Онлайн-руководство разработчика NetCat
Модуль «Поиск по сайту» 12.2.1Начало работы с модулем 12.2.2Язык запросов 12.2.3Способы хранения индекса 12.2.4Интерфейс модуля в панели управления сайтом 12.2.5Области индексирования 12.2.6Области HTML-страниц 12.2.7Области поиска на сайте 12.2.8Индексирование по расписанию, запуск индексирования в фоновом режиме 12.2.9Правила индексирования 12.2.10Постановка задачи переиндексирования в очередь 12.2.11Интеграция модуля в макеты дизайна сайта 12.2.12Простая форма поиска 12.2.13Расширенная форма поиска 12.2.14Вывод результатов поиска 12.2.15Стилизация списка подсказок 12.2.16Расширенные настройки 12.2.17Разработка расширений модуля 12.2.18Обзор архитектуры модуля 12.2.19Обработчики документов различных типов 12.2.20Текстовые фильтры 12.2.21Анализаторы текста 12.2.22Корректировщики запросов 12.2.23Подключение других поисковых систем 12.2.24Решение проблем с поиском 12.2.25Решение проблем с индексированием 12.2.26Справочник API

Система событий

Основная идея системы событий заключается в возможности отслеживания базовых действий в системе. Это может быть добавление или изменение сайта, удаление раздела и проч.

Система генерирует событие по факту. Например, удаление раздела — это запрос к базе данных на удаление записи. Это и есть событие. При этом все так называемые слушатели (подписчики на событие) получат необходимые данные о его совершении. Подписчики назначаются при подключении модуля или библиотеки.

Важно: событие генерируется после обновления системной информации в базе данных. Если событие связано с удалением объекта, будет абсолютно бессмысленно пытаться получить данные об объекте после его удаления.

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

У каждого события есть имя (в именах могут использоваться только латинские буквы, цифры и знак подчеркивания). Имена всех системных событий строятся по шаблону:
«действиеСущность».

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

  • добавление add
  • изменение update
  • включение check
  • выключение uncheck
  • удаление drop
  • авторизация authorize

Сущности описаны в таблице ниже:

Название сущности Ключевое слово сущности
Сайт Catalogue
Раздел Subdivision
Компонент в разделе SubClass
Компонент Class
Шаблон компонента ClassTemplate
Сообщение Message
Системная таблица SystemTable
Макет дизайна Template
Пользователь User
Комментарий Comment
Виджет Widget
Модуль Module

Таким образом событие addMessage возникает при добавление нового объекта, а событие dropUser – при удалении пользователя.

Начиная с версии 5.6 для обозначения событий можно использовать константы класса nc_event. Название констант состоят из трёх частей:

  • время возникновения события:
    • до действия — BEFORE
    • после действия — AFTER
  • сущность, связанная с событием:
    • сайт — SITE
    • раздел сайта — SUBDIVISION
    • инфоблок — INFOBLOCK
    • объект (запись в инфоблоке) — OBJECT
    • системная таблица — SYSTEM_TABLE
    • компонент — COMPONENT
    • поле компонента или системной таблицы — FIELD (появилось в Netcat 6.1)
    • шаблон компонента — COMPONENT_TEMPLATE
    • макет дизайна — TEMPLATE
    • врезка макета дизайна — TEMPLATE_PARTIAL (появилось в Netcat 6.1)
    • пользователь — USER
    • модуль — MODULE
    • виджет — WIDGET
    • все модули (в момент инициализации системы) — MODULES
    • список — LIST (появилось в Netcat 6.1)
    • элемент списка — LIST_ITEM (появилось в Netcat 6.1)
  • производимое действие:
    • добавление — CREATED
    • изменение — UPDATED
    • удаление — DELETED
    • включение — ENABLED
    • выключение — DISABLED
    • загрузка — LOADED
    • вход в систему — AUTHORIZED

Таким образом, константы модуля nc_event имеют следующий вид: nc_event::BEFORE_OBJECT_DISABLED, nc_event::AFTER_COMPONENT_TEMPLATE_UPDATED, nc_event::AFTER_MODULES_LOADED и т. д.

Так как же работает система событий?

Каждое событие несёт в себе определённый набор параметров, которые могут быть использованы при его отслеживании. Например, при обновлении раздела (событие updateSubdivision) передаются параметры Catalogue_ID и Subdivision_ID, причём именно в указанной последовательности, т. к. в таком виде они попадут в функцию, вызываемую при «улавливании» события.

Ниже будет приведён более подробный пример с кодом.

Трансляция и «улавливание» событий происходит через расширение event системного объекта $nc_core. У данного расширения есть три метода, которые нас интересуют — bind(), add_listener() и execute(). Именно они отвечают за отслеживание и трансляцию событий.

Далее в разделе

Комментарии 1

У вас ошибка - событие включения не checked, а check.
   
Описание проекта