Doctor extends AbstractCommand
Doctor command.
This command inspects the current Cecil installation and site configuration. It highlights the active paths, cache settings and common setup problems so users can quickly spot why a build might fail or behave unexpectedly.
Table of Contents
Constants
- CONFIG_FILE : mixed = ['cecil.yml', 'config.yml']
- EXCLUDED_CMD : mixed = ['about', 'new:site', 'self-update', 'serve:stop']
- PID_FILE : mixed = \Cecil\Builder::TMP_DIR . '/server.pid'
- SERVE_OUTPUT : mixed = \Cecil\Builder::TMP_DIR . '/preview'
Properties
- $input : InputInterface
- $io : CecilStyle
- $output : OutputInterface
- $rootPath : string
Methods
- getProcessedHelp() : string
- Override default help message.
- notification() : void
- Send desktop notification.
- run() : int
- {@inheritdoc}
- validateUrl() : string
- Validate URL.
- binName() : string
- Returns the "binary name" in the console context.
- configure() : mixed
- {@inheritdoc}
- execute() : int
- {@inheritdoc}
- getBuilder() : Builder
- Creates or returns a Builder instance.
- getConfigFiles() : array<string|int, mixed>
- Returns config file(s) path.
- getPath() : string|null
- Returns the working path.
- initialize() : mixed
- {@inheritdoc}
- locateAdditionalConfigFiles() : array<string|int, mixed>
- Locates additional configuration file(s) from the given list of files, relative to the given path or absolute.
- locateConfigFile() : array<string|int, mixed>
- Locates the configuration in the given path, as an array of the file name and path, if file exists, otherwise default name and false.
- openEditor() : void
- Opens path with editor.
- formatStatus() : string
- Formats status from domain diagnostics for console output.
Constants
CONFIG_FILE
public
mixed
CONFIG_FILE
= ['cecil.yml', 'config.yml']
EXCLUDED_CMD
public
mixed
EXCLUDED_CMD
= ['about', 'new:site', 'self-update', 'serve:stop']
PID_FILE
public
mixed
PID_FILE
= \Cecil\Builder::TMP_DIR . '/server.pid'
SERVE_OUTPUT
public
mixed
SERVE_OUTPUT
= \Cecil\Builder::TMP_DIR . '/preview'
Properties
$input
protected
InputInterface
$input
$io
protected
CecilStyle
$io
$output
protected
OutputInterface
$output
$rootPath
protected
string
$rootPath
Methods
getProcessedHelp()
Override default help message.
public
getProcessedHelp() : string
Return values
stringnotification()
Send desktop notification.
public
notification(string $body[, string|null $url = null ]) : void
Parameters
- $body : string
- $url : string|null = null
run()
{@inheritdoc}
public
run(InputInterface $input, OutputInterface $output) : int
Parameters
- $input : InputInterface
- $output : OutputInterface
Return values
intvalidateUrl()
Validate URL.
public
static validateUrl(string $url) : string
Parameters
- $url : string
Tags
Return values
stringbinName()
Returns the "binary name" in the console context.
protected
binName() : string
Return values
stringconfigure()
{@inheritdoc}
protected
configure() : mixed
execute()
{@inheritdoc}
protected
execute(InputInterface $input, OutputInterface $output) : int
Parameters
- $input : InputInterface
- $output : OutputInterface
Return values
intgetBuilder()
Creates or returns a Builder instance.
protected
getBuilder([array<string|int, mixed> $config = [] ]) : Builder
Parameters
- $config : array<string|int, mixed> = []
Tags
Return values
BuildergetConfigFiles()
Returns config file(s) path.
protected
getConfigFiles() : array<string|int, mixed>
Return values
array<string|int, mixed>getPath()
Returns the working path.
protected
getPath([bool $exist = true ]) : string|null
Parameters
- $exist : bool = true
Return values
string|nullinitialize()
{@inheritdoc}
protected
initialize(InputInterface $input, OutputInterface $output) : mixed
Parameters
- $input : InputInterface
- $output : OutputInterface
locateAdditionalConfigFiles()
Locates additional configuration file(s) from the given list of files, relative to the given path or absolute.
protected
locateAdditionalConfigFiles(string $path, string $configFilesList) : array<string|int, mixed>
Parameters
- $path : string
- $configFilesList : string
Return values
array<string|int, mixed>locateConfigFile()
Locates the configuration in the given path, as an array of the file name and path, if file exists, otherwise default name and false.
protected
locateConfigFile(string $path) : array<string|int, mixed>
Parameters
- $path : string
Return values
array<string|int, mixed>openEditor()
Opens path with editor.
protected
openEditor(string $path, string $editor) : void
Parameters
- $path : string
- $editor : string
Tags
formatStatus()
Formats status from domain diagnostics for console output.
private
formatStatus(string $status) : string
Parameters
- $status : string