Cours pour apprendre à utiliser le framework Laravel 5.5

Les bases

III. Installation et organisation▲

Dans ce chapitre nous allons voir comment créer une application Laravel et comment le code est organisé dans une application.

Pour utiliser Laravel et suivre ce chapitre et l'ensemble du cours vous aurez besoin d'un serveur équipé de PHP avec au minimum la version 7 et aussi de MySQL. Nous avons vu dans le précédent chapitre les différentes possibilités.

Quelle que soit l'application que vous utilisez, vérifiez que vous avez la bonne version de PHP (minimum 7). D'autre part plusieurs extensions de PHP doivent être activées.

III-A. Créer une application Laravel▲

III-A-1. Le serveur▲

Pour fonctionner correctement, Laravel a besoin de PHP :

version >= 7.0.0 ;
extension PDO ;
extension Mbstring ;
extension OpenSSL ;
extension Tokenizer ;
extension XML.

Laravel est équipé d'un serveur sommaire pour le développement qui se lance avec cette commande :

Sélectionnez

php artisan serve

On y accède à cette adresse : http://localhost:8000. Mais évidemment pour que ça fonctionne il faut que vous ayez PHP installé.

III-A-2. Prérequis▲

Composer fonctionne en ligne de commande. Vous avez donc besoin de la console (nommée Terminal ou Konsole sur OS X et Linux). Les utilisateurs de Linux sont très certainement habitués à l'utilisation de la console mais il n'en est généralement pas de même pour les adeptes de Windows. Pour trouver la console sur ce système il faut chercher l'invite de commande :

Si vous utilisez Laragon, comme je vous le conseille, vous avez une console améliorée (Cmder) accessible avec ce bouton.

III-A-3. Installation avec Composer▲

Il y a plusieurs façons de créer une application Laravel. La plus classique consiste à utiliser la commande create-project de composer. Par exemple je veux créer une application dans un dossier laravel5 à la racine de mon serveur, voici la syntaxe à utiliser :

Sélectionnez

composer create-project --prefer-dist laravel/laravel laravel5

L'installation démarre et je n'ai plus qu'à attendre quelques minutes pour que composer fasse son travail jusqu'au bout. Vous verrez s'afficher une liste de téléchargements. Finalement on se retrouve avec cette architecture :

On peut vérifier que tout fonctionne bien avec l'URL http://localhost/laravel5/public. Normalement on doit obtenir cette page très épurée :

Pour les mises à jour ultérieures il suffit encore d'utiliser composer avec la commande update :

Sélectionnez

composer update

III-A-4. Installation avec Laravel Installer▲

Une autre solution pour installer Laravel consiste à utiliser l'installeur. Il faut commencer par installer globalement l'installeur avec composer :

Sélectionnez

composer global require "laravel/installer"

Il faut ensuite informer la variable d'environnement path de l'emplacement du dossier …/composer/vendor/bin.

Pour créer une application il suffit de taper :

Sélectionnez

laravel new monAppli

Laravel sera alors installé dans le dossier monAppli.

III-A-5. Installation avec Laragon▲

Une façon encore plus simple pour installer Laravel est d'utiliser Laragon avec le menu :

On vous demande alors le nom du projet (donc du dossier) :

Et ensuite vous n'avez plus qu'à attendre ! La console s'ouvre et vous pouvez suivre le déroulement des opérations. On vous rappelle la commande de composer et en plus une base de données est automatiquement créée avec le même nom !

Si vous installez Laravel en téléchargeant directement les fichiers sur Github et en utilisant la commande composer install il vous faut effectuer deux actions complémentaires. En effet dans ce cas il ne sera pas automatiquement créé de clé de sécurité et vous allez tomber sur une erreur au lancement. Il faut donc la créer avec la commande php artisan key:generate. D'autre part vous aurez à la racine le fichier .env.example que vous devrez renommer en .env (ou en faire une copie) pour que la configuration fonctionne.

III-A-6. Autorisations▲

Au niveau des dossiers de Laravel, les seuls qui ont besoin de droits d'écriture par le serveur sont storage (et ses sous-dossiers), et bootstrap/cache.

III-B. Des URL propres▲

Pour un serveur Apache il est prévu dans le dossier public un fichier .htaccess avec ce code :

Sélectionnez

1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.

<IfModule mod_rewrite.c>
    <IfModule mod_negotiation.c>
        Options -MultiViews
    </IfModule>

    RewriteEngine On

    # Redirect Trailing Slashes If Not A Folder...
    RewriteCond %{REQUEST_FILENAME} !-d
    RewriteCond %{REQUEST_URI} (.+)/$
    RewriteRule ^ %1 [L,R=301]

    # Handle Front Controller...
    RewriteCond %{REQUEST_FILENAME} !-d
    RewriteCond %{REQUEST_FILENAME} !-f
    RewriteRule ^ index.php [L]

    # Handle Authorization Header
    RewriteCond %{HTTP:Authorization} .
    RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
</IfModule>

Le but est essentiellement d'éviter d'avoir index.php dans l'URL. Mais pour que ça fonctionne il faut activer le module mod_rewrite.

III-C. Organisation de Laravel▲

Maintenant qu'on a un Laravel tout neuf et qui fonctionne voyons un peu ce qu'il contient…

III-C-1. Dossier app▲

Ce dossier contient les éléments essentiels de l'application :

Console : toutes les commandes en mode console ;
Http : tout ce qui concerne la communication : contrôleurs, middlewares (il y a 4 middlewares de base qui servent à filtrer les requêtes HTTP) et le kernel ;
Providers : tous les fournisseurs de services (providers), il y en a déjà 5 au départ. Les providers servent à initialiser les composants ;
User : un modèle qui concerne les utilisateurs pour la base de données.

Évidemment tout cela doit vous paraître assez nébuleux pour le moment mais nous verrons en détail ces éléments au fil du cours. Et on verra d'ailleurs que seront créés bien d'autres dossiers selon nos besoins.

III-C-2. Autres dossiers▲

Voici une description du contenu des autres dossiers :

bootstrap : scripts d'initialisation de Laravel pour le chargement automatique des classes, la fixation de l'environnement et des chemins et pour le démarrage de l'application ;
public : tout ce qui doit apparaître dans le dossier public du site : images, CSS, scripts… ;
config : toutes les configurations : application, authentification, cache, base de données, espaces de noms, emails, systèmes de fichier, session… ;
database : migrations et populations ;
resources : vues, fichiers de langage et assets (par exemple les fichiers Sass) ;
routes : la gestion des URL d'entrée de l'application ;
storage : données temporaires de l'application : vues compilées, caches, clés de session… ;
tests : fichiers de tests ;
vendor : tous les composants de Laravel et de ses dépendances (créé par composer).

III-C-3. Fichiers de la racine▲

Il y a un certain nombre de fichiers dans la racine dont voici les principaux :

artisan : outil en ligne de Laravel pour des tâches de gestion ;
composer.json : fichier de référence de composer ;
package.json : fichier de référence de npm pour les assets ;
phpunit.xml : fichier de configuration de phpunit (pour les tests unitaires) ;
.env : fichier pour spécifier l'environnement d'exécution.

Nous verrons tout cela progressivement dans le cours, ne vous inquiétez pas !

III-C-4. Accessibilité▲

Pour des raisons de sécurité sur le serveur, seul le dossier public doit être accessible :

Cette configuration n'est pas toujours possible sur un serveur mutualisé, il faut alors modifier un peu Laravel pour que ça fonctionne ; j'en parlerai dans le chapitre sur le déploiement.

III-D. Environnement et messages d'erreur▲

Par défaut lorsque vous installez Laravel, celui-ci est en mode « debug » et vous aurez une description précise de toutes les erreurs. Par exemple ouvrez le fichier routes/web.php et changez ainsi le code :

Sélectionnez

Route::post('/', function () {
    return view('welcome');
});

Ouvrez l'URL de base, vous obtenez cette page :

Laravel utilise la librairie Whoops pour les erreurs.

Pendant la phase de développement on a besoin d'obtenir des messages explicites pour traquer les erreurs inévitables que nous allons faire. En mode « production » il faudra changer ce mode, pour cela ouvrez le fichier .env et trouvez cette ligne :

Sélectionnez

'debug' => env('APP_DEBUG', false),

Autrement dit on va chercher la valeur dans l'environnement, mais où peut-on le trouver ? Regardez à la racine des dossiers, vous y trouvez le fichier .env.

Avec ce contenu :

Sélectionnez

APP_NAME=Laravel
APP_ENV=local
APP_KEY=base64:yrTZiYq/TxheZ3tBcqHo4X47uuSXROCY5gg3H0Pljt8=
APP_DEBUG=true
APP_LOG_LEVEL=debug
APP_URL=http://localhost

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=homestead
DB_USERNAME=homestead
DB_PASSWORD=secret

BROADCAST_DRIVER=log
CACHE_DRIVER=file
SESSION_DRIVER=file
QUEUE_DRIVER=sync

REDIS_HOST=127.0.0.1
REDIS_PASSWORD=null
REDIS_PORT=6379

MAIL_DRIVER=smtp
MAIL_HOST=smtp.mailtrap.io
MAIL_PORT=2525
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null

PUSHER_APP_ID=
PUSHER_APP_KEY=
PUSHER_APP_SECRET=

Vous remarquez que dans ce fichier la variable APP_DEBUG a la valeur true. On va la conserver ainsi puisqu'on veut être en mode « debug ». Vous êtes ainsi en mode débogage avec affichage de messages d'erreur détaillés. Si vous la mettez à false (ou si vous la supprimez), avec une URL non prévue vous obtenez maintenant juste :

Il ne faudra évidemment pas laisser la valeur true lors d'une mise en production ! On en reparlera lorsqu'on verra la gestion de l'environnement. Vous ne risquerez ainsi plus d'oublier de changer cette valeur parce que Laravel saura si vous êtes sur votre serveur de développement ou sur celui de production.

D'autre part il y a un fichier qui collecte les erreurs (Log), vous le trouvez ici :

Par défaut il n'y a qu'un fichier mais si vous préférez avoir un fichier par jour par exemple il suffit d'ajouter cette ligne dans le fichier .env :

Sélectionnez

APP_LOG=daily

De la même manière par défaut Laravel stocke toutes les erreurs. C'est pratique dans la phase de développement mais en production vous pouvez limiter le niveau de sévérité des erreurs retenues, par exemple si vous vous contentez des warning :

Sélectionnez

APP_LOG_LEVEL=warning

Laravel utilise le composant Monolog pour la gestion des erreurs. Reportez-vous à sa documentation si vous avez besoin de plus d'informations. La documentation de Laravel en résume l'essentiel ainsi que son adaptation au framework.

La valeur de APP_KEY qui sécurise les informations est automatiquement générée lors de l'installation avec create-project.

III-E. Une application d'exemple▲

Une application d'exemple complète servira de fil conducteur pour ce cours essentiellement à partir de sa deuxième partie mais vous pouvez déjà l'installer et la parcourir. Vous avez toutes les informations pour cette installation ici.

Plutôt que de créer des petits morceaux d'application limités et pas réalistes je me référerai à cette application complète pour certains chapitres de ce cours, comme par exemple tout ce qui concerne la gestion des bases de données.

Une grande partie du code de cette application d'exemple ne sera pas traitée dans ce cours et fera sans doute l'objet d'articles séparés. D'autre part cet exemple sera évolutif et suivra les suggestions que je reçois sur Github. Je le tiendrai également à jour en fonction des PR (Pull Request de Gihub) du projet Laravel.

III-F. En résumé▲

Pour son installation et sa mise à jour Laravel utilise le gestionnaire de dépendances composer.
La création d'une application Laravel se fait à partir de la console avec une simple ligne de commande.
Laravel est organisé en plusieurs dossiers.
Le dossier public est le seul qui doit être accessible pour le client.
L'environnement est fixé à l'aide du fichier .env.
Par défaut Laravel est en mode « debug » avec affichage de toutes les erreurs.

Copyright © 2018 Laravel. Aucune reproduction, même partielle, ne peut être faite de ce site ni de l'ensemble de son contenu : textes, documents, images, etc. sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu'à trois ans de prison et jusqu'à 300 000 € de dommages et intérêts.