Flagbit\Plantuml\TokenReflection\MethodWriter

Complexity

Total Complexity

22

Size/Duplication

Total Lines	116
Duplicated Lines	11.21 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

96.23%

Importance

Changes	10
Bugs	2	Features	6

7 Methods

Rating	Name	Duplication	Size	Complexity
A	writeElement()	0	6	2
A	writeElements()	0	13	2
A	writeVisibility()	0	4	3
A	writeParameters()	0	13	4
B	writeParameter()	0	20	5
A	writeReturnType()	13	13	3
A	formatLine()	0	7	3

<?php

namespace Flagbit\Plantuml\TokenReflection;

use TokenReflection\IReflectionMethod;
use TokenReflection\IReflectionParameter;

class MethodWriter extends \Flagbit\Plantuml\TokenReflection\WriterAbstract
{
    /**
     * @param \TokenReflection\IReflectionMethod $method
     * @return string
     */
    public function writeElement(IReflectionMethod $method)
    {
        return $this->formatLine($this->writeVisibility($method)
            . ($method->isStatic() ? '{static}' : '') . $method->getName()
            . $this->writeParameters($method) . $this->writeReturnType($method));
    }

    /**
     * @param IReflectionMethod[] $methods
     * @return string
     */
    public function writeElements(array $methods)
    {
        // see https://bugs.php.net/bug.php?id=50688
        @usort($methods, function(IReflectionMethod $a, IReflectionMethod $b) {

It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

            return strnatcasecmp($a->getName(), $b->getName());
        });

        $methodsString = '';
        foreach ($methods as $method) {
            $methodsString .= $this->writeElement($method);
        }
        return $methodsString;
    }

    /**
     * @param \TokenReflection\IReflectionMethod $method
     * @return string
     */
    private function writeVisibility(IReflectionMethod $method)
    {
        return $method->isPrivate() ? '-' : ($method->isProtected() ? '#' : '+');
    }

    /**
     * @param \TokenReflection\IReflectionMethod $method
     * @return string
     */
    private function writeParameters(IReflectionMethod $method)
    {
        $parameters = array();
        foreach ($method->getParameters() as $parameter) {
            /** @var $parameter \TokenReflection\IReflectionParameter */
            $parameters[] = $this->writeParameter($method, $parameter);
        }
        $count = count($parameters);
        if ($this->writerOptions->withoutFunctionParameter && $count > 0) {
            return '( #' . $count . ' params )';
        }
        return '(' . implode(', ' , $parameters) . ')';
    }

    /**
     * @param IReflectionMethod $method
     * @param IReflectionParameter $parameter
     * @return string
     */
    private function writeParameter(IReflectionMethod $method, IReflectionParameter $parameter)
    {
        $parameterString = $parameter->getName();

        if ($parameter->getClassName()) {
            $parameterString .= ' : ' . $this->formatClassName($parameter->getClassName());
        }
        else {
            preg_match('/\*\h+@param\h+([^\h]+)\h+\$' . preg_quote($parameterString). '\s/', (string) $method->getDocComment(), $matches);
            if (isset($matches[1])) {
                $parameterString .= ' : ' . $this->formatClassName($matches[1]);
            }
        }

        if ($parameter->isOptional() && $parameter->isDefaultValueAvailable()) {
            $parameterString .= ' = ' . $this->formatValue($parameter->getDefaultValue());
        }

        return $parameterString;
    }

    /**
     * @param \TokenReflection\IReflectionMethod $method
     * @return string
     */
    private function writeReturnType(IReflectionMethod $method)

This method seems to be duplicated in your project.

    {
        $returnType = '';
        preg_match('/\*\h+@return\h+([^\h]+)/', (string) $method->getDocComment(), $matches);
        if (isset($matches[1])) {
            $returnType = $matches[1];
            if ($method->getDeclaringClass()) {
                $returnType = $this->expandNamespaceAlias($method->getDeclaringClass(), $returnType);
            }
            $returnType = ' : ' . $this->formatClassName($returnType);
        }
        return $returnType;
    }

    /**
     * Overide format line if needed
     * @param  string $string
     * @return string
     */
    public function formatLine($string)
    {
        if (isset($this->writerOptions->maxLineLength) && $this->writerOptions->maxLineLength>0) {
            $string = substr($string, 0, $this->writerOptions->maxLineLength);
        }
        return parent::formatLine($string);
    }

}