construct.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b37bddfde36975bf6bf06ce98867e62d489d49c5 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes Maintainer: yannick -->
<refentry xml:id="yaf-route-regex.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>Yaf_Route_Regex::__construct</refname>
  <refpurpose>Contructeur Yaf_Route_Regex</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <constructorsynopsis>
   <modifier>public</modifier> <methodname>Yaf_Route_Regex::__construct</methodname>
   <methodparam><type>string</type><parameter>match</parameter></methodparam>
   <methodparam><type>array</type><parameter>route</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>map</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>verify</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>reverse</parameter></methodparam>
  </constructorsynopsis>
  <para>

  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>match</parameter></term>
    <listitem>
     <para>
      Un masque de Regex complet à utiliser pour y faire correspondre
      une requête URI ; si aucune correspondance n'est trouvée,
      <classname>Yaf_Route_Regex</classname> retournera &false;.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>route</parameter></term>
    <listitem>
     <para>
      Lorsque le masque trouve une correspondance dans la requête URI,
      <classname>Yaf_Route_Regex</classname> utilisera ce paramètre pour décider
      quel m/c/a doit être routé.
     </para>
     <para>
      Les éléments du tableau m/c/a sont optionnels ; si vous n'assignez pas
      de valeurs spécifiques à ces éléments, ils seront routés vers la route
      par défaut.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>map</parameter></term>
    <listitem>
     <para>
      Un tableau permettant d'assigner les noms aux éléments trouvés via
      le masque.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>verify</parameter></term>
    <listitem>
     <para>
      
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>reverse</parameter></term>
    <listitem>
     <para>
      une chaîne de caractères, utilisé pour assembler l'url. Voir la
      méthode <methodname>Yaf_Route_Regex::assemble</methodname>.
      <note>
       <para>
        Ce paramètre a été introduite en version 2.3.0
       </para>
      </note>
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>

  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Exemple avec <classname>Yaf_Route_Regex</classname></title>
   <programlisting role="php">
<![CDATA[
<?php
   /**
    * Ajoute une route Regex à la pile de routes Yaf_Router
    */
    Yaf_Dispatcher::getInstance()->getRouter()->addRoute("name",
        new Yaf_Route_Regex(
           "#^/product/([^/]+)/([^/])+#", //correspond à la requête URI "/product"
           array(
               'controller' => "product",  //route vers le controlleur produit,
           ),
           array(
              1 => "name",   // maintenant, vous pouvez appeler $request->getParam("name")
              2 => "id",     // pour récupérer la première capture du masque.
           )
        )
    );
?>
]]>
   </programlisting>
  </example>
  <example>
   <title>Exemple avec <function>Yaf_Route_Regex (depuis la version 2.3.0)</function></title>
   <programlisting role="php">
<![CDATA[
<?php
   /**
    * Utilise le résultat des correspondances comme nom MVC
    */
    Yaf_Dispatcher::getInstance()->getRouter()->addRoute("name",
        new Yaf_Route_Regex(
           "#^/product/([^/]+)/([^/])+#i", //trouve l'URI demandée après "/product"
           array(
              'controller' => ":name", // route vers :name, qui correspond à $1 dans le résultat de la correspondance
                                       // comme nom du contrôleur
           ),
           array(
              1 => "name",   // maintenant, vous pouvez appeler $request->getParam("name")
              2 => "id",     // pour récupérer la première capture du masque de correspondance
           )
        )
    );
?>
]]>
   </programlisting>
  </example>
  <example>
   <title>Exemple avec <classname>Yaf_Route_Regex</classname> et la capture du nom (depuis 2.3.0)</title>
   <programlisting role="php">
<![CDATA[
<?php
   /**
    * Use match result as MVC name
    */
    Yaf_Dispatcher::getInstance()->getRouter()->addRoute("name",
        new Yaf_Route_Regex(
           "#^/product/(?<name>[^/]+)/([^/])+#i", //trouve le dernier "/product" de l'URI demandé
           array(
           'controller' => ":name", // route vers :name,
                                    // qui est le groupe de capture 'name' dans le résultat des correspondances comme nom du contrôleur
           ),
           array(
              2 => "id",     // pour récupérer la première capture dans le masque de recherche.
           )
        )
    );
?>
]]>
   </programlisting>
  </example>
  <example>
   <title>Exemple avec <classname>Yaf_Route_Regex</classname></title>
   <programlisting role="php">
<![CDATA[
<?php
   /**
    * Ajoute une route Regex à la pile de routes Yaf_Router en appelant addconfig
    */
    $config = array(
        "name" => array(
           "type"  => "regex",          //la route Yaf_Route_Regex
           "match" => "#(.*)#",         //correspondance arbitraire à la requête URI
           "route" => array(
               'controller' => "product",  //route vers le controlleur produit,
               'action'     => "dummy",    //route pour l'action dummy
           ),
           "map" => array(
              1 => "uri",   // maintenant, vous pouvez appeler $request->getParam("uri")
           ),
        ),
    );
    Yaf_Dispatcher::getInstance()->getRouter()->addConfig(
        new Yaf_Config_Simple($config));
?>
]]>
   </programlisting>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><methodname>Yaf_Router::addRoute</methodname></member>
   <member><methodname>Yaf_Router::addConfig</methodname></member>
   <member><classname>Yaf_Route_Static</classname></member>
   <member><classname>Yaf_Route_Supervar</classname></member>
   <member><classname>Yaf_Route_Simple</classname></member>
   <member><classname>Yaf_Route_Rewrite</classname></member>
   <member><classname>Yaf_Route_Map</classname></member>
  </simplelist>                       
 </refsect1>  

</refentry>

<!-- 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
-->