Maslosoft Zamm API
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 <?php
/**
* This software package is licensed under `AGPL, Commercial` license[s].
*
* @package maslosoft/zamm
* @license AGPL, Commercial
*
* @copyright Copyright (c) Peter Maselkowski <pmaselkowski@gmail.com>
* @link https://maslosoft.com/zamm/
*/
namespace Maslosoft\Zamm\Decorators;
use Maslosoft\Zamm\Interfaces\DecoratorInterface;
/**
* Abstract class implementgin common decorator methods
*
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
abstract class AbstractDecorator
{
/**
* Decorators
* @var DecoratorInterface[]
*/
private $decorators = [];
/**
* Apply decorators configuration.
* Schema is described in Zamm class
* @param string[][] $decoratorsConfig
*/
protected function apply($decoratorsConfig)
{
foreach ($decoratorsConfig as $interface => $decorators)
{
if (!$this->decorated() instanceof $interface)
{
continue;
}
foreach ($decorators as $decorator)
{
$this->addDecorator($decorator);
}
}
}
/**
* Add decorator. This will perform uniqueness check.
* @param string $className
* @return boolean true if added
*/
public function addDecorator($className)
{
if (isset($this->decorators[$className]))
{
return false;
}
$decorator = new $className();
assert($decorator instanceof DecoratorInterface);
$this->decorators[$className] = $decorator;
return true;
}
abstract protected function init(DecoratorInterface $decorator);
/**
* Decorated entity
* @return object
*/
abstract protected function decorated();
/**
* Decorate doc comment
* @param string $docComment
*/
public function decorate(&$docComment)
{
foreach ($this->decorators as $decorator)
{
$decorator->decorate($docComment);
}
}
}
API documentation generated by ApiGen