jclaveau / php-logical-filter

src/LogicalFilter.php

Spacing +86 added lines, -86 removed lines

@@ -51,12 +51,12 @@ 
      *
      * @see self::addRules
      */
-    public function __construct($rules=[], Filterer $default_filterer=null, array $options=[])
+    public function __construct($rules = [], Filterer $default_filterer = null, array $options = [])
     {
         if ($rules instanceof AbstractRule) {
             $rules = $rules->copy();
         }
-        elseif ( ! is_null($rules) && ! is_array($rules)) {
+        elseif (!is_null($rules) && !is_array($rules)) {
             throw new \InvalidArgumentException(
                 "\$rules must be a rules description or an AbstractRule instead of"
                 .var_export($rules, true)
@@ -72,7 +72,7 @@ 
         }
 
         if ($rules) {
-            $this->and_( $rules );
+            $this->and_($rules);
         }
     }
 
@@ -80,7 +80,7 @@ 
      */
     protected function getDefaultFilterer()
     {
-        if ( ! $this->default_filterer) {
+        if (!$this->default_filterer) {
             $this->default_filterer = new PhpFilterer();
         }
 
@@ -138,7 +138,7 @@ 
      * @param  array         $rules_description Rules description
      * @return LogicalFilter $this
      */
-    protected function addRules( $operation, array $rules_description )
+    protected function addRules($operation, array $rules_description)
     {
         if ($rules_description == [null]) {
             // TODO this is due to the bad design of using "Null" instead of
@@ -161,7 +161,7 @@ 
             }
         }
 
-        if (   count($rules_description) == 3
+        if (count($rules_description) == 3
             && is_string($rules_description[0])
             && is_string($rules_description[1])
         ) {
@@ -177,30 +177,30 @@ 
         }
         elseif (count($rules_description) == count(array_filter($rules_description, function($arg) {
             return $arg instanceof LogicalFilter;
-        })) ) {
+        }))) {
             // Already instanciated rules
             foreach ($rules_description as $i => $filter) {
                 $rules = $filter->getRules();
                 if ($rules !== null) {
-                    $this->addRule( $rules, $operation);
+                    $this->addRule($rules, $operation);
                 }
             }
         }
         elseif (count($rules_description) == count(array_filter($rules_description, function($arg) {
             return $arg instanceof AbstractRule;
-        })) ) {
+        }))) {
             // Already instanciated rules
             foreach ($rules_description as $i => $new_rule) {
-                $this->addRule( $new_rule, $operation);
+                $this->addRule($new_rule, $operation);
             }
         }
         elseif (count($rules_description) == 1 && is_array($rules_description[0])) {
             if (count($rules_description[0]) == count(array_filter($rules_description[0], function($arg) {
                 return $arg instanceof AbstractRule;
-            })) ) {
+            }))) {
                 // Case of $filter->or_([AbstractRule, AbstractRule, AbstractRule, ...])
                 foreach ($rules_description[0] as $i => $new_rule) {
-                    $this->addRule( $new_rule, $operation );
+                    $this->addRule($new_rule, $operation);
                 }
             }
             else {
@@ -211,7 +211,7 @@ 
                     $fake_root
                 );
 
-                $this->addRule( $fake_root->getOperands()[0], $operation );
+                $this->addRule($fake_root->getOperands()[0], $operation);
             }
         }
         else {
@@ -232,10 +232,10 @@ 
      *
      * @return $this
      */
-    protected function addRule( AbstractRule $rule, $operation=AndRule::operator )
+    protected function addRule(AbstractRule $rule, $operation = AndRule::operator)
     {
-        if ( $this->rules && in_array( get_class($this->rules), [AndRule::class, OrRule::class] )
-            && ! $this->rules->getOperands() ) {
+        if ($this->rules && in_array(get_class($this->rules), [AndRule::class, OrRule::class])
+            && !$this->rules->getOperands()) {
             throw new \LogicException(
                  "You are trying to add rules to a LogicalFilter which had "
                 ."only contradictory rules that have already been simplified: "
@@ -284,7 +284,7 @@ 
         array $rules_composition,
         AbstractOperationRule $recursion_position
     ) {
-        if ( ! array_filter($rules_composition, function ($rule_composition_part) {
+        if (!array_filter($rules_composition, function($rule_composition_part) {
             return is_string($rule_composition_part);
         })) {
             // at least one operator is required for operation rules
@@ -293,13 +293,13 @@ 
                 .var_export($rules_composition, true)
             );
         }
-        elseif ( count($rules_composition) == 3
-            && ! in_array( AndRule::operator, $rules_composition, true )
-            && ! in_array( OrRule::operator,  $rules_composition, true )
-            && ! in_array( NotRule::operator, $rules_composition, true )
-            && ! in_array( AbstractRule::findSymbolicOperator( AndRule::operator ), $rules_composition, true )
-            && ! in_array( AbstractRule::findSymbolicOperator( OrRule::operator ),  $rules_composition, true )
-            && ! in_array( AbstractRule::findSymbolicOperator( NotRule::operator ), $rules_composition, true )
+        elseif (count($rules_composition) == 3
+            && !in_array(AndRule::operator, $rules_composition, true)
+            && !in_array(OrRule::operator, $rules_composition, true)
+            && !in_array(NotRule::operator, $rules_composition, true)
+            && !in_array(AbstractRule::findSymbolicOperator(AndRule::operator), $rules_composition, true)
+            && !in_array(AbstractRule::findSymbolicOperator(OrRule::operator), $rules_composition, true)
+            && !in_array(AbstractRule::findSymbolicOperator(NotRule::operator), $rules_composition, true)
         ) {
             // atomic or composit rules
             $operand_left  = $rules_composition[0];
@@ -309,20 +309,20 @@ 
             $rule = AbstractRule::generateSimpleRule(
                 $operand_left, $operation, $operand_right, $this->getOptions()
             );
-            $recursion_position->addOperand( $rule );
+            $recursion_position->addOperand($rule);
         }
         else {
             // operations
-            if (   $rules_composition[0] == NotRule::operator
-                || $rules_composition[0] == AbstractRule::findSymbolicOperator( NotRule::operator ) ) {
+            if ($rules_composition[0] == NotRule::operator
+                || $rules_composition[0] == AbstractRule::findSymbolicOperator(NotRule::operator)) {
                 $rule = new NotRule();
             }
-            elseif (in_array( AndRule::operator, $rules_composition )
-                || in_array( AbstractRule::findSymbolicOperator( AndRule::operator ), $rules_composition )) {
+            elseif (in_array(AndRule::operator, $rules_composition)
+                || in_array(AbstractRule::findSymbolicOperator(AndRule::operator), $rules_composition)) {
                 $rule = new AndRule();
             }
-            elseif (in_array( OrRule::operator, $rules_composition )
-                || in_array( AbstractRule::findSymbolicOperator( OrRule::operator ), $rules_composition ) ) {
+            elseif (in_array(OrRule::operator, $rules_composition)
+                || in_array(AbstractRule::findSymbolicOperator(OrRule::operator), $rules_composition)) {
                 $rule = new OrRule();
             }
             else {
@@ -336,8 +336,8 @@ 
 
             $operands_descriptions = array_filter(
                 $rules_composition,
-                function ($operand) use ($operator) {
-                    return ! in_array($operand, [$operator, AbstractRule::findSymbolicOperator( $operator )]);
+                function($operand) use ($operator) {
+                    return !in_array($operand, [$operator, AbstractRule::findSymbolicOperator($operator)]);
                 }
             );
 
@@ -352,27 +352,27 @@ 
 
             foreach ($operands_descriptions as $i => $operands_description) {
                 if ($operands_description === false) {
-                    $operands_descriptions[ $i ] = ['and']; // FalseRule hack
+                    $operands_descriptions[$i] = ['and']; // FalseRule hack
                 }
                 elseif ($operands_description === null || $operands_description === true) {
                     $operands_description = ['and'];
-                    if ( ! $non_true_rule_descriptions) {
+                    if (!$non_true_rule_descriptions) {
                         throw new \LogicException(
                             "TrueRules are not implemented. Please add "
                             ."them to operations having other type of rules"
                         );
                     }
 
-                    unset($operands_descriptions[ $i ]);
+                    unset($operands_descriptions[$i]);
                 }
             }
 
             $remaining_operations = array_filter(
                 $operands_descriptions,
                 function($operand) {
-                    return ! is_array($operand)
-                        && ! $operand instanceof AbstractRule
-                        && ! $operand instanceof LogicalFilter
+                    return !is_array($operand)
+                        && !$operand instanceof AbstractRule
+                        && !$operand instanceof LogicalFilter
                         ;
                 }
             );
@@ -381,7 +381,7 @@ 
                 throw new \InvalidArgumentException(
                     "Mixing different operations in the same rule level not implemented: \n["
                     . implode(', ', $remaining_operations)."]\n"
-                    . 'in ' . var_export($rules_composition, true)
+                    . 'in '.var_export($rules_composition, true)
                 );
             }
 
@@ -407,7 +407,7 @@ 
                 }
             }
 
-            $recursion_position->addOperand( $rule );
+            $recursion_position->addOperand($rule);
         }
 
         return $this;
@@ -436,7 +436,7 @@ 
      */
     public function and_()
     {
-        $this->addRules( AndRule::operator, func_get_args());
+        $this->addRules(AndRule::operator, func_get_args());
         return $this;
     }
 
@@ -464,7 +464,7 @@ 
      */
     public function or_()
     {
-        $this->addRules( OrRule::operator, func_get_args());
+        $this->addRules(OrRule::operator, func_get_args());
         return $this;
     }
 
@@ -511,12 +511,12 @@ 
      * @param  array $options stop_after | stop_before |
      * @return $this
      */
-    public function simplify($options=[])
+    public function simplify($options = [])
     {
         if ($this->rules) {
             // AndRule added to make all Operation methods available
             $this->rules = (new AndRule([$this->rules]))
-                ->simplify( $options )
+                ->simplify($options)
                 // ->dump(true, false)
                 ;
         }
@@ -537,9 +537,9 @@ 
      *
      * @return bool
      */
-    public function hasSolution($save_simplification=true)
+    public function hasSolution($save_simplification = true)
     {
-        if ( ! $this->rules) {
+        if (!$this->rules) {
             return true;
         }
 
@@ -558,7 +558,7 @@ 
      *
      * @return array A description of the rules.
      */
-    public function toArray(array $options=[])
+    public function toArray(array $options = [])
     {
         return $this->rules ? $this->rules->toArray($options) : $this->rules;
     }
@@ -570,7 +570,7 @@ 
      *
      * @return array A description of the rules.
      */
-    public function toString(array $options=[])
+    public function toString(array $options = [])
     {
         return $this->rules ? $this->rules->toString($options) : $this->rules;
     }
@@ -608,7 +608,7 @@ 
      * @param  mixed $row
      * @return bool
      */
-    public function __invoke($row, $key=null)
+    public function __invoke($row, $key = null)
     {
         return $this->validates($row, $key);
     }
@@ -658,8 +658,8 @@ 
             [
                 Filterer::on_row_matches => function($rule, $key, &$rows, $matching_case) use (&$cache_flush_required) {
                     // $rule->dump();
-                    unset( $rows[$key] );
-                    if ( ! $rows ) {
+                    unset($rows[$key]);
+                    if (!$rows) {
                         throw new \Exception(
                              "Removing the only rule $rule from the filter $this "
                             ."produces a case which has no possible solution due to missing "
@@ -695,15 +695,15 @@ 
      *
      * @todo Merge with rules
      */
-    public function keepLeafRulesMatching($filter=[], array $options=[])
+    public function keepLeafRulesMatching($filter = [], array $options = [])
     {
-        $clean_empty_branches = ! isset($options['clean_empty_branches']) || $options['clean_empty_branches'];
+        $clean_empty_branches = !isset($options['clean_empty_branches']) || $options['clean_empty_branches'];
 
         $filter = (new LogicalFilter($filter, new RuleFilterer))
         // ->dump()
         ;
 
-        $options[ Filterer::leaves_only ] = true;
+        $options[Filterer::leaves_only] = true;
 
         $this->rules = (new RuleFilterer)->apply($filter, $this->rules, $options);
         // $this->rules->dump(true);
@@ -719,7 +719,7 @@ 
                 $this->rules,
                 [
                     Filterer::on_row_matches => function($rule, $key, &$rows) {
-                        unset( $rows[$key] );
+                        unset($rows[$key]);
                     },
                     Filterer::on_row_mismatches => function($rule, $key, &$rows) {
                     },
@@ -744,13 +744,13 @@ 
      *
      * @todo Merge with rules
      */
-    public function listLeafRulesMatching($filter=[])
+    public function listLeafRulesMatching($filter = [])
     {
         $filter = (new LogicalFilter($filter, new RuleFilterer))
         // ->dump()
         ;
 
-        if ( ! $this->rules) {
+        if (!$this->rules) {
             return [];
         }
 
@@ -764,9 +764,9 @@ 
                     $key,
                     array $siblings
                 ) use (&$out) {
-                    if (   ! $matching_rule instanceof AndRule
-                        && ! $matching_rule instanceof OrRule
-                        && ! $matching_rule instanceof NotRule
+                    if (!$matching_rule instanceof AndRule
+                        && !$matching_rule instanceof OrRule
+                        && !$matching_rule instanceof NotRule
                     ) {
                         $out[] = $matching_rule;
                     }
@@ -787,13 +787,13 @@ 
      *
      * @todo Make it available on AbstractRule also
      */
-    public function onEachRule($filter=[], $options)
+    public function onEachRule($filter = [], $options)
     {
         $filter = (new LogicalFilter($filter, new RuleFilterer))
         // ->dump()
         ;
 
-        if ( ! $this->rules) {
+        if (!$this->rules) {
             return [];
         }
 
@@ -818,7 +818,7 @@ 
     {
         $this->simplify(['force_logical_core' => true]);
 
-        if ( ! $this->rules) {
+        if (!$this->rules) {
             return $this;
         }
 
@@ -863,7 +863,7 @@ 
      *
      * @return LogicalFilter
      */
-    public function saveAs( &$variable )
+    public function saveAs(&$variable)
     {
         return $variable = $this;
     }
@@ -874,7 +874,7 @@ 
      *
      * @return LogicalFilter
      */
-    public function saveCopyAs( &$copied_variable )
+    public function saveCopyAs(&$copied_variable)
     {
         $copied_variable = $this->copy();
         return $this;
@@ -887,15 +887,15 @@ 
      *
      * @return $this
      */
-    public function dump($exit=false, array $options=[])
+    public function dump($exit = false, array $options = [])
     {
         $default_options = [
             'callstack_depth' => 3,
             'mode'            => 'string',
         ];
         foreach ($default_options as $default_option => &$default_value) {
-            if ( ! isset($options[ $default_option ])) {
-                $options[ $default_option ] = $default_value;
+            if (!isset($options[$default_option])) {
+                $options[$default_option] = $default_value;
             }
         }
         extract($options);
@@ -906,23 +906,23 @@ 
         else {
             // TODO dump a TrueRule
             $bt     = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, $callstack_depth);
-            $caller = $bt[ $callstack_depth - 2 ];
+            $caller = $bt[$callstack_depth - 2];
 
             // get line and file from the previous level of the caller
             // TODO go deeper if this case exist?
-            if ( ! isset($caller['file'])) {
-                $caller['file'] = $bt[ $callstack_depth - 3 ]['file'];
+            if (!isset($caller['file'])) {
+                $caller['file'] = $bt[$callstack_depth - 3]['file'];
             }
-            if ( ! isset($caller['line'])) {
-                $caller['line'] = $bt[ $callstack_depth - 3 ]['line'];
+            if (!isset($caller['line'])) {
+                $caller['line'] = $bt[$callstack_depth - 3]['line'];
             }
 
             try {
-                echo "\n" . $caller['file'] . ':' . $caller['line'] . "\n";
+                echo "\n".$caller['file'].':'.$caller['line']."\n";
                 var_export($this->toArray($options));
             }
             catch (\Exception $e) {
-                echo "\nError while dumping: " . $e->getMessage() . "\n";
+                echo "\nError while dumping: ".$e->getMessage()."\n";
                 var_export($caller);
                 echo "\n\n";
                 var_export($bt);
@@ -947,15 +947,15 @@ 
      *
      * @return mixed The filtered data
      */
-    public function applyOn($data_to_filter, $action_on_matches=null, $filterer=null)
+    public function applyOn($data_to_filter, $action_on_matches = null, $filterer = null)
     {
-        if ( ! $filterer) {
+        if (!$filterer) {
             $filterer = $this->getDefaultFilterer();
         }
         elseif (is_callable($filterer)) {
             $filterer = new CustomizableFilterer($filterer);
         }
-        elseif ( ! $filterer instanceof Filterer) {
+        elseif (!$filterer instanceof Filterer) {
             throw new \InvalidArgumentException(
                  "The given \$filterer must be null or a callable or a instance "
                 ."of Filterer instead of: ".var_export($filterer, true)
@@ -963,11 +963,11 @@ 
         }
 
         if ($data_to_filter instanceof LogicalFilter) {
-            $filtered_rules = $filterer->apply( $this, $data_to_filter->getRules() );
-            return $data_to_filter->flushRules()->addRule( $filtered_rules );
+            $filtered_rules = $filterer->apply($this, $data_to_filter->getRules());
+            return $data_to_filter->flushRules()->addRule($filtered_rules);
         }
         else {
-            return $filterer->apply( $this, $data_to_filter );
+            return $filterer->apply($this, $data_to_filter);
         }
     }
 
@@ -982,22 +982,22 @@ 
      *                                 + Null if the target has no sens (operation filtered by field for example)
      *                                 + A rule tree containing the first matching case if there is one.
      */
-    public function validates($value_to_check, $key_to_check=null, $filterer=null)
+    public function validates($value_to_check, $key_to_check = null, $filterer = null)
     {
-        if ( ! $filterer) {
+        if (!$filterer) {
             $filterer = $this->getDefaultFilterer();
         }
         elseif (is_callable($filterer)) {
             $filterer = new CustomizableFilterer($filterer);
         }
-        elseif ( ! $filterer instanceof Filterer) {
+        elseif (!$filterer instanceof Filterer) {
             throw new \InvalidArgumentException(
                  "The given \$filterer must be null or a callable or a instance "
                 ."of Filterer instead of: ".var_export($filterer, true)
             );
         }
 
-        return $filterer->hasMatchingCase( $this, $value_to_check, $key_to_check );
+        return $filterer->hasMatchingCase($this, $value_to_check, $key_to_check);
     }
 
     /**/

src/Rule/AbstractRule.php

Braces +7 added lines, -14 removed lines

@@ -144,8 +144,7 @@ 
             }
 
             echo ($this->toString($options));
-        }
-        elseif ($mode == 'dump') {
+        } elseif ($mode == 'dump') {
             if ($xdebug_enabled = ini_get('xdebug.overload_var_dump')) {
                 ini_set('xdebug.overload_var_dump', 0);
             }
@@ -155,8 +154,7 @@ 
             if ($xdebug_enabled) {
                 ini_set('xdebug.overload_var_dump', 1);
             }
-        }
-        elseif ($mode == 'xdebug') {
+        } elseif ($mode == 'xdebug') {
             if ( ! function_exists('xdebug_is_enabled')) {
                 throw new \RuntimeException("Xdebug is not installed");
             }
@@ -173,11 +171,9 @@ 
             if ($xdebug_enabled) {
                 ini_set('xdebug.overload_var_dump', 0);
             }
-        }
-        elseif ($mode == 'export') {
+        } elseif ($mode == 'export') {
             var_export($this->toArray($options));
-        }
-        else {
+        } else {
             throw new \InvalidArgumentException(
                  "'mode' option must belong to ['string', 'export', 'dump'] "
                 ."instead of " . var_export($mode, true)
@@ -288,21 +284,18 @@ 
                     $this,
                 ]),
             ]);
-        }
-        elseif ($this instanceof AndRule) {
+        } elseif ($this instanceof AndRule) {
             $ruleTree = new OrRule([
                 $this,
             ]);
-        }
-        elseif ($this instanceof OrRule) {
+        } elseif ($this instanceof OrRule) {
             foreach ($this->operands as $i => $operand) {
                 if ( ! $operand instanceof AndRule) {
                     $this->operands[$i] = new AndRule([$operand]);
                 }
             }
             $ruleTree = $this;
-        }
-        else {
+        } else {
             throw new \LogicException(
                 "Unhandled type of simplified rules provided for conversion: "
                 .$this

src/Converter/ElasticSearchMinimalConverter.php

Indentation +3 added lines, -3 removed lines

@@ -64,7 +64,7 @@ 
                 // https://www.elastic.co/guide/en/elasticsearch/guide/current/_dealing_with_null_values.html#_missing_query
                 $new_rule = [
                     'missing' => [
-                         'field' => $field,
+                            'field' => $field,
                     ],
                 ];
             }
@@ -123,7 +123,7 @@ 
             // https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html
             $new_rule = [
                 'exists' => [
-                     'field' => $field,
+                        'field' => $field,
                 ],
             ];
         }
@@ -131,7 +131,7 @@ 
             // https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html
             $new_rule = [
                 'regexp' => [
-                     $field => [
+                        $field => [
                         'value' => $operand->getPattern(),
                         // 'flags' => 'INTERSECTION|COMPLEMENT|EMPTY',
                         // 'max_determinized_states' => 2000

Braces +9 added lines, -18 removed lines

@@ -67,23 +67,20 @@ 
                          'field' => $field,
                     ],
                 ];
-            }
-            else {
+            } else {
                 $new_rule = [
                     'term' => [
                         $field => $operand->getValue(),
                     ],
                 ];
             }
-        }
-        elseif ($operator == 'in') {
+        } elseif ($operator == 'in') {
             $new_rule = [
                 'terms' => [
                     $field => $operand->getPossibilities(),
                 ],
             ];
-        }
-        elseif ($operator == '<') {
+        } elseif ($operator == '<') {
             $new_rule = [
                 'range' => [
                     $field => [
@@ -91,8 +88,7 @@ 
                     ],
                 ],
             ];
-        }
-        elseif ($operator == '>') {
+        } elseif ($operator == '>') {
             $new_rule = [
                 'range' => [
                     $field => [
@@ -100,8 +96,7 @@ 
                     ],
                 ],
             ];
-        }
-        elseif ($operator == '<=') {
+        } elseif ($operator == '<=') {
             $new_rule = [
                 'range' => [
                     $field => [
@@ -109,8 +104,7 @@ 
                     ],
                 ],
             ];
-        }
-        elseif ($operator == '>=') {
+        } elseif ($operator == '>=') {
             $new_rule = [
                 'range' => [
                     $field => [
@@ -118,16 +112,14 @@ 
                     ],
                 ],
             ];
-        }
-        elseif ($operator == '!=' && $operand->getValue() === null) {
+        } elseif ($operator == '!=' && $operand->getValue() === null) {
             // https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html
             $new_rule = [
                 'exists' => [
                      'field' => $field,
                 ],
             ];
-        }
-        elseif ($operator == 'regexp') {
+        } elseif ($operator == 'regexp') {
             // https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html
             $new_rule = [
                 'regexp' => [
@@ -138,8 +130,7 @@ 
                     ],
                 ],
             ];
-        }
-        else {
+        } else {
             throw new \InvalidArgumentException(
                 "Unhandled operator '$operator' during ES query generation"
             );