Provides a registry/factory for Table objects.
This registry allows you to centralize the configuration for tables their connections and other meta-data.
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.
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); Clears the registry of configuration and instances.
Check to see if an instance exists in the registry.
Get a table instance from the registry.
Returns a singleton instance of LocatorInterface implementation.
Removes an instance from the registry.
Set an instance.
Sets singleton instance of LocatorInterface implementation.
clear(): void
Clears the registry of configuration and instances.
voidexists(string $alias): bool
Check to see if an instance exists in the registry.
string $alias The alias to check for.
boolget(string $alias, array<string, mixed> $options = []): Cake\ORM\Table
Get a table instance from the registry.
See options specification in {@link TableLocator::get()}.
string $alias The alias name you want to get.
array<string, mixed> $options optional The options you want to build the table with.
Cake\ORM\TablegetTableLocator(): Cake\ORM\Locator\LocatorInterface
Returns a singleton instance of LocatorInterface implementation.
Cake\ORM\Locator\LocatorInterfaceremove(string $alias): void
Removes an instance from the registry.
string $alias The alias to remove.
voidset(string $alias, Cake\ORM\Table $object): Cake\ORM\Table
Set an instance.
string $alias The alias to set.
Cake\ORM\Table $object The table to set.
Cake\ORM\TablesetTableLocator(Cake\ORM\Locator\LocatorInterface $tableLocator): void
Sets singleton instance of LocatorInterface implementation.
Cake\ORM\Locator\LocatorInterface $tableLocator Instance of a locator to use.
void
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/class-Cake.ORM.TableRegistry.html