doc-fr/reference/yaf/yaf_controller_abstract/forward.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: c9389e4a0e96801fd14d91336ff3f12e45929a73 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="yaf-controller-abstract.forward" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>Yaf_Controller_Abstract::forward</refname>
  <refpurpose>Transfère vers une autre action</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>bool</type><methodname>Yaf_Controller_Abstract::forward</methodname>
   <methodparam><type>string</type><parameter>action</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>paramters</parameter></methodparam>
  </methodsynopsis>
  <methodsynopsis>
   <modifier>public</modifier> <type>bool</type><methodname>Yaf_Controller_Abstract::forward</methodname>
   <methodparam><type>string</type><parameter>controller</parameter></methodparam>
   <methodparam><type>string</type><parameter>action</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>paramters</parameter></methodparam>
  </methodsynopsis>
  <methodsynopsis>
   <modifier>public</modifier> <type>bool</type><methodname>Yaf_Controller_Abstract::forward</methodname>
   <methodparam><type>string</type><parameter>module</parameter></methodparam>
   <methodparam><type>string</type><parameter>controller</parameter></methodparam>
   <methodparam><type>string</type><parameter>action</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>paramters</parameter></methodparam>
  </methodsynopsis>
  <para>
   Transfère le processus d'exécution courant vers une autre action.
   <note>
    <para>
     Cette méthode ne bascule pas vers l'action de destination immédiatement ;
     ce sera le cas un fois le flux courant terminé.
    </para>
   </note>
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>module</parameter></term>
    <listitem>
     <para>
      Nom du module de destination ; si NULL est fourni,
      alors le nom du module par défaut sera utilisé
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>controller</parameter></term>
    <listitem>
     <para>
      Nom du contrôleur de destination
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>action</parameter></term>
    <listitem>
     <para>
      Nom de l'action de destination
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>paramters</parameter></term>
    <listitem>
     <para>
      Arguments d'appel
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

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

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Exemple avec <function>Yaf_Controller_Abstract::forward</function></title>
   <programlisting role="php">
<![CDATA[
<?php
class IndexController extends Yaf_Controller_Abstract
{
    public function indexAction(){   
         $logined = $_SESSION["login"];
         if (!$logined) {
             $this->forward("login", array("from" => "Index")); // transfère vers l'action 'login'
             return FALSE;  // ceci est important ; cela termine le flux d'exécution courant
                            // et indique à Yaf de ne pas effectuer auto-affichage
         }

         // autres processus
    }

    public function loginAction() {
        echo "login, redirected from ", $this->_request->getParam("from") , " action";
    }
}
?>
]]>
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
   login, redirected from Index action
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><methodname>Yaf_Request_Abstrace::getParam</methodname></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
-->