├── README.md
└── php2twig


/README.md:
--------------------------------------------------------------------------------
 1 | # php-twig-converter
 2 | 
 3 | This little php script is intended to convert at best template files written 
 4 | with the PHPTemplate syntax to Twig syntax.
 5 | 
 6 | ## Usage
 7 | 
 8 | You can pass directly content to the script via stdin, it will return the 
 9 | converted template through stdout.
10 | 
11 |     $ cat page.tpl.php | ./php2twig
12 |     
13 | You can pass file names to the script, it will create a `.tpl.twig` file at the 
14 | same location:
15 | 
16 |     $ ls
17 |     node.tpl.php page.tpl.php
18 |     $ ./php2twig node.tpl.php page.tpl.php
19 |     $ ls
20 |     node.tpl.php node.tpl.twig page.tpl.php page.tpl.twig
21 |     
22 | 
23 | ## Options
24 | 
25 | By default when converting files, the PHPTemplate extension is `.tpl.php`, you 
26 | can override it with `-e`:
27 | 
28 |     $ ls
29 |     node.template
30 |     $ ./php2twig node.template -e ".template"
31 |     $ ls
32 |     node.template node.tpl.twig
33 |     
34 | 
35 | By default when converting files, the new Twig extension is `.tpl.twig`, you 
36 | can override it with `-ne`:
37 | 
38 |     $ ls
39 |     node.tpl.php
40 |     $ ./php2twig node.tpl.php -ne ".html.twig"
41 |     $ ls
42 |     node.html.twig node.tpl.php
43 | 
44 | ## Demo
45 | 
46 | `$ ./php2twig modules/block/block.tpl.php`
47 | 
48 | ```
49 | <div id="<?php print $block_html_id; ?>" class="<?php print $classes; ?>"<?php print $attributes; ?>>
50 | 
51 |   <?php print render($title_prefix); ?>
52 | <?php if ($block->subject): ?>
53 |   <h2<?php print $title_attributes; ?>><?php print $block->subject ?></h2>
54 | <?php endif;?>
55 |   <?php print render($title_suffix); ?>
56 | 
57 |   <div class="content"<?php print $content_attributes; ?>>
58 |     <?php print $content ?>
59 |   </div>
60 | </div>
61 | ```
62 | 
63 | will convert to
64 | 
65 | ```
66 | <div id="{{ block_html_id }} " class="{{ classes }} "{{ attributes }} >
67 | 
68 |   {{ title_prefix }}
69 | {% if block.subject %}
70 |   <h2{{ title_attributes }} >{{ block.subject}}</h2>
71 | {% endif %}
72 |   {{ title_suffix }}
73 | 
74 |   <div class="content"{{ content_attributes }} >
75 |     {{ content }}
76 |   </div>
77 | </div>
78 | ```
79 | 
80 | 
81 | 
82 | 


--------------------------------------------------------------------------------
/php2twig:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env php
  2 | <?php
  3 | 
  4 | $options = [
  5 |     'extension'     => '.tpl.php',
  6 |     'new_extension' => '.tpl.twig',
  7 |     'recursive'     => false,
  8 | ];
  9 | 
 10 | // First we need to get some arguments
 11 | if ($argc > 1) {
 12 |     $files = [];
 13 |     $current_dir = getcwd();
 14 | 
 15 |     // Look for commonly found arguments
 16 |     $cargv = count($argv);
 17 |     for ($i = 1; $i <= $argc && $i <= $cargv - 1; $i++) {
 18 |         switch ($argv[$i]) {
 19 |             case '-h':
 20 |             case '--help':
 21 |                 print <<<HELP
 22 | php2twig: Convert PHPTemplate files to twig
 23 | 
 24 | Usage:
 25 |   Provide a location to a file or directory as argument to convert all .tpl.php
 26 |   files.
 27 | 
 28 | Options:
 29 |   -h    Display this help
 30 |   -r    Recursive
 31 |   -e    Extension (default: .tpl.php)
 32 |   -ne   New extension (default: .tpl.twig)
 33 |   -v    Verbose
 34 | 
 35 | Examples:
 36 |   - ./php2twig -ne .html.twig **/*.tpl.php
 37 |   - ./php2twig -r 1 .
 38 | 
 39 | HELP;
 40 |                 break;
 41 | 
 42 |             // Extension
 43 |             case '-e':
 44 |                 if (!isset($argv[$i + 1])) {
 45 |                     die("You must provide an extension");
 46 |                 }
 47 |                 $options['extension'] = $argv[$i + 1];
 48 |                 $i++;
 49 |                 break;
 50 | 
 51 |             // New extension
 52 |             case '-ne':
 53 |                 if (!isset($argv[$i + 1])) {
 54 |                     die("You must provide an extension");
 55 |                 }
 56 |                 $options['new_extension'] = $argv[$i + 1];
 57 |                 $i++;
 58 |                 break;
 59 | 
 60 |             // Recursive
 61 |             case '-r':
 62 |                 $options['recursive'] = true;
 63 |                 break;
 64 | 
 65 |             // Files
 66 |             default:
 67 |                 if (!isset($argv[$i])) {
 68 |                     break 2;
 69 |                 }
 70 | 
 71 |                 // Treat locations
 72 |                 $file = $argv[$i];
 73 |                 if (is_file($file)) {
 74 |                     $files[] = $file;
 75 |                 } else {
 76 |                     echo "$file is not a valid file path.\n";
 77 |                 }
 78 |         }
 79 |     }
 80 | 
 81 |     // Treat files
 82 |     if (!empty($files)) {
 83 |         foreach ($files as $file) {
 84 |             $new_name = str_replace($options['extension'], $options['new_extension'], basename($file));
 85 |             echo "Converting $file to $new_name\n";
 86 |             $converted = convert_phptemplate(file_get_contents($file));
 87 |             file_put_contents(dirname($file).'/'.$new_name, $converted, FILE_TEXT);
 88 |         }
 89 |     }
 90 | } else {
 91 |     $str = file_get_contents('php://stdin');
 92 |     if ($str) {
 93 |         print convert_phptemplate($str);
 94 |     } else {
 95 |         die("No file or directory specified");
 96 |     }
 97 | }
 98 | 
 99 | /**
100 |  * Function
101 |  *
102 |  * @param $str string
103 |  * @return array
104 |  */
105 | function convert_phptemplate($str)
106 | {
107 |     $tokens = token_get_all($str);
108 |     $output = '';
109 | 
110 |     // Unsupported tokens
111 |     $mapping = [
112 |         T_ARRAY, // array()
113 |         T_BREAK, // break",
114 |         T_CASE, // , // case in a switch",
115 |         T_CONTINUE, // ", // continue in a loop",
116 |         T_CURLY_OPEN, // ", // complex variable parsed syntax",
117 |         T_DEFAULT, // ", // default in a switch",
118 |         T_DO, // ", // do in a do..while",
119 |         T_DOLLAR_OPEN_CURLY_BRACES, // complex variable parsed syntax",
120 |         T_ENCAPSED_AND_WHITESPACE, // \" \$a\" constant part of string with variables",
121 |         T_ENDSWITCH, // endswitch switch, alternative syntax",
122 |         T_ENDWHILE, // endwhile while, alternative syntax",
123 |         T_FOR, // for",
124 |         T_INCLUDE, // include()",
125 |         T_INCLUDE_ONCE, // include_once()",
126 |         T_NUM_STRING, // \"\$a[0]\" numeric array index inside string",
127 |         T_REQUIRE, // require()",
128 |         T_REQUIRE_ONCE, // require_once()",
129 |         T_STRING_VARNAME, // \"$\{a complex variable parsed syntax",
130 |         T_SWITCH, // switch",
131 |     ];
132 | 
133 |     // LIFO list of end tags
134 |     $nesting = [];
135 |     // list of flags
136 |     $flags = [];
137 | 
138 |     $debug = 0;
139 | 
140 |     while ($token = current($tokens)) {
141 |         $index = key($tokens);
142 | 
143 |         // Display information about tokens
144 |         if (is_array($token) && ($debug || in_array($token[0], $mapping))) {
145 |             echo "Index $index, Line {$token[2]}: ", token_name($token[0]), "\t\t{$token[1]}", PHP_EOL;
146 |         } elseif ($debug) {
147 |             echo "Index $index, $token", PHP_EOL;
148 |         }
149 | 
150 |         if (is_array($token)) {
151 |             // Token, not characters
152 |             $name = $token[0];
153 |             $value = $token[1];
154 | 
155 |             // Some tokens depends on following expressions (+=, ++, etc.)
156 |             if (isset($tokens[$index + 1])) {
157 |                 $i = $index;
158 |                 while (isset($tokens[$i + 1]) && $tokens[$i + 1][0] == T_WHITESPACE) {
159 |                     $i++;
160 |                 }
161 |                 $next = $tokens[$i + 1];
162 |                 if (is_array($next)) {
163 |                     if (in_array($next[0], [T_OR_EQUAL, T_PLUS_EQUAL, T_MUL_EQUAL, T_MINUS_EQUAL, T_MUL_EQUAL])) {
164 |                         $output .= $value.' '.substr($token[1], 0, 1).' '.$value;
165 |                         next($tokens);
166 |                         continue;
167 |                     } elseif ($next[0] == T_INC) {
168 |                         $output .= "{% $value = $value + 1 %}";
169 |                         next($tokens);
170 |                         next($tokens);
171 |                         continue;
172 |                     } elseif ($next[0] == T_DEC) {
173 |                         $output .= "{% $value = $value - 1 %}";
174 |                         next($tokens);
175 |                         next($tokens);
176 |                         continue;
177 |                     }
178 |                 }
179 |             }
180 | 
181 |             if (in_array($name, [
182 |                 T_OR_EQUAL,
183 |                 T_PLUS_EQUAL,
184 |                 T_MUL_EQUAL,
185 |                 T_MINUS_EQUAL,
186 |                 T_ISSET,
187 |                 T_DOUBLE_ARROW,
188 |                 T_OPEN_TAG,
189 |                 T_DOC_COMMENT, // TODO Convert to twig doc?
190 |             ])) {
191 |                 // Ignore these tokens
192 | 
193 |             } elseif (in_array($name, [T_CLOSE_TAG, T_INLINE_HTML])) {
194 |                 // When closing tags or displaying HTML, end nesting
195 |                 $nest = array_pop($nesting);
196 |                 // Remove last space for filters
197 |                 if ($nest[0] == '|') {
198 |                     $output = rtrim($output, ' ');
199 |                 }
200 |                 $output .= $nest;
201 |                 $output .= str_replace("?>", "", $value);
202 | 
203 |             } elseif (in_array($name, [
204 |                 T_WHITESPACE,
205 |                 T_LOGICAL_AND,
206 |                 T_LOGICAL_OR,
207 |                 T_CONSTANT_ENCAPSED_STRING,
208 |                 T_LNUMBER,
209 |                 T_DNUMBER,
210 |                 T_IS_GREATER_OR_EQUAL,
211 |                 T_IS_SMALLER_OR_EQUAL,
212 |             ])) {
213 |                 // These are the same in twig
214 |                 $output .= $value;
215 | 
216 |             } elseif ($name == T_VARIABLE) {
217 |                 // Variable, remove leading '$'
218 |                 $output .= substr($value, 1);
219 | 
220 |             } elseif ($name == T_ECHO || $name == T_PRINT) {
221 |                 // Print something
222 |                 $output .= '{{';
223 |                 $nesting[] = '}}';
224 | 
225 |             } elseif ($name == T_STRING) {
226 |                 // Function call
227 |                 if ($value == 't') {
228 |                     $nest = array_pop($nesting);
229 |                     $nesting[] = '|t '.$nest;
230 |                 } elseif ($value == 'render') {
231 |                     // Ignore
232 |                 } elseif (in_array('inside_object_method', $flags) && next($tokens) !== '(') {
233 |                     $output .= $value;
234 |                 } else {
235 |                     $output .= $value.'(';
236 |                     $nesting[] = ')';
237 |                     $flags[] = 'inside_func_call';
238 |                     echo "Unsupported function $value().\n";
239 |                 }
240 |                 // TODO maybe handle theme() ?
241 | 
242 |             } elseif ($name == T_IS_EQUAL || $name == T_IS_IDENTICAL) {
243 |                 $output .= ' is ';
244 | 
245 |             } elseif ($name == T_IS_NOT_EQUAL || $name == T_IS_NOT_IDENTICAL) {
246 |                 $output .= ' is not ';
247 | 
248 |             } elseif ($name == T_BOOLEAN_AND) {
249 |                 $output .= ' and ';
250 | 
251 |             } elseif ($name == T_BOOLEAN_OR) {
252 |                 $output .= ' or ';
253 | 
254 |             } elseif ($name == T_IF) {
255 |                 // There should be an expression after this, so we close it in ':' or '{'
256 |                 $output .= '{% if';
257 |                 $nesting[] = '%}';
258 |                 $flags[] = 'inside_condition';
259 |                 $flags[] = 'inside_if';
260 | 
261 |             } elseif ($name == T_ENDIF) {
262 |                 if (in_array('inside_if', $flags)) {
263 |                     unset($flags[array_search('inside_if', $flags)]);
264 |                 }
265 |                 $output .= '{% endif %}';
266 | 
267 |             } elseif ($name == T_ENDFOR || $name == T_ENDFOREACH) {
268 |                 $output .= '{% endfor %}';
269 | 
270 |             } elseif ($name == T_ELSEIF) {
271 |                 // There should be an expression after this, so we close it in ':' or '{'
272 |                 $output .= '{% elseif ';
273 |                 $flags[] = 'inside_condition';
274 |                 $nesting[] = '%}';
275 | 
276 |             } elseif ($name == T_ELSE) {
277 |                 $output .= '{% else %} ';
278 | 
279 |             } elseif ($name == T_OBJECT_OPERATOR) {
280 |                 // This is object call or property ->
281 |                 $flags[] = 'inside_object_method';
282 |                 $output .= '.';
283 | 
284 |             } elseif ($name == T_EMPTY) {
285 |                 // !empty() is managed in '!', flag to be closed in '?'
286 |                 $flags[] = 'inside_empty_condition';
287 |                 $nesting[] = 'is empty ';
288 | 
289 |             } elseif ($name == T_COMMENT) {
290 |                 if ($value[1] == '*') {
291 |                     // Multiline comment, remove ' * ' on each line
292 |                     $value = preg_replace('@/\*(.+)\s+\*/@sU', '{# $1 #}', $value);
293 |                     $value = preg_replace('@\s{3}\*\s@s', '', $value);
294 |                     $output .= $value;
295 |                 } else {
296 |                     // Single line comment that may be multiline (lol), so take care of this
297 |                     $output .= "{# ";
298 |                     prev($tokens);
299 |                     $matches = null;
300 |                     while (($token = next($tokens)) && is_array($token) && in_array($token[0],
301 |                             [T_WHITESPACE, T_COMMENT])) {
302 |                         if ($token[0] == T_COMMENT) {
303 |                             if (isset($matches[2])) {
304 |                                 $output .= "$matches[2]";
305 |                             }
306 |                             preg_match('@^//\s?(.*)(\s*)@', $token[1], $matches);
307 |                             $output .= "$matches[1]";
308 |                         } else {
309 |                             $matches[2] .= "$token[1]";
310 |                         }
311 |                     }
312 |                     $output .= " #}".$matches[2];
313 |                     prev($tokens);
314 |                 }
315 | 
316 |             } elseif ($name == T_FOREACH) {
317 |                 // foreach($iterated as $index => $value) -> for(value in iterated) _or_ for(index, value in iterated)
318 |                 $output .= '{% for';
319 |                 while (!is_array($token) || !in_array($token[0], [T_VARIABLE, T_STRING])) {
320 |                     $token = next($tokens);
321 |                 }
322 |                 $iterated = substr($token[1], 1);
323 |                 while (!is_array($token) || $token[0] !== T_AS) {
324 |                     $token = next($tokens);
325 |                 }
326 |                 while (!is_array($token) || $token[0] !== T_VARIABLE) {
327 |                     $token = next($tokens);
328 |                 }
329 |                 $index_name = substr($token[1], 1);
330 | 
331 |                 // Try to find value in next four tokens
332 |                 $i = 6;
333 |                 while (($token = next($tokens)) && $i) {
334 |                     if (is_array($token) && $token[0] == T_VARIABLE) {
335 |                         $value = substr($token[1], 1);
336 |                         $output .= " $index_name, $value in $iterated %}";
337 |                         break;
338 |                     }
339 |                     $i--;
340 |                 }
341 |                 if (!$i) {
342 |                     $output .= " $index_name in $iterated %}";
343 |                     // We've got too far, go back a bit
344 |                     prev($tokens);
345 |                     prev($tokens);
346 |                     prev($tokens);
347 |                     prev($tokens);
348 |                 }
349 | 
350 |             } else {
351 |                 // unsupported
352 |                 echo "WARNING: UNSUPPORTED ".token_name($token[0])."\n";
353 |             }
354 |         } else {
355 |             // Characters
356 |             switch ($token) {
357 |                 case ';':
358 |                     // This close a function call or a print
359 |                     if (in_array('inside_func_call', $flags)) {
360 |                         $output .= array_pop($nesting);
361 |                         unset($flags[array_search('inside_func_call', $flags)]);
362 |                     }
363 |                     if (in_array('}}', $nesting)) {
364 |                         $output .= ' '.array_pop($nesting);
365 |                     }
366 |                     break;
367 | 
368 |                 case ':':
369 |                     // This must print inside ternary, else we don't care
370 |                     if (in_array('inside_ternary', $flags)) {
371 |                         $output .= $token;
372 |                         unset($flags[array_search('inside_ternary', $flags)]);
373 |                     }
374 |                     // This might close a if expression
375 |                     if (in_array('inside_condition', $flags)) {
376 |                         $output .= ' '.array_pop($nesting);
377 |                         unset($flags[array_search('inside_condition', $flags)]);
378 |                     }
379 |                     break;
380 | 
381 |                 case '(':
382 |                 case ')':
383 |                 case ']':
384 |                     // Ignored
385 |                     break;
386 | 
387 |                 case '{':
388 |                     // This might close an expression
389 |                     if (count($nesting)) {
390 |                         $output .= array_pop($nesting);
391 |                     }
392 |                     break;
393 | 
394 |                 case '}':
395 |                     // This might close a if block
396 |                     if (in_array('inside_if', $flags)) {
397 |                         $output .= '{% endif %}';
398 |                         unset($flags[array_search('inside_if', $flags)]);
399 |                     }
400 |                     break;
401 | 
402 |                 case '[':
403 |                     // Accessing key of an array
404 |                     $next = next($tokens);
405 |                     if (is_array($next) && $next[0] == T_CONSTANT_ENCAPSED_STRING) {
406 |                         if ($next[1][1] == '#') {
407 |                             // verify unsupported first characters
408 |                             $output .= "[$next[1]]";
409 |                         } else {
410 |                             // else remove quotes
411 |                             $output .= '.'.substr($next[1], 1, -1);
412 |                         }
413 |                     } elseif (is_array($next) && $next[0] == T_VARIABLE) {
414 |                         // Remove leading '$'
415 |                         $output .= '.'.substr($next[1], 1);
416 |                     } elseif (is_array($next) && $next[0] == T_LNUMBER) {
417 |                         // no treatment on numbers
418 |                         $output .= '.'.$next[1];
419 |                     } elseif (is_array($next)) {
420 |                         die("Unsupported array/object traversing with ".token_name($next[0]));
421 |                     } else {
422 |                         die("Unsupported array/object traversing with $next");
423 |                     }
424 |                     break;
425 | 
426 |                 case '!':
427 |                     // Verify next token is not empty()
428 |                     $next = next($tokens);
429 |                     if (is_array($next) && $next[0] == T_EMPTY) {
430 |                         // if empty(), ignore
431 |                     } else {
432 |                         prev($tokens);
433 |                         $output .= "not ";
434 |                     }
435 |                     break;
436 | 
437 |                 case '.':
438 |                     // Concatenation
439 |                     $output .= '~';
440 |                     break;
441 | 
442 |                 case '?':
443 |                     // Ternary condition
444 |                     if (in_array('inside_empty_condition', $flags)) {
445 |                         $output .= array_pop($nesting);
446 |                         unset($flags[array_search('inside_empty_condition', $flags)]);
447 |                     }
448 |                     $flags[] = 'inside_ternary';
449 |                     $output .= $token;
450 |                     break;
451 | 
452 |                 case ',':
453 |                 case '%':
454 |                 case '*':
455 |                 case '/':
456 |                 case '+':
457 |                 case '-':
458 |                     // Same as twig
459 |                     $output .= $token;
460 |                     break;
461 |             }
462 |         }
463 |         next($tokens);
464 |     }
465 | 
466 |     if ($debug) {
467 |         echo $str, $output, "\n";
468 |     }
469 | 
470 |     return $output;
471 | }
472 | 


--------------------------------------------------------------------------------