tykayn/caisse-bliss
1
0
Fork 0
mirror of https://forge.chapril.org/tykayn/caisse-bliss synced 2025-10-04 17:04:54 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
caisse-bliss/v1/.phpdoc/build/classes/Symfony-Component-Console-Input-StreamableInputInterface.html
Tykayn 501795a8fa up to sf 7
2025-02-09 16:45:35 +01:00

1920 lines
88 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Documentation</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/doctrinemigrations.html" class="">DoctrineMigrations</a>
</h4>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/hwi.html" class="">HWI</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/hwi-bundle.html" class="">Bundle</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/caissebliss.html" class="">CaisseBliss</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/caissebliss-controller.html" class="">Controller</a>
</li>
<li>
<a href="namespaces/caissebliss-entity.html" class="">Entity</a>
</li>
<li>
<a href="namespaces/caissebliss-form.html" class="">Form</a>
</li>
<li>
<a href="namespaces/caissebliss-repository.html" class="">Repository</a>
</li>
<li>
<a href="namespaces/caissebliss-security.html" class="">Security</a>
</li>
<li>
<a href="namespaces/caissebliss-service.html" class="">Service</a>
</li>
<li>
<a href="namespaces/caissebliss-tests.html" class="">Tests</a>
</li>
<li>
<a href="namespaces/caissebliss-traits.html" class="">Traits</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/tests.html" class="">Tests</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/tests-appbundle.html" class="">AppBundle</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/app.html" class="">App</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/app-controller.html" class="">Controller</a>
</li>
<li>
<a href="namespaces/app-datafixtures.html" class="">DataFixtures</a>
</li>
<li>
<a href="namespaces/app-entity.html" class="">Entity</a>
</li>
<li>
<a href="namespaces/app-form.html" class="">Form</a>
</li>
<li>
<a href="namespaces/app-repository.html" class="">Repository</a>
</li>
<li>
<a href="namespaces/app-security.html" class="">Security</a>
</li>
<li>
<a href="namespaces/app-traits.html" class="">Traits</a>
</li>
<li>
<a href="namespaces/app-tests.html" class="">Tests</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/containervvrt4pd.html" class="">ContainerVvRT4pd</a>
</h4>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/symfony.html" class="">Symfony</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/symfony-config.html" class="">Config</a>
</li>
<li>
<a href="namespaces/symfony-component.html" class="">Component</a>
</li>
<li>
<a href="namespaces/symfony-contracts.html" class="">Contracts</a>
</li>
<li>
<a href="namespaces/symfony-bundle.html" class="">Bundle</a>
</li>
<li>
<a href="namespaces/symfony-bridge.html" class="">Bridge</a>
</li>
<li>
<a href="namespaces/symfony-flex.html" class="">Flex</a>
</li>
<li>
<a href="namespaces/symfony-polyfill.html" class="">Polyfill</a>
</li>
<li>
<a href="namespaces/symfony-runtime.html" class="">Runtime</a>
</li>
<li>
<a href="namespaces/symfony-webpackencorebundle.html" class="">WebpackEncoreBundle</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/composer.html" class="">Composer</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/composer-autoload.html" class="">Autoload</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/doctrine.html" class="">Doctrine</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/doctrine-common.html" class="">Common</a>
</li>
<li>
<a href="namespaces/doctrine-dbal.html" class="">DBAL</a>
</li>
<li>
<a href="namespaces/doctrine-deprecations.html" class="">Deprecations</a>
</li>
<li>
<a href="namespaces/doctrine-bundle.html" class="">Bundle</a>
</li>
<li>
<a href="namespaces/doctrine-inflector.html" class="">Inflector</a>
</li>
<li>
<a href="namespaces/doctrine-instantiator.html" class="">Instantiator</a>
</li>
<li>
<a href="namespaces/doctrine-migrations.html" class="">Migrations</a>
</li>
<li>
<a href="namespaces/doctrine-orm.html" class="">ORM</a>
</li>
<li>
<a href="namespaces/doctrine-persistence.html" class="">Persistence</a>
</li>
<li>
<a href="namespaces/doctrine-sqlformatter.html" class="">SqlFormatter</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/easycorp.html" class="">EasyCorp</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/easycorp-bundle.html" class="">Bundle</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/egulias.html" class="">Egulias</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/egulias-emailvalidator.html" class="">EmailValidator</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/proxymanager.html" class="">ProxyManager</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/proxymanager-autoloader.html" class="">Autoloader</a>
</li>
<li>
<a href="namespaces/proxymanager-exception.html" class="">Exception</a>
</li>
<li>
<a href="namespaces/proxymanager-factory.html" class="">Factory</a>
</li>
<li>
<a href="namespaces/proxymanager-filelocator.html" class="">FileLocator</a>
</li>
<li>
<a href="namespaces/proxymanager-generator.html" class="">Generator</a>
</li>
<li>
<a href="namespaces/proxymanager-generatorstrategy.html" class="">GeneratorStrategy</a>
</li>
<li>
<a href="namespaces/proxymanager-inflector.html" class="">Inflector</a>
</li>
<li>
<a href="namespaces/proxymanager-proxy.html" class="">Proxy</a>
</li>
<li>
<a href="namespaces/proxymanager-proxygenerator.html" class="">ProxyGenerator</a>
</li>
<li>
<a href="namespaces/proxymanager-signature.html" class="">Signature</a>
</li>
<li>
<a href="namespaces/proxymanager-stub.html" class="">Stub</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/laminas.html" class="">Laminas</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/laminas-code.html" class="">Code</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/monolog.html" class="">Monolog</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/monolog-attribute.html" class="">Attribute</a>
</li>
<li>
<a href="namespaces/monolog-formatter.html" class="">Formatter</a>
</li>
<li>
<a href="namespaces/monolog-handler.html" class="">Handler</a>
</li>
<li>
<a href="namespaces/monolog-processor.html" class="">Processor</a>
</li>
<li>
<a href="namespaces/monolog-test.html" class="">Test</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/deepcopy.html" class="">DeepCopy</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/deepcopy-exception.html" class="">Exception</a>
</li>
<li>
<a href="namespaces/deepcopy-filter.html" class="">Filter</a>
</li>
<li>
<a href="namespaces/deepcopy-matcher.html" class="">Matcher</a>
</li>
<li>
<a href="namespaces/deepcopy-reflection.html" class="">Reflection</a>
</li>
<li>
<a href="namespaces/deepcopy-typefilter.html" class="">TypeFilter</a>
</li>
<li>
<a href="namespaces/deepcopy-typematcher.html" class="">TypeMatcher</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/phpparser.html" class="">PhpParser</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/phpparser-builder.html" class="">Builder</a>
</li>
<li>
<a href="namespaces/phpparser-comment.html" class="">Comment</a>
</li>
<li>
<a href="namespaces/phpparser-errorhandler.html" class="">ErrorHandler</a>
</li>
<li>
<a href="namespaces/phpparser-internal.html" class="">Internal</a>
</li>
<li>
<a href="namespaces/phpparser-lexer.html" class="">Lexer</a>
</li>
<li>
<a href="namespaces/phpparser-node.html" class="">Node</a>
</li>
<li>
<a href="namespaces/phpparser-nodevisitor.html" class="">NodeVisitor</a>
</li>
<li>
<a href="namespaces/phpparser-parser.html" class="">Parser</a>
</li>
<li>
<a href="namespaces/phpparser-prettyprinter.html" class="">PrettyPrinter</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/phario.html" class="">PharIo</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/phario-manifest.html" class="">Manifest</a>
</li>
<li>
<a href="namespaces/phario-version.html" class="">Version</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/phpdocumentor.html" class="">phpDocumentor</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/phpdocumentor-reflection.html" class="">Reflection</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/phpstan.html" class="">PHPStan</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/phpstan-phpdocparser.html" class="">PhpDocParser</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/phpunit.html" class="">PHPUnit</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/phpunit-framework.html" class="">Framework</a>
</li>
<li>
<a href="namespaces/phpunit-runner.html" class="">Runner</a>
</li>
<li>
<a href="namespaces/phpunit-textui.html" class="">TextUI</a>
</li>
<li>
<a href="namespaces/phpunit-util.html" class="">Util</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/psr.html" class="">Psr</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/psr-cache.html" class="">Cache</a>
</li>
<li>
<a href="namespaces/psr-container.html" class="">Container</a>
</li>
<li>
<a href="namespaces/psr-eventdispatcher.html" class="">EventDispatcher</a>
</li>
<li>
<a href="namespaces/psr-link.html" class="">Link</a>
</li>
<li>
<a href="namespaces/psr-log.html" class="">Log</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/sebastianbergmann.html" class="">SebastianBergmann</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/sebastianbergmann-codecoverage.html" class="">CodeCoverage</a>
</li>
<li>
<a href="namespaces/sebastianbergmann-fileiterator.html" class="">FileIterator</a>
</li>
<li>
<a href="namespaces/sebastianbergmann-invoker.html" class="">Invoker</a>
</li>
<li>
<a href="namespaces/sebastianbergmann-template.html" class="">Template</a>
</li>
<li>
<a href="namespaces/sebastianbergmann-timer.html" class="">Timer</a>
</li>
<li>
<a href="namespaces/sebastianbergmann-cliparser.html" class="">CliParser</a>
</li>
<li>
<a href="namespaces/sebastianbergmann-codeunit.html" class="">CodeUnit</a>
</li>
<li>
<a href="namespaces/sebastianbergmann-codeunitreverselookup.html" class="">CodeUnitReverseLookup</a>
</li>
<li>
<a href="namespaces/sebastianbergmann-comparator.html" class="">Comparator</a>
</li>
<li>
<a href="namespaces/sebastianbergmann-complexity.html" class="">Complexity</a>
</li>
<li>
<a href="namespaces/sebastianbergmann-diff.html" class="">Diff</a>
</li>
<li>
<a href="namespaces/sebastianbergmann-environment.html" class="">Environment</a>
</li>
<li>
<a href="namespaces/sebastianbergmann-exporter.html" class="">Exporter</a>
</li>
<li>
<a href="namespaces/sebastianbergmann-globalstate.html" class="">GlobalState</a>
</li>
<li>
<a href="namespaces/sebastianbergmann-linesofcode.html" class="">LinesOfCode</a>
</li>
<li>
<a href="namespaces/sebastianbergmann-objectenumerator.html" class="">ObjectEnumerator</a>
</li>
<li>
<a href="namespaces/sebastianbergmann-objectreflector.html" class="">ObjectReflector</a>
</li>
<li>
<a href="namespaces/sebastianbergmann-recursioncontext.html" class="">RecursionContext</a>
</li>
<li>
<a href="namespaces/sebastianbergmann-resourceoperations.html" class="">ResourceOperations</a>
</li>
<li>
<a href="namespaces/sebastianbergmann-type.html" class="">Type</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/theseer.html" class="">TheSeer</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/theseer-tokenizer.html" class="">Tokenizer</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/twig.html" class="">Twig</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/twig-extra.html" class="">Extra</a>
</li>
<li>
<a href="namespaces/twig-cache.html" class="">Cache</a>
</li>
<li>
<a href="namespaces/twig-error.html" class="">Error</a>
</li>
<li>
<a href="namespaces/twig-extension.html" class="">Extension</a>
</li>
<li>
<a href="namespaces/twig-loader.html" class="">Loader</a>
</li>
<li>
<a href="namespaces/twig-node.html" class="">Node</a>
</li>
<li>
<a href="namespaces/twig-nodevisitor.html" class="">NodeVisitor</a>
</li>
<li>
<a href="namespaces/twig-profiler.html" class="">Profiler</a>
</li>
<li>
<a href="namespaces/twig-runtimeloader.html" class="">RuntimeLoader</a>
</li>
<li>
<a href="namespaces/twig-sandbox.html" class="">Sandbox</a>
</li>
<li>
<a href="namespaces/twig-test.html" class="">Test</a>
</li>
<li>
<a href="namespaces/twig-tokenparser.html" class="">TokenParser</a>
</li>
<li>
<a href="namespaces/twig-util.html" class="">Util</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/webmozart.html" class="">Webmozart</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/webmozart-assert.html" class="">Assert</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Application.html" class="">Application</a>
</h4>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<section>
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/symfony.html">Symfony</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/symfony-component.html">Component</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/symfony-component-console.html">Console</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/symfony-component-console-input.html">Input</a></li>
</ul>
<article class="phpdocumentor-element -interface">
<h2 class="phpdocumentor-content__title">
StreamableInputInterface
<span class="phpdocumentor-element__extends">
extends
<a href="classes/Symfony-Component-Console-Input-InputInterface.html"><abbr title="\Symfony\Component\Console\Input\InputInterface">InputInterface</abbr></a> </span>
<div class="phpdocumentor-element__package">
in
<ul class="phpdocumentor-breadcrumbs">
<li><a href="packages/Application.html">Application</a></li>
</ul>
</div>
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/symfony/console/Input/StreamableInputInterface.php"><a href="files/vendor-symfony-console-input-streamableinputinterface.html"><abbr title="vendor/symfony/console/Input/StreamableInputInterface.php">StreamableInputInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">20</span>
</aside>
<p class="phpdocumentor-summary">StreamableInputInterface is the interface implemented by all input classes
that have an input stream.</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Symfony-Component-Console-Input-StreamableInputInterface.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">author</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Robin Chalas <a href="mailto:robin.chalas@gmail.com">robin.chalas@gmail.com</a></p>
</section>
</dd>
</dl>
<h3 id="toc">
Table of Contents
<a href="classes/Symfony-Component-Console-Input-StreamableInputInterface.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-methods">
Methods
<a href="classes/Symfony-Component-Console-Input-StreamableInputInterface.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_bind">bind()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Binds the current Input instance with the given arguments and options.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_getArgument">getArgument()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Returns the argument value for a given argument name.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_getArguments">getArguments()</a>
<span>
&nbsp;: array&lt;string|int, string|bool|int|float|array&lt;string|int, mixed&gt;|null&gt; </span>
</dt>
<dd>Returns all the given arguments merged with the default values.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_getFirstArgument">getFirstArgument()</a>
<span>
&nbsp;: string|null </span>
</dt>
<dd>Returns the first argument from the raw parameters (not parsed).</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_getOption">getOption()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Returns the option value for a given option name.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_getOptions">getOptions()</a>
<span>
&nbsp;: array&lt;string|int, string|bool|int|float|array&lt;string|int, mixed&gt;|null&gt; </span>
</dt>
<dd>Returns all the given options merged with the default values.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_getParameterOption">getParameterOption()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Returns the value of a raw option (not parsed).</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Symfony-Component-Console-Input-StreamableInputInterface.html#method_getStream">getStream()</a>
<span>
&nbsp;: resource|null </span>
</dt>
<dd>Returns the input stream.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_hasArgument">hasArgument()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Returns true if an InputArgument object exists by name or position.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_hasOption">hasOption()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Returns true if an InputOption object exists by name.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_hasParameterOption">hasParameterOption()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Returns true if the raw parameters (not parsed) contain a value.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_isInteractive">isInteractive()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Is this input means interactive?</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_setArgument">setArgument()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Sets an argument value by name.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_setInteractive">setInteractive()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Sets the input interactivity.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_setOption">setOption()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Sets an option value by name.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Symfony-Component-Console-Input-StreamableInputInterface.html#method_setStream">setStream()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Sets the input stream to read from when interacting with the user.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_validate">validate()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Validates the input.</dd>
</dl>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/Symfony-Component-Console-Input-StreamableInputInterface.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_bind">
bind()
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_bind" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/symfony/console/Input/InputInterface.php"><a href="files/vendor-symfony-console-input-inputinterface.html"><abbr title="vendor/symfony/console/Input/InputInterface.php">InputInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">63</span>
</aside>
<p class="phpdocumentor-summary">Binds the current Input instance with the given arguments and options.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">bind</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Symfony-Component-Console-Input-InputDefinition.html"><abbr title="\Symfony\Component\Console\Input\InputDefinition">InputDefinition</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$definition</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$definition</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Symfony-Component-Console-Input-InputDefinition.html"><abbr title="\Symfony\Component\Console\Input\InputDefinition">InputDefinition</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_bind#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Symfony-Component-Console-Exception-RuntimeException.html"><abbr title="\Symfony\Component\Console\Exception\RuntimeException">RuntimeException</abbr></a></span>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getArgument">
getArgument()
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_getArgument" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/symfony/console/Input/InputInterface.php"><a href="files/vendor-symfony-console-input-inputinterface.html"><abbr title="vendor/symfony/console/Input/InputInterface.php">InputInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">86</span>
</aside>
<p class="phpdocumentor-summary">Returns the argument value for a given argument name.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getArgument</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_getArgument#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Symfony-Component-Console-Exception-InvalidArgumentException.html"><abbr title="\Symfony\Component\Console\Exception\InvalidArgumentException">InvalidArgumentException</abbr></a></span>
<section class="phpdocumentor-description"><p>When argument given doesn't exist</p>
</section>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getArguments">
getArguments()
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_getArguments" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/symfony/console/Input/InputInterface.php"><a href="files/vendor-symfony-console-input-inputinterface.html"><abbr title="vendor/symfony/console/Input/InputInterface.php">InputInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">77</span>
</aside>
<p class="phpdocumentor-summary">Returns all the given arguments merged with the default values.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getArguments</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, string|bool|int|float|array&lt;string|int, mixed&gt;|null&gt;</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, string|bool|int|float|array&lt;string|int, mixed&gt;|null&gt;</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getFirstArgument">
getFirstArgument()
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_getFirstArgument" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/symfony/console/Input/InputInterface.php"><a href="files/vendor-symfony-console-input-inputinterface.html"><abbr title="vendor/symfony/console/Input/InputInterface.php">InputInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>
<p class="phpdocumentor-summary">Returns the first argument from the raw parameters (not parsed).</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getFirstArgument</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|null</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string|null</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getOption">
getOption()
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_getOption" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/symfony/console/Input/InputInterface.php"><a href="files/vendor-symfony-console-input-inputinterface.html"><abbr title="vendor/symfony/console/Input/InputInterface.php">InputInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">114</span>
</aside>
<p class="phpdocumentor-summary">Returns the option value for a given option name.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getOption</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_getOption#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Symfony-Component-Console-Exception-InvalidArgumentException.html"><abbr title="\Symfony\Component\Console\Exception\InvalidArgumentException">InvalidArgumentException</abbr></a></span>
<section class="phpdocumentor-description"><p>When option given doesn't exist</p>
</section>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getOptions">
getOptions()
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_getOptions" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/symfony/console/Input/InputInterface.php"><a href="files/vendor-symfony-console-input-inputinterface.html"><abbr title="vendor/symfony/console/Input/InputInterface.php">InputInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>
<p class="phpdocumentor-summary">Returns all the given options merged with the default values.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getOptions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, string|bool|int|float|array&lt;string|int, mixed&gt;|null&gt;</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, string|bool|int|float|array&lt;string|int, mixed&gt;|null&gt;</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getParameterOption">
getParameterOption()
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_getParameterOption" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/symfony/console/Input/InputInterface.php"><a href="files/vendor-symfony-console-input-inputinterface.html"><abbr title="vendor/symfony/console/Input/InputInterface.php">InputInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">56</span>
</aside>
<p class="phpdocumentor-summary">Returns the value of a raw option (not parsed).</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getParameterOption</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string|array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|bool|int|float|array&lt;string|int, mixed&gt;|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$default</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$onlyParams</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>This method is to be used to introspect the input parameters
before they have been validated. It must be used carefully.
Does not necessarily return the correct result for short options
when multiple flags are combined in the same option.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">string|array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The value(s) to look for in the raw parameters (can be an array)</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$default</span>
: <span class="phpdocumentor-signature__argument__return-type">string|bool|int|float|array&lt;string|int, mixed&gt;|null</span>
= <span class="phpdocumentor-signature__argument__default-value">false</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The default value to return if no result is found</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$onlyParams</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">false</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Only check real parameters, skip those following an end of options (--) signal</p>
</section>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getStream">
getStream()
<a href="classes/Symfony-Component-Console-Input-StreamableInputInterface.html#method_getStream" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/symfony/console/Input/StreamableInputInterface.php"><a href="files/vendor-symfony-console-input-streamableinputinterface.html"><abbr title="vendor/symfony/console/Input/StreamableInputInterface.php">StreamableInputInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">36</span>
</aside>
<p class="phpdocumentor-summary">Returns the input stream.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getStream</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">resource|null</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">resource|null</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_hasArgument">
hasArgument()
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_hasArgument" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/symfony/console/Input/InputInterface.php"><a href="files/vendor-symfony-console-input-inputinterface.html"><abbr title="vendor/symfony/console/Input/InputInterface.php">InputInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">98</span>
</aside>
<p class="phpdocumentor-summary">Returns true if an InputArgument object exists by name or position.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">hasArgument</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_hasOption">
hasOption()
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_hasOption" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/symfony/console/Input/InputInterface.php"><a href="files/vendor-symfony-console-input-inputinterface.html"><abbr title="vendor/symfony/console/Input/InputInterface.php">InputInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">126</span>
</aside>
<p class="phpdocumentor-summary">Returns true if an InputOption object exists by name.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">hasOption</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_hasParameterOption">
hasParameterOption()
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_hasParameterOption" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/symfony/console/Input/InputInterface.php"><a href="files/vendor-symfony-console-input-inputinterface.html"><abbr title="vendor/symfony/console/Input/InputInterface.php">InputInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<p class="phpdocumentor-summary">Returns true if the raw parameters (not parsed) contain a value.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">hasParameterOption</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string|array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$onlyParams</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>This method is to be used to introspect the input parameters
before they have been validated. It must be used carefully.
Does not necessarily return the correct result for short options
when multiple flags are combined in the same option.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">string|array&lt;string|int, mixed&gt;</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The values to look for in the raw parameters (can be an array)</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$onlyParams</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">false</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Only check real parameters, skip those following an end of options (--) signal</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_isInteractive">
isInteractive()
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_isInteractive" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/symfony/console/Input/InputInterface.php"><a href="files/vendor-symfony-console-input-inputinterface.html"><abbr title="vendor/symfony/console/Input/InputInterface.php">InputInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Is this input means interactive?</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">isInteractive</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setArgument">
setArgument()
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_setArgument" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/symfony/console/Input/InputInterface.php"><a href="files/vendor-symfony-console-input-inputinterface.html"><abbr title="vendor/symfony/console/Input/InputInterface.php">InputInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">93</span>
</aside>
<p class="phpdocumentor-summary">Sets an argument value by name.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setArgument</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_setArgument#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Symfony-Component-Console-Exception-InvalidArgumentException.html"><abbr title="\Symfony\Component\Console\Exception\InvalidArgumentException">InvalidArgumentException</abbr></a></span>
<section class="phpdocumentor-description"><p>When argument given doesn't exist</p>
</section>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setInteractive">
setInteractive()
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_setInteractive" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/symfony/console/Input/InputInterface.php"><a href="files/vendor-symfony-console-input-inputinterface.html"><abbr title="vendor/symfony/console/Input/InputInterface.php">InputInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">136</span>
</aside>
<p class="phpdocumentor-summary">Sets the input interactivity.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setInteractive</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$interactive</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$interactive</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setOption">
setOption()
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_setOption" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/symfony/console/Input/InputInterface.php"><a href="files/vendor-symfony-console-input-inputinterface.html"><abbr title="vendor/symfony/console/Input/InputInterface.php">InputInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">121</span>
</aside>
<p class="phpdocumentor-summary">Sets an option value by name.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setOption</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$name</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_setOption#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Symfony-Component-Console-Exception-InvalidArgumentException.html"><abbr title="\Symfony\Component\Console\Exception\InvalidArgumentException">InvalidArgumentException</abbr></a></span>
<section class="phpdocumentor-description"><p>When option given doesn't exist</p>
</section>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setStream">
setStream()
<a href="classes/Symfony-Component-Console-Input-StreamableInputInterface.html#method_setStream" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/symfony/console/Input/StreamableInputInterface.php"><a href="files/vendor-symfony-console-input-streamableinputinterface.html"><abbr title="vendor/symfony/console/Input/StreamableInputInterface.php">StreamableInputInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Sets the input stream to read from when interacting with the user.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setStream</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">resource&nbsp;</span><span class="phpdocumentor-signature__argument__name">$stream</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<section class="phpdocumentor-description"><p>This is mainly useful for testing purpose.</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$stream</span>
: <span class="phpdocumentor-signature__argument__return-type">resource</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The input stream</p>
</section>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_validate">
validate()
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_validate" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="vendor/symfony/console/Input/InputInterface.php"><a href="files/vendor-symfony-console-input-inputinterface.html"><abbr title="vendor/symfony/console/Input/InputInterface.php">InputInterface.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">70</span>
</aside>
<p class="phpdocumentor-summary">Validates the input.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">validate</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<div class="phpdocumentor-label-line">
</div>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_validate#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Symfony-Component-Console-Exception-RuntimeException.html"><abbr title="\Symfony\Component\Console\Exception\RuntimeException">RuntimeException</abbr></a></span>
<section class="phpdocumentor-description"><p>When not enough arguments are given</p>
</section>
</dd>
</dl>
</article>
</section>
<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/vendor/symfony/console/Input/StreamableInputInterface.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
</div>
<button data-exit-button class="phpdocumentor-modal__close">&times;</button>
</div>
</div>
<script type="text/javascript">
(function () {
function loadExternalCodeSnippet(el, url, line) {
Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
const language = 'php';
const code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState !== 4) {
return;
}
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
return;
}
if (xhr.status === 404) {
code.textContent = '✖ Error: File could not be found';
return;
}
if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
return;
}
code.textContent = '✖ Error: An unknown error occurred';
};
xhr.send(null);
});
}
const modalButtons = document.querySelectorAll("[data-modal]");
const openedAsLocalFile = window.location.protocol === 'file:';
if (modalButtons.length > 0 && openedAsLocalFile) {
console.warn(
'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
'browsers block XHR requests when a page is opened this way'
);
}
modalButtons.forEach(function (trigger) {
if (openedAsLocalFile) {
trigger.setAttribute("hidden", "hidden");
}
trigger.addEventListener("click", function (event) {
event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
if (!modal) {
console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
return;
}
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
})();
</script>
</article>
</section>
<section class="phpdocumentor-on-this-page__sidebar">
<section class="phpdocumentor-on-this-page__content">
<strong class="phpdocumentor-on-this-page__title">On this page</strong>
<ul class="phpdocumentor-list -clean">
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/Symfony-Component-Console-Input-StreamableInputInterface.html#toc-constants">Constants</a></li>
<li><a href="classes/Symfony-Component-Console-Input-StreamableInputInterface.html#toc-methods">Methods</a></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Methods</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_bind">bind()</a></li>
<li><a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_getArgument">getArgument()</a></li>
<li><a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_getArguments">getArguments()</a></li>
<li><a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_getFirstArgument">getFirstArgument()</a></li>
<li><a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_getOption">getOption()</a></li>
<li><a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_getOptions">getOptions()</a></li>
<li><a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_getParameterOption">getParameterOption()</a></li>
<li><a href="classes/Symfony-Component-Console-Input-StreamableInputInterface.html#method_getStream">getStream()</a></li>
<li><a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_hasArgument">hasArgument()</a></li>
<li><a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_hasOption">hasOption()</a></li>
<li><a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_hasParameterOption">hasParameterOption()</a></li>
<li><a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_isInteractive">isInteractive()</a></li>
<li><a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_setArgument">setArgument()</a></li>
<li><a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_setInteractive">setInteractive()</a></li>
<li><a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_setOption">setOption()</a></li>
<li><a href="classes/Symfony-Component-Console-Input-StreamableInputInterface.html#method_setStream">setStream()</a></li>
<li><a href="classes/Symfony-Component-Console-Input-InputInterface.html#method_validate">validate()</a></li>
</ul>
</li>
</ul>
</section>
</section>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="classes/Symfony-Component-Console-Input-StreamableInputInterface.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink