RootEntityCollectionsGroup.md

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

---

RootEntityCollectionsGroup class:

namespace BumbleDocGen\Core\Parser\Entity;

final class RootEntityCollectionsGroup implements \IteratorAggregate, \Traversable

Methods:

1. add
2. clearOperationsLog
3. get
4. getIterator - Retrieve an external iterator
5. getOperationsLog
6. getOperationsLogWithoutDuplicates
7. isFoundEntitiesOperationsLogCacheOutdated
8. updateAllEntitiesCache

Method details:

• # add | source code

public function add(\BumbleDocGen\Core\Parser\Entity\RootEntityCollection $rootEntityCollection): void;

Parameters:

Name	Type	Description
$rootEntityCollection	\BumbleDocGen\Core\Parser\Entity\RootEntityCollection	-

Return value: void

---

• # clearOperationsLog | source code

public function clearOperationsLog(): void;

Parameters: not specified

Return value: void

---

• # get | source code

public function get(string $collectionName): \BumbleDocGen\Core\Parser\Entity\RootEntityCollection|null;

Parameters:

Name	Type	Description
$collectionName	string	-

Return value: \BumbleDocGen\Core\Parser\Entity\RootEntityCollection | null

---

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

---

• # getOperationsLog | source code

public function getOperationsLog(): array;

Parameters: not specified

Return value: array

---

• # getOperationsLogWithoutDuplicates | source code

public function getOperationsLogWithoutDuplicates(): array;

Parameters: not specified

Return value: array

---

• # isFoundEntitiesOperationsLogCacheOutdated | source code

public function isFoundEntitiesOperationsLogCacheOutdated(array $classEntityCollectionOperationsLog): bool;

Parameters:

Name	Type	Description
$classEntityCollectionOperationsLog	array	-

Return value: bool

---

• # updateAllEntitiesCache | source code

public function updateAllEntitiesCache(): void;

Parameters: not specified

Return value: void

Throws:

• \Psr\Cache\InvalidArgumentException

---