1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
The baseconfig module (configuration variables) is now modularized in two
ways.
1) The definition of configuration variables has moved from the database to
dedicated .json files, which can be defined by one or multiple additional
modules. This means the database table "settings" is no longer in use.
As an example, see the module "baseconfig_bwlp".
If you only enable the module "baseconfig", you will find that visiting
the "configuration variables" menu entry in slx-admin shows a pretty empty
page. However, if you additionally enable the baseconfig_bwlp module, many
configuration variables will be shown.
baseconfig_bwlp doesn't contain any page.inc.php, as its sole purpose is
to supply wanted configuration variables. This is achieved by supplying
two .json files.
./modules/<module>/baseconfig/categories.json: Defines categories for
configuration variables. Syntax is <id>:<sort-order>
./modules/<module>/baseconfig/settings.json: Defines configuration variables
to be shown by the baseconfig page. This has taken the place of the settings
table from the database and contains pretty much the same information.
Note that you can have multiple modules that supply categories.json or
settings.json files. They will all be honored by the baseconfig module.
To be able to supply translations for the config variables and categories
defined by baseconfig_bwlp (or any other addon), you need to do two things:
- Create config.json with baseconfig as dependency
- Add the hooks/translation.inc.php file as seen in baseconfig_bwlp so the
translation module knows how to handle the translations
(Alternatively, you can manually edit the translation files, in which case
you don't need config.json and the translation hook)
2) You can hook into the baseconfig API mechanism (previously known as
the "getconfig" API) which creates the plain text output intended for
the clients. This way you can create more sophisticated output logic, or
simply have a nicer guy for some values you want to generate.
To hook into the API, you need a hook:
./modules/<module>/baseconfig/getconfig.inc.php
This code will run directly in the context of the baseconfig API request,
so you write code straight away that should add any configuration variables
to the associative array called $configVars, e.g.
$configVars['SLX_FOO'] = 'bar';
These values can be static, or queried from anywhere in the database, etc.
For an example of this, see the module "baseconfig_partitions_cdn"
Which is basically a normal slx-admin module with a GUI for creating a
partitioning config that get stored in the database.
It also contains the .../baseconfig/getconfig.inc.php hook that adds
the partition configuration to the output of the baseconfig API.
|
