PSPHPIPAM

1.3.8

Functions/Public/Sections/Remove-PhpIpamSection.ps1

<#
.SYNOPSIS
    Remove PhpIpam Section
.DESCRIPTION
    Remove PhpIpam Section
.EXAMPLE
    PS C:\> Remove-PhpIpamSection -ID 20
    PS C:\> Remove-PhpIpamSection -Name Section1
    PS C:\> New-PhpIpamSection -Param @{"name"="section5"}|Remove-PhpIpamSection
 
.INPUTS
    Inputs (if any)
.OUTPUTS
    Output (if any)
.NOTES
    General notes
#>
function Remove-PhpIpamSection{
    Param(
        [parameter(
            Mandatory=$true,
            ValueFromPipeline=$true,
            ValueFromPipelineByPropertyName=$true,
            Position=0,
            ParameterSetName="ByID"
        )]
        [int]$ID
        ,
        [parameter(
            Mandatory=$true,
            ValueFromPipeline=$true,
            ValueFromPipelineByPropertyName=$true,
            Position=0,
            ParameterSetName="ByName"
        )]
        [string]$Name
    )
    BEGIN{

    }
    PROCESS{
        if($PSCmdlet.ParameterSetName -eq 'ByID'){
            $r=Invoke-PhpIpamExecute -method delete -controller sections -params @{'id'=$id}
            if($r -and $r.success){
                return $true
            }else{
                return $false
            }
        }
        if($PSCmdlet.ParameterSetName -eq 'ByName'){
            try{
                $sections=(Invoke-PhpIpamExecute -method get -controller sections -identifiers @($name) -ErrorAction stop).data
                $sections|foreach-object{
                    Remove-PhpIpamSection -ID $_.id
                }
            }catch{
                # do nothing ,because if section do not exist ,it will cause exception
                # Section does not exist
            }
        }
    }
    END{

    }
}

Export-ModuleMember -Function Remove-PhpIpamSection