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);

Namespace: Cake\ORM
Located at ORM/TableRegistry.php

Method Detail

__callStaticsource public static

__callStatic( string $name , array $arguments )

Proxy for static calls on a locator.

Parameters

string $name: Method name.
array $arguments: Method arguments.

Returns

mixed
mixed

clearsource public static

clear( )

Clears the registry of configuration and instances.

configsource public static

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.

Parameters

string|null $alias optional null: Name of the alias
array|null $options optional null: list of options for the alias

Returns

array
The config data.

existssource public static

exists( string $alias )

Check to see if an instance exists in the registry.

Parameters

string $alias: The alias to check for.

Returns

boolean
bool

getsource public static

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

Get a table instance from the registry.

Parameters

string $alias: The alias name you want to get.
array $options optional []: The options you want to build the table with.

Returns

Cake\ORM\Table
\Cake\ORM\Table

locatorsource public static

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

Sets and returns a singleton instance of LocatorInterface implementation.

Parameters

Cake\ORM\Locator\LocatorInterface $locator optional null: Instance of a locator to use.

Returns

Cake\ORM\Locator\LocatorInterface
\Cake\ORM\Locator\LocatorInterface

removesource public static

remove( string $alias )

Removes an instance from the registry.

Parameters

string $alias: The alias to remove.

setsource public static

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

Set an instance.

Parameters

string $alias: The alias to set.
Cake\ORM\Table $object: The table to set.

Returns

Cake\ORM\Table
\Cake\ORM\Table

Properties summary

$_defaultLocatorClasssource

protected static string

Default LocatorInterface implementation class.

'Cake\ORM\Locator\TableLocator'

$_locatorsource

protected static Cake\ORM\Locator\LocatorInterface

LocatorInterface implementation instance.

© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.ORM.TableRegistry.html