\phpDocumentor\DescriptorFileDescriptor

__construct()

__construct(string  $hash) 

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

Parameters

setFullyQualifiedStructuralElementName()

setFullyQualifiedStructuralElementName(string  $name) : void

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

Parameters

getFullyQualifiedStructuralElementName()

getFullyQualifiedStructuralElementName() : string

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

Returns

setName()

setName(string  $name) : void

Sets the local name for this element.

Parameters

getName()

getName() : string

Returns the local name for this element.

Returns

setNamespace()

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

Sets the namespace (name) for this element.

Parameters

getNamespace()

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

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

Returns

setSummary()

setSummary(string  $summary) : void

Sets the summary describing this element in short.

Parameters

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

setDescription()

setDescription(string  $description) : void

Sets a description for this element.

Parameters

getDescription()

getDescription() : string

Returns the description for this element.

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

Returns

setLocation()

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

Sets the file and linenumber where this element is at.

Parameters

getPath()

getPath() : string

Returns the file path relative to the project's root.

Returns

getFile()

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

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

.

Returns

setFile()

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

Sets the file to which this element is associated.

Parameters

Returns

getLine()

getLine() : integer

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

Returns

setLine()

setLine(integer  $lineNumber) : void

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

Parameters

setTags()

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

Sets the tags associated with this element.

Parameters

getTags()

getTags() : \phpDocumentor\Descriptor\Collection

Returns the tags associated with this element.

Returns

setPackage()

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

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

Parameters

getPackage()

getPackage() : \phpDocumentor\Descriptor\PackageDescriptor

Returns the package name for this element.

Returns

getAuthor()

getAuthor() : \phpDocumentor\Descriptor\Collection

Returns

getVersion()

getVersion() : \phpDocumentor\Descriptor\Collection

Returns the versions for this element.

Returns

getCopyright()

getCopyright() : \phpDocumentor\Descriptor\Collection

Returns the copyrights for this element.

Returns

isDeprecated()

isDeprecated() : boolean

Checks whether this element is deprecated.

Returns

setErrors()

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

Sets a list of all errors associated with this element.

Parameters

getErrors()

getErrors() : \phpDocumentor\Descriptor\Collection

Returns all errors that occur in this element.

Returns

__call()

__call(string  $name, array<mixed,mixed>  $arguments) : \phpDocumentor\Descriptor\Collection|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

Returns

__toString()

__toString() : string

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

Returns

getInheritedElement()

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

Returns

getHash()

getHash() : string

Returns the hash of the contents for this file.

Returns

getSource()

getSource() : string|null

Retrieves the contents of this file.

Returns

setSource()

setSource(string|null  $source) : void

Sets the source contents for this file.

Parameters

getNamespaceAliases()

getNamespaceAliases() : \phpDocumentor\Descriptor\Collection

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

Returns

setNamespaceAliases()

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

Sets the collection of namespace aliases for this file.

Parameters

getIncludes()

getIncludes() : \phpDocumentor\Descriptor\Collection

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

Returns

setIncludes()

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

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

Parameters

getConstants()

getConstants() : \phpDocumentor\Descriptor\Collection

Returns a list of constant descriptors contained in this file.

Returns

setConstants()

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

Sets a list of constant descriptors contained in this file.

Parameters

getFunctions()

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

Returns a list of function descriptors contained in this file.

Returns

setFunctions()

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

Sets a list of function descriptors contained in this file.

Parameters

getClasses()

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

Returns a list of class descriptors contained in this file.

Returns

setClasses()

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

Sets a list of class descriptors contained in this file.

Parameters

getInterfaces()

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

Returns a list of interface descriptors contained in this file.

Returns

setInterfaces()

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

Sets a list of interface descriptors contained in this file.

Parameters

getTraits()

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

Returns a list of trait descriptors contained in this file.

Returns

setTraits()

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

Sets a list of trait descriptors contained in this file.

Parameters

getMarkers()

getMarkers() : \phpDocumentor\Descriptor\Collection

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

setMarkers()

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

Sets a series of markers contained in this file.

Parameters

getAllErrors()

getAllErrors() : \phpDocumentor\Descriptor\Collection

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

Returns

setPath()

setPath(string  $path) : void

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

Parameters

setHash()

setHash(string  $hash) : void

Sets the hash of the contents for this file.

Parameters