Functions/GenXdev.Data.Preferences/Remove-GenXdevPreference.ps1
|
############################################################################### <# .SYNOPSIS Removes a preference value from the GenXdev preferences store. .DESCRIPTION This function removes a preference value from both the local store and optionally from the default store. It provides two parameter sets - one for local removal only and another for removing from both local and default stores. The function ensures proper synchronization when modifying the default store. .PARAMETER Name Specifies the name of the preference to remove. This is required and can be provided via pipeline input. .PARAMETER RemoveDefault When specified, removes the preference from both the local and default stores. If not specified, only removes from the local store. .PARAMETER SessionOnly Use alternative settings stored in session for Data preferences like Language, Database paths, etc. .PARAMETER ClearSession Clear the session setting (Global variable) before retrieving. .PARAMETER PreferencesDatabasePath Database path for preference data files. .PARAMETER SkipSession Dont use alternative settings stored in session for Data preferences like Language, Database paths, etc. .EXAMPLE Remove-GenXdevPreference -Name "Theme" Removes the "Theme" preference from the local store only. .EXAMPLE removePreference "Theme" -RemoveDefault Removes the "Theme" preference from both local and default stores. #> function Remove-GenXdevPreference { [CmdletBinding( SupportsShouldProcess = $true )] [Alias("removePreference")] param( ####################################################################### [Parameter( Mandatory = $true, Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, HelpMessage = "The name of the preference to remove" )] [ValidateNotNullOrEmpty()] [string]$Name, ####################################################################### [Parameter( Mandatory = $false, Position = 1, ParameterSetName = 'All', HelpMessage = "Switch to also remove the preference from defaults" )] [switch]$RemoveDefault, ####################################################################### [Parameter( Mandatory = $false, HelpMessage = ("Use alternative settings stored in session for " + "Data preferences like Language, Database paths, etc") )] [string]$PreferencesDatabasePath, ####################################################################### [Parameter( Mandatory = $false, HelpMessage = ("Use alternative settings stored in session for " + "Data preferences like Language, Database paths, etc") )] [switch]$SessionOnly, ####################################################################### [Parameter( Mandatory = $false, HelpMessage = ("Clear the session setting (Global variable) " + "before retrieving") )] [switch]$ClearSession, ####################################################################### [Parameter( Mandatory = $false, HelpMessage = ("Dont use alternative settings stored in session " + "for Data preferences like Language, Database " + "paths, etc") )] [Alias("FromPreferences")] [switch]$SkipSession ####################################################################### ) begin { # copy identical parameter values to prepare for database path lookup $params = GenXdev.Helpers\Copy-IdenticalParamValues ` -BoundParameters $PSBoundParameters ` -FunctionName "GenXdev.Data\Get-GenXdevPreferencesDatabasePath" ` -DefaultValues (Microsoft.PowerShell.Utility\Get-Variable ` -Scope Local ` -ErrorAction SilentlyContinue) # resolve the actual database path using the helper function $PreferencesDatabasePath = ` GenXdev.Data\Get-GenXdevPreferencesDatabasePath @params # create global variable name for this preference $globalVariableName = "GenXdevPreference_$Name" # output verbose information about the database path being used Microsoft.PowerShell.Utility\Write-Verbose ` "Using database path: $PreferencesDatabasePath" # output verbose information about the operation start Microsoft.PowerShell.Utility\Write-Verbose ("Starting preference " + "removal for: $Name") } process { # handle clearing session variables first if requested if ($ClearSession) { # confirm the operation with the user before proceeding if ($PSCmdlet.ShouldProcess( "GenXdev.Data Preference Configuration", "Clear session preference setting: $Name" )) { # clear the global variable Microsoft.PowerShell.Utility\Set-Variable ` -Name $globalVariableName ` -Value $null ` -Scope Global ` -Force # output verbose confirmation of session clearing Microsoft.PowerShell.Utility\Write-Verbose ( "Cleared session preference setting: $globalVariableName") } return } # handle session-only removal if ($SessionOnly) { # confirm the operation with the user before proceeding if ($PSCmdlet.ShouldProcess( "GenXdev.Data Preference Configuration", "Remove session-only preference: $Name" )) { # clear the global variable for session-only removal Microsoft.PowerShell.Utility\Set-Variable ` -Name $globalVariableName ` -Value $null ` -Scope Global ` -Force # output verbose confirmation of session-only removal Microsoft.PowerShell.Utility\Write-Verbose ( "Removed session-only preference: $globalVariableName") } return } # check if the operation should proceed based on whatif/confirm if ($PSCmdlet.ShouldProcess($Name, "Remove preference")) { # clear session variable for this preference if not SkipSession if (-not $SkipSession) { Microsoft.PowerShell.Utility\Set-Variable ` -Name $globalVariableName ` -Value $null ` -Scope Global ` -Force Microsoft.PowerShell.Utility\Write-Verbose ( "Cleared session variable: $globalVariableName") } # output verbose information about local store removal Microsoft.PowerShell.Utility\Write-Verbose ("Removing preference " + "from local store") # copy identical parameter values for Remove-KeyFromStore $removeLocalParams = GenXdev.Helpers\Copy-IdenticalParamValues ` -BoundParameters $PSBoundParameters ` -FunctionName "GenXdev.Data\Remove-KeyFromStore" ` -DefaultValues (Microsoft.PowerShell.Utility\Get-Variable ` -Scope Local ` -ErrorAction SilentlyContinue) # assign specific parameters for local store removal $removeLocalParams.StoreName = "GenXdev.PowerShell.Preferences" $removeLocalParams.KeyName = $Name $removeLocalParams.SynchronizationKey = "Local" $removeLocalParams.DatabasePath = $PreferencesDatabasePath # remove the preference key from the local store GenXdev.Data\Remove-KeyFromStore @removeLocalParams # check if removal from default store is also requested if ($RemoveDefault) { # output verbose information about default store removal Microsoft.PowerShell.Utility\Write-Verbose ("Removing " + "preference from default store") # copy identical parameter values for Remove-KeyFromStore $removeDefaultParams = GenXdev.Helpers\Copy-IdenticalParamValues ` -BoundParameters $PSBoundParameters ` -FunctionName "GenXdev.Data\Remove-KeyFromStore" ` -DefaultValues (Microsoft.PowerShell.Utility\Get-Variable ` -Scope Local ` -ErrorAction SilentlyContinue) # assign specific parameters for default store removal $removeDefaultParams.StoreName = "GenXdev.PowerShell.Preferences" $removeDefaultParams.KeyName = $Name $removeDefaultParams.SynchronizationKey = "Defaults" $removeDefaultParams.DatabasePath = $PreferencesDatabasePath # remove the preference key from the default store GenXdev.Data\Remove-KeyFromStore @removeDefaultParams # output verbose information about synchronization Microsoft.PowerShell.Utility\Write-Verbose ("Synchronizing " + "default store changes") # copy identical parameter values for Sync-KeyValueStore $syncParams = GenXdev.Helpers\Copy-IdenticalParamValues ` -BoundParameters $PSBoundParameters ` -FunctionName "GenXdev.Data\Sync-KeyValueStore" ` -DefaultValues (Microsoft.PowerShell.Utility\Get-Variable ` -Scope Local ` -ErrorAction SilentlyContinue) # assign specific parameters for synchronization $syncParams.SynchronizationKey = "Defaults" $syncParams.DatabasePath = $PreferencesDatabasePath # synchronize the changes to ensure consistency $null = GenXdev.Data\Sync-KeyValueStore @syncParams } # output verbose information about operation completion Microsoft.PowerShell.Utility\Write-Verbose ("Preference removal " + "completed") } } end { } } ############################################################################### |