Installazione phpDocumentor dovrebbe essere facile. Almeno, Ho letto qua e là su Internet, oltre ovviamente nel Sito ufficiale, che avete molte opzioni per installarlo, uno più facile del precedente!
Quindi ero assolutamente fiducioso che in pochi minuti sarei stato in grado di eseguire phpDocumentor e creare la documentazione per la mia nuova classe Php.
Lo sai? Mi sbagliavo. Questo è quello che è successo.
phpDocumentor.phar
La prima cosa che ho provato è stata usare il file .phar. So che il primo modo che suggeriscono è usare PEAR, ma ho avuto un'esperienza positiva sull'utilizzo di file .phar solo un giorno prima: Volevo avere l'installazione di php-cs-fixer e l'esecuzione in Atom e dopo diversi tentativi ho finito per utilizzare il file php-cs-fixer.phar. Così, quando è arrivato il momento di installare phpDocumentor mi sono detto: "perché dovrei lottare con la riga di comando?, problemi di dipendenze e il resto quando posso solo scaricare un singolo, meraviglioso file e mettilo nella mia directory php?" Fatto! Una volta installato phpDocumentor.phar, Ho aperto il prompt dei comandi direttamente nella cartella della mia classe e ho digitato
phpdoc -d "." -T "./documenti"
BUUUZZZZ!!!
Impossibile aprire il file di input: “phpDocumentor.phar”
Installazione di phpDocumentor con Composer
Ops, Che cos'è? Ho iniziato a cercare un po' su Google, ma senza successo, quindi ho tristemente abbandonato il file .phar e sono andato avanti con Composer. peggio di prima!
phpdoc non è riconosciuto come comando interno o esterno
A Google o non a Google? No, Non voglio perdere tempo a capire perché qualcosa che viene detto di funzionare non funziona (non parliamo del compositore stesso, che è un ottimo strumento che uso in diverse occasioni, parlo solo dell'installazione di phpDocumentor tramite Composer). Tentativo archiviato.
Installazione di phpDocumentor con PEAR
Ho sempre avuto una buona esperienza nell'installazione di estensioni php tramite PEAR, quindi ho pensato che avrebbe funzionato anche installando phpDocumentor. Ho digitato il seguente comando e ho atteso con impazienza la risposta:
Pear Channel-discover Pear.phpdoc.org pera install phpdoc/phpDocumentor
Wow, sembrava andare tutto bene! Una volta terminato il processo, Ho fatto un altro tentativo di creare la mia documentazione digitando il solito comando:
phpdoc -d "." -T "./documenti"
Aaarghhh!!! La finestra del prompt dei comandi è stata riempita con molti avvisi ed errori relativi ai modelli Smarty!
La soluzione
vi risparmio i dettagli. Dico solo che trenta/quaranta minuti di google mi hanno dato la soluzione: scaricando la versione 2.9.0 direttamente da Github. sono andato a https://github.com/phpDocumentor/phpDocumentor2/releases/tag/v2.9.0 e cliccato sul file compresso con il nome phpDocumentor-2.9.0.tgz per scaricarlo e… Non chiedermi perché, forse quel giorno sono stato terribilmente sfortunato, ma il download è stato terribilmente lento, si è fermato più volte e una volta completato, l'archivio era corrotto!
La vera soluzione!
Fortunatamente ho trovato un altro sito web che permette di scaricare quel file: https://fossies.org/linux/www/phpDocumentor-2.9.0.tgz/. Infine, Ho il file. L'ho messo in una cartella temporanea, aperto il prompt dei comandi e digitato semplicemente:
pera install phpDocumentor-2.9.0.tgz
Manca ancora una piccola modifica al file phpdoc.bat. Vai nella tua cartella php (Nelle mie finestre 10 partizione ho installato xampp, quindi il mio php si trova in C:\cartella xamppphp) e apri phpdoc.bat con un editor di testo. Dovrebbe sembrare come questo:
@eco spento Se "%PHPBIN%" == "" set PHPBIN=php.exe se non esiste "%PHPBIN%" Se "%PHP_PEAR_PHP_BIN%" NEQ "" vai a USE_PEAR_PATH VAI A CORRERE :USE_PEAR_PATH imposta PHPBIN=%PHP_PEAR_PHP_BIN% :CORRERE "%PHPBIN%" "%PHP_PEAR_BIN_DIR%phpdoc" %*
Basta cambiare l'ultima riga sostituendo "%PHP_PEAR_BIN_DIR%\phpdoc" con il percorso completo del tuo file phpdoc. Nel mio caso, il file phpdoc.bat risultante sembra così:
@eco spento Se "%PHPBIN%" == "" set PHPBIN=php.exe se non esiste "%PHPBIN%" Se "%PHP_PEAR_PHP_BIN%" NEQ "" vai a USE_PEAR_PATH VAI A CORRERE :USE_PEAR_PATH imposta PHPBIN=%PHP_PEAR_PHP_BIN% :CORRERE "%PHPBIN%" "C:\xamppphpphpdoc" %*
È tutto, ora funziona! E ho la mia documentazione completa con il mio modello preferito:
phpdoc -d "." -T "./documenti" --modello="ramoscello-reattivo"
Se hai trovato utile questo articolo, per favore condividilo attraverso i tuoi social network. Se vuoi lasciami un commento, Sarò felice di sentirti!