Функции могут быть вызваны как UseModule("FieldHistory")->function(parameter1,parameter2,...);
| Имя функции | Описание | Параметры |
| BuildFieldDiff | Построить diff значения поля
 Подробнее...
Строит машинно-обрабатываемое описание отличий старого и нового значения: простое значение, многострочный текст или список. Итоговый пользовательский UI формирует модуль-потребитель. | | Тип | Параметр | По умолчанию | Описание | | String | $oldValue | Обязательный | Старое нормализованное значение поля. | | String | $newValue | Обязательный | Новое нормализованное значение поля. | | Array | $options | Обязательный | Параметры diff. Поддерживается valueType=string|text|list|integer|number|date|datetime|boolean|json. |
|
| EnsureSchema | Инициализировать хранилища истории полей
Подробнее...
Создает или обновляет SID SQLite-хранилища модуля FieldHistory и фиксирует текущую версию runtime-схемы в записи модуля. | Отсутствуют |
| GetFieldHistory | Получить историю значимых полей
Подробнее...
Возвращает список FieldChange по записи, полю, пользователю, периоду, batch или workflow-переходу. Выдача применяет безопасное представление замаскированных значений. | | Тип | Параметр | По умолчанию | Описание | | Array | $filter | Обязательный | Фильтр истории: profileKey, ownerModule, ownerDb, ownerRecordType, ownerKey, ownerMfn, fieldKey, batchKey, actorKey, workflowTransitionKey, from, to, limit. | | Array | $context | Обязательный | Контекст выдачи. allowSensitive=true разрешает показать сохраненные чувствительные значения после внешней проверки прав. |
|
| GetProfile | Получить профиль истории полей
Подробнее...
Возвращает профиль FieldHistoryProfile из runtime-хранилища, system JSON или безопасный профиль по умолчанию, если это разрешено параметрами вызова. | | Тип | Параметр | По умолчанию | Описание | | String | $profileKey | Обязательный | Ключ профиля истории полей. Пустое значение означает профиль default. | | Array | $options | Обязательный | Параметры чтения. allowDefault=false запрещает возврат профиля по умолчанию при отсутствии записи. |
|
| GetSchemaStatus | Получить состояние схемы истории полей
Подробнее...
Возвращает сведения о записи модуля FieldHistory, установленной версии схемы, наличии runtime-хранилищ и недостающих колонках. | Отсутствуют |
| GetSystemDefinitions | Прочитать системные определения истории полей
Подробнее...
Читает JSON-файл системных определений FieldHistory: runtime-хранилища, профили, типы значений, типы diff, политики маскирования, события и API-операции. | Отсутствуют |
| HealthCheck | Диагностика модуля истории полей
Подробнее...
Проверяет runtime-схему FieldHistory, системные определения и наличие внешних контрактов: FieldConfiguration, Security, EventBus и TestA. | Отсутствуют |
| NormalizeFieldSnapshot | Нормализовать снимок значимых полей
Подробнее...
Приводит входной снимок полей к единому виду FieldHistory: fieldKey, физическая ссылка на поле, тип значения, нормализованное значение, маскирование и признак восстановления. | | Тип | Параметр | По умолчанию | Описание | | Array | $snapshot | Обязательный | Снимок значений. Допустим массив fields или ассоциативный массив fieldKey=>value. | | Array | $profile | Обязательный | Опциональный профиль с config.fields. Если не передан, используется безопасный профиль default. |
|
| PreviewRestore | Подготовить preview восстановления поля
Подробнее...
По записи FieldChange формирует безопасный preview восстановления старого значения. Фактическое применение должно выполнять доменное сохранение записи через модуль-владелец и ФЛК. | | Тип | Параметр | По умолчанию | Описание | | String | $changeKey | Обязательный | Ключ изменения FieldChange, старое значение которого планируется восстановить. | | Array | $context | Обязательный | Контекст preview: createIntent, reason, traceId. Права должны быть проверены вызывающим модулем через Security. |
|
| RecordFieldChanges | Зафиксировать изменения значимых полей
Подробнее...
Сравнивает снимки записи до и после изменения, формирует FieldChangeBatch и append-only записи FieldChange. В dryRun-режиме возвращает будущие изменения без записи в runtime-хранилище. | | Тип | Параметр | По умолчанию | Описание | | Array | $beforeSnapshot | Обязательный | Снимок значимых полей до изменения. | | Array | $afterSnapshot | Обязательный | Снимок значимых полей после изменения. | | Array | $context | Обязательный | Контекст записи и действия: profileKey, object/module/dbn/recordType/recordKey/mfn, actor, sourceKind, sourceKey, traceId, workflowTransitionKey, history907Ref, dryRun, idempotencyKey. |
|
| RegisterProfile | Зарегистрировать профиль истории полей
Подробнее...
Создает или обновляет профиль FieldHistoryProfile, который задает отслеживаемые поля, маскирование, retention и разрешение на восстановление значений. | | Тип | Параметр | По умолчанию | Описание | | Array | $profile | Обязательный | Описание профиля: profileKey, title, ownerModule, ownerRecordType, scopeKey, config.fields, maskPolicy, retentionDays, restoreAllowed, restoreRightKey. | | Array | $options | Обязательный | Дополнительные параметры регистрации. Поддерживается dryRun=true для проверки без записи. |
|
| ValidateSystemDefinitions | Проверить системные определения истории полей
Подробнее...
Проверяет полноту system JSON модуля FieldHistory: имя модуля, версию схемы, обязательные секции, перечисление runtime-хранилищ, политики маскирования и типы diff. | | Тип | Параметр | По умолчанию | Описание | | Array | $definitions | Обязательный | Опциональный массив системных определений. Если не передан, файл читается из modules/FieldHistory/system/fieldhistory.json. |
|