PHP Класс Horde_SyncMl_State, horde

Copyright 2003-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.
Автор: Anthony Mills ([email protected])
Автор: Jan Schneider ([email protected])
Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
$authenticated boolean Whether this session has authenticated successfully.
$curSyncItem Horde_SyncMl_SyncElement Stored in state if one element is split into multiple message packets.
$delayedFinal boolean 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.
$deviceInfo Horde_SyncMl_DeviceInfo Device info provided by the SyncML DevInf data.
$maxMsgSize integer The maximum allowed message size in bytes.
$maxObjSize integer The maximum allowed object size in bytes.
$messageID integer Id of the current message.
$serverChanges array The list of all server changes being sent to the client as a reference for Status responses from the client.
$sessionID string This is not to confuse with the PHP session id, though it is part of the generated PHP session id.
$sourceURI string Can be used to identify the client and is part of the PHP session id.
$targetURI string This is normally the URL of the RPC server. However the client is free to send anything.
$uriDevInf string namespace uri.
$uriMeta string namespace uri.
$user string Username used to authenticate with the backend.
$version integer 0 for SyncML 1.0, 1 for SyncML 1.1, etc.
$wbxml boolean Whether WBXML encoding is used.

Защищенные свойства (Protected)

Свойство Тип Описание
$_deviceDriver string Name of the appropriate device driver.
$_syncs array Array of Horde_SyncMl_Sync objects.
$_uri string namespace uri.

Открытые методы

Метод Описание
__construct ( $sourceURI, $user, $sessionID ) Constructor.
getDevInfURI ( ) Returns the DevInf URI based on the protocol version.
getDevice ( ) : Horde_SyncMl_Device Returns a Horde_SyncMl_Device instance for the device used in this session.
getPendingSyncs ( ) : array Returns all syncs which have pending elements left.
getProtocolName ( ) Returns the protocol name based on the protocol version.
getSync ( string $target ) : Horde_SyncMl_Sync
getSyncs ( ) : array
getURI ( ) : string Returns the namespace URI for the element.
getVerDTD ( ) Returns the content based on the protocol version.
handleFinal ( &$output, $debug = false ) Propagates final tags here and then further to every sync.
hasPendingSyncs ( ) : boolean 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.
isAllSyncsComplete ( ) : boolean Returns whether all syncs are in completed state or no syncs are present.
setSync ( string $target, Horde_SyncMl_Sync $sync )
setVersion ( integer $version ) Sets the protocol version

Описание методов

__construct() публичный Метод

Constructor.
public __construct ( $sourceURI, $user, $sessionID )

getDevInfURI() публичный Метод

Returns the DevInf URI based on the protocol version.
public getDevInfURI ( )

getDevice() публичный Метод

Returns a Horde_SyncMl_Device instance for the device used in this session.
public getDevice ( ) : Horde_SyncMl_Device
Результат Horde_SyncMl_Device A Horde_SyncMl_Device instance.

getPendingSyncs() публичный Метод

Returns all syncs which have pending elements left.
public getPendingSyncs ( ) : array
Результат array Array of TargetLocURIs which can be used as a key in getSync() calls.

getProtocolName() публичный Метод

Returns the protocol name based on the protocol version.
public getProtocolName ( )

getSync() публичный Метод

public getSync ( string $target ) : Horde_SyncMl_Sync
$target string
Результат Horde_SyncMl_Sync

getSyncs() публичный Метод

public getSyncs ( ) : array
Результат array

getURI() публичный Метод

Returns the namespace URI for the element.
public getURI ( ) : string
Результат string The namespace URI to use, if any.

getVerDTD() публичный Метод

Returns the content based on the protocol version.
public getVerDTD ( )

handleFinal() публичный Метод

This allows the sync objects to determine if they are complete.
public handleFinal ( &$output, $debug = false )

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.
public hasPendingSyncs ( ) : boolean
Результат boolean True if there are pending elements that have yet to be sent.

isAllSyncsComplete() публичный Метод

Returns whether all syncs are in completed state or no syncs are present.
public isAllSyncsComplete ( ) : boolean
Результат boolean True if all syncs are in completed state.

setSync() публичный Метод

public setSync ( string $target, Horde_SyncMl_Sync $sync )
$target string
$sync Horde_SyncMl_Sync

setVersion() публичный Метод

Sets the protocol version
public setVersion ( integer $version )
$version integer The protocol version: 0 for SyncML 1.0, 1 for SyncML 1.1 etc.

Описание свойств

$_deviceDriver защищенное свойство

Name of the appropriate device driver.
protected string $_deviceDriver
Результат string

$_syncs защищенное свойство

Array of Horde_SyncMl_Sync objects.
protected array $_syncs
Результат array

$_uri защищенное свойство

namespace uri.
protected string $_uri
Результат string

$authenticated публичное свойство

Whether this session has authenticated successfully.
public bool $authenticated
Результат boolean

$curSyncItem публичное свойство

Stored in state if one element is split into multiple message packets.
public Horde_SyncMl_SyncElement $curSyncItem
Результат Horde_SyncMl_SyncElement

$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.
public bool $delayedFinal
Результат boolean

$deviceInfo публичное свойство

Device info provided by the SyncML DevInf data.
public Horde_SyncMl_DeviceInfo $deviceInfo
Результат Horde_SyncMl_DeviceInfo

$maxMsgSize публичное свойство

The maximum allowed message size in bytes.
public int $maxMsgSize
Результат integer

$maxObjSize публичное свойство

The maximum allowed object size in bytes.
public int $maxObjSize
Результат integer

$messageID публичное свойство

Id of the current message.
public int $messageID
Результат integer

$serverChanges публичное свойство

The list of all server changes being sent to the client as a reference for Status responses from the client.
public array $serverChanges
Результат array

$sessionID публичное свойство

This is not to confuse with the PHP session id, though it is part of the generated PHP session id.
public string $sessionID
Результат string

$sourceURI публичное свойство

Can be used to identify the client and is part of the PHP session id.
public string $sourceURI
Результат string

$targetURI публичное свойство

This is normally the URL of the RPC server. However the client is free to send anything.
public string $targetURI
Результат string

$uriDevInf публичное свойство

namespace uri.
public string $uriDevInf
Результат string

$uriMeta публичное свойство

namespace uri.
public string $uriMeta
Результат string

$user публичное свойство

Username used to authenticate with the backend.
public string $user
Результат string

$version публичное свойство

0 for SyncML 1.0, 1 for SyncML 1.1, etc.
public int $version
Результат integer

$wbxml публичное свойство

Whether WBXML encoding is used.
public bool $wbxml
Результат boolean