Documentation

Horde_Kolab_Storage_Data_Query_History_Base
in package
implements Horde_Kolab_Storage_Data_Query_History

The hook that updates the Horde history information once data gets synchronized with the Kolab backend.

Copyright 2011-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Tags
category

Kolab

author

Gunnar Wrobel wrobel@pardus.de

author

Thomas Jarosch thomas.jarosch@intra2net.com

author

Michael J Rubinsky mrubinsk@horde.org

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

Interfaces, Classes, Traits and Enums

Horde_Kolab_Storage_Data_Query_History
Defines the data synchronization hook for history data.

Table of Contents

$_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
__construct()  : mixed
Constructor.
setLogger()  : mixed
Set the logger
synchronize()  : mixed
Synchronize any changes with the History driver.
_completeSynchronization()  : mixed
Perform a complete synchronization.
_updateLog()  : mixed
Update the history log for an object.

Properties

$_history

The history handler.

protected Horde_History $_history

$_logger

The logger

protected Horde_Log_Logger $_logger

Methods

__construct()

Constructor.

public __construct(Horde_Kolab_Storage_Data $data, array<string|int, mixed> $params) : mixed
Parameters
$data : Horde_Kolab_Storage_Data

The queriable data.

$params : array<string|int, mixed>

Additional parameters.

  • factory: (Horde_Kolab_Storage_Factory) The factory object.
Return values
mixed —

setLogger()

Set the logger

public setLogger([Horde_Log_Logger $logger = null ]) : mixed
Parameters
$logger : Horde_Log_Logger = null

The logger instance.

Return values
mixed —

synchronize()

Synchronize any changes with the History driver.

public synchronize([array<string|int, mixed> $params = array() ]) : mixed
Parameters
$params : array<string|int, mixed> = 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.
Return values
mixed —

_completeSynchronization()

Perform a complete synchronization.

protected _completeSynchronization(string $prefix, bool $is_reset) : mixed

Also marks stale history entries as 'deleted'.

Parameters
$prefix : string

Horde_History prefix

$is_reset : bool

Flag to indicate if the UIDVALIDITY changed

Return values
mixed —

_updateLog()

Update the history log for an object.

protected _updateLog(string $object, string $bid[, bool $force = false ]) : mixed
Parameters
$object : string

The object ID.

$bid : string

The backend ID of the object.

$force : bool = false

Force update

Return values
mixed —

Search results