Symfony\Component\Process\InputStream Class Reference

Provides a way to continuously write to the input of a Process until the InputStream is closed. More...

Inheritance diagram for Symfony\Component\Process\InputStream:

Collaboration diagram for Symfony\Component\Process\InputStream:

Public Member Functions
	onEmpty (callable $onEmpty=null)
	Sets a callback that is called when the write buffer becomes empty. More...
	write ($input)
	Appends an input to the write buffer. More...
	close ()
	Closes the write buffer. More...
	isClosed ()
	Tells whether the write buffer is closed or not. More...
	getIterator ()

Private Attributes
	$onEmpty = null
	$input = array()
	$open = true

Detailed Description

Provides a way to continuously write to the input of a Process until the InputStream is closed.

Author

Nicolas Grekas p@tch.nosp@m.work.nosp@m..com

Definition at line 21 of file InputStream.php.

Member Function Documentation

close()

Symfony\Component\Process\InputStream::close

(

)

Closes the write buffer.

Definition at line 54 of file InputStream.php.

    {
        $this->open = false;
    }

getIterator()

Symfony\Component\Process\InputStream::getIterator

(

)

Definition at line 67 of file InputStream.php.

References Symfony\Component\Process\InputStream\$onEmpty, input, Symfony\Component\Process\InputStream\onEmpty(), and Symfony\Component\Process\InputStream\write().

    {
        $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));
            }
        }
    }

Here is the call graph for this function:

isClosed()

Symfony\Component\Process\InputStream::isClosed

(

)

Tells whether the write buffer is closed or not.

Definition at line 62 of file InputStream.php.

References Symfony\Component\Process\InputStream\$open.

Referenced by Symfony\Component\Process\InputStream\write().

    {
        return !$this->open;
    }

Here is the caller graph for this function:

onEmpty()

Symfony\Component\Process\InputStream::onEmpty

(

callable

$onEmpty = null

)

Sets a callback that is called when the write buffer becomes empty.

Definition at line 30 of file InputStream.php.

References Symfony\Component\Process\InputStream\$onEmpty.

Referenced by Symfony\Component\Process\InputStream\getIterator().

    {
        $this->onEmpty = $onEmpty;
    }

Here is the caller graph for this function:

write()

Symfony\Component\Process\InputStream::write

(

$input

)

Appends an input to the write buffer.

Parameters

resource|scalar|

Definition at line 40 of file InputStream.php.

References Symfony\Component\Process\InputStream\$input, input, Symfony\Component\Process\InputStream\isClosed(), and Symfony\Component\Process\ProcessUtils\validateInput().

Referenced by Symfony\Component\Process\InputStream\getIterator().

    {
        if (null === $input) {
            return;
        }
        if ($this->isClosed()) {
            throw new RuntimeException(sprintf('%s is closed', static::class));
        }
        $this->input[] = ProcessUtils::validateInput(__METHOD__, $input);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$input

Symfony\Component\Process\InputStream::$input = array()

private

Definition at line 24 of file InputStream.php.

Referenced by Symfony\Component\Process\InputStream\write().

$onEmpty

Symfony\Component\Process\InputStream::$onEmpty = null

private

Definition at line 23 of file InputStream.php.

Referenced by Symfony\Component\Process\InputStream\getIterator(), and Symfony\Component\Process\InputStream\onEmpty().

$open

Symfony\Component\Process\InputStream::$open = true

private

Definition at line 25 of file InputStream.php.

Referenced by Symfony\Component\Process\InputStream\isClosed().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/symfony/process/InputStream.php