Class X2NonWebUser
User for console applications.
-
CComponent
-
CApplicationComponent
implements
IApplicationComponent
-
X2NonWebUser
implements
IWebUser
Methods summary
public
mixed
|
#
getId( )
Returns a value that uniquely represents the identity.
Returns a value that uniquely represents the identity.
Returns
mixed a value that uniquely represents the identity (e.g. primary key value).
Implementation of
IWebUser::getId()
|
public
string
|
#
getName( )
Returns the display name for the identity (e.g. username).
Returns the display name for the identity (e.g. username).
Returns
string the display name for the identity.
Implementation of
IWebUser::getName()
|
public
boolean
|
#
getIsGuest( )
Returns a value indicating whether the user is a guest (not
authenticated).
Returns a value indicating whether the user is a guest (not
authenticated).
Returns
boolean whether the user is a guest (not authenticated)
Implementation of
IWebUser::getIsGuest()
|
public
boolean
|
#
checkAccess( string $operation, array $params = array() )
Performs access check for this user.
Performs access check for this user.
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.
Returns
boolean whether the operations can be performed by this user.
Implementation of
IWebUser::checkAccess()
|
public
|
#
loginRequired( )
Redirects the user browser to the login page. Before the redirection, the
current URL (if it's not an AJAX url) will be kept in returnUrl so that
the user browser may be redirected back to the current page after successful
login. Make sure you set loginUrl so that the user browser can be
redirected to the specified login URL after calling this method. After calling
this method, the current request processing will be terminated.
Redirects the user browser to the login page. Before the redirection, the
current URL (if it's not an AJAX url) will be kept in returnUrl so that
the user browser may be redirected back to the current page after successful
login. Make sure you set loginUrl so that the user browser can be
redirected to the specified login URL after calling this method. After calling
this method, the current request processing will be terminated.
Implementation of
IWebUser::loginRequired()
|
public
|
|
Methods inherited from CApplicationComponent
getIsInitialized(),
init()
|
Methods inherited from CComponent
__call(),
__get(),
__isset(),
__set(),
__unset(),
asa(),
attachBehavior(),
attachBehaviors(),
attachEventHandler(),
canGetProperty(),
canSetProperty(),
detachBehavior(),
detachBehaviors(),
detachEventHandler(),
disableBehavior(),
disableBehaviors(),
enableBehavior(),
enableBehaviors(),
evaluateExpression(),
getEventHandlers(),
hasEvent(),
hasEventHandler(),
hasProperty(),
raiseEvent()
|
Properties inherited from CApplicationComponent
$behaviors
|
Magic properties inherited from CApplicationComponent
$isInitialized
|