|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/** |
|
4
|
|
|
* This file is part of byrokrat\giroapp. |
|
5
|
|
|
* |
|
6
|
|
|
* byrokrat\giroapp is free software: you can redistribute it and/or |
|
7
|
|
|
* modify it under the terms of the GNU General Public License as published |
|
8
|
|
|
* by the Free Software Foundation, either version 3 of the License, or |
|
9
|
|
|
* (at your option) any later version. |
|
10
|
|
|
* |
|
11
|
|
|
* byrokrat\giroapp is distributed in the hope that it will be useful, |
|
12
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
13
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
14
|
|
|
* GNU General Public License for more details. |
|
15
|
|
|
* |
|
16
|
|
|
* You should have received a copy of the GNU General Public License |
|
17
|
|
|
* along with byrokrat\giroapp. If not, see <http://www.gnu.org/licenses/>. |
|
18
|
|
|
* |
|
19
|
|
|
* Copyright 2016-21 Hannes Forsgård |
|
20
|
|
|
*/ |
|
21
|
|
|
|
|
22
|
|
|
declare(strict_types=1); |
|
23
|
|
|
|
|
24
|
|
|
namespace byrokrat\giroapp\Utils; |
|
25
|
|
|
|
|
26
|
|
|
use byrokrat\giroapp\Exception\UnknownIdentifierException; |
|
27
|
|
|
|
|
28
|
|
|
trait CollectionTrait |
|
29
|
|
|
{ |
|
30
|
|
|
/** @var array<string, mixed> */ |
|
31
|
|
|
private $items = []; |
|
32
|
|
|
|
|
33
|
|
|
abstract protected function describeItem(): string; |
|
34
|
|
|
|
|
35
|
|
|
/** |
|
36
|
|
|
* @param mixed $item |
|
37
|
|
|
*/ |
|
38
|
|
|
protected function addItem(string $key, $item): void |
|
39
|
|
|
{ |
|
40
|
|
|
$this->items[$key] = $item; |
|
41
|
|
|
} |
|
42
|
|
|
|
|
43
|
|
|
protected function hasItem(string $key): bool |
|
44
|
|
|
{ |
|
45
|
|
|
return isset($this->items[$key]); |
|
46
|
|
|
} |
|
47
|
|
|
|
|
48
|
|
|
/** |
|
49
|
|
|
* @return mixed |
|
50
|
|
|
*/ |
|
51
|
|
|
protected function getItem(string $key) |
|
52
|
|
|
{ |
|
53
|
|
|
if (!$this->hasItem($key)) { |
|
54
|
|
|
throw new UnknownIdentifierException(sprintf( |
|
55
|
|
|
"%s '%s' does not exist", |
|
56
|
|
|
$this->describeItem(), |
|
57
|
|
|
$key |
|
58
|
|
|
)); |
|
59
|
|
|
} |
|
60
|
|
|
|
|
61
|
|
|
return $this->items[$key]; |
|
62
|
|
|
} |
|
63
|
|
|
|
|
64
|
|
|
/** |
|
65
|
|
|
* @return string[] |
|
66
|
|
|
*/ |
|
67
|
|
|
public function getItemKeys(): array |
|
68
|
|
|
{ |
|
69
|
|
|
return array_filter(array_keys($this->items)); |
|
70
|
|
|
} |
|
71
|
|
|
|
|
72
|
|
|
/** |
|
73
|
|
|
* @return mixed[] |
|
74
|
|
|
*/ |
|
75
|
|
|
public function getItems(): array |
|
76
|
|
|
{ |
|
77
|
|
|
return $this->items; |
|
78
|
|
|
} |
|
79
|
|
|
} |
|
80
|
|
|
|
byrokrat /
giroapp
