DomainManagement

1.9.228

internal/functions/Compare-Property.ps1

function Compare-Property {
<#
    .SYNOPSIS
        Helper function simplifying the changes processing.
     
    .DESCRIPTION
        Helper function simplifying the changes processing.
     
    .PARAMETER Property
        The property to use for comparison.
     
    .PARAMETER Configuration
        The object that was used to define the desired state.
     
    .PARAMETER ADObject
        The AD Object containing the actual state.
     
    .PARAMETER Changes
        An arraylist where changes get added to.
        The content of -Property will be added if the comparison fails.
     
    .PARAMETER Resolve
        Whether the value on the configured object's property should be string-resolved.
     
    .PARAMETER ADProperty
        The property on the ad object to use for the comparison.
        If this parameter is not specified, it uses the value from -Property.
     
    .PARAMETER Parameters
        AD Parameters to pass through for Resolve-String.
     
    .PARAMETER AsString
        Compare properties as string.
        Will convert all $null values to "".
 
    .PARAMETER AsUpdate
        The result added to the changes arraylist is a custom object with greater details than the default.
 
    .PARAMETER Type
        What kind of component is the compared object part of.
        Used together with the -AsUpdate parameter to name the resulting object.
 
    .PARAMETER NullValue
        In case the AD Object is of value $null, what value should be used for the comparison?
        This enables simple comparisons where a $null value maps to a default value.
     
    .EXAMPLE
        PS C:\> Compare-Property -Property Description -Configuration $ouDefinition -ADObject $adObject -Changes $changes -Resolve
         
        Compares the description on the configuration object (after resolving it) with the one on the ADObject and adds to $changes if they are inequal.
#>
    
    [CmdletBinding()]
    Param (
        [Parameter(Mandatory = $true)]
        [string]
        $Property,

        [Parameter(Mandatory = $true)]
        [object]
        $Configuration,

        [Parameter(Mandatory = $true)]
        [object]
        $ADObject,

        [Parameter(Mandatory = $true)]
        [AllowEmptyCollection()]
        [System.Collections.ArrayList]
        $Changes,

        [switch]
        $Resolve,

        [string]
        $ADProperty,
        
        [hashtable]
        $Parameters = @{ },
        
        [switch]
        $AsString,

        [switch]
        $AsUpdate,

        [string]
        $Type = 'Unknown',

        [object]
        $NullValue = $null
    )
    
    begin {
        if (-not $ADProperty) { $ADProperty = $Property }
    }
    process {
        $param = @{
            Property = $Property
            Identity = $ADObject.DistinguishedName
            Type = $Type
        }
        $propValue = $Configuration.$Property
        if ($Resolve) { $propValue = $propValue | Resolve-String @parameters }

        $adValue = $ADObject.$ADProperty
        if ($null -eq $adValue) { $adValue = $NullValue }

        if (($propValue -is [System.Collections.ICollection]) -and ($adValue -is [System.Collections.ICollection])) {
            if (Compare-Object $propValue $adValue) {
                if ($AsUpdate) { $null = $Changes.Add((New-Change @param -NewValue $propValue -OldValue $adValue)) }
                else { $null = $Changes.Add($Property) }
            }
        }
        elseif ($AsString) {
            if ("$propValue" -ne "$adValue") {
                if ($AsUpdate) { $null = $Changes.Add((New-Change @param -NewValue "$propValue" -OldValue "$($adValue)")) }
                else { $null = $Changes.Add($Property) }
            }
        }
        elseif ($propValue -ne $adValue) {
            if ($AsUpdate) { $null = $Changes.Add((New-Change @param -NewValue $propValue -OldValue $adValue)) }
            else { $null = $Changes.Add($Property) }
        }
    }
}