Collection/storage of templates

This commit is contained in:
Meritoo
2019-04-02 21:08:11 +02:00
parent 0b74f8da6f
commit faf1da6134
13 changed files with 473 additions and 35 deletions

View File

@@ -0,0 +1,65 @@
<?php
/**
* (c) Meritoo.pl, http://www.meritoo.pl
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
declare(strict_types=1);
namespace Meritoo\Common\Collection;
use Meritoo\Common\Exception\ValueObject\Template\TemplateNotFoundException;
use Meritoo\Common\ValueObject\Template;
/**
* Collection/storage of templates
*
* @author Meritoo <github@meritoo.pl>
* @copyright Meritoo <http://www.meritoo.pl>
*/
class Templates extends Collection
{
/**
* Finds and returns template with given index
*
* @param string $index Index that contains required template
* @throws TemplateNotFoundException
* @return Template
*/
public function findTemplate(string $index): Template
{
/* @var Template $template */
$template = $this->getByIndex($index);
if ($template instanceof Template) {
return $template;
}
// Oops, template not found
throw TemplateNotFoundException::create($index);
}
/**
* Creates and returns the collection from given array
*
* @param array $templates Pairs of key-value where: key - template's index, value - template's content
* @return Templates
*/
public static function fromArray(array $templates): Templates
{
// No templates. Nothing to do.
if (empty($templates)) {
return new static();
}
$result = new static();
foreach ($templates as $index => $template) {
$result->add(new Template($template), $index);
}
return $result;
}
}

View File

@@ -0,0 +1,36 @@
<?php
/**
* (c) Meritoo.pl, http://www.meritoo.pl
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
declare(strict_types=1);
namespace Meritoo\Common\Exception\ValueObject\Template;
use Exception;
/**
* An exception used while template with given index was not found
*
* @author Meritoo <github@meritoo.pl>
* @copyright Meritoo <http://www.meritoo.pl>
*/
class TemplateNotFoundException extends Exception
{
/**
* Creates the exception
*
* @param string $index Index that should contain template, but it was not found
* @return TemplateNotFoundException
*/
public static function create(string $index): TemplateNotFoundException
{
$template = 'Template with \'%s\' index was not found. Did you provide all required templates?';
$message = sprintf($template, $index);
return new static($message);
}
}