Back to overview

Technical File Documentation

Help & Basics Published on 28.10.2025

This documentation provides an overview of the most important PHP and JavaScript files of the project, grouped by their functional area.


Core & Configuration

  • init.php: Heart of the application. Starts the session, loads configurations, checks login status and session timeout. Provides global functions like the multi-app setup (get_setup_path).
  • config.php: Global application settings (e.g., session timeout, rate limiting, multi-app constants).
  • configdb.php: Database credentials.
  • configmail.php: Configuration for email dispatch (SMTP).
  • security.php: Contains central security functions like CSRF protection.
  • language.php: Loads the language files and provides the lang() function.
  • languages/: Folder containing the language files (de.php, en.php, faq.de.php, etc.).

Database & Data Logic

  • dbfunctions.php: Central database layer. Encapsulates all database operations (read, write, delete) using PDO and prepared statements to prevent SQL injection. Also contains logic for duplicating tables.
  • sql_parser.php: Contains the logic to parse CREATE TABLE SQL statements and automatically create table definitions from them.

UI Components & Layout

  • menu.php: Renders the left sidebar navigation, including the dynamic list of user tables.
  • header.php: Renders the top header area with the page title and user menu.
  • footer.php: Renders the global footer at the bottom of the page.
  • uicomponents.php: Contains reusable UI functions, e.g., for pagination (render_pagination).
  • formcomponents.php: Provides functions for rendering standard form elements (render_form_group).
  • field_renderer.php: A specialized file that renders individual fields in the record form (custom_table_record_edit.php) based on their type (text, date, lookup, etc.).
  • layout_functions.php: Contains functions for rendering more complex layout parts, such as the record sidebar.
  • theme.php: Injects user-defined color settings (accent color, dark mode) into the page.
  • style.css: The central CSS file with all custom styles for the project.

Authentication & User Pages

  • login.php: Login page and processing of login credentials.
  • register.php: Registration page for new users.
  • logout.php: Ends the user session.
  • request_reset.php / reset_password.php: Workflow for resetting a password.
  • verify_2fa.php: Page for entering the two-factor authentication code.
  • userprofile.php: Page where users can edit their own profile (password, email, settings).
  • preferences.php: Page for managing personal settings.
  • help.php: The help page that displays this and other documentation.
  • sitemap.php: Generates an overview of all accessible pages.

Custom Table Engine (Core Module)

  • custom_table_view.php: Displays the data of a custom table. Contains the logic for list, card, kanban, and calendar views, as well as for filtering, searching, and sorting.
  • custom_table_record_edit.php: The form for creating and editing a record. Contains the validation and saving logic.
  • record_edit_attachments.php: Renders the section for linked "child" records.
  • record_edit_comments.php: Renders the comment section for a record.
  • lookup_modal_content.php: Generates the content for the selection modal in lookup fields.
  • print_record_view.php: Generates the standard print view for a single record.
  • print_custom_layout.php: Renders a custom print layout.

Administration

  • admin_customtables.php: Management of table definitions (overview).
  • admin_customtable_edit.php: Form for editing the structure of a table and its fields.
  • admin_views.php / admin_view_edit.php: Management of saved views.
  • admin_charts.php / admin_chart_edit.php: Management of charts.
  • admin_queries.php / admin_query_edit.php: Management of SQL queries.
  • admin_custom_buttons.php / admin_custom_button_edit.php: Management of custom buttons.
  • admin_custom_events.php / admin_custom_event_edit.php: Management of automated events.
  • admin_userlist.php / admin_user_edit.php: Central user management.
  • admin_usergroups.php, admin_usergroupmembers.php, admin_userrights.php: Management of the group-based rights system.
  • admin_valuelists.php: Management of team-specific value lists.
  • admin_useractions.php: Display of the activity log (audit log).

JavaScript

  • js/app.js: Contains global JavaScript that is loaded on all pages (e.g., sidebar logic, toasts).
  • js/dialog.js: Provides a promise-based, styled confirm() dialog alternative.
  • js/record_edit.js: Contains the specific JavaScript for the record edit page, e.g., for conditional visibility, Flatpickr initialization, and subtable logic.
  • js/toasts.js: Function for easily displaying Bootstrap toasts.

Setup-Specific Scripts

  • setup_adressen/initialisierung.php: An example of an application-specific script. It is executed on a user's first login and duplicates a table template ("addresses") for their team.