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 | 727 | public static function compileTemplate(&$context, $template) { |
|
| 44 | 727 | array_unshift($context['parsed'], array()); |
|
| 45 | 727 | Validator::verify($context, $template); |
|
| 46 | |||
| 47 | 727 | if (count($context['error'])) { |
|
| 48 | 75 | return; |
|
| 49 | } |
||
| 50 | |||
| 51 | 653 | Parser::setDelimiter($context); |
|
| 52 | |||
| 53 | 653 | $context['compile'] = true; |
|
| 54 | |||
| 55 | // Handle dynamic partials |
||
| 56 | 653 | Partial::handleDynamic($context); |
|
| 57 | |||
| 58 | // Do PHP code generation. |
||
| 59 | 653 | $code = ''; |
|
| 60 | 653 | foreach ($context['parsed'][0] as $info) { |
|
| 61 | 653 | if (is_array($info)) { |
|
| 62 | 612 | $context['tokens']['current']++; |
|
| 63 | 612 | $code .= "'" . static::compileToken($context, $info) . "'"; |
|
| 64 | } else { |
||
| 65 | 653 | $code .= $info; |
|
| 66 | } |
||
| 67 | } |
||
| 68 | |||
| 69 | 653 | static::$lastParsed = array_shift($context['parsed']); |
|
| 70 | |||
| 71 | 653 | return $code; |
|
| 72 | } |
||
| 73 | |||
| 74 | /** |
||
| 75 | * Compose LightnCandy render codes for include() |
||
| 76 | * |
||
| 77 | * @param array<string,array|string|integer> $context Current context |
||
| 78 | * @param string $code generated PHP code |
||
| 79 | * |
||
| 80 | * @return string Composed PHP code |
||
| 81 | */ |
||
| 82 | 652 | public static function composePHPRender($context, $code) { |
|
| 83 | 652 | $flagJStrue = Expression::boolString($context['flags']['jstrue']); |
|
| 84 | 652 | $flagJSObj = Expression::boolString($context['flags']['jsobj']); |
|
| 85 | 652 | $flagSPVar = Expression::boolString($context['flags']['spvar']); |
|
| 86 | 652 | $flagProp = Expression::boolString($context['flags']['prop']); |
|
| 87 | 652 | $flagMethod = Expression::boolString($context['flags']['method']); |
|
| 88 | 652 | $flagLambda = Expression::boolString($context['flags']['lambda']); |
|
| 89 | 652 | $flagMustlok = Expression::boolString($context['flags']['mustlok']); |
|
| 90 | 652 | $flagMustlam = Expression::boolString($context['flags']['mustlam']); |
|
| 91 | 652 | $flagEcho = Expression::boolString($context['flags']['echo']); |
|
| 92 | 652 | $flagPartNC = Expression::boolString($context['flags']['partnc']); |
|
| 93 | 652 | $flagKnownHlp = Expression::boolString($context['flags']['knohlp']); |
|
| 94 | |||
| 95 | 652 | $constants = Exporter::constants($context); |
|
| 96 | 652 | $helpers = Exporter::helpers($context); |
|
| 97 | 652 | $partials = implode(",\n", $context['partialCode']); |
|
| 98 | 652 | $debug = Runtime::DEBUG_ERROR_LOG; |
|
| 99 | 652 | $use = $context['flags']['standalone'] ? Exporter::runtime($context) : "use {$context['runtime']} as {$context['runtimealias']};"; |
|
| 100 | 652 | $safeString = (($context['usedFeature']['enc'] > 0) && ($context['flags']['standalone'] === 0)) ? "use {$context['safestring']} as SafeString;" : ''; |
|
| 101 | 652 | $exportSafeString = (($context['usedFeature']['enc'] > 0) && ($context['flags']['standalone'] >0)) ? Exporter::safestring($context) : ''; |
|
| 102 | |||
| 103 | // Return generated PHP code string. |
||
| 104 | return <<<VAREND |
||
| 105 | 652 | $safeString{$use}{$exportSafeString}return function (\$in = null, \$options = null) { |
|
| 106 | \$helpers = $helpers; |
||
| 107 | \$partials = array($partials); |
||
| 108 | \$cx = array( |
||
| 109 | 'flags' => array( |
||
| 110 | 'jstrue' => $flagJStrue, |
||
| 111 | 'jsobj' => $flagJSObj, |
||
| 112 | 'spvar' => $flagSPVar, |
||
| 113 | 'prop' => $flagProp, |
||
| 114 | 'method' => $flagMethod, |
||
| 115 | 'lambda' => $flagLambda, |
||
| 116 | 'mustlok' => $flagMustlok, |
||
| 117 | 'mustlam' => $flagMustlam, |
||
| 118 | 'echo' => $flagEcho, |
||
| 119 | 'partnc' => $flagPartNC, |
||
| 120 | 'knohlp' => $flagKnownHlp, |
||
| 121 | 'debug' => isset(\$options['debug']) ? \$options['debug'] : $debug, |
||
| 122 | ), |
||
| 123 | 'constants' => $constants, |
||
| 124 | 'helpers' => isset(\$options['helpers']) ? array_merge(\$helpers, \$options['helpers']) : \$helpers, |
||
| 125 | 'partials' => isset(\$options['partials']) ? array_merge(\$partials, \$options['partials']) : \$partials, |
||
| 126 | 'scopes' => array(), |
||
| 127 | 'sp_vars' => isset(\$options['data']) ? array_merge(array('root' => \$in), \$options['data']) : array('root' => \$in), |
||
| 128 | 'blparam' => array(), |
||
| 129 | 'partialid' => 0, |
||
| 130 | 652 | 'runtime' => '{$context['runtime']}', |
|
| 131 | ); |
||
| 132 | 652 | {$context['renderex']} |
|
| 133 | 652 | {$context['ops']['op_start']}'$code'{$context['ops']['op_end']} |
|
| 134 | 652 | }; |
|
| 135 | VAREND |
||
| 136 | ; |
||
| 137 | } |
||
| 138 | |||
| 139 | /** |
||
| 140 | * Get function name for standalone or none standalone template. |
||
| 141 | * |
||
| 142 | * @param array<string,array|string|integer> $context Current context of compiler progress. |
||
| 143 | * @param string $name base function name |
||
| 144 | * @param string $tag original handlabars tag for debug |
||
| 145 | * |
||
| 146 | * @return string compiled Function name |
||
| 147 | * |
||
| 148 | * @expect 'LR::test(' when input array('flags' => array('standalone' => 0, 'debug' => 0), 'runtime' => 'Runtime', 'runtimealias' => 'LR'), 'test', '' |
||
| 149 | * @expect 'LL::test2(' when input array('flags' => array('standalone' => 0, 'debug' => 0), 'runtime' => 'Runtime', 'runtimealias' => 'LL'), 'test2', '' |
||
| 150 | * @expect "lala_abctest3(" when input array('flags' => array('standalone' => 1, 'debug' => 0), 'runtime' => 'Runtime', 'runtimealias' => 0, 'funcprefix' => 'lala_abc'), 'test3', '' |
||
| 151 | * @expect 'RR::debug(\'abc\', \'test\', ' when input array('flags' => array('standalone' => 0, 'debug' => 1), 'runtime' => 'Runtime', 'runtimealias' => 'RR', 'funcprefix' => 'haha456'), 'test', 'abc' |
||
| 152 | */ |
||
| 153 | 587 | protected static function getFuncName(&$context, $name, $tag) { |
|
| 166 | |||
| 167 | /** |
||
| 168 | * Get string presentation of variables |
||
| 169 | * |
||
| 170 | * @param array<string,array|string|integer> $context current compile context |
||
| 171 | * @param array<array> $vn variable name array. |
||
| 172 | * @param array<string>|null $blockParams block param list |
||
| 173 | * |
||
| 174 | * @return array<string|array> variable names |
||
| 175 | * |
||
| 176 | * @expect array('array(array($in),array())', array('this')) when input array('flags'=>array('spvar'=>true)), array(null) |
||
| 177 | * @expect array('array(array($in,$in),array())', array('this', 'this')) when input array('flags'=>array('spvar'=>true)), array(null, null) |
||
| 178 | * @expect array('array(array(),array(\'a\'=>$in))', array('this')) when input array('flags'=>array('spvar'=>true)), array('a' => null) |
||
| 179 | */ |
||
| 180 | 259 | protected static function getVariableNames(&$context, $vn, $blockParams = null) { |
|
| 195 | |||
| 196 | /** |
||
| 197 | * Get string presentation of a sub expression |
||
| 198 | * |
||
| 199 | * @param array<string,array|string|integer> $context current compile context |
||
| 200 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
| 201 | * |
||
| 202 | * @return array<string> code representing passed expression |
||
| 203 | */ |
||
| 204 | 41 | public static function compileSubExpression(&$context, $vars) { |
|
| 213 | |||
| 214 | /** |
||
| 215 | * Get string presentation of a subexpression or a variable |
||
| 216 | * |
||
| 217 | * @param array<array|string|integer> $context current compile context |
||
| 218 | * @param array<array|string|integer> $var variable parsed path |
||
| 219 | * |
||
| 220 | * @return array<string> variable names |
||
|
|
|||
| 221 | */ |
||
| 222 | 368 | protected static function getVariableNameOrSubExpression(&$context, $var) { |
|
| 225 | |||
| 226 | /** |
||
| 227 | * Get string presentation of a variable |
||
| 228 | * |
||
| 229 | * @param array<array|string|integer> $var variable parsed path |
||
| 230 | * @param array<array|string|integer> $context current compile context |
||
| 231 | * @param array<string>|null $lookup extra lookup string as valid PHP variable name |
||
| 232 | * |
||
| 233 | * @return array<string> variable names |
||
| 234 | * |
||
| 235 | * @expect array('$in', 'this') when input array('flags'=>array('spvar'=>true,'debug'=>0)), array(null) |
||
| 236 | * @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') |
||
| 237 | * @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') |
||
| 238 | * @expect array('true', 'true') when input array('flags'=>array('spvar'=>true,'debug'=>0)), array(-1, 'true') |
||
| 239 | * @expect array('false', 'false') when input array('flags'=>array('spvar'=>true,'debug'=>0)), array(-1, 'false') |
||
| 240 | * @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') |
||
| 241 | * @expect array('2', '2') when input array('flags'=>array('spvar'=>true,'debug'=>0,'prop'=>0,'method'=>0)), array(-1, '2') |
||
| 242 | * @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') |
||
| 243 | * @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') |
||
| 244 | * @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') |
||
| 245 | * @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') |
||
| 246 | * @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') |
||
| 247 | * @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"') |
||
| 248 | * @expect array('"a"', '"a"') when input array('flags'=>array('spvar'=>true,'debug'=>0)), array(-1, '"a"') |
||
| 249 | * @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') |
||
| 250 | * @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') |
||
| 251 | * @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') |
||
| 252 | * @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') |
||
| 253 | * @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', 'runtimealias' => 'LR'), array(null, 'id') |
||
| 254 | */ |
||
| 255 | 583 | protected static function getVariableName(&$context, $var, $lookup = null, $args = null) { |
|
| 300 | |||
| 301 | /** |
||
| 302 | * Return compiled PHP code for a handlebars token |
||
| 303 | * |
||
| 304 | * @param array<string,array|string|integer> $context current compile context |
||
| 305 | * @param array<string,array|boolean> $info parsed information |
||
| 306 | * |
||
| 307 | * @return string Return compiled code segment for the token |
||
| 308 | */ |
||
| 309 | 612 | protected static function compileToken(&$context, $info) { |
|
| 336 | |||
| 337 | /** |
||
| 338 | * handle partial |
||
| 339 | * |
||
| 340 | * @param array<string,array|string|integer> $context current compile context |
||
| 341 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
| 342 | * |
||
| 343 | * @return string Return compiled code segment for the partial |
||
| 344 | */ |
||
| 345 | 88 | public static function partial(&$context, $vars) { |
|
| 365 | |||
| 366 | /** |
||
| 367 | * handle inline partial |
||
| 368 | * |
||
| 369 | * @param array<string,array|string|integer> $context current compile context |
||
| 370 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
| 371 | * |
||
| 372 | * @return string Return compiled code segment for the partial |
||
| 373 | */ |
||
| 374 | 10 | public static function inline(&$context, $vars) { |
|
| 385 | |||
| 386 | /** |
||
| 387 | * Return compiled PHP code for a handlebars inverted section begin token |
||
| 388 | * |
||
| 389 | * @param array<string,array|string|integer> $context current compile context |
||
| 390 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
| 391 | * |
||
| 392 | * @return string Return compiled code segment for the token |
||
| 393 | */ |
||
| 394 | 38 | protected static function invertedSection(&$context, $vars) { |
|
| 398 | |||
| 399 | /** |
||
| 400 | * Return compiled PHP code for a handlebars block custom helper begin token |
||
| 401 | * |
||
| 402 | * @param array<string,array|string|integer> $context current compile context |
||
| 403 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
| 404 | * @param boolean $inverted the logic will be inverted |
||
| 405 | * |
||
| 406 | * @return string Return compiled code segment for the token |
||
| 407 | */ |
||
| 408 | 58 | protected static function blockCustomHelper(&$context, $vars, $inverted = false) { |
|
| 417 | |||
| 418 | /** |
||
| 419 | * Return compiled PHP code for a handlebars block end token |
||
| 420 | * |
||
| 421 | * @param array<string,array|string|integer> $context current compile context |
||
| 422 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
| 423 | * @param string|null $matchop should also match to this operator |
||
| 424 | * |
||
| 425 | * @return string Return compiled code segment for the token |
||
| 426 | */ |
||
| 427 | 317 | protected static function blockEnd(&$context, &$vars, $matchop = NULL) { |
|
| 463 | |||
| 464 | /** |
||
| 465 | * Return compiled PHP code for a handlebars block begin token |
||
| 466 | * |
||
| 467 | * @param array<string,array|string|integer> $context current compile context |
||
| 468 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
| 469 | * |
||
| 470 | * @return string Return compiled code segment for the token |
||
| 471 | */ |
||
| 472 | 236 | protected static function blockBegin(&$context, $vars) { |
|
| 492 | |||
| 493 | /** |
||
| 494 | * compile {{#foo}} token |
||
| 495 | * |
||
| 496 | * @param array<string,array|string|integer> $context current compile context |
||
| 497 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
| 498 | * @param boolean $isEach the section is #each |
||
| 499 | * |
||
| 500 | * @return string|null Return compiled code segment for the token |
||
| 501 | */ |
||
| 502 | 162 | protected static function section(&$context, $vars, $isEach = false) { |
|
| 520 | |||
| 521 | /** |
||
| 522 | * compile {{with}} token |
||
| 523 | * |
||
| 524 | * @param array<string,array|string|integer> $context current compile context |
||
| 525 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
| 526 | * |
||
| 527 | * @return string|null Return compiled code segment for the token |
||
| 528 | */ |
||
| 529 | 26 | protected static function with(&$context, $vars) { |
|
| 536 | |||
| 537 | /** |
||
| 538 | * Return compiled PHP code for a handlebars custom helper token |
||
| 539 | * |
||
| 540 | * @param array<string,array|string|integer> $context current compile context |
||
| 541 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
| 542 | * @param boolean $raw is this {{{ token or not |
||
| 543 | * @param boolean $nosep true to compile without seperator |
||
| 544 | * |
||
| 545 | * @return string|null Return compiled code segment for the token when the token is custom helper |
||
| 546 | */ |
||
| 547 | 451 | protected static function customHelper(&$context, $vars, $raw, $nosep) { |
|
| 560 | |||
| 561 | /** |
||
| 562 | * Return compiled PHP code for a handlebars else token |
||
| 563 | * |
||
| 564 | * @param array<string,array|string|integer> $context current compile context |
||
| 565 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
| 566 | * |
||
| 567 | * @return string Return compiled code segment for the token when the token is else |
||
| 568 | */ |
||
| 569 | 48 | protected static function doElse(&$context, $vars) { |
|
| 579 | |||
| 580 | /** |
||
| 581 | * Return compiled PHP code for a handlebars log token |
||
| 582 | * |
||
| 583 | * @param array<string,array|string|integer> $context current compile context |
||
| 584 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
| 585 | * @param boolean $raw is this {{{ token or not |
||
| 586 | * |
||
| 587 | * @return string Return compiled code segment for the token |
||
| 588 | */ |
||
| 589 | 2 | protected static function compileLog(&$context, &$vars, $raw) { |
|
| 594 | |||
| 595 | /** |
||
| 596 | * Return compiled PHP code for a handlebars lookup token |
||
| 597 | * |
||
| 598 | * @param array<string,array|string|integer> $context current compile context |
||
| 599 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
| 600 | * @param boolean $raw is this {{{ token or not |
||
| 601 | * |
||
| 602 | * @return string Return compiled code segment for the token |
||
| 603 | */ |
||
| 604 | 2 | protected static function compileLookup(&$context, &$vars, $raw) { |
|
| 613 | |||
| 614 | /** |
||
| 615 | * Return compiled PHP code for template output |
||
| 616 | * |
||
| 617 | * @param array<string,array|string|integer> $context current compile context |
||
| 618 | * @param string $variable PHP code for the variable |
||
| 619 | * @param string $expression normalized handlebars expression |
||
| 620 | * @param boolean $raw is this {{{ token or not |
||
| 621 | * @param boolean $nosep true to compile without seperator |
||
| 622 | * |
||
| 623 | * @return string Return compiled code segment for the token |
||
| 624 | */ |
||
| 625 | 459 | protected static function compileOutput(&$context, $variable, $expression, $raw, $nosep) { |
|
| 633 | |||
| 634 | /** |
||
| 635 | * Return compiled PHP code for a handlebars variable token |
||
| 636 | * |
||
| 637 | * @param array<string,array|string|integer> $context current compile context |
||
| 638 | * @param array<boolean|integer|string|array> $vars parsed arguments list |
||
| 639 | * @param boolean $raw is this {{{ token or not |
||
| 640 | * @param boolean $nosep true to compile without seperator |
||
| 641 | * |
||
| 642 | * @return string Return compiled code segment for the token |
||
| 643 | */ |
||
| 644 | 359 | protected static function compileVariable(&$context, &$vars, $raw, $nosep) { |
|
| 653 | |||
| 654 | /** |
||
| 655 | * Add usage count to context |
||
| 656 | * |
||
| 657 | * @param array<string,array|string|integer> $context current context |
||
| 658 | * @param string $category category name, can be one of: 'var', 'helpers', 'runtime' |
||
| 659 | * @param string $name used name |
||
| 660 | * @param integer $count increment |
||
| 661 | * |
||
| 662 | * @expect 1 when input array('usedCount' => array('test' => array())), 'test', 'testname' |
||
| 663 | * @expect 3 when input array('usedCount' => array('test' => array('testname' => 2))), 'test', 'testname' |
||
| 664 | * @expect 5 when input array('usedCount' => array('test' => array('testname' => 2))), 'test', 'testname', 3 |
||
| 665 | */ |
||
| 666 | 587 | protected static function addUsageCount(&$context, $category, $name, $count = 1) { |
|
| 672 | } |
||
| 673 | |||
| 674 |
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.