MethodDescriptor

in package
extends DescriptorAbstract Implements MethodInterface, VisibilityInterface

Descriptor representing a Method in a Class, Interface or Trait.

Interfaces, Classes & Used Traits

MethodInterface
Describes the public interface of the description for a method.
VisibilityInterface

Properties

protected$fqsen  : \phpDocumentor\Reflection\Fqsen                

protected$namespace  : \phpDocumentor\Descriptor\NamespaceDescriptor|string                

protected$package  : \phpDocumentor\Descriptor\PackageDescriptor                

protected$summary  : string                

protected$description  : string                

protected$fileDescriptor  : \phpDocumentor\Descriptor\FileDescriptor|null                

protected$tags  : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>>                

protected$errors  : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>                

protected$inheritedElement  : \phpDocumentor\Descriptor\DescriptorAbstract|null                

protected$parent  : \phpDocumentor\Descriptor\ClassDescriptor|\phpDocumentor\Descriptor\InterfaceDescriptor|\phpDocumentor\Descriptor\TraitDescriptor                

protected$abstract  : bool                

protected$final  : bool                

protected$static  : bool                

protected$visibility  : string                

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

private$returnType  : \phpDocumentor\Reflection\Type                

Methods

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

public__construct() : mixed

Returns

mixed

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

publicsetFullyQualifiedStructuralElementName(Fqsen $name) : void

Parameters

$name : Fqsen

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

publicgetFullyQualifiedStructuralElementName() : Fqsen|null

Returns

Fqsen|null

Sets the local name for this element.

publicsetName(string $name) : void

Parameters

$name : string

Returns the local name for this element.

publicgetName() : string

Returns

string

Sets the namespace (name) for this element.

publicsetNamespace(NamespaceDescriptor|string $namespace) : void

Parameters

$namespace : NamespaceDescriptor|string

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

publicgetNamespace() : NamespaceDescriptor|string

Sets the summary describing this element in short.

publicsetSummary(string $summary) : void

Parameters

$summary : string

Returns the summary which describes this element.

publicgetSummary() : string

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

Returns

string

Sets a description for this element.

publicsetDescription(string $description) : void

Parameters

$description : string

Returns the description for this element.

publicgetDescription() : string

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

Returns

string

Sets the file and linenumber where this element is at.

publicsetLocation(FileDescriptor $file, int $line) : void

Parameters

$file : FileDescriptor
$line : int

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

publicgetPath() : string

Returns

string

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

publicgetFile() : FileDescriptor

.

Returns

FileDescriptor

Sets the file to which this element is associated.

publicsetFile(FileDescriptor $file) : void

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

publicgetLine() : int

Returns

int

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

publicsetLine(int $lineNumber) : void

Parameters

$lineNumber : int

Sets the tags associated with this element.

publicsetTags(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>> $tags) : void

Parameters

$tags : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>>

Returns the tags associated with this element.

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

Returns

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

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

publicsetPackage(PackageDescriptor|string $package) : void

Parameters

$package : PackageDescriptor|string

Returns the package name for this element.

publicgetPackage() : PackageDescriptor|null

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

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\AuthorDescriptor>

Returns the versions for this element.

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

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor>

Returns the copyrights for this element.

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

Returns

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

Checks whether this element is deprecated.

publicisDeprecated() : bool

Returns

bool

Sets a list of all errors associated with this element.

publicsetErrors(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> $errors) : void

Parameters

$errors : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>

Returns all errors that occur in this element.

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

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>

Dynamically constructs a set of getters to retrieve tag (collections) with.

public__call(string $name, array $arguments) : Collection|mixed|null

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

$name : string
$arguments : array

Returns

Collection|mixed|null

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

public__toString() : string

Returns

string

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

publicgetInheritedElement() : DescriptorAbstract|string|Fqsen|null

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

DescriptorAbstract|string|Fqsen|null

publicsetAbstract(bool $abstract) : void

Parameters

$abstract : bool

publicisAbstract() : bool

Returns

bool

publicsetFinal(bool $final) : void

Parameters

$final : bool

publicisFinal() : bool

Returns

bool

publicsetStatic(bool $static) : void

Parameters

$static : bool

publicisStatic() : bool

Returns

bool

publicsetVisibility(string $visibility) : void

Parameters

$visibility : string

Returns the visibility for this element.

publicgetVisibility() : string

The following values are supported:

  • public
  • protected
  • private

Returns

string

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

Parameters

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

publicaddArgument(string $name, ArgumentDescriptor $argument) : void

Parameters

$name : string
$argument : ArgumentDescriptor

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

Returns

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

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

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\ReturnDescriptor>

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

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\ParamDescriptor>

Sets return type of this method.

publicsetReturnType(Type $returnType) : void

Parameters

$returnType : Type