42 lines
1.0 KiB
PHP
42 lines
1.0 KiB
PHP
|
<?php
|
||
|
|
|
||
|
|
declare(strict_types=1);
|
||
|
|
|
||
|
|
namespace Doctrine\RST\References;
|
||
|
|
|
||
|
|
use Doctrine\RST\Environment;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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
|
||
|
|
*/
|
||
|
|
abstract class Reference
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* The name of the reference, i.e the :something:
|
||
|
|
*/
|
||
|
|
abstract public function getName(): string;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Resolve the reference and returns an array
|
||
|
|
*
|
||
|
|
* @param Environment $environment the Environment in use
|
||
|
|
* @param string $data the data of the reference
|
||
|
|
*/
|
||
|
|
abstract public function resolve(Environment $environment, string $data): ?ResolvedReference;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Called when a reference is just found
|
||
|
|
*
|
||
|
|
* @param Environment $environment the Environment in use
|
||
|
|
* @param string $data the data of the reference
|
||
|
|
*/
|
||
|
|
public function found(Environment $environment, string $data): void
|
||
|
|
{
|
||
|
|
}
|
||
|
|
}
|