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 <?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\Meta;
use Maslosoft\Mangan\Annotations\RelatedOrderingAnnotation;
use Maslosoft\Mangan\Interfaces\SortInterface;
/**
* Related metadata holder
*
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
class RelatedMeta extends BaseMeta
{
/**
* Whether treat field as single related document
* @var bool
*/
public $single = false;
/**
* Whether field should contain array of related documents.
* @var bool
*/
public $isArray = false;
/**
* Default class for related document. Defaults to current document class.
* @var string
*/
public $class = '';
/**
* Whether related objects should be updated on save of main document
* @var bool
*/
public $updatable = true;
/**
* On which keys join documents.
*
* Keys should be current document field names, values should be related document field names.
*
* Simple relation:
* ```php
* [
* _id => parentId
* ]
* ```
*
* Complex relation:
* ```php
* [
* ownerId => parentId,
* companyId => companyId
* ]
* ```
* @var mixed[]
*/
public $join = [];
/**
* Default order of related entities.
* Key is sort field, value is direction, one of SortInterface constants.
*
* @see SortInterface
* @var int[]
*/
public $sort = [];
/**
* Extra static condition for related entities.
* @var mixed[]
*/
public $condition = [];
/**
* Field for storing order
*
* @see RelatedOrderingAnnotation
* @var string
*/
public $orderField = '';
}
API documentation generated by ApiGen