silverstripe / silverstripe-akismet

code/AkismetField.php

Spacing +12 added lines, -12 removed lines

@@ -27,7 +27,7 @@ 
 	protected function confirmationField() {
 		// Check if confirmation is required
 		$requireConfirmation = Config::inst()->get('AkismetSpamProtector', 'require_confirmation');
-		if(empty($requireConfirmation)) return null;
+		if (empty($requireConfirmation)) return null;
 		
 		// If confirmation is required then return a checkbox
 		return CheckboxField::create(
@@ -41,24 +41,24 @@ 
 	
 	public function Field($properties = array()) {
 		$checkbox = $this->confirmationField();
-		if($checkbox) return $checkbox->Field($properties);
+		if ($checkbox) return $checkbox->Field($properties);
 	}
 	
 	function FieldHolder($properties = array()) {
 		$checkbox = $this->confirmationField();
-		if($checkbox) return $checkbox->FieldHolder($properties);
+		if ($checkbox) return $checkbox->FieldHolder($properties);
 	}
 	
 	/**
 	 * @return array
 	 */
 	public function getSpamMappedData() {
-		if(empty($this->fieldMapping)) return null;
+		if (empty($this->fieldMapping)) return null;
 		
 		$result = array();
 		$data = $this->form->getData();
 
-		foreach($this->fieldMapping as $fieldName => $mappedName) {
+		foreach ($this->fieldMapping as $fieldName => $mappedName) {
 			$result[$mappedName] = (isset($data[$fieldName])) ? $data[$fieldName] : null;
 		}
 
@@ -79,7 +79,7 @@ 
 		
 		// Check that, if necessary, the user has given permission to check for spam
 		$requireConfirmation = Config::inst()->get('AkismetSpamProtector', 'require_confirmation');
-		if($requireConfirmation && !$this->Value()) {
+		if ($requireConfirmation && !$this->Value()) {
 			$validator->validationError(
 				$this->name,
 				_t(
@@ -93,7 +93,7 @@ 
 		
 		// Check result
 		$isSpam = $this->getIsSpam();
-		if(!$isSpam) return true;
+		if (!$isSpam) return true;
 
 		// Save error message
 		$errorMessage = _t(
@@ -102,7 +102,7 @@ 
 		);
 
 		// If spam should be allowed, let it pass and save it for later
-		if(Config::inst()->get('AkismetSpamProtector', 'save_spam')) {
+		if (Config::inst()->get('AkismetSpamProtector', 'save_spam')) {
 			// In order to save spam but still display the spam message, we must mock a form message
 			// without failing the validation
 			$errors = array(array(
@@ -127,15 +127,15 @@ 
 	 */
 	public function getIsSpam() {
 		// Prevent multiple API calls
-		if($this->isSpam !== null) return $this->isSpam;
+		if ($this->isSpam !== null) return $this->isSpam;
 
 		// Check bypass permission
 		$permission = Config::inst()->get('AkismetSpamProtector', 'bypass_permission');
-		if($permission && Permission::check($permission)) return false;
+		if ($permission && Permission::check($permission)) return false;
 
 		// if the user has logged and there's no force check on member
 		$bypassMember = Config::inst()->get('AkismetSpamProtector', 'bypass_members');
-		if($bypassMember && Member::currentUser()) return false;
+		if ($bypassMember && Member::currentUser()) return false;
 
 		// Map input fields to spam fields
 		$mappedData = $this->getSpamMappedData();
@@ -180,7 +180,7 @@ 
 	 * @param \DataObjectInterface $record
 	 */
 	public function saveInto(\DataObjectInterface $record) {
-		if(Config::inst()->get('AkismetSpamProtector', 'save_spam')) {
+		if (Config::inst()->get('AkismetSpamProtector', 'save_spam')) {
 			$dataValue = $this->getIsSpam() ? 1 : 0;
 			$record->setCastedField($this->name, $dataValue);
 		}

Braces +24 added lines, -8 removed lines

@@ -27,7 +27,9 @@ 
 	protected function confirmationField() {
 		// Check if confirmation is required
 		$requireConfirmation = Config::inst()->get('AkismetSpamProtector', 'require_confirmation');
-		if(empty($requireConfirmation)) return null;
+		if(empty($requireConfirmation)) {
+			return null;
+		}
 		
 		// If confirmation is required then return a checkbox
 		return CheckboxField::create(
@@ -41,19 +43,25 @@ 
 	
 	public function Field($properties = array()) {
 		$checkbox = $this->confirmationField();
-		if($checkbox) return $checkbox->Field($properties);
+		if($checkbox) {
+			return $checkbox->Field($properties);
+		}
 	}
 	
 	function FieldHolder($properties = array()) {
 		$checkbox = $this->confirmationField();
-		if($checkbox) return $checkbox->FieldHolder($properties);
+		if($checkbox) {
+			return $checkbox->FieldHolder($properties);
+		}
 	}
 	
 	/**
 	 * @return array
 	 */
 	public function getSpamMappedData() {
-		if(empty($this->fieldMapping)) return null;
+		if(empty($this->fieldMapping)) {
+			return null;
+		}
 		
 		$result = array();
 		$data = $this->form->getData();
@@ -93,7 +101,9 @@ 
 		
 		// Check result
 		$isSpam = $this->getIsSpam();
-		if(!$isSpam) return true;
+		if(!$isSpam) {
+			return true;
+		}
 
 		// Save error message
 		$errorMessage = _t(
@@ -127,15 +137,21 @@ 
 	 */
 	public function getIsSpam() {
 		// Prevent multiple API calls
-		if($this->isSpam !== null) return $this->isSpam;
+		if($this->isSpam !== null) {
+			return $this->isSpam;
+		}
 
 		// Check bypass permission
 		$permission = Config::inst()->get('AkismetSpamProtector', 'bypass_permission');
-		if($permission && Permission::check($permission)) return false;
+		if($permission && Permission::check($permission)) {
+			return false;
+		}
 
 		// if the user has logged and there's no force check on member
 		$bypassMember = Config::inst()->get('AkismetSpamProtector', 'bypass_members');
-		if($bypassMember && Member::currentUser()) return false;
+		if($bypassMember && Member::currentUser()) {
+			return false;
+		}
 
 		// Map input fields to spam fields
 		$mappedData = $this->getSpamMappedData();

code/AkismetSpamProtector.php

Spacing +4 added lines, -4 removed lines

@@ -79,14 +79,14 @@ 
 	 * @return string
 	 */
 	protected static function get_api_key() {
-		if(self::$_api_key) return self::$_api_key;
+		if (self::$_api_key) return self::$_api_key;
 		
 		// Check config
 		$key = Config::inst()->get('AkismetSpamProtector', 'api_key');
-		if(!empty($key)) return $key;
+		if (!empty($key)) return $key;
 		
 		// Check environment
-		if(defined('SS_AKISMET_API_KEY')) return SS_AKISMET_API_KEY;
+		if (defined('SS_AKISMET_API_KEY')) return SS_AKISMET_API_KEY;
 	}
 	
 	/**
@@ -97,7 +97,7 @@ 
 	public static function api() {
 		// Get API key and URL
 		$key = self::get_api_key();
-		if(empty($key)) {
+		if (empty($key)) {
 			user_error("AkismetSpamProtector is incorrectly configured. Please specify an API key.", E_USER_WARNING);
 			return null;
 		}

Braces +9 added lines, -3 removed lines

@@ -79,14 +79,20 @@
 	 * @return string
 	 */
 	protected static function get_api_key() {
-		if(self::$_api_key) return self::$_api_key;
+		if(self::$_api_key) {
+			return self::$_api_key;
+		}
 		
 		// Check config
 		$key = Config::inst()->get('AkismetSpamProtector', 'api_key');
-		if(!empty($key)) return $key;
+		if(!empty($key)) {
+			return $key;
+		}
 		
 		// Check environment
-		if(defined('SS_AKISMET_API_KEY')) return SS_AKISMET_API_KEY;
+		if(defined('SS_AKISMET_API_KEY')) {
+			return SS_AKISMET_API_KEY;
+		}
 	}
 	
 	/**

code/config/AkismetProcessor.php

Spacing +6 added lines, -6 removed lines

@@ -11,18 +11,18 @@ 
 
 	public function preRequest(SS_HTTPRequest $request, Session $session, DataModel $model) {
 		// Skip if database isn't ready
-		if(!$this->isDBReady()) {
+		if (!$this->isDBReady()) {
 			return;
 		}
 
 		// Skip if SiteConfig doesn't have this extension
-		if(!SiteConfig::has_extension('AkismetConfig')) {
+		if (!SiteConfig::has_extension('AkismetConfig')) {
 			return;
 		}
 
 		// Check if key exists
 		$akismetKey = SiteConfig::current_site_config()->AkismetKey;
-		if($akismetKey) {
+		if ($akismetKey) {
 			AkismetSpamProtector::set_api_key($akismetKey);
 		}
 	}
@@ -33,18 +33,18 @@ 
 	 * @return bool
 	 */
 	protected function isDBReady() {
-		if(!DB::isActive()) {
+		if (!DB::isActive()) {
 			return false;
 		}
 
 		// Require table
-		if(!DB::getConn()->hasTable('SiteConfig')) {
+		if (!DB::getConn()->hasTable('SiteConfig')) {
 			return false;
 		}
 
 		// Ensure siteconfig has all fields necessary
 		$dbFields = DB::fieldList('SiteConfig');
-		if(empty($dbFields)) {
+		if (empty($dbFields)) {
 			return false;
 		}
 

code/service/AkismetService.php

Indentation +30 added lines, -30 removed lines

@@ -6,34 +6,34 @@
 interface AkismetService {
 	
 	/**
-     * Check if the comment is spam or not
-     * This is basically the core of everything. This call takes a number of
-     * arguments and characteristics about the submitted content and then
-     * returns a thumbs up or thumbs down.
-     * Almost everything is optional, but performance can drop dramatically if
-     * you exclude certain elements.
-     * REMARK: If you are having trouble triggering you can send
-     * "viagra-test-123" as the author and it will trigger a true response,
-     * always.
-     *
-     * @param string[optional] $content   The content that was submitted.
-     * @param string[optional] $author    The name.
-     * @param string[optional] $email     The email address.
-     * @param string[optional] $url       The URL.
-     * @param string[optional] $permalink The permanent location of the entry
-     *                                    the comment was submitted to.
-     * @param string[optional] $type The type, can be blank, comment,
-     *                                    trackback, pingback, or a made up
-     *                                    value like "registration".
-     * @return bool If the comment is spam true will be
-     *                                    returned, otherwise false.
-     */
-    public function isSpam(
-        $content,
-        $author = null,
-        $email = null,
-        $url = null,
-        $permalink = null,
-        $type = null
-    );
+	 * Check if the comment is spam or not
+	 * This is basically the core of everything. This call takes a number of
+	 * arguments and characteristics about the submitted content and then
+	 * returns a thumbs up or thumbs down.
+	 * Almost everything is optional, but performance can drop dramatically if
+	 * you exclude certain elements.
+	 * REMARK: If you are having trouble triggering you can send
+	 * "viagra-test-123" as the author and it will trigger a true response,
+	 * always.
+	 *
+	 * @param string[optional] $content   The content that was submitted.
+	 * @param string[optional] $author    The name.
+	 * @param string[optional] $email     The email address.
+	 * @param string[optional] $url       The URL.
+	 * @param string[optional] $permalink The permanent location of the entry
+	 *                                    the comment was submitted to.
+	 * @param string[optional] $type The type, can be blank, comment,
+	 *                                    trackback, pingback, or a made up
+	 *                                    value like "registration".
+	 * @return bool If the comment is spam true will be
+	 *                                    returned, otherwise false.
+	 */
+	public function isSpam(
+		$content,
+		$author = null,
+		$email = null,
+		$url = null,
+		$permalink = null,
+		$type = null
+	);
 }

tests/AkismetTest.php

Spacing +5 added lines, -5 removed lines

@@ -50,7 +50,7 @@ 
 		$this->assertEquals('person', $saved->Name);
 		$this->assertEquals('person@domain.com', $saved->Email);
 		$this->assertEquals('what a nice comment', $saved->Content);
-		$this->assertEquals(false, (bool)$saved->IsSpam);
+		$this->assertEquals(false, (bool) $saved->IsSpam);
 		$saved->delete();
 
 		// Test failed setting
@@ -87,7 +87,7 @@ 
 		$this->assertEquals('person', $saved->Name);
 		$this->assertEquals('person@domain.com', $saved->Email);
 		$this->assertEquals('what a nice comment', $saved->Content);
-		$this->assertEquals(false, (bool)$saved->IsSpam);
+		$this->assertEquals(false, (bool) $saved->IsSpam);
 		$saved->delete();
 
 		// Test failed setting
@@ -108,7 +108,7 @@ 
 		$this->assertEquals('spam', $saved->Name);
 		$this->assertEquals('spam@spam.com', $saved->Email);
 		$this->assertEquals('spam', $saved->Content);
-		$this->assertEquals(true, (bool)$saved->IsSpam);
+		$this->assertEquals(true, (bool) $saved->IsSpam);
 	}
 
 	/**
@@ -176,7 +176,7 @@ 
 		$item = new AkismetTest_Submission();
 		$form->saveInto($item);
 		$item->write();
-		$form->sessionMessage('Thanks for your submission, '. $data['Name'], 'good');
+		$form->sessionMessage('Thanks for your submission, ' . $data['Name'], 'good');
 		return $this->redirect($this->Link());
 	}
 }
@@ -184,7 +184,7 @@ 
 class AkismetTest_Service implements TestOnly, AkismetService {
 
 	public function __construct($apiKey, $url) {
-		if($apiKey !== 'dummykey') {
+		if ($apiKey !== 'dummykey') {
 			throw new Exception("Invalid key");
 		}
 	}