zordius /
lightncandy
Complex classes like Compiler often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Compiler, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 31 | class Compiler extends Validator |
||
| 32 | { |
||
| 33 | public static $lastParsed; |
||
| 34 | |||
| 35 | /** |
||
| 36 | * Compile template into PHP code |
||
| 37 | * |
||
| 38 | * @param array<string,array|string|integer> $context Current context |
||
| 39 | * @param string $template handlebars template |
||
| 40 | * |
||
| 41 | * @return string|null generated PHP code |
||
| 42 | */ |
||
| 43 | 693 | public static function compileTemplate(&$context, $template) { |
|
| 77 | |||
| 78 | /** |
||
| 79 | * Compose LightnCandy render codes for include() |
||
| 80 | * |
||
| 81 | * @param array<string,array|string|integer> $context Current context |
||
| 82 | * @param string $code generated PHP code |
||
| 83 | * |
||
| 84 | * @return string Composed PHP code |
||
| 85 | */ |
||
| 86 | 625 | public static function composePHPRender($context, $code) { |
|
| 140 | |||
| 141 | /** |
||
| 142 | * Get function name for standalone or none standalone template. |
||
| 143 | * |
||
| 144 | * @param array<string,array|string|integer> $context Current context of compiler progress. |
||
| 145 | * @param string $name base function name |
||
| 146 | * @param string $tag original handlabars tag for debug |
||
| 147 | * |
||
| 148 | * @return string compiled Function name |
||
| 149 | * |
||
| 150 | * @expect 'LR::test(' when input array('flags' => array('standalone' => 0, 'debug' => 0), 'runtime' => 'Runtime'), 'test', '' |
||
| 151 | * @expect 'LR::test2(' when input array('flags' => array('standalone' => 0, 'debug' => 0), 'runtime' => 'Runtime'), 'test2', '' |
||
| 152 | * @expect "\$cx['funcs']['test3'](" when input array('flags' => array('standalone' => 1, 'debug' => 0), 'runtime' => 'Runtime'), 'test3', '' |
||
| 153 | * @expect 'LR::debug(\'abc\', \'test\', ' when input array('flags' => array('standalone' => 0, 'debug' => 1), 'runtime' => 'Runtime'), 'test', 'abc' |
||
| 154 | */ |
||
| 155 | 561 | protected static function getFuncName(&$context, $name, $tag) { |
|
| 168 | |||
| 169 | /** |
||
| 170 | * Get string presentation of variables |
||
| 171 | * |
||
| 172 | * @param array<string,array|string|integer> $context current compile context |
||
| 173 | * @param array<array> $vn variable name array. |
||
| 174 | * @param array<string>|null $blockParams block param list |
||
| 175 | * |
||
| 176 | * @return array<string|array> variable names |
||
| 177 | * |
||
| 178 | * @expect array('array(array($in),array())', array('this')) when input array('flags'=>array('spvar'=>true)), array(null) |
||
| 179 | * @expect array('array(array($in,$in),array())', array('this', 'this')) when input array('flags'=>array('spvar'=>true)), array(null, null) |
||
| 180 | * @expect array('array(array(),array(\'a\'=>$in))', array('this')) when input array('flags'=>array('spvar'=>true)), array('a' => null) |
||
| 181 | */ |
||
| 182 | 238 | protected static function getVariableNames(&$context, $vn, $blockParams = null) { |
|
| 197 | |||
| 198 | /** |
||
| 199 | * Get string presentation of a sub expression |
||
| 200 | * |
||
| 201 | * @param array<string,array|string|integer> $context current compile context |
||
| 202 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
| 203 | * |
||
| 204 | * @return array<string> code representing passed expression |
||
| 205 | */ |
||
| 206 | 41 | public static function compileSubExpression(&$context, $vars) { |
|
| 220 | |||
| 221 | /** |
||
| 222 | * Get string presentation of a subexpression or a variable |
||
| 223 | * |
||
| 224 | * @param array<array|string|integer> $context current compile context |
||
| 225 | * @param array<array|string|integer> $var variable parsed path |
||
| 226 | * |
||
| 227 | * @return array<string> variable names |
||
|
|
|||
| 228 | */ |
||
| 229 | 340 | protected static function getVariableNameOrSubExpression(&$context, $var) { |
|
| 232 | |||
| 233 | /** |
||
| 234 | * Get string presentation of a variable |
||
| 235 | * |
||
| 236 | * @param array<array|string|integer> $var variable parsed path |
||
| 237 | * @param array<array|string|integer> $context current compile context |
||
| 238 | * @param array<string> $lookup extra lookup string as valid PHP variable name |
||
| 239 | * |
||
| 240 | * @return array<string> variable names |
||
| 241 | * |
||
| 242 | * @expect array('$in', 'this') when input array('flags'=>array('spvar'=>true,'debug'=>0)), array(null) |
||
| 243 | * @expect array('((isset($in[\'true\']) && is_array($in)) ? $in[\'true\'] : null)', '[true]') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0)), array('true') |
||
| 244 | * @expect array('((isset($in[\'false\']) && is_array($in)) ? $in[\'false\'] : null)', '[false]') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0)), array('false') |
||
| 245 | * @expect array('true', 'true') when input array('flags'=>array('spvar'=>true,'debug'=>0)), array(-1, 'true') |
||
| 246 | * @expect array('false', 'false') when input array('flags'=>array('spvar'=>true,'debug'=>0)), array(-1, 'false') |
||
| 247 | * @expect array('((isset($in[\'2\']) && is_array($in)) ? $in[\'2\'] : null)', '[2]') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0)), array('2') |
||
| 248 | * @expect array('2', '2') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0)), array(-1, '2') |
||
| 249 | * @expect array('((isset($in[\'@index\']) && is_array($in)) ? $in[\'@index\'] : null)', '[@index]') when input array('flags'=>array('spvar'=>false,'debug'=>0,'prop'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0)), array('@index') |
||
| 250 | * @expect array("((isset(\$cx['sp_vars']['index']) && is_array(\$cx['sp_vars'])) ? \$cx['sp_vars']['index'] : null)", '@[index]') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0)), array('@index') |
||
| 251 | * @expect array("((isset(\$cx['sp_vars']['key']) && is_array(\$cx['sp_vars'])) ? \$cx['sp_vars']['key'] : null)", '@[key]') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0)), array('@key') |
||
| 252 | * @expect array("((isset(\$cx['sp_vars']['first']) && is_array(\$cx['sp_vars'])) ? \$cx['sp_vars']['first'] : null)", '@[first]') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0)), array('@first') |
||
| 253 | * @expect array("((isset(\$cx['sp_vars']['last']) && is_array(\$cx['sp_vars'])) ? \$cx['sp_vars']['last'] : null)", '@[last]') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0)), array('@last') |
||
| 254 | * @expect array('((isset($in[\'"a"\']) && is_array($in)) ? $in[\'"a"\'] : null)', '["a"]') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0)), array('"a"') |
||
| 255 | * @expect array('"a"', '"a"') when input array('flags'=>array('spvar'=>true,'debug'=>0)), array(-1, '"a"') |
||
| 256 | * @expect array('((isset($in[\'a\']) && is_array($in)) ? $in[\'a\'] : null)', '[a]') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0)), array('a') |
||
| 257 | * @expect array('((isset($cx[\'scopes\'][count($cx[\'scopes\'])-1][\'a\']) && is_array($cx[\'scopes\'][count($cx[\'scopes\'])-1])) ? $cx[\'scopes\'][count($cx[\'scopes\'])-1][\'a\'] : null)', '../[a]') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0)), array(1,'a') |
||
| 258 | * @expect array('((isset($cx[\'scopes\'][count($cx[\'scopes\'])-3][\'a\']) && is_array($cx[\'scopes\'][count($cx[\'scopes\'])-3])) ? $cx[\'scopes\'][count($cx[\'scopes\'])-3][\'a\'] : null)', '../../../[a]') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0)), array(3,'a') |
||
| 259 | * @expect array('((isset($in[\'id\']) && is_array($in)) ? $in[\'id\'] : null)', 'this.[id]') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0)), array(null, 'id') |
||
| 260 | * @expect array('LR::v($cx, $in, isset($in) ? $in : null, array(\'id\'))', 'this.[id]') when input array('flags'=>array('prop'=>true,'spvar'=>true,'debug'=>0,'method'=>0,'mustlok'=>0,'mustlam'=>0, 'lambda'=>0,'standalone'=>0), 'runtime' => 'Runtime'), array(null, 'id') |
||
| 261 | */ |
||
| 262 | 556 | protected static function getVariableName(&$context, $var, $lookup = null, $args = null) { |
|
| 307 | |||
| 308 | /** |
||
| 309 | * Return compiled PHP code for a handlebars token |
||
| 310 | * |
||
| 311 | * @param array<string,array|string|integer> $context current compile context |
||
| 312 | * @param array<string,array|boolean> $info parsed information |
||
| 313 | * |
||
| 314 | * @return string Return compiled code segment for the token |
||
| 315 | */ |
||
| 316 | 585 | protected static function compileToken(&$context, $info) { |
|
| 345 | |||
| 346 | /** |
||
| 347 | * handle partial |
||
| 348 | * |
||
| 349 | * @param array<string,array|string|integer> $context current compile context |
||
| 350 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
| 351 | * |
||
| 352 | * @return string Return compiled code segment for the partial |
||
| 353 | */ |
||
| 354 | 65 | public static function partial(&$context, $vars) { |
|
| 377 | |||
| 378 | /** |
||
| 379 | * Return compiled PHP code for a handlebars inverted section begin token |
||
| 380 | * |
||
| 381 | * @param array<string,array|string|integer> $context current compile context |
||
| 382 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
| 383 | * |
||
| 384 | * @return string Return compiled code segment for the token |
||
| 385 | */ |
||
| 386 | 38 | protected static function invertedSection(&$context, $vars) { |
|
| 390 | |||
| 391 | /** |
||
| 392 | * Return compiled PHP code for a handlebars block custom helper begin token |
||
| 393 | * |
||
| 394 | * @param array<string,array|string|integer> $context current compile context |
||
| 395 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
| 396 | * @param boolean $inverted the logic will be inverted |
||
| 397 | * |
||
| 398 | * @return string Return compiled code segment for the token |
||
| 399 | */ |
||
| 400 | 61 | protected static function blockCustomHelper(&$context, $vars, $inverted = false) { |
|
| 411 | |||
| 412 | /** |
||
| 413 | * Return compiled PHP code for a handlebars block end token |
||
| 414 | * |
||
| 415 | * @param array<string,array|string|integer> $context current compile context |
||
| 416 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
| 417 | * |
||
| 418 | * @return string Return compiled code segment for the token |
||
| 419 | */ |
||
| 420 | 309 | protected static function blockEnd(&$context, $vars) { |
|
| 451 | |||
| 452 | /** |
||
| 453 | * Return compiled PHP code for a handlebars block begin token |
||
| 454 | * |
||
| 455 | * @param array<string,array|string|integer> $context current compile context |
||
| 456 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
| 457 | * |
||
| 458 | * @return string Return compiled code segment for the token |
||
| 459 | */ |
||
| 460 | 225 | protected static function blockBegin(&$context, $vars) { |
|
| 480 | |||
| 481 | /** |
||
| 482 | * compile {{#foo}} token |
||
| 483 | * |
||
| 484 | * @param array<string,array|string|integer> $context current compile context |
||
| 485 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
| 486 | * @param boolean $isEach the section is #each |
||
| 487 | * |
||
| 488 | * @return string|null Return compiled code segment for the token |
||
| 489 | */ |
||
| 490 | 159 | protected static function section(&$context, $vars, $isEach = false) { |
|
| 511 | |||
| 512 | /** |
||
| 513 | * compile {{with}} token |
||
| 514 | * |
||
| 515 | * @param array<string,array|string|integer> $context current compile context |
||
| 516 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
| 517 | * |
||
| 518 | * @return string|null Return compiled code segment for the token |
||
| 519 | */ |
||
| 520 | 20 | protected static function with(&$context, $vars) { |
|
| 527 | |||
| 528 | /** |
||
| 529 | * Return compiled PHP code for a handlebars custom helper token |
||
| 530 | * |
||
| 531 | * @param array<string,array|string|integer> $context current compile context |
||
| 532 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
| 533 | * @param boolean $raw is this {{{ token or not |
||
| 534 | * |
||
| 535 | * @return string|null Return compiled code segment for the token when the token is custom helper |
||
| 536 | */ |
||
| 537 | 440 | protected static function customHelper(&$context, $vars, $raw) { |
|
| 549 | |||
| 550 | /** |
||
| 551 | * Return compiled PHP code for a handlebars else token |
||
| 552 | * |
||
| 553 | * @param array<string,array|string|integer> $context current compile context |
||
| 554 | * |
||
| 555 | * @return string Return compiled code segment for the token when the token is else |
||
| 556 | */ |
||
| 557 | 46 | protected static function doElse(&$context) { |
|
| 567 | |||
| 568 | /** |
||
| 569 | * Return compiled PHP code for a handlebars lookup token |
||
| 570 | * |
||
| 571 | * @param array<string,array|string|integer> $context current compile context |
||
| 572 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
| 573 | * @param boolean $raw is this {{{ token or not |
||
| 574 | * |
||
| 575 | * @return string Return compiled code segment for the token |
||
| 576 | */ |
||
| 577 | 2 | protected static function compileLookup(&$context, &$vars, $raw) { |
|
| 586 | |||
| 587 | /** |
||
| 588 | * Return compiled PHP code for a handlebars variable token |
||
| 589 | * |
||
| 590 | * @param array<string,array|string|integer> $context current compile context |
||
| 591 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
| 592 | * @param boolean $raw is this {{{ token or not |
||
| 593 | * |
||
| 594 | * @return string Return compiled code segment for the token |
||
| 595 | */ |
||
| 596 | 352 | protected static function compileVariable(&$context, &$vars, $raw) { |
|
| 609 | |||
| 610 | /** |
||
| 611 | * Add usage count to context |
||
| 612 | * |
||
| 613 | * @param array<string,array|string|integer> $context current context |
||
| 614 | * @param string $category ctegory name, can be one of: 'var', 'helpers', 'blockhelpers' |
||
| 615 | * @param string $name used name |
||
| 616 | * @param integer $count increment |
||
| 617 | * |
||
| 618 | * @expect 1 when input array('usedCount' => array('test' => array())), 'test', 'testname' |
||
| 619 | * @expect 3 when input array('usedCount' => array('test' => array('testname' => 2))), 'test', 'testname' |
||
| 620 | * @expect 5 when input array('usedCount' => array('test' => array('testname' => 2))), 'test', 'testname', 3 |
||
| 621 | */ |
||
| 622 | 561 | protected static function addUsageCount(&$context, $category, $name, $count = 1) { |
|
| 628 | } |
||
| 629 | |||
| 630 |
Loading history...
This check compares the return type specified in the
@returnannotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.