Interface IWebUser

IWebUser interface is implemented by a CWebApplication::user user application component.

A user application component represents the identity information for the current user.

Direct known implementers

Indirect known implementers

Package: system\base
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 1.0
Located at x2engine/framework/base/interfaces.php

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).
`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.
`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)
`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.
`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.

Packages

Classes

Interfaces

Exceptions

Interface IWebUser

Direct known implementers

Indirect known implementers

Returns

Returns

Returns

Parameters

Returns