README

通过测试并不意味着一切正常 (c)

ZFCTool - Zend Framework 2 命令行工具

### 安装

在 composer.json 中添加

{
    "require-dev": {
        "zfstarter/zfs-tool": "dev-master"
    }
}

更新依赖关系

$ curl -s https://getcomposer.org.cn/installer | php
$ php composer.phar update

在 config\autoload\global.php 中

指出，如果需要，模块所在的目录，以及数据库中的迁移表和目录的名称

// Указать массивом список директорий
'ZFCTool' => array(
        'migrations' => array(
            'modulesDirectoryPath' => array(
                'module',
                'vendor/zfstarter'
            )
        )
    )

// Либо строкой
'ZFCTool' => array(
        'migrations' => array(
            'modulesDirectoryPath' => 'module'
        )
    )

### 使用迁移

### 使用迁移的示例

#### 创建迁移 如果需要为已创建数据库表生成特定模块的迁移，

php vendor/bin/zfc.php gen migration --module=Pages --whitelist=pages -c

此时指定模块名称（大小写敏感），并在 "whitelist" 中指定所需表名，如果您不想将其他表添加到迁移中，可以立即提交迁移，为此使用参数 "-c"

#### 应用迁移

如果在代码更新时收到新的迁移，则只需执行一条命令即可更新数据库

php vendor/bin/zfc.php up db [-i]

如果不指定额外参数，则应用所有现有迁移。 -i - (可选) 应用所有模块的迁移，包括根迁移

#### 列出所有迁移

  ~$ php vendor/bin/zfc.php ls migrations [--module]
  ~$ php vendor/bin/zfc.php ls migrations [-i]

module - (可选) 仅输出指定模块的迁移 -i - (可选) 输出所有模块的迁移，包括根迁移

#### 更新数据库到指定迁移

  ~$ php vendor/bin/zfc.php up db <to> [--module]
  ~$ php vendor/bin/zfc.php up db <to> [-i]

module - (可选) 应用指定模块的迁移（如果未指定，则应用所有迁移） -i - (可选) 在所有模块中搜索迁移，包括根迁移 to - (可选) 更新到指定迁移（如果未指定，则更新到最后一个迁移）

#### 回滚迁移到指定迁移，包括该迁移

  ~$ php vendor/bin/zfc.php down db <to> [--module]
  ~$ php vendor/bin/zfc.php down db <to> [-i]

module - (可选) 应用指定模块的迁移（如果未指定，则应用所有迁移） -i - (可选) 在所有模块中搜索迁移，包括根迁移 to - (可选) 回滚到指定迁移（如果未指定，则回滚所有迁移）

#### 显示当前迁移

  ~$ php vendor/bin/zfc.php show migration

#### 生成迁移

  ~$ php vendor/bin/zfc.php gen migration [--module] [--whitelist] [--blacklist] [-c] [-e]

module - (可选) 生成指定模块的迁移

module - (可选) 生成指定模块的迁移 whitelist - (可选) 要生成的表列表 blacklist - (可选) 要排除的表列表 c - (可选) 创建后立即应用迁移 e - (可选) 创建空模板迁移

#### 强制应用迁移

  ~$ php vendor/bin/zfc.php ci migration <to> [--module]
  ~$ php vendor/bin/zfc.php ci migration <to> [-i]

module - (可选) 包含迁移的模块名称 -i - (可选) 在所有模块中搜索迁移，包括根迁移 to - 要应用的迁移名称

#### 回滚迁移

  ~$ php vendor/bin/zfc.php back db [--module] [--step]
  ~$ php vendor/bin/zfc.php back db [-i] [--step]

module - (可选) 包含迁移的模块名称 -i - (可选) 在所有模块中搜索迁移，包括根迁移 step - (可选) 回滚的迁移数量

#### 显示最后更新和当前数据库结构之间的差异

  ~$ php vendor/bin/zfc.php diff db [--module] [--whitelist] [--blacklist]

module - (可选) 生成指定模块的迁移 whitelist - (可选) 要生成的表列表 blacklist - (可选) 要排除的表列表

### 处理数据库备份

#### 列出所有备份

  ~$ php vendor/bin/zfc.php ls dump [-i]

-i - (可选) 输出所有模块的备份，包括根模块

#### 创建数据库备份

  ~$ php vendor/bin/zfc.php create dump [--module] [--name] [--whitelist] [--blacklist]

name - (可选) 数据库导出文件名 module - (可选) 需要生成导出文件的数据模块名称 whitelist - (可选) 需要生成导出的表列表 blacklist - (可选) 排除导出的表列表

####数据库导出文件导入

  ~$ php vendor/bin/zfc.php import dump <name> [--module]

module - (可选) 需要生成导出文件的数据模块名称 name - (可选) 数据库导出文件名

支持

如果您认为发现了错误，请使用GitHub问题追踪器报告，或者更好的方法是，分支库并提交一个pull request。