phpDocumentor
\
phpDocumentor
Compiler
Linker
Pass
Configuration
Definition
Exception
Console
Command
Project
DependencyInjection
Descriptor
Builder
Reflector
Docblock
Tags
Cache
DocBlock
Exception
Filter
Interfaces
ProjectDescriptor
TableOfContents
Tag
BaseTypes
Validation
Event
Guides
Handlers
Parser
Cache
Event
Exception
Middleware
Pipeline
Stage
Cache
Parser
Transformer
Event
Router
Template
Writer
Exception
Graph
Twig

\phpDocumentor\Descriptor\InterfacesFunctionInterface

Descriptor representing a global function in a file.

Summary

Methods
Constants
setFullyQualifiedStructuralElementName()
getFullyQualifiedStructuralElementName()
setName()
getName()
setSummary()
getSummary()
setDescription()
getDescription()
setLocation()
getPath()
getLine()
getTags()
__toString()
setArguments()
getArguments()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

setFullyQualifiedStructuralElementName()

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

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

Parameters

\phpDocumentor\Reflection\Fqsen $name

getFullyQualifiedStructuralElementName()

getFullyQualifiedStructuralElementName() : ?\phpDocumentor\Reflection\Fqsen

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

Returns

?\phpDocumentor\Reflection\Fqsen —

setName()

setName(string  $name) : void

Sets the local name for this element.

Parameters

string $name

getName()

getName() : string

Returns the local name for this element.

Returns

string —

setSummary()

setSummary(string  $summary) : void

Sets a summary describing this element.

Parameters

string $summary

getSummary()

getSummary() : string

Returns the summary describing this element.

Returns

string —

setDescription()

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

Sets a longer description for this element.

Parameters

\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor $description

getDescription()

getDescription() : ?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Returns a longer description for this element.

Returns

?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor —

setLocation()

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

Sets the file and location for this element.

Parameters

\phpDocumentor\Descriptor\FileDescriptor $file
int $line

getPath()

getPath() : string

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

Returns

string —

getLine()

getLine() : int

Returns the line number where this element may be found.

Returns

int —

getTags()

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

Returns all tags associated with this element.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>> —

__toString()

__toString() : string

Returns

string —

setArguments()

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

Sets the arguments related to this function.

Parameters

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ArgumentDescriptor> $arguments

getArguments()

getArguments() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ArgumentDescriptor>

Returns the arguments related to this function.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ArgumentDescriptor> —