-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathScripturNumArray.php
More file actions
389 lines (354 loc) · 8.89 KB
/
ScripturNumArray.php
File metadata and controls
389 lines (354 loc) · 8.89 KB
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
<?php
namespace ScripturNum;
use ArrayAccess;
use Countable;
use Iterator;
/**
* A class that contains a number of ScripturNum objects, but which can do useful things like print a human-readable
* string.
*
* @since 2.0.0
*/
class ScripturNumArray implements ArrayAccess, Iterator, Countable
{
/**
* @var ScripturNum[]
*/
protected $container = [];
protected $sortEnqueued = false;
protected $hasMultipleBooks = false;
protected $hasMultiplePassagesFromABook = false;
protected $hasMultiplePassagesFromAChapter = false;
/**
* Constructor
*
* @param array $initialValues An array of initial values to add to the container. These can be ScripturNum objects
* or strings/integers that can be parsed into ScripturNum objects.
*/
public function __construct($initialValues = [])
{
foreach ($initialValues as $k => $i) {
if (is_object($i) && get_class($i) === ScripturNum::class) {
$this->offsetSet($k, $i);
continue;
}
try {
$s = new ScripturNum($i);
$this->offsetSet($k, $s);
} catch (ScripturNumException $e) {}
}
}
/**
* @param ScripturNum $a
* @param ScripturNum $b
*
* @return int
*/
protected static function sortCompare(ScripturNum $a, ScripturNum $b): int
{
return $a->getInt() <=> $b->getInt();
}
/**
* Sorts the container.
*
* @return void
*/
protected function sort()
{
uasort($this->container, [static::class, 'sortCompare']);
}
/**
* @return void
* @noinspection PhpDocMissingThrowsInspection
*/
protected function combineAdjacents()
{
$prev = null;
$prevK = null;
$this->hasMultipleBooks = false;
$this->hasMultiplePassagesFromABook = false;
$this->hasMultiplePassagesFromAChapter = false;
foreach ($this->container as $k => $curr) {
if ($prev != null) {
if ($prev->overlapsOrAdjacent($curr)) {
/** @noinspection PhpUnhandledExceptionInspection -- Exception won't happen with overlapsOrAdjacent check */
$this->container[$prevK] = $prev->combineWith($curr);
unset($this->container[$k]);
$prev = $this->container[$prevK];
continue;
}
if ($curr->book === $prev->book) {
$this->hasMultiplePassagesFromABook = true;
if ($prev->endCh === $curr->startCh) {
$this->hasMultiplePassagesFromAChapter = true;
}
} else {
$this->hasMultipleBooks = true;
}
}
$prev = $curr;
$prevK = $k;
}
}
protected function sortAndCombineIfNeeded()
{
if ($this->sortEnqueued) {
$this->sort();
$this->combineAdjacents();
$this->sortEnqueued = false;
}
}
/**
* Whether an offset exists
* @link https://php.net/manual/en/arrayaccess.offsetexists.php
*
* @param mixed $offset
* An offset to check for.
*
* @return bool true on success or false on failure.
*
* The return value will be cast to boolean if non-boolean was returned.
*/
public function offsetExists($offset): bool
{
return isset($this->container[$offset]);
}
/**
* Offset to retrieve
* @link https://php.net/manual/en/arrayaccess.offsetget.php
*
* @param mixed $offset
* The offset to retrieve.
*
* @return ScripturNum Value Can return all value types.
*/
public function offsetGet($offset): ScripturNum
{
$this->sortAndCombineIfNeeded();
return $this->container[$offset];
}
/**
* Offset to set
* @link https://php.net/manual/en/arrayaccess.offsetset.php
*
* @param mixed $offset
* The offset to assign the value to.
*
* @param ScripturNum $value
* The value to set.
*
* @return void
*
* @See Issue #11
*/
#[\ReturnTypeWillChange]
public function offsetSet($offset, $value)
{
if (is_null($offset)) {
$this->container[] = $value;
} else {
$this->container[$offset] = $value;
}
$this->sortEnqueued = true;
}
/**
* Offset to unset
* @link https://php.net/manual/en/arrayaccess.offsetunset.php
*
* @param mixed $offset
* The offset to unset.
*
* @return void
*
* @See Issue #11
*/
#[\ReturnTypeWillChange]
public function offsetUnset($offset)
{
$this->sortEnqueued = true;
unset($this->container[$offset]);
}
/**
* Return the current element
* @link https://php.net/manual/en/iterator.current.php
* @return ScripturNum Can return any type.
*/
public function current(): ScripturNum
{
$this->sortAndCombineIfNeeded();
return current($this->container);
}
/**
* Move forward to next element
*
* @link https://php.net/manual/en/iterator.next.php
*
* @return void Any returned value is ignored.
*
* @See Issue #11
*/
#[\ReturnTypeWillChange]
public function next()
{
next($this->container);
}
/**
* Return the key of the current element
*
* @link https://php.net/manual/en/iterator.key.php
*
* @return int|string|null TKey on success, or null on failure.
*
* @See Issue #11
*/
#[\ReturnTypeWillChange]
public function key()
{
return key($this->container);
}
/**
* Checks if current position is valid
* @link https://php.net/manual/en/iterator.valid.php
* @return bool The return value will be cast to boolean and then evaluated.
* Returns true on success or false on failure.
*/
public function valid(): bool
{
$k = $this->key();
if ($k === null) {
$k = '';
}
return isset($this->container[$k]);
}
/**
* Rewind the Iterator to the first element
*
* @link https://php.net/manual/en/iterator.rewind.php
*
* @return void Any returned value is ignored.
*
* @See Issue #11
*/
#[\ReturnTypeWillChange]
public function rewind()
{
reset($this->container);
}
/**
* Count elements of an object
*
* @link https://php.net/manual/en/countable.count.php
*
* @return int<0,max> The custom count as an integer.
*/
public function count(): int
{
$this->sortAndCombineIfNeeded();
return count($this->container);
}
/**
* Subtract a passage from this array of passages.
*
* @since 2.1.0
*
* @param ScripturNum $other
* @return ScripturNumArray
* @throws ScripturNumException
*/
public function remove(ScripturNum $other): ScripturNumArray
{
$result = new ScripturNumArray();
$this->sortAndCombineIfNeeded();
foreach ($this->container as $sn) {
$r = $sn->remove($other);
foreach ($r as $s) {
$result[] = $s;
}
}
$result->sortAndCombineIfNeeded();
return $result;
}
/**
* Subtract all passages in another ScripturNumArray from this array of passages.
*
* @since 2.1.0
*
* @param ScripturNumArray $others
* @return ScripturNumArray
* @throws ScripturNumException
*/
public function removeAll(ScripturNumArray $others): ScripturNumArray
{
$this->sortAndCombineIfNeeded();
$others->sortAndCombineIfNeeded();
$r = new ScripturNumArray($this->container);
foreach ($others as $o) {
$r = $r->remove($o);
}
$r->sortAndCombineIfNeeded();
return $r;
}
/**
* @return string
*/
public function __toString(): string
{
return $this->getString();
}
/**
* Alias for toString(), but returns an empty string on error.
*
* @see toString()
*
* @param string|array $options
* @return string
*/
public function getString($options = []): string
{
try {
return $this->toString($options);
} catch (ScripturNumException $e) {
return '';
}
}
/**
* Return a human-readable string representation of the contained passages. Throws an exception on error.
* To get an empty string on error instead, use getString() instead of this method.
*
* @param string|array $options The setting set to use, or an array of options.
*
* @since 2.1.0
*
* @return string
* @throws ScripturNumException
*/
public function toString($options = []): string
{
$options = ScripturNum::parseStringOptions($options);
$this->sortAndCombineIfNeeded();
$ret = "";
$prev = null;
foreach ($this->container as $curr) {
$options['excludeCh'] = false;
$options['excludeBook'] = false;
if ($prev !== null) {
$c = ', ';
if ($prev->book === $curr->book) { // same book
$options['excludeBook'] = true;
if ($prev->startCh !== $curr->endCh && $this->hasMultiplePassagesFromABook) { // diff chapter
$c = '; ';
}
if ($this->hasMultiplePassagesFromAChapter && $prev->startCh === $curr->endCh) {
$options['excludeCh'] = true;
}
} else if ($this->hasMultiplePassagesFromABook) { // Different books, when a book has multiple items
$c = "; ";
}
$ret .= $c;
}
$ret .= $curr->toString($options);
$prev = $curr;
}
return $ret;
}
}