DocumentedEntityWrappersCollection.md

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

---

DocumentedEntityWrappersCollection class:

namespace BumbleDocGen\Core\Renderer\Context;

final class DocumentedEntityWrappersCollection implements \IteratorAggregate, \Traversable, \Countable

Initialization methods:

1. __construct

Methods:

1. count - Count elements of an object
2. createAndAddDocumentedEntityWrapper
3. getDocumentedEntitiesRelations
4. getIterator - Retrieve an external iterator

Method details:

• # __construct | source code

public function __construct(\BumbleDocGen\Core\Renderer\Context\RendererContext $rendererContext, \BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache $localObjectCache, \BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper $breadcrumbsHelper, \BumbleDocGen\Core\Plugin\PluginEventDispatcher $pluginEventDispatcher);

Parameters:

Name	Type	Description
$rendererContext	\BumbleDocGen\Core\Renderer\Context\RendererContext	-
$localObjectCache	\BumbleDocGen\Core\Cache\LocalCache\LocalObjectCache	-
$breadcrumbsHelper	\BumbleDocGen\Core\Renderer\Breadcrumbs\BreadcrumbsHelper	-
$pluginEventDispatcher	\BumbleDocGen\Core\Plugin\PluginEventDispatcher	-

---

• # count | source code

public function count(): int;

Count elements of an object

Parameters: not specified

Return value: int

See:

• https://php.net/manual/en/countable.count.php

---

• # createAndAddDocumentedEntityWrapper | source code

public function createAndAddDocumentedEntityWrapper(\BumbleDocGen\Core\Parser\Entity\RootEntityInterface $rootEntity): \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper;

Parameters:

Name	Type	Description
$rootEntity	\BumbleDocGen\Core\Parser\Entity\RootEntityInterface	-

Return value: \BumbleDocGen\Core\Renderer\Context\DocumentedEntityWrapper

Throws:

• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---

• # getDocumentedEntitiesRelations | source code

public function getDocumentedEntitiesRelations(): array;

Parameters: not specified

Return value: array

---

• # 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

---