一.基础介绍

       nop支持多店及多语言,本篇结合NivoSlider插件介绍下如何开发支持多商城的小部件。

       主要接口如下:

ISettingService 接口:设置接口,可实现多店配置。

ILocalizationService 接口:本地化资源接口,配合语言,实现多语言的显示。

二.插件安装、卸载

      我们在上一篇介绍了小部件如何使用(点击这里),这里介绍下如何安装、卸载插件。

nopCommerce 3.9 大波浪系列 之 开发支持多店的插件

【后台管理】【插件管理】【本地插件】可以对插件进行安装、卸载

Nop.Admin.Controllers.PluginController控制器用于插件的管理。Install负责安装插件、Uninstall负责卸载插件。

     所有插件都继承IPlugin接口,Install(),Uninstall()分别用于安装及卸载。

  1 namespace Nop.Core.Plugins
  2 {
  3     /// <summary>
  4     /// Interface denoting plug-in attributes that are displayed throughout 
  5     /// the editing interface.
  6     /// </summary>
  7     public interface IPlugin
  8     {
  9         /// <summary>
 10         /// Gets or sets the plugin descriptor
 11         /// </summary>
 12         PluginDescriptor PluginDescriptor { get; set; }
 13 
 14         /// <summary>
 15         /// Install plugin
 16         /// </summary>
 17         void Install();
 18 
 19         /// <summary>
 20         /// Uninstall plugin
 21         /// </summary>
 22         void Uninstall();
 23     }
 24 }
 25 

       BasePlugin抽象类继承了IPlugin接口,并实现了 Install(),Uninstall()方法,当安装时在"~/App_Data/InstalledPlugins.txt"文件中写入插件的SystemName,卸载时则在文件中删除。

  1 namespace Nop.Core.Plugins
  2 {
  3     /// <summary>
  4     /// Base plugin
  5     /// </summary>
  6     public abstract class BasePlugin : IPlugin
  7     {
  8         /// <summary>
  9         /// Gets or sets the plugin descriptor
 10         /// </summary>
 11         public virtual PluginDescriptor PluginDescriptor { get; set; }
 12 
 13         /// <summary>
 14         /// Install plugin
 15         /// </summary>
 16         public virtual void Install()
 17         {
 18             PluginManager.MarkPluginAsInstalled(this.PluginDescriptor.SystemName);
 19         }
 20 
 21         /// <summary>
 22         /// Uninstall plugin
 23         /// </summary>
 24         public virtual void Uninstall()
 25         {
 26             PluginManager.MarkPluginAsUninstalled(this.PluginDescriptor.SystemName);
 27         }
 28 
 29     }
 30 }
 31 

       我们看下NivoSlider插件在安装时都做了哪些操作。

  1 using System.Collections.Generic;
  2 using System.IO;
  3 using System.Web.Routing;
  4 using Nop.Core;
  5 using Nop.Core.Plugins;
  6 using Nop.Services.Cms;
  7 using Nop.Services.Configuration;
  8 using Nop.Services.Localization;
  9 using Nop.Services.Media;
 10 
 11 namespace Nop.Plugin.Widgets.NivoSlider
 12 {
 13     /// <summary>
 14     /// PLugin
 15     /// </summary>
 16     public class NivoSliderPlugin : BasePlugin, IWidgetPlugin
 17     {
 18         private readonly IPictureService _pictureService;
 19         private readonly ISettingService _settingService;
 20         private readonly IWebHelper _webHelper;
 21 
 22         public NivoSliderPlugin(IPictureService pictureService,
 23             ISettingService settingService, IWebHelper webHelper)
 24         {
 25             this._pictureService = pictureService;
 26             this._settingService = settingService;
 27             this._webHelper = webHelper;
 28         }
 29 
 30         /// <summary>
 31         /// Gets widget zones where this widget should be rendered
 32         /// </summary>
 33         /// <returns>Widget zones</returns>
 34         public IList<string> GetWidgetZones()
 35         {
 36             return new List<string> { "home_page_top" };
 37         }
 38 
 39         /// <summary>
 40         /// Gets a route for provider configuration
 41         /// </summary>
 42         /// <param name="actionName">Action name</param>
 43         /// <param name="controllerName">Controller name</param>
 44         /// <param name="routeValues">Route values</param>
 45         public void GetConfigurationRoute(out string actionName, out string controllerName, out RouteValueDictionary routeValues)
 46         {
 47             actionName = "Configure";
 48             controllerName = "WidgetsNivoSlider";
 49             routeValues = new RouteValueDictionary { { "Namespaces", "Nop.Plugin.Widgets.NivoSlider.Controllers" }, { "area", null } };
 50         }
 51 
 52         /// <summary>
 53         /// Gets a route for displaying widget
 54         /// </summary>
 55         /// <param name="widgetZone">Widget zone where it's displayed</param>
 56         /// <param name="actionName">Action name</param>
 57         /// <param name="controllerName">Controller name</param>
 58         /// <param name="routeValues">Route values</param>
 59         public void GetDisplayWidgetRoute(string widgetZone, out string actionName, out string controllerName, out RouteValueDictionary routeValues)
 60         {
 61             actionName = "PublicInfo";
 62             controllerName = "WidgetsNivoSlider";
 63             routeValues = new RouteValueDictionary
 64             {
 65                 {"Namespaces", "Nop.Plugin.Widgets.NivoSlider.Controllers"},
 66                 {"area", null},
 67                 {"widgetZone", widgetZone}
 68             };
 69         }
 70 
 71         /// <summary>
 72         /// Install plugin
 73         /// </summary>
 74         public override void Install()
 75         {
 76             //pictures
 77             var sampleImagesPath = CommonHelper.MapPath("~/Plugins/Widgets.NivoSlider/Content/nivoslider/sample-images/");
 78 
 79 
 80             //settings
 81             var settings = new NivoSliderSettings
 82             {
 83                 Picture1Id = _pictureService.InsertPicture(File.ReadAllBytes(sampleImagesPath + "banner1.jpg"), MimeTypes.ImagePJpeg, "banner_1").Id,
 84                 Text1 = "",
 85                 Link1 = _webHelper.GetStoreLocation(false),
 86                 Picture2Id = _pictureService.InsertPicture(File.ReadAllBytes(sampleImagesPath + "banner2.jpg"), MimeTypes.ImagePJpeg, "banner_2").Id,
 87                 Text2 = "",
 88                 Link2 = _webHelper.GetStoreLocation(false),
 89                 //Picture3Id = _pictureService.InsertPicture(File.ReadAllBytes(sampleImagesPath + "banner3.jpg"), MimeTypes.ImagePJpeg, "banner_3").Id,
 90                 //Text3 = "",
 91                 //Link3 = _webHelper.GetStoreLocation(false),
 92             };
 93             _settingService.SaveSetting(settings);
 94 
 95 
 96             this.AddOrUpdatePluginLocaleResource("Plugins.Widgets.NivoSlider.Picture1", "Picture 1");
 97             this.AddOrUpdatePluginLocaleResource("Plugins.Widgets.NivoSlider.Picture2", "Picture 2");
 98             this.AddOrUpdatePluginLocaleResource("Plugins.Widgets.NivoSlider.Picture3", "Picture 3");
 99             this.AddOrUpdatePluginLocaleResource("Plugins.Widgets.NivoSlider.Picture4", "Picture 4");
100             this.AddOrUpdatePluginLocaleResource("Plugins.Widgets.NivoSlider.Picture5", "Picture 5");
101             this.AddOrUpdatePluginLocaleResource("Plugins.Widgets.NivoSlider.Picture", "Picture");
102             this.AddOrUpdatePluginLocaleResource("Plugins.Widgets.NivoSlider.Picture.Hint", "Upload picture.");
103             this.AddOrUpdatePluginLocaleResource("Plugins.Widgets.NivoSlider.Text", "Comment");
104             this.AddOrUpdatePluginLocaleResource("Plugins.Widgets.NivoSlider.Text.Hint", "Enter comment for picture. Leave empty if you don't want to display any text.");
105             this.AddOrUpdatePluginLocaleResource("Plugins.Widgets.NivoSlider.Link", "URL");
106             this.AddOrUpdatePluginLocaleResource("Plugins.Widgets.NivoSlider.Link.Hint", "Enter URL. Leave empty if you don't want this picture to be clickable.");
107 
108             base.Install();
109         }
110 
111         /// <summary>
112         /// Uninstall plugin
113         /// </summary>
114         public override void Uninstall()
115         {
116             //settings
117             _settingService.DeleteSetting<NivoSliderSettings>();
118 
119             //locales
120             this.DeletePluginLocaleResource("Plugins.Widgets.NivoSlider.Picture1");
121             this.DeletePluginLocaleResource("Plugins.Widgets.NivoSlider.Picture2");
122             this.DeletePluginLocaleResource("Plugins.Widgets.NivoSlider.Picture3");
123             this.DeletePluginLocaleResource("Plugins.Widgets.NivoSlider.Picture4");
124             this.DeletePluginLocaleResource("Plugins.Widgets.NivoSlider.Picture5");
125             this.DeletePluginLocaleResource("Plugins.Widgets.NivoSlider.Picture");
126             this.DeletePluginLocaleResource("Plugins.Widgets.NivoSlider.Picture.Hint");
127             this.DeletePluginLocaleResource("Plugins.Widgets.NivoSlider.Text");
128             this.DeletePluginLocaleResource("Plugins.Widgets.NivoSlider.Text.Hint");
129             this.DeletePluginLocaleResource("Plugins.Widgets.NivoSlider.Link");
130             this.DeletePluginLocaleResource("Plugins.Widgets.NivoSlider.Link.Hint");
131 
132             base.Uninstall();
133         }
134     }
135 }
136 
Nop.Plugin.Widgets.NivoSlider

相关文章:

  • 2022-12-23
  • 2022-12-23
  • 2021-08-30
  • 2021-09-24
猜你喜欢
  • 2022-12-23
  • 2022-12-23
  • 2022-12-23
  • 2021-08-16
  • 2022-12-23
  • 2021-08-12
相关资源
相似解决方案