Функции могут быть вызваны как UseModule("Menu")->function(parameter1,parameter2,...);
| Имя функции | Описание | Параметры |
| ExplainMaterializedItemVisibility | Объяснение видимости materialized-пункта меню
 Подробнее...
Возвращает безопасное объяснение, почему пункт меню отображается или скрыт: публикация, право VIEW, host context и диагностические признаки target из MenuMaterialization. Функция не раскрывает скрытое содержимое target. | | Тип | Параметр | По умолчанию | Описание | | ObjectDataRecord | $record | Обязательный | Запись PAGE, используемая как пункт меню. | | Array | $options | array (
) | Контекст проверки: metadata, host, published, skipSecurity. |
|
| GetLink | Получение ссылки пункта меню
Подробнее...
Формирует ссылку пункта меню по штатной структуре записи PAGE: обычные и системные страницы ведут на ?id= , а страницы-переходы берут адрес из SID-файла content. | | Тип | Параметр | По умолчанию | Описание | | ObjectDataRecord | $r | Обязательный | Запись PAGE, используемая как пункт меню. |
|
| GetPublicationDefinition | Описание контракта materialized-навигации Menu
Подробнее...
Возвращает системное JSON-описание контракта публикации portal entrypoint и navigation items в штатные записи PAGE, отображаемые модулем Menu. | Отсутствуют |
| HealthCheckPublication | Диагностика materialized-навигации Menu
Подробнее...
Возвращает локальную диагностику контракта публикации Menu: валидность JSON-описания, дубли stableSourceKey/pageId, битые target-ы и public host context. После появления общего HealthCheck функция может использоваться его provider-ом. | | Тип | Параметр | По умолчанию | Описание | | Array | $items | array (
) | Необязательный список materialized items для диагностики. | | Array | $options | array (
) | Зарезервированный контекст диагностики. |
|
| InvalidateCache | Инвалидация кэша меню
Подробнее...
Сбрасывает глобальный кэш MenuGlobalRebuild во Flags и фиксирует причину изменения materialized-навигации. При необходимости может сразу запустить rebuild. | | Тип | Параметр | По умолчанию | Описание | | String | $reason | '' | Причина сброса кэша меню. | | Array | $options | array (
) | Параметры: dryRun и rebuild. |
|
| IsShowMenuItem | Проверка видимости пункта меню
Подробнее...
Проверяет существование записи меню, право просмотра и признак публикации. | | Тип | Параметр | По умолчанию | Описание | | array | $p | Обязательный | Данные пункта меню с SID записи и признаком Published |
|
| LoadMenu | Загрузка меню
Подробнее...
Собирает массив пунктов меню по идентификатору родительской страницы и передает его в шаблонизатор. | | Тип | Параметр | По умолчанию | Описание | | string | $type | '0' | Идентификатор родительской страницы меню |
|
| NeedShow | Проверка отображения пункта меню
Подробнее...
Возвращает итоговый признак отображения пункта меню с учетом публикации, права VIEW, host context и materialized metadata. Подробные причины скрытия возвращает ExplainMaterializedItemVisibility. | | Тип | Параметр | По умолчанию | Описание | | ObjectDataRecord | $r | Обязательный | Запись PAGE, используемая как пункт меню. | | Array | $options | array (
) | Дополнительный контекст проверки: metadata, host, published, skipSecurity. |
|
| NormalizeMaterializedItem | Нормализация materialized-пункта меню
Подробнее...
Проверяет и нормализует описание entrypoint/navigation item, которое Menu может материализовать в штатную запись PAGE: stable source key, owner module, page id, parent page, подпись, channel, host context, target route и cache policy. | | Тип | Параметр | По умолчанию | Описание | | Array | $item | Обязательный | Описание пункта публикации: stableSourceKey, ownerModule, pageId, parentPageId, title, channel, targetModule, targetAction, hostContext. |
|
| RebuildGlobalMenu | Перестроение глобального меню
Подробнее...
Рекурсивно строит глобальное дерево меню из записей страниц и сохраняет его во флаге MenuGlobalRebuild. | | Тип | Параметр | По умолчанию | Описание | | string | $dbname | 'I128F' | Имя базы данных со страницами | | string | $path | '' | Внутренний путь узла меню при рекурсивном перестроении |
|
| Show | Вывод меню
Подробнее...
Выводит пользовательское меню через шаблон, используя глобальный и пользовательский кэш во Flags. | | Тип | Параметр | По умолчанию | Описание | | string | $start | '' | Путь стартового узла меню | | string | $tpl | 'Menu.tpl' | Имя шаблона вывода меню |
|
| SyncMaterializedItems | Синхронизация materialized-пунктов меню
Подробнее...
Выполняет dry-run или apply синхронизацию entrypoint/navigation items в штатные PAGE-записи меню. Повторный запуск идемпотентен по stableSourceKey и pageId, а результат возвращается как MenuSyncReport со списком create/update/none/conflict/invalid. | | Тип | Параметр | По умолчанию | Описание | | Array | $items | array (
) | Список нормализуемых entrypoint/navigation items для публикации в Menu. | | Array | $options | array (
'dryRun' => true,
'dbn' => 'I128F',
) | Параметры sync: dryRun, dbn, lookupExisting, adoptExisting, existingItems, revision. |
|
| TrunkMenuToUser | Фильтрация меню по правам пользователя
Подробнее...
Удаляет из дерева меню пункты, недоступные текущему пользователю. | | Тип | Параметр | По умолчанию | Описание | | array | $res | Обязательный | Дерево меню |
|
| ValidatePublicationDefinition | Проверка контракта materialized-навигации Menu
Подробнее...
Проверяет наличие обязательных разделов системного JSON-описания materialized-навигации Menu. Функция используется TestA и локальной диагностикой HealthCheckPublication. | Отсутствуют |
| hh | Нормализация имени кэша меню
Подробнее...
Преобразует имя host или другого ключа в безопасный фрагмент пути для хранения пользовательского кэша меню во Flags. | | Тип | Параметр | По умолчанию | Описание | | String | $name | '' | Исходное имя host или другого ключа кэша. |
|