Apache Zeta Components - high quality PHP components

Apache Zeta Components Manual :: Docs For Class ezcAuthenticationIdCredentials

Authentication::ezcAuthenticationIdCredentials

Class ezcAuthenticationIdCredentials

Structure containing an id, used as authentication credentials.

Source for this file: /Authentication/src/credentials/id_credentials.php

ezcBaseStruct
   |
   --ezcAuthenticationCredentials
      |
      --ezcAuthenticationIdCredentials
Version:   //autogen//

Member Variables

public string $id
Username or userID or url.

Method Summary

public static ezcAuthenticationIdCredentials __set_state( $array )
Returns a new instance of this class with the data specified by $array.
public ezcAuthenticationIdCredentials __construct( $id )
Constructs a new ezcAuthenticationIdCredentials object.
public string __toString( )
Returns string representation of the credentials.

Inherited Methods

From ezcAuthenticationCredentials
public abstract string ezcAuthenticationCredentials::__toString()
Returns string representation of the credentials.

Methods

__set_state

static ezcAuthenticationIdCredentials __set_state( $array )

Returns a new instance of this class with the data specified by $array.

$array contains all the data members of this class in the form: array('member_name'=>value).

__set_state makes this class exportable with var_export. var_export() generates code, that calls this method when it is parsed with PHP.

Parameters:
Name Type Description
$array array(string=>mixed) Associative array of data members for this class

__construct

ezcAuthenticationIdCredentials __construct( string $id )

Constructs a new ezcAuthenticationIdCredentials object.

Parameters:
Name Type Description
$id string

__toString

string __toString( )

Returns string representation of the credentials.

Use it to save the credentials in the session.

Redefinition of:
Method Description
ezcAuthenticationCredentials::__toString() Returns string representation of the credentials.
Documentation generated by phpDocumentor 1.4.3