Completed
Push — master ( 76160a...cc51e4 )
by Todd
13s
created

Compiler::canSkip()   C

Complexity

Conditions 12
Paths 6

Size

Total Lines 23
Code Lines 15

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 15
CRAP Score 12

Importance

Changes 0
Metric Value
dl 0
loc 23
ccs 15
cts 15
cp 1
rs 5.2987
c 0
b 0
f 0
cc 12
eloc 15
nc 6
nop 2
crap 12

How to fix   Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
/**
3
 * @author Todd Burry <[email protected]>
4
 * @copyright 2009-2017 Vanilla Forums Inc.
5
 * @license MIT
6
 */
7
8
namespace Ebi;
9
10
use DOMAttr;
11
use DOMElement;
12
use DOMNode;
13
use Symfony\Component\ExpressionLanguage\SyntaxError;
14
15
class Compiler {
16
    const T_IF = 'x-if';
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 8 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
17
    const T_EACH = 'x-each';
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
18
    const T_WITH = 'x-with';
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
19
    const T_LITERAL = 'x-literal';
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
20
    const T_AS = 'x-as';
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 8 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
21
    const T_COMPONENT = 'x-component';
22
    const T_CHILDREN = 'x-children';
23
    const T_BLOCK = 'x-block';
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
24
    const T_ELSE = 'x-else';
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
25
    const T_EMPTY = 'x-empty';
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
26
    const T_X = 'x';
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 9 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
27
    const T_INCLUDE = 'x-include';
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
28
    const T_EBI = 'ebi';
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 7 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
29
    const T_UNESCAPE = 'x-unescape';
30
    const T_TAG = 'x-tag';
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 7 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
31
32
    const IDENT_REGEX = '`^([a-z0-9-]+)$`i';
33
34
    protected static $special = [
35
        self::T_COMPONENT => 1,
36
        self::T_IF => 2,
37
        self::T_ELSE => 3,
38
        self::T_EACH => 4,
39
        self::T_EMPTY => 5,
40
        self::T_CHILDREN => 6,
41
        self::T_INCLUDE => 7,
42
        self::T_WITH => 8,
43
        self::T_BLOCK => 9,
44
        self::T_LITERAL => 10,
45
        self::T_AS => 11,
46
        self::T_UNESCAPE => 12,
47
        self::T_TAG => 13
48
    ];
49
50
    protected static $htmlTags = [
51
        'a' => 'i',
52
        'abbr' => 'i',
53
        'acronym' => 'i', // deprecated
54
        'address' => 'b',
55
//        'applet' => 'i', // deprecated
0 ignored issues
show
Unused Code Comprehensibility introduced by
50% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
56
        'area' => 'i',
57
        'article' => 'b',
58
        'aside' => 'b',
59
        'audio' => 'i',
60
        'b' => 'i',
61
        'base' => 'i',
62
//        'basefont' => 'i',
0 ignored issues
show
Unused Code Comprehensibility introduced by
58% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
63
        'bdi' => 'i',
64
        'bdo' => 'i',
65
//        'bgsound' => 'i',
0 ignored issues
show
Unused Code Comprehensibility introduced by
54% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
66
//        'big' => 'i',
67
        'x' => 'i',
68
//        'blink' => 'i',
0 ignored issues
show
Unused Code Comprehensibility introduced by
58% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
69
        'blockquote' => 'b',
70
        'body' => 'b',
71
        'br' => 'i',
72
        'button' => 'i',
73
        'canvas' => 'b',
74
        'caption' => 'i',
75
//        'center' => 'b',
0 ignored issues
show
Unused Code Comprehensibility introduced by
58% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
76
        'cite' => 'i',
77
        'code' => 'i',
78
        'col' => 'i',
79
        'colgroup' => 'i',
80
//        'command' => 'i',
0 ignored issues
show
Unused Code Comprehensibility introduced by
58% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
81
        'content' => 'i',
82
        'data' => 'i',
83
        'datalist' => 'i',
84
        'dd' => 'b',
85
        'del' => 'i',
86
        'details' => 'i',
87
        'dfn' => 'i',
88
        'dialog' => 'i',
89
//        'dir' => 'i',
0 ignored issues
show
Unused Code Comprehensibility introduced by
58% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
90
        'div' => 'i',
91
        'dl' => 'b',
92
        'dt' => 'b',
93
//        'element' => 'i',
0 ignored issues
show
Unused Code Comprehensibility introduced by
58% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
94
        'em' => 'i',
95
        'embed' => 'i',
96
        'fieldset' => 'b',
97
        'figcaption' => 'b',
98
        'figure' => 'b',
99
//        'font' => 'i',
0 ignored issues
show
Unused Code Comprehensibility introduced by
58% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
100
        'footer' => 'b',
101
        'form' => 'b',
102
        'frame' => 'i',
103
        'frameset' => 'i',
104
        'h1' => 'b',
105
        'h2' => 'b',
106
        'h3' => 'b',
107
        'h4' => 'b',
108
        'h5' => 'b',
109
        'h6' => 'b',
110
        'head' => 'b',
111
        'header' => 'b',
112
        'hgroup' => 'b',
113
        'hr' => 'b',
114
        'html' => 'b',
115
        'i' => 'i',
116
        'iframe' => 'i',
117
        'image' => 'i',
118
        'img' => 'i',
119
        'input' => 'i',
120
        'ins' => 'i',
121
        'isindex' => 'i',
122
        'kbd' => 'i',
123
        'keygen' => 'i',
124
        'label' => 'i',
125
        'legend' => 'i',
126
        'li' => 'i',
127
        'link' => 'i',
128
//        'listing' => 'i',
0 ignored issues
show
Unused Code Comprehensibility introduced by
58% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
129
        'main' => 'b',
130
        'map' => 'i',
131
        'mark' => 'i',
132
//        'marquee' => 'i',
0 ignored issues
show
Unused Code Comprehensibility introduced by
58% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
133
        'menu' => 'i',
134
        'menuitem' => 'i',
135
        'meta' => 'i',
136
        'meter' => 'i',
137
        'multicol' => 'i',
138
        'nav' => 'b',
139
        'nobr' => 'i',
140
        'noembed' => 'i',
141
        'noframes' => 'i',
142
        'noscript' => 'b',
143
        'object' => 'i',
144
        'ol' => 'b',
145
        'optgroup' => 'i',
146
        'option' => 'b',
147
        'output' => 'i',
148
        'p' => 'b',
149
        'param' => 'i',
150
        'picture' => 'i',
151
//        'plaintext' => 'i',
0 ignored issues
show
Unused Code Comprehensibility introduced by
58% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
152
        'pre' => 'b',
153
        'progress' => 'i',
154
        'q' => 'i',
155
        'rp' => 'i',
156
        'rt' => 'i',
157
        'rtc' => 'i',
158
        'ruby' => 'i',
159
        's' => 'i',
160
        'samp' => 'i',
161
        'script' => 'i',
162
        'section' => 'b',
163
        'select' => 'i',
164
//        'shadow' => 'i',
0 ignored issues
show
Unused Code Comprehensibility introduced by
58% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
165
        'slot' => 'i',
166
        'small' => 'i',
167
        'source' => 'i',
168
//        'spacer' => 'i',
0 ignored issues
show
Unused Code Comprehensibility introduced by
58% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
169
        'span' => 'i',
170
//        'strike' => 'i',
0 ignored issues
show
Unused Code Comprehensibility introduced by
58% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
171
        'strong' => 'i',
172
        'style' => 'i',
173
        'sub' => 'i',
174
        'summary' => 'i',
175
        'sup' => 'i',
176
        'table' => 'b',
177
        'tbody' => 'i',
178
        'td' => 'i',
179
        'template' => 'i',
180
        'textarea' => 'i',
181
        'tfoot' => 'b',
182
        'th' => 'i',
183
        'thead' => 'i',
184
        'time' => 'i',
185
        'title' => 'i',
186
        'tr' => 'i',
187
        'track' => 'i',
188
//        'tt' => 'i',
0 ignored issues
show
Unused Code Comprehensibility introduced by
58% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
189
        'u' => 'i',
190
        'ul' => 'b',
191
        'var' => 'i',
192
        'video' => 'b',
193
        'wbr' => 'i',
194
195
        /// SVG ///
196
        'animate' => 's',
197
        'animateColor' => 's',
198
        'animateMotion' => 's',
199
        'animateTransform' => 's',
200
//        'canvas' => 's',
0 ignored issues
show
Unused Code Comprehensibility introduced by
58% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
201
        'circle' => 's',
202
        'desc' => 's',
203
        'defs' => 's',
204
        'discard' => 's',
205
        'ellipse' => 's',
206
        'g' => 's',
207
//        'image' => 's',
0 ignored issues
show
Unused Code Comprehensibility introduced by
58% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
208
        'line' => 's',
209
        'marker' => 's',
210
        'mask' => 's',
211
        'missing-glyph' => 's',
212
        'mpath' => 's',
213
        'metadata' => 's',
214
        'path' => 's',
215
        'pattern' => 's',
216
        'polygon' => 's',
217
        'polyline' => 's',
218
        'rect' => 's',
219
        'set' => 's',
220
        'svg' => 's',
221
        'switch' => 's',
222
        'symbol' => 's',
223
        'text' => 's',
224
//        'unknown' => 's',
0 ignored issues
show
Unused Code Comprehensibility introduced by
58% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
225
        'use' => 's',
226
    ];
227
228
    protected static $boolAttributes = [
229
        'checked' => 1,
230
        'itemscope' => 1,
231
        'required' => 1,
232
        'selected' => 1,
233
    ];
234
235
    /**
236
     * @var ExpressionLanguage
237
     */
238
    protected $expressions;
239
240 73
    public function __construct() {
241 73
        $this->expressions = new ExpressionLanguage();
242 73
        $this->expressions->setNamePattern('/[@a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*/A');
243 73
        $this->expressions->register(
244 73
            'hasChildren',
245 73
            function ($name = null) {
246 1
                return empty($name) ? 'isset($children[0])' : "isset(\$children[$name ?: 0])";
247 73
            },
248 73
            function ($name = null) {
0 ignored issues
show
Unused Code introduced by
The parameter $name is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
249
                return false;
250 73
            });
251 73
    }
252
253
    /**
254
     * Register a runtime function.
255
     *
256
     * @param string $name The name of the function.
257
     * @param callable $function The function callback.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $function not be callable|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
258
     */
259 71
    public function defineFunction($name, $function = null) {
260 71
        if ($function === null) {
261 1
            $function = $name;
262
        }
263
264 71
        $this->expressions->register(
265 71
            $name,
266 71
            $this->getFunctionCompiler($name, $function),
267 71
            $this->getFunctionEvaluator($function)
268
        );
269 71
    }
270
271 71
    private function getFunctionEvaluator($function) {
0 ignored issues
show
Documentation introduced by
The return type could not be reliably inferred; please add a @return annotation.

Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a @return annotation as described here.

Loading history...
272 71
        if ($function === 'empty') {
273 71
            return function ($expr) {
274
                return empty($expr);
275 71
            };
276 70
        } elseif ($function === 'isset') {
277
            return function ($expr) {
278
                return isset($expr);
279
            };
280
        }
281
282 70
        return $function;
283
    }
284
285 71
    private function getFunctionCompiler($name, $function) {
286 71
        $var = var_export(strtolower($name), true);
287 71
        $fn = function ($expr) use ($var) {
288 1
            return "\$this->call($var, $expr)";
289 71
        };
290
291 71
        if (is_string($function)) {
292 71
            $fn = function (...$args) use ($function) {
293 14
                return $function.'('.implode(', ', $args).')';
294 71
            };
295 70
        } elseif (is_array($function)) {
296 70
            if (is_string($function[0])) {
297
                $fn = function (...$args) use ($function) {
298
                    return "$function[0]::$function[1](".implode(', ', $args).')';
299
                };
300 70
            } elseif ($function[0] instanceof Ebi) {
301 70
                $fn = function (...$args) use ($function) {
302 8
                    return "\$this->$function[1](".implode(', ', $args).')';
303 70
                };
304
            }
305
        }
306
307 71
        return $fn;
308
    }
309
310 65
    public function compile($src, array $options = []) {
311 65
        $options += ['basename' => '', 'path' => '', 'runtime' => true];
312
313 65
        $src = trim($src);
314
315 65
        $out = new CompilerBuffer();
316
317 65
        $out->setBasename($options['basename']);
318 65
        $out->setSource($src);
319 65
        $out->setPath($options['path']);
320
321 65
        $dom = new \DOMDocument();
322
323 65
        $fragment = false;
324 65
        if (strpos($src, '<html') === false) {
325 63
            $src = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><html><body>$src</body></html>";
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
326 63
            $fragment = true;
327
        }
328
329 65
        libxml_use_internal_errors(true);
330 65
        $dom->loadHTML($src, LIBXML_HTML_NOIMPLIED | LIBXML_HTML_NODEFDTD | LIBXML_NOCDATA | LIBXML_NOXMLDECL);
331
//        $arr = $this->domToArray($dom);
0 ignored issues
show
Unused Code Comprehensibility introduced by
59% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
332
333 65
        if ($options['runtime']) {
334 64
            $name = var_export($options['basename'], true);
335 64
            $out->appendCode("\$this->defineComponent($name, function (\$props = [], \$children = []) {\n");
336
        } else {
337 1
            $out->appendCode("function (\$props = [], \$children = []) {\n");
338
        }
339
340 65
        $out->pushScope(['this' => 'props']);
341 65
        $out->indent(+1);
342
343 65
        $parent = $fragment ? $dom->firstChild->nextSibling->firstChild : $dom;
344
345 65
        foreach ($parent->childNodes as $node) {
346 65
            $this->compileNode($node, $out);
347
        }
348
349 58
        $out->indent(-1);
350 58
        $out->popScope();
351
352 58
        if ($options['runtime']) {
353 57
            $out->appendCode("});");
354
        } else {
355 1
            $out->appendCode("};");
356
        }
357
358 58
        $r = $out->flush();
359
360 58
        $errs = libxml_get_errors();
0 ignored issues
show
Unused Code introduced by
$errs is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
361
362 58
        return $r;
363
    }
364
365 50
    protected function isComponent($tag) {
366 50
        return !isset(static::$htmlTags[$tag]);
367
    }
368
369 65
    protected function compileNode(DOMNode $node, CompilerBuffer $out) {
370 65
        if ($out->getNodeProp($node, 'skip')) {
371 4
            return;
372
        }
373
374 65
        switch ($node->nodeType) {
375 65
            case XML_TEXT_NODE:
376 52
                $this->compileTextNode($node, $out);
377 52
                break;
378 62
            case XML_ELEMENT_NODE:
379
                /* @var \DOMElement $node */
380 62
                $this->compileElementNode($node, $out);
381 56
                break;
382 4
            case XML_COMMENT_NODE:
383
                /* @var \DOMComment $node */
384 1
                $this->compileCommentNode($node, $out);
385 1
                break;
386 3
            case XML_DOCUMENT_TYPE_NODE:
387 1
                $out->echoLiteral("<!DOCTYPE {$node->name}>\n");
0 ignored issues
show
Bug introduced by
The property name does not seem to exist in DOMNode.

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
388 1
                break;
389 2
            case XML_CDATA_SECTION_NODE:
390 2
                $this->compileTextNode($node, $out);
391 2
                break;
392
            default:
393
                $r = "// Unknown node\n".
0 ignored issues
show
Unused Code introduced by
$r is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
394
                    '// '.str_replace("\n", "\n// ", $node->ownerDocument->saveHTML($node));
395
        }
396 60
    }
397
398
    protected function domToArray(DOMNode $root) {
0 ignored issues
show
Documentation introduced by
The return type could not be reliably inferred; please add a @return annotation.

Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a @return annotation as described here.

Loading history...
399
        $result = [];
400
401
        if ($root->hasAttributes()) {
402
            $attrs = $root->attributes;
403
            foreach ($attrs as $attr) {
404
                $result['@attributes'][$attr->name] = $attr->value;
405
            }
406
        }
407
408
        if ($root->hasChildNodes()) {
409
            $children = $root->childNodes;
410
            if ($children->length == 1) {
411
                $child = $children->item(0);
412
                if ($child->nodeType == XML_TEXT_NODE) {
413
                    $result['_value'] = $child->nodeValue;
414
                    return count($result) == 1
415
                        ? $result['_value']
416
                        : $result;
417
                }
418
            }
419
            $groups = [];
420
            foreach ($children as $child) {
421
                if (!isset($result[$child->nodeName])) {
422
                    $result[$child->nodeName] = $this->domToArray($child);
423
                } else {
424
                    if (!isset($groups[$child->nodeName])) {
425
                        $result[$child->nodeName] = [$result[$child->nodeName]];
426
                        $groups[$child->nodeName] = 1;
427
                    }
428
                    $result[$child->nodeName][] = $this->domToArray($child);
429
                }
430
            }
431
        }
432
433
        return $result;
434
    }
435
436 1
    protected function newline(DOMNode $node, CompilerBuffer $out) {
437 1
        if ($node->previousSibling && $node->previousSibling->nodeType !== XML_COMMENT_NODE) {
438
            $out->appendCode("\n");
439
        }
440 1
    }
441
442 1
    protected function compileCommentNode(\DOMComment $node, CompilerBuffer $out) {
443 1
        $comments = explode("\n", trim($node->nodeValue));
444
445 1
        $this->newline($node, $out);
446 1
        foreach ($comments as $comment) {
447 1
            $out->appendCode("// $comment\n");
448
        }
449 1
    }
450
451 54
    protected function compileTextNode(DOMNode $node, CompilerBuffer $out) {
452 54
        $nodeText = $node->nodeValue;
453
454 54
        $items = $this->splitExpressions($nodeText);
455 54
        foreach ($items as $i => list($text, $offset)) {
456 54
            if (preg_match('`^{\S`', $text)) {
457 30
                if (preg_match('`^{\s*unescape\((.+)\)\s*}$`', $text, $m)) {
458 3
                    $out->echoCode($this->expr($m[1], $out));
459
                } else {
460
                    try {
461 28
                        $expr = substr($text, 1, -1);
462 28
                        $out->echoCode($this->compileEscape($this->expr($expr, $out)));
463 1
                    } catch (SyntaxError $ex) {
464 1
                        $nodeLineCount = substr_count($nodeText, "\n");
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
465 1
                        $offsetLineCount = substr_count($nodeText, "\n", 0, $offset);
466 1
                        $line = $node->getLineNo() - $nodeLineCount + $offsetLineCount;
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 12 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
467 30
                        throw $out->createCompilerException($node, $ex, ['source' => $expr, 'line' => $line]);
468
                    }
469
                }
470
            } else {
471 54
                if ($i === 0) {
472 54
                    $text = $this->ltrim($text, $node, $out);
473
                }
474 54
                if ($i === count($items) - 1) {
475 54
                    $text = $this->rtrim($text, $node, $out);
476
                }
477
478 54
                $out->echoLiteral($text);
479
            }
480
        }
481 54
    }
482
483 62
    protected function compileElementNode(DOMElement $node, CompilerBuffer $out) {
484 62
        list($attributes, $special) = $this->splitAttributes($node);
485
486 62
        if ($node->tagName === 'script' && ((isset($attributes['type']) && $attributes['type']->value === self::T_EBI) || !empty($special[self::T_AS]) || !empty($special[self::T_UNESCAPE]))) {
487 8
            $this->compileExpressionNode($node, $attributes, $special, $out);
488 55
        } elseif (!empty($special) || $this->isComponent($node->tagName)) {
489 39
            $this->compileSpecialNode($node, $attributes, $special, $out);
490
        } else {
491 30
            $this->compileBasicElement($node, $attributes, $special, $out);
492
        }
493 56
    }
494
495 54
    protected function splitExpressions($value) {
496 54
        $values = preg_split('`({\S[^}]*?})`', $value, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_OFFSET_CAPTURE);
497 54
        return $values;
498
    }
499
500
    /**
501
     * Compile the PHP for an expression
502
     *
503
     * @param string $expr The expression to compile.
504
     * @param CompilerBuffer $out The current output buffer.
505
     * @param DOMAttr|null $attr The owner of the expression.
506
     * @return string Returns a string of PHP code.
507
     */
508 57
    protected function expr($expr, CompilerBuffer $out, DOMAttr $attr = null) {
509 57
        $names = $out->getScopeVariables();
510
511
        try {
512 57
            $compiled = $this->expressions->compile($expr, function ($name) use ($names) {
0 ignored issues
show
Documentation introduced by
function ($name) use($na...e, true) . ']'; } } is of type object<Closure>, but the function expects a array.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
513 51
                if (isset($names[$name])) {
514 31
                    return $names[$name];
515 33
                } elseif ($name[0] === '@') {
516 1
                    return 'this->meta['.var_export(substr($name, 1), true).']';
517
                } else {
518 32
                    return $names['this'].'['.var_export($name, true).']';
519
                }
520 57
            });
521 3
        } catch (SyntaxError $ex) {
522 3
            if ($attr !== null) {
523 1
                throw $out->createCompilerException($attr, $ex);
524
            } else {
525 2
                throw $ex;
526
            }
527
        }
528
529 54
        if ($attr !== null && null !== $fn = $this->getAttributeFunction($attr)) {
530 5
            $compiled = call_user_func($fn, $compiled);
531
        }
532
533 54
        return $compiled;
534
    }
535
536
    /**
537
     * Get the compiler function to wrap an attribute.
538
     *
539
     * Attribute functions are regular expression functions, but with a special naming convention. The following naming
540
     * conventions are supported:
541
     *
542
     * - **@tag:attribute**: Applies to an attribute only on a specific tag.
543
     * - **@attribute**: Applies to all attributes with a given name.
544
     *
545
     * @param DOMAttr $attr The attribute to look at.
546
     * @return callable|null A function or **null** if the attribute doesn't have a function.
547
     */
548 31
    private function getAttributeFunction(DOMAttr $attr) {
549 31
        $keys = ['@'.$attr->ownerElement->tagName.':'.$attr->name, '@'.$attr->name];
550
551 31
        foreach ($keys as $key) {
552 31
            if (null !== $fn = $this->expressions->getFunctionCompiler($key)) {
553 31
                return $fn;
554
            }
555
        }
556 25
    }
557
558
    /**
559
     * @param DOMElement $node
560
     */
561 62
    protected function splitAttributes(DOMElement $node) {
562 62
        $attributes = [];
563 62
        $special = [];
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
564
565 62
        foreach ($node->attributes as $name => $attribute) {
566 58
            if (isset(static::$special[$name])) {
567 43
                $special[$name] = $attribute;
568
            } else {
569 58
                $attributes[$name] = $attribute;
570
            }
571
        }
572
573 62
        uksort($special, function ($a, $b) {
574 12
            return strnatcmp(static::$special[$a], static::$special[$b]);
575 62
        });
576
577 62
        return [$attributes, $special];
578
    }
579
580 39
    protected function compileSpecialNode(DOMElement $node, array $attributes, array $special, CompilerBuffer $out) {
581 39
        $specialName = key($special);
582
583
        switch ($specialName) {
584 39
            case self::T_COMPONENT:
585 10
                $this->compileComponentRegister($node, $attributes, $special, $out);
586 10
                break;
587 39
            case self::T_IF:
588 10
                $this->compileIf($node, $attributes, $special, $out);
589 9
                break;
590 38
            case self::T_EACH:
591 15
                $this->compileEach($node, $attributes, $special, $out);
592 14
                break;
593 27
            case self::T_BLOCK:
594 3
                $this->compileBlock($node, $attributes, $special, $out);
595 2
                break;
596 26
            case self::T_CHILDREN:
597 4
                $this->compileChildBlock($node, $attributes, $special, $out);
598 4
                break;
599 26
            case self::T_INCLUDE:
600 1
                $this->compileComponentInclude($node, $attributes, $special, $out);
601 1
                break;
602 26
            case self::T_WITH:
603 5
                if ($this->isComponent($node->tagName)) {
604
                    // With has a special meaning in components.
605 3
                    $this->compileComponentInclude($node, $attributes, $special, $out);
606
                } else {
607 2
                    $this->compileWith($node, $attributes, $special, $out);
608
                }
609 4
                break;
610 24
            case self::T_LITERAL:
611 2
                $this->compileLiteral($node, $attributes, $special, $out);
612 2
                break;
613 22
            case '':
614 22
                if ($this->isComponent($node->tagName)) {
615 8
                    $this->compileComponentInclude($node, $attributes, $special, $out);
616
                } else {
617 21
                    $this->compileElement($node, $attributes, $special, $out);
618
                }
619 22
                break;
620 1
            case self::T_TAG:
621
            default:
622
                // This is only a tag node so it just gets compiled as an element.
623 1
                $this->compileBasicElement($node, $attributes, $special, $out);
624 1
                break;
625
        }
626 35
    }
627
628
    /**
629
     * Compile component registering.
630
     *
631
     * @param DOMElement $node
632
     * @param $attributes
633
     * @param $special
634
     * @param CompilerBuffer $out
635
     */
636 10
    public function compileComponentRegister(DOMElement $node, $attributes, $special, CompilerBuffer $out) {
637 10
        $name = strtolower($special[self::T_COMPONENT]->value);
638 10
        unset($special[self::T_COMPONENT]);
639
640 10
        $prev = $out->select($name);
641
642 10
        $varName = var_export($name, true);
643 10
        $out->appendCode("\$this->defineComponent($varName, function (\$props = [], \$children = []) {\n");
644 10
        $out->pushScope(['this' => 'props']);
645 10
        $out->indent(+1);
646
647
        try {
648 10
            $this->compileSpecialNode($node, $attributes, $special, $out);
649 10
        } finally {
650 10
            $out->popScope();
651 10
            $out->indent(-1);
652 10
            $out->appendCode("});");
653 10
            $out->select($prev);
654
        }
655 10
    }
656
657 3
    private function compileBlock(DOMElement $node, array $attributes, array $special, CompilerBuffer $out) {
658
        // Blocks must be direct descendants of component includes.
659 3
        if (!$out->getNodeProp($node->parentNode, self::T_INCLUDE)) {
660 1
            throw $out->createCompilerException($node, new \Exception("Blocks must be direct descendants of component includes."));
661
        }
662
663 2
        $name = strtolower($special[self::T_BLOCK]->value);
664 2
        if (empty($name)) {
665
            throw $out->createCompilerException($special[self::T_BLOCK], new \Exception("Block names cannot be empty."));
666
        }
667 2
        if (!preg_match(self::IDENT_REGEX, $name)) {
668
            throw $out->createCompilerException($special[self::T_BLOCK], new \Exception("The block name isn't a valid identifier."));
669
        }
670
671 2
        unset($special[self::T_BLOCK]);
672
673 2
        $prev = $out->select($name, true);
674
675 2
        $vars = array_filter(array_unique($out->getScopeVariables()));
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
676 2
        $vars[] = 'children';
677 2
        $use = '$'.implode(', $', array_unique($vars));
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
678
679 2
        $out->appendCode("function () use ($use) {\n");
680 2
        $out->pushScope(['this' => 'props']);
681 2
        $out->indent(+1);
682
683
        try {
684 2
            $this->compileSpecialNode($node, $attributes, $special, $out);
685 2
        } finally {
686 2
            $out->indent(-1);
687 2
            $out->popScope();
688 2
            $out->appendCode("}");
689 2
            $out->select($prev);
690
        }
691
692 2
        return $out;
693
    }
694
695
    /**
696
     * Compile component inclusion and rendering.
697
     *
698
     * @param DOMElement $node
699
     * @param DOMAttr[] $attributes
700
     * @param DOMAttr[] $special
701
     * @param CompilerBuffer $out
702
     */
703 12
    protected function compileComponentInclude(DOMElement $node, array $attributes, array $special, CompilerBuffer $out) {
704
        // Mark the node as a component include.
705 12
        $out->setNodeProp($node, self::T_INCLUDE, true);
706
707
        // Generate the attributes into a property array.
708 12
        $props = [];
709 12
        foreach ($attributes as $name => $attribute) {
710
            /* @var DOMAttr $attr */
711 5
            if ($this->isExpression($attribute->value)) {
712 4
                $expr = $this->expr(substr($attribute->value, 1, -1), $out, $attribute);
713
            } else {
714 1
                $expr = var_export($attribute->value, true);
715
            }
716
717 5
            $props[] = var_export($name, true).' => '.$expr;
718
        }
719 12
        $propsStr = '['.implode(', ', $props).']';
720
721 12
        if (isset($special[self::T_WITH])) {
722 3
            $withExpr = $this->expr($special[self::T_WITH]->value, $out, $special[self::T_WITH]);
723 3
            unset($special[self::T_WITH]);
724
725 3
            $propsStr = empty($props) ? $withExpr : $propsStr.' + (array)'.$withExpr;
726
        } elseif (empty($props)) {
727
            // By default the current context is passed to components.
728 5
            $propsStr = $this->expr('this', $out);
729
        }
730
731
        // Compile the children blocks.
732 12
        $blocks = $this->compileComponentBlocks($node, $out);
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
733 12
        $blocksStr = $blocks->flush();
734
735 12
        if (isset($special[self::T_INCLUDE])) {
736 1
            $name = $this->expr($special[self::T_INCLUDE]->value, $out, $special[self::T_INCLUDE]);
737
        } else {
738 11
            $name = var_export($node->tagName, true);
739
        }
740
741 12
        $out->appendCode("\$this->write($name, $propsStr, $blocksStr);\n");
742 12
    }
743
744
    /**
745
     * @param DOMElement $parent
746
     * @return CompilerBuffer
747
     */
748 12
    protected function compileComponentBlocks(DOMElement $parent, CompilerBuffer $out) {
749 12
        $blocksOut = new CompilerBuffer(CompilerBuffer::STYLE_ARRAY, [
750 12
            'baseIndent' => $out->getIndent(),
751 12
            'indent' => $out->getIndent() + 1,
752 12
            'depth' => $out->getDepth(),
753 12
            'scopes' => $out->getAllScopes(),
754 12
            'nodeProps' => $out->getNodePropArray()
755
        ]);
756 12
        $blocksOut->setSource($out->getSource());
757
758 12
        if ($this->isEmptyNode($parent)) {
759 9
            return $blocksOut;
760
        }
761
762 4
        $use = '$'.implode(', $', $blocksOut->getScopeVariables()).', $children';
763
764 4
        $blocksOut->appendCode("function () use ($use) {\n");
765 4
        $blocksOut->indent(+1);
766
767
        try {
768 4
            foreach ($parent->childNodes as $node) {
769 4
                $this->compileNode($node, $blocksOut);
770
            }
771 4
        } finally {
772 4
            $blocksOut->indent(-1);
773 4
            $blocksOut->appendCode("}");
774
        }
775
776 4
        return $blocksOut;
777
    }
778
779 28
    protected function compileTagComment(DOMElement $node, $attributes, $special, CompilerBuffer $out) {
0 ignored issues
show
Unused Code introduced by
The parameter $attributes is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
780
        // Don't double up comments.
781 28
        if ($node->previousSibling && $node->previousSibling->nodeType === XML_COMMENT_NODE) {
782
            return;
783
        }
784
785 28
        $str = '<'.$node->tagName;
786 28
        foreach ($special as $attr) {
787
            /* @var DOMAttr $attr */
788 28
            $str .= ' '.$attr->name.(empty($attr->value) ? '' : '="'.htmlspecialchars($attr->value).'"');
789
        }
790 28
        $str .= '>';
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
791 28
        $comments = explode("\n", $str);
792 28
        foreach ($comments as $comment) {
793 28
            $out->appendCode("// $comment\n");
794
        }
795 28
    }
796
797
    /**
798
     * @param DOMElement $node
799
     * @param DOMAttr[] $attributes
800
     * @param DOMAttr[] $special
801
     * @param CompilerBuffer $out
802
     * @param bool $force
803
     */
804 52
    protected function compileOpenTag(DOMElement $node, $attributes, $special, CompilerBuffer $out, $force = false) {
805 52
        $tagNameExpr = !empty($special[self::T_TAG]) ? $special[self::T_TAG]->value : '';
806
807 52
        if ($node->tagName === self::T_X && empty($tagNameExpr)) {
808 5
            return;
809
        }
810
811 50
        if (!empty($tagNameExpr)) {
812 1
            $tagNameExpr = $this->expr($tagNameExpr, $out, $special[self::T_TAG]);
813 1
            $out->echoLiteral('<');
814 1
            $out->echoCode($tagNameExpr);
815
        } else {
816 50
            $out->echoLiteral('<'.$node->tagName);
817
        }
818
819
        /* @var DOMAttr $attribute */
820 50
        foreach ($attributes as $name => $attribute) {
821
            // Check for an attribute expression.
822 18
            if ($this->isExpression($attribute->value)) {
823 14
                $out->echoCode(
824 14
                    '$this->attribute('.var_export($name, true).', '.
825 14
                    $this->expr(substr($attribute->value, 1, -1), $out, $attribute).
826 14
                    ')');
827 5
            } elseif (null !== $fn = $this->getAttributeFunction($attribute)) {
828 3
                $value  = call_user_func($fn, var_export($attribute->value, true));
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned correctly; expected 1 space but found 2 spaces

This check looks for improperly formatted assignments.

Every assignment must have exactly one space before and one space after the equals operator.

To illustrate:

$a = "a";
$ab = "ab";
$abc = "abc";

will have no issues, while

$a   = "a";
$ab  = "ab";
$abc = "abc";

will report issues in lines 1 and 2.

Loading history...
829
830 3
                $out->echoCode('$this->attribute('.var_export($name, true).', '.$value.')');
831 4
            } elseif ((empty($attribute->value) || $attribute->value === $name) && isset(self::$boolAttributes[$name])) {
0 ignored issues
show
Unused Code Bug introduced by
The strict comparison === seems to always evaluate to false as the types of $attribute->value (string) and $name (integer) can never be identical. Maybe you want to use a loose comparison == instead?
Loading history...
832 2
                $out->echoLiteral(' '.$name);
833
            } else {
834 4
                $out->echoLiteral(' '.$name.'="');
835 4
                $out->echoLiteral(htmlspecialchars($attribute->value));
836 18
                $out->echoLiteral('"');
837
            }
838
        }
839
840 50
        if ($node->hasChildNodes() || $force) {
841 48
            $out->echoLiteral('>');
842
        } else {
843 3
            $out->echoLiteral(" />");
844
        }
845 50
    }
846
847 21
    private function isExpression($value) {
848 21
        return preg_match('`^{\S.*}$`', $value);
849
    }
850
851 50
    protected function compileCloseTag(DOMElement $node, $special, CompilerBuffer $out, $force = false) {
852 50
        if (!$force && !$node->hasChildNodes()) {
853 3
            return;
854
        }
855
856 48
        $tagNameExpr = !empty($special[self::T_TAG]) ? $special[self::T_TAG]->value : '';
857 48
        if (!empty($tagNameExpr)) {
858 1
            $tagNameExpr = $this->expr($tagNameExpr, $out, $special[self::T_TAG]);
859 1
            $out->echoLiteral('</');
860 1
            $out->echoCode($tagNameExpr);
861 1
            $out->echoLiteral('>');
862 48
        } elseif ($node->tagName !== self::T_X) {
863 46
            $out->echoLiteral("</{$node->tagName}>");
864
        }
865 48
    }
866
867 4
    protected function isEmptyText(DOMNode $node) {
868 4
        return $node instanceof \DOMText && empty(trim($node->data));
869
    }
870
871 12
    protected function isEmptyNode(DOMNode $node) {
872 12
        if (!$node->hasChildNodes()) {
873 9
            return true;
874
        }
875
876 4
        foreach ($node->childNodes as $childNode) {
877 4
            if ($childNode instanceof DOMElement) {
878 2
                return false;
879
            }
880 2
            if ($childNode instanceof \DOMText && !$this->isEmptyText($childNode)) {
881 2
                return false;
882
            }
883
        }
884
885
        return true;
886
    }
887
888 10
    protected function compileIf(DOMElement $node, array $attributes, array $special, CompilerBuffer $out) {
889 10
        $this->compileTagComment($node, $attributes, $special, $out);
890 10
        $expr = $this->expr($special[self::T_IF]->value, $out, $special[self::T_IF]);
891 9
        unset($special[self::T_IF]);
892
893 9
        $elseNode = $this->findSpecialNode($node, self::T_ELSE, self::T_IF);
894 9
        $out->setNodeProp($elseNode, 'skip', true);
895
896 9
        $out->appendCode('if ('.$expr.") {\n");
897 9
        $out->indent(+1);
898
899 9
        $this->compileSpecialNode($node, $attributes, $special, $out);
900
901 9
        $out->indent(-1);
902
903 9
        if ($elseNode) {
904 2
            list($attributes, $special) = $this->splitAttributes($elseNode);
905 2
            unset($special[self::T_ELSE]);
906
907 2
            $out->appendCode("} else {\n");
908
909 2
            $out->indent(+1);
910 2
            $this->compileSpecialNode($elseNode, $attributes, $special, $out);
911 2
            $out->indent(-1);
912
        }
913
914 9
        $out->appendCode("}\n");
915 9
    }
916
917 15
    protected function compileEach(DOMElement $node, array $attributes, array $special, CompilerBuffer $out) {
918 15
        $this->compileTagComment($node, $attributes, $special, $out);
919 15
        $this->compileOpenTag($node, $attributes, $special, $out);
920
921 15
        $emptyNode = $this->findSpecialNode($node, self::T_EMPTY, self::T_ELSE);
922 15
        $out->setNodeProp($emptyNode, 'skip', true);
923
924 15
        if ($emptyNode === null) {
925 13
            $this->compileEachLoop($node, $attributes, $special, $out);
926
        } else {
927 2
            $expr = $this->expr("empty({$special[self::T_EACH]->value})", $out);
928
929 2
            list ($emptyAttributes, $emptySpecial) = $this->splitAttributes($emptyNode);
930 2
            unset($emptySpecial[self::T_EMPTY]);
931
932 2
            $out->appendCode('if ('.$expr.") {\n");
933
934 2
            $out->indent(+1);
935 2
            $this->compileSpecialNode($emptyNode, $emptyAttributes, $emptySpecial, $out);
936 2
            $out->indent(-1);
937
938 2
            $out->appendCode("} else {\n");
939
940 2
            $out->indent(+1);
941 2
            $this->compileEachLoop($node, $attributes, $special, $out);
942 2
            $out->indent(-1);
943
944 2
            $out->appendCode("}\n");
945
        }
946
947 14
        $this->compileCloseTag($node, $special, $out);
948 14
    }
949
950 2
    protected function compileWith(DOMElement $node, array $attributes, array $special, CompilerBuffer $out) {
951 2
        $this->compileTagComment($node, $attributes, $special, $out);
952
953 2
        $out->depth(+1);
954 2
        $scope = ['this' => $out->depthName('props')];
955 2
        if (!empty($special[self::T_AS])) {
956 2
            if (preg_match(self::IDENT_REGEX, $special[self::T_AS]->value, $m)) {
957
                // The template specified an x-as attribute to alias the with expression.
958 1
                $scope = [$m[1] => $out->depthName('props')];
959
            } else {
960 1
                throw $out->createCompilerException(
961 1
                    $special[self::T_AS],
962 1
                    new \Exception("Invalid identifier \"{$special[self::T_AS]->value}\" in x-as attribute.")
963
                );
964
            }
965
        }
966 1
        $with = $this->expr($special[self::T_WITH]->value, $out);
967
968 1
        unset($special[self::T_WITH], $special[self::T_AS]);
969
970 1
        $out->pushScope($scope);
971 1
        $out->appendCode('$'.$out->depthName('props')." = $with;\n");
972
973 1
        $this->compileSpecialNode($node, $attributes, $special, $out);
974
975 1
        $out->depth(-1);
976 1
        $out->popScope();
977 1
    }
978
979 2
    protected function compileLiteral(DOMElement $node, array $attributes, array $special, CompilerBuffer $out) {
980 2
        $this->compileTagComment($node, $attributes, $special, $out);
981 2
        unset($special[self::T_LITERAL]);
982
983 2
        $this->compileOpenTag($node, $attributes, $special, $out);
984
985 2
        foreach ($node->childNodes as $childNode) {
986 2
            $html = $childNode->ownerDocument->saveHTML($childNode);
987 2
            $out->echoLiteral($html);
988
        }
989
990 2
        $this->compileCloseTag($node, $special, $out);
991 2
    }
992
993 21
    protected function compileElement(DOMElement $node, array $attributes, array $special, CompilerBuffer $out) {
994 21
        $this->compileOpenTag($node, $attributes, $special, $out);
995
996 21
        foreach ($node->childNodes as $childNode) {
997 21
            $this->compileNode($childNode, $out);
998
        }
999
1000 21
        $this->compileCloseTag($node, $special, $out);
1001 21
    }
1002
1003
    /**
1004
     * Find a special node in relation to another node.
1005
     *
1006
     * This method is used to find things such as x-empty and x-else elements.
1007
     *
1008
     * @param DOMElement $node The node to search in relation to.
1009
     * @param string $attribute The name of the attribute to search for.
1010
     * @param string $parentAttribute The name of the parent attribute to resolve conflicts.
1011
     * @return DOMElement|null Returns the found element node or **null** if not found.
1012
     */
1013 23
    protected function findSpecialNode(DOMElement $node, $attribute, $parentAttribute) {
1014
        // First look for a sibling after the node.
1015 23
        for ($sibNode = $node->nextSibling; $sibNode !== null; $sibNode = $sibNode->nextSibling) {
1016 2
            if ($sibNode instanceof DOMElement && $sibNode->hasAttribute($attribute)) {
1017 2
                return $sibNode;
1018
            }
1019
1020
            // Stop searching if we encounter another node.
1021 2
            if (!$this->isEmptyText($sibNode)) {
1022
                break;
1023
            }
1024
        }
1025
1026
        // Next look inside the node.
1027 21
        $parentFound = false;
1028 21
        foreach ($node->childNodes as $childNode) {
1029 20
            if (!$parentFound && $childNode instanceof DOMElement && $childNode->hasAttribute($attribute)) {
1030 2
                return $childNode;
1031
            }
1032
1033 20
            if ($childNode instanceof DOMElement) {
1034 14
                $parentFound = $childNode->hasAttribute($parentAttribute);
1035 9
            } elseif ($childNode instanceof \DOMText && !empty(trim($childNode->data))) {
1036 20
                $parentFound = false;
1037
            }
1038
        }
1039
1040 19
        return null;
1041
    }
1042
1043
    /**
1044
     * @param DOMElement $node
1045
     * @param array $attributes
1046
     * @param array $special
1047
     * @param CompilerBuffer $out
1048
     */
1049 15
    private function compileEachLoop(DOMElement $node, array $attributes, array $special, CompilerBuffer $out) {
0 ignored issues
show
Unused Code introduced by
The parameter $attributes is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1050 15
        $each = $this->expr($special[self::T_EACH]->value, $out);
1051 15
        unset($special[self::T_EACH]);
1052
1053 15
        $as = ['', $out->depthName('props', 1)];
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
1054 15
        $scope = ['this' => $as[1]];
1055 15
        if (!empty($special[self::T_AS])) {
1056 8
            if (preg_match('`^(?:([a-z0-9]+)\s+)?([a-z0-9]+)$`i', $special[self::T_AS]->value, $m)) {
1057 7
                $scope = [$m[2] => $as[1]];
1058 7
                if (!empty($m[1])) {
1059 7
                    $scope[$m[1]] = $as[0] = $out->depthName('i', 1);
1060
                }
1061
            } else {
1062 1
                throw $out->createCompilerException(
1063 1
                    $special[self::T_AS],
1064 1
                    new \Exception("Invalid identifier \"{$special[self::T_AS]->value}\" in x-as attribute.")
1065
                );
1066
            }
1067
        }
1068 14
        unset($special[self::T_AS]);
1069 14
        if (empty($as[0])) {
1070 10
            $out->appendCode("foreach ($each as \${$as[1]}) {\n");
1071
        } else {
1072 4
            $out->appendCode("foreach ($each as \${$as[0]} => \${$as[1]}) {\n");
1073
        }
1074 14
        $out->depth(+1);
1075 14
        $out->indent(+1);
1076 14
        $out->pushScope($scope);
1077
1078 14
        foreach ($node->childNodes as $childNode) {
1079 14
            $this->compileNode($childNode, $out);
1080
        }
1081
1082 14
        $out->indent(-1);
1083 14
        $out->depth(-1);
1084 14
        $out->popScope();
1085 14
        $out->appendCode("}\n");
1086 14
    }
1087
1088 54
    protected function ltrim($text, \DOMNode $node, CompilerBuffer $out) {
0 ignored issues
show
Documentation introduced by
The return type could not be reliably inferred; please add a @return annotation.

Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a @return annotation as described here.

Loading history...
1089 54
        if ($this->inPre($node)) {
1090
            return $text;
1091
        }
1092
1093
1094 54
        for ($sib = $node->previousSibling; $sib !== null && $this->canSkip($sib, $out); $sib = $sib->previousSibling) {
0 ignored issues
show
Unused Code introduced by
This for loop is empty and can be removed.

This check looks for for loops that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete.

Consider removing the loop.

Loading history...
1095
            //
1096
        }
1097 54
        if ($sib === null) {
1098 54
            return ltrim($text);
1099
        }
1100
//        if ($this->canSkip($sib, $out)) {
0 ignored issues
show
Unused Code Comprehensibility introduced by
61% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
1101
//            return ltrim($text);
1102
//        }
1103
1104 6
        $text = preg_replace('`^\s*\n\s*`', "\n", $text, -1, $count);
1105 6
        if ($count === 0) {
1106
            $text = preg_replace('`^\s+`', ' ', $text);
1107
        }
1108
1109
//        if ($sib !== null && ($sib->nodeType === XML_COMMENT_NODE || in_array($sib->tagName, static::$blocks))) {
0 ignored issues
show
Unused Code Comprehensibility introduced by
53% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
1110
//            return ltrim($text);
1111
//        }
1112 6
        return $text;
1113
    }
1114
1115
    /**
1116
     * Whether or not a node can be skipped for the purposes of trimming whitespace.
1117
     *
1118
     * @param DOMNode|null $node The node to test.
1119
     * @param CompilerBuffer|null $out The compiler information.
1120
     * @return bool Returns **true** if whitespace can be trimmed right up to the node or **false** otherwise.
1121
     */
1122 12
    private function canSkip(\DOMNode $node, CompilerBuffer $out) {
1123 12
        if ($out->getNodeProp($node, 'skip')) {
1124 2
            return true;
1125
        }
1126
1127 12
        switch ($node->nodeType) {
1128 12
            case XML_TEXT_NODE:
1129 2
                return false;
1130 12
            case XML_COMMENT_NODE:
1131 1
                return true;
1132 12
            case XML_ELEMENT_NODE:
1133
                /* @var \DOMElement $node */
1134 12
                if ($node->tagName === self::T_X
1135 11
                    || ($node->tagName === 'script' && $node->hasAttribute(self::T_AS)) // expression assignment
1136 8
                    || ($node->hasAttribute(self::T_WITH) && $node->hasAttribute(self::T_AS)) // with assignment
1137 12
                    || ($node->hasAttribute(self::T_BLOCK) || $node->hasAttribute(self::T_COMPONENT))
1138
                ) {
1139 6
                    return true;
1140
                }
1141
        }
1142
1143 7
        return false;
1144
    }
1145
1146 54
    protected function rtrim($text, \DOMNode $node, CompilerBuffer $out) {
0 ignored issues
show
Documentation introduced by
The return type could not be reliably inferred; please add a @return annotation.

Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a @return annotation as described here.

Loading history...
1147 54
        if ($this->inPre($node)) {
1148
            return $text;
1149
        }
1150
1151 54
        for ($sib = $node->nextSibling; $sib !== null && $this->canSkip($sib, $out); $sib = $sib->nextSibling) {
0 ignored issues
show
Unused Code introduced by
This for loop is empty and can be removed.

This check looks for for loops that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete.

Consider removing the loop.

Loading history...
1152
            //
1153
        }
1154 54
        if ($sib === null) {
1155 53
            return rtrim($text);
1156
        }
1157
1158 5
        $text = preg_replace('`\s*\n\s*$`', "\n", $text, -1, $count);
1159 5
        if ($count === 0) {
1160 5
            $text = preg_replace('`\s+$`', ' ', $text);
1161
        }
1162
1163
//        if ($sib !== null && ($sib->nodeType === XML_COMMENT_NODE || in_array($sib->tagName, static::$blocks))) {
0 ignored issues
show
Unused Code Comprehensibility introduced by
53% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
1164
//            return rtrim($text);
1165
//        }
1166 5
        return $text;
1167
    }
1168
1169 54
    protected function inPre(\DOMNode $node) {
1170 54
        for ($node = $node->parentNode; $node !== null; $node = $node->parentNode) {
1171 54
            if (in_array($node->nodeType, ['code', 'pre'], true)) {
1172
                return true;
1173
            }
1174
        }
1175 54
        return false;
1176
    }
1177
1178 4
    private function compileChildBlock(DOMElement $node, array $attributes, array $special, CompilerBuffer $out) {
1179
        /* @var DOMAttr $child */
1180 4
        $child = $special[self::T_CHILDREN];
1181 4
        unset($special[self::T_CHILDREN]);
1182
1183 4
        $name = $child->value === '' ? 0 : strtolower($child->value);
1184 4
        if ($name !== 0) {
1185 2
            if (empty($name)) {
1186
                throw $out->createCompilerException($special[self::T_BLOCK], new \Exception("Block names cannot be empty."));
1187
            }
1188 2
            if (!preg_match(self::IDENT_REGEX, $name)) {
1189
                throw $out->createCompilerException($special[self::T_BLOCK], new \Exception("The block name isn't a valid identifier."));
1190
            }
1191
        }
1192
1193 4
        $keyStr = var_export($name, true);
1194
1195 4
        $this->compileOpenTag($node, $attributes, $special, $out, true);
1196
1197 4
        $out->appendCode("\$this->writeChildren(\$children[{$keyStr}]);\n");
1198
1199 4
        $this->compileCloseTag($node, $special, $out, true);
1200 4
    }
1201
1202
    /**
1203
     * Compile an x-expr node.
1204
     *
1205
     * @param DOMElement $node The node to compile.
1206
     * @param DOMAttr[] $attributes The node's attributes.
1207
     * @param DOMAttr[] $special An array of special attributes.
1208
     * @param CompilerBuffer $out The compiler output.
1209
     */
1210 8
    private function compileExpressionNode(DOMElement $node, array $attributes, array $special, CompilerBuffer $out) {
0 ignored issues
show
Unused Code introduced by
The parameter $attributes is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1211 8
        $str = $raw = $node->nodeValue;
0 ignored issues
show
Unused Code introduced by
$raw is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
1212
1213
        try {
1214 8
            $expr = $this->expr($str, $out);
1215 1
        } catch (SyntaxError $ex) {
1216 1
            throw $out->createCompilerException($node, $ex);
1217
        }
1218
1219 7
        if (!empty($special[self::T_AS])) {
1220 5
            if (preg_match(self::IDENT_REGEX, $special[self::T_AS]->value, $m)) {
1221
                // The template specified an x-as attribute to alias the with expression.
1222 4
                $out->depth(+1);
1223 4
                $scope = [$m[1] => $out->depthName('expr')];
1224 4
                $out->pushScope($scope);
1225 4
                $out->appendCode('$'.$out->depthName('expr')." = $expr;\n");
1226
            } else {
1227 1
                throw $out->createCompilerException(
1228 1
                    $special[self::T_AS],
1229 5
                    new \Exception("Invalid identifier \"{$special[self::T_AS]->value}\" in x-as attribute.")
1230
                );
1231
            }
1232 2
        } elseif (!empty($special[self::T_UNESCAPE])) {
1233 1
            $out->echoCode($expr);
1234
        } else {
1235 1
            $out->echoCode($this->compileEscape($expr));
1236
        }
1237 6
    }
1238
1239
    /**
1240
     * @param DOMElement $node
1241
     * @param $attributes
1242
     * @param $special
1243
     * @param CompilerBuffer $out
1244
     */
1245 30
    protected function compileBasicElement(DOMElement $node, $attributes, $special, CompilerBuffer $out) {
1246 30
        $this->compileOpenTag($node, $attributes, $special, $out);
1247
1248 30
        foreach ($node->childNodes as $childNode) {
1249 28
            $this->compileNode($childNode, $out);
1250
        }
1251
1252 29
        $this->compileCloseTag($node, $special, $out);
1253 29
    }
1254
1255 28
    protected function compileEscape($php) {
1256
//        return 'htmlspecialchars('.$php.')';
0 ignored issues
show
Unused Code Comprehensibility introduced by
56% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
1257 28
        return '$this->escape('.$php.')';
1258
    }
1259
}
1260