Class EmbedOne
Represents an embedded document that only contains one instance.
Constants
Property Summary
-
$alias protected
stringThe alias this association uses.
-
$entityClass protected
stringThe class to use for the embeded document.
-
$indexClass protected
stringThe index class this embed is linked to
-
$property protected
stringThe property the embedded document is located under.
Method Summary
-
__construct() public
Constructor
-
alias() public
Get the alias for this embed.
-
entityClass() public
Get/set the entity/document class used for this embed.
-
getAlias() public
Get the alias for this embed.
-
getEntityClass() public
Get the entity/document class used for this embed.
-
getIndexClass() public
Get the index class used for this embed.
-
getProperty() public
Get the property this embed is attached to.
-
hydrate() public
Hydrate an instance from the parent documents data.
-
indexClass() public
Get/set the index class used for this embed.
-
property() public
Get/set the property this embed is attached to.
-
setEntityClass() public
Sets the entity/document class used for this embed.
-
setIndexClass() public
Set the index class used for this embed.
-
setProperty() public
Set the property this embed is attached to.
-
type() public
Get the type of association this is.
Method Detail
__construct() ¶ public
__construct(string $alias, array $options = [])Constructor
Parameters
-
string$alias The alias/name for the embedded document.
-
array$options optional The options for the embedded document.
entityClass() ¶ public
entityClass(string|null $name = null): stringGet/set the entity/document class used for this embed.
Parameters
-
string|null$name optional The class name to set.
Returns
stringgetEntityClass() ¶ public
getEntityClass(): stringGet the entity/document class used for this embed.
Returns
stringgetIndexClass() ¶ public
getIndexClass(): stringGet the index class used for this embed.
Returns
stringgetProperty() ¶ public
getProperty(): stringGet the property this embed is attached to.
Returns
stringhydrate() ¶ public
hydrate(array $data, array $options): Cake\ElasticSearch\DocumentHydrate an instance from the parent documents data.
Parameters
-
array$data The data to use in the embedded document.
-
array$options The options to use in the new document.
Returns
Cake\ElasticSearch\DocumentindexClass() ¶ public
indexClass(string|null|Cake\ElasticSearch\Index $name = null): stringGet/set the index class used for this embed.
Parameters
-
string|null|Cake\ElasticSearch\Index$name optional The class name to set.
Returns
stringproperty() ¶ public
property(string|null $name = null): stringGet/set the property this embed is attached to.
Parameters
-
string|null$name optional The property name to set.
Returns
stringsetEntityClass() ¶ public
setEntityClass(string $name): $thisSets the entity/document class used for this embed.
Parameters
-
string$name The name of the class to use
Returns
$thissetIndexClass() ¶ public
setIndexClass(string|null|Cake\ElasticSearch\Index $name): $thisSet the index class used for this embed.
Parameters
-
string|null|Cake\ElasticSearch\Index$name The class name to set.
Returns
$thissetProperty() ¶ public
setProperty(string|null $name = null): stringSet the property this embed is attached to.
Parameters
-
string|null$name optional The property name to set.
Returns
stringtype() ¶ public
type(): stringGet the type of association this is.
Returns one of the association type constants.
Returns
string