Interface LocatorInterface
Registries for Table objects should implement this interface.
Method Summary
-
clear() public
Clears the registry of configuration and instances.
-
config() public
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.
-
get() public
Get a table instance from the registry.
-
getConfig() public @method
-
remove() public
Removes an instance from the registry.
-
set() public
Set an instance.
-
setConfig() public @method
Method Detail
config() ¶ public
config(string|null $alias = null, array|null $options = null): arrayStores 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
arrayThe config data.
exists() ¶ public
exists(string $alias): boolCheck to see if an instance exists in the registry.
Parameters
-
string$alias The alias to check for.
Returns
boolget() ¶ public
get(string $alias, array $options = []): Cake\ORM\TableGet 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\Tableremove() ¶ public
remove(string $alias): voidRemoves an instance from the registry.
Parameters
-
string$alias The alias to remove.
Returns
voidset() ¶ public
set(string $alias, Cake\ORM\Table $object): Cake\ORM\TableSet an instance.
Parameters
-
string$alias The alias to set.
-
Cake\ORM\Table$object The table to set.
Returns
Cake\ORM\TablesetConfig() ¶ public @method
setConfig(mixed $alias, mixed $options = null): $thisParameters
-
$alias -
$options optional
Returns
$this