\phpDocumentor\Descriptor\InterfacesFunctionInterface

getNamespace()

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

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

Returns

setFullyQualifiedStructuralElementName()

setFullyQualifiedStructuralElementName(\phpDocumentor\Reflection\Fqsen  $name) : void

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

Parameters

getFullyQualifiedStructuralElementName()

getFullyQualifiedStructuralElementName() : ?\phpDocumentor\Reflection\Fqsen

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

Returns

setSummary()

setSummary(string  $summary) : void

Sets a summary describing this element.

Parameters

getSummary()

getSummary() : string

Returns the summary describing this element.

Returns

setLocation()

setLocation(\phpDocumentor\Descriptor\Interfaces\FileInterface  $file, \phpDocumentor\Reflection\Location  $startLocation) : void

Sets the file and location for this element.

Parameters

getEndLocation()

getEndLocation() : ?\phpDocumentor\Reflection\Location

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

Returns

getPath()

getPath() : string

Returns the file location for this element relative to the project root.

Returns

getLine()

getLine() : int

Returns the line number where this element may be found.

Returns

getTags()

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

Returns all tags associated with this element.

Returns

getPackage()

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

Returns the package name for this element.

Returns

getName()

getName() : string

Returns the local name for this element.

Returns

setName()

setName(string  $name) : void

Sets the local name for this element.

Parameters

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

setDescription()

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

Sets a longer description for this element.

Parameters

getErrors()

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

Returns

__toString()

__toString() : string

Returns

setArguments()

setArguments(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ArgumentInterface>  $arguments) : void

Sets the arguments related to this function.

Parameters

getArguments()

getArguments() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ArgumentInterface>

Returns the arguments related to this function.

Returns