|
1
|
|
|
<?php |
|
2
|
|
|
/** |
|
3
|
|
|
* inetprocess/transformation |
|
4
|
|
|
* |
|
5
|
|
|
* PHP Version 5.3 |
|
6
|
|
|
* |
|
7
|
|
|
* @author Emmanuel Dyan |
|
8
|
|
|
* @copyright 2005-2015 iNet Process |
|
9
|
|
|
* |
|
10
|
|
|
* @package inetprocess/transformation |
|
11
|
|
|
* |
|
12
|
|
|
* @license GNU General Public License v2.0 |
|
13
|
|
|
* |
|
14
|
|
|
* @link http://www.inetprocess.com |
|
15
|
|
|
*/ |
|
16
|
|
|
|
|
17
|
|
|
namespace Inet\Transformation; |
|
18
|
|
|
|
|
19
|
|
|
use Inet\Transformation\Exception\InvalidRuleException; |
|
20
|
|
|
use Inet\Transformation\Exception\NotTransformableException; |
|
21
|
|
|
|
|
22
|
|
|
/** |
|
23
|
|
|
* Main class that calls statically any Rule |
|
24
|
|
|
* |
|
25
|
|
|
* # CallBack: Be careful that the value to transform is set as the latest parameter |
|
26
|
|
|
* @method static Transform Callback(callable $callable, ...) |
|
27
|
|
|
* @method static Transform Concat(string $before, [string $after]) |
|
28
|
|
|
* @method static Transform Date(string $inputFormat, string $outputFormat) |
|
29
|
|
|
* @method static Transform Implode(string $glue) |
|
30
|
|
|
* @method static Transform Explode(string $delimiter) |
|
31
|
|
|
* @method static Transform NormalizeURL(string $protocol) |
|
32
|
|
|
* @method static Transform Replace(string $search, string $replace) |
|
33
|
|
|
* @method static Transform ReplaceRegexp(string $pattern, string $replacement) |
|
34
|
|
|
* @method static Transform Slugify() |
|
35
|
|
|
* @method static Transform Timezone(string $inputFormat, string $targetTimezone, [string $currentTimezone]) |
|
36
|
|
|
*/ |
|
37
|
|
|
class Transform |
|
38
|
|
|
{ |
|
39
|
|
|
/** |
|
40
|
|
|
* Contains the factory |
|
41
|
|
|
* |
|
42
|
|
|
* @var Transform |
|
43
|
|
|
*/ |
|
44
|
|
|
protected static $transform; |
|
45
|
|
|
|
|
46
|
|
|
/** |
|
47
|
|
|
* List of rules to execute on an input |
|
48
|
|
|
* |
|
49
|
|
|
* @var array |
|
50
|
|
|
*/ |
|
51
|
|
|
protected $currentRules = array(); |
|
52
|
|
|
|
|
53
|
|
|
/** |
|
54
|
|
|
* Doesn't allow the class to be instanciated |
|
55
|
|
|
*/ |
|
56
|
1 |
|
protected function __construct() |
|
57
|
|
|
{ |
|
58
|
1 |
|
} |
|
59
|
|
|
|
|
60
|
|
|
/** |
|
61
|
|
|
* Returns the factory to avoid having multiple instances of the same class |
|
62
|
|
|
* |
|
63
|
|
|
* @return Transform |
|
64
|
|
|
*/ |
|
65
|
115 |
|
protected static function getFactory() |
|
66
|
|
|
{ |
|
67
|
115 |
|
if (!static::$transform instanceof Transform) { |
|
68
|
1 |
|
static::$transform = new static(); |
|
69
|
1 |
|
} |
|
70
|
|
|
|
|
71
|
115 |
|
return static::$transform; |
|
72
|
|
|
} |
|
73
|
|
|
|
|
74
|
|
|
/** |
|
75
|
|
|
* Return an Array of rules for an instance |
|
76
|
|
|
* |
|
77
|
|
|
* @return array |
|
78
|
|
|
*/ |
|
79
|
102 |
|
protected function getRules() |
|
80
|
|
|
{ |
|
81
|
102 |
|
return $this->currentRules; |
|
82
|
|
|
} |
|
83
|
|
|
|
|
84
|
|
|
/** |
|
85
|
|
|
* Called on the first time to remove all old rules |
|
86
|
|
|
* |
|
87
|
|
|
* @return void |
|
88
|
|
|
*/ |
|
89
|
115 |
|
protected function cleanRules() |
|
90
|
|
|
{ |
|
91
|
115 |
|
$this->currentRules = array(); |
|
92
|
115 |
|
} |
|
93
|
|
|
|
|
94
|
|
|
/** |
|
95
|
|
|
* Add a rule to the rules registry |
|
96
|
|
|
* |
|
97
|
|
|
* @param string $ruleName |
|
98
|
|
|
* @param array $arguments |
|
99
|
|
|
* |
|
100
|
|
|
* @return void |
|
101
|
|
|
*/ |
|
102
|
115 |
|
protected function addRule($ruleName, array $arguments) |
|
103
|
|
|
{ |
|
104
|
115 |
|
$ruleClass = "Inet\Transformation\Rule\\".$ruleName; |
|
105
|
115 |
|
if (!class_exists($ruleClass)) { |
|
106
|
2 |
|
throw new InvalidRuleException("The rule '$ruleName' does not exist"); |
|
107
|
|
|
} |
|
108
|
|
|
|
|
109
|
113 |
|
if (!is_subclass_of($ruleClass, '\Inet\Transformation\Rule\AbstractRule')) { |
|
110
|
1 |
|
throw new InvalidRuleException("The rule '$ruleName' must implement AbstractRule"); |
|
111
|
|
|
} |
|
112
|
|
|
|
|
113
|
112 |
|
$this->currentRules[] = array( |
|
114
|
112 |
|
'rule' => $ruleClass, |
|
115
|
112 |
|
'arguments' => $arguments, |
|
116
|
|
|
); |
|
117
|
112 |
|
} |
|
118
|
|
|
|
|
119
|
|
|
/** |
|
120
|
|
|
* For the first execution, the method is called statically such as T::Replace('a', 'b') |
|
121
|
|
|
* Then get the factory, clean the previous rules and do a __call() |
|
122
|
|
|
* |
|
123
|
|
|
* @param string $ruleName |
|
124
|
|
|
* @param array $arguments |
|
125
|
|
|
* |
|
126
|
|
|
* @return Transform |
|
127
|
|
|
*/ |
|
128
|
115 |
|
public static function __callStatic($ruleName, array $arguments) |
|
129
|
|
|
{ |
|
130
|
115 |
|
$transform = self::getFactory(); |
|
131
|
115 |
|
$transform->cleanRules(); |
|
132
|
|
|
|
|
133
|
115 |
|
return $transform->__call($ruleName, $arguments); |
|
134
|
|
|
} |
|
135
|
|
|
|
|
136
|
|
|
/** |
|
137
|
|
|
* Just add a rule in the registry when called |
|
138
|
|
|
* |
|
139
|
|
|
* @param string $ruleName Name of the rule |
|
140
|
|
|
* @param array $arguments Arguments for the rule |
|
141
|
|
|
* |
|
142
|
|
|
* @return Transform |
|
143
|
|
|
*/ |
|
144
|
115 |
|
public function __call($ruleName, array $arguments) |
|
145
|
|
|
{ |
|
146
|
115 |
|
$this->addRule($ruleName, $arguments); |
|
147
|
|
|
|
|
148
|
112 |
|
return $this; |
|
149
|
|
|
} |
|
150
|
|
|
|
|
151
|
|
|
/** |
|
152
|
|
|
* Transform an input by applying rule |
|
153
|
|
|
* |
|
154
|
|
|
* @param string $input Should be a string ! |
|
155
|
|
|
* |
|
156
|
|
|
* @return string Transformed string |
|
157
|
|
|
*/ |
|
158
|
112 |
|
public function transform($input) |
|
159
|
|
|
{ |
|
160
|
112 |
|
$validTypes = array('boolean', 'integer', 'double', 'string', 'array'); |
|
161
|
112 |
|
$inputType = gettype($input); |
|
162
|
112 |
|
if (!in_array($inputType, $validTypes)) { |
|
163
|
10 |
|
throw new NotTransformableException; |
|
164
|
|
|
} |
|
165
|
|
|
|
|
166
|
|
|
// Apply rule by rule |
|
167
|
102 |
|
foreach ($this->getRules() as $ruleArgs) { |
|
168
|
|
|
// Execute the transformation |
|
169
|
102 |
|
$rule = $ruleArgs['rule']; |
|
170
|
102 |
|
$args = $ruleArgs['arguments']; |
|
171
|
|
|
|
|
172
|
102 |
|
$rule = new $rule; |
|
173
|
102 |
|
$input = $rule->transform($input, $args); |
|
174
|
47 |
|
} |
|
175
|
|
|
|
|
176
|
47 |
|
return $input; |
|
177
|
|
|
} |
|
178
|
|
|
} |
|
179
|
|
|
|
inetprocess /
transformation
