Class TableLocator
Provides a default registry/factory for Table objects.
- Cake\ORM\Locator\TableLocator implements Cake\ORM\Locator\LocatorInterface
Properties summary
-
$_configprotectedarrayConfiguration for aliases. -
$_fallbackedprotectedContains a list of Table objects that were created out of the built-in Table class. The list is indexed by table alias
-
$_instancesprotectedInstances that belong to the registry. -
$_optionsprotectedarrayContains a list of options that were passed to get() method. -
$locationsprotectedarrayContains a list of locations where table classes should be looked for.
Method Summary
-
__construct() public
Constructor. -
_create() protected
Wrapper for creating table instances -
_getClassName() protected
Gets the table class name. -
addLocation() public
Adds a location where tables should be looked for. -
clear() public
Clears the registry of configuration and instances. -
config() public deprecated
Stores a list of options to be used when instantiating an object with a matching alias.
-
exists() public
Check to see if an instance exists in the registry. -
genericInstances() public
Returns the list of tables that were created by this registry that could not be instantiated from a specific subclass. This method is useful for debugging common mistakes when setting up associations or created new table classes.
-
get() public
Get a table instance from the registry. -
getConfig() public
Returns configuration for an alias or the full configuration array for all aliases. -
remove() public
Removes an instance from the registry. -
set() public
Set an instance. -
setConfig() public
Stores a list of options to be used when instantiating an object with a matching alias.
Method Detail
__construct() public ¶
__construct( array $locations = null )
Constructor.
Parameters
- array $locations optional null
Locations where tables should be looked for. If none provided, the default
Model\Tableunder your app's namespace is used.
_create() protected ¶
_create( array $options )
Wrapper for creating table instances
Parameters
- array $options
- The alias to check for.
Returns
_getClassName() protected ¶
_getClassName( string $alias , array $options = [] )
Gets the table class name.
Parameters
- string $alias
- The alias name you want to get.
- array $options optional []
- Table options array.
Returns
addLocation() public ¶
addLocation( string $location )
Adds a location where tables should be looked for.
Parameters
- string $location
- Location to add.
Returns
$this
Since
config() public deprecated ¶
config( string|array|null $alias = null , array|null $options = null )
Stores a list of options to be used when instantiating an object with a matching alias.
The options that can be stored are those that are recognized by get()
If second argument is omitted, it will return the current settings
for $alias.
If no arguments are passed it will return the full configuration array for all aliases
Deprecated
Parameters
- string|array|null $alias optional null
- Name of the alias
- array|null $options optional null
- list of options for the alias
Returns
The config data.
Throws
When you attempt to configure an existing table instance.
Implementation of
exists() public ¶
exists( string $alias )
Check to see if an instance exists in the registry.
Parameters
- string $alias
- The alias to check for.
Returns
Implementation of
genericInstances() public ¶
genericInstances( )
Returns the list of tables that were created by this registry that could not be instantiated from a specific subclass. This method is useful for debugging common mistakes when setting up associations or created new table classes.
Returns
get() public ¶
get( string $alias , array $options = [] )
Get a table instance from the registry.
Tables are only created once until the registry is flushed. This means that aliases must be unique across your application. This is important because table associations are resolved at runtime and cyclic references need to be handled correctly.
The options that can be passed are the same as in Cake\ORM\Table::__construct(), but the
className key is also recognized.
Options
classNameDefine the specific class name to use. If undefined, CakePHP will generate the class name based on the alias. For example 'Users' would result inApp\Model\Table\UsersTablebeing used. If this class does not exist, then the defaultCake\ORM\Tableclass will be used. By setting theclassNameoption you can define the specific class to use. The className option supports plugin short class references Cake\Core\App::shortName().tableDefine the table name to use. If undefined, this option will default to the underscored version of the alias name.connectionInject the specific connection object to use. If this option andconnectionNameare undefined, The table class'defaultConnectionName()method will be invoked to fetch the connection name.connectionNameDefine the connection name to use. The named connection will be fetched from Cake\Datasource\ConnectionManager.
Note If your $alias uses plugin syntax only the name part will be used as
key in the registry. This means that if two plugins, or a plugin and app provide
the same alias, the registry will only store the first instance.
Parameters
- string $alias
- The alias name you want to get.
- array $options optional []
The options you want to build the table with. If a table has already been loaded the options will be ignored.
Returns
Throws
When you try to configure an alias that already exists.
Implementation of
getConfig() public ¶
getConfig( string|null $alias = null )
Returns configuration for an alias or the full configuration array for all aliases.
Parameters
- string|null $alias optional null
- Alias to get config for, null for complete config.
Returns
The config data.
remove() public ¶
remove( string $alias )
Removes an instance from the registry.
Parameters
- string $alias
- The alias to remove.
Implementation of
set() public ¶
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
Implementation of
setConfig() public ¶
setConfig( string|array $alias , array|null $options = null )
Stores a list of options to be used when instantiating an object with a matching alias.
Parameters
- string|array $alias
- Name of the alias or array to completely overwrite current config.
- array|null $options optional null
- list of options for the alias
Returns
$this
Throws
When you attempt to configure an existing table instance.
Magic methods inherited from Cake\ORM\Locator\LocatorInterface
getConfig()
|
Properties detail
$_fallbacked ¶
Cake\ORM\Table[]
Contains a list of Table objects that were created out of the built-in Table class. The list is indexed by table alias
[]
$locations ¶
Contains a list of locations where table classes should be looked for.
[]