cvs: peardoc /en/package/configuration config.xml /en/package/configuration/config/config-container searchpath.xml

mansion Sat Aug 16 08:15:57 2003 EDT Added files: /peardoc/en/package/configuration/config/config-container searchpath.xml Modified files: /peardoc/en/package/configuration config.xml Log: Adding searchPath() documentation Index: peardoc/en/package/configuration/config.xml diff -u peardoc/en/package/configuration/config.xml:1.1 peardoc/en/package/configuration/config.xml:1.2 --- peardoc/en/package/configuration/config.xml:1.1 Mon Mar 31 05:33:08 2003 +++ peardoc/en/package/configuration/config.xml Sat Aug 16 08:15:56 2003 @@ -35,6 +35,7 @@ &package.configuration.config.config-container.gettype; &package.configuration.config.config-container.isroot; &package.configuration.config.config-container.removeitem; +&package.configuration.config.config-container.searchpath; &package.configuration.config.config-container.setattributes; &package.configuration.config.config-container.setcontent; &package.configuration.config.config-container.setdirective; Index: peardoc/en/package/configuration/config/config-container/searchpath.xml +++ peardoc/en/package/configuration/config/config-container/searchpath.xml <!-- $Revision: 1.1 $ --> <refentry id="package.configuration.config.config-container.searchpath"> <refnamediv> <refname><function>Config_Container::searchPath</function></refname> <refpurpose>Finds a node using XPATH like format</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'Config/Container.php'; </funcsynopsisinfo> <funcprototype> <funcdef>mixed <function>Config_Container::searchPath</function></funcdef> <paramdef>mixed <parameter>$args</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.configuration.config.config-container.searchpath.desc"> &title.desc; <para> This method tries to find an item by following a given path from the current container. </para> <para> This method can only be called on an object of type <parameter>'section'</parameter>. Note that root is a section. This method is recursive. </para> <para> This method takes as many parameters as is needed to define your path to the requested item. The format is array (item1, item2, ..., itemN). Items can be strings or arrays. Strings will match the item <parameter>name</parameter>, while arrays will match <parameter>'name'</parameter> and/or <parameter>'attributes'</parameter> properties of the requested item. </para> </refsect1> <refsect1 id="package.configuration.config.config-container.searchpath.param"> &title.param; <para> <variablelist> <varlistentry> <term> &type.mixed; <parameter>$args</parameter> </term> <listitem> <para> Strings or arrays of item to match in the order they will be matched, separated by commas </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 id="package.configuration.config.config-container.searchpath.return"> &title.returns; <para> <parameter>mixed</parameter> - reference to item found or &false; when not found </para> </refsect1> <refsect1 id="package.configuration.config.config-container.searchpath.note"> &title.note; &note.notstatic; </refsect1> <refsect1 id="package.configuration.config.config-container.searchpath.example"> &title.example; <example> <title>Example for <function>searchPath</function> usage</title> <programlisting role="php"> <![CDATA[ // Let's say our XML configuration looks like this: // <config> // <db> // <user>root</user> // <password>pass</user> // <host>localhost</host> // </db> // </config> $config = new Config(); $root =& $menuObj->parseConfig('db.xml', 'xml'); // Will return the password directive in db $passObj =& $root->searchPath(array('config', 'db', 'password')); ]]> </programlisting> </example> <example> <title>More complex example with attributes for <function>searchPath</function></title> <programlisting role="php"> <![CDATA[ // Let's say our XML configuration looks like this: // <menu> // <group id="company"> // <page id="news"/> // <page id="jobs"/> // </group> // <group id="projects"> // <page id="project1"/> // <page id="project2"/> // </group> // </menu> $menuObj = new Config(); $root =& $menuObj->parseConfig('menu.xml', 'xml'); // Will return the container in menu which 'id' is set to 'projects' $section =& $root->searchPath(array('menu', array('group', array('id' => 'projects')))); // To get a page we could also use $page =& $root->searchPath(array('menu', array('group', array('id' => 'projects')), array('page', array('id' => 'project2')))); ]]> </programlisting> </example> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 -->