Domov

Vitajte v DotApper CLI, oficiálnom rozhraní príkazového riadka pre dotApp PHP Framework. DotApper je navrhnutý tak, aby zjednodušil váš vývojový postup a umožnil vám jednoducho nastaviť, spravovať a rozširovať projekty dotApp pomocou jednoduchej a výkonnej sady príkazov.

Čo je DotApper CLI?

DotApper CLI je ľahký nástroj, ktorý vám pomôže:

• Nainštalovať a aktualizovať dotApp PHP Framework.
• Vytvárať a spravovať moduly, kontroléry, middleware a modely.
• Generovať a optimalizovať assety projektu, napríklad trasy a súbory .htaccess.
• Zvýšiť produktivitu vďaka intuitívnemu rozhraniu príkazového riadka.

DotApper CLI je postavený s dôrazom na jednoduchosť a efektivitu a hodí sa pre vývojárov, ktorí sa chcú sústrediť na tvorbu moderných webových aplikácií bez opakujúcich sa úloh nastavenia.

Prečo používať DotApper CLI?

• Rýchle nastavenie: Nainštalujte dotApp v priebehu sekúnd jediným príkazom.
• Modulárny postup práce: Jednoducho vytvárajte a organizujte moduly pre škálovateľné projekty.
• Priateľské k vývojárom: Prehľadné príkazy a užitočné výstupy šetria čas.
• Bezproblémová integrácia: Spolupracuje s modulárnou architektúrou frameworku dotApp.

Začnite

Ste pripravení začať? Prejdite do sekcie Inštalácia a nastavte DotApper CLI pre prvý projekt. Alebo si v sekcii Príkazy pozrite celú paletu dostupných nástrojov.

Príklad rýchleho štartu:

# Install dotApp with DotApper CLI
php dotapper.php --install
        

Ďalšie podrobnosti nájdete v úplnej dokumentácii dotApp alebo sa obráťte na tím podpory.

S hrdosťou vytvorené na Slovensku 🇸🇰

Inštalácia

Inštalácia DotApper CLI je jednoduchá a vyžaduje iba stiahnutie jedného súboru, dotapper.php, do vášho počítača. Táto sekcia vysvetľuje, ako nástroj získať a pripraviť na použitie.

Predpoklady

Pred inštaláciou DotApper CLI sa uistite, že vaše prostredie spĺňa nasledujúcu požiadavku:

• PHP: Verzia 7.4 alebo vyššia s prístupom z príkazového riadka na spúšťanie PHP skriptov.

Inštalácia DotApper CLI

Na inštaláciu DotApper CLI postupujte podľa týchto krokov a stiahnite súbor dotapper.php:

1. Otvorte prehliadač a prejdite na odkaz: https://github.com/dotsystems-sk/DotApp/raw/refs/heads/main/dotapper.php.
2. Prehliadač zobrazí zdrojový kód dotapper.php. Kliknite pravým tlačidlom kdekoľvek na stránke a vyberte Uložiť stránku ako (alebo podobnú voľbu podľa prehliadača).
3. Súbor uložte ako dotapper.php do požadovaného adresára (napríklad do priečinka projektu alebo do adresára s nástrojmi).
4. Overte, že je súbor uložený správne: otvorte terminál a spustite:

   
   php dotapper.php --help
               

   Mal by sa zobraziť zoznam dostupných príkazov DotApper CLI, čím sa potvrdí, že je nástroj pripravený na použitie.

Poznámky

• Umiestnenie súboru: Súbor dotapper.php môžete umiestniť do ľubovoľného adresára, zvyčajne však ostáva v koreni projektu kvôli jednoduchému prístupu.
• Spustenie: Príkazy DotApper CLI spúšťajte ako php dotapper.php [command] z adresára, v ktorom sa súbor nachádza.
• Ďalšie kroky: Použitie DotApper CLI na správu projektov dotApp nájdete v sekcii Príkazy.
• Riešenie problémov: Ak príkaz --help zlyhá, uistite sa, že je nainštalované PHP 7.4+ a je dostupné v termináli. Bežné problémy nájdete v FAQ.

Po stiahnutí dotapper.php ste pripravení preskúmať jeho príkazy. Začnite v sekcii Príkazy.

Príkazy

DotApper CLI poskytuje výkonnú sadu príkazov na zjednodušenie vývoja s dotApp PHP Framework. Táto sekcia popisuje všetky dostupné príkazy, ich účel a použitie. Príkazy sa spúšťajú v termináli pomocou skriptu dotapper.php z adresára, v ktorom sa nachádza.

Štruktúra príkazu

Všetky príkazy DotApper CLI majú tento formát:

php dotapper.php [command]
    

[command] nahraďte konkrétnym príkazom a jeho parametrami, ako je uvedené nižšie. Zoznam všetkých príkazov zobrazíte spustením:

php dotapper.php --help
    

Dostupné príkazy

V DotApper CLI sú dostupné nasledujúce príkazy. Každý z nich zjednodušuje úlohy, ako je inštalácia frameworku, správa modulov a kontrola trás.

--help

Zobrazí zoznam všetkých dostupných príkazov a ich popisov.

Príklad:

php dotapper.php --help
    

Výsledok: Vypíše ponuku nápovedy so všetkými príkazmi, napríklad --install, --create-module atď.

--install

Nainštaluje čistú kópiu dotApp PHP Framework do aktuálneho adresára a vytvorí jeho adresárovú štruktúru a konfiguračné súbory.

Príklad:

php dotapper.php --install
    

Výsledok: Nastaví framework dotApp vrátane adresárov ako app/, public/ a súboru app/config.php.

--update

Aktualizuje framework dotApp na najnovšiu verziu a zachová existujúce konfiguračné súbory a moduly.

Príklad:

php dotapper.php --update
    

Výsledok: Stiahne a aplikuje najnovšie súbory jadra dotApp a ponechá app/config.php aj adresáre modulov nedotknuté.

--create-module=

Vytvorí nový modul so zadaným názvom a inicializuje jeho adresárovú štruktúru pre kontroléry, middleware a modely.

Príklad:

php dotapper.php --create-module=Blog
    

Výsledok: Vytvorí modul Blog v app/modules/Blog/ s podadresármi pre komponenty.

--modules

Vypíše všetky moduly aktuálne dostupné v projekte dotApp.

Príklad:

php dotapper.php --modules
    

Výsledok: Vypíše zoznam názvov modulov, napríklad Blog, Auth, Shop.

--module= --create-controller=

Vytvorí nový kontrolér v zadanom module.

Príklad:

php dotapper.php --module=Blog --create-controller=ArticleController
    

Výsledok: Vygeneruje ArticleController.php v app/modules/Blog/controllers/.

--module= --create-middleware=

Vytvorí nové middleware v zadanom module.

Príklad:

php dotapper.php --module=Blog --create-middleware=AuthMiddleware
    

Výsledok: Vygeneruje AuthMiddleware.php v app/modules/Blog/middleware/.

--module= --create-model=

Vytvorí nový model v zadanom module.

Príklad:

php dotapper.php --module=Blog --create-model=PostModel
    

Výsledok: Vygeneruje PostModel.php v app/modules/Blog/models/.

--list-routes

Vypíše všetky definované trasy v aplikácii dotApp vrátane HTTP metód, ciest, priradených kontrolérov a middleware (hooky before a after).

Príklad:

php dotapper.php --list-routes
    

Výsledok: Vypíše podrobný zoznam trás.

Použitie: Užitočné pri ladení problémov s routovaním alebo pri dokumentovaní štruktúry trás aplikácie.

--list-route=

Zobrazí všetky trasy, ktoré sa zhodujú so zadanou cestou, vrátane HTTP metód, priradených kontrolérov a middleware (hooky before a after). Cesta môže byť presná (napríklad / pre úvodnú stránku) alebo čiastočná (napríklad /documentation/).

Príklad 1: Trasy úvodnej stránky

php dotapper.php --list-route=/
    

Výsledok: Vypíše trasy zhodujúce sa s /.

Príklad 2: Trasy dokumentácie

php dotapper.php --list-route=/documentation/
    

Výsledok: Vypíše trasy zhodujúce sa s /documentation/.

Použitie: Pomáha zistiť, ktoré kontroléry a middleware sa spúšťajú pre konkrétnu URL, čo uľahčuje ladenie alebo optimalizáciu trás.

--create-htaccess

Vytvorí alebo znova vytvorí súbor .htaccess v adresári public/ na konfiguráciu pretvárania URL pre servery Apache.

Príklad:

php dotapper.php --create-htaccess
    

Výsledok: Vygeneruje súbor .htaccess optimalizovaný pre routovanie dotApp.

--optimize-modules

Optimalizuje načítanie modulov v projektoch s veľkým počtom modulov a zlepší výkon cacheovaním metadát modulov.

Príklad:

php dotapper.php --optimize-modules
    

Výsledok: Vytvorí alebo aktualizuje cache modulov a skráti čas načítania.

Prehľad príkazov

Tabuľka nižšie poskytuje rýchlu referenciu všetkých príkazov DotApper CLI:

Poznámky

• Príkazy spúšťajte z adresára, v ktorom sa nachádza dotapper.php.
• Príkazy ako --install, --create-module a --list-routes vyžadujú v aktuálnom adresári platnú štruktúru projektu dotApp.
• Praktické príklady použitia týchto príkazov nájdete v sekcii Použitie.
• Ak príkaz zlyhá, pozrite FAQ alebo kontaktujte podporu.

Ako tieto príkazy vyzerajú v praxi, nájdete v sekcii Použitie na reálnych príkladoch.

Pokročilé

DotApper CLI ponúka pokročilé funkcie pre vývojárov, ktorí chcú automatizovať postupy práce, skriptovať zložité úlohy alebo rozšíriť jeho funkcionalitu podľa vlastných potrieb v projektoch dotApp PHP Framework. Táto sekcia sa venuje skriptovaniu, automatizácii, kombinovaniu príkazov a tipom na rozšírenie DotApper CLI.

Skriptovanie s DotApper CLI

Viaceré príkazy DotApper CLI môžete kombinovať v shell skriptoch (napríklad Bash alebo PowerShell) a automatizovať opakujúce sa úlohy, napríklad nastavenie nového projektu s preddefinovanými modulmi a konfiguráciou.

Príklad: Bash skript na nastavenie projektu

#!/bin/bash
# setup_project.sh

echo "Setting up new dotApp project..."
php dotapper.php --install
php dotapper.php --create-module=Blog
php dotapper.php --module=Blog --create-controller=ArticleController
php dotapper.php --module=Blog --create-middleware=AuthMiddleware
php dotapper.php --module=Blog --create-model=PostModel
php dotapper.php --create-htaccess
echo "Project setup complete!"
    

Použitie: Skript uložte ako setup_project.sh, urobte ho spustiteľným (chmod +x setup_project.sh) a spustite:

./setup_project.sh
    

Výsledok: Nainštaluje dotApp, vytvorí modul Blog s kontrolérom, middleware a modelom a vygeneruje súbor .htaccess.

FAQ

Táto sekcia odpovedá na často kladené otázky o nástroji DotApper CLI pre dotApp PHP Framework. Pokrýva bežné problémy, kroky na riešenie problémov a spresnenia, ktoré vám pomôžu používať DotApper CLI efektívne.

1. Prečo dostávam chybu „command not found“, keď spustím php dotapper.php?

Táto chyba zvyčajne nastane, ak PHP nie je nainštalované, nie je dostupné v termináli, alebo ak dotapper.php nie je v aktuálnom adresári.

Riešenie:

• Overte, že je PHP nainštalované a spĺňa minimálnu verziu (7.4+):

  
  php --version
              

  Ak PHP nie je nainštalované, stiahnite ho z php.net.
• Uistite sa, že ste v adresári so súborom dotapper.php. Overte príkazom:

  
  ls | grep dotapper.php
              

  Ak chýba, stiahnite ho podľa popisu v sekcii Inštalácia.
• Ak je PHP nainštalované, ale nie je dostupné, pridajte ho do PATH systému. Napríklad v Linuxe:

  
  export PATH=$PATH:/path/to/php
              

2. Prečo --install zlyhá s chybou oprávnení?

Príkaz --install potrebuje v aktuálnom adresári práva na zápis, aby mohol vytvoriť súbory a adresáre frameworku dotApp.

Riešenie:

• Skontrolujte oprávnenia adresára:

  
  ls -ld .
              

  Uistite sa, že váš používateľ má právo na zápis.
• Udeľte práva na zápis:

  
  chmod -R u+w .
              

• Prípadne spustite príkaz so zvýšenými oprávneniami (používajte opatrne):

  
  sudo php dotapper.php --install
              

3. Čo mám robiť, ak --list-routes nezobrazí žiadne trasy?

Ak --list-routes alebo --list-route= vráti prázdny zoznam, projekt dotApp nemusí mať definované trasy, alebo štruktúra projektu môže byť neúplná.

Riešenie:

• Uistite sa, že je framework dotApp nainštalovaný:

  
  php dotapper.php --install
              

• Overte, že sú trasy definované v module.init.php modulu. Napríklad:

  
  Router::get('/home', 'HelloWorld:Home@index!', Router::STATIC_ROUTE);
              

• Skontrolujte chyby v adresári projektu spustením:

  
  php dotapper.php --list-routes
              

  Ak chyby pretrvávajú, uistite sa, že súbor app/config.php existuje a je platný.

4. Môžem používať DotApper CLI bez inštalácie dotApp?

Niektoré príkazy (napríklad --help, --install) fungujú bez projektu dotApp, väčšina príkazov (napríklad --update, --create-module, --list-routes) však v aktuálnom adresári vyžaduje štruktúru projektu dotApp.

Riešenie:

• Spustite --install a nastavte projekt dotApp:

  
  php dotapper.php --install
              

• Prípadne použite --help a preskúmajte príkazy bez projektu:

  
  php dotapper.php --help
              

5. Prečo --update prepíše moje vlastné súbory?

Príkaz --update je navrhnutý tak, aby zachoval app/config.php a adresáre modulov, môže však prepísať súbory jadra frameworku. Vlastné zmeny v súboroch jadra sa stratia.

Riešenie:

• Pred spustením --update si projekt zálohujte:

  
  cp -r . /path/to/backup
              

• Súbory jadra frameworku nemeňte. Namiesto toho používajte na vlastnú funkcionalitu moduly (pozri Použitie).
• Ak boli vlastné súbory prepísané, obnovte ich zo zálohy a zmeny znova aplikujte v module.

6. Ako ladiť problémy s --list-route=?

Ak --list-route= nevráti očakávané trasy, kontroléry alebo middleware, trasa nemusí byť zaregistrovaná, alebo môže byť problém s formátom cesty.

Riešenie:

• Uistite sa, že je cesta správna vrátane úvodnej a koncovej lomky (napríklad / alebo /documentation/).
• Spustite --list-routes, zobrazte všetky trasy a overte, že cieľová cesta existuje:

  
  php dotapper.php --list-routes
              

• Skontrolujte definície routovania v kontroléroch alebo súboroch routovania kvôli chybám.
• Ak chýbajú middleware alebo kontroléry, overte, že sú správne zaregistrované v konfigurácii modulu.

7. Môžem spúšťať príkazy DotApper CLI globálne?

DotApper CLI je navrhnuté na spúšťanie z adresára projektu so súborom dotapper.php, môžete ho však sprístupniť globálne pridaním do PATH systému.

Riešenie:

• Presuňte dotapper.php do adresára v PATH (napríklad /usr/local/bin/ v Linuxe):

  
  sudo mv dotapper.php /usr/local/bin/dotapper
  sudo chmod +x /usr/local/bin/dotapper
              

• Príkazy spúšťajte globálne z ľubovoľného adresára:

  
  php dotapper --help
              

• Poznámka: Pre väčšinu príkazov musíte byť stále v adresári projektu dotApp.

8. Čo ak príkaz zlyhá bez jasnej chybovej správy?

Niektoré zlyhania môžu vyplývať z konfigurácie PHP, oprávnení súborov alebo neúplného nastavenia dotApp.

Riešenie:

• Zapnite podrobné PHP chyby pridaním tohto kódu do dotapper.php (dočasne):

  
  ini_set('display_errors', 1);
  ini_set('display_startup_errors', 1);
  error_reporting(E_ALL);
              

• Skontrolujte PHP logy kvôli podrobným chybám (umiestnenie závisí od konfigurácie servera).
• Uistite sa, že sú splnené všetky predpoklady (pozri Inštalácia).