ConstantDeclaration

A declared class property.

class ConstantDeclaration implements TokenDeclaration<ScannedConstant>

Constructors / Destructors

Public
Returns	Signature and Description
`void`	`__construct`(`ScannedConstant $constant`, `Block $block`, `?ScannedClass $class = null`) Creates a new ConstantDeclaration.

Public
Returns	Signature and Description
`?ScannedClass`	`getClass`() Gets the containing class.
`Block`	`getDocBlock`() Gets the doc comment block.
`string`	`getFilename`() Gets the source filename.
`string`	`getName`() Gets the name of the declaration.
`string`	`getSummary`() Gets the best summary for the property.
`ScannedConstant`	`getToken`() Gets the scanned token.
`?ScannedTypehint`	`getType`() Gets the best type hints for the property.

public function __construct(ScannedConstant $constant, Block $block, ?ScannedClass $class = null)

Creates a new ConstantDeclaration.

Parameters
Name	Type	Description
`$constant`	`ScannedConstant`	The property
`$block`	`Block`	The doc comment
`$class`	`?ScannedClass`	Optional. The interface, trait, or class

public function getClass()

Gets the containing class.

Returns
Type	Description
`?ScannedClass`	The containing class

public function getDocBlock()

Gets the doc comment block.

Returns
Type	Description
`Block`	The doc block, which could be empty

public function getFilename()

Gets the source filename.

Returns
Type	Description
`string`	The filename

public function getName()

Gets the name of the declaration.

Returns
Type	Description
`string`	The declaration name

public function getSummary()

Gets the best summary for the property.

Either the PHPDoc summary, or the description of its var tag.

Returns
Type	Description
`string`	The summary

public function getToken()

Gets the scanned token.

Returns
Type	Description
`ScannedConstant`	The scanned token

public function getType()

Gets the best type hints for the property.

Either the inline typehint, or if omitted or mixed, we use the tags.

Returns
Type	Description
`?ScannedTypehint`	The type hints