|
|
@@ -7,7 +7,9 @@
|
|
|
<sect4 id="zend.controller.actionhelper.viewrenderer.introduction">
|
|
|
<title>Introduction</title>
|
|
|
|
|
|
- <para>L'aide <code>ViewRenderer</code> apporte les comportements suivants :</para>
|
|
|
+ <para>
|
|
|
+ L'aide <emphasis>ViewRenderer</emphasis> apporte les comportements suivants :
|
|
|
+ </para>
|
|
|
|
|
|
<itemizedlist>
|
|
|
<listitem>
|
|
|
@@ -47,29 +49,32 @@
|
|
|
|
|
|
<note>
|
|
|
<para>
|
|
|
- Su vous utilisez <methodname>_forward()</methodname>, <methodname>redirect()</methodname>, ou
|
|
|
- <methodname>render()</methodname> manuellement, le rendu automatique sera annulé car
|
|
|
- <code>ViewRenderer</code> saura que vous prenez la main.
|
|
|
+ Su vous utilisez <methodname>_forward()</methodname>,
|
|
|
+ <methodname>redirect()</methodname>, ou <methodname>render()</methodname>
|
|
|
+ manuellement, le rendu automatique sera annulé car
|
|
|
+ <emphasis>ViewRenderer</emphasis> saura que vous prenez la main.
|
|
|
</para>
|
|
|
</note>
|
|
|
|
|
|
<note>
|
|
|
<para>
|
|
|
- Le <code>ViewRenderer</code> est activé par défaut dans le contrôleur
|
|
|
- frontal. Pour le désactiver, utilisez le paramètre <code>noViewRenderer</code>
|
|
|
- (<code>$front->setParam('noViewRenderer', true)</code>) ou retirez l'objet du
|
|
|
- gestionnaire d'aides
|
|
|
+ Le <emphasis>ViewRenderer</emphasis> est activé par défaut dans le contrôleur
|
|
|
+ frontal. Pour le désactiver, utilisez le paramètre
|
|
|
+ <emphasis>noViewRenderer</emphasis>
|
|
|
+ (<command>$front->setParam('noViewRenderer', true);</command>) ou retirez
|
|
|
+ l'objet du gestionnaire d'aides
|
|
|
(<methodname>Zend_Controller_Action_HelperBroker::removeHelper('viewRenderer')</methodname>).
|
|
|
</para>
|
|
|
<para>
|
|
|
- Si vous voulez modifier un paramètre du <code>ViewRenderer</code> avant la
|
|
|
+ Si vous voulez modifier un paramètre du <emphasis>ViewRenderer</emphasis> avant la
|
|
|
distribution du contrôleur frontal, il existe deux moyens :
|
|
|
</para>
|
|
|
<itemizedlist>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
Instanciez et enregistrez votre propre objet
|
|
|
- <code>ViewRenderer</code> et passez le au gestionnaire d'aides :
|
|
|
+ <emphasis>ViewRenderer</emphasis> et passez le au gestionnaire
|
|
|
+ d'aides :
|
|
|
</para>
|
|
|
<programlisting language="php"><![CDATA[
|
|
|
$viewRenderer = new Zend_Controller_Action_Helper_ViewRenderer();
|
|
|
@@ -80,8 +85,8 @@ Zend_Controller_Action_HelperBroker::addHelper($viewRenderer);
|
|
|
</listitem>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- Initialisez et/ou récupérez l'objet <code>ViewRenderer</code> via le
|
|
|
- gestionnaire d'aides :
|
|
|
+ Initialisez et/ou récupérez l'objet
|
|
|
+ <emphasis>ViewRenderer</emphasis> via le gestionnaire d'aides :
|
|
|
</para>
|
|
|
<programlisting language="php"><![CDATA[
|
|
|
$viewRenderer =
|
|
|
@@ -99,9 +104,9 @@ $viewRenderer->setView($view)
|
|
|
|
|
|
<para>
|
|
|
L'usage le plus banal consiste à instancier et passer l'objet
|
|
|
- <code>ViewRenderer</code> au gestionnaire d'aides. La manière la plus simple est
|
|
|
- d'utiliser la méthode statique <methodname>getStaticHelper()</methodname> du gestionnaire, qui
|
|
|
- s'occupe de tout ceci en une passe :
|
|
|
+ <emphasis>ViewRenderer</emphasis> au gestionnaire d'aides. La manière la plus simple
|
|
|
+ est d'utiliser la méthode statique <methodname>getStaticHelper()</methodname>
|
|
|
+ du gestionnaire, qui s'occupe de tout ceci en une passe :
|
|
|
</para>
|
|
|
|
|
|
<programlisting language="php"><![CDATA[
|
|
|
@@ -109,16 +114,18 @@ Zend_Controller_Action_HelperBroker::getStaticHelper('viewRenderer');
|
|
|
]]></programlisting>
|
|
|
|
|
|
<para>
|
|
|
- La première action demandée instancie ou récupère l'objet de vue. A chaque
|
|
|
- instanciation de contrôleur, la méthode <methodname>init()</methodname> de l'objet
|
|
|
- <code>ViewRenderer</code> est appelée. Elle va configurer la vue et appeler
|
|
|
- <methodname>addScriptPath()</methodname> avec un chemin relatif au dossier courant. Ceci a pour
|
|
|
- effet de "namespacer" toutes les aides et les filtres de vue pour le module en
|
|
|
- cours.
|
|
|
+ La première action demandée déclenche l'instanciation de l'objet de vue par le
|
|
|
+ <emphasis>ViewRenderer</emphasis>. A chaque instanciation de contrôleur, la
|
|
|
+ méthode <methodname>init()</methodname> de l'objet
|
|
|
+ <emphasis>ViewRenderer</emphasis> est appelée. Elle va configurer la vue et appeler
|
|
|
+ <methodname>addScriptPath()</methodname> avec un chemin relatif au dossier courant.
|
|
|
+ Ceci a pour effet de "namespacer" toutes les aides et les filtres de vue pour le
|
|
|
+ module en cours.
|
|
|
</para>
|
|
|
|
|
|
<para>
|
|
|
- A chaque <methodname>postDispatch()</methodname> d'action, <methodname>render()</methodname> est appelée.
|
|
|
+ A chaque <methodname>postDispatch()</methodname> d'action,
|
|
|
+ <methodname>render()</methodname> est appelée.
|
|
|
</para>
|
|
|
|
|
|
<para>Voici un exemple :</para>
|
|
|
@@ -148,59 +155,66 @@ $this->foo(); // appelle Foo_View_Helper_Foo::foo()
|
|
|
]]></programlisting>
|
|
|
|
|
|
<para>
|
|
|
- Le <code>ViewRenderer</code> définit de même des accesseurs pour configurer la
|
|
|
+ Le <emphasis>ViewRenderer</emphasis> définit de même des accesseurs pour configurer la
|
|
|
vue qu'il encapsule :
|
|
|
</para>
|
|
|
|
|
|
<itemizedlist>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <methodname>setView($view)</methodname> Passage de l'objet de vue. Il devient
|
|
|
- accessible comme une propriété publique de l'objet : <varname>$view</varname>.
|
|
|
+ <methodname>setView($view)</methodname> Passage de l'objet de vue au
|
|
|
+ <emphasis>ViewRenderer</emphasis>. Il devient accessible comme une propriété
|
|
|
+ publique de l'objet : <varname>$view</varname>.
|
|
|
</para>
|
|
|
</listitem>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
<methodname>setNeverRender($flag = true)</methodname> peut être utilisée pour
|
|
|
désactiver le rendu automatique de la vue dans tous les contrôleurs.
|
|
|
- <methodname>postDispatch()</methodname> est alors court-circuitée.
|
|
|
+ Si réglé à <constant>TRUE</constant>
|
|
|
+ <methodname>postDispatch()</methodname> ne va pa automatiquement appeler
|
|
|
+ <methodname>render()</methodname> dans le contrôleur courant.
|
|
|
<methodname>getNeverRender()</methodname> retourne ce paramètre.
|
|
|
</para>
|
|
|
</listitem>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <methodname>setNoRender($flag = true)</methodname> peut être utilisée pour désactiver
|
|
|
- le rendu automatique de la vue dans le contrôleur actuel.
|
|
|
- <methodname>postDispatch()</methodname> est alors court-circuitée, mais
|
|
|
- <methodname>preDispatch()</methodname> réactive le paramètre pour l'action suivante.
|
|
|
- <methodname>getNoRender()</methodname> retourne cette option.
|
|
|
+ <methodname>setNoRender($flag = true)</methodname> peut être utilisée pour
|
|
|
+ désactiver le rendu automatique de la vue dans le contrôleur actuel.
|
|
|
+ Si réglé à <constant>TRUE</constant>
|
|
|
+ <methodname>postDispatch()</methodname> ne va pa automatiquement appeler
|
|
|
+ <methodname>render()</methodname> dans le contrôleur courant, mais
|
|
|
+ <methodname>preDispatch()</methodname> réactive le paramètre pour l'action
|
|
|
+ suivante. <methodname>getNoRender()</methodname> retourne cette option.
|
|
|
</para>
|
|
|
</listitem>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <methodname>setNoController($flag = true)</methodname> est utilisée pour spécifier à
|
|
|
- <methodname>render()</methodname> de ne pas chercher le script de vue dans le sous
|
|
|
- répertoire après le contrôleur (correspondant à l'action). Par défaut, cette
|
|
|
- recherche est effectuée. <methodname>getNoController()</methodname> retourne ce
|
|
|
- paramètre.
|
|
|
+ <methodname>setNoController($flag = true)</methodname> est utilisée pour
|
|
|
+ spécifier à <methodname>render()</methodname> de ne pas chercher le script
|
|
|
+ de vue dans le sous répertoire après le contrôleur (correspondant à l'action).
|
|
|
+ Par défaut, cette recherche est effectuée.
|
|
|
+ <methodname>getNoController()</methodname> retourne ce paramètre.
|
|
|
</para>
|
|
|
</listitem>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
<methodname>setNeverController($flag = true)</methodname> fonctionne de manière
|
|
|
similaire à <methodname>setNoController()</methodname>, mais pour tous les
|
|
|
- contrôleurs.<methodname>getNeverController()</methodname> est l'autre accesseur.
|
|
|
+ contrôleurs.<methodname>getNeverController()</methodname> est l'autre
|
|
|
+ accesseur.
|
|
|
</para>
|
|
|
</listitem>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <methodname>setScriptAction($name)</methodname> peut être utilisée pour spécifier le
|
|
|
- script de vue d'une action à rendre. <varname>$name</varname> doit être le nom de
|
|
|
- l'action sans le suffixe (et sans le nom du contrôleur sauf si
|
|
|
- <code>noController</code> a été activé). Si vous n'utilisez pas cette méthode
|
|
|
- elle cherchera le script de vue correspondant au nom de l'action en cours
|
|
|
- (issue de l'objet de requête). <methodname>getScriptAction()</methodname> retourne la
|
|
|
- valeur actuelle de ce paramètre.
|
|
|
+ <methodname>setScriptAction($name)</methodname> peut être utilisée pour
|
|
|
+ spécifier le script de vue d'une action à rendre. <varname>$name</varname>
|
|
|
+ doit être le nom de l'action sans le suffixe (et sans le nom du contrôleur
|
|
|
+ sauf si <emphasis>noController</emphasis> a été activé). Si vous n'utilisez
|
|
|
+ pas cette méthode elle cherchera le script de vue correspondant au nom de
|
|
|
+ l'action en cours (issue de l'objet de requête).
|
|
|
+ <methodname>getScriptAction()</methodname> retourne la valeur actuelle de ce
|
|
|
+ paramètre.
|
|
|
</para>
|
|
|
</listitem>
|
|
|
<listitem>
|
|
|
@@ -212,20 +226,22 @@ $this->foo(); // appelle Foo_View_Helper_Foo::foo()
|
|
|
</listitem>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <methodname>initView($path, $prefix, $options)</methodname> doit être appelée pour
|
|
|
- configurer la vue : son "base path", le préfixe de classe pour les filtres et
|
|
|
- aides, et des options matérialisées par : <code>neverRender</code>,
|
|
|
- <code>noRender</code>, <code>noController</code>, <code>scriptAction</code>, et
|
|
|
- <code>responseSegment</code>.
|
|
|
+ <methodname>initView($path, $prefix, $options)</methodname> doit être appelée
|
|
|
+ pour configurer la vue : son "base path", le préfixe de classe pour les filtres
|
|
|
+ et aides, et des options du <emphasis>ViewRenderer</emphasis> matérialisées
|
|
|
+ par : <emphasis>neverRender</emphasis>, <emphasis>noRender</emphasis>,
|
|
|
+ <emphasis>noController</emphasis>, <emphasis>scriptAction</emphasis>, et
|
|
|
+ <emphasis>responseSegment</emphasis>.
|
|
|
</para>
|
|
|
</listitem>
|
|
|
<listitem>
|
|
|
<para>
|
|
|
- <code>setRender($action = null, $name = null, $noController =
|
|
|
- false)</code> vous permet de spécifier les paramètres
|
|
|
- <code>scriptAction</code>, <code>responseSegment</code>, et
|
|
|
- <code>noController</code> en une fois. <methodname>direct()</methodname> est un alias qui
|
|
|
- permet un appel rapide depuis le contrôleur :
|
|
|
+ <methodname>setRender($action = null, $name = null, $noController =
|
|
|
+ false)</methodname> vous permet de spécifier les paramètres
|
|
|
+ <emphasis>scriptAction</emphasis>, <emphasis>responseSegment</emphasis>, et
|
|
|
+ <emphasis>noController</emphasis> en une fois.
|
|
|
+ <methodname>direct()</methodname> est un alias qui permet un appel rapide
|
|
|
+ depuis le contrôleur :
|
|
|
</para>
|
|
|
<programlisting language="php"><![CDATA[
|
|
|
// Rend 'foo' au lieu du script correspondant à l'action courante
|
|
|
@@ -237,17 +253,18 @@ $this->_helper->viewRenderer('form', 'html', true);
|
|
|
]]></programlisting>
|
|
|
<note>
|
|
|
<para>
|
|
|
- <methodname>setRender()</methodname> et <methodname>direct()</methodname> ne rendent pas un
|
|
|
- script de vue à proprement parler, mais elles notifient au
|
|
|
- <methodname>postDispatch()</methodname> de le faire.
|
|
|
+ <methodname>setRender()</methodname> et <methodname>direct()</methodname>
|
|
|
+ ne rendent pas un script de vue à proprement parler, mais elles notifient
|
|
|
+ au <methodname>postDispatch()</methodname> et
|
|
|
+ <methodname>render()</methodname> sera utilisée pour le faire.
|
|
|
</para>
|
|
|
</note>
|
|
|
</listitem>
|
|
|
</itemizedlist>
|
|
|
|
|
|
<para>
|
|
|
- Le constructeur de <code>ViewRenderer</code> accepte aussi un objet de vue et un
|
|
|
- tableau d'options, de la même manière que <methodname>initView()</methodname> :
|
|
|
+ Le constructeur de <emphasis>ViewRenderer</emphasis> accepte aussi un objet de vue et
|
|
|
+ un tableau d'options, de la même manière que <methodname>initView()</methodname> :
|
|
|
</para>
|
|
|
|
|
|
<programlisting language="php"><
mikaelkael