DoctrineEncryptBundle 项目使用教程

1. 项目的目录结构及介绍

DoctrineEncryptBundle 是一个用于加密 Symfony 实体的 Symfony Bundle。项目的主要目录结构如下：

• src/
  • 存放Bundle的核心代码。
• tests/
  • 包含单元测试和集成测试。
• config/
  • 存放配置文件。
• .gitignore
  • 指定哪些文件和目录应该被 Git 忽略。
• composer.json
  • 定义项目的依赖和元数据。
• phpunit.xml.dist
  • PHPUnit 的配置文件。
• README.md
  • 项目说明文件。
• LICENSE
  • 项目的许可文件。

2. 项目的启动文件介绍

项目的启动主要通过 composer.json 文件来管理。在项目根目录下运行以下命令安装依赖：

composer install

这将安装项目所需的全部依赖，包括 DoctrineEncryptBundle 本身。

接下来，需要在你的 Symfony 应用中的 appKernel.php 文件中注册这个 Bundle：

new AbsoluteQuantum\DoctrineEncryptBundle\AbsoluteQuantumDoctrineEncryptBundle(),

确保注册了该 Bundle 后，Symfony 应用才能使用它提供的功能。

3. 项目的配置文件介绍

DoctrineEncryptBundle 的配置主要通过 config.yml 文件进行。以下是一个配置示例：

ambta_doctrine_encrypt:
    encryptor_class: Halite # 或者 Defuse
    secret_directory_path: '%kernel.project_dir%'

在这里，encryptor_class 指定了加密类，可以是 Halite 或 Defuse。选择 Defuse 时，需要先通过 Composer 安装 defuse/php-encryption：

composer require "defuse/php-encryption ^2.0"

secret_directory_path 指定了密钥文件的存储路径，通常是项目的根目录。

请确保将生成的密钥文件（例如 .DefuseEncryptor.key 或 .HaliteEncryptor.key）添加到 .gitignore 文件中，以避免将密钥上传到版本控制系统。

完成以上配置后，DoctrineEncryptBundle 就可以正常工作，为你的 Symfony 应用提供实体加密功能了。