reptily/array-list

ArrayList for PHP

0.2.2 2023-10-26 07:29 UTC

Requires

• php: ^7.3|^8.0

Requires (Dev)

• phpunit/phpunit: ^9.3

GPL-3.0-or-later

• Vladimir Aristarkhov

README

composer require reptily/array-list

what problem does this library solve?

There are no built-in mechanisms for creating lists in the PHP language. An associative array does not guarantee that its elements are typed.

Example

function show(array $items)
{
    foreach ($items as $item) {
        echo $item->id . PHP_EOL;
    }
}

In this example, we do not guarantee that all elements will be the necessary objects, and we also do not guarantee that the array will be without attachments.

function show(ArrayList $items)
{
    foreach ($items as $item) {
        echo $item->id . PHP_EOL;
    }
}

The code did not become larger, but typification appeared. ArrayList takes care of all typing and data access issues. We can be sure that all types in the array are correct and not do unnecessary checks.

Example

More examples in the directory /example

Only integer

$list = new ArrayList(ArrayList::TYPE_INTEGER, [1, 2, 3]);
// or
$list = new ArrayListInteger([1, 2, 3]);

foreach ($list as $item) {
    echo $item . PHP_EOL;
}

If we need a collection of objects

class UserList extends ArrayList {
    public function __construct(?array $items = null)
    {
        parent::__construct(UserDTO::class, $items);
    }
};

class UserDTO {
    public $id;
    public $name;

    public function __construct($id, $name)
    {
        $this->id = $id;
        $this->name = $name;
    }
}

$userList = new UserList();
$userList->add(new UserDTO(1, 'bob'));
$userList->add(new UserDTO(2, 'job'));

function echoDTOs(UserList $list): void
{
    $list->forEach(function ($item) {
        echo sprintf("id:%d name:%s" . PHP_EOL, $item->id, $item->name);
    });
}

Use as Object

$ids = new ArrayListInteger([1, 2, 3]);
$ids->add(4);

function show(ArrayListInteger $ids)
{
    $ids->forEach(function($id) {
        echo $id . PHP_EOL;
    });
}
show();

Use as Array

$ids = new ArrayListInteger([1, 2, 3]);
$ids[] = 4;

function show(ArrayListInteger $ids)
{
    foreach ($ids as $id) {
        echo $id;
    }
}
show();

Methods

add(mixed $item): void

Adds an element to the array

count(): int

Return the number of elements in the array

isEmpty(): bool

Return is empty

indexOf(mixed $element): ?int

Searches the array for a match, if there is one it will return the index, if not then return null

lastIndexOf(): ?int

Will return the last index in the array, if the array is empty will return null

clone(): self

Clones an object

toArray(): array

Converts to an associative array

get(int $index): mixed

Returns an element by its index, if there is no element, an exception will be thrown

set(int $index, mixed $item): void

Sets a value on an element by its index

exists(int $index): bool

Checks the presence of an element by its index

remove(int $index): void

Remove element by its index

clear(): void

Cleans the array

forEach(): callback(mixed $item, int $index)

Returns a callback for each element in the array

sort(string $sort = 'asc'|'desc'): void

Sorts an array

Support class

ArrayListInteger

Creates a list where the elements must all be integer

ArrayListString

Creates a list where the elements must all be string

ArrayListFloat

Creates a list where the elements must all be float

Constants

Constants by types

• TYPE_STRING
• TYPE_INTEGER
• TYPE_BOOLEAN
• TYPE_FLOAT

Constants by sort

• SORT_DESC
• SORT_ASC