Управление ресурсами (Assets Management)

Meta
- API
Assets
- API
PackageManager
- API
Package
- API
Assets trait
- В каких элементах используется
- API

В SleepingOwlAdmin реализован достаточно гибкий механизм подключения ассетов с помощью пакета kodicms/laravel-assets - позволяющий разработчику управлять статичными ресурсами в веб-приложении, такими как каскадные таблицы стилей или javascript’ы (Данный пакет можно использовать независимо от админки)

Для работы с ассетами через элементы форм, отображения и т.д. используется trait assets, который работает через класс Meta.

API

`loadPackage`

Подключение пакетов.

static::loadPackage(string|array $packages): static

// app\Providers\AppServiceProvider

PackageManager::add('jquery')
  ->js('jquery.js', 'https://code.jquery.com/jquery-3.1.0.min.js');
  
PackageManager::add('ckeditor')
  ->css('ckeditor.css', asset('css/ckeditor.css'))
  ->js('ckeditor.js', asset('js/ckeditor.js'));
  
// Template
Meta::loadPackage(['jquery', 'ckeditor'])

`addJs`

Добавление javascript файла.

static::addJs(string $handle, string $src, array|string $dependency = null, bool $footer = false): static

Аргументы

$handle string - Ключ ассета (При указании существующего ключа, будет заменен существующий ассет)
$src string - Путь до фала (URL)
$dependency array|string - Зависимости (Зависимости определяются по ключу в $handle. Т.е. если у вас подключен jquery и вам необходимо подключить свой скрипт только после него, то вы указываете его в качестве зависимости, это же правило распространяется на пакеты)
$footer bool - будет помечен для вывода в футере

`addJsElixir`

Добавление javascript файла c версионностью

static::addJsElixir(string $filename = 'js/app.js', string|array $dependency = null, bool $footer = false): static

`removeJs`

Удаление javascript файла. Если параметр $handle не передан, будут удалены все javascript

static::removeJs(string $handle = null): static

`addCss`

Добавление css файла.

static::addCss(string $handle, string $src, array|string $dependency = null, array $attributes = []): static

Аргументы

$handle string - Ключ ассета (При указании существующего ключа, будет заменен существующий ассет)
$src string - Путь до фала (URL)
$dependency array|string - Зависимости (Зависимости определяются по ключу в $handle. Т.е. если у вас подключен jquery и вам необходимо подключить свой скрипт только после него, то вы указываете его в качестве зависимости, это же правило распространяется на пакеты)
$attributes array - Дополнительные атрибуты (['rel' => 'stylesheet', 'media' => 'all'])

`addCssElixir`

Добавление css файла c версионностью

static::addCssElixir(string $filename = 'css/all.css', string|array $dependency = null, array $attributes = []): static

`removeCss`

Удаление css файла. Если параметр $handle не передан, будут удалены все javascript

static::removeCss(string $handle = null): static

`putVars`

Вывод в шаблон javascript переменной.

static::putVars(string|array $key, mixed $value = null): static

Meta::putVars(['key' => 'value', 'key1' => ['data]])
// or

Meta::putVars('key', ['data'])

<script>
window.key = 'value';
</script>

`removeVars`

Удаление всех добавленных в стек данных

static::removeVars(): static

`setTitle`

Указание заголовка <title>...</title>

static::setTitle(string $title): static

Meta::setTitle('SleepingOwl Admin')

`setMetaDescription`

Указание описание <meta name="description" content="...">

static::setMetaDescription(string $description): static

`setMetaKeywords`

Указание ключевых слов <meta name="keywords" content="...">

static::setMetaKeywords(array|string $keywords): static

`setMetaRobots`

<meta name=“robots” content=“...”>

static::setMetaRobots(string $robots): static

`setMetaData`

Указание метаданных через класс реализующий интерфейс KodiCMS\Assets\Contracts\MetaDataInterface

title
description
keywords
robots

static::setMetaData(\KodiCMS\Assets\Contracts\MetaDataInterface $data): static

`addSocialTags`

Добавление тегов для соц. сетей через класс, реализующий интерфейс KodiCMS\Assets\Contracts\SocialMediaTagsInterface

static::addSocialTags(\KodiCMS\Assets\Contracts\SocialMediaTagsInterface $socialTags): static

`setFavicon`

Указание favicon для страницы <link rel=".." href=".." type="image/x-icon" />

static::setFavicon(string $url, string $rel = 'shortcut icon'): static

`addMeta`

Добавление meta тега

static::addMeta(array $attributes, string $group = null): static

Аргументы

$group string - Ключ элемента в группе

Meta::addMeta(['name' => 'description', 'content' => 'hello world']) // <meta name="description" content="hello world">

`addTagToGroup`

Добавление HTML тега в группу. По умолчанию все meta теги (favicon, description, keywords) создаваемые через класс Meta после генерации в html добавляются в группу с ключом meta

static::addTagToGroup(string $handle, string $content, array $params = [], string|array $dependency = null): static

Аргументы

$handle string - Ключ элемента в группе
$content string - HTML код <meta name=":name" content=":description" />
$params array - Параметры для замены. ([':name' => $name, ':description' => 'My super description'])
$dependency array|string - Зависимости (Зависимости определяются по ключу в $handle. Т.е. если у вас подключен jquery и вам необходимо подключить свой скрипт только после него, то вы указываете его в качестве зависимости, это же правило распространяется на пакеты)

Meta::addTagToGroup('favicon', '<link rel=":rel" href=":url" type=":type" />', [
 ':url' => $url,
 ':rel' => $rel,
 ':type' => $type
])

`removeFromGroup`

Удаление HTML тега из группы.

static::removeFromGroup(string $handle): static

`assets`

Получение объекта KodiCMS\Assets\Assets

static::removeFromGroup(string $handle): static

Assets

KodiCMS\Assets\Assets

Класс Assets является хранилищем списка css, javascript, vars и groups.

Класс Meta при добавлении ассетов использует данный класс в качестве хранилища.

API

`packageManager`

Получение объекта KodiCMS\Assets\PackageManager

static::removeFromGroup(string $handle): static

PackageManager

KodiCMS\Assets\PackageManager extends Collection

Менеджер пакетов. Пакет представляет из себя набор ассетов (javascript и css), которые объединены в одну группу, доступную по имени.

Пример инициализации

// app\Providers\AppServiceProvider.php

...
public function boot() 
{
    PackageManager::add('custom')
        ->css('extend', asset('css/custom.css'))
        ->js('extend', asset('js/custom.js'));
}

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

$ php artisan assets:packages

API

`add`

Добавление нового пакета

static::add(KodiCMS\Assets\Contracts\PackageInterface|string $package): return KodiCMS\Assets\Contracts\PackageInterface

`load`

Загрузка объекта пакета

static::load(string $name): return KodiCMS\Assets\Contracts\PackageInterface|null

Package

KodiCMS\Assets\Package extends Collection

Пакет (контейнер) для хранения ассетов

API

`with`

Добавить зависимость от других пакетов (Будут загружены автоматически при подключении пакета в шаблон)

static::with(array|...$packages): static

`js`

Добавление javascript файла.

static::js(string $handle, string $src, array|string $dependency = null, bool $footer = false): static

Аргументы

$handle string - Ключ ассета (При указании существующего ключа, будет заменен существующий ассет)
$src string - Путь до фала (URL)
$dependency array|string - Зависимости (Зависимости определяются по ключу в $handle. Т.е. если у вас подключен jquery и вам необходимо подключить свой скрипт только после него, то вы указываете его в качестве зависимости, это же правило распространяется на пакеты)
$footer bool - будет помечен для вывода в футере

`css`

Добавление css файла.

static::css(string $handle, string $src, array|string $dependency = null, array $attributes = []): static

Аргументы

$handle string - Ключ ассета (При указании существующего ключа, будет заменен существующий ассет)
$src string - Путь до фала (URL)
$dependency array|string - Зависимости (Зависимости определяются по ключу в $handle. Т.е. если у вас подключен jquery и вам необходимо подключить свой скрипт только после него, то вы указываете его в качестве зависимости, это же правило распространяется на пакеты)
$attributes array - Дополнительные атрибуты (['rel' => 'stylesheet', 'media' => 'all'])

Assets trait

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

Допустим у нас есть класс Form\Element\Select

class Select extends ... implements \SleepingOwl\Admin\Contracts\Initializable
{
  use \SleepingOwl\Admin\Traits\Assets;

  public function __construct()
  {
    // Инициализация пакета для хранения ассетов
    $this->initializePackage();

    ...
  }

  public function initialize()
  {
    // подключение ассетов в шаблон
    $this->includePackage();

    ...
  }

  ...
}

При подключении трейта класс инициализирует новый пакет через PackageManager с названием текущего класса, т.е. для класса выше это будет PackageManager::add('Form\Element\Select') и при вызове методов трейта withPackage, addScript и addStyle мы добавляем новые ассеты в данный пакет.

Как мы знаем метод initialize в классе Form\Element\Select будет вызван только в момент подключение элемента в форму, а вместе с ним и ассеты.

В каких элементах используется

Display
DisplayColumn
ColumnFilter
Form
FormElement

API

addStyle

Добавленме css файла в пакет

$element->addStyle(string $handle, string $style, array $attributes): static

// Пример
$element->addStyle('cystom-style', asset('css/style.css'));

Аргументы

$handle string - Ключ ассета (При указании существующего ключа, будет заменен существующий ассет)
$style string - Путь до фала (URL)
$attributes array - Дополнительные атрибуты (['rel' => 'stylesheet', 'media' => 'all'])

addScript

Добавленме js файла в пакет

$element->addScript(string $handle, string $script, array $dependency): static

// Пример
$element->addScript('custom-script', asset('js/app.js'), ['jquery-2.0']);
$element->addScript('jquery-2.0', 'https://ajax.googleapis.com/ajax/libs/jquery/2.2.4/jquery.min.js');

Аргументы

$handle string - Ключ ассета (При указании существующего ключа, будет заменен существующий ассет)
$script string - Путь до фала (URL)
$dependency array|string - Зависимости (Зависимости определяются по ключу в $handle. Т.е. если у вас подключен jquery и вам необходимо подключить свой скрипт только после него, то вы указываете его в качестве зависимости)

withPackage

Подключение пакета Package

$element->withPackage(string|array $packages): static

// Пример
$element->withPackage(['custom', 'ckeditor']);

Files

assets.md

Latest commit

History

assets.md

File metadata and controls

Управление ресурсами (Assets Management)

Meta

API

loadPackage

addJs

Аргументы

addJsElixir

removeJs

addCss

Аргументы

addCssElixir

removeCss

putVars

removeVars

setTitle

setMetaDescription

setMetaKeywords

setMetaRobots

setMetaData

addSocialTags

setFavicon

addMeta

Аргументы

addTagToGroup

Аргументы

removeFromGroup

assets

Assets

API

packageManager

PackageManager

API

add

load

Package

API

with

js

Аргументы

css

Аргументы

Assets trait

В каких элементах используется

API

addStyle

Аргументы

addScript

Аргументы

withPackage

`loadPackage`

`addJs`

`addJsElixir`

`removeJs`

`addCss`

`addCssElixir`

`removeCss`

`putVars`

`removeVars`

`setTitle`

`setMetaDescription`

`setMetaKeywords`

`setMetaRobots`

`setMetaData`

`addSocialTags`

`setFavicon`

`addMeta`

`addTagToGroup`

`removeFromGroup`

`assets`

`packageManager`

`add`

`load`

`with`

`js`

`css`