Reference
in package
A reference is something that can be resolved in the document, for instance:
:method:helloWorld()
Will be resolved as a reference of type method and the given reference will be called to resolve it
Tags
Table of Contents
- found() : void
- Called when a reference is just found
- getName() : string
- The name of the reference, i.e the :something:
- resolve() : ResolvedReference|null
- Resolve the reference and returns an array
Methods
found()
Called when a reference is just found
public
found(Environment $environment, string $data) : void
Parameters
- $environment : Environment
-
the Environment in use
- $data : string
-
the data of the reference
Return values
void —getName()
The name of the reference, i.e the :something:
public
abstract getName() : string
Return values
string —resolve()
Resolve the reference and returns an array
public
abstract resolve(Environment $environment, string $data) : ResolvedReference|null
Parameters
- $environment : Environment
-
the Environment in use
- $data : string
-
the data of the reference