Passed
Push — master ( 32692a...12a81e )
by Sebastian
02:54
created
src/ConvertHelper/StorageSizeEnum.php 2 patches
Spacing   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -44,7 +44,7 @@  discard block
 block discarded – undo
44 44
     */
45 45
     protected static function init()
46 46
     {
47
-        if(isset(self::$sizes)) {
47
+        if (isset(self::$sizes)) {
48 48
             return;
49 49
         }
50 50
         
@@ -64,7 +64,7 @@  discard block
 block discarded – undo
64 64
         
65 65
         self::addSize('b', 1, 1, t('B'), t('Byte'), t('Bytes'));
66 66
         
67
-        if(class_exists('AppLocalize\Localization')) 
67
+        if (class_exists('AppLocalize\Localization')) 
68 68
         {
69 69
             \AppLocalize\Localization::onLocaleChanged(array(self::class, 'handle_localeChanged'));
70 70
         }
@@ -132,7 +132,7 @@  discard block
 block discarded – undo
132 132
         
133 133
         $name = strtolower($name);
134 134
         
135
-        if(isset(self::$sizes[$name])) {
135
+        if (isset(self::$sizes[$name])) {
136 136
             return self::$sizes[$name];
137 137
         }
138 138
         
@@ -174,9 +174,9 @@  discard block
 block discarded – undo
174 174
         
175 175
         $result = array();
176 176
         
177
-        foreach(self::$sizes as $size)
177
+        foreach (self::$sizes as $size)
178 178
         {
179
-            if($size->getBase() === $base) {
179
+            if ($size->getBase() === $base) {
180 180
                 $result[] = $size;
181 181
             }
182 182
         }
Please login to merge, or discard this patch.
Indentation   +56 added lines, -56 removed lines patch added patch discarded remove patch
@@ -31,17 +31,17 @@  discard block
 block discarded – undo
31 31
     
32 32
     const BASE_2 = 1024;
33 33
     
34
-   /**
35
-    * @var ConvertHelper_StorageSizeEnum_Size[]
36
-    */
34
+    /**
35
+     * @var ConvertHelper_StorageSizeEnum_Size[]
36
+     */
37 37
     protected static $sizes;
38 38
     
39
-   /**
40
-    * Initializes the supported unit notations, and
41
-    * how they are supposed to be calculated.
42
-    *
43
-    * @see ConvertHelper_SizeNotation::parseSize()
44
-    */
39
+    /**
40
+     * Initializes the supported unit notations, and
41
+     * how they are supposed to be calculated.
42
+     *
43
+     * @see ConvertHelper_SizeNotation::parseSize()
44
+     */
45 45
     protected static function init()
46 46
     {
47 47
         if(isset(self::$sizes)) {
@@ -70,30 +70,30 @@  discard block
 block discarded – undo
70 70
         }
71 71
     }
72 72
     
73
-   /**
74
-    * Called whenever the application locale is changed,
75
-    * to reset the size definitions so the labels get 
76
-    * translated to the new locale.
77
-    * 
78
-    * @param \AppLocalize\Localization_Event_LocaleChanged $event
79
-    */
73
+    /**
74
+     * Called whenever the application locale is changed,
75
+     * to reset the size definitions so the labels get 
76
+     * translated to the new locale.
77
+     * 
78
+     * @param \AppLocalize\Localization_Event_LocaleChanged $event
79
+     */
80 80
     public static function handle_localeChanged(\AppLocalize\Localization_Event_LocaleChanged $event)
81 81
     {
82 82
         self::$sizes = null;
83 83
     }
84 84
     
85
-   /**
86
-    * Adds a storage size to the internal collection.
87
-    * 
88
-    * @param string $name The lowercase size name, e.g. "kb", "mib"
89
-    * @param int $base This defines how many bytes there are in a kilobyte, to differentiate with the two common way to calculate sizes: base 10 or base 2. See the Wikipedia link for more details.
90
-    * @param int $exponent The multiplier of the base to get the byte value
91
-    * @param string $suffix The localized short suffix, e.g. "KB", "MiB"
92
-    * @param string $singular The localized singular label of the size, e.g. "Kilobyte".
93
-    * @param string $plural The localized plural label of the size, e.g. "Kilobytes".
94
-    * 
95
-    * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions
96
-    */
85
+    /**
86
+     * Adds a storage size to the internal collection.
87
+     * 
88
+     * @param string $name The lowercase size name, e.g. "kb", "mib"
89
+     * @param int $base This defines how many bytes there are in a kilobyte, to differentiate with the two common way to calculate sizes: base 10 or base 2. See the Wikipedia link for more details.
90
+     * @param int $exponent The multiplier of the base to get the byte value
91
+     * @param string $suffix The localized short suffix, e.g. "KB", "MiB"
92
+     * @param string $singular The localized singular label of the size, e.g. "Kilobyte".
93
+     * @param string $plural The localized plural label of the size, e.g. "Kilobytes".
94
+     * 
95
+     * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions
96
+     */
97 97
     protected static function addSize(string $name, int $base, int $exponent, string $suffix, string $singular, string $plural)
98 98
     {
99 99
         self::$sizes[$name] = new ConvertHelper_StorageSizeEnum_Size(
@@ -106,11 +106,11 @@  discard block
 block discarded – undo
106 106
         );
107 107
     }
108 108
     
109
-   /**
110
-    * Retrieves all known sizes.
111
-    * 
112
-    * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size[]
113
-    */
109
+    /**
110
+     * Retrieves all known sizes.
111
+     * 
112
+     * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size[]
113
+     */
114 114
     public static function getSizes()
115 115
     {
116 116
         self::init();
@@ -118,15 +118,15 @@  discard block
 block discarded – undo
118 118
         return self::$sizes;
119 119
     }
120 120
     
121
-   /**
122
-    * Retrieves a size definition instance by its name.
123
-    * 
124
-    * @param string $name Case insensitive. For example "kb", "MiB"...
125
-    * @throws ConvertHelper_Exception
126
-    * @return ConvertHelper_StorageSizeEnum_Size
127
-    * 
128
-    * @see ConvertHelper_StorageSizeEnum::ERROR_UNKNOWN_UNIT_NAME
129
-    */
121
+    /**
122
+     * Retrieves a size definition instance by its name.
123
+     * 
124
+     * @param string $name Case insensitive. For example "kb", "MiB"...
125
+     * @throws ConvertHelper_Exception
126
+     * @return ConvertHelper_StorageSizeEnum_Size
127
+     * 
128
+     * @see ConvertHelper_StorageSizeEnum::ERROR_UNKNOWN_UNIT_NAME
129
+     */
130 130
     public static function getSizeByName(string $name) : ConvertHelper_StorageSizeEnum_Size
131 131
     {
132 132
         self::init();
@@ -148,10 +148,10 @@  discard block
 block discarded – undo
148 148
         );
149 149
     }
150 150
     
151
-   /**
152
-    * Retrieves a list of all size names, e.g. "mb", "kib" (lowercase).
153
-    * @return array
154
-    */
151
+    /**
152
+     * Retrieves a list of all size names, e.g. "mb", "kib" (lowercase).
153
+     * @return array
154
+     */
155 155
     public static function getSizeNames() : array
156 156
     {
157 157
         self::init();
@@ -159,16 +159,16 @@  discard block
 block discarded – undo
159 159
         return array_keys(self::$sizes);
160 160
     }
161 161
    
162
-   /**
163
-    * Retrieves all available storage sizes for the specified
164
-    * base value.
165
-    * 
166
-    * @param int $base
167
-    * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size[]
168
-    * 
169
-    * @see ConvertHelper_StorageSizeEnum::BASE_10
170
-    * @see ConvertHelper_StorageSizeEnum::BASE_2
171
-    */
162
+    /**
163
+     * Retrieves all available storage sizes for the specified
164
+     * base value.
165
+     * 
166
+     * @param int $base
167
+     * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size[]
168
+     * 
169
+     * @see ConvertHelper_StorageSizeEnum::BASE_10
170
+     * @see ConvertHelper_StorageSizeEnum::BASE_2
171
+     */
172 172
     public static function getSizesByBase(int $base)
173 173
     {
174 174
         self::init();
Please login to merge, or discard this patch.
src/ConvertHelper/SizeNotation.php 2 patches
Indentation   +86 added lines, -86 removed lines patch added patch discarded remove patch
@@ -31,9 +31,9 @@  discard block
 block discarded – undo
31 31
     
32 32
     const VALIDATION_ERROR_NEGATIVE_VALUE = 43803;
33 33
     
34
-   /**
35
-    * @var string
36
-    */
34
+    /**
35
+     * @var string
36
+     */
37 37
     protected $sizeString;
38 38
 
39 39
     /**
@@ -41,41 +41,41 @@  discard block
 block discarded – undo
41 41
      */
42 42
     protected $sizeDefinition;
43 43
     
44
-   /**
45
-    * @var integer
46
-    */
44
+    /**
45
+     * @var integer
46
+     */
47 47
     protected $bytes = 0;
48 48
     
49
-   /**
50
-    * @var bool
51
-    */
49
+    /**
50
+     * @var bool
51
+     */
52 52
     protected $valid = true;
53 53
     
54
-   /**
55
-    * @var string
56
-    */
54
+    /**
55
+     * @var string
56
+     */
57 57
     protected $units = null;
58 58
     
59
-   /**
60
-    * @var string
61
-    */
59
+    /**
60
+     * @var string
61
+     */
62 62
     protected $number = '';
63 63
     
64
-   /**
65
-    * @var string
66
-    */
64
+    /**
65
+     * @var string
66
+     */
67 67
     protected $errorMessage = '';
68 68
     
69
-   /**
70
-    * @var int
71
-    */
69
+    /**
70
+     * @var int
71
+     */
72 72
     protected $errorCode = 0;
73 73
     
74
-   /**
75
-    * Create a new instance for the specified size string.
76
-    * 
77
-    * @param string $sizeString A size notation in the format "50 MB", or a number of bytes without units. Spaces are ignored, so "50MB" = "50 MB" = "  50   MB   ". Floating point values are accepted, both with dot and comma notation ("50.5" = "50,5"). To use Base 2 values, ose appropriate units, e.g. "50 MiB", "1.5 GiB". The units are case insensitive, so "50 MB" = "50 mb". 
78
-    */
74
+    /**
75
+     * Create a new instance for the specified size string.
76
+     * 
77
+     * @param string $sizeString A size notation in the format "50 MB", or a number of bytes without units. Spaces are ignored, so "50MB" = "50 MB" = "  50   MB   ". Floating point values are accepted, both with dot and comma notation ("50.5" = "50,5"). To use Base 2 values, ose appropriate units, e.g. "50 MiB", "1.5 GiB". The units are case insensitive, so "50 MB" = "50 mb". 
78
+     */
79 79
     public function __construct(string $sizeString)
80 80
     {
81 81
         $this->sizeString = $this->cleanString($sizeString);
@@ -83,31 +83,31 @@  discard block
 block discarded – undo
83 83
         $this->convert();
84 84
     }
85 85
     
86
-   /**
87
-    * Gets the amount of bytes contained in the size notation.
88
-    * @return int
89
-    */
86
+    /**
87
+     * Gets the amount of bytes contained in the size notation.
88
+     * @return int
89
+     */
90 90
     public function toBytes() : int
91 91
     {
92 92
         return $this->bytes;
93 93
     }
94 94
     
95
-   /**
96
-    * Converts the size notation to a human readable string, e.g. "50 MB".
97
-    * 
98
-    * @param int $precision
99
-    * @return string
100
-    * @see ConvertHelper::bytes2readable()
101
-    */
95
+    /**
96
+     * Converts the size notation to a human readable string, e.g. "50 MB".
97
+     * 
98
+     * @param int $precision
99
+     * @return string
100
+     * @see ConvertHelper::bytes2readable()
101
+     */
102 102
     public function toString(int $precision=1) : string
103 103
     {
104 104
         return ConvertHelper::bytes2readable($this->bytes, $precision, $this->getBase());
105 105
     }
106 106
     
107
-   /**
108
-    * Retrieves the detected number's base.
109
-    * @return int The base number (1000 for Base 10, or 1024 for Base 2), or 0 if it is not valid.
110
-    */
107
+    /**
108
+     * Retrieves the detected number's base.
109
+     * @return int The base number (1000 for Base 10, or 1024 for Base 2), or 0 if it is not valid.
110
+     */
111 111
     public function getBase() : int
112 112
     {
113 113
         if($this->isValid()) {
@@ -117,13 +117,13 @@  discard block
 block discarded – undo
117 117
         return 0;
118 118
     }
119 119
     
120
-   /**
121
-    * Retrieves the detected storage size instance, if 
122
-    * the size string is valid.
123
-    * 
124
-    * @return ConvertHelper_StorageSizeEnum_Size|NULL
125
-    * @see ConvertHelper_StorageSizeEnum_Size
126
-    */
120
+    /**
121
+     * Retrieves the detected storage size instance, if 
122
+     * the size string is valid.
123
+     * 
124
+     * @return ConvertHelper_StorageSizeEnum_Size|NULL
125
+     * @see ConvertHelper_StorageSizeEnum_Size
126
+     */
127 127
     public function getSizeDefinition() : ?ConvertHelper_StorageSizeEnum_Size
128 128
     {
129 129
         if($this->isValid()) {
@@ -133,27 +133,27 @@  discard block
 block discarded – undo
133 133
         return null;
134 134
     }
135 135
     
136
-   /**
137
-    * Checks whether the size notation was valid and could be parsed
138
-    * into a meaningful byte value. If this returns `false`, it is 
139
-    * possible to use the `getErrorXXX` methods to retrieve information
140
-    * on what went wrong. 
141
-    * 
142
-    * @return bool
143
-    * @see ConvertHelper_SizeNotation::getErrorMessage()
144
-    * @see ConvertHelper_SizeNotation::getErrorCode()
145
-    */
136
+    /**
137
+     * Checks whether the size notation was valid and could be parsed
138
+     * into a meaningful byte value. If this returns `false`, it is 
139
+     * possible to use the `getErrorXXX` methods to retrieve information
140
+     * on what went wrong. 
141
+     * 
142
+     * @return bool
143
+     * @see ConvertHelper_SizeNotation::getErrorMessage()
144
+     * @see ConvertHelper_SizeNotation::getErrorCode()
145
+     */
146 146
     public function isValid() : bool
147 147
     {
148 148
         return $this->valid;
149 149
     }
150 150
     
151
-   /**
152
-    * Retrieves the error message if the size notation validation failed.
153
-    * 
154
-    * @return string
155
-    * @see ConvertHelper_SizeNotation::getErrorCode()
156
-    */
151
+    /**
152
+     * Retrieves the error message if the size notation validation failed.
153
+     * 
154
+     * @return string
155
+     * @see ConvertHelper_SizeNotation::getErrorCode()
156
+     */
157 157
     public function getErrorMessage() : string
158 158
     {
159 159
         return $this->errorMessage;
@@ -200,12 +200,12 @@  discard block
 block discarded – undo
200 200
         );
201 201
     }
202 202
     
203
-   /**
204
-    * Detects the units and the number in the size notation string.
205
-    * Populates the `units` and `number` properties.
206
-    * 
207
-    * @return bool Whether the string could be parsed successfully.
208
-    */
203
+    /**
204
+     * Detects the units and the number in the size notation string.
205
+     * Populates the `units` and `number` properties.
206
+     * 
207
+     * @return bool Whether the string could be parsed successfully.
208
+     */
209 209
     protected function detectParts() : bool
210 210
     {
211 211
         $units = ConvertHelper_StorageSizeEnum::getSizeNames();
@@ -241,16 +241,16 @@  discard block
 block discarded – undo
241 241
         return true;
242 242
     }
243 243
     
244
-   /**
245
-    * If the validation fails, this is used to store the reason for retrieval later.
246
-    *  
247
-    * @param string $message
248
-    * @param int $code
249
-    * 
250
-    * @see ConvertHelper_SizeNotation::isValid()
251
-    * @see ConvertHelper_SizeNotation::getErrorMessage()
252
-    * @see ConvertHelper_SizeNotation::getErrorCode()
253
-    */
244
+    /**
245
+     * If the validation fails, this is used to store the reason for retrieval later.
246
+     *  
247
+     * @param string $message
248
+     * @param int $code
249
+     * 
250
+     * @see ConvertHelper_SizeNotation::isValid()
251
+     * @see ConvertHelper_SizeNotation::getErrorMessage()
252
+     * @see ConvertHelper_SizeNotation::getErrorCode()
253
+     */
254 254
     protected function setError(string $message, int $code) : void
255 255
     {
256 256
         $this->valid = false;
@@ -258,12 +258,12 @@  discard block
 block discarded – undo
258 258
         $this->errorCode = $code;
259 259
     }
260 260
     
261
-   /**
262
-    * Retrieves the error code, if the size notation validation failed.
263
-    * 
264
-    * @return int
265
-    * @see ConvertHelper_SizeNotation::getErrorMessage()
266
-    */
261
+    /**
262
+     * Retrieves the error code, if the size notation validation failed.
263
+     * 
264
+     * @return int
265
+     * @see ConvertHelper_SizeNotation::getErrorMessage()
266
+     */
267 267
     public function getErrorCode() : int
268 268
     {
269 269
         return $this->errorCode;
Please login to merge, or discard this patch.
Spacing   +11 added lines, -11 removed lines patch added patch discarded remove patch
@@ -99,7 +99,7 @@  discard block
 block discarded – undo
99 99
     * @return string
100 100
     * @see ConvertHelper::bytes2readable()
101 101
     */
102
-    public function toString(int $precision=1) : string
102
+    public function toString(int $precision = 1) : string
103 103
     {
104 104
         return ConvertHelper::bytes2readable($this->bytes, $precision, $this->getBase());
105 105
     }
@@ -110,7 +110,7 @@  discard block
 block discarded – undo
110 110
     */
111 111
     public function getBase() : int
112 112
     {
113
-        if($this->isValid()) {
113
+        if ($this->isValid()) {
114 114
             return $this->sizeDefinition->getBase(); 
115 115
         }
116 116
         
@@ -126,7 +126,7 @@  discard block
 block discarded – undo
126 126
     */
127 127
     public function getSizeDefinition() : ?ConvertHelper_StorageSizeEnum_Size
128 128
     {
129
-        if($this->isValid()) {
129
+        if ($this->isValid()) {
130 130
             return $this->sizeDefinition;
131 131
         }
132 132
         
@@ -175,18 +175,18 @@  discard block
 block discarded – undo
175 175
     
176 176
     protected function parseSize() : void
177 177
     {
178
-        if(!$this->detectParts()) {
178
+        if (!$this->detectParts()) {
179 179
             return;
180 180
         }
181 181
         
182 182
         // we detected units in the string: all good.
183
-        if($this->units !== null)
183
+        if ($this->units !== null)
184 184
         {
185 185
             return;
186 186
         }
187 187
         
188 188
         // just a numeric value: we assume this means we're dealing with bytes.
189
-        if(is_numeric($this->number)) 
189
+        if (is_numeric($this->number)) 
190 190
         {
191 191
             $this->units = 'b';
192 192
             return;
@@ -212,12 +212,12 @@  discard block
 block discarded – undo
212 212
         
213 213
         $number = $this->sizeString;
214 214
         
215
-        foreach($units as $unit)
215
+        foreach ($units as $unit)
216 216
         {
217
-            if(stristr($number, $unit))
217
+            if (stristr($number, $unit))
218 218
             {
219 219
                 // there are more than 1 unit defined in the string
220
-                if($this->units !== null)
220
+                if ($this->units !== null)
221 221
                 {
222 222
                     $this->setError(
223 223
                         t(
@@ -273,14 +273,14 @@  discard block
 block discarded – undo
273 273
     {
274 274
         $this->parseSize();
275 275
         
276
-        if(!$this->valid) {
276
+        if (!$this->valid) {
277 277
             return;
278 278
         }
279 279
         
280 280
         $int = intval($this->number);
281 281
         
282 282
         // negative values
283
-        if($int < 0) 
283
+        if ($int < 0) 
284 284
         {
285 285
             $this->setError(
286 286
                 t('Negative values cannot be used as size.'),
Please login to merge, or discard this patch.
src/URLInfo/Parser.php 2 patches
Indentation   +17 added lines, -17 removed lines patch added patch discarded remove patch
@@ -20,24 +20,24 @@  discard block
 block discarded – undo
20 20
  */
21 21
 class URLInfo_Parser
22 22
 {
23
-   /**
24
-    * @var string
25
-    */
23
+    /**
24
+     * @var string
25
+     */
26 26
     protected $url;
27 27
     
28
-   /**
29
-    * @var bool
30
-    */
28
+    /**
29
+     * @var bool
30
+     */
31 31
     protected $isValid = false;
32 32
     
33
-   /**
34
-    * @var array
35
-    */
33
+    /**
34
+     * @var array
35
+     */
36 36
     protected $info;
37 37
     
38
-   /**
39
-    * @var array|NULL
40
-    */
38
+    /**
39
+     * @var array|NULL
40
+     */
41 41
     protected $error;
42 42
     
43 43
     /**
@@ -177,11 +177,11 @@  discard block
 block discarded – undo
177 177
         return false;
178 178
     }
179 179
 
180
-   /**
181
-    * Goes through all information in the parse_url result
182
-    * array, and attempts to fix any user errors in formatting
183
-    * that can be recovered from, mostly regarding stray spaces.
184
-    */
180
+    /**
181
+     * Goes through all information in the parse_url result
182
+     * array, and attempts to fix any user errors in formatting
183
+     * that can be recovered from, mostly regarding stray spaces.
184
+     */
185 185
     protected function filterParsed()
186 186
     {
187 187
         foreach($this->info as $key => $val)
Please login to merge, or discard this patch.
Spacing   +23 added lines, -23 removed lines patch added patch discarded remove patch
@@ -59,7 +59,7 @@  discard block
 block discarded – undo
59 59
         
60 60
         $this->parse();
61 61
         
62
-        if(!$this->detectType()) {
62
+        if (!$this->detectType()) {
63 63
             $this->validate();
64 64
         }
65 65
     }
@@ -93,11 +93,11 @@  discard block
 block discarded – undo
93 93
             'phoneLink'
94 94
         );
95 95
         
96
-        foreach($types as $type)
96
+        foreach ($types as $type)
97 97
         {
98 98
             $method = 'detectType_'.$type;
99 99
             
100
-            if($this->$method() === true) 
100
+            if ($this->$method() === true) 
101 101
             {
102 102
                 $this->isValid = true;
103 103
                 return true;
@@ -115,11 +115,11 @@  discard block
 block discarded – undo
115 115
             'hostIsPresent'
116 116
         );
117 117
         
118
-        foreach($validations as $validation) 
118
+        foreach ($validations as $validation) 
119 119
         {
120 120
             $method = 'validate_'.$validation;
121 121
             
122
-            if($this->$method() !== true) {
122
+            if ($this->$method() !== true) {
123 123
                 return;
124 124
             }
125 125
         }
@@ -132,13 +132,13 @@  discard block
 block discarded – undo
132 132
         // every link needs a host. This case can happen for ex, if
133 133
         // the link starts with a typo with only one slash, like:
134 134
         // "http:/hostname"
135
-        if(isset($this->info['host'])) {
135
+        if (isset($this->info['host'])) {
136 136
             return true;
137 137
         }
138 138
         
139 139
         $this->setError(
140 140
             URLInfo::ERROR_MISSING_HOST,
141
-            t('Cannot determine the link\'s host name.') . ' ' .
141
+            t('Cannot determine the link\'s host name.').' '.
142 142
             t('This usually happens when there\'s a typo somewhere.')
143 143
         );
144 144
 
@@ -147,7 +147,7 @@  discard block
 block discarded – undo
147 147
     
148 148
     protected function validate_schemeIsSet() : bool
149 149
     {
150
-        if(isset($this->info['scheme'])) {
150
+        if (isset($this->info['scheme'])) {
151 151
             return true;
152 152
         }
153 153
         
@@ -164,13 +164,13 @@  discard block
 block discarded – undo
164 164
     
165 165
     protected function validate_schemeIsKnown() : bool
166 166
     {
167
-        if(in_array($this->info['scheme'], $this->knownSchemes)) {
167
+        if (in_array($this->info['scheme'], $this->knownSchemes)) {
168 168
             return true;
169 169
         }
170 170
         
171 171
         $this->setError(
172 172
             URLInfo::ERROR_INVALID_SCHEME,
173
-            t('The scheme %1$s is not supported for links.', $this->info['scheme']) . ' ' .
173
+            t('The scheme %1$s is not supported for links.', $this->info['scheme']).' '.
174 174
             t('Valid schemes are: %1$s.', implode(', ', $this->knownSchemes))
175 175
         );
176 176
 
@@ -184,9 +184,9 @@  discard block
 block discarded – undo
184 184
     */
185 185
     protected function filterParsed()
186 186
     {
187
-        foreach($this->info as $key => $val)
187
+        foreach ($this->info as $key => $val)
188 188
         {
189
-            if(is_string($val)) {
189
+            if (is_string($val)) {
190 190
                 $this->info[$key] = trim($val);
191 191
             }
192 192
         }
@@ -194,23 +194,23 @@  discard block
 block discarded – undo
194 194
         $this->info['params'] = array();
195 195
         $this->info['type'] = URLInfo::TYPE_URL;
196 196
         
197
-        if(isset($this->info['user'])) {
197
+        if (isset($this->info['user'])) {
198 198
             $this->info['user'] = urldecode($this->info['user']);
199 199
         }
200 200
 
201
-        if(isset($this->info['pass'])) {
201
+        if (isset($this->info['pass'])) {
202 202
             $this->info['pass'] = urldecode($this->info['pass']);
203 203
         }
204 204
         
205
-        if(isset($this->info['host'])) {
205
+        if (isset($this->info['host'])) {
206 206
             $this->info['host'] = str_replace(' ', '', $this->info['host']);
207 207
         }
208 208
         
209
-        if(isset($this->info['path'])) {
209
+        if (isset($this->info['path'])) {
210 210
             $this->info['path'] = str_replace(' ', '', $this->info['path']);
211 211
         }
212 212
         
213
-        if(isset($this->info['query']) && !empty($this->info['query']))
213
+        if (isset($this->info['query']) && !empty($this->info['query']))
214 214
         {
215 215
             $this->info['params'] = \AppUtils\ConvertHelper::parseQueryString($this->info['query']);
216 216
             ksort($this->info['params']);
@@ -219,12 +219,12 @@  discard block
 block discarded – undo
219 219
     
220 220
     protected function detectType_email() : bool
221 221
     {
222
-        if(isset($this->info['scheme']) && $this->info['scheme'] == 'mailto') {
222
+        if (isset($this->info['scheme']) && $this->info['scheme'] == 'mailto') {
223 223
             $this->info['type'] = URLInfo::TYPE_EMAIL;
224 224
             return true;
225 225
         }
226 226
         
227
-        if(isset($this->info['path']) && preg_match(\AppUtils\RegexHelper::REGEX_EMAIL, $this->info['path']))
227
+        if (isset($this->info['path']) && preg_match(\AppUtils\RegexHelper::REGEX_EMAIL, $this->info['path']))
228 228
         {
229 229
             $this->info['scheme'] = 'mailto';
230 230
             $this->info['type'] = URLInfo::TYPE_EMAIL;
@@ -236,7 +236,7 @@  discard block
 block discarded – undo
236 236
     
237 237
     protected function detectType_fragmentLink() : bool
238 238
     {
239
-        if(isset($this->info['fragment']) && !isset($this->info['scheme'])) {
239
+        if (isset($this->info['fragment']) && !isset($this->info['scheme'])) {
240 240
             $this->info['type'] = URLInfo::TYPE_FRAGMENT;
241 241
             return true;
242 242
         }
@@ -246,7 +246,7 @@  discard block
 block discarded – undo
246 246
     
247 247
     protected function detectType_phoneLink() : bool
248 248
     {
249
-        if(isset($this->info['scheme']) && $this->info['scheme'] == 'tel') {
249
+        if (isset($this->info['scheme']) && $this->info['scheme'] == 'tel') {
250 250
             $this->info['type'] = URLInfo::TYPE_PHONE;
251 251
             return true;
252 252
         }
@@ -271,7 +271,7 @@  discard block
 block discarded – undo
271 271
 
272 272
     public function getErrorMessage() : string
273 273
     {
274
-        if(isset($this->error)) {
274
+        if (isset($this->error)) {
275 275
             return $this->error['message'];
276 276
         }
277 277
         
@@ -280,7 +280,7 @@  discard block
 block discarded – undo
280 280
     
281 281
     public function getErrorCode() : int
282 282
     {
283
-        if(isset($this->error)) {
283
+        if (isset($this->error)) {
284 284
             return $this->error['code'];
285 285
         }
286 286
         
Please login to merge, or discard this patch.
src/URLInfo/Highlighter.php 3 patches
Indentation   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -20,9 +20,9 @@
 block discarded – undo
20 20
  */
21 21
 class URLInfo_Highlighter
22 22
 {
23
-   /**
24
-    * @var URLInfo
25
-    */
23
+    /**
24
+     * @var URLInfo
25
+     */
26 26
     protected $info;
27 27
     
28 28
     public function __construct(URLInfo $info)
Please login to merge, or discard this patch.
Braces   +2 added lines, -4 removed lines patch added patch discarded remove patch
@@ -204,13 +204,11 @@
 block discarded – undo
204 204
                         $tooltip,
205 205
                         $parts
206 206
                     );
207
-                }
208
-                else
207
+                } else
209 208
                 {
210 209
                     continue;
211 210
                 }
212
-            }
213
-            else
211
+            } else
214 212
             {
215 213
                 $tag = sprintf(
216 214
                     '<span class="link-param">%s</span>',
Please login to merge, or discard this patch.
Spacing   +13 added lines, -13 removed lines patch added patch discarded remove patch
@@ -77,7 +77,7 @@  discard block
 block discarded – undo
77 77
             'fragment'
78 78
         );
79 79
         
80
-        foreach($parts as $part) 
80
+        foreach ($parts as $part) 
81 81
         {
82 82
             $method = 'render_'.$part;
83 83
             $result[] = (string)$this->$method();
@@ -88,7 +88,7 @@  discard block
 block discarded – undo
88 88
     
89 89
     protected function render_scheme() : string
90 90
     {
91
-        if(!$this->info->hasScheme()) {
91
+        if (!$this->info->hasScheme()) {
92 92
             return '';
93 93
         }
94 94
         
@@ -103,7 +103,7 @@  discard block
 block discarded – undo
103 103
     
104 104
     protected function render_username() : string
105 105
     {
106
-        if(!$this->info->hasUsername()) {
106
+        if (!$this->info->hasUsername()) {
107 107
             return '';
108 108
         }
109 109
         
@@ -119,7 +119,7 @@  discard block
 block discarded – undo
119 119
     
120 120
     protected function render_host() : string
121 121
     {
122
-        if(!$this->info->hasHost()) {
122
+        if (!$this->info->hasHost()) {
123 123
             return '';
124 124
         }
125 125
         
@@ -131,7 +131,7 @@  discard block
 block discarded – undo
131 131
     
132 132
     protected function render_port() : string
133 133
     {
134
-        if(!$this->info->hasPort()) {
134
+        if (!$this->info->hasPort()) {
135 135
             return '';
136 136
         }
137 137
         
@@ -144,7 +144,7 @@  discard block
 block discarded – undo
144 144
        
145 145
     protected function render_path() : string
146 146
     {
147
-        if(!$this->info->hasPath()) {
147
+        if (!$this->info->hasPath()) {
148 148
             return '';
149 149
         }
150 150
         
@@ -162,19 +162,19 @@  discard block
 block discarded – undo
162 162
     {
163 163
         $params = $this->info->getParams();
164 164
         
165
-        if(empty($params)) {
165
+        if (empty($params)) {
166 166
             return '';
167 167
         }
168 168
         
169 169
         $tokens = array();
170 170
         $excluded = array();
171 171
         
172
-        if($this->info->isParamExclusionEnabled())
172
+        if ($this->info->isParamExclusionEnabled())
173 173
         {
174 174
             $excluded = $this->info->getExcludedParams();
175 175
         }
176 176
         
177
-        foreach($params as $param => $value)
177
+        foreach ($params as $param => $value)
178 178
         {
179 179
             $parts = sprintf(
180 180
                 '<span class="link-param-name">%s</span>'.
@@ -192,10 +192,10 @@  discard block
 block discarded – undo
192 192
             $tag = '';
193 193
             
194 194
             // is parameter exclusion enabled, and is this an excluded parameter?
195
-            if(isset($excluded[$param]))            
195
+            if (isset($excluded[$param]))            
196 196
             {
197 197
                 // display the excluded parameter, but highlight it
198
-                if($this->info->isHighlightExcludeEnabled())
198
+                if ($this->info->isHighlightExcludeEnabled())
199 199
                 {
200 200
                     $tooltip = $excluded[$param];
201 201
                     
@@ -228,7 +228,7 @@  discard block
 block discarded – undo
228 228
      
229 229
     protected function render_fragment() : string
230 230
     {
231
-        if(!$this->info->hasFragment()) {
231
+        if (!$this->info->hasFragment()) {
232 232
             return '';
233 233
         }
234 234
         
@@ -243,7 +243,7 @@  discard block
 block discarded – undo
243 243
     {
244 244
         $cssFolder = realpath(__DIR__.'/../../css');
245 245
         
246
-        if($cssFolder === false) {
246
+        if ($cssFolder === false) {
247 247
             throw new BaseException(
248 248
                 'Cannot find package CSS folder.',
249 249
                 null,
Please login to merge, or discard this patch.
src/Request.php 2 patches
Indentation   +122 added lines, -122 removed lines patch added patch discarded remove patch
@@ -39,9 +39,9 @@  discard block
 block discarded – undo
39 39
      */
40 40
     protected static $instance;
41 41
     
42
-   /**
43
-    * @var string
44
-    */
42
+    /**
43
+     * @var string
44
+     */
45 45
     protected $baseURL = '';
46 46
     
47 47
     public function __construct()
@@ -51,10 +51,10 @@  discard block
 block discarded – undo
51 51
         $this->init();
52 52
     }
53 53
     
54
-   /**
55
-    * Can be extended in a subclass, to avoid
56
-    * redefining the constructor.
57
-    */
54
+    /**
55
+     * Can be extended in a subclass, to avoid
56
+     * redefining the constructor.
57
+     */
58 58
     protected function init()
59 59
     {
60 60
         
@@ -124,12 +124,12 @@  discard block
 block discarded – undo
124 124
         return $this->buildURL($params, $dispatcher);
125 125
     }
126 126
     
127
-   /**
128
-    * Retrieves the name of the current dispatcher script / page.
129
-    * This is made to be extended and implemented in a subclass.
130
-    * 
131
-    * @return string
132
-    */
127
+    /**
128
+     * Retrieves the name of the current dispatcher script / page.
129
+     * This is made to be extended and implemented in a subclass.
130
+     * 
131
+     * @return string
132
+     */
133 133
     public function getDispatcher() : string
134 134
     {
135 135
         return '';
@@ -198,10 +198,10 @@  discard block
 block discarded – undo
198 198
         return $url;
199 199
     }
200 200
     
201
-   /**
202
-    * Retrieves the base URL of the application.
203
-    * @return string
204
-    */
201
+    /**
202
+     * Retrieves the base URL of the application.
203
+     * @return string
204
+     */
205 205
     public function getBaseURL() : string
206 206
     {
207 207
         return $this->baseURL;
@@ -231,13 +231,13 @@  discard block
 block discarded – undo
231 231
         return $this->knownParams[$name];
232 232
     }
233 233
     
234
-   /**
235
-    * Retrieves a previously registered parameter instance.
236
-    * 
237
-    * @param string $name
238
-    * @throws Request_Exception
239
-    * @return Request_Param
240
-    */
234
+    /**
235
+     * Retrieves a previously registered parameter instance.
236
+     * 
237
+     * @param string $name
238
+     * @throws Request_Exception
239
+     * @return Request_Param
240
+     */
241 241
     public function getRegisteredParam(string $name) : Request_Param
242 242
     {
243 243
         if(isset($this->knownParams[$name])) {
@@ -254,48 +254,48 @@  discard block
 block discarded – undo
254 254
         );
255 255
     }
256 256
     
257
-   /**
258
-    * Checks whether a parameter with the specified name 
259
-    * has been registered.
260
-    * 
261
-    * @param string $name
262
-    * @return bool
263
-    */
257
+    /**
258
+     * Checks whether a parameter with the specified name 
259
+     * has been registered.
260
+     * 
261
+     * @param string $name
262
+     * @return bool
263
+     */
264 264
     public function hasRegisteredParam(string $name) : bool
265 265
     {
266 266
         return isset($this->knownParams[$name]);
267 267
     }
268 268
     
269
-   /**
270
-    * Retrieves an indexed array with accept mime types
271
-    * that the client sent, in the order of preference
272
-    * the client specified.
273
-    *
274
-    * Example:
275
-    *
276
-    * array(
277
-    *     'text/html',
278
-    *     'application/xhtml+xml',
279
-    *     'image/webp'
280
-    *     ...
281
-    * )
282
-    * 
283
-    * @return array
284
-    * @see Request::parseAcceptHeaders()
285
-    */
269
+    /**
270
+     * Retrieves an indexed array with accept mime types
271
+     * that the client sent, in the order of preference
272
+     * the client specified.
273
+     *
274
+     * Example:
275
+     *
276
+     * array(
277
+     *     'text/html',
278
+     *     'application/xhtml+xml',
279
+     *     'image/webp'
280
+     *     ...
281
+     * )
282
+     * 
283
+     * @return array
284
+     * @see Request::parseAcceptHeaders()
285
+     */
286 286
     public static function getAcceptHeaders() : array
287 287
     {
288 288
         return self::parseAcceptHeaders()->getMimeStrings();
289 289
     }
290 290
     
291
-   /**
292
-    * Returns an instance of the accept headers parser,
293
-    * to access information on the browser's accepted
294
-    * mime types.
295
-    *  
296
-    * @return Request_AcceptHeaders
297
-    * @see Request::getAcceptHeaders()
298
-    */
291
+    /**
292
+     * Returns an instance of the accept headers parser,
293
+     * to access information on the browser's accepted
294
+     * mime types.
295
+     *  
296
+     * @return Request_AcceptHeaders
297
+     * @see Request::getAcceptHeaders()
298
+     */
299 299
     public static function parseAcceptHeaders() : Request_AcceptHeaders
300 300
     {
301 301
         static $accept;
@@ -343,14 +343,14 @@  discard block
 block discarded – undo
343 343
         return false;
344 344
     }
345 345
     
346
-   /**
347
-    * Removes a single parameter from the request.
348
-    * If the parameter has been registered, also
349
-    * removes the registration info.
350
-    * 
351
-    * @param string $name
352
-    * @return Request
353
-    */
346
+    /**
347
+     * Removes a single parameter from the request.
348
+     * If the parameter has been registered, also
349
+     * removes the registration info.
350
+     * 
351
+     * @param string $name
352
+     * @return Request
353
+     */
354 354
     public function removeParam(string $name) : Request
355 355
     {
356 356
         if(isset($_REQUEST[$name])) {
@@ -364,12 +364,12 @@  discard block
 block discarded – undo
364 364
         return $this;
365 365
     }
366 366
     
367
-   /**
368
-    * Removes several parameters from the request.
369
-    * 
370
-    * @param string[] $names
371
-    * @return Request
372
-    */
367
+    /**
368
+     * Removes several parameters from the request.
369
+     * 
370
+     * @param string[] $names
371
+     * @return Request
372
+     */
373 373
     public function removeParams(array $names) : Request
374 374
     {
375 375
         foreach($names as $name) {
@@ -434,18 +434,18 @@  discard block
 block discarded – undo
434 434
         return $val;
435 435
     }
436 436
     
437
-   /**
438
-    * Treats the request parameter as a JSON string, and
439
-    * if it exists and contains valid JSON, returns the
440
-    * decoded JSON value as an array (default).
441
-    *
442
-    * @param string $name
443
-    * @param bool $assoc
444
-    * @return array|object
445
-    * 
446
-    * @see Request::getJSONAssoc()
447
-    * @see Request::getJSONObject()
448
-    */
437
+    /**
438
+     * Treats the request parameter as a JSON string, and
439
+     * if it exists and contains valid JSON, returns the
440
+     * decoded JSON value as an array (default).
441
+     *
442
+     * @param string $name
443
+     * @param bool $assoc
444
+     * @return array|object
445
+     * 
446
+     * @see Request::getJSONAssoc()
447
+     * @see Request::getJSONObject()
448
+     */
449 449
     public function getJSON(string $name, bool $assoc=true)
450 450
     {
451 451
         $value = $this->getParam($name);
@@ -470,13 +470,13 @@  discard block
 block discarded – undo
470 470
         return new \stdClass();
471 471
     }
472 472
     
473
-   /**
474
-    * Like {@link Request::getJSON()}, but omitting the second
475
-    * parameter. Use this for more readable code.
476
-    * 
477
-    * @param string $name
478
-    * @return array
479
-    */
473
+    /**
474
+     * Like {@link Request::getJSON()}, but omitting the second
475
+     * parameter. Use this for more readable code.
476
+     * 
477
+     * @param string $name
478
+     * @return array
479
+     */
480 480
     public function getJSONAssoc(string $name) : array
481 481
     {
482 482
         $result = $this->getJSON($name);
@@ -487,13 +487,13 @@  discard block
 block discarded – undo
487 487
         return array();
488 488
     }
489 489
     
490
-   /**
491
-    * Like {@link Request::getJSON()}, but omitting the second
492
-    * parameter. Use this for more readable code.
493
-    *
494
-    * @param string $name
495
-    * @return object
496
-    */
490
+    /**
491
+     * Like {@link Request::getJSON()}, but omitting the second
492
+     * parameter. Use this for more readable code.
493
+     *
494
+     * @param string $name
495
+     * @return object
496
+     */
497 497
     public function getJSONObject(string $name) : object
498 498
     {
499 499
         $result = $this->getJSON($name, false);
@@ -504,12 +504,12 @@  discard block
 block discarded – undo
504 504
         return new \stdClass();
505 505
     }
506 506
     
507
-   /**
508
-    * Sends a JSON response with the correct headers.
509
-    *
510
-    * @param array|string $data
511
-    * @param bool $exit Whether to exit the script afterwards.
512
-    */
507
+    /**
508
+     * Sends a JSON response with the correct headers.
509
+     *
510
+     * @param array|string $data
511
+     * @param bool $exit Whether to exit the script afterwards.
512
+     */
513 513
     public static function sendJSON($data, bool $exit=true)
514 514
     {
515 515
         $payload = $data;
@@ -529,12 +529,12 @@  discard block
 block discarded – undo
529 529
         }
530 530
     }
531 531
     
532
-   /**
533
-    * Sends HTML to the browser with the correct headers.
534
-    * 
535
-    * @param string $html
536
-    * @param bool $exit Whether to exit the script afterwards.
537
-    */
532
+    /**
533
+     * Sends HTML to the browser with the correct headers.
534
+     * 
535
+     * @param string $html
536
+     * @param bool $exit Whether to exit the script afterwards.
537
+     */
538 538
     public static function sendHTML(string $html, bool $exit=true)
539 539
     {
540 540
         header('Cache-Control: no-cache, must-revalidate');
@@ -549,16 +549,16 @@  discard block
 block discarded – undo
549 549
         }
550 550
     }
551 551
     
552
-   /**
553
-    * Creates a new instance of the URL comparer, which can check 
554
-    * whether the specified URLs match, regardless of the order in 
555
-    * which the query parameters are, if any.
556
-    * 
557
-    * @param string $sourceURL
558
-    * @param string $targetURL
559
-    * @param array $limitParams Whether to limit the comparison to these specific parameter names (if present)
560
-    * @return Request_URLComparer
561
-    */
552
+    /**
553
+     * Creates a new instance of the URL comparer, which can check 
554
+     * whether the specified URLs match, regardless of the order in 
555
+     * which the query parameters are, if any.
556
+     * 
557
+     * @param string $sourceURL
558
+     * @param string $targetURL
559
+     * @param array $limitParams Whether to limit the comparison to these specific parameter names (if present)
560
+     * @return Request_URLComparer
561
+     */
562 562
     public function createURLComparer(string $sourceURL, string $targetURL, array $limitParams=array()) : Request_URLComparer
563 563
     {
564 564
         $comparer = new Request_URLComparer($this, $sourceURL, $targetURL);
@@ -567,10 +567,10 @@  discard block
 block discarded – undo
567 567
         return $comparer;
568 568
     }
569 569
     
570
-   /**
571
-    * Retrieves the full URL that was used to access the current page.
572
-    * @return string
573
-    */
570
+    /**
571
+     * Retrieves the full URL that was used to access the current page.
572
+     * @return string
573
+     */
574 574
     public function getCurrentURL() : string
575 575
     {
576 576
         return $_SERVER['HTTP_HOST'].$_SERVER['REQUEST_URI'];
Please login to merge, or discard this patch.
Spacing   +35 added lines, -35 removed lines patch added patch discarded remove patch
@@ -90,11 +90,11 @@  discard block
 block discarded – undo
90 90
     public function getParam($name, $default = null)
91 91
     {
92 92
         $value = $default;
93
-        if(isset($_REQUEST[$name])) {
93
+        if (isset($_REQUEST[$name])) {
94 94
             $value = $_REQUEST[$name];
95 95
         }
96 96
         
97
-        if(isset($this->knownParams[$name])) {
97
+        if (isset($this->knownParams[$name])) {
98 98
             $value = $this->knownParams[$name]->validate($value);
99 99
         }
100 100
         
@@ -143,9 +143,9 @@  discard block
 block discarded – undo
143 143
         
144 144
         $exclude = array_merge($exclude, $this->getExcludeParams());
145 145
         
146
-        foreach($exclude as $name) 
146
+        foreach ($exclude as $name) 
147 147
         {
148
-            if(isset($vars[$name])) 
148
+            if (isset($vars[$name])) 
149 149
             {
150 150
                 unset($vars[$name]);
151 151
             }
@@ -156,9 +156,9 @@  discard block
 block discarded – undo
156 156
         // remove the HTML_QuickForm2 form variable if present, to 
157 157
         // avoid redirect loops when using the refresh URL in
158 158
         // a page in which a form has been submitted.
159
-        foreach($names as $name) 
159
+        foreach ($names as $name) 
160 160
         {
161
-            if(strstr($name, '_qf__')) 
161
+            if (strstr($name, '_qf__')) 
162 162
             {
163 163
                 unset($vars[$name]);
164 164
                 break;
@@ -186,13 +186,13 @@  discard block
 block discarded – undo
186 186
      * @param string $dispatcher Relative path to script to use for the URL. Append trailing slash if needed.
187 187
      * @return string
188 188
      */
189
-    public function buildURL($params = array(), string $dispatcher='')
189
+    public function buildURL($params = array(), string $dispatcher = '')
190 190
     {
191
-        $url = rtrim($this->getBaseURL(), '/') . '/' . $dispatcher;
191
+        $url = rtrim($this->getBaseURL(), '/').'/'.$dispatcher;
192 192
         
193 193
         // append any leftover parameters to the end of the URL
194 194
         if (!empty($params)) {
195
-            $url .= '?' . http_build_query($params, null, '&amp;');
195
+            $url .= '?'.http_build_query($params, null, '&amp;');
196 196
         }
197 197
         
198 198
         return $url;
@@ -223,7 +223,7 @@  discard block
 block discarded – undo
223 223
      */
224 224
     public function registerParam($name)
225 225
     {
226
-        if(!isset($this->knownParams[$name])) {
226
+        if (!isset($this->knownParams[$name])) {
227 227
             $param = new Request_Param($this, $name);
228 228
             $this->knownParams[$name] = $param;
229 229
         }
@@ -240,7 +240,7 @@  discard block
 block discarded – undo
240 240
     */
241 241
     public function getRegisteredParam(string $name) : Request_Param
242 242
     {
243
-        if(isset($this->knownParams[$name])) {
243
+        if (isset($this->knownParams[$name])) {
244 244
             return $this->knownParams[$name];
245 245
         }
246 246
         
@@ -300,7 +300,7 @@  discard block
 block discarded – undo
300 300
     {
301 301
         static $accept;
302 302
         
303
-        if(!isset($accept)) {
303
+        if (!isset($accept)) {
304 304
             $accept = new Request_AcceptHeaders();
305 305
         }
306 306
         
@@ -319,7 +319,7 @@  discard block
 block discarded – undo
319 319
     {
320 320
         $_REQUEST[$name] = $value;
321 321
         
322
-        if(isset($this->knownParams[$name])) {
322
+        if (isset($this->knownParams[$name])) {
323 323
             unset($this->knownParams[$name]);
324 324
         }
325 325
         
@@ -353,11 +353,11 @@  discard block
 block discarded – undo
353 353
     */
354 354
     public function removeParam(string $name) : Request
355 355
     {
356
-        if(isset($_REQUEST[$name])) {
356
+        if (isset($_REQUEST[$name])) {
357 357
             unset($_REQUEST[$name]);
358 358
         }
359 359
         
360
-        if(isset($this->knownParams[$name])) {
360
+        if (isset($this->knownParams[$name])) {
361 361
             unset($this->knownParams[$name]);
362 362
         }
363 363
         
@@ -372,7 +372,7 @@  discard block
 block discarded – undo
372 372
     */
373 373
     public function removeParams(array $names) : Request
374 374
     {
375
-        foreach($names as $name) {
375
+        foreach ($names as $name) {
376 376
             $this->removeParam($name);
377 377
         }
378 378
         
@@ -388,10 +388,10 @@  discard block
 block discarded – undo
388 388
      * @param string $name
389 389
      * @return bool
390 390
      */
391
-    public function getBool($name, $default=false)
391
+    public function getBool($name, $default = false)
392 392
     {
393 393
         $value = $this->getParam($name, $default);
394
-        if(ConvertHelper::isBoolean($value)) {
394
+        if (ConvertHelper::isBoolean($value)) {
395 395
             return ConvertHelper::string2bool($value);
396 396
         }
397 397
         
@@ -400,11 +400,11 @@  discard block
 block discarded – undo
400 400
     
401 401
     public function validate()
402 402
     {
403
-        foreach($this->knownParams as $param) 
403
+        foreach ($this->knownParams as $param) 
404 404
         {
405 405
             $name = $param->getName();
406 406
             
407
-            if($param->isRequired() && !$this->hasParam($name)) 
407
+            if ($param->isRequired() && !$this->hasParam($name)) 
408 408
             {
409 409
                 throw new Request_Exception(
410 410
                     'Missing request parameter '.$name,
@@ -426,10 +426,10 @@  discard block
 block discarded – undo
426 426
      * @param mixed $default
427 427
      * @return string
428 428
      */
429
-    public function getFilteredParam($name, $default=null)
429
+    public function getFilteredParam($name, $default = null)
430 430
     {
431 431
         $val = $this->getParam($name, $default);
432
-        if(is_string($val)) {
432
+        if (is_string($val)) {
433 433
             $val = htmlspecialchars(trim(strip_tags($val)), ENT_QUOTES, 'UTF-8');
434 434
         }
435 435
         
@@ -448,24 +448,24 @@  discard block
 block discarded – undo
448 448
     * @see Request::getJSONAssoc()
449 449
     * @see Request::getJSONObject()
450 450
     */
451
-    public function getJSON(string $name, bool $assoc=true)
451
+    public function getJSON(string $name, bool $assoc = true)
452 452
     {
453 453
         $value = $this->getParam($name);
454 454
         
455
-        if(!empty($value) && is_string($value)) 
455
+        if (!empty($value) && is_string($value)) 
456 456
         {
457 457
             $data = json_decode($value, $assoc);
458 458
             
459
-            if($assoc && is_array($data)) {
459
+            if ($assoc && is_array($data)) {
460 460
                 return $data;
461 461
             }
462 462
             
463
-            if(is_object($data)) {
463
+            if (is_object($data)) {
464 464
                 return $data;
465 465
             }
466 466
         }
467 467
         
468
-        if($assoc) {
468
+        if ($assoc) {
469 469
             return array();
470 470
         }
471 471
         
@@ -482,7 +482,7 @@  discard block
 block discarded – undo
482 482
     public function getJSONAssoc(string $name) : array
483 483
     {
484 484
         $result = $this->getJSON($name);
485
-        if(is_array($result)) {
485
+        if (is_array($result)) {
486 486
             return $result;
487 487
         }
488 488
         
@@ -499,7 +499,7 @@  discard block
 block discarded – undo
499 499
     public function getJSONObject(string $name) : object
500 500
     {
501 501
         $result = $this->getJSON($name, false);
502
-        if(is_object($result)) {
502
+        if (is_object($result)) {
503 503
             return $result;
504 504
         }
505 505
         
@@ -512,10 +512,10 @@  discard block
 block discarded – undo
512 512
     * @param array|string $data
513 513
     * @param bool $exit Whether to exit the script afterwards.
514 514
     */
515
-    public static function sendJSON($data, bool $exit=true)
515
+    public static function sendJSON($data, bool $exit = true)
516 516
     {
517 517
         $payload = $data;
518
-        if(!is_string($payload)) {
518
+        if (!is_string($payload)) {
519 519
             $payload = json_encode($payload);
520 520
         }
521 521
         
@@ -525,7 +525,7 @@  discard block
 block discarded – undo
525 525
         
526 526
         echo $payload;
527 527
         
528
-        if($exit) 
528
+        if ($exit) 
529 529
         {
530 530
             exit;
531 531
         }
@@ -537,7 +537,7 @@  discard block
 block discarded – undo
537 537
     * @param string $html
538 538
     * @param bool $exit Whether to exit the script afterwards.
539 539
     */
540
-    public static function sendHTML(string $html, bool $exit=true)
540
+    public static function sendHTML(string $html, bool $exit = true)
541 541
     {
542 542
         header('Cache-Control: no-cache, must-revalidate');
543 543
         header('Expires: Mon, 26 Jul 1997 05:00:00 GMT');
@@ -545,7 +545,7 @@  discard block
 block discarded – undo
545 545
         
546 546
         echo $html;
547 547
         
548
-        if($exit)
548
+        if ($exit)
549 549
         {
550 550
             exit;
551 551
         }
@@ -561,7 +561,7 @@  discard block
 block discarded – undo
561 561
     * @param array $limitParams Whether to limit the comparison to these specific parameter names (if present)
562 562
     * @return Request_URLComparer
563 563
     */
564
-    public function createURLComparer(string $sourceURL, string $targetURL, array $limitParams=array()) : Request_URLComparer
564
+    public function createURLComparer(string $sourceURL, string $targetURL, array $limitParams = array()) : Request_URLComparer
565 565
     {
566 566
         $comparer = new Request_URLComparer($this, $sourceURL, $targetURL);
567 567
         $comparer->addLimitParams($limitParams);
Please login to merge, or discard this patch.
src/Request/AcceptHeaders.php 3 patches
Indentation   +37 added lines, -37 removed lines patch added patch discarded remove patch
@@ -28,20 +28,20 @@  discard block
 block discarded – undo
28 28
         $this->parse();
29 29
     }
30 30
     
31
-   /**
32
-    * Retrieves an indexed array with accept mime types
33
-    * that the client sent, in the order of preference
34
-    * the client specified.
35
-    *
36
-    * Example:
37
-    *
38
-    * array(
39
-    *     'text/html',
40
-    *     'application/xhtml+xml',
41
-    *     'image/webp'
42
-    *     ...
43
-    * )
44
-    */
31
+    /**
32
+     * Retrieves an indexed array with accept mime types
33
+     * that the client sent, in the order of preference
34
+     * the client specified.
35
+     *
36
+     * Example:
37
+     *
38
+     * array(
39
+     *     'text/html',
40
+     *     'application/xhtml+xml',
41
+     *     'image/webp'
42
+     *     ...
43
+     * )
44
+     */
45 45
     public function getMimeStrings() : array
46 46
     {
47 47
         $result = array();
@@ -54,9 +54,9 @@  discard block
 block discarded – undo
54 54
         return $result;
55 55
     }
56 56
     
57
-   /**
58
-    * Checks that an accept header string exists, and tries to parse it.
59
-    */
57
+    /**
58
+     * Checks that an accept header string exists, and tries to parse it.
59
+     */
60 60
     protected function parse() : void
61 61
     {
62 62
         // we may be in a CLI environment where the headers
@@ -68,11 +68,11 @@  discard block
 block discarded – undo
68 68
         $this->headers = $this->parseHeader($_SERVER['HTTP_ACCEPT']);
69 69
     }
70 70
     
71
-   /**
72
-    * Splits the accept header string and parses the mime types.
73
-    *  
74
-    * @param string $acceptHeader 
75
-    */
71
+    /**
72
+     * Splits the accept header string and parses the mime types.
73
+     *  
74
+     * @param string $acceptHeader 
75
+     */
76 76
     protected function parseHeader(string $acceptHeader) : array
77 77
     {
78 78
         $tokens = preg_split('/\s*,\s*/', $acceptHeader);
@@ -89,13 +89,13 @@  discard block
 block discarded – undo
89 89
         return $accept;
90 90
     }
91 91
     
92
-   /**
93
-    * Parses a single mime type entry.
94
-    * 
95
-    * @param int $i The position in the accept string
96
-    * @param string $mime The mime type
97
-    * @return array
98
-    */
92
+    /**
93
+     * Parses a single mime type entry.
94
+     * 
95
+     * @param int $i The position in the accept string
96
+     * @param string $mime The mime type
97
+     * @return array
98
+     */
99 99
     protected function parseEntry(int $i, string $mime) : array
100 100
     {
101 101
         $entry = array(
@@ -125,14 +125,14 @@  discard block
 block discarded – undo
125 125
         return $entry;
126 126
     }
127 127
     
128
-   /**
129
-    * Sorts the mime types collection, first by quality
130
-    * and then by position in the list.
131
-    * 
132
-    * @param array $a
133
-    * @param array $b
134
-    * @return number
135
-    */
128
+    /**
129
+     * Sorts the mime types collection, first by quality
130
+     * and then by position in the list.
131
+     * 
132
+     * @param array $a
133
+     * @param array $b
134
+     * @return number
135
+     */
136 136
     protected function sortMimeTypes(array $a, array $b)
137 137
     {
138 138
         /* first tier: highest q factor wins */
Please login to merge, or discard this patch.
Spacing   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -46,7 +46,7 @@  discard block
 block discarded – undo
46 46
     {
47 47
         $result = array();
48 48
         
49
-        foreach($this->headers as $header)
49
+        foreach ($this->headers as $header)
50 50
         {
51 51
             $result[] = $header['type'];
52 52
         }
@@ -61,7 +61,7 @@  discard block
 block discarded – undo
61 61
     {
62 62
         // we may be in a CLI environment where the headers
63 63
         // are not populated.
64
-        if(!isset($_SERVER['HTTP_ACCEPT'])) {
64
+        if (!isset($_SERVER['HTTP_ACCEPT'])) {
65 65
             return;
66 66
         }
67 67
         
@@ -79,7 +79,7 @@  discard block
 block discarded – undo
79 79
         
80 80
         $accept = array();
81 81
         
82
-        foreach($tokens as $i => $term)
82
+        foreach ($tokens as $i => $term)
83 83
         {
84 84
             $accept[] = $this->parseEntry($i, $term);
85 85
         }
@@ -105,7 +105,7 @@  discard block
 block discarded – undo
105 105
             'type' => null
106 106
         );
107 107
         
108
-        if(strstr($mime, ';'))
108
+        if (strstr($mime, ';'))
109 109
         {
110 110
             $parts = explode(';', $mime);
111 111
             $mime = array_shift($parts);
@@ -114,7 +114,7 @@  discard block
 block discarded – undo
114 114
             // like an URL query string if separated by ampersands;
115 115
             $entry['params'] = ConvertHelper::parseQueryString(implode('&', $parts));
116 116
                 
117
-            if(isset($entry['params']['q'])) 
117
+            if (isset($entry['params']['q'])) 
118 118
             {
119 119
                 $entry['quality'] = (double)$entry['params']['q'];
120 120
             } 
Please login to merge, or discard this patch.
Braces   +2 added lines, -4 removed lines patch added patch discarded remove patch
@@ -141,14 +141,12 @@
 block discarded – undo
141 141
         if ($diff > 0) 
142 142
         {
143 143
             $diff = 1;
144
-        } 
145
-        else 
144
+        } else 
146 145
         {
147 146
             if ($diff < 0) 
148 147
             {
149 148
                 $diff = -1;
150
-            } 
151
-            else 
149
+            } else 
152 150
             {
153 151
                 /* tie-breaker: first listed item wins */
154 152
                 $diff = $a['pos'] - $b['pos'];
Please login to merge, or discard this patch.
src/FileHelper.php 3 patches
Braces   +3 added lines, -6 removed lines patch added patch discarded remove patch
@@ -215,8 +215,7 @@  discard block
 block discarded – undo
215 215
             if ($item->isDir()) 
216 216
             {
217 217
                 FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target . '/' . $baseName);
218
-            } 
219
-            else if($item->isFile()) 
218
+            } else if($item->isFile()) 
220 219
             {
221 220
                 self::copyFile($itemPath, $target . '/' . $baseName);
222 221
             }
@@ -260,8 +259,7 @@  discard block
 block discarded – undo
260 259
         if(!file_exists($targetFolder))
261 260
         {
262 261
             self::createFolder($targetFolder);
263
-        }
264
-        else if(!is_writable($targetFolder)) 
262
+        } else if(!is_writable($targetFolder)) 
265 263
         {
266 264
             throw new FileHelper_Exception(
267 265
                 sprintf('Target folder [%s] is not writable.', basename($targetFolder)),
@@ -760,8 +758,7 @@  discard block
 block discarded – undo
760 758
         if(isset($options['relative-path']) && $options['relative-path'] === true) 
761 759
         {
762 760
             $finder->setPathmodeRelative();
763
-        } 
764
-        else if(isset($options['absolute-path']) && $options['absolute-path'] === true)
761
+        } else if(isset($options['absolute-path']) && $options['absolute-path'] === true)
765 762
         {
766 763
             $finder->setPathmodeAbsolute();
767 764
         }
Please login to merge, or discard this patch.
Indentation   +410 added lines, -410 removed lines patch added patch discarded remove patch
@@ -74,32 +74,32 @@  discard block
 block discarded – undo
74 74
     
75 75
     const ERROR_CANNOT_OPEN_FILE_TO_DETECT_BOM = 340032;
76 76
     
77
-   /**
78
-    * Opens a serialized file and returns the unserialized data.
79
-    * 
80
-    * @param string $file
81
-    * @throws FileHelper_Exception
82
-    * @return array
83
-    * @deprecated Use parseSerializedFile() instead.
84
-    * @see FileHelper::parseSerializedFile()
85
-    */
77
+    /**
78
+     * Opens a serialized file and returns the unserialized data.
79
+     * 
80
+     * @param string $file
81
+     * @throws FileHelper_Exception
82
+     * @return array
83
+     * @deprecated Use parseSerializedFile() instead.
84
+     * @see FileHelper::parseSerializedFile()
85
+     */
86 86
     public static function openUnserialized(string $file) : array
87 87
     {
88 88
         return self::parseSerializedFile($file);
89 89
     }
90 90
 
91
-   /**
92
-    * Opens a serialized file and returns the unserialized data.
93
-    *
94
-    * @param string $file
95
-    * @throws FileHelper_Exception
96
-    * @return array
97
-    * @see FileHelper::parseSerializedFile()
98
-    * 
99
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
100
-    * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
101
-    * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
102
-    */
91
+    /**
92
+     * Opens a serialized file and returns the unserialized data.
93
+     *
94
+     * @param string $file
95
+     * @throws FileHelper_Exception
96
+     * @return array
97
+     * @see FileHelper::parseSerializedFile()
98
+     * 
99
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
100
+     * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
101
+     * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
102
+     */
103 103
     public static function parseSerializedFile(string $file)
104 104
     {
105 105
         self::requireFileExists($file);
@@ -168,13 +168,13 @@  discard block
 block discarded – undo
168 168
         return rmdir($rootFolder);
169 169
     }
170 170
     
171
-   /**
172
-    * Create a folder, if it does not exist yet.
173
-    *  
174
-    * @param string $path
175
-    * @throws FileHelper_Exception
176
-    * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
177
-    */
171
+    /**
172
+     * Create a folder, if it does not exist yet.
173
+     *  
174
+     * @param string $path
175
+     * @throws FileHelper_Exception
176
+     * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
177
+     */
178 178
     public static function createFolder($path)
179 179
     {
180 180
         if(is_dir($path) || mkdir($path, 0777, true)) {
@@ -221,22 +221,22 @@  discard block
 block discarded – undo
221 221
         }
222 222
     }
223 223
     
224
-   /**
225
-    * Copies a file to the target location. Includes checks
226
-    * for most error sources, like the source file not being
227
-    * readable. Automatically creates the target folder if it
228
-    * does not exist yet.
229
-    * 
230
-    * @param string $sourcePath
231
-    * @param string $targetPath
232
-    * @throws FileHelper_Exception
233
-    * 
234
-    * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
235
-    * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND
236
-    * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE
237
-    * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE
238
-    * @see FileHelper::ERROR_CANNOT_COPY_FILE
239
-    */
224
+    /**
225
+     * Copies a file to the target location. Includes checks
226
+     * for most error sources, like the source file not being
227
+     * readable. Automatically creates the target folder if it
228
+     * does not exist yet.
229
+     * 
230
+     * @param string $sourcePath
231
+     * @param string $targetPath
232
+     * @throws FileHelper_Exception
233
+     * 
234
+     * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
235
+     * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND
236
+     * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE
237
+     * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE
238
+     * @see FileHelper::ERROR_CANNOT_COPY_FILE
239
+     */
240 240
     public static function copyFile($sourcePath, $targetPath)
241 241
     {
242 242
         self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND);
@@ -287,15 +287,15 @@  discard block
 block discarded – undo
287 287
         );
288 288
     }
289 289
     
290
-   /**
291
-    * Deletes the target file. Ignored if it cannot be found,
292
-    * and throws an exception if it fails.
293
-    * 
294
-    * @param string $filePath
295
-    * @throws FileHelper_Exception
296
-    * 
297
-    * @see FileHelper::ERROR_CANNOT_DELETE_FILE
298
-    */
290
+    /**
291
+     * Deletes the target file. Ignored if it cannot be found,
292
+     * and throws an exception if it fails.
293
+     * 
294
+     * @param string $filePath
295
+     * @throws FileHelper_Exception
296
+     * 
297
+     * @see FileHelper::ERROR_CANNOT_DELETE_FILE
298
+     */
299 299
     public static function deleteFile(string $filePath) : void
300 300
     {
301 301
         if(!file_exists($filePath)) {
@@ -317,15 +317,15 @@  discard block
 block discarded – undo
317 317
     }
318 318
 
319 319
     /**
320
-    * Creates a new CSV parser instance and returns it.
321
-    * 
322
-    * @param string $delimiter
323
-    * @param string $enclosure
324
-    * @param string $escape
325
-    * @param bool $heading
326
-    * @return \parseCSV
327
-    * @todo Move this to the CSV helper.
328
-    */
320
+     * Creates a new CSV parser instance and returns it.
321
+     * 
322
+     * @param string $delimiter
323
+     * @param string $enclosure
324
+     * @param string $escape
325
+     * @param bool $heading
326
+     * @return \parseCSV
327
+     * @todo Move this to the CSV helper.
328
+     */
329 329
     public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : \parseCSV
330 330
     {
331 331
         if($delimiter==='') { $delimiter = ';'; }
@@ -340,23 +340,23 @@  discard block
 block discarded – undo
340 340
         return $parser;
341 341
     }
342 342
 
343
-   /**
344
-    * Parses all lines in the specified string and returns an
345
-    * indexed array with all csv values in each line.
346
-    *
347
-    * @param string $csv
348
-    * @param string $delimiter
349
-    * @param string $enclosure
350
-    * @param string $escape
351
-    * @param bool $heading
352
-    * @return array
353
-    * @throws FileHelper_Exception
354
-    * 
355
-    * @todo Move this to the CSVHelper.
356
-    *
357
-    * @see parseCSVFile()
358
-    * @see FileHelper::ERROR_PARSING_CSV
359
-    */
343
+    /**
344
+     * Parses all lines in the specified string and returns an
345
+     * indexed array with all csv values in each line.
346
+     *
347
+     * @param string $csv
348
+     * @param string $delimiter
349
+     * @param string $enclosure
350
+     * @param string $escape
351
+     * @param bool $heading
352
+     * @return array
353
+     * @throws FileHelper_Exception
354
+     * 
355
+     * @todo Move this to the CSVHelper.
356
+     *
357
+     * @see parseCSVFile()
358
+     * @see FileHelper::ERROR_PARSING_CSV
359
+     */
360 360
     public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array
361 361
     {
362 362
         $parser = self::createCSVParser($delimiter, $enclosure, $escape, $heading);
@@ -527,31 +527,31 @@  discard block
 block discarded – undo
527 527
         );
528 528
     }
529 529
     
530
-   /**
531
-    * Verifies whether the target file is a PHP file. The path
532
-    * to the file can be a path to a file as a string, or a 
533
-    * DirectoryIterator object instance.
534
-    * 
535
-    * @param string|\DirectoryIterator $pathOrDirIterator
536
-    * @return boolean
537
-    */
530
+    /**
531
+     * Verifies whether the target file is a PHP file. The path
532
+     * to the file can be a path to a file as a string, or a 
533
+     * DirectoryIterator object instance.
534
+     * 
535
+     * @param string|\DirectoryIterator $pathOrDirIterator
536
+     * @return boolean
537
+     */
538 538
     public static function isPHPFile($pathOrDirIterator)
539 539
     {
540
-    	if(self::getExtension($pathOrDirIterator) == 'php') {
541
-    		return true;
542
-    	}
540
+        if(self::getExtension($pathOrDirIterator) == 'php') {
541
+            return true;
542
+        }
543 543
     	
544
-    	return false;
544
+        return false;
545 545
     }
546 546
     
547
-   /**
548
-    * Retrieves the extension of the specified file. Can be a path
549
-    * to a file as a string, or a DirectoryIterator object instance.
550
-    * 
551
-    * @param string|\DirectoryIterator $pathOrDirIterator
552
-    * @param bool $lowercase
553
-    * @return string
554
-    */
547
+    /**
548
+     * Retrieves the extension of the specified file. Can be a path
549
+     * to a file as a string, or a DirectoryIterator object instance.
550
+     * 
551
+     * @param string|\DirectoryIterator $pathOrDirIterator
552
+     * @param bool $lowercase
553
+     * @return string
554
+     */
555 555
     public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string
556 556
     {
557 557
         if($pathOrDirIterator instanceof \DirectoryIterator) {
@@ -562,51 +562,51 @@  discard block
 block discarded – undo
562 562
          
563 563
         $ext = pathinfo($filename, PATHINFO_EXTENSION);
564 564
         if($lowercase) {
565
-        	$ext = mb_strtolower($ext);
565
+            $ext = mb_strtolower($ext);
566 566
         }
567 567
         
568 568
         return $ext;
569 569
     }
570 570
     
571
-   /**
572
-    * Retrieves the file name from a path, with or without extension.
573
-    * The path to the file can be a string, or a DirectoryIterator object
574
-    * instance.
575
-    * 
576
-    * In case of folders, behaves like the pathinfo function: returns
577
-    * the name of the folder.
578
-    * 
579
-    * @param string|\DirectoryIterator $pathOrDirIterator
580
-    * @param bool $extension
581
-    * @return string
582
-    */
571
+    /**
572
+     * Retrieves the file name from a path, with or without extension.
573
+     * The path to the file can be a string, or a DirectoryIterator object
574
+     * instance.
575
+     * 
576
+     * In case of folders, behaves like the pathinfo function: returns
577
+     * the name of the folder.
578
+     * 
579
+     * @param string|\DirectoryIterator $pathOrDirIterator
580
+     * @param bool $extension
581
+     * @return string
582
+     */
583 583
     public static function getFilename($pathOrDirIterator, $extension = true)
584 584
     {
585 585
         $path = $pathOrDirIterator;
586
-    	if($pathOrDirIterator instanceof \DirectoryIterator) {
587
-    		$path = $pathOrDirIterator->getFilename();
588
-    	}
586
+        if($pathOrDirIterator instanceof \DirectoryIterator) {
587
+            $path = $pathOrDirIterator->getFilename();
588
+        }
589 589
     	
590
-    	$path = self::normalizePath($path);
590
+        $path = self::normalizePath($path);
591 591
     	
592
-    	if(!$extension) {
593
-    	    return pathinfo($path, PATHINFO_FILENAME);
594
-    	}
592
+        if(!$extension) {
593
+            return pathinfo($path, PATHINFO_FILENAME);
594
+        }
595 595
     	
596
-    	return pathinfo($path, PATHINFO_BASENAME); 
596
+        return pathinfo($path, PATHINFO_BASENAME); 
597 597
     }
598 598
    
599
-   /**
600
-    * Tries to read the contents of the target file and
601
-    * treat it as JSON to return the decoded JSON data.
602
-    * 
603
-    * @param string $file
604
-    * @throws FileHelper_Exception
605
-    * @return array
606
-    * 
607
-    * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
608
-    * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
609
-    */ 
599
+    /**
600
+     * Tries to read the contents of the target file and
601
+     * treat it as JSON to return the decoded JSON data.
602
+     * 
603
+     * @param string $file
604
+     * @throws FileHelper_Exception
605
+     * @return array
606
+     * 
607
+     * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
608
+     * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
609
+     */ 
610 610
     public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null)
611 611
     {
612 612
         self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE);
@@ -642,16 +642,16 @@  discard block
 block discarded – undo
642 642
         return $json;
643 643
     }
644 644
     
645
-   /**
646
-    * Corrects common formatting mistakes when users enter
647
-    * file names, like too many spaces, dots and the like.
648
-    * 
649
-    * NOTE: if the file name contains a path, the path is
650
-    * stripped, leaving only the file name.
651
-    * 
652
-    * @param string $name
653
-    * @return string
654
-    */
645
+    /**
646
+     * Corrects common formatting mistakes when users enter
647
+     * file names, like too many spaces, dots and the like.
648
+     * 
649
+     * NOTE: if the file name contains a path, the path is
650
+     * stripped, leaving only the file name.
651
+     * 
652
+     * @param string $name
653
+     * @return string
654
+     */
655 655
     public static function fixFileName(string $name) : string
656 656
     {
657 657
         $name = trim($name);
@@ -681,68 +681,68 @@  discard block
 block discarded – undo
681 681
         return $name;
682 682
     }
683 683
     
684
-   /**
685
-    * Creates an instance of the file finder, which is an easier
686
-    * alternative to the other manual findFile methods, since all
687
-    * options can be set by chaining.
688
-    * 
689
-    * @param string $path
690
-    * @return FileHelper_FileFinder
691
-    */
684
+    /**
685
+     * Creates an instance of the file finder, which is an easier
686
+     * alternative to the other manual findFile methods, since all
687
+     * options can be set by chaining.
688
+     * 
689
+     * @param string $path
690
+     * @return FileHelper_FileFinder
691
+     */
692 692
     public static function createFileFinder(string $path) : FileHelper_FileFinder
693 693
     {
694 694
         return new FileHelper_FileFinder($path);
695 695
     }
696 696
     
697
-   /**
698
-    * Searches for all HTML files in the target folder.
699
-    * 
700
-    * NOTE: This method only exists for backwards compatibility.
701
-    * Use the `createFileFinder()` method instead, which offers
702
-    * an object oriented interface that is much easier to use.
703
-    * 
704
-    * @param string $targetFolder
705
-    * @param array $options
706
-    * @return array An indexed array with files.
707
-    * @see FileHelper::createFileFinder()
708
-    */
697
+    /**
698
+     * Searches for all HTML files in the target folder.
699
+     * 
700
+     * NOTE: This method only exists for backwards compatibility.
701
+     * Use the `createFileFinder()` method instead, which offers
702
+     * an object oriented interface that is much easier to use.
703
+     * 
704
+     * @param string $targetFolder
705
+     * @param array $options
706
+     * @return array An indexed array with files.
707
+     * @see FileHelper::createFileFinder()
708
+     */
709 709
     public static function findHTMLFiles(string $targetFolder, array $options=array()) : array
710 710
     {
711 711
         return self::findFiles($targetFolder, array('html'), $options);
712 712
     }
713 713
 
714
-   /**
715
-    * Searches for all PHP files in the target folder.
716
-    * 
717
-    * NOTE: This method only exists for backwards compatibility.
718
-    * Use the `createFileFinder()` method instead, which offers
719
-    * an object oriented interface that is much easier to use.
720
-    * 
721
-    * @param string $targetFolder
722
-    * @param array $options
723
-    * @return array An indexed array of PHP files.
724
-    * @see FileHelper::createFileFinder()
725
-    */
714
+    /**
715
+     * Searches for all PHP files in the target folder.
716
+     * 
717
+     * NOTE: This method only exists for backwards compatibility.
718
+     * Use the `createFileFinder()` method instead, which offers
719
+     * an object oriented interface that is much easier to use.
720
+     * 
721
+     * @param string $targetFolder
722
+     * @param array $options
723
+     * @return array An indexed array of PHP files.
724
+     * @see FileHelper::createFileFinder()
725
+     */
726 726
     public static function findPHPFiles(string $targetFolder, array $options=array()) : array
727 727
     {
728 728
         return self::findFiles($targetFolder, array('php'), $options);
729 729
     }
730 730
     
731
-   /**
732
-    * Finds files according to the specified options.
733
-    * 
734
-    * NOTE: This method only exists for backwards compatibility.
735
-    * Use the `createFileFinder()` method instead, which offers
736
-    * an object oriented interface that is much easier to use.
737
-    *  
738
-    * @param string $targetFolder
739
-    * @param array $extensions
740
-    * @param array $options
741
-    * @param array $files
742
-    * @throws FileHelper_Exception
743
-    * @return array
744
-    * @see FileHelper::createFileFinder()
745
-    */
731
+    /**
732
+     * Finds files according to the specified options.
733
+     * 
734
+     * NOTE: This method only exists for backwards compatibility.
735
+     * Use the `createFileFinder()` method instead, which offers
736
+     * an object oriented interface that is much easier to use.
737
+     *  
738
+     * @param string $targetFolder
739
+     * @param array $extensions
740
+     * @param array $options
741
+     * @param array $files
742
+     * @throws FileHelper_Exception
743
+     * @return array
744
+     * @see FileHelper::createFileFinder()
745
+     */
746 746
     public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array
747 747
     {
748 748
         $finder = self::createFileFinder($targetFolder);
@@ -768,13 +768,13 @@  discard block
 block discarded – undo
768 768
         return $finder->getAll();
769 769
     }
770 770
 
771
-   /**
772
-    * Removes the extension from the specified path or file name,
773
-    * if any, and returns the name without the extension.
774
-    * 
775
-    * @param string $filename
776
-    * @return sTring
777
-    */
771
+    /**
772
+     * Removes the extension from the specified path or file name,
773
+     * if any, and returns the name without the extension.
774
+     * 
775
+     * @param string $filename
776
+     * @return sTring
777
+     */
778 778
     public static function removeExtension(string $filename) : string
779 779
     {
780 780
         // normalize paths to allow windows style slashes even on nix servers
@@ -783,22 +783,22 @@  discard block
 block discarded – undo
783 783
         return pathinfo($filename, PATHINFO_FILENAME);
784 784
     }
785 785
     
786
-   /**
787
-    * Detects the UTF BOM in the target file, if any. Returns
788
-    * the encoding matching the BOM, which can be any of the
789
-    * following:
790
-    * 
791
-    * <ul>
792
-    * <li>UTF32-BE</li>
793
-    * <li>UTF32-LE</li>
794
-    * <li>UTF16-BE</li>
795
-    * <li>UTF16-LE</li>
796
-    * <li>UTF8</li>
797
-    * </ul>
798
-    * 
799
-    * @param string $filename
800
-    * @return string|NULL
801
-    */
786
+    /**
787
+     * Detects the UTF BOM in the target file, if any. Returns
788
+     * the encoding matching the BOM, which can be any of the
789
+     * following:
790
+     * 
791
+     * <ul>
792
+     * <li>UTF32-BE</li>
793
+     * <li>UTF32-LE</li>
794
+     * <li>UTF16-BE</li>
795
+     * <li>UTF16-LE</li>
796
+     * <li>UTF8</li>
797
+     * </ul>
798
+     * 
799
+     * @param string $filename
800
+     * @return string|NULL
801
+     */
802 802
     public static function detectUTFBom(string $filename) : ?string
803 803
     {
804 804
         $fp = fopen($filename, 'r');
@@ -830,13 +830,13 @@  discard block
 block discarded – undo
830 830
     
831 831
     protected static $utfBoms;
832 832
     
833
-   /**
834
-    * Retrieves a list of all UTF byte order mark character
835
-    * sequences, as an assocative array with UTF encoding => bom sequence
836
-    * pairs.
837
-    * 
838
-    * @return array
839
-    */
833
+    /**
834
+     * Retrieves a list of all UTF byte order mark character
835
+     * sequences, as an assocative array with UTF encoding => bom sequence
836
+     * pairs.
837
+     * 
838
+     * @return array
839
+     */
840 840
     public static function getUTFBOMs()
841 841
     {
842 842
         if(!isset(self::$utfBoms)) {
@@ -852,15 +852,15 @@  discard block
 block discarded – undo
852 852
         return self::$utfBoms;
853 853
     }
854 854
     
855
-   /**
856
-    * Checks whether the specified encoding is a valid
857
-    * unicode encoding, for example "UTF16-LE" or "UTF8".
858
-    * Also accounts for alternate way to write the, like
859
-    * "UTF-8", and omitting little/big endian suffixes.
860
-    * 
861
-    * @param string $encoding
862
-    * @return boolean
863
-    */
855
+    /**
856
+     * Checks whether the specified encoding is a valid
857
+     * unicode encoding, for example "UTF16-LE" or "UTF8".
858
+     * Also accounts for alternate way to write the, like
859
+     * "UTF-8", and omitting little/big endian suffixes.
860
+     * 
861
+     * @param string $encoding
862
+     * @return boolean
863
+     */
864 864
     public static function isValidUnicodeEncoding(string $encoding) : bool
865 865
     {
866 866
         $encodings = self::getKnownUnicodeEncodings();
@@ -879,40 +879,40 @@  discard block
 block discarded – undo
879 879
         return in_array($encoding, $keep);
880 880
     }
881 881
     
882
-   /**
883
-    * Retrieves a list of all known unicode file encodings.
884
-    * @return array
885
-    */
882
+    /**
883
+     * Retrieves a list of all known unicode file encodings.
884
+     * @return array
885
+     */
886 886
     public static function getKnownUnicodeEncodings()
887 887
     {
888 888
         return array_keys(self::getUTFBOMs());
889 889
     }
890 890
     
891
-   /**
892
-    * Normalizes the slash style in a file or folder path,
893
-    * by replacing any antislashes with forward slashes.
894
-    * 
895
-    * @param string $path
896
-    * @return string
897
-    */
891
+    /**
892
+     * Normalizes the slash style in a file or folder path,
893
+     * by replacing any antislashes with forward slashes.
894
+     * 
895
+     * @param string $path
896
+     * @return string
897
+     */
898 898
     public static function normalizePath(string $path) : string
899 899
     {
900 900
         return str_replace(array('\\', '//'), array('/', '/'), $path);
901 901
     }
902 902
     
903
-   /**
904
-    * Saves the specified data to a file, JSON encoded.
905
-    * 
906
-    * @param mixed $data
907
-    * @param string $file
908
-    * @param bool $pretty
909
-    * @throws FileHelper_Exception
910
-    * 
911
-    * @see FileHelper::ERROR_JSON_ENCODE_ERROR
912
-    * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
913
-    * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
914
-    * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
915
-    */
903
+    /**
904
+     * Saves the specified data to a file, JSON encoded.
905
+     * 
906
+     * @param mixed $data
907
+     * @param string $file
908
+     * @param bool $pretty
909
+     * @throws FileHelper_Exception
910
+     * 
911
+     * @see FileHelper::ERROR_JSON_ENCODE_ERROR
912
+     * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
913
+     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
914
+     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
915
+     */
916 916
     public static function saveAsJSON($data, string $file, bool $pretty=false)
917 917
     {
918 918
         $options = null;
@@ -936,18 +936,18 @@  discard block
 block discarded – undo
936 936
         self::saveFile($file, $json);
937 937
     }
938 938
    
939
-   /**
940
-    * Saves the specified content to the target file, creating
941
-    * the file and the folder as necessary.
942
-    * 
943
-    * @param string $filePath
944
-    * @param string $content
945
-    * @throws FileHelper_Exception
946
-    * 
947
-    * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
948
-    * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
949
-    * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
950
-    */
939
+    /**
940
+     * Saves the specified content to the target file, creating
941
+     * the file and the folder as necessary.
942
+     * 
943
+     * @param string $filePath
944
+     * @param string $content
945
+     * @throws FileHelper_Exception
946
+     * 
947
+     * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
948
+     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
949
+     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
950
+     */
951 951
     public static function saveFile(string $filePath, string $content='') : void
952 952
     {
953 953
         // target file already exists
@@ -1000,12 +1000,12 @@  discard block
 block discarded – undo
1000 1000
         );
1001 1001
     }
1002 1002
     
1003
-   /**
1004
-    * Checks whether it is possible to run PHP command 
1005
-    * line commands.
1006
-    * 
1007
-    * @return boolean
1008
-    */
1003
+    /**
1004
+     * Checks whether it is possible to run PHP command 
1005
+     * line commands.
1006
+     * 
1007
+     * @return boolean
1008
+     */
1009 1009
     public static function canMakePHPCalls() : bool
1010 1010
     {
1011 1011
         return self::cliCommandExists('php');
@@ -1082,16 +1082,16 @@  discard block
 block discarded – undo
1082 1082
         return $result;
1083 1083
     }
1084 1084
     
1085
-   /**
1086
-    * Validates a PHP file's syntax.
1087
-    * 
1088
-    * NOTE: This will fail silently if the PHP command line
1089
-    * is not available. Use {@link FileHelper::canMakePHPCalls()}
1090
-    * to check this beforehand as needed.
1091
-    * 
1092
-    * @param string $path
1093
-    * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise.
1094
-    */
1085
+    /**
1086
+     * Validates a PHP file's syntax.
1087
+     * 
1088
+     * NOTE: This will fail silently if the PHP command line
1089
+     * is not available. Use {@link FileHelper::canMakePHPCalls()}
1090
+     * to check this beforehand as needed.
1091
+     * 
1092
+     * @param string $path
1093
+     * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise.
1094
+     */
1095 1095
     public static function checkPHPFileSyntax($path)
1096 1096
     {
1097 1097
         if(!self::canMakePHPCalls()) {
@@ -1115,14 +1115,14 @@  discard block
 block discarded – undo
1115 1115
         return $output;
1116 1116
     }
1117 1117
     
1118
-   /**
1119
-    * Retrieves the last modified date for the specified file or folder.
1120
-    * 
1121
-    * Note: If the target does not exist, returns null. 
1122
-    * 
1123
-    * @param string $path
1124
-    * @return \DateTime|NULL
1125
-    */
1118
+    /**
1119
+     * Retrieves the last modified date for the specified file or folder.
1120
+     * 
1121
+     * Note: If the target does not exist, returns null. 
1122
+     * 
1123
+     * @param string $path
1124
+     * @return \DateTime|NULL
1125
+     */
1126 1126
     public static function getModifiedDate($path)
1127 1127
     {
1128 1128
         $time = filemtime($path);
@@ -1135,24 +1135,24 @@  discard block
 block discarded – undo
1135 1135
         return null; 
1136 1136
     }
1137 1137
     
1138
-   /**
1139
-    * Retrieves the names of all subfolders in the specified path.
1140
-    * 
1141
-    * Available options:
1142
-    * 
1143
-    * - recursive: true/false
1144
-    *   Whether to search for subfolders recursively. 
1145
-    *   
1146
-    * - absolute-paths: true/false
1147
-    *   Whether to return a list of absolute paths.
1148
-    * 
1149
-    * @param string $targetFolder
1150
-    * @param array $options
1151
-    * @throws FileHelper_Exception
1152
-    * @return string[]
1153
-    * 
1154
-    * @todo Move this to a separate class.
1155
-    */
1138
+    /**
1139
+     * Retrieves the names of all subfolders in the specified path.
1140
+     * 
1141
+     * Available options:
1142
+     * 
1143
+     * - recursive: true/false
1144
+     *   Whether to search for subfolders recursively. 
1145
+     *   
1146
+     * - absolute-paths: true/false
1147
+     *   Whether to return a list of absolute paths.
1148
+     * 
1149
+     * @param string $targetFolder
1150
+     * @param array $options
1151
+     * @throws FileHelper_Exception
1152
+     * @return string[]
1153
+     * 
1154
+     * @todo Move this to a separate class.
1155
+     */
1156 1156
     public static function getSubfolders($targetFolder, $options = array())
1157 1157
     {
1158 1158
         if(!is_dir($targetFolder)) 
@@ -1213,16 +1213,16 @@  discard block
 block discarded – undo
1213 1213
         return $result;
1214 1214
     }
1215 1215
 
1216
-   /**
1217
-    * Retrieves the maximum allowed upload file size, in bytes.
1218
-    * Takes into account the PHP ini settings <code>post_max_size</code>
1219
-    * and <code>upload_max_filesize</code>. Since these cannot
1220
-    * be modified at runtime, they are the hard limits for uploads.
1221
-    * 
1222
-    * NOTE: Based on binary values, where 1KB = 1024 Bytes.
1223
-    * 
1224
-    * @return int Will return <code>-1</code> if no limit.
1225
-    */
1216
+    /**
1217
+     * Retrieves the maximum allowed upload file size, in bytes.
1218
+     * Takes into account the PHP ini settings <code>post_max_size</code>
1219
+     * and <code>upload_max_filesize</code>. Since these cannot
1220
+     * be modified at runtime, they are the hard limits for uploads.
1221
+     * 
1222
+     * NOTE: Based on binary values, where 1KB = 1024 Bytes.
1223
+     * 
1224
+     * @return int Will return <code>-1</code> if no limit.
1225
+     */
1226 1226
     public static function getMaxUploadFilesize() : int
1227 1227
     {
1228 1228
         static $max_size = -1;
@@ -1259,16 +1259,16 @@  discard block
 block discarded – undo
1259 1259
         return round($size);
1260 1260
     }
1261 1261
    
1262
-   /**
1263
-    * Makes a path relative using a folder depth: will reduce the
1264
-    * length of the path so that only the amount of folders defined
1265
-    * in the <code>$depth</code> attribute are shown below the actual
1266
-    * folder or file in the path.
1267
-    *  
1268
-    * @param string  $path The absolute or relative path
1269
-    * @param int $depth The folder depth to reduce the path to
1270
-    * @return string
1271
-    */
1262
+    /**
1263
+     * Makes a path relative using a folder depth: will reduce the
1264
+     * length of the path so that only the amount of folders defined
1265
+     * in the <code>$depth</code> attribute are shown below the actual
1266
+     * folder or file in the path.
1267
+     *  
1268
+     * @param string  $path The absolute or relative path
1269
+     * @param int $depth The folder depth to reduce the path to
1270
+     * @return string
1271
+     */
1272 1272
     public static function relativizePathByDepth(string $path, int $depth=2) : string
1273 1273
     {
1274 1274
         $path = self::normalizePath($path);
@@ -1306,23 +1306,23 @@  discard block
 block discarded – undo
1306 1306
         return trim(implode('/', $tokens), '/');
1307 1307
     }
1308 1308
     
1309
-   /**
1310
-    * Makes the specified path relative to another path,
1311
-    * by removing one from the other if found. Also 
1312
-    * normalizes the path to use forward slashes. 
1313
-    * 
1314
-    * Example:
1315
-    * 
1316
-    * <pre>
1317
-    * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder');
1318
-    * </pre>
1319
-    * 
1320
-    * Result: <code>to/file.txt</code>
1321
-    * 
1322
-    * @param string $path
1323
-    * @param string $relativeTo
1324
-    * @return string
1325
-    */
1309
+    /**
1310
+     * Makes the specified path relative to another path,
1311
+     * by removing one from the other if found. Also 
1312
+     * normalizes the path to use forward slashes. 
1313
+     * 
1314
+     * Example:
1315
+     * 
1316
+     * <pre>
1317
+     * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder');
1318
+     * </pre>
1319
+     * 
1320
+     * Result: <code>to/file.txt</code>
1321
+     * 
1322
+     * @param string $path
1323
+     * @param string $relativeTo
1324
+     * @return string
1325
+     */
1326 1326
     public static function relativizePath(string $path, string $relativeTo) : string
1327 1327
     {
1328 1328
         $path = self::normalizePath($path);
@@ -1334,17 +1334,17 @@  discard block
 block discarded – undo
1334 1334
         return $relative;
1335 1335
     }
1336 1336
     
1337
-   /**
1338
-    * Checks that the target file exists, and throws an exception
1339
-    * if it does not. 
1340
-    * 
1341
-    * @param string $path
1342
-    * @param int|NULL $errorCode Optional custom error code
1343
-    * @throws FileHelper_Exception
1344
-    * @return string The real path to the file
1345
-    * 
1346
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1347
-    */
1337
+    /**
1338
+     * Checks that the target file exists, and throws an exception
1339
+     * if it does not. 
1340
+     * 
1341
+     * @param string $path
1342
+     * @param int|NULL $errorCode Optional custom error code
1343
+     * @throws FileHelper_Exception
1344
+     * @return string The real path to the file
1345
+     * 
1346
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1347
+     */
1348 1348
     public static function requireFileExists(string $path, $errorCode=null) : string
1349 1349
     {
1350 1350
         $result = realpath($path);
@@ -1363,18 +1363,18 @@  discard block
 block discarded – undo
1363 1363
         );
1364 1364
     }
1365 1365
     
1366
-   /**
1367
-    * Reads a specific line number from the target file and returns its
1368
-    * contents, if the file has such a line. Does so with little memory
1369
-    * usage, as the file is not read entirely into memory.
1370
-    * 
1371
-    * @param string $path
1372
-    * @param int $lineNumber Note: 1-based; the first line is number 1.
1373
-    * @return string|NULL Will return null if the requested line does not exist.
1374
-    * @throws FileHelper_Exception
1375
-    * 
1376
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1377
-    */
1366
+    /**
1367
+     * Reads a specific line number from the target file and returns its
1368
+     * contents, if the file has such a line. Does so with little memory
1369
+     * usage, as the file is not read entirely into memory.
1370
+     * 
1371
+     * @param string $path
1372
+     * @param int $lineNumber Note: 1-based; the first line is number 1.
1373
+     * @return string|NULL Will return null if the requested line does not exist.
1374
+     * @throws FileHelper_Exception
1375
+     * 
1376
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1377
+     */
1378 1378
     public static function getLineFromFile(string $path, int $lineNumber) : ?string
1379 1379
     {
1380 1380
         self::requireFileExists($path);
@@ -1390,19 +1390,19 @@  discard block
 block discarded – undo
1390 1390
         $file->seek($targetLine);
1391 1391
         
1392 1392
         if($file->key() !== $targetLine) {
1393
-             return null;
1393
+                return null;
1394 1394
         }
1395 1395
         
1396 1396
         return $file->current(); 
1397 1397
     }
1398 1398
     
1399
-   /**
1400
-    * Retrieves the total amount of lines in the file, without 
1401
-    * reading the whole file into memory.
1402
-    * 
1403
-    * @param string $path
1404
-    * @return int
1405
-    */
1399
+    /**
1400
+     * Retrieves the total amount of lines in the file, without 
1401
+     * reading the whole file into memory.
1402
+     * 
1403
+     * @param string $path
1404
+     * @return int
1405
+     */
1406 1406
     public static function countFileLines(string $path) : int
1407 1407
     {
1408 1408
         self::requireFileExists($path);
@@ -1432,26 +1432,26 @@  discard block
 block discarded – undo
1432 1432
         return $number+1;
1433 1433
     }
1434 1434
     
1435
-   /**
1436
-    * Parses the target file to detect any PHP classes contained
1437
-    * within, and retrieve information on them. Does not use the 
1438
-    * PHP reflection API.
1439
-    * 
1440
-    * @param string $filePath
1441
-    * @return FileHelper_PHPClassInfo
1442
-    */
1435
+    /**
1436
+     * Parses the target file to detect any PHP classes contained
1437
+     * within, and retrieve information on them. Does not use the 
1438
+     * PHP reflection API.
1439
+     * 
1440
+     * @param string $filePath
1441
+     * @return FileHelper_PHPClassInfo
1442
+     */
1443 1443
     public static function findPHPClasses(string $filePath) : FileHelper_PHPClassInfo
1444 1444
     {
1445 1445
         return new FileHelper_PHPClassInfo($filePath);
1446 1446
     }
1447 1447
     
1448
-   /**
1449
-    * Detects the end of line style used in the target file, if any.
1450
-    * Can be used with large files, because it only reads part of it.
1451
-    * 
1452
-    * @param string $filePath The path to the file.
1453
-    * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found.
1454
-    */
1448
+    /**
1449
+     * Detects the end of line style used in the target file, if any.
1450
+     * Can be used with large files, because it only reads part of it.
1451
+     * 
1452
+     * @param string $filePath The path to the file.
1453
+     * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found.
1454
+     */
1455 1455
     public static function detectEOLCharacter(string $filePath) : ?ConvertHelper_EOL
1456 1456
     {
1457 1457
         // 20 lines is enough to get a good picture of the newline style in the file.
@@ -1464,18 +1464,18 @@  discard block
 block discarded – undo
1464 1464
         return ConvertHelper::detectEOLCharacter($string);
1465 1465
     }
1466 1466
     
1467
-   /**
1468
-    * Reads the specified amount of lines from the target file.
1469
-    * Unicode BOM compatible: any byte order marker is stripped
1470
-    * from the resulting lines.
1471
-    * 
1472
-    * @param string $filePath
1473
-    * @param int $amount Set to 0 to read all lines.
1474
-    * @return array
1475
-    * 
1476
-    * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
1477
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1478
-    */
1467
+    /**
1468
+     * Reads the specified amount of lines from the target file.
1469
+     * Unicode BOM compatible: any byte order marker is stripped
1470
+     * from the resulting lines.
1471
+     * 
1472
+     * @param string $filePath
1473
+     * @param int $amount Set to 0 to read all lines.
1474
+     * @return array
1475
+     * 
1476
+     * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
1477
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1478
+     */
1479 1479
     public static function readLines(string $filePath, int $amount=0) : array
1480 1480
     {
1481 1481
         self::requireFileExists($filePath);
@@ -1526,16 +1526,16 @@  discard block
 block discarded – undo
1526 1526
         return $result;
1527 1527
     }
1528 1528
     
1529
-   /**
1530
-    * Reads all content from a file.
1531
-    * 
1532
-    * @param string $filePath
1533
-    * @throws FileHelper_Exception
1534
-    * @return string
1535
-    * 
1536
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1537
-    * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
1538
-    */
1529
+    /**
1530
+     * Reads all content from a file.
1531
+     * 
1532
+     * @param string $filePath
1533
+     * @throws FileHelper_Exception
1534
+     * @return string
1535
+     * 
1536
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1537
+     * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
1538
+     */
1539 1539
     public static function readContents(string $filePath) : string
1540 1540
     {
1541 1541
         self::requireFileExists($filePath);
Please login to merge, or discard this patch.
Spacing   +97 added lines, -97 removed lines patch added patch discarded remove patch
@@ -106,7 +106,7 @@  discard block
 block discarded – undo
106 106
         
107 107
         $contents = file_get_contents($file);
108 108
         
109
-        if($contents === false) 
109
+        if ($contents === false) 
110 110
         {
111 111
             throw new FileHelper_Exception(
112 112
                 'Cannot load serialized content from file.',
@@ -120,7 +120,7 @@  discard block
 block discarded – undo
120 120
         
121 121
         $result = @unserialize($contents);
122 122
         
123
-        if($result !== false) {
123
+        if ($result !== false) {
124 124
             return $result;
125 125
         }
126 126
         
@@ -136,7 +136,7 @@  discard block
 block discarded – undo
136 136
     
137 137
     public static function deleteTree($rootFolder)
138 138
     {
139
-        if(!file_exists($rootFolder)) {
139
+        if (!file_exists($rootFolder)) {
140 140
             return true;
141 141
         }
142 142
         
@@ -177,7 +177,7 @@  discard block
 block discarded – undo
177 177
     */
178 178
     public static function createFolder($path)
179 179
     {
180
-        if(is_dir($path) || mkdir($path, 0777, true)) {
180
+        if (is_dir($path) || mkdir($path, 0777, true)) {
181 181
             return;
182 182
         }
183 183
         
@@ -212,11 +212,11 @@  discard block
 block discarded – undo
212 212
 
213 213
             if ($item->isDir()) 
214 214
             {
215
-                FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target . '/' . $baseName);
215
+                FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target.'/'.$baseName);
216 216
             } 
217
-            else if($item->isFile()) 
217
+            else if ($item->isFile()) 
218 218
             {
219
-                self::copyFile($itemPath, $target . '/' . $baseName);
219
+                self::copyFile($itemPath, $target.'/'.$baseName);
220 220
             }
221 221
         }
222 222
     }
@@ -241,7 +241,7 @@  discard block
 block discarded – undo
241 241
     {
242 242
         self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND);
243 243
         
244
-        if(!is_readable($sourcePath))
244
+        if (!is_readable($sourcePath))
245 245
         {
246 246
             throw new FileHelper_Exception(
247 247
                 sprintf('Source file [%s] to copy is not readable.', basename($sourcePath)),
@@ -255,11 +255,11 @@  discard block
 block discarded – undo
255 255
         
256 256
         $targetFolder = dirname($targetPath);
257 257
         
258
-        if(!file_exists($targetFolder))
258
+        if (!file_exists($targetFolder))
259 259
         {
260 260
             self::createFolder($targetFolder);
261 261
         }
262
-        else if(!is_writable($targetFolder)) 
262
+        else if (!is_writable($targetFolder)) 
263 263
         {
264 264
             throw new FileHelper_Exception(
265 265
                 sprintf('Target folder [%s] is not writable.', basename($targetFolder)),
@@ -271,7 +271,7 @@  discard block
 block discarded – undo
271 271
             );
272 272
         }
273 273
         
274
-        if(copy($sourcePath, $targetPath)) {
274
+        if (copy($sourcePath, $targetPath)) {
275 275
             return;
276 276
         }
277 277
         
@@ -298,11 +298,11 @@  discard block
 block discarded – undo
298 298
     */
299 299
     public static function deleteFile(string $filePath) : void
300 300
     {
301
-        if(!file_exists($filePath)) {
301
+        if (!file_exists($filePath)) {
302 302
             return;
303 303
         }
304 304
         
305
-        if(unlink($filePath)) {
305
+        if (unlink($filePath)) {
306 306
             return;
307 307
         }
308 308
         
@@ -326,10 +326,10 @@  discard block
 block discarded – undo
326 326
     * @return \parseCSV
327 327
     * @todo Move this to the CSV helper.
328 328
     */
329
-    public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : \parseCSV
329
+    public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : \parseCSV
330 330
     {
331
-        if($delimiter==='') { $delimiter = ';'; }
332
-        if($enclosure==='') { $enclosure = '"'; }
331
+        if ($delimiter === '') { $delimiter = ';'; }
332
+        if ($enclosure === '') { $enclosure = '"'; }
333 333
         
334 334
         $parser = new \parseCSV(null, null, null, array());
335 335
 
@@ -357,11 +357,11 @@  discard block
 block discarded – undo
357 357
     * @see parseCSVFile()
358 358
     * @see FileHelper::ERROR_PARSING_CSV
359 359
     */
360
-    public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array
360
+    public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array
361 361
     {
362 362
         $parser = self::createCSVParser($delimiter, $enclosure, $escape, $heading);
363 363
         $result = $parser->parse_string(/** @scrutinizer ignore-type */ $csv);
364
-        if(is_array($result)) {
364
+        if (is_array($result)) {
365 365
             return $result;
366 366
         }
367 367
         
@@ -389,7 +389,7 @@  discard block
 block discarded – undo
389 389
      * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
390 390
      * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
391 391
      */
392
-    public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array
392
+    public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array
393 393
     {
394 394
         $content = self::readContents($filePath);
395 395
 
@@ -406,7 +406,7 @@  discard block
 block discarded – undo
406 406
     public static function detectMimeType(string $fileName) : ?string
407 407
     {
408 408
         $ext = self::getExtension($fileName);
409
-        if(empty($ext)) {
409
+        if (empty($ext)) {
410 410
             return null;
411 411
         }
412 412
 
@@ -427,11 +427,11 @@  discard block
 block discarded – undo
427 427
      * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
428 428
      * @see FileHelper::ERROR_UNKNOWN_FILE_MIME_TYPE
429 429
      */
430
-    public static function sendFile(string $filePath, $fileName = null, bool $asAttachment=true)
430
+    public static function sendFile(string $filePath, $fileName = null, bool $asAttachment = true)
431 431
     {
432 432
         self::requireFileExists($filePath);
433 433
         
434
-        if(empty($fileName)) {
434
+        if (empty($fileName)) {
435 435
             $fileName = basename($filePath);
436 436
         }
437 437
 
@@ -449,10 +449,10 @@  discard block
 block discarded – undo
449 449
         
450 450
         header("Cache-Control: public", true);
451 451
         header("Content-Description: File Transfer", true);
452
-        header("Content-Type: " . $mime, true);
452
+        header("Content-Type: ".$mime, true);
453 453
 
454 454
         $disposition = 'inline';
455
-        if($asAttachment) {
455
+        if ($asAttachment) {
456 456
             $disposition = 'attachment';
457 457
         }
458 458
         
@@ -480,7 +480,7 @@  discard block
 block discarded – undo
480 480
         requireCURL();
481 481
         
482 482
         $ch = curl_init();
483
-        if($ch === false) 
483
+        if ($ch === false) 
484 484
         {
485 485
             throw new FileHelper_Exception(
486 486
                 'Could not initialize a new cURL instance.',
@@ -501,7 +501,7 @@  discard block
 block discarded – undo
501 501
         
502 502
         $output = curl_exec($ch);
503 503
 
504
-        if($output === false) {
504
+        if ($output === false) {
505 505
             throw new FileHelper_Exception(
506 506
                 'Unable to open URL',
507 507
                 sprintf(
@@ -515,7 +515,7 @@  discard block
 block discarded – undo
515 515
 
516 516
         curl_close($ch);
517 517
 
518
-        if(is_string($output)) 
518
+        if (is_string($output)) 
519 519
         {
520 520
             return $output;
521 521
         }
@@ -537,7 +537,7 @@  discard block
 block discarded – undo
537 537
     */
538 538
     public static function isPHPFile($pathOrDirIterator)
539 539
     {
540
-    	if(self::getExtension($pathOrDirIterator) == 'php') {
540
+    	if (self::getExtension($pathOrDirIterator) == 'php') {
541 541
     		return true;
542 542
     	}
543 543
     	
@@ -554,14 +554,14 @@  discard block
 block discarded – undo
554 554
     */
555 555
     public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string
556 556
     {
557
-        if($pathOrDirIterator instanceof \DirectoryIterator) {
557
+        if ($pathOrDirIterator instanceof \DirectoryIterator) {
558 558
             $filename = $pathOrDirIterator->getFilename();
559 559
         } else {
560 560
             $filename = basename($pathOrDirIterator);
561 561
         }
562 562
          
563 563
         $ext = pathinfo($filename, PATHINFO_EXTENSION);
564
-        if($lowercase) {
564
+        if ($lowercase) {
565 565
         	$ext = mb_strtolower($ext);
566 566
         }
567 567
         
@@ -583,13 +583,13 @@  discard block
 block discarded – undo
583 583
     public static function getFilename($pathOrDirIterator, $extension = true)
584 584
     {
585 585
         $path = $pathOrDirIterator;
586
-    	if($pathOrDirIterator instanceof \DirectoryIterator) {
586
+    	if ($pathOrDirIterator instanceof \DirectoryIterator) {
587 587
     		$path = $pathOrDirIterator->getFilename();
588 588
     	}
589 589
     	
590 590
     	$path = self::normalizePath($path);
591 591
     	
592
-    	if(!$extension) {
592
+    	if (!$extension) {
593 593
     	    return pathinfo($path, PATHINFO_FILENAME);
594 594
     	}
595 595
     	
@@ -607,12 +607,12 @@  discard block
 block discarded – undo
607 607
     * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE
608 608
     * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE
609 609
     */ 
610
-    public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null)
610
+    public static function parseJSONFile(string $file, $targetEncoding = null, $sourceEncoding = null)
611 611
     {
612 612
         self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE);
613 613
         
614 614
         $content = file_get_contents($file);
615
-        if(!$content) {
615
+        if (!$content) {
616 616
             throw new FileHelper_Exception(
617 617
                 'Cannot get file contents',
618 618
                 sprintf(
@@ -623,12 +623,12 @@  discard block
 block discarded – undo
623 623
             );
624 624
         }
625 625
         
626
-        if(isset($targetEncoding)) {
626
+        if (isset($targetEncoding)) {
627 627
             $content = mb_convert_encoding($content, $targetEncoding, $sourceEncoding);
628 628
         }
629 629
         
630 630
         $json = json_decode($content, true);
631
-        if($json === false || $json === NULL) {
631
+        if ($json === false || $json === NULL) {
632 632
             throw new FileHelper_Exception(
633 633
                 'Cannot decode json data',
634 634
                 sprintf(
@@ -668,13 +668,13 @@  discard block
 block discarded – undo
668 668
         
669 669
         $name = str_replace(array_keys($replaces), array_values($replaces), $name);
670 670
         
671
-        while(strstr($name, '  ')) {
671
+        while (strstr($name, '  ')) {
672 672
             $name = str_replace('  ', ' ', $name);
673 673
         }
674 674
 
675 675
         $name = str_replace(array_keys($replaces), array_values($replaces), $name);
676 676
         
677
-        while(strstr($name, '..')) {
677
+        while (strstr($name, '..')) {
678 678
             $name = str_replace('..', '.', $name);
679 679
         }
680 680
         
@@ -706,7 +706,7 @@  discard block
 block discarded – undo
706 706
     * @return array An indexed array with files.
707 707
     * @see FileHelper::createFileFinder()
708 708
     */
709
-    public static function findHTMLFiles(string $targetFolder, array $options=array()) : array
709
+    public static function findHTMLFiles(string $targetFolder, array $options = array()) : array
710 710
     {
711 711
         return self::findFiles($targetFolder, array('html'), $options);
712 712
     }
@@ -723,7 +723,7 @@  discard block
 block discarded – undo
723 723
     * @return array An indexed array of PHP files.
724 724
     * @see FileHelper::createFileFinder()
725 725
     */
726
-    public static function findPHPFiles(string $targetFolder, array $options=array()) : array
726
+    public static function findPHPFiles(string $targetFolder, array $options = array()) : array
727 727
     {
728 728
         return self::findFiles($targetFolder, array('php'), $options);
729 729
     }
@@ -743,22 +743,22 @@  discard block
 block discarded – undo
743 743
     * @return array
744 744
     * @see FileHelper::createFileFinder()
745 745
     */
746
-    public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array
746
+    public static function findFiles(string $targetFolder, array $extensions = array(), array $options = array(), array $files = array()) : array
747 747
     {
748 748
         $finder = self::createFileFinder($targetFolder);
749 749
 
750 750
         $finder->setPathmodeStrip();
751 751
         
752
-        if(isset($options['relative-path']) && $options['relative-path'] === true) 
752
+        if (isset($options['relative-path']) && $options['relative-path'] === true) 
753 753
         {
754 754
             $finder->setPathmodeRelative();
755 755
         } 
756
-        else if(isset($options['absolute-path']) && $options['absolute-path'] === true)
756
+        else if (isset($options['absolute-path']) && $options['absolute-path'] === true)
757 757
         {
758 758
             $finder->setPathmodeAbsolute();
759 759
         }
760 760
         
761
-        if(isset($options['strip-extension'])) 
761
+        if (isset($options['strip-extension'])) 
762 762
         {
763 763
             $finder->stripExtensions();
764 764
         }
@@ -802,7 +802,7 @@  discard block
 block discarded – undo
802 802
     public static function detectUTFBom(string $filename) : ?string
803 803
     {
804 804
         $fp = fopen($filename, 'r');
805
-        if($fp === false) 
805
+        if ($fp === false) 
806 806
         {
807 807
             throw new FileHelper_Exception(
808 808
                 'Cannot open file for reading',
@@ -817,10 +817,10 @@  discard block
 block discarded – undo
817 817
 
818 818
         $boms = self::getUTFBOMs();
819 819
         
820
-        foreach($boms as $bom => $value) 
820
+        foreach ($boms as $bom => $value) 
821 821
         {
822 822
             $length = mb_strlen($value);
823
-            if(mb_substr($text, 0, $length) == $value) {
823
+            if (mb_substr($text, 0, $length) == $value) {
824 824
                 return $bom;
825 825
             }
826 826
         }
@@ -839,13 +839,13 @@  discard block
 block discarded – undo
839 839
     */
840 840
     public static function getUTFBOMs()
841 841
     {
842
-        if(!isset(self::$utfBoms)) {
842
+        if (!isset(self::$utfBoms)) {
843 843
             self::$utfBoms = array(
844
-                'UTF32-BE' => chr(0x00) . chr(0x00) . chr(0xFE) . chr(0xFF),
845
-                'UTF32-LE' => chr(0xFF) . chr(0xFE) . chr(0x00) . chr(0x00),
846
-                'UTF16-BE' => chr(0xFE) . chr(0xFF),
847
-                'UTF16-LE' => chr(0xFF) . chr(0xFE),
848
-                'UTF8' => chr(0xEF) . chr(0xBB) . chr(0xBF)
844
+                'UTF32-BE' => chr(0x00).chr(0x00).chr(0xFE).chr(0xFF),
845
+                'UTF32-LE' => chr(0xFF).chr(0xFE).chr(0x00).chr(0x00),
846
+                'UTF16-BE' => chr(0xFE).chr(0xFF),
847
+                'UTF16-LE' => chr(0xFF).chr(0xFE),
848
+                'UTF8' => chr(0xEF).chr(0xBB).chr(0xBF)
849 849
             );
850 850
         }
851 851
         
@@ -866,7 +866,7 @@  discard block
 block discarded – undo
866 866
         $encodings = self::getKnownUnicodeEncodings();
867 867
 
868 868
         $keep = array();
869
-        foreach($encodings as $string) 
869
+        foreach ($encodings as $string) 
870 870
         {
871 871
             $withHyphen = str_replace('UTF', 'UTF-', $string);
872 872
             
@@ -913,16 +913,16 @@  discard block
 block discarded – undo
913 913
     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
914 914
     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
915 915
     */
916
-    public static function saveAsJSON($data, string $file, bool $pretty=false)
916
+    public static function saveAsJSON($data, string $file, bool $pretty = false)
917 917
     {
918 918
         $options = null;
919
-        if($pretty) {
919
+        if ($pretty) {
920 920
             $options = JSON_PRETTY_PRINT;
921 921
         }
922 922
         
923 923
         $json = json_encode($data, $options);
924 924
         
925
-        if($json===false) 
925
+        if ($json === false) 
926 926
         {
927 927
             $errorCode = json_last_error();
928 928
             
@@ -948,12 +948,12 @@  discard block
 block discarded – undo
948 948
     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
949 949
     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
950 950
     */
951
-    public static function saveFile(string $filePath, string $content='') : void
951
+    public static function saveFile(string $filePath, string $content = '') : void
952 952
     {
953 953
         // target file already exists
954
-        if(file_exists($filePath))
954
+        if (file_exists($filePath))
955 955
         {
956
-            if(!is_writable($filePath))
956
+            if (!is_writable($filePath))
957 957
             {
958 958
                 throw new FileHelper_Exception(
959 959
                     sprintf('Cannot save file: target file [%s] exists, but is not writable.', basename($filePath)),
@@ -973,7 +973,7 @@  discard block
 block discarded – undo
973 973
             // create the folder as needed
974 974
             self::createFolder($targetFolder);
975 975
             
976
-            if(!is_writable($targetFolder)) 
976
+            if (!is_writable($targetFolder)) 
977 977
             {
978 978
                 throw new FileHelper_Exception(
979 979
                     sprintf('Cannot save file: target folder [%s] is not writable.', basename($targetFolder)),
@@ -986,7 +986,7 @@  discard block
 block discarded – undo
986 986
             }
987 987
         }
988 988
         
989
-        if(file_put_contents($filePath, $content) !== false) {
989
+        if (file_put_contents($filePath, $content) !== false) {
990 990
             return;
991 991
         }
992 992
         
@@ -1024,7 +1024,7 @@  discard block
 block discarded – undo
1024 1024
     {
1025 1025
         static $checked = array();
1026 1026
         
1027
-        if(isset($checked[$command])) {
1027
+        if (isset($checked[$command])) {
1028 1028
             return $checked[$command];
1029 1029
         }
1030 1030
         
@@ -1037,7 +1037,7 @@  discard block
 block discarded – undo
1037 1037
         
1038 1038
         $os = strtolower(PHP_OS_FAMILY);
1039 1039
         
1040
-        if(!isset($osCommands[$os])) 
1040
+        if (!isset($osCommands[$os])) 
1041 1041
         {
1042 1042
             throw new FileHelper_Exception(
1043 1043
                 'Unsupported OS for CLI commands',
@@ -1063,7 +1063,7 @@  discard block
 block discarded – undo
1063 1063
             $pipes
1064 1064
         );
1065 1065
         
1066
-        if($process === false) {
1066
+        if ($process === false) {
1067 1067
             $checked[$command] = false;
1068 1068
             return false;
1069 1069
         }
@@ -1094,7 +1094,7 @@  discard block
 block discarded – undo
1094 1094
     */
1095 1095
     public static function checkPHPFileSyntax($path)
1096 1096
     {
1097
-        if(!self::canMakePHPCalls()) {
1097
+        if (!self::canMakePHPCalls()) {
1098 1098
             return true;
1099 1099
         }
1100 1100
         
@@ -1105,7 +1105,7 @@  discard block
 block discarded – undo
1105 1105
         // when the validation is successful, the first entry
1106 1106
         // in the array contains the success message. When it
1107 1107
         // is invalid, the first entry is always empty.
1108
-        if(!empty($output[0])) {
1108
+        if (!empty($output[0])) {
1109 1109
             return true;
1110 1110
         }
1111 1111
         
@@ -1126,7 +1126,7 @@  discard block
 block discarded – undo
1126 1126
     public static function getModifiedDate($path)
1127 1127
     {
1128 1128
         $time = filemtime($path);
1129
-        if($time !== false) {
1129
+        if ($time !== false) {
1130 1130
             $date = new \DateTime();
1131 1131
             $date->setTimestamp($time);
1132 1132
             return $date;
@@ -1155,7 +1155,7 @@  discard block
 block discarded – undo
1155 1155
     */
1156 1156
     public static function getSubfolders($targetFolder, $options = array())
1157 1157
     {
1158
-        if(!is_dir($targetFolder)) 
1158
+        if (!is_dir($targetFolder)) 
1159 1159
         {
1160 1160
             throw new FileHelper_Exception(
1161 1161
                 'Target folder does not exist',
@@ -1179,29 +1179,29 @@  discard block
 block discarded – undo
1179 1179
         
1180 1180
         $d = new \DirectoryIterator($targetFolder);
1181 1181
         
1182
-        foreach($d as $item) 
1182
+        foreach ($d as $item) 
1183 1183
         {
1184
-            if($item->isDir() && !$item->isDot()) 
1184
+            if ($item->isDir() && !$item->isDot()) 
1185 1185
             {
1186 1186
                 $name = $item->getFilename();
1187 1187
                 
1188
-                if(!$options['absolute-path']) {
1188
+                if (!$options['absolute-path']) {
1189 1189
                     $result[] = $name;
1190 1190
                 } else {
1191 1191
                     $result[] = $targetFolder.'/'.$name;
1192 1192
                 }
1193 1193
                 
1194
-                if(!$options['recursive']) 
1194
+                if (!$options['recursive']) 
1195 1195
                 {
1196 1196
                     continue;
1197 1197
                 }
1198 1198
                 
1199 1199
                 $subs = self::getSubfolders($targetFolder.'/'.$name, $options);
1200
-                foreach($subs as $sub) 
1200
+                foreach ($subs as $sub) 
1201 1201
                 {
1202 1202
                     $relative = $name.'/'.$sub;
1203 1203
                     
1204
-                    if(!$options['absolute-path']) {
1204
+                    if (!$options['absolute-path']) {
1205 1205
                         $result[] = $relative;
1206 1206
                     } else {
1207 1207
                         $result[] = $targetFolder.'/'.$relative;
@@ -1269,7 +1269,7 @@  discard block
 block discarded – undo
1269 1269
     * @param int $depth The folder depth to reduce the path to
1270 1270
     * @return string
1271 1271
     */
1272
-    public static function relativizePathByDepth(string $path, int $depth=2) : string
1272
+    public static function relativizePathByDepth(string $path, int $depth = 2) : string
1273 1273
     {
1274 1274
         $path = self::normalizePath($path);
1275 1275
         
@@ -1277,17 +1277,17 @@  discard block
 block discarded – undo
1277 1277
         $tokens = array_filter($tokens); // remove empty entries (trailing slash for example)
1278 1278
         $tokens = array_values($tokens); // re-index keys
1279 1279
         
1280
-        if(empty($tokens)) {
1280
+        if (empty($tokens)) {
1281 1281
             return '';
1282 1282
         }
1283 1283
         
1284 1284
         // remove the drive if present
1285
-        if(strstr($tokens[0], ':')) {
1285
+        if (strstr($tokens[0], ':')) {
1286 1286
             array_shift($tokens);
1287 1287
         }
1288 1288
         
1289 1289
         // path was only the drive
1290
-        if(count($tokens) == 0) {
1290
+        if (count($tokens) == 0) {
1291 1291
             return '';
1292 1292
         }
1293 1293
 
@@ -1296,8 +1296,8 @@  discard block
 block discarded – undo
1296 1296
         
1297 1297
         // reduce the path to the specified depth
1298 1298
         $length = count($tokens);
1299
-        if($length > $depth) {
1300
-            $tokens = array_slice($tokens, $length-$depth);
1299
+        if ($length > $depth) {
1300
+            $tokens = array_slice($tokens, $length - $depth);
1301 1301
         }
1302 1302
 
1303 1303
         // append the last element again
@@ -1345,14 +1345,14 @@  discard block
 block discarded – undo
1345 1345
     * 
1346 1346
     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1347 1347
     */
1348
-    public static function requireFileExists(string $path, $errorCode=null) : string
1348
+    public static function requireFileExists(string $path, $errorCode = null) : string
1349 1349
     {
1350 1350
         $result = realpath($path);
1351
-        if($result !== false) {
1351
+        if ($result !== false) {
1352 1352
             return $result;
1353 1353
         }
1354 1354
         
1355
-        if($errorCode === null) {
1355
+        if ($errorCode === null) {
1356 1356
             $errorCode = self::ERROR_FILE_DOES_NOT_EXIST;
1357 1357
         }
1358 1358
         
@@ -1381,15 +1381,15 @@  discard block
 block discarded – undo
1381 1381
         
1382 1382
         $file = new \SplFileObject($path);
1383 1383
         
1384
-        if($file->eof()) {
1384
+        if ($file->eof()) {
1385 1385
             return '';
1386 1386
         }
1387 1387
         
1388
-        $targetLine = $lineNumber-1;
1388
+        $targetLine = $lineNumber - 1;
1389 1389
         
1390 1390
         $file->seek($targetLine);
1391 1391
         
1392
-        if($file->key() !== $targetLine) {
1392
+        if ($file->key() !== $targetLine) {
1393 1393
              return null;
1394 1394
         }
1395 1395
         
@@ -1415,7 +1415,7 @@  discard block
 block discarded – undo
1415 1415
         $number = $spl->key();
1416 1416
         
1417 1417
         // if seeking to the end the cursor is still at 0, there are no lines. 
1418
-        if($number === 0) 
1418
+        if ($number === 0) 
1419 1419
         {
1420 1420
             // since it's a very small file, to get reliable results,
1421 1421
             // we read its contents and use that to determine what
@@ -1423,13 +1423,13 @@  discard block
 block discarded – undo
1423 1423
             // that this is not pactical to solve with the SplFileObject.
1424 1424
             $content = file_get_contents($path);
1425 1425
             
1426
-            if(empty($content)) {
1426
+            if (empty($content)) {
1427 1427
                 return 0;
1428 1428
             }
1429 1429
         }
1430 1430
         
1431 1431
         // return the line number we were able to reach + 1 (key is zero-based)
1432
-        return $number+1;
1432
+        return $number + 1;
1433 1433
     }
1434 1434
     
1435 1435
    /**
@@ -1476,13 +1476,13 @@  discard block
 block discarded – undo
1476 1476
     * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
1477 1477
     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
1478 1478
     */
1479
-    public static function readLines(string $filePath, int $amount=0) : array
1479
+    public static function readLines(string $filePath, int $amount = 0) : array
1480 1480
     {
1481 1481
         self::requireFileExists($filePath);
1482 1482
         
1483 1483
         $fn = fopen($filePath, "r");
1484 1484
         
1485
-        if($fn === false) 
1485
+        if ($fn === false) 
1486 1486
         {
1487 1487
             throw new FileHelper_Exception(
1488 1488
                 'Could not open file for reading.',
@@ -1498,25 +1498,25 @@  discard block
 block discarded – undo
1498 1498
         $counter = 0;
1499 1499
         $first = true;
1500 1500
         
1501
-        while(!feof($fn)) 
1501
+        while (!feof($fn)) 
1502 1502
         {
1503 1503
             $counter++;
1504 1504
             
1505 1505
             $line = fgets($fn);
1506 1506
             
1507 1507
             // can happen with zero length files
1508
-            if($line === false) {
1508
+            if ($line === false) {
1509 1509
                 continue;
1510 1510
             }
1511 1511
             
1512 1512
             // the first line may contain a unicode BOM marker.
1513
-            if($first) {
1513
+            if ($first) {
1514 1514
                 $line = ConvertHelper::stripUTFBom($line);
1515 1515
             }
1516 1516
             
1517 1517
             $result[] = $line;
1518 1518
             
1519
-            if($amount > 0 && $counter == $amount) {
1519
+            if ($amount > 0 && $counter == $amount) {
1520 1520
                 break;
1521 1521
             }
1522 1522
         }
@@ -1542,7 +1542,7 @@  discard block
 block discarded – undo
1542 1542
         
1543 1543
         $result = file_get_contents($filePath);
1544 1544
         
1545
-        if($result !== false) {
1545
+        if ($result !== false) {
1546 1546
             return $result;
1547 1547
         }
1548 1548
         
Please login to merge, or discard this patch.
src/Request/Param/Filter.php 1 patch
Indentation   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -22,9 +22,9 @@
 block discarded – undo
22 22
 {
23 23
     use Traits_Optionable;
24 24
     
25
-   /**
26
-    * @var Request_Param
27
-    */
25
+    /**
26
+     * @var Request_Param
27
+     */
28 28
     protected $param;
29 29
     
30 30
     protected $value;
Please login to merge, or discard this patch.
src/Request/Param/Filter/Boolean.php 1 patch
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -20,7 +20,7 @@
 block discarded – undo
20 20
     
21 21
     protected function _filter()
22 22
     {
23
-        if($this->value === 'yes' || $this->value === 'true' || $this->value === true) {
23
+        if ($this->value === 'yes' || $this->value === 'true' || $this->value === true) {
24 24
             return true;
25 25
         }
26 26
         
Please login to merge, or discard this patch.