README

🎯 Objetivo

O Ambivar é um pacote em PHP que tem como objetivo facilitar a gestão de variáveis de ambiente em projetos. Esse pacote permite carregar essas variáveis através de um arquivo .env, que é lido automaticamente ou especificando o diretório do arquivo.

Esse tipo de abordagem tem se tornado cada vez mais comum em projetos de software, pois oferece uma maneira fácil e segura de gerenciar configurações e segredos do projeto, sem precisar expor essas informações no código fonte.

O uso do Ambivar é bastante simples e intuitivo. Basta incluir o pacote no seu projeto PHP e criar um arquivo .env na raiz do projeto, contendo as variáveis de ambiente desejadas. O Ambivar se encarregará de ler esse arquivo e disponibilizar as variáveis para o projeto através de funções específicas.

🔷

🔧 Instalação

Para instalar o pacote Ambivar, certifique-se de que tenha o PHP e o gerenciador de pacotes Composer instalados em seu ambiente. Instale executando o seguinde comando:

$ composer require dev-macb/ambivar

Para clonar o projeto para sua máquina via git, execute os comandos a seguir:

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

🔷

⚙️ Funcionalidades

Para usar o Ambivar basta criar um arquivo .env na raiz de seu projeto. Como, por exemplo:

URL=http//localhost/exemplo

Use as funcionalidades do pacote

<?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');

?>

Lembre-se de adicionar no .gitignore as arquivos de variáveis de ambiente para não colocar dados sensíveis do seu projeto para repositórios na nuvem

🔷

✒️ Contribuições

Toda contribuição será bem-vinda!🎉 Caso tenha encontrado algum bug, propor uma nova funcionalidade ou conversar sobre o projeto Abra uma Issue e descreva seu caso. Se houver uma issue aberta e você deseja resolve-la, adicionar uma nova funcionalidade ou melhorar a documentação, desenvolva suas adições e me envie um Pull Request. Gostou do projeto e ainda não consegue contribuir com ele? Considere deixar uma ⭐ para o Ambivar. Desde já agradeço pelo interesse em colaborar de alguma forma com o nosso projeto.

🔷

📄 Licença

O Ambivar utiliza a licença MIT em todo seu código, confira suas condições em LICENSE.

🔷

dev-macb / ambivar

Maintainers

Details