Handles the generation of API documentation for the project.
Description
This class MUST NOT be extended and SHALL utilize phpDocumentor to accomplish its task.
'docs'
'Generates API documentation.'
'This command generates API documentation using phpDocumentor.'
Properties
Methods
Constructs a new AbstractCommand instance.
Configures the command instance.
Executes the generation of the documentation files.
Computes the absolute path for a given relative or absolute path.
Determines the correct absolute path to a configuration file.
Retrieves the current working directory of the application.
Resolves the absolute path to a file within the fast-forward/dev-tools package.
Configures and executes a registered console command by name.
Executes a given system process gracefully and outputs its buffer.
Creates a temporary phpDocumentor configuration for the current project.
protected
Filesystem
$filesystem
private
ComposerJson
$composerJson
Constructs a new AbstractCommand instance.
public
__construct(ComposerJson
$composerJson, Filesystem
$filesystem) : mixed
Parameters
$filesystem
:
Filesystem
Configures the command instance.
protected
configure() : void
Description
The method MUST set up the name and description. It MAY accept an optional --target option
pointing to an alternative configuration target path.
Executes the generation of the documentation files.
protected
execute(InputInterface
$input, OutputInterface
$output) : int
Description
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
Description
the input details for the command
$output
:
OutputInterface
Description
the output mechanism for logging
Return values
Description
the final execution status code
Computes the absolute path for a given relative or absolute path.
protected
getAbsolutePath(
string
$relativePath) : string
Description
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
Description
the path to evaluate or resolve
Return values
Description
the resolved absolute path
Determines the correct absolute path to a configuration file.
protected
getConfigFile(
string
$filename[,
bool
$force = false]) : string
Description
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
Description
the name of the configuration file
$force
:
bool
=
false
Description
determines whether to bypass fallback and forcefully return the local file path
Return values
Description
the resolved absolute path to the configuration file
Retrieves the current working directory of the application.
protected
getCurrentWorkingDirectory() : string
Description
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
Description
the absolute path to the current working directory
Resolves the absolute path to a file within the fast-forward/dev-tools package.
protected
getDevToolsFile(
string
$filename) : string
Description
This method uses Composer's InstalledVersions to determine the installation path of the fast-forward/dev-tools package and returns the absolute path to the given filename within it. It is used as a fallback when a configuration file is not found in the project root.
Parameters
$filename
:
string
Description
the name of the file to resolve within the dev-tools package
Return values
Description
the absolute path to the file inside the dev-tools package
Configures and executes a registered console command by name.
protected
runCommand(
string
$command, OutputInterface
$output) : int
Description
The method MUST run the specified command with the provided input and output interfaces.
Parameters
$command
:
string
Description
the commandline name of the command to execute
$output
:
OutputInterface
Description
the interface for buffering output
Return values
Description
the status code resulting from the dispatched command
Executes a given system process gracefully and outputs its buffer.
protected
runProcess(Process
$command, OutputInterface
$output[,
bool
$tty = true]) : int
Description
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
Description
the configured process instance to run
$output
:
OutputInterface
Description
the output interface to log warnings or results
$tty
:
bool
=
true
Return values
Description
the status code of the command execution
Creates a temporary phpDocumentor configuration for the current project.
private
createPhpDocumentorConfig(
string
$source,
string
$target,
string
$template) : string
Parameters
$source
:
string
Description
the source directory for the generated documentation
$target
:
string
Description
the output directory for the generated documentation
$template
:
string
Description
the phpDocumentor template name or path
Return values
Description
the absolute path to the generated configuration