-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
LocatorInterface.php
68 lines (62 loc) · 2.33 KB
/
LocatorInterface.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
<?php
declare(strict_types=1);
/**
* 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\Datasource\Locator\LocatorInterface as BaseLocatorInterface;
use Cake\Datasource\RepositoryInterface;
use Cake\ORM\Table;
/**
* Registries for Table objects should implement this interface.
*/
interface LocatorInterface extends BaseLocatorInterface
{
/**
* Returns configuration for an alias or the full configuration array for
* all aliases.
*
* @param string|null $alias Alias to get config for, null for complete config.
* @return array The config data.
*/
public function getConfig(?string $alias = null): array;
/**
* Stores a list of options to be used when instantiating an object
* with a matching alias.
*
* @param array<string, mixed>|string $alias Name of the alias or array to completely
* overwrite current config.
* @param array<string, mixed>|null $options list of options for the alias
* @return $this
* @throws \RuntimeException When you attempt to configure an existing
* table instance.
*/
public function setConfig(array|string $alias, ?array $options = null);
/**
* Get a table instance from the registry.
*
* @param string $alias The alias name you want to get.
* @param array<string, mixed> $options The options you want to build the table with.
* @return \Cake\ORM\Table
*/
public function get(string $alias, array $options = []): Table;
/**
* Set a table instance.
*
* @param string $alias The alias to set.
* @param \Cake\ORM\Table $repository The table to set.
* @return \Cake\ORM\Table
* @psalm-suppress MoreSpecificImplementedParamType
*/
public function set(string $alias, RepositoryInterface $repository): Table;
}