Урок, в якому познайомимося з доповненням CMS MODX Revo Collections.
Призначення і основні принципи роботи з MODX-доповненням Collections
Collections (колекції) - це компонент для CMS MODX Revolution, який приховує показ дочірніх ресурсів в дереві адмінки і організовує їх висновок в батьківському об'єкті за допомогою таблиці. Іншими словами він дозволяє перевести стандартне уявлення дочірніх ресурсів в табличний вигляд.
Здійснює це дія компонент Collection тільки для тих батьківських ресурсів, у яких в якості типу встановлено значення "Колекція". Виставлення даного значення здійснюється на вкладці "Налаштування" з розкриває списку "Тип ресурсу".
MODX Collections - Установка полю "Тип ресурсу" значення "Колекція"
Після цього, ресурс стане колекцією. і його дочірні елементи будуть відображатися вже не в дереві, а в ньому, за допомогою таблиці на відповідній вкладці.
MODX Collections - Відображення дочірніх елементів ресурсу у вигляді таблиці
У табличному поданні ресурси не тільки зручно переглядати. але і управляти ними. Це пов'язано з тим, що в таблиці ресурс (рядок) можна зобразити за допомогою будь-яких даних. а не тільки за допомогою заголовка, тобто так, як це виконано в дереві ресурсів.
Налаштування представлення колекції дочірніх ресурсів (таблиці) здійснюється на сторінці "Змінити вигляд". На цій сторінці можна не тільки налаштувати зовнішній вигляд таблиці (за допомогою створення стовпців, які будуть пов'язані з основними або TV полями ресурсу), а й багато інших параметрів.
Призначення ресурсу необхідного виду колекції здійснюється за допомогою його вибору з розкриває списку "Види Колекції". розташованої на вкладці "Налаштування" в розділі "Колекції".
Компонент Collections дозволяє також організувати ієрархічні колекції. Іншими словами він підтримує вкладеність, тобто дозволяє розташовувати всередині однієї колекції іншу. У такій структурі колекції, що мають в своєму складі інші колекції (дочірні), будуть відображені в дереві вже за звичайними правилами, і мати стандартне управління.
MODX Collections - Вкладені колекції
Ще одна перевага компонента MODX Revolution Collections. як вже було зазначено вище, пов'язано з тим, що він не відображає дочірні ресурси в дереві адмінки. Це властивість компонента Collections дозволяє не тільки дуже сильно розвантажити дерево ресурсів, але і збільшити швидкодію адмінки в цілому. Особливо це характерно для проектів налічують дуже велика кількість ресурсів.
Крім цього, додаток Collection підтримує режим Drag'n'Drop, який дозволяє додати в колекцію ресурс, який не має дітей, за допомогою простого перетягування.
Створення табличного представлення дочірніх ресурсів
Але перед тим як приступати до роботи з компонентом Collections його потрібно спочатку встановити в систему MODX Revo. Дізнатися, як здійснюється процес установки компонентів (плагінів) в MODX Revolution можна в статті "Робота з менеджером пакетів".
Як значення основних параметрів вкажемо такі значення:
Налаштування стовпців, які будуть використовуватися для формування таблиці, зробимо в нижній частині сторінки "Змінити вигляд".
При вказівці TV-полів необхідно використовувати префікс tv_.
3. Установка створеної колекції необхідним батьківським ресурсів. Здійснюється за допомогою виконання 2 кроків:
Довідка по полях сторінки "Змінити вигляд"
Поля, за допомогою яких задаються загальні налаштування колекції:
- Назва - ім'я колекції.
- Опис - поле, яке дозволяє зберегти пояснювальну інформацію про призначення цієї колекції.
- Задати як вид за замовчуванням. Значення "Так" буде означати те, що дана колекція буде встановлюватися як вид дочірніх ресурсів за замовчуванням.
- За замовчуванням для шаблонів - вказує, що цей вид необхідно використовувати за замовчуванням при створенні нової колекції, якщо вона має вказаний MODX шаблон. При необхідності вид колекції можна змінити. Здійснюється це за допомогою розкриває списку, розташованого на вкладці ресурсу "Налаштування" в секції "Колекції".
- Сортувати - вказує ім'я поля, яке буде за замовчуванням визначати порядок виведення (сортування) записів (ресурсів) таблиці.
- Напрямок сортування - задає напрямок сортування за замовчуванням.
- Розмір сторінки (при пагінацію) - визначає, яку кількість дочірніх ресурсів може бути виведено на одній сторінці.
- Дозволити масові дії - додає в таблицю прапорці для множинного вибору ресурсів і масові дії, які можна застосувати до цього вибору.
- Дозволити перетягування - дозволяє поміщати ресурси, які не мають дітей, в колекцію, шляхом їх перетягування за допомогою миші.
- Місце розташування контенту - позиція, в якій необхідно розташовувати стандартне поле ресурсу content.
- Напис вкладки - настройка назви вкладки, в якій будуть відображатися дочірні ресурси.
- Пункти контекстного меню - назва елементів, які необхідно відобразити в контекстному меню (викликається контекстне меню за допомогою натискання правої кнопки миші в області належить таблиці).
- Кнопки - список, що містить назви кнопок, які необхідно відобразити поруч із заголовком ресурсу (якщо використовується відповідний ренедерер).
Елементи, за допомогою яких задаються настройки колекції:
- Вибір типу ресурсу - додати до кнопки "Створити дочірній ресурс", що випадає, за допомогою якого можна вибрати тип створюваного ресурсу.
- Тип дочірніх ресурсів за замовчуванням - встановлює, який тип ресурсу використовувати за замовчуванням при створенні дочірніх ресурсів.
- Шаблон дочірніх ресурсів за замовчуванням - вказує, який шаблон необхідно встановлювати дочірнім ресурсів під час їх створення за замовчуванням.
- Напис кнопки створення дочірніх ресурсів - завдання необхідної написи кнопки "Створити дочірній ресурс".
- Дозволені типи ресурсів - вказує, які типи ресурсів (через кому) можна створювати за допомогою списку кнопки "Створити дочірній ресурс". якщо параметр "Вибір типу ресурсу" має значення "Так".
Назва елементів, які використовуються при створенні стовпців таблиці:
- textfield (для текстових полів).
- textarea (для текстових областей).
- modx-combo-boolean (для установки логічного значення "Так" або "Ні").
- numberfield або # 123; "type": "number field", "allowDecimals": false, "allowNegative": false # 125; (Для числових полів).
Рендерер (функції), за допомогою яких здійснюється подання даних дочірніх ресурсів в полях таблиці: