Popis struktury souboru plugin.json
Tento soubor obsahuje popis metainformací pluginu, které nopCommerce používá k určení, do které skupiny plugin patří, zda je plugin kompatibilní s aktuální verzí nopCommerce, jaká je verze pluginu, a k několika dalším informacím. Každý plugin nopCommerce musí tento soubor mít.
Struktura souboru
{
"Group": "Payment methods",
"FriendlyName": "PayPal Commerce",
"SystemName": "Payments.PayPalCommerce",
"Version": "4.70.1",
"SupportedVersions": [ "4.70" ],
"Author": "nopCommerce team",
"DisplayOrder": -1,
"FileName": "Nop.Plugin.Payments.PayPalCommerce.dll",
"Description": ""
}
Group. nopCommerce ji používá k identifikaci, vyhledávání nebo filtrování pluginů podle názvu skupiny v seznamu pluginů v nabídce
Admin/Configuration/LocalPlugin. Může to být název vaší společnosti.FriendlyName. Zobrazovaný název pluginu. Slouží k identifikaci našeho pluginu v seznamu pluginů.
SystemName. nopCommerce jej používá k jednoznačné identifikaci pluginu, proto se musí lišit od všech ostatních pluginů. Nelze zaregistrovat více než jeden plugin se stejným
SystemName.Version. Číslo verze pluginu, které můžete nastavit na libovolnou hodnotu. Toto číslo slouží k identifikaci verze pluginu, která je aktuálně nainstalována v aplikaci nopCommerce. Doporučujeme však dodržovat následující formát –
"{nopCommerce_version_number}.{build_number}".SupportedVersions. Jde o pole řetězců. Obsahuje jednu nebo více verzí nopCommerce, na kterých je tento plugin podporován, neboli pro které je plugin určen. Během vývoje zajistěte, aby byla v tomto seznamu uvedena aktuální verze nopCommerce, ve které plugin vyvíjíte, jinak se plugin v seznamu pluginů nenačte.
Author. Informace o tvůrci pluginu. Může to být jméno osoby, název společnosti nebo tým, který plugin vytvořil.
DisplayOrder. Slouží k nastavení pořadí, ve kterém se má plugin zobrazovat v seznamu pluginů. Jeho hodnota je typu číslo.
FileName. Má následující formát Nop.Plugin...dll (jde o název souboru sestavení (assembly) vašeho pluginu).
Description. Obsahuje krátký popis vašeho pluginu, například o čem plugin je a co dělá. Zobrazuje se v seznamu pluginů pod názvem pluginu.
LimitedToStores – Seznam identifikátorů obchodů, ve kterých je tento plugin k dispozici. Je-li prázdný, je plugin k dispozici ve všech obchodech.
LimitedToCustomerRoles – Seznam identifikátorů rolí zákazníků, pro které je tento plugin k dispozici. Je-li prázdný, je plugin k dispozici pro všechny.
DependsOnSystemNames – Seznam systémových názvů pluginů, na kterých tento plugin závisí.
Tip
Po úpravě obsahu souboru plugin.json je třeba nastavit hodnotu jeho vlastnosti Copy to Output Directory na Copy if newer.
Je to nutné, protože tento soubor musí být zkopírován do kompilovaného adresáře, odkud k němu nopCommerce může přistupovat a zobrazit náš plugin v seznamu pluginů v administraci.
Příklady
Plugin FixedOrByCountryStateZip má následující soubor
plugin.json:{ "Group": "Tax providers", "FriendlyName": "Manual (Fixed or By Country/State/Zip)", "SystemName": "Tax.FixedOrByCountryStateZip", "Version": "4.70.1", "SupportedVersions": [ "4.70" ], "Author": "nopCommerce team", "DisplayOrder": 1, "FileName": "Nop.Plugin.Tax.FixedOrByCountryStateZip.dll", "Description": "This plugin allow to configure fix tax rates or tax rates by countries, states and zip codes" }Widget Google Analytics má následující soubor plugin.json:
{ "Group": "Widgets", "FriendlyName": "Google Analytics", "SystemName": "Widgets.GoogleAnalytics", "Version": "4.70.1", "SupportedVersions": [ "4.70" ], "Author": "nopCommerce team, Nicolas Muniere", "DisplayOrder": 1, "FileName": "Nop.Plugin.Widgets.GoogleAnalytics.dll", "Description": "This plugin integrates with Google Analytics. It keeps track of statistics about the visitors and ecommerce conversion on your website" }