BaseEntityCollection.md

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

---

BaseEntityCollection class:

namespace BumbleDocGen\Core\Parser\Entity;

abstract class BaseEntityCollection implements \IteratorAggregate, \Traversable

Methods:

1. get
2. getIterator - Retrieve an external iterator
3. has
4. isEmpty
5. remove

Method details:

• # get | source code

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

Parameters:

Name	Type	Description
$objectName	string	-

Return value: \BumbleDocGen\Core\Parser\Entity\EntityInterface | 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

---

• # has | source code

public function has(string $objectName): bool;

Parameters:

Name	Type	Description
$objectName	string	-

Return value: bool

---

• # isEmpty | source code

public function isEmpty(): bool;

Parameters: not specified

Return value: bool

---

• # remove | source code

public function remove(string $objectName): void;

Parameters:

Name	Type	Description
$objectName	string	-

Return value: void

---