SubAction::getSummary() - Code Metrics - Inspection of "added summary for post sub actions" - pjordaan/apie - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( af5ff0...adbbe6 )

by Pieter

created 2020-06-20 21:06 UTC

SubAction::getSummary() A

↳ Parent: SubAction

Complexity

Conditions	3
Paths	2

Size

Total Lines	10
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	7
nc	2
nop	0
dl	0
loc	10
rs	10
c	0
b	0
f	0

<?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);

        if (!$docComment) {
            return null;
        }
        $docblock = $factory->create($docComment);
        $docblock = $factory->create(/** @scrutinizer ignore-type */ $docComment);
        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;
    }
}


pjordaan / apie

Push — master ( af5ff0...adbbe6 )

SubAction::getSummary() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like