FunctionInterface
extends ElementInterface, TypeInterface
in package
Descriptor representing a global function in a file.
Methods
setFullyQualifiedStructuralElementName() inherited
Sets the Fully Qualified Structural Element Name (FQSEN) for this element.
publicsetFullyQualifiedStructuralElementName(Fqsen $name) : void
getFullyQualifiedStructuralElementName() inherited
Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
publicgetFullyQualifiedStructuralElementName() : Fqsen|null
setSummary() inherited
Sets a summary describing this element.
publicsetSummary(string $summary) : void
setDescription() inherited
Sets a longer description for this element.
publicsetDescription(string $description) : void
Parameters
- Inherited from
- \phpDocumentor\Descriptor\Interfaces\ElementInterface
getDescription() inherited
Returns a longer description for this element.
publicgetDescription() : string
setLocation() inherited
Sets the file and location for this element.
publicsetLocation(FileDescriptor $file, int $line) : void
- Inherited from
- \phpDocumentor\Descriptor\Interfaces\ElementInterface
getPath() inherited
Returns the file location for this element relative to the project root.
publicgetPath() : string
getTags() inherited
Returns all tags associated with this element.
publicgetTags() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor> —- Inherited from
- \phpDocumentor\Descriptor\Interfaces\ElementInterface
__toString() inherited
public__toString() : string
setArguments() Line 29
Sets the arguments related to this function.
publicsetArguments(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ArgumentDescriptor> $arguments) : void
Parameters
getArguments() Line 36
Returns the arguments related to this function.
publicgetArguments() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ArgumentDescriptor>