php-doc-en/reference/yaconf/book.xml
2021-06-13 23:23:33 +01:00

94 lines
2.1 KiB
XML

<?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 INI 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 yaconf, it could be considered as zero-copy, very fast.
</para>
<para>
Yaconf supports sections and sections
inheritance in INI files. if PHP is built as non-ZTS build,
Yaconf also supports automatically reloading after INI 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
;use PHP constants
version=PHP_VERION
;use environment
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]
;override configuration key in SectionA
key=new_val
]]>
</programlisting>
</example>
</preface>
&reference.yaconf.setup;
&reference.yaconf.constants;
&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
-->