PHP Class Horde_Kolab_Format_Xml_Type_Multiple, horde

Copyright 2011-2016 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.
Inheritance: extends Horde_Kolab_Format_Xml_Type_Base
显示文件 Open project: horde/horde

Protected Properties

Property Type Description
$default string A default value if required.
$element string The class name representing the element that can occur multiple times.
$value integer Indicate which value type is expected.

Public Methods

Method Description
load ( string $name, &$attributes, DOMNode $parent_node, Horde_Kolab_Format_Xml_Helper $helper, array $params = [] ) : DOMNode | boolean Load the node value from the Kolab object.
save ( string $name, array $attributes, DOMNode $parent_node, Horde_Kolab_Format_Xml_Helper $helper, array $params = [] ) : DOMNode | boolean Update the specified attribute.

Protected Methods

Method Description
generateWriteValue ( string $name, array $attributes, array $params ) : mixed Generate the value that should be written to the node. Override in the extending classes.

Private Methods

Method Description
_writeMultiple ( DOMNode $parent_node, string $name, array $values, Horde_Kolab_Format_Xml_Helper $helper, array $params ) : array Write multiple values to one parent node.

Method Details

generateWriteValue() protected method

Generate the value that should be written to the node. Override in the extending classes.
protected generateWriteValue ( string $name, array $attributes, array $params ) : mixed
$name string The name of the the attribute to be updated.
$attributes array The data array that holds all attribute values.
$params array The parameters for this write operation.
return mixed The value to be written.

load() public method

Load the node value from the Kolab object.
public load ( string $name, &$attributes, DOMNode $parent_node, Horde_Kolab_Format_Xml_Helper $helper, array $params = [] ) : DOMNode | boolean
$name string The name of the the attribute to be fetched.
$parent_node DOMNode The parent node of the node to be loaded.
$helper Horde_Kolab_Format_Xml_Helper A XML helper instance.
$params array Additiona parameters for this parse operation.
return DOMNode | boolean The named DOMNode or false if no node value was found.

save() public method

Update the specified attribute.
public save ( string $name, array $attributes, DOMNode $parent_node, Horde_Kolab_Format_Xml_Helper $helper, array $params = [] ) : DOMNode | boolean
$name string The name of the the attribute to be updated.
$attributes array The data array that holds all attribute values.
$parent_node DOMNode The parent node of the node that should be updated.
$helper Horde_Kolab_Format_Xml_Helper A XML helper instance.
$params array Additional parameters for this write operation.
return DOMNode | boolean The new/updated child node or false if this failed.

Property Details

$default protected_oe property

A default value if required.
protected string $default
return string

$element protected_oe property

The class name representing the element that can occur multiple times.
protected string $element
return string

$value protected_oe property

Indicate which value type is expected.
protected int $value
return integer