Add conditional type

Author: ahjdev

src/PseudoTypes/AbstractConditional.php

@@ -0,0 +1,71 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of phpDocumentor.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @link      http://phpdoc.org
+ */
+
+namespace phpDocumentor\Reflection\PseudoTypes;
+
+use phpDocumentor\Reflection\PseudoType;
+use phpDocumentor\Reflection\Type;
+use phpDocumentor\Reflection\Types\Mixed_;
+
+/**
+ * Represents a conditional. This is an abstract class for Conditional and ConditionalParameter.
+ *
+ * @psalm-immutable
+ */
+abstract class AbstractConditional implements PseudoType
+{
+    /** @var Type */
+    private $target;
+
+    /** @var Type */
+    private $if;
+
+    /** @var Type */
+    private $else;
+
+    /** @var bool */
+    private $negated;
+
+    public function __construct(Type $target, Type $if, Type $else, bool $negated)
+    {
+        $this->target  = $target;
+        $this->if      = $if;
+        $this->else    = $else;
+        $this->negated = $negated;
+    }
+
+    public function getTarget(): Type
+    {
+        return $this->target;
+    }
+
+    public function getIf(): Type
+    {
+        return $this->if;
+    }
+
+    public function getElse(): Type
+    {
+        return $this->else;
+    }
+
+    public function getNegated(): bool
+    {
+        return $this->negated;
+    }
+
+    public function underlyingType(): Type
+    {
+        return new Mixed_();
+    }
+}

src/PseudoTypes/Conditional.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of phpDocumentor.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @link      http://phpdoc.org
+ */
+
+namespace phpDocumentor\Reflection\PseudoTypes;
+
+use phpDocumentor\Reflection\Type;
+
+use function sprintf;
+
+/** @psalm-immutable */
+final class Conditional extends AbstractConditional
+{
+    /** @var Type */
+    private $subject;
+
+    public function __construct(Type $subject, Type $target, Type $if, Type $else, bool $negated)
+    {
+        parent::__construct($target, $if, $else, $negated);
+        $this->subject = $subject;
+    }
+
+    public function getSubject(): Type
+    {
+        return $this->subject;
+    }
+
+    /**
+     * Returns a rendered output of the Type as it would be used in a DocBlock.
+     */
+    public function __toString(): string
+    {
+        return sprintf(
+			'(%s %s %s ? %s : %s)',
+			$this->subject,
+			$this->negated ? 'is not' : 'is',
+			$this->target,
+			$this->if,
+			$this->else
+		);
+	}
+}

src/PseudoTypes/ConditionalParameter.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of phpDocumentor.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @link      http://phpdoc.org
+ */
+
+namespace phpDocumentor\Reflection\PseudoTypes;
+
+use phpDocumentor\Reflection\Type;
+
+use function sprintf;
+
+/** @psalm-immutable */
+final class ConditionalParameter extends AbstractConditional
+{
+    /** @var string */
+    private $parameter;
+
+    public function __construct(string $parameter, Type $target, Type $if, Type $else, bool $negated)
+    {
+        parent::__construct($target, $if, $else, $negated);
+        $this->parameter = $parameter;
+    }
+
+    public function getParameterName(): string
+    {
+        return $this->parameter;
+    }
+
+    /**
+     * Returns a rendered output of the Type as it would be used in a DocBlock.
+     */
+    public function __toString(): string
+    {
+        return sprintf(
+			'(%s %s %s ? %s : %s)',
+			$this->parameter,
+			$this->negated ? 'is not' : 'is',
+			$this->target,
+			$this->if,
+			$this->else
+		);
+	}
+}