README

publish assets (js, css etc) from vendor, support dependencies (inspired by yii2 assets)

Установка (Install)

Установка с помощью composer:

composer require it-for-free/php-simple-assets:~v0.0.1

(install via composer).

Использование (Usage)

it-for-free/php-simple-assets предоставляет два класса (it-for-free/php-simple-assets package supplies two classes):

SimpleAssetManager -- управляет зависимостями ассетов друг от друга и выводит подключенные файлы в html шаблон (manage assets dependencies and print added files into html template)
SimpleAsset -- базовый класс для описания ассетов (base class for asset definition)

Настройка SimpleAssetManager (ассета) (Configure Asset Manager)

Во время инициаллизации приложения (или до использования других возможностей данного пакета) установите путь к папке асстов (относительно корня сайта): (set base asset publish path relative to document root during your app init, or before any different usage of this package)

\ItForFree\SimpleAsset\SimpleAssetManager::$assetsPath = 'myassets/'; // default 'assets/'

-- эта директория должна быть доступной для записи ($assetsPath dir should be writable)

Создание пакета расурсов (ассета) (Asset declaration)

Определите пакет унаследовавшись от SimpleAsset (define yoor new assets with js and html paths):

namespace application\models;
use ItForFree\SimpleAsset\SimpleAsset;

/**
 *  TestAsset -- пример описания пакета ресурсов (ассета)
 *
 * @author vedro-compota
 */
class BaseAsset extends SimpleAsset
{
    public $basePath = 'JS/'; // from doc root
    public $js = [
        'myjs/basejs.js' // relative from $basePath path
    ];
    
    public $css = [
        'myjs/css/basecss.css' // relative from $basePath path
    ];
}

Также можно указать ассет с зависимостью от другого ассета, для этого заполните свойство-массив $needs полными именами классов ассетов, от которых зависит данный (You can also define dependencies from other packages by setting $needs array property):

use ItForFree\SimpleAsset\SimpleAsset;
use application\models\BaseAsset;

/**
 *  TestAsset -- пример описания пакета ресурсов (ассета)
 *
 * @author vedro-compota
 */
class TestAsset extends SimpleAsset
{
    public $basePath = 'JS/';
    public $js = [
        'myjs/test1.js',
        'myjs/test2222.js'
    ];
    
    public $css = [
        'myjs/css/my.css'
    ];
    
    public $needs = [BaseAsset::class];
}

Далее в любом месте кода, например в представлении зарегистрируем ассет (Then in any place in your code register any asset you need on page by call ::add()):

<?php
use application\models\TestAsset;
use ItForFree\SimpleAsset\SimpleAssetManager;

TestAsset::add();
?>

<div class="row">
    <div class="col ">
      <p class="lead"> Тестируем... </p>
      Js:
      <pre><?php SimpleAssetManager::printJs()  ?></pre>
      Css:
      <pre><?php SimpleAssetManager::printCss()  ?></pre>
    </div>
</div>

Это даст нам (We will get):

Js:
<pre><script type="text/javascript" src="/assets/88bdd3ea85/1542210511/js/basejs.js"></script>
<script type="text/javascript" src="/assets/0a23d877c3/1542203580/js/test1.js"></script>
<script type="text/javascript" src="/assets/0a23d877c3/1542203580/js/test2222.js"></script>
</pre>
Css:
<pre><link rel="stylesheet" type="text/css" href="/assets/88bdd3ea85/1542210511/css/basecss.css">
<link rel="stylesheet" type="text/css" href="/assets/0a23d877c3/1542203580/css/my.css">
</pre>

-- Как видно, SimpleAssetManager может выводить все зарегистрированные JS и CSS в нужном порядке. (As you can see SimpleAssetManager can print JS or Css like HTML resource tags)

javascript source maps

Вы можете добавлять пути к файлам source map (они должны заканчиваться на .map) в свойство public $js вашего класса-ассета.

(You can add paths to source map files (they should end with .map) in your asset class public $js array property.)

Тестирование

С помощью кодесепшн:

cept run unit

Связанные пакеты (Other related packages)

Смотрите компоненты SimpleMVC (Look at SimpleMVC components): https://github.com/it-for-free/SimpleMVC#%D0%BF%D0%BE%D0%BB%D0%B5%D0%B7%D0%BD%D1%8B%D0%B5-%D0%BA%D0%BE%D0%BC%D0%BF%D0%BE%D0%BD%D0%B5%D0%BD%D1%82%D1%8B

ToDo

Если некий js-файл уже лежал в папке ассета (vendor) до публикации, потом не был опубликован с другими файлами этого ассета, а затем был добавлен в список, то файл этот скопирован не будет -- проблема решена, НО необходимо переписать мок-тест на стиль, который использует клиенский код.

it-for-free / php-simple-assets

Maintainers

Details