GenericLinkProvider
in package
FinalYes
Role to create references to link targets.
Example:
:ref:`label`
Table of Contents
Properties
- $prefixLinkTypeMapping : array<string, string>
- $textRoleLinkTypeMapping : array<string, string>
Methods
- addGenericLink() : void
- getLinkPrefix() : string
- getLinkType() : string
- getTextRoleLinkTypeMapping() : array<string|int, string>
Properties
$prefixLinkTypeMapping
private
array<string, string>
$prefixLinkTypeMapping
= ['ref' => '']
$textRoleLinkTypeMapping
private
array<string, string>
$textRoleLinkTypeMapping
= ['ref' => \phpDocumentor\Guides\Nodes\SectionNode::STD_LABEL]
Methods
addGenericLink()
public
addGenericLink(string $textRole, string $linkType[, string $prefix = '' ]) : void
Parameters
- $textRole : string
- $linkType : string
- $prefix : string = ''
getLinkPrefix()
public
getLinkPrefix(string $textRole) : string
Parameters
- $textRole : string
Return values
stringgetLinkType()
public
getLinkType(string $textRole) : string
Parameters
- $textRole : string
Return values
stringgetTextRoleLinkTypeMapping()
public
getTextRoleLinkTypeMapping() : array<string|int, string>