Micro\Library\DTO\Preparation\Processor\ClassCommentProcessor

Complexity

Total Complexity

5

Size/Duplication

Total Lines	31
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	addComment()	0	5	2
A	process()	0	14	3

<?php

declare(strict_types=1);

/*
 *  This file is part of the Micro framework package.
 *
 *  (c) Stanislau Komar <kost@micro-php.net>
 *
 *  For the full copyright and license information, please view the LICENSE
 *  file that was distributed with this source code.
 */

namespace Micro\Library\DTO\Preparation\Processor;

use Micro\Library\DTO\ClassDef\ClassDefinition;
use Micro\Library\DTO\Preparation\PreparationProcessorInterface;

class ClassCommentProcessor implements PreparationProcessorInterface
{
    public function process(iterable $classDef, ClassDefinition $classDefinition, array $classList): void
    {
        $opts = [
            self::DEPRECATED => '@deprecated',
            self::DESCRIPTION => null,
        ];

        foreach ($opts as $opt => $prefix) {
            $commentValue = $classDef[$opt] ?? false;
            if (!$commentValue) {
                continue;
            }

            $this->addComment($classDefinition, $commentValue, $prefix);
        }
    }

    /**
     * @param ClassDefinition $classDefinition
     * @param string          $comment
     * @param string|null     $commentPrefix
     *
     * @return void
     */
    protected function addComment(ClassDefinition $classDefinition, string $comment, ?string $commentPrefix): void
    {
        $text = $commentPrefix ? $commentPrefix.' '.$comment : $comment;

        $classDefinition->addComment($text);
    }
}