RWebUser Class Reference

Public Member Functions
	afterLogin ($fromCookie)
	checkAccess ($operation, $params=array(), $allowCaching=true)
	setIsSuperuser ($value)
	getIsSuperuser ()
	setRightsReturnUrl ($value)
	getRightsReturnUrl ($defaultUrl=null)
	updateSession ()

Detailed Description

Rights web user class file.

Author

Christoffer Niska cnisk.nosp@m.a@li.nosp@m.ve.co.nosp@m.m

Copyright

Copyright © 2010 Christoffer Niska

Since

0.5

Definition at line 10 of file RWebUser.php.

Member Function Documentation

RWebUser::afterLogin

(

$fromCookie

)

Actions to be taken after logging in. Overloads the parent method in order to mark superusers.

Parameters

boolean

$fromCookie

whether the login is based on cookie.

Definition at line 18 of file RWebUser.php.

Here is the call graph for this function:

RWebUser::checkAccess	(		$operation,
			$params = array(),
			$allowCaching = true
	)

Performs access check for this user. Overloads the parent method in order to allow superusers access implicitly.

Parameters

string	$operation	the name of the operation that need access check.
array	$params	name-value pairs that would be passed to business rules associated with the tasks and roles assigned to the user.
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.

Definition at line 45 of file RWebUser.php.

RWebUser::getIsSuperuser

(

)

Returns

boolean whether the user is a superuser.

Definition at line 62 of file RWebUser.php.

RWebUser::getRightsReturnUrl

(

$defaultUrl = null

)

Returns the URL that the user should be redirected to after updating an authorization item.

Parameters

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.

Definition at line 85 of file RWebUser.php.

RWebUser::setIsSuperuser

(

$value

)

Parameters

boolean

$value

whether the user is a superuser.

Definition at line 54 of file RWebUser.php.

RWebUser::setRightsReturnUrl

(

$value

)

Parameters

array

$value

return url.

Definition at line 70 of file RWebUser.php.

RWebUser::updateSession

(

)

Definition at line 95 of file RWebUser.php.

---

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

• app/protected/modules/rights/components/RWebUser.php