FunctionDeclaration

A declared namespace function.

class FunctionDeclaration implements FunctionyDeclaration, TokenDeclaration<ScannedFunction>

Constructors / Destructors

Public
Returns	Signature and Description
`void`	`__construct`(`ScannedFunction $function`, `Block $block`) Creates a new MethodDeclaration.

Public
Returns	Signature and Description
`Block`	`getDocBlock`() Gets the doc comment block.
`string`	`getFilename`() Gets the source filename.
`string`	`getName`() Gets the name of the declaration.
`ConstMap`<`string`,`ParameterTag`>	`getParameterTags`() Gets the parameter tags.
`?TypedTag`	`getReturnsTag`() Gets the returns tag.
`ConstVector`<`TypedTag`>	`getThrowsTags`() Gets the list of exceptions thrown.
`ScannedFunction`	`getToken`() Gets the scanned token.

public function __construct(ScannedFunction $function, Block $block)

Creates a new MethodDeclaration.

Parameters
Name	Type	Description
`$function`	`ScannedFunction`	The method
`$block`	`Block`	The doc comment

public function getDocBlock()

Gets the doc comment block.

Returns
Type	Description
`Block`	The doc block, which could be empty

public function getFilename()

Gets the source filename.

Returns
Type	Description
`string`	The filename

public function getName()

Gets the name of the declaration.

Returns
Type	Description
`string`	The declaration name

public function getParameterTags()

Gets the parameter tags.

Returns
Type	Description
`ConstMap`<`string`,`ParameterTag`>	The parameter tags

public function getReturnsTag()

Gets the returns tag.

Returns
Type	Description
`?TypedTag`	The return tag

public function getThrowsTags()

Gets the list of exceptions thrown.

Returns
Type	Description
`ConstVector`<`TypedTag`>	The throws tags

public function getToken()

Gets the scanned token.

Returns
Type	Description
`ScannedFunction`	The scanned token