Add PHP Switcher feature, that lets you switching the "current" PHP version

Author: mlocati

PhpManager/PhpManager.psd1

@@ -19,7 +19,7 @@
 	# TypesToProcess = @()
 	# FormatsToProcess = @()
 	# NestedModules = @()
-	FunctionsToExport = 'Get-PhpAvailableVersion', 'Install-Php', 'Update-Php', 'Uninstall-Php', 'Get-Php', 'Set-PhpIniKey', 'Get-PhpIniKey', 'Get-PhpExtension', 'Enable-PhpExtension', 'Disable-PhpExtension', 'Install-PhpExtension', 'Update-PhpCAInfo', 'Set-PhpDownloadCache', 'Get-PhpDownloadCache'
+	FunctionsToExport = 'Get-PhpAvailableVersion', 'Install-Php', 'Update-Php', 'Uninstall-Php', 'Get-Php', 'Set-PhpIniKey', 'Get-PhpIniKey', 'Get-PhpExtension', 'Enable-PhpExtension', 'Disable-PhpExtension', 'Install-PhpExtension', 'Update-PhpCAInfo', 'Set-PhpDownloadCache', 'Get-PhpDownloadCache', 'Initialize-PhpSwitcher', 'Add-PhpToSwitcher', 'Remove-PhpFromSwitcher', 'Switch-Php', 'Move-PhpSwitcher', 'Remove-PhpSwitcher'
 	CmdletsToExport = ''
 	VariablesToExport = ''
 	AliasesToExport = ''

PhpManager/private/Get-PhpManagerConfigurationKey.ps1

@@ -11,13 +11,22 @@ Function Get-PhpManagerConfigurationKey
         [Parameter(Mandatory = $True, Position = 0)]
         [ValidateNotNull()]
         [ValidateLength(1, [int]::MaxValue)]
-        [string]$Key
+        [string]$Key,
+        [Parameter(Mandatory = $False, Position = 1)]
+        [ValidateSet('Any', 'CurrentUser', 'AllUsers')]
+        [string]$Scope = 'Any'
     )
     Begin {
         $result = $null
     }
     Process {
-        $folders = @($Env:LOCALAPPDATA, $Env:ProgramData)
+        If ($Scope -eq 'CurrentUser') {
+            $folders = @($Env:LOCALAPPDATA)
+        } ElseIf ($Scope -eq 'AllUsers') {
+            $folders = @($Env:ProgramData)
+        } Else {
+            $folders = @($Env:LOCALAPPDATA, $Env:ProgramData)
+        }
         ForEach ($folder in $folders) {
             If ($folder) {
                 $path = Join-Path -Path $folder -ChildPath 'phpmanager.json'

PhpManager/private/Get-PhpSwitcher.ps1

@@ -0,0 +1,47 @@
+Function Get-PhpSwitcher
+{
+    <#
+    .Synopsis
+    Gets the currently configured PHP Switcher (if configured).
+
+    .Outputs
+    PSCustomObject|$null
+    #>
+    Begin {
+        $result = $null
+    }
+    Process {
+        $scope = 'CurrentUser'
+        $data = Get-PhpManagerConfigurationKey -Key 'PHP_SWITCHER' -Scope $scope
+        If ($data -eq $null) {
+            $scope = 'AllUsers'
+            $data = Get-PhpManagerConfigurationKey -Key 'PHP_SWITCHER' -Scope $scope
+        }
+        If ($data -ne $null) {
+            $result = New-Object PSObject
+            $result | Add-Member -MemberType NoteProperty -Name 'Scope' -Value $scope
+            $alias = ''
+            If ($data | Get-Member -Name 'Alias') {
+                If ($data.Alias) {
+                    $alias = [string]$data.Alias
+                }
+            }
+            $result | Add-Member -MemberType NoteProperty -Name 'Alias' -Value $alias
+            $targets = @{}
+            If ($data | Get-Member -Name 'Targets') {
+                Try {
+                    $data.Targets.PSObject.Properties | ForEach-Object {
+                        $targets[$_.Name] = [string] $_.Value
+                    }
+                }
+                Catch {
+                    Write-Debug $_.Exception.Message
+                }
+            }
+            $result | Add-Member -MemberType NoteProperty -Name 'Targets' -Value $targets
+        }
+    }
+    End {
+        $result
+    }
+}

PhpManager/private/Install-PhpFromUrl.ps1

@@ -113,6 +113,26 @@ function Install-PhpFromUrl() {
             }
             Write-Debug "Extracting $temporaryFile to destination directory"
             Expand-Archive -LiteralPath $temporaryFile -DestinationPath $Path -Force
+            Try {
+                $apacheFile = [System.IO.Path]::Combine($Path, 'Apache.conf')
+                If (-Not(Test-Path -LiteralPath $apacheFile)) {
+                    $apacheDlls = @(Get-ChildItem -LiteralPath $Path -Filter 'php*apache*.dll')
+                    If ($apacheDlls.Count -gt 1) {
+                        $apacheDlls = $apacheDlls | Where-Object { $_.BaseName -match '^php(\d+(_\d+)*)apache(\d+(_\d+)*)$' }
+                    }
+                    If ($apacheDlls.Count -eq 1) {
+                        $match = $apacheDlls[0].BaseName | Select-String -Pattern '^php(\d+(?:_\d+)*)apache(?:\d+(?:_\d+)*)$'
+                        If ($match) {
+                            $moduleName = 'php' + $match.Matches[0].Groups[1].Value + '_module'
+                            $fullName = $apacheDlls[0].FullName
+                            Set-Content -LiteralPath $apacheFile -Value "LoadModule $moduleName ""$fullName"""
+                        }
+                    }
+                }
+            }
+            Catch {
+                Write-Debug 'Failed to configure the Apache.conf file'
+            }
         } Finally {
             If (-Not($keepTemporaryFile)) {
                 Try {

PhpManager/private/Set-PhpManagerConfigurationKey.ps1

@@ -47,7 +47,7 @@ Function Set-PhpManagerConfigurationKey
     }
     Process {
         If ($null -eq $Value) {
-            $json.PSObject.Properties.Remove($key)
+            $json.PSObject.Properties.Remove($Key)
         } Else {
             $json | Add-Member -MemberType NoteProperty -Name $Key -Value $Value -Force
         }

PhpManager/public/Add-PhpToSwitcher.ps1

@@ -0,0 +1,57 @@
+Function Add-PhpToSwitcher
+{
+    <#
+    .Synopsis
+    Adds a PHP installation to the PHP Switcher.
+
+    .Parameter Name
+    The symbolic name to give to the PHP installation.
+
+    .Parameter Path
+    The path to an existing PHP installation to be added to the PHP Switcher.
+
+    .Parameter Force
+    Force adding the PHP installation to the PHP Switcher even if another installation is already defined with the specified name.
+
+    .Example
+    Initialize-PhpSwitcher C:\PHP
+    Add-PhpToSwitcher 5.6 C:\PHP5.6
+    Add-PhpToSwitcher 7.2 C:\PHP7.2
+    Switch-Php 5.6
+    #>
+    Param (
+        [Parameter(Mandatory = $True, Position = 0, HelpMessage = 'The symbolic name to give to the PHP installation')]
+        [ValidateNotNull()]
+        [ValidateLength(1, [int]::MaxValue)]
+        [string]$Name,
+        [Parameter(Mandatory = $True, Position = 1, HelpMessage = 'The path to an existing PHP installation to be added to the PHP Switcher')]
+        [ValidateNotNull()]
+        [ValidateLength(1, [int]::MaxValue)]
+        [string]$Path,
+        [switch]$Force
+    )
+    Begin {
+    }
+    Process {
+        $switcher = Get-PhpSwitcher
+        if ($null -eq $switcher) {
+            Throw 'PHP Switcher is not initialized: you can initialize it with the Initialize-PhpSwitcher command'
+        }
+        If ($switcher.Targets.ContainsKey($Name) -and -Not($Force)) {
+            Throw "Another PHP installation (" + $switcher.Targets[$Name] + ") is already assigned to the PHP Switcher with the name $Name. Use the -Force flag to force the operation anyway."
+        }
+        $Path = [System.IO.Path]::GetFullPath($Path)
+        If (-Not(Test-Path -LiteralPath $Path -PathType Container)) {
+            Throw "Unable to find the folder $Path"
+        }
+        $pathInfo = Get-Item -LiteralPath $Path
+        If ($pathInfo.LinkType -eq 'Junction') {
+            Throw "$Path must be a regular directory (it is a junction)."
+        }
+        Get-PhpVersionFromPath -Path $Path | Out-Null
+        $switcher.Targets[$Name] = $Path
+        Set-PhpManagerConfigurationKey -Key 'PHP_SWITCHER' -Value $switcher -Scope $switcher.Scope
+    }
+    End {
+    }
+}

PhpManager/public/Initialize-PhpSwitcher.ps1

@@ -0,0 +1,69 @@
+Function Initialize-PhpSwitcher
+{
+    <#
+    .Synopsis
+    Initializes the PHP Switcher.
+
+    .Parameter Alias
+    The path where PHP will be visible when switching to a PHP version.
+
+    .Parameter Scope
+    Initialize the PHP Switcher for the current user only ('CurrentUser' - default), or for any user ('AllUsers').
+
+    .Parameter Force
+    Force the creation of a PHP Switcher even if there's already an existing switcher.
+
+    .Example
+    Initialize-PhpSwitcher C:\PHP
+    Add-PhpToSwitcher 5.6 C:\PHP5.6
+    Add-PhpToSwitcher 7.2 C:\PHP7.2
+    Switch-Php 5.6
+    #>
+    Param (
+        [Parameter(Mandatory = $True, Position = 0, HelpMessage = 'The path where PHP will be visible when switching to a PHP version')]
+        [ValidateNotNull()]
+        [ValidateLength(1, [int]::MaxValue)]
+        [string]$Alias,
+        [Parameter(Mandatory = $False, Position = 99, HelpMessage = 'Initialize the PHP Switcher for the current user only (''CurrentUser''), or for any user (''AllUsers'')')]
+        [ValidateSet('CurrentUser', 'AllUsers')]
+        [string]$Scope = 'CurrentUser',
+        [switch]$Force
+    )
+    Begin {
+
+    }
+    Process {
+        $existingSwitcher = Get-PhpSwitcher
+        if ($null -ne $existingSwitcher) {
+            if ($Scope -eq 'AllUsers' -and $existingSwitcher.Scope -eq 'CurrentUser') {
+                Throw 'It''s not possible to create a PHP Switcher for all users while there''s a PHP Switcher for the current user.'
+            }
+            if ($Scope -eq $existingSwitcher.Scope) {
+                If (-Not($Force)) {
+                    Throw 'Another PHP Switcher already exists. You should delete it first (with the Remove-PhpSwitcher command), or use the -Force flag.'
+                }
+            } Else {
+                $existingSwitcher = $null
+            }
+        }
+        $newSwitcher = @{}
+        $Alias = [System.IO.Path]::GetFullPath($Alias)
+        If (Test-Path -LiteralPath $Alias -PathType Container) {
+            $aliasItem = Get-Item -LiteralPath $Alias
+            If ($aliasItem.LinkType -ne 'Junction') {
+                Throw "$Alias already exist and it's not a junction."
+            }
+        } ElseIf (Test-Path -LiteralPath $Alias) {
+            Throw "$Alias already exist and it's not a junction."
+        }
+        $newSwitcher.Alias = $Alias
+        $newSwitcher.Targets = @{}
+        If ($existingSwitcher) {
+            Remove-PhpSwitcher
+        }
+        Set-PhpManagerConfigurationKey -Key 'PHP_SWITCHER' -Value $newSwitcher -Scope $Scope
+        Write-Verbose 'The new PHP Switcher has been created.'
+    }
+    End {
+    }
+}

PhpManager/public/Move-PhpSwitcher.ps1

@@ -0,0 +1,69 @@
+Function Move-PhpSwitcher
+{
+    <#
+    .Synopsis
+    Changes the path will be visible when switching to a PHP version.
+
+    .Parameter NewAlias
+    The path where PHP will be visible when switching to a PHP version.
+
+    .Example
+    Move-PhpSwitcher C:\PHP
+    #>
+    Param (
+        [Parameter(Mandatory = $True, Position = 0, HelpMessage = 'The new path where PHP will be visible when switching to a PHP version')]
+        [ValidateNotNull()]
+        [ValidateLength(1, [int]::MaxValue)]
+        [string]$NewAlias
+    )
+    Begin {
+    }
+    Process {
+        $switcher = Get-PhpSwitcher
+        if ($null -eq $switcher) {
+            Throw 'PHP Switcher is not initialized: you can initialize it with the Initialize-PhpSwitcher command'
+        }
+        $NewAlias = [System.IO.Path]::GetFullPath($NewAlias)
+        $newAliasJunction = $null
+        If (Test-Path -LiteralPath $NewAlias -PathType Container) {
+            $newAliasJunction = Get-Item -LiteralPath $NewAlias
+            If ($newAliasJunction.LinkType -ne 'Junction') {
+                Throw "$NewAlias already exist and it's not a junction."
+            }
+        } ElseIf (Test-Path -LiteralPath $NewAlias) {
+            Throw "$NewAlias already exist and it's not a junction."
+        }
+        $oldAlias = $switcher.Alias
+        $dsc = [System.IO.Path]::DirectorySeparatorChar
+        If ($oldAlias.TrimEnd($dsc) -ne $NewAlias.TrimEnd($dsc)) {
+            $recreateAs = $null
+            If (Test-Path -LiteralPath $oldAlias -PathType Container) {
+                $oldAliasItem = Get-Item -LiteralPath $oldAlias
+                If ($oldAliasItem.LinkType -eq 'Junction') {
+                    If ($oldAliasItem | Get-Member -Name 'Target') {
+                        $s = [string]$oldAliasItem.Target
+                        If (Test-Path -LiteralPath $s -PathType Container) {
+                            $sItem = Get-Item -LiteralPath $s
+                            If (-Not($sItem.LinkType)) {
+                                $recreateAs = $s
+                            }
+                        }
+                    }
+                    Remove-PhpFolderFromPath -Path $oldAlias
+                    Remove-Item -LiteralPath $oldAlias -Recurse -Force
+                }
+            }
+            $switcher.Alias = $NewAlias
+            If ($recreateAs -ne $null) {
+                If ($newAliasJunction -ne $null) {
+                    Remove-Item -LiteralPath $NewAlias -Recurse -Force
+                }
+                New-Item -ItemType Junction -Path $NewAlias -Value $recreateAs | Out-Null
+                Add-PhpFolderToPath -Path $NewAlias -Persist $(If ($switcher.Scope -eq 'AllUsers') { 'System' } Else { 'User' } ) -CurrentProcess
+            }
+            Set-PhpManagerConfigurationKey -Key 'PHP_SWITCHER' -Value $switcher -Scope $switcher.Scope
+        }
+    }
+    End {
+    }
+}

PhpManager/public/Remove-PhpFromSwitcher.ps1

@@ -0,0 +1,53 @@
+Function Remove-PhpFromSwitcher
+{
+    <#
+    .Synopsis
+    Removes a PHP installation from the PHP Switcher.
+
+    .Parameter Name
+    The symbolic name of the PHP installation to be removed from the PHP Switcher.
+    If no symbolic name exists with this name, nothing occurs.
+
+    .Parameter Force
+    Force removing the PHP installation from the PHP Switcher even if it is the currently active one.
+
+    .Example
+    Initialize-PhpSwitcher C:\PHP
+    Add-PhpToSwitcher 5.6 C:\PHP5.6
+    Add-PhpToSwitcher 7.2 C:\PHP7.2
+    Remove-PhpFromSwitcher 5.6
+    #>
+    Param (
+        [Parameter(Mandatory = $True, Position = 0, HelpMessage = 'The symbolic name of the PHP installation to be removed from the PHP Switcher')]
+        [ValidateNotNull()]
+        [ValidateLength(1, [int]::MaxValue)]
+        [string]$Name,
+        [switch]$Force
+    )
+    Begin {
+    }
+    Process {
+        $switcher = Get-PhpSwitcher
+        if ($null -eq $switcher) {
+            Throw 'PHP Switcher is not initialized: you can initialize it with the Initialize-PhpSwitcher command'
+        }
+        If ($switcher.Targets.ContainsKey($Name)) {
+            If (-Not($Force)) {
+                If (Test-Path -LiteralPath $switcher.Alias -PathType Container) {
+                    $aliasItem = Get-Item -LiteralPath $switcher.Alias
+                    If ($aliasItem.LinkType -eq 'Junction') {
+                        $aliasTarget = [string]$aliasItem.Target
+                        $dsc = [System.IO.Path]::DirectorySeparatorChar
+                        if ($aliasTarget.TrimEnd($dsc) -eq $switcher.Targets[$Name].TrimEnd($dsc)) {
+                            Throw "$Name is the currently active version for the PHP Switcher. Use -Force to remove it anyway."
+                        }
+                    }
+                }
+            }
+            $switcher.Targets.Remove($Name)
+            Set-PhpManagerConfigurationKey -Key 'PHP_SWITCHER' -Value $switcher -Scope $switcher.Scope
+        }
+    }
+    End {
+    }
+}

PhpManager/public/Remove-PhpSwitcher.ps1

@@ -0,0 +1,23 @@
+Function Remove-PhpSwitcher
+{
+    Begin {
+    }
+    Process {
+        $switcher = Get-PhpSwitcher
+        If ($switcher -ne $null) {
+            Remove-PhpFolderFromPath -Path $switcher.Alias
+            If (Test-Path -LiteralPath $switcher.Alias -PathType Container) {
+                $aliasItem = Get-Item -LiteralPath $switcher.Alias
+                If ($aliasItem.LinkType -eq 'Junction') {
+                    Remove-Item -LiteralPath $switcher.Alias -Force -Recurse
+                }
+            }
+            Set-PhpManagerConfigurationKey -Key 'PHP_SWITCHER' -Value $null -Scope $switcher.Scope
+            Write-Output ('The PHP Switcher has been deleted (scope: ' + $switcher.Scope + ').')
+        } Else {
+            Write-Output 'No PHP Switcher is defined.'
+        }
+    }
+    End {
+    }
+}