Главная › Система контекстной помощи

Система контекстной помощи

Что это?

Система Help Links автоматически связывает страницы приложения с соответствующими разделами документации. Когда вы находитесь на странице, для которой настроена справка, в заголовке появляется фиолетовая кнопка помощи (?).

При нажатии на кнопку открывается соответствующая документация в новой вкладке, что позволяет быстро получить подробную информацию о функционале страницы.

Как это работает

Шаг 1: Определение маршрута

Когда вы открываете страницу, система определяет её маршрут Symfony (например, app_property_adjustments_index для страницы списка корректировок).

Шаг 2: Поиск в базе данных

Система ищет в таблице help_links запись для этого маршрута. Если найдена активная ссылка, получает путь к документации (например, /adjustments/service-provider).

Шаг 3: Отображение кнопки

Если ссылка найдена и активна, в заголовке страницы отображается фиолетовая кнопка помощи с иконкой знака вопроса.

Шаг 4: Открытие документации

При нажатии на кнопку открывается соответствующий раздел библиотеки (например, /library/adjustments/service-provider) в новой вкладке браузера.

Где находится кнопка?

Кнопка помощи расположена в заголовке страницы, обычно справа от кнопки меню объекта, перед индикаторами и кнопками действий. Вот как она выглядит:

Какие страницы поддерживаются?

Система Help Links настроена для всех основных модулей приложения. Кнопка помощи доступна на страницах:

  • Корректировки баланса (создание, просмотр, редактирование)
  • Договоры аренды
  • Документы
  • Расходы
  • Платежи
  • Штрафы
  • Компенсации за ремонт
  • Коммуникации
  • Счётчики
  • Нарушения
  • Имущество арендодателя
  • Сообщения
  • Согласование договоров
  • Коммерческие предложения
  • Фото и видео

API для управления ссылками

Система предоставляет REST API для программного управления ссылками на помощь. Все операции изменения данных (создание, обновление, удаление) доступны только администраторам.

GET /api/v1/help-links

Получить список всех ссылок на помощь с возможностью фильтрации по статусу активности.

Параметры запроса

  • is_active - Фильтр по статусу активности (0 или 1)

Пример ответа

[
  {
    "id": 1,
    "route_name": "app_property_adjustments_index",
    "library_path": "/adjustments/service-provider",
    "full_library_url": "/library/adjustments/service-provider",
    "is_active": true
  }
]

GET /api/v1/help-links/by-route/{routeName}

Получить ссылку на помощь для конкретного маршрута Symfony.

Пример запроса

GET /api/v1/help-links/by-route/app_property_adjustments_index

Пример ответа

{
  "id": 1,
  "route_name": "app_property_adjustments_index",
  "library_path": "/adjustments/service-provider",
  "full_library_url": "/library/adjustments/service-provider",
  "is_active": true
}

POST /api/v1/help-links

Создать новую ссылку на помощь.

Примечание: Эта операция доступна только пользователям с ролью ROLE_ADMIN.

Тело запроса

{
  "route_name": "app_property_adjustments_index",
  "library_path": "/adjustments/service-provider",
  "is_active": true
}

PUT /api/v1/help-links/{id}

Обновить существующую ссылку на помощь.

Примечание: Эта операция доступна только пользователям с ролью ROLE_ADMIN.

DELETE /api/v1/help-links/{id}

Удалить ссылку на помощь.

Важно: Примечание: Эта операция доступна только пользователям с ролью ROLE_ADMIN.

Swagger документация

Полная интерактивная документация API с возможностью тестирования запросов доступна в Swagger UI:

Открыть Swagger документацию