Controller Skripte

View Scripte

Sobald dein Controller die Variablen übergeben und die render() Methode aufgerufen hat, inkludiert Zend_View das angeforderte View Skript und führt es "innerhalb" des Gültigkeitsbereichs der Zend_View Instanz aus. Deshalb weisen Referenzen auf $this in deinem View Skript auf die Zend_View Instanz selber.

Auf Variablen, die vom Controller an den View übergeben worden sind, kann als Eigenschaften der Instanz zurückgegriffen werden. Wenn der Controller zum Beispiel eine Variable 'irgendwas' übergeben hat, würdest du in deinem View Skript über $this->irgendwas darauf zugreifen können. (Dies erlaubt es dir, den Überblick darüber zu behalten, welche Variablen an das Skript übergeben worden sind und welche Variablen intern zum Skript selber gehören.)

Zur Erinnerung hier noch einmal das Beispiel View Skript aus der Zend_View Einführung.

  1. span style="color: #ff0000;">'author''title'

Ausgaben maskieren

Eine der wichtigsten Aufgaben, die in einem View Skript zu erledigen sind, ist es sicherzustellen, dass die Ausgaben auch richtig maskiert sind; neben anderen Dingen hilft dies auch Cross-Site Scripting Attacken zu vermeiden. Sofern du keine Funktion, Methode oder einen Helfer verwendest, der die Maskierungen selber durchführt, solltest Du Variablen immer maskieren, wenn du sie ausgeben möchtest.

Zend_View stellt eine Methode escape() bereit, die das Maskieren für dich übernimmt.

  1. // schlechte View Skript Praxis:
  2. // gute View Skript Praxis:

Standardmäßig verwendet escape() die PHP htmlspecialchars() Funktion für die Maskierung. Allerdings könntest du abhängig von deiner Umgebung den Wunsch haben, die Maskierung anders durchzuführen. Verwende die setEscape() Methode auf der Controller Ebene, um Zend_View mitzuteilen, welche Maskierungsmöglichkeit als Callback verwendet werden soll.

  1. // erstelle eine Zend_View Instanz
  2. // teile ihr mit, dass htmlentities für die Maskierung
  3. // verwendet werden soll
  4. $view->setEscape('htmlentities');
  5.  
  6. // oder teile ihr mit, eine statische Klassenmethode für
  7. // die Maskierung zu verwenden
  8. 'SomeClass', 'methodName'));
  9.  
  10. // sogar Instanzmethoden sind möglich
  11. 'methodName'));
  12.  
  13. // und dann erstelle die Ausgabe

Diese Callback Funktion oder Methode sollte den zu maskierenden Wert als ersten Parameter übernehmen und alle anderen Parameter sollten optional sein.

Verwendung alternativer Templatesysteme

Obwohl PHP selber eine mächtiges Templatesystem ist, haben viele Entwickler das Gefühl, dass es zu mächtig oder komplex für die Template Designer ist und möchten ein alternatives Templatesystem verwenden. Zend_View stellt zwei Mechanismen bereit, um dies zu realisieren, die erste durch Viewskripte und die zweite durch Implementierung von Zend_View_Interface.

Template Systeme die View Scripte verwenden

Ein Viewskript kann verwendet werden, um ein separats Templateobjekt zu instanzieren und anzupassen, z.B. für eine PHPLIB-style Template. Das Viewskript für solch eine Aufgabe könnte so aussehen:

  1. span style="color: #ff0000;">'template.inc'"booklist" => "booklist.tpl",
  2.         "eachbook" => "eachbook.tpl"'author', $this->escape($val['author''title', $this->escape($val['title']);
  3.         $tpl->parse("books", "eachbook""output", "booklist""nobooks", "nobooks.tpl")
  4.     $tpl->pparse("output", "nobooks");
  5. }

Dies wären die zugehörigen Template Dateien:

  1. <!-- booklist.tpl -->
  2. <table>
  3.     <tr>
  4.         <th>Autor</th>
  5.         <th>Titel</th>
  6.     </tr>
  7.     {books}
  8. </table>
  9.  
  10. <!-- eachbook.tpl -->
  11.     <tr>
  12.         <td>{author}</td>
  13.         <td>{title}</td>
  14.     </tr>
  15.  
  16. <!-- nobooks.tpl -->
  17. <p>Es gibt keine Bücher zum Anzeigen.</p>

Ein Templatesystem mit Hilfe von Zend_View_Interface verwenden

Manche finden es einfacher, ein Zend_View kompatibles Templatesystem zu verwenden. Zend_View_Interface definiert die minimale Schnittstelle, die zur Kompatibilität benötigt wird.

  1. /**
  2. * Gebe das aktuelle Template Engine Objekt zurück
  3. *//**
  4. * Setze den Pfad zu den Viewskripten / Templates
  5. *//**
  6. * Setze den Pfad zu allen View Ressourcen
  7. */'Zend_View');
  8.  
  9. /**
  10. * Füge einen zusätzlichen Basispfad den View ressourcen hinzu
  11. */'Zend_View');
  12.  
  13. /**
  14. * Empfange die aktuellen Skript Pfade
  15. *//**
  16. * Überladungsmethoden zum Zuordnen von Templatevariablen
  17. * als Objekteigenschaften
  18. *//**
  19. * Manuelle Zuweisung von Templatevariablen oder die Möglichkeit,
  20. * mehrere Variablen in einem Durchgang zuzuordnen.
  21. *//**
  22. * Alle zugewiesenen Templatevariablen zurücksetzen
  23. *//**
  24. * Rendern des Templates mit dem Namen $name
  25. */

Durch Verwendung dieses Interfaces ist es relativ einfach, das Templatesystem eines Dritten in eine Zend_View kompatible Klasse zu umhüllen. Als Beispiel folgt ein möglicher Wrapper für Smarty:

  1. span style="color: #808080; font-style: italic;">/**
  2.      * Smarty object
  3.      * @var Smarty
  4.      *//**
  5.      * Constructor
  6.      *
  7.      * @param string $tmplPath
  8.      * @param array $extraParams
  9.      * @return void
  10.      *//**
  11.      * Gebe das aktuelle Template Engine Objekt zurück
  12.      *
  13.      * @return Smarty
  14.      *//**
  15.      * Setze den Pfad zu den Templates
  16.      *
  17.      * @param string $path Das Verzeichnis, das als Pfad gesetzt werden soll.
  18.      * @return void
  19.      */'Invalid path provided');
  20.     }
  21.  
  22.     /**
  23.      * Empfange das aktuelle template Verzeichnis
  24.      *
  25.      * @return string
  26.      *//**
  27.      * Alias für setScriptPath
  28.      *
  29.      * @param string $path
  30.      * @param string $prefix nicht verwendet
  31.      * @return void
  32.      */'Zend_View'/**
  33.      * Alias für setScriptPath
  34.      *
  35.      * @param string $path
  36.      * @param string $prefix nicht verwendet
  37.      * @return void
  38.      */'Zend_View'/**
  39.      * Weise dem Template eine Variable zu
  40.      *
  41.      * @param string $key der Variablenname.
  42.      * @param mixed $val der Variablenwert.
  43.      * @return void
  44.      *//**
  45.      * Erlaubt das Testen von empty() und isset()
  46.      *
  47.      * @param string $key
  48.      * @return boolean
  49.      *//**
  50.      * Erlaubt das Zurücksetzen von Objekteigenschaften
  51.      *
  52.      * @param string $key
  53.      * @return void
  54.      *//**
  55.      * Weise dem Template Variablen zu
  56.      *
  57.      * Erlaubt das Zuweisen eines bestimmten Wertes zu einem bestimmten
  58.      * Schlüssel, ODER die Übergabe eines Array mit Schlüssel => Wert
  59.      * Paaren zum Setzen in einem Rutsch.
  60.      *
  61.      * @see __set()
  62.      * @param string|array $spec Die zu verwendene Zuweisungsstrategie
  63.      * (Schlüssel oder Array mit Schlüssel => Wert paaren)
  64.      * @param mixed $value (Optional) Wenn ein Variablenname verwendet wurde,
  65.      *                                verwende diesen als Wert
  66.      * @return void
  67.      *//**
  68.      * Setze alle zugewiesenen Variablen zurück.
  69.      *
  70.      * Setzt alle Variablen zurück, die Zend_View entweder durch
  71.      * {@link assign()} oder Überladen von Eigenschaften
  72.      * ({@link __get()}/{@link __set()}) zugewiesen worden sind.
  73.      *
  74.      * @return void
  75.      *//**
  76.      * Verarbeitet ein Template und gibt die Ausgabe zurück
  77.      *
  78.      * @param string $name Das zu verarbeitende Template
  79.      * @return string Die Ausgabe.
  80.      */

In diesem Beispiel kannst du die Zend_View_Smarty anstelle von Zend_View instanzieren und es dann ungefähr wie Zend_View verwenden:

  1. // Beispiel 1. In initView() des Initialisers.
  2. '/Pfad/der/Templates''ViewRenderer'':controller/:action.:suffix')
  3.              ->setViewScriptPathNoControllerSpec(':action.:suffix')
  4.              ->setViewSuffix('tpl');
  5.  
  6. // Beispiel 2. Die Verwendung im Action Controller bleibt die gleiche...
  7. 'Zend PHP 5 Zertifizierungs Study Guide';
  8.         $this->view->author = 'Davey Shafik und Ben Ramsey'
  9.     }
  10. }
  11.  
  12. // Beispiel 3. Initialisierung der View im Action Controller
  13. '/path/to/templates''viewRenderer'':controller/:action.:suffix')
  14.                      ->setViewScriptPathNoControllerSpec(':action.:suffix')
  15.                      ->setViewSuffix('tpl');
  16.     }
  17. }

Controller Skripte