API Documentation
\

\Horde_SyncMl_Command_Status

The Horde_SyncMl_Command_Status class provides a SyncML implementation of the Status response as defined in SyncML Representation Protocol, version 1.1, section 5.4.

This is not strictly a command but specifies the request status code for a corresponding SyncML 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
__construct()
startElement()
endElement()
characters()
getCommandName()
handleCommand()
factory()
No public properties found
No constants found
No protected methods found
$_cmdName
$_cmdID
$_stack
$_chars
$_outputHandler
$_CmdRef
$_MsgRef
$_Status
$_Cmd
$_TargetRef
$_SourceRef
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

$_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

$_CmdRef

$_CmdRef : integer

The command ID (CmdID) of the command sent to the client, that this Status response refers to.

Type

integer

$_MsgRef

$_MsgRef : integer

The message ID (Msg) of the message sent to the client, that this Status response refers to.

Type

integer

$_Status

$_Status : integer

The status response code, one of the Horde_SyncMl::RESPONSE_* constants.

Type

integer

$_Cmd

$_Cmd : string

The command (Add, Replace, etc) sent to the client, that this Status response refers to.

Type

string

$_TargetRef

$_TargetRef : string

The client ID of the sent object, that this Status response refers to.

This element is optional. If specified, Status response refers to a single Item in the command sent to the client. It refers to all Items in the sent command otherwise.

Type

string

$_SourceRef

$_SourceRef : string

The server ID of the sent object, that this Status response refers to.

This element is optional. If specified, Status response refers to a single Item in the command sent to the client. It refers to all Items in the sent command otherwise.

Type

string

Methods

__construct()

__construct(\Horde_SyncMl_XmlOutput  $outputHandler)

Constructor.

Parameters

\Horde_SyncMl_XmlOutput $outputHandler

A Horde_SyncMl_XmlOutput object.

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.

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.

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

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.