FileDescriptor

Extends \phpDocumentor\Descriptor\DescriptorAbstract Implements \phpDocumentor\Descriptor\Interfaces\FileInterface

Represents a file in the project.

package

Default

Methods

Dynamically constructs a set of getters to retrieve tag (collections) with.

__call(string $name, array<mixed,mixed> $arguments) : \phpDocumentor\Descriptor\Collection|null
inherited

Important: __call() is not a fast method of access; it is preferred to directly use the getTags() collection. This interface is provided to allow for uniform and easy access to certain tags.

Arguments

$name

string

$arguments

array<mixed,mixed>

Response

\phpDocumentor\Descriptor\Collection|null

Initializes this descriptor.

__construct() 
inherited

Represents this object by its unique identifier, the Fully Qualified Structural Element Name.

__toString() : string
inherited

Response

string

Returns a list of all errors in this file and all its child elements.

getAllErrors() : \phpDocumentor\Descriptor\Collection

getAuthor

getAuthor() : \phpDocumentor\Descriptor\Collection
inherited

Returns a list of class descriptors contained in this file.

getClasses() : \phpDocumentor\Descriptor\Collection|array<mixed,\phpDocumentor\Descriptor\ClassInterface>

Response

\phpDocumentor\Descriptor\Collection|array<mixed,\phpDocumentor\Descriptor\ClassInterface>

Returns a list of constant descriptors contained in this file.

getConstants() : \phpDocumentor\Descriptor\Collection

Returns the copyrights for this element.

getCopyright() : \phpDocumentor\Descriptor\Collection
inherited

Returns the description for this element.

getDescription() : string
inherited

This method will automatically attempt to inherit the parent's description if this one has none.

Response

string

Returns all errors that occur in this element.

getErrors() : \phpDocumentor\Descriptor\Collection
inherited

Returns the file in which this element resides or null in case the element is not bound to a file.

getFile() : \phpDocumentor\Descriptor\FileDescriptor|null
inherited

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

getFullyQualifiedStructuralElementName() : string
inherited

Response

string

Returns a list of function descriptors contained in this file.

getFunctions() : \phpDocumentor\Descriptor\Collection|array<mixed,\phpDocumentor\Descriptor\FunctionInterface>

Response

\phpDocumentor\Descriptor\Collection|array<mixed,\phpDocumentor\Descriptor\FunctionInterface>

Returns the hash of the contents for this file.

getHash() : string

Response

string

Returns a list of all includes that have been declared in this file.

getIncludes() : \phpDocumentor\Descriptor\Collection

getInheritedElement

getInheritedElement() : \phpDocumentor\Descriptor\DescriptorAbstract|null
inherited

Returns a list of interface descriptors contained in this file.

getInterfaces() : \phpDocumentor\Descriptor\Collection|array<mixed,\phpDocumentor\Descriptor\InterfaceInterface>

Response

\phpDocumentor\Descriptor\Collection|array<mixed,\phpDocumentor\Descriptor\InterfaceInterface>

Returns the line number where the definition for this element can be found.

getLine() : integer
inherited

Response

integer

Returns a series of markers contained in this file.

getMarkers() : \phpDocumentor\Descriptor\Collection

A marker is a special inline comment that starts with a keyword and is followed by a single line description.

Example:

// TODO: This is an item that needs to be done.

Response

\phpDocumentor\Descriptor\Collection

Returns the local name for this element.

getName() : string
inherited

Response

string

Returns the namespace for this element or null if none is attached.

getNamespace() : \phpDocumentor\Descriptor\NamespaceDescriptor|string|null
inherited

Returns the namespace aliases that have been defined in this file.

getNamespaceAliases() : \phpDocumentor\Descriptor\Collection

Returns the package name for this element.

getPackage() : \phpDocumentor\Descriptor\PackageDescriptor
inherited

Returns the path to the file containing this element relative to the project's root.

getPath() : string
inherited

Response

string

Retrieves the contents of this file.

getSource() : string|null

Response

string|null

Returns the summary which describes this element.

getSummary() : string
inherited

This method will automatically attempt to inherit the parent's summary if this one has none.

Response

string

Returns the tags associated with this element.

getTags() : \phpDocumentor\Descriptor\Collection
inherited

Returns a list of trait descriptors contained in this file.

getTraits() : \phpDocumentor\Descriptor\Collection|array<mixed,\phpDocumentor\Descriptor\TraitInterface>

Response

\phpDocumentor\Descriptor\Collection|array<mixed,\phpDocumentor\Descriptor\TraitInterface>

Returns the versions for this element.

getVersion() : \phpDocumentor\Descriptor\Collection
inherited

Checks whether this element is deprecated.

isDeprecated() : boolean
inherited

Response

boolean

Sets a list of class descriptors contained in this file.

setClasses(\phpDocumentor\Descriptor\Collection $classes) : void

Sets a list of constant descriptors contained in this file.

setConstants(\phpDocumentor\Descriptor\Collection $constants) : void

Sets a description for this element.

setDescription(string $description) : void
inherited

Arguments

$description

string

Sets a list of all errors associated with this element.

setErrors(\phpDocumentor\Descriptor\Collection $errors) : void
inherited

Sets the file to which this element is associated.

setFile(\phpDocumentor\Descriptor\FileDescriptor $file) : false
inherited

Arguments

Response

false

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

setFullyQualifiedStructuralElementName(string $name) : void
inherited

Arguments

$name

string

Sets a list of function descriptors contained in this file.

setFunctions(\phpDocumentor\Descriptor\Collection $functions) : void

Sets the hash of the contents for this file.

setHash(string $hash) : void

Arguments

$hash

string

Sets a list of all includes that have been declared in this file.

setIncludes(\phpDocumentor\Descriptor\Collection $includes) : void

Sets a list of interface descriptors contained in this file.

setInterfaces(\phpDocumentor\Descriptor\Collection $interfaces) : void

Arguments

Sets the line number for this element's location in the source file.

setLine(integer $lineNumber) : void
inherited

Arguments

$lineNumber

integer

Sets the file and linenumber where this element is at.

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

Arguments

$line

integer

Sets a series of markers contained in this file.

setMarkers(\phpDocumentor\Descriptor\Collection $markers) : void

Sets the local name for this element.

setName(string $name) : void
inherited

Arguments

$name

string

Sets the namespace (name) for this element.

setNamespace(\phpDocumentor\Descriptor\NamespaceDescriptor|string $namespace) 
inherited

Arguments

Sets the collection of namespace aliases for this file.

setNamespaceAliases(\phpDocumentor\Descriptor\Collection $namespaceAliases) : void

Arguments

Sets the name of the package to which this element belongs.

setPackage(\phpDocumentor\Descriptor\PackageDescriptor $package) : void
inherited

Sets the file path for this file relative to the project's root.

setPath(string $path) : void

Arguments

$path

string

Sets the source contents for this file.

setSource(string|null $source) : void

Arguments

$source

string|null

Sets the summary describing this element in short.

setSummary(string $summary) : void
inherited

Arguments

$summary

string

Sets the tags associated with this element.

setTags(\phpDocumentor\Descriptor\Collection $tags) : void
inherited

Sets a list of trait descriptors contained in this file.

setTraits(\phpDocumentor\Descriptor\Collection $traits) : void

Properties

hash

hash : string
var

Type(s)

string

path

path : string
var

Type(s)

string

source

source : string|null
var

Type(s)

string|null

namespaceAliases

namespaceAliases : \phpDocumentor\Descriptor\Collection

includes

includes : \phpDocumentor\Descriptor\Collection

constants

constants : \phpDocumentor\Descriptor\Collection

functions

functions : \phpDocumentor\Descriptor\Collection

classes

classes : \phpDocumentor\Descriptor\Collection

interfaces

interfaces : \phpDocumentor\Descriptor\Collection

traits

traits : \phpDocumentor\Descriptor\Collection

markers

markers : \phpDocumentor\Descriptor\Collection

Fully Qualified Structural Element Name; the FQCN including method, property of constant name

fqsen : string
inherited
var

Fully Qualified Structural Element Name; the FQCN including method, property of constant name

Type(s)

string

The local name for this element

name : string
inherited
var

The local name for this element

Type(s)

string

The namespace for this element

namespace : \phpDocumentor\Descriptor\NamespaceDescriptor
inherited
var

The namespace for this element

Type(s)

\phpDocumentor\Descriptor\NamespaceDescriptor

The package with which this element is associated

package : string
inherited
var

The package with which this element is associated

Type(s)

string

A summary describing the function of this element in short.

summary : string
inherited
var

A summary describing the function of this element in short.

Type(s)

string

A more extensive description of this element.

description : string
inherited
var

A more extensive description of this element.

Type(s)

string

The file to which this element belongs; if applicable

fileDescriptor : \phpDocumentor\Descriptor\FileDescriptor|null
inherited
var

The file to which this element belongs; if applicable

Type(s)

\phpDocumentor\Descriptor\FileDescriptor|null

The line number on which this element occurs.

line : integer
inherited
var

The line number on which this element occurs.

Type(s)

integer

The tags associated with this element.

tags : \phpDocumentor\Descriptor\Collection
inherited
var

The tags associated with this element.

Type(s)

\phpDocumentor\Descriptor\Collection

A list of errors found while building this element.

errors : \phpDocumentor\Descriptor\Collection
inherited
var

A list of errors found while building this element.

Type(s)

\phpDocumentor\Descriptor\Collection

the element from which to inherit information in this element

inheritedElement : \phpDocumentor\Descriptor\DescriptorAbstract|null
inherited
var

the element from which to inherit information in this element

Type(s)

\phpDocumentor\Descriptor\DescriptorAbstract|null