How to load non-default models?

Question

In CakePHP2.x, I have frequently used $uses attribute in controllers but it seems that this attribute is no longer available in CakePHP 3.0.

The only way I know to load models which is not default one is to use loadModel() method. Is this recommended way to load models? Or is there any other way to load models?

Answer 1

Your observations are correct, there is no $uses property anymore, instead models/tables that do not match the controller (ex PostsTable for PostsController) and are not available via associations, must be loaded explicitly.

This can be done by using either

• Controller::loadModel() which adds the instance to the controller as a property.
• or TableRegistry::get() which just returns the instance.
• and as of CakePHP 3.1 using TableLocator::get(), either by retrieving the locator via TableRegistry::locator() (TableRegistry::getTableLocator() as of CakePHP 3.5.0), or via LocatorAwareTrait::tableLocator() (LocatorAwareTrait::getTableLocator() as of CakePHP 3.5.0), which however usually shouldn't be required in a controller.

So this is kind of a yes to your question, Controller::loadModel(), ie

$this->loadModel('Name');

is a viable way of adding model/table instances to your controller as properties, wich at least in the default configuration, is essentially the shorthand for:

$this->Name = TableRegistry::get('Name');

but more loadModel() is more abstracted, and supports non-table repositories.