Overview

Namespaces

  • Webmozart
    • Console
      • Adapter
      • Api
        • Application
        • Args
          • Format
        • Command
        • Config
        • Event
        • Formatter
        • IO
        • Resolver
      • Args
      • Config
      • Formatter
      • Handler
        • Help
      • IO
        • InputStream
        • OutputStream
      • Process
      • Resolver
      • UI
        • Alignment
        • Component
        • Help
        • Layout
        • Style
      • Util

Classes

  • Webmozart\Console\Adapter\ApplicationAdapter
  • Webmozart\Console\Adapter\ArgsFormatInputDefinition
  • Webmozart\Console\Adapter\ArgsInput
  • Webmozart\Console\Adapter\CommandAdapter
  • Webmozart\Console\Adapter\FormatterAdapter
  • Webmozart\Console\Adapter\IOOutput
  • Webmozart\Console\Adapter\StyleConverter
  • Webmozart\Console\Api\Args\Args
  • Webmozart\Console\Api\Args\Format\AbstractOption
  • Webmozart\Console\Api\Args\Format\ArgsFormat
  • Webmozart\Console\Api\Args\Format\ArgsFormatBuilder
  • Webmozart\Console\Api\Args\Format\Argument
  • Webmozart\Console\Api\Args\Format\CommandName
  • Webmozart\Console\Api\Args\Format\CommandOption
  • Webmozart\Console\Api\Args\Format\Option
  • Webmozart\Console\Api\Command\Command
  • Webmozart\Console\Api\Command\CommandCollection
  • Webmozart\Console\Api\Config\ApplicationConfig
  • Webmozart\Console\Api\Config\CommandConfig
  • Webmozart\Console\Api\Config\Config
  • Webmozart\Console\Api\Config\OptionCommandConfig
  • Webmozart\Console\Api\Config\SubCommandConfig
  • Webmozart\Console\Api\Event\ConfigEvent
  • Webmozart\Console\Api\Event\ConsoleEvents
  • Webmozart\Console\Api\Event\PreHandleEvent
  • Webmozart\Console\Api\Event\PreResolveEvent
  • Webmozart\Console\Api\Formatter\Style
  • Webmozart\Console\Api\Formatter\StyleSet
  • Webmozart\Console\Api\IO\Input
  • Webmozart\Console\Api\IO\IO
  • Webmozart\Console\Api\IO\Output
  • Webmozart\Console\Api\Resolver\ResolvedCommand
  • Webmozart\Console\Args\ArgvArgs
  • Webmozart\Console\Args\DefaultArgsParser
  • Webmozart\Console\Args\StringArgs
  • Webmozart\Console\Args\TokenParser
  • Webmozart\Console\Config\DefaultApplicationConfig
  • Webmozart\Console\ConsoleApplication
  • Webmozart\Console\Formatter\AnsiFormatter
  • Webmozart\Console\Formatter\DefaultStyleSet
  • Webmozart\Console\Formatter\NullFormatter
  • Webmozart\Console\Formatter\PlainFormatter
  • Webmozart\Console\Handler\CallbackHandler
  • Webmozart\Console\Handler\DelegatingHandler
  • Webmozart\Console\Handler\Help\HelpAsciiDocHandler
  • Webmozart\Console\Handler\Help\HelpHandler
  • Webmozart\Console\Handler\Help\HelpJsonHandler
  • Webmozart\Console\Handler\Help\HelpManHandler
  • Webmozart\Console\Handler\Help\HelpTextHandler
  • Webmozart\Console\Handler\Help\HelpXmlHandler
  • Webmozart\Console\Handler\NullHandler
  • Webmozart\Console\IO\BufferedIO
  • Webmozart\Console\IO\ConsoleIO
  • Webmozart\Console\IO\InputStream\NullInputStream
  • Webmozart\Console\IO\InputStream\StandardInputStream
  • Webmozart\Console\IO\InputStream\StreamInputStream
  • Webmozart\Console\IO\InputStream\StringInputStream
  • Webmozart\Console\IO\OutputStream\BufferedOutputStream
  • Webmozart\Console\IO\OutputStream\ErrorOutputStream
  • Webmozart\Console\IO\OutputStream\NullOutputStream
  • Webmozart\Console\IO\OutputStream\StandardOutputStream
  • Webmozart\Console\IO\OutputStream\StreamOutputStream
  • Webmozart\Console\Process\ProcessLauncher
  • Webmozart\Console\Resolver\DefaultResolver
  • Webmozart\Console\Resolver\ResolveResult
  • Webmozart\Console\UI\Alignment\LabelAlignment
  • Webmozart\Console\UI\Component\BorderUtil
  • Webmozart\Console\UI\Component\CellWrapper
  • Webmozart\Console\UI\Component\EmptyLine
  • Webmozart\Console\UI\Component\ExceptionTrace
  • Webmozart\Console\UI\Component\Grid
  • Webmozart\Console\UI\Component\LabeledParagraph
  • Webmozart\Console\UI\Component\NameVersion
  • Webmozart\Console\UI\Component\Paragraph
  • Webmozart\Console\UI\Component\Table
  • Webmozart\Console\UI\Help\AbstractHelp
  • Webmozart\Console\UI\Help\ApplicationHelp
  • Webmozart\Console\UI\Help\CommandHelp
  • Webmozart\Console\UI\Layout\BlockLayout
  • Webmozart\Console\UI\Rectangle
  • Webmozart\Console\UI\Style\Alignment
  • Webmozart\Console\UI\Style\BorderStyle
  • Webmozart\Console\UI\Style\GridStyle
  • Webmozart\Console\UI\Style\TableStyle
  • Webmozart\Console\Util\ProcessTitle
  • Webmozart\Console\Util\SimilarCommandName
  • Webmozart\Console\Util\StringUtil

Interfaces

  • Webmozart\Console\Api\Application\Application
  • Webmozart\Console\Api\Args\ArgsParser
  • Webmozart\Console\Api\Args\RawArgs
  • Webmozart\Console\Api\Formatter\Formatter
  • Webmozart\Console\Api\IO\InputStream
  • Webmozart\Console\Api\IO\OutputStream
  • Webmozart\Console\Api\Resolver\CommandResolver
  • Webmozart\Console\UI\Component

Exceptions

  • Webmozart\Console\Api\Args\CannotAddArgumentException
  • Webmozart\Console\Api\Args\CannotAddOptionException
  • Webmozart\Console\Api\Args\CannotParseArgsException
  • Webmozart\Console\Api\Args\Format\InvalidValueException
  • Webmozart\Console\Api\Args\NoSuchArgumentException
  • Webmozart\Console\Api\Args\NoSuchOptionException
  • Webmozart\Console\Api\Command\CannotAddCommandException
  • Webmozart\Console\Api\Command\NoSuchCommandException
  • Webmozart\Console\Api\IO\IOException
  • Webmozart\Console\Api\Resolver\CannotResolveCommandException
  • 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: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 
<?php

/*
 * This file is part of the webmozart/console package.
 *
 * (c) Bernhard Schussek <bschussek@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Webmozart\Console\Adapter;

use Symfony\Component\Console\Application;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\HelperSet;
use Symfony\Component\Console\Input\InputDefinition;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Webmozart\Assert\Assert;

/**
 * Adapts a `Command` instance of this package to Symfony's {@link Command} API.
 *
 * @since  1.0
 *
 * @author Bernhard Schussek <bschussek@gmail.com>
 */
class CommandAdapter extends Command
{
    /**
     * @var \Webmozart\Console\Api\Command\Command
     */
    private $adaptedCommand;

    /**
     * Creates the adapter.
     *
     * @param \Webmozart\Console\Api\Command\Command $adaptedCommand The adapted command.
     * @param Application                            $application    The application.
     */
    public function __construct(\Webmozart\Console\Api\Command\Command $adaptedCommand, Application $application)
    {
        parent::setName($adaptedCommand->getName());

        parent::__construct();

        $this->adaptedCommand = $adaptedCommand;

        $config = $adaptedCommand->getConfig();

        parent::setDefinition(new ArgsFormatInputDefinition($this->adaptedCommand->getArgsFormat()));
        parent::setApplication($application);
        parent::setDescription($config->getDescription());
        parent::setHelp($config->getHelp());
        parent::setAliases($adaptedCommand->getAliases());

        if ($helperSet = $config->getHelperSet()) {
            parent::setHelperSet($helperSet);
        }
    }

    /**
     * Returns the adapted command.
     *
     * @return Command The adapted command.
     */
    public function getAdaptedCommand()
    {
        return $this->adaptedCommand;
    }

    /**
     * Does nothing.
     *
     * @param Application $application The application.
     *
     * @return static The current instance.
     */
    public function setApplication(Application $application = null)
    {
        return $this;
    }

    /**
     * Does nothing.
     *
     * @param HelperSet $helperSet The helper set.
     *
     * @return static The current instance.
     */
    public function setHelperSet(HelperSet $helperSet)
    {
        return $this;
    }

    /**
     * Does nothing.
     *
     * @param callable $code The code.
     *
     * @return static The current instance.
     */
    public function setCode($code)
    {
        return $this;
    }

    /**
     * Does nothing.
     *
     * @param array|InputDefinition $definition The definition
     *
     * @return static The current instance.
     */
    public function setDefinition($definition)
    {
        return $this;
    }

    /**
     * Does nothing.
     *
     * @param string $name The name.
     *
     * @return static The current instance.
     */
    public function setName($name)
    {
        return $this;
    }

    /**
     * Does nothing.
     *
     * @param string $title The process title.
     *
     * @return static The current instance.
     */
    public function setProcessTitle($title)
    {
        return $this;
    }

    /**
     * Does nothing.
     *
     * @param string $description The description.
     *
     * @return static The current instance.
     */
    public function setDescription($description)
    {
        return $this;
    }

    /**
     * Does nothing.
     *
     * @param string $help The help.
     *
     * @return static The current instance.
     */
    public function setHelp($help)
    {
        return $this;
    }

    /**
     * Does nothing.
     *
     * @param string[] $aliases The aliases.
     *
     * @return static The current instance.
     */
    public function setAliases($aliases)
    {
        return $this;
    }

    /**
     * Does nothing.
     *
     * @param bool $mergeArgs
     *
     * @return static The current instance.
     */
    public function mergeApplicationDefinition($mergeArgs = true)
    {
        return $this;
    }

    /**
     * Does nothing.
     *
     * @param string $name
     * @param null   $mode
     * @param string $description
     * @param null   $default
     *
     * @return static The current instance.
     */
    public function addArgument($name, $mode = null, $description = '', $default = null)
    {
        return $this;
    }

    /**
     * Does nothing.
     *
     * @param string $name
     * @param null   $shortcut
     * @param null   $mode
     * @param string $description
     * @param null   $default
     *
     * @return static The current instance.
     */
    public function addOption($name, $shortcut = null, $mode = null, $description = '', $default = null)
    {
        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function isEnabled()
    {
        return $this->adaptedCommand->getConfig()->isEnabled();
    }

    /**
     * Executes the command.
     *
     * @param InputInterface  $input  The console input.
     * @param OutputInterface $output The console output.
     *
     * @return int The exit status.
     */
    public function run(InputInterface $input, OutputInterface $output)
    {
        /* @var ArgsInput $input */
        /* @var IOOutput $output */
        Assert::isInstanceOf($input, 'Webmozart\Console\Adapter\ArgsInput');
        Assert::isInstanceOf($output, 'Webmozart\Console\Adapter\IOOutput');

        return $this->adaptedCommand->handle($input->getArgs(), $output->getIO());
    }
}
Webmozart Console API API documentation generated by ApiGen