API Documentation
\

\Horde_SyncMl_Command_Results

The Horde_SyncMl_Command_Results class provides a SyncML implementation of the Results command as defined in SyncML Representation Protocol, version 1.1, section 5.5.12.

The Results command is used to return the results of a Search or Get command. Currently Horde_SyncMl_Command_Results behaves the same as Horde_SyncMl_Command_Put. The only results we get is the same DevInf as for the Put command.

Copyright 2003-2017 Horde LLC (http://www.horde.org/)

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

Summary

Methods
Properties
Constants
startElement()
endElement()
handleCommand()
__construct()
characters()
getCommandName()
factory()
No public properties found
No constants found
No protected methods found
$_cmdName
$_devinf
$_currentDS
$_currentCTType
$_VerCT
$_currentPropName
$_currentParamName
$_currentXNam
$_cmdID
$_stack
$_chars
$_outputHandler
N/A
No private methods found
No private properties found
N/A

Properties

$_cmdName

$_cmdName : string

Name of the command.

Must be overwritten by a sub class.

Type

string

$_devinf

$_devinf : \Horde_SyncMl_DeviceInfo

The Horde_SyncMl_DeviceInfo object where all parsed <DevInf> content is saved.

specifies the type of the source synchronization device.

Type

\Horde_SyncMl_DeviceInfo

$_currentDS

$_currentDS : \Horde_SyncMl_DataStore

A Horde_SyncMl_DataStore object where the information from the currently parsed <DataStore> section is saved.

specifies the properties of a given local datastore.

Type

\Horde_SyncMl_DataStore

$_currentCTType

$_currentCTType : string

The MIME content type as specified by the last <CTType> element like text/calendar or text/x-vcard.

specifies the type of a supported content type.

Type

string

$_VerCT

$_VerCT : string

The version of the MIME content type in $_currentCTType as specified by the last <VerCT> element like 1.0 for text/x-vcalendar or 2.1 for text/x-vcard.

specifies the version of a supported content type.

Type

string

$_currentPropName

$_currentPropName : string

A property name of the currently parsed content type (CTType), like 'DTSTART' for text/calendar or 'BDAY' for text/x-vcard.

specifies a supported property of a given content type.

Type

string

$_currentParamName

$_currentParamName : string

A property name of the currently parsed property name (PropName), like 'ROLE' for 'ATTENDEE' or 'HOME' for 'ADR'.

specifies supported parameters of a given content type property.

Type

string

$_currentXNam

$_currentXNam : string

The name of the currently parsed DevInf extension (<Ext>) as specified by the XNam element.

specifies the name of one of the DevInf extension element types.

Type

string

$_cmdID

$_cmdID : integer

The command ID (<CmdID>).

Type

integer

$_stack

$_stack : array

Stack for holding the XML elements during creation of the object from the XML event flow.

Type

array

$_chars

$_chars : string

Buffer for the parsed character data.

Type

string

$_outputHandler

$_outputHandler : \Horde_SyncMl_XmlOutput

A Horde_SyncMl_XmlOutput instance responsible for generating the output.

Type

\Horde_SyncMl_XmlOutput

Methods

startElement()

startElement(string  $uri, string  $element, array  $attrs)

Start element handler for the XML parser, delegated from Horde_SyncMl_ContentHandler::startElement().

Parameters

string $uri

The namespace URI of the element.
string $element

The element tag name.
array $attrs

A hash with the element's attributes.

endElement()

endElement(string  $uri, string  $element)

End element handler for the XML parser, delegated from Horde_SyncMl_ContentHandler::endElement().

Parameters

string $uri

The namespace URI of the element.
string $element

The element tag name.

handleCommand()

handleCommand(  $debug = false)

This method is supposed to implement the actual business logic of the command once the XML parsing is complete.

Parameters

$debug

__construct()

__construct(\Horde_SyncMl_XmlOutput  $outputHandler)

Constructor.

Parameters

\Horde_SyncMl_XmlOutput $outputHandler

A Horde_SyncMl_XmlOutput object.

characters()

characters(string  $str)

Character data handler for the XML parser, delegated from Horde_SyncMl_ContentHandler::characters().

Parameters

string $str

The data string.

getCommandName()

getCommandName() : string

Returns the command name this instance is reponsible for.

Returns

string —

The command name this object is handling.

factory()

factory(string  $command, \Horde_SyncMl_XmlOutput  $outputHandler) : \Horde_SyncMl_Command

Attempts to return a concrete Horde_SyncMl_Command instance based on $command.

Parameters

string $command

The type of the concrete Horde_SyncMl_Comment subclass to return.
\Horde_SyncMl_XmlOutput $outputHandler

A Horde_SyncMl_XmlOutput object.

Returns

\Horde_SyncMl_Command —

The newly created concrete Horde_SyncMl_Command instance, or false on error.