Interface LocatorInterface

Registries for Table objects should implement this interface.

Direct Implementers

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.
  • remove() public
    Removes an instance from the registry.
  • set() public
    Set an instance.

Method Detail

clear()source public

clear( )

Clears the registry of configuration and instances.

config()source public

config( string|null $alias null , array|null $options null )

Stores a list of options to be used when instantiating an object with a matching alias.

Parameters

string|null $alias optional null
Name of the alias
array|null $options optional null
list of options for the alias

Returns

array
The config data.

exists()source public

exists( string $alias )

Check to see if an instance exists in the registry.

Parameters

string $alias
The alias to check for.

Returns

boolean

get()source public

get( string $alias , array $options [] )

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

remove()source public

remove( string $alias )

Removes an instance from the registry.

Parameters

string $alias
The alias to remove.

set()source public

set( string $alias , Cake\ORM\Table $object )

Set an instance.

Parameters

string $alias
The alias to set.
Cake\ORM\Table $object
The table to set.

Returns

Cake\ORM\Table

© 2005–2017 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/3.4/class-Cake.ORM.Locator.LocatorInterface.html