README

这是一个将MySQL Workbench模型 (*.mwb) 转换为Doctrine 2 Schema的导出工具。

先决条件

• PHP 5.4+
• Composer来安装依赖项

安装

php composer.phar require --dev mysql-workbench-schema-exporter/doctrine2-exporter

这将安装导出器，并需要mysql-workbench-schema-exporter。

然后可以使用vendor/bin/mysql-workbench-schema-export命令行脚本。

格式化设置选项

除了mysql-workbench-schema-exporter的通用选项外，还支持以下选项

Doctrine 2.0通用设置选项

• useAutomaticRepository

  自动生成实体存储库类名。

• bundleNamespace

  实体类名全局命名空间前缀。

• entityNamespace

  实体命名空间。

  默认为Entity。

• repositoryNamespace

  实体存储库类名命名空间前缀。为了应用此配置，必须将useAutomaticRepository设置为true。

• skipColumnWithRelation

  不要为与其他表有关系的列生成列定义（对于YAML）或列变量和列获取器、设置器（对于注解）。

  默认为false。

• relatedVarNameFormat

  生成相关列名格式。

  默认为%name%%related%。

• nullableAttribute

  如何生成列和连接的null属性。如果想要根据其值自动包含null属性，请设置为auto。如果始终包含null属性，请设置为always。

  默认为auto。

• generatedValueStrategy

  自动生成值的策略。

  默认为auto。

• defaultCascade

  要定义的默认级联选项。

  默认为false。

Doctrine 2.0 YAML Schema

设置选项

• extendTableNameWithSchemaName

  在表名旁边包含模式名称。

  默认为false。

Doctrine 2.0 Annotation

设置选项

• useAnnotationPrefix

  Doctrine注解前缀。

  默认为ORM\。

• skipGetterAndSetter

  不生成列获取器和设置器。

  默认为false。

• generateEntitySerialization

  生成__sleep()方法以在实体序列化时仅包含实际列。

  默认为true。

• generateExtendableEntity

  为模式中的每个表生成两个类，一个用于基类，另一个用于扩展类。如果已存在扩展类，则不会生成扩展类。因此，可以在扩展类中安全地放置自定义代码。

  此选项将使用单表继承生成实体。

  默认为false。

• quoteIdentifierStrategy

  此选项确定是否应用标识符引号，取决于策略值。

  • auto，如果标识符是保留词，则启用标识符引号。
  • always，始终引号标识符。
  • none，从不引号标识符。

  默认为auto。

• extendsClass

  此选项允许您定义一个基类，所有生成的实体都从此基类扩展。

  默认为''。

• propertyTypehint

  此选项允许您指定是否为所有非标量属性启用类型提示，这些属性的类型是类。例如，\DateTime将启用类型提示，但不是object或string。

  默认为false。

模型注释行为

• {d:bundleNamespace}AcmeBundle{/d:bundleNamespace}（应用于表）

  覆盖bundleNamespace选项。

• {d:m2m}false{/d:m2m}（应用于表）

  MySQL Workbench Schema Exporter 尝试自动猜测哪些表是多对多映射表，并且不会为这些表生成实体类。

  如果一个表被认为是映射表，那么它必须恰好包含两个指向不同表的唯一外键，并且这些表不是多对多映射表。

  有时这种猜测可能对你不正确。但你可以向表的注释中添加提示，表明它不是映射表。只需在表注释的任何地方使用 {d:m2m}false{/d:m2m} 即可。

• {d:unidirectional}true{/d:unidirectional}（应用于 ForeignKey）

  默认情况下，所有外键都会产生双向关系。如果你只想有一个单向关系，请在外键注释中添加一个标志。

• {d:owningSide}true{/d:owningSide}（应用于 ForeignKey）

  在双向多对多映射表中，关系的一侧是随机选择的。如果你向 m2m 表的一个外键添加此提示，你可以为 Doctrine 定义拥有侧。

• {d:cascade}persist, merge, remove, detach, all{/d:cascade}（应用于 ForeignKey）

  你可以在外键注释中指定 Doctrine 级联选项。它们将被生成到注释中。（参考）

• {d:fetch}EAGER{/d:fetch}（应用于 ForeignKey）

  你可以在外键注释中指定关系的抓取类型。（EAGER 或 LAZY，Doctrine 默认是 LAZY）

• {d:orphanRemoval}true{/d:orphanRemoval}（应用于 ForeignKey）

  你可以在外键注释中设置的另一个选项。（参考）

• {d:order}column{/d:order}（应用于 ForeignKey）

  将 OrderBy 注解应用于一对多和多对多关系。OrderBy 注解可以写成以下格式

  column[,(asc|desc)]
  

  支持多列，列之间用换行符分隔。示例用法

  {d:order}
    column1
    column1,desc
  {/d:order}
  

Doctrine 2.0 注解与 ZF2 输入过滤器类

Doctrine 2.0 注解与 ZF2 输入过滤器类格式化器直接扩展 Doctrine 2.0 注解。设置选项和模型注释行为与 Doctrine 2.0 注解以及以下附加组件完全相同。

设置选项

• generateEntityPopulate

  为实体类生成 populate() 方法。

  默认为true。

• generateEntityGetArrayCopy

  为实体类生成 getArrayCopy() 方法。

  默认为true。

命令行界面 (CLI)

请参阅 mysql-workbench-schema-exporter 的文档。

链接

• MySQL Workbench
• Doctrine 项目