plugse/fileandpath

A library to assist in writing and reading documents.

1.0.0 2023-05-19 14:27 UTC

Requires

• php: >=7.4

Requires (Dev)

• phpunit/phpunit: ^9

MIT

• José Hélio Veríssimo Jr

• log
• json
• file
• path
• read
• write
• env

README

Salvando e lendo dados em arquivos de maneira simplificada

Menu

• Instalação como Dependência
  • Diretamente pelo Composer
  • Alterando o arquivo composer.json
• Rodando os Testes
• Funcionalidades
• Exceções

Instalação como dependência

Instale File and Path usando o Composer

Diretamente pelo Composer

  composer require plugse/fileandpath

Alterando o arquivo composer.json

1. Crie ou altere o arquivo composer.json
2. Crie ou altere a propriedade require

{
    "require": {
        "plugse/fileandpath": "^1"
    }
}

1. Atualize a biblioteca com o comando abaixo:

    composer update

Rodando os testes

Para rodar os testes, rode o seguinte comando

  composer run-script post-install-cmd

Funcionalidades

• Cria um caminho caso ainda não exista

File::createPathIfNotExists(
    string $path
): void

• Salva um array em um arquivo JSON

Json::Save(
    string $filename,
    array $dataStructure
): void

• Salva um array em um arquivo .ENV

Env::save(
    string $filename,
    array $dataStructure
): void

• Salva um array em um arquivo de LOG

Log::save(
    string $filename,
    array $dataStructure
): void

• Lê um arquivo JSON e retorna o conteúdo como um array

Json::read(
    string $filename
): array

• Lê um arquivo .ENV e retorna o conteúdo como um array

Env::read(
    string $filename
): array

• Lê um arquivo de LOG e retorna o conteúdo como um array

Log::read(
    string $filename
): array

Exceções

• FileAlreadyExists

• FileNotFound