Функции могут быть вызваны как UseModule("VirtualRef")->function(parameter1,parameter2,...);
| Имя функции | Описание | Параметры |
| API_Create | Создать вопрос через API
Подробнее...
Создает новую запись вопроса Виртуальной справки через API, заполняет автора, дату, тему, текст вопроса, проект, начальный workflow-статус и дополнительные поля, затем сохраняет запись и возвращает ее SID. | | Тип | Параметр | По умолчанию | Описание | | string | $question | Обязательный | Текст вопроса | | string | $userId | Обязательный | Идентификатор пользователя, задавшего вопрос | | int | $datetime | 0 | Дата и время создания вопроса в формате unixtime | | array | $additionalFields | array (
) | Дополнительные поля, которые необходимо добавить в запись при создании запроса. Массив имеет вид $additionalFields[field][occ-1][subfield]=value | | string | $projectKey | '' | Ключ проекта VirtualRef. Если не указан, используется текущий проект из настроек модуля | | string | $questionTitle | '' | Тема вопроса. Если не указана, в пользовательских списках отображается начало текста вопроса |
|
| API_Get | Получить измененные вопросы через API
Подробнее...
Возвращает через API список вопросов, измененных после указанного времени. Если передан пользователь, отбирает только его вопросы; иначе читает записи по индексу времени изменения. | | Тип | Параметр | По умолчанию | Описание | | int | $datetime | 0 | Дата/время в формате 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-команды |
|