jclaveau / php-logical-filter

src/LogicalFilter.php

Doc Comments +7 added lines, -9 removed lines

@@ -535,7 +535,7 @@ 
      *
      * This helpes to ease the result of simplify()
      *
-     * @return OrRule
+     * @return LogicalFilter
      */
     public function addMinimalCase()
     {
@@ -590,7 +590,7 @@ 
      *
      * @param $debug Provides a source oriented dump.
      *
-     * @return array A description of the rules.
+     * @return string A description of the rules.
      */
     public function toString(array $options=[])
     {
@@ -668,7 +668,7 @@ 
      * @param  array|callable Associative array of renamings or callable
      *                        that would rename the fields.
      *
-     * @return string $this
+     * @return LogicalFilter $this
      */
     public function removeRules($filter)
     {
@@ -711,8 +711,8 @@ 
      * @param  array|callable Associative array of renamings or callable
      *                        that would rename the fields.
      *
-     * @return array The rules matching the filter
-     * @return array $options debug | leaves_only | clean_empty_branches
+     * @return LogicalFilter The rules matching the filter
+     * @return LogicalFilter $options debug | leaves_only | clean_empty_branches
      *
      *
      * @todo Merge with rules
@@ -823,6 +823,7 @@ 
      * @param  array|LogicalFilter
      * @param  array|callable Associative array of renamings or callable
      *                        that would rename the fields.
+     * @param \Closure $options
      *
      * @return array          The rules matching the filter
      */
@@ -887,7 +888,6 @@ 
      * Retrieves the minimum possibility and the maximum possibility for
      * the given field.
      *
-     * @param  array|LogicalFilter|AbstractRule $filter
      * @return array The bounds of the range and a nullable
      */
     public function getRanges($ruleFilter=null)
@@ -1005,7 +1005,6 @@ 
     }
 
     /**
-     * @param bool  $exit=false
      * @param array $options    + callstack_depth=2 The level of the caller to dump
      *                          + mode='string' in 'export' | 'dump' | 'string'
      *
@@ -1100,10 +1099,9 @@ 
      * Applies the current instance to a value (and its index optionnally).
      *
      * @param  mixed                  $value_to_check
-     * @param  scalar                 $index
      * @param  Filterer|callable|null $filterer
      *
-     * @return AbstractRule|false|true + False if the filter doesn't validates
+     * @return boolean + False if the filter doesn't validates
      *                                 + 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.
      */

Spacing +80 added lines, -80 removed lines

@@ -51,7 +51,7 @@ 
      *
      * @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();
@@ -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();
         }
 
@@ -161,7 +161,7 @@ 
             }
         }
 
-        if (   3 == count($rules_description)
+        if (3 == count($rules_description)
             && 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 (null !== $rules) {
-                    $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 (1 == count($rules_description) && 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 {
@@ -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 ( 3 == count($rules_composition)
-            && ! 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 (3 == count($rules_composition)
+            && ! 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 (   NotRule::operator == $rules_composition[0]
-                || $rules_composition[0] == AbstractRule::findSymbolicOperator( NotRule::operator ) ) {
+            if (NotRule::operator == $rules_composition[0]
+                || $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,7 +352,7 @@ 
 
             foreach ($operands_descriptions as $i => $operands_description) {
                 if (false === $operands_description) {
-                    $operands_descriptions[ $i ] = ['and']; // FalseRule hack
+                    $operands_descriptions[$i] = ['and']; // FalseRule hack
                 }
                 elseif (null === $operands_description || true === $operands_description) {
                     $operands_description = ['and'];
@@ -363,7 +363,7 @@ 
                         );
                     }
 
-                    unset($operands_descriptions[ $i ]);
+                    unset($operands_descriptions[$i]);
                 }
             }
 
@@ -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)
                 ;
         }
@@ -559,9 +559,9 @@ 
      *
      * @return bool
      */
-    public function hasSolution($save_simplification=true)
+    public function hasSolution($save_simplification = true)
     {
-        if (! $this->rules) {
+        if ( ! $this->rules) {
             return true;
         }
 
@@ -580,7 +580,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;
     }
@@ -592,7 +592,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;
     }
@@ -630,7 +630,7 @@ 
      * @param  mixed $row
      * @return bool
      */
-    public function __invoke($row, $key=null)
+    public function __invoke($row, $key = null)
     {
         return $this->validates($row, $key);
     }
@@ -680,8 +680,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 "
@@ -717,7 +717,7 @@ 
      *
      * @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'];
 
@@ -725,7 +725,7 @@ 
         // ->dump()
         ;
 
-        $options[ Filterer::leaves_only ] = true;
+        $options[Filterer::leaves_only] = true;
 
         $this->rules = (new RuleFilterer)->apply($filter, $this->rules, $options);
         // $this->rules->dump(true);
@@ -765,13 +765,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 [];
         }
 
@@ -785,7 +785,7 @@ 
                     $key,
                     array $siblings
                 ) use (&$out) {
-                    if (   ! $matching_rule instanceof AndRule
+                    if ( ! $matching_rule instanceof AndRule
                         && ! $matching_rule instanceof OrRule
                         && ! $matching_rule instanceof NotRule
                     ) {
@@ -826,13 +826,13 @@ 
      *
      * @return array          The rules matching the filter
      */
-    public function onEachRule($filter=[], $options)
+    public function onEachRule($filter = [], $options)
     {
         $filter = (new LogicalFilter($filter, new RuleFilterer))
         // ->dump()
         ;
 
-        if (! $this->rules) {
+        if ( ! $this->rules) {
             return [];
         }
 
@@ -865,7 +865,7 @@ 
     {
         $this->simplify()->addMinimalCase();
 
-        if (! $this->rules) {
+        if ( ! $this->rules) {
             return $this;
         }
 
@@ -890,11 +890,11 @@ 
      * @param  array|LogicalFilter|AbstractRule $filter
      * @return array The bounds of the range and a nullable
      */
-    public function getRanges($ruleFilter=null)
+    public function getRanges($ruleFilter = null)
     {
         $ranges = [];
 
-        $this->onEachCase(function (AndRule $and_rule) use (&$ranges, $ruleFilter) {
+        $this->onEachCase(function(AndRule $and_rule) use (&$ranges, $ruleFilter) {
             (new self($and_rule))->onEachRule(
                 ['and',
                     $ruleFilter,
@@ -903,12 +903,12 @@ 
                         '><', '><=', '=><=', '=><',
                     ]],
                 ],
-                function ($rule) use (&$ranges) {
+                function($rule) use (&$ranges) {
 
                     $field = $rule->getField();
 
-                    $range = isset($ranges[ $field ])
-                           ? $ranges[ $field ]
+                    $range = isset($ranges[$field])
+                           ? $ranges[$field]
                            : ['min' => [], 'max' => [], 'nullable' => false];
 
                     if ($rule::operator == '=') {
@@ -936,7 +936,7 @@ 
                         );
                     }
 
-                    $ranges[ $field ] = $range;
+                    $ranges[$field] = $range;
                 }
             );
         });
@@ -958,7 +958,7 @@ 
      */
     public function getFieldRange($field)
     {
-        return reset( $this->getRanges(['field', '=', $field]) );
+        return reset($this->getRanges(['field', '=', $field]));
     }
 
     /**
@@ -987,7 +987,7 @@ 
      *
      * @return LogicalFilter
      */
-    public function saveAs( &$variable)
+    public function saveAs(&$variable)
     {
         return $variable = $this;
     }
@@ -998,7 +998,7 @@ 
      *
      * @return LogicalFilter
      */
-    public function saveCopyAs( &$copied_variable)
+    public function saveCopyAs(&$copied_variable)
     {
         $copied_variable = $this->copy();
         return $this;
@@ -1011,15 +1011,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);
@@ -1030,24 +1030,24 @@ 
         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);
@@ -1072,15 +1072,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)
@@ -1088,8 +1088,8 @@ 
         }
 
         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);
@@ -1107,15 +1107,15 @@ 
      *                                 + 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)