quickstart-create-model.xml 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 20879 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="learning.quickstart.create-model">
  5. <title>Utworzenie modelu oraz tabeli w bazie danych</title>
  6. <para>
  7. Przed rozpoczęciem należy zastanowić się nad następującym zagadnieniem: gdzie tworzone
  8. klasy będą przechowywane i w jaki sposób będzie można je odnaleźć? Utworzony właśnie
  9. domyślny projekt, używa automatycznego dołączania plików (autoloader). Możliwe jest
  10. dołączenie do niego kolejnych autoloaderów tak by umożliwić odnajdywanie tworzonych
  11. klas. Typowym rozwiązaniem jest umieszczenie różnych klas w głównym katalogu - w tym
  12. wypadku nazwanego <filename>application/</filename> - i nazywanie ich z zachowaniem
  13. wspólnego prefiksu.
  14. </para>
  15. <para>
  16. Klasa <classname>Zend_Controller_Front</classname> umożliwia tworzenie modułów (modules)
  17. - odrębnych części, które same są mini-aplikacjami. W ramach każdego modułu odwzorowywana
  18. jest taka sama struktura katalogów jaka jest tworzona przez
  19. narzędzie <command>zf</command> w katalogu głównym aplikacji. Nazwy wszystkich
  20. klas w jednym module muszą rozpoczynać się od wspólnego prefiksu - nazwy modułu.
  21. Katalog główny - <filename>application/</filename> również jest modułem (domyślnym)
  22. dlatego też jego zasoby zostaną uwzględnione w procesie automatycznego dołączania plików.
  23. </para>
  24. <para>
  25. <classname>Zend_Application_Module_Autoloader</classname> oferuje funkcjonalność
  26. niezbędną do odwzorowania zasobów modułów na odpowiednie ścieżki katalogów oraz
  27. ułatwia zachowanie spójnego standardu nazewnictwa. Instancja tej klasy jest tworzona
  28. domyślnie podczas uruchamiania klasy bootstrap. Domyślnym prefiksem używanym przez
  29. bootstrap jest "Application" więc modele, formularze oraz klasy tabel będą rozpoczynały
  30. się prefiksem "Application_".
  31. </para>
  32. <para>
  33. Teraz należy się zastanowić co składa się na książkę odwiedzin. Typowo będzie w niej
  34. lista wpisów z <emphasis>komentarzem</emphasis>, <emphasis>czasem zapisu</emphasis>
  35. oraz <emphasis>adresem email</emphasis>. Zakładając użycie bazy danych, pole
  36. <emphasis>unikalny identyfikator</emphasis> może również być przydatne. Aplikacja
  37. powinna umożliwiać zapis danych, pobranie wpisów pojedynczo oraz wszystkich na raz.
  38. Prosty model oferujący opisaną funkcjonalność może przedstawiać się następująco:
  39. </para>
  40. <programlisting language="php"><![CDATA[
  41. // application/models/Guestbook.php
  42. class Application_Model_Guestbook
  43. {
  44. protected $_comment;
  45. protected $_created;
  46. protected $_email;
  47. protected $_id;
  48. public function __set($name, $value);
  49. public function __get($name);
  50. public function setComment($text);
  51. public function getComment();
  52. public function setEmail($email);
  53. public function getEmail();
  54. public function setCreated($ts);
  55. public function getCreated();
  56. public function setId($id);
  57. public function getId();
  58. }
  59. class Application_Model_GuestbookMapper
  60. {
  61. public function save(Application_Model_Guestbook $guestbook);
  62. public function find($id);
  63. public function fetchAll();
  64. }
  65. ]]></programlisting>
  66. <para>
  67. <methodname>__get()</methodname> and <methodname>__set()</methodname> stanowią mechanizmy
  68. ułatwiające dostęp do poszczególnych właściwości oraz pośredniczą w dostępie do innych
  69. getterów i setterów. Dzięki nim, można również upewnić się, że jedynie pożądane
  70. właściwości będą dostępne.
  71. </para>
  72. <para>
  73. Metody <methodname>find()</methodname> oraz <methodname>fetchAll()</methodname> umożliwiają
  74. zwrócenie pojedynczego lub wszystkich rekordów natomiast <methodname>save()</methodname>
  75. zapisuje dane.
  76. </para>
  77. <para>
  78. W tym momencie można zacząć myśleć o skonfigurowaniu bazy danych.
  79. </para>
  80. <para>
  81. Na początku należy zainicjować zasób <classname>Db</classname>. Jego konfiguracja
  82. jest możliwa na podobnych zasadach jak w przypadku zasobów
  83. <classname>Layout</classname> oraz <classname>View</classname>.
  84. Można to osiągnąć za pomocą polecenia <command>zf configure db-adapter</command>:
  85. </para>
  86. <programlisting language="shell"><![CDATA[
  87. % zf configure db-adapter \
  88. > 'adapter=PDO_SQLITE&dbname=APPLICATION_PATH "/../data/db/guestbook.db"' \
  89. > production
  90. A db configuration for the production has been written to the application config file.
  91. % zf configure db-adapter \
  92. > 'adapter=PDO_SQLITE&dbname=APPLICATION_PATH "/../data/db/guestbook-testing.db"' \
  93. > testing
  94. A db configuration for the production has been written to the application config file.
  95. % zf configure db-adapter \
  96. > 'adapter=PDO_SQLITE&dbname=APPLICATION_PATH "/../data/db/guestbook-dev.db"' \
  97. > development
  98. A db configuration for the production has been written to the application config file.
  99. ]]></programlisting>
  100. <para>
  101. Teraz, po otworzeniu pliku <filename>application/configs/application.ini</filename>
  102. można zobaczyć instrukcje, jakie zostały do niego dodane w odpowiednich sekcjach.
  103. </para>
  104. <programlisting language="ini"><![CDATA[
  105. ; application/configs/application.ini
  106. [production]
  107. ; ...
  108. resources.db.adapter = "PDO_SQLITE"
  109. resources.db.params.dbname = APPLICATION_PATH "/../data/db/guestbook.db"
  110. [testing : production]
  111. ; ...
  112. resources.db.adapter = "PDO_SQLITE"
  113. resources.db.params.dbname = APPLICATION_PATH "/../data/db/guestbook-testing.db"
  114. [development : production]
  115. ; ...
  116. resources.db.adapter = "PDO_SQLITE"
  117. resources.db.params.dbname = APPLICATION_PATH "/../data/db/guestbook-dev.db"
  118. ]]></programlisting>
  119. <para>
  120. Ostatecznie plik konfiguracyjny powinien wyglądać następująco:
  121. </para>
  122. <programlisting language="ini"><![CDATA[
  123. ; application/configs/application.ini
  124. [production]
  125. phpSettings.display_startup_errors = 0
  126. phpSettings.display_errors = 0
  127. bootstrap.path = APPLICATION_PATH "/Bootstrap.php"
  128. bootstrap.class = "Bootstrap"
  129. appnamespace = "Application"
  130. resources.frontController.controllerDirectory = APPLICATION_PATH "/controllers"
  131. resources.frontController.params.displayExceptions = 0
  132. resources.layout.layoutPath = APPLICATION_PATH "/layouts/scripts"
  133. resources.view[] =
  134. resources.db.adapter = "PDO_SQLITE"
  135. resources.db.params.dbname = APPLICATION_PATH "/../data/db/guestbook.db"
  136. [staging : production]
  137. [testing : production]
  138. phpSettings.display_startup_errors = 1
  139. phpSettings.display_errors = 1
  140. resources.db.adapter = "PDO_SQLITE"
  141. resources.db.params.dbname = APPLICATION_PATH "/../data/db/guestbook-testing.db"
  142. [development : production]
  143. phpSettings.display_startup_errors = 1
  144. phpSettings.display_errors = 1
  145. resources.db.adapter = "PDO_SQLITE"
  146. resources.db.params.dbname = APPLICATION_PATH "/../data/db/guestbook-dev.db"
  147. ]]></programlisting>
  148. <para>
  149. Należy zauważyć, iż baza (bazy) danych będzie przechowywana w
  150. <filename>data/db/</filename>.
  151. Te katalogi powinny zostać utworzone i udostępnione wszystkim. Na systemach unix można
  152. tego dokonać następująco: </para>
  153. <programlisting language="shell"><![CDATA[
  154. % mkdir -p data/db; chmod -R a+rwX data
  155. ]]></programlisting>
  156. <para>
  157. Na systemach Windows należy utworzyć odpowiednie katalogi w eksploratorze oraz ustawić
  158. uprawnienia w taki sposób aby każdy użytkownik miał prawo zapisu.
  159. </para>
  160. <para>
  161. Połączenie z bazą danych zostało utworzone - w tym przypadku bazą jest Sqlite
  162. znajdująca się w katalogu <filename>application/data/</filename>. Następnym krokiem jest
  163. utworzenie tabeli przechowującej rekordy książki adresowej.
  164. </para>
  165. <programlisting language="sql"><![CDATA[
  166. -- scripts/schema.sqlite.sql
  167. --
  168. -- Poniższy kod SQL należy uruchomić w bazie danych
  169. CREATE TABLE guestbook (
  170. id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
  171. email VARCHAR(32) NOT NULL DEFAULT 'noemail@test.com',
  172. comment TEXT NULL,
  173. created DATETIME NOT NULL
  174. );
  175. CREATE INDEX "id" ON "guestbook" ("id");
  176. ]]></programlisting>
  177. <para>
  178. Aby mieć zestaw danych do testowania można utworzyć w tabeli kilka rekordów.
  179. </para>
  180. <programlisting language="sql"><![CDATA[
  181. -- scripts/data.sqlite.sql
  182. --
  183. -- Poniższy kod SQL może posłużyć do zapełnienia tabeli testowymi danymi
  184. INSERT INTO guestbook (email, comment, created) VALUES
  185. ('ralph.schindler@zend.com',
  186. 'Hello! Hope you enjoy this sample zf application!',
  187. DATETIME('NOW'));
  188. INSERT INTO guestbook (email, comment, created) VALUES
  189. ('foo@bar.com',
  190. 'Baz baz baz, baz baz Baz baz baz - baz baz baz.',
  191. DATETIME('NOW'));
  192. ]]></programlisting>
  193. <para>
  194. Mamy zdefiniowany schemat bazy danych oraz niewielką ilość danych do zaimportowania.
  195. Teraz można napisać skrypt tworzący bazę danych. Ten krok nie jest potrzebny w środowisku
  196. produkcyjnym. Dzięki niemu można lokalnie wypracować odpowiednią strukturę bazy danych
  197. aby tworzona aplikacja działała zgodnie z założeniami. Skrypt
  198. <filename>scripts/load.sqlite.php</filename> można wypełnić w poniższy sposób:
  199. </para>
  200. <programlisting language="php"><![CDATA[
  201. // scripts/load.sqlite.php
  202. /**
  203. * Skrypt tworzący bazę danych i wypełniający ją danymi
  204. */
  205. // Inicjalizacja ścieżek oraz autoloadera
  206. defined('APPLICATION_PATH')
  207. || define('APPLICATION_PATH', realpath(dirname(__FILE__) . '/../application'));
  208. set_include_path(implode(PATH_SEPARATOR, array(
  209. APPLICATION_PATH . '/../library',
  210. get_include_path(),
  211. )));
  212. require_once 'Zend/Loader/Autoloader.php';
  213. Zend_Loader_Autoloader::getInstance();
  214. // Zdefiniowanie opcji CLI
  215. $getopt = new Zend_Console_Getopt(array(
  216. 'withdata|w' => 'Load database with sample data',
  217. 'env|e-s' => 'Application environment for which to create database (defaults to development)',
  218. 'help|h' => 'Help -- usage message',
  219. ));
  220. try {
  221. $getopt->parse();
  222. } catch (Zend_Console_Getopt_Exception $e) {
  223. // Bad options passed: report usage
  224. echo $e->getUsageMessage();
  225. return false;
  226. }
  227. // W przypadku zażądania pomocy, wyświetlenie informacji o użyciu
  228. if ($getopt->getOption('h')) {
  229. echo $getopt->getUsageMessage();
  230. return true;
  231. }
  232. // Inicjalizacja wartości na podstawie opcji CLI
  233. $withData = $getopt->getOption('w');
  234. $env = $getopt->getOption('e');
  235. defined('APPLICATION_ENV')
  236. || define('APPLICATION_ENV', (null === $env) ? 'development' : $env);
  237. // Inicjalizacja Zend_Application
  238. $application = new Zend_Application(
  239. APPLICATION_ENV,
  240. APPLICATION_PATH . '/configs/application.ini'
  241. );
  242. // Inicjalizacja oraz zwrócenie zasobu bazy danych
  243. $bootstrap = $application->getBootstrap();
  244. $bootstrap->bootstrap('db');
  245. $dbAdapter = $bootstrap->getResource('db');
  246. // Powiadomienie użytkownika o postępie (w tym miejscu jest tworzona baza danych)
  247. if ('testing' != APPLICATION_ENV) {
  248. echo 'Writing Database Guestbook in (control-c to cancel): ' . PHP_EOL;
  249. for ($x = 5; $x > 0; $x--) {
  250. echo $x . "\r"; sleep(1);
  251. }
  252. }
  253. // Sprawdzenie czy plik bazy danych istnieje
  254. $options = $bootstrap->getOption('resources');
  255. $dbFile = $options['db']['params']['dbname'];
  256. if (file_exists($dbFile)) {
  257. unlink($dbFile);
  258. }
  259. // Wywołanie poleceń zawartych w pliku tworzącym schemat
  260. try {
  261. $schemaSql = file_get_contents(dirname(__FILE__) . '/schema.sqlite.sql');
  262. // bezpośrednie użycie obiektu połączenia w celu wywołania poleceń SQL
  263. $dbAdapter->getConnection()->exec($schemaSql);
  264. chmod($dbFile, 0666);
  265. if ('testing' != APPLICATION_ENV) {
  266. echo PHP_EOL;
  267. echo 'Database Created';
  268. echo PHP_EOL;
  269. }
  270. if ($withData) {
  271. $dataSql = file_get_contents(dirname(__FILE__) . '/data.sqlite.sql');
  272. // bezpośrednie użycie obiektu połączenia w celu wywołania poleceń SQL
  273. $dbAdapter->getConnection()->exec($dataSql);
  274. if ('testing' != APPLICATION_ENV) {
  275. echo 'Data Loaded.';
  276. echo PHP_EOL;
  277. }
  278. }
  279. } catch (Exception $e) {
  280. echo 'AN ERROR HAS OCCURED:' . PHP_EOL;
  281. echo $e->getMessage() . PHP_EOL;
  282. return false;
  283. }
  284. // Ten skrypt powinien zostać uruchomiony z wiersza poleceń
  285. return true;
  286. ]]></programlisting>
  287. <para>
  288. Teraz należy wywołać powyższy skrypt. Można to zrobić z poziomu terminala lub
  289. wiersza poleceń poprzez wpisanie następującej komendy:
  290. </para>
  291. <programlisting language="shell"><![CDATA[
  292. % php scripts/load.sqlite.php --withdata
  293. ]]></programlisting>
  294. <para>
  295. Powinien pojawić się następujący komunikat:
  296. </para>
  297. <programlisting language="text"><![CDATA[
  298. path/to/ZendFrameworkQuickstart/scripts$ php load.sqlite.php --withdata
  299. Writing Database Guestbook in (control-c to cancel):
  300. 1
  301. Database Created
  302. Data Loaded.
  303. ]]></programlisting>
  304. <para>
  305. Po zdefiniowaniu bazy danych aplikacji książka odwiedzin można przystąpić do budowy kodu
  306. samej aplikacji. W następnych krokach zostanie zbudowana klasa dostępu do danych
  307. (poprzez <classname>Zend_Db_Table</classname>), oraz klasa mapująca - służąca do
  308. połączenia z wcześniej opisanym modelem.
  309. Na koniec utworzony zostanie kontroler zarządzający modelem, którego zadaniem będzie
  310. wyświetlanie istniejących rekordów oraz obróbka nowych danych.
  311. </para>
  312. <para>
  313. Aby łączyć się ze źródłem danych użyty zostanie wzorzec
  314. <ulink url="http://martinfowler.com/eaaCatalog/tableDataGateway.html">Table Data
  315. Gateway</ulink> udostępniany poprzez klasę <classname>Zend_Db_Table</classname>.
  316. Na początek należy utworzyć klasę opartą o <classname>Zend_Db_Table</classname>.
  317. Podobnie jak przy layoucie oraz adapterze bazy danych - można skorzystać z narzędzia
  318. <command>zf</command> i jego komendy <command>create db-table</command>. Należy przy tym
  319. podać minimalnie dwa argumenty: nazwę tworzonej klasy oraz nazwę tabeli bazy danych,
  320. do której prowadzi.
  321. </para>
  322. <programlisting language="shell"><![CDATA[
  323. % zf create db-table Guestbook guestbook
  324. Creating a DbTable at application/models/DbTable/Guestbook.php
  325. Updating project profile 'zfproject.xml'
  326. ]]></programlisting>
  327. <para>
  328. Spoglądając na strukturę katalogów należy zwrócić uwagę na nowy katalog
  329. <filename>application/models/DbTable/</filename> zawierający plik
  330. <filename>Guestbook.php</filename>. Ten plik powinien zawierać następującą
  331. treść:
  332. </para>
  333. <programlisting language="php"><![CDATA[
  334. // application/models/DbTable/Guestbook.php
  335. /**
  336. * This is the DbTable class for the guestbook table.
  337. */
  338. class Application_Model_DbTable_Guestbook extends Zend_Db_Table_Abstract
  339. {
  340. /** Table name */
  341. protected $_name = 'guestbook';
  342. }
  343. ]]></programlisting>
  344. <para>
  345. Należy zwrócić uwagę na prefiks: <classname>Application_Model_DbTable</classname>.
  346. Prefiks klas aplikacji "Application" znajduje się na pierwszym miejscu. Po nim
  347. występuje komponent "Model_DbTable", który jest mapowany do katalogu
  348. <filename>models/DbTable/</filename> znajdującego się w module.
  349. </para>
  350. <para>
  351. Jedyne dane niezbędne przy tworzeniu klasy pochodnej w stosunku do
  352. <classname>Zend_Db_Table</classname> to nazwa tabeli i opcjonalnie klucz pierwotny
  353. (jeśli jest inny niż "id").
  354. </para>
  355. <para>
  356. Teraz należy utworzyć klasę mapującą obiekt w aplikacji na obiekt w bazie danych czyli
  357. <ulink url="http://martinfowler.com/eaaCatalog/dataMapper.html">Data Mapper</ulink>.
  358. Obiektem w bazie danych jest <classname>Application_Model_Guestbook</classname> natomiast
  359. za obiekt bazy danych odpowiada <classname>Application_Model_DbTable_Guestbook</classname>.
  360. Typowy API takiej klasy wygląda następująco:
  361. </para>
  362. <programlisting language="php"><![CDATA[
  363. // application/models/GuestbookMapper.php
  364. class Application_Model_GuestbookMapper
  365. {
  366. public function save($model);
  367. public function find($id, $model);
  368. public function fetchAll();
  369. }
  370. ]]></programlisting>
  371. <para>
  372. Dodatkowo można zdefiniować metody ustawiające i zwracające Table Data Gateway.
  373. Do utworzenia klasy można użyć narzędzia <command>zf</command>:
  374. </para>
  375. <programlisting language="shell"><![CDATA[
  376. % zf create model GuestbookMapper
  377. Creating a model at application/models/GuestbookMapper.php
  378. Updating project profile '.zfproject.xml'
  379. ]]></programlisting>
  380. <para>
  381. Po otwarciu klasy <classname>Application_Model_GuestbookMapper</classname> z lokalizacji
  382. <filename>application/models/GuestbookMapper.php</filename> widać następujący kod:
  383. </para>
  384. <programlisting language="php"><![CDATA[
  385. // application/models/GuestbookMapper.php
  386. class Application_Model_GuestbookMapper
  387. {
  388. protected $_dbTable;
  389. public function setDbTable($dbTable)
  390. {
  391. if (is_string($dbTable)) {
  392. $dbTable = new $dbTable();
  393. }
  394. if (!$dbTable instanceof Zend_Db_Table_Abstract) {
  395. throw new Exception('Invalid table data gateway provided');
  396. }
  397. $this->_dbTable = $dbTable;
  398. return $this;
  399. }
  400. public function getDbTable()
  401. {
  402. if (null === $this->_dbTable) {
  403. $this->setDbTable('Application_Model_DbTable_Guestbook');
  404. }
  405. return $this->_dbTable;
  406. }
  407. public function save(Application_Model_Guestbook $guestbook)
  408. {
  409. $data = array(
  410. 'email' => $guestbook->getEmail(),
  411. 'comment' => $guestbook->getComment(),
  412. 'created' => date('Y-m-d H:i:s'),
  413. );
  414. if (null === ($id = $guestbook->getId())) {
  415. unset($data['id']);
  416. $this->getDbTable()->insert($data);
  417. } else {
  418. $this->getDbTable()->update($data, array('id = ?' => $id));
  419. }
  420. }
  421. public function find($id, Application_Model_Guestbook $guestbook)
  422. {
  423. $result = $this->getDbTable()->find($id);
  424. if (0 == count($result)) {
  425. return;
  426. }
  427. $row = $result->current();
  428. $guestbook->setId($row->id)
  429. ->setEmail($row->email)
  430. ->setComment($row->comment)
  431. ->setCreated($row->created);
  432. }
  433. public function fetchAll()
  434. {
  435. $resultSet = $this->getDbTable()->fetchAll();
  436. $entries = array();
  437. foreach ($resultSet as $row) {
  438. $entry = new Application_Model_Guestbook();
  439. $entry->setId($row->id)
  440. ->setEmail($row->email)
  441. ->setComment($row->comment)
  442. ->setCreated($row->created);
  443. $entries[] = $entry;
  444. }
  445. return $entries;
  446. }
  447. }
  448. ]]></programlisting>
  449. <para>
  450. W obecnym momencie można przystąpić do utworzenia klasy modelu używając polecenia
  451. <command>zf create model</command>:
  452. </para>
  453. <programlisting language="shell"><![CDATA[
  454. % zf create model Guestbook
  455. Creating a model at application/models/Guestbook.php
  456. Updating project profile '.zfproject.xml'
  457. ]]></programlisting>
  458. <para>
  459. Nowo utworzoną klasę można zmodyfikować tak aby ułatwić umieszczanie danych w modelu
  460. poprzez przekazanie tablicy do konstruktora lub do metody
  461. <methodname>setOptions()</methodname>. Ostatecznie model znajdujący się w
  462. <filename>application/models/Guestbook.php</filename> powinien wyglądać następująco:
  463. </para>
  464. <programlisting language="php"><![CDATA[
  465. // application/models/Guestbook.php
  466. class Application_Model_Guestbook
  467. {
  468. protected $_comment;
  469. protected $_created;
  470. protected $_email;
  471. protected $_id;
  472. public function __construct(array $options = null)
  473. {
  474. if (is_array($options)) {
  475. $this->setOptions($options);
  476. }
  477. }
  478. public function __set($name, $value)
  479. {
  480. $method = 'set' . $name;
  481. if (('mapper' == $name) || !method_exists($this, $method)) {
  482. throw new Exception('Invalid guestbook property');
  483. }
  484. $this->$method($value);
  485. }
  486. public function __get($name)
  487. {
  488. $method = 'get' . $name;
  489. if (('mapper' == $name) || !method_exists($this, $method)) {
  490. throw new Exception('Invalid guestbook property');
  491. }
  492. return $this->$method();
  493. }
  494. public function setOptions(array $options)
  495. {
  496. $methods = get_class_methods($this);
  497. foreach ($options as $key => $value) {
  498. $method = 'set' . ucfirst($key);
  499. if (in_array($method, $methods)) {
  500. $this->$method($value);
  501. }
  502. }
  503. return $this;
  504. }
  505. public function setComment($text)
  506. {
  507. $this->_comment = (string) $text;
  508. return $this;
  509. }
  510. public function getComment()
  511. {
  512. return $this->_comment;
  513. }
  514. public function setEmail($email)
  515. {
  516. $this->_email = (string) $email;
  517. return $this;
  518. }
  519. public function getEmail()
  520. {
  521. return $this->_email;
  522. }
  523. public function setCreated($ts)
  524. {
  525. $this->_created = $ts;
  526. return $this;
  527. }
  528. public function getCreated()
  529. {
  530. return $this->_created;
  531. }
  532. public function setId($id)
  533. {
  534. $this->_id = (int) $id;
  535. return $this;
  536. }
  537. public function getId()
  538. {
  539. return $this->_id;
  540. }
  541. }
  542. ]]></programlisting>
  543. <para>
  544. W ostatnim kroku, aby połączyć wszystkie elementy, należy utworzyć kontroler,
  545. którego zadaniem będzie zaprezentowanie listy zapisanych rekordów oraz obsługa
  546. dopisania nowych danych.
  547. </para>
  548. <para>
  549. Aby to osiągnąć należy użyć polecenia <command>zf create controller</command>:
  550. </para>
  551. <programlisting language="shell"><![CDATA[
  552. % zf create controller Guestbook
  553. Creating a controller at
  554. application/controllers/GuestbookController.php
  555. Creating an index action method in controller Guestbook
  556. Creating a view script for the index action method at
  557. application/views/scripts/guestbook/index.phtml
  558. Creating a controller test file at
  559. tests/application/controllers/GuestbookControllerTest.php
  560. Updating project profile '.zfproject.xml'
  561. ]]></programlisting>
  562. <para>
  563. Powyższe polecenie tworzy nowy kontroler - <classname>GuestbookController</classname>
  564. w pliku <filename>application/controllers/GuestbookController.php</filename> zawierający
  565. jedną akcję - <methodname>indexAction()</methodname>.
  566. Na użytek tego kontrolera utworzony zostaje również katalog widoków:
  567. <filename>application/views/scripts/guestbook/</filename> zawierający view skrypt dla
  568. akcji index.
  569. </para>
  570. <para>
  571. Akcja "index" będzie stanowić domyślny punkt kontrolera pokazujący zapisane rekordy.
  572. </para>
  573. <para>
  574. Teraz należy zaprogramować logikę aplikacji. Aby pokazać zapisane rekordy użytkownikowi
  575. wchodzącemu do <methodname>indexAction()</methodname> można użyć poniższego kodu:
  576. </para>
  577. <programlisting language="php"><![CDATA[
  578. // application/controllers/GuestbookController.php
  579. class GuestbookController extends Zend_Controller_Action
  580. {
  581. public function indexAction()
  582. {
  583. $guestbook = new Application_Model_GuestbookMapper();
  584. $this->view->entries = $guestbook->fetchAll();
  585. }
  586. }
  587. ]]></programlisting>
  588. <para>
  589. Dodatkowo potrzebny jest jeszcze widok wyświetlający dane. W pliku
  590. <filename>application/views/scripts/guestbook/index.phtml</filename> można umieścić
  591. następujący zapis:
  592. </para>
  593. <programlisting language="php"><![CDATA[
  594. <!-- application/views/scripts/guestbook/index.phtml -->
  595. <p><a href="<?php echo $this->url(
  596. array(
  597. 'controller' => 'guestbook',
  598. 'action' => 'sign'
  599. ),
  600. 'default',
  601. true) ?>">Sign Our Guestbook</a></p>
  602. Guestbook Entries: <br />
  603. <dl>
  604. <?php foreach ($this->entries as $entry): ?>
  605. <dt><?php echo $this->escape($entry->email) ?></dt>
  606. <dd><?php echo $this->escape($entry->comment) ?></dd>
  607. <?php endforeach ?>
  608. </dl>
  609. ]]></programlisting>
  610. <note>
  611. <title>Punkt kontrolny</title>
  612. <para>
  613. Teraz, po przejściu do "http://localhost/guestbook" powinna się pojawić lista
  614. zapisanych rekordów:
  615. </para>
  616. <para>
  617. <inlinegraphic width="525" scale="100" align="center" valign="middle"
  618. fileref="figures/learning.quickstart.create-model.png" format="PNG" />
  619. </para>
  620. </note>
  621. <note>
  622. <title>Użycie skryptu ładującego dane</title>
  623. <para>
  624. Skrypt ładujący dane pokazany we wcześniejszej części tego rozdziału
  625. (<filename>scripts/load.sqlite.php</filename>) może zostać użyty do utworzenia
  626. bazy danych jak i do zaimportowania przykładowych danych dla każdego środowiska.
  627. Wewnętrznie korzysta z klasy <classname>Zend_Console_Getopt</classname>, dzięki
  628. czemu możliwe jest podanie parametrów sterujących skryptem. Podając parametr
  629. "-h" lub "--help" można zapoznać się z dostępnymi opcjami:
  630. </para>
  631. <programlisting language="php"><![CDATA[
  632. Usage: load.sqlite.php [ options ]
  633. --withdata|-w Load database with sample data
  634. --env|-e [ ] Application environment for which to create database
  635. (defaults to development)
  636. --help|-h Help -- usage message)]]
  637. ]]></programlisting>
  638. <para>
  639. Parametr "-e" pozwala na nadanie wartości stałej <constant>APPLICATION_ENV</constant>
  640. określającej środowisko co, z kolei, umożliwia utworzenie bazy danych SQLite dla
  641. każdego środowiska oddzielnie. Należy się upewnić, że skrypt jest uruchamiany z
  642. odpowiednią wartością tego parametru dla każdego ze środowisk.
  643. </para>
  644. </note>
  645. </sect1>