PHP Config Writer je PHP knjižnjica za enostavno zapisovanje konfiguracijskih datotek.

Namestitev

Zahteve

PHP Config Writer potrebuje vsaj PHP 5.5.9. Za shranjevanje konfiguracijske datoteke mora imeti spletni strežnik zapisovalni dostop do mape s konfiguracijsko datoteko.

S programom Composer

Priporočen način za nameščanje programa je s programom Composer, upravljalcem odvisnosti za PHP.

V projekt je potrebno dodati filips123/config-writer.

composer require filips123/config-writer:^2.0

Nato boste v vaš program morali samo vključiti autoloader in namepace.

<?php

use ConfigWriter\Config;

require 'vendor/autoload.php';

$config = new Config;

Brez programa Composer

Lahko tudi prenesete datoteke iz GitHuba in jih ročno vključite v vaše datoteke.

Nato boste v vaš program morali vključiti vse datoteke in namepace.

<?php

use ConfigWriter\Config;

require 'src/Exceptions/UnsupportedFormatException.php';
require 'src/Exceptions/WriteException.php';
require 'src/ConfigInterface.php';
require 'src/AbstractConfig.php';
require 'src/Config.php';
require 'src/Record.php';
require 'src/Writers/WriterInterface.php';
require 'src/Writers/PhpWriter.php';

$config = new Config;

Uporaba

Ustvarjanje konfiguracije

Ustvarjanje konfiguracije je možno z razredom ConfigWriter\Config.

$config = new Config;

Konstruktor sprejme dva parametra, podatke in komentar, ki pa nista zahtevana. Parameter s podatki lahko vsebuje prenastavljene podatke za konfiguracijo, komenrar pa dodatni komentar (ali kodo), ki bo vključen na vrh generiranje datoteke.

$config = new Config(
    [
        'username' => 'user',
        'password' => 'pass',
    ],
    <<<EOD
/**
 * The configuration file.
 *
 * It contains configuration data.
 */
EOD;
);

Dodajanje zapisov

Dodajanje zapisov je možno z metodo ConfigWriter\Config::addRecord().

$config->addRecord('application', 'ConfigWriter');

Zapisi lahko vsebujejo tudi komentar, ki bo vključen v konfiguracijo.

$config->addRecord('application', 'ConfigWriter', 'Application name');

Dodajanje odsekov

Odseki vizualno in funkcionalno delijo zapise ali skupine zapisov. Dodani so lahko z metodo ConfigWriter\Config::addSection().

$database = $config->addSection('database', [], 'Database settings');

$database->addRecord('host', 'localhost', 'Database host');
$database->addRecord('port', '3306', 'Database port');

Tudi odseki lahko vsebujejo predefiniranje podatke in komentar.

$config->addSection(
    'database',
    [
        'host' => 'localhost',
        'port' => '3306',
    ],
    'Database settings');

Shranjevanje konfiguracije

Konfiguracijo lahko shranite z metodama ConfigWriter\Config::toString() in ConfigWriter\Config::toFile().

Pri shranjevanju v niz je zapisovalec zahtevan, pri shranjevanju v datoteko pa bo samodejno določen.

$config->toString(new ConfigWriter\Writers\PhpWriter);
$config->toFile('config.php');

Zapisovalci lahko omogočajo tudi dodatne zapisovalne možnosti. Njihovo spreminjanje lahko trenutno povzroči nestabilno delovanje programa.

$config->toFile('config.php', new ConfigWriter\Writers\PhpWriter, ['indentation' => '	']);

Trenutno edini podprt zapisovalec je za PHP array, vendar bo več zapisovalcev dodanih kasneje.

Različice

Program za različice uporablja SemVer. Za ogled objavljenih različic obiščite oznake na skladišču.

Licenca

Program je zaščiten z licenco MIT.