PropertyInterface
extends ElementInterface, TypeInterfaceDescriptor representing a property on a class or trait.
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
setDefault() Line 26
Stores a textual representation of the default value for a property.
publicsetDefault(string $default) : void
Parameters
getDefault() Line 31
Returns the textual representation of the default value for a property, or null if none is provided.
publicgetDefault() : string|null
Returns
string|null —
setStatic() Line 36
Sets whether this property is static in scope.
publicsetStatic(bool $static) : void
Parameters
Returns
bool —
setType() Line 46
Sets the types associated with the value(s) for this property.
publicsetType(Type $type) : void
Parameters
getType() Line 51
Returns the types associated with the value(s) for this property.
publicgetType() : Type|null
Returns
Type|null —
setVisibility() Line 58
Sets whether this property is available from inside or outside its class and/or descendants.
publicsetVisibility(string $visibility) : void
Parameters
May be either 'public', 'private' or 'protected'.