TagFactory

Creates tags.

class TagFactory

Copyright: 2016 Appertly

License: Apache-2.0

Static Properties

Protected
Name	Type	Summary
`$constants`	`ImmSet`<`string`>
`$notTypes`	`ImmSet`<`string`>
`$psrKeywords`	`ImmSet`<`string`>
`$replaceTypes`	`ImmMap`<`string`,`string`>
`$thisy`	`ImmSet`<`string`>

Instance Methods

Public
Returns	Signature and Description
`ConstVector`<`Tag`>	`convert`(`?ScannedBase $token`, `ConstVector<string> $tags`) Creates a bunch of tags

Protected
Returns	Signature and Description
`ParameterTag`	`doParameterTag`(`?ScannedBase $token`, `array<string> $matches`)
`void`	`doTag`(`Vector<Tag> $out`, `?ScannedBase $token`, `string $tag`)
`TypedTag`	`doTypedTag`(`?ScannedBase $token`, `array<string> $matches`)
`VersionTag`	`doVersionTag`(`?ScannedBase $token`, `array<string> $matches`)
`ConstVector`<`ScannedTypehint`>	`parseTypes`(`string $hints`, `?ScannedBase $token = null`) Tries to convert a string typehint into a Vector.
`?ScannedTypehint`	`stringToTypehint`(`string $t`, `?ScannedBase $token = null`) Tries to convert a string into a Typehint

Property Details

$constants

static protected ImmSet<string> $constants

$notTypes

static protected ImmSet<string> $notTypes

$psrKeywords

static protected ImmSet<string> $psrKeywords

$replaceTypes

static protected ImmMap<string,string> $replaceTypes

$thisy

static protected ImmSet<string> $thisy

Method Details

convert

public function convert(?ScannedBase $token, ConstVector<string> $tags)

Creates a bunch of tags

Parameters
Name	Type	Description
`$token`	`?ScannedBase`	The scanned token whose doc comment has these tags
`$tags`	`ConstVector`<`string`>	The tags to convert

Returns
Type	Description
`ConstVector`<`Tag`>

doParameterTag

protected function doParameterTag(?ScannedBase $token, array<string> $matches)

Parameters
Name	Type	Description
`$token`	`?ScannedBase`
`$matches`	`array`<`string`>

Returns
Type	Description
`ParameterTag`

doTag

protected function doTag(Vector<Tag> $out, ?ScannedBase $token, string $tag)

Parameters
Name	Type	Description
`$out`	`Vector`<`Tag`>
`$token`	`?ScannedBase`
`$tag`	`string`

doTypedTag

protected function doTypedTag(?ScannedBase $token, array<string> $matches)

Parameters
Name	Type	Description
`$token`	`?ScannedBase`
`$matches`	`array`<`string`>

Returns
Type	Description
`TypedTag`

doVersionTag

protected function doVersionTag(?ScannedBase $token, array<string> $matches)

Parameters
Name	Type	Description
`$token`	`?ScannedBase`
`$matches`	`array`<`string`>

Returns
Type	Description
`VersionTag`

parseTypes

protected function parseTypes(string $hints, ?ScannedBase $token = null)

Tries to convert a string typehint into a Vector.

parseTypes('Foo|string|null');

Parameters
Name	Type	Description
`$hints`	`string`	The hints to parse
`$token`	`?ScannedBase`

Returns
Type	Description
`ConstVector`<`ScannedTypehint`>	The typehints contained

stringToTypehint

protected function stringToTypehint(string $t, ?ScannedBase $token = null)

Tries to convert a string into a Typehint

Parameters
Name	Type	Description
`$t`	`string`	The string typehint
`$token`	`?ScannedBase`

Returns
Type	Description
`?ScannedTypehint`	The scanned typehint or null