VarTag

namespace	bhenk\doc2rst\tag
predicates	Cloneable | Instantiable
implements	TagInterface | Stringable
extends	ParamTag
hierarchy	VarTag -> ParamTag -> AbstractTypeTag -> AbstractLinkTag -> AbstractTag

Represents the var tag

syntax

@var ["Type"] [element_name] [<description>]

see also

PSR-19 @var

---

Constants

VarTag::TAG

predicates

public

@inheritdoc

var string TAG - the name of this tag

@inheritdoc from AbstractTag::TAG

string(4) "@var"

---

Constructor

VarTag::__construct

predicates	public | constructor
inherited from	AbstractTag::__construct

Construct a new Tag

The param $tag_string should include the at-symbol @, tag name and possibly curly braces. The string should follow the syntax of the specific Tag being constructed.

public function __construct(
      Parameter #0 [ <optional> ?string $tag_string = '' ]
 )

param ?string $tag_string - string following syntax of this Tag class

---

Methods

VarTag::getTagName

predicates	public
implements	TagInterface::getTagName

@inheritdoc

Gets the tag-name of this Tag

return string - tag-name of this Tag

@inheritdoc from method TagInterface::getTagName

public function getTagName(): string

return string - name of this Tag

---

VarTag::render

predicates	public
implements	AbstractTag::render
inherited from	ParamTag::render

Renders a named type Tag

syntax

@tag_name ["Type"] $[name] [<description>]

public function render(): void

return void

---

VarTag::__toString

predicates	public
implements	Stringable::__toString
inherited from	ParamTag::__toString

Returns a reStructuredText representation of the contents of this Tag

public function __toString(): string

return string - reStructuredText representation of contents

---

VarTag::getName

predicates	public
inherited from	ParamTag::getName

public function getName(): ?string

return ?string

---

VarTag::setName

predicates	public
inherited from	ParamTag::setName

public function setName(
      Parameter #0 [ <required> ?string $name ]
 ): void

param ?string $name

return void

---

VarTag::getType

predicates	public
inherited from	AbstractTypeTag::getType

public function getType(): ?string

return ?string

---

VarTag::setType

predicates	public
inherited from	AbstractTypeTag::setType

public function setType(
      Parameter #0 [ <required> ?string $type ]
 ): void

param ?string $type

return void

---

VarTag::getUri

predicates	public
inherited from	AbstractLinkTag::getUri

public function getUri(): ?string

return ?string

---

VarTag::setUri

predicates	public
inherited from	AbstractLinkTag::setUri

public function setUri(
      Parameter #0 [ <required> ?string $uri ]
 ): void

param ?string $uri

return void

---

VarTag::getDescription

predicates	public
inherited from	AbstractLinkTag::getDescription

public function getDescription(): ?string

return ?string

---

VarTag::setDescription

predicates	public
inherited from	AbstractLinkTag::setDescription

public function setDescription(
      Parameter #0 [ <required> ?string $description ]
 ): void

param ?string $description

return void

---

VarTag::getTagString

predicates	public
inherited from	AbstractTag::getTagString

Get the $tag_string

public function getTagString(): string

return string - string with which this Tag was constructed

---

VarTag::getLine

predicates	public
inherited from	AbstractTag::getLine

Get the content of the $tag_string without the tag name and curly braces

public function getLine(): string

return string - content of the $tag_string

---

VarTag::getDisplayName

predicates	public
implements	TagInterface::getDisplayName
inherited from	AbstractTag::getDisplayName

@inheritdoc

Get the short version of this tagname, without the at-sign (@)

return string - short version of this tagname

@inheritdoc from method TagInterface::getDisplayName

public function getDisplayName(): string

return string

---

VarTag::isInline

predicates	public
implements	TagInterface::isInline
inherited from	AbstractTag::isInline

@inheritdoc

Is this an inline tag

Is this an inline tag (with curly braces) or does this tag appear at the start of a line.

return bool - true if this is an inline link, false otherwise

@inheritdoc from method TagInterface::isInline

public function isInline(): bool

return bool

---

VarTag::getTagLength

predicates	public
implements	TagInterface::getTagLength
inherited from	AbstractTag::getTagLength

@inheritdoc

Get the length (in characters) of this tagname

return int - length (in characters) of this tagname

@inheritdoc from method TagInterface::getTagLength

public function getTagLength(): int

return int

---

VarTag::getGroupWidth

predicates	public
implements	TagInterface::getGroupWidth
inherited from	AbstractTag::getGroupWidth

@inheritdoc

Get the width (in characters) of the group in which this Tag will be displayed

return int - width (in characters) or -1 if not yet set

@inheritdoc from method TagInterface::getGroupWidth

public function getGroupWidth(): int

return int

---

VarTag::setGroupWidth

predicates	public
implements	TagInterface::setGroupWidth
inherited from	AbstractTag::setGroupWidth

@inheritdoc

Set the width (in characters) of the group in which this Tag will be displayed

param int $max_width - width (in characters)

return void

@inheritdoc from method TagInterface::setGroupWidth

public function setGroupWidth(
      Parameter #0 [ <required> int $max_width ]
 ): void

param int $max_width

return void

---

VarTag::toRst

predicates	public
implements	TagInterface::toRst
inherited from	AbstractTag::toRst

@inheritdoc

Express this Tag in reStructuredText

return string - reStructuredText representation of this Tag

@inheritdoc from method TagInterface::toRst

public function toRst(): string

return string

---

Fri, 31 Mar 2023 13:22:46 +0000