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 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 <?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\Annotations;
use Maslosoft\Addendum\Helpers\ParamsExpander;
use Maslosoft\Mangan\Decorators\EmbedRefDecorator;
use Maslosoft\Mangan\Decorators\RelatedDecorator;
use Maslosoft\Mangan\Interfaces\SortInterface;
use Maslosoft\Mangan\Meta\ManganPropertyAnnotation;
use Maslosoft\Mangan\Meta\RelatedMeta;
use UnexpectedValueException;
/**
* RelatedAnnotation
* Shorthand notation:
*
* Related(Company\Project\Projects, join = {'_id' = 'entity_id'}, sort = {'_id' = 1}, true)
*
* Expanded notation:
*
* Related(class = Company\Project\Projects, join = {'_id' => 'entity_id'}, sort = {'_id' = 1}, updatable = true)
*
*
* @Conflicts('Embedded')
* @Conflicts('EmbeddedArray')
* @Conflicts('DbRef')
* @Conflicts('DbRefArray')
* @Conflicts('RelatedArray')
*
*
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
class RelatedAnnotation extends ManganPropertyAnnotation
{
public $class;
public $join;
public $condition;
public $updatable;
public $value;
public function init()
{
$relMeta = $this->_getMeta();
$relMeta->single = true;
$relMeta->isArray = false;
$this->getEntity()->related = $relMeta;
$this->getEntity()->propagateEvents = true;
$this->getEntity()->owned = true;
$this->getEntity()->decorators[] = RelatedDecorator::class;
$this->getEntity()->decorators[] = EmbedRefDecorator::class;
}
/**
*
* @return RelatedMeta
*/
protected function _getMeta()
{
$data = ParamsExpander::expand($this, ['class', 'join', 'sort', 'updatable']);
// Do not expand `condition` with params expander for backward compat.
if(isset($this->value['condition']))
{
$data['condition'] = $this->value['condition'];
}
if (empty($this->getEntity()->related))
{
$relMeta = new RelatedMeta();
}
else
{
$relMeta = $this->getEntity()->related;
}
foreach ($data as $key => $val)
{
$relMeta->$key = $val;
}
if (!$relMeta->class)
{
$relMeta->class = $this->getMeta()->type()->name;
}
if (empty($relMeta->join) && empty($relMeta->condition))
{
throw new UnexpectedValueException(sprintf('Parameter `join` or `condition` is required for `%s`, model `%s`, field `%s`', static::class, $this->getMeta()->type()->name, $this->getEntity()->name));
}
if (empty($relMeta->sort))
{
$relMeta->sort = [
'_id' => SortInterface::SortAsc
];
}
return $relMeta;
}
}
API documentation generated by ApiGen