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 TableRegistry 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::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 using get(). One instance is stored per alias. Once an alias is populated the same instance will always be returned. This is used to make the ORM use less memory and help make cyclic references easier to solve.

$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
  Clears the registry of configuration and instances.
• config() public static

  Stores a list of options to be used when instantiating an object with a matching alias.

• exists() public static
  Check to see if an instance exists in the registry.
• get() public static
  Get a table instance from the registry.
• getTableLocator() public static
  Returns a singleton instance of LocatorInterface implementation.
• locator() public static
  Sets and returns a singleton instance of LocatorInterface implementation.
• remove() public static
  Removes an instance from the registry.
• set() public static
  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'