Integracje
W skrócie
Dział zatytułowany „W skrócie”Rozszerzenia NextPDF łączą bazowy silnik formatu Portable Document Format (PDF) z frameworkami aplikacji, mechanizmami renderowania w przeglądarce, usługami brzegowymi, narzędziami do kompilacji oraz ścieżkami migracji ze starszych rozwiązań. Każda sekcja dotycząca rozszerzenia ma tę samą strukturę podręcznika: przegląd, instalacja, szybki start, konfiguracja, interfejs programowania aplikacji (API), przewodnik dla programistów, użycie w produkcji, bezpieczeństwo oraz rozwiązywanie problemów.
Mapa rozszerzeń
Dział zatytułowany „Mapa rozszerzeń”| Rozszerzenie | Pakiet | Kiedy go używać | Sekcja główna |
|---|---|---|---|
| Laravel | nextpdf/laravel | Używaj, gdy tworzysz aplikacje Laravel i potrzebujesz wiązań kontenera, fasady, odpowiedzi oraz zadań kolejkowych. | Laravel |
| Symfony | nextpdf/symfony | Używaj, gdy tworzysz aplikacje Symfony i potrzebujesz pakietu (bundle), powiązań wstrzykiwania zależności, zadań Messenger oraz odpowiedzi protokołu Hypertext Transfer Protocol (HTTP). | Symfony |
| CodeIgniter | nextpdf/codeigniter | Używaj, gdy tworzysz aplikacje CodeIgniter 4 i potrzebujesz usług, wrappera biblioteki, odpowiedzi oraz zadań kolejkowych. | CodeIgniter |
| Artisan | nextpdf/artisan | Używaj, gdy potrzebujesz renderowania Hypertext Markup Language (HTML) przez Chrome DevTools Protocol (CDP), importu stron lub niskopoziomowych narzędzi do inspekcji plików PDF. | Artisan |
| Cloudflare | nextpdf/cloudflare | Używaj, gdy renderujesz przez Cloudflare Browser Rendering, chronisz dostęp do API lub archiwizujesz pliki PDF w R2. | Cloudflare |
| Gotenberg | nextpdf/gotenberg | Używaj, gdy konwertujesz dokumenty biurowe lub HTML za pomocą usługi Gotenberg. | Gotenberg |
| Zgodność z TCPDF | nextpdf/compat-legacy | Używaj, gdy migrujesz kod aplikacji w stylu TCPDF do NextPDF bez pełnego przepisywania. | Zgodność z TCPDF |
| Backport Builder | nextpdf/backport-builder | Używaj, gdy utrzymujesz artefakty wydań dla starszych środowisk uruchomieniowych PHP: Hypertext Preprocessor (PHP). | Backport Builder |
Przewodnik wyboru
Dział zatytułowany „Przewodnik wyboru”| Potrzeba | Zacznij tutaj | Uwaga operacyjna |
|---|---|---|
| Pomocniki odpowiedzi frameworka | Laravel, Symfony lub CodeIgniter | Pakiet frameworka odpowiada za kontener i integrację odpowiedzi; rdzeń odpowiada za tworzenie dokumentów. |
| Renderowanie HTML precyzyjne pikselowo | Artisan lub Cloudflare | Wybierz Artisan, jeśli używasz lokalnego Chrome CDP na hoście. Wybierz Cloudflare, gdy renderowanie powinno odbywać się na brzegu sieci. |
| Konwersja dokumentów biurowych | Gotenberg | Traktuj Gotenberg jako granicę usługi zewnętrznej i stosuj kontrole limitu czasu, rozmiaru oraz fałszowania żądań po stronie serwera (SSRF). |
| Migracja ze starszego TCPDF | Zgodność z TCPDF | Sprawdź tabelę pokrycia metod, zanim założysz, że starsze wywołanie jest obsługiwane. |
| Starsza dystrybucja PHP | Backport Builder | To wyłącznie narzędzie do kompilacji; nie instaluj go jako zależności środowiska uruchomieniowego aplikacji. |
Struktura podręcznika
Dział zatytułowany „Struktura podręcznika”Każda sekcja dotycząca rozszerzenia zawiera następujące typy stron:
| Strona | Cel |
|---|---|
overview | Granice produktu, grupa docelowa, obsługiwane procesy oraz ograniczenia. |
install | Polecenia instalacji oraz wymagane zależności środowiska uruchomieniowego. |
quickstart | Minimalny działający przepływ z pierwszym wynikiem gotowym do skopiowania. |
configuration | Obsługiwane klucze konfiguracji, zmienne środowiskowe, wartości domyślne oraz ich skutki. |
api | Publiczne klasy, metody, parametry, wartości domyślne, wartości zwracane oraz wyjątki. |
developer-guide | Architektura rozszerzenia, cykl życia, punkty rozszerzania oraz organizacja kodu. |
production-usage | Wdrożenie, niezawodność, wydajność, bezpieczeństwo procesów roboczych oraz obserwowalność. |
security-and-operations | Granice zaufania, bezpieczne wartości domyślne, sekrety, dostęp do plików oraz kontrole operacyjne. |
troubleshooting | Objawy, diagnostyka, prawdopodobne przyczyny oraz działania naprawcze. |
Konwencja tabel API
Dział zatytułowany „Konwencja tabel API”Tabele API w całym podręczniku używają tych samych kolumn, dzięki czemu możesz porównywać pakiety bez poznawania nowego układu.
| Kolumna | Znaczenie |
|---|---|
| Symbol | W pełni kwalifikowana klasa, metoda, punkt końcowy, polecenie interfejsu wiersza poleceń (CLI) lub obiekt konfiguracji. |
| Parametry | Nazwa, typ, wymagalność, wartość domyślna oraz akceptowane wartości. |
| Zachowanie domyślne | Co dzieje się, gdy pominiesz opcjonalne dane wejściowe. |
| Zwraca | Typ zwracany lub artefakt wyjściowy. |
| Zgłasza wyjątek lub kończy się niepowodzeniem | Typ wyjątku, status HTTP, niepowodzenie walidacji lub operacyjny tryb awarii. |
| Uwagi | Szczegóły z zakresu bezpieczeństwa, bezpieczeństwa procesów roboczych, zgodności lub wydajności. |
Gotowość do tłumaczenia
Dział zatytułowany „Gotowość do tłumaczenia”Angielskie źródło napisano z myślą o późniejszej lokalizacji: krótkie sekcje, stabilne nagłówki, jednoznaczne rzeczowniki, brak idiomów oraz tabele dla powtarzalnych struktur. Na nowych stronach API zachowaj nazwy metod, klucze konfiguracji, flagi CLI oraz nazwy wyjątków w formatowaniu kodu, aby narzędzia tłumaczeniowe je zachowały.