Interface LocatorInterface
Registries for Table objects should implement this interface.
Method Summary
- config() public
Stores a list of options to be used when instantiating an object with a matching alias.
- getConfig() public
- setConfig() public
Method Detail
clear() public
clear()
Clears the registry of configuration and instances.
config() public
config(mixed $alias, mixed $options)
Stores a list of options to be used when instantiating an object with a matching alias.
Parameters
-
string|null
$alias optional Name of the alias
-
array|null
$options optional list of options for the alias
Returns
array
The config data.
exists() public
exists(mixed $alias)
Check to see if an instance exists in the registry.
Parameters
-
string
$alias The alias to check for.
Returns
bool
get() public
get(mixed $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
getConfig() public
getConfig(mixed $alias)
Parameters
-
mixed
$alias
remove() public
remove(mixed $alias)
Removes an instance from the registry.
Parameters
-
string
$alias The alias to remove.
set() public
set(mixed $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
setConfig() public
setConfig(mixed $alias, mixed $options)
Parameters
-
mixed
$alias -
mixed
$options
© 2005–present 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.
https://api.cakephp.org/3.9/interface-Cake.ORM.Locator.LocatorInterface.html