From: Matthias Schmidt Date: Fri, 15 Jul 2011 17:39:41 +0000 (+0200) Subject: Updated PackageInstallationPlugin property documentation X-Git-Tag: 2.0.0_Beta_1~2006^2~4 X-Git-Url: https://git.stricted.de/?a=commitdiff_plain;h=b5be6fb094b1ea2fb5cd741f758720f010f0eada;p=GitHub%2FWoltLab%2FWCF.git Updated PackageInstallationPlugin property documentation Added missing PackageInstallationPlugin property documentations, removed AbstractXMLPackageInstallationPlugin::$tableName since it's already defined in AbstractPackageInstallationPlugin::$tableName and updated the relevant @see-references --- diff --git a/wcfsetup/install/files/lib/system/package/plugin/ACPMenuPackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/ACPMenuPackageInstallationPlugin.class.php index 5248f793f1..3b9801b892 100644 --- a/wcfsetup/install/files/lib/system/package/plugin/ACPMenuPackageInstallationPlugin.class.php +++ b/wcfsetup/install/files/lib/system/package/plugin/ACPMenuPackageInstallationPlugin.class.php @@ -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'; diff --git a/wcfsetup/install/files/lib/system/package/plugin/ACPTemplatesPackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/ACPTemplatesPackageInstallationPlugin.class.php index 55382cb243..0b82eec331 100644 --- a/wcfsetup/install/files/lib/system/package/plugin/ACPTemplatesPackageInstallationPlugin.class.php +++ b/wcfsetup/install/files/lib/system/package/plugin/ACPTemplatesPackageInstallationPlugin.class.php @@ -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() */ diff --git a/wcfsetup/install/files/lib/system/package/plugin/AbstractXMLPackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/AbstractXMLPackageInstallationPlugin.class.php index 756ad136b0..baa49da85d 100644 --- a/wcfsetup/install/files/lib/system/package/plugin/AbstractXMLPackageInstallationPlugin.class.php +++ b/wcfsetup/install/files/lib/system/package/plugin/AbstractXMLPackageInstallationPlugin.class.php @@ -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 diff --git a/wcfsetup/install/files/lib/system/package/plugin/CoreObjectPackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/CoreObjectPackageInstallationPlugin.class.php index 6ac57a31f7..10f7651434 100644 --- a/wcfsetup/install/files/lib/system/package/plugin/CoreObjectPackageInstallationPlugin.class.php +++ b/wcfsetup/install/files/lib/system/package/plugin/CoreObjectPackageInstallationPlugin.class.php @@ -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'; diff --git a/wcfsetup/install/files/lib/system/package/plugin/CronjobsPackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/CronjobsPackageInstallationPlugin.class.php index b56c652d61..dee7aef56d 100644 --- a/wcfsetup/install/files/lib/system/package/plugin/CronjobsPackageInstallationPlugin.class.php +++ b/wcfsetup/install/files/lib/system/package/plugin/CronjobsPackageInstallationPlugin.class.php @@ -20,7 +20,7 @@ class CronjobsPackageInstallationPlugin extends AbstractXMLPackageInstallationPl public $className = 'wcf\data\cronjob\CronjobEditor'; /** - * @see AbstractXMLPackageInstallationPlugin::$tableName + * @see AbstractPackageInstallationPlugin::$tableName */ public $tableName = 'cronjob'; diff --git a/wcfsetup/install/files/lib/system/package/plugin/EventListenerPackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/EventListenerPackageInstallationPlugin.class.php index 666b4dacb3..2ac9be0165 100644 --- a/wcfsetup/install/files/lib/system/package/plugin/EventListenerPackageInstallationPlugin.class.php +++ b/wcfsetup/install/files/lib/system/package/plugin/EventListenerPackageInstallationPlugin.class.php @@ -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'; diff --git a/wcfsetup/install/files/lib/system/package/plugin/FilesPackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/FilesPackageInstallationPlugin.class.php index 9584b22463..3ba4e453b3 100644 --- a/wcfsetup/install/files/lib/system/package/plugin/FilesPackageInstallationPlugin.class.php +++ b/wcfsetup/install/files/lib/system/package/plugin/FilesPackageInstallationPlugin.class.php @@ -21,6 +21,9 @@ use wcf\util\StyleUtil; * @category Community Framework */ class FilesPackageInstallationPlugin extends AbstractPackageInstallationPlugin { + /** + * @see AbstractPackageInstallationPlugin::$tableName + */ public $tableName = 'package_installation_file_log'; /** diff --git a/wcfsetup/install/files/lib/system/package/plugin/GroupOptionsPackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/GroupOptionsPackageInstallationPlugin.class.php index bf1ba22f04..5560127fa0 100644 --- a/wcfsetup/install/files/lib/system/package/plugin/GroupOptionsPackageInstallationPlugin.class.php +++ b/wcfsetup/install/files/lib/system/package/plugin/GroupOptionsPackageInstallationPlugin.class.php @@ -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'); /** diff --git a/wcfsetup/install/files/lib/system/package/plugin/LanguagesPackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/LanguagesPackageInstallationPlugin.class.php index 4b79096020..2d1943150c 100644 --- a/wcfsetup/install/files/lib/system/package/plugin/LanguagesPackageInstallationPlugin.class.php +++ b/wcfsetup/install/files/lib/system/package/plugin/LanguagesPackageInstallationPlugin.class.php @@ -18,6 +18,9 @@ use wcf\util\XML; * @category Community Framework */ class LanguagesPackageInstallationPlugin extends AbstractXMLPackageInstallationPlugin { + /** + * @see AbstractPackageInstallationPlugin::$tableName + */ public $tableName = 'language_item'; /** diff --git a/wcfsetup/install/files/lib/system/package/plugin/OptionsPackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/OptionsPackageInstallationPlugin.class.php index b11a328681..4370b1581c 100644 --- a/wcfsetup/install/files/lib/system/package/plugin/OptionsPackageInstallationPlugin.class.php +++ b/wcfsetup/install/files/lib/system/package/plugin/OptionsPackageInstallationPlugin.class.php @@ -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'); /** diff --git a/wcfsetup/install/files/lib/system/package/plugin/PIPPackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/PIPPackageInstallationPlugin.class.php index ee323a1511..3aae98a8d7 100644 --- a/wcfsetup/install/files/lib/system/package/plugin/PIPPackageInstallationPlugin.class.php +++ b/wcfsetup/install/files/lib/system/package/plugin/PIPPackageInstallationPlugin.class.php @@ -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'; /** diff --git a/wcfsetup/install/files/lib/system/package/plugin/PageLocationPackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/PageLocationPackageInstallationPlugin.class.php index e522077038..a53ed86667 100644 --- a/wcfsetup/install/files/lib/system/package/plugin/PageLocationPackageInstallationPlugin.class.php +++ b/wcfsetup/install/files/lib/system/package/plugin/PageLocationPackageInstallationPlugin.class.php @@ -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'; /** diff --git a/wcfsetup/install/files/lib/system/package/plugin/PageMenuPackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/PageMenuPackageInstallationPlugin.class.php index ef30bd6afb..e344c6573b 100644 --- a/wcfsetup/install/files/lib/system/package/plugin/PageMenuPackageInstallationPlugin.class.php +++ b/wcfsetup/install/files/lib/system/package/plugin/PageMenuPackageInstallationPlugin.class.php @@ -20,8 +20,8 @@ class PageMenuPackageInstallationPlugin extends AbstractMenuPackageInstallationP public $className = 'wcf\data\page\menu\item\PageMenuItemEditor'; /** - * @see AbstractXMLPackageInstallationPlugin::$tableName - */ + * @see AbstractPackageInstallationPlugin::$tableName + */ public $tableName = 'page_menu_item'; /** @@ -52,4 +52,4 @@ class PageMenuPackageInstallationPlugin extends AbstractMenuPackageInstallationP return $result; } -} +} diff --git a/wcfsetup/install/files/lib/system/package/plugin/SqlPackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/SqlPackageInstallationPlugin.class.php index 3e2e6e1eff..1cebf2ac34 100644 --- a/wcfsetup/install/files/lib/system/package/plugin/SqlPackageInstallationPlugin.class.php +++ b/wcfsetup/install/files/lib/system/package/plugin/SqlPackageInstallationPlugin.class.php @@ -15,6 +15,9 @@ use wcf\util\StringUtil; * @category Community Framework */ class SqlPackageInstallationPlugin extends AbstractPackageInstallationPlugin { + /** + * @see AbstractPackageInstallationPlugin::$tableName + */ public $tableName = 'package_installation_sql_log'; /** diff --git a/wcfsetup/install/files/lib/system/package/plugin/StyleAttributesPackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/StyleAttributesPackageInstallationPlugin.class.php index 9c7d9ed277..e9eeadb76c 100644 --- a/wcfsetup/install/files/lib/system/package/plugin/StyleAttributesPackageInstallationPlugin.class.php +++ b/wcfsetup/install/files/lib/system/package/plugin/StyleAttributesPackageInstallationPlugin.class.php @@ -22,8 +22,8 @@ class StyleAttributesPackageInstallationPlugin extends AbstractXMLPackageInstall protected $styleVariables = array(); /** - * @see AbstractXMLPackageInstallationPlugin::$tableName - */ + * @see AbstractPackageInstallationPlugin::$tableName + */ public $tableName = 'style_variable_to_attribute'; /** @@ -141,4 +141,4 @@ class StyleAttributesPackageInstallationPlugin extends AbstractXMLPackageInstall $style->writeStyleFile(); } } -} +} diff --git a/wcfsetup/install/files/lib/system/package/plugin/StylePackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/StylePackageInstallationPlugin.class.php index c04f8bd5ab..6846f2341e 100644 --- a/wcfsetup/install/files/lib/system/package/plugin/StylePackageInstallationPlugin.class.php +++ b/wcfsetup/install/files/lib/system/package/plugin/StylePackageInstallationPlugin.class.php @@ -21,8 +21,8 @@ class StylePackageInstallationPlugin extends AbstractPackageInstallationPlugin { public $className = 'wcf\data\style\StyleEditor'; /** - * @see AbstractXMLPackageInstallationPlugin::$tableName - */ + * @see AbstractPackageInstallationPlugin::$tableName + */ public $tableName = 'style'; /** @@ -86,4 +86,4 @@ class StylePackageInstallationPlugin extends AbstractPackageInstallationPlugin { } } } -} +} diff --git a/wcfsetup/install/files/lib/system/package/plugin/TemplateListenerPackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/TemplateListenerPackageInstallationPlugin.class.php index a3d512dbfb..8de8c566ca 100644 --- a/wcfsetup/install/files/lib/system/package/plugin/TemplateListenerPackageInstallationPlugin.class.php +++ b/wcfsetup/install/files/lib/system/package/plugin/TemplateListenerPackageInstallationPlugin.class.php @@ -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'; /** diff --git a/wcfsetup/install/files/lib/system/package/plugin/TemplatesPackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/TemplatesPackageInstallationPlugin.class.php index 4e45227cc2..456a276e35 100644 --- a/wcfsetup/install/files/lib/system/package/plugin/TemplatesPackageInstallationPlugin.class.php +++ b/wcfsetup/install/files/lib/system/package/plugin/TemplatesPackageInstallationPlugin.class.php @@ -17,6 +17,9 @@ use wcf\util\FileUtil; * @category Community Framework */ class TemplatesPackageInstallationPlugin extends AbstractPackageInstallationPlugin { + /** + * @see AbstractPackageInstallationPlugin::$tableName + */ public $tableName = 'template'; /** diff --git a/wcfsetup/install/files/lib/system/package/plugin/UserOptionsPackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/UserOptionsPackageInstallationPlugin.class.php index fac1f1eeb3..afa56420c9 100644 --- a/wcfsetup/install/files/lib/system/package/plugin/UserOptionsPackageInstallationPlugin.class.php +++ b/wcfsetup/install/files/lib/system/package/plugin/UserOptionsPackageInstallationPlugin.class.php @@ -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'); /**