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 <?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\Interfaces\SortInterface;
use Maslosoft\Mangan\Meta\ManganPropertyAnnotation;
use Maslosoft\Mangan\Meta\RelatedMeta;
/**
* RelatedOrderingAnnotation
*
* Use this annotation to store order of related documents.
* This should be used on same field as Related or RelatedArray annotations are applied.
* This will apply incrementing values on selected field.
*
* Will also apply sort if not set.
*
* Compact notation:
*
* RelatedOrdering('order')
*
* Extended notation:
*
* RelatedOrdering(orderField = 'order')
*
*
* @Conflicts('Embedded')
* @Conflicts('EmbeddedArray')
* @Conflicts('DbRef')
* @Conflicts('DbRefArray')
*
* @template RelatedOrdering('${orderField}')
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
class RelatedOrderingAnnotation extends ManganPropertyAnnotation
{
public $value;
public $orderField;
public function init()
{
$data = ParamsExpander::expand($this, ['orderField']);
if (empty($this->getEntity()->related))
{
$relMeta = new RelatedMeta();
}
else
{
$relMeta = $this->getEntity()->related;
}
foreach ($data as $key => $val)
{
$relMeta->$key = $val;
}
if (empty($relMeta->sort))
{
$relMeta->sort = [
$relMeta->orderField => SortInterface::SortAsc
];
}
$this->getEntity()->related = $relMeta;
}
}
API documentation generated by ApiGen