PHP Class Horde_Kolab_Format_Xml_Type_Composite, horde

Author: Gunnar Wrobel ([email protected])

Inheritance: extends Horde_Kolab_Format_Xml_Type_Base

Protected Properties

Свойство	Type	Description
$default	string	A default value if required.
$elements	array	The elements of the composite attribute.
$merge	boolean	Should the values be merged into the parent attributes?
$value	integer	Indicate which value type is expected.

Méthode	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.
loadNodeValue ( DOMNode $node, Horde_Kolab_Format_Xml_Helper $helper, array $params = [] ) : mixed \| null	Load the value of a node.
save ( string $name, array $attributes, DOMNode $parent_node, Horde_Kolab_Format_Xml_Helper $helper, array $params = [] ) : DOMNode \| boolean	Update the specified attribute.
saveNodeValue ( string $name, mixed $value, DOMNode $parent_node, Horde_Kolab_Format_Xml_Helper $helper, array $params = [], DOMNode \| null $old_node = false ) : DOMNode \| boolean	Update the specified attribute.

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

Méthode	Description
_writeComposite ( DOMNode $parent_node, string $name, array $values, Horde_Kolab_Format_Xml_Helper $helper, array $params ) : array	Write a composite value to a parent node.

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.
Résultat	mixed	The value to be written.

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.
Résultat	DOMNode \| boolean	The named DOMNode or false if no node value was found.

Load the value of a node.

public loadNodeValue ( DOMNode $node, Horde_Kolab_Format_Xml_Helper $helper, array $params = [] ) : mixed \| null
$node	DOMNode	Retrieve value for this node.
$helper	Horde_Kolab_Format_Xml_Helper	A XML helper instance.
$params	array	Additiona parameters for this parse operation.
Résultat	mixed \| null	The value or null if no value was found.

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.
Résultat	DOMNode \| boolean	The new/updated child node or false if this failed.

Update the specified attribute.

public saveNodeValue ( string $name, mixed $value, DOMNode $parent_node, Horde_Kolab_Format_Xml_Helper $helper, array $params = [], DOMNode \| null $old_node = false ) : DOMNode \| boolean
$name	string	The name of the attribute to be updated.
$value	mixed	The value to store.
$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	The parameters for this write operation.
$old_node	DOMNode \| null	The previous value (or null if there is none).
Résultat	DOMNode \| boolean	The new/updated child node or false if this failed.

A default value if required.

protected string $default
Résultat	string

The elements of the composite attribute.

protected array $elements
Résultat	array

Should the values be merged into the parent attributes?

protected bool $merge
Résultat	boolean

Indicate which value type is expected.

protected int $value
Résultat	integer