Algo-Web /
POData
| Total Complexity | 51 |
| Total Lines | 457 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like ExpressionParser2 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.
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 ExpressionParser2, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 28 | class ExpressionParser2 extends ExpressionParser |
||
| 29 | { |
||
| 30 | /** |
||
| 31 | * @var array |
||
| 32 | */ |
||
| 33 | private $mapTable; |
||
| 34 | |||
| 35 | /** |
||
| 36 | * Collection of navigation properties used in the expression. |
||
| 37 | * |
||
| 38 | * @var array<array> |
||
| 39 | */ |
||
| 40 | private $navigationPropertiesUsedInTheExpression; |
||
| 41 | |||
| 42 | /** |
||
| 43 | * Indicates whether the end user has implemented IExpressionProvider or not. |
||
| 44 | * |
||
| 45 | * @var bool |
||
| 46 | */ |
||
| 47 | private $isPHPExpressionProvider; |
||
| 48 | |||
| 49 | /** |
||
| 50 | * Create new instance of ExpressionParser2. |
||
| 51 | * |
||
| 52 | * @param string $text The text expression to parse |
||
| 53 | * @param ResourceType $resourceType The resource type in which |
||
| 54 | * expression will be applied |
||
| 55 | * @param bool $isPHPExpressionProvider True if IExpressionProvider provider is |
||
| 56 | * implemented by user, False otherwise |
||
| 57 | */ |
||
| 58 | public function __construct($text, ResourceType $resourceType, $isPHPExpressionProvider) |
||
| 59 | { |
||
| 60 | parent::__construct($text, $resourceType, $isPHPExpressionProvider); |
||
| 61 | $this->navigationPropertiesUsedInTheExpression = []; |
||
| 62 | $this->isPHPExpressionProvider = $isPHPExpressionProvider; |
||
| 63 | } |
||
| 64 | |||
| 65 | /** |
||
| 66 | * Parse and generate expression from the the given odata expression. |
||
| 67 | * |
||
| 68 | * |
||
| 69 | * @param string $text The text expression to parse |
||
| 70 | * @param ResourceType $resourceType The resource type in which |
||
| 71 | * @param IExpressionProvider $expressionProvider Implementation of IExpressionProvider |
||
| 72 | * |
||
| 73 | * @throws ODataException If any error occurs while parsing the odata expression or |
||
| 74 | * building the php/custom expression |
||
| 75 | * |
||
| 76 | * @return FilterInfo |
||
| 77 | */ |
||
| 78 | public static function parseExpression2($text, ResourceType $resourceType, IExpressionProvider $expressionProvider) |
||
| 79 | { |
||
| 80 | $expressionParser2 = new self($text, $resourceType, $expressionProvider instanceof PHPExpressionProvider); |
||
| 81 | $expressionTree = $expressionParser2->parseFilter(); |
||
| 82 | |||
| 83 | $expressionAsString = null; |
||
|
Unused Code
introduced
by
|
|||
| 84 | |||
| 85 | $expressionProvider->setResourceType($resourceType); |
||
| 86 | $expressionProcessor = new ExpressionProcessor($expressionProvider); |
||
| 87 | |||
| 88 | try { |
||
| 89 | $expressionAsString = $expressionProcessor->processExpression($expressionTree); |
||
| 90 | } catch (\InvalidArgumentException $invalidArgumentException) { |
||
| 91 | throw ODataException::createInternalServerError($invalidArgumentException->getMessage()); |
||
| 92 | } |
||
| 93 | $expressionAsString = (null !== $expressionAsString) ? $expressionAsString : ''; |
||
| 94 | return new FilterInfo( |
||
| 95 | $expressionParser2->navigationPropertiesUsedInTheExpression, |
||
| 96 | $expressionAsString |
||
| 97 | ); |
||
| 98 | } |
||
| 99 | |||
| 100 | /** |
||
| 101 | * Parse the expression. |
||
| 102 | * |
||
| 103 | * @see library/POData/QueryProcessor/ExpressionParser::parseFilter() |
||
| 104 | * |
||
| 105 | * @throws ODataException |
||
| 106 | * |
||
| 107 | * @return AbstractExpression |
||
| 108 | */ |
||
| 109 | public function parseFilter() |
||
| 110 | { |
||
| 111 | $expression = parent::parseFilter(); |
||
| 112 | if (!$expression->typeIs(new Boolean())) { |
||
| 113 | throw ODataException::createSyntaxError( |
||
| 114 | Messages::expressionParser2BooleanRequired() |
||
| 115 | ); |
||
| 116 | } |
||
| 117 | if ($this->isPHPExpressionProvider) { |
||
| 118 | $resultExpression = $this->processNodeForNullability(null, $expression); |
||
| 119 | if (null != $resultExpression) { |
||
| 120 | return $resultExpression; |
||
| 121 | } |
||
| 122 | } |
||
| 123 | |||
| 124 | return $expression; |
||
| 125 | } |
||
| 126 | |||
| 127 | /** |
||
| 128 | * Process the expression node for nullability. |
||
| 129 | * |
||
| 130 | * @param AbstractExpression $parentExpression The parent expression of expression node to process |
||
| 131 | * @param AbstractExpression|null $expression The expression node to process |
||
| 132 | * @param bool $checkNullForMostChild Whether to include null check for current property |
||
| 133 | * @throws ODataException |
||
| 134 | * @return AbstractExpression|null |
||
| 135 | */ |
||
| 136 | private function processNodeForNullability( |
||
| 137 | $parentExpression, |
||
| 138 | AbstractExpression $expression = null, |
||
| 139 | $checkNullForMostChild = true |
||
| 140 | ) { |
||
| 141 | if ($expression instanceof ArithmeticExpression) { |
||
| 142 | return $this->processArithmeticNode($expression); |
||
| 143 | } elseif ($expression instanceof ConstantExpression) { |
||
| 144 | return null; |
||
| 145 | } elseif ($expression instanceof FunctionCallExpression) { |
||
| 146 | return $this->processFunctionCallNode($expression, $parentExpression); |
||
| 147 | } elseif ($expression instanceof LogicalExpression) { |
||
| 148 | return $this->processLogicalNode($expression, $parentExpression); |
||
| 149 | } elseif ($expression instanceof PropertyAccessExpression) { |
||
| 150 | return $this->processPropertyAccessNode( |
||
| 151 | $expression, |
||
| 152 | $parentExpression, |
||
| 153 | $checkNullForMostChild |
||
| 154 | ); |
||
| 155 | } elseif ($expression instanceof RelationalExpression) { |
||
| 156 | return $this->processRelationalNode($expression, $parentExpression); |
||
| 157 | } elseif ($expression instanceof UnaryExpression) { |
||
| 158 | return $this->processUnaryNode($expression, $parentExpression); |
||
| 159 | } |
||
| 160 | |||
| 161 | throw ODataException::createSyntaxError( |
||
| 162 | Messages::expressionParser2UnexpectedExpression(get_class($expression)) |
||
| 163 | ); |
||
| 164 | } |
||
| 165 | |||
| 166 | /** |
||
| 167 | * Process an arithmetic expression node for nullability. |
||
| 168 | * |
||
| 169 | * @param ArithmeticExpression $expression The arithmetic expression node |
||
| 170 | * to process |
||
| 171 | * |
||
| 172 | * @return AbstractExpression|null |
||
| 173 | */ |
||
| 174 | private function processArithmeticNode(ArithmeticExpression $expression) |
||
| 175 | { |
||
| 176 | $leftNullableExpTree = $this->processNodeForNullability($expression, $expression->getLeft()); |
||
| 177 | $rightNullableExpTree = $this->processNodeForNullability($expression, $expression->getRight()); |
||
| 178 | $resultExpression = $this->calculateResultExpression($leftNullableExpTree, $rightNullableExpTree); |
||
| 179 | |||
| 180 | return $resultExpression; |
||
| 181 | } |
||
| 182 | |||
| 183 | /** |
||
| 184 | * Process an arithmetic expression node for nullability. |
||
| 185 | * |
||
| 186 | * @param FunctionCallExpression $expression The function call expression |
||
| 187 | * node to process |
||
| 188 | * @param AbstractExpression $parentExpression The parent expression of |
||
| 189 | * expression node to process |
||
| 190 | * |
||
| 191 | * @return null|AbstractExpression |
||
| 192 | */ |
||
| 193 | private function processFunctionCallNode( |
||
| 194 | FunctionCallExpression $expression, |
||
| 195 | $parentExpression |
||
| 196 | ) { |
||
| 197 | $paramExpressions = $expression->getParamExpressions(); |
||
| 198 | $checkNullForMostChild = strcmp($expression->getFunctionDescription()->name, 'is_null') === 0; |
||
| 199 | $resultExpression = null; |
||
| 200 | foreach ($paramExpressions as $paramExpression) { |
||
| 201 | $resultExpression1 = $this->processNodeForNullability( |
||
| 202 | $expression, |
||
| 203 | $paramExpression, |
||
| 204 | !$checkNullForMostChild |
||
| 205 | ); |
||
| 206 | $resultExpression = $this->calculateResultExpression($resultExpression, $resultExpression1); |
||
| 207 | } |
||
| 208 | |||
| 209 | if (null == $resultExpression) { |
||
| 210 | return null; |
||
| 211 | } |
||
| 212 | |||
| 213 | if (null == $parentExpression) { |
||
| 214 | return new LogicalExpression( |
||
| 215 | $resultExpression, |
||
| 216 | $expression, |
||
| 217 | ExpressionType::AND_LOGICAL() |
||
| 218 | ); |
||
| 219 | } |
||
| 220 | |||
| 221 | return $resultExpression; |
||
| 222 | } |
||
| 223 | |||
| 224 | /** |
||
| 225 | * Process an logical expression node for nullability. |
||
| 226 | * |
||
| 227 | * @param LogicalExpression $expression The logical expression node |
||
| 228 | * to process |
||
| 229 | * @param AbstractExpression $parentExpression The parent expression of |
||
| 230 | * expression node to process |
||
| 231 | * |
||
| 232 | * @return null|AbstractExpression |
||
| 233 | */ |
||
| 234 | private function processLogicalNode( |
||
| 235 | LogicalExpression $expression, |
||
| 236 | $parentExpression |
||
| 237 | ) { |
||
| 238 | $leftNullableExpTree = $this->processNodeForNullability($expression, $expression->getLeft()); |
||
| 239 | $rightNullableExpTree = $this->processNodeForNullability($expression, $expression->getRight()); |
||
| 240 | if ($expression->getNodeType() == ExpressionType::OR_LOGICAL()) { |
||
| 241 | if (null !== $leftNullableExpTree) { |
||
| 242 | $resultExpression = new LogicalExpression( |
||
| 243 | $leftNullableExpTree, |
||
| 244 | $expression->getLeft(), |
||
| 245 | ExpressionType::AND_LOGICAL() |
||
| 246 | ); |
||
| 247 | $expression->setLeft($resultExpression); |
||
| 248 | } |
||
| 249 | |||
| 250 | if (null !== $rightNullableExpTree) { |
||
| 251 | $resultExpression = new LogicalExpression( |
||
| 252 | $rightNullableExpTree, |
||
| 253 | $expression->getRight(), |
||
| 254 | ExpressionType::AND_LOGICAL() |
||
| 255 | ); |
||
| 256 | $expression->setRight($resultExpression); |
||
| 257 | } |
||
| 258 | |||
| 259 | return null; |
||
| 260 | } |
||
| 261 | |||
| 262 | $resultExpression = $this->calculateResultExpression($leftNullableExpTree, $rightNullableExpTree); |
||
| 263 | |||
| 264 | if (null == $resultExpression) { |
||
| 265 | return null; |
||
| 266 | } |
||
| 267 | |||
| 268 | if (null == $parentExpression) { |
||
| 269 | return new LogicalExpression( |
||
| 270 | $resultExpression, |
||
| 271 | $expression, |
||
| 272 | ExpressionType::AND_LOGICAL() |
||
| 273 | ); |
||
| 274 | } |
||
| 275 | |||
| 276 | return $resultExpression; |
||
| 277 | } |
||
| 278 | |||
| 279 | /** |
||
| 280 | * Process an property access expression node for nullability. |
||
| 281 | * |
||
| 282 | * @param PropertyAccessExpression $expression The property access |
||
| 283 | * expression node to process |
||
| 284 | * @param AbstractExpression $parentExpression The parent expression of |
||
| 285 | * expression node to process |
||
| 286 | * @param bool $checkNullForMostChild Whether to check null for |
||
| 287 | * most child node or not |
||
| 288 | * |
||
| 289 | * @return LogicalExpression|UnaryExpression|null |
||
| 290 | */ |
||
| 291 | private function processPropertyAccessNode( |
||
| 292 | PropertyAccessExpression $expression, |
||
| 293 | $parentExpression, |
||
| 294 | $checkNullForMostChild |
||
| 295 | ) { |
||
| 296 | $navigationsUsed = $expression->getNavigationPropertiesInThePath(); |
||
| 297 | if (!empty($navigationsUsed)) { |
||
| 298 | $this->navigationPropertiesUsedInTheExpression[] = $navigationsUsed; |
||
| 299 | } |
||
| 300 | |||
| 301 | $nullableExpTree = $expression->createNullableExpressionTree($checkNullForMostChild); |
||
| 302 | |||
| 303 | if (null == $parentExpression) { |
||
| 304 | return new LogicalExpression( |
||
| 305 | $nullableExpTree, |
||
| 306 | $expression, |
||
| 307 | ExpressionType::AND_LOGICAL() |
||
| 308 | ); |
||
| 309 | } |
||
| 310 | |||
| 311 | return $nullableExpTree; |
||
| 312 | } |
||
| 313 | |||
| 314 | /** |
||
| 315 | * Process a relational expression node for nullability. |
||
| 316 | * |
||
| 317 | * @param RelationalExpression $expression The relational expression node |
||
| 318 | * to process |
||
| 319 | * @param AbstractExpression $parentExpression The parent expression of |
||
| 320 | * expression node to process |
||
| 321 | * |
||
| 322 | * @return null|AbstractExpression |
||
| 323 | */ |
||
| 324 | private function processRelationalNode( |
||
| 346 | } |
||
| 347 | |||
| 348 | /** |
||
| 349 | * Process an unary expression node for nullability. |
||
| 350 | * |
||
| 351 | * @param UnaryExpression $expression The unary expression node |
||
| 352 | * to process |
||
| 353 | * @param AbstractExpression $parentExpression The parent expression of |
||
| 354 | * expression node to process |
||
| 355 | * |
||
| 356 | * @throws ODataException |
||
| 357 | * @return AbstractExpression|null |
||
| 358 | */ |
||
| 359 | private function processUnaryNode( |
||
| 386 | ); |
||
| 387 | } |
||
| 388 | |||
| 389 | /** |
||
| 390 | * Merge two null check expression trees by removing duplicate nodes. |
||
| 391 | * |
||
| 392 | * @param AbstractExpression $nullCheckExpTree1 First expression |
||
| 393 | * @param AbstractExpression $nullCheckExpTree2 Second expression |
||
| 394 | * |
||
| 395 | * @return LogicalExpression|UnaryExpression|null |
||
| 396 | */ |
||
| 397 | private function mergeNullableExpressionTrees( |
||
| 434 | } |
||
| 435 | |||
| 436 | /** |
||
| 437 | * Populate map table. |
||
| 438 | * |
||
| 439 | * @param AbstractExpression $nullCheckExpTree The expression to verify |
||
| 440 | * |
||
| 441 | * @throws ODataException |
||
| 442 | */ |
||
| 443 | private function map($nullCheckExpTree) |
||
| 465 | ); |
||
| 466 | } |
||
| 467 | } |
||
| 468 | |||
| 469 | /** |
||
| 470 | * @param AbstractExpression|null $leftNullableExpTree |
||
| 471 | * @param AbstractExpression|null $rightNullableExpTree |
||
| 472 | * @return null|AbstractExpression |
||
| 473 | */ |
||
| 474 | private function calculateResultExpression($leftNullableExpTree, $rightNullableExpTree) |
||
| 485 | } |
||
| 486 | } |
||
| 487 |
Loading history...
