forked from joomla-framework/string
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathInflector.php
More file actions
314 lines (283 loc) · 7.78 KB
/
Copy pathInflector.php
File metadata and controls
314 lines (283 loc) · 7.78 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
<?php
/**
* Part of the Joomla Framework String Package
*
* @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
namespace Joomla\String;
use Doctrine\Common\Inflector\Inflector as DoctrineInflector;
/**
* Joomla Framework String Inflector Class
*
* The Inflector transforms words
*
* @since 1.0
*/
class Inflector extends DoctrineInflector
{
/**
* The singleton instance.
*
* @var Inflector
* @since 1.0
* @deprecated 3.0
*/
private static $instance;
/**
* The inflector rules for countability.
*
* @var array
* @since 2.0.0
*/
private static $countable = [
'rules' => [
'id',
'hits',
'clicks',
],
];
/**
* Adds inflection regex rules to the inflector.
*
* @param mixed $data A string or an array of strings or regex rules to add.
* @param string $ruleType The rule type: singular | plural | countable
*
* @return void
*
* @since 1.0
* @throws \InvalidArgumentException
*/
private function addRule($data, string $ruleType)
{
if (\is_string($data)) {
$data = [$data];
} elseif (!\is_array($data)) {
throw new \InvalidArgumentException('Invalid inflector rule data.');
} elseif (!\in_array($ruleType, ['singular', 'plural', 'countable'])) {
throw new \InvalidArgumentException('Unsupported rule type.');
}
if ($ruleType === 'countable') {
foreach ($data as $rule) {
// Ensure a string is pushed.
array_push(self::$countable['rules'], (string) $rule);
}
} else {
static::rules($ruleType, $data);
}
}
/**
* Adds a countable word.
*
* @param mixed $data A string or an array of strings to add.
*
* @return $this
*
* @since 1.0
*/
public function addCountableRule($data)
{
$this->addRule($data, 'countable');
return $this;
}
/**
* Adds a specific singular-plural pair for a word.
*
* @param string $singular The singular form of the word.
* @param string $plural The plural form of the word. If omitted, it is assumed the singular and plural are identical.
*
* @return $this
*
* @since 1.0
* @deprecated 3.0 Use Doctrine\Common\Inflector\Inflector::rules() instead.
*/
public function addWord($singular, $plural = '')
{
trigger_deprecation(
'joomla/string',
'2.0.0',
'%s() is deprecated and will be removed in 3.0, use %s::rules() instead.',
__METHOD__,
DoctrineInflector::class
);
if ($plural !== '') {
static::rules(
'plural',
[
'irregular' => [$plural => $singular],
]
);
static::rules(
'singular',
[
'irregular' => [$singular => $plural],
]
);
} else {
static::rules(
'plural',
[
'uninflected' => [$singular],
]
);
static::rules(
'singular',
[
'uninflected' => [$singular],
]
);
}
return $this;
}
/**
* Adds a pluralisation rule.
*
* @param mixed $data A string or an array of regex rules to add.
*
* @return $this
*
* @since 1.0
* @deprecated 3.0 Use Doctrine\Common\Inflector\Inflector::rules() instead.
*/
public function addPluraliseRule($data)
{
trigger_deprecation(
'joomla/string',
'2.0.0',
'%s() is deprecated and will be removed in 3.0, use %s::rules() instead.',
__METHOD__,
DoctrineInflector::class
);
$this->addRule($data, 'plural');
return $this;
}
/**
* Adds a singularisation rule.
*
* @param mixed $data A string or an array of regex rules to add.
*
* @return $this
*
* @since 1.0
* @deprecated 3.0 Use Doctrine\Common\Inflector\Inflector::rules() instead.
*/
public function addSingulariseRule($data)
{
trigger_deprecation(
'joomla/string',
'2.0.0',
'%s() is deprecated and will be removed in 3.0, use %s::rules() instead.',
__METHOD__,
DoctrineInflector::class
);
$this->addRule($data, 'singular');
return $this;
}
/**
* Gets an instance of the Inflector singleton.
*
* @param boolean $new If true (default is false), returns a new instance regardless if one exists. This argument is mainly used for testing.
*
* @return static
*
* @since 1.0
* @deprecated 3.0 Use static methods without a class instance instead.
*/
public static function getInstance($new = false)
{
trigger_deprecation(
'joomla/string',
'2.0.0',
'%s() is deprecated and will be removed in 3.0.',
__METHOD__
);
if ($new) {
return new static();
}
if (!\is_object(self::$instance)) {
self::$instance = new static();
}
return self::$instance;
}
/**
* Checks if a word is countable.
*
* @param string $word The string input.
*
* @return boolean True if word is countable, false otherwise.
*
* @since 1.0
*/
public function isCountable($word)
{
return \in_array($word, self::$countable['rules']);
}
/**
* Checks if a word is in a plural form.
*
* @param string $word The string input.
*
* @return boolean True if word is plural, false if not.
*
* @since 1.0
*/
public function isPlural($word)
{
return $this->toPlural($this->toSingular($word)) === $word;
}
/**
* Checks if a word is in a singular form.
*
* @param string $word The string input.
*
* @return boolean True if word is singular, false if not.
*
* @since 1.0
*/
public function isSingular($word)
{
return $this->toSingular($word) === $word;
}
/**
* Converts a word into its plural form.
*
* @param string $word The singular word to pluralise.
*
* @return string The word in plural form.
*
* @since 1.0
* @deprecated 3.0 Use Doctrine\Common\Inflector\Inflector::pluralize() instead.
*/
public function toPlural($word)
{
trigger_deprecation(
'joomla/string',
'2.0.0',
'%s() is deprecated and will be removed in 3.0, use %s::pluralize() instead.',
__METHOD__,
DoctrineInflector::class
);
return static::pluralize($word);
}
/**
* Converts a word into its singular form.
*
* @param string $word The plural word to singularise.
*
* @return string The word in singular form.
*
* @since 1.0
* @deprecated 3.0 Use Doctrine\Common\Inflector\Inflector::singularize() instead.
*/
public function toSingular($word)
{
trigger_deprecation(
'joomla/string',
'2.0.0',
'%s() is deprecated and will be removed in 3.0, use %s::singularize() instead.',
__METHOD__,
DoctrineInflector::class
);
return static::singularize($word);
}
}