PropertyEntityCollection.md

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

---

PropertyEntityCollection class:

namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;

final class PropertyEntityCollection extends \BumbleDocGen\Core\Parser\Entity\BaseEntityCollection implements \IteratorAggregate, \Traversable

Initialization methods:

1. __construct

Methods:

1. add
2. get
3. getIterator - Retrieve an external iterator
4. has
5. isEmpty
6. loadPropertyEntities
7. remove
8. unsafeGet

Method details:

• # __construct | source code

public function __construct(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity $classEntity, \BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings $phpHandlerSettings, \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory $cacheablePhpEntityFactory);

Parameters:

Name	Type	Description
$classEntity	\BumbleDocGen\LanguageHandler\Php\Parser\Entity\ClassEntity	-
$phpHandlerSettings	\BumbleDocGen\LanguageHandler\Php\PhpHandlerSettings	-
$cacheablePhpEntityFactory	\BumbleDocGen\LanguageHandler\Php\Parser\Entity\Cache\CacheablePhpEntityFactory	-

---

• # add | source code

public function add(\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PropertyEntity $propertyEntity, bool $reload = false): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PropertyEntityCollection;

Parameters:

Name	Type	Description
$propertyEntity	\BumbleDocGen\LanguageHandler\Php\Parser\Entity\PropertyEntity	-
$reload	bool	-

Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PropertyEntityCollection

---

• # get | source code

public function get(string $objectName): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PropertyEntity|null;

Parameters:

Name	Type	Description
$objectName	string	-

Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PropertyEntity | null

---

• # getIterator | source code

// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection

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

// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection

public function has(string $objectName): bool;

Parameters:

Name	Type	Description
$objectName	string	-

Return value: bool

---

• # isEmpty | source code

// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection

public function isEmpty(): bool;

Parameters: not specified

Return value: bool

---

• # loadPropertyEntities | source code

public function loadPropertyEntities(): void;

Parameters: not specified

Return value: void

Throws:

• \DI\DependencyException
• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException
• \DI\NotFoundException
• \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException

---

• # remove | source code

// Implemented in BumbleDocGen\Core\Parser\Entity\BaseEntityCollection

public function remove(string $objectName): void;

Parameters:

Name	Type	Description
$objectName	string	-

Return value: void

---

• # unsafeGet | source code

public function unsafeGet(string $objectName): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PropertyEntity|null;

Parameters:

Name	Type	Description
$objectName	string	-

Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\PropertyEntity | null

Throws:

• \DI\NotFoundException
• \DI\DependencyException
• \BumbleDocGen\LanguageHandler\Php\Parser\Entity\Exception\ReflectionException
• \BumbleDocGen\Core\Configuration\Exception\InvalidConfigurationParameterException

---