silverstripe / deploynaut

code/api/DeploynautAPI.php

Doc Comments +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
 	/**
 	 *
 	 * @param SS_HTTPRequest $request
-	 * @return string
+	 * @return SS_HTTPResponse
 	 */
 	public function listProjects(SS_HTTPRequest $request) {
 		$response = array(

Braces +4 added lines, -1 removed lines

@@ -49,7 +49,10 @@
 			'projects' => array(),
 		);
 
-		if($request->httpMethod() != 'GET') return $this->message('API not found', 404);;
+		if($request->httpMethod() != 'GET') {
+			return $this->message('API not found', 404);
+		}
+		;
 
 		foreach(DNProject::get() as $item) {
 			if($item->canView($this->getMember())) {

code/backends/CapistranoDeploymentBackend.php

Doc Comments +1 added lines

@@ -300,6 +300,7 @@
 	/**
 	 * Utility function for triggering the db rebuild and flush.
 	 * Also cleans up and generates new error pages.
+	 * @param DeploynautLogFile $log
 	 */
 	public function rebuild(DNEnvironment $environment, $log) {
 		$name = $environment->getFullName();

Braces +3 added lines, -1 removed lines

@@ -176,7 +176,9 @@
 		$name = $environment->getFullName();
 		$env = $environment->Project()->getProcessEnv();
 
-		if(!$args) $args = array();
+		if(!$args) {
+			$args = array();
+		}
 		$args['history_path'] = realpath(DEPLOYNAUT_LOG_PATH.'/');
 
 		// Inject env string directly into the command.

code/backends/DeploymentBackend.php

Doc Comments +5 added lines

@@ -10,6 +10,7 @@ 
 	 * @param DeploynautLogFile $log
 	 * @param DNProject $project
 	 * @param type $leaveMaintenancePage
+	 * @return void
 	 */
 	public function deploy(DNEnvironment $environment, $sha, DeploynautLogFile $log, DNProject $project, $leaveMaintenancePage = false);
 
@@ -19,6 +20,7 @@ 
 	 *
 	 * @param DNDataTransfer $dataTransfer
 	 * @param DeploynautLogFile $log
+	 * @return void
 	 */
 	public function dataTransfer(DNDataTransfer $dataTransfer, DeploynautLogFile $log);
 
@@ -28,6 +30,7 @@ 
 	 * @param DNEnvironment $environment
 	 * @param DeploynautLogFile $log
 	 * @param DNProject $project
+	 * @return void
 	 */
 	public function enableMaintenance(DNEnvironment $environment, DeploynautLogFile $log, DNProject $project);
 
@@ -37,6 +40,7 @@ 
 	 * @param DNEnvironment $environment
 	 * @param DeploynautLogFile $log
 	 * @param DNProject $project
+	 * @return void
 	 */
 	public function disableMaintenance(DNEnvironment $environment, DeploynautLogFile $log, DNProject $project);
 
@@ -46,6 +50,7 @@ 
 	 * @param DNEnvironment $environment
 	 * @param DeploynautLogFile $log
 	 * @param DNProject $project
+	 * @return void
 	 */
 	public function ping(DNEnvironment $environment, DeploynautLogFile $log, DNProject $project);
 

code/backends/PackageGenerator.php

Doc Comments +2 added lines, -1 removed lines

@@ -13,8 +13,9 @@
 	/**
 	 * Generate the package file, saving to the given location
 	 *
-	 * @param $baseDir string The base directory of the project, checked out from git.
+	 * @param string $baseDir string The base directory of the project, checked out from git.
 	 * @param $outputFilename string The filename to write to.
+	 * @param string $sha
 	 *
 	 * @return boolean True on success
 	 */

code/backends/SizeRestrictedPackageCache.php

Doc Comments +1 added lines, -1 removed lines

@@ -72,7 +72,7 @@
 	/**
 	 * Take the identifier an make it safe to use as a directory name.
 	 *
-	 * @param string $identfiier The unsanitised directory name.
+	 * @param string $identifier The unsanitised directory name.
 	 */
 	protected function sanitiseDirName($identifier) {
 		$safe = preg_replace('/[^A-Za-z0-9_-]/', '', $identifier);

Braces +12 added lines, -4 removed lines

@@ -41,16 +41,22 @@ 
 	 * @param DeploynautLogFile $log The log to write status output to, including package-generation commands
 	 */
 	public function getPackageFilename(PackageGenerator $generator, $identifier, $sha, $repositoryDir, DeploynautLogFile $log) {
-		if(!$this->baseDir) throw new \LogicException("Can't use PackageCache without setting BaseDir");
+		if(!$this->baseDir) {
+			throw new \LogicException("Can't use PackageCache without setting BaseDir");
+		}
 
 		$buildPath = $this->baseDir . '/' . $this->sanitiseDirName($identifier);
 		$filename = "$buildPath/$sha.tar.gz";
 
 		if(!file_exists($this->baseDir)) {
-			if(!mkdir($this->baseDir)) throw new \LogicException("Can't create base dir {$this->baseDir}");
+			if(!mkdir($this->baseDir)) {
+				throw new \LogicException("Can't create base dir {$this->baseDir}");
+			}
 		}
 		if(!file_exists($buildPath)) {
-			if(!mkdir($buildPath)) throw new \LogicException("Can't create build path $buildPath");
+			if(!mkdir($buildPath)) {
+				throw new \LogicException("Can't create build path $buildPath");
+			}
 		}
 
 		if(file_exists($filename)) {
@@ -61,7 +67,9 @@ 
 			return $filename;
 
 		} else {
-			if($this->cacheSize) $this->reduceDirSizeTo($buildPath, $this->cacheSize-1, $log);
+			if($this->cacheSize) {
+				$this->reduceDirSizeTo($buildPath, $this->cacheSize-1, $log);
+			}
 
 			if($generator->generatePackage($sha, $repositoryDir, $filename, $log)) {
 				return $filename;

code/control/DeployForm.php

Doc Comments +5 added lines, -1 removed lines

@@ -18,6 +18,7 @@ 
 	 * Validate a commit sha
 	 *
 	 * @param string $sha
+	 * @param string $field
 	 * @return boolean
 	 */
 	protected function validateCommit($sha, $field) {
@@ -100,6 +101,10 @@ 
  */
 class DeployForm extends Form {
 
+	/**
+	 * @param DNRoot $controller
+	 * @param string $name
+	 */
 	public function __construct($controller, $name, DNEnvironment $environment, DNProject $project) {
 		if($environment->HasPipelineSupport()) {
 			// Determine if commits are filtered
@@ -261,7 +266,6 @@ 
 	/**
 	 * Generate fields necessary to select from a filtered commit list
 	 *
-	 * @param DNEnvironment $environment
 	 * @param DataList $commits List of commits
 	 * @return FormField
 	 */

code/control/DNRoot.php

Doc Comments +7 added lines, -4 removed lines

@@ -161,7 +161,7 @@ 
 	/**
 	 * Action
 	 *
-	 * @return string - HTML
+	 * @return HTMLText - HTML
 	 */
 	public function projects(SS_HTTPRequest $request) {
 		// Performs canView permission check by limiting visible projects in DNProjectsList() call.
@@ -854,6 +854,7 @@ 
 	}
 
 	/**
+	 * @param SS_HTTPRequest $request
 	 * @return Form
 	 */
 	public function getDataTransferForm($request) {
@@ -1189,6 +1190,8 @@ 
 
 	/**
 	 * Build snapshot move form.
+	 * @param SS_HTTPRequest $request
+	 * @param DataObject $dataArchive
 	 */
 	public function getMoveForm($request, $dataArchive = null) {
 		$dataArchive = $dataArchive ? $dataArchive : DNDataArchive::get()->byId($request->requestVar('DataArchiveID'));
@@ -1330,7 +1333,7 @@ 
 	 * TODO To be replaced with a method that just returns the list of archives this {@link Member} has access to.
 	 *
 	 * @param Member $member The {@link Member} to check (or null to check the currently logged in Member)
-	 * @return boolean true if $member has access to upload or download to at least one {@link DNEnvironment}.
+	 * @return boolean|null true if $member has access to upload or download to at least one {@link DNEnvironment}.
 	 */
 	public function CanViewArchives(Member $member = null) {
 		if(!$member) $member = Member::currentUser();
@@ -1357,7 +1360,7 @@ 
 	}
 
 	/**
-	 * @return ArrayList The list of all archive files that can be accessed by the currently logged-in {@link Member}
+	 * @return PaginatedList The list of all archive files that can be accessed by the currently logged-in {@link Member}
 	 */
 	public function CompleteDataArchives() {
 		$project = $this->getCurrentProject();
@@ -1375,7 +1378,7 @@ 
 	}
 
 	/**
-	 * @return ArrayList The list of "pending" data archives which are waiting for a file
+	 * @return PaginatedList The list of "pending" data archives which are waiting for a file
 	 * to be delivered offline by post, and manually uploaded into the system.
 	 */
 	public function PendingDataArchives() {

Braces +75 added lines, -25 removed lines

@@ -107,11 +107,15 @@ 
 	 * @return boolean
 	 */
 	public static function FlagSnapshotsEnabled() {
-		if (defined('FLAG_SNAPSHOTS_ENABLED') && FLAG_SNAPSHOTS_ENABLED) return true;
+		if (defined('FLAG_SNAPSHOTS_ENABLED') && FLAG_SNAPSHOTS_ENABLED) {
+			return true;
+		}
 		if (defined('FLAG_SNAPSHOTS_ENABLED_FOR_MEMBERS') && FLAG_SNAPSHOTS_ENABLED_FOR_MEMBERS) {
 			$allowedMembers = explode(';', FLAG_SNAPSHOTS_ENABLED_FOR_MEMBERS);
 			$member = Member::currentUser();
-			if ($allowedMembers && $member && in_array($member->Email, $allowedMembers)) return true;
+			if ($allowedMembers && $member && in_array($member->Email, $allowedMembers)) {
+				return true;
+			}
 		}
 		return false;
 	}
@@ -655,14 +659,22 @@ 
 		$params = $request->params();
 		$pipeline = Pipeline::get()->byID($params['Identifier']);
 
-		if(!$pipeline || !$pipeline->ID || !$pipeline->Environment()) throw new SS_HTTPResponse_Exception('Pipeline not found', 404);
-		if(!$pipeline->Environment()->canView()) return Security::permissionFailure();
+		if(!$pipeline || !$pipeline->ID || !$pipeline->Environment()) {
+			throw new SS_HTTPResponse_Exception('Pipeline not found', 404);
+		}
+		if(!$pipeline->Environment()->canView()) {
+			return Security::permissionFailure();
+		}
 
 		$environment = $pipeline->Environment();
 		$project = $pipeline->Environment()->Project();
 
-		if($environment->Name != $params['Environment']) throw new LogicException("Environment in URL doesn't match this pipeline");
-		if($project->Name != $params['Project']) throw new LogicException("Project in URL doesn't match this pipeline");
+		if($environment->Name != $params['Environment']) {
+			throw new LogicException("Environment in URL doesn't match this pipeline");
+		}
+		if($project->Name != $params['Project']) {
+			throw new LogicException("Project in URL doesn't match this pipeline");
+		}
 
 		// Delegate to sub-requesthandler
 		return PipelineController::create($this, $pipeline);
@@ -795,14 +807,22 @@ 
 		$params = $request->params();
 		$deployment = DNDeployment::get()->byId($params['Identifier']);
 
-		if(!$deployment || !$deployment->ID) throw new SS_HTTPResponse_Exception('Deployment not found', 404);
-		if(!$deployment->canView()) return Security::permissionFailure();
+		if(!$deployment || !$deployment->ID) {
+			throw new SS_HTTPResponse_Exception('Deployment not found', 404);
+		}
+		if(!$deployment->canView()) {
+			return Security::permissionFailure();
+		}
 
 		$environment = $deployment->Environment();
 		$project = $environment->Project();
 
-		if($environment->Name != $params['Environment']) throw new LogicException("Environment in URL doesn't match this deploy");
-		if($project->Name != $params['Project']) throw new LogicException("Project in URL doesn't match this deploy");
+		if($environment->Name != $params['Environment']) {
+			throw new LogicException("Environment in URL doesn't match this deploy");
+		}
+		if($project->Name != $params['Project']) {
+			throw new LogicException("Project in URL doesn't match this deploy");
+		}
 
 		return $this->customise(new ArrayData(array(
 			'Deployment' => $deployment,
@@ -818,14 +838,22 @@ 
 		$params = $request->params();
 		$deployment = DNDeployment::get()->byId($params['Identifier']);
 
-		if(!$deployment || !$deployment->ID) throw new SS_HTTPResponse_Exception('Deployment not found', 404);
-		if(!$deployment->canView()) return Security::permissionFailure();
+		if(!$deployment || !$deployment->ID) {
+			throw new SS_HTTPResponse_Exception('Deployment not found', 404);
+		}
+		if(!$deployment->canView()) {
+			return Security::permissionFailure();
+		}
 
 		$environment = $deployment->Environment();
 		$project = $environment->Project();
 
-		if($environment->Name != $params['Environment']) throw new LogicException("Environment in URL doesn't match this deploy");
-		if($project->Name != $params['Project']) throw new LogicException("Project in URL doesn't match this deploy");
+		if($environment->Name != $params['Environment']) {
+			throw new LogicException("Environment in URL doesn't match this deploy");
+		}
+		if($project->Name != $params['Project']) {
+			throw new LogicException("Project in URL doesn't match this deploy");
+		}
 
 		$log = $deployment->log();
 		if($log->exists()) {
@@ -950,13 +978,19 @@ 
 		$params = $request->params();
 		$transfer = DNDataTransfer::get()->byId($params['Identifier']);
 
-		if(!$transfer || !$transfer->ID) throw new SS_HTTPResponse_Exception('Transfer not found', 404);
-		if(!$transfer->canView()) return Security::permissionFailure();
+		if(!$transfer || !$transfer->ID) {
+			throw new SS_HTTPResponse_Exception('Transfer not found', 404);
+		}
+		if(!$transfer->canView()) {
+			return Security::permissionFailure();
+		}
 
 		$environment = $transfer->Environment();
 		$project = $environment->Project();
 
-		if($project->Name != $params['Project']) throw new LogicException("Project in URL doesn't match this deploy");
+		if($project->Name != $params['Project']) {
+			throw new LogicException("Project in URL doesn't match this deploy");
+		}
 
 		return $this->customise(new ArrayData(array(
 			'Transfer' => $transfer,
@@ -973,13 +1007,19 @@ 
 		$params = $request->params();
 		$transfer = DNDataTransfer::get()->byId($params['Identifier']);
 
-		if(!$transfer || !$transfer->ID) throw new SS_HTTPResponse_Exception('Transfer not found', 404);
-		if(!$transfer->canView()) return Security::permissionFailure();
+		if(!$transfer || !$transfer->ID) {
+			throw new SS_HTTPResponse_Exception('Transfer not found', 404);
+		}
+		if(!$transfer->canView()) {
+			return Security::permissionFailure();
+		}
 
 		$environment = $transfer->Environment();
 		$project = $environment->Project();
 
-		if($project->Name != $params['Project']) throw new LogicException("Project in URL doesn't match this deploy");
+		if($project->Name != $params['Project']) {
+			throw new LogicException("Project in URL doesn't match this deploy");
+		}
 
 		$log = $transfer->log();
 		if($log->exists()) {
@@ -1318,7 +1358,9 @@ 
 	 * @return DNEnvironment
 	 */
 	protected function getCurrentEnvironment($project = null) {
-		if(!$project) $project = $this->getCurrentProject();
+		if(!$project) {
+			$project = $this->getCurrentProject();
+		}
 		return $project->DNEnvironmentList()->filter('Name', $this->getRequest()->latestParam('Environment'))->First();
 	}
 
@@ -1333,12 +1375,18 @@ 
 	 * @return boolean true if $member has access to upload or download to at least one {@link DNEnvironment}.
 	 */
 	public function CanViewArchives(Member $member = null) {
-		if(!$member) $member = Member::currentUser();
+		if(!$member) {
+			$member = Member::currentUser();
+		}
 
-		if(Permission::checkMember($member, 'ADMIN')) return true;
+		if(Permission::checkMember($member, 'ADMIN')) {
+			return true;
+		}
 
 		$allProjects = $this->DNProjectList();
-		if(!$allProjects) return false;
+		if(!$allProjects) {
+			return false;
+		}
 
 		foreach($allProjects as $project) {
 			if($project->Environments()) {
@@ -1383,7 +1431,9 @@ 
 		$archives = new ArrayList();
 		foreach($project->DNEnvironmentList() as $env) {
 			foreach($env->DataArchives() as $archive) {
-				if($archive->canView() && $archive->isPending()) $archives->push($archive);
+				if($archive->canView() && $archive->isPending()) {
+					$archives->push($archive);
+				}
 			}
 		}
 		return new PaginatedList($archives->sort("Created", "DESC"), $this->request);

code/control/EmailMessagingService.php

Doc Comments +1 added lines, -1 removed lines

@@ -84,7 +84,7 @@
 	 *
 	 * @param PipelineStep $source Client step
 	 * @param string $from
-	 * @param string|Member $to
+	 * @param string $to
 	 * @param string $subject
 	 * @param string $body
 	 */

Braces +3 added lines, -1 removed lines

@@ -75,7 +75,9 @@
 	 * @param string $body
 	 */
 	protected function sendMessageTo($source, $from, $to, $subject, $body) {
-		if($to instanceof Member) $to = $to->Email;
+		if($to instanceof Member) {
+			$to = $to->Email;
+		}
 		$this->sendViaEmail($source, $from, $to, $subject, $body);
 	}
 

code/model/DNBranch.php

Doc Comments -1 removed lines

@@ -27,7 +27,6 @@
 
 	/**
 	 *
-	 * @param Gitonomy\Git\Commit $commit
 	 * @param DNProject $project
 	 * @param DNData $data
 	 */

Braces +5 added lines, -2 removed lines

@@ -97,8 +97,11 @@
 	 * @return string
 	 */
 	public function IsOpenByDefault() {
-		if($this->Name() == 'master') return " open";
-		else return "";
+		if($this->Name() == 'master') {
+			return " open";
+		} else {
+			return "";
+		}
 	}
 
 }