iconfig

KO | EN

gitlite — search

#javascript #react #ai #go #linux #nodejs #java #windows #awesome #awesome-list #vue #mcp #ios #openai

(★ 15)

A simple and smart, dynamic configuration manager for any PHP application/website.

iconfig 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Iconfig [![Build Status](https://travis-ci.org/heera/iconfig.svg?branch=master)](https://travis-ci.org/heera/iconfig) [![Latest Stable Version](https://poser.pugx.org/sheikhheera/iconfig/version)](https://packagist.org/packages/sheikhheera/iconfig) [![Total Downloads](https://poser.pugx.org/sheikhheera/iconfig/downloads)](https://packagist.org/packages/sheikhheera/iconfig) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/heera/iconfig/blob/master/license.txt)

A very simple, smart, light-weight and dynamic configuration manager for `PHP`.

Iconfig (Instant Config) could be used as a stand alone component to manage the configuration of any php application. It can load
settings saved in a php file and build an array which would be available at run time. It provides useful methods to set or retrieve any configuration at the run time of an application.

## Installation

Iconfig uses [Composer](http://getcomposer.org/) to make things easy.

Learn to use composer and add this to require (in your composer.json):

"sheikhheera/iconfig": "1.0.0"
    
And run:

composer update

Library on [Packagist](https://packagist.org/packages/sheikhheera/iconfig).

## How It Works ?
Basically, php applications or `mvc` frameworks use array for configurations, for example, this is a sample of database configuration
```PHP
return array(
 	'default' => 'mysql',
	'connections' => array(
		'sqlite' => array(
			'driver'   => 'sqlite',
			'database' => 'public/caliber.sqlite',
			'prefix'   => 'cb_',
		),
		'mysql' => array(
			'driver'    => 'mysql',
			'host'      => 'localhost',
			'database'  => 'caliber',
			'username'  => 'root',
			'password'  => 'bossboss',
			'charset'   => 'utf8',
			'collation' => 'utf8_unicode_ci',
			'prefix'    => 'cb_',
		)
   ),
);
```
An `mvc` framework or an application without any framework must have some common settings and user can configure those according to his/her need and
most often all configuration files reside in a single folder, commonly, the `config` name is used. So, keeping that on mind, this dynamic configuration
manager (or whatever you say) has been built, which loads all files from a given path. For example :
## Initialization
```PHP
$config = new Iconfig\Config('config');
```
Above code will load all files from the `config` folder (it expects arrays inside files) and will put everything in an array (groups using file name). Now, you can set/get any
item from the array. For example, if you want to get the `default` item from the array, then you can use
```PHP
$default = $config->getDatabase('default'); // mysql
```
Now, what is `getDatabase()` ? Actually, in this example, I've used the file name `database.php` for this array so I can use `getDatabase()` and `setDatabase()` to get or set an item.
If I have a file named with `session.php` then I can use `getSession()` and `setSession()` to get or set any settings for session management. Which means, when you will pass the path
(where you all configuration files are saved) to the constructor it'l load all 'php' files from that path/folder. So If, for example, in a folder named `settings` you have three files
inside that folder as `database.php`, `session.php` and for example `chache.php` and if you initialize it using
```PHP
$settings = new Iconfig\Config('settings');
```
Then, it'll load all three `php` files from the folder and it'll create one associative array using three groups like
```PHP
Array(
  'database' => array(
    'default' => 'mysql',
    'connections' => array(
		    'sqlite' => array(
			  'driver'   => 'sqlite',
			  'database' => 'public/caliber.sqlite',
			  'prefix'   => 'cb_',
		  )
  ),
  'session' => array(
    'driver' => 'native',
    'lifetime' 120,
    'files' => '/sessions'
  ),
  'chache' =>array(
    'path' => 'c:/web/app/storage'
  )
);
```
Now, you can use this array to retrieve a setting or you can also set/change any predefined settings using dynamic methods.
## Dynamic Methods
You can use `setDatabase()` and `getDatabase` to set/get database' configurations and `setSession()` and `getSession` for session and so on.
These dynamic methods will be available to you after initialization, using php's `overloading` technic.
```PHP
$settings->setDatabase('default', 'sqlite');
$settings->getDatabase('default'); // sqlite

$settings->setSession('lifetime', 240);
$settings->getSession('lifetime'); // 240
```

## Using Alias
If you want you can set an `Alias` and can use methods `statically` like this :
```PHP
new Iconfig\Config('../myApp/config', 'Config'); // Config as Alias, you can use any name
if(Config::isExist('session')) {
    Config::setSession('driver', 'database');
    $sessionArray = Config::getSession(); // full array will be returned when called without argument
}
```
## Give Default Value
Also you can use a defult value like
```PHP
$chache = getChache('path', '/web') // if path doesn't exist then "/web" will be returned
```
## Access Nested Arrays
If you have three database connections and all have a driver `key` then you can specify which `driver` key you want like
```PHP
Config::getDatabase('connections.sqlite.driver'); // get the driver from sqlite
Config::getDatabase('connections.pgsql.driver'); // get the driver from pgsql
```
## Use callbacks
You can use closure as `getMethod($key, $callback)`
```PHP
$connections = Config::getDatabase('connections', function($data){
  if(is_array($data) && array_key_exists('sqlite', $data)) {
		Config::setDatabase('connections.sqlite.driver', 'myNewSqliteDriver');
		return Config::getDatabase('connections'); // this will return connections array with new value
	}
});
```
Same could be used when setting a value like `setDatabase('connections.pgsql.driver', 'pgsql')`. 
## Search Using `find()` Method

You can also use `::find()` to search for an item as
```PHP
Config::find('sqlite'); // if it exists, you'll get the value
Config::find('connections.sqlite'); // it'll look sqlite in to the connections
Config::find('connections.sqlite.driver'); // it'll look driver in to the connections.sqlite array
```
## Get All Using `getAll()` Method
Also you can use
```PHP
$all = Config::getAll();
var_dump($all); // full configuration array will be returned
```
## Load More Files Using `load()` Method
You can also use
```PHP
Config::load('filePath'); // new items will be added.
```
Well, that's all for now. Feel free to use or modify it to improve it's functionality or if you find any bug, please inform me. Hope, I'll be able to add more features in future In-Sha-Allah (on God's will). Thanks!
___
© 2013 Sheikh Heera. Licensed under MIT.

iconfig

iconfig 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

iconfig

iconfig 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README