PHP Class Horde_SyncMl_Device, horde

If a sync client needs any kind of special conversion of the data sent to it or received from it, this is done here. There are two sources of information to identify an device: The first (and better) one is the DevInf device info sent by the device during a request. If DevInf is not supported or sent by the client, the Source/LocURI of the device request might be sufficent to identify it. Copyright 2005-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.

Author: Karsten Fourmont ([email protected])

ファイルを表示 Open project: horde/horde Class Usage Examples

Public Properties

Property	Type	Description
$requestedContentType	string	The original preferred content type of the client, if provided through DevInf.

Public Methods

Method	Description
convertClient2Server ( string $content, string $contentType ) : array	Converts the content received from the client for the backend.
convertServer2Client ( string $content, string $contentType, string $database ) : array	Converts the content from the backend to a format suitable for the client device.
factory ( string $driver ) : Horde_SyncMl_Device	Attempts to return a concrete Horde_SyncMl_Device instance based on $driver.
getPreferredContentType ( string $database ) : string	Returns the guessed content type for a database URI.
getPreferredContentTypeClient ( string $serverSyncURI, string $sourceSyncURI )	Returns the preferrred MIME content type of the client for the given sync data type (contacts/tasks/notes/calendar).
handleTasksInCalendar ( ) : boolean	Returns whether the device handles tasks and events in a single "calendar" sync.
omitIndividualSyncStatus ( ) : boolean	Returns whether to send individual status response for each Add, Delete and Replace.
useCdataTag ( ) : boolean	Returns whether the payload data should be enclosed in a [CDATA[ section when sending via XML.
useLocalTime ( ) : boolean	Returns whether the device accepts datetimes only in local time format (DTSTART:20061222T130000) instead of the more robust UTC time (DTSTART:20061222T110000Z).

Protected Methods

Method	Description
_convertUTC2LocalTime ( array $utc ) : string	Converts an UTC timestamp like "20061222T110000Z" into a local timestamp like "20061222T130000" using the server timezone.

Method Details

_convertUTC2LocalTime() protected method

Converts an UTC timestamp like "20061222T110000Z" into a local timestamp like "20061222T130000" using the server timezone.

protected _convertUTC2LocalTime ( array $utc ) : string
$utc	array	Array with a datetime string in UTC.
return	string	The datetime string converted to the local timezone.

convertClient2Server() public method

Currently strips UID (primary key) information as client and server might use different ones. Charset conversions might be added here too.

public convertClient2Server ( string $content, string $contentType ) : array
$content	string	The content to convert.
$contentType	string	The content type of the content.
return	array	Two-element array with the converted content and the (possibly changed) new content type.

convertServer2Client() public method

Strips the UID (primary key) information as client and server might use different ones. Charset conversions might be added here too.

public convertServer2Client ( string $content, string $contentType, string $database ) : array
$content	string	The content to convert
$contentType	string	The content type of content as returned from the backend
$database	string	The server database URI.
return	array	Three-element array with the converted content, the (possibly changed) new content type, and encoding type (like b64 as used by Funambol).

factory() public method

Attempts to return a concrete Horde_SyncMl_Device instance based on $driver.

public factory ( string $driver ) : Horde_SyncMl_Device
$driver	string	The type of concrete Horde_SyncMl_Device subclass to return.
return	Horde_SyncMl_Device	The newly created concrete Horde_SyncMl_Device instance, or false on error.

getPreferredContentType() public method

When a client sends data during a sync but does not provide information about the MIME content type with this individual item, this function returns the content type the item is supposed to be in.

public getPreferredContentType ( string $database ) : string
$database	string	A database URI.
return	string	A MIME type that might match the database URI.

getPreferredContentTypeClient() public method

The result is passed as an option to the backend export functions. This is not the content type ultimately passed to the client but rather the content type presented to the backend export functions. After the data is retrieved from the backend, convertServer2Client() can do some post-processing and set the correct content type acceptable for the client if necessary. The default implementation tries to extract the content type from the device info. If this does not work, some defaults are used. If the client does not provice proper DevInf data, this public function may have to be overwritten to return the correct values.

public getPreferredContentTypeClient ( string $serverSyncURI, string $sourceSyncURI )
$serverSyncURI	string	The URI for the server database: contacts, notes, calendar or tasks.
$sourceSyncURI	string	The URI for the client database. This is needed as the DevInf is grouped by sourceSyncURIs.

handleTasksInCalendar() public method

This requires special actions on our side as we store this in different backend databases.

public handleTasksInCalendar ( ) : boolean
return	boolean	True if tasks and events are processed in a single request.

omitIndividualSyncStatus() public method

Returns whether to send individual status response for each Add, Delete and Replace.

public omitIndividualSyncStatus ( ) : boolean
return	boolean	False if individual status responses should be send.

useCdataTag() public method

The synchronized data may contain XML special characters like &, < or >. Clients might choke when sending these embedded in XML. The data should be enclosed in [CDATA[ in these cases. This applies only to XML, not to WBXML devices.

public useCdataTag ( ) : boolean
return	boolean	True if the data should be enclosed in [CDATA[.

useLocalTime() public method

Returns whether the device accepts datetimes only in local time format (DTSTART:20061222T130000) instead of the more robust UTC time (DTSTART:20061222T110000Z).

public useLocalTime ( ) : boolean
return	boolean	True if the client doesn't accept UTC datetimes.

Property Details

$requestedContentType public_oe property

The original preferred content type of the client, if provided through DevInf.

public string $requestedContentType
return	string