App\G6K\Command\CommandBase | Documentation of G6K classes

abstract class CommandBase extends Command

Base class for all command of the g6k namespace.

Properties

protected string	$name
protected string	$version
protected array\|false	$parameters
protected string	$projectDir
protected string	$publicDir
protected Translator	$translator
protected bool	$initialized
protected bool	$html

Methods

__construct(string $projectDir, string $name)

The constructor for the command

void

doInitialization()

Realizes the initialization this command

array|false

getParameters()

This function parses the '.env' file and returns an array of parameters

string

getParameterValue(string $parameter)

Returns the value of a parameter

string

getConfigParameter(string $parameter)

Gets a parameter with its name.

void

configure()

Configures the current command.

void

initialize(InputInterface $input, OutputInterface $output)

initializes the current command.

void

askArgument(InputInterface $input, OutputInterface $output, string $argumentName, string $questionText)

Asks an argument if it's not supplied in the command line.

int|null

execute(InputInterface $input, OutputInterface $output)

Executes the current command.

bool

runEmbeddedCommand(array $command, InputInterface $input, OutputInterface $output)

Run an embedded console command.

DOMElement|null

castDOMElement(DOMNode $node)

Casts a DOMNode to DOMElement

DOMElement|null

getDOMElementItem(DOMNodeList $nodes, int $index)

Retuns the DOMElement at position $index of the DOMNodeList

string

resolvePath(string $path, string $base)

Converts a relative path of a file to an absolute path

array

findFile(string $in, string $name, InputInterface $input, OutputInterface $output, array $filters = [])

Finds files in the subdirectories of a giving directory

string|int

findAssetsDirectory(string $in, InputInterface $input, OutputInterface $output)

Finds the assets directory

string|int

findTemplatesDirectory(string $in, InputInterface $input, OutputInterface $output)

Finds the templates directory

string|int

findPDFFormsDirectory(string $in, InputInterface $input, OutputInterface $output)

Finds the pdf forms directory

string|int

findSimulatorsDirectory(string $in, InputInterface $input, OutputInterface $output)

Finds the simulators directory

bool

isHtml()

Returns true, if the message are displayed in HTML, false if not.

void

message(OutputInterface $output, string $message, array $parameters = [], string $start = 'info', string $end = 'info', int $verbosity = OutputInterface::VERBOSITY_NORMAL)

Displays an message

void

info(OutputInterface $output, string $message, array $parameters = [])

Displays an info message

void

warning(OutputInterface $output, string $message, array $parameters = [])

Displays a warning message

void

success(OutputInterface $output, string $message, array $parameters = [])

Displays a success message

void

failure(OutputInterface $output, string $message, array $parameters = [])

Displays a failure message

void

fatal(OutputInterface $output, string $message, array $parameters = [])

Displays an fatal error message

void

error(OutputInterface $output, string $message, array $parameters = [])

Displays an error message

void

debug(OutputInterface $output, string $message, array $parameters = [])

Displays a debug message

void

comment(OutputInterface $output, string $message, array $parameters = [])

Displays a comment

string

getCommandName()

Returns the name of the current command

string

getCommandDescription()

Returns the description of the current command

string

getCommandHelp()

Returns the help text of the current command

array

getCommandArguments()

Returns the arguments of the current command

array

getCommandOptions()

Returns the options of the current command

Details

at line 97
`__construct(string $projectDir, string $name)`

The constructor for the command

Parameters

string	$projectDir	The project directory
string	$name	The command name

at line 111
`private void doInitialization()`

Realizes the initialization this command

Return Value

void

at line 136
`private array|false getParameters()`

This function parses the '.env' file and returns an array of parameters

Return Value

array|false

parameters array or false in case of error

at line 169
`private string getParameterValue(string $parameter)`

Returns the value of a parameter

Parameters

string

$parameter

The given parameter

Return Value

string

The value of the parameter

at line 184
`protected string getConfigParameter(string $parameter)`

Gets a parameter with its name.

Parameters

string

$parameter

The parameter name

Return Value

string

The parameter value

at line 194
`protected void configure()`

Configures the current command.

Return Value

void

at line 228
`protected void initialize(InputInterface $input, OutputInterface $output)`

initializes the current command.

Parameters

InputInterface	$input	The input interface
OutputInterface	$output	The output interface

Return Value

void

Exceptions

LogicException

at line 259
`protected void askArgument(InputInterface $input, OutputInterface $output, string $argumentName, string $questionText)`

Asks an argument if it's not supplied in the command line.

Parameters

InputInterface	$input	The input interface
OutputInterface	$output	The output interface
string	$argumentName	The argument name
string	$questionText	The question text

Return Value

void

at line 285
`protected int|null execute(InputInterface $input, OutputInterface $output)`

Executes the current command.

Parameters

InputInterface	$input	The input interface
OutputInterface	$output	The output interface

Return Value

int|null

null or 0 if everything went fine, or an error code

Exceptions

LogicException

When this abstract method is not implemented

at line 307
`protected bool runEmbeddedCommand(array $command, InputInterface $input, OutputInterface $output)`

Run an embedded console command.

Parameters

array	$command	The command
InputInterface	$input	The input interface
OutputInterface	$output	The output interface

Return Value

bool

at line 325
`protected DOMElement|null castDOMElement(DOMNode $node)`

Casts a DOMNode to DOMElement

Parameters

DOMNode

$node

The DOMNodeList

Return Value

DOMElement|null

The DOMElement.

at line 341
`protected DOMElement|null getDOMElementItem(DOMNodeList $nodes, int $index)`

Retuns the DOMElement at position $index of the DOMNodeList

Parameters

DOMNodeList	$nodes	The DOMNodeList
int	$index	The position in the DOMNodeList

Return Value

DOMElement|null

The DOMElement.

at line 357
`protected string resolvePath(string $path, string $base)`

Converts a relative path of a file to an absolute path

Parameters

string	$path	The relative path name of the file
string	$base	The base path

Return Value

string

at line 385
`protected array findFile(string $in, string $name, InputInterface $input, OutputInterface $output, array $filters = [])`

Finds files in the subdirectories of a giving directory

Parameters

string	$in	The start directory of the search
string	$name	The base name of the searched file
InputInterface	$input	The input interface
OutputInterface	$output	The output interface
array	$filters	Optional, filters to apply to the search

Return Value

array

The full path of the files or an empty array if none has been found

at line 438
`protected string|int findAssetsDirectory(string $in, InputInterface $input, OutputInterface $output)`

Finds the assets directory

Parameters

string	$in	The start directory of the search
InputInterface	$input	The input interface
OutputInterface	$output	The output interface

Return Value

string|int

The full path of the directory or an error code (1: not found, 2: multiple found)

at line 482
`protected string|int findTemplatesDirectory(string $in, InputInterface $input, OutputInterface $output)`

Finds the templates directory

Parameters

string	$in	The start directory of the search
InputInterface	$input	The input interface
OutputInterface	$output	The output interface

Return Value

string|int

The full path of the directory or an error code (1: not found, 2: multiple found)

at line 526
`protected string|int findPDFFormsDirectory(string $in, InputInterface $input, OutputInterface $output)`

Finds the pdf forms directory

Parameters

string	$in	The start directory of the search
InputInterface	$input	The input interface
OutputInterface	$output	The output interface

Return Value

string|int

The full path of the directory or an error code (1: not found, 2: multiple found)

at line 570
`protected string|int findSimulatorsDirectory(string $in, InputInterface $input, OutputInterface $output)`

Finds the simulators directory

Parameters

string	$in	The start directory of the search
InputInterface	$input	The input interface
OutputInterface	$output	The output interface

Return Value

string|int

The full path of the directory or an error code (1: not found, 2: multiple found)

at line 611
`protected bool isHtml()`

Returns true, if the message are displayed in HTML, false if not.

Return Value

bool

at line 627
`private void message(OutputInterface $output, string $message, array $parameters = [], string $start = 'info', string $end = 'info', int $verbosity = OutputInterface::VERBOSITY_NORMAL)`

Displays an message

Parameters

OutputInterface	$output	The output interface
string	$message	The message to display
array	$parameters	Optional, message parameters for translation
string	$start	The start tag
string	$end	The end tag
int	$verbosity	The verbosity option (default: OutputInterface::VERBOSITY_NORMAL), values : VERBOSITY_QUIET, VERBOSITY_NORMAL, VERBOSITY_VERBOSE, VERBOSITY_VERY_VERBOSE, VERBOSITY_DEBUG

Return Value

void

at line 647
`protected void info(OutputInterface $output, string $message, array $parameters = [])`

Displays an info message

Parameters

OutputInterface	$output	The output interface
string	$message	The message to display
array	$parameters	Optional, message parameters

Return Value

void

at line 664
`protected void warning(OutputInterface $output, string $message, array $parameters = [])`

Displays a warning message

Parameters

OutputInterface	$output	The output interface
string	$message	The message to display
array	$parameters	Optional, message parameters

Return Value

void

at line 681
`protected void success(OutputInterface $output, string $message, array $parameters = [])`

Displays a success message

Parameters

OutputInterface	$output	The output interface
string	$message	The message to display
array	$parameters	Optional, message parameters

Return Value

void

at line 698
`protected void failure(OutputInterface $output, string $message, array $parameters = [])`

Displays a failure message

Parameters

OutputInterface	$output	The output interface
string	$message	The message to display
array	$parameters	Optional, message parameters

Return Value

void

at line 715
`protected void fatal(OutputInterface $output, string $message, array $parameters = [])`

Displays an fatal error message

Parameters

OutputInterface	$output	The output interface
string	$message	The message to display
array	$parameters	Optional, message parameters

Return Value

void

at line 732
`protected void error(OutputInterface $output, string $message, array $parameters = [])`

Displays an error message

Parameters

OutputInterface	$output	The output interface
string	$message	The message to display
array	$parameters	Optional, message parameters

Return Value

void

at line 749
`protected void debug(OutputInterface $output, string $message, array $parameters = [])`

Displays a debug message

Parameters

OutputInterface	$output	The output interface
string	$message	The message to display
array	$parameters	Optional, message parameters

Return Value

void

at line 762
`protected void comment(OutputInterface $output, string $message, array $parameters = [])`

Displays a comment

Parameters

OutputInterface	$output	The output interface
string	$message	The message to display
array	$parameters	Optional, message parameters

Return Value

void

at line 772
`abstract protected string getCommandName()`

Returns the name of the current command

Return Value

string

The name

at line 781
`abstract protected string getCommandDescription()`

Returns the description of the current command

Return Value

string

The description

at line 790
`abstract protected string getCommandHelp()`

Returns the help text of the current command

Return Value

string

The help text

at line 799
`abstract protected array getCommandArguments()`

Returns the arguments of the current command

Return Value

array

The help text

at line 808
`abstract protected array getCommandOptions()`

Returns the options of the current command

Return Value

array

The help text

CommandBase

Properties

Methods

Details

at line 97 __construct(string $projectDir, string $name)

Parameters

at line 111 private void doInitialization()

Return Value

at line 136 private array|false getParameters()

Return Value

at line 169 private string getParameterValue(string $parameter)

Parameters

Return Value

at line 184 protected string getConfigParameter(string $parameter)

Parameters

Return Value

at line 194 protected void configure()

Return Value

at line 228 protected void initialize(InputInterface $input, OutputInterface $output)

Parameters

Return Value

Exceptions

at line 259 protected void askArgument(InputInterface $input, OutputInterface $output, string $argumentName, string $questionText)

Parameters

Return Value

at line 285 protected int|null execute(InputInterface $input, OutputInterface $output)

Parameters

Return Value

Exceptions

at line 307 protected bool runEmbeddedCommand(array $command, InputInterface $input, OutputInterface $output)

Parameters

Return Value

at line 325 protected DOMElement|null castDOMElement(DOMNode $node)

Parameters

Return Value

at line 341 protected DOMElement|null getDOMElementItem(DOMNodeList $nodes, int $index)

Parameters

Return Value

at line 357 protected string resolvePath(string $path, string $base)

Parameters

Return Value

at line 385 protected array findFile(string $in, string $name, InputInterface $input, OutputInterface $output, array $filters = [])

Parameters

Return Value

at line 438 protected string|int findAssetsDirectory(string $in, InputInterface $input, OutputInterface $output)

Parameters

Return Value

at line 482 protected string|int findTemplatesDirectory(string $in, InputInterface $input, OutputInterface $output)

Parameters

Return Value

at line 526 protected string|int findPDFFormsDirectory(string $in, InputInterface $input, OutputInterface $output)

Parameters

Return Value

at line 570 protected string|int findSimulatorsDirectory(string $in, InputInterface $input, OutputInterface $output)

Parameters

Return Value

at line 611 protected bool isHtml()

Return Value

at line 627 private void message(OutputInterface $output, string $message, array $parameters = [], string $start = 'info', string $end = 'info', int $verbosity = OutputInterface::VERBOSITY_NORMAL)

Parameters

Return Value

at line 647 protected void info(OutputInterface $output, string $message, array $parameters = [])

Parameters

Return Value

at line 664 protected void warning(OutputInterface $output, string $message, array $parameters = [])

Parameters

Return Value

at line 681 protected void success(OutputInterface $output, string $message, array $parameters = [])

Parameters

Return Value

at line 698 protected void failure(OutputInterface $output, string $message, array $parameters = [])

Parameters

Return Value

at line 715 protected void fatal(OutputInterface $output, string $message, array $parameters = [])

Parameters

Return Value

at line 732 protected void error(OutputInterface $output, string $message, array $parameters = [])

Parameters

Return Value

at line 749 protected void debug(OutputInterface $output, string $message, array $parameters = [])

at line 97
`__construct(string $projectDir, string $name)`

at line 111
`private void doInitialization()`

at line 136
`private array|false getParameters()`

at line 169
`private string getParameterValue(string $parameter)`

at line 184
`protected string getConfigParameter(string $parameter)`

at line 194
`protected void configure()`

at line 228
`protected void initialize(InputInterface $input, OutputInterface $output)`

at line 259
`protected void askArgument(InputInterface $input, OutputInterface $output, string $argumentName, string $questionText)`

at line 285
`protected int|null execute(InputInterface $input, OutputInterface $output)`

at line 307
`protected bool runEmbeddedCommand(array $command, InputInterface $input, OutputInterface $output)`

at line 325
`protected DOMElement|null castDOMElement(DOMNode $node)`

at line 341
`protected DOMElement|null getDOMElementItem(DOMNodeList $nodes, int $index)`

at line 357
`protected string resolvePath(string $path, string $base)`

at line 385
`protected array findFile(string $in, string $name, InputInterface $input, OutputInterface $output, array $filters = [])`

at line 438
`protected string|int findAssetsDirectory(string $in, InputInterface $input, OutputInterface $output)`

at line 482
`protected string|int findTemplatesDirectory(string $in, InputInterface $input, OutputInterface $output)`

at line 526
`protected string|int findPDFFormsDirectory(string $in, InputInterface $input, OutputInterface $output)`

at line 570
`protected string|int findSimulatorsDirectory(string $in, InputInterface $input, OutputInterface $output)`

at line 611
`protected bool isHtml()`

at line 627
`private void message(OutputInterface $output, string $message, array $parameters = [], string $start = 'info', string $end = 'info', int $verbosity = OutputInterface::VERBOSITY_NORMAL)`

at line 647
`protected void info(OutputInterface $output, string $message, array $parameters = [])`

at line 664
`protected void warning(OutputInterface $output, string $message, array $parameters = [])`

at line 681
`protected void success(OutputInterface $output, string $message, array $parameters = [])`

at line 698
`protected void failure(OutputInterface $output, string $message, array $parameters = [])`

at line 715
`protected void fatal(OutputInterface $output, string $message, array $parameters = [])`

at line 732
`protected void error(OutputInterface $output, string $message, array $parameters = [])`

at line 749
`protected void debug(OutputInterface $output, string $message, array $parameters = [])`

at line 762
`protected void comment(OutputInterface $output, string $message, array $parameters = [])`

at line 772
`abstract protected string getCommandName()`

at line 781
`abstract protected string getCommandDescription()`

at line 790
`abstract protected string getCommandHelp()`

at line 799
`abstract protected array getCommandArguments()`

at line 808
`abstract protected array getCommandOptions()`