Download the PHP package mcustiel/php-simple-config without Composer
On this page you can find all versions of the php package mcustiel/php-simple-config. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mcustiel/php-simple-config
More information about mcustiel/php-simple-config
Files in mcustiel/php-simple-config
Package php-simple-config
Short Description A simple library to manage configuration files in different formats and cache them.
License GPL-3.0+
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package php-simple-config
php-simple-config
What is it?
php-simple-config is a simple and extensible component that allows the developer to abstract the application configuration management.
php-simple-config uses a minimalistic approach and supports different types of configuration files, the currently supported types are:
- PHP files (containing a config array).
- INI files
- JSON files
- YAML files
The component can read and write these configuration formats.
Also, it allows the developer to cache the configurations to increase the performance when accessing to it, this is made through mcustiel/php-simple-cache library.
Installation
Composer:
Just add the packagist dependecy:
Or, if you want to get it directly from github, adding this to your composer.json should be enough:
Or just download the code. :D
How to use it?
Reading configuration
First you have to create a configuration file, in this example it is a PHP file. If the format is PHP you must define a variable containing an array with the configuration and return it, for JSON or INI you don't need any special convention:
or, if you prefer it:
Then you can access the config from your code using a Reader object:
or use the Loader class supplied by the library:
Accessing configuration
The config object allows you to access the information in the configuration file:
Caching the config
php-simple-config allows the developer to create a cached version of the configuration to open and parse it faster. To do this you must provide the ConfigLoader with a CacheConfig object as shown in following code block:
CacheConfig receives the instance of \Mcustiel\SimpleCache\Interfaces\CacheInterface, the key to use, and the time to live in milliseconds.
Writing configuration
To write the configuration to a file you need a Writer object:
NOTE When writing using ini or yaml format, the library does not guarantee that the original format and item order is kept. But the file is still parseable
Example about the note
The original ini file
Could be transformed to:
Examples:
In the unit and functional tests you can see examples of php-simple-config use.
