<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.1.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\ORM\Locator;
use Cake\ORM\Table;
/**
* Registries for Table objects should implement this interface.
*
* @method array getConfig($alias)
* @method $this setConfig($alias, $options = null)
*/
interface LocatorInterface
{
/**
* Stores a list of options to be used when instantiating an object
* with a matching alias.
*
* @param string|null $alias Name of the alias
* @param array|null $options list of options for the alias
* @return array The config data.
*/
public function config($alias = null, $options = null);
/**
* Get a table instance from the registry.
*
* @param string $alias The alias name you want to get.
* @param array $options The options you want to build the table with.
* @return \Cake\ORM\Table
*/
public function get($alias, array $options = []);
/**
* Check to see if an instance exists in the registry.
*
* @param string $alias The alias to check for.
* @return bool
*/
public function exists($alias);
/**
* Set an instance.
*
* @param string $alias The alias to set.
* @param \Cake\ORM\Table $object The table to set.
* @return \Cake\ORM\Table
*/
public function set($alias, Table $object);
/**
* Clears the registry of configuration and instances.
*
* @return void
*/
public function clear();
/**
* Removes an instance from the registry.
*
* @param string $alias The alias to remove.
* @return void
*/
public function remove($alias);
}