67 lines
1.6 KiB
PHP
67 lines
1.6 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 phpDocumentor\Reflection\Fqsen;
|
|
use phpDocumentor\Reflection\Type;
|
|
|
|
/**
|
|
* Represents a collection type as described in the PSR-5, the PHPDoc Standard.
|
|
*
|
|
* A collection can be represented in two forms:
|
|
*
|
|
* 1. `ACollectionObject<aValueType>`
|
|
* 2. `ACollectionObject<aValueType,aKeyType>`
|
|
*
|
|
* - ACollectionObject can be 'array' or an object that can act as an array
|
|
* - aValueType and aKeyType can be any type expression
|
|
*/
|
|
final class Collection extends AbstractList
|
|
{
|
|
/** @var Fqsen|null */
|
|
private $fqsen;
|
|
|
|
/**
|
|
* Initializes this representation of an array with the given Type or Fqsen.
|
|
*/
|
|
public function __construct(?Fqsen $fqsen, Type $valueType, ?Type $keyType = null)
|
|
{
|
|
parent::__construct($valueType, $keyType);
|
|
|
|
$this->fqsen = $fqsen;
|
|
}
|
|
|
|
/**
|
|
* Returns the FQSEN associated with this object.
|
|
*/
|
|
public function getFqsen() : ?Fqsen
|
|
{
|
|
return $this->fqsen;
|
|
}
|
|
|
|
/**
|
|
* Returns a rendered output of the Type as it would be used in a DocBlock.
|
|
*/
|
|
public function __toString() : string
|
|
{
|
|
$objectType = (string) ($this->fqsen ?? 'object');
|
|
|
|
if ($this->keyType === null) {
|
|
return $objectType . '<' . $this->valueType . '>';
|
|
}
|
|
|
|
return $objectType . '<' . $this->keyType . ',' . $this->valueType . '>';
|
|
}
|
|
}
|