Functions/GenXdev.Data.Preferences/Get-GenXdevPreference.cs
|
// ################################################################################
// Part of PowerShell module : GenXdev.Data.Preferences // Original cmdlet filename : Get-GenXdevPreference.cs // Original author : René Vaessen / GenXdev // Version : 1.302.2025 // ################################################################################ // Copyright (c) René Vaessen / GenXdev // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // ################################################################################ using System; using System.Collections; using System.Management.Automation; namespace GenXdev.Data.Preferences { /// <summary> /// <para type="synopsis"> /// Retrieves a preference value from the GenXdev preferences store. /// </para> /// /// <para type="description"> /// The function implements a two-tier preference retrieval system. It first checks /// the local store for a preference value. If not found, it falls back to the /// default store. If still not found, returns the provided default value. /// </para> /// /// <para type="description"> /// PARAMETERS /// </para> /// /// <para type="description"> /// -Name <String><br/> /// The name of the preference to retrieve from the preference stores.<br/> /// - <b>Position</b>: 0<br/> /// - <b>Mandatory</b>: true<br/> /// </para> /// /// <para type="description"> /// -DefaultValue <String><br/> /// The fallback value to return if the preference is not found in any store.<br/> /// - <b>Position</b>: 1<br/> /// - <b>Default</b>: null<br/> /// </para> /// /// <para type="description"> /// -PreferencesDatabasePath <String><br/> /// Database path for preference data files.<br/> /// - <b>Position</b>: named<br/> /// - <b>Mandatory</b>: false<br/> /// </para> /// /// <para type="description"> /// -SessionOnly <SwitchParameter><br/> /// Use alternative settings stored in session for Data preferences like Language, /// Database paths, etc.<br/> /// - <b>Position</b>: named<br/> /// - <b>Default</b>: false<br/> /// </para> /// /// <para type="description"> /// -ClearSession <SwitchParameter><br/> /// Clear the session setting (Global variable) before retrieving.<br/> /// - <b>Position</b>: named<br/> /// - <b>Default</b>: false<br/> /// </para> /// /// <para type="description"> /// -SkipSession <SwitchParameter><br/> /// Dont use alternative settings stored in session for Data preferences like /// Language, Database paths, etc.<br/> /// - <b>Aliases</b>: FromPreferences<br/> /// - <b>Position</b>: named<br/> /// - <b>Default</b>: false<br/> /// </para> /// /// <example> /// <para>Get-GenXdevPreference -Name "Theme" -DefaultValue "Dark"</para> /// <code> /// Get-GenXdevPreference -Name "Theme" -DefaultValue "Dark" /// </code> /// </example> /// /// <example> /// <para>getPreference "Theme" "Dark"</para> /// <code> /// getPreference "Theme" "Dark" /// </code> /// </example> /// </summary> [Cmdlet(VerbsCommon.Get, "GenXdevPreference")] [Alias("getPreference")] [OutputType(typeof(string))] public class GetGenXdevPreferenceCommand : PSGenXdevCmdlet { /// <summary> /// The name of the preference to retrieve /// </summary> [Parameter( Mandatory = true, Position = 0, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true, HelpMessage = "The name of the preference to retrieve" )] [ValidateNotNullOrEmpty] [Alias("PreferenceName")] public string Name { get; set; } /// <summary> /// The default value if preference is not found /// </summary> [Parameter( Mandatory = false, Position = 1, ValueFromPipelineByPropertyName = true, HelpMessage = "The default value if preference is not found" )] [AllowNull] [AllowEmptyString] [Alias("DefaultPreference")] public string DefaultValue { get; set; } /// <summary> /// Database path for preference data files /// </summary> [Parameter( Mandatory = false, HelpMessage = "Database path for preference data files" )] [Alias("DatabasePath")] public string PreferencesDatabasePath { get; set; } /// <summary> /// Use alternative settings stored in session for Data preferences like Language, /// Database paths, etc /// </summary> [Parameter( Mandatory = false, HelpMessage = "Use alternative settings stored in session for Data preferences like Language, Database paths, etc" )] public SwitchParameter SessionOnly { get; set; } /// <summary> /// Clear the session setting (Global variable) before retrieving /// </summary> [Parameter( Mandatory = false, HelpMessage = "Clear the session setting (Global variable) before retrieving" )] public SwitchParameter ClearSession { get; set; } /// <summary> /// Dont use alternative settings stored in session for Data preferences like /// Language, Database paths, etc /// </summary> [Parameter( Mandatory = false, HelpMessage = "Dont use alternative settings stored in session for Data preferences like Language, Database paths, etc" )] [Alias("FromPreferences")] public SwitchParameter SkipSession { get; set; } protected override void BeginProcessing() { } protected override void ProcessRecord() { WriteObject(GetGenXdevPreference(Name, DefaultValue, PreferencesDatabasePath, SessionOnly.ToBool(), ClearSession.ToBool(), SkipSession.ToBool())); } protected override void EndProcessing() { } } } |