svn: /pear/peardoc/trunk/en/package/configuration/config/ avail-container/generic-conf.xml examples/generic-conf-write.php examples/generic-conf-write.txt

cweiske                                  Tue, 08 Mar 2011 19:27:22 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=309033

Log:
example for the config genericconf container

Changed paths:
    U   pear/peardoc/trunk/en/package/configuration/config/avail-container/generic-conf.xml
    A   pear/peardoc/trunk/en/package/configuration/config/examples/generic-conf-write.php
    A   pear/peardoc/trunk/en/package/configuration/config/examples/generic-conf-write.txt

Modified: pear/peardoc/trunk/en/package/configuration/config/avail-container/generic-conf.xml
===================================================================
--- pear/peardoc/trunk/en/package/configuration/config/avail-container/generic-conf.xml	2011-03-08 18:24:04 UTC (rev 309032)
+++ pear/peardoc/trunk/en/package/configuration/config/avail-container/generic-conf.xml	2011-03-08 19:27:22 UTC (rev 309033)
@@ -62,5 +62,32 @@
  </table>


- <!-- FIXME: example file, example load, example save -->
+
+
+ <section>
+  <info>
+   <title>Writing a config file with custom options</title>
+  </info>
+
+  <programlisting role="php">
+   <xi:include parse="text"
+    xmlns:xi="http://www.w3.org/2001/XInclude"
+    href="&package.configuration.config.examples.generic-conf-write.php;"
+   >
+    <xi:fallback>FIXME:MISSING XINCLUDE CONTENT</xi:fallback>
+   </xi:include>
+  </programlisting>
+
+  <example>
+   <title>Generated file</title>
+   <programlisting role="ini">
+    <xi:include parse="text"
+     xmlns:xi="http://www.w3.org/2001/XInclude"
+     href="&package.configuration.config.examples.generic-conf-write.txt;"
+    >
+     <xi:fallback>FIXME:MISSING XINCLUDE CONTENT</xi:fallback>
+    </xi:include>
+   </programlisting>
+  </example>
+ </section>
 </section>

Added: pear/peardoc/trunk/en/package/configuration/config/examples/generic-conf-write.php
===================================================================
--- pear/peardoc/trunk/en/package/configuration/config/examples/generic-conf-write.php	                        (rev 0)
+++ pear/peardoc/trunk/en/package/configuration/config/examples/generic-conf-write.php	2011-03-08 19:27:22 UTC (rev 309033)
@@ -0,0 +1,27 @@
+<?php
+require_once 'Config.php';
+
+$conf = new Config();
+$root = $conf->getRoot();
+$root->createComment('Demo config file with GenericConf container');
+$root->createDirective('openLastFile', true);
+
+$root->createBlank();
+//GenericConf does not support sections, but section contents are serialized
+// into the main config namespace
+$dbsect = $root->createSection('database');
+$dbsect->createDirective('host', 'db-server.example.org');
+$dbsect->createDirective('name', 'demo-db');
+
+$r = $conf->writeConfig(
+    'generic-conf-write.txt',
+    'genericconf',
+    array(
+        'comment' => '#',
+        'equals'  => '=>',
+    )
+);
+if (PEAR::isError($r)) {
+    echo $r->getMessage() . "\n";
+}
+?>
\ No newline at end of file

Added: pear/peardoc/trunk/en/package/configuration/config/examples/generic-conf-write.txt
===================================================================
--- pear/peardoc/trunk/en/package/configuration/config/examples/generic-conf-write.txt	                        (rev 0)
+++ pear/peardoc/trunk/en/package/configuration/config/examples/generic-conf-write.txt	2011-03-08 19:27:22 UTC (rev 309033)
@@ -0,0 +1,5 @@
+#Demo config file with GenericConf container
+openLastFile=>1
+
+host=>db-server.example.org
+name=>demo-db