final class MethodElement
Represents a Method structural element.
| Namespace | BeastBytes\CodPhp\Element |
|---|---|
| Inheritance | BeastBytes\CodPhp\Element\MethodElement |
| Uses | BeastBytes\CodPhp\Element\DeclaringClassTrait |
Properties
$copyright
Element copyright or null if the element does not have a @copyright tag.
| Type | Read/Write | Default |
|---|---|---|
| string|null | Read |
Declared in BeastBytes\CodPhp\Element\Element
Related
$declaringClass
Declaring class of the element.
| Type | Read/Write | Default |
|---|---|---|
| BeastBytes\CodPhp\Element\ClassElement | Read |
Declared in BeastBytes\CodPhp\Element\MethodElement
$deprecationNotice
Element deprecation notice or null if the element does not have a @deprecated tag.
| Type | Read/Write | Default |
|---|---|---|
| string|null | Read |
Declared in BeastBytes\CodPhp\Element\Element
Related
$description
Element description or null if the element does not have a description.
| Type | Read/Write | Default |
|---|---|---|
| string|null | Read |
Declared in BeastBytes\CodPhp\Element\Element
Related
$elementType
Type of element.
| Type | Read/Write | Default |
|---|---|---|
| string | Read |
Declared in BeastBytes\CodPhp\Element\Element
$hasDescription
true if the element has a description, false if not.
| Type | Read/Write | Default |
|---|---|---|
| bool | Read |
Declared in BeastBytes\CodPhp\Element\Element
Related
$hasDocBlock
true if the element has a docBlock, false if not.
| Type | Read/Write | Default |
|---|---|---|
| bool | Read |
Declared in BeastBytes\CodPhp\Element\Element
Related
$hasParameters
true if the method has parameters, false if not.
| Type | Read/Write | Default |
|---|---|---|
| bool | Read |
Declared in BeastBytes\CodPhp\Element\MethodElement
$hasReturnType
true if the method has a return type, false if not.
| Type | Read/Write | Default |
|---|---|---|
| bool | Read |
Declared in BeastBytes\CodPhp\Element\MethodElement
$hasSummary
true if the element has a summary, false if not.
| Type | Read/Write | Default |
|---|---|---|
| bool | Read |
Declared in BeastBytes\CodPhp\Element\Element
Related
$isConstructor
true if the method is a contructor, false if not
| Type | Read/Write | Default |
|---|---|---|
| bool | Read |
Declared in BeastBytes\CodPhp\Element\MethodElement
$isDestructor
true if the method is a destructor, false if not
| Type | Read/Write | Default |
|---|---|---|
| bool | Read |
Declared in BeastBytes\CodPhp\Element\MethodElement
$isInApi
true if the element is in the API, false if not.
| Type | Read/Write | Default |
|---|---|---|
| bool | Read |
Declared in BeastBytes\CodPhp\Element\Element
$linkTags
@link tags normalised to Link objects.
| Type | Read/Write | Default |
|---|---|---|
| array | Read |
Declared in BeastBytes\CodPhp\Element\Element
Related
$modifiers
Element modifiers
| Type | Read/Write | Default |
|---|---|---|
| array | Read |
Declared in BeastBytes\CodPhp\Element\MethodElement
$name
Name of the element.
| Type | Read/Write | Default |
|---|---|---|
| string | Read |
Declared in BeastBytes\CodPhp\Element\Element
$namespace
Namespace of the element.
| Type | Read/Write | Default |
|---|---|---|
| string|null | Read |
Declared in BeastBytes\CodPhp\Element\Element
$parameters
Method parameters indexed by name.
| Type | Read/Write | Default |
|---|---|---|
| array | Read | [] |
Declared in BeastBytes\CodPhp\Element\MethodElement
$returnType
Method return type or null if the method does not have a return type.
| Type | Read/Write | Default |
|---|---|---|
| ReflectionType|null | Read |
Declared in BeastBytes\CodPhp\Element\MethodElement
$returnValueDescription
Method return value description.
| Type | Read/Write | Default |
|---|---|---|
| string | Read |
Declared in BeastBytes\CodPhp\Element\MethodElement
$returnsReference
true if the method returns a reference, false if not.
| Type | Read/Write | Default |
|---|---|---|
| bool | Read |
Declared in BeastBytes\CodPhp\Element\MethodElement
$rootNamespace
Root namespace being documented.
| Type | Read/Write | Default |
|---|---|---|
| string | Read/Write |
Declared in BeastBytes\CodPhp\Element\Element
$seeTags
@see tags normalised to Link objects.
| Type | Read/Write | Default |
|---|---|---|
| array | Read |
Declared in BeastBytes\CodPhp\Element\Element
Related
$since
Content of the element's @since tag, or null if the element does not have a @since tag.
| Type | Read/Write | Default |
|---|---|---|
| string|null | Read |
Declared in BeastBytes\CodPhp\Element\Element
Related
$summary
Element summary or null if the element does not have a summary.
| Type | Read/Write | Default |
|---|---|---|
| string|null | Read |
Declared in BeastBytes\CodPhp\Element\Element
Related
$throwsException
true if the element throws an exception, false if not.
| Type | Read/Write | Default |
|---|---|---|
| bool | Read |
Declared in BeastBytes\CodPhp\Element\MethodElement
Related
$throwsTags
Array of Throws tags.
| Type | Read/Write | Default |
|---|---|---|
| array | Read |
Declared in BeastBytes\CodPhp\Element\MethodElement
Related
$version
Content of the element's @version tag, or null if the element does not have a @version tag.
| Type | Read/Write | Default |
|---|---|---|
| string|null | Read |
Declared in BeastBytes\CodPhp\Element\Element
Related
Methods
getElements()
Returns object elements, optionally filtered by element type.
| public function getElements(string|null $type = null): array | ||
| $type | string|null | Type (FQCN) of element to return; `null` returns all elements. |
| return | array | Object elements. |
Declared in BeastBytes\CodPhp\Element\Element
hasTag()
Returns a value indicating whether the element has the specified tag.
| public function hasTag(string $tag): bool | ||
| $tag | string | Name of the tag. |
| return | bool | `true` if the element has the specified taf, `false` if not. |
Declared in BeastBytes\CodPhp\Element\Element
Generated by CodPhp