// Copyright (C) Stichting Deltares 2017. All rights reserved.
//
// This file is part of the Dam Engine.
//
// The Dam Engine is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
// All names, logos, and references to "Deltares" are registered trademarks of
// Stichting Deltares and remain full property of Stichting Deltares at all times.
// All rights reserved.

namespace Deltares.DamEngine.Data.Standard.Language
{
    /// <summary>
    /// Helper class with methods related to localization and globalization.
    /// </summary>
    /// <seealso cref="LocalizationManager"/>
    public static class TranslateHelper
    {
        /// <summary>
        /// Retrieves a translatable string using an ID.
        /// </summary>
        /// <param name="anObject">The object used to retrieve the Translations.xml by reflection.</param>
        /// <param name="id">The ID in the Translations.xml.</param>
        /// <returns>
        /// The translated string if <paramref name="id" /> exists; otherwise returns id />.
        /// </returns>
        /// <remarks>
        /// This class does not properly deal when called further down the inheritance tree.
        /// Use <see cref="LocalizationManager" /> instead when you know or expect the class
        /// will be inherited from, such as base classes.
        /// </remarks>
        /// <seealso cref="LocalizationManager" />
        public static string Translate(this object anObject, string id)
        {
            return LocalizationManager.GetTranslatedText(anObject.GetType(), id);
        }
    }
}