Maslosoft Mangan API

Name: Mangan
Brand: Maslosoft

Class RelatedMeta

Related metadata holder

Maslosoft\Mangan\Meta\BaseMeta uses Maslosoft\Addendum\Traits\MetaState (not available)

Maslosoft\Mangan\Meta\RelatedMeta

Namespace: Maslosoft\Mangan\Meta
Author: Piotr Maselkowski
Located at Meta/RelatedMeta.php

`public boolean`	`$single` Whether treat field as single related document Whether treat field as single related document	# `false`
`public boolean`	`$isArray` Whether field should contain array of related documents. Whether field should contain array of related documents.	# `false`
`public string`	`$class` Default class for related document. Defaults to current document class. Default class for related document. Defaults to current document class.	# `''`
`public boolean`	`$updatable` Whether related objects should be updated on save of main document Whether related objects should be updated on save of main document	# `true`
`public mixed[]`	`$join` On which keys join documents. On which keys join documents. Keys should be current document field names, values should be related document field names. Simple relation: [ _id => parentId ] Complex relation: `php [ ownerId => parentId, companyId => companyId ]`	# `[]`
`public integer[]`	`$sort` Default order of related entities. Key is sort field, value is direction, one of SortInterface constants. Default order of related entities. Key is sort field, value is direction, one of SortInterface constants. See `Maslosoft\Mangan\Interfaces\SortInterface`	# `[]`
`public mixed[]`	`$condition` Extra static condition for related entities. Extra static condition for related entities.	# `[]`
`public string`	`$orderField` Field for storing order Field for storing order See `Maslosoft\Mangan\Annotations\RelatedOrderingAnnotation`	# `''`

API documentation generated by ApiGen