PaymentStatusManager.cs :  » Web-Frameworks » nopCommerce » NopSolutions » NopCommerce » BusinessLogic » Payment » 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.Payment;

namespace NopSolutions.NopCommerce.BusinessLogic.Payment{
    /// <summary>
    /// Payment status manager
    /// </summary>
    public partial class PaymentStatusManager
    {
        #region Constants
        private const string PAYMENTSTATUSES_ALL_KEY = "Nop.paymentstatus.all";
        private const string PAYMENTSTATUSES_BY_ID_KEY = "Nop.paymentstatus.id-{0}";
        private const string PAYMENTSTATUSES_PATTERN_KEY = "Nop.paymentstatus.";
        #endregion

        #region Utilities
        private static PaymentStatusCollection DBMapping(DBPaymentStatusCollection dbCollection)
        {
            if (dbCollection == null)
                return null;

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

            return collection;
        }

        private static PaymentStatus DBMapping(DBPaymentStatus dbItem)
        {
            if (dbItem == null)
                return null;

            var item = new PaymentStatus();
            item.PaymentStatusId = dbItem.PaymentStatusId;
            item.Name = dbItem.Name;

            return item;
        }
        #endregion

        #region Methods

        /// <summary>
        /// Gets a payment status full name
        /// </summary>
        /// <param name="paymentStatusId">Payment status identifier</param>
        /// <returns>Payment status name</returns>
        public static string GetPaymentStatusName(int paymentStatusId)
        {
            var paymentStatus = GetPaymentStatusById(paymentStatusId);
            if (paymentStatus != null)
            {
                string name = string.Empty;
                if (NopContext.Current != null)
                {
                    name = LocalizationManager.GetLocaleResourceString(string.Format("PaymentStatus.{0}", (PaymentStatusEnum)paymentStatus.PaymentStatusId), NopContext.Current.WorkingLanguage.LanguageId, true, paymentStatus.Name);
                }
                else
                {
                    name = paymentStatus.Name;
                }
                return name;
            }
            else
            {
                return ((PaymentStatusEnum)paymentStatusId).ToString();
            }
        }

        /// <summary>
        /// Gets a payment status by identifier
        /// </summary>
        /// <param name="paymentStatusId">payment status identifier</param>
        /// <returns>Payment status</returns>
        public static PaymentStatus GetPaymentStatusById(int paymentStatusId)
        {
            if (paymentStatusId == 0)
                return null;

            string key = string.Format(PAYMENTSTATUSES_BY_ID_KEY, paymentStatusId);
            object obj2 = NopCache.Get(key);
            if (PaymentStatusManager.CacheEnabled && (obj2 != null))
            {
                return (PaymentStatus)obj2;
            }

            var dbItem = DBProviderManager<DBPaymentStatusProvider>.Provider.GetPaymentStatusById(paymentStatusId);
            var paymentStatus = DBMapping(dbItem);

            if (PaymentStatusManager.CacheEnabled)
            {
                NopCache.Max(key, paymentStatus);
            }
            return paymentStatus;
        }

        /// <summary>
        /// Gets all payment statuses
        /// </summary>
        /// <returns>Payment status collection</returns>
        public static PaymentStatusCollection GetAllPaymentStatuses()
        {
            string key = string.Format(PAYMENTSTATUSES_ALL_KEY);
            object obj2 = NopCache.Get(key);
            if (PaymentStatusManager.CacheEnabled && (obj2 != null))
            {
                return (PaymentStatusCollection)obj2;
            }

            var dbCollection = DBProviderManager<DBPaymentStatusProvider>.Provider.GetAllPaymentStatuses();
            var paymentStatusCollection = DBMapping(dbCollection);

            if (PaymentStatusManager.CacheEnabled)
            {
                NopCache.Max(key, paymentStatusCollection);
            }
            return paymentStatusCollection;
        }
        
        #endregion

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