PHP 클래스 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

저자: Arne Blankerts ([email protected])

파일 보기 프로젝트 열기: theseer/phpdox

공개 메소드들

메소드	설명
__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

메소드 상세

__construct() 공개 메소드

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() 공개 메소드

Get list of all registered collector backends

public getBackends ( ) : array
리턴	array

getEngines() 공개 메소드

Get list of all registered generator engines

public getEngines ( ) : array
리턴	array

getEnrichers() 공개 메소드

Get list of all registered enrichers

public getEnrichers ( ) : array
리턴	array

registerBackend() 공개 메소드

public registerBackend ( string $name, string $description = 'no description set' ) : BackendBootstrapApi
$name	string	Name of the collector backend
$description	string	A describing text
리턴	BackendBootstrapApi

registerEngine() 공개 메소드

public registerEngine ( string $name, string $description ) : EngineBootstrapApi
$name	string	Name of the generator engine
$description	string	A describing text
리턴	EngineBootstrapApi

registerEnricher() 공개 메소드

public registerEnricher ( string $name, string $description ) : EnricherBootstrapApi
$name	string	Name of the enricher
$description	string	A describing text
리턴	EnricherBootstrapApi

registerParser() 공개 메소드

public registerParser ( $annotation ) : ParserBootstrapApi
$annotation
리턴	ParserBootstrapApi