Toolkit

DrupalSanitiseCommands extends AbstractCommands
in package

Provides commands to check sanitisation fields.

Table of Contents

Properties

$io  : ConsoleIO
The Symfony Input Output.

Methods

areCommentFieldsSanitised()  : bool
Checks if the Comment fields are being sanitised.
areUserFieldsSanitised()  : bool
Checks if the User fields are being sanitised.
drupalCheckSanitisationClasses()  : int
Command to check existence of Sanitisation classes.
drupalCheckSanitisationFields()  : int
Command to check fields for sanitisation.
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.
optionPattern()  : string
Prepare regex to check if option exists with value "no".
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.
createClassMap()  : array<string|int, string>
Generates a class map for given directory.
getDrushSanitizeInterface()  : string
Returns the Drush Sanitize Interface namespace depending on the current version.
registerCustomClasses()  : void
Register all classes in custom code directory folder that are not registered.
testMap()  : array<string|int, mixed>
Returns a static field map for test purposes.

Properties

Methods

areCommentFieldsSanitised()

Checks if the Comment fields are being sanitised.

public static areCommentFieldsSanitised() : bool

Validates the presence of the SanitizeCommentsCommands command.

Return values
bool

areUserFieldsSanitised()

Checks if the User fields are being sanitised.

public static areUserFieldsSanitised() : bool

Validates the presence of the SanitizeUserTableCommands command and ensure that the fields are not being ignored in the opts.yml file with the options --sanitize-password and --sanitize-email.

Return values
bool

drupalCheckSanitisationClasses()

Command to check existence of Sanitisation classes.

public drupalCheckSanitisationClasses(ConsoleIO $io) : int
Parameters
$io : ConsoleIO
Tags
command

drupal:check-sanitisation-classes

Return values
int —

The drupal check sanitize status.

drupalCheckSanitisationFields()

Command to check fields for sanitisation.

public drupalCheckSanitisationFields(ConsoleIO $io[, array<string|int, mixed> $options = ['types' => InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'keywords' => InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'types-ignore' => InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY] ]) : int
Parameters
$io : ConsoleIO
$options : array<string|int, mixed> = ['types' => InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'keywords' => InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'types-ignore' => InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY]

Command options.

Tags
command

drupal:check-sanitisation-fields

option

types The field types to check.

option

keywords The keywords to look into field names.

SuppressWarnings

(PHPMD.CyclomaticComplexity)

SuppressWarnings

(PHPMD.NPathComplexity)

Return values
int

getConfigurationFile()

Path to YAML configuration file containing command defaults.

public getConfigurationFile() : string

Command classes should implement this method.

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

optionPattern()

Prepare regex to check if option exists with value "no".

public static optionPattern(string $option) : string
Parameters
$option : string

The option name to check, i.e: sanitize-email.

Return values
string

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.

createClassMap()

Generates a class map for given directory.

private createClassMap(string $directory) : array<string|int, string>

Only consider classes inside the src folder.

Parameters
$directory : string

The directory to scan, usually 'lib'.

Return values
array<string|int, string> —

Class map array generated.

getDrushSanitizeInterface()

Returns the Drush Sanitize Interface namespace depending on the current version.

private getDrushSanitizeInterface() : string
Return values
string —

Drush Sanitize Interface namespace.

registerCustomClasses()

Register all classes in custom code directory folder that are not registered.

private registerCustomClasses(string $directory) : void

This assumes the Drupal namespace \Drupal[module].

Parameters
$directory : string

The directory to search for classes.

Return values
void —

Register all classes in custom code directory folder.

testMap()

Returns a static field map for test purposes.

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

The static field map.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results