@@ -31,9 +31,9 @@ discard block |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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; |
@@ -99,7 +99,7 @@ discard block |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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.'), |
@@ -20,24 +20,24 @@ discard block |
||
| 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 |
||
| 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) |
@@ -59,7 +59,7 @@ discard block |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 | |
@@ -20,9 +20,9 @@ |
||
| 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) |
@@ -204,13 +204,11 @@ |
||
| 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>', |
@@ -77,7 +77,7 @@ discard block |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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, |
@@ -39,9 +39,9 @@ discard block |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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']; |
@@ -90,11 +90,11 @@ discard block |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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, '&'); |
|
| 195 | + $url .= '?'.http_build_query($params, null, '&'); |
|
| 196 | 196 | } |
| 197 | 197 | |
| 198 | 198 | return $url; |
@@ -223,7 +223,7 @@ discard block |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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); |
@@ -28,20 +28,20 @@ discard block |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 */ |
@@ -46,7 +46,7 @@ discard block |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 | } |
@@ -141,14 +141,12 @@ |
||
| 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']; |
@@ -215,8 +215,7 @@ discard block |
||
| 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 |
||
| 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 |
||
| 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 | } |
@@ -74,32 +74,32 @@ discard block |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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); |
@@ -106,7 +106,7 @@ discard block |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 | |
@@ -390,7 +390,7 @@ discard block |
||
| 390 | 390 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
| 391 | 391 | * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
| 392 | 392 | */ |
| 393 | - public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array |
|
| 393 | + public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array |
|
| 394 | 394 | { |
| 395 | 395 | $content = self::readContents($filePath); |
| 396 | 396 | |
@@ -407,7 +407,7 @@ discard block |
||
| 407 | 407 | public static function detectMimeType(string $fileName) : ?string |
| 408 | 408 | { |
| 409 | 409 | $ext = self::getExtension($fileName); |
| 410 | - if(empty($ext)) { |
|
| 410 | + if (empty($ext)) { |
|
| 411 | 411 | return null; |
| 412 | 412 | } |
| 413 | 413 | |
@@ -428,11 +428,11 @@ discard block |
||
| 428 | 428 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
| 429 | 429 | * @see FileHelper::ERROR_UNKNOWN_FILE_MIME_TYPE |
| 430 | 430 | */ |
| 431 | - public static function sendFile(string $filePath, $fileName = null, bool $asAttachment=true) |
|
| 431 | + public static function sendFile(string $filePath, $fileName = null, bool $asAttachment = true) |
|
| 432 | 432 | { |
| 433 | 433 | self::requireFileExists($filePath); |
| 434 | 434 | |
| 435 | - if(empty($fileName)) { |
|
| 435 | + if (empty($fileName)) { |
|
| 436 | 436 | $fileName = basename($filePath); |
| 437 | 437 | } |
| 438 | 438 | |
@@ -450,10 +450,10 @@ discard block |
||
| 450 | 450 | |
| 451 | 451 | header("Cache-Control: public", true); |
| 452 | 452 | header("Content-Description: File Transfer", true); |
| 453 | - header("Content-Type: " . $mime, true); |
|
| 453 | + header("Content-Type: ".$mime, true); |
|
| 454 | 454 | |
| 455 | 455 | $disposition = 'inline'; |
| 456 | - if($asAttachment) { |
|
| 456 | + if ($asAttachment) { |
|
| 457 | 457 | $disposition = 'attachment'; |
| 458 | 458 | } |
| 459 | 459 | |
@@ -481,7 +481,7 @@ discard block |
||
| 481 | 481 | requireCURL(); |
| 482 | 482 | |
| 483 | 483 | $ch = curl_init(); |
| 484 | - if(!is_resource($ch)) |
|
| 484 | + if (!is_resource($ch)) |
|
| 485 | 485 | { |
| 486 | 486 | throw new FileHelper_Exception( |
| 487 | 487 | 'Could not initialize a new cURL instance.', |
@@ -502,7 +502,7 @@ discard block |
||
| 502 | 502 | |
| 503 | 503 | $output = curl_exec($ch); |
| 504 | 504 | |
| 505 | - if($output === false) { |
|
| 505 | + if ($output === false) { |
|
| 506 | 506 | throw new FileHelper_Exception( |
| 507 | 507 | 'Unable to open URL', |
| 508 | 508 | sprintf( |
@@ -516,7 +516,7 @@ discard block |
||
| 516 | 516 | |
| 517 | 517 | curl_close($ch); |
| 518 | 518 | |
| 519 | - if(is_string($output)) |
|
| 519 | + if (is_string($output)) |
|
| 520 | 520 | { |
| 521 | 521 | return $output; |
| 522 | 522 | } |
@@ -538,7 +538,7 @@ discard block |
||
| 538 | 538 | */ |
| 539 | 539 | public static function isPHPFile($pathOrDirIterator) |
| 540 | 540 | { |
| 541 | - if(self::getExtension($pathOrDirIterator) == 'php') { |
|
| 541 | + if (self::getExtension($pathOrDirIterator) == 'php') { |
|
| 542 | 542 | return true; |
| 543 | 543 | } |
| 544 | 544 | |
@@ -555,14 +555,14 @@ discard block |
||
| 555 | 555 | */ |
| 556 | 556 | public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string |
| 557 | 557 | { |
| 558 | - if($pathOrDirIterator instanceof \DirectoryIterator) { |
|
| 558 | + if ($pathOrDirIterator instanceof \DirectoryIterator) { |
|
| 559 | 559 | $filename = $pathOrDirIterator->getFilename(); |
| 560 | 560 | } else { |
| 561 | 561 | $filename = basename($pathOrDirIterator); |
| 562 | 562 | } |
| 563 | 563 | |
| 564 | 564 | $ext = pathinfo($filename, PATHINFO_EXTENSION); |
| 565 | - if($lowercase) { |
|
| 565 | + if ($lowercase) { |
|
| 566 | 566 | $ext = mb_strtolower($ext); |
| 567 | 567 | } |
| 568 | 568 | |
@@ -584,13 +584,13 @@ discard block |
||
| 584 | 584 | public static function getFilename($pathOrDirIterator, $extension = true) |
| 585 | 585 | { |
| 586 | 586 | $path = $pathOrDirIterator; |
| 587 | - if($pathOrDirIterator instanceof \DirectoryIterator) { |
|
| 587 | + if ($pathOrDirIterator instanceof \DirectoryIterator) { |
|
| 588 | 588 | $path = $pathOrDirIterator->getFilename(); |
| 589 | 589 | } |
| 590 | 590 | |
| 591 | 591 | $path = self::normalizePath($path); |
| 592 | 592 | |
| 593 | - if(!$extension) { |
|
| 593 | + if (!$extension) { |
|
| 594 | 594 | return pathinfo($path, PATHINFO_FILENAME); |
| 595 | 595 | } |
| 596 | 596 | |
@@ -608,12 +608,12 @@ discard block |
||
| 608 | 608 | * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE |
| 609 | 609 | * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE |
| 610 | 610 | */ |
| 611 | - public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null) |
|
| 611 | + public static function parseJSONFile(string $file, $targetEncoding = null, $sourceEncoding = null) |
|
| 612 | 612 | { |
| 613 | 613 | self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE); |
| 614 | 614 | |
| 615 | 615 | $content = file_get_contents($file); |
| 616 | - if(!$content) { |
|
| 616 | + if (!$content) { |
|
| 617 | 617 | throw new FileHelper_Exception( |
| 618 | 618 | 'Cannot get file contents', |
| 619 | 619 | sprintf( |
@@ -624,12 +624,12 @@ discard block |
||
| 624 | 624 | ); |
| 625 | 625 | } |
| 626 | 626 | |
| 627 | - if(isset($targetEncoding)) { |
|
| 627 | + if (isset($targetEncoding)) { |
|
| 628 | 628 | $content = mb_convert_encoding($content, $targetEncoding, $sourceEncoding); |
| 629 | 629 | } |
| 630 | 630 | |
| 631 | 631 | $json = json_decode($content, true); |
| 632 | - if($json === false || $json === NULL) { |
|
| 632 | + if ($json === false || $json === NULL) { |
|
| 633 | 633 | throw new FileHelper_Exception( |
| 634 | 634 | 'Cannot decode json data', |
| 635 | 635 | sprintf( |
@@ -669,13 +669,13 @@ discard block |
||
| 669 | 669 | |
| 670 | 670 | $name = str_replace(array_keys($replaces), array_values($replaces), $name); |
| 671 | 671 | |
| 672 | - while(strstr($name, ' ')) { |
|
| 672 | + while (strstr($name, ' ')) { |
|
| 673 | 673 | $name = str_replace(' ', ' ', $name); |
| 674 | 674 | } |
| 675 | 675 | |
| 676 | 676 | $name = str_replace(array_keys($replaces), array_values($replaces), $name); |
| 677 | 677 | |
| 678 | - while(strstr($name, '..')) { |
|
| 678 | + while (strstr($name, '..')) { |
|
| 679 | 679 | $name = str_replace('..', '.', $name); |
| 680 | 680 | } |
| 681 | 681 | |
@@ -707,7 +707,7 @@ discard block |
||
| 707 | 707 | * @return array An indexed array with files. |
| 708 | 708 | * @see FileHelper::createFileFinder() |
| 709 | 709 | */ |
| 710 | - public static function findHTMLFiles(string $targetFolder, array $options=array()) : array |
|
| 710 | + public static function findHTMLFiles(string $targetFolder, array $options = array()) : array |
|
| 711 | 711 | { |
| 712 | 712 | return self::findFiles($targetFolder, array('html'), $options); |
| 713 | 713 | } |
@@ -724,7 +724,7 @@ discard block |
||
| 724 | 724 | * @return array An indexed array of PHP files. |
| 725 | 725 | * @see FileHelper::createFileFinder() |
| 726 | 726 | */ |
| 727 | - public static function findPHPFiles(string $targetFolder, array $options=array()) : array |
|
| 727 | + public static function findPHPFiles(string $targetFolder, array $options = array()) : array |
|
| 728 | 728 | { |
| 729 | 729 | return self::findFiles($targetFolder, array('php'), $options); |
| 730 | 730 | } |
@@ -744,22 +744,22 @@ discard block |
||
| 744 | 744 | * @return array |
| 745 | 745 | * @see FileHelper::createFileFinder() |
| 746 | 746 | */ |
| 747 | - public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array |
|
| 747 | + public static function findFiles(string $targetFolder, array $extensions = array(), array $options = array(), array $files = array()) : array |
|
| 748 | 748 | { |
| 749 | 749 | $finder = self::createFileFinder($targetFolder); |
| 750 | 750 | |
| 751 | 751 | $finder->setPathmodeStrip(); |
| 752 | 752 | |
| 753 | - if(isset($options['relative-path']) && $options['relative-path'] === true) |
|
| 753 | + if (isset($options['relative-path']) && $options['relative-path'] === true) |
|
| 754 | 754 | { |
| 755 | 755 | $finder->setPathmodeRelative(); |
| 756 | 756 | } |
| 757 | - else if(isset($options['absolute-path']) && $options['absolute-path'] === true) |
|
| 757 | + else if (isset($options['absolute-path']) && $options['absolute-path'] === true) |
|
| 758 | 758 | { |
| 759 | 759 | $finder->setPathmodeAbsolute(); |
| 760 | 760 | } |
| 761 | 761 | |
| 762 | - if(isset($options['strip-extension'])) |
|
| 762 | + if (isset($options['strip-extension'])) |
|
| 763 | 763 | { |
| 764 | 764 | $finder->stripExtensions(); |
| 765 | 765 | } |
@@ -803,7 +803,7 @@ discard block |
||
| 803 | 803 | public static function detectUTFBom(string $filename) : ?string |
| 804 | 804 | { |
| 805 | 805 | $fp = fopen($filename, 'r'); |
| 806 | - if($fp === false) |
|
| 806 | + if ($fp === false) |
|
| 807 | 807 | { |
| 808 | 808 | throw new FileHelper_Exception( |
| 809 | 809 | 'Cannot open file for reading', |
@@ -818,10 +818,10 @@ discard block |
||
| 818 | 818 | |
| 819 | 819 | $boms = self::getUTFBOMs(); |
| 820 | 820 | |
| 821 | - foreach($boms as $bom => $value) |
|
| 821 | + foreach ($boms as $bom => $value) |
|
| 822 | 822 | { |
| 823 | 823 | $length = mb_strlen($value); |
| 824 | - if(mb_substr($text, 0, $length) == $value) { |
|
| 824 | + if (mb_substr($text, 0, $length) == $value) { |
|
| 825 | 825 | return $bom; |
| 826 | 826 | } |
| 827 | 827 | } |
@@ -840,13 +840,13 @@ discard block |
||
| 840 | 840 | */ |
| 841 | 841 | public static function getUTFBOMs() |
| 842 | 842 | { |
| 843 | - if(!isset(self::$utfBoms)) { |
|
| 843 | + if (!isset(self::$utfBoms)) { |
|
| 844 | 844 | self::$utfBoms = array( |
| 845 | - 'UTF32-BE' => chr(0x00) . chr(0x00) . chr(0xFE) . chr(0xFF), |
|
| 846 | - 'UTF32-LE' => chr(0xFF) . chr(0xFE) . chr(0x00) . chr(0x00), |
|
| 847 | - 'UTF16-BE' => chr(0xFE) . chr(0xFF), |
|
| 848 | - 'UTF16-LE' => chr(0xFF) . chr(0xFE), |
|
| 849 | - 'UTF8' => chr(0xEF) . chr(0xBB) . chr(0xBF) |
|
| 845 | + 'UTF32-BE' => chr(0x00).chr(0x00).chr(0xFE).chr(0xFF), |
|
| 846 | + 'UTF32-LE' => chr(0xFF).chr(0xFE).chr(0x00).chr(0x00), |
|
| 847 | + 'UTF16-BE' => chr(0xFE).chr(0xFF), |
|
| 848 | + 'UTF16-LE' => chr(0xFF).chr(0xFE), |
|
| 849 | + 'UTF8' => chr(0xEF).chr(0xBB).chr(0xBF) |
|
| 850 | 850 | ); |
| 851 | 851 | } |
| 852 | 852 | |
@@ -867,7 +867,7 @@ discard block |
||
| 867 | 867 | $encodings = self::getKnownUnicodeEncodings(); |
| 868 | 868 | |
| 869 | 869 | $keep = array(); |
| 870 | - foreach($encodings as $string) |
|
| 870 | + foreach ($encodings as $string) |
|
| 871 | 871 | { |
| 872 | 872 | $withHyphen = str_replace('UTF', 'UTF-', $string); |
| 873 | 873 | |
@@ -914,16 +914,16 @@ discard block |
||
| 914 | 914 | * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
| 915 | 915 | * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
| 916 | 916 | */ |
| 917 | - public static function saveAsJSON($data, string $file, bool $pretty=false) |
|
| 917 | + public static function saveAsJSON($data, string $file, bool $pretty = false) |
|
| 918 | 918 | { |
| 919 | 919 | $options = null; |
| 920 | - if($pretty) { |
|
| 920 | + if ($pretty) { |
|
| 921 | 921 | $options = JSON_PRETTY_PRINT; |
| 922 | 922 | } |
| 923 | 923 | |
| 924 | 924 | $json = json_encode($data, $options); |
| 925 | 925 | |
| 926 | - if($json===false) |
|
| 926 | + if ($json === false) |
|
| 927 | 927 | { |
| 928 | 928 | $errorCode = json_last_error(); |
| 929 | 929 | |
@@ -949,12 +949,12 @@ discard block |
||
| 949 | 949 | * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
| 950 | 950 | * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
| 951 | 951 | */ |
| 952 | - public static function saveFile(string $filePath, string $content='') : void |
|
| 952 | + public static function saveFile(string $filePath, string $content = '') : void |
|
| 953 | 953 | { |
| 954 | 954 | // target file already exists |
| 955 | - if(file_exists($filePath)) |
|
| 955 | + if (file_exists($filePath)) |
|
| 956 | 956 | { |
| 957 | - if(!is_writable($filePath)) |
|
| 957 | + if (!is_writable($filePath)) |
|
| 958 | 958 | { |
| 959 | 959 | throw new FileHelper_Exception( |
| 960 | 960 | sprintf('Cannot save file: target file [%s] exists, but is not writable.', basename($filePath)), |
@@ -974,7 +974,7 @@ discard block |
||
| 974 | 974 | // create the folder as needed |
| 975 | 975 | self::createFolder($targetFolder); |
| 976 | 976 | |
| 977 | - if(!is_writable($targetFolder)) |
|
| 977 | + if (!is_writable($targetFolder)) |
|
| 978 | 978 | { |
| 979 | 979 | throw new FileHelper_Exception( |
| 980 | 980 | sprintf('Cannot save file: target folder [%s] is not writable.', basename($targetFolder)), |
@@ -987,7 +987,7 @@ discard block |
||
| 987 | 987 | } |
| 988 | 988 | } |
| 989 | 989 | |
| 990 | - if(file_put_contents($filePath, $content) !== false) { |
|
| 990 | + if (file_put_contents($filePath, $content) !== false) { |
|
| 991 | 991 | return; |
| 992 | 992 | } |
| 993 | 993 | |
@@ -1025,7 +1025,7 @@ discard block |
||
| 1025 | 1025 | { |
| 1026 | 1026 | static $checked = array(); |
| 1027 | 1027 | |
| 1028 | - if(isset($checked[$command])) { |
|
| 1028 | + if (isset($checked[$command])) { |
|
| 1029 | 1029 | return $checked[$command]; |
| 1030 | 1030 | } |
| 1031 | 1031 | |
@@ -1038,7 +1038,7 @@ discard block |
||
| 1038 | 1038 | |
| 1039 | 1039 | $os = strtolower(PHP_OS_FAMILY); |
| 1040 | 1040 | |
| 1041 | - if(!isset($osCommands[$os])) |
|
| 1041 | + if (!isset($osCommands[$os])) |
|
| 1042 | 1042 | { |
| 1043 | 1043 | throw new FileHelper_Exception( |
| 1044 | 1044 | 'Unsupported OS for CLI commands', |
@@ -1064,7 +1064,7 @@ discard block |
||
| 1064 | 1064 | $pipes |
| 1065 | 1065 | ); |
| 1066 | 1066 | |
| 1067 | - if($process === false) { |
|
| 1067 | + if ($process === false) { |
|
| 1068 | 1068 | $checked[$command] = false; |
| 1069 | 1069 | return false; |
| 1070 | 1070 | } |
@@ -1095,7 +1095,7 @@ discard block |
||
| 1095 | 1095 | */ |
| 1096 | 1096 | public static function checkPHPFileSyntax($path) |
| 1097 | 1097 | { |
| 1098 | - if(!self::canMakePHPCalls()) { |
|
| 1098 | + if (!self::canMakePHPCalls()) { |
|
| 1099 | 1099 | return true; |
| 1100 | 1100 | } |
| 1101 | 1101 | |
@@ -1106,7 +1106,7 @@ discard block |
||
| 1106 | 1106 | // when the validation is successful, the first entry |
| 1107 | 1107 | // in the array contains the success message. When it |
| 1108 | 1108 | // is invalid, the first entry is always empty. |
| 1109 | - if(!empty($output[0])) { |
|
| 1109 | + if (!empty($output[0])) { |
|
| 1110 | 1110 | return true; |
| 1111 | 1111 | } |
| 1112 | 1112 | |
@@ -1127,7 +1127,7 @@ discard block |
||
| 1127 | 1127 | public static function getModifiedDate($path) |
| 1128 | 1128 | { |
| 1129 | 1129 | $time = filemtime($path); |
| 1130 | - if($time !== false) { |
|
| 1130 | + if ($time !== false) { |
|
| 1131 | 1131 | $date = new \DateTime(); |
| 1132 | 1132 | $date->setTimestamp($time); |
| 1133 | 1133 | return $date; |
@@ -1156,7 +1156,7 @@ discard block |
||
| 1156 | 1156 | */ |
| 1157 | 1157 | public static function getSubfolders($targetFolder, $options = array()) |
| 1158 | 1158 | { |
| 1159 | - if(!is_dir($targetFolder)) |
|
| 1159 | + if (!is_dir($targetFolder)) |
|
| 1160 | 1160 | { |
| 1161 | 1161 | throw new FileHelper_Exception( |
| 1162 | 1162 | 'Target folder does not exist', |
@@ -1180,29 +1180,29 @@ discard block |
||
| 1180 | 1180 | |
| 1181 | 1181 | $d = new \DirectoryIterator($targetFolder); |
| 1182 | 1182 | |
| 1183 | - foreach($d as $item) |
|
| 1183 | + foreach ($d as $item) |
|
| 1184 | 1184 | { |
| 1185 | - if($item->isDir() && !$item->isDot()) |
|
| 1185 | + if ($item->isDir() && !$item->isDot()) |
|
| 1186 | 1186 | { |
| 1187 | 1187 | $name = $item->getFilename(); |
| 1188 | 1188 | |
| 1189 | - if(!$options['absolute-path']) { |
|
| 1189 | + if (!$options['absolute-path']) { |
|
| 1190 | 1190 | $result[] = $name; |
| 1191 | 1191 | } else { |
| 1192 | 1192 | $result[] = $targetFolder.'/'.$name; |
| 1193 | 1193 | } |
| 1194 | 1194 | |
| 1195 | - if(!$options['recursive']) |
|
| 1195 | + if (!$options['recursive']) |
|
| 1196 | 1196 | { |
| 1197 | 1197 | continue; |
| 1198 | 1198 | } |
| 1199 | 1199 | |
| 1200 | 1200 | $subs = self::getSubfolders($targetFolder.'/'.$name, $options); |
| 1201 | - foreach($subs as $sub) |
|
| 1201 | + foreach ($subs as $sub) |
|
| 1202 | 1202 | { |
| 1203 | 1203 | $relative = $name.'/'.$sub; |
| 1204 | 1204 | |
| 1205 | - if(!$options['absolute-path']) { |
|
| 1205 | + if (!$options['absolute-path']) { |
|
| 1206 | 1206 | $result[] = $relative; |
| 1207 | 1207 | } else { |
| 1208 | 1208 | $result[] = $targetFolder.'/'.$relative; |
@@ -1252,7 +1252,7 @@ discard block |
||
| 1252 | 1252 | $unit = preg_replace('/[^bkmgtpezy]/i', '', $size); // Remove the non-unit characters from the size. |
| 1253 | 1253 | $size = floatval(preg_replace('/[^0-9\.]/', '', $size)); // Remove the non-numeric characters from the size. |
| 1254 | 1254 | |
| 1255 | - if($unit) |
|
| 1255 | + if ($unit) |
|
| 1256 | 1256 | { |
| 1257 | 1257 | // Find the position of the unit in the ordered string which is the power of magnitude to multiply a kilobyte by. |
| 1258 | 1258 | return round($size * pow(1024, stripos('bkmgtpezy', $unit[0]))); |
@@ -1271,7 +1271,7 @@ discard block |
||
| 1271 | 1271 | * @param int $depth The folder depth to reduce the path to |
| 1272 | 1272 | * @return string |
| 1273 | 1273 | */ |
| 1274 | - public static function relativizePathByDepth(string $path, int $depth=2) : string |
|
| 1274 | + public static function relativizePathByDepth(string $path, int $depth = 2) : string |
|
| 1275 | 1275 | { |
| 1276 | 1276 | $path = self::normalizePath($path); |
| 1277 | 1277 | |
@@ -1279,17 +1279,17 @@ discard block |
||
| 1279 | 1279 | $tokens = array_filter($tokens); // remove empty entries (trailing slash for example) |
| 1280 | 1280 | $tokens = array_values($tokens); // re-index keys |
| 1281 | 1281 | |
| 1282 | - if(empty($tokens)) { |
|
| 1282 | + if (empty($tokens)) { |
|
| 1283 | 1283 | return ''; |
| 1284 | 1284 | } |
| 1285 | 1285 | |
| 1286 | 1286 | // remove the drive if present |
| 1287 | - if(strstr($tokens[0], ':')) { |
|
| 1287 | + if (strstr($tokens[0], ':')) { |
|
| 1288 | 1288 | array_shift($tokens); |
| 1289 | 1289 | } |
| 1290 | 1290 | |
| 1291 | 1291 | // path was only the drive |
| 1292 | - if(count($tokens) == 0) { |
|
| 1292 | + if (count($tokens) == 0) { |
|
| 1293 | 1293 | return ''; |
| 1294 | 1294 | } |
| 1295 | 1295 | |
@@ -1298,8 +1298,8 @@ discard block |
||
| 1298 | 1298 | |
| 1299 | 1299 | // reduce the path to the specified depth |
| 1300 | 1300 | $length = count($tokens); |
| 1301 | - if($length > $depth) { |
|
| 1302 | - $tokens = array_slice($tokens, $length-$depth); |
|
| 1301 | + if ($length > $depth) { |
|
| 1302 | + $tokens = array_slice($tokens, $length - $depth); |
|
| 1303 | 1303 | } |
| 1304 | 1304 | |
| 1305 | 1305 | // append the last element again |
@@ -1347,14 +1347,14 @@ discard block |
||
| 1347 | 1347 | * |
| 1348 | 1348 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
| 1349 | 1349 | */ |
| 1350 | - public static function requireFileExists(string $path, $errorCode=null) : string |
|
| 1350 | + public static function requireFileExists(string $path, $errorCode = null) : string |
|
| 1351 | 1351 | { |
| 1352 | 1352 | $result = realpath($path); |
| 1353 | - if($result !== false) { |
|
| 1353 | + if ($result !== false) { |
|
| 1354 | 1354 | return $result; |
| 1355 | 1355 | } |
| 1356 | 1356 | |
| 1357 | - if($errorCode === null) { |
|
| 1357 | + if ($errorCode === null) { |
|
| 1358 | 1358 | $errorCode = self::ERROR_FILE_DOES_NOT_EXIST; |
| 1359 | 1359 | } |
| 1360 | 1360 | |
@@ -1383,15 +1383,15 @@ discard block |
||
| 1383 | 1383 | |
| 1384 | 1384 | $file = new \SplFileObject($path); |
| 1385 | 1385 | |
| 1386 | - if($file->eof()) { |
|
| 1386 | + if ($file->eof()) { |
|
| 1387 | 1387 | return ''; |
| 1388 | 1388 | } |
| 1389 | 1389 | |
| 1390 | - $targetLine = $lineNumber-1; |
|
| 1390 | + $targetLine = $lineNumber - 1; |
|
| 1391 | 1391 | |
| 1392 | 1392 | $file->seek($targetLine); |
| 1393 | 1393 | |
| 1394 | - if($file->key() !== $targetLine) { |
|
| 1394 | + if ($file->key() !== $targetLine) { |
|
| 1395 | 1395 | return null; |
| 1396 | 1396 | } |
| 1397 | 1397 | |
@@ -1417,7 +1417,7 @@ discard block |
||
| 1417 | 1417 | $number = $spl->key(); |
| 1418 | 1418 | |
| 1419 | 1419 | // if seeking to the end the cursor is still at 0, there are no lines. |
| 1420 | - if($number === 0) |
|
| 1420 | + if ($number === 0) |
|
| 1421 | 1421 | { |
| 1422 | 1422 | // since it's a very small file, to get reliable results, |
| 1423 | 1423 | // we read its contents and use that to determine what |
@@ -1425,13 +1425,13 @@ discard block |
||
| 1425 | 1425 | // that this is not pactical to solve with the SplFileObject. |
| 1426 | 1426 | $content = file_get_contents($path); |
| 1427 | 1427 | |
| 1428 | - if(empty($content)) { |
|
| 1428 | + if (empty($content)) { |
|
| 1429 | 1429 | return 0; |
| 1430 | 1430 | } |
| 1431 | 1431 | } |
| 1432 | 1432 | |
| 1433 | 1433 | // return the line number we were able to reach + 1 (key is zero-based) |
| 1434 | - return $number+1; |
|
| 1434 | + return $number + 1; |
|
| 1435 | 1435 | } |
| 1436 | 1436 | |
| 1437 | 1437 | /** |
@@ -1478,13 +1478,13 @@ discard block |
||
| 1478 | 1478 | * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES |
| 1479 | 1479 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
| 1480 | 1480 | */ |
| 1481 | - public static function readLines(string $filePath, int $amount=0) : array |
|
| 1481 | + public static function readLines(string $filePath, int $amount = 0) : array |
|
| 1482 | 1482 | { |
| 1483 | 1483 | self::requireFileExists($filePath); |
| 1484 | 1484 | |
| 1485 | 1485 | $fn = fopen($filePath, "r"); |
| 1486 | 1486 | |
| 1487 | - if($fn === false) |
|
| 1487 | + if ($fn === false) |
|
| 1488 | 1488 | { |
| 1489 | 1489 | throw new FileHelper_Exception( |
| 1490 | 1490 | 'Could not open file for reading.', |
@@ -1500,19 +1500,19 @@ discard block |
||
| 1500 | 1500 | $counter = 0; |
| 1501 | 1501 | $first = true; |
| 1502 | 1502 | |
| 1503 | - while(!feof($fn)) |
|
| 1503 | + while (!feof($fn)) |
|
| 1504 | 1504 | { |
| 1505 | 1505 | $counter++; |
| 1506 | 1506 | |
| 1507 | 1507 | $line = fgets($fn); |
| 1508 | 1508 | |
| 1509 | 1509 | // can happen with zero length files |
| 1510 | - if($line === false) { |
|
| 1510 | + if ($line === false) { |
|
| 1511 | 1511 | continue; |
| 1512 | 1512 | } |
| 1513 | 1513 | |
| 1514 | 1514 | // the first line may contain a unicode BOM marker. |
| 1515 | - if($first) |
|
| 1515 | + if ($first) |
|
| 1516 | 1516 | { |
| 1517 | 1517 | $line = ConvertHelper::stripUTFBom($line); |
| 1518 | 1518 | $first = false; |
@@ -1520,7 +1520,7 @@ discard block |
||
| 1520 | 1520 | |
| 1521 | 1521 | $result[] = $line; |
| 1522 | 1522 | |
| 1523 | - if($amount > 0 && $counter == $amount) { |
|
| 1523 | + if ($amount > 0 && $counter == $amount) { |
|
| 1524 | 1524 | break; |
| 1525 | 1525 | } |
| 1526 | 1526 | } |
@@ -1546,7 +1546,7 @@ discard block |
||
| 1546 | 1546 | |
| 1547 | 1547 | $result = file_get_contents($filePath); |
| 1548 | 1548 | |
| 1549 | - if($result !== false) { |
|
| 1549 | + if ($result !== false) { |
|
| 1550 | 1550 | return $result; |
| 1551 | 1551 | } |
| 1552 | 1552 | |
@@ -22,9 +22,9 @@ |
||
| 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; |
@@ -20,7 +20,7 @@ |
||
| 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 | |
@@ -23,11 +23,11 @@ discard block |
||
| 23 | 23 | |
| 24 | 24 | protected function _filter() |
| 25 | 25 | { |
| 26 | - if(is_array($this->value)) { |
|
| 26 | + if (is_array($this->value)) { |
|
| 27 | 27 | return $this->value; |
| 28 | 28 | } |
| 29 | 29 | |
| 30 | - if($this->value === '' || $this->value === null || !is_string($this->value)) { |
|
| 30 | + if ($this->value === '' || $this->value === null || !is_string($this->value)) { |
|
| 31 | 31 | return array(); |
| 32 | 32 | } |
| 33 | 33 | |
@@ -35,19 +35,19 @@ discard block |
||
| 35 | 35 | $stripEmptyEntries = $this->getBoolOption('stripEmptyEntries'); |
| 36 | 36 | $result = explode(',', $this->value); |
| 37 | 37 | |
| 38 | - if(!$trimEntries && !$stripEmptyEntries) { |
|
| 38 | + if (!$trimEntries && !$stripEmptyEntries) { |
|
| 39 | 39 | return $result; |
| 40 | 40 | } |
| 41 | 41 | |
| 42 | 42 | $keep = array(); |
| 43 | 43 | |
| 44 | - foreach($result as $entry) |
|
| 44 | + foreach ($result as $entry) |
|
| 45 | 45 | { |
| 46 | - if($trimEntries === true) { |
|
| 46 | + if ($trimEntries === true) { |
|
| 47 | 47 | $entry = trim($entry); |
| 48 | 48 | } |
| 49 | 49 | |
| 50 | - if($stripEmptyEntries === true && $entry === '') { |
|
| 50 | + if ($stripEmptyEntries === true && $entry === '') { |
|
| 51 | 51 | continue; |
| 52 | 52 | } |
| 53 | 53 | |