Atrapalo\PHPTools\Parser\PHPDocClass

Complexity

Total Complexity

15

Size/Duplication

Total Lines	97
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	docComment()	0	6	1
B	createMethods()	0	19	6
B	parseParams()	0	18	6
A	staticMethods()	0	13	1
A	methods()	0	13	1

<?php

namespace Atrapalo\PHPTools\Parser;

use Atrapalo\PHPTools\Parser\Values\Method;
use Atrapalo\PHPTools\Parser\Values\Param;

/**
 * Class PHPDocClass
 * @package Atrapalo\PHPTools\Parser
 *
 * @author Guillermo González <guillermo.gonzalez@atrapalo.com>
 */
class PHPDocClass
{
    /**
     * @param string $className
     * @return Method[]
     */
    public static function staticMethods(string $className): array
    {
        $classDoc = self::docComment($className);

        preg_match_all(
            '/^[* ]+@method(?>\hstatic) ?([a-zA-Z0-9_\-\$\\\ ]*) (\w+)\(([a-zA-Z0-9_\-$,\\\ ]*)\) ?(.*)$/im',
            $classDoc,
            $staticMethodsOfDoc,
            PREG_SET_ORDER
        );

        return self::createMethods($staticMethodsOfDoc, true);

It seems like $staticMethodsOfDoc can also be of type null; however, Atrapalo\PHPTools\Parser\PHPDocClass::createMethods() does only seem to accept array, maybe add an additional type check?

    }

    /**
     * @param string $className
     * @return Method[]
     */
    public static function methods(string $className): array
    {
        $classDoc = self::docComment($className);

        preg_match_all(
            '/^[* ]+@method(?!.*static )([a-zA-Z0-9_\-\$\\\ ]*) (\w+)\(([a-zA-Z0-9_\-$,\\\ ]*)\) ?(.*)$/mi',
            $classDoc,
            $staticMethodsOfDoc,
            PREG_SET_ORDER
        );

        return self::createMethods($staticMethodsOfDoc, false);

It seems like $staticMethodsOfDoc can also be of type null; however, Atrapalo\PHPTools\Parser\PHPDocClass::createMethods() does only seem to accept array, maybe add an additional type check?

    }

    /**
     * @param string $className
     * @return string
     */
    private static function docComment(string $className): string
    {
        $rc = new \ReflectionClass($className);

        return $rc->getDocComment();
    }

    /**
     * @param array $methodsOfDoc
     * @param bool  $areStatics
     * @return array
     */
    private static function createMethods(array $methodsOfDoc, bool $areStatics): array
    {
        $methods = [];
        foreach ($methodsOfDoc as $methodOfDoc) {
            $return = isset($methodOfDoc[1]) ? trim($methodOfDoc[1]) : '';
            $name = isset($methodOfDoc[2]) ? trim($methodOfDoc[2]) : '';
            $params = isset($methodOfDoc[3]) ? self::parseParams($methodOfDoc[3]) : [];
            $description = isset($methodOfDoc[4]) ? trim($methodOfDoc[4]) : '';

            $method = new Method($areStatics, $name);
            $method->setReturn($return)
                ->setDescription($description)
                ->setParams($params);

            $methods[] = $method;
        }

        return $methods;
    }

    /**
     * @param string $stringParams
     * @return array
     */
    private static function parseParams(string $stringParams): array
    {
        $params = [];
        if (!empty($stringParams)){
            $paramsSlice = explode(',', $stringParams);
            foreach ($paramsSlice as $paramElement) {
                preg_match('/([\\a-z]*)\h?(\$\w+)/i', $paramElement, $paramData);
                if (count($paramData) == 3) {
                    $type = isset($paramData[1]) ? trim($paramData[1]) : '';
                    $name = isset($paramData[2]) ? trim($paramData[2]) : '';

                    $params[] = new Param($name, $type);
                }
            }
        }

        return $params;
    }
}