Download the PHP package yongtiger/yii2-setting without Composer
On this page you can find all versions of the php package yongtiger/yii2-setting. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
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 yii2-setting
Yii2 Setting release version 1.2.0 (CHG# tableName)
Simple and efficient setup. All settings are read from DB or cache into a static array at frontend. Updates specified setting category at backend.
FEATURES
- frontend and backend codes completely separated
- settings pre-stored in DB
- categorized settings
- simple API for frontend read
- displaying all setting items of the specified category by URL route
- displaying a setting item according to the specified input field type
DEPENDENCES
INSTALLATION
The preferred way to install this extension is through composer.
Either run
or add
to the require section of your composer.json.
CONFIGURATION
Database migrations and customize settings
Before usage this extension, you need to prepare the database.
1. Create setting table
2. Customize settings
You need to modify the records in the setting table by any SQL query tools, such as phpmysqladmin.
Refer to
demo settings in DBandUsages.
Backend setup
1. Module setup
To access the module in backend, you need to configure the modules array in your application configuration:
2. Internationalization setup (optional)
All text and messages introduced in this extension (NOT include the settings in DB!) are translatable under category:
And the default basePath is '@vendor/yongtiger/yii2-setting/src/messages'.
If you want to custumize your own translations, using following application configuration:
USAGE IN FRONTEND
Note: Only
category,key,valueandtypefields in the setting table are used in the frontend.
Use function Setting::get($category, $key, $default = null) to get a setting directly (no need frontend setup):
The return value has been automatically converted to the type defined in the setting type.
See more about setting type:
-
Using basic setting type -
Using array setting type Using object setting type
Using default value
Note: It is recommended that
default valuebe set to define the type in thesetting type.
Using setting array
In frontend, while getting any setting for the first time, all settings are read from DB or cache into a static array. Later, you can read a setting from the static array.
Using caching:
Default caching is enabled.
Sometimes you need to disable the cache (e.g. in testing):
USAGE IN BACKEND
You can access or update setting page by given the specified category:
See more advanced settings:
-
Using input field type -
Using items and options -
Using label and labelOptions Using hint and hintOptions
TODO
Development roadmap
LICENSE
Yii2-setting is released under the MIT license, see LICENSE file for details.
