Krayin CRM Developer Portal

# Controller

# Introduction

In Laravel, controllers are responsible for handling the request logic of an application. They act as intermediaries between the models and views, processing user input, interacting with the data layer, and returning the appropriate responses. By organizing related request handling logic into separate classes, controllers make it easier to manage and maintain the application's codebase.

To learn in detail about Controllers, you can visit the Laravel documentation here (opens new window).

# How to create Controllers

To start building a controller for our category within the Laravel package named "Category," follow the steps below:

# Directory Structure

Create the necessary directory structure within the packages/Webkul/Category/src path. To create the directory structure follow the following steps:

  1. Navigate to the packages/Webkul/Category/src directory.
  2. Create an Http directory inside src.
  3. Inside the Http directory, create another directory named Controllers.
  4. Inside the Controllers directory, create base controller named Controller.php which is extends the Laravel core controller:
<?php

namespace Webkul\Admin\Http\Controllers;

use Illuminate\Foundation\Bus\DispatchesJobs;
use Illuminate\Routing\Controller as BaseController;
use Illuminate\Foundation\Validation\ValidatesRequests;
use Illuminate\Foundation\Auth\Access\AuthorizesRequests;

class Controller extends BaseController
{
  use AuthorizesRequests, DispatchesJobs, ValidatesRequests;
}
  1. Now create a new directory named Category inside this directory, create a new file named CategoryController.php file.

In packages/Webkul/Category/src/Http/Controllers/Category/CategoryController.php, define the CategoryController:

<?php

namespace Webkul\Category\Http\Controllers;

use Webkul\Category\Http\Controllers\Controller;
use Webkul\Category\Repository\CategoryRepository;

class CategoryController extends Controller
{
  /**
   * Create a controller instance.
   * 
   * @return void
   */
  public function __construct(protected CategoryRepository $categoryRepository)
  {
  }

  /**
   * Display the listing of the resource.
   * 
   * @return \Illuminate\View\View
   */
  public function index()
  {
    $categories = $this->categoryRepository->all();

    return view('category::admin.index', compact('categories'));
  }

  /**
   * Category details.
   * 
   * @return \Illuminate\View\View
   */
  public function show(int $id) 
  {
    // ...
  }

  // ...
}

The Updated directory structure will look like this.

└── packages
    └── Webkul
        └── Category
            └── src
                ├── ...
                └── Http
                    └── Controllers
                        ├── Controller.php
                        └── Category
                            └── CategoryController.php

By following these steps, you will have created the necessary structure and files for handling category within your "Category" package. You can now add the specific logic for each method to handle the functionality required for your category into the admin.

← Views →