DEV Community: Reza Amini

Manage your Laravel migrations with 1 click!

Reza Amini — Tue, 14 Sep 2021 17:02:48 +0000

Have you ever want to migrate a single migration in Laravel?
You need to write a huge line of words in your command line to just migrate a migration.

Or have you ever tried to refresh or reset a migration?
In some cases the migration commands literally aren't understandable and you may wonder what is the fresh or refresh and should I use refresh or reset or other commands and what is the difference between them?

Imagine that you have over 10 migrations and you just want to refresh just one of them, to do this you need to execute this command:

php artisan migrate:refresh --path=database/migrations/2021_09_14_153949_create_products_table.php

Hmmm, to me and lots of you it's not enjoyable and also it does take time to write in command line and if we type the wrong name we may lose our data in database.

So what should we do?

Here Migrator comes!

Migrator is a GUI migration manager for Laravel.

With Migrator you can manage your migration as easy as possible in a beautiful user interface.

Migrator features:

Create new migration
Migrate all migrations
Fresh migrations
Drop a single migration
Migrate a single migration
Delete and drop a migration
See the status of migrations
Refresh a migration (Drop then up)
Show the migration data in a better way!

So we have talked about the features, let's install Migrator in a minute.

Installing Migrator is super duper easy, you just need to run a single composer command:

composer require rezaamini-ir/migrator

Congrats! Migrator was installed successfully, now you will be to access the /migrator path in your project and if you want to change the authentication method or Migrator route you can publish config file with this command:

php artisan vendor:publish --tag=migrator-config

Then a new file will be created in your config directory called: migrator.php and you can change the middleware which authenticates the user and also the route of the package is editable.

To read more about the Migrator package you can check out the documentation:
https://github.com/rezaamini-ir/migrator

Don't forget to contribute to the project and Star it ⭐️ :)).

Boost your queries in Laravel

Reza Amini — Fri, 16 Jul 2021 17:01:45 +0000

There are lots situations which you may think that your query is super duper optimize and your project works like a Rocket!
But when we monitor your queries which has been executed, you may be shocked and say : "Oh man, what's going on ? 31 query for just getting a bunch of articles ???? 🤐"

+"It's not possible"
-It is possible :))

N + 1 Problem

First of all let me tell you about N + 1 problem, a big problem which you may not be noticed about.
What is N + 1 Problem?

Imagine you have about 30 articles and each article has a author and you want to show these articles with their author in a table.

$articles = Article::all();

return view('articles', compact('articles'));

And in your Blade :

@foreach($articles as $article)
    <li>{{ $article->title }}</li>
    <li>{{ $article->author->name }}</li>
@endforeach

But if we check the queries which has been executed, we will see that over 31 queries have been executed !

+Damn, whyyyyyyy?
-Let me tell you why.

When you are getting articles just one query will be executed but where are these other 30 queries ?

If you remove the <li>{{ $article->author->name }}</li> you will back to the safe zone with just 1 executed query.

This one line per each article's author run a query to get the data of author... (Oh mannnn, I got it.)

Let's check the queries :
The first query is this:

SELECT * FROM `articles`

And the other 30 queries are like this:

SELECT * FROM `authors` WHERE `id` = 1 LIMIT 1
SELECT * FROM `authors` WHERE `id` = 2 LIMIT 1
SELECT * FROM `authors` WHERE `id` = 3 LIMIT 1
--.....
SELECT * FROM `authors` WHERE `id` = 30 LIMIT 1

Per each article's author one query will be executed.

With() is your saver

Now with method will be appears and save your project's life.

To solve the problem you can use the with method in your controller and write this code:

$articles = Article::with('user')->get();

return view('articles', compact('articles'));

That's it, nothing else needs to do :)

With is solution of the N + 1 problem and it solves that with eager loading.

So what is eager loading and how does it work?

First lets check the queries, we had 31 queries on top and now if we check the queries we can see that just 2 queries has been executed!

How just 2 queries?

When we are using eager loading instead of lazy load of Laravel to get authors data just one query will be executed.

SELECT * FROM `authors` WHERE `id` in (1, 2, 3, ..., 30)

And literally one query is super faster than 30 query :))

Also you can get a bunch of relationship with with():

$articles = Article::with(['author', 'publisher'])->get();

And you can get a nested relation:
$articles = Article::with('author.profile')->get();

Wait, it isn't done, you can also filter the data which you want to return with QueryBuilder

$articles = Article::with(['author.addresses' => function($query){
    $query->where('active', true)->latest();
}]);

Neat Routes in Laravel!

Reza Amini — Tue, 23 Feb 2021 09:07:37 +0000

What is the Problem?

One of the programmer's concerns is refactoring.
Refactoring allows us to improve our code knowledge and code quality.

If have been familiar with the Laravel Routing system you know there are some files in routes/ directory which contain some routes for our project,api.php and web.php are more useful than other files.

When your project will grow up manage and edit these files are very harmful :(.

Imagine we have a blog project which has a dashboard and admin panel and a home page for everybody.

If we want to make these routes in web.php file after a while we will have an unreadable file and we didn't pay attention to the first principle of SOLID which tells us to "A class should have only one reason to change".

So what should We do?

How routes will be registerd?

If you check out the app/Providers/ directory you will see a file called RouteServiceProvider.php which contains our routes and it will register our route files.

In the boot method we have something like that:


$this->routes(function () {
    // It will register web.php route with 'web' middleware
    Route::middleware('web')
        ->group(base_path('routes/web.php'));


    // It will register api.php route with 'api' middleware and 'api' prefix
    Route::prefix('api')
        ->middleware('api')
        ->group(base_path('routes/api.php'));
});

With the Route facade, we will be able to register our routes in different files.

So let's do that, let's register our routes.

1- Register Home Route:
We don't need to use middleware or a special prefix for this route, so register this in web.php:

Route::get('/', [HomeController::class, 'index']);

2- Register dashboard Routes:
First, we have to create a new file in the routes directory called dashboard.php which contains our dashboard routes:

Route::get('/', [DashboardController::class, 'index']);

Route::get('/edit', [DashboardController::class, 'showEdit']);
Route::post('/edit', [DashboardController::class, 'storeData']);

Then we must register this file in our service provider with a /dashboard prefix and auth middleware.
Open the RouteServiceProvider.php and boot method, write some codes like this below:


$this->routes(function () {
    Route::middleware('web')
        ->group(base_path('routes/web.php'));

   // It will register dasboard.php route with 'api' and 'auth' middleware and 'dashboard' prefix
    Route::middleware(['web', 'auth'])
        ->prefix('dashboard')
        ->group(base_path('routes/dasboard.php'));

    Route::prefix('api')
        ->middleware('api')
        ->group(base_path('routes/api.php'));
});

Congrats! we registered our first route file :)

You can make more changes based on your project.

Point: This syntax belongs to Laravel 8 and in the previous versions we had some differences, but the scenario has not changed.

Model data tracker in Laravel

Reza Amini — Thu, 14 Jan 2021 13:29:07 +0000

Have you ever tried to track your model data and see the complete data of every visit by clients?

Have you ever wanted to know who sees your post and where they live?

With this package, you will be able to track model data and see how many views your posts and data have.

For example, you have a blog and you want to see who has seen your posts.

You just need to use Trackable trait in your model and say $post->track();

Now you are able to track your post and see who saw it with complete information like County, IP, Reefer page, and...

You can see the package which is called laravel-tracker in Github.

Repo : https://github.com/rezaamini-ir/laravel-tracker

Make a flexible Laravel admin panel in 2 minutes!

Reza Amini — Sun, 15 Nov 2020 18:38:27 +0000

Have you ever tried to build a complete admin panel in Laravel from zero?

It takes lots of energy and time and, you may not like what you have built.

I had the same problem as you, When I was trying to make an admin panel and I think to myself and I said: Reza there are lots of people who want to build a beautiful admin panel like you, make your module more flexible and share It in Github.

Wow, It's very good I should do it for the open-source community.

So I decided to build an admin panel module and because I love Livewire I decided to do that with Livewire.

If You don't know what is Livewire I should tell You It is a Fullstack framework and makes You needless from Javascript frameworks.

Come on dude, don't say too much show us your package...

Ok, let me tell you about EasyPanel.
EasyPanel is an admin panel package for Laravel and You can build your admin panel in 2 minutes (maybe less than 2 minutes).

There are some features of EasyPanel :

Create CRUD in the config file.
Manage route prefix and addresses
Beautiful UI/UX with AdminMart template
Add/remove Admins with command line
Every UserProviders and Authentication classes are customizable and you can change them
You can create your own routes and customize our views and components
Manage pagination count
Multi lang
Real-time validation with Livewire
Customize every action in your project
A small and beautiful TODO (You can disable it in your config)
Create a nice and responsive view based on your data in the config file for every CRUDs
Custom validation based on the config file
Ajax search with Livewire in every column you want

So We saw the features, But let's build an admin with articles section (Create, Read, Update, Delete)

first of all, We must install the package (how 🤔)
Don't be afraid It's very easy as the package name.

Install the package with Composer.

composer require rezaamini-ir/laravel-easypanel

next, We should publish configurations and styles (Just with one command) :

php artisan panel:install

Congratulations 👏! You have installed the package.

Now We have access to the config file in config directory and we can pass our cruds to actions key in the easy_panel.php file.

To create a CRUD we must pass 3 steps:

1- Create a CRUD config file.

To create a CRUD config we must run this command out:

php artisan panel:config Article

which Article is our model name.
the file will be created in resources/cruds/article.php

2- Config our CRUD file and pass the data that we want.

let's write our array in the CRUD file :

return [
    'model' => \App\Models\Article::class,

    // searchable field, if you dont want search feature, remove it
    'search' => ['title', ['user' => 'name']],

    // Manage actions in crud
    'create' => true,
    'update' => true,
    'delete' => true,

    // Validation in update and create actions
    'validation' => [
        'title' => 'required',
        'content' => 'required|min:30',
    ],

    // Write every fields in your db which you want to show
    'fields' => [
        'title' => 'text',
        'content' => 'textarea',
        'image' => 'file'
    ],

    'store' => [
        'image' => 'image/articles'
    ],

    //Default that data you want to pass in create and update actions, Do not you want? Delete this key.
    'extra_values' => [
        'user_id' => 'auth()->user()->id'
    ],

    // which kind of data should be showed in list page
    'show' => ['title', 'image',  ['user' => 'name']],
];

Now we must pass 'article' value in our config file in config/easy_panel.php in actions key like:

'actions' => ['article', 'user']

3- Run CRUD creator command:
with one command We can create our CRUD action with routes and everything which a panel needs...
php artisan panel:crud article

Now we have an admin panel with an Article section and a default TODO list.
So easy 😁.

Let's see what we build :

This is a simple example of this package and you can customize every file in your project.

Repository address :
https://github.com/rezaamini-ir/laravel-easypanel

Don't forget to star to the package ⭐.

You are free to submit a pull request :)