Documentation

Horde_ActiveSync_Folder_RI extends Horde_ActiveSync_Folder_Base
in package
implements Serializable

The class contains functionality for maintaining state for the Recipient Information Cache.

Tags
license

http://www.horde.org/licenses/gpl GPLv2

copyright

2014-2020 Horde LLC (http://www.horde.org)

author

Michael J Rubinsky mrubinsk@horde.org

Interfaces, Classes, Traits and Enums

Serializable

Table of Contents

VERSION  = 1
$haveInitialSync  : bool
Flag for indicating we have an initial sync for this collection.
$_added  : mixed
$_class  : string
The collection class.
$_contacts  : array<string|int, mixed>
The current list of recipient email addresses.
$_lastSinceDate  : int
Timestamp for the last sincedate used for SOFTDELETE.
$_removed  : mixed
$_serverid  : string
The backend server id for this folder.
$_softDelete  : int
Timestamp for the last time we performed a SOFTDELETE
$_status  : array<string|int, mixed>
The folder's current internal property state.
__construct()  : mixed
Const'r
__toString()  : string
Convert the instance into a string.
added()  : array<string|int, mixed>
Return the recipients that are to be added.
collectionClass()  : string
Return the collection class for this collection.
getSoftDeleteTimes()  : array<string|int, mixed>
Return the softdelete timestamps.
removed()  : array<string|int, mixed>
Return the recipients that are to be deleted.
serialize()  : string
Serialize this object.
serverid()  : string
Return the serverid for this collection.
setChanges()  : mixed
Set the current Recipient Cache
setServerId()  : mixed
Set a new value for the serverid.
setSoftDeleteTimes()  : mixed
Set the last softdelete timestamps used.
setStatus()  : mixed
Set the status for this collection.
unserialize()  : mixed
Reconstruct the object from serialized data.
updateState()  : mixed
Updates the internal UID cache, and clears the internal update/deleted/changed cache.

Constants

VERSION

public mixed VERSION = 1

Properties

$haveInitialSync

Flag for indicating we have an initial sync for this collection.

public bool $haveInitialSync = \false

$_added

protected mixed $_added = array()

$_class

The collection class.

protected string $_class

$_contacts

The current list of recipient email addresses.

protected array<string|int, mixed> $_contacts = array()

$_lastSinceDate

Timestamp for the last sincedate used for SOFTDELETE.

protected int $_lastSinceDate = 0

$_removed

protected mixed $_removed = array()

$_serverid

The backend server id for this folder.

protected string $_serverid = 'RI'

$_softDelete

Timestamp for the last time we performed a SOFTDELETE

protected int $_softDelete = 0

$_status

The folder's current internal property state.

protected array<string|int, mixed> $_status = array()

Methods

__construct()

Const'r

public __construct(string $serverid, string $class[, array<string|int, mixed> $status = array() ]) : mixed
Parameters
$serverid : string

The backend serverid of this folder.

$class : string

The collection class.

$status : array<string|int, mixed> = array()

Internal folder state.

Return values
mixed

__toString()

Convert the instance into a string.

public __toString() : string
Return values
string

The string representation for this instance.

added()

Return the recipients that are to be added.

public added() : array<string|int, mixed>
Return values
array<string|int, mixed>

An array of psuedo-uids consisting of the the email address, a colon, and the weighed rank. E.g. user@example.com:10

collectionClass()

Return the collection class for this collection.

public collectionClass() : string
Return values
string

The collection class.

getSoftDeleteTimes()

Return the softdelete timestamps.

public getSoftDeleteTimes() : array<string|int, mixed>
Return values
array<string|int, mixed>

An array with the last sincedate in the 0 element and the last timestamp in the 1 element.

removed()

Return the recipients that are to be deleted.

public removed() : array<string|int, mixed>
Return values
array<string|int, mixed>

An array of psuedo-uids consisting of the the email address, a colon, and the weighed rank. E.g. user@example.com:10

serialize()

Serialize this object.

public serialize() : string
Return values
string

The serialized data.

serverid()

Return the serverid for this collection.

public serverid() : string
Return values
string

The serverid.

setChanges()

Set the current Recipient Cache

public setChanges(array<string|int, mixed> $contacts) : mixed
Parameters
$contacts : array<string|int, mixed>

An array of email addresses. Ordered by weight.

Return values
mixed

setServerId()

Set a new value for the serverid.

public setServerId(string $id) : mixed
Parameters
$id : string

The new id.

Tags
since
2.4.0
todo

For H6 make these all __get/__set calls.

Return values
mixed

setSoftDeleteTimes()

Set the last softdelete timestamps used.

public setSoftDeleteTimes(long $sincedate, long $ts) : mixed
Parameters
$sincedate : long

The sincedate used in the last softdelete check.

$ts : long

Time the softdelete check was performed.

Return values
mixed

setStatus()

Set the status for this collection.

public setStatus(array<string|int, mixed> $status) : mixed
Parameters
$status : array<string|int, mixed>
Return values
mixed

unserialize()

Reconstruct the object from serialized data.

public unserialize(string $data) : mixed
Parameters
$data : string

The serialized data.

Tags
throws
Horde_ActiveSync_Exception_StaleState
Return values
mixed

updateState()

Updates the internal UID cache, and clears the internal update/deleted/changed cache.

public updateState() : mixed
Return values
mixed

Search results