Class: Base_User_LoginCommon

Source Location: /modules/Base/User/Login/LoginCommon_0.php

Class Base_User_LoginCommon

Class Overview

Login class.

This class provides for basic login functionality, saves passwords to database and enables password recvery.

Located in /modules/Base/User/Login/LoginCommon_0.php [line 16]

ModuleAcl
   |
   --ModulePrimitive
      |
      --ModuleCommon
         |
         --Base_User_LoginCommon

Author(s):

Paul Bukowski <pbukowski@telaxus.com>

Information Tags:

Version:	1.0
Copyright:	Copyright © 2008, Telaxus LLC
License:	MIT

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From ModuleCommon

ModuleCommon::Instance()

Singleton.

Inherited From ModulePrimitive

ModulePrimitive::__construct()

ModulePrimitive::check_access()

Checks access to function which name is passed as first parameter.

ModulePrimitive::create_data_dir()

Creates default data directory for module. Typical usage: in module installation

ModulePrimitive::get_data_dir()

Returns path to the default data directory for module calling this method.

ModulePrimitive::get_module_dir()

Returns path to the module directory.

ModulePrimitive::get_type()

Returns name(type) of module that called this function.

ModulePrimitive::get_type_with_bt()

ModulePrimitive::remove_data_dir()

Removes default data directory of a module. Typical usage: in module uninstallation

Inherited From ModuleAcl

ModuleAcl::acl_check()

ModuleAcl::add_aco()

ModuleAcl::del_aco()

ModuleAcl::get_type()

[ Top ]

Method Summary

static bool	add_user()	Add user and send password by mail.
static void	change_user_preferences()	Change user mail and password.
static bool	check_login()	Check if username and password is valid login.
static bool	check_username_free()	Checks if username is not assigned to a user.
static void	check_username_mail_valid()
static void	get_mail()
static void	mobile_autologin()
static void	mobile_login()
static void	mobile_logout()
static void	mobile_menu()
static void	send_mail_with_password()	Send mail with login and password to address....
static void	set_logged()
static void	submit_login()

[ Top ]

Methods

static method add_user [line 100]

static bool add_user(
string
$username, string
$mail, [string
$pass = null], [
$send_mail = true] 
)

Add user and send password by mail.

Parameters:

string	$username:	username
string	$mail:	mail address
string	$pass:	password
	$send_mail:

API Tags:

Return:	everything is ok?
Access:	public

[ Top ]

static method change_user_preferences [line 132]

static void change_user_preferences(
integer
$id, string
$mail, [string
$pass = ''] 
)

Change user mail and password.

Parameters:

integer	$id:	user id (get from User module)
string	$mail:	new mail address
string	$pass:	password, if empty, don't change pass

API Tags:

Access:

public

[ Top ]

static method check_login [line 24]

static bool check_login(
string
$username, string
$pass 
)

Check if username and password is valid login.

Parameters:

string	$username:
string	$pass:

API Tags:

Access:

public

[ Top ]

static method check_username_free [line 67]

static bool check_username_free(
string
$username 
)

Checks if username is not assigned to a user.

Parameters:

string

$username:

username

API Tags:

Return:	false if there is a user in the system with given name, true otherwise
Access:	public

[ Top ]

static method check_username_mail_valid [line 55]

static void check_username_mail_valid(

$username, 
$form 
)

Parameters:

	$username:
	$form:

API Tags:

Access:

public

[ Top ]

static method get_mail [line 143]

static void get_mail(

$id 
)

Parameters:

$id:

API Tags:

Access:

public

[ Top ]

static method mobile_autologin [line 170]

static void mobile_autologin(
)

API Tags:

Access:

public

[ Top ]

static method mobile_login [line 184]

static void mobile_login(
)

API Tags:

Access:

public

[ Top ]

static method mobile_logout [line 156]

static void mobile_logout(
)

API Tags:

Access:

public

[ Top ]

static method mobile_menu [line 150]

static void mobile_menu(
)

API Tags:

Access:

public

[ Top ]

static method send_mail_with_password [line 78]

static void send_mail_with_password(
string
$username, string
$pass, string
$mail 
)

Send mail with login and password to address....

Parameters:

string	$username:	username
string	$pass:	password
string	$mail:	destination mail address

API Tags:

Access:

public

[ Top ]

static method set_logged [line 49]

static void set_logged(

$user 
)

Parameters:

$user:

API Tags:

Access:

public

[ Top ]

static method submit_login [line 32]

static void submit_login(

$x 
)

Parameters:

$x:

API Tags:

Access:

public

[ Top ]

Documentation generated on Fri, 26 Dec 2008 21:43:11 -0500 by phpDocumentor 1.4.2

	epesi-base user-login

[ class tree: epesi-base ] [ index: epesi-base ] [ all elements ]