ini.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f9c4a68ef4f89e51e6d9b905ad3ddb6492386dd3 Maintainer: yannick Status: ready -->
<!-- CREDITS: DavidA -->

<section xml:id="yaf.configuration" xmlns="http://docbook.org/ns/docbook">
 &reftitle.runtime;
 &extension.runtime;
 <para>
  <table>
   <title>&ConfigureOptions; Yaf</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_ALL</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>
      Le chemin vers la bibliothèque globale ; Yaf_loader
      cherchera dans ce dossier la bibliothèque globale.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.yaf.action-prefer">
    <term>
     <parameter>yaf.action_prefer</parameter>
     <type>int</type>
    </term>
    <listitem>
     <para>
      S'il n'y a qu'une seule partie dans PATH_INFO,
      doit être considéré comme un contrôleur ou une action.
     </para>
     <para>
      Si cette option est activée, elle sera considérée
      comme un nom d'action.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.yaf.lowcase-path">
    <term>
     <parameter>yaf.lowcase_path</parameter>
     <type>int</type>
    </term>
    <listitem>
     <para>
      Si l'on doit mettre en minuscule le chemin lors de l'autochargement
      de la classe.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.yaf.use-spl-autoload">
    <term>
     <parameter>yaf.use_spl_autoload</parameter>
     <type>int</type>
    </term>
    <listitem>
     <para>
      Lorsque cette valeur est active, si <classname>Yaf_Loader</classname>
      ne trouve pas une classe, il retournera &false;, et donnera ensuite
      la chance aux autres fonctions au chargement automatique d'être appelées.
     </para>
     <para>
      Lorsque cette valeur est désactivée, si <classname>Yaf_Loader</classname>
      ne peut pas trouver une classe, il retournera &true;, et fera échouer
      l'autochargement de la classe immédiatement.
     </para>
     <note>
      <para>
       Yaf enregistrera son chargeur lors de l'instanciation de
       <classname>Yaf_Application</classname>, aussi, tous les autres
       chargeurs automatiques qui sont enregistrés avant l'instanciation
       seront appelés avant <methodname>Yaf_Loader::autoload</methodname>.
      </para>
     </note>
     <para>
      Lorsque cette valeur est désactivé (Off par défaut),
      la méthode <methodname>Yaf_Loader::autoload</methodname>
      retournera toujours &true;.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.yaf.forward-limit">
    <term>
     <parameter>yaf.forward_limit</parameter>
     <type>int</type>
    </term>
    <listitem>
     <para>
      Le nombre maximal de redirection ; par défaut, 5.
      Cela signifie que vous pouvez avoir un nombre maximal de 5 redirections
      dans la pile des redirections.
     </para>
     <para>
      Ceci est une protection contre les
      <methodname>Yaf_Controller_Abstract::forward</methodname> récursifs.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.yaf.name-suffix">
    <term>
     <parameter>yaf.name_suffix</parameter>
     <type>int</type>
    </term>
    <listitem>
     <para>
      Lorsqu'activé, Yaf_Loader identifiera une classe par son suffixe pour
      décider si c'est bien une classe MVC.
     </para>
     <para>
      Lorsque désactivé, Yaf_Loader regardera le préfixe du nom de la classe.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.yaf.name-separator">
    <term>
     <parameter>yaf.name_separator</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      Lorsque non vide, Yaf_Loader identifiera le suffixe de la classe
      à l'aide de ce séparateur.
     </para>
     <para>
      Par exemple, lorsque cette option contient la valeur "_", Yaf_Loader
      prendra Index_Controller comme une classe contrôleur, et
      IndexController comme une classe normale.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.yaf.cache-config">
    <term>
     <parameter>yaf.cache_config</parameter>
     <type>int</type>
    </term>
    <listitem>
     <para>
      Si activé, et dans le même temps, vous utilisez un fichier de configuration
      au format ini comme paramètre de la méthode <methodname>Yaf_Application</methodname>,
      le résultat de la compilation du fichier de configuration au format ini
      sera mis en cache dans le processus PHP.
      <note>
       <para>
        Yaf examine le flag mtime du fichier ini, et s'il a été modifié depuis
        la dernière compilation, Yaf le rechargera.
       </para>
      </note>
      <warning>
       <para>
        Yaf utilise le chemin vers le fichier ini comme clé de l'entrée du cache,
        aussi, n'utilisez pas un chemin absolu pour votre chemin vers le fichier ini,
        sinon, il se pourrait qu'il y ait des conflit si deux applications
        utilisent le même chemin relatif pour le chemin vers le fichier de configuration ini.
       </para>
      </warning>
     </para>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="ini.yaf.environ">
    <term>
     <parameter>yaf.environ</parameter>
     <type>string</type>
    </term>
    <listitem>
     <para>
      La valeur est "product" par défaut ; utilisé par Yaf pour récupérer
      la section de configuration d'un fichier de configuration au format ini.
     </para>
     <para>
      Si la valeur est bien "product", Yaf utilisera la section nommée "product"
      dans le fichier de configuration au format ini (le premier paramètre de la
      classe <classname>Yaf_Application</classname>) comme configuration finale
      pour la classe <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>
      Si cette option est activée, toutes
      les classes de Yaf seront nommées via des espaces de noms.
     </para>
     <para>
      Par exemple :
      <screen>
<![CDATA[
Yaf_Route_Rewrite => \Yaf\Route\Rewrite
Yaf_Request_Http  => \Yaf\Request\Http
]]>
      </screen>
      Il y a une exception à ce principe, comme par exemple la classe
      <classname>Yaf_Controller_Abstract</classname>.
      Le dernier composant est un mot clé PHP, ne pouvant pas être utilisé
      comme nom de classe ; aussi, pour de tel cas :
      <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
-->