Toolkit

PatchCommands extends AbstractCommands
in package

Commands for patch download and list.

phpcs:disable Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClassAfterLastUsed

Tags
SuppressWarnings

(PHPMD.UnusedFormalParameter)

Table of Contents

Properties

$options  : array<string|int, mixed>
The command options.

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.
toolkitPatchDownload()  : int|mixed
Download remote patches into a local directory.
toolkitPatchList()  : int
Lists remote patches from the root composer.json.
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.
getDependenciesPatches()  : array<string|int, mixed>
Returns the patches from dependencies.
getPatches()  : array<string|int, string>
Returns the patches to be downloaded.
isComposerPatchesVersion2()  : bool
Check if project is using the version 2 of package cweagans/composer-patches.

Properties

$options

The command options.

protected array<string|int, mixed> $options

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
bool

toolkitPatchDownload()

Download remote patches into a local directory.

public toolkitPatchDownload(ConsoleIO $io[, array<string|int, mixed> $options = ['dir' => InputOption::VALUE_REQUIRED, 'package' => InputOption::VALUE_REQUIRED, 'composer' => InputOption::VALUE_REQUIRED, 'dependencies' => InputOption::VALUE_NONE] ]) : int|mixed
Parameters
$io : ConsoleIO
$options : array<string|int, mixed> = ['dir' => InputOption::VALUE_REQUIRED, 'package' => InputOption::VALUE_REQUIRED, 'composer' => InputOption::VALUE_REQUIRED, 'dependencies' => InputOption::VALUE_NONE]

Command options.

Tags
command

toolkit:patch-download

option

dir The destination directory to save the patches.

option

package Download patches for given package.

option

composer The composer.json file.

option

dependencies Look for patches defined by dependencies.

aliases

tk-pd

Return values
int|mixed —

Patch download status.

phpcs:disable Generic.CodeAnalysis.EmptyStatement.DetectedCatch

toolkitPatchList()

Lists remote patches from the root composer.json.

public toolkitPatchList(ConsoleIO $io[, array<string|int, mixed> $options = ['package' => InputOption::VALUE_REQUIRED, 'composer' => InputOption::VALUE_REQUIRED, 'dependencies' => InputOption::VALUE_NONE] ]) : int
Parameters
$io : ConsoleIO
$options : array<string|int, mixed> = ['package' => InputOption::VALUE_REQUIRED, 'composer' => InputOption::VALUE_REQUIRED, 'dependencies' => InputOption::VALUE_NONE]

The option to be list.

Tags
command

toolkit:patch-list

option

package List patches for given package.

option

composer The composer.json relative path.

option

dependencies Look for patches defined by dependencies.

aliases

tk-pl.

Return values
int —

Remote patch list.

getBin()

Validate and return the path to given bin.

protected getBin(string $name) : string
Parameters
$name : string

The bin to look for.

Tags
throws
TaskException
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
throws
TaskException
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
bool

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, 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.

getDependenciesPatches()

Returns the patches from dependencies.

private getDependenciesPatches() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Patches from dependencies.

getPatches()

Returns the patches to be downloaded.

private getPatches() : array<string|int, string>
Tags
SuppressWarnings

(PHPMD.CyclomaticComplexity)

SuppressWarnings

(PHPMD.NPathComplexity)

Return values
array<string|int, string> —

Patches to be downloaded.

isComposerPatchesVersion2()

Check if project is using the version 2 of package cweagans/composer-patches.

private isComposerPatchesVersion2() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results