Updating an existing entity. How to add a new property

This tutorial covers how to add a property to the "Category" entity that ships with the nopCommerce source code.

The data model

Entities will have two classes that are used to map records to a table. The first class defines the properties, fields, and methods consumed by the web application.

File System Location: [Project Root]\Libraries\Nop.Core\Domain\Catalog\Category.cs
Assembly: Nop.Core
Solution Location: Nop.Core.Domain.Catalog.Category.cs

The second class is used to map the properties defined in the class above to their respective SQL columns. The mapping class is also responsible for mapping relationships between different SQL tables.

File System Location: [Project Root]\Libraries\Nop.Data\Mapping\Builders\Catalog\CategoryBuilder.cs
Assembly: Nop.Data
Solution Location: Nop.Data.Mapping.Builders.Catalog.CategoryBuilder.cs

But I recommend you to use it only for your own entity classes. In our case, we'll use the migration mechanism instead of mapping class.

Add the following property to the Category class.

public string SomeNewProperty { get; set; }

Add the new class (Nop.Data.Migrations.AddSomeNewProperty) with following code:

using FluentMigrator;
using Nop.Core.Domain.Catalog;

namespace Nop.Data.Migrations
{
    [NopMigration("2020/05/25 11:24:16:2551770", "Category. Add some new property")]
    public class AddSomeNewProperty: AutoReversingMigration
    {
        /// <summary>Collect the UP migration expressions</summary>
        public override void Up()
        {
            Create.Column(nameof(Category.SomeNewProperty))
            .OnTable(nameof(Category))
            .AsString(255)
            .Nullable();
        }
    }
}

Note

Since migrations appeared only in the nopCommerce 4.30, it does not implement the update procedure call. Therefore, you need to add the following code to the method ApplicationBuilderExtensions.StartEngine

var migrationManager = EngineContext.Current.Resolve<IMigrationManager>();
migrationManager.ApplyUpMigrations();

The specified code should be added before the lines:

//update plugins
pluginService.UpdatePlugins();

The presentation model

The presentation model is used to transport information from a controller to the view (read more at asp.net/mvc). Models have another purpose; defining requirements.

We configured our database to only store 255 characters for the SomeNewProperty. If we try and save an SomeNewProperty with 300 characters the application will break (or truncate the text). We want the application to protect users from failures the best we can, and our view models help enforce requirements like string length.

File System Location: [Project Root]\Presentation\Nop.Web\Areas\Admin\Models\Catalog\CategoryModel.cs
Assembly: Nop.Admin
Solution Location: Nop.Web.Areas.Admin.Models.Catalog.CategoryModel.cs

The validator class is used to validate the data stored inside of the model class (e.g. required fields, max length, and required ranges).

File System Location: [Project Root]\Presentation\Nop.Web\Areas\Admin\Validators\Catalog\CategoryValidator.cs
Assembly: Nop.Web
Solution Location: Nop.Web.Areas.Admin.Validators.Catalog.CategoryValidator.cs

Add the property to our view model.

// The NopResourceDisplayName provides the "key" used during localization
// Keep an eye out for more about localization in future blogs
[NopResourceDisplayName("Admin.Catalog.Categories.Fields.SomeNewProperty")]
public string SomeNewProperty { get; set; }

The requirements code will be added in the constructor of the validator.

//I think this code can speak for itself
RuleFor(m => m.SomeNewProperty).Length(0, 255);

The view

File System Location: [Project Root]\Presentation\Nop.Web\Areas\Admin\Views\Category\ _CreateOrUpdate.Info.cshtml
Assembly: Nop.Web

Views contain the html for displaying model data. Place this html under the "PictureId" section.

<div class="form-group">
     <div class="col-md-3">
        <nop-label asp-for="SomeNewProperty" />
     </div>
     <div class="col-md-9">
        <nop-editor asp-for="SomeNewProperty" />
        <span asp-validation-for="SomeNewProperty"></span>
     </div>
 </div>

The controller

In this case the controller is responsible for mapping the domain data model to our view model and vice versa. The reason I choose the category model to update is because of the simplicity. I want this to be an introduction to the nopCommerce platform and I would like to keep it as simple as possible.

File System Location: [Project Root]\Presentation\Nop.Web\Areas\Admin\Controllers\CategoryController.cs
Assembly: Nop.Admin
Solution Location:
Nop.Web.Areas.Admin.Controllers.CategoryController.cs

We're going to make three updates to the CategoryController class.

• Data Model → View Model
• Create View Model → Data Model
• Edit View Model → Data Model

Normally I would write tests for the following code and verify that model mapping is working correctly, but I'll skip unit testing to keep it simple.

In the appropriate methods ("Create", "Edit", or "PrepareSomeModel") add the code to set this property. In most case it's not required because it's automatically handled by AutoMapper in the .ToModel() method.

In the public method to save entity (usually: "Create" or "Edit" methods with [HttpPost] attribute)

// Edit View Model → Data Model
category.SomeNewProperty = model.SomeNewProperty;

Troubleshooting

• Recreate the database. Either your own custom SQL script or use the nopCommerce installer.
• Stop the development web server between schema changes.
• Post a detailed comment on our forums.