FileDeclaration

A declared file.

class FileDeclaration implements Declaration
Copyright
2016 Appertly
License
Apache-2.0

Constructors / Destructors

Public
ReturnsSignature and Description
void
__construct(string $filename, Block $block)

Creates a new FileDeclaration.

Instance Methods

Public
ReturnsSignature and Description
Block

Gets the doc comment block.

string

Gets the source filename.

Method Details

__construct

public function __construct(string $filename, Block $block)

Creates a new FileDeclaration.

Parameters
NameTypeDescription
$filenamestring

The filename

$blockBlock

The doc comment

getDocBlock

public function getDocBlock()

Gets the doc comment block.

Returns
TypeDescription
Block

The doc block, which could be empty

getFilename

public function getFilename()

Gets the source filename.

Returns
TypeDescription
string

The filename