PHP Класс Horde_SyncMl_XmlOutput, horde

Each member public function creates one type of SyncML artefact (like a Status response). Currently some of the information is retrieved from state. Maybe remove these dependencies (by providing the data as parameter) for an even cleaner implementation. The Horde_SyncMl_XmlOutput class takes automatically care of creating a unique CmdID for each command created. Copyright 2006-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.
Автор: Karsten Fourmont ([email protected])
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$output The outputhandler to whom the XML is passed: like Horde_Xml_Wbxml_Encoder

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

Свойство Тип Описание
$_msg_CmdID The CmdID provides a unique ID for each command in a syncml packet.
$_uri

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

Метод Описание
getOutput ( ) The final output as procuded by the _output Encoder. Either an XML string or a WBXML string.
getOutputSize ( ) The length of the output as produced by the Encoder. To limit the size of individual messages.
init ( &$theoutputhandler )
isWBXML ( ) To we create wbxml or not?
outputAlert ( $alertCode, $clientDB = '', $serverDB = '', $lastAnchor = '', $nextAnchor = '' )
outputBodyStart ( )
outputDevInf ( $cmdRef )
outputEnd ( )
outputFinal ( )
outputGetDevInf ( )
outputHeader ( string $respURI ) Creates a SyncHdr output.
outputInit ( )
outputStatus ( $cmdRef, $cmd, $data, $targetRef = '', $sourceRef = '', $syncAnchorNext = '', $syncAnchorLast = '' )
outputSyncCommand ( string $command, string $content = null, string $contentType = null, string $encodingType = null, string $cuid = null, string $suid = null, integer $contentSize = null, boolean $moreData = false ) : integer Creates a single Sync command
outputSyncEnd ( )
outputSyncStart ( $clientLocURI, $serverLocURI, $numberOfChanges = null )
singleton ( )

Защищенные методы

Метод Описание
_outputCmdID ( ) internal helper functions:
_singleEle ( $tag, $str, $uri = null ) Output a single $str element.
_writeDataStore ( string $sourceref, string $mimetype, string $version, Horde_Xml_Wbxml_ContentHandler &$output, array $additionaltypes = [] ) Writes DevInf data for one DataStore.

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

_outputCmdID() защищенный Метод

internal helper functions:
protected _outputCmdID ( )

_singleEle() защищенный Метод

Output a single $str element.
protected _singleEle ( $tag, $str, $uri = null )

_writeDataStore() защищенный Метод

Writes DevInf data for one DataStore.
protected _writeDataStore ( string $sourceref, string $mimetype, string $version, Horde_Xml_Wbxml_ContentHandler &$output, array $additionaltypes = [] )
$sourceref string Data for element.
$mimetype string Data for and .
$version string Data for and .
$output Horde_Xml_Wbxml_ContentHandler Content handler that will received the output.
$additionaltypes array Array of additional types for and ; format array('text/directory' => '3.0')

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

The final output as procuded by the _output Encoder. Either an XML string or a WBXML string.
public getOutput ( )

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

The length of the output as produced by the Encoder. To limit the size of individual messages.
public getOutputSize ( )

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

public init ( &$theoutputhandler )

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

To we create wbxml or not?
public isWBXML ( )

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

public outputAlert ( $alertCode, $clientDB = '', $serverDB = '', $lastAnchor = '', $nextAnchor = '' )

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

public outputBodyStart ( )

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

public outputDevInf ( $cmdRef )

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

public outputEnd ( )

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

public outputFinal ( )

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

public outputGetDevInf ( )

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

Required data is retrieved from state.
public outputHeader ( string $respURI )
$respURI string The url of the server endpoint.

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

public outputInit ( )

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

public outputStatus ( $cmdRef, $cmd, $data, $targetRef = '', $sourceRef = '', $syncAnchorNext = '', $syncAnchorLast = '' )

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

Creates a single Sync command
public outputSyncCommand ( string $command, string $content = null, string $contentType = null, string $encodingType = null, string $cuid = null, string $suid = null, integer $contentSize = null, boolean $moreData = false ) : integer
$command string The Sync command (Add, Delete, Replace).
$content string The actual object content.
$contentType string The content's MIME type.
$encodingType string The content encoding of the object.
$cuid string The client's object UID.
$suid string The server's object UID.
$contentSize integer The total content size.
$moreData boolean Add MoreData tag when splitting messages.
Результат integer The CmdID used for this command.

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

public outputSyncEnd ( )

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

public outputSyncStart ( $clientLocURI, $serverLocURI, $numberOfChanges = null )

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

public singleton ( )

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

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

The CmdID provides a unique ID for each command in a syncml packet.
protected $_msg_CmdID

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

protected $_uri

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

The outputhandler to whom the XML is passed: like Horde_Xml_Wbxml_Encoder
public $output