SourceLocatorsCollection.md

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

---

SourceLocatorsCollection class:

namespace BumbleDocGen\Core\Parser\SourceLocator;

final class SourceLocatorsCollection implements \IteratorAggregate, \Traversable

Methods:

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

Method details:

• # add | source code

public function add(\BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorInterface $sourceLocator): \BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection;

Parameters:

Name	Type	Description
$sourceLocator	\BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorInterface	-

Return value: \BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection

---

• # create | source code

public static function create(\BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorInterface ...$sourceLocators): \BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection;

Parameters:

Name	Type	Description
$sourceLocators (variadic)	\BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorInterface	-

Return value: \BumbleDocGen\Core\Parser\SourceLocator\SourceLocatorsCollection

---

• # getCommonFinder | source code

public function getCommonFinder(): \Symfony\Component\Finder\Finder;

Parameters: not specified

Return value: \Symfony\Component\Finder\Finder

---

• # getIterator | source code

public function getIterator(): \Generator;

Retrieve an external iterator

Parameters: not specified

Return value: \Generator

Throws:

• \Exception - on failure.

See:

• https://php.net/manual/en/iteratoraggregate.getiterator.php

---