Class \Prado\Security\TUser

TUser class

TUser implements basic user functionality for a Prado application. To get the name of the user, use \Prado\Security\getName property. The property \Prado\Security\getIsGuest tells if the user a guest/anonymous user. To obtain or test the roles that the user is in, use property \Prado\Security\getRoles and call isInRole(), respectively.

TUser is meant to be used together with IUserManager.

Class hierarchy

\Prado\Security\TUser implements IUser

\Prado\TComponent

Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0

Methods summary
`public`	`__construct(IUserManager $manager) : mixed` Constructor.
`public`	`getAutoGlobalListen() : bool` TUser auto listen to global events.
`public`	`getIsGuest() : bool`
`public`	`getManager() : IUserManager`
`public`	`getName() : string`
`public`	`getRoles() : array<string\|int, mixed>`
`public`	`getStateChanged() : bool`
`public`	`isInRole(string $role) : bool`
`public`	`loadFromString(string $data) : IUser`
`public`	`saveToString() : string`
`public`	`setIsGuest(bool $value) : mixed`
`public`	`setName(string $value) : mixed`
`public`	`setRoles(array<string\|int, mixed>\|string $value) : mixed`
`public`	`setStateChanged(bool $value) : mixed`
`protected`	`getState(string $key[, null\|mixed $defaultValue = null ]) : mixed` Returns the value of a variable that is stored in user session. This function is designed to be used by TUser descendant classes who want to store additional user information in user session. A variable, if stored in user session using setState can be retrieved back using this function.
`protected`	`setState(string $key, mixed $value[, null\|mixed $defaultValue = null ]) : mixed` Stores a variable in user session. This function is designed to be used by TUser descendant classes who want to store additional user information in user session. By storing a variable using this function, the variable may be retrieved back later using getState. The variable will be persistent across page requests during a user session.

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getEventHandlers, getListeningToGlobalEvents, getSubProperty, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, listen, raiseEvent, setSubProperty, unlisten, _getZappableSleepProps, getCallChain, getClassFxEvents, instanceBehavior, filter_prado_fx

Inherited constants
`\Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`

Classes

Interfaces

Traits

Search results

Class \Prado\Security\TUser

Class hierarchy