"Fossies" - the Fresh Open Source Software Archive

Member "yii-docs-1.1.24.a5ab20/api/IUserIdentity.html" (7 Jun 2021, 9667 Bytes) of package /linux/www/yii-docs-1.1.24.a5ab20.tar.gz:


Caution: In this restricted "Fossies" environment the current HTML page may not be correctly presentated and may have some non-functional links. You can here alternatively try to browse the pure source code or just view or download the uninterpreted raw source code. If the rendering is insufficient you may try to find and view the page on the project site itself.

Yii Framework v1.1.24 Class Reference

IUserIdentity

Package system.base
Inheritance interface IUserIdentity
Subclasses CBaseUserIdentity, CUserIdentity
Since 1.0
Source Code framework/base/interfaces.php
IUserIdentity interface is implemented by a user identity class.

An identity represents a way to authenticate a user and retrieve information needed to uniquely identity the user. It is normally used with the user application component.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
authenticate() Authenticates the user. IUserIdentity
getId() Returns a value that uniquely represents the identity. IUserIdentity
getIsAuthenticated() Returns a value indicating whether the identity is authenticated. IUserIdentity
getName() Returns the display name for the identity (e.g. username). IUserIdentity
getPersistentStates() Returns the additional identity information that needs to be persistent during the user session. IUserIdentity

Method Details

authenticate() method
abstract public boolean authenticate()
{return} boolean whether authentication succeeds.
Source Code: framework/base/interfaces.php#255 (show)
public function authenticate();

Authenticates the user. The information needed to authenticate the user are usually provided in the constructor.

getId() method
abstract public mixed getId()
{return} mixed a value that uniquely represents the identity (e.g. primary key value).
Source Code: framework/base/interfaces.php#265 (show)
public function getId();

Returns a value that uniquely represents the identity.

getIsAuthenticated() method
abstract public boolean getIsAuthenticated()
{return} boolean whether the identity is valid.
Source Code: framework/base/interfaces.php#260 (show)
public function getIsAuthenticated();

Returns a value indicating whether the identity is authenticated.

getName() method
abstract public string getName()
{return} string the display name for the identity.
Source Code: framework/base/interfaces.php#270 (show)
public function getName();

Returns the display name for the identity (e.g. username).

getPersistentStates() method
abstract public array getPersistentStates()
{return} array additional identity information that needs to be persistent during the user session (excluding id).
Source Code: framework/base/interfaces.php#275 (show)
public function getPersistentStates();

Returns the additional identity information that needs to be persistent during the user session.

© 2008-2013 by Yii Software LLC
All Rights Reserved.