1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
|
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 24249 -->
<!-- Reviewed: no -->
<sect3 id="zend.controller.actionhelpers.viewrenderer">
<title>ViewRenderer</title>
<sect4 id="zend.controller.actionhelper.viewrenderer.introduction">
<title>Introduction</title>
<para>
L'aide <emphasis>ViewRenderer</emphasis> apporte les comportements suivants :
</para>
<itemizedlist>
<listitem>
<para>
Élimine le besoin d'instancier un objet de vue dans ses contrôleurs. Ceci
devient automatique.
</para>
</listitem>
<listitem>
<para>
Configure automatiquement les chemins vers les scripts de vue, les aides,
et les filtres, en se basant sur le module actuel et associe le nom du module
comme préfixe de classe pour les aides et les filtres.
</para>
</listitem>
<listitem>
<para>
Créer un objet de vue général accessible pour tous les contrôleurs et
donc pour toutes les actions disptachées.
</para>
</listitem>
<listitem>
<para>
Autorise le développeur à personnaliser les options de rendu de la vue.
</para>
</listitem>
<listitem>
<para>Donne la possibilité de rendre automatiquement un script de vue.</para>
</listitem>
<listitem>
<para>
Donne accès aux paramètres configurant le chemin de base (base path) et
le chemin des scripts (script path), de la vue.
</para>
</listitem>
</itemizedlist>
<note>
<para>
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 <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 <emphasis>ViewRenderer</emphasis> avant la
distribution du contrôleur frontal, il existe deux moyens :
</para>
<itemizedlist>
<listitem>
<para>
Instanciez et enregistrez votre propre objet
<emphasis>ViewRenderer</emphasis> et passez le au gestionnaire
d'aides :
</para>
<programlisting language="php"><![CDATA[
$viewRenderer = new Zend_Controller_Action_Helper_ViewRenderer();
$viewRenderer->setView($view)
->setViewSuffix('php');
Zend_Controller_Action_HelperBroker::addHelper($viewRenderer);
]]></programlisting>
</listitem>
<listitem>
<para>
Initialisez et/ou récupérez l'objet
<emphasis>ViewRenderer</emphasis> via le gestionnaire d'aides :
</para>
<programlisting language="php"><![CDATA[
$viewRenderer =
Zend_Controller_Action_HelperBroker::getStaticHelper('viewRenderer');
$viewRenderer->setView($view)
->setViewSuffix('php');
]]></programlisting>
</listitem>
</itemizedlist>
</note>
</sect4>
<sect4 id="zend.controller.actionhelper.viewrenderer.api">
<title>API</title>
<para>
L'usage le plus banal consiste à instancier et passer l'objet
<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[
Zend_Controller_Action_HelperBroker::getStaticHelper('viewRenderer');
]]></programlisting>
<para>
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.
</para>
<para>Voici un exemple :</para>
<programlisting language="php"><![CDATA[
// Bar controller , module foo :
class Foo_BarController extends Zend_Controller_Action
{
// Rend bar/index.phtml par défaut; rien à faire c'est automatique
public function indexAction()
{
}
// Rend bar/populate.phtml avec une variable 'foo' à la valeur 'bar'.
// l'objet de vue est défini dans le preDispatch(), il est donc
// accessible.
public function populateAction()
{
$this->view->foo = 'bar';
}
}
...
// Dans un des scripts de vue :
$this->foo(); // appelle Foo_View_Helper_Foo::foo()
]]></programlisting>
<para>
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 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.
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.
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.
</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.
</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 <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>
<para>
<methodname>setResponseSegment($name)</methodname> dit dans quel segment de la
réponse rendre le script. Par défaut, la vue est rendue dans le segment par
défaut. <methodname>getResponseSegment()</methodname> retourne cette valeur.
</para>
</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 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>
<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
$this->_helper->viewRenderer('foo');
// rend form.phtml dans le segment 'html' de la réponse sans utiliser le
// sous repertoire contrôleur pour chercher le script de vue :
$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> et
<methodname>render()</methodname> sera utilisée pour le faire.
</para>
</note>
</listitem>
</itemizedlist>
<para>
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"><![CDATA[
$view = new Zend_View(array('encoding' => 'UTF-8'));
$options = array('noController' => true, 'neverRender' => true);
$viewRenderer =
new Zend_Controller_Action_Helper_ViewRenderer($view, $options);
]]></programlisting>
<para>
Il est aussi possible de personnaliser les chemins utilisés pour déterminer le
base path (chemin de base) de la vue ainsi que le script path (chemin vers les scripts
de vue). Des méthodes le permettent, utilisez les options suivantes avec :
</para>
<itemizedlist>
<listitem>
<para>
<emphasis>:moduleDir</emphasis> représente le module courant (par convention le
dossier parent au dossier contrôleur).
</para>
</listitem>
<listitem>
<para><emphasis>:module</emphasis> pointe vers le module actuel.</para>
</listitem>
<listitem>
<para><emphasis>:controller</emphasis> pointe vers le contrôleur actuel.</para>
</listitem>
<listitem>
<para><emphasis>:action</emphasis> représente l'action actuellement traitée.</para>
</listitem>
<listitem>
<para>
<emphasis>:suffix</emphasis> est utilisée pour le suffixe du script de vue.
<methodname>setViewSuffix()</methodname> permet aussi de le modifier.
</para>
</listitem>
</itemizedlist>
<para>Toutes ces options s'utilisent avec les méthodes ci-après :</para>
<itemizedlist>
<listitem>
<para>
<methodname>setViewBasePathSpec($spec)</methodname> vous permet de changer le
dossier donnant accès aux dossiers de la vue : le base path. Par défaut
il s'agit de <filename>:moduleDir/views</filename>. L'accesseur de récupération
est <methodname>getViewBasePathSpec()</methodname>.
</para>
</listitem>
<listitem>
<para>
<methodname>setViewScriptPathSpec($spec)</methodname> : une fois dans le base
path, le rendu cherche le script de vue dans le script path, que cette méthode
permet de définir. La valeur par défaut est
<filename>:controller/:action.:suffix</filename> et
l'autre accesseur est <methodname>getViewScriptPathSpec()</methodname>.
</para>
</listitem>
<listitem>
<para>
<methodname>setViewScriptPathNoControllerSpec($spec)</methodname> Une fois
dans le base path, si <emphasis>noController</emphasis> est activé, le rendu
cherche le script de vue dans le chemin que cette méthode permet de définir.
La valeur par défaut est <filename>:action.:suffix</filename> et l'autre
accesseur est <methodname>getViewScriptPathNoControllerSpec()</methodname>.
</para>
</listitem>
</itemizedlist>
<para>
<emphasis>ViewRenderer</emphasis> utilise un inflecteur :
<link linkend="zend.filter.inflector">Zend_Filter_Inflector</link>, pour résoudre les
options de chemin, en chemins réels. Pour une personnalisation maximale, vous pouvez
interagir avec cet inflecteur à l'aide des méthodes suivantes :
</para>
<itemizedlist>
<listitem>
<para>
<methodname>getInflector()</methodname> retourne l'inflecteur. Si aucun
n'existe, <emphasis>ViewRenderer</emphasis> en crée un avec des options par
défaut.
</para>
<para>
Par défaut, les règles de l'inflecteur sont statiques autant pour le
suffixe et le répertoire module, que pour la cible. Ceci permet au
<emphasis>ViewRenderer</emphasis> de modifier ces valeurs dynamiquement.
</para>
</listitem>
<listitem>
<para>
<methodname>setInflector($inflector, $reference)</methodname> peut être
utilisée pour passer son propre inflecteur à
<emphasis>ViewRenderer</emphasis>. Si <varname>$reference</varname> est à
<constant>TRUE</constant>, alors le suffixe, le répertoire du module et
la cible seront affectés en fonction des propriétés de
<emphasis>ViewRenderer</emphasis>.
</para>
</listitem>
</itemizedlist>
<note>
<title>Règles de résolution par défaut</title>
<para>
Le <emphasis>ViewRenderer</emphasis> utilise certaines règles par défaut pour
chercher ses scripts de vue, voyez plutôt :
</para>
<itemizedlist>
<listitem>
<para>
<emphasis>:module</emphasis> : casseMélangée et motsEnNotationCamel
qui deviennent des mots séparés par des tirets, et en minuscules.
"FooBarBaz" devient "foo-bar-baz".
</para>
<para>
En interne, l'inflecteur utilise les filtres
<classname>Zend_Filter_Word_CamelCaseToDash</classname> et
<classname>Zend_Filter_StringToLower</classname>.
</para>
</listitem>
<listitem>
<para>
<emphasis>:controller</emphasis> : casseMélangée et
motsEnNotationCamel qui deviennent des mots séparés par des tirets ;
les tirets bas eux, se transforment en séparateur de dossier et tout est
passé en minuscules. "<classname>FooBar</classname>" devient
"foo-bar" ; "<classname>FooBar_Admin</classname>"
devient "<filename>foo-bar/admin</filename>".
</para>
<para>
En interne, l'inflecteur utilise les filtres
<classname>Zend_Filter_Word_CamelCaseToDash</classname>,
<classname>Zend_Filter_Word_UnderscoreToSeparator</classname>, et
<classname>Zend_Filter_StringToLower</classname>.
</para>
</listitem>
<listitem>
<para>
<emphasis>:action</emphasis> : casseMélangée et motsEnNotationCamel
qui se transforment en mots séparés par des tirets, minuscules. Les
caractères non alphanumériques deviennent des tirets. "fooBar" devient
"foo-bar" ; "foo-barBaz" devient "foo-bar-baz".
</para>
<para>
Pour ceci, l'inflecteur interne utilise les filtres
<classname>Zend_Filter_Word_CamelCaseToDash</classname>,
<classname>Zend_Filter_PregReplace</classname>, et
<classname>Zend_Filter_StringToLower</classname>.
</para>
</listitem>
</itemizedlist>
</note>
<para>
Enfin, l'<acronym>API</acronym> de <emphasis>ViewRenderer</emphasis> vous propose
aussi des méthodes pour déterminer les scripts de vue, et rendre la vue. Celles-ci
se décomposent en :
</para>
<itemizedlist>
<listitem>
<para>
<methodname>renderScript($script, $name)</methodname> va vous permettre de
spécifier pleinement le script de vue à rendre, et éventuellement un nom de
segment de réponse dans lequel rendre. <emphasis>ViewRenderer</emphasis>
s'attend à un paramètre <varname>$script</varname> représentant un chemin
complet vers un script de vue, telle que la méthode de la vue
<methodname>render()</methodname> l'attend.
</para>
<note>
<para>
Une fois rendue, la vue utilise <emphasis>noRender</emphasis> pour éviter
un double rendu automatisé.
</para>
</note>
<note>
<para>
Par défaut, <methodname>Zend_Controller_Action::renderScript()</methodname>
est un proxy vers la méthode <methodname>renderScript()</methodname> de
<emphasis>ViewRenderer</emphasis>.
</para>
</note>
</listitem>
<listitem>
<para>
<methodname>getViewScript($action, $vars)</methodname> récupère le chemin du
script de vue en se basant sur les paramètres $action et $vars.
<varname>$vars</varname> peut contenir "moduleDir", "module", "controller",
"action", et "suffix"), sinon les valeurs de la requête actuelle seront
utilisées.
</para>
<para>
<methodname>getViewScript()</methodname> utilisera
<emphasis>viewScriptPathSpec</emphasis> ou
<emphasis>viewScriptPathNoControllerSpec</emphasis> selon le paramètre
<emphasis>noController</emphasis>.
</para>
<para>
Les délimiteurs apparaissant dans les modules, contrôleurs ou actions seront
remplacés par des tirets ("-"). Ainsi pour un contrôleur
"<command>foo.bar</command>" et une action "<command>baz:bat</command>", il
résultera un chemin de vue "<filename>foo-bar/baz-bat.phtml</filename>".
</para>
<note>
<para>
Par défaut <methodname>Zend_Controller_Action::getViewScript()</methodname>
est un proxy vers la méthode <methodname>getViewScript()</methodname> de
<emphasis>ViewRenderer</emphasis>.
</para>
</note>
</listitem>
<listitem>
<para>
<methodname>render($action, $name, $noController)</methodname> a beaucoup de
responsabilités : d'abord, elle vérifie si <varname>$name</varname> ou
<varname>$noController</varname> lui ont été passés, si c'est le cas, elle
configure correctement les paramètres <code>responseSegment</code> et
<code>noController</code> dans le ViewRenderer. Elle passe ensuite
<varname>$action</varname>, si spécifié, à
<methodname>getViewScript()</methodname>. Enfin, elle
passe le script de vue calculé à <methodname>renderScript()</methodname>.
</para>
<note>
<para>
Attention aux effets secondaires avec
<methodname>render()</methodname> : les valeurs segment de réponse,
et <code>noController</code> vont persister dans l'objet ViewRenderer.
De plus, <methodname>noRender()</methodname> va être appelée.
</para>
</note>
<note>
<para>
Par défaut, <methodname>Zend_Controller_Action::render()</methodname>
est un proxy vers <methodname>render()</methodname> de
<emphasis>ViewRenderer</emphasis>.
</para>
</note>
</listitem>
<listitem>
<para>
<methodname>renderBySpec($action, $vars, $name)</methodname> vous fournit le
moyen de passer des paramètres de spécification pour le dossier de script de
vue. Cette méthode passe <varname>$action</varname> et <varname>$vars</varname>
à <methodname>getScriptPath()</methodname>, pour en déduire un chemin qu'elle
envoie alors avec <varname>$name</varname> à
<methodname>renderScript()</methodname>.
</para>
</listitem>
</itemizedlist>
</sect4>
<sect4 id="zend.controller.actionhelper.viewrenderer.basicusage">
<title>Exemples</title>
<example id="zend.controller.actionhelper.viewrenderer.basicusage.example-1">
<title>Usage de base</title>
<para>
L'utilisation la plus basique consiste à initialiser ou et enregistrer un
objet <emphasis>ViewRenderer</emphasis> dans le gestionnaire d'aides (helper
broker), et ensuite lui passer des variables dans vos contrôleurs.
</para>
<programlisting language="php"><![CDATA[
// Dans le fichier de démarrage :
Zend_Controller_Action_HelperBroker::getStaticHelper('viewRenderer');
...
// 'foo' module, contrôleur 'bar' :
class Foo_BarController extends Zend_Controller_Action
{
// Rend bar/index.phtml par défaut, rien à faire
public function indexAction()
{
}
// Rend bar/populate.phtml avec la variable 'foo' à la valeur 'bar'.
// L'objet de vue est rendu disponible en preDispatch().
public function populateAction()
{
$this->view->foo = 'bar';
}
// Ne rend rien, car on demande un nouveau jeton de distribution
public function bazAction()
{
$this->_forward('index');
}
// Ne rend rien, une redirection est demandée
public function batAction()
{
$this->_redirect('/index');
}
}
]]></programlisting>
</example>
<note>
<title>
Conventions de noms : délimiteurs de mots dans les noms de contrôleur et
d'action
</title>
<para>
Si les noms de votre contrôleur ou de votre action sont composés de plusieurs
mots, le distributeur s'attend à ce qu'ils soient séparés par des caractères bien
définis, dans l'<acronym>URL</acronym>. Le <emphasis>ViewRenderer</emphasis> les
transforme alors en '/' pour les chemins, ou tirets '-' pour les mots. Ainsi, un
appel à <filename>/foo.bar/baz.bat</filename> distribuera
<methodname>FooBarController::bazBatAction()</methodname> dans
<filename>FooBarController.php</filename>, et ceci rendra
<filename>foo-bar/baz-bat.phtml</filename>. Un appel à
<filename>/bar_baz/baz-bat</filename> distribuera vers
<methodname>Bar_BazController::bazBatAction()</methodname> dans
<filename>Bar/BazController.php</filename> (notez la séparation du chemin),
et rend <filename>bar/baz/baz-bat.phtml</filename>.
</para>
<para>
Notez dans le second exemple, le module est celui par défaut, mais comme un
séparateur de chemin (tiret bas ou "_") est donné, alors le contrôleur distribué
devient <classname>Bar_BazController</classname>, dans
<filename>Bar/BazController.php</filename>.
</para>
</note>
<example id="zend.controller.actionhelper.viewrenderer.basicusage.example-2">
<title>Désactivation du rendu automatique</title>
<para>
Il peut être nécessaire dans certains cas de désactiver manuellement le rendu
automatique de vue effectué par ViewRenderer. Par exemple, si le contrôleur doit
retourner une sortie spéciale, comme <acronym>XML</acronym> ou
<acronym>JSON</acronym>. Deux options s'offrent à vous :
<methodname>setNeverRender()</methodname>) et
<methodname>setNoRender()</methodname>.
</para>
<programlisting language="php"><![CDATA[
// Baz controller class, bar module :
class Bar_BazController extends Zend_Controller_Action
{
public function fooAction()
{
// Ne rend pas automatiquement cette action
$this->_helper->viewRenderer->setNoRender();
}
}
// Bat controller class, bar module :
class Bar_BatController extends Zend_Controller_Action
{
public function preDispatch()
{
// Ne rend plus aucune action de ce contrôleur
$this->_helper->viewRenderer->setNoRender();
}
}
]]></programlisting>
</example>
<note>
<para>
Utiliser <methodname>setNeverRender()</methodname>), pour désactiver totalement
le rendu automatique de vue vous fera perdre un des avantages majeur de
<emphasis>ViewRenderer</emphasis>.
</para>
</note>
<example id="zend.controller.actionhelper.viewrenderer.basicusage.example-3">
<title>Choix d'un script de vue différent</title>
<para>
Il peut arriver que vous éprouviez le besoin de rendre un script de vue
différent de celui correspondant à l'action en cours de distribution. Par exemple,
un contrôleur qui possède deux actions ajout et édition, qui sont susceptibles
toutes les deux de rendre le même script de vue. Utilisez alors
<methodname>setScriptAction()</methodname>, <methodname>setRender()</methodname>,
ou appelez directement l'aide ViewRenderer qui invoquera
<methodname>setRender()</methodname> :
</para>
<programlisting language="php"><![CDATA[
// Bar controller class, foo module :
class Foo_BarController extends Zend_Controller_Action
{
public function addAction()
{
// Rend 'bar/form.phtml' plutôt que 'bar/add.phtml'
$this->_helper->viewRenderer('form');
}
public function editAction()
{
// Rend 'bar/form.phtml' au lieu de 'bar/edit.phtml'
$this->_helper->viewRenderer->setScriptAction('form');
}
public function processAction()
{
// un peu de validation...
if (!$valid) {
// Rend 'bar/form.phtml' à la place de 'bar/process.phtml'
$this->_helper->viewRenderer->setRender('form');
return;
}
// continue le processus...
}
}
]]></programlisting>
</example>
<example id="zend.controller.actionhelper.viewrenderer.basicusage.example-4">
<title>Modification de l'objet de vue</title>
<para>
Si vous désirez modifier l'objet de vue absorbé par
<code>ViewRenderer</code>, pour par exemple ajouter un chemin vers des aides
spécifique, ou spécifier l'encodage, vous pourriez par exemple récupérer l'objet de
vue depuis le <emphasis>ViewRenderer</emphasis>, ou dans un contrôleur.
</para>
<programlisting language="php"><![CDATA[
// Bar controller class, foo module :
class Foo_BarController extends Zend_Controller_Action
{
public function preDispatch()
{
// change l'encodage de la vue
$this->view->setEncoding('UTF-8');
}
public function bazAction()
{
// Récupère l'objet de vue, et lui passe la fonction
// d'2chappement 'htmlspecialchars'
$view = $this->_helper->viewRenderer->view;
$view->setEscape('htmlspecialchars');
}
}
]]></programlisting>
</example>
</sect4>
<sect4 id="zend.controller.actionhelper.viewrenderer.advancedusage">
<title>Utilisation avancée</title>
<example id="zend.controller.actionhelper.viewrenderer.advancedusage.example-1">
<title>Changement des spécifications de dossier</title>
<para>
Dans certains cas, il peut être nécessaire d'utiliser un chemin absolu, fixe.
Par exemple si vous ne donnez accès à vos graphistes qu'à un seul dossier, en
utilisant un moteur de template tel que
<ulink url="http://smarty.php.net/">Smarty</ulink>.
</para>
<para>
Pour ceci, imaginons que le base path soit fixé à
"<filename>/opt/vendor/templates</filename>", et
que vous voulez que vos scripts de vues soit référencés par
"<filename>:moduleDir/:controller/:action.:suffix</filename>"; si le paramètre
<emphasis>noController</emphasis> est activé, vous désirez utiliser le dossier
plus haut "<filename>:action.:suffix</filename>". Enfin,
vous désirez un suffixe en "tpl" :
</para>
<programlisting language="php"><![CDATA[
/**
* Dans le fichier de démarrage :
*/
// Une implémentation personnalisée de la vue
$view = new ZF_Smarty();
$viewRenderer = new Zend_Controller_Action_Helper_ViewRenderer($view);
$viewRenderer->setViewBasePathSpec('/opt/vendor/templates')
->setViewScriptPathSpec(':module/:controller/:action.:suffix')
->setViewScriptPathNoControllerSpec(':action.:suffix')
->setViewSuffix('tpl');
Zend_Controller_Action_HelperBroker::addHelper($viewRenderer);
]]></programlisting>
</example>
<example id="zend.controller.actionhelper.viewrenderer.advancedusage.example-2">
<title>Rendu de plusieurs scripts de vue dans une même action</title>
<para>
Afin de rendre plusieurs scripts de vue dans une même action, appelez tout
simplement plusieurs fois <methodname>render()</methodname> :
</para>
<programlisting language="php"><![CDATA[
class SearchController extends Zend_Controller_Action
{
public function resultsAction()
{
// Considérons $this->model comme étant un modèle valide
$this->view->results = $this->model
->find($this->_getParam('query', '');
// render() est proxiée vers ViewRenderer
// Rend d'abord un formulaire, puis un résultat
$this->render('form');
$this->render('results');
}
public function formAction()
{
// Rien : ViewRenderer rend automatiquement un script de vue
}
}
]]></programlisting>
</example>
</sect4>
</sect3>
|