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

• $_defaultLocatorClass protected static
  string
  Default LocatorInterface implementation class.
• $_locator protected static
  Cake\ORM\Locator\LocatorInterface
  LocatorInterface 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( string $name , array $arguments )

clear( )

config( string|null $alias = null , array|null $options = null )

exists( string $alias )

get( string $alias , array $options = [] )

getTableLocator( )

locator( Cake\ORM\Locator\LocatorInterface $locator = null )

remove( string $alias )

set( string $alias , Cake\ORM\Table $object )

setTableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator )

Properties detail

'Cake\ORM\Locator\TableLocator'