Come utilizzare Symfony Console

Symfony Console è un potente strumento, messo a disposizione dal framework Symfony, con interfaccia a riga di comando per eseguire operazioni di varia natura sul progetto. Tramite console è possibile recuperare informazioni sul progetto, effettuare debug, gestire le dipendenze, automatizzare compiti ripetitivi come la pulizia della cache e generare codice per la creazione di nuovi Controller, Entity, ecc. 

Per accedere alla console è sufficiente utilizzare un terminale come, ad esempio, quello integrato in Visual Studio Code. Dopo aver installato Symfony, posizionarsi nella cartella del progetto e lanciare il comando:

php /bin/console

Tramite questo comando, chiediamo a PHP di eseguire il file “console” presente all’interno delle cartella “bin”. L’output di questo comando illustra l’utilizzo base di Symfony Console elencando tutti i comandi disponibili.

Come si nota dalla sezione Usage, per ogni comando è possibile definire una lista di opzioni e argomenti. Vediamone un esempio.

Esempio: come svuotare la cache con Symfony Console

Se volessimo, ad esempio, richiedere le istruzioni per l’utilizzo del comando cache:clear, utile per rimuovere la cache, sarà sufficiente digitare sul terminale il nome del comando con l’opzione help:

php bin/console cache:clear --help

Symfony Console visualizzerà la schermata seguente:

Analizziamo le sezioni della schermata precedente:

• Description: la descrizione del comando per il quale è stato richiesto aiuto.
• Usage: come utilizzare il comando da CLI
• Options: la lista di opzioni che possono essere fornite in input al comando
• Help: un esempio pratico di utilizzo del comando. In questo caso specifico, l’esempio propone la pulizia della cache sull’ambiente dev ovvero di sviluppo.

Proviamo, ora, a lanciare il comando senza alcuna opzione, con l’obiettivo di svuotare la cache:

php bin/console cache:clear

Il risultato sarà il seguente:

Svuotare la cache è utile per aggiornare lo stato dell’applicazione dopo che sono state effettuate modifiche sui file.

Informazioni sul sistema con Symfony Console

Un altro comando utile è il comando about che ci permette di avere informazioni sul progetto e sul sistema. Per eseguirlo, basta lanciare il seguento comando

php bin/console about

Riceveremo in output tutte le informazioni del progetto, come la versione di Symfony, e le informazioni sul sistema, come la versione di PHP utilizzata.

La lista dei comandi presenti in Symfony Console aumenta sulla base dei componenti che vengono installati. Nel momento in cui aggiungeremo Doctrine ORM, ad esempio, avremo a disposizione una serie di comandi per interagire con il database.