Yii 2, псевдонимы пути для приложений basic и advanced

6 мая 2016 г. 5 Yehor Rykhnov 4296

Псевдонимы (алиасы) предназначены для обозначения путей к папкам, файлам или URL. Псевдонимы помогают избежать использования абсолютных путей или URL в коде. Чтобы не путать псевдоним с обычным путем к папке, файлу или URL, он должен начинаться с @. В yii есть заранее заданные псевдонимы (алиасы), например @yii, @app, но так же есть возможность задать свои псевдонимы.

Как задать псевдоним пути в yii2
Как получить псевдоним пути в yii2
Дополнительно о псевдонимах путей
Псевдонимы путей в yii2 basic
Псевдонимы (алиасы) путей в yii2 advanced

Как создать/установить псевдоним (алиас) пути в Yii 2

Для того чтобы создать псевдоним (алиас) пути используется метод Yii::setAlias():

// псевдоним пути к папке
Yii::setAlias('@myalias', '/path/to/myfolder');

// псевдоним пути к папке на основе другого псевдонима
Yii::setAlias('@img', '@myalias/path/to/img');

// псевдоним URL
Yii::setAlias('@mysite', 'http://mysite.com');

Псевдонимы путей в yii2 можно задать в файле конфигураций приложения с помощью свойства aliases, пример:

return [
    // ...
    'aliases' => [
        '@myalias' => '/path/to/myfolder',
        '@mysite' => 'http://mysite.com'
    ],
];

Как получить псевдоним (алиас) пути в Yii 2

Для того чтобы получить псевдоним пути в yii2 используеться метод Yii::getAlias():

echo Yii::getAlias('@myalias');                        // вернет: /path/to/myfolder
echo Yii::getAlias('@mysite');                         // вернет: http://mysite.com
echo Yii::getAlias('@myalias/other/folder/index.php'); // вернет: /path/to/myfolder/other/folder/index.php

Дополнительно о псевдонимах путей в Yii 2

Имя псевдонима

Имя псевдонима может содержать /, при этом метод Yii::getAlias() определит какая часть является именем псевдонима, а какая добавочным путем, например:

Yii::setAlias('@test', '/path/to/test');
Yii::setAlias('@test/val', '/path/to/val');
Yii::getAlias('@test/folder/index.php');  // вернет: /path/to/test/folder/index.php
Yii::getAlias('@test/val/index.php');   // вернет: /path/to/val/index.php

Если бы в строке 2 небыл определен алиас @test/val, то строка 4 вернула бы /path/to/test/val/index.php

Псевдонимы расширений

При установке расширения с помощью composer, для него автоматически задается псевдоним (путь к корневой директории расширения). Например при установке imperavi redactor (vova07/yii2-imperavi-widget), вам будет доступен псевдоним пути @vova07/imperavi (@vendor/vova07/yii2-imperavi-widget/src)