Typy
@param int $count v komentáři je jen slib, int $count v signatuře PHP vynutí.
Sekce types rozhoduje, jestli parametr, vlastnost, návratová hodnota a konstanta třídy musí typ deklarovat, jak
se píše typ s null a v jakém pořadí stojí typy sjednocení.
Klíče pod declaration doplní nativní typ parametru, vlastnosti, návratové hodnoty, konstanty a closure tam,
kde ho dokumentační komentář už říká. Anotaci, která pak jen opakuje nativní typ, odstraní rozhodnutí
phpdoc.annotation.nativeTypeOnly, proto ho ukázka nastavuje taky. Parametr, který nemá ani typ, ani anotaci, se
jen ohlásí: typ za vás nikdo nevymyslí. Které třídy číst jako pole, jehož položky popisuje anotace, říká parametr
traversableClasses. Typy v dokumentačních komentářích jsou věcí sekce phpdoc; o tom, odkud DressCode zná typy výrazů, rozhoduje vyhrazený
klíč typeAnalysis, který vysvětluje stránka Typy
z PHPStanu.
types:
declaration:
parameter: required
return: required
nullable: '?int'
phpdoc:
annotation:
nativeTypeOnly: forbidden
/** // Useless `@param` annotation for the parameter `$count`, because the native type says the same.
* @param int $count
*/
function repeat(string $text, $count, ?string $glue = null): string // The parameter `$count` must have the native type `int` from its `@param` annotation.
{
return implode($glue ?? '', array_fill(0, $count, $text));
}
function repeat(string $text, int $count, ?string $glue = null): string
{
return implode($glue ?? '', array_fill(0, $count, $text));
}
types.declaration.parameter
A parameter of a function or a method declares its type, taken from @param where it has one and nullable where it
defaults to null; one with neither is reported, and so is a variadic one whose annotation names an array, which is not
written.
Not a parameter of a closure, whose types belong to the call it is passed to.
Not one whose annotation has no native type, such as resource or a template.
required: always therekeep: nic se nevynucuje, kód zůstane, jak je
Výchozí keep · standardy: perCs keep, psr12 keep, nette
keep, symfony keep, laravel keep · pokrývá
phpdoc_to_param_type, SlevomatCodingStandard.TypeHints.ParameterTypeHint
types.declaration.property
A property declares its type, a promoted one included, taken from @var, or the @param of a promoted
one, where it has one and nullable where it defaults to null, = null written where an untyped one had no default; one
with neither is reported, and so is one with hooks or declared beside others, whose annotation is not written.
Not one whose annotation has no native type, such as callable.
required: always therekeep: nic se nevynucuje, kód zůstane, jak je
Výchozí keep · standardy: perCs keep, psr12 keep, nette
keep, symfony keep, laravel keep · pokrývá
phpdoc_to_property_type, SlevomatCodingStandard.TypeHints.PropertyTypeHint
types.declaration.return
A function or a method declares its return type, taken from @return, void where it returns no value
and never where the annotation says so; one with neither is reported.
Not one whose annotation has no native type, such as resource.
required: always therekeep: nic se nevynucuje, kód zůstane, jak je
Výchozí keep · standardy: perCs keep, psr12 keep, nette
keep, symfony keep, laravel keep · pokrývá phpdoc_to_return_type,
void_return, SlevomatCodingStandard.TypeHints.ReturnTypeHint
types.declaration.constant
A class constant declares the type of its value.
required: always therekeep: nic se nevynucuje, kód zůstane, jak je
Výchozí keep · PHP 8.3 · standardy: perCs keep, psr12 keep,
nette keep, symfony keep, laravel keep
types.declaration.anonymousFunction
A closure declares its return type void where it returns no value.
Not an arrow function, whose value is its expression.
required: always therekeep: nic se nevynucuje, kód zůstane, jak je
Výchozí keep · standardy: perCs keep, psr12 keep, nette
keep, symfony keep, laravel keep · pokrývá
void_return, SlevomatCodingStandard.TypeHints.ReturnTypeHint
types.nullable
How a native type of one type and null is written.
'?int': a single type withnullwritten with?'int|null': a union withnull, whichtypes.nullPositionplaceskeep: nic se nevynucuje, kód zůstane, jak je
Výchozí keep · standardy: perCs '?int', psr12 keep, nette
'?int', symfony '?int', laravel '?int' ·
pokrývá nullable_type_declaration
types.nullPosition
Where null stands in a native union type.
last:int|string|nullfirst:null|int|stringkeep: nic se nevynucuje, kód zůstane, jak je
Výchozí keep · standardy: perCs last, psr12 keep, nette
last, symfony last, laravel keep · pokrývá ordered_types
types.unionOrder
The order of the types of a native union.
alphabetical: the types besidenullsorted by name, case-insensitively, an intersection by its first namekeep: nic se nevynucuje, kód zůstane, jak je
Výchozí keep · standardy: perCs keep, psr12 keep, nette
keep, symfony keep, laravel keep · pokrývá ordered_types
types.traversableClasses
Classes treated like array and iterable, whose annotation says what their items are.
- seznam jmen
Výchozí [Traversable] · standardy: perCs [Traversable], psr12
[Traversable], nette [Traversable], symfony [Traversable],
laravel [Traversable]