A BoxedResult subclass used by ServerBoxedExecutor, providing simplified output file handling. More...

Inheritance diagram for Shellbox\Command\ServerBoxedResult:

Public Member Functions
	getFileNames ()
	Get the names of all files which were registered and were created by the command.

	getReceivedFileNames ()
	Get the names of all files which were received.

	setFileNames ( $fileNames, $sentFileNames)

Public Member Functions inherited from Shellbox\Command\BoxedResult
	addOutputFile ( $name, OutputFile $outputFile)
	Add an output file to the result.

	getFileContents ( $name)
	Get the contents of an output file as a string.

	wasReceived ( $name)
	Query whether an output file was received.

	wasGenerated ( $name)
	Query whether an output file was generated by the command.

	getUploadedFileNames ()
	Get the names of all files which were uploaded.

Public Member Functions inherited from Shellbox\Command\UnboxedResult
	exitCode ( $exitCode)
	Set the exit code.

	stdout ( $stdout)
	Set the stdout contents.

	stderr ( $stderr)
	Set the stderr contents.

	merge (UnboxedResult $other)
	Combine another result with this one.

	getExitCode ()
	Returns exit code of the process.

	getStdout ()
	Returns stdout of the process.

	getStderr ()
	Returns stderr of the process or null if the Command was configured to add stderr to stdout with includeStderr( true )

Detailed Description

A BoxedResult subclass used by ServerBoxedExecutor, providing simplified output file handling.

Member Function Documentation

Shellbox\Command\ServerBoxedResult::getFileNames ( )

Get the names of all files which were registered and were created by the command.

Shellbox\Command\ServerBoxedResult::getReceivedFileNames ( )

Get the names of all files which were received.

This is all generated files except for uploaded files.

Shellbox\Command\ServerBoxedResult::setFileNames	(		$fileNames,
			$sentFileNames )

Parameters

string[]	$fileNames
string[]	$sentFileNames

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