Ralf Eggert. Zend Framework 2. Das Praxisbuch

Transkript

1 Ralf Eggert Zend Framework 2 Das Praxisbuch

2 7.4 Ein Anwendungsmodul entwickeln Weitere Konfigurationen Der Modul-Manager ermöglicht auch die Konfiguration weiterer Elemente, für die entsprechende Konfigurationsschlüssel für den Einsatz in der module.config.php und Interfaces für die Implementierung in der Module.php verwendet werden können. Eigene Validatoren können mit dem Konfigurationsschlüssel validators konfiguriert oder durch die Implementation des ValidatorProviderInterface bereitgestellt werden. Eigene Filter können mit dem Konfigurationsschlüssel filters konfiguriert oder durch die Implementation des FilterProviderInterface bereitgestellt werden. Eigene Formularelemente können mit dem Konfigurationsschlüssel form_elements konfiguriert oder durch die Implementation des FormElementProviderInterface bereitgestellt werden. 7 Eigene Route-Typen können mit dem Konfigurationsschlüssel route_manager konfiguriert oder durch die Implementation des RouteProviderInterface bereitgestellt werden. Eigene Serializer-Adapter können mit dem Konfigurationsschlüssel serializers konfiguriert oder durch die Implementation des SerializerProviderInterface bereitgestellt werden. Eigene Hydratoren können mit dem Konfigurationsschlüssel hydrators konfiguriert oder durch die Implementation des HydratorProviderInterface bereitgestellt werden. Eigene InputFilter können mit dem Konfigurationsschlüssel input_filters konfiguriert oder durch die Implementation des InputFilterProviderInterface bereitgestellt werden. 7.4 Ein Anwendungsmodul entwickeln Wir werden ein Anwendungsmodul entwickeln, um die Grundlagen des Modul- Managers zu vertiefen. Statt eines langweiligen»hallo Welt«-Moduls entwickeln wir ein cooles»hallo Pizza«-Modul. In dem Beispielprojekt zu diesem Kapitel sind die Voraussetzungen in Form einer Verzeichnisstruktur unter /module/pizza bereits geschaffen. Bevor Sie anfangen, testen Sie kurz, ob beim Aufruf von die Anwendung in Ihrem Browser angezeigt wird. Falls nicht, richten Sie das Projekt für Kapitel 7 ein (siehe Anhang A,»Installation der Projektdateien«). 169

3 8.7 Controller-Plugins return $this->redirect()->toroute( 'pizza/action', $params, true $form = $this->getpizzaservice()->getcreateform( return array( 'form' => $form, 8 Listing 8.30 Beispiel für den Einsatz des»postredirectget«-plugins Zuerst wird in der createaction()-methode das»postredirectget«-plugin aufgerufen und die URL übergeben. Danach wird geprüft, ob das»postredirectget«-plugin eine Instanz von Zend\Http\Response zurückgegeben hat. Falls ja, kann die Weiterleitung ausgeführt werden. Als Nächstes wird geprüft, ob das»postredirectget«-plugin nicht false zurückgegeben hat. In diesem Fall wird die neue Pizza angelegt, um bei Erfolg auf die Änderungsseite umzuleiten. War das Anlegen der Pizza erfolglos bzw. wurde vom»postredirectget«-plugin false zurückgegeben, wird das Formular zum Erstellen einer Pizza aus dem Pizza-Service geholt und an den View übergeben. Die if-elseif-struktur kann so umgeschrieben werden, dass die Rückgabe der Daten als Array geprüft wird. Sie können alternativ die Reihenfolge der Bedingungen ändern. Wie Sie die Abfragen umsetzen, bleibt Ihnen überlassen. Sie müssen nur die drei verschiedenen Rückgabefälle (siehe oben) im Kopf behalten. Natürlich sind Sie nicht gezwungen, das»postredirectget«-plugin einzusetzen Das»FilePostRedirectGet«-Plugin Möchten Sie Dateien hochladen, hilft Ihnen das»postredirectget«-plugin nicht weiter, da die hochgeladenen Dateien nach dem Redirect nicht mehr zur Verfügung stehen. Nicht verschobene Dateiuploads werden von PHP nach dem Ende eines Requests automatisch gelöscht. Zur Lösung dieses Problems steht Ihnen das»filepostredirectget«-plugin zur Verfügung. Die hochgeladenen Dateien und die weiteren Formulardaten werden in einer Session gespeichert und stehen nach dem Redirect dann zur Weiterverarbeitung bereit. 231

4 8 MVC-Komponenten Listing 8.31 zeigt den Einsatz des»filepostredirectget«-plugins. Das Beispiel setzt voraus, dass ein Model-Service über getpizzaservice() erreichbar ist, der die Methoden upload() und getuploadform() implementiert. namespace Pizza\Controller; use Pizza\Service\PizzaService; use Zend\Http\Response; use Zend\Mvc\Controller\AbstractActionController; use Zend\View\Model\ViewModel; class IndexController extends AbstractActionController [...] public function uploadaction() $form = $this->getpizzaservice()->getuploadform( $prg = $this->fileprg($form if ($prg instanceof Response) return $prg; elseif ($prg!== false) $pizza = $this->getpizzaservice()->upload($prg if ($pizza) $params = array('action' => 'upload', 'id' => $pizza->getid() return $this->redirect()->toroute('pizza/action', $params return array( 'form' => $form, Listing 8.31 Beispiel für den Einsatz des»filepostredirectget«-plugins Der große Unterschied zum»postredirectget«-plugin ist, dass keine URL, sondern ein Formularobjekt übergeben werden muss. Ansonsten ist die Vorgehensweise die- 232

5 8.7 Controller-Plugins selbe. In Abschnitt 18.6,»Bild-Upload einrichten«, finden Sie ein praktisches Beispiel für den Einsatz des»filepostredirectget«-plugin Das»FlashMessenger«-Plugin Das»FlashMessenger«-Plugin speichert Nachrichten in einer Session, um sie nach einer Umleitung zurückgeben zu können. Wenn Sie einen neuen Datensatz speichern, möchten Sie vielleicht nach der Umleitung auf der Änderungsseite eine Erfolgsmeldung ausgeben, die Sie vor der Umleitung festlegen. Listing 8.32 zeigt einen Action-Controller, der das»flashmessenger«-plugin einsetzt. In der sendaction()-methode wird dem FlashMessenger eine Nachricht hinzugefügt. Nach der Weiterleitung wird der FlashMessenger daraufhin geprüft, ob Nachrichten vorhanden sind. Falls ja, werden diese an den View übergeben. Sie sollten beachten, dass von getmessages() immer ein Array zurückgegeben wird. 8 namespace Pizza\Controller; use Zend\Mvc\Controller\AbstractActionController; use Zend\View\Model\ViewModel; class IndexController extends AbstractActionController public function sendaction() $this->flashmessenger()->addmessage( 'Die Pizza wurde versandt.' return $this->redirect()->tourl('/pizza/ordered' public function orderedaction() if ($this->flashmessenger()->hasmessages()) return array( 'messages' => $this->flashmessenger()->getmessages() Listing 8.32 Beispiel für den Einsatz des»flashmessenger«-plugins 233

6 10 Datenbank-Komponenten Abfragen mit DDL generieren Mit dem 2.2 Release vom Zend Framework wurde die Unterstützung für die Data Definition Language (DDL) eingeführt. Damit können SQL Abfragen zum Anlegen. Ändern und Löschen von Datenbanktabellen objektorientiert erstellt werden. In Listing werden zuerst einige Spalten sowie ein Primärschlüssel angelegt. Danach wird die Tabelle orders nacheinander angelegt, geändert und am Ende wieder gelöscht. Die generierten SQL-Abfragen werden am Ende des Listings ausgegeben. Diese SQL-Strings können somit problemlos an die query() Methode des Datenbankadapters übergeben werden, um sie auszuführen. use Zend\Debug\Debug; use Zend\Db\Adapter\Adapter; use Zend\Db\Sql\Ddl\Column\Char; use Zend\Db\Sql\Ddl\Column\Date; use Zend\Db\Sql\Ddl\Column\Float; use Zend\Db\Sql\Ddl\Column\Integer; use Zend\Db\Sql\Ddl\Column\Varchar; use Zend\Db\Sql\Ddl\Constraint\PrimaryKey; use Zend\Db\Sql\Ddl\AlterTable; use Zend\Db\Sql\Ddl\CreateTable; use Zend\Db\Sql\Ddl\DropTable; $db = new Adapter(array( 'driver' => 'Pdo_Sqlite', 'database' => LUIGI_ROOT. '/data/db/pizza.sqlite3.db', ) $columnid = new Integer('id' $columndate = new Date('created' $columnsum = new Float('sum', 6, 2 $columncode = new Char('code', 3 $columnname = new Varchar('name', 64 $primary = new PrimaryKey('id' $create = new CreateTable('orders' $create->addcolumn($columnid $create->addcolumn($columndate $create->addcolumn($columnsum $create->addcolumn($columncode $alter = new AlterTable('orders' $alter->addcolumn($columnname 270

7 10.4 Gateway-Klassen $alter->addconstraint($primary $alter->dropcolumn('code' $drop = new DropTable('orders' Debug::dump($create->getSqlString() Debug::dump($alter->getSqlString() Debug::dump($drop->getSqlString() Listing Tabellen anlegen, ändern und löschen mit Zend\Db\Sql\Ddl generieren Die generierten SQL-Strings zum Anlegen, Ändern und Löschen der Datenbanktabelle orders sehen wie folgt aus: CREATE TABLE "orders" ( "id" INTEGER NOT NULL, "created" DATE NOT NULL, "sum" DECIMAL(6, 2) NOT NULL, "code" CHAR(3) NOT NULL ) 10 ALTER TABLE "orders" ADD COLUMN "name" VARCHAR(64) NOT NULL, DROP COLUMN "code", ADD PRIMARY KEY ("id") DROP TABLE "orders" Die Unterstützung der DDL wurde für MySQL und ANSI SQL-92 bereitgestellt, weitere Datenbanken sollen in Zukunft zusätzlich unterstützt werden Gateway-Klassen Zend\Db bietet zwei Gateway-Klassen für die Arbeit mit Tabellen und Tabellenzeilen. Das TableGateway repräsentiert eine ganze Tabelle, während das RowGateway eine Tabellenzeile darstellt. Sie können die Klassen allein und in Kombination verwenden Zend\Db\TableGateway Für Zend\Db\TableGateway gibt es zwei Varianten. AbstractTableGateway stellt alle Funktionen bereit. TableGateway erweitert AbstractTableGateway und konfiguriert das TableGateway-Objekt. In den meisten Fällen ist es ausreichend, wenn Sie Table- 271

8 12 Formularverarbeitung Diese Klasse lässt sich im Service-Manager als Invokable einrichten, um das Objekt in einem Formular oder Ihrer Modelinfrastruktur verwenden zu können Hierarchische InputFilter Sie können auch hierarchische InputFilter-Klassen aufbauen, die z. B. für den Einsatz von Fieldsets in Formularen verwendet werden können (siehe Abschnitt ,»Fieldsets«). In Listing 12.5 ist ein Input-Filter für einige Datenfelder dargestellt. Die Definition erfolgt hier programmatisch innerhalb des Konstruktors der Klasse. namespace Pizza\InputFilter; use Zend\InputFilter\InputFilter; use Zend\InputFilter\Input; class PizzaDataInputFilter extends InputFilter public function construct() $name = new Input('pizza_name' $name->getfilterchain()->attachbyname('stringtrim' $name->getvalidatorchain()->attachbyname('stringlength', array( 'max' => 32 ) $name->getvalidatorchain()->attachbyname('alpha', array( 'allowwhitespace' => true ) $price = new Input('pizza_price' $price->getfilterchain()->attachbyname('numberformat' $price->getvalidatorchain()->attachbyname('float' $category = new Input('pizza_category' $category->getvalidatorchain()->attachbyname('inarray', array( 'haystack' => array(1, 2, 3) ) $this->add($name $this->add($price $this->add($category Listing 12.5 Untergeordneter Input-Filter für Pizzadaten 320

9 12.1 Zend\InputFilter Der PizzaDataInputFilter kann nun wiederum in einen übergeordneten Input-Filter eingesetzt werden, wie die Klasse HierarchicalInputFilter in Listing 12.6 zeigt. Dabei wird eine Instanz von PizzaDataInputFilter an die add()-methode übergeben und bekommt den Bezeichner pizza_data zugeteilt. namespace Pizza\InputFilter; use Zend\InputFilter\InputFilter; class HierarchicalInputFilter extends InputFilter public function construct() $this->add(new PizzaDataInputFilter(), 'pizza_data' Listing 12.6 Übergeordneter Input-Filter verwendet»pizzadatainputfilter«. 12 In Listing 12.7 sehen Sie den Einsatz des HierarchicalInputFilter. Das Besondere daran ist die Definition der zu filternden Daten. Diese spiegeln die Hierarchie des Input-Filters wider, wobei auch der Bezeichner pizza_data zum Einsatz kommt. Der Rest des Scripts zeigt dann keine Besonderheiten. Wenn Sie es ausprobieren, wird die Hierarchie bei der Ausgabe der Fehlermeldungen und verarbeiteten Daten ebenfalls dargestellt. use Zend\Debug\Debug; use Pizza\InputFilter\HierarchicalInputFilter; $validdata = array( 'pizza_data' => array( 'pizza_name' => ' Pizza Salami ', 'pizza_price' => 6.95, 'pizza_category' => '1', ), $invaliddata = array( 'pizza_data' => array( 'pizza_name' => 'Pizza 123 ', 'pizza_price' => ' 6.95', 'pizza_category' => '1a', ), 321

10 12 Formularverarbeitung $inputfilter = new HierarchicalInputFilter( $inputfilter->setdata($validdata Debug::dump($inputFilter->isValid() Debug::dump($inputFilter->getValues() Debug::dump($inputFilter->getMessages() $inputfilter->setdata($invaliddata Debug::dump($inputFilter->isValid() Debug::dump($inputFilter->getValues() Debug::dump($inputFilter->getMessages() Listing 12.7 Einsatz des»hierarchicalinputfilter«wie Sie den hierarchischen Input-Filter für die Validierung eines Formulars verwenden, können Sie in Abschnitt ,»Validierung von Formularen«, nachlesen InputFilter im MVC Mit dem Release wurden mehrere Plugin-Manager für Filter, Validatoren und InputFilter eingeführt. Damit lassen sich eigene Filter und Validatoren leichter in den InputFilter-Instanzen einsetzen, als es vorher der Fall war. In Teil III werden einige eigene Filter verwendet, die in den InputFilter-Instanzen der Kapitel zum Einsatz kommen. Wie Sie Ihre Module in einer MVC-Anwendung konfigurieren können, erfahren Sie in Abschnitt 15.9,»Eigene Filter«, sowie in Abschnitt 16.4,»Filter und Formulare« Zend\Form Für die Erstellung von Formularen stellt das ZF2 die Komponente Zend\Form zur Verfügung. Wer vom ZF1 kommt, wird sich zuerst sicher wundern, dass die Dekorierer komplett entfallen sind. Die Ausgabe wurde von Zend\Form entkoppelt und in mehrere View-Helper ausgelagert. Details zu Zend\Form finden Sie im Referenzhandbuch unter 322