SAM - Simple Asset Manager
Это простой asset manager для управления js и css файлами., (*1)
, (*2)
Возможности
- Объединять разные css и js файлы в один
- Сжимать css и js (минифицировать)
- Контролировать кэш браузера
- Компилировать asset`ы на лету в Development окружении
- Использовать удаленные js и css (например с CDN)
- Работа с inline css и js
Установка
composer require dmitrynaum/sam
Использование
В корне проекта должен находится файл настроек sam.json в котором описаны все необходимые для SAM`а параметры, (*3)
{
"devServerAddress" : "Адрес сервера на котором работает сервер компиляции ассетов на лету",
"assetBasePath" : "Базовая папка куда будут сохранены все asset`ы. Должна быть доступна из web без учета rootDir!",
"rootDir" : "Публичная папка приложения (в которую можно попасть через WEB).",
"resultMapPath" : "Путь до карты скомпилированных asset`ов ",
"assets" : {
"Название файла в который будет сохранен скомпилированный asset (app.css) является названием asset`а " : [
"Файл который будет объединен с другими и записан в app.css",
"Файл который будет объединен с другими и записан в app.css"
]
}
}
Пример sam.json, (*4)
{
"devServerAddress" : "127.0.0.1:8090",
"assetBasePath" : "build/",
"rootDir" : "public/",
"resultMapPath" : "asset/map.json",
"assets" : {
"app.css" : [
"https:///maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css",
"jquery-ui.css",
"asset/css/first.css",
"asset/css/second.css"
],
"jquery-ui.css" : [
"asset/vendor/jquery-ui/jquery-ui.css",
"asset/vendor/jquery-ui/skin.css"
]
}
}
Asset файлы сохраняются в папку которая указана в rootDir+assetBasePath. Т.е. asset app.css из примера
выше будет сохранен в public/build/app.css, (*5)
Компиляция
Есть несколько режимов компиляции asset`ов.
1. Простая компиляция. SAM просто соберет все asset`ы, (*6)
php vendor/bin/sam build
- Компиляция с минификацией. Asset`ы будут собраны и минифицированы
php vendor/bin/sam build -m
- Компиляция с заморозкой. Asset`ы будут собраны и в название результирующих файлов будут добавлены их хэши. Это помогает избежать проблем с кэшем браузера
php vendor/bin/sam build -f
- Компиляция с минификацией и заморозкой.
```
php vendor/bin/sam build -m -f
Также компилятору asset\`ов можно указать путь до `sam.json`.
php vendor/bin/sam build my_sam.json -m -f, (*7)
## Рендеринг
Для того что бы добавить asset в шаблон Вашего сайта, выполните 2 простые команды
```php
<?php
// Добавляем asset
Dmitrynaum\SAM\Asset::useCss('app.css');
// Выводим asset на страницу
echo Dmitrynaum\SAM\Asset::renderCss();
Рендеринг с атрибутами
<?php
// Добавляем asset
Dmitrynaum\SAM\Asset::useJs('app.js');
// Выводим asset на страницу
echo Dmitrynaum\SAM\Asset::renderJs(['defer']);
Удаленные ресурсы
Для использования удаленных js и css файлов Вы можете воспользоваться методами Dmitrynaum\SAM\Asset::useRemoteJs() и Dmitrynaum\SAM\Asset::useRemoteCss().
SAM не будет их нигде кэшировать, он просто обернет ссылки на ресурсы в соответствующие HTML теги, (*8)
<?php
// ...
Dmitrynaum\SAM\Asset::useJs('https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js');
Dmitrynaum\SAM\Asset::useCss('https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css');
// ...
echo Dmitrynaum\SAM\Asset::renderCss();
echo Dmitrynaum\SAM\Asset::renderJs();
inline css & js
Dmitrynaum\SAM\Asset::addInlineJs('alert("hello")');
Dmitrynaum\SAM\Asset::addInlineJs('alert("world")');
Dmitrynaum\SAM\Asset::addInlineCss('body{color:green;}');
Dmitrynaum\SAM\Asset::addInlineCss('h1{size:34px;}');
echo Dmitrynaum\SAM\Asset::renderInlineCss();
echo Dmitrynaum\SAM\Asset::renderInlineJs();
/**
* Результат работы
*
*<style>body{color:green;}
*h1{size:34px;}</style>
*
*
*/
Компиляция на лету
Для удобной разработки в SAM`е предусмотрена возможность компилировать asset`ы на лету без лишних движений., (*9)
Для этого Вам необходимо в коде Вашего приложения в Development окружении сообщить SAM`у что он должен работать в development режиме, и запустить встроенный веб сервер SAM`а., (*10)
<?php
// ...
if (App::isDevelopment()) {
Dmitrynaum\SAM\Asset::enableDevelopmentMode();
}
// ...
php vendor/bin/sam start-server
После чего все asset`ы будут доступны по адресу http://127.0.0.1:8090?asset=asset_name и каждый раз при запросе необходимого asset`а они будут компилироваться на лету., (*11)
ВНИМАНИЕ!
Не используйте встроенный сервер SAM`а в Production окружении. Это не безопасно!, (*12)
Wallogit.com
