@@ -87,37 +87,37 @@ |
||
| 87 | 87 | */ |
| 88 | 88 | interface Interface_Classable |
| 89 | 89 | { |
| 90 | - /** |
|
| 91 | - * @param string $name |
|
| 92 | - * @return $this |
|
| 93 | - */ |
|
| 90 | + /** |
|
| 91 | + * @param string $name |
|
| 92 | + * @return $this |
|
| 93 | + */ |
|
| 94 | 94 | public function addClass(string $name); |
| 95 | 95 | |
| 96 | - /** |
|
| 97 | - * @param array $names |
|
| 98 | - * @return $this |
|
| 99 | - */ |
|
| 96 | + /** |
|
| 97 | + * @param array $names |
|
| 98 | + * @return $this |
|
| 99 | + */ |
|
| 100 | 100 | public function addClasses(array $names); |
| 101 | 101 | |
| 102 | - /** |
|
| 103 | - * @param string $name |
|
| 104 | - * @return bool |
|
| 105 | - */ |
|
| 102 | + /** |
|
| 103 | + * @param string $name |
|
| 104 | + * @return bool |
|
| 105 | + */ |
|
| 106 | 106 | public function hasClass(string $name) : bool; |
| 107 | 107 | |
| 108 | - /** |
|
| 109 | - * @param string $name |
|
| 110 | - * @return $this |
|
| 111 | - */ |
|
| 108 | + /** |
|
| 109 | + * @param string $name |
|
| 110 | + * @return $this |
|
| 111 | + */ |
|
| 112 | 112 | public function removeClass(string $name); |
| 113 | 113 | |
| 114 | - /** |
|
| 115 | - * @return array |
|
| 116 | - */ |
|
| 114 | + /** |
|
| 115 | + * @return array |
|
| 116 | + */ |
|
| 117 | 117 | public function getClasses() : array; |
| 118 | 118 | |
| 119 | - /** |
|
| 120 | - * @return string |
|
| 121 | - */ |
|
| 119 | + /** |
|
| 120 | + * @return string |
|
| 121 | + */ |
|
| 122 | 122 | public function classesToString() : string; |
| 123 | 123 | } |
@@ -26,18 +26,18 @@ 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 | - /** |
|
| 35 | - * Sets an option to the specified value. This can be any |
|
| 36 | - * kind of variable type, including objects, as needed. |
|
| 37 | - * |
|
| 38 | - * @param string $name |
|
| 39 | - * @param mixed $value |
|
| 40 | - */ |
|
| 34 | + /** |
|
| 35 | + * Sets an option to the specified value. This can be any |
|
| 36 | + * kind of variable type, including objects, as needed. |
|
| 37 | + * |
|
| 38 | + * @param string $name |
|
| 39 | + * @param mixed $value |
|
| 40 | + */ |
|
| 41 | 41 | public function setOption(string $name, $value) |
| 42 | 42 | { |
| 43 | 43 | if(!isset($this->options)) { |
@@ -48,12 +48,12 @@ discard block |
||
| 48 | 48 | return $this; |
| 49 | 49 | } |
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * Sets a collection of options at once, from an |
|
| 53 | - * associative array. |
|
| 54 | - * |
|
| 55 | - * @param array $options |
|
| 56 | - */ |
|
| 51 | + /** |
|
| 52 | + * Sets a collection of options at once, from an |
|
| 53 | + * associative array. |
|
| 54 | + * |
|
| 55 | + * @param array $options |
|
| 56 | + */ |
|
| 57 | 57 | public function setOptions(array $options) |
| 58 | 58 | { |
| 59 | 59 | foreach($options as $name => $value) { |
@@ -63,16 +63,16 @@ discard block |
||
| 63 | 63 | return $this; |
| 64 | 64 | } |
| 65 | 65 | |
| 66 | - /** |
|
| 67 | - * Retrieves an option's value. |
|
| 68 | - * |
|
| 69 | - * NOTE: Use the specialized type getters to ensure an option |
|
| 70 | - * contains the expected type (for ex. getArrayOption()). |
|
| 71 | - * |
|
| 72 | - * @param string $name |
|
| 73 | - * @param mixed $default The default value to return if the option does not exist. |
|
| 74 | - * @return mixed |
|
| 75 | - */ |
|
| 66 | + /** |
|
| 67 | + * Retrieves an option's value. |
|
| 68 | + * |
|
| 69 | + * NOTE: Use the specialized type getters to ensure an option |
|
| 70 | + * contains the expected type (for ex. getArrayOption()). |
|
| 71 | + * |
|
| 72 | + * @param string $name |
|
| 73 | + * @param mixed $default The default value to return if the option does not exist. |
|
| 74 | + * @return mixed |
|
| 75 | + */ |
|
| 76 | 76 | public function getOption(string $name, $default=null) |
| 77 | 77 | { |
| 78 | 78 | if(!isset($this->options)) { |
@@ -86,16 +86,16 @@ discard block |
||
| 86 | 86 | return $default; |
| 87 | 87 | } |
| 88 | 88 | |
| 89 | - /** |
|
| 90 | - * Enforces that the option value is a string. Numbers are converted |
|
| 91 | - * to string, strings are passed through, and all other types will |
|
| 92 | - * return the default value. The default value is also returned if |
|
| 93 | - * the string is empty. |
|
| 94 | - * |
|
| 95 | - * @param string $name |
|
| 96 | - * @param string $default Used if the option does not exist, is invalid, or empty. |
|
| 97 | - * @return string |
|
| 98 | - */ |
|
| 89 | + /** |
|
| 90 | + * Enforces that the option value is a string. Numbers are converted |
|
| 91 | + * to string, strings are passed through, and all other types will |
|
| 92 | + * return the default value. The default value is also returned if |
|
| 93 | + * the string is empty. |
|
| 94 | + * |
|
| 95 | + * @param string $name |
|
| 96 | + * @param string $default Used if the option does not exist, is invalid, or empty. |
|
| 97 | + * @return string |
|
| 98 | + */ |
|
| 99 | 99 | public function getStringOption(string $name, string $default='') : string |
| 100 | 100 | { |
| 101 | 101 | $value = $this->getOption($name, false); |
@@ -107,15 +107,15 @@ discard block |
||
| 107 | 107 | return $default; |
| 108 | 108 | } |
| 109 | 109 | |
| 110 | - /** |
|
| 111 | - * Treats the option value as a boolean value: will return |
|
| 112 | - * true if the value actually is a boolean true. |
|
| 113 | - * |
|
| 114 | - * NOTE: boolean string representations are not accepted. |
|
| 115 | - * |
|
| 116 | - * @param string $name |
|
| 117 | - * @return bool |
|
| 118 | - */ |
|
| 110 | + /** |
|
| 111 | + * Treats the option value as a boolean value: will return |
|
| 112 | + * true if the value actually is a boolean true. |
|
| 113 | + * |
|
| 114 | + * NOTE: boolean string representations are not accepted. |
|
| 115 | + * |
|
| 116 | + * @param string $name |
|
| 117 | + * @return bool |
|
| 118 | + */ |
|
| 119 | 119 | public function getBoolOption(string $name, bool $default=false) : bool |
| 120 | 120 | { |
| 121 | 121 | if($this->getOption($name) === true) { |
@@ -125,15 +125,15 @@ discard block |
||
| 125 | 125 | return $default; |
| 126 | 126 | } |
| 127 | 127 | |
| 128 | - /** |
|
| 129 | - * Treats the option value as an integer value: will return |
|
| 130 | - * valid integer values (also from integer strings), or the |
|
| 131 | - * default value otherwise. |
|
| 132 | - * |
|
| 133 | - * @param string $name |
|
| 134 | - * @param int $default |
|
| 135 | - * @return int |
|
| 136 | - */ |
|
| 128 | + /** |
|
| 129 | + * Treats the option value as an integer value: will return |
|
| 130 | + * valid integer values (also from integer strings), or the |
|
| 131 | + * default value otherwise. |
|
| 132 | + * |
|
| 133 | + * @param string $name |
|
| 134 | + * @param int $default |
|
| 135 | + * @return int |
|
| 136 | + */ |
|
| 137 | 137 | public function getIntOption(string $name, int $default=0) : int |
| 138 | 138 | { |
| 139 | 139 | $value = $this->getOption($name); |
@@ -144,14 +144,14 @@ discard block |
||
| 144 | 144 | return $default; |
| 145 | 145 | } |
| 146 | 146 | |
| 147 | - /** |
|
| 148 | - * Treats an option as an array, and returns its value |
|
| 149 | - * only if it contains an array - otherwise, an empty |
|
| 150 | - * array is returned. |
|
| 151 | - * |
|
| 152 | - * @param string $name |
|
| 153 | - * @return array |
|
| 154 | - */ |
|
| 147 | + /** |
|
| 148 | + * Treats an option as an array, and returns its value |
|
| 149 | + * only if it contains an array - otherwise, an empty |
|
| 150 | + * array is returned. |
|
| 151 | + * |
|
| 152 | + * @param string $name |
|
| 153 | + * @return array |
|
| 154 | + */ |
|
| 155 | 155 | public function getArrayOption(string $name) : array |
| 156 | 156 | { |
| 157 | 157 | $val = $this->getOption($name); |
@@ -162,13 +162,13 @@ discard block |
||
| 162 | 162 | return array(); |
| 163 | 163 | } |
| 164 | 164 | |
| 165 | - /** |
|
| 166 | - * Checks whether the specified option exists - even |
|
| 167 | - * if it has a NULL value. |
|
| 168 | - * |
|
| 169 | - * @param string $name |
|
| 170 | - * @return bool |
|
| 171 | - */ |
|
| 165 | + /** |
|
| 166 | + * Checks whether the specified option exists - even |
|
| 167 | + * if it has a NULL value. |
|
| 168 | + * |
|
| 169 | + * @param string $name |
|
| 170 | + * @return bool |
|
| 171 | + */ |
|
| 172 | 172 | public function hasOption(string $name) : bool |
| 173 | 173 | { |
| 174 | 174 | if(!isset($this->options)) { |
@@ -178,10 +178,10 @@ discard block |
||
| 178 | 178 | return array_key_exists($name, $this->options); |
| 179 | 179 | } |
| 180 | 180 | |
| 181 | - /** |
|
| 182 | - * Returns all options in one associative array. |
|
| 183 | - * @return array |
|
| 184 | - */ |
|
| 181 | + /** |
|
| 182 | + * Returns all options in one associative array. |
|
| 183 | + * @return array |
|
| 184 | + */ |
|
| 185 | 185 | public function getOptions() : array |
| 186 | 186 | { |
| 187 | 187 | if(!isset($this->options)) { |
@@ -191,24 +191,24 @@ discard block |
||
| 191 | 191 | return $this->options; |
| 192 | 192 | } |
| 193 | 193 | |
| 194 | - /** |
|
| 195 | - * Checks whether the option's value is the one specified. |
|
| 196 | - * |
|
| 197 | - * @param string $name |
|
| 198 | - * @param mixed $value |
|
| 199 | - * @return bool |
|
| 200 | - */ |
|
| 194 | + /** |
|
| 195 | + * Checks whether the option's value is the one specified. |
|
| 196 | + * |
|
| 197 | + * @param string $name |
|
| 198 | + * @param mixed $value |
|
| 199 | + * @return bool |
|
| 200 | + */ |
|
| 201 | 201 | public function isOption(string $name, $value) : bool |
| 202 | 202 | { |
| 203 | 203 | return $this->getOption($name) === $value; |
| 204 | 204 | } |
| 205 | 205 | |
| 206 | - /** |
|
| 207 | - * Retrieves the default available options as an |
|
| 208 | - * associative array with option name => value pairs. |
|
| 209 | - * |
|
| 210 | - * @return array |
|
| 211 | - */ |
|
| 206 | + /** |
|
| 207 | + * Retrieves the default available options as an |
|
| 208 | + * associative array with option name => value pairs. |
|
| 209 | + * |
|
| 210 | + * @return array |
|
| 211 | + */ |
|
| 212 | 212 | abstract public function getDefaultOptions() : array; |
| 213 | 213 | } |
| 214 | 214 | |
@@ -226,24 +226,24 @@ discard block |
||
| 226 | 226 | */ |
| 227 | 227 | interface Interface_Optionable |
| 228 | 228 | { |
| 229 | - /** |
|
| 230 | - * @param string $name |
|
| 231 | - * @param mixed $value |
|
| 232 | - * @return $this |
|
| 233 | - */ |
|
| 229 | + /** |
|
| 230 | + * @param string $name |
|
| 231 | + * @param mixed $value |
|
| 232 | + * @return $this |
|
| 233 | + */ |
|
| 234 | 234 | function setOption(string $name, $value); |
| 235 | 235 | |
| 236 | - /** |
|
| 237 | - * @param string $name |
|
| 238 | - * @param mixed $default |
|
| 239 | - * @return $this |
|
| 240 | - */ |
|
| 236 | + /** |
|
| 237 | + * @param string $name |
|
| 238 | + * @param mixed $default |
|
| 239 | + * @return $this |
|
| 240 | + */ |
|
| 241 | 241 | function getOption(string $name, $default=null); |
| 242 | 242 | |
| 243 | - /** |
|
| 244 | - * @param array $options |
|
| 245 | - * @return $this |
|
| 246 | - */ |
|
| 243 | + /** |
|
| 244 | + * @param array $options |
|
| 245 | + * @return $this |
|
| 246 | + */ |
|
| 247 | 247 | function setOptions(array $options); |
| 248 | 248 | function getOptions() : array; |
| 249 | 249 | function isOption(string $name, $value) : bool; |
@@ -40,7 +40,7 @@ discard block |
||
| 40 | 40 | */ |
| 41 | 41 | public function setOption(string $name, $value) |
| 42 | 42 | { |
| 43 | - if(!isset($this->options)) { |
|
| 43 | + if (!isset($this->options)) { |
|
| 44 | 44 | $this->options = $this->getDefaultOptions(); |
| 45 | 45 | } |
| 46 | 46 | |
@@ -56,7 +56,7 @@ discard block |
||
| 56 | 56 | */ |
| 57 | 57 | public function setOptions(array $options) |
| 58 | 58 | { |
| 59 | - foreach($options as $name => $value) { |
|
| 59 | + foreach ($options as $name => $value) { |
|
| 60 | 60 | $this->setOption($name, $value); |
| 61 | 61 | } |
| 62 | 62 | |
@@ -73,13 +73,13 @@ discard block |
||
| 73 | 73 | * @param mixed $default The default value to return if the option does not exist. |
| 74 | 74 | * @return mixed |
| 75 | 75 | */ |
| 76 | - public function getOption(string $name, $default=null) |
|
| 76 | + public function getOption(string $name, $default = null) |
|
| 77 | 77 | { |
| 78 | - if(!isset($this->options)) { |
|
| 78 | + if (!isset($this->options)) { |
|
| 79 | 79 | $this->options = $this->getDefaultOptions(); |
| 80 | 80 | } |
| 81 | 81 | |
| 82 | - if(isset($this->options[$name])) { |
|
| 82 | + if (isset($this->options[$name])) { |
|
| 83 | 83 | return $this->options[$name]; |
| 84 | 84 | } |
| 85 | 85 | |
@@ -96,11 +96,11 @@ discard block |
||
| 96 | 96 | * @param string $default Used if the option does not exist, is invalid, or empty. |
| 97 | 97 | * @return string |
| 98 | 98 | */ |
| 99 | - public function getStringOption(string $name, string $default='') : string |
|
| 99 | + public function getStringOption(string $name, string $default = '') : string |
|
| 100 | 100 | { |
| 101 | 101 | $value = $this->getOption($name, false); |
| 102 | 102 | |
| 103 | - if((is_string($value) || is_numeric($value)) && !empty($value)) { |
|
| 103 | + if ((is_string($value) || is_numeric($value)) && !empty($value)) { |
|
| 104 | 104 | return (string)$value; |
| 105 | 105 | } |
| 106 | 106 | |
@@ -116,9 +116,9 @@ discard block |
||
| 116 | 116 | * @param string $name |
| 117 | 117 | * @return bool |
| 118 | 118 | */ |
| 119 | - public function getBoolOption(string $name, bool $default=false) : bool |
|
| 119 | + public function getBoolOption(string $name, bool $default = false) : bool |
|
| 120 | 120 | { |
| 121 | - if($this->getOption($name) === true) { |
|
| 121 | + if ($this->getOption($name) === true) { |
|
| 122 | 122 | return true; |
| 123 | 123 | } |
| 124 | 124 | |
@@ -134,10 +134,10 @@ discard block |
||
| 134 | 134 | * @param int $default |
| 135 | 135 | * @return int |
| 136 | 136 | */ |
| 137 | - public function getIntOption(string $name, int $default=0) : int |
|
| 137 | + public function getIntOption(string $name, int $default = 0) : int |
|
| 138 | 138 | { |
| 139 | 139 | $value = $this->getOption($name); |
| 140 | - if(ConvertHelper::isInteger($value)) { |
|
| 140 | + if (ConvertHelper::isInteger($value)) { |
|
| 141 | 141 | return (int)$value; |
| 142 | 142 | } |
| 143 | 143 | |
@@ -155,7 +155,7 @@ discard block |
||
| 155 | 155 | public function getArrayOption(string $name) : array |
| 156 | 156 | { |
| 157 | 157 | $val = $this->getOption($name); |
| 158 | - if(is_array($val)) { |
|
| 158 | + if (is_array($val)) { |
|
| 159 | 159 | return $val; |
| 160 | 160 | } |
| 161 | 161 | |
@@ -171,7 +171,7 @@ discard block |
||
| 171 | 171 | */ |
| 172 | 172 | public function hasOption(string $name) : bool |
| 173 | 173 | { |
| 174 | - if(!isset($this->options)) { |
|
| 174 | + if (!isset($this->options)) { |
|
| 175 | 175 | $this->options = $this->getDefaultOptions(); |
| 176 | 176 | } |
| 177 | 177 | |
@@ -184,7 +184,7 @@ discard block |
||
| 184 | 184 | */ |
| 185 | 185 | public function getOptions() : array |
| 186 | 186 | { |
| 187 | - if(!isset($this->options)) { |
|
| 187 | + if (!isset($this->options)) { |
|
| 188 | 188 | $this->options = $this->getDefaultOptions(); |
| 189 | 189 | } |
| 190 | 190 | |
@@ -238,7 +238,7 @@ discard block |
||
| 238 | 238 | * @param mixed $default |
| 239 | 239 | * @return $this |
| 240 | 240 | */ |
| 241 | - function getOption(string $name, $default=null); |
|
| 241 | + function getOption(string $name, $default = null); |
|
| 242 | 242 | |
| 243 | 243 | /** |
| 244 | 244 | * @param array $options |