Trait ModelAwareTrait
Provides functionality for loading table classes and other repositories onto properties of the host object.
Example users of this trait are Cake\Controller\Controller and Cake\Console\Shell.
Property Summary
-
$_modelFactories protected
arrayA list of overridden model factory functions.
-
$_modelType protected
stringThe model type to use.
-
$modelClass public
stringThis object's primary model class name. Should be a plural form. CakePHP will not inflect the name.
Method Summary
-
_setModelClass() protected
Set the modelClass and modelKey properties based on conventions.
-
getModelType() public
Get the model type to be used by this class
-
loadModel() public
Loads and constructs repository objects required by this object
-
modelFactory() public
Override a existing callable to generate repositories of a given type.
-
modelType() public deprecated
Set or get the model type to be used by this class
-
setModelType() public
Set the model type to be used by this class
Method Detail
_setModelClass() ¶ protected
_setModelClass(string $name): voidSet the modelClass and modelKey properties based on conventions.
If the properties are already set they will not be overwritten
Parameters
-
string$name Class name.
Returns
voidgetModelType() ¶ public
getModelType(): stringGet the model type to be used by this class
Returns
stringloadModel() ¶ public
loadModel(string|null $modelClass = null, string|null $modelType = null): Cake\Datasource\RepositoryInterfaceLoads and constructs repository objects required by this object
Typically used to load ORM Table objects as required. Can also be used to load other types of repository objects your application uses.
If a repository provider does not return an object a MissingModelException will be thrown.
Parameters
-
string|null$modelClass optional Name of model class to load. Defaults to $this->modelClass
-
string|null$modelType optional The type of repository to load. Defaults to the modelType() value.
Returns
Cake\Datasource\RepositoryInterfaceThrows
Cake\Datasource\Exception\MissingModelExceptionIf the model class cannot be found.
InvalidArgumentExceptionWhen using a type that has not been registered.
UnexpectedValueExceptionIf no model type has been defined
modelFactory() ¶ public
modelFactory(string $type, callable $factory): voidOverride a existing callable to generate repositories of a given type.
Parameters
-
string$type The name of the repository type the factory function is for.
-
callable$factory The factory function used to create instances.
Returns
voidmodelType() ¶ public
modelType(string|null $modelType = null): string|$thisSet or get the model type to be used by this class
Parameters
-
string|null$modelType optional The model type or null to retrieve the current
Returns
string|$thissetModelType() ¶ public
setModelType(string $modelType): $thisSet the model type to be used by this class
Parameters
-
string$modelType The model type
Returns
$thisProperty Detail
$modelClass ¶ public
This object's primary model class name. Should be a plural form. CakePHP will not inflect the name.
Example: For an object named 'Comments', the modelClass would be 'Comments'.
Plugin classes should use Plugin.Comments style names to correctly load
models from the correct plugin.
Type
string