Shortcode und Parameter

Um die Ergebnisse aus einem Bericht sichtbar zu machen, muss ein Beitrag mit einem Shortcode erstellt werden. Es kann aber auch direkt aus der Bearbeitung des Berichts im Zahlungsplaner mit einem Klick ein neuer Beitrag erstellt werden. Mehr hierzu unter Berichte.

Bitte beachten, dass das “§”-Zeichen für die Ausführung entfernt werden muss. Es dient hier nur der Verhinderung eines Aufrufs, da der “Zahlungsplaner” auch auf dieser Web-Seite aktiv ist 😉

Beispiel hierzu siehe unten in diesem Beitrag.

Einfache Ausführung:

[§zahlungsplaner berichtsname]

Führt den in berichtsname angegebenen Bericht aus.

Sollte der Bericht nicht vorhanden sein oder deaktiviert, wird folgender Text ausgegeben: „Zahlungsplaner: Bericht : ‘Name’ nicht gefunden“.

Ausführung mit Parametern:

Parameter für Berichte:

[§zahlungsplaner berichtsname monat]

Führt den in berichtsname angegebenen Bericht aus, wobei der im Bericht gespeicherte Zeitraum durch den aktuellen Monat überschrieben wird.

Es können auch Berechnungen durch Angabe von +monat oder – monat durchgeführt werden.

[§zahlungsplaner berichtsname monat+2]

bezieht sich somit auf den übernächsten Monat.

Gleiches gilt für Berechnungen mit dem Jahr, bspw.

[§zahlungsplaner berichtsname jahr-1]

um das vergangene Jahr zu berechnen.

Berichten der Berichtsart „nur Summe“ können Parameter mitgegeben werden, die wie folgt beschrieben sind.

Wird der Parameter um ein %anzahl ergänzt, gibt der Bericht nur die Anzahl der gefundenen Einträge zurück.

Bei %durchschnitt wird der durchschnittliche Betrag, berechnet auf einen Monat, ausgegeben. Der Zusatz %dauer gibt den Berichtszeitraum in Monaten zurück.

Beispiel Aufruf ohne Parameter:

 [§zahlungsplaner berichtsname %durchschnitt]

Beispiel Aufruf mit Parameter:

[§zahlungsplaner berichtsname monat+2%durchschnitt]

(ohne Leerzeichen).

Der Aufruf von Berichten einer anderen Berichtsart als „nur Summe“ mit diesen Parametern meldet : „Angegebener Parameter bei dieser Berichtsart nicht unterstützt!“.

Weitere Parameter:

• %hoch-+ : gibt den höchsten Einzelbetrag der Einnahmen aus
• %hoch- : gibt den höchsten Einzelbetrag der Einnahmen aus
• %niedrig+ : gibt den niedrigsten Einzelbetrag der Einnahmen aus
• %niedrig-> : gibt den niedrigsten Einzelbetrag der Einnahmen aus

Umbuchungen werden nicht berücksichtigt, da sie keinen Geldabgang/Zugang darstellen!

Parameter ohne Berichte:

Datumsberechnungen können auch ohne einen Bericht durchgeführt werden. Wenn ein Text ausgegeben werden soll, um bspw. den nachfolgenden oder vorher ausgeführten Bericht zu beschreiben, genügt es, die Anweisung ohne Berichtsnamen anzugeben.

Beispiel:

Heutiges Datum:

 [§zahlungsplaner {heute}Y-m-d] deutsches Format [§zahlungsplaner {heute}d.m.Y]

druckt folgenden Satz aus:

Heutiges Datum 2017-12-29 deutsches Format  29.12.2017 .

Heute + 3 Monate [§zahlungsplaner {heute%monat+3}d.m.Y]

druckt den Satz:

Heute + 3 Monate 29.03.2018

Das Datumsformat, bspw. d.m.Y, entspricht den Formaten, wie sie in PHP angewendet werden:

W           Wochennummer des Jahres, die Woche beginnt am Montag
                Beispiel: 42 (die 42. Woche im Jahr)

F             Monat als ganzes Wort, wie January oder March January bis December

m            Monat als Zahl, mit führenden Nullen 01 bis 12

M            Monatsname mit drei Buchstaben Jan bis Dec

n              Monatszahl, ohne führende Nullen 1 bis 12

t               Anzahl der Tage des angegebenen Monats 28 bis 31

L              Schaltjahr oder nicht 1 für ein Schaltjahr, ansonsten 0

Y             Vierstellige Jahreszahl Beispiele: 1999 oder 2003

y              Jahreszahl, zweistellig Beispiele: 99 oder 03

Der Berichtszeitraum, der im Bericht definiert ist, kann auch im Beitrag überschrieben werden. Hierbei ist einfach hinter dem Berichtsnamen der Zeitraum in der Form zeitraum:tt.mm.jjjj- tt.mm.jjjj anzugeben.

Beispiel:

[§zahlungsplaner berichtsname zeitraum:tt.mm.jjjj-tt.mm.jjjj]

Wenn ein ungültiges Datum eingegeben wurde, wird folgender Text ausgegeben: „Parameter Zeitraum ‘x1.01.2019-31.12.2019’ ungültig !“.

Schaltjahre werden bei allen Berechnungen berücksichtigt.

Weitere Parameter:

Es können die Daten der Berichtssätze ausgedruckt werden.

Beschreibung des Berichts:

[§zahlungsplaner berichtsname {bericht}beschreibung]

druckt den im Berichtssatz gespeicherten Beschreibungstext aus.

Mögliche Felder sind:

name
der Name des Berichts

beschreibung
der Beschreibungstext des Berichts

von                      
das Datum Zeitraum „von“ des Berichts: gibt gesamt aus, wenn der Zeitraum auf gesamt gestellt wurde

bis
das Datum Zeitraum „bis“ des Berichts: gibt gesamt aus, wenn der Zeitraum  auf gesamt gestellt wurde

ea                          
gibt entweder Einnahme oder Ausgabe aus

mandant           
gibt den im Bericht hinterlegten Mandanten aus, alle, wenn der Bericht sich auf alle Mandanten bezieht

kategorien
gibt die im Bericht hinterlegten Kategorien aus, alle, wenn der Bericht sich auf alle Kategorien bezieht

Beispiele:

In einem Beitrag wird folgender Shortcode mit Parametern angelegt:

Alle Einnahmen und Ausgaben gesamter Zeitraum

Der verwendete Bericht hat den Namen : [§zahlungsplaner Gesamt-Summe {bericht}name]
 Die Bemerkung hierzu aus dem Bericht : [§zahlungsplaner Gesamt-Summe {bericht}beschreibung]

Einnahmen/Ausgaben gesamt : [§zahlungsplaner Gesamt-Summe]
 Anzahl Buchungen gesamt : [§zahlungsplaner Gesamt-Summe %anzahl]
 Dauer des Berichts : [§zahlungsplaner Gesamt-Summe %dauer] Monat(e)
 Höchster Einzelbetrag Einnahme :  [§zahlungsplaner Gesamt-Summe %hoch+]
 Höchster Einzelbetrag Ausgabe :  [§zahlungsplaner Gesamt-Summe %hoch-]
 Niedrigster Einzelbetrag Einnahme :  [§zahlungsplaner Gesamt-Summe %niedrig+]
 Niedrigster Einzelbetrag Ausgabe :  [§zahlungsplaner Gesamt-Summe %niedrig-]
 Durchschnitt im Zeitraum :  [§zahlungsplaner Gesamt-Summe %durchschnitt]
 Durchschnitt im aktuellen Jahr ([§zahlungsplaner {heute}Y]) :  [§zahlungsplaner Gesamt-Summe jahr%durchschnitt]
 Durchschnitt im nächsten Jahr ([§zahlungsplaner {heute%jahr+1}Y]) :  [§zahlungsplaner Gesamt-Summe jahr+1%durchschnitt]

Einnahmen/Ausgaben Sechs-Monats-Sicht :
 [§zahlungsplaner {heute%monat}m.Y] : [§zahlungsplaner Gesamt-Summe monat]
 [§zahlungsplaner {heute%monat+1}m.Y] : [§zahlungsplaner Gesamt-Summe monat+1]
 [§zahlungsplaner {heute%monat+2}m.Y] : [§zahlungsplaner Gesamt-Summe monat+2]
 [§zahlungsplaner {heute%monat+3}m.Y] : [§zahlungsplaner Gesamt-Summe monat+3]
 [§zahlungsplaner {heute%monat+4}m.Y] : [§zahlungsplaner Gesamt-Summe monat+4]
 [§zahlungsplaner {heute%monat+5}m.Y] : [§zahlungsplaner Gesamt-Summe monat+5]

Daraus ergibt sich folgende Ausgabe:

Zahlungsplan Vorschau Bericht : Gesamt-Summe

ALLE EINNAHMEN UND AUSGABEN GESAMTER ZEITRAUM

Der verwendete Bericht hat den Namen : Gesamt-Summe
Die Bemerkung hierzu aus dem Bericht : Alle, nur Summe

Einnahmen/Ausgaben gesamt : 22.800,00
Anzahl Buchungen gesamt : 72
Dauer des Berichts : 24 Monat(e)
Höchster Einzelbetrag Einnahme :  2.000,00
Höchster Einzelbetrag Ausgabe :  -1.300,00
Niedrigster Einzelbetrag Einnahme :  200,00
Niedrigster Einzelbetrag Ausgabe :  -1.200,00
Durchschnitt im Zeitraum :  950,00
Durchschnitt im aktuellen Jahr (2018 ) :  1.000,00
Durchschnitt im nächsten Jahr (2019 ) :  900,00

Einnahmen/Ausgaben Sechs-Monats-Sicht :
01.2018 : 1.000,00
02.2018 : 1.000,00
03.2018 : 1.000,00
04.2018 : 1.000,00
05.2018 : 1.000,00
06.2018 : 1.000,00