Implement ArrayStorage package

Author: henriquemoody

README.md

@@ -15,3 +15,96 @@ using [Composer](http://getcomposer.org).
 ```bash
 composer require phpfluent/arraystorage
 ```
+
+# Usage
+
+The examples below are using the following use statement at the beginning of the file:
+
+```php
+use PHPFluent\ArrayStorage\Storage;
+```
+
+## Creating and returning a collection
+
+```php
+$storage = new Storage();
+$storage->users; // This is a collection
+```
+
+## Inserting records to a collection
+
+You can use a single array:
+
+```php
+$storage = new Storage();
+$storage->users->insert(array('name' => 'Henrique Moody'));
+```
+
+But you also can use a Record object:
+
+```php
+use PHPFluent\ArrayStorage\Record;
+
+$storage = new Storage();
+$record = new Record();
+$record->name = 'Henrique Moody';
+
+$storage->users->insert($record);
+```
+
+You can create a Record object from Storage object:
+
+```php
+$storage = new Storage();
+$record = $storage->record();
+$record->name = 'Henrique Moody';
+
+$storage->users->insert($record);
+```
+
+An important point to note is that, after you insert the record to the collection object
+it gives to the record an unique (incremental integer) `id` property.
+
+## Removing records from a collection
+
+```php
+$storage = new Storage();
+$storage->users->delete(array('name' => 'Henrique Moody'));
+```
+
+## Removing all records from a collection
+
+```php
+$storage = new Storage();
+$storage->users->delete();
+```
+
+## Converting collection to an array
+
+```php
+$storage = new Storage();
+$collectionData = $storage->users->toArray();
+```
+
+The example above convert all Record objects that are children of Record objects into an string, but returning its `id` property.
+
+## Converting collection to an expanded array
+
+```php
+$storage = new Storage();
+$collectionData = $storage->users->toArray();
+```
+
+The example above convert all Record objects into an array.
+
+## Finding multiple records into a collection
+
+```php
+$storage->users->findAll(array('name' => 'Henrique Moody')); // Return an Collection object with the partial result (if any)
+```
+
+## Finding single record into a collection
+
+```php
+$storage->users->find(array('name' => 'Henrique Moody')); // Return an Record object with the first matched result (if any) or NULL
+```

src/Collection.php

@@ -0,0 +1,130 @@
+<?php
+
+namespace PHPFluent\ArrayStorage;
+
+use ArrayIterator;
+use IteratorAggregate;
+use Countable;
+
+class Collection implements Countable, IteratorAggregate
+{
+    protected $name;
+    protected $records = array();
+    protected $lastRecordId = 0;
+
+    public function __construct($name, array $records = array())
+    {
+        $this->name = $name;
+        foreach ($records as $record) {
+            $this->insert($record);
+        }
+    }
+
+    public function getName()
+    {
+        return $this->name;
+    }
+
+    public function record($record)
+    {
+        if (! $record instanceof Record) {
+            $data = (array) $record;
+            $record = new Record($data);
+        }
+
+        return $record;
+    }
+
+    public function count()
+    {
+        return count($this->records);
+    }
+
+    public function insert($data)
+    {
+        $record = $this->record($data);
+        if (0 >= $record->id) {
+            $record->id = ++$this->lastRecordId;
+        }
+
+        $this->records[] = $record;
+
+        return $record->id;
+    }
+
+    public function update(array $update, array $criteria = array())
+    {
+        $records = $this->findAll($criteria);
+        foreach ($records as $record) {
+            $record->update($update);
+        }
+    }
+
+    public function delete(array $criteria = array())
+    {
+        foreach ($this->records as $key => $record) {
+            if (! $this->equals($criteria, $record)) {
+                continue;
+            }
+
+            unset($this->records[$key]);
+        }
+    }
+
+    public function getIterator()
+    {
+        return new ArrayIterator($this->records);
+    }
+
+    protected function equals(array $values, Record $record)
+    {
+        foreach ($values as $key => $value) {
+            if ((string) $record->__get($key) == (string) $value) {
+                continue;
+            }
+
+            return false;
+        }
+
+        return true;
+    }
+
+    public function findAll(array $criteria = array(), $limit = null)
+    {
+        $count = 0;
+        $results = array();
+        foreach ($this->records as $record) {
+            if (null !== $limit && $count == $limit) {
+                continue;
+            }
+
+            if (! $this->equals($criteria, $record)) {
+                continue;
+            }
+
+            $count++;
+            $results[] = $record;
+        }
+
+        $name = $this->name . '-' . json_encode($criteria);
+
+        return new static($name, $results);
+    }
+
+    public function find(array $criteria = array())
+    {
+        $records = $this->findAll($criteria, 1);
+
+        return $records->getIterator()->current();
+    }
+
+    public function toArray($expandChildren = false)
+    {
+        $results = array();
+        foreach ($this->records as $record) {
+            $results[] = $record->toArray($expandChildren);
+        }
+
+        return $results;
+    }
+}

src/Record.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace PHPFluent\ArrayStorage;
+
+class Record
+{
+    protected $data = array('id' => null);
+
+    public function __construct(array $data = array())
+    {
+        foreach ($data as $name => $value) {
+            $this->__set($name, $value);
+        }
+    }
+
+    public function __set($name, $value)
+    {
+        $this->data[$name] = $value;
+    }
+
+    public function __get($name)
+    {
+        if (! isset($this->data[$name])) {
+            $this->data[$name] = null;
+        }
+
+        return $this->data[$name];
+    }
+
+    public function __toString()
+    {
+        return (string) $this->__get('id');
+    }
+
+    public function update(array $update)
+    {
+        foreach ($update as $key => $value) {
+            $this->__set($key, $value);
+        }
+    }
+
+    public function toArray($expandChildren = false)
+    {
+        $result = array();
+        foreach ($this->data as $key => $value) {
+            if ($value instanceof static && true === $expandChildren) {
+                $value = $value->toArray($expandChildren);
+            } elseif ($value instanceof static && true !== $expandChildren) {
+                $value = (int) $value->__toString() ?: null;
+            }
+
+            $result[$key] = $value;
+        }
+
+        return $result;
+    }
+}

src/Storage.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace PHPFluent\ArrayStorage;
+
+use ArrayIterator;
+use Countable;
+use IteratorAggregate;
+
+class Storage implements IteratorAggregate, Countable
+{
+    protected $collections = array();
+
+    public function __get($name)
+    {
+        if (! isset($this->collections[$name])) {
+            $this->collections[$name] = new Collection($name);
+        }
+
+        return $this->collections[$name];
+    }
+
+    public function count()
+    {
+        return count($this->collections);
+    }
+
+    public function getIterator()
+    {
+        return new ArrayIterator($this->collections);
+    }
+}