YiiBase.php 21.5 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\base\UnknownClassException;
Qiang Xue committed
13
use yii\log\Logger;
Qiang Xue committed
14

Qiang Xue committed
15
/**
w  
Qiang Xue committed
16
 * Gets the application start timestamp.
Qiang Xue committed
17
 */
w  
Qiang Xue committed
18
defined('YII_BEGIN_TIME') or define('YII_BEGIN_TIME', microtime(true));
Qiang Xue committed
19 20 21
/**
 * This constant defines whether the application should be in debug mode or not. Defaults to false.
 */
w  
Qiang Xue committed
22
defined('YII_DEBUG') or define('YII_DEBUG', false);
23 24 25 26 27
/**
 * 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
28
/**
w  
Qiang Xue committed
29
 * This constant defines the framework installation directory.
Qiang Xue committed
30
 */
w  
Qiang Xue committed
31
defined('YII_PATH') or define('YII_PATH', __DIR__);
Qiang Xue committed
32 33 34 35 36
/**
 * 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
37

Qiang Xue committed
38
/**
w  
Qiang Xue committed
39
 * YiiBase is the core helper class for the Yii framework.
Qiang Xue committed
40
 *
w  
Qiang Xue committed
41
 * Do not use YiiBase directly. Instead, use its child class [[Yii]] where
Qiang Xue committed
42 43 44
 * you can customize methods of YiiBase.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
w  
Qiang Xue committed
45
 * @since 2.0
Qiang Xue committed
46 47 48 49 50
 */
class YiiBase
{
	/**
	 * @var array class map used by the Yii autoloading mechanism.
51
	 * The array keys are the class names (without leading backslashes), and the array values
Qiang Xue committed
52 53
	 * are the corresponding class file paths (or path aliases). This property mainly affects
	 * how [[autoload()]] works.
Qiang Xue committed
54 55
	 * @see import
	 * @see autoload
w  
Qiang Xue committed
56 57 58
	 */
	public static $classMap = array();
	/**
Qiang Xue committed
59 60
	 * @var boolean whether to search PHP include_path when autoloading unknown classes.
	 * You may want to turn this off if you are also using autoloaders from other libraries.
w  
Qiang Xue committed
61
	 */
Qiang Xue committed
62
	public static $enableIncludePath = false;
w  
Qiang Xue committed
63
	/**
64
	 * @var \yii\console\Application|\yii\web\Application the application instance
Qiang Xue committed
65
	 */
Qiang Xue committed
66
	public static $app;
w  
Qiang Xue committed
67 68
	/**
	 * @var array registered path aliases
Qiang Xue committed
69 70
	 * @see getAlias
	 * @see setAlias
w  
Qiang Xue committed
71
	 */
72
	public static $aliases = array('@yii' => __DIR__);
Qiang Xue committed
73 74
	/**
	 * @var array initial property values that will be applied to objects newly created via [[createObject]].
Qiang Xue committed
75 76
	 * 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
77 78 79
	 *
	 * ~~~
	 * array(
Qiang Xue committed
80
	 *     'Bar' => array(
Qiang Xue committed
81 82 83
	 *         'prop1' => 'value1',
	 *         'prop2' => 'value2',
	 *     ),
Qiang Xue committed
84
	 *     'mycompany\foo\Car' => array(
Qiang Xue committed
85 86 87 88 89 90 91 92 93
	 *         'prop1' => 'value1',
	 *         'prop2' => 'value2',
	 *     ),
	 * )
	 * ~~~
	 *
	 * @see createObject
	 */
	public static $objectConfig = array();
Qiang Xue committed
94

Qiang Xue committed
95
	private static $_imported = array(); // alias => class name or directory
Qiang Xue committed
96 97 98 99 100 101

	/**
	 * @return string the version of Yii framework
	 */
	public static function getVersion()
	{
w  
Qiang Xue committed
102
		return '2.0-dev';
Qiang Xue committed
103 104 105
	}

	/**
Qiang Xue committed
106
	 * Imports a class by its alias.
Qiang Xue committed
107
	 *
Qiang Xue committed
108 109 110
	 * 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
111
	 *
Qiang Xue committed
112 113 114 115
	 * 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
116
	 *
Qiang Xue committed
117
	 * You may import the same class multiple times. Only the first importing will count.
Qiang Xue committed
118
	 *
Qiang Xue committed
119 120 121 122
	 * @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
123
	 */
Qiang Xue committed
124
	public static function import($alias)
Qiang Xue committed
125
	{
Qiang Xue committed
126
		if (strncmp($alias, '@', 1)) {
Qiang Xue committed
127
			return $alias;
Qiang Xue committed
128 129 130 131
		} else {
			$alias = static::getAlias($alias);
			if (!isset(self::$_imported[$alias])) {
				$className = basename($alias);
w  
Qiang Xue committed
132
				self::$_imported[$alias] = $className;
Qiang Xue committed
133
				self::$classMap[$className] = $alias . '.php';
w  
Qiang Xue committed
134
			}
Qiang Xue committed
135
			return self::$_imported[$alias];
Qiang Xue committed
136 137 138
		}
	}

139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
	/**
	 * 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 !== '') {
157
				$name = trim(strtr($name, array('\\' => '/', '_' => '/')), '/');
158 159 160
				if (is_array($path)) {
					$path = reset($path);
				}
161
				static::setAlias('@' . $name, rtrim($path, '/\\') . '/' . $name);
162 163 164 165
			}
		}
	}

Qiang Xue committed
166
	/**
w  
Qiang Xue committed
167
	 * Translates a path alias into an actual path.
m  
Qiang Xue committed
168
	 *
169
	 * The translation is done according to the following procedure:
m  
Qiang Xue committed
170
	 *
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
	 * 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
188
	 *
Qiang Xue committed
189
	 * @param string $alias the alias to be translated.
Qiang Xue committed
190 191
	 * @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
192
	 * @return string|boolean the path corresponding to the alias, false if the root alias is not previously registered.
Qiang Xue committed
193
	 * @throws InvalidParamException if the alias is invalid while $throwException is true.
w  
Qiang Xue committed
194
	 * @see setAlias
Qiang Xue committed
195
	 */
Qiang Xue committed
196
	public static function getAlias($alias, $throwException = true)
Qiang Xue committed
197
	{
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
		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
214
				}
Qiang Xue committed
215 216
			}
		}
217

Qiang Xue committed
218 219 220 221 222
		if ($throwException) {
			throw new InvalidParamException("Invalid path alias: $alias");
		} else {
			return false;
		}
Qiang Xue committed
223 224
	}

Qiang Xue committed
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
	/**
	 * 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
251
	/**
w  
Qiang Xue committed
252
	 * Registers a path alias.
m  
Qiang Xue committed
253
	 *
254 255
	 * 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
256
	 *
257 258
	 * A path alias must start with the character '@' so that it can be easily differentiated
	 * from non-alias paths.
m  
Qiang Xue committed
259
	 *
260 261 262 263 264 265 266 267 268 269
	 * 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
270 271 272 273
	 *
	 * - 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
274
	 *   actual path first by calling [[getAlias()]].
Qiang Xue committed
275
	 *
Qiang Xue committed
276
	 * @throws InvalidParamException if $path is an invalid alias.
w  
Qiang Xue committed
277
	 * @see getAlias
Qiang Xue committed
278
	 */
w  
Qiang Xue committed
279
	public static function setAlias($alias, $path)
Qiang Xue committed
280
	{
281
		if (strncmp($alias, '@', 1)) {
Qiang Xue committed
282
			$alias = '@' . $alias;
283 284 285 286 287 288
		}
		$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
289 290 291 292 293
				if ($pos === false) {
					self::$aliases[$root] = $path;
				} else {
					self::$aliases[$root] = array($alias => $path);
				}
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
			} 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
313
		}
Qiang Xue committed
314 315 316 317
	}

	/**
	 * Class autoload loader.
Qiang Xue committed
318 319
	 * 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
320 321 322 323 324 325 326 327
	 *
	 * 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`);
Qiang Xue committed
328
	 * 4. Search PHP include_path for the actual class file if [[enableIncludePath]] is true;
w  
Qiang Xue committed
329 330
	 * 5. Return false so that other autoloaders have chance to include the class file.
	 *
Qiang Xue committed
331 332
	 * @param string $className class name
	 * @return boolean whether the class has been loaded successfully
Qiang Xue committed
333 334
	 * @throws InvalidConfigException if the class file does not exist
	 * @throws UnknownClassException if the class does not exist in the class file
Qiang Xue committed
335 336 337
	 */
	public static function autoload($className)
	{
Qiang Xue committed
338
		$className = ltrim($className, '\\');
w  
Qiang Xue committed
339

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
			}
Qiang Xue committed
345
		} else {
Qiang Xue committed
346
			// follow PSR-0 to determine the class file
Qiang Xue committed
347 348
			if (($pos = strrpos($className, '\\')) !== false) {
				// namespaced class, e.g. yii\base\Component
Qiang Xue committed
349
				$path = str_replace('\\', '/', substr($className, 0, $pos + 1))
Qiang Xue committed
350 351
					. str_replace('_', '/', substr($className, $pos + 1)) . '.php';
			} else {
Qiang Xue committed
352
				$path = str_replace('_', '/', $className) . '.php';
w  
Qiang Xue committed
353
			}
Qiang Xue committed
354 355 356 357 358 359 360

			// try via path alias first
			if (strpos($path, '/') !== false) {
				$fullPath = static::getAlias('@' . $path, false);
				if ($fullPath !== false && is_file($fullPath)) {
					$classFile = $fullPath;
				}
Qiang Xue committed
361 362
			}

Qiang Xue committed
363
			// search include_path
364 365
			if (!isset($classFile) && self::$enableIncludePath && ($fullPath = stream_resolve_include_path($path)) !== false) {
				$classFile = $fullPath;
Qiang Xue committed
366 367 368 369 370
			}

			if (!isset($classFile)) {
				// return false to let other autoloaders to try loading the class
				return false;
w  
Qiang Xue committed
371
			}
Qiang Xue committed
372 373 374 375
		}

		include($classFile);

Suralc committed
376
		if (class_exists($className, false) || interface_exists($className, false) ||
377
			function_exists('trait_exists') && trait_exists($className, false)) {
Qiang Xue committed
378
			return true;
Qiang Xue committed
379
		} else {
Qiang Xue committed
380
			throw new UnknownClassException("Unable to find '$className' in file: $classFile");
w  
Qiang Xue committed
381
		}
Qiang Xue committed
382 383
	}

w  
Qiang Xue committed
384
	/**
Qiang Xue committed
385
	 * Creates a new object using the given configuration.
w  
Qiang Xue committed
386
	 *
Qiang Xue committed
387
	 * The configuration can be either a string or an array.
Qiang Xue committed
388 389
	 * 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
390 391 392
	 * the rest of the name-value pairs in the array will be used to initialize
	 * the corresponding object properties.
	 *
Qiang Xue committed
393
	 * The object type can be either a class name or the [[getAlias()|alias]] of
w  
Qiang Xue committed
394
	 * the class. For example,
w  
Qiang Xue committed
395
	 *
Qiang Xue committed
396 397
	 * - `app\components\GoogleMap`: fully-qualified namespaced class.
	 * - `@app/components/GoogleMap`: an alias, used for non-namespaced class.
Qiang Xue committed
398 399 400
	 *
	 * Below are some usage examples:
	 *
w  
Qiang Xue committed
401
	 * ~~~
Qiang Xue committed
402
	 * $object = \Yii::createObject('@app/components/GoogleMap');
Qiang Xue committed
403 404
	 * $object = \Yii::createObject(array(
	 *     'class' => '\app\components\GoogleMap',
w  
Qiang Xue committed
405 406 407 408
	 *     'apiKey' => 'xyz',
	 * ));
	 * ~~~
	 *
Qiang Xue committed
409 410 411 412 413 414 415 416 417 418
	 * 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
419
	 *
Qiang Xue committed
420 421
	 * @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
422
	 * @return mixed the created object
Qiang Xue committed
423
	 * @throws InvalidConfigException if the configuration is invalid.
w  
Qiang Xue committed
424
	 */
Qiang Xue committed
425
	public static function createObject($config)
w  
Qiang Xue committed
426
	{
Qiang Xue committed
427 428
		static $reflections = array();

w  
Qiang Xue committed
429
		if (is_string($config)) {
w  
Qiang Xue committed
430
			$class = $config;
w  
Qiang Xue committed
431
			$config = array();
Qiang Xue committed
432
		} elseif (isset($config['class'])) {
w  
Qiang Xue committed
433
			$class = $config['class'];
w  
Qiang Xue committed
434
			unset($config['class']);
Qiang Xue committed
435
		} else {
Qiang Xue committed
436
			throw new InvalidConfigException('Object configuration must be an array containing a "class" element.');
w  
Qiang Xue committed
437 438
		}

w  
Qiang Xue committed
439
		if (!class_exists($class, false)) {
Qiang Xue committed
440
			$class = static::import($class);
w  
Qiang Xue committed
441 442
		}

Qiang Xue committed
443 444 445 446
		$class = ltrim($class, '\\');

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

Qiang Xue committed
449
		if (($n = func_num_args()) > 1) {
Qiang Xue committed
450 451 452
			/** @var $reflection \ReflectionClass */
			if (isset($reflections[$class])) {
				$reflection = $reflections[$class];
Qiang Xue committed
453
			} else {
Qiang Xue committed
454 455 456 457
				$reflection = $reflections[$class] = new \ReflectionClass($class);
			}
			$args = func_get_args();
			array_shift($args); // remove $config
458
			if (!empty($config)) {
Qiang Xue committed
459
				$args[] = $config;
Qiang Xue committed
460
			}
Qiang Xue committed
461
			return $reflection->newInstanceArgs($args);
Qiang Xue committed
462
		} else {
463
			return empty($config) ? new $class : new $class($config);
Qiang Xue committed
464
		}
w  
Qiang Xue committed
465 466
	}

Qiang Xue committed
467
	/**
w  
Qiang Xue committed
468 469 470 471 472
	 * 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
473
	 */
w  
Qiang Xue committed
474
	public static function trace($message, $category = 'application')
Qiang Xue committed
475
	{
w  
Qiang Xue committed
476
		if (YII_DEBUG) {
Qiang Xue committed
477
			self::$app->getLog()->log($message, Logger::LEVEL_TRACE, $category);
w  
Qiang Xue committed
478
		}
Qiang Xue committed
479 480 481
	}

	/**
w  
Qiang Xue committed
482 483 484 485 486
	 * 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
487
	 */
Qiang Xue committed
488
	public static function error($message, $category = 'application')
Qiang Xue committed
489
	{
Qiang Xue committed
490
		self::$app->getLog()->log($message, Logger::LEVEL_ERROR, $category);
w  
Qiang Xue committed
491 492 493 494 495 496 497 498 499
	}

	/**
	 * 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
500
	public static function warning($message, $category = 'application')
w  
Qiang Xue committed
501
	{
Qiang Xue committed
502
		self::$app->getLog()->log($message, Logger::LEVEL_WARNING, $category);
Qiang Xue committed
503 504 505
	}

	/**
w  
Qiang Xue committed
506 507 508 509 510 511
	 * 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
512
	public static function info($message, $category = 'application')
w  
Qiang Xue committed
513
	{
Qiang Xue committed
514
		self::$app->getLog()->log($message, Logger::LEVEL_INFO, $category);
w  
Qiang Xue committed
515 516 517 518 519 520 521 522 523
	}

	/**
	 * 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
524 525 526 527
	 * // some code to be profiled
	 *     \Yii::beginProfile('block2');
	 *     // some other code to be profiled
	 *     \Yii::endProfile('block2');
w  
Qiang Xue committed
528 529
	 * \Yii::endProfile('block1');
	 * ~~~
Qiang Xue committed
530 531
	 * @param string $token token for the code block
	 * @param string $category the category of this log message
Qiang Xue committed
532 533
	 * @see endProfile
	 */
Qiang Xue committed
534
	public static function beginProfile($token, $category = 'application')
Qiang Xue committed
535
	{
Qiang Xue committed
536
		self::$app->getLog()->log($token, Logger::LEVEL_PROFILE_BEGIN, $category);
Qiang Xue committed
537 538 539 540
	}

	/**
	 * Marks the end of a code block for profiling.
w  
Qiang Xue committed
541
	 * This has to be matched with a previous call to [[beginProfile]] with the same category name.
Qiang Xue committed
542 543
	 * @param string $token token for the code block
	 * @param string $category the category of this log message
Qiang Xue committed
544 545
	 * @see beginProfile
	 */
Qiang Xue committed
546
	public static function endProfile($token, $category = 'application')
Qiang Xue committed
547
	{
Qiang Xue committed
548
		self::$app->getLog()->log($token, Logger::LEVEL_PROFILE_END, $category);
Qiang Xue committed
549 550 551
	}

	/**
w  
Qiang Xue committed
552 553
	 * 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
554 555 556 557 558 559 560 561
	 */
	public static function powered()
	{
		return 'Powered by <a href="http://www.yiiframework.com/" rel="external">Yii Framework</a>.';
	}

	/**
	 * Translates a message to the specified language.
Qiang Xue committed
562
	 *
563 564 565
	 * 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
566 567 568 569 570 571 572 573 574 575 576 577
	 *
	 * 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]]
	 *
578
	 * @param string $category the message category.
Qiang Xue committed
579 580 581 582 583
	 * @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
584
	 */
585
	public static function t($category, $message, $params = array(), $language = null)
Qiang Xue committed
586
	{
Qiang Xue committed
587
		if (self::$app !== null) {
Qiang Xue committed
588
			return self::$app->getI18N()->translate($category, $message, $params, $language ?: self::$app->language);
Qiang Xue committed
589 590 591
		} else {
			return is_array($params) ? strtr($message, $params) : $message;
		}
Qiang Xue committed
592
	}
Qiang Xue committed
593 594 595 596 597 598 599 600 601 602 603 604

	/**
	 * 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;
		}
	}
605 606 607 608 609 610 611 612 613 614 615 616 617

	/**
	 * 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
618
}