Začínáme se Zend Framework 1.5

15.6.2011 – Vyšel aktualizovaný překlad od Martina Hujera – Začínáme se Zend Frameworkem

Před necelým rokem jsem tu zveřejnil překlad skvělého tutoriálu na Zend Framework 1.0 od Rob Allen – Začínáme se Zend Framework 1.0 (originál). Nicméně vývoj Zend Framework se naštěstí nezastavil a k dispozici je ve verzi 1.5. Přináším vám tedy aktualizovanou verzi překladu.

Co je nového?

Tak tuhle otázku si položí asi každý, kdo už pracoval s předchozí verzí tutoriálu. Rob Allen se v nové revizi zaměřil na nové komponenty Zend_Layout a Zend_Form. Asi nemá cenu komponenty blíže představovat, protože to za mě udělali jiní – Zend_Layout a Zend_Form .

Tak a teď už vzhůru k tvorbě aplikace pro Zend Framework 1.5!

Originál je pouze jeden a ten najdete: Getting Started with the Zend Framework 1.5.

Verze	Zend Framework	Poslední aktualizace
1.5.2	1.5 a novější	2.6.2008

Tento tutoriál byl vytvořen proto, aby vám poskytl základní představu o použití Zend Framework (dále pod slovem framework je automaticky myšleno Zend Framework není-li uvedeno jinak). Jeho využití si budeme demonstrovat na základní aplikaci využívající databázi.

Tento tutoriál byl vytvořen a otestován na Zend Frameworku ve verzi 1.5. Na nižší verzi nebude fungovat.

MVC (Model-View-Controller) architektura aplikace

Tradiční způsob tvorby PHP aplikací je asi takový:

<?php
include "common-libs.php";
include "config.php";
mysql_connect($hostname, $username, $password);
mysql_select_db($database);
?>

<?php include "header.php"; ?>
<h1>Home Page</h1>

<?php
$sql = "SELECT * FROM news";
$result = mysql_query($sql);
?>
<table>
<?php
while ($row = mysql_fetch_assoc($result)) {
?>
<tr>
    <td><?php echo $row['date_created']; ?></td>
    <td><?php echo $row['title']; ?></td>
</tr>
<?php
}
?>
</table>
<?php include "footer.php"; ?>

Během vývoje aplikace ale zjistíme, že tento postup je neefektivní, pokud provádíme nějaké změny. Tyto změny musí být provedeny napříč celou aplikací.

Jednou z možností, jak si vývoj aplikace usnadnit je rozdělit kód na stránce do 3 různých částí (a většinou i samostatných souborů):

Model	Model je část aplikace, která je zodpovědná za výběr dat, která budou zobrazena. Na příkladu uvedeném o pář řádku výše by se jednalo o výběr novinek z databáze a jejich uložení do pole.
View	View se stará o způsob, jakým jsou data prezentována uživateli. Nejčastěji se tedy jedná o HTML.
Controller	Controller se stará o vytvoření modelu a zároveň volá správný view.

Zend Framework využívá MVC (Model-View-Controller) architekturu. Ta se používá pro oddělení rozdílných částí aplikace a tím také snažší vývoj a údržbu.

Požadavky

Zend Framework požaduje:

• PHP 5.1.4 (a novější)
• Webový server podporující mod_rewrite. V tomto tutoriálu je použit Apache.

Předpoklady pro úspěšné fungování vaší aplikace

Při psání tutoriálu jsem vycházel z toho, že aplikaci spouštíte na serveru, kde běží minimálně PHP 5.1.4 spolu s webovým serverem Apache. Poslední dobou se množí dotazy, že vám funguje pouze hlavní stránka aplikace. Zkontrolujte, zda máte aktivováno mod_rewrite pod Apache. Dále tento problém může být způsoben tím, že nemáte povoleno použití souboru .htaccess.

Podívejte se do souboru httpd.conf, jestli direktivita AllowOverride je nastavena na All.

Začínáme se Zend Framework

Zend Framework si můžete stáhnout ze stránek http://framework.zend.com/download ve formátu .zip nebo .tar.gz.

Adresářová struktura

Zend Framework vám nenařizuje striktně používat jednotnou strukturu aplikace, ale je doporučené držet se navrhované struktury v manuálu. Budeme tedy vycházet z dané struktury, která počítá s tím, že máte plnou kontrolu nad Apache serverem a můžete aplikaci umístit mimo web root adresář.

Začneme vytvořením adresáře zf-tutorial v kořenovém adresáři webového serveru (Apache). To znamená, že URL námi vytvořené aplikace bude dostupné na adrese http://localhost/zf-tutorial.

Vytvořte následující podadresáře:

zf-tutorial/
   /application
      /controllers
      /models
      /views
         /filters
         /helpers
         /scripts
   /library
   /public
      /css
      /images
      /js

Jak vidíte, vytvořili jsme rozdílné adresáře pro model, view a controller soubory naší aplikace. Podporované obrázky, skripty a CSS soubory jsou uloženy ve zvláštních adresářích ve složce public. Soubory Zend Framework budou uloženy v adresáři library. Pokud budeme potřebovat nějaké další knihovny, je vhodné umístit je do složky library. Důležité je si uvědomit, že hlavní stránka naší aplikace se bude nacházet na adrese http://localhost/…rial/public/ a je vhodné tedy zamezit přístup přes web do ostatních složek kvůli bezpečnosti.

Rozbalte soubory z archivu ZendFramework-1.5.0.zip do dočasné složky. Všechny soubory jsou umístěny v podadresáři ZendFramework-1.5.0. Zkopírujte obsah adresáře library/Zend do zf-tutorial/library/. V adresáři zf-tutorial/library/ tedy budete mít podadresář Zend.

Bootstrap

Zend Framework a jeho controller Zend_Controller byl vytvořen tak, aby podporoval hezká URL. Pokud tohoto chcete dosáhnout, musí jít veškeré požadavky na aplikaci přes soubor index.php, kterému se říká bootstrap soubor. Veškeré požadavky tedy budou přesměrovány na tento soubor pomocí souboru .htaccess v adresáři zf-tutorial/public:

zf-tutorial/public/.htaccess

# Rewrite rules for Zend Framework
RewriteEngine on
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule .* index.php

# Security: Don't allow browsing of directories
Options -Indexes

# PHP settings
php_flag magic_quotes_gpc off
php_flag register_globals off
php_flag short_open_tag on

Pravidlo RewriteRule je velmi jednoduché a slovně ho lze vyjádřit „vezmi jakoukoliv URL a přesměruj na index.php“.

Také definujeme několik PHP ini nastavení kvůli bezpečnosti. Tyto parametry jsou pravděpodobně již nastaveny, ale my se potřebujeme ujistit, že tomu skutečně tak je. Poznámka: php_flag nastavení v souboru .htaccess funguje pouze pokud používáte mod_php. Pokud používáte CGI/FastCGI, budete muset nastavení provést v konfiguračním souboru php.ini.

Bootstrap soubor: index.php

zf-tutorial/public/index.php je náš bootstrap soubor a my nyní začneme s následujícím kódem:

zf-tutorial/public/index.php

<?php

error_reporting(E_ALL|E_STRICT);
ini_set('display_errors', 1);
date_default_timezone_set('Europe/London');

// directory setup and class loading
set_include_path('.' . PATH_SEPARATOR . '../library/'
     . PATH_SEPARATOR . '../application/models'
     . PATH_SEPARATOR . get_include_path());
include "Zend/Loader.php";
Zend_Loader::registerAutoload();

// setup controller
$frontController = Zend_Controller_Front::getInstance();
$frontController->throwExceptions(true);
$frontController->setControllerDirectory('../application/controllers');

// run!
$frontController->dispatch();

Určitě jste si všimli, že na konci souboru chybí ?>. Uzavření není potřeba a dokážeme jejím vynecháním předejít mnoha složitě odhalitelných chyb pokud používáme přesměrování přes header() a na konci souboru se vyskytuje „prázdné místo“.

Pojďme si projít soubor index.php

error_reporting(E_ALL|E_STRICT);
date_default_timezone_set('Europe/London');

Tyto řádky slouží k tomu, že budeme informováni o všech chybách, které ať už úmyslně nebo neúmyslně vytvoříme (direktivita display_errors musí být nastavena na on v souboru php.ini). Také zvolíme naše časové pásmo, jak požaduje specifikace PHP 5.1+.

// directory setup and class loading
set_include_path('.' . PATH_SEPARATOR . '../library/'
     . PATH_SEPARATOR . '../application/models'
     . PATH_SEPARATOR . get_include_path());
include "Zend/Loader.php";
Zend_Loader::registerAutoload();

Zend Framework je koncipován tak, že cesty k jeho souborům musí být definovány v include_path. Pro usnadnění si do include_path přidáme i cestu k model, takže budou naše třídy později snadno dostupné. Jako první připojíme soubor Zend/Loader.php, který nám spřístupní třídu Zend_Loader. Pak můžeme použít její metodu registerAutoload() pro automatické nahrávání potřebných tříd.

// setup controller
$frontController = Zend_Controller_Front::getInstance();
$frontController->throwExceptions(true);
$frontController->setControllerDirectory('../application/controllers');

Protože se jedná pouze o ukázkovou aplikaci, nastavíme front controller tak, aby se zobrazovaly veškeré vyjímky. Defaultně front controller vyjímky zachytí a přesměruje je do ErrorController. To může být matoucí pro nováčky, proto raději zobrazíme všechny. Nicméně na produkčním serveru by uživatel nikdy neměl žádnou vyjímku spatřit!

Front controller používá třídu router pro analýzu URL a vytvoření cesty k funkci, která zobrazí správnou stránku. Aby mohla třída router správně analyzovat URL, musí vědět, která část URL vede k index.php a od tohoto místa začít. Za normálních okolností by měl Request object zjistit umístění souboru index.php sám. V některých případech je ale potřeba tuto cestu manuálně nastavit $frontController->setBaseUrl().

Nakonec se dostaneme k tomu hlavnímu – aplikaci spustíme:

// run!
$frontController->dispatch();

Pokud nyní načtete stránku http://localhost/…orial/public měla by se vám zobrazit tato chyba:

Fatal error: Uncaught exception 'Zend_Controller_Dispatcher_Exception' with
message 'Invalid controller specified (index)' in…

Tato chyba se nám zobrazuje z důvodu toho, že jsme ještě neprovedli veškeré potřebné nastavení aplikace. Nejdříve si ale popíšeme to, co bude naše aplikace vlastně dělat.

Co to vůbec vytváříme za aplikaci?

Naše aplikace bude fungovat jako jednoduchý organizér nějaké sbírky CD nebo DVD. Na hlavní stránce bude zobrazen obsah naší sbírky, a také možnost přidání, editace nebo smazání jednotlivých položek. Pro uložení dat o naší sbírce využijeme databázi, která bude obsahovat tabulku album s následující strukturou:

Sloupec	Typ	Nulový	Poznámka
id	Integer	Ne	Primary key, Autoincrement
artist	Varchar(100)	Ne
title	Varchar (100)	Ne

Jednotlivé stránky

Home page	Na hlavní stránce se zobrazí obsah naší sbírky spolu s odkazy na přidání, editaci nebo smazání jednotlivých položek.
Add New Album	Tato stránka bude obsahovat formulář pro přidání nového alba.
Edit Album	Tato stránka bude obsahovat formulář pro editaci alba.
Delete Album	Na této stránce potvrdíte, jestli opravdu chcete album smazat.

Umístění jednotlivých stránek

Ještě předtím než začneme vytvářet jednotlivé soubory, je důležité, aby jste pochopili, kde framework bude hledat vaše soubory a proč. Každá stránka se nazývá „action“ a actions jsou sdruženy do „controllers“. Když tedy budeme chtít zobrazit stránku http://localhost/…al/news/view tak pro nás controller bude news a action view. To nám umožňuje sdružovat podobné actions. Například controller news může mít action current, archived a view. Zend Framework a jeho MVC struktura také podporuje moduly, které nám pro změnu umožňují sdružovat controllers dohromady. Tato aplikace ale pro toto použítí není dostatečně rozsáhlá.

Zend Framework a jeho controller obsahuje speciální action nazvanou index která je použita jako výchozí. To znamená, že pro URL http://localhost/…torial/news/ je controller news a action index. Jak už možná tušíte, Zend Framework obsahuje i výchozí controller, který je opět nazvaný index. Pokud tedy zadáte URL http://localhost/zf-tutorial/ jako controller se použije index a jako action také index. Je doporučeno defaultní controller nebo action vynechávat.

Protože se jedná o základní tutoriál, nebudeme u aplikace zacházet do takových detailů, jako je přihlašování a odhlašování uživatelů. Nicméně pokud vás to zajímá, pokračování tohoto tutoriálu se právě touto funkcí zabývá – Getting Started with Zend_Auth (pokud bude zájem, jsem ochoten přeložit)

Máme tedy čtyři stránky, které pracují s naší aplikací pro organizování CD. Bude tedy vhodné sdružit je do jediného controlleru a čtyř action. Použijeme výchozí controller index a následující actions:

Stránka	Controller	Action
Home page	Index	index
Add New Album	Index	add
Edit Album	Index	edit
Delete Album	Index	delete

Vidíte jak je to jednoduché 🙂

Nastavujeme Controller

V frameworku je controller třída a musí být nazvána {název Controlleru}Controller. {název Controlleru} musí začínat velkým písmenem. Tento controller musí být uložen v souboru nazvaném {název Controlleru}Controller.php uvnitř adresáře určeného pro controllery. Nezapomeňte na to, že první písmeno musí být velké a ostatní malá! Každá action je public function, kterou obsahuje třída controller. Akce musí být pojmenována {název action}Action. Pro název action používáme hned od začátku malá písmena.

Nyní již máme vytvořenou třídu IndexController, která je uložena v souboru zf-tutorial/application/controllers/IndexController.php:

zf-tutorial/application/controllers/IndexController.php

<?php

class IndexController extends Zend_Controller_Action
{
    function indexAction()
    {
    }

    function addAction()
    {
    }

    function editAction()
    {
    }

    function deleteAction()
    {
    }
}

Nyní jsme vytvořili čtyři akce, které zatím nebudou fungovat. Musíme jim definovat views.

URL pro jednotlivé akce jsou:

URL	Action
http://localhost/…rial/public/	IndexController::indexAction()
http://localhost/…ic/index/add	IndexController::addAction()
http://localhost/…c/index/edit	IndexController::editAction()
http://localhost/…index/delete	IndexController::deleteAction()

Nyní máme vytvořený funkční router a je čas na přípravu views.

Nastavujeme Views

Komponenta view frameworku je nazvána vcelku logicky Zend_View. Ta nám umožňuje oddělit kód, který se stará o zobrazení stránky (nejčastěji HTML) od kódu v příslušné action a tím aplikaci spřehlednit.

Základní použití Zend_View je následující:

$view = new Zend_View();
$view->setScriptPath('/path/to/view_files');
echo $view->render('viewScipt.php');

Tento kód bychom jednoduše mohli umístit do každé action, bylo by to ale zbytečné. Mnohem lepší je inicializovat třídu view někde jinde a v action jen přistupovat na objekt třídy view. Vývojáři Zend Framework to vyřešili tím, že vytvořili tzv. „action helper“.

Zend_Controller_Action_Helper_ViewRenderer se nám tedy postárá o inicializaci objektu view($this->view) a zároveň vygeneruje view skript. Dále nastaví objektu Zend_View cestu k view skriptu views/scripts/{controller name}. Tento se ve výchozím nastavení nachází views/scripts/{controller name}/{action_name}.phtml. Výsledný obsah stránky je přidán do objektu Response. Objekt Response sdružuje všechny HTTP hlavičky, obsah stránky a vyjímky vzniklé v důsledku použítí MVC. Front Controller poté automaticky pošle hlavičku a obsah body na konci dispatchingu.

Abychom si ověřili, že views fungují správně, vytvoříme si pro každý view samostatný soubor a dále v action specifický obsah.

Změníme soubor IndexController naslédovně:

zf-tutorial/application/controllers/IndexController.php

<?php

class IndexController extends Zend_Controller_Action
{
    function indexAction()
    {
        $this->view->title = "My Albums";
    }

    function addAction()
    {
        $this->view->title = "Add New Album";
    }

    function editAction()
    {
        $this->view->title = "Edit Album";
    }

    function deleteAction()
    {
        $this->view->title = "Delete Album";
    }
}

V každé funkci jsme přiřadili proměnnou title objektu view. Nezapomínejte na to, že tento text se zobrazí teprve až projde přes Front Controller na konci procesu nazvaném dispatching, který se volá až na úplném konci běhu aplikace.

Nyní potřebujeme vytvořit view soubory pro naší aplikaci. Tyto soubory můžeme také nazvat šablony. Metoda render() očekává, že šablony jsou pojmenovány podle přidružených action s koncovkou .phtml. Soubory musí být umístěny v podadresáři, který je pojmenován podle controlleru.

zf-tutorial/application/views/scripts/index/index.phtml

<html>
<head>
 <title><?php echo $this->escape($this->title); ?></title>
</head>
<body>
 <h1><?php echo $this->escape($this->title); ?></h1>
</body>
</html>

zf-tutorial/application/views/scripts/index/add.phtml

<html>
<head>
 <title><?php echo $this->escape($this->title); ?></title>
</head>
<body>
 <h1><?php echo $this->escape($this->title); ?></h1>
</body>
</html>

zf-tutorial/application/views/scripts/index/edit.phtml

<html>
<head>
 <title><?php echo $this->escape($this->title); ?></title>
</head>
<body>
 <h1><?php echo $this->escape($this->title); ?></h1>
</body>
</html>

zf-tutorial/application/views/scripts/index/delete.phtml

<html>
<head>
 <title><?php echo $this->escape($this->title); ?></title>
</head>
<body>
 <h1><?php echo $this->escape($this->title); ?></h1>
</body>
</html>

Pokud nyní otestujete jednotlivé URL vypsané výše v tabulce, měly by se zobrazit title definované v controlleru a k přidružené action.

Pár řádků HTML kódu

Je tedy jasné, že view obsahují velké množství HTML kódu. A co s tím provedeme? Nyní přichází na řadu NOVINKA v Zend Framework 1.5 a to komponenta Zend_Layout. Ta nám umožňuje umístit veškerý kód typický pro header a footer do layout view scriptu, který je pak přístupný specifickým actions.

Následující změny provedeme, aby jsme předchozí odstavec uplatnili v naší aplikaci. Jako první si musíme zvolit, kde se budou nacházet naše layout view scripty. V manuálu je doporučené vytvořit složku layouts v adresáři zf-tutorial/application, budeme se ho tedy držet.

Zároveň musíme komponentu Zend_Layout inicializovat v boostrap souboru. Doplníme tedy následující řádky do souboru public/index.php.

zf-tutorial/public/index.php

...
$frontController->throwExceptions(true);
$frontController->setControllerDirectory('../application/controllers');
Zend_Layout::startMvc(array('layoutPath'=>'../application/layouts'));

// run!
$frontController->dispatch();

Funkce startMvc() provede na pozadí několik změn ve front controller, aby správně fungovaly naše layout view scripty v adresáři zf-tutorial/application/layouts

Nyní už se dostáváme k vytvoření prvního layout view scriptu, který se defaultně jmenuje layout.phtml.

Vytvoříme si jej.

zf-tutorial/application/layouts/layout.phtml

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
    <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
    <title><?php echo $this->escape($this->title); ?></title>
</head>
<body>
<div id="content">
    <h1><?php echo $this->escape($this->title); ?></h1>
    <?php echo $this->layout()->content; ?>
</div>
</body>
</html>

Poznámka: Jelikož se nadpis <h1> vyskytuje na každé stránce na stejném místě, je vhodné umístit ho přímo sem. Abychom se ujistili, že se nadpis zobrazí správně, aplikujeme na něj view helper escape().

Obsah sdružuje layout() view helper: echo $this->layout()->content;. Znamená to, že view scripty pro zvolenou action proběhnou dříve než samotný layout view script.

V následujícím kroku si ověříme funkčnost. Smažte obsah souborů index.phtml, add.phtml, edit.phtml a delete.phtml.

Znovu vyzkoušejte všechny 4 URL adresy v tabulce výše. Vidíte nějakou změnu? Pokud ne, tak je to správně, protože vše funguje, tak jak má. Jediná změna je v tom, že jsme využili komponentu Zend_Layout, která nám podstatně zjednodušila práci. Škoda, že ve frameworku nebyla už dříve.

Stylování

Sice se jedná pouze o tutoriál, ale neodpoustil jsem si malé grafické vylepšení aplikace pomocí CSS. Na tomto příkladu si můžeme zároveň ukázat, jak odkazovat na externí soubory.

Protože URL neodkazují na správný root adresář, musíme si vytvořit view helper nazvaný baseUrl(), který nám vytvoří správnou URL adresu.

View helpers se nachází ve složce application/views/helpers a jsou pojmenovány následovně {Název helper}.php (první písmeno musí být velké) a třída ve které se view helper nachází se musí jmenovat Zend_Controller_Helper_{Název helper} (opět první písmeno velké). Ve třídě se musí nacházet metoda nazvaná {Název helper}() (pozor změna – první písmeno malé!). V tomto případě se soubor bude jmenovat BaseUrl.php.

zf-tutorial/application/views/helpers/BaseUrl.php

<?php

class Zend_View_Helper_BaseUrl
{
    function baseUrl()
    {
        $fc = Zend_Controller_Front::getInstance();
        return $fc->getBaseUrl();
    }
}

Jak vidíte, není to složitá metoda. Jednoduše jsme zavolali instanci front controller a vrátili hodnotu metody getBaseUrl().

Nyní již můžeme přidat do <head> odkaz na CSS soubor. Editujeme soubor application/layouts/layout.phtml.

zf-tutorial/application/layouts/layout.phtml

...
<head>
    <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
    <title><?php echo $this->escape($this->title); ?></title>
    <link rel="stylesheet" type="text/css" media="screen"
             href="<?php echo $this->baseUrl();?>/css/site.css" />
</head>
...

A nakonec samozřejmě vytvoříme CSS soubor.

zf-tutorial/public/css/site.css

body,html {
    margin: 0 5px;
    font-family: Verdana,sans-serif;
}
h1 {
    font-size:1.4em;
    color: #008000;
}
a {
    color: #008000;
}

/* Table */
th {
    text-align: left;
}
td, th {
    padding-right: 5px;
}

/* style form */
form dt {
    width: 100px;
    display: block;
    float: left;
    clear: left;
}
form dd {
    margin-left: 0;
    float: left;

}
form #submitbutton {
    margin-left: 100px;
}

Tak a teď už to vypadá trošku lépe.

Databáze

Nyní, když jsme oddělili ovládání aplikace a zobrazení použitím views se vrhneme na model. Opakování je matka moudrosti, takže model ja ta část aplikace, která má na starost data. Je to objekt(kolekce objektů), který je volán ve view. V naší aplikaci bude tedy pracovat s databází. K tomu použijeme třídu Zend_Db_Table, která má v Zend Framework na starost práci s databází.

Nastavení

Nyní provedeme konfiguraci třídy Zend_Db_Table. Třídě musíme nastavit typ databáze, který použijeme(MySQL) a přihlašovací údaje do databáze. Na tomto příkladu si ukážeme použití další třídy přímo ze Zend Framework – Zend_Config. Ta nám rychle objektově spřístupní veškeré konfigurační soubory. Konfigurační soubor může být buď INI nebo XML. My použijeme INI.

zf-tutorial/application/config.ini

[general]
db.adapter = PDO_MYSQL
db.params.host = localhost

db.params.username = rob
db.params.password = 123456
db.params.dbname = zftest

Nezapomeňte použít vaše vlastní přihlašovací údaje do databáze! V rozsáhlejších aplikacích je vhodné pro konfigurační soubory vytvořit vlastní adresář.

Použítí Zend_Config je následně velmi jednoduché:

$config = new Zend_Config_Ini('config.ini', 'section');

V této konfiguraci Zend_Config_Ini načte pouze jednu sekci s názvem section(naše sekce má název general). Dále je také podporováno použití poznámky u jména section, pomocí které můžeme načíst další section. Pro oddělení hiearchické struktury se používá tečka, což znamená že podobné direktivity můžeme sdružit. V našem příkladě bude host, username, password a dbname sdruženo pod objekt $config->params->config.

A kam umístit načtení třídy Zend_Config? No přece do bootstrap souboru(public/index.php):

zf-tutorial/public/index.php

...
include "Zend/Loader.php";
Zend_Loader::registerAutoload();

// load configuration
$config = new Zend_Config_Ini('../application/config.ini', 'general');
$registry = Zend_Registry::getInstance();
$registry->set('config', $config);

// setup controller
$frontController = Zend_Controller_Front::getInstance();
...

Nejprve načteme třídy, které budeme potřebovat – Zend_Registry a Zend_Config_Ini. Jako parametr pro třídu Zend_Config_Ini použijeme cestu k souboru config.ini a jako název section general čímž vše načteme do objektu $config. Nakonec objekt $config přiřadíme do objektu $registry s pomocí třídy Zend_Registry a to z důvodu toho, že nyní budeme mít ke konfiguraci přístup v celé aplikaci.

Poznámka: V této ukázkové aplikaci je zbytečné, aby přihlašovací údaje do databáze byly globálně přístupné. Můžeme si tak ale demonstrovat případ, kdy bude konfigurační soubor obsahovat mnohem více nastavení, ke kterému budeme potřebovat přístupovat v celé aplikaci.

Nastavujeme Zend_Db_Table

Pro použití Zend_Db_Table potřebujeme nejdříve předat konfigurační údaje, které jsme právě načetli. Vytvoříme instanci Zend_Db a pak ji přiřadíme statickou metodou Zend_Db_Table:: setDefaultAdapter(). Tohle všechno opět provedeme v boostrap souboru(public/index.php):

zf-tutorial/public/index.php

...
$registry = Zend_Registry::getInstance();
$registry->set('config', $config);

// setup database
$db = Zend_Db::factory($config->db);
Zend_Db_Table::setDefaultAdapter($db);

// setup controller
$frontController = Zend_Controller_Front::getInstance();
...

Vytvoříme tabulku

Nejdříve vytvoříme, pokud jste ještě tak neučinili, databázi zftest. Pak v ní tabulku album například pomocí aplikace PhpMyAdmin.

CREATE TABLE albums (
  id int(11) NOT NULL auto_increment,
  artist varchar(100) NOT NULL,
  title varchar(100) NOT NULL,
  PRIMARY KEY (id)
);

Naplníme tabulku

Do tabulky si vložíme několik položek. Můžeme třeba použít první dvě z Hot 100” CDs from Amazon.co.uk.

INSERT INTO albums (artist, title)
VALUES
('Duffy', 'Rockferry'),
('Van Morrison', 'Keep It Simple');

Model

Zend_Db_Table je abstraktní třída, musíme ji tedy rozšířit tak, aby pracovala s naší vzorovou aplikací. Vytvoříme si tedy třídu pojmenovanou Albums podle názvu tabulky v databázi. Třídě Zend_Db_Table nastavíme protected proměnnou $_name, která bude obsahovat název tabulky. Zend_Db_Table počítá s tím, že primární klíč je pojmenován id a má hodnotu auto increment. Sloupec s primárním klíčem si ale můžete pojmenovat i podle sebe, jen pak jeho název musíte předat tříde Zend_Db_Table.

Naši třídu Albums tedy uložíme v adresáři určeném pro models:

zf-tutorial/application/models/Albums.php

<?php

class Albums extends Zend_Db_Table
{
    protected $_name = 'albums';
}

Pro naši jednoduchou aplikaci nepotřebujeme třídu více rozšiřovat. Pokud budete mít nějaké další plány s modelem, je tohle to pravé místo, kde tak učinit.

Výpis alb

Nyní se konečně dostáváme k cíli naší aplikace a zobrazíme si výpis alb. To provedeme ve třídě IndexController a action nazvané indexAction().

zf-tutorial/application/controllers/IndexController.php

...
function indexAction()
{
    $this->view->title = "My Albums";
    $albums = new Albums();
    $this->view->albums = $albums->fetchAll();

}
...

Metoda fetchAll() navrací Zend_Db_Table_Rowset, který nám umožňuje procházet postupně všechny řádky pomocí iterace. Naplníme tedy soubor index.phtml.

zf-tutorial/application/views/scripts/index/index.phtml

<p><a href="<?php echo $this->url(array('controller'=>'index',
        'action'=>'add'));?>">Add new album</a></p>
<table>
<tr>
    <th>Title</th>
    <th>Artist</th>
    <th>&nbsp;</th>
</tr>
<?php foreach($this->albums as $album) : ?>
<tr>
    <td><?php echo $this->escape($album->title);?></td>
    <td><?php echo $this->escape($album->artist);?></td>
    <td>
        <a href="<?php echo $this->url(array('controller'=>'index',
            'action'=>'edit', 'id'=>$album->id));?>">Edit</a>
        <a href="<?php echo $this->url(array('controller'=>'index',
            'action'=>'delete', 'id'=>$album->id));?>">Delete</a>
    </td>
</tr>
<?php endforeach; ?>
</table>

Jako první jsme vytvořili odkaz na přidání nového alba. View helper url() nám automaticky poskládá správnou URL, jestliže mu v poli předáme jednotlivé parametry. Pak vytvoříme tabulku, která bude zobrazovat název alba, umělce a dále odkaz na editaci nebo smazání záznamu. Pro zobrazení všech alb je použit cyklus foreach. Pokud jste někde neudělali chybu, na hlavní stránce se vám právě zobrazil výpis alb (jsou dvě).

Přidáváme nové album

Nyní se vrhneme na tvorbu obslužné části pro přidání nového alba. Ta má dvě části:

• Vypíše se jednoduchý formulář pro přidání alba
• Data od uživatele se uloží do databáze

Tak tady využijeme další NOVINKY v Zend Framework 1.5 a to komponenty Zend_Form. Zend_Form nám usnadňuje práci s vytvářením formulářů a jejich následné kontrole. Vytvoříme si tedy novou třídu nazvanou AlbumForm, která se v naší MVC struktuře řadí do části model (viz. tabulka úplně na začátku).

Naše třída AlbumForm bude potomek Zend_Form:

zf-tutorial/application/models/AlbumForm.php

<?php

class AlbumForm extends Zend_Form
{
    public function __construct($options = null)
    {
        parent::__construct($options);
        $this->setName('album');

        $id = new Zend_Form_Element_Hidden('id');

        $artist = new Zend_Form_Element_Text('artist');
        $artist->setLabel('Artist')
        ->setRequired(true)
        ->addFilter('StripTags')
        ->addFilter('StringTrim')
        ->addValidator('NotEmpty');

        $title = new Zend_Form_Element_Text('title');
        $title->setLabel('Title')
        ->setRequired(true)
        ->addFilter('StripTags')
        ->addFilter('StringTrim')
        ->addValidator('NotEmpty');

        $submit = new Zend_Form_Element_Submit('submit');
        $submit->setAttrib('id', 'submitbutton');

        $this->addElements(array($id, $artist, $title, $submit));
    }
}

Přímo v konstruktoru naší třídy AlbumForm vytvoříme 4 prvky – id, artist, title a submit. Pro každý prvek definujeme potřebné atributy včetně popisku v <label>. Pro textový prvek definujeme dva filtry – StripTags(odstranění html tagů) a StringTrim(odstranění mezer na začátku a konci řetězce), poté nastavíme, že prvek musí být zadaný(Required) a nakonec přidáme validátor na prázdnost řetězce.

Model máme hotový a teď se vrhneme na controller. Upravujeme metodu addAction() v souboru indexController.php:

zf-tutorial/application/controllers/IndexController.php

...
    function addAction()
    {
        $this->view->title = "Add New Album";

        $form = new AlbumForm();
        $form->submit->setLabel('Add');
        $this->view->form = $form;

        if ($this->_request->isPost()) {
            $formData = $this->_request->getPost();
            if ($form->isValid($formData)) {
                $albums = new Albums();
                $row = $albums->createRow();
                $row->artist = $form->getValue('artist');
                $row->title = $form->getValue('title');
                $row->save();

                $this->_redirect('/');
            } else {
                $form->populate($formData);
            }
        }
    }
...

Nyní si výše uvedený kód rozebeme řádek po řádku, protože je velmi důležitý.

$form = new AlbumForm();
$form->submit->setLabel('Add');
$this->view->form = $form;

Jako první si vytvoříme novou instanci naší třídy AlbumForm. Následně si definujeme popisek tlačítka submit. Poslední řádek přidá naše atributy do view pro zobrazení.

if ($this->_request->isPost()) {
    $formData = $this->_request->getPost();
    if ($form->isValid($formData)) {

Pokud nabývá metoda isPost() hodnotu true, formulář byl odeslán ke zpracování. Nyní můžeme k odeslaným datům přistupovat přes metodu getPost() a zkontrolovat zadané údaje pomocí metody isValid().

$albums = new Albums();
$row = $albums->createRow();
$row->artist = $form->getValue('artist');
$row->title = $form->getValue('title');
$row->save();
$this->_redirect('/');

Pokud náš formulář prošel kontrolou, vytvoříme si instanci třídy Albums (v MVC se jedná o model). Použijeme metodu této třídy createRow(). Předáme ji naše atributy artist a title a uložíme save(). Nakonec přesměrujeme na hlavní stránku pomocí metody controlleru _redirect().

} else {
    $form->populate($formData);
}

Pokud data z formuláře nejsou validní, vrátíme uživateli formulář včetně nesprávně vyplněných dat.

Nyní máme i úpravu controlleru za sebou a je čas se vrhnout na poslední část a tou je vytvoření view v souboru add.phtml

zf-tutorial/application/views/scripts/index/add.phtml

<?php echo $this->form ;?>

No povězte, není to mnohem jednodušší než datlovat ručně html kód 🙂 Dalo by se to přirovnat jak když hážete lopatou a pak přijede bagr a má stejnou práci hotovou mnohem dříve.

Editujeme album

Editování alba je velmi pobodné, takže ho nemusíme rozebírat:

zf-tutorial/application/controllers/IndexController.php

...
   function editAction()
   {
       $this->view->title = "Edit Album";

       $form = new AlbumForm();
       $form->submit->setLabel('Save');
       $this->view->form = $form;

       if ($this->_request->isPost()) {
           $formData = $this->_request->getPost();
           if ($form->isValid($formData)) {
               $albums = new Albums();
               $id = (int)$form->getValue('id');
               $row = $albums->fetchRow('id='.$id);
               $row->artist = $form->getValue('artist');
               $row->title = $form->getValue('title');
               $row->save();

               $this->_redirect('/');
           } else {
               $form->populate($formData);
           }
       } else {
           // album id is expected in $params['id']
           $id = (int)$this->_request->getParam('id', 0);
           if ($id > 0) {
               $albums = new Albums();
               $album = $albums->fetchRow('id='.$id);
               $form->populate($album->toArray());
           }
       }
   }
   ...

Výše uvedený kód nebudeme rozebírat řádek po řádku, protože kód je velmi podobný metodě addAction(). Rozebeme si akorát několik rozdílů. Jako první musíme informace o požadovaném záznamu získat z databáze a uložit je do proměnných formuláře.

// album id is expected in $params['id']
$id = (int)$this->_request->getParam('id', 0);
if ($id > 0) {
    $albums = new Albums();
    $album = $albums->fetchRow('id='.$id);
    $form->populate($album->toArray());
}

Aby tento kód fungoval, nesmí být id předáváno metodou POST. Dále využíváme námi vytvořené třídy Albums() pro získání informací o záznamu z databáze. Data vybraná z db můžeme přímo vložit do formuláře přes metodu toArray() třídy Zend_Db_Table_Row.

A nakonec změněná data uložíme na původní místo do databáze.

$albums = new Albums();
$id = (int)$form->getValue('id');
$row = $albums->fetchRow('id='.$id);

Nejlepší na tom je, že šablona pro editaci je stejná jako pro přidání.

zf-tutorial/application/views/scripts/index/edit.phtml

<?php echo $this->form ;?>

Teď už by vám mělo fungovat přidávání a editace alb.

Mazání alb

Aby naše aplikace byla kompletní, musíme uživatelům umožnit alba smazat. Vedle výpisu každého alba se zobrazuje odkaz na editaci a smazání každé položky. Po kliknutí na tlačítko smazat se nejprve objeví potvrzovací stránka a až poté se položka definitivně smaže z databáze.

zf-tutorial/application/controllers/IndexController.php

...
    function deleteAction()
    {
        $this->view->title = "Delete Album";

        if ($this->_request->isPost()) {
            $id = (int)$this->_request->getPost('id');
            $del = $this->_request->getPost('del');
            if ($del == 'Yes' && $id > 0) {
                $albums = new Albums();
                $where = 'id = ' . $id;
                $albums->delete($where);
            }
            $this->_redirect('/');
        } else {
            $id = (int)$this->_request->getParam('id');
            if ($id > 0) {
                $albums = new Albums();
                $this->view->album = $albums->fetchRow('id='.$id);
            }
        }
    }
...

Použijeme metodu isPost(), na jejichž základě rozhodneme, zda teprve vypíšeme potvrzení nebo už máme potvrzeno, že záznam můžeme smazat. Vlastní smazání je řešené metodou delete() třídy Zend_Db_Table. Ještě bych tu rád zmínil, že pokud není použita metoda post, zkusíme získat id z URL a načíst korektní data z db.

A na závěr view skript:

zf-tutorial/application/views/scripts/index/delete.phtml

<?php if ($this->album) :?>
<p>Are you sure that you want to delete
  '<?php echo $this->escape($this->album->title); ?>' by
  '<?php echo $this->escape($this->album->artist); ?>'?
</p>
<form action="<?php echo $this->url(array('action'=>'delete')); ?>"
method="post">
<div>
  <input type="hidden" name="id" value="<?php echo $this->album->id; ?>" />
  <input type="submit" name="del" value="Yes" />
  <input type="submit" name="del" value="No" />
</div>
</form>
<?php else: ?>
<p>Cannot find album.</p>
<?php endif;?>

Po kliknutí na tlačítko smazat ve výpisu alb se nám nejdříve zobrazí dotaz, jestli chceme záznam opravdu smazat. Pokud ho potvrdíme, dojde k fyzickému smazání záznamu z databáze.

A jsme u konce. Právě máte před sebou plně funkční aplikaci postavenou na nejnovějším Zend Framework. Oproti starší verzi jsme se naučili používat Zend_Layout a Zend_Form.

Řešení problémů

Pokud máte problém s tím, že fungují všechny stránky kromě hlavní (index/index) je pravděpodobné, že router není schopen určit ve kterém podadresáři se nachází vaše aplikace. Trochu jsem pátral, proč tomu tak je a zjistil jsem, že se to stává, když URL na vaše stránky se liší od kořenového adresáře, kde je aplikace umístěna. Mělo by pomoct nastavit $baseURL.

zf-tutorial/public/index.php

...
// setup controller
$frontController = Zend_Controller_Front::getInstance();
$frontController->throwExceptions(true);
$frontController->setControllerDirectory('../application/controllers');
$frontController->setBaseUrl('/mysubdir/zf-tutorial/public');
Zend_Layout::startMvc(array('layoutPath'=>'../application/layouts'));
...

Nahraďte ‚/mysubdir/zf-tutorial/public‘ správnou URL k index.php. Pokud je index.php dostupný na adrese http://localhost/…ic/index.php ,pak správná hodnota $baseUrl je ‚/~ralle/zf-tutorial/public‘.

Závěr

Doufám, že byl tento tutoriál pro vás užitečný. Pokud naleznete jakukoliv chybu v mém překladu, budu rád, když mi o tom dáte vědět, abych ji mohl opravit.

Komentáře

O autorovi