Config::Model::AnyThing - Base class for configuration tree item
# internal class
This class must be inherited by all nodes or leaves of the configuration tree.
AnyThing provides some methods and no constructor.
Returns the element name that contain this object.
For object stored in an array or hash element, returns the index (or key) containing this object.
Returns the node containing this object. May return undef if
parent() is called on the root of the tree.
Returns the type (e.g.
warped_node) of the element containing this object.
Returns the root node of the configuration tree.
Returns the node location in the configuration tree. This location conforms with the syntax defined by grab method.
Returns the node location in the configuration tree. This location truncates long indexes to be readable. It cannot be used by grab method.
Return the element name with its index (if any). I.e. returns
Return the element name with its index (if any). Too long indexes are truncated to be readable.
Annotation is a way to store miscellaneous information associated to each node. (Yeah... comments). Reading and writing annotation makes sense only if they can be read from and written to the configuration file, hence the need for the following method:
Returns 1 if at least one of the backends attached to a parent node support to read and write annotations (aka comments) in the configuration file.
Returns 1 if at least one of the backends support to read and write annotations (aka comments) in the configuration file.
Without argument, return a string containing the object's annotation (or an empty string).
With several arguments, join the arguments with "\n", store the annotations and return the resulting string.
Load annotations in configuration tree from a pod document. The pod must be in the form:
=over =item path Annotation text =back
Clear the annotation of an element
Notify the instance of semantic changes. Parameters are:
old value. (optional)
new value (optional)
Location of the changed parameter starting from root node. Default to
element name. Default to
If the changed parameter is part of a hash or an array,
index contains the key or the index to get the changed parameter.
information about the change. Mandatory of neither old or new value are defined.
When set to 1, force recording of change even if in initial load phase.
Forwarded to "show_message( string )" in Config::Model::Instance.
Forwarded to "root_path" in Config::Model::Instance.
Returns an object dedicated to search an element in the configuration model (respecting privilege level).
Dumps the configuration data of the node and its siblings into a perl data structure.
Returns a hash ref containing the data. See Config::Model::DumpAsData for details.
Returns a string describing any issue with Config::Model::Warper object. Returns '' if invoked on a tree object without warp specification.
Dominique Dumont, (ddumont at cpan dot org)
This software is Copyright (c) 2005-2017 by Dominique Dumont.
This is free software, licensed under:
The GNU Lesser General Public License, Version 2.1, February 1999