mscribellito/arraylist

ArrayList is an implementation of a list, backed by an array.

, _(*1)

ArrayList

ArrayList is an implementation of a list, backed by an array. It provides methods for adding, removing, searching and sorting elements., _(*2)

Requirements

PHP 5.4 or newer is required., _(*3)

License

Released under the MIT License. See LICENSE for details., _(*4)

API

Constructor Summary

Method Summary

Methods inherited from ArrayAccess

Methods inherited from Countable

Methods inherited from IteratorAggregate

Methods inherited from Serializable

Usage

Creating an ArrayList

Create an empty instance:, _(*5)

$empty = new ArrayList();
echo $empty; // []

Create an instance and initialize it with an array:, _(*6)

$occupants = new ArrayList(['Michael', 'Brittany', 'Wallace', 'Martin']);
echo $occupants; // [Michael, Brittany, Wallace, Martin]

Create an instance and initialize it with an ArrayList:, _(*7)

$empty = new ArrayList();
$alsoEmpty = new ArrayList($empty);
echo $alsoEmpty; // []

ArrayList Utility Methods

clear

$numbers = new ArrayList([1, 2, 3, 4]);
echo $numbers; // [1, 2, 3, 4]
$numbers->clear();
echo $numbers; // []

isEmpty

$numbers = new ArrayList([1, 2, 3, 4]);
echo $numbers->isEmpty() ? 'empty' : 'not empty'; // not empty

size

$numbers = new ArrayList([1, 2, 3, 4]);
echo $numbers->size(); // 4

Getting and Setting Indices

get

$numbers = new ArrayList([1, 2, 3, 4]);
echo $numbers->get(3); // 4

set

$numbers = new ArrayList([1, 2, 3, 0]);
$old = $numbers->set(3, 4);
echo $numbers; // [1, 2, 3, 4]

Sublist

Get a sublist from another list., _(*8)

$cars = new ArrayList(['Mustang', 'Prius', 'PT Cruiser', 'Jeep']);
$lameCars = $cars->sublist(1, 3);
echo $lameCars; // [Prius, PT Cruiser]

Sorting

sort accepts a comparator function (callback)., _(*9)

Sort lowest to highest:, _(*10)

$letters = new ArrayList(['b', 'c', 'd', 'a']);
echo $letters; // [b, c, d, a]
$letters->sort(function ($a, $b) {
    return $a == $b ? 0 : $a < $b ? -1 : 1;
});
echo $letters; // [a, b, c, d]

Sort highest to lowest:, _(*11)

$numbers = new ArrayList([2, 3, 4, 1]);
echo $numbers; // [2, 3, 4, 1]
$numbers->sort(function ($a, $b) {
    return $a == $b ? 0 : $a < $b ? 1 : -1;
});
echo $numbers; // [4, 3, 2, 1]

Searching

contains

$fruits = new ArrayList(['apples', 'oranges', 'bananas']);
var_dump($fruits->contains('apples')); // bool(true)
var_dump($fruits->contains('pears')); // bool(false)

indexOf

$fruits = new ArrayList(['apples', 'oranges', 'bananas']);
var_dump($fruits->indexOf('apples')); // int(0)

lastIndexOf

$fruits = new ArrayList(['apples', 'oranges', 'bananas', 'apples']);
var_dump($fruits->lastIndexOf('apples')); // int(3)

Adding Elements

Single Element

Add at end of list:, _(*12)

$food = new ArrayList(['Pizza', 'French Fries', 'Bacon']);
$food->add('Burgers');
echo $food; // [Pizza, French Fries, Bacon, Burgers]

Add at specified position in list:, _(*13)

$food = new ArrayList(['Pizza', 'French Fries', 'Bacon']);
$food->addAt(1, 'Tacos');
echo $food; // [Pizza, Tacos, French Fries, Bacon]

Multiple Elements

Add at end of list:, _(*14)

$food = new ArrayList(['Pizza', 'French Fries', 'Bacon']);
$food->addAll(['Burgers', 'Tacos']);
echo $food; // [Pizza, French Fries, Bacon, Burgers, Tacos]

Add at specified position in list:, _(*15)

$food = new ArrayList(['Pizza', 'French Fries', 'Bacon']);
$food->addAllAt(1, ['Burgers', 'Tacos']);
echo $food; // [Pizza, Burgers, Tacos, French Fries, Bacon]

Removing Elements

Single Element

By element:, _(*16)

$food = new ArrayList(['Pizza', 'French Fries', 'Bacon']);
$food->remove('French Fries');
echo $food; // [Pizza, Bacon]

By index:, _(*17)

$food = new ArrayList(['Pizza', 'French Fries', 'Bacon']);
$food->removeAt(1);
echo $food; // [Pizza, Bacon]

Multiple Elements

By collection:, _(*18)

$food = new ArrayList(['Pizza', 'Sushi', 'Quiche', 'Bacon']);
$food->removeAll(['Sushi', 'Quiche']);
echo $food; // [Pizza, Bacon]

By range:, _(*19)

$food = new ArrayList(['Pizza', 'Sushi', 'Quiche', 'Bacon']);
$food->removeRange(1, 3);
echo $food; // [Pizza, Bacon]

Interfaces

ArrayList implements the following interfaces:, _(*20)

• ArrayAccess
• Countable
• IteratorAggregate
• Serializable

ArrayAccess

get

$letters = new ArrayList(['a', 'b', 'c', 'd']);
echo $letters[0]; // a

set

$letters = new ArrayList(['a', 'b', 'c']);
$letters[] = '?';
echo $letters; // [a, b, c, ?]
$letters[3] = 'd';
echo $letters; // [a, b, c, d]

isset

$letters = new ArrayList(['a', 'b', 'c', 'd']);
var_dump(isset($letters[0])); // bool(true)
var_dump(isset($letters[4])); // bool(false)

unset

$letters = new ArrayList(['a', 'b', 'c', 'd']);
unset($letters[3]);
echo $letters; // [a, b, c]

Countable

$letters = new ArrayList(['a', 'b', 'c', 'd']);
echo count($letters); // 4

IteratorAggregate

$numbers = new ArrayList([1, 2, 3, 4]);
foreach ($numbers as $number) echo $number; // 1234

Serializable

serialize and unserialize

$numbers = new ArrayList([1, 2, 3, 4]);
echo $numbers; // [1, 2, 3, 4]
$serialized = serialize($numbers);
unset($numbers);
var_dump(isset($numbers)); // bool(false)
$numbers = unserialize($serialized);
echo $numbers; // [1, 2, 3, 4]