silverstripe / deploynaut

code/model/jobs/DNDeployment.php

Doc Comments +3 added lines

@@ -82,6 +82,9 @@
 		'Deployer.Name' => 'Deployer'
 	);
 
+	/**
+	 * @param false|string $token
+	 */
 	public function setResqueToken($token) {
 		$this->ResqueToken = $token;
 	}

code/control/DeployDispatcher.php

Spacing +2 added lines, -2 removed lines

@@ -263,12 +263,12 @@
 
 		// failover for older deployments
 		$started = $deployment->Created;
-		if($deployment->DeployStarted) {
+		if ($deployment->DeployStarted) {
 			$started = $deployment->DeployStarted;
 		}
 
 		$requested = $deployment->Created;
-		if($deployment->DeployRequested) {
+		if ($deployment->DeployRequested) {
 			$requested = $deployment->DeployRequested;
 		}
 

code/model/DNEnvironment.php

Spacing +64 added lines, -64 removed lines

@@ -180,7 +180,7 @@ 
 	 */
 	public function Backend() {
 		$backends = array_keys($this->config()->get('allowed_backends', Config::FIRST_SET));
-		switch(sizeof($backends)) {
+		switch (sizeof($backends)) {
 		// Nothing allowed, use the default value "DeploymentBackend"
 			case 0:
 				$backend = "DeploymentBackend";
@@ -194,7 +194,7 @@ 
 			// Multiple choices, use our choice if it's legal, otherwise default to the first item on the list
 			default:
 				$backend = $this->BackendIdentifier;
-				if(!in_array($backend, $backends)) {
+				if (!in_array($backend, $backends)) {
 					$backend = $backends[0];
 				}
 		}
@@ -256,14 +256,14 @@ 
 
 	public function getBareURL() {
 		$url = parse_url($this->URL);
-		if(isset($url['host'])) {
+		if (isset($url['host'])) {
 			return strtolower($url['host']);
 		}
 	}
 
 	public function getBareDefaultURL() {
 		$url = parse_url($this->getDefaultURL());
-		if(isset($url['host'])) {
+		if (isset($url['host'])) {
 			return strtolower($url['host']);
 		}
 	}
@@ -275,20 +275,20 @@ 
 	 * @return boolean
 	 */
 	public function canView($member = null) {
-		if(!$member) {
+		if (!$member) {
 			$member = Member::currentUser();
 		}
-		if(!$member) {
+		if (!$member) {
 			return false;
 		}
 		// Must be logged in to check permissions
 
-		if(Permission::checkMember($member, 'ADMIN')) {
+		if (Permission::checkMember($member, 'ADMIN')) {
 			return true;
 		}
 
 		// if no Viewers or ViewerGroups defined, fallback to DNProject::canView permissions
-		if($this->Viewers()->exists() || $this->ViewerGroups()->exists()) {
+		if ($this->Viewers()->exists() || $this->ViewerGroups()->exists()) {
 			return $this->Viewers()->byID($member->ID)
 				|| $member->inGroups($this->ViewerGroups());
 		}
@@ -303,10 +303,10 @@ 
 	 * @return boolean
 	 */
 	public function canDeploy($member = null) {
-		if(!$member) {
+		if (!$member) {
 			$member = Member::currentUser();
 		}
-		if(!$member) {
+		if (!$member) {
 			return false;
 		}
 		// Must be logged in to check permissions
@@ -338,10 +338,10 @@ 
 	 * @return boolean true if $member can restore, and false if they can't.
 	 */
 	public function canRestore($member = null) {
-		if(!$member) {
+		if (!$member) {
 			$member = Member::currentUser();
 		}
-		if(!$member) {
+		if (!$member) {
 			return false;
 		}
 		// Must be logged in to check permissions
@@ -365,15 +365,15 @@ 
 	 */
 	public function canBackup($member = null) {
 		$project = $this->Project();
-		if($project->HasDiskQuota() && $project->HasExceededDiskQuota()) {
+		if ($project->HasDiskQuota() && $project->HasExceededDiskQuota()) {
 			return false;
 		}
 
-		if(!$member) {
+		if (!$member) {
 			$member = Member::currentUser();
 		}
 		// Must be logged in to check permissions
-		if(!$member) {
+		if (!$member) {
 			return false;
 		}
 
@@ -400,14 +400,14 @@ 
 	 */
 	public function canUploadArchive($member = null) {
 		$project = $this->Project();
-		if($project->HasDiskQuota() && $project->HasExceededDiskQuota()) {
+		if ($project->HasDiskQuota() && $project->HasExceededDiskQuota()) {
 			return false;
 		}
 
-		if(!$member) {
+		if (!$member) {
 			$member = Member::currentUser();
 		}
-		if(!$member) {
+		if (!$member) {
 			return false;
 		}
 		// Must be logged in to check permissions
@@ -430,10 +430,10 @@ 
 	 * @return boolean true if $member can download archives from this environment, false if they can't.
 	 */
 	public function canDownloadArchive($member = null) {
-		if(!$member) {
+		if (!$member) {
 			$member = Member::currentUser();
 		}
-		if(!$member) {
+		if (!$member) {
 			return false;
 		}
 		// Must be logged in to check permissions
@@ -456,10 +456,10 @@ 
 	 * @return boolean true if $member can delete archives from this environment, false if they can't.
 	 */
 	public function canDeleteArchive($member = null) {
-		if(!$member) {
+		if (!$member) {
 			$member = Member::currentUser();
 		}
-		if(!$member) {
+		if (!$member) {
 			return false;
 		}
 		// Must be logged in to check permissions
@@ -589,18 +589,18 @@ 
 			'State' => DNDeployment::STATE_COMPLETED
 		))->sort('LastEdited DESC')->first();
 
-		if(!$deploy || (!$deploy->SHA)) {
+		if (!$deploy || (!$deploy->SHA)) {
 			return false;
 		}
 
 		$repo = $this->Project()->getRepository();
-		if(!$repo) {
+		if (!$repo) {
 			return $deploy;
 		}
 
 		try {
 			$commit = $repo->getCommit($deploy->SHA);
-			if($commit) {
+			if ($commit) {
 				$deploy->Message = Convert::raw2xml($commit->getMessage());
 				$deploy->Committer = Convert::raw2xml($commit->getCommitterName());
 				$deploy->CommitDate = $commit->getCommitterDate()->Format('d/m/Y g:ia');
@@ -608,7 +608,7 @@ 
 				$deploy->AuthorDate = $commit->getAuthorDate()->Format('d/m/Y g:ia');
 			}
 			// We can't find this SHA, so we ignore adding a commit message to the deployment
-		} catch(Exception $ex) { }
+		} catch (Exception $ex) { }
 
 		return $deploy;
 	}
@@ -621,7 +621,7 @@ 
 	public function DeployHistory($orderBy = '') {
 
 		$sort = [];
-		if($orderBy != '') {
+		if ($orderBy != '') {
 			$sort[$orderBy] = 'DESC';
 		}
 		// default / fallback sort order
@@ -661,17 +661,17 @@ 
 	protected function getCommitData($sha) {
 		try {
 			$repo = $this->Project()->getRepository();
-			if($repo !== false) {
+			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())
 				];
 			}
-		} catch(\Gitonomy\Git\Exception\ReferenceNotFoundException $exc) {
+		} catch (\Gitonomy\Git\Exception\ReferenceNotFoundException $exc) {
 			SS_Log::log($exc, SS_Log::WARN);
 		}
 		return array(
@@ -743,12 +743,12 @@ 
 		$fields = new FieldList(new TabSet('Root'));
 
 		$project = $this->Project();
-		if($project && $project->exists()) {
+		if ($project && $project->exists()) {
 			$viewerGroups = $project->Viewers();
 			$groups = $viewerGroups->sort('Title')->map()->toArray();
 			$members = array();
-			foreach($viewerGroups as $group) {
-				foreach($group->Members()->map() as $k => $v) {
+			foreach ($viewerGroups as $group) {
+				foreach ($group->Members()->map() as $k => $v) {
 					$members[$k] = $v;
 				}
 			}
@@ -785,7 +785,7 @@ 
 		// Backend identifier - pick from a named list of configurations specified in YML config
 		$backends = $this->config()->get('allowed_backends', Config::FIRST_SET);
 		// If there's only 1 backend, then user selection isn't needed
-		if(sizeof($backends) > 1) {
+		if (sizeof($backends) > 1) {
 			$fields->addFieldToTab('Root.Main', DropdownField::create('BackendIdentifier', 'Deployment backend')
 				->setSource($backends)
 				->setDescription('What kind of deployment system should be used to deploy to this environment'));
@@ -834,7 +834,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).'
 				),
 
@@ -854,14 +854,14 @@ 
 		));
 
 		// The Main.DeployConfig
-		if($this->Project()->exists()) {
+		if ($this->Project()->exists()) {
 			$this->setDeployConfigurationFields($fields);
 		}
 
 		// The DataArchives
 		$dataArchiveConfig = GridFieldConfig_RecordViewer::create();
 		$dataArchiveConfig->removeComponentsByType('GridFieldAddNewButton');
-		if(class_exists('GridFieldBulkManager')) {
+		if (class_exists('GridFieldBulkManager')) {
 			$dataArchiveConfig->addComponent(new GridFieldBulkManager());
 		}
 		$dataArchive = GridField::create('DataArchives', 'Data Archives', $this->DataArchives(), $dataArchiveConfig);
@@ -870,7 +870,7 @@ 
 		// Deployments
 		$deploymentsConfig = GridFieldConfig_RecordEditor::create();
 		$deploymentsConfig->removeComponentsByType('GridFieldAddNewButton');
-		if(class_exists('GridFieldBulkManager')) {
+		if (class_exists('GridFieldBulkManager')) {
 			$deploymentsConfig->addComponent(new GridFieldBulkManager());
 		}
 		$deployments = GridField::create('Deployments', 'Deployments', $this->Deployments(), $deploymentsConfig);
@@ -881,7 +881,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');
 
@@ -894,11 +894,11 @@ 
 	 * @param FieldList $fields
 	 */
 	protected function setDeployConfigurationFields(&$fields) {
-		if(!$this->config()->get('allow_web_editing')) {
+		if (!$this->config()->get('allow_web_editing')) {
 			return;
 		}
 
-		if($this->envFileExists()) {
+		if ($this->envFileExists()) {
 			$deployConfig = new TextareaField('DeployConfig', 'Deploy config', $this->getEnvironmentConfig());
 			$deployConfig->setRows(40);
 			$fields->insertAfter($deployConfig, 'Filename');
@@ -918,8 +918,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();
@@ -928,13 +928,13 @@ 
 	public function onAfterWrite() {
 		parent::onAfterWrite();
 
-		if($this->Usage === self::PRODUCTION || $this->Usage === self::UAT) {
+		if ($this->Usage === self::PRODUCTION || $this->Usage === self::UAT) {
 			$conflicting = DNEnvironment::get()
 				->filter('ProjectID', $this->ProjectID)
 				->filter('Usage', $this->Usage)
 				->exclude('ID', $this->ID);
 
-			foreach($conflicting as $otherEnvironment) {
+			foreach ($conflicting as $otherEnvironment) {
 				$otherEnvironment->Usage = self::UNSPECIFIED;
 				$otherEnvironment->write();
 			}
@@ -948,7 +948,7 @@ 
 	protected function checkEnvironmentPath() {
 		// Create folder if it doesn't exist
 		$configDir = dirname($this->getConfigFilename());
-		if(!file_exists($configDir) && $configDir) {
+		if (!file_exists($configDir) && $configDir) {
 			mkdir($configDir, 0777, true);
 		}
 	}
@@ -957,18 +957,18 @@ 
 	 * Write the deployment config file to filesystem
 	 */
 	protected function writeConfigFile() {
-		if(!$this->config()->get('allow_web_editing')) {
+		if (!$this->config()->get('allow_web_editing')) {
 			return;
 		}
 
 		// Create a basic new environment config from a template
-		if(!$this->envFileExists()
+		if (!$this->envFileExists()
 			&& $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) {
+		} else if ($this->envFileExists() && $this->DeployConfig) {
 			file_put_contents($this->getConfigFilename(), $this->DeployConfig);
 		}
 	}
@@ -979,12 +979,12 @@ 
 	public function onAfterDelete() {
 		parent::onAfterDelete();
 		// Create a basic new environment config from a template
-		if($this->config()->get('allow_web_editing') && $this->envFileExists()) {
+		if ($this->config()->get('allow_web_editing') && $this->envFileExists()) {
 			unlink($this->getConfigFilename());
 		}
 
 		$create = $this->CreateEnvironment();
-		if($create && $create->exists()) {
+		if ($create && $create->exists()) {
 			$create->delete();
 		}
 	}
@@ -993,7 +993,7 @@ 
 	 * @return string
 	 */
 	protected function getEnvironmentConfig() {
-		if(!$this->envFileExists()) {
+		if (!$this->envFileExists()) {
 			return '';
 		}
 		return file_get_contents($this->getConfigFilename());
@@ -1003,7 +1003,7 @@ 
 	 * @return boolean
 	 */
 	protected function envFileExists() {
-		if(!$this->getConfigFilename()) {
+		if (!$this->getConfigFilename()) {
 			return false;
 		}
 		return file_exists($this->getConfigFilename());
@@ -1015,13 +1015,13 @@ 
 	 * @return string
 	 */
 	public function getConfigFilename() {
-		if(!$this->Project()->exists()) {
+		if (!$this->Project()->exists()) {
 			return '';
 		}
-		if(!$this->Filename) {
+		if (!$this->Filename) {
 			return '';
 		}
-		return $this->DNData()->getEnvironmentDir() . '/' . $this->Project()->Name . '/' . $this->Filename;
+		return $this->DNData()->getEnvironmentDir().'/'.$this->Project()->Name.'/'.$this->Filename;
 	}
 
 	/**
@@ -1034,24 +1034,24 @@ 
 	 */
 	public static function array_to_viewabledata($array) {
 		// Don't transform non-arrays
-		if(!is_array($array)) {
+		if (!is_array($array)) {
 			return $array;
 		}
 
 		// Figure out whether this is indexed or associative
 		$keys = array_keys($array);
 		$assoc = ($keys != array_keys($keys));
-		if($assoc) {
+		if ($assoc) {
 			// Treat as viewable data
 			$data = new ArrayData(array());
-			foreach($array as $key => $value) {
+			foreach ($array as $key => $value) {
 				$data->setField($key, self::array_to_viewabledata($value));
 			}
 			return $data;
 		} else {
 			// Treat this as basic non-associative list
 			$list = new ArrayList();
-			foreach($array as $value) {
+			foreach ($array as $value) {
 				$list->push(self::array_to_viewabledata($value));
 			}
 			return $list;
@@ -1062,7 +1062,7 @@ 
 		$result = parent::validate();
 		$backend = $this->Backend();
 
-		if(strcasecmp('test', $this->Name) === 0 && get_class($backend) == 'CapistranoDeploymentBackend') {
+		if (strcasecmp('test', $this->Name) === 0 && get_class($backend) == 'CapistranoDeploymentBackend') {
 			$result->error('"test" is not a valid environment name when using Capistrano backend.');
 		}