Variablen

Plugin-Variablen stehen dem Plugin-Entwickler im Front- und Backend des Onlineshops sowie in jeder vom Plugin verwalteten Datei zur Verfügung. Alle unten aufgelisteten Plugin-Variablen sind in JTL-Shop 3 und 4 Member des globalen Objekts $oPlugin.

Beispiel:

Ausgabe des Pluginnamens

echo $oPlugin->cName;

Nutzen Sie ab JTL-Shop 5.0 daher das Interface JTL\Plugin\PluginInterface. Die entsprechenden Getter sind in der Spalte Methode dokumentiert.

Beispiel:

in der PHP-Datei eines Frontend-Links

$smarty->assign([
    'pluginName' => $plugin->getMeta()->getName()
]);

in einem Frontend-Template

{$plugin->getMeta()->getName()}

Von den allgemeinen Informationen des Plugins über Sprachvariablen bis hin zu den Einstellungen des Plugins sind alle Variablen über die hier aufgeführten Methoden erreichbar.

Klassenvariablen

Klassenvariable	Methode	Funktionalität
$kPlugin	getID(): int	Eindeutiger Plugin-Key
$nStatus	getState(): int	Plugin-Status
		(1 = Deaktiviert, 2 = Aktiviert und Installiert, 3 = Fehlerhaft, 4 = Update fehlgeschlagen)
$nVersion	getMeta()->getVersion(): Version	Plugin-Version
$icon	getMeta()->getIcon(): string	Dateiname des Icons
$nXMLVersion	---	XML-Version
$nPrio	getPriority(): int	Priorität bei Plugins mit gleichem Autor
$cName	getMeta()->getName(): string	Name des Plugins
$cBeschreibung	getMeta()->getDescription(): string	Plugin-Beschreibung
$cAutor	getMeta()->getAuthor(): string	Plugin-Autor
$cURL	getMeta()->getURL(): string	URL zum Plugin-Hersteller
$cVerzeichnis	getPaths()->getBaseDir(): string	Plugin-Verzeichnis
$cPluginID	getPluginID(): string	Einmalige Plugin-ID
$cLizenz	getLicense()->getKey(): string	Konfigurierter Lizenzschlüssel
$cLizenzKlasse	getLicense()->getClassName(): string	Name der Lizenzklasse
$cLicencePfad	getLicense()->getClass(): string	Physischer Pfad auf dem Server zum Ordner license
$cLicencePfadURL	---	Vollständige URL zum Ordner license
$cLicencePfadURLSSL	---	Vollständige URL via https zum Ordner license
$cFrontendPfad	getPaths()->getFrontendPath(): string	Physischer Pfad auf dem Server zum Ordner frontend
$cFrontendPfadURL	getPaths()->getFrontendURL(): string	Vollständige URL zum Ordner frontend
$cFrontendPfadURLSSL	getPaths()->getFrontendURL(): string	Vollständige URL via https zum Ordner frontend
$cAdminmenuPfad	getPaths()->getAdminPath(): string	Physischer Pfad auf dem Server zum Ordner adminmenu
$cAdminmenuPfadURLSSL	getPaths()->getAdminURL(): string	Vollständige URL zum SSL-gesicherten Ordner adminmenu
$dZuletztAktualisiert	getMeta()->getDateLastUpdate(): DateTime	Letztes Aktualisierungsdatum
$dInstalliert	getMeta()->getDateInstalled(): DateTime	Installationsdatum
$dErstellt	getMeta()->getDateInstalled(): DateTime	Erstellungsdatum
$oPluginHook_arr	getHooks(): array	Array mit Hooks
$oPluginAdminMenu_arr	getAdminMenu()->getItems: array	Array mit Adminmenüs
$oPluginEinstellung_arr	getConfig()->getOptions(): Collection	Array mit gesetzten Einstellungen
$oPluginEinstellungConf_arr	getConfig()->getOptions(): Collection	Array mit Einstellungen
$oPluginEinstellungAssoc_arr	getConfig()->getOptions(): Collection	Assoziatives Array mit gesetzten Einstellungen
---	getConfig()->getValue(<ValueName>): mixed	Wert einer einzelnen Einstellung
$oPluginSprachvariable_arr	getLocalization()->getTranslations(): array	Assoziatives Array mit Sprachvariablen
$oPluginFrontendLink_arr	getLinks()->getLinks(): Collection	Array mit Frontend-Links
$oPluginZahlungsmethode_arr	getPaymentMethods()->getMethods(): array	Array mit Zahlungsmethoden
$oPluginZahlungsmethodeAssoc_arr	getPaymentMethods()->getMethodsAssoc(): array	Assoziatives Array mit Zahlungsmethoden
$dInstalliert_DE	---	Lokalisiertes Installationsdatum
$dZuletztAktualisiert_DE	---	Lokalisiertes Aktualisierungsdatum
$dErstellt_DE	---	Lokalisiertes Hersteller-Erstellungsdatum
$nCalledHook	---	ID des aktuell ausgeführten Hooks
$pluginCacheID	getCache()->getID(): string	Individuelle Cache-ID zur Nutzung des Objekt-Caches
$pluginCacheGroup	getCache()->getGroup(): string	Individuelle Cache-Gruppe zur Nutzung des Objekt-Caches

Arrays

oPluginHook_arr

Dieses Array beinhaltet alle durch das Plugin genutzten Hooks.

Typ: Array von Objekten

Member: kPluginHook, kPlugin, nHook, cDateiname

Member	Funktionalität
kPluginHook	Eindeutiger Hook-Key
kPlugin	Eindeutiger Plugin-Key
nHook	Hook-ID
cDateiname	Dateiname, der bei nHook ausgeführt wird

oPluginAdminMenu_arr

Array mit allen Backend-Links

Typ: Array von Objekten

Member: kPluginAdminMenu, kPlugin, cName, cDateiname, nSort, nConf

Member	Funktionalität
kPluginAdminMenu	Eindeutiger Plugin-Adminmenu-Key
kPlugin	Eindeutiger Plugin-Key
cName	Name des Admin-Tabs
nSort	Sortierungsnummer des Admin-Tabs
nConf	0 = Custom Link auf cDateiname / 1 = Settings

oPluginEinstellung_arr

Array mit allen gesetzten Einstellungen des Plugins

Typ: Array von Objekten

Member: kPlugin, cName, cWert

Member	Funktionalität
kPlugin	Eindeutiger Plugin-Key
cName	Eindeutiger Einstellungsname der Variable
cWert	Wert der Variable

oPluginEinstellungAssoc_arr

Assoziatives Array mit Einstellungen

Der Unterschied zum obigen Array besteht darin, dass die jeweiligen Einstellungen assoziativ mit ihrem ValueName angesprochen werden können.

Beispiel:

JTL-Shop 5

if ($plugin->getOptions()->getValue('mein_cName') === 'Y') {
    //...
}

Typ: Assoziatives Array

Key: cName Wert: cWert

Member	Funktionalität
cWert	Wert der Variable

oPluginEinstellungConf_arr

Array mit Einstellungsoptionen

Diese Optionen werden im Backend unter dem jeweiligen Settings-Link angezeigt und können dort als Einstellung gesetzt werden.

Typ: Array von Objekten

Member: kPluginEinstellungenConf, kPlugin, kPluginAdminMenu, cName, cBeschreibung, cWertName, cInputTyp, nSort, cConf, oPluginEinstellungenConfWerte_arr

Member	Funktionalität
kPluginEinstellungenConf	Eindeutiger Plugin-Einstellungs-Key
kPlugin	Eindeutiger Plugin-Key
kPluginAdminMenu	Eindeutiger Plugin-Adminmenu-Key
cName	Name der Einstellung
cBeschreibung	Beschreibung der Einstellung
cWertName	Wert der Variable
cInputTyp	Typ der Variable (text, zahl, selectbox,...)
nSort	Sortierung der Einstellung
cConf	Y = Einstellung / N = Überschrift
oPluginEinstellungenConfWerte_arr	Array von Optionswerten

oPluginEinstellungenConfWerte_arr

Array mit Einstellungsoptionswerten

Falls eine Einstellungsoption eine selectbox oder radio ist, beinhaltet dieses Array zu einer bestimmten Einstellungsoption alle Optionswerte.

Typ: Array von Objekten

Member: kPluginEinstellungenConf, cName, cWert, nSort

Member	Funktionalität
kPluginEinstellungenConf	Eindeutiger Plugin-Einstellungs-Key
cName	Eindeutiger Einstellungsname der Variablen
cWert	Wert der Option
nSort	Sortierung der Option

oPluginSprachvariable_arr

Array mit allen Sprachvariablen des Plugins

Typ: Array von Objekten

Member: kPluginSprachvariable, kPlugin, cName, cBeschreibung, oPluginSprachvariableSprache_arr

Member	Funktionalität
kPluginSprachvariable	Eindeutiger Sprachvariablen-Key
kPlugin	Eindeutiger Plugin-Key
cName	Name der Sprachvariable
cBeschreibung	Beschreibung der Sprachvariable
oPluginSprachvariableSprache_arr	Array aller lokalisierten Sprachen dieser Sprachvariable

oPluginSprachvariableSprache_arr

Dieses Array beinhaltet alle Sprachvariablen des jeweiligen Plugins. Es muss assoziativ mit der entsprechenden Sprach-ISO angesprochen werden.

Assoziatives Array

Key: ISO

Wert: Lokalisierte Sprachvariable

oPluginFrontendLink_arr

Array mit vorhanden Frontend-Links

Typ: Array von Objekten

Member: kLink, kLinkgruppe, kPlugin, cName, nLinkart, cURL, cKundengruppen, cSichtbarNachLogin, cDruckButton, nSort, oPluginFrontendLinkSprache_arr

Member	Funktionalität
kLink	Eindeutiger Link-Key
kLinkgruppe	Eindeutiger Linkgruppen-Key
kPlugin	Eindeutiger Plugin-Key
cName	Name des Frontend-Links
nLinkart	Eindeutiger Linkart-Key
cURL	Pfad zur Datei, die verlinkt werden soll
cKundengruppen	String von Kundengruppen-Keys
cSichtbarNachLogin	Ist der Link nur nach dem Einloggen sichtbar? Y = Ja / N = Nein
cDruckButton	Soll die Linkseite einen Druckbutton erhalten? Y = Ja / N = Nein
nSort	Sortierungsnummer des Links
oPluginFrontendLinkSprache_arr	Array lokalisierter Linknamen

oPluginSprachvariableAssoc_arr

Assoziatives Array mit allen Sprachvariablen des Plugins

Diese assoziative Array beinhaltet alle Sprachvariablen des Plugins. Sie werden direkt in der entsprechenden Sprache des Onlineshops lokalisiert und können über cName angesprochen werden.

Typ: Assoziatives Array

Key: cName Wert: Objekt

Member: kPluginSprachvariable, kPlugin, cName, cBeschreibung, oPluginSprachvariableSprache_arr

Member	Funktionalität
kPluginSprachvariable	Eindeutiger Plugin-Sprachvariablen-Key
kPlugin	Eindeutiger Plugin-Key
cName	Name der Sprachvariable
cBeschreibung	Beschreibung der Sprachvariable
oPluginSprachvariableSprache_arr	Array aller Sprachen, für die diese Sprachvariable lokalisiert ist

oPluginFrontendLinkSprache_arr

Array mit lokalisierten Namen eines bestimmten Frontend-Links

Typ: Array von Objekten

Member: kLink, cSeo, cISOSprache, cName, cTitle, cContent, cMetaTitle, cMetaKeywords, cMetaDescription

Member	Funktion
kLink	Eindeutiger Link-Key
cSeo	SEO für die jeweilige Linksprache
cISOSprache	ISO der Linksprache
cName	Lokalisierter Name des Links
cTitle	Lokalisierter Titel des Links
cContent	Lokalisierter Content des Links
cMetaTitle	Lokalisierter MetaTitel des Links
cMetaKeywords	Lokalisierte MetaKeywords des Links
cMetaDescription	Lokalisierte MetaDescription des Links

oPluginZahlungsmethode_arr

Array aller Zahlungsmethoden

Dieses Array beinhaltet alle verfügbaren Zahlungsmethoden.

Typ: Array von Objekten

Member: kZahlungsart, cName, cModulId, cKundengruppen, cZusatzschrittTemplate, cPluginTemplate, cBild, nSort, nMailSenden, nActive, cAnbieter, cTSCode, nWaehrendBestellung, nCURL, nSOAP, nSOCKETS, nNutzbar, cTemplateFileURL, oZahlungsmethodeSprache_arr, oZahlungsmethodeEinstellung_arr

Member	Funktionalität
kZahlungsart	Eindeutiger Zahlungsart Key
cName	Name der Zahlungsart
cModulId	Eindeutige Modul-ID der Zahlungsart
cKundengruppen	String von Kundengruppen, für die diese Zahlungsart gilt
cZusatzschrittTemplate	Zusätzliche Daten für Transaktionen können eingegeben werden
cPluginTemplate	Pfad zum Template der Zahlungsart
cBild	Bildpfad der Zahlungsart
nSort	Sortierungsnummer der Zahlungsart
nMailSenden	Versendet diese Zahlungsart standardmäßig eine E-Mail beim Abschluss? 1 = Ja / 0 = Nein
nActive	Ist diese Zahlungsart aktiv? 1 = Ja / 0 = Nein
cAnbieter	Name des Anbieters der Zahlungsart
cTSCode	Trusted Shops Code
nWaehrendBestellung	Pre- oder Post-Bestellung
nCURL	Nutzt diese Zahlungsart das CURL-Protokoll?
nSOAP	Nutzt diese Zahlungsart das SOAP-Protokoll?
nSOCKETS	Nutzt diese Zahlungsart Sockets?
nNutzbar	Sind alle Serverprotokolle nutzbar, die für diese Zahlungsart benötigt werden?
cTemplateFileURL	Absoluter Pfad zur Template-Datei
oZahlungsmethodeSprache_arr	Lokalisierte Zahlungsart für alle angegebenen Sprachen
oZahlungsmethodeEinstellung_arr	Array von lokalisierten Einstellungen

oZahlungsmethodeSprache_arr

Array mit lokalisierten Namen der jeweiligen Zahlungsmethode

Typ: Array von Objekten

Member: kZahlungsart, cISOSprache, cName, cGebuehrname, cHinweisText

Member	Funktionalität
kZahlungsart	Eindeutiger Zahlungsart-Key
cISOSprache	Sprach-ISO
cName	Lokalisierter Name
cGebuehrname	Lokalisierter Gebührenname
cHinweisText	Lokalisierter Hinweistext

oZahlungsmethodeEinstellung_arr

Array mit Einstellungen zu einer bestimmten Zahlungsmethode

Typ: Array von Objekten

Member: kPluginEinstellungenConf, kPlugin, kPluginAdminMenu, cName, cBeschreibung, cWertName, cInputTyp, nSort, cConf

Member	Funktion
kPluginEinstellungenConf	Eindeutiger Plugin-Einstellungs-Key
kPlugin	Eindeutiger Plugin-Key
kPluginAdminMenu	Eindeutiger Plugin-Adminmenü-Key
cName	Name der Einstellung
cBeschreibung	Beschreibung der Einstellung
cWertName	Wert der Variable
cInputTyp	Typ der Variable (text, zahl, selectbox,...)
nSort	Sortierung der Einstellung
cConf	Y = Einstellung / N = Überschrift