ExceptionMakeCommand.php

TLDR

This file is part of the Illuminate\Foundation\Console namespace and contains the ExceptionMakeCommand class. This class extends the GeneratorCommand class and is used to create a new custom exception class. The command can be invoked using the command make:exception. The generated exception class can be customized with the --force, --render, and --report command options.

Methods

No methods are defined in this file.

Classes

ExceptionMakeCommand

The ExceptionMakeCommand class extends the GeneratorCommand class and is used to create a new custom exception class. It is annotated with the #[AsCommand] attribute to specify the command name as make:exception. The class has the following properties:

• $name (string): The console command name is set to 'make:exception'.
• $description (string): The console command description is set to 'Create a new custom exception class'.
• $type (string): The type of class being generated is set to 'Exception'.

The class has the following methods:

• getStub() - Returns the stub file path based on the --render and --report command options.
• alreadyExists($rawName) - Determines if the exception class already exists based on the fully qualified class name.
• getDefaultNamespace($rootNamespace) - Returns the default namespace for the generated exception class.
• getOptions() - Returns the console command options, including --force, --render, and --report.

<?php

namespace Illuminate\Foundation\Console;

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

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

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

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

    /**
     * Get the stub file for the generator.
     *
     * @return string
     */
    protected function getStub()
    {
        if ($this->option('render')) {
            return $this->option('report')
                ? __DIR__.'/stubs/exception-render-report.stub'
                : __DIR__.'/stubs/exception-render.stub';
        }

        return $this->option('report')
            ? __DIR__.'/stubs/exception-report.stub'
            : __DIR__.'/stubs/exception.stub';
    }

    /**
     * Determine if the class already exists.
     *
     * @param  string  $rawName
     * @return bool
     */
    protected function alreadyExists($rawName)
    {
        return class_exists($this->rootNamespace().'Exceptions\\'.$rawName);
    }

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

    /**
     * Get the console command options.
     *
     * @return array
     */
    protected function getOptions()
    {
        return [
            ['force', 'f', InputOption::VALUE_NONE, 'Create the class even if the exception already exists'],
            ['render', null, InputOption::VALUE_NONE, 'Create the exception with an empty render method'],
            ['report', null, InputOption::VALUE_NONE, 'Create the exception with an empty report method'],
        ];
    }
}