|
14 | 14 | ** This file defines the admin panel of photobooth. The admin panel definition is done in a JSON variable and structured as follows |
15 | 15 | ** |
16 | 16 | ** Admin panel |
17 | | - ** |- Section 1 |
18 | | - ** | |- Parameter 1 |
19 | | - ** | |- Parameter 2 |
20 | | - ** | |- Setting A |
21 | | - ** | |- Setting B |
22 | | - ** | |
23 | | - ** |- Section 2 |
24 | | - ** | |- Setting C |
25 | | - ** | |- Setting D |
26 | | - ** | |- Setting E |
27 | | - ** | |
28 | | - ** |- Section 3 |
29 | | - ** | |- Parameter 1 |
30 | | - ** | |- ... |
31 | | - ** | |
32 | | - ** |... |
| 17 | + ** |- Section 1 |
| 18 | + ** | |- Parameter 1 |
| 19 | + ** | |- Parameter 2 |
| 20 | + ** | |- Setting A |
| 21 | + ** | |- Setting B |
| 22 | + ** | |
| 23 | + ** |- Section 2 |
| 24 | + ** | |- Setting C |
| 25 | + ** | |- Setting D |
| 26 | + ** | |- Setting E |
| 27 | + ** | |
| 28 | + ** |- Section 3 |
| 29 | + ** | |- Parameter 1 |
| 30 | + ** | |- ... |
| 31 | + ** | |
| 32 | + ** |... |
33 | 33 | ** |
34 | 34 | ** * Section descriptor |
35 | | - ** - Always key / array pair |
36 | | - ** * 'key': always starts with a character, consists of characters, numbers and underscore only |
37 | | - ** - Admin panel sort order is defined by the order in this config file |
38 | | - ** - The i18n tag for translation is identified by the actual section key |
39 | | - ** - Parameter: Key / Value pairs are parameters which apply to how the section is displayed in the admin panel |
40 | | - ** * 'view' (optional): Accepted values are 'basic', 'advanced' or 'expert'. Defines in which admin panel view mode |
41 | | - ** the section is shown or not. Missing parameter defaults to 'expert'. |
42 | | - ** * 'platform' (optional): Accepted values are 'all', 'linux', 'windows'. Defines whether the section is visible |
43 | | - ** by platform. Missing parameter defaults to 'all' |
44 | | - ** - Settings: Key / Array pairs define a setting (see next) |
| 35 | + ** - Always key / array pair |
| 36 | + ** * 'key': always starts with a character, consists of characters, numbers and underscore only |
| 37 | + ** - Admin panel sort order is defined by the order in this config file |
| 38 | + ** - The i18n tag for translation is identified by the actual section key |
| 39 | + ** - Parameter: Key / Value pairs are parameters which apply to how the section is displayed in the admin panel |
| 40 | + ** * 'view' (optional): Accepted values are 'basic', 'advanced' or 'expert'. Defines in which admin panel view mode |
| 41 | + ** the section is shown or not. Missing parameter defaults to 'expert'. |
| 42 | + ** * 'platform' (optional): Accepted values are 'all', 'linux', 'windows'. Defines whether the section is visible |
| 43 | + ** by platform. Missing parameter defaults to 'all' |
| 44 | + ** - Settings: Key / Array pairs define a setting (see next) |
45 | 45 | ** |
46 | 46 | ** * Settings descriptor |
47 | | - ** - Is a key / array pair where the key string is distinct across the entire admin panel. Even with different sections, no |
48 | | - ** duplicate setting keys are allowed across the file. |
49 | | - ** * 'key': always starts with a character, consists of characters, numbers and underscore only |
50 | | - ** - Admin panel sort order is defined by the order in this config file |
51 | | - ** - The i18n tag for translation is identified by concatenation of section key, ':', setting key. Tags for manual entries |
52 | | - ** start with "manual:" |
53 | | - ** Examples: |
54 | | - ** "general:ui_language" |
55 | | - ** "user_interface:button_show_fs" |
56 | | - ** "manual:print:print_from_result" |
| 47 | + ** - Is a key / array pair where the key string is distinct across the entire admin panel. Even with different sections, no |
| 48 | + ** duplicate setting keys are allowed across the file. |
| 49 | + ** * 'key': always starts with a character, consists of characters, numbers and underscore only |
| 50 | + ** - Admin panel sort order is defined by the order in this config file |
| 51 | + ** - The i18n tag for translation is identified by concatenation of section key, ':', setting key. Tags for manual entries |
| 52 | + ** start with "manual:" |
| 53 | + ** Examples: |
| 54 | + ** "general:ui_language" |
| 55 | + ** "user_interface:button_show_fs" |
| 56 | + ** "manual:print:print_from_result" |
57 | 57 | ** |
58 | | - ** - Parameter: Can be key/value or key/array pairs. Sort order does not matter. |
59 | | - ** * 'view' (optional): Accepted values are 'basic', 'advanced' or 'expert'. Defines in which admin panel view mode |
60 | | - ** the section is shown or not. Missing parameter defaults to 'expert'. |
61 | | - ** * 'name': Matches the name of the config variable or array. For type 'button' this has no effect. |
62 | | - ** * 'data-theme-field' |
63 | | - ** * 'type': Values are 'input', 'number', 'range', 'color', 'hidden', 'checkbox', 'multi-select', 'select', 'button'. Defines the actual |
64 | | - ** input type in the admin panel for this setting. |
65 | | - ** * 'value': Value is a reference to the actual PB config (i.e. 'value' => $config['dev']['reload_on_error']) and pre- |
66 | | - ** populates the current config value into the admin panel |
67 | | - ** Exceptionally, for type 'button' this is the HTML element ID applied to the actual button itself. |
68 | | - ** * 'placeholder': For types 'input', 'range', 'color' to prepopulate / preset the admin panel setting entry |
69 | | - ** field / range selector. Often references the default config for this setting |
70 | | - ** (i.e 'placeholder' => $defaultConfig['picture']['time_to_live']) |
71 | | - ** For type 'button' this is the i18ntag string for the actual button text. |
72 | | - ** * 'option': Only for types 'select','multi-select'. Lists the options available in this setting (i.e. |
73 | | - ** 'options' => [ |
74 | | - ** '360px' => 'XS', |
75 | | - ** '540px' => 'S', |
76 | | - ** ]) |
77 | | - ** * 'range_min', 'range_max', 'range_step': Only for type 'range'. Define the slider range and step when moved |
78 | | - ** * 'unit': Only for type 'range'. Defines the unit of the slider and is used to identify the i18n tag for translation of the unit |
| 58 | + ** - Parameter: Can be key/value or key/array pairs. Sort order does not matter. |
| 59 | + ** * 'view' (optional): Accepted values are 'basic', 'advanced' or 'expert'. Defines in which admin panel view mode |
| 60 | + ** the section is shown or not. Missing parameter defaults to 'expert'. |
| 61 | + ** * 'name': Matches the name of the config variable or array. For type 'button' this has no effect. |
| 62 | + ** * 'data-theme-field' |
| 63 | + ** * 'type': Values are 'input', 'number', 'range', 'color', 'hidden', 'checkbox', 'multi-select', 'select', 'button'. Defines the actual |
| 64 | + ** input type in the admin panel for this setting. |
| 65 | + ** * 'value': Value is a reference to the actual PB config (i.e. 'value' => $config['dev']['reload_on_error']) and pre- |
| 66 | + ** populates the current config value into the admin panel |
| 67 | + ** Exceptionally, for type 'button' this is the HTML element ID applied to the actual button itself. |
| 68 | + ** * 'placeholder': For types 'input', 'range', 'color' to prepopulate / preset the admin panel setting entry |
| 69 | + ** field / range selector. Often references the default config for this setting |
| 70 | + ** (i.e 'placeholder' => $defaultConfig['picture']['time_to_live']) |
| 71 | + ** For type 'button' this is the i18ntag string for the actual button text. |
| 72 | + ** * 'option': Only for types 'select','multi-select'. Lists the options available in this setting (i.e. |
| 73 | + ** 'options' => [ |
| 74 | + ** '360px' => 'XS', |
| 75 | + ** '540px' => 'S', |
| 76 | + ** ] |
| 77 | + ** * 'range_min', 'range_max', 'range_step': Only for type 'range'. Define the slider range and step when moved |
| 78 | + ** * 'unit': Only for type 'range'. Defines the unit of the slider and is used to identify the i18n tag for translation of the unit |
79 | 79 | */ |
80 | 80 |
|
81 | 81 | $configurationService = ConfigurationService::getInstance(); |
|
0 commit comments