PHP Class Horde_Core_Prefs_Identity, horde

Author: Jan Schneider ([email protected])
Author: Michael Slusarz ([email protected])
Inheritance: extends Horde_Prefs_Identity
Datei anzeigen Open project: horde/horde Class Usage Examples

Public Methods

Method Description
confirmIdentity ( string $hash ) Checks whether an identity confirmation is valid, and adds the validated identity.
getMatchingIdentity ( mixed $addresses, boolean $search_own = true ) : integer Returns the identity's id that matches the passed addresses.
getName ( integer $ident = null ) : string Returns the user's full name.
prefsGc ( ) Perform garbage collection on preferences used by identities.
verifyIdentity ( integer $id, string $old_addr ) Sends a message to an email address supposed to be added to the identity.

Protected Methods

Method Description
_confirmEmail ( array $confirm = null ) : array Manage the storage of the confirm_email preference.

Method Details

_confirmEmail() protected method

Manage the storage of the confirm_email preference.
protected _confirmEmail ( array $confirm = null ) : array
$confirm array If set, save this in the pref backend.
return array Confirm email array.

confirmIdentity() public method

Checks whether an identity confirmation is valid, and adds the validated identity.
public confirmIdentity ( string $hash )
$hash string The hash of the identity being validated.

getMatchingIdentity() public method

Returns the identity's id that matches the passed addresses.
public getMatchingIdentity ( mixed $addresses, boolean $search_own = true ) : integer
$addresses mixed Either an array or a single string or a comma-separated list of email addresses.
$search_own boolean Search for a matching identity in own addresses also?
return integer The id of the first identity that from or alias addresses match (one of) the passed addresses or null if none matches.

getName() public method

Returns the user's full name.
public getName ( integer $ident = null ) : string
$ident integer The identity to retrieve the name from.
return string The user's full name, or the user name if it doesn't exist.

prefsGc() public method

Perform garbage collection on preferences used by identities.
public prefsGc ( )

verifyIdentity() public method

A message is send to this address containing a time-sensitive link to confirm that the address really belongs to that user.
public verifyIdentity ( integer $id, string $old_addr )
$id integer The identity's ID.
$old_addr string The old From: address.