Download the PHP package jorisvaesen/cakephp-keyvalue-pairs without Composer
On this page you can find all versions of the php package jorisvaesen/cakephp-keyvalue-pairs. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jorisvaesen/cakephp-keyvalue-pairs
More information about jorisvaesen/cakephp-keyvalue-pairs
Files in jorisvaesen/cakephp-keyvalue-pairs
Package cakephp-keyvalue-pairs
Short Description CakePHP plugin to handle key-value pairs to be mapped between datasource and application
License MIT
Homepage https://github.com/jorisvaesen/cakephp-keyvalue-pairs
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 cakephp-keyvalue-pairs
CakePHP 3 Key Value Pairs
Map key-value pairs between datasource and application.
Requirements
- PHP 5.4+
- CakePHP 3.x
Installation
Using composer
Run the following command
or copy the json snippet for the latest version into your project’s composer.json:
You need to enable the plugin
or copy this line into your config/bootstrap.php file:
If you are already using Plugin::loadAll();, then this is not necessary.
Usage
Add behavior
Options
| Key | Default | Description |
|---|---|---|
| fields.key | 'key' |
Name of the key field |
| fields.value | 'value' |
Name of the value field |
| scope | false |
If you want to set extra conditions |
| preventDeletion | false |
Prevent pairs from being deleted. true to disallow deletion, array to specify keys that should not be removed |
| allowedKeys | false |
array of allowed keys or false to allow any |
| cache | false |
Enable or disable caching |
| cacheConfig | 'default' |
A custom cache config that should be used |
Available functions
getPair($key, $asEntity = false)get the value of$key. When$asEntityis set true, it returns the complete entity (useful when you want to make changes to it).getPairs($keys, $requireAll = true, $asEntity = false)returns an associative array with the keys and its values. When$requireAllis set true, the function returns false when not all keys could be found. When$asEntityis set true, it returns the complete entities (useful when you want to make changes to it).
Tips
- Cache invalidation happens on afterSave and afterDelete callbacks, when you use
updateAll, these callbacks don't get called. In this case you should invalidate the cache yourself. - Caching is advisable and its duration can be set to
+999 dayssince the cached result gets invalidated automatically when a pair gets saved or removed. - Caching automatically saves all the pairs in the database and extracts the specific values from it. If you want a cache file for each record, disable caching in this plugin and do the caching yourself or suggest the functionality by doing a pull request.
- This plugin is rather new so it can contain bugs. If you find any or want to suggest enhancements, please use the issue tracker here.
Example
Lets say you have an application where the user can create invoices which should get a prefix and number when created, but this user wants to manage these values for new invoices.
First we create a database table to store the key value pairs and insert the defaults.
We create a cache config that should be used by the plugin.
Next we add the behavior to our table in Model/Table/ConfigsTable.php.
Now when a new invoice is created we can grab the values and increase the invoice number for new invoices (this automatically invalidates the cache).
License
The MIT License (MIT)
Copyright (c) 2016 Joris Vaesen
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
