README

Collection of value objects that represent the types of the PHP static analysis type system (Psalm, PHPStan).

All implementations of Type should be treated as sealed. The Type interface MUST NOT be implemented in userland. If one needs an alias for a complex compound type, implement Alias or create a builder/function instead.

This library will never have any dependencies. Once full and stable, it might be proposed as a PSR.

Installation

composer require poseidon/type

Naming

Value objects, representing native PHP types cannot be named after them, because words like Int, Strind etc. are reserved. A suffix might be introduced to fix this problem. Type suffix is too verbose, so we have chosen T: int -> IntT, float -> FloatT. Although types like non-empty-list can be safely named NonEmptyList, for now we have decided to follow the T-convention for all types.

Supported types

Scalar types

• bool
• int
• positive-int
• float
• non-empty-string
• string
• literal-string
• array-key
• numeric-string
• class-string
• class-string<T>
• interface-string
• trait-string
• enum-string
• callable-string
• numeric
• scalar

Literals

• null
• true
• false
• -10
• -0.34
• 'foo'

Array types

• list<TValue>
• non-empty-list<TValue>
• array<TKey, TValue>
• non-empty-array<TKey, TValue>
• array{foo: int, bar?: string}, array{int, string}
• callable-array

Object types

• object
• Foo\MyClass<T>
• Generator<TKey, TValue, TSend, TReturn>
• static

Callable types

• callable(Foo, Bar=): Baz
• \Closure(Foo, Bar=): Baz

Constants

• Foo\Bar::MY_SCALAR_CONST
• key-of<Foo\Bar::ARRAY_CONST>
• value-of<Foo\Bar::ARRAY_CONST>
• key-of<T>, T[TKey] (example)

Other types

• ?T
• never
• void
• mixed
• iterable<TKey, TValue>
• resource
• union types
• intersection types
• template types