final class InterfaceElement
Represents an Interface structural element.
| Namespace | BeastBytes\CodPhp\Element |
|---|---|
| Inheritance | BeastBytes\CodPhp\Element\InterfaceElement |
| Uses |
Properties
$ancestors
Ancestors of the element indexed by FQCN.
| Type | Read/Write | Default |
|---|---|---|
| array | Read | [] |
Declared in BeastBytes\CodPhp\Element\ObjectElement
$canHaveMethodTag
true if the element can have a @method tag, false if not.
| Type | Read/Write | Default |
|---|---|---|
| bool | Read |
Declared in BeastBytes\CodPhp\Element\ObjectElement
$canHavePropertyTag
true if the element can have a @property, @property-read, or @property-write tag, false if not.
| Type | Read/Write | Default |
|---|---|---|
| bool | Read |
Declared in BeastBytes\CodPhp\Element\ObjectElement
$constants
Public constants defined in the element. Enum cases are not included - use the cases property.
| Type | Read/Write | Default |
|---|---|---|
| array | Read | [] |
Declared in BeastBytes\CodPhp\Element\ObjectElement
Related
$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
$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
$fqcn
FQCN of the element's object
| Type | Read/Write | Default |
|---|---|---|
| string | Read |
Declared in BeastBytes\CodPhp\Element\ObjectElement
$hasAncestors
true if the element has ancestors, false if not.
| Type | Read/Write | Default |
|---|---|---|
| bool | Read |
Declared in BeastBytes\CodPhp\Element\ObjectElement
Related
$hasConstants
true if the element has public constants, false if not.
| Type | Read/Write | Default |
|---|---|---|
| bool | Read |
Declared in BeastBytes\CodPhp\Element\ObjectElement
Related
$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
$hasMethods
true if the element has methods, false if not.
| Type | Read/Write | Default |
|---|---|---|
| bool | Read |
Declared in BeastBytes\CodPhp\Element\ObjectElement
Related
$hasProperties
true if the element's object has has properties, false if not.
| Type | Read/Write | Default |
|---|---|---|
| bool | Read |
Declared in BeastBytes\CodPhp\Element\InterfaceElement
Related
$hasSubclasses
true if the element has subclasses, false if not.
| Type | Read/Write | Default |
|---|---|---|
| bool | Read |
Declared in BeastBytes\CodPhp\Element\ObjectElement
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
$implementedBy
Object elements that implement the Iterface of this element.
| Type | Read/Write | Default |
|---|---|---|
| array | Read | [] |
Declared in BeastBytes\CodPhp\Element\InterfaceElement
$implementsInterfaces
true if the element implements interfaces, false if not.
| Type | Read/Write | Default |
|---|---|---|
| bool | Read |
Declared in BeastBytes\CodPhp\Element\ObjectElement
$inheritance
The inheritance path for the element; $this and its ancestors.
| Type | Read/Write | Default |
|---|---|---|
| array | Read |
Declared in BeastBytes\CodPhp\Element\ObjectElement
$inheritanceLevel
Inheritence level to show.
| Type | Read/Write | Default |
|---|---|---|
| BeastBytes\CodPhp\InheritanceLevel | Read/Write |
Declared in BeastBytes\CodPhp\Element\ObjectElement
$interfaces
Interfaces implemented by the element.
| Type | Read/Write | Default |
|---|---|---|
| array | Read | [] |
Declared in BeastBytes\CodPhp\Element\ObjectElement
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
$linkTags
@link tags normalised to Link objects.
| Type | Read/Write | Default |
|---|---|---|
| array | Read |
Declared in BeastBytes\CodPhp\Element\Element
Related
$methodTags
Array of @method tags
| Type | Read/Write | Default |
|---|---|---|
| array | Read |
Declared in BeastBytes\CodPhp\Element\ObjectElement
$methods
Methods implemented by the element.
| Type | Read/Write | Default |
|---|---|---|
| array | Read | [] |
Declared in BeastBytes\CodPhp\Element\ObjectElement
Related
$name
Element name.
| Type | Read/Write | Default |
|---|---|---|
| string | Read |
Declared in BeastBytes\CodPhp\Element\ObjectElement
$namespace
Object namespace.
| Type | Read/Write | Default |
|---|---|---|
| string | Read |
Declared in BeastBytes\CodPhp\Element\ObjectElement
$properties
Properties of the element indexed by FQCN.
| Type | Read/Write | Default |
|---|---|---|
| array | Read | [] |
Declared in BeastBytes\CodPhp\Element\InterfaceElement
$propertyReadTags
Array of @property-read tags
| Type | Read/Write | Default |
|---|---|---|
| array | Read |
Declared in BeastBytes\CodPhp\Element\ObjectElement
$propertyTags
Array of @property tags
| Type | Read/Write | Default |
|---|---|---|
| array | Read |
Declared in BeastBytes\CodPhp\Element\ObjectElement
$propertyWriteTags
Array of @property-write tags
| Type | Read/Write | Default |
|---|---|---|
| array | Read |
Declared in BeastBytes\CodPhp\Element\ObjectElement
$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
$subclasses
Subclasses of the element.
| Type | Read/Write | Default |
|---|---|---|
| array | Read | [] |
Declared in BeastBytes\CodPhp\Element\ObjectElement
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
$traits
Traits used by the element.
| Type | Read/Write | Default |
|---|---|---|
| array | Read | [] |
Declared in BeastBytes\CodPhp\Element\ObjectElement
Related
$usesTraits
true if the element uses traits, false if not.
| Type | Read/Write | Default |
|---|---|---|
| bool | Read |
Declared in BeastBytes\CodPhp\Element\ObjectElement
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
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
pathTo()
Returns the relative path from this element to the given element.
| public function pathTo(BeastBytes\CodPhp\Element\ObjectElement|string $destination): string|null | ||
| $destination | BeastBytes\CodPhp\Element\ObjectElement|string | The FQCN or element to get the path to. |
| return | string|null | Relative path to the element from this element or `null` if $element is this element. |
Declared in BeastBytes\CodPhp\Element\ObjectElement
Generated by CodPhp