eZ Publish  [trunk]
eZUserAccountKey Class Reference

The class eZUserAccountKey does. More...

+ Inheritance diagram for eZUserAccountKey:
+ Collaboration diagram for eZUserAccountKey:

List of all members.

Public Member Functions

 eZUserAccountKey ($row=array())

Static Public Member Functions

static createNew ($userID, $hashKey, $time)
static definition ()
 Returns the definition for the object, the default implementation is to return an empty array.
static fetchByKey ($hashKey)
static fetchByUserID ($userID)
 Return the eZUserAccountKey object associated to a user id.
static removeByUserID ($userID)

Detailed Description

The class eZUserAccountKey does.

Definition at line 18 of file ezuseraccountkey.php.


Member Function Documentation

static eZUserAccountKey::createNew ( userID,
hashKey,
time 
) [static]

Definition at line 57 of file ezuseraccountkey.php.

Referenced by eZUserOperationCollection\activation().

static eZUserAccountKey::definition ( ) [static]

Returns the definition for the object, the default implementation is to return an empty array.

It's upto each inheriting class to return a proper definition array.

The definition array is an associative array consists of these keys:

  • fields: an associative array of fields which defines which database field (the key) is to fetched and how they map to object member variables (the value).
  • keys: an array of fields which is used for uniquely identifying the object in the table.
  • function_attributes: an associative array of attributes which maps to member functions, used for fetching data with functions.
  • set_functions: an associative array of attributes which maps to member functions, used for setting data with functions.
  • increment_key: the field which is incremented on table inserts.
  • class_name: the classname which is used for instantiating new objecs when fetching from the database.
  • sort: an associative array which defines the default sorting of lists, the key is the table field while the value is the sorting method which is either 'asc' or 'desc'.
  • name: the name of the database table

Example: public static function definition() { return array( "fields" => array( "id" => "ID", "version" => "Version", "name" => "Name" ), "keys" => array( "id", "version" ), "function_attributes" => array( "current" => "currentVersion", "class_name" => "className" ), "increment_key" => "id", "class_name" => "eZContentClass", "sort" => array( "id" => "asc" ), "name" => "ezcontentclass" ); }

Returns:
array

Reimplemented from eZPersistentObject.

Definition at line 28 of file ezuseraccountkey.php.

Referenced by fetchByKey(), fetchByUserID(), and removeByUserID().

eZUserAccountKey::eZUserAccountKey ( row = array())

Constructor

Definition at line 23 of file ezuseraccountkey.php.

Referenced by createNew().

static eZUserAccountKey::fetchByKey ( hashKey) [static]

Definition at line 64 of file ezuseraccountkey.php.

static eZUserAccountKey::fetchByUserID ( userID) [static]

Return the eZUserAccountKey object associated to a user id.

Parameters:
int$userID
Returns:
eZUserAccountKey

Definition at line 78 of file ezuseraccountkey.php.

Referenced by eZUser\accountKey().

static eZUserAccountKey::removeByUserID ( userID) [static]

Remove account keys belonging to user $userID

Definition at line 91 of file ezuseraccountkey.php.

Referenced by eZUserOperationCollection\activation(), eZUser\removeUser(), and eZUserOperationCollection\setSettings().


The documentation for this class was generated from the following file: