phpstan/phpstan-webmozart-assert

PHPStan webmozart/assert extension

2.0.0 2024-10-14 03:45 UTC

Requires

• php: ^7.4 || ^8.0
• phpstan/phpstan: ^2.0

Requires (Dev)

• nikic/php-parser: ^5.1
• php-parallel-lint/php-parallel-lint: ^1.2
• phpstan/phpstan-deprecation-rules: ^2.0
• phpstan/phpstan-phpunit: ^2.0
• phpstan/phpstan-strict-rules: ^2.0
• phpunit/phpunit: ^9.6
• webmozart/assert: ^1.11.0

MIT

README

• PHPStan
• webmozart/assert

Description

The main scope of this extension is to help PHPStan to detect the type of object after the Webmozart\Assert\Assert validation.

<?php declare(strict_types = 1);

use Webmozart\Assert\Assert;

function demo(?int $a) {
	// ...

	Assert::integer($a);
	// PHPStan is now aware that $a can no longer be `null` at this point

	return ($a === 10);
}

Supported assertions

This extension understands the following Assert::* methods and narrows types accordingly.

All assertions also work with the nullOr*(), all*(), and allNullOr*() prefixes (e.g. Assert::nullOrString(), Assert::allInteger(), Assert::allNullOrNotEmpty()).

Type checks

integer, positiveInteger, natural, float, numeric, integerish, boolean, scalar, string, stringNotEmpty, object, resource, isCallable, isArray, isIterable, isTraversable, isList, isNonEmptyList, isMap, isNonEmptyMap, isCountable, isArrayAccessible

Instance and class checks

isInstanceOf, isInstanceOfAny, notInstanceOf, isAOf, isAnyOf, isNotA, subclassOf, implementsInterface, classExists, interfaceExists

Comparison

same, notSame, eq, notEq, greaterThan, greaterThanEq, lessThan, lessThanEq, range, true, false, null, notNull, notFalse, inArray, oneOf

String assertions

contains, startsWith, endsWith, startsWithLetter, unicodeLetters, alpha, digits, alnum, lower, upper, uuid, ip, ipv4, ipv6, email, notWhitespaceOnly, length, minLength, maxLength, lengthBetween

Count assertions

count, minCount, maxCount, countBetween

Object and array

keyExists, keyNotExists, validArrayKey, methodExists, propertyExists

Negative all* assertions

allNotNull, allNotInstanceOf, allNotSame

Installation

To use this extension, require it in Composer:

composer require --dev phpstan/phpstan-webmozart-assert

If you also install phpstan/extension-installer then you're all set!

Manual installation

If you don't want to use phpstan/extension-installer, include extension.neon in your project's PHPStan config:

includes:
    - vendor/phpstan/phpstan-webmozart-assert/extension.neon