ArrayKey
extends AggregatedType
in package
implements
PseudoType
FinalYes
Value Object representing a array-key Type.
A array-key Type is the supertype (but not a union) of int and string.
Tags
Table of Contents
Interfaces
Properties
Methods
- __construct() : mixed
- __toString() : string
- Returns a rendered output of the Type as it would be used in a DocBlock.
- contains() : bool
- Tests if this compound type contains the given type.
- get() : Type|null
- Returns the type at the given index.
- getIterator() : ArrayIterator<int, Type>
- has() : bool
- Tests if this compound type has a type with the given index.
- underlyingType() : Type
- add() : void
Properties
$token
private
string
$token
$types
private
array<int, Type>
$types
= []
Tags
Methods
__construct()
public
__construct() : mixed
__toString()
Returns a rendered output of the Type as it would be used in a DocBlock.
public
__toString() : string
Return values
stringcontains()
Tests if this compound type contains the given type.
public
contains(Type $type) : bool
Parameters
- $type : Type
Return values
boolget()
Returns the type at the given index.
public
get(int $index) : Type|null
Parameters
- $index : int
Return values
Type|nullgetIterator()
public
getIterator() : ArrayIterator<int, Type>
Return values
ArrayIterator<int, Type>has()
Tests if this compound type has a type with the given index.
public
has(int $index) : bool
Parameters
- $index : int
Return values
boolunderlyingType()
public
underlyingType() : Type
Return values
Typeadd()
private
add(Type $type) : void
Parameters
- $type : Type