mblarsen / arrgh

src/Arrgh.php

Doc Comments +9 added lines, -1 removed lines

@@ -204,6 +204,10 @@ 
     }
 
     /* Wraps a callable with the purpose of fixing bad PHP sort implementations */
+
+    /**
+     * @param Closure $callable
+     */
     private static function wrapCallable($callable)
     {
         $direction = Arrgh::getSortDirection();
@@ -215,6 +219,10 @@ 
     }
 
     /* Transforms the incoming calls to native calls */
+
+    /**
+     * @param Arrgh $object
+     */
     private static function invoke($method, $args, $object = null)
     {
         self::getSortDirection();
@@ -651,7 +659,7 @@ 
      * Partion the input based on the result of the callback function.
      *
      * @param array    $array    A collection
-     * @param Closeure $callable A callable returning true or false depending on which way to partion the element—left or right.
+     * @param Closure $callable A callable returning true or false depending on which way to partion the element—left or right.
      * @return array An array with two arrays—left and right: [left, right]
      */
     private static function arrgh_partition($array, $callable)

Spacing +24 added lines, -24 removed lines

@@ -61,7 +61,7 @@ 
     /* Returns an array */
     public function toArray()
     {
-        $array = array_map(function ($item) {
+        $array = array_map(function($item) {
             if ($item instanceof Arrgh) {
                 return $item->toArray();
             }
@@ -207,7 +207,7 @@ 
     private static function wrapCallable($callable)
     {
         $direction = Arrgh::getSortDirection();
-        return function ($a, $b) use ($direction, $callable) {
+        return function($a, $b) use ($direction, $callable) {
             $result = $callable($a, $b);
             if ($result === 0) return $direction;
             return $result;
@@ -223,7 +223,7 @@ 
         $function_name = $snake;
         $function_name_prefixed = stripos($method, "array_") === 0 ? $snake : "array_" . $snake;
 
-        $all_function_names = [ $function_name, $function_name_prefixed ];
+        $all_function_names = [$function_name, $function_name_prefixed];
         $all_functions      = self::allFunctions();
 
         $matching_handler = null;
@@ -246,7 +246,7 @@ 
         // asort in PHP5 reverses equals ("arsort" doen't mess up for some reason)
         if ($matching_function === "asort") {
             $matching_function = "uasort";
-            array_push($args, function ($a, $b) { return strcasecmp($a, $b); });
+            array_push($args, function($a, $b) { return strcasecmp($a, $b); });
         }
 
         // Native array_column filters away null values. That means you cannot
@@ -260,15 +260,15 @@ 
             $column_key   = $args[1];
             if (count($args) === 3) {
                 $column_id = $args[2];
-                $column_ids_new = array_map(function ($item) use ($column_id) {
+                $column_ids_new = array_map(function($item) use ($column_id) {
                     return isset($item[$column_id]) ? $item[$column_id] : null;
                 }, $column_array);
-                $post_handler = function ($result) use ($column_ids_new) {
+                $post_handler = function($result) use ($column_ids_new) {
                     return array_combine($column_ids_new, $result);
                 };
             }
             $args = [$column_array];
-            array_push($args, function ($item) use ($column_key) {
+            array_push($args, function($item) use ($column_key) {
                 return isset($item[$column_key]) ? $item[$column_key] : null;
             });
         }
@@ -280,7 +280,7 @@ 
 
         // If some arrays are Arrghs map to array or if callable, wrap it in new callable with
         // info about sort direction.
-        $args = array_map(function ($arg) use ($matching_function) {
+        $args = array_map(function($arg) use ($matching_function) {
             if ($arg instanceof Arrgh) {
                 return $arg->array;
             } else if ($arg instanceof Closure) {
@@ -407,14 +407,14 @@ 
             return $array;
         }
 
-        $column = array_map(function ($item) use ($key) { return isset($item[$key]) ? $item[$key] : null; }, $array);
+        $column = array_map(function($item) use ($key) { return isset($item[$key]) ? $item[$key] : null; }, $array);
         array_multisort($column, ($direction_int === 1 ? SORT_ASC : SORT_DESC), $array);
         return $array;
     }
 
     private static function arrgh_collapse($array)
     {
-        return array_reduce($array, function ($merged, $item) {
+        return array_reduce($array, function($merged, $item) {
             if (is_array($item)) {
                 return array_merge($merged, $item);
             }
@@ -429,7 +429,7 @@ 
         if ($key) {
             $haystack = array_column($array, $key);
         } else {
-            $haystack = array_reduce($array, function ($merged, $item) {
+            $haystack = array_reduce($array, function($merged, $item) {
                 return array_merge($merged, array_values($item));
             }, []);
         }
@@ -439,13 +439,13 @@ 
     private static function arrgh_except($array, $except)
     {
         if (is_string($except)) {
-            $except = [ $except ];
+            $except = [$except];
         }
 
         $is_collection = Arrgh::arrgh_is_collection($array);
-        $array = $is_collection ? $array : [ $array ];
+        $array = $is_collection ? $array : [$array];
 
-        $result = array_map(function ($item) use ($except) {
+        $result = array_map(function($item) use ($except) {
             foreach ($except as $key) {
                 unset($item[$key]);
             }
@@ -461,13 +461,13 @@ 
     private static function arrgh_only($array, $only)
     {
         if (is_string($only)) {
-            $only = [ $only ];
+            $only = [$only];
         }
 
         $is_collection = Arrgh::arrgh_is_collection($array);
-        $array = $is_collection ? $array : [ $array ];
+        $array = $is_collection ? $array : [$array];
 
-        $result = array_map(function ($item) use ($only) {
+        $result = array_map(function($item) use ($only) {
             foreach ($item as $key => $value) {
                 if (!in_array($key, $only)) {
                     unset($item[$key]);
@@ -540,7 +540,7 @@ 
                 $next_node = $data;
             } else {
                 if ($is_collection) {
-                    $next_node = array_map(function ($item) use ($next_key) {
+                    $next_node = array_map(function($item) use ($next_key) {
                         if ($item !== null && array_key_exists($next_key, $item)) {
                             return $item[$next_key];
                         }
@@ -597,7 +597,7 @@ 
                             if ($collapse) {
                                 $result[] = $partial;
                             } else {
-                                $result[] = [ $partial ];
+                                $result[] = [$partial];
                             }
                         }
                     }
@@ -640,7 +640,7 @@ 
 
         $depth = 0;
         $child = array_shift($array);
-        while(Arrgh::arrgh_is_collection($child)) {
+        while (Arrgh::arrgh_is_collection($child)) {
             $depth += 1;
             $child = array_shift($child);
         }
@@ -658,24 +658,24 @@ 
     {
         $left = [];
         $right = [];
-        array_walk($array, function ($item, $key) use (&$left, &$right, $callable) {
+        array_walk($array, function($item, $key) use (&$left, &$right, $callable) {
             if ($callable($item, $key)) {
                 $left[] = $item;
             } else {
                 $right[] = $item;
             }
         });
-        return [ $left, $right ];
+        return [$left, $right];
     }
 
     private static function arrgh_even($array)
     {
-        return Arrgh::arrgh_partition($array, function ($item, $key) { return $key % 2 === 0; })[0];
+        return Arrgh::arrgh_partition($array, function($item, $key) { return $key % 2 === 0; })[0];
     }
 
     private static function arrgh_odd($array)
     {
-        return Arrgh::arrgh_partition($array, function ($item, $key) { return $key % 2 === 1; })[0];
+        return Arrgh::arrgh_partition($array, function($item, $key) { return $key % 2 === 1; })[0];
     }
 
     /* Synonym of shift */