PHP Class TheSeer\phpDox\BootstrapApi

This class provides the API for use within the bootstrap process to register collecting backends, additional parsers for annotations, generator engines for additional output formats as well as enrichment plugins
Author: Arne Blankerts ([email protected])
ファイルを表示 Open project: theseer/phpdox

Public Methods

Method Description
__construct ( Factory $bf, Factory $df, TheSeer\phpDox\Generator\Enricher\Factory $erf, Factory $enf, TheSeer\phpDox\ProgressLogger $logger ) Constructor
getBackends ( ) : array Get list of all registered collector backends
getEngines ( ) : array Get list of all registered generator engines
getEnrichers ( ) : array Get list of all registered enrichers
registerBackend ( string $name, string $description = 'no description set' ) : BackendBootstrapApi Register a new backend
registerEngine ( string $name, string $description ) : EngineBootstrapApi Register a new generator enginge
registerEnricher ( string $name, string $description ) : EnricherBootstrapApi Register a new enricher
registerParser ( $annotation ) : ParserBootstrapApi

Method Details

__construct() public method

Constructor
public __construct ( Factory $bf, Factory $df, TheSeer\phpDox\Generator\Enricher\Factory $erf, Factory $enf, TheSeer\phpDox\ProgressLogger $logger )
$bf TheSeer\phpDox\Collector\Backend\Factory
$df TheSeer\phpDox\DocBlock\Factory
$erf TheSeer\phpDox\Generator\Enricher\Factory
$enf TheSeer\phpDox\Generator\Engine\Factory
$logger TheSeer\phpDox\ProgressLogger

getBackends() public method

Get list of all registered collector backends
public getBackends ( ) : array
return array

getEngines() public method

Get list of all registered generator engines
public getEngines ( ) : array
return array

getEnrichers() public method

Get list of all registered enrichers
public getEnrichers ( ) : array
return array

registerBackend() public method

Register a new backend
public registerBackend ( string $name, string $description = 'no description set' ) : BackendBootstrapApi
$name string Name of the collector backend
$description string A describing text
return BackendBootstrapApi

registerEngine() public method

Register a new generator enginge
public registerEngine ( string $name, string $description ) : EngineBootstrapApi
$name string Name of the generator engine
$description string A describing text
return EngineBootstrapApi

registerEnricher() public method

Register a new enricher
public registerEnricher ( string $name, string $description ) : EnricherBootstrapApi
$name string Name of the enricher
$description string A describing text
return EnricherBootstrapApi

registerParser() public method

public registerParser ( $annotation ) : ParserBootstrapApi
$annotation
return ParserBootstrapApi