com.woltlab.wcf.acp.package
PackageInstallationQueue represents a database entry in the package_installation_queue table.
| Class | Description |
|---|---|
PackageInstallation |
PackageInstallation executes package installations and updates. |
PackageUninstallation |
PackageUninstallation executes package uninstallations. |
| Type | Name |
|---|---|
string |
$action |
boolean |
$cancelable |
boolean |
$confirmInstallation |
mixed |
$done |
mixed |
$nextStep |
Package |
$package |
integer |
$packageID |
string |
$packageType |
integer |
$parentQueueID |
mixed |
$pipSortOrder |
integer |
$processNo |
integer |
$queueID |
mixed |
$step |
mixed |
$stepAfterPIP |
| Return | Name |
|---|---|
PackageInstallationQueue |
__construct(integer $queueID)
|
void |
assignPackageInfo()
|
void |
assignQueueInfo()
|
void |
calcProgress(integer $currentStep)
|
static void |
checkPackageInstallationQueue()
|
resource |
checkSafeMode()
|
void |
executePackageInstallationPlugin(string $pluginName)
|
string |
getAction()
|
integer |
getCurrentStep(integer $currentStep)
|
array |
getInstallationInfo()
|
static integer |
getNewProcessNo()
|
string |
getNextPackageInstallationPlugin(string $currentStep)
|
Package |
getPackage()
|
integer |
getPackageID()
|
PackageInstallationPlugin |
getPackageInstallationPlugin(string $pluginName)
|
integer |
getTotalStep()
|
void |
loadPackageInstallationPlugins()
|
void |
makeClear()
|
static void |
openQueue([integer $parentQueueID = 0], [integer $processNo = 0])
|
void |
showPackageInstallationException(SystemException $e)
|
protected string $action
action
protected boolean $cancelable
true, if action is cancelable
protected boolean $confirmInstallation
true, if the user has to confirm the action
protected mixed $done
protected mixed $nextStep = ''
protected Package $package
package object
protected integer $packageID
id of package
protected string $packageType
type of package
protected integer $parentQueueID
id of parent queue entry
protected mixed $pipSortOrder = 'DESC'
Redefined in descendants as: PackageUninstallation::$pipSortOrder
protected integer $processNo
process number
protected integer $queueID
id of queue entry
public mixed $step = ''
protected mixed $stepAfterPIP = ''
Redefined in descendants as: PackageInstallation::$stepAfterPIP, PackageUninstallation::$stepAfterPIP
public PackageInstallationQueue __construct(integer $queueID)
Creates a new PackageInstallationQueue object.
$queueID Redefined in descendants as: PackageInstallation::__construct(), PackageInstallationInfo::__construct(), PackageUninstallation::__construct()
protected void assignPackageInfo()
Assigns the information of this package in the template engine.
Redefined in descendants as: PackageInstallation::assignPackageInfo(), PackageUninstallation::assignPackageInfo(), PackageInstallationRollback::assignPackageInfo()
protected void assignQueueInfo()
Assigns the information of this queue entry in the template engine.
protected void calcProgress(integer $currentStep)
Calculates the current state of the progress bar.
$currentStep Redefined in descendants as: PackageInstallation::calcProgress(), PackageUninstallation::calcProgress()
public static void checkPackageInstallationQueue()
Checks the package installation queue for outstanding entries.
public resource checkSafeMode()
Checks if PHP's safe_mode is enabled, and if so, cares for ftp access.
protected void executePackageInstallationPlugin(string $pluginName)
executes a package installation plugin
$pluginName Redefined in descendants as: PackageInstallationRollback::executePackageInstallationPlugin()
public string getAction()
Returns the current installation action.
protected integer getCurrentStep(integer $currentStep)
Returns the number of the current installation step.
$currentStep Redefined in descendants as: PackageInstallation::getCurrentStep()
protected array getInstallationInfo()
Loads all information about this installation.
Redefined in descendants as: PackageInstallation::getInstallationInfo(), PackageInstallationInfo::getInstallationInfo(), PackageUninstallation::getInstallationInfo()
public static integer getNewProcessNo()
Returns a new process number for package installation queue.
public string getNextPackageInstallationPlugin(string $currentStep)
Returns the name of the next step.
$currentStep public Package getPackage()
Returns the active package of this installation.
public integer getPackageID()
Returns the package id of this package installation.
protected PackageInstallationPlugin getPackageInstallationPlugin(string $pluginName)
Returns an object of the package installation plugin with the given name.
$pluginName protected integer getTotalStep()
Returns the number of all installation steps.
Redefined in descendants as: PackageInstallation::getTotalStep(), PackageUninstallation::getTotalStep()
protected void loadPackageInstallationPlugins()
Loads all registered needed package installation plugins.
Redefined in descendants as: PackageInstallationRollback::loadPackageInstallationPlugins()
protected void makeClear()
Clears relevant caches after package installation, update or uninstallation.
public static void openQueue([integer $parentQueueID = 0], [integer $processNo = 0])
Opens the package installation queue and starts the installation, update or uninstallation of the first entry.
$parentQueueID $processNo protected void showPackageInstallationException(SystemException $e)
Displays a system exception in the paackageinstallation exception template.
$e