PhUml\Code\Variables\TypeDeclaration

Complexity

Total Complexity

10

Size/Duplication

Total Lines	58
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	removeArraySuffix()	0	3	1
A	isArray()	0	3	1
A	from()	0	3	1
A	__toString()	0	3	1
A	__construct()	0	3	1
A	isPresent()	0	3	1
A	isBuiltIn()	0	7	3
A	absent()	0	3	1

<?php
/**
 * PHP version 7.1
 *
 * This source file is subject to the license that is bundled with this package in the file LICENSE.
 */

namespace PhUml\Code\Variables;

/**
 * It represents a variable's type declaration
 */
class TypeDeclaration
{
    /** @var string[] All valid types for PHP 7.1 */
    private static $builtInTypes = [
        'int', 'bool', 'string', 'array', 'float', 'callable', 'iterable'
    ];

    /** @var string */
    private $name;

    public static function absent(): TypeDeclaration
    {
        return new TypeDeclaration(null);
    }

    public static function from(?string $text): TypeDeclaration
    {
        return new TypeDeclaration($text);
    }

    public function isPresent(): bool
    {
        return null !== $this->name;
    }

    /**
     * It helps building the relationships between classes/interfaces since built-in
     * types are not part of a UML class diagram
     *
     * @see \PhUml\Code\Variables\WithTypeDeclaration::isAReference() for more details
     */
    public function isBuiltIn(): bool
    {
        $type = $this->name;
        if ($this->isArray()) {
            $type = $this->removeArraySuffix();
        }
        return $this->isPresent() && \in_array($type, self::$builtInTypes, true);
    }

    private function isArray(): bool
    {
        return strpos($this->name, '[]') === \strlen($this->name) - 2;
    }

    private function removeArraySuffix(): string
    {
        return substr($this->name, 0, -2);
    }

    private function __construct(?string $name)
    {
        $this->name = $name;
    }

    public function __toString()
    {
        return (string)$this->name;
    }
}