ConstantBooleanType.php

<?php declare(strict_types = 1);

namespace PHPStan\Type\Constant;

use PHPStan\Php\PhpVersion;
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
use PHPStan\PhpDocParser\Ast\Type\TypeNode;
use PHPStan\TrinaryLogic;
use PHPStan\Turbo\ShadowedByTurboExtension;
use PHPStan\Type\BooleanType;
use PHPStan\Type\ConstantScalarType;
use PHPStan\Type\ErrorType;
use PHPStan\Type\GeneralizePrecision;
use PHPStan\Type\InstanceofDeprecated;
use PHPStan\Type\MixedType;
use PHPStan\Type\NeverType;
use PHPStan\Type\StaticTypeFactory;
use PHPStan\Type\Traits\ConstantScalarTypeTrait;
use PHPStan\Type\Type;
use PHPStan\Type\TypeCombinator;
use PHPStan\Type\VerbosityLevel;

/** @api */
#[ShadowedByTurboExtension(implementation: __DIR__ . '/../../../turbo-ext/src/ConstantBooleanType.cpp')]
#[InstanceofDeprecated(insteadUse: 'Type::isTrue() or Type::isFalse()')]
class ConstantBooleanType extends BooleanType implements ConstantScalarType
{

	use ConstantScalarTypeTrait {
		looseCompare as private scalarLooseCompare;
	}

	/** @api */
	public function __construct(private bool $value)
	{
		parent::__construct();
	}

	public function getValue(): bool
	{
		return $this->value;
	}

	public function describe(VerbosityLevel $level): string
	{
		return $this->value ? 'true' : 'false';
	}

	public function getSmallerType(PhpVersion $phpVersion): Type
	{
		if ($this->value) {
			return StaticTypeFactory::falsey();
		}
		return new NeverType();
	}

	public function getSmallerOrEqualType(PhpVersion $phpVersion): Type
	{
		if ($this->value) {
			return new MixedType();
		}
		return StaticTypeFactory::falsey();
	}

	public function getGreaterType(PhpVersion $phpVersion): Type
	{
		if ($this->value) {
			return new NeverType();
		}
		return StaticTypeFactory::truthy();
	}

	public function getGreaterOrEqualType(PhpVersion $phpVersion): Type
	{
		if ($this->value) {
			return StaticTypeFactory::truthy();
		}
		return new MixedType();
	}

	public function toBoolean(): BooleanType
	{
		return $this;
	}

	public function toNumber(): Type
	{
		return new ConstantIntegerType((int) $this->value);
	}

	public function toBitwiseNotType(): Type
	{
		return new ErrorType();
	}

	public function toAbsoluteNumber(): Type
	{
		return $this->toNumber()->toAbsoluteNumber();
	}

	public function toString(): Type
	{
		return new ConstantStringType((string) $this->value);
	}

	public function toInteger(): Type
	{
		return new ConstantIntegerType((int) $this->value);
	}

	public function toFloat(): Type
	{
		return new ConstantFloatType((float) $this->value);
	}

	public function toArrayKey(): Type
	{
		return new ConstantIntegerType((int) $this->value);
	}

	public function toCoercedArgumentType(bool $strictTypes): Type
	{
		if (!$strictTypes) {
			return TypeCombinator::union($this->toInteger(), $this->toFloat(), $this->toString(), $this);
		}

		return $this;
	}

	public function isTrue(): TrinaryLogic
	{
		return TrinaryLogic::createFromBoolean($this->value === true);
	}

	public function isFalse(): TrinaryLogic
	{
		return TrinaryLogic::createFromBoolean($this->value === false);
	}

	public function unsetOffset(Type $offsetType): Type
	{
		/** unset() of an offset leaves false as it is (deprecated since PHP 8.1) and throws on true. see https://3v4l.org/mHHkL#veol */
		if ($this->value) {
			return new ErrorType();
		}

		return $this;
	}

	public function generalize(GeneralizePrecision $precision): Type
	{
		return new BooleanType();
	}

	public function toPhpDocNode(): TypeNode
	{
		return new IdentifierTypeNode($this->value ? 'true' : 'false');
	}

	public function looseCompare(Type $type, PhpVersion $phpVersion): BooleanType
	{
		if ($type->isObject()->yes()) {
			return $this;
		}

		return $this->scalarLooseCompare($type, $phpVersion);
	}

}