Справка

Части

Список частей

Так может выглядеть список частей модуля:

Вверху экрана частей расположен поиск по всем частям и обработчикам модуля.

Части делятся на следующие группы:

  • Части модуля для обработки URL. Вызываются по определённому URL из адресной строки браузера. Могут быть привязаны к определённому URL, либо к таблице объектов с полем URL. В этом случае часть будет иметь "текущий объект" для работы с ним (например, текущая открытая страница).
  • Вспомогательные части
  • Виджеты / Блоки
  • Действия / Обработчики. Части, которые можно запустить из страницы модуля, либо запускаются автоматически по таймеру. Могут быть связаны с определённым экземпляром модуля, либо же перебирать все экземпляры по мере выполнения.
  • Действия для строк/рядов.Части, которые вызываются над объектом, либо над группой объектов.
  • Обработка импорта

Внутри группы части могут подчиняться друг другу, составляя иерархичную структуру:

Подробнее о типах частей и их роли в разработки модуля можно почитать в разделе "Архитектура".

В колонке "Название" указано имя части, а также её специальное имя и связь с таблицей (если установлена).

Перед названием может отображаться пиктограмма части (для действий над объектами).

Кроме этого можно увидеть следующие иконки:

  • Показывает связь части с таблицей
  • Показывает дочерние части
  • Часть является глобальной (доступна из других модулей)
  • Часть вызывается с правами суперпользователя, либо одной из групп модуля
  • Для запуска части используется условие (см.ниже)
  • Текущий объект части переопределён (см.ниже)

В колонке URL (присутствует на URL-частях) отображается постоянный URL адрес части.

В колонке "Раздел" (для частей-действий) указан связанный раздел, либо статус перебираемого раздела (если установлено соответствующее значение).

В колонке "Автозапуск" (для частей-действий) указано время или интервал автозапуска.

В колонке действий можно увидеть стандартные "удалить" и "изменить", а кроме этого:

  • Содержимое (исходный код на языке шаблонов Е5)
  • Содержимое на языке PHP
  • Входящие переменные части (для визуального редактора)
  • Кнопка запуска части-действия
  • Кнопка настройки автозапуска (таймера) для части-действия
  • Кнопка настройки автозапуска (таймер активен)
  • Переопределить часть родительского модуля
  • Перейти к истории изменения части

Форма добавления части

Название. Указывайте название, отражающее суть работы части.

Уникальное спец. название на английском. Правила составления смотрите тут.

Язык. Язык шаблонов Е5 или PHP.

Тип. Тип части - базовый, виджет, обработчик (обычный / импорта / объекта).

Видимость. Локальная или глобальная (локальная - только внутри модуля). Используйте глобальную видимость для блоков, которые планируются использовать в других модулях.

Связь с таблицей. Таблица, с которой связана часть (с объектом которого она работает).

Владелец. Часть, которой будет подчинена текущая часть. Можно использовать для упорядочивания частей, а также для разбора URL вложенной структуры.

Связь с разделом (для запуска обработчика). Определяет текущий раздел части (cex), либо позволяет выбрать "перебирать все разделы".

Опорный элемент (текущий объект части cow). Определяет текущий объект части (перед выбором объекта нужно выбрать экземпляр модуля из которого планируется брать объект).

Участвует в разборе URL:

  • По точному совпадению. Запускает часть в том случае, если аппендикс URL совпал с значением из поля "Вызывается по URL"
  • По совпадению с URL объекта. Запускает часть в том случае, если аппендикс URL совпал с URL одного из объектов связанной таблицы (поддерживаются вложенные объекты, вложенные URL). Также допускается статический префикс URL.
  • По условию для запуска. Часть запускается в том случае, если выполнено условие, записанное в соответствующее поле. Также лопускается статический префикс URL.
  • Как главная часть. Запускается в том случае, если аппендикс URL пустой, либо под разбор не попала ни одна из частей предыдущего типа.
  • Запускается в случае, если не подошли остальные части. Работает только в том случае, если в модуле нет главных частей.

Дополнительные параметры формы добавления

Условие для запуска. Условие, в формате условий языка шаблонов Е5. Если условие указано, то часть будет запущена (или примет участие в URL-разборе) только в том случае, если условие выполняется.

Связанная папка. Позволяет указать связанную папку (или несколько папок), содержимое которой будет экспортироваться/обновляться вместе с модулем.

Права доступа. Позволяет установить группу пользователей (или суперпользователя), с правами которой часть будет запущена. Таким образом можно создавать группы доступа ориентированные только на части.

Переопределение текущего объекта. Позволяет переопределить текущий объект (с которым работает часть) выражением, записанным на языке шаблонов Е5.

Сколько дополнительных сегментов отрезать от URL. Если часть использует аппендикс URL для своих внутренних нужд (не связанных с встроенным URL-разбором), можно указать какое количество сегментов игнорировать для передачи следующим частям/модулям.

Не проверять входящие GET переменные (для AJAX вызовов), а также разрешить вызов через ?ajax=module.ex.part. Разрешает небезопасную фильтрацию переменных части, а также её публичный вызов (для Ajax).

Настройка таймера / автозапуска

В самом верху указано время на сервере, а также дата и время последнего запуска части.

Типы автозапуска:

  • Только 1 раз в указанную дату и время
  • Запускается каждые X минут
  • Запускается каждый день в указанное время

Если часть перебирает все экземпляры, то она будет автоматически запущена такое количество раз, которое нужно для того, чтобы обойти все имеющиеся экземпляры модуля.



Читать далее про "Переменные таблицы и модуля"