symplify/better-phpdoc-parser

Slim wrapper around phpstan/phpdoc-parser with format preserving printer

Deprecated, moved to Rector

Better PhpDoc Parser

, _(*1)

Wrapper around phpstan/phpdoc-parser that adds format preserving printer., _(*2)

When do We Need Format Preserving Printer?

Original code, _(*3)

/**
 * @param   string   $name
 * @param   string   $surname
 * @return  bool
  */

Printed by PHPStan PhpDocParser :x:, _(*4)

/**
 * @param string $name
 * @param string $surname
 * @return bool
 */

Printed by Better PhpDocParser :+1:, _(*5)

/**
 * @param   string   $name
 * @param   string   $surname
 * @return  bool
 */

Symplify\CodingStandard and Rector need to modify docblock and put it back in correct format. Other packages often put own spacing, or formats of specific tags., _(*6)

This package preserve original spacing., _(*7)

Thanks for inspiration in Format Preserving Printer feature in nikic/php-parser., _(*8)

Install

composer require symplify/better-phpdoc-parser

Usage

Register services in your Symfony config:, _(*9)

# services.yaml
imports:
    - { resource: 'vendor/symplify/better-phpdoc-parser/config/config.yml' }

or register the needed services from services.yaml in config of your other framework., _(*10)

<?php

use Symplify\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
use Symplify\BetterPhpDocParser\Printer\PhpDocInfoPrinter;

class SomeClass
{
    public function __construct(PhpDocInfoFactory $phpDocInfoFactory, PhpDocInfoPrinter $phpDocInfoPrinter)
    {
        $this->phpDocInfoFactory = $phpDocInfoFactory;
        $this->phpDocInfoPrinter = $phpDocInfoPrinter;
    }

    public function changeDocBlockAndPrintItBack(): string
    {
        $docComment = '/**    @var Type $variable    */';

        $phpDocInfo = $this->phpDocInfoFactory->createFrom($docComment);

        // modify `$phpDocInfo` using its methods

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