getopt.php

来自「PHP 知识管理系统（基于树结构的知识管理系统）, 英文原版的PHP源码。」· PHP 代码 · 共 912 行 · 第 1/3 页

     *
     * @param array $argv
     */
    public function addArguments($argv)
    {
        $this->_argv = array_merge($this->_argv, $argv);
        $this->_parsed = false;
    }

    /**
     * Define full set of command-line arguments.
     * These replace any currently defined.
     *
     * @param array $argv
     */
    public function setArguments($argv)
    {
        $this->_argv = $argv;
        $this->_parsed = false;
    }

    /**
     * Define multiple configuration options from an associative array.
     * These are not program options, but properties to configure
     * the behavior of Zend_Console_Getopt.
     *
     * @param array $getoptConfig
     */
    public function setOptions($getoptConfig)
    {
        if (isset($getoptConfig)) {
            foreach ($getoptConfig as $key => $value) {
                $this->_getoptConfig[$key] = $value;
            }
        }
    }

    /**
     * Define one configuration option as a key/value pair.
     * These are not program options, but properties to configure
     * the behavior of Zend_Console_Getopt.
     *
     * @param string $configKey
     * @param string $configValue
     */
    public function setOption($configKey, $configValue)
    {
        if ($configKey == null || $configKey == '') {
            return;
        }
        $this->_getoptConfig[$configKey] = $configValue;
    }

    /**
     * Define additional option rules.
     * These are appended to the rules defined when the constructor was called.
     *
     * @param array $rules
     * @throws Zend_Console_Getopt_Exception
     */
    public function addRules($rules)
    {
        $ruleMode = $this->_getoptConfig['ruleMode'];
        switch ($this->_getoptConfig['ruleMode']) {
            case self::MODE_ZEND:
                if (is_array($rules)) {
                    $this->addRulesModeZend($rules);
                    break;
                }
                $this->_getoptConfig['ruleMode'] = self::MODE_GNU;
                // intentional fallthrough
            case self::MODE_GNU:
                $this->addRulesModeGnu($rules);
                break;
            default:
                /**
                 * Call addRulesModeFoo() for ruleMode 'foo'.
                 * The developer should subclass Getopt and
                 * provide this method.
                 */
                $method = 'addRulesMode' . ucfirst($ruleMode);
                $this->$method($rules);
        }
        $this->_parsed = false;
    }

    /**
     * Return the current set of options and parameters seen as a string.
     *
     * @throws Zend_Console_Getopt_Exception
     * @return string
     */
    public function toString()
    {
        if (!$this->_parsed) {
            $this->parse();
        }
        $s = array();
        foreach ($this->_options as $flag => $value) {
            $s[] = $flag . '=' . ($value === true ? 'true' : $value);
        }
        return implode(' ', $s);
    }

    /**
     * Return the current set of options and parameters seen
     * as an array of canonical options and parameters.
     *
     * Clusters have been expanded, and option aliases
     * have been mapped to their primary option names.
     *
     * @throws Zend_Console_Getopt_Exception
     * @return array
     */
    public function toArray()
    {
        if (!$this->_parsed) {
            $this->parse();
        }
        $s = array();
        foreach ($this->_options as $flag => $value) {
            $s[] = $flag;
            if ($value !== true) {
                $s[] = $value;
            }
        }
        return $s;
    }

    /**
     * Return the current set of options and parameters seen in Json format.
     *
     * @throws Zend_Console_Getopt_Exception
     * @return string
     */
    public function toJson()
    {
        if (!$this->_parsed) {
            $this->parse();
        }
        $j = array();
        foreach ($this->_options as $flag => $value) {
            $j['options'][] = array(
                'option' => array(
                    'flag' => $flag,
                    'parameter' => $value
                )
            );
        }

        require_once 'Zend/Json.php';
        $json = Zend_Json::encode($j);

        return $json;
    }

    /**
     * Return the current set of options and parameters seen in XML format.
     *
     * @throws Zend_Console_Getopt_Exception
     * @return string
     */
    public function toXml()
    {
        if (!$this->_parsed) {
            $this->parse();
        }
        $doc = new DomDocument('1.0', 'utf-8');
        $optionsNode = $doc->createElement('options');
        $doc->appendChild($optionsNode);
        foreach ($this->_options as $flag => $value) {
            $optionNode = $doc->createElement('option');
            $optionNode->setAttribute('flag', utf8_encode($flag));
            if ($value !== true) {
                $optionNode->setAttribute('parameter', utf8_encode($value));
            }
            $optionsNode->appendChild($optionNode);
        }
        $xml = $doc->saveXML();
        return $xml;
    }

    /**
     * Return a list of options that have been seen in the current argv.
     *
     * @throws Zend_Console_Getopt_Exception
     * @return array
     */
    public function getOptions()
    {
        if (!$this->_parsed) {
            $this->parse();
        }
        return array_keys($this->_options);
    }

    /**
     * Return the state of the option seen on the command line of the
     * current application invocation.
     *
     * This function returns true, or the parameter value to the option, if any.
     * If the option was not given, this function returns false.
     *
     * @param string $key
     * @throws Zend_Console_Getopt_Exception
     * @return mixed
     */
    public function getOption($flag)
    {
        if (!$this->_parsed) {
            $this->parse();
        }
        if ($this->_getoptConfig[self::CONFIG_IGNORECASE]) {
            $flag = strtolower($flag);
        }
        if (isset($this->_ruleMap[$flag])) {
            $flag = $this->_ruleMap[$flag];
            if (isset($this->_options[$flag])) {
                return $this->_options[$flag];
            }
        }
        return null;
    }

    /**
     * Return the arguments from the command-line following all options found.
     *
     * @throws Zend_Console_Getopt_Exception
     * @return array
     */
    public function getRemainingArgs()
    {
        if (!$this->_parsed) {
            $this->parse();
        }
        return $this->_remainingArgs;
    }

    /**
     * Return a useful option reference, formatted for display in an
     * error message.
     *
     * Note that this usage information is provided in most Exceptions
     * generated by this class.
     *
     * @return string
     */
    public function getUsageMessage()
    {
        $usage = "Usage: {$this->_progname} [ options ]\n";
        $maxLen = 20;
        foreach ($this->_rules as $rule) {
            $flags = array();
            if (is_array($rule['alias'])) {
                foreach ($rule['alias'] as $flag) {
                    $flags[] = (strlen($flag) == 1 ? '-' : '--') . $flag;
                }
            }
            $linepart['name'] = implode('|', $flags);
            if (isset($rule['param']) && $rule['param'] != 'none') {
                $linepart['name'] .= ' ';
                switch ($rule['param']) {
                    case 'optional':
                        $linepart['name'] .= "[ <{$rule['paramType']}> ]";
                        break;
                    case 'required':
                        $linepart['name'] .= "<{$rule['paramType']}>";
                        break;
                    default:
                        throw new Zend_Console_Getopt_Exception(
                            "Unknown parameter type: \"{$rule['param']}\".");
                }
            }
            if (strlen($linepart['name']) > $maxLen) {
                $maxLen = strlen($linepart['name']);
            }
            $linepart['help'] = '';
            if (isset($rule['help'])) {
                $linepart['help'] .= $rule['help'];
            }
            $lines[] = $linepart;
        }
        foreach ($lines as $linepart) {
            $usage .= sprintf("%s %s\n",
            str_pad($linepart['name'], $maxLen),
            $linepart['help']);
        }
        return $usage;
    }

    /**
     * Define aliases for options.
     *
     * The parameter $aliasMap is an associative array
     * mapping option name (short or long) to an alias.
     *
     * @param array $aliasMap
     * @throws Zend_Console_Getopt_Exception
     */
    public function setAliases($aliasMap)
    {
        foreach ($aliasMap as $flag => $alias)
        {
            if ($this->_getoptConfig[self::CONFIG_IGNORECASE]) {