Класс yii\web\AssetManager

AssetManager управляет конфигурацией и загрузкой пакетов ресурсов.

AssetManager настраивается как компонент приложения в yii\web\Application по умолчанию. Вы можете получить доступ к этому экземпляру через Yii::$app->assetManager.

Вы можете изменить его конфигурацию, добавив массив в вашу конфигурацию приложения в components, как показано в следующем примере:

'assetManager' => [
    'bundles' => [
        // you can override AssetBundle configs here
    ],
]

Для получения более подробной информации и справочных данных по AssetManager, см. статью справочника по ресурсам.

Публичные свойства

Публичные методы

Защищенные методы

Подробное описание свойств

$afterCopy общедоступное свойство

Обратный вызов PHP, который вызывается после успешного копирования поддиректории или файла. Этот параметр используется только при публикации директории. Подпись обратного вызова такая же, как у $beforeCopy. Этот параметр передаётся в качестве параметра afterCopy к yii\helpers\FileHelper::copyDirectory().

public callback $afterCopy = null

$appendTimestamp общедоступное свойство (доступно с версии 2.0.3)

Добавлять ли отметку времени к URL каждого опубликованного ресурса. Если это true, URL опубликованного ресурса может выглядеть как /path/to/asset?v=timestamp, где timestamp — последняя метка времени изменения опубликованного файла ресурса. Обычно вы захотите установить это свойство в true, когда вы включили кэширование HTTP для ресурсов, потому что это позволяет вам сбросить кэш, когда ресурсы обновляются.

public boolean $appendTimestamp = false

$assetMap общедоступное свойство

Сопоставление исходных файлов ресурсов (ключи) с целевыми файлами ресурсов (значения).

Это свойство предназначено для поддержки исправления неверных путей к файлам ресурсов в некоторых пакетах ресурсов. Когда пакет ресурсов регистрируется в представлении, каждый относительный файл ресурса в массивах css и js будет проверен по этому отображению. Если какой-либо из ключей будет найден в качестве последней части имени файла ресурса (который префиксруется с yii\web\AssetBundle::$sourcePath, если доступно), соответствующее значение заменит ресурс и будет зарегистрировано в представлении. Например, файл ресурса my/path/to/jquery.js соответствует ключу jquery.js.

Обратите внимание, что целевые файлы ресурсов должны быть абсолютными URL, URL, относящимися к домену (начинающимися с '/'), или путями, относительными к $baseUrl и $basePath.

В следующем примере любые ресурсы, заканчивающиеся на jquery.min.js будут заменены на jquery/dist/jquery.js , которое относительно $baseUrl и $basePath.

[
    'jquery.min.js' => 'jquery/dist/jquery.js',
]

Вы также можете использовать псевдонимы при указании значения отображения, например:

[
    'jquery.min.js' => '@web/js/jquery/jquery.js',
]

public array $assetMap = []

$basePath общедоступное свойство

Корневой каталог, хранящий опубликованные файлы ресурсов.

public string $basePath = '@webroot/assets'

$baseUrl общедоступное свойство

Базовый URL, через который можно получить доступ к опубликованным файлам ресурсов.

public string $baseUrl = '@web/assets'

$beforeCopy общедоступное свойство

Обратный вызов PHP, который вызывается перед копированием каждой подпапки или файла. Этот параметр используется только при публикации каталога. Если обратный вызов возвращает false, операция копирования подкаталога или файла будет отменена.

Подпись обратного вызова должна быть: function ($from, $to), где $from — подкаталог или файл, подлежащий копированию, а $to — целевой каталог копирования.

Это передаётся как параметр beforeCopy в yii\helpers\FileHelper::copyDirectory().

public callback $beforeCopy = null

$bundles общедоступное свойство

Список конфигураций пакетов ресурсов. Это свойство предназначено для настройки пакетов ресурсов. Когда пакет загружается с помощью getBundle(), если здесь указана соответствующая конфигурация, она будет применена к пакету.

Ключи массива — имена пакетов ресурсов, которые обычно являются именами классов пакетов ресурсов без ведущей косой черты. Значения массива — соответствующие конфигурации. Если значение равно false, это означает, что соответствующий пакет ресурсов отключен, и getBundle() должен возвращать null.

Если это свойство имеет значение false, это означает, что вся функция пакетов ресурсов отключена, и getBundle() всегда будет возвращать null.

Следующий пример демонстрирует, как отключить файл bootstrap css, используемый виджетами Bootstrap (потому что вы хотите использовать собственные стили):

[
    'yii\bootstrap\BootstrapAsset' => [
        'css' => [],
    ],
]

public array|boolean $bundles = []

$converter общедоступное свойство

Конвертер ресурсов.

public yii\web\AssetConverterInterface getConverter ( )
public void setConverter ( $value )

$dirMode общедоступное свойство

Разрешения, которые должны быть установлены для вновь созданных каталогов ресурсов. Это значение будет использоваться функцией PHP chmod(). Установка umask не производится. По умолчанию равно 0775, что означает, что каталог читаем и записываем владельцем и группой, но только для чтения другими пользователями.

public integer $dirMode = 0775

$fileMode общедоступное свойство

Разрешения, которые должны быть установлены для вновь опубликованных файлов ресурсов. Это значение будет использоваться функцией PHP chmod(). Установка umask не производится. Если не указано, разрешения будут определены текущей средой.

public integer $fileMode = null

$forceCopy общедоступное свойство

Следует ли скопировать каталог, подлежащий публикации, даже если он найден в целевом каталоге. Этот параметр используется только при публикации каталога. Вы можете установить его в true во время разработки, чтобы убедиться, что опубликованный каталог всегда является актуальным. Не устанавливайте это значение в true на серверах производства, так как это значительно снизит производительность.

public boolean $forceCopy = false

$hashCallback общедоступное свойство (доступно с версии 2.0.6)

Обратный вызов, который будет вызван для создания хэша для генерации каталога ресурсов. Подпись обратного вызова должна быть следующей:

function ($path)

где $path — путь к ресурсу. Обратите внимание, что $path может быть либо каталогом, где находятся файлы ресурсов, либо одним файлом. Для файла CSS, использующего относительный путь в url(), реализация хэша должна использовать путь к каталогу файла вместо пути к файлу, чтобы включить относительные файлы ресурсов в копирование.

Если это не указано, менеджер ресурсов будет использовать по умолчанию CRC32 и filemtime в методе hash.

Пример реализации с использованием хэша MD4:

function ($path) {
    return hash('md4', $path);
}

public callable $hashCallback = null

$linkAssets общедоступное свойство

Использовать ли символические ссылки для публикации файлов ресурсов. По умолчанию false, что означает, что файлы ресурсов копируются в $basePath. Использование символических ссылок имеет преимущество, что опубликованные ресурсы всегда будут согласованы с исходными ресурсами, и не требуется операция копирования. Это особенно полезно во время разработки.

Однако существуют особые требования к средам хостинга для использования символических ссылок. В частности, символические ссылки поддерживаются только в Linux/Unix и Windows Vista/2008 или более поздних версиях.

Кроме того, некоторые веб-серверы должны быть должным образом сконфигурированы, чтобы связанные ресурсы были доступны пользователям веб-сайта. Например, для веб-сервера Apache необходимо добавить следующую директиву конфигурации для веб-каталога:

Options FollowSymLinks

public boolean $linkAssets = false

Подробное описание методов