InterfaceInterface
extends
ElementInterface, TypeInterface
in
Represents the public interface for an interface descriptor.
Table of Contents
- __toString() : string
- getConstants() : Collection<string|int, ConstantDescriptor>
- Returns the constants associated with this interface.
- getDescription() : DescriptionDescriptor|null
- Returns a longer description for this element.
- getFullyQualifiedStructuralElementName() : Fqsen|null
- Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
- getInheritedMethods() : Collection<string|int, MethodDescriptor>
- Returns a list of all methods that were inherited from parent interfaces.
- getLine() : int
- Returns the line number where this element may be found.
- getMethods() : Collection<string|int, MethodDescriptor>
- Returns the methods belonging to this interface.
- getName() : string
- Returns the local name for this element.
- getParent() : Collection<string|int, \phpDocumentor\Descriptor\InterfaceDescriptor|\phpDocumentor\Reflection\Fqsen>
- Returns the parent for this descriptor.
- getPath() : string
- Returns the file location for this element relative to the project root.
- getSummary() : string
- Returns the summary describing this element.
- getTags() : Collection<string|int, Collection<string|int, TagDescriptor>>
- Returns all tags associated with this element.
- setConstants() : void
- Sets the constants associated with this interface.
- setDescription() : void
- Sets a longer description for this element.
- setFullyQualifiedStructuralElementName() : void
- Sets the Fully Qualified Structural Element Name (FQSEN) for this element.
- setLocation() : void
- Sets the file and location for this element.
- setMethods() : void
- Sets the methods belonging to this interface.
- setName() : void
- Sets the local name for this element.
- setParent() : void
- Sets the parent for this Descriptor.
- setSummary() : void
- Sets a summary describing this element.
Methods
__toString()
public
__toString() : string
Return values
string —getConstants()
Returns the constants associated with this interface.
public
getConstants() : Collection<string|int, ConstantDescriptor>
Return values
Collection<string|int, ConstantDescriptor> —getDescription()
Returns a longer description for this element.
public
getDescription() : DescriptionDescriptor|null
Return values
DescriptionDescriptor|null —getFullyQualifiedStructuralElementName()
Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
public
getFullyQualifiedStructuralElementName() : Fqsen|null
Return values
Fqsen|null —getInheritedMethods()
Returns a list of all methods that were inherited from parent interfaces.
public
getInheritedMethods() : Collection<string|int, MethodDescriptor>
Return values
Collection<string|int, MethodDescriptor> —getLine()
Returns the line number where this element may be found.
public
getLine() : int
Tags
Return values
int —getMethods()
Returns the methods belonging to this interface.
public
getMethods() : Collection<string|int, MethodDescriptor>
Return values
Collection<string|int, MethodDescriptor> —getName()
Returns the local name for this element.
public
getName() : string
Return values
string —getParent()
Returns the parent for this descriptor.
public
getParent() : Collection<string|int, \phpDocumentor\Descriptor\InterfaceDescriptor|\phpDocumentor\Reflection\Fqsen>
Return values
Collection<string|int, \phpDocumentor\Descriptor\InterfaceDescriptor|\phpDocumentor\Reflection\Fqsen> —getPath()
Returns the file location for this element relative to the project root.
public
getPath() : string
Return values
string —getSummary()
Returns the summary describing this element.
public
getSummary() : string
Return values
string —getTags()
Returns all tags associated with this element.
public
getTags() : Collection<string|int, Collection<string|int, TagDescriptor>>
Return values
Collection<string|int, Collection<string|int, TagDescriptor>> —setConstants()
Sets the constants associated with this interface.
public
setConstants(Collection<string|int, ConstantDescriptor> $constants) : void
Parameters
- $constants : Collection<string|int, ConstantDescriptor>
Return values
void —setDescription()
Sets a longer description for this element.
public
setDescription(DescriptionDescriptor $description) : void
Parameters
- $description : DescriptionDescriptor
Return values
void —setFullyQualifiedStructuralElementName()
Sets the Fully Qualified Structural Element Name (FQSEN) for this element.
public
setFullyQualifiedStructuralElementName(Fqsen $name) : void
Parameters
- $name : Fqsen
Return values
void —setLocation()
Sets the file and location for this element.
public
setLocation(FileDescriptor $file, int $line) : void
Parameters
- $file : FileDescriptor
- $line : int
Return values
void —setMethods()
Sets the methods belonging to this interface.
public
setMethods(Collection<string|int, MethodDescriptor> $methods) : void
Parameters
- $methods : Collection<string|int, MethodDescriptor>
Return values
void —setName()
Sets the local name for this element.
public
setName(string $name) : void
Parameters
- $name : string
Return values
void —setParent()
Sets the parent for this Descriptor.
public
setParent(Collection<string|int, \phpDocumentor\Descriptor\InterfaceDescriptor|\phpDocumentor\Reflection\Fqsen> $parents) : void
Parameters
- $parents : Collection<string|int, \phpDocumentor\Descriptor\InterfaceDescriptor|\phpDocumentor\Reflection\Fqsen>
Return values
void —setSummary()
Sets a summary describing this element.
public
setSummary(string $summary) : void
Parameters
- $summary : string