Разработка:storages/taglinks

Материал из DOF

Перейти к: навигация, поиск
Плагин
Название taglinks
Тип storages


Содержание

Таблица в базе данных

taglinks - Ссылки(Линковки) тегов, связь объектов Деканата и тегов.

Подробный формат полей в таблице:

  • id - ID линка.
  • tagid - ID тега, к которому относится данная линковка
  • plugintype - Тип плагина, которому принадлежит прилинкованный объект
  • plugincode - Код плагина, которому принадлежит прилинкованный объект
  • objectid - ID прилинкованного объекта
  • sortname - ПОле для сортировки записей
  • departmentid - ID подразделения, к которому принадлежит линковка
  • infotext - Информация о линке
  • infoserial - Сериализованный объект с опциями объекта линка
  • date - Дата создания линковки
  • updatemark - Метка актуальности линковки
  • status - Статус линковки

API

link_tag($tagid, $plugintype, $plugincode, $objectid, $departmenid = 0, $manualoptions = null,$updatemark = null)

Метод для линковки объекта к тегу. Вызывает map функцию класса тега и в зависимости от результата работы этой функции производит действия над линком, удаляя, обновляя или создавая его.

Аргументы:

  • $tagid(object) - ID тега
  • $plugintype(string) - тип плагина, которому принадлежит объект
  • $plugincode(string) - код плагина, которому принадлежит объект
  • $objectid(int) - id объекта для линка
  • $departmenid(int) - id подразделения
  • $manualoptions(object) - опции для ручного линка
  • $updatemark(int) - время начала процедуры линковки

Возвращаемые значения:

  • string - сообщение о выполненных действиях

unlink_tag_manual($taglinkid)

Принудительная отлинковка объекта от тега.

Аргументы:

  • $taglinkid(int) - ID линка

Возвращаемые значения:

  • boolean - false в случае ошибки, true в случае успеха

rescan_taglinks($tagid, $depid = 0, $updatemark = null, $limit = 0, $continue = null)

Самостоятельное сканирование справочников для тега и обновление выборки

Аргументы:

  • id $tagid - ID тега, для которого будет проведено обновление
  • id $depid - ID подразделения
  • int $updatemark - время начала обновления для отбора устаревших линков
  • int $limit - лимит записей для сканирования
  • object $continue - объект с данными для продолжения прерванного сканирования

Возвращаемые значения:

  • @return bool - false в случае ошибки, true в случае успешного завершения

get_list_taglinks($filters, $order = 0, $limitfrom = 0, $limitnum = 0)

Получить отфильтрованный список линковок. Метод предназначен для получения массива линковок.Значения фильтров берутся из ключей массива

Аргументы:

  • $filters(object) - объект с параметрами, по которым идет отбор линковок
  • -> tagid(int|array) - маcсив ID тегов (или один ID), к которым принадлежат возвращаемые линковки
  • -> departmentid(int|array) - маcсив подразделений(или одно подразделение), к которым принадлежат возвращаемые линковки
  • -> status(str|array) - маcсив статусов(или один статус), которые могут иметь возвращаемые линковки
  • $order(int) - сортировка, 0 - прямая, 1 - обратная
  • $from(int) - смещение выборки
  • $limit(int) - чосло строк (0 - все строки)

Возвращаемые значения:

  • array - массив линковок, хранящихся в БД, отфильтрованный и отсортированный

Планы:

События

В этом разделе описан список всех событий, которые генерируются, перехватываются и обрабатываются этим плагином.

Перехватываемые события

Генерируемые события

Личные инструменты