Класс yii\BaseYii

public static array $aliases = ['@yii' => __DIR__]

public static yii\console\Application|yii\web\Application $app = null

public static array $classMap = []

public static yii\di\Container $container = null

autoload() public static method

Загрузчик класса автозагрузки.

Этот метод вызывается автоматически, когда PHP видит неизвестный класс. Метод попытается включить файл класса в соответствии со следующим алгоритмом:

1. Поиск в $classMap;
2. Если класс имеет пространство имён (например, yii\base\Component), он попытается включить файл, соответствующий пути алиаса (например, @yii/base/Component.php);

Этот автозагрузчик позволяет загружать классы, которые следуют стандарту PSR-4 и имеют своё основное пространство имён или подпространства имён, определённые как пути алиасов.

Пример: Когда определены алиасы @yii и @yii/bootstrap, классы в пространстве имён yii\bootstrap будут загружаться с помощью алиаса @yii/bootstrap, который указывает на каталог, где установлены файлы расширения bootstrap, и все классы из других пространств имён yii будут загружаться из каталога фреймворка Yii.

Также см. раздел руководства по автозагрузке.

public static void autoload ( $className )
$className	string	Полное имя класса без ведущего обратного слэша «\»
throws	yii\base\UnknownClassException	если класс отсутствует в файле класса

beginProfile() public static method

Помечает начало блока кода для профилирования.

Это должно быть согласовано с вызовом endProfile() с тем же именем категории. Вызовы begin и end также должны быть правильно вложены. Например,

\Yii::beginProfile('block1');
// some code to be profiled
    \Yii::beginProfile('block2');
    // some other code to be profiled
    \Yii::endProfile('block2');
\Yii::endProfile('block1');

См. также endProfile().

public static void beginProfile ( $token, $category = 'application' )
$token	string	Токен для блока кода
$category	string	Категория этого сообщения журнала

configure() public static method

Настраивает объект с начальными значениями свойств.

public static object configure ( $object, $properties )
$object	object	Настраиваемый объект
$properties	array	Начальные значения свойств, заданные в виде пар имя-значение.
return	object	Сам объект

createObject() public static method

Создаёт новый объект, используя заданную конфигурацию.

Этот метод можно рассматривать как усовершенствованную версию оператора new. Метод поддерживает создание объекта на основе имени класса, массива конфигурации или анонимной функции.

Ниже приведены примеры использования:

// 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]);

Используя контейнер внедрения зависимостей, этот метод также может определить зависимые объекты, создать их и внедрить их в только что созданный объект.

См. также yii\di\Container.

public static object createObject ( $type, array $params = [] )
$type	string|array|callable	Тип объекта. Это может быть указано в одном из следующих форматов: строка: представляющая имя класса создаваемого объекта массив конфигурации: массив должен содержать элемент class, который обрабатывается как класс объекта, а остальные пары имя-значение будут использоваться для инициализации соответствующих свойств объекта PHP callable: либо анонимная функция, либо массив, представляющий метод класса ([$class or $object, $method]). Callable должен возвращать новый экземпляр создаваемого объекта.
$params	array	Параметры конструктора
return	object	Созданный объект
throws	yii\base\InvalidConfigException	если конфигурация некорректна.

endProfile() public static method

Помечает конец блока кода для профилирования.

Это должно быть согласовано с предыдущим вызовом beginProfile() с тем же именем категории.

См. также beginProfile().

public static void endProfile ( $token, $category = 'application' )
$token	string	Токен для блока кода
$category	string	Категория этого сообщения журнала

error() public static method

Записывает сообщение об ошибке.

Сообщение об ошибке обычно записывается, когда во время выполнения приложения возникает невосстановимая ошибка.

public static void error ( $message, $category = 'application' )
$message	string|array	Сообщение для записи. Это может быть простая строка или более сложная структура данных, например, массив.
$category	string	Категория сообщения.

getAlias() public static method

Преобразует алиас пути в фактический путь.

Преобразование выполняется по следующему алгоритму:

1. Если заданный алиас не начинается с «@», он возвращается без изменений;
2. В противном случае ищется самый длинный зарегистрированный алиас, соответствующий начальной части заданного алиаса. Если он существует, соответствующая часть заданного алиаса заменяется соответствующим зарегистрированным путём.
3. Выбрасывается исключение или возвращается false, в зависимости от параметра $throwException.

Например, по умолчанию «@yii» зарегистрирован как алиас каталога фреймворка Yii, например, «/path/to/yii». Тогда алиас «@yii/web» преобразуется в «/path/to/yii/web».

Если у вас зарегистрированы два алиаса «@foo» и «@foo/bar». Тогда перевод «@foo/bar/config» заменит часть «@foo/bar» (вместо «@foo») соответствующим зарегистрированным путём. Это потому, что самый длинный алиас имеет приоритет.

Однако, если алиас для перевода — «@foo/barbar/config», то будет заменено «@foo», а не «@foo/bar», потому что «/» служит разделителем.

Обратите внимание, что этот метод не проверяет, существует ли возвращаемый путь или нет.

См. статью руководства по алиасам для получения дополнительной информации.

См. также setAlias().

public static string|boolean getAlias ( $alias, $throwException = true )
$alias	string	Алиас для преобразования.
$throwException	boolean	Выбрасывать ли исключение, если заданный алиас некорректен. Если это false, и задан некорректный алиас, этот метод вернёт false.
return	string|boolean	Путь, соответствующий алиасу, false, если корневой алиас не был зарегистрирован ранее.
throws	yii\base\InvalidParamException	если алиас некорректен, а $throwException — true.

getLogger() public static method

public static yii\log\Logger getLogger ( )
return	yii\log\Logger	Диспетчер сообщений

getObjectVars() public static method

Возвращает общедоступные переменные члена объекта.

Этот метод предоставляется для получения общедоступных переменных члена объекта. Он отличается от «get_object_vars()», потому что последний вернёт приватные и защищённые переменные, если его вызывают внутри самого объекта.

public static array getObjectVars ( $object )
$object	object	Обрабатываемый объект
return	array	Общедоступные переменные члена объекта

getRootAlias() public static method

Возвращает часть корневого алиаса заданного алиаса.

Корневой псевдоним — это псевдоним, который был зарегистрирован с помощью setAlias() ранее. Если заданный псевдоним соответствует нескольким корневым псевдонимам, будет возвращён самый длинный.

public static string|boolean getRootAlias ( $alias )
$alias	string	Псевдоним
return	string|boolean	Корневой псевдоним или false, если корневой псевдоним не найден

getVersion() public static method

Возвращает строку, представляющую текущую версию фреймворка Yii.

public static string getVersion ( )
return	string	Версия фреймворка Yii

info() public static method

Записывает информационное сообщение.

Информационное сообщение обычно записывается приложением для ведения записи чего-либо важного (например, администратор входит в систему).

public static void info ( $message, $category = 'application' )
$message	string|array	Сообщение для записи. Это может быть простая строка или более сложная структура данных, например, массив.
$category	string	Категория сообщения.

powered() public static method

Возвращает HTML гиперссылку, которая может быть отображена на вашей веб-странице, показывающую информацию "Работает на Yii Framework".

public static string powered ( )
return	string	HTML гиперссылка, которая может быть отображена на вашей веб-странице, показывающая информацию "Работает на Yii Framework"

setAlias() public static method

Регистрирует псевдоним пути.

Псевдоним пути — это короткое имя, представляющее длинный путь (путь к файлу, URL и т. д.). Например, мы используем '@yii' в качестве псевдонима пути к директории фреймворка Yii.

Псевдоним пути должен начинаться с символа '@', чтобы его можно было легко отличить от путей без псевдонима.

Обратите внимание, что этот метод не проверяет, существует ли заданный путь или нет. Всё, что он делает, — это связывает псевдоним с путем.

Любые конечные символы '/' и '\' в указанном пути будут обрезаны.

Дополнительную информацию см. в статье руководства по псевдонимам.

См. также getAlias().

public static void setAlias ( $alias, $path )
$alias	string	Имя псевдонима (например, "@yii"). Он должен начинаться с символа '@'. Может содержать прямой слеш '/', который служит разделителем при выполнении перевода псевдонима методом getAlias().
$path	string	Путь, соответствующий псевдониму. Если это null, псевдоним будет удалён. Конечные символы '/' и '\' будут обрезаны. Это может быть путь к каталогу или файлу (например, /tmp, /tmp/main.txt) URL (например, http://www.yiiframework.com) псевдоним пути (например, @yii/base). В этом случае псевдоним пути будет сначала преобразован в фактический путь с помощью вызова getAlias().
throws	yii\base\InvalidParamException	если $path является недопустимым псевдонимом.

setLogger() public static method

Устанавливает объект логгера.

public static void setLogger ( $logger )
$logger	yii\log\Logger	Объект логгера.

t() public static method

Переводит сообщение на указанный язык.

Это сокращённый метод yii\i18n\I18N::translate().

Перевод будет выполнен в соответствии с категорией сообщения, а целевой язык будет использован.

Вы можете добавить параметры к сообщению перевода, которые будут заменены соответствующим значением после перевода. Формат для этого — использовать фигурные скобки вокруг имени параметра, как показано в следующем примере:

$username = 'Alexander';
echo \Yii::t('app', 'Hello, {username}!', ['username' => $username]);

Дополнительный форматирование параметров сообщения поддерживается с помощью расширений PHP intl форматировщик сообщений. Дополнительные сведения см. в yii\i18n\I18N::translate().

public static string t ( $category, $message, $params = [], $language = null )
$category	string	Категория сообщения.
$message	string	Сообщение для перевода.
$params	array	Параметры, которые будут использованы для замены соответствующих местозаполнителей в сообщении.
$language	string	Код языка (например, en-US, en). Если это null, будет использован текущий язык приложения.
return	string	Переведённое сообщение.

trace() public static method

Записывает сообщение трассировки.

Сообщения трассировки в основном записываются для целей разработки, чтобы увидеть поток выполнения некоторого кода.

public static void trace ( $message, $category = 'application' )
$message	string|array	Сообщение для записи. Это может быть простая строка или более сложная структура данных, например, массив.
$category	string	Категория сообщения.

warning() public static method

Записывает предупреждающее сообщение.

Предупреждающее сообщение обычно записывается, когда возникает ошибка, но выполнение всё ещё может продолжаться.

public static void warning ( $message, $category = 'application' )
$message	string|array	Сообщение для записи. Это может быть простая строка или более сложная структура данных, например, массив.
$category	string	Категория сообщения.