zordius /
lightncandy
Complex classes like Parser 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 Parser, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 29 | class Parser extends Token |
||
| 30 | { |
||
| 31 | // Compile time error handling flags |
||
| 32 | const BLOCKPARAM = 9999; |
||
| 33 | |||
| 34 | /** |
||
| 35 | * Get block params and fix the variable list |
||
| 36 | * |
||
| 37 | * @param array<boolean|integer|array> $vars parsed token |
||
| 38 | * |
||
| 39 | * @return array<string>|null Return list of block params or null |
||
|
|
|||
| 40 | * |
||
| 41 | */ |
||
| 42 | 168 | public static function getBlockParams(&$vars) { |
|
| 49 | |||
| 50 | /** |
||
| 51 | * Return array presentation for an expression |
||
| 52 | * |
||
| 53 | * @param string $name variable name. |
||
| 54 | * @param boolean $asis keep the name as is or not |
||
| 55 | * @param boolean $quote add single quote or not |
||
| 56 | * |
||
| 57 | * @return array<integer|string> Return variable name array |
||
| 58 | * |
||
| 59 | */ |
||
| 60 | 80 | protected static function getLiteral($name, $asis, $quote = false) { |
|
| 63 | |||
| 64 | /** |
||
| 65 | * Return array presentation for an expression |
||
| 66 | * |
||
| 67 | * @param string $v analyzed expression names. |
||
| 68 | * @param array<string,array|string|integer> $context Current compile content. |
||
| 69 | * @param boolean $asis keep the reference name |
||
| 70 | * |
||
| 71 | * @return array<integer,string> Return variable name array |
||
| 72 | * |
||
| 73 | * @expect array('this') when input 'this', array('flags' => array('advar' => 0, 'this' => 0)), false |
||
| 74 | * @expect array() when input 'this', array('flags' => array('advar' => 0, 'this' => 1)), false |
||
| 75 | * @expect array(1) when input '../', array('flags' => array('advar' => 0, 'this' => 1, 'parent' => 1), 'usedFeature' => array('parent' => 0)), false |
||
| 76 | * @expect array(1) when input '../.', array('flags' => array('advar' => 0, 'this' => 1, 'parent' => 1), 'usedFeature' => array('parent' => 0)), false |
||
| 77 | * @expect array(1) when input '../this', array('flags' => array('advar' => 0, 'this' => 1, 'parent' => 1), 'usedFeature' => array('parent' => 0)), false |
||
| 78 | * @expect array(1, 'a') when input '../a', array('flags' => array('advar' => 0, 'this' => 1, 'parent' => 1), 'usedFeature' => array('parent' => 0)), false |
||
| 79 | * @expect array(2, 'a', 'b') when input '../../a.b', array('flags' => array('advar' => 0, 'this' => 0, 'parent' => 1), 'usedFeature' => array('parent' => 0)), false |
||
| 80 | * @expect array(2, '[a]', 'b') when input '../../[a].b', array('flags' => array('advar' => 0, 'this' => 0, 'parent' => 1), 'usedFeature' => array('parent' => 0)), false |
||
| 81 | * @expect array(2, 'a', 'b') when input '../../[a].b', array('flags' => array('advar' => 1, 'this' => 0, 'parent' => 1), 'usedFeature' => array('parent' => 0)), false |
||
| 82 | * @expect array('id') when input 'this.id', array('flags' => array('advar' => 1, 'this' => 1, 'parent' => 1), 'usedFeature' => array('parent' => 0)), false |
||
| 83 | * @expect array(0, '\'a.b\'') when input '"a.b"', array('flags' => array('advar' => 1, 'this' => 0, 'parent' => 1), 'usedFeature' => array('parent' => 0)), false |
||
| 84 | * @expect array(0, '123') when input '123', array('flags' => array('advar' => 1, 'this' => 0, 'parent' => 1), 'usedFeature' => array('parent' => 0)), false |
||
| 85 | * @expect array(0, 'null') when input 'null', array('flags' => array('advar' => 1, 'this' => 0, 'parent' => 1), 'usedFeature' => array('parent' => 0)), false |
||
| 86 | */ |
||
| 87 | 583 | protected static function getExpression($v, &$context, $asis) { |
|
| 88 | // handle number |
||
| 89 | 583 | if (is_numeric($v)) { |
|
| 90 | 24 | return static::getLiteral(strval(1 * $v), $asis); |
|
| 91 | } |
||
| 92 | |||
| 93 | // handle double quoted string |
||
| 94 | 583 | if (preg_match('/^"(.*)"$/', $v, $matched)) { |
|
| 95 | 44 | return static::getLiteral(preg_replace('/([^\\\\])\\\\\\\\"/', '$1"', preg_replace('/^\\\\\\\\"/', '"', $matched[1])), $asis, true); |
|
| 96 | } |
||
| 97 | |||
| 98 | // handle single quoted string |
||
| 99 | 577 | if (preg_match('/^\\\\\'(.*)\\\\\'$/', $v, $matched)) { |
|
| 100 | 16 | return static::getLiteral($matched[1], $asis, true); |
|
| 101 | } |
||
| 102 | |||
| 103 | // handle boolean, null and undefined |
||
| 104 | 574 | if (preg_match('/^(true|false|null|undefined)$/', $v)) { |
|
| 105 | 22 | return static::getLiteral(($v === 'undefined') ? 'null' : $v, $asis); |
|
| 106 | } |
||
| 107 | |||
| 108 | 571 | $ret = array(); |
|
| 109 | 571 | $levels = 0; |
|
| 110 | |||
| 111 | // handle .. |
||
| 112 | 571 | if ($v === '..') { |
|
| 113 | 6 | $v = '../'; |
|
| 114 | } |
||
| 115 | |||
| 116 | // Trace to parent for ../ N times |
||
| 117 | 571 | $v = preg_replace_callback('/\\.\\.\\//', function() use (&$levels) { |
|
| 118 | 40 | $levels++; |
|
| 119 | 40 | return ''; |
|
| 120 | 571 | }, trim($v)); |
|
| 121 | |||
| 122 | // remove ./ in path |
||
| 123 | 571 | $v = preg_replace('/\\.\\//', '', $v); |
|
| 124 | |||
| 125 | 571 | if ($levels) { |
|
| 126 | 40 | $ret[] = $levels; |
|
| 127 | 40 | if (!$context['flags']['parent']) { |
|
| 128 | 4 | $context['error'][] = 'Do not support {{../var}}, you should do compile with LightnCandy::FLAG_PARENT flag'; |
|
| 129 | } |
||
| 130 | 40 | $context['usedFeature']['parent'] ++; |
|
| 131 | } |
||
| 132 | |||
| 133 | 571 | if ($context['flags']['advar'] && preg_match('/\\]/', $v)) { |
|
| 134 | 31 | preg_match_all(static::VARNAME_SEARCH, $v, $matchedall); |
|
| 135 | } else { |
||
| 136 | 546 | preg_match_all('/([^\\.\\/]+)/', $v, $matchedall); |
|
| 137 | } |
||
| 138 | |||
| 139 | 571 | foreach ($matchedall[1] as $m) { |
|
| 140 | 564 | if ($context['flags']['advar'] && substr($m, 0, 1) === '[') { |
|
| 141 | 25 | $ret[] = substr($m, 1, -1); |
|
| 142 | 557 | } else if ((!$context['flags']['this'] || ($m !== 'this')) && ($m !== '.')) { |
|
| 143 | 564 | $ret[] = $m; |
|
| 144 | } |
||
| 145 | } |
||
| 146 | |||
| 147 | 571 | return $ret; |
|
| 148 | } |
||
| 149 | |||
| 150 | /** |
||
| 151 | * Parse the token and return parsed result. |
||
| 152 | * |
||
| 153 | * @param array<string> $token preg_match results |
||
| 154 | * @param array<string,array|string|integer> $context current compile context |
||
| 155 | * |
||
| 156 | * @return array<boolean|integer|array> Return parsed result |
||
| 157 | * |
||
| 158 | * @expect array(false, array(array())) when input array(0,0,0,0,0,0,0,''), array('flags' => array('advar' => 0, 'this' => 1, 'namev' => 0, 'noesc' => 0), 'rawblock' => false) |
||
| 159 | * @expect array(true, array(array())) when input array(0,0,0,'{{',0,'{',0,''), array('flags' => array('advar' => 0, 'this' => 1, 'namev' => 0, 'noesc' => 0), 'rawblock' => false) |
||
| 160 | * @expect array(true, array(array())) when input array(0,0,0,0,0,0,0,''), array('flags' => array('advar' => 0, 'this' => 1, 'namev' => 0, 'noesc' => 1), 'rawblock' => false) |
||
| 161 | * @expect array(false, array(array('a'))) when input array(0,0,0,0,0,0,0,'a'), array('flags' => array('advar' => 0, 'this' => 1, 'namev' => 0, 'noesc' => 0), 'rawblock' => false) |
||
| 162 | * @expect array(false, array(array('a'), array('b'))) when input array(0,0,0,0,0,0,0,'a b'), array('flags' => array('advar' => 0, 'this' => 1, 'namev' => 0, 'noesc' => 0), 'rawblock' => false) |
||
| 163 | * @expect array(false, array(array('a'), array('"b'), array('c"'))) when input array(0,0,0,0,0,0,0,'a "b c"'), array('flags' => array('advar' => 0, 'this' => 1, 'namev' => 0, 'noesc' => 0), 'rawblock' => false) |
||
| 164 | * @expect array(false, array(array('a'), array(0, '\'b c\''))) when input array(0,0,0,0,0,0,0,'a "b c"'), array('flags' => array('advar' => 1, 'this' => 1, 'namev' => 0, 'noesc' => 0), 'rawblock' => false) |
||
| 165 | * @expect array(false, array(array('a'), array('[b'), array('c]'))) when input array(0,0,0,0,0,0,0,'a [b c]'), array('flags' => array('advar' => 0, 'this' => 1, 'namev' => 0, 'noesc' => 0), 'rawblock' => false) |
||
| 166 | * @expect array(false, array(array('a'), array('[b'), array('c]'))) when input array(0,0,0,0,0,0,0,'a [b c]'), array('flags' => array('advar' => 0, 'this' => 1, 'namev' => 1, 'noesc' => 0), 'rawblock' => false) |
||
| 167 | * @expect array(false, array(array('a'), array('b c'))) when input array(0,0,0,0,0,0,0,'a [b c]'), array('flags' => array('advar' => 1, 'this' => 1, 'namev' => 0, 'noesc' => 0), 'rawblock' => false) |
||
| 168 | * @expect array(false, array(array('a'), array('b c'))) when input array(0,0,0,0,0,0,0,'a [b c]'), array('flags' => array('advar' => 1, 'this' => 1, 'namev' => 1, 'noesc' => 0), 'rawblock' => false) |
||
| 169 | * @expect array(false, array(array('a'), 'q' => array('b c'))) when input array(0,0,0,0,0,0,0,'a q=[b c]'), array('flags' => array('advar' => 1, 'this' => 1, 'namev' => 1, 'noesc' => 0), 'rawblock' => false) |
||
| 170 | * @expect array(false, array(array('a'), array('q=[b c'))) when input array(0,0,0,0,0,0,0,'a [q=[b c]'), array('flags' => array('advar' => 1, 'this' => 1, 'namev' => 1, 'noesc' => 0), 'rawblock' => false) |
||
| 171 | * @expect array(false, array(array('a'), 'q' => array('[b'), array('c]'))) when input array(0,0,0,0,0,0,0,'a q=[b c]'), array('flags' => array('advar' => 0, 'this' => 1, 'namev' => 1, 'noesc' => 0), 'rawblock' => false) |
||
| 172 | * @expect array(false, array(array('a'), 'q' => array('b'), array('c'))) when input array(0,0,0,0,0,0,0,'a [q]=b c'), array('flags' => array('advar' => 0, 'this' => 1, 'namev' => 1, 'noesc' => 0), 'rawblock' => false) |
||
| 173 | * @expect array(false, array(array('a'), 'q' => array(0, '\'b c\''))) when input array(0,0,0,0,0,0,0,'a q="b c"'), array('flags' => array('advar' => 1, 'this' => 1, 'namev' => 1, 'noesc' => 0), 'rawblock' => false) |
||
| 174 | * @expect array(false, array(array(-1, array(array('foo'), array('bar')), '(foo bar)'))) when input array(0,0,0,0,0,0,0,'(foo bar)'), array('flags' => array('advar' => 1, 'this' => 1, 'namev' => 1, 'noesc' => 0, 'exhlp' => 1, 'lambda' => 0), 'ops' => array('seperator' => ''), 'usedFeature' => array('subexp' => 0), 'rawblock' => false) |
||
| 175 | * @expect array(false, array(array('foo'), array("'=='"), array('bar'))) when input array(0,0,0,0,0,0,0,"foo '==' bar"), array('flags' => array('advar' => 1, 'namev' => 1, 'noesc' => 0, 'this' => 0), 'rawblock' => false) |
||
| 176 | * @expect array(false, array(array(-1, array(array('foo'), array('bar')), '( foo bar)'))) when input array(0,0,0,0,0,0,0,'( foo bar)'), array('flags' => array('advar' => 1, 'this' => 1, 'namev' => 1, 'noesc' => 0, 'exhlp' => 1, 'lambda' => 0), 'ops' => array('seperator' => ''), 'usedFeature' => array('subexp' => 0), 'rawblock' => false) |
||
| 177 | * @expect array(false, array(array('a'), array(0, '\' b c\''))) when input array(0,0,0,0,0,0,0,'a " b c"'), array('flags' => array('advar' => 1, 'this' => 1, 'namev' => 0, 'noesc' => 0), 'rawblock' => false) |
||
| 178 | * @expect array(false, array(array('a'), 'q' => array(0, '\' b c\''))) when input array(0,0,0,0,0,0,0,'a q=" b c"'), array('flags' => array('advar' => 1, 'this' => 1, 'namev' => 1, 'noesc' => 0), 'rawblock' => false) |
||
| 179 | * @expect array(false, array(array('foo'), array(0, "' =='"), array('bar'))) when input array(0,0,0,0,0,0,0,"foo \' ==\' bar"), array('flags' => array('advar' => 1, 'namev' => 1, 'noesc' => 0, 'this' => 0), 'rawblock' => false) |
||
| 180 | * @expect array(false, array(array('a'), array(' b c'))) when input array(0,0,0,0,0,0,0,'a [ b c]'), array('flags' => array('advar' => 1, 'this' => 1, 'namev' => 1, 'noesc' => 0), 'rawblock' => false) |
||
| 181 | * @expect array(false, array(array('a'), 'q' => array(0, "' d e'"))) when input array(0,0,0,0,0,0,0,"a q=\' d e\'"), array('flags' => array('advar' => 1, 'this' => 1, 'namev' => 1, 'noesc' => 0), 'rawblock' => false) |
||
| 182 | * @expect array(false, array('q' => array(-1, array(array('foo'), array('bar')), '( foo bar)'))) when input array(0,0,0,0,0,0,0,'q=( foo bar)'), array('flags' => array('advar' => 1, 'this' => 1, 'namev' => 1, 'noesc' => 0, 'exhlp' => 0, 'lambda' => 0), 'usedFeature' => array('subexp' => 0), 'ops' => array('seperator' => 0), 'rawblock' => false) |
||
| 183 | */ |
||
| 184 | 589 | public static function parse(&$token, &$context) { |
|
| 185 | 589 | $vars = static::analyze($token[static::POS_INNERTAG], $context); |
|
| 186 | 589 | if ($token[static::POS_OP] === '>' && isset($vars[0])) { |
|
| 187 | 69 | $fn = $vars[0]; |
|
| 188 | } |
||
| 189 | |||
| 190 | 589 | $avars = static::advancedVariable($vars, $context, static::toString($token)); |
|
| 191 | |||
| 192 | 589 | if ($token[static::POS_OP] === '>' && isset($fn)) { |
|
| 193 | 69 | $avars[0] = preg_match(SafeString::IS_SUBEXP_SEARCH, $fn) ? $avars[0] : array(preg_replace('/^("(.+)")|(\\[(.+)\\])$/', '$2$4', $fn)); |
|
| 194 | } |
||
| 195 | |||
| 196 | 589 | return array(($token[static::POS_BEGINRAW] === '{') || ($token[static::POS_OP] === '&') || $context['flags']['noesc'] || $context['rawblock'], $avars); |
|
| 197 | } |
||
| 198 | |||
| 199 | /** |
||
| 200 | * Parse a subexpression then return parsed result. |
||
| 201 | * |
||
| 202 | * @param string $expression the full string of a sub expression |
||
| 203 | * @param array<string,array|string|integer> $context current compile context |
||
| 204 | * |
||
| 205 | * @return array<boolean|integer|array> Return parsed result |
||
| 206 | */ |
||
| 207 | 37 | public static function subexpression($expression, &$context) { |
|
| 208 | 37 | $context['usedFeature']['subexp']++; |
|
| 209 | 37 | $vars = static::analyze(substr($expression, 1, -1), $context); |
|
| 210 | 37 | $avars = static::advancedVariable($vars, $context, $expression); |
|
| 211 | 37 | if (isset($avars[0][0]) && !$context['flags']['exhlp']) { |
|
| 212 | 21 | if (!Validator::helper($context, $avars[0][0])) { |
|
| 213 | 2 | $context['error'][] = "Can not find custom helper function defination {$avars[0][0]}() !"; |
|
| 214 | } |
||
| 215 | } |
||
| 216 | 37 | return array(-1, $avars, $expression); |
|
| 217 | } |
||
| 218 | |||
| 219 | /** |
||
| 220 | * Check a parsed result is a subexpression or not |
||
| 221 | * |
||
| 222 | * @param array<string|integer|array> $var |
||
| 223 | * |
||
| 224 | * @return boolean return true when input is a subexpression |
||
| 225 | */ |
||
| 226 | 354 | public static function isSubExp($var) { |
|
| 229 | |||
| 230 | /** |
||
| 231 | * Check a parsed result is a subexpression or not |
||
| 232 | * |
||
| 233 | * @param array<string|integer|array> $var |
||
| 234 | * |
||
| 235 | * @return boolean return true when input is a subexpression |
||
| 236 | */ |
||
| 237 | public static function isBlockParam($var) { |
||
| 240 | |||
| 241 | /** |
||
| 242 | * Analyze parsed token for advanved variables. |
||
| 243 | * |
||
| 244 | * @param array<boolean|integer|array> $vars parsed token |
||
| 245 | * @param array<string,array|string|integer> $context current compile context |
||
| 246 | * @param string $token original token |
||
| 247 | * |
||
| 248 | * @return array<boolean|integer|array> Return parsed result |
||
| 249 | * |
||
| 250 | */ |
||
| 251 | 588 | protected static function advancedVariable($vars, &$context, $token) { |
|
| 315 | |||
| 316 | /** |
||
| 317 | * Analyze a token string and return parsed result. |
||
| 318 | * |
||
| 319 | * @param string $token preg_match results |
||
| 320 | * @param array<string,array|string|integer> $context current compile context |
||
| 321 | * |
||
| 322 | * @return array<boolean|integer|array> Return parsed result |
||
| 323 | * |
||
| 324 | */ |
||
| 325 | 588 | protected static function analyze($token, &$context) { |
|
| 426 | } |
||
| 427 | |||
| 428 |
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.If the return type contains the type array, this check recommends the use of a more specific type like
String[]orarray<String>.