Overview

Packages

  • None
  • SyncMl

Classes

  • Horde_SyncMl
  • Horde_SyncMl_Backend
  • Horde_SyncMl_Backend_Horde
  • Horde_SyncMl_Command
  • Horde_SyncMl_Command_Alert
  • Horde_SyncMl_Command_Final
  • Horde_SyncMl_Command_Get
  • Horde_SyncMl_Command_Map
  • Horde_SyncMl_Command_Put
  • Horde_SyncMl_Command_Replace
  • Horde_SyncMl_Command_Results
  • Horde_SyncMl_Command_Status
  • Horde_SyncMl_Command_Sync
  • Horde_SyncMl_Command_SyncHdr
  • Horde_SyncMl_ContentHandler
  • Horde_SyncMl_DataStore
  • Horde_SyncMl_Device
  • Horde_SyncMl_Device_Nokia
  • Horde_SyncMl_Device_P800
  • Horde_SyncMl_Device_sync4j
  • Horde_SyncMl_Device_Sync4JMozilla
  • Horde_SyncMl_Device_Synthesis
  • Horde_SyncMl_DeviceInfo
  • Horde_SyncMl_Property
  • Horde_SyncMl_PropertyParameter
  • Horde_SyncMl_State
  • Horde_SyncMl_Sync
  • Horde_SyncMl_SyncElement
  • Horde_SyncMl_Translation
  • Horde_SyncMl_XmlOutput
  • Overview
  • Package
  • Class
  • Tree

Class Horde_SyncMl_XmlOutput

This class creates the actual XML data and passes it on to a ContentHandler for optional WBXML encoding.

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-2012 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.

Package: SyncMl
Author: Karsten Fourmont karsten@horde.org
Located at Horde/SyncMl/XmlOutput.php
Methods summary
public
# getOutput( )

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

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

public
# getOutputSize( )

The length of the output as produced by the Encoder. To limit the size of individual messages.

The length of the output as produced by the Encoder. To limit the size of individual messages.

public
# isWBXML( )

To we create wbxml or not?

To we create wbxml or not?

public &
# singleton( )
public
# init( mixed & $theoutputhandler )
public
# outputHeader( string $respURI )

Creates a SyncHdr output.

Creates a SyncHdr output.

Required data is retrieved from state.

Parameters

$respURI
The url of the server endpoint.

Throws

Horde_Xml_Wbxml_Exception
public
# outputInit( )
public
# outputBodyStart( )
public
# outputFinal( )
public
# outputEnd( )
public
# outputStatus( mixed $cmdRef, mixed $cmd, mixed $data, mixed $targetRef = '', mixed $sourceRef = '', mixed $syncAnchorNext = '', mixed $syncAnchorLast = '' )
public
# outputDevInf( mixed $cmdRef )
public
# outputAlert( mixed $alertCode, mixed $clientDB = '', mixed $serverDB = '', mixed $lastAnchor = '', mixed $nextAnchor = '' )
public
# outputGetDevInf( )
public integer
# outputSyncCommand( string $command, string $content = null, string $contentType = null, string $encodingType = null, string $cuid = null, string $suid = null )

Creates a single Sync command

Creates a single Sync command

Parameters

$command
The Sync command (Add, Delete, Replace).
$content
The actual object content.
$contentType
The content's MIME type.
$encodingType
The content encoding of the object.
$cuid
The client's object UID.
$suid
The server's object UID.

Returns

integer
The CmdID used for this command.
public
# outputSyncStart( mixed $clientLocURI, mixed $serverLocURI, mixed $numberOfChanges = null )
public
# outputSyncEnd( )
Properties summary
public mixed $output

The outputhandler to whom the XML is passed: like Horde_Xml_Wbxml_Encoder

The outputhandler to whom the XML is passed: like Horde_Xml_Wbxml_Encoder

#
API documentation generated by ApiGen