README

简介

数据字典是一个 Symfony 包，可以将项目数据库结构以 HTML 格式呈现，使开发者更容易阅读字段名、数据类型和注释。

要求

PHP 5.3 或更高版本
Symfony 2.x 或 3.x
Doctrine Symfony 包 ~1.4
Doctrine ORM ^2.4.8
Twig ^1.0||^2.0

安装和用法

这是一个依赖于 Doctrine 的 Symfony 包，您可以通过 Composer 安装它。

安装

步骤 1：下载包

打开命令行，进入您的项目目录，并执行以下命令以下载此包的最新稳定版本

$ composer require mherrera05/data-dictionary "dev-master"
ó
$ composer require mherrera05/data-dictionary ">=1.0"

此命令需要您全局安装了 Composer，有关说明，请参阅 Composer 文档中的安装章节。

步骤 2：启用包

然后，通过将其添加到项目 app/AppKernel.php 文件中注册的包列表中来启用包。

<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...
            new DataDictionaryBundle\DataDictionaryBundle(),
        );

        // ...
    }

    // ...
}

步骤 3：从包导入资源

通过在 routing.yml 中添加资源来导入包资源。

data_dictionary:
    resource: "@DataDictionaryBundle/Resources/config/routing.yml"
    prefix:   /

如果您愿意，可以为 URL 添加前缀。

步骤 4：添加供应商模板

将供应商模板目录添加到 config.yml 中配置的路径。

twig:
    ...
    paths:
        '%kernel.root_dir%/../vendor/mherrera05/data-dictionary/Resources/views': 'DataDictionaryBundle'

用法

步骤 1：将模型导入到 json 文件中

安装并启用包后，您可以执行以下命令

$ php app/console data:dictionary:import {bundle-name}

此命令将数据库表和字段结构导出到 .json 文件。

使用您希望放置 json 文件的包名称。例如，Doctrine 从基础包创建 orm.yml。

步骤 2：调用 URL

文件导入后，只需在网页浏览器中调用该 URL。

/app.php/data-dictionary

维护者

Miguel Herrera https://github.com/mherrera05/

mherrera05 / data-dictionary

维护者

详细信息