PHP Class yii\BaseYii

Do not use BaseYii directly. Instead, use its child class [[\Yii]] which you can replace to customize methods of BaseYii.

Since: 2.0

Author: Qiang Xue ([email protected])

Mostra file Open project: yiisoft/yii2 Class Usage Examples

Public Properties

Property	Type	Description
$aliases		registered path aliases
$app		the application instance
$classMap		class map used by the Yii autoloading mechanism. The array keys are the class names (without leading backslashes), and the array values are the corresponding class file paths (or path aliases). This property mainly affects how BaseYii::autoload works.
$container		the dependency injection (DI) container used by BaseYii::createObject. You may use [[Container::set()]] to set up the needed dependencies of classes and their initial property values.

Public Methods

Method	Description
autoload ( string $className )	Class autoload loader.
beginProfile ( string $token, string $category = 'application' )	Marks the beginning of a code block for profiling.
configure ( object $object, array $properties ) : object	Configures an object with the initial property values.
createObject ( string \| array \| callable $type, array $params = [] ) : object	Creates a new object using the given configuration.
endProfile ( string $token, string $category = 'application' )	Marks the end of a code block for profiling.
error ( string $message, string $category = 'application' )	Logs an error message.
getAlias ( string $alias, boolean $throwException = true ) : string \| boolean	Translates a path alias into an actual path.
getLogger ( ) : Logger
getObjectVars ( object $object ) : array	Returns the public member variables of an object.
getRootAlias ( string $alias ) : string \| boolean	Returns the root alias part of a given alias.
getVersion ( ) : string	Returns a string representing the current version of the Yii framework.
info ( string $message, string $category = 'application' )	Logs an informative message.
powered ( ) : string	Returns an HTML hyperlink that can be displayed on your Web page showing "Powered by Yii Framework" information.
setAlias ( string $alias, string $path )	Registers a path alias.
setLogger ( Logger $logger )	Sets the logger object.
t ( string $category, string $message, array $params = [], string $language = null ) : string	Translates a message to the specified language.
trace ( string $message, string $category = 'application' )	Logs a trace message.
warning ( string $message, string $category = 'application' )	Logs a warning message.

Method Details

autoload() public static method

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: 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); This autoloader allows loading classes that follow the PSR-4 standard and have its top-level namespace or sub-namespaces defined as path aliases. Example: When aliases @yii and @yii/bootstrap are defined, classes in the yii\bootstrap namespace will be loaded using the @yii/bootstrap alias which points to the directory where bootstrap extension files are installed and all classes from other yii namespaces will be loaded from the yii framework directory. Also the guide section on autoloading.

public static autoload ( string $className )
$className	string	the fully qualified class name without a leading backslash "\"

beginProfile() public static method

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, php \Yii::beginProfile('block1'); some code to be profiled \Yii::beginProfile('block2'); some other code to be profiled \Yii::endProfile('block2'); \Yii::endProfile('block1');

configure() public static method

Configures an object with the initial property values.

public static configure ( object $object, array $properties ) : object
$object	object	the object to be configured
$properties	array	the property initial values given in terms of name-value pairs.
return	object	the object itself

createObject() public static method

You may view this method as an enhanced version of the new operator. The method supports creating an object based on a class name, a configuration array or an anonymous function. Below are some usage examples: php create an object using a class name $object = Yii::createObject('yii\db\Connection'); create an object using a configuration array $object = Yii::createObject([ 'class' => 'yii\db\Connection', 'dsn' => 'mysql:host=127.0.0.1;dbname=demo', 'username' => 'root', 'password' => '', 'charset' => 'utf8', ]); create an object with two constructor parameters $object = \Yii::createObject('MyClass', [$param1, $param2]); Using [[\yii\di\Container|dependency injection container]], this method can also identify dependent objects, instantiate them and inject them into the newly created object.

endProfile() public static method

This has to be matched with a previous call to [[beginProfile]] with the same category name.

error() public static method

An error message is typically logged when an unrecoverable error occurs during the execution of an application.

public static error ( string $message, string $category = 'application' )
$message	string	the message to be logged.
$category	string	the category of the message.

getAlias() public static method

The translation is done according to the following procedure: 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.

getLogger() public static method

public static getLogger ( ) : Logger
return	yii\log\Logger	message logger

getObjectVars() public static method

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.

public static getObjectVars ( object $object ) : array
$object	object	the object to be handled
return	array	the public member variables of the object

getRootAlias() public static method

A root alias is an alias that has been registered via BaseYii::setAlias previously. If a given alias matches multiple root aliases, the longest one will be returned.

public static getRootAlias ( string $alias ) : string \| boolean
$alias	string	the alias
return	string \| boolean	the root alias, or false if no root alias is found

getVersion() public static method

Returns a string representing the current version of the Yii framework.

public static getVersion ( ) : string
return	string	the version of Yii framework

info() public static method

An informative message is typically logged by an application to keep record of something important (e.g. an administrator logs in).

public static info ( string $message, string $category = 'application' )
$message	string	the message to be logged.
$category	string	the category of the message.

powered() public static method

Returns an HTML hyperlink that can be displayed on your Web page showing "Powered by Yii Framework" information.

public static powered ( ) : string
return	string	an HTML hyperlink that can be displayed on your Web page showing "Powered by Yii Framework" information

setAlias() public static method

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. A path alias must start with the character '@' so that it can be easily differentiated from non-alias paths. 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.

setLogger() public static method

Sets the logger object.

public static setLogger ( Logger $logger )
$logger	yii\log\Logger	the logger object.

t() public static method

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. You can add parameters to a translation message that will be substituted with the corresponding value after translation. The format for this is to use curly brackets around the parameter name as you can see in the following example: php $username = 'Alexander'; echo \Yii::t('app', 'Hello, {username}!', ['username' => $username]); Further formatting of message parameters is supported using the PHP intl extensions message formatter. See [[\yii\i18n\I18N::translate()]] for more details.

public static t ( string $category, string $message, array $params = [], string $language = null ) : string
$category	string	the message category.
$message	string	the message to be translated.
$params	array	the parameters that will be used to replace the corresponding placeholders in the message.
$language	string	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.

trace() public static method

Trace messages are logged mainly for development purpose to see the execution work flow of some code.

public static trace ( string $message, string $category = 'application' )
$message	string	the message to be logged.
$category	string	the category of the message.

warning() public static method

A warning message is typically logged when an error occurs while the execution can still continue.

public static warning ( string $message, string $category = 'application' )
$message	string	the message to be logged.
$category	string	the category of the message.

Property Details

$aliases public_oe static_oe property

registered path aliases

$app public_oe static_oe property

the application instance

public static $app

$classMap public_oe static_oe property

class map used by the Yii autoloading mechanism. The array keys are the class names (without leading backslashes), and the array values are the corresponding class file paths (or path aliases). This property mainly affects how BaseYii::autoload works.

$container public_oe static_oe property

the dependency injection (DI) container used by BaseYii::createObject. You may use [[Container::set()]] to set up the needed dependencies of classes and their initial property values.

public static beginProfile ( string $token, string $category = 'application' )
$token	string	token for the code block
$category	string	the category of this log message

public static createObject ( string \| array \| callable $type, array $params = [] ) : object
$type	string \| array \| callable	the object type. This can be specified in one of the following forms: - a string: representing the class name of the object to be created - a configuration array: the array must contain a `class` element which is treated as the object class, and the rest of the name-value pairs will be used to initialize the corresponding object properties - a PHP callable: either an anonymous function or an array representing a class method (`[$class or $object, $method]`). The callable should return a new instance of the object being created.
$params	array	the constructor parameters
return	object	the created object

public static endProfile ( string $token, string $category = 'application' )
$token	string	token for the code block
$category	string	the category of this log message

public static getAlias ( string $alias, boolean $throwException = true ) : string \| boolean
$alias	string	the alias to be translated.
$throwException	boolean	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.
return	string \| boolean	the path corresponding to the alias, false if the root alias is not previously registered.

public static setAlias ( string $alias, string $path )
$alias	string	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()]].
$path	string	the path corresponding to the alias. If this is null, the alias will be removed. Trailing '/' and '\' characters will be trimmed. This can be - 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 actual path first by calling [[getAlias()]].