InstallCommands
extends AbstractCommands
in package
Class ToolkitCommands.
Table of Contents
Methods
- getConfigurationFile() : string
- Path to YAML configuration file containing command defaults.
- getJson() : array<string|int, mixed>
- Returns the JSON parsed content.
- getWorkingDir() : string
- Returns the current working directory.
- isWebsiteInstalled() : bool
- Check if the website is installed.
- toolkitInstallClean() : CollectionBuilder
- Install a clean website.
- toolkitInstallClone() : CollectionBuilder
- Install a clone website.
- toolkitRunDeploy() : CollectionBuilder
- Run deployment sequence.
- getBin() : string
- Validate and return the path to given bin.
- getBinPath() : string
- Return the path to given bin.
- getConfigValue() : mixed|null
- Return the configuration value.
- getNodeBin() : string
- Validate and return the path to given bin from node packages.
- getNodeBinPath() : string
- Return the path to given bin from node packages.
- isJunit() : bool
- Check whether Junit option is being used, or env var is set.
- isSimulating() : bool
- Check if current command is being executed with option simulate.
- taskExecute() : CollectionBuilder
- Execute a command.
- taskProcess() : ReplaceBlock|CollectionBuilder
- Process the file.
- taskReplaceBlock() : ReplaceBlock|CollectionBuilder
- Replace block in a file.
Methods
getConfigurationFile()
Path to YAML configuration file containing command defaults.
public
getConfigurationFile() : string
Return values
string —Configuration file path.
getJson()
Returns the JSON parsed content.
public
getJson(string $filename[, bool $throwException = true ]) : array<string|int, mixed>
Parameters
- $filename : string
- $throwException : bool = true
-
If the file is not found.
Return values
array<string|int, mixed> —Json parsed content.
getWorkingDir()
Returns the current working directory.
public
getWorkingDir() : string
Return values
string —The current working directory.
isWebsiteInstalled()
Check if the website is installed.
public
isWebsiteInstalled() : bool
Return values
booltoolkitInstallClean()
Install a clean website.
public
toolkitInstallClean([array<string|int, mixed> $options = ['config-file' => InputOption::VALUE_REQUIRED] ]) : CollectionBuilder
Parameters
- $options : array<string|int, mixed> = ['config-file' => InputOption::VALUE_REQUIRED]
-
Command options.
Tags
Return values
CollectionBuilder —Collection builder.
toolkitInstallClone()
Install a clone website.
public
toolkitInstallClone(ConsoleIO $io[, array<string|int, mixed> $options = ['dumpfile' => InputOption::VALUE_REQUIRED] ]) : CollectionBuilder
Parameters
- $io : ConsoleIO
- $options : array<string|int, mixed> = ['dumpfile' => InputOption::VALUE_REQUIRED]
-
Command options.
Tags
Return values
CollectionBuilder —The cloned website task.
toolkitRunDeploy()
Run deployment sequence.
public
toolkitRunDeploy([array<string|int, mixed> $options = ['sequence-file' => InputOption::VALUE_REQUIRED, 'sequence-key' => InputOption::VALUE_REQUIRED] ]) : CollectionBuilder
This command will check for a file that holds the deployment sequence. If it is available it will run the commands defined in the yaml file under the selected key. If not we will run a standard set of deployment commands.
Parameters
- $options : array<string|int, mixed> = ['sequence-file' => InputOption::VALUE_REQUIRED, 'sequence-key' => InputOption::VALUE_REQUIRED]
-
Command options.
Tags
Return values
CollectionBuilder —Collection builder.
getBin()
Validate and return the path to given bin.
protected
getBin(string $name) : string
Parameters
- $name : string
-
The bin to look for.
Tags
Return values
string —The bin path.
getBinPath()
Return the path to given bin.
protected
getBinPath(string $name) : string
Parameters
- $name : string
Return values
string —The path to given binary.
getConfigValue()
Return the configuration value.
protected
getConfigValue(string $key[, mixed|null $default = null ]) : mixed|null
Parameters
- $key : string
-
The config item to look up.
- $default : mixed|null = null
-
Default configuration value for the key item if neither has value nor exists.
Return values
mixed|null —The configuration value.
getNodeBin()
Validate and return the path to given bin from node packages.
protected
getNodeBin(string $name) : string
Parameters
- $name : string
-
The bin to look for.
Tags
Return values
string —The bin path.
getNodeBinPath()
Return the path to given bin from node packages.
protected
getNodeBinPath(string $name) : string
Parameters
- $name : string
Return values
string —The path to given binary.
isJunit()
Check whether Junit option is being used, or env var is set.
protected
isJunit() : bool
Return values
boolisSimulating()
Check if current command is being executed with option simulate.
protected
isSimulating() : bool
Return values
bool —True if using --simulate, false otherwise.
taskExecute()
Execute a command.
protected
taskExecute(array<string|int, string> $tasks) : CollectionBuilder
Parameters
- $tasks : array<string|int, string>
-
An array with tasks to execute.
Return values
CollectionBuilder —The task executed.
taskProcess()
Process the file.
protected
taskProcess(string $source[, string $destination = '' ]) : ReplaceBlock|CollectionBuilder
Parameters
- $source : string
-
The source file to process.
- $destination : string = ''
-
The destination file.
Return values
ReplaceBlock|CollectionBuilder —The file task processed.
taskReplaceBlock()
Replace block in a file.
protected
taskReplaceBlock([string $filename = '' ]) : ReplaceBlock|CollectionBuilder
Parameters
- $filename : string = ''
-
The file to process.
Return values
ReplaceBlock|CollectionBuilder —The file replaced.