InputHandler::getOutputFromThrowable() - Code Metrics - valkyrjaio/valkyrja - Measure and Improve Code Quality continuously with Scrutinizer

InputHandler::getOutputFromThrowable() A
last analyzed 2025-08-08 04:54 UTC

↳ Parent: InputHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines	25
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	21
dl	0
loc	25
rs	9.584
c	0
b	0
f	0
cc	1
nc	1
nop	2

<?php

declare(strict_types=1);

/*
 * This file is part of the Valkyrja Framework package.
 *
 * (c) Melech Mizrachi <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Valkyrja\Cli\Server;

use Override;
filter:
    dependency_paths: ["lib/*"]
use Throwable;
use Valkyrja\Cli\Interaction\Config as InteractionConfig;
use Valkyrja\Cli\Interaction\Enum\ExitCode;
use Valkyrja\Cli\Interaction\Input\Contract\Input;
use Valkyrja\Cli\Interaction\Message\Banner;
use Valkyrja\Cli\Interaction\Message\ErrorMessage;
use Valkyrja\Cli\Interaction\Message\Message;
use Valkyrja\Cli\Interaction\Message\NewLine;
use Valkyrja\Cli\Interaction\Output\Contract\Output;
use Valkyrja\Cli\Middleware;
use Valkyrja\Cli\Middleware\Handler\Contract\ExitedHandler;
use Valkyrja\Cli\Middleware\Handler\Contract\InputReceivedHandler;
use Valkyrja\Cli\Middleware\Handler\Contract\ThrowableCaughtHandler;
use Valkyrja\Cli\Routing\Command\VersionCommand;
filter:
    dependency_paths: ["lib/*"]
use Valkyrja\Cli\Routing\Contract\Router;
use Valkyrja\Cli\Routing\Data\Option\NoInteractionOptionParameter;
filter:
    dependency_paths: ["lib/*"]
use Valkyrja\Cli\Routing\Data\Option\QuietOptionParameter;
filter:
    dependency_paths: ["lib/*"]
use Valkyrja\Cli\Routing\Data\Option\SilentOptionParameter;
filter:
    dependency_paths: ["lib/*"]
use Valkyrja\Cli\Routing\Data\Option\VersionOptionParameter;
filter:
    dependency_paths: ["lib/*"]
use Valkyrja\Cli\Server\Contract\InputHandler as Contract;
use Valkyrja\Container\Contract\Container;
use Valkyrja\Support\Exiter;

/**
 * Class InputHandler.
 *
 * @author Melech Mizrachi
 */
class InputHandler implements Contract
{
    /**
     * RequestHandler constructor.
     */
    public function __construct(
        protected Container $container = new \Valkyrja\Container\Container(),
        protected Router $router = new \Valkyrja\Cli\Routing\Router(),
        protected InputReceivedHandler $inputReceivedHandler = new Middleware\Handler\InputReceivedHandler(),
        protected ThrowableCaughtHandler $throwableCaughtHandler = new Middleware\Handler\ThrowableCaughtHandler(),
        protected ExitedHandler $exitedHandler = new Middleware\Handler\ExitedHandler(),
        protected InteractionConfig $interactionConfig = new InteractionConfig(),
    ) {
    }

    /**
     * Handle the input.
     *
     * @param Input $input The input
     *
     * @return Output
     */
    #[Override]
    public function handle(Input $input): Output
    {
        try {
            $this->setInteractivity($input);

            if (
                $input->hasOption(VersionOptionParameter::SHORT_NAME)
                || $input->hasOption(VersionOptionParameter::NAME)
            ) {
                $input = $input->withCommandName(VersionCommand::NAME);
            }

            $output = $this->dispatchRouter($input);
        } catch (Throwable $throwable) {
            $output = $this->getOutputFromThrowable($input, $throwable);
            $output = $this->throwableCaughtHandler->throwableCaught($input, $output, $throwable);
        }

        // Set the returned output in the container
        $this->container->setSingleton(Output::class, $output);

        return $output;
    }

    /**
     * Handle exiting the handler.
     *
     * @param Input  $input  The input
     * @param Output $output The output
     *
     * @return void
     */
    #[Override]
    public function exit(Input $input, Output $output): void
    {
        // Dispatch the exited middleware
        $this->exitedHandler->exited($input, $output);
    }

    /**
     * Run the handler.
     *
     * @param Input $input
     *
     * @return void
     */
    #[Override]
    public function run(Input $input): void
    {
        $output = $this->handle($input);

        $output->writeMessages();

        $this->exit($input, $output);

        $exitCode = $output->getExitCode();

        if ($exitCode instanceof ExitCode) {
            $exitCode = $exitCode->value;
        }

        Exiter::exit($exitCode);
    }

    /**
     * Set the interactivity.
     *
     * @param Input $input The input
     *
     * @return void
     */
    protected function setInteractivity(Input $input): void
    {
        if (
            $input->hasOption(NoInteractionOptionParameter::SHORT_NAME)
            || $input->hasOption(NoInteractionOptionParameter::NAME)
        ) {
            $this->interactionConfig->isInteractive = false;
        }

        if (
            $input->hasOption(QuietOptionParameter::SHORT_NAME)
            || $input->hasOption(QuietOptionParameter::NAME)
        ) {
            $this->interactionConfig->isQuiet = true;
        }

        if (
            $input->hasOption(SilentOptionParameter::SHORT_NAME)
            || $input->hasOption(SilentOptionParameter::NAME)
        ) {
            $this->interactionConfig->isSilent = true;
        }
    }

    /**
     * Dispatch the input via the router.
     *
     * @param Input $input The input
     *
     * @return Output
     */
    protected function dispatchRouter(Input $input): Output
    {
        // Set the request object in the container
        $this->container->setSingleton(Input::class, $input);

        // Dispatch the before input received middleware
        $inputAfterMiddleware = $this->inputReceivedHandler->inputReceived($input);

        // If the return value after middleware is a response return it
        if ($inputAfterMiddleware instanceof Output) {
            return $inputAfterMiddleware;
        }

        // Set the returned request in the container
        $this->container->setSingleton(Input::class, $inputAfterMiddleware);

        return $this->router->dispatch($inputAfterMiddleware);
    }

    /**
     * Get an output from a throwable.
     *
     * @param Input     $input     The input
     * @param Throwable $throwable The throwable
     *
     * @return Output
     */
    protected function getOutputFromThrowable(Input $input, Throwable $throwable): Output
    {
        $commandName = $input->getCommandName();

        return (new \Valkyrja\Cli\Interaction\Output\Output(
            exitCode: ExitCode::ERROR
        ))
            ->withMessages(
                new Banner(new ErrorMessage('Cli Server Error:')),
                new NewLine(),
                new ErrorMessage('Command:'),
                new Message(" $commandName"),
                new NewLine(),
                new NewLine(),
                new ErrorMessage('Message:'),
                new Message(' ' . $throwable->getMessage()),
                new NewLine(),
                new NewLine(),
                new ErrorMessage('Line:'),
                new Message(' ' . ((string) $throwable->getLine())),
                new NewLine(),
                new NewLine(),
                new ErrorMessage('Trace:'),
                new NewLine(),
                new Message($throwable->getTraceAsString() . "\n"),
            );
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Valkyrja Framework package.
7			*
8			* (c) Melech Mizrachi <[email protected]>
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Valkyrja\Cli\Server;
15
16			use Override;
			0 ignored issues – show Bug introduced 2025-07-10 03:52 UTC by Report Bug Copy Issue Report The type `Override` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
17			use Throwable;
18			use Valkyrja\Cli\Interaction\Config as InteractionConfig;
19			use Valkyrja\Cli\Interaction\Enum\ExitCode;
20			use Valkyrja\Cli\Interaction\Input\Contract\Input;
21			use Valkyrja\Cli\Interaction\Message\Banner;
22			use Valkyrja\Cli\Interaction\Message\ErrorMessage;
23			use Valkyrja\Cli\Interaction\Message\Message;
24			use Valkyrja\Cli\Interaction\Message\NewLine;
25			use Valkyrja\Cli\Interaction\Output\Contract\Output;
26			use Valkyrja\Cli\Middleware;
27			use Valkyrja\Cli\Middleware\Handler\Contract\ExitedHandler;
28			use Valkyrja\Cli\Middleware\Handler\Contract\InputReceivedHandler;
29			use Valkyrja\Cli\Middleware\Handler\Contract\ThrowableCaughtHandler;
30			use Valkyrja\Cli\Routing\Command\VersionCommand;
			0 ignored issues – show Bug introduced 2025-06-26 04:57 UTC by Report Bug Copy Issue Report The type `Valkyrja\Cli\Routing\Command\VersionCommand` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
31			use Valkyrja\Cli\Routing\Contract\Router;
32			use Valkyrja\Cli\Routing\Data\Option\NoInteractionOptionParameter;
			0 ignored issues – show Bug introduced 2025-06-26 04:57 UTC by Report Bug Copy Issue Report The type `Valkyrja\Cli\Routing\Dat...eractionOptionParameter` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
33			use Valkyrja\Cli\Routing\Data\Option\QuietOptionParameter;
			0 ignored issues – show Bug introduced 2025-06-26 04:57 UTC by Report Bug Copy Issue Report The type `Valkyrja\Cli\Routing\Dat...on\QuietOptionParameter` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
34			use Valkyrja\Cli\Routing\Data\Option\SilentOptionParameter;
			0 ignored issues – show Bug introduced 2025-06-26 04:57 UTC by Report Bug Copy Issue Report The type `Valkyrja\Cli\Routing\Dat...n\SilentOptionParameter` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
35			use Valkyrja\Cli\Routing\Data\Option\VersionOptionParameter;
			0 ignored issues – show Bug introduced 2025-06-26 04:57 UTC by Report Bug Copy Issue Report The type `Valkyrja\Cli\Routing\Dat...\VersionOptionParameter` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
36			use Valkyrja\Cli\Server\Contract\InputHandler as Contract;
37			use Valkyrja\Container\Contract\Container;
38			use Valkyrja\Support\Exiter;
39
40			/**
41			* Class InputHandler.
42			*
43			* @author Melech Mizrachi
44			*/
45			class InputHandler implements Contract
46			{
47			/**
48			* RequestHandler constructor.
49			*/
50			public function __construct(
51			protected Container $container = new \Valkyrja\Container\Container(),
52			protected Router $router = new \Valkyrja\Cli\Routing\Router(),
53			protected InputReceivedHandler $inputReceivedHandler = new Middleware\Handler\InputReceivedHandler(),
54			protected ThrowableCaughtHandler $throwableCaughtHandler = new Middleware\Handler\ThrowableCaughtHandler(),
55			protected ExitedHandler $exitedHandler = new Middleware\Handler\ExitedHandler(),
56			protected InteractionConfig $interactionConfig = new InteractionConfig(),
57			) {
58			}
59
60			/**
61			* Handle the input.
62			*
63			* @param Input $input The input
64			*
65			* @return Output
66			*/
67			#[Override]
68			public function handle(Input $input): Output
69			{
70			try {
71			$this->setInteractivity($input);
72
73			if (
74			$input->hasOption(VersionOptionParameter::SHORT_NAME)
75			\|\| $input->hasOption(VersionOptionParameter::NAME)
76			) {
77			$input = $input->withCommandName(VersionCommand::NAME);
78			}
79
80			$output = $this->dispatchRouter($input);
81			} catch (Throwable $throwable) {
82			$output = $this->getOutputFromThrowable($input, $throwable);
83			$output = $this->throwableCaughtHandler->throwableCaught($input, $output, $throwable);
84			}
85
86			// Set the returned output in the container
87			$this->container->setSingleton(Output::class, $output);
88
89			return $output;
90			}
91
92			/**
93			* Handle exiting the handler.
94			*
95			* @param Input $input The input
96			* @param Output $output The output
97			*
98			* @return void
99			*/
100			#[Override]
101			public function exit(Input $input, Output $output): void
102			{
103			// Dispatch the exited middleware
104			$this->exitedHandler->exited($input, $output);
105			}
106
107			/**
108			* Run the handler.
109			*
110			* @param Input $input
111			*
112			* @return void
113			*/
114			#[Override]
115			public function run(Input $input): void
116			{
117			$output = $this->handle($input);
118
119			$output->writeMessages();
120
121			$this->exit($input, $output);
122
123			$exitCode = $output->getExitCode();
124
125			if ($exitCode instanceof ExitCode) {
126			$exitCode = $exitCode->value;
127			}
128
129			Exiter::exit($exitCode);
130			}
131
132			/**
133			* Set the interactivity.
134			*
135			* @param Input $input The input
136			*
137			* @return void
138			*/
139			protected function setInteractivity(Input $input): void
140			{
141			if (
142			$input->hasOption(NoInteractionOptionParameter::SHORT_NAME)
143			\|\| $input->hasOption(NoInteractionOptionParameter::NAME)
144			) {
145			$this->interactionConfig->isInteractive = false;
146			}
147
148			if (
149			$input->hasOption(QuietOptionParameter::SHORT_NAME)
150			\|\| $input->hasOption(QuietOptionParameter::NAME)
151			) {
152			$this->interactionConfig->isQuiet = true;
153			}
154
155			if (
156			$input->hasOption(SilentOptionParameter::SHORT_NAME)
157			\|\| $input->hasOption(SilentOptionParameter::NAME)
158			) {
159			$this->interactionConfig->isSilent = true;
160			}
161			}
162
163			/**
164			* Dispatch the input via the router.
165			*
166			* @param Input $input The input
167			*
168			* @return Output
169			*/
170			protected function dispatchRouter(Input $input): Output
171			{
172			// Set the request object in the container
173			$this->container->setSingleton(Input::class, $input);
174
175			// Dispatch the before input received middleware
176			$inputAfterMiddleware = $this->inputReceivedHandler->inputReceived($input);
177
178			// If the return value after middleware is a response return it
179			if ($inputAfterMiddleware instanceof Output) {
180			return $inputAfterMiddleware;
181			}
182
183			// Set the returned request in the container
184			$this->container->setSingleton(Input::class, $inputAfterMiddleware);
185
186			return $this->router->dispatch($inputAfterMiddleware);
187			}
188
189			/**
190			* Get an output from a throwable.
191			*
192			* @param Input $input The input
193			* @param Throwable $throwable The throwable
194			*
195			* @return Output
196			*/
197			protected function getOutputFromThrowable(Input $input, Throwable $throwable): Output
198			{
199			$commandName = $input->getCommandName();
200
201			return (new \Valkyrja\Cli\Interaction\Output\Output(
202			exitCode: ExitCode::ERROR
203			))
204			->withMessages(
205			new Banner(new ErrorMessage('Cli Server Error:')),
206			new NewLine(),
207			new ErrorMessage('Command:'),
208			new Message(" $commandName"),
209			new NewLine(),
210			new NewLine(),
211			new ErrorMessage('Message:'),
212			new Message(' ' . $throwable->getMessage()),
213			new NewLine(),
214			new NewLine(),
215			new ErrorMessage('Line:'),
216			new Message(' ' . ((string) $throwable->getLine())),
217			new NewLine(),
218			new NewLine(),
219			new ErrorMessage('Trace:'),
220			new NewLine(),
221			new Message($throwable->getTraceAsString() . "\n"),
222			);
223			}
224			}
225

valkyrjaio / valkyrja

InputHandler::getOutputFromThrowable() A last analyzed 2025-08-08 04:54 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

InputHandler::getOutputFromThrowable() A
last analyzed 2025-08-08 04:54 UTC