Download the PHP package pozitronik/yii2-dynamic-attributes without Composer
On this page you can find all versions of the php package pozitronik/yii2-dynamic-attributes. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download pozitronik/yii2-dynamic-attributes
More information about pozitronik/yii2-dynamic-attributes
Files in pozitronik/yii2-dynamic-attributes
Package yii2-dynamic-attributes
Short Description Dynamic attributes for yii2 models
License GPL-3.0
Informations about the package yii2-dynamic-attributes
yii2-dynamic-attributes
Динамические атрибуты для ActiveRecord-моделей.
Установка
Предпочтительный вариант установки расширения через composer.
Выполните
или добавьте
В секцию require файла composer.json
в вашем проекте.
Миграции
Модуль хранит данные в таблицах, которые будут созданы командой
php yii migrate/up --migrationPath=@vendor/pozitronik/yii2-dynamic-attributes/migrations
список названий таблиц, создаваемых миграцией, можно посмотреть в
файле migrations/m000000_000000_create_dynamic_attributes_tables.php
.
Концепция и примеры использования
Обычно проектируя приложение, мы заранее знаем, с какими наборами данных будем работать, моделируя классы с учётом этого, например, создавая структуру БД под эти данные. Но бывают случаи, когда нужно дать пользователю самому определять набор данных прямо в рантайме.
- Как в Excel? - Как в Excel!
Этот компонент добавляет поддержку динамических атрибутов в ActiveRecord-модели ровно в два шага.
1) Добавляем алиас класса записав его в конфигурацию модели, либо динамически:
2) Добавляем трейт DynamicAttributesTrait
в вашу модель:
Теперь в экземплярах классов этой модели можно без ограничений создавать любые атрибуты:
Примеры манипуляций с динамическими атрибутами можно посмотреть в тесте tests/unit/DynamicAttributesTest.php .
Использование в search-моделях.
Чтобы использовать динамические атрибуты в поисковых моделях, нужно выполнить несколько шагов:
1) Добавить в поисковую модель трейт DynamicAttributesSearchTrait
,
2) Если требуется поддержка сортировки, добавить её в настройки сортировки,
3) Добавить поддержку фильтров в поисковый запрос.
Для п.п 2-4 написаны адаптеры, избавляющие вас от лишних телодвижений.
Теперь динамические атрибуты можно использовать в GridView абсолютно аналогично обычным атрибутам (хотя вам наверняка понадобится добавлять их к гриду динамически, но это несложно).
Ну почти...
Небольшое ограничение: при генерации html-полей для атрибутов моделей (например, для фильтров в гридах), используются имена этих атрибутов. Как видно выше, динамический атрибут может быть назван так, что ничего хорошего из его имени сгенерировать не получится.
Для решения этой проблемы, каждому динамическому атрибуту во время исполнения присваивается алиас, который используется в поисковой модели (и, соответственно, в генераторах html) вместо непосредственного имени атрибута. Это сделано, для того, чтобы максимально не напрягать разработчика, но при необходимости можно посмотреть на логику подстановок в тесте tests/unit/DynamicAttributesSearchTest.php и далее по коду.
Ограничения
- Текущая версия создавалась только для работы с PostgreSQL, и проверялась только на ней.
- На текущий момент не полностью поддерживаются структурированные типы данных (массивы и объекты). Создание и использование динамических атрибутов с такими значениями допускается, но поиск и сортировка по ним не реализованы.
Конфигурация
Запуск локальных тестов
Скопируйте tests/.env.example
в tests/.env
, и измените конфигурацию соответственно вашему локальному
окружению. Затем выполните команду php vendor/bin/codecept run
.
Тесты производительности
В конфиге codeception.yml
установите значение modules: Yii2: transaction:
в false
.
В файле tests/unit/IndexGeneratorTest.php
уберите директиву @skip
у тех тестов, которые нужно запустить.
Опционально, измените значения констант TESTING_RECORDS_CNT
и TESTING_SEARCH_REPEATS
. Чем больше их значение, тем большая выборка будет сделана для расчёта итогового результата.
Для запуска теста выполните команду php vendor/bin/codecept run tests/unit/IndexGeneratorTest.php
.
Лицензия
GNU GPL v3.0
All versions of yii2-dynamic-attributes with dependencies
pozitronik/yii2-traits Version ^1.0.0
pozitronik/yii2-badgewidget Version ^2.0.0
cusodede/yii2-default-controller Version ^1.0.0
kartik-v/yii2-widget-select2 Version ^2.2.3