-
-
Notifications
You must be signed in to change notification settings - Fork 18
Expand file tree
/
Copy pathInflector.php
More file actions
198 lines (174 loc) · 4.63 KB
/
Copy pathInflector.php
File metadata and controls
198 lines (174 loc) · 4.63 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
<?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\Inflector\InflectorFactory;
/**
* Joomla Framework String Inflector Class
*
* The Inflector transforms words
*
* @since 1.0
* @deprecated 5.0 Use doctrine/inflector package as complete replacement instead.
*/
class Inflector
{
/**
* 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;
}
/**
* 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 static::pluralize(static::singularize($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 static::singularize($word) === $word;
}
/**
* Proxy for Inflector::tableize()
*/
public static function tableize(string $word): string
{
$inflector = InflectorFactory::create()->build();
return $inflector->tableize($word);
}
/**
* Proxy for Inflector::classify()
*/
public static function classify(string $word): string
{
$inflector = InflectorFactory::create()->build();
return $inflector->classify($word);
}
/**
* Proxy for Inflector::camelize()
*/
public static function camelize(string $word): string
{
$inflector = InflectorFactory::create()->build();
return $inflector->camelize($word);
}
/**
* Proxy for Inflector::ucwords()
*/
public static function ucwords(string $string, string $delimiters = " \n\t\r\0\x0B-"): string
{
return ucwords($string, $delimiters);
}
/**
* Empty method to suffice the former interface
*/
public static function reset(): void
{
}
/**
* Empty method to suffice the former interface
*/
public static function rules(string $type, iterable $rules, bool $reset = false): void
{
}
/**
* Proxy for Inflector::pluralize()
*/
public static function pluralize(string $word): string
{
$inflector = InflectorFactory::create()->build();
return $inflector->pluralize($word);
}
/**
* Proxy for Inflector::singularize()
*/
public static function singularize(string $word): string
{
$inflector = InflectorFactory::create()->build();
return $inflector->singularize($word);
}
}