Updated PackageInstallationPlugin property documentation
authorMatthias Schmidt <gravatronics@live.com>
Fri, 15 Jul 2011 17:39:41 +0000 (19:39 +0200)
committerMatthias Schmidt <gravatronics@live.com>
Fri, 15 Jul 2011 17:39:41 +0000 (19:39 +0200)
Added missing PackageInstallationPlugin property documentations, removed AbstractXMLPackageInstallationPlugin::$tableName since it's already defined in AbstractPackageInstallationPlugin::$tableName and updated the relevant @see-references

19 files changed:
wcfsetup/install/files/lib/system/package/plugin/ACPMenuPackageInstallationPlugin.class.php
wcfsetup/install/files/lib/system/package/plugin/ACPTemplatesPackageInstallationPlugin.class.php
wcfsetup/install/files/lib/system/package/plugin/AbstractXMLPackageInstallationPlugin.class.php
wcfsetup/install/files/lib/system/package/plugin/CoreObjectPackageInstallationPlugin.class.php
wcfsetup/install/files/lib/system/package/plugin/CronjobsPackageInstallationPlugin.class.php
wcfsetup/install/files/lib/system/package/plugin/EventListenerPackageInstallationPlugin.class.php
wcfsetup/install/files/lib/system/package/plugin/FilesPackageInstallationPlugin.class.php
wcfsetup/install/files/lib/system/package/plugin/GroupOptionsPackageInstallationPlugin.class.php
wcfsetup/install/files/lib/system/package/plugin/LanguagesPackageInstallationPlugin.class.php
wcfsetup/install/files/lib/system/package/plugin/OptionsPackageInstallationPlugin.class.php
wcfsetup/install/files/lib/system/package/plugin/PIPPackageInstallationPlugin.class.php
wcfsetup/install/files/lib/system/package/plugin/PageLocationPackageInstallationPlugin.class.php
wcfsetup/install/files/lib/system/package/plugin/PageMenuPackageInstallationPlugin.class.php
wcfsetup/install/files/lib/system/package/plugin/SqlPackageInstallationPlugin.class.php
wcfsetup/install/files/lib/system/package/plugin/StyleAttributesPackageInstallationPlugin.class.php
wcfsetup/install/files/lib/system/package/plugin/StylePackageInstallationPlugin.class.php
wcfsetup/install/files/lib/system/package/plugin/TemplateListenerPackageInstallationPlugin.class.php
wcfsetup/install/files/lib/system/package/plugin/TemplatesPackageInstallationPlugin.class.php
wcfsetup/install/files/lib/system/package/plugin/UserOptionsPackageInstallationPlugin.class.php

index 5248f793f1081b0651194e78fee5fe801cdd3eb4..3b9801b892ac0061efb2ec6e614f658f8c88b7c5 100644 (file)
@@ -18,7 +18,7 @@ class ACPMenuPackageInstallationPlugin extends AbstractMenuPackageInstallationPl
        public $className = 'wcf\data\acp\menu\item\ACPMenuItemEditor';
        
        /**
-        * @see AbstractXMLPackageInstallationPlugin::$tableName
+        * @see AbstractPackageInstallationPlugin::$tableName
         */
        public $tableName = 'acp_menu_item';
        
index 55382cb2430346e0d717e6cd704e3706a9d2640c..0b82eec3314418e0ac9bca4c19a3e74646d8b058 100644 (file)
@@ -17,9 +17,16 @@ use wcf\util\FileUtil;
  * @category   Community Framework
  */
 class ACPTemplatesPackageInstallationPlugin extends AbstractPackageInstallationPlugin {
-       public $tagName = 'acptemplates';
+       /**
+        * @see AbstractPackageInstallationPlugin::$tableName
+        */
        public $tableName = 'acp_template';
        
+       /**
+        * @see AbstractXMLPackageInstallationPlugin::$tagName
+        */     
+       public $tagName = 'acptemplates';
+
        /**
         * @see PackageInstallationPlugin::install()
         */
index 756ad136b0c56e83d0a7324636d18bdacae72105..baa49da85d935c92c3544abe739621aace229615 100644 (file)
@@ -23,12 +23,6 @@ abstract class AbstractXMLPackageInstallationPlugin extends AbstractPackageInsta
         */
        public $className = '';
        
-       /**
-        * sql database table name
-        * @var string
-        */
-       public $tableName = '';
-       
        /**
         * xml tag name, e.g. 'acpmenuitem'
         * @var string
index 6ac57a31f719e2db1eb4076c5c28984f9efa0a32..10f76514347d05fd250f282d0a268eaefa64edee 100644 (file)
@@ -20,7 +20,7 @@ class CoreObjectPackageInstallationPlugin extends AbstractXMLPackageInstallation
        public $className = 'wcf\data\core\object\CoreObjectEditor';
        
        /**
-        * @see AbstractXMLPackageInstallationPlugin::$tableName
+        * @see AbstractPackageInstallationPlugin::$tableName
         */
        public $tableName = 'core_object';
        
index b56c652d613047c6fe6d60f95ef0d4c4a61aafe9..dee7aef56da7b54be65af608da369eff9fd3b811 100644 (file)
@@ -20,7 +20,7 @@ class CronjobsPackageInstallationPlugin extends AbstractXMLPackageInstallationPl
        public $className = 'wcf\data\cronjob\CronjobEditor';
        
        /**
-        * @see AbstractXMLPackageInstallationPlugin::$tableName
+        * @see AbstractPackageInstallationPlugin::$tableName
         */
        public $tableName = 'cronjob';
        
index 666b4dacb39b7d39e9aadbee4a80be61eecdfd2c..2ac9be016593f67aa56dafd40e617c34961b3995 100644 (file)
@@ -20,7 +20,7 @@ class EventListenerPackageInstallationPlugin extends AbstractXMLPackageInstallat
        public $className = 'wcf\data\event\listener\EventListenerEditor';
        
        /**
-        * @see AbstractXMLPackageInstallationPlugin::$tableName
+        * @see AbstractPackageInstallationPlugin::$tableName
         */
        public $tableName = 'event_listener';
        
index 9584b2246321fd9f726d28942535f3ec7ba3b8d7..3ba4e453b375b2123637f422724ce0937fc9e05f 100644 (file)
@@ -21,6 +21,9 @@ use wcf\util\StyleUtil;
  * @category   Community Framework
  */
 class FilesPackageInstallationPlugin extends AbstractPackageInstallationPlugin {
+       /**
+        * @see AbstractPackageInstallationPlugin::$tableName
+        */     
        public $tableName = 'package_installation_file_log';
        
        /**
index bf1ba22f04638775a30d5387bc49cda9eddcb6dd..5560127fa05b8568eaacdc760cf5d978f00ebb1c 100644 (file)
@@ -16,7 +16,11 @@ use wcf\system\WCF;
  * @category   Community Framework
  */
 class GroupOptionsPackageInstallationPlugin extends AbstractOptionPackageInstallationPlugin {
+       /**
+        * @see AbstractPackageInstallationPlugin::$tableName
+        */     
        public $tableName = 'user_group_option';
+
        public static $reservedTags = array('name', 'optiontype', 'defaultvalue', 'admindefaultvalue', 'validationpattern', 'showorder', 'categoryname', 'selectoptions', 'enableoptions', 'permissions', 'options', 'attrs', 'cdata');
        
        /**
index 4b79096020e232225573cb3fc44ab478253d0984..2d1943150cbbef8cd23c35073b846a5f5498eecc 100644 (file)
@@ -18,6 +18,9 @@ use wcf\util\XML;
  * @category   Community Framework
  */
 class LanguagesPackageInstallationPlugin extends AbstractXMLPackageInstallationPlugin {
+       /**
+        * @see AbstractPackageInstallationPlugin::$tableName
+        */     
        public $tableName = 'language_item';
        
        /**
index b11a32868168ccb48233ad7ccfb12b37e36fcb07..4370b1581cafff9103c8a73d91621c3f35e53a0c 100644 (file)
@@ -15,7 +15,11 @@ use wcf\system\WCF;
  * @category   Community Framework
  */
 class OptionsPackageInstallationPlugin extends AbstractOptionPackageInstallationPlugin {
+       /**
+        * @see AbstractPackageInstallationPlugin::$tableName
+        */     
        public $tableName = 'option';
+
        public static $reservedTags = array('name', 'optiontype', 'defaultvalue', 'validationpattern', 'enableoptions', 'showorder', 'hidden', 'selectoptions', 'categoryname', 'permissions', 'options', 'attrs', 'cdata');
        
        /**
index ee323a15110c7defcbcc12a414107a48fcbf350b..3aae98a8d7135727239db4c98af801737d7cfbca 100644 (file)
@@ -20,8 +20,8 @@ class PIPPackageInstallationPlugin extends AbstractXMLPackageInstallationPlugin
        public $className = 'wcf\data\package\installation\plugin\PackageInstallationPluginEditor';
        
        /**
-        * @see AbstractXMLPackageInstallationPlugin::$tableName
-        */
+        * @see AbstractPackageInstallationPlugin::$tableName
+        */     
        public $tableName = 'package_installation_plugin';
        
        /**
index e522077038c97afe655b634ee3b23273948d27b7..a53ed866670b667705aaa3ad982a96c9d4e6311a 100644 (file)
@@ -19,8 +19,8 @@ class PageLocationPackageInstallationPlugin extends AbstractXMLPackageInstallati
        public $className = 'wcf\data\page\location\PageLocationEditor';
        
        /**
-        * @see AbstractXMLPackageInstallationPlugin::$tableName
-        */
+        * @see AbstractPackageInstallationPlugin::$tableName
+        */     
        public $tableName = 'page_location';
        
        /**
index ef30bd6afbf6ef2720e7f1c7a6dcdba85deee9dd..e344c6573b15b36937a25543f95f07b378e07976 100644 (file)
@@ -20,8 +20,8 @@ class PageMenuPackageInstallationPlugin extends AbstractMenuPackageInstallationP
        public $className = 'wcf\data\page\menu\item\PageMenuItemEditor';\r
        \r
        /**\r
-        * @see AbstractXMLPackageInstallationPlugin::$tableName\r
-        */\r
+        * @see AbstractPackageInstallationPlugin::$tableName\r
+        */     \r
        public $tableName = 'page_menu_item';\r
        \r
        /**\r
@@ -52,4 +52,4 @@ class PageMenuPackageInstallationPlugin extends AbstractMenuPackageInstallationP
                \r
                return $result;\r
        }\r
-}
+}\r
index 3e2e6e1effeaa0002b8ed8ecbc04bbbd7582a794..1cebf2ac34c2ff61d2744b36532dd4f1cce70364 100644 (file)
@@ -15,6 +15,9 @@ use wcf\util\StringUtil;
  * @category   Community Framework
  */
 class SqlPackageInstallationPlugin extends AbstractPackageInstallationPlugin {
+       /**
+        * @see AbstractPackageInstallationPlugin::$tableName
+        */     
        public $tableName = 'package_installation_sql_log';
        
        /**
index 9c7d9ed277b05a931bc87b024839eb2fb6bec6f3..e9eeadb76cc558aec0b93bbd44611da2eceea53e 100644 (file)
@@ -22,8 +22,8 @@ class StyleAttributesPackageInstallationPlugin extends AbstractXMLPackageInstall
        protected $styleVariables = array();\r
        \r
        /**\r
-        * @see AbstractXMLPackageInstallationPlugin::$tableName\r
-        */\r
+        * @see AbstractPackageInstallationPlugin::$tableName\r
+        */     \r
        public $tableName = 'style_variable_to_attribute';\r
        \r
        /**\r
@@ -141,4 +141,4 @@ class StyleAttributesPackageInstallationPlugin extends AbstractXMLPackageInstall
                        $style->writeStyleFile();\r
                }\r
        }\r
-}
+}\r
index c04f8bd5abf5a650ccf660663c8b73a2b858355a..6846f2341e0e22e89fe00dd3c013cf84a5dda84e 100644 (file)
@@ -21,8 +21,8 @@ class StylePackageInstallationPlugin extends AbstractPackageInstallationPlugin {
        public $className = 'wcf\data\style\StyleEditor';\r
        \r
        /**\r
-        * @see AbstractXMLPackageInstallationPlugin::$tableName\r
-        */\r
+        * @see AbstractPackageInstallationPlugin::$tableName\r
+        */     \r
        public $tableName = 'style';\r
        \r
        /**\r
@@ -86,4 +86,4 @@ class StylePackageInstallationPlugin extends AbstractPackageInstallationPlugin {
                        }\r
                }\r
        }\r
-}
+}\r
index a3d512dbfbe9c6180f3ae374703f8e09c2951443..8de8c566cad1786dfc1093cfe9a590c6e55b8442 100644 (file)
@@ -20,8 +20,8 @@ class TemplateListenerPackageInstallationPlugin extends AbstractXMLPackageInstal
        public $className = 'wcf\data\template\listener\TemplateListenerEditor';
        
        /**
-        * @see AbstractXMLPackageInstallationPlugin::$tableName
-        */
+        * @see AbstractPackageInstallationPlugin::$tableName
+        */     
        public $tableName = 'template_listener';
        
        /**
index 4e45227cc253945d2710c5a614015b7435c389fd..456a276e353cf9c2f69df6114f39b69902ff0783 100644 (file)
@@ -17,6 +17,9 @@ use wcf\util\FileUtil;
  * @category   Community Framework
  */
 class TemplatesPackageInstallationPlugin extends AbstractPackageInstallationPlugin {
+       /**
+        * @see AbstractPackageInstallationPlugin::$tableName
+        */     
        public $tableName = 'template';
        
        /**
index fac1f1eeb36fe8aa0ac516bf12ed53a826b8dc1d..afa56420c999557422d50bd41bc391505d3ad73c 100644 (file)
@@ -18,7 +18,11 @@ use wcf\system\WCF;
  * @category   Community Framework
  */
 class UserOptionsPackageInstallationPlugin extends AbstractOptionPackageInstallationPlugin {
+       /**
+        * @see AbstractPackageInstallationPlugin::$tableName
+        */     
        public $tableName = 'user_option';
+
        public static $reservedTags = array('name', 'optiontype', 'defaultvalue', 'validationpattern', 'required', 'editable', 'visible', 'searchable', 'showorder', 'outputclass', 'selectoptions', 'enableoptions', 'disabled', 'categoryname', 'permissions', 'options', 'attrs', 'cdata');
        
        /**