Properties

$fqsen

$fqsen : \phpDocumentor\Reflection\Fqsen

Type

\phpDocumentor\Reflection\Fqsen — Fully Qualified Structural Element Name; the FQCN including method, property or constant name

$name

$name : string

Type

string — The local name for this element

$namespace

$namespace : \phpDocumentor\Descriptor\NamespaceDescriptor|string

Type

NamespaceDescriptor|string — The namespace for this element

$package

$package : \phpDocumentor\Descriptor\PackageDescriptor|string

Type

PackageDescriptor|string — The package with which this element is associated

$summary

$summary : string

Type

string — A summary describing the function of this element in short.

$description

$description : \phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor|null

Type

DescriptionDescriptor|null — A more extensive description of this element.

$fileDescriptor

$fileDescriptor : \phpDocumentor\Descriptor\FileDescriptor|null

Type

FileDescriptor|null — The file to which this element belongs; if applicable

$line

$line : int

Type

int — The line number on which this element occurs.

$tags

$tags : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>>

Type

TagDescriptor>> — The tags associated with this element.

$errors

$errors : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>

Type

Error> — A list of errors found while building this element.

$inheritedElement

$inheritedElement : \phpDocumentor\Descriptor\DescriptorAbstract|null

Type

DescriptorAbstract|null — the element from which to inherit information in this element

$parent

$parent : \phpDocumentor\Descriptor\ClassDescriptor|\phpDocumentor\Descriptor\TraitDescriptor|null

Type

TraitDescriptor|null

$type

$type : \phpDocumentor\Reflection\Type|null

Type

Type|null

$default

$default : string

Type

string

$static

$static : bool

Type

bool

$visibility

$visibility : string

Type

string

$readOnly

$readOnly : bool

Type

bool

$writeOnly

$writeOnly : bool

Type

bool

Methods

__construct()

__construct() : mixed

Initializes this descriptor.

Returns

mixed —

getFullyQualifiedStructuralElementName()

getFullyQualifiedStructuralElementName() : ?\phpDocumentor\Reflection\Fqsen

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

Returns

?\phpDocumentor\Reflection\Fqsen —

getName()

getName() : string

Returns the local name for this element.

Returns

string —

getNamespace()

getNamespace() : \phpDocumentor\Descriptor\NamespaceDescriptor|string

Returns the namespace for this element (defaults to global "\")

Returns

\phpDocumentor\Descriptor\NamespaceDescriptor|string —

getSummary()

getSummary() : string

Returns the summary which describes this element.

This method will automatically attempt to inherit the parent's summary if this one has none.

Returns

string —

getDescription()

getDescription() : ?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Returns the description for this element.

This method will automatically attempt to inherit the parent's description if this one has none.

Returns

?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor —

getPath()

getPath() : string

Returns the path to the file containing this element relative to the project's root.

Returns

string —

getFile()

getFile() : \phpDocumentor\Descriptor\FileDescriptor

Returns the file associated with the parent class or trait.

Returns

\phpDocumentor\Descriptor\FileDescriptor —

getLine()

getLine() : int

Returns the line number where the definition for this element can be found.

Returns

int —

getTags()

getTags() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>>

Returns the tags associated with this element.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>> —

getPackage()

getPackage() : ?\phpDocumentor\Descriptor\PackageDescriptor

Returns the package name for this element.

Returns

?\phpDocumentor\Descriptor\PackageDescriptor —

getAuthor()

getAuthor() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\AuthorDescriptor>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\AuthorDescriptor> —

getVersion()

getVersion() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor>

Returns the versions for this element.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor> —

getCopyright()

getCopyright() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>

Returns the copyrights for this element.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor> —

isDeprecated()

isDeprecated() : bool

Checks whether this element is deprecated.

Returns

bool —

getErrors()

getErrors() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>

Returns all errors that occur in this element.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> —

__call()

__call(string  $name, array  $arguments) : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>|null

Dynamically constructs a set of getters to retrieve tag (collections) with.

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.

Parameters

string $name
array $arguments

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>|null —

__toString()

__toString() : string

Represents this object by its unique identifier, the Fully Qualified Structural Element Name.

Returns

string —

getInheritedElement()

getInheritedElement() : \phpDocumentor\Descriptor\DescriptorAbstract|string|\phpDocumentor\Reflection\Fqsen|null

Returns the property from which this one should inherit, if any.

Returns

\phpDocumentor\Descriptor\DescriptorAbstract|string|\phpDocumentor\Reflection\Fqsen|null —

setParent()

setParent(\phpDocumentor\Descriptor\ClassDescriptor|\phpDocumentor\Descriptor\TraitDescriptor  $parent) : void

Parameters

\phpDocumentor\Descriptor\ClassDescriptor|\phpDocumentor\Descriptor\TraitDescriptor $parent

getParent()

getParent() : \phpDocumentor\Descriptor\ClassDescriptor|\phpDocumentor\Descriptor\TraitDescriptor|null

Returns

\phpDocumentor\Descriptor\ClassDescriptor|\phpDocumentor\Descriptor\TraitDescriptor|null —

setDefault()

setDefault(?string  $default) : void

Stores a textual representation of the default value for a property.

Parameters

?string $default

getDefault()

getDefault() : ?string

Returns the textual representation of the default value for a property, or null if none is provided.

Returns

?string —

setStatic()

setStatic(bool  $static) : void

Sets whether this property is static in scope.

Parameters

bool $static

isStatic()

isStatic() : bool

Returns whether this property is static in scope.

Returns

bool —

setType()

setType(?\phpDocumentor\Reflection\Type  $type) : void

Sets the types associated with the value(s) for this property.

Parameters

?\phpDocumentor\Reflection\Type $type

getTypes()

getTypes() : \phpDocumentor\Descriptor\list<string>

Returns

\phpDocumentor\Descriptor\list

getType()

getType() : ?\phpDocumentor\Reflection\Type

Returns the types associated with the value(s) for this property.

Returns

?\phpDocumentor\Reflection\Type —

setVisibility()

setVisibility(string  $visibility) : void

Sets whether this property is available from inside or outside its class and/or descendants.

Parameters

string $visibility

May be either 'public', 'private' or 'protected'.

getVisibility()

getVisibility() : string

Returns the visibility for this element.

The following values are supported:

  • public
  • protected
  • private

Returns

string —

getVar()

getVar() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\VarDescriptor>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\VarDescriptor> —

setReadOnly()

setReadOnly(bool  $value) : void

Parameters

bool $value

isReadOnly()

isReadOnly() : bool

Returns true when this property is intended to be read-only.

Returns

bool —

setWriteOnly()

setWriteOnly(bool  $value) : void

Parameters

bool $value

isWriteOnly()

isWriteOnly() : bool

Returns true when this property is intended to be write-only.

Returns

bool —