Головна › Система контекстної допомоги

Система контекстної допомоги

Що це таке?

Система 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 документацію