Skip to content

Latest commit

 

History

History
200 lines (137 loc) · 4.63 KB

PluginsCollection.md

File metadata and controls

200 lines (137 loc) · 4.63 KB

BumbleDocGen / Technical description of the project / Class map / PluginsCollection


namespace BumbleDocGen\Core\Plugin;

final class PluginsCollection implements \IteratorAggregate, \Traversable

Methods:

  1. add
  2. create
  3. get
  4. getIterator - Retrieve an external iterator

Method details:

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


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


public function get(string $key): \BumbleDocGen\Core\Plugin\PluginInterface|null;

Parameters:

Name Type Description
$key string -

Return value: \BumbleDocGen\Core\Plugin\PluginInterface | null


public function getIterator(): \Generator;
Retrieve an external iterator

Parameters: not specified

Return value: \Generator

Throws:

See: