TheSeer\phpDox\BootstrapApi
Bootstrapping API for registering backends, generator engines and parsers
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 <arne@blankerts.de>
- Copyright: Arne Blankerts <arne@blankerts.de>, All rights reserved.
- License: BSD License
Synopsis
- // members
- private Factory $backendFactory;
- private Factory $engineFactory;
- private Factory $parserFactory;
- private Factory $enricherFactory;
- private array $engines;
- private array $enrichers;
- private array $backends;
- // methods
- public void __construct()
- public array getEngines()
- public array getEnrichers()
- public array getBackends()
- public BackendBootstrapApi registerBackend()
- public EngineBootstrapApi registerEngine()
- public ParserBootstrapApi registerParser()
- public EnricherBootstrapApi registerEnricher()
Violations
PHPMessDetector
Line | Rule | Message |
---|---|---|
109 | ShortVariable | Avoid variables with short names like $bf. Configured minimum length is 3. |
109 | ShortVariable | Avoid variables with short names like $df. Configured minimum length is 3. |
Members
private
- $backendFactory
—
TheSeer\phpDox\Collector\Backend\Factory
Reference to the BackendFactory instance - $backends
—
array
Array of registered backends - $engineFactory
—
TheSeer\phpDox\Generator\Engine\Factory
Reference to the EngineFactory instance - $engines
—
array
Array of registered engines - $enricherFactory — TheSeer\phpDox\Generator\Enricher\Factory
- $enrichers
—
array
Array of registered enrichers - $parserFactory
—
TheSeer\phpDox\DocBlock\Factory
Reference to the DocblockParserFactory instance
Methods
public
- __construct() — Constructor
- getBackends() — Get list of all registered collector backends
- getEngines() — Get list of all registered generator engines
- getEnrichers() — Get list of all registered enrichers
- registerBackend() — Register a new backend
- registerEngine() — Register a new generator enginge
- registerEnricher() — Register a new enricher
- registerParser()
History
-
2014-04-20T19:11:34+02:00 (commit #aaf8a91)
Author: Arne Blankerts (Arne@Blankerts.de) / Commiter: Arne Blankerts (Arne@Blankerts.de)
More Cleanup
-
2014-02-05T01:36:10+01:00 (commit #84b92e5)
Author: Arne Blankerts (Arne@Blankerts.de) / Commiter: Arne Blankerts (Arne@Blankerts.de)
Bump Copyright year, some cleanups
-
2013-11-10T20:59:30+01:00 (commit #12d5768)
Author: Arne Blankerts (Arne@Blankerts.de) / Commiter: Arne Blankerts (Arne@Blankerts.de)
Make things private, cleanup docblocks
-
2013-10-27T01:43:22+02:00 (commit #6ae5e5d)
Author: Arne Blankerts (Arne@Blankerts.de) / Commiter: Arne Blankerts (Arne@Blankerts.de)
Added list of available enrichers to CLI
-
2013-08-07T02:45:04+02:00 (commit #05a7c94)
Author: Arne Blankerts (Arne@Blankerts.de) / Commiter: Arne Blankerts (Arne@Blankerts.de)
Bump Copyright to 2013 ;)
-
2013-07-05T09:51:30+02:00 (commit #48a49b7)
Author: Arne Blankerts (Arne@Blankerts.de) / Commiter: Arne Blankerts (Arne@Blankerts.de)
Foundations for enriching support implementend
-
2013-03-31T15:41:00+02:00 (commit #d6eda9b)
Author: Arne Blankerts (Arne@Blankerts.de) / Commiter: Arne Blankerts (Arne@Blankerts.de)
Inheritance resolving - WIP
-
2012-10-04T14:25:18+02:00 (commit #b746ee1)
Author: Arne Blankerts (Arne@Blankerts.de) / Commiter: Arne Blankerts (Arne@Blankerts.de)
Added basic docblock
-
2012-07-21T12:30:35+02:00 (commit #c36cbad)
Author: Arne Blankerts (Arne@Blankerts.de) / Commiter: Arne Blankerts (Arne@Blankerts.de)
Refactoring in progress
-
2012-01-07T21:35:02+01:00 (commit #3bb10b3)
Author: Arne Blankerts (Arne@Blankerts.de) / Commiter: Arne Blankerts (Arne@Blankerts.de)
Bump Copyright year
-
2011-12-31T11:55:17+01:00 (commit #5a7bbe6)
Author: Arne Blankerts (Arne@Blankerts.de) / Commiter: Arne Blankerts (Arne@Blankerts.de)
- Major refactoring: - Switched from CLI params to XML based config file - Lots of rewrites of internal parameter passing and logic - Renamed"builder" to "engine"
-
2011-08-17T19:37:51+02:00 (commit #48edbb7)
Author: Arne Blankerts (Arne@Blankerts.de) / Commiter: Arne Blankerts (Arne@Blankerts.de)
change filenames to camel case
-
2011-05-11T16:33:14+02:00 (commit #dfeb7bb)
Author: Arne Blankerts (Arne@Blankerts.de) / Commiter: Arne Blankerts (Arne@Blankerts.de)
Refactor: Use container class in favor of passing around the same DOMDocuments all the time
-
2011-05-11T00:40:04+02:00 (commit #5ef2885)
Author: Arne Blankerts (Arne@Blankerts.de) / Commiter: Arne Blankerts (Arne@Blankerts.de)
refactor to have automagic bootstrapping for builder
-
2011-05-02T00:28:17+02:00 (commit #5fd3a2e)
Author: Arne Blankerts (Arne@Blankerts.de) / Commiter: Arne Blankerts (Arne@Blankerts.de)
Remove var_dump ;)
-
2011-05-02T00:15:35+02:00 (commit #b4e8c7d)
Author: Arne Blankerts (Arne@Blankerts.de) / Commiter: Arne Blankerts (Arne@Blankerts.de)
- Rewrote Generator to use Events - Build up first generic (html) renderer - Added process logging output - Reworked Parameters - Enhanced Parsing logic - Moved some files around ;)