From: Matthias Schmidt Date: Sun, 22 May 2016 09:37:20 +0000 (+0200) Subject: Add @method documentation for DBO actions X-Git-Tag: 3.0.0_Beta_1~1679 X-Git-Url: https://git.stricted.de/?a=commitdiff_plain;h=0e8867ac271672f11a80f78a82a065cdbf8eb5f7;p=GitHub%2FWoltLab%2FWCF.git Add @method documentation for DBO actions --- diff --git a/wcfsetup/install/files/lib/data/acl/option/ACLOptionAction.class.php b/wcfsetup/install/files/lib/data/acl/option/ACLOptionAction.class.php index 0fce333d7e..915a33dbba 100644 --- a/wcfsetup/install/files/lib/data/acl/option/ACLOptionAction.class.php +++ b/wcfsetup/install/files/lib/data/acl/option/ACLOptionAction.class.php @@ -12,6 +12,10 @@ use wcf\system\acl\ACLHandler; * @package com.woltlab.wcf * @subpackage data.acl.option * @category Community Framework + * + * @method ACLOption create() + * @method ACLOptionEditor[] getObjects() + * @method ACLOptionEditor getSingleObject() */ class ACLOptionAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/acl/option/category/ACLOptionCategoryAction.class.php b/wcfsetup/install/files/lib/data/acl/option/category/ACLOptionCategoryAction.class.php index 9b2ed408cb..5d86a95ef5 100644 --- a/wcfsetup/install/files/lib/data/acl/option/category/ACLOptionCategoryAction.class.php +++ b/wcfsetup/install/files/lib/data/acl/option/category/ACLOptionCategoryAction.class.php @@ -11,6 +11,10 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.acl.option.category * @category Community Framework + * + * @method ACLOptionCategory create() + * @method ACLOptionCategoryEditor[] getObjects() + * @method ACLOptionCategoryEditor getSingleObject() */ class ACLOptionCategoryAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/acp/menu/item/ACPMenuItemAction.class.php b/wcfsetup/install/files/lib/data/acp/menu/item/ACPMenuItemAction.class.php index 4f8d416203..10e9629929 100644 --- a/wcfsetup/install/files/lib/data/acp/menu/item/ACPMenuItemAction.class.php +++ b/wcfsetup/install/files/lib/data/acp/menu/item/ACPMenuItemAction.class.php @@ -11,6 +11,10 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.acp.menu.item * @category Community Framework + * + * @method ACPMenuItem create() + * @method ACPMenuItemEditor[] getObjects() + * @method ACPMenuItemEditor getSingleObject() */ class ACPMenuItemAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/acp/search/provider/ACPSearchProviderAction.class.php b/wcfsetup/install/files/lib/data/acp/search/provider/ACPSearchProviderAction.class.php index 0a9b270874..70a40b9dca 100644 --- a/wcfsetup/install/files/lib/data/acp/search/provider/ACPSearchProviderAction.class.php +++ b/wcfsetup/install/files/lib/data/acp/search/provider/ACPSearchProviderAction.class.php @@ -13,6 +13,10 @@ use wcf\system\search\acp\ACPSearchHandler; * @package com.woltlab.wcf * @subpackage data.acp.search.provider * @category Community Framework + * + * @method ACPSearchProvider create() + * @method ACPSearchProviderEditor[] getObjects() + * @method ACPSearchProviderEditor getSingleObject() */ class ACPSearchProviderAction extends AbstractDatabaseObjectAction implements ISearchAction { /** diff --git a/wcfsetup/install/files/lib/data/acp/session/ACPSessionAction.class.php b/wcfsetup/install/files/lib/data/acp/session/ACPSessionAction.class.php index 5470e2feb9..dfdc7be159 100644 --- a/wcfsetup/install/files/lib/data/acp/session/ACPSessionAction.class.php +++ b/wcfsetup/install/files/lib/data/acp/session/ACPSessionAction.class.php @@ -11,6 +11,10 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.acp.session * @category Community Framework + * + * @method ACPSession create() + * @method ACPSessionEditor[] getObjects() + * @method ACPSessionEditor getSingleObject() */ class ACPSessionAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/acp/session/access/log/ACPSessionAccessLogAction.class.php b/wcfsetup/install/files/lib/data/acp/session/access/log/ACPSessionAccessLogAction.class.php index b581c2b55f..3cfac3dcfb 100644 --- a/wcfsetup/install/files/lib/data/acp/session/access/log/ACPSessionAccessLogAction.class.php +++ b/wcfsetup/install/files/lib/data/acp/session/access/log/ACPSessionAccessLogAction.class.php @@ -11,6 +11,10 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.acp.session.access.log * @category Community Framework + * + * @method ACPSessionAccessLog create() + * @method ACPSessionAccessLogEditor[] getObjects() + * @method ACPSessionAccessLogEditor getSingleObject() */ class ACPSessionAccessLogAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/acp/session/log/ACPSessionLogAction.class.php b/wcfsetup/install/files/lib/data/acp/session/log/ACPSessionLogAction.class.php index 9a1d1a21fb..34c5ed7eb9 100644 --- a/wcfsetup/install/files/lib/data/acp/session/log/ACPSessionLogAction.class.php +++ b/wcfsetup/install/files/lib/data/acp/session/log/ACPSessionLogAction.class.php @@ -11,6 +11,10 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.acp.session.log * @category Community Framework + * + * @method ACPSessionLog create() + * @method ACPSessionLogEditor[] getObjects() + * @method ACPSessionLogEditor getSingleObject() */ class ACPSessionLogAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/acp/session/virtual/ACPSessionVirtualAction.class.php b/wcfsetup/install/files/lib/data/acp/session/virtual/ACPSessionVirtualAction.class.php index 49f3fbdc2a..5485e7df9c 100644 --- a/wcfsetup/install/files/lib/data/acp/session/virtual/ACPSessionVirtualAction.class.php +++ b/wcfsetup/install/files/lib/data/acp/session/virtual/ACPSessionVirtualAction.class.php @@ -12,6 +12,9 @@ use wcf\util\UserUtil; * @package com.woltlab.wcf * @subpackage data.acp.session.virtual * @category Community Framework + * + * @method ACPSessionVirtualEditor[] getObjects() + * @method ACPSessionVirtualEditor getSingleObject() */ class ACPSessionVirtualAction extends AbstractDatabaseObjectAction { /** @@ -23,7 +26,7 @@ class ACPSessionVirtualAction extends AbstractDatabaseObjectAction { * Attention: This method does not always return a new object, in case a matching virtual session * already exists, the existing session will be returned rather than a new session being created. * - * @see \wcf\data\AbstractDatabaseObjectAction::create() + * @return ACPSessionVirtual */ public function create() { // try to find an existing virtual session diff --git a/wcfsetup/install/files/lib/data/acp/template/ACPTemplateAction.class.php b/wcfsetup/install/files/lib/data/acp/template/ACPTemplateAction.class.php index f1a20bc434..db7241e861 100644 --- a/wcfsetup/install/files/lib/data/acp/template/ACPTemplateAction.class.php +++ b/wcfsetup/install/files/lib/data/acp/template/ACPTemplateAction.class.php @@ -11,6 +11,10 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.acp.template * @category Community Framework + * + * @method ACPTemplate create() + * @method ACPTemplateEditor[] getObjects() + * @method ACPTemplateEditor getSingleObject() */ class ACPTemplateAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/ad/AdAction.class.php b/wcfsetup/install/files/lib/data/ad/AdAction.class.php index 1844818a0a..b5d3823f61 100644 --- a/wcfsetup/install/files/lib/data/ad/AdAction.class.php +++ b/wcfsetup/install/files/lib/data/ad/AdAction.class.php @@ -16,6 +16,9 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.ad * @category Community Framework + * + * @method AdEditor[] getObjects() + * @method AdEditor getSingleObject() */ class AdAction extends AbstractDatabaseObjectAction implements ISortableAction, IToggleAction { /** @@ -35,6 +38,7 @@ class AdAction extends AbstractDatabaseObjectAction implements ISortableAction, /** * @inheritDoc + * @return Ad */ public function create() { $showOrder = 0; @@ -43,6 +47,7 @@ class AdAction extends AbstractDatabaseObjectAction implements ISortableAction, unset($this->parameters['data']['showOrder']); } + /** @var Ad $ad */ $ad = parent::create(); $adEditor = new AdEditor($ad); $adEditor->setShowOrder($showOrder); diff --git a/wcfsetup/install/files/lib/data/application/ApplicationAction.class.php b/wcfsetup/install/files/lib/data/application/ApplicationAction.class.php index e31cb75901..ad933eb8b7 100644 --- a/wcfsetup/install/files/lib/data/application/ApplicationAction.class.php +++ b/wcfsetup/install/files/lib/data/application/ApplicationAction.class.php @@ -17,6 +17,10 @@ use wcf\util\StringUtil; * @package com.woltlab.wcf * @subpackage data.application * @category Community Framework + * + * @method Application create() + * @method ApplicationEditor[] getObjects() + * @method ApplicationEditor getSingleObject() */ class ApplicationAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/attachment/AttachmentAction.class.php b/wcfsetup/install/files/lib/data/attachment/AttachmentAction.class.php index f3b2aadc46..09d534e214 100644 --- a/wcfsetup/install/files/lib/data/attachment/AttachmentAction.class.php +++ b/wcfsetup/install/files/lib/data/attachment/AttachmentAction.class.php @@ -25,6 +25,10 @@ use wcf\util\FileUtil; * @package com.woltlab.wcf * @subpackage data.attachment * @category Community Framework + * + * @method Attachment create() + * @method AttachmentEditor[] getObjects() + * @method AttachmentEditor getSingleObject() */ class AttachmentAction extends AbstractDatabaseObjectAction implements ISortableAction, IUploadAction { /** diff --git a/wcfsetup/install/files/lib/data/bbcode/BBCodeAction.class.php b/wcfsetup/install/files/lib/data/bbcode/BBCodeAction.class.php index 21d68fa704..5ce1d7f75b 100644 --- a/wcfsetup/install/files/lib/data/bbcode/BBCodeAction.class.php +++ b/wcfsetup/install/files/lib/data/bbcode/BBCodeAction.class.php @@ -17,6 +17,9 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.bbcode * @category Community Framework + * + * @method BBCodeEditor[] getObjects() + * @method BBCodeEditor getSingleObject() */ class BBCodeAction extends AbstractDatabaseObjectAction implements IToggleAction { /** @@ -41,8 +44,10 @@ class BBCodeAction extends AbstractDatabaseObjectAction implements IToggleAction /** * @inheritDoc + * @return BBCode */ public function create() { + /** @var BBCode $bbCode */ $bbCode = parent::create(); // add bbcode to BBCodeSelect user group options diff --git a/wcfsetup/install/files/lib/data/bbcode/attribute/BBCodeAttributeAction.class.php b/wcfsetup/install/files/lib/data/bbcode/attribute/BBCodeAttributeAction.class.php index 203d423f85..cf0e3152b8 100644 --- a/wcfsetup/install/files/lib/data/bbcode/attribute/BBCodeAttributeAction.class.php +++ b/wcfsetup/install/files/lib/data/bbcode/attribute/BBCodeAttributeAction.class.php @@ -11,6 +11,10 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.bbcode.attribute * @category Community Framework + * + * @method BBCodeAttribute create() + * @method BBCodeAttributeEditor[] getObjects() + * @method BBCodeAttributeEditor getSingleObject() */ class BBCodeAttributeAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/bbcode/media/provider/BBCodeMediaProviderAction.class.php b/wcfsetup/install/files/lib/data/bbcode/media/provider/BBCodeMediaProviderAction.class.php index c18b5a3720..72e14170c0 100644 --- a/wcfsetup/install/files/lib/data/bbcode/media/provider/BBCodeMediaProviderAction.class.php +++ b/wcfsetup/install/files/lib/data/bbcode/media/provider/BBCodeMediaProviderAction.class.php @@ -11,6 +11,10 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.bbcode.media.provider * @category Community Framework + * + * @method BBCodeMediaProvider create() + * @method BBCodeMediaProviderEditor[] getObjects() + * @method BBCodeMediaProviderEditor getSingleObject() */ class BBCodeMediaProviderAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/box/BoxAction.class.php b/wcfsetup/install/files/lib/data/box/BoxAction.class.php index f0bbfc3378..48b53e3f16 100644 --- a/wcfsetup/install/files/lib/data/box/BoxAction.class.php +++ b/wcfsetup/install/files/lib/data/box/BoxAction.class.php @@ -18,6 +18,9 @@ use wcf\system\WCF; * @subpackage data.box * @category Community Framework * @since 2.2 + * + * @method BoxEditor[] getObjects() + * @method BoxEditor getSingleObject() */ class BoxAction extends AbstractDatabaseObjectAction { /** @@ -53,8 +56,10 @@ class BoxAction extends AbstractDatabaseObjectAction { /** * @inheritDoc + * @return Box */ public function create() { + /** @var Box $box */ $box = parent::create(); // save box content diff --git a/wcfsetup/install/files/lib/data/captcha/question/CaptchaQuestionAction.class.php b/wcfsetup/install/files/lib/data/captcha/question/CaptchaQuestionAction.class.php index b8cf7eadd4..bf0e833eca 100644 --- a/wcfsetup/install/files/lib/data/captcha/question/CaptchaQuestionAction.class.php +++ b/wcfsetup/install/files/lib/data/captcha/question/CaptchaQuestionAction.class.php @@ -12,6 +12,10 @@ use wcf\data\IToggleAction; * @package com.woltlab.wcf * @subpackage data.captcha.question * @category Community Framework + * + * @method CaptchaQuestion create() + * @method CaptchaQuestionEditor[] getObjects() + * @method CaptchaQuestionEditor getSingleObject() */ class CaptchaQuestionAction extends AbstractDatabaseObjectAction implements IToggleAction { /** diff --git a/wcfsetup/install/files/lib/data/category/CategoryAction.class.php b/wcfsetup/install/files/lib/data/category/CategoryAction.class.php index de566ed085..0bc6fa6b90 100644 --- a/wcfsetup/install/files/lib/data/category/CategoryAction.class.php +++ b/wcfsetup/install/files/lib/data/category/CategoryAction.class.php @@ -20,6 +20,10 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.category * @category Community Framework + * + * @method Category create() + * @method CategoryEditor[] getObjects() + * @method CategoryEditor getSingleObject() */ class CategoryAction extends AbstractDatabaseObjectAction implements ISortableAction, IToggleAction, IToggleContainerAction { /** diff --git a/wcfsetup/install/files/lib/data/clipboard/action/ClipboardActionAction.class.php b/wcfsetup/install/files/lib/data/clipboard/action/ClipboardActionAction.class.php index 182369dd65..969dbd3c60 100644 --- a/wcfsetup/install/files/lib/data/clipboard/action/ClipboardActionAction.class.php +++ b/wcfsetup/install/files/lib/data/clipboard/action/ClipboardActionAction.class.php @@ -11,6 +11,10 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.clipboard.action * @category Community Framework + * + * @method ClipboardAction create() + * @method ClipboardActionEditor[] getObjects() + * @method ClipboardActionEditor getSingleObject() */ class ClipboardActionAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/comment/CommentAction.class.php b/wcfsetup/install/files/lib/data/comment/CommentAction.class.php index 97a23b1eb1..790599f14e 100644 --- a/wcfsetup/install/files/lib/data/comment/CommentAction.class.php +++ b/wcfsetup/install/files/lib/data/comment/CommentAction.class.php @@ -33,6 +33,10 @@ use wcf\util\UserUtil; * @package com.woltlab.wcf * @subpackage data.comment * @category Community Framework + * + * @method Comment create() + * @method CommentEditor[] getObjects() + * @method CommentEditor getSingleObject() */ class CommentAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/comment/response/CommentResponseAction.class.php b/wcfsetup/install/files/lib/data/comment/response/CommentResponseAction.class.php index e90998826d..b984c6b4dd 100644 --- a/wcfsetup/install/files/lib/data/comment/response/CommentResponseAction.class.php +++ b/wcfsetup/install/files/lib/data/comment/response/CommentResponseAction.class.php @@ -21,6 +21,10 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.comment.response * @category Community Framework + * + * @method CommentResponse create() + * @method CommentResponseEditor[] getObjects() + * @method CommentResponseEditor getSingleObject() */ class CommentResponseAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/condition/ConditionAction.class.php b/wcfsetup/install/files/lib/data/condition/ConditionAction.class.php index 092fbd6ab5..84b9b11279 100644 --- a/wcfsetup/install/files/lib/data/condition/ConditionAction.class.php +++ b/wcfsetup/install/files/lib/data/condition/ConditionAction.class.php @@ -11,5 +11,9 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.condition * @category Community Framework + * + * @method Condition create() + * @method ConditionEditor[] getObjects() + * @method ConditionEditor getSingleObject() */ class ConditionAction extends AbstractDatabaseObjectAction { } diff --git a/wcfsetup/install/files/lib/data/core/object/CoreObjectAction.class.php b/wcfsetup/install/files/lib/data/core/object/CoreObjectAction.class.php index 497bd0061f..83dbed55c9 100644 --- a/wcfsetup/install/files/lib/data/core/object/CoreObjectAction.class.php +++ b/wcfsetup/install/files/lib/data/core/object/CoreObjectAction.class.php @@ -11,6 +11,10 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.core.object * @category Community Framework + * + * @method CoreObject create() + * @method CoreObjectEditor[] getObjects() + * @method CoreObjectEditor getSingleObject() */ class CoreObjectAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/cronjob/CronjobAction.class.php b/wcfsetup/install/files/lib/data/cronjob/CronjobAction.class.php index 52f471384a..07446cde4a 100644 --- a/wcfsetup/install/files/lib/data/cronjob/CronjobAction.class.php +++ b/wcfsetup/install/files/lib/data/cronjob/CronjobAction.class.php @@ -18,6 +18,10 @@ use wcf\util\DateUtil; * @package com.woltlab.wcf * @subpackage data.cronjob * @category Community Framework + * + * @method Cronjob create() + * @method CronjobEditor[] getObjects() + * @method CronjobEditor getSingleObject() */ class CronjobAction extends AbstractDatabaseObjectAction implements IToggleAction { /** diff --git a/wcfsetup/install/files/lib/data/cronjob/log/CronjobLogAction.class.php b/wcfsetup/install/files/lib/data/cronjob/log/CronjobLogAction.class.php index ee073a7296..0118b8c05c 100644 --- a/wcfsetup/install/files/lib/data/cronjob/log/CronjobLogAction.class.php +++ b/wcfsetup/install/files/lib/data/cronjob/log/CronjobLogAction.class.php @@ -12,6 +12,10 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.acp.menu.item * @category Community Framework + * + * @method CronjobLog create() + * @method CronjobLogEditor[] getObjects() + * @method CronjobLogEditor getSingleObject() */ class CronjobLogAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/edit/history/entry/EditHistoryEntryAction.class.php b/wcfsetup/install/files/lib/data/edit/history/entry/EditHistoryEntryAction.class.php index a50448911a..17259ba0c5 100644 --- a/wcfsetup/install/files/lib/data/edit/history/entry/EditHistoryEntryAction.class.php +++ b/wcfsetup/install/files/lib/data/edit/history/entry/EditHistoryEntryAction.class.php @@ -13,6 +13,10 @@ use wcf\system\exception\IllegalLinkException; * @package com.woltlab.wcf * @subpackage data.edit.history.entry * @category Community Framework + * + * @method EditHistoryEntry create() + * @method EditHistoryEntryEditor[] getObjects() + * @method EditHistoryEntryEditor getSingleObject() */ class EditHistoryEntryAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/event/listener/EventListenerAction.class.php b/wcfsetup/install/files/lib/data/event/listener/EventListenerAction.class.php index 83dda923cd..913fd0fa96 100644 --- a/wcfsetup/install/files/lib/data/event/listener/EventListenerAction.class.php +++ b/wcfsetup/install/files/lib/data/event/listener/EventListenerAction.class.php @@ -11,6 +11,10 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.event.listener * @category Community Framework + * + * @method EventListener create() + * @method EventListenerEditor[] getObjects() + * @method EventListenerEditor getSingleObject() */ class EventListenerAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/label/LabelAction.class.php b/wcfsetup/install/files/lib/data/label/LabelAction.class.php index 914959526f..ab7860add1 100644 --- a/wcfsetup/install/files/lib/data/label/LabelAction.class.php +++ b/wcfsetup/install/files/lib/data/label/LabelAction.class.php @@ -17,6 +17,9 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.label * @category Community Framework + * + * @method LabelEditor[] getObjects() + * @method LabelEditor getSingleObject() */ class LabelAction extends AbstractDatabaseObjectAction implements ISortableAction { /** @@ -46,6 +49,7 @@ class LabelAction extends AbstractDatabaseObjectAction implements ISortableActio /** * @inheritDoc + * @return Label */ public function create() { $showOrder = 0; @@ -54,6 +58,7 @@ class LabelAction extends AbstractDatabaseObjectAction implements ISortableActio unset($this->parameters['data']['showOrder']); } + /** @var Label $label */ $label = parent::create(); (new LabelEditor($label))->setShowOrder($label->groupID, $showOrder); diff --git a/wcfsetup/install/files/lib/data/label/group/LabelGroupAction.class.php b/wcfsetup/install/files/lib/data/label/group/LabelGroupAction.class.php index 8847db4970..84ad7d475f 100644 --- a/wcfsetup/install/files/lib/data/label/group/LabelGroupAction.class.php +++ b/wcfsetup/install/files/lib/data/label/group/LabelGroupAction.class.php @@ -12,6 +12,10 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.label.group * @category Community Framework + * + * @method LabelGroup create() + * @method LabelGroupEditor[] getObjects() + * @method LabelGroupEditor getSingleObject() */ class LabelGroupAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/language/LanguageAction.class.php b/wcfsetup/install/files/lib/data/language/LanguageAction.class.php index ff42f99d59..20bb5853f1 100644 --- a/wcfsetup/install/files/lib/data/language/LanguageAction.class.php +++ b/wcfsetup/install/files/lib/data/language/LanguageAction.class.php @@ -12,6 +12,10 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.language * @category Community Framework + * + * @method Language create() + * @method LanguageEditor[] getObjects() + * @method LanguageEditor getSingleObject() */ class LanguageAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/language/category/LanguageCategoryAction.class.php b/wcfsetup/install/files/lib/data/language/category/LanguageCategoryAction.class.php index 812475fd17..8511560ce6 100644 --- a/wcfsetup/install/files/lib/data/language/category/LanguageCategoryAction.class.php +++ b/wcfsetup/install/files/lib/data/language/category/LanguageCategoryAction.class.php @@ -11,6 +11,10 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.language.category * @category Community Framework + * + * @method LanguageCategory create() + * @method LanguageCategoryEditor[] getObjects() + * @method LanguageCategoryEditor getSingleObject() */ class LanguageCategoryAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/language/item/LanguageItemAction.class.php b/wcfsetup/install/files/lib/data/language/item/LanguageItemAction.class.php index 50fedbd656..f6463d32cd 100644 --- a/wcfsetup/install/files/lib/data/language/item/LanguageItemAction.class.php +++ b/wcfsetup/install/files/lib/data/language/item/LanguageItemAction.class.php @@ -15,6 +15,10 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.language.item * @category Community Framework + * + * @method LanguageItem create() + * @method LanguageItemEditor[] getObjects() + * @method LanguageItemEditor getSingleObject() */ class LanguageItemAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/like/LikeAction.class.php b/wcfsetup/install/files/lib/data/like/LikeAction.class.php index 703624e9e1..73b3241bbc 100644 --- a/wcfsetup/install/files/lib/data/like/LikeAction.class.php +++ b/wcfsetup/install/files/lib/data/like/LikeAction.class.php @@ -23,6 +23,10 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.like * @category Community Framework + * + * @method Like create() + * @method LikeEditor[] getObjects() + * @method LikeEditor getSingleObject() */ class LikeAction extends AbstractDatabaseObjectAction implements IGroupedUserListAction { /** diff --git a/wcfsetup/install/files/lib/data/media/MediaAction.class.php b/wcfsetup/install/files/lib/data/media/MediaAction.class.php index 5816578571..dec6f43f8f 100644 --- a/wcfsetup/install/files/lib/data/media/MediaAction.class.php +++ b/wcfsetup/install/files/lib/data/media/MediaAction.class.php @@ -25,6 +25,10 @@ use wcf\util\FileUtil; * @subpackage data.media * @category Community Framework * @since 2.2 + * + * @method Media create() + * @method MediaEditor[] getObjects() + * @method MediaEditor getSingleObject() */ class MediaAction extends AbstractDatabaseObjectAction implements ISearchAction, IUploadAction { /** diff --git a/wcfsetup/install/files/lib/data/menu/MenuAction.class.php b/wcfsetup/install/files/lib/data/menu/MenuAction.class.php index fd37965498..09a4928340 100644 --- a/wcfsetup/install/files/lib/data/menu/MenuAction.class.php +++ b/wcfsetup/install/files/lib/data/menu/MenuAction.class.php @@ -15,6 +15,9 @@ use wcf\system\exception\PermissionDeniedException; * @subpackage data.menu * @category Community Framework * @since 2.2 + * + * @method MenuEditor[] getObjects() + * @method MenuEditor getSingleObject() */ class MenuAction extends AbstractDatabaseObjectAction { /** @@ -44,9 +47,10 @@ class MenuAction extends AbstractDatabaseObjectAction { /** * @inheritdoc + * @return Menu */ public function create() { - // create menu + /** @var Menu $menu */ $menu = parent::create(); // create box diff --git a/wcfsetup/install/files/lib/data/menu/item/MenuItemAction.class.php b/wcfsetup/install/files/lib/data/menu/item/MenuItemAction.class.php index 9c7f809429..48c976ca3b 100644 --- a/wcfsetup/install/files/lib/data/menu/item/MenuItemAction.class.php +++ b/wcfsetup/install/files/lib/data/menu/item/MenuItemAction.class.php @@ -18,6 +18,10 @@ use wcf\system\WCF; * @subpackage data.menu.item * @category Community Framework * @since 2.2 + * + * @method MenuItem create() + * @method MenuItemEditor[] getObjects() + * @method MenuItemEditor getSingleObject() */ class MenuItemAction extends AbstractDatabaseObjectAction implements ISortableAction, IToggleAction { /** diff --git a/wcfsetup/install/files/lib/data/moderation/queue/ModerationQueueAction.class.php b/wcfsetup/install/files/lib/data/moderation/queue/ModerationQueueAction.class.php index 51811f9e51..a527622df4 100644 --- a/wcfsetup/install/files/lib/data/moderation/queue/ModerationQueueAction.class.php +++ b/wcfsetup/install/files/lib/data/moderation/queue/ModerationQueueAction.class.php @@ -21,6 +21,9 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.moderation.queue * @category Community Framework + * + * @method ModerationQueueEditor[] getObjects() + * @method ModerationQueueEditor getSingleObject() */ class ModerationQueueAction extends AbstractDatabaseObjectAction { /** @@ -42,6 +45,7 @@ class ModerationQueueAction extends AbstractDatabaseObjectAction { /** * @inheritDoc + * @return ModerationQueue */ public function create() { if (!isset($this->parameters['data']['lastChangeTime'])) { diff --git a/wcfsetup/install/files/lib/data/modification/log/ModificationLogAction.class.php b/wcfsetup/install/files/lib/data/modification/log/ModificationLogAction.class.php index 58133522c3..7a1624aa85 100644 --- a/wcfsetup/install/files/lib/data/modification/log/ModificationLogAction.class.php +++ b/wcfsetup/install/files/lib/data/modification/log/ModificationLogAction.class.php @@ -11,5 +11,9 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.modification.log * @category Community Framework + * + * @method ModificationLog create() + * @method ModificationLogEditor[] getObjects() + * @method ModificationLogEditor getSingleObject() */ class ModificationLogAction extends AbstractDatabaseObjectAction { } diff --git a/wcfsetup/install/files/lib/data/notice/NoticeAction.class.php b/wcfsetup/install/files/lib/data/notice/NoticeAction.class.php index 91d41debab..85ae432a8c 100644 --- a/wcfsetup/install/files/lib/data/notice/NoticeAction.class.php +++ b/wcfsetup/install/files/lib/data/notice/NoticeAction.class.php @@ -17,6 +17,9 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.notice * @category Community Framework + * + * @method NoticeEditor[] getObjects() + * @method NoticeEditor getSingleObject() */ class NoticeAction extends AbstractDatabaseObjectAction implements ISortableAction, IToggleAction { /** @@ -41,6 +44,7 @@ class NoticeAction extends AbstractDatabaseObjectAction implements ISortableActi /** * @inheritDoc + * @return Notice */ public function create() { $showOrder = 0; @@ -49,6 +53,7 @@ class NoticeAction extends AbstractDatabaseObjectAction implements ISortableActi unset($this->parameters['data']['showOrder']); } + /** @var Notice $notice */ $notice = parent::create(); $noticeEditor = new NoticeEditor($notice); $noticeEditor->setShowOrder($showOrder); diff --git a/wcfsetup/install/files/lib/data/object/type/ObjectTypeAction.class.php b/wcfsetup/install/files/lib/data/object/type/ObjectTypeAction.class.php index 6073861bcd..7158153f52 100644 --- a/wcfsetup/install/files/lib/data/object/type/ObjectTypeAction.class.php +++ b/wcfsetup/install/files/lib/data/object/type/ObjectTypeAction.class.php @@ -11,6 +11,10 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.object.type * @category Community Framework + * + * @method ObjectType create() + * @method ObjectTypeEditor[] getObjects() + * @method ObjectTypeEditor getSingleObject() */ class ObjectTypeAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/object/type/definition/ObjectTypeDefinitionAction.class.php b/wcfsetup/install/files/lib/data/object/type/definition/ObjectTypeDefinitionAction.class.php index 433d578c87..6c2f9d3ae0 100644 --- a/wcfsetup/install/files/lib/data/object/type/definition/ObjectTypeDefinitionAction.class.php +++ b/wcfsetup/install/files/lib/data/object/type/definition/ObjectTypeDefinitionAction.class.php @@ -11,6 +11,10 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.object.type.definition * @category Community Framework + * + * @method ObjectTypeDefinition create() + * @method ObjectTypeDefinitionEditor[] getObjects() + * @method ObjectTypeDefinitionEditor getSingleObject() */ class ObjectTypeDefinitionAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/option/OptionAction.class.php b/wcfsetup/install/files/lib/data/option/OptionAction.class.php index 810fb04357..26ee6414cb 100644 --- a/wcfsetup/install/files/lib/data/option/OptionAction.class.php +++ b/wcfsetup/install/files/lib/data/option/OptionAction.class.php @@ -11,6 +11,10 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data. * @category Community Framework + * + * @method Option create() + * @method OptionEditor[] getObjects() + * @method OptionEditor getSingleObject() */ class OptionAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/option/category/OptionCategoryAction.class.php b/wcfsetup/install/files/lib/data/option/category/OptionCategoryAction.class.php index d586c65fdf..d3269d0abf 100644 --- a/wcfsetup/install/files/lib/data/option/category/OptionCategoryAction.class.php +++ b/wcfsetup/install/files/lib/data/option/category/OptionCategoryAction.class.php @@ -11,6 +11,10 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.option.category * @category Community Framework + * + * @method OptionCategory create() + * @method OptionCategoryEditor[] getObjects() + * @method OptionCategoryEditor getSingleObject() */ class OptionCategoryAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/package/PackageAction.class.php b/wcfsetup/install/files/lib/data/package/PackageAction.class.php index bf53eda8f1..4823f54bce 100644 --- a/wcfsetup/install/files/lib/data/package/PackageAction.class.php +++ b/wcfsetup/install/files/lib/data/package/PackageAction.class.php @@ -18,6 +18,10 @@ use wcf\util\JSON; * @package com.woltlab.wcf * @subpackage data.package * @category Community Framework + * + * @method Package create() + * @method PackageEditor[] getObjects() + * @method PackageEditor getSingleObject() */ class PackageAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/package/installation/plugin/PackageInstallationPluginAction.class.php b/wcfsetup/install/files/lib/data/package/installation/plugin/PackageInstallationPluginAction.class.php index 6d6642f78e..ae36f05f4d 100644 --- a/wcfsetup/install/files/lib/data/package/installation/plugin/PackageInstallationPluginAction.class.php +++ b/wcfsetup/install/files/lib/data/package/installation/plugin/PackageInstallationPluginAction.class.php @@ -11,6 +11,10 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.package.installation.plugin * @category Community Framework + * + * @method PackageInstallationPlugin create() + * @method PackageInstallationPluginEditor[] getObjects() + * @method PackageInstallationPluginEditor getSingleObject() */ class PackageInstallationPluginAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/package/installation/queue/PackageInstallationQueueAction.class.php b/wcfsetup/install/files/lib/data/package/installation/queue/PackageInstallationQueueAction.class.php index 24055a8a01..2f8e3b0f9a 100644 --- a/wcfsetup/install/files/lib/data/package/installation/queue/PackageInstallationQueueAction.class.php +++ b/wcfsetup/install/files/lib/data/package/installation/queue/PackageInstallationQueueAction.class.php @@ -16,6 +16,10 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.package.installation.queue * @category Community Framework + * + * @method PackageInstallationQueue create() + * @method PackageInstallationQueueEditor[] getObjects() + * @method PackageInstallationQueueEditor getSingleObject() */ class PackageInstallationQueueAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/package/update/PackageUpdateAction.class.php b/wcfsetup/install/files/lib/data/package/update/PackageUpdateAction.class.php index 9f51eee7fb..4c58ebc7b0 100644 --- a/wcfsetup/install/files/lib/data/package/update/PackageUpdateAction.class.php +++ b/wcfsetup/install/files/lib/data/package/update/PackageUpdateAction.class.php @@ -26,6 +26,10 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.package.update * @category Community Framework + * + * @method PackageUpdate create() + * @method PackageUpdateEditor[] getObjects() + * @method PackageUpdateEditor getSingleObject() */ class PackageUpdateAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/package/update/server/PackageUpdateServerAction.class.php b/wcfsetup/install/files/lib/data/package/update/server/PackageUpdateServerAction.class.php index e924c53f01..3342288c0f 100644 --- a/wcfsetup/install/files/lib/data/package/update/server/PackageUpdateServerAction.class.php +++ b/wcfsetup/install/files/lib/data/package/update/server/PackageUpdateServerAction.class.php @@ -12,6 +12,10 @@ use wcf\data\IToggleAction; * @package com.woltlab.wcf * @subpackage data.package.update.server * @category Community Framework + * + * @method PackageUpdateServer create() + * @method PackageUpdateServerEditor[] getObjects() + * @method PackageUpdateServerEditor getSingleObject() */ class PackageUpdateServerAction extends AbstractDatabaseObjectAction implements IToggleAction { /** diff --git a/wcfsetup/install/files/lib/data/package/update/version/PackageUpdateVersionAction.class.php b/wcfsetup/install/files/lib/data/package/update/version/PackageUpdateVersionAction.class.php index 9c659c659a..84ec855942 100644 --- a/wcfsetup/install/files/lib/data/package/update/version/PackageUpdateVersionAction.class.php +++ b/wcfsetup/install/files/lib/data/package/update/version/PackageUpdateVersionAction.class.php @@ -11,6 +11,10 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.package.update.version * @category Community Framework + * + * @method PackageUpdateVersion create() + * @method PackageUpdateVersionEditor[] getObjects() + * @method PackageUpdateVersionEditor getSingleObject() */ class PackageUpdateVersionAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/page/PageAction.class.php b/wcfsetup/install/files/lib/data/page/PageAction.class.php index b038bddefe..96f39f74e8 100644 --- a/wcfsetup/install/files/lib/data/page/PageAction.class.php +++ b/wcfsetup/install/files/lib/data/page/PageAction.class.php @@ -18,6 +18,9 @@ use wcf\system\WCF; * @subpackage data.page * @category Community Framework * @since 2.2 + * + * @method PageEditor[] getObjects() + * @method PageEditor getSingleObject() */ class PageAction extends AbstractDatabaseObjectAction implements ISearchAction, IToggleAction { /** @@ -52,8 +55,10 @@ class PageAction extends AbstractDatabaseObjectAction implements ISearchAction, /** * @inheritDoc + * @return Page */ public function create() { + /** @var Page $page */ $page = parent::create(); // save page content diff --git a/wcfsetup/install/files/lib/data/paid/subscription/PaidSubscriptionAction.class.php b/wcfsetup/install/files/lib/data/paid/subscription/PaidSubscriptionAction.class.php index 623011aa67..f249f30b11 100644 --- a/wcfsetup/install/files/lib/data/paid/subscription/PaidSubscriptionAction.class.php +++ b/wcfsetup/install/files/lib/data/paid/subscription/PaidSubscriptionAction.class.php @@ -12,6 +12,9 @@ use wcf\data\IToggleAction; * @package com.woltlab.wcf * @subpackage data.paid.subscription * @category Community Framework + * + * @method PaidSubscriptionEditor[] getObjects() + * @method PaidSubscriptionEditor getSingleObject() */ class PaidSubscriptionAction extends AbstractDatabaseObjectAction implements IToggleAction { /** @@ -31,6 +34,7 @@ class PaidSubscriptionAction extends AbstractDatabaseObjectAction implements ITo /** * @inheritDoc + * @return PaidSubscription */ public function create() { $showOrder = 0; @@ -39,6 +43,7 @@ class PaidSubscriptionAction extends AbstractDatabaseObjectAction implements ITo unset($this->parameters['data']['showOrder']); } + /** @var PaidSubscription $subscription */ $subscription = parent::create(); $editor = new PaidSubscriptionEditor($subscription); $editor->setShowOrder($showOrder); diff --git a/wcfsetup/install/files/lib/data/paid/subscription/transaction/log/PaidSubscriptionTransactionLogAction.class.php b/wcfsetup/install/files/lib/data/paid/subscription/transaction/log/PaidSubscriptionTransactionLogAction.class.php index 61d7c210d6..fc0800b28f 100644 --- a/wcfsetup/install/files/lib/data/paid/subscription/transaction/log/PaidSubscriptionTransactionLogAction.class.php +++ b/wcfsetup/install/files/lib/data/paid/subscription/transaction/log/PaidSubscriptionTransactionLogAction.class.php @@ -11,5 +11,9 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.paid.subscription.transaction.log * @category Community Framework + * + * @method PaidSubscriptionTransactionLog create() + * @method PaidSubscriptionTransactionLogEditor[] getObjects() + * @method PaidSubscriptionTransactionLogEditor getSingleObject() */ class PaidSubscriptionTransactionLogAction extends AbstractDatabaseObjectAction {} diff --git a/wcfsetup/install/files/lib/data/paid/subscription/user/PaidSubscriptionUserAction.class.php b/wcfsetup/install/files/lib/data/paid/subscription/user/PaidSubscriptionUserAction.class.php index cc7277f2c2..3b9ed6121e 100644 --- a/wcfsetup/install/files/lib/data/paid/subscription/user/PaidSubscriptionUserAction.class.php +++ b/wcfsetup/install/files/lib/data/paid/subscription/user/PaidSubscriptionUserAction.class.php @@ -17,6 +17,9 @@ use wcf\util\DateUtil; * @package com.woltlab.wcf * @subpackage data.paid.subscription.user * @category Community Framework + * + * @method PaidSubscriptionUserEditor[] getObjects() + * @method PaidSubscriptionUserEditor getSingleObject() */ class PaidSubscriptionUserAction extends AbstractDatabaseObjectAction { /** @@ -36,6 +39,7 @@ class PaidSubscriptionUserAction extends AbstractDatabaseObjectAction { /** * @inheritDoc + * @return PaidSubscriptionUser */ public function create() { $this->parameters['data']['subscriptionID'] = $this->parameters['subscription']->subscriptionID; @@ -53,6 +57,7 @@ class PaidSubscriptionUserAction extends AbstractDatabaseObjectAction { } if (!isset($this->parameters['data']['isActive'])) $this->parameters['data']['isActive'] = 1; + /** @var PaidSubscriptionUser $subscriptionUser */ $subscriptionUser = parent::create(); // update group memberships diff --git a/wcfsetup/install/files/lib/data/poll/PollAction.class.php b/wcfsetup/install/files/lib/data/poll/PollAction.class.php index b35417e3d6..29962e3044 100644 --- a/wcfsetup/install/files/lib/data/poll/PollAction.class.php +++ b/wcfsetup/install/files/lib/data/poll/PollAction.class.php @@ -19,6 +19,9 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.poll * @category Community Framework + * + * @method PollEditor[] getObjects() + * @method PollEditor getSingleObject() */ class PollAction extends AbstractDatabaseObjectAction implements IGroupedUserListAction { /** @@ -39,11 +42,12 @@ class PollAction extends AbstractDatabaseObjectAction implements IGroupedUserLis /** * @inheritDoc + * @return Poll */ public function create() { if (!isset($this->parameters['data']['time'])) $this->parameters['data']['time'] = TIME_NOW; - // create poll + /** @var Poll $poll */ $poll = parent::create(); // create options diff --git a/wcfsetup/install/files/lib/data/poll/option/PollOptionAction.class.php b/wcfsetup/install/files/lib/data/poll/option/PollOptionAction.class.php index a2b29f1042..73f8a309aa 100644 --- a/wcfsetup/install/files/lib/data/poll/option/PollOptionAction.class.php +++ b/wcfsetup/install/files/lib/data/poll/option/PollOptionAction.class.php @@ -11,6 +11,10 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.poll.option * @category Community Framework + * + * @method PollOption create() + * @method PollOptionEditor[] getObjects() + * @method PollOptionEditor getSingleObject() */ class PollOptionAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/search/SearchAction.class.php b/wcfsetup/install/files/lib/data/search/SearchAction.class.php index 2d0b21206e..9d0c6b953a 100644 --- a/wcfsetup/install/files/lib/data/search/SearchAction.class.php +++ b/wcfsetup/install/files/lib/data/search/SearchAction.class.php @@ -11,6 +11,10 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.search * @category Community Framework + * + * @method Search create() + * @method SearchEditor[] getObjects() + * @method SearchEditor getSingleObject() */ class SearchAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/search/keyword/SearchKeywordAction.class.php b/wcfsetup/install/files/lib/data/search/keyword/SearchKeywordAction.class.php index 4e81403e51..22d22827d9 100644 --- a/wcfsetup/install/files/lib/data/search/keyword/SearchKeywordAction.class.php +++ b/wcfsetup/install/files/lib/data/search/keyword/SearchKeywordAction.class.php @@ -13,6 +13,10 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.search.keyword * @category Community Framework + * + * @method SearchKeyword create() + * @method SearchKeywordEditor[] getObjects() + * @method SearchKeywordEditor getSingleObject() */ class SearchKeywordAction extends AbstractDatabaseObjectAction implements ISearchAction { /** diff --git a/wcfsetup/install/files/lib/data/session/SessionAction.class.php b/wcfsetup/install/files/lib/data/session/SessionAction.class.php index 5358760c51..bbe9bf7682 100644 --- a/wcfsetup/install/files/lib/data/session/SessionAction.class.php +++ b/wcfsetup/install/files/lib/data/session/SessionAction.class.php @@ -15,6 +15,10 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.session * @category Community Framework + * + * @method Session create() + * @method SessionEditor[] getObjects() + * @method SessionEditor getSingleObject() */ class SessionAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/session/virtual/SessionVirtualAction.class.php b/wcfsetup/install/files/lib/data/session/virtual/SessionVirtualAction.class.php index f54456eede..5659f9afdd 100644 --- a/wcfsetup/install/files/lib/data/session/virtual/SessionVirtualAction.class.php +++ b/wcfsetup/install/files/lib/data/session/virtual/SessionVirtualAction.class.php @@ -12,6 +12,10 @@ use wcf\data\acp\session\virtual\ACPSessionVirtualAction; * @package com.woltlab.wcf * @subpackage data.session.virtual * @category Community Framework + * + * @method SessionVirtual create() + * @method SessionVirtualEditor[] getObjects() + * @method SessionVirtualEditor getSingleObject() */ class SessionVirtualAction extends ACPSessionVirtualAction { /** diff --git a/wcfsetup/install/files/lib/data/sitemap/SitemapAction.class.php b/wcfsetup/install/files/lib/data/sitemap/SitemapAction.class.php index 039be32ee5..768b9bad3c 100644 --- a/wcfsetup/install/files/lib/data/sitemap/SitemapAction.class.php +++ b/wcfsetup/install/files/lib/data/sitemap/SitemapAction.class.php @@ -13,6 +13,10 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.sitemap * @category Community Framework + * + * @method Sitemap create() + * @method SitemapEditor[] getObjects() + * @method SitemapEditor getSingleObject() */ class SitemapAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/smiley/SmileyAction.class.php b/wcfsetup/install/files/lib/data/smiley/SmileyAction.class.php index 4105973227..c3e7fb15c7 100644 --- a/wcfsetup/install/files/lib/data/smiley/SmileyAction.class.php +++ b/wcfsetup/install/files/lib/data/smiley/SmileyAction.class.php @@ -15,6 +15,9 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.smiley * @category Community Framework + * + * @method SmileyEditor[] getObjects() + * @method SmileyEditor getSingleObject() */ class SmileyAction extends AbstractDatabaseObjectAction implements ISortableAction { /** @@ -39,8 +42,10 @@ class SmileyAction extends AbstractDatabaseObjectAction implements ISortableActi /** * @inheritDoc + * @return Smiley */ public function create() { + /** @var Smiley $smiley */ $smiley = parent::create(); if (!empty($this->parameters['fileLocation'])) { diff --git a/wcfsetup/install/files/lib/data/smiley/category/SmileyCategoryAction.class.php b/wcfsetup/install/files/lib/data/smiley/category/SmileyCategoryAction.class.php index 2a442fd577..8223e123e0 100644 --- a/wcfsetup/install/files/lib/data/smiley/category/SmileyCategoryAction.class.php +++ b/wcfsetup/install/files/lib/data/smiley/category/SmileyCategoryAction.class.php @@ -1,5 +1,6 @@ parameters['source'])) { diff --git a/wcfsetup/install/files/lib/data/template/group/TemplateGroupAction.class.php b/wcfsetup/install/files/lib/data/template/group/TemplateGroupAction.class.php index a1a31256d9..3a7220da32 100644 --- a/wcfsetup/install/files/lib/data/template/group/TemplateGroupAction.class.php +++ b/wcfsetup/install/files/lib/data/template/group/TemplateGroupAction.class.php @@ -11,6 +11,10 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.template.group * @category Community Framework + * + * @method TemplateGroup create() + * @method TemplateGroupEditor[] getObjects() + * @method TemplateGroupEditor getSingleObject() */ class TemplateGroupAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/template/listener/TemplateListenerAction.class.php b/wcfsetup/install/files/lib/data/template/listener/TemplateListenerAction.class.php index 2ece26cb4b..3e141e6221 100644 --- a/wcfsetup/install/files/lib/data/template/listener/TemplateListenerAction.class.php +++ b/wcfsetup/install/files/lib/data/template/listener/TemplateListenerAction.class.php @@ -11,6 +11,10 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.template.listener * @category Community Framework + * + * @method TemplateListener create() + * @method TemplateListenerEditor[] getObjects() + * @method TemplateListenerEditor getSingleObject() */ class TemplateListenerAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/user/UserAction.class.php b/wcfsetup/install/files/lib/data/user/UserAction.class.php index 80f6aa5f49..53ddb1b33f 100644 --- a/wcfsetup/install/files/lib/data/user/UserAction.class.php +++ b/wcfsetup/install/files/lib/data/user/UserAction.class.php @@ -25,6 +25,9 @@ use wcf\util\UserRegistrationUtil; * @package com.woltlab.wcf * @subpackage data.user * @category Community Framework + * + * @method UserEditor[] getObjects() + * @method UserEditor getSingleObject() */ class UserAction extends AbstractDatabaseObjectAction implements IClipboardAction, ISearchAction { /** @@ -246,8 +249,7 @@ class UserAction extends AbstractDatabaseObjectAction implements IClipboardActio } /** - * Creates a new user. - * + * @inheritDoc * @return User */ public function create() { @@ -255,6 +257,7 @@ class UserAction extends AbstractDatabaseObjectAction implements IClipboardActio $this->parameters['data']['socialNetworkPrivacySettings'] = ''; } + /** @var User $user */ $user = parent::create(); $userEditor = new UserEditor($user); diff --git a/wcfsetup/install/files/lib/data/user/activity/event/UserActivityEventAction.class.php b/wcfsetup/install/files/lib/data/user/activity/event/UserActivityEventAction.class.php index c8e3de6e68..00497eae96 100644 --- a/wcfsetup/install/files/lib/data/user/activity/event/UserActivityEventAction.class.php +++ b/wcfsetup/install/files/lib/data/user/activity/event/UserActivityEventAction.class.php @@ -15,6 +15,10 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.user.activity.event * @category Community Framework + * + * @method UserActivityEvent create() + * @method UserActivityEventEditor[] getObjects() + * @method UserActivityEventEditor getSingleObject() */ class UserActivityEventAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/user/authentication/failure/UserAuthenticationFailureAction.class.php b/wcfsetup/install/files/lib/data/user/authentication/failure/UserAuthenticationFailureAction.class.php index 2a8d4fc86b..b27a0c43f7 100644 --- a/wcfsetup/install/files/lib/data/user/authentication/failure/UserAuthenticationFailureAction.class.php +++ b/wcfsetup/install/files/lib/data/user/authentication/failure/UserAuthenticationFailureAction.class.php @@ -11,6 +11,9 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.user.authentication.failure * @category Community Framework + * + * @method UserAuthenticationFailure create() + * @method UserAuthenticationFailureEditor[] getObjects() + * @method UserAuthenticationFailureEditor getSingleObject() */ -class UserAuthenticationFailureAction extends AbstractDatabaseObjectAction { -} +class UserAuthenticationFailureAction extends AbstractDatabaseObjectAction { } diff --git a/wcfsetup/install/files/lib/data/user/avatar/UserAvatarAction.class.php b/wcfsetup/install/files/lib/data/user/avatar/UserAvatarAction.class.php index 9ada63005d..6738703db7 100644 --- a/wcfsetup/install/files/lib/data/user/avatar/UserAvatarAction.class.php +++ b/wcfsetup/install/files/lib/data/user/avatar/UserAvatarAction.class.php @@ -25,6 +25,10 @@ use wcf\util\HTTPRequest; * @package com.woltlab.wcf * @subpackage data.user.avatar * @category Community Framework + * + * @method UserAvatar create() + * @method UserAvatarEditor[] getObjects() + * @method UserAvatarEditor getSingleObject() */ class UserAvatarAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/user/follow/UserFollowAction.class.php b/wcfsetup/install/files/lib/data/user/follow/UserFollowAction.class.php index c356bc7319..ace89e95cc 100644 --- a/wcfsetup/install/files/lib/data/user/follow/UserFollowAction.class.php +++ b/wcfsetup/install/files/lib/data/user/follow/UserFollowAction.class.php @@ -22,6 +22,10 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.user.follow * @category Community Framework + * + * @method UserFollow create() + * @method UserFollowEditor[] getObjects() + * @method UserFollowEditor getSingleObject() */ class UserFollowAction extends AbstractDatabaseObjectAction implements IGroupedUserListAction { /** diff --git a/wcfsetup/install/files/lib/data/user/group/UserGroupAction.class.php b/wcfsetup/install/files/lib/data/user/group/UserGroupAction.class.php index 154576c727..0f7ba3ac84 100644 --- a/wcfsetup/install/files/lib/data/user/group/UserGroupAction.class.php +++ b/wcfsetup/install/files/lib/data/user/group/UserGroupAction.class.php @@ -16,6 +16,9 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.user.group * @category Community Framework + * + * @method UserGroupEditor[] getObjects() + * @method UserGroupEditor getSingleObject() */ class UserGroupAction extends AbstractDatabaseObjectAction { /** @@ -51,8 +54,10 @@ class UserGroupAction extends AbstractDatabaseObjectAction { /** * @inheritDoc + * @return UserGroup */ public function create() { + /** @var UserGroup $group */ $group = parent::create(); if (isset($this->parameters['options'])) { diff --git a/wcfsetup/install/files/lib/data/user/group/assignment/UserGroupAssignmentAction.class.php b/wcfsetup/install/files/lib/data/user/group/assignment/UserGroupAssignmentAction.class.php index b7115ee08c..d18d157c13 100644 --- a/wcfsetup/install/files/lib/data/user/group/assignment/UserGroupAssignmentAction.class.php +++ b/wcfsetup/install/files/lib/data/user/group/assignment/UserGroupAssignmentAction.class.php @@ -13,6 +13,10 @@ use wcf\system\condition\ConditionHandler; * @package com.woltlab.wcf * @subpackage data.user.group.assignment * @category Community Framework + * + * @method UserGroupAssignment create() + * @method UserGroupAssignmentEditor[] getObjects() + * @method UserGroupAssignmentEditor getSingleObject() */ class UserGroupAssignmentAction extends AbstractDatabaseObjectAction implements IToggleAction { /** diff --git a/wcfsetup/install/files/lib/data/user/group/option/UserGroupOptionAction.class.php b/wcfsetup/install/files/lib/data/user/group/option/UserGroupOptionAction.class.php index c729d0ad17..205d872e50 100644 --- a/wcfsetup/install/files/lib/data/user/group/option/UserGroupOptionAction.class.php +++ b/wcfsetup/install/files/lib/data/user/group/option/UserGroupOptionAction.class.php @@ -13,6 +13,10 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.user.group.option * @category Community Framework + * + * @method UserGroupOption create() + * @method UserGroupOptionEditor[] getObjects() + * @method UserGroupOptionEditor getSingleObject() */ class UserGroupOptionAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/user/group/option/category/UserGroupOptionCategoryAction.class.php b/wcfsetup/install/files/lib/data/user/group/option/category/UserGroupOptionCategoryAction.class.php index 766c160c52..e12e1a001c 100644 --- a/wcfsetup/install/files/lib/data/user/group/option/category/UserGroupOptionCategoryAction.class.php +++ b/wcfsetup/install/files/lib/data/user/group/option/category/UserGroupOptionCategoryAction.class.php @@ -11,6 +11,10 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.user.group.option.category * @category Community Framework + * + * @method UserGroupOptionCategory create() + * @method UserGroupOptionCategoryEditor[] getObjects() + * @method UserGroupOptionCategoryEditor getSingleObject() */ class UserGroupOptionCategoryAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/user/ignore/UserIgnoreAction.class.php b/wcfsetup/install/files/lib/data/user/ignore/UserIgnoreAction.class.php index 1e845c2f4b..6585e25df3 100644 --- a/wcfsetup/install/files/lib/data/user/ignore/UserIgnoreAction.class.php +++ b/wcfsetup/install/files/lib/data/user/ignore/UserIgnoreAction.class.php @@ -19,6 +19,10 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.user.ignore * @category Community Framework + * + * @method UserIgnore create() + * @method UserIgnoreEditor[] getObjects() + * @method UserIgnoreEditor getSingleObject() */ class UserIgnoreAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/user/menu/item/UserMenuItemAction.class.php b/wcfsetup/install/files/lib/data/user/menu/item/UserMenuItemAction.class.php index 605e35358c..35c618365a 100644 --- a/wcfsetup/install/files/lib/data/user/menu/item/UserMenuItemAction.class.php +++ b/wcfsetup/install/files/lib/data/user/menu/item/UserMenuItemAction.class.php @@ -11,5 +11,9 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.user.menu.item * @category Community Framework + * + * @method UserMenuItem create() + * @method UserMenuItemEditor[] getObjects() + * @method UserMenuItemEditor getSingleObject() */ class UserMenuItemAction extends AbstractDatabaseObjectAction { } diff --git a/wcfsetup/install/files/lib/data/user/notification/UserNotificationAction.class.php b/wcfsetup/install/files/lib/data/user/notification/UserNotificationAction.class.php index cc293910ab..2dd5572b90 100644 --- a/wcfsetup/install/files/lib/data/user/notification/UserNotificationAction.class.php +++ b/wcfsetup/install/files/lib/data/user/notification/UserNotificationAction.class.php @@ -15,6 +15,9 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.user.notification * @category Community Framework + * + * @method UserNotificationEditor[] getObjects() + * @method UserNotificationEditor getSingleObject() */ class UserNotificationAction extends AbstractDatabaseObjectAction { /** @@ -25,8 +28,10 @@ class UserNotificationAction extends AbstractDatabaseObjectAction { /** * @inheritDoc + * @return UserNotification */ public function create() { + /** @var UserNotification $notification */ $notification = parent::create(); $sql = "INSERT INTO wcf".WCF_N."_user_notification_to_user diff --git a/wcfsetup/install/files/lib/data/user/notification/event/UserNotificationEventAction.class.php b/wcfsetup/install/files/lib/data/user/notification/event/UserNotificationEventAction.class.php index a8326c4927..a9097f9dd6 100644 --- a/wcfsetup/install/files/lib/data/user/notification/event/UserNotificationEventAction.class.php +++ b/wcfsetup/install/files/lib/data/user/notification/event/UserNotificationEventAction.class.php @@ -12,12 +12,17 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.user.notification.event * @category Community Framework + * + * @method UserNotificationEventEditor[] getObjects() + * @method UserNotificationEventEditor getSingleObject() */ class UserNotificationEventAction extends AbstractDatabaseObjectAction { /** * @inheritDoc + * @return UserNotificationEvent */ public function create() { + /** @var UserNotificationEvent $event */ $event = parent::create(); if ($event->preset) { diff --git a/wcfsetup/install/files/lib/data/user/object/watch/UserObjectWatchAction.class.php b/wcfsetup/install/files/lib/data/user/object/watch/UserObjectWatchAction.class.php index 16efdbe5ce..d67da0c5f6 100644 --- a/wcfsetup/install/files/lib/data/user/object/watch/UserObjectWatchAction.class.php +++ b/wcfsetup/install/files/lib/data/user/object/watch/UserObjectWatchAction.class.php @@ -15,6 +15,10 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.user.object.watch * @category Community Framework + * + * @method UserObjectWatch create() + * @method UserObjectWatchEditor[] getObjects() + * @method UserObjectWatchEditor getSingleObject() */ class UserObjectWatchAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/user/option/UserOptionAction.class.php b/wcfsetup/install/files/lib/data/user/option/UserOptionAction.class.php index 15ae734a47..8a0cdf4011 100644 --- a/wcfsetup/install/files/lib/data/user/option/UserOptionAction.class.php +++ b/wcfsetup/install/files/lib/data/user/option/UserOptionAction.class.php @@ -13,6 +13,10 @@ use wcf\system\exception\PermissionDeniedException; * @package com.woltlab.wcf * @subpackage data.user.option * @category Community Framework + * + * @method UserOption create() + * @method UserOptionEditor[] getObjects() + * @method UserOptionEditor getSingleObject() */ class UserOptionAction extends AbstractDatabaseObjectAction implements IToggleAction { /** diff --git a/wcfsetup/install/files/lib/data/user/option/category/UserOptionCategoryAction.class.php b/wcfsetup/install/files/lib/data/user/option/category/UserOptionCategoryAction.class.php index 95e0385eff..9121b1f8ae 100644 --- a/wcfsetup/install/files/lib/data/user/option/category/UserOptionCategoryAction.class.php +++ b/wcfsetup/install/files/lib/data/user/option/category/UserOptionCategoryAction.class.php @@ -11,6 +11,10 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.user.option.category * @category Community Framework + * + * @method UserOptionCategory create() + * @method UserOptionCategoryEditor[] getObjects() + * @method UserOptionCategoryEditor getSingleObject() */ class UserOptionCategoryAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/user/profile/menu/item/UserProfileMenuItemAction.class.php b/wcfsetup/install/files/lib/data/user/profile/menu/item/UserProfileMenuItemAction.class.php index ce0647f36c..236776978e 100644 --- a/wcfsetup/install/files/lib/data/user/profile/menu/item/UserProfileMenuItemAction.class.php +++ b/wcfsetup/install/files/lib/data/user/profile/menu/item/UserProfileMenuItemAction.class.php @@ -14,6 +14,10 @@ use wcf\system\menu\user\profile\UserProfileMenu; * @package com.woltlab.wcf * @subpackage data.user.profile.menu.item * @category Community Framework + * + * @method UserProfileMenuItem create() + * @method UserProfileMenuItemEditor[] getObjects() + * @method UserProfileMenuItemEditor getSingleObject() */ class UserProfileMenuItemAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/user/profile/visitor/UserProfileVisitorAction.class.php b/wcfsetup/install/files/lib/data/user/profile/visitor/UserProfileVisitorAction.class.php index a82a31092d..774ae4c674 100644 --- a/wcfsetup/install/files/lib/data/user/profile/visitor/UserProfileVisitorAction.class.php +++ b/wcfsetup/install/files/lib/data/user/profile/visitor/UserProfileVisitorAction.class.php @@ -17,6 +17,10 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.user.profile.visitor * @category Community Framework + * + * @method UserProfileVisitor create() + * @method UserProfileVisitorEditor[] getObjects() + * @method UserProfileVisitorEditor getSingleObject() */ class UserProfileVisitorAction extends AbstractDatabaseObjectAction implements IGroupedUserListAction { /** diff --git a/wcfsetup/install/files/lib/data/user/rank/UserRankAction.class.php b/wcfsetup/install/files/lib/data/user/rank/UserRankAction.class.php index 86db16b6af..b432f73943 100644 --- a/wcfsetup/install/files/lib/data/user/rank/UserRankAction.class.php +++ b/wcfsetup/install/files/lib/data/user/rank/UserRankAction.class.php @@ -11,6 +11,10 @@ use wcf\data\AbstractDatabaseObjectAction; * @package com.woltlab.wcf * @subpackage data.user.rank * @category Community Framework + * + * @method UserRank create() + * @method UserRankEditor[] getObjects() + * @method UserRankEditor getSingleObject() */ class UserRankAction extends AbstractDatabaseObjectAction { /**