Interface LocatorInterface

Registries for Table objects should implement this interface.

Namespace: Cake\ORM\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 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

clear() public 

clear(): void

Clears the registry of configuration and instances.

Returns

void

exists() public 

exists(string $alias): bool

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<string, mixed> $options = []): Cake\ORM\Table

Get 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\Table

getConfig() public 

getConfig(string|null $alias = null): array

Returns 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

array

remove() public 

remove(string $alias): void

Removes an repository instance from the registry.

Parameters

string $alias

The alias to remove.

Returns

void

set() public 

set(string $alias, Cake\Datasource\RepositoryInterface $repository): Cake\ORM\Table

Set a table instance.

Parameters

string $alias

The alias to set.

Cake\Datasource\RepositoryInterface $repository

The table to set.

Returns

Cake\ORM\Table

setConfig() public 

setConfig(array<string, mixed>|string $alias, array<string, mixed>|null $options = null): $this

Stores 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

$this

Throws

RuntimeException
When you attempt to configure an existing table instance.

© 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.4/interface-Cake.ORM.Locator.LocatorInterface.html