Spec-Zone.ru › Yii 2.0

Класс yii\web\AssetBundle

Все классы | Свойства | Методы
Наследование yii\web\AssetBundle » yii\base\Object
Реализует yii\base\Configurable
Подклассы yii\apidoc\templates\bootstrap\assets\AssetBundle, yii\apidoc\templates\bootstrap\assets\HighlightBundle, yii\apidoc\templates\bootstrap\assets\JsSearchAsset, yii\authclient\widgets\AuthChoiceAsset, yii\authclient\widgets\AuthChoiceStyleAsset, yii\bootstrap\BootstrapAsset, yii\bootstrap\BootstrapPluginAsset, yii\bootstrap\BootstrapThemeAsset, yii\captcha\CaptchaAsset, yii\debug\DebugAsset, yii\debug\TimelineAsset, yii\debug\UserswitchAsset, yii\gii\GiiAsset, yii\gii\TypeAheadAsset, yii\grid\GridViewAsset, yii\jui\DatePickerLanguageAsset, yii\jui\JuiAsset, yii\validators\PunycodeAsset, yii\validators\ValidationAsset, yii\web\JqueryAsset, yii\web\YiiAsset, yii\widgets\ActiveFormAsset, yii\widgets\MaskedInputAsset, yii\widgets\PjaxAsset
Доступен с версии 2.0
Исходный код https://github.com/yiisoft/yii2/blob/master/framework/web/AssetBundle.php

AssetBundle представляет собой набор файлов ресурсов, таких как CSS, JS и изображения.

Каждый пакет ресурсов имеет уникальное имя, которое глобально идентифицирует его среди всех пакетов ресурсов, используемых в приложении. Имя — это полное имя класса класса, представляющего его.

Пакет ресурсов может зависеть от других пакетов ресурсов. При регистрации пакета ресурсов в представлении все его зависимые пакеты будут автоматически зарегистрированы.

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

Свойства Public

Свойство Тип Описание Определено в
$basePath string Веб-доступная директория, содержащая файлы ресурсов в этом пакете. yii\web\AssetBundle
$baseUrl string Базовый URL для относительных файлов ресурсов, перечисленных в $js и $css. yii\web\AssetBundle
$css array Список файлов CSS, содержащихся в этом пакете. yii\web\AssetBundle
$cssOptions array Параметры, которые будут переданы в yii\web\View::registerCssFile() при регистрации файлов CSS в этом пакете. yii\web\AssetBundle
$depends array Список имен классов пакетов, от которых зависит этот пакет. yii\web\AssetBundle
$js array Список файлов JavaScript, содержащихся в этом пакете. yii\web\AssetBundle
$jsOptions array Параметры, которые будут переданы в yii\web\View::registerJsFile() при регистрации файлов JS в этом пакете. yii\web\AssetBundle
$publishOptions array Параметры, которые будут переданы в yii\web\AssetManager::publish() при публикации пакета ресурсов. yii\web\AssetBundle
$sourcePath string Директория, содержащая исходные файлы ресурсов для этого пакета ресурсов. yii\web\AssetBundle

Методы Public

Метод Описание Определено в
__call() Вызывает именованный метод, который не является методом класса. yii\base\Object
__construct() Конструктор. yii\base\Object
__get() Возвращает значение свойства объекта. yii\base\Object
__isset() Проверяет, установлено ли свойство, т. е. определено и не равно null. yii\base\Object
__set() Устанавливает значение свойства объекта. yii\base\Object
__unset() Устанавливает свойство объекта в null. yii\base\Object
canGetProperty() Возвращает значение, указывающее, можно ли считать свойство. yii\base\Object
canSetProperty() Возвращает значение, указывающее, можно ли установить свойство. yii\base\Object
className() Возвращает полное имя этого класса. yii\base\Object
hasMethod() Возвращает значение, указывающее, определён ли метод. yii\base\Object
hasProperty() Возвращает значение, указывающее, определено ли свойство. yii\base\Object
init() Инициализирует пакет. yii\web\AssetBundle
publish() Опубликует пакет ресурсов, если его исходный код не находится в веб-доступной директории. yii\web\AssetBundle
register() Регистрирует этот пакет ресурсов в представлении. yii\web\AssetBundle
registerAssetFiles() Регистрирует файлы CSS и JS с заданным представлением. yii\web\AssetBundle

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

$basePath public property

Веб-доступная директория, содержащая файлы ресурсов в этом пакете.

Если $sourcePath установлен, это свойство будет перезаписано yii\web\AssetManager при публикации файлов ресурсов из $sourcePath.

Вы можете использовать либо директорию, либо псевдоним директории.

public string $basePath = null

$baseUrl public property

Базовый URL для относительных файлов ресурсов, перечисленных в $js и $css.

Если $sourcePath установлен, это свойство будет перезаписано yii\web\AssetManager при публикации файлов ресурсов из $sourcePath.

Вы можете использовать либо URL, либо псевдоним URL.

public string $baseUrl = null

$css public property

Список файлов CSS, содержащихся в этом пакете. Каждый файл CSS может быть указан в одном из трёх форматов, как описано в $js.

Обратите внимание, что в качестве разделителя директорий должен использоваться только прямой слэш "/".

public array $css = []

$cssOptions public property

Параметры, которые будут переданы в yii\web\View::registerCssFile() при регистрации файлов CSS в этом пакете.

public array $cssOptions = []

$depends общее свойство

Список имен классов пакетов, от которых зависит этот пакет.

Например:

public $depends = [
   'yii\web\YiiAsset',
   'yii\bootstrap\BootstrapAsset',
];
public array $depends = []

$js общее свойство

Список файлов JavaScript, которые содержит этот пакет. Каждый файл JavaScript может быть указан в одном из следующих форматов:

  • абсолютный URL, представляющий внешний ресурс. Например, http://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js или //ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js.
  • относительный путь, представляющий локальный ресурс (например, js/main.js). Фактический путь к локальному ресурсу может быть определен путём добавления $basePath к относительному пути, а фактический URL ресурса может быть определен путём добавления $baseUrl к относительному пути.
  • массив, где первым элементом является URL или относительный путь, как описано выше, и список пар ключ => значение, которые будут использованы для перезаписи настроек $jsOptions для этого элемента. Эта функциональность доступна начиная с версии 2.0.7.

Обратите внимание, что в качестве разделителя каталогов должен использоваться только прямой слэш "/".

public array $js = []

$jsOptions общее свойство

Параметры, которые будут переданы в yii\web\View::registerJsFile() при регистрации файлов JS в этом пакете.

public array $jsOptions = []

$publishOptions общее свойство

Параметры, которые будут переданы в yii\web\AssetManager::publish() при публикации пакета ресурсов. Это свойство используется только тогда, когда установлено $sourcePath.

public array $publishOptions = []

$sourcePath общее свойство

Каталог, содержащий исходные файлы ресурсов для этого пакета ресурсов. Исходный файл ресурса — это файл, который является частью репозитория исходного кода вашего веб-приложения.

Вы должны установить это свойство, если каталог, содержащий исходные файлы ресурсов, недоступен по сети. Установив это свойство, yii\web\AssetManager автоматически опубликует исходные файлы ресурсов в каталог, доступный по сети, когда пакет ресурсов зарегистрирован на странице.

Если вы не устанавливаете это свойство, это означает, что исходные файлы ресурсов находятся в $basePath.

Вы можете использовать либо каталог, либо псевдоним каталога.

См. также $publishOptions.

public string $sourcePath = null

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

init() общественный метод

Инициализирует пакет.

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

public void init ( )

publish() общественный метод

Опубликовывает пакет ресурсов, если его исходный код не находится в каталоге, доступном по сети.

Также будет пытаться преобразовать файлы, не являющиеся CSS или JS (например, LESS, Sass), в соответствующие файлы CSS или JS с помощью конвертера ресурсов.

public void publish ( $am )
$am yii\web\AssetManager

Менеджер ресурсов для выполнения публикации ресурсов

register() общественный статический метод

Регистрирует этот пакет ресурсов в представлении.

public static static register ( $view )
$view yii\web\View

Представление, с которым нужно зарегистрировать

return static

Зарегистрированный экземпляр пакета ресурсов

registerAssetFiles() общественный метод

Регистрирует файлы CSS и JS в данном представлении.

public void registerAssetFiles ( $view )
$view yii\web\View

Представление, с которым нужно зарегистрировать файлы ресурсов.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-web-assetbundle.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API