phpstan/phpstan-webmozart-assert

PHPStan webmozart/assert extension

Installs: 613 260

Dependents: 246

Suggesters: 0

Security: 0

Stars: 72

Watchers: 4

Forks: 11

Open Issues: 6

Type:phpstan-extension

0.12.4 2020-05-04 08:30 UTC

This package is auto-updated.

Last update: 2020-05-04 08:31:51 UTC


README

Build Status Latest Stable Version License

Description

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

<?php declare(strict_types = 1);

use Webmozart\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);
}

This extension specifies types of values passed to:

  • Assert::integer
  • Assert::string
  • Assert::stringNotEmpty
  • Assert::float
  • Assert::numeric
  • Assert::integerish
  • Assert::boolean
  • Assert::scalar
  • Assert::object
  • Assert::resource
  • Assert::isCallable
  • Assert::isArray
  • Assert::isIterable
  • Assert::isCountable
  • Assert::isInstanceOf
  • Assert::notInstanceOf
  • Assert::subclassOf
  • Assert::true
  • Assert::false
  • Assert::notFalse
  • Assert::null
  • Assert::notNull
  • Assert::same
  • Assert::notSame
  • Assert::implementsInterface
  • nullOr* and all* variants of the above methods

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