Mapper

Takes the ScannedBase tokens and resolves PHPDoc inheritance.

class Mapper

Copyright: 2016 Appertly

License: Apache-2.0

Constructors / Destructors

Public
Returns	Signature and Description
`void`	`__construct`(`ConstVector<ScannedBase> $tokens`, `Parser $parser`) Creates a new Mapper.

Instance Methods

Public
Returns	Signature and Description
`?ClassyDeclaration`	`getClass`(`string $name`) Gets a class declaration
`ConstMap`<`string`,`ClassyDeclaration`>	`getClasses`() Gets all class declarations.
`?ConstantDeclaration`	`getConstant`(`string $name`) Gets a constant declaration.
`?FileDeclaration`	`getFile`(`string $name`) Gets a file definition.
`ConstMap`<`string`,`FileDeclaration`>	`getFiles`() Gets the file definitions.
`?FunctionDeclaration`	`getFunction`(`string $name`) Gets a function declaration.
`ConstSet`<`string`>	`getNamespaces`() Gets the namespaces of the tokens.
`ConstVector`<`ScannedBase`>	`getTokens`() Gets a list of all tokens
`ImmMap`<`string`,`ImmVector`<`ScannedBase`>>	`getTokensByFilename`() Gets all tokens by filename.
`ImmMap`<`string`,`ScannedBase`>	`getTokensByName`() Gets all tokens by their name.
`ImmMap`<`string`,`ImmVector`<`ScannedBase`>>	`getTokensByNamespace`() Gets all tokens by namespace name.

Method Details

__construct

public function __construct(ConstVector<ScannedBase> $tokens, Parser $parser)

Creates a new Mapper.

Parameters
Name	Type	Description
`$tokens`	`ConstVector`<`ScannedBase`>	All scanned tokens
`$parser`	`Parser`

getClass

public function getClass(string $name)

Gets a class declaration

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

Returns
Type	Description
`?ClassyDeclaration`	The class declaration or `null`

getClasses

public function getClasses()

Gets all class declarations.

Returns
Type	Description
`ConstMap`<`string`,`ClassyDeclaration`>	The class declarations

getConstant

public function getConstant(string $name)

Gets a constant declaration.

Parameters
Name	Type	Description
`$name`	`string`

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

getFile

public function getFile(string $name)

Gets a file definition.

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

Returns
Type	Description
`?FileDeclaration`	The file declaration or `null`

getFiles

public function getFiles()

Gets the file definitions.

Returns
Type	Description
`ConstMap`<`string`,`FileDeclaration`>	The file definitions

getFunction

public function getFunction(string $name)

Gets a function declaration.

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

Returns
Type	Description
`?FunctionDeclaration`	The function declaration or `null`

getNamespaces

public function getNamespaces()

Gets the namespaces of the tokens.

Returns
Type	Description
`ConstSet`<`string`>	The token namespaces

getTokens

public function getTokens()

Gets a list of all tokens

Returns
Type	Description
`ConstVector`<`ScannedBase`>

getTokensByFilename

public function getTokensByFilename()

Gets all tokens by filename.

Returns
Type	Description
`ImmMap`<`string`,`ImmVector`<`ScannedBase`>>	The tokens by filename

getTokensByName

public function getTokensByName()

Gets all tokens by their name.

Returns
Type	Description
`ImmMap`<`string`,`ScannedBase`>	The tokens by name

getTokensByNamespace

public function getTokensByNamespace()

Gets all tokens by namespace name.

Returns
Type	Description
`ImmMap`<`string`,`ImmVector`<`ScannedBase`>>	The tokens by namespace name