zordius /
lightncandy
Complex classes like Runtime 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 Runtime, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 27 | class Runtime extends Encoder |
||
| 28 | { |
||
| 29 | const DEBUG_ERROR_LOG = 1; |
||
| 30 | const DEBUG_ERROR_EXCEPTION = 2; |
||
| 31 | const DEBUG_TAGS = 4; |
||
| 32 | const DEBUG_TAGS_ANSI = 12; |
||
| 33 | const DEBUG_TAGS_HTML = 20; |
||
| 34 | |||
| 35 | /** |
||
| 36 | * Output debug info. |
||
| 37 | * |
||
| 38 | * @param string $v expression |
||
| 39 | * @param string $f runtime function name |
||
| 40 | * @param array<string,array|string|integer> $cx render time context for lightncandy |
||
| 41 | * |
||
| 42 | * @expect '{{123}}' when input '123', 'miss', array('flags' => array('debug' => Runtime::DEBUG_TAGS), 'runtime' => 'LightnCandy\\Runtime'), '' |
||
| 43 | * @expect '<!--MISSED((-->{{#123}}<!--))--><!--SKIPPED--><!--MISSED((-->{{/123}}<!--))-->' when input '123', 'wi', array('flags' => array('debug' => Runtime::DEBUG_TAGS_HTML), 'runtime' => 'LightnCandy\\Runtime'), false, null, false, function () {return 'A';} |
||
| 44 | */ |
||
| 45 | 9 | public static function debug($v, $f, $cx) { |
|
| 80 | |||
| 81 | /** |
||
| 82 | * Handle error by error_log or throw exception. |
||
| 83 | * |
||
| 84 | * @param array<string,array|string|integer> $cx render time context for lightncandy |
||
| 85 | * @param string $err error message |
||
| 86 | * |
||
| 87 | * @throws \Exception |
||
| 88 | */ |
||
| 89 | 12 | public static function err($cx, $err) { |
|
| 98 | |||
| 99 | /** |
||
| 100 | * Handle missing data error. |
||
| 101 | * |
||
| 102 | * @param array<string,array|string|integer> $cx render time context for lightncandy |
||
| 103 | * @param string $v expression |
||
| 104 | */ |
||
| 105 | 5 | public static function miss($cx, $v) { |
|
| 108 | |||
| 109 | /** |
||
| 110 | * For {{log}} . |
||
| 111 | * |
||
| 112 | * @param array<string,array|string|integer> $cx render time context for lightncandy |
||
| 113 | * @param string $v expression |
||
| 114 | */ |
||
| 115 | public static function lo($cx, $v) { |
||
| 119 | |||
| 120 | /** |
||
| 121 | * Resursive lookup variable and helpers. This is slow and will only be used for instance property or method detection or lambdas. |
||
| 122 | * |
||
| 123 | * @param array<string,array|string|integer> $cx render time context for lightncandy |
||
| 124 | * @param array|string|boolean|integer|double|null $in current context |
||
| 125 | * @param array<array|string|integer> $base current variable context |
||
| 126 | * @param array<string|integer> $path array of names for path |
||
| 127 | * @param array|null $args extra arguments for lambda |
||
| 128 | * |
||
| 129 | * @return null|string Return the value or null when not found |
||
| 130 | * |
||
| 131 | * @expect null when input array('scopes' => array(), 'flags' => array('prop' => 0, 'method' => 0, 'mustlok' => 0)), null, 0, array('a', 'b') |
||
| 132 | * @expect 3 when input array('scopes' => array(), 'flags' => array('prop' => 0, 'method' => 0), 'mustlok' => 0), null, array('a' => array('b' => 3)), array('a', 'b') |
||
| 133 | * @expect null when input array('scopes' => array(), 'flags' => array('prop' => 0, 'method' => 0, 'mustlok' => 0)), null, (Object) array('a' => array('b' => 3)), array('a', 'b') |
||
| 134 | * @expect 3 when input array('scopes' => array(), 'flags' => array('prop' => 1, 'method' => 0, 'mustlok' => 0)), null, (Object) array('a' => array('b' => 3)), array('a', 'b') |
||
| 135 | */ |
||
| 136 | 387 | public static function v($cx, $in, $base, $path, $args = null) { |
|
| 196 | |||
| 197 | /** |
||
| 198 | * For {{#if}} . |
||
| 199 | * |
||
| 200 | * @param array<string,array|string|integer> $cx render time context for lightncandy |
||
| 201 | * @param array<array|string|integer>|string|integer|null $v value to be tested |
||
| 202 | * @param boolean $zero include zero as true |
||
| 203 | * |
||
| 204 | * @return boolean Return true when the value is not null nor false. |
||
| 205 | * |
||
| 206 | * @expect false when input array(), null, false |
||
| 207 | * @expect false when input array(), 0, false |
||
| 208 | * @expect true when input array(), 0, true |
||
| 209 | * @expect false when input array(), false, false |
||
| 210 | * @expect true when input array(), true, false |
||
| 211 | * @expect true when input array(), 1, false |
||
| 212 | * @expect false when input array(), '', false |
||
| 213 | * @expect false when input array(), array(), false |
||
| 214 | * @expect true when input array(), array(''), false |
||
| 215 | * @expect true when input array(), array(0), false |
||
| 216 | */ |
||
| 217 | 74 | public static function ifvar($cx, $v, $zero) { |
|
| 220 | |||
| 221 | /** |
||
| 222 | * For {{^var}} . |
||
| 223 | * |
||
| 224 | * @param array<string,array|string|integer> $cx render time context for lightncandy |
||
| 225 | * @param array<array|string|integer>|string|integer|null $v value to be tested |
||
| 226 | * |
||
| 227 | * @return boolean Return true when the value is not null nor false. |
||
| 228 | * |
||
| 229 | * @expect true when input array(), null |
||
| 230 | * @expect false when input array(), 0 |
||
| 231 | * @expect true when input array(), false |
||
| 232 | * @expect false when input array(), 'false' |
||
| 233 | * @expect true when input array(), array() |
||
| 234 | * @expect false when input array(), array('1') |
||
| 235 | */ |
||
| 236 | 37 | public static function isec($cx, $v) { |
|
| 239 | |||
| 240 | /** |
||
| 241 | * For {{var}} . |
||
| 242 | * |
||
| 243 | * @param array<string,array|string|integer> $cx render time context for lightncandy |
||
| 244 | * @param array<array|string|integer>|string|integer|null $var value to be htmlencoded |
||
| 245 | * |
||
| 246 | * @return string The htmlencoded value of the specified variable |
||
| 247 | * |
||
| 248 | * @expect 'a' when input array('flags' => array('mustlam' => 0, 'lambda' => 0)), 'a' |
||
| 249 | * @expect 'a&b' when input array('flags' => array('mustlam' => 0, 'lambda' => 0)), 'a&b' |
||
| 250 | * @expect 'a'b' when input array('flags' => array('mustlam' => 0, 'lambda' => 0)), 'a\'b' |
||
| 251 | * @expect 'a&b' when input null, new \LightnCandy\SafeString('a&b') |
||
| 252 | */ |
||
| 253 | 46 | public static function enc($cx, $var) { |
|
| 260 | |||
| 261 | /** |
||
| 262 | * For {{var}} , do html encode just like handlebars.js . |
||
| 263 | * |
||
| 264 | * @param array<string,array|string|integer> $cx render time context for lightncandy |
||
| 265 | * @param array<array|string|integer>|string|integer|null $var value to be htmlencoded |
||
| 266 | * |
||
| 267 | * @return string The htmlencoded value of the specified variable |
||
| 268 | * |
||
| 269 | * @expect 'a' when input array('flags' => array('mustlam' => 0, 'lambda' => 0)), 'a' |
||
| 270 | * @expect 'a&b' when input array('flags' => array('mustlam' => 0, 'lambda' => 0)), 'a&b' |
||
| 271 | * @expect 'a'b' when input array('flags' => array('mustlam' => 0, 'lambda' => 0)), 'a\'b' |
||
| 272 | * @expect '`a'b' when input array('flags' => array('mustlam' => 0, 'lambda' => 0)), '`a\'b' |
||
| 273 | */ |
||
| 274 | 335 | public static function encq($cx, $var) { |
|
| 281 | |||
| 282 | /** |
||
| 283 | * For {{#var}} or {{#each}} . |
||
| 284 | * |
||
| 285 | * @param array<string,array|string|integer> $cx render time context for lightncandy |
||
| 286 | * @param array<array|string|integer>|string|integer|null $v value for the section |
||
| 287 | * @param array<string>|null $bp block parameters |
||
| 288 | * @param array<array|string|integer>|string|integer|null $in input data with current scope |
||
| 289 | * @param boolean $each true when rendering #each |
||
| 290 | * @param Closure $cb callback function to render child context |
||
| 291 | * @param Closure|null $else callback function to render child context when {{else}} |
||
| 292 | * |
||
| 293 | * @return string The rendered string of the section |
||
| 294 | * |
||
| 295 | * @expect '' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'mustsec' => 0, 'lambda' => 0)), false, null, false, false, function () {return 'A';} |
||
| 296 | * @expect '' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'mustsec' => 0, 'lambda' => 0)), null, null, null, false, function () {return 'A';} |
||
| 297 | * @expect 'A' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'mustsec' => 0, 'lambda' => 0)), true, null, true, false, function () {return 'A';} |
||
| 298 | * @expect 'A' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'mustsec' => 0, 'lambda' => 0)), 0, null, 0, false, function () {return 'A';} |
||
| 299 | * @expect '-a=' when input array('scopes' => array(), 'flags' => array('spvar' => 0, 'mustlam' => 0, 'lambda' => 0)), array('a'), null, array('a'), false, function ($c, $i) {return "-$i=";} |
||
| 300 | * @expect '-a=-b=' when input array('scopes' => array(), 'flags' => array('spvar' => 0, 'mustlam' => 0, 'lambda' => 0)), array('a','b'), null, array('a','b'), false, function ($c, $i) {return "-$i=";} |
||
| 301 | * @expect '' when input array('scopes' => array(), 'flags' => array('spvar' => 0, 'mustlam' => 0, 'lambda' => 0)), 'abc', null, 'abc', true, function ($c, $i) {return "-$i=";} |
||
| 302 | * @expect '-b=' when input array('scopes' => array(), 'flags' => array('spvar' => 0, 'mustlam' => 0, 'lambda' => 0)), array('a' => 'b'), null, array('a' => 'b'), true, function ($c, $i) {return "-$i=";} |
||
| 303 | * @expect '1' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'mustsec' => 0, 'lambda' => 0)), 'b', null, 'b', false, function ($c, $i) {return count($i);} |
||
| 304 | * @expect '1' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'mustsec' => 0, 'lambda' => 0)), 1, null, 1, false, function ($c, $i) {return print_r($i, true);} |
||
| 305 | * @expect '0' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'mustsec' => 0, 'lambda' => 0)), 0, null, 0, false, function ($c, $i) {return print_r($i, true);} |
||
| 306 | * @expect '{"b":"c"}' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'lambda' => 0)), array('b' => 'c'), null, array('b' => 'c'), false, function ($c, $i) {return json_encode($i);} |
||
| 307 | * @expect 'inv' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'lambda' => 0)), array(), null, 0, true, function ($c, $i) {return 'cb';}, function ($c, $i) {return 'inv';} |
||
| 308 | * @expect 'inv' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'lambda' => 0)), array(), null, 0, false, function ($c, $i) {return 'cb';}, function ($c, $i) {return 'inv';} |
||
| 309 | * @expect 'inv' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'lambda' => 0)), false, null, 0, true, function ($c, $i) {return 'cb';}, function ($c, $i) {return 'inv';} |
||
| 310 | * @expect 'inv' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'mustsec' => 0, 'lambda' => 0)), false, null, 0, false, function ($c, $i) {return 'cb';}, function ($c, $i) {return 'inv';} |
||
| 311 | * @expect 'inv' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'lambda' => 0)), '', null, 0, true, function ($c, $i) {return 'cb';}, function ($c, $i) {return 'inv';} |
||
| 312 | * @expect 'cb' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'mustsec' => 0, 'lambda' => 0)), '', null, 0, false, function ($c, $i) {return 'cb';}, function ($c, $i) {return 'inv';} |
||
| 313 | * @expect 'inv' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'lambda' => 0)), 0, null, 0, true, function ($c, $i) {return 'cb';}, function ($c, $i) {return 'inv';} |
||
| 314 | * @expect 'cb' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'mustsec' => 0, 'lambda' => 0)), 0, null, 0, false, function ($c, $i) {return 'cb';}, function ($c, $i) {return 'inv';} |
||
| 315 | * @expect 'inv' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'lambda' => 0)), new stdClass, null, 0, true, function ($c, $i) {return 'cb';}, function ($c, $i) {return 'inv';} |
||
| 316 | * @expect 'cb' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'mustsec' => 0, 'lambda' => 0)), new stdClass, null, 0, false, function ($c, $i) {return 'cb';}, function ($c, $i) {return 'inv';} |
||
| 317 | * @expect '268' when input array('scopes' => array(), 'flags' => array('spvar' => 1, 'mustlam' => 0, 'lambda' => 0), 'sp_vars'=>array('root' => 0)), array(1,3,4), null, 0, false, function ($c, $i) {return $i * 2;} |
||
| 318 | * @expect '038' when input array('scopes' => array(), 'flags' => array('spvar' => 1, 'mustlam' => 0, 'lambda' => 0), 'sp_vars'=>array('root' => 0)), array(1,3,'a'=>4), null, 0, true, function ($c, $i) {return $i * $c['sp_vars']['index'];} |
||
| 319 | */ |
||
| 320 | 165 | public static function sec($cx, $v, $bp, $in, $each, $cb, $else = null) { |
|
| 432 | |||
| 433 | /** |
||
| 434 | * For {{#with}} . |
||
| 435 | * |
||
| 436 | * @param array<string,array|string|integer> $cx render time context for lightncandy |
||
| 437 | * @param array<array|string|integer>|string|integer|null $v value to be the new context |
||
| 438 | * @param array<array|string|integer>|string|integer|null $in input data with current scope |
||
| 439 | * @param array<string>|null $bp block parameters |
||
| 440 | * @param Closure $cb callback function to render child context |
||
| 441 | * @param Closure|null $else callback function to render child context when {{else}} |
||
| 442 | * |
||
| 443 | * @return string The rendered string of the token |
||
| 444 | * |
||
| 445 | * @expect '' when input array(), false, null, false, function () {return 'A';} |
||
| 446 | * @expect '' when input array(), null, null, null, function () {return 'A';} |
||
| 447 | * @expect '{"a":"b"}' when input array(), array('a'=>'b'), null, array('a'=>'c'), function ($c, $i) {return json_encode($i);} |
||
| 448 | * @expect '-b=' when input array(), 'b', null, array('a'=>'b'), function ($c, $i) {return "-$i=";} |
||
| 449 | */ |
||
| 450 | 28 | public static function wi($cx, $v, $bp, $in, $cb, $else = null) { |
|
| 466 | |||
| 467 | /** |
||
| 468 | * Get merged context. |
||
| 469 | * |
||
| 470 | * @param array<string,array|string|integer> $cx render time context for lightncandy |
||
| 471 | * @param array<array|string|integer>|string|integer|null $a the context to be merged |
||
| 472 | * @param array<array|string|integer>|string|integer|null $b the new context to overwrite |
||
| 473 | * |
||
| 474 | * @return array<array|string|integer>|string|integer the merged context object |
||
| 475 | * |
||
| 476 | */ |
||
| 477 | 93 | public static function m($cx, $a, $b) { |
|
| 491 | |||
| 492 | /** |
||
| 493 | * For {{> partial}} . |
||
| 494 | * |
||
| 495 | * @param array<string,array|string|integer> $cx render time context for lightncandy |
||
| 496 | * @param string $p partial name |
||
| 497 | * @param array<array|string|integer>|string|integer|null $v value to be the new context |
||
| 498 | * |
||
| 499 | * @return string The rendered string of the partial |
||
| 500 | * |
||
| 501 | */ |
||
| 502 | 88 | public static function p($cx, $p, $v, $pid, $sp = '') { |
|
| 514 | |||
| 515 | /** |
||
| 516 | * For {{#* inlinepartial}} . |
||
| 517 | * |
||
| 518 | * @param array<string,array|string|integer> $cx render time context for lightncandy |
||
| 519 | * @param string $p partial name |
||
| 520 | * @param Closure $code the compiled partial code |
||
| 521 | * |
||
| 522 | */ |
||
| 523 | 7 | public static function in(&$cx, $p, $code) { |
|
| 526 | |||
| 527 | /* For single custom helpers. |
||
| 528 | * |
||
| 529 | * @param array<string,array|string|integer> $cx render time context for lightncandy |
||
| 530 | * @param string $ch the name of custom helper to be executed |
||
| 531 | * @param array<array|string|integer>|string|integer|null $vars variables for the helper |
||
| 532 | * @param string $op the name of variable resolver. should be one of: 'raw', 'enc', or 'encq'. |
||
| 533 | * @param array<string,array|string|integer> $_this current rendering context for the helper |
||
| 534 | * |
||
| 535 | * @return string The rendered string of the token |
||
| 536 | */ |
||
| 537 | 119 | public static function hbch($cx, $ch, $vars, $op, &$_this) { |
|
| 556 | |||
| 557 | /** |
||
| 558 | * For block custom helpers. |
||
| 559 | * |
||
| 560 | * @param array<string,array|string|integer> $cx render time context for lightncandy |
||
| 561 | * @param string $ch the name of custom helper to be executed |
||
| 562 | * @param array<array|string|integer>|string|integer|null $vars variables for the helper |
||
| 563 | * @param array<string,array|string|integer> $_this current rendering context for the helper |
||
| 564 | * @param boolean $inverted the logic will be inverted |
||
| 565 | * @param Closure|null $cb callback function to render child context |
||
| 566 | * @param Closure|null $else callback function to render child context when {{else}} |
||
| 567 | * |
||
| 568 | * @return string The rendered string of the token |
||
| 569 | */ |
||
| 570 | 56 | public static function hbbch($cx, $ch, $vars, &$_this, $inverted, $cb, $else = null) { |
|
| 571 | $options = array( |
||
| 572 | 56 | 'name' => $ch, |
|
| 573 | 56 | 'hash' => $vars[1], |
|
| 574 | 56 | 'contexts' => count($cx['scopes']) ? $cx['scopes'] : array(null), |
|
| 575 | 56 | 'fn.blockParams' => 0, |
|
| 576 | 56 | '_this' => &$_this, |
|
| 577 | ); |
||
| 578 | |||
| 579 | 56 | if ($cx['flags']['spvar']) { |
|
| 580 | 52 | $options['data'] = $cx['sp_vars']; |
|
| 581 | } |
||
| 582 | |||
| 583 | 56 | if (isset($vars[2])) { |
|
| 584 | 3 | $options['fn.blockParams'] = count($vars[2]); |
|
| 585 | } |
||
| 586 | |||
| 587 | // $invert the logic |
||
| 588 | 56 | if ($inverted) { |
|
| 589 | $tmp = $else; |
||
| 590 | $else = $cb; |
||
| 591 | $cb = $tmp; |
||
| 592 | } |
||
| 593 | |||
| 594 | $options['fn'] = function ($context = '_NO_INPUT_HERE_', $data = null) use ($cx, &$_this, $cb, $options, $vars) { |
||
| 595 | 45 | if ($cx['flags']['echo']) { |
|
| 596 | ob_start(); |
||
| 597 | } |
||
| 598 | 45 | if (isset($data['data'])) { |
|
| 599 | 6 | $old_spvar = $cx['sp_vars']; |
|
| 600 | 6 | $cx['sp_vars'] = array_merge(array('root' => $old_spvar['root']), $data['data'], array('_parent' => $old_spvar)); |
|
| 601 | } |
||
| 602 | 45 | $ex = false; |
|
| 603 | 45 | if (isset($data['blockParams']) && isset($vars[2])) { |
|
| 604 | 3 | $ex = array_combine($vars[2], array_slice($data['blockParams'], 0, count($vars[2]))); |
|
| 605 | 3 | array_unshift($cx['blparam'], $ex); |
|
| 606 | 43 | } else if (isset($cx['blparam'][0])) { |
|
| 607 | 1 | $ex = $cx['blparam'][0]; |
|
| 608 | } |
||
| 609 | 45 | if (($context === '_NO_INPUT_HERE_') || ($context === $_this)) { |
|
| 610 | 28 | $ret = $cb($cx, is_array($ex) ? static::m($cx, $_this, $ex) : $_this); |
|
| 611 | } else { |
||
| 612 | 20 | $cx['scopes'][] = $_this; |
|
| 613 | 20 | $ret = $cb($cx, is_array($ex) ? static::m($cx, $context, $ex) : $context); |
|
| 614 | 20 | array_pop($cx['scopes']); |
|
| 615 | } |
||
| 616 | 45 | if (isset($data['data'])) { |
|
| 617 | 6 | $cx['sp_vars'] = $old_spvar; |
|
| 618 | } |
||
| 619 | 45 | return $cx['flags']['echo'] ? ob_get_clean() : $ret; |
|
| 620 | }; |
||
| 621 | |||
| 622 | 56 | if ($else) { |
|
| 623 | $options['inverse'] = function ($context = '_NO_INPUT_HERE_') use ($cx, $_this, $else) { |
||
| 624 | 6 | if ($cx['flags']['echo']) { |
|
| 625 | ob_start(); |
||
| 626 | } |
||
| 627 | 6 | if ($context === '_NO_INPUT_HERE_') { |
|
| 628 | 1 | $ret = $else($cx, $_this); |
|
| 629 | } else { |
||
| 630 | 5 | $cx['scopes'][] = $_this; |
|
| 631 | 5 | $ret = $else($cx, $context); |
|
| 632 | 5 | array_pop($cx['scopes']); |
|
| 633 | } |
||
| 634 | 6 | return $cx['flags']['echo'] ? ob_get_clean() : $ret; |
|
| 635 | 10 | }; |
|
| 636 | } else { |
||
| 637 | $options['inverse'] = function () { |
||
| 638 | return ''; |
||
| 639 | }; |
||
| 640 | } |
||
| 641 | |||
| 642 | 56 | return static::exch($cx, $ch, $vars, $options); |
|
| 643 | } |
||
| 644 | |||
| 645 | /** |
||
| 646 | * Execute custom helper with prepared options |
||
| 647 | * |
||
| 648 | * @param array<string,array|string|integer> $cx render time context for lightncandy |
||
| 649 | * @param string $ch the name of custom helper to be executed |
||
| 650 | * @param array<array|string|integer>|string|integer|null $vars variables for the helper |
||
| 651 | * @param array<string,array|string|integer> $options the options object |
||
| 652 | * |
||
| 653 | * @return string The rendered string of the token |
||
| 654 | */ |
||
| 655 | 165 | public static function exch($cx, $ch, $vars, &$options) { |
|
| 673 | } |
||
| 674 |
Loading history...
If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: