PHP Класс Horde_Kolab_Format_Xml, horde
For implementing a new format type you will have to inherit this
class and provide a _load/_save function.
Copyright 2007-2009 Klarälvdalens Datakonsult AB
Copyright 2010-2014 Horde LLC (http://www.horde.org/)
See the enclosed file COPYING for license information (LGPL). If you did not
receive this file, see
http://www.horde.org/licenses/lgpl21.
Показать файл
Открыть проект
Примеры использования класса
Защищенные свойства (Protected)
Открытые методы
Метод |
Описание |
|
__construct ( Horde_Kolab_Format_Xml_Parser $parser, Horde_Kolab_Format_Factory $factory, array $params = null ) |
Constructor |
|
getVersion ( ) : integer |
Return the API version of the data structures that are being used for in-
and output. |
|
load ( resource $xml, array $options = [] ) : array |
Load an object based on the given XML stream. The stream may only contain
UTF-8 data. |
|
save ( array $object, array $options = [] ) : string |
Convert the data to a XML stream. Strings contained in the data array may
only be provided as UTF-8 data. |
|
Приватные методы
Метод |
Описание |
|
_getParameters ( array $options ) : array |
Generate the internal parameter list for this operation. |
|
_getParser ( ) : Horde_Kolab_Format_Xml_Parser |
Fetch the XML parser. |
|
_getRoot ( array $params = [] ) : Horde_Kolab_Xml_Type_Root |
Return the root handler. |
|
_refreshParser ( ) : null |
Throw the parser instance away. |
|
Описание методов
__construct()
публичный Метод
public __construct ( Horde_Kolab_Format_Xml_Parser $parser, Horde_Kolab_Format_Factory $factory, array $params = null ) |
$parser |
Horde_Kolab_Format_Xml_Parser |
The XML parser. |
$factory |
Horde_Kolab_Format_Factory |
The factory for helper
objects. |
$params |
array |
Any additional options. |
getVersion()
публичный Метод
Return the API version of the data structures that are being used for in-
and output.
Load an object based on the given XML stream. The stream may only contain
UTF-8 data.
public load ( resource $xml, array $options = [] ) : array |
$xml |
resource |
The XML stream of the message. |
$options |
array |
Additional options when parsing the XML.
- relaxed: Relaxed error checking (default: false)
|
Результат |
array |
The data array representing the object. |
Convert the data to a XML stream. Strings contained in the data array may
only be provided as UTF-8 data.
public save ( array $object, array $options = [] ) : string |
$object |
array |
The data array representing the object. |
$options |
array |
Additional options when writing the XML.
- previous: The previous XML text (default: empty string)
- relaxed: Relaxed error checking (default: false)
|
Результат |
string |
The data as an XML string. |
Описание свойств
$_factory защищенное свойство
The factory for additional objects.
protected Horde_Kolab_Format_Factory $_factory |
Результат |
Horde_Kolab_Format_Factory |
|
$_fields_specific защищенное свойство
Specific data fields for the contact object
protected array $_fields_specific |
Результат |
array |
|
$_parser защищенное свойство
The parser dealing with the input.
protected Horde_Kolab_Format_Xml_Parser $_parser |
Результат |
Horde_Kolab_Format_Xml_Parser |
|
$_root_name защищенное свойство
The name of the root element.
protected string $_root_name |
Результат |
string |
|
$_root_version защищенное свойство
Kolab format version of the root element.
protected string $_root_version |
Результат |
string |
|
$_version защищенное свойство
Requested version of the data array to return
protected int $_version |
Результат |
integer |
|
$_xmldoc защищенное свойство
The XML document this driver works with.
protected DOMDocument $_xmldoc |
Результат |
DOMDocument |
|