Horde_Kolab_Storage_Folder_Stamp
extends
Serializable
in
Defines unique stamps that allow to determine if folder data has changed or not.
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
Table of Contents
- ADDED = 'a'
- List of added IDs
- DELETED = 'd'
- List of deleted IDs
- getChanges() : array<string|int, mixed>|bool
- 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.
Constants
ADDED
List of added IDs
public
mixed
ADDED
= 'a'
DELETED
List of deleted IDs
public
mixed
DELETED
= 'd'
Methods
getChanges()
What changed between this old stamp and the new provided stamp?
public
getChanges(Horde_Kolab_Storage_Folder_Stamp $stamp) : array<string|int, mixed>|bool
Parameters
- $stamp : Horde_Kolab_Storage_Folder_Stamp
Return values
array<string|int, mixed>|bool —False if there was no change, an array of two elements (added IDs, deleted IDs) otherwise.
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.