achrome/conphig

A simple PHP configurator.

Welcome to Conphig

It's a simple configuration generator that parses different types of configuration files into an object. The idea behind it is to standardize configuration objects and allowing you to mix and match configuration files as per need.

Currently the only supported file types are INI, XML and JSON. YAML support can be added through custom configuration

Installation

With Composer

Just add this to your composer.json

{
	"require": {
		"achrome/conphig": "*"
	}
}

Alternatively, you can use the composer CLI like this

$ php composer.phar require 'achrome/conphig=*'

Or

$ composer require 'achrome/conphig=*'

Then, in the application bootstrap, just require 'vendor/autoload.php'.

Without Composer (Honestly, why?)

You can clone this repo directly and use it as well, like this

$ mkdir vendor && cd vendor
$ git clone https://github.com/Achrome/Conphig.git

Then, you just have to require 'Conphig/autoload.php' in the bootstrap file.

Usage

In the application bootstrap, require 'Conphig/autoload.php' to set up the autoloader, or if you are using Composer, just require 'vendor/autoload.php'

use Conphig\Factories\ConfigurationFactory;

$configCreator = new ConfigurationFactory;
$configuration = $configCreator->setConfigPath('/path/to/config/dir')
					       ->setConfigFileName('configFileName')
					       ->setConfigType('filetype')
					       ->create();

Or, if you prefer to go through a simpler route

use Conphig\Factories\ConfigurationFactory;

$configCreator = new ConfigurationFactory;
$configuration = $configCreator->create('/path/to/config/file.ext');

By default, it will take the file name config and type ini, so the only thing it needs is the path.

If this is the case, you could just do this.

use Conphig\Factories\ConfigurationFactory;

$configCreator = new ConfigurationFactory('/path/to/config/dir');
$configuration = $configCreator->create();

For example, if a config.ini looks like this,

[database]
engine = mysql
host = localhost
dbname = test
user = root
password = FooBar1234

When parsed through Conphig

use Conphig\Factories\ConfigurationFactory;

$configCreator = new ConfigurationFactory('/path/to/config/dir');
$configuration = $configCreator->create();

echo $configuration->database->engine; //Will output mysql

Custom configurators

You can register your own configuration system by extending Conphig\Configurators\AbstractConfigurator like this

namespace Foo;

use Conphig\Configurators\AbstractConfigurator;

class BarConfigurator extends AbstractConfigurator {

	public function parseConfig() {
		//The file name is saved in AbstractConfigurator::filePath and can be used here to write your own logic to parse the file.
		//Save the configuration in AbstractConfigurator::configuration for the factory to be able to return it.
	}
}

Then, you need to register the custom handler and it will be set as the configurator that will be used

use Conphig\Factories\ConfigurationFactory;

$configCreator = new ConfigurationFactory('/path/to/custom/config/dir');
$configuration = $configCreator->registerConfigHandler('custom', 'Foo\\BarConfigurator')->create();

License

MIT

Contributing

Just add new features as you want and send out a pull request! If you see an issue, just open it in issues Note: Please run grunt before committing to make sure code style and unit tests pass

Contact

Github Mail

conphig's Issues

Unit Tests

Increase unit test coverage to 100%

This library uses the Singleton pattern!

Use of the Singleton pattern is highly not recommended:

• The Singleton pattern introduces global state which
  • Makes it very hard for users of your library to test the code.
  • Makes applications who use it lie about their dependencies (The methods don't mention they need the Configuration class, but in fact, they do need it).

Instead, you should:

• Make the constructor public
• Get rid of static methods (and especially getInstance)
• Use proper DI and utilize the constructor's arguments.

For more information: The Clean Code Talks - Don't Look for Things!