\phpDocumentor\ParserServiceProvider

This provider is responsible for registering the parser component with the given Application.

Summary

Methods
Properties
Constants
register()
validateDocBlocks()
No public properties found
No constants found
loadConfiguration()
loadConfigurationByElement()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

register()

register(\Cilex\Application  $app) : void

Registers services on the given app.

Parameters

\Cilex\Application $app

An Application instance

Throws

\phpDocumentor\Parser\Exception\MissingDependencyException

if the Descriptor Builder is not present.

validateDocBlocks()

validateDocBlocks(\phpDocumentor\Reflection\Event\PostDocBlockExtractionEvent  $data) : void

Checks all phpDocumentor whether they match the given rules.

Parameters

\phpDocumentor\Reflection\Event\PostDocBlockExtractionEvent $data

Event object containing the parameters.

loadConfiguration()

loadConfiguration() : array

Load the configuration from the plugin.xml file

Returns

array

loadConfigurationByElement()

loadConfigurationByElement(array  $configOptions, string  $configType) : array

Load the configuration for given element (deprecated/required)

Parameters

array $configOptions

The configuration from the plugin.xml file

string $configType

Required/Deprecated for the time being

Returns

array