phpDocumentor

FileInterface extends ElementInterface, ContainerInterface

Describes the public interface for a description of a File.

Table of Contents

Methods

getClasses()  : Collection<string|int, ClassInterface>
getConstants()  : Collection<string|int, ConstantInterface>
getDescription()  : DescriptionDescriptor
Returns the description for this element.
getEndLocation()  : Location|null
Returns the end location where the definition for this element can be found.
getEnums()  : Collection<string|int, EnumInterface>
getErrors()  : Collection<string|int, Error>
getFullyQualifiedStructuralElementName()  : Fqsen|null
Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
getFunctions()  : Collection<string|int, FunctionInterface>
getHash()  : string
getIncludes()  : Collection<string|int, string>
getInterfaces()  : Collection<string|int, InterfaceInterface>
getLine()  : int
Returns the line number where this element may be found.
getName()  : string
Returns the local name for this element.
getNamespace()  : NamespaceInterface|string
Returns the namespace for this element (defaults to global "\")
getNamespaceAliases()  : Collection<string|int, \phpDocumentor\Descriptor\Interfaces\NamespaceInterface|\phpDocumentor\Reflection\Fqsen>
getPackage()  : PackageInterface|null
Returns the package name for this element.
getPath()  : string
Returns the file location for this element relative to the project root.
getSource()  : string|null
getSummary()  : string
Returns the summary describing this element.
getTags()  : Collection<string|int, Collection<string|int, TagDescriptor>>
Returns all tags associated with this element.
getTraits()  : Collection<string|int, TraitInterface>
setDescription()  : void
Sets a longer description for this element.
setFullyQualifiedStructuralElementName()  : void
Sets the Fully Qualified Structural Element Name (FQSEN) for this element.
setLocation()  : void
Sets the file and location for this element.
setName()  : void
Sets the local name for this element.
setSource()  : void
setSummary()  : void
Sets a summary describing this element.

Methods

getEndLocation()

Returns the end location where the definition for this element can be found.

public getEndLocation() : Location|null
Return values
Location|null

getFullyQualifiedStructuralElementName()

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

public getFullyQualifiedStructuralElementName() : Fqsen|null
Return values
Fqsen|null

getLine()

Returns the line number where this element may be found.

public getLine() : int
Tags
see
getPath()

to find out in which file this element is found.

Return values
int

getName()

Returns the local name for this element.

public getName() : string
Return values
string

getNamespaceAliases()

public getNamespaceAliases() : Collection<string|int, \phpDocumentor\Descriptor\Interfaces\NamespaceInterface|\phpDocumentor\Reflection\Fqsen>
Return values
Collection<string|int, \phpDocumentor\Descriptor\Interfaces\NamespaceInterface|\phpDocumentor\Reflection\Fqsen>

getPath()

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

public getPath() : string
Return values
string

getSource()

public getSource() : string|null
Return values
string|null

getSummary()

Returns the summary describing this element.

public getSummary() : string
Return values
string

setFullyQualifiedStructuralElementName()

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

public setFullyQualifiedStructuralElementName(Fqsen $name) : void
Parameters
$name : Fqsen

setName()

Sets the local name for this element.

public setName(string $name) : void
Parameters
$name : string

setSource()

public setSource(string|null $source) : void
Parameters
$source : string|null

setSummary()

Sets a summary describing this element.

public setSummary(string $summary) : void
Parameters
$summary : string

        
On this page

Search results