Laravel Scope

Понимание Областей (Scopes) в Laravel

Laravel Scope — это мощная функция в Laravel Eloquent ORM, которая позволяет разработчикам определять ограничения многократного использования запросов. Используя Laravel Scopes, вы можете создавать более чистый и эффективный код и оптимизировать запросы к базе данных. В этом подробном руководстве мы рассмотрим различные аспекты Laravel Scopes и продемонстрируем, как эффективно реализовать их в ваших веб-приложениях.

Что такое Scopes в Laravel?

Области (Scopes) в Laravel - это специализированные методы, которые вы добавляете к моделям Eloquent для упрощения запросов к базе данных. Они позволяют вам определить и централизовать логику запросов, чтобы вы могли легко повторно использовать эти запросы в разных частях вашего приложения.

Где создаются области?

Области создаются непосредственно внутри ваших моделей Eloquent. Модель в Laravel - это класс, который представляет и работает с данными вашей таблицы базы данных. Например, если у вас есть таблица posts, вы, скорее всего, имеете модель Post.

Типы областей

1. Локальные Области (Local Scopes): Эти методы начинаются с префикса scope и добавляются в модели. Они вызываются явно в вашем коде, когда вы работаете с запросами.
2. Глобальные Области (Global Scopes): Эти области применяются ко всем запросам модели автоматически. Они определяются в методе booted модели.

Локальные области в Laravel Eloquent

Локальные области в Laravel Eloquent позволяют упаковать часто используемую логику запросов прямо внутри моделей. Это упрощает применение специфических условий к запросам базы данных, делая код более понятным и легким в поддержке.

Область по статусу

Этот пример демонстрирует создание локальной области для извлечения пользователей с определенным статусом из базы данных. Вот как это может быть реализовано:

public function scopeActive($query) {
    return $query->where('status', 'active');
}

Здесь scopeActive - это локальная область, добавленная к модели User. Она позволяет фильтровать пользователей по статусу 'active'. Вызов этой области выглядит так:

$activeUsers = User::active()->get();

Этот код возвращает всех активных пользователей. Это упрощает повторное использование запроса и делает код более читаемым.

Область по категории

Этот пример показывает, как создать область для выборки продуктов, принадлежащих определенной категории:

public function scopeByCategory($query, $categoryId) {
    return $query->where('category_id', $categoryId);
}

Здесь scopeByCategory позволяет фильтровать продукты по category_id. Пример использования:

$categoryProducts = Product::byCategory(1)->get();

Этот запрос вернет все продукты из категории с id = 1.

Область с параметрами

Этот пример демонстрирует создание области с параметрами для фильтрации результатов на основе критериев, определенных пользователем, например, диапазонов дат:

public function scopePublishedBetween($query, $startDate, $endDate) {
    return $query->whereBetween('published_at', [$startDate, $endDate]);
}

Здесь scopePublishedBetween позволяет фильтровать записи по дате публикации. Пример использования:

$postsBetweenDates = Post::publishedBetween('2024-01-01', '2024-07-31')->get();

Этот запрос вернет все записи, опубликованные между '2024-01-01' и '2024-07-31'.

Локальные области в Laravel Eloquent - это мощный инструмент для создания читаемых и легко поддерживаемых запросов. Они позволяют инкапсулировать логику запросов в моделях, что упрощает повторное использование и поддержку кода.

Работа с глобальными областями в Laravel

Глобальные области в Laravel автоматически используются в каждом запросе к определенной модели Eloquent. Они очень удобны для установления общих правил, которые будут работать везде в вашем приложении, помогая поддерживать единообразие и порядок в коде.

Глобальная область для многопользовательской среды

Этот пример демонстрирует использование глобальной области для извлечения данных, специфичных для определенного арендатора (tenant) в многопользовательском приложении. Пример реализации:

protected static function booted() {
    static::addGlobalScope('tenant', function (Builder $builder) {
        $builder->where('tenant_id', auth()->user()->tenant_id);
    });
}

Здесь в методе booted модели добавляется глобальная область с именем 'tenant'. Эта область автоматически применяется ко всем запросам к этой модели, ограничивая их данными, соответствующими текущему арендатору. Пример использования:

$tenantPosts = Post::all();

Этот запрос вернет все записи, которые принадлежат арендатору текущего пользователя.

Мягкое удаление с глобальной областью

Этот пример показывает, как реализовать глобальную область для автоматического исключения мягко удаленных записей из всех запросов:

protected static function booted() {
    static::addGlobalScope('soft_delete', function (Builder $builder) {
        $builder->whereNull('deleted_at');
    });
}

Здесь в методе booted добавляется глобальная область 'soft_delete', которая исключает из запросов все записи с ненулевым значением в поле deleted_at. Это обеспечивает, что мягко удаленные записи не будут появляться в результатах запросов. Пример использования:

$activePosts = Post::all();

Этот запрос вернет все записи, которые не были мягко удалены.

Глобальные области в Laravel - это мощный инструмент для определения ограничений, которые автоматически применяются ко всем запросам определенной модели. Они особенно полезны для реализации функций, таких как многопользовательская среда и мягкое удаление, обеспечивая единообразие и безопасность данных на уровне приложения.

Динамические области в Laravel

Динамические области в Laravel позволяют нам создавать гибкие условия для запросов к базе данных, которые можно легко настраивать "на лету", используя разные параметры. Это делает запросы более универсальными и эффективными, поскольку они могут быть адаптированы к различным ситуациям без необходимости писать много дополнительного кода.

Фильтрация продуктов по цене

Этот пример иллюстрирует создание динамической области, позволяющей пользователям фильтровать продукты по диапазону цен:

public function scopePriceRange($query, $minPrice, $maxPrice) {
    return $query->whereBetween('price', [$minPrice, $maxPrice]);
}

Здесь scopePriceRange - это динамическая область, добавленная к модели Product. Она позволяет фильтровать продукты по цене, находящейся в заданном диапазоне. Пример использования:

$affordableProducts = Product::priceRange(10, 50)->get();

Этот запрос вернет все продукты, цена которых находится в диапазоне от 10 до 50.

Динамическая сортировка записей

Этот пример показывает, как реализовать динамическую область, позволяющую пользователям сортировать записи по различным критериям:

public function scopeSortBy($query, $column, $direction = 'asc') {
    return $query->orderBy($column, $direction);
}

Здесь scopeSortBy позволяет динамически сортировать записи по указанному столбцу и направлению. Пример использования:

$sortedPosts = Post::sortBy('created_at', 'desc')->get();

Этот запрос вернет все записи, отсортированные по дате создания в убывающем порядке.

Динамические области в Laravel предоставляют гибкость для создания сложных запросов, которые могут быть легко настроены во время выполнения. Это делает код более адаптивным и удобным для повторного использования, позволяя разработчикам легко настраивать поведение запросов в зависимости от потребностей приложения.

Использование областей Laravel для безопасности

Laravel Scopes помогает улучшить безопасность вашего приложения. Он позволяет точно управлять тем, кто и как может получать доступ к данным, защищая приложение от доступа неавторизованных пользователей.

Защита профилей пользователей

Этот пример демонстрирует создание области, которая ограничивает доступ к профилям пользователей, позволяя просматривать чувствительную информацию только владельцу профиля или администратору:

public function scopeAccessibleByUser($query, $userId) {
    return $query->where(function ($query) use ($userId) {
        $query->where('user_id', $userId)
              ->orWhere('is_public', true);
    });
}

Здесь scopeAccessibleByUser добавляется к модели UserProfile. Эта область позволяет фильтровать профили так, чтобы пользователь мог видеть только свой профиль или публичные профили.

Используя замыкание, мы явно группируем эти два условия вместе, так что они будут обрабатываться как единое целое. Это означает, что запрос вернет записи, где user_id соответствует указанному userId ИЛИ где is_public установлено в true, независимо от других условий, которые могут быть добавлены к запросу.

В SQL это будет выглядеть примерно так:

SELECT * FROM table WHERE (user_id = ? OR is_public = true) AND другие_условия;

Пример использования:

$userProfile = UserProfile::accessibleByUser(auth()->user()->id)->get();

Этот запрос вернет профиль текущего пользователя, если он приватный, или все публичные профили.

Управление разрешениями

Этот пример показывает, как создать область для управления доступом пользователей к определенным ресурсам на основе их роли:

public function scopeAccessibleByRole($query, $role) {
    return $query->where('required_role', $role);
}

Здесь scopeAccessibleByRole добавляется к модели Resource. Эта область позволяет фильтровать ресурсы на основе роли пользователя. Пример использования:

$accessibleResources = Resource::accessibleByRole('admin')->get();

Этот запрос вернет все ресурсы, доступные для пользователя с ролью 'admin'.

Использование областей для управления безопасностью и доступом в Laravel позволяет разработчикам эффективно контролировать, какие данные и функции доступны различным пользователям. Это помогает предотвратить несанкционированный доступ и улучшает общую безопасность приложения.

Лучшие практики Scopes в Laravel

Для того чтобы наилучшим образом использовать области в Laravel и сделать код более удобным в обслуживании и эффективным, важно придерживаться проверенных методик и рекомендаций.

Переиспользование областей

Этот пример подчеркивает важность создания областей, которые могут быть легко переиспользованы в разных частях приложения. Это способствует чистоте кода и его удобству в поддержке. Пример:

public function scopePublished($query) {
    return $query->where('published', true);
}

public function scopeFeatured($query) {
    return $query->where('featured', true);
}

Здесь scopePublished и scopeFeatured добавлены к модели Post. Они позволяют фильтровать записи по статусу публикации и признаку избранности соответственно. Пример использования:

$featuredPosts = Post::published()->featured()->get();

Этот запрос вернет все опубликованные записи, которые также являются избранными.

Избегание чрезмерно сложных областей

Важно избегать создания областей, которые слишком сложны и пытаются делать слишком многое. Сложные области могут быть трудными для понимания и поддержки. Пример простой области:

public function scopeShippedWithinDays($query, $days) {
    return $query->whereDate('shipped_at', '>=', now()->subDays($days));
}

Эта область позволяет фильтровать заказы, отправленные в течение определенного количества дней. Пример использования:

$recentOrders = Order::shippedWithinDays(30)->get();

Этот запрос вернет все заказы, отправленные за последние 30 дней.

Тестирование областей

Тестирование областей помогает убедиться в их корректности и предотвращает регрессии в будущем. Пример теста для области:

public function testScopePublished() {
    factory(Post::class)->create(['published' => true]);
    factory(Post::class)->create(['published' => false]);

    $publishedPosts = Post::published()->get();

    $this->assertCount(1, $publishedPosts);
}

Здесь тест проверяет, что область published корректно фильтрует записи.

Заключение

Следование этим лучшим практикам при использовании областей в Laravel помогает создавать более чистый, поддерживаемый и надежный код. Области - это мощный инструмент, который, при правильном использовании, значительно улучшает качество и эффективность разработки.