Horde_SyncMl_Command_Results
extends Horde_SyncMl_Command_Put
in package
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.
Tags
Table of Contents
- $_chars : string
- Buffer for the parsed character data.
- $_cmdID : int
- The command ID (<CmdID>).
- $_cmdName : string
- Name of the command.
- $_currentCTType : string
- The MIME content type as specified by the last <CTType> element like text/calendar or text/x-vcard.
- $_currentDS : Horde_SyncMl_DataStore
- A Horde_SyncMl_DataStore object where the information from the currently parsed <DataStore> section is saved.
- $_currentParamName : string
- A property name of the currently parsed property name (PropName), like 'ROLE' for 'ATTENDEE' or 'HOME' for 'ADR'.
- $_currentPropName : string
- A property name of the currently parsed content type (CTType), like 'DTSTART' for text/calendar or 'BDAY' for text/x-vcard.
- $_currentXNam : string
- The name of the currently parsed DevInf extension (<Ext>) as specified by the XNam element.
- $_devinf : Horde_SyncMl_DeviceInfo
- The Horde_SyncMl_DeviceInfo object where all parsed <DevInf> content is saved.
- $_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.
- $_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.
- __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
= ''
$_cmdID
The command ID (<CmdID>).
protected
int
$_cmdID
$_cmdName
Name of the command.
protected
string
$_cmdName
= 'Results'
$_currentCTType
The MIME content type as specified by the last <CTType> element like text/calendar or text/x-vcard.
protected
string
$_currentCTType
$_currentDS
A Horde_SyncMl_DataStore object where the information from the currently parsed <DataStore> section is saved.
protected
Horde_SyncMl_DataStore
$_currentDS
$_currentParamName
A property name of the currently parsed property name (PropName), like 'ROLE' for 'ATTENDEE' or 'HOME' for 'ADR'.
protected
string
$_currentParamName
$_currentPropName
A property name of the currently parsed content type (CTType), like 'DTSTART' for text/calendar or 'BDAY' for text/x-vcard.
protected
string
$_currentPropName
$_currentXNam
The name of the currently parsed DevInf extension (<Ext>) as specified by the XNam element.
protected
string
$_currentXNam
$_devinf
The Horde_SyncMl_DeviceInfo object where all parsed <DevInf> content is saved.
protected
Horde_SyncMl_DeviceInfo
$_devinf
$_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()
$_VerCT
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.
protected
string
$_VerCT
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.