Come utilizzare Composer integrato in ServBay per la gestione dei progetti PHP

ServBay, potente ambiente locale di sviluppo Web, offre agli sviluppatori una versione preinstallata di Composer, semplificando enormemente la gestione delle dipendenze nei progetti PHP. Composer è uno strumento indispensabile nello sviluppo PHP moderno: aiuta a integrare e gestire facilmente librerie di terze parti, gestisce automaticamente le complesse dipendenze e fornisce un pratico sistema di autoload. Grazie a ServBay, puoi sfruttare Composer senza dover eseguire installazioni o configurazioni aggiuntive, accelerando il tuo workflow di sviluppo PHP su macOS.

Introduzione a Composer

Composer è uno strumento per la gestione delle dipendenze nei progetti PHP. Permette agli sviluppatori di dichiarare quali librerie esterne (solitamente chiamate "package") sono necessarie al progetto e di installarle o aggiornarle automaticamente. Composer può gestire non solo librerie PHP, ma anche framework, componenti, plugin ecc.

Caratteristiche principali

Gestione delle dipendenze: Composer gestisce automaticamente le dipendenze del progetto, garantendo la compatibilità delle versioni tra le librerie e risolvendo eventuali conflitti.
Autoload: Composer offre un sistema di caricamento automatico dei file di classe installati via Composer, generando un unico file di autoload che elimina la necessità di includere manualmente (include o require) le classi nei tuoi script.
Controllo delle versioni: Nel file composer.json è possibile specificare i vincoli di versione per le dipendenze. Composer installerà le versioni compatibili sulla base di questi vincoli e, tramite il file composer.lock, bloccherà le versioni effettivamente installate per assicurare coerenza tra collaboratori e ambienti diversi.
Gestione dei pacchetti: Composer si appoggia a Packagist, un repository centrale dove trovare (ed aggiungere) quasi tutte le librerie PHP più popolari.
Supporto della community: Composer è supportato da una vasta ed attiva community e da una documentazione molto ricca.

Composer integrato in ServBay

ServBay include più versioni di PHP e ha Composer già preinstallato. Non dovrai quindi preoccuparti di scaricare o configurare Composer autonomamente: ServBay garantisce che Composer sia subito disponibile nel tuo ambiente, in associazione con la versione di PHP attualmente attiva. Puoi utilizzare direttamente i comandi composer o composer-2.2 nel terminale del tuo progetto.

Suggerimento

Composer è disponibile in due versioni: l'ultima release Composer 2.8.x e la versione Composer 2.2.x LTS compatibile con vecchie versioni di PHP (PHP 7.2+ e PHP 5.3 - PHP 7.1 rispettivamente).

Alla prima installazione, ServBay include Composer 2.8.x, adatto a PHP 7.2+.

Se hai bisogno di Composer su versioni PHP comprese tra PHP 5.3 e PHP 7.1, vai nella sezione Pacchetti e installa Composer 2.2.x LTS. Una volta completata l'installazione, usa il comando composer-2.2. Le due versioni possono coesistere senza conflitti.

Gestione delle dipendenze del progetto con Composer

Composer utilizza il file composer.json, presente nella cartella root del tuo progetto, per gestire le dipendenze. Ecco i passaggi fondamentali per creare e gestire questo file:

1. Creare il file `composer.json`

Nel root directory del tuo progetto PHP, crea un file denominato composer.json. Ad esempio, lavorando nella cartella /Applications/ServBay/www/my_php_project, crea lì questo file.

Il file composer.json è un oggetto JSON: la chiave require serve ad elencare le dipendenze richieste dal progetto. La chiave è il nome del pacchetto (di norma con il formato vendor/package), il valore indica il vincolo di versione desiderato.

Ad esempio, per installare Monolog (una libreria PHP per il logging) versione almeno 2.0:

json

{
    "require": {
        "monolog/monolog": "^2.0"
    }
}

Qui, ^2.0 è un vincolo che indica compatibilità con la versione 2.0.0 e superiori, escludendo però la 3.0.0 e successive.

2. Installare le dipendenze

Apri il terminale nella cartella che contiene composer.json ed esegui:

composer install

Questa operazione:

Legge il file composer.json.
Calcola tutte le dipendenze necessarie (incluse quelle dichiarate e le loro dipendenze secondarie).
Scarica tutte le librerie nella cartella vendor presente nel root del progetto.
Genera il file composer.lock, che documenta le versioni esatte di ogni libreria installata. Devi sempre aggiungere composer.lock al sistema di versionamento (come Git) per garantire che collaboratori e ambienti di produzione lavorino con versioni delle dipendenze identiche.
Genera il file autoload vendor/autoload.php.

Se l'installazione va a buon fine, nella root del progetto troverai la cartella vendor e il file composer.lock.

Utilizzo dell'autoload di Composer

Una delle funzionalità fondamentali di Composer è l’autoload. Composer segue vari standard di caricamento (come PSR-0 e PSR-4), mappando i namespace ai path dei file tramite un file autoload generico.

Ecco come configurare e utilizzare l'autoload:

1. Configurare il campo `autoload`

Nel file composer.json puoi aggiungere o modificare la sezione autoload. Ad esempio, per mappare il namespace App\ alla directory src/, usando lo standard PSR-4:

json

{
    "require": {
        "monolog/monolog": "^2.0"
    },
    "autoload": {
        "psr-4": {
            "App\\": "src/"
        }
    }
}

Questo significa che tutte le classi che iniziano con App\ verranno autoloadate da Composer dalla cartella src/ (ad esempio App\MyClass dal file src/MyClass.php).

2. Generare il file di autoload

Dopo aver modificato la configurazione di autoload, aggiorna le mappature eseguendo:

composer dump-autoload

Il comando rigenera il file vendor/autoload.php. Se installi o aggiorni le dipendenze e non hai modificato autoload, l’esecuzione di composer install o composer update aggiornerà automaticamente anche il file autoload.

3. Includere il file di autoload nel codice

All'inizio del tuo script PHP, inserisci:

php

<?php

// Includi il file di autoload generato da Composer
require __DIR__ . '/vendor/autoload.php';

// Ora puoi usare direttamente le librerie installate via Composer o le tue classi configurate nell'autoload
use Monolog\Logger;
use Monolog\Handler\StreamHandler;
use App\MyClass; // Se hai configurato il namespace App\ per l'autoload

// Uso della libreria Monolog
$log = new Logger('name');
$log->pushHandler(new StreamHandler('your.log', Logger::WARNING));
$log->warning('Questa è un'avvertenza!');

// Uso di una tua classe (se configurata nell'autoload)
// $myObject = new MyClass();
// $myObject->doSomething();

?>

Grazie a require __DIR__ . '/vendor/autoload.php'; puoi utilizzare tutte le classi gestite da Composer senza gestire a mano una moltitudine di istruzioni require o include, semplificando radicalmente il codice.

Aggiornamento delle dipendenze

Man mano che il progetto cresce o le librerie si aggiornano, potrebbe essere necessario allineare le versioni delle dipendenze.

Apri il terminale nella root del progetto ed esegui:

composer update

composer update verifica se le dipendenze elencate in composer.json e le loro sub-dipendenze hanno nuove versioni compatibili con i vincoli specificati.
Se trova nuove versioni, le installerà automaticamente.
Aggiornerà infine il file composer.lock con le versioni appena installate delle librerie.

Nota importante:

composer install vs composer update: usa composer install al primo setup o per installare le dipendenze di un progetto esistente: segue esattamente le versioni registrate in composer.lock. Usando composer update, invece, aggiorni le dipendenze alle ultime versioni compatibili con composer.json e aggiorni anche composer.lock. Nel lavoro di squadra, esegui composer update solo quando vuoi aggiornare una o più dipendenze, e ricordati di committare sia composer.json sia composer.lock dopo averlo fatto.

Accorgimenti per l'utilizzo di Composer in ServBay

ServBay rende lo sviluppo locale molto più agevole, ma usa questi accorgimenti quando lavori con Composer:

Ambiente terminale: assicurati di eseguire i comandi Composer da un terminale inizializzato dall'ambiente ServBay. ServBay aggiunge la versione PHP attiva al PATH, quindi puoi usare direttamente i comandi php e composer nelle nuove finestre di terminale. Se ricevi l'errore command not found, prova a riavviare il terminale o verificare che ServBay sia attivo.
Versione PHP: ServBay ti permette di cambiare facilmente versione di PHP. I comandi composer usano la versione attiva di PHP impostata dal pannello ServBay. Se un progetto richiede una versione PHP specifica (ad esempio una libreria che funziona solo su vecchie versioni di PHP), cambia prima la versione PHP nel pannello ServBay, poi esegui Composer.
Percorso del progetto: per semplicità, crea i tuoi progetti web nelle sottocartelle di /Applications/ServBay/www e mappali tramite il pannello ServBay così da poterli raggiungere tramite il browser. Esegui i comandi Composer nelle sottocartelle dei tuoi progetti.

Esempio pratico: uso della libreria GuzzleHttp

Ecco come installare e usare GuzzleHttp (una popolare libreria per richieste HTTP in PHP) in ambiente ServBay:

Crea la directory del progetto ed entra: Nella root dei siti ServBay, crea una nuova directory e spostati al suo interno:
sh
```
cd /Applications/ServBay/www
mkdir guzzle_demo.servbay.demo
cd guzzle_demo.servbay.demo
```
1
2
3
In questo esempio, la directory ha il nome di dominio dimostrativo raccomandato da ServBay.
Crea il file composer.json: Nella cartella guzzle_demo.servbay.demo, crea il file composer.json con questo contenuto:
json
```
{
    "require": {
        "guzzlehttp/guzzle": "^7.0"
    },
    "autoload": {
         "psr-4": {
             "App\\": "src/"
         }
     }
}
```
1
2
3
4
5
6
7
8
9
10
Si configura anche l’autoload secondo PSR-4: anche se non necessario in questo esempio, è una buona pratica.
Installa le dipendenze: Esegui dalla stessa cartella:
sh
```
composer install
```
1
Composer scarica GuzzleHttp e tutte le dipendenze, crea le cartelle vendor e il file composer.lock.

Crea un file PHP e usa la libreria: Crea il file index.php:

php

<?php
// Includi il file di autoload generato da Composer
require __DIR__ . '/vendor/autoload.php';

use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;

echo "<h1>Demo GuzzleHttp</h1>";
echo "<pre>";

try {
    // Crea un'istanza client Guzzle
    $client = new Client();

    // Effettua una richiesta GET
    $response = $client->request('GET', 'https://httpbin.org/get', [
        'query' => ['param1' => 'value1', 'param2' => 'value2']
    ]);

    // Ottieni il corpo della risposta
    $body = $response->getBody()->getContents();
    echo "Corpo della risposta:\n";
    echo $body;

    // Ottieni il codice di stato della risposta
    $statusCode = $response->getStatusCode();
    echo "\n\nStatus Code: " . $statusCode;

} catch (RequestException $e) {
    // Gestione delle eccezioni richieste
    echo "Eccezione nella richiesta:\n";
    echo $e->getMessage();
    if ($e->hasResponse()) {
        echo "\nStato risposta: " . $e->getResponse()->getStatusCode();
        echo "\nCorpo risposta: " . $e->getResponse()->getBody()->getContents();
    }
} catch (\Exception $e) {
    // Gestione di altre eccezioni
    echo "Si è verificato un errore:\n";
    echo $e->getMessage();
}

echo "</pre>";
?>

Il file include l'autoload e usa GuzzleHttp per inviare una richiesta API di test, stampando il risultato.

Configura il sito in ServBay: Apri il pannello ServBay, vai nella scheda “Siti” (ex “Host”), clicca su Aggiungi, configura il nuovo sito puntando a /Applications/ServBay/www/guzzle_demo.servbay.demo e imposta il dominio come guzzle_demo.servbay.demo. Salva le impostazioni e riavvia il relativo server web (Caddy, Nginx, ecc.).
Accedi tramite browser: Accedi a http://guzzle_demo.servbay.demo/ dal browser. Vedrai i risultati dello script PHP con i dati restituiti da https://httpbin.org/get.

Domande frequenti (FAQ)

D: Uso PHP 5.6 e Composer non funziona. Come posso risolvere?

R: ServBay mette a disposizione due versioni di Composer, la 2.8.x più recente e la 2.2.x LTS compatibile con vecchie versioni di PHP. Installa Composer 2.2 LTS e usa il comando composer-2.2 per PHP 5.6.

D: Ricevo l’errore command not found quando eseguo composer dal terminale. Che fare?

Verifica che ServBay sia in esecuzione.
Chiudi e riapri il terminale. ServBay aggiunge le variabili d’ambiente al lancio e le nuove istanze del terminale caricano queste variabili.
Assicurati che almeno una versione PHP sia attivata nel pannello ServBay.
Se ancora non va, prova a lanciare Composer specificando il percorso PHP e lo script Composer, per esempio /Applications/ServBay/php/8.2/bin/php /usr/local/bin/composer install (adattando il path in base alle tue versioni e installazioni, anche se l’obiettivo di ServBay è permetterti di usare semplicemente il comando composer).

D: Come posso scegliere quale versione PHP usare con Composer in ServBay?

R: Composer userà la versione PHP attivata nel pannello di controllo ServBay. Per cambiare, seleziona la versione PHP desiderata dal tab PHP di ServBay, rendila attiva e apri un nuovo terminale: il comando composer userà quella versione.

D: A cosa serve il file composer.lock? Bisogna aggiungerlo a Git?

R: Il file composer.lock registra esattamente le versioni delle dipendenze installate l’ultima volta che hai eseguito composer install o composer update. Si raccomanda vivamente di aggiungere composer.lock al repository Git, per garantire che collaboratori, ambiente di test e produzione abbiano le stesse versioni delle dipendenze e per evitare problemi "funziona solo sul mio PC". Quando altri cloneranno il tuo progetto ed eseguiranno composer install, Composer seguirà le versioni di composer.lock e non solo i vincoli di composer.json.

Conclusione

ServBay, grazie all’integrazione di Composer, offre agli sviluppatori PHP un ambiente locale efficiente e pratico. Potrai gestire facilmente le dipendenze dei progetti, sfruttare il sistema di autoload e usare diverse versioni PHP, concentrandoti solo sul codice e migliorando produttività e qualità delle applicazioni. La combinazione di ServBay e Composer è una soluzione potente per il moderno sviluppo PHP, velocizzando la creazione e la manutenzione dei tuoi progetti.

Come utilizzare Composer integrato in ServBay per la gestione dei progetti PHP ​

Introduzione a Composer ​

Caratteristiche principali ​

Composer integrato in ServBay ​

Gestione delle dipendenze del progetto con Composer ​

1. Creare il file composer.json ​

2. Installare le dipendenze ​

Utilizzo dell'autoload di Composer ​

1. Configurare il campo autoload ​

2. Generare il file di autoload ​

3. Includere il file di autoload nel codice ​

Aggiornamento delle dipendenze ​

Accorgimenti per l'utilizzo di Composer in ServBay ​

Esempio pratico: uso della libreria GuzzleHttp ​

Domande frequenti (FAQ) ​

Conclusione ​