Laravel Eloquent Tutorial - Get only the fields (aka columns) we need from relation.

codewitholgun — Sun, 20 Feb 2022 01:10:16 +0000

Laravel is a great framework to work with, and I use it every day for my 9-5 job. One of the greatest power of Laravel is, it has an ORM (Object Relational Mapping) as default called Eloquent.

I am not going to talk about what is Eloquent ORM, but I would like to just indicate that, it makes your life easier to deal with databases.

Below you can find some simple usages of eloquent;

$post = Post::find(1)
// That will run the following query in the database
// select * from posts where id = 1
// You see, it's so easy to use and powerful because we don't need to write a query anymore

If you are using relational databases such as MySQL, MariaDB, PostgreSQL and etc, it becomes more powerful because you don't need to write complex join queries anymore.

For example, we want to get a specific post from the posts table but also we want to GET the author of the post as well. The following example, clearly explains that.

class Post extends Model {
 ....
 // that will assume that we have author_id column in the posts table
 public function author(): BelongsTo
{ 
   return $this->belongsTo(related: Author::class)
 }
}

 // Since the author relation is defined in Post model, we can load it using following code
$post = Post::with('author')->find(1);
// Now, the post data will have the author data from database
// This is called Eager loading and it is very important learn about it.
// Link: https://laravel.com/docs/9.x/eloquent-relationships#eager-loading

Since we used eager loading to get author data with the post, all columns in the author data is loaded. This is not a problem with a small amount of data, but if we get millions of posts, each post will have an author and probably that will run a little bit slower. So, instead of getting all columns in author data, let's get some specific columns.

$post = Post::with('author:id, name')->find(1);
// Now, the post data will have the author data from database but only specific columns id and name
// This will make your it more faster to load data

In the example above, we have used :id, name, so, only those columns are going to be loaded from the database.

That's all for this tutorial :)

If you like to get more content similar to that, please follow me on Twitter and on my youtube channel.

Twitter: twitter.com/olgunsoftware

Youtube: youtube.com/channel/UCH-xplaz-cmloIUkYspcEhQ

How to create custom helpers in Laravel?

codewitholgun — Thu, 10 Feb 2022 08:12:52 +0000

Laravel is one of the best frameworks out there FOR ME. I use it every day for my 9-5 job and I really love it.

Whenever I start a new project either for my job or for my side projects, the first thing that I do is to create a new file called helpers.php. I use that file to create the custom helper functions that I will be used for along the project.

For example; I really don't like to find the name of the current route in blade files following a hard way like as below;

{{ Illuminate\Support\Facades\Route::currentRouteName() }}

Instead, I prefer to create a simple function that I can use anywhere in the project to get the current route name in a shorter syntax like as below;

{{ getCurrentRouteName() }} // In the blade files,also can be used in .php files as well.

How to make sure that this simple function can work anywhere?

Since Laravel as a default uses composer to manage the dependencies, we have a powerful tool under our hands and we can tell the composer to autoload any file we want and it allows us to use it in the entire project.

To do so; first of all, we have to create the file anywhere we want, as a default, I always put it under the app folder.

app/helpers.php

After I am sure that, the file exists, I create my own custom helper functions as shown below;

// function_exists method is initiated to check;
// If there is any function existed with the name of getCurrentRouteName,
// If not, this function will be added otherwise existed one will be used.
// The aim is to protect existing functions to be overwritten
if (!function_exists('getCurrentRouteName')) {
    function getCurrentRouteName()
    {
        return Illuminate\Support\Facades\Route::currentRouteName();
    }
}

At this point, I have to tell the composer to discover and autoload this file by adding it to the composer.json file as shown below.

If you don't know, composer.json is a file in that you can define the project dependencies and install them using a simple command composer install or update them with composer update.

{
    "require": { ... },
    "require-dev": { ... },
    "autoload": {
        "psr-4": { ... },
        "files": [
            "app/helpers.php" //this is the place I tell composer to autoload file
        ]
    },
    ...
}

I created a file, add it to the composer.json file, so is it going to work? Unfortunately No 😥

Because we have to run a simple composer command to load all files again in the entire project just for one time.

composer dump-autoload

I am afraid to ask, but is it going to work? Yes! Congratulations, you've made it 😇

So, now I can use getCurrentRouteName anywhere I want as I showed in the example above.

{{ getCurrentRouteName() }} // In the blade files,also can be used in .php files as well.

This is how I create custom helpers in my Laravel projects.

DEV Community: codewitholgun

Laravel Eloquent Tutorial - Get only the fields (aka columns) we need from relation.

How to create custom helpers in Laravel?

How to make sure that this simple function can work anywhere?