jclaveau / php-logical-filter

src/LogicalFilter.php

Doc Comments +5 added lines, -7 removed lines

@@ -568,7 +568,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=[])
     {
@@ -646,7 +646,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)
     {
@@ -689,8 +689,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
@@ -880,7 +880,6 @@ 
     }
 
     /**
-     * @param bool  $exit=false
      * @param array $options    + callstack_depth=2 The level of the caller to dump
      *                          + mode='string' in 'export' | 'dump' | 'string'
      *
@@ -974,10 +973,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.
      */