ComplexParameter Class Reference

Public Member Functions
	__construct ($name, $pattern=self::DEFAULT_PATTERN)
	getFromArray ($input)
	getFromString ($string)
	mergeFromArgv ($server, array $into=[])

Data Fields
const	DEFAULT_PATTERN = '/^\-\-%s=(.+)$/'

Detailed Description

A parser for complex parameters in command-line arguments

Transforms parameter formatted as a URL query string into an array

Definition at line 14 of file ComplexParameter.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$name,
			$pattern = self::DEFAULT_PATTERN
	)

Constructor

Parameters

string	$name
string	$pattern

Definition at line 41 of file ComplexParameter.php.

    {
        $this->name = $name;
        $this->pcre = sprintf($pattern, preg_quote($name, '/'));
    }

Member Function Documentation

getFromArray()

getFromArray

(

$input

)

Searches and parses the value from an array of arguments

Parameters

string[]

$input

Returns

array

Definition at line 53 of file ComplexParameter.php.

    {
        foreach ($input as $row) {
            $result = $this->getFromString($row);
            if ($result) {
                return $result;
            }
        }
        return [];
    }

getFromString()

getFromString

(

$string

)

Parses the value from a specified argument string

Parameters

string

$string

Returns

array

Definition at line 70 of file ComplexParameter.php.

    {
        if (preg_match($this->pcre, $string, $matches)) {
            parse_str($matches[1], $result);
            return $result;
        }
        return [];
    }

mergeFromArgv()

mergeFromArgv	(		$server,
		array	$into = []
	)

Searches the value parameter in an "argv" array and merges it recursively into specified array

Parameters

array	$server
array	$into

Returns

array

Definition at line 86 of file ComplexParameter.php.

    {
        $result = $into;
        if (isset($server['argv'])) {
            $value = $this->getFromArray($server['argv']);
            $result = array_replace_recursive($into, $value);
        }
        return $result;
    }

Field Documentation

DEFAULT_PATTERN

const DEFAULT_PATTERN = '/^\-\-%s=(.+)$/'

Default regex pattern for searching the parameter

Definition at line 19 of file ComplexParameter.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/Shell/ComplexParameter.php