PHPReference
in package
implements
Resolver
FinalYes
php domain reference resolver
Resolves the references in php domain. All elements supported by phpDocument's api component are available in the
router, and can be referenced from guides.
To reference a class you can use the example below.
:php:class:`\phpDocumentor\Guides\References\Resolver\Php\PHPReference`
Table of Contents
Interfaces
- Resolver
Properties
Methods
- __construct() : mixed
- resolve() : ResolvedReference|null
- supports() : bool
- withoutLeadingSlash() : string
Properties
$router
private
Router
$router
Methods
__construct()
public
__construct(Router $router) : mixed
Parameters
- $router : Router
resolve()
public
resolve(CrossReferenceNode $node, RenderContext $context) : ResolvedReference|null
Parameters
- $node : CrossReferenceNode
- $context : RenderContext
Return values
ResolvedReference|nullsupports()
public
supports(CrossReferenceNode $node, RenderContext $context) : bool
Parameters
- $node : CrossReferenceNode
- $context : RenderContext
Return values
boolwithoutLeadingSlash()
private
withoutLeadingSlash(string $path) : string
Parameters
- $path : string