\phpDocumentor\DescriptorFileDescriptor

Represents a file in the project.

This class contains all structural elements of the file it represents. In most modern projects a file will contain a single element like a Class, Interface or Trait, sometimes multiple functions. Depending on the config settings of the parsed project it might include all source code from the file in the project.

Summary

Methods

Properties

Constants

__construct()
getErrors()
__call()
__toString()
getFullyQualifiedStructuralElementName()
getName()
getNamespace()
getPackage()
getSummary()
setDescription()
getDescription()
getTags()
getAuthor()
getVersion()
getCopyright()
isDeprecated()
getPath()
getFile()
getLine()
getStartLocation()
getEndLocation()
getInheritedElement()
getHash()
getSource()
getNamespaceAliases()
getIncludes()
getConstants()
getFunctions()
getClasses()
getInterfaces()
getTraits()
getEnums()
getMarkers()
getAllErrors()

No public properties found

No constants found

setHash()

$fqsen
$name
$namespace
$package
$summary
$description
$tags
$fileDescriptor
$line
$startLocation
$endLocation
$errors
$inheritedElement
$hash
$path
$source
$namespaceAliases
$includes
$constants
$functions
$classes
$interfaces
$traits
$markers

N/A

No private methods found

$enums

N/A

File: src/phpDocumentor/Descriptor/FileDescriptor.php
Package: phpDocumentor\AST
Class hierarchy: DescriptorAbstract

\phpDocumentor\Descriptor\FileDescriptor
Implements: \phpDocumentor\Descriptor\Interfaces\FileInterface
Uses

Properties

$fqsen

$fqsen : ?\phpDocumentor\Reflection\Fqsen

Type

?\phpDocumentor\Reflection\Fqsen — Fully Qualified Structural Element Name; the FQCN including method, property or constant name

$name

$name : string

Type

string

$namespace

$namespace : \phpDocumentor\Descriptor\Interfaces\NamespaceInterface|string

Type

\phpDocumentor\Descriptor\Interfaces\NamespaceInterface|string — The namespace for this element

$package

$package : \phpDocumentor\Descriptor\Interfaces\PackageInterface|string

Type

\phpDocumentor\Descriptor\Interfaces\PackageInterface|string — The package with which this element is associated

$summary

$summary : string

Type

string — A summary describing the function of this element in short.

$description

$description : ?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Type

?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

$tags

$tags : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>>

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>> — The tags associated with this element.

$fileDescriptor

$fileDescriptor : \phpDocumentor\Descriptor\Interfaces\FileInterface|null

Type

\phpDocumentor\Descriptor\Interfaces\FileInterface|null — The file to which this element belongs; if applicable

$line

$line : int

Type

int — The line number on which this element occurs.

$startLocation

$startLocation : ?\phpDocumentor\Reflection\Location

Type

?\phpDocumentor\Reflection\Location

$endLocation

$endLocation : ?\phpDocumentor\Reflection\Location

Type

?\phpDocumentor\Reflection\Location

$errors

$errors : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> — A collection of errors found during filtering.

$inheritedElement

$inheritedElement : \phpDocumentor\Descriptor\Interfaces\ElementInterface|string|\phpDocumentor\Reflection\Fqsen|null

Type

\phpDocumentor\Descriptor\Interfaces\ElementInterface|string|\phpDocumentor\Reflection\Fqsen|null — the element from which to inherit information in this element

$hash

$hash : string

Type

string

$path

$path : string

Type

string

$source

$source : ?string

Type

?string

$namespaceAliases

$namespaceAliases : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\NamespaceInterface|\phpDocumentor\Reflection\Fqsen>

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\NamespaceInterface|\phpDocumentor\Reflection\Fqsen> —

$includes

$includes : \phpDocumentor\Descriptor\Collection<string>

Type

\phpDocumentor\Descriptor\Collection —

$constants

$constants : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ConstantInterface>

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ConstantInterface> —

$functions

$functions : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\FunctionInterface>

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\FunctionInterface> —

$classes

$classes : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ClassInterface>

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ClassInterface> —

$interfaces

$interfaces : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\InterfaceInterface>

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\InterfaceInterface> —

$traits

$traits : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\TraitInterface>

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\TraitInterface> —

$markers

$markers : \phpDocumentor\Descriptor\Collection<array<int|string,mixed>>

Type

\phpDocumentor\Descriptor\Collection> —

$enums

$enums : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\EnumInterface>

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\EnumInterface> —

Methods

__construct()

__construct(string  $hash) : mixed

Initializes a new file descriptor with the given hash of its contents.

Parameters

string

$hash

An MD5 hash of the contents if this file.

Returns

mixed —

getErrors()

getErrors() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>

Returns all errors associated with this tag.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> —

__call()

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

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

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.

Parameters

string	$name
array	$arguments

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>|null —

__toString()

__toString() : string

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

Returns

string —

getFullyQualifiedStructuralElementName()

getFullyQualifiedStructuralElementName() : ?\phpDocumentor\Reflection\Fqsen

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

Returns

?\phpDocumentor\Reflection\Fqsen —

getName()

getName() : string

Returns the name for this element.

Returns

string —

getNamespace()

getNamespace() : \phpDocumentor\Descriptor\Interfaces\NamespaceInterface|string

Returns the namespace for this element (defaults to global "\")

Returns

\phpDocumentor\Descriptor\Interfaces\NamespaceInterface|string —

getPackage()

getPackage() : ?\phpDocumentor\Descriptor\Interfaces\PackageInterface

Returns the package name for this element.

Returns

?\phpDocumentor\Descriptor\Interfaces\PackageInterface —

getSummary()

getSummary() : string

Returns the summary which describes this element.

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

Returns

string —

setDescription()

setDescription(?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor  $description) : void

Sets a description or none to inherit from a parent.

Parameters

?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

$description

getDescription()

getDescription() : \phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Returns the description for this element.

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

Returns

\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor —

getTags()

getTags() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>>

Returns the tags associated with this element.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>> —

getAuthor()

getAuthor() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\AuthorDescriptor>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\AuthorDescriptor> —

getVersion()

getVersion() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor>

Returns the versions for this element.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor> —

getCopyright()

getCopyright() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>

Returns the copyrights for this element.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor> —

isDeprecated()

isDeprecated() : bool

Checks whether this element is deprecated.

Returns

bool —

getPath()

getPath() : string

Returns the relative file path.

The path is a relative to the source file based on the dsn of the config.

Returns

string —

getFile()

getFile() : ?\phpDocumentor\Descriptor\Interfaces\FileInterface

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

Returns

?\phpDocumentor\Descriptor\Interfaces\FileInterface —

getLine()

getLine() : int

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

Returns

int —

getStartLocation()

getStartLocation() : ?\phpDocumentor\Reflection\Location

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

Returns

?\phpDocumentor\Reflection\Location —

getEndLocation()

getEndLocation() : ?\phpDocumentor\Reflection\Location

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

Returns

?\phpDocumentor\Reflection\Location —

getInheritedElement()

getInheritedElement() : \phpDocumentor\Descriptor\Interfaces\ElementInterface|string|\phpDocumentor\Reflection\Fqsen|null

Returns the element from which this element inherits, or null if it doesn't inherit any information.

This method is usually overridden in consuming classes with the determination how that class should resolve inheritance. This is a placeholder function for those classes who need a simple way to provide inheritance.

Returns

\phpDocumentor\Descriptor\Interfaces\ElementInterface|string|\phpDocumentor\Reflection\Fqsen|null —

getHash()

getHash() : string

Returns the hash of the contents for this file.

Returns

string —

getSource()

getSource() : ?string

Retrieves the contents of this file.

When source is included in parsing process this property will contain the raw file contents.

Returns

?string —

getNamespaceAliases()

getNamespaceAliases() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\NamespaceInterface|\phpDocumentor\Reflection\Fqsen>

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

A namespace alias can either be a full descriptor of the namespace or just a {@see \phpDocumentor\Reflection\Fqsen} when the namespace was not part of the processed code. When it is a {@see \phpDocumentor\Descriptor\NamespaceDescriptor} it will contain all structural elements in the namespace not just the once in this particlar file.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\NamespaceInterface|\phpDocumentor\Reflection\Fqsen> —

getIncludes()

getIncludes() : \phpDocumentor\Descriptor\Collection<string>

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

Returns

\phpDocumentor\Descriptor\Collection —

getConstants()

getConstants() : \phpDocumentor\Descriptor\Collection

Returns a list of constant descriptors contained in this file.

{@inheritDoc}

Returns

\phpDocumentor\Descriptor\Collection —

getFunctions()

getFunctions() : \phpDocumentor\Descriptor\Collection

Returns a list of function descriptors contained in this file.

{@inheritDoc}

Returns

\phpDocumentor\Descriptor\Collection —

getClasses()

getClasses() : \phpDocumentor\Descriptor\Collection

Returns a list of class descriptors contained in this file.

{@inheritDoc}

Returns

\phpDocumentor\Descriptor\Collection —

getInterfaces()

getInterfaces() : \phpDocumentor\Descriptor\Collection

Returns a list of interface descriptors contained in this file.

{@inheritDoc}

Returns

\phpDocumentor\Descriptor\Collection —

getTraits()

getTraits() : \phpDocumentor\Descriptor\Collection

Returns a list of trait descriptors contained in this file.

{@inheritDoc}

Returns

\phpDocumentor\Descriptor\Collection —

getEnums()

getEnums() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\EnumInterface>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\EnumInterface> —

getMarkers()

getMarkers() : \phpDocumentor\Descriptor\Collection<array<int|string,mixed>>

Returns a series of markers contained in this file.

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.

Returns

\phpDocumentor\Descriptor\Collection> —

getAllErrors()

getAllErrors() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>

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

All errors from structural elements in the file are collected to the deepest level.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> —

setHash()

setHash(string  $hash) : void

Sets the hash of the contents for this file.

Parameters

string

$hash