dev-macb/ambivar

Ambivar 是一个 PHP 包,旨在简化项目中对环境变量的管理。

1.2.0 2023-07-24 23:47 UTC

This package is auto-updated.

Last update: 2024-09-25 02:33:28 UTC


README

Packagist Version Packagist Downloads Packagist License

🎯 目标

Ambivar 是一个 PHP 包,旨在简化项目中对环境变量的管理。该包允许通过 .env 文件加载这些变量,该文件可以自动读取或指定文件所在的目录。

这种做法在软件项目中变得越来越普遍,因为它提供了一种简单且安全的方式来管理配置和项目秘密,而无需在源代码中暴露这些信息。

Ambivar 的使用非常简单直观。只需将包添加到您的 PHP 项目中,并在项目根目录下创建一个 .env 文件,包含所需的变量。Ambivar 将负责读取该文件并通过特定函数提供这些变量。

🔷

🔧 安装

要安装 Ambivar 包,请确保您的环境中已安装 PHP 和包管理器 Composer。通过以下命令进行安装:

$ composer require dev-macb/ambivar

通过 git 将项目克隆到您的机器上,请执行以下命令

$ mkdir ambivar && cd ambivar
$ git clone https://github.com/dev-macb/ambivar
$ composer install

🔷

⚙️ 功能

要使用 Ambivar,只需在项目根目录下创建一个 .env 文件。例如:

URL=http///exemplo

使用包的功能

<?php
    use MacB\Ambivar;


    // Carregar arquivo .env na raiz do projeto
    Ambivar::dotenv();

    // Carregar um arquivo .env específico
    Ambivar::carregar(__DIR__, 'nome_arquivo');

    // Carregar todos os arquivo .env do diretório específico
    Ambivar::carregar_pasta(__DIR__.'/pasta');


    // Verifica se uma variável de ambiente existe
    Ambivar::existe('URL');

    // Obtem o valor de uma variável ou retorna valor padrão
    $valor = Ambivar::obter('UURRLL', null);


    // Escrever uma variável de ambiente no arquivo especificado
    Ambivar::adicionar('PROJETO', 'ambivar', __DIR__.'/.env');

    // Apagar uma variável de ambiente específica de um arquivo .env
    Ambivar::remover('PROJETO', __DIR__.'/.env');


    // Use as variáveis de ambiente com:
    echo getenv('URL');
    echo $_ENV['URL'];
    echo $_SERVER['URL'];
    echo Ambivar::obter('URL');

?>
请记住在 .gitignore 文件中添加环境变量文件,以防止将项目敏感数据上传到云存储的仓库。

🔷

✒️ 贡献

欢迎所有贡献!🎉 如果您发现了任何错误,提出了新的功能或想讨论项目,请打开一个问题并描述您的案例。如果您已打开一个问题并希望解决它,添加新功能或改进文档,请开发您的改进并将其作为 拉取请求 发送给我。如果您喜欢该项目但无法贡献,请考虑给它一个 ⭐。感谢您以任何方式为我们的项目做出贡献。

🔷

📄 许可证

Ambivar 使用 MIT 许可证在其所有代码中,有关条件请参阅 LICENSE

🔷