samsonframework\generator\CommentsGenerator

Complexity

Total Complexity

13

Size/Duplication

Total Lines	105
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	defVar()	0	4	2
A	defParam()	0	4	2
A	defReturn()	0	4	2
A	defMethod()	0	4	1
A	formatSingleLine()	0	4	1
A	formatMultiLine()	0	13	3
A	code()	0	8	2

<?php declare(strict_types=1);
/**
 * Created by Vitaly Iegorov <egorov@samsonos.com>.
 * on 03.09.16 at 13:02
 */
namespace samsonframework\generator;

/**
 * Comments block generator.
 *
 * @author Vitaly Egorov <egorov@samsonos.com>
 */
class CommentsGenerator extends AbstractGenerator
{
    use CodeTrait;

    /**
     * Set var comment line.
     *
     * @param string      $type        Type
     * @param string|null $description Description
     *
     * @return CommentsGenerator
     */
    public function defVar(string $type, string $description = null): CommentsGenerator
    {
        return $this->defLine('@var ' . $type . ($description !== null ? ' ' . $description : ''));
    }

    /**
     * Set param comment line.
     *
     * @param string      $name        Argument name
     * @param string      $type        Argument type
     * @param string|null $description Argument description
     *
     * @return CommentsGenerator
     */
    public function defParam(string $name, string $type, string $description = null): CommentsGenerator
    {
        return $this->defLine('@param ' . $type . ' $' . $name . ($description !== null ? ' ' . $description : ''));
    }

    /**
     * Set return comment line.
     *
     * @param string      $type        Return type
     * @param string|null $description Return description
     *
     * @return CommentsGenerator
     */
    public function defReturn(string $type, string $description = null): CommentsGenerator
    {
        return $this->defLine('@return ' . $type . ($description !== null ? ' ' . $description : ''));
    }

    /**
     * Set method comment line.
     *
     * @param string $name       Method name
     * @param string $returnType Method return type
     * @param array  $arguments  Method arguments
     *
     * @return CommentsGenerator
     * @internal param null|string $description Argument description
     *
     */
    public function defMethod(string $name, string $returnType, array $arguments = []): CommentsGenerator
    {
        return $this->defLine('@method ' . $returnType . ' ' . $name . '(' . $this->buildArguments($arguments) . ')');
    }

    /**
     * {@inheritdoc}
     */
    public function code(): string
    {
        $indentationString = $this->indentation($this->indentation);

        return count($this->code) === 1
            ? $this->formatSingleLine($indentationString)
            : $this->formatMultiLine($indentationString);
    }

    /**
     * Format comments code into single line comment.
     *
     * @param string $indentation Indentation string
     *
     * @return string Single line comments code
     */
    protected function formatSingleLine(string $indentation)
    {
        return $indentation . '/** ' . $this->code[0] . ' */';
    }

    /**
     * Format comments code into multi line comment.
     *
     * @param string $indentation Indentation string
     *
     * @return string Multi-line comments code
     */
    protected function formatMultiLine(string $indentation)
    {
        $formattedCode = ['/**'];

        // Prepend inner indentation to code
        foreach ($this->code as $codeLine) {
            $formattedCode[] = $codeLine !== '' ? ' * ' . $codeLine : ' *';
        }

        $formattedCode[] = ' */';

        return $indentation . implode("\n" . $indentation, $formattedCode);
    }
}