Horde_ActiveSync_Connector_Exporter_FolderSync
extends Horde_ActiveSync_Connector_Exporter_Base
in package
Horde_ActiveSync_Connector_Exporter_FolderSync:: Responsible for outputing blocks of WBXML responses in FOLDER_SYNC responses.
Tags
Table of Contents
- $changed : array<string|int, mixed>
- Array of folder objects that have changed.
- $count : int
- Tracks the total number of folder changes
- $deleted : array<string|int, mixed>
- Array of folder ids that have been deleted on the server.
- $_as : Horde_ActiveSync
- The ActiveSync server object.
- $_changes : array<string|int, mixed>
- Local cache of changes to send.
- $_encoder : Horde_ActiveSync_Wbxml_Encoder
- The wbxml encoder
- $_procid : int
- Process id for logging.
- $_step : int
- Counter of changes sent.
- __construct() : Horde_ActiveSync_Connector_Exporter
- Const'r
- folderChange() : mixed
- Add a folder change to the cache (used during FolderSync requests).
- folderDeletion() : mixed
- Add a folder deletion to the cache (used during FolderSync Requests).
- sendNextChange() : bool|Horde_Exception
- Sends the next change in the set to the client.
- setChanges() : mixed
- Set the changes to send to the client.
- _sendNextFolderSyncChange() : mixed
- Sends the next folder change to the client.
Properties
$changed
Array of folder objects that have changed.
public
array<string|int, mixed>
$changed
= array()
Used when exporting folder structure changes since they are not streamed from this object.
$count
Tracks the total number of folder changes
public
int
$count
= 0
$deleted
Array of folder ids that have been deleted on the server.
public
array<string|int, mixed>
$deleted
= array()
$_as
The ActiveSync server object.
protected
Horde_ActiveSync
$_as
$_changes
Local cache of changes to send.
protected
array<string|int, mixed>
$_changes
= array()
$_encoder
The wbxml encoder
protected
Horde_ActiveSync_Wbxml_Encoder
$_encoder
$_procid
Process id for logging.
protected
int
$_procid
$_step
Counter of changes sent.
protected
int
$_step
= 0
Methods
__construct()
Const'r
public
__construct(Horde_ActiveSync $as[, Horde_ActiveSync_Wbxml_Encoder $encoder = null ]) : Horde_ActiveSync_Connector_Exporter
Parameters
- $as : Horde_ActiveSync
-
The ActiveSync server.
- $encoder : Horde_ActiveSync_Wbxml_Encoder = null
-
The encoder
Return values
Horde_ActiveSync_Connector_Exporter —folderChange()
Add a folder change to the cache (used during FolderSync requests).
public
folderChange(Horde_ActiveSync_Message_Folder $folder) : mixed
Parameters
- $folder : Horde_ActiveSync_Message_Folder
Return values
mixed —folderDeletion()
Add a folder deletion to the cache (used during FolderSync Requests).
public
folderDeletion(string $id) : mixed
Parameters
- $id : string
-
The folder id
Return values
mixed —sendNextChange()
Sends the next change in the set to the client.
public
sendNextChange() : bool|Horde_Exception
Return values
bool|Horde_Exception —True if more changes can be sent false if all changes were sent, Horde_Exception if there was an error sending an item.
setChanges()
Set the changes to send to the client.
public
setChanges(array<string|int, mixed> $changes[, array<string|int, mixed> $collection = null ]) : mixed
Parameters
- $changes : array<string|int, mixed>
-
The changes array returned from the collection handler.
- $collection : array<string|int, mixed> = null
-
The collection we are currently syncing.
Return values
mixed —_sendNextFolderSyncChange()
Sends the next folder change to the client.
protected
_sendNextFolderSyncChange() : mixed