Interface_
in package
implements
Element, MetaDataContainer
Uses
MetadataContainer
Descriptor representing an Interface.
Interfaces, Classes and Traits
- Element
- Interface for Api Elements
- MetaDataContainer
Table of Contents
- $constants : array<string|int, mixed>
- $docBlock : DocBlock|null
- $endLocation : Location
- $fqsen : Fqsen
- $location : Location
- $methods : array<string|int, mixed>
- $parents : array<string|int, mixed>
- __construct() : mixed
- Initializes the object.
- addConstant() : void
- Add constant to this interface.
- addMethod() : void
- Add method to this interface.
- getConstants() : array<string|int, Constant>
- Returns the constants of this interface.
- getDocBlock() : DocBlock|null
- Returns the DocBlock of this interface if available.
- getEndLocation() : Location
- getFqsen() : Fqsen
- Returns the Fqsen of the element.
- getLocation() : Location
- getMethods() : array<string|int, Method>
- Returns the methods in this interface.
- getName() : string
- Returns the name of the element.
- getParents() : array<string|int, Fqsen>
- Returns the Fqsen of the interfaces this interface is extending.
Properties
$constants
private
array<string|int, mixed>
$constants
= []
$docBlock
private
DocBlock|null
$docBlock
$endLocation
private
Location
$endLocation
$fqsen
private
Fqsen
$fqsen
Full Qualified Structural Element Name
$location
private
Location
$location
$methods
private
array<string|int, mixed>
$methods
= []
$parents
private
array<string|int, mixed>
$parents
= []
Methods
__construct()
Initializes the object.
public
__construct(Fqsen $fqsen[, array<string|int, Fqsen> $parents = [] ][, DocBlock|null $docBlock = null ][, Location|null $location = null ][, Location|null $endLocation = null ]) : mixed
Parameters
- $fqsen : Fqsen
- $parents : array<string|int, Fqsen> = []
- $docBlock : DocBlock|null = null
- $location : Location|null = null
- $endLocation : Location|null = null
Return values
mixed —addConstant()
Add constant to this interface.
public
addConstant(Constant $constant) : void
Parameters
- $constant : Constant
Return values
void —addMethod()
Add method to this interface.
public
addMethod(Method $method) : void
Parameters
- $method : Method
Return values
void —getConstants()
Returns the constants of this interface.
public
getConstants() : array<string|int, Constant>
Return values
array<string|int, Constant> —getDocBlock()
Returns the DocBlock of this interface if available.
public
getDocBlock() : DocBlock|null
Return values
DocBlock|null —getEndLocation()
public
getEndLocation() : Location
Return values
Location —getFqsen()
Returns the Fqsen of the element.
public
getFqsen() : Fqsen
Return values
Fqsen —getLocation()
public
getLocation() : Location
Return values
Location —getMethods()
Returns the methods in this interface.
public
getMethods() : array<string|int, Method>
Return values
array<string|int, Method> —getName()
Returns the name of the element.
public
getName() : string
Return values
string —getParents()
Returns the Fqsen of the interfaces this interface is extending.
public
getParents() : array<string|int, Fqsen>