Class Horde_SyncMl_Command

The Horde_SyncMl_Command class provides a base class for handling all commands.

A SyncML command is a protocol primitive. Each SyncML command specifies to a recipient an individual operation that is to be performed.

The Horde_SyncMl_Command objects are hooked into the XML parser of the Horde_SyncMl_ContentHandler class and are reponsible for parsing a single command inside the SyncBody section of a SyncML message. All actions that must be executed for a single SyncML command are handled by these objects, by means of the handleCommand() method.

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

Direct known subclasses

Horde_SyncMl_Command_Alert, Horde_SyncMl_Command_Final, Horde_SyncMl_Command_Get, Horde_SyncMl_Command_Map, Horde_SyncMl_Command_Put, Horde_SyncMl_Command_Replace, Horde_SyncMl_Command_Status, Horde_SyncMl_Command_Sync, Horde_SyncMl_Command_SyncHdr

Indirect known subclasses

Horde_SyncMl_Command_Results

Package: SyncMl
Author: Anthony Mills amills@pyramid6.com
Author: Jan Schneider jan@horde.org
Located at Horde/SyncMl/Command.php

Methods summary
`public`	# `__construct( Horde_SyncMl_XmlOutput & $outputHandler )` Constructor. Constructor. Parameters `$outputHandler` A Horde_SyncMl_XmlOutput object.
`public`	# `startElement( string $uri, string $element, array $attrs )` Start element handler for the XML parser, delegated from Horde_SyncMl_ContentHandler::startElement(). Start element handler for the XML parser, delegated from Horde_SyncMl_ContentHandler::startElement(). Parameters `$uri` The namespace URI of the element. `$element` The element tag name. `$attrs` A hash with the element's attributes.
`public`	# `endElement( string $uri, string $element )` End element handler for the XML parser, delegated from Horde_SyncMl_ContentHandler::endElement(). End element handler for the XML parser, delegated from Horde_SyncMl_ContentHandler::endElement(). Parameters `$uri` The namespace URI of the element. `$element` The element tag name.
`public`	# `characters( string $str )` Character data handler for the XML parser, delegated from Horde_SyncMl_ContentHandler::characters(). Character data handler for the XML parser, delegated from Horde_SyncMl_ContentHandler::characters(). Parameters `$str` The data string.
`public string`	# `getCommandName( )` Returns the command name this instance is reponsible for. Returns the command name this instance is reponsible for. Returns `string` The command name this object is handling.
`public`	# `handleCommand( mixed $debug = false )` This method is supposed to implement the actual business logic of the command once the XML parsing is complete. This method is supposed to implement the actual business logic of the command once the XML parsing is complete.
`public Horde_SyncMl_Command &`	# `factory( string $command, Horde_SyncMl_XmlOutput & $outputHandler )` Attempts to return a concrete Horde_SyncMl_Command instance based on $command. Attempts to return a concrete Horde_SyncMl_Command instance based on $command. Parameters `$command` <p>The type of the concrete Horde_SyncMl_Comment subclass to return.</p> `$outputHandler` A Horde_SyncMl_XmlOutput object. Returns `Horde_SyncMl_Command` The newly created concrete Horde_SyncMl_Command instance, or false on error.

Packages

Classes

Class Horde_SyncMl_Command

Direct known subclasses

Indirect known subclasses

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns