W2w\Lib\Apie\OpenApiSchema\SubActions\SubAction

Complexity

Total Complexity

9

Size/Duplication

Total Lines	92
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	1

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getObject()	0	3	1
A	getName()	0	3	1
A	getArguments()	0	3	1
A	getSummary()	0	10	3
A	getReflectionMethod()	0	3	1
A	getReturnTypehint()	0	3	1
A	__construct()	0	6	1

<?php

namespace W2w\Lib\Apie\OpenApiSchema\SubActions;

use phpDocumentor\Reflection\DocBlockFactory;
use ReflectionMethod;
use Symfony\Component\PropertyInfo\Type;

class SubAction
{
    /**
     * @var string
     */
    private $name;

    /**
     * @var (Type|null)[]
     */
    private $arguments;

    /**
     * @var Type|null
     */
    private $returnTypehint;

    /**
     * @var ReflectionMethod
     */
    private $reflectionMethod;

    /**
     * @var object|null
     */
    private $object;

    /**
     * @param string $name
     * @param (Type|null)[] $arguments
     * @param ReflectionMethod $reflectionMethod
     * @param Type|null $returnTypehint
     * @param object|null $object
     */
    public function __construct(string $name, array $arguments, ReflectionMethod $reflectionMethod, ?Type $returnTypehint, ?object $object) {
        $this->name = $name;
        $this->arguments = $arguments;
        $this->reflectionMethod = $reflectionMethod;
        $this->returnTypehint = $returnTypehint;
        $this->object = $object;
    }

    /**
     * @return string
     */
    public function getName(): string
    {
        return $this->name;
    }

    public function getSummary(): ?string
    {
        $factory  = DocBlockFactory::createInstance();
        $docComment = $this->reflectionMethod->getDocComment();
        var_dump($docComment);

var_dump($docComment) looks like debug code. Are you sure you do not want to remove it?

        if (!$docComment) {
            return null;
        }
        $docblock = $factory->create($docComment);

It seems like $docComment can also be of type true; however, parameter $docblock of phpDocumentor\Reflection\DocBlockFactory::create() does only seem to accept object|string, maybe add an additional type check?

        return $docblock->getDescription() ? : null;
    }

    /**
     * @return Type[]
     */
    public function getArguments(): array
    {
        return $this->arguments;
    }

    /**
     * @return Type|null
     */
    public function getReturnTypehint(): ?Type
    {
        return $this->returnTypehint;
    }

    /**
     * @return ReflectionMethod
     */
    public function getReflectionMethod(): ReflectionMethod
    {
        return $this->reflectionMethod;
    }

    /**
     * @return object|null
     */
    public function getObject(): ?object
    {
        return $this->object;
    }
}