ProcessPipes

class ProcessPipes

ProcessPipes manages descriptors and pipes for the use of proc_open.

Properties

array

$pipes

Methods

	__construct($useFiles, $ttyMode)
	__destruct()
	unblock() Sets non-blocking mode on pipes.
	close() Closes file handles and pipes.
	closeUnixPipes() Closes Unix pipes.
array	getDescriptors() Returns an array of descriptors for the use of proc_open.
array	read(Boolean $blocking) Reads data in file handles and pipes.
array	readAndCloseHandles(Boolean $blocking) Reads data in file handles and pipes, closes them if EOF is reached.
Boolean	hasOpenHandles() Returns if the current state has open file handles or pipes.
	write(Boolean $blocking, string\|null $stdin) Writes stdin data.

Details

__construct($useFiles, $ttyMode)

Parameters

	$useFiles
	$ttyMode

__destruct()

unblock()

Sets non-blocking mode on pipes.

close()

Closes file handles and pipes.

closeUnixPipes()

Closes Unix pipes.

Nothing happens in case file handles are used.

array getDescriptors()

Returns an array of descriptors for the use of proc_open.

Return Value

array

array read(Boolean $blocking)

Reads data in file handles and pipes.

Parameters

Boolean

$blocking

Whether to use blocking calls or not.

Return Value

array

An array of read data indexed by their fd.

array readAndCloseHandles(Boolean $blocking)

Reads data in file handles and pipes, closes them if EOF is reached.

Parameters

Boolean

$blocking

Whether to use blocking calls or not.

Return Value

array

An array of read data indexed by their fd.

Boolean hasOpenHandles()

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

Return Value

Boolean

write(Boolean $blocking, string|null $stdin)

Writes stdin data.

Parameters

Boolean	$blocking	Whether to use blocking calls or not.
string\|null	$stdin	The data to write.

Links:

http://api.symfony.com/master/Symfony/Component/Process/ProcessPipes.html

doc_Symfony

2016-10-28 06:27:10

Comments