silverstripe / deploynaut

code/backends/DeploymentStrategy.php

Doc Comments +2 added lines

@@ -75,6 +75,7 @@ 
 	}
 
 	/**
+	 * @param string $code
 	 */
 	public function setActionCode($code) {
 		$this->actionCode = $code;
@@ -89,6 +90,7 @@ 
 
 	/**
 	 * @param int
+	 * @param string $seconds
 	 */
 	public function setEstimatedTime($seconds) {
 		$this->estimatedTime = $seconds;

code/control/DNRoot.php

Braces +9 added lines, -3 removed lines

@@ -936,7 +936,9 @@ 
 		}
 
 		$fields = $backend->getCreateEnvironmentFields($project);
-		if(!$fields) return null;
+		if(!$fields) {
+			return null;
+		}
 
 		if(!$project->canCreateEnvironments()) {
 			return new SS_HTTPResponse('Not allowed to create environments for this project', 401);
@@ -2366,8 +2368,12 @@ 
 	 * @return bool
 	 */
 	public function canCreateProjects($member = null) {
-		if(!$member) $member = Member::currentUser();
-		if(!$member) return false;
+		if(!$member) {
+			$member = Member::currentUser();
+		}
+		if(!$member) {
+			return false;
+		}
 
 		return singleton('DNProject')->canCreate($member);
 	}

Doc Comments +1 added lines, -1 removed lines

@@ -961,7 +961,7 @@
 	 * @param array $data
 	 * @param Form $form
 	 *
-	 * @return bool|HTMLText|SS_HTTPResponse
+	 * @return SS_HTTPResponse|null
 	 */
 	public function doCreateEnvironment($data, Form $form) {
 		$this->setCurrentActionType(self::ACTION_ENVIRONMENTS);

code/control/Dispatcher.php

Braces +12 added lines, -4 removed lines

@@ -36,13 +36,17 @@ 
 	}
 
 	protected function getSecurityToken($name = null) {
-		if(is_null($name)) $name = sprintf('%sSecurityID', get_class($this));
+		if(is_null($name)) {
+			$name = sprintf('%sSecurityID', get_class($this));
+		}
 		return new \SecurityToken($name);
 	}
 
 	protected function checkSecurityToken($name = null) {
 		$postVar = is_null($name) ? 'SecurityID' : $name;
-		if(is_null($name)) $name = sprintf('%sSecurityID', get_class($this));
+		if(is_null($name)) {
+			$name = sprintf('%sSecurityID', get_class($this));
+		}
 		$securityToken = $this->getSecurityToken($name);
 
 		// By default the security token is always represented by a "SecurityID" post var,
@@ -132,7 +136,9 @@ 
 	 */
 	protected function trimWhitespace($val) {
 		if(is_array($val)) {
-			foreach($val as $k => $v) $val[$k] = $this->trimWhitespace($v);
+			foreach($val as $k => $v) {
+				$val[$k] = $this->trimWhitespace($v);
+			}
 			return $val;
 		} else {
 			return trim($val);
@@ -147,7 +153,9 @@ 
 	 */
 	protected function stripNonPrintables($val) {
 		if(is_array($val)) {
-			foreach($val as $k => $v) $val[$k] = $this->stripNonPrintables($v);
+			foreach($val as $k => $v) {
+				$val[$k] = $this->stripNonPrintables($v);
+			}
 			return $val;
 		} else {
 			return preg_replace('/[[:cntrl:]]/', '', $val);

Doc Comments +2 added lines, -2 removed lines

@@ -23,7 +23,7 @@ 
 	 * Usage: $getReactComponent(YourComponent);
 	 *
 	 * @param string $name Used to name the DOM elements and obtain the initial model.
-	 * @return string A snippet good for adding to a SS template.
+	 * @return HTMLText A snippet good for adding to a SS template.
 	 */
 	public function getReactComponent($name) {
 		$model = $this->getModel($name);
@@ -120,7 +120,7 @@ 
 	/**
 	 * Decode the data submitted by the form.jsx control.
 	 *
-	 * @return array
+	 * @return string
 	 */
 	protected function getFormData() {
 		return $this->stripNonPrintables(json_decode($this->request->postVar('Details'), true));

code/model/DNEnvironment.php

Braces +36 added lines, -12 removed lines

@@ -386,9 +386,13 @@ 
 		// Must be logged in to check permissions
 
 		if ($this->Usage==='Production' || $this->Usage==='Unspecified') {
-			if ($this->Project()->allowed(DNRoot::ALLOW_PROD_DEPLOYMENT, $member)) return true;
+			if ($this->Project()->allowed(DNRoot::ALLOW_PROD_DEPLOYMENT, $member)) {
+				return true;
+			}
 		} else {
-			if ($this->Project()->allowed(DNRoot::ALLOW_NON_PROD_DEPLOYMENT, $member)) return true;
+			if ($this->Project()->allowed(DNRoot::ALLOW_NON_PROD_DEPLOYMENT, $member)) {
+				return true;
+			}
 		}
 
 		return $this->Deployers()->byID($member->ID)
@@ -412,9 +416,13 @@ 
 		// Must be logged in to check permissions
 
 		if ($this->Usage==='Production' || $this->Usage==='Unspecified') {
-			if ($this->Project()->allowed(DNRoot::ALLOW_PROD_SNAPSHOT, $member)) return true;
+			if ($this->Project()->allowed(DNRoot::ALLOW_PROD_SNAPSHOT, $member)) {
+				return true;
+			}
 		} else {
-			if ($this->Project()->allowed(DNRoot::ALLOW_NON_PROD_SNAPSHOT, $member)) return true;
+			if ($this->Project()->allowed(DNRoot::ALLOW_NON_PROD_SNAPSHOT, $member)) {
+				return true;
+			}
 		}
 
 		return $this->CanRestoreMembers()->byID($member->ID)
@@ -443,9 +451,13 @@ 
 		}
 
 		if ($this->Usage==='Production' || $this->Usage==='Unspecified') {
-			if ($this->Project()->allowed(DNRoot::ALLOW_PROD_SNAPSHOT, $member)) return true;
+			if ($this->Project()->allowed(DNRoot::ALLOW_PROD_SNAPSHOT, $member)) {
+				return true;
+			}
 		} else {
-			if ($this->Project()->allowed(DNRoot::ALLOW_NON_PROD_SNAPSHOT, $member)) return true;
+			if ($this->Project()->allowed(DNRoot::ALLOW_NON_PROD_SNAPSHOT, $member)) {
+				return true;
+			}
 		}
 
 		return $this->CanBackupMembers()->byID($member->ID)
@@ -478,9 +490,13 @@ 
 		// Must be logged in to check permissions
 
 		if ($this->Usage==='Production' || $this->Usage==='Unspecified') {
-			if ($this->Project()->allowed(DNRoot::ALLOW_PROD_SNAPSHOT, $member)) return true;
+			if ($this->Project()->allowed(DNRoot::ALLOW_PROD_SNAPSHOT, $member)) {
+				return true;
+			}
 		} else {
-			if ($this->Project()->allowed(DNRoot::ALLOW_NON_PROD_SNAPSHOT, $member)) return true;
+			if ($this->Project()->allowed(DNRoot::ALLOW_NON_PROD_SNAPSHOT, $member)) {
+				return true;
+			}
 		}
 
 		return $this->ArchiveUploaders()->byID($member->ID)
@@ -504,9 +520,13 @@ 
 		// Must be logged in to check permissions
 
 		if ($this->Usage==='Production' || $this->Usage==='Unspecified') {
-			if ($this->Project()->allowed(DNRoot::ALLOW_PROD_SNAPSHOT, $member)) return true;
+			if ($this->Project()->allowed(DNRoot::ALLOW_PROD_SNAPSHOT, $member)) {
+				return true;
+			}
 		} else {
-			if ($this->Project()->allowed(DNRoot::ALLOW_NON_PROD_SNAPSHOT, $member)) return true;
+			if ($this->Project()->allowed(DNRoot::ALLOW_NON_PROD_SNAPSHOT, $member)) {
+				return true;
+			}
 		}
 
 		return $this->ArchiveDownloaders()->byID($member->ID)
@@ -573,9 +593,13 @@ 
 		// Must be logged in to check permissions
 
 		if ($this->Usage==='Production' || $this->Usage==='Unspecified') {
-			if ($this->Project()->allowed(DNRoot::ALLOW_PROD_SNAPSHOT, $member)) return true;
+			if ($this->Project()->allowed(DNRoot::ALLOW_PROD_SNAPSHOT, $member)) {
+				return true;
+			}
 		} else {
-			if ($this->Project()->allowed(DNRoot::ALLOW_NON_PROD_SNAPSHOT, $member)) return true;
+			if ($this->Project()->allowed(DNRoot::ALLOW_NON_PROD_SNAPSHOT, $member)) {
+				return true;
+			}
 		}
 
 		return $this->ArchiveDeleters()->byID($member->ID)

code/model/DNProject.php

Braces +15 added lines, -5 removed lines

@@ -929,7 +929,9 @@ 
 	 * @return SS_List
 	 */
 	public function whoIsAllowedAny($codes) {
-		if(!is_array($codes)) $codes = array($codes);
+		if(!is_array($codes)) {
+			$codes = array($codes);
+		}
 
 		$SQLa_codes = Convert::raw2sql($codes);
 		$SQL_codes = join("','", $SQLa_codes);
@@ -991,7 +993,9 @@ 
 			$member = Member::currentUser();
 		}
 
-		if(Permission::checkMember($member, 'ADMIN')) return true;
+		if(Permission::checkMember($member, 'ADMIN')) {
+			return true;
+		}
 
 		$hits = $this->whoIsAllowedAny($codes)->filter('Member.ID', $member->ID)->count();
 		return ($hits>0 ? true : false);
@@ -1018,7 +1022,9 @@ 
 			});
 
 			// If anything returns false then we're not ready.
-			if($isDone) return min($isDone);
+			if($isDone) {
+				return min($isDone);
+			}
 		}
 
 		return true;
@@ -1099,8 +1105,12 @@ 
 	 * @return bool
 	 */
 	public function canCreate($member = null) {
-		if(!$member) $member = Member::currentUser();
-		if(!$member) return false;
+		if(!$member) {
+			$member = Member::currentUser();
+		}
+		if(!$member) {
+			return false;
+		}
 
 		if(Permission::checkMember($member, 'ADMIN')) {
 			return true;

code/model/jobs/DNDeployment.php

Braces +9 added lines, -3 removed lines

@@ -201,12 +201,16 @@ 
 	 */
 	public function getFullDeployMessages() {
 		$strategy = $this->getDeploymentStrategy();
-		if ($strategy->getActionCode()!=='full') return null;
+		if ($strategy->getActionCode()!=='full') {
+			return null;
+		}
 
 		$changes = $strategy->getChangesModificationNeeded();
 		$messages = [];
 		foreach ($changes as $change => $details) {
-			if ($change==='Code version') continue;
+			if ($change==='Code version') {
+				continue;
+			}
 
 			$messages[] = [
 				'Flag' => sprintf(
@@ -260,7 +264,9 @@ 
 		$list = new ArrayList();
 		$strategy = $this->getDeploymentStrategy();
 		foreach($strategy->getChanges() as $name => $change) {
-			if(empty($change['to'])) continue;
+			if(empty($change['to'])) {
+				continue;
+			}
 
 			$list->push(new ArrayData([
 				'Name' => $name,

code/backends/DeploymentBackend.php

Doc Comments +5 added lines

@@ -10,6 +10,7 @@ 
 	 * @param DeploynautLogFile $log
 	 * @param DNProject $project
 	 * @param type $leaveMaintenancePage
+	 * @return void
 	 */
 	public function deploy(DNEnvironment $environment, $sha, DeploynautLogFile $log, DNProject $project, $leaveMaintenancePage = false);
 
@@ -19,6 +20,7 @@ 
 	 *
 	 * @param DNDataTransfer $dataTransfer
 	 * @param DeploynautLogFile $log
+	 * @return void
 	 */
 	public function dataTransfer(DNDataTransfer $dataTransfer, DeploynautLogFile $log);
 
@@ -28,6 +30,7 @@ 
 	 * @param DNEnvironment $environment
 	 * @param DeploynautLogFile $log
 	 * @param DNProject $project
+	 * @return void
 	 */
 	public function enableMaintenance(DNEnvironment $environment, DeploynautLogFile $log, DNProject $project);
 
@@ -37,6 +40,7 @@ 
 	 * @param DNEnvironment $environment
 	 * @param DeploynautLogFile $log
 	 * @param DNProject $project
+	 * @return void
 	 */
 	public function disableMaintenance(DNEnvironment $environment, DeploynautLogFile $log, DNProject $project);
 
@@ -46,6 +50,7 @@ 
 	 * @param DNEnvironment $environment
 	 * @param DeploynautLogFile $log
 	 * @param DNProject $project
+	 * @return void
 	 */
 	public function ping(DNEnvironment $environment, DeploynautLogFile $log, DNProject $project);
 

code/backends/PackageCache.php

Doc Comments +1 added lines

@@ -13,6 +13,7 @@
 	 * @param string $sha The SHA of the commit to be deployed
 	 * @param string $repositoryDir The directory where the repository resides
 	 * @param DeploynautLogFile $log The log to write status output to, including package-generation commands
+	 * @return string
 	 */
 	public function getPackageFilename(
 		PackageGenerator $generator,

code/model/PipelineData.php

Doc Comments +1 added lines

@@ -13,6 +13,7 @@
 	 * Log message
 	 *
 	 * @param string $message The message to log
+	 * @return void
 	 */
 	public function log($message);
 }