Horde_Kolab_Storage_Folder_Stamp_Uids
in package
implements
Horde_Kolab_Storage_Folder_Stamp
A folder stamp that includes a list of UIDs.
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
Interfaces, Classes, Traits and Enums
- Horde_Kolab_Storage_Folder_Stamp
- Defines unique stamps that allow to determine if folder data has changed or not.
Table of Contents
- TOKEN = 'token'
- The sync token
- UIDNEXT = 'uidnext'
- The next UID status
- UIDVALIDITY = 'uidvalidity'
- The UID validity status
- $_ids : array<string|int, mixed>
- The list of backend object IDs.
- $_status : array<string|int, mixed>
- The folder status.
- __construct() : mixed
- Constructor.
- __serialize() : array<string|int, mixed>
- __toString() : string
- Convert the instance into a string.
- __unserialize() : void
- getChanges() : array<string|int, mixed>
- What changed between this old stamp and the new provided stamp?
- getToken() : string|boolen
- Return the sync token.
- ids() : array<string|int, mixed>
- Return the backend object IDs in the folder.
- isReset() : bool
- Indicate if there was a complete folder reset.
- serialize() : string
- Serialize this object.
- uidnext() : string
- Return the folder next UID number.
- uidvalidity() : string
- Return the folder UID validity.
- unserialize() : mixed
- Reconstruct the object from serialized data.
Constants
TOKEN
The sync token
public
mixed
TOKEN
= 'token'
UIDNEXT
The next UID status
public
mixed
UIDNEXT
= 'uidnext'
UIDVALIDITY
The UID validity status
public
mixed
UIDVALIDITY
= 'uidvalidity'
Properties
$_ids
The list of backend object IDs.
protected
array<string|int, mixed>
$_ids
$_status
The folder status.
protected
array<string|int, mixed>
$_status
Methods
__construct()
Constructor.
public
__construct(array<string|int, mixed> $status, array<string|int, mixed> $ids) : mixed
Parameters
- $status : array<string|int, mixed>
-
The folder status.
- $ids : array<string|int, mixed>
-
The list of undeleted objects in the folder.
Return values
mixed —__serialize()
public
__serialize() : array<string|int, mixed>
Return values
array<string|int, mixed> —__toString()
Convert the instance into a string.
public
__toString() : string
Return values
string —The string representation for this instance.
__unserialize()
public
__unserialize(array<string|int, mixed> $data) : void
Parameters
- $data : array<string|int, mixed>
Return values
void —getChanges()
What changed between this old stamp and the new provided stamp?
public
getChanges(Horde_Kolab_Storage_Folder_Stamp_Uids $stamp) : array<string|int, mixed>
Parameters
- $stamp : Horde_Kolab_Storage_Folder_Stamp_Uids
-
The new stamp to compare against.
Return values
array<string|int, mixed> —An array of two elements (added IDs, deleted IDs).
getToken()
Return the sync token.
public
getToken() : string|boolen
Return values
string|boolen —The token provided by the IMAP client, or false if unavailable.
ids()
Return the backend object IDs in the folder.
public
ids() : array<string|int, mixed>
Return values
array<string|int, mixed> —The list of backend IDs.
isReset()
Indicate if there was a complete folder reset.
public
isReset(Horde_Kolab_Storage_Folder_Stamp $stamp) : bool
Parameters
- $stamp : Horde_Kolab_Storage_Folder_Stamp
Return values
bool —True if there was a complete folder reset stamps are different, false if not.
serialize()
Serialize this object.
public
serialize() : string
Return values
string —The serialized data.
uidnext()
Return the folder next UID number.
public
uidnext() : string
Return values
string —The next UID number.
uidvalidity()
Return the folder UID validity.
public
uidvalidity() : string
Return values
string —The folder UID validity marker.
unserialize()
Reconstruct the object from serialized data.
public
unserialize(string $data) : mixed
Parameters
- $data : string
-
The serialized data.