Overview

Namespaces

  • Evenement
  • None
  • Peridot
    • Console
    • Core
    • Reporter
    • Runner
    • Scope
    • Test
  • Symfony
    • Component
      • Console
        • Command
        • Descriptor
        • Event
        • Exception
        • Formatter
        • Helper
        • Input
        • Logger
        • Output
        • Question
        • Style
        • Tester
        • Tests
          • Command
          • Descriptor
          • Fixtures
          • Formatter
          • Helper
          • Input
          • Logger
          • Output
          • Style
          • Tester

Classes

  • BarBucCommand
  • Evenement\EventEmitter
  • Foo1Command
  • Foo2Command
  • Foo3Command
  • Foo4Command
  • Foo5Command
  • Foo6Command
  • FoobarCommand
  • FooCommand
  • FooSubnamespaced1Command
  • FooSubnamespaced2Command
  • Peridot\Configuration
  • Peridot\Console\Application
  • Peridot\Console\CliOptionParser
  • Peridot\Console\Command
  • Peridot\Console\ConfigurationReader
  • Peridot\Console\Environment
  • Peridot\Console\InputDefinition
  • Peridot\Console\Version
  • Peridot\Core\AbstractTest
  • Peridot\Core\Scope
  • Peridot\Core\Suite
  • Peridot\Core\Test
  • Peridot\Core\TestResult
  • Peridot\Reporter\AbstractBaseReporter
  • Peridot\Reporter\AnonymousReporter
  • Peridot\Reporter\CompositeReporter
  • Peridot\Reporter\ReporterFactory
  • Peridot\Reporter\SpecReporter
  • Peridot\Runner\Context
  • Peridot\Runner\Runner
  • Peridot\Runner\SuiteLoader
  • Peridot\Scope\Scope
  • Peridot\Test\ItWasRun
  • Symfony\Component\Console\Application
  • Symfony\Component\Console\Command\Command
  • Symfony\Component\Console\Command\HelpCommand
  • Symfony\Component\Console\Command\ListCommand
  • Symfony\Component\Console\ConsoleEvents
  • Symfony\Component\Console\Event\ConsoleCommandEvent
  • Symfony\Component\Console\Event\ConsoleEvent
  • Symfony\Component\Console\Event\ConsoleExceptionEvent
  • Symfony\Component\Console\Event\ConsoleTerminateEvent
  • Symfony\Component\Console\Formatter\OutputFormatter
  • Symfony\Component\Console\Formatter\OutputFormatterStyle
  • Symfony\Component\Console\Formatter\OutputFormatterStyleStack
  • Symfony\Component\Console\Helper\DebugFormatterHelper
  • Symfony\Component\Console\Helper\DescriptorHelper
  • Symfony\Component\Console\Helper\DialogHelper
  • Symfony\Component\Console\Helper\FormatterHelper
  • Symfony\Component\Console\Helper\Helper
  • Symfony\Component\Console\Helper\HelperSet
  • Symfony\Component\Console\Helper\InputAwareHelper
  • Symfony\Component\Console\Helper\ProcessHelper
  • Symfony\Component\Console\Helper\ProgressBar
  • Symfony\Component\Console\Helper\ProgressHelper
  • Symfony\Component\Console\Helper\ProgressIndicator
  • Symfony\Component\Console\Helper\QuestionHelper
  • Symfony\Component\Console\Helper\SymfonyQuestionHelper
  • Symfony\Component\Console\Helper\Table
  • Symfony\Component\Console\Helper\TableCell
  • Symfony\Component\Console\Helper\TableHelper
  • Symfony\Component\Console\Helper\TableSeparator
  • Symfony\Component\Console\Helper\TableStyle
  • Symfony\Component\Console\Input\ArgvInput
  • Symfony\Component\Console\Input\ArrayInput
  • Symfony\Component\Console\Input\Input
  • Symfony\Component\Console\Input\InputArgument
  • Symfony\Component\Console\Input\InputDefinition
  • Symfony\Component\Console\Input\InputOption
  • Symfony\Component\Console\Input\StringInput
  • Symfony\Component\Console\Logger\ConsoleLogger
  • Symfony\Component\Console\Output\BufferedOutput
  • Symfony\Component\Console\Output\ConsoleOutput
  • Symfony\Component\Console\Output\NullOutput
  • Symfony\Component\Console\Output\Output
  • Symfony\Component\Console\Output\StreamOutput
  • Symfony\Component\Console\Question\ChoiceQuestion
  • Symfony\Component\Console\Question\ConfirmationQuestion
  • Symfony\Component\Console\Question\Question
  • Symfony\Component\Console\Shell
  • Symfony\Component\Console\Style\OutputStyle
  • Symfony\Component\Console\Style\SymfonyStyle
  • Symfony\Component\Console\Tester\ApplicationTester
  • Symfony\Component\Console\Tester\CommandTester
  • Symfony\Component\Console\Tests\ApplicationTest
  • Symfony\Component\Console\Tests\Command\CommandTest
  • Symfony\Component\Console\Tests\Command\HelpCommandTest
  • Symfony\Component\Console\Tests\Command\ListCommandTest
  • Symfony\Component\Console\Tests\CustomApplication
  • Symfony\Component\Console\Tests\CustomDefaultCommandApplication
  • Symfony\Component\Console\Tests\Descriptor\AbstractDescriptorTest
  • Symfony\Component\Console\Tests\Descriptor\JsonDescriptorTest
  • Symfony\Component\Console\Tests\Descriptor\MarkdownDescriptorTest
  • Symfony\Component\Console\Tests\Descriptor\ObjectsProvider
  • Symfony\Component\Console\Tests\Descriptor\TextDescriptorTest
  • Symfony\Component\Console\Tests\Descriptor\XmlDescriptorTest
  • Symfony\Component\Console\Tests\Fixtures\DescriptorApplication1
  • Symfony\Component\Console\Tests\Fixtures\DescriptorApplication2
  • Symfony\Component\Console\Tests\Fixtures\DescriptorCommand1
  • Symfony\Component\Console\Tests\Fixtures\DescriptorCommand2
  • Symfony\Component\Console\Tests\Fixtures\DummyOutput
  • Symfony\Component\Console\Tests\Formatter\OutputFormatterStyleStackTest
  • Symfony\Component\Console\Tests\Formatter\OutputFormatterStyleTest
  • Symfony\Component\Console\Tests\Formatter\OutputFormatterTest
  • Symfony\Component\Console\Tests\Formatter\TableCell
  • Symfony\Component\Console\Tests\Helper\FormatterHelperTest
  • Symfony\Component\Console\Tests\Helper\HelperSetTest
  • Symfony\Component\Console\Tests\Helper\HelperTest
  • Symfony\Component\Console\Tests\Helper\LegacyDialogHelperTest
  • Symfony\Component\Console\Tests\Helper\LegacyProgressHelperTest
  • Symfony\Component\Console\Tests\Helper\LegacyTableHelperTest
  • Symfony\Component\Console\Tests\Helper\ProcessHelperTest
  • Symfony\Component\Console\Tests\Helper\ProgressBarTest
  • Symfony\Component\Console\Tests\Helper\ProgressIndicatorTest
  • Symfony\Component\Console\Tests\Helper\QuestionHelperTest
  • Symfony\Component\Console\Tests\Helper\SymfonyQuestionHelperTest
  • Symfony\Component\Console\Tests\Helper\TableStyleTest
  • Symfony\Component\Console\Tests\Helper\TableTest
  • Symfony\Component\Console\Tests\Input\ArgvInputTest
  • Symfony\Component\Console\Tests\Input\ArrayInputTest
  • Symfony\Component\Console\Tests\Input\InputArgumentTest
  • Symfony\Component\Console\Tests\Input\InputDefinitionTest
  • Symfony\Component\Console\Tests\Input\InputOptionTest
  • Symfony\Component\Console\Tests\Input\InputTest
  • Symfony\Component\Console\Tests\Input\StringInputTest
  • Symfony\Component\Console\Tests\Logger\ConsoleLoggerTest
  • Symfony\Component\Console\Tests\Output\ConsoleOutputTest
  • Symfony\Component\Console\Tests\Output\NullOutputTest
  • Symfony\Component\Console\Tests\Output\OutputTest
  • Symfony\Component\Console\Tests\Output\StreamOutputTest
  • Symfony\Component\Console\Tests\Output\TestOutput
  • Symfony\Component\Console\Tests\Style\SymfonyStyleTest
  • Symfony\Component\Console\Tests\Style\SymfonyStyleWithForcedLineLength
  • Symfony\Component\Console\Tests\Tester\ApplicationTesterTest
  • Symfony\Component\Console\Tests\Tester\CommandTesterTest
  • TestCommand

Interfaces

  • Evenement\EventEmitterInterface
  • Peridot\Core\TestInterface
  • Peridot\Reporter\ReporterInterface
  • Peridot\Runner\RunnerInterface
  • Peridot\Runner\SuiteLoaderInterface
  • Symfony\Component\Console\Descriptor\DescriptorInterface
  • Symfony\Component\Console\Exception\ExceptionInterface
  • Symfony\Component\Console\Formatter\OutputFormatterInterface
  • Symfony\Component\Console\Formatter\OutputFormatterStyleInterface
  • Symfony\Component\Console\Helper\HelperInterface
  • Symfony\Component\Console\Input\InputAwareInterface
  • Symfony\Component\Console\Input\InputInterface
  • Symfony\Component\Console\Output\ConsoleOutputInterface
  • Symfony\Component\Console\Output\OutputInterface
  • Symfony\Component\Console\Style\StyleInterface

Traits

  • Evenement\EventEmitterTrait
  • Peridot\Core\HasEventEmitterTrait
  • Peridot\Scope\ScopeTrait

Exceptions

  • Peridot\AssertException
  • Symfony\Component\Console\Exception\CommandNotFoundException
  • Symfony\Component\Console\Exception\InvalidArgumentException
  • Symfony\Component\Console\Exception\InvalidOptionException
  • Symfony\Component\Console\Exception\LogicException
  • Symfony\Component\Console\Exception\RuntimeException

Functions

  • afterEach
  • beforeEach
  • context
  • describe
  • fcontext
  • fdescribe
  • fit
  • it
  • Symfony\Component\Console\Tests\Command\createClosure
  • xcontext
  • xdescribe
  • xit
  • 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: 
<?php
namespace Peridot\Console;

use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputDefinition as Definition;
use Symfony\Component\Console\Input\InputOption;

/**
 * The InputDefinition for Peridot defines what command line arguments
 * and options are available by default.
 *
 * @package Peridot\Console
 */
class InputDefinition extends Definition
{
    /**
     * Define input definition for peridot
     */
    public function __construct()
    {
        parent::__construct([]);
        $this->addArgument(new InputArgument('path', InputArgument::OPTIONAL, 'The path to a directory or file containing specs'));

        $this->addOption(new InputOption('focus', 'f', InputOption::VALUE_REQUIRED, 'Run tests matching <pattern>'));
        $this->addOption(new InputOption('skip', 's', InputOption::VALUE_REQUIRED, 'Skip tests matching <pattern>'));
        $this->addOption(new InputOption('grep', 'g', InputOption::VALUE_REQUIRED, 'Run tests with filenames matching <pattern> <comment>(default: *.spec.php)</comment>'));
        $this->addOption(new InputOption('no-colors', 'C', InputOption::VALUE_NONE, 'Disable output colors'));
        $this->addOption(new InputOption('--force-colors', null, InputOption::VALUE_NONE, 'Force output colors'));
        $this->addOption(new InputOption('reporter', 'r', InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'Select which reporter(s) to use', ['spec']));
        $this->addOption(new InputOption('bail', 'b', InputOption::VALUE_NONE, 'Stop on failure'));
        $this->addOption(new InputOption('configuration', 'c', InputOption::VALUE_REQUIRED, 'A php file containing peridot configuration'));
        $this->addOption(new InputOption('reporters', null, InputOption::VALUE_NONE, 'List all available reporters'));
        $this->addOption(new InputOption('--version', '-V', InputOption::VALUE_NONE, 'Display the Peridot version number'));
        $this->addOption(new InputOption('--help', '-h', InputOption::VALUE_NONE, 'Display this help message.'));
    }

    /**
     * Add an argument
     *
     * @param  string $name
     * @param  null          $mode
     * @param  string        $description
     * @param  null          $default
     * @return InputDefinition
     */
    public function argument($name, $mode = null, $description = '', $default = null)
    {
        $argument = new InputArgument($name, $mode, $description, $default);
        $this->addArgument($argument);

        return $this;
    }

    /**
     * Add an option
     *
     * @param  string $name
     * @param  null        $shortcut
     * @param  null        $mode
     * @param  string      $description
     * @param  null        $default
     * @return InputDefinition
     */
    public function option($name, $shortcut = null, $mode = null, $description = '', $default = null)
    {
        $option = new InputOption($name, $shortcut, $mode, $description, $default);
        $this->addOption($option);

        return $this;
    }
}
Peridot API documentation generated by ApiGen