@@ -25,17 +25,17 @@ |
||
| 25 | 25 | * |
| 26 | 26 | * @return string |
| 27 | 27 | */ |
| 28 | - function render() : string; |
|
| 28 | + function render() : string; |
|
| 29 | 29 | |
| 30 | 30 | /** |
| 31 | 31 | * Converts the string builder to a string. |
| 32 | 32 | * |
| 33 | 33 | * @return string |
| 34 | 34 | */ |
| 35 | - function __toString(); |
|
| 35 | + function __toString(); |
|
| 36 | 36 | |
| 37 | 37 | /** |
| 38 | 38 | * Renders the string and echos it. |
| 39 | 39 | */ |
| 40 | - function display() : void; |
|
| 40 | + function display() : void; |
|
| 41 | 41 | } |
@@ -33,24 +33,24 @@ discard block |
||
| 33 | 33 | */ |
| 34 | 34 | class StringBuilder implements StringBuilder_Interface |
| 35 | 35 | { |
| 36 | - /** |
|
| 37 | - * @var string |
|
| 38 | - */ |
|
| 36 | + /** |
|
| 37 | + * @var string |
|
| 38 | + */ |
|
| 39 | 39 | protected $separator = ' '; |
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * @var string[] |
|
| 43 | - */ |
|
| 41 | + /** |
|
| 42 | + * @var string[] |
|
| 43 | + */ |
|
| 44 | 44 | protected $strings = array(); |
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * @var string |
|
| 48 | - */ |
|
| 46 | + /** |
|
| 47 | + * @var string |
|
| 48 | + */ |
|
| 49 | 49 | protected $mode = 'html'; |
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * @var string |
|
| 53 | - */ |
|
| 51 | + /** |
|
| 52 | + * @var string |
|
| 53 | + */ |
|
| 54 | 54 | protected $noSpace = '§!§'; |
| 55 | 55 | |
| 56 | 56 | public function __construct() |
@@ -58,12 +58,12 @@ discard block |
||
| 58 | 58 | |
| 59 | 59 | } |
| 60 | 60 | |
| 61 | - /** |
|
| 62 | - * Adds a subject as a string. Is ignored if empty. |
|
| 63 | - * |
|
| 64 | - * @param string|number|StringBuilder_Interface $string |
|
| 65 | - * @return $this |
|
| 66 | - */ |
|
| 61 | + /** |
|
| 62 | + * Adds a subject as a string. Is ignored if empty. |
|
| 63 | + * |
|
| 64 | + * @param string|number|StringBuilder_Interface $string |
|
| 65 | + * @return $this |
|
| 66 | + */ |
|
| 67 | 67 | public function add($string) : StringBuilder |
| 68 | 68 | { |
| 69 | 69 | $string = strval($string); |
@@ -76,57 +76,57 @@ discard block |
||
| 76 | 76 | return $this; |
| 77 | 77 | } |
| 78 | 78 | |
| 79 | - /** |
|
| 80 | - * Adds a string without appending an automatic space. |
|
| 81 | - * |
|
| 82 | - * @param string|number|StringBuilder_Interface $string |
|
| 83 | - * @return $this |
|
| 84 | - */ |
|
| 79 | + /** |
|
| 80 | + * Adds a string without appending an automatic space. |
|
| 81 | + * |
|
| 82 | + * @param string|number|StringBuilder_Interface $string |
|
| 83 | + * @return $this |
|
| 84 | + */ |
|
| 85 | 85 | public function nospace($string) : StringBuilder |
| 86 | 86 | { |
| 87 | 87 | return $this->add($this->noSpace.strval($string)); |
| 88 | 88 | } |
| 89 | 89 | |
| 90 | - /** |
|
| 91 | - * Adds raw HTML code. Does not add an automatic space. |
|
| 92 | - * |
|
| 93 | - * @param string|number|StringBuilder_Interface $html |
|
| 94 | - * @return $this |
|
| 95 | - */ |
|
| 90 | + /** |
|
| 91 | + * Adds raw HTML code. Does not add an automatic space. |
|
| 92 | + * |
|
| 93 | + * @param string|number|StringBuilder_Interface $html |
|
| 94 | + * @return $this |
|
| 95 | + */ |
|
| 96 | 96 | public function html($html) : StringBuilder |
| 97 | 97 | { |
| 98 | 98 | return $this->nospace($html); |
| 99 | 99 | } |
| 100 | 100 | |
| 101 | - /** |
|
| 102 | - * Adds an unordered list with the specified items. |
|
| 103 | - * |
|
| 104 | - * @param array<int,string|number|StringBuilder_Interface> $items |
|
| 105 | - * @return $this |
|
| 106 | - */ |
|
| 101 | + /** |
|
| 102 | + * Adds an unordered list with the specified items. |
|
| 103 | + * |
|
| 104 | + * @param array<int,string|number|StringBuilder_Interface> $items |
|
| 105 | + * @return $this |
|
| 106 | + */ |
|
| 107 | 107 | public function ul(array $items) : StringBuilder |
| 108 | 108 | { |
| 109 | 109 | return $this->list('ul', $items); |
| 110 | 110 | } |
| 111 | 111 | |
| 112 | - /** |
|
| 113 | - * Adds an ordered list with the specified items. |
|
| 114 | - * |
|
| 115 | - * @param array<int,string|number|StringBuilder_Interface> $items |
|
| 116 | - * @return $this |
|
| 117 | - */ |
|
| 112 | + /** |
|
| 113 | + * Adds an ordered list with the specified items. |
|
| 114 | + * |
|
| 115 | + * @param array<int,string|number|StringBuilder_Interface> $items |
|
| 116 | + * @return $this |
|
| 117 | + */ |
|
| 118 | 118 | public function ol(array $items) : StringBuilder |
| 119 | 119 | { |
| 120 | 120 | return $this->list('ol', $items); |
| 121 | 121 | } |
| 122 | 122 | |
| 123 | - /** |
|
| 124 | - * Creates a list tag with the items list. |
|
| 125 | - * |
|
| 126 | - * @param string $type The list type, `ol` or `ul`. |
|
| 127 | - * @param array<int,string|number|StringBuilder_Interface> $items |
|
| 128 | - * @return $this |
|
| 129 | - */ |
|
| 123 | + /** |
|
| 124 | + * Creates a list tag with the items list. |
|
| 125 | + * |
|
| 126 | + * @param string $type The list type, `ol` or `ul`. |
|
| 127 | + * @param array<int,string|number|StringBuilder_Interface> $items |
|
| 128 | + * @return $this |
|
| 129 | + */ |
|
| 130 | 130 | protected function list(string $type, array $items) : StringBuilder |
| 131 | 131 | { |
| 132 | 132 | return $this->html(sprintf( |
@@ -136,13 +136,13 @@ discard block |
||
| 136 | 136 | )); |
| 137 | 137 | } |
| 138 | 138 | |
| 139 | - /** |
|
| 140 | - * Add a translated string. |
|
| 141 | - * |
|
| 142 | - * @param string $format The native string to translate. |
|
| 143 | - * @param array<int,mixed> $arguments The variables to inject into the translated string, if any. |
|
| 144 | - * @return $this |
|
| 145 | - */ |
|
| 139 | + /** |
|
| 140 | + * Add a translated string. |
|
| 141 | + * |
|
| 142 | + * @param string $format The native string to translate. |
|
| 143 | + * @param array<int,mixed> $arguments The variables to inject into the translated string, if any. |
|
| 144 | + * @return $this |
|
| 145 | + */ |
|
| 146 | 146 | public function t(string $format, ...$arguments) : StringBuilder |
| 147 | 147 | { |
| 148 | 148 | array_unshift($arguments, $format); |
@@ -158,47 +158,47 @@ discard block |
||
| 158 | 158 | )); |
| 159 | 159 | } |
| 160 | 160 | |
| 161 | - /** |
|
| 162 | - * Adds a "5 months ago" age since the specified date. |
|
| 163 | - * |
|
| 164 | - * @param DateTime $since |
|
| 165 | - * @return $this |
|
| 166 | - */ |
|
| 161 | + /** |
|
| 162 | + * Adds a "5 months ago" age since the specified date. |
|
| 163 | + * |
|
| 164 | + * @param DateTime $since |
|
| 165 | + * @return $this |
|
| 166 | + */ |
|
| 167 | 167 | public function age(DateTime $since) : StringBuilder |
| 168 | 168 | { |
| 169 | 169 | return $this->add(ConvertHelper::duration2string($since)); |
| 170 | 170 | } |
| 171 | 171 | |
| 172 | - /** |
|
| 173 | - * Adds HTML quotes around the string. |
|
| 174 | - * |
|
| 175 | - * @param string|number|StringBuilder_Interface $string |
|
| 176 | - * @return $this |
|
| 177 | - */ |
|
| 172 | + /** |
|
| 173 | + * Adds HTML quotes around the string. |
|
| 174 | + * |
|
| 175 | + * @param string|number|StringBuilder_Interface $string |
|
| 176 | + * @return $this |
|
| 177 | + */ |
|
| 178 | 178 | public function quote($string) |
| 179 | 179 | { |
| 180 | 180 | return $this->sf('"%s"', strval($string)); |
| 181 | 181 | } |
| 182 | 182 | |
| 183 | - /** |
|
| 184 | - * Adds a text that is meant as a reference to an UI element, |
|
| 185 | - * like a menu item, button, etc. |
|
| 186 | - * |
|
| 187 | - * @param string|number|StringBuilder_Interface |
|
| 188 | - * @return $this |
|
| 189 | - */ |
|
| 183 | + /** |
|
| 184 | + * Adds a text that is meant as a reference to an UI element, |
|
| 185 | + * like a menu item, button, etc. |
|
| 186 | + * |
|
| 187 | + * @param string|number|StringBuilder_Interface |
|
| 188 | + * @return $this |
|
| 189 | + */ |
|
| 190 | 190 | public function reference($string) : StringBuilder |
| 191 | 191 | { |
| 192 | 192 | return $this->sf('"%s"', $string); |
| 193 | 193 | } |
| 194 | 194 | |
| 195 | - /** |
|
| 196 | - * Add a string using the `sprintf` method. |
|
| 197 | - * |
|
| 198 | - * @param string $format The format string |
|
| 199 | - * @param string|number|StringBuilder_Interface $arguments The variables to inject |
|
| 200 | - * @return $this |
|
| 201 | - */ |
|
| 195 | + /** |
|
| 196 | + * Add a string using the `sprintf` method. |
|
| 197 | + * |
|
| 198 | + * @param string $format The format string |
|
| 199 | + * @param string|number|StringBuilder_Interface $arguments The variables to inject |
|
| 200 | + * @return $this |
|
| 201 | + */ |
|
| 202 | 202 | public function sf(string $format, ...$arguments) : StringBuilder |
| 203 | 203 | { |
| 204 | 204 | array_unshift($arguments, $format); |
@@ -206,12 +206,12 @@ discard block |
||
| 206 | 206 | return $this->add(call_user_func_array('sprintf', $arguments)); |
| 207 | 207 | } |
| 208 | 208 | |
| 209 | - /** |
|
| 210 | - * Adds a bold string. |
|
| 211 | - * |
|
| 212 | - * @param string|number|StringBuilder_Interface $string |
|
| 213 | - * @return $this |
|
| 214 | - */ |
|
| 209 | + /** |
|
| 210 | + * Adds a bold string. |
|
| 211 | + * |
|
| 212 | + * @param string|number|StringBuilder_Interface $string |
|
| 213 | + * @return $this |
|
| 214 | + */ |
|
| 215 | 215 | public function bold($string) : StringBuilder |
| 216 | 216 | { |
| 217 | 217 | return $this->sf( |
@@ -220,74 +220,74 @@ discard block |
||
| 220 | 220 | ); |
| 221 | 221 | } |
| 222 | 222 | |
| 223 | - /** |
|
| 224 | - * Adds a HTML `br` tag. |
|
| 225 | - * |
|
| 226 | - * @return $this |
|
| 227 | - */ |
|
| 223 | + /** |
|
| 224 | + * Adds a HTML `br` tag. |
|
| 225 | + * |
|
| 226 | + * @return $this |
|
| 227 | + */ |
|
| 228 | 228 | public function nl() : StringBuilder |
| 229 | 229 | { |
| 230 | 230 | return $this->html('<br>'); |
| 231 | 231 | } |
| 232 | 232 | |
| 233 | - /** |
|
| 234 | - * Adds the current time, in the format <code>H:i:s</code>. |
|
| 235 | - * |
|
| 236 | - * @return $this |
|
| 237 | - */ |
|
| 233 | + /** |
|
| 234 | + * Adds the current time, in the format <code>H:i:s</code>. |
|
| 235 | + * |
|
| 236 | + * @return $this |
|
| 237 | + */ |
|
| 238 | 238 | public function time() : StringBuilder |
| 239 | 239 | { |
| 240 | 240 | return $this->add(date('H:i:s')); |
| 241 | 241 | } |
| 242 | 242 | |
| 243 | - /** |
|
| 244 | - * Adds the "Note:" text. |
|
| 245 | - * |
|
| 246 | - * @return $this |
|
| 247 | - */ |
|
| 243 | + /** |
|
| 244 | + * Adds the "Note:" text. |
|
| 245 | + * |
|
| 246 | + * @return $this |
|
| 247 | + */ |
|
| 248 | 248 | public function note() : StringBuilder |
| 249 | 249 | { |
| 250 | 250 | return $this->t('Note:'); |
| 251 | 251 | } |
| 252 | 252 | |
| 253 | - /** |
|
| 254 | - * Like `note()`, but as bold text. |
|
| 255 | - * |
|
| 256 | - * @return $this |
|
| 257 | - */ |
|
| 253 | + /** |
|
| 254 | + * Like `note()`, but as bold text. |
|
| 255 | + * |
|
| 256 | + * @return $this |
|
| 257 | + */ |
|
| 258 | 258 | public function noteBold() : StringBuilder |
| 259 | 259 | { |
| 260 | 260 | return $this->bold(sb()->note()); |
| 261 | 261 | } |
| 262 | 262 | |
| 263 | - /** |
|
| 264 | - * Adds the "Hint:" text. |
|
| 265 | - * |
|
| 266 | - * @return $this |
|
| 267 | - */ |
|
| 263 | + /** |
|
| 264 | + * Adds the "Hint:" text. |
|
| 265 | + * |
|
| 266 | + * @return $this |
|
| 267 | + */ |
|
| 268 | 268 | public function hint() : StringBuilder |
| 269 | 269 | { |
| 270 | 270 | return $this->t('Hint:'); |
| 271 | 271 | } |
| 272 | 272 | |
| 273 | - /** |
|
| 274 | - * Adds two linebreaks. |
|
| 275 | - * |
|
| 276 | - * @return $this |
|
| 277 | - */ |
|
| 273 | + /** |
|
| 274 | + * Adds two linebreaks. |
|
| 275 | + * |
|
| 276 | + * @return $this |
|
| 277 | + */ |
|
| 278 | 278 | public function para() : StringBuilder |
| 279 | 279 | { |
| 280 | 280 | return $this->nl()->nl(); |
| 281 | 281 | } |
| 282 | 282 | |
| 283 | - /** |
|
| 284 | - * Adds an anchor HTML tag. |
|
| 285 | - * |
|
| 286 | - * @param string $label |
|
| 287 | - * @param string $url |
|
| 288 | - * @param bool $newTab |
|
| 289 | - * @return $this |
|
| 290 | - */ |
|
| 283 | + /** |
|
| 284 | + * Adds an anchor HTML tag. |
|
| 285 | + * |
|
| 286 | + * @param string $label |
|
| 287 | + * @param string $url |
|
| 288 | + * @param bool $newTab |
|
| 289 | + * @return $this |
|
| 290 | + */ |
|
| 291 | 291 | public function link(string $label, string $url, bool $newTab=false) : StringBuilder |
| 292 | 292 | { |
| 293 | 293 | $target = ''; |
@@ -303,12 +303,12 @@ discard block |
||
| 303 | 303 | ); |
| 304 | 304 | } |
| 305 | 305 | |
| 306 | - /** |
|
| 307 | - * Wraps the string in a `code` tag. |
|
| 308 | - * |
|
| 309 | - * @param string|number|StringBuilder_Interface $string |
|
| 310 | - * @return $this |
|
| 311 | - */ |
|
| 306 | + /** |
|
| 307 | + * Wraps the string in a `code` tag. |
|
| 308 | + * |
|
| 309 | + * @param string|number|StringBuilder_Interface $string |
|
| 310 | + * @return $this |
|
| 311 | + */ |
|
| 312 | 312 | public function code($string) : StringBuilder |
| 313 | 313 | { |
| 314 | 314 | return $this->sf( |
@@ -317,24 +317,24 @@ discard block |
||
| 317 | 317 | ); |
| 318 | 318 | } |
| 319 | 319 | |
| 320 | - /** |
|
| 321 | - * Wraps the string in a `pre` tag. |
|
| 322 | - * |
|
| 323 | - * @param string|number|StringBuilder_Interface $string |
|
| 324 | - * @return $this |
|
| 325 | - */ |
|
| 320 | + /** |
|
| 321 | + * Wraps the string in a `pre` tag. |
|
| 322 | + * |
|
| 323 | + * @param string|number|StringBuilder_Interface $string |
|
| 324 | + * @return $this |
|
| 325 | + */ |
|
| 326 | 326 | public function pre($string) : StringBuilder |
| 327 | 327 | { |
| 328 | 328 | return $this->sf('<pre>%s</pre>', strval($string)); |
| 329 | 329 | } |
| 330 | 330 | |
| 331 | - /** |
|
| 332 | - * Wraps the text in a `span` tag with the specified classes. |
|
| 333 | - * |
|
| 334 | - * @param string|number|StringBuilder_Interface $string |
|
| 335 | - * @param string|string[] $classes |
|
| 336 | - * @return $this |
|
| 337 | - */ |
|
| 331 | + /** |
|
| 332 | + * Wraps the text in a `span` tag with the specified classes. |
|
| 333 | + * |
|
| 334 | + * @param string|number|StringBuilder_Interface $string |
|
| 335 | + * @param string|string[] $classes |
|
| 336 | + * @return $this |
|
| 337 | + */ |
|
| 338 | 338 | protected function spanned($string, $classes) : StringBuilder |
| 339 | 339 | { |
| 340 | 340 | if(!is_array($classes)) |
@@ -68,7 +68,7 @@ discard block |
||
| 68 | 68 | { |
| 69 | 69 | $string = strval($string); |
| 70 | 70 | |
| 71 | - if(!empty($string)) |
|
| 71 | + if (!empty($string)) |
|
| 72 | 72 | { |
| 73 | 73 | $this->strings[] = $string; |
| 74 | 74 | } |
@@ -147,7 +147,7 @@ discard block |
||
| 147 | 147 | { |
| 148 | 148 | array_unshift($arguments, $format); |
| 149 | 149 | |
| 150 | - if(!class_exists('\AppLocalize\Localization')) |
|
| 150 | + if (!class_exists('\AppLocalize\Localization')) |
|
| 151 | 151 | { |
| 152 | 152 | return $this->sf(...$arguments); |
| 153 | 153 | } |
@@ -288,10 +288,10 @@ discard block |
||
| 288 | 288 | * @param bool $newTab |
| 289 | 289 | * @return $this |
| 290 | 290 | */ |
| 291 | - public function link(string $label, string $url, bool $newTab=false) : StringBuilder |
|
| 291 | + public function link(string $label, string $url, bool $newTab = false) : StringBuilder |
|
| 292 | 292 | { |
| 293 | 293 | $target = ''; |
| 294 | - if($newTab) { |
|
| 294 | + if ($newTab) { |
|
| 295 | 295 | $target = ' target="_blank"'; |
| 296 | 296 | } |
| 297 | 297 | |
@@ -337,7 +337,7 @@ discard block |
||
| 337 | 337 | */ |
| 338 | 338 | protected function spanned($string, $classes) : StringBuilder |
| 339 | 339 | { |
| 340 | - if(!is_array($classes)) |
|
| 340 | + if (!is_array($classes)) |
|
| 341 | 341 | { |
| 342 | 342 | $classes = array(strval($classes)); |
| 343 | 343 | } |