DEV Community: Federica Ferletti

Relationship One To One in Laravel

Federica Ferletti — Wed, 18 Jan 2023 15:11:16 +0000

this tutorial was made with laravel 9

There are 3 types of relationships:

One to One
One to Many
Many to Many

In this tutorial I will try to explain the One relation as best as possible
To One since during its realization I encountered different techniques (not always correct).

So we will create the migration, the model, the controller, seeder & factory and finally the test!

Let's begin

One To One

Create a migration:

php artisan make:migration create_users_table

Schema::create('users', function (Blueprint $table) {
            $table->uuid("id")->primary();
            $table->string("name", 128);
            $table->string("surname", 128);
            $table->string("email")->unique();
            $table->string("photo")->nullable();
            $table->integer("level")->nullable();
            $table->string("password");
            $table->timestamps();
});

Schema::create('roles', function (Blueprint $table) {
            $table->uuid("id")->primary();
            $table->string("role")->unique();
            $table->uuid('user_id')->unsigned();
            $table->foreign('user_id')->references('id')->on('users')->onDelete('cascade');
            $table->timestamps();
});

//DOWN METHOD
public function down() n{
        Schema::drop('roles');
        Schema::drop('users');
}

⚠️ It is important to put the deletion of the tables in the correct order, if in this example I had deleted the users table first I would have created an error as the roles table has the foreign key linked to the user.

Create Model:

php artisan make:model UserModel

Models/User.php

// =====================================
// RELATIONSHIP
// =====================================

public function role()
{
    return $this->hasOne(Role::class);
}

and now Model/Role.php

// =====================================
// RELATIONSHIP
// =====================================

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

And now we can create the updateRole method since it's the only one that cares about the relationship.
Methods like create, show, update and delete can normally be created outside the relationship.

Controller/UserController.php
php artisan make:controller UserController

use App\Models\User;
use App\Models\Role;

public function updateRole(Request $request, $uuid) {
        $user = User::find($uuid);
        $role = Role::where('user_id', $uuid)->firstOrFail();

        $validatedRoleUpdate = $request->validate([
            'role' => 'in:admin,user,student,educator',
        ]);

        $role->role = $validatedRoleUpdate['role'];
        $user->role()->save($role);

        return response()->json([
            'status' => true,
            'message' => 'User Role Update Successfully',
        ], 200);

}

Well, now we do Seeder and Factory:
php artisan make:factory UserFactory
factories/UserFactory.php

public function definition(){
        return [ 
            'name' => fake()->name(),
            'surname' => fake()->name(),
            'email' => fake()->unique()->safeEmail(),
            'password' => '$2y$10$92IXUNpkjO0rOQ5byMi.Ye4oKoEa3Ro9llC/.og/at2.uheWG/igi', // password
        ];
}

factories/RoleFactory.php

public function definition() {
        return [ 
            'role' => 'user',
        ];
}

seeders/UserSeeder.php
php artisan make:seeder UserSeeder

$user = User::factory()
            ->has(Role::factory())
            ->create();

Last step let's test the updateRole method
php artisan make:test UserTest --unit

/*
Command for run a specific test
./vendor/bin/phpunit --filter testUpdateRole tests/Unit/UserControllerTest.php
*/
public function testUpdateRole() {
        $id = User::all()->first()['id'];

        $response = $this->put("/api/users/{$id}/role", ['role' => 'student']);
        $response->assertStatus(200)->assertJson([
            'message' => 'User Role Update Successfully',
        ]);
}

Well in our database we will now have a connected role created for each user and vice versa, each role has its own connected user.

For this personal project it had to be done this way, but it could just as well have added the 'role_id' field in the user table.

In the next articles I will explain how relationships between tables can get complicated!

TDD CRUD API

Federica Ferletti — Wed, 11 Jan 2023 15:46:14 +0000

CRUD refers to four basic functions: Create, Read, Update, Delete. It is the operations performed in the database.

Test Driven Development (TDD) is a software development approach where test cases are developed to specify and validate what the code will do. In simple terms, test cases for each feature are built and tested first and if the test fails, new code is written to pass the test and make the code simple and bug-free.

this tutorial was made with laravel 9

Now let's program

First test - Create User
api.php

Route::post('/users/create', [UserController::class, 'create']);

⚠️ IMPORTANT: insert in the controller method a return response like this:

return response()->json([
      'status' => true,
      'message' => 'User Created Successfully',

], 200);

and now test!

public function testCreateUser(){
      $response = $this->postJson('/api/users/create', ['name' => 'Sally', 'surname' => 'Willi', 'email' => 's@gmail.com', 'password' => '12345678']);
      $response->assertStatus(200)->assertJson([
            'message' => 'User Created Successfully',
      ]);
}

if I want to run only this test just run this command:

./vendor/bin/phpunit --filter testCreateUser tests/Unit/UserControllerTest.php

Second test - Show User

public function testShowUser(){
      $id = User::all()->first()['id'];
      $response = $this->get("/api/users/retrieve/{$id}");        
      $response->assertStatus(200)->assertJson([
            'role' => 'user',
      ]);
}

if I want to run only this test just run this command:

./vendor/bin/phpunit --filter testShowUser tests/Unit/UserControllerTest.php

Third test - Update User

public function testUpdateUser(){
      $id = User::all()->first()['id'];

      $response = $this->put("/api/users/{$id}", ['name' => 'Homer', 'surname' => 'Simpson', 'email' => 'homerS11@gmail.com', 'password' => '12345678']);
      $response->assertStatus(200)->assertJson([
            'message' => 'User Update Successfully',
      ]);
}

if I want to run only this test just run this command:

./vendor/bin/phpunit --filter testUpdateUser tests/Unit/UserControllerTest.php

Last test - Delete User

public function testUserDelete(){
      $id = User::all()->first()['id'];
      $response = $this->delete("/api/users/{$id}");
      $response->assertStatus(200)->assertJson([
            'message' => 'User Deleting Successfully',
      ]);
}

if I want to run only this test just run this command:

./vendor/bin/phpunit --filter testUserDelete tests/Unit/UserControllerTest.php

That's it

I hope this tutorial helps you in your Laravel experience.