File: Zend_View-Scripts.xml

package info (click to toggle)
zendframework 1.12.9%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 133,584 kB
  • sloc: xml: 1,311,829; php: 570,173; sh: 170; makefile: 125; sql: 121
file content (466 lines) | stat: -rw-r--r-- 12,553 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 24249 -->
<!-- Reviewed: no -->
<sect1 id="zend.view.scripts">

    <title>Skrypty widoków</title>

    <para>
        Kiedy już kontroler przypisze zmienne i wywoła metodę render(),
        Zend_View dołącza wymagany skrypt widoku i wykonuje go "wewnątrz"
        instancji Zend_View. Dlatego w skrypcie widoku, odwołania do zmiennych
        i metod obsługiwane są za pomocą $this.
    </para>

    <para>
        Zmienne przypisane do widoku przez kontroler odnoszą się do właściwości
        tej instancji. Na przykład, jeśli kontroler przypisał zmienną 'cos', w
        skrypcie widoku możesz odwołać się do niej za pomocą $this->cos.
        (To pozwala Ci na śledzenie zmiennych które zostały przypisane do skryptu
        i tych które są zmiennymi wewnętrznymi skryptu).
    </para>

    <para>
        W celu przypomnienia, oto przykład skryptu widoku pokazanego we wprowadzeniu
        do Zend_View.
    </para>

    <programlisting role="php"><![CDATA[
if ($this->books): ?>

    <!-- Tabela z książkami. -->
    <table>
        <tr>
            <th>Autor</th>
            <th>Tytuł</th>
        </tr>

        <?php foreach ($this->books as $key => $val): ?>
        <tr>
            <td><?php echo $this->escape($val['author']) ?></td>
            <td><?php echo $this->escape($val['title']) ?></td>
        </tr>
        <?php endforeach; ?>

    </table>

<?php else: ?>

    <p>Nie ma żadnych książek do wyświetlenia.</p>

<?php endif;
]]>
    </programlisting>

    <sect2 id="zend.view.scripts.escaping">

        <title>Filtrowanie danych wyjściowych</title>

        <para>
            Jedną z najważniejszych rzeczy do zrobienia w skrypcie widoku
            jest uzyskanie pewności, że dane wyjściowe zostały prawidłowo
            przefiltrowane. Pomaga to w przeciwdziałaniu atakom XSS. Jeśli
            nie używasz funkcji, metody lub helpera w celu
            filtrowania danych wyjściowych, powinieneś zawsze je filtrować
            wtedy gdy chcesz je wyświetlić.
        </para>

        <para>
            Zend_View dostarcza metodę zwaną escape() która filtruje dane
            wyjściowe.
        </para>

        <programlisting role="php"><![CDATA[
// zły zwyczaj wyświetlania zmiennej:
echo $this->variable;

// dobry zwyczaj wyświetlania zmiennej:
echo $this->escape($this->variable);
]]>
        </programlisting>

        <para>
            Domyślnie metoda escape() używa funkcji PHP htmlspecialchars() do
            filtrowania danych wyjściowych. Jakkolwiek, zależenie od Twojego
            środowiska możesz chcieć filtrować dane wyjściowe w inny sposób.
            Użyj metody setEscape() na poziomie kontrolera by przekazać instancji
            Zend_View informację o tym, jakiej metody filtrowania ma używać.
        </para>

        <programlisting role="php"><![CDATA[
// utwórz instancje Zend_View
$view = new Zend_View();

// wybierz funkcję htmlentities() jako metodę filtrowania
$view->setEscape('htmlentities');

// lub wybierz statyczną klasę jako metodę filtrowania
$view->setEscape(array('SomeClass', 'methodName'));

// lub instancję
$obj = new SomeClass();
$view->setEscape(array($obj, 'methodName'));

// a teraz wygeneruj skrypt widoku
echo $view->render(...);
]]>
        </programlisting>

        <para>
            Metoda lub funkcja filtrująca powinna przyjmować wartość do
            przefiltrowania jako pierwszy parametr, a wszystkie inne parametry
            powinny być opcjonalne.
        </para>

    </sect2>

    <sect2 id="zend.view.scripts.templates">

        <title>Użycie alternatywnych systemów szablonów</title>

        <para>
            Chociaż PHP jest sam w sobie potężnym systemem szablonów, wielu
            programistów czuje, że jest on jednak zbyt potężny lub skomplikowany
            dla projektantów szablonów i mogą chcieć użyć alternatywnego systemu
            szablonów. Zend_View zapewnia do tego dwa mechanizmy, pierwszy przez
            skrypty widoku, drugi przez zaimplementowanie interfejsu
            Zend_View_Interface.
        </para>

        <sect3 id="zend.view.scripts.templates.scripts">
            <title>Systemy szablonów używające skryptów widoku</title>

            <para>
                Skrypt widoku może być użyty w celu utworzenia instancji
                i manipulowania osobnym obiektem szablonu, takim jak np.
                szablon PHPLIB. Skrypt widoku w takim przypadku mógłby wyglądać
                mniej więcej tak:
            </para>

            <programlisting role="php"><![CDATA[
include_once 'template.inc';
$tpl = new Template();

if ($this->books) {
    $tpl->setFile(array(
        "booklist" => "booklist.tpl",
        "eachbook" => "eachbook.tpl",
    ));

    foreach ($this->books as $key => $val) {
        $tpl->set_var('author', $this->escape($val['author']);
        $tpl->set_var('title', $this->escape($val['title']);
        $tpl->parse("books", "eachbook", true);
    }

    $tpl->pparse("output", "booklist");
} else {
    $tpl->setFile("nobooks", "nobooks.tpl")
    $tpl->pparse("output", "nobooks");
}
]]>
            </programlisting>

            <para>
                I mogłoby to być powiązane z takim plikiem szablonu:
            </para>

            <programlisting role="html"><![CDATA[
<!-- booklist.tpl -->
<table>
    <tr>
        <th>Autor</th>
        <th>Tytuł</th>
    </tr>
    {books}
</table>

<!-- eachbook.tpl -->
    <tr>
        <td>{author}</td>
        <td>{title}</td>
    </tr>

<!-- nobooks.tpl -->
<p>Nie ma żadnych książek do wyświetlenia.</p>
]]>
            </programlisting>

        </sect3>

        <sect3 id="zend.view.scripts.templates.interface">
            <title>Systemy szablonów używające interfejsu Zend_View_Interface</title>

            <para>
                Niektórzy mogą zrobić to łatwiej zapewniając w prosty sposób system
                szablonów kompatybilny z Zend_View. <code>Zend_View_Interface</code>
                definiuje minimalny interfejs potrzebny dla kompatybilności.
            </para>

            <programlisting role="php"><![CDATA[
/**
 * Zwraca aktualny obiekt systemu szablonów
 */
public function getEngine();

/**
 * Ustawia ścieżkę do skryptów/szablonów widoku
 */
public function setScriptPath($path);

/**
 * Ustawia bazową ścieżkę dla wszystkich zasobów widoków
 */
public function setBasePath($path, $prefix = 'Zend_View');

/**
 * Dodaje dodatkową ścieżkę dla wszystkich zasobów widoków
 */
public function addBasePath($path, $prefix = 'Zend_View');

/**
 * Zwraca obecne ścieżki skryptów widoków
 */
public function getScriptPaths();

/**
 * Nadpisanie metod do przypisywania zmiennych
 * szablonów jako właściwości obiektu
 */
public function __set($key, $value);
public function __get($key);
public function __isset($key);
public function __unset($key);

/**
 * Ręczne przypisywanie zmiennych szablonu,
 * lub możliwość przypisania wielu
 * zmiennych na raz.
 */
public function assign($spec, $value = null);

/**
 * Czyści wszystkie przypisane zmienne.
 */
public function clearVars();

/**
 * Renderowanie szablonu o nazwie $name
 */
public function render($name);
]]>
            </programlisting>

            <para>
                Używając tego interfejsu, relatywnie proste staje się podpięcie
                zewnętrznego systemu szablonów jako klasy kompatybilnej z
                Zend_View. Przykładowo, poniższy przykład to podpięcie systemu Smarty:
            </para>

            <programlisting role="php"><![CDATA[
class Zend_View_Smarty implements Zend_View_Interface
{
    /**
     * Obiekt Smarty
     * @var Smarty
     */
    protected $_smarty;

    /**
     * Konstruktor
     *
     * @param string $tmplPath
     * @param array $extraParams
     * @return void
     */
    public function __construct($tmplPath = null, $extraParams = array())
    {
        $this->_smarty = new Smarty;

        if (null !== $tmplPath) {
            $this->setScriptPath($tmplPath);
        }

        foreach ($extraParams as $key => $value) {
            $this->_smarty->$key = $value;
        }
    }

    /**
     * Zwraca aktualny obiekt systemu szablonów
     *
     * @return Smarty
     */
    public function getEngine()
    {
        return $this->_smarty;
    }

    /**
     * Ustawia ścieżkę do szablonów
     *
     * @param string $path Ścieżka.
     * @return void
     */
    public function setScriptPath($path)
    {
        if (is_readable($path)) {
            $this->_smarty->template_dir = $path;
            return;
        }

        throw new Exception('Nieprawidłowa ścieżka');
    }

    /**
     * Zwraca obecną ścieżkę szablonów
     *
     * @return string
     */
    public function getScriptPaths()
    {
        return array($this->_smarty->template_dir);
    }

    /**
     * Alias dla setScriptPath
     *
     * @param string $path
     * @param string $prefix Unused
     * @return void
     */
    public function setBasePath($path, $prefix = 'Zend_View')
    {
        return $this->setScriptPath($path);
    }

    /**
     * Alias dla setScriptPath
     *
     * @param string $path
     * @param string $prefix Unused
     * @return void
     */
    public function addBasePath($path, $prefix = 'Zend_View')
    {
        return $this->setScriptPath($path);
    }

    /**
     * Przypisanie zmiennej do szablonu
     *
     * @param string $key Nazwa zmiennej.
     * @param mixed $val Wartość zmiennej.
     * @return void
     */
    public function __set($key, $val)
    {
        $this->_smarty->assign($key, $val);
    }

    /**
     * Pobiera przypisaną zmienną
     *
     * @param string $key Nazwa zmiennej
     * @return mixed Wartość zmiennej.
     */
    public function __get($key)
    {
        return $this->_smarty->get_template_vars($key);
    }

    /**
     * Pozwala działać funkcjom empty() oraz
     * isset() na właściwościach obiektu
     *
     * @param string $key
     * @return boolean
     */
    public function __isset($key)
    {
        return (null !== $this->_smarty->get_template_vars($key));
    }

    /**
     * Pozwala działać funkcji unset() na właściwości obiektu
     *
     * @param string $key
     * @return void
     */
    public function __unset($key)
    {
        $this->_smarty->clear_assign($key);
    }

    /**
     * Przypisywanie zmiennych do szablonu
     *
     * Pozwala przypisać określoną wartość do określonego
     * klucza, LUB przekazać tablicę par klucz => wartość
     * aby przypisać je wszystkie na raz.
     *
     * @see __set()
     * @param string|array $spec Strategia przypisania (klucz
     * lub tablica par klucz=> wartość)
     * @param mixed $value (Opcjonalny) Gdy przypisujesz
     * nazwaną zmienną, użyj go jako wartości.
     * @return void
     */
    public function assign($spec, $value = null)
    {
        if (is_array($spec)) {
            $this->_smarty->assign($spec);
            return;
        }

        $this->_smarty->assign($spec, $value);
    }

    /**
     * Czyści wszystkie przypisane zmienne.
     *
     * Czyści wszystkie zmienne przypisane do Zend_View za pomocą
     * {@link assign()} lub przeładowania właściwości
     * ({@link __get()}/{@link __set()}).
     *
     * @return void
     */
    public function clearVars()
    {
        $this->_smarty->clear_all_assign();
    }

    /**
     * Renderuje szablon i zwraca dane wyjściowe.
     *
     * @param string $name Nazwa szablonu do renderowania.
     * @return string Dane wyjściowe.
     */
    public function render($name)
    {
        return $this->_smarty->fetch($name);
    }
}
]]>
            </programlisting>

            <para>
                W tym przykładzie powinieneś utworzyć instancję klasy
                <code>Zend_View_Smarty</code> zamiast <code>Zend_View</code>,
                a następnie używać jej w dokładnie w ten sam sposób jak
                <code>Zend_View</code>:
            </para>

            <programlisting role="php"><![CDATA[
$view = new Zend_View_Smarty();
$view->setScriptPath('/path/to/templates');
$view->book = 'Zend PHP 5 Certification Study Guide';
$view->author = 'Davey Shafik and Ben Ramsey'
$rendered = $view->render('bookinfo.tpl');
]]>
            </programlisting>

        </sect3>
    </sect2>

</sect1>