phpDocumentor

MethodDescriptor extends DescriptorAbstract
in package
implements MethodInterface, VisibilityInterface

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

Interfaces, Classes and Traits

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

Table of Contents

$abstract  : bool
$arguments  : Collection<string|int, ArgumentDescriptor>
$description  : DescriptionDescriptor|null
$errors  : Collection<string|int, Error>
$fileDescriptor  : FileDescriptor|null
$final  : bool
$fqsen  : Fqsen
$inheritedElement  : DescriptorAbstract|null
$line  : int
$name  : string
$namespace  : NamespaceDescriptor|string
$package  : PackageDescriptor|string
$parent  : ClassDescriptor|InterfaceDescriptor|TraitDescriptor|null
$static  : bool
$summary  : string
$tags  : Collection<string|int, Collection<string|int, TagDescriptor>>
$visibility  : string
$returnType  : Type
__call()  : Collection<string|int, TagDescriptor>|null
Dynamically constructs a set of getters to retrieve tag (collections) with.
__construct()  : mixed
Initializes the all properties representing a collection with a new Collection object.
__toString()  : string
Represents this object by its unique identifier, the Fully Qualified Structural Element Name.
addArgument()  : void
getArguments()  : Collection<string|int, ArgumentDescriptor>
getAuthor()  : Collection<string|int, AuthorDescriptor>
getCopyright()  : Collection<string|int, TagDescriptor>
Returns the copyrights for this element.
getDescription()  : DescriptionDescriptor|null
Returns the description for this element.
getErrors()  : Collection<string|int, Error>
Returns all errors that occur in this element.
getFile()  : FileDescriptor
Returns the file associated with the parent class, interface or trait.
getFullyQualifiedStructuralElementName()  : Fqsen|null
Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
getInheritedElement()  : DescriptorAbstract|string|Fqsen|null
Returns the Method from which this method should inherit its information, if any.
getLine()  : int
Returns the line number where the definition for this element can be found.
getName()  : string
Returns the local name for this element.
getNamespace()  : NamespaceDescriptor|string
Returns the namespace for this element (defaults to global "\")
getPackage()  : PackageDescriptor|null
Returns the package name for this element.
getParam()  : Collection<string|int, ParamDescriptor>
getParent()  : ClassDescriptor|InterfaceDescriptor|TraitDescriptor|null
getPath()  : string
Returns the path to the file containing this element relative to the project's root.
getResponse()  : ReturnDescriptor
getReturn()  : Collection<string|int, ReturnDescriptor>
getSummary()  : string
Returns the summary which describes this element.
getTags()  : Collection<string|int, Collection<string|int, TagDescriptor>>
Returns the tags associated with this element.
getVersion()  : Collection<string|int, VersionDescriptor>
Returns the versions for this element.
getVisibility()  : string
Returns the visibility for this element.
isAbstract()  : bool
isDeprecated()  : bool
Checks whether this element is deprecated.
isFinal()  : bool
isStatic()  : bool
setAbstract()  : void
setArguments()  : void
setFinal()  : void
setParent()  : void
setReturnType()  : void
Sets return type of this method.
setStatic()  : void
setVisibility()  : void

Properties

$fqsen

protected Fqsen $fqsen

Fully Qualified Structural Element Name; the FQCN including method, property or constant name

$summary

protected string $summary = ''

A summary describing the function of this element in short.

Methods

__call()

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

public __call(string $name, array<string|int, mixed> $arguments) : Collection<string|int, TagDescriptor>|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<string|int, mixed>
Return values
Collection<string|int, TagDescriptor>|null

__construct()

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

public __construct() : mixed
Return values
mixed

__toString()

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

public __toString() : string
Return values
string

getFullyQualifiedStructuralElementName()

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

public getFullyQualifiedStructuralElementName() : Fqsen|null
Return values
Fqsen|null

getInheritedElement()

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

public getInheritedElement() : 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.
Return values
DescriptorAbstract|string|Fqsen|null

getLine()

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

public getLine() : int
Return values
int

getName()

Returns the local name for this element.

public getName() : string
Return values
string

getPath()

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

public getPath() : string
Return values
string

getSummary()

Returns the summary which describes this element.

public getSummary() : string

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

Return values
string

getVisibility()

Returns the visibility for this element.

public getVisibility() : string

The following values are supported:

  • public
  • protected
  • private
Return values
string

isDeprecated()

Checks whether this element is deprecated.

public isDeprecated() : bool
Return values
bool

setAbstract()

public setAbstract(bool $abstract) : void
Parameters
$abstract : bool
Return values
void

setFinal()

public setFinal(bool $final) : void
Parameters
$final : bool
Return values
void

setReturnType()

Sets return type of this method.

public setReturnType(Type $returnType) : void
Parameters
$returnType : Type
Return values
void

setStatic()

public setStatic(bool $static) : void
Parameters
$static : bool
Return values
void

setVisibility()

public setVisibility(string $visibility) : void
Parameters
$visibility : string
Return values
void

Search results