SymlinkProjectCommands
extends AbstractCommands
in package
Provides command to symlink project as a package.
Table of Contents
Properties
- $types : array<string|int, string>
- A mapping of Drupal project type to directory.
Methods
- getConfigurationFile() : mixed
- 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.
- symlinkProject() : CollectionBuilder
- Symlink project as module, theme or profile in the proper directory.
- symlinkProjectValidate() : void
- Validate command drupal:symlink-project.
- getBin() : string
- Validate and return the path to given bin.
- getBinPath() : string
- Return the path to given bin.
- getConfigValue() : mixed
- {@inheritdoc}
- getNodeBin() : string
- Validate and return the path to given bin from node packages.
- getNodeBinPath() : string
- Return the path to given bin from node packages.
- isSimulating() : bool
- Check if current command is being executed with option simulate.
- taskExecute() : mixed
- Execute a command.
- taskProcess() : mixed
- Process the file.
- taskReplaceBlock() : mixed
- Replace block in a file.
- scanDir() : array<string|int, mixed>
- Scan given directory excluding specific folders.
Properties
$types
A mapping of Drupal project type to directory.
protected
array<string|int, string>
$types
= ['drupal-module' => 'modules/custom', 'drupal-theme' => 'themes/custom', 'drupal-profile' => 'profiles/custom']
Methods
getConfigurationFile()
Path to YAML configuration file containing command defaults.
public
getConfigurationFile() : mixed
getJson()
Returns the JSON parsed content.
public
getJson(string $filename[, mixed $throwException = true ]) : array<string|int, mixed>
Parameters
- $filename : string
- $throwException : mixed = true
Return values
array<string|int, mixed>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
boolsymlinkProject()
Symlink project as module, theme or profile in the proper directory.
public
symlinkProject([array<string|int, mixed> $options = ['root' => InputOption::VALUE_REQUIRED, 'ignore' => InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY] ]) : CollectionBuilder
Parameters
- $options : array<string|int, mixed> = ['root' => InputOption::VALUE_REQUIRED, 'ignore' => InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY]
-
Command options.
Tags
Return values
CollectionBuilder —Collection builder.
symlinkProjectValidate()
Validate command drupal:symlink-project.
public
symlinkProjectValidate() : void
Tags
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()
{@inheritdoc}
protected
getConfigValue(mixed $key[, mixed $default = null ]) : mixed
Parameters
- $key : mixed
- $default : mixed = null
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.
isSimulating()
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, mixed> $tasks) : mixed
Parameters
- $tasks : array<string|int, mixed>
-
An array with tasks to execute.
taskProcess()
Process the file.
protected
taskProcess(string $source[, string $destination = '' ]) : mixed
Parameters
- $source : string
-
The source file to process.
- $destination : string = ''
-
The destination file.
taskReplaceBlock()
Replace block in a file.
protected
taskReplaceBlock([string $filename = '' ]) : mixed
Parameters
- $filename : string = ''
-
The file to process.
scanDir()
Scan given directory excluding specific folders.
private
scanDir(string $directory[, array<string|int, mixed> $ignore = [] ]) : array<string|int, mixed>
Parameters
- $directory : string
-
The directory to scan.
- $ignore : array<string|int, mixed> = []
-
Extra folders to ignore.