Horde_Core_Prefs_Identity
extends Horde_Prefs_Identity
in package
This class provides Horde-specific functions for the Horde_Prefs_Identity class.
Tags
Table of Contents
Constants
- EXPIRE = 'confirm_expire'
- Identity entry containing the expiration time.
- EXPIRE_SECS = 86400
- Expiration (in seconds) of a confirmation request.
Methods
- confirmIdentity() : mixed
- Checks whether an identity confirmation is valid, and adds the validated identity.
- getMatchingIdentity() : int
- Returns the identity's id that matches the passed addresses.
- getName() : string
- Returns the user's full name.
- prefsGc() : mixed
- Perform garbage collection on preferences used by identities.
- verifyIdentity() : mixed
- Sends a message to an email address supposed to be added to the identity.
- _confirmEmail() : array<string|int, mixed>
- Manage the storage of the confirm_email preference.
Constants
EXPIRE
Identity entry containing the expiration time.
public
mixed
EXPIRE
= 'confirm_expire'
EXPIRE_SECS
Expiration (in seconds) of a confirmation request.
public
mixed
EXPIRE_SECS
= 86400
Methods
confirmIdentity()
Checks whether an identity confirmation is valid, and adds the validated identity.
public
confirmIdentity(string $hash) : mixed
Parameters
- $hash : string
-
The hash of the identity being validated.
getMatchingIdentity()
Returns the identity's id that matches the passed addresses.
public
getMatchingIdentity(mixed $addresses[, bool $search_own = true ]) : int
Parameters
- $addresses : mixed
-
Either an array or a single string or a comma-separated list of email addresses.
- $search_own : bool = true
-
Search for a matching identity in own addresses also?
Return values
int —The id of the first identity that from or alias addresses match (one of) the passed addresses or null if none matches.
getName()
Returns the user's full name.
public
getName([int $ident = null ]) : string
Parameters
- $ident : int = null
-
The identity to retrieve the name from.
Return values
string —The user's full name, or the user name if it doesn't exist.
prefsGc()
Perform garbage collection on preferences used by identities.
public
prefsGc() : mixed
verifyIdentity()
Sends a message to an email address supposed to be added to the identity.
public
verifyIdentity(int $id, string $old_addr) : mixed
A message is send to this address containing a time-sensitive link to confirm that the address really belongs to that user.
Parameters
- $id : int
-
The identity's ID.
- $old_addr : string
-
The old From: address.
Tags
_confirmEmail()
Manage the storage of the confirm_email preference.
protected
_confirmEmail([array<string|int, mixed> $confirm = null ]) : array<string|int, mixed>
Parameters
- $confirm : array<string|int, mixed> = null
-
If set, save this in the pref backend.
Return values
array<string|int, mixed> —Confirm email array.