Laravel Package generation tutorial.

Welcome, aspiring Laravel developers! Today, we'll dive into the exciting world of Laravel package development. Packages are like Lego bricks that extend the functionality of your Laravel applications in a modular and reusable way. They allow you to encapsulate features, making your code more maintainable, shareable, and efficient.

Why Create Laravel Packages?

Modularity: Break your application into smaller, manageable pieces.            
Reusability: Easily reuse your code across multiple projects.            
Collaboration: Share your packages with the Laravel community.            
Clean Code: Promote clean and organized code structure.

Our Project: Creating a CRUD Package

For our hands-on lesson, we'll focus on creating a simple Laravel CRUD (Create, Read, Update, Delete) package named CRUD-GENERATOR. This package will help us perform common CRUD operations effortlessly.

Create a Laravel Project: 

Open your terminal and run the following command to create a new Laravel project.

composer create-project --prefer-dist laravel/laravel your-project-name

Navigate to Your Project:

Change into the newly created project directory.

cd your-project-name

Create a Package Folder:

Inside your Laravel project, create a folder to house your custom package. Conventionally, these could be named packages.

mkdir Crud-Generator

Create Your Package:

Inside the packages folder, create a subfolder for your custom package. For example, if your package is named MyPackage, your structure might look like this:

Source Code:

Place all these package's source code, classes, and other files inside the Crud-Geneator folder. Organize it according to Laravel conventions, such as having a src folder for source files.

Database:

This is a PHP script written in the Laravel framework for defining a database migration. Laravel provides a migration system to version control your database schema and easily share it with others.

<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
    /**
     * Run the migrations.
     */
    public function up(): void
    {
        Schema::create('crud_generators', function (Blueprint $table) {
            $table->increments('id');
            $table->string('name',255);
            $table->string('email',100);
            $table->string('phone',20);
            $table->text('address');
            $table->timestamps();
        });
    }
    /**
     * Reverse the migrations.
     */
    public function down(): void
    {
        Schema::dropIfExists('crud_generators');
    }
};

Models:

The class, named CrudGenerator, extends the Eloquent Model class in Laravel, indicating its role in database interaction through the Eloquent ORM. The use HasFactory statement incorporates the HasFactory trait, facilitating the creation of model factories for test data. The $guarded property, set to an empty array, signifies that all attributes of the model are mass assignable, allowing for simplified CRUD (Create, Read, Update, Delete) operations without explicitly listing each attribute. This follows a common Laravel practice for convenient data manipulation while maintaining security by guarding against mass assignment vulnerabilities.

<?php
namespace Mustafiz\CrudGenerator\Models;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
class CrudGenerator extends Model
{
    use HasFactory;
    protected $guarded = [];
}

routes:

This PHP script defines Laravel routes in a group, specifying a namespace for controllers and applying the 'web' middleware. The routes map to CRUD operations in a hypothetical Mustafiz\CrudGenerator package. The paths include 'crud/index' for listing, 'crud/create' for creating, 'crud/store' for storing data, 'crud/edit/{id}' for editing, 'crud/update/{id}' for updating, and 'crud/delete/{id}' for deletion. These routes are associated with methods in the CrudController within the specified namespace.

<?php
use Illuminate\Http\Request;
Route::group(['namespace'=>'Mustafiz\CrudGenerator\Http\Controllers','middleware' => ['web']],function (){
    Route::get('/crud/index','CrudController@index')->name('crud.index');
    Route::get('/crud/create','CrudController@create')->name('crud.create');
    Route::post('/crud/store','CrudController@store')->name('crud.store');
    Route::get('/crud/edit/{id}','CrudController@edit')->name('crud.edit');
    Route::post('/crud/update/{id}','CrudController@update')->name('crud.update');
    Route::get('/crud/delete/{id}','CrudController@delete')->name('crud.delete');
});

Views:

Laravel uses the Blade templating engine for its views. Blade provides a clean and concise syntax for writing templates, making it easy to work with PHP code within your views. Blade templates have the file extension .blade.php.

Views:

Laravel uses the Blade templating engine for its views. Blade provides a clean and concise syntax for writing templates, making it easy to work with PHP code within your views. Blade templates have the file extension .blade.php.

<!doctype html>
    <html lang="en">
    <head>
        <meta charset="UTF-8">
        <meta name="viewport"
              content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
        <meta http-equiv="X-UA-Compatible" content="ie=edge">
        <title>CRUD GENERATOR</title>
        <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@4.4.1/dist/css/bootstrap.min.css" integrity="sha384-Vkoo8x4CGsO3+Hhxv8T/Q5PaXtkKtu6ug5TOeNV6gBiFeWPGFN9MuhOf23Q9Ifjh" crossorigin="anonymous">
    
    </head>
    <body class="bg-light">
    <div class="container bg-white pb-3">
        <div class="d-flex justify-content-between pt-4 mb-3">
            <h3>CREATE NEW ENTRY</h3>
            <div>
                <a href="{!!route('crud.index')!!}" class="btn btn-info  btn-sm text-white">Entry List</a>
            </div>
        </div>
    
        <form action="{!!route('crud.store')!!}" method="POST">
            @csrf
            <div class="form-group">
                <label for="name">Name</label>
                <input type="text" class="form-control" id="name" name="name" value="{!! old('name') !!} " placeholder="Enter name">
                @if($errors->has('name'))
                <small class="text-danger">! {!!  $errors->first('name')  !!} </small>
                @endif
            </div>
            <div class="form-group">
                <label for="email">Email</label>
                <input type="email" class="form-control" id="email" name="email" value="{!! old('email') !!} " placeholder="Enter email">
                @if($errors->has('email'))
                <small class="text-danger">! {!!  $errors->first('email')  !!} </small>
                @endif
            </div>
            <div class="form-group">
                <label for="phone_no">Phone No</label>
                <input type="number" class="form-control" id="phone_no" name="phone"  value="{!! old('phone') !!} " placeholder="Enter Phone No">
                @if($errors->has('phone'))
                <small class="text-danger">! {!!  $errors->first('phone')  !!} </small>
                @endif
            </div>
            <div class="form-group">
                <label for="address">Address</label>
                <textarea  class="form-control" id="address" name="address" placeholder="Enter Phone No">{!! old('address') !!} </textarea>
                @if($errors->has('address'))
                <small class="text-danger">! {!! $errors->first('address') !!}</small>
                @endif
            </div>
            <button type="submit" class="btn btn-success btn-sm text-white">Submit</button>
        </form>
    </div>
    
    <script src="https://code.jquery.com/jquery-3.4.1.slim.min.js" integrity="sha384-J6qa4849blE2+poT4WnyKhv5vZF5SrPo0iEjwBvKU7imGFAV0wwj1yYfoRSJoZ+n" crossorigin="anonymous"></script>
    <script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script>
    <script src="https://cdn.jsdelivr.net/npm/bootstrap@4.4.1/dist/js/bootstrap.min.js" integrity="sha384-wfSDF2E50Y2D1uUdj0O3uMBJnjuUD4Ih7YwaYd1iqfktj0Uod8GCExl3Og8ifwB6" crossorigin="anonymous"></script>
    </body>
    </html>
    

Edit File:

Here is the Edit form views file

<!doctype html>
    <html lang="en">
    <head>
        <meta charset="UTF-8">
        <meta name="viewport"
              content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
        <meta http-equiv="X-UA-Compatible" content="ie=edge">
        <title>CRUD GENERATOR</title>
        <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@4.4.1/dist/css/bootstrap.min.css" integrity="sha384-Vkoo8x4CGsO3+Hhxv8T/Q5PaXtkKtu6ug5TOeNV6gBiFeWPGFN9MuhOf23Q9Ifjh" crossorigin="anonymous">
    
    </head>
    <body class="bg-light">
    <div class="container bg-white pb-3">
        <div class="d-flex justify-content-between pt-4 mb-3">
            <h3>EDIT ENTRY</h3>
            <div>
                <a href="{!! route('crud.index') !!}" class="btn btn-info  btn-sm text-white">Entry List</a>
            </div>
        </div>
    
        <form action="{!!route('crud.update',$edit_data->id)!!}" method="POST">
            @csrf
            <div class="form-group">
                <label for="name">Name</label>
                <input type="text" class="form-control" id="name" name="name" value="{!! $edit_data->name !!} " placeholder="Enter name">
                @if($errors->has('name'))
                <small class="text-danger">! {!!  $errors->first('name')  !!} </small>
                @endif
            </div>
            <div class="form-group">
                <label for="email">Email</label>
                <input type="email" class="form-control" id="email" name="email" value="{!! $edit_data->email !!} " placeholder="Enter email">
                @if($errors->has('email'))
                <small class="text-danger">! {!!  $errors->first('email')  !!} </small>
                @endif
            </div>
            <div class="form-group">
                <label for="phone_no">Phone No</label>
                <input type="number" class="form-control" id="phone_no" name="phone"  value="{!! $edit_data->phone !!} " placeholder="Enter Phone No">
                @if($errors->has('phone'))
                <small class="text-danger">! {!!  $errors->first('phone')  !!} </small>
                @endif
            </div>
            <div class="form-group">
                <label for="address">Address</label>
                <textarea  class="form-control" id="address" name="address" placeholder="Enter Phone No">{!! $edit_data->address !!} </textarea>
                @if($errors->has('address'))
                <small class="text-danger">! {!!  $errors->first('address')  !!} </small>
                @endif
            </div>
            <button type="submit" class="btn btn-success btn-sm text-white">Submit</button>
        </form>
    </div>
    
    <script src="https://code.jquery.com/jquery-3.4.1.slim.min.js" integrity="sha384-J6qa4849blE2+poT4WnyKhv5vZF5SrPo0iEjwBvKU7imGFAV0wwj1yYfoRSJoZ+n" crossorigin="anonymous"></script>
    <script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script>
    <script src="https://cdn.jsdelivr.net/npm/bootstrap@4.4.1/dist/js/bootstrap.min.js" integrity="sha384-wfSDF2E50Y2D1uUdj0O3uMBJnjuUD4Ih7YwaYd1iqfktj0Uod8GCExl3Og8ifwB6" crossorigin="anonymous"></script>
    </body>
    </html>
    

Index file:

Here is the Index form views file

<!doctype html>
    <html lang="en">
    <head>
        <meta charset="UTF-8">
        <meta name="viewport"
              content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
        <meta http-equiv="X-UA-Compatible" content="ie=edge">
        <title>CRUD GENERATOR</title>
        <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@4.4.1/dist/css/bootstrap.min.css" integrity="sha384-Vkoo8x4CGsO3+Hhxv8T/Q5PaXtkKtu6ug5TOeNV6gBiFeWPGFN9MuhOf23Q9Ifjh" crossorigin="anonymous">
    
    </head>
    <body class="bg-light">
        <div class="container bg-white pb-3">
            <div class="d-flex justify-content-between pt-4 mb-3">
                <h3>ENTRY LIST</h3>
                <div>
                    <a href="{!! route('crud.create')!!}" class="btn btn-info btn-sm text-white">Add New</a>
                </div>
            </div>
            @if(session()->has('success'))
            <div class="alert alert-success">
                {!!  session()->get('success')  !!} 
            </div>
            @endif
            <table class="table mb-3">
                <thead>
                <tr>
                    <th scope="col">#SL</th>
                    <th scope="col">Name</th>
                    <th scope="col">Email</th>
                    <th scope="col">Phone</th>
                    <th scope="col">Address</th>
                    <th scope="col">Action</th>
                </tr>
                </thead>
                <tbody>
                @foreach($data_list as $key=>$list)
                <tr>
                    <th scope="row">{!! $list->id !!} </th>
                    <td>{!! $list->name !!} </td>
                    <td>{!! $list->email !!} </td>
                    <td>{!! $list->phone !!} </td>
                    <td>{!! $list->address !!} </td>
                    <td>
                        <div class="btn-group">
                            <a href="{!! route('crud.edit',$list->id) !!}" class="btn btn-info  btn-sm text-white">Edit</a>
                            <a href="{!! route('crud.delete',$list->id)!!}" class="btn btn-danger  btn-sm text-white">Delete</a>
                        </div>
    
                    </td>
                </tr>
                @endforeach
                </tbody>
            </table>
            {!! $data_list->links() !!}
        </div>
    
      <script src="https://code.jquery.com/jquery-3.4.1.slim.min.js" integrity="sha384-J6qa4849blE2+poT4WnyKhv5vZF5SrPo0iEjwBvKU7imGFAV0wwj1yYfoRSJoZ+n" crossorigin="anonymous"></script>
      <script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script>
      <script src="https://cdn.jsdelivr.net/npm/bootstrap@4.4.1/dist/js/bootstrap.min.js" integrity="sha384-wfSDF2E50Y2D1uUdj0O3uMBJnjuUD4Ih7YwaYd1iqfktj0Uod8GCExl3Og8ifwB6" crossorigin="anonymous"></script>
    </body>
    </html>
    

Controller:

This is the controller for all crud methods.

<?php

namespace Mustafiz\CrudGenerator\Http\Controllers;

use App\Http\Controllers\Controller;
use Illuminate\Http\Request;
use Mustafiz\CrudGenerator\Models\CrudGenerator;

class CrudController extends Controller
{
    public function index(){
       $data_list =  CrudGenerator::orderBy('id','DESC')->paginate(10);
        return view('crud-generator::index',compact('data_list'));
    }
    public function create(){
        return view('crud-generator::create');
    }
    public function store(Request $request){
        $this->validate($request,[
            'name' => 'required|max:255',
            'email' => 'required|max:100|unique:crud_generators',
            'phone' => 'required|max:20|unique:crud_generators',
            'address' => 'required',
        ]);
        $create = CrudGenerator::create($request->all());
        if($create){
            return redirect()->route('crud.index')->with('success', 'Entry created successfully.');
        }else{
            return view('crud-generator::create');
        }
    }
    public function update(Request $request, $id){
        $this->validate($request,[
            'name' => 'required|max:255',
            'email' => 'required|max:100',
            'phone' => 'required|max:20',
            'address' => 'required',
        ]);
        $up = [
            'name' => $request->name,
            'email' => $request->email,
            'phone' => $request->phone,
            'address' => $request->address,
        ];
        $update = CrudGenerator::where('id',$id)->update($up);
        if($update){
            return redirect()->route('crud.index')->with('success', 'Entry update successfully.');
        }else{
            return redirect()->back();
        }
    }
    public function edit($id){
       $edit_data = CrudGenerator::find($id);
        return view('crud-generator::edit',compact('edit_data'));
    }
    public function delete($id){
        CrudGenerator::find($id)->delete();
        return redirect()->back()->with('success','Entry delete successfully');
    }
}

Service provider file:

In provider file we have to register our package routes, views and controllers

<?php

namespace Mustafiz\CrudGenerator;
use Illuminate\Support\ServiceProvider;
use Illuminate\Pagination\Paginator;

class CrudServiceProvider extends ServiceProvider
{

    /**
     * Register any application services.
     */
    public function register(): void
    {
        $this->loadRoutesFrom(__DIR__.'/routes/web.php');
        $this->loadViewsFrom(__DIR__.'/views', 'crud-generator');
        $this->loadMigrationsFrom(__DIR__.'/database/migrations');
    }


    /**
     * Bootstrap the package services.
     */
    public function boot(): void
    {
        Paginator::useBootstrap();
    }

}

Create Package Configuration:
Inside the MyPackage folder, create a composer.json file to define your package dependencies, autoload information, and other details.

{
    "name": "mustafiz/crud-generator",
    "description": "Simple CRUD Generator Package",
    "type": "library",
    "license": "MIT",
    "authors": [
        {
            "name": "mostafiz310",
            "email": "mostafiztopu@yahoo.com"
        }
    ],
    "minimum-stability": "dev",
    "require": {},
    "autoload": {
        "psr-4": {
            "Mustafiz\\CrudGenerator\\": "src/"
        }
    },
    "extra": {
        "laravel": {
            "providers": [
                "Mustafiz\\CrudGenerator\\CrudServiceProvider"
            ]
        }
    }
}

Run Composer Dump-Autoload:

After changing the composer.json file, run the following command to refresh the autoloader.

composer dump-autoload

Now, you have a Laravel project with a custom package folder structure. You can start building and using your package within your Laravel application.

Flow this github Repository : https://github.com/mostafiz128/crud-generator-package-by-mustafiz

Recommended Laravel Posts For You:

Recommended: Laravel all artisan call command to remove all caching data

Recommended: Laravel Custom Form Validation

Recommended: Laravel Form Validation With Google ReCAPTCHA

Recommended: Update data in laravel using ajax

Recommended: Ajax Data Fetching in Laravel

Recommended: Submit a form using AJAX in Laravel

Recommended: Laravel Custom Form Validation.