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


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


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

Имя функцииОписаниеПараметры
CopySidFilesКопирование SID-файлов профиля
Подробнее... 

Копирует SID-файлы управляемых переменных из исходной записи профиля в новую запись. Используется при создании дочернего профиля или копии профиля.

ТипПараметрПо умолчаниюОписание
ObjectData$record''Целевая запись профиля
ObjectData$source''Исходная запись, из которой копируются SID-файлы
GetChildrenCountКоличество дочерних профилей
Подробнее... 
Возвращает количество дочерних профилей для указанной родительской записи. Используется деревом ProfileManager и операциями обновления наследников.
ТипПараметрПо умолчаниюОписание
ObjectDataDatabase$dbОбязательныйБаза данных, в которой хранятся записи профилей.
String$sid''SID родительской записи профиля.
GetChildrenRecordsПолучение дочерних профилей
Подробнее... 
Возвращает записи дочерних профилей по SID родительского профиля. Основной поиск выполняется по индексу OSID, а при ошибке индекса используется безопасный последовательный просмотр базы с пропуском битых записей.
ТипПараметрПо умолчаниюОписание
ObjectDataDatabase$dbОбязательныйБаза данных, в которой хранятся записи профилей.
String$sid''SID родительской записи профиля.
GetEffectivePreferenceРасчет effective preference
Подробнее... 
Вычисляет effective preference по предсказуемому порядку слоев: system default, project default, project override, bindings, user preference и request override. Функция возвращает источник итогового значения и не сохраняет request override.
ТипПараметрПо умолчаниюОписание
Array$targetОбязательныйОписание preference target.
Array$optionsarray ( )Слои расчета: systemDefault, projectDefault, projectOverride, bindings, userPreference, principalRecord, requestOverride, targetAccessAllowed.
GetPreferenceDefinitionОписание preference contract ProfileManager
Подробнее... 
Возвращает системное JSON-описание контракта пользовательских preference и overrides, поддерживаемого модулем ProfileManager.
Отсутствуют
GetPreferenceStoreЧтение хранилища пользовательских preference
Подробнее... 
Возвращает нормализованное хранилище пользовательских preference из SID-данных записи пользователя или из явно переданного массива store. Функция не исполняет настройки и не проверяет права на внешние target-объекты.
ТипПараметрПо умолчаниюОписание
ObjectDataRecord$principalRecordОбязательныйЗапись пользователя или другого principal, на которой хранится SID-файл preference.
Array$optionsarray ( )Параметры чтения: store для in-memory сценариев или storagePath для нестандартного пути SID-данных.
GetSafePreferenceDiagnosticsБезопасная диагностика preference
Подробнее... 
Возвращает безопасные диагностические признаки по preference target: отсутствующий target, потеря доступа и конфликт локального override с системным baseline. Диагностика не раскрывает содержимое скрытого target.
ТипПараметрПо умолчаниюОписание
Array$targetОбязательныйОписание preference target.
Array$optionsarray ( )Флаги диагностики: targetExists, targetAccessAllowed, baselineHash, overrideBaselineHash.
GetUserPreferenceЧтение пользовательской preference
Подробнее... 
Возвращает сохраненную пользовательскую preference по нормализованному target. Если target недоступен или настройка отсутствует, функция возвращает безопасную причину отказа без исполнения внешнего фильтра, view или страницы.
ТипПараметрПо умолчаниюОписание
ObjectDataRecord$principalRecordОбязательныйЗапись пользователя или другого principal.
Array$targetОбязательныйОписание preference target.
Array$optionsarray ( )Параметры чтения: store, storagePath, targetAccessAllowed.
HealthCheckPreferencesДиагностика preference contract ProfileManager
Подробнее... 
Возвращает локальную диагностику preference contract ProfileManager без изменения данных. После появления общего HealthCheck эта функция может использоваться его provider-ом.
Отсутствуют
NormalizePreferenceTargetНормализация preference target
Подробнее... 
Проверяет и нормализует ссылку на объект пользовательской настройки: модуль-владелец, область действия, тип target, ключ target, ключ preference и контекст. Возвращает стабильный storageKey для хранения настройки без копирования определения внешнего объекта.
ТипПараметрПо умолчаниюОписание
Array$targetОбязательныйОписание preference target: ownerModule, scope, targetType, targetKey, preferenceKey и context.
ResetUserPreferenceСброс пользовательской preference
Подробнее... 
Удаляет пользовательскую preference по нормализованному target и возвращает обновленный store. Системный профиль, target-объект и определения внешних модулей при этом не изменяются.
ТипПараметрПо умолчаниюОписание
ObjectDataRecord$principalRecordОбязательныйЗапись пользователя или другого principal.
Array$targetОбязательныйОписание preference target.
Array$optionsarray ( )Параметры сброса: dryRun, store, storagePath.
SetDefaultTargetСохранение target по умолчанию
Подробнее... 
Сохраняет пользовательский выбор target по умолчанию для заданного контекста: проекта, страницы, workflow или портального профиля. ProfileManager хранит только ссылку и выбор, а проверку доступности target должен выполнять модуль-владелец совместно с Security.
ТипПараметрПо умолчаниюОписание
ObjectDataRecord$principalRecordОбязательныйЗапись пользователя или другого principal.
Array$targetОбязательныйОписание target, который выбирается по умолчанию.
Array$optionsarray ( )Параметры записи, включая dryRun и targetAccessAllowed.
SetFavoriteTargetСохранение избранного target
Подробнее... 
Сохраняет признак избранного target и порядок показа для пользователя. Определение фильтра, представления или страницы не копируется: сохраняется только ссылка на target и пользовательский выбор.
ТипПараметрПо умолчаниюОписание
ObjectDataRecord$principalRecordОбязательныйЗапись пользователя или другого principal.
Array$targetОбязательныйОписание target, например WorkflowFilter или portal page.
Boolean$favoritetrueПризнак включения target в избранное.
Integer$order0Порядок показа избранного target.
Array$optionsarray ( )Параметры записи, включая dryRun и targetAccessAllowed.
SetLastUsedParametersСохранение последних параметров
Подробнее... 
Сохраняет последние параметры пользователя для фильтра, формы или рабочего места только если владелец target явно разрешил такое сохранение. При отсутствии разрешения возвращает безопасный отказ last_used_not_allowed.
ТипПараметрПо умолчаниюОписание
ObjectDataRecord$principalRecordОбязательныйЗапись пользователя или другого principal.
Array$targetОбязательныйОписание target, для которого сохраняются параметры.
Array$parametersОбязательныйПоследние параметры пользователя.
Array$optionsarray ( )Параметры записи, включая allowLastUsed, dryRun и targetAccessAllowed.
SetListViewPreferenceСохранение настроек списка
Подробнее... 
Сохраняет пользовательские настройки отображения списка: порядок колонок, скрытые колонки, плотность строк, сортировку и группировку. Если вызывающий модуль передал allowedColumns, значения вне разрешенного WorkflowView отбрасываются и не расширяют доступ пользователя.
ТипПараметрПо умолчаниюОписание
ObjectDataRecord$principalRecordОбязательныйЗапись пользователя или другого principal.
Array$targetОбязательныйОписание WorkflowView или другой страницы списка.
Array$preferenceОбязательныйНастройки columns, hiddenColumns, density, sort и group.
Array$optionsarray ( )Параметры записи, включая allowedColumns, dryRun и targetAccessAllowed.
SetUserPreferenceСохранение пользовательской preference
Подробнее... 
Сохраняет пользовательскую preference на записи principal в SID-данных ProfileManager. Функция хранит только выбор пользователя и не копирует определения WorkflowFilter, WorkflowView, страниц или других внешних target-объектов. В режиме dryRun возвращает будущий store без записи на диск.
ТипПараметрПо умолчаниюОписание
ObjectDataRecord$principalRecordОбязательныйЗапись пользователя или другого principal.
Array$targetОбязательныйОписание preference target.
Array$valueОбязательныйСохраняемое значение preference. Секреты и токены маскируются.
Array$optionsarray ( )Параметры записи: dryRun, store, storagePath, source, baselineHash, principalKey, targetAccessAllowed.
UpdateChildrenЗапуск обновления наследников профиля
Подробнее... 

Ставит действие ProfileManager/UpdateChildren в очередь на выполение, если у записи есть потомки

ТипПараметрПо умолчаниюОписание
ObjectDataRecord$record''Запись модуля или профиля, для которой нужно обновить наследников
String$dbn'I128F'База данных, в которой находятся записи профилей
UpdateDiffсравнение записей
Подробнее... 

сравнивает запись с ее родителем по списку переменных модуля ($m->_variableslist). Не совпавшие значения будут сохранены в файл "Intersect"

ТипПараметрПо умолчаниюОписание
ObjectData$r''запись
ObjectData$rowner''запись-родитель
ValidatePreferenceDefinitionПроверка preference contract ProfileManager
Подробнее... 
Проверяет наличие обязательных разделов системного JSON-описания ProfileManager preference contract. Функция используется TestA и будущими HealthCheck-провайдерами.
Отсутствуют