PHP Typ

Nette\Utils\Type reprezentuje datový typ PHP. Slouží k analýze, porovnávání a manipulaci s typy, ať už pocházejí z řetězce nebo z reflexe.

PHP má dnes velmi bohatý typový systém: od skalárních typů (int, string) přes objekty a rozhraní až po složené typy (union A|B, intersection A&B nebo disjunktivní normální formy (A&B)|D). Navíc existují speciální typy jako void, never, mixed nebo relativní self či static.

Práce s těmito typy nativně, zejména přes ReflectionType, je často zdlouhavá, protože musíte rekurzivně rozlišovat mezi ReflectionNamedType, ReflectionUnionType a dalšími objekty. Třída Nette\Utils\Type toto vše zapouzdřuje a poskytuje jednotné a srozumitelné API pro práci s jakýmkoliv typem, který PHP podporuje.

Umožňuje například snadno zjistit, zda jeden typ akceptuje druhý (kompatibilita), rozšiřovat typy nebo převádět reflexe na čitelný zápis.

Instalace:

composer require nette/utils

Všechny příklady předpokládají vytvořený alias:

use Nette\Utils\Type;

fromReflection ($reflection): ?Type

Statická metoda vytvoří objekt Type na základě reflexe. Parameterem může být objekt ReflectionMethod nebo ReflectionFunction (vrací typ návratové hodnoty) nebo ReflectionParameter či ReflectionProperty. Překládá self, static a parent na skutečný název třídy. Pokud subjekt nemá žádný typ, vrátí null.

class DemoClass
{
	public self $foo;
}

$prop = new ReflectionProperty(DemoClass::class, 'foo');
echo Type::fromReflection($prop); // 'DemoClass'

fromString (string $type): Type

Statická metoda vytvoří objekt Type podle textového zápisu.

$type = Type::fromString('Foo|Bar');
echo $type;      // 'Foo|Bar'

fromValue (mixed $value): Type

Statická metoda, která vytvoří objekt Type podle typu předané hodnoty.

$type = Type::fromValue('hello'); // 'string'
$type = Type::fromValue(123);     // 'int'
$type = Type::fromValue(new stdClass); // 'stdClass'

Pro resources vrací mixed, protože PHP typ resource nezná. U anonymních tříd vrací nejbližšího předka nebo typ object.

$obj = new class extends Foo { };
$type = Type::fromValue($obj);    // 'Foo'

getNames (): (string|array)[]

Vrací pole podtypů, ze kterých se skládá složený typ, jako řetězce.

$type = Type::fromString('string|null'); // nebo '?string'
$type->getNames();  // ['string', 'null']

$type = Type::fromString('(Foo&Bar)|string');
$type->getNames();  // [['Foo', 'Bar'], 'string']

getTypes(): Type[]

Vrací pole podtypů, ze kterých se skládá složený typ, jako objekty ReflectionType:

$type = Type::fromString('string|null'); // or '?string'
$type->getTypes();  // [Type::fromString('string'), Type::fromString('null')]

$type = Type::fromString('(Foo&Bar)|string');
$type->getTypes();  // [Type::fromString('Foo&Bar'), Type::fromString('string')]

$type = Type::fromString('Foo&Bar');
$type->getTypes();  // [Type::fromString('Foo'), Type::fromString('Bar')]

getSingleName(): ?string

U simple typů vrací název typu, jinak null.

$type = Type::fromString('string|null');
echo $type;                       // '?string'
echo $type->getSingleName();      // 'string'

$type = Type::fromString('?Foo');
echo $type;                       // '?Foo'
echo $type->getSingleName();      // 'Foo'

$type = Type::fromString('Foo|Bar');
echo $type;                       // 'Foo|Bar'
echo $type->getSingleName();      // null

isSimple(): bool

Vrací, zda je o simple typ. Za simple typy se považují i jednoduché nullable typy:

$type = Type::fromString('string');
$type->isSimple();       // true
$type->isUnion();        // false

$type = Type::fromString('?Foo'); // nebo 'Foo|null'
$type->isSimple();       // true
$type->isUnion();        // true

isUnion(): bool

Vrací, zda je o union typ.

$type = Type::fromString('string|int');
$type->isUnion();        // true

isIntersection(): bool

Vrací, zda je o intersection typ.

$type = Type::fromString('Foo&Bar');
$type->isIntersection(); // true

isBuiltin(): bool

Vrací, zda je typ simple a zároveň vestavěným typem PHP.

$type = Type::fromString('string');
$type->isBuiltin(); // true

$type = Type::fromString('string|int');
$type->isBuiltin(); // false

$type = Type::fromString('Foo');
$type->isBuiltin(); // false

isClass(): bool

Vrací, zda je typ simple a zároveň název třídy.

$type = Type::fromString('string');
$type->isClass();   // false

$type = Type::fromString('Foo|null');
$type->isClass();   // true

$type = Type::fromString('Foo|Bar');
$type->isClass();   // false

isClassKeyword(): bool

Vrací, zda je typ jedním z interních typů self, parent, static.

$type = Type::fromString('self');
$type->isClassKeyword();   // true

$type = Type::fromString('Foo');
$type->isClassKeyword();   // false

allows (string|Type $type): bool

Metoda allows() ověřuje kompatibilitu typů. Například umožní zjistit, jestli hodnota určitého typu by mohla být předaná jako parametr.

$type = Type::fromString('string|null');
$type->allows('string'); // true
$type->allows('null');   // true
$type->allows('Foo');    // false

$type = Type::fromString('mixed');
$type->allows('null');   // true

with (string|Type $type): Type

Vrací objekt Type, který akceptuje jak původní typ, tak i nově přidaný. Vytváří tzv. union type.

Metoda je chytrá a typy zbytečně nezdvojuje. Pokud přidáte typ, který je již obsažen, nebo je nadmnožinou stávajícího typu (např. přidání mixed k string), vrátí se zjednodušený výsledek.

$type = Type::fromString('string');

// Rozšíření na nullable string
echo $type->with('null'); // '?string'

// Vytvoření union typu
echo $type->with('int');  // 'string|int'

// Přidání typu, který "přebije" vše ostatní
echo $type->with('mixed'); // 'mixed'