ClassDescriptor
Descriptor representing a Class.
Interfaces, Classes & Used Traits
- ClassInterface
- Common interface representing the description of a class.
Properties
$fqsen inherited
protected$fqsen : \phpDocumentor\Reflection\Fqsen
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$name inherited
protected$name : string
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$namespace inherited
protected$namespace : \phpDocumentor\Descriptor\NamespaceDescriptor|string
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$package inherited
protected$package : \phpDocumentor\Descriptor\PackageDescriptor
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$summary inherited
protected$summary : string
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$description inherited
protected$description : string
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$fileDescriptor inherited
protected$fileDescriptor : \phpDocumentor\Descriptor\FileDescriptor|null
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$line inherited
protected$line : int
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$tags inherited
protected$tags : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>>
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$errors inherited
protected$errors : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$inheritedElement inherited
protected$inheritedElement : \phpDocumentor\Descriptor\DescriptorAbstract|null
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$parent Line 33
protected$parent : \phpDocumentor\Descriptor\ClassDescriptor|\phpDocumentor\Descriptor\InterfaceDescriptor|\phpDocumentor\Reflection\Fqsen|string|null
Reference to an instance of the superclass for this class, if any.
$implements Line 40
protected$implements : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\InterfaceDescriptor|\phpDocumentor\Reflection\Fqsen>
References to interfaces that are implemented by this class.
$abstract Line 43
protected$abstract : bool
$final Line 46
protected$final : bool
$constants Line 49
protected$constants : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ConstantDescriptor>
$properties Line 52
protected$properties : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\PropertyDescriptor>
$methods Line 55
protected$methods : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\MethodDescriptor>
$usedTraits Line 58
protected$usedTraits : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TraitDescriptor>|\phpDocumentor\Descriptor\Collection<\phpDocumentor\Reflection\Fqsen>
Methods
__construct() Line 63
Initializes the all properties representing a collection with a new Collection object.
public__construct() : mixed
Returns
mixed —
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
setNamespace() inherited
Sets the namespace (name) for this element.
publicsetNamespace(NamespaceDescriptor|string $namespace) : void
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
getNamespace() inherited
Returns the namespace for this element (defaults to global "\")
publicgetNamespace() : NamespaceDescriptor|string
setSummary() inherited
Sets the summary describing this element in short.
publicsetSummary(string $summary) : void
getSummary() inherited
Returns the summary which describes this element.
publicgetSummary() : string
This method will automatically attempt to inherit the parent's summary if this one has none.
Returns
string —- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
setDescription() inherited
Sets a description for this element.
publicsetDescription(string $description) : void
getDescription() inherited
Returns the description for this element.
publicgetDescription() : string
This method will automatically attempt to inherit the parent's description if this one has none.
Returns
string —- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
setLocation() inherited
Sets the file and linenumber where this element is at.
publicsetLocation(FileDescriptor $file, int $line) : void
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
getPath() inherited
Returns the path to the file containing this element relative to the project's root.
publicgetPath() : string
getFile() inherited
Returns the file in which this element resides or null in case the element is not bound to a file.
publicgetFile() : FileDescriptor|null
setFile() inherited
Sets the file to which this element is associated.
publicsetFile(FileDescriptor $file) : void
getLine() inherited
Returns the line number where the definition for this element can be found.
publicgetLine() : int
setLine() inherited
Sets the line number for this element's location in the source file.
publicsetLine(int $lineNumber) : void
setTags() inherited
Sets the tags associated with this element.
publicsetTags(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>> $tags) : void
Parameters
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
getTags() inherited
Returns the tags associated with this element.
publicgetTags() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>> —- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
setPackage() Line 291
Sets the name of the package to which this element belongs.
publicsetPackage(mixed $package) : void
Parameters
getPackage() inherited
Returns the package name for this element.
publicgetPackage() : PackageDescriptor|null
getAuthor() inherited
publicgetAuthor() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\AuthorDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\AuthorDescriptor> —- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
getVersion() inherited
Returns the versions for this element.
publicgetVersion() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor> —- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
getCopyright() inherited
Returns the copyrights for this element.
publicgetCopyright() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor> —- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
setErrors() inherited
Sets a list of all errors associated with this element.
publicsetErrors(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> $errors) : void
Parameters
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
getErrors() inherited
Returns all errors that occur in this element.
publicgetErrors() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> —- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
__call() inherited
Dynamically constructs a set of getters to retrieve tag (collections) with.
public__call(string $name, array $arguments) : Collection|mixed|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.
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
__toString() inherited
Represents this object by its unique identifier, the Fully Qualified Structural Element Name.
public__toString() : string
getInheritedElement() Line 333
publicgetInheritedElement() : ClassDescriptor|Fqsen|null
setParent() Line 77
publicsetParent(ClassDescriptor|InterfaceDescriptor|Fqsen|string|null $parents) : void
getParent() Line 85
publicgetParent() : ClassDescriptor|InterfaceDescriptor|Fqsen|string|null
setInterfaces() Line 90
publicsetInterfaces(Collection $implements) : void
getInterfaces() Line 95
publicgetInterfaces() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\InterfaceDescriptor|\phpDocumentor\Reflection\Fqsen>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\InterfaceDescriptor|\phpDocumentor\Reflection\Fqsen> —
setFinal() Line 100
publicsetFinal(bool $final) : void
Parameters
isFinal() Line 105
publicisFinal() : bool
Returns
bool —
setAbstract() Line 110
publicsetAbstract(bool $abstract) : void
Parameters
isAbstract() Line 115
publicisAbstract() : bool
Returns
bool —
setConstants() Line 120
publicsetConstants(Collection $constants) : void
getConstants() Line 125
publicgetConstants() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ConstantDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ConstantDescriptor> —
getInheritedConstants() Line 133
publicgetInheritedConstants() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ConstantDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ConstantDescriptor> —
setMethods() Line 144
publicsetMethods(Collection $methods) : void
getMethods() Line 149
publicgetMethods() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\MethodDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\MethodDescriptor> —
getInheritedMethods() Line 154
publicgetInheritedMethods() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\MethodDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\MethodDescriptor> —
getMagicMethods() Line 178
publicgetMagicMethods() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\MethodDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\MethodDescriptor> —
setProperties() Line 211
publicsetProperties(Collection $properties) : void
getProperties() Line 216
publicgetProperties() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\PropertyDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\PropertyDescriptor> —
getInheritedProperties() Line 221
publicgetInheritedProperties() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\PropertyDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\PropertyDescriptor> —
getMagicProperties() Line 245
publicgetMagicProperties() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\PropertyDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\PropertyDescriptor> —
setUsedTraits() Line 313
Sets a collection of all traits used by this class.
publicsetUsedTraits(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TraitDescriptor>|\phpDocumentor\Descriptor\Collection<\phpDocumentor\Reflection\Fqsen> $usedTraits) : void
Parameters
getUsedTraits() Line 325
Returns the traits used by this class.
publicgetUsedTraits() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TraitDescriptor>|\phpDocumentor\Descriptor\Collection<\phpDocumentor\Reflection\Fqsen>
Returned values may either be a string (when the Trait is not in this project) or a TraitDescriptor.