Strona główna › System pomocy kontekstowej

System pomocy kontekstowej

Co to jest?

System Help Links automatycznie łączy strony aplikacji z odpowiednimi sekcjami dokumentacji. Gdy jesteś na stronie z skonfigurowaną pomocą, w nagłówku pojawia się fioletowy przycisk pomocy (?).

Kliknięcie przycisku otwiera odpowiednią dokumentację w nowej karcie, umożliwiając szybkie uzyskanie szczegółowych informacji o funkcjonalności strony.

Jak to działa

Krok 1: Wykrywanie trasy

Gdy otwierasz stronę, system wykrywa jej trasę Symfony (np. app_property_adjustments_index dla strony listy korekt).

Krok 2: Wyszukiwanie w bazie danych

System przeszukuje tabelę help_links w poszukiwaniu rekordu dla tej trasy. Jeśli zostanie znaleziony aktywny link, pobiera ścieżkę dokumentacji (np. /adjustments/service-provider).

Krok 3: Wyświetlanie przycisku

Jeśli link zostanie znaleziony i jest aktywny, w nagłówku strony wyświetlany jest fioletowy przycisk pomocy z ikoną znaku zapytania.

Krok 4: Otwieranie dokumentacji

Po kliknięciu przycisku odpowiednia sekcja biblioteki (np. /library/adjustments/service-provider) otwiera się w nowej karcie przeglądarki.

Gdzie znajduje się przycisk?

Przycisk pomocy znajduje się w nagłówku strony, zwykle po prawej stronie przycisku menu nieruchomości, przed wskaźnikami i przyciskami akcji. Oto jak wygląda:

Które strony są obsługiwane?

System Help Links jest skonfigurowany dla wszystkich głównych modułów aplikacji. Przycisk pomocy jest dostępny na stronach:

  • Korekty salda (tworzenie, przeglądanie, edycja)
  • Umowy najmu
  • Dokumenty
  • Wydatki
  • Płatności
  • Kary
  • Odszkodowania za naprawy
  • Komunikacje
  • Liczniki
  • Naruszenia
  • Majątek wynajmującego
  • Wiadomości
  • Negocjacje umów
  • Propozycje komercyjne
  • Zdjęcia i filmy

API do zarządzania linkami

System zapewnia REST API do programowego zarządzania linkami pomocy. Wszystkie operacje modyfikacji danych (tworzenie, aktualizacja, usuwanie) są dostępne tylko dla administratorów.

GET /api/v1/help-links

Pobierz listę wszystkich linków pomocy z możliwością filtrowania według statusu aktywności.

Parametry zapytania

  • is_active - Filtruj według statusu aktywności (0 lub 1)

Przykład odpowiedzi

[
  {
    "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}

Pobierz link pomocy dla konkretnej trasy Symfony.

Przykład żądania

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

Przykład odpowiedzi

{
  "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

Utwórz nowy link pomocy.

Uwaga: Ta operacja jest dostępna tylko dla użytkowników z rolą ROLE_ADMIN.

Treść żądania

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

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

Zaktualizuj istniejący link pomocy.

Uwaga: Ta operacja jest dostępna tylko dla użytkowników z rolą ROLE_ADMIN.

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

Usuń link pomocy.

Ważne: Uwaga: Ta operacja jest dostępna tylko dla użytkowników z rolą ROLE_ADMIN.

Dokumentacja Swagger

Pełna interaktywna dokumentacja API z możliwością testowania żądań jest dostępna w Swagger UI:

Otwórz dokumentację Swagger