final class Link

Source Code

Immutable data object that normalises phpDocumentor Link and See tags.

Namespace	BeastBytes\CodPhp\Util
Inheritance	BeastBytes\CodPhp\Util\Link

Properties

$content

Content of the link

Type	Read/Write	Default
string	Read

Declared in BeastBytes\CodPhp\Util\Link

---

$description

Type	Read/Write	Default
phpDocumentor\Reflection\DocBlock\Description|null	Read

Declared in BeastBytes\CodPhp\Util\Link

---

$element

Element the link is from.

Type	Read/Write	Default
BeastBytes\CodPhp\Element\Element	Read

Declared in BeastBytes\CodPhp\Util\Link

---

$isToConstant

true if the link is to a constant element, false if not.

Type	Read/Write	Default
bool	Read

Declared in BeastBytes\CodPhp\Util\Link

---

$isToDoc

true if the link is to hand-written documentation, false if not.

Type	Read/Write	Default
bool	Read

Declared in BeastBytes\CodPhp\Util\Link

---

$isToExternal

true if the link is to an external URI, false if not.

Type	Read/Write	Default
bool	Read

Declared in BeastBytes\CodPhp\Util\Link

---

$isToMethod

true if the link is to a method element, false if not.

Type	Read/Write	Default
bool	Read

Declared in BeastBytes\CodPhp\Util\Link

---

$isToProperty

true if the link is to a property element, false if not.

Type	Read/Write	Default
bool	Read

Declared in BeastBytes\CodPhp\Util\Link

---

$uri

Link URI

Type	Read/Write	Default
string	Read

Declared in BeastBytes\CodPhp\Util\Link

---

Methods

__construct()

Create a Link object.

public function __construct(phpDocumentor\Reflection\DocBlock\Tags\Link|phpDocumentor\Reflection\DocBlock\Tags\See $tag, BeastBytes\CodPhp\Element\Element $element)
$tag	phpDocumentor\Reflection\DocBlock\Tags\Link|phpDocumentor\Reflection\DocBlock\Tags\See	Tag containg link information.
$element	BeastBytes\CodPhp\Element\Element	Element the link is from.
throws	ReflectionException

Declared in BeastBytes\CodPhp\Util\Link

---

Generated by CodPhp