osn/envoy

一个简单的环境配置加载器。

v2.0.3 2022-03-13 10:33 UTC

This package is auto-updated.

Last update: 2024-09-16 18:48:24 UTC


README

PHP Composer Packagist Version

一个简单的环境配置加载器。

安装

您可以使用composer安装envoy

$ composer require osn/envoy

用法

安装envoy后,您可以将composer生成的自动加载器包含到项目中并开始编写代码

<?php
  require __DIR__ . "/vendor/autoload.php";
  
  // ...

好了,现在您已经准备好了!让我们看看如何调用envoy。

首先需要创建一个 OSN\Envoy\Envoy 对象。The Envoy 构造函数接受参数1作为环境文件路径,第二个参数是配置数组。这两个参数都是可选的,但请注意,参数1的默认值为 ./.env

然后您需要在实例上调用 load() 方法,将所有配置从环境文件加载到全局变量 $_ENV 中。

如果在解析文件时发生错误,Envoy 将抛出 OSN\Envoy\EntityParseErrorException

<?php
  require __DIR__ . "/vendor/autoload.php";
  
  use OSN\Envoy\Envoy;
  
  $envoy = new Envoy();
  
  try {
    $envoy->load();
    print_r($_ENV);
  }
  catch(\OSN\Envoy\EntityParseErrorException $e){
    echo "Error while parsing the file: " . $e->getMessage();
  }

如果 .env 文件是这样的

DSN=mysql:host=localhost;port=3306;dbname=mydatabase
DB_USER=root
DB_PASSWORD= 

则上面的代码应该打印

Array (
  [DSN] => mysql:host=localhost;port=3306;dbname=mydatabase
  [DB_USER] => root
  [DB_PASSWORD] =>
)

配置

当您创建 Envoy 对象时,可以将配置数组作为第二个参数传递给构造函数。数组遵循以下结构

[
    \OSN\Envoy\Envoy::CONFIG_OPTION_HERE => "value",
    \OSN\Envoy\Envoy::CONFIG_OPTION_2 => true,
]

可用的配置选项

支持

请通过 envoy@onesoftnet.eu.org 联系我们。