🗃 Arrayy

A PHP array manipulation library. Compatible with PHP 7+ & PHP 8+

\Arrayy\Type\StringCollection::create(['Array', 'Array'])->unique()->append('y')->implode() // Arrayy

documentation via gitbooks.io

Installation
Multidimensional ArrayAccess
PhpDoc @property checking
OO and Chaining
Collections
- Pre-Defined Typified Collections
- Convert JSON-Data into Collections
Class methods
Instance methods
Tests
License

Installation via "composer require"

composer require voku/arrayy

Multidimensional ArrayAccess

You can access / change the array via Object, Array or with "Arrayy"-syntax.

Access via "Arrayy"-syntax: (dot-notation)

$arrayy = new A(['Lars' => ['lastname' => 'Moelleken']]);

$arrayy->get('Lars'); // ['lastname' => 'Moelleken']
$arrayy->get('Lars.lastname'); // 'Moelleken'

Access via "array"-syntax:

$arrayy = new A(['Lars' => ['lastname' => 'Moelleken']]);

$arrayy['Lars'];             // ['lastname' => 'Moelleken']
$arrayy['Lars']['lastname']; // 'Moelleken'

Access via "object"-syntax:

$arrayy = new A(['Lars' => ['lastname' => 'Moelleken']]);

$arrayy->Lars; // Arrayy['lastname' => 'Moelleken']
$arrayy->Lars->lastname; // 'Moelleken'

Set values via "Arrayy"-syntax: (dot-notation)

$arrayy = new A(['Lars' => ['lastname' => 'Mueller']]);

$arrayy->set('Lars.lastname', 'Moelleken');
$arrayy->get('Lars.lastname'); // 'Moelleken'

Set values via "array"-syntax:

$arrayy = new A(['Lars' => ['lastname' => 'Moelleken']]);

$arrayy['Lars'] = array('lastname' => 'Müller');
$arrayy['Lars']['lastname']; // 'Müller'

Set values via "object"-syntax:

$arrayy = new A(['Lars' => ['lastname' => 'Moelleken']]);

$arrayy->Lars = array('lastname' => 'Müller');
$arrayy->Lars->lastname; // 'Müller'

PhpDoc @property checking

The library offers a type checking for @property phpdoc-class-comments, as seen below:

/**
 * @property int        $id
 * @property int|string $firstName
 * @property string     $lastName
 * @property null|City  $city
 *
 * @extends  \Arrayy\Arrayy<array-key,mixed>
 */
class User extends \Arrayy\Arrayy
{
  protected $checkPropertyTypes = true;

  protected $checkPropertiesMismatchInConstructor = true;
}

/**
 * @property string|null $plz
 * @property string      $name
 * @property string[]    $infos
 *
 * @extends  \Arrayy\Arrayy<array-key,mixed>
 */
class City extends \Arrayy\Arrayy
{
    protected $checkPropertyTypes = true;

    protected $checkPropertiesMismatchInConstructor = true;
}

$cityMeta = City::meta();
$city = new City(
    [
        $cityMeta->plz   => null,
        $cityMeta->name  => 'Düsseldorf',
        $cityMeta->infos => ['lall'],
    ]
);

$userMeta = User::meta();
$user = new User(
    [
        $userMeta->id        => 1,
        $userMeta->firstName => 'Lars',
        $userMeta->lastName  => 'Moelleken',
        $userMeta->city      => $city,
    ]
);

var_dump($user['lastName']); // 'Moelleken'
var_dump($user[$userMeta->lastName]); // 'Moelleken'
var_dump($user->lastName); // Moelleken

var_dump($user['city.name']); // 'Düsseldorf'
var_dump($user[$userMeta->city][$cityMeta->name]); // 'Düsseldorf'
var_dump($user->city->name); // Düsseldorf

"checkPropertyTypes": activate the type checking for all defined @property in the class-phpdoc
"checkPropertiesMismatchInConstructor": activate the property mismatch check, so you can only add an array with all needed properties (or an empty array) into the constructor

OO and Chaining

The library also offers OO method chaining, as seen below:

echo a(['fòô', 'bàř', 'bàř'])->unique()->reverse()->implode(','); // 'bàř,fòô'

Implemented Interfaces

Arrayy\Arrayy implements the IteratorAggregate interface, meaning that foreach can be used with an instance of the class:

$arrayy = a(['fòôbàř', 'foo']);
foreach ($arrayy as $value) {
    echo $value;
}
// 'fòôbàř'
// 'foo'

It implements the Countable interface, enabling the use of count() to retrieve the number of elements in the array:

$arrayy = a(['fòô', 'foo']);
count($arrayy);  // 2

PHP 5.6 Creation

As of PHP 5.6, use function is available for importing functions. Arrayy exposes a namespaced function, Arrayy\create, which emits the same behaviour as Arrayy\Arrayy::create(). If running PHP 5.6, or another runtime that supports the use function syntax, you can take advantage of an even simpler API as seen below:

use function Arrayy\create as a;

// Instead of: A::create(['fòô', 'bàř'])->reverse()->implode();
a(['fòô', 'bàř'])->reverse()->implode(','); // 'bàř,fòô'

Collections

If you need to group objects together, it's not a good idea to use a simple array or Arrayy object. For these cases you can use the AbstractCollection class.

It will throw a InvalidArgumentException if you try to add a non valid object into the collection.

e.g.: "YOURCollection.php" (see example /tests/CollectionTest.php on github)

use Arrayy\Collection\AbstractCollection;

/**
 * @extends  AbstractCollection<array-key,YOURInterface>
 */
class YOURCollection extends AbstractCollection
{
    /**
     * The type (FQCN) associated with this collection.
     *
     * @return string
     */
    public function getType(): string
    {
        return YOURInterface::class;
    }
}

$YOURobject1 = new YOURClass();
$YOURobject2 = new YOURClass();

$YOURcollection = new YOURCollection($YOURobject1);
$YOURcollection->add($YOURobject2); // add one more object

// Or, you can use an array of objects.
//
// $YOURcollection = new YOURCollection([$YOURobject1, $YOURobject2]);

// Or, if you don't want to create new classes ... 
// ... and you don't need typehints and autocompletion via classes.
//
// $YOURcollection = \Arrayy\Collection::construct(YOURInterface::class, [$YOURobject1]);
// $YOURcollection->add($YOURobject2); // add one more object

// Or, if you don't like classes at all. ;-)
//
// $YOURcollection = \Arrayy\collection(YOURInterface::class, [$YOURobject1]);
// $YOURcollection->add($YOURobject2); // add one more object

foreach ($YOURcollection as $YOURobject) {
    if ($YOURobject instanceof YOURInterface) {
        // Do something with $YOURobject
    }
}

You can also use "dot-notation" to get data from your collections e.g. $YOURcollection->get('3123.foo.bar');

Pre-Defined Typified Collections

simple example

This will throw a "TypeError"-Exception.

use Arrayy\Type\StringCollection;

$collection = new StringCollection(['A', 'B', 'C', 1]);

complex example

This will NOT throw a "TypeError"-Exception.

use Arrayy\Type\IntCollection;
use Arrayy\Type\StringCollection;
use Arrayy\Type\InstancesCollection;
use Arrayy\Type\TypeInterface;

$collection = InstancesCollection::construct(
    TypeInterface::class,
    [new StringCollection(['A', 'B', 'C']), new IntCollection([1])]
);

$collection->toArray(true); // [['A', 'B', 'C'], [1]]

Convert JSON-Data into Objects (Collection)

namespace Arrayy\tests\Collection;

use Arrayy\Collection\AbstractCollection;

/**
 * @extends  AbstractCollection<array-key,\Arrayy\tests\UserData>
 */
class UserDataCollection extends AbstractCollection
{
    /**
     * The type (FQCN) associated with this collection.
     *
     * @return string
     */
    public function getType()
    {
        return \Arrayy\tests\UserData::class;
    }
}

$json = '[{"id":1,"firstName":"Lars","lastName":"Moelleken","city":{"name":"Düsseldorf","plz":null,"infos":["lall"]}}, {"id":1,"firstName":"Sven","lastName":"Moelleken","city":{"name":"Köln","plz":null,"infos":["foo"]}}]';
$userDataCollection = UserDataCollection::createFromJsonMapper($json);

/** @var \Arrayy\tests\UserData[] $userDatas */
$userDataCollection->getAll();

$userData0 = $userDataCollection[0];
echo $userData0->firstName; // 'Lars'
$userData0->city; // CityData::class
echo $userData0->city->name; // 'Düsseldorf'

$userData1 = $userDataCollection[1];
echo $userData1->firstName; // 'Sven'
$userData1->city; // CityData::class
echo $userData1->city->name; // 'Köln'

Class methods

use a "default object"

Creates an Arrayy object.

$arrayy = new Arrayy(array('fòô', 'bàř')); // Arrayy['fòô', 'bàř']

create(array $array) : Arrayy (Immutable)

Creates an Arrayy object, via static "create()"-method

$arrayy = A::create(array('fòô', 'bàř')); // Arrayy['fòô', 'bàř']

createByReference(array &$array) : Arrayy (Mutable)

WARNING: Creates an Arrayy object by reference.

$array = array('fòô', 'bàř');
$arrayy = A::createByReference($array); // Arrayy['fòô', 'bàř']

createFromJson(string $json) : Arrayy (Immutable)

Create an new Arrayy object via JSON.

$str = '{"firstName":"John", "lastName":"Doe"}';
$arrayy = A::createFromJson($str); // Arrayy['firstName' => 'John', 'lastName' => 'Doe']

createFromJsonMapper(string $json) : Arrayy (Immutable)

Create an new Arrayy object via JSON and fill sub-objects is possible.

<?php

namespace Arrayy\tests;

/**
 * @property int                         $id
 * @property int|string                  $firstName
 * @property string                      $lastName
 * @property \Arrayy\tests\CityData|null $city
 *
 * @extends  \Arrayy\Arrayy<array-key,mixed>
 */
class UserData extends \Arrayy\Arrayy
{
    protected $checkPropertyTypes = true;

    protected $checkForMissingPropertiesInConstructor = true;
}

/**
 * @property string|null $plz
 * @property string      $name
 * @property string[]    $infos
 *
 * @extends  \Arrayy\Arrayy<array-key,mixed>
 */
class CityData extends \Arrayy\Arrayy
{
    protected $checkPropertyTypes = true;

    protected $checkPropertiesMismatchInConstructor = true;

    protected $checkForMissingPropertiesInConstructor = true;

    protected $checkPropertiesMismatch = true;
}

$json = '{"id":1,"firstName":"Lars","lastName":"Moelleken","city":{"name":"Düsseldorf","plz":null,"infos":["lall"]}}';
$userData = UserData::createFromJsonMapper($json);

$userData; // => \Arrayy\tests\UserData::class
echo $userData->firstName; // 'Lars' 
$userData->city; // => \Arrayy\tests\CityData::class
echo $userData->city->name; // 'Düsseldorf'

createFromObject(ArrayAccess $object) : Arrayy (Immutable)

Create an new instance filled with values from an object that have implemented ArrayAccess.

$object = A::create(1, 'foo');
$arrayy = A::createFromObject($object); // Arrayy[1, 'foo']

createFromObjectVars(\object $object) : Arrayy (Immutable)

Create an new instance filled with values from an object.

$object = new stdClass();
$object->x = 42;
$arrayy = A::createFromObjectVars($object); // Arrayy['x' => 42]

createWithRange() : Arrayy (Immutable)

Create an new instance containing a range of elements.

$arrayy = A::createWithRange(2, 4); // Arrayy[2, 3, 4]

createFromGeneratorImmutable() : Arrayy (Immutable)

Create an new instance filled with a copy of values from a "Generator"-object.

WARNING: Need more memory then the "A::createFromGeneratorFunction()" call, because we will fetch and store all keys and values from the Generator.

$generator = A::createWithRange(2, 4)->getGenerator();
$arrayy = A::createFromGeneratorImmutable($generator); // Arrayy[2, 3, 4]

createFromGeneratorFunction() : Arrayy (Immutable)

Create an new instance from a callable function which will return a Generator.

$generatorFunction = static function() {
    yield from A::createWithRange(2, 4)->getArray();
};
$arrayy = A::createFromGeneratorFunction($generatorFunction); // Arrayy[2, 3, 4]

createFromString(string $str) : Arrayy (Immutable)

Create an new Arrayy object via string.

$arrayy = A::createFromString(' foo, bar '); // Arrayy['foo', 'bar']

Instance Methods

Arrayy: All examples below make use of PHP 5.6 function importing, and PHP 5.4 short array syntax. For further details, see the documentation for the create method above, as well as the notes on PHP 5.6 creation.

"set an array value"

$arrayy = a(['fòô' => 'bàř']);
$arrayy['foo'] = 'bar';
var_dump($arrayy); // Arrayy['fòô' => 'bàř', 'foo' => 'bar']

"get an array value"

$arrayy = a(['fòô' => 'bàř']);
var_dump($arrayy['fòô']); // 'bàř'

"get the array"

$arrayy = a(['fòô' => 'bàř']);
var_dump($arrayy->getArray()); // ['fòô' => 'bàř']

"delete an array value"

$arrayy = a(['fòô' => 'bàř', 'lall']);
unset($arrayy['fòô']);
var_dump($arrayy); // Arrayy[0 => 'lall']

"check if an array value is-set"

$arrayy = a(['fòô' => 'bàř']);
isset($arrayy['fòô']); // true

"simple loop with an Arrayy-object"

$arrayy = a(['fòô' => 'bàř']);
foreach ($arrayy) as $key => $value) {
  echo $key . ' | ' . $value; // fòô | bàř
}

Arrayy methods

add	append	appendArrayValues	appendImmutable
appendToEachKey	appendToEachValue	arsort	arsortImmutable
asort	asortImmutable	at	average
changeKeyCase	changeSeparator	chunk	clean
clear	contains	containsCaseInsensitive	containsKey
containsKeys	containsKeysRecursive	containsValue	containsValueRecursive
containsValues	count	countValues	create
createByReference	createFromArray	createFromGeneratorFunction	createFromGeneratorImmutable
createFromJson	createFromJsonMapper	createFromObject	createFromObjectVars
createFromString	createFromTraversableImmutable	createWithRange	current
customSortKeys	customSortKeysImmutable	customSortValues	customSortValuesImmutable
delete	diff	diffKey	diffKeyAndValue
diffRecursive	diffReverse	divide	each
end	exchangeArray	exists	fillWithDefaults
filter	filterBy	find	findBy
first	firstKey	firstsImmutable	firstsKeys
firstsMutable	flatten	flip	get
getAll	getArray	getArrayCopy	getColumn
getGenerator	getGeneratorByReference	getIterator	getIteratorClass
getKeys	getList	getObject	getPhpDocPropertiesFromClass
getRandom	getRandomKey	getRandomKeys	getRandomValue
getRandomValues	getValues	getValuesYield	group
has	hasValue	implode	implodeKeys
indexBy	indexOf	initial	intersection
intersectionMulti	intersects	invoke	isAssoc
isEmpty	isEqual	isMultiArray	isNumeric
isSequential	jsonSerialize	key	keyExists
keys	krsort	krsortImmutable	ksort
ksortImmutable	last	lastKey	lastsImmutable
lastsMutable	length	map	matches
matchesAny	max	mergeAppendKeepIndex	mergeAppendNewIndex
mergePrependKeepIndex	mergePrependNewIndex	meta	min
mostUsedValue	mostUsedValues	moveElement	moveElementToFirstPlace
moveElementToLastPlace	natcasesort	natcasesortImmutable	natsort
natsortImmutable	next	nth	offsetExists
offsetGet	offsetSet	offsetUnset	only
pad	partition	pop	prepend
prependImmutable	prependToEachKey	prependToEachValue	pull
push	randomImmutable	randomKey	randomKeys
randomMutable	randomValue	randomValues	randomWeighted
reduce	reduce_dimension	reindex	reject
remove	removeElement	removeFirst	removeLast
removeValue	repeat	replace	replaceAllKeys
replaceAllValues	replaceKeys	replaceOneValue	replaceValues
rest	reverse	rsort	rsortImmutable
searchIndex	searchValue	serialize	set
setAndGet	setIteratorClass	shift	shuffle
size	sizeIs	sizeIsBetween	sizeIsGreaterThan
sizeIsLessThan	sizeRecursive	slice	sort
sortImmutable	sortKeys	sortKeysImmutable	sortValueKeepIndex
sortValueNewIndex	sorter	splice	split
stripEmpty	swap	toArray	toJson
toList	toPermutation	toString	uasort
uasortImmutable	uksort	uksortImmutable	unique
uniqueKeepIndex	uniqueNewIndex	unserialize	unshift
validate	values	walk	where

add(mixed $value, int|string|null $key): static

↑ Add new values (optional using dot-notation).

Parameters:

T $value
TKey $key

Return:

static (Immutable) Return this Arrayy object, with the appended values.

append(mixed $value, mixed $key): $this

↑ Append a (key) + value to the current array.

EXAMPLE: a(['fòô' => 'bàř'])->append('foo'); // Arrayy['fòô' => 'bàř', 0 => 'foo']

Parameters:

T $value
TKey|null $key

Return:

$this (Mutable) Return this Arrayy object, with the appended values.

appendArrayValues(array $values, mixed $key): $this

↑ Append a (key) + values to the current array.

EXAMPLE: a(['fòô' => ['bàř']])->appendArrayValues(['foo1', 'foo2'], 'fòô'); // Arrayy['fòô' => ['bàř', 'foo1', 'foo2']]

Parameters:

array<array-key, T> $values
TKey|null $key

Return:

$this (Mutable) Return this Arrayy object, with the appended values.

appendImmutable(mixed $value, mixed $key): $this

↑ Append a (key) + value to the current array.

EXAMPLE: a(['fòô' => 'bàř'])->appendImmutable('foo')->getArray(); // ['fòô' => 'bàř', 0 => 'foo']

Parameters:

T $value
TKey $key

Return:

$this (Immutable) Return this Arrayy object, with the appended values.

appendToEachKey(int|string $prefix): static

↑ Add a suffix to each key.

Parameters:

int|string $prefix

Return:

static (Immutable) Return an Arrayy object, with the prefixed keys.

appendToEachValue(float|int|string $prefix): static

↑ Add a prefix to each value.

Parameters:

float|int|string $prefix

Return:

static (Immutable) Return an Arrayy object, with the prefixed values.

arsort(): $this

↑ Sort an array in reverse order and maintain index association.

Parameters: nothing

Return:

$this (Mutable) Return this Arrayy object.

arsortImmutable(): $this

↑ Sort an array in reverse order and maintain index association.

Parameters: nothing

Return:

$this (Immutable) Return this Arrayy object.

asort(int $sort_flags): $this

↑ Sort the entries by value.

Parameters:

`int $sort_flags [optional]
You may modify the behavior of the sort using the optional parameter sort_flags, for details see sort.

Return:

$this (Mutable) Return this Arrayy object.

asortImmutable(int $sort_flags): $this

↑ Sort the entries by value.

Parameters:

`int $sort_flags [optional]
You may modify the behavior of the sort using the optional parameter sort_flags, for details see sort.

Return:

$this (Immutable) Return this Arrayy object.

at(\Closure $closure): static

↑ Iterate over the current array and execute a callback for each loop.

EXAMPLE: $result = A::create(); $closure = function ($value, $key) use ($result) { $result[$key] = ':' . $value . ':'; }; a(['foo', 'bar' => 'bis'])->at($closure); // Arrayy[':foo:', 'bar' => ':bis:']

Parameters:

\Closure $closure

Return:

static (Immutable)

average(int $decimals): float|int

↑ Returns the average value of the current array.

EXAMPLE: a([-9, -8, -7, 1.32])->average(2); // -5.67

Parameters:

int $decimals The number of decimal-numbers to return.

Return:

float|int The average value.

changeKeyCase(int $case): static

↑ Changes all keys in an array.

Parameters:

int $case [optional] Either CASE_UPPER or CASE_LOWER (default)

Return:

static (Immutable)

changeSeparator(string $separator): $this

↑ Change the path separator of the array wrapper.

By default, the separator is: "."

Parameters:

string $separator Separator to set.

Return:

$this (Mutable) Return this Arrayy object.

chunk(int $size, bool $preserveKeys): static

↑ Create a chunked version of the current array.

EXAMPLE: a([-9, -8, -7, 1.32])->chunk(2); // Arrayy[[-9, -8], [-7, 1.32]]

Parameters:

int $size Size of each chunk.
bool $preserveKeys Whether array keys are preserved or no.

Return:

static (Immutable) A new array of chunks from the original array.

clean(): static

↑ Clean all falsy values from the current array.

EXAMPLE: a([-8 => -9, 1, 2 => false])->clean(); // Arrayy[-8 => -9, 1]

Parameters: nothing

Return:

static (Immutable)

clear(int|int[]|string|string[]|null $key): $this

↑ WARNING!!! -> Clear the current full array or a $key of it.

EXAMPLE: a([-8 => -9, 1, 2 => false])->clear(); // Arrayy[]

Parameters:

int|int[]|string|string[]|null $key

Return:

$this (Mutable) Return this Arrayy object, with an empty array.

contains(float|int|string $value, bool $recursive, bool $strict): bool

↑ Check if an item is in the current array.

EXAMPLE: a([1, true])->contains(true); // true

Parameters:

float|int|string $value
bool $recursive
bool $strict

Return:

bool

containsCaseInsensitive(mixed $value, bool $recursive): bool

↑ Check if an (case-insensitive) string is in the current array.

EXAMPLE: a(['E', 'é'])->containsCaseInsensitive('É'); // true

Parameters:

mixed $value
bool $recursive

Return:

bool

containsKey(int|string $key): bool

↑ Check if the given key/index exists in the array.

EXAMPLE: a([1 => true])->containsKey(1); // true

Parameters:

int|string $key key/index to search for

Return:

bool Returns true if the given key/index exists in the array, false otherwise.

containsKeys(array $needles, bool $recursive): bool

↑ Check if all given needles are present in the array as key/index.

EXAMPLE: a([1 => true])->containsKeys(array(1 => 0)); // true

Parameters:

array<array-key>|array<TKey> $needles The keys you are searching for.
bool $recursive

Return:

bool Returns true if all the given keys/indexes exists in the array, false otherwise.

containsKeysRecursive(array $needles): bool

↑ Check if all given needles are present in the array as key/index.

Parameters:

array<array-key>|array<TKey> $needles The keys you are searching for.

Return:

bool Returns true if all the given keys/indexes exists in the array, false otherwise.

containsValue(float|int|string $value): bool

↑ alias: for "Arrayy->contains()"

Parameters:

float|int|string $value

Return:

bool

containsValueRecursive(float|int|string $value): bool

↑ alias: for "Arrayy->contains($value, true)"

Parameters:

float|int|string $value

Return:

bool

containsValues(array $needles): bool

↑ Check if all given needles are present in the array.

EXAMPLE: a([1, true])->containsValues(array(1, true)); // true

Parameters:

array<mixed>|array<T> $needles

Return:

bool Returns true if all the given values exists in the array, false otherwise.

count(int $mode): int

↑ Counts all elements in an array, or something in an object.

EXAMPLE: a([-9, -8, -7, 1.32])->count(); // 4

For objects, if you have SPL installed, you can hook into count() by implementing interface {@see \Countable}. The interface has exactly one method, {@see \Countable::count()}, which returns the return value for the count() function. Please see the {@see \Array} section of the manual for a detailed explanation of how arrays are implemented and used in PHP.

Parameters:

int $mode [optional] If the optional mode parameter is set to COUNT_RECURSIVE (or 1), count will recursively count the array. This is particularly useful for counting all the elements of a multidimensional array. count does not detect infinite recursion.

Return:

`int
The number of elements in var, which is typically an array, since anything else will have one element.

If var is not an array or an object with implemented Countable interface, 1 will be returned. There is one exception, if var is &null;, 0 will be returned.

Caution: count may return 0 for a variable that isn't set, but it may also return 0 for a variable that has been initialized with an empty array. Use isset to test if a variable is set.

countValues(): static

↑ Counts all the values of an array

Parameters: nothing

Return:

`static
(Immutable) An associative Arrayy-object of values from input as keys and their count as value.

create(mixed $data, string $iteratorClass, bool $checkPropertiesInConstructor): static

↑ Creates an Arrayy object.

Parameters:

mixed $data
class-string<\Arrayy\ArrayyIterator> $iteratorClass
bool $checkPropertiesInConstructor

Return:

static (Immutable) Returns an new instance of the Arrayy object.

createByReference(array $array): $this

↑ WARNING: Creates an Arrayy object by reference.

Parameters:

array<TKey, T> $array

Return:

$this (Mutable) Return this Arrayy object.

createFromArray(array $array): static

↑ Create an new Arrayy object via JSON.

Parameters:

array<TKey, T> $array

Return:

static (Immutable) Returns an new instance of the Arrayy object.

createFromGeneratorFunction(callable $generatorFunction): static

↑ Create an new instance from a callable function which will return an Generator.

Parameters:

callable(): \Generator<TKey, T> $generatorFunction

Return:

static (Immutable) Returns an new instance of the Arrayy object.

createFromGeneratorImmutable(\Generator $generator): static

↑ Create an new instance filled with a copy of values from a "Generator"-object.

Parameters:

\Generator<TKey, T> $generator

Return:

static (Immutable) Returns an new instance of the Arrayy object.

createFromJson(string $json): static

↑ Create an new Arrayy object via JSON.

Parameters:

string $json

Return:

static (Immutable) Returns an new instance of the Arrayy object.

createFromJsonMapper(string $json): $this

↑

Parameters:

string $json

Return:

$this

createFromObject(\Traversable $object): static

↑ Create an new instance filled with values from an object that is iterable.

Parameters:

\Traversable<array-key, T> $object iterable object

Return:

static (Immutable) Returns an new instance of the Arrayy object.

createFromObjectVars(object $object): static

↑ Create an new instance filled with values from an object.

Parameters:

object $object

Return:

static (Immutable) Returns an new instance of the Arrayy object.

createFromString(string $str, string|null $delimiter, string|null $regEx): static

↑ Create an new Arrayy object via string.

Parameters:

string $str The input string.
string|null $delimiter The boundary string.
string|null $regEx Use the $delimiter or the $regEx, so if $pattern is null, $delimiter will be used.

Return:

static (Immutable) Returns an new instance of the Arrayy object.

createFromTraversableImmutable(\Traversable $traversable, bool $use_keys): static

↑ Create an new instance filled with a copy of values from a "Traversable"-object.

Parameters:

\Traversable<(array-key|TKey), T> $traversable
`bool $use_keys [optional]
Whether to use the iterator element keys as index.

Return:

static (Immutable) Returns an new instance of the Arrayy object.

createWithRange(float|int|string $low, float|int|string $high, float|int $step): static

↑ Create an new instance containing a range of elements.

Parameters:

float|int|string $low First value of the sequence.
float|int|string $high The sequence is ended upon reaching the end value.
float|int $step Used as the increment between elements in the sequence.

Return:

static (Immutable) Returns an new instance of the Arrayy object.

current(): false|mixed

↑ Gets the element of the array at the current internal iterator position.

Parameters: nothing

Return:

false|mixed

customSortKeys(callable $function): $this

↑ Custom sort by index via "uksort".

EXAMPLE: $callable = function ($a, $b) { if ($a == $b) { return 0; } return ($a > $b) ? 1 : -1; }; $arrayy = a(['three' => 3, 'one' => 1, 'two' => 2]); $resultArrayy = $arrayy->customSortKeys($callable); // Arrayy['one' => 1, 'three' => 3, 'two' => 2]

Parameters:

callable $function

Return:

$this (Mutable) Return this Arrayy object.

customSortKeysImmutable(callable $function): $this

↑ Custom sort by index via "uksort".

Parameters:

callable $function

Return:

$this (Immutable) Return this Arrayy object.

customSortValues(callable $function): $this

↑ Custom sort by value via "usort".

EXAMPLE: $callable = function ($a, $b) { if ($a == $b) { return 0; } return ($a > $b) ? 1 : -1; }; $arrayy = a(['three' => 3, 'one' => 1, 'two' => 2]); $resultArrayy = $arrayy->customSortValues($callable); // Arrayy['one' => 1, 'two' => 2, 'three' => 3]

Parameters:

callable $function

Return:

$this (Mutable) Return this Arrayy object.

customSortValuesImmutable(callable $function): $this

↑ Custom sort by value via "usort".

Parameters:

callable $function

Return:

$this (Immutable) Return this Arrayy object.

delete(int|int[]|string|string[] $keyOrKeys): void

↑ Delete the given key or keys.

Parameters:

int|int[]|string|string[] $keyOrKeys

Return:

void

diff(array $array): static

↑ Return elements where the values that are only in the current array.

EXAMPLE: a([1 => 1, 2 => 2])->diff([1 => 1]); // Arrayy[2 => 2]

Parameters:

array<TKey, T> ...$array

Return:

static (Immutable)

diffKey(array $array): static

↑ Return elements where the keys are only in the current array.

Parameters:

array<TKey, T> ...$array

Return:

static (Immutable)

diffKeyAndValue(array $array): static

↑ Return elements where the values and keys are only in the current array.

Parameters:

array<TKey, T> ...$array

Return:

static (Immutable)

diffRecursive(array $array, array|\Generator|null $helperVariableForRecursion): static

↑ Return elements where the values are only in the current multi-dimensional array.

EXAMPLE: a([1 => [1 => 1], 2 => [2 => 2]])->diffRecursive([1 => [1 => 1]]); // Arrayy[2 => [2 => 2]]

Parameters:

array<TKey, T> $array
null|array<TKey, T>|\Generator<TKey, T> $helperVariableForRecursion (only for internal usage)

Return:

static (Immutable)

diffReverse(array $array): static

↑ Return elements where the values that are only in the new $array.

EXAMPLE: a([1 => 1])->diffReverse([1 => 1, 2 => 2]); // Arrayy[2 => 2]

Parameters:

array<TKey, T> $array

Return:

static (Immutable)

divide(): static

↑ Divide an array into two arrays. One with keys and the other with values.

EXAMPLE: a(['a' => 1, 'b' => ''])->divide(); // Arrayy[Arrayy['a', 'b'], Arrayy[1, '']]

Parameters: nothing

Return:

static (Immutable)

each(\Closure $closure): static

↑ Iterate over the current array and modify the array's value.

EXAMPLE: $result = A::create(); $closure = function ($value) { return ':' . $value . ':'; }; a(['foo', 'bar' => 'bis'])->each($closure); // Arrayy[':foo:', 'bar' => ':bis:']

Parameters:

\Closure(T = default): T|\Closure(T = default, TKey = default): T $closure

Return:

static (Immutable)

end(): false|mixed

↑ Sets the internal iterator to the last element in the array and returns this element.

Parameters: nothing

Return:

false|mixed

exchangeArray(array|mixed|static $data): array

↑ Exchange the array for another one.

Parameters:

`T|array<TKey, T>|self<TKey, T> $data 1. use the current array, if it's a array

fallback to empty array, if there is nothing
call "getArray()" on object, if there is a "Arrayy"-object
call "createFromObject()" on object, if there is a "\Traversable"-object
call "__toArray()" on object, if the method exists
cast a string or object with "__toString()" into an array
throw a "InvalidArgumentException"-Exception`

Return:

array

exists(\Closure $closure): bool

↑ Check if a value is in the current array using a closure.

EXAMPLE: $callable = function ($value, $key) { return 2 === $key and 'two' === $value; }; a(['foo', 2 => 'two'])->exists($callable); // true

Parameters:

\Closure(T = default, TKey = default): bool $closure

Return:

bool Returns true if the given value is found, false otherwise.

fillWithDefaults(int $num, mixed $default): static

↑ Fill the array until "$num" with "$default" values.

EXAMPLE: a(['bar'])->fillWithDefaults(3, 'foo'); // Arrayy['bar', 'foo', 'foo']

Parameters:

int $num
T $default

Return:

static (Immutable)

filter(\Closure|null $closure, int $flag): static

↑ Find all items in an array that pass the truth test.

EXAMPLE: $closure = function ($value) { return $value % 2 !== 0; } a([1, 2, 3, 4])->filter($closure); // Arrayy[0 => 1, 2 => 3]

Parameters:

`null|\Closure(T = default, TKey = default): bool|\Closure(T = default): bool|\Closure(TKey = default): bool $closure [optional]
The callback function to use

If no callback is supplied, all entries of input equal to false (see converting to boolean) will be removed.

` - `int $flag [optional]

Flag determining what arguments are sent to callback:

ARRAY_FILTER_USE_KEY (1) - pass key as the only argument to callback instead of the value
ARRAY_FILTER_USE_BOTH (2) - pass both value and key as arguments to callback instead of the value

Return:

static (Immutable)

filterBy(string $property, mixed $value, string|null $comparisonOp): static

↑ Filters an array of objects (or a numeric array of associative arrays) based on the value of a particular property within that.

Parameters:

string $property
array|T $value
`string|null $comparisonOp
'eq' (equals),
'gt' (greater),
'gte' || 'ge' (greater or equals),
'lt' (less),
'lte' || 'le' (less or equals),
'ne' (not equals),
'contains',
'notContains',
'newer' (via strtotime),
'older' (via strtotime),

Return:

static (Immutable)

find(\Closure $closure): false|mixed

↑ Find the first item in an array that passes the truth test, otherwise return false.

EXAMPLE: $search = 'foo'; $closure = function ($value, $key) use ($search) { return $value === $search; }; a(['foo', 'bar', 'lall'])->find($closure); // 'foo'

Parameters:

\Closure(T = default, TKey = default): bool $closure

Return:

false|mixed Return false if we did not find the value.

findBy(string $property, mixed $value, string $comparisonOp): static

↑ find by .

EXAMPLE: $array = [ 0 => ['id' => 123, 'name' => 'foo', 'group' => 'primary', 'value' => 123456, 'when' => '2014-01-01'], 1 => ['id' => 456, 'name' => 'bar', 'group' => 'primary', 'value' => 1468, 'when' => '2014-07-15'], ]; a($array)->filterBy('name', 'foo'); // Arrayy[0 => ['id' => 123, 'name' => 'foo', 'group' => 'primary', 'value' => 123456, 'when' => '2014-01-01']]

Parameters:

string $property
array|T $value
string $comparisonOp

Return:

static (Immutable)

first(): mixed|null

↑ Get the first value from the current array.

EXAMPLE: a([2 => 'foo', 3 => 'bar', 4 => 'lall'])->first(); // 'foo'

Parameters: nothing

Return:

mixed|null Return null if there wasn't a element.

firstKey(): mixed|null

↑ Get the first key from the current array.

Parameters: nothing

Return:

mixed|null Return null if there wasn't a element.

firstsImmutable(int|null $number): static

↑ Get the first value(s) from the current array.

And will return an empty array if there was no first entry.

EXAMPLE: a([2 => 'foo', 3 => 'bar', 4 => 'lall'])->firstsImmutable(2); // Arrayy[0 => 'foo', 1 => 'bar']

Parameters:

int|null $number How many values you will take?

Return:

static (Immutable)

firstsKeys(int|null $number): static

↑ Get the first value(s) from the current array.

And will return an empty array if there was no first entry.

Parameters:

int|null $number How many values you will take?

Return:

static (Immutable)

firstsMutable(int|null $number): $this

↑ Get and remove the first value(s) from the current array.

And will return an empty array if there was no first entry.

EXAMPLE: a([2 => 'foo', 3 => 'bar', 4 => 'lall'])->firstsMutable(); // 'foo'

Parameters:

int|null $number How many values you will take?

Return:

$this (Mutable)

flatten(string $delimiter, string $prepend, array|null $items): array

↑ Flatten an array with the given character as a key delimiter.

EXAMPLE: $dot = a(['foo' => ['abc' => 'xyz', 'bar' => ['baz']]]); $flatten = $dot->flatten(); $flatten['foo.abc']; // 'xyz' $flatten['foo.bar.0']; // 'baz'

Parameters:

string $delimiter
string $prepend
array|null $items

Return:

array

flip(): static

↑ Exchanges all keys with their associated values in an array.

EXAMPLE: a([0 => 'foo', 1 => 'bar'])->flip(); // Arrayy['foo' => 0, 'bar' => 1]

Parameters: nothing

Return:

static (Immutable)

get(int|string $key, mixed $fallback, array|null $array, bool $useByReference): mixed|static

↑ Get a value from an array (optional using dot-notation).

EXAMPLE: $arrayy = a(['user' => ['lastname' => 'Moelleken']]); $arrayy->get('user.lastname'); // 'Moelleken' // --- $arrayy = new A(); $arrayy['user'] = ['lastname' => 'Moelleken']; $arrayy['user.firstname'] = 'Lars'; $arrayy['user']['lastname']; // Moelleken $arrayy['user.lastname']; // Moelleken $arrayy['user.firstname']; // Lars

Parameters:

array-key $key The key to look for.
mixed $fallback Value to fallback to.
array<array-key, mixed>|array<TKey, T> $array The array to get from, if it's set to "null" we use the current array from the class.
bool $useByReference

Return:

mixed|static

getAll(): array

↑ alias: for "Arrayy->toArray()"

Parameters: nothing

Return:

array

getArray(bool $convertAllArrayyElements, bool $preserveKeys): array

↑ Get the current array from the "Arrayy"-object.

alias for "toArray()"

Parameters:

`bool $convertAllArrayyElements
Convert all Child-"Arrayy" objects also to arrays.

` - `bool $preserveKeys

e.g.: A generator maybe return the same key more then once, so maybe you will ignore the keys.

Return:

array

getArrayCopy(): array

↑ Creates a copy of the ArrayyObject.

Parameters: nothing

Return:

array

getColumn(int|string|null $columnKey, int|string|null $indexKey): static

↑ Returns the values from a single column of the input array, identified by the $columnKey, can be used to extract data-columns from multi-arrays.

EXAMPLE: a([['foo' => 'bar', 'id' => 1], ['foo => 'lall', 'id' => 2]])->getColumn('foo', 'id'); // Arrayy[1 => 'bar', 2 => 'lall']

INFO: Optionally, you may provide an $indexKey to index the values in the returned array by the values from the $indexKey column in the input array.

Parameters:

int|string|null $columnKey
int|string|null $indexKey

Return:

static (Immutable)

getGenerator(): Generator

↑ Get the current array from the "Arrayy"-object as generator.

Parameters: nothing

Return:

\Generator

getGeneratorByReference(): Generator

↑ Get the current array from the "Arrayy"-object as generator by reference.

Parameters: nothing

Return:

\Generator

getIterator(): Iterator<mixed,mixed>

↑ Returns a new iterator, thus implementing the \Iterator interface.

EXAMPLE: a(['foo', 'bar'])->getIterator(); // ArrayyIterator['foo', 'bar']

Parameters: nothing

Return:

\Iterator<mixed,mixed> An iterator for the values in the array.

getIteratorClass(): string

↑ Gets the iterator classname for the ArrayObject.

Parameters: nothing

Return:

string

getKeys(): static

↑ alias: for "Arrayy->keys()"

Parameters: nothing

Return:

static (Immutable)

getList(bool $convertAllArrayyElements): array

↑ Get the current array from the "Arrayy"-object as list.

alias for "toList()"

Parameters:

`bool $convertAllArrayyElements
Convert all Child-"Arrayy" objects also to arrays.

Return:

array

getObject(): stdClass

↑ Get the current array from the "Arrayy"-object as object.

Parameters: nothing

Return:

\stdClass

getPhpDocPropertiesFromClass():

↑

Parameters: nothing

Return:

TODO: __not_detected__

getRandom(): static

↑ alias: for "Arrayy->randomImmutable()"

Parameters: nothing

Return:

static (Immutable)

getRandomKey(): null|mixed

↑ alias: for "Arrayy->randomKey()"

Parameters: nothing

Return:

null|mixed Get a key/index or null if there wasn't a key/index.

getRandomKeys(int $number): static

↑ alias: for "Arrayy->randomKeys()"

Parameters:

int $number

Return:

static (Immutable)

getRandomValue(): null|mixed

↑ alias: for "Arrayy->randomValue()"

Parameters: nothing

Return:

null|mixed Get a random value or null if there wasn't a value.

getRandomValues(int $number): static

↑ alias: for "Arrayy->randomValues()"

Parameters:

int $number

Return:

static (Immutable)

getValues(): static

↑ Gets all values.

Parameters: nothing

Return:

static The values of all elements in this array, in the order they appear in the array.

getValuesYield(): Generator

↑ Gets all values via Generator.

Parameters: nothing

Return:

\Generator The values of all elements in this array, in the order they appear in the array as Generator.

group(callable|string $grouper, bool $saveKeys): static

↑ Group values from a array according to the results of a closure.

Parameters:

callable|string $grouper A callable function name.
bool $saveKeys

Return:

static (Immutable)

has(mixed $key): bool

↑ Check if an array has a given key.

Parameters:

null|TKey|array-key $key

Return:

bool

hasValue(mixed $value): bool

↑ Check if an array has a given value.

INFO: If you need to search recursive please use contains($value, true).

Parameters:

T $value

Return:

bool

implode(string $glue, string $prefix): string

↑ Implodes the values of this array.

EXAMPLE: a([0 => -9, 1, 2])->implode('|'); // '-9|1|2'

Parameters:

string $glue
string $prefix

Return:

string

implodeKeys(string $glue): string

↑ Implodes the keys of this array.

Parameters:

string $glue

Return:

string

indexBy(int|string $key): static

↑ Given a list and an iterate-function that returns a key for each element in the list (or a property name), returns an object with an index of each item.

Parameters:

array-key $key

Return:

static (Immutable)

indexOf(mixed $value): false|int|string

↑ alias: for "Arrayy->searchIndex()"

Parameters:

T $value The value to search for.

Return:

false|int|string

initial(int $to): static

↑ Get everything but the last.

.$to items.

EXAMPLE: a([2 => 'foo', 3 => 'bar', 4 => 'lall'])->initial(2); // Arrayy[0 => 'foo']

Parameters:

int $to

Return:

static (Immutable)

intersection(array $search, bool $keepKeys): static

↑ Return an array with all elements found in input array.

EXAMPLE: a(['foo', 'bar'])->intersection(['bar', 'baz']); // Arrayy['bar']

Parameters:

array<TKey, T> $search
bool $keepKeys

Return:

static (Immutable)

intersectionMulti(array $array): static

↑ Return an array with all elements found in input array.

Parameters:

array<array<TKey, T>> ...$array

Return:

static (Immutable)

intersects(array $search): bool

↑ Return a boolean flag which indicates whether the two input arrays have any common elements.

EXAMPLE: a(['foo', 'bar'])->intersects(['föö', 'bär']); // false

Parameters:

array<TKey, T> $search

Return:

bool

invoke(callable $callable, mixed $arguments): static

↑ Invoke a function on all of an array's values.

Parameters:

callable(T = default, mixed ): mixed $callable
mixed $arguments

Return:

static (Immutable)

isAssoc(bool $recursive): bool

↑ Check whether array is associative or not.

EXAMPLE: a(['foo' => 'bar', 2, 3])->isAssoc(); // true

Parameters:

bool $recursive

Return:

bool Returns true if associative, false otherwise.

isEmpty(int|int[]|string|string[]|null $keys): bool

↑ Check if a given key or keys are empty.

Parameters:

int|int[]|string|string[]|null $keys

Return:

bool Returns true if empty, false otherwise.

isEqual(array $array): bool

↑ Check if the current array is equal to the given "$array" or not.

EXAMPLE: a(['💩'])->isEqual(['💩']); // true

Parameters:

array<array-key, mixed> $array

Return:

bool

isMultiArray(): bool

↑ Check if the current array is a multi-array.

EXAMPLE: a(['foo' => [1, 2 , 3]])->isMultiArray(); // true

Parameters: nothing

Return:

bool

isNumeric(): bool

↑ Check whether array is numeric or not.

Parameters: nothing

Return:

bool Returns true if numeric, false otherwise.

isSequential(bool $recursive): bool

↑ Check if the current array is sequential [0, 1, 2, 3, 4, 5 .

..] or not.

EXAMPLE: a([0 => 'foo', 1 => 'lall', 2 => 'foobar'])->isSequential(); // true

INFO: If the array is empty we count it as non-sequential.

Parameters:

bool $recursive

Return:

bool

jsonSerialize(): array

↑

Parameters: nothing

Return:

array

key(): int|string|null

↑ Gets the key/index of the element at the current internal iterator position.

Parameters: nothing

Return:

int|string|null

keyExists(int|string $key): bool

↑ Checks if the given key exists in the provided array.

INFO: This method only use "array_key_exists()" if you want to use "dot"-notation, then you need to use "Arrayy->offsetExists()".

Parameters:

int|string $key the key to look for

Return:

bool

keys(bool $recursive, mixed|null $search_values, bool $strict): static

↑ Get all keys from the current array.

EXAMPLE: a([1 => 'foo', 2 => 'foo2', 3 => 'bar'])->keys(); // Arrayy[1, 2, 3]

Parameters:

`bool $recursive [optional]
Get all keys, also from all sub-arrays from an multi-dimensional array.

` - `null|T|T[] $search_values [optional]

If specified, then only keys containing these values are returned.

` - `bool $strict [optional]

Determines if strict comparison (===) should be used during the search.

Return:

static (Immutable) An array of all the keys in input.

krsort(int $sort_flags): $this

↑ Sort an array by key in reverse order.

Parameters:

`int $sort_flags [optional]
You may modify the behavior of the sort using the optional parameter sort_flags, for details see sort.

Return:

$this (Mutable) Return this Arrayy object.

krsortImmutable(int $sort_flags): $this

↑ Sort an array by key in reverse order.

Parameters:

`int $sort_flags [optional]
You may modify the behavior of the sort using the optional parameter sort_flags, for details see sort.

Return:

$this (Immutable) Return this Arrayy object.

ksort(int $sort_flags): $this

↑ Sort the entries by key.

Parameters:

`int $sort_flags [optional]
You may modify the behavior of the sort using the optional parameter sort_flags, for details see sort.

Return:

$this (Mutable) Return this Arrayy object.

ksortImmutable(int $sort_flags): $this

↑ Sort the entries by key.

Parameters:

`int $sort_flags [optional]
You may modify the behavior of the sort using the optional parameter sort_flags, for details see sort.

Return:

$this (Immutable) Return this Arrayy object.

last(): mixed|null

↑ Get the last value from the current array.

EXAMPLE: a([2 => 'foo', 3 => 'bar', 4 => 'lall'])->last(); // 'lall'

Parameters: nothing

Return:

mixed|null Return null if there wasn't a element.

lastKey(): mixed|null

↑ Get the last key from the current array.

Parameters: nothing

Return:

mixed|null Return null if there wasn't a element.

lastsImmutable(int|null $number): static

↑ Get the last value(s) from the current array.

EXAMPLE: a([2 => 'foo', 3 => 'bar', 4 => 'lall'])->lasts(2); // Arrayy[0 => 'bar', 1 => 'lall']

Parameters:

int|null $number

Return:

static (Immutable)

lastsMutable(int|null $number): $this

↑ Get the last value(s) from the current array.

EXAMPLE: a([2 => 'foo', 3 => 'bar', 4 => 'lall'])->lasts(2); // Arrayy[0 => 'bar', 1 => 'lall']

Parameters:

int|null $number

Return:

$this (Mutable)

length(int $mode): int

↑ Count the values from the current array.

alias: for "Arrayy->count()"

Parameters:

int $mode

Return:

int

map(callable $callable, bool $useKeyAsSecondParameter, mixed $arguments): static

↑ Apply the given function to the every element of the array, collecting the results.

EXAMPLE: a(['foo', 'Foo'])->map('mb_strtoupper'); // Arrayy['FOO', 'FOO']

Parameters:

callable(T , TKey = default, mixed = default): T2 $callable
bool $useKeyAsSecondParameter
mixed ...$arguments

Return:

static (Immutable) Arrayy object with modified elements.

matches(\Closure $closure): bool

↑ Check if all items in current array match a truth test.

EXAMPLE: $closure = function ($value, $key) { return ($value % 2 === 0); }; a([2, 4, 8])->matches($closure); // true

Parameters:

\Closure(T = default, TKey = default): bool $closure

Return:

bool

matchesAny(\Closure $closure): bool

↑ Check if any item in the current array matches a truth test.

EXAMPLE: $closure = function ($value, $key) { return ($value % 2 === 0); }; a([1, 4, 7])->matches($closure); // true

Parameters:

\Closure(T = default, TKey = default): bool $closure

Return:

bool

max(): false|float|int|string

↑ Get the max value from an array.

EXAMPLE: a([-9, -8, -7, 1.32])->max(); // 1.32

Parameters: nothing

Return:

false|float|int|string Will return false if there are no values.

mergeAppendKeepIndex(array $array, bool $recursive): static

↑ Merge the new $array into the current array.

keep key,value from the current array, also if the index is in the new $array

EXAMPLE: $array1 = [1 => 'one', 'foo' => 'bar1']; $array2 = ['foo' => 'bar2', 3 => 'three']; a($array1)->mergeAppendKeepIndex($array2); // Arrayy[1 => 'one', 'foo' => 'bar2', 3 => 'three'] // --- $array1 = [0 => 'one', 1 => 'foo']; $array2 = [0 => 'foo', 1 => 'bar2']; a($array1)->mergeAppendKeepIndex($array2); // Arrayy[0 => 'foo', 1 => 'bar2']

Parameters:

array<(int|TKey), T> $array
bool $recursive

Return:

static (Immutable)

mergeAppendNewIndex(array $array, bool $recursive): static

↑ Merge the new $array into the current array.

replace duplicate assoc-keys from the current array with the key,values from the new $array
create new indexes

EXAMPLE: $array1 = [1 => 'one', 'foo' => 'bar1']; $array2 = ['foo' => 'bar2', 3 => 'three']; a($array1)->mergeAppendNewIndex($array2); // Arrayy[0 => 'one', 'foo' => 'bar2', 1 => 'three'] // --- $array1 = [0 => 'one', 1 => 'foo']; $array2 = [0 => 'foo', 1 => 'bar2']; a($array1)->mergeAppendNewIndex($array2); // Arrayy[0 => 'one', 1 => 'foo', 2 => 'foo', 3 => 'bar2']

Parameters:

array<TKey, T> $array
bool $recursive

Return:

static (Immutable)

mergePrependKeepIndex(array $array, bool $recursive): static

↑ Merge the the current array into the $array.

use key,value from the new $array, also if the index is in the current array

EXAMPLE: $array1 = [1 => 'one', 'foo' => 'bar1']; $array2 = ['foo' => 'bar2', 3 => 'three']; a($array1)->mergePrependKeepIndex($array2); // Arrayy['foo' => 'bar1', 3 => 'three', 1 => 'one'] // --- $array1 = [0 => 'one', 1 => 'foo']; $array2 = [0 => 'foo', 1 => 'bar2']; a($array1)->mergePrependKeepIndex($array2); // Arrayy[0 => 'one', 1 => 'foo']

Parameters:

array<TKey, T> $array
bool $recursive

Return:

static (Immutable)

mergePrependNewIndex(array $array, bool $recursive): static

↑ Merge the current array into the new $array.

replace duplicate assoc-keys from new $array with the key,values from the current array
create new indexes

EXAMPLE: $array1 = [1 => 'one', 'foo' => 'bar1']; $array2 = ['foo' => 'bar2', 3 => 'three']; a($array1)->mergePrependNewIndex($array2); // Arrayy['foo' => 'bar1', 0 => 'three', 1 => 'one'] // --- $array1 = [0 => 'one', 1 => 'foo']; $array2 = [0 => 'foo', 1 => 'bar2']; a($array1)->mergePrependNewIndex($array2); // Arrayy[0 => 'foo', 1 => 'bar2', 2 => 'one', 3 => 'foo']

Parameters:

array<TKey, T> $array
bool $recursive

Return:

static (Immutable)

meta(): ArrayyMeta|mixed|static

↑

Parameters: nothing

Return:

\ArrayyMeta|mixed|static

min(): false|mixed

↑ Get the min value from an array.

EXAMPLE: a([-9, -8, -7, 1.32])->min(); // -9

Parameters: nothing

Return:

false|mixed Will return false if there are no values.

mostUsedValue(): mixed|null

↑ Get the most used value from the array.

Parameters: nothing

Return:

mixed|null (Immutable) Return null if there wasn't a element.

mostUsedValues(int|null $number): static

↑ Get the most used value from the array.

Parameters:

int|null $number How many values you will take?

Return:

static (Immutable)

moveElement(int|string $from, int $to): static

↑ Move an array element to a new index.

EXAMPLE: $arr2 = new A(['A' => 'a', 'B' => 'b', 'C' => 'c', 'D' => 'd', 'E' => 'e']); $newArr2 = $arr2->moveElement('D', 1); // Arrayy['A' => 'a', 'D' => 'd', 'B' => 'b', 'C' => 'c', 'E' => 'e']

Parameters:

int|string $from
int $to

Return:

static (Immutable)

moveElementToFirstPlace(int|string $key): static

↑ Move an array element to the first place.

INFO: Instead of "Arrayy->moveElement()" this method will NOT loss the keys of an indexed array.

Parameters:

int|string $key

Return:

static (Immutable)

moveElementToLastPlace(int|string $key): static

↑ Move an array element to the last place.

INFO: Instead of "Arrayy->moveElement()" this method will NOT loss the keys of an indexed array.

Parameters:

int|string $key

Return:

static (Immutable)

natcasesort(): $this

↑ Sort an array using a case insensitive "natural order" algorithm.

Parameters: nothing

Return:

$this (Mutable) Return this Arrayy object.

natcasesortImmutable(): $this

↑ Sort an array using a case insensitive "natural order" algorithm.

Parameters: nothing

Return:

$this (Immutable) Return this Arrayy object.

natsort(): $this

↑ Sort entries using a "natural order" algorithm.

Parameters: nothing

Return:

$this (Mutable) Return this Arrayy object.

natsortImmutable(): $this

↑ Sort entries using a "natural order" algorithm.

Parameters: nothing

Return:

$this (Immutable) Return this Arrayy object.

next(): false|mixed

↑ Moves the internal iterator position to the next element and returns this element.

Parameters: nothing

Return:

false|mixed (Mutable) Will return false if there are no values.

nth(int $step, int $offset): static

↑ Get the next nth keys and values from the array.

Parameters:

int $step
int $offset

Return:

static (Immutable)

offsetExists(bool|int|string $offset): bool

↑ Whether or not an offset exists.

Parameters:

bool|int|string $offset

Return:

bool

offsetGet(int|string $offset): mixed

↑ Returns the value at specified offset.

Parameters:

TKey $offset

Return:

mixed Will return null if the offset did not exists.

offsetSet(int|string|null $offset, mixed $value): void

↑ Assigns a value to the specified offset + check the type.

Parameters:

int|string|null $offset
mixed $value

Return:

void

offsetUnset(int|string $offset): void

↑ Unset an offset.

Parameters:

int|string $offset

Return:

void (Mutable) Return nothing.

only(int[]|string[] $keys): static

↑ Get a subset of the items from the given array.

Parameters:

array-key[] $keys

Return:

static (Immutable)

pad(int $size, mixed $value): static

↑ Pad array to the specified size with a given value.

Parameters:

int $size Size of the result array.
mixed $value Empty value by default.

Return:

static (Immutable) Arrayy object padded to $size with $value.

partition(\Closure $closure): array<int,static>

↑ Partitions this array in two array according to a predicate.

Keys are preserved in the resulting array.

Parameters:

\Closure(T = default, TKey = default): bool $closure The predicate on which to partition.

Return:

array<int,static> An array with two elements. The first element contains the array of elements where the predicate returned TRUE, the second element contains the array of elements where the predicate returned FALSE.

pop(): mixed|null

↑ Pop a specified value off the end of the current array.

Parameters: nothing

Return:

mixed|null (Mutable) The popped element from the current array or null if the array is e.g. empty.

prepend(mixed $value, mixed $key): $this

↑ Prepend a (key) + value to the current array.

EXAMPLE: a(['fòô' => 'bàř'])->prepend('foo'); // Arrayy[0 => 'foo', 'fòô' => 'bàř']

Parameters:

T $value
TKey|null $key

Return:

$this (Mutable) Return this Arrayy object, with the prepended value.

prependImmutable(mixed $value, mixed $key): $this

↑ Prepend a (key) + value to the current array.

EXAMPLE: a(['fòô' => 'bàř'])->prependImmutable('foo')->getArray(); // [0 => 'foo', 'fòô' => 'bàř']

Parameters:

T $value
TKey $key

Return:

$this (Immutable) Return this Arrayy object, with the prepended value.

prependToEachKey(float|int|string $suffix): static

↑ Add a suffix to each key.

Parameters:

float|int|string $suffix

Return:

static (Immutable) Return an Arrayy object, with the prepended keys.

prependToEachValue(float|int|string $suffix): static

↑ Add a suffix to each value.

Parameters:

float|int|string $suffix

Return:

static (Immutable) Return an Arrayy object, with the prepended values.

pull(int|int[]|string|string[]|null $keyOrKeys, mixed $fallback): mixed

↑ Return the value of a given key and delete the key.

Parameters:

int|int[]|string|string[]|null $keyOrKeys
mixed $fallback

Return:

mixed

push(mixed $args): $this

↑ Push one or more values onto the end of array at once.

Parameters:

array<TKey, T> ...$args

Return:

$this (Mutable) Return this Arrayy object, with pushed elements to the end of array.

randomImmutable(int|null $number): static

↑ Get a random value from the current array.

EXAMPLE: a([1, 2, 3, 4])->randomImmutable(2); // e.g.: Arrayy[1, 4]

Parameters:

int|null $number How many values you will take?

Return:

static (Immutable)

randomKey(): null|mixed

↑ Pick a random key/index from the keys of this array.

EXAMPLE: $arrayy = A::create([1 => 'one', 2 => 'two']); $arrayy->randomKey(); // e.g. 2

Parameters: nothing

Return:

null|mixed Get a key/index or null if there wasn't a key/index.

randomKeys(int $number): static

↑ Pick a given number of random keys/indexes out of this array.

EXAMPLE: a([1 => 'one', 2 => 'two'])->randomKeys(); // e.g. Arrayy[1, 2]

Parameters:

int $number The number of keys/indexes (should be <= \count($this->array))

Return:

static (Immutable)

randomMutable(int|null $number): $this

↑ Get a random value from the current array.

EXAMPLE: a([1, 2, 3, 4])->randomMutable(2); // e.g.: Arrayy[1, 4]

Parameters:

int|null $number How many values you will take?

Return:

$this (Mutable) Return this Arrayy object.

randomValue(): mixed

↑ Pick a random value from the values of this array.

EXAMPLE: a([1 => 'one', 2 => 'two'])->randomValue(); // e.g. 'one'

Parameters: nothing

Return:

mixed Get a random value or null if there wasn't a value.

randomValues(int $number): static

↑ Pick a given number of random values out of this array.

EXAMPLE: a([1 => 'one', 2 => 'two'])->randomValues(); // e.g. Arrayy['one', 'two']

Parameters:

int $number

Return:

static (Mutable)

randomWeighted(array $array, int $number):

↑

Parameters:

array $array
int $number

Return:

self

reduce(callable $callable, mixed $initial): static

↑ Reduce the current array via callable e.g. anonymous-function and return the end result.

EXAMPLE: a([1, 2, 3, 4])->reduce( function ($carry, $item) { return $carry * $item; }, 1 ); // Arrayy[24]

Parameters:

callable(T2 , T , TKey ): T2 $callable
T2 $initial

Return:

static (Immutable)

reduce_dimension(bool $unique): static

↑

Parameters:

bool $unique

Return:

static (Immutable)

reindex(): $this

↑ Create a numerically re-indexed Arrayy object.

EXAMPLE: a([2 => 1, 3 => 2])->reindex(); // Arrayy[0 => 1, 1 => 2]

Parameters: nothing

Return:

$this (Mutable) Return this Arrayy object, with re-indexed array-elements.

reject(\Closure $closure): static

↑ Return all items that fail the truth test.

EXAMPLE: $closure = function ($value) { return $value % 2 !== 0; } a([1, 2, 3, 4])->reject($closure); // Arrayy[1 => 2, 3 => 4]

Parameters:

\Closure(T = default, TKey = default): bool $closure

Return:

static (Immutable)

remove(mixed $key): static

↑ Remove a value from the current array (optional using dot-notation).

EXAMPLE: a([1 => 'bar', 'foo' => 'foo'])->remove(1); // Arrayy['foo' => 'foo']

Parameters:

TKey $key

Return:

static (Mutable)

removeElement(mixed $element): static

↑ alias: for "Arrayy->removeValue()"

Parameters:

T $element

Return:

static (Immutable)

removeFirst(): static

↑ Remove the first value from the current array.

EXAMPLE: a([1 => 'bar', 'foo' => 'foo'])->removeFirst(); // Arrayy['foo' => 'foo']

Parameters: nothing

Return:

static (Immutable)

removeLast(): static

↑ Remove the last value from the current array.

EXAMPLE: a([1 => 'bar', 'foo' => 'foo'])->removeLast(); // Arrayy[1 => 'bar']

Parameters: nothing

Return:

static (Immutable)

removeValue(mixed $value): static

↑ Removes a particular value from an array (numeric or associative).

EXAMPLE: a([1 => 'bar', 'foo' => 'foo'])->removeValue('foo'); // Arrayy[1 => 'bar']

Parameters:

T $value

Return:

static (Immutable)

repeat(int $times): static

↑ Generate array of repeated arrays.

Parameters:

int $times How many times has to be repeated.

Return:

static (Immutable)

replace(mixed $oldKey, mixed $newKey, mixed $newValue): static

↑ Replace a key with a new key/value pair.

EXAMPLE: $arrayy = a([1 => 'foo', 2 => 'foo2', 3 => 'bar']); $arrayy->replace(2, 'notfoo', 'notbar'); // Arrayy[1 => 'foo', 'notfoo' => 'notbar', 3 => 'bar']

Parameters:

mixed $oldKey
mixed $newKey
mixed $newValue

Return:

static (Immutable)

replaceAllKeys(int[]|string[] $keys): static

↑ Create an array using the current array as values and the other array as keys.

EXAMPLE: $firstArray = [ 1 => 'one', 2 => 'two', 3 => 'three', ]; $secondArray = [ 'one' => 1, 1 => 'one', 2 => 2, ]; $arrayy = a($firstArray); $arrayy->replaceAllKeys($secondArray); // Arrayy[1 => "one", 'one' => "two", 2 => "three"]

Parameters:

array<array-key, TKey> $keys An array of keys.

Return:

`static
(Immutable) Arrayy object with keys from the other array, empty Arrayy object if the number of elements for each array isn't equal or if the arrays are empty.

replaceAllValues(array $array): static

↑ Create an array using the current array as keys and the other array as values.

EXAMPLE: $firstArray = [ 1 => 'one', 2 => 'two', 3 => 'three', ]; $secondArray = [ 'one' => 1, 1 => 'one', 2 => 2, ]; $arrayy = a($firstArray); $arrayy->replaceAllValues($secondArray); // Arrayy['one' => 1, 'two' => 'one', 'three' => 2]

Parameters:

array<array-key, T> $array An array of values.

Return:

`static
(Immutable) Arrayy object with values from the other array, empty Arrayy object if the number of elements for each array isn't equal or if the arrays are empty.

replaceKeys(array $keys): static

↑ Replace the keys in an array with another set.

EXAMPLE: a([1 => 'bar', 'foo' => 'foo'])->replaceKeys([1 => 2, 'foo' => 'replaced']); // Arrayy[2 => 'bar', 'replaced' => 'foo']

Parameters:

array<array-key, TKey> $keys An array of keys matching the array's size.

Return:

static (Immutable)

replaceOneValue(mixed $search, mixed $replacement): static

↑ Replace the first matched value in an array.

EXAMPLE: $testArray = ['bar', 'foo' => 'foo', 'foobar' => 'foobar']; a($testArray)->replaceOneValue('foo', 'replaced'); // Arrayy['bar', 'foo' => 'replaced', 'foobar' => 'foobar']

Parameters:

mixed $search The value to replace.
mixed $replacement The value to replace.

Return:

static (Immutable)

replaceValues(string $search, string $replacement): static

↑ Replace values in the current array.

EXAMPLE: $testArray = ['bar', 'foo' => 'foo', 'foobar' => 'foobar']; a($testArray)->replaceValues('foo', 'replaced'); // Arrayy['bar', 'foo' => 'replaced', 'foobar' => 'replacedbar']

Parameters:

string $search The value to replace.
string $replacement What to replace it with.

Return:

static (Immutable)

rest(int $from): static

↑ Get the last elements from index $from until the end of this array.

EXAMPLE: a([2 => 'foo', 3 => 'bar', 4 => 'lall'])->rest(2); // Arrayy[0 => 'lall']

Parameters:

int $from

Return:

static (Immutable)

reverse(): $this

↑ Return the array in the reverse order.

EXAMPLE: a([1, 2, 3])->reverse(); // self[3, 2, 1]

Parameters: nothing

Return:

$this (Mutable) Return this Arrayy object.

rsort(int $sort_flags): $this

↑ Sort an array in reverse order.

Parameters:

`int $sort_flags [optional]
You may modify the behavior of the sort using the optional parameter sort_flags, for details see sort.

Return:

$this (Mutable) Return this Arrayy object.

rsortImmutable(int $sort_flags): $this

↑ Sort an array in reverse order.

Parameters:

`int $sort_flags [optional]
You may modify the behavior of the sort using the optional parameter sort_flags, for details see sort.

Return:

$this (Immutable) Return this Arrayy object.

searchIndex(mixed $value): false|int|string

↑ Search for the first index of the current array via $value.

EXAMPLE: a(['fòô' => 'bàř', 'lall' => 'bàř'])->searchIndex('bàř'); // Arrayy[0 => 'fòô']

Parameters:

T $value

Return:

false|int|string Will return FALSE if the value can't be found.

searchValue(mixed $index): static

↑ Search for the value of the current array via $index.

EXAMPLE: a(['fòô' => 'bàř'])->searchValue('fòô'); // Arrayy[0 => 'bàř']

Parameters:

mixed $index

Return:

static (Immutable) Will return a empty Arrayy if the value wasn't found.

serialize(): string

↑ Serialize the current "Arrayy"-object.

EXAMPLE: a([1, 4, 7])->serialize();

Parameters: nothing

Return:

string

set(string $key, mixed $value): $this

↑ Set a value for the current array (optional using dot-notation).

EXAMPLE: $arrayy = a(['Lars' => ['lastname' => 'Moelleken']]); $arrayy->set('Lars.lastname', 'Müller'); // Arrayy['Lars', ['lastname' => 'Müller']]]

Parameters:

TKey $key The key to set.
T $value Its value.

Return:

$this (Mutable) Return this Arrayy object.

setAndGet(mixed $key, mixed $fallback): mixed

↑ Get a value from a array and set it if it was not.

WARNING: this method only set the value, if the $key is not already set

EXAMPLE: $arrayy = a([1 => 1, 2 => 2, 3 => 3]); $arrayy->setAndGet(1, 4); // 1 $arrayy->setAndGet(0, 4); // 4

Parameters:

mixed $key The key
mixed $fallback The default value to set if it isn't.

Return:

mixed (Mutable)

setIteratorClass(string $iteratorClass): void

↑ Sets the iterator classname for the current "Arrayy"-object.

Parameters:

class-string<\Arrayy\ArrayyIterator> $iteratorClass

Return:

void

shift(): mixed

↑ Shifts a specified value off the beginning of array.

Parameters: nothing

Return:

mixed (Mutable) A shifted element from the current array.

shuffle(bool $secure, array|null $array): static

↑ Shuffle the current array.

EXAMPLE: a([1 => 'bar', 'foo' => 'foo'])->shuffle(); // e.g.: Arrayy[['foo' => 'foo', 1 => 'bar']]

Parameters:

bool $secure using a CSPRNG | @see https://paragonie.com/b/JvICXzh_jhLyt4y3
array<TKey, T> $array [optional]

Return:

static (Immutable)

size(int $mode): int

↑ Count the values from the current array.

alias: for "Arrayy->count()"

Parameters:

int $mode

Return:

int

sizeIs(int $size): bool

↑ Checks whether array has exactly $size items.

Parameters:

int $size

Return:

bool

sizeIsBetween(int $fromSize, int $toSize): bool

↑ Checks whether array has between $fromSize to $toSize items. $toSize can be smaller than $fromSize.

Parameters:

int $fromSize
int $toSize

Return:

bool

sizeIsGreaterThan(int $size): bool

↑ Checks whether array has more than $size items.

Parameters:

int $size

Return:

bool

sizeIsLessThan(int $size): bool

↑ Checks whether array has less than $size items.

Parameters:

int $size

Return:

bool

sizeRecursive(): int

↑ Counts all elements in an array, or something in an object.

Parameters: nothing

Return:

`int
The number of elements in var, which is typically an array, since anything else will have one element.

If var is not an array or an object with implemented Countable interface, 1 will be returned. There is one exception, if var is &null;, 0 will be returned.

Caution: count may return 0 for a variable that isn't set, but it may also return 0 for a variable that has been initialized with an empty array. Use isset to test if a variable is set.

slice(int $offset, int|null $length, bool $preserveKeys): static

↑ Extract a slice of the array.

Parameters:

int $offset Slice begin index.
int|null $length Length of the slice.
bool $preserveKeys Whether array keys are preserved or no.

Return:

static (Immutable) A slice of the original array with length $length.

sort(int|string $direction, int $strategy, bool $keepKeys): static

↑ Sort the current array and optional you can keep the keys.

EXAMPLE: a(3 => 'd', 2 => 'f', 0 => 'a')->sort(SORT_ASC, SORT_NATURAL, false); // Arrayy[0 => 'a', 1 => 'd', 2 => 'f']

Parameters:

int|string $direction use SORT_ASC (default) or SORT_DESC
int $strategy sort_flags => use e.g.: SORT_REGULAR (default) or SORT_NATURAL
bool $keepKeys

Return:

static (Mutable) Return this Arrayy object.

sortImmutable(int|string $direction, int $strategy, bool $keepKeys): static

↑ Sort the current array and optional you can keep the keys.

Parameters:

int|string $direction use SORT_ASC (default) or SORT_DESC
int $strategy sort_flags => use e.g.: SORT_REGULAR (default) or SORT_NATURAL
bool $keepKeys

Return:

static (Immutable) Return this Arrayy object.

sortKeys(int|string $direction, int $strategy): $this

↑ Sort the current array by key.

EXAMPLE: a([1 => 2, 0 => 1])->sortKeys(\SORT_ASC); // Arrayy[0 => 1, 1 => 2]

Parameters:

int|string $direction use SORT_ASC (default) or SORT_DESC
int $strategy use e.g.: SORT_REGULAR (default) or SORT_NATURAL

Return:

$this (Mutable) Return this Arrayy object.

sortKeysImmutable(int|string $direction, int $strategy): $this

↑ Sort the current array by key.

Parameters:

int|string $direction use SORT_ASC (default) or SORT_DESC
int $strategy use e.g.: SORT_REGULAR (default) or SORT_NATURAL

Return:

$this (Immutable) Return this Arrayy object.

sortValueKeepIndex(int|string $direction, int $strategy): static

↑ Sort the current array by value.

EXAMPLE: a(3 => 'd', 2 => 'f', 0 => 'a')->sortValueKeepIndex(SORT_ASC, SORT_REGULAR); // Arrayy[0 => 'a', 3 => 'd', 2 => 'f']

Parameters:

int|string $direction use SORT_ASC (default) or SORT_DESC
int $strategy use e.g.: SORT_REGULAR (default) or SORT_NATURAL

Return:

static (Mutable)

sortValueNewIndex(int|string $direction, int $strategy): static

↑ Sort the current array by value.

EXAMPLE: a(3 => 'd', 2 => 'f', 0 => 'a')->sortValueNewIndex(SORT_ASC, SORT_NATURAL); // Arrayy[0 => 'a', 1 => 'd', 2 => 'f']

Parameters:

int|string $direction use SORT_ASC (default) or SORT_DESC
int $strategy use e.g.: SORT_REGULAR (default) or SORT_NATURAL

Return:

static (Mutable)

sorter(callable|mixed|null $sorter, int|string $direction, int $strategy): static

↑ Sort a array by value or by a closure.

If the sorter is null, the array is sorted naturally.
Associative (string) keys will be maintained, but numeric keys will be re-indexed.

EXAMPLE: $testArray = range(1, 5); $under = a($testArray)->sorter( function ($value) { return $value % 2 === 0; } ); var_dump($under); // Arrayy[1, 3, 5, 2, 4]

Parameters:

callable|mixed|null $sorter
int|string $direction use SORT_ASC (default) or SORT_DESC
int $strategy use e.g.: SORT_REGULAR (default) or SORT_NATURAL

Return:

static (Immutable)

splice(int $offset, int|null $length, array $replacement): static

↑

Parameters:

int $offset
int|null $length
array<array-key, T> $replacement

Return:

static (Immutable)

split(int $numberOfPieces, bool $keepKeys): static

↑ Split an array in the given amount of pieces.

EXAMPLE: a(['a' => 1, 'b' => 2])->split(2, true); // Arrayy[['a' => 1], ['b' => 2]]

Parameters:

int $numberOfPieces
bool $keepKeys

Return:

static (Immutable)

stripEmpty(): static

↑ Strip all empty items from the current array.

EXAMPLE: a(['a' => 1, 'b' => ''])->stripEmpty(); // Arrayy[['a' => 1]]

Parameters: nothing

Return:

static (Immutable)

swap(int|string $swapA, int|string $swapB): static

↑ Swap two values between positions by key.

EXAMPLE: a(['a' => 1, 'b' => ''])->swap('a', 'b'); // Arrayy[['a' => '', 'b' => 1]]

Parameters:

int|string $swapA a key in the array
int|string $swapB a key in the array

Return:

static (Immutable)

toArray(bool $convertAllArrayyElements, bool $preserveKeys): array

↑ Get the current array from the "Arrayy"-object.

alias for "getArray()"

Parameters:

`bool $convertAllArrayyElements
Convert all Child-"Arrayy" objects also to arrays.

` - `bool $preserveKeys

e.g.: A generator maybe return the same key more then once, so maybe you will ignore the keys.

Return:

array

toJson(int $options, int $depth): string

↑ Convert the current array to JSON.

EXAMPLE: a(['bar', ['foo']])->toJson(); // '["bar",{"1":"foo"}]'

Parameters:

int $options [optional] e.g. JSON_PRETTY_PRINT
int $depth [optional] Set the maximum depth. Must be greater than zero.

Return:

string

toList(bool $convertAllArrayyElements): array

↑ Get the current array from the "Arrayy"-object as list.

Parameters:

`bool $convertAllArrayyElements
Convert all Child-"Arrayy" objects also to arrays.

Return:

array

toPermutation(string[]|null $items, string[] $helper): static|static[]

↑

Parameters:

string[]|null $items [optional]
string[] $helper [optional]

Return:

static|static[]

toString(string $separator): string

↑ Implodes array to a string with specified separator.

Parameters:

string $separator [optional] The element's separator.

Return:

string The string representation of array, separated by ",".

uasort(callable $function): $this

↑ Sort the entries with a user-defined comparison function and maintain key association.

Parameters:

callable $function

Return:

$this (Mutable) Return this Arrayy object.

uasortImmutable(callable $function): $this

↑ Sort the entries with a user-defined comparison function and maintain key association.

Parameters:

callable $function

Return:

$this (Immutable) Return this Arrayy object.

uksort(callable $function): static

↑ Sort the entries by keys using a user-defined comparison function.

Parameters:

callable $function

Return:

static (Mutable) Return this Arrayy object.

uksortImmutable(callable $function): static

↑ Sort the entries by keys using a user-defined comparison function.

Parameters:

callable $function

Return:

static (Immutable) Return this Arrayy object.

unique(): static

↑ alias: for "Arrayy->uniqueNewIndex()"

Parameters: nothing

Return:

static (Mutable) Return this Arrayy object, with the appended values.

uniqueKeepIndex(): $this

↑ Return a duplicate free copy of the current array. (with the old keys)

EXAMPLE: a([2 => 1, 3 => 2, 4 => 2])->uniqueNewIndex(); // Arrayy[2 => 1, 3 => 2]

Parameters: nothing

Return:

$this (Mutable)

uniqueNewIndex(): $this

↑ Return a duplicate free copy of the current array.

EXAMPLE: a([2 => 1, 3 => 2, 4 => 2])->uniqueNewIndex(); // Arrayy[1, 2]

Parameters: nothing

Return:

$this (Mutable)

unserialize(string $string): $this

↑ Unserialize an string and return the instance of the "Arrayy"-class.

EXAMPLE: $serialized = a([1, 4, 7])->serialize(); a()->unserialize($serialized);

Parameters:

string $string

Return:

$this

unshift(mixed $args): $this

↑ Prepends one or more values to the beginning of array at once.

Parameters:

array<TKey, T> ...$args

Return:

$this (Mutable) Return this Arrayy object, with prepended elements to the beginning of array.

validate(\Closure $closure): bool

↑ Tests whether the given closure return something valid for all elements of this array.

Parameters:

\Closure(T = default, TKey = default): bool $closure the predicate

Return:

bool TRUE, if the predicate yields TRUE for all elements, FALSE otherwise.

values(): static

↑ Get all values from a array.

EXAMPLE: $arrayy = a([1 => 'foo', 2 => 'foo2', 3 => 'bar']); $arrayyTmp->values(); // Arrayy[0 => 'foo', 1 => 'foo2', 2 => 'bar']

Parameters: nothing

Return:

static (Immutable)

walk(callable $callable, bool $recursive, mixed $userData): $this

↑ Apply the given function to every element in the array, discarding the results.

EXAMPLE: $callable = function (&$value, $key) { $value = $key; }; $arrayy = a([1, 2, 3]); $arrayy->walk($callable); // Arrayy[0, 1, 2]

Parameters:

callable $callable
bool $recursive [optional] Whether array will be walked recursively or no
`mixed $userData [optional]
If the optional $userData parameter is supplied, it will be passed as the third parameter to the $callable.

Return:

$this (Mutable) Return this Arrayy object, with modified elements.

where(string $keyOrPropertyOrMethod, mixed $value): static

↑ Returns a collection of matching items.

Parameters:

string $keyOrPropertyOrMethod The property or method to evaluate.
mixed $value The value to match.

Return:

static

Support

For support and donations please visit Github | Issues | PayPal | Patreon.

For status updates and release announcements please visit Releases | Twitter | Patreon.

For professional support please contact me.

Thanks

Thanks to GitHub (Microsoft) for hosting the code and a good infrastructure including Issues-Managment, etc.
Thanks to IntelliJ as they make the best IDEs for PHP and they gave me an open source license for PhpStorm!
Thanks to Travis CI for being the most awesome, easiest continous integration tool out there!
Thanks to StyleCI for the simple but powerfull code style check.
Thanks to PHPStan && Psalm for relly great Static analysis tools and for discover bugs in the code!

Tests

From the project directory, tests can be ran using phpunit

License

Released under the MIT License - see LICENSE.txt for details.

This PR contains the following updates:

| Package | Type | Update | Change | |---|---|---|---| | shivammathur/setup-php | action | minor | 2.17.1 -> 2.22.0 |

Release Notes

shivammathur/setup-php

`v2.22.0`

Compare Source

Support Ukraine

Added support for PHP builds with debugging symbols for PHP 5.6 and above. ^ALPHA Docs, (#634, shivammathur/homebrew-php#976)

- name: Setup PHP with debugging symbols
  uses: shivammathur/setup-php@v2
  with:
    php-version: '8.1'
  env:
    debug: true

Added support for intl extension with ICU 72.1. shivammathur/icu-intl#4

- name: Setup PHP with intl
  uses: shivammathur/setup-php@v2
  with:
    php-version: '8.1'
    extensions: intl-72.1

Existing PHP version on GitHub actions Ubuntu images is now updated if ppa:ondrej/php is missing regardless of the update environment variable. (actions/runner-images#6331).
Environment variable COMPOSER_NO_AUDIT is now set by default. If you would like to run the composer audit in your workflows, please add a step with composer audit command. (#635, #636)

- name: Composer audit
  run: composer audit

Switched to GITHUB_OUTPUT environment file for setting up outputs. If you are using setup-php on self-hosted runners, please update it to 2.297.0 or greater. More Info (#654)
Updated sqlsrv and pdo_sqlsrv version to 5.10.1 for PHP 7.0 and above on Linux.
Improved support for phalcon5 extension to set up the latest stable version.
Improved symfony-cli support to fetch the artifact URL from the brew tap on Linux. (#641, #652, #653)
Improved fetching brew taps on Linux to avoid brew's overhead.
Fixed installing extension packages on self-hosted Linux runners. (#642)
Fixed support for couchbase and firebird extensions after GitHub release page changes.
Fixed support for older versions of laravel/pint. (#647)
Updated Node.js dependencies.

Full Changelog: https://github.com/shivammathur/setup-php/compare/2.21.2...2.22.0

Thanks! @alcaeus and @jderusse for the contributions 🎉

Follow for updates

`v2.21.2`

Compare Source

Support Ukraine

Added support for rector in tools input. #627

- name: Setup PHP
  uses: shivammathur/setup-php@v2
  with:
    php-version: 8.1
    tools: rector

Added support for ast extension on macOS using shivammathur/extensions tap.

- name: Setup PHP
  uses: shivammathur/setup-php@v2
  with:
    php-version: 8.1
    extensions: ast

Fixed support for symfony-cli on Linux #632

- name: Setup PHP
  uses: shivammathur/setup-php@v2
  with:
    php-version: 8.1
    tools: symfony

Fixed installing unstable extensions from PECL. #625
Updated Node.js dependencies.

Follow for updates

`v2.21.1`

Compare Source

Support Ukraine

Fixed installing tools' old versions which are composer plugins.
Updated Node.js dependencies.

Follow for updates

`v2.21.0`

Compare Source

Support Ukraine

Added support for Laravel Pint #613, #614

- name: Setup PHP
  uses: shivammathur/setup-php@v2
  with:
    php-version: `8.1`
    tools: pint

Added support for phalcon5 for all OS. https://github.com/shivammathur/homebrew-extensions/issues/1890 Also fixed phalcon3 and phalcon4 support on Ubuntu 22.04.

- name: Setup PHP
  uses: shivammathur/setup-php@v2
  with:
    php-version: `8.1`
    extensions: phalcon5

Added support for Private Packagist authentication for composer. Docs

- name: Setup PHP
  uses: shivammathur/setup-php@v2
  with:
    php-version: '8.1'
  env:
    PACKAGIST_TOKEN: ${{ secrets.PACKAGIST_TOKEN }}

Added support for manual JSON-based authentication for composer Docs

- name: Setup PHP
  uses: shivammathur/setup-php@v2
  with:
    php-version: '8.1'
  env:
    COMPOSER_AUTH_JSON: |
      {
        "http-basic": {
          "example.org": {
            "username": "${{ secrets.EXAMPLE_ORG_USERNAME }}",
            "password": "${{ secrets.EXAMPLE_ORG_PASSWORD }}"
          }
        }
      }

Deprecated COMPOSER_TOKEN in favor of GITHUB_TOKEN. Docs

- name: Setup PHP
  uses: shivammathur/setup-php@v2
  with:
    php-version: '8.1'
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Updated Node.js dependencies.

Thanks! @phpstan for the sponsorship ❤️

Thanks! @d8vjork and @ChristophWurst for the contributions 🎉

Follow for updates

`v2.20.1`

Compare Source

Support Ukraine

Fixed support for prestissimo with composer v1. #612
Added support for Private Packagist and manual JSON based authentication for composer. ^ALPHA Docs - Private Packagist Authentication Docs - Manual Composer Authentication
Deprecated COMPOSER_TOKEN in favor of GITHUB_TOKEN. Docs
Updated Node.js dependencies.

Follow for updates

`v2.20.0`

Compare Source

Support Ukraine

Improved support for event extension on Linux and macOS for PHP 5.4 and above. #604
Fixed support for composer plugins in tools input. Since composer 2.2, the plugins are required to be marked as allowed in the composer config. This will now be done by default. #611
Added support to show code coverage driver's (Xdebug/PCOV) version in the logs when setup using the coverage input. #610
Fixed a bug where PHP was not added to PATH during the action run on self-hosted Windows environments. #609
Fixed a bug where the tool cache path was not set on self-hosted environments. #606
Updated Node.js dependencies.

Thanks! @jrfnl, @dino182 and @markseuffert for the contributions 🚀

Follow for updates

`v2.19.1`

Compare Source

Support Ukraine

Fixed support for deployer.
Updated Node.js dependencies.

Follow for updates

`v2.19.0`

Compare Source

Support Ukraine

Added support for ubuntu-22.04 runner. Docs
Added support for Couchbase extension 4.x for PHP 7.4 and above. Also added support to specify the extension version you need. https://github.com/shivammathur/setup-php/issues/593

Note: Please use the extensions cache if using the latest Couchbase version on Linux as it can take 10+ minutes to build along with its library.

To install the latest version of couchbase extension
```
- name: Setup PHP
  uses: shivammathur@setup-php@v2
  with:
    php-version: '8.1'
    extensions: couchbase
```
To install a specific version - suffix couchbase with exact version you want in the extensions input.
```
- name: Setup PHP
  uses: shivammathur@setup-php@v2
  with:
    php-version: '7.4'
    extensions: couchbase-2.6.2
```
Improved fallback support upon cache failure in composer setup. This fixes an error when the latest composer version was installed on older PHP versions when fetching composer from shivammathur/composer-cache failed.
Bumped Node.js version required to 16.x. Also bumped build target version to ES2021.
- If you use any of the following to run setup-php, please upgrade to their latest versions.
  - Self-Hosted runners
  - nektos/act
  - shivammathur/node images.
Removed support for Debian 9 and Ubuntu 21.04 for self-hosted runners. Docs
Fixed tools setup with older composer versions which do not create composer.json if missing in the directory.
Fixed support for extensions on macOS where the extension package name might conflict with package names in homebrew-core repo. This fixes support for redis extension on macOS on PHP 7.0.
Fixed enabling cached extensions which depend on other extensions on PHP 7.1 and lower.
Fixed setting default INI values so that it is possible to override those using php -c. https://github.com/shivammathur/setup-php/issues/595
Fixed PECL support for PHP 5.3, this was broken in previous release while adding support for specifying configure options, as that is only supported on PHP 5.4 and above.
Fixed identifying the latest protoc release.
Removed unnecessary fs dependency.
Added dependabot config to update older actions in workflows. https://github.com/shivammathur/setup-php/pull/597
Added permissions for GITHUB_TOKEN in workflows. https://github.com/shivammathur/setup-php/pull/596
Updated Node.js dependencies.

Thanks! @naveensrinivasan for the contributions 🚀

Follow for updates

`v2.18.1`

Compare Source

Support Ukraine

Added support for ICU 71.1 based intl extension setup. https://github.com/shivammathur/icu-intl/pull/3

- name: Setup PHP with intl
  uses: shivammathur/setup-php@v2
  with:
    php-version: '8.1'
    extensions: intl-71.1

Added support for macOS Monterey (macos-12) GitHub hosted environment.
Added support for mcrypt extension using shivammathur/extensions tap on macOS.
Fixed patching brew for overwriting existing linked libraries.
Fixed identifying the latest protoc release.
Updated Node.js dependencies.

Thanks! @jderusse for the contributions 🚀

Follow for updates

`v2.18.0`

Compare Source

Support Ukraine

Added support for installing libraries and custom configure options for PECL extensions. #575. Docs.
Added support for blackfire extension on PHP 8.1 on Windows.
Improved support for http extension on Windows and self-hosted environments.
Fixed installing php-dev package on self-hosted environments when missing. #569
Fixed linking pecl ini file on self-hosted environments. #569
Fixed copying extensions when installed using brew from its Cellar to extension directory on macOS.
Fixed generating extension dependency map.
Fixed a bug in log functions on Linux and macOS by using local variables.
Improved switching versions on Linux. #572
Improved enabling default extensions by reducing PHP calls.
Bumped actions/checkout, actions/upload-artifact, actions/download-artifact and actions/cache version in examples and workflows to v3. #571, #577
Added PECL customization guide to README.
Updated Node.js dependencies.

Thanks! @jrfnl for the contributions 🚀

Follow for updates

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

[ ] If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

This change is

Update actions/cache action to v3
This PR contains the following updates:

| Package | Type | Update | Change | |---|---|---|---| | actions/cache | action | major | v2.1.7 -> v3.2.2 |

Release Notes

actions/cache

v3.2.2

Compare Source

What's Changed

Fix formatting error in restore/README.md by @me-and in https://github.com/actions/cache/pull/1044

save/README.md: Fix typo in example by @mmuetzel in https://github.com/actions/cache/pull/1040

README.md: remove outdated Windows cache tip link by @me-and in https://github.com/actions/cache/pull/1042

Revert compression changes related to windows but keep version logging by @Phantsure in https://github.com/actions/cache/pull/1049

New Contributors

@me-and made their first contribution in https://github.com/actions/cache/pull/1044

@mmuetzel made their first contribution in https://github.com/actions/cache/pull/1040

Full Changelog: https://github.com/actions/cache/compare/v3.2.1...v3.2.2

v3.2.1

Compare Source

What's Changed

Release compression related changes for windows by @Phantsure in https://github.com/actions/cache/pull/1039

Upgrade codeql to v2 by @Phantsure in https://github.com/actions/cache/pull/1023

Full Changelog: https://github.com/actions/cache/compare/v3.2.0...v3.2.1

v3.2.0

Compare Source

What's Changed

fix wrong timeout env var key in README.md by @walterddr in https://github.com/actions/cache/pull/959

Updated release doc with correct env variable by @kotewar in https://github.com/actions/cache/pull/960

Create pull_request_template.md by @pdotl in https://github.com/actions/cache/pull/963

Update README with clearer info about cache-hit and its value by @kotewar in https://github.com/actions/cache/pull/961

Change datadog/squid to Ubuntu/squid in CI check by @bishal-pdMSFT in https://github.com/actions/cache/pull/976

Add more details to version section in readme by @bishal-pdMSFT in https://github.com/actions/cache/pull/971

Update hashFiles documentation reference by @asaf400 in https://github.com/actions/cache/pull/979

Updated link for cache segment download info by @kotewar in https://github.com/actions/cache/pull/986

Readme update for deleting caches by @t-dedah in https://github.com/actions/cache/pull/981

Add oncall logic to assign issues and PRs by @vsvipul in https://github.com/actions/cache/pull/997

Bump minimatch from 3.0.4 to 3.1.2 by @dependabot in https://github.com/actions/cache/pull/998

Revert "Bump minimatch from 3.0.4 to 3.1.2" by @vsvipul in https://github.com/actions/cache/pull/1005

Fix npm vulnerability by @Phantsure in https://github.com/actions/cache/pull/1007

refactor: Use early return pattern to avoid nested conditions by @jongwooo in https://github.com/actions/cache/pull/1013

Use cache in check-dist.yml by @jongwooo in https://github.com/actions/cache/pull/1004

chore: Use built-in cache action to cache dependencies by @jongwooo in https://github.com/actions/cache/pull/1014

Updated node example by @t-dedah in https://github.com/actions/cache/pull/1008

Fix: Node npm doc example by @apascualm in https://github.com/actions/cache/pull/1026

docs: fix an invalid link in workarounds.md by @teatimeguest in https://github.com/actions/cache/pull/929

General Availability release for granular cache by @kotewar in https://github.com/actions/cache/pull/1035 More details here on beta release.

New Contributors

@walterddr made their first contribution in https://github.com/actions/cache/pull/959

@asaf400 made their first contribution in https://github.com/actions/cache/pull/979

@jongwooo made their first contribution in https://github.com/actions/cache/pull/1013

@apascualm made their first contribution in https://github.com/actions/cache/pull/1026

@teatimeguest made their first contribution in https://github.com/actions/cache/pull/929

Full Changelog: https://github.com/actions/cache/compare/v3...v3.2.0

v3.0.11

Compare Source

What's Changed

Call out cache not saved on hit by @Phantsure in https://github.com/actions/cache/pull/946

Update @actions/core to 1.10.0 by @rentziass in https://github.com/actions/cache/pull/950

Update cache to use @actions/core@^1.10.0 by @pdotl in https://github.com/actions/cache/pull/956

New Contributors

@rentziass made their first contribution in https://github.com/actions/cache/pull/950

Full Changelog: https://github.com/actions/cache/compare/v3...v3.0.11

v3.0.10

Compare Source

Fix a bug with sorting inputs.

Update definition for restore-keys in README.md

v3.0.9

Compare Source

Enhanced the warning message for cache unavailability in case of GHES.

v3.0.8

Compare Source

What's Changed

Fix zstd not working for windows on gnu tar in issues.

Allow users to provide a custom timeout as input for aborting cache segment download using the environment variable SEGMENT_DOWNLOAD_TIMEOUT_MIN. Default is 60 minutes.

v3.0.7

Compare Source

What's Changed

Fix for the download stuck problem has been added in actions/cache for users who were intermittently facing the issue. As part of this fix, new timeout has been introduced in the download step to stop the download if it doesn't complete within an hour and run the rest of the workflow without erroring out.

v3.0.6

Compare Source

What's Changed

Add example for clojure lein project dependencies by @shivamarora1 in PR https://github.com/actions/cache/pull/835

Update toolkit's cache npm module to latest. Bump cache version to v3.0.6 by @pdotl in PR https://github.com/actions/cache/pull/887

Fix issue #809 where cache save/restore was failing for Amazon Linux 2 runners due to older tar version

Fix issue #833 where cache save was not working for caching github workspace directory

New Contributors

@shivamarora1 made their first contribution in https://github.com/actions/cache/pull/835

@pdotl made their first contribution in https://github.com/actions/cache/pull/887

Full Changelog: https://github.com/actions/cache/compare/v3...v3.0.6

v3.0.5

Compare Source

Removed error handling by consuming actions/cache 3.0 toolkit, Now cache server error handling will be done by toolkit.

v3.0.4

Compare Source

In this release, we have fixed the tar creation error while trying to create it with path as ~/ home folder on ubuntu-latest.

v3.0.3

Compare Source

Fixed avoiding empty cache save when no files are available for caching. (https://github.com/actions/cache/issues/624)

v3.0.2

Compare Source

This release adds the support for dynamic cache size cap on GHES.

v3.0.1

Compare Source

Added support for caching from GHES 3.5.

Fixed download issue for files > 2GB during restore.

v3.0.0

Compare Source

This change adds a minimum runner version(node12 -> node16), which can break users using an out-of-date/fork of the runner. This would be most commonly affecting users on GHES 3.3 or before, as those runners do not support node16 actions and they can use actions from github.com via github connect or manually copying the repo to their GHES instance.

Few dependencies and cache action usage examples have also been updated.

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

[ ] If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

This change is
opened by renovate[bot] 7
Update shivammathur/setup-php action to v2.22.0
This PR contains the following updates:

| Package | Type | Update | Change | |---|---|---|---| | shivammathur/setup-php | action | minor | 2.17.1 -> 2.22.0 |

Release Notes

shivammathur/setup-php

v2.22.0

Compare Source

Support Ukraine

Added support for PHP builds with debugging symbols for PHP 5.6 and above. ^ALPHA Docs, (#634, shivammathur/homebrew-php#976)

- name: Setup PHP with debugging symbols uses: shivammathur/setup-php@v2 with: php-version: '8.1' env: debug: true

Added support for intl extension with ICU 72.1. shivammathur/icu-intl#4

- name: Setup PHP with intl uses: shivammathur/setup-php@v2 with: php-version: '8.1' extensions: intl-72.1

Existing PHP version on GitHub actions Ubuntu images is now updated if ppa:ondrej/php is missing regardless of the update environment variable. (actions/runner-images#6331).

Environment variable COMPOSER_NO_AUDIT is now set by default. If you would like to run the composer audit in your workflows, please add a step with composer audit command. (#635, #636)

- name: Composer audit run: composer audit

Switched to GITHUB_OUTPUT environment file for setting up outputs. If you are using setup-php on self-hosted runners, please update it to 2.297.0 or greater. More Info (#654)

Updated sqlsrv and pdo_sqlsrv version to 5.10.1 for PHP 7.0 and above on Linux.

Improved support for phalcon5 extension to set up the latest stable version.

Improved symfony-cli support to fetch the artifact URL from the brew tap on Linux. (#641, #652, #653)

Improved fetching brew taps on Linux to avoid brew's overhead.

Fixed installing extension packages on self-hosted Linux runners. (#642)

Fixed support for couchbase and firebird extensions after GitHub release page changes.

Fixed support for older versions of laravel/pint. (#647)

Updated Node.js dependencies.

Full Changelog: https://github.com/shivammathur/setup-php/compare/2.21.2...2.22.0

Thanks! @alcaeus and @jderusse for the contributions 🎉

Follow for updates

v2.21.2

Compare Source

Support Ukraine

Added support for rector in tools input. #627

- name: Setup PHP uses: shivammathur/setup-php@v2 with: php-version: 8.1 tools: rector

Added support for ast extension on macOS using shivammathur/extensions tap.

- name: Setup PHP uses: shivammathur/setup-php@v2 with: php-version: 8.1 extensions: ast

Fixed support for symfony-cli on Linux #632

- name: Setup PHP uses: shivammathur/setup-php@v2 with: php-version: 8.1 tools: symfony

Fixed installing unstable extensions from PECL. #625

Updated Node.js dependencies.

Follow for updates

v2.21.1

Compare Source

Support Ukraine

Fixed installing tools' old versions which are composer plugins.

Updated Node.js dependencies.

Follow for updates

v2.21.0

Compare Source

Support Ukraine

Added support for Laravel Pint #613, #614

- name: Setup PHP uses: shivammathur/setup-php@v2 with: php-version: `8.1` tools: pint

Added support for phalcon5 for all OS. https://github.com/shivammathur/homebrew-extensions/issues/1890 Also fixed phalcon3 and phalcon4 support on Ubuntu 22.04.

- name: Setup PHP uses: shivammathur/setup-php@v2 with: php-version: `8.1` extensions: phalcon5

Added support for Private Packagist authentication for composer. Docs

- name: Setup PHP uses: shivammathur/setup-php@v2 with: php-version: '8.1' env: PACKAGIST_TOKEN: ${{ secrets.PACKAGIST_TOKEN }}

Added support for manual JSON-based authentication for composer Docs

- name: Setup PHP uses: shivammathur/setup-php@v2 with: php-version: '8.1' env: COMPOSER_AUTH_JSON: | { "http-basic": { "example.org": { "username": "${{ secrets.EXAMPLE_ORG_USERNAME }}", "password": "${{ secrets.EXAMPLE_ORG_PASSWORD }}" } } }

Deprecated COMPOSER_TOKEN in favor of GITHUB_TOKEN. Docs

- name: Setup PHP uses: shivammathur/setup-php@v2 with: php-version: '8.1' env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Updated Node.js dependencies.

Thanks! @phpstan for the sponsorship ❤️

Thanks! @d8vjork and @ChristophWurst for the contributions 🎉

Follow for updates

v2.20.1

Compare Source

Support Ukraine

Fixed support for prestissimo with composer v1. #612

Added support for Private Packagist and manual JSON based authentication for composer. ^ALPHA Docs - Private Packagist Authentication Docs - Manual Composer Authentication

Deprecated COMPOSER_TOKEN in favor of GITHUB_TOKEN. Docs

Updated Node.js dependencies.

Follow for updates

v2.20.0

Compare Source

Support Ukraine

Improved support for event extension on Linux and macOS for PHP 5.4 and above. #604

Fixed support for composer plugins in tools input. Since composer 2.2, the plugins are required to be marked as allowed in the composer config. This will now be done by default. #611

Added support to show code coverage driver's (Xdebug/PCOV) version in the logs when setup using the coverage input. #610

Fixed a bug where PHP was not added to PATH during the action run on self-hosted Windows environments. #609

Fixed a bug where the tool cache path was not set on self-hosted environments. #606

Updated Node.js dependencies.

Thanks! @jrfnl, @dino182 and @markseuffert for the contributions 🚀

Follow for updates

v2.19.1

Compare Source

Support Ukraine

Fixed support for deployer.

Updated Node.js dependencies.

Follow for updates

v2.19.0

Compare Source

Support Ukraine

Added support for ubuntu-22.04 runner. Docs

Added support for Couchbase extension 4.x for PHP 7.4 and above. Also added support to specify the extension version you need. https://github.com/shivammathur/setup-php/issues/593

Note: Please use the extensions cache if using the latest Couchbase version on Linux as it can take 10+ minutes to build along with its library.

To install the latest version of couchbase extension

- name: Setup PHP uses: shivammathur@setup-php@v2 with: php-version: '8.1' extensions: couchbase

To install a specific version - suffix couchbase with exact version you want in the extensions input.

- name: Setup PHP uses: shivammathur@setup-php@v2 with: php-version: '7.4' extensions: couchbase-2.6.2

Improved fallback support upon cache failure in composer setup. This fixes an error when the latest composer version was installed on older PHP versions when fetching composer from shivammathur/composer-cache failed.

Bumped Node.js version required to 16.x. Also bumped build target version to ES2021.

If you use any of the following to run setup-php, please upgrade to their latest versions.

Self-Hosted runners

nektos/act

shivammathur/node images.

Removed support for Debian 9 and Ubuntu 21.04 for self-hosted runners. Docs

Fixed tools setup with older composer versions which do not create composer.json if missing in the directory.

Fixed support for extensions on macOS where the extension package name might conflict with package names in homebrew-core repo. This fixes support for redis extension on macOS on PHP 7.0.

Fixed enabling cached extensions which depend on other extensions on PHP 7.1 and lower.

Fixed setting default INI values so that it is possible to override those using php -c. https://github.com/shivammathur/setup-php/issues/595

Fixed PECL support for PHP 5.3, this was broken in previous release while adding support for specifying configure options, as that is only supported on PHP 5.4 and above.

Fixed identifying the latest protoc release.

Removed unnecessary fs dependency.

Added dependabot config to update older actions in workflows. https://github.com/shivammathur/setup-php/pull/597

Added permissions for GITHUB_TOKEN in workflows. https://github.com/shivammathur/setup-php/pull/596

Updated Node.js dependencies.

Thanks! @naveensrinivasan for the contributions 🚀

Follow for updates

v2.18.1

Compare Source

Support Ukraine

Added support for ICU 71.1 based intl extension setup. https://github.com/shivammathur/icu-intl/pull/3

- name: Setup PHP with intl uses: shivammathur/setup-php@v2 with: php-version: '8.1' extensions: intl-71.1

Added support for macOS Monterey (macos-12) GitHub hosted environment.

Added support for mcrypt extension using shivammathur/extensions tap on macOS.

Fixed patching brew for overwriting existing linked libraries.

Fixed identifying the latest protoc release.

Updated Node.js dependencies.

Thanks! @jderusse for the contributions 🚀

Follow for updates

v2.18.0

Compare Source

Support Ukraine

Added support for installing libraries and custom configure options for PECL extensions. #575. Docs.

Added support for blackfire extension on PHP 8.1 on Windows.

Improved support for http extension on Windows and self-hosted environments.

Fixed installing php-dev package on self-hosted environments when missing. #569

Fixed linking pecl ini file on self-hosted environments. #569

Fixed copying extensions when installed using brew from its Cellar to extension directory on macOS.

Fixed generating extension dependency map.

Fixed a bug in log functions on Linux and macOS by using local variables.

Improved switching versions on Linux. #572

Improved enabling default extensions by reducing PHP calls.

Bumped actions/checkout, actions/upload-artifact, actions/download-artifact and actions/cache version in examples and workflows to v3. #571, #577

Added PECL customization guide to README.

Updated Node.js dependencies.

Thanks! @jrfnl for the contributions 🚀

Follow for updates

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

[ ] If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

This change is
opened by renovate[bot] 5
Configure Renovate
Welcome to Renovate! This is an onboarding PR to help you understand and configure settings before regular Pull Requests begin.

🚦 To activate Renovate, merge this Pull Request. To disable Renovate, simply close this Pull Request unmerged.

Detected Package Files

build/composer.json (composer)

composer.json (composer)

.github/workflows/ci.yml (github-actions)

package.json (npm)

Configuration Summary

Based on the default config's presets, Renovate will:

Start dependency updates only once this onboarding PR is merged

Enable Renovate Dependency Dashboard creation

If semantic commits detected, use semantic commit type fix for dependencies and chore for all others

Ignore node_modules, bower_components, vendor and various test/tests directories

Autodetect whether to pin dependencies or maintain ranges

Rate limit PR creation to a maximum of two per hour

Limit to maximum 10 open PRs at any time

Group known monorepo packages together

Use curated list of recommended non-monorepo package groupings

Fix some problems with very old Maven commons versions

Ignore spring cloud 1.x releases

Ignore http4s digest-based 1.x milestones

Use node versioning for @types/node

Limit concurrent requests to reduce load on Repology servers until we can fix this properly, see issue 10133

🔡 Would you like to change the way Renovate is upgrading your dependencies? Simply edit the renovate.json in this branch with your custom config and the list of Pull Requests in the "What to Expect" section below will be updated the next time Renovate runs.

What to Expect

With your current configuration, Renovate will create 4 Pull Requests:

Pin dependencies

Schedule: ["at any time"]

Branch name: renovate/pin-dependencies

Merge into: master

Pin gitbook-cli to 2.3.2

Pin phpunit/phpunit to 9.5.12

Pin voku/php-readme-helper to 0.6.3

Update actions/cache action to v2.1.7

Schedule: ["at any time"]

Branch name: renovate/actions-cache-2.x

Merge into: master

Upgrade actions/cache to v2.1.7

Update shivammathur/setup-php action to v2.16.0

Schedule: ["at any time"]

Branch name: renovate/shivammathur-setup-php-2.x

Merge into: master

Upgrade shivammathur/setup-php to 2.16.0

Update codecov/codecov-action action to v2

Schedule: ["at any time"]

Branch name: renovate/codecov-codecov-action-2.x

Merge into: master

Upgrade codecov/codecov-action to v2

🚸 Branch creation will be limited to maximum 2 per hour, so it doesn't swamp any CI resources or spam the project. See docs for prhourlylimit for details.

❓ Got questions? Check out Renovate's Docs, particularly the Getting Started section. If you need any further assistance then you can also request help here.

This PR has been generated by WhiteSource Renovate. View repository job log here.

This change is
opened by renovate[bot] 5
Update shivammathur/setup-php action to v2.23.0
This PR contains the following updates:

| Package | Type | Update | Change | |---|---|---|---| | shivammathur/setup-php | action | minor | 2.22.0 -> 2.23.0 |

Release Notes

shivammathur/setup-php

v2.23.0

Compare Source

Support Ukraine

Added support for nightly builds of PHP 8.3. Note: Specifying nightly as the php-version now will set up PHP 8.3.

- name: Setup PHP uses: shivammathur/setup-php@v2 with: php-version: '8.3'

PHP 8.2 is now stable on setup-php. #673 Notes:

Specifying latest or 8.x as the php-version now will set up PHP 8.2.

Except ubuntu-22.04, all GitHub runners now have PHP 8.2 as the default version.

- name: Setup PHP uses: shivammathur/setup-php@v2 with: php-version: '8.2'

Added support for thread-safe builds of PHP on Linux. #651

- name: Setup PHP uses: shivammathur/setup-php@v2 with: php-version: '8.2' env: phpts: ts

Improved extension support on macOS for various extensions using the shivammathur/extensions tap.

ds https://github.com/shivammathur/homebrew-extensions/issues/2250

gearman https://github.com/shivammathur/homebrew-extensions/issues/2161

lua https://github.com/shivammathur/homebrew-extensions/issues/1898

sqlsrv and pdo_sqlsrv https://github.com/shivammathur/homebrew-extensions/issues/2032

v8js https://github.com/shivammathur/homebrew-extensions/issues/1899

Dropped support for macos-10.15 GitHub runner. Please update your workflows to use macos-latest or macos-12 runner.

Fixed support for composer-unused. #668

Fixed support for ini-values with the = sign in the value. #676

Added fallbacks to various tools and extensions that use the GitHub API for setup to avoid rate limit errors on Windows.

Fixed a minor error on macOS while patching updated dependency formulae.

Updated Node.js dependencies.

Full Changelog: https://github.com/shivammathur/setup-php/compare/2.22.0...2.23.0

Merry Christmas and happy holidays! 🎄🎁

Thanks! @jrfnl and @flavioheleno for the contributions 🎉

Follow for updates

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

[ ] If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

This change is
opened by renovate[bot] 4
Update codecov/codecov-action action to v3
This PR contains the following updates:

| Package | Type | Update | Change | |---|---|---|---| | codecov/codecov-action | action | major | v2 -> v3 |

Release Notes

codecov/codecov-action

v3

Compare Source

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

[ ] If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

This change is
opened by renovate[bot] 4
Update shivammathur/setup-php action to v2.17.1
This PR contains the following updates:

| Package | Type | Update | Change | |---|---|---|---| | shivammathur/setup-php | action | patch | 2.17.0 -> 2.17.1 |

Release Notes

shivammathur/setup-php

v2.17.1

Compare Source

This release is possible because of our sponsors ❤️.

Help setup-php reach its sponsorship goals.

Added support for OpenSSL config on Windows. #564 Now setup-php will set the environment variable OPENSSL_CONF pointing to a valid openssl.cnf file on Windows.

Added GitHub releases fallback URL for phing.

Updated version of sqlsrv and pdo_sqlsrv extensions to 5.10.0 for PHP 7.4 and above.

Fixed logs for symfony-cli on failure. #568

Fixed setting an environment variable on Windows in self-hosted environments.

Fixed a bug in adding a directory to PATH. #562

Fixed a minor UUOC shellcheck warning in add_tools.sh.

Updated Node.js dependencies.

Thanks! @mlocati for adding support for Set-OpenSSLConf 🚀

Follow for updates

Configuration

📅 Schedule: At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

[ ] If you want to rebase/retry this PR, click this checkbox.

This PR has been generated by WhiteSource Renovate. View repository job log here.

This change is
opened by renovate[bot] 4
Upgrade to GitHub-native Dependabot

Dependabot Preview will be shut down on August 3rd, 2021. In order to keep getting Dependabot updates, please merge this PR and migrate to GitHub-native Dependabot before then.

Dependabot has been fully integrated into GitHub, so you no longer have to install and manage a separate app. This pull request migrates your configuration from Dependabot.com to a config file, using the new syntax. When merged, we'll swap out dependabot-preview (me) for a new dependabot app, and you'll be all set!

With this change, you'll now use the Dependabot page in GitHub, rather than the Dependabot dashboard, to monitor your version updates, and you'll configure Dependabot through the new config file rather than a UI.

If you've got any questions or feedback for us, please let us know by creating an issue in the dependabot/dependabot-core repository.

Learn more about migrating to GitHub-native Dependabot

Please note that regular @dependabot commands do not work on this pull request.

This change is
dependencies

opened by dependabot-preview[bot] 4
MultiDimensional Array

array:3 [▼ 0 => Nmap\Port {#329 ▼ -number: 22 -protocol: "tcp" -state: "open" -service: Nmap\Service {#332 ▼ -name: "ssh" -product: "OpenSSH" -version: "7.9p1 Raspbian 10" } } 1 => Nmap\Port {#324 ▼ -number: 80 -protocol: "tcp" -state: "open" -service: Nmap\Service {#334 ▼ -name: "http" -product: "Apache httpd" -version: "2.4.38" } } 2 => Nmap\Port {#330 ▼ -number: 5900 -protocol: "tcp" -state: "open" -service: Nmap\Service {#336 ▼ -name: "vnc" -product: "RealVNC Enterprise" -version: "5.3 or later" } } ]

I have this multidimensional array.

$arrayy = new A([$ports]);

$arrayy->get('Nmap\Port'); // ['lastname' => 'Moelleken'] $echo = $arrayy->get('Nmap\Port.-service'); dd($echo);

When I use this code I am getting null

opened by katesaikishore 4
Update actions/upload-artifact action to v3
This PR contains the following updates:

| Package | Type | Update | Change | |---|---|---|---| | actions/upload-artifact | action | major | v2 -> v3 |

Release Notes

actions/upload-artifact

v3

Compare Source

Configuration

📅 Schedule: At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

[ ] If you want to rebase/retry this PR, click this checkbox.

This PR has been generated by WhiteSource Renovate. View repository job log here.

This change is
opened by renovate[bot] 3
Update actions/checkout action to v3
This PR contains the following updates:

| Package | Type | Update | Change | |---|---|---|---| | actions/checkout | action | major | v2 -> v3 |

Release Notes

actions/checkout

v3

Compare Source

Configuration

📅 Schedule: At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

[ ] If you want to rebase/retry this PR, click this checkbox.

This PR has been generated by WhiteSource Renovate. View repository job log here.

This change is
opened by renovate[bot] 3
Update shivammathur/setup-php action to v2.17.0
This PR contains the following updates:

| Package | Type | Update | Change | |---|---|---|---| | shivammathur/setup-php | action | minor | 2.16.0 -> 2.17.0 |

Release Notes

shivammathur/setup-php

v2.17.0

Compare Source

This release is possible because of our sponsors ❤️.

Help setup-php reach its sponsorship goals.

Added ini-file input to specify the base php.ini file. Accepts production, development or none. Docs (#450, #469)

By default the production php.ini is used, you can change it to the development one, or remove it using none.

- name: Setup PHP with: php-version: '8.1' ini-file: development

Updated support for symfony-cli to use the new version from symfony-cli/symfony-cli.

- name: Setup PHP with: php-version: '8.1' tools: symfony-cli

Added support for Churn-PHP (#561)

- name: Setup PHP with: php-version: '8.1' tools: churn

Added support for blackfire extension on PHP 8.1.

- name: Setup PHP with: php-version: '8.1' extensions: blackfire

Tools pecl, phpize and php-config are now installed by default on Linux. Specifying these in tools input is no longer required.

The environment variable COMPOSER_NO_INTERACTION is now set to 1 by default, so using --no-interaction in composer commands is not required. (#547)

The environment is now considered self-hosted unless the GitHub hosted environment is detected. This should prevent broken PHP installs in self-hosted environments when the runner environment variable is not specified. (#554)

Added support to enable disabled extensions when required by tools. For this extensions are now processed before tools.

Added support to enable xml extension before installing other extensions using pecl. (#553)

Speed improvements

Reduced the initial I/O in script creation.

Reduced the number of PHP calls and it now uses php-config instead.

Reduced number of brew calls on macOS setup.

Windows builds for all PHP versions are now fetched from shivammathur/php-builder-windows releases as a faster cache with windows.php.net as a fallback.

SSL libraries for PHP 5.3 to 5.5 on Windows are now fetched in parallel.

PHP builds for PHP 5.3 to 5.5 should now use cached macports builds from shivammathur/php5-darwin.

Added support for installing tools using composer in different scopes. This allows installing two tools with different versions of a common dependency. (#549)

Added support to fail immediately when composer setup fails. (#548)

Added support to parse PECL extension versions when wrongly hyphenated. (#536)

Added support for composer phars from shivammathur/composer-cache with PHP version as now different PHP versions can have different composer versions for a release type.

Added setup-php.com as a fallback in addition to jsdeliver.com for script sources.

Fixed support for fallback sources for tools in Windows.

Fixed potential exponential backtracking in regex to parse extension input when installing extensions from a git repository.

Fixed adding sudo to self-hosted Linux environments. (#555)

Fixed enabling disabled extensions with other extensions as dependencies. For example pecl_http, redis, etc.

Fixed a bug where the ini file used for enabling extensions by pecl in the scan directory was deleted when disabling extensions.

Fixed misconfiguration which prevented package lists from updating on Linux.

Fixed the fallback to install PowerShell packages using Install-Module on Windows when GitHub Releases is down. Also fixed not adding the Import-Module command to the profile when it fallbacks.

Fixed tools setup to not overwrite an existing tool with a broken one if it fails to set up.

Fixed an error when copying tools to a directory in PATH in tools setup.

Fixed parsing composer phars from snapshot channel for its version when is a stable version.

Fixed support for oci8 and pdo_oci extensions on Windows.

Fixed pecl_http setup.

Fixed restore-keys input in composer cache example in README with dependency range.

Fixed error in tools setup on self-hosted environments when composer's bin directory is not present.

Fixed tools.getLatestVersion to handle failing GitHub API call.

Fixed output on non-GitHub Action environments where GitHub Action specific command syntax was printed.

Fixed a bug where the status variable was overwritten in ppa.sh and was breaking the status output.

Fixed scope of variables to local in bash scripts.

Fixed setting extension stability in Add-Extension Function on Windows.

Fixed node-release workflow to add lib directory to the packages.

Fixed sending coverage data to codecov on pull requests.

Refactored utils.fetch to its own module and mocked the http module using nock for fetch tests. Now the Node.js test suite does not make any external requests.

Refactored setting environment variables and adding to PATH.

Refactored setting outputs to functions with a check to only run on GitHub Actions.

Refactored extension functions to add_extension.sh and add_extension.ps1.

Refactored the default PHP packages for self-hosted Linux environments to a config file. Also added cgi, fpm, mysql, opcache, pgsql and zip to the list.

Refactored Nightly PHP setup to Install-PhpNightly Function on Windows.

Refactored CI workflows and templates.

Rename common.sh to unix.sh.

Update security policy to specify clearly that the latest patch versions of both v1 and v2 are supported for security updates.

Updated Node workflows to use 16.x.

Updated README for the release.

Updated Node.js dependencies.

Thanks! @jrfnl and @villfa for the contributions 🚀

Follow for updates

Configuration

📅 Schedule: At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

[ ] If you want to rebase/retry this PR, click this checkbox.

This PR has been generated by WhiteSource Renovate. View repository job log here.

This change is
opened by renovate[bot] 3
Validate array based on a schema

What is this feature about (expected vs actual behaviour)?

Provide a schema a check validity of/fix an array.

@voku Do you happen to know a package that does this? Do you plan to implement it?

opened by szepeviktor 2
Dependency Dashboard
This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

composer

build/composer.json

voku/php-readme-helper ~0.6

composer.json

php >=7.0.0

symfony/polyfill-mbstring ~1.0

phpdocumentor/reflection-docblock ~4.3 || ~5.0

phpunit/phpunit ~6.0 || ~7.0 || ~9.0

github-actions

.github/workflows/ci.yml

actions/checkout v3

shivammathur/setup-php 2.23.0

actions/cache v3.2.2

codecov/codecov-action v3

actions/upload-artifact v3

[ ] Check this box to trigger a request for Renovate to run again on this repository
opened by renovate[bot] 0
Activating Open Collective
Hi, I'm making updates for Open Collective. Either you or another core contributor signed this repository up for Open Collective. This pull request adds financial contributors from your Open Collective https://opencollective.com/Arrayy ❤️

What it does:

adds a badge to show the latest number of financial contributors

adds a banner displaying contributors to the project on GitHub

adds a banner displaying all individuals contributing financially on Open Collective

adds a section displaying all organizations contributing financially on Open Collective, with their logo and a link to their website

P.S: As with any pull request, feel free to comment or suggest changes.

Thank you for your great contribution to the Open Source community. You are awesome! 🙌 And welcome to the Open Collective community! 😊

Come chat with us in the #opensource channel on https://slack.opencollective.com - great place to ask questions and share best practices with other Open Source sustainers!

This change is
opened by monkeywithacupcake 1