\Horde_ActiveSync_Folder_RI

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

Summary

Methods
Properties
Constants
__construct()
serverid()
setServerId()
collectionClass()
setStatus()
setSoftDeleteTimes()
getSoftDeleteTimes()
updateState()
setChanges()
__toString()
added()
removed()
serialize()
unserialize()
$haveInitialSync
VERSION
No protected methods found
$_status
$_serverid
$_class
$_lastSinceDate
$_softDelete
$_contacts
$_removed
$_added
N/A
No private methods found
No private properties found
N/A

Constants

VERSION

VERSION

Properties

$haveInitialSync

$haveInitialSync : boolean

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

Type

boolean

$_status

$_status : array

The folder's current internal property state.

Type

array

$_serverid

$_serverid : string

The backend server id for this folder.

Type

string

$_class

$_class : string

The collection class.

Type

string

$_lastSinceDate

$_lastSinceDate : integer

Timestamp for the last sincedate used for SOFTDELETE.

Type

integer

$_softDelete

$_softDelete : integer

Timestamp for the last time we performed a SOFTDELETE

Type

integer

$_contacts

$_contacts : array

The current list of recipient email addresses.

Type

array

$_removed

$_removed : 

Type

$_added

$_added : 

Type

Methods

__construct()

__construct(string  $serverid, string  $class, array  $status = array()) 

Const'r

Parameters

string $serverid

The backend serverid of this folder.

string $class

The collection class.

array $status

Internal folder state.

serverid()

serverid() : string

Return the serverid for this collection.

Returns

string —

The serverid.

setServerId()

setServerId(string  $id) 

Set a new value for the serverid.

Parameters

string $id

The new id.

collectionClass()

collectionClass() : string

Return the collection class for this collection.

Returns

string —

The collection class.

setStatus()

setStatus(array  $status) 

Set the status for this collection.

Parameters

array $status

setSoftDeleteTimes()

setSoftDeleteTimes(\long  $sincedate, \long  $ts) 

Set the last softdelete timestamps used.

Parameters

\long $sincedate

The sincedate used in the last softdelete check.

\long $ts

Time the softdelete check was performed.

getSoftDeleteTimes()

getSoftDeleteTimes() : array

Return the softdelete timestamps.

Returns

array —

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

updateState()

updateState() 

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

setChanges()

setChanges(array  $contacts) 

Set the current Recipient Cache

Parameters

array $contacts

An array of email addresses. Ordered by weight.

__toString()

__toString() : string

Convert the instance into a string.

Returns

string —

The string representation for this instance.

added()

added() : array

Return the recipients that are to be added.

Returns

array —

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

removed()

removed() : array

Return the recipients that are to be deleted.

Returns

array —

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() : string

Serialize this object.

Returns

string —

The serialized data.

unserialize()

unserialize(string  $data) 

Reconstruct the object from serialized data.

Parameters

string $data

The serialized data.

Throws

\Horde_ActiveSync_Exception_StaleState