Class UserModule

Yii-User module

CComponent

CModule

CWebModule

UserModule

License: http://www.opensource.org/licenses/bsd-license.php
Author: Mikhail Mangushev <mishamx@gmail.com>
Version: $Id: UserModule.php 132 2011-10-30 10:45:01Z mishamx $
Link: http://yii-user.2mx.org/
Located at mishamx/yii-user/UserModule.php

Methods summary

`public`	# `init( )` Initializes the module. This method is called at the end of the module constructor. Note that at this moment, the module has been configured, the behaviors have been attached and the application components have been registered. Initializes the module. This method is called at the end of the module constructor. Note that at this moment, the module has been configured, the behaviors have been attached and the application components have been registered. See `CModule::preinit()` Overrides `CModule::init`
`public`	# `getBehaviorsFor( mixed $componentName )`
`public boolean`	# `beforeControllerAction( CController $controller, CAction $action )` The pre-filter for controller actions. This method is invoked before the currently requested controller action and all its filters are executed. You may override this method in the following way: if(parent::beforeControllerAction($controller,$action)) { // your code return true; } else return false; The pre-filter for controller actions. This method is invoked before the currently requested controller action and all its filters are executed. You may override this method in the following way: if(parent::beforeControllerAction($controller,$action)) { // your code return true; } else return false; Parameters `$controller` `CController` $controller the controller `$action` `CAction` $action the action Returns `boolean` whether the action should be executed. Overrides `CWebModule::beforeControllerAction`
`public static string`	# `t( mixed $str = '', mixed $params = array(), mixed $dic = 'user' )` Parameters `$str` `mixed` $str `$params` `mixed` $params `$dic` `mixed` $dic Returns `string`
`public static UserModule::$hash`	# `encrypting( mixed $string = "" )` Returns `UserModule::$hash` string.
`public static boolean`	# `doCaptcha( mixed $place = '' )` Parameters `$place` `mixed` $place Returns `boolean`
`public static boolean`	# `isAdmin( )` Return admin status. Return admin status. Returns `boolean`
`public static array`	# `getAdmins( )` Return admins. Return admins. Returns `array` syperusers names
`public static`	# `sendMail( mixed $email, mixed $subject, mixed $message )` Send to user mail Send to user mail
`public`	# `sendMailToUser( mixed $user_id, mixed $subject, mixed $message, mixed $from = '' )` Send to user mail Send to user mail
`public static UserModule::user()`	# `user( UserModule::user() $id = 0, mixed $clearCache = false )` Return safe user data. Return safe user data. Parameters `$id` `UserModule::user()` id not required `$clearCache` Returns `UserModule::user()` object or false
`public static UserModule::user()`	# `getUserByName( UserModule::user() $username )` Return safe user data. Return safe user data. Parameters `$username` `UserModule::user()` name Returns `UserModule::user()` object or false
`public UserModule::user()`	# `users( )` Return safe user data. Return safe user data. Returns `UserModule::user()` object or false

Methods inherited from CWebModule

afterControllerAction(), getControllerPath(), getDescription(), getLayoutPath(), getName(), getVersion(), getViewPath(), setControllerPath(), setLayoutPath(), setViewPath()

Methods inherited from CModule

__construct(), __get(), __isset(), configure(), getBasePath(), getComponent(), getComponents(), getId(), getModule(), getModulePath(), getModules(), getParams(), getParentModule(), hasComponent(), hasModule(), preinit(), preloadComponents(), setAliases(), setBasePath(), setComponent(), setComponents(), setId(), setImport(), setModulePath(), setModules(), setParams()

Methods inherited from CComponent

__call(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()

Magic methods summary

Properties summary

`public integer`	`$user_page_size`	# Desc items on page
`public integer`	`$fields_page_size`	# Desc items on page
`public string`	`$hash`	# Desc hash method (md5,sha1 or algo hash function http://www.php.net/manual/en/function.hash.php)
`public boolean`	`$sendActivationMail`	# Desc use email for activation user account
`public boolean`	`$loginNotActiv`	# Desc allow auth for is not active user
`public boolean`	`$activeAfterRegister`	# Desc activate user on registration (only $sendActivationMail = false)
`public boolean`	`$autoLogin`	# Desc login after registration (need loginNotActiv or activeAfterRegister = true)
`public array`	`$registrationUrl`	#
`public array`	`$recoveryUrl`	#
`public array`	`$loginUrl`	#
`public array`	`$logoutUrl`	#
`public array`	`$profileUrl`	#
`public array`	`$returnUrl`	#
`public array`	`$returnLogoutUrl`	#
`public integer`	`$rememberMeTime`	# Desc Remember Me Time (seconds), defalt = 2592000 (30 days)
`public string`	`$fieldsMessage`	#
`public array`	`$relations`	# See http://www.yiiframework.com/doc/guide/database.arr Desc User model relation from other models
`public array`	`$profileRelations`	# Desc Profile model relation from other models
`public boolean`	`$captcha`	#
`public string`	`$tableUsers`	#
`public string`	`$tableProfiles`	#
`public string`	`$tableProfileFields`	#
`public array`	`$defaultScope`	#
`public array`	`$componentBehaviors`	# Desc Behaviors for models

Properties inherited from CWebModule

$controllerMap, $controllerNamespace, $defaultController, $layout

Properties inherited from CModule

$behaviors, $preload

Magic properties inherited from CWebModule

$controllerPath, $description, $layoutPath, $name, $version, $viewPath

Magic properties inherited from CModule

$aliases, $basePath, $components, $id, $import, $modulePath, $modules, $params, $parentModule

Packages

Classes

Class UserModule

Methods summary

See

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Methods inherited from CWebModule

Methods inherited from CModule

Methods inherited from CComponent

Magic methods summary

Properties summary

Desc

Desc

Desc

Desc

Desc

Desc

Desc

Desc

See

Desc

Desc

Desc

Properties inherited from CWebModule

Properties inherited from CModule

Magic properties inherited from CWebModule

Magic properties inherited from CModule