RequestMakeCommand.php

TLDR

This file is a part of the Illuminate\Foundation\Console namespace in the Demo Projects project. It is the RequestMakeCommand class, which extends the GeneratorCommand class. The RequestMakeCommand class is responsible for creating a new form request class.

Methods

There are no custom methods in this file.

Classes

RequestMakeCommand

The RequestMakeCommand class is a command that generates a new form request class. It extends the GeneratorCommand class and is used to create a new form request class when executed. The class provides the following:

• The $name property, which specifies the console command name as "make:request".
• The $description property, which describes the console command as "Create a new form request class".
• The $type property, which specifies "Request" as the type of class being generated.
• The getStub() method, which returns the stub file path for the generator.
• The resolveStubPath() method, which resolves the fully-qualified path to the stub.
• The getDefaultNamespace() method, which returns the default namespace for the class.
• The getOptions() method, which returns an array of console command options.

<?php

namespace Illuminate\Foundation\Console;

use Illuminate\Console\GeneratorCommand;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Input\InputOption;

#[AsCommand(name: 'make:request')]
class RequestMakeCommand extends GeneratorCommand
{
    /**
     * The console command name.
     *
     * @var string
     */
    protected $name = 'make:request';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Create a new form request class';

    /**
     * The type of class being generated.
     *
     * @var string
     */
    protected $type = 'Request';

    /**
     * Get the stub file for the generator.
     *
     * @return string
     */
    protected function getStub()
    {
        return $this->resolveStubPath('/stubs/request.stub');
    }

    /**
     * Resolve the fully-qualified path to the stub.
     *
     * @param  string  $stub
     * @return string
     */
    protected function resolveStubPath($stub)
    {
        return file_exists($customPath = $this->laravel->basePath(trim($stub, '/')))
                        ? $customPath
                        : __DIR__.$stub;
    }

    /**
     * Get the default namespace for the class.
     *
     * @param  string  $rootNamespace
     * @return string
     */
    protected function getDefaultNamespace($rootNamespace)
    {
        return $rootNamespace.'\Http\Requests';
    }

    /**
     * Get the console command arguments.
     *
     * @return array
     */
    protected function getOptions()
    {
        return [
            ['force', 'f', InputOption::VALUE_NONE, 'Create the class even if the request already exists'],
        ];
    }
}