Laravel 学习记录

Appearance

Model Relations 模型关系 ​

关联关系的最新/旧项 ​

从 Laravel 8.42 开始，在 Eloquent 模型中，可以定义一个关系，该关系将获取另一个关系的最新（或最旧）项目。

php
/**
 * Get the user's latest order.
 */
public function latestOrder()
{
    return $this->hasOne(Order::class)->latestOfMany();
}
 
/**
 * Get the user's oldest order.
 */
public function oldestOrder()
{
    return $this->hasOne(Order::class)->oldestOfMany();
}

关联数据排序 ​

可以直接在 Eloquent 关系上指定 orderBy() 对数据进行默认排序。

php
public function products()
{
    return $this->hasMany(Product::class);
}
 
public function productsByName()
{
    return $this->hasMany(Product::class)->orderBy('name');
}

条件关系 ​

如果发现经常使用相同的关系和附加 where 条件，则可以创建单独的关系方法。

php
public function comments()
{
    return $this->hasMany(Comment::class);
}
 
public function approvedComments()
{
    return $this->hasMany(Comment::class)->where('approved', 1);
}

将条件语句添加到多对多关系 ​

在多对多关系中，可以使用 wherePivot 方法将 where 语句添加到数据中间表。

php
class Developer extends Model
{
     // Get all clients related to this developer
     public function clients()
     {
          return $this->belongsToMany(Clients::class);
     }
 
     // Get only local clients
     public function localClients()
     {
          return $this->belongsToMany(Clients::class)
               ->wherePivot('is_local', true);
     }
}

重命名数据中间表 ​

如果想重命名 pivot 并指定关联的名称，只需在关系中使用 ->as('name') 即可。

php
public function podcasts() {
    return $this->belongsToMany(Podcast::class)
        ->as('subscription') 
        ->withTimestamps();
}

// 使用
$podcasts = $user->podcasts();
foreach ($podcasts as $podcast) {
    // 使用下面的方式替换 $podcast->pivot->created_at ...
    echo $podcast->subscription->created_at; 
}

havingRaw 查询语句 ​

可以在各个地方使用 RAW 数据库查询，包括在 groupBy() 之后使用 havingRaw() 函数。

php
Product::groupBy('category_id')->havingRaw('COUNT(*) > 1')->get();

has 多种关联关系查询 ​

可以使用模型 has() 方法来查询两层甚至更深的关联关系。

php
// Author -> hasMany(Book::class);
// Book -> hasMany(Rating::class);

Author::has('books.ratings')->get();

has 条件 ​

在 hasMany() 关联关系中，可以过滤掉具有指定数量的记录。

php
// Author -> hasMany(Book::class)

$authors = Author::has('books', '>', 5)->get();

withDefault 默认模型 ​

可以在 belongsTo 关系中指定默认模型，以避免在调用它时出现致命错误。

例如：$post->user 不存在，当 $post->user->name 获取 name 时会抛出致命错误。

php
public function user()
{
    return $this->belongsTo(User::class)->withDefault();
}

saveMany 批量创建 ​

如果有 hasMany() 关系，可以使用 saveMany() 从父对象中保存多个子项。

php
$post = Post::find(1);

$post->comments()->saveMany([
    new Comment(['message' => 'First comment']),
    new Comment(['message' => 'Second comment']),
]);

多层预加载 ​

可以在一条语句中预加载多个级别，在下面的示例中，不仅加载作者关系，还加载作者模型上的国家关系。

php
// Book -> belongsTo(Author::class)
// Author -> belongsTo(Country::class)

$users = Book::with('author.country')->get();

使用精确列进行预加载 ​

执行预加载时可以指定想要从关系中获取的确切列。

php
// Book -> belongsTo(Author::class)

$users = Book::with('author:id,name')->get();

即使在更深层次的嵌套关系中也可以获取确切列：

php
// Book -> belongsTo(Author::class)
// Author -> belongsTo(Country::class)

$users = Book::with('author.country:id,name')->get();

更新父级 ​

如果正在更新记录并想要更新 belongsTo 关系的 updated_at 列。

例如，添加新的帖子评论并希望 posts.updated_at 更新，只需要在 Comment 模型上定义 $touches 属性。

php
class Comment extends Model
{
    protected $touches = ['post'];

    public function post()
    {
        return $this->belongsTo(Post::class); 
    }
}

也可以这样更新模型关系数据：

php
// Project -> belongsTo(User::class)

$project->user->update(['email' => 'some@gmail.com']);

withCount() 计算子关系记录 ​

如果有 hasMany() 关系，并且想要计算“子”条目，请不要编写特殊查询。

例如，如果在 User 模型上有帖子和评论，请用 withCount() 编写：

php
// User => hasMany(Post::class)
// Post => hasMany(Commend::clas)

User::withCount(['posts', 'comments'])->get();

// 使用 {relationship}_count 属性访问这些值
$user->posts_count
$user->comments_count

// 还可以按该字段进行排序
User::withCount('comments')->orderBy('comments_count', 'desc')->get();

对关系的额外过滤 ​

如果要加载关系数据，可以在闭包函数中指定一些限制或排序。

例如想获取只有三个最大城市的国家/地区，可以使用以下代码：

php
// Country => hasMany(City::class)

Country::with([
    'cities' => function ($query) {
        $query->orderBy('population', 'desc')->limit(3);
    }
])->get();

动态加载关系 ​

不仅可以指定始终随模型加载的关系，还可以在模型的构造方法中动态执行此操作：

php
class Tag extends Model
{
    protected $with = ['product']; // [!code focus]
 
    public function __construct() {
        parent::__construct();
 
        if (auth()->check()) {// [!code focus]
            $this->with[] = 'user';// [!code focus]
        }// [!code focus]
    }
}

使用 hasMany 代替 belongsTo ​

对于 belongsTo 关系，在创建子记录时不要传递父记录的ID，而是使用 hasMany 关系来使得逻辑更加简单。

php
// Post -> belongsTo(User)
// User -> hasMany(Post)

// 创建文章，使用当前登录的用户
Post::create([
    'user_id' => auth()->id(),
    'title' => request('title'),
    'post_text' => request('post_text'),
]);

// 使用 hasMany 关系替代
auth()->user()->posts()->create([
    'title' => request('title'),
    'post_text' => request('post_text'),
]);

组合两个 whereHas ​

在模型关系中，可以将 whereHas() 和 orDoesntHave() 组合在一个查询中。

php
User::whereHas('roles', function($query) {
    $query->where('id', 1);
})
->orDoesntHave('roles')
->get();

inRandomOrder 随机排序 ​

可以使用 inRandomOrder() 来随机化模型查询结果，还可以使用它来随机查询加载的关系数据。

比如有一个问答系统，需要随机问题：

php
// 1. 如果想以随机获得问题
$questions = Question::inRandomOrder()->get();

// 2. 同时想以随机顺序获得问题选项，可以这样编写查询:
$questions = Question::with(['answers' => function ($q) {
    $q->inRandomOrder();
}])->inRandomOrder()->get();

whereRelation 语句 ​

php
// Laravel 8.57 之前
User::whereHas('posts', function ($query) {
    $query->where('published_at', '>', now());
})->get();
 
// Laravel 8.57 之后
User::whereRelation('posts', 'published_at', '>', now())->get();

updateExistingPivot 更新中间表 ​

如果要更新表上的现有中间表的数据记录，使用 updateExistingPivot 而不是 syncWithPivotValues。

php
// 中间表迁移文件
Schema::create('role_user', function ($table) {
    $table->unsignedId('user_id');
    $table->unsignedId('role_id');
    $table->timestamp('assigned_at');
})
 
// 第一个参数为记录ID
// 第二个参数为中间表更新的字段和值的数组
$user->roles()->updateExistingPivot(
    $id, ['assigned_at' => now()],
);