Formatter.php 20.8 KB
Newer Older
Qiang Xue committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\base;

use Yii;
use DateTime;
use yii\helpers\HtmlPurifier;
use yii\helpers\Html;

/**
 * Formatter provides a set of commonly used data formatting methods.
 *
 * The formatting methods provided by Formatter are all named in the form of `asXyz()`.
 * The behavior of some of them may be configured via the properties of Formatter. For example,
 * by configuring [[dateFormat]], one may control how [[asDate()]] formats the value into a date string.
 *
22
 * Formatter is configured as an application component in [[\yii\base\Application]] by default.
23 24
 * You can access that instance via `Yii::$app->formatter`.
 *
Qiang Xue committed
25 26 27 28 29
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class Formatter extends Component
{
David Renty committed
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
    /**
     * @var string the timezone to use for formatting time and date values.
     * This can be any value that may be passed to [date_default_timezone_set()](http://www.php.net/manual/en/function.date-default-timezone-set.php)
     * e.g. `UTC`, `Europe/Berlin` or `America/Chicago`.
     * Refer to the [php manual](http://www.php.net/manual/en/timezones.php) for available timezones.
     * If this property is not set, [[\yii\base\Application::timezone]] will be used.
     */
    public $timeZone;
    /**
     * @var string the default format string to be used to format a date using PHP date() function.
     */
    public $dateFormat = 'Y/m/d';
    /**
     * @var string the default format string to be used to format a time using PHP date() function.
     */
    public $timeFormat = 'h:i:s A';
    /**
     * @var string the default format string to be used to format a date and time using PHP date() function.
     */
    public $datetimeFormat = 'Y/m/d h:i:s A';
    /**
     * @var string the text to be displayed when formatting a null. Defaults to '<span class="not-set">(not set)</span>'.
     */
    public $nullDisplay;
    /**
     * @var array the text to be displayed when formatting a boolean value. The first element corresponds
     * to the text display for false, the second element for true. Defaults to `['No', 'Yes']`.
     */
    public $booleanFormat;
    /**
     * @var string the character displayed as the decimal point when formatting a number.
     * If not set, "." will be used.
     */
    public $decimalSeparator;
    /**
     * @var string the character displayed as the thousands separator character when formatting a number.
     * If not set, "," will be used.
     */
    public $thousandSeparator;
    /**
     * @var array the format used to format size (bytes). Three elements may be specified: "base", "decimals" and "decimalSeparator".
     * They correspond to the base at which a kilobyte is calculated (1000 or 1024 bytes per kilobyte, defaults to 1024),
     * the number of digits after the decimal point (defaults to 2) and the character displayed as the decimal point.
     */
    public $sizeFormat = [
        'base' => 1024,
        'decimals' => 2,
        'decimalSeparator' => null,
    ];

    /**
     * Initializes the component.
     */
    public function init()
    {
        if ($this->timeZone === null) {
            $this->timeZone = Yii::$app->timeZone;
        }

        if (empty($this->booleanFormat)) {
            $this->booleanFormat = [Yii::t('yii', 'No'), Yii::t('yii', 'Yes')];
        }
        if ($this->nullDisplay === null) {
            $this->nullDisplay = '<span class="not-set">' . Yii::t('yii', '(not set)') . '</span>';
        }
    }

    /**
     * Formats the value based on the given format type.
     * This method will call one of the "as" methods available in this class to do the formatting.
     * For type "xyz", the method "asXyz" will be used. For example, if the format is "html",
     * then [[asHtml()]] will be used. Format names are case insensitive.
102 103 104 105 106 107
     * @param  mixed                 $value  the value to be formatted
     * @param  string|array          $format the format of the value, e.g., "html", "text". To specify additional
     *                                       parameters of the formatting method, you may use an array. The first element of the array
     *                                       specifies the format name, while the rest of the elements will be used as the parameters to the formatting
     *                                       method. For example, a format of `['date', 'Y-m-d']` will cause the invocation of `asDate($value, 'Y-m-d')`.
     * @return string                the formatting result
David Renty committed
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
     * @throws InvalidParamException if the type is not supported by this class.
     */
    public function format($value, $format)
    {
        if (is_array($format)) {
            if (!isset($format[0])) {
                throw new InvalidParamException('The $format array must contain at least one element.');
            }
            $f = $format[0];
            $format[0] = $value;
            $params = $format;
            $format = $f;
        } else {
            $params = [$value];
        }
        $method = 'as' . $format;
        if ($this->hasMethod($method)) {
            return call_user_func_array([$this, $method], $params);
        } else {
            throw new InvalidParamException("Unknown type: $format");
        }
    }

    /**
     * Formats the value as is without any formatting.
     * This method simply returns back the parameter without any format.
134
     * @param  mixed  $value the value to be formatted
David Renty committed
135 136 137 138 139 140 141
     * @return string the formatted result
     */
    public function asRaw($value)
    {
        if ($value === null) {
            return $this->nullDisplay;
        }
142

David Renty committed
143 144 145 146 147
        return $value;
    }

    /**
     * Formats the value as an HTML-encoded plain text.
148
     * @param  mixed  $value the value to be formatted
David Renty committed
149 150 151 152 153 154 155
     * @return string the formatted result
     */
    public function asText($value)
    {
        if ($value === null) {
            return $this->nullDisplay;
        }
156

David Renty committed
157 158 159 160 161
        return Html::encode($value);
    }

    /**
     * Formats the value as an HTML-encoded plain text with newlines converted into breaks.
162
     * @param  mixed  $value the value to be formatted
David Renty committed
163 164 165 166 167 168 169
     * @return string the formatted result
     */
    public function asNtext($value)
    {
        if ($value === null) {
            return $this->nullDisplay;
        }
170

David Renty committed
171 172 173 174 175 176 177
        return nl2br(Html::encode($value));
    }

    /**
     * Formats the value as HTML-encoded text paragraphs.
     * Each text paragraph is enclosed within a `<p>` tag.
     * One or multiple consecutive empty lines divide two paragraphs.
178
     * @param  mixed  $value the value to be formatted
David Renty committed
179 180 181 182 183 184 185
     * @return string the formatted result
     */
    public function asParagraphs($value)
    {
        if ($value === null) {
            return $this->nullDisplay;
        }
186 187

        return str_replace('<p></p>', '',
David Renty committed
188 189 190 191 192 193 194 195
            '<p>' . preg_replace('/[\r\n]{2,}/', "</p>\n<p>", Html::encode($value)) . '</p>'
        );
    }

    /**
     * Formats the value as HTML text.
     * The value will be purified using [[HtmlPurifier]] to avoid XSS attacks.
     * Use [[asRaw()]] if you do not want any purification of the value.
196 197 198
     * @param  mixed      $value  the value to be formatted
     * @param  array|null $config the configuration for the HTMLPurifier class.
     * @return string     the formatted result
David Renty committed
199 200 201 202 203 204
     */
    public function asHtml($value, $config = null)
    {
        if ($value === null) {
            return $this->nullDisplay;
        }
205

David Renty committed
206 207 208 209 210
        return HtmlPurifier::process($value, $config);
    }

    /**
     * Formats the value as a mailto link.
211
     * @param  mixed  $value the value to be formatted
David Renty committed
212 213 214 215 216 217 218
     * @return string the formatted result
     */
    public function asEmail($value)
    {
        if ($value === null) {
            return $this->nullDisplay;
        }
219

David Renty committed
220 221 222 223 224
        return Html::mailto(Html::encode($value), $value);
    }

    /**
     * Formats the value as an image tag.
225
     * @param  mixed  $value the value to be formatted
David Renty committed
226 227 228 229 230 231 232
     * @return string the formatted result
     */
    public function asImage($value)
    {
        if ($value === null) {
            return $this->nullDisplay;
        }
233

David Renty committed
234 235 236 237 238
        return Html::img($value);
    }

    /**
     * Formats the value as a hyperlink.
239
     * @param  mixed  $value the value to be formatted
David Renty committed
240 241 242 243 244 245 246 247 248 249 250
     * @return string the formatted result
     */
    public function asUrl($value)
    {
        if ($value === null) {
            return $this->nullDisplay;
        }
        $url = $value;
        if (strpos($url, 'http://') !== 0 && strpos($url, 'https://') !== 0) {
            $url = 'http://' . $url;
        }
251

David Renty committed
252 253 254 255 256
        return Html::a(Html::encode($value), $url);
    }

    /**
     * Formats the value as a boolean.
257
     * @param  mixed  $value the value to be formatted
David Renty committed
258 259 260 261 262 263 264 265
     * @return string the formatted result
     * @see booleanFormat
     */
    public function asBoolean($value)
    {
        if ($value === null) {
            return $this->nullDisplay;
        }
266

David Renty committed
267 268 269 270 271 272
        return $value ? $this->booleanFormat[1] : $this->booleanFormat[0];
    }

    /**
     * Formats the value as a date.
     * @param integer|string|DateTime $value the value to be formatted. The following
273
     *                                       types of value are supported:
David Renty committed
274 275 276 277 278
     *
     * - an integer representing a UNIX timestamp
     * - a string that can be parsed into a UNIX timestamp via `strtotime()`
     * - a PHP DateTime object
     *
279 280 281
     * @param  string $format the format used to convert the value into a date string.
     *                        If null, [[dateFormat]] will be used. The format string should be one
     *                        that can be recognized by the PHP `date()` function.
David Renty committed
282 283 284 285 286 287 288 289 290
     * @return string the formatted result
     * @see dateFormat
     */
    public function asDate($value, $format = null)
    {
        if ($value === null) {
            return $this->nullDisplay;
        }
        $value = $this->normalizeDatetimeValue($value);
291

David Renty committed
292 293 294 295 296 297
        return $this->formatTimestamp($value, $format === null ? $this->dateFormat : $format);
    }

    /**
     * Formats the value as a time.
     * @param integer|string|DateTime $value the value to be formatted. The following
298
     *                                       types of value are supported:
David Renty committed
299 300 301 302 303
     *
     * - an integer representing a UNIX timestamp
     * - a string that can be parsed into a UNIX timestamp via `strtotime()`
     * - a PHP DateTime object
     *
304 305 306
     * @param  string $format the format used to convert the value into a date string.
     *                        If null, [[timeFormat]] will be used. The format string should be one
     *                        that can be recognized by the PHP `date()` function.
David Renty committed
307 308 309 310 311 312 313 314 315
     * @return string the formatted result
     * @see timeFormat
     */
    public function asTime($value, $format = null)
    {
        if ($value === null) {
            return $this->nullDisplay;
        }
        $value = $this->normalizeDatetimeValue($value);
316

David Renty committed
317 318 319 320 321 322
        return $this->formatTimestamp($value, $format === null ? $this->timeFormat : $format);
    }

    /**
     * Formats the value as a datetime.
     * @param integer|string|DateTime $value the value to be formatted. The following
323
     *                                       types of value are supported:
David Renty committed
324 325 326 327 328
     *
     * - an integer representing a UNIX timestamp
     * - a string that can be parsed into a UNIX timestamp via `strtotime()`
     * - a PHP DateTime object
     *
329 330 331
     * @param  string $format the format used to convert the value into a date string.
     *                        If null, [[datetimeFormat]] will be used. The format string should be one
     *                        that can be recognized by the PHP `date()` function.
David Renty committed
332 333 334 335 336 337 338 339 340
     * @return string the formatted result
     * @see datetimeFormat
     */
    public function asDatetime($value, $format = null)
    {
        if ($value === null) {
            return $this->nullDisplay;
        }
        $value = $this->normalizeDatetimeValue($value);
341

David Renty committed
342 343 344 345 346
        return $this->formatTimestamp($value, $format === null ? $this->datetimeFormat : $format);
    }

    /**
     * Normalizes the given datetime value as one that can be taken by various date/time formatting methods.
347
     * @param  mixed   $value the datetime value to be normalized.
David Renty committed
348 349 350 351 352
     * @return integer the normalized datetime value
     */
    protected function normalizeDatetimeValue($value)
    {
        if (is_string($value)) {
353 354
            return is_numeric($value) || $value === '' ? (int) $value : strtotime($value);
        } elseif ($value instanceof DateTime || $value instanceof \DateTimeInterface) {
David Renty committed
355 356
            return $value->getTimestamp();
        } else {
357
            return (int) $value;
David Renty committed
358 359 360 361
        }
    }

    /**
362 363 364
     * @param  integer $value  normalized datetime value
     * @param  string  $format the format used to convert the value into a date string.
     * @return string  the formatted result
David Renty committed
365 366 367 368 369
     */
    protected function formatTimestamp($value, $format)
    {
        $date = new DateTime(null, new \DateTimeZone($this->timeZone));
        $date->setTimestamp($value);
370

David Renty committed
371 372 373 374 375
        return $date->format($format);
    }

    /**
     * Formats the value as an integer.
376
     * @param  mixed  $value the value to be formatted
David Renty committed
377 378 379 380 381 382 383 384 385 386
     * @return string the formatting result.
     */
    public function asInteger($value)
    {
        if ($value === null) {
            return $this->nullDisplay;
        }
        if (is_string($value) && preg_match('/^(-?\d+)/', $value, $matches)) {
            return $matches[1];
        } else {
387 388
            $value = (int) $value;

David Renty committed
389 390 391 392 393 394 395
            return "$value";
        }
    }

    /**
     * Formats the value as a double number.
     * Property [[decimalSeparator]] will be used to represent the decimal point.
396 397 398
     * @param  mixed   $value    the value to be formatted
     * @param  integer $decimals the number of digits after the decimal point
     * @return string  the formatting result.
David Renty committed
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
     * @see decimalSeparator
     */
    public function asDouble($value, $decimals = 2)
    {
        if ($value === null) {
            return $this->nullDisplay;
        }
        if ($this->decimalSeparator === null) {
            return sprintf("%.{$decimals}f", $value);
        } else {
            return str_replace('.', $this->decimalSeparator, sprintf("%.{$decimals}f", $value));
        }
    }

    /**
     * Formats the value as a number with decimal and thousand separators.
     * This method calls the PHP number_format() function to do the formatting.
416 417 418
     * @param  mixed   $value    the value to be formatted
     * @param  integer $decimals the number of digits after the decimal point
     * @return string  the formatted result
David Renty committed
419 420 421 422 423 424 425 426 427 428
     * @see decimalSeparator
     * @see thousandSeparator
     */
    public function asNumber($value, $decimals = 0)
    {
        if ($value === null) {
            return $this->nullDisplay;
        }
        $ds = isset($this->decimalSeparator) ? $this->decimalSeparator: '.';
        $ts = isset($this->thousandSeparator) ? $this->thousandSeparator: ',';
429

David Renty committed
430 431 432 433 434
        return number_format($value, $decimals, $ds, $ts);
    }

    /**
     * Formats the value in bytes as a size in human readable form.
435 436 437 438
     * @param  integer $value   value in bytes to be formatted
     * @param  boolean $verbose if full names should be used (e.g. bytes, kilobytes, ...).
     *                          Defaults to false meaning that short names will be used (e.g. B, KB, ...).
     * @return string  the formatted result
David Renty committed
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
     * @see sizeFormat
     */
    public function asSize($value, $verbose = false)
    {
        $position = 0;

        do {
            if ($value < $this->sizeFormat['base']) {
                break;
            }

            $value = $value / $this->sizeFormat['base'];
            $position++;
        } while ($position < 6);

        $value = round($value, $this->sizeFormat['decimals']);
        $formattedValue = isset($this->sizeFormat['decimalSeparator']) ? str_replace('.', $this->sizeFormat['decimalSeparator'], $value) : $value;
        $params = ['n' => $formattedValue];
457 458

        switch ($position) {
David Renty committed
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
            case 0:
                return $verbose ? Yii::t('yii', '{n, plural, =1{# byte} other{# bytes}}', $params) : Yii::t('yii', '{n} B', $params);
            case 1:
                return $verbose ? Yii::t('yii', '{n, plural, =1{# kilobyte} other{# kilobytes}}', $params) : Yii::t('yii', '{n} KB', $params);
            case 2:
                return $verbose ? Yii::t('yii', '{n, plural, =1{# megabyte} other{# megabytes}}', $params) : Yii::t('yii', '{n} MB', $params);
            case 3:
                return $verbose ? Yii::t('yii', '{n, plural, =1{# gigabyte} other{# gigabytes}}', $params) : Yii::t('yii', '{n} GB', $params);
            case 4:
                return $verbose ? Yii::t('yii', '{n, plural, =1{# terabyte} other{# terabytes}}', $params) : Yii::t('yii', '{n} TB', $params);
            default:
                return $verbose ? Yii::t('yii', '{n, plural, =1{# petabyte} other{# petabytes}}', $params) : Yii::t('yii', '{n} PB', $params);
        }
    }

    /**
     * Formats the value as the time interval between a date and now in human readable form.
     * @param integer|string|DateTime|DateInterval $value the value to be formatted. The following
     * types of value are supported:
     *
     * - an integer representing a UNIX timestamp
     * - a string that can be parsed into a UNIX timestamp via `strtotime()` or that can be passed to a DateInterval constructor.
     * - a PHP DateTime object
David Renty committed
482
     * - a PHP DateInterval object (a positive time interval will refer to the past, a negative one to the future)
David Renty committed
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
     *
     * @return string the formatted result
     */
    public function asRelativeTime($value, $referenceTime = null)
    {
        if ($value === null) {
            return $this->nullDisplay;
        }

        if ($value instanceof \DateInterval) {
            $interval = $value;
        } else {
            $timestamp = $this->normalizeDatetimeValue($value);

            if ($timestamp === false) {
                // $value is not a valid date/time value, so we try
                // to create a DateInterval with it
                try {
                    $interval = new \DateInterval($value);
                } catch (Exception $e) {
                    // invalid date/time and invalid interval
                    return $this->nullDisplay;
                }
            } else {
                $timezone = new \DateTimeZone($this->timeZone);
                
                if ($referenceTime === null) {
                    $dateNow = new DateTime('now', $timezone);
                } else {
                    $referenceTime = $this->normalizeDatetimeValue($referenceTime);
                    $dateNow = new DateTime(null, $timezone);
                    $dateNow->setTimestamp($referenceTime);
                }

                $dateThen = new DateTime(null, $timezone);
                $dateThen->setTimestamp($timestamp);

                $interval = $dateThen->diff($dateNow);
            }
        }

        if ($interval->invert) {
            if ($interval->y >= 1) {
                return Yii::t('yii', 'in {delta, plural, =1{a year} other{# years}}', ['delta' => $interval->y]);
            }
            if ($interval->m >= 1) {
                return Yii::t('yii', 'in {delta, plural, =1{a month} other{# months}}', ['delta' => $interval->m]);
            }
            if ($interval->d >= 1) {
                return Yii::t('yii', 'in {delta, plural, =1{a day} other{# days}}', ['delta' => $interval->d]);
            }
            if ($interval->h >= 1) {
                return Yii::t('yii', 'in {delta, plural, =1{an hour} other{# hours}}', ['delta' => $interval->h]);
            }
            if ($interval->i >= 1) {
                return Yii::t('yii', 'in {delta, plural, =1{a minute} other{# minutes}}', ['delta' => $interval->i]);
            }

            return Yii::t('yii', 'in {delta, plural, =1{a second} other{# seconds}}', ['delta' => $interval->s]);
        } else {
            if ($interval->y >= 1) {
                return Yii::t('yii', '{delta, plural, =1{a year} other{# years}} ago', ['delta' => $interval->y]);
            }
            if ($interval->m >= 1) {
                return Yii::t('yii', '{delta, plural, =1{a month} other{# months}} ago', ['delta' => $interval->m]);
            }
            if ($interval->d >= 1) {
                return Yii::t('yii', '{delta, plural, =1{a day} other{# days}} ago', ['delta' => $interval->d]);
            }
            if ($interval->h >= 1) {
                return Yii::t('yii', '{delta, plural, =1{an hour} other{# hours}} ago', ['delta' => $interval->h]);
            }
            if ($interval->i >= 1) {
                return Yii::t('yii', '{delta, plural, =1{a minute} other{# minutes}} ago', ['delta' => $interval->i]);
            }

            return Yii::t('yii', '{delta, plural, =1{a second} other{# seconds}} ago', ['delta' => $interval->s]);
        }
    }
Qiang Xue committed
562
}