CBaseUserIdentity

Property Details

errorCode property

public integer $errorCode;

the authentication error code. If there is an error, the error code will be non-zero. Defaults to 100, meaning unknown identity. Calling authenticate will change this value.

errorMessage property

public string $errorMessage;

the authentication error message. Defaults to empty.

id property read-only

public mixed getId()

Returns a value that uniquely represents the identity.

isAuthenticated property read-only

public boolean getIsAuthenticated()

Returns a value indicating whether the identity is authenticated. This method is required by IUserIdentity.

name property read-only

public string getName()

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

persistentStates property

public array getPersistentStates()
public void setPersistentStates(array $states)

Returns the identity states that should be persisted. This method is required by IUserIdentity.

Method Details

clearState() method

public void clearState(string $name)

public function clearState($name)
{
    unset($this->_state[$name]);
}

Removes the specified state.

getId() method

public mixed getId()

public function getId()
{
    return $this->getName();
}

Returns a value that uniquely represents the identity.

getIsAuthenticated() method

public boolean getIsAuthenticated()

public function getIsAuthenticated()
{
    return $this->errorCode==self::ERROR_NONE;
}

Returns a value indicating whether the identity is authenticated. This method is required by IUserIdentity.

getName() method

public string getName()

public function getName()
{
    return '';
}

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

getPersistentStates() method

public array getPersistentStates()

public function getPersistentStates()
{
    return $this->_state;
}

Returns the identity states that should be persisted. This method is required by IUserIdentity.

getState() method

public mixed getState(string $name, mixed $defaultValue=NULL)

public function getState($name,$defaultValue=null)
{
    return isset($this->_state[$name])?$this->_state[$name]:$defaultValue;
}

Gets the persisted state by the specified name.

setPersistentStates() method

public void setPersistentStates(array $states)

public function setPersistentStates($states)
{
    $this->_state = $states;
}

Sets an array of persistent states.

setState() method

public void setState(string $name, mixed $value)

public function setState($name,$value)
{
    $this->_state[$name]=$value;
}

Sets the named state with a given value.