Geburtstagsliste [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.
====== Geburtstagsliste ======

==== Beschreibung ====
Dieses Plugin erzeugt für einen bestimmten Zeitraum eine Geburtstags- und Jubiläumsliste der Mitglieder.


==== Downloads ====
[[https://www.admidio.org/intern/adm_program/modules/downloads/get_file.php?file_id=191|geburtstagsliste_2.3.0.zip]] - **(Admidio 3.3)** 


Ältere Versionen:\\ 
[[https://www.admidio.org/intern/adm_program/modules/downloads/get_file.php?file_id=180|geburtstagsliste_2.2.2.zip]] - (Admidio 3.2)\\ 
[[https://www.admidio.org/intern/adm_program/modules/downloads/get_file.php?file_id=155|geburtstagsliste_2.1.1.zip]] - (Admidio 3.1)\\ 
[[https://www.admidio.org/intern/adm_program/modules/downloads/get_file.php?file_id=53|geburtstagsliste_2.0.2.zip]] - (Admidio 3.0)\\ 
[[https://www.admidio.org/intern/adm_program/modules/downloads/get_file.php?file_id=56|geburtstagsliste_1.3.5.zip]] - (Admidio 2.4)

==== Informationen ====
Betreut von: **[[https://www.admidio.org/forum/memberlist.php?mode=viewprofile&u=1506|rmb]] **\\ 

Plugin-Version:     **2.2.2**\\ 

Notwendige Admidio-Version:  **3.2**\\ 

Unterstützte Datenbanken:  **MySQL**\\ 

Unterstützte Sprachen: **Deutsch (du), Deutsch (Sie), Englisch**

Lizenz: **GPL 2**

Sourcecode: [[https://github.com/rmbinder/Geburtstagsliste.git|GitHub]]
 
==== Screenshots ====
{{:de:plugins:geburtstagsliste:screenshot_01.png?300|}}  

==== Installation ====
  * Im Ordner adm_plugins einen neuen Ordner mit dem Namen geburtstagsliste erstellen
  * Danach alle Dateien (und Ordner) des Ordners geburtstagsliste aus der entpackten Zip-Datei in diesen Ordner kopieren.
  * Zuletzt noch den Link zum Plugin in die Datei my_body_bottom.php einfügen.

^Hier gibt es zwei verschiedene Möglichkeiten:^^
|Soll der Link zu Geburtstagsliste im vorhandenen Module-Menü angezeigt werden:|Soll der Link zu Geburtstagsliste in einem eigenen Plugins-Menü angezeigt werden:|
|  {{:de:plugins:geburtstagsliste:link-in-menue-module.png?150}}  |  {{:de:plugins:geburtstagsliste:link-in-menue-plugins.png?150}}  |
|Dann DIREKT VOR der vorhandenen Anweisung "echo $moduleMenu->show();" diese Zeile einfügen:|Dann diese Zeilen einfügen (falls noch nicht vorhanden):|
|include(ADMIDIO_PATH . FOLDER_PLUGINS . '/geburtstagsliste/geburtstagsliste.php');|$pluginMenu = new Menu('plugins', 'Plugins');|
|:::|include(ADMIDIO_PATH . FOLDER_PLUGINS . '/geburtstagsliste/geburtstagsliste.php');|
|:::|echo $pluginMenu->show();|

 
==== Update ====
  * Zuerst alle Dateien im Pluginverzeichnis von Geburtstagsliste löschen.
  * Danach alle Dateien (und Ordner) des Ordners geburtstagsliste aus der entpackten Zip-Datei in das Pluginverzeichnis kopieren.

==== Änderungshistorie ====
//2.2.2 (04.12.2017)//
  * [[https://github.com/rmbinder/Geburtstagsliste/issues?q=milestone%3Av2.2.2|Alle Änderungen dieser Version auf GitHub]]

//2.2.1 (05.05.2017)//
  * [[https://github.com/rmbinder/Geburtstagsliste/issues?q=milestone%3Av2.2.1|Alle Änderungen dieser Version auf GitHub]]

//2.2.0 (19.12.2016)//
  * Kompatibilität mit Admidio 3.2
  * [[https://github.com/rmbinder/Geburtstagsliste/issues?q=milestone%3Av2.2.0|Alle weiteren Änderungen dieser Version auf GitHub]]

//2.1.1 (08.06.2016)//
  * [[https://github.com/rmbinder/Geburtstagsliste/issues?q=milestone%3Av2.1.1|Alle Änderungen dieser Version auf GitHub]]

//2.1.0 (15.02.2016)//
  * Kompatibilität mit Admidio 3.1
  * Link zur Dokumentation geändert

//2.0.2 (09.12.2015)//
  * Jahresversatz integriert (Wunsch von red)
  * Fehler in der Datumsberechnung behoben (Kalenderjahr in Verbindung mit negativen Vorschautagen)   

//2.0.1 (02.11.2015)//
  * Fehler (verursacht durch die Methode addHeadline) behoben

//2.0.0 (26.05.2015)//
  * Anpassung an Admidio 3.0
  * Deinstallationsroutine erstellt
  * Verfahren zum Einbinden des Plugins (include) geändert 
  * Berechnungsalgorithmus umgestellt (dadurch unbegrenzte Vorschau von Tagen möglich)
  * Menübezeichnungen angepasst (gleichlautend mit anderen Plugins) 
  * Nur Intern: Verwaltung der Konfigurationsdaten geändert

//1.3.5 (05.11.2014)//
  * Für den Export sind diverse Parameter jetzt im Setup einstellbar
  * Bei Namensgleichheit von Profilfeldern wird die Kategorie in Klammern angehängt
  * Die Option Kalenderjahr kann für jede Konfiguration separat eingestellt werden

//1.3.4 (15.05.2014)//
  * Fehler ...indefined index:...beim ersten Aufruf des Plugins behoben
  * Default-Einstellungen um zusätzliche Einträge ergänzt
  * Aufruf des Plugins über die Klasse Menu realisiert (Systemanforderung jetzt Admidio Version 2.4.4 oder höher)
  * Anpassung von Menübezeichnungen
  * E-Mail-Texte für jede Konfiguration (Fokus) separat definierbar

//1.3.3 (09.01.2014)//
  * Fehler ...indefined index:...language.php line 272... behoben
  * Vorschautage kleiner 10 benötigen keine führende Null mehr
  * negative Werte für die Vorschau möglich

//1.3.2 (21.11.2013)//
  * Kompatibilität zu PHP 5.4

//1.3.1 (12.11.2013)//
  * Default-Einstellung für Fokus
  * Diverse Überprüfungen eingearbeitet
  * Anzeigemodus überarbeitet
  * E-Mail-Modul eingearbeitet
  * Die Konfigurationen können auf bestimmte Rollen und/oder Kategorien einschränkt werden  

//1.3.0 (01.04.2013)//
  * Anpassung an Admidio 2.4
  * Konfigurationsdaten werden nicht mehr in einer config.ini gespeichert, sondern in der Admidio Datenbank abgelegt
  * Das Menü Einstellungen kann separat über Berechtigungen angezeigt werden
  * Aufgrund eines Wunsches im Forum kann der Beginn der Anzeige auf den 1. Januar gesetzt werden (Kalenderjahr)
  * E-Mail-Adressen werden mit einem Link versehen (DieterB)
  * Englische Sprachdatei erstellt
  * Die Default-Einstellung der Pluginfreigabe wurde erweitert um die Rolle Mitglied

//1.2.3 (26.12.2012)//
  * Alle Einstellungen sind menuegesteuert veraenderbar  
  * Eine deutsche Sprachdatei wurde erstellt
  * Das Plugin ist für mehrere Organisationen geeeignet
  * Ein Fehler in der Berechnung des Zeitraumes wurde behoben (Für den Zeitraum...) 

//1.2.2 (01.03.2012)//
  * Jubiläen können angezeigt werden 
  * Die Jahre für die Jubliläen und runden Geburtstage können in der config.php definiert werden 
  * Die Spaltenüberschriften für Jubiläen und runde Geburtstage sind frei definierbar   
  * Das Suffix in der Anzeige von Jubiläen und runden Geburtstagen ist frei definierbar  

//1.2.1 (23.02.2012)//
  * Über ein Pulldownmenü kann direkt ein bestimmter Monat gewählt werden 
  * Das Jahr des Geburtsdatums kann angezeigt werden 
  * Runde Geburtstage können angezeigt werden   
           
//1.2.0 (21.02.2012)//
  * Das Plugin ist jetzt Admidio 2.3 kompatibel 
 
//1.1.2 (08.12.2011)//
  * Das Standard-Datenbankpräfix (adm_) ist nicht mehr fest kodiert

//1.1.1 (21.11.2011)//
  * Bei Mitgliedern ohne Geburtsdatum wurde der 01.01. eingetragen, dies wurde korrigiert. Mitglieder ohne Geburtsdatum werden nicht mehr in der Liste aufgeführt. 
  * Die Einschränkung in einer Abfrage in geburtstagsliste_show.php, auf nur Mitglieder der Rolle "Mitglied" wurde aufgehoben. 
  * Die Default-Einstellung für die Vorschautage kann jetzt in der config.php definiert werden.  
  * Beim Export wurden die Vorschautage nicht aktualisiert. 
  * Die Einträge im Pulldownmenü "Anzahl der Vorschautage..." können jetzt in der config.php definiert werden  
  * Die Berechtigung das Plugin aufzurufen, wurde um Rollenmitgliedschaften erweitert.

//1.1.0 (26.10.2011)//
  * Für das Plugin wurde eine Weboberfläche erstellt.
  * Die erzeugte CSV-Datei wird nicht mehr auf dem Server zwischengespeichert, sie wird in der Listenansicht zum Download angeboten. Das zusätzliche Plugin downloadfile.php wird nicht mehr benötigt.        

//1.0.0 (11.07.2011)//

==== Funktionsweise ====
Dieses Plugin erzeugt Geburtstags- und Jubiläumslisten von Mitgliedern. Über den Menüpunkt //Einstellungen-Konfigurationen// können beliebig viele, unterschiedliche Konfigurationen angelegt werden.

In einer Konfiguration werden 
  * die anzuzeigenden Spalten (=Profilfelder), 
  * zu welchem Bezugstag diese Konfiguration angezeigt wird (der aktuelle Tag oder der 01.01.), 
  * Filterungen zum Datum (runde Geburtstage oder Jubiläen)
  * oder auch Filterungen aufgrund von Rollenzugehörigkeiten
festgelegt. 

Muster einer Geburtstagsliste:\\
{{:de:plugins:geburtstagsliste:musteranzeige.png?300|}}

Mit "Konfiguration wählen..." wird eine vorher definierte Konfiguration als Basis der Anzeige bestimmt.\\
{{:de:plugins:geburtstagsliste:konfiguration-waehlen.png?300|}}

Nach der Wahl der Konfiguration wird ausgewählt, wieviele Tage (Vorschautage) angezeigt werden sollen.\\
{{:de:plugins:geburtstagsliste:vorschautage-waehlen.png?300|}}

//Hinweis:// 
Vorschautage werden immer in Relation zu einem Bezugstag gesehen. Als Bezugstag kann entweder das aktuelle Datum oder der 1. Januar eines Jahres gewählt werden. 

Damit zukünftige und auch vergangene Geburtstage und Jubiläen angezeigt werden können, wurde folgende Festlegung getroffen:
  * Sollen Geburtstage und Jubiläen nur am Bezugstag (aktueller Tag oder der 01.01.) angezeigt werden, so ist als Vorschautage "0" zu wählen.
  * Sollen zukünftige Geburtstage und Jubiläen angezeigt werden, so ist als Vorschautage die Anzahl der zusätzlichen Tage zu wählen (z.B. "1" für den aktuellen Tag plus einen Tag zusätzlich, ⇒ heute und morgen).
  * Sollen vergangene Geburtstage und Jubiläen angezeigt werden, so ist als Vorschautage eine negative Anzahl von Tagen zu wählen (z.B. "-1" für den aktuellen Tag minus einen Tag in die Vergangenheit, ⇒ gestern und heute).
 
{{:de:plugins:geburtstagsliste:vorschautage-gewaehlt-0.png?300|}}
{{:de:plugins:geburtstagsliste:vorschautage-gewaehlt-1.png?300|}}

Zusätzlich zu Vorschautagen kann ein bestimmter Monat gewählt werden.\\
{{:de:plugins:geburtstagsliste:monat-waehlen.png?300|}}

Dies ist eine nochmalige Filterung der bereits bestehenden Liste.\\
{{:de:plugins:geburtstagsliste:monat-gewaehlt-august.png?300|}}

=== Menü Einstellungen ===
Das Menü **Einstellungen** ist über den Link Einstellungen, oben im Menü der Listenansicht anwählbar. Es ist in vier Menüpunkte unterteilt.

  * Konfigurationen
  * Optionen
  * Pluginfreigabe
  * Plugininformationen

{{:de:plugins:geburtstagsliste:standardansicht-einstellungen.png?300}}
{{:de:plugins:geburtstagsliste:menue-einstellungen.png?300}}

=== Menüpunkt Konfigurationen ===
Hier können beliebig viele Konfigurationen für die Geburtstagsliste erstellt werden. In der Listenansicht wird jeweils eine dieser Konfigurationen über "Konfiguration wählen..." als Grundlage der Anzeige verwendet. 

Nach einer Neuinstallation ist eine Beispielkonfigurationen voreingestellt und mit Standardwerten befüllt.\\
|  {{:de:plugins:geburtstagsliste:beispielkonfiguration-konfiguration1.png?300}}{{:de:plugins:geburtstagsliste:beispielkonfiguration-konfiguration2.png?300}}  |    {{:de:plugins:geburtstagsliste:beispielkonfiguration-anzeige.png?300}}   |
|  Konfiguration  |   Anzeige   |

== Bezeichnung ==
Die hier eingetragende Bezeichnung erscheint in der Bildschirmanzeige im Auswahlmenü "Konfiguration wählen...". Gelöscht werden kann eine Konfiguration, indem man den Inhalt des Feldes Bezeichnung löscht und anschließend den Speichern-Button betätigt.\\
{{:de:plugins:geburtstagsliste:konfiguration-bezeichnung.png?400|}}

== Spaltenauswahl ==
Hier werden die Profilfelder ausgewählt, die in dieser Konfiguration als Spalten in der Listenansicht angezeigt werden sollen.\\
{{:de:plugins:geburtstagsliste:konfiguration-spaltenauswahl.png?400|}}

== Prüfdatum ==
Prüfdatum ist das für die Berechnungen verwendete Datumsfeld (Entweder ein Profilfeld vom Typ "Datum" oder bei Wahl einer Rolle, der Beginn der Rollenmitgliedschaft)\\
{{:de:plugins:geburtstagsliste:konfiguration-pruefdatum.png?400|}}

== Werte ==
Über Werte kann die Anzeige auf bestimmte Werte gefiltert werden. 30,40,50 bedeutet z.B., dass nur 30., 40. oder 50. Geburtstage oder Jubiläen angezeigt werden. Soll nicht gefiltert werden, so ist das Feld leer zu lassen.\\
{{:de:plugins:geburtstagsliste:konfiguration-werte.png?400|}}

== Ergänzungstext ==
Der angegebene Text wird an das Lebensjahr oder Jubiläum angehängt.\\
{{:de:plugins:geburtstagsliste:konfiguration-ergaenzungstext.png?400|}}

Der Ergänzungstext "ster Geburtstag am #Day#.#Month#" könnte z.B. angezeigt werden als "30ster Geburtstag am 10.02.".

//Platzhalter://
  * #Day# = Tag
  * #Month# = Monat
  * #Year# = Jahr

//Hinweis://
  * Um den Ergänzungstext mit einem Leerzeichen beginnen zu lassen muss dieses als geschütztes Leerzeichen mit dem Code &nbsp; (z.B. &nbsp;ster Geburtstag am #Day#.#Month#) angegeben werden.

== Rollenwahl/Kategoriewahl ==
Über Rollen- und Kategoriewahl kann eine Konfiguration auf die Angehörigen der gewählten Rollen bzw. auf die Angehörigen von Rollen der gewählten Kategorien eingeschränkt werden.

Soll keine Einschränkung erfolgen, so sind beide Felder (Rollenwahl und Kategoriewahl) leer zu lassen.

== E-Mail-Vorlage ==
Hier kann der Text für eine E-Mail angepasst und ergänzt werden. Der Text ist in zwei Bereiche (Betreff & Inhalt) unterteilt und wird durch die Zeichenfolge #subject# und #content# identifiziert. Danach folgt dann der Inhalt für den Bereich. In jeder Mail können Platzhalter benutzt werden, welche dann zur Laufzeit durch die entsprechenden Inhalte ersetzt werden.

WICHTIG: Zum Versenden von Mails muss das Profilfeld E-Mail in einer Spalte angezeigt werden.

//Platzhalter://
  * #user_first_name# = Vorname des Mitglieds
  * #user_last_name# = Nachname des Mitglieds
  * #organization_long_name# = Name der Organisation
  * #config# = Text der letzten Spalte (Konfigurationsspalte)

== Kalenderjahr ==
Diese Einstellung bestimmt den Bezugstag der Anzeige. Standardmäßig wird ab dem aktuellen Datum angezeigt. Soll die Anzeige ab dem 1. Januar des aktuellen Jahres beginnen, so ist der Haken zu setzen.

== Jahresversatz ==
Hiermit kann die Anzeige um x Jahre vor- oder zurückversetzt werden (0 entspricht keinem Versatz).

=== Menüpunkt Optionen ===
Über Optionen können allgemeingültige Einstellungen für das Plugin definiert werden.\\ 
{{:de:plugins:geburtstagsliste:optionen.png?300}}

== Vorschautage == 
Hier wird die Standardeinstellung der Vorschautage festgelegt.

== Vorschauliste ==
Hier werden die Tage eingetragen, die später in der Geburtstagsliste zur Auswahl angeboten werden. Mehrere Einträge sind durch Kommata zu trennen (Bsp: -14,2,5,10,20,30,60,365,1000).

== Konfiguration ==
Hier wird festgelegt, welche Konfiguration beim Start des Plugins angezeigt wird.\\
{{:de:plugins:geburtstagsliste:standardkonfiguration-waehlen.png?300}}

== Deinstallation ==
Über die Deinstallation können alle vom Plugin erstellten Konfigurationsdaten wieder gelöscht werden. \\
{{:de:plugins:geburtstagsliste:deinstallation.png?300}}
{{:de:plugins:geburtstagsliste:deinstallation-hinweis.png?300}}

=== Menüpunkt Pluginfreigabe ===
Auswahl der Rollen, deren Angehörige das Plugin aufrufen dürfen. Das Plugin und das Einstellungen-Menü können getrennt voneinander für bestimmte Rollen freigeschaltet werden.

{{:de:plugins:geburtstagsliste:pluginfreigabe.png?300}}

Hinweis: Eine ausgewählte Rolle benötigt zusätzlich über die Admidio-Rollenverwaltung mindestens eine der nachfolgenden Berechtigungen:

  * "Rollen verwalten und zuordnen"
  * "Profildaten aller Benutzer bearbeiten"
  * "Registrierungen verwalten und zuordnen"

=== Menüpunkt Plugininformationen ===

{{:de:plugins:geburtstagsliste:plugininformationen.png?300}}

Hier werden Informationen zur Version und zum Stand des Plugins angezeigt.

=== Die Speicherung der Konfiguration ===
Alle Konfigurationsdaten werden in einer Tabelle mit dem Namen adm_plugin_preferences in der Admidio-Datenbank gespeichert. Sollte diese Tabelle nicht existieren, wird sie angelegt.

Derzeit werden in dieser Tabelle die Konfigurationen folgender Plugins abgelegt:
   * Mitgliedsbeitrag
   * Kategoriereport
   * Geburtstagsliste
   * FormFiller

Die Tabelleneinträge des Plugins Geburtstagsliste beginnen hierbei alle mit den Buchstaben "PGL".