ExampleTagsEnricher

in package
Implements CompilerPassInterface

This index builder collects all examples from tags and inserts them into the example index.

Interfaces, Classes & Used Traits

CompilerPassInterface
Represents a single pass / business rule to be executed by the Compiler.
ExampleTagsEnricher.php

Constants

Properties

private$exampleAssembler  : \phpDocumentor\Descriptor\Builder\Reflector\Tags\ExampleAssembler

Methods

Initializes this compiler pass with its dependencies.

public__construct(ExampleFinder $finder) : mixed

Parameters

$finder : ExampleFinder

Finds examples in several directories.

Returns

mixed —

Returns a textual description of what this pass does for output purposes.

publicgetDescription() : string

Please note that the command line will be truncated to 68 characters ( .. 000.000s) so longer descriptions won't have much use.

Returns

string —

Executes a compiler pass.

publicexecute(ProjectDescriptor $project) : void

This method will execute the business logic associated with a given compiler pass and allow it to manipulate or consumer the Object Graph using the ProjectDescriptor object.

Parameters

$project : ProjectDescriptor

Representation of the Object Graph that can be manipulated.

Replaces the example tags in the description with the contents of the found example.

protectedreplaceInlineExamples(DescriptorAbstract $element) : string

Parameters

$element : DescriptorAbstract

Returns

string —