Collection/storage of templates

docs/Collection/Collection.md

@@ -0,0 +1,60 @@
+# Meritoo Common Library
+
+Common and useful classes, methods, exceptions etc.
+
+# Collection
+
+### Namespace
+
+`Meritoo\Common\Collection\Collection`
+
+### Info
+
+It's a set of some elements, e.g. objects. It's iterable and countable. Provides very useful methods. Some of them:
+- `getFirst()` - returns the first element in the collection
+- `getLast()` - returns the last element in the collection
+- `isEmpty()` - returns information if collection is empty
+- `add($element, $index = null)` - adds given element (at the end of collection)
+- `addMultiple($elements, $useIndexes = false)` - adds given elements (at the end of collection)
+- `prepend($element)` - prepends given element (adds given element at the beginning of collection)
+- `remove($element)` - removes given element
+
+Examples of usage below.
+
+### An empty collection
+
+```php
+use Meritoo\Common\Collection\Collection;
+
+$emptyCollection = new Collection();
+var_dump($emptyCollection->isEmpty()); // bool(true)
+```
+
+### Simple collection
+
+```php
+use Meritoo\Common\Collection\Collection;
+
+$elements = [
+    'lorem',
+    'ipsum',
+    123 => 'dolor',
+    345 => 'sit',
+];
+
+$simpleCollection = new Collection($elements);
+var_dump($simpleCollection->has('dolor')); // bool(true)
+```
+
+# More
+
+1. [Base test case (with common methods and data providers)](../Base-test-case.md)
+2. [**Collection of elements**](Collection.md)
+3. [Templates](Templates.md)
+4. [Exceptions](../Exceptions.md)
+5. [Static methods](../Static-methods.md)
+   1. [Arrays](../Static-methods/Arrays.md)
+   2. [Regex](../Static-methods/Regex.md)
+6. [Value Objects](../Value-Objects.md)
+
+[‹ Back to `Readme`](../../README.md)

docs/Collection/Templates.md

@@ -0,0 +1,65 @@
+# Meritoo Common Library
+
+Common and useful classes, methods, exceptions etc.
+
+# Templates
+
+### Namespace
+
+`Meritoo\Common\Collection\Templates`
+
+### Info
+
+Collection/storage of templates, instance of `Meritoo\Common\ValueObject\Template` class.
+
+##### New instance
+
+New instance can be created using:
+
+1. Constructor:
+
+	```php
+    new Templates([
+    	'first' => new Template('First name: %first_name%'),
+        'last'  => new Template('Last name: %last_name%'),
+    ]);
+    ```
+
+2. Static method `fromArray(array $templates)` - creates and returns the collection from given array
+
+	```php
+	Templates::fromArray([
+    	'first' => 'First name: %first_name%',
+        'last'  => 'Last name: %last_name%',
+    ]);
+	```
+
+##### Methods
+
+Has all methods of parent class `Meritoo\Common\Collection\Collection` + `findTemplate(string $index)` method that finds and returns template with given index.
+
+Example of usage:
+
+```php
+$templates = new Templates([
+	'first' => new Template('First name: %first_name%'),
+    'last'  => new Template('Last name: %last_name%'),
+]);
+
+$template = $templates->findTemplate('first'); // new Template('First name: %first_name%')
+```
+
+Throws an `Meritoo\Common\Exception\ValueObject\Template\TemplateNotFoundException` exception if template with given index was not found.
+
+# More
+
+1. [Base test case (with common methods and data providers)](../Base-test-case.md)
+2. [Collection of elements](Collection.md)
+3. [**Templates**](Templates.md)
+4. [Exceptions](../Exceptions.md)
+5. [Static methods](../Static-methods.md)
+   1. [Arrays](../Static-methods/Arrays.md)
+   2. [Regex](../Static-methods/Regex.md)
+6. [Value Objects](../Value-Objects.md)
+
+[‹ Back to `Readme`](../../README.md)