Zend_View-Helpers-Partial.xml 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 24249 -->
  3. <!-- Reviewed: no -->
  4. <sect3 id="zend.view.helpers.initial.partial">
  5. <title>L'aide de vue Partial</title>
  6. <para>
  7. L'aide de vue <code>Partial</code> est utilisée pour effectuer le rendu d'un modèle
  8. ("template") spécifique dans sa propre portée de variable. L'utilisation principale est pour
  9. les fragments réutilisables de modèle avec lesquels vous n'avez pas besoin de vous inquiéter
  10. des conflits de noms de variable. De plus, ils vous permettent de spécifier les scripts de
  11. vue partiels dans des modules spécifiques.
  12. </para>
  13. <para>
  14. Une soeur de l'aide <code>Partial</code>, l'aide de vue de <code>PartialLoop</code>
  15. vous permet de passer des données itératives, et effectue un rendu partiel pour chaque
  16. élément.
  17. </para>
  18. <note>
  19. <title>Compteur de PartialLoop</title>
  20. <para>
  21. L'aide de vue <code>PartialLoop</code> assigne une variable à la vue nommée
  22. <code>partialCounter</code> qui fournit la position courante du tableau au script de
  23. vue. Ce qui permet simplement d'avoir des couleurs alternatives dans les lignes d'un
  24. tableau par exemple.
  25. </para>
  26. </note>
  27. <example id="zend.view.helpers.initial.partial.usage">
  28. <title>Utilisation de base des Partials</title>
  29. <para>
  30. L'utilisation de base des <code>Partials</code> est d'effectuer le rendu d'un
  31. fragment de modèle dans sa propre portée de vue. Examinez le script partiel suivant
  32. :
  33. </para>
  34. <programlisting language="php"><![CDATA[
  35. <!--partiel.phtml-->
  36. <ul>
  37. <li>De : <?php echo $this->escape($this->de) ?></li>
  38. <li>Sujet : <?php echo $this->escape($this->sujet) ?></li>
  39. </ul>
  40. ]]></programlisting>
  41. <para>
  42. Vous l'appelleriez alors dans votre script de vue en utilisant ce qui suit
  43. :
  44. </para>
  45. <programlisting language="php"><![CDATA[
  46. <?php echo $this->partial('partiel.phtml', array(
  47. 'de' => 'Equipe Framework',
  48. 'sujet' => 'vues partielles')); ?>
  49. ]]></programlisting>
  50. <para>Qui vous retournerait :</para>
  51. <programlisting language="html"><![CDATA[
  52. <ul>
  53. <li>De : Equipe Framework</li>
  54. <li>Sujet : vues partielles</li>
  55. </ul>
  56. ]]></programlisting>
  57. </example>
  58. <note>
  59. <title>Qu'est qu'un modèle ?</title>
  60. <para>
  61. Un modèle utilisé avec l'aide de vue <code>Partial</code> peut être un des
  62. suivants :
  63. </para>
  64. <itemizedlist>
  65. <listitem>
  66. <para>
  67. <emphasis>Tableaux ("array")</emphasis> : si un tableau est fourni, il
  68. devrait être associatif, car ses paires de clé/valeur sont assignées à la vue
  69. avec les clés comme variables de vue.
  70. </para>
  71. </listitem>
  72. <listitem>
  73. <para>
  74. <emphasis>Objet implémentant la méthode toArray()</emphasis> : si un objet
  75. est fourni et qu'il possède une méthode <methodname>toArray()</methodname>, le résultat de
  76. <methodname>toArray()</methodname> sera assigné à la vue comme variable de vue.
  77. </para>
  78. </listitem>
  79. <listitem>
  80. <para>
  81. <emphasis>Objet standard</emphasis> : tout autre objet assignera le
  82. résultat de <methodname>object_get_vars()</methodname> (essentiellement toutes les
  83. propriétés publiques de l'objet) à l'objet de vue.
  84. </para>
  85. </listitem>
  86. </itemizedlist>
  87. <para>
  88. Si votre modèle est un objet, vous pouvez vouloir le fournir en tant qu'objet au
  89. script partiel, plutôt que de le sérialiser en un tableau de variables. Vous pouvez
  90. faire ceci en paramétrant la propriété "objectKey" de l'aide de vue approprié :
  91. </para>
  92. <programlisting language="php"><![CDATA[
  93. // Tell partial to pass objects as 'model' variable
  94. $view->partial()->setObjectKey('model');
  95. // Tell partial to pass objects from partialLoop as 'model' variable in final
  96. // partial view script:
  97. $view->partialLoop()->setObjectKey('model');
  98. ]]></programlisting>
  99. <para>
  100. Cette technique est particulièrement utile quand vous fournissez un
  101. <classname>Zend_Db_Table_Rowset</classname>s à <methodname>partialLoop()</methodname>, ainsi vous
  102. avez un accès complet à vos objets <code>Row</code> à l'intérieur de vos scripts de vue,
  103. permettant d'appeler des méthodes sur ceux-ci (comme récupérer des valeurs d'un
  104. <code>Row</code> parent ou dépendant).
  105. </para>
  106. </note>
  107. <example id="zend.view.helpers.initial.partial.partialloop">
  108. <title>Utiliser PartialLoop pour effectuer le rendu d'éléments itératifs</title>
  109. <para>
  110. Typiquement, vous voudrez employer des <code>Partials</code> dans une boucle, pour
  111. rendre le même fragment de contenu plusieurs fois ; de cette façon vous pouvez mettre de
  112. grands blocs de contenu répété ou de logique complexe d'affichage dans un endroit
  113. unique. Toutefois ceci a un impact d'exécution, car l'aide Partial doit être appelée une
  114. fois par itération.
  115. </para>
  116. <para>
  117. L'aide de vue <code>PartialLoop</code> résout ce problème. Elle vous permet de
  118. fournir un élément itérable (tableau ou objet implémentant <code>Iterator</code>) comme
  119. modèle. Elle réitère alors au-dessus de celui-ci en fournissant les éléments au script
  120. partiel. Les éléments dans l'itérateur peuvent être n'importe quel modèle que l'aide de
  121. vue <code>Partial</code> permet (cf. ci-dessus).
  122. </para>
  123. <para>Considérons le script partiel suivant :</para>
  124. <programlisting language="php"><![CDATA[
  125. <!--partialLoop.phtml-->
  126. <dt><?php echo $this->key ?></dt>
  127. <dd><?php echo $this->value ?></dd>
  128. ]]></programlisting>
  129. <para>Et le "modèle" suivant :</para>
  130. <programlisting language="php"><![CDATA[
  131. $model = array(
  132. array('key' => 'Mammifère', 'value' => 'Chameau'),
  133. array('key' => 'Oiseau', 'value' => 'Pingouin'),
  134. array('key' => 'Reptile', 'value' => 'Asp'),
  135. array('key' => 'Poisson', 'value' => 'Flounder')
  136. );
  137. ]]></programlisting>
  138. <para>
  139. Dans votre script de vue, vous pouvez maintenant appeler l'aide
  140. <code>PartialLoop</code> :
  141. </para>
  142. <programlisting language="php"><![CDATA[
  143. <dl>
  144. <?php echo $this->partialLoop('partialLoop.phtml', $model) ?>
  145. </dl>
  146. ]]></programlisting>
  147. <programlisting language="html"><![CDATA[
  148. <dl>
  149. <dt>Mammifère</dt>
  150. <dd>Chameau</dd>
  151. <dt>Oiseau</dt>
  152. <dd>Pingouin</dd>
  153. <dt>Reptile</dt>
  154. <dd>Asp</dd>
  155. <dt>Poisson</dt>
  156. <dd>Flounder</dd>
  157. </dl>
  158. ]]></programlisting>
  159. </example>
  160. <example id="zend.view.helpers.initial.partial.modules">
  161. <title>Effectuer le rendu partiel dans des modules différents</title>
  162. <para>
  163. Parfois un partiel existera dans un module différent. Si vous connaissez le nom du
  164. module, vous pouvez le fournir comme deuxième argument à <methodname>partial()</methodname> ou à
  165. <methodname>partialLoop()</methodname>, en déplaçant l'argument <varname>$model</varname> à la troisième
  166. position.
  167. </para>
  168. <para>
  169. Par exemple, s'il y a un gestionnaire de page partiel que vous souhaitez utiliser
  170. et qui est dans le module "liste", vous pourriez le saisir comme suit :
  171. </para>
  172. <programlisting language="php"><![CDATA[
  173. <?php echo $this->partial('pager.phtml', 'liste', $pagerData) ?>
  174. ]]></programlisting>
  175. <para>
  176. De cette façon, vous pouvez réutiliser des partiels créés spécifiquement pour
  177. d'autre modules. Ceci dit, il est probablement une meilleure pratique de mettre des
  178. partiels réutilisables dans des dossiers partagés de script de vue.
  179. </para>
  180. </example>
  181. </sect3>