| Свойство | Тип | Описание | |
|---|---|---|---|
| $_auth | string | The current user. | |
| $_cache | Horde_Cache | Cache driver object. | |
| $_logger | Horde_Log_Logger | Our log handler. |
| Метод | Описание | |
|---|---|---|
| __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. |
| Метод | Описание | |
|---|---|---|
| _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. |
| public __construct ( string $auth ) | ||
| $auth | string | The current user. |
| 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. |
| Результат | array | An array of history object ids, or an empty array if none matched the criteria. |
| abstract public _getHistory ( string $guid ) : Horde_History_Log | ||
| $guid | string | The name of the history entry to retrieve. |
| Результат | Horde_History_Log | A Horde_History_Log object. |
| 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. |
| 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. |
| Результат | array | An array of history object ids, or an empty array if none matched the criteria. |
| 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. |
| Результат | array | An array of history object ids, or an empty array if none matched the criteria. |
| public getHighestModSeq ( string $parent = null ) : integer | ||
| $parent | string | Restrict to entries a specific parent. |
| Результат | integer | The modseq |
| public getHistory ( string $guid ) : Horde_History_Log | ||
| $guid | string | The name of the history entry to retrieve. |
| Результат | Horde_History_Log | A Horde_History_Log object. |
| 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. |
| Результат | array | boolean | The latest history entry, or false if $guid does not exist. |
| 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. |
| abstract public removeByNames ( array $names ) | ||
| $names | array | The history entries to remove. |
| public removeByParent ( string $parent ) | ||
| $parent | string | The parent name to remove. |
| public setCache ( Horde_Cache $cache ) | ||
| $cache | Horde_Cache | The cache instance. |
| protected Horde_Cache $_cache | ||
| Результат | Horde_Cache | |