Open source
Onboarding for Laravel
composer require roundly-consulting/onboarding-for-laravelPrehľad
Onboarding for Laravel opisuje onboarding ako toky zoradených krokov a postup každého používateľa vypočíta za behu z údajov, ktoré už máte — bez tabuliek, migrácií a konfiguračného súboru. Toky zaregistrujete raz a potom sa ktoréhokoľvek modelu opýtate na ďalší krok, percento dokončenia, sekcie alebo súhrn pripravený pre JSON; prístup k routám podmienite dokončením jediným middlewarom a postup ohlásite udalosťami vtedy, keď sa rozhodnete vy. Licencia MIT, bezstavový návrh a postavené len na Laraveli — jedinou runtime závislosťou je náš vlastný package toolkit.
Čo získate
Žiadne tabuľky ani konfigurácia
Postup sa počíta za behu z údajov, ktoré už máte — bez migrácií, konfiguračného súboru a zastaraných príznakov.
Viac tokov, jeden resolver
Registrujte toky pod kľúčmi alebo ako znovupoužiteľné triedy a nechajte resolver vybrať správny tok každému používateľovi.
Deklaratívne kroky
completeWhenFilled(), completeWhenTrue() a completeWhenHas() pokryjú bežné prípady; zvyšok vyriešia closures.
Voliteľné kroky, sekcie a pozícia
Voliteľné kroky nikdy neblokujú dokončenie; sekcie, „krok 3 zo 7“ a pokračovanie tam, kde používateľ skončil, sú zabudované.
Ochrana rout a pripravené pre frontend
Middleware onboarding presmeruje nedokončených používateľov na aktuálny krok; toArray() a typované DTO obslúžia vaše UI.
Udalosti a voliteľná perzistencia
record() ohlási StepCompleted a FlowCompleted; s vlastným store získate skryteľné kroky a jednorazové udalosti.
Fasáda alebo DI, so skutočným fakom
Jedna fasáda Onboarding nad vložiteľným OnboardingManager; Onboarding::fake() zachytí udalosti, zaznamená skrytia krokov a naplní store.
Dokumentácia
Inštalácia
Inštalácia cez Composer — nie je čo publikovať, žiadna konfigurácia, migrácia ani view. Zapojenie overíte cez php artisan about.
Základné pojmy
Toky, kroky, subjekty a manager — ako sa postup odvodzuje za behu z vašich údajov namiesto ukladania.
Fasáda Onboarding
Celá fasáda Onboarding — registrácia tokov, kópia pre subjekt cez for(), výber toku resolverom a zapojenie store.
Bez fasády
Bez fasády: vložte si OnboardingManager a máte to isté API bez statických volaní. Triedy akcií balík nemá.
Registrácia tokov
Registrujte predvolené toky aj toky pod kľúčmi, skladajte ich fluentne, balte do tried a spravujte register.
Definovanie krokov
Skladajte kroky s názvom, CTA, cieľmi, metadátami, kľúčmi a poradím; o dokončení a vylúčení rozhodujú closures.
Deklaratívne podmienky
completeWhenFilled(), completeWhenTrue(), completeWhenHas() a ich náprotivky na vylúčenie — pravidlá na jeden riadok bez closures.
Voliteľné kroky
Usmerňujte používateľov krokmi navyše, ktoré sa započítajú do postupu, ale nikdy neblokujú dokončenie.
Príprava modelu
Pridajte GetsOnboarded na model — čítajte jeho tok, zvoľte predvolený kľúč a používajte jednoriadkové metódy bezpečné voči null.
Čítanie postupu
Dokončenie, aktuálny krok, percentá, pozícia a pokračovanie — celé API na čítanie toku s referenčnou tabuľkou.
Viazanie subjektu
Vyhodnoťte tok pre konkrétny model alebo prihláseného používateľa — každé volanie Onboarding::for() vráti vlastnú naviazanú kópiu.
Výber toku pre subjekt
Zaregistrujte jeden resolver, ktorý každému subjektu priradí kľúč toku, s automatickým návratom na predvolený tok.
Middleware pre routy
Podmieňte routy dokončením onboardingu: nedokončených používateľov presmeruje na aktuálny krok, bez cyklenia.
Sekcie
Zoskupte kroky do pomenovaných sekcií s vlastným postupom — základ pre viacdielnych sprievodcov nastavením.
Preložiteľné texty
Používajte prekladové kľúče ako názvy krokov a CTA — preložia sa pri čítaní a správanie môžete vynútiť alebo vypnúť.
Serializácia pre API
Odovzdajte tok frontendu ako pole pripravené pre JSON alebo ako typované DTO FlowData, StepData a SectionData.
Udalosti
Ohláste postup cez record() — StepCompleted a FlowCompleted pre analytiku, notifikácie alebo vlastnú perzistenciu.
Perzistencia
Zapnite skryteľné voliteľné kroky a jednorazové udalosti tak, že cez Onboarding::useStore() zapojíte vlastný OnboardingStore.
Rozšírenie a výnimky
Pridajte fluentné pomocníky cez makrá, poznajte všetky body rozšírenia a ošetrite typované InvalidFlowException a InvalidStoreException.
Artisan príkazy
Vypíšte zaregistrované toky, preskúmajte kroky jedného toku a overte zapojenie balíka z terminálu.
Testovanie
Onboarding::fake() zachytí udalosti, zaznamená skrytia krokov a naplní store v pamäti — alebo testujte postup priamo z údajov modelu.
Požiadavky
PHP 8.4+ a Laravel 12 alebo 13 — bez PHP rozšírení, databázových tabuliek a konfiguračného súboru.
Prejavte lásku k open source
Tento balík je zadarmo pod licenciou MIT. Ak vám šetrí čas, jednorazový príspevok alebo členstvo na Patreone nám pomôže ho ďalej udržiavať, testovať a dokumentovať.
Ďalšie spôsoby podpory vrátane kryptomienOdoslaním daru súhlasíte s našimi podmienkami prijímania darov.
Chcete to zabudovať do svojho produktu?
Naše balíky integrujeme do zákazkových Laravel a AI riešení. Napíšte nám, na čom pracujete, a ozveme sa do 48 hodín.