@@ -38,38 +38,38 @@ |
||
| 38 | 38 | */ |
| 39 | 39 | protected $text; |
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * @var string |
|
| 43 | - */ |
|
| 41 | + /** |
|
| 42 | + * @var string |
|
| 43 | + */ |
|
| 44 | 44 | protected $trimmed; |
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * @var int |
|
| 48 | - */ |
|
| 46 | + /** |
|
| 47 | + * @var int |
|
| 48 | + */ |
|
| 49 | 49 | protected $lineNumber; |
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * @var string |
|
| 53 | - */ |
|
| 51 | + /** |
|
| 52 | + * @var string |
|
| 53 | + */ |
|
| 54 | 54 | protected $type; |
| 55 | 55 | |
| 56 | - /** |
|
| 57 | - * @var string |
|
| 58 | - */ |
|
| 56 | + /** |
|
| 57 | + * @var string |
|
| 58 | + */ |
|
| 59 | 59 | protected $varName = ''; |
| 60 | 60 | |
| 61 | - /** |
|
| 62 | - * @var string |
|
| 63 | - */ |
|
| 61 | + /** |
|
| 62 | + * @var string |
|
| 63 | + */ |
|
| 64 | 64 | protected $varValue = ''; |
| 65 | 65 | |
| 66 | 66 | protected $valueUnquoted = ''; |
| 67 | 67 | |
| 68 | 68 | protected $quoteStyle = ''; |
| 69 | 69 | |
| 70 | - /** |
|
| 71 | - * @var string |
|
| 72 | - */ |
|
| 70 | + /** |
|
| 71 | + * @var string |
|
| 72 | + */ |
|
| 73 | 73 | protected $sectionName = ''; |
| 74 | 74 | |
| 75 | 75 | public function __construct(string $text, int $lineNumber) |
@@ -78,7 +78,7 @@ discard block |
||
| 78 | 78 | $this->trimmed = trim($text); |
| 79 | 79 | $this->lineNumber = $lineNumber; |
| 80 | 80 | |
| 81 | - if(empty($this->trimmed)) |
|
| 81 | + if (empty($this->trimmed)) |
|
| 82 | 82 | { |
| 83 | 83 | $this->type = self::TYPE_EMPTY; |
| 84 | 84 | return; |
@@ -86,11 +86,11 @@ discard block |
||
| 86 | 86 | |
| 87 | 87 | $startChar = substr($this->trimmed, 0, 1); |
| 88 | 88 | |
| 89 | - if($startChar === ';') |
|
| 89 | + if ($startChar === ';') |
|
| 90 | 90 | { |
| 91 | 91 | $this->type = self::TYPE_COMMENT; |
| 92 | 92 | } |
| 93 | - else if($startChar === '[') |
|
| 93 | + else if ($startChar === '[') |
|
| 94 | 94 | { |
| 95 | 95 | $this->type = self::TYPE_SECTION_DECLARATION; |
| 96 | 96 | $this->sectionName = trim($this->trimmed, '[]'); |
@@ -99,7 +99,7 @@ discard block |
||
| 99 | 99 | else |
| 100 | 100 | { |
| 101 | 101 | $pos = strpos($this->trimmed, '='); |
| 102 | - if($pos === false) |
|
| 102 | + if ($pos === false) |
|
| 103 | 103 | { |
| 104 | 104 | $this->type = self::TYPE_INVALID; |
| 105 | 105 | return; |
@@ -108,7 +108,7 @@ discard block |
||
| 108 | 108 | $this->type = self::TYPE_VALUE; |
| 109 | 109 | $this->varName = trim(substr($this->trimmed, 0, $pos)); |
| 110 | 110 | |
| 111 | - $this->parseValue(substr($this->trimmed, $pos+1)); |
|
| 111 | + $this->parseValue(substr($this->trimmed, $pos + 1)); |
|
| 112 | 112 | } |
| 113 | 113 | } |
| 114 | 114 | |
@@ -118,12 +118,12 @@ discard block |
||
| 118 | 118 | |
| 119 | 119 | $value = $this->varValue; |
| 120 | 120 | |
| 121 | - if(substr($value, 0, 1) == '"' && substr($value, -1, 1) == '"') |
|
| 121 | + if (substr($value, 0, 1) == '"' && substr($value, -1, 1) == '"') |
|
| 122 | 122 | { |
| 123 | 123 | $value = trim($value, '"'); |
| 124 | 124 | $this->quoteStyle = '"'; |
| 125 | 125 | } |
| 126 | - else if(substr($value, 0, 1) == "'" && substr($value, -1, 1) == "'") |
|
| 126 | + else if (substr($value, 0, 1) == "'" && substr($value, -1, 1) == "'") |
|
| 127 | 127 | { |
| 128 | 128 | $value = trim($value, "'"); |
| 129 | 129 | $this->quoteStyle = "'"; |
@@ -144,7 +144,7 @@ discard block |
||
| 144 | 144 | |
| 145 | 145 | public function getQuotedVarValue() : string |
| 146 | 146 | { |
| 147 | - if($this->quoteStyle === '') { |
|
| 147 | + if ($this->quoteStyle === '') { |
|
| 148 | 148 | return $this->getVarValue(); |
| 149 | 149 | } |
| 150 | 150 | |
@@ -198,7 +198,7 @@ discard block |
||
| 198 | 198 | |
| 199 | 199 | public function setValue($value) : IniHelper_Line |
| 200 | 200 | { |
| 201 | - if(!is_scalar($value)) |
|
| 201 | + if (!is_scalar($value)) |
|
| 202 | 202 | { |
| 203 | 203 | throw new IniHelper_Exception( |
| 204 | 204 | 'Cannot use non-scalar values.', |
@@ -218,7 +218,7 @@ discard block |
||
| 218 | 218 | |
| 219 | 219 | public function toString() : string |
| 220 | 220 | { |
| 221 | - switch($this->type) |
|
| 221 | + switch ($this->type) |
|
| 222 | 222 | { |
| 223 | 223 | case self::TYPE_EMPTY: |
| 224 | 224 | case self::TYPE_INVALID: |
@@ -89,14 +89,12 @@ discard block |
||
| 89 | 89 | if($startChar === ';') |
| 90 | 90 | { |
| 91 | 91 | $this->type = self::TYPE_COMMENT; |
| 92 | - } |
|
| 93 | - else if($startChar === '[') |
|
| 92 | + } else if($startChar === '[') |
|
| 94 | 93 | { |
| 95 | 94 | $this->type = self::TYPE_SECTION_DECLARATION; |
| 96 | 95 | $this->sectionName = trim($this->trimmed, '[]'); |
| 97 | 96 | $this->sectionName = trim($this->sectionName); // remove any whitespace |
| 98 | - } |
|
| 99 | - else |
|
| 97 | + } else |
|
| 100 | 98 | { |
| 101 | 99 | $pos = strpos($this->trimmed, '='); |
| 102 | 100 | if($pos === false) |
@@ -122,8 +120,7 @@ discard block |
||
| 122 | 120 | { |
| 123 | 121 | $value = trim($value, '"'); |
| 124 | 122 | $this->quoteStyle = '"'; |
| 125 | - } |
|
| 126 | - else if(substr($value, 0, 1) == "'" && substr($value, -1, 1) == "'") |
|
| 123 | + } else if(substr($value, 0, 1) == "'" && substr($value, -1, 1) == "'") |
|
| 127 | 124 | { |
| 128 | 125 | $value = trim($value, "'"); |
| 129 | 126 | $this->quoteStyle = "'"; |
@@ -21,19 +21,19 @@ discard block |
||
| 21 | 21 | */ |
| 22 | 22 | class IniHelper_Section |
| 23 | 23 | { |
| 24 | - /** |
|
| 25 | - * @var IniHelper |
|
| 26 | - */ |
|
| 24 | + /** |
|
| 25 | + * @var IniHelper |
|
| 26 | + */ |
|
| 27 | 27 | protected $ini; |
| 28 | 28 | |
| 29 | - /** |
|
| 30 | - * @var string |
|
| 31 | - */ |
|
| 29 | + /** |
|
| 30 | + * @var string |
|
| 31 | + */ |
|
| 32 | 32 | protected $name; |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * @var IniHelper_Line[] |
|
| 36 | - */ |
|
| 34 | + /** |
|
| 35 | + * @var IniHelper_Line[] |
|
| 36 | + */ |
|
| 37 | 37 | protected $lines = array(); |
| 38 | 38 | |
| 39 | 39 | public function __construct(IniHelper $ini, string $name) |
@@ -42,33 +42,33 @@ discard block |
||
| 42 | 42 | $this->name = $name; |
| 43 | 43 | } |
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * The section's name. |
|
| 47 | - * @return string |
|
| 48 | - */ |
|
| 45 | + /** |
|
| 46 | + * The section's name. |
|
| 47 | + * @return string |
|
| 48 | + */ |
|
| 49 | 49 | public function getName() : string |
| 50 | 50 | { |
| 51 | 51 | return $this->name; |
| 52 | 52 | } |
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * Whether this is the default section: this |
|
| 56 | - * is used internally to store all variables that |
|
| 57 | - * are not in any specific section. |
|
| 58 | - * |
|
| 59 | - * @return bool |
|
| 60 | - */ |
|
| 54 | + /** |
|
| 55 | + * Whether this is the default section: this |
|
| 56 | + * is used internally to store all variables that |
|
| 57 | + * are not in any specific section. |
|
| 58 | + * |
|
| 59 | + * @return bool |
|
| 60 | + */ |
|
| 61 | 61 | public function isDefault() : bool |
| 62 | 62 | { |
| 63 | 63 | return $this->name === IniHelper::SECTION_DEFAULT; |
| 64 | 64 | } |
| 65 | 65 | |
| 66 | - /** |
|
| 67 | - * Adds a line instance to the section. |
|
| 68 | - * |
|
| 69 | - * @param IniHelper_Line $line |
|
| 70 | - * @return IniHelper_Section |
|
| 71 | - */ |
|
| 66 | + /** |
|
| 67 | + * Adds a line instance to the section. |
|
| 68 | + * |
|
| 69 | + * @param IniHelper_Line $line |
|
| 70 | + * @return IniHelper_Section |
|
| 71 | + */ |
|
| 72 | 72 | public function addLine(IniHelper_Line $line) : IniHelper_Section |
| 73 | 73 | { |
| 74 | 74 | $this->lines[] = $line; |
@@ -76,12 +76,12 @@ discard block |
||
| 76 | 76 | return $this; |
| 77 | 77 | } |
| 78 | 78 | |
| 79 | - /** |
|
| 80 | - * Converts the values contained in the section into |
|
| 81 | - * an associative array. |
|
| 82 | - * |
|
| 83 | - * @return array |
|
| 84 | - */ |
|
| 79 | + /** |
|
| 80 | + * Converts the values contained in the section into |
|
| 81 | + * an associative array. |
|
| 82 | + * |
|
| 83 | + * @return array |
|
| 84 | + */ |
|
| 85 | 85 | public function toArray() : array |
| 86 | 86 | { |
| 87 | 87 | $result = array(); |
@@ -114,11 +114,11 @@ discard block |
||
| 114 | 114 | return $result; |
| 115 | 115 | } |
| 116 | 116 | |
| 117 | - /** |
|
| 118 | - * Converts the section's lines into an INI string. |
|
| 119 | - * |
|
| 120 | - * @return string |
|
| 121 | - */ |
|
| 117 | + /** |
|
| 118 | + * Converts the section's lines into an INI string. |
|
| 119 | + * |
|
| 120 | + * @return string |
|
| 121 | + */ |
|
| 122 | 122 | public function toString() |
| 123 | 123 | { |
| 124 | 124 | $lines = array(); |
@@ -140,12 +140,12 @@ discard block |
||
| 140 | 140 | return implode($this->ini->getEOLChar(), $lines); |
| 141 | 141 | } |
| 142 | 142 | |
| 143 | - /** |
|
| 144 | - * Deletes a line from the section. |
|
| 145 | - * |
|
| 146 | - * @param IniHelper_Line $toDelete |
|
| 147 | - * @return IniHelper_Section |
|
| 148 | - */ |
|
| 143 | + /** |
|
| 144 | + * Deletes a line from the section. |
|
| 145 | + * |
|
| 146 | + * @param IniHelper_Line $toDelete |
|
| 147 | + * @return IniHelper_Section |
|
| 148 | + */ |
|
| 149 | 149 | public function deleteLine(IniHelper_Line $toDelete) : IniHelper_Section |
| 150 | 150 | { |
| 151 | 151 | $keep = array(); |
@@ -162,13 +162,13 @@ discard block |
||
| 162 | 162 | return $this; |
| 163 | 163 | } |
| 164 | 164 | |
| 165 | - /** |
|
| 166 | - * Sets the value of a variable, overwriting any existing value. |
|
| 167 | - * |
|
| 168 | - * @param string $name |
|
| 169 | - * @param mixed $value If an array is specified, it is treated as duplicate keys and will add a line for each value. |
|
| 170 | - * @return IniHelper_Section |
|
| 171 | - */ |
|
| 165 | + /** |
|
| 166 | + * Sets the value of a variable, overwriting any existing value. |
|
| 167 | + * |
|
| 168 | + * @param string $name |
|
| 169 | + * @param mixed $value If an array is specified, it is treated as duplicate keys and will add a line for each value. |
|
| 170 | + * @return IniHelper_Section |
|
| 171 | + */ |
|
| 172 | 172 | public function setValue(string $name, $value) : IniHelper_Section |
| 173 | 173 | { |
| 174 | 174 | $lines = $this->getLinesByVariable($name); |
@@ -229,15 +229,15 @@ discard block |
||
| 229 | 229 | return $this; |
| 230 | 230 | } |
| 231 | 231 | |
| 232 | - /** |
|
| 233 | - * Adds a variable value to the section. Unlike setValue(), this |
|
| 234 | - * will not overwrite any existing value. If the name is an existing |
|
| 235 | - * variable name, it will be converted to duplicate keys. |
|
| 236 | - * |
|
| 237 | - * @param string $name |
|
| 238 | - * @param mixed $value If this is an array, it will be treated as duplicate keys, and all values that are not present yet will be added. |
|
| 239 | - * @return IniHelper_Section |
|
| 240 | - */ |
|
| 232 | + /** |
|
| 233 | + * Adds a variable value to the section. Unlike setValue(), this |
|
| 234 | + * will not overwrite any existing value. If the name is an existing |
|
| 235 | + * variable name, it will be converted to duplicate keys. |
|
| 236 | + * |
|
| 237 | + * @param string $name |
|
| 238 | + * @param mixed $value If this is an array, it will be treated as duplicate keys, and all values that are not present yet will be added. |
|
| 239 | + * @return IniHelper_Section |
|
| 240 | + */ |
|
| 241 | 241 | public function addValue(string $name, $value) : IniHelper_Section |
| 242 | 242 | { |
| 243 | 243 | // array value? Treat it as duplicate keys. |
@@ -295,12 +295,12 @@ discard block |
||
| 295 | 295 | } |
| 296 | 296 | |
| 297 | 297 | |
| 298 | - /** |
|
| 299 | - * Retrieves all lines for the specified variable name. |
|
| 300 | - * |
|
| 301 | - * @param string $name |
|
| 302 | - * @return \AppUtils\IniHelper_Line[] |
|
| 303 | - */ |
|
| 298 | + /** |
|
| 299 | + * Retrieves all lines for the specified variable name. |
|
| 300 | + * |
|
| 301 | + * @param string $name |
|
| 302 | + * @return \AppUtils\IniHelper_Line[] |
|
| 303 | + */ |
|
| 304 | 304 | public function getLinesByVariable(string $name) |
| 305 | 305 | { |
| 306 | 306 | $result = array(); |
@@ -86,15 +86,15 @@ discard block |
||
| 86 | 86 | { |
| 87 | 87 | $result = array(); |
| 88 | 88 | |
| 89 | - foreach($this->lines as $line) |
|
| 89 | + foreach ($this->lines as $line) |
|
| 90 | 90 | { |
| 91 | - if(!$line->isValue()) { |
|
| 91 | + if (!$line->isValue()) { |
|
| 92 | 92 | continue; |
| 93 | 93 | } |
| 94 | 94 | |
| 95 | 95 | $name = $line->getVarName(); |
| 96 | 96 | |
| 97 | - if(!isset($result[$name])) |
|
| 97 | + if (!isset($result[$name])) |
|
| 98 | 98 | { |
| 99 | 99 | $result[$name] = $line->getVarValue(); |
| 100 | 100 | continue; |
@@ -103,7 +103,7 @@ discard block |
||
| 103 | 103 | // name exists in collection? Then this is a |
| 104 | 104 | // duplicate key and we need to convert it to |
| 105 | 105 | // an indexed array of values. |
| 106 | - if(!is_array($result[$name])) |
|
| 106 | + if (!is_array($result[$name])) |
|
| 107 | 107 | { |
| 108 | 108 | $result[$name] = array($result[$name]); |
| 109 | 109 | } |
@@ -122,15 +122,15 @@ discard block |
||
| 122 | 122 | public function toString() |
| 123 | 123 | { |
| 124 | 124 | $lines = array(); |
| 125 | - if(!$this->isDefault()) |
|
| 125 | + if (!$this->isDefault()) |
|
| 126 | 126 | { |
| 127 | 127 | $lines[] = '['.$this->getName().']'; |
| 128 | 128 | } |
| 129 | 129 | |
| 130 | - foreach($this->lines as $line) |
|
| 130 | + foreach ($this->lines as $line) |
|
| 131 | 131 | { |
| 132 | 132 | // we already did this |
| 133 | - if($line->isSection()) { |
|
| 133 | + if ($line->isSection()) { |
|
| 134 | 134 | continue; |
| 135 | 135 | } |
| 136 | 136 | |
@@ -150,9 +150,9 @@ discard block |
||
| 150 | 150 | { |
| 151 | 151 | $keep = array(); |
| 152 | 152 | |
| 153 | - foreach($this->lines as $line) |
|
| 153 | + foreach ($this->lines as $line) |
|
| 154 | 154 | { |
| 155 | - if($line !== $toDelete) { |
|
| 155 | + if ($line !== $toDelete) { |
|
| 156 | 156 | $keep[] = $line; |
| 157 | 157 | } |
| 158 | 158 | } |
@@ -177,23 +177,23 @@ discard block |
||
| 177 | 177 | // Removes any superfluous values that may |
| 178 | 178 | // already exist, if there are more than the |
| 179 | 179 | // new set of values. |
| 180 | - if(is_array($value)) |
|
| 180 | + if (is_array($value)) |
|
| 181 | 181 | { |
| 182 | 182 | $values = array_values($value); |
| 183 | 183 | $amountNew = count($values); |
| 184 | 184 | $amountExisting = count($lines); |
| 185 | 185 | |
| 186 | 186 | $max = $amountNew; |
| 187 | - if($amountExisting > $max) { |
|
| 187 | + if ($amountExisting > $max) { |
|
| 188 | 188 | $max = $amountExisting; |
| 189 | 189 | } |
| 190 | 190 | |
| 191 | - for($i=0; $i < $max; $i++) |
|
| 191 | + for ($i = 0; $i < $max; $i++) |
|
| 192 | 192 | { |
| 193 | 193 | // new value exists |
| 194 | - if(isset($values[$i])) |
|
| 194 | + if (isset($values[$i])) |
|
| 195 | 195 | { |
| 196 | - if(isset($lines[$i])) { |
|
| 196 | + if (isset($lines[$i])) { |
|
| 197 | 197 | $lines[$i]->setValue($values[$i]); |
| 198 | 198 | } else { |
| 199 | 199 | $this->addValueLine($name, $values[$i]); |
@@ -211,12 +211,12 @@ discard block |
||
| 211 | 211 | else |
| 212 | 212 | { |
| 213 | 213 | // remove all superfluous lines |
| 214 | - if(!empty($lines)) |
|
| 214 | + if (!empty($lines)) |
|
| 215 | 215 | { |
| 216 | 216 | $line = array_shift($lines); // keep only the first line |
| 217 | 217 | $line->setValue($value); |
| 218 | 218 | |
| 219 | - foreach($lines as $delete) { |
|
| 219 | + foreach ($lines as $delete) { |
|
| 220 | 220 | $this->deleteLine($delete); |
| 221 | 221 | } |
| 222 | 222 | } |
@@ -241,11 +241,11 @@ discard block |
||
| 241 | 241 | public function addValue(string $name, $value) : IniHelper_Section |
| 242 | 242 | { |
| 243 | 243 | // array value? Treat it as duplicate keys. |
| 244 | - if(is_array($value)) |
|
| 244 | + if (is_array($value)) |
|
| 245 | 245 | { |
| 246 | 246 | $values = array_values($value); |
| 247 | 247 | |
| 248 | - foreach($values as $setValue) |
|
| 248 | + foreach ($values as $setValue) |
|
| 249 | 249 | { |
| 250 | 250 | $this->addValue($name, $setValue); |
| 251 | 251 | } |
@@ -255,7 +255,7 @@ discard block |
||
| 255 | 255 | |
| 256 | 256 | $lines = $this->getLinesByVariable($name); |
| 257 | 257 | |
| 258 | - if(empty($lines)) |
|
| 258 | + if (empty($lines)) |
|
| 259 | 259 | { |
| 260 | 260 | $this->addValueLine($name, $value); |
| 261 | 261 | } |
@@ -263,15 +263,15 @@ discard block |
||
| 263 | 263 | { |
| 264 | 264 | $found = false; |
| 265 | 265 | |
| 266 | - foreach($lines as $line) |
|
| 266 | + foreach ($lines as $line) |
|
| 267 | 267 | { |
| 268 | - if($line->getVarValue() === $value) { |
|
| 268 | + if ($line->getVarValue() === $value) { |
|
| 269 | 269 | $found = $line; |
| 270 | 270 | break; |
| 271 | 271 | } |
| 272 | 272 | } |
| 273 | 273 | |
| 274 | - if(!$found) |
|
| 274 | + if (!$found) |
|
| 275 | 275 | { |
| 276 | 276 | $this->addValueLine($name, $value); |
| 277 | 277 | } |
@@ -305,9 +305,9 @@ discard block |
||
| 305 | 305 | { |
| 306 | 306 | $result = array(); |
| 307 | 307 | |
| 308 | - foreach($this->lines as $line) |
|
| 308 | + foreach ($this->lines as $line) |
|
| 309 | 309 | { |
| 310 | - if($line->isValue() && $line->getVarName() === $name) { |
|
| 310 | + if ($line->isValue() && $line->getVarName() === $name) { |
|
| 311 | 311 | $result[] = $line; |
| 312 | 312 | } |
| 313 | 313 | } |
@@ -198,8 +198,7 @@ discard block |
||
| 198 | 198 | } else { |
| 199 | 199 | $this->addValueLine($name, $values[$i]); |
| 200 | 200 | } |
| 201 | - } |
|
| 202 | - else |
|
| 201 | + } else |
|
| 203 | 202 | { |
| 204 | 203 | $this->deleteLine($lines[$i]); |
| 205 | 204 | } |
@@ -219,8 +218,7 @@ discard block |
||
| 219 | 218 | foreach($lines as $delete) { |
| 220 | 219 | $this->deleteLine($delete); |
| 221 | 220 | } |
| 222 | - } |
|
| 223 | - else |
|
| 221 | + } else |
|
| 224 | 222 | { |
| 225 | 223 | $this->addValueLine($name, $value); |
| 226 | 224 | } |
@@ -258,8 +256,7 @@ discard block |
||
| 258 | 256 | if(empty($lines)) |
| 259 | 257 | { |
| 260 | 258 | $this->addValueLine($name, $value); |
| 261 | - } |
|
| 262 | - else |
|
| 259 | + } else |
|
| 263 | 260 | { |
| 264 | 261 | $found = false; |
| 265 | 262 | |
@@ -17,7 +17,7 @@ discard block |
||
| 17 | 17 | return $this->setOption('separatorChar', $char); |
| 18 | 18 | } |
| 19 | 19 | |
| 20 | - public function setTrailingNewline($useNewline=true) |
|
| 20 | + public function setTrailingNewline($useNewline = true) |
|
| 21 | 21 | { |
| 22 | 22 | return $this->setOption('trailingNewline', $useNewline); |
| 23 | 23 | } |
@@ -38,7 +38,7 @@ discard block |
||
| 38 | 38 | $args = $args[0]; |
| 39 | 39 | } |
| 40 | 40 | |
| 41 | - $this->lines[] = '"' . implode('"'.$this->getOption('separatorChar').'"', $args) . '"'; |
|
| 41 | + $this->lines[] = '"'.implode('"'.$this->getOption('separatorChar').'"', $args).'"'; |
|
| 42 | 42 | |
| 43 | 43 | return $this; |
| 44 | 44 | } |
@@ -54,7 +54,7 @@ discard block |
||
| 54 | 54 | { |
| 55 | 55 | $csv = implode(PHP_EOL, $this->lines); |
| 56 | 56 | |
| 57 | - if($this->getOption('trailingNewline')) { |
|
| 57 | + if ($this->getOption('trailingNewline')) { |
|
| 58 | 58 | $csv .= PHP_EOL; |
| 59 | 59 | } |
| 60 | 60 | |
@@ -65,7 +65,7 @@ discard block |
||
| 65 | 65 | |
| 66 | 66 | public function setOption($name, $value) |
| 67 | 67 | { |
| 68 | - if(!isset($this->options)) { |
|
| 68 | + if (!isset($this->options)) { |
|
| 69 | 69 | $this->options = $this->getDefaultOptions(); |
| 70 | 70 | } |
| 71 | 71 | |
@@ -75,20 +75,20 @@ discard block |
||
| 75 | 75 | |
| 76 | 76 | public function setOptions($options) |
| 77 | 77 | { |
| 78 | - foreach($options as $name => $value) { |
|
| 78 | + foreach ($options as $name => $value) { |
|
| 79 | 79 | $this->setOption($name, $value); |
| 80 | 80 | } |
| 81 | 81 | |
| 82 | 82 | return $this; |
| 83 | 83 | } |
| 84 | 84 | |
| 85 | - public function getOption($name, $default=null) |
|
| 85 | + public function getOption($name, $default = null) |
|
| 86 | 86 | { |
| 87 | - if(!isset($this->options)) { |
|
| 87 | + if (!isset($this->options)) { |
|
| 88 | 88 | $this->options = $this->getDefaultOptions(); |
| 89 | 89 | } |
| 90 | 90 | |
| 91 | - if(isset($this->options[$name])) { |
|
| 91 | + if (isset($this->options[$name])) { |
|
| 92 | 92 | return $this->options[$name]; |
| 93 | 93 | } |
| 94 | 94 | |
@@ -97,7 +97,7 @@ discard block |
||
| 97 | 97 | |
| 98 | 98 | public function hasOption($name) |
| 99 | 99 | { |
| 100 | - if(!isset($this->options)) { |
|
| 100 | + if (!isset($this->options)) { |
|
| 101 | 101 | $this->options = $this->getDefaultOptions(); |
| 102 | 102 | } |
| 103 | 103 | |
@@ -106,7 +106,7 @@ discard block |
||
| 106 | 106 | |
| 107 | 107 | public function getOptions() |
| 108 | 108 | { |
| 109 | - if(!isset($this->options)) { |
|
| 109 | + if (!isset($this->options)) { |
|
| 110 | 110 | $this->options = $this->getDefaultOptions(); |
| 111 | 111 | } |
| 112 | 112 | |
@@ -115,7 +115,7 @@ discard block |
||
| 115 | 115 | |
| 116 | 116 | public function isOption($name, $value) |
| 117 | 117 | { |
| 118 | - if($this->getOption($name) === $value) { |
|
| 118 | + if ($this->getOption($name) === $value) { |
|
| 119 | 119 | return true; |
| 120 | 120 | } |
| 121 | 121 | |
@@ -36,17 +36,17 @@ discard block |
||
| 36 | 36 | |
| 37 | 37 | protected $classes = array(); |
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * The namespace detected in the file, if any. |
|
| 41 | - * @var string |
|
| 42 | - */ |
|
| 39 | + /** |
|
| 40 | + * The namespace detected in the file, if any. |
|
| 41 | + * @var string |
|
| 42 | + */ |
|
| 43 | 43 | protected $namespace = ''; |
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * @param string $path The path to the PHP file to parse. |
|
| 47 | - * @throws FileHelper_Exception |
|
| 48 | - * @see FileHelper::findPHPClasses() |
|
| 49 | - */ |
|
| 45 | + /** |
|
| 46 | + * @param string $path The path to the PHP file to parse. |
|
| 47 | + * @throws FileHelper_Exception |
|
| 48 | + * @see FileHelper::findPHPClasses() |
|
| 49 | + */ |
|
| 50 | 50 | public function __construct(string $path) |
| 51 | 51 | { |
| 52 | 52 | $this->path = realpath($path); |
@@ -66,66 +66,66 @@ discard block |
||
| 66 | 66 | $this->parseFile(); |
| 67 | 67 | } |
| 68 | 68 | |
| 69 | - /** |
|
| 70 | - * The name of the namespace of the classes in the file, if any. |
|
| 71 | - * @return string |
|
| 72 | - */ |
|
| 69 | + /** |
|
| 70 | + * The name of the namespace of the classes in the file, if any. |
|
| 71 | + * @return string |
|
| 72 | + */ |
|
| 73 | 73 | public function getNamespace() : string |
| 74 | 74 | { |
| 75 | 75 | return $this->namespace; |
| 76 | 76 | } |
| 77 | 77 | |
| 78 | - /** |
|
| 79 | - * Whether the file contains a namespace. |
|
| 80 | - * @return bool |
|
| 81 | - */ |
|
| 78 | + /** |
|
| 79 | + * Whether the file contains a namespace. |
|
| 80 | + * @return bool |
|
| 81 | + */ |
|
| 82 | 82 | public function hasNamespace() : bool |
| 83 | 83 | { |
| 84 | 84 | return !empty($this->namespace); |
| 85 | 85 | } |
| 86 | 86 | |
| 87 | - /** |
|
| 88 | - * The absolute path to the file. |
|
| 89 | - * @return string |
|
| 90 | - */ |
|
| 87 | + /** |
|
| 88 | + * The absolute path to the file. |
|
| 89 | + * @return string |
|
| 90 | + */ |
|
| 91 | 91 | public function getPath() : string |
| 92 | 92 | { |
| 93 | 93 | return $this->path; |
| 94 | 94 | } |
| 95 | 95 | |
| 96 | - /** |
|
| 97 | - * Whether any classes were found in the file. |
|
| 98 | - * @return bool |
|
| 99 | - */ |
|
| 96 | + /** |
|
| 97 | + * Whether any classes were found in the file. |
|
| 98 | + * @return bool |
|
| 99 | + */ |
|
| 100 | 100 | public function hasClasses() : bool |
| 101 | 101 | { |
| 102 | 102 | return !empty($this->classes); |
| 103 | 103 | } |
| 104 | 104 | |
| 105 | - /** |
|
| 106 | - * The names of the classes that were found in the file (with namespace if any). |
|
| 107 | - * @return string[] |
|
| 108 | - */ |
|
| 105 | + /** |
|
| 106 | + * The names of the classes that were found in the file (with namespace if any). |
|
| 107 | + * @return string[] |
|
| 108 | + */ |
|
| 109 | 109 | public function getClassNames() : array |
| 110 | 110 | { |
| 111 | 111 | return array_keys($this->classes); |
| 112 | 112 | } |
| 113 | 113 | |
| 114 | - /** |
|
| 115 | - * Retrieves all classes that were detected in the file, |
|
| 116 | - * which can be used to retrieve more information about |
|
| 117 | - * them. |
|
| 118 | - * |
|
| 119 | - * @return FileHelper_PHPClassInfo_Class[] |
|
| 120 | - */ |
|
| 114 | + /** |
|
| 115 | + * Retrieves all classes that were detected in the file, |
|
| 116 | + * which can be used to retrieve more information about |
|
| 117 | + * them. |
|
| 118 | + * |
|
| 119 | + * @return FileHelper_PHPClassInfo_Class[] |
|
| 120 | + */ |
|
| 121 | 121 | public function getClasses() |
| 122 | 122 | { |
| 123 | 123 | return $this->classes; |
| 124 | 124 | } |
| 125 | 125 | |
| 126 | - /** |
|
| 127 | - * @throws FileHelper_Exception |
|
| 128 | - */ |
|
| 126 | + /** |
|
| 127 | + * @throws FileHelper_Exception |
|
| 128 | + */ |
|
| 129 | 129 | protected function parseFile() |
| 130 | 130 | { |
| 131 | 131 | $code = file_get_contents($this->path); |
@@ -180,13 +180,13 @@ discard block |
||
| 180 | 180 | } |
| 181 | 181 | } |
| 182 | 182 | |
| 183 | - /** |
|
| 184 | - * Strips all whitespace from the string, replacing it with |
|
| 185 | - * regular spaces (newlines, tabs, etc.). |
|
| 186 | - * |
|
| 187 | - * @param string $string |
|
| 188 | - * @return string |
|
| 189 | - */ |
|
| 183 | + /** |
|
| 184 | + * Strips all whitespace from the string, replacing it with |
|
| 185 | + * regular spaces (newlines, tabs, etc.). |
|
| 186 | + * |
|
| 187 | + * @param string $string |
|
| 188 | + * @return string |
|
| 189 | + */ |
|
| 190 | 190 | protected function stripWhitespace(string $string) : string |
| 191 | 191 | { |
| 192 | 192 | return preg_replace('/[\s]/', ' ', $string); |
@@ -51,7 +51,7 @@ discard block |
||
| 51 | 51 | { |
| 52 | 52 | $this->path = realpath($path); |
| 53 | 53 | |
| 54 | - if($this->path === false) |
|
| 54 | + if ($this->path === false) |
|
| 55 | 55 | { |
| 56 | 56 | throw new FileHelper_Exception( |
| 57 | 57 | 'Cannot extract file information: file not found.', |
@@ -130,7 +130,7 @@ discard block |
||
| 130 | 130 | { |
| 131 | 131 | $code = file_get_contents($this->path); |
| 132 | 132 | |
| 133 | - if($code === false) |
|
| 133 | + if ($code === false) |
|
| 134 | 134 | { |
| 135 | 135 | throw new FileHelper_Exception( |
| 136 | 136 | 'Cannot open file for parsing.', |
@@ -149,24 +149,24 @@ discard block |
||
| 149 | 149 | |
| 150 | 150 | $result = array(); |
| 151 | 151 | preg_match_all('/namespace[\s]+([^;]+);/six', $code, $result, PREG_PATTERN_ORDER); |
| 152 | - if(isset($result[0]) && isset($result[0][0])) { |
|
| 152 | + if (isset($result[0]) && isset($result[0][0])) { |
|
| 153 | 153 | $this->namespace = trim($result[1][0]); |
| 154 | 154 | } |
| 155 | 155 | |
| 156 | 156 | $result = array(); |
| 157 | 157 | preg_match_all('/(abstract|final)[\s]+class[\s]+([\sa-z0-9\\\\_,]+){|class[\s]+([\sa-z0-9\\\\_,]+){/six', $code, $result, PREG_PATTERN_ORDER); |
| 158 | 158 | |
| 159 | - if(!isset($result[0]) || !isset($result[0][0])) { |
|
| 159 | + if (!isset($result[0]) || !isset($result[0][0])) { |
|
| 160 | 160 | return; |
| 161 | 161 | } |
| 162 | 162 | |
| 163 | 163 | $indexes = array_keys($result[0]); |
| 164 | 164 | |
| 165 | - foreach($indexes as $idx) |
|
| 165 | + foreach ($indexes as $idx) |
|
| 166 | 166 | { |
| 167 | 167 | $keyword = $result[1][$idx]; |
| 168 | 168 | $declaration = $result[2][$idx]; |
| 169 | - if(empty($keyword)) { |
|
| 169 | + if (empty($keyword)) { |
|
| 170 | 170 | $declaration = $result[3][$idx]; |
| 171 | 171 | } |
| 172 | 172 | |
@@ -147,8 +147,7 @@ discard block |
||
| 147 | 147 | if($this->getOption('recursive') === true && !$item->isDot()) { |
| 148 | 148 | $this->find($item->getPathname()); |
| 149 | 149 | } |
| 150 | - } |
|
| 151 | - else |
|
| 150 | + } else |
|
| 152 | 151 | { |
| 153 | 152 | $file = $this->filterFile($item->getPathname()); |
| 154 | 153 | if($file) { |
@@ -172,8 +171,7 @@ discard block |
||
| 172 | 171 | if(!in_array($info['extension'], $include)) { |
| 173 | 172 | return false; |
| 174 | 173 | } |
| 175 | - } |
|
| 176 | - else if(!empty($exclude)) |
|
| 174 | + } else if(!empty($exclude)) |
|
| 177 | 175 | { |
| 178 | 176 | if(in_array($info['extension'], $exclude)) { |
| 179 | 177 | return false; |
@@ -31,9 +31,9 @@ |
||
| 31 | 31 | |
| 32 | 32 | const PATH_MODE_STRIP = 'strip'; |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * @var string |
|
| 36 | - */ |
|
| 34 | + /** |
|
| 35 | + * @var string |
|
| 36 | + */ |
|
| 37 | 37 | protected $path; |
| 38 | 38 | |
| 39 | 39 | public function __construct(string $path) |
@@ -7,7 +7,7 @@ discard block |
||
| 7 | 7 | * @see FileHelper_FileFinder |
| 8 | 8 | */ |
| 9 | 9 | |
| 10 | -declare(strict_types = 1); |
|
| 10 | +declare(strict_types=1); |
|
| 11 | 11 | |
| 12 | 12 | namespace AppUtils; |
| 13 | 13 | |
@@ -125,7 +125,7 @@ discard block |
||
| 125 | 125 | |
| 126 | 126 | public function getAll() : array |
| 127 | 127 | { |
| 128 | - if(!isset($this->found)) { |
|
| 128 | + if (!isset($this->found)) { |
|
| 129 | 129 | $this->find($this->path, true); |
| 130 | 130 | } |
| 131 | 131 | |
@@ -150,25 +150,25 @@ discard block |
||
| 150 | 150 | |
| 151 | 151 | protected $found; |
| 152 | 152 | |
| 153 | - protected function find($path, $isRoot=false) |
|
| 153 | + protected function find($path, $isRoot = false) |
|
| 154 | 154 | { |
| 155 | - if($isRoot) { |
|
| 155 | + if ($isRoot) { |
|
| 156 | 156 | $this->found = array(); |
| 157 | 157 | } |
| 158 | 158 | |
| 159 | 159 | $d = new \DirectoryIterator($path); |
| 160 | - foreach($d as $item) |
|
| 160 | + foreach ($d as $item) |
|
| 161 | 161 | { |
| 162 | - if($item->isDir()) |
|
| 162 | + if ($item->isDir()) |
|
| 163 | 163 | { |
| 164 | - if($this->getOption('recursive') === true && !$item->isDot()) { |
|
| 164 | + if ($this->getOption('recursive') === true && !$item->isDot()) { |
|
| 165 | 165 | $this->find($item->getPathname()); |
| 166 | 166 | } |
| 167 | 167 | } |
| 168 | 168 | else |
| 169 | 169 | { |
| 170 | 170 | $file = $this->filterFile($item->getPathname()); |
| 171 | - if($file) { |
|
| 171 | + if ($file) { |
|
| 172 | 172 | $this->found[] = $file; |
| 173 | 173 | } |
| 174 | 174 | } |
@@ -184,20 +184,20 @@ discard block |
||
| 184 | 184 | $include = $this->getOption('include-extensions'); |
| 185 | 185 | $exclude = $this->getOption('exclude-extensions'); |
| 186 | 186 | |
| 187 | - if(!empty($include)) |
|
| 187 | + if (!empty($include)) |
|
| 188 | 188 | { |
| 189 | - if(!in_array($info['extension'], $include)) { |
|
| 189 | + if (!in_array($info['extension'], $include)) { |
|
| 190 | 190 | return false; |
| 191 | 191 | } |
| 192 | 192 | } |
| 193 | - else if(!empty($exclude)) |
|
| 193 | + else if (!empty($exclude)) |
|
| 194 | 194 | { |
| 195 | - if(in_array($info['extension'], $exclude)) { |
|
| 195 | + if (in_array($info['extension'], $exclude)) { |
|
| 196 | 196 | return false; |
| 197 | 197 | } |
| 198 | 198 | } |
| 199 | 199 | |
| 200 | - switch($this->getOption('pathmode')) |
|
| 200 | + switch ($this->getOption('pathmode')) |
|
| 201 | 201 | { |
| 202 | 202 | case self::PATH_MODE_STRIP: |
| 203 | 203 | $path = basename($path); |
@@ -213,13 +213,13 @@ discard block |
||
| 213 | 213 | break; |
| 214 | 214 | } |
| 215 | 215 | |
| 216 | - if($this->getOption('strip-extensions') === true) |
|
| 216 | + if ($this->getOption('strip-extensions') === true) |
|
| 217 | 217 | { |
| 218 | 218 | $path = str_replace('.'.$info['extension'], '', $path); |
| 219 | 219 | } |
| 220 | 220 | |
| 221 | 221 | $replace = $this->getOption('slash-replacement'); |
| 222 | - if(!empty($replace)) { |
|
| 222 | + if (!empty($replace)) { |
|
| 223 | 223 | $path = str_replace('/', $replace, $path); |
| 224 | 224 | } |
| 225 | 225 | |
@@ -221,7 +221,7 @@ |
||
| 221 | 221 | */ |
| 222 | 222 | public static function getMime($extension) |
| 223 | 223 | { |
| 224 | - if(isset(self::$mimeTypes[$extension])) { |
|
| 224 | + if (isset(self::$mimeTypes[$extension])) { |
|
| 225 | 225 | return self::$mimeTypes[$extension]; |
| 226 | 226 | } |
| 227 | 227 | |
@@ -22,51 +22,51 @@ discard block |
||
| 22 | 22 | */ |
| 23 | 23 | class FileHelper_PHPClassInfo_Class |
| 24 | 24 | { |
| 25 | - /** |
|
| 26 | - * @var FileHelper_PHPClassInfo |
|
| 27 | - */ |
|
| 25 | + /** |
|
| 26 | + * @var FileHelper_PHPClassInfo |
|
| 27 | + */ |
|
| 28 | 28 | protected $info; |
| 29 | 29 | |
| 30 | - /** |
|
| 31 | - * @var bool |
|
| 32 | - */ |
|
| 30 | + /** |
|
| 31 | + * @var bool |
|
| 32 | + */ |
|
| 33 | 33 | protected $abstract = false; |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @var bool |
|
| 37 | - */ |
|
| 35 | + /** |
|
| 36 | + * @var bool |
|
| 37 | + */ |
|
| 38 | 38 | protected $final = false; |
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * @var string |
|
| 42 | - */ |
|
| 40 | + /** |
|
| 41 | + * @var string |
|
| 42 | + */ |
|
| 43 | 43 | protected $extends = ''; |
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * @var string[] |
|
| 47 | - */ |
|
| 45 | + /** |
|
| 46 | + * @var string[] |
|
| 47 | + */ |
|
| 48 | 48 | protected $implements = array(); |
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * @var string |
|
| 52 | - */ |
|
| 50 | + /** |
|
| 51 | + * @var string |
|
| 52 | + */ |
|
| 53 | 53 | protected $name; |
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * @var string |
|
| 57 | - */ |
|
| 55 | + /** |
|
| 56 | + * @var string |
|
| 57 | + */ |
|
| 58 | 58 | protected $declaration; |
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * @var string |
|
| 62 | - */ |
|
| 60 | + /** |
|
| 61 | + * @var string |
|
| 62 | + */ |
|
| 63 | 63 | protected $keyword; |
| 64 | 64 | |
| 65 | - /** |
|
| 66 | - * @param FileHelper_PHPClassInfo $info The class info instance. |
|
| 67 | - * @param string $declaration The full class declaration, e.g. "class SomeName extends SomeOtherClass". |
|
| 68 | - * @param string $keyword The class keyword, if any, i.e. "abstract" or "final". |
|
| 69 | - */ |
|
| 65 | + /** |
|
| 66 | + * @param FileHelper_PHPClassInfo $info The class info instance. |
|
| 67 | + * @param string $declaration The full class declaration, e.g. "class SomeName extends SomeOtherClass". |
|
| 68 | + * @param string $keyword The class keyword, if any, i.e. "abstract" or "final". |
|
| 69 | + */ |
|
| 70 | 70 | public function __construct(FileHelper_PHPClassInfo $info, string $declaration, string $keyword) |
| 71 | 71 | { |
| 72 | 72 | $this->info = $info; |
@@ -76,31 +76,31 @@ discard block |
||
| 76 | 76 | $this->analyzeCode(); |
| 77 | 77 | } |
| 78 | 78 | |
| 79 | - /** |
|
| 80 | - * Check if this class is a subclass of the specified |
|
| 81 | - * class name. |
|
| 82 | - * |
|
| 83 | - * @param string $className |
|
| 84 | - * @return bool |
|
| 85 | - */ |
|
| 79 | + /** |
|
| 80 | + * Check if this class is a subclass of the specified |
|
| 81 | + * class name. |
|
| 82 | + * |
|
| 83 | + * @param string $className |
|
| 84 | + * @return bool |
|
| 85 | + */ |
|
| 86 | 86 | public function isSublassOf(string $className) : bool |
| 87 | 87 | { |
| 88 | 88 | return is_subclass_of($this->getNameNS(), $className); |
| 89 | 89 | } |
| 90 | 90 | |
| 91 | - /** |
|
| 92 | - * The class name without namespace. |
|
| 93 | - * @return string |
|
| 94 | - */ |
|
| 91 | + /** |
|
| 92 | + * The class name without namespace. |
|
| 93 | + * @return string |
|
| 94 | + */ |
|
| 95 | 95 | public function getName() : string |
| 96 | 96 | { |
| 97 | 97 | return $this->name; |
| 98 | 98 | } |
| 99 | 99 | |
| 100 | - /** |
|
| 101 | - * The absolute class name with namespace (if any). |
|
| 102 | - * @return string |
|
| 103 | - */ |
|
| 100 | + /** |
|
| 101 | + * The absolute class name with namespace (if any). |
|
| 102 | + * @return string |
|
| 103 | + */ |
|
| 104 | 104 | public function getNameNS() : string |
| 105 | 105 | { |
| 106 | 106 | $name = $this->getName(); |
@@ -112,48 +112,48 @@ discard block |
||
| 112 | 112 | return $name; |
| 113 | 113 | } |
| 114 | 114 | |
| 115 | - /** |
|
| 116 | - * Whether it is an abstract class. |
|
| 117 | - * @return bool |
|
| 118 | - */ |
|
| 115 | + /** |
|
| 116 | + * Whether it is an abstract class. |
|
| 117 | + * @return bool |
|
| 118 | + */ |
|
| 119 | 119 | public function isAbstract() : bool |
| 120 | 120 | { |
| 121 | 121 | return $this->abstract; |
| 122 | 122 | } |
| 123 | 123 | |
| 124 | - /** |
|
| 125 | - * Whether it is a final class. |
|
| 126 | - * @return bool |
|
| 127 | - */ |
|
| 124 | + /** |
|
| 125 | + * Whether it is a final class. |
|
| 126 | + * @return bool |
|
| 127 | + */ |
|
| 128 | 128 | public function isFinal() : bool |
| 129 | 129 | { |
| 130 | 130 | return $this->final; |
| 131 | 131 | } |
| 132 | 132 | |
| 133 | - /** |
|
| 134 | - * The name of the class that this class extends (with namespace, if specified). |
|
| 135 | - * @return string |
|
| 136 | - */ |
|
| 133 | + /** |
|
| 134 | + * The name of the class that this class extends (with namespace, if specified). |
|
| 135 | + * @return string |
|
| 136 | + */ |
|
| 137 | 137 | public function getExtends() : string |
| 138 | 138 | { |
| 139 | 139 | return $this->extends; |
| 140 | 140 | } |
| 141 | 141 | |
| 142 | - /** |
|
| 143 | - * A list of interfaces the class implements, if any. |
|
| 144 | - * @return array |
|
| 145 | - */ |
|
| 142 | + /** |
|
| 143 | + * A list of interfaces the class implements, if any. |
|
| 144 | + * @return array |
|
| 145 | + */ |
|
| 146 | 146 | public function getImplements() : array |
| 147 | 147 | { |
| 148 | 148 | return $this->implements; |
| 149 | 149 | } |
| 150 | 150 | |
| 151 | - /** |
|
| 152 | - * The class declaration string, with normalized spaces and sorted interface names. |
|
| 153 | - * NOTE: does not include the keyword "abstract" or "final". |
|
| 154 | - * |
|
| 155 | - * @return string |
|
| 156 | - */ |
|
| 151 | + /** |
|
| 152 | + * The class declaration string, with normalized spaces and sorted interface names. |
|
| 153 | + * NOTE: does not include the keyword "abstract" or "final". |
|
| 154 | + * |
|
| 155 | + * @return string |
|
| 156 | + */ |
|
| 157 | 157 | public function getDeclaration() : string |
| 158 | 158 | { |
| 159 | 159 | $parts = array(); |
@@ -173,10 +173,10 @@ discard block |
||
| 173 | 173 | return implode(' ', $parts); |
| 174 | 174 | } |
| 175 | 175 | |
| 176 | - /** |
|
| 177 | - * The keyword before "class", e.g. "abstract". |
|
| 178 | - * @return string |
|
| 179 | - */ |
|
| 176 | + /** |
|
| 177 | + * The keyword before "class", e.g. "abstract". |
|
| 178 | + * @return string |
|
| 179 | + */ |
|
| 180 | 180 | public function getKeyword() : string |
| 181 | 181 | { |
| 182 | 182 | return $this->keyword; |
@@ -105,7 +105,7 @@ discard block |
||
| 105 | 105 | { |
| 106 | 106 | $name = $this->getName(); |
| 107 | 107 | |
| 108 | - if($this->info->hasNamespace()) { |
|
| 108 | + if ($this->info->hasNamespace()) { |
|
| 109 | 109 | $name = $this->info->getNamespace().'\\'.$this->name; |
| 110 | 110 | } |
| 111 | 111 | |
@@ -160,12 +160,12 @@ discard block |
||
| 160 | 160 | $parts[] = 'class'; |
| 161 | 161 | $parts[] = $this->getName(); |
| 162 | 162 | |
| 163 | - if(!empty($this->extends)) { |
|
| 163 | + if (!empty($this->extends)) { |
|
| 164 | 164 | $parts[] = 'extends'; |
| 165 | 165 | $parts[] = $this->extends; |
| 166 | 166 | } |
| 167 | 167 | |
| 168 | - if(!empty($this->implements)) { |
|
| 168 | + if (!empty($this->implements)) { |
|
| 169 | 169 | $parts[] = 'implements'; |
| 170 | 170 | $parts[] = implode(', ', $this->implements); |
| 171 | 171 | } |
@@ -184,9 +184,9 @@ discard block |
||
| 184 | 184 | |
| 185 | 185 | protected function analyzeCode() |
| 186 | 186 | { |
| 187 | - if($this->keyword == 'abstract') { |
|
| 187 | + if ($this->keyword == 'abstract') { |
|
| 188 | 188 | $this->abstract = true; |
| 189 | - } else if($this->keyword == 'final') { |
|
| 189 | + } else if ($this->keyword == 'final') { |
|
| 190 | 190 | $this->final = true; |
| 191 | 191 | } |
| 192 | 192 | |
@@ -203,16 +203,16 @@ discard block |
||
| 203 | 203 | |
| 204 | 204 | $tokenName = 'none'; |
| 205 | 205 | |
| 206 | - foreach($parts as $part) |
|
| 206 | + foreach ($parts as $part) |
|
| 207 | 207 | { |
| 208 | 208 | $part = str_replace(',', '', $part); |
| 209 | 209 | $part = trim($part); |
| 210 | - if(empty($part)) { |
|
| 210 | + if (empty($part)) { |
|
| 211 | 211 | continue; |
| 212 | 212 | } |
| 213 | 213 | |
| 214 | 214 | $name = strtolower($part); |
| 215 | - if($name == 'extends' || $name == 'implements') { |
|
| 215 | + if ($name == 'extends' || $name == 'implements') { |
|
| 216 | 216 | $tokenName = $name; |
| 217 | 217 | continue; |
| 218 | 218 | } |
@@ -222,13 +222,13 @@ discard block |
||
| 222 | 222 | |
| 223 | 223 | $this->implements = $tokens['implements']; |
| 224 | 224 | |
| 225 | - if(!empty($this->implements)) { |
|
| 225 | + if (!empty($this->implements)) { |
|
| 226 | 226 | usort($this->implements, function(string $a, string $b) { |
| 227 | 227 | return strnatcasecmp($a, $b); |
| 228 | 228 | }); |
| 229 | 229 | } |
| 230 | 230 | |
| 231 | - if(!empty($tokens['extends'])) { |
|
| 231 | + if (!empty($tokens['extends'])) { |
|
| 232 | 232 | $this->extends = $tokens['extends'][0]; |
| 233 | 233 | } |
| 234 | 234 | } |
@@ -18,23 +18,23 @@ discard block |
||
| 18 | 18 | |
| 19 | 19 | public function __construct(array $size) |
| 20 | 20 | { |
| 21 | - if(!isset($size['width'])) { |
|
| 21 | + if (!isset($size['width'])) { |
|
| 22 | 22 | $size['width'] = $size[0]; |
| 23 | 23 | } |
| 24 | 24 | |
| 25 | - if(!isset($size['height'])) { |
|
| 25 | + if (!isset($size['height'])) { |
|
| 26 | 26 | $size['height'] = $size[1]; |
| 27 | 27 | } |
| 28 | 28 | |
| 29 | - if(!isset($size[0])) { |
|
| 29 | + if (!isset($size[0])) { |
|
| 30 | 30 | $size[0] = $size['width']; |
| 31 | 31 | } |
| 32 | 32 | |
| 33 | - if(!isset($size[1])) { |
|
| 33 | + if (!isset($size[1])) { |
|
| 34 | 34 | $size[1] = $size['height']; |
| 35 | 35 | } |
| 36 | 36 | |
| 37 | - if(!isset($size['channels'])) { |
|
| 37 | + if (!isset($size['channels'])) { |
|
| 38 | 38 | $size['channels'] = 1; |
| 39 | 39 | } |
| 40 | 40 | |
@@ -68,7 +68,7 @@ discard block |
||
| 68 | 68 | |
| 69 | 69 | public function offsetGet($offset) |
| 70 | 70 | { |
| 71 | - if(isset($this->size[$offset])) { |
|
| 71 | + if (isset($this->size[$offset])) { |
|
| 72 | 72 | return $this->size[$offset]; |
| 73 | 73 | } |
| 74 | 74 | |
@@ -77,7 +77,7 @@ discard block |
||
| 77 | 77 | |
| 78 | 78 | public function offsetSet($offset, $value) |
| 79 | 79 | { |
| 80 | - if(is_null($offset)) { |
|
| 80 | + if (is_null($offset)) { |
|
| 81 | 81 | $this->size[] = $value; |
| 82 | 82 | } else { |
| 83 | 83 | $this->size[$offset] = $value; |
@@ -197,8 +197,7 @@ discard block |
||
| 197 | 197 | if ($item->isDir()) |
| 198 | 198 | { |
| 199 | 199 | FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target . '/' . $baseName); |
| 200 | - } |
|
| 201 | - else if($item->isFile()) |
|
| 200 | + } else if($item->isFile()) |
|
| 202 | 201 | { |
| 203 | 202 | self::copyFile($itemPath, $target . '/' . $baseName); |
| 204 | 203 | } |
@@ -242,8 +241,7 @@ discard block |
||
| 242 | 241 | if(!file_exists($targetFolder)) |
| 243 | 242 | { |
| 244 | 243 | self::createFolder($targetFolder); |
| 245 | - } |
|
| 246 | - else if(!is_writable($targetFolder)) |
|
| 244 | + } else if(!is_writable($targetFolder)) |
|
| 247 | 245 | { |
| 248 | 246 | throw new FileHelper_Exception( |
| 249 | 247 | sprintf('Target folder [%s] is not writable.', basename($targetFolder)), |
@@ -80,32 +80,32 @@ discard block |
||
| 80 | 80 | |
| 81 | 81 | const ERROR_CANNOT_OPEN_FILE_TO_DETECT_BOM = 340032; |
| 82 | 82 | |
| 83 | - /** |
|
| 84 | - * Opens a serialized file and returns the unserialized data. |
|
| 85 | - * |
|
| 86 | - * @param string $file |
|
| 87 | - * @throws FileHelper_Exception |
|
| 88 | - * @return array |
|
| 89 | - * @deprecated Use parseSerializedFile() instead. |
|
| 90 | - * @see FileHelper::parseSerializedFile() |
|
| 91 | - */ |
|
| 83 | + /** |
|
| 84 | + * Opens a serialized file and returns the unserialized data. |
|
| 85 | + * |
|
| 86 | + * @param string $file |
|
| 87 | + * @throws FileHelper_Exception |
|
| 88 | + * @return array |
|
| 89 | + * @deprecated Use parseSerializedFile() instead. |
|
| 90 | + * @see FileHelper::parseSerializedFile() |
|
| 91 | + */ |
|
| 92 | 92 | public static function openUnserialized(string $file) : array |
| 93 | 93 | { |
| 94 | 94 | return self::parseSerializedFile($file); |
| 95 | 95 | } |
| 96 | 96 | |
| 97 | - /** |
|
| 98 | - * Opens a serialized file and returns the unserialized data. |
|
| 99 | - * |
|
| 100 | - * @param string $file |
|
| 101 | - * @throws FileHelper_Exception |
|
| 102 | - * @return array |
|
| 103 | - * @see FileHelper::parseSerializedFile() |
|
| 104 | - * |
|
| 105 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 106 | - * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ |
|
| 107 | - * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED |
|
| 108 | - */ |
|
| 97 | + /** |
|
| 98 | + * Opens a serialized file and returns the unserialized data. |
|
| 99 | + * |
|
| 100 | + * @param string $file |
|
| 101 | + * @throws FileHelper_Exception |
|
| 102 | + * @return array |
|
| 103 | + * @see FileHelper::parseSerializedFile() |
|
| 104 | + * |
|
| 105 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 106 | + * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ |
|
| 107 | + * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED |
|
| 108 | + */ |
|
| 109 | 109 | public static function parseSerializedFile(string $file) |
| 110 | 110 | { |
| 111 | 111 | self::requireFileExists($file); |
@@ -174,13 +174,13 @@ discard block |
||
| 174 | 174 | return rmdir($rootFolder); |
| 175 | 175 | } |
| 176 | 176 | |
| 177 | - /** |
|
| 178 | - * Create a folder, if it does not exist yet. |
|
| 179 | - * |
|
| 180 | - * @param string $path |
|
| 181 | - * @throws FileHelper_Exception |
|
| 182 | - * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
| 183 | - */ |
|
| 177 | + /** |
|
| 178 | + * Create a folder, if it does not exist yet. |
|
| 179 | + * |
|
| 180 | + * @param string $path |
|
| 181 | + * @throws FileHelper_Exception |
|
| 182 | + * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
| 183 | + */ |
|
| 184 | 184 | public static function createFolder($path) |
| 185 | 185 | { |
| 186 | 186 | if(is_dir($path) || mkdir($path, 0777, true)) { |
@@ -227,22 +227,22 @@ discard block |
||
| 227 | 227 | } |
| 228 | 228 | } |
| 229 | 229 | |
| 230 | - /** |
|
| 231 | - * Copies a file to the target location. Includes checks |
|
| 232 | - * for most error sources, like the source file not being |
|
| 233 | - * readable. Automatically creates the target folder if it |
|
| 234 | - * does not exist yet. |
|
| 235 | - * |
|
| 236 | - * @param string $sourcePath |
|
| 237 | - * @param string $targetPath |
|
| 238 | - * @throws FileHelper_Exception |
|
| 239 | - * |
|
| 240 | - * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
| 241 | - * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND |
|
| 242 | - * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE |
|
| 243 | - * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE |
|
| 244 | - * @see FileHelper::ERROR_CANNOT_COPY_FILE |
|
| 245 | - */ |
|
| 230 | + /** |
|
| 231 | + * Copies a file to the target location. Includes checks |
|
| 232 | + * for most error sources, like the source file not being |
|
| 233 | + * readable. Automatically creates the target folder if it |
|
| 234 | + * does not exist yet. |
|
| 235 | + * |
|
| 236 | + * @param string $sourcePath |
|
| 237 | + * @param string $targetPath |
|
| 238 | + * @throws FileHelper_Exception |
|
| 239 | + * |
|
| 240 | + * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER |
|
| 241 | + * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND |
|
| 242 | + * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE |
|
| 243 | + * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE |
|
| 244 | + * @see FileHelper::ERROR_CANNOT_COPY_FILE |
|
| 245 | + */ |
|
| 246 | 246 | public static function copyFile($sourcePath, $targetPath) |
| 247 | 247 | { |
| 248 | 248 | self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND); |
@@ -293,15 +293,15 @@ discard block |
||
| 293 | 293 | ); |
| 294 | 294 | } |
| 295 | 295 | |
| 296 | - /** |
|
| 297 | - * Deletes the target file. Ignored if it cannot be found, |
|
| 298 | - * and throws an exception if it fails. |
|
| 299 | - * |
|
| 300 | - * @param string $filePath |
|
| 301 | - * @throws FileHelper_Exception |
|
| 302 | - * |
|
| 303 | - * @see FileHelper::ERROR_CANNOT_DELETE_FILE |
|
| 304 | - */ |
|
| 296 | + /** |
|
| 297 | + * Deletes the target file. Ignored if it cannot be found, |
|
| 298 | + * and throws an exception if it fails. |
|
| 299 | + * |
|
| 300 | + * @param string $filePath |
|
| 301 | + * @throws FileHelper_Exception |
|
| 302 | + * |
|
| 303 | + * @see FileHelper::ERROR_CANNOT_DELETE_FILE |
|
| 304 | + */ |
|
| 305 | 305 | public static function deleteFile(string $filePath) : void |
| 306 | 306 | { |
| 307 | 307 | if(!file_exists($filePath)) { |
@@ -323,15 +323,15 @@ discard block |
||
| 323 | 323 | } |
| 324 | 324 | |
| 325 | 325 | /** |
| 326 | - * Creates a new CSV parser instance and returns it. |
|
| 327 | - * |
|
| 328 | - * @param string $delimiter |
|
| 329 | - * @param string $enclosure |
|
| 330 | - * @param string $escape |
|
| 331 | - * @param bool $heading |
|
| 332 | - * @return \parseCSV |
|
| 333 | - * @todo Move this to the CSV helper. |
|
| 334 | - */ |
|
| 326 | + * Creates a new CSV parser instance and returns it. |
|
| 327 | + * |
|
| 328 | + * @param string $delimiter |
|
| 329 | + * @param string $enclosure |
|
| 330 | + * @param string $escape |
|
| 331 | + * @param bool $heading |
|
| 332 | + * @return \parseCSV |
|
| 333 | + * @todo Move this to the CSV helper. |
|
| 334 | + */ |
|
| 335 | 335 | public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : \parseCSV |
| 336 | 336 | { |
| 337 | 337 | if($delimiter==='') { $delimiter = ';'; } |
@@ -346,23 +346,23 @@ discard block |
||
| 346 | 346 | return $parser; |
| 347 | 347 | } |
| 348 | 348 | |
| 349 | - /** |
|
| 350 | - * Parses all lines in the specified string and returns an |
|
| 351 | - * indexed array with all csv values in each line. |
|
| 352 | - * |
|
| 353 | - * @param string $csv |
|
| 354 | - * @param string $delimiter |
|
| 355 | - * @param string $enclosure |
|
| 356 | - * @param string $escape |
|
| 357 | - * @param bool $heading |
|
| 358 | - * @return array |
|
| 359 | - * @throws FileHelper_Exception |
|
| 360 | - * |
|
| 361 | - * @todo Move this to the CSVHelper. |
|
| 362 | - * |
|
| 363 | - * @see parseCSVFile() |
|
| 364 | - * @see FileHelper::ERROR_PARSING_CSV |
|
| 365 | - */ |
|
| 349 | + /** |
|
| 350 | + * Parses all lines in the specified string and returns an |
|
| 351 | + * indexed array with all csv values in each line. |
|
| 352 | + * |
|
| 353 | + * @param string $csv |
|
| 354 | + * @param string $delimiter |
|
| 355 | + * @param string $enclosure |
|
| 356 | + * @param string $escape |
|
| 357 | + * @param bool $heading |
|
| 358 | + * @return array |
|
| 359 | + * @throws FileHelper_Exception |
|
| 360 | + * |
|
| 361 | + * @todo Move this to the CSVHelper. |
|
| 362 | + * |
|
| 363 | + * @see parseCSVFile() |
|
| 364 | + * @see FileHelper::ERROR_PARSING_CSV |
|
| 365 | + */ |
|
| 366 | 366 | public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array |
| 367 | 367 | { |
| 368 | 368 | $parser = self::createCSVParser($delimiter, $enclosure, $escape, $heading); |
@@ -541,31 +541,31 @@ discard block |
||
| 541 | 541 | ); |
| 542 | 542 | } |
| 543 | 543 | |
| 544 | - /** |
|
| 545 | - * Verifies whether the target file is a PHP file. The path |
|
| 546 | - * to the file can be a path to a file as a string, or a |
|
| 547 | - * DirectoryIterator object instance. |
|
| 548 | - * |
|
| 549 | - * @param string|\DirectoryIterator $pathOrDirIterator |
|
| 550 | - * @return boolean |
|
| 551 | - */ |
|
| 544 | + /** |
|
| 545 | + * Verifies whether the target file is a PHP file. The path |
|
| 546 | + * to the file can be a path to a file as a string, or a |
|
| 547 | + * DirectoryIterator object instance. |
|
| 548 | + * |
|
| 549 | + * @param string|\DirectoryIterator $pathOrDirIterator |
|
| 550 | + * @return boolean |
|
| 551 | + */ |
|
| 552 | 552 | public static function isPHPFile($pathOrDirIterator) |
| 553 | 553 | { |
| 554 | - if(self::getExtension($pathOrDirIterator) == 'php') { |
|
| 555 | - return true; |
|
| 556 | - } |
|
| 554 | + if(self::getExtension($pathOrDirIterator) == 'php') { |
|
| 555 | + return true; |
|
| 556 | + } |
|
| 557 | 557 | |
| 558 | - return false; |
|
| 558 | + return false; |
|
| 559 | 559 | } |
| 560 | 560 | |
| 561 | - /** |
|
| 562 | - * Retrieves the extension of the specified file. Can be a path |
|
| 563 | - * to a file as a string, or a DirectoryIterator object instance. |
|
| 564 | - * |
|
| 565 | - * @param string|\DirectoryIterator $pathOrDirIterator |
|
| 566 | - * @param bool $lowercase |
|
| 567 | - * @return string |
|
| 568 | - */ |
|
| 561 | + /** |
|
| 562 | + * Retrieves the extension of the specified file. Can be a path |
|
| 563 | + * to a file as a string, or a DirectoryIterator object instance. |
|
| 564 | + * |
|
| 565 | + * @param string|\DirectoryIterator $pathOrDirIterator |
|
| 566 | + * @param bool $lowercase |
|
| 567 | + * @return string |
|
| 568 | + */ |
|
| 569 | 569 | public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string |
| 570 | 570 | { |
| 571 | 571 | if($pathOrDirIterator instanceof \DirectoryIterator) { |
@@ -576,51 +576,51 @@ discard block |
||
| 576 | 576 | |
| 577 | 577 | $ext = pathinfo($filename, PATHINFO_EXTENSION); |
| 578 | 578 | if($lowercase) { |
| 579 | - $ext = mb_strtolower($ext); |
|
| 579 | + $ext = mb_strtolower($ext); |
|
| 580 | 580 | } |
| 581 | 581 | |
| 582 | 582 | return $ext; |
| 583 | 583 | } |
| 584 | 584 | |
| 585 | - /** |
|
| 586 | - * Retrieves the file name from a path, with or without extension. |
|
| 587 | - * The path to the file can be a string, or a DirectoryIterator object |
|
| 588 | - * instance. |
|
| 589 | - * |
|
| 590 | - * In case of folders, behaves like the pathinfo function: returns |
|
| 591 | - * the name of the folder. |
|
| 592 | - * |
|
| 593 | - * @param string|\DirectoryIterator $pathOrDirIterator |
|
| 594 | - * @param bool $extension |
|
| 595 | - * @return string |
|
| 596 | - */ |
|
| 585 | + /** |
|
| 586 | + * Retrieves the file name from a path, with or without extension. |
|
| 587 | + * The path to the file can be a string, or a DirectoryIterator object |
|
| 588 | + * instance. |
|
| 589 | + * |
|
| 590 | + * In case of folders, behaves like the pathinfo function: returns |
|
| 591 | + * the name of the folder. |
|
| 592 | + * |
|
| 593 | + * @param string|\DirectoryIterator $pathOrDirIterator |
|
| 594 | + * @param bool $extension |
|
| 595 | + * @return string |
|
| 596 | + */ |
|
| 597 | 597 | public static function getFilename($pathOrDirIterator, $extension = true) |
| 598 | 598 | { |
| 599 | 599 | $path = $pathOrDirIterator; |
| 600 | - if($pathOrDirIterator instanceof \DirectoryIterator) { |
|
| 601 | - $path = $pathOrDirIterator->getFilename(); |
|
| 602 | - } |
|
| 600 | + if($pathOrDirIterator instanceof \DirectoryIterator) { |
|
| 601 | + $path = $pathOrDirIterator->getFilename(); |
|
| 602 | + } |
|
| 603 | 603 | |
| 604 | - $path = self::normalizePath($path); |
|
| 604 | + $path = self::normalizePath($path); |
|
| 605 | 605 | |
| 606 | - if(!$extension) { |
|
| 607 | - return pathinfo($path, PATHINFO_FILENAME); |
|
| 608 | - } |
|
| 606 | + if(!$extension) { |
|
| 607 | + return pathinfo($path, PATHINFO_FILENAME); |
|
| 608 | + } |
|
| 609 | 609 | |
| 610 | - return pathinfo($path, PATHINFO_BASENAME); |
|
| 610 | + return pathinfo($path, PATHINFO_BASENAME); |
|
| 611 | 611 | } |
| 612 | 612 | |
| 613 | - /** |
|
| 614 | - * Tries to read the contents of the target file and |
|
| 615 | - * treat it as JSON to return the decoded JSON data. |
|
| 616 | - * |
|
| 617 | - * @param string $file |
|
| 618 | - * @throws FileHelper_Exception |
|
| 619 | - * @return array |
|
| 620 | - * |
|
| 621 | - * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE |
|
| 622 | - * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE |
|
| 623 | - */ |
|
| 613 | + /** |
|
| 614 | + * Tries to read the contents of the target file and |
|
| 615 | + * treat it as JSON to return the decoded JSON data. |
|
| 616 | + * |
|
| 617 | + * @param string $file |
|
| 618 | + * @throws FileHelper_Exception |
|
| 619 | + * @return array |
|
| 620 | + * |
|
| 621 | + * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE |
|
| 622 | + * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE |
|
| 623 | + */ |
|
| 624 | 624 | public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null) |
| 625 | 625 | { |
| 626 | 626 | self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE); |
@@ -656,16 +656,16 @@ discard block |
||
| 656 | 656 | return $json; |
| 657 | 657 | } |
| 658 | 658 | |
| 659 | - /** |
|
| 660 | - * Corrects common formatting mistakes when users enter |
|
| 661 | - * file names, like too many spaces, dots and the like. |
|
| 662 | - * |
|
| 663 | - * NOTE: if the file name contains a path, the path is |
|
| 664 | - * stripped, leaving only the file name. |
|
| 665 | - * |
|
| 666 | - * @param string $name |
|
| 667 | - * @return string |
|
| 668 | - */ |
|
| 659 | + /** |
|
| 660 | + * Corrects common formatting mistakes when users enter |
|
| 661 | + * file names, like too many spaces, dots and the like. |
|
| 662 | + * |
|
| 663 | + * NOTE: if the file name contains a path, the path is |
|
| 664 | + * stripped, leaving only the file name. |
|
| 665 | + * |
|
| 666 | + * @param string $name |
|
| 667 | + * @return string |
|
| 668 | + */ |
|
| 669 | 669 | public static function fixFileName(string $name) : string |
| 670 | 670 | { |
| 671 | 671 | $name = trim($name); |
@@ -695,60 +695,60 @@ discard block |
||
| 695 | 695 | return $name; |
| 696 | 696 | } |
| 697 | 697 | |
| 698 | - /** |
|
| 699 | - * Creates an instance of the file finder, which is an easier |
|
| 700 | - * alternative to the other manual findFile methods, since all |
|
| 701 | - * options can be set by chaining. |
|
| 702 | - * |
|
| 703 | - * @param string $path |
|
| 704 | - * @return FileHelper_FileFinder |
|
| 705 | - */ |
|
| 698 | + /** |
|
| 699 | + * Creates an instance of the file finder, which is an easier |
|
| 700 | + * alternative to the other manual findFile methods, since all |
|
| 701 | + * options can be set by chaining. |
|
| 702 | + * |
|
| 703 | + * @param string $path |
|
| 704 | + * @return FileHelper_FileFinder |
|
| 705 | + */ |
|
| 706 | 706 | public static function createFileFinder(string $path) : FileHelper_FileFinder |
| 707 | 707 | { |
| 708 | 708 | return new FileHelper_FileFinder($path); |
| 709 | 709 | } |
| 710 | 710 | |
| 711 | - /** |
|
| 712 | - * Searches for all HTML files in the target folder. |
|
| 713 | - * |
|
| 714 | - * @param string $targetFolder |
|
| 715 | - * @param array $options |
|
| 716 | - * @return array An indexed array with files. |
|
| 717 | - * @see FileHelper::createFileFinder() |
|
| 718 | - * |
|
| 719 | - * @todo Convert this to use the file finder. |
|
| 720 | - */ |
|
| 711 | + /** |
|
| 712 | + * Searches for all HTML files in the target folder. |
|
| 713 | + * |
|
| 714 | + * @param string $targetFolder |
|
| 715 | + * @param array $options |
|
| 716 | + * @return array An indexed array with files. |
|
| 717 | + * @see FileHelper::createFileFinder() |
|
| 718 | + * |
|
| 719 | + * @todo Convert this to use the file finder. |
|
| 720 | + */ |
|
| 721 | 721 | public static function findHTMLFiles(string $targetFolder, array $options=array()) : array |
| 722 | 722 | { |
| 723 | 723 | return self::findFiles($targetFolder, array('html'), $options); |
| 724 | 724 | } |
| 725 | 725 | |
| 726 | - /** |
|
| 727 | - * Searches for all PHP files in the target folder. |
|
| 728 | - * |
|
| 729 | - * @param string $targetFolder |
|
| 730 | - * @param array $options |
|
| 731 | - * @return array An indexed array of PHP files. |
|
| 732 | - * @see FileHelper::createFileFinder() |
|
| 733 | - * |
|
| 734 | - * @todo Convert this to use the file finder. |
|
| 735 | - */ |
|
| 726 | + /** |
|
| 727 | + * Searches for all PHP files in the target folder. |
|
| 728 | + * |
|
| 729 | + * @param string $targetFolder |
|
| 730 | + * @param array $options |
|
| 731 | + * @return array An indexed array of PHP files. |
|
| 732 | + * @see FileHelper::createFileFinder() |
|
| 733 | + * |
|
| 734 | + * @todo Convert this to use the file finder. |
|
| 735 | + */ |
|
| 736 | 736 | public static function findPHPFiles(string $targetFolder, array $options=array()) : array |
| 737 | 737 | { |
| 738 | 738 | return self::findFiles($targetFolder, array('php'), $options); |
| 739 | 739 | } |
| 740 | 740 | |
| 741 | - /** |
|
| 742 | - * |
|
| 743 | - * @param string $targetFolder |
|
| 744 | - * @param array $extensions |
|
| 745 | - * @param array $options |
|
| 746 | - * @param array $files |
|
| 747 | - * @throws FileHelper_Exception |
|
| 748 | - * @return array |
|
| 749 | - * @see FileHelper::createFileFinder() |
|
| 750 | - * @todo Convert this to use the file finder. |
|
| 751 | - */ |
|
| 741 | + /** |
|
| 742 | + * |
|
| 743 | + * @param string $targetFolder |
|
| 744 | + * @param array $extensions |
|
| 745 | + * @param array $options |
|
| 746 | + * @param array $files |
|
| 747 | + * @throws FileHelper_Exception |
|
| 748 | + * @return array |
|
| 749 | + * @see FileHelper::createFileFinder() |
|
| 750 | + * @todo Convert this to use the file finder. |
|
| 751 | + */ |
|
| 752 | 752 | public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array |
| 753 | 753 | { |
| 754 | 754 | if(!isset($options['strip-extension'])) { |
@@ -829,13 +829,13 @@ discard block |
||
| 829 | 829 | return $files; |
| 830 | 830 | } |
| 831 | 831 | |
| 832 | - /** |
|
| 833 | - * Removes the extension from the specified path or file name, |
|
| 834 | - * if any, and returns the name without the extension. |
|
| 835 | - * |
|
| 836 | - * @param string $filename |
|
| 837 | - * @return sTring |
|
| 838 | - */ |
|
| 832 | + /** |
|
| 833 | + * Removes the extension from the specified path or file name, |
|
| 834 | + * if any, and returns the name without the extension. |
|
| 835 | + * |
|
| 836 | + * @param string $filename |
|
| 837 | + * @return sTring |
|
| 838 | + */ |
|
| 839 | 839 | public static function removeExtension(string $filename) : string |
| 840 | 840 | { |
| 841 | 841 | // normalize paths to allow windows style slashes even on nix servers |
@@ -844,22 +844,22 @@ discard block |
||
| 844 | 844 | return pathinfo($filename, PATHINFO_FILENAME); |
| 845 | 845 | } |
| 846 | 846 | |
| 847 | - /** |
|
| 848 | - * Detects the UTF BOM in the target file, if any. Returns |
|
| 849 | - * the encoding matching the BOM, which can be any of the |
|
| 850 | - * following: |
|
| 851 | - * |
|
| 852 | - * <ul> |
|
| 853 | - * <li>UTF32-BE</li> |
|
| 854 | - * <li>UTF32-LE</li> |
|
| 855 | - * <li>UTF16-BE</li> |
|
| 856 | - * <li>UTF16-LE</li> |
|
| 857 | - * <li>UTF8</li> |
|
| 858 | - * </ul> |
|
| 859 | - * |
|
| 860 | - * @param string $filename |
|
| 861 | - * @return string|NULL |
|
| 862 | - */ |
|
| 847 | + /** |
|
| 848 | + * Detects the UTF BOM in the target file, if any. Returns |
|
| 849 | + * the encoding matching the BOM, which can be any of the |
|
| 850 | + * following: |
|
| 851 | + * |
|
| 852 | + * <ul> |
|
| 853 | + * <li>UTF32-BE</li> |
|
| 854 | + * <li>UTF32-LE</li> |
|
| 855 | + * <li>UTF16-BE</li> |
|
| 856 | + * <li>UTF16-LE</li> |
|
| 857 | + * <li>UTF8</li> |
|
| 858 | + * </ul> |
|
| 859 | + * |
|
| 860 | + * @param string $filename |
|
| 861 | + * @return string|NULL |
|
| 862 | + */ |
|
| 863 | 863 | public static function detectUTFBom(string $filename) : ?string |
| 864 | 864 | { |
| 865 | 865 | $fp = fopen($filename, 'r'); |
@@ -891,13 +891,13 @@ discard block |
||
| 891 | 891 | |
| 892 | 892 | protected static $utfBoms; |
| 893 | 893 | |
| 894 | - /** |
|
| 895 | - * Retrieves a list of all UTF byte order mark character |
|
| 896 | - * sequences, as an assocative array with UTF encoding => bom sequence |
|
| 897 | - * pairs. |
|
| 898 | - * |
|
| 899 | - * @return array |
|
| 900 | - */ |
|
| 894 | + /** |
|
| 895 | + * Retrieves a list of all UTF byte order mark character |
|
| 896 | + * sequences, as an assocative array with UTF encoding => bom sequence |
|
| 897 | + * pairs. |
|
| 898 | + * |
|
| 899 | + * @return array |
|
| 900 | + */ |
|
| 901 | 901 | public static function getUTFBOMs() |
| 902 | 902 | { |
| 903 | 903 | if(!isset(self::$utfBoms)) { |
@@ -913,15 +913,15 @@ discard block |
||
| 913 | 913 | return self::$utfBoms; |
| 914 | 914 | } |
| 915 | 915 | |
| 916 | - /** |
|
| 917 | - * Checks whether the specified encoding is a valid |
|
| 918 | - * unicode encoding, for example "UTF16-LE" or "UTF8". |
|
| 919 | - * Also accounts for alternate way to write the, like |
|
| 920 | - * "UTF-8", and omitting little/big endian suffixes. |
|
| 921 | - * |
|
| 922 | - * @param string $encoding |
|
| 923 | - * @return boolean |
|
| 924 | - */ |
|
| 916 | + /** |
|
| 917 | + * Checks whether the specified encoding is a valid |
|
| 918 | + * unicode encoding, for example "UTF16-LE" or "UTF8". |
|
| 919 | + * Also accounts for alternate way to write the, like |
|
| 920 | + * "UTF-8", and omitting little/big endian suffixes. |
|
| 921 | + * |
|
| 922 | + * @param string $encoding |
|
| 923 | + * @return boolean |
|
| 924 | + */ |
|
| 925 | 925 | public static function isValidUnicodeEncoding(string $encoding) : bool |
| 926 | 926 | { |
| 927 | 927 | $encodings = self::getKnownUnicodeEncodings(); |
@@ -940,22 +940,22 @@ discard block |
||
| 940 | 940 | return in_array($encoding, $keep); |
| 941 | 941 | } |
| 942 | 942 | |
| 943 | - /** |
|
| 944 | - * Retrieves a list of all known unicode file encodings. |
|
| 945 | - * @return array |
|
| 946 | - */ |
|
| 943 | + /** |
|
| 944 | + * Retrieves a list of all known unicode file encodings. |
|
| 945 | + * @return array |
|
| 946 | + */ |
|
| 947 | 947 | public static function getKnownUnicodeEncodings() |
| 948 | 948 | { |
| 949 | 949 | return array_keys(self::getUTFBOMs()); |
| 950 | 950 | } |
| 951 | 951 | |
| 952 | - /** |
|
| 953 | - * Normalizes the slash style in a file or folder path, |
|
| 954 | - * by replacing any antislashes with forward slashes. |
|
| 955 | - * |
|
| 956 | - * @param string $path |
|
| 957 | - * @return string |
|
| 958 | - */ |
|
| 952 | + /** |
|
| 953 | + * Normalizes the slash style in a file or folder path, |
|
| 954 | + * by replacing any antislashes with forward slashes. |
|
| 955 | + * |
|
| 956 | + * @param string $path |
|
| 957 | + * @return string |
|
| 958 | + */ |
|
| 959 | 959 | public static function normalizePath(string $path) : string |
| 960 | 960 | { |
| 961 | 961 | return str_replace(array('\\', '//'), array('/', '/'), $path); |
@@ -988,18 +988,18 @@ discard block |
||
| 988 | 988 | } |
| 989 | 989 | } |
| 990 | 990 | |
| 991 | - /** |
|
| 992 | - * Saves the specified content to the target file, creating |
|
| 993 | - * the file and the folder as necessary. |
|
| 994 | - * |
|
| 995 | - * @param string $filePath |
|
| 996 | - * @param string $content |
|
| 997 | - * @throws FileHelper_Exception |
|
| 998 | - * |
|
| 999 | - * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
| 1000 | - * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
| 1001 | - * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
| 1002 | - */ |
|
| 991 | + /** |
|
| 992 | + * Saves the specified content to the target file, creating |
|
| 993 | + * the file and the folder as necessary. |
|
| 994 | + * |
|
| 995 | + * @param string $filePath |
|
| 996 | + * @param string $content |
|
| 997 | + * @throws FileHelper_Exception |
|
| 998 | + * |
|
| 999 | + * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
| 1000 | + * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
| 1001 | + * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
| 1002 | + */ |
|
| 1003 | 1003 | public static function saveFile(string $filePath, string $content='') : void |
| 1004 | 1004 | { |
| 1005 | 1005 | // target file already exists |
@@ -1052,12 +1052,12 @@ discard block |
||
| 1052 | 1052 | ); |
| 1053 | 1053 | } |
| 1054 | 1054 | |
| 1055 | - /** |
|
| 1056 | - * Checks whether it is possible to run PHP command |
|
| 1057 | - * line commands. |
|
| 1058 | - * |
|
| 1059 | - * @return boolean |
|
| 1060 | - */ |
|
| 1055 | + /** |
|
| 1056 | + * Checks whether it is possible to run PHP command |
|
| 1057 | + * line commands. |
|
| 1058 | + * |
|
| 1059 | + * @return boolean |
|
| 1060 | + */ |
|
| 1061 | 1061 | public static function canMakePHPCalls() : bool |
| 1062 | 1062 | { |
| 1063 | 1063 | return self::cliCommandExists('php'); |
@@ -1132,16 +1132,16 @@ discard block |
||
| 1132 | 1132 | return $result; |
| 1133 | 1133 | } |
| 1134 | 1134 | |
| 1135 | - /** |
|
| 1136 | - * Validates a PHP file's syntax. |
|
| 1137 | - * |
|
| 1138 | - * NOTE: This will fail silently if the PHP command line |
|
| 1139 | - * is not available. Use {@link FileHelper::canMakePHPCalls()} |
|
| 1140 | - * to check this beforehand as needed. |
|
| 1141 | - * |
|
| 1142 | - * @param string $path |
|
| 1143 | - * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise. |
|
| 1144 | - */ |
|
| 1135 | + /** |
|
| 1136 | + * Validates a PHP file's syntax. |
|
| 1137 | + * |
|
| 1138 | + * NOTE: This will fail silently if the PHP command line |
|
| 1139 | + * is not available. Use {@link FileHelper::canMakePHPCalls()} |
|
| 1140 | + * to check this beforehand as needed. |
|
| 1141 | + * |
|
| 1142 | + * @param string $path |
|
| 1143 | + * @return boolean|array A boolean true if the file is valid, an array with validation messages otherwise. |
|
| 1144 | + */ |
|
| 1145 | 1145 | public static function checkPHPFileSyntax($path) |
| 1146 | 1146 | { |
| 1147 | 1147 | if(!self::canMakePHPCalls()) { |
@@ -1165,14 +1165,14 @@ discard block |
||
| 1165 | 1165 | return $output; |
| 1166 | 1166 | } |
| 1167 | 1167 | |
| 1168 | - /** |
|
| 1169 | - * Retrieves the last modified date for the specified file or folder. |
|
| 1170 | - * |
|
| 1171 | - * Note: If the target does not exist, returns null. |
|
| 1172 | - * |
|
| 1173 | - * @param string $path |
|
| 1174 | - * @return \DateTime|NULL |
|
| 1175 | - */ |
|
| 1168 | + /** |
|
| 1169 | + * Retrieves the last modified date for the specified file or folder. |
|
| 1170 | + * |
|
| 1171 | + * Note: If the target does not exist, returns null. |
|
| 1172 | + * |
|
| 1173 | + * @param string $path |
|
| 1174 | + * @return \DateTime|NULL |
|
| 1175 | + */ |
|
| 1176 | 1176 | public static function getModifiedDate($path) |
| 1177 | 1177 | { |
| 1178 | 1178 | $time = filemtime($path); |
@@ -1185,22 +1185,22 @@ discard block |
||
| 1185 | 1185 | return null; |
| 1186 | 1186 | } |
| 1187 | 1187 | |
| 1188 | - /** |
|
| 1189 | - * Retrieves the names of all subfolders in the specified path. |
|
| 1190 | - * |
|
| 1191 | - * Available options: |
|
| 1192 | - * |
|
| 1193 | - * - recursive: true/false |
|
| 1194 | - * Whether to search for subfolders recursively. |
|
| 1195 | - * |
|
| 1196 | - * - absolute-paths: true/false |
|
| 1197 | - * Whether to return a list of absolute paths. |
|
| 1198 | - * |
|
| 1199 | - * @param string $targetFolder |
|
| 1200 | - * @param array $options |
|
| 1201 | - * @throws FileHelper_Exception |
|
| 1202 | - * @return string[] |
|
| 1203 | - */ |
|
| 1188 | + /** |
|
| 1189 | + * Retrieves the names of all subfolders in the specified path. |
|
| 1190 | + * |
|
| 1191 | + * Available options: |
|
| 1192 | + * |
|
| 1193 | + * - recursive: true/false |
|
| 1194 | + * Whether to search for subfolders recursively. |
|
| 1195 | + * |
|
| 1196 | + * - absolute-paths: true/false |
|
| 1197 | + * Whether to return a list of absolute paths. |
|
| 1198 | + * |
|
| 1199 | + * @param string $targetFolder |
|
| 1200 | + * @param array $options |
|
| 1201 | + * @throws FileHelper_Exception |
|
| 1202 | + * @return string[] |
|
| 1203 | + */ |
|
| 1204 | 1204 | public static function getSubfolders($targetFolder, $options = array()) |
| 1205 | 1205 | { |
| 1206 | 1206 | if(!is_dir($targetFolder)) |
@@ -1261,16 +1261,16 @@ discard block |
||
| 1261 | 1261 | return $result; |
| 1262 | 1262 | } |
| 1263 | 1263 | |
| 1264 | - /** |
|
| 1265 | - * Retrieves the maximum allowed upload file size, in bytes. |
|
| 1266 | - * Takes into account the PHP ini settings <code>post_max_size</code> |
|
| 1267 | - * and <code>upload_max_filesize</code>. Since these cannot |
|
| 1268 | - * be modified at runtime, they are the hard limits for uploads. |
|
| 1269 | - * |
|
| 1270 | - * NOTE: Based on binary values, where 1KB = 1024 Bytes. |
|
| 1271 | - * |
|
| 1272 | - * @return int Will return <code>-1</code> if no limit. |
|
| 1273 | - */ |
|
| 1264 | + /** |
|
| 1265 | + * Retrieves the maximum allowed upload file size, in bytes. |
|
| 1266 | + * Takes into account the PHP ini settings <code>post_max_size</code> |
|
| 1267 | + * and <code>upload_max_filesize</code>. Since these cannot |
|
| 1268 | + * be modified at runtime, they are the hard limits for uploads. |
|
| 1269 | + * |
|
| 1270 | + * NOTE: Based on binary values, where 1KB = 1024 Bytes. |
|
| 1271 | + * |
|
| 1272 | + * @return int Will return <code>-1</code> if no limit. |
|
| 1273 | + */ |
|
| 1274 | 1274 | public static function getMaxUploadFilesize() : int |
| 1275 | 1275 | { |
| 1276 | 1276 | static $max_size = -1; |
@@ -1307,16 +1307,16 @@ discard block |
||
| 1307 | 1307 | return round($size); |
| 1308 | 1308 | } |
| 1309 | 1309 | |
| 1310 | - /** |
|
| 1311 | - * Makes a path relative using a folder depth: will reduce the |
|
| 1312 | - * length of the path so that only the amount of folders defined |
|
| 1313 | - * in the <code>$depth</code> attribute are shown below the actual |
|
| 1314 | - * folder or file in the path. |
|
| 1315 | - * |
|
| 1316 | - * @param string $path The absolute or relative path |
|
| 1317 | - * @param int $depth The folder depth to reduce the path to |
|
| 1318 | - * @return string |
|
| 1319 | - */ |
|
| 1310 | + /** |
|
| 1311 | + * Makes a path relative using a folder depth: will reduce the |
|
| 1312 | + * length of the path so that only the amount of folders defined |
|
| 1313 | + * in the <code>$depth</code> attribute are shown below the actual |
|
| 1314 | + * folder or file in the path. |
|
| 1315 | + * |
|
| 1316 | + * @param string $path The absolute or relative path |
|
| 1317 | + * @param int $depth The folder depth to reduce the path to |
|
| 1318 | + * @return string |
|
| 1319 | + */ |
|
| 1320 | 1320 | public static function relativizePathByDepth(string $path, int $depth=2) : string |
| 1321 | 1321 | { |
| 1322 | 1322 | $path = self::normalizePath($path); |
@@ -1354,23 +1354,23 @@ discard block |
||
| 1354 | 1354 | return trim(implode('/', $tokens), '/'); |
| 1355 | 1355 | } |
| 1356 | 1356 | |
| 1357 | - /** |
|
| 1358 | - * Makes the specified path relative to another path, |
|
| 1359 | - * by removing one from the other if found. Also |
|
| 1360 | - * normalizes the path to use forward slashes. |
|
| 1361 | - * |
|
| 1362 | - * Example: |
|
| 1363 | - * |
|
| 1364 | - * <pre> |
|
| 1365 | - * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder'); |
|
| 1366 | - * </pre> |
|
| 1367 | - * |
|
| 1368 | - * Result: <code>to/file.txt</code> |
|
| 1369 | - * |
|
| 1370 | - * @param string $path |
|
| 1371 | - * @param string $relativeTo |
|
| 1372 | - * @return string |
|
| 1373 | - */ |
|
| 1357 | + /** |
|
| 1358 | + * Makes the specified path relative to another path, |
|
| 1359 | + * by removing one from the other if found. Also |
|
| 1360 | + * normalizes the path to use forward slashes. |
|
| 1361 | + * |
|
| 1362 | + * Example: |
|
| 1363 | + * |
|
| 1364 | + * <pre> |
|
| 1365 | + * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder'); |
|
| 1366 | + * </pre> |
|
| 1367 | + * |
|
| 1368 | + * Result: <code>to/file.txt</code> |
|
| 1369 | + * |
|
| 1370 | + * @param string $path |
|
| 1371 | + * @param string $relativeTo |
|
| 1372 | + * @return string |
|
| 1373 | + */ |
|
| 1374 | 1374 | public static function relativizePath(string $path, string $relativeTo) : string |
| 1375 | 1375 | { |
| 1376 | 1376 | $path = self::normalizePath($path); |
@@ -1382,17 +1382,17 @@ discard block |
||
| 1382 | 1382 | return $relative; |
| 1383 | 1383 | } |
| 1384 | 1384 | |
| 1385 | - /** |
|
| 1386 | - * Checks that the target file exists, and throws an exception |
|
| 1387 | - * if it does not. |
|
| 1388 | - * |
|
| 1389 | - * @param string $path |
|
| 1390 | - * @param int|NULL $errorCode Optional custom error code |
|
| 1391 | - * @throws FileHelper_Exception |
|
| 1392 | - * @return string The real path to the file |
|
| 1393 | - * |
|
| 1394 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 1395 | - */ |
|
| 1385 | + /** |
|
| 1386 | + * Checks that the target file exists, and throws an exception |
|
| 1387 | + * if it does not. |
|
| 1388 | + * |
|
| 1389 | + * @param string $path |
|
| 1390 | + * @param int|NULL $errorCode Optional custom error code |
|
| 1391 | + * @throws FileHelper_Exception |
|
| 1392 | + * @return string The real path to the file |
|
| 1393 | + * |
|
| 1394 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 1395 | + */ |
|
| 1396 | 1396 | public static function requireFileExists(string $path, $errorCode=null) : string |
| 1397 | 1397 | { |
| 1398 | 1398 | $result = realpath($path); |
@@ -1411,18 +1411,18 @@ discard block |
||
| 1411 | 1411 | ); |
| 1412 | 1412 | } |
| 1413 | 1413 | |
| 1414 | - /** |
|
| 1415 | - * Reads a specific line number from the target file and returns its |
|
| 1416 | - * contents, if the file has such a line. Does so with little memory |
|
| 1417 | - * usage, as the file is not read entirely into memory. |
|
| 1418 | - * |
|
| 1419 | - * @param string $path |
|
| 1420 | - * @param int $lineNumber Note: 1-based; the first line is number 1. |
|
| 1421 | - * @return string|NULL Will return null if the requested line does not exist. |
|
| 1422 | - * @throws FileHelper_Exception |
|
| 1423 | - * |
|
| 1424 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 1425 | - */ |
|
| 1414 | + /** |
|
| 1415 | + * Reads a specific line number from the target file and returns its |
|
| 1416 | + * contents, if the file has such a line. Does so with little memory |
|
| 1417 | + * usage, as the file is not read entirely into memory. |
|
| 1418 | + * |
|
| 1419 | + * @param string $path |
|
| 1420 | + * @param int $lineNumber Note: 1-based; the first line is number 1. |
|
| 1421 | + * @return string|NULL Will return null if the requested line does not exist. |
|
| 1422 | + * @throws FileHelper_Exception |
|
| 1423 | + * |
|
| 1424 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 1425 | + */ |
|
| 1426 | 1426 | public static function getLineFromFile(string $path, int $lineNumber) : ?string |
| 1427 | 1427 | { |
| 1428 | 1428 | self::requireFileExists($path); |
@@ -1438,19 +1438,19 @@ discard block |
||
| 1438 | 1438 | $file->seek($targetLine); |
| 1439 | 1439 | |
| 1440 | 1440 | if($file->key() !== $targetLine) { |
| 1441 | - return null; |
|
| 1441 | + return null; |
|
| 1442 | 1442 | } |
| 1443 | 1443 | |
| 1444 | 1444 | return $file->current(); |
| 1445 | 1445 | } |
| 1446 | 1446 | |
| 1447 | - /** |
|
| 1448 | - * Retrieves the total amount of lines in the file, without |
|
| 1449 | - * reading the whole file into memory. |
|
| 1450 | - * |
|
| 1451 | - * @param string $path |
|
| 1452 | - * @return int |
|
| 1453 | - */ |
|
| 1447 | + /** |
|
| 1448 | + * Retrieves the total amount of lines in the file, without |
|
| 1449 | + * reading the whole file into memory. |
|
| 1450 | + * |
|
| 1451 | + * @param string $path |
|
| 1452 | + * @return int |
|
| 1453 | + */ |
|
| 1454 | 1454 | public static function countFileLines(string $path) : int |
| 1455 | 1455 | { |
| 1456 | 1456 | self::requireFileExists($path); |
@@ -1480,26 +1480,26 @@ discard block |
||
| 1480 | 1480 | return $number+1; |
| 1481 | 1481 | } |
| 1482 | 1482 | |
| 1483 | - /** |
|
| 1484 | - * Parses the target file to detect any PHP classes contained |
|
| 1485 | - * within, and retrieve information on them. Does not use the |
|
| 1486 | - * PHP reflection API. |
|
| 1487 | - * |
|
| 1488 | - * @param string $filePath |
|
| 1489 | - * @return FileHelper_PHPClassInfo |
|
| 1490 | - */ |
|
| 1483 | + /** |
|
| 1484 | + * Parses the target file to detect any PHP classes contained |
|
| 1485 | + * within, and retrieve information on them. Does not use the |
|
| 1486 | + * PHP reflection API. |
|
| 1487 | + * |
|
| 1488 | + * @param string $filePath |
|
| 1489 | + * @return FileHelper_PHPClassInfo |
|
| 1490 | + */ |
|
| 1491 | 1491 | public static function findPHPClasses(string $filePath) : FileHelper_PHPClassInfo |
| 1492 | 1492 | { |
| 1493 | 1493 | return new FileHelper_PHPClassInfo($filePath); |
| 1494 | 1494 | } |
| 1495 | 1495 | |
| 1496 | - /** |
|
| 1497 | - * Detects the end of line style used in the target file, if any. |
|
| 1498 | - * Can be used with large files, because it only reads part of it. |
|
| 1499 | - * |
|
| 1500 | - * @param string $filePath The path to the file. |
|
| 1501 | - * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found. |
|
| 1502 | - */ |
|
| 1496 | + /** |
|
| 1497 | + * Detects the end of line style used in the target file, if any. |
|
| 1498 | + * Can be used with large files, because it only reads part of it. |
|
| 1499 | + * |
|
| 1500 | + * @param string $filePath The path to the file. |
|
| 1501 | + * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found. |
|
| 1502 | + */ |
|
| 1503 | 1503 | public static function detectEOLCharacter(string $filePath) : ?ConvertHelper_EOL |
| 1504 | 1504 | { |
| 1505 | 1505 | // 20 lines is enough to get a good picture of the newline style in the file. |
@@ -1512,18 +1512,18 @@ discard block |
||
| 1512 | 1512 | return ConvertHelper::detectEOLCharacter($string); |
| 1513 | 1513 | } |
| 1514 | 1514 | |
| 1515 | - /** |
|
| 1516 | - * Reads the specified amount of lines from the target file. |
|
| 1517 | - * Unicode BOM compatible: any byte order marker is stripped |
|
| 1518 | - * from the resulting lines. |
|
| 1519 | - * |
|
| 1520 | - * @param string $filePath |
|
| 1521 | - * @param int $amount Set to 0 to read all lines. |
|
| 1522 | - * @return array |
|
| 1523 | - * |
|
| 1524 | - * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES |
|
| 1525 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 1526 | - */ |
|
| 1515 | + /** |
|
| 1516 | + * Reads the specified amount of lines from the target file. |
|
| 1517 | + * Unicode BOM compatible: any byte order marker is stripped |
|
| 1518 | + * from the resulting lines. |
|
| 1519 | + * |
|
| 1520 | + * @param string $filePath |
|
| 1521 | + * @param int $amount Set to 0 to read all lines. |
|
| 1522 | + * @return array |
|
| 1523 | + * |
|
| 1524 | + * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES |
|
| 1525 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 1526 | + */ |
|
| 1527 | 1527 | public static function readLines(string $filePath, int $amount=0) : array |
| 1528 | 1528 | { |
| 1529 | 1529 | self::requireFileExists($filePath); |
@@ -1574,16 +1574,16 @@ discard block |
||
| 1574 | 1574 | return $result; |
| 1575 | 1575 | } |
| 1576 | 1576 | |
| 1577 | - /** |
|
| 1578 | - * Reads all content from a file. |
|
| 1579 | - * |
|
| 1580 | - * @param string $filePath |
|
| 1581 | - * @throws FileHelper_Exception |
|
| 1582 | - * @return string |
|
| 1583 | - * |
|
| 1584 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 1585 | - * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
|
| 1586 | - */ |
|
| 1577 | + /** |
|
| 1578 | + * Reads all content from a file. |
|
| 1579 | + * |
|
| 1580 | + * @param string $filePath |
|
| 1581 | + * @throws FileHelper_Exception |
|
| 1582 | + * @return string |
|
| 1583 | + * |
|
| 1584 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 1585 | + * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
|
| 1586 | + */ |
|
| 1587 | 1587 | public static function readContents(string $filePath) : string |
| 1588 | 1588 | { |
| 1589 | 1589 | self::requireFileExists($filePath); |
@@ -112,7 +112,7 @@ discard block |
||
| 112 | 112 | |
| 113 | 113 | $contents = file_get_contents($file); |
| 114 | 114 | |
| 115 | - if($contents === false) |
|
| 115 | + if ($contents === false) |
|
| 116 | 116 | { |
| 117 | 117 | throw new FileHelper_Exception( |
| 118 | 118 | 'Cannot load serialized content from file.', |
@@ -126,7 +126,7 @@ discard block |
||
| 126 | 126 | |
| 127 | 127 | $result = @unserialize($contents); |
| 128 | 128 | |
| 129 | - if($result !== false) { |
|
| 129 | + if ($result !== false) { |
|
| 130 | 130 | return $result; |
| 131 | 131 | } |
| 132 | 132 | |
@@ -142,7 +142,7 @@ discard block |
||
| 142 | 142 | |
| 143 | 143 | public static function deleteTree($rootFolder) |
| 144 | 144 | { |
| 145 | - if(!file_exists($rootFolder)) { |
|
| 145 | + if (!file_exists($rootFolder)) { |
|
| 146 | 146 | return true; |
| 147 | 147 | } |
| 148 | 148 | |
@@ -183,7 +183,7 @@ discard block |
||
| 183 | 183 | */ |
| 184 | 184 | public static function createFolder($path) |
| 185 | 185 | { |
| 186 | - if(is_dir($path) || mkdir($path, 0777, true)) { |
|
| 186 | + if (is_dir($path) || mkdir($path, 0777, true)) { |
|
| 187 | 187 | return; |
| 188 | 188 | } |
| 189 | 189 | |
@@ -218,11 +218,11 @@ discard block |
||
| 218 | 218 | |
| 219 | 219 | if ($item->isDir()) |
| 220 | 220 | { |
| 221 | - FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target . '/' . $baseName); |
|
| 221 | + FileHelper::copyTree(str_replace('\\', '/', $itemPath), $target.'/'.$baseName); |
|
| 222 | 222 | } |
| 223 | - else if($item->isFile()) |
|
| 223 | + else if ($item->isFile()) |
|
| 224 | 224 | { |
| 225 | - self::copyFile($itemPath, $target . '/' . $baseName); |
|
| 225 | + self::copyFile($itemPath, $target.'/'.$baseName); |
|
| 226 | 226 | } |
| 227 | 227 | } |
| 228 | 228 | } |
@@ -247,7 +247,7 @@ discard block |
||
| 247 | 247 | { |
| 248 | 248 | self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND); |
| 249 | 249 | |
| 250 | - if(!is_readable($sourcePath)) |
|
| 250 | + if (!is_readable($sourcePath)) |
|
| 251 | 251 | { |
| 252 | 252 | throw new FileHelper_Exception( |
| 253 | 253 | sprintf('Source file [%s] to copy is not readable.', basename($sourcePath)), |
@@ -261,11 +261,11 @@ discard block |
||
| 261 | 261 | |
| 262 | 262 | $targetFolder = dirname($targetPath); |
| 263 | 263 | |
| 264 | - if(!file_exists($targetFolder)) |
|
| 264 | + if (!file_exists($targetFolder)) |
|
| 265 | 265 | { |
| 266 | 266 | self::createFolder($targetFolder); |
| 267 | 267 | } |
| 268 | - else if(!is_writable($targetFolder)) |
|
| 268 | + else if (!is_writable($targetFolder)) |
|
| 269 | 269 | { |
| 270 | 270 | throw new FileHelper_Exception( |
| 271 | 271 | sprintf('Target folder [%s] is not writable.', basename($targetFolder)), |
@@ -277,7 +277,7 @@ discard block |
||
| 277 | 277 | ); |
| 278 | 278 | } |
| 279 | 279 | |
| 280 | - if(copy($sourcePath, $targetPath)) { |
|
| 280 | + if (copy($sourcePath, $targetPath)) { |
|
| 281 | 281 | return; |
| 282 | 282 | } |
| 283 | 283 | |
@@ -304,11 +304,11 @@ discard block |
||
| 304 | 304 | */ |
| 305 | 305 | public static function deleteFile(string $filePath) : void |
| 306 | 306 | { |
| 307 | - if(!file_exists($filePath)) { |
|
| 307 | + if (!file_exists($filePath)) { |
|
| 308 | 308 | return; |
| 309 | 309 | } |
| 310 | 310 | |
| 311 | - if(unlink($filePath)) { |
|
| 311 | + if (unlink($filePath)) { |
|
| 312 | 312 | return; |
| 313 | 313 | } |
| 314 | 314 | |
@@ -332,10 +332,10 @@ discard block |
||
| 332 | 332 | * @return \parseCSV |
| 333 | 333 | * @todo Move this to the CSV helper. |
| 334 | 334 | */ |
| 335 | - public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : \parseCSV |
|
| 335 | + public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : \parseCSV |
|
| 336 | 336 | { |
| 337 | - if($delimiter==='') { $delimiter = ';'; } |
|
| 338 | - if($enclosure==='') { $enclosure = '"'; } |
|
| 337 | + if ($delimiter === '') { $delimiter = ';'; } |
|
| 338 | + if ($enclosure === '') { $enclosure = '"'; } |
|
| 339 | 339 | |
| 340 | 340 | $parser = new \parseCSV(null, null, null, array()); |
| 341 | 341 | |
@@ -363,11 +363,11 @@ discard block |
||
| 363 | 363 | * @see parseCSVFile() |
| 364 | 364 | * @see FileHelper::ERROR_PARSING_CSV |
| 365 | 365 | */ |
| 366 | - public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array |
|
| 366 | + public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array |
|
| 367 | 367 | { |
| 368 | 368 | $parser = self::createCSVParser($delimiter, $enclosure, $escape, $heading); |
| 369 | 369 | $result = $parser->parse_string(/** @scrutinizer ignore-type */ $csv); |
| 370 | - if(is_array($result)) { |
|
| 370 | + if (is_array($result)) { |
|
| 371 | 371 | return $result; |
| 372 | 372 | } |
| 373 | 373 | |
@@ -395,7 +395,7 @@ discard block |
||
| 395 | 395 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
| 396 | 396 | * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
| 397 | 397 | */ |
| 398 | - public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array |
|
| 398 | + public static function parseCSVFile(string $filePath, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading = false) : array |
|
| 399 | 399 | { |
| 400 | 400 | $content = self::readContents($filePath); |
| 401 | 401 | |
@@ -412,7 +412,7 @@ discard block |
||
| 412 | 412 | public static function detectMimeType(string $fileName) : ?string |
| 413 | 413 | { |
| 414 | 414 | $ext = self::getExtension($fileName); |
| 415 | - if(empty($ext)) { |
|
| 415 | + if (empty($ext)) { |
|
| 416 | 416 | return null; |
| 417 | 417 | } |
| 418 | 418 | |
@@ -433,11 +433,11 @@ discard block |
||
| 433 | 433 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
| 434 | 434 | * @see FileHelper::ERROR_UNKNOWN_FILE_MIME_TYPE |
| 435 | 435 | */ |
| 436 | - public static function sendFile(string $filePath, $fileName = null, bool $asAttachment=true) |
|
| 436 | + public static function sendFile(string $filePath, $fileName = null, bool $asAttachment = true) |
|
| 437 | 437 | { |
| 438 | 438 | self::requireFileExists($filePath); |
| 439 | 439 | |
| 440 | - if(empty($fileName)) { |
|
| 440 | + if (empty($fileName)) { |
|
| 441 | 441 | $fileName = basename($filePath); |
| 442 | 442 | } |
| 443 | 443 | |
@@ -455,10 +455,10 @@ discard block |
||
| 455 | 455 | |
| 456 | 456 | header("Cache-Control: public", true); |
| 457 | 457 | header("Content-Description: File Transfer", true); |
| 458 | - header("Content-Type: " . $mime, true); |
|
| 458 | + header("Content-Type: ".$mime, true); |
|
| 459 | 459 | |
| 460 | 460 | $disposition = 'inline'; |
| 461 | - if($asAttachment) { |
|
| 461 | + if ($asAttachment) { |
|
| 462 | 462 | $disposition = 'attachment'; |
| 463 | 463 | } |
| 464 | 464 | |
@@ -484,7 +484,7 @@ discard block |
||
| 484 | 484 | */ |
| 485 | 485 | public static function downloadFile($url) |
| 486 | 486 | { |
| 487 | - if(!function_exists('curl_init')) |
|
| 487 | + if (!function_exists('curl_init')) |
|
| 488 | 488 | { |
| 489 | 489 | throw new FileHelper_Exception( |
| 490 | 490 | 'The cURL extension is not installed.', |
@@ -494,7 +494,7 @@ discard block |
||
| 494 | 494 | } |
| 495 | 495 | |
| 496 | 496 | $ch = curl_init(); |
| 497 | - if($ch === false) |
|
| 497 | + if ($ch === false) |
|
| 498 | 498 | { |
| 499 | 499 | throw new FileHelper_Exception( |
| 500 | 500 | 'Could not initialize a new cURL instance.', |
@@ -515,7 +515,7 @@ discard block |
||
| 515 | 515 | |
| 516 | 516 | $output = curl_exec($ch); |
| 517 | 517 | |
| 518 | - if($output === false) { |
|
| 518 | + if ($output === false) { |
|
| 519 | 519 | throw new FileHelper_Exception( |
| 520 | 520 | 'Unable to open URL', |
| 521 | 521 | sprintf( |
@@ -529,7 +529,7 @@ discard block |
||
| 529 | 529 | |
| 530 | 530 | curl_close($ch); |
| 531 | 531 | |
| 532 | - if(is_string($output)) |
|
| 532 | + if (is_string($output)) |
|
| 533 | 533 | { |
| 534 | 534 | return $output; |
| 535 | 535 | } |
@@ -551,7 +551,7 @@ discard block |
||
| 551 | 551 | */ |
| 552 | 552 | public static function isPHPFile($pathOrDirIterator) |
| 553 | 553 | { |
| 554 | - if(self::getExtension($pathOrDirIterator) == 'php') { |
|
| 554 | + if (self::getExtension($pathOrDirIterator) == 'php') { |
|
| 555 | 555 | return true; |
| 556 | 556 | } |
| 557 | 557 | |
@@ -568,14 +568,14 @@ discard block |
||
| 568 | 568 | */ |
| 569 | 569 | public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string |
| 570 | 570 | { |
| 571 | - if($pathOrDirIterator instanceof \DirectoryIterator) { |
|
| 571 | + if ($pathOrDirIterator instanceof \DirectoryIterator) { |
|
| 572 | 572 | $filename = $pathOrDirIterator->getFilename(); |
| 573 | 573 | } else { |
| 574 | 574 | $filename = basename($pathOrDirIterator); |
| 575 | 575 | } |
| 576 | 576 | |
| 577 | 577 | $ext = pathinfo($filename, PATHINFO_EXTENSION); |
| 578 | - if($lowercase) { |
|
| 578 | + if ($lowercase) { |
|
| 579 | 579 | $ext = mb_strtolower($ext); |
| 580 | 580 | } |
| 581 | 581 | |
@@ -597,13 +597,13 @@ discard block |
||
| 597 | 597 | public static function getFilename($pathOrDirIterator, $extension = true) |
| 598 | 598 | { |
| 599 | 599 | $path = $pathOrDirIterator; |
| 600 | - if($pathOrDirIterator instanceof \DirectoryIterator) { |
|
| 600 | + if ($pathOrDirIterator instanceof \DirectoryIterator) { |
|
| 601 | 601 | $path = $pathOrDirIterator->getFilename(); |
| 602 | 602 | } |
| 603 | 603 | |
| 604 | 604 | $path = self::normalizePath($path); |
| 605 | 605 | |
| 606 | - if(!$extension) { |
|
| 606 | + if (!$extension) { |
|
| 607 | 607 | return pathinfo($path, PATHINFO_FILENAME); |
| 608 | 608 | } |
| 609 | 609 | |
@@ -621,12 +621,12 @@ discard block |
||
| 621 | 621 | * @see FileHelper::ERROR_CANNOT_FIND_JSON_FILE |
| 622 | 622 | * @see FileHelper::ERROR_CANNOT_DECODE_JSON_FILE |
| 623 | 623 | */ |
| 624 | - public static function parseJSONFile(string $file, $targetEncoding=null, $sourceEncoding=null) |
|
| 624 | + public static function parseJSONFile(string $file, $targetEncoding = null, $sourceEncoding = null) |
|
| 625 | 625 | { |
| 626 | 626 | self::requireFileExists($file, self::ERROR_CANNOT_FIND_JSON_FILE); |
| 627 | 627 | |
| 628 | 628 | $content = file_get_contents($file); |
| 629 | - if(!$content) { |
|
| 629 | + if (!$content) { |
|
| 630 | 630 | throw new FileHelper_Exception( |
| 631 | 631 | 'Cannot get file contents', |
| 632 | 632 | sprintf( |
@@ -637,12 +637,12 @@ discard block |
||
| 637 | 637 | ); |
| 638 | 638 | } |
| 639 | 639 | |
| 640 | - if(isset($targetEncoding)) { |
|
| 640 | + if (isset($targetEncoding)) { |
|
| 641 | 641 | $content = mb_convert_encoding($content, $targetEncoding, $sourceEncoding); |
| 642 | 642 | } |
| 643 | 643 | |
| 644 | 644 | $json = json_decode($content, true); |
| 645 | - if($json === false || $json === NULL) { |
|
| 645 | + if ($json === false || $json === NULL) { |
|
| 646 | 646 | throw new FileHelper_Exception( |
| 647 | 647 | 'Cannot decode json data', |
| 648 | 648 | sprintf( |
@@ -682,13 +682,13 @@ discard block |
||
| 682 | 682 | |
| 683 | 683 | $name = str_replace(array_keys($replaces), array_values($replaces), $name); |
| 684 | 684 | |
| 685 | - while(strstr($name, ' ')) { |
|
| 685 | + while (strstr($name, ' ')) { |
|
| 686 | 686 | $name = str_replace(' ', ' ', $name); |
| 687 | 687 | } |
| 688 | 688 | |
| 689 | 689 | $name = str_replace(array_keys($replaces), array_values($replaces), $name); |
| 690 | 690 | |
| 691 | - while(strstr($name, '..')) { |
|
| 691 | + while (strstr($name, '..')) { |
|
| 692 | 692 | $name = str_replace('..', '.', $name); |
| 693 | 693 | } |
| 694 | 694 | |
@@ -718,7 +718,7 @@ discard block |
||
| 718 | 718 | * |
| 719 | 719 | * @todo Convert this to use the file finder. |
| 720 | 720 | */ |
| 721 | - public static function findHTMLFiles(string $targetFolder, array $options=array()) : array |
|
| 721 | + public static function findHTMLFiles(string $targetFolder, array $options = array()) : array |
|
| 722 | 722 | { |
| 723 | 723 | return self::findFiles($targetFolder, array('html'), $options); |
| 724 | 724 | } |
@@ -733,7 +733,7 @@ discard block |
||
| 733 | 733 | * |
| 734 | 734 | * @todo Convert this to use the file finder. |
| 735 | 735 | */ |
| 736 | - public static function findPHPFiles(string $targetFolder, array $options=array()) : array |
|
| 736 | + public static function findPHPFiles(string $targetFolder, array $options = array()) : array |
|
| 737 | 737 | { |
| 738 | 738 | return self::findFiles($targetFolder, array('php'), $options); |
| 739 | 739 | } |
@@ -749,39 +749,39 @@ discard block |
||
| 749 | 749 | * @see FileHelper::createFileFinder() |
| 750 | 750 | * @todo Convert this to use the file finder. |
| 751 | 751 | */ |
| 752 | - public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array(), array $files=array()) : array |
|
| 752 | + public static function findFiles(string $targetFolder, array $extensions = array(), array $options = array(), array $files = array()) : array |
|
| 753 | 753 | { |
| 754 | - if(!isset($options['strip-extension'])) { |
|
| 754 | + if (!isset($options['strip-extension'])) { |
|
| 755 | 755 | $options['strip-extension'] = false; |
| 756 | 756 | } |
| 757 | 757 | |
| 758 | - if(!isset($options['absolute-path'])) { |
|
| 758 | + if (!isset($options['absolute-path'])) { |
|
| 759 | 759 | $options['absolute-path'] = false; |
| 760 | 760 | } |
| 761 | 761 | |
| 762 | - if(!isset($options['relative-path'])) { |
|
| 762 | + if (!isset($options['relative-path'])) { |
|
| 763 | 763 | $options['relative-path'] = false; |
| 764 | 764 | } |
| 765 | 765 | |
| 766 | - if(!isset($options['recursive'])) { |
|
| 766 | + if (!isset($options['recursive'])) { |
|
| 767 | 767 | $options['recursive'] = false; |
| 768 | 768 | } |
| 769 | 769 | |
| 770 | - if($options['relative-path']) { |
|
| 770 | + if ($options['relative-path']) { |
|
| 771 | 771 | $options['absolute-path'] = true; |
| 772 | 772 | } |
| 773 | 773 | |
| 774 | - if(!isset($options['__root'])) { |
|
| 774 | + if (!isset($options['__root'])) { |
|
| 775 | 775 | $options['__root'] = self::normalizePath($targetFolder); |
| 776 | 776 | } |
| 777 | 777 | |
| 778 | 778 | $checkExtensions = false; |
| 779 | - if(!empty($extensions)) { |
|
| 779 | + if (!empty($extensions)) { |
|
| 780 | 780 | $checkExtensions = true; |
| 781 | 781 | $extensions = array_map('strtolower', $extensions); |
| 782 | 782 | } |
| 783 | 783 | |
| 784 | - if(!is_dir($targetFolder)) |
|
| 784 | + if (!is_dir($targetFolder)) |
|
| 785 | 785 | { |
| 786 | 786 | throw new FileHelper_Exception( |
| 787 | 787 | 'Target folder does not exist', |
@@ -794,32 +794,32 @@ discard block |
||
| 794 | 794 | } |
| 795 | 795 | |
| 796 | 796 | $d = new \DirectoryIterator($targetFolder); |
| 797 | - foreach($d as $item) { |
|
| 798 | - if($item->isDot()) { |
|
| 797 | + foreach ($d as $item) { |
|
| 798 | + if ($item->isDot()) { |
|
| 799 | 799 | continue; |
| 800 | 800 | } |
| 801 | 801 | |
| 802 | - if($item->isDir()) { |
|
| 803 | - if($options['recursive']) { |
|
| 802 | + if ($item->isDir()) { |
|
| 803 | + if ($options['recursive']) { |
|
| 804 | 804 | $files = self::findFiles($item->getPathname(), $extensions, $options, $files); |
| 805 | 805 | } |
| 806 | 806 | continue; |
| 807 | 807 | } |
| 808 | 808 | |
| 809 | - if($checkExtensions && !in_array(self::getExtension($item, true), $extensions)) { |
|
| 809 | + if ($checkExtensions && !in_array(self::getExtension($item, true), $extensions)) { |
|
| 810 | 810 | continue; |
| 811 | 811 | } |
| 812 | 812 | |
| 813 | 813 | $filename = $item->getFilename(); |
| 814 | - if($options['strip-extension']) { |
|
| 814 | + if ($options['strip-extension']) { |
|
| 815 | 815 | $filename = self::removeExtension($filename); |
| 816 | 816 | } |
| 817 | 817 | |
| 818 | - if($options['absolute-path']) { |
|
| 818 | + if ($options['absolute-path']) { |
|
| 819 | 819 | $filename = self::normalizePath($targetFolder.'/'.$filename); |
| 820 | 820 | } |
| 821 | 821 | |
| 822 | - if($options['relative-path']) { |
|
| 822 | + if ($options['relative-path']) { |
|
| 823 | 823 | $filename = ltrim(str_replace($options['__root'], '', $filename), '/'); |
| 824 | 824 | } |
| 825 | 825 | |
@@ -863,7 +863,7 @@ discard block |
||
| 863 | 863 | public static function detectUTFBom(string $filename) : ?string |
| 864 | 864 | { |
| 865 | 865 | $fp = fopen($filename, 'r'); |
| 866 | - if($fp === false) |
|
| 866 | + if ($fp === false) |
|
| 867 | 867 | { |
| 868 | 868 | throw new FileHelper_Exception( |
| 869 | 869 | 'Cannot open file for reading', |
@@ -878,10 +878,10 @@ discard block |
||
| 878 | 878 | |
| 879 | 879 | $boms = self::getUTFBOMs(); |
| 880 | 880 | |
| 881 | - foreach($boms as $bom => $value) |
|
| 881 | + foreach ($boms as $bom => $value) |
|
| 882 | 882 | { |
| 883 | 883 | $length = mb_strlen($value); |
| 884 | - if(mb_substr($text, 0, $length) == $value) { |
|
| 884 | + if (mb_substr($text, 0, $length) == $value) { |
|
| 885 | 885 | return $bom; |
| 886 | 886 | } |
| 887 | 887 | } |
@@ -900,13 +900,13 @@ discard block |
||
| 900 | 900 | */ |
| 901 | 901 | public static function getUTFBOMs() |
| 902 | 902 | { |
| 903 | - if(!isset(self::$utfBoms)) { |
|
| 903 | + if (!isset(self::$utfBoms)) { |
|
| 904 | 904 | self::$utfBoms = array( |
| 905 | - 'UTF32-BE' => chr(0x00) . chr(0x00) . chr(0xFE) . chr(0xFF), |
|
| 906 | - 'UTF32-LE' => chr(0xFF) . chr(0xFE) . chr(0x00) . chr(0x00), |
|
| 907 | - 'UTF16-BE' => chr(0xFE) . chr(0xFF), |
|
| 908 | - 'UTF16-LE' => chr(0xFF) . chr(0xFE), |
|
| 909 | - 'UTF8' => chr(0xEF) . chr(0xBB) . chr(0xBF) |
|
| 905 | + 'UTF32-BE' => chr(0x00).chr(0x00).chr(0xFE).chr(0xFF), |
|
| 906 | + 'UTF32-LE' => chr(0xFF).chr(0xFE).chr(0x00).chr(0x00), |
|
| 907 | + 'UTF16-BE' => chr(0xFE).chr(0xFF), |
|
| 908 | + 'UTF16-LE' => chr(0xFF).chr(0xFE), |
|
| 909 | + 'UTF8' => chr(0xEF).chr(0xBB).chr(0xBF) |
|
| 910 | 910 | ); |
| 911 | 911 | } |
| 912 | 912 | |
@@ -927,7 +927,7 @@ discard block |
||
| 927 | 927 | $encodings = self::getKnownUnicodeEncodings(); |
| 928 | 928 | |
| 929 | 929 | $keep = array(); |
| 930 | - foreach($encodings as $string) |
|
| 930 | + foreach ($encodings as $string) |
|
| 931 | 931 | { |
| 932 | 932 | $withHyphen = str_replace('UTF', 'UTF-', $string); |
| 933 | 933 | |
@@ -961,15 +961,15 @@ discard block |
||
| 961 | 961 | return str_replace(array('\\', '//'), array('/', '/'), $path); |
| 962 | 962 | } |
| 963 | 963 | |
| 964 | - public static function saveAsJSON($data, $file, $pretty=false) |
|
| 964 | + public static function saveAsJSON($data, $file, $pretty = false) |
|
| 965 | 965 | { |
| 966 | 966 | $options = null; |
| 967 | - if($pretty) { |
|
| 967 | + if ($pretty) { |
|
| 968 | 968 | $options = JSON_PRETTY_PRINT; |
| 969 | 969 | } |
| 970 | 970 | |
| 971 | 971 | $json = json_encode($data, $options); |
| 972 | - if($json===false) |
|
| 972 | + if ($json === false) |
|
| 973 | 973 | { |
| 974 | 974 | $errorCode = json_last_error(); |
| 975 | 975 | throw new FileHelper_Exception( |
@@ -979,7 +979,7 @@ discard block |
||
| 979 | 979 | ); |
| 980 | 980 | } |
| 981 | 981 | |
| 982 | - if(!file_put_contents($file, $json)) { |
|
| 982 | + if (!file_put_contents($file, $json)) { |
|
| 983 | 983 | throw new FileHelper_Exception( |
| 984 | 984 | sprintf('Could not write the JSON file [%s] to disk.', basename($file)), |
| 985 | 985 | sprintf('Full path: [%s].', $file), |
@@ -1000,12 +1000,12 @@ discard block |
||
| 1000 | 1000 | * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
| 1001 | 1001 | * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
| 1002 | 1002 | */ |
| 1003 | - public static function saveFile(string $filePath, string $content='') : void |
|
| 1003 | + public static function saveFile(string $filePath, string $content = '') : void |
|
| 1004 | 1004 | { |
| 1005 | 1005 | // target file already exists |
| 1006 | - if(file_exists($filePath)) |
|
| 1006 | + if (file_exists($filePath)) |
|
| 1007 | 1007 | { |
| 1008 | - if(!is_writable($filePath)) |
|
| 1008 | + if (!is_writable($filePath)) |
|
| 1009 | 1009 | { |
| 1010 | 1010 | throw new FileHelper_Exception( |
| 1011 | 1011 | sprintf('Cannot save file: target file [%s] exists, but is not writable.', basename($filePath)), |
@@ -1025,7 +1025,7 @@ discard block |
||
| 1025 | 1025 | // create the folder as needed |
| 1026 | 1026 | self::createFolder($targetFolder); |
| 1027 | 1027 | |
| 1028 | - if(!is_writable($targetFolder)) |
|
| 1028 | + if (!is_writable($targetFolder)) |
|
| 1029 | 1029 | { |
| 1030 | 1030 | throw new FileHelper_Exception( |
| 1031 | 1031 | sprintf('Cannot save file: target folder [%s] is not writable.', basename($targetFolder)), |
@@ -1038,7 +1038,7 @@ discard block |
||
| 1038 | 1038 | } |
| 1039 | 1039 | } |
| 1040 | 1040 | |
| 1041 | - if(file_put_contents($filePath, $content) !== false) { |
|
| 1041 | + if (file_put_contents($filePath, $content) !== false) { |
|
| 1042 | 1042 | return; |
| 1043 | 1043 | } |
| 1044 | 1044 | |
@@ -1074,7 +1074,7 @@ discard block |
||
| 1074 | 1074 | { |
| 1075 | 1075 | static $checked = array(); |
| 1076 | 1076 | |
| 1077 | - if(isset($checked[$command])) { |
|
| 1077 | + if (isset($checked[$command])) { |
|
| 1078 | 1078 | return $checked[$command]; |
| 1079 | 1079 | } |
| 1080 | 1080 | |
@@ -1087,7 +1087,7 @@ discard block |
||
| 1087 | 1087 | |
| 1088 | 1088 | $os = strtolower(PHP_OS_FAMILY); |
| 1089 | 1089 | |
| 1090 | - if(!isset($osCommands[$os])) |
|
| 1090 | + if (!isset($osCommands[$os])) |
|
| 1091 | 1091 | { |
| 1092 | 1092 | throw new FileHelper_Exception( |
| 1093 | 1093 | 'Unsupported OS for CLI commands', |
@@ -1113,7 +1113,7 @@ discard block |
||
| 1113 | 1113 | $pipes |
| 1114 | 1114 | ); |
| 1115 | 1115 | |
| 1116 | - if($process === false) { |
|
| 1116 | + if ($process === false) { |
|
| 1117 | 1117 | $checked[$command] = false; |
| 1118 | 1118 | return false; |
| 1119 | 1119 | } |
@@ -1144,7 +1144,7 @@ discard block |
||
| 1144 | 1144 | */ |
| 1145 | 1145 | public static function checkPHPFileSyntax($path) |
| 1146 | 1146 | { |
| 1147 | - if(!self::canMakePHPCalls()) { |
|
| 1147 | + if (!self::canMakePHPCalls()) { |
|
| 1148 | 1148 | return true; |
| 1149 | 1149 | } |
| 1150 | 1150 | |
@@ -1155,7 +1155,7 @@ discard block |
||
| 1155 | 1155 | // when the validation is successful, the first entry |
| 1156 | 1156 | // in the array contains the success message. When it |
| 1157 | 1157 | // is invalid, the first entry is always empty. |
| 1158 | - if(!empty($output[0])) { |
|
| 1158 | + if (!empty($output[0])) { |
|
| 1159 | 1159 | return true; |
| 1160 | 1160 | } |
| 1161 | 1161 | |
@@ -1176,7 +1176,7 @@ discard block |
||
| 1176 | 1176 | public static function getModifiedDate($path) |
| 1177 | 1177 | { |
| 1178 | 1178 | $time = filemtime($path); |
| 1179 | - if($time !== false) { |
|
| 1179 | + if ($time !== false) { |
|
| 1180 | 1180 | $date = new \DateTime(); |
| 1181 | 1181 | $date->setTimestamp($time); |
| 1182 | 1182 | return $date; |
@@ -1203,7 +1203,7 @@ discard block |
||
| 1203 | 1203 | */ |
| 1204 | 1204 | public static function getSubfolders($targetFolder, $options = array()) |
| 1205 | 1205 | { |
| 1206 | - if(!is_dir($targetFolder)) |
|
| 1206 | + if (!is_dir($targetFolder)) |
|
| 1207 | 1207 | { |
| 1208 | 1208 | throw new FileHelper_Exception( |
| 1209 | 1209 | 'Target folder does not exist', |
@@ -1227,29 +1227,29 @@ discard block |
||
| 1227 | 1227 | |
| 1228 | 1228 | $d = new \DirectoryIterator($targetFolder); |
| 1229 | 1229 | |
| 1230 | - foreach($d as $item) |
|
| 1230 | + foreach ($d as $item) |
|
| 1231 | 1231 | { |
| 1232 | - if($item->isDir() && !$item->isDot()) |
|
| 1232 | + if ($item->isDir() && !$item->isDot()) |
|
| 1233 | 1233 | { |
| 1234 | 1234 | $name = $item->getFilename(); |
| 1235 | 1235 | |
| 1236 | - if(!$options['absolute-path']) { |
|
| 1236 | + if (!$options['absolute-path']) { |
|
| 1237 | 1237 | $result[] = $name; |
| 1238 | 1238 | } else { |
| 1239 | 1239 | $result[] = $targetFolder.'/'.$name; |
| 1240 | 1240 | } |
| 1241 | 1241 | |
| 1242 | - if(!$options['recursive']) |
|
| 1242 | + if (!$options['recursive']) |
|
| 1243 | 1243 | { |
| 1244 | 1244 | continue; |
| 1245 | 1245 | } |
| 1246 | 1246 | |
| 1247 | 1247 | $subs = self::getSubfolders($targetFolder.'/'.$name, $options); |
| 1248 | - foreach($subs as $sub) |
|
| 1248 | + foreach ($subs as $sub) |
|
| 1249 | 1249 | { |
| 1250 | 1250 | $relative = $name.'/'.$sub; |
| 1251 | 1251 | |
| 1252 | - if(!$options['absolute-path']) { |
|
| 1252 | + if (!$options['absolute-path']) { |
|
| 1253 | 1253 | $result[] = $relative; |
| 1254 | 1254 | } else { |
| 1255 | 1255 | $result[] = $targetFolder.'/'.$relative; |
@@ -1317,7 +1317,7 @@ discard block |
||
| 1317 | 1317 | * @param int $depth The folder depth to reduce the path to |
| 1318 | 1318 | * @return string |
| 1319 | 1319 | */ |
| 1320 | - public static function relativizePathByDepth(string $path, int $depth=2) : string |
|
| 1320 | + public static function relativizePathByDepth(string $path, int $depth = 2) : string |
|
| 1321 | 1321 | { |
| 1322 | 1322 | $path = self::normalizePath($path); |
| 1323 | 1323 | |
@@ -1325,17 +1325,17 @@ discard block |
||
| 1325 | 1325 | $tokens = array_filter($tokens); // remove empty entries (trailing slash for example) |
| 1326 | 1326 | $tokens = array_values($tokens); // re-index keys |
| 1327 | 1327 | |
| 1328 | - if(empty($tokens)) { |
|
| 1328 | + if (empty($tokens)) { |
|
| 1329 | 1329 | return ''; |
| 1330 | 1330 | } |
| 1331 | 1331 | |
| 1332 | 1332 | // remove the drive if present |
| 1333 | - if(strstr($tokens[0], ':')) { |
|
| 1333 | + if (strstr($tokens[0], ':')) { |
|
| 1334 | 1334 | array_shift($tokens); |
| 1335 | 1335 | } |
| 1336 | 1336 | |
| 1337 | 1337 | // path was only the drive |
| 1338 | - if(count($tokens) == 0) { |
|
| 1338 | + if (count($tokens) == 0) { |
|
| 1339 | 1339 | return ''; |
| 1340 | 1340 | } |
| 1341 | 1341 | |
@@ -1344,8 +1344,8 @@ discard block |
||
| 1344 | 1344 | |
| 1345 | 1345 | // reduce the path to the specified depth |
| 1346 | 1346 | $length = count($tokens); |
| 1347 | - if($length > $depth) { |
|
| 1348 | - $tokens = array_slice($tokens, $length-$depth); |
|
| 1347 | + if ($length > $depth) { |
|
| 1348 | + $tokens = array_slice($tokens, $length - $depth); |
|
| 1349 | 1349 | } |
| 1350 | 1350 | |
| 1351 | 1351 | // append the last element again |
@@ -1393,14 +1393,14 @@ discard block |
||
| 1393 | 1393 | * |
| 1394 | 1394 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
| 1395 | 1395 | */ |
| 1396 | - public static function requireFileExists(string $path, $errorCode=null) : string |
|
| 1396 | + public static function requireFileExists(string $path, $errorCode = null) : string |
|
| 1397 | 1397 | { |
| 1398 | 1398 | $result = realpath($path); |
| 1399 | - if($result !== false) { |
|
| 1399 | + if ($result !== false) { |
|
| 1400 | 1400 | return $result; |
| 1401 | 1401 | } |
| 1402 | 1402 | |
| 1403 | - if($errorCode === null) { |
|
| 1403 | + if ($errorCode === null) { |
|
| 1404 | 1404 | $errorCode = self::ERROR_FILE_DOES_NOT_EXIST; |
| 1405 | 1405 | } |
| 1406 | 1406 | |
@@ -1429,15 +1429,15 @@ discard block |
||
| 1429 | 1429 | |
| 1430 | 1430 | $file = new \SplFileObject($path); |
| 1431 | 1431 | |
| 1432 | - if($file->eof()) { |
|
| 1432 | + if ($file->eof()) { |
|
| 1433 | 1433 | return ''; |
| 1434 | 1434 | } |
| 1435 | 1435 | |
| 1436 | - $targetLine = $lineNumber-1; |
|
| 1436 | + $targetLine = $lineNumber - 1; |
|
| 1437 | 1437 | |
| 1438 | 1438 | $file->seek($targetLine); |
| 1439 | 1439 | |
| 1440 | - if($file->key() !== $targetLine) { |
|
| 1440 | + if ($file->key() !== $targetLine) { |
|
| 1441 | 1441 | return null; |
| 1442 | 1442 | } |
| 1443 | 1443 | |
@@ -1463,7 +1463,7 @@ discard block |
||
| 1463 | 1463 | $number = $spl->key(); |
| 1464 | 1464 | |
| 1465 | 1465 | // if seeking to the end the cursor is still at 0, there are no lines. |
| 1466 | - if($number === 0) |
|
| 1466 | + if ($number === 0) |
|
| 1467 | 1467 | { |
| 1468 | 1468 | // since it's a very small file, to get reliable results, |
| 1469 | 1469 | // we read its contents and use that to determine what |
@@ -1471,13 +1471,13 @@ discard block |
||
| 1471 | 1471 | // that this is not pactical to solve with the SplFileObject. |
| 1472 | 1472 | $content = file_get_contents($path); |
| 1473 | 1473 | |
| 1474 | - if(empty($content)) { |
|
| 1474 | + if (empty($content)) { |
|
| 1475 | 1475 | return 0; |
| 1476 | 1476 | } |
| 1477 | 1477 | } |
| 1478 | 1478 | |
| 1479 | 1479 | // return the line number we were able to reach + 1 (key is zero-based) |
| 1480 | - return $number+1; |
|
| 1480 | + return $number + 1; |
|
| 1481 | 1481 | } |
| 1482 | 1482 | |
| 1483 | 1483 | /** |
@@ -1524,13 +1524,13 @@ discard block |
||
| 1524 | 1524 | * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES |
| 1525 | 1525 | * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
| 1526 | 1526 | */ |
| 1527 | - public static function readLines(string $filePath, int $amount=0) : array |
|
| 1527 | + public static function readLines(string $filePath, int $amount = 0) : array |
|
| 1528 | 1528 | { |
| 1529 | 1529 | self::requireFileExists($filePath); |
| 1530 | 1530 | |
| 1531 | 1531 | $fn = fopen($filePath, "r"); |
| 1532 | 1532 | |
| 1533 | - if($fn === false) |
|
| 1533 | + if ($fn === false) |
|
| 1534 | 1534 | { |
| 1535 | 1535 | throw new FileHelper_Exception( |
| 1536 | 1536 | 'Could not open file for reading.', |
@@ -1546,25 +1546,25 @@ discard block |
||
| 1546 | 1546 | $counter = 0; |
| 1547 | 1547 | $first = true; |
| 1548 | 1548 | |
| 1549 | - while(!feof($fn)) |
|
| 1549 | + while (!feof($fn)) |
|
| 1550 | 1550 | { |
| 1551 | 1551 | $counter++; |
| 1552 | 1552 | |
| 1553 | 1553 | $line = fgets($fn); |
| 1554 | 1554 | |
| 1555 | 1555 | // can happen with zero length files |
| 1556 | - if($line === false) { |
|
| 1556 | + if ($line === false) { |
|
| 1557 | 1557 | continue; |
| 1558 | 1558 | } |
| 1559 | 1559 | |
| 1560 | 1560 | // the first line may contain a unicode BOM marker. |
| 1561 | - if($first) { |
|
| 1561 | + if ($first) { |
|
| 1562 | 1562 | $line = ConvertHelper::stripUTFBom($line); |
| 1563 | 1563 | } |
| 1564 | 1564 | |
| 1565 | 1565 | $result[] = $line; |
| 1566 | 1566 | |
| 1567 | - if($amount > 0 && $counter == $amount) { |
|
| 1567 | + if ($amount > 0 && $counter == $amount) { |
|
| 1568 | 1568 | break; |
| 1569 | 1569 | } |
| 1570 | 1570 | } |
@@ -1590,7 +1590,7 @@ discard block |
||
| 1590 | 1590 | |
| 1591 | 1591 | $result = file_get_contents($filePath); |
| 1592 | 1592 | |
| 1593 | - if($result !== false) { |
|
| 1593 | + if ($result !== false) { |
|
| 1594 | 1594 | return $result; |
| 1595 | 1595 | } |
| 1596 | 1596 | |