Shellbox
Library and server for containerized shell execution
Loading...
Searching...
No Matches
Shellbox\Command\ServerBoxedExecutor Class Reference

A BoxedExecutor for internal use by the Server. More...

+ Inheritance diagram for Shellbox\Command\ServerBoxedExecutor:

Public Member Functions

 executeValid (BoxedCommand $command)
 Execute a BoxedCommand that has already been validated.
 
- Public Member Functions inherited from Shellbox\Command\LocalBoxedExecutor
 __construct (UnboxedExecutor $unboxedExecutor, TempDirManager $tempDirManager)
 
 setLogger (LoggerInterface $logger)
 Set the logger.
 
- Public Member Functions inherited from Shellbox\Command\BoxedExecutor
 execute (BoxedCommand $command)
 Execute a boxed command.
 
 createCommand ()
 Create an empty command linked to this executor.
 
 setValidationConfig ( $config)
 Set validation configuration.
 

Additional Inherited Members

- Protected Member Functions inherited from Shellbox\Command\LocalBoxedExecutor
 createInputFiles (BoxedCommand $command)
 Copy input files from the BoxedCommand to the working directory, ready for command execution.
 
 prepareOutputDirectories (BoxedCommand $command)
 Ensure that any subdirectories named in registered output files are created, so that the command can write the files there.
 
 applyBoxConfig (BoxedCommand $command)
 Modify the configuration of the command as required by the BoxedCommand abstraction, returning a cloned BoxedCommand.
 
 findOutputFiles (BoxedCommand $command)
 This is called after the command has run.
 
 collectOutputFiles (BoxedCommand $command, BoxedResult $result)
 This is called after the command has run.
 
- Protected Member Functions inherited from Shellbox\Command\BoxedExecutor
 assertIsValid (BoxedCommand $command)
 Validate the command.
 
- Protected Attributes inherited from Shellbox\Command\LocalBoxedExecutor
 $unboxedExecutor
 
 $tempDirManager
 
 $logger
 
- Protected Attributes inherited from Shellbox\Command\BoxedExecutor
 $validator
 

Detailed Description

A BoxedExecutor for internal use by the Server.

The Server reads input files directly from the multipart stream into the temporary directory. So unlike LocalBoxedExecutor, there is no need to create input files here. Similarly, output file destruction is deferred until after the response has been sent.

Member Function Documentation

◆ executeValid()

Shellbox\Command\ServerBoxedExecutor::executeValid ( BoxedCommand $command)

Execute a BoxedCommand that has already been validated.

Parameters
BoxedCommand$command
Returns
BoxedResult

Reimplemented from Shellbox\Command\LocalBoxedExecutor.


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