W3cubDocs

/Symfony 4.1

PipesInterface

interface PipesInterface

PipesInterface manages descriptors and pipes for the use of proc_open.

Constants

CHUNK_SIZE

Methods

array getDescriptors()

Returns an array of descriptors for the use of proc_open.

string[] getFiles()

Returns an array of filenames indexed by their related stream in case these pipes use temporary files.

string[] readAndWrite(bool $blocking, bool $close = false)

Reads data in file handles and pipes.

bool areOpen()

Returns if the current state has open file handles or pipes.

bool haveReadSupport()

Returns if pipes are able to read output.

close()

Closes file handles and pipes.

Details

array getDescriptors()

Returns an array of descriptors for the use of proc_open.

Return Value

array

string[] getFiles()

Returns an array of filenames indexed by their related stream in case these pipes use temporary files.

Return Value

string[]

string[] readAndWrite(bool $blocking, bool $close = false)

Reads data in file handles and pipes.

Parameters

bool $blocking Whether to use blocking calls or not
bool $close Whether to close pipes if they've reached EOF

Return Value

string[] An array of read data indexed by their fd

bool areOpen()

Returns if the current state has open file handles or pipes.

Return Value

bool

bool haveReadSupport()

Returns if pipes are able to read output.

Return Value

bool

close()

Closes file handles and pipes.

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Process/Pipes/PipesInterface.html