6108a212ad
This PR was submitted for the 3.4 branch but it was squashed and merged into the 3.3 branch instead (closes #25585).
Discussion
----------
Add type string to docblock for Process::setInput()
| Q | A
| ------------- | ---
| Branch? | 3.4
| Bug fix? | no
| New feature? | no
| BC breaks? | no
| Deprecations? | no
| Tests pass? | yes
| Fixed tickets | none
| License | MIT
| Doc PR | none
Add `string` as valid `$input` for `Process::setInput()`. Since `getInput()` will also return as string and the internal method `ProcessUtils::validateInput()` will accept a string, this should be a viable input type.
Commits
-------
e3de68f2 Add type string to docblock for Process::setInput()
93 lines
2.3 KiB
PHP
93 lines
2.3 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the Symfony package.
|
|
*
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Symfony\Component\Process;
|
|
|
|
use Symfony\Component\Process\Exception\RuntimeException;
|
|
|
|
/**
|
|
* Provides a way to continuously write to the input of a Process until the InputStream is closed.
|
|
*
|
|
* @author Nicolas Grekas <p@tchwork.com>
|
|
*/
|
|
class InputStream implements \IteratorAggregate
|
|
{
|
|
/** @var null|callable */
|
|
private $onEmpty = null;
|
|
private $input = array();
|
|
private $open = true;
|
|
|
|
/**
|
|
* Sets a callback that is called when the write buffer becomes empty.
|
|
*/
|
|
public function onEmpty(callable $onEmpty = null)
|
|
{
|
|
$this->onEmpty = $onEmpty;
|
|
}
|
|
|
|
/**
|
|
* Appends an input to the write buffer.
|
|
*
|
|
* @param resource|string|int|float|bool|\Traversable|null The input to append as scalar,
|
|
* stream resource or \Traversable
|
|
*/
|
|
public function write($input)
|
|
{
|
|
if (null === $input) {
|
|
return;
|
|
}
|
|
if ($this->isClosed()) {
|
|
throw new RuntimeException(sprintf('%s is closed', static::class));
|
|
}
|
|
$this->input[] = ProcessUtils::validateInput(__METHOD__, $input);
|
|
}
|
|
|
|
/**
|
|
* Closes the write buffer.
|
|
*/
|
|
public function close()
|
|
{
|
|
$this->open = false;
|
|
}
|
|
|
|
/**
|
|
* Tells whether the write buffer is closed or not.
|
|
*/
|
|
public function isClosed()
|
|
{
|
|
return !$this->open;
|
|
}
|
|
|
|
public function getIterator()
|
|
{
|
|
$this->open = true;
|
|
|
|
while ($this->open || $this->input) {
|
|
if (!$this->input) {
|
|
yield '';
|
|
continue;
|
|
}
|
|
$current = array_shift($this->input);
|
|
|
|
if ($current instanceof \Iterator) {
|
|
foreach ($current as $cur) {
|
|
yield $cur;
|
|
}
|
|
} else {
|
|
yield $current;
|
|
}
|
|
if (!$this->input && $this->open && null !== $onEmpty = $this->onEmpty) {
|
|
$this->write($onEmpty($this));
|
|
}
|
|
}
|
|
}
|
|
}
|