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

An output glob for files that are written to a local directory. More...

+ Inheritance diagram for Shellbox\Command\OutputGlobToFile:

Public Member Functions

 __construct ( $prefix, $extension, $destDir)
 
 getInstance ( $boxedName)
 Get an OutputFile corresponding to an instance of the OutputEntity.
 
- Public Member Functions inherited from Shellbox\Command\OutputGlob
 __construct ( $prefix, $extension)
 
 getPrefix ()
 
 getExtension ()
 
 getClientData ()
 Get JSON serializable data for client/server communication.
 
 getFiles ()
 
 isMatch ( $boxedName)
 Determine whether a given relative path matches the glob pattern.
 

Additional Inherited Members

- Static Public Member Functions inherited from Shellbox\Command\OutputGlob
static newFromClientData (array $data)
 This is used on the server side to create a placeholder object for globs based on a specification received from the client.
 
- Protected Attributes inherited from Shellbox\Command\OutputGlob
 $prefix
 
 $extension
 
 $files = []
 

Detailed Description

An output glob for files that are written to a local directory.

Constructor & Destructor Documentation

◆ __construct()

Shellbox\Command\OutputGlobToFile::__construct ( $prefix,
$extension,
$destDir )
Parameters
string$prefix
string$extension
string$destDir

Member Function Documentation

◆ getInstance()

Shellbox\Command\OutputGlobToFile::getInstance ( $boxedName)

Get an OutputFile corresponding to an instance of the OutputEntity.

For OutputFile objects this returns $this. For OutputGlob objects it returns an OutputFile object for a file that matches the glob.

Parameters
string$boxedName
Returns
OutputFile

Reimplemented from Shellbox\Command\OutputEntity.


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