dbunt1tled / php-value-objects

src/VObjects/Scalar/Boolean.php

<?php

declare(strict_types=1);


namespace DBUnt1tled\VO\VObjects\Scalar;

use DBUnt1tled\VO\Exception\InvalidVOArgumentException;
use DBUnt1tled\VO\VObjects\ValueObject;

class Boolean extends ValueObject
{
    /**
     * @param mixed $value
     * @param mixed ...$other
     * @throws \ReflectionException
     */
    public function guard($value, ...$other): void
    {
        parent::guard($value);
        if (!\is_bool($value)) {
            throw new InvalidVOArgumentException('Value is invalid. Allowed type is boolean', $value);
        }
    }

    /**
     * @param int $int
     * @return Boolean
     * @throws \ReflectionException
     */
    public static function createFromInt(int $int): self
    {
        return new static($int !== 0);

The expression return new static($int !== 0) returns the type DBUnt1tled\VO\VObjects\Scalar\Boolean which is incompatible with the documented return type boolean.

    }

    /**
     * @param string $string
     * @return Boolean
     * @throws \ReflectionException
     */
    public static function createFromString(string $string): self
    {
        return new static(mb_strtolower($string) === 'true' || $string === '1');

The expression return new static(mb_strtolower($string) === 'true' || $string === '1') returns the type DBUnt1tled\VO\VObjects\Scalar\Boolean which is incompatible with the documented return type boolean.

    }

    /**
     * @return string
     */
    public function __toString(): string
    {
        return $this->value ? 'true' : 'false';
    }

    /**
     * @return int
     */
    public function toInt(): int
    {
        return $this->value ? 1 : 0;
    }

    /**
     * @param self $boolean
     * @return Boolean
     * @throws \ReflectionException
     */
    public function and(self $boolean): self
    {
        $andResult = $this->value && $boolean->value;
        return new static($andResult);

The expression return new static($andResult) returns the type DBUnt1tled\VO\VObjects\Scalar\Boolean which is incompatible with the documented return type boolean.

    }

    /**
     * @param self $boolean
     * @return Boolean
     * @throws \ReflectionException
     */
    public function or(self $boolean): self
    {
        $orResult = $this->value || $boolean->value;
        return new static($orResult);

The expression return new static($orResult) returns the type DBUnt1tled\VO\VObjects\Scalar\Boolean which is incompatible with the documented return type boolean.

    }

    /**
     * @return Boolean
     * @throws \ReflectionException
     */
    public function not(): self
    {
        $notResult = !$this->value;
        return new static($notResult);

The expression return new static($notResult) returns the type DBUnt1tled\VO\VObjects\Scalar\Boolean which is incompatible with the documented return type boolean.

    }

    /**
     * @param self $boolean
     * @return Boolean
     * @throws \ReflectionException
     */
    public function xor(self $boolean): self
    {
        $xorResult = ($this->value xor $boolean->value);
        return new static($xorResult);

The expression return new static($xorResult) returns the type DBUnt1tled\VO\VObjects\Scalar\Boolean which is incompatible with the documented return type boolean.

    }
}