-
Notifications
You must be signed in to change notification settings - Fork 7
/
AbstractLocator.php
115 lines (101 loc) · 3.28 KB
/
AbstractLocator.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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
<?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 4.1.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Datasource\Locator;
use Cake\Core\Exception\CakeException;
use Cake\Datasource\RepositoryInterface;
/**
* Provides an abstract registry/factory for repository objects.
*/
abstract class AbstractLocator implements LocatorInterface
{
/**
* Instances that belong to the registry.
*
* @var array<string, \Cake\Datasource\RepositoryInterface>
*/
protected array $instances = [];
/**
* Contains a list of options that were passed to get() method.
*
* @var array<string, array>
*/
protected array $options = [];
/**
* {@inheritDoc}
*
* @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\Datasource\RepositoryInterface
* @throws \Cake\Core\Exception\CakeException When trying to get alias for which instance
* has already been created with different options.
*/
public function get(string $alias, array $options = []): RepositoryInterface
{
$storeOptions = $options;
unset($storeOptions['allowFallbackClass']);
if (isset($this->instances[$alias])) {
if ($storeOptions && isset($this->options[$alias]) && $this->options[$alias] !== $storeOptions) {
throw new CakeException(sprintf(
'You cannot configure `%s`, it already exists in the registry.',
$alias
));
}
return $this->instances[$alias];
}
$this->options[$alias] = $storeOptions;
return $this->instances[$alias] = $this->createInstance($alias, $options);
}
/**
* Create an instance of a given classname.
*
* @param string $alias Repository alias.
* @param array<string, mixed> $options The options you want to build the instance with.
* @return \Cake\Datasource\RepositoryInterface
*/
abstract protected function createInstance(string $alias, array $options): RepositoryInterface;
/**
* @inheritDoc
*/
public function set(string $alias, RepositoryInterface $repository): RepositoryInterface
{
return $this->instances[$alias] = $repository;
}
/**
* @inheritDoc
*/
public function exists(string $alias): bool
{
return isset($this->instances[$alias]);
}
/**
* @inheritDoc
*/
public function remove(string $alias): void
{
unset(
$this->instances[$alias],
$this->options[$alias]
);
}
/**
* @inheritDoc
*/
public function clear(): void
{
$this->instances = [];
$this->options = [];
}
}