Class RWebUser

Rights web user class file.

CComponent

CApplicationComponent implements IApplicationComponent

CWebUser implements IWebUser

RWebUser

Copyright: Copyright © 2010 Christoffer Niska
Author: Christoffer Niska <cniska@live.com>
Since: 0.5
Located at crisu83/yii-rights/components/RWebUser.php

Methods summary

`public`	# `afterLogin( boolean $fromCookie )` Actions to be taken after logging in. Overloads the parent method in order to mark superusers. Actions to be taken after logging in. Overloads the parent method in order to mark superusers. Parameters `$fromCookie` `boolean` $fromCookie whether the login is based on cookie. Overrides `CWebUser::afterLogin`
`public boolean`	# `checkAccess( string $operation, array $params = array(), boolean $allowCaching = true )` Performs access check for this user. Overloads the parent method in order to allow superusers access implicitly. Performs access check for this user. Overloads the parent method in order to allow superusers access implicitly. Parameters `$operation` `string` $operation the name of the operation that need access check. `$params` `array` $params name-value pairs that would be passed to business rules associated with the tasks and roles assigned to the user. `$allowCaching` `boolean` $allowCaching whether to allow caching the result of access checki. This parameter has been available since version 1.0.5. When this parameter is true (default), if the access check of an operation was performed before, its result will be directly returned when calling this method to check the same operation. If this parameter is false, this method will always call CAuthManager::checkAccess to obtain the up-to-date access result. Note that this caching is effective only within the same request. Returns `boolean` whether the operations can be performed by this user. Overrides `CWebUser::checkAccess`
`public`	# `setIsSuperuser( boolean $value )` Parameters `$value` `boolean` $value whether the user is a superuser.
`public boolean`	# `getIsSuperuser( )` Returns `boolean` whether the user is a superuser.
`public`	# `setRightsReturnUrl( array $value )` Parameters `$value` `array` $value return url.
`public string`	# `getRightsReturnUrl( string $defaultUrl = null )` Returns the URL that the user should be redirected to after updating an authorization item. Returns the URL that the user should be redirected to after updating an authorization item. Parameters `$defaultUrl` `string` $defaultUrl the default return URL in case it was not set previously. If this is null, the application entry URL will be considered as the default return URL. Returns `string` the URL that the user should be redirected to after updating an authorization item.

Methods inherited from CWebUser

__get(), __isset(), __set(), __unset(), afterLogout(), beforeLogin(), beforeLogout(), changeIdentity(), clearStates(), createIdentityCookie(), getFlash(), getFlashes(), getId(), getIsGuest(), getName(), getReturnUrl(), getState(), getStateKeyPrefix(), hasFlash(), hasState(), init(), loadIdentityStates(), login(), loginRequired(), logout(), renewCookie(), restoreFromCookie(), saveIdentityStates(), saveToCookie(), setFlash(), setId(), setName(), setReturnUrl(), setState(), setStateKeyPrefix(), updateAuthStatus(), updateFlash()

Methods inherited from CApplicationComponent

getIsInitialized()

Methods inherited from CComponent

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

Magic methods summary

Constants summary

Constants inherited from CWebUser

AUTH_TIMEOUT_VAR, FLASH_COUNTERS, FLASH_KEY_PREFIX, STATES_VAR

Properties summary

Properties inherited from CWebUser

$allowAutoLogin, $authTimeout, $autoRenewCookie, $autoUpdateFlash, $guestName, $identityCookie, $loginRequiredAjaxResponse, $loginUrl

Properties inherited from CApplicationComponent

$behaviors

Magic properties inherited from CWebUser

$flashes, $id, $isGuest, $name, $returnUrl, $stateKeyPrefix

Magic properties inherited from CApplicationComponent

$isInitialized

Packages

Classes

Class RWebUser

Methods summary

Parameters

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Parameters

Returns

Methods inherited from CWebUser

Methods inherited from CApplicationComponent

Methods inherited from CComponent

Magic methods summary

Constants summary

Constants inherited from CWebUser

Properties summary

Properties inherited from CWebUser

Properties inherited from CApplicationComponent

Magic properties inherited from CWebUser

Magic properties inherited from CApplicationComponent