|
1
|
|
|
<?php namespace Chekote\NounStore; |
|
2
|
|
|
|
|
3
|
|
|
use InvalidArgumentException; |
|
4
|
|
|
|
|
5
|
|
|
class Key |
|
6
|
|
|
{ |
|
7
|
|
|
use Singleton; |
|
8
|
|
|
|
|
9
|
|
|
const ORDINAL_ST = 'st'; |
|
10
|
|
|
const ORDINAL_ND = 'nd'; |
|
11
|
|
|
const ORDINAL_RD = 'rd'; |
|
12
|
|
|
const ORDINAL_TH = 'th'; |
|
13
|
|
|
|
|
14
|
|
|
protected static $ordinals = [ |
|
15
|
|
|
0 => self::ORDINAL_TH, |
|
16
|
|
|
1 => self::ORDINAL_ST, |
|
17
|
|
|
2 => self::ORDINAL_ND, |
|
18
|
|
|
3 => self::ORDINAL_RD, |
|
19
|
|
|
4 => self::ORDINAL_TH, |
|
20
|
|
|
5 => self::ORDINAL_TH, |
|
21
|
|
|
6 => self::ORDINAL_TH, |
|
22
|
|
|
7 => self::ORDINAL_TH, |
|
23
|
|
|
8 => self::ORDINAL_TH, |
|
24
|
|
|
9 => self::ORDINAL_TH, |
|
25
|
|
|
]; |
|
26
|
|
|
|
|
27
|
|
|
const POSSESSION = "'s "; |
|
28
|
|
|
|
|
29
|
|
|
/** |
|
30
|
|
|
* Builds a key from it's separate key and index values. |
|
31
|
|
|
* |
|
32
|
|
|
* @example buildKey("Item", null): "Item" |
|
33
|
|
|
* @example buildKey("Item", 0): "1st Item" |
|
34
|
|
|
* @example buildKey("Item", 1): "2nd Item" |
|
35
|
|
|
* @example buildKey("Item", 2): "3rd Item" |
|
36
|
|
|
* |
|
37
|
|
|
* @param string $key The key to check. |
|
38
|
|
|
* @param int|null $index The index (zero indexed) value for the key. If not specified, the method |
|
39
|
|
|
* will not add an index notation to the key. |
|
40
|
|
|
* @throws InvalidArgumentException if $index is less than -1. Note: It should really be zero or higher, but this |
|
41
|
|
|
* method does not assert that. The error is bubbling up from getOrdinal() |
|
42
|
3 |
|
* @return string the key with the index, or just the key if index is null. |
|
43
|
|
|
*/ |
|
44
|
3 |
|
public function build($key, $index) |
|
45
|
1 |
|
{ |
|
46
|
|
|
if ($index === null) { |
|
47
|
|
|
return $key; |
|
48
|
2 |
|
} |
|
49
|
|
|
|
|
50
|
2 |
|
$nth = $index + 1; |
|
51
|
|
|
|
|
52
|
|
|
return $nth . $this->getOrdinal($nth) . ' ' . $key; |
|
53
|
|
|
} |
|
54
|
|
|
|
|
55
|
|
|
/** |
|
56
|
|
|
* Provides the ordinal notation for the specified nth number. |
|
57
|
|
|
* |
|
58
|
|
|
* @param int $nth the number to determine the ordinal for |
|
59
|
|
|
* @throws InvalidArgumentException if $nth is not a positive number. |
|
60
|
24 |
|
* @return string the ordinal |
|
61
|
|
|
*/ |
|
62
|
24 |
|
public function getOrdinal($nth) |
|
63
|
1 |
|
{ |
|
64
|
|
|
if ($nth < 0) { |
|
65
|
|
|
throw new InvalidArgumentException('$nth must be a positive number'); |
|
66
|
23 |
|
} |
|
67
|
|
|
|
|
68
|
|
|
return $nth > 9 && $nth < 20 ? self::ORDINAL_TH : self::$ordinals[substr($nth, -1)]; |
|
69
|
|
|
} |
|
70
|
|
|
|
|
71
|
|
|
/** |
|
72
|
|
|
* Parses a key into the separate key and index value. |
|
73
|
|
|
* |
|
74
|
|
|
* @example parseKey("Item"): ["Item", null] |
|
75
|
|
|
* @example parseKey("1st Item"): ["Item", 0] |
|
76
|
|
|
* @example parseKey("2nd Item"): ["Item", 1] |
|
77
|
|
|
* @example parseKey("3rd Item"): ["Item", 2] |
|
78
|
|
|
* |
|
79
|
|
|
* @param string $key the key to parse. |
|
80
|
|
|
* @throws InvalidArgumentException if the key syntax is invalid. |
|
81
|
|
|
* @return array a tuple, the 1st being the key with the nth removed, and the 2nd being the |
|
82
|
|
|
* index that the nth translates to, or null if no nth was specified. |
|
83
|
|
|
*/ |
|
84
|
|
|
public function parse($key) |
|
85
|
14 |
|
{ |
|
86
|
|
|
if (!preg_match("/^(([1-9][0-9]*)(?:st|nd|rd|th) )?([^']+)$/", $key, $matches)) { |
|
87
|
14 |
|
throw new InvalidArgumentException('Key syntax is invalid'); |
|
88
|
11 |
|
} |
|
89
|
5 |
|
|
|
90
|
5 |
|
// @todo use null coalescing operator when upgrading to PHP 7 |
|
91
|
|
|
$index = isset($matches[2]) && $matches[2] !== '' ? $matches[2] - 1 : null; |
|
92
|
|
|
$key = $matches[3]; |
|
93
|
|
|
|
|
94
|
6 |
|
return [$key, $index]; |
|
95
|
6 |
|
} |
|
96
|
|
|
|
|
97
|
|
|
/** |
|
98
|
9 |
|
* Resolves an index and parsed nth value to an index. |
|
99
|
|
|
* |
|
100
|
|
|
* Ensures that if both an index and parsed nth value are provided, that they are equivalent. If only one is |
|
101
|
|
|
* provided, then the appropriate index will be returned. e.g. if an index is provided, it is returned as-is, as |
|
102
|
|
|
* it is already an index. If an nth is provided, it will be returned decremented by 1. |
|
103
|
|
|
* |
|
104
|
|
|
* @param int|null $index the index to process |
|
105
|
|
|
* @param int|null $nth the nth to process |
|
106
|
|
|
* @throws InvalidArgumentException if both an $index and $key are provided, but the $key contains an nth value |
|
107
|
|
|
* that does not match the index. |
|
108
|
|
|
* @throws InvalidArgumentException if nth is not null and is less than 1 |
|
109
|
|
|
* @return int the resolved index. |
|
110
|
|
|
*/ |
|
111
|
|
|
protected function resolveIndex($index, $nth) |
|
112
|
|
|
{ |
|
113
|
|
|
// If we don't have an nth, there's nothing to process. We'll just return the $index, even if it's null. |
|
114
|
|
|
if ($nth === null) { |
|
115
|
|
|
return $index; |
|
116
|
|
|
} |
|
117
|
|
|
|
|
118
|
|
|
$decrementedNth = $nth - 1; |
|
119
|
|
|
|
|
120
|
|
|
// If both index and nth are provided, but they aren't equivalent, we need to error out. |
|
121
|
|
|
if ($index !== null && $index !== $decrementedNth) { |
|
122
|
|
|
throw new InvalidArgumentException("index $index was provided with nth $nth, but they are not equivalent"); |
|
123
|
|
|
} |
|
124
|
|
|
|
|
125
|
|
|
if ($decrementedNth < 0) { |
|
126
|
|
|
throw new InvalidArgumentException('nth must be equal to or larger than 1'); |
|
127
|
|
|
} |
|
128
|
|
|
|
|
129
|
|
|
return $decrementedNth; |
|
130
|
|
|
} |
|
131
|
|
|
|
|
132
|
|
|
/** |
|
133
|
|
|
* Determines if the specified key is a possessive noun. |
|
134
|
|
|
* |
|
135
|
|
|
* @param string $key |
|
136
|
|
|
* @return bool true if the key is possessive, false if not |
|
137
|
|
|
*/ |
|
138
|
|
|
protected function isPossessive($key) |
|
139
|
|
|
{ |
|
140
|
|
|
return strpos($key, self::POSSESSION) !== false; |
|
141
|
|
|
} |
|
142
|
|
|
} |
|
143
|
|
|
|
Chekote /
noun-store
