Horde_SyncMl_Command_Status
extends Horde_SyncMl_Command
in package
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.
Tags
Table of Contents
- $_chars : string
- Buffer for the parsed character data.
- $_Cmd : string
- The command (Add, Replace, etc) sent to the client, that this Status response refers to.
- $_cmdID : int
- The command ID (<CmdID>).
- $_cmdName : string
- Name of the command.
- $_CmdRef : int
- The command ID (CmdID) of the command sent to the client, that this Status response refers to.
- $_MsgRef : int
- The message ID (Msg) of the message sent to the client, that this Status response refers to.
- $_outputHandler : Horde_SyncMl_XmlOutput
- A Horde_SyncMl_XmlOutput instance responsible for generating the output.
- $_SourceRef : string
- The server ID of the sent object, that this Status response refers to.
- $_stack : array<string|int, mixed>
- Stack for holding the XML elements during creation of the object from the XML event flow.
- $_Status : int
- The status response code, one of the Horde_SyncMl::RESPONSE_* constants.
- $_TargetRef : string
- The client ID of the sent object, that this Status response refers to.
- __construct() : mixed
- Constructor.
- characters() : mixed
- Character data handler for the XML parser, delegated from Horde_SyncMl_ContentHandler::characters().
- endElement() : mixed
- End element handler for the XML parser, delegated from Horde_SyncMl_ContentHandler::endElement().
- factory() : Horde_SyncMl_Command
- Attempts to return a concrete Horde_SyncMl_Command instance based on $command.
- getCommandName() : string
- Returns the command name this instance is reponsible for.
- handleCommand() : mixed
- This method is supposed to implement the actual business logic of the command once the XML parsing is complete.
- startElement() : mixed
- Start element handler for the XML parser, delegated from Horde_SyncMl_ContentHandler::startElement().
Properties
$_chars
Buffer for the parsed character data.
protected
string
$_chars
= ''
$_Cmd
The command (Add, Replace, etc) sent to the client, that this Status response refers to.
protected
string
$_Cmd
$_cmdID
The command ID (<CmdID>).
protected
int
$_cmdID
$_cmdName
Name of the command.
protected
string
$_cmdName
= 'Status'
$_CmdRef
The command ID (CmdID) of the command sent to the client, that this Status response refers to.
protected
int
$_CmdRef
$_MsgRef
The message ID (Msg) of the message sent to the client, that this Status response refers to.
protected
int
$_MsgRef
$_outputHandler
A Horde_SyncMl_XmlOutput instance responsible for generating the output.
protected
Horde_SyncMl_XmlOutput
$_outputHandler
$_SourceRef
The server ID of the sent object, that this Status response refers to.
protected
string
$_SourceRef
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.
$_stack
Stack for holding the XML elements during creation of the object from the XML event flow.
protected
array<string|int, mixed>
$_stack
= array()
$_Status
The status response code, one of the Horde_SyncMl::RESPONSE_* constants.
protected
int
$_Status
$_TargetRef
The client ID of the sent object, that this Status response refers to.
protected
string
$_TargetRef
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.
Methods
__construct()
Constructor.
public
__construct(Horde_SyncMl_XmlOutput &$outputHandler) : mixed
Parameters
- $outputHandler : Horde_SyncMl_XmlOutput
-
A Horde_SyncMl_XmlOutput object.
Return values
mixed —characters()
Character data handler for the XML parser, delegated from Horde_SyncMl_ContentHandler::characters().
public
characters(string $str) : mixed
Parameters
- $str : string
-
The data string.
Return values
mixed —endElement()
End element handler for the XML parser, delegated from Horde_SyncMl_ContentHandler::endElement().
public
endElement(string $uri, string $element) : mixed
Parameters
- $uri : string
-
The namespace URI of the element.
- $element : string
-
The element tag name.
Return values
mixed —factory()
Attempts to return a concrete Horde_SyncMl_Command instance based on $command.
public
factory(string $command, Horde_SyncMl_XmlOutput &$outputHandler) : Horde_SyncMl_Command
Parameters
- $command : string
-
The type of the concrete Horde_SyncMl_Comment subclass to return.
- $outputHandler : Horde_SyncMl_XmlOutput
-
A Horde_SyncMl_XmlOutput object.
Return values
Horde_SyncMl_Command —The newly created concrete Horde_SyncMl_Command instance, or false on error.
getCommandName()
Returns the command name this instance is reponsible for.
public
getCommandName() : string
Return values
string —The command name this object is handling.
handleCommand()
This method is supposed to implement the actual business logic of the command once the XML parsing is complete.
public
handleCommand([mixed $debug = false ]) : mixed
Parameters
- $debug : mixed = false
Tags
Return values
mixed —startElement()
Start element handler for the XML parser, delegated from Horde_SyncMl_ContentHandler::startElement().
public
startElement(string $uri, string $element, array<string|int, mixed> $attrs) : mixed
Parameters
- $uri : string
-
The namespace URI of the element.
- $element : string
-
The element tag name.
- $attrs : array<string|int, mixed>
-
A hash with the element's attributes.