jclaveau / php-chainable-array

src/ChainableArray_Utils_Trait.php

Spacing +64 added lines, -64 removed lines

@@ -18,7 +18,7 @@ 
      *
      * @return array The array containing the grouped rows.
      */
-    public function groupBy( callable $indexGenerator, callable $conflictResolver=null )
+    public function groupBy(callable $indexGenerator, callable $conflictResolver = null)
     {
         // todo : this doesn't work
         // return $this->groupByTransformed($indexGenerator, null, $conflictResolver);
@@ -26,15 +26,15 @@ 
         $out = [];
         foreach ($this->data as $key => $row) {
 
-            if (!$row)
+            if ( ! $row)
                 continue;
 
             $newIndexes     = call_user_func($indexGenerator, $key, $row);
-            if (!is_array($newIndexes))
+            if ( ! is_array($newIndexes))
                 $newIndexes = [$newIndexes];
 
             foreach ($newIndexes as $newIndex) {
-                if (!isset($out[$newIndex])) {
+                if ( ! isset($out[$newIndex])) {
                     $out[$newIndex] = $row;
                 }
                 else {
@@ -69,26 +69,26 @@ 
      *
      * @return array The array containing the grouped rows.
      */
-    public function groupInArrays( callable $indexGenerator )
+    public function groupInArrays(callable $indexGenerator)
     {
         $out = [];
         foreach ($this->data as $key => $row) {
 
-            if (!$row)
+            if ( ! $row)
                 continue;
 
             $new_keys = call_user_func($indexGenerator, $row, $key);
-            if (!is_array($new_keys))
+            if ( ! is_array($new_keys))
                 $new_keys = [$new_keys];
 
             foreach ($new_keys as $new_key) {
-                if (!isset($out[ $new_key ])) {
-                    $out[ $new_key ] = [
+                if ( ! isset($out[$new_key])) {
+                    $out[$new_key] = [
                         $key => $row
                     ];
                 }
                 else {
-                    $out[ $new_key ][ $key ] = $row;
+                    $out[$new_key][$key] = $row;
                 }
             }
         }
@@ -111,13 +111,13 @@ 
     public static function mergeRecursiveCustom(
         array $existing_row,
         array $conflict_row,
-        callable $merge_resolver=null,
-        $max_depth=null
-    ){
+        callable $merge_resolver = null,
+        $max_depth = null
+    ) {
         foreach ($conflict_row as $column => $conflict_value) {
 
             // not existing in first array
-            if (!isset($existing_row[$column])) {
+            if ( ! isset($existing_row[$column])) {
                 $existing_row[$column] = $conflict_value;
                 continue;
             }
@@ -150,7 +150,7 @@ 
             }
             else {
                 // same reslution as array_merge_recursive
-                if (!is_array($existing_value)) {
+                if ( ! is_array($existing_value)) {
                     $existing_row[$column] = [$existing_value];
                 }
 
@@ -173,13 +173,13 @@ 
     public static function mergePreservingDistincts(
         array $existing_row,
         array $conflict_row
-    ){
+    ) {
         return static::mergeRecursiveCustom(
             $existing_row,
             $conflict_row,
-            function ($existing_value, $conflict_value, $column) {
+            function($existing_value, $conflict_value, $column) {
 
-                if (!is_array($existing_value))
+                if ( ! is_array($existing_value))
                     $existing_value = [$existing_value];
 
                 // We store the new value with their previous ones
@@ -204,10 +204,10 @@ 
      *
      * @see mergePreservingDistincts()
      */
-    public static function keepUniqueColumnValues(array $row, array $excluded_columns=[])
+    public static function keepUniqueColumnValues(array $row, array $excluded_columns = [])
     {
         foreach ($row as $column => &$values) {
-            if (!is_array($values))
+            if ( ! is_array($values))
                 continue;
 
             if (in_array($column, $excluded_columns))
@@ -237,7 +237,7 @@ 
      */
     public function groupByTransformed(
         callable $indexGenerator,
-        callable $rowTransformer,      // todo check this behavior
+        callable $rowTransformer, // todo check this behavior
         callable $conflictResolver )
     {
         // The goal here is to remove the second parameter has it makes the
@@ -250,7 +250,7 @@ 
         $out = [];
         foreach ($this->data as $key => $row) {
 
-            if (!$row)
+            if ( ! $row)
                 continue;
 
             $newIndex       = call_user_func($indexGenerator, $key, $row);
@@ -259,7 +259,7 @@ 
                             ? call_user_func($rowTransformer, $row)
                             : $row;
 
-            if (!isset($out[$newIndex])) {
+            if ( ! isset($out[$newIndex])) {
                 $out[$newIndex] = $transformedRow;
             }
             else {
@@ -284,12 +284,12 @@ 
      *                                       rows have the same index.
      * @return static
      */
-    public function mergeWith( $otherTable, callable $conflictResolver=null )
+    public function mergeWith($otherTable, callable $conflictResolver = null)
     {
         if (is_array($otherTable))
             $otherTable = new static($otherTable);
 
-        if (!$otherTable instanceof static) {
+        if ( ! $otherTable instanceof static) {
             self::throwUsageException(
                 '$otherTable must be an array or an instance of '.static::class.' instead of: '
                 .var_export($otherTable, true)
@@ -299,7 +299,7 @@ 
         $out = $this->data;
         foreach ($otherTable->getArray() as $key => $row) {
 
-            if (!isset($out[$key])) {
+            if ( ! isset($out[$key])) {
                 $out[$key] = $row;
             }
             else {
@@ -327,7 +327,7 @@ 
      * (same as self::mergeWith with the other table as $this)
      * @return static
      */
-    public function mergeIn( $otherTable, callable $conflictResolver=null )
+    public function mergeIn($otherTable, callable $conflictResolver = null)
     {
         $otherTable->mergeWith($this, $conflictResolver);
         return $this;
@@ -353,7 +353,7 @@ 
      */
     public function each(callable $rowTransformer)
     {
-        $out  = [];
+        $out = [];
         foreach ($this->data as $key => $row) {
             $out[$key] = call_user_func_array(
                 $rowTransformer,
@@ -383,7 +383,7 @@ 
      */
     public function renameColumns(array $old_to_new_names)
     {
-        $out  = [];
+        $out = [];
         foreach ($this->data as $key => $row) {
             try {
                 foreach ($old_to_new_names as $old_name => $new_name) {
@@ -392,7 +392,7 @@ 
                 }
             }
             catch (\Exception $e) {
-                self::throwUsageException( $e->getMessage() );
+                self::throwUsageException($e->getMessage());
             }
 
             $out[$key] = $row;
@@ -444,20 +444,20 @@ 
      *                            nor a static.
      * @return static       $this
      */
-    public function append($new_rows, callable $conflict_resolver=null)
+    public function append($new_rows, callable $conflict_resolver = null)
     {
         if ($new_rows instanceof static)
             $new_rows = $new_rows->getArray();
 
-        if (!is_array($new_rows)) {
+        if ( ! is_array($new_rows)) {
             $this->throwUsageException(
-                "\$new_rows parameter must be an array or an instance of " . __CLASS__
+                "\$new_rows parameter must be an array or an instance of ".__CLASS__
             );
         }
 
-        if (!$conflict_resolver) {
+        if ( ! $conflict_resolver) {
             // default conflict resolver: append with numeric key
-            $conflict_resolver = function (&$data, $existing_row, $confliuct_row, $key) {
+            $conflict_resolver = function(&$data, $existing_row, $confliuct_row, $key) {
                 $data[] = $confliuct_row;
             };
         }
@@ -489,7 +489,7 @@ 
      *
      * @return static
      */
-    public function dimensionsAsColumns(array $columnNames, array $options=null)
+    public function dimensionsAsColumns(array $columnNames, array $options = null)
     {
         $out = $this->dimensionsAsColumns_recurser($this->data, $columnNames);
         return $this->returnConstant($out);
@@ -526,12 +526,12 @@ 
      *      ],
      * ]
      */
-    protected function dimensionsAsColumns_recurser(array $data, $columnNames, $rowIdParts=[])
+    protected function dimensionsAsColumns_recurser(array $data, $columnNames, $rowIdParts = [])
     {
         $out = [];
         // if (!$columnNames)
             // return $data;
-        $no_more_column = !(bool) $columnNames;
+        $no_more_column = ! (bool) $columnNames;
 
         // If all the names have been given to the dimensions
         // we compile the index key of the row at the current level
@@ -555,7 +555,7 @@ 
                     self::throwUsageException(
                          "Trying to populate a column '$name' that "
                         ."already exists with a different value "
-                        .var_export($data[$name], true). " => '$value'"
+                        .var_export($data[$name], true)." => '$value'"
                     );
                 }
                 $data[$name] = $value;
@@ -586,7 +586,7 @@ 
             }
             else {
 
-                if (!isset($rows)) {
+                if ( ! isset($rows)) {
                     echo json_encode([
                         '$rowIdParts' => $rowIdParts,
                         '$row' => $row,
@@ -645,12 +645,12 @@ 
 
             if (is_string($value) && array_key_exists($value, $row)) {
                 $part_name  .= $value;
-                $group_value = $row[ $value ];
+                $group_value = $row[$value];
             }
             elseif (is_callable($value)) {
 
                 if (is_string($value)) {
-                    $part_name  .= $value;
+                    $part_name .= $value;
                 }
                 // elseif (is_function($value)) {
                 elseif (is_object($value) && ($value instanceof Closure)) {
@@ -666,19 +666,19 @@ 
                 ]);
             }
             elseif (is_int($value)) {
-                $part_name  .= $value ? : '0';
-                $group_value = $row[ $value ];
+                $part_name  .= $value ?: '0';
+                $group_value = $row[$value];
             }
             else {
                 self::throwUsageException(
                     'Bad value provided for groupBy id generation: '
                     .var_export($value, true)
-                    ."\n" . var_export($row, true)
+                    ."\n".var_export($row, true)
                 );
             }
 
-            if (!is_null($part_name))
-                $group_parts[ $part_name ] = $group_value;
+            if ( ! is_null($part_name))
+                $group_parts[$part_name] = $group_value;
         }
 
         // sort the groups by names (without it the same group could have multiple ids)
@@ -696,9 +696,9 @@ 
     /**
      * Returns the first element of the array
      */
-    public function first($strict=false)
+    public function first($strict = false)
     {
-        if (!$this->count()) {
+        if ( ! $this->count()) {
             if ($strict)
                 throw new \ErrorException("No first element found in this array");
             else
@@ -718,9 +718,9 @@ 
      *
      * @todo Preserve the offset
      */
-    public function last($strict=false)
+    public function last($strict = false)
     {
-        if (!$this->count()) {
+        if ( ! $this->count()) {
             if ($strict)
                 throw new \ErrorException("No last element found in this array");
             else
@@ -738,9 +738,9 @@ 
     /**
      *
      */
-    public function firstKey($strict=false)
+    public function firstKey($strict = false)
     {
-        if (!$this->count()) {
+        if ( ! $this->count()) {
             if ($strict)
                 throw new \ErrorException("No last element found in this array");
             else
@@ -759,16 +759,16 @@ 
     /**
      *
      */
-    public function lastKey($strict=false)
+    public function lastKey($strict = false)
     {
-        if (!$this->count()) {
+        if ( ! $this->count()) {
             if ($strict)
                 throw new \ErrorException("No last element found in this array");
             else
                 $lastKey = null;
         }
         else {
-            $key  = key($this->data);
+            $key = key($this->data);
             end($this->data);
             $lastKey = key($this->data);
             $this->move($key);
@@ -780,7 +780,7 @@ 
     /**
      * Move the internal pointer of the array to the key given as parameter
      */
-    public function move($key, $strict=true)
+    public function move($key, $strict = true)
     {
         if (array_key_exists($key, $this->data)) {
             foreach ($this->data as $i => &$value) {
@@ -847,13 +847,13 @@ 
      * @see http://php.net/manual/fr/function.var-dump.php
      * @todo Handle xdebug dump formatting
      */
-    public function dump($exit=false)
+    public function dump($exit = false)
     {
         $bt = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
         $caller = $bt[0];
 
         var_export([
-            'location' => $caller['file'] . ':' . $caller['line'],
+            'location' => $caller['file'].':'.$caller['line'],
             'data'     => $this->data,
         ]);
 
@@ -870,7 +870,7 @@ 
      * @todo move it to an Arrays class storing static methods
      */
     public static function replaceEntries(
-        array $array, callable $replacer, $max_depth=null
+        array $array, callable $replacer, $max_depth = null
     ) {
         foreach ($array as $key => &$row) {
             $arguments = [&$row, $key];
@@ -878,7 +878,7 @@ 
 
             if (is_array($row) && $max_depth !== 0) { // allowing null to have no depth limit
                 $row = self::replaceEntries(
-                    $row, $replacer, $max_depth ? $max_depth-1 : $max_depth
+                    $row, $replacer, $max_depth ? $max_depth - 1 : $max_depth
                 );
             }
         }
@@ -894,7 +894,7 @@ 
      *
      * @return static $this or a new static.
      */
-    public function extract($callback=null)
+    public function extract($callback = null)
     {
         if ($callback) {
 
@@ -902,7 +902,7 @@ 
                 $callback = new \JClaveau\LogicalFilter\LogicalFilter($callback);
             }
 
-            if (!is_callable($callback)) {
+            if ( ! is_callable($callback)) {
                 $this->throwUsageException(
                     "\$callback must be a logical filter description array or a callable"
                     ." instead of "
@@ -914,7 +914,7 @@ 
             foreach ($this->data as $key => $value) {
                 if ($callback($value, $key)) {
                     $out[$key] = $value;
-                    unset( $this->data[$key] );
+                    unset($this->data[$key]);
                 }
             }
         }

Braces +90 added lines, -86 removed lines

@@ -26,18 +26,19 @@ 
         $out = [];
         foreach ($this->data as $key => $row) {
 
-            if (!$row)
-                continue;
+            if (!$row) {
+                            continue;
+            }
 
             $newIndexes     = call_user_func($indexGenerator, $key, $row);
-            if (!is_array($newIndexes))
-                $newIndexes = [$newIndexes];
+            if (!is_array($newIndexes)) {
+                            $newIndexes = [$newIndexes];
+            }
 
             foreach ($newIndexes as $newIndex) {
                 if (!isset($out[$newIndex])) {
                     $out[$newIndex] = $row;
-                }
-                else {
+                } else {
                     if ($conflictResolver === null) {
                         self::throwUsageException(
                             "A 'group by' provoking a conflict"
@@ -74,20 +75,21 @@ 
         $out = [];
         foreach ($this->data as $key => $row) {
 
-            if (!$row)
-                continue;
+            if (!$row) {
+                            continue;
+            }
 
             $new_keys = call_user_func($indexGenerator, $row, $key);
-            if (!is_array($new_keys))
-                $new_keys = [$new_keys];
+            if (!is_array($new_keys)) {
+                            $new_keys = [$new_keys];
+            }
 
             foreach ($new_keys as $new_key) {
                 if (!isset($out[ $new_key ])) {
                     $out[ $new_key ] = [
                         $key => $row
                     ];
-                }
-                else {
+                } else {
                     $out[ $new_key ][ $key ] = $row;
                 }
             }
@@ -147,8 +149,7 @@ 
                         $column,
                     ]
                 );
-            }
-            else {
+            } else {
                 // same reslution as array_merge_recursive
                 if (!is_array($existing_value)) {
                     $existing_row[$column] = [$existing_value];
@@ -179,8 +180,9 @@ 
             $conflict_row,
             function ($existing_value, $conflict_value, $column) {
 
-                if (!is_array($existing_value))
-                    $existing_value = [$existing_value];
+                if (!is_array($existing_value)) {
+                                    $existing_value = [$existing_value];
+                }
 
                 // We store the new value with their previous ones
                 if ( ! is_array($conflict_value)) {
@@ -207,15 +209,18 @@ 
     public static function keepUniqueColumnValues(array $row, array $excluded_columns=[])
     {
         foreach ($row as $column => &$values) {
-            if (!is_array($values))
-                continue;
+            if (!is_array($values)) {
+                            continue;
+            }
 
-            if (in_array($column, $excluded_columns))
-                continue;
+            if (in_array($column, $excluded_columns)) {
+                            continue;
+            }
 
             $values = array_unique($values);
-            if (count($values) == 1)
-                $values = $values[0];
+            if (count($values) == 1) {
+                            $values = $values[0];
+            }
         }
 
         return $row;
@@ -250,8 +255,9 @@ 
         $out = [];
         foreach ($this->data as $key => $row) {
 
-            if (!$row)
-                continue;
+            if (!$row) {
+                            continue;
+            }
 
             $newIndex       = call_user_func($indexGenerator, $key, $row);
 
@@ -261,8 +267,7 @@ 
 
             if (!isset($out[$newIndex])) {
                 $out[$newIndex] = $transformedRow;
-            }
-            else {
+            } else {
                 $out[$newIndex] = call_user_func(
                     $conflictResolver,
                     $newIndex,
@@ -286,8 +291,9 @@ 
      */
     public function mergeWith( $otherTable, callable $conflictResolver=null )
     {
-        if (is_array($otherTable))
-            $otherTable = new static($otherTable);
+        if (is_array($otherTable)) {
+                    $otherTable = new static($otherTable);
+        }
 
         if (!$otherTable instanceof static) {
             self::throwUsageException(
@@ -301,10 +307,10 @@ 
 
             if (!isset($out[$key])) {
                 $out[$key] = $row;
-            }
-            else {
-                if ($conflictResolver === null)
-                    self::throwUsageException('No conflict resolver for a merge provoking one');
+            } else {
+                if ($conflictResolver === null) {
+                                    self::throwUsageException('No conflict resolver for a merge provoking one');
+                }
 
                 $arguments = [
                     &$key,
@@ -390,8 +396,7 @@ 
                     $row[$new_name] = $row[$old_name];
                     unset($row[$old_name]);
                 }
-            }
-            catch (\Exception $e) {
+            } catch (\Exception $e) {
                 self::throwUsageException( $e->getMessage() );
             }
 
@@ -412,17 +417,19 @@ 
     public function limit()
     {
         $arguments = func_get_args();
-        if (count($arguments) == 1 && is_numeric($arguments[0]))
-            $max = $arguments[0];
-        else
-            self::throwUsageException("Bad arguments type and count for limit()");
+        if (count($arguments) == 1 && is_numeric($arguments[0])) {
+                    $max = $arguments[0];
+        } else {
+                    self::throwUsageException("Bad arguments type and count for limit()");
+        }
 
         $out   = [];
         $count = 0;
         foreach ($this->data as $key => $row) {
 
-            if ($max <= $count)
-                break;
+            if ($max <= $count) {
+                            break;
+            }
 
             $out[$key] = $row;
 
@@ -446,8 +453,9 @@ 
      */
     public function append($new_rows, callable $conflict_resolver=null)
     {
-        if ($new_rows instanceof static)
-            $new_rows = $new_rows->getArray();
+        if ($new_rows instanceof static) {
+                    $new_rows = $new_rows->getArray();
+        }
 
         if (!is_array($new_rows)) {
             $this->throwUsageException(
@@ -472,8 +480,7 @@ 
                 ];
 
                 call_user_func_array($conflict_resolver, $arguments);
-            }
-            else {
+            } else {
                 $this->data[$key] = $new_row;
             }
         }
@@ -583,8 +590,7 @@ 
                 foreach ($rows as $row_id => $joined_row) {
                     $out[$row_id] = $joined_row;
                 }
-            }
-            else {
+            } else {
 
                 if (!isset($rows)) {
                     echo json_encode([
@@ -594,8 +600,9 @@ 
                     exit;
                 }
 
-                foreach ($rowIdParts as $rowIdPartName => $rowIdPartValue)
-                    $row[$rowIdPartName] = $rowIdPartValue;
+                foreach ($rowIdParts as $rowIdPartName => $rowIdPartValue) {
+                                    $row[$rowIdPartName] = $rowIdPartValue;
+                }
 
                 $indexParts = [];
                 foreach ($rowIdParts as $name => $value) {
@@ -646,8 +653,7 @@ 
             if (is_string($value) && array_key_exists($value, $row)) {
                 $part_name  .= $value;
                 $group_value = $row[ $value ];
-            }
-            elseif (is_callable($value)) {
+            } elseif (is_callable($value)) {
 
                 if (is_string($value)) {
                     $part_name  .= $value;
@@ -656,20 +662,17 @@ 
                 elseif (is_object($value) && ($value instanceof Closure)) {
                     $part_name .= 'unnamed-closure-'
                                 . hash('crc32b', var_export($value, true));
-                }
-                elseif (is_array($value)) {
+                } elseif (is_array($value)) {
                     $part_name .= implode('::', $value);
                 }
 
                 $group_value = call_user_func_array($value, [
                     $row, &$part_name
                 ]);
-            }
-            elseif (is_int($value)) {
+            } elseif (is_int($value)) {
                 $part_name  .= $value ? : '0';
                 $group_value = $row[ $value ];
-            }
-            else {
+            } else {
                 self::throwUsageException(
                     'Bad value provided for groupBy id generation: '
                     .var_export($value, true)
@@ -677,8 +680,9 @@ 
                 );
             }
 
-            if (!is_null($part_name))
-                $group_parts[ $part_name ] = $group_value;
+            if (!is_null($part_name)) {
+                            $group_parts[ $part_name ] = $group_value;
+            }
         }
 
         // sort the groups by names (without it the same group could have multiple ids)
@@ -699,12 +703,12 @@ 
     public function first($strict=false)
     {
         if (!$this->count()) {
-            if ($strict)
-                throw new \ErrorException("No first element found in this array");
-            else
-                $first = null;
-        }
-        else {
+            if ($strict) {
+                            throw new \ErrorException("No first element found in this array");
+            } else {
+                            $first = null;
+            }
+        } else {
             $key   = key($this->data);
             $first = reset($this->data);
             $this->move($key);
@@ -721,12 +725,12 @@ 
     public function last($strict=false)
     {
         if (!$this->count()) {
-            if ($strict)
-                throw new \ErrorException("No last element found in this array");
-            else
-                $last = null;
-        }
-        else {
+            if ($strict) {
+                            throw new \ErrorException("No last element found in this array");
+            } else {
+                            $last = null;
+            }
+        } else {
             $key  = key($this->data);
             $last = end($this->data);
             $this->move($key);
@@ -741,12 +745,12 @@ 
     public function firstKey($strict=false)
     {
         if (!$this->count()) {
-            if ($strict)
-                throw new \ErrorException("No last element found in this array");
-            else
-                $firstKey = null;
-        }
-        else {
+            if ($strict) {
+                            throw new \ErrorException("No last element found in this array");
+            } else {
+                            $firstKey = null;
+            }
+        } else {
             $key      = key($this->data);
             reset($this->data);
             $firstKey = key($this->data);
@@ -762,12 +766,12 @@ 
     public function lastKey($strict=false)
     {
         if (!$this->count()) {
-            if ($strict)
-                throw new \ErrorException("No last element found in this array");
-            else
-                $lastKey = null;
-        }
-        else {
+            if ($strict) {
+                            throw new \ErrorException("No last element found in this array");
+            } else {
+                            $lastKey = null;
+            }
+        } else {
             $key  = key($this->data);
             end($this->data);
             $lastKey = key($this->data);
@@ -789,8 +793,7 @@ 
                     break;
                 }
             }
-        }
-        elseif ($strict) {
+        } elseif ($strict) {
             throw new \ErrorException("Unable to move the internal pointer to a key that doesn't exist.");
         }
 
@@ -857,8 +860,9 @@ 
             'data'     => $this->data,
         ]);
 
-        if ($exit)
-            exit;
+        if ($exit) {
+                    exit;
+        }
 
         return $this;
     }