89 lines
2.2 KiB
PHP
89 lines
2.2 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
/**
|
|
* This file is part of phpDocumentor.
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*
|
|
* @link http://phpdoc.org
|
|
*/
|
|
|
|
namespace phpDocumentor\Reflection\Types;
|
|
|
|
use ArrayIterator;
|
|
use InvalidArgumentException;
|
|
use IteratorAggregate;
|
|
use phpDocumentor\Reflection\Type;
|
|
use function implode;
|
|
|
|
/**
|
|
* Value Object representing a Compound Type.
|
|
*
|
|
* A Compound Type is not so much a special keyword or object reference but is a series of Types that are separated
|
|
* using an OR operator (`|`). This combination of types signifies that whatever is associated with this compound type
|
|
* may contain a value with any of the given types.
|
|
*/
|
|
final class Compound implements Type, IteratorAggregate
|
|
{
|
|
/** @var Type[] */
|
|
private $types;
|
|
|
|
/**
|
|
* Initializes a compound type (i.e. `string|int`) and tests if the provided types all implement the Type interface.
|
|
*
|
|
* @param Type[] $types
|
|
*
|
|
* @throws InvalidArgumentException When types are not all instance of Type.
|
|
*/
|
|
public function __construct(array $types)
|
|
{
|
|
foreach ($types as $type) {
|
|
/** @psalm-suppress RedundantConditionGivenDocblockType */
|
|
if (!$type instanceof Type) {
|
|
throw new InvalidArgumentException('A compound type can only have other types as elements');
|
|
}
|
|
}
|
|
|
|
$this->types = $types;
|
|
}
|
|
|
|
/**
|
|
* Returns the type at the given index.
|
|
*/
|
|
public function get(int $index) : ?Type
|
|
{
|
|
if (!$this->has($index)) {
|
|
return null;
|
|
}
|
|
|
|
return $this->types[$index];
|
|
}
|
|
|
|
/**
|
|
* Tests if this compound type has a type with the given index.
|
|
*/
|
|
public function has(int $index) : bool
|
|
{
|
|
return isset($this->types[$index]);
|
|
}
|
|
|
|
/**
|
|
* Returns a rendered output of the Type as it would be used in a DocBlock.
|
|
*/
|
|
public function __toString() : string
|
|
{
|
|
return implode('|', $this->types);
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getIterator()
|
|
{
|
|
return new ArrayIterator($this->types);
|
|
}
|
|
}
|