InputOption.php

Ir para a documentação deste ficheiro.

<?php
 
namespace Symfony\Component\Console\Input;
 
/*
 * This file is part of the Symfony framework.
 *
 * (c) Fabien Potencier <fabien.potencier@symfony-project.com>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */
 
class InputOption
{
    const VALUE_NONE     = 1;
    const VALUE_REQUIRED = 2;
    const VALUE_OPTIONAL = 4;
    const VALUE_IS_ARRAY = 8;
 
    protected $name;
    protected $shortcut;
    protected $mode;
    protected $default;
    protected $description;
 
    public function __construct($name, $shortcut = null, $mode = null, $description = '', $default = null)
    {
        if ('--' === substr($name, 0, 2)) {
            $name = substr($name, 2);
        }
 
        if (empty($shortcut)) {
            $shortcut = null;
        }
 
        if (null !== $shortcut) {
            if ('-' === $shortcut[0]) {
                $shortcut = substr($shortcut, 1);
            }
        }
 
        if (null === $mode) {
            $mode = self::VALUE_NONE;
        } else if (!is_int($mode) || $mode > 15) {
            throw new \InvalidArgumentException(sprintf('Option mode "%s" is not valid.', $mode));
        }
 
        $this->name        = $name;
        $this->shortcut    = $shortcut;
        $this->mode        = $mode;
        $this->description = $description;
 
        if ($this->isArray() && !$this->acceptValue()) {
            throw new \InvalidArgumentException('Impossible to have an option mode VALUE_IS_ARRAY if the option does not accept a value.');
        }
 
        $this->setDefault($default);
    }
 
    public function getShortcut()
    {
        return $this->shortcut;
    }
 
    public function getName()
    {
        return $this->name;
    }
 
    public function acceptValue()
    {
        return $this->isValueRequired() || $this->isValueOptional();
    }
 
    public function isValueRequired()
    {
        return self::VALUE_REQUIRED === (self::VALUE_REQUIRED & $this->mode);
    }
 
    public function isValueOptional()
    {
        return self::VALUE_OPTIONAL === (self::VALUE_OPTIONAL & $this->mode);
    }
 
    public function isArray()
    {
        return self::VALUE_IS_ARRAY === (self::VALUE_IS_ARRAY & $this->mode);
    }
 
    public function setDefault($default = null)
    {
        if (self::VALUE_NONE === (self::VALUE_NONE & $this->mode) && null !== $default) {
            throw new \LogicException('Cannot set a default value when using Option::VALUE_NONE mode.');
        }
 
        if ($this->isArray()) {
            if (null === $default) {
                $default = array();
            } elseif (!is_array($default)) {
                throw new \LogicException('A default value for an array option must be an array.');
            }
        }
 
        $this->default = $this->acceptValue() ? $default : false;
    }
 
    public function getDefault()
    {
        return $this->default;
    }
 
    public function getDescription()
    {
        return $this->description;
    }
}