PropertyInterface

extends ElementInterface, TypeInterface
in package

Descriptor representing a property on a class or trait.

Methods

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

publicsetFullyQualifiedStructuralElementName(Fqsen $name) : void

Parameters

$name : Fqsen

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

publicgetFullyQualifiedStructuralElementName() : Fqsen|null

Returns

Fqsen|null

Sets the local name for this element.

publicsetName(string $name) : void

Parameters

$name : string

Returns the local name for this element.

publicgetName() : string

Returns

string

Sets a summary describing this element.

publicsetSummary(string $summary) : void

Parameters

$summary : string

Returns the summary describing this element.

publicgetSummary() : string

Returns

string

Sets a longer description for this element.

publicsetDescription(string $description) : void

Parameters

$description : string

Returns a longer description for this element.

publicgetDescription() : string

Returns

string

Sets the file and location for this element.

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

Parameters

$file : FileDescriptor
$line : int

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

publicgetPath() : string

Returns

string

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>

public__toString() : string

Returns

string

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

publicsetDefault(string $default) : void

Parameters

$default : string

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

publicgetDefault() : string|null

Returns

string|null

Sets whether this property is static in scope.

publicsetStatic(bool $static) : void

Parameters

$static : bool

Returns whether this property is static in scope.

publicisStatic() : bool

Returns

bool

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

publicsetType(Type $type) : void

Parameters

$type : Type

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

publicgetType() : Type|null

Returns

Type|null

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

publicsetVisibility(string $visibility) : void

Parameters

$visibility : string

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