Maslosoft Mangan 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 91 <?php
/**
* This software package is licensed under AGPL or Commercial license.
*
* @package maslosoft/mangan
* @licence AGPL or Commercial
* @copyright Copyright (c) Piotr Masełkowski <pmaselkowski@gmail.com>
* @copyright Copyright (c) Maslosoft
* @copyright Copyright (c) Others as mentioned in code
* @link https://maslosoft.com/mangan/
*/
namespace Maslosoft\Mangan\Traits\Criteria;
use Maslosoft\Addendum\Interfaces\AnnotatedInterface;
use Maslosoft\Mangan\Criteria\ConditionDecorator;
use Maslosoft\Mangan\Interfaces\ConditionDecoratorInterface;
use Maslosoft\Mangan\Interfaces\Criteria\DecoratableInterface;
use Maslosoft\Mangan\Interfaces\CriteriaInterface;
use Maslosoft\Mangan\Interfaces\Decorators\ConditionDecoratorTypeAwareInterface;
use Maslosoft\Mangan\Interfaces\Decorators\ConditionDecoratorTypeInterface;
/**
* DecoratableTrait
* @see DecoratableInterface
* @see CriteriaInterface
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
trait DecoratableTrait
{
/**
* Condition decorator instance
* @var ConditionDecoratorInterface
*/
private $cd = null;
/**
* Get condition interface
* @return ConditionDecoratorInterface
*/
public function getCd()
{
if($this instanceof ConditionDecoratorTypeAwareInterface && $this->cd instanceof ConditionDecoratorTypeInterface)
{
$this->cd->setDecoratorType($this->getDecoratorType());
}
return $this->cd;
}
/**
* Set condition decorator interface
* @param ConditionDecoratorInterface $cd
* @return CriteriaInterface
*/
public function setCd(ConditionDecoratorInterface $cd)
{
if($this instanceof ConditionDecoratorTypeAwareInterface && $cd instanceof ConditionDecoratorTypeInterface)
{
$cd->setDecoratorType($this->getDecoratorType());
}
$this->cd = $cd;
return $this;
}
/**
* Decorate and sanitize criteria with provided model.
* @param AnnotatedInterface $model Model to use for decorators and sanitizer when creating conditions. If null no decorators will be used. If model is provided it's sanitizers and decorators will be used.
* @param ConditionDecoratorInterface $decorator
* @return CriteriaInterface
*/
public function decorateWith($model, ConditionDecoratorInterface $decorator = null)
{
if (null !== $decorator)
{
$this->cd = $decorator;
}
else
{
$this->cd = new ConditionDecorator($model);
}
if($this instanceof ConditionDecoratorTypeAwareInterface && $this->cd instanceof ConditionDecoratorTypeInterface)
{
$this->cd->setDecoratorType($this->getDecoratorType());
}
return $this;
}
}
API documentation generated by ApiGen