IPFS\Utils\AnnotationReader

Complexity

Total Complexity

13

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

97.14%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	isApi()	0	4	1
A	getDescription()	0	4	1
A	getName()	0	4	1
A	getParameters()	0	17	3
A	getApi()	0	7	1
A	getMethod()	0	10	2
A	parseParameterDocblock()	0	10	3

<?php

declare(strict_types=1);

/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license. For more information, see
 * <https://github.com/digitalkaoz/php-ipfs>
 */

namespace IPFS\Utils;

use Doctrine\Common\Annotations\AnnotationReader as BaseReader;
use IPFS\Annotation\Api;
use IPFS\Annotation\Param;
use phpDocumentor\Reflection\DocBlockFactory;

class AnnotationReader
{
    /**
     * @var BaseReader
     */
    private $reader;
    /**
     * @var DocBlockFactory
     */
    private $docBlockFactory;

    public function __construct(BaseReader $reader, DocBlockFactory $docBlockFactory)
    {
        $this->reader = $reader;
        $this->docBlockFactory = $docBlockFactory;
    }

    public function isApi($method): bool
    {
        return (bool) $this->getApi($method);
    }

    public function getDescription($method): string
    {
        return $this->docBlockFactory->create($this->getMethod($method))->getSummary();
    }

    public function getName($method): string
    {
        return (string) $this->getApi($method)->name;
    }

    /**
     * @return array|Param[]
     */
    public function getParameters($method): array
    {
        $reflection = $this->getMethod($method);
        $parameters = [];
        $docBlock = $this->docBlockFactory->create($reflection->getDocComment());
        $params = $docBlock->getTagsByName('param');

        foreach ($reflection->getParameters() as $parameter) {
            $parameters[$parameter->name] = new Param(
                $parameter->name,
                $this->parseParameterDocblock($params, $parameter),
                $parameter->isDefaultValueAvailable() ? $parameter->getDefaultValue() : Param::class
            );
        }

        return $parameters;
    }

    /**
     * @return Api|null
     */
    private function getApi($method)
    {
        return $this->reader->getMethodAnnotation(
            $this->getMethod($method),
            Api::class
        );
    }

    private function getMethod($method): \ReflectionMethod
    {
        if ($method instanceof \ReflectionMethod) {
            return $method;
        }

        list($api, $method) = explode('::', $method);

        return new \ReflectionMethod($api, $method);
    }

    private function parseParameterDocblock(array $params, \ReflectionParameter $parameter): string
    {
        foreach ($params as $param) {
            if ($parameter->name === $param->getVariableName()) {
                return $param->getDescription()->render();
            }
        }

        return '';
    }
}