ClassyDeclaration

A declared interface, trait, or class.

class ClassyDeclaration implements TokenDeclaration<ScannedClass>

Copyright: 2016 Appertly

License: Apache-2.0

Constructors / Destructors

Public
Returns	Signature and Description
`void`	`__construct`(`ScannedClass $class`, `Block $block`, `ConstMap<string,PropertyDeclaration> $properties`, `ConstMap<string,MethodDeclaration> $methods`, `ConstMap<string,ConstantDeclaration> $constants`, `ConstMap<string,TypeConstantDeclaration> $typeConstants`) Creates a new ClassDeclaration.

Instance Methods

Public
Returns	Signature and Description
`?ConstantDeclaration`	`getConstant`(`string $name`) Gets a constant by name
`ConstMap`<`string`,`ConstantDeclaration`>	`getConstants`() Gets all constants in this class by name
`Block`	`getDocBlock`() Gets the doc comment block.
`string`	`getFilename`() Gets the source filename.
`?MethodDeclaration`	`getMethod`(`string $name`) Gets a method by name
`ConstMap`<`string`,`MethodDeclaration`>	`getMethods`() Gets all methods in this class by name
`string`	`getName`() Gets the name of the declaration.
`ConstMap`<`string`,`PropertyDeclaration`>	`getProperties`() Gets all properties in this class by name
`?PropertyDeclaration`	`getProperty`(`string $name`) Gets a property by name
`ScannedClass`	`getToken`() Gets the scanned token.
`?TypeConstantDeclaration`	`getTypeConstant`(`string $name`) Gets a type constant by name
`ConstMap`<`string`,`TypeConstantDeclaration`>	`getTypeConstants`() Gets all type constants in this class by name
`bool`	`isInterface`() Whether this class is an interface
`bool`	`isTrait`() Whether this class is a trait

Static Methods

Public
Returns	Signature and Description
`ClassyDeclaration`	`factory`(`ScannedClass $token`, `Parser $parser`, `Mapper $mapper`) Convenience method to create a new ClassyDeclaration.

Protected
Returns	Signature and Description
`ConstMap`<`string`,`ConstantDeclaration`>	`mergeConstants`(`ScannedClass $c`, `Parser $parser`, `Mapper $mapper`) Grab any inherited constants and make sure doc blocks are inherited.
`ConstMap`<`string`,`MethodDeclaration`>	`mergeMethods`(`ScannedClass $c`, `Parser $parser`, `Mapper $mapper`) Grab any inherited methods and make sure doc blocks are inherited.
`ConstMap`<`string`,`PropertyDeclaration`>	`mergeProperties`(`ScannedClass $c`, `Parser $parser`, `Mapper $mapper`) Grab any inherited properties and make sure doc blocks are inherited.
`ConstMap`<`string`,`TypeConstantDeclaration`>	`mergeTypeConstants`(`ScannedClass $c`, `Parser $parser`, `Mapper $mapper`) Grab any inherited constants and make sure doc blocks are inherited.

Method Details

__construct

public function __construct(ScannedClass $class, Block $block, ConstMap<string,PropertyDeclaration> $properties, ConstMap<string,MethodDeclaration> $methods, ConstMap<string,ConstantDeclaration> $constants, ConstMap<string,TypeConstantDeclaration> $typeConstants)

Creates a new ClassDeclaration.

Parameters
Name	Type	Description
`$class`	`ScannedClass`	The interface, trait, or class
`$block`	`Block`
`$properties`	`ConstMap`<`string`,`PropertyDeclaration`>
`$methods`	`ConstMap`<`string`,`MethodDeclaration`>
`$constants`	`ConstMap`<`string`,`ConstantDeclaration`>
`$typeConstants`	`ConstMap`<`string`,`TypeConstantDeclaration`>

factory

public static function factory(ScannedClass $token, Parser $parser, Mapper $mapper)

Convenience method to create a new ClassyDeclaration.

Parameters
Name	Type	Description
`$token`	`ScannedClass`	The class to read
`$parser`	`Parser`	The doc comment parser
`$mapper`	`Mapper`	The mapper

Returns
Type	Description
`ClassyDeclaration`	The created ClassyDeclaration

getConstant

public function getConstant(string $name)

Gets a constant by name

Parameters
Name	Type	Description
`$name`	`string`	The constant name

Returns
Type	Description
`?ConstantDeclaration`	The constant found or `null`

getConstants

public function getConstants()

Gets all constants in this class by name

Returns
Type	Description
`ConstMap`<`string`,`ConstantDeclaration`>	All constants in this class

getDocBlock

public function getDocBlock()

Gets the doc comment block.

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

getFilename

public function getFilename()

Gets the source filename.

Returns
Type	Description
`string`	The filename

getMethod

public function getMethod(string $name)

Gets a method by name

Parameters
Name	Type	Description
`$name`	`string`	The method name

Returns
Type	Description
`?MethodDeclaration`	The method found or `null`

getMethods

public function getMethods()

Gets all methods in this class by name

Returns
Type	Description
`ConstMap`<`string`,`MethodDeclaration`>	All methods in this class

getName

public function getName()

Gets the name of the declaration.

Returns
Type	Description
`string`	The declaration name

getProperties

public function getProperties()

Gets all properties in this class by name

Returns
Type	Description
`ConstMap`<`string`,`PropertyDeclaration`>	All properties in this class

getProperty

public function getProperty(string $name)

Gets a property by name

Parameters
Name	Type	Description
`$name`	`string`	The property name

Returns
Type	Description
`?PropertyDeclaration`	The property found or `null`

getToken

public function getToken()

Gets the scanned token.

Returns
Type	Description
`ScannedClass`	The scanned token

getTypeConstant

public function getTypeConstant(string $name)

Gets a type constant by name

Parameters
Name	Type	Description
`$name`	`string`	The constant name

Returns
Type	Description
`?TypeConstantDeclaration`	The type constant found or `null`

getTypeConstants

public function getTypeConstants()

Gets all type constants in this class by name

Returns
Type	Description
`ConstMap`<`string`,`TypeConstantDeclaration`>	All type constants in this class

isInterface

public function isInterface()

Whether this class is an interface

Returns
Type	Description
`bool`	`true` if this class is an interface

isTrait

public function isTrait()

Whether this class is a trait

Returns
Type	Description
`bool`	`true` if this class is a trait

mergeConstants

static protected function mergeConstants(ScannedClass $c, Parser $parser, Mapper $mapper)

Grab any inherited constants and make sure doc blocks are inherited.

Parameters
Name	Type	Description
`$c`	`ScannedClass`	The token
`$parser`	`Parser`	The doc block parser
`$mapper`	`Mapper`	The mapper

Returns
Type	Description
`ConstMap`<`string`,`ConstantDeclaration`>	The constants by name

mergeMethods

static protected function mergeMethods(ScannedClass $c, Parser $parser, Mapper $mapper)

Grab any inherited methods and make sure doc blocks are inherited.

Parameters
Name	Type	Description
`$c`	`ScannedClass`	The token
`$parser`	`Parser`	The doc block parser
`$mapper`	`Mapper`	The mapper

Returns
Type	Description
`ConstMap`<`string`,`MethodDeclaration`>	The methods by name

mergeProperties

static protected function mergeProperties(ScannedClass $c, Parser $parser, Mapper $mapper)

Grab any inherited properties and make sure doc blocks are inherited.

Parameters
Name	Type	Description
`$c`	`ScannedClass`	The token
`$parser`	`Parser`	The doc block parser
`$mapper`	`Mapper`	The mapper

Returns
Type	Description
`ConstMap`<`string`,`PropertyDeclaration`>	The properties by name

mergeTypeConstants

static protected function mergeTypeConstants(ScannedClass $c, Parser $parser, Mapper $mapper)

Grab any inherited constants and make sure doc blocks are inherited.

Parameters
Name	Type	Description
`$c`	`ScannedClass`	The token
`$parser`	`Parser`	The doc block parser
`$mapper`	`Mapper`	The mapper

Returns
Type	Description
`ConstMap`<`string`,`TypeConstantDeclaration`>	The constants by name