gordonbanderson / silverstripe-comments

code/controllers/CommentingController.php

Doc Comments +2 added lines, -1 removed lines

@@ -120,7 +120,7 @@ 
 	 * Get the commenting option for the current state
 	 *
 	 * @param string $key
-	 * @return mixed Result if the setting is available, or null otherwise
+	 * @return integer Result if the setting is available, or null otherwise
 	 */
 	public function getOption($key) {
 		// If possible use the current record
@@ -280,6 +280,7 @@ 
      * Redirect back to referer if available, ensuring that only site URLs
      * are allowed to avoid phishing.  If it's an AJAX request render the
      * comment in it's new state
+     * @param DataObject $comment
      */
     private function renderChangedCommentState($comment) {
         $referer = $this->request->getHeader('Referer');

Indentation +30 added lines, -30 removed lines

@@ -243,7 +243,7 @@ 
 		if(!$comment->getSecurityToken()->checkRequest($this->request)) return $this->httpError(400);
 
 		$comment->markSpam();
-        return $this->renderChangedCommentState($comment);
+		return $this->renderChangedCommentState($comment);
 	}
 
 	/**
@@ -258,7 +258,7 @@ 
 		if(!$comment->getSecurityToken()->checkRequest($this->request)) return $this->httpError(400);
 
 		$comment->markApproved();
-        return $this->renderChangedCommentState($comment);
+		return $this->renderChangedCommentState($comment);
 	}
 
 	/**
@@ -273,36 +273,36 @@ 
 		if(!$comment->getSecurityToken()->checkRequest($this->request)) return $this->httpError(400);
 
 		$comment->markApproved();
-        return $this->renderChangedCommentState($comment);
+		return $this->renderChangedCommentState($comment);
 	}
 
-    /**
-     * Redirect back to referer if available, ensuring that only site URLs
-     * are allowed to avoid phishing.  If it's an AJAX request render the
-     * comment in it's new state
-     */
-    private function renderChangedCommentState($comment) {
-        $referer = $this->request->getHeader('Referer');
-
-        // Render comment using AJAX
-        if ($this->request->isAjax()) {
-            return $comment->renderWith('CommentsInterface_singlecomment');
-        } else {
-            // Redirect to either the comment or start of the page
-            if (empty($referer)) {
-                return $this->redirectBack();
-            } else {
-                // Redirect to the comment, but check for phishing
-                $url = $referer . '#comment-' . $comment->ID;
-                // absolute redirection URLs not located on this site may cause phishing
-                if(Director::is_site_url($url)) {
-                    return $this->redirect($url);
-                } else {
-                    return false;
-                }
-            }
-        }
-    }
+	/**
+	 * Redirect back to referer if available, ensuring that only site URLs
+	 * are allowed to avoid phishing.  If it's an AJAX request render the
+	 * comment in it's new state
+	 */
+	private function renderChangedCommentState($comment) {
+		$referer = $this->request->getHeader('Referer');
+
+		// Render comment using AJAX
+		if ($this->request->isAjax()) {
+			return $comment->renderWith('CommentsInterface_singlecomment');
+		} else {
+			// Redirect to either the comment or start of the page
+			if (empty($referer)) {
+				return $this->redirectBack();
+			} else {
+				// Redirect to the comment, but check for phishing
+				$url = $referer . '#comment-' . $comment->ID;
+				// absolute redirection URLs not located on this site may cause phishing
+				if(Director::is_site_url($url)) {
+					return $this->redirect($url);
+				} else {
+					return false;
+				}
+			}
+		}
+	}
 
 	/**
 	 * Returns the comment referenced in the URL (by ID). Permission checking

Spacing +50 added lines, -50 removed lines

@@ -124,12 +124,12 @@ 
 	 */
 	public function getOption($key) {
 		// If possible use the current record
-		if($record = $this->getOwnerRecord()) {
+		if ($record = $this->getOwnerRecord()) {
 			return $record->getCommentsOption($key);
 		}
 
 		// Otherwise a singleton of that record
-		if($class = $this->getBaseClass()) {
+		if ($class = $this->getBaseClass()) {
 			return singleton($class)->getCommentsOption($key);
 		}
 
@@ -143,7 +143,7 @@ 
 	 * @return string
 	 */
 	public function Link($action = '', $id = '', $other = '') {
-		return Controller::join_links(Director::baseURL(), __CLASS__ , $action, $id, $other);
+		return Controller::join_links(Director::baseURL(), __CLASS__, $action, $id, $other);
 	}
 
 	/**
@@ -173,7 +173,7 @@ 
 		$id = $request->param('OtherID');
 
 		// Support old pageid param
-		if(!$id && !$class && ($id = $request->getVar('pageid'))) {
+		if (!$id && !$class && ($id = $request->getVar('pageid'))) {
 			$class = 'SiteTree';
 		}
 
@@ -183,8 +183,8 @@ 
 		));
 
 		// Check if class filter
-		if($class) {
-			if(!is_subclass_of($class, 'DataObject') || !$class::has_extension('CommentsExtension')) {
+		if ($class) {
+			if (!is_subclass_of($class, 'DataObject') || !$class::has_extension('CommentsExtension')) {
 				return $this->httpError(404);
 			}
 			$this->setBaseClass($class);
@@ -192,7 +192,7 @@ 
 			$link = Controller::join_links($link, $class);
 
 			// Check if id filter
-			if($id) {
+			if ($id) {
 				$comments = $comments->filter('ParentID', $id);
 				$link = Controller::join_links($link, $id);
 				$this->setOwnerRecord(DataObject::get_by_id($class, $id));
@@ -218,11 +218,11 @@ 
 	 */
 	public function delete() {
 		$comment = $this->getComment();
-		if(!$comment) return $this->httpError(404);
-		if(!$comment->canDelete()) {
+		if (!$comment) return $this->httpError(404);
+		if (!$comment->canDelete()) {
 			return Security::permissionFailure($this, 'You do not have permission to delete this comment');
 		}
-		if(!$comment->getSecurityToken()->checkRequest($this->request)) return $this->httpError(400);
+		if (!$comment->getSecurityToken()->checkRequest($this->request)) return $this->httpError(400);
 
 		$comment->delete();
 
@@ -236,11 +236,11 @@ 
 	 */
 	public function spam() {
 		$comment = $this->getComment();
-		if(!$comment) return $this->httpError(404);
-		if(!$comment->canEdit()) {
+		if (!$comment) return $this->httpError(404);
+		if (!$comment->canEdit()) {
 			return Security::permissionFailure($this, 'You do not have permission to edit this comment');
 		}
-		if(!$comment->getSecurityToken()->checkRequest($this->request)) return $this->httpError(400);
+		if (!$comment->getSecurityToken()->checkRequest($this->request)) return $this->httpError(400);
 
 		$comment->markSpam();
         return $this->renderChangedCommentState($comment);
@@ -251,11 +251,11 @@ 
 	 */
 	public function ham() {
 		$comment = $this->getComment();
-		if(!$comment) return $this->httpError(404);
-		if(!$comment->canEdit()) {
+		if (!$comment) return $this->httpError(404);
+		if (!$comment->canEdit()) {
 			return Security::permissionFailure($this, 'You do not have permission to edit this comment');
 		}
-		if(!$comment->getSecurityToken()->checkRequest($this->request)) return $this->httpError(400);
+		if (!$comment->getSecurityToken()->checkRequest($this->request)) return $this->httpError(400);
 
 		$comment->markApproved();
         return $this->renderChangedCommentState($comment);
@@ -266,11 +266,11 @@ 
 	 */
 	public function approve() {
 		$comment = $this->getComment();
-		if(!$comment) return $this->httpError(404);
-		if(!$comment->canEdit()) {
+		if (!$comment) return $this->httpError(404);
+		if (!$comment->canEdit()) {
 			return Security::permissionFailure($this, 'You do not have permission to approve this comment');
 		}
-		if(!$comment->getSecurityToken()->checkRequest($this->request)) return $this->httpError(400);
+		if (!$comment->getSecurityToken()->checkRequest($this->request)) return $this->httpError(400);
 
 		$comment->markApproved();
         return $this->renderChangedCommentState($comment);
@@ -295,7 +295,7 @@ 
                 // Redirect to the comment, but check for phishing
                 $url = $referer . '#comment-' . $comment->ID;
                 // absolute redirection URLs not located on this site may cause phishing
-                if(Director::is_site_url($url)) {
+                if (Director::is_site_url($url)) {
                     return $this->redirect($url);
                 } else {
                     return false;
@@ -313,10 +313,10 @@ 
 	public function getComment() {
 		$id = isset($this->urlParams['ID']) ? $this->urlParams['ID'] : false;
 
-		if($id) {
+		if ($id) {
 			$comment = DataObject::get_by_id('Comment', $id);
 
-			if($comment) {
+			if ($comment) {
 				$this->fallbackReturnURL = $comment->Link();
 				return $comment;
 			}
@@ -333,7 +333,7 @@ 
 	public function ReplyForm($comment) {
 		// Enables multiple forms with different names to use the same handler
 		$form = $this->CommentsForm();
-		$form->setName('ReplyForm_'.$comment->ID);
+		$form->setName('ReplyForm_' . $comment->ID);
 		$form->addExtraClass('reply-form');
 
 		// Load parent into reply form
@@ -357,9 +357,9 @@ 
 	 */
 	public function reply(SS_HTTPRequest $request) {
 		// Extract parent comment from reply and build this way
-		if($parentID = $request->param('ParentCommentID')) {
+		if ($parentID = $request->param('ParentCommentID')) {
 			$comment = DataObject::get_by_id('Comment', $parentID, true);
-			if($comment) {
+			if ($comment) {
 				return $this->ReplyForm($comment);
 			}
 		}
@@ -415,7 +415,7 @@ 
 
 		// Preview formatted comment. Makes most sense when shortcodes or
 		// limited HTML is allowed. Populated by JS/Ajax.
-		if($usePreview) {
+		if ($usePreview) {
 			$fields->insertAfter(
 				ReadonlyField::create('PreviewComment', _t('CommentInterface.PREVIEWLABEL', 'Preview'))
 					->setAttribute('style', 'display: none'), // enable through JS
@@ -429,7 +429,7 @@ 
 		$actions = new FieldList(
 			new FormAction("doPostComment", _t('CommentInterface.POST', 'Post'))
 		);
-		if($usePreview) {
+		if ($usePreview) {
 			$actions->push(
 				FormAction::create('doPreviewComment', _t('CommentInterface.PREVIEW', 'Preview'))
 					->addExtraClass('action-minor')
@@ -444,11 +444,11 @@ 
 		$form = new Form($this, 'CommentsForm', $fields, $actions, $required);
 
 		// if the record exists load the extra required data
-		if($record = $this->getOwnerRecord()) {
+		if ($record = $this->getOwnerRecord()) {
 
 			// Load member data
 			$member = Member::currentUser();
-			if(($record->CommentsRequireLogin || $record->PostingRequiredPermission) && $member) {
+			if (($record->CommentsRequireLogin || $record->PostingRequiredPermission) && $member) {
 				$fields = $form->Fields();
 
 				$fields->removeByName('Name');
@@ -471,7 +471,7 @@ 
 		$form->setRedirectToFormOnValidationError(true);
 
 		// load any data from the cookies
-		if($data = Cookie::get('CommentsForm_UserData')) {
+		if ($data = Cookie::get('CommentsForm_UserData')) {
 			$data = Convert::json2array($data);
 
 			$form->loadDataFrom(array(
@@ -481,12 +481,12 @@ 
 			));
 			// allow previous value to fill if comment not stored in cookie (i.e. validation error)
 			$prevComment = Cookie::get('CommentsForm_Comment');
-			if($prevComment && $prevComment != ''){
+			if ($prevComment && $prevComment != '') {
 				$form->loadDataFrom(array("Comment" => $prevComment));
 			}
 		}
 
-		if(!empty($member)) {
+		if (!empty($member)) {
 			$form->loadDataFrom($member);
 		}
 
@@ -504,13 +504,13 @@ 
 	 */
 	public function doPostComment($data, $form) {
 		// Load class and parent from data
-		if(isset($data['BaseClass'])) {
+		if (isset($data['BaseClass'])) {
 			$this->setBaseClass($data['BaseClass']);
 		}
-		if(isset($data['ParentID']) && ($class = $this->getBaseClass())) {
+		if (isset($data['ParentID']) && ($class = $this->getBaseClass())) {
 			$this->setOwnerRecord($class::get()->byID($data['ParentID']));
 		}
-		if(!$this->getOwnerRecord()) return $this->httpError(404);
+		if (!$this->getOwnerRecord()) return $this->httpError(404);
 
 		// cache users data
 		Cookie::set("CommentsForm_UserData", Convert::raw2json($data));
@@ -520,7 +520,7 @@ 
 		$this->extend('onBeforePostComment', $form);
 
 		// If commenting can only be done by logged in users, make sure the user is logged in
-		if(!$this->getOwnerRecord()->canPostComment()) {
+		if (!$this->getOwnerRecord()->canPostComment()) {
 			return Security::permissionFailure(
 				$this,
 				_t(
@@ -531,12 +531,12 @@ 
 			);
 		}
 
-		if($member = Member::currentUser()) {
+		if ($member = Member::currentUser()) {
 			$form->Fields()->push(new HiddenField("AuthorID", "Author ID", $member->ID));
 		}
 
 		// What kind of moderation is required?
-		switch($this->getOwnerRecord()->ModerationRequired) {
+		switch ($this->getOwnerRecord()->ModerationRequired) {
 			case 'Required':
 				$requireModeration = true;
 				break;
@@ -558,7 +558,7 @@ 
 		// Save into DB, or call pre-save hooks to give accurate preview
 		$usePreview = $this->getOption('use_preview');
 		$isPreview = $usePreview && !empty($data['IsPreview']);
-		if($isPreview) {
+		if ($isPreview) {
 			$comment->extend('onBeforeWrite');
 		} else {
 			$comment->write();
@@ -576,19 +576,19 @@ 
 		Cookie::set('CommentsForm_Comment', false);
 
 		// Find parent link
-		if(!empty($data['ReturnURL'])) {
+		if (!empty($data['ReturnURL'])) {
 			$url = $data['ReturnURL'];
-		} elseif($parent = $comment->getParent()) {
+		} elseif ($parent = $comment->getParent()) {
 			$url = $parent->Link();
 		} else {
 			return $this->redirectBack();
 		}
 
 		// Given a redirect page exists, attempt to link to the correct anchor
-		if($comment->IsSpam) {
+		if ($comment->IsSpam) {
 			// Link to the form with the error message contained
 			$hash = $form->FormName();
-		} else if(!$comment->Moderated) {
+		} else if (!$comment->Moderated) {
 			// Display the "awaiting moderation" text
 			$holder = $this->getOption('comments_holder_id');
 			$hash = "{$holder}_PostCommentForm_error";
@@ -615,21 +615,21 @@ 
 		// In edge-cases, this will be called outside of a handleRequest() context; in that case,
 		// redirect to the homepage - don't break into the global state at this stage because we'll
 		// be calling from a test context or something else where the global state is inappropraite
-		if($this->request) {
-			if($this->request->requestVar('BackURL')) {
+		if ($this->request) {
+			if ($this->request->requestVar('BackURL')) {
 				$url = $this->request->requestVar('BackURL');
-			} else if($this->request->isAjax() && $this->request->getHeader('X-Backurl')) {
+			} else if ($this->request->isAjax() && $this->request->getHeader('X-Backurl')) {
 				$url = $this->request->getHeader('X-Backurl');
-			} else if($this->request->getHeader('Referer')) {
+			} else if ($this->request->getHeader('Referer')) {
 				$url = $this->request->getHeader('Referer');
 			}
 		}
 
-		if(!$url) $url = $this->fallbackReturnURL;
-		if(!$url) $url = Director::baseURL();
+		if (!$url) $url = $this->fallbackReturnURL;
+		if (!$url) $url = Director::baseURL();
 
 		// absolute redirection URLs not located on this site may cause phishing
-		if(Director::is_site_url($url)) {
+		if (Director::is_site_url($url)) {
 			return $this->redirect($url);
 		} else {
 			return false;