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;

Spacing +8 added lines, -8 removed lines

@@ -110,8 +110,8 @@ 
 		// Normalise "empty" values into dashes so comparisons are done properly.
 		// This means there is no diference between an empty string and a null
 		// but "0" is considered to be non-empty.
-		if(empty($from) && !strlen($from)) $from = '-';
-		if(empty($to) && !strlen($to)) $to = '-';
+		if (empty($from) && !strlen($from)) $from = '-';
+		if (empty($to) && !strlen($to)) $to = '-';
 
 		return $this->changes[$title] = array(
 			'from' => $from,
@@ -170,7 +170,7 @@ 
 	 */
 	public function getChange($key) {
 		$changes = $this->getChanges();
-		if(array_key_exists($key, $changes)) {
+		if (array_key_exists($key, $changes)) {
 			return new ArrayData($changes[$key]);
 		}
 		return null;
@@ -189,7 +189,7 @@ 
 	 * @return string|null
 	 */
 	public function getOption($option) {
-		if(!empty($this->options[$option])) {
+		if (!empty($this->options[$option])) {
 			return $this->options[$option];
 		}
 	}
@@ -230,7 +230,7 @@ 
 			DeploymentStrategy::WARNING_CODE => 1,
 			DeploymentStrategy::ERROR_CODE => 2
 		];
-		if($map[$current] < $map[$code]) {
+		if ($map[$current] < $map[$code]) {
 			$this->setValidationCode($code);
 		}
 	}
@@ -259,7 +259,7 @@ 
 		);
 
 		$output = array();
-		foreach($fields as $field) {
+		foreach ($fields as $field) {
 			$output[$field] = $this->$field;
 		}
 		return $output;
@@ -300,8 +300,8 @@ 
 			'messages'
 		);
 
-		foreach($fields as $field) {
-			if(!empty($data[$field])) {
+		foreach ($fields as $field) {
+			if (!empty($data[$field])) {
 				$this->$field = $data[$field];
 			}
 		}

code/control/DNRoot.php

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);

Spacing +29 added lines, -29 removed lines

@@ -177,7 +177,7 @@ 
 		Requirements::javascript('deploynaut/javascript/material.js');
 
 		// Load the buildable dependencies only if not loaded centrally.
-		if (!is_dir(BASE_PATH . DIRECTORY_SEPARATOR . 'static')) {
+		if (!is_dir(BASE_PATH.DIRECTORY_SEPARATOR.'static')) {
 			if (\Director::isDev()) {
 				\Requirements::javascript('deploynaut/static/bundle-debug.js');
 			} else {
@@ -220,7 +220,7 @@ 
 		}
 
 		// Block framework jquery
-		Requirements::block(FRAMEWORK_DIR . '/thirdparty/jquery/jquery.js');
+		Requirements::block(FRAMEWORK_DIR.'/thirdparty/jquery/jquery.js');
 
 		self::include_requirements();
 	}
@@ -239,7 +239,7 @@ 
 	 * @return \SS_HTTPResponse
 	 */
 	public function index(\SS_HTTPRequest $request) {
-		return $this->redirect($this->Link() . 'projects/');
+		return $this->redirect($this->Link().'projects/');
 	}
 
 	/**
@@ -367,7 +367,7 @@ 
 		// Framing an environment as a "group of people with download access"
 		// makes more sense to the user here, while still allowing us to enforce
 		// environment specific restrictions on downloading the file later on.
-		$envs = $project->DNEnvironmentList()->filterByCallback(function ($item) {
+		$envs = $project->DNEnvironmentList()->filterByCallback(function($item) {
 			return $item->canUploadArchive();
 		});
 		$envsMap = [];
@@ -399,7 +399,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;
 	}
@@ -420,7 +420,7 @@ 
 		}
 
 		$validEnvs = $project->DNEnvironmentList()
-			->filterByCallback(function ($item) {
+			->filterByCallback(function($item) {
 				return $item->canUploadArchive();
 			});
 
@@ -449,9 +449,9 @@ 
 		$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) {
+		$cleanupFn = function() use ($workingDir, $dataTransfer, $dataArchive) {
 			$process = new AbortableProcess(sprintf('rm -rf %s', escapeshellarg($workingDir)));
 			$process->setTimeout(120);
 			$process->run();
@@ -525,7 +525,7 @@ 
 		// Framing an environment as a "group of people with download access"
 		// makes more sense to the user here, while still allowing us to enforce
 		// environment specific restrictions on downloading the file later on.
-		$envs = $project->DNEnvironmentList()->filterByCallback(function ($item) {
+		$envs = $project->DNEnvironmentList()->filterByCallback(function($item) {
 			return $item->canUploadArchive();
 		});
 		$envsMap = [];
@@ -551,7 +551,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;
 	}
@@ -570,7 +570,7 @@ 
 			return $this->project404Response();
 		}
 
-		$validEnvs = $project->DNEnvironmentList()->filterByCallback(function ($item) {
+		$validEnvs = $project->DNEnvironmentList()->filterByCallback(function($item) {
 			return $item->canUploadArchive();
 		});
 
@@ -693,7 +693,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([
@@ -829,7 +829,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;
 	}
@@ -862,7 +862,7 @@ 
 		$job->write();
 		$job->start();
 
-		return $this->redirect($project->Link('createenv') . '/' . $job->ID);
+		return $this->redirect($project->Link('createenv').'/'.$job->ID);
 	}
 
 	/**
@@ -1039,7 +1039,7 @@ 
 			return $body;
 		}
 
-		$form->setFormAction($this->getRequest()->getURL() . '/DeployForm');
+		$form->setFormAction($this->getRequest()->getURL().'/DeployForm');
 		return $form;
 	}
 
@@ -1307,7 +1307,7 @@ 
 		$deployment->getMachine()->apply(DNDeployment::TR_QUEUE);
 
 		return json_encode([
-			'url' => Director::absoluteBaseURL() . $deployment->Link()
+			'url' => Director::absoluteBaseURL().$deployment->Link()
 		], JSON_PRETTY_PRINT);
 	}
 
@@ -1438,7 +1438,7 @@ 
 	 */
 	public function getDataTransferForm(\SS_HTTPRequest $request = null) {
 		// Performs canView permission check by limiting visible projects
-		$envs = $this->getCurrentProject()->DNEnvironmentList()->filterByCallback(function ($item) {
+		$envs = $this->getCurrentProject()->DNEnvironmentList()->filterByCallback(function($item) {
 			return $item->canBackup();
 		});
 
@@ -1448,7 +1448,7 @@ 
 
 		$items = [];
 		$disabledEnvironments = [];
-		foreach($envs as $env) {
+		foreach ($envs as $env) {
 			$items[$env->ID] = $env->Title;
 			if ($env->CurrentBuild() === false) {
 				$items[$env->ID] = sprintf("%s - requires initial deployment", $env->Title);
@@ -1489,7 +1489,7 @@ 
 			$fields,
 			FieldList::create($formAction)
 		);
-		$form->setFormAction($this->getRequest()->getURL() . '/DataTransferForm');
+		$form->setFormAction($this->getRequest()->getURL().'/DataTransferForm');
 
 		return $form;
 	}
@@ -1515,12 +1515,12 @@ 
 		// Validate direction.
 		if ($data['Direction'] == 'get') {
 			$validEnvs = $this->getCurrentProject()->DNEnvironmentList()
-				->filterByCallback(function ($item) {
+				->filterByCallback(function($item) {
 					return $item->canBackup();
 				});
 		} else if ($data['Direction'] == 'push') {
 			$validEnvs = $this->getCurrentProject()->DNEnvironmentList()
-				->filterByCallback(function ($item) {
+				->filterByCallback(function($item) {
 					return $item->canRestore();
 				});
 		} else {
@@ -1652,7 +1652,7 @@ 
 
 		// Performs canView permission check by limiting visible projects
 		$project = $this->getCurrentProject();
-		$envs = $project->DNEnvironmentList()->filterByCallback(function ($item) {
+		$envs = $project->DNEnvironmentList()->filterByCallback(function($item) {
 			return $item->canRestore();
 		});
 
@@ -1677,7 +1677,7 @@ 
 
 		$items = [];
 		$disabledEnvironments = [];
-		foreach($envs as $env) {
+		foreach ($envs as $env) {
 			$items[$env->ID] = $env->Title;
 			if ($env->CurrentBuild() === false) {
 				$items[$env->ID] = sprintf("%s - requires initial deployment", $env->Title);
@@ -1707,7 +1707,7 @@ 
 			),
 			FieldList::create($formAction)
 		);
-		$form->setFormAction($project->Link() . '/DataTransferRestoreForm');
+		$form->setFormAction($project->Link().'/DataTransferRestoreForm');
 
 		return $form;
 	}
@@ -1805,7 +1805,7 @@ 
 					->addExtraClass('btn')
 			)
 		);
-		$form->setFormAction($project->Link() . '/DeleteForm');
+		$form->setFormAction($project->Link().'/DeleteForm');
 
 		return $form;
 	}
@@ -1911,7 +1911,7 @@ 
 					->addExtraClass('btn')
 			)
 		);
-		$form->setFormAction($this->getCurrentProject()->Link() . '/MoveForm');
+		$form->setFormAction($this->getCurrentProject()->Link().'/MoveForm');
 
 		return $form;
 	}
@@ -2172,7 +2172,7 @@ 
 		$transfers = DNDataTransfer::get()
 			->filter('EnvironmentID', $environments)
 			->filterByCallback(
-				function ($record) {
+				function($record) {
 					return
 						$record->Environment()->canRestore() || // Ensure member can perform an action on the transfers env
 						$record->Environment()->canBackup() ||
@@ -2297,7 +2297,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
 		);
 	}
@@ -2307,7 +2307,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);
 	}
 
 	/**

code/jobs/PingJob.php

Spacing +1 added lines, -1 removed lines

@@ -31,7 +31,7 @@
 	 * Do the actual job by calling the appropiate backend
 	 */
 	public function perform() {
-		echo "[-] PingJob starting" . PHP_EOL;
+		echo "[-] PingJob starting".PHP_EOL;
 		$log = new DeploynautLogFile($this->args['logfile']);
 
 		$ping = DNPing::get()->byID($this->args['pingID']);

code/control/DeployDispatcher.php

Doc Comments +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
 	 *
 	 * @param \SS_HTTPRequest $request
 	 *
-	 * @return \HTMLText|\SS_HTTPResponse
+	 * @return SS_HTTPResponse|null
 	 */
 	public function index(\SS_HTTPRequest $request) {
 		return $this->redirect(\Controller::join_links($this->Link(), 'history'), 302);

code/control/GitDispatcher.php

Doc Comments +5 added lines, -5 removed lines

@@ -47,7 +47,7 @@ 
 	 *
 	 * @param \SS_HTTPRequest $request
 	 *
-	 * @return \HTMLText|\SS_HTTPResponse
+	 * @return SS_HTTPResponse|null
 	 */
 	public function index(\SS_HTTPRequest $request) {
 		return $this->redirect(\Controller::join_links($this->Link(), 'show'), 302);
@@ -72,7 +72,7 @@ 
 	/**
 	 * @param SS_HTTPRequest $request
 	 *
-	 * @return string
+	 * @return SS_HTTPResponse
 	 */
 	public function show(\SS_HTTPRequest $request) {
 
@@ -166,7 +166,7 @@ 
 	}
 
 	/**
-	 * @param $project
+	 * @param DNProject $project
 	 *
 	 * @return array
 	 */
@@ -182,7 +182,7 @@ 
 	}
 
 	/**
-	 * @param $project
+	 * @param DNProject $project
 	 *
 	 * @return array
 	 */
@@ -198,7 +198,7 @@ 
 	}
 
 	/**
-	 * @param $project
+	 * @param DNProject $project
 	 *
 	 * @return array
 	 */

Spacing +2 added lines, -2 removed lines

@@ -133,7 +133,7 @@ 
 	protected function getUpdateStatus($ID) {
 		$ping = DNGitFetch::get()->byID($ID);
 		if (!$ping) {
-			return $this->getAPIResponse(['message' => 'GIT update (' . $ID . ') not found'], 404);
+			return $this->getAPIResponse(['message' => 'GIT update ('.$ID.') not found'], 404);
 		}
 		$output = [
 			'id' => $ID,
@@ -154,7 +154,7 @@ 
 		$fetch->write();
 		$fetch->start();
 
-		$location = Director::absoluteBaseURL() . $this->Link() . '/update/' . $fetch->ID;
+		$location = Director::absoluteBaseURL().$this->Link().'/update/'.$fetch->ID;
 		$output = [
 			'message' => 'git fetch has been queued',
 			'id' => $fetch->ID,

_config.php

Spacing +1 added lines, -1 removed lines

@@ -10,7 +10,7 @@
 // This will ensure jobs can correctly clean themselves up on any type of failure
 Resque_Event::listen('onFailure', function(Exception $exception, Resque_job $job) {
 	$inst = $job->getInstance();
-	if($inst instanceof DeploynautJobInterface) {
+	if ($inst instanceof DeploynautJobInterface) {
 		$inst->onFailure($exception);
 	}
 });

code/backends/PackageGenerator.php

Spacing +4 added lines, -4 removed lines

@@ -50,14 +50,14 @@
 	 */
 	public function getPackageFilename($identifier, $sha, $repositoryDir, DeploynautLogFile $log) {
 		// Fetch through the cache
-		if($this->cache) {
-			$identifier .= '-' . get_class($this) . '-' . $this->getIdentifier();
+		if ($this->cache) {
+			$identifier .= '-'.get_class($this).'-'.$this->getIdentifier();
  			return $this->cache->getPackageFilename($this, $identifier, $sha, $repositoryDir, $log);
 
  		// Default, cacheless implementation
  		} else {
- 			$filename = TEMP_FOLDER . '/' . $sha . '.tar.gz';
- 			if($this->generatePackage($sha, $repositoryDir, $filename, $log)) {
+ 			$filename = TEMP_FOLDER.'/'.$sha.'.tar.gz';
+ 			if ($this->generatePackage($sha, $repositoryDir, $filename, $log)) {
  				return $filename;
  			}
  		}

code/backends/SimplePackageGenerator.php

Spacing +7 added lines, -7 removed lines

@@ -30,8 +30,8 @@ 
 	 * Generate the package
 	 */
 	public function generatePackage($sha, $baseDir, $outputFilename, DeploynautLogFile $log) {
-		$tempPath = TEMP_FOLDER . "/" . str_replace(".tar.gz", "", basename($outputFilename));
-		if(!file_exists($tempPath)) {
+		$tempPath = TEMP_FOLDER."/".str_replace(".tar.gz", "", basename($outputFilename));
+		if (!file_exists($tempPath)) {
 			mkdir($tempPath);
 		}
 
@@ -42,22 +42,22 @@ 
 		// 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 {
 			$this->executeProcesses($processes, $log);
-		} catch(Exception $e) {
+		} catch (Exception $e) {
 			// Execute cleanup on failure
 			$this->executeProcesses($cleanup, $log);
 			throw $e;
@@ -75,7 +75,7 @@ 
 	 * @param DeploynautLogFile $log The log to send output to
 	 */
 	protected function executeProcesses($processes, DeploynautLogFile $log) {
-		foreach($processes as $process) {
+		foreach ($processes as $process) {
 			$process->mustRun(function($type, $buffer) use($log) {
 				$log->write($buffer);
 			});

code/backends/SizeRestrictedPackageCache.php

Spacing +13 added lines, -13 removed lines

@@ -48,25 +48,25 @@ 
 		$repositoryDir,
 		DeploynautLogFile $log
 	) {
-		if(!$this->baseDir) {
+		if (!$this->baseDir) {
 			throw new \LogicException("Can't use PackageCache without setting BaseDir");
 		}
 
-		$buildPath = $this->baseDir . '/' . $this->sanitiseDirName($identifier);
+		$buildPath = $this->baseDir.'/'.$this->sanitiseDirName($identifier);
 		$filename = "$buildPath/$sha.tar.gz";
 
-		if(!file_exists($this->baseDir)) {
-			if(!mkdir($this->baseDir)) {
+		if (!file_exists($this->baseDir)) {
+			if (!mkdir($this->baseDir)) {
 				throw new \LogicException("Can't create base dir {$this->baseDir}");
 			}
 		}
-		if(!file_exists($buildPath)) {
-			if(!mkdir($buildPath)) {
+		if (!file_exists($buildPath)) {
+			if (!mkdir($buildPath)) {
 				throw new \LogicException("Can't create build path $buildPath");
 			}
 		}
 
-		if(file_exists($filename)) {
+		if (file_exists($filename)) {
 			$log->write("Using previously generated package $filename");
 			// This will ensure that our cache garbage collection will remove least-recently-accessed,
 			// rather than oldest.
@@ -74,11 +74,11 @@ 
 			return $filename;
 
 		} else {
-			if($this->cacheSize) {
+			if ($this->cacheSize) {
 				$this->reduceDirSizeTo($buildPath, $this->cacheSize - 1, $log);
 			}
 
-			if($generator->generatePackage($sha, $repositoryDir, $filename, $log)) {
+			if ($generator->generatePackage($sha, $repositoryDir, $filename, $log)) {
 				return $filename;
 			}
 		}
@@ -103,14 +103,14 @@ 
 	 * @param DeploynautLogFile $log The log to send removal status messages to
 	 */
 	protected function reduceDirSizeTo($dir, $count, DeploynautLogFile $log) {
-		$files = glob($dir . '/*.tar.gz');
-		if(sizeof($files) > $count) {
+		$files = glob($dir.'/*.tar.gz');
+		if (sizeof($files) > $count) {
 			usort($files, function($a, $b) {
 				return filemtime($a) > filemtime($b);
 			});
 
-			for($i = 0; $i < sizeof($files) - $count; $i++) {
-				$log->write("Removing " . $files[$i] . " from package cache");
+			for ($i = 0; $i < sizeof($files) - $count; $i++) {
+				$log->write("Removing ".$files[$i]." from package cache");
 				unlink($files[$i]);
 			}
 		}