Documentation

Horde_SyncMl_Command_Alert extends Horde_SyncMl_Command
in package

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.

Tags
author

Anthony Mills amills@pyramid6.com

author

Karsten Fourmont karsten@horde.org

author

Jan Schneider jan@horde.org

Table of Contents

$_alert  : int
The alert type. Should be one of the Horde_SyncMl::ALERT_* constants.
$_chars  : string
Buffer for the parsed character data.
$_cmdID  : int
The command ID (<CmdID>).
$_cmdName  : string
Name of the command.
$_metaAnchorLast  : int
The last time when synchronization happened, from the <Meta><Last> element.
$_metaAnchorNext  : string
The current time this synchronization happens, from the <Meta><Next> element.
$_outputHandler  : Horde_SyncMl_XmlOutput
A Horde_SyncMl_XmlOutput instance responsible for generating the output.
$_sourceLocURI  : string
Source database of the Alert command.
$_stack  : array<string|int, mixed>
Stack for holding the XML elements during creation of the object from the XML event flow.
$_targetLocURI  : string
Target database of the Alert command.
__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

$_alert

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

protected int $_alert

$_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 = 'Alert'

$_metaAnchorLast

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

protected int $_metaAnchorLast

$_metaAnchorNext

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

protected string $_metaAnchorNext

$_sourceLocURI

Source database of the Alert command.

protected string $_sourceLocURI

$_stack

Stack for holding the XML elements during creation of the object from the XML event flow.

protected array<string|int, mixed> $_stack = array()

$_targetLocURI

Target database of the Alert command.

protected string $_targetLocURI

Methods

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.

Return values
mixed

Search results