Provides operations to inspect, lint, and repair PHPDoc comments across the project.
Description
The class MUST NOT be extended and SHALL coordinate tools like PHP-CS-Fixer and Rector.
'phpdoc'
'Checks and fixes PHPDocs.'
'This command checks and fixes PHPDocs in your PHP files.'
Constants
Properties
Methods
Creates a new PhpDocCommand instance.
Configures the PHPDoc command.
Executes the PHPDoc checks and rectifications.
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 the missing document header configuration file if needed.
Executes the PHP-CS-Fixer checks internally.
Runs Rector to insert missing method block comments automatically.
protected
Filesystem
$filesystem
private
ComposerJson
$composerJson
Creates a new PhpDocCommand instance.
public
__construct(ComposerJson
$composerJson, Filesystem
$filesystem) : mixed
Parameters
Description
the composer.json accessor
$filesystem
:
Filesystem
Description
the filesystem component
Configures the PHPDoc command.
protected
configure() : void
Description
This method MUST securely configure the expected inputs, such as the --fix option.
Executes the PHPDoc checks and rectifications.
protected
execute(InputInterface
$input, OutputInterface
$output) : int
Description
The method MUST ensure the .docheader template is present. It SHALL then invoke
PHP-CS-Fixer and Rector. If both succeed, it MUST return self::SUCCESS.
Parameters
$input
:
InputInterface
Description
the command input parameters
$output
:
OutputInterface
Description
the system output handler
Return values
Description
the success or failure state
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 the missing document header configuration file if needed.
private
ensureDocHeaderExists(OutputInterface
$output) : void
Description
The method MUST query the local filesystem. If the file is missing, it SHOULD copy the tool template into the root folder.
Parameters
$output
:
OutputInterface
Description
the logger where missing capabilities are announced
Executes the PHP-CS-Fixer checks internally.
private
runPhpCsFixer(InputInterface
$input, OutputInterface
$output) : int
Description
The method SHOULD run in dry-run mode unless the fix flag is explicitly provided. It MUST return an integer describing the exit code.
Parameters
$input
:
InputInterface
Description
the parsed console inputs
$output
:
OutputInterface
Description
the configured outputs
Return values
Description
the status result of the underlying process
Runs Rector to insert missing method block comments automatically.
private
runRector(InputInterface
$input, OutputInterface
$output) : int
Description
The method MUST apply the AddMissingMethodPhpDocRector constraint locally.
It SHALL strictly return an integer denoting success or failure.
Parameters
$input
:
InputInterface
Description
the incoming console parameters
$output
:
OutputInterface
Description
the outgoing console display
Return values
Description
the code indicating the process result