sugiphp/config

SugiPHP Config Component

1.0.0 2014-12-16 12:51 UTC

Requires

• php: >=5.3

Requires (Dev)

• symfony/yaml: ~2.2

Suggests

• symfony/yaml: Symfony Yaml Component to use .yml config files

MIT

• Plamen Popov

• yaml
• php
• json
• xml
• configuration
• ini
• config

README

Installation

composer require sugiphp/config ~1.0

SugiPHP\Config is designed to simplify access to configuration settings. Config class natively supports reading and parsing configuration options from several file types (php, json, yaml, ini, xml) stored in one or several locations in your project. Config::get("file.key") method automatically finds configuration file, loads it, parses it and then searches for the key and returns it's value. If the file or the key is not found gracefully returns NULL or some other default value if it is provided like a second parameter.

Usage

You can use different file types to store settings:

• PHP (with filename app.php)

<?php
return array(
	"development" => array(
		"host" => "localhost",
		"debug" => 1
	),
	"production" => array(
		"host" => "example.com"
	)
);
?>

• JSON (app.json)

{
	"development": {
		"host": "localhost",
		"debug": 1
	},
	"production": {
		"host": "example.com"
	}
}

• YAML (app.yml)

development:
	host: localhost
	debug: 1

production:
	host: example.com

• INI (app.ini)

[development]
host=localhost
debug=1

[production]
host=example.com

• XML (app.xml)

<?xml version='1.0'?>
<environments>
	<development>
		<host>localhost</host>
		<debug>1</debug>
	</development>
	<production>
		<host>example.com</host>
	</production>
</environments>

To access the host option no matter wich type of configurations file you use:

<?php
$locator = new \SugiPHP\Config\FileLocator(__DIR__."/config");
$loader = new \SugiPHP\Config\JsonLoader($locator);
$config = new \SugiPHP\Config\Config($loader);

$config->get("app.production.host"); // returns example.com
$config->get("app.development"); // array("host" => "localhost", "debug" => 1)
$config->get("app.production.debug"); // will return NULL
$config->get("app.testing.host", "127.0.0.1"); // will return default value "127.0.0.1"
?>

FileLocator

FileLocator is used to search for a (configuration) file in one or more directories.

<?php
// search in one directory only
$locator = new FileLocator("/path/to/your/app/config/");
// search in several directories
$locator = new FileLocator(array("/path/to/your/app/config", "/other/config/path/"));
// add additional path
$locator->addPath("/somewhere/else/config/");
// Note that later method adds a path to the end. Locator will search in it only if the
// file was NOT found in the previously added paths. If you wish to add a path in the
// beginning of the search paths use:
$locator->unshiftPath("/first/search/path/");
// remove a search path from the end of the search paths:
$locator->popPath();
// remove a path from the beginning of the search paths:
$locator->shiftPath();
?>

Loader

A loader binds a key with a corresponding value which can be found somewhere (in a file, in a database, etc.) and can be in any form (a php array, json string, xml, etc.). A simple example that explains a loader: Lets assume your application resides in a "/path/to/app", and your configuration files are in "/path/to/app/config" path. Your application needs a database connection. The host, database, user and password are described in a PHP file living in configuration directory. You can use a loader which will include a file (a $key = "database" with ".php" extension) in that folder and return the contents, like the PHP code will do:

<?php
include "/path/to/app/config/database.php";
?>

A slightly more complicated example is when a database is described in an json format. So the loader will do something like:

<?php
return json_decode(file_get_contents("/path/to/app/config/database.json"), true);
?>

Another example is if some of your app configurations are stored not in files but lets say in a NoSQL storage. So you can write your custom loader which will connect to the NoSQL DB, fetch items and return them as array. And that's really easy, and the better thing is that your existing code will not need any modification.

You can peek in Database Loader for a simple database configuration store example.