execute.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 9e0f03ac354d797d1d16c0fcc1663e5e170f2727 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="yaf-action-abstract.execute" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>Yaf_Action_Abstract::execute</refname>
  <refpurpose>Point d'entrée de l'action</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>abstract</modifier> <modifier>public</modifier><type>mixed</type><methodname>Yaf_Action_Abstract::execute</methodname>
   <methodparam rep="repeat"><type>mixed</type><parameter>args</parameter></methodparam>
  </methodsynopsis>
  <para>
   L'utilisateur doit toujours définir cette méthode pour une action ;
   c'est le point d'entrée de l'action.
   La méthode <methodname>Yaf_Action_Abstract::execute</methodname>
   peut avoir des arguments.
   <note>
    <para>
     La valeur récupérée depuis la requête n'est pas sécurisée. Vous devriez
     effectuer quelques filtres avant de l'utiliser.
    </para>
   </note>
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>args</parameter></term>
    <listitem>
     <para>

     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

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

  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Exemple avec <function>Yaf_Action_Abstract::execute</function></title>
   <programlisting role="php">
<![CDATA[
<?php
/** 
 * Un exemple de contrôleur
 */
class ProductController extends Yaf_Controller_Abstract {
      protected $actions = array(
          "index" => "actions/Index.php",
      );
}
?>
]]>
   </programlisting>
  </example>
  <example>
   <title>Exemple avec <function>Yaf_Action_Abstract::execute</function></title>
   <programlisting role="php">
<![CDATA[
<?php
/** 
 * ListAction
 */
class ListAction extends Yaf_Action_Abstract {
     public function execute ($name, $id) {
         assert($name == $this->getRequest()->getParam("name"));
         assert($id   == $this->getRequest()->getParam("id"));
     }
}
?>
]]>
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
/**
 * Supposons que nous utilisons la route Yaf_Route_Static
 * pour la requête : http://yourdomain/product/list/name/yaf/id/22
 * Voici le résultat :
 */
 bool(true)
 bool(true)
]]>
   </screen>
  </example>
 </refsect1>

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