Class Horde_SyncMl_State

The Horde_SyncMl_State class provides a SyncML state object.

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Package: SyncMl
Author: Anthony Mills amills@pyramid6.com
Author: Jan Schneider jan@horde.org
Located at Horde/SyncMl/State.php

Methods summary
`public`	# `__construct( mixed $sourceURI, mixed $user, mixed $sessionID )` Constructor. Constructor.
`public`	# `getVerDTD( )` Returns the content based on the protocol version. Returns the content based on the protocol version.
`public`	# `getDevInfURI( )` Returns the DevInf URI based on the protocol version. Returns the DevInf URI based on the protocol version.
`public`	# `getProtocolName( )` Returns the protocol name based on the protocol version. Returns the protocol name based on the protocol version.
`public`	# `setVersion( integer $version )` Sets the protocol version Sets the protocol version Parameters `$version` <p>The protocol version: 0 for SyncML 1.0, 1 for SyncML 1.1 etc.</p>
`public string`	# `getURI( )` Returns the namespace URI for the element. Returns the namespace URI for the element. Returns `string` The namespace URI to use, if any.
`public Horde_SyncMl_Device`	# `getDevice( )` Returns a Horde_SyncMl_Device instance for the device used in this session. Returns a Horde_SyncMl_Device instance for the device used in this session. Returns `Horde_SyncMl_Device` A Horde_SyncMl_Device instance.
`public`	# `setSync( string $target, Horde_SyncMl_Sync $sync )` Parameters `$target` `$sync`
`public Horde_SyncMl_Sync`	# `getSync( string $target )` Parameters `$target` Returns `Horde_SyncMl_Sync`
`public array`	# `getSyncs( )` Returns `array`
`public boolean`	# `hasPendingSyncs( )` Returns whether there are any pending elements that have not been sent to due to message size restrictions. These will be sent int the next message. Returns whether there are any pending elements that have not been sent to due to message size restrictions. These will be sent int the next message. Returns `boolean` True if there are pending elements that have yet to be sent.
`public array`	# `getPendingSyncs( )` Returns all syncs which have pending elements left. Returns all syncs which have pending elements left. Returns `array` Array of TargetLocURIs which can be used as a key in getSync() calls.
`public boolean`	# `isAllSyncsComplete( )` Returns whether all syncs are in completed state or no syncs are present. Returns whether all syncs are in completed state or no syncs are present. Returns `boolean` True if all syncs are in completed state.
`public`	# `handleFinal( mixed & $output, mixed $debug = false )` Propagates final tags here and then further to every sync. Propagates final tags here and then further to every sync. This allows the sync objects to determine if they are complete.

Properties summary
`public string`	`$sessionID` Id of this SyncML session. Id of this SyncML session. This is not to confuse with the PHP session id, though it is part of the generated PHP session id.	#
`public integer`	`$messageID` Id of the current message. Id of the current message.	#
`public string`	`$targetURI` The target URI as sent by the client. The target URI as sent by the client. This is normally the URL of the RPC server. However the client is free to send anything.	#
`public string`	`$sourceURI` The source URI as sent by the client. The source URI as sent by the client. Can be used to identify the client and is part of the PHP session id.	#
`public integer`	`$version` SyncML protocol version. SyncML protocol version. 0 for SyncML 1.0, 1 for SyncML 1.1, etc.	#
`public string`	`$user` Username used to authenticate with the backend. Username used to authenticate with the backend.	#
`public boolean`	`$authenticated` Whether this session has authenticated successfully. Whether this session has authenticated successfully.	# `false`
`public string`	`$uriMeta` namespace uri. namespace uri.	#
`public string`	`$uriDevInf` namespace uri. namespace uri.	#
`public boolean`	`$wbxml` Whether WBXML encoding is used. Whether WBXML encoding is used.	# `false`
`public integer`	`$maxMsgSize` The maximum allowed message size in bytes. The maximum allowed message size in bytes.	# `1000000000`
`public array`	`$serverChanges` The list of all server changes being sent to the client as a reference for Status responses from the client. The list of all server changes being sent to the client as a reference for Status responses from the client.	# `array()`
`public Horde_SyncMl_DeviceInfo`	`$deviceInfo` Device info provided by the SyncML DevInf data. Device info provided by the SyncML DevInf data.	#
`public Horde_SyncMl_SyncElement`	`$curSyncItem` Current sync element sent from client. Current sync element sent from client. Stored in state if one element is split into multiple message packets.	#
`public boolean`	`$delayedFinal` Flag that is set if the client sends a Final but we are not finished with the current package and thus can't final this package yet. Flag that is set if the client sends a Final but we are not finished with the current package and thus can't final this package yet.	# `false`

Packages

Classes

Class Horde_SyncMl_State

Parameters

Returns

Returns

Parameters

Parameters

Returns

Returns

Returns

Returns

Returns