HumHub Documentation (unofficial)

Yii extends BaseYii
in package

Application

Yii is a helper class serving common framework functionalities.

It extends from [[\yii\BaseYii]] which provides the actual implementation. By writing your own Yii class, you can customize some functionalities of [[\yii\BaseYii]].

Properties

$aliases : array<string|int, mixed>
$app : Application|Application
$classMap : array<string|int, mixed>
$container : Container
$_logger : mixed

Methods

autoload() : mixed: Class autoload loader.
beginProfile() : mixed: Marks the beginning of a code block for profiling.
configure() : object: Configures an object with the initial property values.
createObject() : object: Creates a new object using the given configuration.
debug() : mixed: Logs a debug message.
endProfile() : mixed: Marks the end of a code block for profiling.
error() : mixed: Logs an error message.
getAlias() : string|false: Translates a path alias into an actual path.
getLogger() : Logger
getObjectVars() : array<string|int, mixed>: Returns the public member variables of an object.
getRootAlias() : string|false: Returns the root alias part of a given alias.
getVersion() : string: Returns a string representing the current version of the Yii framework.
info() : mixed: 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() : mixed: Registers a path alias.
setLogger() : mixed: Sets the logger object.
t() : string: Translates a message to the specified language.
trace() : mixed: Alias of [[debug()]].
warning() : mixed: Logs a warning message.

$aliases


    public
    static    array<string|int, mixed>
    $aliases
     = ['@yii' => __DIR__]

registered path aliases

$app


    public
    static    Application|Application
    $app

the application instance

$classMap


    public
    static    array<string|int, mixed>
    $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 [[autoload()]] works.

$container


    public
    static    Container
    $container

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

$_logger


    private
    static    mixed
    $_logger

autoload()

Class autoload loader.


    public
            static        autoload(string $className) : mixed

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:

Search in [[classMap]];
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 the 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.

Parameters

$className : string: the fully qualified class name without a leading backslash ""

beginProfile()

Marks the beginning of a code block for profiling.


    public
            static        beginProfile(string $token[, string $category = 'application' ]) : mixed

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

Parameters

$token : string: token for the code block
$category : string = 'application': the category of this log message

configure()

Configures an object with the initial property values.


    public
            static        configure(object $object, array<string|int, mixed> $properties) : object

Parameters

$object : object: the object to be configured
$properties : array<string|int, mixed>: the property initial values given in terms of name-value pairs.

Return values

object —

the object itself

createObject()

Creates a new object using the given configuration.


    public
            static        createObject(string|array<string|int, mixed>|callable $type[, array<string|int, mixed> $params = [] ]) : object

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:

// 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.

Parameters

$type : string|array<string|int, mixed>|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<string|int, mixed> = []

the constructor parameters

Return values

object —

the created object

debug()

Logs a debug message.


    public
            static        debug(string|array<string|int, mixed> $message[, string $category = 'application' ]) : mixed

Trace messages are logged mainly for development purposes to see the execution workflow of some code. This method will only log a message when the application is in debug mode.

Parameters

$message : string|array<string|int, mixed>: the message to be logged. This can be a simple string or a more complex data structure, such as an array.
$category : string = 'application': the category of the message.

endProfile()

Marks the end of a code block for profiling.


    public
            static        endProfile(string $token[, string $category = 'application' ]) : mixed

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

Parameters

$token : string: token for the code block
$category : string = 'application': the category of this log message

error()

Logs an error message.


    public
            static        error(string|array<string|int, mixed> $message[, string $category = 'application' ]) : mixed

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

Parameters

$message : string|array<string|int, mixed>: the message to be logged. This can be a simple string or a more complex data structure, such as an array.
$category : string = 'application': the category of the message.

getAlias()

Translates a path alias into an actual path.


    public
            static        getAlias(string $alias[, bool $throwException = true ]) : string|false

The translation is done according to the following procedure:

If the given alias does not start with '@', it is returned back without change;
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.
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.

See the guide article on aliases for more information.

Parameters

$alias : string: the alias to be translated.
$throwException : bool = true: 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 values

string|false —

the path corresponding to the alias, false if the root alias is not previously registered.

getLogger()


    public
            static        getLogger() : Logger

Return values

Logger —

message logger

getObjectVars()

Returns the public member variables of an object.


    public
            static        getObjectVars(object $object) : array<string|int, mixed>

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.

Parameters

$object : object: the object to be handled

Return values

array<string|int, mixed> —

the public member variables of the object

getRootAlias()

Returns the root alias part of a given alias.


    public
            static        getRootAlias(string $alias) : string|false

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.

Parameters

$alias : string: the alias

Return values

string|false —

the root alias, or false if no root alias is found

getVersion()

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


    public
            static        getVersion() : string

Return values

string —

the version of Yii framework

info()

Logs an informative message.


    public
            static        info(string|array<string|int, mixed> $message[, string $category = 'application' ]) : mixed

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

Parameters

$message : string|array<string|int, mixed>: the message to be logged. This can be a simple string or a more complex data structure, such as an array.
$category : string = 'application': the category of the message.

powered()

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


    public
            static        powered() : string

Return values

string —

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

setAlias()

Registers a path alias.


    public
            static        setAlias(string $alias, string|null $path) : mixed

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.

See the guide article on aliases for more information.

Parameters

$alias : string

the alias name (e.g. "@yii"). It must start with a '@' character. It may contain the forward-slash '/' which serves as a boundary character when performing alias translation by [[getAlias()]].

$path : string|null

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. https://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()]].

setLogger()

Sets the logger object.


    public
            static        setLogger(Logger|null $logger) : mixed

Parameters

$logger : Logger|null: the logger object.

t()

Translates a message to the specified language.


    public
            static        t(string $category, string $message[, array<string|int, mixed> $params = [] ][, string|null $language = null ]) : string

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:

$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.

Parameters

$category : string: the message category.
$message : string: the message to be translated.
$params : array<string|int, mixed> = []: the parameters that will be used to replace the corresponding placeholders in the message.
$language : string|null = null: the language code (e.g. en-US, en). If this is null, the current [[\yii\base\Application::language|application language]] will be used.

Return values

string —

the translated message.

trace()

Alias of [[debug()]].


    public
            static        trace(string|array<string|int, mixed> $message[, string $category = 'application' ]) : mixed

Parameters

$message : string|array<string|int, mixed>: the message to be logged. This can be a simple string or a more complex data structure, such as an array.
$category : string = 'application': the category of the message.

warning()

Logs a warning message.


    public
            static        warning(string|array<string|int, mixed> $message[, string $category = 'application' ]) : mixed

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

Parameters

$message : string|array<string|int, mixed>: the message to be logged. This can be a simple string or a more complex data structure, such as an array.
$category : string = 'application': the category of the message.

Yii extends BaseYii in package Application

Tags

Table of Contents

Properties

Methods

Properties

$aliases

Tags

$app

$classMap

Tags

$container

Tags

$_logger

Methods

autoload()

Parameters

Tags

beginProfile()

Parameters

Tags

configure()

Parameters

Return values

createObject()

Parameters

Tags

Return values

debug()

Parameters

Tags

endProfile()

Parameters

Tags

error()

Parameters

getAlias()

Parameters

Tags

Return values

getLogger()

Return values

getObjectVars()

Parameters

Return values

getRootAlias()

Parameters

Return values

getVersion()

Return values

info()

Parameters

powered()

Tags

Return values

setAlias()

Parameters

Tags

setLogger()

Parameters

t()

Parameters

Return values

trace()

Parameters

Tags

warning()

Parameters

Yii extends BaseYii
in package

Application