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

PHP RPC handler. More...

+ Inheritance diagram for Shellbox\Action\CallAction:

Protected Member Functions

 execute ( $pathParts)
 
 getActionName ()
 Override this to provide the action name as used in the URL.
 
- Protected Member Functions inherited from Shellbox\Action\MultipartAction
 getRequiredParam ( $name)
 Get a parameter from the request, or throw if it isn't present.
 
 getParam ( $name, $default=null)
 Get a parameter from the request.
 
 getConfig ( $name)
 Get a configuration option, or throw if it doesn't exist.
 
 forgetConfig ( $name)
 Erase a configuration option.
 
 getHeader ( $name)
 Get a request header of a given name, or null if there was no such header.
 
 error ( $message, $code=500)
 Throw an error exception.
 
 writeResult ( $structuredData, $binaryData=[], $files=[])
 Write a standard result.
 
 getReceivedFileNames ()
 Get the names of the received files, relative to the temporary directory.
 

Additional Inherited Members

- Public Member Functions inherited from Shellbox\Action\MultipartAction
 __construct (Server $server)
 
 setLogger (LoggerInterface $logger)
 
 baseExecute ( $pathParts)
 The entry point for execution of the action.
 
- Protected Attributes inherited from Shellbox\Action\MultipartAction
 $tempDirManager
 
 $logger
 

Detailed Description

PHP RPC handler.

Member Function Documentation

◆ execute()

Shellbox\Action\CallAction::execute ( $pathParts)
protected
Parameters
string[]$pathParts@phan-unused-param

Reimplemented from Shellbox\Action\MultipartAction.

◆ getActionName()

Shellbox\Action\CallAction::getActionName ( )
protected

Override this to provide the action name as used in the URL.

Returns
string

Reimplemented from Shellbox\Action\MultipartAction.


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