ClassInterface

extends ElementInterface, ChildInterface, TypeInterface
in package

Common interface representing the description of a class.

ClassInterface.php
Parents
\phpDocumentor\Descriptor\Interfaces\ElementInterface
\phpDocumentor\Descriptor\Interfaces\ChildInterface
\phpDocumentor\Descriptor\Interfaces\TypeInterface
see
NamespaceInterface

Classes may be contained in namespaces.

see
FileInterface

Classes may be defined in a file.

Methods

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

publicsetFullyQualifiedStructuralElementName(Fqsen $name) : void

Parameters

$name : Fqsen
Inherited from
\phpDocumentor\Descriptor\Interfaces\ElementInterface

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

publicgetFullyQualifiedStructuralElementName() : Fqsen|null

Returns

Fqsen|null —
Inherited from
\phpDocumentor\Descriptor\Interfaces\ElementInterface

Sets the local name for this element.

publicsetName(string $name) : void

Parameters

$name : string
Inherited from
\phpDocumentor\Descriptor\Interfaces\ElementInterface

Returns the local name for this element.

publicgetName() : string

Returns

string —
Inherited from
\phpDocumentor\Descriptor\Interfaces\ElementInterface

Sets a summary describing this element.

publicsetSummary(string $summary) : void

Parameters

$summary : string
Inherited from
\phpDocumentor\Descriptor\Interfaces\ElementInterface

Returns the summary describing this element.

publicgetSummary() : string

Returns

string —
Inherited from
\phpDocumentor\Descriptor\Interfaces\ElementInterface

Sets a longer description for this element.

publicsetDescription(string $description) : void

Parameters

$description : string
Inherited from
\phpDocumentor\Descriptor\Interfaces\ElementInterface

Returns a longer description for this element.

publicgetDescription() : string

Returns

string —
Inherited from
\phpDocumentor\Descriptor\Interfaces\ElementInterface

Sets the file and location for this element.

publicsetLocation(FileDescriptor $file, int $line) : void

Parameters

$file : FileDescriptor
$line : int
Inherited from
\phpDocumentor\Descriptor\Interfaces\ElementInterface

Returns the file location for this element relative to the project root.

publicgetPath() : string

Returns

string —
Inherited from
\phpDocumentor\Descriptor\Interfaces\ElementInterface

Returns the line number where this element may be found.

publicgetLine() : int

Returns

int —
Inherited from
\phpDocumentor\Descriptor\Interfaces\ElementInterface
see
getPath()

to find out in which file this element is found.

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

Returns the parent for this descriptor.

publicgetParent() : DescriptorAbstract|Fqsen|string|null

Returns

DescriptorAbstract|Fqsen|string|null —
Inherited from
\phpDocumentor\Descriptor\Interfaces\ChildInterface

Sets the parent for this Descriptor.

publicsetParent(DescriptorAbstract|Fqsen|string|null $parent) : void

Parameters

$parent : DescriptorAbstract|Fqsen|string|null
Inherited from
\phpDocumentor\Descriptor\Interfaces\ChildInterface

public__toString() : string

Returns

string —
Inherited from
\phpDocumentor\Descriptor\Interfaces\TypeInterface

publicsetInterfaces(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\InterfaceDescriptor|\phpDocumentor\Reflection\Fqsen> $implements) : void

Parameters

$implements : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\InterfaceDescriptor|\phpDocumentor\Reflection\Fqsen> 

publicgetInterfaces() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\InterfaceDescriptor|\phpDocumentor\Reflection\Fqsen>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\InterfaceDescriptor|\phpDocumentor\Reflection\Fqsen> — 

publicsetFinal(bool $final) : void

Parameters

$final : bool 

publicisFinal() : bool

Returns

bool — 

publicsetAbstract(bool $abstract) : void

Parameters

$abstract : bool 

publicisAbstract() : bool

Returns

bool — 

publicsetConstants(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ConstantDescriptor> $constants) : void

Parameters

$constants : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ConstantDescriptor> 

publicgetConstants() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ConstantDescriptor>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ConstantDescriptor> — 

publicsetMethods(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\MethodDescriptor> $methods) : void

Parameters

$methods : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\MethodDescriptor> 

publicgetMethods() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\MethodDescriptor>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\MethodDescriptor> — 

publicgetInheritedMethods() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\MethodDescriptor>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\MethodDescriptor> — 

publicsetProperties(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\PropertyDescriptor> $properties) : void

Parameters

$properties : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\PropertyDescriptor> 

publicgetProperties() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\PropertyDescriptor>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\PropertyDescriptor> — 

publicgetInheritedProperties() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\PropertyDescriptor>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\PropertyDescriptor> —