floor12 / yii2-module-banner
Advanced yii2 module for banners management.
Requires
- php: >=7.0.0
- ext-zip: *
- floor12/yii2-editmodal: *
- floor12/yii2-module-files: *
- kartik-v/yii2-widget-datepicker: @dev
- kartik-v/yii2-widget-select2: @dev
- voskobovich/yii2-linker-behavior: @dev
- yiisoft/yii2: ~2.0.13
- dev-master
- 1.8.1
- 1.8.0
- 1.7.1
- 1.7.0
- 1.6.0
- 1.5.4
- 1.5.3
- 1.5.2
- 1.5.1
- 1.5.0
- 1.4.5
- 1.4.4
- 1.4.3
- 1.4.2
- 1.4.1
- 1.4.0
- 1.3.0
- 1.2.28
- 1.2.27
- 1.2.26
- 1.2.25
- 1.2.24
- 1.2.23
- 1.2.22
- 1.2.21
- 1.2.20
- 1.2.19
- 1.2.18
- 1.2.17
- 1.2.16
- 1.2.15
- 1.2.14
- 1.2.13
- 1.2.12
- 1.2.11
- 1.2.10
- 1.2.9
- 1.2.8
- 1.2.7
- 1.2.6
- 1.2.5
- 1.2.4
- 1.2.3
- 1.2.2
- 1.2.1
- 1.2.0
- 1.1.8
- 1.1.7
- 1.1.6
- 1.1.5
- 1.1.4
- 1.1.3
- 1.1.2
- 1.1.1
- 1.1.0
- 1.0.1
- 1.0.0
- 0.1.0
This package is auto-updated.
Last update: 2024-10-13 13:48:25 UTC
README
Модуль для размещения и управления баннерами и поп-ап на сайте.
На данный момент оперирует со следующими сущностями
- площадками (местами установки баннера на сайте),
- площадками для поп-ап баннеров
- непосредственно баннерами
- pop-up баннерами.
Установка
Добавление модуля в проект
Для добавления модуля выполняем команду
$ composer require floor12/yii2-module-banner
или добавляем в секцию "required" вашего файла composer.json следую строку:
"floor12/yii2-module-banner": "dev-master"
Внимание, для работы модуля необходима библиотека PHP-GD, собранная с поддержкай формата WEBP. Этот формат имеет ряд преимуществ и используется модулем для отображения баннеров для тех браузеров, которые это поддерживают.
Выполнение миграций
Для работы модуль использует модуль для работы с файлами floor12/yii2-module-files, поэтому необходимо применить миграции сразу обоих модулей. Для автоматического применения миграций из установленных в проект модулей рекомендую использовать дополнительный компонент, например fishvision/yii2-migrate.
Выполняем миграции:
$ ./yii migrate --migrationPath=@vendor/floor12/yii2-module-banner/src/migrations $ ./yii migrate --migrationPath=@vendor/floor12/yii2-module-files/src/migrations
Регистрация и конфигурирование модуля
Для дальнейшей работы необходимо зарегистрировать данный и зависимый от него модули в конфиге приложения, в секции modules
. В минимальной конфигурации регистрация модулей выглядит следующим образом:
'modules' => [ 'modules' => [ 'banner' => [ 'class' => 'floor12\banner\Module', ], 'files' => [ 'class' => 'floor12\files\Module', ], ], ] ...
При этом floor12\banner\Module
имеет дополнительный параметры для конфигурации:
administratorRole
- роль пользователей, которым доступно управление, по умолчанию содержит@
предоставляя доступ всем авторизованным пользователям;adminLayout
- алиас для лейаута админского контроллера, по умолчанию@app/views/layouts/main
;adaptiveBreakpoint
- ширина в пикселях, на которой происходит переключения баннера между мобильной и десктоп-версией, по умолчанию700
;bannersWebPath
- алиас путь к папке для html баннеров для доступа из браузера, по умолчанию@web/banners
;bannersWebRootPath
- алиас путь к папке для html баннеров относительно корня файловой системы, по умолчанию@webroot/banners
;
Последние 2 параметра необходисы только при использовании Rich HTML баннеров, загрузка которых должна происходить в виде zip архива.
Необходимый для работы модуль файлов floor12/yii2-module-files имеет ряд параметров, описанных в его документации.
Использование
Для внедрения в view-файл баннера, вызываем виджет BannerWidget
, который размещает в этом месте площадку, созданную заранее. В баннер необходимо передать place_id
- это id
площадки для размещения.
<?= floor12\banner\widgets\BannerWidget::widget(['place_id' => 1]) ?>
Если площадка не найдена, или в ней отсутствуют связанные баннеры, то виджет ничего не отобразит.
Если на одну и ту же площадку добавлено более одного активного баннера, то существуют две модели поведения. По умолчанию, баннеры будут рандомно меняться при перезагрузке страницы. Но, если в настройках площадки выбрать "слайдер", то все активные баннеры текущей площадки будут перелистываться, образуя слайдер. В настройках баннера существует атрибут как "вес". Если на данной площадке включен режим слайдера, то этот атрибут отвечает за порядок отображения баннеров в слайдере.
Для отображения pop-up баннеров, необходимо в основной layout вывести PopupWidget
, куда передать place_id
c ID площадки для pop-up
баннеров:
<?php
$this->beginBody();
echo PopupWidget::widget(['place_id' => 1]);
?>
Администрирование
По умолчанию админский контроллер доступен по адресу:
http://your-domain.com/banner/admin