Interface LocatorInterface
Registries for repository objects should implement this interface.
Namespace: Cake\Datasource\Locator
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 repository instance from the registry.
-
remove() public
Removes an repository instance from the registry.
-
set() public
Set a repository instance.
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\Datasource\RepositoryInterfaceGet a repository 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\Datasource\RepositoryInterfaceThrows
RuntimeExceptionWhen trying to get alias for which instance has already been created with different options.
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\Datasource\RepositoryInterfaceSet a repository instance.
Parameters
-
string$alias The alias to set.
-
Cake\Datasource\RepositoryInterface$repository The repository to set.
Returns
Cake\Datasource\RepositoryInterface