Type
Tags
Methods
- assert() : T
- Checks that the value is of the type of this object, throwing when it is not.
- cast() : T
- Takes a value and when necessary casts it to the type of this object.
- isValid() : bool
- Checks if the value is of the type of this object, returning a boolean instead of throwing.
- normalize() : array<string, mixed>
- toString() : string
- Returns a string representation of the type.
Methods
assert()
Checks that the value is of the type of this object, throwing when it is not.
public
assert(mixed $value) : T
Unlike cast(), this method never performs any conversion — the value must already match the type. Unlike isValid(), this method returns the value (narrowed to T) instead of a boolean, and always narrows the static type.
Parameters
- $value : mixed
Tags
Return values
Tcast()
Takes a value and when necessary casts it to the type of this object.
public
cast(mixed $value) : T
When value is already of the type of this object, it is returned as is. When cast method is used, it will additionally narrow the type of the returned value for static analysis tools.
Parameters
- $value : mixed
Tags
Return values
TisValid()
Checks if the value is of the type of this object, returning a boolean instead of throwing.
public
isValid(mixed $value) : bool
When this method returns true, static analysis tools narrow the value's type to T at the call site (via @phpstan-assert-if-true). Use this when you want to branch on the result; use assert() when you want the call to fail loudly on a mismatch.
Parameters
- $value : mixed
Tags
Return values
boolnormalize()
public
normalize() : array<string, mixed>
Return values
array<string, mixed>toString()
Returns a string representation of the type.
public
toString() : string
- string - for type_string()
- int - for type_int()
- ?float - for type_optional(type_float())