Updates comments of system package classes

diff --git a/wcfsetup/install/files/lib/system/package/PackageArchive.class.php b/wcfsetup/install/files/lib/system/package/PackageArchive.class.php
index ee93a50e7bfb1ed855ba74743c4dd83185710a58..d1bd46caf4d4c5f7ca71411f055770edec26db19 100644 (file)
--- a/wcfsetup/install/files/lib/system/package/PackageArchive.class.php
+++ b/wcfsetup/install/files/lib/system/package/PackageArchive.class.php
@@ -21,63 +21,54 @@ use wcf\util\XML;
 class PackageArchive {
        /**
         * path to archive
-        *
         * @var string
         */
        protected $archive = null;
        
        /**
         * package object of an existing package
-        *
-        * @var Package
+        * @var wcf\data\package\Package
         */
        protected $package = null;
        
        /**
         * tar archive object
-        *
-        * @var Tar
+        * @var wcf\system\io\Tar
         */
        protected $tar = null;
        
        /**
         * general package information
-        *
         * @var array
         */
        protected $packageInfo = array();
        
        /**
         * author information
-        *
         * @var array
         */
        protected $authorInfo = array();
        
        /**
         * list of requirements
-        *
         * @var array
         */
        protected $requirements = array();
        
        /**
         * list of optional packages
-        *
         * @var array
         */
        protected $optionals = array();
        
        /**
         * list of excluded packages
-        * 
         * @var array
         */
        protected $excludedPackages = array();
        
        /**
         * list of instructions
-        * 
         * @var array<array>
         */     
        protected $instructions = array(
@@ -87,14 +78,12 @@ class PackageArchive {
        
        /**
         * list of php requirements
-        * 
         * @var array<array>
         */
        protected $phpRequirements = array();
        
        /**
         * default name of the package.xml file
-        *
         * @var string
         */
        const INFO_FILE = 'package.xml';

diff --git a/wcfsetup/install/files/lib/system/package/PackageDependencyHandler.class.php b/wcfsetup/install/files/lib/system/package/PackageDependencyHandler.class.php
index 0e3b061fd2787c1282d76514434e6ef3f7050d82..5ca49a9d246e042ed317b80865f8572fd98a6aad 100644 (file)
--- a/wcfsetup/install/files/lib/system/package/PackageDependencyHandler.class.php
+++ b/wcfsetup/install/files/lib/system/package/PackageDependencyHandler.class.php
@@ -16,7 +16,6 @@ use wcf\system\SingletonFactory;
 class PackageDependencyHandler extends SingletonFactory {
        /**
         * cache of package dependencies
-        *
         * @var array
         */     
        protected $packageDependencyCache = null;

diff --git a/wcfsetup/install/files/lib/system/package/PackageInstallationFileHandler.class.php b/wcfsetup/install/files/lib/system/package/PackageInstallationFileHandler.class.php
index 4f3a899bf86b239d261f6c432c012ecd473d371b..3f329e59a6da773200467f4f1a4261ae58e1a3a4 100644 (file)
--- a/wcfsetup/install/files/lib/system/package/PackageInstallationFileHandler.class.php
+++ b/wcfsetup/install/files/lib/system/package/PackageInstallationFileHandler.class.php
@@ -13,12 +13,16 @@ use wcf\system\setup\IFileHandler;
  * @category   Community Framework
  */
 abstract class PackageInstallationFileHandler implements IFileHandler {
+       /**
+        * active package installation dispatcher
+        * @var wcf\system\package\PackageInstallationDispatcher
+        */
        protected $packageInstallation;
        
        /**
         * Creates a new PackageInstallationFileHandler object.
         * 
-        * @param       PackageInstallationDispatcher   $packageInstallation
+        * @param       wcf\system\package\PackageInstallationDispatcher        $packageInstallation
         */
        public function __construct(PackageInstallationDispatcher $packageInstallation) {
                $this->packageInstallation = $packageInstallation;

diff --git a/wcfsetup/install/files/lib/system/package/PackageInstallationNodeBuilder.class.php b/wcfsetup/install/files/lib/system/package/PackageInstallationNodeBuilder.class.php
index aa465e58607f543d5414644c4dbff79dd8d66936..e9906cf59bd483a337707988f56e3d372656c4d4 100644 (file)
--- a/wcfsetup/install/files/lib/system/package/PackageInstallationNodeBuilder.class.php
+++ b/wcfsetup/install/files/lib/system/package/PackageInstallationNodeBuilder.class.php
@@ -20,22 +20,19 @@ use wcf\util\StringUtil;
  */
 class PackageInstallationNodeBuilder {
        /**
-        * instance of PackageInstallationDispatcher
-        *
-        * @var PackageInstallationDispatcher
+        * active package installation dispatcher
+        * @var wcf\system\package\PackageInstallationDispatcher
         */
        public $installation = null;
        
        /**
-        * current node
-        *
+        * current installation node
         * @var string
         */
        public $node = '';
        
        /**
-        * current parent node
-        *
+        * current parent installation node
         * @var string
         */
        public $parentNode = '';
@@ -48,7 +45,6 @@ class PackageInstallationNodeBuilder {
        
        /**
         * current sequence number within one node
-        *
         * @var integer
         */
        public $sequenceNo = 0;

diff --git a/wcfsetup/install/files/lib/system/package/PackageInstallationScheduler.class.php b/wcfsetup/install/files/lib/system/package/PackageInstallationScheduler.class.php
index f911299687a55202f1c0bc5dc3bd9b481374071b..4bf6429422794f41ca80f7e21da800867df98b97 100644 (file)
--- a/wcfsetup/install/files/lib/system/package/PackageInstallationScheduler.class.php
+++ b/wcfsetup/install/files/lib/system/package/PackageInstallationScheduler.class.php
@@ -21,35 +21,30 @@ use wcf\util\FileUtil;
 class PackageInstallationScheduler {
        /**
         * list of packages to update or install
-        * 
         * @var array
         */
        protected $selectedPackages = array();
        
        /**
         * list of package update server ids
-        * 
         * @var array
         */
        protected $packageUpdateServerIDs;
        
        /**
         * enables downloading of updates
-        * 
         * @var boolean
         */
        protected $download;
        
        /**
         * virtual package versions
-        * 
         * @var array
         */
        protected $virtualPackageVersions = array();
        
        /**
         * stack of package installations / updates
-        * 
         * @var array
         */
        protected $packageInstallationStack = array();

diff --git a/wcfsetup/install/files/lib/system/package/PackageInstallationStep.class.php b/wcfsetup/install/files/lib/system/package/PackageInstallationStep.class.php
index d72e7b946670226c63a82b8636b5a9e6da43d09a..4737f0e48f6c57a65a28537af81cd4dbb493fab5 100644 (file)
--- a/wcfsetup/install/files/lib/system/package/PackageInstallationStep.class.php
+++ b/wcfsetup/install/files/lib/system/package/PackageInstallationStep.class.php
@@ -15,21 +15,18 @@ use wcf\system\form\FormDocument;
 class PackageInstallationStep {
        /**
         * form document object
-        *
-        * @var FormDocument
+        * @var wcf\system\form\FormDocument
         */
        protected $document = null;
        
        /**
         * next installation node
-        *
         * @var string
         */
        protected $node = '';
        
        /**
-        * split current node
-        *
+        * indicates if current current node should be splitted
         * @var boolean
         */
        protected $splitNode = false;

diff --git a/wcfsetup/install/files/lib/system/package/PackageUpdateAuthorizationRequiredException.class.php b/wcfsetup/install/files/lib/system/package/PackageUpdateAuthorizationRequiredException.class.php
index ae93cf018ac307487c6b8f77eb4895eee1b8271b..f2dd854039ed4139c6ecc368a0a741b218db49c0 100644 (file)
--- a/wcfsetup/install/files/lib/system/package/PackageUpdateAuthorizationRequiredException.class.php
+++ b/wcfsetup/install/files/lib/system/package/PackageUpdateAuthorizationRequiredException.class.php
@@ -14,8 +14,22 @@ use wcf\system\exception\UserException;
  * @category   Community Framework
  */
 class PackageUpdateAuthorizationRequiredException extends UserException {
+       /**
+        * id of the package update server that requires authorization
+        * @var integer
+        */
        protected $packageUpdateServerID = 0;
+       
+       /**
+        * url of the requested package update
+        * @var string
+        */
        protected $url = '';
+       
+       /**
+        * package update sever response data
+        * @var array
+        */
        protected $response = array();
        
        /**