YiiBase.php 20.7 KB
Newer Older
Qiang Xue committed
1
<?php
w  
Qiang Xue committed
2 3
/**
 * @link http://www.yiiframework.com/
Qiang Xue committed
4
 * @copyright Copyright (c) 2008 Yii Software LLC
w  
Qiang Xue committed
5 6
 * @license http://www.yiiframework.com/license/
 */
7 8
namespace yii;

Qiang Xue committed
9
use yii\base\Exception;
Qiang Xue committed
10
use yii\base\InvalidConfigException;
Qiang Xue committed
11
use yii\base\InvalidParamException;
Qiang Xue committed
12
use yii\log\Logger;
Qiang Xue committed
13

Qiang Xue committed
14
/**
w  
Qiang Xue committed
15
 * Gets the application start timestamp.
Qiang Xue committed
16
 */
w  
Qiang Xue committed
17
defined('YII_BEGIN_TIME') or define('YII_BEGIN_TIME', microtime(true));
18 19 20 21
/**
 * This constant defines the framework installation directory.
 */
defined('YII_PATH') or define('YII_PATH', __DIR__);
Qiang Xue committed
22 23 24
/**
 * This constant defines whether the application should be in debug mode or not. Defaults to false.
 */
w  
Qiang Xue committed
25
defined('YII_DEBUG') or define('YII_DEBUG', false);
26 27 28 29 30
/**
 * This constant defines in which environment the application is running. Defaults to 'prod', meaning production environment.
 * You may define this constant in the bootstrap script. The value could be 'prod' (production), 'dev' (development), 'test', 'staging', etc.
 */
defined('YII_ENV') or define('YII_ENV', 'prod');
Qiang Xue committed
31
/**
32
 * Whether the the application is running in production environment
Qiang Xue committed
33
 */
34 35 36 37 38 39 40 41 42 43
defined('YII_ENV_PROD') or define('YII_ENV_PROD', YII_ENV === 'prod');
/**
 * Whether the the application is running in development environment
 */
defined('YII_ENV_DEV') or define('YII_ENV_DEV', YII_ENV === 'dev');
/**
 * Whether the the application is running in testing environment
 */
defined('YII_ENV_TEST') or define('YII_ENV_TEST', YII_ENV === 'test');

Qiang Xue committed
44 45 46 47 48
/**
 * This constant defines whether error handling should be enabled. Defaults to true.
 */
defined('YII_ENABLE_ERROR_HANDLER') or define('YII_ENABLE_ERROR_HANDLER', true);

w  
Qiang Xue committed
49

Qiang Xue committed
50
/**
w  
Qiang Xue committed
51
 * YiiBase is the core helper class for the Yii framework.
Qiang Xue committed
52
 *
w  
Qiang Xue committed
53
 * Do not use YiiBase directly. Instead, use its child class [[Yii]] where
Qiang Xue committed
54 55 56
 * you can customize methods of YiiBase.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
w  
Qiang Xue committed
57
 * @since 2.0
Qiang Xue committed
58 59 60 61 62
 */
class YiiBase
{
	/**
	 * @var array class map used by the Yii autoloading mechanism.
63
	 * The array keys are the class names (without leading backslashes), and the array values
Qiang Xue committed
64 65
	 * are the corresponding class file paths (or path aliases). This property mainly affects
	 * how [[autoload()]] works.
Qiang Xue committed
66 67
	 * @see import
	 * @see autoload
w  
Qiang Xue committed
68 69 70
	 */
	public static $classMap = array();
	/**
71
	 * @var \yii\console\Application|\yii\web\Application the application instance
Qiang Xue committed
72
	 */
Qiang Xue committed
73
	public static $app;
w  
Qiang Xue committed
74 75
	/**
	 * @var array registered path aliases
Qiang Xue committed
76 77
	 * @see getAlias
	 * @see setAlias
w  
Qiang Xue committed
78
	 */
79
	public static $aliases = array('@yii' => __DIR__);
Qiang Xue committed
80 81
	/**
	 * @var array initial property values that will be applied to objects newly created via [[createObject]].
Qiang Xue committed
82 83
	 * The array keys are class names without leading backslashes "\", and the array values are the corresponding
	 * name-value pairs for initializing the created class instances. For example,
Qiang Xue committed
84 85 86
	 *
	 * ~~~
	 * array(
Qiang Xue committed
87
	 *     'Bar' => array(
Qiang Xue committed
88 89 90
	 *         'prop1' => 'value1',
	 *         'prop2' => 'value2',
	 *     ),
Qiang Xue committed
91
	 *     'mycompany\foo\Car' => array(
Qiang Xue committed
92 93 94 95 96 97 98 99 100
	 *         'prop1' => 'value1',
	 *         'prop2' => 'value2',
	 *     ),
	 * )
	 * ~~~
	 *
	 * @see createObject
	 */
	public static $objectConfig = array();
Qiang Xue committed
101

Qiang Xue committed
102
	private static $_imported = array(); // alias => class name or directory
Qiang Xue committed
103 104 105 106 107 108

	/**
	 * @return string the version of Yii framework
	 */
	public static function getVersion()
	{
w  
Qiang Xue committed
109
		return '2.0-dev';
Qiang Xue committed
110 111 112
	}

	/**
Qiang Xue committed
113
	 * Imports a class by its alias.
Qiang Xue committed
114
	 *
Qiang Xue committed
115 116 117
	 * This method is provided to support autoloading of non-namespaced classes.
	 * Such a class can be specified in terms of an alias. For example, the alias `@old/code/Sample`
	 * may represent the `Sample` class under the directory `@old/code` (a path alias).
Qiang Xue committed
118
	 *
Qiang Xue committed
119 120 121 122
	 * By importing a class, the class is put in an internal storage such that when
	 * the class is used for the first time, the class autoloader will be able to
	 * find the corresponding class file and include it. For this reason, this method
	 * is much lighter than `include()`.
Qiang Xue committed
123
	 *
Qiang Xue committed
124
	 * You may import the same class multiple times. Only the first importing will count.
Qiang Xue committed
125
	 *
Qiang Xue committed
126 127 128 129
	 * @param string $alias the class to be imported. This may be either a class alias or a fully-qualified class name.
	 * If the latter, it will be returned back without change.
	 * @return string the actual class name that `$alias` refers to
	 * @throws Exception if the alias is invalid
Qiang Xue committed
130
	 */
Qiang Xue committed
131
	public static function import($alias)
Qiang Xue committed
132
	{
Qiang Xue committed
133
		if (strncmp($alias, '@', 1)) {
Qiang Xue committed
134
			return $alias;
Qiang Xue committed
135 136 137 138
		} else {
			$alias = static::getAlias($alias);
			if (!isset(self::$_imported[$alias])) {
				$className = basename($alias);
w  
Qiang Xue committed
139
				self::$_imported[$alias] = $className;
Qiang Xue committed
140
				self::$classMap[$className] = $alias . '.php';
w  
Qiang Xue committed
141
			}
Qiang Xue committed
142
			return self::$_imported[$alias];
Qiang Xue committed
143 144 145
		}
	}

146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
	/**
	 * Imports a set of namespaces.
	 *
	 * By importing a namespace, the method will create an alias for the directory corresponding
	 * to the namespace. For example, if "foo\bar" is a namespace associated with the directory
	 * "path/to/foo/bar", then an alias "@foo/bar" will be created for this directory.
	 *
	 * This method is typically invoked in the bootstrap file to import the namespaces of
	 * the installed extensions. By default, Composer, when installing new extensions, will
	 * generate such a mapping file which can be loaded and passed to this method.
	 *
	 * @param array $namespaces the namespaces to be imported. The keys are the namespaces,
	 * and the values are the corresponding directories.
	 */
	public static function importNamespaces($namespaces)
	{
		foreach ($namespaces as $name => $path) {
			if ($name !== '') {
164
				$name = trim(strtr($name, array('\\' => '/', '_' => '/')), '/');
165 166 167
				if (is_array($path)) {
					$path = reset($path);
				}
168
				static::setAlias('@' . $name, rtrim($path, '/\\') . '/' . $name);
169 170 171 172
			}
		}
	}

Qiang Xue committed
173
	/**
w  
Qiang Xue committed
174
	 * Translates a path alias into an actual path.
m  
Qiang Xue committed
175
	 *
176
	 * The translation is done according to the following procedure:
m  
Qiang Xue committed
177
	 *
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
	 * 1. If the given alias does not start with '@', it is returned back without change;
	 * 2. Otherwise, look for the longest registered alias that matches the beginning part
	 *    of the given alias. If it exists, replace the matching part of the given alias with
	 *    the corresponding registered path.
	 * 3. Throw an exception or return false, depending on the `$throwException` parameter.
	 *
	 * For example, by default '@yii' is registered as the alias to the Yii framework directory,
	 * say '/path/to/yii'. The alias '@yii/web' would then be translated into '/path/to/yii/web'.
	 *
	 * If you have registered two aliases '@foo' and '@foo/bar'. Then translating '@foo/bar/config'
	 * would replace the part '@foo/bar' (instead of '@foo') with the corresponding registered path.
	 * This is because the longest alias takes precedence.
	 *
	 * However, if the alias to be translated is '@foo/barbar/config', then '@foo' will be replaced
	 * instead of '@foo/bar', because '/' serves as the boundary character.
	 *
	 * Note, this method does not check if the returned path exists or not.
w  
Qiang Xue committed
195
	 *
Qiang Xue committed
196
	 * @param string $alias the alias to be translated.
Qiang Xue committed
197 198
	 * @param boolean $throwException whether to throw an exception if the given alias is invalid.
	 * If this is false and an invalid alias is given, false will be returned by this method.
Qiang Xue committed
199
	 * @return string|boolean the path corresponding to the alias, false if the root alias is not previously registered.
Qiang Xue committed
200
	 * @throws InvalidParamException if the alias is invalid while $throwException is true.
w  
Qiang Xue committed
201
	 * @see setAlias
Qiang Xue committed
202
	 */
Qiang Xue committed
203
	public static function getAlias($alias, $throwException = true)
Qiang Xue committed
204
	{
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
		if (strncmp($alias, '@', 1)) {
			// not an alias
			return $alias;
		}

		$pos = strpos($alias, '/');
		$root = $pos === false ? $alias : substr($alias, 0, $pos);

		if (isset(self::$aliases[$root])) {
			if (is_string(self::$aliases[$root])) {
				return $pos === false ? self::$aliases[$root] : self::$aliases[$root] . substr($alias, $pos);
			} else {
				foreach (self::$aliases[$root] as $name => $path) {
					if (strpos($alias . '/', $name . '/') === 0) {
						return $path . substr($alias, strlen($name));
					}
Qiang Xue committed
221
				}
Qiang Xue committed
222 223
			}
		}
224

Qiang Xue committed
225 226 227 228 229
		if ($throwException) {
			throw new InvalidParamException("Invalid path alias: $alias");
		} else {
			return false;
		}
Qiang Xue committed
230 231
	}

Qiang Xue committed
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
	/**
	 * Returns the root alias part of a given alias.
	 * A root alias is an alias that has been registered via [[setAlias()]] previously.
	 * If a given alias matches multiple root aliases, the longest one will be returned.
	 * @param string $alias the alias
	 * @return string|boolean the root alias, or false if no root alias is found
	 */
	public static function getRootAlias($alias)
	{
		$pos = strpos($alias, '/');
		$root = $pos === false ? $alias : substr($alias, 0, $pos);

		if (isset(self::$aliases[$root])) {
			if (is_string(self::$aliases[$root])) {
				return $root;
			} else {
				foreach (self::$aliases[$root] as $name => $path) {
					if (strpos($alias . '/', $name . '/') === 0) {
						return $name;
					}
				}
			}
		}
		return false;
	}

Qiang Xue committed
258
	/**
w  
Qiang Xue committed
259
	 * Registers a path alias.
m  
Qiang Xue committed
260
	 *
261 262
	 * A path alias is a short name representing a long path (a file path, a URL, etc.)
	 * For example, we use '@yii' as the alias of the path to the Yii framework directory.
m  
Qiang Xue committed
263
	 *
264 265
	 * A path alias must start with the character '@' so that it can be easily differentiated
	 * from non-alias paths.
m  
Qiang Xue committed
266
	 *
267 268 269 270 271 272 273 274 275 276
	 * Note that this method does not check if the given path exists or not. All it does is
	 * to associate the alias with the path.
	 *
	 * Any trailing '/' and '\' characters in the given path will be trimmed.
	 *
	 * @param string $alias the alias name (e.g. "@yii"). It must start with a '@' character.
	 * It may contain the forward slash '/' which serves as boundary character when performing
	 * alias translation by [[getAlias()]].
	 * @param string $path the path corresponding to the alias. Trailing '/' and '\' characters
	 * will be trimmed. This can be
m  
Qiang Xue committed
277 278 279 280
	 *
	 * - a directory or a file path (e.g. `/tmp`, `/tmp/main.txt`)
	 * - a URL (e.g. `http://www.yiiframework.com`)
	 * - a path alias (e.g. `@yii/base`). In this case, the path alias will be converted into the
Qiang Xue committed
281
	 *   actual path first by calling [[getAlias()]].
Qiang Xue committed
282
	 *
Qiang Xue committed
283
	 * @throws InvalidParamException if $path is an invalid alias.
w  
Qiang Xue committed
284
	 * @see getAlias
Qiang Xue committed
285
	 */
w  
Qiang Xue committed
286
	public static function setAlias($alias, $path)
Qiang Xue committed
287
	{
288
		if (strncmp($alias, '@', 1)) {
Qiang Xue committed
289
			$alias = '@' . $alias;
290 291 292 293 294 295
		}
		$pos = strpos($alias, '/');
		$root = $pos === false ? $alias : substr($alias, 0, $pos);
		if ($path !== null) {
			$path = strncmp($path, '@', 1) ? rtrim($path, '\\/') : static::getAlias($path);
			if (!isset(self::$aliases[$root])) {
Qiang Xue committed
296 297 298 299 300
				if ($pos === false) {
					self::$aliases[$root] = $path;
				} else {
					self::$aliases[$root] = array($alias => $path);
				}
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
			} elseif (is_string(self::$aliases[$root])) {
				if ($pos === false) {
					self::$aliases[$root] = $path;
				} else {
					self::$aliases[$root] = array(
						$alias => $path,
						$root => self::$aliases[$root],
					);
				}
			} else {
				self::$aliases[$root][$alias] = $path;
				krsort(self::$aliases[$root]);
			}
		} elseif (isset(self::$aliases[$root])) {
			if (is_array(self::$aliases[$root])) {
				unset(self::$aliases[$root][$alias]);
			} elseif ($pos === false) {
				unset(self::$aliases[$root]);
			}
m  
Qiang Xue committed
320
		}
Qiang Xue committed
321 322 323 324
	}

	/**
	 * Class autoload loader.
Qiang Xue committed
325 326
	 * This method is invoked automatically when PHP sees an unknown class.
	 * The method will attempt to include the class file according to the following procedure:
w  
Qiang Xue committed
327 328 329 330 331 332 333 334 335
	 *
	 * 1. Search in [[classMap]];
	 * 2. If the class is namespaced (e.g. `yii\base\Component`), it will attempt
	 *    to include the file associated with the corresponding path alias
	 *    (e.g. `@yii/base/Component.php`);
	 * 3. If the class is named in PEAR style (e.g. `PHPUnit_Framework_TestCase`),
	 *    it will attempt to include the file associated with the corresponding path alias
	 *    (e.g. `@PHPUnit/Framework/TestCase.php`);
	 *
336
	 * @param string $className the fully qualified class name without a leading backslash "\"
Qiang Xue committed
337 338 339
	 */
	public static function autoload($className)
	{
Qiang Xue committed
340
		if (isset(self::$classMap[$className])) {
341 342 343
			$classFile = self::$classMap[$className];
			if ($classFile[0] === '@') {
				$classFile = static::getAlias($classFile);
Qiang Xue committed
344
			}
345
			include($classFile);
Qiang Xue committed
346
		} else {
Qiang Xue committed
347
			// follow PSR-0 to determine the class file
Qiang Xue committed
348 349
			if (($pos = strrpos($className, '\\')) !== false) {
				// namespaced class, e.g. yii\base\Component
Qiang Xue committed
350
				$path = str_replace('\\', '/', substr($className, 0, $pos + 1))
Qiang Xue committed
351 352
					. str_replace('_', '/', substr($className, $pos + 1)) . '.php';
			} else {
Qiang Xue committed
353
				$path = str_replace('_', '/', $className) . '.php';
w  
Qiang Xue committed
354
			}
Qiang Xue committed
355

356
			// try loading via path alias
Qiang Xue committed
357
			if (strpos($path, '/') !== false) {
358 359
				$classFile = static::getAlias('@' . $path, false);
				if ($classFile !== false && is_file($classFile)) {
360
					include($classFile);
Qiang Xue committed
361
				}
Qiang Xue committed
362
			}
w  
Qiang Xue committed
363
		}
Qiang Xue committed
364 365
	}

w  
Qiang Xue committed
366
	/**
Qiang Xue committed
367
	 * Creates a new object using the given configuration.
w  
Qiang Xue committed
368
	 *
Qiang Xue committed
369
	 * The configuration can be either a string or an array.
Qiang Xue committed
370 371
	 * If a string, it is treated as the *object class*; if an array,
	 * it must contain a `class` element specifying the *object class*, and
w  
Qiang Xue committed
372 373 374
	 * the rest of the name-value pairs in the array will be used to initialize
	 * the corresponding object properties.
	 *
Qiang Xue committed
375
	 * The object type can be either a class name or the [[getAlias()|alias]] of
w  
Qiang Xue committed
376
	 * the class. For example,
w  
Qiang Xue committed
377
	 *
Qiang Xue committed
378 379
	 * - `app\components\GoogleMap`: fully-qualified namespaced class.
	 * - `@app/components/GoogleMap`: an alias, used for non-namespaced class.
Qiang Xue committed
380 381 382
	 *
	 * Below are some usage examples:
	 *
w  
Qiang Xue committed
383
	 * ~~~
Qiang Xue committed
384
	 * $object = \Yii::createObject('@app/components/GoogleMap');
Qiang Xue committed
385 386
	 * $object = \Yii::createObject(array(
	 *     'class' => '\app\components\GoogleMap',
w  
Qiang Xue committed
387 388 389 390
	 *     'apiKey' => 'xyz',
	 * ));
	 * ~~~
	 *
Qiang Xue committed
391 392 393 394 395 396 397 398 399 400
	 * This method can be used to create any object as long as the object's constructor is
	 * defined like the following:
	 *
	 * ~~~
	 * public function __construct(..., $config = array()) {
	 * }
	 * ~~~
	 *
	 * The method will pass the given configuration as the last parameter of the constructor,
	 * and any additional parameters to this method will be passed as the rest of the constructor parameters.
w  
Qiang Xue committed
401
	 *
Qiang Xue committed
402 403
	 * @param string|array $config the configuration. It can be either a string representing the class name
	 * or an array representing the object configuration.
w  
Qiang Xue committed
404
	 * @return mixed the created object
Qiang Xue committed
405
	 * @throws InvalidConfigException if the configuration is invalid.
w  
Qiang Xue committed
406
	 */
Qiang Xue committed
407
	public static function createObject($config)
w  
Qiang Xue committed
408
	{
Qiang Xue committed
409 410
		static $reflections = array();

w  
Qiang Xue committed
411
		if (is_string($config)) {
w  
Qiang Xue committed
412
			$class = $config;
w  
Qiang Xue committed
413
			$config = array();
Qiang Xue committed
414
		} elseif (isset($config['class'])) {
w  
Qiang Xue committed
415
			$class = $config['class'];
w  
Qiang Xue committed
416
			unset($config['class']);
Qiang Xue committed
417
		} else {
Qiang Xue committed
418
			throw new InvalidConfigException('Object configuration must be an array containing a "class" element.');
w  
Qiang Xue committed
419 420
		}

w  
Qiang Xue committed
421
		if (!class_exists($class, false)) {
Qiang Xue committed
422
			$class = static::import($class);
w  
Qiang Xue committed
423 424
		}

Qiang Xue committed
425 426 427 428
		$class = ltrim($class, '\\');

		if (isset(self::$objectConfig[$class])) {
			$config = array_merge(self::$objectConfig[$class], $config);
429 430
		}

Qiang Xue committed
431
		if (($n = func_num_args()) > 1) {
Qiang Xue committed
432 433 434
			/** @var $reflection \ReflectionClass */
			if (isset($reflections[$class])) {
				$reflection = $reflections[$class];
Qiang Xue committed
435
			} else {
Qiang Xue committed
436 437 438 439
				$reflection = $reflections[$class] = new \ReflectionClass($class);
			}
			$args = func_get_args();
			array_shift($args); // remove $config
440
			if (!empty($config)) {
Qiang Xue committed
441
				$args[] = $config;
Qiang Xue committed
442
			}
Qiang Xue committed
443
			return $reflection->newInstanceArgs($args);
Qiang Xue committed
444
		} else {
445
			return empty($config) ? new $class : new $class($config);
Qiang Xue committed
446
		}
w  
Qiang Xue committed
447 448
	}

Qiang Xue committed
449
	/**
w  
Qiang Xue committed
450 451 452 453 454
	 * Logs a trace message.
	 * Trace messages are logged mainly for development purpose to see
	 * the execution work flow of some code.
	 * @param string $message the message to be logged.
	 * @param string $category the category of the message.
Qiang Xue committed
455
	 */
w  
Qiang Xue committed
456
	public static function trace($message, $category = 'application')
Qiang Xue committed
457
	{
w  
Qiang Xue committed
458
		if (YII_DEBUG) {
Qiang Xue committed
459
			self::$app->getLog()->log($message, Logger::LEVEL_TRACE, $category);
w  
Qiang Xue committed
460
		}
Qiang Xue committed
461 462 463
	}

	/**
w  
Qiang Xue committed
464 465 466 467 468
	 * Logs an error message.
	 * An error message is typically logged when an unrecoverable error occurs
	 * during the execution of an application.
	 * @param string $message the message to be logged.
	 * @param string $category the category of the message.
Qiang Xue committed
469
	 */
Qiang Xue committed
470
	public static function error($message, $category = 'application')
Qiang Xue committed
471
	{
Qiang Xue committed
472
		self::$app->getLog()->log($message, Logger::LEVEL_ERROR, $category);
w  
Qiang Xue committed
473 474 475 476 477 478 479 480 481
	}

	/**
	 * Logs a warning message.
	 * A warning message is typically logged when an error occurs while the execution
	 * can still continue.
	 * @param string $message the message to be logged.
	 * @param string $category the category of the message.
	 */
Qiang Xue committed
482
	public static function warning($message, $category = 'application')
w  
Qiang Xue committed
483
	{
Qiang Xue committed
484
		self::$app->getLog()->log($message, Logger::LEVEL_WARNING, $category);
Qiang Xue committed
485 486 487
	}

	/**
w  
Qiang Xue committed
488 489 490 491 492 493
	 * Logs an informative message.
	 * An informative message is typically logged by an application to keep record of
	 * something important (e.g. an administrator logs in).
	 * @param string $message the message to be logged.
	 * @param string $category the category of the message.
	 */
Qiang Xue committed
494
	public static function info($message, $category = 'application')
w  
Qiang Xue committed
495
	{
Qiang Xue committed
496
		self::$app->getLog()->log($message, Logger::LEVEL_INFO, $category);
w  
Qiang Xue committed
497 498 499 500 501 502 503 504 505
	}

	/**
	 * Marks the beginning of a code block for profiling.
	 * This has to be matched with a call to [[endProfile]] with the same category name.
	 * The begin- and end- calls must also be properly nested. For example,
	 *
	 * ~~~
	 * \Yii::beginProfile('block1');
Qiang Xue committed
506 507 508 509
	 * // some code to be profiled
	 *     \Yii::beginProfile('block2');
	 *     // some other code to be profiled
	 *     \Yii::endProfile('block2');
w  
Qiang Xue committed
510 511
	 * \Yii::endProfile('block1');
	 * ~~~
Qiang Xue committed
512 513
	 * @param string $token token for the code block
	 * @param string $category the category of this log message
Qiang Xue committed
514 515
	 * @see endProfile
	 */
Qiang Xue committed
516
	public static function beginProfile($token, $category = 'application')
Qiang Xue committed
517
	{
Qiang Xue committed
518
		self::$app->getLog()->log($token, Logger::LEVEL_PROFILE_BEGIN, $category);
Qiang Xue committed
519 520 521 522
	}

	/**
	 * Marks the end of a code block for profiling.
w  
Qiang Xue committed
523
	 * This has to be matched with a previous call to [[beginProfile]] with the same category name.
Qiang Xue committed
524 525
	 * @param string $token token for the code block
	 * @param string $category the category of this log message
Qiang Xue committed
526 527
	 * @see beginProfile
	 */
Qiang Xue committed
528
	public static function endProfile($token, $category = 'application')
Qiang Xue committed
529
	{
Qiang Xue committed
530
		self::$app->getLog()->log($token, Logger::LEVEL_PROFILE_END, $category);
Qiang Xue committed
531 532 533
	}

	/**
w  
Qiang Xue committed
534 535
	 * Returns an HTML hyperlink that can be displayed on your Web page showing Powered by Yii" information.
	 * @return string an HTML hyperlink that can be displayed on your Web page showing Powered by Yii" information
Qiang Xue committed
536 537 538
	 */
	public static function powered()
	{
Qiang Xue committed
539
		return 'Powered by <a href="http://www.yiiframework.com/" rel="external">Yii Framework</a>';
Qiang Xue committed
540 541 542 543
	}

	/**
	 * Translates a message to the specified language.
Qiang Xue committed
544
	 *
545 546 547
	 * This is a shortcut method of [[\yii\i18n\I18N::translate()]].
	 *
	 * The translation will be conducted according to the message category and the target language will be used.
Qiang Xue committed
548 549 550 551 552 553 554 555 556 557 558 559
	 *
	 * In case when a translated message has different plural forms (separated by "|"), this method
	 * will also attempt to choose an appropriate one according to a given numeric value which is
	 * specified as the first parameter (indexed by 0) in `$params`.
	 *
	 * For example, if a translated message is "I have an apple.|I have {n} apples.", and the first
	 * parameter is 2, the message returned will be "I have 2 apples.". Note that the placeholder "{n}"
	 * will be replaced with the given number.
	 *
	 * For more details on how plural rules are applied, please refer to:
	 * [[http://www.unicode.org/cldr/charts/supplemental/language_plural_rules.html]]
	 *
560
	 * @param string $category the message category.
Qiang Xue committed
561 562 563 564 565
	 * @param string $message the message to be translated.
	 * @param array $params the parameters that will be used to replace the corresponding placeholders in the message.
	 * @param string $language the language code (e.g. `en_US`, `en`). If this is null, the current
	 * [[\yii\base\Application::language|application language]] will be used.
	 * @return string the translated message.
Qiang Xue committed
566
	 */
567
	public static function t($category, $message, $params = array(), $language = null)
Qiang Xue committed
568
	{
Qiang Xue committed
569
		if (self::$app !== null) {
Qiang Xue committed
570
			return self::$app->getI18N()->translate($category, $message, $params, $language ?: self::$app->language);
Qiang Xue committed
571 572 573
		} else {
			return is_array($params) ? strtr($message, $params) : $message;
		}
Qiang Xue committed
574
	}
Qiang Xue committed
575 576 577 578 579 580 581 582 583 584 585 586

	/**
	 * Configures an object with the initial property values.
	 * @param object $object the object to be configured
	 * @param array $properties the property initial values given in terms of name-value pairs.
	 */
	public static function configure($object, $properties)
	{
		foreach ($properties as $name => $value) {
			$object->$name = $value;
		}
	}
587 588 589 590 591 592 593 594 595 596 597 598 599

	/**
	 * Returns the public member variables of an object.
	 * This method is provided such that we can get the public member variables of an object.
	 * It is different from "get_object_vars()" because the latter will return private
	 * and protected variables if it is called within the object itself.
	 * @param object $object the object to be handled
	 * @return array the public member variables of the object
	 */
	public static function getObjectVars($object)
	{
		return get_object_vars($object);
	}
Qiang Xue committed
600
}