File: book.xml

package info (click to toggle)
php-doc 20241205~git.dfcbb86%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 70,956 kB
  • sloc: xml: 968,269; php: 23,883; javascript: 671; sh: 177; makefile: 37
file content (96 lines) | stat: -rw-r--r-- 2,241 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<book xml:id="book.yaconf" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <?phpdoc extension-membership="pecl" ?>
 <title>Yaconf</title>
 <titleabbrev>Yaconf</titleabbrev>

 <preface xml:id="intro.yaconf">
  &reftitle.intro;
  <para>
   <literal>Yet Another Configurations Container</literal>
   (<acronym>Yaconf</acronym>) is a configurations container,
   it parses <literal>INI</literal> files, and store the result
   in PHP when PHP is started, the result lives with the
   whole PHP lifecycle.
  </para>
  <para>
   Yaconf stores all configurations as
   interned string or immutable array, which means they are
   not refcounted-able, thus when you retrieving configurations
   from <acronym>Yaconf</acronym>, it could be considered as zero-copy, very fast.
  </para>
  <para>
   Yaconf supports sections and sections
   inheritance in <literal>INI</literal> files. If PHP is built as non-ZTS build,
   Yaconf also supports automatically reloading after <literal>INI</literal> files
   are changed.
  </para>
  <para>
   Yaconf requires PHP 7.0 or greater.
  </para>
  <example>
   <title>INI example</title>
   <programlisting role="ini">
<![CDATA[
;Simple key val
key=val

;Hash
hash.a=val

;Array
arr.0=val
;or
arr[]=val

;PHP constant
version=PHP_VERSION

;Environment variable
env=${PATH}
]]>
   </programlisting>
  </example>
  <example>
   <title>INI sections example</title>
   <programlisting role="ini">
<![CDATA[
[SectionA]
key=val
hash.a=val

;SectionB inherits SectionA
[SectionB:SectionA]
key=new_val                  ;override configuration key in SectionA
]]>
   </programlisting>
  </example>
 </preface>

 &reference.yaconf.setup;
 &reference.yaconf.yaconf;

</book>

<!-- 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
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/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
-->