Formatter.php 11.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 23 24
 * Formatter is configured as an application component in [[yii\base\Application]] by default.
 * You can access that instance via `Yii::$app->formatter`.
 *
Qiang Xue committed
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class Formatter extends Component
{
	/**
	 * @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';
42
	/**
43
	 * @var string the text to be displayed when formatting a null. Defaults to '<span class="not-set">(not set)</span>'.
44 45
	 */
	public $nullDisplay;
Qiang Xue committed
46 47
	/**
	 * @var array the text to be displayed when formatting a boolean value. The first element corresponds
Alexander Makarov committed
48
	 * to the text display for false, the second element for true. Defaults to `['No', 'Yes']`.
Qiang Xue committed
49 50
	 */
	public $booleanFormat;
51 52
	/**
	 * @var string the character displayed as the decimal point when formatting a number.
53
	 * If not set, "." will be used.
54
	 */
55
	public $decimalSeparator;
56 57
	/**
	 * @var string the character displayed as the thousands separator character when formatting a number.
58
	 * If not set, "," will be used.
59
	 */
60
	public $thousandSeparator;
Qiang Xue committed
61 62 63 64 65 66 67 68


	/**
	 * Initializes the component.
	 */
	public function init()
	{
		if (empty($this->booleanFormat)) {
Alexander Makarov committed
69
			$this->booleanFormat = [Yii::t('yii', 'No'), Yii::t('yii', 'Yes')];
Qiang Xue committed
70
		}
71
		if ($this->nullDisplay === null) {
72
			$this->nullDisplay = '<span class="not-set">' . Yii::t('yii', '(not set)') . '</span>';
73
		}
Qiang Xue committed
74 75
	}

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

Qiang Xue committed
110 111 112 113 114 115 116 117
	/**
	 * 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)
	{
118 119 120
		if ($value === null) {
			return $this->nullDisplay;
		}
Qiang Xue committed
121 122 123 124 125 126 127 128 129 130
		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)
	{
131 132 133
		if ($value === null) {
			return $this->nullDisplay;
		}
Qiang Xue committed
134 135 136 137 138 139 140 141 142 143
		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)
	{
144 145 146
		if ($value === null) {
			return $this->nullDisplay;
		}
Qiang Xue committed
147 148 149 150 151 152 153 154 155 156 157 158
		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)
	{
159 160 161
		if ($value === null) {
			return $this->nullDisplay;
		}
Qiang Xue committed
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
		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)
	{
177 178 179
		if ($value === null) {
			return $this->nullDisplay;
		}
Qiang Xue committed
180 181 182 183 184 185 186 187 188 189
		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)
	{
190 191 192
		if ($value === null) {
			return $this->nullDisplay;
		}
193
		return Html::mailto(Html::encode($value), $value);
Qiang Xue committed
194 195 196 197 198 199 200 201 202
	}

	/**
	 * Formats the value as an image tag.
	 * @param mixed $value the value to be formatted
	 * @return string the formatted result
	 */
	public function asImage($value)
	{
203 204 205
		if ($value === null) {
			return $this->nullDisplay;
		}
Qiang Xue committed
206 207 208 209 210 211 212 213 214 215
		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)
	{
216 217 218
		if ($value === null) {
			return $this->nullDisplay;
		}
Qiang Xue committed
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
		$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)
	{
234 235 236
		if ($value === null) {
			return $this->nullDisplay;
		}
Qiang Xue committed
237 238 239 240 241 242 243 244
		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:
	 *
245
	 * - an integer representing a UNIX timestamp
Qiang Xue committed
246 247 248 249
	 * - 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.
250
	 * If null, [[dateFormat]] will be used. The format string should be one
Qiang Xue committed
251 252 253 254 255 256
	 * that can be recognized by the PHP `date()` function.
	 * @return string the formatted result
	 * @see dateFormat
	 */
	public function asDate($value, $format = null)
	{
257 258 259
		if ($value === null) {
			return $this->nullDisplay;
		}
Qiang Xue committed
260 261 262 263 264 265 266 267 268
		$value = $this->normalizeDatetimeValue($value);
		return date($format === null ? $this->dateFormat : $format, $value);
	}

	/**
	 * Formats the value as a time.
	 * @param integer|string|DateTime $value the value to be formatted. The following
	 * types of value are supported:
	 *
269
	 * - an integer representing a UNIX timestamp
Qiang Xue committed
270 271 272 273
	 * - 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.
274
	 * If null, [[timeFormat]] will be used. The format string should be one
Qiang Xue committed
275 276 277 278 279 280
	 * that can be recognized by the PHP `date()` function.
	 * @return string the formatted result
	 * @see timeFormat
	 */
	public function asTime($value, $format = null)
	{
281 282 283
		if ($value === null) {
			return $this->nullDisplay;
		}
Qiang Xue committed
284 285 286 287 288 289 290 291 292
		$value = $this->normalizeDatetimeValue($value);
		return date($format === null ? $this->timeFormat : $format, $value);
	}

	/**
	 * Formats the value as a datetime.
	 * @param integer|string|DateTime $value the value to be formatted. The following
	 * types of value are supported:
	 *
293
	 * - an integer representing a UNIX timestamp
Qiang Xue committed
294 295 296 297
	 * - 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.
298
	 * If null, [[datetimeFormat]] will be used. The format string should be one
Qiang Xue committed
299 300 301 302 303 304
	 * that can be recognized by the PHP `date()` function.
	 * @return string the formatted result
	 * @see datetimeFormat
	 */
	public function asDatetime($value, $format = null)
	{
305 306 307
		if ($value === null) {
			return $this->nullDisplay;
		}
Qiang Xue committed
308 309 310 311 312 313 314
		$value = $this->normalizeDatetimeValue($value);
		return date($format === null ? $this->datetimeFormat : $format, $value);
	}

	/**
	 * 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.
315
	 * @return integer the normalized datetime value
Qiang Xue committed
316 317 318 319
	 */
	protected function normalizeDatetimeValue($value)
	{
		if (is_string($value)) {
Qiang Xue committed
320
			return is_numeric($value) || $value === '' ? (int)$value : strtotime($value);
Qiang Xue committed
321 322 323 324 325 326 327 328 329 330 331 332 333 334
		} elseif ($value instanceof DateTime) {
			return $value->getTimestamp();
		} else {
			return (int)$value;
		}
	}

	/**
	 * Formats the value as an integer.
	 * @param mixed $value the value to be formatted
	 * @return string the formatting result.
	 */
	public function asInteger($value)
	{
335 336 337
		if ($value === null) {
			return $this->nullDisplay;
		}
Qiang Xue committed
338 339 340 341 342 343 344 345 346 347
		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.
348
	 * Property [[decimalSeparator]] will be used to represent the decimal point.
Qiang Xue committed
349 350 351
	 * @param mixed $value the value to be formatted
	 * @param integer $decimals the number of digits after the decimal point
	 * @return string the formatting result.
352
	 * @see decimalSeparator
Qiang Xue committed
353 354 355
	 */
	public function asDouble($value, $decimals = 2)
	{
356 357 358
		if ($value === null) {
			return $this->nullDisplay;
		}
359 360 361 362 363
		if ($this->decimalSeparator === null) {
			return sprintf("%.{$decimals}f", $value);
		} else {
			return str_replace('.', $this->decimalSeparator, sprintf("%.{$decimals}f", $value));
		}
Qiang Xue committed
364 365 366
	}

	/**
Qiang Xue committed
367 368
	 * 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
369 370 371
	 * @param mixed $value the value to be formatted
	 * @param integer $decimals the number of digits after the decimal point
	 * @return string the formatted result
372 373
	 * @see decimalSeparator
	 * @see thousandSeparator
Qiang Xue committed
374
	 */
375
	public function asNumber($value, $decimals = 0)
Qiang Xue committed
376
	{
377 378 379
		if ($value === null) {
			return $this->nullDisplay;
		}
380 381 382
		$ds = isset($this->decimalSeparator) ? $this->decimalSeparator: '.';
		$ts = isset($this->thousandSeparator) ? $this->thousandSeparator: ',';
		return number_format($value, $decimals, $ds, $ts);
Qiang Xue committed
383 384
	}
}