$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.
$inheritedElement : \phpDocumentor\Descriptor\Interfaces\ElementInterface|string|\phpDocumentor\Reflection\Fqsen|null
__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 |
getTags() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>>
Returns the tags associated with this element.
getStartLocation() : ?\phpDocumentor\Reflection\Location
Returns the start location where the definition for this element can be found.
None found |
getEndLocation() : ?\phpDocumentor\Reflection\Location
Returns the end location where the definition for this element can be found.
None found |
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.
None found |
None found |
getSource() : ?string
Retrieves the contents of this file.
When source is included in parsing process this property will contain the raw file contents.
None found |
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.
None found |
getIncludes() : \phpDocumentor\Descriptor\Collection<string>
Returns a list of all includes that have been declared in this file.
None found |
getConstants() : \phpDocumentor\Descriptor\Collection
Returns a list of constant descriptors contained in this file.
{@inheritDoc}
None found |
getFunctions() : \phpDocumentor\Descriptor\Collection
Returns a list of function descriptors contained in this file.
{@inheritDoc}
None found |
getClasses() : \phpDocumentor\Descriptor\Collection
Returns a list of class descriptors contained in this file.
{@inheritDoc}
None found |
getInterfaces() : \phpDocumentor\Descriptor\Collection
Returns a list of interface descriptors contained in this file.
{@inheritDoc}
None found |
getTraits() : \phpDocumentor\Descriptor\Collection
Returns a list of trait descriptors contained in this file.
{@inheritDoc}
None found |
getEnums() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\EnumInterface>
None found |
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.
None found |
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.
None found |
setHash(string $hash) : void
Sets the hash of the contents for this file.
string | $hash |
None found |