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])
파일 보기 프로젝트 열기: horde/horde

공개 프로퍼티들

프로퍼티 타입 설명
$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.

보호된 프로퍼티들

프로퍼티 타입 설명
$_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