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 |
||
| 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) { |
|
| 75 | |||
| 76 | /** |
||
| 77 | * Handle error by error_log or throw exception. |
||
| 78 | * |
||
| 79 | * @param array<string,array|string|integer> $cx render time context |
||
| 80 | * @param string $err error message |
||
| 81 | * |
||
| 82 | * @throws \Exception |
||
| 83 | */ |
||
| 84 | 12 | public static function err($cx, $err) { |
|
| 93 | |||
| 94 | /** |
||
| 95 | * Handle missing data error. |
||
| 96 | * |
||
| 97 | * @param array<string,array|string|integer> $cx render time context |
||
| 98 | * @param string $v expression |
||
| 99 | */ |
||
| 100 | 5 | public static function miss($cx, $v) { |
|
| 103 | |||
| 104 | /** |
||
| 105 | * For {{log}} . |
||
| 106 | * |
||
| 107 | * @param array<string,array|string|integer> $cx render time context |
||
| 108 | * @param string $v expression |
||
| 109 | */ |
||
| 110 | public static function lo($cx, $v) { |
||
| 114 | |||
| 115 | /** |
||
| 116 | * Resursive lookup variable and helpers. This is slow and will only be used for instance property or method detection or lambdas. |
||
| 117 | * |
||
| 118 | * @param array<string,array|string|integer> $cx render time context |
||
| 119 | * @param array|string|boolean|integer|double|null $in current context |
||
| 120 | * @param array<array|string|integer> $base current variable context |
||
| 121 | * @param array<string|integer> $path array of names for path |
||
| 122 | * @param array|null $args extra arguments for lambda |
||
| 123 | * |
||
| 124 | * @return null|string Return the value or null when not found |
||
| 125 | * |
||
| 126 | * @expect null when input array('scopes' => array(), 'flags' => array('prop' => 0, 'method' => 0, 'mustlok' => 0)), null, 0, array('a', 'b') |
||
| 127 | * @expect 3 when input array('scopes' => array(), 'flags' => array('prop' => 0, 'method' => 0), 'mustlok' => 0), null, array('a' => array('b' => 3)), array('a', 'b') |
||
| 128 | * @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') |
||
| 129 | * @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') |
||
| 130 | */ |
||
| 131 | 385 | public static function v($cx, $in, $base, $path, $args = null) { |
|
| 185 | |||
| 186 | /** |
||
| 187 | * For {{#if}} . |
||
| 188 | * |
||
| 189 | * @param array<string,array|string|integer> $cx render time context |
||
| 190 | * @param array<array|string|integer>|string|integer|null $v value to be tested |
||
| 191 | * @param boolean $zero include zero as true |
||
| 192 | * |
||
| 193 | * @return boolean Return true when the value is not null nor false. |
||
| 194 | * |
||
| 195 | * @expect false when input array(), null, false |
||
| 196 | * @expect false when input array(), 0, false |
||
| 197 | * @expect true when input array(), 0, true |
||
| 198 | * @expect false when input array(), false, false |
||
| 199 | * @expect true when input array(), true, false |
||
| 200 | * @expect true when input array(), 1, false |
||
| 201 | * @expect false when input array(), '', false |
||
| 202 | * @expect false when input array(), array(), false |
||
| 203 | * @expect true when input array(), array(''), false |
||
| 204 | * @expect true when input array(), array(0), false |
||
| 205 | */ |
||
| 206 | 64 | public static function ifvar($cx, $v, $zero) { |
|
| 209 | |||
| 210 | /** |
||
| 211 | * For {{^var}} . |
||
| 212 | * |
||
| 213 | * @param array<string,array|string|integer> $cx render time context |
||
| 214 | * @param array<array|string|integer>|string|integer|null $v value to be tested |
||
| 215 | * |
||
| 216 | * @return boolean Return true when the value is not null nor false. |
||
| 217 | * |
||
| 218 | * @expect true when input array(), null |
||
| 219 | * @expect false when input array(), 0 |
||
| 220 | * @expect true when input array(), false |
||
| 221 | * @expect false when input array(), 'false' |
||
| 222 | * @expect true when input array(), array() |
||
| 223 | * @expect false when input array(), array('1') |
||
| 224 | */ |
||
| 225 | 37 | public static function isec($cx, $v) { |
|
| 228 | |||
| 229 | /** |
||
| 230 | * For {{var}} . |
||
| 231 | * |
||
| 232 | * @param array<string,array|string|integer> $cx render time context |
||
| 233 | * @param array<array|string|integer>|string|integer|null $var value to be htmlencoded |
||
| 234 | * |
||
| 235 | * @return string The htmlencoded value of the specified variable |
||
| 236 | * |
||
| 237 | * @expect 'a' when input array('flags' => array('mustlam' => 0, 'lambda' => 0)), 'a' |
||
| 238 | * @expect 'a&b' when input array('flags' => array('mustlam' => 0, 'lambda' => 0)), 'a&b' |
||
| 239 | * @expect 'a'b' when input array('flags' => array('mustlam' => 0, 'lambda' => 0)), 'a\'b' |
||
| 240 | * @expect 'a&b' when input null, new \LightnCandy\SafeString('a&b') |
||
| 241 | */ |
||
| 242 | 45 | public static function enc($cx, $var) { |
|
| 249 | |||
| 250 | /** |
||
| 251 | * For {{var}} , do html encode just like handlebars.js . |
||
| 252 | * |
||
| 253 | * @param array<string,array|string|integer> $cx render time context |
||
| 254 | * @param array<array|string|integer>|string|integer|null $var value to be htmlencoded |
||
| 255 | * |
||
| 256 | * @return string The htmlencoded value of the specified variable |
||
| 257 | * |
||
| 258 | * @expect 'a' when input array('flags' => array('mustlam' => 0, 'lambda' => 0)), 'a' |
||
| 259 | * @expect 'a&b' when input array('flags' => array('mustlam' => 0, 'lambda' => 0)), 'a&b' |
||
| 260 | * @expect 'a'b' when input array('flags' => array('mustlam' => 0, 'lambda' => 0)), 'a\'b' |
||
| 261 | * @expect '`a'b' when input array('flags' => array('mustlam' => 0, 'lambda' => 0)), '`a\'b' |
||
| 262 | */ |
||
| 263 | 317 | public static function encq($cx, $var) { |
|
| 270 | |||
| 271 | /** |
||
| 272 | * For {{#var}} or {{#each}} . |
||
| 273 | * |
||
| 274 | * @param array<string,array|string|integer> $cx render time context |
||
| 275 | * @param array<array|string|integer>|string|integer|null $v value for the section |
||
| 276 | * @param array<string>|null $bp block parameters |
||
| 277 | * @param array<array|string|integer>|string|integer|null $in input data with current scope |
||
| 278 | * @param boolean $each true when rendering #each |
||
| 279 | * @param Closure $cb callback function to render child context |
||
| 280 | * @param Closure|null $else callback function to render child context when {{else}} |
||
| 281 | * |
||
| 282 | * @return string The rendered string of the section |
||
| 283 | * |
||
| 284 | * @expect '' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'lambda' => 0)), false, null, false, false, function () {return 'A';} |
||
| 285 | * @expect '' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'lambda' => 0)), null, null, null, false, function () {return 'A';} |
||
| 286 | * @expect 'A' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'lambda' => 0)), true, null, true, false, function () {return 'A';} |
||
| 287 | * @expect 'A' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'lambda' => 0)), 0, null, 0, false, function () {return 'A';} |
||
| 288 | * @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=";} |
||
| 289 | * @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=";} |
||
| 290 | * @expect '' when input array('scopes' => array(), 'flags' => array('spvar' => 0, 'mustlam' => 0, 'lambda' => 0)), 'abc', null, 'abc', true, function ($c, $i) {return "-$i=";} |
||
| 291 | * @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=";} |
||
| 292 | * @expect '1' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'lambda' => 0)), 'b', null, 'b', false, function ($c, $i) {return count($i);} |
||
| 293 | * @expect '1' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'lambda' => 0)), 1, null, 1, false, function ($c, $i) {return print_r($i, true);} |
||
| 294 | * @expect '0' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'lambda' => 0)), 0, null, 0, false, function ($c, $i) {return print_r($i, true);} |
||
| 295 | * @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);} |
||
| 296 | * @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';} |
||
| 297 | * @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';} |
||
| 298 | * @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';} |
||
| 299 | * @expect 'inv' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'lambda' => 0)), false, null, 0, false, function ($c, $i) {return 'cb';}, function ($c, $i) {return 'inv';} |
||
| 300 | * @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';} |
||
| 301 | * @expect 'cb' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'lambda' => 0)), '', null, 0, false, function ($c, $i) {return 'cb';}, function ($c, $i) {return 'inv';} |
||
| 302 | * @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';} |
||
| 303 | * @expect 'cb' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'lambda' => 0)), 0, null, 0, false, function ($c, $i) {return 'cb';}, function ($c, $i) {return 'inv';} |
||
| 304 | * @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';} |
||
| 305 | * @expect 'cb' when input array('flags' => array('spvar' => 0, 'mustlam' => 0, 'lambda' => 0)), new stdClass, null, 0, false, function ($c, $i) {return 'cb';}, function ($c, $i) {return 'inv';} |
||
| 306 | * @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;} |
||
| 307 | * @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'];} |
||
| 308 | */ |
||
| 309 | 158 | public static function sec($cx, $v, $bp, $in, $each, $cb, $else = null) { |
|
| 417 | |||
| 418 | /** |
||
| 419 | * For {{#with}} . |
||
| 420 | * |
||
| 421 | * @param array<string,array|string|integer> $cx render time context |
||
| 422 | * @param array<array|string|integer>|string|integer|null $v value to be the new context |
||
| 423 | * @param array<array|string|integer>|string|integer|null $in input data with current scope |
||
| 424 | * @param array<string>|null $bp block parameters |
||
| 425 | * @param Closure $cb callback function to render child context |
||
| 426 | * @param Closure|null $else callback function to render child context when {{else}} |
||
| 427 | * |
||
| 428 | * @return string The rendered string of the token |
||
| 429 | * |
||
| 430 | * @expect '' when input array(), false, null, false, function () {return 'A';} |
||
| 431 | * @expect '' when input array(), null, null, null, function () {return 'A';} |
||
| 432 | * @expect '{"a":"b"}' when input array(), array('a'=>'b'), null, array('a'=>'c'), function ($c, $i) {return json_encode($i);} |
||
| 433 | * @expect '-b=' when input array(), 'b', null, array('a'=>'b'), function ($c, $i) {return "-$i=";} |
||
| 434 | */ |
||
| 435 | 22 | public static function wi($cx, $v, $bp, $in, $cb, $else = null) { |
|
| 447 | |||
| 448 | /** |
||
| 449 | * Get merged context. |
||
| 450 | * |
||
| 451 | * @param array<string,array|string|integer> $cx render time context |
||
| 452 | * @param array<array|string|integer>|string|integer|null $a the context to be merged |
||
| 453 | * @param array<array|string|integer>|string|integer|null $b the new context to overwrite |
||
| 454 | * |
||
| 455 | * @return array<array|string|integer>|string|integer the merged context object |
||
| 456 | * |
||
| 457 | */ |
||
| 458 | 83 | public static function m($cx, $a, $b) { |
|
| 472 | |||
| 473 | /** |
||
| 474 | * For {{> partial}} . |
||
| 475 | * |
||
| 476 | * @param array<string,array|string|integer> $cx render time context |
||
| 477 | * @param string $p partial name |
||
| 478 | * @param array<array|string|integer>|string|integer|null $v value to be the new context |
||
| 479 | * |
||
| 480 | * @return string The rendered string of the partial |
||
| 481 | * |
||
| 482 | */ |
||
| 483 | 79 | public static function p($cx, $p, $v, $pid, $sp = '') { |
|
| 497 | |||
| 498 | /** |
||
| 499 | * For {{#* inlinepartial}} . |
||
| 500 | * |
||
| 501 | * @param array<string,array|string|integer> $cx render time context |
||
| 502 | * @param string $p partial name |
||
| 503 | * @param Closure $code the compiled partial code |
||
| 504 | * |
||
| 505 | */ |
||
| 506 | 7 | public static function in(&$cx, $p, $code) { |
|
| 509 | |||
| 510 | /** |
||
| 511 | * For custom helpers. |
||
| 512 | * |
||
| 513 | * @param array<string,array|string|integer> $cx render time context |
||
| 514 | * @param string $ch the name of custom helper to be executed |
||
| 515 | * @param array<array|string|integer>|string|integer|null $vars variables for the helper |
||
| 516 | * @param string $op the name of variable resolver. should be one of: 'raw', 'enc', or 'encq'. |
||
| 517 | * @param boolean $inverted the logic will be inverted |
||
| 518 | * @param Closure|null $cb callback function to render child context |
||
| 519 | * @param Closure|null $else callback function to render child context when {{else}} |
||
| 520 | * |
||
| 521 | * @return string The rendered string of the token |
||
| 522 | */ |
||
| 523 | 150 | public static function hbch($cx, $ch, $vars, $op, $inverted, $cb = null, $else = null) { |
|
| 621 | } |
||
| 622 | |||
| 623 |
Loading history...
This check looks from parameters that have been defined for a function or method, but which are not used in the method body.