Class PackageUninstallation

com.woltlab.wcf.acp.package

Description

PackageUninstallation executes package uninstallations.

  • author: Marcel Werk
  • copyright: 2001-2009 WoltLab GmbH
  • license: GNU
PackageInstallationQueue
   |
   --PackageUninstallation

Direct descendents

Class Description
PackageInstallationRollback PackageInstallationRollback extends PackageUninstallation for a rollback during the installation of a package.

Variable Summary

Type Name
mixed $pipSortOrder
mixed $stepAfterPIP

Method Summary

Return Name
PackageUninstallation __construct(integer $queueID)
static void addQueueEntries(Package $package, [array $packages = array()])
void assignPackageInfo()
void calcProgress( $currentStep)
static void checkDependencies()
void checkPackageRequirements()
void deleteFiles(string $targetDir, string $files, [booelan $deleteEmptyTargetDir = false], [boolean $deleteEmptyDirectories = true])
string finishUninstallation()
void getInstallationInfo()
static array getPackageDependencies(integer $packageID)
void getTotalStep()
void openPackage(array $info)
void showInstallationFrame()
void startUninstallation()
void uninstall()
void uninstallPackage()
void uninstallPackageInstallationPlugins()

Variables

$pipSortOrder

protected mixed $pipSortOrder = 'ASC'

Redefinition of: PackageInstallationQueue::$pipSortOrder

$stepAfterPIP

protected mixed $stepAfterPIP = 'packageInstallationPlugins'

Redefinition of: PackageInstallationQueue::$stepAfterPIP

Inherited variables from PackageInstallationQueue

PackageInstallationQueue::$action, PackageInstallationQueue::$cancelable, PackageInstallationQueue::$confirmInstallation, PackageInstallationQueue::$done, PackageInstallationQueue::$nextStep, PackageInstallationQueue::$package, PackageInstallationQueue::$packageID, PackageInstallationQueue::$packageType, PackageInstallationQueue::$parentQueueID, PackageInstallationQueue::$processNo, PackageInstallationQueue::$queueID, PackageInstallationQueue::$step

Methods

__construct

public PackageUninstallation __construct(integer $queueID)

Creates a new PackageUninstallation object.

Parameters:

  • $queueID

Redefinition of: PackageInstallationQueue::__construct()

addQueueEntries

public static void addQueueEntries(Package $package, [array $packages = array()])

Adds an uninstall entry to the package installation queue.

Parameters:

  • $package
  • $packages

assignPackageInfo

protected void assignPackageInfo()

  • see: PackageInstallationQueue::assignPackageInfo();

Redefinition of: PackageInstallationQueue::assignPackageInfo()

Redefined in descendants as: PackageInstallationRollback::assignPackageInfo()

calcProgress

protected void calcProgress( $currentStep)

Parameters:

  • $currentStep

Redefinition of: PackageInstallationQueue::calcProgress()

checkDependencies

public static void checkDependencies()

Checks whether this package is required by other packages.

If so than a template will be displayed to warn the user that a further uninstallation will uninstall also the dependent packages

checkPackageRequirements

protected void checkPackageRequirements()

Does nothing.

Redefined in descendants as: PackageInstallationRollback::checkPackageRequirements()

deleteFiles

public void deleteFiles(string $targetDir, string $files, [booelan $deleteEmptyTargetDir = false], [boolean $deleteEmptyDirectories = true])

Deletes the given list of files from the target dir.

Parameters:

  • $targetDir
  • $files
  • $deleteEmptyDirectories
  • $deleteEmptyTargetDir

finishUninstallation

protected string finishUninstallation()

Finalises uninstallation of this package.

  • return: nextStep

Redefined in descendants as: PackageInstallationRollback::finishUninstallation()

getInstallationInfo

protected void getInstallationInfo()

Redefinition of: PackageInstallationQueue::getInstallationInfo()

getPackageDependencies

protected static array getPackageDependencies(integer $packageID)

Get all packages which require this package.

Parameters:

  • $packageID

getTotalStep

protected void getTotalStep()

Redefinition of: PackageInstallationQueue::getTotalStep()

openPackage

protected void openPackage(array $info)

Creates a Package object with the given package information.

Parameters:

  • $info

Redefined in descendants as: PackageInstallationRollback::openPackage()

showInstallationFrame

protected void showInstallationFrame()

Shows the uninstallation output frame.

Redefined in descendants as: PackageInstallationRollback::showInstallationFrame()

startUninstallation

protected void startUninstallation()

Starts the uninstallation of this package.

Redefined in descendants as: PackageInstallationRollback::startUninstallation()

uninstall

protected void uninstall()

Steps through the uninstallation process of a package.

Redefined in descendants as: PackageInstallationRollback::uninstall()

uninstallPackage

protected void uninstallPackage()

Removes package information from database.

uninstallPackageInstallationPlugins

protected void uninstallPackageInstallationPlugins()

Uninstalls all package installation plugins of this package.

Inherited methods from PackageInstallationQueue

PackageInstallationQueue::__construct(), PackageInstallationQueue::assignPackageInfo(), PackageInstallationQueue::assignQueueInfo(), PackageInstallationQueue::calcProgress(), PackageInstallationQueue::checkPackageInstallationQueue(), PackageInstallationQueue::checkSafeMode(), PackageInstallationQueue::executePackageInstallationPlugin(), PackageInstallationQueue::getAction(), PackageInstallationQueue::getCurrentStep(), PackageInstallationQueue::getInstallationInfo(), PackageInstallationQueue::getNewProcessNo(), PackageInstallationQueue::getNextPackageInstallationPlugin(), PackageInstallationQueue::getPackage(), PackageInstallationQueue::getPackageID(), PackageInstallationQueue::getPackageInstallationPlugin(), PackageInstallationQueue::getTotalStep(), PackageInstallationQueue::loadPackageInstallationPlugins(), PackageInstallationQueue::makeClear(), PackageInstallationQueue::openQueue(), PackageInstallationQueue::showPackageInstallationException()