class InputStream
Provides a way to continuously write to the input of a Process until the InputStream is closed.
@author Nicolas Grekas <p@tchwork.com>
@implements \IteratorAggregate<int, string>
Hierarchy
- class \Symfony\Component\Process\InputStream implements \Symfony\Component\Process\IteratorAggregate
Expanded class hierarchy of InputStream
File
-
vendor/
symfony/ process/ InputStream.php, line 23
Namespace
Symfony\Component\ProcessView source
class InputStream implements \IteratorAggregate {
private ?\Closure $onEmpty = null;
private array $input = [];
private bool $open = true;
/**
* Sets a callback that is called when the write buffer becomes empty.
*/
public function onEmpty(?callable $onEmpty = null) : void {
$this->onEmpty = null !== $onEmpty ? $onEmpty(...) : null;
}
/**
* Appends an input to the write buffer.
*
* @param resource|string|int|float|bool|\Traversable|null $input The input to append as scalar,
* stream resource or \Traversable
*/
public function write(mixed $input) : void {
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() : void {
$this->open = false;
}
/**
* Tells whether the write buffer is closed or not.
*/
public function isClosed() : bool {
return !$this->open;
}
public function getIterator() : \Traversable {
$this->open = true;
while ($this->open || $this->input) {
if (!$this->input) {
(yield '');
continue;
}
$current = array_shift($this->input);
if ($current instanceof \Iterator) {
yield from $current;
}
else {
(yield $current);
}
if (!$this->input && $this->open && null !== ($onEmpty = $this->onEmpty)) {
$this->write($onEmpty($this));
}
}
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
InputStream::$input | private | property | |
InputStream::$onEmpty | private | property | |
InputStream::$open | private | property | |
InputStream::close | public | function | Closes the write buffer. |
InputStream::getIterator | public | function | |
InputStream::isClosed | public | function | Tells whether the write buffer is closed or not. |
InputStream::onEmpty | public | function | Sets a callback that is called when the write buffer becomes empty. |
InputStream::write | public | function | Appends an input to the write buffer. |