/
advanced.html
853 lines (799 loc) · 72 KB
/
advanced.html
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
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Extendiendo Twig — Manual de Twig en Español</title>
<link rel="stylesheet" href="_static/tnp.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.9.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/translations.js"></script>
<link rel="shortcut icon" href="_static/icotnp.ico"/>
<link rel="top" title="Manual de Twig en Español" href="index.html" />
<link rel="next" title="Twig por dentro" href="internals.html" />
<link rel="prev" title="Twig para desarrolladores" href="api.html" />
</head>
<body>
<div class="imalogo">
<a href="index.html"><img src="http://gitnacho.github.com/tnp/img/twig/twig-logo.png" alt="Traducciones de Nacho Pacheco" />
<a href="http://gitnacho.github.com/tnp/"><img src="http://gitnacho.github.com/tnp/_static/normaltnp.png" alt="Traducciones de Nacho Pacheco" /></a>
<div class="social">
<a href="https://twitter.com/share" class="twitter-share-button" data-via="esymfony" data-lang="es">Tweet</a>
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
</div>
<div id="searchbox">
<form class="searc " action="search.html" method="get">
<input type="search" name="q" placeholder="Término a buscar" />
<input type="submit" value="Ir" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
<div class="related">
<h3>Navegación</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="Índice General"
accesskey="I">índice</a></li>
<li class="right" >
<a href="internals.html" title="Twig por dentro"
accesskey="N">siguiente</a> |</li>
<li class="right" >
<a href="api.html" title="Twig para desarrolladores"
accesskey="P">anterior</a> |</li>
<li><a href="index.html">Twig en Español</a> »</li>
</ul>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="extendiendo-twig">
<h1>Extendiendo <em>Twig</em><a class="headerlink" href="#extendiendo-twig" title="Enlazar permanentemente con este título">¶</a></h1>
<p><em>Twig</em> se puede extender en muchos aspectos; puedes añadir etiquetas adicionales, filtros, pruebas, operadores, variables globales y funciones. Incluso puedes extender el propio analizador con visitantes de nodo.</p>
<div class="admonition note">
<p class="first admonition-title">Nota</p>
<p class="last">Este capítulo describe cómo extender <em>Twig</em> fácilmente. Si deseas reutilizar tus cambios en diferentes proyectos o si quieres compartirlos con los demás, entonces, debes crear una extensión tal como se describe en el siguiente capítulo.</p>
</div>
<p>Antes de extender <em>Twig</em>, debes entender las diferencias entre todos los diferentes puntos de extensión posibles y cuándo utilizarlos.</p>
<p>En primer lugar, recuerda que el lenguaje de <em>Twig</em> tiene dos construcciones principales:</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">{{</span> <span class="pre">}}</span></tt>: Utilizada para imprimir el resultado de la evaluación de la expresión;</li>
<li><tt class="docutils literal"><span class="pre">{%</span> <span class="pre">%}</span></tt>: Utilizada para ejecutar declaraciones.</li>
</ul>
<p>Para entender por qué <em>Twig</em> expone tantos puntos de extensión, vamos a ver cómo implementar un generador <em>Lorem ipsum</em> (este necesita saber el número de palabras a generar).</p>
<p>Puedes utilizar una <em>etiqueta</em> <tt class="docutils literal"><span class="pre">Lipsum</span></tt>:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span class="cp">{%</span> <span class="k">lipsum</span> <span class="m">40</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<p>Eso funciona, pero usar una etiqueta para <tt class="docutils literal"><span class="pre">lipsum</span></tt> no es una buena idea por al menos tres razones principales:</p>
<ul>
<li><p class="first"><tt class="docutils literal"><span class="pre">lipsum</span></tt> no es una construcción del lenguaje;</p>
</li>
<li><p class="first">La etiqueta produce algo;</p>
</li>
<li><p class="first">La etiqueta no es flexible ya que no la puedes utilizar en una expresión:</p>
<div class="highlight-jinja"><pre>{{ 'algún texto' ~ {% lipsum 40 %} ~ 'algo más de texto' }}</pre>
</div>
</li>
</ul>
<p>De hecho, rara vez es necesario crear etiquetas; y es una muy buena noticia porque las etiquetas son el punto de extensión más complejo de <em>Twig</em>.</p>
<p>Ahora, vamos a utilizar un <em>filtro</em> <tt class="docutils literal"><span class="pre">lipsum</span></tt>:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span class="cp">{{</span> <span class="m">40</span><span class="o">|</span><span class="nf">lipsum</span> <span class="cp">}}</span><span class="x"></span>
</pre></div>
</div>
<p>Una vez más, funciona, pero se ve raro. Un filtro transforma el valor que se le pasa a alguna otra cosa, pero aquí utilizamos el valor para indicar el número de palabras a generar.</p>
<p>En seguida, vamos a utilizar una <em>función</em> <tt class="docutils literal"><span class="pre">lipsum</span></tt>:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span class="cp">{{</span> <span class="nv">lipsum</span><span class="o">(</span><span class="m">40</span><span class="o">)</span> <span class="cp">}}</span><span class="x"></span>
</pre></div>
</div>
<p>Aquí vamos. Para este ejemplo concreto, la creación de una función es el punto de extensión a usar. Y la puedes usar en cualquier lugar en que se acepte una expresión:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span class="cp">{{</span> <span class="s1">'algún texto'</span> <span class="o">~</span> <span class="nv">lipsum</span><span class="o">(</span><span class="m">40</span><span class="o">)</span> <span class="o">~</span> <span class="s1">'algo más de texto'</span> <span class="cp">}}</span><span class="x"></span>
<span class="cp">{%</span> <span class="k">set</span> <span class="nv">lipsum</span> <span class="o">=</span> <span class="nv">lipsum</span><span class="o">(</span><span class="m">40</span><span class="o">)</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<p>Por último pero no menos importante, también puedes utilizar un objeto <em>global</em> con un método capaz de generar texto <em>Lorem Ipsum</em>:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span class="cp">{{</span> <span class="nv">text.lipsum</span><span class="o">(</span><span class="m">40</span><span class="o">)</span> <span class="cp">}}</span><span class="x"></span>
</pre></div>
</div>
<p>Como regla general, utiliza funciones para las características más utilizadas y objetos globales para todo lo demás.</p>
<p>Ten en cuenta lo siguiente cuando quieras extender <em>Twig</em>:</p>
<table border="1" class="docutils">
<colgroup>
<col width="12%" />
<col width="35%" />
<col width="22%" />
<col width="32%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">¿Qué?</th>
<th class="head">¿dificultad para implementarlo?</th>
<th class="head">¿Con qué frecuencia?</th>
<th class="head">¿Cuándo?</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><em>macro</em></td>
<td>trivial</td>
<td>frecuente</td>
<td>Generación de contenido</td>
</tr>
<tr class="row-odd"><td><em>global</em></td>
<td>trivial</td>
<td>frecuente</td>
<td>Objeto ayudante</td>
</tr>
<tr class="row-even"><td><em>function</em></td>
<td>trivial</td>
<td>frecuente</td>
<td>Generación de contenido</td>
</tr>
<tr class="row-odd"><td><em>filter</em></td>
<td>trivial</td>
<td>frecuente</td>
<td>Transformación de valor</td>
</tr>
<tr class="row-even"><td><em>tag</em></td>
<td>complejo</td>
<td>raro</td>
<td>Constructor del lenguaje <em>DSL</em></td>
</tr>
<tr class="row-odd"><td><em>test</em></td>
<td>trivial</td>
<td>raro</td>
<td>Decisión booleana</td>
</tr>
<tr class="row-even"><td><em>operator</em></td>
<td>trivial</td>
<td>raro</td>
<td>Transformación de valores</td>
</tr>
</tbody>
</table>
<div class="section" id="globales">
<h2>Globales<a class="headerlink" href="#globales" title="Enlazar permanentemente con este título">¶</a></h2>
<p>Una variable global es como cualquier otra variable de plantilla, excepto que está disponible en todas las plantillas y macros:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$twig</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Twig_Environment</span><span class="p">(</span><span class="nv">$loader</span><span class="p">);</span>
<span class="nv">$twig</span><span class="o">-></span><span class="na">addGlobal</span><span class="p">(</span><span class="s1">'text'</span><span class="p">,</span> <span class="k">new</span> <span class="nx">Text</span><span class="p">());</span>
</pre></div>
</div>
<p>Entonces puedes utilizar la variable <tt class="docutils literal"><span class="pre">text</span></tt> en cualquier parte de una plantilla:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span class="cp">{{</span> <span class="nv">text.lipsum</span><span class="o">(</span><span class="m">40</span><span class="o">)</span> <span class="cp">}}</span><span class="x"></span>
</pre></div>
</div>
</div>
<div class="section" id="filtros">
<h2>Filtros<a class="headerlink" href="#filtros" title="Enlazar permanentemente con este título">¶</a></h2>
<p>Un filtro es una función <em>PHP</em> regular o un método de objeto que toma el lado izquierdo del filtro (antes del tubo <tt class="docutils literal"><span class="pre">|</span></tt>) como primer argumento y los argumentos adicionales pasados al filtro (entre paréntesis <tt class="docutils literal"><span class="pre">()</span></tt>) como argumentos adicionales.</p>
<p>La definición de un filtro es tan fácil como asociar el nombre del filtro con un ejecutable de <em>PHP</em>. Por ejemplo, digamos que tienes el siguiente código en una plantilla:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span class="cp">{{</span> <span class="s1">'TWIG'</span><span class="o">|</span><span class="nf">lower</span> <span class="cp">}}</span><span class="x"></span>
</pre></div>
</div>
<p>Al compilar esta plantilla para <em>PHP</em>, <em>Twig</em> busca el ejecutable <em>PHP</em> asociado con el filtro <tt class="docutils literal"><span class="pre">lower</span></tt>. El filtro <tt class="docutils literal"><span class="pre">lower</span></tt> es un filtro integrado en <em>Twig</em>, y simplemente se asigna a la función <em>PHP</em> <tt class="docutils literal"><span class="pre">strtolower()</span></tt>. Después de la compilación, el código generado por <em>PHP</em> es más o menos equivalente a:</p>
<div class="highlight-html+php"><div class="highlight"><pre><span class="cp"><?php</span> <span class="k">echo</span> <span class="nb">strtolower</span><span class="p">(</span><span class="s1">'TWIG'</span><span class="p">)</span> <span class="cp">?></span>
</pre></div>
</div>
<p>Como puedes ver, la cadena <tt class="docutils literal"><span class="pre">'TWIG'</span></tt> se pasa como primer argumento a la función de <em>PHP</em>.</p>
<p>Un filtro también puede tomar argumentos adicionales como en el siguiente ejemplo:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span class="cp">{{</span> <span class="nv">now</span><span class="o">|</span><span class="nf">date</span><span class="o">(</span><span class="s1">'d/m/Y'</span><span class="o">)</span> <span class="cp">}}</span><span class="x"></span>
</pre></div>
</div>
<p>En este caso, los argumentos adicionales son pasados a la función después del argumento principal, y el código compilado es equivalente a:</p>
<div class="highlight-html+php"><div class="highlight"><pre><span class="cp"><?php</span> <span class="k">echo</span> <span class="nx">twig_date_format_filter</span><span class="p">(</span><span class="nv">$now</span><span class="p">,</span> <span class="s1">'d/m/Y'</span><span class="p">)</span> <span class="cp">?></span>
</pre></div>
</div>
<p>Vamos a ver cómo crear un nuevo filtro.</p>
<p>En esta sección, vamos a crear un filtro <tt class="docutils literal"><span class="pre">rot13</span></tt>, el cual debe devolver la transformación <a class="reference external" href="http://www.php.net/manual/en/function.str-rot13.php">rot13</a> de una cadena. Aquí está un ejemplo de su uso y los resultados esperados:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span class="cp">{{</span> <span class="s2">"Twig"</span><span class="o">|</span><span class="nf">rot13</span> <span class="cp">}}</span><span class="x"></span>
<span class="c">{# debería mostrar Gjvt #}</span><span class="x"></span>
</pre></div>
</div>
<p>Agregar un filtro es tan sencillo como llamar al método <tt class="docutils literal"><span class="pre">addFilter()</span></tt> en la instancia de <tt class="docutils literal"><span class="pre">Twig_Environment</span></tt>:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$twig</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Twig_Environment</span><span class="p">(</span><span class="nv">$loader</span><span class="p">);</span>
<span class="nv">$twig</span><span class="o">-></span><span class="na">addFilter</span><span class="p">(</span><span class="s1">'rot13'</span><span class="p">,</span> <span class="k">new</span> <span class="nx">Twig_Filter_Function</span><span class="p">(</span><span class="s1">'str_rot13'</span><span class="p">));</span>
</pre></div>
</div>
<p>El segundo argumento de <tt class="docutils literal"><span class="pre">addFilter()</span></tt> es una instancia de <tt class="docutils literal"><span class="pre">Twig_Filter</span></tt>.
Aquí, utilizamos <tt class="docutils literal"><span class="pre">Twig_Filter_Function</span></tt> puesto que el filtro es una función <em>PHP</em>. El primer argumento pasado al constructor <tt class="docutils literal"><span class="pre">Twig_Filter_Function</span></tt> es el nombre de la función <em>PHP</em> a llamar, aquí <tt class="docutils literal"><span class="pre">str_rot13</span></tt>, una función nativa de <em>PHP</em>.</p>
<p>Digamos que ahora deseas poder añadir un prefijo antes de la cadena convertida:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span class="cp">{{</span> <span class="s2">"Twig"</span><span class="o">|</span><span class="nf">rot13</span><span class="o">(</span><span class="s1">'prefijo_'</span><span class="o">)</span> <span class="cp">}}</span><span class="x"></span>
<span class="c">{# debe mostrar prefijo_Gjvt #}</span><span class="x"></span>
</pre></div>
</div>
<p>Como la función <tt class="docutils literal"><span class="pre">str_rot13()</span></tt> de <em>PHP</em> no es compatible con este requisito, vamos a crear una nueva función <em>PHP</em>:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="k">function</span> <span class="nf">project_compute_rot13</span><span class="p">(</span><span class="nv">$string</span><span class="p">,</span> <span class="nv">$prefix</span> <span class="o">=</span> <span class="s1">''</span><span class="p">)</span>
<span class="p">{</span>
<span class="k">return</span> <span class="nv">$prefix</span><span class="o">.</span><span class="nb">str_rot13</span><span class="p">(</span><span class="nv">$string</span><span class="p">);</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Como puedes ver, el argumento <tt class="docutils literal"><span class="pre">prefix</span></tt> del filtro se pasa como un argumento adicional a la función <tt class="docutils literal"><span class="pre">project_compute_rot13()</span></tt>.</p>
<p>La adición de este filtro es tan fácil como antes:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$twig</span><span class="o">-></span><span class="na">addFilter</span><span class="p">(</span> <span class="s1">'rot13'</span><span class="p">,</span>
<span class="k">new</span> <span class="nx">Twig_Filter_Function</span><span class="p">(</span><span class="s1">'project_compute_rot13'</span>
<span class="p">));</span>
</pre></div>
</div>
<p>Para una mejor encapsulación, también puedes definir un filtro como un método estático de una clase. También puedes utilizar la clase <tt class="docutils literal"><span class="pre">Twig_Filter_Function</span></tt> para registrar métodos estáticos, tal como filtros:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$twig</span><span class="o">-></span><span class="na">addFilter</span><span class="p">(</span> <span class="s1">'rot13'</span><span class="p">,</span>
<span class="k">new</span> <span class="nx">Twig_Filter_Function</span><span class="p">(</span><span class="s1">'SomeClass::rot13Filter'</span>
<span class="p">));</span>
</pre></div>
</div>
<div class="admonition tip">
<p class="first admonition-title">Truco</p>
<p class="last">En una extensión, también puedes definir un filtro como un método estático de la clase extendida.</p>
</div>
<div class="section" id="entorno-consciente-de-filtros">
<h3>Entorno consciente de filtros<a class="headerlink" href="#entorno-consciente-de-filtros" title="Enlazar permanentemente con este título">¶</a></h3>
<p>La clase <tt class="docutils literal"><span class="pre">Twig_Filter</span></tt> toma opciones como su último argumento. Por ejemplo, si deseas acceder a la instancia del entorno actual en tu filtro, establece la opción <tt class="docutils literal"><span class="pre">needs_environment</span></tt> a <tt class="docutils literal"><span class="pre">true</span></tt>:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$filter</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Twig_Filter_Function</span><span class="p">(</span> <span class="s1">'str_rot13'</span><span class="p">,</span>
<span class="k">array</span><span class="p">(</span> <span class="s1">'needs_environment'</span> <span class="o">=></span> <span class="k">true</span>
<span class="p">));</span>
</pre></div>
</div>
<p><em>Twig</em> entonces pasará el entorno actual como primer argumento al invocar el filtro:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="k">function</span> <span class="nf">twig_compute_rot13</span><span class="p">(</span><span class="nx">Twig_Environment</span> <span class="nv">$env</span><span class="p">,</span> <span class="nv">$string</span><span class="p">)</span>
<span class="p">{</span>
<span class="c1">// obtiene el juego de caracteres actual, por ejemplo</span>
<span class="nv">$charset</span> <span class="o">=</span> <span class="nv">$env</span><span class="o">-></span><span class="na">getCharset</span><span class="p">();</span>
<span class="k">return</span> <span class="nb">str_rot13</span><span class="p">(</span><span class="nv">$string</span><span class="p">);</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="escapando-automaticamente">
<h3>Escapando automáticamente<a class="headerlink" href="#escapando-automaticamente" title="Enlazar permanentemente con este título">¶</a></h3>
<p>Si está habilitado el escape automático, puedes escapar la salida del filtro antes de imprimir. Si tu filtro actúa como un escapista (o explícitamente produce código <em>html</em> o <em>javascript</em>), desearás que se imprima la salida cruda. En tal caso, establece la opción <tt class="docutils literal"><span class="pre">is_safe</span></tt>:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$filter</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Twig_Filter_Function</span><span class="p">(</span> <span class="s1">'nl2br'</span><span class="p">,</span>
<span class="k">array</span><span class="p">(</span><span class="s1">'is_safe'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span><span class="s1">'html'</span><span class="p">)</span>
<span class="p">));</span>
</pre></div>
</div>
<p>Algunos filtros posiblemente tengan que trabajar en valores ya escapados o seguros. En tal caso, establece la opción <tt class="docutils literal"><span class="pre">pre_escape</span></tt>:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$filter</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Twig_Filter_Function</span><span class="p">(</span> <span class="s1">'somefilter'</span><span class="p">,</span>
<span class="k">array</span><span class="p">(</span> <span class="s1">'pre_escape'</span> <span class="o">=></span> <span class="s1">'html'</span><span class="p">,</span>
<span class="s1">'is_safe'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span><span class="s1">'html'</span><span class="p">)</span>
<span class="p">));</span>
</pre></div>
</div>
</div>
<div class="section" id="filtros-dinamicos">
<h3>Filtros dinámicos<a class="headerlink" href="#filtros-dinamicos" title="Enlazar permanentemente con este título">¶</a></h3>
<p class="versionadded">
<span class="versionmodified">Nuevo en la versión 1.5: </span>El apoyo a los filtros dinámicos se añadió en <em>Twig</em> 1.5.</p>
<p>Un nombre de filtro que contiene el carácter especial <tt class="docutils literal"><span class="pre">*</span></tt> es un filtro dinámico debido a que el <tt class="docutils literal"><span class="pre">*</span></tt> puede ser cualquier cadena:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$twig</span><span class="o">-></span><span class="na">addFilter</span><span class="p">(</span><span class="s1">'*_path'</span><span class="p">,</span> <span class="k">new</span> <span class="nx">Twig_Filter_Function</span><span class="p">(</span><span class="s1">'twig_path'</span><span class="p">));</span>
<span class="k">function</span> <span class="nf">twig_path</span><span class="p">(</span><span class="nv">$name</span><span class="p">,</span> <span class="nv">$arguments</span><span class="p">)</span>
<span class="p">{</span>
<span class="c1">// ...</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Los siguientes filtros deben corresponder con el filtro dinámico definido anteriormente:</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">product_path</span></tt></li>
<li><tt class="docutils literal"><span class="pre">category_path</span></tt></li>
</ul>
<p>Un filtro dinámico puede definir más de una parte dinámica:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$twig</span><span class="o">-></span><span class="na">addFilter</span><span class="p">(</span><span class="s1">'*_path_*'</span><span class="p">,</span> <span class="k">new</span> <span class="nx">Twig_Filter_Function</span><span class="p">(</span><span class="s1">'twig_path'</span><span class="p">));</span>
<span class="k">function</span> <span class="nf">twig_path</span><span class="p">(</span><span class="nv">$name</span><span class="p">,</span> <span class="nv">$suffix</span><span class="p">,</span> <span class="nv">$arguments</span><span class="p">)</span>
<span class="p">{</span>
<span class="c1">// ...</span>
<span class="p">}</span>
</pre></div>
</div>
<p>El filtro debe recibir todos los valores de las partes dinámicas antes de los argumentos normales de los filtros. Por ejemplo, una llamada a <tt class="docutils literal"><span class="pre">'foo'|a_path_b()</span></tt> resultará en la siguiente llamada <em>PHP</em>: <tt class="docutils literal"><span class="pre">twig_path('a',</span> <span class="pre">'b',</span> <span class="pre">'foo')</span></tt>.</p>
</div>
</div>
<div class="section" id="funciones">
<h2>Funciones<a class="headerlink" href="#funciones" title="Enlazar permanentemente con este título">¶</a></h2>
<p>Una función es una función <em>PHP</em> regular o un método de objeto que puedes llamar desde las plantillas.</p>
<div class="highlight-jinja"><div class="highlight"><pre><span class="cp">{{</span> <span class="nv">constant</span><span class="o">(</span><span class="s2">"DATE_W3C"</span><span class="o">)</span> <span class="cp">}}</span><span class="x"></span>
</pre></div>
</div>
<p>Al compilar esta plantilla para <em>PHP</em>, <em>Twig</em> busca el <em>PHP</em> ejecutable asociado con la función <tt class="docutils literal"><span class="pre">constant</span></tt>. La función <tt class="docutils literal"><span class="pre">constant</span></tt> está integrada en las funciones <em>Twig</em>, asignada simplemente a la función <tt class="docutils literal"><span class="pre">constant()</span></tt> de <em>PHP</em>. Después de la compilación, el código generado por <em>PHP</em> es más o menos equivalente a:</p>
<div class="highlight-html+php"><div class="highlight"><pre><span class="cp"><?php</span> <span class="k">echo</span> <span class="nb">constant</span><span class="p">(</span><span class="s1">'DATE_W3C'</span><span class="p">)</span> <span class="cp">?></span>
</pre></div>
</div>
<p>Agregar una función es similar a agregar un filtro. Esto se puede hacer llamando al método <tt class="docutils literal"><span class="pre">addFunction()</span></tt> en la instancia de <tt class="docutils literal"><span class="pre">Twig_Environment</span></tt>:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$twig</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Twig_Environment</span><span class="p">(</span><span class="nv">$loader</span><span class="p">);</span>
<span class="nv">$twig</span><span class="o">-></span><span class="na">addFunction</span><span class="p">(</span><span class="s1">'functionName'</span><span class="p">,</span> <span class="k">new</span> <span class="nx">Twig_Function_Function</span><span class="p">(</span><span class="s1">'someFunction'</span><span class="p">));</span>
</pre></div>
</div>
<p>También puedes exponer los métodos de extensión como funciones en tus plantillas:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="c1">// $this es un objeto que implementa a Twig_ExtensionInterface.</span>
<span class="nv">$twig</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Twig_Environment</span><span class="p">(</span><span class="nv">$loader</span><span class="p">);</span>
<span class="nv">$twig</span><span class="o">-></span><span class="na">addFunction</span><span class="p">(</span><span class="s1">'otherFunction'</span><span class="p">,</span> <span class="k">new</span> <span class="nx">Twig_Function_Method</span><span class="p">(</span> <span class="nv">$this</span><span class="p">,</span>
<span class="s1">'someMethod'</span>
<span class="p">));</span>
</pre></div>
</div>
<p>Las funciones también son compatibles con los parámetros <tt class="docutils literal"><span class="pre">needs_environment</span></tt> e <tt class="docutils literal"><span class="pre">is_safe</span></tt>.</p>
<div class="section" id="funciones-dinamicas">
<h3>Funciones dinámicas<a class="headerlink" href="#funciones-dinamicas" title="Enlazar permanentemente con este título">¶</a></h3>
<p class="versionadded">
<span class="versionmodified">Nuevo en la versión 1.5: </span>La compatibilidad con las funciones dinámicas se añadió en <em>Twig</em> 1.5.</p>
<p>Un nombre de función que contiene el carácter especial <tt class="docutils literal"><span class="pre">*</span></tt> es una función dinámica debido a que el <tt class="docutils literal"><span class="pre">*</span></tt> puede ser cualquier cadena:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$twig</span><span class="o">-></span><span class="na">addFunction</span><span class="p">(</span><span class="s1">'*_path'</span><span class="p">,</span> <span class="k">new</span> <span class="nx">Twig_Function_Function</span><span class="p">(</span><span class="s1">'twig_path'</span><span class="p">));</span>
<span class="k">function</span> <span class="nf">twig_path</span><span class="p">(</span><span class="nv">$name</span><span class="p">,</span> <span class="nv">$arguments</span><span class="p">)</span>
<span class="p">{</span>
<span class="c1">// ...</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Las siguientes funciones deben corresponder con la función dinámica definida anteriormente:</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">product_path</span></tt></li>
<li><tt class="docutils literal"><span class="pre">category_path</span></tt></li>
</ul>
<p>Una función dinámica puede definir más de una parte dinámica:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$twig</span><span class="o">-></span><span class="na">addFilter</span><span class="p">(</span><span class="s1">'*_path_*'</span><span class="p">,</span> <span class="k">new</span> <span class="nx">Twig_Filter_Function</span><span class="p">(</span><span class="s1">'twig_path'</span><span class="p">));</span>
<span class="k">function</span> <span class="nf">twig_path</span><span class="p">(</span><span class="nv">$name</span><span class="p">,</span> <span class="nv">$suffix</span><span class="p">,</span> <span class="nv">$arguments</span><span class="p">)</span>
<span class="p">{</span>
<span class="c1">// ...</span>
<span class="p">}</span>
</pre></div>
</div>
<p>La función debe recibir todos los valores de las partes dinámicas antes de los argumentos normales de las funciones. Por ejemplo, una llamada a <tt class="docutils literal"><span class="pre">a_path_b('foo')</span></tt> resultará en la siguiente llamada <em>PHP</em>: <tt class="docutils literal"><span class="pre">twig_path('a',</span> <span class="pre">'b',</span> <span class="pre">'foo')</span></tt>.</p>
</div>
</div>
<div class="section" id="etiquetas">
<h2>Etiquetas<a class="headerlink" href="#etiquetas" title="Enlazar permanentemente con este título">¶</a></h2>
<p>Una de las características más interesantes de un motor de plantillas como <em>Twig</em> es la posibilidad de definir nuevas construcciones del lenguaje. Esta también es la característica más compleja que necesitas comprender de cómo trabaja <em>Twig</em> internamente.</p>
<p>Vamos a crear una simple etiqueta <tt class="docutils literal"><span class="pre">set</span></tt> que te permita definir variables simples dentro de una plantilla. Puedes utilizar la etiqueta de la siguiente manera:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span class="cp">{%</span> <span class="k">set</span> <span class="nv">name</span> <span class="o">=</span> <span class="s2">"value"</span> <span class="cp">%}</span><span class="x"></span>
<span class="cp">{{</span> <span class="nv">name</span> <span class="cp">}}</span><span class="x"></span>
<span class="c">{# debe producir value #}</span><span class="x"></span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Nota</p>
<p class="last">La etiqueta <tt class="docutils literal"><span class="pre">set</span></tt> es parte de la extensión <tt class="docutils literal"><span class="pre">core</span></tt> y como tal siempre está disponible. La versión integrada es un poco más potente y de manera predeterminada es compatible con múltiples asignaciones (consulta el capítulo <a class="reference internal" href="templates.html"><em>Twig para diseñadores de plantillas</em></a> para más información).</p>
</div>
<p>para definir una nueva etiqueta son necesarios tres pasos:</p>
<ul class="simple">
<li>Definir una clase para analizar segmentos (responsable de analizar el código de la plantilla);</li>
<li>Definir una clase Nodo (responsable de convertir el código analizado a <em>PHP</em>);</li>
<li>Registrar la etiqueta.</li>
</ul>
<div class="section" id="registrando-una-nueva-etiqueta">
<h3>Registrando una nueva etiqueta<a class="headerlink" href="#registrando-una-nueva-etiqueta" title="Enlazar permanentemente con este título">¶</a></h3>
<p>Agregar una etiqueta es tan simple como una llamada al método <tt class="docutils literal"><span class="pre">addTokenParser</span></tt> en la instancia de <tt class="docutils literal"><span class="pre">Twig_Environment</span></tt>:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$twig</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Twig_Environment</span><span class="p">(</span><span class="nv">$loader</span><span class="p">);</span>
<span class="nv">$twig</span><span class="o">-></span><span class="na">addTokenParser</span><span class="p">(</span><span class="k">new</span> <span class="nx">Project_Set_TokenParser</span><span class="p">());</span>
</pre></div>
</div>
</div>
<div class="section" id="definiendo-un-analizador-de-fragmentos">
<h3>Definiendo un analizador de fragmentos<a class="headerlink" href="#definiendo-un-analizador-de-fragmentos" title="Enlazar permanentemente con este título">¶</a></h3>
<p>Ahora, vamos a ver el código real de esta clase:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Project_Set_TokenParser</span> <span class="k">extends</span> <span class="nx">Twig_TokenParser</span>
<span class="p">{</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">parse</span><span class="p">(</span><span class="nx">Twig_Token</span> <span class="nv">$token</span><span class="p">)</span>
<span class="p">{</span>
<span class="nv">$lineno</span> <span class="o">=</span> <span class="nv">$token</span><span class="o">-></span><span class="na">getLine</span><span class="p">();</span>
<span class="nv">$name</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-></span><span class="na">parser</span>
<span class="o">-></span><span class="na">getStream</span><span class="p">()</span>
<span class="o">-></span><span class="na">expect</span><span class="p">(</span><span class="nx">Twig_Token</span><span class="o">::</span><span class="na">NAME_TYPE</span><span class="p">)</span>
<span class="o">-></span><span class="na">getValue</span><span class="p">();</span>
<span class="nv">$this</span><span class="o">-></span><span class="na">parser</span><span class="o">-></span><span class="na">getExpressionParser</span><span class="p">()</span>
<span class="o">-></span><span class="na">expect</span><span class="p">(</span><span class="nx">Twig_Token</span><span class="o">::</span><span class="na">OPERATOR_TYPE</span><span class="p">,</span> <span class="s1">'='</span><span class="p">);</span>
<span class="nv">$value</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-></span><span class="na">parser</span>
<span class="o">-></span><span class="na">getExpressionParser</span><span class="p">()</span>
<span class="o">-></span><span class="na">parseExpression</span><span class="p">();</span>
<span class="nv">$this</span><span class="o">-></span><span class="na">parser</span><span class="o">-></span><span class="na">getStream</span><span class="p">()</span>
<span class="o">-></span><span class="na">expect</span><span class="p">(</span><span class="nx">Twig_Token</span><span class="o">::</span><span class="na">BLOCK_END_TYPE</span><span class="p">);</span>
<span class="k">return</span> <span class="k">new</span> <span class="nx">Project_Set_Node</span><span class="p">(</span> <span class="nv">$name</span><span class="p">,</span>
<span class="nv">$value</span><span class="p">,</span>
<span class="nv">$lineno</span><span class="p">,</span>
<span class="nv">$this</span><span class="o">-></span><span class="na">getTag</span><span class="p">()</span>
<span class="p">);</span>
<span class="p">}</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">getTag</span><span class="p">()</span>
<span class="p">{</span>
<span class="k">return</span> <span class="s1">'set'</span><span class="p">;</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<p>El método <tt class="docutils literal"><span class="pre">getTag()</span></tt> debe devolver la etiqueta que queremos analizar, aquí <tt class="docutils literal"><span class="pre">set</span></tt>.</p>
<p>El método <tt class="docutils literal"><span class="pre">parse()</span></tt> se invoca cada vez que el analizador encuentra una etiqueta <tt class="docutils literal"><span class="pre">set</span></tt>. Este debe devolver una instancia de <tt class="docutils literal"><span class="pre">Twig_Node</span></tt> que representa el nodo (la llamada para la creación del <tt class="docutils literal"><span class="pre">Project_Set_Node</span></tt> se explica en la siguiente sección).</p>
<p>El proceso de análisis se simplifica gracias a un montón de métodos que se pueden llamar desde el fragmento del flujo (<tt class="docutils literal"><span class="pre">$this->parser->getStream()</span></tt>):</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">getCurrent()</span></tt>: Obtiene el segmento actual del flujo.</li>
<li><tt class="docutils literal"><span class="pre">next()</span></tt>: Mueve al siguiente segmento en la secuencia, <em>pero devuelve el antiguo</em>.</li>
<li><tt class="docutils literal"><span class="pre">test($type)</span></tt>, <tt class="docutils literal"><span class="pre">test($value)</span></tt> o <tt class="docutils literal"><span class="pre">test($type,</span> <span class="pre">$value)</span></tt>: Determina si el segmento actual es de un tipo o valor particular (o ambos). El valor puede ser una matriz de varios posibles valores.</li>
<li><tt class="docutils literal"><span class="pre">expect($type[,</span> <span class="pre">$value[,</span> <span class="pre">$message]])</span></tt>: Si el segmento actual no es del tipo/valor dado lanza un error de sintaxis. De lo contrario, si el tipo y valor son correctos, devuelve el segmento y mueve el flujo al siguiente segmento.</li>
<li><tt class="docutils literal"><span class="pre">look()</span></tt>: Busca el siguiente segmento sin consumirlo.</li>
</ul>
<p>Las expresiones de análisis se llevan a cabo llamando a <tt class="docutils literal"><span class="pre">parseExpression()</span></tt> como lo hicimos para la etiqueta <tt class="docutils literal"><span class="pre">set</span></tt>.</p>
<div class="admonition tip">
<p class="first admonition-title">Truco</p>
<p class="last">Leer las clases <tt class="docutils literal"><span class="pre">TokenParser</span></tt> existentes es la mejor manera de aprender todos los detalles esenciales del proceso de análisis.</p>
</div>
</div>
<div class="section" id="definiendo-un-nodo">
<h3>Definiendo un nodo<a class="headerlink" href="#definiendo-un-nodo" title="Enlazar permanentemente con este título">¶</a></h3>
<p>La clase <tt class="docutils literal"><span class="pre">Project_Set_Node</span></tt> en sí misma es bastante simple:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Project_Set_Node</span> <span class="k">extends</span> <span class="nx">Twig_Node</span>
<span class="p">{</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">__construct</span><span class="p">(</span> <span class="nv">$name</span><span class="p">,</span>
<span class="nx">Twig_Node_Expression</span> <span class="nv">$value</span><span class="p">,</span>
<span class="nv">$lineno</span><span class="p">,</span>
<span class="nv">$tag</span> <span class="o">=</span> <span class="k">null</span>
<span class="p">)</span>
<span class="p">{</span>
<span class="k">parent</span><span class="o">::</span><span class="na">__construct</span><span class="p">(</span> <span class="k">array</span><span class="p">(</span> <span class="s1">'value'</span> <span class="o">=></span> <span class="nv">$value</span> <span class="p">),</span>
<span class="k">array</span><span class="p">(</span> <span class="s1">'name'</span> <span class="o">=></span> <span class="nv">$name</span> <span class="p">),</span>
<span class="nv">$lineno</span><span class="p">,</span>
<span class="nv">$tag</span>
<span class="p">);</span>
<span class="p">}</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">compile</span><span class="p">(</span><span class="nx">Twig_Compiler</span> <span class="nv">$compiler</span><span class="p">)</span>
<span class="p">{</span>
<span class="nv">$compiler</span>
<span class="o">-></span><span class="na">addDebugInfo</span><span class="p">(</span><span class="nv">$this</span><span class="p">)</span>
<span class="o">-></span><span class="na">write</span><span class="p">(</span><span class="s1">'$context[\''</span><span class="o">.</span><span class="nv">$this</span><span class="o">-></span><span class="na">getAttribute</span><span class="p">(</span><span class="s1">'name'</span><span class="p">)</span><span class="o">.</span><span class="s1">'\'] = '</span><span class="p">)</span>
<span class="o">-></span><span class="na">subcompile</span><span class="p">(</span><span class="nv">$this</span><span class="o">-></span><span class="na">getNode</span><span class="p">(</span><span class="s1">'value'</span><span class="p">))</span>
<span class="o">-></span><span class="na">raw</span><span class="p">(</span><span class="s2">";</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
<span class="p">;</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<p>El compilador implementa una interfaz fluida y proporciona métodos que ayudan a los desarrolladores a generar código <em>PHP</em> hermoso y fácil de leer:</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">subcompile()</span></tt>: Compila un nodo.</li>
<li><tt class="docutils literal"><span class="pre">raw()</span></tt>: Escribe la cadena dada tal cual.</li>
<li><tt class="docutils literal"><span class="pre">write()</span></tt>: Escribe la cadena dada añadiendo sangría al principio de cada línea.</li>
<li><tt class="docutils literal"><span class="pre">string()</span></tt>: Escribe una cadena entre comillas.</li>
<li><tt class="docutils literal"><span class="pre">repr()</span></tt>: Escribe una representación <em>PHP</em> de un valor dado (consulta <tt class="docutils literal"><span class="pre">Twig_Node_For</span></tt> para un ejemplo real).</li>
<li><tt class="docutils literal"><span class="pre">addDebugInfo()</span></tt>: Agrega como comentario la línea del archivo de plantilla original relacionado con el nodo actual.</li>
<li><tt class="docutils literal"><span class="pre">indent()</span></tt>: Aplica sangrías el código generado (consulta <tt class="docutils literal"><span class="pre">Twig_Node_Block</span></tt> para un ejemplo real).</li>
<li><tt class="docutils literal"><span class="pre">outdent()</span></tt>: Quita la sangría el código generado (consulta <tt class="docutils literal"><span class="pre">Twig_Node_Block</span></tt> para un ejemplo real).</li>
</ul>
</div>
</div>
<div class="section" id="creando-una-extension">
<span id="creating-extensions"></span><h2>Creando una extensión<a class="headerlink" href="#creando-una-extension" title="Enlazar permanentemente con este título">¶</a></h2>
<p>La principal motivación para escribir una extensión es mover el código usado frecuentemente a una clase reutilizable como agregar apoyo para la internacionalización. Una extensión puede definir etiquetas, filtros, pruebas, operadores, variables globales, funciones y visitantes de nodo.</p>
<p>La creación de una extensión también hace una mejor separación del código que se ejecuta en tiempo de compilación y el código necesario en tiempo de ejecución. Por lo tanto, hace que tu código sea más rápido.</p>
<p>La mayoría de las veces, es útil crear una extensión para tu proyecto, para acoger todas las etiquetas y filtros específicos que deseas agregar a <em>Twig</em>.</p>
<div class="admonition note">
<p class="first admonition-title">Nota</p>
<p class="last">Antes de escribir tus propias extensiones, echa un vistazo al repositorio de extensiones oficial de <em>Twig</em>: <a class="reference external" href="http://github.com/fabpot/Twig-extensions">http://github.com/fabpot/Twig-extensions</a>.</p>
</div>
<p>Una extensión es una clase que implementa la siguiente interfaz:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="k">interface</span> <span class="nx">Twig_ExtensionInterface</span>
<span class="p">{</span>
<span class="sd">/**</span>
<span class="sd"> * Inicia el entorno en tiempo de ejecución.</span>
<span class="sd"> *</span>
<span class="sd"> * Aquí es donde puedes cargar algún archivo que contenga funciones</span>
<span class="sd"> * de filtro, por ejemplo.</span>
<span class="sd"> *</span>
<span class="sd"> * @param Twig_Environment $environment La instancia actual de</span>
<span class="sd"> * Twig_Environment</span>
<span class="sd"> */</span>
<span class="k">function</span> <span class="nf">initRuntime</span><span class="p">(</span><span class="nx">Twig_Environment</span> <span class="nv">$environment</span><span class="p">);</span>
<span class="sd">/**</span>
<span class="sd"> * Devuelve instancias del analizador de segmentos para añadirlos a</span>
<span class="sd"> * la lista existente.</span>
<span class="sd"> *</span>
<span class="sd"> * @return array Un arreglo de instancias Twig_TokenParserInterface</span>
<span class="sd"> * o Twig_TokenParserBrokerInterface</span>
<span class="sd"> */</span>
<span class="k">function</span> <span class="nf">getTokenParsers</span><span class="p">();</span>
<span class="sd">/**</span>
<span class="sd"> * Devuelve instancias del visitante de nodos para añadirlas a la</span>
<span class="sd"> * lista existente.</span>
<span class="sd"> *</span>
<span class="sd"> * @return array Un arreglo de instancias de</span>
<span class="sd"> * Twig_NodeVisitorInterface</span>
<span class="sd"> */</span>
<span class="k">function</span> <span class="nf">getNodeVisitors</span><span class="p">();</span>
<span class="sd">/**</span>
<span class="sd"> * Devuelve una lista de filtros para añadirla a la lista</span>
<span class="sd"> * existente.</span>
<span class="sd"> *</span>
<span class="sd"> * @return array Un arreglo de filtros</span>
<span class="sd"> */</span>
<span class="k">function</span> <span class="nf">getFilters</span><span class="p">();</span>
<span class="sd">/**</span>
<span class="sd"> * Devuelve una lista de pruebas para añadirla a la lista</span>
<span class="sd"> * existente.</span>
<span class="sd"> *</span>
<span class="sd"> * @return array Un arreglo de pruebas</span>
<span class="sd"> */</span>
<span class="k">function</span> <span class="nf">getTests</span><span class="p">();</span>
<span class="sd">/**</span>
<span class="sd"> * Devuelve una lista de funciones para añadirla a la lista</span>
<span class="sd"> * existente.</span>
<span class="sd"> *</span>
<span class="sd"> * @return array Un arreglo de funciones</span>
<span class="sd"> */</span>
<span class="k">function</span> <span class="nf">getFunctions</span><span class="p">();</span>
<span class="sd">/**</span>
<span class="sd"> * Devuelve una lista de operadores para añadirla a la lista</span>
<span class="sd"> * existente.</span>
<span class="sd"> *</span>
<span class="sd"> * @return array Un arreglo de operadores</span>
<span class="sd"> */</span>
<span class="k">function</span> <span class="nf">getOperators</span><span class="p">();</span>
<span class="sd">/**</span>
<span class="sd"> * Devuelve una lista de variables globales para añadirla a la</span>
<span class="sd"> * lista existente.</span>
<span class="sd"> *</span>
<span class="sd"> * @return array Un arreglo de variables globales</span>
<span class="sd"> */</span>
<span class="k">function</span> <span class="nf">getGlobals</span><span class="p">();</span>
<span class="sd">/**</span>
<span class="sd"> * Devuelve el nombre de la extensión.</span>
<span class="sd"> *</span>
<span class="sd"> * @return string El nombre de la extensión</span>
<span class="sd"> */</span>
<span class="k">function</span> <span class="nf">getName</span><span class="p">();</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Para mantener tu clase de extensión limpia y ordenada, puedes heredar de la clase <tt class="docutils literal"><span class="pre">Twig_Extension</span></tt> incorporada en lugar de implementar toda la interfaz. De esta forma, sólo tienes que implementar el método <tt class="docutils literal"><span class="pre">getName()</span></tt> como el que proporcionan las implementaciones vacías de <tt class="docutils literal"><span class="pre">Twig_Extension</span></tt> para todos los otros métodos.</p>
<p>El método <tt class="docutils literal"><span class="pre">getName()</span></tt> debe devolver un identificador único para tu extensión.</p>
<p>Ahora, con esta información en mente, vamos a crear la extensión más básica posible:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Project_Twig_Extension</span> <span class="k">extends</span> <span class="nx">Twig_Extension</span>
<span class="p">{</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">getName</span><span class="p">()</span>
<span class="p">{</span>
<span class="k">return</span> <span class="s1">'project'</span><span class="p">;</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Nota</p>
<p class="last">Por supuesto, esta extensión no hace nada por ahora. Vamos a personalizarla en las siguientes secciones.</p>
</div>
<p>A <em>Twig</em> no le importa dónde guardas tu extensión en el sistema de archivos, puesto que todas las extensiones se deben registrar explícitamente para estar disponibles en tus plantillas.</p>
<p>Puedes registrar una extensión con el método <tt class="docutils literal"><span class="pre">addExtension()</span></tt> en tu objeto <tt class="docutils literal"><span class="pre">Environment</span></tt> principal:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$twig</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Twig_Environment</span><span class="p">(</span><span class="nv">$loader</span><span class="p">);</span>
<span class="nv">$twig</span><span class="o">-></span><span class="na">addExtension</span><span class="p">(</span><span class="k">new</span> <span class="nx">Project_Twig_Extension</span><span class="p">());</span>
</pre></div>
</div>
<p>Por supuesto, tienes que cargar primero el archivo de la extensión, ya sea utilizando <tt class="docutils literal"><span class="pre">require_once()</span></tt> o con un cargador automático (consulta la sección <a class="reference external" href="http://www.php.net/spl_autoload_register">spl_autoload_register()</a>).</p>
<div class="admonition tip">
<p class="first admonition-title">Truco</p>
<p class="last">Las extensiones integradas son grandes ejemplos de cómo trabajan las extensiones.</p>
</div>
<div class="section" id="id1">
<h3>Globales<a class="headerlink" href="#id1" title="Enlazar permanentemente con este título">¶</a></h3>
<p>Puedes registrar las variables globales en una extensión vía el método <tt class="docutils literal"><span class="pre">getGlobals()</span></tt>:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Project_Twig_Extension</span> <span class="k">extends</span> <span class="nx">Twig_Extension</span>
<span class="p">{</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">getGlobals</span><span class="p">()</span>
<span class="p">{</span>
<span class="k">return</span> <span class="k">array</span><span class="p">(</span>
<span class="s1">'text'</span> <span class="o">=></span> <span class="k">new</span> <span class="nx">Text</span><span class="p">(),</span>
<span class="p">);</span>
<span class="p">}</span>
<span class="c1">// ...</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="id2">
<h3>Funciones<a class="headerlink" href="#id2" title="Enlazar permanentemente con este título">¶</a></h3>
<p>Puedes registrar funciones en una extensión vía el método <tt class="docutils literal"><span class="pre">getFunctions()</span></tt>:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Project_Twig_Extension</span> <span class="k">extends</span> <span class="nx">Twig_Extension</span>
<span class="p">{</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">getFunctions</span><span class="p">()</span>
<span class="p">{</span>
<span class="k">return</span> <span class="k">array</span><span class="p">(</span>
<span class="s1">'lipsum'</span> <span class="o">=></span> <span class="k">new</span> <span class="nx">Twig_Function_Function</span><span class="p">(</span><span class="s1">'generate_lipsum'</span><span class="p">),</span>
<span class="p">);</span>
<span class="p">}</span>
<span class="c1">// ...</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="id3">
<h3>Filtros<a class="headerlink" href="#id3" title="Enlazar permanentemente con este título">¶</a></h3>
<p>Para agregar un filtro a una extensión, es necesario sustituir el método <tt class="docutils literal"><span class="pre">getFilters()</span></tt>. Este método debe devolver una matriz de filtros para añadir al entorno <em>Twig</em>:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Project_Twig_Extension</span> <span class="k">extends</span> <span class="nx">Twig_Extension</span>
<span class="p">{</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">getFilters</span><span class="p">()</span>
<span class="p">{</span>
<span class="k">return</span> <span class="k">array</span><span class="p">(</span>
<span class="s1">'rot13'</span> <span class="o">=></span> <span class="k">new</span> <span class="nx">Twig_Filter_Function</span><span class="p">(</span><span class="s1">'str_rot13'</span><span class="p">),</span>
<span class="p">);</span>
<span class="p">}</span>
<span class="c1">// ...</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Como puedes ver en el código anterior, el método <tt class="docutils literal"><span class="pre">getFilters()</span></tt> devuelve una matriz donde las claves son el nombre de los filtros (<tt class="docutils literal"><span class="pre">rot13</span></tt>) y los valores de la definición del filtro (<tt class="docutils literal"><span class="pre">new</span> <span class="pre">Twig_Filter_Function('str_rot13')</span></tt>).</p>
<p>Como vimos en el capítulo anterior, también puedes definir filtros como métodos estáticos en la clase de la extensión:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$twig</span><span class="o">-></span><span class="na">addFilter</span><span class="p">(</span> <span class="s1">'rot13'</span><span class="p">,</span>
<span class="k">new</span> <span class="nx">Twig_Filter_Function</span><span class="p">(</span>
<span class="s1">'Project_Twig_Extension::rot13Filter'</span>
<span class="p">)</span>
<span class="p">);</span>
</pre></div>
</div>
<p>También puedes utilizar <tt class="docutils literal"><span class="pre">Twig_Filter_Method</span></tt> en lugar de <tt class="docutils literal"><span class="pre">Twig_Filter_Function</span></tt> cuando definas un filtro que usa un método:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Project_Twig_Extension</span> <span class="k">extends</span> <span class="nx">Twig_Extension</span>
<span class="p">{</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">getFilters</span><span class="p">()</span>
<span class="p">{</span>
<span class="k">return</span> <span class="k">array</span><span class="p">(</span>
<span class="s1">'rot13'</span> <span class="o">=></span> <span class="k">new</span> <span class="nx">Twig_Filter_Method</span><span class="p">(</span><span class="nv">$this</span><span class="p">,</span> <span class="s1">'rot13Filter'</span><span class="p">),</span>
<span class="p">);</span>
<span class="p">}</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">rot13Filter</span><span class="p">(</span><span class="nv">$string</span><span class="p">)</span>
<span class="p">{</span>
<span class="k">return</span> <span class="nb">str_rot13</span><span class="p">(</span><span class="nv">$string</span><span class="p">);</span>
<span class="p">}</span>
<span class="c1">// ...</span>
<span class="p">}</span>
</pre></div>
</div>
<p>El primer argumento del constructor de <tt class="docutils literal"><span class="pre">Twig_Filter_Method</span></tt> siempre es <tt class="docutils literal"><span class="pre">$this</span></tt>, el objeto extensión actual. El segundo es el nombre del método a llamar.</p>
<p>Usar métodos de filtro es una gran manera de empaquetar el filtro sin contaminar el espacio de nombres global. Esto también le da más flexibilidad al desarrollador a costa de una pequeña sobrecarga.</p>
<div class="section" id="sustituyendo-los-filtros-predeterminados">
<h4>Sustituyendo los filtros predeterminados<a class="headerlink" href="#sustituyendo-los-filtros-predeterminados" title="Enlazar permanentemente con este título">¶</a></h4>
<p>Si algunos filtros predeterminados del núcleo no se ajustan a tus necesidades, los puedes sustituir fácilmente creando tu propia extensión del núcleo. Por supuesto, no es necesario copiar y pegar el código del núcleo en toda tu extensión de <em>Twig</em>. En lugar de eso la puedes extender y sustituir los filtros que deseas reemplazando el método <tt class="docutils literal"><span class="pre">getFilters()</span></tt>:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="k">class</span> <span class="nc">MyCoreExtension</span> <span class="k">extends</span> <span class="nx">Twig_Extension_Core</span>
<span class="p">{</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">getFilters</span><span class="p">()</span>
<span class="p">{</span>
<span class="k">return</span> <span class="nb">array_merge</span><span class="p">(</span><span class="k">parent</span><span class="o">::</span><span class="na">getFilters</span><span class="p">(),</span> <span class="k">array</span><span class="p">(</span>
<span class="s1">'date'</span> <span class="o">=></span> <span class="k">new</span> <span class="nx">Twig_Filter_Method</span><span class="p">(</span><span class="nv">$this</span><span class="p">,</span> <span class="s1">'dateFilter'</span><span class="p">),</span>
<span class="c1">// ...</span>
<span class="p">));</span>
<span class="p">}</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">dateFilter</span><span class="p">(</span><span class="nv">$timestamp</span><span class="p">,</span> <span class="nv">$format</span> <span class="o">=</span> <span class="s1">'F j, Y H:i'</span><span class="p">)</span>
<span class="p">{</span>
<span class="k">return</span> <span class="s1">'...'</span><span class="o">.</span><span class="nx">twig_date_format_filter</span><span class="p">(</span><span class="nv">$timestamp</span><span class="p">,</span> <span class="nv">$format</span><span class="p">);</span>
<span class="p">}</span>
<span class="c1">// ...</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Aquí, reemplazamos el filtro <tt class="docutils literal"><span class="pre">date</span></tt> con uno personalizado. Usar esta nueva extensión del núcleo es tan simple como registrar la extensión <tt class="docutils literal"><span class="pre">MyCoreExtension</span></tt> llamando al método <tt class="docutils literal"><span class="pre">addExtension()</span></tt> en la instancia del entorno:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$twig</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Twig_Environment</span><span class="p">(</span><span class="nv">$loader</span><span class="p">);</span>
<span class="nv">$twig</span><span class="o">-></span><span class="na">addExtension</span><span class="p">(</span><span class="k">new</span> <span class="nx">MyCoreExtension</span><span class="p">());</span>
</pre></div>
</div>
<p>Pero ya puedo escuchar a algunas personas preguntando cómo pueden hacer que la extensión del núcleo se cargue por omisión. Eso es cierto, pero el truco es que ambas extensiones comparten el mismo identificador único (<tt class="docutils literal"><span class="pre">core</span></tt> - definido en el método <tt class="docutils literal"><span class="pre">getName()</span></tt>). Al registrar una extensión con el mismo nombre que una ya existente, realmente sustituyes la predeterminada, incluso si ya está registrada:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$twig</span><span class="o">-></span><span class="na">addExtension</span><span class="p">(</span><span class="k">new</span> <span class="nx">Twig_Extension_Core</span><span class="p">());</span>
<span class="nv">$twig</span><span class="o">-></span><span class="na">addExtension</span><span class="p">(</span><span class="k">new</span> <span class="nx">MyCoreExtension</span><span class="p">());</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id4">
<h3>Etiquetas<a class="headerlink" href="#id4" title="Enlazar permanentemente con este título">¶</a></h3>
<p>Puedes agregar una etiqueta en una extensión reemplazando el método <tt class="docutils literal"><span class="pre">getTokenParsers()</span></tt>. Este método debe devolver una matriz de etiquetas para añadir al entorno <em>Twig</em>:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Project_Twig_Extension</span> <span class="k">extends</span> <span class="nx">Twig_Extension</span>
<span class="p">{</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">getTokenParsers</span><span class="p">()</span>
<span class="p">{</span>
<span class="k">return</span> <span class="k">array</span><span class="p">(</span><span class="k">new</span> <span class="nx">Project_Set_TokenParser</span><span class="p">());</span>
<span class="p">}</span>
<span class="c1">// ...</span>
<span class="p">}</span>
</pre></div>
</div>
<p>En el código anterior, hemos añadido una sola etiqueta nueva, definida por la clase <tt class="docutils literal"><span class="pre">Project_Set_TokenParser</span></tt>. La clase <tt class="docutils literal"><span class="pre">Project_Set_TokenParser</span></tt> es responsable de analizar la etiqueta y compilarla a <em>PHP</em>.</p>
</div>
<div class="section" id="operadores">
<h3>Operadores<a class="headerlink" href="#operadores" title="Enlazar permanentemente con este título">¶</a></h3>
<p>El método <tt class="docutils literal"><span class="pre">getOperators()</span></tt> te permite añadir nuevos operadores. Aquí tienes cómo añadir los operadores
<tt class="docutils literal"><span class="pre">!</span></tt>, <tt class="docutils literal"><span class="pre">||</span></tt> y <tt class="docutils literal"><span class="pre">&&</span></tt>:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Project_Twig_Extension</span> <span class="k">extends</span> <span class="nx">Twig_Extension</span>
<span class="p">{</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">getOperators</span><span class="p">()</span>
<span class="p">{</span>
<span class="k">return</span> <span class="k">array</span><span class="p">(</span>
<span class="k">array</span><span class="p">(</span>
<span class="s1">'!'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span> <span class="s1">'precedence'</span> <span class="o">=></span> <span class="mi">50</span><span class="p">,</span>
<span class="s1">'class'</span>
<span class="o">=></span> <span class="s1">'Twig_Node_Expression_Unary_Not'</span>
<span class="p">),</span>
<span class="p">),</span>
<span class="k">array</span><span class="p">(</span>
<span class="s1">'||'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span> <span class="s1">'precedence'</span> <span class="o">=></span> <span class="mi">10</span><span class="p">,</span>
<span class="s1">'class'</span>
<span class="o">=></span> <span class="s1">'Twig_Node_Expression_Binary_Or'</span><span class="p">,</span>
<span class="s1">'associativity'</span>
<span class="o">=></span> <span class="nx">Twig_ExpressionParser</span><span class="o">::</span><span class="na">OPERATOR_LEFT</span>
<span class="p">),</span>
<span class="s1">'&&'</span> <span class="o">=></span> <span class="k">array</span><span class="p">(</span> <span class="s1">'precedence'</span> <span class="o">=></span> <span class="mi">15</span><span class="p">,</span>
<span class="s1">'class'</span>
<span class="o">=></span> <span class="s1">'Twig_Node_Expression_Binary_And'</span><span class="p">,</span>
<span class="s1">'associativity'</span>
<span class="o">=></span> <span class="nx">Twig_ExpressionParser</span><span class="o">::</span><span class="na">OPERATOR_LEFT</span>
<span class="p">),</span>
<span class="p">),</span>
<span class="p">);</span>
<span class="p">}</span>
<span class="c1">// ...</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="pruebas">
<h3>Pruebas<a class="headerlink" href="#pruebas" title="Enlazar permanentemente con este título">¶</a></h3>
<p>El método <tt class="docutils literal"><span class="pre">getTests()</span></tt> te permite añadir funciones de prueba:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Project_Twig_Extension</span> <span class="k">extends</span> <span class="nx">Twig_Extension</span>
<span class="p">{</span>
<span class="k">public</span> <span class="k">function</span> <span class="nf">getTests</span><span class="p">()</span>
<span class="p">{</span>
<span class="k">return</span> <span class="k">array</span><span class="p">(</span>
<span class="s1">'even'</span> <span class="o">=></span> <span class="k">new</span> <span class="nx">Twig_Test_Function</span><span class="p">(</span><span class="s1">'twig_test_even'</span><span class="p">),</span>
<span class="p">);</span>
<span class="p">}</span>
<span class="c1">// ...</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<a href="https://github.com/fabpot/Twig"><img style="position: fixed; top: 0; right: 0; border: 0;" src="http://gitnacho.github.com/tnp/img/comun/bifurcame.png" alt="Bifúrcame en GitHub" /></a>
<div style="width:740px;margin:10px auto;">
<div class="related">
<h3>Navegación</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="Índice General"
>índice</a></li>
<li class="right" >
<a href="internals.html" title="Twig por dentro"
>siguiente</a> |</li>
<li class="right" >
<a href="api.html" title="Twig para desarrolladores"
>anterior</a> |</li>
<li><a href="index.html">Twig en Español</a> »</li>
</ul>
</div>
</div>
<div style="width: 740px; margin: 0 auto;">
<div id="disqus_thread"></div>
<div class="footer">
© Copyright 2011-2012, Traducido por Nacho Pacheco.
Actualizado por última vez en May 29, 2012.
Creado con <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
</div>
</div>
<script type="text/javascript">
var disqus_shortname = 'documentos-mx';
var disqus_developer = 1;
(function() {
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
dsq.src = 'http://' + disqus_shortname + '.disqus.com/embed.js';
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
})();
</script>
<noscript>
Por favor activa JavaScript para ver los <a href="http://disqus.com/?ref_noscript">comentarios accionados por Disqus.</a>
</noscript>
</body>
</html>