PHP Class Horde_History_Mock, horde

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

Author: Gunnar Wrobel ([email protected])

Inheritance: extends Horde_History

Datei anzeigen Open project: horde/horde

Public Properties

Property	Type	Description
$getCount	integer	Used for testing caching.

Public Methods

Method	Description
_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.
getHighestModSeq ( string $parent = null ) : integer \| boolean	Return the current value of the modseq. We take the MAX of the horde_histories table instead of the value of the horde_histories_modseq table to ensure we never miss an entry if we query the history system between the time we call nextModSeq() and the time the new entry is written.
removeByNames ( array $names )	Removes one or more history entries by name.

Protected Methods

Method	Description
_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.
_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

_getByModSeq() protected method

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

protected _getByModSeq ( integer $start, integer $end, array $filters = [], string $parent = null ) : array
$start	integer	The start of the modseq range.
$end	integer	The 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.
return	array	An array of history object ids, or an empty array if none matched the criteria.

_getByTimestamp() public method

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.
return	array	An array of history object ids, or an empty array if none matched the criteria.

_getHistory() public method

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.
return	Horde_History_Log	A Horde_History_Log object.

_log() protected method

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

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.

getHighestModSeq() public method

Return the current value of the modseq. We take the MAX of the horde_histories table instead of the value of the horde_histories_modseq table to ensure we never miss an entry if we query the history system between the time we call nextModSeq() and the time the new entry is written.

public getHighestModSeq ( string $parent = null ) : integer \| boolean
$parent	string	Restrict to entries a specific parent.
return	integer \| boolean	The highest used modseq value, false if no history.

removeByNames() public method

Removes one or more history entries by name.

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

Property Details

$getCount public_oe property

Used for testing caching.

public int $getCount
return	integer