| array key |
Description |
Needed? |
Possible content |
Dependancies |
| type |
Determines the type of input field |
mandatory |
textfield, checkbox, radio, hidden, password, select, select_multiple |
|
| default_value |
Allow users to reset individual input fields to the default value (instead of resetting the entire config screen) |
optional |
Any valid config table content (text, numerals) |
|
| help_link |
When the help icon display is enabled, the content of this field determines what the help pop-up will contain.
Example content: f=foo.htm&as=bla&ae=bar |
mandatory |
The f-parameter determines the file name (needs to reside within the docs folder), the as-parameter determines the starting anchor and the ae-parameter the ending anchor. |
none |
| width |
Determines the width of text input fields. |
optional |
Any width entry that is CSS-valid, e.g. 70% (width in percent) or 20 (width in pixels). Default (if no value is given) will be 100%. |
Only applies for the types "textfield" and "password". Possible interaction with the size key |
| size |
Number of characters for the width of the text input fields. |
optional |
Can contain any valid entry for the size parameter of HTML's <input type="text" />-field |
Possible interaction with the width-key. |
| maxlength |
Maximum number of characters allowed to enter into textfield |
optional |
Any valid entry for the maxlength attribute of HTML's <input type="text" />-field |
Regex-field |
| regex |
Regular expression that the value entered will be checked against (using PHP's preg_match) when the form is being submit. If the regular expression returns false, the config field change will be rejected |
optional |
|
maxlength-field |
| regex_not |
Regular expression that the value entered will be checked against (using PHP's preg_match) when the form is being submit (similar to the field "regex") with the difference/exception that the config value the user has entered will be rejected if the regular expression entered into "regex_not" does match the field.
Use it to make sure the end user changes the content of a field once registered to something that makes sense (instead of keeping the default value). |
optional |
|
none |
| bridged |
Determine entries that are disabled / not being taken into account when coppermine is bridged |
optional |
If the entry is set to "hide", the field will be greyed out and disabled. |
|
| options |
Sub-array determines the <option>-entries for a select field or the possible choices for radio buttons |
mandatory for 'type' => 'select' and 'radio' |
For radio buttons:
Non-associative array, that contains the possible options, starting from the option that corresponds to 0 onwards.
$lang_common['no'],
$lang_common['yes'].': '.$lang_admin_php['debug_everyone'],
$lang_common['yes'].': '.$lang_admin_php['debug_admin']
For select-fields:
Either an associative array with the scheme ('option_value' => 'option_label') or a non-associative array ('foo', 'bar', 'whatever').
'options' => array(5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25)
|
|
| additional_description |
Specifies additional text to be displayed after the actual config option name (in the left column of the table). This should allow shorter config options names and alternative ways of describing a config setting for those who are too lazy to click the help icon. |
optional |
Both hardcoded text as well as a reference to a language string. |
none |
| end_description |
Specifies additional text to be displayed after the input field. Should be used for short strings or links to other pages. |
optional |
Both hardcoded text as well as a reference to a language string. |
none |
| preserve_when_resetting |
If set to '1', the setting will remain as-is even if the entire config is reset to factory defaults. Currently only used for the legacy feature "password encryption", as it is a one-way feature that can not be undone. |
optional |
1 |
none |
| only_display_if |
Was used to make sure that the one-way setting "enable_encrypted_passwords" would be only displayed if the config value is zero. As the storage of unencrypted passwords has been dropped for cpg1.5.x, there is currently no use for this setting. |
optional |
Any valid content of the config field that it is checked against |
none |
| only_display_if_not |
Used to make sure that the one-way setting "thumb_pfx" will be only displayed if the config value differs from the given value, thus making sure that only upgraded galleries with different settings get displayed. If the value is default, it won't be displayed. |
optional |
Any valid content of the config field that it is checked against |
none |
| linebreak |
If set, the value of the entry will be added to the HTML output for all radio buttons after each option. Use it for option labels that need a lot of space to make the output better readable. |
optional |
<br /> |
type = radio |
| warning |
When set, a warning will be displayed that the config setting mustn't be changed when there are already pics in the database |
optional |
Any reference to the language file (or even hard-coded text) will do - it will be displayed in the JavaScript alert box and onmouseover. |
none |
| min |
If set, there will be spin buttons next to the field and the minimum value will be set to what you specify here. Additionally, the value will be checked when the form is submit. |
optional |
Numeric |
type = textfield |
| max |
If set, there will be spin buttons next to the field and the maximum value will be set to what you specify here. Additionally, the value will be checked when the form is submit. |
optional |
Numeric |
type = textfield |
| step |
If set, the step size of the spin buttons will differ (default is 1). |
optional |
Numeric |
type = textfield, min or max set |
