FileInterface

Extends \phpDocumentor\Descriptor\Interfaces\ElementInterface, \phpDocumentor\Descriptor\Interfaces\ContainerInterface

Describes the public interface for a description of a File.

package

Default

Methods

getClasses

getClasses() : \phpDocumentor\Descriptor\Collection
inherited

getConstants

getConstants() : \phpDocumentor\Descriptor\Collection
inherited

Returns a longer description for this element.

getDescription() : string
inherited

Response

string

getErrors

getErrors() : \phpDocumentor\Descriptor\Collection

Returns the Fully Qualified Structural Element Name (FQSEN) for this element.

getFullyQualifiedStructuralElementName() : string
inherited

Response

string

getFunctions

getFunctions() : \phpDocumentor\Descriptor\Collection
inherited

getHash

getHash() : string

Response

string

getIncludes

getIncludes() : \phpDocumentor\Descriptor\Collection

getInterfaces

getInterfaces() : \phpDocumentor\Descriptor\Collection
inherited

Returns the line number where this element may be found.

getLine() : integer
inherited
see \phpDocumentor\Descriptor\Interfaces\ElementInterface::getPath()

to find out in which file this element is found.

Response

integer

Returns the local name for this element.

getName() : string
inherited

Response

string

getNamespaceAliases

getNamespaceAliases() : \phpDocumentor\Descriptor\Collection

Returns the file location for this element relative to the project root.

getPath() : string
inherited

Response

string

getSource

getSource() : string|null

Response

string|null

Returns the summary describing this element.

getSummary() : string
inherited

Response

string

Returns all tags associated with this element.

getTags() : \phpDocumentor\Descriptor\Collection
inherited

getTraits

getTraits() : \phpDocumentor\Descriptor\Collection
inherited

Sets a longer description for this element.

setDescription(string $description) : void
inherited

Arguments

$description

string

Sets the Fully Qualified Structural Element Name (FQSEN) for this element.

setFullyQualifiedStructuralElementName(string $name) : void
inherited

Arguments

$name

string

Sets the file and location for this element.

setLocation(\phpDocumentor\Descriptor\FileDescriptor $file, integer $line) : void
inherited

Arguments

$line

integer

Sets the local name for this element.

setName(string $name) : void
inherited

Arguments

$name

string

setSource

setSource( $source) : void

Arguments

$source

Sets a summary describing this element.

setSummary(string $summary) : void
inherited

Arguments

$summary

string