com.woltlab.wcf.acp.package
PackageInstallation executes package installations and updates.
PackageInstallationQueue | --PackageInstallation
| Class | Description |
|---|---|
PackageInstallationInfo |
PackageInstallationInfo is used to calculate the progress bar of a package installation. |
| Name | Value |
|---|---|
| CONFIG_FILE | 'config.inc.php' |
| Type | Name |
|---|---|
PackageArchive |
$packageArchive |
Package |
$progressPackage |
mixed |
$selectedRequirements |
mixed |
$stepAfterPIP |
| Return | Name |
|---|---|
PackageInstallation |
__construct(integer $queueID)
|
void |
assignPackageInfo()
|
void |
calcProgress( $currentStep)
|
void |
checkArchive()
|
void |
checkExclusions()
|
Installer |
extractFiles(string $targetDir, string $sourceArchive, [FileHandler $fileHandler = null])
|
string |
finishInstallation()
|
PackageArchive |
getArchive()
|
void |
getCurrentStep( $currentStep)
|
void |
getInstallationInfo()
|
array |
getInstructions()
|
void |
getTotalStep()
|
string |
getXMLTag(string $tagName)
|
boolean |
hasPackageInstallationPlugins()
|
void |
install()
|
void |
installPackage()
|
void |
installPackageInstallationPlugins()
|
void |
installPackageOptionals()
|
void |
installPackageParent()
|
boolean |
installPackageRequirements()
|
void |
installSelectablePackageRequirements()
|
void |
rebuildConfigFiles()
|
void |
saveParentPackage(integer $parentPackageID)
|
void |
updatePackageVersion()
|
boolean |
XMLTagExists(string $tagName)
|
protected PackageArchive $packageArchive
the archive object
protected Package $progressPackage = null
package object of an existing package
protected mixed $selectedRequirements = array()
protected mixed $stepAfterPIP = 'optionals'
Redefinition of: PackageInstallationQueue::$stepAfterPIP
PackageInstallationQueue::$action, PackageInstallationQueue::$cancelable, PackageInstallationQueue::$confirmInstallation, PackageInstallationQueue::$done, PackageInstallationQueue::$nextStep, PackageInstallationQueue::$package, PackageInstallationQueue::$packageID, PackageInstallationQueue::$packageType, PackageInstallationQueue::$parentQueueID, PackageInstallationQueue::$pipSortOrder, PackageInstallationQueue::$processNo, PackageInstallationQueue::$queueID, PackageInstallationQueue::$step
public PackageInstallation __construct(integer $queueID)
Creates a new PackageInstallation object.
$queueID Redefinition of: PackageInstallationQueue::__construct()
Redefined in descendants as: PackageInstallationInfo::__construct()
protected void assignPackageInfo()
Redefinition of: PackageInstallationQueue::assignPackageInfo()
protected void calcProgress( $currentStep)
$currentStep Redefinition of: PackageInstallationQueue::calcProgress()
protected void checkArchive()
Checks the correctness of the package archive.
protected void checkExclusions()
Checks for conflicted exclusions.
public Installer extractFiles(string $targetDir, string $sourceArchive, [FileHandler $fileHandler = null])
Extracts files from .tar (or .tar.gz) archive and installs them
$targetDir $sourceArchive $fileHandler protected string finishInstallation()
finalises installation of this package.
public PackageArchive getArchive()
Returns the package archive.
protected void getCurrentStep( $currentStep)
protected void getInstallationInfo()
Redefinition of: PackageInstallationQueue::getInstallationInfo()
Redefined in descendants as: PackageInstallationInfo::getInstallationInfo()
public array getInstructions()
Returns the package installation instructions.
protected void getTotalStep()
Redefinition of: PackageInstallationQueue::getTotalStep()
public string getXMLTag(string $tagName)
Returns the content of the tag with the given tag name in package.xml file.
$tagName protected boolean hasPackageInstallationPlugins()
checks if this package has packageInstallationPlugins to add.
protected void install()
Steps through the installation process of a package.
protected void installPackage()
Registers package information into database.
protected void installPackageInstallationPlugins()
Finds and extracts userexits archive in package archive and start extraction
protected void installPackageOptionals()
Installs optional packages for this package.
protected void installPackageParent()
determines if the package that's about to install does have a "parent" package, and if so, associates the package with that parent.
protected boolean installPackageRequirements()
Installs the requirements of the current package.
Inserts needed package installations or updates into the package installation queue. Returns true, if no package installations are needed. Otherwise false.
protected void installSelectablePackageRequirements()
Shows a select form if multiple instances of a reqiured package are installed.
protected void rebuildConfigFiles()
Rebuilds config.inc.php files after package updates or plugin installations.
protected void saveParentPackage(integer $parentPackageID)
Saves the given parent package id as parent package for this package.
$parentPackageID protected void updatePackageVersion()
Updates the version of a package.
public boolean XMLTagExists(string $tagName)
checks if a tag named $tagName exists in package.xml file and has contents (either cdata or attributes)
$tagName 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()