silverstripe / deploynaut

code/backends/CapistranoDeploymentBackend.php

Doc Comments +1 added lines, -1 removed lines

@@ -124,7 +124,7 @@
 	}
 
 	/**
-	 * @return array
+	 * @return PredeployBackupOption[]
 	 */
 	public function getDeployOptions() {
 		return [

code/control/DNRoot.php

Spacing +26 added lines, -26 removed lines

@@ -174,8 +174,8 @@ 
 		Requirements::javascript('deploynaut/javascript/material.js');
 
 		// Load the buildable dependencies only if not loaded centrally.
-		if (!is_dir(BASE_PATH . DIRECTORY_SEPARATOR . 'static')) {
-			if (\Director::isDev()) {
+		if(!is_dir(BASE_PATH.DIRECTORY_SEPARATOR.'static')) {
+			if(\Director::isDev()) {
 				\Requirements::javascript('deploynaut/static/bundle-debug.js');
 			} else {
 				\Requirements::javascript('deploynaut/static/bundle.js');
@@ -238,7 +238,7 @@ 
 		}
 
 		// Block framework jquery
-		Requirements::block(FRAMEWORK_DIR . '/thirdparty/jquery/jquery.js');
+		Requirements::block(FRAMEWORK_DIR.'/thirdparty/jquery/jquery.js');
 
 		self::include_requirements();
 	}
@@ -257,7 +257,7 @@ 
 	 * @return \SS_HTTPResponse
 	 */
 	public function index(SS_HTTPRequest $request) {
-		return $this->redirect($this->Link() . 'projects/');
+		return $this->redirect($this->Link().'projects/');
 	}
 
 	/**
@@ -417,7 +417,7 @@ 
 		$form->disableSecurityToken();
 		$form->addExtraClass('fields-wide');
 		// Tweak the action so it plays well with our fake URL structure.
-		$form->setFormAction($project->Link() . '/UploadSnapshotForm');
+		$form->setFormAction($project->Link().'/UploadSnapshotForm');
 
 		return $form;
 	}
@@ -467,7 +467,7 @@ 
 		$dataArchive->DataTransfers()->add($dataTransfer);
 		$form->saveInto($dataArchive);
 		$dataArchive->write();
-		$workingDir = TEMP_FOLDER . DIRECTORY_SEPARATOR . 'deploynaut-transfer-' . $dataTransfer->ID;
+		$workingDir = TEMP_FOLDER.DIRECTORY_SEPARATOR.'deploynaut-transfer-'.$dataTransfer->ID;
 
 		$cleanupFn = function() use($workingDir, $dataTransfer, $dataArchive) {
 			$process = new AbortableProcess(sprintf('rm -rf %s', escapeshellarg($workingDir)));
@@ -569,7 +569,7 @@ 
 		$form->disableSecurityToken();
 		$form->addExtraClass('fields-wide');
 		// Tweak the action so it plays well with our fake URL structure.
-		$form->setFormAction($project->Link() . '/PostSnapshotForm');
+		$form->setFormAction($project->Link().'/PostSnapshotForm');
 
 		return $form;
 	}
@@ -708,7 +708,7 @@ 
 		$branchName = $request->getVar('name');
 		$branch = $project->DNBranchList()->byName($branchName);
 		if(!$branch) {
-			return new SS_HTTPResponse("Branch '" . Convert::raw2xml($branchName) . "' not found.", 404);
+			return new SS_HTTPResponse("Branch '".Convert::raw2xml($branchName)."' not found.", 404);
 		}
 
 		return $this->render(array(
@@ -844,7 +844,7 @@ 
 		);
 
 		// Tweak the action so it plays well with our fake URL structure.
-		$form->setFormAction($project->Link() . '/CreateEnvironmentForm');
+		$form->setFormAction($project->Link().'/CreateEnvironmentForm');
 
 		return $form;
 	}
@@ -877,7 +877,7 @@ 
 		$job->write();
 		$job->start();
 
-		return $this->redirect($project->Link('createenv') . '/' . $job->ID);
+		return $this->redirect($project->Link('createenv').'/'.$job->ID);
 	}
 
 	/**
@@ -938,7 +938,7 @@ 
 	 */
 	public function getPlatformSpecificStrings() {
 		$strings = $this->config()->platform_specific_strings;
-		if ($strings) {
+		if($strings) {
 			return new ArrayList($strings);
 		}
 	}
@@ -1003,7 +1003,7 @@ 
 
 				$isCurrentEnvironment = false;
 				if($project && $currentEnvironment) {
-					$isCurrentEnvironment = (bool) $project->DNEnvironmentList()->find('ID', $currentEnvironment->ID);
+					$isCurrentEnvironment = (bool)$project->DNEnvironmentList()->find('ID', $currentEnvironment->ID);
 				}
 
 				$navigation->push(array(
@@ -1073,7 +1073,7 @@ 
 			return $body;
 		}
 
-		$form->setFormAction($this->getRequest()->getURL() . '/DeployForm');
+		$form->setFormAction($this->getRequest()->getURL().'/DeployForm');
 		return $form;
 	}
 
@@ -1097,7 +1097,7 @@ 
 		}
 
 		$options = [];
-		foreach ($env->Backend()->getDeployOptions() as $option) {
+		foreach($env->Backend()->getDeployOptions() as $option) {
 			$options[] = [
 				'name' => $option->getName(),
 				'title' => $option->getTitle(),
@@ -1230,7 +1230,7 @@ 
 	}
 
 	protected function applyRedeploy(SS_HTTPRequest $request, &$data) {
-		if (!$request->getVar('redeploy')) return;
+		if(!$request->getVar('redeploy')) return;
 
 		$project = $this->getCurrentProject();
 		if(!$project) {
@@ -1244,12 +1244,12 @@ 
 		}
 
 		$current = $env->CurrentBuild();
-		if ($current && $current->exists()) {
+		if($current && $current->exists()) {
 			$data['preselect_tab'] = 3;
 			$data['preselect_sha'] = $current->SHA;
 		} else {
 			$master = $project->DNBranchList()->byName('master');
-			if ($master) {
+			if($master) {
 				$data['preselect_tab'] = 1;
 				$data['preselect_sha'] = $master->SHA();
 			}
@@ -1380,7 +1380,7 @@ 
 		$deployment->getMachine()->apply(DNDeployment::TR_QUEUE);
 
 		return json_encode(array(
-			'url' => Director::absoluteBaseURL() . $deployment->Link()
+			'url' => Director::absoluteBaseURL().$deployment->Link()
 		), JSON_PRETTY_PRINT);
 	}
 
@@ -1484,7 +1484,7 @@ 
 			throw new LogicException("Project in URL doesn't match this deploy");
 		}
 
-		if (!in_array($deployment->Status, ['Queued', 'Deploying', 'Aborting'])) {
+		if(!in_array($deployment->Status, ['Queued', 'Deploying', 'Aborting'])) {
 			throw new LogicException(sprintf("Cannot abort from %s state.", $deployment->Status));
 		}
 
@@ -1522,7 +1522,7 @@ 
 					->addExtraClass('btn')
 			)
 		);
-		$form->setFormAction($this->getRequest()->getURL() . '/DataTransferForm');
+		$form->setFormAction($this->getRequest()->getURL().'/DataTransferForm');
 
 		return $form;
 	}
@@ -1724,7 +1724,7 @@ 
 					->addExtraClass('btn')
 			)
 		);
-		$form->setFormAction($project->Link() . '/DataTransferRestoreForm');
+		$form->setFormAction($project->Link().'/DataTransferRestoreForm');
 
 		return $form;
 	}
@@ -1822,7 +1822,7 @@ 
 					->addExtraClass('btn')
 			)
 		);
-		$form->setFormAction($project->Link() . '/DeleteForm');
+		$form->setFormAction($project->Link().'/DeleteForm');
 
 		return $form;
 	}
@@ -1928,7 +1928,7 @@ 
 					->addExtraClass('btn')
 			)
 		);
-		$form->setFormAction($this->getCurrentProject()->Link() . '/MoveForm');
+		$form->setFormAction($this->getCurrentProject()->Link().'/MoveForm');
 
 		return $form;
 	}
@@ -2220,7 +2220,7 @@ 
 	 */
 	protected function project404Response() {
 		return new SS_HTTPResponse(
-			"Project '" . Convert::raw2xml($this->getRequest()->param('Project')) . "' not found.",
+			"Project '".Convert::raw2xml($this->getRequest()->param('Project'))."' not found.",
 			404
 		);
 	}
@@ -2230,7 +2230,7 @@ 
 	 */
 	protected function environment404Response() {
 		$envName = Convert::raw2xml($this->getRequest()->param('Environment'));
-		return new SS_HTTPResponse("Environment '" . $envName . "' not found.", 404);
+		return new SS_HTTPResponse("Environment '".$envName."' not found.", 404);
 	}
 
 	/**
@@ -2297,7 +2297,7 @@ 
 	public function AmbientMenu() {
 		$list = new ArrayList();
 
-		if (Member::currentUserID()) {
+		if(Member::currentUserID()) {
 			$list->push(new ArrayData(array(
 				'Classes' => 'logout',
 				'FaIcon' => 'sign-out',

code/model/jobs/DNDataTransfer.php

Spacing +7 added lines, -7 removed lines

@@ -112,7 +112,7 @@ 
 	}
 
 	public function getTitle() {
-		return $this->dbObject('Created')->Nice() . " (Status: {$this->Status})";
+		return $this->dbObject('Created')->Nice()." (Status: {$this->Status})";
 	}
 
 	public function Link() {
@@ -233,14 +233,14 @@ 
 		$envName = $this->Environment()->getFullName();
 		if($this->Direction == 'get') {
 			if($this->Origin == 'ManualUpload') {
-				$description = 'Manual upload of ' . $this->getModeNice() . ' to ' . $envName;
+				$description = 'Manual upload of '.$this->getModeNice().' to '.$envName;
 			} elseif($this->IsBackupDataTransfer()) {
-				$description = 'Automated backup of ' . $this->getModeNice() . ' from ' . $envName;
+				$description = 'Automated backup of '.$this->getModeNice().' from '.$envName;
 			} else {
-				$description = 'Backup of ' . $this->getModeNice() . ' to ' . $envName;
+				$description = 'Backup of '.$this->getModeNice().' to '.$envName;
 			}
 		} else {
-			$description = 'Restore ' . $this->getModeNice() . ' to ' . $envName;
+			$description = 'Restore '.$this->getModeNice().' to '.$envName;
 		}
 
 		return $description;
@@ -263,7 +263,7 @@ 
 			'SELECT COUNT("ID") FROM "DNDeployment" WHERE "BackupDataTransferID" = %d',
 			$this->ID
 		))->value();
-		if ($deploymentBackup) {
+		if($deploymentBackup) {
 			return true;
 		}
 
@@ -271,7 +271,7 @@ 
 			'SELECT COUNT("ID") FROM "DNDataTransfer" WHERE "BackupDataTransferID" = %d',
 			$this->ID
 		))->value();
-		if ($transferBackup) {
+		if($transferBackup) {
 			return true;
 		}
 

code/jobs/DeployJob.php

Doc Comments +3 added lines

@@ -139,6 +139,9 @@
 		$this->updateStatus(DNDeployment::TR_FAIL);
 	}
 
+	/**
+	 * @param DNDataTransfer|null $backupDataTransfer
+	 */
 	protected function performBackup($backupDataTransfer, DeploynautLogFile $log) {
 		if (!$backupDataTransfer) {
 			return false;

Spacing +11 added lines, -11 removed lines

@@ -17,9 +17,9 @@ 
 	 */
 	public function alarmHandler() {
 		$sigFile = $this->args['sigFile'];
-		if (file_exists($sigFile) && is_readable($sigFile) && is_writable($sigFile)) {
+		if(file_exists($sigFile) && is_readable($sigFile) && is_writable($sigFile)) {
 			$signal = (int)file_get_contents($sigFile);
-			if (is_int($signal) && in_array((int)$signal, [
+			if(is_int($signal) && in_array((int)$signal, [
 				// The following signals are trapped by both Resque and Rainforest.
 				SIGTERM,
 				SIGINT,
@@ -30,7 +30,7 @@ 
 				SIGCONT
 			])) {
 				echo sprintf(
-					'[-] Signal "%s" received, delivering to own process group, PID "%s".' . PHP_EOL,
+					'[-] Signal "%s" received, delivering to own process group, PID "%s".'.PHP_EOL,
 					$signal,
 					getmypid()
 				);
@@ -40,9 +40,9 @@ 
 
 				// Dispatch to own process group.
 				$pgid = posix_getpgid(getmypid());
-				if ($pgid<=0) {
+				if($pgid <= 0) {
 					echo sprintf(
-						'[-] Unable to send signal to invalid PGID "%s".' . PHP_EOL,
+						'[-] Unable to send signal to invalid PGID "%s".'.PHP_EOL,
 						$pgid
 					);
 				} else {
@@ -61,8 +61,8 @@ 
 		posix_setsid();
 
 		if(function_exists('pcntl_alarm') && function_exists('pcntl_signal')) {
-			if (!empty($this->args['sigFile'])) {
-				echo sprintf('[-] Signal file requested, polling "%s".' . PHP_EOL, $this->args['sigFile']);
+			if(!empty($this->args['sigFile'])) {
+				echo sprintf('[-] Signal file requested, polling "%s".'.PHP_EOL, $this->args['sigFile']);
 				declare(ticks = 1);
 				pcntl_signal(SIGALRM, [$this, 'alarmHandler']);
 				pcntl_alarm(1);
@@ -74,7 +74,7 @@ 
 	}
 
 	public function perform() {
-		echo "[-] DeployJob starting" . PHP_EOL;
+		echo "[-] DeployJob starting".PHP_EOL;
 		$log = new DeploynautLogFile($this->args['logfile']);
 
 		$deployment = DNDeployment::get()->byID($this->args['deploymentID']);
@@ -127,12 +127,12 @@ 
 			);
 		} catch(Exception $e) {
 			// DeploynautJob will automatically trigger onFailure.
-			echo "[-] DeployJob failed" . PHP_EOL;
+			echo "[-] DeployJob failed".PHP_EOL;
 			throw $e;
 		}
 
 		$this->updateStatus(DNDeployment::TR_COMPLETE);
-		echo "[-] DeployJob finished" . PHP_EOL;
+		echo "[-] DeployJob finished".PHP_EOL;
 	}
 
 	public function onFailure(Exception $exception) {
@@ -140,7 +140,7 @@ 
 	}
 
 	protected function performBackup($backupDataTransfer, DeploynautLogFile $log) {
-		if (!$backupDataTransfer) {
+		if(!$backupDataTransfer) {
 			return false;
 		}
 

code/jobs/DataTransferJob.php

Spacing +4 added lines, -4 removed lines

@@ -20,7 +20,7 @@ 
 	}
 
 	public function perform() {
-		echo "[-] DataTransferJob starting" . PHP_EOL;
+		echo "[-] DataTransferJob starting".PHP_EOL;
 		$log = new DeploynautLogFile($this->args['logfile']);
 		$dataTransfer = DNDataTransfer::get()->byID($this->args['dataTransferID']);
 		$environment = $dataTransfer->Environment();
@@ -64,16 +64,16 @@ 
 			$this->performBackup($backupDataTransfer, $log);
 			$environment->Backend()->dataTransfer($dataTransfer, $log);
 		} catch(Exception $e) {
-			echo "[-] DataTransferJob failed" . PHP_EOL;
+			echo "[-] DataTransferJob failed".PHP_EOL;
 			throw $e;
 		}
 
 		$this->updateStatus('Finished');
-		echo "[-] DataTransferJob finished" . PHP_EOL;
+		echo "[-] DataTransferJob finished".PHP_EOL;
 	}
 
 	protected function performBackup($backupDataTransfer, DeploynautLogFile $log) {
-		if (!$backupDataTransfer) {
+		if(!$backupDataTransfer) {
 			return false;
 		}
 

Doc Comments +3 added lines

@@ -139,6 +139,9 @@
 		$this->updateStatus(DNDeployment::TR_FAIL);
 	}
 
+	/**
+	 * @param DNDataTransfer|null $backupDataTransfer
+	 */
 	protected function performBackup($backupDataTransfer, DeploynautLogFile $log) {
 		if (!$backupDataTransfer) {
 			return false;