...
Requires: phpFox version 4.6.0 or higher.
...
Supported Types
- string
- large_string
- password
- integer
- boolean
- currency
- select
- drop
- array
- multi_text
Deprecated
...
Types
Below types won't be supported anymore since phpFox version 4.7.0.
- drop_with_key
- input:text
- input:radio
Sample Code
string
| Code Block |
|---|
|
$settings = [
'your_setting_name' => [
'var_name' => 'example_name',
'info' => 'example label',
'description' => 'example description',
'type' => 'string',
'value' => 'default_value',
],
];
|
large_string
| Code Block |
|---|
|
$settings = [
'your_setting_name' => [
'var_name' => 'example_name',
'info' => 'example label',
'description' => 'example description',
'type' => 'large_string',
'value' => 'default_value',
],
];
|
password
| Code Block |
|---|
|
$settings = [
'your_setting_name' => [
'var_name' => 'example_name',
'info' => 'example label',
'description' => 'example description',
'type' => 'password',
'value' => 'default_value',
],
];
|
integer
| Code Block |
|---|
|
$settings = [
'your_setting_name' => [
'var_name' => 'example_name',
'info' => 'example label',
'description' => 'example description',
'type' => 'integer',
'value' => 10,
],
];
|
boolean
| Code Block |
|---|
|
$settings = [
'your_setting_name' => [
'var_name' => 'example_name',
'info' => 'example label',
'description' =>'example description',
'type' => 'boolean',
'value' => 0,
],
];
|
currency
| Code Block |
|---|
|
$settings = [
'your_setting_name' => [
'var_name' => 'example_name',
'info' => 'example label',
'description' => 'example description',
'type' => 'currency',
'value' => ['USD' => 0],
],
];
|
select
| Code Block |
|---|
|
$settings = [
'your_setting_name' => [
'var_name' => 'example_name',
'info' => 'example label',
'description' => 'example description',
'type' => 'select',
'value' => 'default_value',
'options' => [
'value_1' => 'Value label 1',
'value_2' => 'Value label 2',
]
],
];
|
...
array
| Code Block |
|---|
|
$settings = [
'your_setting_name' => [
'var_name' => 'example_name',
'info' => 'example label',
'description' => 'example description',
'type' => 'droparray',
'value' => 'default_value',
'options' => [
'value_1' => 'Value label 1',
'value_2' => 'Value label 2',
],3,4],
],
];
|
...
multi_text
| Code Block |
|---|
|
$settings = [
'your_setting_name' => [
'var_name' => 'example_name',
'info' => 'example label',
'description' =>'example description',
'type' => 'arraymulti_text',
'value' => [1,2,3,4],
], ]; |
multi_text
| Code Block |
|---|
| php | php | $settings = [ 'yourvalue_setting_name1' => ['Value label 1',
'var_name' => 'examplevalue_name2', => 'Value label 2',
'info' ],
],
=> 'example label',
'description' =>'example description',
];
|
Validation
You can support to validate your apps settings when admin change them in Admincp:
- Add a plugin/hook with name
validator.admincp_settings_{{app}}
please replace app with your app alias.
...
| Code Block |
|---|
|
// file name: validator.admincp_settings_ad.php
$aValidation['ad_multi_ad_count'] = [ // setting var name
' |
...
...
...
int:required', //the setting is required and must be an |
...
...
...
1', // the in value for this setting is 1.
' |
...
...
...
min Multi-Ad Location" must be greater than 0'), thrown message when admin enter invalid value.
];
|