ini.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: e2f2172bf114599926878017ab2dce356956fa9e Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<section xml:id="yaf.configuration" xmlns="http://docbook.org/ns/docbook">
 &reftitle.runtime;
 &extension.runtime;
 <para>
  <table>
   <title>Yaf &ConfigureOptions;</title>
   <tgroup cols="4">
    <thead>
     <row>
      <entry>&Name;</entry>
      <entry>&Default;</entry>
      <entry>&Changeable;</entry>
      <entry>&Changelog;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry><link linkend="ini.yaf.library">yaf.library</link></entry>
      <entry></entry>
      <entry><constant>INI_ALL</constant></entry>
      <entry><!-- leave empty, this will be filled by an automatic script --></entry>
     </row>
     <row>
      <entry><link linkend="ini.yaf.action-prefer">yaf.action_prefer</link></entry>
      <entry>0</entry>
      <entry><constant>INI_ALL</constant></entry>
      <entry><!-- leave empty, this will be filled by an automatic script --></entry>
     </row>
     <row>
      <entry><link linkend="ini.yaf.lowcase-path">yaf.lowcase_path</link></entry>
      <entry>0</entry>
      <entry><constant>INI_ALL</constant></entry>
      <entry><!-- leave empty, this will be filled by an automatic script --></entry>
     </row>
     <row>
      <entry><link linkend="ini.yaf.use-spl-autoload">yaf.use_spl_autoload</link></entry>
      <entry>0</entry>
      <entry><constant>INI_ALL</constant></entry>
      <entry><!-- leave empty, this will be filled by an automatic script --></entry>
     </row>
     <row>
      <entry><link linkend="ini.yaf.forward-limit">yaf.forward_limit</link></entry>
      <entry>5</entry>
      <entry><constant>INI_ALL</constant></entry>
      <entry><!-- leave empty, this will be filled by an automatic script --></entry>
     </row>
     <row>
      <entry><link linkend="ini.yaf.name-suffix">yaf.name_suffix</link></entry>
      <entry>1</entry>
      <entry><constant>INI_ALL</constant></entry>
      <entry><!-- leave empty, this will be filled by an automatic script --></entry>
     </row>
     <row>
      <entry><link linkend="ini.yaf.name-separator">yaf.name_separator</link></entry>
      <entry></entry>
      <entry><constant>INI_ALL</constant></entry>
      <entry><!-- leave empty, this will be filled by an automatic script --></entry>
     </row>
     <row>
      <entry><link linkend="ini.yaf.cache-config">yaf.cache_config</link></entry>
      <entry>0</entry>
      <entry><constant>INI_SYSTEM</constant></entry>
      <entry><!-- leave empty, this will be filled by an automatic script --></entry>
     </row>
     <row>
      <entry><link linkend="ini.yaf.environ">yaf.environ</link></entry>
      <entry>product</entry>
      <entry><constant>INI_SYSTEM</constant></entry>
      <entry><!-- leave empty, this will be filled by an automatic script --></entry>
     </row>
     <row>
      <entry><link linkend="ini.yaf.use-namespace">yaf.use_namespace</link></entry>
      <entry>0</entry>
      <entry><constant>INI_SYSTEM</constant></entry>
      <entry><!-- leave empty, this will be filled by an automatic script --></entry>
     </row>
    </tbody>
   </tgroup>
  </table>
 </para>

 &ini.descriptions.title;

 <para>
  <variablelist>
   <varlistentry xml:id="ini.yaf.library">
    <term>
     <parameter>yaf.library</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      Путь к каталогу, в котором Yaf_loader станет искать глобальную библиотеку.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.yaf.action-prefer">
    <term>
     <parameter>yaf.action_prefer</parameter>
     <type>int</type>
    </term>
    <listitem>
     <para>
      Требуется ли интерпретировать в элементе PATH_INFO путь с единственным сегментом как контроллер или действие.
     </para>
     <para>
      При установке значения On путь интерпретируется как название действия.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.yaf.lowcase-path">
    <term>
     <parameter>yaf.lowcase_path</parameter>
     <type>int</type>
    </term>
    <listitem>
     <para>
      Приводить ли путь к нижнему регистру при автозагрузке классов.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.yaf.use-spl-autoload">
    <term>
     <parameter>yaf.use_spl_autoload</parameter>
     <type>int</type>
    </term>
    <listitem>
     <para>
      При установке значения On автозагрузчик <classname>Yaf_Loader</classname> вернёт &false;,
      если не найдёт класс, и вернёт управление для вызова следующей функции автозагрузки.
     </para>
     <para>
      При установке значения Off автозагрузчик <classname>Yaf_Loader</classname>
      вернёт &true;, если не найдёт класс, и сразу прервёт автозагрузку классов с ошибкой.
     </para>
     <note>
      <para>
       Yaf регистрирует загрузчик классов при создании экземпляра класса
       <classname>Yaf_Application</classname>, поэтому остальные
       автозагрузчики, зарегистрированные до инстанциации этого класса,
       запустятся до срабатывания метода <methodname>Yaf_Loader::autoload</methodname>.
      </para>
     </note>
     <para>
      Со значением по умолчанию — Off —
      метод <methodname>Yaf_Loader::autoload</methodname> возвращает &true; независимо от результата поиска класса.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.yaf.forward-limit">
    <term>
     <parameter>yaf.forward_limit</parameter>
     <type>int</type>
    </term>
    <listitem>
     <para>
      Предельное количество перенаправлений. Значение по умолчанию — 5:
      предельная глубина стека перенаправлений.
     </para>
     <para>
      Ограничение глубины стека защищает от бесконечного рекурсивного вызова метода
      <methodname>Yaf_Controller_Abstract::forward</methodname>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.yaf.name-suffix">
    <term>
     <parameter>yaf.name_suffix</parameter>
     <type>int</type>
    </term>
    <listitem>
     <para>
      При установке значения On автозагрузчик Yaf_Loader распознаёт MVC-классы
      по суффиксу в названии класса.
     </para>
     <para>
      При установке значения Off автозагрузчик Yaf_Loader опирается на префикс в названии класса.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.yaf.name-separator">
    <term>
     <parameter>yaf.name_separator</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      Непустое значение разделяет название класса на две части: префикс и суффикс.
      Автозагрузчик Yaf_Loader распознает MVC-роль класса по суффиксу, а название MVC-компонента — по префиксу.
     </para>
     <para>
      С разделителем  "_" автозагрузчик Yaf_Loader распознает название Index_Controller
      как класс контроллера, а IndexController — как стандартный класс.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.yaf.cache-config">
    <term>
     <parameter>yaf.cache_config</parameter>
     <type>int</type>
    </term>
    <listitem>
     <para>
      При установке значения On и передаче в конструктор класса <classname>Yaf_Application</classname>
      аргумента с путём к конфигурационному ini-файлу результат компиляции
      ini-файла кешируется в PHP-процессе.
      <note>
       <para>
        Модуль Yaf проверяет время модификации файла конфигурации и перекомпилирует ini-файл,
        если значение mtime изменилось с момента последней компиляции.
       </para>
      </note>
      <warning>
       <para>
        Модуль Yaf обрабатывает путь к ini-файлу как ключ закешированной записи,
        поэтому лучше указывать полные, абсолютные пути,
        чтобы два приложения, которые работают с ini-файлами с одинаковыми названиями, но разным содержанием,
        не конфликтовали между собой.
       </para>
      </warning>
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.yaf.environ">
    <term>
     <parameter>yaf.environ</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      Значение по умолчанию — "product". По значению директивы модуль Yaf
      определяет, какую секцию конфигурационного ini-файла требуется загрузить.
     </para>
     <para>
      При установке значения "product" модуль Yaf считает ini-файл, путь к которому передали в первый параметр конструктора класса
      <classname>Yaf_Application</classname>, и загрузит секцию с названием "product" как окончательную конфигурацию приложения
      <classname>Yaf_Application</classname>.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry xml:id="ini.yaf.use-namespace">
    <term>
     <parameter>yaf.use_namespace</parameter>
     <type>int</type>
    </term>
    <listitem>
     <para>
      При установке значения On названия классов модуля Yaf строятся
      по правилам именования классов в пространствах имён.
     </para>
     <para>
      Например:
      <screen>
<![CDATA[
Yaf_Route_Rewrite => \Yaf\Route\Rewrite
Yaf_Request_Http  => \Yaf\Request\Http
]]>
      </screen>
      Исключение — отдельные классы наподобие
      <classname>Yaf_Controller_Abstract</classname>.
      Последний компонент названия — ключевое слово в PHP,
      которое нельзя указывать как название класса,
      поэтому класс получит следующее название:
      <screen>
<![CDATA[
Yaf_Controller_Abstract => \Yaf\Controller_Abstract
Yaf_Route_Static => \Yaf\Route_Static
]]>
      </screen>
     </para>
    </listitem>
   </varlistentry>

  </variablelist>
 </para>
</section>
<!-- 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
-->