Download the PHP package jenson/convict without Composer
On this page you can find all versions of the php package jenson/convict. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jenson/convict
More information about jenson/convict
Files in jenson/convict
Package convict
Short Description Configuration management. PHP implementation of node-convict
License MIT
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 convict
php-convict
This is a php implementation of node-convict, with some additional features and some features yet to be implemented.
Install
`
TODO
This is far from a completed library yet, even if it works.
The following needs to be done:
- Unit tests
- More formats
Loading several config files at the same time- More unit tests
- Prettying up the code
- More examples and documentation.
- Implement an optional strict check where errors are thrown if configuration is set that is not defined in the scheme.
- Better exception handling
- Even more unit tests.
Usage
First define a scheme and then get and set values from that scheme:
Can be started with
API
Constructor
Parameters
filename | json-string Scheme The scheme to load, either as a filename or as a JSON string.
Array Options Defaults to an empty array. Valid options:
nohelp => true Turn of the automatic command line help.
Throws
Throws an \Exception if the scheme is invalid.
Convict->get
Parameters
string key Defaults to empty. Use a dot notation to address configuration values.
Returns
null If the key does not exist mixed If the key points to a leaf then that value is returned. If the key points to a part of the configuration tree then that sub-part is returned. An empty key returns the entire config tree.
Throws
Should not throw an exception.
Convict->set
Parameters
string key The key to set the value for. Use a dot notation to address configuration values. If the key doesnt exist then it will be created. mixed value The value to set
Returns
Does not return anything
Throws
Should not throw an exception.
Note
The values set are not persisted in any way. Use Convict->writeFile to save them.
Only the leafs can carry values, and if a new leaf is created then the value on the previous position will be discarded. Example:
``
Convict->addFormat
Set a custom format for the validator to use. Just use the class name in the format field in the scheme. Case insensitive.
Parameters
Convict\Validator\Validator format An instance of a class implementing the Validator interface.
Returns
Does not return anything
Throws
Should not throw an exception.
The Validator interface
validate ($key, $value) Should throw a Validator\ValidationException for invalid values. coerce ($value) Should return a value that has been formated to fit the application.
Convict->validate
Parameters
No parameters
Returns
Does not return any value
Throws
Will throw either a Validator\ValidationException or an \Exception depending on the circumstances.
Note
For convenience sake this function will set the uncaught exception handler function to handle the events it throws out. After the validation it will restore the previous exception handler.
Convict->loadFile
Parameters
Array | filename files Will go through all the filenames in the array and load them in order. Also accepts a single file name.
Returns
Does not return any value.
Throws
Does not throw any exception.
Convict->loadConfigJson
Parameters
Array | string jsons Will go through all the JSON strings and load them to the config as if the were loaded from a file. Can also handle single JSON entries.
Returns
Does not return anything
Throws
Nope.
The config file
A config file is loaded with
and a file that matches the scheme above can look like this
It is not fully json5 compatible, but comments are allowed (and encouraged).
The library can write a config file with
and will use the special about field in the scheme and all the doc fileds as comments.
Precedence
The rules of precedence are:
- Command line argument
- Environment variable
- Configuration file value
- Default value
- Throw an exception because we dont know what to do.
The scheme
Format
Validate the value with this format. Does not apply to runtime config::set's.
Supported formats:
- any | *: No validation and no coercion.
- boolean: True-ish or false-ish (includes the string true, yes, 1 etc. Coerces to strict true/false.
- duration: Miliseconds or a duration string such as 5.4d, 3,2h, 100s etc (yes, it takes both . and ,). Coerces to an int representing miliseconds.
- nat: Natural number. No fractions and above zero. Coerces to int.
- path: Not implemented yet. Should verify that it is an existing path.
- Port: Valid port number.
- Size: Either bytes or a size string such as 50m or 2.3G.
You can add a new format at runtime through config::addFormat(Convict\Validator\Validator).
Arg
Look for this as a long form command argument. Uses getopt in the background, so add :: afterwards to make it optional.
Shortarg
Same as arg, but governs the short form (-X etc).
Env
Load from this environment variable.
Default
Use this value if nothing else comes along. Note that this will also be subjected to the format rules. This is optional, but if it is omitted and not added at runtime then an exception will be thrown when the config is instanciated.
Autogenerated help
Per default the config listens for -h and --help and will print a help message and exit. This can be turned of by passing the option "nohelp" => true.
``
