Zend_View-Helpers.xml 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622
  1. <sect1 id="zend.view.helpers" xmlns:xi="http://www.w3.org/2001/XInclude">
  2. <title>Klasy helperów</title>
  3. <para>
  4. W skryptach widoków często potrzebne jest przeprowadzanie złożonych
  5. funkcji: na przykład formatowanie daty, generowanie elementów
  6. formularzy, czy wyświetlanie odnośnikow akcji. Możesz użyć klas
  7. helperów w tym celu.
  8. </para>
  9. <para>
  10. Klasa helpera jest prostą klasą. Powiedzmy, że potrzebujemy klasę
  11. helpera o nazwie 'fooBar'. Domyślnie nazwa klasy jest poprzedzona
  12. przedrostkiem <code>'Zend_View_Helper_'</code> (możesz określić własny
  13. przedrostek podczas ustawiania ścieżki do klas helperów), a ostatni
  14. segment nazwy klasy jest nazwą klasy helpera; ten segment powinien
  15. być w postaci TitleCapped; pełna nazwa klasy wygląda więc tak:
  16. <code>Zend_View_Helper_FooBar</code>. Ta klasa powinna zawierać
  17. przynajmniej jedną metodę, nazwaną tak jak klasa helpera, ale już w
  18. postaci camelCased: <code>fooBar()</code>.
  19. </para>
  20. <note>
  21. <title>Zwróć uwagę na wielkość liter</title>
  22. <para>
  23. Nazwy klas helperów są zawsze w postaci camelCased, czyli nigdy
  24. nie zaczynają się wielką literą. Nazwa klasy jest w postaci
  25. MixedCased, ale wywoływana metoda zawsze ma postać camelCased.
  26. </para>
  27. </note>
  28. <note>
  29. <title>Domyślne ścieżki helperów</title>
  30. <para>
  31. Domyślna ścieżka helperów zawsze wskazuje na ścieżkę helperów
  32. widoków Zend Framework np., 'Zend/View/Helper/'. Nawet jeśli
  33. wywołasz metodę <code>setHelperPath()</code> aby nadpisać istniejące
  34. ścieżki, domyślna ścieżka zawsze będzie ustawiona aby być pewnym, że
  35. domyślne helpery będą zawsze działać.
  36. </para>
  37. </note>
  38. <para>
  39. Aby użyć helpera w swoim skrypcie widoku, wywołaj go za pomocą
  40. <code>$this->nazwaHelpera()</code>. Obiekt <code>Zend_View</code>
  41. załaduje klasę <code>Zend_View_Helper_NazwaHelpera</code>, utworzy
  42. obiekt tej klasy i wywoła metodę <code>nazwaHelpera()</code>.
  43. Instancja obiektu istnieje teraz w instancji <code>Zend_View</code> i
  44. będzie ona ponownie używana przy następnych wywołaniach
  45. <code>$this->nazwaHelpera()</code>.
  46. </para>
  47. <sect2 id="zend.view.helpers.initial">
  48. <title>Wbudowane klasy helperów</title>
  49. <para>
  50. <code>Zend_View</code> posiada wbudowany zbiór klas helperów, z
  51. których większość odnosi się do generowania formularzy, a każda z
  52. nich autmatycznie filtruje dane wyjściowe. Dodatkowo dostępne są
  53. klasy helperów służące do tworzenia adresów URL na podstawie tras,
  54. do tworzenia list HTML oraz do deklarowania zmiennych. Obecnie
  55. dostępne klasy helperów to:
  56. </para>
  57. <itemizedlist>
  58. <listitem><para>
  59. <code>declareVars():</code> Głównie używana gdy używamy metody
  60. <code>strictVars()</code>, ta klasa helpera może być użyta
  61. do zadeklarowania zmiennych szablonu, które zostały ustawione
  62. lub nie, w obiekcie widoku. Możemy też użyć jej do ustawienia
  63. domyślnych wartości. Tablice przekazane do metody jako argumenty
  64. zostaną użyte do ustawienia domyślnych wartości; w przeciwnym
  65. razie, gdy zmienna nie istnieje, zostanie ustawiona jako pusty
  66. łańcuch znaków.
  67. </para></listitem>
  68. <listitem><para>
  69. <code>fieldset($name, $content, $attribs):</code> Tworzy element
  70. fieldset. Jeśli tablica <code>$attribs</code> zawiera
  71. klucz 'legend', ta wartość zostanie użyta jako legenda pola
  72. fieldset. Pole fieldset będzie zawierać zawartość przekazaną do
  73. tego helpera przez zmienną <code>$content</code>.
  74. </para></listitem>
  75. <listitem><para>
  76. <code>form($name, $attribs, $content):</code> Generuje formularz.
  77. Wszystkie atrybuty z tablicy <code>$attribs</code> będą
  78. zabezpieczone i zrenderowane jako atrybuty XHTML znacznika form.
  79. Jeśli przekazana jest zmienna <code>$content</code> i ma inną
  80. wartość niż false, to zawartość tej zmiennej zostanie
  81. zrenderowana wraz ze znacznikiem otwierającym i zamykającym
  82. formularz; jeśli zmienna <code>$content</code> ma wartość false
  83. (domyślnie), zostanie zrenderowany tylko znacznik otwierający.
  84. </para></listitem>
  85. <listitem><para>
  86. <code>formButton($name, $value, $attribs):</code> Tworzy element
  87. &lt;button /&gt;.
  88. </para></listitem>
  89. <listitem>
  90. <para>
  91. <code>formCheckbox($name, $value, $attribs,
  92. $options):</code> Tworzy element &lt;input type="checkbox"
  93. /&gt;.
  94. </para>
  95. <para>
  96. Domyślnie, jeśli zmienne $value oraz $options nie są
  97. przekazane, dla pola niezaznaczonego zostanie przyjęta
  98. wartość '0', a dla zaznaczonego wartość '1'.
  99. Jeśli zostanie przekazana zmienna $value, ale nie zostanie
  100. przekazana zmienna $options, dla pola zaznaczonego zostanie
  101. przyjęta wartość zmiennej $value.
  102. </para>
  103. <para>
  104. Zmienna $options powinna być tablicą. Jeśli tablica jest
  105. indeksowana, dla pola zaznaczonego zostanie przyjęta pierwsza
  106. wartość, a druga wartość dla pola niezaznaczonego; wszystkie
  107. inne wartości zostaną zignorowane. Możesz także przekazać
  108. tablicę asocjacyjną z kluczami 'checked' oraz 'unChecked'.
  109. </para>
  110. <para>
  111. Jeśli zmienna $options zostanie przekazana, a wartość
  112. $value jest równa wartości określonej dla pola zaznaczonego,
  113. to element zostanie zaznaczony. Możesz także określić czy
  114. element ma być zaznaczony przekazująć logiczną wartość dla
  115. atrybutu 'checked'.
  116. </para>
  117. <para>
  118. Powyższe najlepiej podsumować za pomocą przykładów:
  119. </para>
  120. <programlisting role="php"><![CDATA[
  121. // '1' oraz '0' jako opcje dla pola zaznaczonego/niezaznaczonego;
  122. // pole jest niezaznaczone
  123. echo $this->formCheckbox('foo');
  124. // '1' oraz '0' jako opcje dla pola zaznaczonego/niezaznaczonego;
  125. // pole jest zaznaczone
  126. echo $this->formCheckbox('foo', null, array('checked' => true));
  127. // 'bar' oraz '0' jako opcje dla pola zaznaczonego/niezaznaczonego;
  128. // pole jest niezaznaczone
  129. echo $this->formCheckbox('foo', 'bar');
  130. // 'bar' oraz '0' jako opcje dla pola zaznaczonego/niezaznaczonego;
  131. // pole jest zaznaczone
  132. echo $this->formCheckbox('foo', 'bar', array('checked' => true));
  133. // 'bar' oraz 'baz' jako opcje dla pola zaznaczonego/niezaznaczonego;
  134. // pole jest niezaznaczone
  135. echo $this->formCheckbox('foo', null, null, array('bar', 'baz');
  136. // 'bar' oraz 'baz' jako opcje dla pola zaznaczonego/niezaznaczonego;
  137. // pole jest niezaznaczone
  138. echo $this->formCheckbox('foo', null, null, array(
  139. 'checked' => 'bar',
  140. 'unChecked' => 'baz'
  141. ));
  142. // 'bar' oraz 'baz' jako opcje dla pola zaznaczonego/niezaznaczonego;
  143. // pole jest zaznaczone
  144. echo $this->formCheckbox('foo', 'bar', null, array('bar', 'baz');
  145. echo $this->formCheckbox('foo',
  146. null,
  147. array('checked' => true),
  148. array('bar', 'baz');
  149. // 'bar' oraz 'baz' jako opcje dla pola zaznaczonego/niezaznaczonego;
  150. // pole jest niezaznaczone
  151. echo $this->formCheckbox('foo', 'baz', null, array('bar', 'baz');
  152. echo $this->formCheckbox('foo',
  153. null,
  154. array('checked' => false),
  155. array('bar', 'baz');
  156. ]]>
  157. </programlisting>
  158. <para>
  159. We wszystkich przypadkach zostanie dołączony ukryty element
  160. z wartością dla pola niezaznaczonego; w ten sposób uzyskamy
  161. pewność, że nawet jeśli pole nie będzie zaznaczone, to do
  162. formularza zostanie przekazana poprawna wartość.
  163. </para>
  164. </listitem>
  165. <listitem>
  166. <para>
  167. <code>formErrors($errors, $options):</code> Generuje listę
  168. nieuporządkowaną zawierająca informacje o błędach. Zmienna
  169. <code>$errors</code> powinna być łańcuchem znaków lub
  170. tablicą łańcuchów znaków; Zmienna <code>$options</code>
  171. powinna zawiierać atrybuty jakie chcesz umieścić w znaczniku
  172. otwierającym listę.
  173. </para>
  174. <para>
  175. Możesz określić alternatywny sposób otwarcia, zamknięcia i
  176. oddzielania informacji o błędach wywołując metody helpera:
  177. </para>
  178. <itemizedlist>
  179. <listitem><para>
  180. <code>setElementStart($string)</code>; domyślną
  181. wartością jest '&lt;ul class="errors"%s"&gt;&lt;li&gt;', gdzie %s
  182. jest zastąpione atrybutami zdefiniowanymi w zmiennej
  183. <code>$options</code>.
  184. </para></listitem>
  185. <listitem><para>
  186. <code>setElementSeparator($string)</code>; domyślną
  187. wartością jest '&lt;/li&gt;&lt;li&gt;'.
  188. </para></listitem>
  189. <listitem><para>
  190. <code>setElementEnd($string)</code>; domyślną
  191. wartością jest '&lt;/li&gt;&lt;/ul&gt;'.
  192. </para></listitem>
  193. </itemizedlist>
  194. </listitem>
  195. <listitem><para>
  196. <code>formFile($name, $value, $attribs):</code> Tworzy element
  197. &lt;input type="file" /&gt;.
  198. </para></listitem>
  199. <listitem><para>
  200. <code>formHidden($name, $value, $attribs):</code> Tworzy element
  201. &lt;input type="hidden" /&gt;.
  202. </para></listitem>
  203. <listitem><para>
  204. <code>formLabel($name, $value, $attribs):</code> Tworzy element
  205. &lt;label&gt;, nadając atrybutowi <code>for</code> wartość
  206. zmiennej <code>$name</code> i ustawiając jako etykietę wartość
  207. zmiennej <code>$value</code>.
  208. Jeśli opcja <code>disable</code> zostanie przekazana w zmiennej
  209. <code>$attribs</code>, żaden kod nie zostanie zwrócony.
  210. </para></listitem>
  211. <listitem><para>
  212. <code>formMultiCheckbox($name, $value, $attribs, $options,
  213. $listsep):</code> Tworzy listę elementów checkbox. Zmienna
  214. <code>$options</code> powinna być asocjacyjną tablicą, i może
  215. mieć dowolne rozmiary. Zmienna <code>$value</code> może być
  216. pojedynczą wartością lub tablicą wartości, które odpowiadają
  217. kluczom tablicy <code>$options</code>. Zmienna
  218. <code>$listsep</code> jest separatorem elementów, domyślnie ma
  219. wartość &lt;br /&gt;. Domyślnie ten element jest traktowany jako
  220. tablica; wszystkie pola mają te samą nazwę i będą wysłane jako
  221. tablica.
  222. </para></listitem>
  223. <listitem><para>
  224. <code>formPassword($name, $value, $attribs):</code> Tworzy
  225. element &lt;input type="password" /&gt;.
  226. </para></listitem>
  227. <listitem><para>
  228. <code>formRadio($name, $value, $attribs, $options):</code>
  229. Tworzy serię elementów &lt;input type="radio" /&gt;, po jednym
  230. dla każdego elementu tablicy $options. W tablicy $options, klucz
  231. jest wartością przycisku radio, a wartość elementu tablicy
  232. jest etykietą przycisku radio. Zmienna $value określa wartość
  233. przycisku, który ma być początkowo zaznaczony.
  234. </para></listitem>
  235. <listitem><para>
  236. <code>formReset($name, $value, $attribs):</code> Tworzy element
  237. &lt;input type="reset" /&gt;.
  238. </para></listitem>
  239. <listitem><para>
  240. <code>formSelect($name, $value, $attribs, $options):</code>
  241. Tworzy blok &lt;select&gt;...&lt;/select&gt;, z elementami
  242. &lt;option&gt; po jednym dla każdego elementu tablicy $options.
  243. W tablicy $options klucz jest wartościa elementu, a wartość
  244. jest etykietą. Zmienna $value określa wartośc elementu (lub
  245. elementów), który ma być początkowo zaznaczony.
  246. </para></listitem>
  247. <listitem><para>
  248. <code>formSubmit($name, $value, $attribs):</code> Tworzy element
  249. &lt;input type="submit" /&gt;.
  250. </para></listitem>
  251. <listitem><para>
  252. <code>formText($name, $value, $attribs):</code> Tworzy element
  253. &lt;input type="text" /&gt;.
  254. </para></listitem>
  255. <listitem><para>
  256. <code>formTextarea($name, $value, $attribs):</code> Tworzy
  257. element &lt;textarea&gt;...&lt;/textarea&gt;.
  258. </para></listitem>
  259. <listitem><para>
  260. <code>url($urlOptions, $name, $reset):</code> Tworzy adres URL
  261. na podstawie nazwy trasy. Parametr <code>$urlOptions</code>
  262. powinien być tablicą asocjacyjną zawierającą pary klucz/wartość
  263. używane przez daną trasę.
  264. </para></listitem>
  265. <listitem><para>
  266. <code>htmlList($items, $ordered, $attribs, $escape):</code> generuje
  267. uporządkowane oraz nieuporządkowane listy na podstawie
  268. przekazanego do niej parametru <code>$items</code>.
  269. Jeśli parametr <code>$items</code> jest wielowymiarową tablicą,
  270. zostanie zbudowana lista zagnieżdżona. Jeśli flaga <code>$escape</code>
  271. ma wartość true (domyślnie), każdy z elementów zostanie
  272. zabezpieczony za pomocą mechanizmu zarejestrowanego w obiekcie
  273. widoku; przekaż wartość false aby zezwolić na wyświetlanie kodu
  274. html wewnątrz elementów list.
  275. </para></listitem>
  276. </itemizedlist>
  277. <para>
  278. Użycie tych metod w Twoim skrypcie jest bardzo łatwe, poniżej
  279. znajduje się przykład. Zauważ, że wszystko czego potrzebujesz
  280. to wywołanie tych metod; załadowanie ich i utworzenie instancji
  281. odbędzie się automatycznie.
  282. </para>
  283. <programlisting role="php"><![CDATA[
  284. // wewnątrz skryptu widoku, $this odnosi się do instancji Zend_View.
  285. //
  286. // załóżmy, że już przypisałeś serię elementów opcji jako tablicę
  287. // o nazwie $countries = array('us' => 'United States', 'il' =>
  288. // 'Israel', 'de' => 'Germany').
  289. ?>
  290. <form action="action.php" method="post">
  291. <p><label>Adres Email:
  292. <?php echo $this->formText('email', 'you@example.com', array('size' => 32)) ?>
  293. </label></p>
  294. <p><label>Kraj:
  295. <?php echo $this->formSelect('country', 'us', null, $this->countries) ?>
  296. </label></p>
  297. <p><label>Czy zgadzasz się?
  298. <?php echo $this->formCheckbox('opt_in', 'yes', null, array('yes', 'no')) ?>
  299. </label></p>
  300. </form>
  301. ]]>
  302. </programlisting>
  303. <para>
  304. Rezultat wyglądałby w ten sposób:
  305. </para>
  306. <programlisting role="php"><![CDATA[
  307. <form action="action.php" method="post">
  308. <p><label>Adres Email:
  309. <input type="text" name="email" value="you@example.com" size="32" />
  310. </label></p>
  311. <p><label>Kraj:
  312. <select name="country">
  313. <option value="us" selected="selected">United States</option>
  314. <option value="il">Israel</option>
  315. <option value="de">Germany</option>
  316. </select>
  317. </label></p>
  318. <p><label>Czy zgadzasz się?
  319. <input type="hidden" name="opt_in" value="no" />
  320. <input type="checkbox" name="opt_in" value="yes" checked="checked" />
  321. </label></p>
  322. </form>
  323. ]]>
  324. </programlisting>
  325. <xi:include href="Zend_View-Helpers-Action.xml">
  326. <xi:fallback><xi:include href="../../en/module_specs/Zend_View-Helpers-Action.xml" /></xi:fallback>
  327. </xi:include>
  328. <xi:include href="Zend_View-Helpers-Partial.xml">
  329. <xi:fallback><xi:include href="../../en/module_specs/Zend_View-Helpers-Partial.xml" /></xi:fallback>
  330. </xi:include>
  331. <xi:include href="Zend_View-Helpers-Placeholder.xml">
  332. <xi:fallback><xi:include href="../../en/module_specs/Zend_View-Helpers-Placeholder.xml" /></xi:fallback>
  333. </xi:include>
  334. <xi:include href="Zend_View-Helpers-Doctype.xml">
  335. <xi:fallback><xi:include href="../../en/module_specs/Zend_View-Helpers-Doctype.xml" /></xi:fallback>
  336. </xi:include>
  337. <xi:include href="Zend_View-Helpers-HeadLink.xml">
  338. <xi:fallback><xi:include href="../../en/module_specs/Zend_View-Helpers-HeadLink.xml" /></xi:fallback>
  339. </xi:include>
  340. <xi:include href="Zend_View-Helpers-HeadMeta.xml">
  341. <xi:fallback><xi:include href="../../en/module_specs/Zend_View-Helpers-HeadMeta.xml" /></xi:fallback>
  342. </xi:include>
  343. <xi:include href="Zend_View-Helpers-HeadScript.xml">
  344. <xi:fallback><xi:include href="../../en/module_specs/Zend_View-Helpers-HeadScript.xml" /></xi:fallback>
  345. </xi:include>
  346. <xi:include href="Zend_View-Helpers-HeadStyle.xml">
  347. <xi:fallback><xi:include href="../../en/module_specs/Zend_View-Helpers-HeadStyle.xml" /></xi:fallback>
  348. </xi:include>
  349. <xi:include href="Zend_View-Helpers-HeadTitle.xml">
  350. <xi:fallback><xi:include href="../../en/module_specs/Zend_View-Helpers-HeadTitle.xml" /></xi:fallback>
  351. </xi:include>
  352. <xi:include href="Zend_View-Helpers-HtmlObject.xml">
  353. <xi:fallback><xi:include href="../../en/module_specs/Zend_View-Helpers-HtmlObject.xml" /></xi:fallback>
  354. </xi:include>
  355. <xi:include href="Zend_View-Helpers-InlineScript.xml">
  356. <xi:fallback><xi:include href="../../en/module_specs/Zend_View-Helpers-InlineScript.xml" /></xi:fallback>
  357. </xi:include>
  358. <xi:include href="Zend_View-Helpers-Json.xml">
  359. <xi:fallback><xi:include href="../../en/module_specs/Zend_View-Helpers-Json.xml" /></xi:fallback>
  360. </xi:include>
  361. <xi:include href="Zend_View-Helpers-Translate.xml">
  362. <xi:fallback><xi:include href="../../en/module_specs/Zend_View-Helpers-Translate.xml" /></xi:fallback>
  363. </xi:include>
  364. </sect2>
  365. <sect2 id="zend.view.helpers.paths">
  366. <title>Ścieżki klas helperów</title>
  367. <para>
  368. Tak jak ze skryptami widoków, kontroler może określić stos ścieżek,
  369. w których <code>Zend_View</code> ma szukać klas helperów.
  370. Domyślnie <code>Zend_View</code> szuka klas helperów w katalogu
  371. "Zend/View/Helper/*". Możesz wybrać inny katalog używając metod
  372. <code>setHelperPath()</code> oraz <code>addHelperPath()</code>.
  373. Dodatkowo możesz określić przedrostek klas helperów znajdujących
  374. się w podanej ścieżce aby utworzyć przestrzenie nazw dla klas
  375. helperów. Domyślnie, gdy żaden przedrostek nie zostanie określony,
  376. przyjęty zostanie przedrostek 'Zend_View_Helper_'.
  377. </para>
  378. <programlisting role="php"><![CDATA[
  379. $view = new Zend_View();
  380. // Ustaw ścieżkę na /path/to/more/helpers, z przedrostkiem 'My_View_Helper'
  381. $view->setHelperPath('/path/to/more/helpers', 'My_View_Helper');
  382. ]]>
  383. </programlisting>
  384. <para>
  385. Oczywiście możesz dodawać ścieżki na stos używająć metody
  386. <code>addHelperPath()</code>. Gdy dodajesz ścieżki na stos,
  387. <code>Zend_View</code> będzie szukać klasy helpera począwszy od
  388. ostatnio dodanej ścieżki. To pozwala na dodanie (lub nawet
  389. nadpisanie) podstawowego pakietu klas helperów swoimi własnymi
  390. klasami.
  391. </para>
  392. <programlisting role="php"><![CDATA[
  393. $view = new Zend_View();
  394. // Dodaj ścieżkę /path/to/some/helpers z przedrostkiem
  395. // klasy 'My_View_Helper'
  396. $view->addHelperPath('/path/to/some/helpers', 'My_View_Helper');
  397. // Dodaj ścieżkę /other/path/to/helpers z przedrostkiem
  398. // klasy 'Your_View_Helper'
  399. $view->addHelperPath('/other/path/to/helpers', 'Your_View_Helper');
  400. // teraz kiedy wywołasz $this->helperName(), Zend_View będzie
  401. // wpierw szukał w "/path/to/some/helpers/HelperName" używając
  402. // nazwy klasy "Your_View_Helper_HelperName",
  403. // następnie w "/other/path/to/helpers/HelperName.php" używając
  404. // nazwy klasy "My_View_Helper_HelperName"
  405. // i ostatecznie w "Zend/View/Helper/HelperName.php" używając
  406. // nazwy klasy "Zend_View_Helper_HelperName".
  407. ]]>
  408. </programlisting>
  409. </sect2>
  410. <sect2 id="zend.view.helpers.custom">
  411. <title>Pisanie własnych klas helperów</title>
  412. <para>
  413. Pisanie własnych klas helperów jest łatwe; po prostu pisz według
  414. poniższych zasad:
  415. </para>
  416. <itemizedlist>
  417. <listitem><para>
  418. Minimalna nazwa klasy musi kończyć się nazwą helpera przy
  419. użyciu MixedCaps. Przykładowo, jeśli piszesz klasę helpera
  420. zwaną "twojHelper", minimalną nazwą klasy musi być
  421. "TwojHelper". Możesz, a nawet powinieneś nadać nazwie klasy
  422. przedrostek i jest zalecane, abyś użył 'View_Helper' jako
  423. części przedrostka: "My_View_Helper_TwojHelper". (Przedrostek
  424. będziesz musiał przekazać wraz z końcowym znakiem podkreślenia
  425. lub bez niego, do metod <code>addHelperPath()</code> oraz
  426. <code>setHelperPath()</code>).
  427. </para></listitem>
  428. <listitem><para>
  429. Nazwa klasy musi przynajmniej składać się z nazwy helpera,
  430. używając formy MixedCaps. Np. jeśli tworzysz helper nazwany
  431. "twojHelper", nazwą klasy musi być przynajmniej "TwojHelper".
  432. Możesz, a nawet powinieneś dać nazwie klasy przedostek i jest
  433. zalecane aby znalazła się w nim część 'View_Helper' aby cała
  434. nazwa klasy wyglądała mniej więcej tak: "My_View_Helper_TwojHelper".
  435. (Będziesz musiał przekazać ten przedrostek, ze końcowym znakiem
  436. podkreślenia lub bez, do jednej z metod <code>addHelperPath()</code>
  437. lub <code>setHelperPath()</code>).
  438. </para></listitem>
  439. <listitem><para>
  440. Klasa musi posiadać publiczną metodę która jest taka jak nazwa
  441. helpera; jest to metoda która zostanie wywołana gdy skrypt
  442. widoku wywoła "$this->twojHelper()". W przykładzie helpera
  443. "twojHelper", wymaganą deklaracją metody powinno być
  444. "public function twojHelper()".
  445. </para></listitem>
  446. <listitem><para>
  447. Klasa nie powinna wyświetlać ani w inny sposób generować danych
  448. wyjściowych. Zamiast tego powinna zwrócić dane do wyświetlenia.
  449. Zwracane wartości powinny być odpowiednio przefiltrowane.
  450. </para></listitem>
  451. <listitem><para>
  452. Klasa musi znajdować się w pliku odpowiednio do nazwy metody
  453. helpera. Przykładowo dla helpera o nazwie "twojHelper",
  454. plik powinien nazywać się "TwojHelper.php".
  455. </para></listitem>
  456. </itemizedlist>
  457. <para>
  458. Umieść plik klasy helpera w katalogu który był dodany do stosu
  459. ścieżek, a <code>Zend_View</code> automatycznie załaduje klasę,
  460. utworzy instancję, i uruchomi metodę.
  461. </para>
  462. <para>
  463. Poniżej przykład kodu naszego przykładowego helpera
  464. <code>twojHelper</code>:
  465. </para>
  466. <programlisting role="php"><![CDATA[
  467. class My_View_Helper_TwojHelper extends Zend_View_Helper_Abstract
  468. {
  469. protected $_count = 0;
  470. public function twojHelper()
  471. {
  472. $this->_count++;
  473. $output = "I have seen 'The Jerk' {$this->_count} time(s).";
  474. return htmlspecialchars($output);
  475. }
  476. }
  477. ]]>
  478. </programlisting>
  479. <para>
  480. Teraz w skrypcie widoku możesz wywołać helpera
  481. <code>TwojHelper</code> tyle razy ile zechcesz; instancja zostanie
  482. utworzona raz i będzie ona istniała przez cały okres istnienia
  483. instancji <code>Zend_View</code>.
  484. </para>
  485. <programlisting role="php"><![CDATA[
  486. // pamiętaj, że w skrypcie widoku $this odnosi się do instancji Zend_View.
  487. echo $this->twojHelper();
  488. echo $this->twojHelper();
  489. echo $this->twojHelper();
  490. ]]>
  491. </programlisting>
  492. <para>
  493. Dane wyjściowe wyglądałyby w ten sposób:
  494. </para>
  495. <programlisting role="php"><![CDATA[
  496. I have seen 'The Jerk' 1 time(s).
  497. I have seen 'The Jerk' 2 time(s).
  498. I have seen 'The Jerk' 3 time(s).
  499. ]]>
  500. </programlisting>
  501. <para>
  502. Czasem możesz potrzebować uzyskać dostęp do obiektu
  503. <code>Zend_View</code> -- na przykład, jeśli potrzebujesz użyć
  504. zarejestrowanego kodowania, lub chcesz zrenderować inny skrypt
  505. widoku jako część klasy helpera. Aby uzyskać dostęp do obiektu
  506. widoku, klasa helpera powinna posiadać metodę
  507. <code>setView($view)</code>, tak jak poniżej:
  508. </para>
  509. <programlisting role="php"><![CDATA[
  510. class My_View_Helper_ScriptPath
  511. {
  512. public $view;
  513. public function setView(Zend_View_Interface $view)
  514. {
  515. $this->view = $view;
  516. }
  517. public function scriptPath($script)
  518. {
  519. return $this->view->getScriptPath($script);
  520. }
  521. }
  522. ]]>
  523. </programlisting>
  524. <para>
  525. Jeśli twoja klasa helpera posiada metodę <code>setView()</code>,
  526. będzie ona wywołana wtedy, gdy po raz pierwszy zostanie utworzona
  527. instancja klasy helpera i przekazany zostanie obecny obiekt
  528. widoku. Jest to po to, aby przechować obiekt widoku w klasie helpera,
  529. a także po to, aby określić w jaki sposób powinno się uzyskiwać do
  530. tego obiektu dostęp.
  531. </para>
  532. <para>
  533. Jeśli rozszerzasz klasę <code>Zend_View_Helper_Abstract</code>
  534. nie musisz definiować tej metody, ponieważ jest ona zdefiniowana
  535. przez klasę rozszerzaną.
  536. </para>
  537. </sect2>
  538. </sect1>