\phpDocumentor\Guides\References\Resolver\PhpPHPReference

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`

Summary

Methods

Properties

Constants

__construct()
supports()
resolve()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

withoutLeadingSlash()

$router

N/A

final

File: src/phpDocumentor/Guides/References/Resolver/Php/PHPReference.php
Package: phpDocumentor
Class hierarchy: \phpDocumentor\Guides\References\Resolver\Php\PHPReference
Implements
Uses

Properties

$router

$router : \phpDocumentor\Transformer\Router\Router

Type

\phpDocumentor\Transformer\Router\Router

Methods

__construct()

__construct(\phpDocumentor\Transformer\Router\Router  $router) : mixed

Parameters

\phpDocumentor\Transformer\Router\Router

$router

Returns

mixed —

supports()

supports(\phpDocumentor\Guides\Span\CrossReferenceNode  $node, \phpDocumentor\Guides\RenderContext  $context) : bool

Parameters

\phpDocumentor\Guides\Span\CrossReferenceNode	$node
\phpDocumentor\Guides\RenderContext	$context

Returns

bool —

resolve()

resolve(\phpDocumentor\Guides\Span\CrossReferenceNode  $node, \phpDocumentor\Guides\RenderContext  $context) : ?\phpDocumentor\Guides\References\ResolvedReference

Parameters

\phpDocumentor\Guides\Span\CrossReferenceNode	$node
\phpDocumentor\Guides\RenderContext	$context

Returns

?\phpDocumentor\Guides\References\ResolvedReference —

withoutLeadingSlash()

withoutLeadingSlash(string  $path) : string

Parameters

string

$path

Returns

string —