Class TableRegistry

Provides a registry/factory for Table objects.

This registry allows you to centralize the configuration for tables their connections and other meta-data.

Configuring instances

You may need to configure your table objects. Using the TableLocator you can centralize configuration. Any configuration set before instances are created will be used when creating instances. If you modify configuration after an instance is made, the instances will not be updated.

TableRegistry::getTableLocator()->setConfig('Users', ['table' => 'my_users']);

// Prior to 3.6.0
TableRegistry::config('Users', ['table' => 'my_users']);

Configuration data is stored per alias if you use the same table with multiple aliases you will need to set configuration multiple times.

Getting instances

You can fetch instances out of the registry through TableLocator::get(). One instance is stored per alias. Once an alias is populated the same instance will always be returned. This reduces the ORM memory cost and helps make cyclic references easier to solve.

$table = TableRegistry::getTableLocator()->get('Users', $config);

// Prior to 3.6.0
$table = TableRegistry::get('Users', $config);