Horde_Kolab_Format_Factory
in package
A factory for generating Kolab format handlers.
Tags
Table of Contents
- $_params : array<string|int, mixed>
- Parameters for the parser construction.
- __construct() : mixed
- Constructor.
- create() : Horde_Kolab_Format
- Generates a handler for a specific Kolab object type.
- createXmlHelper() : Horde_Kolab_Format_Xml_Helper
- Generates a XML helper instance.
- createXmlParser() : Horde_Kolab_Format_Xml_Parser
- Generates a XML parser.
- createXmlType() : Horde_Kolab_Format_Xml_Type
- Generates a XML type that deals with XML data modifications.
Properties
$_params
Parameters for the parser construction.
private
array<string|int, mixed>
$_params
Methods
__construct()
Constructor.
public
__construct([array<string|int, mixed> $params = array() ]) : mixed
Parameters
- $params : array<string|int, mixed> = array()
-
Additional parameters for the creation of parsers.
Return values
mixed —create()
Generates a handler for a specific Kolab object type.
public
create([string $format = 'Xml' ][, string $type = '' ][, array<string|int, mixed> $params = array() ]) : Horde_Kolab_Format
Parameters
- $format : string = 'Xml'
-
The format that the handler should work with.
- $type : string = ''
-
The object type that should be handled.
- $params : array<string|int, mixed> = array()
-
Additional parameters.
'version' - The format version.
Tags
Return values
Horde_Kolab_Format —The handler.
createXmlHelper()
Generates a XML helper instance.
public
createXmlHelper(DOMDocument $xmldoc) : Horde_Kolab_Format_Xml_Helper
Parameters
- $xmldoc : DOMDocument
-
The XML document the helper works with.
Return values
Horde_Kolab_Format_Xml_Helper —The helper utility.
createXmlParser()
Generates a XML parser.
public
createXmlParser() : Horde_Kolab_Format_Xml_Parser
Return values
Horde_Kolab_Format_Xml_Parser —The parser.
createXmlType()
Generates a XML type that deals with XML data modifications.
public
createXmlType(string $type[, array<string|int, mixed> $params = array() ]) : Horde_Kolab_Format_Xml_Type
Parameters
- $type : string
-
The value type.
- $params : array<string|int, mixed> = array()
-
Additional parameters.
Tags
Return values
Horde_Kolab_Format_Xml_Type —The type.