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 <?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\DataProvider;
use Maslosoft\Addendum\Interfaces\AnnotatedInterface;
use Maslosoft\Mangan\Interfaces\Criteria\DecoratableInterface;
use Maslosoft\Mangan\Interfaces\CriteriaInterface;
use Maslosoft\Mangan\Interfaces\ModelAwareInterface;
/**
* CriteriaTrait
*
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
trait CriteriaTrait
{
/**
* @var CriteriaInterface
*/
private $criteria;
/**
* Returns the criteria.
* @return CriteriaInterface the query criteria
* @since v1.0
*/
public function getCriteria()
{
// Initialise empty criteria, so it's always available via this method call.
if (empty($this->criteria))
{
$className = static::CriteriaClass;
if ($this instanceof ModelAwareInterface)
{
$model = $this->getModel();
}
else
{
$model = null;
}
$this->criteria = new $className(null, $model);
}
return $this->criteria;
}
/**
* Sets the query criteria.
* @param CriteriaInterface|array $criteria the query criteria. Array representing the MongoDB query criteria.
* @return static
*/
public function setCriteria($criteria)
{
if (is_array($criteria))
{
$className = static::CriteriaClass;
$this->criteria = new $className($criteria);
}
elseif ($criteria instanceof CriteriaInterface)
{
$this->criteria = $criteria;
}
if ($this->criteria instanceof DecoratableInterface)
{
$this->criteria->decorateWith($this->getModel());
}
return $this;
}
/**
* @return AnnotatedInterface
*/
abstract public function getModel();
}
API documentation generated by ApiGen