PHP Class Horde_History, horde

See link: http://pear.horde.org/index.php?package=History

Author: Chuck Hagenbuch ([email protected])

Author: Gunnar Wrobel ([email protected])

Afficher le fichier Open project: horde/horde Class Usage Examples

Protected Properties

Свойство	Type	Description
$_auth	string	The current user.
$_cache	Horde_Cache	Cache driver object.
$_logger	Horde_Log_Logger	Our log handler.

Méthodes publiques

Méthode	Description
__construct ( string $auth )	Constructor.
_getByTimestamp ( string $cmp, integer $ts, array $filters = [], string $parent = null ) : array	Finds history objects by timestamp, and optionally filter on other fields as well.
_getHistory ( string $guid ) : Horde_History_Log	Returns a Horde_History_Log corresponding to the named history entry, with the data retrieved appropriately.
getActionModSeq ( string $guid, string $action ) : integer	Gets the modseq of the most recent change to $guid
getActionTimestamp ( string $guid, string $action ) : integer	Gets the timestamp of the most recent change to $guid.
getByModSeq ( integer $start, integer $end, array $filters = [], string $parent = null ) : array	Return history objects with changes during a modseq interval, and optionally filtered on other fields as well.
getByTimestamp ( string $cmp, integer $ts, array $filters = [], string $parent = null ) : array	Finds history objects by timestamp, and optionally filter on other fields as well.
getHighestModSeq ( string $parent = null ) : integer	Return the maximum modification sequence. To be overridden in concrete class.
getHistory ( string $guid ) : Horde_History_Log	Returns a Horde_History_Log corresponding to the named history entry, with the data retrieved appropriately.
getLatestEntry ( string $guid, boolean $use_ts = false ) : array \| boolean	Gets the latest entry of $guid
log ( string $guid, array $attributes = [], boolean $replaceAction = false )	Logs an event to an item's history log.
removeByNames ( array $names )	Removes one or more history entries by name.
removeByParent ( string $parent )	Remove one or more history entries by parent.
setCache ( Horde_Cache $cache )	Set Cache object.
setLogger ( Horde_Log_Logger $logger ) : null	Set the log handler.

Méthodes protégées

Méthode	Description
_log ( Horde_History_Log $history, array $attributes, boolean $replaceAction = false )	Logs an event to an item's history log. Any other details about the event are passed in $attributes.

Method Details

__construct() public méthode

Constructor.

public __construct ( string $auth )
$auth	string	The current user.

_getByTimestamp() abstract public méthode

Finds history objects by timestamp, and optionally filter on other fields as well.

abstract public _getByTimestamp ( string $cmp, integer $ts, array $filters = [], string $parent = null ) : array
$cmp	string	The comparison operator (<, >, <=, >=, or =) to check the timestamps with.
$ts	integer	The timestamp to compare against.
$filters	array	An array of additional (ANDed) criteria. Each array value should be an array with 3 entries: - field: the history field being compared (i.e. 'action'). - op: the operator to compare this field with. - value: the value to check for (i.e. 'add').
$parent	string	The parent history to start searching at. If non-empty, will be searched for with a LIKE '$parent:%' clause.
Résultat	array	An array of history object ids, or an empty array if none matched the criteria.

_getHistory() abstract public méthode

Returns a Horde_History_Log corresponding to the named history entry, with the data retrieved appropriately.

abstract public _getHistory ( string $guid ) : Horde_History_Log
$guid	string	The name of the history entry to retrieve.
Résultat	Horde_History_Log	A Horde_History_Log object.

_log() abstract protected méthode

Logs an event to an item's history log. Any other details about the event are passed in $attributes.

abstract protected _log ( Horde_History_Log $history, array $attributes, boolean $replaceAction = false )
$history	Horde_History_Log	The history item to add to.
$attributes	array	The hash of name => value entries that describe this event.
$replaceAction	boolean	If $attributes['action'] is already present in the item's history log, update that entry instead of creating a new one.

getActionModSeq() public méthode

Gets the modseq of the most recent change to $guid

Since: 2.1.0

public getActionModSeq ( string $guid, string $action ) : integer
$guid	string	The name of the history entry to retrieve.
$action	string	An action: 'add', 'modify', 'delete', etc.
Résultat	integer	The modseq, or 0 if no matching entry is found.

getActionTimestamp() public méthode

Gets the timestamp of the most recent change to $guid.

public getActionTimestamp ( string $guid, string $action ) : integer
$guid	string	The name of the history entry to retrieve.
$action	string	An action: 'add', 'modify', 'delete', etc.
Résultat	integer	The timestamp, or 0 if no matching entry is found.

getByModSeq() public méthode

Return history objects with changes during a modseq interval, and optionally filtered on other fields as well.

public getByModSeq ( integer $start, integer $end, array $filters = [], string $parent = null ) : array
$start	integer	The (exclusive) start of the modseq range.
$end	integer	The (inclusive) end of the modseq range.
$filters	array	An array of additional (ANDed) criteria. Each array value should be an array with 3 entries: - field: the history field being compared (i.e. 'action'). - op: the operator to compare this field with. - value: the value to check for (i.e. 'add').
$parent	string	The parent history to start searching at. If non-empty, will be searched for with a LIKE '$parent:%' clause.
Résultat	array	An array of history object ids, or an empty array if none matched the criteria.

getByTimestamp() public méthode

Finds history objects by timestamp, and optionally filter on other fields as well.

public getByTimestamp ( string $cmp, integer $ts, array $filters = [], string $parent = null ) : array
$cmp	string	The comparison operator (<, >, <=, >=, or =) to check the timestamps with.
$ts	integer	The timestamp to compare against.
$filters	array	An array of additional (ANDed) criteria. Each array value should be an array with 3 entries: - field: the history field being compared (i.e. 'action'). - op: the operator to compare this field with. - value: the value to check for (i.e. 'add').
$parent	string	The parent history to start searching at. If non-empty, will be searched for with a LIKE '$parent:%' clause.
Résultat	array	An array of history object ids, or an empty array if none matched the criteria.

getHighestModSeq() public méthode

Return the maximum modification sequence. To be overridden in concrete class.

Since: 2.1.0

public getHighestModSeq ( string $parent = null ) : integer
$parent	string	Restrict to entries a specific parent.
Résultat	integer	The modseq

getHistory() public méthode

Returns a Horde_History_Log corresponding to the named history entry, with the data retrieved appropriately.

public getHistory ( string $guid ) : Horde_History_Log
$guid	string	The name of the history entry to retrieve.
Résultat	Horde_History_Log	A Horde_History_Log object.

getLatestEntry() public méthode

Gets the latest entry of $guid

Since: 2.2.0

public getLatestEntry ( string $guid, boolean $use_ts = false ) : array \| boolean
$guid	string	The name of the history entry to retrieve.
$use_ts	boolean	If false we use the 'modseq' field to determine the latest entry. If true we use the timestamp instead of modseq to determine the latest entry. Note: Only 'modseq' can give a definitive answer.
Résultat	array \| boolean	The latest history entry, or false if $guid does not exist.

log() public méthode

The item must be uniquely identified by $guid. Any other details about the event are passed in $attributes. Standard suggested attributes are: - who: The id of the user that performed the action (will be added automatically if not present). - ts: Timestamp of the action (this will be added automatically if it is not present).

public log ( string $guid, array $attributes = [], boolean $replaceAction = false )
$guid	string	The unique identifier of the entry to add to.
$attributes	array	The hash of name => value entries that describe this event.
$replaceAction	boolean	If $attributes['action'] is already present in the item's history log, update that entry instead of creating a new one.

removeByNames() abstract public méthode

Removes one or more history entries by name.

abstract public removeByNames ( array $names )
$names	array	The history entries to remove.

removeByParent() public méthode

Remove one or more history entries by parent.

public removeByParent ( string $parent )
$parent	string	The parent name to remove.

setCache() public méthode

Set Cache object.

Since: 2.1.0

public setCache ( Horde_Cache $cache )
$cache	Horde_Cache	The cache instance.

setLogger() public méthode

Set the log handler.

public setLogger ( Horde_Log_Logger $logger ) : null
$logger	Horde_Log_Logger	The log handler.
Résultat	null

Property Details

$_auth protected_oe property

The current user.

protected string $_auth
Résultat	string

$_cache protected_oe property

Cache driver object.

protected Horde_Cache $_cache
Résultat	Horde_Cache

$_logger protected_oe property

Our log handler.

protected Horde_Log_Logger $_logger
Résultat	Horde_Log_Logger