Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/laruence/yaconf
A PHP Persistent Configurations Container
https://github.com/laruence/yaconf
c configuration-management php yaconf
Last synced: about 2 months ago
JSON representation
A PHP Persistent Configurations Container
- Host: GitHub
- URL: https://github.com/laruence/yaconf
- Owner: laruence
- License: other
- Created: 2013-08-12T02:34:04.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-06-28T08:59:05.000Z (3 months ago)
- Last Synced: 2024-06-29T05:21:41.024Z (3 months ago)
- Topics: c, configuration-management, php, yaconf
- Language: C
- Homepage:
- Size: 140 KB
- Stars: 1,042
- Watchers: 78
- Forks: 186
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-php-extensions - yaconf - 配置管理 (框架组件)
- awesome-php-cn - Yaconf - 一个高性能的配置管理扩展 (配置 Configuration / 无服务器的 Serverless)
- php-awesome - Yaconf - 高性能的配置管理扩展 (PHP 扩展 / PRC)
README
# Yaconf - Yet Another Configurations Container
[](https://ci.appveyor.com/project/laruence/yaconf/branch/master) [](https://github.com/laruence/yaconf/actions?query=workflow%3Aintegrate)
A PHP Persistent Configurations Container
### Requirement
- PHP 7+
### Introduction
Yaconf is a configurations container, it parses ini files, store the result in PHP when PHP is started, configurations live in the whole PHP lifecycle, which makes it very fast.
### Features
- Fast, Light
- Zero-copy while accesses configurations
- Support sections, sections inheritance
- Configurations reload automatically after changed
### Install
#### Compile Yaconf in Linux
Yaconf is an PECL extension, thus you can simply install it by:
```
$pecl install yaconf
```
Or you can compile it by your self:
```
$ /path/to/php7/bin/phpize
$ ./configure --with-php-config=/path/to/php7/bin/php-config
$ make && make install
```
### Runtime configuration
- yaconf.directory
```
Path to directory which all ini configuration files are placed in
```
- yaconf.check_delay
```
In which interval Yaconf will detect ini file's change(by directory's mtime),
if it is set to zero, you have to restart php to reloading configurations.
```
### APIs
````php
mixed Yaconf::get(string $name, mixed $default = NULL)
bool Yaconf::has(string $name)
````
### Example
#### Directory
Assuming we place all configurations files in /tmp/yaconf/, thus we added this into php.ini
```
yaconf.directory=/tmp/yaconf
````
#### INI Files
Assuming there are two files in /tmp/yaconf
foo.ini
````ini
name="yaconf" ;string
year=2015 ;number
features[]="fast" ;map
features.1="light"
features.plus="zero-copy"
features.constant=PHP_VERSION ;PHP constants
features.env=${HOME} ;Enviorment variables
````
and bar.ini
````ini
[base]
parent="yaconf"
children="NULL"
[children:base] ;inherit from section "base"
children="set"
````
#### Run
lets retrieve the configurations from Yaconf
##### foo.ini
````php
php7 -r 'var_dump(Yaconf::get("foo"));'
/*
array(3) {
["name"]=>
string(6) "yaconf"
["year"]=>
string(4) "2015"
["features"]=>
array(5) {
[0]=>
string(4) "fast"
[1]=>
string(5) "light"
["plus"]=>
string(9) "zero-copy"
["constant"]=>
string(9) "7.0.0-dev"
["env"] =>
string(16) "/home/huixinchen"
}
}
*/
````
As you can see, Yaconf supports string, map(array), ini, env variable and PHP constants.
You can also access configurations like this:
````php
php7 -r 'var_dump(Yaconf::get("foo.name"));'
//string(6) "yaconf"
php7 -r 'var_dump(Yaconf::get("foo.features.1"));'
//string(5) "light"
php7 -r 'var_dump(Yaconf::get("foo.features")["plus"]);'
//string(9) "zero-copy"
````
##### bar.ini
Now let's see the sections and sections inheritance:
````php
php7 -r 'var_dump(Yaconf::get("bar"));'
/*
array(2) {
["base"]=>
array(2) {
["parent"]=>
string(6) "yaconf"
["children"]=>
string(4) "NULL"
}
["children"]=>
array(2) {
["parent"]=>
string(6) "yaconf"
["children"]=>
string(3) "set"
}
}
*/
````
Children section has inherited values in base sections, and children is able to override the values they want.