\phpDocumentor\DescriptorMethodDescriptor

__construct()

__construct() : mixed

Initializes the all properties representing a collection with a new Collection object.

Returns

getFullyQualifiedStructuralElementName()

getFullyQualifiedStructuralElementName() : ?\phpDocumentor\Reflection\Fqsen

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

Returns

getName()

getName() : string

Returns the local name for this element.

Returns

getNamespace()

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

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

Returns

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

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

getPath()

getPath() : string

Returns the path to the file containing this element relative to the project's root.

Returns

getFile()

getFile() : \phpDocumentor\Descriptor\FileDescriptor

Returns the file associated with the parent class, interface or trait.

Returns

getLine()

getLine() : int

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

Returns

getTags()

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

Returns the tags associated with this element.

Returns

getPackage()

getPackage() : ?\phpDocumentor\Descriptor\PackageDescriptor

Returns the package name for this element.

Returns

getAuthor()

getAuthor() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\AuthorDescriptor>

Returns

getVersion()

getVersion() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor>

Returns the versions for this element.

Returns

getCopyright()

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

Returns the copyrights for this element.

Returns

isDeprecated()

isDeprecated() : bool

Checks whether this element is deprecated.

Returns

getErrors()

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

Returns all errors that occur in this element.

Returns

__call()

__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.

Parameters

Returns

__toString()

__toString() : string

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

Returns

getInheritedElement()

getInheritedElement() : \phpDocumentor\Descriptor\DescriptorAbstract|string|\phpDocumentor\Reflection\Fqsen|null

Returns the Method from which this method should inherit its information, if any.

The inheritance scheme for a method is more complicated than for most elements; the following business rules apply:

1. if the parent class/interface extends another class or other interfaces (interfaces have multiple inheritance!) then:
   1. Check each parent class/interface's parent if they have a method with the exact same name
   2. if a method is found with the same name; return the first one encountered.
2. if the parent is a class and implements interfaces, check each interface for a method with the exact same name. If such a method is found, return the first hit.

Returns

setParent()

setParent(\phpDocumentor\Descriptor\ClassDescriptor|\phpDocumentor\Descriptor\InterfaceDescriptor|\phpDocumentor\Descriptor\TraitDescriptor  $parent) : void

Parameters

getParent()

getParent() : \phpDocumentor\Descriptor\ClassDescriptor|\phpDocumentor\Descriptor\InterfaceDescriptor|\phpDocumentor\Descriptor\TraitDescriptor|null

Returns

setAbstract()

setAbstract(bool  $abstract) : void

Parameters

isAbstract()

isAbstract() : bool

Returns

setFinal()

setFinal(bool  $final) : void

Parameters

isFinal()

isFinal() : bool

Returns

setStatic()

setStatic(bool  $static) : void

Parameters

isStatic()

isStatic() : bool

Returns

setVisibility()

setVisibility(string  $visibility) : void

Parameters

getVisibility()

getVisibility() : string

Returns the visibility for this element.

The following values are supported:

• public
• protected
• private

Returns

setArguments()

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

Parameters

addArgument()

addArgument(string  $name, \phpDocumentor\Descriptor\ArgumentDescriptor  $argument) : void

Parameters

getArguments()

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

Returns

getResponse()

getResponse() : \phpDocumentor\Descriptor\Tag\ReturnDescriptor

Returns

getReturn()

getReturn() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\ReturnDescriptor>

Returns

getParam()

getParam() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\ParamDescriptor>

Returns

setReturnType()

setReturnType(\phpDocumentor\Reflection\Type  $returnType) : void

Sets return type of this method.

Parameters