ReportsCommand
extends AbstractCommand
in package
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.
Table of Contents
Properties
- $filesystem : Filesystem
Methods
- __construct() : mixed
- Constructs a new AbstractCommand instance.
- configure() : void
- Configures the metadata for the reports generation command.
- execute() : int
- Executes the generation logic for diverse reports.
- getAbsolutePath() : string
- Computes the absolute path for a given relative or absolute path.
- getConfigFile() : string
- Determines the correct absolute path to a configuration file.
- getCurrentWorkingDirectory() : string
- Retrieves the current working directory of the application.
- getProjectDescription() : string
- Computes the human-readable description of the current application.
- getProjectName() : string
- Computes the human-readable title or description of the current application.
- getPsr4Namespaces() : array<string|int, mixed>
- Retrieves configured PSR-4 namespaces from the composer configuration.
- runCommand() : int
- Configures and executes a registered console command by name.
- runProcess() : int
- Executes a given system process gracefully and outputs its buffer.
- generateFrontpage() : void
- Generates the compiled documentation frontpage correctly.
- renderTemplate() : string
- Constructs string variations defining standard components by linking to predefined resources.
Properties
$filesystem read-only
protected
Filesystem
$filesystem
The filesystem instance used for file operations. This property MUST be utilized for interacting with the file system securely.
Methods
__construct()
Constructs a new AbstractCommand instance.
public
__construct([Filesystem|null $filesystem = null ]) : mixed
The method MAY accept a Filesystem instance; if omitted, it SHALL instantiate a new one.
Parameters
- $filesystem : Filesystem|null = null
-
the filesystem utility to use
configure()
Configures the metadata for the reports generation command.
protected
configure() : void
The method MUST identify the command correctly and describe its intent broadly.
execute()
Executes the generation logic for diverse reports.
protected
execute(InputInterface $input, OutputInterface $output) : int
The method MUST run the underlying docs and tests commands. It SHALL process
and generate the frontpage output file successfully.
Parameters
- $input : InputInterface
-
the structured inputs holding specific arguments
- $output : OutputInterface
-
the designated output interface
Return values
int —the integer outcome from the base process execution
getAbsolutePath()
Computes the absolute path for a given relative or absolute path.
protected
getAbsolutePath(string $relativePath) : string
This method MUST return the exact path if it is already absolute. If relative, it SHALL make it absolute relying on the current working directory.
Parameters
- $relativePath : string
-
the path to evaluate or resolve
Return values
string —the resolved absolute path
getConfigFile()
Determines the correct absolute path to a configuration file.
protected
getConfigFile(string $filename[, bool $force = false ]) : string
The method MUST attempt to resolve the configuration file locally in the working directory. If absent and not forced, it SHALL provide the default equivalent from the package itself.
Parameters
- $filename : string
-
the name of the configuration file
- $force : bool = false
-
determines whether to bypass fallback and forcefully return the local file path
Return values
string —the resolved absolute path to the configuration file
getCurrentWorkingDirectory()
Retrieves the current working directory of the application.
protected
getCurrentWorkingDirectory() : string
The method MUST return the initial working directory defined by the application. If not available, it SHALL fall back to the safe current working directory.
Return values
string —the absolute path to the current working directory
getProjectDescription()
Computes the human-readable description of the current application.
protected
getProjectDescription() : string
The method SHOULD utilize the package description as the title, but MUST provide the raw package name as a fallback mechanism.
Return values
string —the computed title or description string
getProjectName()
Computes the human-readable title or description of the current application.
protected
getProjectName() : string
The method SHOULD utilize the package description as the title, but MUST provide the raw package name as a fallback mechanism.
Return values
string —the computed title or description string
getPsr4Namespaces()
Retrieves configured PSR-4 namespaces from the composer configuration.
protected
getPsr4Namespaces() : array<string|int, mixed>
This method SHALL parse the underlying composer.json using the Composer instance,
and MUST provide an empty array if no specific paths exist.
Return values
array<string|int, mixed> —the PSR-4 namespaces mappings
runCommand()
Configures and executes a registered console command by name.
protected
runCommand(string $commandName, array<string|int, mixed>|InputInterface $input, OutputInterface $output) : int
The method MUST look up the command from the application and run it. It SHALL ignore generic validation errors and route the custom input and output correctly.
Parameters
- $commandName : string
-
the name of the required command
- $input : array<string|int, mixed>|InputInterface
-
the input arguments or array definition
- $output : OutputInterface
-
the interface for buffering output
Return values
int —the status code resulting from the dispatched command
runProcess()
Executes a given system process gracefully and outputs its buffer.
protected
runProcess(Process $command, OutputInterface $output) : int
The method MUST execute the provided command ensuring the output is channeled
to the OutputInterface. It SHOULD leverage TTY if supported. If the process
fails, it MUST return self::FAILURE; otherwise, it SHALL return self::SUCCESS.
Parameters
- $command : Process
-
the configured process instance to run
- $output : OutputInterface
-
the output interface to log warnings or results
Return values
int —the status code of the command execution
generateFrontpage()
Generates the compiled documentation frontpage correctly.
private
generateFrontpage() : void
This method MUST collect the configured render template and write it persistently
to the public/index.html directory.
renderTemplate()
Constructs string variations defining standard components by linking to predefined resources.
private
renderTemplate(string $title, array<string, string> $links) : string
The method MUST extract variables correctly and stream the content safely. It SHALL strictly return the interpreted string structure.
Parameters
- $title : string
-
the main title intended for the index interface
- $links : array<string, string>
-
the associative array representing link titles and their URIs
Return values
string —the evaluated and parsed HTML content