-
-
Notifications
You must be signed in to change notification settings - Fork 0
ReportsCommand
github-actions edited this page Apr 22, 2026
·
1 revision
Coordinates the generation of Fast Forward documentation frontpage and related reports.
This class MUST NOT be overridden and SHALL securely combine docs and testing commands.
- Full name:
\FastForward\DevTools\Console\Command\ReportsCommand - Parent class:
BaseCommand - This class is marked as final and can't be subclassed
- This class implements:
\FastForward\DevTools\Console\Command\LoggerAwareCommandInterface - This class is a Final class
Initializes the command with required dependencies.
public __construct(\FastForward\DevTools\Process\ProcessBuilderInterface $processBuilder, \FastForward\DevTools\Process\ProcessQueueInterface $processQueue, \Psr\Log\LoggerInterface $logger): mixedParameters:
| Parameter | Type | Description |
|---|---|---|
$processBuilder |
\FastForward\DevTools\Process\ProcessBuilderInterface | the builder instance used to construct execution processes |
$processQueue |
\FastForward\DevTools\Process\ProcessQueueInterface | the execution queue mechanism for running sub-processes |
$logger |
\Psr\Log\LoggerInterface | the output-aware logger |
protected configure(): voidExecutes the generation logic for diverse reports.
protected execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output): intThe method MUST run the underlying docs and tests commands. It SHALL process
and generate the frontpage output file successfully.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$input |
\Symfony\Component\Console\Input\InputInterface | the structured inputs holding specific arguments |
$output |
\Symfony\Component\Console\Output\OutputInterface | the designated output interface |
Return Value:
the integer outcome from the base process execution
Adds the standard JSON output options to the current command.
protected addJsonOption(): staticDetermines whether JSON output was requested.
protected isJsonOutput(\Symfony\Component\Console\Input\InputInterface $input): boolThe pretty-json flag SHALL imply JSON output.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$input |
\Symfony\Component\Console\Input\InputInterface |
Determines whether pretty JSON output was requested.
protected isPrettyJsonOutput(\Symfony\Component\Console\Input\InputInterface $input): boolParameters:
| Parameter | Type | Description |
|---|---|---|
$input |
\Symfony\Component\Console\Input\InputInterface |