JobMakeCommand.php

TLDR

This file contains the JobMakeCommand class which is a command for creating a new job class in the Illuminate/Foundation/Console namespace of the Laravel framework.

Methods

No specific methods are defined in this file.

Classes

JobMakeCommand

The JobMakeCommand class extends the GeneratorCommand class and is responsible for creating a new job class. It is a console command with the name 'make:job' and has the following properties:

• $name: The console command name.
• $description: The console command description.
• $type: The type of class being generated.

The class also uses the CreatesMatchingTest trait.

The class has the following methods:

• getStub(): Returns the stub file for the generator based on the 'sync' option.
• resolveStubPath($stub): Resolves the fully-qualified path to the stub.
• getDefaultNamespace($rootNamespace): Returns the default namespace for the class.
• getOptions(): Returns the console command options.

<?php

namespace Illuminate\Foundation\Console;

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

#[AsCommand(name: 'make:job')]
class JobMakeCommand extends GeneratorCommand
{
    use CreatesMatchingTest;

    /**
     * The console command name.
     *
     * @var string
     */
    protected $name = 'make:job';

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

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

    /**
     * Get the stub file for the generator.
     *
     * @return string
     */
    protected function getStub()
    {
        return $this->option('sync')
                        ? $this->resolveStubPath('/stubs/job.stub')
                        : $this->resolveStubPath('/stubs/job.queued.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.'\Jobs';
    }

    /**
     * Get the console command options.
     *
     * @return array
     */
    protected function getOptions()
    {
        return [
            ['force', 'f', InputOption::VALUE_NONE, 'Create the class even if the job already exists'],
            ['sync', null, InputOption::VALUE_NONE, 'Indicates that job should be synchronous'],
        ];
    }
}