|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/** |
|
4
|
|
|
* Platine Collection |
|
5
|
|
|
* |
|
6
|
|
|
* Platine Collection provides a flexible and simple PHP collection implementation. |
|
7
|
|
|
* |
|
8
|
|
|
* This content is released under the MIT License (MIT) |
|
9
|
|
|
* |
|
10
|
|
|
* Copyright (c) 2020 Platine Collection |
|
11
|
|
|
* |
|
12
|
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy |
|
13
|
|
|
* of this software and associated documentation files (the "Software"), to deal |
|
14
|
|
|
* in the Software without restriction, including without limitation the rights |
|
15
|
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
|
16
|
|
|
* copies of the Software, and to permit persons to whom the Software is |
|
17
|
|
|
* furnished to do so, subject to the following conditions: |
|
18
|
|
|
* |
|
19
|
|
|
* The above copyright notice and this permission notice shall be included in all |
|
20
|
|
|
* copies or substantial portions of the Software. |
|
21
|
|
|
* |
|
22
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
|
23
|
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|
24
|
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
|
25
|
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|
26
|
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
|
27
|
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
|
28
|
|
|
* SOFTWARE. |
|
29
|
|
|
*/ |
|
30
|
|
|
|
|
31
|
|
|
/** |
|
32
|
|
|
* @file Stack.php |
|
33
|
|
|
* |
|
34
|
|
|
* The Stack class |
|
35
|
|
|
* |
|
36
|
|
|
* @package Platine\Collection\Stack |
|
37
|
|
|
* @author Platine Developers Team |
|
38
|
|
|
* @copyright Copyright (c) 2020 |
|
39
|
|
|
* @license http://opensource.org/licenses/MIT MIT License |
|
40
|
|
|
* @link https://www.platine-php.com |
|
41
|
|
|
* @version 1.0.0 |
|
42
|
|
|
* @filesource |
|
43
|
|
|
*/ |
|
44
|
|
|
|
|
45
|
|
|
declare(strict_types=1); |
|
46
|
|
|
|
|
47
|
|
|
namespace Platine\Collection\Stack; |
|
48
|
|
|
|
|
49
|
|
|
use Countable; |
|
50
|
|
|
use Platine\Collection\Exception\InvalidOperationException; |
|
51
|
|
|
use Platine\Collection\TypeCheck; |
|
52
|
|
|
|
|
53
|
|
|
/** |
|
54
|
|
|
* @class Stack |
|
55
|
|
|
* @package Platine\Collection\Stack |
|
56
|
|
|
*/ |
|
57
|
|
|
class Stack implements Countable |
|
58
|
|
|
{ |
|
59
|
|
|
/** |
|
60
|
|
|
* |
|
61
|
|
|
* @var array<int, mixed> |
|
62
|
|
|
*/ |
|
63
|
|
|
protected array $data = []; |
|
64
|
|
|
|
|
65
|
|
|
/** |
|
66
|
|
|
* Create new instance |
|
67
|
|
|
* @param string $type |
|
68
|
|
|
*/ |
|
69
|
|
|
public function __construct(protected string $type) |
|
70
|
|
|
{ |
|
71
|
|
|
} |
|
72
|
|
|
|
|
73
|
|
|
/** |
|
74
|
|
|
* |
|
75
|
|
|
* @return void |
|
76
|
|
|
*/ |
|
77
|
|
|
public function clear(): void |
|
78
|
|
|
{ |
|
79
|
|
|
$this->data = []; |
|
80
|
|
|
} |
|
81
|
|
|
|
|
82
|
|
|
/** |
|
83
|
|
|
* {@inheritedoc} |
|
84
|
|
|
*/ |
|
85
|
|
|
public function count(): int |
|
86
|
|
|
{ |
|
87
|
|
|
return count($this->data); |
|
88
|
|
|
} |
|
89
|
|
|
|
|
90
|
|
|
/** |
|
91
|
|
|
* |
|
92
|
|
|
* @return bool |
|
93
|
|
|
*/ |
|
94
|
|
|
public function isEmpty(): bool |
|
95
|
|
|
{ |
|
96
|
|
|
return $this->count() === 0; |
|
97
|
|
|
} |
|
98
|
|
|
|
|
99
|
|
|
/** |
|
100
|
|
|
* @return mixed |
|
101
|
|
|
*/ |
|
102
|
|
|
public function peek(): mixed |
|
103
|
|
|
{ |
|
104
|
|
|
if ($this->isEmpty()) { |
|
105
|
|
|
throw new InvalidOperationException('The collection is empty'); |
|
106
|
|
|
} |
|
107
|
|
|
|
|
108
|
|
|
return $this->data[$this->count() - 1]; |
|
109
|
|
|
} |
|
110
|
|
|
|
|
111
|
|
|
/** |
|
112
|
|
|
* |
|
113
|
|
|
* @return mixed |
|
114
|
|
|
*/ |
|
115
|
|
|
public function pop(): mixed |
|
116
|
|
|
{ |
|
117
|
|
|
return array_pop($this->data); |
|
118
|
|
|
} |
|
119
|
|
|
|
|
120
|
|
|
|
|
121
|
|
|
/** |
|
122
|
|
|
* |
|
123
|
|
|
* @param mixed $value |
|
124
|
|
|
* @return mixed |
|
125
|
|
|
*/ |
|
126
|
|
|
public function push(mixed $value): mixed |
|
127
|
|
|
{ |
|
128
|
|
|
TypeCheck::isValueOf( |
|
129
|
|
|
$value, |
|
130
|
|
|
$this->type, |
|
131
|
|
|
sprintf( |
|
132
|
|
|
'The type specified for this collection is [%s], ' |
|
133
|
|
|
. 'you cannot pass a value of type [%s]', |
|
134
|
|
|
$this->type, |
|
135
|
|
|
gettype($value) |
|
136
|
|
|
) |
|
137
|
|
|
); |
|
138
|
|
|
|
|
139
|
|
|
$this->data[] = $value; |
|
140
|
|
|
|
|
141
|
|
|
return $value; |
|
142
|
|
|
} |
|
143
|
|
|
} |
|
144
|
|
|
|
platine-php /
collection
