Zend_View-Scripts.xml 12 KB

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