Maslosoft Mangan API

Name: Mangan
Brand: Maslosoft

Class DocumentPropertyMeta

DocumentPropertyMeta

Maslosoft\Addendum\Collections\MetaProperty

Maslosoft\Mangan\Meta\DocumentPropertyMeta

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

Properties summary

`public string`	`$label` Field label Field label	# `''`
`public string`	`$description` Description Description	# `''`
`public Maslosoft\Mangan\Meta\DbRefMeta`	`$dbRef` DB Ref metadata DB Ref metadata	# `null`
`public Maslosoft\Mangan\Meta\EmbeddedMeta`	`$embedded` Embedded document meta data Embedded document meta data	# `null`
`public Maslosoft\Mangan\Meta\RelatedMeta`	`$related` Related document meta data Related document meta data	# `null`
`public boolean`	`$owned` If document is owned set this to true. If document is owned set this to true. NOTE: This should not be set directly, but rather by annotations.	# `false`
`public boolean`	`$updatable` When ownered decide if should be updatable When ownered decide if should be updatable NOTE: This should not be set directly, but rather by annotations.	# `true`
`public Maslosoft\Mangan\Meta\I18NMeta`	`$i18n` I18N metadata I18N metadata	# `null`
`public string[]`	`$decorators` Decorators Decorators	# `[]`
`public string\|mixed[]`	`$sanitizer` Sanitizer short name or class name or configuration. Sanitizer short name or class name or configuration. Example will resolve to `\Maslosoft\Mangan\Sanitizers\MongoObjectId`: $sanitizer = 'MongoObjectId'; Or use full class name: $sanitizer = \Maslosoft\Mangan\Sanitizers\MongoObjectId::class; Or configuration: $sanitizer = [ \Maslosoft\Mangan\Sanitizers\MongoObjectId::class, 'nullable' => true ];	# `null`
`public boolean`	`$sanitizeArray` Whether sanitization should be performed for array of elements Whether sanitization should be performed for array of elements	# `false`
`public boolean`	`$persistent` If field should be persistent, by default true If field should be persistent, by default true	# `true`
`public boolean\|null`	`$safe` Whether attribute is safe for mass assignement Whether attribute is safe for mass assignement See EntityManager::setAttributes()	# `null`
`public boolean`	`$readonly` Whether property is read only Whether property is read only	# `false`
`public boolean`	`$toJson` Whether property should be included when converting to Json Whether property should be included when converting to Json See `Maslosoft\Mangan\Transformers\JsonArray`	# `true`
`public boolean`	`$fromJson` Whether property should be included when converting from Json Whether property should be included when converting from Json See `Maslosoft\Mangan\Transformers\JsonArray`	# `true`
`public boolean`	`$toArray` Whether property should be included when converting to document array Whether property should be included when converting to document array See `Maslosoft\Mangan\Transformers\DocumentArray`	# `true`
`public boolean`	`$fromArray` Whether property should be included when converting from document array Whether property should be included when converting from document array See `Maslosoft\Mangan\Transformers\DocumentArray`	# `true`
`public boolean\|Maslosoft\Mangan\Meta\SecretMeta`	`$secret` Whether property is secret Whether property is secret	# `false`
`public boolean`	`$propagateEvents` Whether events should be propagated to this property sub objects Whether events should be propagated to this property sub objects	# `false`
`public Maslosoft\Mangan\Meta\ValidatorMeta[]`	`$validators` Validators configuration Validators configuration	# `[]`
`public Maslosoft\Mangan\Meta\IndexMeta[]`	`$index` Index specification. Index specification.	# `null`

API documentation generated by ApiGen

Maslosoft Mangan API

Namespaces

Classes

Class DocumentPropertyMeta

Properties summary

See

See

See

See

See

Contact us