And missing method documentation and throws tags

diff --git a/wcfsetup/install/files/lib/data/comment/CommentAction.class.php b/wcfsetup/install/files/lib/data/comment/CommentAction.class.php
index e4ebff444f6776e8ad74c429cc827ce6c5785419..3d21cfe44b3dfb2d698c554dce18e215411f389d 100644 (file)
--- a/wcfsetup/install/files/lib/data/comment/CommentAction.class.php
+++ b/wcfsetup/install/files/lib/data/comment/CommentAction.class.php
@@ -173,6 +173,8 @@ class CommentAction extends AbstractDatabaseObjectAction implements IMessageInli
        
        /**
         * Validates parameters to load comments.
+        * 
+        * @throws      PermissionDeniedException
         */
        public function validateLoadComments() {
                $this->readInteger('lastCommentTime', false, 'data');
@@ -208,6 +210,8 @@ class CommentAction extends AbstractDatabaseObjectAction implements IMessageInli
        
        /**
         * Validates the `loadComment` action.
+        * 
+        * @throws      PermissionDeniedException
         */
        public function validateLoadComment() {
                $this->readInteger('objectID', false, 'data');
@@ -278,6 +282,8 @@ class CommentAction extends AbstractDatabaseObjectAction implements IMessageInli
        
        /**
         * Validates parameters to add a comment.
+        * 
+        * @throws      PermissionDeniedException
         */
        public function validateAddComment() {
                CommentHandler::enforceFloodControl();
@@ -423,6 +429,8 @@ class CommentAction extends AbstractDatabaseObjectAction implements IMessageInli
        
        /**
         * Validates parameters to add a response.
+        * 
+        * @throws      PermissionDeniedException
         */
        public function validateAddResponse() {
                CommentHandler::enforceFloodControl();
@@ -532,6 +540,9 @@ class CommentAction extends AbstractDatabaseObjectAction implements IMessageInli
                ];
        }
        
+       /**
+        * Publishes a response.
+        */
        public function triggerPublicationResponse() {
                if (!empty($this->parameters['commentProcessor'])) {
                        $objectType = null;
@@ -634,6 +645,11 @@ class CommentAction extends AbstractDatabaseObjectAction implements IMessageInli
                }
        }
        
+       /**
+        * Validates the `enable` action.
+        * 
+        * @throws      PermissionDeniedException
+        */
        public function validateEnable() {
                $this->comment = $this->getSingleObject()->getDecoratedObject();
                
@@ -644,6 +660,11 @@ class CommentAction extends AbstractDatabaseObjectAction implements IMessageInli
                }
        }
        
+       /**
+        * Enables a comment.
+        * 
+        * @return      integer[]
+        */
        public function enable() {
                if ($this->comment === null) $this->comment = reset($this->objects);
                
@@ -660,6 +681,12 @@ class CommentAction extends AbstractDatabaseObjectAction implements IMessageInli
                return ['commentID' => $this->comment->commentID];
        }
        
+       /**
+        * Validates the `enableResponse` action.
+        * 
+        * @throws      PermissionDeniedException
+        * @throws      UserInputException
+        */
        public function validateEnableResponse() {
                $this->readInteger('responseID', false, 'data');
                $this->response = new CommentResponse($this->parameters['data']['responseID']);
@@ -676,6 +703,11 @@ class CommentAction extends AbstractDatabaseObjectAction implements IMessageInli
                }
        }
        
+       /**
+        * Enables a response.
+        * 
+        * @return      integer[]
+        */
        public function enableResponse() {
                if ($this->comment === null) $this->comment = reset($this->objects);
                if ($this->response === null) $this->response = reset($this->parameters['responses']);
@@ -696,6 +728,9 @@ class CommentAction extends AbstractDatabaseObjectAction implements IMessageInli
        
        /**
         * Validates parameters to edit a comment or a response.
+        * 
+        * @throws      PermissionDeniedException
+        * @throws      UserInputException
         */
        public function validatePrepareEdit() {
                // validate response id
@@ -821,6 +856,9 @@ class CommentAction extends AbstractDatabaseObjectAction implements IMessageInli
        
        /**
         * Validates parameters to remove a comment or response.
+        * 
+        * @throws      PermissionDeniedException
+        * @throws      UserInputException
         */
        public function validateRemove() {
                // validate comment id or response id
@@ -875,6 +913,8 @@ class CommentAction extends AbstractDatabaseObjectAction implements IMessageInli
        
        /**
         * Validates the 'getGuestDialog' action.
+        * 
+        * @throws      PermissionDeniedException
         */
        public function validateGetGuestDialog() {
                if (WCF::getUser()->userID) {
@@ -1065,6 +1105,8 @@ class CommentAction extends AbstractDatabaseObjectAction implements IMessageInli
        
        /**
         * Validates comment id parameter.
+        * 
+        * @throws      UserInputException
         */
        protected function validateCommentID() {
                $this->readInteger('commentID', false, 'data');
@@ -1077,6 +1119,8 @@ class CommentAction extends AbstractDatabaseObjectAction implements IMessageInli
        
        /**
         * Validates response id parameter.
+        * 
+        * @throws      UserInputException
         */
        protected function validateResponseID() {
                if (isset($this->parameters['data']['responseID'])) {
@@ -1110,6 +1154,8 @@ class CommentAction extends AbstractDatabaseObjectAction implements IMessageInli
        
        /**
         * Validates the captcha challenge.
+        * 
+        * @throws      SystemException
         */
        protected function validateCaptcha() {
                if (WCF::getUser()->userID) return;

diff --git a/wcfsetup/install/files/lib/data/user/UserProfileAction.class.php b/wcfsetup/install/files/lib/data/user/UserProfileAction.class.php
index 10996d3b197ef236f12eaaeff3d3af3c1b7f05d2..2ab198566f6008d08dd66a3b1de5eb934721f118 100644 (file)
--- a/wcfsetup/install/files/lib/data/user/UserProfileAction.class.php
+++ b/wcfsetup/install/files/lib/data/user/UserProfileAction.class.php
@@ -86,6 +86,8 @@ class UserProfileAction extends UserAction {
        
        /**
         * Validates user profile preview.
+        * 
+        * @throws      UserInputException
         */
        public function validateGetUserProfile() {
                WCF::getSession()->checkPermissions(['user.profile.canViewUserProfile']);
@@ -128,6 +130,8 @@ class UserProfileAction extends UserAction {
        
        /**
         * Validates detailed activity point list
+        * 
+        * @throws      UserInputException
         */
        public function validateGetDetailedActivityPointList() {
                if (count($this->objectIDs) != 1) {
@@ -177,6 +181,9 @@ class UserProfileAction extends UserAction {
        
        /**
         * Validates parameters to begin profile inline editing.
+        * 
+        * @throws      PermissionDeniedException
+        * @throws      UserInputException
         */
        public function validateBeginEdit() {
                if (!empty($this->objectIDs) && count($this->objectIDs) == 1) {
@@ -218,6 +225,8 @@ class UserProfileAction extends UserAction {
        
        /**
         * Validates parameters to save changes to user profile.
+        * 
+        * @throws      PermissionDeniedException
         */
        public function validateSave() {
                $this->validateBeginEdit();
@@ -559,12 +568,22 @@ class UserProfileAction extends UserAction {
                }
        }
        
+       /**
+        * Validates the `deleteCoverPhoto` action.
+        * 
+        * @throws      PermissionDeniedException
+        */
        public function validateDeleteCoverPhoto() {
                if (!MODULE_USER_COVER_PHOTO) {
                        throw new PermissionDeniedException();
                }
        }
        
+       /**
+        * Deletes the cover photo of the active user.
+        * 
+        * @return      string[]        link to the new cover photo
+        */
        public function deleteCoverPhoto() {
                if (WCF::getUser()->coverPhotoHash) {
                        UserProfileRuntimeCache::getInstance()->getObject(WCF::getUser()->userID)->getCoverPhoto()->delete();