Redbox\Cli\Arguments\Argument

Complexity

Total Complexity

7

Size/Duplication

Total Lines	50
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	usageInfo()	0	18	6
A	usageLine()	0	5	1

<?php
namespace Redbox\Cli\Arguments;
use Redbox\Cli\Object\ArgumentObject;

/**
 * The Argument class represents one single argument
 * set to the Manager. To make sure its universal we use
 * the ArgumentObject as an abstract to this class.
 *
 * @package Redbox\Cli\Arguments
 */
class Argument extends ArgumentObject
{
    const LINE_FMT = "\t%s\n\t\t%s\n";

    public $prefix;
    public $defaultValue;
    public $longPrefix;
    public $description;
    public $required;
    public $noValue;
    public $name;

    /**
     * Returns the usage information for this argument something like
     * -u user, --user user, (default: me_myself_i)
     *
     * @return string
     */
    public function usageInfo()
    {
        $arg = array();
        if ($this->prefix) {
            $arg[] = '-'.$this->prefix.' '.$this->name;
        }
        if ($this->longPrefix) {
            $arg[] = '--'.$this->longPrefix.' '.$this->name;
        }
        if ($this->defaultValue) {
            $arg[] = '(default: '.$this->defaultValue.')';
        }
        if (!$this->prefix && !$this->longPrefix) {
            $arg[] = $this->name;
        }
        $arg = implode(', ', $arg);
        return $arg;
    }

    /**
     * Returns a usage line something like.
     * -u user, --user user, (default: me_myself_i)
     *   Username
     *
     * @return string
     */
    public function usageLine()
    {
        $arg = $this->usageInfo();
        return sprintf(self::LINE_FMT, $arg, $this->description);
    }
}