Accesseurs et modificateurs élégants dans Laravel

Dans cet article, nous présenterons les modificateurs et accesseurs d'Eloquent ORM dans le framework web Laravel. Après l'introduction, nous comprendrons ces concepts à travers quelques exemples.

Dans Laravel, les modificateurs et les accesseurs vous permettent de modifier les données avant de les enregistrer ou d'obtenir des données de la base de données. Plus précisément, les mutateurs vous permettent de modifier les données avant de les enregistrer dans la base de données. Les accesseurs, quant à eux, vous permettent de modifier les données après les avoir extraites de la base de données.

En fait, les modèles Laravel sont l'endroit central où vous pouvez créer des modificateurs et des méthodes d'accès. Bien sûr, c'est bien d'avoir toutes vos modifications au même endroit au lieu d'être dispersées à différents endroits.

Créer des accesseurs et des modificateurs dans les classes de modèles

Maintenant que vous êtes familiarisé avec les concepts de base des modificateurs et des accesseurs, nous allons passer au développement d'un exemple pratique pour le démontrer.

Je suppose que vous connaissez les modèles Eloquent dans Laravel, nous utiliserons la commande Post 模型作为示例的起点。如果您还没有创建 Post 模型，让我们使用 artisan pour les créer.

php artisan make:model Post --migration

Cela devrait créer un fichier modèle dans app/Post.php comme indiqué ci-dessous.

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

Remplaçons le contenu de ce fichier par le contenu suivant.

<?php
namespace App;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Casts\Attribute;

class Post extends Model
{
    /**
     * Interact with the user's name attribute.
     *
     * @param  string  $value
     * @return \Illuminate\Database\Eloquent\Casts\Attribute
     */
    protected function name(): Attribute
    {
        return Attribute::make(
            get: fn ($value) => ucfirst($value),
            set: fn ($value) => strtolower($value),
        );
    }
}

Puisque nous avons utilisé l'option --migration, elle devrait également créer des migrations de bases de données associées. Juste au cas où vous ne le sauriez pas, vous pouvez exécuter la commande suivante afin qu'elle crée réellement la table dans la base de données.

php artisan migrate

Pour exécuter les exemples de cet article, vous devez être dans la colonne post 表中创建 name. Quoi qu’il en soit, nous n’entrerons pas dans les détails de la migration car cela dépasse le cadre de cet article.

Méthode Mutateur

Tout d’abord, jetons un coup d’œil à la méthode mutateur.

protected function name(): Attribute
{
    return Attribute::make(
        #get: fn ($value) => ucfirst($value),
        set: fn ($value) => strtolower($value),
    );
}

Comme nous en avons discuté précédemment, les modificateurs sont utilisés pour modifier les données avant de les enregistrer dans la base de données. Comme vous pouvez le voir, la syntaxe d'une méthode mutator est une instance {attribute-name}。当然，您需要将 {attribute-name} 替换为驼峰大小写的实际属性名称。需要注意的是，所有访问器和修改器方法都会返回一个 Attribute, qui définit comment accéder et modifier la propriété.

Lors de l'appel de la méthode mutator sur une propriété, la fonction set 参数。为了简单起见，我们只使用了 strtolower est utilisée, qui convertit le titre du message en minuscules avant de l'enregistrer dans la base de données.

De cette façon, vous pouvez créer des méthodes de mutation sur toutes les colonnes du tableau. Examinons ensuite les méthodes d'accès.

Méthodes d'accès

Si vous utilisez des variables pour modifier les données avant de les enregistrer dans la base de données, des méthodes d'accès sont utilisées pour modifier les données après les avoir obtenues de la base de données. Pour définir une méthode accesseur, vous devez fournir le paramètre get lors de la définition de la propriété.

Jetons un coup d'œil aux méthodes d'accès.

protected function name(): Attribute
{
    return Attribute::make(
        get: fn ($value) => ucfirst($value),
        #set: fn ($value) => strtolower($value),
    );
}

Le paramètre name 属性的值后，将调用 get 参数。在我们的例子中，我们刚刚使用 ucfirst est appelé après avoir obtenu la valeur de l'attribut

de la base de données. Dans notre cas, nous avons simplement utilisé la méthode ucfirst pour changer le titre du message.

Jusqu'à présent, nous venons de créer les méthodes assignateur et accesseur, mais nous les testerons dans les sections suivantes.

Le rôle du mutateur

Créons un contrôleur sur app/Http/Controllers/MutatorController.php

afin de pouvoir tester la méthode mutator que nous avons créée dans la section précédente.

<?php
// app/Http/Controllers/MutatorController.php
namespace App\Http\Controllers;
 
use App\Post;
use App\Http\Controllers\Controller;
 
class MutatorController extends Controller
{
    public function index()
    {
        // create a new post object
        $post = new Post;
        $post->name = 'Post Title';
        $post->save();
    }
}

De plus, vous devrez créer des routes associées dans le fichier routes/web.php

pour accéder au contrôleur de mutateur.

Route::get('mutator/index', 'MutatorController@index');

index 方法中，我们使用 Post 模型创建一个新帖子。它应该将 name 列的值设置为 post title 值，因为我们在相应的 mutator 方法中使用了 strtolower dans la fonction

.

Accesseurs en action

Pour voir l'accesseur en action, allons-y et créons un fichier de contrôleur avec le contenu suivant app/Http/Controllers/AccessorController.php

 :

<?php
namespace App\Http\Controllers;
 
use App\Post;
use App\Http\Controllers\Controller;
 
class AccessorController extends Controller
{
    public function index()
    {
        // load post
        $post = Post::find(1);
         
        // check the name property, it should be output of the ucfirst function
        echo $post->name;
        exit;
    }
}

Encore une fois, vous devez utiliser la route associée dans le fichier routes/web.php

pour accéder au contrôleur d'accesseur.

Route::get('accessor/index', 'AccessorController@index');

index 方法中，我们首先使用 PostDans le modèle pour charger des exemples de publications.

nameEnsuite, nous vérifions la valeur de la colonne

, elle doit commencer par une lettre majuscule car nous avons défini une méthode d'accesseur pour cette colonne.

C'est ainsi que fonctionnent les mutateurs et accesseurs Eloquent ! 🎜

Conclusion

Aujourd'hui, nous avons exploré les concepts de modificateurs et d'accesseurs pour l'ORM Eloquent dans Laravel. Il constitue un excellent moyen de modifier les données avant de les enregistrer dans la base de données et de les extraire de la base de données.

Pour ceux d'entre vous qui débutent avec Laravel ou qui cherchent à élargir leurs connaissances, leur site Web ou leur application avec des extensions, nous proposons une variété de contenus sur lesquels vous pourrez apprendre sur le marché Envato.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!