API Documentation
\

\Horde_ActiveSync_Connector_Exporter_Sync

Horde_ActiveSync_Connector_Exporter_Sync:: Responsible for outputing blocks of WBXML responses in SYNC responses. E.g., sending all WBXML necessary to transmit a new/changed message object to the client.

Summary

Methods
Properties
Constants
__construct()
setChanges()
sendNextChange()
messageChange()
messageDeletion()
messageMove()
syncAddResponse()
syncModifiedResponse()
modifyFailures()
missingRemove()
fetchIds()
syncFolderType()
syncKey()
syncFolderId()
syncStatus()
No public properties found
No constants found
_sendEas16MessageResponse()
_getNextChange()
_sendNextChange()
$_encoder
$_changes
$_step
$_as
$_procid
$_seenObjects
$_currentCollection
N/A
No private methods found
No private properties found
N/A

Properties

$_changes

$_changes : array

Local cache of changes to send.

Type

array

$_step

$_step : integer

Counter of changes sent.

Type

integer

$_procid

$_procid : integer

Process id for logging.

Type

integer

$_seenObjects

$_seenObjects : array

Local cache of object ids we have already dealt with.

Type

array

$_currentCollection

$_currentCollection : array

Currently syncing collection.

Type

array

Methods

__construct()

__construct(\Horde_ActiveSync  $as, \Horde_ActiveSync_Wbxml_Encoder  $encoder = null) : \Horde_ActiveSync_Connector_Exporter

Const'r

Parameters

\Horde_ActiveSync $as

The ActiveSync server.
\Horde_ActiveSync_Wbxml_Encoder $encoder

The encoder

Returns

\Horde_ActiveSync_Connector_Exporter

setChanges()

setChanges(array  $changes, array  $collection = null)

Set the changes to send to the client.

Parameters

array $changes

The changes array returned from the collection handler.
array $collection

The collection we are currently syncing.

sendNextChange()

sendNextChange() : boolean|\Horde_Exception

Sends the next change in the set to the client.

Returns

boolean|\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.

messageChange()

messageChange(string  $id, \Horde_ActiveSync_Message_Base  $message)

Send a message change over the wbxml stream

Parameters

string $id

The uid of the message
\Horde_ActiveSync_Message_Base $message

The message object

messageDeletion()

messageDeletion(string  $id, boolean  $soft = false)

Stream a message deletion to the client.

Parameters

string $id

The uid of the message we are deleting.
boolean $soft

If true, send a SOFTDELETE, otherwise a REMOVE.

messageMove()

messageMove(\Horde_ActiveSync_Message_Base  $message)

Move a message to a different folder.

Parameters

\Horde_ActiveSync_Message_Base $message

The message

syncAddResponse()

syncAddResponse(array  $collection)

Send the SYNC_ADD response for any items added from the client.

Parameters

array $collection

The collection array.

syncModifiedResponse()

syncModifiedResponse(array  $collection)

Send the SYNC_MODIFY response for each modified item that requires this response.

@see self::syncAddResponse()

Parameters

array $collection

The collection array.

modifyFailures()

modifyFailures(array  $collection)

Send the SYNC_MODIFY response for any items modified from the client that require this response. Basically any items that have AirSyncBaseAttachments changes.

Parameters

array $collection

The collection array.

missingRemove()

missingRemove(array  $collection)

Send the SYNC_REMOVE response for any items deleted from the client but were unable to be removed on the server. Usually due to not being found.

Parameters

array $collection

The collection array.

fetchIds()

fetchIds(  $driver, array  $collection)

Send the SYNC_FETCH response for any items requested by the client.

Parameters

$driver
array $collection

The collection array.

syncFolderType()

syncFolderType(array  $collection)

Send the SYNC_FOLDERTYPE node if needed.

Parameters

array $collection

The collection array.

syncKey()

syncKey(array  $collection)

Send the SYNC_SYNCKEY response appropriate for this response.

Parameters

array $collection

The collection array.

syncFolderId()

syncFolderId(array  $collection)

Send the SYNC_FOLDERID value.

Parameters

array $collection

The collection array.

syncStatus()

syncStatus(  $statusCode)

Send the SYNC_STATUS value.

Parameters

$statusCode

_sendEas16MessageResponse()

_sendEas16MessageResponse(string  $serverid, array  $collection)

Sends the appropriate message object reply within a SYNC_ADD or SYNC_MODIFY block in a SYNC_REPLIES block for EAS >= 16 clients.

Parameters

string $serverid

The serverid of the message being sent.
array $collection

The collection array.

_getNextChange()

_getNextChange()

_sendNextChange()

_sendNextChange() : \@see

Sends the next message change to the client.

Returns

\@see —

self::sendNextChange()