Admidio-Wiki2 en:entwickler

Installing changes to the database

Anonymous (anonymous@undisclosed.example.com) — 2021-11-15T14:24:48+00:00

Installing changes to the database Where do I build the changes in the source code? Changes in the database structure must be installed at two locations. Once the installation script, which sets up the database for new installations and, secondly, the update script, which adapts existing databases with the new features.

How Admidio's Changelog Works and Instructions for Implementations

Anonymous (anonymous@undisclosed.example.com) — 2025-03-21T08:55:28+00:00

How Admidio's Changelog Works and Instructions for Implementations Introduction Starting with Admidio 5.0, all changes to objects (Users, Events, Groups/Roles, Weblinks, Albums, Folders/Files, ...) and settings that are saved in Admidio's database can be logged and the changes displayed in the Change History screen. Logging can be enabled per object type (=database table) in the preferences. Each object or list with changelogs enabled will display a changelog button to view it:

Changes to functions and methods

Anonymous (anonymous@undisclosed.example.com) — 2022-04-15T20:11:05+00:00

Changes to functions and methods With this page we want to help plugin developers to stay compatible with the changes that were made in the Admidio core and that could affect plugins. During the development of Admidio we try to not change our existing methods and functions but sometimes it's necessary and could break your working plugin. Here you will find a list of methods and functions that we changed in a specific Admidio version with a notice how you could fix this in your plugin if you hav…

Database Access Class

Anonymous (anonymous@undisclosed.example.com) — 2016-12-03T15:13:18+00:00

Database Access Class Since version 2.0, there is now a class for database access. This class is similar to the table access classes of 2 parts. One general class DB and the respective extension, in our case MySqlDb. Advantage of this new class is as a unified error handling. If an error occurs in the SQL statement, so a nicely formatted error message is now displayed automatically and must no longer, as before, the function

Set up a developement environment

Anonymous (anonymous@undisclosed.example.com) — 2024-12-01T07:13:19+00:00

Set up a developement environment Where can I find the source code? We develop Admidio using the version management Git on the platform GitHub. The current source code is located in the Master Branch and can be found via the following link: https://github.com/Admidio/admidio

How to make your plugin translatable

Anonymous (anonymous@undisclosed.example.com) — 2019-08-01T08:29:08+00:00

How to make your plugin translatable Create an xml file with your strings Admidio uses for translations the Android string resource. This is a very compact xml format that should contain every string you use in your plugin. The format looks like this: Your string

Developer Area

Anonymous (anonymous@undisclosed.example.com) — 2026-04-11T18:36:12+00:00

Developer Area In this section you will find useful information about the development of Admidio. The informations should help developers, but also people who want to make their own enhancements to Admidio. If you want to support Admidio you can help us in

Make your plugin compatible to Admidio 4

Anonymous (anonymous@undisclosed.example.com) — 2021-01-05T14:15:28+00:00

Make your plugin compatible to Admidio 4 New menu calls In Admidio 4 we have changed the way the menu is structured. For this you have to change your plugin if you have worked with $page->getMenu(); before. Now you don't have to create an instance of the menu to add the single entries there. Also there is now a simple function to add a back button to the page.

Make your plugin compatible to Admidio 5

Anonymous (anonymous@undisclosed.example.com) — 2025-04-03T21:05:56+00:00

Make your plugin compatible to Admidio 5 Using Bootstrap 5 Admidio 5 uses Bootstrap 5. So therefore you have to convert your Bootstrap customizations to Bootstrap 5. View Migration document of Bootstrap 5. Changes to HtmlForm The entry list of the parameter $options

Multilingualism

Anonymous (anonymous@undisclosed.example.com) — 2018-06-17T07:47:45+00:00

Multilingualism With version 2.2 Admidio supports multiple languages. For this purpose, all the texts were stored in an XML file in adm_program/languages with the respective language abbreviations as the filename. The language can be selected in the

Message class for note texts

Anonymous (anonymous@undisclosed.example.com) — 2016-12-03T15:06:11+00:00

Message class for note texts Using the Class Message in message.php Note texts can be created. With this new class err_msg.php is to be replaced. Advantages of the new class: * simple call (not on location) * Any number of variables can be set in the text

Navigation across multiple pages

Anonymous (anonymous@undisclosed.example.com) — 2016-12-03T15:04:07+00:00

Navigation across multiple pages To navigate back to the sides within a module of which the user has come, you have to remember the appropriate page views to fall back later on this information. This is done with the Class Navigation (navigation.php

Install new organizational settings

Anonymous (anonymous@undisclosed.example.com) — 2016-12-03T15:00:20+00:00

Install new organizational settings Quite often it can happen that you need new settings for specific modules. These are then usually maintained in the organization settings. In order to add new settings will not become too laboriously, we have developed a mechanism by which this works relatively quickly.

Settings

Anonymous (anonymous@undisclosed.example.com) — 2015-10-30T20:19:14+00:00

Settings Preamble PHP offers the ability to configure many things about its configuration file php.ini. Some settings will help in the development, other settings should be set in order to prevent problems for the user in advance, where this adjustment was possibly set by Hoster.

PHP-Settings for developement environment

Anonymous (anonymous@undisclosed.example.com) — 2019-07-11T09:33:17+00:00

PHP-Settings for developement environment Preamble PHP offers the ability to configure many things about its configuration file php.ini. Some settings will help in the development, other settings should be set in order to prevent problems for the user in advance, where this adjustment was possibly set by Hoster.

Plugin Manager

Anonymous (anonymous@undisclosed.example.com) — 2026-02-08T12:14:42+00:00

Plugin Manager The Plugin Manager module provides a simple user interface and standardized procedures for * installing, * uninstalling, * updating, * managing and * integrating plugins in Admidio. With the Plugin Manager it is now also possible to easily and quickly integrate your own custom overview plugins.

Coding Guidelines

Anonymous (anonymous@undisclosed.example.com) — 2021-11-15T14:28:59+00:00

Coding Guidelines Preamble Hello dear friends of Admidio! This document should help to generate clean code, comprehensible to other people. The points listed here are merely to be understood as implementation proposals. If in doubt, you should just turn your mind and think about whether this is all really so clear, as has been imagined.

Sessionhandling

Anonymous (anonymous@undisclosed.example.com) — 2016-12-03T15:00:53+00:00

Sessionhandling Since version 2.0, the session handling has been revised. There is now a Session class (derived from Table Access) of which a global object $gCurrentSession is applied calling scripts each time. An important difference to previous handling is that now every visitor gets a session entry in the session table. In addition, we now offer that an user can be entered multiple times in the session table, which means that you can log in to different systems or browsers several times.

Developer area

Anonymous (anonymous@undisclosed.example.com) — 2025-03-09T11:21:12+00:00

Developer area Common * Coding Guidelines * Set up a test environment * PHP-Settings for developement environment * Set up a developement environment * Translation * Publish new Version Developing with PHP * Documentation of classes and functions * Sourcecode-Documentation * Checking of passed variables * Multilingualism * Install new organizational settings * Sessionhandling * Forms - Create, validate and save * Navigation across multiple pages * Message class …

Sourcecode-Documentation

Anonymous (anonymous@undisclosed.example.com) — 2016-12-03T14:53:24+00:00

Sourcecode-Documentation Doxygen The documentation of our classes and functions should be done withDoxygen. This program creates a structured HTML documentation within the comment section of the source code using keywords. The documentation can also be downloaded offline access also

SQL-Injection

Anonymous (anonymous@undisclosed.example.com) — 2016-12-03T15:13:56+00:00

SQL-Injection With SQL Injection, the point is that you try on forms or URLs, through specific inputs, the original SQL statement, which processes the input, overturn and execute modified SQL code. Example at login: I enter the following username:

What methods are available?

Anonymous (anonymous@undisclosed.example.com) — 2016-12-03T15:11:48+00:00

What methods are available? The following methods are available within the Table Access class and can be extended by derived classes: * readData reads out the corresponding record from the database. With special deliveries the SQL statement can still be changed. (Eg.: roles_class.php)

Set up a test environment

Anonymous (anonymous@undisclosed.example.com) — 2025-10-09T17:57:20+00:00

Set up a test environment Local web server set up Admidio requires a web server with PHP support and a MySQL/MariaDB or PostgreSQL database. This is already done usually set up on the web space. For developing it is advisable to set up a web server along with PHP and MySQL locally. There are available for Windows and Linux, the

Checking of passed variables

Anonymous (anonymous@undisclosed.example.com) — 2016-12-03T14:57:17+00:00

Checking of passed variables Passing to PHP scripts can be easily manipulated by attackers. For this purpose, only the URL must be manipulated in accordance with the variable in the browser. For this reason it is very important that all passed variables are tested prior to use in the script to appropriate values.

Translation

Anonymous (anonymous@undisclosed.example.com) — 2023-07-16T10:51:01+00:00

Translation Admidio use separated language texts within the code that are added in separate XML files. Thus a translation become relatively easy and we look forward to any other language in which we can offer Admidio. Within the translation files we use the xml format of

Publish new Version

Anonymous (anonymous@undisclosed.example.com) — 2015-10-30T22:38:29+00:00

Publish new Version The following things are to be done in a version update: * All changes must be checked in * Version number in constant.php must be updated * Filter all closed Milestones on GitHub Issues * Copy the list of GitHub Issues in a text editor, remove additional information and categorize the individual points (General, appointments, guestbook

Where and how can I help?

Anonymous (anonymous@undisclosed.example.com) — 2023-02-27T08:30:24+00:00

Where and how can I help? Help we can use in many areas. This can range from useful information and assistance in the Forum until the programming of new functions. Recommend Admidio Are you satisfied with Admidio, so the easiest way is to help us to recommend Admidio. This can be done in different ways. Show in the different social networks (links at bottom of page) that you like Admidio. So you not only spread Admidio but also remains up to date, if there are new features or plug-ins. In ad…