30 хитрощів при роботі з Laravel Eloquent

$user = User::where('email', $email)->first();
if (!$user) {
  User::create([
    'email' => $email
  ]);
}

Зробіть:

$user = User::firstOrCreate(['email' => $email]);

03: Модельний метод boot()

У моделі Eloquent є чарівний метод boot(), в якому ви можете перевизначити дефолтну поведінку:

class User extends Model
{
    public static function boot()
    {
        parent::boot();
        static::updating(function($model)
        {
            // делаем протоколирование
            // переопределяем некоторые свойства, например $model->something = transform($something);
        });
    }
}

Один із найпопулярніших прикладів, це встановлення значень для деяких полів у момент створення об'єкта моделі.
Наприклад, генеруємо поле UUID у цей момент.

public static function boot()
{
  parent::boot();
  self::creating(function ($model) {
    $model->uuid = (string)Uuid::generate();
  });
}

04: Відносини з умовами та сортуванням

Це стандартний спосіб завдання відносин:

public function users() {
    return $this->hasMany(User::class);   
}

А ви знали, що ми одразу можемо додати методи where та orderBy?

Наприклад, якщо ви хочете задати певні відносини для користувачів певного типу, відсортованих електронною поштою, ви можете зробити так:

public function approvedUsers() {
    return $this->hasMany('App\User')->where('approved', 1)->orderBy('email');
}

05: Властивості моделі: тимчасові мітки, додавання тощо

Є кілька «параметрів» моделі Eloquent у формі властивостей цього класу.
Найпопулярніші з них такі:

class User extends Model {
    protected $table = 'users';
    protected $fillable = ['email', 'password']; // поля, которые можно заполнять при User::create()
    protected $dates = ['created_at', 'deleted_at']; // поля, которые должны быть преобразованы к датам
    protected $appends = ['field1', 'field2']; // дополнительные значения, возвращаемые в JSON
}

Але зачекайте, це ще не все:

protected $primaryKey = 'uuid'; // это не обязательно должен быть поле "id"
public $incrementing = false; // и оно не обязательно должно быть автоинкрементным
protected $perPage = 25; // Да, вы можете изменить счетчик пагинации в модели (по умолчанию: 15)
const CREATED_AT = 'created_at';
const UPDATED_AT = 'updated_at'; // Да, эти поля тоже можно менять
public $timestamps = false; // или даже вообще не использовать

І є ще більше, я просто перерахував найцікавіші. Щоб дізнатися більше, подивіться код абстрактного класу Model

06: Знайти кілька значень

Всі знають метод find(), вірно?

$user = User::find(1);

Я був дуже здивований, як мало хто знає, що цей метод може приймати кілька ідентифікаторів у вигляді масиву:

$users = User::find([1,2,3]);

07: WhereX

Є елегантний спосіб перетворити це:

$users = User::where('approved', 1)->get();

у це:

$users = User::whereApproved(1)->get();

Так, ви можете змінити ім'я будь-якого поля та додати його як суфікс до where, і це буде працювати.

Крім того, в Eloquent є кілька наперед визначених методів, пов'язаних з датою та часом:

User::whereDate('created_at', date('Y-m-d'));
User::whereDay('created_at', date('d'));
User::whereMonth('created_at', date('m'));
User::whereYear('created_at', date('Y'));

08: Сортування за відносинами

Трохи складніша хитрість. Наприклад, у вас є теми на форумі, і ви хочете відсортувати їх за останнім повідомленням. Звичайна справа для форумів, чи не так?

Спершу зробіть окреме відношення для останнього повідомлення у темі:

public function latestPost()
{
    return $this->hasOne(\App\Post::class)->latest();
}

А тепер, у нашому контролері, ми займемося магією:

$users = Topic::with('latestPost')->get()->sortByDesc('latestPost.created_at');

09: Eloquent::when() – без if-else

Багато хто з нас пишуть умовні запити за допомогою if-else, на кшталт такого:

if (request('filter_by') == 'likes') {
    $query->where('likes', '>', request('likes_amount', 0));
}
if (request('filter_by') == 'date') {
    $query->orderBy('created_at', request('ordering_rule', 'desc'));
}

Але є спосіб краще - використовуйте when():

$query = Author::query();
$query->when(request('filter_by') == 'likes', function ($q) {
    return $q->where('likes', '>', request('likes_amount', 0));
});
$query->when(request('filter_by') == 'date', function ($q) {
    return $q->orderBy('created_at', request('ordering_rule', 'desc'));
});

Можливо, він не виглядає більш коротким і елегантним, але він крутіший у передачі параметрів:

$query = User::query();
$query->when(request('role', false), function ($q, $role) {
    return $q->where('role_id', $role);
});
$authors = $query->get();

10: BelongsTo дефолтна модель

Допустимо у вас є Повідомлення (Post), що належить Автору (Author) і такий код у шаблоні Blade:

{{ $post->author->name }}

Але що якщо автор видалений або не встановлений з якоїсь іншої причини? Тоді ви отримаєте помилку, щось на зразок «property of non-object»
Звичайно, ви можете запобігти цьому:

{{ $post->author->name }}

Але ви можете зробити це на рівні Eloquent відносин:

public function author()
{
    return $this->belongsTo('App\Author')->withDefault();
}

У цьому прикладі відношення author() поверне порожню модель App\Author, якщо за Повідомленням не закріплено жодного Автора.

Крім того, ми можемо надати дефолтне значення цієї дефолтної моделі.

public function author()
{
    return $this->belongsTo('App\Author')->withDefault([
        'name' => 'Guest Author'
    ]);
}

11: Сортування за Перетворювачем

Уявимо, що ми маємо:

function getFullNameAttribute()
{
    return $this->attributes['first_name'] . ' ' . $this->attributes['last_name'];
}

Тепер спробуйте відсортувати по full_name. Не спрацює:

$clients = Client::orderBy('full_name')->get(); // не работает

Рішення досить просте. Нам потрібно відсортувати результати після їх отримання:

$clients = Client::get()->sortBy('full_name'); // заработало!

12: Дефолтне сортування у глобальному Scope

Наприклад, ви хочете, щоб User::all() завжди був відсортований по полю name. Для цього можна призначити глобальний Scope. Повернімося до методу boot(), про який ви вже говорили вище.

protected static function boot()
{
    parent::boot();


    // Сортировка поля name по возрастанию (ASC)
    static::addGlobalScope('order', function (Builder $builder) {
        $builder->orderBy('name', 'asc');
    });
}

Дізнайтесь більше про глобальних Scope тут.

13: Методи сирих запитів

Іноді нам потрібно додати сирі запити до наших викликів Eloquent. На щастя, для цього є функціонал.

// whereRaw
$orders = DB::table('orders')
->whereRaw('price > IF(state = "TX", ?, 100)', [200])
->get();


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


// orderByRaw
User::where('created_at', '>', '2016-01-01')
->orderByRaw('(updated_at - created_at) desc')
->get();

14. Replicate: копія рядка

Без поглиблених пояснень — найкращий спосіб зробити копію запису бази даних:

$task = Tasks::find(1);
$newTask = $task->replicate();
$newTask->save();

15: Метод chunk() для великих таблиць

Не зовсім про Eloquent, скоріше про Collection, проте ось потужний спосіб обробки великих наборів даних: ви можете розбити їх на частини.

Замість:

$users = User::all();
foreach ($users as $user) {
// ...

Ви можете зробити:

User::chunk(100, function ($users) {
foreach ($users as $user) {
// ...
}
});

16: Додаткові дії під час створення моделі

Ми всі знаємо цю команду Artisan

Але ви знаєте, що є три корисні прапори для створення файлів, пов'язаних з моделлю?

-m створить файл міграції
-c створить контролер
-r вказівку на те, що контролер повинен містити готові ресурси

17: Перевизначення updated_at під час збереження

А ви знали, що метод ->save() може приймати параметри?
У результаті ми можемо змусити його «ігнорувати» дефолтну функцію заповнення поля updated_at поточною позначкою часу. Дивіться:

$product = Product::find($id);
$product->updated_at = '2019-01-01 10:00:00';
$product->save(['timestamps' => false]);

Тут ми перевизначаємо дефолтну updated_at на нашу власну.

18: Який результат update()?

Чи ви замислювалися про те, що насправді повертає цей код?

$result = $products->whereNull('category_id')->update(['category_id' => 2]);

Я маю на увазі, що оновлення виконується в базі даних, але в результаті чого дорівнює змінна $result?

Відповідь на кількість порушених рядків. Тому, якщо вам потрібно перевірити, скільки рядків було порушено, вам не потрібно нічого викликати — метод update() поверне вам це число.

19: Перетворення дужок у запиті Eloquent

Що робити, якщо у вас у SQL запиті змішані AND та OR, наприклад:

... WHERE (gender = 'Male' and age >= 18) or (gender = 'Female' and age >= 65)

Як перекласти це до Eloquent? Неправильний спосіб:

$q->where('gender', 'Male');
$q->orWhere('age', '>=', 18);
$q->where('gender', 'Female');
$q->orWhere('age', '>=', 65);

$q->where(function ($query) {
    $query->where('gender', 'Male')
        ->where('age', '>=', 18);
})->orWhere(function($query) {
    $query->where('gender', 'Female')
        ->where('age', '>=', 65);
})

20: orWhere з кількома параметрами

Ви можете передати масив параметрів в orWhere().
«Звичайний» спосіб:

$q->where('a', 1);
$q->orWhere('b', 2);
$q->orWhere('c', 3);

Ви можете це зробити:

$q->where('a', 1);
$q->orWhere(['b' => 2, 'c' => 3]);