DocsCommand
extends AbstractCommand
in package
Handles the generation of API documentation for the project.
This class MUST NOT be extended and SHALL utilize phpDocumentor to accomplish its task.
Table of Contents
Properties
- $filesystem : Filesystem
Methods
- __construct() : mixed
- Constructs a new AbstractCommand instance.
- configure() : void
- Configures the command instance.
- execute() : int
- Executes the generation of the documentation files.
- 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.
- createPhpDocumentorConfig() : string
- Creates a temporary phpDocumentor configuration for the current project.
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 command instance.
protected
configure() : void
The method MUST set up the name and description. It MAY accept an optional --target option
pointing to an alternative configuration target path.
execute()
Executes the generation of the documentation files.
protected
execute(InputInterface $input, OutputInterface $output) : int
This method MUST compile arguments based on PSR-4 namespaces to feed into phpDocumentor.
It SHOULD provide feedback on generation progress, and SHALL return self::SUCCESS on success.
Parameters
- $input : InputInterface
-
the input details for the command
- $output : OutputInterface
-
the output mechanism for logging
Return values
int —the final execution status code
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
createPhpDocumentorConfig()
Creates a temporary phpDocumentor configuration for the current project.
private
createPhpDocumentorConfig(string $source, string $target, string $template) : string
Parameters
- $source : string
-
the source directory for the generated documentation
- $target : string
-
the output directory for the generated documentation
- $template : string
-
the phpDocumentor template name or path
Return values
string —the absolute path to the generated configuration