Shellbox\Command\OutputGlob Class Reference

The base class for output file glob patterns. More...

Inheritance diagram for Shellbox\Command\OutputGlob:

Public Member Functions
	__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.
Public Member Functions inherited from Shellbox\Command\OutputEntity
	getInstance ( $boxedName)
	Get an OutputFile corresponding to an instance of the OutputEntity.

Static Public Member Functions
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
	$prefix
	$extension
	$files = []

Detailed Description

The base class for output file glob patterns.

Constructor & Destructor Documentation

__construct()

Shellbox\Command\OutputGlob::__construct	(		$prefix,
			$extension )

Parameters

string	$prefix
string	$extension

Member Function Documentation

getClientData()

Shellbox\Command\OutputGlob::getClientData

(

)

Get JSON serializable data for client/server communication.

Returns

array

getExtension()

Shellbox\Command\OutputGlob::getExtension

(

)

Returns

string

getFiles()

Shellbox\Command\OutputGlob::getFiles

(

)

Returns

OutputFile[]

getPrefix()

Shellbox\Command\OutputGlob::getPrefix

(

)

Returns

string

isMatch()

Shellbox\Command\OutputGlob::isMatch

(

$boxedName

)

Determine whether a given relative path matches the glob pattern.

Parameters

string

$boxedName

Returns

bool

newFromClientData()

static Shellbox\Command\OutputGlob::newFromClientData ( array $data )

static

This is used on the server side to create a placeholder object for globs based on a specification received from the client.

Because the content is never actually populated, it's not necessary to distinguish between the different glob types.

Parameters

array

$data

Returns

OutputGlobPlaceholder

---

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

• src/Command/OutputGlob.php