Eloquent ORM

1. À propos des modèles

Dans un contexte MVC (modèle-vue-contrôleur), et en particulier en programmation orientée objet, un modèle représente les données et la logique liée à ces données.

Voici quelques exemples de modèles pour un site de type e-commerce :

Avec Laravel, un modèle est représenté par une classe, avec des propriétés et des méthodes. Il est généralement lié à une table en base de données. L’ORM (Object-Relational Mapping) Eloquent permet de créer une correspondance entre les classes PHP et la base de données.

Ainsi, grâce à Eloquent, on pourra créer une classe Product pour représenter un produit, associée à une table products, accéder aux colonnes de la table au travers des propriétés de la classe et bénéficier de méthodes pour charger un produit, enregistrer un produit, lister tous les produits ou encore mettre à jour un produit.

2. Manipuler des objets

Eloquent permet donc de manipuler des objets de manière simple et intuitive, en créant une abstraction au-dessus de la base de données. Ainsi, manipuler des données SQL se fait naturellement en utilisant des objets PHP.

Exemple de manipulation d’un utilisateur...

1. Utiliser Artisan

php artisan make:model Article
 

<?php  
  
namespace App;  
  
use Illuminate\Database\Eloquent\Model;  
  
class Article extends Model  
{  
    //  
}
 

1. Créer et enregistrer une instance de modèle

$user_a = new User;  
$user_a->name = 'Colyne';  
  
$user_b = new User;  
$user_b->name = 'Arthur';  
  
$user_c = new $user;  
$user_c->name = 'Brian';
 

// Initialisation, définitions de propriétés  
$user_a = new User;  
$user_a->name = 'Colyne';  
  
$user_b = new User;  
$user_b->name = 'Arthur';  
  
$user_c = new $user;  
$user_c->name = 'Brian';  
  
// Enregistrement  
$user_a->save();  
$user_b->save();  
$user_c->save();
 

1. Espace de noms par défaut

Par défaut, les modèles sont créés dans le dossier app et ont pour espace de noms App. Cela signifie qu’à chaque fois qu’un fichier a besoin d’utiliser un modèle, il doit importer cet espace de noms. L’import d’un espace de noms se fait avec le mot-clé use et doit être effectué en début de fichier.

Exemple dans un fichier routes/web.php

<?php  
  
use App\User;  
use App\Document;  
  
// Affichage de tous les utilisateurs  
Route::get('users', function () {  
    $users = User::all();  
  
    return view('users', [  
        'users' => $users  
    ]);  
});  
  
// Affichage d'un document  
Route::get('documents/{id}', function ($id) {  
    $document = Document::findOrFail($id);  
  
    return view('document', [  
        'document' => $document  
    ]);  
});
 

2. Choisir un autre espace de noms

Quand une application se développe, de plus en plus de modèles sont créés à la racine du dossier app. Il est tout à fait possible de les laisser à cet endroit, mais généralement...

1. Relations 1..1

La relation 1..1 (one-to-one) correspond comme son nom anglais l’indique à une relation unique entre deux entités. Une entité est généralement représentée par un modèle.

Par exemple, si deux entités Company (société) et Address (adresse) existent, on peut déclarer qu’une société possède une et une seule adresse et qu’une adresse appartient à une et une seule société. Il y a donc une relation de un à un.

Dans la suite de cette section sur les relations 1..1, cet exemple de société lié à une adresse sera gardé et déroulé entièrement, depuis la création des modèles jusqu’à l’utilisation et la sauvegarde d’instances.

php artisan make:model Company --migration  
php artisan make:model Address --migration
 

1. Accesseurs

Les accesseurs permettent de définir des attributs personnalisés sur les modèles. Ce mécanisme peut être utilisé lorsqu’on souhaite modifier la façon dont une colonne en particulier est affichée, ou lorsqu’on souhaite créer un attribut personnalisé qui n’existe pas dans la table de la base de données.

Par exemple, dans l’espace administration d’un site, on peut vouloir afficher le nom de famille des utilisateurs en majuscules. Si la base de données contient une liste d’utilisateur dont le nom n’est pas toujours en majuscule, il sera possible de forcer la transformation du nom en majuscule dès qu’on y accède depuis le code PHP. Autrement dit, un accesseur permet de traiter différemment le stockage et l’affichage.

Pour définir un accesseur, ajoutez une méthode sur le modèle avec le préfixe get et le suffixe Attribute. Au milieu, placez le nom de la propriété en notation CamelCase. Par exemple, pour créer un accesseur sur un attribut author_name, il faut créer une méthode getAuthorNameAttribute. L’accesseur peut faire référence à une colonne existante (par exemple pour donner une valeur par défaut si la propriété est vide) ou un attribut créé...