Class AbstractLocator
Provides an abstract registry/factory for repository objects.
Properties summary
- $instances protected
\Cake\Datasource\RepositoryInterface[]
Instances that belong to the registry.
- $options protected
array
Contains a list of options that were passed to get() method.
Method Summary
Method Detail
clear() public
clear()
Clears the registry of configuration and instances.
createInstance() abstract protected
createInstance(string $alias, array $options)
Create an instance of a given classname.
Parameters
-
string
$alias Repository alias.
-
array
$options The options you want to build the instance with.
Returns
\Cake\Datasource\RepositoryInterface
exists() public
exists(string $alias)
Check to see if an instance exists in the registry.
Parameters
-
string
$alias The alias to check for.
Returns
bool
get() public
get(string $alias, array $options)
Get a repository 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\Datasource\RepositoryInterface
Throws
RuntimeException
When trying to get alias for which instance has already been created with different options.
remove() public
remove(string $alias)
Removes an repository instance from the registry.
Parameters
-
string
$alias The alias to remove.
set() public
set(string $alias, \Cake\Datasource\RepositoryInterface $repository)
Set a repository instance.
Parameters
-
string
$alias The alias to set.
-
\Cake\Datasource\RepositoryInterface
$repository The repository to set.
Returns
\Cake\Datasource\RepositoryInterface
Property Detail
$instances protected
Instances that belong to the registry.
Type
\Cake\Datasource\RepositoryInterface[]
$options protected
Contains a list of options that were passed to get() method.
Type
array
© 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/4.1/class-Cake.Datasource.Locator.AbstractLocator.html