DocBlockUpdater.php

<?php

declare(strict_types=1);

namespace Rector\Comments\NodeDocBlock;

use PhpParser\Comment\Doc;
use PhpParser\Node;
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
use Rector\BetterPhpDocParser\Printer\PhpDocInfoPrinter;
use Rector\NodeTypeResolver\Node\AttributeKey;

final class DocBlockUpdater
{
    /**
     * @var string
     * @see https://regex101.com/r/VdaVGL/1
     */
    final public const SPACE_OR_ASTERISK_REGEX = '#(\s|\*)+#';

    public function __construct(
        private readonly PhpDocInfoPrinter $phpDocInfoPrinter
    ) {
    }

    public function updateNodeWithPhpDocInfo(Node $node): void
    {
        // nothing to change? don't save it
        $phpDocInfo = $node->getAttribute(AttributeKey::PHP_DOC_INFO);
        if (! $phpDocInfo instanceof PhpDocInfo) {
            return;
        }

        if (! $phpDocInfo->hasChanged()) {
            return;
        }

        $phpDoc = $this->printPhpDocInfoToString($phpDocInfo);

        // make sure, that many separated comments are not removed
        if ($phpDoc === '') {
            if (count($node->getComments()) > 1) {
                foreach ($node->getComments() as $comment) {
                    $phpDoc .= $comment->getText() . PHP_EOL;
                }
            }

            if ($phpDocInfo->getOriginalPhpDocNode()->children !== []) {
                // all comments were removed → null
                $node->setAttribute(AttributeKey::COMMENTS, null);
            }

            return;
        }

        // this is needed to remove duplicated // commentsAsText
        $node->setDocComment(new Doc($phpDoc));
    }

    private function printPhpDocInfoToString(PhpDocInfo $phpDocInfo): string
    {
        if ($phpDocInfo->isNewNode()) {
            return $this->phpDocInfoPrinter->printNew($phpDocInfo);
        }

        return $this->phpDocInfoPrinter->printFormatPreserving($phpDocInfo);
    }
}