InterfaceInterface
extends ElementInterface, TypeInterfaceRepresents the public interface for an interface descriptor.
Methods
setFullyQualifiedStructuralElementName() inherited
Sets the Fully Qualified Structural Element Name (FQSEN) for this element.
publicsetFullyQualifiedStructuralElementName(Fqsen $name) : void
getFullyQualifiedStructuralElementName() inherited
Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
publicgetFullyQualifiedStructuralElementName() : Fqsen|null
setSummary() inherited
Sets a summary describing this element.
publicsetSummary(string $summary) : void
setDescription() inherited
Sets a longer description for this element.
publicsetDescription(string $description) : void
Parameters
- Inherited from
- \phpDocumentor\Descriptor\Interfaces\ElementInterface
getDescription() inherited
Returns a longer description for this element.
publicgetDescription() : string
setLocation() inherited
Sets the file and location for this element.
publicsetLocation(FileDescriptor $file, int $line) : void
- Inherited from
- \phpDocumentor\Descriptor\Interfaces\ElementInterface
getPath() inherited
Returns the file location for this element relative to the project root.
publicgetPath() : string
getTags() inherited
Returns all tags associated with this element.
publicgetTags() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor> —- Inherited from
- \phpDocumentor\Descriptor\Interfaces\ElementInterface
__toString() inherited
public__toString() : string
getParent() Line 32
Returns the parent for this descriptor.
publicgetParent() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\InterfaceDescriptor|\phpDocumentor\Reflection\Fqsen>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\InterfaceDescriptor|\phpDocumentor\Reflection\Fqsen> —
setParent() Line 39
Sets the parent for this Descriptor.
publicsetParent(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\InterfaceDescriptor|\phpDocumentor\Reflection\Fqsen> $parents) : void
Parameters
setConstants() Line 46
Sets the constants associated with this interface.
publicsetConstants(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ConstantDescriptor> $constants) : void
Parameters
getConstants() Line 53
Returns the constants associated with this interface.
publicgetConstants() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ConstantDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ConstantDescriptor> —
setMethods() Line 60
Sets the methods belonging to this interface.
publicsetMethods(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\MethodDescriptor> $methods) : void
Parameters
getMethods() Line 67
Returns the methods belonging to this interface.
publicgetMethods() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\MethodDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\MethodDescriptor> —
getInheritedMethods() Line 74
Returns a list of all methods that were inherited from parent interfaces.
publicgetInheritedMethods() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\MethodDescriptor>