Що таке Laravel Eloquent, як ним користуватися, посібник із прикладами

Фреймворк PHP Laravel включає Eloquent.

Eloquent — це ORM, тобто Object Relational Mapper.

Eloquent забезпечує надзвичайно простий спосіб спілкування з базою даних. 

Laravel e Eloquent вони допомагають прискорити розробку додатків і платформ, забезпечуючи адекватне вирішення більшості проблем управління структурованими даними. Вимоги задовольняються за допомогою швидшої розробки, а також добре організованого коду, який можна багаторазово використовувати, підтримувати та масштабувати. 

Приблизний час читання: 9 хвилин

Як працює Eloquent

Працювати з Eloquent це означає управління інформацією, присутність навіть у кількох базах даних, ефективно використовуючи одну реалізацію ActiveMethod. Це архітектурна модель, де модель створена в структурі Модель-Вид-Контролер (MVC), відповідає таблиці в база даних. Перевагою є те, що шаблони виконують операції база даних звичайний без кодування довгих запитів SQL. 

Шаблони дозволяють запитувати дані в таблицях і вставляти нові записи в таблиці. Процес синхронізації більше база даних спрощується робота на різних системах. Вам не потрібно писати запити SQL. Все, що вам потрібно зробити, це визначити таблиці база даних і зв’язки між ними, а Eloquent зробить решту роботи.

Підготовка Laravel

Щоб розпочати роботу над Eloquent, необхідно виконати такі дії:

1. Установіть Laravel з getcomposer.org, щоб зробити це, дотримуючись інструкцій тут
2. створення migration за допомогою консолі Artisan
3. Створення шаблонів eloquent
4. бігти я seed Дель база даних

Artisan Console це назва інтерфейсу Command Line включено до Laravel. Надає ряд корисних команд для використання під час розробки програми.

Щоб переглянути список усіх доступних команд Artisan, ви можете скористатися командою list:

php artisan list

Або просто php artisan, отримавши такий результат:

php artisan list
Laravel Framework 9.52.4

Usage:
  command [options] [arguments]

Options:
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Available commands:
  about                                Display basic information about your application
  clear-compiled                       Remove the compiled class file
  completion                           Dump the shell completion script
  db                                   Start a new database CLI session
  docs                                 Access the Laravel documentation
  down                                 Put the application into maintenance / demo mode
  env                                  Display the current framework environment
  help                                 Display help for a command
  inspire                              Display an inspiring quote
  list                                 List commands
  migrate                              Run the database migrations
  optimize                             Cache the framework bootstrap files
  serve                                Serve the application on the PHP development server
  test                                 Run the application tests
  tinker                               Interact with your application
  ui                                   Swap the front-end scaffolding for the application
  up                                   Bring the application out of maintenance mode
 auth
  auth:clear-resets                    Flush expired password reset tokens
 cache
  cache:clear                          Flush the application cache
  cache:forget                         Remove an item from the cache
  cache:table                          Create a migration for the cache database table
 config
  config:cache                         Create a cache file for faster configuration loading
  config:clear                         Remove the configuration cache file
 db
  db:monitor                           Monitor the number of connections on the specified database
  db:seed                              Seed the database with records
  db:show                              Display information about the given database
  db:table                             Display information about the given database table
  db:wipe                              Drop all tables, views, and types
 env
  env:decrypt                          Decrypt an environment file
  env:encrypt                          Encrypt an environment file
 event
  event:cache                          Discover and cache the application's events and listeners
  event:clear                          Clear all cached events and listeners
  event:generate                       Generate the missing events and listeners based on registration
  event:list                           List the application's events and listeners
 key
  key:generate                         Set the application key
 make
  make:cast                            Create a new custom Eloquent cast class
  make:channel                         Create a new channel class
  make:command                         Create a new Artisan command
  make:component                       Create a new view component class
  make:controller                      Create a new controller class
  make:event                           Create a new event class
  make:exception                       Create a new custom exception class
  make:factory                         Create a new model factory
  make:job                             Create a new job class
  make:listener                        Create a new event listener class
  make:mail                            Create a new email class
  make:middleware                      Create a new middleware class
  make:migration                       Create a new migration file
  make:model                           Create a new Eloquent model class
  make:notification                    Create a new notification class
  make:observer                        Create a new observer class
  make:policy                          Create a new policy class
  make:provider                        Create a new service provider class
  make:request                         Create a new form request class
  make:resource                        Create a new resource
  make:rule                            Create a new validation rule
  make:scope                           Create a new scope class
  make:seeder                          Create a new seeder class
  make:test                            Create a new test class
 migrate
  migrate:fresh                        Drop all tables and re-run all migrations
  migrate:install                      Create the migration repository
  migrate:refresh                      Reset and re-run all migrations
  migrate:reset                        Rollback all database migrations
  migrate:rollback                     Rollback the last database migration
  migrate:status                       Show the status of each migration
 model
  model:prune                          Prune models that are no longer needed
  model:show                           Show information about an Eloquent model
 notifications
  notifications:table                  Create a migration for the notifications table
 optimize
  optimize:clear                       Remove the cached bootstrap files
 package
  package:discover                     Rebuild the cached package manifest
 permission
  permission:cache-reset               Reset the permission cache
  permission:create-permission         Create a permission
  permission:create-permission-routes  Create a permission routes.
  permission:create-role               Create a role
  permission:setup-teams               Setup the teams feature by generating the associated migration.
  permission:show                      Show a table of roles and permissions per guard
 queue
  queue:batches-table                  Create a migration for the batches database table
  queue:clear                          Delete all of the jobs from the specified queue
  queue:failed                         List all of the failed queue jobs
  queue:failed-table                   Create a migration for the failed queue jobs database table
  queue:flush                          Flush all of the failed queue jobs
  queue:forget                         Delete a failed queue job
  queue:listen                         Listen to a given queue
  queue:monitor                        Monitor the size of the specified queues
  queue:prune-batches                  Prune stale entries from the batches database
  queue:prune-failed                   Prune stale entries from the failed jobs table
  queue:restart                        Restart queue worker daemons after their current job
  queue:retry                          Retry a failed queue job
  queue:retry-batch                    Retry the failed jobs for a batch
  queue:table                          Create a migration for the queue jobs database table
  queue:work                           Start processing jobs on the queue as a daemon
 route
  route:cache                          Create a route cache file for faster route registration
  route:clear                          Remove the route cache file
  route:list                           List all registered routes
 sail
  sail:add                             Add a service to an existing Sail installation
  sail:install                         Install Laravel Sail's default Docker Compose file
  sail:publish                         Publish the Laravel Sail Docker files
 sanctum
  sanctum:prune-expired                Prune tokens expired for more than specified number of hours.
 schedule
  schedule:clear-cache                 Delete the cached mutex files created by scheduler
  schedule:list                        List all scheduled tasks
  schedule:run                         Run the scheduled commands
  schedule:test                        Run a scheduled command
  schedule:work                        Start the schedule worker
 schema
  schema:dump                          Dump the given database schema
 session
  session:table                        Create a migration for the session database table
 storage
  storage:link                         Create the symbolic links configured for the application
 stub
  stub:publish                         Publish all stubs that are available for customization
 ui
  ui:auth                              Scaffold basic login and registration views and routes
  ui:controllers                       Scaffold the authentication controllers
 vendor
  vendor:publish                       Publish any publishable assets from vendor packages
 view
  view:cache                           Compile all of the application's Blade templates
  view:clear                           Clear all compiled view files

Усі команди супроводжуються коротким описом аргументів і опцій. Це показано на екрані «довідки». Щоб переглянути екран довідки, просто поставте перед назвою команди «help», як показано:

php artisan help migrate
Description:
  Run the database migrations

Usage:
  migrate [options]

Options:
      --database[=DATABASE]        The database connection to use
      --force                      Force the operation to run when in production
      --path[=PATH]                The path(s) to the migrations files to be executed (multiple values allowed)
      --realpath                   Indicate any provided migration file paths are pre-resolved absolute paths
      --schema-path[=SCHEMA-PATH]  The path to a schema dump file
      --pretend                    Dump the SQL queries that would be run
      --seed                       Indicates if the seed task should be re-run
      --seeder[=SEEDER]            The class name of the root seeder
      --step                       Force the migrations to be run so they can be rolled back individually
      --isolated[=ISOLATED]        Do not run the command if another instance of the command is already running [default: false]
  -h, --help                       Display help for the given command. When no command is given display help for the list command
  -q, --quiet                      Do not output any message
  -V, --version                    Display this application version
      --ansi|--no-ansi             Force (or disable --no-ansi) ANSI output
  -n, --no-interaction             Do not ask any interactive question
      --env[=ENV]                  The environment the command should run under
  -v|vv|vvv, --verbose             Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Migration

Міграція – це процес управління база даних написання замість цього PHP SQL. Надає спосіб додати контроль версій до база даних. 

Щоб створити міграцію, просто виконайте таку команду:

php artisan make:migration create_student_records

Це створює файл міграції. У текстовому редакторі відкрийте щойно створений файл у папці database\migrations:

<?php
use IlluminateSupportFacadesSchema;
use IlluminateDatabaseSchemaBlueprint;
use IlluminateDatabaseMigrationsMigration;

class CreateStudentRecordsTable extends Migration
{
    /**
    * Run the migrations.
    *
    * @return void
    */
    public function up()
    {
        Schema::create('student__records', function (Blueprint $table) {
            $table->increments('id');
            $table->timestamps();
        });
    }

    /**
    * Reverse the migrations.
    *
    * @return void
    */
    public function down()
    {
        Schema::dropIfExists('student__records');
    }
}

Код є класом з такою ж назвою 'create student records', і має два методи: up e down. Метод up слід внести зміни до база даних; тому кожного разу, коли ви переносите свій база даних, будь-який код у методі буде виконано up. З іншого боку, метод down має повернути ці зміни до база даних; тому кожного разу, коли ви запускаєте rollback з migration, метод down має скасувати те, що зробив метод up. Всередині методу up є конструктор схем, який використовується для створення та керування таблицями. Що станеться, якщо ви скасуєте деякі міграції? Все, що вам потрібно зробити, це виконати таку команду:

php artisan migrate:rollback

І він збере останнє migration яка була реалізована. Крім того, ви можете повністю відновити база даних працює:

php artisan migrate:reset

Це скасує всі ваші міграції.

Визначення моделей Eloquent

Після міграції в база даних, наступним процесом є seeding. Eloquent вступає в дію з моменту seeding вставляє записи в наш база даних. Тому вам потрібно буде створити шаблони перед заповненням база даних. Кожна таблиця з база даних має відповідну модель, яка використовується для взаємодії з цією таблицею. Шаблони дозволяють запитувати дані у ваших таблицях, а також вставляти нові записи в таблицю. Найпростіший спосіб створити екземпляр моделі — це використати таку команду:

php artisan make:model Student

Приклад шаблону наведено нижче Student, який можна використовувати для отримання та зберігання інформації з таблиці база даних нашого студента:

<?php
namespace App;
use IlluminateDatabaseEloquentModel;

class Student extends Model
{
    //
}

Коли ви створюєте модель і в той же час хочете створити міграцію база даних, ви можете скористатися опцією –migration o -m:

php artisan make:model Student --migration

php artisan make:model Student -m

Fillable e Guarded

In Laravel, бути $fillable що $guarded вони використовуються для керування масовим призначенням атрибутів у ваших моделях. Давайте розберемо відмінності:

$fillable:

• Він діє як «білий список» атрибутів, які можна призначати масово.
• Ви явно вказуєте, які атрибути дозволені для масового призначення.
• Лише атрибути, перелічені в $fillable, можна встановити за допомогою fill() із масивом значень.

приклад:

class User extends Eloquent {
    protected $fillable = ['name', 'email'];
}

У цьому прикладі можна масово призначити лише стовпці імені та електронної пошти.

$охороняється:

• Він діє як «чорний список» атрибутів, які не слід призначати масово.
• Ви явно вказуєте, які атрибути мають бути захищені від масового призначення.
• Атрибути, перелічені в $guarded вони не будуть встановлені за допомогою fill().

приклад:

class User extends Eloquent {
    protected $guarded = ['name', 'email'];
}

У цьому випадку стовпці імені та електронної пошти не можна буде масово призначити.

Поєднання обох:

Ви можете використовувати обидва $fillable що $guarded разом.

Якщо ви хочете, щоб усі поля, крім кількох, могли призначатися масово, використовуйте масив $guarded порожній:

protected $guarded = [];

Якщо ви хочете запобігти груповому призначенню всіх полів, використовуйте:

protected $guarded = ['*'];

Якщо ви хочете захистити певні поля, використовуйте $fillable для групових полів e $guarded для решти.

Сівалки

I seeder загалом це спеціальний набір класів, які дозволяють нам заповнювати наші база даних знову і знову з однаковими точними даними. Реалізуємо таку команду:

php artisan make:seeder StudentsRecordSeeder

У текстовому редакторі під папкою seeds, відкрийте щойно створений файл із назвою: StudentsRecordSeeder.php. Як бачите, це просто дуже простий клас з єдиним методом run().

<?php
use IlluminateDatabaseSeeder;

class StudentsRecordSeeder extends Seeder
{
    /**
    * Run the database seeds
    * @return void
    */

    public function run()
    {
        //
    }
}

Код — це лише обгортка навколо класу команд консолі, спеціально створена, щоб допомогти у виконанні завдання seeding. Відредагуйте код, а потім збережіть його.

public function run()
{
    echo 'Seeding!';
}

І перейдіть до терміналу, запустіть команду artisan для виконання методу run новоствореного класу:

php artisan db:seed --class=StudentsRecordSeeder

Якщо ви хочете спробувати реалізувати приклад класу Seeder, ви можете продовжити читаючи наш пост.

Тепер ми можемо продовжувати реалізацію всіх операцій з БД за допомогою Eloquent.

CRUD з Laravel Eloquent

Операції Сирий з Laravel Eloquent object-relational mapper (ORM) вони полегшують розробникам Laravel роботу з більшою кількістю база даних. Esegue operazioni di creazione, lettura, aggiornamento ed eliminazione (Сирий), nonché mappa i modelli di oggetti alle tabelle del база даних. Керує всіма взаємодіями база даних richieste per le operazioni Сирий.

Створення записів

Ви можете використовувати метод ::create, щоб вставити новий запис у база даних.

student_record::create(array(
    'first_name' => 'John',
    'last_name'  => 'Doe',
    'student_rank' => 1
));

На додаток до простого методу створення, показаного вище, ви також можете створити новий об’єкт і надати йому інші атрибути. Потім ви можете викликати функцію save() і запустити код. Методи, як firstOrCreate() o firstOrNew() є інші варіанти створення записів. Це дозволить вам знайти студента з певними атрибутами; якщо цього студента не знайдено, ви створите його в база даних або ви створите новий екземпляр.

firstOrCreate()

Шукає запис за допомогою вказаних пар ключ-значення. Якщо модель не знайдено в база даних, створює новий запис із зазначеними атрибутами. Пара ключ-значення має бути надана як асоціативний ключ.

Приклад: припустимо, що ми маємо a model User і хочете знайти або створити користувача на основі його електронної адреси:

$user = User::firstOrCreate(['email' => 'user@example.com']);

Якщо є користувач із електронною адресою «user@example.com», firstOrCreate поверне цього користувача. Якщо збігів не знайдено, буде створено нового користувача з указаною електронною адресою.

Приклад із певними атрибутами: якщо ви хочете перевірити існування лише одного конкретного поля (наприклад, електронної пошти), але також написати інші, тоді ви можете надати одноелементний масив із потрібним полем.

$user = User::firstOrCreate(['email' => 'user@example.com'], ['name' => 'John Doe']);

Якщо є користувач із електронною адресою «user@example.com», firstOrCreate повертає цього користувача. В іншому випадку буде створено нового користувача з електронною адресою та іменем «Джон Доу».

firstOrNew()

Метод firstOrNew використовується для пошуку першої моделі, яка задовольняє певні умови. Якщо відповідного шаблону не знайдено, створюється новий екземпляр шаблону, але не зберігається в база даних.

$user = User::firstOrNew(['email' => 'user@example.com']);

Якщо є користувач із електронною адресою «user@example.com», він поверне цього користувача. В іншому випадку буде створено новий екземпляр користувача з указаною електронною адресою. Ви також можете передати додаткові атрибути для встановлення під час створення нового екземпляра:

$user = User::firstOrNew(['email' => 'user@example.com'], ['name' => 'John Doe']);

Якщо існуючого користувача не знайдено, буде створено нового користувача з електронною адресою та ім’ям «Джон Доу».

Два методи firstOrCreate e firstOrNew вони схожі. Метод firstOrCreate намагається знайти шаблон, який відповідає вказаним атрибутам. Якщо не знайдено, автоматично створює та зберігає новий шаблон firstOrNew якщо він не знаходить його, він створює екземпляр, але не зберігає його. Якщо ви не збережете, згодом вам доведеться записати будь-які атрибути, а потім зберегти.

Читання записів

Використовуючи Eloquent ORM, ви можете знайти записи в база даних. Запити створені просто та пропонують плавний потік. Щоб створити заяви:where, ви будете використовувати методи get() І first† 

Метод first() поверне лише один запис, а метод get() поверне масив записів, які можна прокрутити, щоб прочитати всі результати. Крім того, метод find() можна використовувати з масивом первинних ключів, який повертатиме колекцію відповідних записів. 

Ось кілька прикладів:

$student = Students::all();

Цей код отримують усі учні. Хоча наступний код знаходить конкретного студента за ідентифікатором:

$student = Students::find(1);

Також, як показано нижче, код описує пошук студента за певним атрибутом.

$JohnDoe = Students::where('name', '=', 'John Doe')->first();

Для методу get() цей код показує, як знайти студента з рівнем вище 5.

$rankStudents = Student::where('student_rank', '>', 5)->get();

Оновлення запису

Оновлювати записи за допомогою Eloquent так само просто. Щоб оновити запис, просто знайдіть запис, який потрібно оновити, відредагуйте атрибути та збережіть. Наприклад, щоб змінити рівень оцінки учня Джона Доу на 5, спочатку знайдіть учня, а потім виконайте метод збереження.

$JohnDoe = Bear::where('name', '=', 'John Doe')->first();
$JohnDoe->danger_level = 5;
$JohnDoe->save();

Метод збереження також можна використовувати для оновлення моделей, які вже існують у база даних.

Видалити записи

Eloquent може похвалитися своїм легким процесом оновлення записів, але така ж історія з видаленням. Є два варіанти: витягнути записи та виконати метод видалення або просто використати метод знищення. Щоб знайти та видалити запис, просто виконайте такі команди:

$student = Students::find(1);
$student->delete();

Щоб видалити запис і кілька записів, виконуються команди:

Students::destroy(1);
Students::destroy(1, 2, 3);

Зверніть увагу, що параметри delete є лише первинними ключами, на відміну від методу delete, який може приймати будь-який стовпець del база даних.

Щоб знайти та видалити всіх учнів вище 10 рівня.

Students::where('student_rank', '>', 10)->delete();

Пов'язані читання

• WooCommerce: як керувати каталогом продуктів
• Як налаштувати Laravel для використання кількох баз даних у вашому проекті
• Стійкі організації роблять психологічну безпеку стратегічним пріоритетом
• Як створити звіт про проект за допомогою Microsoft Project
• Інновації в енергетичному секторі: дослідження термоядерного синтезу, новий рекорд для європейського токамака JET

Ercole Palmeri