https://github.com/alexandreelise/plg_system_chocofields
Dynamic Custom Fields Inference a.k.a "Choco Fields"
https://github.com/alexandreelise/plg_system_chocofields
joomla-custom-fields joomla-extensions joomla-plugin plugin
Last synced: 10 months ago
JSON representation
Dynamic Custom Fields Inference a.k.a "Choco Fields"
- Host: GitHub
- URL: https://github.com/alexandreelise/plg_system_chocofields
- Owner: alexandreelise
- License: gpl-2.0
- Created: 2021-03-31T21:52:37.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-06-08T04:40:16.000Z (almost 5 years ago)
- Last Synced: 2025-05-26T00:08:45.406Z (about 1 year ago)
- Topics: joomla-custom-fields, joomla-extensions, joomla-plugin, plugin
- Language: PHP
- Homepage: https://apiadept.com
- Size: 498 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Choco Fields
A plugin allowing to populate Joomla Custom Fields from Web Services
## Preamble
Please go for more explanations and for a demo.
In this plugin, we retrieve information from , which is a Directory of social organizations in Brussels.
Example of page for a given organization:
Corresponding page in json format (which will then be used to synchronize our Custom Field values):
## INSTALLATION
* Go to build folder and install latest extension file
## Setup of the website for this plugin
This version of the plugin uses what we call "Dynamic Custom Field Inference" . Behind this fancy looking words are basically if statements and some "secret" public sauce since this repo is public anyone can see it and play around with the code to grasp the idea behind this seemingly "complex" concept.
This plugin tries it's best to infer and create dynamically the types of custom fields that migth come from the cached fetched json api.
It attempts to adapt to any kind of json api regardless of its structure.
It accomplishes this by "flattening" the resulting cached json using the native Joomla! Registry flatten method which turns any json to a one dimension associative array which deeper keys are merge in one first level key seperated by a custom separator in our example it's a dot.
Joomla natively supports multilingual websites. So we assign the corresponding language (FR / NL) to each Custom Field, meaning that they will appear in the front-end in function of the selected language on the website.
## Options
The plugin has several Options. You can indeed:
- Type a default api url in plugin params as fallback to each url customisable in the each article
- Type a default resource id for the same purpose. (as a fallback)
- Use the native Joomla! Ajax feature special url to call trigger a manual update via url, cron or webcron
- enable/disable the Action Log (you can access the Log file on JPATH_ROOT/administrator/logs/chocofields.trace.log.php or JPATH_ROOT/logs)
## SPECIAL THANKS
This plugin is based on the work of a core "team" of 4 joomlers which are:
* [Pascal Leconte](https://www.conseilgouz.com)
* [Christophe Avonture](https://avonture.be)
* [Marc Dechèvre](https://woluweb.be)
* [Alexandre ELISÉ](https://alexandre-elise.fr)
## BASED ON
The first version of this plugin can be found [here](https://github.com/woluweb/updatecf)
## CONTRIBUTIONS
Contributions are welcome to improve this plugin. Still work in progress.
--------------------------------------------
## INFOS
> English: [Click here to get in touch](https://github.com/mralexandrelise/mralexandrelise/blob/master/community.md "Get in touch")
> Français: [Cliquez ici pour me contacter](https://github.com/mralexandrelise/mralexandrelise/blob/master/community.md "Me contacter")