Interface LocatorInterface
Registries for Table objects should implement this interface.
Method Summary
-
clear() public
Clears the registry of configuration and instances.
-
exists() public
Check to see if an instance exists in the registry.
-
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 repository instance from the registry.
-
set() public
Set a table instance.
-
setConfig() public
Stores a list of options to be used when instantiating an object with a matching alias.
Method Detail
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<string, mixed> $options = []): Cake\ORM\TableGet a table instance from the registry.
Parameters
-
string$alias The alias name you want to get.
-
array<string, mixed>$options optional The options you want to build the table with.
Returns
Cake\ORM\TablegetConfig() ¶ public
getConfig(string|null $alias = null): arrayReturns configuration for an alias or the full configuration array for all aliases.
Parameters
-
string|null$alias optional Alias to get config for, null for complete config.
Returns
arrayThe config data.
remove() ¶ public
remove(string $alias): voidRemoves an repository instance from the registry.
Parameters
-
string$alias The alias to remove.
Returns
voidset() ¶ public
set(string $alias, Cake\Datasource\RepositoryInterface $repository): Cake\ORM\TableSet a table instance.
Parameters
-
string$alias The alias to set.
-
Cake\Datasource\RepositoryInterface$repository The table to set.
Returns
Cake\ORM\TablesetConfig() ¶ public
setConfig(array<string, mixed>|string $alias, array<string, mixed>|null $options = null): $thisStores a list of options to be used when instantiating an object with a matching alias.
Parameters
-
array<string, mixed>|string$alias Name of the alias or array to completely overwrite current config.
-
array<string, mixed>|null$options optional list of options for the alias
Returns
$thisThrows
RuntimeExceptionWhen you attempt to configure an existing table instance.