@@ -55,8 +55,7 @@ |
||
| 55 | 55 | if(is_array($serialized)) |
| 56 | 56 | { |
| 57 | 57 | $this->parseSerialized($serialized); |
| 58 | - } |
|
| 59 | - else |
|
| 58 | + } else |
|
| 60 | 59 | { |
| 61 | 60 | $this->parseValue($value); |
| 62 | 61 | } |
@@ -32,25 +32,25 @@ discard block |
||
| 32 | 32 | self::TYPE_CALLABLE => 'cf5e20' |
| 33 | 33 | ); |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @var string |
|
| 37 | - */ |
|
| 35 | + /** |
|
| 36 | + * @var string |
|
| 37 | + */ |
|
| 38 | 38 | protected $string; |
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * @var mixed |
|
| 42 | - */ |
|
| 40 | + /** |
|
| 41 | + * @var mixed |
|
| 42 | + */ |
|
| 43 | 43 | protected $value; |
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * @var string |
|
| 47 | - */ |
|
| 45 | + /** |
|
| 46 | + * @var string |
|
| 47 | + */ |
|
| 48 | 48 | protected $type; |
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * @param mixed $value |
|
| 52 | - * @param array|null $serialized |
|
| 53 | - */ |
|
| 50 | + /** |
|
| 51 | + * @param mixed $value |
|
| 52 | + * @param array|null $serialized |
|
| 53 | + */ |
|
| 54 | 54 | public function __construct($value, $serialized=null) |
| 55 | 55 | { |
| 56 | 56 | if(is_array($serialized)) |
@@ -63,26 +63,26 @@ discard block |
||
| 63 | 63 | } |
| 64 | 64 | } |
| 65 | 65 | |
| 66 | - /** |
|
| 67 | - * Creates a new variable info instance from a PHP variable |
|
| 68 | - * of any type. |
|
| 69 | - * |
|
| 70 | - * @param mixed $variable |
|
| 71 | - * @return VariableInfo |
|
| 72 | - */ |
|
| 66 | + /** |
|
| 67 | + * Creates a new variable info instance from a PHP variable |
|
| 68 | + * of any type. |
|
| 69 | + * |
|
| 70 | + * @param mixed $variable |
|
| 71 | + * @return VariableInfo |
|
| 72 | + */ |
|
| 73 | 73 | public static function fromVariable($variable) : VariableInfo |
| 74 | 74 | { |
| 75 | 75 | return new VariableInfo($variable); |
| 76 | 76 | } |
| 77 | 77 | |
| 78 | - /** |
|
| 79 | - * Restores a variable info instance using a previously serialized |
|
| 80 | - * array using the serialize() method. |
|
| 81 | - * |
|
| 82 | - * @param array $serialized |
|
| 83 | - * @return VariableInfo |
|
| 84 | - * @see VariableInfo::serialize() |
|
| 85 | - */ |
|
| 78 | + /** |
|
| 79 | + * Restores a variable info instance using a previously serialized |
|
| 80 | + * array using the serialize() method. |
|
| 81 | + * |
|
| 82 | + * @param array $serialized |
|
| 83 | + * @return VariableInfo |
|
| 84 | + * @see VariableInfo::serialize() |
|
| 85 | + */ |
|
| 86 | 86 | public static function fromSerialized(array $serialized) : VariableInfo |
| 87 | 87 | { |
| 88 | 88 | return new VariableInfo(null, $serialized); |
@@ -108,12 +108,12 @@ discard block |
||
| 108 | 108 | $this->string = $this->_toString(); |
| 109 | 109 | } |
| 110 | 110 | |
| 111 | - /** |
|
| 112 | - * The variable type - this is the same string that |
|
| 113 | - * is returned by the PHP function `gettype`. |
|
| 114 | - * |
|
| 115 | - * @return string |
|
| 116 | - */ |
|
| 111 | + /** |
|
| 112 | + * The variable type - this is the same string that |
|
| 113 | + * is returned by the PHP function `gettype`. |
|
| 114 | + * |
|
| 115 | + * @return string |
|
| 116 | + */ |
|
| 117 | 117 | public function getType() : string |
| 118 | 118 | { |
| 119 | 119 | return $this->type; |
@@ -127,13 +127,13 @@ discard block |
||
| 127 | 127 | ); |
| 128 | 128 | } |
| 129 | 129 | |
| 130 | - /** |
|
| 131 | - * Whether to prepend the variable type before the value, |
|
| 132 | - * like the var_dump function. Example: <code>string "Some text"</code>. |
|
| 133 | - * |
|
| 134 | - * @param bool $enable |
|
| 135 | - * @return VariableInfo |
|
| 136 | - */ |
|
| 130 | + /** |
|
| 131 | + * Whether to prepend the variable type before the value, |
|
| 132 | + * like the var_dump function. Example: <code>string "Some text"</code>. |
|
| 133 | + * |
|
| 134 | + * @param bool $enable |
|
| 135 | + * @return VariableInfo |
|
| 136 | + */ |
|
| 137 | 137 | public function enableType(bool $enable=true) : VariableInfo |
| 138 | 138 | { |
| 139 | 139 | return $this->setOption('prepend-type', $enable); |
@@ -203,12 +203,12 @@ discard block |
||
| 203 | 203 | return $converted; |
| 204 | 204 | } |
| 205 | 205 | |
| 206 | - /** |
|
| 207 | - * Converts an array to a string. |
|
| 208 | - * @return string |
|
| 209 | - * |
|
| 210 | - * @todo Create custom dump implementation, using VariableInfo instances. |
|
| 211 | - */ |
|
| 206 | + /** |
|
| 207 | + * Converts an array to a string. |
|
| 208 | + * @return string |
|
| 209 | + * |
|
| 210 | + * @todo Create custom dump implementation, using VariableInfo instances. |
|
| 211 | + */ |
|
| 212 | 212 | protected function toString_array() : string |
| 213 | 213 | { |
| 214 | 214 | $result = json_encode($this->value, JSON_PRETTY_PRINT); |
@@ -51,9 +51,9 @@ discard block |
||
| 51 | 51 | * @param mixed $value |
| 52 | 52 | * @param array|null $serialized |
| 53 | 53 | */ |
| 54 | - public function __construct($value, $serialized=null) |
|
| 54 | + public function __construct($value, $serialized = null) |
|
| 55 | 55 | { |
| 56 | - if(is_array($serialized)) |
|
| 56 | + if (is_array($serialized)) |
|
| 57 | 57 | { |
| 58 | 58 | $this->parseSerialized($serialized); |
| 59 | 59 | } |
@@ -101,7 +101,7 @@ discard block |
||
| 101 | 101 | $this->value = $value; |
| 102 | 102 | $this->type = strtolower(gettype($value)); |
| 103 | 103 | |
| 104 | - if(is_array($value) && is_callable($value)) { |
|
| 104 | + if (is_array($value) && is_callable($value)) { |
|
| 105 | 105 | $this->type = self::TYPE_CALLABLE; |
| 106 | 106 | } |
| 107 | 107 | |
@@ -134,7 +134,7 @@ discard block |
||
| 134 | 134 | * @param bool $enable |
| 135 | 135 | * @return VariableInfo |
| 136 | 136 | */ |
| 137 | - public function enableType(bool $enable=true) : VariableInfo |
|
| 137 | + public function enableType(bool $enable = true) : VariableInfo |
|
| 138 | 138 | { |
| 139 | 139 | return $this->setOption('prepend-type', $enable); |
| 140 | 140 | } |
@@ -143,9 +143,9 @@ discard block |
||
| 143 | 143 | { |
| 144 | 144 | $converted = $this->string; |
| 145 | 145 | |
| 146 | - if($this->getOption('prepend-type') === true && !$this->isNull()) |
|
| 146 | + if ($this->getOption('prepend-type') === true && !$this->isNull()) |
|
| 147 | 147 | { |
| 148 | - if($this->isString()) |
|
| 148 | + if ($this->isString()) |
|
| 149 | 149 | { |
| 150 | 150 | $converted = '"'.$converted.'"'; |
| 151 | 151 | } |
@@ -177,16 +177,16 @@ discard block |
||
| 177 | 177 | |
| 178 | 178 | $converted = $this->$varMethod(); |
| 179 | 179 | |
| 180 | - if($format === 'HTML') |
|
| 180 | + if ($format === 'HTML') |
|
| 181 | 181 | { |
| 182 | 182 | $converted = '<span style="color:#'.self::$colors[$type].'" class="variable-value-'.$this->type.'">'.$converted.'</span>'; |
| 183 | 183 | } |
| 184 | 184 | |
| 185 | - if($this->getOption('prepend-type') === true && !$this->isNull()) |
|
| 185 | + if ($this->getOption('prepend-type') === true && !$this->isNull()) |
|
| 186 | 186 | { |
| 187 | 187 | $typeLabel = $type; |
| 188 | 188 | |
| 189 | - switch($format) |
|
| 189 | + switch ($format) |
|
| 190 | 190 | { |
| 191 | 191 | case 'HTML': |
| 192 | 192 | $typeLabel = '<span style="color:#1c2eb1" class="variable-type">'.$type.'</span> '; |
@@ -215,7 +215,7 @@ discard block |
||
| 215 | 215 | |
| 216 | 216 | // the array may not be encodable - for example if it contains |
| 217 | 217 | // broken unicode characters. |
| 218 | - if(is_string($result) && $result !== '') { |
|
| 218 | + if (is_string($result) && $result !== '') { |
|
| 219 | 219 | return $result; |
| 220 | 220 | } |
| 221 | 221 | |
@@ -226,7 +226,7 @@ discard block |
||
| 226 | 226 | { |
| 227 | 227 | $string = ''; |
| 228 | 228 | |
| 229 | - if(is_string($this->value[0])) { |
|
| 229 | + if (is_string($this->value[0])) { |
|
| 230 | 230 | $string .= $this->value[0].'::'; |
| 231 | 231 | } else { |
| 232 | 232 | $string .= get_class($this->value[0]).'->'; |
@@ -353,7 +353,7 @@ discard block |
||
| 353 | 353 | str_replace(' ', '-', $this->type) |
| 354 | 354 | ); |
| 355 | 355 | |
| 356 | - if($this->getOption('prepend-type') === true && !$this->isNull()) |
|
| 356 | + if ($this->getOption('prepend-type') === true && !$this->isNull()) |
|
| 357 | 357 | { |
| 358 | 358 | $typeLabel = '<span style="color:#1c2eb1" class="variable-type">'.$this->type.'</span> '; |
| 359 | 359 | $converted = $typeLabel.' '.$converted; |
@@ -59,8 +59,7 @@ discard block |
||
| 59 | 59 | try |
| 60 | 60 | { |
| 61 | 61 | throw new BaseException(''); |
| 62 | - } |
|
| 63 | - catch(BaseException $e) |
|
| 62 | + } catch(BaseException $e) |
|
| 64 | 63 | { |
| 65 | 64 | echo self::createInfo($e)->toString(); |
| 66 | 65 | } |
@@ -74,8 +73,7 @@ discard block |
||
| 74 | 73 | try |
| 75 | 74 | { |
| 76 | 75 | throw new BaseException(''); |
| 77 | - } |
|
| 78 | - catch(BaseException $e) |
|
| 76 | + } catch(BaseException $e) |
|
| 79 | 77 | { |
| 80 | 78 | echo '<pre style="background:#fff;font-family:monospace;font-size:14px;color:#444;padding:16px;border:solid 1px #999;border-radius:4px;">'; |
| 81 | 79 | echo self::createInfo($e)->toString(); |
@@ -20,17 +20,17 @@ discard block |
||
| 20 | 20 | */ |
| 21 | 21 | class BaseException extends \Exception |
| 22 | 22 | { |
| 23 | - /** |
|
| 24 | - * @var string |
|
| 25 | - */ |
|
| 23 | + /** |
|
| 24 | + * @var string |
|
| 25 | + */ |
|
| 26 | 26 | protected $details; |
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * @param string $message |
|
| 30 | - * @param string $details |
|
| 31 | - * @param int $code |
|
| 32 | - * @param \Exception $previous |
|
| 33 | - */ |
|
| 28 | + /** |
|
| 29 | + * @param string $message |
|
| 30 | + * @param string $details |
|
| 31 | + * @param int $code |
|
| 32 | + * @param \Exception $previous |
|
| 33 | + */ |
|
| 34 | 34 | public function __construct(string $message, $details=null, $code=null, $previous=null) |
| 35 | 35 | { |
| 36 | 36 | parent::__construct($message, $code, $previous); |
@@ -38,10 +38,10 @@ discard block |
||
| 38 | 38 | $this->details = $details; |
| 39 | 39 | } |
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * Retrieves the detailed error description, if any. |
|
| 43 | - * @return string |
|
| 44 | - */ |
|
| 41 | + /** |
|
| 42 | + * Retrieves the detailed error description, if any. |
|
| 43 | + * @return string |
|
| 44 | + */ |
|
| 45 | 45 | public function getDetails() : string |
| 46 | 46 | { |
| 47 | 47 | if($this->details !== null) { |
@@ -51,10 +51,10 @@ discard block |
||
| 51 | 51 | return ''; |
| 52 | 52 | } |
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * Displays pertinent information on the exception in |
|
| 56 | - * the browser, and exits the script. |
|
| 57 | - */ |
|
| 54 | + /** |
|
| 55 | + * Displays pertinent information on the exception in |
|
| 56 | + * the browser, and exits the script. |
|
| 57 | + */ |
|
| 58 | 58 | public function display() |
| 59 | 59 | { |
| 60 | 60 | if(!headers_sent()) { |
@@ -65,20 +65,20 @@ discard block |
||
| 65 | 65 | exit; |
| 66 | 66 | } |
| 67 | 67 | |
| 68 | - /** |
|
| 69 | - * Retrieves information on the exception that can be |
|
| 70 | - * easily accessed. |
|
| 71 | - * |
|
| 72 | - * @return ConvertHelper_ThrowableInfo |
|
| 73 | - */ |
|
| 68 | + /** |
|
| 69 | + * Retrieves information on the exception that can be |
|
| 70 | + * easily accessed. |
|
| 71 | + * |
|
| 72 | + * @return ConvertHelper_ThrowableInfo |
|
| 73 | + */ |
|
| 74 | 74 | public function getInfo() : ConvertHelper_ThrowableInfo |
| 75 | 75 | { |
| 76 | 76 | return ConvertHelper::throwable2info($this); |
| 77 | 77 | } |
| 78 | 78 | |
| 79 | - /** |
|
| 80 | - * Dumps a current PHP function trace, as a textonly string. |
|
| 81 | - */ |
|
| 79 | + /** |
|
| 80 | + * Dumps a current PHP function trace, as a textonly string. |
|
| 81 | + */ |
|
| 82 | 82 | public static function dumpTraceAsString() |
| 83 | 83 | { |
| 84 | 84 | try |
@@ -91,9 +91,9 @@ discard block |
||
| 91 | 91 | } |
| 92 | 92 | } |
| 93 | 93 | |
| 94 | - /** |
|
| 95 | - * Dumps a current PHP function trace, with HTML styling. |
|
| 96 | - */ |
|
| 94 | + /** |
|
| 95 | + * Dumps a current PHP function trace, with HTML styling. |
|
| 96 | + */ |
|
| 97 | 97 | public static function dumpTraceAsHTML() |
| 98 | 98 | { |
| 99 | 99 | try |
@@ -108,13 +108,13 @@ discard block |
||
| 108 | 108 | } |
| 109 | 109 | } |
| 110 | 110 | |
| 111 | - /** |
|
| 112 | - * Creates an exception info instance from a throwable instance. |
|
| 113 | - * |
|
| 114 | - * @param \Throwable $e |
|
| 115 | - * @return ConvertHelper_ThrowableInfo |
|
| 116 | - * @see ConvertHelper::throwable2info() |
|
| 117 | - */ |
|
| 111 | + /** |
|
| 112 | + * Creates an exception info instance from a throwable instance. |
|
| 113 | + * |
|
| 114 | + * @param \Throwable $e |
|
| 115 | + * @return ConvertHelper_ThrowableInfo |
|
| 116 | + * @see ConvertHelper::throwable2info() |
|
| 117 | + */ |
|
| 118 | 118 | public static function createInfo(\Throwable $e) : ConvertHelper_ThrowableInfo |
| 119 | 119 | { |
| 120 | 120 | return ConvertHelper::throwable2info($e); |
@@ -31,7 +31,7 @@ discard block |
||
| 31 | 31 | * @param int $code |
| 32 | 32 | * @param \Exception $previous |
| 33 | 33 | */ |
| 34 | - public function __construct(string $message, $details=null, $code=null, $previous=null) |
|
| 34 | + public function __construct(string $message, $details = null, $code = null, $previous = null) |
|
| 35 | 35 | { |
| 36 | 36 | parent::__construct($message, $code, $previous); |
| 37 | 37 | |
@@ -44,7 +44,7 @@ discard block |
||
| 44 | 44 | */ |
| 45 | 45 | public function getDetails() : string |
| 46 | 46 | { |
| 47 | - if($this->details !== null) { |
|
| 47 | + if ($this->details !== null) { |
|
| 48 | 48 | return $this->details; |
| 49 | 49 | } |
| 50 | 50 | |
@@ -57,7 +57,7 @@ discard block |
||
| 57 | 57 | */ |
| 58 | 58 | public function display() |
| 59 | 59 | { |
| 60 | - if(!headers_sent()) { |
|
| 60 | + if (!headers_sent()) { |
|
| 61 | 61 | header('Content-type:text/plain; charset=utf-8'); |
| 62 | 62 | } |
| 63 | 63 | |
@@ -85,7 +85,7 @@ discard block |
||
| 85 | 85 | { |
| 86 | 86 | throw new BaseException(''); |
| 87 | 87 | } |
| 88 | - catch(BaseException $e) |
|
| 88 | + catch (BaseException $e) |
|
| 89 | 89 | { |
| 90 | 90 | echo self::createInfo($e)->toString(); |
| 91 | 91 | } |
@@ -100,7 +100,7 @@ discard block |
||
| 100 | 100 | { |
| 101 | 101 | throw new BaseException(''); |
| 102 | 102 | } |
| 103 | - catch(BaseException $e) |
|
| 103 | + catch (BaseException $e) |
|
| 104 | 104 | { |
| 105 | 105 | echo '<pre style="background:#fff;font-family:monospace;font-size:14px;color:#444;padding:16px;border:solid 1px #999;border-radius:4px;">'; |
| 106 | 106 | echo self::createInfo($e)->toString(); |
@@ -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 | |
@@ -38,9 +38,9 @@ discard block |
||
| 38 | 38 | |
| 39 | 39 | protected $file; |
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * @var \ZipArchive |
|
| 43 | - */ |
|
| 41 | + /** |
|
| 42 | + * @var \ZipArchive |
|
| 43 | + */ |
|
| 44 | 44 | protected $zip; |
| 45 | 45 | |
| 46 | 46 | public function __construct($targetFile) |
@@ -48,33 +48,33 @@ discard block |
||
| 48 | 48 | $this->file = $targetFile; |
| 49 | 49 | } |
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * Sets an option, among the available options: |
|
| 53 | - * |
|
| 54 | - * <ul> |
|
| 55 | - * <li>WriteThreshold: The amount of files to add before the zip is automatically written to disk and re-opened to release the file handles. Set to 0 to disable.</li> |
|
| 56 | - * </ul> |
|
| 57 | - * |
|
| 58 | - * @param string $name |
|
| 59 | - * @param mixed $value |
|
| 60 | - * @return ZIPHelper |
|
| 61 | - */ |
|
| 51 | + /** |
|
| 52 | + * Sets an option, among the available options: |
|
| 53 | + * |
|
| 54 | + * <ul> |
|
| 55 | + * <li>WriteThreshold: The amount of files to add before the zip is automatically written to disk and re-opened to release the file handles. Set to 0 to disable.</li> |
|
| 56 | + * </ul> |
|
| 57 | + * |
|
| 58 | + * @param string $name |
|
| 59 | + * @param mixed $value |
|
| 60 | + * @return ZIPHelper |
|
| 61 | + */ |
|
| 62 | 62 | public function setOption($name, $value) |
| 63 | 63 | { |
| 64 | 64 | $this->options[$name] = $value; |
| 65 | 65 | return $this; |
| 66 | 66 | } |
| 67 | 67 | |
| 68 | - /** |
|
| 69 | - * Adds a file to the zip. By default, the file is stored |
|
| 70 | - * with the same name in the root of the zip. Use the optional |
|
| 71 | - * parameter to change the location in the zip. |
|
| 72 | - * |
|
| 73 | - * @param string $filePath |
|
| 74 | - * @param string $zipPath |
|
| 75 | - * @throws ZIPHelper_Exception |
|
| 76 | - * @return bool |
|
| 77 | - */ |
|
| 68 | + /** |
|
| 69 | + * Adds a file to the zip. By default, the file is stored |
|
| 70 | + * with the same name in the root of the zip. Use the optional |
|
| 71 | + * parameter to change the location in the zip. |
|
| 72 | + * |
|
| 73 | + * @param string $filePath |
|
| 74 | + * @param string $zipPath |
|
| 75 | + * @throws ZIPHelper_Exception |
|
| 76 | + * @return bool |
|
| 77 | + */ |
|
| 78 | 78 | public function addFile($filePath, $zipPath=null) |
| 79 | 79 | { |
| 80 | 80 | $this->open(); |
@@ -252,13 +252,13 @@ discard block |
||
| 252 | 252 | |
| 253 | 253 | protected $exit; |
| 254 | 254 | |
| 255 | - /** |
|
| 256 | - * Like {@link ZIPHelper::download()}, but deletes the |
|
| 257 | - * file after sending it to the browser. |
|
| 258 | - * |
|
| 259 | - * @param string|NULL $fileName Override the ZIP's file name for the download |
|
| 260 | - * @see ZIPHelper::download() |
|
| 261 | - */ |
|
| 255 | + /** |
|
| 256 | + * Like {@link ZIPHelper::download()}, but deletes the |
|
| 257 | + * file after sending it to the browser. |
|
| 258 | + * |
|
| 259 | + * @param string|NULL $fileName Override the ZIP's file name for the download |
|
| 260 | + * @see ZIPHelper::download() |
|
| 261 | + */ |
|
| 262 | 262 | public function downloadAndDelete($fileName=null) |
| 263 | 263 | { |
| 264 | 264 | $this->exit = false; |
@@ -272,14 +272,14 @@ discard block |
||
| 272 | 272 | exit; |
| 273 | 273 | } |
| 274 | 274 | |
| 275 | - /** |
|
| 276 | - * Extracts all files and folders from the zip to the |
|
| 277 | - * target folder. If no folder is specified, the files |
|
| 278 | - * are extracted into the same folder as the zip itself. |
|
| 279 | - * |
|
| 280 | - * @param string $outputFolder |
|
| 281 | - * @return boolean |
|
| 282 | - */ |
|
| 275 | + /** |
|
| 276 | + * Extracts all files and folders from the zip to the |
|
| 277 | + * target folder. If no folder is specified, the files |
|
| 278 | + * are extracted into the same folder as the zip itself. |
|
| 279 | + * |
|
| 280 | + * @param string $outputFolder |
|
| 281 | + * @return boolean |
|
| 282 | + */ |
|
| 283 | 283 | public function extractAll($outputFolder=null) |
| 284 | 284 | { |
| 285 | 285 | if(empty($outputFolder)) { |
@@ -292,9 +292,9 @@ discard block |
||
| 292 | 292 | } |
| 293 | 293 | |
| 294 | 294 | |
| 295 | - /** |
|
| 296 | - * @return \ZipArchive |
|
| 297 | - */ |
|
| 295 | + /** |
|
| 296 | + * @return \ZipArchive |
|
| 297 | + */ |
|
| 298 | 298 | public function getArchive() |
| 299 | 299 | { |
| 300 | 300 | $this->open(); |
@@ -302,14 +302,14 @@ discard block |
||
| 302 | 302 | return $this->zip; |
| 303 | 303 | } |
| 304 | 304 | |
| 305 | - /** |
|
| 306 | - * JSON encodes the specified data and adds the json as |
|
| 307 | - * a file in the ZIP archive. |
|
| 308 | - * |
|
| 309 | - * @param mixed $data |
|
| 310 | - * @param string $zipPath |
|
| 311 | - * @return boolean |
|
| 312 | - */ |
|
| 305 | + /** |
|
| 306 | + * JSON encodes the specified data and adds the json as |
|
| 307 | + * a file in the ZIP archive. |
|
| 308 | + * |
|
| 309 | + * @param mixed $data |
|
| 310 | + * @param string $zipPath |
|
| 311 | + * @return boolean |
|
| 312 | + */ |
|
| 313 | 313 | public function addJSON($data, $zipPath) |
| 314 | 314 | { |
| 315 | 315 | return $this->addString( |
@@ -30,7 +30,7 @@ discard block |
||
| 30 | 30 | |
| 31 | 31 | const ERROR_OPENING_ZIP_FILE = 338003; |
| 32 | 32 | |
| 33 | - const ERROR_CANNOT_SAVE_FILE_TO_DISK =338004; |
|
| 33 | + const ERROR_CANNOT_SAVE_FILE_TO_DISK = 338004; |
|
| 34 | 34 | |
| 35 | 35 | protected $options = array( |
| 36 | 36 | 'WriteThreshold' => 100 |
@@ -75,7 +75,7 @@ discard block |
||
| 75 | 75 | * @throws ZIPHelper_Exception |
| 76 | 76 | * @return bool |
| 77 | 77 | */ |
| 78 | - public function addFile($filePath, $zipPath=null) |
|
| 78 | + public function addFile($filePath, $zipPath = null) |
|
| 79 | 79 | { |
| 80 | 80 | $this->open(); |
| 81 | 81 | |
@@ -120,16 +120,16 @@ discard block |
||
| 120 | 120 | |
| 121 | 121 | protected function open() |
| 122 | 122 | { |
| 123 | - if($this->open) { |
|
| 123 | + if ($this->open) { |
|
| 124 | 124 | return; |
| 125 | 125 | } |
| 126 | 126 | |
| 127 | - if(!isset($this->zip)) { |
|
| 127 | + if (!isset($this->zip)) { |
|
| 128 | 128 | $this->zip = new \ZipArchive(); |
| 129 | 129 | } |
| 130 | 130 | |
| 131 | 131 | $flag = null; |
| 132 | - if(!file_exists($this->file)) { |
|
| 132 | + if (!file_exists($this->file)) { |
|
| 133 | 133 | $flag = \ZipArchive::CREATE; |
| 134 | 134 | } |
| 135 | 135 | |
@@ -169,7 +169,7 @@ discard block |
||
| 169 | 169 | { |
| 170 | 170 | $this->fileTracker++; |
| 171 | 171 | |
| 172 | - if($this->options['WriteThreshold'] < 1) { |
|
| 172 | + if ($this->options['WriteThreshold'] < 1) { |
|
| 173 | 173 | return; |
| 174 | 174 | } |
| 175 | 175 | |
@@ -182,7 +182,7 @@ discard block |
||
| 182 | 182 | |
| 183 | 183 | protected function close() |
| 184 | 184 | { |
| 185 | - if(!$this->open) { |
|
| 185 | + if (!$this->open) { |
|
| 186 | 186 | return; |
| 187 | 187 | } |
| 188 | 188 | |
@@ -190,8 +190,8 @@ discard block |
||
| 190 | 190 | throw new ZIPHelper_Exception( |
| 191 | 191 | 'Could not save ZIP file to disk', |
| 192 | 192 | sprintf( |
| 193 | - 'Tried saving the ZIP file [%1$s], but the write failed. This can have several causes, ' . |
|
| 194 | - 'including adding files that do not exist on disk, trying to create an empty zip, ' . |
|
| 193 | + 'Tried saving the ZIP file [%1$s], but the write failed. This can have several causes, '. |
|
| 194 | + 'including adding files that do not exist on disk, trying to create an empty zip, '. |
|
| 195 | 195 | 'or trying to save to a directory that does not exist.', |
| 196 | 196 | $this->file |
| 197 | 197 | ), |
@@ -228,22 +228,22 @@ discard block |
||
| 228 | 228 | * @see ZIPHelper::downloadAndDelete() |
| 229 | 229 | * @throws ZIPHelper_Exception |
| 230 | 230 | */ |
| 231 | - public function download($fileName=null) |
|
| 231 | + public function download($fileName = null) |
|
| 232 | 232 | { |
| 233 | 233 | $this->save(); |
| 234 | 234 | |
| 235 | - if(empty($fileName)) { |
|
| 235 | + if (empty($fileName)) { |
|
| 236 | 236 | $fileName = basename($this->file); |
| 237 | 237 | } |
| 238 | 238 | |
| 239 | 239 | header('Content-type: application/zip'); |
| 240 | - header('Content-Disposition: attachment; filename=' . $fileName); |
|
| 241 | - header('Content-length: ' . filesize($this->file)); |
|
| 240 | + header('Content-Disposition: attachment; filename='.$fileName); |
|
| 241 | + header('Content-length: '.filesize($this->file)); |
|
| 242 | 242 | header('Pragma: no-cache'); |
| 243 | 243 | header('Expires: 0'); |
| 244 | 244 | readfile($this->file); |
| 245 | 245 | |
| 246 | - if($this->exit === false) { |
|
| 246 | + if ($this->exit === false) { |
|
| 247 | 247 | return; |
| 248 | 248 | } |
| 249 | 249 | |
@@ -259,7 +259,7 @@ discard block |
||
| 259 | 259 | * @param string|NULL $fileName Override the ZIP's file name for the download |
| 260 | 260 | * @see ZIPHelper::download() |
| 261 | 261 | */ |
| 262 | - public function downloadAndDelete($fileName=null) |
|
| 262 | + public function downloadAndDelete($fileName = null) |
|
| 263 | 263 | { |
| 264 | 264 | $this->exit = false; |
| 265 | 265 | |
@@ -280,9 +280,9 @@ discard block |
||
| 280 | 280 | * @param string $outputFolder |
| 281 | 281 | * @return boolean |
| 282 | 282 | */ |
| 283 | - public function extractAll($outputFolder=null) |
|
| 283 | + public function extractAll($outputFolder = null) |
|
| 284 | 284 | { |
| 285 | - if(empty($outputFolder)) { |
|
| 285 | + if (empty($outputFolder)) { |
|
| 286 | 286 | $outputFolder = dirname($this->file); |
| 287 | 287 | } |
| 288 | 288 | |
@@ -60,7 +60,7 @@ discard block |
||
| 60 | 60 | * The converted string will be all lowercase. |
| 61 | 61 | * @return Transliteration |
| 62 | 62 | */ |
| 63 | - public function setLowercase(bool $lowercase=true) : Transliteration |
|
| 63 | + public function setLowercase(bool $lowercase = true) : Transliteration |
|
| 64 | 64 | { |
| 65 | 65 | $this->setOption('lowercase', true); |
| 66 | 66 | |
@@ -97,8 +97,8 @@ discard block |
||
| 97 | 97 | |
| 98 | 98 | $result = implode('', $keep); |
| 99 | 99 | |
| 100 | - while (strstr($result, $space . $space)) { |
|
| 101 | - $result = str_replace($space . $space, $space, $result); |
|
| 100 | + while (strstr($result, $space.$space)) { |
|
| 101 | + $result = str_replace($space.$space, $space, $result); |
|
| 102 | 102 | } |
| 103 | 103 | |
| 104 | 104 | $result = trim($result, $space); |
@@ -19,15 +19,15 @@ discard block |
||
| 19 | 19 | const TYPE_PHONE = 'phone'; |
| 20 | 20 | const TYPE_URL = 'url'; |
| 21 | 21 | |
| 22 | - /** |
|
| 23 | - * The original URL that was passed to the constructor. |
|
| 24 | - * @var string |
|
| 25 | - */ |
|
| 22 | + /** |
|
| 23 | + * The original URL that was passed to the constructor. |
|
| 24 | + * @var string |
|
| 25 | + */ |
|
| 26 | 26 | protected $rawURL; |
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * @var string |
|
| 30 | - */ |
|
| 28 | + /** |
|
| 29 | + * @var string |
|
| 30 | + */ |
|
| 31 | 31 | protected $info; |
| 32 | 32 | |
| 33 | 33 | protected $isEmail = false; |
@@ -38,9 +38,9 @@ discard block |
||
| 38 | 38 | |
| 39 | 39 | protected $isPhone = false; |
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * @var string[] |
|
| 43 | - */ |
|
| 41 | + /** |
|
| 42 | + * @var string[] |
|
| 43 | + */ |
|
| 44 | 44 | protected $knownSchemes = array( |
| 45 | 45 | 'ftp', |
| 46 | 46 | 'http', |
@@ -51,36 +51,36 @@ discard block |
||
| 51 | 51 | 'file' |
| 52 | 52 | ); |
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * @var array |
|
| 56 | - */ |
|
| 54 | + /** |
|
| 55 | + * @var array |
|
| 56 | + */ |
|
| 57 | 57 | protected $error; |
| 58 | 58 | |
| 59 | - /** |
|
| 60 | - * @var array |
|
| 61 | - */ |
|
| 59 | + /** |
|
| 60 | + * @var array |
|
| 61 | + */ |
|
| 62 | 62 | protected $params = array(); |
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * @var string[] |
|
| 66 | - */ |
|
| 64 | + /** |
|
| 65 | + * @var string[] |
|
| 66 | + */ |
|
| 67 | 67 | protected $excludedParams = array(); |
| 68 | 68 | |
| 69 | - /** |
|
| 70 | - * @var bool |
|
| 71 | - * @see URLInfo::setParamExclusion() |
|
| 72 | - */ |
|
| 69 | + /** |
|
| 70 | + * @var bool |
|
| 71 | + * @see URLInfo::setParamExclusion() |
|
| 72 | + */ |
|
| 73 | 73 | protected $paramExclusion = false; |
| 74 | 74 | |
| 75 | - /** |
|
| 76 | - * @var array |
|
| 77 | - * @see URLInfo::getTypeLabel() |
|
| 78 | - */ |
|
| 75 | + /** |
|
| 76 | + * @var array |
|
| 77 | + * @see URLInfo::getTypeLabel() |
|
| 78 | + */ |
|
| 79 | 79 | protected static $typeLabels; |
| 80 | 80 | |
| 81 | - /** |
|
| 82 | - * @var bool |
|
| 83 | - */ |
|
| 81 | + /** |
|
| 82 | + * @var bool |
|
| 83 | + */ |
|
| 84 | 84 | protected $highlightExcluded = false; |
| 85 | 85 | |
| 86 | 86 | protected $infoKeys = array( |
@@ -177,13 +177,13 @@ discard block |
||
| 177 | 177 | $this->isValid = true; |
| 178 | 178 | } |
| 179 | 179 | |
| 180 | - /** |
|
| 181 | - * Filters an URL: removes control characters and the |
|
| 182 | - * like to have a clean URL to work with. |
|
| 183 | - * |
|
| 184 | - * @param string $url |
|
| 185 | - * @return string |
|
| 186 | - */ |
|
| 180 | + /** |
|
| 181 | + * Filters an URL: removes control characters and the |
|
| 182 | + * like to have a clean URL to work with. |
|
| 183 | + * |
|
| 184 | + * @param string $url |
|
| 185 | + * @return string |
|
| 186 | + */ |
|
| 187 | 187 | public static function filterURL(string $url) |
| 188 | 188 | { |
| 189 | 189 | // fix ampersands if it comes from HTML |
@@ -206,11 +206,11 @@ discard block |
||
| 206 | 206 | return $url; |
| 207 | 207 | } |
| 208 | 208 | |
| 209 | - /** |
|
| 210 | - * Goes through all information in the parse_url result |
|
| 211 | - * array, and attempts to fix any user errors in formatting |
|
| 212 | - * that can be recovered from, mostly regarding stray spaces. |
|
| 213 | - */ |
|
| 209 | + /** |
|
| 210 | + * Goes through all information in the parse_url result |
|
| 211 | + * array, and attempts to fix any user errors in formatting |
|
| 212 | + * that can be recovered from, mostly regarding stray spaces. |
|
| 213 | + */ |
|
| 214 | 214 | protected function filterParsed() |
| 215 | 215 | { |
| 216 | 216 | foreach($this->info as $key => $val) |
@@ -294,12 +294,12 @@ discard block |
||
| 294 | 294 | return $this->isPhone; |
| 295 | 295 | } |
| 296 | 296 | |
| 297 | - /** |
|
| 298 | - * Whether the URL is a regular URL, not one of the |
|
| 299 | - * other types like a phone number or email address. |
|
| 300 | - * |
|
| 301 | - * @return bool |
|
| 302 | - */ |
|
| 297 | + /** |
|
| 298 | + * Whether the URL is a regular URL, not one of the |
|
| 299 | + * other types like a phone number or email address. |
|
| 300 | + * |
|
| 301 | + * @return bool |
|
| 302 | + */ |
|
| 303 | 303 | public function isURL() : bool |
| 304 | 304 | { |
| 305 | 305 | $host = $this->getHost(); |
@@ -311,20 +311,20 @@ discard block |
||
| 311 | 311 | return $this->isValid; |
| 312 | 312 | } |
| 313 | 313 | |
| 314 | - /** |
|
| 315 | - * Retrieves the host name, or an empty string if none is present. |
|
| 316 | - * |
|
| 317 | - * @return string |
|
| 318 | - */ |
|
| 314 | + /** |
|
| 315 | + * Retrieves the host name, or an empty string if none is present. |
|
| 316 | + * |
|
| 317 | + * @return string |
|
| 318 | + */ |
|
| 319 | 319 | public function getHost() : string |
| 320 | 320 | { |
| 321 | 321 | return $this->getInfoKey('host'); |
| 322 | 322 | } |
| 323 | 323 | |
| 324 | - /** |
|
| 325 | - * Retrieves the path, or an empty string if none is present. |
|
| 326 | - * @return string |
|
| 327 | - */ |
|
| 324 | + /** |
|
| 325 | + * Retrieves the path, or an empty string if none is present. |
|
| 326 | + * @return string |
|
| 327 | + */ |
|
| 328 | 328 | public function getPath() : string |
| 329 | 329 | { |
| 330 | 330 | return $this->getInfoKey('path'); |
@@ -340,10 +340,10 @@ discard block |
||
| 340 | 340 | return $this->getInfoKey('scheme'); |
| 341 | 341 | } |
| 342 | 342 | |
| 343 | - /** |
|
| 344 | - * Retrieves the port specified in the URL, or -1 if none is preseent. |
|
| 345 | - * @return int |
|
| 346 | - */ |
|
| 343 | + /** |
|
| 344 | + * Retrieves the port specified in the URL, or -1 if none is preseent. |
|
| 345 | + * @return int |
|
| 346 | + */ |
|
| 347 | 347 | public function getPort() : int |
| 348 | 348 | { |
| 349 | 349 | $port = $this->getInfoKey('port'); |
@@ -354,13 +354,13 @@ discard block |
||
| 354 | 354 | return -1; |
| 355 | 355 | } |
| 356 | 356 | |
| 357 | - /** |
|
| 358 | - * Retrieves the raw query string, or an empty string if none is present. |
|
| 359 | - * |
|
| 360 | - * @return string |
|
| 361 | - * |
|
| 362 | - * @see URLInfo::getParams() |
|
| 363 | - */ |
|
| 357 | + /** |
|
| 358 | + * Retrieves the raw query string, or an empty string if none is present. |
|
| 359 | + * |
|
| 360 | + * @return string |
|
| 361 | + * |
|
| 362 | + * @see URLInfo::getParams() |
|
| 363 | + */ |
|
| 364 | 364 | public function getQuery() : string |
| 365 | 365 | { |
| 366 | 366 | return $this->getInfoKey('query'); |
@@ -376,20 +376,20 @@ discard block |
||
| 376 | 376 | return $this->getInfoKey('pass'); |
| 377 | 377 | } |
| 378 | 378 | |
| 379 | - /** |
|
| 380 | - * Whether the URL contains a port number. |
|
| 381 | - * @return bool |
|
| 382 | - */ |
|
| 379 | + /** |
|
| 380 | + * Whether the URL contains a port number. |
|
| 381 | + * @return bool |
|
| 382 | + */ |
|
| 383 | 383 | public function hasPort() : bool |
| 384 | 384 | { |
| 385 | 385 | return $this->getPort() !== -1; |
| 386 | 386 | } |
| 387 | 387 | |
| 388 | - /** |
|
| 389 | - * Alias for the hasParams() method. |
|
| 390 | - * @return bool |
|
| 391 | - * @see URLInfo::hasParams() |
|
| 392 | - */ |
|
| 388 | + /** |
|
| 389 | + * Alias for the hasParams() method. |
|
| 390 | + * @return bool |
|
| 391 | + * @see URLInfo::hasParams() |
|
| 392 | + */ |
|
| 393 | 393 | public function hasQuery() : bool |
| 394 | 394 | { |
| 395 | 395 | return $this->hasParams(); |
@@ -470,25 +470,25 @@ discard block |
||
| 470 | 470 | return $normalized; |
| 471 | 471 | } |
| 472 | 472 | |
| 473 | - /** |
|
| 474 | - * Creates a hash of the URL, which can be used for comparisons. |
|
| 475 | - * Since any parameters in the URL's query are sorted alphabetically, |
|
| 476 | - * the same links with a different parameter order will have the |
|
| 477 | - * same hash. |
|
| 478 | - * |
|
| 479 | - * @return string |
|
| 480 | - */ |
|
| 473 | + /** |
|
| 474 | + * Creates a hash of the URL, which can be used for comparisons. |
|
| 475 | + * Since any parameters in the URL's query are sorted alphabetically, |
|
| 476 | + * the same links with a different parameter order will have the |
|
| 477 | + * same hash. |
|
| 478 | + * |
|
| 479 | + * @return string |
|
| 480 | + */ |
|
| 481 | 481 | public function getHash() |
| 482 | 482 | { |
| 483 | 483 | return \AppUtils\ConvertHelper::string2shortHash($this->getNormalized()); |
| 484 | 484 | } |
| 485 | 485 | |
| 486 | - /** |
|
| 487 | - * Highlights the URL using HTML tags with specific highlighting |
|
| 488 | - * class names. |
|
| 489 | - * |
|
| 490 | - * @return string Will return an empty string if the URL is not valid. |
|
| 491 | - */ |
|
| 486 | + /** |
|
| 487 | + * Highlights the URL using HTML tags with specific highlighting |
|
| 488 | + * class names. |
|
| 489 | + * |
|
| 490 | + * @return string Will return an empty string if the URL is not valid. |
|
| 491 | + */ |
|
| 492 | 492 | public function getHighlighted() : string |
| 493 | 493 | { |
| 494 | 494 | if(!$this->isValid) { |
@@ -670,15 +670,15 @@ discard block |
||
| 670 | 670 | return count($params); |
| 671 | 671 | } |
| 672 | 672 | |
| 673 | - /** |
|
| 674 | - * Retrieves all parameters specified in the url, |
|
| 675 | - * if any, as an associative array. |
|
| 676 | - * |
|
| 677 | - * NOTE: Ignores parameters that have been added |
|
| 678 | - * to the excluded parameters list. |
|
| 679 | - * |
|
| 680 | - * @return array |
|
| 681 | - */ |
|
| 673 | + /** |
|
| 674 | + * Retrieves all parameters specified in the url, |
|
| 675 | + * if any, as an associative array. |
|
| 676 | + * |
|
| 677 | + * NOTE: Ignores parameters that have been added |
|
| 678 | + * to the excluded parameters list. |
|
| 679 | + * |
|
| 680 | + * @return array |
|
| 681 | + */ |
|
| 682 | 682 | public function getParams() : array |
| 683 | 683 | { |
| 684 | 684 | if(!$this->paramExclusion || empty($this->excludedParams)) { |
@@ -695,26 +695,26 @@ discard block |
||
| 695 | 695 | return $keep; |
| 696 | 696 | } |
| 697 | 697 | |
| 698 | - /** |
|
| 699 | - * Retrieves the names of all parameters present in the URL, if any. |
|
| 700 | - * @return string[] |
|
| 701 | - */ |
|
| 698 | + /** |
|
| 699 | + * Retrieves the names of all parameters present in the URL, if any. |
|
| 700 | + * @return string[] |
|
| 701 | + */ |
|
| 702 | 702 | public function getParamNames() : array |
| 703 | 703 | { |
| 704 | 704 | $params = $this->getParams(); |
| 705 | 705 | return array_keys($params); |
| 706 | 706 | } |
| 707 | 707 | |
| 708 | - /** |
|
| 709 | - * Excludes an URL parameter entirely if present: |
|
| 710 | - * the parser will act as if the parameter was not |
|
| 711 | - * even present in the source URL, effectively |
|
| 712 | - * stripping it. |
|
| 713 | - * |
|
| 714 | - * @param string $name |
|
| 715 | - * @param string $reason A human readable explanation why this is excluded - used when highlighting links. |
|
| 716 | - * @return URLInfo |
|
| 717 | - */ |
|
| 708 | + /** |
|
| 709 | + * Excludes an URL parameter entirely if present: |
|
| 710 | + * the parser will act as if the parameter was not |
|
| 711 | + * even present in the source URL, effectively |
|
| 712 | + * stripping it. |
|
| 713 | + * |
|
| 714 | + * @param string $name |
|
| 715 | + * @param string $reason A human readable explanation why this is excluded - used when highlighting links. |
|
| 716 | + * @return URLInfo |
|
| 717 | + */ |
|
| 718 | 718 | public function excludeParam(string $name, string $reason) : URLInfo |
| 719 | 719 | { |
| 720 | 720 | if(!isset($this->excludedParams[$name])) |
@@ -779,25 +779,25 @@ discard block |
||
| 779 | 779 | return self::$typeLabels[$this->getType()]; |
| 780 | 780 | } |
| 781 | 781 | |
| 782 | - /** |
|
| 783 | - * Whether excluded parameters should be highlighted in |
|
| 784 | - * a different color in the URL when using the |
|
| 785 | - * {@link URLInfo::getHighlighted()} method. |
|
| 786 | - * |
|
| 787 | - * @param bool $highlight |
|
| 788 | - * @return URLInfo |
|
| 789 | - */ |
|
| 782 | + /** |
|
| 783 | + * Whether excluded parameters should be highlighted in |
|
| 784 | + * a different color in the URL when using the |
|
| 785 | + * {@link URLInfo::getHighlighted()} method. |
|
| 786 | + * |
|
| 787 | + * @param bool $highlight |
|
| 788 | + * @return URLInfo |
|
| 789 | + */ |
|
| 790 | 790 | public function setHighlightExcluded(bool $highlight=true) : URLInfo |
| 791 | 791 | { |
| 792 | 792 | $this->highlightExcluded = $highlight; |
| 793 | 793 | return $this; |
| 794 | 794 | } |
| 795 | 795 | |
| 796 | - /** |
|
| 797 | - * Returns an array with all relevant URL information. |
|
| 798 | - * |
|
| 799 | - * @return array |
|
| 800 | - */ |
|
| 796 | + /** |
|
| 797 | + * Returns an array with all relevant URL information. |
|
| 798 | + * |
|
| 799 | + * @return array |
|
| 800 | + */ |
|
| 801 | 801 | public function toArray() : array |
| 802 | 802 | { |
| 803 | 803 | return array( |
@@ -841,24 +841,24 @@ discard block |
||
| 841 | 841 | return $this; |
| 842 | 842 | } |
| 843 | 843 | |
| 844 | - /** |
|
| 845 | - * Whether the parameter exclusion mode is enabled: |
|
| 846 | - * In this case, if any parameters have been added to the |
|
| 847 | - * exclusion list, all relevant methods will exclude these. |
|
| 848 | - * |
|
| 849 | - * @return bool |
|
| 850 | - */ |
|
| 844 | + /** |
|
| 845 | + * Whether the parameter exclusion mode is enabled: |
|
| 846 | + * In this case, if any parameters have been added to the |
|
| 847 | + * exclusion list, all relevant methods will exclude these. |
|
| 848 | + * |
|
| 849 | + * @return bool |
|
| 850 | + */ |
|
| 851 | 851 | public function isParamExclusionEnabled() : bool |
| 852 | 852 | { |
| 853 | 853 | return $this->paramExclusion; |
| 854 | 854 | } |
| 855 | 855 | |
| 856 | - /** |
|
| 857 | - * Checks whether the link contains any parameters that |
|
| 858 | - * are on the list of excluded parameters. |
|
| 859 | - * |
|
| 860 | - * @return bool |
|
| 861 | - */ |
|
| 856 | + /** |
|
| 857 | + * Checks whether the link contains any parameters that |
|
| 858 | + * are on the list of excluded parameters. |
|
| 859 | + * |
|
| 860 | + * @return bool |
|
| 861 | + */ |
|
| 862 | 862 | public function containsExcludedParams() : bool |
| 863 | 863 | { |
| 864 | 864 | if(empty($this->excludedParams)) { |
@@ -117,26 +117,26 @@ discard block |
||
| 117 | 117 | |
| 118 | 118 | $this->filterParsed(); |
| 119 | 119 | |
| 120 | - if($this->detectEmail()) { |
|
| 120 | + if ($this->detectEmail()) { |
|
| 121 | 121 | return; |
| 122 | 122 | } |
| 123 | 123 | |
| 124 | - if($this->detectFragmentLink()) { |
|
| 124 | + if ($this->detectFragmentLink()) { |
|
| 125 | 125 | return; |
| 126 | 126 | } |
| 127 | 127 | |
| 128 | - if($this->detectPhoneLink()) { |
|
| 128 | + if ($this->detectPhoneLink()) { |
|
| 129 | 129 | return; |
| 130 | 130 | } |
| 131 | 131 | |
| 132 | - if(!$this->isValid) { |
|
| 132 | + if (!$this->isValid) { |
|
| 133 | 133 | return; |
| 134 | 134 | } |
| 135 | 135 | |
| 136 | 136 | // no scheme found: it may be an email address without the mailto: |
| 137 | 137 | // It can't be a variable, since without the scheme it would already |
| 138 | 138 | // have been recognized as a vaiable only link. |
| 139 | - if(!isset($this->info['scheme'])) { |
|
| 139 | + if (!isset($this->info['scheme'])) { |
|
| 140 | 140 | $this->setError( |
| 141 | 141 | self::ERROR_MISSING_SCHEME, |
| 142 | 142 | t('Cannot determine the link\'s scheme, e.g. %1$s.', 'http') |
@@ -145,10 +145,10 @@ discard block |
||
| 145 | 145 | return; |
| 146 | 146 | } |
| 147 | 147 | |
| 148 | - if(!in_array($this->info['scheme'], $this->knownSchemes)) { |
|
| 148 | + if (!in_array($this->info['scheme'], $this->knownSchemes)) { |
|
| 149 | 149 | $this->setError( |
| 150 | 150 | self::ERROR_INVALID_SCHEME, |
| 151 | - t('The scheme %1$s is not supported for links.', $this->info['scheme']) . ' ' . |
|
| 151 | + t('The scheme %1$s is not supported for links.', $this->info['scheme']).' '. |
|
| 152 | 152 | t('Valid schemes are: %1$s.', implode(', ', $this->knownSchemes)) |
| 153 | 153 | ); |
| 154 | 154 | $this->isValid = false; |
@@ -158,17 +158,17 @@ discard block |
||
| 158 | 158 | // every link needs a host. This case can happen for ex, if |
| 159 | 159 | // the link starts with a typo with only one slash, like: |
| 160 | 160 | // "http:/hostname" |
| 161 | - if(!isset($this->info['host'])) { |
|
| 161 | + if (!isset($this->info['host'])) { |
|
| 162 | 162 | $this->setError( |
| 163 | 163 | self::ERROR_MISSING_HOST, |
| 164 | - t('Cannot determine the link\'s host name.') . ' ' . |
|
| 164 | + t('Cannot determine the link\'s host name.').' '. |
|
| 165 | 165 | t('This usually happens when there\'s a typo somewhere.') |
| 166 | 166 | ); |
| 167 | 167 | $this->isValid = false; |
| 168 | 168 | return; |
| 169 | 169 | } |
| 170 | 170 | |
| 171 | - if(!empty($this->info['query'])) |
|
| 171 | + if (!empty($this->info['query'])) |
|
| 172 | 172 | { |
| 173 | 173 | $this->params = \AppUtils\ConvertHelper::parseQueryString($this->info['query']); |
| 174 | 174 | ksort($this->params); |
@@ -213,30 +213,30 @@ discard block |
||
| 213 | 213 | */ |
| 214 | 214 | protected function filterParsed() |
| 215 | 215 | { |
| 216 | - foreach($this->info as $key => $val) |
|
| 216 | + foreach ($this->info as $key => $val) |
|
| 217 | 217 | { |
| 218 | - if(is_string($val)) { |
|
| 218 | + if (is_string($val)) { |
|
| 219 | 219 | $this->info[$key] = trim($val); |
| 220 | 220 | } |
| 221 | 221 | } |
| 222 | 222 | |
| 223 | - if(isset($this->info['host'])) { |
|
| 223 | + if (isset($this->info['host'])) { |
|
| 224 | 224 | $this->info['host'] = str_replace(' ', '', $this->info['host']); |
| 225 | 225 | } |
| 226 | 226 | |
| 227 | - if(isset($this->info['path'])) { |
|
| 227 | + if (isset($this->info['path'])) { |
|
| 228 | 228 | $this->info['path'] = str_replace(' ', '', $this->info['path']); |
| 229 | 229 | } |
| 230 | 230 | } |
| 231 | 231 | |
| 232 | 232 | protected function detectEmail() |
| 233 | 233 | { |
| 234 | - if(isset($this->info['scheme']) && $this->info['scheme'] == 'mailto') { |
|
| 234 | + if (isset($this->info['scheme']) && $this->info['scheme'] == 'mailto') { |
|
| 235 | 235 | $this->isEmail = true; |
| 236 | 236 | return true; |
| 237 | 237 | } |
| 238 | 238 | |
| 239 | - if(isset($this->info['path']) && preg_match(\AppUtils\RegexHelper::REGEX_EMAIL, $this->info['path'])) |
|
| 239 | + if (isset($this->info['path']) && preg_match(\AppUtils\RegexHelper::REGEX_EMAIL, $this->info['path'])) |
|
| 240 | 240 | { |
| 241 | 241 | $this->info['scheme'] = 'email'; |
| 242 | 242 | $this->isEmail = true; |
@@ -248,7 +248,7 @@ discard block |
||
| 248 | 248 | |
| 249 | 249 | protected function detectFragmentLink() |
| 250 | 250 | { |
| 251 | - if(isset($this->info['fragment']) && !isset($this->info['scheme'])) { |
|
| 251 | + if (isset($this->info['fragment']) && !isset($this->info['scheme'])) { |
|
| 252 | 252 | $this->isFragment = true; |
| 253 | 253 | return true; |
| 254 | 254 | } |
@@ -258,7 +258,7 @@ discard block |
||
| 258 | 258 | |
| 259 | 259 | protected function detectPhoneLink() |
| 260 | 260 | { |
| 261 | - if(isset($this->info['scheme']) && $this->info['scheme'] == 'tel') { |
|
| 261 | + if (isset($this->info['scheme']) && $this->info['scheme'] == 'tel') { |
|
| 262 | 262 | $this->isPhone = true; |
| 263 | 263 | return true; |
| 264 | 264 | } |
@@ -272,7 +272,7 @@ discard block |
||
| 272 | 272 | */ |
| 273 | 273 | public function isSecure() |
| 274 | 274 | { |
| 275 | - if(isset($this->info['scheme']) && $this->info['scheme']=='https') { |
|
| 275 | + if (isset($this->info['scheme']) && $this->info['scheme'] == 'https') { |
|
| 276 | 276 | return true; |
| 277 | 277 | } |
| 278 | 278 | |
@@ -347,7 +347,7 @@ discard block |
||
| 347 | 347 | public function getPort() : int |
| 348 | 348 | { |
| 349 | 349 | $port = $this->getInfoKey('port'); |
| 350 | - if(!empty($port)) { |
|
| 350 | + if (!empty($port)) { |
|
| 351 | 351 | return (int)$port; |
| 352 | 352 | } |
| 353 | 353 | |
@@ -427,7 +427,7 @@ discard block |
||
| 427 | 427 | |
| 428 | 428 | protected function getInfoKey(string $name) : string |
| 429 | 429 | { |
| 430 | - if(isset($this->info[$name])) { |
|
| 430 | + if (isset($this->info[$name])) { |
|
| 431 | 431 | return (string)$this->info[$name]; |
| 432 | 432 | } |
| 433 | 433 | |
@@ -436,34 +436,34 @@ discard block |
||
| 436 | 436 | |
| 437 | 437 | public function getNormalized() : string |
| 438 | 438 | { |
| 439 | - if(!$this->isValid) { |
|
| 439 | + if (!$this->isValid) { |
|
| 440 | 440 | return ''; |
| 441 | 441 | } |
| 442 | 442 | |
| 443 | - if($this->isFragment === true) |
|
| 443 | + if ($this->isFragment === true) |
|
| 444 | 444 | { |
| 445 | 445 | return '#'.$this->getFragment(); |
| 446 | 446 | } |
| 447 | - else if($this->isPhone === true) |
|
| 447 | + else if ($this->isPhone === true) |
|
| 448 | 448 | { |
| 449 | 449 | return 'tel://'.$this->getHost(); |
| 450 | 450 | } |
| 451 | - else if($this->isEmail === true) |
|
| 451 | + else if ($this->isEmail === true) |
|
| 452 | 452 | { |
| 453 | 453 | return 'mailto:'.$this->getPath(); |
| 454 | 454 | } |
| 455 | 455 | |
| 456 | 456 | $normalized = $this->info['scheme'].'://'.$this->info['host']; |
| 457 | - if(isset($this->info['path'])) { |
|
| 457 | + if (isset($this->info['path'])) { |
|
| 458 | 458 | $normalized .= $this->info['path']; |
| 459 | 459 | } |
| 460 | 460 | |
| 461 | 461 | $params = $this->getParams(); |
| 462 | - if(!empty($params)) { |
|
| 462 | + if (!empty($params)) { |
|
| 463 | 463 | $normalized .= '?'.http_build_query($params); |
| 464 | 464 | } |
| 465 | 465 | |
| 466 | - if(isset($this->info['fragment'])) { |
|
| 466 | + if (isset($this->info['fragment'])) { |
|
| 467 | 467 | $normalized .= '#'.$this->info['fragment']; |
| 468 | 468 | } |
| 469 | 469 | |
@@ -491,11 +491,11 @@ discard block |
||
| 491 | 491 | */ |
| 492 | 492 | public function getHighlighted() : string |
| 493 | 493 | { |
| 494 | - if(!$this->isValid) { |
|
| 494 | + if (!$this->isValid) { |
|
| 495 | 495 | return ''; |
| 496 | 496 | } |
| 497 | 497 | |
| 498 | - if($this->isEmail) { |
|
| 498 | + if ($this->isEmail) { |
|
| 499 | 499 | return sprintf( |
| 500 | 500 | '<span class="link-scheme scheme-mailto">mailto:</span>'. |
| 501 | 501 | '<span class="link-host">%s</span>', |
@@ -503,7 +503,7 @@ discard block |
||
| 503 | 503 | ); |
| 504 | 504 | } |
| 505 | 505 | |
| 506 | - if($this->isFragment) { |
|
| 506 | + if ($this->isFragment) { |
|
| 507 | 507 | return sprintf( |
| 508 | 508 | '<span class="link-fragment-sign">#</span>'. |
| 509 | 509 | '<span class="link-fragment-value">%s</span>', |
@@ -511,7 +511,7 @@ discard block |
||
| 511 | 511 | ); |
| 512 | 512 | } |
| 513 | 513 | |
| 514 | - if($this->hasScheme()) |
|
| 514 | + if ($this->hasScheme()) |
|
| 515 | 515 | { |
| 516 | 516 | $result = sprintf( |
| 517 | 517 | '<span class="link-scheme scheme-%1$s">'. |
@@ -523,7 +523,7 @@ discard block |
||
| 523 | 523 | |
| 524 | 524 | $result .= '<span class="link-component double-slashes">//</span>'; |
| 525 | 525 | |
| 526 | - if($this->hasUsername()) |
|
| 526 | + if ($this->hasUsername()) |
|
| 527 | 527 | { |
| 528 | 528 | $result .= sprintf( |
| 529 | 529 | '<span class="link-credentials">%s</span>'. |
@@ -535,7 +535,7 @@ discard block |
||
| 535 | 535 | ); |
| 536 | 536 | } |
| 537 | 537 | |
| 538 | - if($this->hasHost()) |
|
| 538 | + if ($this->hasHost()) |
|
| 539 | 539 | { |
| 540 | 540 | $result .= |
| 541 | 541 | sprintf( |
@@ -544,7 +544,7 @@ discard block |
||
| 544 | 544 | ); |
| 545 | 545 | } |
| 546 | 546 | |
| 547 | - if($this->hasPort()) |
|
| 547 | + if ($this->hasPort()) |
|
| 548 | 548 | { |
| 549 | 549 | $result .= sprintf( |
| 550 | 550 | '<span class="link-component port-separator">:</span>'. |
@@ -553,7 +553,7 @@ discard block |
||
| 553 | 553 | ); |
| 554 | 554 | } |
| 555 | 555 | |
| 556 | - if($this->hasPath()) |
|
| 556 | + if ($this->hasPath()) |
|
| 557 | 557 | { |
| 558 | 558 | $path = str_replace(array(';', '='), array(';<wbr>', '=<wbr>'), $this->getPath()); |
| 559 | 559 | $tokens = explode('/', $path); |
@@ -564,11 +564,11 @@ discard block |
||
| 564 | 564 | ); |
| 565 | 565 | } |
| 566 | 566 | |
| 567 | - if(!empty($this->params)) |
|
| 567 | + if (!empty($this->params)) |
|
| 568 | 568 | { |
| 569 | 569 | $tokens = array(); |
| 570 | 570 | |
| 571 | - foreach($this->params as $param => $value) |
|
| 571 | + foreach ($this->params as $param => $value) |
|
| 572 | 572 | { |
| 573 | 573 | $parts = sprintf( |
| 574 | 574 | '<span class="link-param-name">%s</span>'. |
@@ -586,10 +586,10 @@ discard block |
||
| 586 | 586 | $tag = ''; |
| 587 | 587 | |
| 588 | 588 | // is parameter exclusion enabled, and is this an excluded parameter? |
| 589 | - if($this->paramExclusion && isset($this->excludedParams[$param])) |
|
| 589 | + if ($this->paramExclusion && isset($this->excludedParams[$param])) |
|
| 590 | 590 | { |
| 591 | 591 | // display the excluded parameter, but highlight it |
| 592 | - if($this->highlightExcluded) |
|
| 592 | + if ($this->highlightExcluded) |
|
| 593 | 593 | { |
| 594 | 594 | $tooltip = $this->excludedParams[$param]; |
| 595 | 595 | |
@@ -619,7 +619,7 @@ discard block |
||
| 619 | 619 | '<span class="link-component query-sign">?</span>'.implode('<span class="link-component param-separator">&</span>', $tokens); |
| 620 | 620 | } |
| 621 | 621 | |
| 622 | - if(isset($this->info['fragment'])) { |
|
| 622 | + if (isset($this->info['fragment'])) { |
|
| 623 | 623 | $result .= sprintf( |
| 624 | 624 | '<span class="link-fragment-sign">#</span>'. |
| 625 | 625 | '<span class="link-fragment">%s</span>', |
@@ -642,7 +642,7 @@ discard block |
||
| 642 | 642 | |
| 643 | 643 | public function getErrorMessage() : string |
| 644 | 644 | { |
| 645 | - if(isset($this->error)) { |
|
| 645 | + if (isset($this->error)) { |
|
| 646 | 646 | return $this->error['message']; |
| 647 | 647 | } |
| 648 | 648 | |
@@ -651,7 +651,7 @@ discard block |
||
| 651 | 651 | |
| 652 | 652 | public function getErrorCode() : int |
| 653 | 653 | { |
| 654 | - if(isset($this->error)) { |
|
| 654 | + if (isset($this->error)) { |
|
| 655 | 655 | return $this->error['code']; |
| 656 | 656 | } |
| 657 | 657 | |
@@ -681,13 +681,13 @@ discard block |
||
| 681 | 681 | */ |
| 682 | 682 | public function getParams() : array |
| 683 | 683 | { |
| 684 | - if(!$this->paramExclusion || empty($this->excludedParams)) { |
|
| 684 | + if (!$this->paramExclusion || empty($this->excludedParams)) { |
|
| 685 | 685 | return $this->params; |
| 686 | 686 | } |
| 687 | 687 | |
| 688 | 688 | $keep = array(); |
| 689 | - foreach($this->params as $name => $value) { |
|
| 690 | - if(!isset($this->excludedParams[$name])) { |
|
| 689 | + foreach ($this->params as $name => $value) { |
|
| 690 | + if (!isset($this->excludedParams[$name])) { |
|
| 691 | 691 | $keep[$name] = $value; |
| 692 | 692 | } |
| 693 | 693 | } |
@@ -717,7 +717,7 @@ discard block |
||
| 717 | 717 | */ |
| 718 | 718 | public function excludeParam(string $name, string $reason) : URLInfo |
| 719 | 719 | { |
| 720 | - if(!isset($this->excludedParams[$name])) |
|
| 720 | + if (!isset($this->excludedParams[$name])) |
|
| 721 | 721 | { |
| 722 | 722 | $this->excludedParams[$name] = $reason; |
| 723 | 723 | $this->setParamExclusion(); |
@@ -738,15 +738,15 @@ discard block |
||
| 738 | 738 | */ |
| 739 | 739 | public function getType() : string |
| 740 | 740 | { |
| 741 | - if($this->isEmail) { |
|
| 741 | + if ($this->isEmail) { |
|
| 742 | 742 | return self::TYPE_EMAIL; |
| 743 | 743 | } |
| 744 | 744 | |
| 745 | - if($this->isFragment) { |
|
| 745 | + if ($this->isFragment) { |
|
| 746 | 746 | return self::TYPE_FRAGMENT; |
| 747 | 747 | } |
| 748 | 748 | |
| 749 | - if($this->isPhone) { |
|
| 749 | + if ($this->isPhone) { |
|
| 750 | 750 | return self::TYPE_PHONE; |
| 751 | 751 | } |
| 752 | 752 | |
@@ -755,7 +755,7 @@ discard block |
||
| 755 | 755 | |
| 756 | 756 | public function getTypeLabel() : string |
| 757 | 757 | { |
| 758 | - if(!isset(self::$typeLabels)) |
|
| 758 | + if (!isset(self::$typeLabels)) |
|
| 759 | 759 | { |
| 760 | 760 | self::$typeLabels = array( |
| 761 | 761 | self::TYPE_EMAIL => t('Email'), |
@@ -767,7 +767,7 @@ discard block |
||
| 767 | 767 | |
| 768 | 768 | $type = $this->getType(); |
| 769 | 769 | |
| 770 | - if(!isset(self::$typeLabels[$type])) |
|
| 770 | + if (!isset(self::$typeLabels[$type])) |
|
| 771 | 771 | { |
| 772 | 772 | throw new BaseException( |
| 773 | 773 | sprintf('Unknown URL type label for type [%s].', $type), |
@@ -787,7 +787,7 @@ discard block |
||
| 787 | 787 | * @param bool $highlight |
| 788 | 788 | * @return URLInfo |
| 789 | 789 | */ |
| 790 | - public function setHighlightExcluded(bool $highlight=true) : URLInfo |
|
| 790 | + public function setHighlightExcluded(bool $highlight = true) : URLInfo |
|
| 791 | 791 | { |
| 792 | 792 | $this->highlightExcluded = $highlight; |
| 793 | 793 | return $this; |
@@ -835,7 +835,7 @@ discard block |
||
| 835 | 835 | * @see URLInfo::isParamExclusionEnabled() |
| 836 | 836 | * @see URLInfo::setHighlightExcluded() |
| 837 | 837 | */ |
| 838 | - public function setParamExclusion(bool $enabled=true) : URLInfo |
|
| 838 | + public function setParamExclusion(bool $enabled = true) : URLInfo |
|
| 839 | 839 | { |
| 840 | 840 | $this->paramExclusion = $enabled; |
| 841 | 841 | return $this; |
@@ -861,13 +861,13 @@ discard block |
||
| 861 | 861 | */ |
| 862 | 862 | public function containsExcludedParams() : bool |
| 863 | 863 | { |
| 864 | - if(empty($this->excludedParams)) { |
|
| 864 | + if (empty($this->excludedParams)) { |
|
| 865 | 865 | return false; |
| 866 | 866 | } |
| 867 | 867 | |
| 868 | 868 | $names = array_keys($this->params); |
| 869 | - foreach($names as $name) { |
|
| 870 | - if(isset($this->excludedParams[$name])) { |
|
| 869 | + foreach ($names as $name) { |
|
| 870 | + if (isset($this->excludedParams[$name])) { |
|
| 871 | 871 | return true; |
| 872 | 872 | } |
| 873 | 873 | } |
@@ -883,7 +883,7 @@ discard block |
||
| 883 | 883 | |
| 884 | 884 | public function offsetSet($offset, $value) |
| 885 | 885 | { |
| 886 | - if(in_array($offset, $this->infoKeys)) { |
|
| 886 | + if (in_array($offset, $this->infoKeys)) { |
|
| 887 | 887 | $this->info[$offset] = $value; |
| 888 | 888 | } |
| 889 | 889 | } |
@@ -900,11 +900,11 @@ discard block |
||
| 900 | 900 | |
| 901 | 901 | public function offsetGet($offset) |
| 902 | 902 | { |
| 903 | - if($offset === 'port') { |
|
| 903 | + if ($offset === 'port') { |
|
| 904 | 904 | return $this->getPort(); |
| 905 | 905 | } |
| 906 | 906 | |
| 907 | - if(in_array($offset, $this->infoKeys)) { |
|
| 907 | + if (in_array($offset, $this->infoKeys)) { |
|
| 908 | 908 | return $this->getInfoKey($offset); |
| 909 | 909 | } |
| 910 | 910 | |
@@ -915,7 +915,7 @@ discard block |
||
| 915 | 915 | { |
| 916 | 916 | $cssFolder = realpath(__DIR__.'/../css'); |
| 917 | 917 | |
| 918 | - if($cssFolder === false) { |
|
| 918 | + if ($cssFolder === false) { |
|
| 919 | 919 | throw new BaseException( |
| 920 | 920 | 'Cannot find package CSS folder.', |
| 921 | 921 | null, |
@@ -443,12 +443,10 @@ discard block |
||
| 443 | 443 | if($this->isFragment === true) |
| 444 | 444 | { |
| 445 | 445 | return '#'.$this->getFragment(); |
| 446 | - } |
|
| 447 | - else if($this->isPhone === true) |
|
| 446 | + } else if($this->isPhone === true) |
|
| 448 | 447 | { |
| 449 | 448 | return 'tel://'.$this->getHost(); |
| 450 | - } |
|
| 451 | - else if($this->isEmail === true) |
|
| 449 | + } else if($this->isEmail === true) |
|
| 452 | 450 | { |
| 453 | 451 | return 'mailto:'.$this->getPath(); |
| 454 | 452 | } |
@@ -598,13 +596,11 @@ discard block |
||
| 598 | 596 | $tooltip, |
| 599 | 597 | $parts |
| 600 | 598 | ); |
| 601 | - } |
|
| 602 | - else |
|
| 599 | + } else |
|
| 603 | 600 | { |
| 604 | 601 | continue; |
| 605 | 602 | } |
| 606 | - } |
|
| 607 | - else |
|
| 603 | + } else |
|
| 608 | 604 | { |
| 609 | 605 | $tag = sprintf( |
| 610 | 606 | '<span class="link-param">%s</span>', |
@@ -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 | |