phpDocumentor

MethodInterface extends ElementInterface, TypeInterface, InheritsFromElement, ChildInterface, AttributedInterface, VisibilityInterface

Describes the public interface of the description for a method.

Table of Contents

Methods

__toString()  : string
addAttribute()  : void
getArguments()  : Collection<string|int, ArgumentInterface>
getAttributes()  : Collection<string|int, AttributeInterface>
getDescription()  : DescriptionDescriptor
Returns the description for this element.
getEndLocation()  : Location|null
Returns the end location where the definition for this element can be found.
getErrors()  : Collection<string|int, Error>
getFullyQualifiedStructuralElementName()  : Fqsen|null
Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
getInheritedElement()  : ElementInterface|string|Fqsen|null
Returns the element from which this element inherits, or null if it doesn't inherit any information.
getLine()  : int
Returns the line number where this element may be found.
getName()  : string
Returns the local name for this element.
getNamespace()  : NamespaceInterface|string
Returns the namespace for this element (defaults to global "\")
getPackage()  : PackageInterface|null
Returns the package name for this element.
getParam()  : Collection<string|int, ParamDescriptor>
getParent()  : ElementInterface|Fqsen|string|null
Returns the parent for this descriptor.
getPath()  : string
Returns the file location for this element relative to the project root.
getReturn()  : Collection<string|int, ReturnDescriptor>
getSummary()  : string
Returns the summary describing this element.
getTags()  : Collection<string|int, Collection<string|int, TagInterface>>
Returns all tags associated with this element.
getVisibility()  : Visibility
Returns the visibility for this element.
isAbstract()  : bool
isFinal()  : bool
isStatic()  : bool
setAbstract()  : void
setDescription()  : void
Sets a longer description for this element.
setFinal()  : void
setFullyQualifiedStructuralElementName()  : void
Sets the Fully Qualified Structural Element Name (FQSEN) for this element.
setLocation()  : void
Sets the file and location for this element.
setName()  : void
Sets the local name for this element.
setParent()  : void
Sets the parent for this Descriptor.
setStatic()  : void
setSummary()  : void
Sets a summary describing this element.
setVisibility()  : void

Methods

__toString()

public __toString() : string
Return values
string

getDescription()

Returns the description for this element.

public getDescription() : DescriptionDescriptor
See More

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

Return values
DescriptionDescriptor

getEndLocation()

Returns the end location where the definition for this element can be found.

public getEndLocation() : Location|null
Return values
Location|null

getFullyQualifiedStructuralElementName()

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

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

getLine()

Returns the line number where this element may be found.

public getLine() : int
Tags
see
getPath()

to find out in which file this element is found.

Return values
int

getName()

Returns the local name for this element.

public getName() : string
Return values
string

getPath()

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

public getPath() : string
Return values
string

getSummary()

Returns the summary describing this element.

public getSummary() : string
Return values
string

setAbstract()

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

setFinal()

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

setFullyQualifiedStructuralElementName()

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

public setFullyQualifiedStructuralElementName(Fqsen $name) : void
Parameters
$name : Fqsen

setName()

Sets the local name for this element.

public setName(string $name) : void
Parameters
$name : string

setStatic()

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

setSummary()

Sets a summary describing this element.

public setSummary(string $summary) : void
Parameters
$summary : string
On this page

Search results