zqueal/phpconfigure

Simple PHP configure library that adds a key=>value relationship for configuration data callable via variables.

About

A simple configuration script to store values in an array, and return them using public static functions!, _(*1)

Got an email recently about this repository--its all but defunct and no longer necessary. A better approach would be to use .env variables. Check out this project here--and be sure to include .env to your .gitignore., _(*2)

Index

• Usage
• Classes
  • Set
  • Get
  • Return
  • Init
  • Update
• Pull Requests and Support

Usage

Ensure you have at least PHP version 5.4;, _(*3)

Require or include the class file:, _(*4)

require 'vendor/Config.php';

Create your configuration array:, _(*5)

Config::init([
    'username' => 'user',
    'password' => 'password',
    'hostname' => 'localhost',
    'dbname'   => 'test',
    'database' => [
        'hostname' => 'localhost',
        'username' => 'username',
        'password' => 'test',
        'port' => 3306
    ]
]);

Then do stuff with your values:, _(*6)

Config::get('username'); // contains 'user'

Or for multidimensional (init) arrays:, _(*7)

Config::$instance->database{'password'}; // contains 'password'

Classes

There are 5 classes of note, they are: set, get, ret, init, and update., _(*8)

Set

public static function set($key, $val) {
  self::$config[$key] = $val;
}

Enables you to set a single key value pair., _(*9)

Config::set('username', 'zQueal');

Get

public static function get($key) {
    self::$config[$key];
}

Enables you to 'test' a single key pair value. Config::get() will not longer return a value. See Config::ret()., _(*10)

if(Config::get('username') == $value){
    doStuff();
}

Return

public static function ret($key) {
  print self::$config[$key];
}

Returns (print) a single key pair value., _(*11)

Config::ret('username'); // returns stored value

Init

public static function init($a) {
  self::$config = $a;
  self::$instance = new Config();
}

Enables you to set multiple key value pairs in a single function, and create multidimensional values., _(*12)

Config::init([
    'username' => 'username',
    'password' => 'password',
    'directory' => '/home/zqueal',
    'about' => [
        'name' => 'Zach Q',
        'email' => 'zach.queal@gmail.com',
        'color' = 'blue'
    ]
]);

Once your function call has been executed, all the variables will be able to be used in the rest of your script / application. To call a single (top nested) key value pair, use the Config::get('directory'); // contains /home/zqueal static function call. If you're trying to access a nested key value pair, then you need to use the static object method Config::$instance->about{'name'} // returns 'Zach Q'., _(*13)

Update

public static function update($a) {
    self::$config = array_merge(self::$config, $a);
}

A function to update already created values., _(*14)

Config::set('name', 'Zach Q');
Config::ret('name'); // returns 'Zach Q'
Config::update('name', 'Other Name');
Config::ret('name'); // returns 'Other Name'

Pulls and Support

I do not maintain this repository. If you have an improvement I'm open to pull requests, but I do not offer support., _(*15)