/
Projection.php
196 lines (166 loc) · 5.71 KB
/
Projection.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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
<?php
/**
* Copyright 2014-2016 Blue Snowman
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
declare(strict_types = 1);
namespace Saber\Data\IEither {
use \Saber\Core;
use \Saber\Data\IArrayList;
use \Saber\Data\IBool;
use \Saber\Data\IEither;
use \Saber\Data\ILinkedList;
use \Saber\Data\IOption;
abstract class Projection {
#region Properties
/**
* This variable stores the either type.
*
* @access protected
* @var IEither\Type
*/
protected $either;
#endregion
#region Methods -> Native Oriented
public function __construct(IEither\Type $either) {
$this->either = $either;
}
#endregion
#region Methods -> Basic Operations
/**
* This method (aka "every" or "forall") iterates over the items in the collection, yielding each
* item to the predicate function, or fails the truthy test. Opposite of "none".
*
* @access public
* @abstract
* @param callable $predicate the predicate function to be used
* @return IBool\Type whether each item passed the
* truthy test
*/
public abstract function all(callable $predicate) : IBool\Type;
/**
* This method (aka "exists" or "some") returns whether some of the items in the collection
* passed the truthy test.
*
* @access public
* @abstract
* @param callable $predicate the predicate function to be used
* @return IBool\Type whether some of the items
* passed the truthy test
*/
public abstract function any(callable $predicate) : IBool\Type;
/**
* This method binds the specified subroutine to the projection's object.
*
* @access public
* @abstract
* @param callable $subroutine the subroutine to bind
* @return IEither\Type the either
*/
public abstract function bind(callable $subroutine) : IEither\Type;
/**
* This method iterates over the items in the either, yielding each item to the
* procedure function.
*
* @access public
* @abstract
* @param callable $procedure the procedure function to be used
* @return IEither\Projection the projection
*/
public abstract function each(callable $procedure) : IEither\Projection;
/**
* This method returns the either that the projection was created.
*
* @access public
* @final
* @return IEither\Type the either
*/
public final function either() : IEither\Type {
return $this->either;
}
/**
* This method returns a collection of those items that satisfy the predicate.
*
* @access public
* @abstract
* @param callable $predicate the predicate function to be used
* @return IEither\Type the either
*/
public abstract function filter(callable $predicate) : IEither\Type;
/**
* This method returns the item stored within the option.
*
* @access public
* @abstract
* @return Core\Type the stored item
*/
public abstract function item() : Core\Type;
/**
* This method returns an iterator for this collection.
*
* @access public
* @final
* @return IArrayList\Iterator an iterator for this collection
*/
public final function iterator() : IArrayList\Iterator {
return IArrayList\Module::iterator($this->toArrayList());
}
/**
* This method applies each item in this either to the subroutine function.
*
* @access public
* @abstract
* @param callable $subroutine the subroutine function to be used
* @return IEither\Type the either
*/
public abstract function map(callable $subroutine) : IEither\Type;
/**
* This method returns this either's object if is has "some" object; otherwise, it will
* return the specified object.
*
* @access public
* @abstract
* @param Core\Type $y the alternative object
* @return Core\Type the boxed object
*/
public abstract function orSome(Core\Type $y) : Core\Type;
#endregion
#region Methods -> Conversion Operations
/**
* This method returns the either as an array.
*
* @access public
* @abstract
* @return IArrayList\Type the either as an array list
*/
public abstract function toArrayList() : IArrayList\Type;
/**
* This method returns the either as a linked list.
*
* @access public
* @abstract
* @return ILinkedList\Type the either as a linked list
*/
public abstract function toLinkedList() : ILinkedList\Type;
/**
* This method returns the either as an option.
*
* @access public
* @abstract
* @return IOption\Type the either as an option
*/
public abstract function toOption() : IOption\Type;
#endregion
}
}