UriTag
Any tag that includes a URI or a symbol and a description.
Constructors / Destructors
Returns | Signature and Description |
---|---|
void | __construct ( , , )Creates a new UriTag. |
Instance Methods
Returns | Signature and Description |
---|---|
string | Returns a string representation. |
string | Gets the tag description. |
string | getName ()Gets the name of the tag |
string | getUri ()Gets the tag types |
bool | Whether this tag is needed in the vector. |
Static Methods
Returns | Signature and Description |
---|---|
bool | applies ( )Whether the given tag name applies to this class. |
Method Details
__construct
public function
__construct
(string
$name
, string
$uri
, string
$description
)Creates a new UriTag.
Name | Type | Description |
---|---|---|
$name | string | The tag name |
$uri | string | The URI or symbol |
$description | string | The tag description |
__toString
public function
__toString
()Returns a string representation.
Type | Description |
---|---|
string | The string representation |
applies
public static function
applies
(string
$tagName
)Whether the given tag name applies to this class.
Name | Type | Description |
---|---|---|
$tagName | string | The tag name to test |
Type | Description |
---|---|
bool | whether the tag name applies |
getDescription
Inherited from DescribedTag
public function
getDescription
()Gets the tag description.
Type | Description |
---|---|
string | The tag description |
getName
Inherited from Tag
public function
getName
()Gets the name of the tag
Type | Description |
---|---|
string | The name |
getUri
public function
getUri
()Gets the tag types
Type | Description |
---|---|
string | The tag types |
isNeeded
public function
isNeeded
(ConstVector
<Tag
> $tags
)Whether this tag is needed in the vector.
Name | Type | Description |
---|---|---|
$tags | ConstVector <Tag > | The tags |
Type | Description |
---|---|
bool |
|