$fqsen
$fqsen : \phpDocumentor\Reflection\Fqsen
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.
$name : string
$namespace : \phpDocumentor\Descriptor\NamespaceDescriptor|string
$package : \phpDocumentor\Descriptor\PackageDescriptor|string
$summary : string
$description : \phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor|null
$fileDescriptor : \phpDocumentor\Descriptor\FileDescriptor|null
$line : int
$tags : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>>
$errors : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>
$inheritedElement : \phpDocumentor\Descriptor\DescriptorAbstract|null
$hash : string
$path : string
$source : string|null
$namespaceAliases : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\NamespaceDescriptor>|\phpDocumentor\Descriptor\Collection<\phpDocumentor\Reflection\Fqsen>
$includes : \phpDocumentor\Descriptor\Collection<string>
$constants : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ConstantDescriptor>
$functions : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\FunctionDescriptor>
$classes : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ClassDescriptor>
$interfaces : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\InterfaceDescriptor>
$traits : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TraitDescriptor>
$markers : \phpDocumentor\Descriptor\Collection<array<int|string,mixed>>
$enums : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\EnumDescriptor>
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.
getTags() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>>
Returns the tags associated with this element.
__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.
string | $name | |
array | $arguments |
getNamespaceAliases() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\NamespaceDescriptor>|\phpDocumentor\Descriptor\Collection<\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} when the namespace was not part of the processed code. When it is a {@see} it will contain all structural elements in the namespace not just the once in this particlar file.
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.
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 structual elements in the file are collected to the deepes level.