ShippingStatusManager.cs :  » Web-Frameworks » nopCommerce » NopSolutions » NopCommerce » BusinessLogic » Shipping » C# / CSharp Open Source

//------------------------------------------------------------------------------
// The contents of this file are subject to the nopCommerce Public License Version 1.0 ("License"); you may not use this file except in compliance with the License.
// You may obtain a copy of the License at  http://www.nopCommerce.com/License.aspx. 
// 
// Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. 
// See the License for the specific language governing rights and limitations under the License.
// 
// The Original Code is nopCommerce.
// The Initial Developer of the Original Code is NopSolutions.
// All Rights Reserved.
// 
// Contributor(s): _______. 
//------------------------------------------------------------------------------

using System;
using System.Collections.Generic;
using System.Data;
using System.Data.Common;
using System.Globalization;
using System.Text;
using NopSolutions.NopCommerce.BusinessLogic.Caching;
using NopSolutions.NopCommerce.BusinessLogic.Configuration.Settings;
using NopSolutions.NopCommerce.BusinessLogic.Localization;
using NopSolutions.NopCommerce.DataAccess;
using NopSolutions.NopCommerce.DataAccess.Shipping;

namespace NopSolutions.NopCommerce.BusinessLogic.Shipping{
    /// <summary>
    /// Shipping status manager
    /// </summary>
    public partial class ShippingStatusManager
    {
        #region Constants
        private const string SHIPPINGTATUSES_ALL_KEY = "Nop.shippingstatus.all";
        private const string SHIPPINGTATUSES_BY_ID_KEY = "Nop.shippingstatus.id-{0}";
        private const string SHIPPINGTATUSES_PATTERN_KEY = "Nop.shippingstatus.";
        #endregion

        #region Utilities
        private static ShippingStatusCollection DBMapping(DBShippingStatusCollection dbCollection)
        {
            if (dbCollection == null)
                return null;

            var collection = new ShippingStatusCollection();
            foreach (var dbItem in dbCollection)
            {
                var item = DBMapping(dbItem);
                collection.Add(item);
            }

            return collection;
        }

        private static ShippingStatus DBMapping(DBShippingStatus dbItem)
        {
            if (dbItem == null)
                return null;

            var item = new ShippingStatus();
            item.ShippingStatusId = dbItem.ShippingStatusId;
            item.Name = dbItem.Name;

            return item;
        }
        #endregion

        #region Methods

        /// <summary>
        /// Gets a shipping status full name
        /// </summary>
        /// <param name="shippingStatusId">Shipping status identifier</param>
        /// <returns>Shipping status name</returns>
        public static string GetShippingStatusName(int shippingStatusId)
        {
            var shippingStatus = GetShippingStatusById(shippingStatusId);
            if (shippingStatus != null)
            {
                string name = string.Empty;
                if (NopContext.Current != null)
                {
                    name = LocalizationManager.GetLocaleResourceString(string.Format("ShippingStatus.{0}", (ShippingStatusEnum)shippingStatus.ShippingStatusId), NopContext.Current.WorkingLanguage.LanguageId, true, shippingStatus.Name);
                }
                else
                {
                    name = shippingStatus.Name;
                }
                return name;
            }
            else
            {
                return ((ShippingStatusEnum)shippingStatusId).ToString();
            }
        }

        /// <summary>
        /// Gets a shipping status by identifier
        /// </summary>
        /// <param name="shippingStatusId">Shipping status identifier</param>
        /// <returns>Shipping status</returns>
        public static ShippingStatus GetShippingStatusById(int shippingStatusId)
        {
            if (shippingStatusId == 0)
                return null;

            string key = string.Format(SHIPPINGTATUSES_BY_ID_KEY, shippingStatusId);
            object obj2 = NopCache.Get(key);
            if (ShippingStatusManager.CacheEnabled && (obj2 != null))
            {
                return (ShippingStatus)obj2;
            }

            var dbItem = DBProviderManager<DBShippingStatusProvider>.Provider.GetShippingStatusById(shippingStatusId);
            var shippingStatus = DBMapping(dbItem);

            if (ShippingStatusManager.CacheEnabled)
            {
                NopCache.Max(key, shippingStatus);
            }
            return shippingStatus;
        }

        /// <summary>
        /// Gets all shipping statuses
        /// </summary>
        /// <returns>Shipping status collection</returns>
        public static ShippingStatusCollection GetAllShippingStatuses()
        {
            string key = string.Format(SHIPPINGTATUSES_ALL_KEY);
            object obj2 = NopCache.Get(key);
            if (ShippingStatusManager.CacheEnabled && (obj2 != null))
            {
                return (ShippingStatusCollection)obj2;
            }

            var dbCollection = DBProviderManager<DBShippingStatusProvider>.Provider.GetAllShippingStatuses();
            var shippingStatusCollection = DBMapping(dbCollection);
            
            if (ShippingStatusManager.CacheEnabled)
            {
                NopCache.Max(key, shippingStatusCollection);
            }
            return shippingStatusCollection;
        }

        #endregion

        #region Property
        /// <summary>
        /// Gets a value indicating whether cache is enabled
        /// </summary>
        public static bool CacheEnabled
        {
            get
            {
                return SettingManager.GetSettingValueBoolean("Cache.ShippingStatusManager.CacheEnabled");
            }
        }
        #endregion
    }
}