ArraysMethods::flatten() - Code Metrics - Inspection of "fix tests" - mariosvasiliou/underscore_php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1cf5ae...a503d8 )

by Marios

created 2019-12-23 09:02 UTC

ArraysMethods::flatten() A

↳ Parent: ArraysMethods

Complexity

Conditions	6
Paths	15

Size

Total Lines	28
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	1

Metric	Value
eloc	15
c	1
b	1
f	1
dl	0
loc	28
rs	9.2222
cc	6
nc	15
nop	3

<?php

/*
 * This file is part of Underscore.php
 *
 * (c) Maxime Fabre <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Underscore\Methods;

use Closure;

/**
 * Methods to manage arrays.
 */
class ArraysMethods extends CollectionMethods
{

    ////////////////////////////////////////////////////////////////////
    ///////////////////////////// GENERATE /////////////////////////////
    ////////////////////////////////////////////////////////////////////

    //<editor-fold desc="*** Methods ***">
    /**
     * Generate an array from a range.
     *
     * @param int $_base The base number
     * @param int $stop  The stopping point
     * @param int $step  How many to increment of
     *
     * @return array
     */
    public static function range($_base, $stop = null, $step = 1) : array
    {
        // Dynamic arguments
        if ($stop !== null) {
            $start = $_base;
        }
        else {
            $start = 1;
            $stop  = $_base;
        }

        return range($start, $stop, $step);
    }

    /**
     * Fill an array with $times times some $data.
     *
     * @param mixed $data
     * @param int   $times
     *
     * @return array
     */
    public static function repeat($data, int $times) : array
    {
        $times = (int)(abs($times));
        if ($times === 0) {
            return [];
        }

        return array_fill(0, $times, $data);
    }

    ////////////////////////////////////////////////////////////////////
    ///////////////////////////// ANALYZE //////////////////////////////
    ////////////////////////////////////////////////////////////////////

    /**
     * Search for the index of a value in an array.
     *
     * @param array  $array
     * @param string $value
     *
     * @return mixed
     */
    public static function search($array, $value)
    {
        return array_search($value, $array, true);
    }

    /**
     * Check if all items in an array match a truth test.
     *
     * @param array    $array
     * @param callable $closure
     *
     * @return bool
     */
    public static function matches($array, callable $closure) : bool
    {
        // Reduce the array to only booleans
        $array = static::each($array, $closure);

        // Check the results
        if (\count($array) === 0) {
            return true;
        }
        $array = array_search(false, $array, false);

        return \is_bool($array);
    }

    /**
     * Check if any item in an array matches a truth test.
     *
     * @param array    $array
     * @param callable $closure
     *
     * @return bool
     */
    public static function matchesAny(array $array, callable $closure) : bool
    {
        // Reduce the array to only booleans
        $array = static::each($array, $closure);

        // Check the results
        if (\count($array) === 0) {
            return true;
        }
        $array = array_search(true, $array, false);

        return \is_int($array);
    }

    /**
     * Check if an item is in an array.
     *
     * @param $array
     * @param $value
     *
     * @return bool
     */
    public static function contains($array, $value) : bool
    {
        return \in_array($value, $array, true);
    }

    /**
     * Returns the average value of an array.
     *
     * @param array $array    The source array
     * @param int   $decimals The number of decimals to return
     *
     * @return float The average value
     */
    public static function average(array $array, int $decimals = 0) : float
    {
        return round((array_sum($array) / \count($array)), $decimals);
    }

    /**
     * Get the size of an array.
     *
     * @param array $array
     *
     * @return int
     */
    public static function size(array $array) : int
    {
        return \count($array);
    }

    /**
     * Get the max value from an array.
     *
     * @param array        $array
     * @param Closure|null $closure
     *
     * @return mixed
     */
    public static function max(array $array, $closure = null)
    {
        // If we have a closure, apply it to the array
        if ($closure) {
            $array = static::each($array, $closure);
        }

        return max($array);
    }

    /**
     * Get the min value from an array.
     *
     * @param array        $array
     * @param Closure|null $closure
     *
     * @return mixed
     */
    public static function min(array $array, $closure = null)
    {
        // If we have a closure, apply it to the array
        if ($closure) {
            $array = static::each($array, $closure);
        }

        return min($array);
    }

    ////////////////////////////////////////////////////////////////////
    //////////////////////////// FETCH FROM ////////////////////////////
    ////////////////////////////////////////////////////////////////////

    /**
     * Find the first item in an array that passes the truth test.
     *
     * @param array   $array
     * @param Closure $closure
     *
     * @return mixed|void
     */
    public static function find(array $array, Closure $closure)
    {
        foreach ($array as $key => $value) {
            if ($closure($value, $key)) {
                return $value;
            }
        }

        return;
    }

    /**
     * Clean all falsy values from an array.
     *
     * @param array $array
     *
     * @return array|mixed
     */
    public static function clean(array $array)
    {
        return static::filter($array, function($value) {
            return (bool)$value;
        });
    }

    /**
     * Get a random string from an array.
     *
     * @param array    $array
     * @param int|null $take
     *
     * @return array|mixed
     */
    public static function random(array $array, int $take = null)
    {
        if ( ! $take) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            return $array[array_rand($array)];
        }

        shuffle($array);

        return static::first($array, $take);
    }

    /**
     * Return an array without all instances of certain values.
     */
    public static function without()
    {
        $arguments = \func_get_args();
        $array     = array_shift($arguments);
        // if singular argument and is an array treat this AS the array to run without agains
        if (\is_array($arguments[0]) && \count($arguments) === 1) {
            $arguments = $arguments[0];
        }

        return static::filter($array, function($value) use ($arguments) {
            return ! \in_array($value, $arguments, true);
        });
    }

    /**
     * Return an array with all elements found in both input arrays.
     *
     * @param array $a
     * @param array $b
     *
     * @return array
     */
    public static function intersection(array $a, array $b) : array
    {
        $a = (array)$a;
        $b = (array)$b;

        return array_values(array_intersect($a, $b));
    }

    /**
     * Return a boolean flag which indicates whether the two input arrays have any common elements.
     *
     * @param array $a
     * @param array $b
     *
     * @return bool
     */
    public static function intersects(array $a, array $b) : bool
    {
        $a = (array)$a;
        $b = (array)$b;

        return \count(self::intersection($a, $b)) > 0;
    }

    ////////////////////////////////////////////////////////////////////
    ///////////////////////////// SLICERS //////////////////////////////
    ////////////////////////////////////////////////////////////////////

    /**
     * Get the first value from an array.
     *
     * @param array    $array
     * @param int|null $take
     *
     * @return array|mixed
     */
    public static function first(array $array, int $take = null)
    {
        if ( ! $take) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            return array_shift($array);
        }

        return array_splice($array, 0, $take, true);
    }

    /**
     * Get the last value from an array.
     *
     * @param array    $array
     * @param int|null $take
     *
     * @return array|mixed
     */
    public static function last(array $array, int $take = null)
    {
        if ( ! $take) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            return array_pop($array);
        }

        return static::rest($array, -$take);
    }

    /**
     * Get everything but the last $to items.
     *
     * @param array $array
     * @param int   $to
     *
     * @return array|mixed
     */
    public static function initial(array $array, $to = 1)
    {
        $slice = \count($array) - $to;

        return static::first($array, $slice);
    }

    /**
     * Get the last elements from index $from.
     *
     * @param array $array
     * @param int   $from
     *
     * @return array
     */
    public static function rest(array $array, $from = 1) : array
    {
        return array_splice($array, $from);
    }

    ////////////////////////////////////////////////////////////////////
    ///////////////////////////// ACT UPON /////////////////////////////
    ////////////////////////////////////////////////////////////////////

    /**
     * Iterate over an array and execute a callback for each loop.
     *
     * @param array   $array
     * @param Closure $closure
     *
     * @return array
     */
    public static function at(array $array, Closure $closure) : array
    {
        foreach ($array as $key => $value) {
            $closure($value, $key);
        }

        return $array;
    }

    ////////////////////////////////////////////////////////////////////
    ////////////////////////////// ALTER ///////////////////////////////
    ////////////////////////////////////////////////////////////////////

    /**
     * Replace a value in an array.
     *
     * @param array  $array   The array
     * @param string $replace The string to replace
     * @param string $with    What to replace it with
     *
     * @return array
     */
    public static function replaceValue(array $array, string $replace, string $with) : array
    {
        return static::each($array, function($value) use ($replace, $with) {
            return str_replace($replace, $with, $value);
        });
    }

    /**
     * Replace the keys in an array with another set.
     *
     * @param array $array The array
     * @param array $keys  An array of keys matching the array's size
     *
     * @return array
     */
    public static function replaceKeys(array $array, array $keys) : array
    {
        $values = array_values($array);

        return array_combine($keys, $values);

    }

    /**
     * Iterate over an array and modify the array's value.
     *
     * @param array   $array
     * @param Closure $closure
     *
     * @return array
     */
    public static function each(array $array, Closure $closure) : array
    {
        foreach ($array as $key => $value) {
            $array[$key] = $closure($value, $key);
        }

        return $array;
    }

    /**
     * Shuffle an array.
     *
     * @param array $array
     *
     * @return array
     */
    public static function shuffle(array $array) : array
    {
        shuffle($array);

        return $array;
    }

    /**
     * Sort an array by key.
     *
     * @param array  $array
     * @param string $direction
     *
     * @return array
     */
    public static function sortKeys(array $array, string $direction = 'ASC') : array
    {
        $direction = (strtolower($direction) === 'desc') ? SORT_DESC : SORT_ASC;
        if ($direction === SORT_ASC) {
            ksort($array);
        }
        else {
            krsort($array);
        }

        return $array;
    }

    /**
     * Implodes an array.
     *
     * @param array  $array The array
     * @param string $with  What to implode it with
     *
     * @return string
     */
    public static function implode($array, $with = '') : string
    {
        return implode($with, $array);
    }

    /**
     * Find all items in an array that pass the truth test.
     *
     * @param array         $array
     * @param callable|null $closure
     *
     * @return array|mixed
     */
    public static function filter(array $array, $closure = null)
    {
        if ( ! $closure) {
            return static::clean($array);
        }

        return array_filter($array, $closure);
    }

    /**
     * Flattens an array to dot notation.
     *
     * @param array  $array     An array
     * @param string $separator The characater to flatten with
     * @param string $parent    The parent passed to the child (private)
     *
     * @return string|array Flattened array to one level
     */
    public static function flatten(array $array, string $separator = '.', string $parent = null)
    {
        $_flattened = [];

        // Rewrite keys
        foreach ($array as $key => $value) {
            if ($parent) {
                $key = $parent.$separator.$key;
            }
            if ( ! \is_array($value)) {
                $_flattened[$key] = $value;
                continue;
            }
            $_flattened[$key] = static::flatten($value, $separator, $key);
        }

        // Flatten
        $flattened = [];
        foreach ($_flattened as $key => $value) {
            if (\is_array($value)) {
                $flattened = array_merge($flattened, $value);
            }
            else {
                $flattened[$key] = $value;
            }
        }

        return $flattened;
    }

    /**
     * Invoke a function on all of an array's values.
     *
     * @param array        $array
     * @param callable     $callable
     * @param array|string $arguments
     *
     * @return array
     */
    public static function invoke(array $array, $callable, $arguments = []) : array
    {
        // If one argument given for each iteration, create an array for it
        if ( ! \is_array($arguments)) {
            $arguments = static::repeat($arguments, \count($array));
        }

        // If the callable has arguments, pass them
        if ($arguments) {
            return array_map($callable, $array, $arguments);
        }

        return array_map($callable, $array);
    }

    /**
     * Return all items that fail the truth test.
     *
     * @param array   $array
     * @param Closure $closure
     *
     * @return array
     */
    public static function reject(array $array, Closure $closure) : array
    {
        $filtered = [];

        foreach ($array as $key => $value) {
            if ( ! $closure($value, $key)) {
                $filtered[$key] = $value;
            }
        }

        return $filtered;
    }

    /**
     * Remove the first value from an array.
     *
     * @param array $array
     *
     * @return array
     */
    public static function removeFirst(array $array) : array
    {
        array_shift($array);

        return $array;
    }

    /**
     * Remove the last value from an array.
     *
     * @param array $array
     *
     * @return array
     */
    public static function removeLast(array $array) : array
    {
        array_pop($array);

        return $array;
    }

    /**
     * Removes a particular value from an array (numeric or associative).
     *
     * @param array  $array
     * @param string $value
     *
     * @return array
     */
    public static function removeValue(array $array, string $value) : array
    {
        $isNumericArray = true;
        foreach ($array as $key => $item) {
            if ($item === $value) {
                if ( ! \is_int($key)) {
                    $isNumericArray = false;
                }
                unset($array[$key]);
            }
        }
        if ($isNumericArray) {
            $array = array_values($array);
        }

        return $array;
    }

    /**
     * Prepend a value to an array.
     *
     * @param array  $array
     * @param string $value
     *
     * @return array
     */
    public static function prepend($array, $value) : array
    {
        array_unshift($array, $value);

        return $array;
    }

    /**
     * Append a value to an array.
     *
     * @param array  $array
     * @param string $value
     *
     * @return array
     */
    public static function append($array, $value) : array
    {
        $array[] = $value;

        return $array;
    }

    /*
     *  Return a duplicate free copy of an array
     * */
    /**
     * @param array $array
     *
     * @return array
     */
    public static function unique($array) : array
    {
        return array_reduce($array, function($resultArray, $value) {
            if ( ! static::contains($resultArray, $value)) {
                $resultArray[] = $value;
            }

            return $resultArray;
        }, []);
    }
    //</editor-fold desc="*** Methods ***">
}


1			<?php
2
3			/*
4			* This file is part of Underscore.php
5			*
6			* (c) Maxime Fabre <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Underscore\Methods;
13
14			use Closure;
15
16			/**
17			* Methods to manage arrays.
18			*/
19			class ArraysMethods extends CollectionMethods
20			{
21
22			////////////////////////////////////////////////////////////////////
23			///////////////////////////// GENERATE /////////////////////////////
24			////////////////////////////////////////////////////////////////////
25
26			//<editor-fold desc="* Methods *">
27			/**
28			* Generate an array from a range.
29			*
30			* @param int $_base The base number
31			* @param int $stop The stopping point
32			* @param int $step How many to increment of
33			*
34			* @return array
35			*/
36			public static function range($_base, $stop = null, $step = 1) : array
37			{
38			// Dynamic arguments
39			if ($stop !== null) {
40			$start = $_base;
41			}
42			else {
43			$start = 1;
44			$stop = $_base;
45			}
46
47			return range($start, $stop, $step);
48			}
49
50			/**
51			* Fill an array with $times times some $data.
52			*
53			* @param mixed $data
54			* @param int $times
55			*
56			* @return array
57			*/
58			public static function repeat($data, int $times) : array
59			{
60			$times = (int)(abs($times));
61			if ($times === 0) {
62			return [];
63			}
64
65			return array_fill(0, $times, $data);
66			}
67
68			////////////////////////////////////////////////////////////////////
69			///////////////////////////// ANALYZE //////////////////////////////
70			////////////////////////////////////////////////////////////////////
71
72			/**
73			* Search for the index of a value in an array.
74			*
75			* @param array $array
76			* @param string $value
77			*
78			* @return mixed
79			*/
80			public static function search($array, $value)
81			{
82			return array_search($value, $array, true);
83			}
84
85			/**
86			* Check if all items in an array match a truth test.
87			*
88			* @param array $array
89			* @param callable $closure
90			*
91			* @return bool
92			*/
93			public static function matches($array, callable $closure) : bool
94			{
95			// Reduce the array to only booleans
96			$array = static::each($array, $closure);
97
98			// Check the results
99			if (\count($array) === 0) {
100			return true;
101			}
102			$array = array_search(false, $array, false);
103
104			return \is_bool($array);
105			}
106
107			/**
108			* Check if any item in an array matches a truth test.
109			*
110			* @param array $array
111			* @param callable $closure
112			*
113			* @return bool
114			*/
115			public static function matchesAny(array $array, callable $closure) : bool
116			{
117			// Reduce the array to only booleans
118			$array = static::each($array, $closure);
119
120			// Check the results
121			if (\count($array) === 0) {
122			return true;
123			}
124			$array = array_search(true, $array, false);
125
126			return \is_int($array);
127			}
128
129			/**
130			* Check if an item is in an array.
131			*
132			* @param $array
133			* @param $value
134			*
135			* @return bool
136			*/
137			public static function contains($array, $value) : bool
138			{
139			return \in_array($value, $array, true);
140			}
141
142			/**
143			* Returns the average value of an array.
144			*
145			* @param array $array The source array
146			* @param int $decimals The number of decimals to return
147			*
148			* @return float The average value
149			*/
150			public static function average(array $array, int $decimals = 0) : float
151			{
152			return round((array_sum($array) / \count($array)), $decimals);
153			}
154
155			/**
156			* Get the size of an array.
157			*
158			* @param array $array
159			*
160			* @return int
161			*/
162			public static function size(array $array) : int
163			{
164			return \count($array);
165			}
166
167			/**
168			* Get the max value from an array.
169			*
170			* @param array $array
171			* @param Closure\|null $closure
172			*
173			* @return mixed
174			*/
175			public static function max(array $array, $closure = null)
176			{
177			// If we have a closure, apply it to the array
178			if ($closure) {
179			$array = static::each($array, $closure);
180			}
181
182			return max($array);
183			}
184
185			/**
186			* Get the min value from an array.
187			*
188			* @param array $array
189			* @param Closure\|null $closure
190			*
191			* @return mixed
192			*/
193			public static function min(array $array, $closure = null)
194			{
195			// If we have a closure, apply it to the array
196			if ($closure) {
197			$array = static::each($array, $closure);
198			}
199
200			return min($array);
201			}
202
203			////////////////////////////////////////////////////////////////////
204			//////////////////////////// FETCH FROM ////////////////////////////
205			////////////////////////////////////////////////////////////////////
206
207			/**
208			* Find the first item in an array that passes the truth test.
209			*
210			* @param array $array
211			* @param Closure $closure
212			*
213			* @return mixed\|void
214			*/
215			public static function find(array $array, Closure $closure)
216			{
217			foreach ($array as $key => $value) {
218			if ($closure($value, $key)) {
219			return $value;
220			}
221			}
222
223			return;
224			}
225
226			/**
227			* Clean all falsy values from an array.
228			*
229			* @param array $array
230			*
231			* @return array\|mixed
232			*/
233			public static function clean(array $array)
234			{
235			return static::filter($array, function($value) {
236			return (bool)$value;
237			});
238			}
239
240			/**
241			* Get a random string from an array.
242			*
243			* @param array $array
244			* @param int\|null $take
245			*
246			* @return array\|mixed
247			*/
248			public static function random(array $array, int $take = null)
249			{
250			if ( ! $take) {
			0 ignored issues – show Bug Best Practice introduced 2019-12-23 08:57 UTC by Report Bug Copy Issue Report The expression `$take` of type `integer\|null` is loosely compared to `false`; this is ambiguous if the integer can be 0. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
251			return $array[array_rand($array)];
252			}
253
254			shuffle($array);
255
256			return static::first($array, $take);
257			}
258
259			/**
260			* Return an array without all instances of certain values.
261			*/
262			public static function without()
263			{
264			$arguments = \func_get_args();
265			$array = array_shift($arguments);
266			// if singular argument and is an array treat this AS the array to run without agains
267			if (\is_array($arguments[0]) && \count($arguments) === 1) {
268			$arguments = $arguments[0];
269			}
270
271			return static::filter($array, function($value) use ($arguments) {
272			return ! \in_array($value, $arguments, true);
273			});
274			}
275
276			/**
277			* Return an array with all elements found in both input arrays.
278			*
279			* @param array $a
280			* @param array $b
281			*
282			* @return array
283			*/
284			public static function intersection(array $a, array $b) : array
285			{
286			$a = (array)$a;
287			$b = (array)$b;
288
289			return array_values(array_intersect($a, $b));
290			}
291
292			/**
293			* Return a boolean flag which indicates whether the two input arrays have any common elements.
294			*
295			* @param array $a
296			* @param array $b
297			*
298			* @return bool
299			*/
300			public static function intersects(array $a, array $b) : bool
301			{
302			$a = (array)$a;
303			$b = (array)$b;
304
305			return \count(self::intersection($a, $b)) > 0;
306			}
307
308			////////////////////////////////////////////////////////////////////
309			///////////////////////////// SLICERS //////////////////////////////
310			////////////////////////////////////////////////////////////////////
311
312			/**
313			* Get the first value from an array.
314			*
315			* @param array $array
316			* @param int\|null $take
317			*
318			* @return array\|mixed
319			*/
320			public static function first(array $array, int $take = null)
321			{
322			if ( ! $take) {
			0 ignored issues – show Bug Best Practice introduced 2019-12-23 08:57 UTC by Report Bug Copy Issue Report The expression `$take` of type `integer\|null` is loosely compared to `false`; this is ambiguous if the integer can be 0. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
323			return array_shift($array);
324			}
325
326			return array_splice($array, 0, $take, true);
327			}
328
329			/**
330			* Get the last value from an array.
331			*
332			* @param array $array
333			* @param int\|null $take
334			*
335			* @return array\|mixed
336			*/
337			public static function last(array $array, int $take = null)
338			{
339			if ( ! $take) {
			0 ignored issues – show Bug Best Practice introduced 2019-12-23 08:57 UTC by Report Bug Copy Issue Report The expression `$take` of type `integer\|null` is loosely compared to `false`; this is ambiguous if the integer can be 0. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
340			return array_pop($array);
341			}
342
343			return static::rest($array, -$take);
344			}
345
346			/**
347			* Get everything but the last $to items.
348			*
349			* @param array $array
350			* @param int $to
351			*
352			* @return array\|mixed
353			*/
354			public static function initial(array $array, $to = 1)
355			{
356			$slice = \count($array) - $to;
357
358			return static::first($array, $slice);
359			}
360
361			/**
362			* Get the last elements from index $from.
363			*
364			* @param array $array
365			* @param int $from
366			*
367			* @return array
368			*/
369			public static function rest(array $array, $from = 1) : array
370			{
371			return array_splice($array, $from);
372			}
373
374			////////////////////////////////////////////////////////////////////
375			///////////////////////////// ACT UPON /////////////////////////////
376			////////////////////////////////////////////////////////////////////
377
378			/**
379			* Iterate over an array and execute a callback for each loop.
380			*
381			* @param array $array
382			* @param Closure $closure
383			*
384			* @return array
385			*/
386			public static function at(array $array, Closure $closure) : array
387			{
388			foreach ($array as $key => $value) {
389			$closure($value, $key);
390			}
391
392			return $array;
393			}
394
395			////////////////////////////////////////////////////////////////////
396			////////////////////////////// ALTER ///////////////////////////////
397			////////////////////////////////////////////////////////////////////
398
399			/**
400			* Replace a value in an array.
401			*
402			* @param array $array The array
403			* @param string $replace The string to replace
404			* @param string $with What to replace it with
405			*
406			* @return array
407			*/
408			public static function replaceValue(array $array, string $replace, string $with) : array
409			{
410			return static::each($array, function($value) use ($replace, $with) {
411			return str_replace($replace, $with, $value);
412			});
413			}
414
415			/**
416			* Replace the keys in an array with another set.
417			*
418			* @param array $array The array
419			* @param array $keys An array of keys matching the array's size
420			*
421			* @return array
422			*/
423			public static function replaceKeys(array $array, array $keys) : array
424			{
425			$values = array_values($array);
426
427			return array_combine($keys, $values);
			0 ignored issues – show Bug Best Practice introduced 2019-12-23 08:09 UTC by Report Bug Copy Issue Report The expression `return array_combine($keys, $values)` could return the type `false` which is incompatible with the type-hinted return `array`. Consider adding an additional type-check to rule them out. Loading history...
428			}
429
430			/**
431			* Iterate over an array and modify the array's value.
432			*
433			* @param array $array
434			* @param Closure $closure
435			*
436			* @return array
437			*/
438			public static function each(array $array, Closure $closure) : array
439			{
440			foreach ($array as $key => $value) {
441			$array[$key] = $closure($value, $key);
442			}
443
444			return $array;
445			}
446
447			/**
448			* Shuffle an array.
449			*
450			* @param array $array
451			*
452			* @return array
453			*/
454			public static function shuffle(array $array) : array
455			{
456			shuffle($array);
457
458			return $array;
459			}
460
461			/**
462			* Sort an array by key.
463			*
464			* @param array $array
465			* @param string $direction
466			*
467			* @return array
468			*/
469			public static function sortKeys(array $array, string $direction = 'ASC') : array
470			{
471			$direction = (strtolower($direction) === 'desc') ? SORT_DESC : SORT_ASC;
472			if ($direction === SORT_ASC) {
473			ksort($array);
474			}
475			else {
476			krsort($array);
477			}
478
479			return $array;
480			}
481
482			/**
483			* Implodes an array.
484			*
485			* @param array $array The array
486			* @param string $with What to implode it with
487			*
488			* @return string
489			*/
490			public static function implode($array, $with = '') : string
491			{
492			return implode($with, $array);
493			}
494
495			/**
496			* Find all items in an array that pass the truth test.
497			*
498			* @param array $array
499			* @param callable\|null $closure
500			*
501			* @return array\|mixed
502			*/
503			public static function filter(array $array, $closure = null)
504			{
505			if ( ! $closure) {
506			return static::clean($array);
507			}
508
509			return array_filter($array, $closure);
510			}
511
512			/**
513			* Flattens an array to dot notation.
514			*
515			* @param array $array An array
516			* @param string $separator The characater to flatten with
517			* @param string $parent The parent passed to the child (private)
518			*
519			* @return string\|array Flattened array to one level
520			*/
521			public static function flatten(array $array, string $separator = '.', string $parent = null)
522			{
523			$_flattened = [];
524
525			// Rewrite keys
526			foreach ($array as $key => $value) {
527			if ($parent) {
528			$key = $parent.$separator.$key;
529			}
530			if ( ! \is_array($value)) {
531			$_flattened[$key] = $value;
532			continue;
533			}
534			$_flattened[$key] = static::flatten($value, $separator, $key);
535			}
536
537			// Flatten
538			$flattened = [];
539			foreach ($_flattened as $key => $value) {
540			if (\is_array($value)) {
541			$flattened = array_merge($flattened, $value);
542			}
543			else {
544			$flattened[$key] = $value;
545			}
546			}
547
548			return $flattened;
549			}
550
551			/**
552			* Invoke a function on all of an array's values.
553			*
554			* @param array $array
555			* @param callable $callable
556			* @param array\|string $arguments
557			*
558			* @return array
559			*/
560			public static function invoke(array $array, $callable, $arguments = []) : array
561			{
562			// If one argument given for each iteration, create an array for it
563			if ( ! \is_array($arguments)) {
564			$arguments = static::repeat($arguments, \count($array));
565			}
566
567			// If the callable has arguments, pass them
568			if ($arguments) {
569			return array_map($callable, $array, $arguments);
570			}
571
572			return array_map($callable, $array);
573			}
574
575			/**
576			* Return all items that fail the truth test.
577			*
578			* @param array $array
579			* @param Closure $closure
580			*
581			* @return array
582			*/
583			public static function reject(array $array, Closure $closure) : array
584			{
585			$filtered = [];
586
587			foreach ($array as $key => $value) {
588			if ( ! $closure($value, $key)) {
589			$filtered[$key] = $value;
590			}
591			}
592
593			return $filtered;
594			}
595
596			/**
597			* Remove the first value from an array.
598			*
599			* @param array $array
600			*
601			* @return array
602			*/
603			public static function removeFirst(array $array) : array
604			{
605			array_shift($array);
606
607			return $array;
608			}
609
610			/**
611			* Remove the last value from an array.
612			*
613			* @param array $array
614			*
615			* @return array
616			*/
617			public static function removeLast(array $array) : array
618			{
619			array_pop($array);
620
621			return $array;
622			}
623
624			/**
625			* Removes a particular value from an array (numeric or associative).
626			*
627			* @param array $array
628			* @param string $value
629			*
630			* @return array
631			*/
632			public static function removeValue(array $array, string $value) : array
633			{
634			$isNumericArray = true;
635			foreach ($array as $key => $item) {
636			if ($item === $value) {
637			if ( ! \is_int($key)) {
638			$isNumericArray = false;
639			}
640			unset($array[$key]);
641			}
642			}
643			if ($isNumericArray) {
644			$array = array_values($array);
645			}
646
647			return $array;
648			}
649
650			/**
651			* Prepend a value to an array.
652			*
653			* @param array $array
654			* @param string $value
655			*
656			* @return array
657			*/
658			public static function prepend($array, $value) : array
659			{
660			array_unshift($array, $value);
661
662			return $array;
663			}
664
665			/**
666			* Append a value to an array.
667			*
668			* @param array $array
669			* @param string $value
670			*
671			* @return array
672			*/
673			public static function append($array, $value) : array
674			{
675			$array[] = $value;
676
677			return $array;
678			}
679
680			/*
681			* Return a duplicate free copy of an array
682			* */
683			/**
684			* @param array $array
685			*
686			* @return array
687			*/
688			public static function unique($array) : array
689			{
690			return array_reduce($array, function($resultArray, $value) {
691			if ( ! static::contains($resultArray, $value)) {
692			$resultArray[] = $value;
693			}
694
695			return $resultArray;
696			}, []);
697			}
698			//</editor-fold desc="* Methods *">
699			}
700

mariosvasiliou / underscore_php

GitHub Access Token became invalid

Push — master ( 1cf5ae...a503d8 )

ArraysMethods::flatten() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like