PHP Class Horde_Kolab_Storage_Data_Query_History_Base, horde

Copyright 2011-2014 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Inheritance: implements Horde_Kolab_Storage_Data_Query_History
Mostra file Open project: horde/horde Class Usage Examples

Protected Properties

Property Type Description
$_data Horde_Kolab_Storage_Data The queriable data.
$_factory Horde_Kolab_Storage_Factory The Kolab factory.
$_history Horde_History The history handler.
$_logger Horde_Log_Logger The logger

Public Methods

Method Description
__construct ( Horde_Kolab_Storage_Data $data, array $params ) Constructor.
setLogger ( Horde_Log_Logger $logger = null ) Set the logger
synchronize ( array $params = [] ) Synchronize any changes with the History driver.

Protected Methods

Method Description
_completeSynchronization ( string $prefix, boolean $is_reset ) Perform a complete synchronization.
_updateLog ( string $object, string $bid, boolean $force = false ) Update the history log for an object.

Method Details

__construct() public method

Constructor.
public __construct ( Horde_Kolab_Storage_Data $data, array $params )
$data Horde_Kolab_Storage_Data The queriable data.
$params array Additional parameters. - factory: (Horde_Kolab_Storage_Factory) The factory object.

_completeSynchronization() protected method

Also marks stale history entries as 'deleted'.
protected _completeSynchronization ( string $prefix, boolean $is_reset )
$prefix string Horde_History prefix
$is_reset boolean Flag to indicate if the UIDVALIDITY changed

_updateLog() protected method

Update the history log for an object.
protected _updateLog ( string $object, string $bid, boolean $force = false )
$object string The object ID.
$bid string The backend ID of the object.
$force boolean Force update

setLogger() public method

Set the logger
public setLogger ( Horde_Log_Logger $logger = null )
$logger Horde_Log_Logger The logger instance.

synchronize() public method

Synchronize any changes with the History driver.
public synchronize ( array $params = [] )
$params array Additional parameters: - changes: (array) An array of arrays keyed by backend id containing information about each change. If not present, triggers a full history sync. - is_reset: (boolean) If true, indicates that UIDVALIDITY changed.

Property Details

$_data protected_oe property

The queriable data.
protected Horde_Kolab_Storage_Data $_data
return Horde_Kolab_Storage_Data

$_factory protected_oe property

The Kolab factory.
protected Horde_Kolab_Storage_Factory $_factory
return Horde_Kolab_Storage_Factory

$_history protected_oe property

The history handler.
protected Horde_History $_history
return Horde_History

$_logger protected_oe property

The logger
protected Horde_Log_Logger $_logger
return Horde_Log_Logger