phpDocumentor

InterfaceDescriptor extends DescriptorAbstract
in package
implements InterfaceInterface

Descriptor representing an Interface.

Table of Contents

Interfaces

InterfaceInterface
Represents the public interface for an interface descriptor.

Properties

$constants  : Collection<string|int, ConstantInterface>
$description  : DescriptionDescriptor|null
$endLocation  : Location|null
$errors  : Collection<string|int, Error>
$fileDescriptor  : FileInterface|null
$fqsen  : Fqsen|null
$inheritedElement  : ElementInterface|string|Fqsen|null
$line  : int
$methods  : Collection<string|int, MethodInterface>
$name  : string
$namespace  : NamespaceInterface|string
$package  : PackageInterface|string
$parents  : Collection<string|int, InterfaceInterface|Fqsen>
$startLocation  : Location|null
$summary  : string
$tags  : Collection<string|int, Collection<string|int, TagDescriptor>>
$metadata  : array<string|int, Metadata>

Methods

__call()  : Collection<string|int, TagDescriptor>|null
Dynamically constructs a set of getters to retrieve tag (collections) with.
__construct()  : mixed
Initializes this descriptor.
__toString()  : string
Represents this object by its unique identifier, the Fully Qualified Structural Element Name.
getAuthor()  : Collection<string|int, AuthorDescriptor>
getConstants()  : Collection<string|int, ConstantInterface>
Returns the constants associated with this interface.
getCopyright()  : Collection<string|int, TagDescriptor>
Returns the copyrights for this element.
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>
Returns all errors that occur in this element.
getFile()  : FileInterface|null
Returns the file in which this element resides or null in case the element is not bound to a file.
getFullyQualifiedStructuralElementName()  : Fqsen|null
Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
getInheritedConstants()  : Collection<string|int, ConstantInterface>
getInheritedElement()  : ElementInterface|string|Fqsen|null
Returns the element from which this element inherits, or null if it doesn't inherit any information.
getInheritedMethods()  : Collection<string|int, MethodInterface>
Returns a list of all methods that were inherited from parent interfaces.
getLine()  : int
Returns the line number where the definition for this element can be found.
getMetadata()  : array<string|int, Metadata>
getMethods()  : Collection<string|int, MethodInterface>
Returns the methods belonging to this interface.
getName()  : string
Returns the 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.
getParent()  : Collection<string|int, InterfaceInterface|Fqsen>
Returns the parent for this descriptor.
getPath()  : string
Returns the path to the file containing this element relative to the project's root.
getStartLocation()  : Location|null
Returns the start location where the definition for this element can be found.
getSummary()  : string
Returns the summary which describes this element.
getTags()  : Collection<string|int, Collection<string|int, TagDescriptor>>
Returns the tags associated with this element.
getVersion()  : Collection<string|int, VersionDescriptor>
Returns the versions for this element.
isDeprecated()  : bool
Checks whether this element is deprecated.
setConstants()  : void
Sets the constants associated with this interface.
setDescription()  : void
Sets a description or none to inherit from a parent.
setMetadata()  : void
setMethods()  : void
Sets the methods belonging to this interface.
setPackage()  : void
setParent()  : void
Sets the parent for this Descriptor.

Properties

$endLocation

protected Location|null $endLocation = null

$fileDescriptor

protected FileInterface|null $fileDescriptor = null

The file to which this element belongs; if applicable

$fqsen

protected Fqsen|null $fqsen = null

Fully Qualified Structural Element Name; the FQCN including method, property or constant name

$inheritedElement

protected ElementInterface|string|Fqsen|null $inheritedElement = null

the element from which to inherit information in this element

$line

protected int $line = 0

The line number on which this element occurs.

$startLocation

protected Location|null $startLocation = null

$summary

protected string $summary = ''

A summary describing the function of this element in short.

$metadata

private array<string|int, Metadata> $metadata = []

Methods

__call()

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

public __call(string $name, array<string|int, mixed> $arguments) : Collection<string|int, TagDescriptor>|null

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
$name : string
$arguments : array<string|int, mixed>
Return values
Collection<string|int, TagDescriptor>|null

__toString()

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

public __toString() : string
Return values
string

getEndLocation()

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

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

getFile()

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

public getFile() : FileInterface|null

.

Return values
FileInterface|null

getFullyQualifiedStructuralElementName()

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

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

getInheritedElement()

Returns the element from which this element inherits, or null if it doesn't inherit any information.

public getInheritedElement() : ElementInterface|string|Fqsen|null

This method is usually overridden in consuming classes with the determination how that class should resolve inheritance. This is a placeholder function for those classes who need a simple way to provide inheritance.

Return values
ElementInterface|string|Fqsen|null

getLine()

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

public getLine() : int
Tags
deprecated

use getStartLocation()->getLineNumber() instead

Return values
int

getMetadata()

public getMetadata() : array<string|int, Metadata>
Return values
array<string|int, Metadata>

getName()

Returns the name for this element.

public getName() : string
Return values
string

getPath()

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

public getPath() : string
Return values
string

getStartLocation()

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

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

getSummary()

Returns the summary which describes this element.

public getSummary() : string

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

Return values
string

isDeprecated()

Checks whether this element is deprecated.

public isDeprecated() : bool
Return values
bool

setMetadata()

public setMetadata(array<string|int, Metadata> $metadata) : void
Parameters
$metadata : array<string|int, Metadata>

setPackage()

public setPackage(mixed $package) : void
Parameters
$package : mixed
Tags
inheritDoc 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results