ParameterTag

Any tag that includes a typehint, a name, and a description.

class ParameterTag extends TypedTag

Implementors are meant to be immutable.

Copyright: 2016 Appertly

License: Apache-2.0

Constructors / Destructors

Public
Returns	Signature and Description
`void`	`__construct`(`string $name`, `Traversable<ScannedTypehint> $type`, `string $variable`, `string $description`) Creates a new ParameterTag.

Instance Methods

Public
Returns	Signature and Description
`string`	`__toString`() Returns a string representation.
`string`	`getDescription`() Gets the tag description.
`string`	`getName`() Gets the name of the tag
`ImmVector`<`ScannedTypehint`>	`getTypes`() Gets the tag types
`string`	`getVariable`() Gets the tag variable name
`bool`	`isNeeded`(`ConstVector<Tag> $tags`) Whether this tag is needed in the vector.

Static Methods

Public
Returns	Signature and Description
`bool`	`applies`(`string $tagName`) Whether the given tag name applies to this class.

Method Details

__construct

public function __construct(string $name, Traversable<ScannedTypehint> $type, string $variable, string $description)

Creates a new ParameterTag.

Parameters
Name	Type	Description
`$name`	`string`	The tag name
`$type`	`Traversable`<`ScannedTypehint`>	The typehint
`$variable`	`string`	The variable name
`$description`	`string`	The tag description

__toString

public function __toString()

Returns a string representation.

Returns
Type	Description
`string`	The string representation

applies

public static function applies(string $tagName)

Whether the given tag name applies to this class.

Parameters
Name	Type	Description
`$tagName`	`string`	The tag name to test

Returns
Type	Description
`bool`	whether the tag name applies

getDescription

Inherited from DescribedTag

public function getDescription()

Gets the tag description.

Returns
Type	Description
`string`	The tag description

getName

Inherited from Tag

public function getName()

Gets the name of the tag

Returns
Type	Description
`string`	The name

getTypes

Inherited from TypedTag

public function getTypes()

Gets the tag types

Returns
Type	Description
`ImmVector`<`ScannedTypehint`>	The tag types

getVariable

public function getVariable()

Gets the tag variable name

Returns
Type	Description
`string`	The tag variable name

isNeeded

public function isNeeded(ConstVector<Tag> $tags)

Whether this tag is needed in the vector.

Parameters
Name	Type	Description
`$tags`	`ConstVector`<`Tag`>	The tags

Returns
Type	Description
`bool`	`true` if the tag is not duplicated in the vector