final class ParameterElement
Represents a Parameter structural element.
| Namespace | BeastBytes\CodPhp\Element |
|---|---|
| Inheritance | BeastBytes\CodPhp\Element\ParameterElement |
| Uses | BeastBytes\CodPhp\Element\DefaultValueTrait |
Properties
$allowsNull
true if the type allows null, false if not.
| Type | Read/Write | Default |
|---|---|---|
| bool | Read |
Declared in BeastBytes\CodPhp\Element\ParameterElement
$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
$defaultValue
String representation of the default value of a parameter or property element or null if the property does not have a default value.
| Type | Read/Write | Default |
|---|---|---|
| string|null | Read |
Declared in BeastBytes\CodPhp\Element\ParameterElement
Related
$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
Parameter description.
| Type | Read/Write | Default |
|---|---|---|
| string | Read |
Declared in BeastBytes\CodPhp\Element\ParameterElement
$elementType
Type of element.
| Type | Read/Write | Default |
|---|---|---|
| string | Read |
Declared in BeastBytes\CodPhp\Element\Element
$hasDefaultValue
true if the parameter has a default value, false if not.
| Type | Read/Write | Default |
|---|---|---|
| bool | Read |
Declared in BeastBytes\CodPhp\Element\ParameterElement
$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
$hasSummary
true if the element has a summary, false if not.
| Type | Read/Write | Default |
|---|---|---|
| bool | Read |
Declared in BeastBytes\CodPhp\Element\Element
Related
$isInApi
true if the element is in the API, false if not.
| Type | Read/Write | Default |
|---|---|---|
| bool | Read |
Declared in BeastBytes\CodPhp\Element\Element
$isPassedByReference
true if the parameter is passed by reference, false if not.
| Type | Read/Write | Default |
|---|---|---|
| bool | Read |
Declared in BeastBytes\CodPhp\Element\ParameterElement
$isVariadic
true if the parameter is variadic, false if not.
| Type | Read/Write | Default |
|---|---|---|
| bool | Read |
Declared in BeastBytes\CodPhp\Element\ParameterElement
$linkTags
@link tags normalised to Link objects.
| Type | Read/Write | Default |
|---|---|---|
| array | Read |
Declared in BeastBytes\CodPhp\Element\Element
Related
$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
$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
$type
Element type.
| Type | Read/Write | Default |
|---|---|---|
| ReflectionType|null | Read |
Declared in BeastBytes\CodPhp\Element\ParameterElement
$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
__construct()
Create a parameter element.
| public function __construct(ReflectionParameter $reflector, string $description) | ||
| $reflector | ReflectionParameter | Para |
| $description | string | Parameter description |
Declared in BeastBytes\CodPhp\Element\ParameterElement
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
getTag()
Returns the content of the specifies tag or null if the element does not have the specified tag.
| public function getTag(string $name): string|null | ||
| $name | string | Name of the tag. |
| return | string|null | Content of the specifies tag or `null` if the element does not have the specified tag. |
Declared in BeastBytes\CodPhp\Element\Element
hasTag()
Returns a value indicating whether the element has the specified tag.
| public function hasTag(string $name): bool | ||
| $name | string | Name of the tag. |
| return | bool | `true` if the element has the specified tag, `false` if not. |
Declared in BeastBytes\CodPhp\Element\Element
Generated by CodPhp