PhUml\Code\Methods\MethodDocBlock

Complexity

Total Complexity

12

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	extractParametersTypes()	0	8	3
A	hasTypeOfParameter()	0	3	1
A	extractReturnType()	0	8	2
A	__construct()	0	4	1
A	hasReturnType()	0	3	1
A	returnType()	0	3	1
A	typeOfParameter()	0	3	1
A	extractDeclarationFrom()	0	5	2

<?php declare(strict_types=1);
/**
 * PHP version 7.4
 *
 * This source file is subject to the license that is bundled with this package in the file LICENSE.
 */

namespace PhUml\Code\Methods;

use PhUml\Code\Variables\TypeDeclaration;

/**
 * It extracts the return type and parameters type of a method
 */
final class MethodDocBlock
{
    private const RETURN_EXPRESSION = '/@return\s*([\w]+(\[\])?)/';

    private const PARAMETER_EXPRESSION = '/@param\s*([\w]+(?:\[\])?)\s*(\$[\w]+)/';

    private TypeDeclaration $returnType;

    /** @var TypeDeclaration[] */
    private array $parametersTypes = [];

    public function __construct(?string $comment)
    {
        $this->extractParametersTypes($comment);
        $this->extractReturnType($comment);
    }

    public function hasReturnType(): bool
    {
        return $this->returnType->isPresent();
    }

    public function returnType(): TypeDeclaration
    {
        return $this->returnType;
    }

    public function hasTypeOfParameter(string $parameterName): bool
    {
        return isset($this->parametersTypes[$parameterName]);
    }

    public function typeOfParameter(string $parameterName): TypeDeclaration
    {
        return $this->parametersTypes[$parameterName] ?? TypeDeclaration::absent();
    }

    private function extractReturnType(?string $comment): void
    {
        if (preg_match(self::RETURN_EXPRESSION, (string) $comment, $matches) === 1) {
            $this->returnType = TypeDeclaration::from(trim($matches[1]));
            return;
        }

        $this->returnType = TypeDeclaration::absent();
    }

    private function extractParametersTypes(?string $comment): void
    {
        if (preg_match_all(self::PARAMETER_EXPRESSION, (string) $comment, $matches) < 1) {
            $this->parametersTypes = [];
            return;
        }
        foreach ($matches[0] as $typeHint) {
            $this->extractDeclarationFrom($typeHint);
        }
    }

    private function extractDeclarationFrom(string $typeHint): void
    {
        if (preg_match(self::PARAMETER_EXPRESSION, $typeHint, $match) === 1) {
            [$_, $type, $parameterName] = $match;
            $this->parametersTypes[$parameterName] = TypeDeclaration::from($type);
        }
    }
}