Iterators, ArrayAccess & Countable (Oh My!) - Madison PHP 2014

By: Sandy Smith (originally by Eli White)
CEO & Founding Partner:
musketeers.me
Training Director:
phparch.com
!
!
@SandyS1
– Oh My!
Iterators, ArrayAccess & Countable

1st: The SPL (Standard PHP Library)
A standard set of !
interfaces & classes for PHP5
!
Designed to solve standard problems
and provide efficient data access.
Iterators, ArrayAccess & Countable, Oh My! - Sandy Smith - Madison PHP - September 13, 2014
2

SPL Features
!
SPL includes numerous types of features:
- Data Structures (Linked Lists, Stacks, Queues, Heaps, …)
- Iterators (w/ Filtering, Caching, Recursion, …)
- Various standard objects (FileObject, ArrayObject, …)
- Subject/Observer Interface
- Exceptions
- and more …
3

This talk …
Will focus on a core set that are generically
useful for all your data access objects.
(and maybe a few others)
4
!
!
Iterators, ArrayAccess, Countable
!

Why?
5
!
Allows your user-space objects to be
treated like native 1st class types.

Starting us off
You have to start from somewhere …
!
6

Features we want to duplicate
All features built in to arrays
!
foreach iteration:
foreach ($array as $key => $value) {
echo "{$key}: {$value}n";
}
!
direct item access:
echo $array[5];
!
countability:
echo count($array);
7

A Basic Class
8
class Set
{
protected $_set;
public function __construct(Array $parameters = NULL)
{
$this->_set = $this->_loadFromCache($parameters);
if ($this->_set === NULL) {
$this->_set = $this->_loadFromDatabase($parameters);
}
if ($this->_set === NULL) {
$this->_set = [];
}
}
protected function _loadFromCache(Array $parameters = NULL)
{
// Pull data from cache, returning an array of arrays or objects
}
protected function _loadFromDatabase(Array $parameters = NULL)
{
// Pull data from DB, returning an array of arrays or objects
}
}

But you need to access the data…
So you need to implement some access method:
9
class SetAccess extends Set
{
public function getAll()
{
return $this->_set;
}
public function get($index)
{
if (array_key_exists($index, $this->_set)) {
return $this->_set[$index];
} else {
return NULL;
}
}
}
!

Inelegant solution
Leaves you accessing data in these ways:
10
!
$myset = new SetAccess();
print_r($myset->get(3));
!
$myset = new SetAccess();
$all = $myset->getAll();
foreach ($all as $item) {
print_r($item);
}

Iterators
Natively use foreach on your objects
11

Iterator Interface
12
interface Iterator extends Traversable {
abstract public mixed current ( void )
abstract public scalar key ( void )
abstract public void next ( void )
abstract public void rewind ( void )
abstract public boolean valid ( void )
}
!
5 methods to define, revolve around remembering state:
current(): Retur ns the current value
key(): Returns the current value’s access key
next(): Moves the inter nal pointer to the next item
rewind(): Needs to reset the inter nal pointer to the first item
valid(): Returns whether the internal pointer is at a valid data item

Easy to implement with Arrays
13
class SetIteratable extends SetAccess implements Iterator
{
public function current() {
return current($this->_set);
}
public function key() {
return key($this->_set);
}
public function next() {
next($this->_set);
}
public function rewind() {
reset($this->_set);
}
public function valid() {
return (key($this->_set) !== NULL);
}
}

Now have direct access…
Now we can access the object directly in a foreach loop!
14
$myset = new SetIteratable();
foreach ($myset as $key => $item) {
echo "{$key}: ", print_r($item, true), "<br/>n";
}
!

ArrayAccess
Treat your object like it was an array.
15

ArrayAccess Interface
16
interface ArrayAccess {
abstract public boolean offsetExists ( mixed $offset )
abstract public mixed offsetGet ( mixed $offset )
abstract public void offsetSet ( mixed $offset , mixed $value )
abstract public void offsetUnset ( mixed $offset )
}
!
4 methods to define, to gain direct key access:
offsetExists(): Does the provided key exist?
offsetGet(): Retur n the value at provided key
offsetSet(): Set the value at the provided key
offsetUnset(): Remove the value (and key) provided

Again easy to code with builtins …
17
class SetArray extends SetIteratable implements ArrayAccess
{
public function offsetExists($offset)
{
return array_key_exists($offset, $this->_set);
}
public function offsetGet($offset)
{
return $this->_set[$offset];
}
public function offsetSet($offset, $value)
{
if (is_null($offset)) {
$this->_set[] = $value;
} else {
$this->_set[$offset] = $value;
}
}
public function offsetUnset($offset)
{
unset($this->_set[$offset]);
}
}

Treat it like an array…
18
!
You can now directly treat the object like an array:
$myset = new SetArray();
print_r($myset[3]);
if (isset($myset['Sandy'])) {
echo “Smith";
}
$myset['Eli'] = 'White';
echo '<p>', $myset['Eli'], '</p>';
unset($myset['Eli']);
$myset[] = [2013, 2014, 2015];
$myset[] = 'php[tek] 2015';
!
NOTE:
You don’t have to implement
everything. Create blank
offsetSet() and offsetUnset() if
you don’t want to allow
modification!

Countable
And while we are at it …
19

Countable Interface
20
!
Just one method:
count(): How many items in this object?
class SetCountable extends SetArray implements Countable
{
public function count()
{
return count($this->_set);
}
}
$myset = new SetCountable();
echo count($myset);

Return whatever you want though…
Like all these, what you return is up to you!
21
!
class SetCountable extends SetArray implements Countable
{
public function count()
{
return count($this->_set, COUNT_RECURSIVE);
}
}
$myset = new SetCountable();
echo count($myset);

Serializable
Another bit of magic…
22

Serializable Interface
23
!
2 methods to let you custom define serialization:
serialize(): Returns a serialized form of your object
unserialize(): Instantiates an object, given the serialized form
interface Serializable {
abstract public string serialize ( void )
abstract public void unserialize ( string $serialized )
}

A simple example, just saving data
24
class SetSerial extends SetArray implements Serializable
{
public function serialize()
{
return serialize($this->_set);
}
public function unserialize($serialized)
{
$this->_set = unserialize($serialized);
}
}
!
Simple, and serialization works as normal!
$myset = new SetSerial();
$myset['magazine'] = ‘php[architect]’;
$save = serialize($myset);
$restore = unserialize($save);
echo $restore['magazine'];

But you can return whatever…
25
!
Only save what data you want.
Encode in whatever format you want:
class SetSerialFunky extends SetArray implements Serializable
{
public function serialize()
{
$copy = array_filter($this->_set, function ($val) { return !is_array($val); });
return json_encode($copy);
}
public function unserialize($serialized)
{
$this->_set = json_decode($serialized, TRUE);
}
}

Putting it all together
So what does this look like…
!
26

Put it all together and what do we get?
class SetFull implements Iterator, ArrayAccess, Countable, Serializable
{
27
// Iterator:
public function current() { return current($this->_set); }
public function key() { return key($this->_set); }
public function next() { next($this->_set); }
public function rewind() { reset($this->_set); }
public function valid() { return (key($this->_set) !== NULL); }
// ArrayAccess:
public function offsetExists($key) { return array_key_exists($key, $this->_set); }
public function offsetGet($key) { return $this->_set[$key]; }
public function offsetUnset($key) { unset($this->_set[$key]); }
public function offsetSet($key, $value) {
if (is_null($key)) { $this->_set[] = $value; }
else { $this->_set[$key] = $value; }
}
// Countable:
public function count() { return count($this->_set); }
// Serializable
public function serialize() { return serialize($this->_set); }
public function unserialize($data) { $this->_set = unserialize($data); }
}

Get creative!
28
!
This only scrapes the surface of what is possible!
!
None of the methods need to
retur n ‘basic’ information like this.
!
Get as creative as needed for your situation!

Bonus Round!
Let’s look at some magic methods…
!
29

Magic methods have come a long way…
30
!
Not just your __get & __set anymore!
!
Let’s look at some PHP5 magic methods
that are useful to data access classes!

__toString()
Been around a while, but recently become universal
31
!
class SetString extends SetSerial
{
public function __toString()
{
return "Set: " . print_r($this->_set, TRUE);
}
}
!
$myset = new SetString();
echo $myset;

__set_state()
32
!
Called statically by var_export() on your object:
IE: var_export retur ns: SetState::__set_state($data);
class SetState extends SetString
{
public static function __set_state(Array $array)
{
$obj = new self();
$obj->_set = $array['_set'];
return $obj;
}
}
$myset = new SetState();
$export = var_export($myset, TRUE);
eval('$newset = '. $export. ';');
echo $newset;

__callStatic()
__call() has been around for a while to dynamic method calls.
33
!
__callStatic() now allows the same feature on static methods.
class SetCall extends SetState {
public function __call($name, $args) {
if ($name == 'flip') {
return array_reverse($this->_set);
}
}
public function __callStatic($name, $args) {
if ($name == 'factory') {
return new self();
}
}
}
$myset = SetCall::factory();
$reversed = $myset->flip();
var_dump($reversed);

__invoke()
34
!
Blow your mind:
Allows your object to be called as a function!
class SetInvoke extends SetCall
{
public function __invoke($start, $length)
{
return array_slice($this->_set, $start, $length, TRUE);
}
}
$myset = new SetInvoke();
$slice = $myset(1,3);
var_dump($slice);
!
Can do anything with this!

More Iterator Fun!
If we have time, let’s play!
!
35

InfiniteIterator
Causes an iterator to automatically rewind:
36
!
$forever = new InfiniteIterator(new SetFull());
$count = 100;
foreach ($forever as $item) {
print_r($item);
if (!($count--)) break;
}

LimitIterator
37
!
Allows you to set a start index & max iterations:
foreach (new LimitIterator(new SetFull(), 0, 3) as $item) {
print_r($item);
}
$forever = new InfiniteIterator(new SetFull());
foreach (new LimitIterator($forever, 0, 100) as $item) {
print_r($item);
}

FilterIterator
38
!
Apply your own filtering to what items are returned
class ArrayFilter extends FilterIterator
{
public function accept()
{
return is_array($this->getInnerIterator()->current());
}
}
foreach (new ArrayFilter(new SetFull()) as $item) {
print_r($item);
}

RegexIterator
Predefined instance of FilterIterator with regex
39
!
$regex = new RegexIterator(new SetFull(), '/^tek[0-9]+/', RegexIterator::MATCH);
foreach ($regex as $item) {
print_r($item);
} !
Lots of options/flags:
RegexIterator::MATCH
RegexIterator::GET_MATCH
RegexIterator::ALL_MATCHES
RegexIterator::SPLIT
RegexIterator::REPLACE
RegexIterator::USE_KEY

MultipleIterator
40
!
Allows iterating over multiple iterators at once
$multiple = new MultipleIterator();
$multiple->attachIterator(new SetFull());
$multiple->attachIterator(new SetFull(['other','parameters']));
foreach ($multiple as $both) {
$setOne = print_r($both[0], TRUE);
$setTwo = print_r($both[1], TRUE);
echo "One: {$setOne} | Two: {$setTwo} <br/>n";
}
!
Stops whenever any one runs out of items

RecursiveIterator & RecursiveIteratorIterator
41
class SetRecursable extends SetFull implements RecursiveIterator
{
public function hasChildren()
{
return is_array(current($this->_set));
}
public function getChildren() {
return new RecursiveArrayIterator(current($this->_set));
}
}
foreach (new RecursiveIteratorIterator(new SetRecursable()) as $item) {
echo " {$item} ";
}
!
2 methods to you define to allow recursion:
hasChildren(): Does the current item have any children?
getChildren(): If so, return a RecursiveIterator to iterate them.

And so much more…
!
ArrayIterator !
NoRewindIterator
42
!
SeekableIterator
!
ParentIterator
!
AppendIterator
CachingIterator
!
CallbackFilterIterator
!
DirectoryIterator
!
EmptyIterator
!
FilesystemIterator
!
GlobIterator
!
!
RecursiveCachingIterator
!
RecursiveFilterIterator !
RecursiveDirectoryIterator
!
RecursiveCallbackFilterIterator
!
RecursiveRegexIterator
!
RecursiveTreeIterator

Brief Commercial Interruption…
43

Get a discount to php[world]!
44

Win an ElePHPant!
45
Drop your card/name & email in the shoebox at our table

Questions?
Twitter: @SandyS1, @phparch
php[architect]: http://phparch.com/
musketeers: http://musketeers.me/
Rate me: https://joind.in/11744
!
!
!
!
!
46

Iterators, ArrayAccess & Countable (Oh My!) - Madison PHP 2014

More Related Content

What's hot (19)

Viewers also liked (20)

Similar to Iterators, ArrayAccess & Countable (Oh My!) - Madison PHP 2014 (20)

Recently uploaded (20)

Iterators, ArrayAccess & Countable (Oh My!) - Madison PHP 2014