phpDocumentor

FileInterface extends ElementInterface, ContainerInterface

Describes the public interface for a description of a File.

Table of Contents

getClasses()  : Collection<string|int, ClassDescriptor>
getConstants()  : Collection<string|int, ConstantDescriptor>
getDescription()  : DescriptionDescriptor|null
Returns a longer description for this element.
getErrors()  : Collection<string|int, Error>
getFullyQualifiedStructuralElementName()  : Fqsen|null
Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
getFunctions()  : Collection<string|int, FunctionDescriptor>
getHash()  : string
getIncludes()  : Collection<string|int, string>
getInterfaces()  : Collection<string|int, InterfaceDescriptor>
getLine()  : int
Returns the line number where this element may be found.
getName()  : string
Returns the local name for this element.
getNamespaceAliases()  : Collection<string|int, NamespaceDescriptor>|Collection<string|int, Fqsen>
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, TraitDescriptor>
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

getFullyQualifiedStructuralElementName()

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

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

getHash()

public getHash() : string
Return values
string

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

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
Return values
void

setName()

Sets the local name for this element.

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

setSource()

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

setSummary()

Sets a summary describing this element.

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

Search results