dotenv-connector 项目使用教程

dotenv-connector 项目使用教程

dotenv-connectorMakes values from a .env file available as environment variables for composer based projects项目地址:https://gitcode.com/gh_mirrors/do/dotenv-connector

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

dotenv-connector 项目的目录结构如下：

dotenv-connector/
├── LICENSE
├── README.md
├── composer.json
├── php_cs.dist
├── styleci.yml
├── travis.yml
├── src/
│   └── Plugin.php
├── tests/
│   └── Unit/
│       └── PluginTest.php
└── .gitignore

目录结构介绍

• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• composer.json: Composer 依赖管理文件。
• php_cs.dist: PHP 代码风格配置文件。
• styleci.yml: StyleCI 配置文件。
• travis.yml: Travis CI 配置文件。
• src/: 源代码目录，包含项目的主要逻辑。
  • Plugin.php: Composer 插件的主文件。
• tests/: 测试代码目录。
  • Unit/: 单元测试目录。
    • PluginTest.php: 插件的单元测试文件。
• .gitignore: Git 忽略文件配置。

2、项目的启动文件介绍

dotenv-connector 项目的启动文件是 src/Plugin.php。这个文件是 Composer 插件的主文件，负责加载和解析 .env 文件，并将环境变量注入到系统环境中。

启动文件介绍

• Plugin.php:
  • 该文件定义了 Helhum\DotenvConnector\Plugin 类，实现了 Composer 插件的逻辑。
  • 主要方法包括 activate() 和 deactivate()，分别在插件激活和停用时调用。
  • 该文件通过 Composer 的 PluginInterface 接口与 Composer 进行交互。

3、项目的配置文件介绍

dotenv-connector 项目的主要配置文件是 composer.json 和 .env 文件。

composer.json 配置文件介绍

composer.json 文件包含了项目的依赖、脚本和其他配置信息。以下是部分关键配置：

{
  "require": {
    "helhum/dotenv-connector": "1.0.0"
  },
  "extra": {
    "helhum/dotenv-connector": {
      "env-dir": "",
      "allow-overrides": true,
      "cache-dir": "var/cache"
    }
  }
}

• require: 定义了项目的依赖，包括 helhum/dotenv-connector。
• extra: 包含插件的额外配置，如 env-dir、allow-overrides 和 cache-dir。

.env 配置文件介绍

.env 文件用于定义环境变量。以下是一个示例：

TYPO3_CONTEXT="Development"
TYPO3__DB__database="dotenvconnector"
TYPO3__DB__host="127.0.0.1"
TYPO3__DB__password="root"
TYPO3__DB__port="3306"
TYPO3__DB__username="root"

• TYPO3_CONTEXT: 定义 TYPO3 的运行环境。
• TYPO3__DB__*: 定义数据库连接的配置，包括数据库名、主机、密码、端口和用户名。

通过这些配置文件，可以灵活地管理项目的依赖和环境变量，确保项目在不同环境下的稳定运行。

dotenv-connectorMakes values from a .env file available as environment variables for composer based projects项目地址:https://gitcode.com/gh_mirrors/do/dotenv-connector