FrameBeurk documentation

4. Organisation

The diagram below represents the organisation of the different files on the server.

The 5 entry points, the interpreter, the .htaccess file for parameterizing the Apache server (if it is the one that is used).
The folder « modules » contains the bootstrap, the configuration file of the website, the DB communication layer, as well as a sub-folder for each installed module.
« ressources » contains the files that are requested by the browser. This folder must therefore be set to « allow » in the directives of the http server (unlike the other folders which can be set to « deny »).
« imports » contains the possible stand-alone php or html files (outside of modules), that will be included in the code of the html page before sending.
« patrons » contains a sub-folder for each installed template.

The configuration file of the module. It will be included in the configuration file of the website. It is the only mandatory file of the module.
The file for service functions of the module. A parameter in the module configuration sets up if this file has to be loaded by the bootstrap.
The helpers file. Helpers are shared functions that help to generate the html code.
The controllers brought along with the module.
The widgets to display specific divs.

The folder « _sql » contains the script(s) for generating in the data-base the objects needed for the smooth functioning of the module.
The folder « _js » contains the Javascript used by the module. The file has the .php type and is included in the entry point js.php. Before sending to the browser, it is interpreted especially to resolve the weaving of js functions.
The folder « _css » contains as many CSS files than styles handled by the module. Like for Javascript files, CSS files have the extension .php and will be interpreted before sending to the browser (entry point is css.php).
One folder for each entity type.

The helpers file contains the functions displaying Cards of the entity.
The modele file pools (if needed) the requests accessing the data-base for this entity.
The folder « Maj » contains one file for each Maj action of the entity.
The folder « Vue » contains one file for each Vue action of the entity.

The template file for the HTML code of a page sent by index.php.
Possibly in separate files, the header and trailer of the HTML template.
The template file for the HTML code of a Vue sent by ajax.php.
The template file for a RSS feed.
The folder « _css » contains one CSS file for each style described in the template, and if needed a file of PHP functions to generate specific CSS code (for example : buttons, images to encode in the CSS...).
The folder « _js » contains the Javascript that the browser needs to manage the page (regarding the items of the template).