FunctionHelper

To be used by XHP that renders functions and methods

trait FunctionHelper
Copyright
2016 Appertly
License
Apache-2.0

Static Properties

Protected
NameTypeSummary
$primitivesImmSet<string>
$thisyImmSet<string>

Instance Methods

Protected
ReturnsSignature and Description
string
getFilename(ScannedBase $c)

Cleans up a filename.

Page
getPage(string $title)

Gets a page builder.

?XHPRoot
getParameters(FunctionyDeclaration $function, DocParser $mdParser)
?XHPRoot
getReturns(FunctionyDeclaration $function, DocParser $mdParser)
?XHPRoot
getThrows(FunctionyDeclaration $function, DocParser $mdParser)
bool
isPrimitive(string $type)

Gets whether the provided type is primitive.

bool
isThisy(?ScannedTypehint $type)

Gets whether the provided typehint refers to $this

bool
isVoid(?ScannedTypehint $type)

Gets whether the provided typehint is void.

Property Details

$primitives

Inherited from Producer

static protected ImmSet<string> $primitives

$thisy

Inherited from Producer

static protected ImmSet<string> $thisy

Method Details

getFilename

Inherited from Producer

protected function getFilename(ScannedBase $c)

Cleans up a filename.

Parameters
NameTypeDescription
$cScannedBase

The scanned token

Returns
TypeDescription
string

The cleaned up filename

getPage

Inherited from Producer

protected function getPage(string $title)

Gets a page builder.

Parameters
NameTypeDescription
$titlestring

The page title

Returns
TypeDescription
Page

The page builder

getParameters

protected function getParameters(FunctionyDeclaration $function, DocParser $mdParser)
Parameters
NameTypeDescription
$functionFunctionyDeclaration
$mdParserDocParser
Returns
TypeDescription
?XHPRoot

getReturns

protected function getReturns(FunctionyDeclaration $function, DocParser $mdParser)
Parameters
NameTypeDescription
$functionFunctionyDeclaration
$mdParserDocParser
Returns
TypeDescription
?XHPRoot

getThrows

protected function getThrows(FunctionyDeclaration $function, DocParser $mdParser)
Parameters
NameTypeDescription
$functionFunctionyDeclaration
$mdParserDocParser
Returns
TypeDescription
?XHPRoot

isPrimitive

Inherited from Producer

protected function isPrimitive(string $type)

Gets whether the provided type is primitive.

Parameters
NameTypeDescription
$typestring

The type to test

Returns
TypeDescription
bool

true if the type is primitive.

isThisy

Inherited from Producer

protected function isThisy(?ScannedTypehint $type)

Gets whether the provided typehint refers to $this

Parameters
NameTypeDescription
$type?ScannedTypehint

The typehint to test

Returns
TypeDescription
bool

true if the typehint is thisy

isVoid

Inherited from Producer

protected function isVoid(?ScannedTypehint $type)

Gets whether the provided typehint is void.

Parameters
NameTypeDescription
$type?ScannedTypehint

The typehint to test

Returns
TypeDescription
bool

true if the typehint is void