Introduction
- Allow plugin to gather configuration data from the plugin user.
- Plugin properties options should be returned in the abstract method "getPropertyOptions" of each plugin.
- Plugin properties options are in JSON format.
Basic Properties Options Structure
[
{
title : 'Page Title',
properties : [
{
name : 'Property Name',
label : 'Property Label',
type : 'Property Type',
required : 'Mandatory or Not',
//… more property attributes …
}, //… more properties …
],
validators : [
//… properties custom validators …
]
}, //… more properties page …
]
Properties Option Types
Hidden field - hidden
Read only field – readonly
Text field – textfield
Password field – password
Text area field – textarea
HTML editor field – htmleditor
Checkbox field – checkbox
Radio button field – radio
Select box field – selectbox
Multi select box field – multiselect
Element (Plugin) select field – elementselect
Grid field - grid
- Hidden field - hidden
- Read only field – readonly
- Text field – textfield
- Password field – password
- Text area field – textarea
- HTML editor field – htmleditor
- Checkbox field – checkbox
- Radio button field – radio
- Select box field – selectbox
- Multi select box field – multiselect
- Element (Plugin) select field – elementselect
- Grid field - grid
Properties Validator Types
- AJAX - ajax
Detail attributes of Option Types
Common Attributes for All Properties Options Type except Hidden Field and Grid
{
name : 'Property Name',
label : 'Property Label',
description : 'Property Description', //optional, default is NULL
type : 'readonly',
value : 'Property Value', //optional , default is empty string
required : 'true', //optional, boolean value, default is false
}
Extra Attributes for Text Field, Password Field, Text Area and HTML Editor
{
size : '50', //optional , integer value, default is NULL, only for text field and password field
maxlength : '50', //optional, integer value, default is NULL, only for text field and password field
rows : '50', //optional, integer value, default is NULL, only for text area and html editor
cols : '50', //optional, integer value, default is NULL , only for text area and html editor
regex_validation : '^[a-zA-Z0-9_|a-zA-Z0-9_]
+$', //optional, default is NULL
validation_message : 'Error!!' //optional, default is NULL
}