Plugins in die Homepage einbauen [Admidio-Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Plugins in die Homepage einbauen ======
===== Der Unterschied zwischen Plugins und Modulen =====

Plugins sind kleine Php-Scripte für bestimmte Aufgaben (z.B. nächsten 2 Termine anzeigen, aktuelle Geburtstage anzeigen ...). Sie müssen im Gegensatz zu Modulen aber nicht unbedingt als eigene Seite aufgerufen werden, sondern können in jede beliebige Html- oder Php-Seite eingebunden werden. Du kannst die Plugins auch in der body_top.php oder body_bottom.php von Admidio einbauen, so dass bestimmte Informationen auf allen Admidio-Seiten angezeigt werden.



===== Wie baue ich Plugins ein ? =====
Lade das Plugin aus [[de:plugins| unserem Pluginbereich]] herunter und entpacken die Zip-Datei. Kopiere das Verzeichnis mit den Dateien in den Ordner **adm_plugins** in euren Admidio-Ordner. Falls der Ordner adm_plugins noch nicht existiert, muss dieser zuerst noch erstellt werden. Dieser sollte sich auf derselben Ebene wie adm_my_files befinden.

==== Plugin in die Admidio 4 einbauen ====

Prüfe im ersten Schritt auf der Pluginseite die Installationsanleitung. Einige Plugins liefern ein eigenes Installationsscript und integrieren sich damit selbstständig in unser Menü. In diesem Fall sind dann keine weiteren Schritte notwendig.

Andere Plugins können sich mit einem kleinen HTML-Script auf der Übersichtsseite einbinden lassen. Dazu muss das entsprechende Script in die Template-Datei ''adm_themes/simple/templates/overview.tpl'' eingebunden werden.

Dort sind mehrere DIV-Blöcke hinterlegt und du musst hinter einem existierenden DIV-Block deinen neuen DIV-Block ergänzen. Die DIV-Blöcke sehen so aus: 
<code html><div class="col-sm-6 col-lg-4 col-xl-3">
    <div class="card admidio-roles" id="role_details_panel_'.$rolId.'">
        <div class="card-body" id="admRoleDetails'.$rolId.'">
            {load_admidio_plugin plugin="plugin-name" file="plugin-datei-name"}
        </div>
    </div>
</div></code>
Ersetze in diesem DIV-Block den **plugin-name** durch den Namen des Ordners deines Plugins und ersetze **plugin-datei-name** durch den Dateinamen der das Html-Script beinhaltet.

Willst du zum Beispiel das Plugin ''adm_plugins/calendar/calendar.php'' einbinden, so sieht der Code-Block anschließend so aus: 
<code html><div class="col-sm-6 col-lg-4 col-xl-3">
    <div class="card admidio-roles" id="role_details_panel_'.$rolId.'">
        <div class="card-body" id="admRoleDetails'.$rolId.'">
            {load_admidio_plugin plugin="calendar" file="calendar.php"}
        </div>
    </div>
</div></code>

Anschließend kannst du die Übersichtsseite neu laden und dein Plugin sollte sichtbar sein.


==== Plugin in die Admidio 3 einbauen ====

Der Einbau des Plugins innerhalb von Admidio ist sehr einfach. Gehe dazu idealerweise in die Datei **adm_themes/modern/my_body_bottom.php** und füge dort an der entsprechenden Stelle den folgenden Codeschnipsel hinzu:
<code php><?php include(ADMIDIO_PATH . FOLDER_PLUGINS . '/birthday/birthday.php'); ?></code>
Befindest du dich bereits innerhalb eines PHP-Teils der Seite, dann musst du nur folgenden Code hinzufügen: <code php>include(ADMIDIO_PATH . FOLDER_PLUGINS . '/birthday/birthday.php');</code>

Lade nun die Admidio-Seite neu und das Plugin sollte jetzt angezeigt werden.\\  
Seit Version 3.0 werden auch CSS-Dateien des Plugins automatisch geladen und müssen nicht separat aufgerufen werden.

==== Plugin außerhalb von Admidio-Seiten einbauen ====

Du kannst die Plugins in der Regel auch außerhalb der Admidio-Seiten nutzen und in deine eigenen HTML/PHP-Seiten einbinden. Allerdings sind hier ein paar zusätzliche Schritte notwendig.

Falls du das Plugin nun in eine reine Html-Seite einbinden möchtest, solltest du die Dateierweiterung der Seite zuerst von html in php umbenennen. Nun kannst du das Modul mit Hilfe von PHP in deine ehemals reine Html-Seite integrieren. Füge nun das Plugin (als Beispiel wird hier das Plugin //login_form// benutzt) mit einer der folgenden Methoden in deinen Html-Code an der Stelle ein, an der die Ausgabe des Plugins dargestellt werden soll:

1. Zuerst muss die Datei //common.php// **ganz am Anfang** deiner PHP-Datei über den Serverpfad eingebunden werden:

<code php><?php
  include_once($_SERVER['DOCUMENT_ROOT']. '/Pfad-zu-Admidio-Ordner /adm_program/system/common.php');
?></code>
Der //Pfad-zu-Admidio-Ordner// muss dabei die Ordnerstruktur beinhalten, die man von der Datei gehen muss, in der du das Plugin einbauen willst, bis zum Admidio-Ordner.

**Beispiel 1**
  FTP-Dateipfad in der das Plugin eingebaut werden soll:
  homepage/index.php
  
  FTP-Dateipfad zum Admidio-Ordner
  homepage/admidio/index.php
  
  Include-Befehl:
  include_once($_SERVER['DOCUMENT_ROOT']. '/admidio/adm_program/system/common.php');

**Beispiel 2**
  FTP-Dateipfad in der das Plugin eingebaut werden soll:
  homepage/index.php
  
  FTP-Dateipfad zum Admidio-Ordner
  admidio/index.php
  
  Include-Befehl:
  include_once($_SERVER['DOCUMENT_ROOT']. '/../admidio/adm_program/system/common.php');
  
2. Danach folgt der Einbau der Plugins an der gewünschten Stellen:

<code php><?php
  include($_SERVER['DOCUMENT_ROOT']. '/Pfad-zu-Admidio-Ordner /adm_plugins/login_form/login_form.php');
?></code>

3. Haben die vorherigen Varianten nicht zum Erfolg geführt kannst du die Plugins auch direkt über eine URL einbinden. Allerdings wird bei dieser Variante die common.php für jedes Plugin wiederholt abgearbeitet, was der Performance des Webservers nicht gerade dienlich ist.

<code php><?php
  include('http://www.example.org/Pfad-zu-Admidio /adm_plugins/login_form/login_form.php');
?></code>

4. Besitzt das Plugin eine CSS Datei so muss du diese auch in die Webseite integrieren. Dies muss zum einen innerhalb Admidio's in der **my_header.php** des ausgewählten Themeordners geschehen, als auch im Header deiner eigenen Seiten, falls du auch dort das Plugin anzeigen möchtest.

<code html><link rel="stylesheet" type="text/css" href="http://www.example.org/Pfad-zu-Admidio /adm_plugins/login_form/login_form.css" /></code>

===== Wo kann ich Plugins konfigurieren ? =====
Konfigurieren kannst du die meisten Plugins über eine **config.php** Datei. Dazu wird meistens eine **config_sample.php** Datei ausgeliefert, welche sich im Ordner des Plugins befinden sollte. Diese Datei kannst du dann einfach in **config.php** umbenennen. Hier stehen einige Variablen mit Default-Werten zur Verfügung. Diese kannst du nach euren Bedürfnissen anpassen.

Besitzt das Plugin eine eigene CSS Datei, kann über diese das Layout des Plugins angepasst werden.

Bei einem Update des Plugins brauchen und sollten diese beiden Dateien nicht überschrieben werden. Sind durch das Update neue Einstellungen oder CSS-Einstellungen hinzugekommen, so können die neuen Variablen bzw. CSS-Einstellungen, aus der **config_sample.php** in die bisherige Dateien (//config.php// und //pluginname.css//) des Plugins kopiert und die gewünschten Werte eingesetzt werden.

Ein Beispiel für eine Integration von mehreren Plugins in einer Seitenleiste siehst du auf diesem Screenshot im hervorgehobenen Bereich:

{{:de:2.0:documentation:plugins:plugins_show.png?400|Plugins einbauen}}

===== Wie aktualisiere ich ein Plugin ? =====
Steht ein Update an, sei es wegen einer Fehlerbehebung, einer neuen Funktion oder aufgrund einer Inkompatiblität zur aktuellen Admidio-Version, so kann einfach der Ordner des entsprechenden Plugins ausgetauscht werden. Lade dir dazu die aktuelle Version aus dem [[de:plugins:index|Pluginbereich]] herunter und ersetze den vorhandenen Pluginordner durch den neuen Ordner aus der Zip-Datei. Besonderheiten beim Update werden in der **readme.txt** im Pluginordner erwähnt.