@@ -15,7 +15,7 @@ |
||
| 15 | 15 | $autoload = $root.'/vendor/autoload.php'; |
| 16 | 16 | |
| 17 | 17 | // we need the autoloader to be present |
| 18 | - if($autoload === false) |
|
| 18 | + if ($autoload === false) |
|
| 19 | 19 | { |
| 20 | 20 | die('<b>ERROR:</b> Autoloader not present. Run composer update first.'); |
| 21 | 21 | } |
@@ -29,17 +29,17 @@ discard block |
||
| 29 | 29 | */ |
| 30 | 30 | public static function fromString($string) : bool |
| 31 | 31 | { |
| 32 | - if($string === '' || $string === null || !is_scalar($string)) |
|
| 32 | + if ($string === '' || $string === null || !is_scalar($string)) |
|
| 33 | 33 | { |
| 34 | 34 | return false; |
| 35 | 35 | } |
| 36 | 36 | |
| 37 | - if(is_bool($string)) |
|
| 37 | + if (is_bool($string)) |
|
| 38 | 38 | { |
| 39 | 39 | return $string; |
| 40 | 40 | } |
| 41 | 41 | |
| 42 | - if(array_key_exists($string, self::$booleanStrings)) |
|
| 42 | + if (array_key_exists($string, self::$booleanStrings)) |
|
| 43 | 43 | { |
| 44 | 44 | return self::$booleanStrings[$string]; |
| 45 | 45 | } |
@@ -67,7 +67,7 @@ discard block |
||
| 67 | 67 | public static function toString($boolean, bool $yesno = false) : string |
| 68 | 68 | { |
| 69 | 69 | // allow 'yes', 'true', 'no', 'false' string notations as well |
| 70 | - if(!is_bool($boolean)) { |
|
| 70 | + if (!is_bool($boolean)) { |
|
| 71 | 71 | $boolean = self::fromString($boolean); |
| 72 | 72 | } |
| 73 | 73 | |
@@ -97,11 +97,11 @@ discard block |
||
| 97 | 97 | */ |
| 98 | 98 | public static function isBoolean($value) : bool |
| 99 | 99 | { |
| 100 | - if(is_bool($value)) { |
|
| 100 | + if (is_bool($value)) { |
|
| 101 | 101 | return true; |
| 102 | 102 | } |
| 103 | 103 | |
| 104 | - if(!is_scalar($value)) { |
|
| 104 | + if (!is_scalar($value)) { |
|
| 105 | 105 | return false; |
| 106 | 106 | } |
| 107 | 107 | |
@@ -32,7 +32,7 @@ discard block |
||
| 32 | 32 | * @param string[] $paths |
| 33 | 33 | * @throws FileHelper_Exception |
| 34 | 34 | */ |
| 35 | - public function __construct(array $paths=array()) |
|
| 35 | + public function __construct(array $paths = array()) |
|
| 36 | 36 | { |
| 37 | 37 | $this->addPaths($paths); |
| 38 | 38 | } |
@@ -46,7 +46,7 @@ discard block |
||
| 46 | 46 | */ |
| 47 | 47 | public function addPaths(array $paths) : FileHelper_PathsReducer |
| 48 | 48 | { |
| 49 | - foreach($paths as $path) { |
|
| 49 | + foreach ($paths as $path) { |
|
| 50 | 50 | $this->addPath($path); |
| 51 | 51 | } |
| 52 | 52 | |
@@ -64,7 +64,7 @@ discard block |
||
| 64 | 64 | { |
| 65 | 65 | $path = FileHelper::normalizePath(FileHelper::requireFileExists($path)); |
| 66 | 66 | |
| 67 | - if(!in_array($path, $this->paths)) { |
|
| 67 | + if (!in_array($path, $this->paths)) { |
|
| 68 | 68 | $this->paths[] = $path; |
| 69 | 69 | } |
| 70 | 70 | |
@@ -81,11 +81,11 @@ discard block |
||
| 81 | 81 | { |
| 82 | 82 | $split = $this->splitPaths(); |
| 83 | 83 | |
| 84 | - if(empty($split)) { |
|
| 84 | + if (empty($split)) { |
|
| 85 | 85 | return array(); |
| 86 | 86 | } |
| 87 | 87 | |
| 88 | - while($this->shiftPart($split) === true) {} |
|
| 88 | + while ($this->shiftPart($split) === true) {} |
|
| 89 | 89 | |
| 90 | 90 | return $this->joinPaths($split); |
| 91 | 91 | } |
@@ -99,7 +99,7 @@ discard block |
||
| 99 | 99 | $result = array(); |
| 100 | 100 | |
| 101 | 101 | foreach ($split as $entry) { |
| 102 | - if(!empty($entry)) { |
|
| 102 | + if (!empty($entry)) { |
|
| 103 | 103 | $result[] = implode('/', $entry); |
| 104 | 104 | } |
| 105 | 105 | } |
@@ -116,22 +116,22 @@ discard block |
||
| 116 | 116 | $current = null; |
| 117 | 117 | $result = array(); |
| 118 | 118 | |
| 119 | - foreach($split as $entry) |
|
| 119 | + foreach ($split as $entry) |
|
| 120 | 120 | { |
| 121 | - if(empty($entry)) { |
|
| 121 | + if (empty($entry)) { |
|
| 122 | 122 | return false; |
| 123 | 123 | } |
| 124 | 124 | |
| 125 | 125 | $part = array_shift($entry); |
| 126 | - if(empty($entry)) { |
|
| 126 | + if (empty($entry)) { |
|
| 127 | 127 | return false; |
| 128 | 128 | } |
| 129 | 129 | |
| 130 | - if($current === null) { |
|
| 130 | + if ($current === null) { |
|
| 131 | 131 | $current = $part; |
| 132 | 132 | } |
| 133 | 133 | |
| 134 | - if($part !== $current) { |
|
| 134 | + if ($part !== $current) { |
|
| 135 | 135 | return false; |
| 136 | 136 | } |
| 137 | 137 | |
@@ -147,9 +147,9 @@ discard block |
||
| 147 | 147 | { |
| 148 | 148 | $split = array(); |
| 149 | 149 | |
| 150 | - foreach($this->paths as $path) { |
|
| 150 | + foreach ($this->paths as $path) { |
|
| 151 | 151 | $entry = ConvertHelper::explodeTrim('/', $path); |
| 152 | - if(!empty($entry)) { |
|
| 152 | + if (!empty($entry)) { |
|
| 153 | 153 | $split[] = $entry; |
| 154 | 154 | } |
| 155 | 155 | } |
@@ -29,19 +29,19 @@ discard block |
||
| 29 | 29 | const TYPE_LF = 'LF'; |
| 30 | 30 | const TYPE_CR = 'CR'; |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * @var string |
|
| 34 | - */ |
|
| 32 | + /** |
|
| 33 | + * @var string |
|
| 34 | + */ |
|
| 35 | 35 | protected $char; |
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * @var string |
|
| 39 | - */ |
|
| 37 | + /** |
|
| 38 | + * @var string |
|
| 39 | + */ |
|
| 40 | 40 | protected $type; |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * @var string |
|
| 44 | - */ |
|
| 42 | + /** |
|
| 43 | + * @var string |
|
| 44 | + */ |
|
| 45 | 45 | protected $description; |
| 46 | 46 | |
| 47 | 47 | /** |
@@ -56,33 +56,33 @@ discard block |
||
| 56 | 56 | $this->description = $description; |
| 57 | 57 | } |
| 58 | 58 | |
| 59 | - /** |
|
| 60 | - * The actual EOL character. |
|
| 61 | - * @return string |
|
| 62 | - */ |
|
| 59 | + /** |
|
| 60 | + * The actual EOL character. |
|
| 61 | + * @return string |
|
| 62 | + */ |
|
| 63 | 63 | public function getCharacter() : string |
| 64 | 64 | { |
| 65 | 65 | return $this->char; |
| 66 | 66 | } |
| 67 | 67 | |
| 68 | - /** |
|
| 69 | - * A more detailed, human readable description of the character. |
|
| 70 | - * @return string |
|
| 71 | - */ |
|
| 68 | + /** |
|
| 69 | + * A more detailed, human readable description of the character. |
|
| 70 | + * @return string |
|
| 71 | + */ |
|
| 72 | 72 | public function getDescription() : string |
| 73 | 73 | { |
| 74 | 74 | return $this->description; |
| 75 | 75 | } |
| 76 | 76 | |
| 77 | - /** |
|
| 78 | - * The EOL character type, e.g. "CR+LF", "CR"... |
|
| 79 | - * @return string |
|
| 80 | - * |
|
| 81 | - * @see ConvertHelper_EOL::TYPE_CR |
|
| 82 | - * @see ConvertHelper_EOL::TYPE_CRLF |
|
| 83 | - * @see ConvertHelper_EOL::TYPE_LF |
|
| 84 | - * @see ConvertHelper_EOL::TYPE_LFCR |
|
| 85 | - */ |
|
| 77 | + /** |
|
| 78 | + * The EOL character type, e.g. "CR+LF", "CR"... |
|
| 79 | + * @return string |
|
| 80 | + * |
|
| 81 | + * @see ConvertHelper_EOL::TYPE_CR |
|
| 82 | + * @see ConvertHelper_EOL::TYPE_CRLF |
|
| 83 | + * @see ConvertHelper_EOL::TYPE_LF |
|
| 84 | + * @see ConvertHelper_EOL::TYPE_LFCR |
|
| 85 | + */ |
|
| 86 | 86 | public function getType() : string |
| 87 | 87 | { |
| 88 | 88 | return $this->type; |
@@ -121,7 +121,7 @@ discard block |
||
| 121 | 121 | */ |
| 122 | 122 | public static function detect(string $subjectString) : ?ConvertHelper_EOL |
| 123 | 123 | { |
| 124 | - if(empty($subjectString)) { |
|
| 124 | + if (empty($subjectString)) { |
|
| 125 | 125 | return null; |
| 126 | 126 | } |
| 127 | 127 | |
@@ -129,18 +129,18 @@ discard block |
||
| 129 | 129 | $results = array(); |
| 130 | 130 | $chars = self::getEOLChars(); |
| 131 | 131 | |
| 132 | - foreach($chars as $def) |
|
| 132 | + foreach ($chars as $def) |
|
| 133 | 133 | { |
| 134 | 134 | $amount = substr_count($subjectString, $def['char']); |
| 135 | 135 | |
| 136 | - if($amount > $max) |
|
| 136 | + if ($amount > $max) |
|
| 137 | 137 | { |
| 138 | 138 | $max = $amount; |
| 139 | 139 | $results[] = $def; |
| 140 | 140 | } |
| 141 | 141 | } |
| 142 | 142 | |
| 143 | - if(empty($results)) { |
|
| 143 | + if (empty($results)) { |
|
| 144 | 144 | return null; |
| 145 | 145 | } |
| 146 | 146 | |
@@ -156,7 +156,7 @@ discard block |
||
| 156 | 156 | */ |
| 157 | 157 | public static function getEOLChars() : array |
| 158 | 158 | { |
| 159 | - if(isset(self::$eolChars)) { |
|
| 159 | + if (isset(self::$eolChars)) { |
|
| 160 | 160 | return self::$eolChars; |
| 161 | 161 | } |
| 162 | 162 | |
@@ -12,9 +12,9 @@ discard block |
||
| 12 | 12 | * @param bool $forceNew |
| 13 | 13 | * @return NumberInfo |
| 14 | 14 | */ |
| 15 | -function parseNumber($value, bool $forceNew=false) |
|
| 15 | +function parseNumber($value, bool $forceNew = false) |
|
| 16 | 16 | { |
| 17 | - if($value instanceof NumberInfo && $forceNew !== true) { |
|
| 17 | + if ($value instanceof NumberInfo && $forceNew !== true) { |
|
| 18 | 18 | return $value; |
| 19 | 19 | } |
| 20 | 20 | |
@@ -95,7 +95,7 @@ discard block |
||
| 95 | 95 | $args = func_get_args(); |
| 96 | 96 | |
| 97 | 97 | // is the localization package installed? |
| 98 | - if(function_exists('\AppLocalize\t')) |
|
| 98 | + if (function_exists('\AppLocalize\t')) |
|
| 99 | 99 | { |
| 100 | 100 | return call_user_func_array('\AppLocalize\t', $args); |
| 101 | 101 | } |
@@ -110,7 +110,7 @@ discard block |
||
| 110 | 110 | * @param bool $initial The initial boolean value to use. |
| 111 | 111 | * @return Value_Bool |
| 112 | 112 | */ |
| 113 | -function valBool(bool $initial=false) : Value_Bool |
|
| 113 | +function valBool(bool $initial = false) : Value_Bool |
|
| 114 | 114 | { |
| 115 | 115 | return new Value_Bool($initial); |
| 116 | 116 | } |
@@ -123,7 +123,7 @@ discard block |
||
| 123 | 123 | * @param bool $initial |
| 124 | 124 | * @return Value_Bool_True |
| 125 | 125 | */ |
| 126 | -function valBoolTrue(bool $initial=false) : Value_Bool_True |
|
| 126 | +function valBoolTrue(bool $initial = false) : Value_Bool_True |
|
| 127 | 127 | { |
| 128 | 128 | return new Value_Bool_True($initial); |
| 129 | 129 | } |
@@ -136,7 +136,7 @@ discard block |
||
| 136 | 136 | * @param bool $initial |
| 137 | 137 | * @return Value_Bool_False |
| 138 | 138 | */ |
| 139 | -function valBoolFalse(bool $initial=true) : Value_Bool_False |
|
| 139 | +function valBoolFalse(bool $initial = true) : Value_Bool_False |
|
| 140 | 140 | { |
| 141 | 141 | return new Value_Bool_False($initial); |
| 142 | 142 | } |
@@ -167,7 +167,7 @@ discard block |
||
| 167 | 167 | */ |
| 168 | 168 | function init() |
| 169 | 169 | { |
| 170 | - if(!class_exists('\AppLocalize\Localization')) { |
|
| 170 | + if (!class_exists('\AppLocalize\Localization')) { |
|
| 171 | 171 | return; |
| 172 | 172 | } |
| 173 | 173 | |
@@ -22,9 +22,9 @@ discard block |
||
| 22 | 22 | { |
| 23 | 23 | use Traits_Optionable; |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * @var URLInfo |
|
| 27 | - */ |
|
| 25 | + /** |
|
| 26 | + * @var URLInfo |
|
| 27 | + */ |
|
| 28 | 28 | private $url; |
| 29 | 29 | |
| 30 | 30 | public function __construct(URLInfo $url) |
@@ -41,13 +41,13 @@ discard block |
||
| 41 | 41 | ); |
| 42 | 42 | } |
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * Whether to verify the host's SSL certificate, in |
|
| 46 | - * case of an https connection. |
|
| 47 | - * |
|
| 48 | - * @param bool $verifySSL |
|
| 49 | - * @return URLInfo_ConnectionTester |
|
| 50 | - */ |
|
| 44 | + /** |
|
| 45 | + * Whether to verify the host's SSL certificate, in |
|
| 46 | + * case of an https connection. |
|
| 47 | + * |
|
| 48 | + * @param bool $verifySSL |
|
| 49 | + * @return URLInfo_ConnectionTester |
|
| 50 | + */ |
|
| 51 | 51 | public function setVerifySSL(bool $verifySSL=true) : URLInfo_ConnectionTester |
| 52 | 52 | { |
| 53 | 53 | $this->setOption('verify-ssl', $verifySSL); |
@@ -81,12 +81,12 @@ discard block |
||
| 81 | 81 | return $this->getIntOption('timeout'); |
| 82 | 82 | } |
| 83 | 83 | |
| 84 | - /** |
|
| 85 | - * Initializes the CURL instance. |
|
| 86 | - * |
|
| 87 | - * @throws BaseException |
|
| 88 | - * @return resource |
|
| 89 | - */ |
|
| 84 | + /** |
|
| 85 | + * Initializes the CURL instance. |
|
| 86 | + * |
|
| 87 | + * @throws BaseException |
|
| 88 | + * @return resource |
|
| 89 | + */ |
|
| 90 | 90 | private function initCURL() |
| 91 | 91 | { |
| 92 | 92 | $ch = curl_init(); |
@@ -103,9 +103,9 @@ discard block |
||
| 103 | 103 | return $ch; |
| 104 | 104 | } |
| 105 | 105 | |
| 106 | - /** |
|
| 107 | - * @param resource $ch |
|
| 108 | - */ |
|
| 106 | + /** |
|
| 107 | + * @param resource $ch |
|
| 108 | + */ |
|
| 109 | 109 | private function configureOptions($ch) : void |
| 110 | 110 | { |
| 111 | 111 | if($this->isVerboseModeEnabled()) |
@@ -48,7 +48,7 @@ discard block |
||
| 48 | 48 | * @param bool $verifySSL |
| 49 | 49 | * @return URLInfo_ConnectionTester |
| 50 | 50 | */ |
| 51 | - public function setVerifySSL(bool $verifySSL=true) : URLInfo_ConnectionTester |
|
| 51 | + public function setVerifySSL(bool $verifySSL = true) : URLInfo_ConnectionTester |
|
| 52 | 52 | { |
| 53 | 53 | $this->setOption('verify-ssl', $verifySSL); |
| 54 | 54 | return $this; |
@@ -59,7 +59,7 @@ discard block |
||
| 59 | 59 | return $this->getBoolOption('verify-ssl'); |
| 60 | 60 | } |
| 61 | 61 | |
| 62 | - public function setVerboseMode(bool $enabled=true) : URLInfo_ConnectionTester |
|
| 62 | + public function setVerboseMode(bool $enabled = true) : URLInfo_ConnectionTester |
|
| 63 | 63 | { |
| 64 | 64 | $this->setOption('curl-verbose', $enabled); |
| 65 | 65 | return $this; |
@@ -91,7 +91,7 @@ discard block |
||
| 91 | 91 | { |
| 92 | 92 | $ch = curl_init(); |
| 93 | 93 | |
| 94 | - if(!is_resource($ch)) |
|
| 94 | + if (!is_resource($ch)) |
|
| 95 | 95 | { |
| 96 | 96 | throw new BaseException( |
| 97 | 97 | 'Could not initialize a new cURL instance.', |
@@ -108,7 +108,7 @@ discard block |
||
| 108 | 108 | */ |
| 109 | 109 | private function configureOptions($ch) : void |
| 110 | 110 | { |
| 111 | - if($this->isVerboseModeEnabled()) |
|
| 111 | + if ($this->isVerboseModeEnabled()) |
|
| 112 | 112 | { |
| 113 | 113 | curl_setopt($ch, CURLOPT_VERBOSE, true); |
| 114 | 114 | } |
@@ -118,13 +118,13 @@ discard block |
||
| 118 | 118 | curl_setopt($ch, CURLOPT_TIMEOUT, $this->getTimeout()); |
| 119 | 119 | curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); |
| 120 | 120 | |
| 121 | - if(!$this->isVerifySSLEnabled()) |
|
| 121 | + if (!$this->isVerifySSLEnabled()) |
|
| 122 | 122 | { |
| 123 | 123 | curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); |
| 124 | 124 | curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); |
| 125 | 125 | } |
| 126 | 126 | |
| 127 | - if($this->url->hasUsername()) |
|
| 127 | + if ($this->url->hasUsername()) |
|
| 128 | 128 | { |
| 129 | 129 | curl_setopt($ch, CURLOPT_USERNAME, $this->url->getUsername()); |
| 130 | 130 | curl_setopt($ch, CURLOPT_PASSWORD, $this->url->getPassword()); |
@@ -13,20 +13,20 @@ discard block |
||
| 13 | 13 | $string = ''; |
| 14 | 14 | |
| 15 | 15 | // Simple function call |
| 16 | - if(is_string($this->value)) |
|
| 16 | + if (is_string($this->value)) |
|
| 17 | 17 | { |
| 18 | 18 | return $this->value.'()'; |
| 19 | 19 | } |
| 20 | 20 | |
| 21 | - if(is_array($this->value)) { |
|
| 21 | + if (is_array($this->value)) { |
|
| 22 | 22 | return $this->renderArray(); |
| 23 | 23 | } |
| 24 | 24 | |
| 25 | - if($this->value instanceof NamedClosure) { |
|
| 25 | + if ($this->value instanceof NamedClosure) { |
|
| 26 | 26 | return 'Closure:'.$this->value->getOrigin(); |
| 27 | 27 | } |
| 28 | 28 | |
| 29 | - if($this->value instanceof Closure) { |
|
| 29 | + if ($this->value instanceof Closure) { |
|
| 30 | 30 | return 'Closure'; |
| 31 | 31 | } |
| 32 | 32 | |
@@ -38,9 +38,9 @@ discard block |
||
| 38 | 38 | $string = ''; |
| 39 | 39 | |
| 40 | 40 | if (is_string($this->value[0])) { |
| 41 | - $string .= $this->value[0] . '::'; |
|
| 41 | + $string .= $this->value[0].'::'; |
|
| 42 | 42 | } else { |
| 43 | - $string .= get_class($this->value[0]) . '->'; |
|
| 43 | + $string .= get_class($this->value[0]).'->'; |
|
| 44 | 44 | } |
| 45 | 45 | |
| 46 | 46 | $string .= $this->value[1].'()'; |
@@ -26,9 +26,9 @@ discard block |
||
| 26 | 26 | */ |
| 27 | 27 | trait Traits_Optionable |
| 28 | 28 | { |
| 29 | - /** |
|
| 30 | - * @var array |
|
| 31 | - */ |
|
| 29 | + /** |
|
| 30 | + * @var array |
|
| 31 | + */ |
|
| 32 | 32 | protected $options; |
| 33 | 33 | |
| 34 | 34 | /** |
@@ -49,13 +49,13 @@ discard block |
||
| 49 | 49 | return $this; |
| 50 | 50 | } |
| 51 | 51 | |
| 52 | - /** |
|
| 53 | - * Sets a collection of options at once, from an |
|
| 54 | - * associative array. |
|
| 55 | - * |
|
| 56 | - * @param array<string,mixed> $options |
|
| 57 | - * @return $this |
|
| 58 | - */ |
|
| 52 | + /** |
|
| 53 | + * Sets a collection of options at once, from an |
|
| 54 | + * associative array. |
|
| 55 | + * |
|
| 56 | + * @param array<string,mixed> $options |
|
| 57 | + * @return $this |
|
| 58 | + */ |
|
| 59 | 59 | public function setOptions(array $options) |
| 60 | 60 | { |
| 61 | 61 | foreach($options as $name => $value) { |
@@ -65,16 +65,16 @@ discard block |
||
| 65 | 65 | return $this; |
| 66 | 66 | } |
| 67 | 67 | |
| 68 | - /** |
|
| 69 | - * Retrieves an option's value. |
|
| 70 | - * |
|
| 71 | - * NOTE: Use the specialized type getters to ensure an option |
|
| 72 | - * contains the expected type (for ex. getArrayOption()). |
|
| 73 | - * |
|
| 74 | - * @param string $name |
|
| 75 | - * @param mixed $default The default value to return if the option does not exist. |
|
| 76 | - * @return mixed |
|
| 77 | - */ |
|
| 68 | + /** |
|
| 69 | + * Retrieves an option's value. |
|
| 70 | + * |
|
| 71 | + * NOTE: Use the specialized type getters to ensure an option |
|
| 72 | + * contains the expected type (for ex. getArrayOption()). |
|
| 73 | + * |
|
| 74 | + * @param string $name |
|
| 75 | + * @param mixed $default The default value to return if the option does not exist. |
|
| 76 | + * @return mixed |
|
| 77 | + */ |
|
| 78 | 78 | public function getOption(string $name, $default=null) |
| 79 | 79 | { |
| 80 | 80 | if(!isset($this->options)) { |
@@ -88,16 +88,16 @@ discard block |
||
| 88 | 88 | return $default; |
| 89 | 89 | } |
| 90 | 90 | |
| 91 | - /** |
|
| 92 | - * Enforces that the option value is a string. Numbers are converted |
|
| 93 | - * to string, strings are passed through, and all other types will |
|
| 94 | - * return the default value. The default value is also returned if |
|
| 95 | - * the string is empty. |
|
| 96 | - * |
|
| 97 | - * @param string $name |
|
| 98 | - * @param string $default Used if the option does not exist, is invalid, or empty. |
|
| 99 | - * @return string |
|
| 100 | - */ |
|
| 91 | + /** |
|
| 92 | + * Enforces that the option value is a string. Numbers are converted |
|
| 93 | + * to string, strings are passed through, and all other types will |
|
| 94 | + * return the default value. The default value is also returned if |
|
| 95 | + * the string is empty. |
|
| 96 | + * |
|
| 97 | + * @param string $name |
|
| 98 | + * @param string $default Used if the option does not exist, is invalid, or empty. |
|
| 99 | + * @return string |
|
| 100 | + */ |
|
| 101 | 101 | public function getStringOption(string $name, string $default='') : string |
| 102 | 102 | { |
| 103 | 103 | $value = $this->getOption($name, false); |
@@ -128,15 +128,15 @@ discard block |
||
| 128 | 128 | return $default; |
| 129 | 129 | } |
| 130 | 130 | |
| 131 | - /** |
|
| 132 | - * Treats the option value as an integer value: will return |
|
| 133 | - * valid integer values (also from integer strings), or the |
|
| 134 | - * default value otherwise. |
|
| 135 | - * |
|
| 136 | - * @param string $name |
|
| 137 | - * @param int $default |
|
| 138 | - * @return int |
|
| 139 | - */ |
|
| 131 | + /** |
|
| 132 | + * Treats the option value as an integer value: will return |
|
| 133 | + * valid integer values (also from integer strings), or the |
|
| 134 | + * default value otherwise. |
|
| 135 | + * |
|
| 136 | + * @param string $name |
|
| 137 | + * @param int $default |
|
| 138 | + * @return int |
|
| 139 | + */ |
|
| 140 | 140 | public function getIntOption(string $name, int $default=0) : int |
| 141 | 141 | { |
| 142 | 142 | $value = $this->getOption($name); |
@@ -147,14 +147,14 @@ discard block |
||
| 147 | 147 | return $default; |
| 148 | 148 | } |
| 149 | 149 | |
| 150 | - /** |
|
| 151 | - * Treats an option as an array, and returns its value |
|
| 152 | - * only if it contains an array - otherwise, an empty |
|
| 153 | - * array is returned. |
|
| 154 | - * |
|
| 155 | - * @param string $name |
|
| 156 | - * @return array |
|
| 157 | - */ |
|
| 150 | + /** |
|
| 151 | + * Treats an option as an array, and returns its value |
|
| 152 | + * only if it contains an array - otherwise, an empty |
|
| 153 | + * array is returned. |
|
| 154 | + * |
|
| 155 | + * @param string $name |
|
| 156 | + * @return array |
|
| 157 | + */ |
|
| 158 | 158 | public function getArrayOption(string $name) : array |
| 159 | 159 | { |
| 160 | 160 | $val = $this->getOption($name); |
@@ -165,13 +165,13 @@ discard block |
||
| 165 | 165 | return array(); |
| 166 | 166 | } |
| 167 | 167 | |
| 168 | - /** |
|
| 169 | - * Checks whether the specified option exists - even |
|
| 170 | - * if it has a NULL value. |
|
| 171 | - * |
|
| 172 | - * @param string $name |
|
| 173 | - * @return bool |
|
| 174 | - */ |
|
| 168 | + /** |
|
| 169 | + * Checks whether the specified option exists - even |
|
| 170 | + * if it has a NULL value. |
|
| 171 | + * |
|
| 172 | + * @param string $name |
|
| 173 | + * @return bool |
|
| 174 | + */ |
|
| 175 | 175 | public function hasOption(string $name) : bool |
| 176 | 176 | { |
| 177 | 177 | if(!isset($this->options)) { |
@@ -181,11 +181,11 @@ discard block |
||
| 181 | 181 | return array_key_exists($name, $this->options); |
| 182 | 182 | } |
| 183 | 183 | |
| 184 | - /** |
|
| 185 | - * Returns all options in one associative array. |
|
| 186 | - * |
|
| 187 | - * @return array<string,mixed> |
|
| 188 | - */ |
|
| 184 | + /** |
|
| 185 | + * Returns all options in one associative array. |
|
| 186 | + * |
|
| 187 | + * @return array<string,mixed> |
|
| 188 | + */ |
|
| 189 | 189 | public function getOptions() : array |
| 190 | 190 | { |
| 191 | 191 | if(!isset($this->options)) { |
@@ -195,23 +195,23 @@ discard block |
||
| 195 | 195 | return $this->options; |
| 196 | 196 | } |
| 197 | 197 | |
| 198 | - /** |
|
| 199 | - * Checks whether the option's value is the one specified. |
|
| 200 | - * |
|
| 201 | - * @param string $name |
|
| 202 | - * @param mixed $value |
|
| 203 | - * @return bool |
|
| 204 | - */ |
|
| 198 | + /** |
|
| 199 | + * Checks whether the option's value is the one specified. |
|
| 200 | + * |
|
| 201 | + * @param string $name |
|
| 202 | + * @param mixed $value |
|
| 203 | + * @return bool |
|
| 204 | + */ |
|
| 205 | 205 | public function isOption(string $name, $value) : bool |
| 206 | 206 | { |
| 207 | 207 | return $this->getOption($name) === $value; |
| 208 | 208 | } |
| 209 | 209 | |
| 210 | - /** |
|
| 211 | - * Retrieves the default available options as an |
|
| 212 | - * associative array with option name => value pairs. |
|
| 213 | - * |
|
| 214 | - * @return array<string,mixed> |
|
| 215 | - */ |
|
| 210 | + /** |
|
| 211 | + * Retrieves the default available options as an |
|
| 212 | + * associative array with option name => value pairs. |
|
| 213 | + * |
|
| 214 | + * @return array<string,mixed> |
|
| 215 | + */ |
|
| 216 | 216 | abstract public function getDefaultOptions() : array; |
| 217 | 217 | } |
@@ -41,7 +41,7 @@ discard block |
||
| 41 | 41 | */ |
| 42 | 42 | public function setOption(string $name, $value) |
| 43 | 43 | { |
| 44 | - if(!isset($this->options)) { |
|
| 44 | + if (!isset($this->options)) { |
|
| 45 | 45 | $this->options = $this->getDefaultOptions(); |
| 46 | 46 | } |
| 47 | 47 | |
@@ -58,7 +58,7 @@ discard block |
||
| 58 | 58 | */ |
| 59 | 59 | public function setOptions(array $options) |
| 60 | 60 | { |
| 61 | - foreach($options as $name => $value) { |
|
| 61 | + foreach ($options as $name => $value) { |
|
| 62 | 62 | $this->setOption($name, $value); |
| 63 | 63 | } |
| 64 | 64 | |
@@ -75,13 +75,13 @@ discard block |
||
| 75 | 75 | * @param mixed $default The default value to return if the option does not exist. |
| 76 | 76 | * @return mixed |
| 77 | 77 | */ |
| 78 | - public function getOption(string $name, $default=null) |
|
| 78 | + public function getOption(string $name, $default = null) |
|
| 79 | 79 | { |
| 80 | - if(!isset($this->options)) { |
|
| 80 | + if (!isset($this->options)) { |
|
| 81 | 81 | $this->options = $this->getDefaultOptions(); |
| 82 | 82 | } |
| 83 | 83 | |
| 84 | - if(isset($this->options[$name])) { |
|
| 84 | + if (isset($this->options[$name])) { |
|
| 85 | 85 | return $this->options[$name]; |
| 86 | 86 | } |
| 87 | 87 | |
@@ -98,11 +98,11 @@ discard block |
||
| 98 | 98 | * @param string $default Used if the option does not exist, is invalid, or empty. |
| 99 | 99 | * @return string |
| 100 | 100 | */ |
| 101 | - public function getStringOption(string $name, string $default='') : string |
|
| 101 | + public function getStringOption(string $name, string $default = '') : string |
|
| 102 | 102 | { |
| 103 | 103 | $value = $this->getOption($name, false); |
| 104 | 104 | |
| 105 | - if((is_string($value) || is_numeric($value)) && !empty($value)) { |
|
| 105 | + if ((is_string($value) || is_numeric($value)) && !empty($value)) { |
|
| 106 | 106 | return (string)$value; |
| 107 | 107 | } |
| 108 | 108 | |
@@ -119,9 +119,9 @@ discard block |
||
| 119 | 119 | * @param bool $default |
| 120 | 120 | * @return bool |
| 121 | 121 | */ |
| 122 | - public function getBoolOption(string $name, bool $default=false) : bool |
|
| 122 | + public function getBoolOption(string $name, bool $default = false) : bool |
|
| 123 | 123 | { |
| 124 | - if($this->getOption($name) === true) { |
|
| 124 | + if ($this->getOption($name) === true) { |
|
| 125 | 125 | return true; |
| 126 | 126 | } |
| 127 | 127 | |
@@ -137,10 +137,10 @@ discard block |
||
| 137 | 137 | * @param int $default |
| 138 | 138 | * @return int |
| 139 | 139 | */ |
| 140 | - public function getIntOption(string $name, int $default=0) : int |
|
| 140 | + public function getIntOption(string $name, int $default = 0) : int |
|
| 141 | 141 | { |
| 142 | 142 | $value = $this->getOption($name); |
| 143 | - if(ConvertHelper::isInteger($value)) { |
|
| 143 | + if (ConvertHelper::isInteger($value)) { |
|
| 144 | 144 | return (int)$value; |
| 145 | 145 | } |
| 146 | 146 | |
@@ -158,7 +158,7 @@ discard block |
||
| 158 | 158 | public function getArrayOption(string $name) : array |
| 159 | 159 | { |
| 160 | 160 | $val = $this->getOption($name); |
| 161 | - if(is_array($val)) { |
|
| 161 | + if (is_array($val)) { |
|
| 162 | 162 | return $val; |
| 163 | 163 | } |
| 164 | 164 | |
@@ -174,7 +174,7 @@ discard block |
||
| 174 | 174 | */ |
| 175 | 175 | public function hasOption(string $name) : bool |
| 176 | 176 | { |
| 177 | - if(!isset($this->options)) { |
|
| 177 | + if (!isset($this->options)) { |
|
| 178 | 178 | $this->options = $this->getDefaultOptions(); |
| 179 | 179 | } |
| 180 | 180 | |
@@ -188,7 +188,7 @@ discard block |
||
| 188 | 188 | */ |
| 189 | 189 | public function getOptions() : array |
| 190 | 190 | { |
| 191 | - if(!isset($this->options)) { |
|
| 191 | + if (!isset($this->options)) { |
|
| 192 | 192 | $this->options = $this->getDefaultOptions(); |
| 193 | 193 | } |
| 194 | 194 | |
@@ -45,7 +45,7 @@ |
||
| 45 | 45 | * @param mixed $default The default value to return if the option does not exist. |
| 46 | 46 | * @return mixed |
| 47 | 47 | */ |
| 48 | - function getOption(string $name, $default=null); |
|
| 48 | + function getOption(string $name, $default = null); |
|
| 49 | 49 | |
| 50 | 50 | /** |
| 51 | 51 | * Sets a collection of options at once, from an |