Zend_View-Scripts.xml 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463
  1. <sect1 id="zend.view.scripts">
  2. <title>Skrypty widoków</title>
  3. <para>
  4. Kiedy już kontroler przypisze zmienne i wywoła metodę render(),
  5. Zend_View dołącza wymagany skrypt widoku i wykonuje go "wewnątrz"
  6. instancji Zend_View. Dlatego w skrypcie widoku, odwołania do zmiennych
  7. i metod obsługiwane są za pomocą $this.
  8. </para>
  9. <para>
  10. Zmienne przypisane do widoku przez kontroler odnoszszą się do właściwości
  11. tej instancji. Na przykład, jeśli kontroler przypisał zmienną 'cos', w
  12. skrypcie widoku możesz odwołać się do niej za pomocą $this->cos.
  13. (To pozwala Ci na śledzenie zmiennych które zostały przypisane do skryptu
  14. i tych które są zmiennymi wewnętrznymi skryptu).
  15. </para>
  16. <para>
  17. W celu przypomnienia, oto przykład skryptu widoku pokazanego we wprowadzeniu
  18. do Zend_View.
  19. </para>
  20. <programlisting role="php"><![CDATA[
  21. if ($this->books): ?>
  22. <!-- Tabela z książkami. -->
  23. <table>
  24. <tr>
  25. <th>Autor</th>
  26. <th>Tytuł</th>
  27. </tr>
  28. <?php foreach ($this->books as $key => $val): ?>
  29. <tr>
  30. <td><?php echo $this->escape($val['author']) ?></td>
  31. <td><?php echo $this->escape($val['title']) ?></td>
  32. </tr>
  33. <?php endforeach; ?>
  34. </table>
  35. <?php else: ?>
  36. <p>Nie ma żadnych książek do wyświetlenia.</p>
  37. <?php endif;
  38. ]]>
  39. </programlisting>
  40. <sect2 id="zend.view.scripts.escaping">
  41. <title>Filtrowanie danych wyjściowych</title>
  42. <para>
  43. Jedną z najważniejszych rzeczy do zrobienia w skrypcie widoku
  44. jest uzyskanie pewności, że dane wyjściowe zostały prawidłowo
  45. przefiltrowane. Pomaga to w przeciwdziałaniu atakom XSS. Jeśli
  46. nie używasz funkcji, metody lub helpera w celu
  47. filtrowania danych wyjściowych, powinieneś zawsze je filtrować
  48. wtedy gdy chcesz je wyświetlić.
  49. </para>
  50. <para>
  51. Zend_View dostarcza metodę zwaną escape() która filtruje dane
  52. wyjściowe.
  53. </para>
  54. <programlisting role="php"><![CDATA[
  55. // zły zwyczaj wyświetlania zmiennej:
  56. echo $this->variable;
  57. // dobry zwyczaj wyświetlania zmiennej:
  58. echo $this->escape($this->variable);
  59. ]]>
  60. </programlisting>
  61. <para>
  62. Domyślnie metoda escape() używa funkcji PHP htmlspecialchars() do
  63. filtrowania danych wyjściowych. Jakkolwiek, zależenie od Twojego
  64. środowiska możesz chciec filtrować dane wyjściowe w inny sposób.
  65. Użyj metody setEscape() na poziomie kontrolera by przekazać istancji
  66. Zend_View informację o tym, jakiej metody filtrowania ma używać.
  67. </para>
  68. <programlisting role="php"><![CDATA[
  69. // utwórz instancje Zend_View
  70. $view = new Zend_View();
  71. // wybierz funkcję htmlentities() jako metodę filtrowania
  72. $view->setEscape('htmlentities');
  73. // lub wybierz statyczną klasę jako metodę filtrowania
  74. $view->setEscape(array('SomeClass', 'methodName'));
  75. // lub instancję
  76. $obj = new SomeClass();
  77. $view->setEscape(array($obj, 'methodName'));
  78. // a teraz wygeneruj skrypt widoku
  79. echo $view->render(...);
  80. ]]>
  81. </programlisting>
  82. <para>
  83. Metoda lub funkcja filtrująca powinna przyjmować wartość do
  84. przefiltrowania jako pierwszy parametr, a wszystkie inne parametry
  85. powinny być opcjonalne.
  86. </para>
  87. </sect2>
  88. <sect2 id="zend.view.scripts.templates">
  89. <title>Użycie alternatywnych systemów szablonów</title>
  90. <para>
  91. Chociaż PHP jest sam w sobie potężnym systemem szablonów, wielu
  92. programistów czuje, że jest on jednak zbyt potężny lub skomplikowany
  93. dla projektantów szablonów i mogą chcieć użyć alternatywnego systemu
  94. szablonów. Zend_View zapewnia do tego dwa mechanizmy, pierwszy przez
  95. skrypty widoku, drugi przez zaimplementowanie interfejsu
  96. Zend_View_Interface.
  97. </para>
  98. <sect3 id="zend.view.scripts.templates.scripts">
  99. <title>Systemy szablonów używające skryptów widoku</title>
  100. <para>
  101. Skrypt widoku może być użyty w celu utworzenia instancji
  102. i manipulowania osobnym obiektem szablonu, takim jak np.
  103. szablon PHPLIB. Skrypt widoku w takim przypadku mógłby wyglądać
  104. mniej więcej tak:
  105. </para>
  106. <programlisting role="php"><![CDATA[
  107. include_once 'template.inc';
  108. $tpl = new Template();
  109. if ($this->books) {
  110. $tpl->setFile(array(
  111. "booklist" => "booklist.tpl",
  112. "eachbook" => "eachbook.tpl",
  113. ));
  114. foreach ($this->books as $key => $val) {
  115. $tpl->set_var('author', $this->escape($val['author']);
  116. $tpl->set_var('title', $this->escape($val['title']);
  117. $tpl->parse("books", "eachbook", true);
  118. }
  119. $tpl->pparse("output", "booklist");
  120. } else {
  121. $tpl->setFile("nobooks", "nobooks.tpl")
  122. $tpl->pparse("output", "nobooks");
  123. }
  124. ]]>
  125. </programlisting>
  126. <para>
  127. I mogłoby to być powiązane z takim plikiem szablonu:
  128. </para>
  129. <programlisting role="html"><![CDATA[
  130. <!-- booklist.tpl -->
  131. <table>
  132. <tr>
  133. <th>Autor</th>
  134. <th>Tytuł</th>
  135. </tr>
  136. {books}
  137. </table>
  138. <!-- eachbook.tpl -->
  139. <tr>
  140. <td>{author}</td>
  141. <td>{title}</td>
  142. </tr>
  143. <!-- nobooks.tpl -->
  144. <p>Nie ma żadnych książek do wyświetlenia.</p>
  145. ]]>
  146. </programlisting>
  147. </sect3>
  148. <sect3 id="zend.view.scripts.templates.interface">
  149. <title>Systemy szablonów używające interfejsu Zend_View_Interface</title>
  150. <para>
  151. Niektórzy mogą zrobić to łatwiej zapewniając w prosty sposób system
  152. szablonów kompatybilny z Zend_View. <code>Zend_View_Interface</code>
  153. definiuje minimalny interfejs potrzebny dla kompatybilności.
  154. </para>
  155. <programlisting role="php"><![CDATA[
  156. /**
  157. * Zwraca aktualny obiekt systemu szablonów
  158. */
  159. public function getEngine();
  160. /**
  161. * Ustawia ścieżkę do skryptów/szablonów widoku
  162. */
  163. public function setScriptPath($path);
  164. /**
  165. * Ustawia bazową ścieżkę dla wszystkich zasobów widoków
  166. */
  167. public function setBasePath($path, $prefix = 'Zend_View');
  168. /**
  169. * Dodaje dodatkową ścieżkę dla wszystkich zasobów widoków
  170. */
  171. public function addBasePath($path, $prefix = 'Zend_View');
  172. /**
  173. * Zwraca obecne ścieżki skryptów widoków
  174. */
  175. public function getScriptPaths();
  176. /**
  177. * Nadpisanie metod do przypisywania zmiennych
  178. * szablonów jako właściwości obiektu
  179. */
  180. public function __set($key, $value);
  181. public function __get($key);
  182. public function __isset($key);
  183. public function __unset($key);
  184. /**
  185. * Ręczne przypisywanie zmiennych szablonu,
  186. * lub możliwość przypisania wielu
  187. * zmiennych na raz.
  188. */
  189. public function assign($spec, $value = null);
  190. /**
  191. * Czyści wszystkie przypisane zmienne.
  192. */
  193. public function clearVars();
  194. /**
  195. * Renderowanie szablonu o nazwie $name
  196. */
  197. public function render($name);
  198. ]]>
  199. </programlisting>
  200. <para>
  201. Używając tego interfejsu, relatywnie proste staje się podpięcie
  202. zewnętrznego systemu szablonów jako klasy kompatybilnej z
  203. Zend_View. Przykładowo, poniższy przyklad to podpięcie systemu Smarty:
  204. </para>
  205. <programlisting role="php"><![CDATA[
  206. class Zend_View_Smarty implements Zend_View_Interface
  207. {
  208. /**
  209. * Obiekt Smarty
  210. * @var Smarty
  211. */
  212. protected $_smarty;
  213. /**
  214. * Konstruktor
  215. *
  216. * @param string $tmplPath
  217. * @param array $extraParams
  218. * @return void
  219. */
  220. public function __construct($tmplPath = null, $extraParams = array())
  221. {
  222. $this->_smarty = new Smarty;
  223. if (null !== $tmplPath) {
  224. $this->setScriptPath($tmplPath);
  225. }
  226. foreach ($extraParams as $key => $value) {
  227. $this->_smarty->$key = $value;
  228. }
  229. }
  230. /**
  231. * Zwraca aktualny obiekt systemu szablonów
  232. *
  233. * @return Smarty
  234. */
  235. public function getEngine()
  236. {
  237. return $this->_smarty;
  238. }
  239. /**
  240. * Ustawia ścieżkę do szablonów
  241. *
  242. * @param string $path Ścieżka.
  243. * @return void
  244. */
  245. public function setScriptPath($path)
  246. {
  247. if (is_readable($path)) {
  248. $this->_smarty->template_dir = $path;
  249. return;
  250. }
  251. throw new Exception('Nieprawidłowa ścieżka');
  252. }
  253. /**
  254. * Zwraca obecną ścieżkę szablonów
  255. *
  256. * @return string
  257. */
  258. public function getScriptPaths()
  259. {
  260. return array($this->_smarty->template_dir);
  261. }
  262. /**
  263. * Alias dla setScriptPath
  264. *
  265. * @param string $path
  266. * @param string $prefix Unused
  267. * @return void
  268. */
  269. public function setBasePath($path, $prefix = 'Zend_View')
  270. {
  271. return $this->setScriptPath($path);
  272. }
  273. /**
  274. * Alias dla setScriptPath
  275. *
  276. * @param string $path
  277. * @param string $prefix Unused
  278. * @return void
  279. */
  280. public function addBasePath($path, $prefix = 'Zend_View')
  281. {
  282. return $this->setScriptPath($path);
  283. }
  284. /**
  285. * Przypisanie zmiennej do szablonu
  286. *
  287. * @param string $key Nazwa zmiennej.
  288. * @param mixed $val Wartość zmiennej.
  289. * @return void
  290. */
  291. public function __set($key, $val)
  292. {
  293. $this->_smarty->assign($key, $val);
  294. }
  295. /**
  296. * Pobiera przypisaną zmienną
  297. *
  298. * @param string $key Nazwa zmiennej
  299. * @return mixed Wartość zmiennej.
  300. */
  301. public function __get($key)
  302. {
  303. return $this->_smarty->get_template_vars($key);
  304. }
  305. /**
  306. * Pozwala działać funkcjom empty() oraz
  307. * isset() na właściwościach obiektu
  308. *
  309. * @param string $key
  310. * @return boolean
  311. */
  312. public function __isset($key)
  313. {
  314. return (null !== $this->_smarty->get_template_vars($key));
  315. }
  316. /**
  317. * Pozwala działać funkcji unset() na właściwości obiektu
  318. *
  319. * @param string $key
  320. * @return void
  321. */
  322. public function __unset($key)
  323. {
  324. $this->_smarty->clear_assign($key);
  325. }
  326. /**
  327. * Przypisywanie zmiennych do szablonu
  328. *
  329. * Pozwala przypisać określoną wartość do określonego
  330. * klucza, LUB przekazać tablicę par klucz => wartość
  331. * aby przypisać je wszystkie na raz.
  332. *
  333. * @see __set()
  334. * @param string|array $spec Strategia przypisania (klucz
  335. * lub tablica par klucz=> wartość)
  336. * @param mixed $value (Opcjonalny) Gdy przypisujesz
  337. * nazwaną zmienną, użyj go jako wartości.
  338. * @return void
  339. */
  340. public function assign($spec, $value = null)
  341. {
  342. if (is_array($spec)) {
  343. $this->_smarty->assign($spec);
  344. return;
  345. }
  346. $this->_smarty->assign($spec, $value);
  347. }
  348. /**
  349. * Czyści wszystkie przypisane zmienne.
  350. *
  351. * Czyści wszystkie zmienne przypisane do Zend_View za pomocą
  352. * {@link assign()} lub przeładowania właściwości
  353. * ({@link __get()}/{@link __set()}).
  354. *
  355. * @return void
  356. */
  357. public function clearVars()
  358. {
  359. $this->_smarty->clear_all_assign();
  360. }
  361. /**
  362. * Renderuje szablon i zwraca dane wyjściowe.
  363. *
  364. * @param string $name Nazwa szablonu do renderowania.
  365. * @return string Dane wyjściowe.
  366. */
  367. public function render($name)
  368. {
  369. return $this->_smarty->fetch($name);
  370. }
  371. }
  372. ]]>
  373. </programlisting>
  374. <para>
  375. W tym przykładzie powinieneś utworzyć instancję klasy
  376. <code>Zend_View_Smarty</code> zamiast <code>Zend_View</code>,
  377. a następnie używać jej w dokładnie w ten sam sposób jak
  378. <code>Zend_View</code>:
  379. </para>
  380. <programlisting role="php"><![CDATA[
  381. $view = new Zend_View_Smarty();
  382. $view->setScriptPath('/path/to/templates');
  383. $view->book = 'Zend PHP 5 Certification Study Guide';
  384. $view->author = 'Davey Shafik and Ben Ramsey'
  385. $rendered = $view->render('bookinfo.tpl');
  386. ]]>
  387. </programlisting>
  388. </sect3>
  389. </sect2>
  390. </sect1>