API Documentation
\

\Horde_SyncMl_Command_Alert

The Horde_SyncMl_Command_Alert class provides a SyncML implementation of the Alert command as defined in SyncML Representation Protocol, version 1.1, section 5.5.2.

The Alert command is used for sending custom content information to the recipient. The command provides a mechanism for communicating content information, such as state information or notifications to an application on the recipient device.

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
$_alert
$_sourceLocURI
$_targetLocURI
$_metaAnchorNext
$_metaAnchorLast
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

$_alert

$_alert : integer

The alert type. Should be one of the Horde_SyncMl::ALERT_* constants.

Type

integer

$_sourceLocURI

$_sourceLocURI : string

Source database of the Alert command.

Type

string

$_targetLocURI

$_targetLocURI : string

Target database of the Alert command.

Type

string

$_metaAnchorNext

$_metaAnchorNext : string

The current time this synchronization happens, from the <Meta><Next> element.

Type

string

$_metaAnchorLast

$_metaAnchorLast : integer

The last time when synchronization happened, from the <Meta><Last> element.

Type

integer

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)

Implements the actual business logic of the Alert command.

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.