Overview

Namespaces

  • Net
    • Bazzline
      • Component
        • Cli
          • Arguments

Classes

  • Net\Bazzline\Component\Cli\Arguments\Arguments
  • Net\Bazzline\Component\Cli\Arguments\Parser
  • Overview
  • Namespace
  • Class
  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:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 
<?php
/**
 * @author: stev leibelt <artodeto@bazzline.net>
 * @since: 2015-04-16
 */

namespace Net\Bazzline\Component\Cli\Arguments;

class Arguments
{
    /** @var array */
    private $arguments;

    /** @var array */
    private $flags;

    /** @var array */
    private $lists;

    /** @var Parser */
    private $parser;

    /** @var array */
    private $values;

    /**
     * @param null|array $argv
     * @param boolean $removeFirstArgument
     */
    public function __construct($argv = null, $removeFirstArgument = true)
    {
        $this->parser = new Parser();

        if (is_array($argv)) {
            $this->parseArguments($argv, $removeFirstArgument);
        } else {
            $this->setArgumentsFromParser($this->parser);
        }
    }

    /**
     * @return array
     */
    public function getArguments()
    {
        return $this->arguments;
    }

    /**
     * @return array
     */
    public function getFlags()
    {
        return $this->flags;
    }

    /**
     * @param string $name
     * @return null|array
     */
    public function getList($name)
    {
        return (isset($this->lists[$name]))
            ? $this->lists[$name]
            : null;
    }

    /**
     * @return int
     */
    public function getNumberOfArguments()
    {
        return (count($this->arguments));
    }

    /**
     * @return int
     */
    public function getNumberOfFlags()
    {
        return (count($this->flags));
    }

    /**
     * @return int
     */
    public function getNumberOfLists()
    {
        return (count($this->lists));
    }

    /**
     * @return int
     */
    public function getNumberOfValues()
    {
        return (count($this->values));
    }

    /**
     * @return array
     */
    public function getLists()
    {
        return $this->lists;
    }

    /**
     * @return array
     */
    public function getValues()
    {
        return $this->values;
    }

    /**
     * @return bool
     */
    public function hasArguments()
    {
        return (!empty($this->arguments));
    }

    /**
     * @param string $name
     * @return bool
     */
    public function hasFlag($name)
    {
        return (in_array($name, $this->flags));
    }

    /**
     * @return bool
     */
    public function hasFlags()
    {
        return (!empty($this->flags));
    }

    /**
     * @param string $name
     * @return bool
     */
    public function hasList($name)
    {
        return (isset($this->lists[$name]));
    }

    /**
     * @return bool
     */
    public function hasLists()
    {
        return (!empty($this->lists));
    }

    /**
     * @return bool
     */
    public function hasValues()
    {
        return (!empty($this->values));
    }

    /**
     * @param array $argv
     * @param boolean $removeFirstArgument
     * @return $this
     */
    public function parseArguments(array $argv, $removeFirstArgument = true)
    {
        if ($removeFirstArgument) {
            array_shift($argv);
        }

        $this->arguments = $argv;
        $this->parser->parse($this->arguments);
        $this->setArgumentsFromParser($this->parser);

        return $this;
    }

    /**
     * @return array
     */
    public function convertToArray()
    {
        return $this->getArguments();
    }

    /**
     * @return string
     */
    public function convertToString()
    {
        return implode(' ', $this->convertToArray());
    }

    /**
     * @return string
     */
    public function __toString()
    {
        return $this->convertToString();
    }

    /**
     * @param Parser $parser
     */
    private function setArgumentsFromParser(Parser $parser)
    {
        $this->flags    = $parser->getFlags();
        $this->lists    = $parser->getLists();
        $this->values   = $parser->getValues();
    }
}
PHP Cli Argument Component by Bazzline API documentation generated by ApiGen