phpDocumentor

PropertyInterface extends ElementInterface, TypeInterface

Descriptor representing a property on a class or trait.

Table of Contents

__toString()  : string
getDefault()  : string|null
Returns the textual representation of the default value for a property, or null if none is provided.
getDescription()  : DescriptionDescriptor|null
Returns a longer description for this element.
getFullyQualifiedStructuralElementName()  : Fqsen|null
Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
getLine()  : int
Returns the line number where this element may be found.
getName()  : string
Returns the local name for this element.
getPackage()  : PackageDescriptor|null
Returns the package name for this element.
getPath()  : string
Returns the file location for this element relative to the project root.
getSummary()  : string
Returns the summary describing this element.
getTags()  : Collection<string|int, Collection<string|int, TagDescriptor>>
Returns all tags associated with this element.
getType()  : Type|null
Returns the types associated with the value(s) for this property.
isReadOnly()  : bool
Returns true when this property is intended to be read-only.
isStatic()  : bool
Returns whether this property is static in scope.
isWriteOnly()  : bool
Returns true when this property is intended to be write-only.
setDefault()  : void
Stores a textual representation of the default value for a property.
setDescription()  : void
Sets a longer description for this element.
setFullyQualifiedStructuralElementName()  : void
Sets the Fully Qualified Structural Element Name (FQSEN) for this element.
setLocation()  : void
Sets the file and location for this element.
setName()  : void
Sets the local name for this element.
setStatic()  : void
Sets whether this property is static in scope.
setSummary()  : void
Sets a summary describing this element.
setType()  : void
Sets the types associated with the value(s) for this property.
setVisibility()  : void
Sets whether this property is available from inside or outside its class and/or descendants.

Methods

__toString()

public __toString() : string
Return values
string

getDefault()

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

public getDefault() : string|null
Return values
string|null

getFullyQualifiedStructuralElementName()

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

public getFullyQualifiedStructuralElementName() : Fqsen|null
Return values
Fqsen|null

getLine()

Returns the line number where this element may be found.

public getLine() : int
Tags
see
getPath()

to find out in which file this element is found.

Return values
int

getName()

Returns the local name for this element.

public getName() : string
Return values
string

getPath()

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

public getPath() : string
Return values
string

getSummary()

Returns the summary describing this element.

public getSummary() : string
Return values
string

getType()

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

public getType() : Type|null
Return values
Type|null

isStatic()

Returns whether this property is static in scope.

public isStatic() : bool
Return values
bool

setDefault()

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

public setDefault(string $default) : void
Parameters
$default : string
Return values
void

setFullyQualifiedStructuralElementName()

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

public setFullyQualifiedStructuralElementName(Fqsen $name) : void
Parameters
$name : Fqsen
Return values
void

setName()

Sets the local name for this element.

public setName(string $name) : void
Parameters
$name : string
Return values
void

setStatic()

Sets whether this property is static in scope.

public setStatic(bool $static) : void
Parameters
$static : bool
Return values
void

setSummary()

Sets a summary describing this element.

public setSummary(string $summary) : void
Parameters
$summary : string
Return values
void

setType()

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

public setType(Type $type) : void
Parameters
$type : Type
Return values
void

setVisibility()

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

public setVisibility(string $visibility) : void
Parameters
$visibility : string

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

Return values
void

Search results