BumbleDocGen / Technical description of the project / Class map / PluginsCollection
PluginsCollection class:
namespace BumbleDocGen\Core\Plugin;
final class PluginsCollection implements \IteratorAggregate, \Traversable
- add
- create
- get
- getIterator - Retrieve an external iterator
- # add | source code
public function add(\BumbleDocGen\Core\Plugin\PluginInterface ...$plugins): \BumbleDocGen\Core\Plugin\PluginsCollection;
Parameters:
Name | Type | Description |
---|---|---|
$plugins (variadic) | \BumbleDocGen\Core\Plugin\PluginInterface | - |
Return value: \BumbleDocGen\Core\Plugin\PluginsCollection
- # create | source code
public static function create(\BumbleDocGen\Core\Plugin\PluginInterface ...$plugins): \BumbleDocGen\Core\Plugin\PluginsCollection;
Parameters:
Name | Type | Description |
---|---|---|
$plugins (variadic) | \BumbleDocGen\Core\Plugin\PluginInterface | - |
Return value: \BumbleDocGen\Core\Plugin\PluginsCollection
- # get | source code
public function get(string $key): \BumbleDocGen\Core\Plugin\PluginInterface|null;
Parameters:
Name | Type | Description |
---|---|---|
$key | string | - |
Return value: \BumbleDocGen\Core\Plugin\PluginInterface | null
- # getIterator | source code
public function getIterator(): \Generator;
Retrieve an external iterator
Parameters: not specified
Return value: \Generator
Throws:
- \Exception - on failure.
See: