mtvbrianking / laravel-artisan-gui

src/Http/CommandController.php

<?php

namespace Bmatovu\ArtisanGui\Http;

use Bmatovu\ArtisanGui\Support\Commander;
use Illuminate\Contracts\Console\Kernel;
use Illuminate\Contracts\Validation\Factory as ValidationFactory;
use Illuminate\Http\Request;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Output\BufferedOutput;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

class CommandController
{
    /**
     * The console kernel.
     *
     * @var \Illuminate\Contracts\Console\Kernel
     */
    protected $kernel;

    /**
     * The validation factory implementation.
     *
     * @var \Illuminate\Contracts\Validation\Factory
     */
    protected $validationFactory;

    /**
     * Create a new controller instance.
     *
     * @param \Illuminate\Contracts\Console\Kernel     $kernel
     * @param \Illuminate\Contracts\Validation\Factory $validationFactory
     *
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct(Kernel $kernel, ValidationFactory $validationFactory)
    {
        $this->kernel = $kernel;
        $this->validationFactory = $validationFactory;
    }

    /**
     * Get artisan commands.
     *
     * @return \Illuminate\Http\Response
     */
    public function __invoke()
    {
        $commander = new Commander($this->kernel);

        return response([

The expression response(array('namespaces' => $commander->getNamespaces(), 'definition' => $commander->getDefinition(), 'commands' => $commander->getCommands())); of type Illuminate\Http\Response|Illuminate\Contracts\Routing\ResponseFactory adds the type Illuminate\Contracts\Routing\ResponseFactory to the return on line 52 which is incompatible with the return type documented by Bmatovu\ArtisanGui\Http\CommandController::__invoke of type Illuminate\Http\Response.

            'namespaces' => $commander->getNamespaces(),
            'definition' => $commander->getDefinition(),
            'commands' => $commander->getCommands(),
        ]);
    }

    /**
     * Execute artisan command.
     *
     * @param \Illuminate\Http\Request $request
     *
     * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
     *
     * @return \Illuminate\Http\Response
     */
    public function execute(Request $request)
    {
        $command = $this->resolve($request->command);

        $validated = $this->validationFactory->make($request->all(), $this->rules($command))->validate();

        $parameters = array_merge($validated, config('artisan-gui.options'));

        $outputBuffer = new BufferedOutput();

        try {
            $exitCode = $this->kernel->call($command->getName(), $parameters, $outputBuffer);
            // $output = $this->kernel->output();
            $output = $outputBuffer->fetch();
        } catch (\Exception $exception) {
            return response([

The expression response(array('code' => $exception->getCode() ?? '', 'message' => $exception->getMessage()), 500); of type Illuminate\Http\Response|Illuminate\Contracts\Routing\ResponseFactory adds the type Illuminate\Contracts\Routing\ResponseFactory to the return on line 83 which is incompatible with the return type documented by Bmatovu\ArtisanGui\Http\CommandController::execute of type Illuminate\Http\Response.

                'code' => $exception->getCode() ?? '',
                'message' => $exception->getMessage(),
            ], 500);
        }

        return response([

The expression response(array('command' => $command->getName(), 'parameters' => $this->flatten($parameters), 'exit-code' => $exitCode, 'output' => $output)); of type Illuminate\Http\Response|Illuminate\Contracts\Routing\ResponseFactory adds the type Illuminate\Contracts\Routing\ResponseFactory to the return on line 89 which is incompatible with the return type documented by Bmatovu\ArtisanGui\Http\CommandController::execute of type Illuminate\Http\Response.

            'command' => $command->getName(),
            'parameters' => $this->flatten($parameters),
            'exit-code' => $exitCode,
            'output' => $output,
        ]);
    }

    /**
     * Flatten command parameters.
     *
     * @param array $parameters
     *
     * @return string
     */
    protected function flatten(array $parameters)
    {
        $cli_params = '';

        foreach ($parameters as $name => $value) {
            if (empty($value)) {
                continue;
            }

            if (strpos($name, '--') === 0) {
                if (is_bool($value)) {
                    $cli_params .= " {$name}";

                    continue;
                }
            }

            if (is_array($value)) {
                $items = implode(',', $value);
                $cli_params .= " {$name}=\"{$items}\"";

                continue;
            }

            $cli_params .= " {$name}=\"{$value}\"";
        }

        return $cli_params;
    }

    /**
     * Resolve command from kernel.
     *
     * @param string $name Command name
     *
     * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
     *
     * @return \Symfony\Component\Console\Command\Command
     */
    protected function resolve($name): Command
    {
        $commands = $this->kernel->all();

        $command = $commands[$name] ?? null;

        if (! $command) {
            throw new NotFoundHttpException('Unknown command.');
        }

        return $command;
    }

    /**
     * Build command validation rules.
     *
     * @param \Symfony\Component\Console\Command\Command $command
     *
     * @return array
     */
    protected function rules(Command $command): array
    {
        $rules = [];

        foreach ($command->getDefinition()->getArguments() as $argument) {
            $rules[$argument->getName()] = array_filter([
                $argument->isRequired() ? 'required' : 'nullable',
                $argument->isArray() ? 'array' : '',
            ]);
        }

        foreach ($command->getDefinition()->getOptions() as $option) {
            $name = $option->getName();

            $rules["--{$name}"] = array_filter([
                $option->isValueRequired() ? 'required' : 'nullable',
                $option->isArray() ? 'array' : ($option->acceptValue() ? 'string' : 'bool'),
            ]);
        }

        return $rules;
    }
}