From b1a0a33cae6298f7042494b2b10d5cf05f850e53 Mon Sep 17 00:00:00 2001 From: Matthias Schmidt Date: Sat, 14 Jul 2012 19:36:23 +0200 Subject: [PATCH] Updates comments of system package classes --- .../lib/system/package/PackageArchive.class.php | 15 ++------------- .../package/PackageDependencyHandler.class.php | 1 - .../PackageInstallationFileHandler.class.php | 6 +++++- .../PackageInstallationNodeBuilder.class.php | 12 ++++-------- .../PackageInstallationScheduler.class.php | 5 ----- .../package/PackageInstallationStep.class.php | 7 ++----- ...UpdateAuthorizationRequiredException.class.php | 14 ++++++++++++++ 7 files changed, 27 insertions(+), 33 deletions(-) diff --git a/wcfsetup/install/files/lib/system/package/PackageArchive.class.php b/wcfsetup/install/files/lib/system/package/PackageArchive.class.php index ee93a50e7b..d1bd46caf4 100644 --- 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 */ protected $instructions = array( @@ -87,14 +78,12 @@ class PackageArchive { /** * list of php requirements - * * @var 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 0e3b061fd2..5ca49a9d24 100644 --- 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 4f3a899bf8..3f329e59a6 100644 --- 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 aa465e5860..e9906cf59b 100644 --- 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 f911299687..4bf6429422 100644 --- 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 d72e7b9466..4737f0e48f 100644 --- 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 ae93cf018a..f2dd854039 100644 --- 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(); /** -- 2.20.1