ComplexParameter.php 2.09 KB
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */

namespace Magento\Framework\Shell;

/**
 * A parser for complex parameters in command-line arguments
 *
 * Transforms parameter formatted as a URL query string into an array
 */
class ComplexParameter
{
    /**
     * Default regex pattern for searching the parameter
     */
    const DEFAULT_PATTERN = '/^\-\-%s=(.+)$/';

    /**
     * Argument name
     *
     * @var string
     */
    private $name;

    /**
     * Regex pattern for searching the parameter among arguments
     *
     * @var string
     */
    private $pcre;

    /**
     * Constructor
     *
     * @param string $name
     * @param string $pattern
     */
    public function __construct($name, $pattern = self::DEFAULT_PATTERN)
    {
        $this->name = $name;
        $this->pcre = sprintf($pattern, preg_quote($name, '/'));
    }

    /**
     * Searches and parses the value from an array of arguments
     *
     * @param string[] $input
     * @return array
     */
    public function getFromArray($input)
    {
        foreach ($input as $row) {
            $result = $this->getFromString($row);
            if ($result) {
                return $result;
            }
        }
        return [];
    }

    /**
     * Parses the value from a specified argument string
     *
     * @param string $string
     * @return array
     */
    public function getFromString($string)
    {
        if (preg_match($this->pcre, $string, $matches)) {
            parse_str($matches[1], $result);
            return $result;
        }
        return [];
    }

    /**
     * Searches the value parameter in an "argv" array and merges it recursively into specified array
     *
     * @param array $server
     * @param array $into
     * @return array
     */
    public function mergeFromArgv($server, array $into = [])
    {
        $result = $into;
        if (isset($server['argv'])) {
            $value = $this->getFromArray($server['argv']);
            $result = array_replace_recursive($into, $value);
        }
        return $result;
    }
}