Horde_SyncMl_Command_Final
extends Horde_SyncMl_Command
in package
The Horde_SyncMl_Command_Final class provides a SyncML implementation of the Final command as defined in SyncML Representation Protocol, version 1.1, section 5.1.7.
The Final command is an indicator that the SyncML message is the last message in the current Horde_SyncMl package.
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.
- $_cmdID : int
- The command ID (<CmdID>).
- $_cmdName : string
- Name of the command.
- $_outputHandler : Horde_SyncMl_XmlOutput
- A Horde_SyncMl_XmlOutput instance responsible for generating the output.
- $_stack : array<string|int, mixed>
- Stack for holding the XML elements during creation of the object from the XML event flow.
- __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
- Implements the actual business logic of the Alert command.
- 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
= ''
$_cmdID
The command ID (<CmdID>).
protected
int
$_cmdID
$_cmdName
Name of the command.
protected
string
$_cmdName
= 'Final'
$_outputHandler
A Horde_SyncMl_XmlOutput instance responsible for generating the output.
protected
Horde_SyncMl_XmlOutput
$_outputHandler
$_stack
Stack for holding the XML elements during creation of the object from the XML event flow.
protected
array<string|int, mixed>
$_stack
= array()
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()
Implements the actual business logic of the Alert command.
public
handleCommand([mixed $debug = false ]) : mixed
Parameters
- $debug : mixed = false
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.