dsnetpl/doctrine-column-comment-bundle

Modifying doctrine metadata so that doctrine knows that columns in the database have additional information - a comment.

v1.0.1 2023-12-17 21:22 UTC

Requires

• php: >=7.4
• ext-ctype: *
• doctrine/doctrine-bundle: ^2.5
• doctrine/orm: ^2.10
• phpdocumentor/reflection-docblock: ^5.3

Requires (Dev)

• phpstan/phpstan: ^1.0
• slevomat/coding-standard: ^7.0
• symfony/flex: ^1.17
• symfony/framework-bundle: >=4.4.0
• symfony/proxy-manager-bridge: >=4.4.0
• symplify/easy-coding-standard: ^9.4

Conflicts

• symfony/symfony: *

MIT

README

Bundle for Symfony >= 4.4.0

Modifying doctrine metadata so that doctrine knows that columns in the database have additional information.

Install

$ composer require dsnetpl/doctrine-column-comment-bundle

If in project is not using Symfony Flex, should will be need to register a bundle:

# config/bundles.php
return [
    // ...
    Dsnetpl\DoctrineColumnCommentBundle::class => ['all' => true],
];

Using

To add automatic comment to field in datatable in database. Should be modified Entity file:

//...

    /**
     * Comment must be written in docblock
     *
     * @ORM\Column()
     */
    private string $field;

//..

The next step is create diff on database:

$ bin/console doctrine:schema:update --dump-sql

If everything is well configured, the following query should be generated:

COMMENT ON COLUMN table.field IS 'Comment must be written in docblock'