silverstripe / silverstripe-externallinks

code/model/BrokenExternalPageTrackStatus.php

Doc Comments +3 added lines

@@ -111,6 +111,9 @@
 		return $status;
 	}
 
+	/**
+	 * @param string $message
+	 */
 	public function updateJobInfo($message) {
 		$this->JobInfo = $message;
 		$this->write();

Spacing +1 added lines, -1 removed lines

@@ -40,7 +40,7 @@
 		$pageIDs = $this
 			->getIncompleteTracks()
 			->column('PageID');
-		if($pageIDs) return Versioned::get_by_stage('SiteTree', 'Stage')
+		if ($pageIDs) return Versioned::get_by_stage('SiteTree', 'Stage')
 			->byIDs($pageIDs);
 	}
 

Braces +3 added lines, -1 removed lines

@@ -40,8 +40,10 @@
 		$pageIDs = $this
 			->getIncompleteTracks()
 			->column('PageID');
-		if($pageIDs) return Versioned::get_by_stage('SiteTree', 'Stage')
+		if($pageIDs) {
+			return Versioned::get_by_stage('SiteTree', 'Stage')
 			->byIDs($pageIDs);
+		}
 	}
 
 	/**

code/controllers/CMSExternalLinks.php

Spacing +1 added lines, -1 removed lines

@@ -20,7 +20,7 @@
 
 		// Format status
 		$track = BrokenExternalPageTrackStatus::get_latest();
-		if($track) return json_encode(array(
+		if ($track) return json_encode(array(
 			'TrackID' => $track->ID,
 			'Status' => $track->Status,
 			'Completed' => $track->getCompletedPages(),

Braces +6 added lines, -2 removed lines

@@ -20,12 +20,14 @@ 
 
 		// Format status
 		$track = BrokenExternalPageTrackStatus::get_latest();
-		if($track) return json_encode(array(
+		if($track) {
+			return json_encode(array(
 			'TrackID' => $track->ID,
 			'Status' => $track->Status,
 			'Completed' => $track->getCompletedPages(),
 			'Total' => $track->getTotalPages()
 		));
+		}
 	}
 
 
@@ -35,7 +37,9 @@ 
 	public function start() {
 		// return if the a job is already running
 		$status = BrokenExternalPageTrackStatus::get_latest();
-		if ($status && $status->Status == 'Running') return;
+		if ($status && $status->Status == 'Running') {
+			return;
+		}
 
 		// Create a new job
 		if (class_exists('QueuedJobService')) {

code/jobs/CheckExternalLinksJob.php

Spacing +1 added lines, -1 removed lines

@@ -1,6 +1,6 @@
 <?php
 
-if(!class_exists('AbstractQueuedJob')) return;
+if (!class_exists('AbstractQueuedJob')) return;
 
 /**
  * A Job for running a external link check for published pages

Braces +3 added lines, -1 removed lines

@@ -1,6 +1,8 @@
 <?php
 
-if(!class_exists('AbstractQueuedJob')) return;
+if(!class_exists('AbstractQueuedJob')) {
+	return;
+}
 
 /**
  * A Job for running a external link check for published pages

code/model/BrokenExternalLink.php

Spacing +2 added lines, -2 removed lines

@@ -53,10 +53,10 @@
 	 */
 	public function getHTTPCodeDescription() {
 		$code = $this->HTTPCode;
-		if(empty($code)) {
+		if (empty($code)) {
 			// Assume that $code = 0 means there was no response
 			$description = _t('BrokenExternalLink.NOTAVAILABLE', 'Server Not Available');
-		} elseif(
+		} elseif (
 			($descriptions = Config::inst()->get('SS_HTTPResponse', 'status_codes'))
 			&& isset($descriptions[$code])
 		) {

code/reports/BrokenExternalLinksReport.php

Braces +3 added lines, -1 removed lines

@@ -56,7 +56,9 @@
 
 	public function sourceRecords() {
 		$track = BrokenExternalPageTrackStatus::get_latest();
-		if ($track) return $track->BrokenLinks();
+		if ($track) {
+			return $track->BrokenLinks();
+		}
 		return new ArrayList();
 	}
 

code/tasks/CheckExternalLinksTask.php

Spacing +11 added lines, -11 removed lines

@@ -28,7 +28,7 @@ 
 	 * @param string $message
 	 */
 	protected function log($message) {
-		if(!$this->silent) Debug::message($message);
+		if (!$this->silent) Debug::message($message);
 	}
 
 	public function run($request) {
@@ -70,10 +70,10 @@ 
 
 		// Check link
 		$httpCode = $this->linkChecker->checkLink($href);
-		if($httpCode === null) return; // Null link means uncheckable, such as an internal link
+		if ($httpCode === null) return; // Null link means uncheckable, such as an internal link
 
 		// If this code is broken then mark as such
-		if($foundBroken = $this->isCodeBroken($httpCode)) {
+		if ($foundBroken = $this->isCodeBroken($httpCode)) {
 			// Create broken record
 			$brokenLink = new BrokenExternalLink();
 			$brokenLink->Link = $href;
@@ -84,8 +84,8 @@ 
 		}
 
 		// Check if we need to update CSS class, otherwise return
-		if($markedBroken == $foundBroken) return;
-		if($foundBroken) {
+		if ($markedBroken == $foundBroken) return;
+		if ($foundBroken) {
 			$class .= ' ss-broken';
 		} else {
 			$class = preg_replace('/\s*\b(ss-broken)\b\s*/', ' ', $class);
@@ -101,11 +101,11 @@ 
 	 */
 	protected function isCodeBroken($httpCode) {
 		// Null represents no request attempted
-		if($httpCode === null) return false;
+		if ($httpCode === null) return false;
 
 		// do we have any whitelisted codes
 		$ignoreCodes = Config::inst()->get('CheckExternalLinks', 'IgnoreCodes');
-		if(is_array($ignoreCodes) && in_array($httpCode, $ignoreCodes)) return false;
+		if (is_array($ignoreCodes) && in_array($httpCode, $ignoreCodes)) return false;
 
 		// Check if code is outside valid range
 		return $httpCode < 200 || $httpCode > 302;
@@ -123,7 +123,7 @@ 
 
 		// Calculate pages to run
 		$pageTracks = $status->getIncompleteTracks();
-		if($limit) $pageTracks = $pageTracks->limit($limit);
+		if ($limit) $pageTracks = $pageTracks->limit($limit);
 
 		// Check each page
 		foreach ($pageTracks as $pageTrack) {
@@ -139,7 +139,7 @@ 
 
 			// Check each link
 			$links = $htmlValue->getElementsByTagName('a');
-			foreach($links as $link) {
+			foreach ($links as $link) {
 				$this->checkPageLink($pageTrack, $link);
 			}
 
@@ -151,7 +151,7 @@ 
 			// Once all links have been created for this page update HasBrokenLinks
 			$count = $pageTrack->BrokenLinks()->count();
 			$this->log("Found {$count} broken links");
-			if($count) {
+			if ($count) {
 				// Bypass the ORM as syncLinkTracking does not allow you to update HasBrokenLink to true
 				DB::query(sprintf(
 					'UPDATE "SiteTree" SET "HasBrokenLink" = 1 WHERE "ID" = \'%d\'',
@@ -180,7 +180,7 @@ 
 
 	private function updateJobInfo($message) {
 		$track = BrokenExternalPageTrackStatus::get_latest();
-		if($track) {
+		if ($track) {
 			$track->JobInfo = $message;
 			$track->write();
 		}

Braces +22 added lines, -7 removed lines

@@ -28,7 +28,9 @@ 
 	 * @param string $message
 	 */
 	protected function log($message) {
-		if(!$this->silent) Debug::message($message);
+		if(!$this->silent) {
+			Debug::message($message);
+		}
 	}
 
 	public function run($request) {
@@ -70,7 +72,10 @@ 
 
 		// Check link
 		$httpCode = $this->linkChecker->checkLink($href);
-		if($httpCode === null) return; // Null link means uncheckable, such as an internal link
+		if($httpCode === null) {
+			return;
+		}
+		// Null link means uncheckable, such as an internal link
 
 		// If this code is broken then mark as such
 		if($foundBroken = $this->isCodeBroken($httpCode)) {
@@ -84,7 +89,9 @@ 
 		}
 
 		// Check if we need to update CSS class, otherwise return
-		if($markedBroken == $foundBroken) return;
+		if($markedBroken == $foundBroken) {
+			return;
+		}
 		if($foundBroken) {
 			$class .= ' ss-broken';
 		} else {
@@ -101,11 +108,15 @@ 
 	 */
 	protected function isCodeBroken($httpCode) {
 		// Null represents no request attempted
-		if($httpCode === null) return false;
+		if($httpCode === null) {
+			return false;
+		}
 
 		// do we have any whitelisted codes
 		$ignoreCodes = Config::inst()->get('CheckExternalLinks', 'IgnoreCodes');
-		if(is_array($ignoreCodes) && in_array($httpCode, $ignoreCodes)) return false;
+		if(is_array($ignoreCodes) && in_array($httpCode, $ignoreCodes)) {
+			return false;
+		}
 
 		// Check if code is outside valid range
 		return $httpCode < 200 || $httpCode > 302;
@@ -123,7 +134,9 @@ 
 
 		// Calculate pages to run
 		$pageTracks = $status->getIncompleteTracks();
-		if($limit) $pageTracks = $pageTracks->limit($limit);
+		if($limit) {
+			$pageTracks = $pageTracks->limit($limit);
+		}
 
 		// Check each page
 		foreach ($pageTracks as $pageTrack) {
@@ -135,7 +148,9 @@ 
 			$page = $pageTrack->Page();
 			$this->log("Checking {$page->Title}");
 			$htmlValue = Injector::inst()->create('HTMLValue', $page->Content);
-			if (!$htmlValue->isValid()) continue;
+			if (!$htmlValue->isValid()) {
+				continue;
+			}
 
 			// Check each link
 			$links = $htmlValue->getElementsByTagName('a');

code/tasks/CurlLinkChecker.php

Spacing +2 added lines, -2 removed lines

@@ -26,12 +26,12 @@
 	 */
 	public function checkLink($href) {
 		// Skip non-external links
-		if(!preg_match('/^https?[^:]*:\/\//', $href)) return null;
+		if (!preg_match('/^https?[^:]*:\/\//', $href)) return null;
 
 		// Check if we have a cached result
 		$cacheKey = md5($href);
 		$result = $this->getCache()->load($cacheKey);
-		if($result !== false) return $result;
+		if ($result !== false) return $result;
 
 		// No cached result so just request
 		$handle = curl_init($href);

Braces +6 added lines, -2 removed lines

@@ -26,12 +26,16 @@
 	 */
 	public function checkLink($href) {
 		// Skip non-external links
-		if(!preg_match('/^https?[^:]*:\/\//', $href)) return null;
+		if(!preg_match('/^https?[^:]*:\/\//', $href)) {
+			return null;
+		}
 
 		// Check if we have a cached result
 		$cacheKey = md5($href);
 		$result = $this->getCache()->load($cacheKey);
-		if($result !== false) return $result;
+		if($result !== false) {
+			return $result;
+		}
 
 		// No cached result so just request
 		$handle = curl_init($href);