BumbleDocGen / Technical description of the project / Parser / Entities and entities collections / ConstantEntityCollection
ConstantEntityCollection class:
namespace BumbleDocGen\LanguageHandler\Php\Parser\Entity;
final class ConstantEntityCollection extends \BumbleDocGen\Core\Parser\Entity\BaseEntityCollection implements \IteratorAggregate, \Traversable- add
- get
- getIterator - Retrieve an external iterator
- has
- isEmpty
- loadConstantEntities
- remove
- unsafeGet
- # __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\ConstantEntity $constantEntity, bool $reload = false): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ConstantEntityCollection;Parameters:
| Name | Type | Description |
|---|---|---|
| $constantEntity | \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ConstantEntity | - |
| $reload | bool | - |
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ConstantEntityCollection
- # get | source code
public function get(string $objectName): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ConstantEntity|null;Parameters:
| Name | Type | Description |
|---|---|---|
| $objectName | string | - |
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ConstantEntity | 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:
- # 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
- # loadConstantEntities | source code
public function loadConstantEntities(): void;Parameters: not specified
Return value: void
Throws:
- # 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 $constantName): \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ConstantEntity|null;Parameters:
| Name | Type | Description |
|---|---|---|
| $constantName | string | - |
Return value: \BumbleDocGen\LanguageHandler\Php\Parser\Entity\ConstantEntity | null
Throws: