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;

Braces +6 added lines, -2 removed lines

@@ -110,8 +110,12 @@
 		// 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,

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/model/DNEnvironment.php

Upper-Lower-Casing +1 added lines, -1 removed lines

@@ -954,7 +954,7 @@
 to other environments, alongside the "Who can restore" permission.<br>
 Should include all users with upload permissions, otherwise they can't download
 their own uploads.
-PHP
+php
 				),
 
 			// The Main.PipelineApprovers

Doc Comments +1 added lines, -1 removed lines

@@ -578,7 +578,7 @@
 	 * Dear people of the future: If you are looking to optimize this, simply create a CurrentBuildSHA(), which can be
 	 * a lot faster. I presume you came here because of the Project display template, which only needs a SHA.
 	 *
-	 * @return false|DNDeployment
+	 * @return DNDeployment
 	 */
 	public function CurrentBuild() {
 		// The DeployHistory function is far too slow to use for this

Spacing +9 added lines, -9 removed lines

@@ -774,7 +774,7 @@ 
 				->buildPermissionField('ArchiveUploaderGroups', 'ArchiveUploaders', $groups, $members)
 				->setTitle('Who can upload?')
 				->setDescription(
-					'Users who can upload archives linked to this environment into Deploynaut.<br />' .
+					'Users who can upload archives linked to this environment into Deploynaut.<br />'.
 					'Linking them to an environment allows limiting download permissions (see below).'
 				),
 
@@ -821,7 +821,7 @@ 
 		// Add actions
 		$action = new FormAction('check', 'Check Connection');
 		$action->setUseButtonTag(true);
-		$dataURL = Director::absoluteBaseURL() . 'naut/api/' . $this->Project()->Name . '/' . $this->Name . '/ping';
+		$dataURL = Director::absoluteBaseURL().'naut/api/'.$this->Project()->Name.'/'.$this->Name.'/ping';
 		$action->setAttribute('data-url', $dataURL);
 		$fields->insertBefore($action, 'Name');
 
@@ -834,8 +834,8 @@ 
 	 */
 	public function onBeforeWrite() {
 		parent::onBeforeWrite();
-		if ($this->Name && $this->Name . '.rb' != $this->Filename) {
-			$this->Filename = $this->Name . '.rb';
+		if ($this->Name && $this->Name.'.rb' != $this->Filename) {
+			$this->Filename = $this->Name.'.rb';
 		}
 		$this->checkEnvironmentPath();
 		$this->writeConfigFile();
@@ -885,7 +885,7 @@ 
 		if (!$this->Filename) {
 			return '';
 		}
-		return $this->DNData()->getEnvironmentDir() . '/' . $this->Project()->Name . '/' . $this->Filename;
+		return $this->DNData()->getEnvironmentDir().'/'.$this->Project()->Name.'/'.$this->Filename;
 	}
 
 	/**
@@ -947,9 +947,9 @@ 
 			if ($repo !== false) {
 				$commit = new \Gitonomy\Git\Commit($repo, $sha);
 				return [
-					'AuthorName' => (string) Convert::raw2xml($commit->getAuthorName()),
-					'AuthorEmail' => (string) Convert::raw2xml($commit->getAuthorEmail()),
-					'Message' => (string) Convert::raw2xml($commit->getMessage()),
+					'AuthorName' => (string)Convert::raw2xml($commit->getAuthorName()),
+					'AuthorEmail' => (string)Convert::raw2xml($commit->getAuthorEmail()),
+					'Message' => (string)Convert::raw2xml($commit->getMessage()),
 					'ShortHash' => Convert::raw2xml($commit->getFixedShortHash(8)),
 					'Hash' => Convert::raw2xml($commit->getHash())
 				];
@@ -1039,7 +1039,7 @@ 
 			&& $this->Filename
 			&& $this->CreateEnvConfig
 		) {
-			$templateFile = $this->config()->template_file ?: BASE_PATH . '/deploynaut/environment.template';
+			$templateFile = $this->config()->template_file ?: BASE_PATH.'/deploynaut/environment.template';
 			file_put_contents($this->getConfigFilename(), file_get_contents($templateFile));
 		} else if ($this->envFileExists() && $this->DeployConfig) {
 			file_put_contents($this->getConfigFilename(), $this->DeployConfig);

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

@@ -178,7 +178,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 {
@@ -242,7 +242,7 @@ 
 		}
 
 		// Block framework jquery
-		Requirements::block(FRAMEWORK_DIR . '/thirdparty/jquery/jquery.js');
+		Requirements::block(FRAMEWORK_DIR.'/thirdparty/jquery/jquery.js');
 
 		self::include_requirements();
 	}
@@ -261,7 +261,7 @@ 
 	 * @return \SS_HTTPResponse
 	 */
 	public function index(SS_HTTPRequest $request) {
-		return $this->redirect($this->Link() . 'projects/');
+		return $this->redirect($this->Link().'projects/');
 	}
 
 	/**
@@ -389,7 +389,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 = [];
@@ -421,7 +421,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;
 	}
@@ -442,7 +442,7 @@ 
 		}
 
 		$validEnvs = $project->DNEnvironmentList()
-			->filterByCallback(function ($item) {
+			->filterByCallback(function($item) {
 				return $item->canUploadArchive();
 			});
 
@@ -471,9 +471,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();
@@ -547,7 +547,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 = [];
@@ -573,7 +573,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;
 	}
@@ -592,7 +592,7 @@ 
 			return $this->project404Response();
 		}
 
-		$validEnvs = $project->DNEnvironmentList()->filterByCallback(function ($item) {
+		$validEnvs = $project->DNEnvironmentList()->filterByCallback(function($item) {
 			return $item->canUploadArchive();
 		});
 
@@ -712,7 +712,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([
@@ -740,7 +740,7 @@ 
 		return $this->render([
 			'DNEnvironmentList' => $this->getCurrentProject()->DNEnvironmentList(),
 			'FlagSnapshotsEnabled' => $this->FlagSnapshotsEnabled(),
-			'Redeploy' => (bool) $request->getVar('redeploy')
+			'Redeploy' => (bool)$request->getVar('redeploy')
 		]);
 	}
 
@@ -849,7 +849,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;
 	}
@@ -882,7 +882,7 @@ 
 		$job->write();
 		$job->start();
 
-		return $this->redirect($project->Link('createenv') . '/' . $job->ID);
+		return $this->redirect($project->Link('createenv').'/'.$job->ID);
 	}
 
 	/**
@@ -1008,7 +1008,7 @@ 
 
 				$isCurrentEnvironment = false;
 				if ($project && $currentEnvironment) {
-					$isCurrentEnvironment = (bool) $project->DNEnvironmentList()->find('ID', $currentEnvironment->ID);
+					$isCurrentEnvironment = (bool)$project->DNEnvironmentList()->find('ID', $currentEnvironment->ID);
 				}
 
 				$navigation->push([
@@ -1080,7 +1080,7 @@ 
 			return $body;
 		}
 
-		$form->setFormAction($this->getRequest()->getURL() . '/DeployForm');
+		$form->setFormAction($this->getRequest()->getURL().'/DeployForm');
 		return $form;
 	}
 
@@ -1346,7 +1346,7 @@ 
 		$deployment->getMachine()->apply(DNDeployment::TR_QUEUE);
 
 		return json_encode([
-			'url' => Director::absoluteBaseURL() . $deployment->Link()
+			'url' => Director::absoluteBaseURL().$deployment->Link()
 		], JSON_PRETTY_PRINT);
 	}
 
@@ -1469,7 +1469,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();
 		});
 
@@ -1491,7 +1491,7 @@ 
 					->addExtraClass('btn')
 			)
 		);
-		$form->setFormAction($this->getRequest()->getURL() . '/DataTransferForm');
+		$form->setFormAction($this->getRequest()->getURL().'/DataTransferForm');
 
 		return $form;
 	}
@@ -1517,12 +1517,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 {
@@ -1653,7 +1653,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();
 		});
 
@@ -1692,7 +1692,7 @@ 
 					->addExtraClass('btn')
 			)
 		);
-		$form->setFormAction($project->Link() . '/DataTransferRestoreForm');
+		$form->setFormAction($project->Link().'/DataTransferRestoreForm');
 
 		return $form;
 	}
@@ -1790,7 +1790,7 @@ 
 					->addExtraClass('btn')
 			)
 		);
-		$form->setFormAction($project->Link() . '/DeleteForm');
+		$form->setFormAction($project->Link().'/DeleteForm');
 
 		return $form;
 	}
@@ -1896,7 +1896,7 @@ 
 					->addExtraClass('btn')
 			)
 		);
-		$form->setFormAction($this->getCurrentProject()->Link() . '/MoveForm');
+		$form->setFormAction($this->getCurrentProject()->Link().'/MoveForm');
 
 		return $form;
 	}
@@ -2157,7 +2157,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() ||
@@ -2282,7 +2282,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
 		);
 	}
@@ -2292,7 +2292,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/model/GitonomyCache.php

Spacing +1 added lines, -1 removed lines

@@ -7,7 +7,7 @@
 	public static $cache = array();
 
 	public static function getIncludingBranches($commit) {
-		$cacheKey = 'getIncludingBranches-' . $commit->getRepository()->getPath() . '-' . $commit->gethash();
+		$cacheKey = 'getIncludingBranches-'.$commit->getRepository()->getPath().'-'.$commit->gethash();
 		if(!isset(self::$cache[$cacheKey])) {
 			self::$cache[$cacheKey] = $commit->getIncludingBranches();
 		}

code/model/jobs/DNPing.php

Spacing +1 added lines, -1 removed lines

@@ -37,7 +37,7 @@
 	 * @return string
 	 */
 	public function LogLink() {
-		return $this->Link() . '/log';
+		return $this->Link().'/log';
 	}
 
 	/**

code/model/jobs/DNDataTransfer.php

Spacing +5 added lines, -5 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;

code/model/jobs/DNCreateEnvironment.php

Spacing +2 added lines, -2 removed lines

@@ -68,7 +68,7 @@ 
 	 * @return string
 	 */
 	public function LogLink() {
-		return $this->Link() . '/log';
+		return $this->Link().'/log';
 	}
 
 	/**
@@ -190,7 +190,7 @@ 
 			if($env instanceof EnvironmentCreateBackend) {
 				return $env;
 			} else {
-				throw new Exception("Invalid backend: " . $data['EnvironmentType']);
+				throw new Exception("Invalid backend: ".$data['EnvironmentType']);
 			}
 		}
 		return null;

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/model/DNData.php

Spacing +8 added lines, -8 removed lines

@@ -89,7 +89,7 @@ 
 	 */
 	public function setEnvironmentDir($environmentDir) {
 		if($environmentDir[0] != "/") {
-			$environmentDir = BASE_PATH . '/' . $environmentDir;
+			$environmentDir = BASE_PATH.'/'.$environmentDir;
 		}
 		$this->environmentDir = realpath($environmentDir) ?: $environmentDir;
 	}
@@ -110,7 +110,7 @@ 
 	 */
 	public function setKeyDir($keyDir) {
 		if($keyDir[0] != "/") {
-			$keyDir = BASE_PATH . '/' . $keyDir;
+			$keyDir = BASE_PATH.'/'.$keyDir;
 		}
 		$this->keyDir = realpath($keyDir) ?: $keyDir;
 	}
@@ -127,7 +127,7 @@ 
 	 */
 	public function setSignalDir($signalDir) {
 		if($signalDir[0] != "/") {
-			$signalDir = BASE_PATH . '/' . $signalDir;
+			$signalDir = BASE_PATH.'/'.$signalDir;
 		}
 		$this->signalDir = realpath($signalDir) ?: $signalDir;
 	}
@@ -169,7 +169,7 @@ 
 	 */
 	public function setDataTransferDir($transferDir) {
 		if($transferDir[0] != "/") {
-			$transferDir = BASE_PATH . '/' . $transferDir;
+			$transferDir = BASE_PATH.'/'.$transferDir;
 		}
 		if(strpos($transferDir, ASSETS_PATH) === false) {
 			throw new LogicException(sprintf(
@@ -199,14 +199,14 @@ 
 	public function getProjectPaths() {
 		$paths = array();
 		if(!file_exists($this->getEnvironmentDir())) {
-			$eMessage = 'The environment directory ' . $this->getEnvironmentDir() . ' doesn\'t exist. Create it '
+			$eMessage = 'The environment directory '.$this->getEnvironmentDir().' doesn\'t exist. Create it '
 			. 'first and add some projects to it.';
 			throw new Exception($eMessage);
 		}
 		foreach(scandir($this->getEnvironmentDir()) as $project) {
 			// Exlcude dot-prefixed directories (.git was getting in the way)
 			if(preg_match('/^[^\.]/', $project)) {
-				$path = $this->getEnvironmentDir() . '/' . $project;
+				$path = $this->getEnvironmentDir().'/'.$project;
 				if(is_dir($path) && $project != '.' && $project != '..') {
 					$paths[] = $project;
 				}
@@ -221,11 +221,11 @@ 
 	 * Returns an array of paths
 	 */
 	public function getEnvironmentPaths($project) {
-		$baseDir = $this->getEnvironmentDir() . '/' . $project;
+		$baseDir = $this->getEnvironmentDir().'/'.$project;
 
 		$paths = array();
 		if(!file_exists($baseDir)) {
-			throw new Exception('Environment directory ' . $baseDir . ' doesn\'t exist. Create it first.');
+			throw new Exception('Environment directory '.$baseDir.' doesn\'t exist. Create it first.');
 		}
 		// Search the directory for config files.
 		foreach(scandir($baseDir) as $environmentFile) {