silverstripe / deploynaut

code/backends/CapistranoDeploymentBackend.php

Spacing +15 added lines, -15 removed lines

@@ -72,7 +72,7 @@ 
 
 			try {
 				$args['build_filename'] = $this->packageGenerator->getPackageFilename($project->Name, $sha, $repository, $log);
-			} catch (Exception $e) {
+			} catch(Exception $e) {
 				$log->write($e->getMessage());
 				throw $e;
 			}
@@ -176,7 +176,7 @@ 
 		} else {
 			$environment = $dataTransfer->Environment();
 			$project = $environment->Project();
-			$workingDir = TEMP_FOLDER . DIRECTORY_SEPARATOR . 'deploynaut-transfer-' . $dataTransfer->ID;
+			$workingDir = TEMP_FOLDER.DIRECTORY_SEPARATOR.'deploynaut-transfer-'.$dataTransfer->ID;
 			$archive = $dataTransfer->DataArchive();
 
 			// extract the sspak contents, we'll need these so capistrano can restore that content
@@ -222,7 +222,7 @@ 
 		if(!$args) {
 			$args = array();
 		}
-		$args['history_path'] = realpath(DEPLOYNAUT_LOG_PATH . '/');
+		$args['history_path'] = realpath(DEPLOYNAUT_LOG_PATH.'/');
 		$args['environment_id'] = $environment->ID;
 
 		// Inject env string directly into the command.
@@ -237,7 +237,7 @@ 
 
 		$data = DNData::inst();
 		// Generate a capfile from a template
-		$capTemplate = file_get_contents(BASE_PATH . '/deploynaut/Capfile.template');
+		$capTemplate = file_get_contents(BASE_PATH.'/deploynaut/Capfile.template');
 		$cap = str_replace(
 			array('<config root>', '<ssh key>', '<base path>'),
 			array($data->getEnvironmentDir(), DEPLOYNAUT_SSH_KEY, BASE_PATH),
@@ -247,13 +247,13 @@ 
 		if(defined('DEPLOYNAUT_CAPFILE')) {
 			$capFile = DEPLOYNAUT_CAPFILE;
 		} else {
-			$capFile = ASSETS_PATH . '/Capfile';
+			$capFile = ASSETS_PATH.'/Capfile';
 		}
 		file_put_contents($capFile, $cap);
 
-		$command = "{$envString}cap -f " . escapeshellarg($capFile) . " -vv $name $action ROLES=$roles";
+		$command = "{$envString}cap -f ".escapeshellarg($capFile)." -vv $name $action ROLES=$roles";
 		foreach($args as $argName => $argVal) {
-			$command .= ' -s ' . escapeshellarg($argName) . '=' . escapeshellarg($argVal);
+			$command .= ' -s '.escapeshellarg($argName).'='.escapeshellarg($argVal);
 		}
 
 		$log->write(sprintf('Running command: %s', $command));
@@ -287,7 +287,7 @@ 
 		$filepathBase = $dataArchive->generateFilepath($dataTransfer);
 		mkdir($filepathBase, 0700, true);
 
-		$databasePath = $filepathBase . DIRECTORY_SEPARATOR . 'database.sql';
+		$databasePath = $filepathBase.DIRECTORY_SEPARATOR.'database.sql';
 
 		// Backup database
 		if(in_array($dataTransfer->Mode, array('all', 'db'))) {
@@ -325,7 +325,7 @@ 
 		$log->write('Creating sspak...');
 
 		$sspakFilename = sprintf('%s.sspak', $dataArchive->generateFilename($dataTransfer));
-		$sspakFilepath = $filepathBase . DIRECTORY_SEPARATOR . $sspakFilename;
+		$sspakFilepath = $filepathBase.DIRECTORY_SEPARATOR.$sspakFilename;
 
 		try {
 			$dataArchive->attachFile($sspakFilepath, $dataTransfer);
@@ -392,7 +392,7 @@ 
 		// Restore database into target environment
 		if(in_array($dataTransfer->Mode, array('all', 'db'))) {
 			$log->write(sprintf('Restore of database to "%s" started', $name));
-			$args = array('data_path' => $workingDir . DIRECTORY_SEPARATOR . 'database.sql');
+			$args = array('data_path' => $workingDir.DIRECTORY_SEPARATOR.'database.sql');
 			$command = $this->getCommand('data:pushdb', 'db', $environment, $args, $log);
 			$command->run(function($type, $buffer) use($log) {
 				$log->write($buffer);
@@ -409,7 +409,7 @@ 
 		// Restore assets into target environment
 		if(in_array($dataTransfer->Mode, array('all', 'assets'))) {
 			$log->write(sprintf('Restore of assets to "%s" started', $name));
-			$args = array('data_path' => $workingDir . DIRECTORY_SEPARATOR . 'assets');
+			$args = array('data_path' => $workingDir.DIRECTORY_SEPARATOR.'assets');
 			$command = $this->getCommand('data:pushassets', 'web', $environment, $args, $log);
 			$command->run(function($type, $buffer) use($log) {
 				$log->write($buffer);
@@ -490,17 +490,17 @@ 
 			}
 
 			// Produce an informational ticker roughly every $tick
-			if (time() > $infoTick) {
+			if(time() > $infoTick) {
 				$message = [];
 
 				// Collect status information from different sources.
-				if ($status) {
+				if($status) {
 					$message[] = sprintf('HTTP status code is %s', $status);
 				}
-				if (!$response) {
+				if(!$response) {
 					$message[] = 'response is empty';
 				}
-				if ($error = curl_error($ch)) {
+				if($error = curl_error($ch)) {
 					$message[] = sprintf('request error: %s', $error);
 				}
 

Doc Comments +1 added lines, -1 removed lines

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

code/backends/SimplePackageGenerator.php

Spacing +4 added lines, -4 removed lines

@@ -30,7 +30,7 @@ 
 	 * Generate the package
 	 */
 	public function generatePackage($sha, $baseDir, $outputFilename, DeploynautLogFile $log) {
-		$tempPath = TEMP_FOLDER . "/" . str_replace(".tar.gz", "", basename($outputFilename));
+		$tempPath = TEMP_FOLDER."/".str_replace(".tar.gz", "", basename($outputFilename));
 		if(!file_exists($tempPath)) {
 			mkdir($tempPath);
 		}
@@ -42,17 +42,17 @@ 
 		// Execute these in sequence until there's a failure
 		$processes = array(
 			// Export the relevant SHA into a temp folder
-			new AbortableProcess("git archive $sha | tar -x -C " . $escapedTempPath, $baseDir),
+			new AbortableProcess("git archive $sha | tar -x -C ".$escapedTempPath, $baseDir),
 			// Run build script
 			new AbortableProcess($this->buildScript, $tempPath, null, null, 3600),
 			// Compress the result
-			new AbortableProcess("tar -czf " . $escapedOutputFile . " " . $escapedTempDir, dirname($tempPath)),
+			new AbortableProcess("tar -czf ".$escapedOutputFile." ".$escapedTempDir, dirname($tempPath)),
 		);
 
 		// Call at the end, regardless of success or failure
 		$cleanup = array(
 			// Delete the temporary staging folder
-			new AbortableProcess("rm -rf " . $escapedTempPath),
+			new AbortableProcess("rm -rf ".$escapedTempPath),
 		);
 
 		try {

code/control/DeployPlanDispatcher.php

Doc Comments +3 added lines, -3 removed lines

@@ -132,7 +132,7 @@ 
 	}
 
 	/**
-	 * @param $project
+	 * @param DNProject $project
 	 *
 	 * @return array
 	 */
@@ -148,7 +148,7 @@ 
 	}
 
 	/**
-	 * @param $project
+	 * @param DNProject $project
 	 *
 	 * @return array
 	 */
@@ -164,7 +164,7 @@ 
 	}
 
 	/**
-	 * @param $project
+	 * @param DNProject $project
 	 *
 	 * @return array
 	 */

Spacing +2 added lines, -2 removed lines

@@ -168,9 +168,9 @@
 		$fetch->write();
 		$fetch->start();
 
-		$location = Director::absoluteBaseURL() . $this->Link() . '/gitupdate/' . $fetch->ID;
+		$location = Director::absoluteBaseURL().$this->Link().'/gitupdate/'.$fetch->ID;
 		$output = array(
-			'message' => 'Fetch queued as job ' . $fetch->ResqueToken,
+			'message' => 'Fetch queued as job '.$fetch->ResqueToken,
 			'href' => $location,
 		);
 

code/AbortableProcess.php

Spacing +1 added lines, -1 removed lines

@@ -20,7 +20,7 @@
 			sleep(1);
 		}
 
-		if ($this->hasBeenSignaled()) {
+		if($this->hasBeenSignaled()) {
 			throw new RuntimeException(sprintf('The process has been signaled with signal "%s".', $this->getTermSignal));
 		}
 

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;