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);
Properties summary
-
$_defaultLocatorClassprotected staticstringDefault LocatorInterface implementation class. -
$_locatorprotected staticLocatorInterface implementation instance.
Method Summary
-
__callStatic() public static
Proxy for static calls on a locator. -
clear() public static deprecated
Clears the registry of configuration and instances. -
config() public static deprecated
Stores a list of options to be used when instantiating an object with a matching alias.
-
exists() public static deprecated
Check to see if an instance exists in the registry. -
get() public static deprecated
Get a table instance from the registry. -
getTableLocator() public static
Returns a singleton instance of LocatorInterface implementation. -
locator() public static deprecated
Sets and returns a singleton instance of LocatorInterface implementation. -
remove() public static deprecated
Removes an instance from the registry. -
set() public static deprecated
Set an instance. -
setTableLocator() public static
Sets singleton instance of LocatorInterface implementation.
Method Detail
__callStatic() public static ¶
__callStatic( string $name , array $arguments )
Proxy for static calls on a locator.
Parameters
- string $name
- Method name.
- array $arguments
- Method arguments.
Returns
clear() public static deprecated ¶
clear( )
Clears the registry of configuration and instances.
Deprecated
config() public static deprecated ¶
config( string|null $alias = null , array|null $options = null )
Stores a list of options to be used when instantiating an object with a matching alias.
Deprecated
Parameters
- string|null $alias optional null
- Name of the alias
- array|null $options optional null
- list of options for the alias
Returns
The config data.
exists() public static deprecated ¶
exists( string $alias )
Check to see if an instance exists in the registry.
Deprecated
Parameters
- string $alias
- The alias to check for.
Returns
get() public static deprecated ¶
get( string $alias , array $options = [] )
Get a table instance from the registry.
See options specification in TableLocator::get().
Deprecated
Parameters
- string $alias
- The alias name you want to get.
- array $options optional []
- The options you want to build the table with.
Returns
getTableLocator() public static ¶
getTableLocator( )
Returns a singleton instance of LocatorInterface implementation.
Returns
locator() public static deprecated ¶
locator( Cake\ORM\Locator\LocatorInterface $locator = null )
Sets and returns a singleton instance of LocatorInterface implementation.
Deprecated
Parameters
-
Cake\ORM\Locator\LocatorInterface$locator optional null - Instance of a locator to use.
Returns
remove() public static deprecated ¶
remove( string $alias )
Removes an instance from the registry.
Deprecated
Parameters
- string $alias
- The alias to remove.
set() public static deprecated ¶
set( string $alias , Cake\ORM\Table $object )
Set an instance.
Deprecated
Parameters
- string $alias
- The alias to set.
-
Cake\ORM\Table$object - The table to set.
Returns
setTableLocator() public static ¶
setTableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator )
Sets singleton instance of LocatorInterface implementation.
Parameters
-
Cake\ORM\Locator\LocatorInterface$tableLocator - Instance of a locator to use.
Properties detail
$_defaultLocatorClass ¶
Default LocatorInterface implementation class.
'Cake\ORM\Locator\TableLocator'