Provides functionality to execute automated code refactoring using Rector.
Description
This class MUST NOT be extended and SHALL encapsulate the logic for Rector invocation.
'standards:rector'
'Runs Rector for code refactoring.'
['refactor', 'rector']
Constants
Properties
Methods
Creates a new RefactorCommand instance.
Adds the standard JSON output options to the current command.
Configures the refactor command options and description.
Executes the refactoring process securely.
Determines whether JSON output was requested.
Determines whether pretty JSON output was requested.
Logs a failed command result and returns the failure exit code.
Determines whether structured JSON output SHOULD be enabled implicitly.
Determines whether a boolean input option was enabled.
Logs a non-terminal command message unless structured JSON output is active.
Logs a successful command result and returns the success exit code.
private
FileLocatorInterface
$fileLocator
private
ProcessBuilderInterface
$processBuilder
private
ProcessQueueInterface
$processQueue
Creates a new RefactorCommand instance.
public
__construct(FileLocatorInterface
$fileLocator, ProcessBuilderInterface
$processBuilder, ProcessQueueInterface
$processQueue) : mixed
Parameters
$fileLocator
:
FileLocatorInterface
Description
the file locator
Description
the process builder
Description
the process queue
Adds the standard JSON output options to the current command.
protected
addJsonOption() : static
Return values
Configures the refactor command options and description.
protected
configure() : void
Description
This method MUST define the expected --fix option. It SHALL configure the command name
and descriptions accurately.
Executes the refactoring process securely.
protected
execute(InputInterface
$input, OutputInterface
$output) : int
Description
The method MUST execute Rector securely via Process. It SHALL use dry-run mode
unless the --fix option is specified. It MUST return self::SUCCESS or self::FAILURE.
Parameters
$input
:
InputInterface
Description
the input interface to retrieve arguments properly
$output
:
OutputInterface
Description
the output interface to log outputs
Return values
Description
the status code denoting success or failure
Determines whether JSON output was requested.
protected
isJsonOutput(InputInterface
$input) : bool
Description
The pretty-json flag SHALL imply JSON output.
Parameters
$input
:
InputInterface
Return values
Determines whether pretty JSON output was requested.
protected
isPrettyJsonOutput(InputInterface
$input) : bool
Parameters
$input
:
InputInterface
Return values
Logs a failed command result and returns the failure exit code.
private
failure(
string
$message, InputInterface
$input[,
array<string, mixed>
$context = []][,
string|null
$file = null][,
int|null
$line = null]) : int
Parameters
$message
:
string
Description
the failure message
$input
:
InputInterface
Description
the originating command input
$context
:
array<string, mixed>
=
[]
Description
optional extra log context
$file
:
string|null
=
null
Description
the related file path when known
$line
:
int|null
=
null
Description
the related line when known
Return values
Determines whether structured JSON output SHOULD be enabled implicitly.
private
isImplicitJsonOutputEnabled() : bool
Description
Commands MAY opt into runtime-environment-aware behavior by exposing a
$runtimeEnvironment property. Commands that do not expose it SHALL fall
back to the shared runtime-environment service from the DevTools container.
Return values
Determines whether a boolean input option was enabled.
private
isOptionEnabled(InputInterface
$input,
string
$option) : bool
Parameters
$input
:
InputInterface
$option
:
string
Return values
Logs a non-terminal command message unless structured JSON output is active.
private
log(
string
$message, InputInterface
$input[,
array<string, mixed>
$context = []][,
string
$logLevel = LogLevel::INFO]) : void
Parameters
$message
:
string
Description
the progress message
$input
:
InputInterface
Description
the originating command input
$context
:
array<string, mixed>
=
[]
Description
optional extra log context
$logLevel
:
string
=
LogLevel::INFO
Description
the PSR-3 log level used for the message
private
resolveRuntimeEnvironment() : RuntimeEnvironmentInterface|null
Return values
Logs a successful command result and returns the success exit code.
private
success(
string
$message, InputInterface
$input[,
array<string, mixed>
$context = []][,
string
$logLevel = LogLevel::INFO]) : int
Parameters
$message
:
string
Description
the success message
$input
:
InputInterface
Description
the originating command input
$context
:
array<string, mixed>
=
[]
Description
optional extra log context
$logLevel
:
string
=
LogLevel::INFO
Description
the PSR-3 log level used for the successful result