From: Matthias Schmidt <gravatronics@live.com>
Date: Fri, 12 Aug 2011 11:02:17 +0000 (+0200)
Subject: Mostly documentation updates
X-Git-Tag: 2.0.0_Beta_1~1886^2
X-Git-Url: https://git.stricted.de/?a=commitdiff_plain;h=26ea99d069421da79e4628ffde599677059ffef8;p=GitHub%2FWoltLab%2FWCF.git

Mostly documentation updates

Additionally added missing used namespaces to AbstractSecureForm and
removed an unused key in a foreach loop in SetupLanguage.
---

diff --git a/wcfsetup/install/files/lib/acp/action/InstallPackageAction.class.php b/wcfsetup/install/files/lib/acp/action/InstallPackageAction.class.php
index 7803f0c33c..54960a83d1 100755
--- a/wcfsetup/install/files/lib/acp/action/InstallPackageAction.class.php
+++ b/wcfsetup/install/files/lib/acp/action/InstallPackageAction.class.php
@@ -20,33 +20,31 @@ use wcf\util\StringUtil;
 class InstallPackageAction extends AbstractDialogAction {
 	/**
 	 * current node
-	 *
 	 * @var	string
 	 */
 	public $node = '';
 	
 	/**
 	 * PackageInstallationDispatcher object
-	 *
-	 * @var	PackageInstallationDispatcher
+	 * @var	wcf\system\package\PackageInstallationDispatcher
 	 */
 	public $installation = null;
 	
 	/**
 	 * PackageInstallationQueue object
-	 *
-	 * @var	PackageInstallationQueue
+	 * @var	wcf\data\package\installation\queue\PackageInstallationQueue
 	 */
 	public $queue = null;
 	
 	/**
 	 * current queue id
-	 *
 	 * @var	integer
 	 */
 	public $queueID = 0;
 	
-	// system
+	/**
+	 * @see	wcf\action\AbstractDialogAction::$templateName
+	 */
 	public $templateName = 'packageInstallationStep';
 	
 	/**
diff --git a/wcfsetup/install/files/lib/acp/action/UninstallPackageAction.class.php b/wcfsetup/install/files/lib/acp/action/UninstallPackageAction.class.php
index c89e7f82b6..ae054a77a9 100644
--- a/wcfsetup/install/files/lib/acp/action/UninstallPackageAction.class.php
+++ b/wcfsetup/install/files/lib/acp/action/UninstallPackageAction.class.php
@@ -23,12 +23,13 @@ use wcf\util\StringUtil;
 class UninstallPackageAction extends InstallPackageAction {
 	/**
 	 * active package id
-	 *
 	 * @var	integer
 	 */
 	protected $packageID = 0;
 	
-	// system
+	/**
+	 * @see	wcf\action\AbstractDialogAction::$templateName
+	 */
 	public $templateName = 'packageUninstallationStep';
 	
 	/**
diff --git a/wcfsetup/install/files/lib/acp/form/ACPForm.class.php b/wcfsetup/install/files/lib/acp/form/ACPForm.class.php
index 7562e345e8..5b9f2f41f1 100755
--- a/wcfsetup/install/files/lib/acp/form/ACPForm.class.php
+++ b/wcfsetup/install/files/lib/acp/form/ACPForm.class.php
@@ -7,7 +7,7 @@ use wcf\form\AbstractForm;
  * Provides a default implementation for the show method in acp forms.
  * 
  * @author	Marcel Werk
- * @copyright	2001-2009 WoltLab GmbH
+ * @copyright	2001-2011 WoltLab GmbH
  * @license	GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @package	com.woltlab.wcf
  * @subpackage	acp.form
@@ -24,8 +24,10 @@ class ACPForm extends AbstractForm {
 	 * @see wcf\page\IPage::show()
 	 */
 	public function show() {
-		// enable menu item
-		if (!empty($this->activeMenuItem)) ACPMenu::getInstance()->setActiveMenuItem($this->activeMenuItem);
+		// set active acp menu item
+		if (!empty($this->activeMenuItem)) {
+			ACPMenu::getInstance()->setActiveMenuItem($this->activeMenuItem);
+		}
 		
 		parent::show();
 	}
diff --git a/wcfsetup/install/files/lib/action/AJAXProxyAction.class.php b/wcfsetup/install/files/lib/action/AJAXProxyAction.class.php
index e05ce38320..cc357b44af 100644
--- a/wcfsetup/install/files/lib/action/AJAXProxyAction.class.php
+++ b/wcfsetup/install/files/lib/action/AJAXProxyAction.class.php
@@ -20,37 +20,37 @@ use wcf\util\StringUtil;
 class AJAXProxyAction extends AbstractSecureAction {
 	/**
 	 * class name
-	 * @var string
+	 * @var	string
 	 */
 	protected $className = '';
 	
 	/**
 	 * action name
-	 * @var string
+	 * @var	string
 	 */
 	protected $actionName = '';
 	
 	/**
 	 * list of object ids
-	 * @var array<integer>
+	 * @var	array<integer>
 	 */
 	protected $objectIDs = array();
 	
 	/**
 	 * additional parameters
-	 * @var array<mixed>
+	 * @var	array<mixed>
 	 */
 	protected $parameters = array();
 	
 	/**
 	 * object action
-	 * @var wcf\data\IDatabaseObjectAction
+	 * @var	wcf\data\IDatabaseObjectAction
 	 */
 	protected $objectAction = null;
 	
 	/**
 	 * results of the executed action
-	 * @var mixed
+	 * @var	mixed
 	 */
 	protected $response = null;
 	
diff --git a/wcfsetup/install/files/lib/action/AbstractAction.class.php b/wcfsetup/install/files/lib/action/AbstractAction.class.php
index e7d7d47c40..3cbf68e3ee 100644
--- a/wcfsetup/install/files/lib/action/AbstractAction.class.php
+++ b/wcfsetup/install/files/lib/action/AbstractAction.class.php
@@ -17,15 +17,13 @@ use wcf\system\WCF;
  */
 abstract class AbstractAction implements IAction {
 	/**
-	 * Needed modules to execute this action.
-	 * 
+	 * needed modules to execute this action
 	 * @var	array<string>
 	 */
 	public $neededModules = array();
 	
 	/**
-	 * Needed permissions to execute this action.
-	 * 
+	 * needed permissions to execute this action
 	 * @var array<string>
 	 */
 	public $neededPermissions = array();
diff --git a/wcfsetup/install/files/lib/action/AbstractDialogAction.class.php b/wcfsetup/install/files/lib/action/AbstractDialogAction.class.php
index 6b70512c00..474f548731 100644
--- a/wcfsetup/install/files/lib/action/AbstractDialogAction.class.php
+++ b/wcfsetup/install/files/lib/action/AbstractDialogAction.class.php
@@ -4,24 +4,32 @@ use wcf\system\exception\AJAXException;
 use wcf\util\JSON;
 use wcf\util\StringUtil;
 
+/**
+ * Abstract implementation of an action that displays a dialog and that is executed
+ * in multiple steps.
+ * 
+ * @author	
+ * @copyright	2001-2011 WoltLab GmbH
+ * @license	GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @package	com.woltlab.wcf
+ * @subpackage	action
+ * @category 	Community Framework
+ */
 abstract class AbstractDialogAction extends AbstractSecureAction {
 	/**
 	 * current step
-	 *
 	 * @var	string
 	 */
 	public $step = '';
 	
 	/**
 	 * template name
-	 *
 	 * @var	string
 	 */
 	public $templateName = '';
 	
 	/**
 	 * response data
-	 *
 	 * @var	array
 	 */
 	public $data = array();
@@ -46,6 +54,9 @@ abstract class AbstractDialogAction extends AbstractSecureAction {
 		$this->validateStep();
 	}
 	
+	/**
+	 * @see	wcf\action\IAction::execute()
+	 */
 	public final function execute() {
 		parent::execute();
 		
@@ -68,5 +79,5 @@ abstract class AbstractDialogAction extends AbstractSecureAction {
 	/**
 	 * Validates current dialog step.
 	 */
-	abstract protected function validateStep();
+	protected abstract function validateStep();
 }
diff --git a/wcfsetup/install/files/lib/data/language/SetupLanguage.class.php b/wcfsetup/install/files/lib/data/language/SetupLanguage.class.php
index 05753dd791..37042956b7 100644
--- a/wcfsetup/install/files/lib/data/language/SetupLanguage.class.php
+++ b/wcfsetup/install/files/lib/data/language/SetupLanguage.class.php
@@ -59,7 +59,7 @@ class SetupLanguage extends Language {
 			if (count($categoriesToCache) > 0) {
 				$file = new File($filename);
 				$file->write("<?php\n/**\n* WoltLab Community Framework\n* language: ".$this->languageCode."\n* encoding: UTF-8\n* category: WCF Setup\n* generated at ".gmdate("r")."\n* \n* DO NOT EDIT THIS FILE\n*/\n");
-				foreach ($categoriesToCache as $value => $name) {
+				foreach ($categoriesToCache as $name) {
 					$file->write("\$this->items['".$name['name']."'] = '".str_replace("'", "\'", $name['cdata'])."';\n");
 					
 					// compile dynamic language variables
@@ -81,10 +81,10 @@ class SetupLanguage extends Language {
 	 * Sets the local language.
 	 */
 	private function setLocale() {
-		// set locale for
-		// string comparison
-		// character classification and conversion
-		// date and time formatting
+		// set locale for:
+		// - string comparison
+		// - character classification and conversion
+		// - date and time formatting
 		setlocale(LC_COLLATE, $this->get('wcf.global.locale.unix').'.UTF-8', $this->get('wcf.global.locale.unix'), $this->get('wcf.global.locale.win'));
 		setlocale(LC_CTYPE, $this->get('wcf.global.locale.unix').'.UTF-8', $this->get('wcf.global.locale.unix'), $this->get('wcf.global.locale.win'));
 	}
diff --git a/wcfsetup/install/files/lib/form/AbstractSecureForm.class.php b/wcfsetup/install/files/lib/form/AbstractSecureForm.class.php
index 3a7424c7bf..d1260645d7 100644
--- a/wcfsetup/install/files/lib/form/AbstractSecureForm.class.php
+++ b/wcfsetup/install/files/lib/form/AbstractSecureForm.class.php
@@ -1,12 +1,14 @@
 <?php
 namespace wcf\form;
+use wcf\system\exception\IllegalLinkException;
+use wcf\system\WCF;
 
 /**
  * Extends AbstractForm by a function to validate a given security token.
  * A missing or invalid token will be result in a throw of a IllegalLinkException.
  * 
  * @author	Marcel Werk
- * @copyright	2001-2009 WoltLab GmbH
+ * @copyright	2001-2011 WoltLab GmbH
  * @license	GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @package	com.woltlab.wcf
  * @subpackage	form
diff --git a/wcfsetup/install/files/lib/system/language/LanguageServerProcessor.class.php b/wcfsetup/install/files/lib/system/language/LanguageServerProcessor.class.php
index d435aff9fd..fbeadcd120 100644
--- a/wcfsetup/install/files/lib/system/language/LanguageServerProcessor.class.php
+++ b/wcfsetup/install/files/lib/system/language/LanguageServerProcessor.class.php
@@ -30,7 +30,7 @@ class LanguageServerProcessor extends SingletonFactory {
 	 * Imports language variables for a language from given language servers.
 	 * 
 	 * @param	wcf\data\language\Language	$language
-	 * @param	array	$languageServers
+	 * @param	array<wcf\data\language\server\LanguageServer>	$languageServers
 	 */
 	public function import(Language $language, array $languageServers) {
 		if (!count($languageServers)) return;
@@ -47,7 +47,7 @@ class LanguageServerProcessor extends SingletonFactory {
 	/**
 	 * Returns list of installed packages and their associated version.
 	 * 
-	 * @return	array
+	 * @return	array<string>
 	 */
 	protected function getPackageList() {
 		$sql = "SELECT	package, packageVersion
@@ -66,8 +66,8 @@ class LanguageServerProcessor extends SingletonFactory {
 	/**
 	 * Downloads and imports a language file from a language server.
 	 * 
-	 * @param	string	$location
-	 * @param	array	$packageList
+	 * @param	string		$location
+	 * @param	array<string>	$packageList
 	 */	
 	protected function importLanguageFile($location, array $packageList) {
 		// get proxy
@@ -161,7 +161,7 @@ class LanguageServerProcessor extends SingletonFactory {
 	/**
 	 * Parses XML response from language server.
 	 * 
-	 * @param	string	$xmlResponse
+	 * @param	string		$xmlResponse
 	 */
 	protected function parseResponse($xmlResponse) {
 		// parse xml
@@ -211,8 +211,8 @@ class LanguageServerProcessor extends SingletonFactory {
 	/**
 	 * Imports language variables and categories.
 	 * 
-	 * @param	array	$variables
-	 * @param	array	$packages
+	 * @param	array		$variables
+	 * @param	array<integer>	$packages
 	 */
 	protected function importVariables(array $variables, array $packages) {
 		$categories = $this->importCategories($variables);
@@ -291,7 +291,7 @@ class LanguageServerProcessor extends SingletonFactory {
 	/**
 	 * Imports new langage categories.
 	 * 
-	 * @param	array	$variables
+	 * @param	array		$variables
 	 * @return	array
 	 */	
 	protected function importCategories(array $variables) {
diff --git a/wcfsetup/install/files/lib/system/request/Request.class.php b/wcfsetup/install/files/lib/system/request/Request.class.php
index 6ebbaebfa3..a14a42e613 100644
--- a/wcfsetup/install/files/lib/system/request/Request.class.php
+++ b/wcfsetup/install/files/lib/system/request/Request.class.php
@@ -31,7 +31,7 @@ class Request {
 	protected $pageType = '';
 	
 	/**
-	 * true, if this request was executed already.
+	 * true, if this request has already been executed
 	 * @var boolean
 	 */
 	protected $executed = false;
@@ -60,9 +60,9 @@ class Request {
 	}
 	
 	/**
-	 * Returns true, if this request was executed already.
+	 * Returns true, if this request has already been executed.
 	 * 
-	 * @return boolean
+	 * @return	boolean
 	 */
 	public function isExecuted() {
 		return $this->executed;
@@ -71,7 +71,7 @@ class Request {
 	/**
 	 * Returns the page class name of this request.
 	 * 
-	 * @return string
+	 * @return	string
 	 */
 	public function getClassName() {
 		return $this->className; 
@@ -80,7 +80,7 @@ class Request {
 	/**
 	 * Returns the page name of this request.
 	 * 
-	 * @return string
+	 * @return	string
 	 */
 	public function getPageName() {
 		return $this->pageName;
@@ -89,7 +89,7 @@ class Request {
 	/**
 	 * Returns the page type of this request.
 	 * 
-	 * @return string
+	 * @return	string
 	 */
 	public function getPageType() {
 		return $this->pageType;
diff --git a/wcfsetup/install/files/lib/system/request/RequestHandler.class.php b/wcfsetup/install/files/lib/system/request/RequestHandler.class.php
index 1f878132a9..0e4ff0d843 100644
--- a/wcfsetup/install/files/lib/system/request/RequestHandler.class.php
+++ b/wcfsetup/install/files/lib/system/request/RequestHandler.class.php
@@ -17,7 +17,7 @@ use wcf\system\SingletonFactory;
 class RequestHandler extends SingletonFactory {
 	/**
 	 * active request object
-	 * @var Request
+	 * @var wcf\system\request\Request
 	 */
 	protected $activeRequest = null;
 	
@@ -90,7 +90,7 @@ class RequestHandler extends SingletonFactory {
 	/**
 	 * Returns the active request object.
 	 *
-	 * @return Request
+	 * @return	wcf\system\request\Request
 	 */
 	public function getActiveRequest() {
 		return $this->activeRequest;
diff --git a/wcfsetup/install/files/lib/system/storage/StorageHandler.class.php b/wcfsetup/install/files/lib/system/storage/StorageHandler.class.php
index ac55600d6a..cc2f631a7c 100644
--- a/wcfsetup/install/files/lib/system/storage/StorageHandler.class.php
+++ b/wcfsetup/install/files/lib/system/storage/StorageHandler.class.php
@@ -16,22 +16,19 @@ use wcf\system\WCF;
  */
 class StorageHandler extends SingletonFactory {
 	/**
-	 * Data cache
-	 * 
+	 * data cache
 	 * @var	array<array>
 	 */
 	protected $cache = array();
 	
 	/**
-	 * List of outdated data records
-	 * 
+	 * list of outdated data records
 	 * @var	array<array>
 	 */
 	protected $resetFields = array();
 	
 	/**
-	 * List of updated or new data records
-	 * 
+	 * list of updated or new data records
 	 * @var	array<array>
 	 */
 	protected $updateFields = array();
@@ -39,7 +36,7 @@ class StorageHandler extends SingletonFactory {
 	/**
 	 * Loads storage for a given set of users.
 	 * 
-	 * @param	array		$userIDs
+	 * @param	array<integer>	$userIDs
 	 * @param	integer		$packageID
 	 */
 	public function loadStorage(array $userIDs, $packageID = PACKAGE_ID) {
@@ -76,7 +73,7 @@ class StorageHandler extends SingletonFactory {
 	/**
 	 * Returns stored data for given users.
 	 * 
-	 * @param	array		$userIDs
+	 * @param	array<integer>	$userIDs
 	 * @param	string		$field
 	 * @param	integer		$packageID
 	 * @return	array<array>
@@ -125,7 +122,7 @@ class StorageHandler extends SingletonFactory {
 	/**
 	 * Removes a data record from database.
 	 * 
-	 * @param	array<integer>	$userID
+	 * @param	array<integer>	$userIDs
 	 * @param	string		$field
 	 * @param	integer		$packageID
 	 */
diff --git a/wcfsetup/install/files/lib/system/style/StyleHandler.class.php b/wcfsetup/install/files/lib/system/style/StyleHandler.class.php
index 6919e3cf2a..c87ea632af 100644
--- a/wcfsetup/install/files/lib/system/style/StyleHandler.class.php
+++ b/wcfsetup/install/files/lib/system/style/StyleHandler.class.php
@@ -25,7 +25,7 @@ class StyleHandler extends SingletonFactory {
 	
 	/**
 	 * active style object
-	 * @var	ActiveStyle
+	 * @var	wcf\data\style\ActiveStyle
 	 */
 	protected $style = null;
 	
@@ -41,7 +41,7 @@ class StyleHandler extends SingletonFactory {
 	/**
 	 * Returns a list of all for the current user available styles.
 	 * 
-	 * @return	array<Style>
+	 * @return	array<wcf\data\style\Style>
 	 */
 	public function getAvailableStyles() {
 		$styles = array();
@@ -58,7 +58,7 @@ class StyleHandler extends SingletonFactory {
 	/**
 	 * Returns the active style.
 	 * 
-	 * @return	ActiveStyle
+	 * @return	wcf\data\style\ActiveStyle
 	 */
 	public function getStyle() {
 		return $this->style;