Функции модуля (__call)


НАЧАЛО >> Оглавление >> Сервер приложений ИРБИС 64/128 >> Описание модулей системы >> VirtualRef - Виртуальная справка >> Функции модуля (__call)📄 Скачать в DOCX


Функции могут быть вызваны как UseModule("VirtualRef")->function(parameter1,parameter2,...);

Имя функцииОписаниеПараметры
API_CreateСоздать вопрос через API
Подробнее... 
Создает новую запись вопроса Виртуальной справки через API, заполняет автора, дату, тему, текст вопроса, проект, начальный workflow-статус и дополнительные поля, затем сохраняет запись и возвращает ее SID.
ТипПараметрПо умолчаниюОписание
string$questionОбязательныйТекст вопроса
string$userIdОбязательныйИдентификатор пользователя, задавшего вопрос
int$datetime0Дата и время создания вопроса в формате unixtime
array$additionalFieldsarray ( )Дополнительные поля, которые необходимо добавить в запись при создании запроса. Массив имеет вид $additionalFields[field][occ-1][subfield]=value
string$projectKey''Ключ проекта VirtualRef. Если не указан, используется текущий проект из настроек модуля
string$questionTitle''Тема вопроса. Если не указана, в пользовательских списках отображается начало текста вопроса
API_GetПолучить измененные вопросы через API
Подробнее... 
Возвращает через API список вопросов, измененных после указанного времени. Если передан пользователь, отбирает только его вопросы; иначе читает записи по индексу времени изменения.
ТипПараметрПо умолчаниюОписание
int$datetime0Дата/время в формате unixtime. Получить последние запросы, начиная с этой метки времени
string$userId''Получить вопросы указанного пользователя
API_HideСкрыть ответ во внешнем личном кабинете
Подробнее... 
Помечает вопрос так, чтобы ответ больше не отображался во внешнем личном кабинете, и возвращает результат операции API.
ТипПараметрПо умолчаниюОписание
string$sidОбязательныйSID записи VirtualRef
AddWatcherДобавить наблюдателя вопроса
Подробнее... 
Добавляет указанного пользователя в список наблюдателей вопроса, если он еще не добавлен. Используется вспомогательными действиями и workflow-командами VirtualRef.
ТипПараметрПо умолчаниюОписание
ObjectDataRecord$r''Запись вопроса
string$login''Логин пользователя
ApplyRecordIndexesОбновить поисковые индексы вопроса
Подробнее... 
Перестраивает поисковые индексы вопроса: ключ, тему, проект, ответственного, наблюдателей и признаки текущего статуса.
ТипПараметрПо умолчаниюОписание
ObjectDataRecord$r''Запись вопроса
ClearProjectCacheОчистить кэш проекта Workflow
Подробнее... 
Сбрасывает локальный кэш текущего проекта Workflow, используемый модулем VirtualRef.
Отсутствуют
EnsureCurrentProjectConfigПроверить текущий проект VirtualRef
Подробнее... 
Проверяет и при необходимости сохраняет в записи модуля VirtualRef ключ текущего проекта Workflow.
ТипПараметрПо умолчаниюОписание
ObjectDataDatabase|null$db'null'Системная база данных
EnsureWorkflowScreenFileПроверить наличие файла формы workflow
Подробнее... 
Проверяет наличие файла рабочего листа, справочника или формата workflow в базе данных и при необходимости загружает стандартный файл из поставки.
ТипПараметрПо умолчаниюОписание
ObjectDataDatabase$db''База данных
string$fileName''Имя файла
bool$force'false'Признак принудительного выполнения
EnsureWorkflowScreenWsПроверить наличие рабочего листа формы workflow
Подробнее... 
Проверяет наличие рабочего листа workflow и связанных с ним справочников, необходимых для отображения формы в he3.
ТипПараметрПо умолчаниюОписание
ObjectDataDatabase$db''База данных
string$wsName''Имя рабочего листа
FormatHistoryTimeОтформатировать время истории вопроса
Подробнее... 
Преобразует дату и время события истории из внутреннего формата ИРБИС в удобный для интерфейса текст.
ТипПараметрПо умолчаниюОписание
int|string$time''Дата и время события
FormatPersonСформировать отображаемое имя пользователя
Подробнее... 
Формирует отображаемое имя человека из фамилии, имени, отчества и логина, используя логин как резервное значение.
ТипПараметрПо умолчаниюОписание
string$family''Фамилия
string$name''Имя
string$sname''Отчество
string$login''Логин пользователя
GetApiStatusIntПолучить числовой статус для API
Подробнее... 
Возвращает числовой статус для внешнего API на основе текущего workflow-статуса и его признаков.
ТипПараметрПо умолчаниюОписание
int|string$status''Статус
ObjectDataWorkflowProject|null$project'null'Проект workflow
string$projectObjectTypeKey''Ключ типа объекта проекта workflow
GetAvailableAskProjectsПолучить проекты, доступные для создания вопроса
Подробнее... 
Возвращает проекты, в которых текущий пользователь может создать новый вопрос Виртуальной справки.
Отсутствуют
GetCurrentProjectПолучить текущий проект VirtualRef
Подробнее... 
Возвращает объект текущего проекта Workflow, настроенного для работы модуля VirtualRef.
Отсутствуют
GetCurrentProjectKeyПолучить ключ текущего проекта
Подробнее... 
Возвращает ключ проекта Workflow, в котором VirtualRef создает и показывает вопросы.
ТипПараметрПо умолчаниюОписание
string$default'VREF'Ключ проекта по умолчанию
GetPersonInitialsПолучить инициалы пользователя
Подробнее... 
Возвращает инициалы пользователя для компактного отображения в аватаре.
ТипПараметрПо умолчаниюОписание
string$family''Фамилия
string$name''Имя
string$sname''Отчество
string$login''Логин пользователя
GetProjectsПолучить проекты VirtualRef
Подробнее... 
Возвращает текущий проект Workflow, доступный модулю VirtualRef, с локальным кэшированием результата.
Отсутствуют
GetQuestionIdentityConfigПолучить настройку ключа вопроса
Подробнее... 
Возвращает настройки поля, подполя и поискового префикса для человекочитаемого идентификатора вопроса VirtualRef.
ТипПараметрПо умолчаниюОписание
ObjectDataWorkflowProject|null$project'null'Проект Workflow
GetQuestionIdentityFieldПолучить поле ключа вопроса
Подробнее... 
Возвращает номер поля, в котором для записей VirtualRef хранится человекочитаемый идентификатор вопроса.
Отсутствуют
GetQuestionIdentitySubFieldПолучить подполе ключа вопроса
Подробнее... 
Возвращает код подполя, в котором для записей VirtualRef хранится человекочитаемый идентификатор вопроса.
Отсутствуют
GetQuestionSummaryПолучить краткое содержание вопроса
Подробнее... 
Возвращает краткое текстовое содержание вопроса, очищенное от HTML и ограниченное по длине.
ТипПараметрПо умолчаниюОписание
ObjectDataRecord$r''Запись вопроса
int$limit'180'Ограничение длины
GetQuestionTitleПолучить тему вопроса
Подробнее... 
Возвращает тему вопроса; если тема не заполнена, может использовать начало текста вопроса как резервное отображение.
ТипПараметрПо умолчаниюОписание
ObjectDataRecord$r''Запись вопроса
bool$useTextFallback'true'Использовать текст вопроса при пустой теме
int$limit'180'Ограничение длины
GetQuestionViewUrlСформировать ссылку на просмотр вопроса
Подробнее... 
Формирует ссылку на страницу просмотра конкретного вопроса с указанием базы, SID и источника перехода.
ТипПараметрПо умолчаниюОписание
ObjectDataDatabase|null$db''База данных
ObjectDataRecord$r''Запись вопроса
string$from''Источник перехода
GetQuestionWorkflowProjectПолучить проект Workflow вопроса
Подробнее... 
Определяет проект Workflow для записи вопроса VirtualRef по переданному ключу или по полю идентификатора в самой записи.
ТипПараметрПо умолчаниюОписание
ObjectDataRecord$r''Запись вопроса
string$projectKey''Ключ проекта Workflow
GetSystemWorkflowDefinitionFilesПолучить системные JSON Workflow
Подробнее... 
Возвращает список JSON-файлов с системной Workflow-конфигурацией, поставляемой модулем VirtualRef.
Отсутствуют
GetUserInfoПолучить данные пользователя
Подробнее... 
Возвращает основные данные пользователя по логину: фамилию, имя, отчество и отображаемое имя.
ТипПараметрПо умолчаниюОписание
string$login''Логин пользователя
HasPreparedAnswerПроверить наличие подготовленного ответа
Подробнее... 
Проверяет, есть ли у вопроса сохраненный, но еще не отправленный ответ или связанные данные ответа.
ТипПараметрПо умолчаниюОписание
ObjectDataRecord$r''Запись вопроса
HtmlЭкранировать HTML
Подробнее... 
Преобразует произвольное значение в безопасную строку для вывода внутри HTML-разметки VirtualRef.
ТипПараметрПо умолчаниюОписание
mixed$value''Значение для вывода
IsQuestionOwnerПроверить автора вопроса
Подробнее... 
Проверяет, является ли пользователь автором вопроса.
ТипПараметрПо умолчаниюОписание
ObjectDataRecord$r''Запись вопроса
string|null$login'null'Логин пользователя
IsWatcherПроверить наблюдателя вопроса
Подробнее... 
Проверяет, включен ли пользователь в список наблюдателей вопроса.
ТипПараметрПо умолчаниюОписание
ObjectDataRecord$r''Запись вопроса
string$login''Логин пользователя
LimitQuestionTextОграничить текст вопроса
Подробнее... 
Обрезает текст вопроса до заданной длины без разрыва отображения длинных значений.
ТипПараметрПо умолчаниюОписание
string$text''Текст
int$limit'180'Ограничение длины
NormalizeProjectKeyНормализовать ключ проекта Workflow
Подробнее... 
Приводит ключ проекта Workflow, используемого VirtualRef, к единому машинному виду с резервным ключом VREF.
ТипПараметрПо умолчаниюОписание
string$key''Ключ проекта
NormalizeQuestionTitleНормализовать тему вопроса
Подробнее... 
Очищает и нормализует тему вопроса перед сохранением или отображением.
ТипПараметрПо умолчаниюОписание
string$title''Заголовок
RemoveWatcherУдалить наблюдателя вопроса
Подробнее... 
Удаляет указанного пользователя из списка наблюдателей вопроса.
ТипПараметрПо умолчаниюОписание
ObjectDataRecord$r''Запись вопроса
string$login''Логин пользователя
RenderPersonAvatarСформировать аватар пользователя
Подробнее... 
Формирует компактный HTML-аватар пользователя с инициалами и подсказкой.
ТипПараметрПо умолчаниюОписание
string$family''Фамилия
string$name''Имя
string$sname''Отчество
string$login''Логин пользователя
string$label''Подпись аватара
string$colorClass'bg-secondary'CSS-класс цвета аватара
RenderQuestionDetailStylesСформировать стили страницы просмотра вопроса
Подробнее... 
Возвращает CSS, используемый страницей просмотра вопроса VirtualRef.
Отсутствуют
RenderQuestionWatchersСформировать блок наблюдателей вопроса
Подробнее... 
Формирует свернутый блок наблюдателей вопроса.
ТипПараметрПо умолчаниюОписание
ObjectDataRecord$r''Запись вопроса
SetLanguage_ruЗагрузить русскую локализацию Виртуальной справки
Подробнее... 
Заполняет русские языковые строки модуля Виртуальная справка.
Отсутствуют
SetResponsibleНазначить ответственного за вопрос
Подробнее... 
Записывает указанного пользователя как ответственного за вопрос.
ТипПараметрПо умолчаниюОписание
ObjectDataRecord$r''Запись вопроса
string$login''Логин пользователя
SetupModuleConfigureВыполнить первичную настройку VirtualRef
Подробнее... 
Выполняет первичную настройку модуля VirtualRef, включая проверку текущего проекта и очистку кэшей конфигурации.
ТипПараметрПо умолчаниюОписание
int$count'0'Служебный счетчик шага настройки
SyncQuestionWorkflowStateСинхронизировать workflow-состояние вопроса
Подробнее... 
Обновляет поле 113 LINK с workflow-состоянием вопроса для проекта и синхронизирует связанные поля статуса.
ТипПараметрПо умолчаниюОписание
ObjectDataRecord$r''Запись вопроса
ObjectDataWorkflowProject$project''Проект workflow
int|string|null$status'null'Статус
string$transitionKey''Идентификатор выполненного перехода
Workflow_AddWatcherДобавить наблюдателя вопроса
Подробнее... 
Добавляет пользователя из параметров перехода в наблюдатели вопроса VirtualRef. Если параметр не задан, используется текущий пользователь.
ТипПараметрПо умолчаниюОписание
WorkflowContext$ctx''Контекст выполнения workflow-команды
Workflow_ApplyAnswerAuthorЗаписать автора ответа
Подробнее... 
Записывает текущего пользователя как автора ответа VirtualRef после редактирования ответа.
ТипПараметрПо умолчаниюОписание
WorkflowContext$ctx''Контекст выполнения workflow-команды
Workflow_ApplyQuestionCreateDefaultsЗаполнить данные созданного вопроса
Подробнее... 
Заполняет служебные поля нового вопроса VirtualRef после создания записи через Workflow: автора из текущего пользователя, дату и время создания, а также нормализованную тему вопроса.
ТипПараметрПо умолчаниюОписание
WorkflowContext$ctx''Контекст выполнения workflow-команды
Workflow_AssignResponsibleНазначить ответственного вопроса
Подробнее... 
Назначает пользователя из параметров перехода ответственным за вопрос VirtualRef. Если параметр не задан, используется текущий пользователь.
ТипПараметрПо умолчаниюОписание
WorkflowContext$ctx''Контекст выполнения workflow-команды
Workflow_RemoveWatcherУдалить наблюдателя вопроса
Подробнее... 
Удаляет пользователя из наблюдателей вопроса VirtualRef. Если параметр не задан, используется текущий пользователь.
ТипПараметрПо умолчаниюОписание
WorkflowContext$ctx''Контекст выполнения workflow-команды
Workflow_SyncStatusFieldsСинхронизировать поля статуса вопроса
Подробнее... 
Обновляет человекочитаемое поле статуса вопроса VirtualRef после выполнения перехода.
ТипПараметрПо умолчаниюОписание
WorkflowContext$ctx''Контекст выполнения workflow-команды
Workflow_UnlinkUserУбрать вопрос из списка пользователя
Подробнее... 
Скрывает вопрос VirtualRef из личного списка пользователя, не удаляя сам вопрос и состояние Workflow. Если параметр не задан, используется текущий пользователь.
ТипПараметрПо умолчаниюОписание
WorkflowContext$ctx''Контекст выполнения workflow-команды