Formatter.php 12.5 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
{
30
	/**
31
	 * @var string the timezone to use for formatting time and date values.
32 33 34
	 * 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.
35
	 * If this property is not set, [[\yii\base\Application::timezone]] will be used.
36 37
	 */
	public $timeZone;
Qiang Xue committed
38 39 40 41 42 43 44 45 46 47 48 49
	/**
	 * @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';
50
	/**
51
	 * @var string the text to be displayed when formatting a null. Defaults to '<span class="not-set">(not set)</span>'.
52 53
	 */
	public $nullDisplay;
Qiang Xue committed
54 55
	/**
	 * @var array the text to be displayed when formatting a boolean value. The first element corresponds
Alexander Makarov committed
56
	 * to the text display for false, the second element for true. Defaults to `['No', 'Yes']`.
Qiang Xue committed
57 58
	 */
	public $booleanFormat;
59 60
	/**
	 * @var string the character displayed as the decimal point when formatting a number.
61
	 * If not set, "." will be used.
62
	 */
63
	public $decimalSeparator;
64 65
	/**
	 * @var string the character displayed as the thousands separator character when formatting a number.
66
	 * If not set, "," will be used.
67
	 */
68
	public $thousandSeparator;
Qiang Xue committed
69 70 71 72 73 74

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

Qiang Xue committed
79
		if (empty($this->booleanFormat)) {
Alexander Makarov committed
80
			$this->booleanFormat = [Yii::t('yii', 'No'), Yii::t('yii', 'Yes')];
Qiang Xue committed
81
		}
82
		if ($this->nullDisplay === null) {
83
			$this->nullDisplay = '<span class="not-set">' . Yii::t('yii', '(not set)') . '</span>';
84
		}
Qiang Xue committed
85 86
	}

Qiang Xue committed
87
	/**
88
	 * Formats the value based on the given format type.
Qiang Xue committed
89
	 * This method will call one of the "as" methods available in this class to do the formatting.
90 91
	 * 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.
Qiang Xue committed
92
	 * @param mixed $value the value to be formatted
93 94 95
	 * @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
Alexander Makarov committed
96
	 * method. For example, a format of `['date', 'Y-m-d']` will cause the invocation of `asDate($value, 'Y-m-d')`.
Qiang Xue committed
97 98 99
	 * @return string the formatting result
	 * @throws InvalidParamException if the type is not supported by this class.
	 */
100
	public function format($value, $format)
Qiang Xue committed
101
	{
102 103 104 105 106 107 108 109 110
		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 {
Alexander Makarov committed
111
			$params = [$value];
112 113
		}
		$method = 'as' . $format;
Qiang Xue committed
114
		if (method_exists($this, $method)) {
Alexander Makarov committed
115
			return call_user_func_array([$this, $method], $params);
Qiang Xue committed
116
		} else {
117
			throw new InvalidParamException("Unknown type: $format");
Qiang Xue committed
118 119 120
		}
	}

Qiang Xue committed
121 122 123 124 125 126 127 128
	/**
	 * Formats the value as is without any formatting.
	 * This method simply returns back the parameter without any format.
	 * @param mixed $value the value to be formatted
	 * @return string the formatted result
	 */
	public function asRaw($value)
	{
129 130 131
		if ($value === null) {
			return $this->nullDisplay;
		}
Qiang Xue committed
132 133 134 135 136 137 138 139 140 141
		return $value;
	}

	/**
	 * Formats the value as an HTML-encoded plain text.
	 * @param mixed $value the value to be formatted
	 * @return string the formatted result
	 */
	public function asText($value)
	{
142 143 144
		if ($value === null) {
			return $this->nullDisplay;
		}
Qiang Xue committed
145 146 147 148 149 150 151 152 153 154
		return Html::encode($value);
	}

	/**
	 * Formats the value as an HTML-encoded plain text with newlines converted into breaks.
	 * @param mixed $value the value to be formatted
	 * @return string the formatted result
	 */
	public function asNtext($value)
	{
155 156 157
		if ($value === null) {
			return $this->nullDisplay;
		}
Qiang Xue committed
158 159 160 161 162 163 164 165 166 167 168 169
		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.
	 * @param mixed $value the value to be formatted
	 * @return string the formatted result
	 */
	public function asParagraphs($value)
	{
170 171 172
		if ($value === null) {
			return $this->nullDisplay;
		}
Qiang Xue committed
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
		return str_replace('<p></p>', '',
			'<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.
	 * @param mixed $value the value to be formatted
	 * @param array|null $config the configuration for the HTMLPurifier class.
	 * @return string the formatted result
	 */
	public function asHtml($value, $config = null)
	{
188 189 190
		if ($value === null) {
			return $this->nullDisplay;
		}
Qiang Xue committed
191 192 193 194 195 196 197 198 199 200
		return HtmlPurifier::process($value, $config);
	}

	/**
	 * Formats the value as a mailto link.
	 * @param mixed $value the value to be formatted
	 * @return string the formatted result
	 */
	public function asEmail($value)
	{
201 202 203
		if ($value === null) {
			return $this->nullDisplay;
		}
204
		return Html::mailto(Html::encode($value), $value);
Qiang Xue committed
205 206 207 208 209 210 211 212 213
	}

	/**
	 * Formats the value as an image tag.
	 * @param mixed $value the value to be formatted
	 * @return string the formatted result
	 */
	public function asImage($value)
	{
214 215 216
		if ($value === null) {
			return $this->nullDisplay;
		}
Qiang Xue committed
217 218 219 220 221 222 223 224 225 226
		return Html::img($value);
	}

	/**
	 * Formats the value as a hyperlink.
	 * @param mixed $value the value to be formatted
	 * @return string the formatted result
	 */
	public function asUrl($value)
	{
227 228 229
		if ($value === null) {
			return $this->nullDisplay;
		}
Qiang Xue committed
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
		$url = $value;
		if (strpos($url, 'http://') !== 0 && strpos($url, 'https://') !== 0) {
			$url = 'http://' . $url;
		}
		return Html::a(Html::encode($value), $url);
	}

	/**
	 * Formats the value as a boolean.
	 * @param mixed $value the value to be formatted
	 * @return string the formatted result
	 * @see booleanFormat
	 */
	public function asBoolean($value)
	{
245 246 247
		if ($value === null) {
			return $this->nullDisplay;
		}
Qiang Xue committed
248 249 250 251 252 253 254 255
		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
	 * types of value are supported:
	 *
256
	 * - an integer representing a UNIX timestamp
Qiang Xue committed
257 258 259 260
	 * - a string that can be parsed into a UNIX timestamp via `strtotime()`
	 * - a PHP DateTime object
	 *
	 * @param string $format the format used to convert the value into a date string.
261
	 * If null, [[dateFormat]] will be used. The format string should be one
Qiang Xue committed
262 263 264 265 266 267
	 * that can be recognized by the PHP `date()` function.
	 * @return string the formatted result
	 * @see dateFormat
	 */
	public function asDate($value, $format = null)
	{
268 269 270
		if ($value === null) {
			return $this->nullDisplay;
		}
Qiang Xue committed
271
		$value = $this->normalizeDatetimeValue($value);
Vladimir Zbrailov committed
272
		return $this->formatTimestamp($value, $format === null ? $this->dateFormat : $format, $value);
Qiang Xue committed
273 274 275 276 277 278 279
	}

	/**
	 * Formats the value as a time.
	 * @param integer|string|DateTime $value the value to be formatted. The following
	 * types of value are supported:
	 *
280
	 * - an integer representing a UNIX timestamp
Qiang Xue committed
281 282 283 284
	 * - a string that can be parsed into a UNIX timestamp via `strtotime()`
	 * - a PHP DateTime object
	 *
	 * @param string $format the format used to convert the value into a date string.
285
	 * If null, [[timeFormat]] will be used. The format string should be one
Qiang Xue committed
286 287 288 289 290 291
	 * that can be recognized by the PHP `date()` function.
	 * @return string the formatted result
	 * @see timeFormat
	 */
	public function asTime($value, $format = null)
	{
292 293 294
		if ($value === null) {
			return $this->nullDisplay;
		}
Qiang Xue committed
295
		$value = $this->normalizeDatetimeValue($value);
Vladimir Zbrailov committed
296
		return $this->formatTimestamp($value, $format === null ? $this->timeFormat : $format, $value);
Qiang Xue committed
297 298 299 300 301 302 303
	}

	/**
	 * Formats the value as a datetime.
	 * @param integer|string|DateTime $value the value to be formatted. The following
	 * types of value are supported:
	 *
304
	 * - an integer representing a UNIX timestamp
Qiang Xue committed
305 306 307 308
	 * - a string that can be parsed into a UNIX timestamp via `strtotime()`
	 * - a PHP DateTime object
	 *
	 * @param string $format the format used to convert the value into a date string.
309
	 * If null, [[datetimeFormat]] will be used. The format string should be one
Qiang Xue committed
310 311 312 313 314 315
	 * that can be recognized by the PHP `date()` function.
	 * @return string the formatted result
	 * @see datetimeFormat
	 */
	public function asDatetime($value, $format = null)
	{
316 317 318
		if ($value === null) {
			return $this->nullDisplay;
		}
Qiang Xue committed
319
		$value = $this->normalizeDatetimeValue($value);
Vladimir Zbrailov committed
320
		return $this->formatTimestamp($value, $format === null ? $this->datetimeFormat : $format, $value);
Qiang Xue committed
321 322 323 324 325
	}

	/**
	 * Normalizes the given datetime value as one that can be taken by various date/time formatting methods.
	 * @param mixed $value the datetime value to be normalized.
326
	 * @return integer the normalized datetime value
Qiang Xue committed
327 328 329 330
	 */
	protected function normalizeDatetimeValue($value)
	{
		if (is_string($value)) {
Qiang Xue committed
331
			return is_numeric($value) || $value === '' ? (int)$value : strtotime($value);
Qiang Xue committed
332 333 334 335 336 337 338
		} elseif ($value instanceof DateTime) {
			return $value->getTimestamp();
		} else {
			return (int)$value;
		}
	}

339 340 341 342 343
	/**
	 * @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
	 */
Vladimir Zbrailov committed
344
	protected function formatTimestamp($value, $format)
345
	{
346
		$date = new DateTime(null, new \DateTimeZone($this->timeZone));
347
		$date->setTimestamp($value);
Vladimir Zbrailov committed
348
		return $date->format($format);
349 350
	}

Qiang Xue committed
351 352 353 354 355 356 357
	/**
	 * Formats the value as an integer.
	 * @param mixed $value the value to be formatted
	 * @return string the formatting result.
	 */
	public function asInteger($value)
	{
358 359 360
		if ($value === null) {
			return $this->nullDisplay;
		}
Qiang Xue committed
361 362 363 364 365 366 367 368 369 370
		if (is_string($value) && preg_match('/^(-?\d+)/', $value, $matches)) {
			return $matches[1];
		} else {
			$value = (int)$value;
			return "$value";
		}
	}

	/**
	 * Formats the value as a double number.
371
	 * Property [[decimalSeparator]] will be used to represent the decimal point.
Qiang Xue committed
372 373 374
	 * @param mixed $value the value to be formatted
	 * @param integer $decimals the number of digits after the decimal point
	 * @return string the formatting result.
375
	 * @see decimalSeparator
Qiang Xue committed
376 377 378
	 */
	public function asDouble($value, $decimals = 2)
	{
379 380 381
		if ($value === null) {
			return $this->nullDisplay;
		}
382 383 384 385 386
		if ($this->decimalSeparator === null) {
			return sprintf("%.{$decimals}f", $value);
		} else {
			return str_replace('.', $this->decimalSeparator, sprintf("%.{$decimals}f", $value));
		}
Qiang Xue committed
387 388 389
	}

	/**
Qiang Xue committed
390 391
	 * Formats the value as a number with decimal and thousand separators.
	 * This method calls the PHP number_format() function to do the formatting.
Qiang Xue committed
392 393 394
	 * @param mixed $value the value to be formatted
	 * @param integer $decimals the number of digits after the decimal point
	 * @return string the formatted result
395 396
	 * @see decimalSeparator
	 * @see thousandSeparator
Qiang Xue committed
397
	 */
398
	public function asNumber($value, $decimals = 0)
Qiang Xue committed
399
	{
400 401 402
		if ($value === null) {
			return $this->nullDisplay;
		}
403 404 405
		$ds = isset($this->decimalSeparator) ? $this->decimalSeparator: '.';
		$ts = isset($this->thousandSeparator) ? $this->thousandSeparator: ',';
		return number_format($value, $decimals, $ds, $ts);
Qiang Xue committed
406 407
	}
}