• Home
  • Horde_Kolab_Storage_Folder_Stamp_Uids

PHP Class Horde_Kolab_Storage_Folder_Stamp_Uids, horde

Copyright 2011-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
See link: http://pear.horde.org/index.php?package=Kolab_Storage
Author: Thomas Jarosch ([email protected])
Author: Gunnar Wrobel ([email protected])
Inheritance: implements Horde_Kolab_Storage_Folder_Stamp
Show file Open project: horde/horde

Protected Properties

Property Type Description
$_ids array The list of backend object IDs.
$_status array The folder status.

Public Methods

Method Description
__construct ( array $status, array $ids ) Constructor.
__toString ( ) : string Convert the instance into a string.
getChanges ( Horde_Kolab_Storage_Folder_Stamp $stamp ) : array What changed between this old stamp and the new provided stamp?
getToken ( ) : string | boolen Return the sync token.
ids ( ) : array Return the backend object IDs in the folder.
isReset ( Horde_Kolab_Storage_Folder_Stamp $stamp ) : boolean 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 ( string $data ) Reconstruct the object from serialized data.

Method Details

__construct() public method

Constructor.
public __construct ( array $status, array $ids )
$status array The folder status.
$ids array The list of undeleted objects in the folder.

__toString() public method

Convert the instance into a string.
public __toString ( ) : string
return string The string representation for this instance.

getChanges() public method

What changed between this old stamp and the new provided stamp?
public getChanges ( Horde_Kolab_Storage_Folder_Stamp $stamp ) : array
$stamp Horde_Kolab_Storage_Folder_Stamp The new stamp to compare against.
return array An array of two elements (added IDs, deleted IDs).

getToken() public method

Return the sync token.
public getToken ( ) : string | boolen
return string | boolen The token provided by the IMAP client, or false if unavailable.

ids() public method

Return the backend object IDs in the folder.
public ids ( ) : array
return array The list of backend IDs.

isReset() public method

Indicate if there was a complete folder reset.
public isReset ( Horde_Kolab_Storage_Folder_Stamp $stamp ) : boolean
$stamp Horde_Kolab_Storage_Folder_Stamp
return boolean True if there was a complete folder reset stamps are different, false if not.

serialize() public method

Serialize this object.
public serialize ( ) : string
return string The serialized data.

uidnext() public method

Return the folder next UID number.
public uidnext ( ) : string
return string The next UID number.

uidvalidity() public method

Return the folder UID validity.
public uidvalidity ( ) : string
return string The folder UID validity marker.

unserialize() public method

Reconstruct the object from serialized data.
public unserialize ( string $data )
$data string The serialized data.

Property Details

$_ids protected property

The list of backend object IDs.
protected array $_ids
return array

$_status protected property

The folder status.
protected array $_status
return array