Fake news content
19 |Lorem ipsum
20 |54 | {% custom_tag %} 55 | {{ someUnsafeVariable }} 56 | {% endcustom_tag %} 57 |
58 | 59 | 60 | Installation 61 | ************ 62 | 63 | There are two recommended ways to install Twital via Composer_: 64 | 65 | * using the ``composer require`` command: 66 | 67 | .. code-block:: bash 68 | 69 | composer require 'goetas/twital:0.1.*' 70 | 71 | * adding the dependency to your ``composer.json`` file: 72 | 73 | .. code-block:: js 74 | 75 | "require": { 76 | .. 77 | "goetas/twital":"0.1.*", 78 | .. 79 | } 80 | 81 | 82 | Getting started 83 | *************** 84 | 85 | First, you have to create a file that contains your template 86 | (named for example ``demo.twital.html``): 87 | 88 | .. code-block:: xml+jinja 89 | 90 |
91 | Hello {{ name }}
92 |
93 |
94 | Afterwards, you have to create a PHP script that instantiate the required objects:
95 |
96 | .. code-block:: php
97 |
98 | render('demo.twital.html', array('name' => 'John'));
108 |
109 |
110 | That's all!
111 |
112 |
113 | .. note::
114 |
115 | Since Twital uses Twig to compile and render templates,
116 | their performance is the same.
117 |
118 | Contents
119 | ********
120 |
121 | .. toctree::
122 | :maxdepth: 3
123 | :hidden:
124 |
125 | tags/index
126 | templates
127 | api
128 | mistakes
129 | symfony
130 |
131 | Contributing
132 | ************
133 |
134 | This is an open source project: contributions are welcome. If your are interested,
135 | you can contribute to documentation, source code, test suite or anything else!
136 |
137 | To start contributing right now, go to https://github.com/goetas/twital and fork
138 | it!
139 |
140 | To improve your contributing experience, you can take a look into https://github.com/goetas/twital/blob/master/CONTRIBUTING.md
141 | inside the root directory of Twital GIT repository.
142 |
143 | Symfony2 Users
144 | **************
145 |
146 | If you are a Symfony2_ user, you can add Twital to your project using the
147 | TwitalBundle_.
148 |
149 | The bundle integrates all most common functionalities as Assetic, Forms, Translations, Routing, etc.
150 |
151 |
152 | Note
153 | ****
154 |
155 | I'm sorry for the *terrible* english fluency used inside the documentation, I'm trying to improve it.
156 | Pull Requests are welcome.
157 |
158 |
159 | .. _Twig: http://twig.sensiolabs.org/
160 | .. _TwitalBundle: https://github.com/goetas/twital-bundle
161 | .. _Symfony2: http://symfony.com
162 | .. _Composer: https://getcomposer.org/
163 | .. _TAL: http://en.wikipedia.org/wiki/Template_Attribute_Language
164 | .. _PHPTal: http://phptal.org/
165 | .. _AngularJS: http://angularjs.org/
166 |
--------------------------------------------------------------------------------
/doc/mistakes.rst:
--------------------------------------------------------------------------------
1 | Common mistakes and tricks
2 | --------------------------
3 |
4 | Since Twital internally uses XML, you need to pay attention to some aspects while writing a template.
5 | All templates must be XML valid (some exceptions are allowed...).
6 |
7 | - All templates must have **one** root node.
8 | When needed, you can use the `t:omit` node to enclose other nodes.
9 |
10 | .. code-block:: xml
11 |
12 | one
14 | two
15 |
27 |
28 |
29 |
30 |
31 |
32 |
33 | - The usage of `&` must follow XML syntax rules.
34 |
35 | .. code-block:: html
36 |
37 | 28 |
38 | &
39 | <
40 | >
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 | - To be compatible with all browsers, the use of the `script` tag should be combined with `CDATA` sections and script comments.
49 |
50 | .. code-block:: html
51 |
52 |
59 |
66 |
--------------------------------------------------------------------------------
/doc/symfony.rst:
--------------------------------------------------------------------------------
1 | Symfony Users
2 | #############
3 |
4 | If you are a Symfony_ user, the most convenient way to integrate Twital into your project is using the
5 | TwitalBundle_.
6 |
7 | The bundle integrates all most common Symfony functionalities as Assetic, Forms, Translations etc.
8 |
9 | .. _TwitalBundle: https://github.com/goetas/twital-bundle
10 | .. _Symfony: https://symfony.com
11 |
--------------------------------------------------------------------------------
/doc/tags/attr-append.rst:
--------------------------------------------------------------------------------
1 | ``attr-append``
2 | ===============
3 |
4 | Twital allows you to create HTML/XML attributes in a very simple way.
5 |
6 | `t:attr-append` is a different version of `t:attr`:
7 | it allows to append content to existing attributes instead of replacing it.
8 |
9 | .. code-block:: xml+jinja
10 |
11 |
12 | class will be "row even" if 'i' is odd.
13 |
14 |
15 | In the same way of `t:attr`, `condition` and the value of attribute can be any valid Twig expression.
16 |
17 | .. code-block:: xml+jinja
18 |
19 |
21 | class will be "row EVEN" if 'i' is odd.
22 |
23 |
24 |
25 | When not needed, you can omit the condition instruction.
26 |
27 | .. code-block:: xml+jinja
28 |
29 |
30 | Class will be "row even"
31 |
32 |
--------------------------------------------------------------------------------
/doc/tags/attr.rst:
--------------------------------------------------------------------------------
1 | ``attr``
2 | ========
3 |
4 | Twital allows you to create HTML/XML attributes in a very simple way.
5 | You do not have to mess up with control structures inside HTML tags.
6 |
7 | Let's see how does it work:
8 |
9 | .. code-block:: xml+jinja
10 |
11 |
12 | My Company
13 |
14 |
15 |
16 | Here we add conditionally an attribute based on the value of the `condition` expression.
17 |
18 |
19 | You can use any Twig test expression as **condition** and **attribute value**,
20 | but the attribute name must be a litteral.
21 |
22 | .. code-block:: xml+jinja
23 |
24 |
27 | Here wins the last class that condition will be evaluated to true.
28 |
29 |
30 | When not needed, you can omit the condition instruction.
31 |
32 | .. code-block:: xml+jinja
33 |
34 |
35 | Class will be "row"
36 |
37 |
38 | .. tip::
39 |
40 | `attr-append`
41 |
42 |
43 | To set an HTML5 boolean attribute, just use booleans as ``true`` or ``false``.
44 |
45 | .. code-block:: xml+jinja
46 |
47 |
50 |
51 | The previous template will be rendered as:
52 |
53 | .. code-block:: html
54 |
55 |
58 |
59 | .. note::
60 |
61 | Since XML does not have the concept of "boolean attributes",
62 | this feature may break your output if you are using XML.
63 |
64 |
65 |
66 | To to remove and already defined attribute, use ``false`` as attribute value
67 |
68 | .. code-block:: xml+jinja
69 |
70 |
71 | My Company
72 |
73 |
74 | The previous template will be rendered as:
75 |
76 | .. code-block:: html
77 |
78 |
79 | My Company
80 |
81 |
82 |
--------------------------------------------------------------------------------
/doc/tags/autoescape.rst:
--------------------------------------------------------------------------------
1 | ``autoescape``
2 | ==============
3 |
4 | The Twital instruction for Twig ``autoescape`` tag is ``t:autoescape`` attribute.
5 |
6 |
7 | Whether automatic escaping is enabled or not, you can mark a section of a
8 | template to be escaped or not by using the ``autoescape`` tag.
9 |
10 | To see how to use it, take a look at this example:
11 |
12 | .. code-block:: xml+jinja
13 |
14 |
15 | Everything will be automatically escaped in this block
16 | using the HTML strategy
17 |
18 |
19 |
20 | Everything will be automatically escaped in this block
21 | using the HTML strategy
22 |
23 |
24 |
25 | Everything will be automatically escaped in this block
26 | using the js escaping strategy
27 |
28 |
29 |
30 | Everything will be outputted as is in this block
31 |
32 |
33 | When automatic escaping is enabled, everything is escaped by default, except for
34 | values explicitly marked as safe. Those can be marked in the template by using
35 | the Twig ``raw`` filter:
36 |
37 | .. code-block:: xml+jinja
38 |
39 |
40 | {{ safe_value|raw }}
41 |
42 |
43 |
--------------------------------------------------------------------------------
/doc/tags/block.rst:
--------------------------------------------------------------------------------
1 | ``block``
2 | =========
3 |
4 |
5 | The Twital instruction for Twig ``block`` tag is ``t:block`` node.
6 |
7 | To see how to use it, consider the following base template named ``layout.html.twital``:
8 |
9 | .. code-block:: xml+jinja
10 |
11 |
12 |
13 |
9 | ... any content ..
10 |
11 |
12 |
13 | All contents inside "pagination" div will be captured and saved inside a variable named `foo`.
14 |
15 | .. note::
16 |
17 | For more information about the ``set`` tag, please refer to `Twig official documentation
11 | This content will be removed
12 |
13 |
14 |
15 | The output will be:
16 |
17 | .. code-block:: xml+jinja
18 |
19 | My name is John
20 |
21 |
22 | This can be useful to put come "test" content in your templates that will have a nice aspect on WYSIWYG
23 | editors, but at runtime will be replaced by real data coming from variables.
24 |
--------------------------------------------------------------------------------
/doc/tags/embed.rst:
--------------------------------------------------------------------------------
1 | ``embed``
2 | =========
3 |
4 | The Twital instruction for Twig ``embed`` tag is ``t:embed`` node.
5 |
6 | The embed tag combines the behaviour of include and extends.
7 | It allows you to include another template's contents, just like include does.
8 | But, it also allows you to override any block defined inside the included template,
9 | like when extending a template.
10 |
11 | To learn about the usefulness of `embed`, you can read the official documentation.
12 |
13 | Now, let's see how to use it, take a look to this example:
14 |
15 | .. code-block:: xml+jinja
16 |
17 |
22 | Hello!
23 |
24 |
25 |
26 |
27 |
28 | To improve the greating message, we can extend it using the ``t:textends`` node,
29 | so we can create a new template called ``hello.html.twital``.
30 |
31 | .. code-block:: xml+jinja
32 |
33 |
11 | This text becomes uppercase
12 |
13 |
14 |
15 | This text becomes uppercase
16 |
17 |
18 |
19 | .. note::
20 |
21 | To learn more about the `filter` tab, you can read the
22 | `Twig official documentation Members
13 |-
14 |
- 15 | {{ user.username }} 16 | 17 |
9 | Our website is in maintenance mode. Please, come back later. 10 |
11 | 12 | 13 | ``elseif`` and ``else`` are not *well* supported, but you can always combine Twital with Twig. 14 | 15 | .. code-block:: xml+jinja 16 | 17 |18 | {%if online_users == 1%} 19 | one user 20 | {% else %} 21 | {{online_users}} users 22 | {% endif %} 23 |
24 | 25 | But if you are really interested to use ``elseif`` and ``else`` tags with Twital 26 | you can do it anyway. 27 | 28 | .. code-block:: xml+jinja 29 | 30 |31 | I'm online 32 |
33 |34 | I'm invisible 35 |
36 |37 | I'm offline 38 |
39 | 40 | This syntax will work if there are no non-space charachters between the ``p`` tags. 41 | 42 | This example will not work: 43 | 44 | .. code-block:: xml+jinja 45 | 46 |47 | I'm online 48 |
49 |50 |
51 | I'm offline 52 |
53 | 54 |55 | I'm online 56 |
57 | some text... 58 |59 | I'm offline 60 |
61 | 62 | .. note:: 63 | 64 | To learn more about the Twig ``if`` tag, please refer to `Twig official documentation-
31 |
- Username 32 |
- {{ forms.input('username') }} 33 |
- Password 34 |
- {{ forms.input('password', null, 'password') }} 35 | {{ forms.textarea('comment') }} 36 |
-
44 |
- Username 45 |
- {{ input_field('username') }} 46 |
- Password 47 |
- {{ input_field('password', '', 'password') }} 48 |
{{ textarea('comment') }}
50 | 51 | .. tip:: 52 | 53 | To import macros from the current file, use the special ``_self`` variable 54 | for the source. 55 | 56 | .. note:: 57 | 58 | For more information about the ``import`` tag, please refer to 59 | `Twig official documentation
18 |
21 |
22 | In this case, the content of div will be replaced with the content of template 'news.html'.
23 |
24 |
25 | You can add additional variables by passing them after the ``with`` attribute:
26 |
27 | .. code-block:: xml+jinja
28 |
29 |
12 | This content will be removed
13 |
14 |
15 |
16 | The output will be:
17 |
18 | .. code-block:: xml+jinja
19 |
20 | My name is John
21 |
22 |
23 | This can be useful to put come "test" content in your templates that will have a nice aspect on WYSIWYG
24 | editors, but at runtime will be replaced by real data coming from variables.
25 |
--------------------------------------------------------------------------------
/doc/tags/sandbox.rst:
--------------------------------------------------------------------------------
1 | ``sandbox``
2 | ===========
3 |
4 | The Twital instruction for Twig ``import`` tag is ``t:sandbox`` node or the ``t:sandbox`` attribute.
5 |
6 | The ``sandbox`` tag can be used to enable the sandboxing mode for an included
7 | template, when sandboxing is not enabled globally for the Twig environment:
8 |
9 | .. code-block:: xml+jinja
10 |
11 |
16 | {% include 'user.html' %}
17 |
18 |
19 |
20 | .. note::
21 |
22 | For more information about the ``sandbox`` tag, please refer to
23 | `Twig official documentation Hello {{ name }}
12 |Hello {{ foo.bas }}
13 |14 | Hello {{ name }} {{ surname }} 15 |
16 | 17 | .. note:: 18 | 19 | For more information about the ``set`` tag, please refer to 20 | `Twig official documentation
14 | {% include 'user.html' %}
15 |
16 |
17 |
18 | .. note::
19 |
20 | For more information about the ``spaceless`` tag, please refer to
21 | `Twig official documentation {% block name%}foo{% endblock %}
'
11 | * @author Asmir Mustafic foo
{% endblock %}'
11 | *
12 | * @author Asmir Mustafic
17 | * array(
18 | * 'http://www.w3.org/1998/Math/MathML' => array(
19 | * 'math'=> new MathML\MathAttribute()
20 | * )
21 | * )
22 | *
23 | *
24 | * @return array
25 | */
26 | public function getAttributes();
27 |
28 | /**
29 | * Array of objects implementing Node interface, responsible of DOM node handling.
30 | * The returned array must be a "two level array",
31 | * first level as namespace and second level as attribute name.
32 | * Example:
33 | *
34 | * array(
35 | * 'http://www.w3.org/1998/Math/MathML' => array(
36 | * 'math'=> new MathML\MathNode()
37 | * )
38 | * )
39 | *
40 | *
41 | * @return array
42 | */
43 | public function getNodes();
44 |
45 | /**
46 | * Array of event subscribers
47 | * @return array
48 | */
49 | public function getSubscribers();
50 | }
51 |
--------------------------------------------------------------------------------
/src/Extension/AbstractExtension.php:
--------------------------------------------------------------------------------
1 |
9 | *
10 | */
11 | abstract class AbstractExtension implements Extension
12 | {
13 | public function getAttributes()
14 | {
15 | return array();
16 | }
17 |
18 | public function getNodes()
19 | {
20 | return array();
21 | }
22 |
23 | public function getSubscribers()
24 | {
25 | return array();
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/src/Extension/CoreExtension.php:
--------------------------------------------------------------------------------
1 |
16 | *
17 | */
18 | class CoreExtension extends AbstractExtension
19 | {
20 | public function getSubscribers()
21 | {
22 | return array(
23 | new DOMMessSubscriber(),
24 | new CustomNamespaceRawSubscriber(array(
25 | 't' => Twital::NS
26 | )),
27 | new FixHtmlEntitiesInExpressionSubscriber(),
28 | new ContextAwareEscapingSubscriber(),
29 | new IDNodeSubscriber()
30 | );
31 | }
32 |
33 | public function getAttributes()
34 | {
35 | $attributes = array();
36 | $attributes[Twital::NS]['__base__'] = new Attribute\BaseAttribute();
37 | $attributes[Twital::NS]['__internal-id__'] = new Attribute\InternalIDAttribute();
38 |
39 | $attributes[Twital::NS]['if'] = new Attribute\IfAttribute();
40 | $attributes[Twital::NS]['elseif'] = new Attribute\ElseIfAttribute();
41 | $attributes[Twital::NS]['else'] = new Attribute\ElseAttribute();
42 |
43 | $attributes[Twital::NS]['omit'] = new Attribute\OmitAttribute();
44 | $attributes[Twital::NS]['set'] = new Attribute\SetAttribute();
45 |
46 | $attributes[Twital::NS]['content'] = new Attribute\ContentAttribute();
47 | $attributes[Twital::NS]['capture'] = new Attribute\CaptureAttribute();
48 | $attributes[Twital::NS]['replace'] = new Attribute\ReplaceAttribute();
49 |
50 | $attributes[Twital::NS]['attr'] = new Attribute\AttrAttribute();
51 | $attributes[Twital::NS]['attr-append'] = new Attribute\AttrAppendAttribute();
52 |
53 | $attributes[Twital::NS]['extends'] = new Attribute\ExtendsAttribute();
54 |
55 | $attributes[Twital::NS]['block'] = new Attribute\BlockInnerAttribute();
56 | $attributes[Twital::NS]['block-inner'] = new Attribute\BlockInnerAttribute();
57 | $attributes[Twital::NS]['block-outer'] = new Attribute\BlockOuterAttribute();
58 |
59 | return $attributes;
60 | }
61 |
62 | public function getNodes()
63 | {
64 | $nodes = array();
65 | $nodes[Twital::NS]['extends'] = new Node\ExtendsNode();
66 | $nodes[Twital::NS]['block'] = new Node\BlockNode();
67 | $nodes[Twital::NS]['macro'] = new Node\MacroNode();
68 | $nodes[Twital::NS]['import'] = new Node\ImportNode();
69 | $nodes[Twital::NS]['include'] = new Node\IncludeNode();
70 | $nodes[Twital::NS]['omit'] = new Node\OmitNode();
71 | $nodes[Twital::NS]['embed'] = new Node\EmbedNode();
72 | $nodes[Twital::NS]['use'] = new Node\UseNode();
73 |
74 | return $nodes;
75 | }
76 | }
77 |
--------------------------------------------------------------------------------
/src/Extension/FullCompatibilityTwigExtension.php:
--------------------------------------------------------------------------------
1 |
12 | *
13 | */
14 | class FullCompatibilityTwigExtension extends AbstractExtension
15 | {
16 | public function getSubscribers()
17 | {
18 | return array(
19 | new ReplaceDoctypeAsTwigExpressionSubscriber(),
20 | new FixTwigExpressionSubscriber(),
21 | new CustomNamespaceSubscriber(array(
22 | 't' => Twital::NS
23 | )),
24 | );
25 | }
26 | }
27 |
--------------------------------------------------------------------------------
/src/Helper/DOMHelper.php:
--------------------------------------------------------------------------------
1 |
7 | *
8 | */
9 | class DOMHelper
10 | {
11 | public static function removeChilds(\DOMNode $ref)
12 | {
13 | while ($ref->hasChildNodes()) {
14 | $ref->removeChild($ref->firstChild);
15 | }
16 | }
17 |
18 | public static function insertAfterSet(\DOMNode $node, array $newNodes)
19 | {
20 | $ref = $node;
21 | foreach ($newNodes as $newNode) {
22 | if ($newNode->parentNode) {
23 | $newNode->parentNode->removeChild($newNode);
24 | }
25 | $ref->parentNode->insertBefore($newNode, $ref->nextSibling);
26 | $ref = $newNode;
27 | }
28 | }
29 |
30 | public static function replaceWithSet(\DOMNode $node, array $newNodes)
31 | {
32 | self::insertAfterSet($node, $newNodes);
33 | $node->parentNode->removeChild($node);
34 | }
35 |
36 | public static function remove(\DOMNode $ref)
37 | {
38 | return $ref->parentNode->removeChild($ref);
39 | }
40 |
41 | public static function checkNamespaces(\DOMElement $element, array $namespaces = array())
42 | {
43 | if ($element->namespaceURI === null && preg_match('/^([a-z0-9\-]+):(.+)$/i', $element->nodeName, $mch) && isset($namespaces[$mch[1]])) {
44 | $oldElement = $element;
45 | $element = self::copyElementInNs($oldElement, $namespaces[$mch[1]]);
46 | }
47 | // fix attrs
48 | foreach (iterator_to_array($element->attributes) as $attr) {
49 | if ($attr->namespaceURI === null && preg_match('/^([a-z0-9\-]+):/i', $attr->name, $mch) && isset($namespaces[$mch[1]])) {
50 | $element->removeAttributeNode($attr);
51 | $element->setAttributeNS($namespaces[$mch[1]], $attr->name, $attr->value);
52 | }
53 | }
54 | foreach (iterator_to_array($element->childNodes) as $child) {
55 | if ($child instanceof \DOMElement) {
56 | self::checkNamespaces($child, $namespaces);
57 | }
58 | }
59 | }
60 |
61 | /**
62 | * @param \DOMElement $oldElement
63 | * @param string $newNamespace
64 | * @return mixed
65 | */
66 | public static function copyElementInNs($oldElement, $newNamespace)
67 | {
68 | $element = $oldElement->ownerDocument->createElementNS($newNamespace, $oldElement->nodeName);
69 |
70 | // copy attributes
71 | foreach (iterator_to_array($oldElement->attributes) as $attr) {
72 | $oldElement->removeAttributeNode($attr);
73 | if ($attr->namespaceURI) {
74 | $element->setAttributeNodeNS($attr);
75 | } else {
76 | $element->setAttributeNode($attr);
77 | }
78 | }
79 | // copy children
80 | while ($child = $oldElement->firstChild) {
81 | $oldElement->removeChild($child);
82 | $element->appendChild($child);
83 | }
84 | $oldElement->parentNode->replaceChild($element, $oldElement);
85 |
86 | return $element;
87 | }
88 | }
89 |
--------------------------------------------------------------------------------
/src/Helper/ParserHelper.php:
--------------------------------------------------------------------------------
1 |
9 | *
10 | */
11 | class ParserHelper
12 | {
13 | private static $closing = array(
14 | '}' => '{',
15 | ')' => '(',
16 | ']' => '['
17 | );
18 |
19 | public static function staticSplitExpression($str, $splitter, $limit = 0)
20 | {
21 | $in = array();
22 | $inApex = false;
23 | $parts = array();
24 | $prev = 0;
25 |
26 | for ($i = 0, $l = strlen($str); $i < $l; $i++) {
27 | $chr = $str[$i];
28 |
29 | if ($chr == "'" || $chr == '"') {
30 | $j = 1;
31 | while ($i >= $j && $str[$i - $j] === '\\') {
32 | $j++;
33 | }
34 |
35 | if ($j % 2 !== 0) {
36 | if (!$inApex) {
37 | $inApex = $chr;
38 | } elseif ($inApex === $chr) {
39 | $inApex = false;
40 | }
41 | }
42 | }
43 |
44 | if (!$inApex) {
45 | if (in_array($chr, self::$closing)) {
46 | array_push($in, $chr);
47 | } elseif (isset(self::$closing[$chr]) && self::$closing[$chr] === end($in)) {
48 | array_pop($in);
49 | } elseif (isset(self::$closing[$chr]) && !count($in)) {
50 | throw new Exception(sprintf('Unexpected "%s" next to "%s"', $chr, substr($str, 0, $i + 1)));
51 | }
52 |
53 | if (!count($in) && $chr === $splitter) {
54 | $parts[] = substr($str, $prev, $i - $prev);
55 | $prev = $i + 1;
56 | if ($limit > 1 && count($parts) == ($limit - 1)) {
57 | break;
58 | }
59 | }
60 | }
61 | }
62 | if ($inApex) {
63 | throw new Exception(sprintf('Can\'t find the closing "%s" in "%s" expression', $inApex, $str));
64 | } elseif (count($in)) {
65 | throw new Exception(sprintf('Can\'t find the closing braces for "%s" in "%s" expression', implode(',', $in), $str));
66 | }
67 |
68 | $parts[] = substr($str, $prev);
69 |
70 | return array_map('trim', $parts);
71 | }
72 |
73 | public static function implodeKeyedDouble($glue, array $array, $quoteKeys = false)
74 | {
75 | $a = array();
76 | foreach ($array as $key => $val) {
77 | $a[] = ($quoteKeys ? "'$key'" : $key) . ":[" . implode(",", $val) . "]";
78 | }
79 |
80 | return implode($glue, $a);
81 | }
82 |
83 | public static function implodeKeyed($glue, array $array, $quoteKeys = false)
84 | {
85 | $a = array();
86 | foreach ($array as $key => $val) {
87 | $a[] = ($quoteKeys ? "'$key'" : $key) . ":$val";
88 | }
89 |
90 | return implode($glue, $a);
91 | }
92 | }
93 |
--------------------------------------------------------------------------------
/src/Node.php:
--------------------------------------------------------------------------------
1 |
8 | *
9 | */
10 | interface Node
11 | {
12 | /**
13 | * Visit a node.
14 | *
15 | * @param \DOMElement $node
16 | * @param Compiler $context
17 | * @return void
18 | */
19 | public function visit(\DOMElement $node, Compiler $context);
20 | }
21 |
--------------------------------------------------------------------------------
/src/Node/BlockNode.php:
--------------------------------------------------------------------------------
1 |
13 | *
14 | */
15 | class BlockNode implements Node
16 | {
17 | public function visit(\DOMElement $node, Compiler $context)
18 | {
19 | if (!$node->hasAttribute("name")) {
20 | throw new Exception("Name attribute is required");
21 | }
22 |
23 | $sandbox = $node->ownerDocument->createElementNS(Twital::NS, "sandbox");
24 | $node->parentNode->insertBefore($sandbox, $node);
25 | $node->parentNode->removeChild($node);
26 | $sandbox->appendChild($node);
27 |
28 | $context->compileAttributes($node);
29 | $context->compileChilds($node);
30 |
31 | $start = $context->createControlNode("block " . $node->getAttribute("name"));
32 | $end = $context->createControlNode("endblock");
33 |
34 | $sandbox->insertBefore($start, $sandbox->firstChild);
35 | $sandbox->appendChild($end);
36 |
37 | DOMHelper::replaceWithSet($sandbox, iterator_to_array($sandbox->childNodes));
38 | DOMHelper::replaceWithSet($node, iterator_to_array($node->childNodes));
39 | }
40 | }
41 |
--------------------------------------------------------------------------------
/src/Node/EmbedNode.php:
--------------------------------------------------------------------------------
1 |
12 | *
13 | */
14 | class EmbedNode implements Node
15 | {
16 | public function visit(\DOMElement $node, Compiler $context)
17 | {
18 | if ($node->hasAttribute("from-exp")) {
19 | $filename = $node->getAttribute("from-exp");
20 | } elseif ($node->hasAttribute("from")) {
21 | $filename = '"' . $node->getAttribute("from") . '"';
22 | } else {
23 | throw new Exception("The 'from' or 'from-exp' attribute is required");
24 | }
25 |
26 | // remove any non-element node
27 | foreach (iterator_to_array($node->childNodes) as $child) {
28 | if (!($child instanceof \DOMElement)) {
29 | $child->parentNode->removeChild($child);
30 | }
31 | }
32 |
33 | $context->compileChilds($node);
34 |
35 | $code = "embed {$filename}";
36 |
37 | if ($node->hasAttribute("ignore-missing") && $node->hasAttribute("ignore-missing") !== false) {
38 | $code .= " ignore missing";
39 | }
40 | if ($node->hasAttribute("with")) {
41 | $code .= " with " . $node->getAttribute("with");
42 | }
43 | if ($node->hasAttribute("only") && $node->getAttribute("only") !== "false") {
44 | $code .= " only";
45 | }
46 |
47 | $ext = $context->createControlNode($code);
48 |
49 | $set = iterator_to_array($node->childNodes);
50 |
51 | $n = $node->ownerDocument->createTextNode("\n");
52 | array_unshift($set, $n);
53 | array_unshift($set, $ext);
54 |
55 | $set[] = $context->createControlNode("endembed");
56 |
57 | DOMHelper::replaceWithSet($node, $set);
58 | }
59 | }
60 |
--------------------------------------------------------------------------------
/src/Node/ExtendsNode.php:
--------------------------------------------------------------------------------
1 |
12 | *
13 | */
14 | class ExtendsNode implements Node
15 | {
16 | public function visit(\DOMElement $node, Compiler $context)
17 | {
18 | if ($node->hasAttribute("from-exp")) {
19 | $filename = $node->getAttribute("from-exp");
20 | } elseif ($node->hasAttribute("from")) {
21 | $filename = '"' . $node->getAttribute("from") . '"';
22 | } else {
23 | throw new Exception("The 'from' or 'from-exp' attribute is required");
24 | }
25 |
26 | $context->compileChilds($node);
27 |
28 | $ext = $context->createControlNode("extends {$filename}");
29 |
30 | $set = iterator_to_array($node->childNodes);
31 | if (count($set)) {
32 | $n = $node->ownerDocument->createTextNode("\n");
33 | array_unshift($set, $n);
34 | }
35 | array_unshift($set, $ext);
36 |
37 | DOMHelper::replaceWithSet($node, $set);
38 | }
39 | }
40 |
--------------------------------------------------------------------------------
/src/Node/ImportNode.php:
--------------------------------------------------------------------------------
1 |
11 | *
12 | */
13 | class ImportNode implements Node
14 | {
15 | public function visit(\DOMElement $node, Compiler $context)
16 | {
17 | if ($node->hasAttribute("from-exp")) {
18 | $filename = $node->getAttribute("from-exp");
19 | } elseif ($node->hasAttribute("from")) {
20 | $filename = '"' . $node->getAttribute("from") . '"';
21 | } else {
22 | throw new Exception("The 'from' or 'from-exp' attribute is required");
23 | }
24 |
25 | if ($node->hasAttribute("as")) {
26 | $code = "import $filename as " . $node->getAttribute("as");
27 | $context->createControlNode("import " . ($node->getAttribute("fro-exp") ? $node->getAttribute("name-exp") : ("'" . $node->getAttribute("name") . "'")) . " as " . $node->getAttribute("as"));
28 | } elseif ($node->hasAttribute("aliases")) {
29 | $code = "from $filename import " . $node->getAttribute("aliases");
30 | } else {
31 | throw new Exception("As or Alias attribute is required");
32 | }
33 |
34 | $pi = $context->createControlNode($code);
35 |
36 | $node->parentNode->replaceChild($pi, $node);
37 | }
38 | }
39 |
--------------------------------------------------------------------------------
/src/Node/IncludeNode.php:
--------------------------------------------------------------------------------
1 |
11 | *
12 | */
13 | class IncludeNode implements Node
14 | {
15 | public function visit(\DOMElement $node, Compiler $context)
16 | {
17 | $code = "include ";
18 |
19 | if ($node->hasAttribute("from-exp")) {
20 | $code .= $node->getAttribute("from-exp");
21 | } elseif ($node->hasAttribute("from")) {
22 | $code .= '"' . $node->getAttribute("from") . '"';
23 | } else {
24 | throw new Exception("The 'from' or 'from-exp' attribute is required");
25 | }
26 |
27 | if ($node->hasAttribute("ignore-missing") && $node->getAttribute("ignore-missing") !== "false") {
28 | $code .= " ignore missing";
29 | }
30 | if ($node->hasAttribute("with")) {
31 | $code .= " with " . $node->getAttribute("with");
32 | }
33 | if ($node->hasAttribute("only") && $node->getAttribute("only") !== "false") {
34 | $code .= " only";
35 | }
36 | if ($node->hasAttribute("sandboxed") && $node->getAttribute("sandboxed") !== "false") {
37 | $code .= " sandboxed = true";
38 | }
39 |
40 | $pi = $context->createControlNode($code);
41 | $node->parentNode->replaceChild($pi, $node);
42 | }
43 | }
44 |
--------------------------------------------------------------------------------
/src/Node/MacroNode.php:
--------------------------------------------------------------------------------
1 |
12 | *
13 | */
14 | class MacroNode implements Node
15 | {
16 | public function visit(\DOMElement $node, Compiler $context)
17 | {
18 | if (!$node->hasAttribute("name")) {
19 | throw new Exception("Name attribute is required");
20 | }
21 |
22 | $context->compileChilds($node);
23 |
24 | $set = iterator_to_array($node->childNodes);
25 |
26 | $start = $context->createControlNode("macro " . $node->getAttribute("name") . "(" . $node->getAttribute("args") . ")");
27 | array_unshift($set, $start);
28 |
29 | $set[] = $context->createControlNode("endmacro");
30 |
31 | DOMHelper::replaceWithSet($node, $set);
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/src/Node/OmitNode.php:
--------------------------------------------------------------------------------
1 |
11 | *
12 | */
13 | class OmitNode implements Node
14 | {
15 | public function visit(\DOMElement $node, Compiler $context)
16 | {
17 | $context->compileAttributes($node);
18 | $context->compileChilds($node);
19 | DOMHelper::replaceWithSet($node, iterator_to_array($node->childNodes));
20 | }
21 | }
22 |
--------------------------------------------------------------------------------
/src/Node/UseNode.php:
--------------------------------------------------------------------------------
1 |
11 | *
12 | */
13 | class UseNode implements Node
14 | {
15 | public function visit(\DOMElement $node, Compiler $context)
16 | {
17 | $code = "use ";
18 |
19 | if ($node->hasAttribute("from")) {
20 | $code .= '"' . $node->getAttribute("from") . '"';
21 | } else {
22 | throw new Exception("The 'from' attribute is required");
23 | }
24 |
25 | if ($node->hasAttribute("with")) {
26 | $code .= " with " . $node->getAttribute("with");
27 | }
28 |
29 | $pi = $context->createControlNode($code);
30 | $node->parentNode->replaceChild($pi, $node);
31 | }
32 | }
33 |
--------------------------------------------------------------------------------
/src/SourceAdapter.php:
--------------------------------------------------------------------------------
1 |
7 | *
8 | */
9 | interface SourceAdapter
10 | {
11 | /**
12 | * Gets the raw template source code and return a {Goetas\Twital\Template} instance.
13 | *
14 | * @param string $string
15 | * @return Template
16 | */
17 | public function load($string);
18 |
19 | /**
20 | * Gets a {Template} instance and return the raw template source code.
21 | *
22 | * @param Template $dom
23 | * @return string
24 | */
25 | public function dump(Template $dom);
26 | }
27 |
--------------------------------------------------------------------------------
/src/SourceAdapter/HTML5Adapter.php:
--------------------------------------------------------------------------------
1 |
11 | *
12 | */
13 | class HTML5Adapter implements SourceAdapter
14 | {
15 | private $html5;
16 |
17 | /**
18 | * {@inheritdoc}
19 | */
20 | public function load($source)
21 | {
22 | $html5 = $this->getHtml5();
23 |
24 | if (stripos(rtrim($source), '') === 0) {
25 | $dom = $html5->loadHTML($source);
26 | } else {
27 | $f = $html5->loadHTMLFragment($source);
28 | $dom = new \DOMDocument('1.0', 'UTF-8');
29 | if ('' !== trim($source)) {
30 | $dom->appendChild($dom->importNode($f, true));
31 | }
32 | }
33 | return new Template($dom, $this->collectMetadata($dom, $source));
34 | }
35 |
36 | /**
37 | * {@inheritdoc}
38 | */
39 | public function dump(Template $template)
40 | {
41 | $metadata = $template->getMetadata();
42 | $dom = $template->getDocument();
43 | $html5 = $this->getHtml5();
44 | return $html5->saveHTML($metadata['fragment'] ? $dom->childNodes : $dom);
45 | }
46 |
47 | /**
48 | * Collect some metadata about $dom and $content
49 | * @param \DOMDocument $dom
50 | * @param string $source
51 | * @return mixed
52 | */
53 | protected function collectMetadata(\DOMDocument $dom, $source)
54 | {
55 | $metadata = array();
56 |
57 | $metadata['doctype'] = !!$dom->doctype;
58 | $metadata['fragment'] = stripos(rtrim($source), '') !== 0;
59 |
60 | return $metadata;
61 | }
62 |
63 | private function getHtml5()
64 | {
65 | if (!$this->html5) {
66 | $this->html5 = new HTML5(array(
67 | "xmlNamespaces" => true
68 | ));
69 | }
70 | return $this->html5;
71 | }
72 | }
73 |
--------------------------------------------------------------------------------
/src/SourceAdapter/XHTMLAdapter.php:
--------------------------------------------------------------------------------
1 |
9 | *
10 | */
11 | class XHTMLAdapter extends XMLAdapter
12 | {
13 | /**
14 | * {@inheritdoc}
15 | */
16 | public function dump(Template $template)
17 | {
18 | $metadata = $template->getMetadata();
19 | $dom = $template->getDocument();
20 | $dom->preserveWhiteSpace = true;
21 | $dom->formatOutput = false;
22 |
23 | if ($metadata['xmldeclaration']) {
24 | $xml = $dom->saveXML();
25 | } else {
26 | $xml = '';
27 | foreach ($dom->childNodes as $node) {
28 | $xml .= $dom->saveXML($node, LIBXML_NOEMPTYTAG);
29 | if ($node instanceof \DOMDocumentType) {
30 | $xml .= PHP_EOL;
31 | }
32 | }
33 | }
34 |
35 | return $this->replaceShortTags($xml);
36 | }
37 |
38 | protected function replaceShortTags($str)
39 | {
40 | $selfClosingTags = array(
41 | "area",
42 | "base",
43 | "br",
44 | "col",
45 | "embed",
46 | "hr",
47 | "img",
48 | "input",
49 | "keygen",
50 | "link",
51 | "menuitem",
52 | "meta",
53 | "param",
54 | "source",
55 | "track",
56 | "wbr"
57 | );
58 | $regex = implode("|", array_map(function ($tag) {
59 | return ">";
60 | }, $selfClosingTags));
61 |
62 | return preg_replace("#$regex#i", "/>", $str);
63 | }
64 | }
65 |
--------------------------------------------------------------------------------
/src/SourceAdapter/XMLAdapter.php:
--------------------------------------------------------------------------------
1 |
10 | *
11 | */
12 | class XMLAdapter implements SourceAdapter
13 | {
14 | /**
15 | * {@inheritdoc}
16 | */
17 | public function load($source)
18 | {
19 | $dom = $this->createDom($source);
20 |
21 | return new Template($dom, $this->collectMetadata($dom, $source));
22 | }
23 |
24 | /**
25 | * {@inheritdoc}
26 | */
27 | public function dump(Template $template)
28 | {
29 | $metadata = $template->getMetadata();
30 | $dom = $template->getDocument();
31 | $dom->preserveWhiteSpace = true;
32 | $dom->formatOutput = false;
33 |
34 | if ($metadata['xmldeclaration']) {
35 | return $dom->saveXML();
36 | } else {
37 | $xml = '';
38 | foreach ($dom->childNodes as $node) {
39 | $xml .= $dom->saveXML($node);
40 | if ($node instanceof \DOMDocumentType) {
41 | $xml .= PHP_EOL;
42 | }
43 | }
44 |
45 | return $xml;
46 | }
47 | }
48 |
49 | /**
50 | * Collect some metadata about $dom and $source
51 | * @param \DOMDocument $dom
52 | * @param string $source
53 | * @return mixed
54 | */
55 | protected function collectMetadata(\DOMDocument $dom, $source)
56 | {
57 | $metadata = array();
58 |
59 | $metadata['xmldeclaration'] = strpos(rtrim($source), 'doctype;
61 |
62 | return $metadata;
63 | }
64 |
65 | protected function createDom($source)
66 | {
67 | $internalErrors = libxml_use_internal_errors(true);
68 | libxml_clear_errors();
69 |
70 | $dom = new \DOMDocument('1.0', 'UTF-8');
71 | if ('' !== trim($source) && !$dom->loadXML($source, LIBXML_NONET | (defined('LIBXML_COMPACT') ? LIBXML_COMPACT : 0))) {
72 | throw new \InvalidArgumentException(implode("\n", $this->getXmlErrors($internalErrors)));
73 | }
74 |
75 | libxml_use_internal_errors($internalErrors);
76 |
77 | return $dom;
78 | }
79 |
80 | protected function getXmlErrors($internalErrors)
81 | {
82 | $errors = array();
83 | foreach (libxml_get_errors() as $error) {
84 | $errors[] = sprintf(
85 | '[%s %s] %s (in %s - line %d, column %d)',
86 | LIBXML_ERR_WARNING == $error->level ? 'WARNING' : 'ERROR',
87 | $error->code,
88 | trim($error->message),
89 | $error->file ? $error->file : 'n/a',
90 | $error->line,
91 | $error->column
92 | );
93 | }
94 |
95 | libxml_clear_errors();
96 | libxml_use_internal_errors($internalErrors);
97 |
98 | return $errors;
99 | }
100 | }
101 |
--------------------------------------------------------------------------------
/src/Template.php:
--------------------------------------------------------------------------------
1 |
9 | *
10 | */
11 | class Template
12 | {
13 | /**
14 | * The template {DOMDocument}
15 | *
16 | * @var \DOMDocument
17 | */
18 | private $document;
19 |
20 | /**
21 | * Template metadatas
22 | *
23 | * @var mixed
24 | */
25 | private $metadata;
26 |
27 | /**
28 | * @param \DOMDocument $document The template {DOMDocument}
29 | * @param mixed $metadata Template metadatas
30 | */
31 | public function __construct(\DOMDocument $document, $metadata = null)
32 | {
33 | $this->document = $document;
34 | $this->metadata = $metadata;
35 | }
36 |
37 | /**
38 | * Returns the {DOMDocument} of a template
39 | *
40 | * @return \DOMDocument
41 | */
42 | public function getDocument()
43 | {
44 | return $this->document;
45 | }
46 |
47 | /**
48 | * Return template metadatas.
49 | *
50 | * @return mixed
51 | */
52 | public function getMetadata()
53 | {
54 | return $this->metadata;
55 | }
56 | }
57 |
--------------------------------------------------------------------------------
/src/Twital.php:
--------------------------------------------------------------------------------
1 |
14 | *
15 | */
16 | class Twital
17 | {
18 | const NS = 'urn:goetas:twital';
19 |
20 | protected $extensionsInitialized = false;
21 |
22 | /**
23 | *
24 | * @var EventDispatcher
25 | */
26 | protected $dispatcher;
27 |
28 | /**
29 | *
30 | * @var array
31 | */
32 | private $attributes = array();
33 |
34 | /**
35 | *
36 | * @var array
37 | */
38 | private $nodes = array();
39 |
40 | /**
41 | *
42 | * @var array
43 | */
44 | private $extensions = array();
45 |
46 | /**
47 | *
48 | * @var array
49 | */
50 | private $options = array();
51 |
52 | public function __construct(array $options = array())
53 | {
54 | $this->options = $options;
55 | $this->dispatcher = new EventDispatcher();
56 |
57 | $this->addExtension(new CoreExtension());
58 | }
59 |
60 | /**
61 | *
62 | * @return \Symfony\Component\EventDispatcher\EventDispatcher
63 | */
64 | public function getEventDispatcher()
65 | {
66 | $this->initExtensions();
67 |
68 | return $this->dispatcher;
69 | }
70 |
71 | public function getNodes()
72 | {
73 | $this->initExtensions();
74 |
75 | return $this->nodes;
76 | }
77 |
78 | public function getAttributes()
79 | {
80 | $this->initExtensions();
81 |
82 | return $this->attributes;
83 | }
84 |
85 | /**
86 | *
87 | * @param SourceAdapter $adapter
88 | * @param string $source
89 | * @return string
90 | */
91 | public function compile(SourceAdapter $adapter, $source)
92 | {
93 | $this->initExtensions();
94 |
95 | $sourceEvent = new SourceEvent($this, $source);
96 | $this->dispatch($sourceEvent, CompilerEvents::PRE_LOAD);
97 | $template = $adapter->load($sourceEvent->getTemplate());
98 |
99 | $templateEvent = new TemplateEvent($this, $template);
100 | $this->dispatch($templateEvent, CompilerEvents::POST_LOAD);
101 |
102 | $compiler = new Compiler($this, isset($this->options['lexer']) ? $this->options['lexer'] : array());
103 | $compiler->compile($templateEvent->getTemplate()->getDocument());
104 |
105 | $templateEvent = new TemplateEvent($this, $templateEvent->getTemplate());
106 | $this->dispatch($templateEvent, CompilerEvents::PRE_DUMP);
107 | $source = $adapter->dump($templateEvent->getTemplate());
108 |
109 | $sourceEvent = new SourceEvent($this, $source);
110 | $this->dispatch($sourceEvent, CompilerEvents::POST_DUMP);
111 |
112 | return $sourceEvent->getTemplate();
113 | }
114 |
115 | public function addExtension(Extension $extension)
116 | {
117 | $this->extensionsInitialized = false;
118 |
119 | return $this->extensions[] = $extension;
120 | }
121 |
122 | public function setExtensions(array $extensions)
123 | {
124 | $this->extensionsInitialized = false;
125 |
126 | $this->extensions = $extensions;
127 | }
128 |
129 | /**
130 | * @return Extension[]
131 | */
132 | public function getExtensions()
133 | {
134 | return $this->extensions;
135 | }
136 |
137 | protected function initExtensions()
138 | {
139 | if (!$this->extensionsInitialized) {
140 | foreach ($this->getExtensions() as $extension) {
141 | $this->attributes = array_merge_recursive($this->attributes, $extension->getAttributes());
142 | $this->nodes = array_merge_recursive($this->nodes, $extension->getNodes());
143 |
144 | foreach ($extension->getSubscribers() as $subscriber) {
145 | $this->dispatcher->addSubscriber($subscriber);
146 | }
147 | }
148 | $this->extensionsInitialized = true;
149 | }
150 | }
151 |
152 | protected function dispatch($event, $name)
153 | {
154 | if ($this->dispatcher instanceof EventDispatcherInterface) {
155 | $this->dispatcher->dispatch($event, $name);
156 | } else {
157 | $this->dispatcher->dispatch($name, $event);
158 | }
159 | }
160 | }
161 |
--------------------------------------------------------------------------------
/src/TwitalLoader.php:
--------------------------------------------------------------------------------
1 | getSourceContext($name)->getCode();
17 | }
18 | }
19 | } elseif (interface_exists(ExistsLoaderInterface::class)) { // Twig 2
20 | abstract class BaseTwitalLoader extends TwitalLoaderTwigLt3 implements LoaderInterface, ExistsLoaderInterface, SourceContextLoaderInterface
21 | {
22 | }
23 | } else { // Twig 3
24 | abstract class BaseTwitalLoader extends TwitalLoaderTwigGte3
25 | {
26 | }
27 | }
28 |
29 | /**
30 | * This is a Twital Loader.
31 | * Compiles a Twital template into a Twig template.
32 | *
33 | * @author Asmir Mustafic 
',
139 | ' | escape(\'url\') }})
'
140 | ),
141 | );
142 | }
143 |
144 | protected function wrap($html, $addNs = true)
145 | {
146 | return "content
', '{% if test %}content
{% endif %}'),
34 | array('content1
content2
{% if test1 %}
'),
35 | array('content1
{% elseif test2 %}content2
{% endif %}content1
content2
{% if test1 %}
'),
36 | array('content1
{% elseif test2 %}content2
{% endif %}content1
content2
content3
{% if test1 %}
'),
37 | array('content1
{% elseif test2 %}content2
{% elseif test3 %}content3
{% endif %}content1
content2
{% if test1 %}
'),
38 | array('content1
{% else %}content2
{% endif %}content1
content2
content3
{% if test1 %}
'),
39 | // for
40 | array('content1
{% elseif test2 %}content2
{% else %}content3
{% endif %}content
', '{% for foo %}content
{% endfor %}'),
41 | // set
42 | array('content
', '{% set foo = 1 %}content
'),
43 | array('content
', '{% set foo %}content
{% endset %}'),
44 | // content
45 | array('content
', '{{ foo }}
'),
46 | // mixed
47 | array('content
', '{% if cond %}{% for foo %}content
{% endfor %}{% endif %}'),
48 | array('content
', '{% for foo %}{% if cond %}content
{% endif %}{% endfor %}'),
49 | // omit
50 | array('content
', '{% set __tmp_omit = cond %}{% if not __tmp_omit %}{% endif %}content{% if not __tmp_omit %}
{% endif %}'),
51 | array('content
', '{% set __tmp_omit = cond %}{% if not __tmp_omit %}{% endif %}content{% if not __tmp_omit %}
{% endif %}'),
52 |
53 | array('content
', '{% if cond %}{% set __tmp_omit = true %}{% if not __tmp_omit %}{% endif %}content{% if not __tmp_omit %}
{% endif %}{% endif %}'),
54 |
55 | );
56 | }
57 | }
58 |
--------------------------------------------------------------------------------
/tests/Tests/DynamicAttrAttributeTest.php:
--------------------------------------------------------------------------------
1 | loader = new ArrayLoader();
30 | $twitalLoader = new TwitalLoader($this->loader, null, false);
31 | $twitalLoader->addSourceAdapter("/.*/", new XMLAdapter());
32 |
33 | $this->twig = new Environment($twitalLoader);
34 | }
35 |
36 | /**
37 | * @dataProvider getData
38 | */
39 | public function testVisitAttribute($source, $expected, $vars = null)
40 | {
41 | $this->loader->setTemplate('template', $source);
42 | $rendered = $this->twig->render('template', $vars ?: array());
43 | $this->assertEquals($expected, $rendered);
44 | }
45 |
46 | public function getData()
47 | {
48 | return array(
49 | array('content
', 'content
'),
50 | array('{%if true%}{%endif%}
{%if true%}{%endif%}
content
'),
54 | array('', 'content
'),
55 | array('content
', 'content
', array('condition' => 1)),
56 | array('', '', array('condition' => 0)),
57 | array('', 'content
', array('condition' => 1)),
58 |
59 | array('', ''),
60 | array('content
', 'content
', array('condition' => 0)),
64 |
65 | array('content
', 'content
', array('condition' => 1)),
66 | array('content
', '', array('condition' => 1)),
67 | array('content
', '', array('condition' => 1)),
68 |
69 | array('content
', 'content', array('condition' => 1)),
70 | array('content
', 'content
', array('condition' => 0)),
71 | array('content
', 'content'),
72 |
73 | array('
', array('a' => '/a/x.jpg')),
74 | array('
',),
75 | array('
', '
'),
76 | array('
', array('a' => '/d/x.jpg', 'b' => '/b/x.jpg')),
77 | );
78 | }
79 |
80 | public function testAttributeHash()
81 | {
82 | $source = <<-
85 |
86 |
88 | yyy
89 |
90 |
91 |
92 |
93 |
94 | EOT;
95 |
96 | $this->loader->setTemplate('template', $source);
97 | $rendered = $this->twig->render('template');
98 | $expected = <<-
101 |
102 |
104 | yyy
105 |
106 |
107 |
108 |
109 |
110 | EOT;
111 | $this->assertEquals($expected, $rendered);
112 | }
113 |
114 | public function getInvalidData()
115 | {
116 | return array(
117 | array('content
'),
118 | array('content
'),
119 | );
120 | }
121 |
122 | /**
123 | * @dataProvider getInvalidData
124 | */
125 | public function testInvalidVisitAttribute($source)
126 | {
127 | $this->expectException(\Exception::class);
128 | $this->loader->setTemplate('template', $source);
129 | $this->twig->render('template');
130 | }
131 | }
132 |
--------------------------------------------------------------------------------
/tests/Tests/Event/SourceEventTest.php:
--------------------------------------------------------------------------------
1 | twital = new Twital();
19 | }
20 |
21 | public function testBase()
22 | {
23 | $template = md5(microtime());
24 | $ist = new SourceEvent($this->twital, $template);
25 |
26 | $this->assertSame($this->twital, $ist->getTwital());
27 | $this->assertSame($template, $ist->getTemplate());
28 | }
29 |
30 | public function testBaseSetter()
31 | {
32 | $template = md5(microtime());
33 | $ist = new SourceEvent($this->twital, $template);
34 |
35 | $this->assertSame($template, $ist->getTemplate());
36 |
37 | $templateNew = md5(microtime());
38 | $ist->setTemplate($templateNew);
39 |
40 | $this->assertSame($templateNew, $ist->getTemplate());
41 | }
42 | }
43 |
--------------------------------------------------------------------------------
/tests/Tests/Event/TemplateEventTest.php:
--------------------------------------------------------------------------------
1 | twital = new Twital();
21 | $this->template = $this->getTemplateMock();
22 | }
23 |
24 | public function testBase()
25 | {
26 | $ist = new TemplateEvent($this->twital, $this->template);
27 |
28 | $this->assertSame($this->twital, $ist->getTwital());
29 | $this->assertSame($this->template, $ist->getTemplate());
30 | }
31 |
32 | public function testBaseSetter()
33 | {
34 | $ist = new TemplateEvent($this->twital, $this->template);
35 |
36 | $template = $this->getTemplateMock();
37 | $ist->setTemplate($template);
38 |
39 | $this->assertSame($template, $ist->getTemplate());
40 | }
41 |
42 | protected function getTemplateMock()
43 | {
44 | return $this->getMockBuilder(Template::class)->setConstructorArgs(array(new \DOMDocument('1.0', 'UTF-8')))->getMock();
45 | }
46 | }
47 |
--------------------------------------------------------------------------------
/tests/Tests/ExpressionParserTest.php:
--------------------------------------------------------------------------------
1 | assertEquals($expected, $splitted);
16 | }
17 |
18 | /**
19 | * @dataProvider getDataWithLimit
20 | */
21 | public function testExpressionsWithLimit($expression, $splitter, $limit, $expected)
22 | {
23 | $splitted = ParserHelper::staticSplitExpression($expression, $splitter, $limit);
24 | $this->assertEquals($expected, $splitted);
25 | }
26 |
27 | /**
28 | * @dataProvider getWrongData
29 | */
30 | public function testWrongExpressions($expression)
31 | {
32 | $this->expectException(\Exception::class);
33 | ParserHelper::staticSplitExpression($expression, "x");
34 | }
35 |
36 | public function getWrongData()
37 | {
38 | return array(
39 |
40 | array('a? "b'),
41 | array('a? \'b'),
42 | array('a? b)'),
43 |
44 | );
45 | }
46 |
47 | public function getDataWithLimit()
48 | {
49 | return array(
50 | array('a', '?', 2, array('a')),
51 | array('?', '?', 2, array('', '')),
52 | array('a?b?c', '?', 2, array('a', 'b?c')),
53 | array('a?(b?c)', '?', 2, array('a', '(b?c)')),
54 | array('a?(b?c)?d?e', '?', 3, array('a', '(b?c)', 'd?e')),
55 | array('[a?(b?c)?d]?e', '?', 3, array('[a?(b?c)?d]', 'e')),
56 |
57 | array('[aa?(bb?cc)?dd]?ee', '?', 3, array('[aa?(bb?cc)?dd]', 'ee')),
58 | array('[aa?"bb?cc"?dd]?ee', '?', 3, array('[aa?"bb?cc"?dd]', 'ee')),
59 |
60 | array('[aa?"bb\"?cc"?dd]?ee', '?', 3, array('[aa?"bb\"?cc"?dd]', 'ee')),
61 | );
62 | }
63 |
64 | public function getData()
65 | {
66 | return array(
67 | array('?a b', '?', array('', 'a b')),
68 |
69 | array('a b?', '?', array('a b', '')),
70 |
71 | array('a b', '?', array('a b')),
72 |
73 | array('a? b', '?', array('a', 'b')),
74 | array('a? "b?"', '?', array('a', '"b?"')),
75 | array('"a?"? "b?"', '?', array('"a?"', '"b?"')),
76 | array('"a?" ? "b?"', '?', array('"a?"', '"b?"')),
77 | array('"a?" ? "b?"', '?', array('"a?"', '"b?"')),
78 |
79 | array('\'a?\' ? "b?"', '?', array('\'a?\'', '"b?"')),
80 |
81 | //non quoted group
82 | array('(a?) ? "b?"', '?', array('(a?)', '"b?"')),
83 | array('"a?" ? (b?)', '?', array('"a?"', '(b?)')),
84 |
85 | array("aaa:{'aaa':'xxx', 'bbb':'cc'},title", ',', array("aaa:{'aaa':'xxx', 'bbb':'cc'}", "title")),
86 | array("'aaa':'xxx', 'bbb':'cc'", ',', array("'aaa':'xxx'", "'bbb':'cc'")),
87 | );
88 | }
89 | }
90 |
--------------------------------------------------------------------------------
/tests/Tests/FullCompatibilityTwigTest.php:
--------------------------------------------------------------------------------
1 | templateSubscriber = new DebugTemplateSubscriber();
25 |
26 | $this->twital = new Twital();
27 | $this->twital->addExtension(new FullCompatibilityTwigExtension());
28 | $this->twital->getEventDispatcher()->addSubscriber($this->templateSubscriber);
29 | }
30 |
31 | public function testListenerPriority()
32 | {
33 | $eventDispatcher = $this->twital->getEventDispatcher();
34 |
35 | $preLoad = $eventDispatcher->getListeners(CompilerEvents::PRE_LOAD);
36 |
37 | $this->assertEquals(array(new ReplaceDoctypeAsTwigExpressionSubscriber(), 'replaceDoctype'), $preLoad[0]);
38 | $this->assertEquals(array(new FixTwigExpressionSubscriber(), 'addPlaceholder'), $preLoad[1]);
39 |
40 | $postDump = $eventDispatcher->getListeners(CompilerEvents::POST_DUMP);
41 | $this->assertEquals(array(new FixTwigExpressionSubscriber(), 'removePlaceholder'), end($postDump));
42 | }
43 |
44 | /**
45 | * @dataProvider getData
46 | */
47 | public function testHTML5SourceAdapter($source, $expected = null)
48 | {
49 | $sourceAdapter = new HTML5Adapter();
50 |
51 | $compiled = $this->twital->compile($sourceAdapter, $source);
52 | $this->assertEquals($expected !== null ? $expected : $source, $compiled, 'PRE: '.$this->templateSubscriber->preLoadTemplate."\n\nPOST: ".$this->templateSubscriber->postDumpTemplate);
53 | }
54 |
55 | public function getData()
56 | {
57 | return array(
58 | array('{% if foo > 5 and bar < 8 and bar & 4 %}foo{% endif %}
'),
59 | array('{{ foo > 5 and bar < 8 and bar & 4 ? "foo" }}
'),
60 | array('{# foo > 5 and bar < 8 and bar & 4 ? "foo" #}
'),
61 |
62 | array("{% '{%' and '%}' and '{{' and '}}' and '{#' and '#}' %}
"),
63 | array("{{ '{%' and '%}' and '{{' and '}}' and '{#' and '#}' }}
"),
64 | array("{# '{%' and '%}' and '{{' and '}}' and '{#' and '#}' #}
"),
65 |
66 | array("{{ '}}\\'}}' > 5 & 4 }}
"),
67 | array("{{ '{%\\'%}\\\\\\'}}' > 5 & 4 }}
"),
68 |
69 | array('foo
'),
73 | array('<{{ tagname }}>foo'),
74 | array('foo
'),
78 | array('foo
'),
79 | array('foo
'),
81 |
82 | array(file_get_contents(__DIR__.'/templates/web_profiler_js.html.twig')),
83 | array(file_get_contents(__DIR__.'/templates/logger.html.twig')),
84 | array("{% set a = 1 %}\n\nfoo", "{% set a = 1 %}\n{{ '' }}\nfoo"),
85 | array("{% set a = 1 %}\n\nfoo", "{% set a = 1 %}\n{{ '' }}\nfoo"),
86 | array('test {{ foo }}
test {{ bar }}
test', 'test {% if foo %}{{ foo }}
{% endif %} test {% if bar %}{{ bar }}
{% endif %} test'),
87 | );
88 | }
89 | }
90 |
91 | class DebugTemplateSubscriber implements EventSubscriberInterface
92 | {
93 | public $preLoadTemplate;
94 | public $postDumpTemplate;
95 |
96 | public static function getSubscribedEvents()
97 | {
98 | return array(
99 | CompilerEvents::PRE_LOAD => array('onPreLoad'),
100 | CompilerEvents::POST_DUMP => array('onPostDump'),
101 | );
102 | }
103 |
104 | public function onPreLoad(SourceEvent $event)
105 | {
106 | $this->preLoadTemplate = $event->getTemplate();
107 | }
108 |
109 | public function onPostDump(SourceEvent $event)
110 | {
111 | $this->postDumpTemplate = $event->getTemplate();
112 | }
113 | }
114 |
--------------------------------------------------------------------------------
/tests/Tests/Html5CoreNodesTest.php:
--------------------------------------------------------------------------------
1 | ', '', $str);
39 | return parent::cleanup($str);
40 | }
41 | }
42 |
--------------------------------------------------------------------------------
/tests/Tests/Html5DynamicAttrAttributeTest.php:
--------------------------------------------------------------------------------
1 | loader = new ArrayLoader();
30 | $twitalLoader = new TwitalLoader($this->loader, null, false);
31 | $twitalLoader->addSourceAdapter("/.*/", new HTML5Adapter());
32 |
33 | $this->twig = new Environment($twitalLoader, array(
34 | 'strict_variables' => true
35 | ));
36 | }
37 |
38 | /**
39 | * @dataProvider getData
40 | */
41 | public function testVisitAttribute($source, $expected, $vars = null)
42 | {
43 | $this->loader->setTemplate('template', $source);
44 | $rendered = $this->twig->render('template', $vars ?: array());
45 | $this->assertEquals($expected, $rendered);
46 | }
47 |
48 | public function getData()
49 | {
50 | return array(
51 | array('', '', array('value' => true)),
52 |
53 | array('', '', array('value' => false)),
54 | array('', '', array('value' => 1)),
55 | array('', '', array('value' => 'foo')),
56 |
57 | array('', '', array('value' => true)),
58 | array('', '', array('value' => true)),
59 |
60 | array('', '', array('value' => false)),
61 | array('', '', array('value' => false)),
62 | array('', '', array('value' => false)),
63 |
64 | array('', '', array('value' => 'foo')),
65 | array('', '', array('value' => 'foo')),
66 | array('', '', array('value' => 'foo')),
67 | );
68 | }
69 | }
70 |
--------------------------------------------------------------------------------
/tests/Tests/TwitalLoaderTest.php:
--------------------------------------------------------------------------------
1 | assertSame($loader, $twitalLoader->getLoader());
45 |
46 | $newLoader = new ArrayLoader();
47 | $twitalLoader->setLoader($newLoader);
48 | $this->assertSame($newLoader, $twitalLoader->getLoader());
49 | $this->assertNotSame($loader, $twitalLoader->getLoader());
50 | }
51 |
52 | public function testDefaultAdapters()
53 | {
54 | $twitalLoader = new TwitalLoader();
55 |
56 | $adapters = $twitalLoader->getSourceAdapters();
57 |
58 | $this->assertContainsOnlyInstancesOf('Goetas\Twital\SourceAdapter', $adapters);
59 |
60 | foreach ($this->getRequiredAdapters() as $class) {
61 | $filteredAdapters = array_filter($adapters, function ($adapter) use ($class) {
62 | return is_a($adapter, $class);
63 | });
64 | $this->assertGreaterThanOrEqual(1, count($filteredAdapters), "Cant find any $class adapter");
65 | }
66 | }
67 |
68 | /**
69 | *
70 | * @dataProvider getMatchedFilenames
71 | */
72 | public function testRegexAdapters($filename, $managed)
73 | {
74 | $twitalLoader = new TwitalLoader();
75 | $this->assertEquals($managed, !!$twitalLoader->getSourceAdapter($filename));
76 | }
77 |
78 | public function testTwitalFile()
79 | {
80 | $loader = new ArrayLoader();
81 | $loader->setTemplate('aaa.xml', '');
82 |
83 | $twital = $this->createMock(Twital::class);
84 | $twitalLoader = new TwitalLoader($loader, $twital, false);
85 | $twitalLoader->addSourceAdapter('/.*\.xml$/', new XMLAdapter());
86 |
87 | $twital->expects($this->once())->method('compile')->willReturn('');
88 | $twitalLoader->getSourceContext('aaa.xml');
89 | }
90 |
91 | public function testNonTwitalFile()
92 | {
93 | $loader = new ArrayLoader();
94 | $loader->setTemplate('aaa.txt', '');
95 |
96 | $twital = $this->createMock(Twital::class);
97 | $twitalLoader = new TwitalLoader($loader, $twital, false);
98 | $twitalLoader->addSourceAdapter('/.*\.xml$/', new XMLAdapter());
99 |
100 | $twital->expects($this->never())->method('compile');
101 | $twitalLoader->getSourceContext('aaa.txt');
102 | }
103 |
104 | public function testExistsWithBaseLoaderTwig1()
105 | {
106 | if (Environment::MAJOR_VERSION >= 2) {
107 | $this->markTestSkipped("Twig > 1 has the LoaderInterface::exists method");
108 | }
109 |
110 | $mockLoader = $this->createMock(LoaderInterface::class);
111 | $mockLoader->expects($this->once())->method('getSource')->with($this->equalTo('foo'));
112 |
113 | $twitalLoader = new TwitalLoader($mockLoader, null, false);
114 | $this->assertTrue($twitalLoader->exists('foo'));
115 | }
116 |
117 | public function testNonExistsWithBaseLoaderTwig1()
118 | {
119 | if (Environment::MAJOR_VERSION >= 2) {
120 | $this->markTestSkipped("Twig > 1 has the LoaderInterface::exists method");
121 | }
122 |
123 | $mockLoader = $this->createMock(LoaderInterface::class);
124 |
125 | $mockLoader->expects($this->once())
126 | ->method('getSource')
127 | ->with($this->equalTo('foo'))
128 | ->will($this->throwException(new LoaderError("File not found")));
129 |
130 | $twitalLoader = new TwitalLoader($mockLoader, null, false);
131 | $this->assertFalse($twitalLoader->exists('foo'));
132 | }
133 |
134 | public function testExistsWithBaseLoaderTwigGte2()
135 | {
136 | if (Environment::MAJOR_VERSION < 2) {
137 | $this->markTestSkipped("Twig >= 2 only");
138 | }
139 |
140 | $mockLoader = $this->createMock(LoaderInterface::class);
141 |
142 | $mockLoader->expects($this->once())->method('exists')->will($this->returnValue(true));
143 |
144 | $twitalLoader = new TwitalLoader($mockLoader, null, false);
145 | $this->assertTrue($twitalLoader->exists('foo'));
146 | }
147 |
148 | public function testNonExistsWithBaseLoaderTwigGte2()
149 | {
150 | if (Environment::MAJOR_VERSION < 2) {
151 | $this->markTestSkipped("Twig >= 2 only");
152 | }
153 |
154 | $mockLoader = $this->createMock(LoaderInterface::class);
155 |
156 | $mockLoader->expects($this->once())->method('exists')->will($this->returnValue(false));
157 |
158 | $twitalLoader = new TwitalLoader($mockLoader, null, false);
159 | $this->assertFalse($twitalLoader->exists('foo'));
160 | }
161 |
162 | protected function getRequiredAdapters()
163 | {
164 | return array(
165 | 'Goetas\Twital\SourceAdapter\HTML5Adapter',
166 | 'Goetas\Twital\SourceAdapter\XMLAdapter',
167 | 'Goetas\Twital\SourceAdapter\XHTMLAdapter'
168 | );
169 | }
170 | }
171 |
--------------------------------------------------------------------------------
/tests/Tests/XhtmlCoreNodesTest.php:
--------------------------------------------------------------------------------
1 | {% block block01 %}
2 | Content {{ parent() }}
3 | {% endblock %}
--------------------------------------------------------------------------------
/tests/Tests/templates/base-01.xml:
--------------------------------------------------------------------------------
1 |
2 | Content {{ parent() }}
3 |
--------------------------------------------------------------------------------
/tests/Tests/templates/doctype-01.html.twig:
--------------------------------------------------------------------------------
1 |
2 | foo
3 |
4 |
--------------------------------------------------------------------------------
/tests/Tests/templates/doctype-01.twig:
--------------------------------------------------------------------------------
1 |
2 | foo
--------------------------------------------------------------------------------
/tests/Tests/templates/doctype-01.xml:
--------------------------------------------------------------------------------
1 |
2 | foo
3 |
--------------------------------------------------------------------------------
/tests/Tests/templates/doctype-02.htm:
--------------------------------------------------------------------------------
1 |
2 | foo
3 |
--------------------------------------------------------------------------------
/tests/Tests/templates/doctype-02.twig:
--------------------------------------------------------------------------------
1 |
2 | foo
3 |
4 |
--------------------------------------------------------------------------------
/tests/Tests/templates/embed-01.twig:
--------------------------------------------------------------------------------
1 | {% extends "layout_skeleton.twig" %}
2 | {% block content %}
3 | {% embed "vertical_boxes_skeleton.twig" %}
4 | {% block top %}
5 | Some content for the top box
6 | {% endblock %}{% block bottom %}
7 | Some content for the bottom box
8 | {% endblock %}{% endembed %}
9 | {% endblock %}
--------------------------------------------------------------------------------
/tests/Tests/templates/embed-01.xml:
--------------------------------------------------------------------------------
1 |
6 | {% block block02 %}
7 |
8 | 02
9 |
10 | {% block block03 %}
11 | 03
12 | {% endblock %}
13 |
14 |
15 | {% endblock %}
16 |
17 | some
18 | 19 | {% block block04 %} 20 | 04 21 | {% endblock %} 22 |
23 | {% endblock %} 24 | 25 | {% block block05 %} 26 | 05 27 | {% endblock %} 28 | -------------------------------------------------------------------------------- /tests/Tests/templates/extends-as-attributes-inner.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 |
4 | 01
5 |
6 |
7 |
8 | 02
9 |
10 |
15 | some
16 |
20 |
23 |
24 |
25 |
--------------------------------------------------------------------------------
/tests/Tests/templates/extends-as-attributes-use.twig:
--------------------------------------------------------------------------------
1 | {% extends "foo.twig" %}
2 | {% use "blocks.html" %}
3 | {% block block01 %}
4 |
7 |
8 | 02
9 |
10 |
11 | 03
12 |
13 |
14 |
15 | some
16 | 17 | 04 18 |
19 |
5 | 01
6 |
7 | {% endblock %}
8 |
9 | {% block block05 %}
10 |
11 | {% endblock %}
12 |
--------------------------------------------------------------------------------
/tests/Tests/templates/extends-as-attributes-use.xml:
--------------------------------------------------------------------------------
1 |
2 |
5 | 01
6 |
7 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/tests/Tests/templates/extends-as-attributes.twig:
--------------------------------------------------------------------------------
1 | {% extends "foo.twig" %}
2 |
3 | {% block block01 %}
4 |
5 | 01
6 | {% block block02 %}
7 |
8 | 02
9 | {% block block03 %}
10 |
13 | {% endblock %}
14 |
15 | some
16 |
17 | {% block block04 %}
18 |
21 | {% endblock %}
22 |
23 | {% block block05 %}
24 |
25 | {% endblock %}
26 |
--------------------------------------------------------------------------------
/tests/Tests/templates/extends-as-attributes.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
8 | 02
9 | {% block block03 %}
10 | 03
11 | {% endblock %}
12 |
13 | {% endblock %}
14 |
15 | some
16 |
17 | {% block block04 %}
18 | 04
19 | {% endblock %} 20 |
4 | 01
5 |
6 |
7 |
8 | 02
9 |
10 |
15 | some
16 |
20 |
23 |
24 |
25 |
--------------------------------------------------------------------------------
/tests/Tests/templates/macro-01.html.twig:
--------------------------------------------------------------------------------
1 | {% macro input(name, value, type, size) %}
2 |
3 | {% endmacro %}
--------------------------------------------------------------------------------
/tests/Tests/templates/macro-01.twig:
--------------------------------------------------------------------------------
1 | {% macro input(name, value, type, size) %}
2 |
3 | {% endmacro %}
--------------------------------------------------------------------------------
/tests/Tests/templates/macro-01.xml:
--------------------------------------------------------------------------------
1 |
7 |
8 | 02
9 |
10 |
11 | 03
12 |
13 |
14 |
15 | some
16 | 17 | 04 18 |
19 |
25 | {{ block('header') }}
26 | {% if 'subheader' is block name %}
28 | {% else %}
29 | {{ block('header') }}
30 | {% endif %}
31 |
32 | {% endblock %}
33 |
34 | {% block header %}
35 | {{ 'text' is block name ? block('text') : block('__content__') }}
36 | {% endblock %}
37 |
--------------------------------------------------------------------------------
/tests/Tests/templates/xmldeclaration-01.html.twig:
--------------------------------------------------------------------------------
1 |
2 | foo
--------------------------------------------------------------------------------
/tests/Tests/templates/xmldeclaration-01.twig:
--------------------------------------------------------------------------------
1 |
2 | foo
3 |
--------------------------------------------------------------------------------
/tests/Tests/templates/xmldeclaration-01.xml:
--------------------------------------------------------------------------------
1 |
2 | foo
--------------------------------------------------------------------------------
/tests/bootstrap.php:
--------------------------------------------------------------------------------
1 | {{ block('subheader') }}
{% endif %}
27 |