dsnetpl / doctrine-column-comment-bundle
修改doctrine元数据,使doctrine知道数据库中的列有额外的信息 - 一个注释。
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
This package is auto-updated.
Last update: 2024-09-17 23:12:22 UTC
README
适用于Symfony >= 4.4.0的Bundle
修改doctrine元数据,使doctrine知道数据库中的列有额外的信息。
安装
$ composer require dsnetpl/doctrine-column-comment-bundle
如果项目中没有使用 Symfony Flex,则需要注册一个Bundle
# config/bundles.php return [ // ... Dsnetpl\DoctrineColumnCommentBundle::class => ['all' => true], ];
使用
为了在数据库中的数据表字段上添加自动注释。需要修改Entity文件
//... /** * Comment must be written in docblock * * @ORM\Column() */ private string $field; //..
下一步是创建数据库的diff
$ bin/console doctrine:schema:update --dump-sql
如果一切配置正确,应该生成以下查询
COMMENT ON COLUMN table.field IS 'Comment must be written in docblock'