Download the PHP package yii1tech/config without Composer
On this page you can find all versions of the php package yii1tech/config. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download yii1tech/config
More information about yii1tech/config
Files in yii1tech/config
Package config
Short Description Provides support for Yii1 application runtime configuration
License BSD-3-Clause
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 config
Application Runtime Configuration Extension for Yii 1
This extension introduces persistent configuration repository for Yii 1. Its usage in particular provides support for application runtime configuration, loading config from database.
For license information check the LICENSE-file.
Installation
The preferred way to install this extension is through composer.
Either run
or add
to the "require" section of your composer.json.
Usage
This extension allows reconfiguring already created Yii application instance using config extracted from external storage
like relational database. It allows to reconfigure any application property, component or module.
Configuration is performed by \yii1tech\config\Manager component, which should be added to the application configuration.
For example:
In order to apply configuration defined via \yii1tech\config\Manager - yii1tech\config\ConfiguresAppFromConfigManager application
behavior is used. It automatically updates the application configuration before request processing begins.
You can apply config manually to the application or any \CModule descendant, using following code:
Heads up! Behavior yii1tech\config\ConfiguresAppFromConfigManager automatically suppresses any error or exception, which appears during values
restoration. This is done to avoid application blocking in case storage is not yet ready for usage, for example: database table does not yet exist.
Storage failure error will appear only at the application log. You should manually test value restoration is working at your application
to avoid unexpected behavior.
Configuration items specification
Application parts, which should be reconfigured are determined by \yii1tech\config\Manager::$items, which is a list
of \yii1tech\config\Item. Each configuration item determines the configuration path - a list of keys in application
configuration array, which leads to the target value. For example: path 'components.format.dateFormat' (or
['components', 'format', 'dateFormat']) points to the property 'dateFormat' of \CFormatter component,
path 'name' points to \CApplication::$name and so on.
Note: if no path is specified it will be considered as a key inside
\CModule::$paramsarray, which matches configuration item id (name of key in\yii1tech\config\Manager::$itemsarray).
Configuration item may also have several properties, which supports creation of web interface for configuration setup. These are:
- 'path' - array|string, application component config path.
- 'label' - string, input label.
- 'description' - string, configuration parameter description or input hint.
- 'rules' - array, value validation rules.
- 'cast' - string, native type for the value to be cast to.
- 'options' - array, additional descriptive options for this item.
Tip: since runtime configuration may consist of many items and their declaration may cost a lot of code, it can be moved into a separated file and specified by this file name.
Here are some examples of item specifications:
Tip: there is no need to prepare data for particualr item inside the storage. If it is missing the value will be picked from current related application configuration. Thus, you can add and remove config items freely without extra action, like DB migration, involved.
Configuration storage
Declared configuration items may be saved into persistent storage and then retrieved from it.
The actual item storage is determined via \yii1tech\config\Manager::$storage.
Following storages are available:
- \yii1tech\config\StoragePhp - stores configuration inside PHP files
- \yii1tech\config\StorageDb - stores configuration inside relational database
- \yii1tech\config\StorageActiveRecord - finds configuration using ActiveRecord
- \yii1tech\config\StorageArray - uses internal array for the config storage, could be useful in unit tests
Please refer to the particular storage class for more details.
Creating configuration web interface
The most common use case for this extension is creating a web interface, which allows control of application
configuration in runtime.
\yii1tech\config\Manager serves not only for applying of the configuration - it also helps to create an
interface for configuration editing.
The web controller for configuration management may look like following:
The main view file can be following:
