phpDocumentor
\
phpDocumentor
Compiler
Linker
Pass
Configuration
Definition
Exception
Console
Command
Project
DependencyInjection
Descriptor
Builder
Reflector
Docblock
Tags
Cache
DocBlock
Example
Exception
Filter
Interfaces
ProjectDescriptor
Query
TableOfContents
Tag
BaseTypes
Traits
Validation
ValueObjects
Event
Guides
DependencyInjection
Handlers
References
Resolver
Php
Parser
Cache
Event
Exception
Middleware
Pipeline
Stage
Cache
Parser
Transformer
Event
Router
Template
Writer
Exception
Graph
Twig
LinkRenderer

\phpDocumentor\DescriptorInterfaceDescriptor

Descriptor representing an Interface.

Summary

Methods
Properties
Constants
__construct()
getErrors()
__call()
__toString()
getFullyQualifiedStructuralElementName()
getName()
getNamespace()
getPackage()
getSummary()
setDescription()
getDescription()
getTags()
getAuthor()
getVersion()
getCopyright()
isDeprecated()
getPath()
getFile()
getLine()
getStartLocation()
getEndLocation()
getInheritedElement()
setParent()
getParent()
setConstants()
getConstants()
getInheritedConstants()
setMethods()
getMethods()
getInheritedMethods()
setPackage()
No public properties found
No constants found
No protected methods found
$fqsen
$name
$namespace
$package
$summary
$description
$tags
$fileDescriptor
$line
$startLocation
$endLocation
$errors
$inheritedElement
$parents
$constants
$methods
N/A
No private methods found
No private properties found
N/A

Properties

$fqsen

$fqsen : ?\phpDocumentor\Reflection\Fqsen

Type

?\phpDocumentor\Reflection\Fqsen — Fully Qualified Structural Element Name; the FQCN including method, property or constant name

$name

$name : string

Type

string

$namespace

$namespace : \phpDocumentor\Descriptor\Interfaces\NamespaceInterface|string

Type

\phpDocumentor\Descriptor\Interfaces\NamespaceInterface|string — The namespace for this element

$package

$package : \phpDocumentor\Descriptor\Interfaces\PackageInterface|string

Type

\phpDocumentor\Descriptor\Interfaces\PackageInterface|string — The package with which this element is associated

$summary

$summary : string

Type

string — A summary describing the function of this element in short.

$description

$description : ?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Type

?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

$tags

$tags : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>>

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>> — The tags associated with this element.

$fileDescriptor

$fileDescriptor : \phpDocumentor\Descriptor\Interfaces\FileInterface|null

Type

\phpDocumentor\Descriptor\Interfaces\FileInterface|null — The file to which this element belongs; if applicable

$line

$line : int

Type

int — The line number on which this element occurs.

$startLocation

$startLocation : ?\phpDocumentor\Reflection\Location

Type

?\phpDocumentor\Reflection\Location

$endLocation

$endLocation : ?\phpDocumentor\Reflection\Location

Type

?\phpDocumentor\Reflection\Location

$errors

$errors : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> — A collection of errors found during filtering.

$inheritedElement

$inheritedElement : \phpDocumentor\Descriptor\Interfaces\ElementInterface|string|\phpDocumentor\Reflection\Fqsen|null

Type

\phpDocumentor\Descriptor\Interfaces\ElementInterface|string|\phpDocumentor\Reflection\Fqsen|null — the element from which to inherit information in this element

$parents

$parents : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\InterfaceInterface|\phpDocumentor\Reflection\Fqsen>

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\InterfaceInterface|\phpDocumentor\Reflection\Fqsen> —

$constants

$constants : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ConstantInterface>

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ConstantInterface> —

$methods

$methods : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\MethodInterface>

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\MethodInterface> —

Methods

__construct()

__construct() : mixed

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

Returns

mixed —

getErrors()

getErrors() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>

Returns all errors associated with this tag.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> —

__call()

__call(string  $name, array  $arguments) : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>|null

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

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

string $name
array $arguments

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>|null —

__toString()

__toString() : string

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

Returns

string —

getFullyQualifiedStructuralElementName()

getFullyQualifiedStructuralElementName() : ?\phpDocumentor\Reflection\Fqsen

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

Returns

?\phpDocumentor\Reflection\Fqsen —

getName()

getName() : string

Returns the name for this element.

Returns

string —

getNamespace()

getNamespace() : \phpDocumentor\Descriptor\Interfaces\NamespaceInterface|string

Returns the namespace for this element (defaults to global "\")

Returns

\phpDocumentor\Descriptor\Interfaces\NamespaceInterface|string —

getPackage()

getPackage() : ?\phpDocumentor\Descriptor\Interfaces\PackageInterface

Returns the package name for this element.

Returns

?\phpDocumentor\Descriptor\Interfaces\PackageInterface —

getSummary()

getSummary() : string

Returns the summary which describes this element.

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

Returns

string —

setDescription()

setDescription(?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor  $description) : void

Sets a description or none to inherit from a parent.

Parameters

?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor $description

getDescription()

getDescription() : \phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Returns the description for this element.

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

Returns

\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor —

getTags()

getTags() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>>

Returns the tags associated with this element.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>> —

getAuthor()

getAuthor() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\AuthorDescriptor>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\AuthorDescriptor> —

getVersion()

getVersion() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor>

Returns the versions for this element.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor> —

getCopyright()

getCopyright() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>

Returns the copyrights for this element.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor> —

isDeprecated()

isDeprecated() : bool

Checks whether this element is deprecated.

Returns

bool —

getPath()

getPath() : string

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

Returns

string —

getFile()

getFile() : ?\phpDocumentor\Descriptor\Interfaces\FileInterface

Returns the file in which this element resides or null in case the element is not bound to a file.

.

Returns

?\phpDocumentor\Descriptor\Interfaces\FileInterface —

getLine()

getLine() : int

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

Returns

int —

getStartLocation()

getStartLocation() : ?\phpDocumentor\Reflection\Location

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

Returns

?\phpDocumentor\Reflection\Location —

getEndLocation()

getEndLocation() : ?\phpDocumentor\Reflection\Location

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

Returns

?\phpDocumentor\Reflection\Location —

getInheritedElement()

getInheritedElement() : \phpDocumentor\Descriptor\Interfaces\InterfaceInterface|\phpDocumentor\Reflection\Fqsen|null

Returns

\phpDocumentor\Descriptor\Interfaces\InterfaceInterface|\phpDocumentor\Reflection\Fqsen|null —

setParent()

setParent(\phpDocumentor\Descriptor\Collection  $parents) : void

Sets the parent for this Descriptor.

Parameters

\phpDocumentor\Descriptor\Collection $parents

getParent()

getParent() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\InterfaceInterface|\phpDocumentor\Reflection\Fqsen>

Returns the parent for this descriptor.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\InterfaceInterface|\phpDocumentor\Reflection\Fqsen> —

setConstants()

setConstants(\phpDocumentor\Descriptor\Collection  $constants) : void

Sets the constants associated with this interface.

Parameters

\phpDocumentor\Descriptor\Collection $constants

getConstants()

getConstants() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ConstantInterface>

Returns the constants associated with this interface.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ConstantInterface> —

getInheritedConstants()

getInheritedConstants() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ConstantInterface>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ConstantInterface> —

setMethods()

setMethods(\phpDocumentor\Descriptor\Collection  $methods) : void

Sets the methods belonging to this interface.

Parameters

\phpDocumentor\Descriptor\Collection $methods

getMethods()

getMethods() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\MethodInterface>

Returns the methods belonging to this interface.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\MethodInterface> —

getInheritedMethods()

getInheritedMethods() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\MethodInterface>

Returns a list of all methods that were inherited from parent interfaces.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\MethodInterface> —

setPackage()

setPackage(mixed  $package) : void

Parameters

mixed $package