Public Member Functions
	init ()
	getBehaviorsFor ($componentName)
	beforeControllerAction ($controller, $action)
	users ()

Static Public Member Functions
static	t ($str= '', $params=array(), $dic= 'user')
static	encrypting ($string="")
static	doCaptcha ($place= '')
static	isAdmin ()
static	getAdmins ()
static	sendMail ($email, $subject, $message)
static	user ($id=0, $clearCache=false)
static	getUserByName ($username)
static	isGuest ()
static	isUserTemp ()
static	isNotGuestAndUserTemp ()
static	getUserId ()
static	createAndLoginUserTemp ()

Public Attributes
	$user_page_size = 10
	$fields_page_size = 10
	$hash = 'md5'
	$sendActivationMail = true
	$loginNotActiv = false
	$activeAfterRegister = false
	$autoLogin = true
	$registrationUrl = array("/user/registration")
	$recoveryUrl = array("/user/recovery/recovery")
	$loginUrl = array("/user/login")
	$logoutUrl = array("/user/logout")
	$profileUrl = array("/user/profile")
	$returnUrl = array("/user/profile")
	$returnLogoutUrl = array("/user/login")
	$rememberMeTime = 2592000
	$fieldsMessage = ''
	$relations = array()
	$profileRelations = array()
	$captcha = array('registration' => true)
	$tableUsers = '{{users}}'
	$tableProfiles = '{{profiles}}'
	$tableProfileFields = '{{profiles_fields}}'
	$defaultScope
	$componentBehaviors = array()

Static Private Attributes
static	$_user
static	$_users = array()
static	$_userByName = array()
static	$_admin
static	$_admins

Detailed Description

Yii-User module.

Author: Mikhail Mangushev misha.nosp@m.mx@g.nosp@m.mail..nosp@m.com

http://www.opensource.org/licenses/bsd-license.php

Definition at line 13 of file UserModule.php.

Member Function Documentation

UserModule::beforeControllerAction	(	$controller,
		$action
	)

Definition at line 138 of file UserModule.php.

static UserModule::createAndLoginUserTemp ( )

static

Create and login user temp.

Definition at line 350 of file UserModule.php.

Here is the call graph for this function:

Here is the caller graph for this function:

static UserModule::doCaptcha ( $place = '' )

static

Parameters

$place

Returns: boolean

Definition at line 186 of file UserModule.php.

Here is the caller graph for this function:

static UserModule::encrypting ( $string = "" )

static

Returns: hash string.

Definition at line 168 of file UserModule.php.

Here is the caller graph for this function:

static UserModule::getAdmins ( )

static

Return admins.

Returns: array syperusers names

Definition at line 225 of file UserModule.php.

Here is the call graph for this function:

Here is the caller graph for this function:

UserModule::getBehaviorsFor ( $componentName )

Definition at line 129 of file UserModule.php.

static UserModule::getUserByName ( $username )

static

Return safe user data.

Parameters

user name

Returns: user object or false

Definition at line 282 of file UserModule.php.

Here is the call graph for this function:

static UserModule::getUserId ( )

static

Returns user id.

Returns: integer

Definition at line 342 of file UserModule.php.

UserModule::init ( )

Definition at line 117 of file UserModule.php.

static UserModule::isAdmin ( )

static

Return admin status.

Returns: boolean

Definition at line 203 of file UserModule.php.

Here is the call graph for this function:

Here is the caller graph for this function:

static UserModule::isGuest ( )

static

Check user is guest (not authorized) or not.

Returns: boolean

Definition at line 308 of file UserModule.php.

Here is the caller graph for this function:

static UserModule::isNotGuestAndUserTemp ( )

static

Check user is not guest and not temp.

Returns: boolean

Definition at line 332 of file UserModule.php.

static UserModule::isUserTemp ( )

static

Check user is temp or not.

Returns: boolean

Definition at line 318 of file UserModule.php.

Here is the call graph for this function:

Here is the caller graph for this function:

static UserModule::sendMail	(	$email,
		$subject,
		$message
	)

static

Send mail method.

Definition at line 242 of file UserModule.php.

Here is the caller graph for this function:

static UserModule::t	(	$str = `''`,
		$params = `array()`,
		$dic = `'user'`
	)

static

Parameters

$str
$params
$dic

Returns: string

Definition at line 156 of file UserModule.php.

Here is the caller graph for this function:

static UserModule::user	(	$id = `0`,
		$clearCache = `false`
	)

static

Return safe user data.

Parameters

user	id not required

Returns: user object or false

Definition at line 259 of file UserModule.php.

Here is the call graph for this function:

Here is the caller graph for this function:

UserModule::users ( )

Return safe user data.

Parameters

user	id not required

Returns: user object or false

Definition at line 298 of file UserModule.php.

Member Data Documentation

UserModule::$_admin

staticprivate

Definition at line 108 of file UserModule.php.

UserModule::$_admins

staticprivate

Definition at line 109 of file UserModule.php.

UserModule::$_user

staticprivate

Definition at line 105 of file UserModule.php.

UserModule::$_userByName = array()

staticprivate

Definition at line 107 of file UserModule.php.

UserModule::$_users = array()

staticprivate

Definition at line 106 of file UserModule.php.

UserModule::$activeAfterRegister = false

Definition at line 49 of file UserModule.php.

UserModule::$autoLogin = true

Definition at line 55 of file UserModule.php.

UserModule::$captcha = array('registration' => true)

Definition at line 90 of file UserModule.php.

UserModule::$componentBehaviors = array()

Definition at line 115 of file UserModule.php.

UserModule::$defaultScope

Initial value:

 array(
            'with' => array('profile'),
    )

Definition at line 101 of file UserModule.php.

UserModule::$fields_page_size = 10

Definition at line 25 of file UserModule.php.

UserModule::$fieldsMessage = ''

Definition at line 71 of file UserModule.php.

UserModule::$hash = 'md5'

Definition at line 31 of file UserModule.php.

UserModule::$loginNotActiv = false

Definition at line 43 of file UserModule.php.

UserModule::$loginUrl = array("/user/login")

Definition at line 59 of file UserModule.php.

UserModule::$logoutUrl = array("/user/logout")

Definition at line 60 of file UserModule.php.

UserModule::$profileRelations = array()

Definition at line 85 of file UserModule.php.

UserModule::$profileUrl = array("/user/profile")

Definition at line 61 of file UserModule.php.

UserModule::$recoveryUrl = array("/user/recovery/recovery")

Definition at line 58 of file UserModule.php.

UserModule::$registrationUrl = array("/user/registration")

Definition at line 57 of file UserModule.php.

UserModule::$relations = array()

Definition at line 79 of file UserModule.php.

UserModule::$rememberMeTime = 2592000

Definition at line 69 of file UserModule.php.

UserModule::$returnLogoutUrl = array("/user/login")

Definition at line 63 of file UserModule.php.

UserModule::$returnUrl = array("/user/profile")

Definition at line 62 of file UserModule.php.

UserModule::$sendActivationMail = true

Definition at line 37 of file UserModule.php.

UserModule::$tableProfileFields = '{{profiles_fields}}'

Definition at line 99 of file UserModule.php.

UserModule::$tableProfiles = '{{profiles}}'

Definition at line 98 of file UserModule.php.

UserModule::$tableUsers = '{{users}}'

Definition at line 97 of file UserModule.php.

UserModule::$user_page_size = 10

Definition at line 19 of file UserModule.php.

The documentation for this class was generated from the following file:

app/protected/modules/user/UserModule.php

Public Member Functions

Static Public Member Functions

Public Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

Member Data Documentation