silverstripe / sspak

src/Executor.php

Doc Comments -3 removed lines

@@ -18,9 +18,6 @@
 
 	/**
 	 * @param string $command The command
-	 * @param boolean $throwException If true, an Exception will be thrown on a nonzero error code
-	 * @param boolean $returnOutput If true, output will be captured
-	 * @param boolean $inputContent Content for STDIN. Otherwise the parent script's STDIN is used
 	 * @return A map containing 'return', 'output', and 'error'
 	 */
 	function execLocal($command, $options = array()) {

Spacing +15 added lines, -15 removed lines

@@ -35,7 +35,7 @@ 
 
 	function createLocal($command, $options) {
 		$options = array_merge($this->defaultOptions, $options);
-		if(is_array($command)) $command = $this->commandArrayToString($command);
+		if (is_array($command)) $command = $this->commandArrayToString($command);
 
 		return new Process($command, $options);
 	}
@@ -53,7 +53,7 @@ 
 	 */
 	function commandArrayToString($command) {
 		$string = escapeshellcmd(array_shift($command));
-		foreach($command as $arg) {
+		foreach ($command as $arg) {
 			$string .= ' ' . escapeshellarg($arg);
 		}
 		return $string;
@@ -80,8 +80,8 @@ 
 		$options = array_merge($this->options, $options);
 
 		// Modify command for remote execution, if necessary.
-		if($this->remoteServer) {
-			if(!empty($options['outputFile']) || !empty($options['outputStream'])) $ssh = "ssh -T ";
+		if ($this->remoteServer) {
+			if (!empty($options['outputFile']) || !empty($options['outputStream'])) $ssh = "ssh -T ";
 			else $ssh = "ssh -t ";
 			$command = $ssh . escapeshellarg($this->remoteServer) . ' ' . escapeshellarg($this->command);
 		} else {
@@ -96,9 +96,9 @@ 
 		);
 
 		// Alternatives
-		if($options['inputContent'] || $options['inputStream']) $pipeSpec[0] = array('pipe', 'r');
+		if ($options['inputContent'] || $options['inputStream']) $pipeSpec[0] = array('pipe', 'r');
 		
-		if($options['outputFile']) {
+		if ($options['outputFile']) {
 			$pipeSpec[1] = array('file',
 				$options['outputFile'], 
 				$options['outputFileAppend'] ? 'a' : 'w');
@@ -106,24 +106,24 @@ 
 
 		$process = proc_open($command, $pipeSpec, $pipes);
 
-		if($options['inputContent']) {
+		if ($options['inputContent']) {
 			fwrite($pipes[0], $options['inputContent']);
 
-		} else if($options['inputStream']) {
-			while($content = fread($options['inputStream'], 8192)) {
+		} else if ($options['inputStream']) {
+			while ($content = fread($options['inputStream'], 8192)) {
 				fwrite($pipes[0], $content);
 			}
 		}
-		if(isset($pipes[0])) fclose($pipes[0]);
+		if (isset($pipes[0])) fclose($pipes[0]);
 	
 		$result = array();
 
-		if(isset($pipes[1])) {
+		if (isset($pipes[1])) {
 			// If a stream was provided, then pipe all the content
 			// Doing it this way rather than passing outputStream to $pipeSpec
 			// Means that streams as well as simple FDs can be used
-			if($options['outputStream']) {
-				while($content = fread($pipes[1], 8192)) {
+			if ($options['outputStream']) {
+				while ($content = fread($pipes[1], 8192)) {
 					fwrite($options['outputStream'], $content);
 				}
 
@@ -133,14 +133,14 @@ 
 			}
 			fclose($pipes[1]);
 		}
-		if(isset($pipes[2])) {
+		if (isset($pipes[2])) {
 			$result['error'] = stream_get_contents($pipes[2]);
 			fclose($pipes[2]);
 		}
 
 		$result['return'] = proc_close($process);
 
-		if($options['throwException'] && $result['return'] != 0)	{
+		if ($options['throwException'] && $result['return'] != 0) {
 			throw new Exception("Command: $command\nExecution failed: returned {$result['return']}.\n"
 				. (empty($result['output']) ? "" : "Output:\n{$result['output']}"));
 		}

Braces +14 added lines, -5 removed lines

@@ -35,7 +35,9 @@ 
 
 	function createLocal($command, $options) {
 		$options = array_merge($this->defaultOptions, $options);
-		if(is_array($command)) $command = $this->commandArrayToString($command);
+		if(is_array($command)) {
+			$command = $this->commandArrayToString($command);
+		}
 
 		return new Process($command, $options);
 	}
@@ -81,8 +83,11 @@ 
 
 		// Modify command for remote execution, if necessary.
 		if($this->remoteServer) {
-			if(!empty($options['outputFile']) || !empty($options['outputStream'])) $ssh = "ssh -T ";
-			else $ssh = "ssh -t ";
+			if(!empty($options['outputFile']) || !empty($options['outputStream'])) {
+				$ssh = "ssh -T ";
+			} else {
+				$ssh = "ssh -t ";
+			}
 			$command = $ssh . escapeshellarg($this->remoteServer) . ' ' . escapeshellarg($this->command);
 		} else {
 			$command = $this->command;
@@ -96,7 +101,9 @@ 
 		);
 
 		// Alternatives
-		if($options['inputContent'] || $options['inputStream']) $pipeSpec[0] = array('pipe', 'r');
+		if($options['inputContent'] || $options['inputStream']) {
+			$pipeSpec[0] = array('pipe', 'r');
+		}
 		
 		if($options['outputFile']) {
 			$pipeSpec[1] = array('file',
@@ -114,7 +121,9 @@ 
 				fwrite($pipes[0], $content);
 			}
 		}
-		if(isset($pipes[0])) fclose($pipes[0]);
+		if(isset($pipes[0])) {
+			fclose($pipes[0]);
+		}
 	
 		$result = array();
 

src/FilesystemEntity.php

Doc Comments +4 added lines, -1 removed lines

@@ -22,6 +22,10 @@ 
 	function isLocal() {
 		return $this->server == null;
 	}
+
+	/**
+	 * @return string|null
+	 */
 	function getPath() {
 		return $this->path;
 	}
@@ -52,7 +56,6 @@ 
 
 	/**
 	 * Upload a file to the given destination on the server
-	 * @param string $file The file to upload
 	 * @param string $dest The remote filename/dir to upload to
 	 */
 	function upload($source, $dest) {

Spacing +11 added lines, -11 removed lines

@@ -11,8 +11,8 @@ 
 	function __construct($path, $executor) {
 		$this->executor = $executor;
 
-		if(strpos($path,':') !== false) {
-			list($this->server,$this->path) = explode(':', $path, 2);
+		if (strpos($path, ':') !== false) {
+			list($this->server, $this->path) = explode(':', $path, 2);
 		} else {
 			$this->server = null;
 			$this->path = $path;
@@ -34,7 +34,7 @@ 
 	 * @param  string $command Shell command, either a fully escaped string or an array
 	 */
 	function exec($command, $options = array()) {
-		if($this->server) $process = $this->executor->createRemote($this->server, $command, $options);
+		if ($this->server) $process = $this->executor->createRemote($this->server, $command, $options);
 		else $process = $this->executor->createLocal($command, $options);
 
 		return $process->exec();
@@ -46,7 +46,7 @@ 
 	 * @return Process
 	 */
 	function createProcess($command, $options = array()) {
-		if($this->server) return $this->executor->createRemote($this->server, $command, $options);
+		if ($this->server) return $this->executor->createRemote($this->server, $command, $options);
 		else return $this->executor->createLocal($command, $options);
 	}
 
@@ -56,7 +56,7 @@ 
 	 * @param string $dest The remote filename/dir to upload to
 	 */
 	function upload($source, $dest) {
-		if($this->server) {
+		if ($this->server) {
 			$this->executor->execLocal(array("scp", $source, "$this->server:$dest"));
 		} else {
 			$this->executor->execLocal(array("cp", $source, $dest));
@@ -78,7 +78,7 @@ 
 	 * @param string $dest The local filename/dir to download to
 	 */
 	function download($source, $dest) {
-		if($this->server) {
+		if ($this->server) {
 			$this->executor->execLocal(array("scp", "$this->server:$source", $dest));
 		} else {
 			$this->executor->execLocal(array("cp", $file, $dest));
@@ -91,10 +91,10 @@ 
 	 * @return boolean
 	 */
 	function exists($file = null) {
-		if(!$file) $file = $this->path;
-		if($file == '@self') return true;
+		if (!$file) $file = $this->path;
+		if ($file == '@self') return true;
 
-		if($this->server) {
+		if ($this->server) {
 			$result = $this->exec("if [ -e " . escapeshellarg($file) . " ]; then echo yes; fi");
 			return (trim($result['output']) == 'yes');
 
@@ -107,7 +107,7 @@ 
 	 * Create the given file with the given content
 	 */
 	function writeFile($file, $content) {
-		if($this->server) {
+		if ($this->server) {
 			$this->exec("echo " . escapeshellarg($content) . " > " . escapeshellarg($file));
 
 		} else {
@@ -121,7 +121,7 @@ 
 	 * @param string $file The file to remove
 	 */
 	function unlink($file) {
-		if(!$file || $file == '/' || $file == '.') throw new Exception("Can't unlink file '$file'");
+		if (!$file || $file == '/' || $file == '.') throw new Exception("Can't unlink file '$file'");
 		$this->exec(array('rm', '-rf', $file));
 		return true;
 	}

Braces +19 added lines, -7 removed lines

@@ -34,8 +34,11 @@ 
 	 * @param  string $command Shell command, either a fully escaped string or an array
 	 */
 	function exec($command, $options = array()) {
-		if($this->server) $process = $this->executor->createRemote($this->server, $command, $options);
-		else $process = $this->executor->createLocal($command, $options);
+		if($this->server) {
+			$process = $this->executor->createRemote($this->server, $command, $options);
+		} else {
+			$process = $this->executor->createLocal($command, $options);
+		}
 
 		return $process->exec();
 	}
@@ -46,8 +49,11 @@ 
 	 * @return Process
 	 */
 	function createProcess($command, $options = array()) {
-		if($this->server) return $this->executor->createRemote($this->server, $command, $options);
-		else return $this->executor->createLocal($command, $options);
+		if($this->server) {
+			return $this->executor->createRemote($this->server, $command, $options);
+		} else {
+			return $this->executor->createLocal($command, $options);
+		}
 	}
 
 	/**
@@ -91,8 +97,12 @@ 
 	 * @return boolean
 	 */
 	function exists($file = null) {
-		if(!$file) $file = $this->path;
-		if($file == '@self') return true;
+		if(!$file) {
+			$file = $this->path;
+		}
+		if($file == '@self') {
+			return true;
+		}
 
 		if($this->server) {
 			$result = $this->exec("if [ -e " . escapeshellarg($file) . " ]; then echo yes; fi");
@@ -121,7 +131,9 @@ 
 	 * @param string $file The file to remove
 	 */
 	function unlink($file) {
-		if(!$file || $file == '/' || $file == '.') throw new Exception("Can't unlink file '$file'");
+		if(!$file || $file == '/' || $file == '.') {
+			throw new Exception("Can't unlink file '$file'");
+		}
 		$this->exec(array('rm', '-rf', $file));
 		return true;
 	}

src/SSPak.php

Doc Comments +10 added lines

@@ -234,6 +234,11 @@ 
 		return true;
 	}
 
+	/**
+	 * @param Webroot $webroot
+	 * @param SSPakFile $sspak
+	 * @param string $filename
+	 */
 	function getassets($webroot, $assetsPath, $sspak, $filename) {
 		$assetsParentArg = escapeshellarg(dirname($assetsPath));
 		$assetsBaseArg = escapeshellarg(basename($assetsPath));
@@ -242,6 +247,11 @@ 
 		$sspak->writeFileFromProcess($filename, $process);
 	}
 
+	/**
+	 * @param Webroot $webroot
+	 * @param SSPakFile $sspak
+	 * @param string $gitRemoteFile
+	 */
 	function getgitremote($webroot, $sspak, $gitRemoteFile) {
 		// Only do anything if we're copying from a git checkout
 		$gitRepo = $webroot->getPath() .'/.git';

Spacing +46 added lines, -46 removed lines

@@ -64,16 +64,16 @@ 
 
 	function help($args) {
 		echo "SSPak: manage SilverStripe .sspak archives.\n\nUsage:\n";
-		foreach($this->getActions() as $action => $info) {
+		foreach ($this->getActions() as $action => $info) {
 			echo "sspak $action";
-			if(!empty($info['unnamedArgs'])) {
-				foreach($info['unnamedArgs'] as $arg) echo " ($arg)";
+			if (!empty($info['unnamedArgs'])) {
+				foreach ($info['unnamedArgs'] as $arg) echo " ($arg)";
 			}
-			if(!empty($info['namedFlags'])) {
-				foreach($info['namedFlags'] as $arg) echo " (--$arg)";
+			if (!empty($info['namedFlags'])) {
+				foreach ($info['namedFlags'] as $arg) echo " (--$arg)";
 			}
-			if(!empty($info['namedArgs'])) {
-				foreach($info['namedArgs'] as $arg) echo " --$arg=\"$arg value\"";
+			if (!empty($info['namedArgs'])) {
+				foreach ($info['namedArgs'] as $arg) echo " --$arg=\"$arg value\"";
 			}
 			echo "\n  {$info['description']}\n\n";
 		}
@@ -97,13 +97,13 @@ 
 
 		$filesystem = new FilesystemEntity(null, $executor);
 
-		if($pakParts['db']) {
+		if ($pakParts['db']) {
 			$dbPath = escapeshellarg($namedArgs['db']);
 			$process = $filesystem->createProcess("cat $dbPath | gzip -c");
 			$sspak->writeFileFromProcess('database.sql.gz', $process);
 		}
 
-		if($pakParts['assets']) {
+		if ($pakParts['assets']) {
 			$assetsParentArg = escapeshellarg(dirname($namedArgs['assets']));
 			$assetsBaseArg = escapeshellarg(basename($namedArgs['assets']));
 			$process = $filesystem->createProcess("cd $assetsParentArg && tar cfh - $assetsBaseArg | gzip -c");
@@ -126,7 +126,7 @@ 
 		$sspak = new SSPakFile($file, $executor);
 
 		// Validation
-		if(!$sspak->exists()) throw new Exception("File '$file' doesn't exist.");
+		if (!$sspak->exists()) throw new Exception("File '$file' doesn't exist.");
 
 		$phar = $sspak->getPhar();
 		$phar->extractTo($dest);
@@ -145,12 +145,12 @@ 
 
 		$webroot = new Webroot($unnamedArgs[0], $executor);
 		$file = $unnamedArgs[1];
-		if(file_exists($file)) throw new Exception( "File '$file' already exists.");
+		if (file_exists($file)) throw new Exception("File '$file' already exists.");
 
 		$sspak = new SSPakFile($file, $executor);
 
-		if(!empty($namedArgs['from-sudo'])) $webroot->setSudo($namedArgs['from-sudo']);
-		else if(!empty($namedArgs['sudo'])) $webroot->setSudo($namedArgs['sudo']);
+		if (!empty($namedArgs['from-sudo'])) $webroot->setSudo($namedArgs['from-sudo']);
+		else if (!empty($namedArgs['sudo'])) $webroot->setSudo($namedArgs['sudo']);
 
 		// Look up which parts of the sspak are going to be saved
 		$pakParts = $args->pakParts();
@@ -159,7 +159,7 @@ 
 		$details = $webroot->sniff();
 
 		// Create a build folder for the sspak file
-		$buildFolder = "/tmp/sspak-" . rand(100000,999999);
+		$buildFolder = "/tmp/sspak-" . rand(100000, 999999);
 		$webroot->exec(array('mkdir', $buildFolder));
 
 		$dbFile = "$buildFolder/database.sql.gz";
@@ -170,22 +170,22 @@ 
 		$fileList = array();
 
 		// Save DB
-		if($pakParts['db']) {
+		if ($pakParts['db']) {
 			// Check the database type
-			$dbFunction = 'getdb_'.$details['db_type'];
-			if(!method_exists($this,$dbFunction)) {
+			$dbFunction = 'getdb_' . $details['db_type'];
+			if (!method_exists($this, $dbFunction)) {
 				throw new Exception("Can't process database type '" . $details['db_type'] . "'");
 			}
 			$this->$dbFunction($webroot, $details, $sspak, basename($dbFile));
 		}
 
 		// Save Assets
-		if($pakParts['assets']) {
+		if ($pakParts['assets']) {
 			$this->getassets($webroot, $details['assets_path'], $sspak, basename($assetsFile));
 		}
 
 		// Save git-remote
-		if($pakParts['git-remote']) {
+		if ($pakParts['git-remote']) {
 			$this->getgitremote($webroot, $sspak, basename($gitRemoteFile));
 		}
 
@@ -198,20 +198,20 @@ 
 	}
 
 	function getdb_MySQLDatabase($webroot, $conf, $sspak, $filename) {
-		$usernameArg = escapeshellarg("--user=".$conf['db_username']);
-		$passwordArg = escapeshellarg("--password=".$conf['db_password']);
+		$usernameArg = escapeshellarg("--user=" . $conf['db_username']);
+		$passwordArg = escapeshellarg("--password=" . $conf['db_password']);
 		$databaseArg = escapeshellarg($conf['db_database']);
 
 		$hostArg = '';
 		$portArg = '';
 		if (!empty($conf['db_server']) && $conf['db_server'] != 'localhost') {
-			if (strpos($conf['db_server'], ':')!==false) {
+			if (strpos($conf['db_server'], ':') !== false) {
 				// Handle "server:port" format.
 				$server = explode(':', $conf['db_server'], 2);
-				$hostArg = escapeshellarg("--host=".$server[0]);
-				$portArg = escapeshellarg("--port=".$server[1]);
+				$hostArg = escapeshellarg("--host=" . $server[0]);
+				$portArg = escapeshellarg("--port=" . $server[1]);
 			} else {
-				$hostArg = escapeshellarg("--host=".$conf['db_server']);
+				$hostArg = escapeshellarg("--host=" . $conf['db_server']);
 			}
 		}
 
@@ -223,10 +223,10 @@ 
 	}
 
 	function getdb_PostgreSQLDatabase($webroot, $conf, $sspak, $filename) {
-		$usernameArg = escapeshellarg("--username=".$conf['db_username']);
-		$passwordArg = "PGPASSWORD=".escapeshellarg($conf['db_password']);
+		$usernameArg = escapeshellarg("--username=" . $conf['db_username']);
+		$passwordArg = "PGPASSWORD=" . escapeshellarg($conf['db_password']);
 		$databaseArg = escapeshellarg($conf['db_database']);
-		$hostArg = escapeshellarg("--host=".$conf['db_server']);
+		$hostArg = escapeshellarg("--host=" . $conf['db_server']);
 		$filenameArg = escapeshellarg($filename);
 
 		$process = $webroot->createProcess("$passwordArg pg_dump --clean --no-owner --no-tablespaces $usernameArg $hostArg $databaseArg | gzip -c");
@@ -244,16 +244,16 @@ 
 
 	function getgitremote($webroot, $sspak, $gitRemoteFile) {
 		// Only do anything if we're copying from a git checkout
-		$gitRepo = $webroot->getPath() .'/.git';
-		if($webroot->exists($gitRepo)) {
+		$gitRepo = $webroot->getPath() . '/.git';
+		if ($webroot->exists($gitRepo)) {
 			// Identify current branch
-			$output = $webroot->exec(array('git', '--git-dir='.$gitRepo, 'branch'));
-			if(preg_match("/\* ([^ \n]*)/", $output['output'], $matches) && strpos("(no branch)", $matches[1])===false) {
+			$output = $webroot->exec(array('git', '--git-dir=' . $gitRepo, 'branch'));
+			if (preg_match("/\* ([^ \n]*)/", $output['output'], $matches) && strpos("(no branch)", $matches[1]) === false) {
 				// If there is a current branch, use that branch's remove
 				$currentBranch = trim($matches[1]);
-				$output = $webroot->exec(array('git', '--git-dir='.$gitRepo, 'config','--get',"branch.$currentBranch.remote"));
+				$output = $webroot->exec(array('git', '--git-dir=' . $gitRepo, 'config', '--get', "branch.$currentBranch.remote"));
 				$remoteName = trim($output['output']);
-				if(!$remoteName) $remoteName = 'origin';
+				if (!$remoteName) $remoteName = 'origin';
 
 			// Default to origin
 			} else {
@@ -262,11 +262,11 @@ 
 			}
 
 			// Determine the URL of that remote
-			$output = $webroot->exec(array('git', '--git-dir='.$gitRepo, 'config','--get',"remote.$remoteName.url"));
+			$output = $webroot->exec(array('git', '--git-dir=' . $gitRepo, 'config', '--get', "remote.$remoteName.url"));
 			$remoteURL = trim($output['output']);
 
 			// Determine the current SHA
-			$output = $webroot->exec(array('git', '--git-dir='.$gitRepo, 'log','-1','--format=%H'));
+			$output = $webroot->exec(array('git', '--git-dir=' . $gitRepo, 'log', '-1', '--format=%H'));
 			$sha = trim($output['output']);
 
 			$content = "remote = $remoteURL\nbranch = $currentBranch\nsha = $sha\n";
@@ -294,16 +294,16 @@ 
 		$pakParts = $args->pakParts();
 
 		// Validation
-		if(!$sspak->exists()) throw new Exception( "File '$file' doesn't exist.");
+		if (!$sspak->exists()) throw new Exception("File '$file' doesn't exist.");
 
 		// Push database, if necessary
 		$namedArgs = $args->getNamedArgs();
-		if($pakParts['db'] && $sspak->contains('database.sql.gz')) {
+		if ($pakParts['db'] && $sspak->contains('database.sql.gz')) {
 			$webroot->putdb($sspak, isset($namedArgs['drop-db']));
 		}
 
 		// Push assets, if neccessary
-		if($pakParts['assets'] && $sspak->contains('assets.tar.gz')) {
+		if ($pakParts['assets'] && $sspak->contains('assets.tar.gz')) {
 			$webroot->putassets($sspak);
 		}
 	}
@@ -325,13 +325,13 @@ 
 		$pakParts = $args->pakParts();
 
 		// Validation
-		if($webroot->exists($webroot->getPath())) throw new Exception( "Webroot '$webrootDir' already exists.");
-		if(!$sspak->exists()) throw new Exception( "File '$file' doesn't exist.");
+		if ($webroot->exists($webroot->getPath())) throw new Exception("Webroot '$webrootDir' already exists.");
+		if (!$sspak->exists()) throw new Exception("File '$file' doesn't exist.");
 
 		// Create new dir
 		$webroot->exec(array('mkdir', $webroot->getPath()));
 
-		if($sspak->contains('git-remote')) {
+		if ($sspak->contains('git-remote')) {
 			$details = $sspak->gitRemoteDetails();
 			$webroot->putgit($details);
 		}
@@ -340,12 +340,12 @@ 
 		
 		// Push database, if necessary
 		$namedArgs = $args->getNamedArgs();
-		if($pakParts['db'] && $sspak->contains('database.sql.gz')) {
+		if ($pakParts['db'] && $sspak->contains('database.sql.gz')) {
 			$webroot->putdb($sspak, isset($namedArgs['drop-db']));
 		}
 
 		// Push assets, if neccessary
-		if($pakParts['assets'] && $sspak->contains('assets.tar.gz')) {
+		if ($pakParts['assets'] && $sspak->contains('assets.tar.gz')) {
 			$webroot->putassets($sspak);
 		}
 	}
@@ -366,7 +366,7 @@ 
 
 		$sspakScript = file_get_contents($_SERVER['argv'][0]);
 		// Broken up to not get detected by our sed command
-		$sspakScript .= "\n__halt_compiler();\n"."//"." TAR START?>\n";
+		$sspakScript .= "\n__halt_compiler();\n" . "//" . " TAR START?>\n";
 
 		// Mark as self-extracting
 		$sspakScript = str_replace('$isSelfExtracting = false;', '$isSelfExtracting = true;', $sspakScript);
@@ -375,7 +375,7 @@ 
 		$snifferFile = dirname(__FILE__) . '/sspak-sniffer.php';
 		$sspakScript = str_replace("\$snifferFileContent = '';\n",
 			"\$snifferFileContent = '" 
-			. str_replace(array("\\","'"),array("\\\\", "\\'"), file_get_contents($snifferFile)) . "';\n", $sspakScript);
+			. str_replace(array("\\", "'"), array("\\\\", "\\'"), file_get_contents($snifferFile)) . "';\n", $sspakScript);
 
 		file_put_contents($destFile, $sspakScript);
 		chmod($destFile, 0775);

Braces +32 added lines, -11 removed lines

@@ -67,13 +67,19 @@ 
 		foreach($this->getActions() as $action => $info) {
 			echo "sspak $action";
 			if(!empty($info['unnamedArgs'])) {
-				foreach($info['unnamedArgs'] as $arg) echo " ($arg)";
+				foreach($info['unnamedArgs'] as $arg) {
+					echo " ($arg)";
+				}
 			}
 			if(!empty($info['namedFlags'])) {
-				foreach($info['namedFlags'] as $arg) echo " (--$arg)";
+				foreach($info['namedFlags'] as $arg) {
+					echo " (--$arg)";
+				}
 			}
 			if(!empty($info['namedArgs'])) {
-				foreach($info['namedArgs'] as $arg) echo " --$arg=\"$arg value\"";
+				foreach($info['namedArgs'] as $arg) {
+					echo " --$arg=\"$arg value\"";
+				}
 			}
 			echo "\n  {$info['description']}\n\n";
 		}
@@ -126,7 +132,9 @@ 
 		$sspak = new SSPakFile($file, $executor);
 
 		// Validation
-		if(!$sspak->exists()) throw new Exception("File '$file' doesn't exist.");
+		if(!$sspak->exists()) {
+			throw new Exception("File '$file' doesn't exist.");
+		}
 
 		$phar = $sspak->getPhar();
 		$phar->extractTo($dest);
@@ -145,12 +153,17 @@ 
 
 		$webroot = new Webroot($unnamedArgs[0], $executor);
 		$file = $unnamedArgs[1];
-		if(file_exists($file)) throw new Exception( "File '$file' already exists.");
+		if(file_exists($file)) {
+			throw new Exception( "File '$file' already exists.");
+		}
 
 		$sspak = new SSPakFile($file, $executor);
 
-		if(!empty($namedArgs['from-sudo'])) $webroot->setSudo($namedArgs['from-sudo']);
-		else if(!empty($namedArgs['sudo'])) $webroot->setSudo($namedArgs['sudo']);
+		if(!empty($namedArgs['from-sudo'])) {
+			$webroot->setSudo($namedArgs['from-sudo']);
+		} else if(!empty($namedArgs['sudo'])) {
+			$webroot->setSudo($namedArgs['sudo']);
+		}
 
 		// Look up which parts of the sspak are going to be saved
 		$pakParts = $args->pakParts();
@@ -253,7 +266,9 @@ 
 				$currentBranch = trim($matches[1]);
 				$output = $webroot->exec(array('git', '--git-dir='.$gitRepo, 'config','--get',"branch.$currentBranch.remote"));
 				$remoteName = trim($output['output']);
-				if(!$remoteName) $remoteName = 'origin';
+				if(!$remoteName) {
+					$remoteName = 'origin';
+				}
 
 			// Default to origin
 			} else {
@@ -294,7 +309,9 @@ 
 		$pakParts = $args->pakParts();
 
 		// Validation
-		if(!$sspak->exists()) throw new Exception( "File '$file' doesn't exist.");
+		if(!$sspak->exists()) {
+			throw new Exception( "File '$file' doesn't exist.");
+		}
 
 		// Push database, if necessary
 		$namedArgs = $args->getNamedArgs();
@@ -325,8 +342,12 @@ 
 		$pakParts = $args->pakParts();
 
 		// Validation
-		if($webroot->exists($webroot->getPath())) throw new Exception( "Webroot '$webrootDir' already exists.");
-		if(!$sspak->exists()) throw new Exception( "File '$file' doesn't exist.");
+		if($webroot->exists($webroot->getPath())) {
+			throw new Exception( "Webroot '$webrootDir' already exists.");
+		}
+		if(!$sspak->exists()) {
+			throw new Exception( "File '$file' doesn't exist.");
+		}
 
 		// Create new dir
 		$webroot->exec(array('mkdir', $webroot->getPath()));

src/SSPakFile.php

Doc Comments +6 added lines, -2 removed lines

@@ -6,6 +6,9 @@ 
 	protected $pharAlias;
 	protected $pharPath;
 
+	/**
+	 * @param Executor $executor
+	 */
 	function __construct($path, $executor, $pharAlias = 'sspak.phar') {
 		parent::__construct($path, $executor);
 		if(!$this->isLocal()) throw new LogicException("Can't manipulate remote .sspak.phar files, only remote webroots.");
@@ -73,6 +76,7 @@ 
 
 	/**
 	 * Returns the content of a file from this sspak
+	 * @param string $file
 	 */
 	function content($file) {
 		return file_get_contents($this->phar[$file]);
@@ -105,7 +109,7 @@ 
 	/**
 	 * Return a writeable stream corresponding to the given file within the .sspak
 	 * @param  string $filename The name of the file within the .sspak
-	 * @return Stream context
+	 * @return resource context
 	 */
 	function writeStreamForFile($filename) {
 		return fopen('phar://' . $this->pharAlias . '/' . $filename, 'w');
@@ -114,7 +118,7 @@ 
 	/**
 	 * Return a readable stream corresponding to the given file within the .sspak
 	 * @param  string $filename The name of the file within the .sspak
-	 * @return Stream context
+	 * @return resource context
 	 */
 	function readStreamForFile($filename) {
 		// Note: using pharAlias here doesn't work on Debian Wheezy (nor on Windows for that matter).

Spacing +12 added lines, -12 removed lines

@@ -8,16 +8,16 @@ 
 
 	function __construct($path, $executor, $pharAlias = 'sspak.phar') {
 		parent::__construct($path, $executor);
-		if(!$this->isLocal()) throw new LogicException("Can't manipulate remote .sspak.phar files, only remote webroots.");
+		if (!$this->isLocal()) throw new LogicException("Can't manipulate remote .sspak.phar files, only remote webroots.");
 
 		$this->pharAlias = $pharAlias;
 		$this->pharPath = $path;
 		
 		// Executable Phar version
-		if(substr($path,-5) === '.phar') {
+		if (substr($path, -5) === '.phar') {
 			$this->phar = new Phar($path, FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::KEY_AS_FILENAME,
 				$this->pharAlias);
-			if(!file_exists($this->path)) $this->makeExecutable();
+			if (!file_exists($this->path)) $this->makeExecutable();
 
 		// Non-executable Tar version
 		} else {
@@ -34,7 +34,7 @@ 
 	 * Add the SSPak executable information into this SSPak file
 	 */
 	function makeExecutable() {
-		if(ini_get('phar.readonly')) {
+		if (ini_get('phar.readonly')) {
 			throw new Exception("Please set phar.readonly to false in your php.ini.");
 		}
 
@@ -44,9 +44,9 @@ 
 		// Add the bin file, but strip of the #! exec header.
 		$this->phar['bin/sspak'] = preg_replace("/^#!\/usr\/bin\/env php\n/", '', file_get_contents($root . "bin/sspak"));
 
-		foreach(scandir($srcRoot) as $file) {
-			if($file[0] == '.') continue;
-			$this->phar['src/'.$file] = file_get_contents($srcRoot . $file);
+		foreach (scandir($srcRoot) as $file) {
+			if ($file[0] == '.') continue;
+			$this->phar['src/' . $file] = file_get_contents($srcRoot . $file);
 		}
 
 		$stub = <<<STUB
@@ -88,8 +88,8 @@ 
 		// Non-executable Phars can't have content streamed into them
 		// This means that we need to create a temp file, which is a pain, if that file happens to be a 3GB
 		// asset dump. :-/
-		if($this->phar instanceof PharData) {
-			$tmpFile = '/tmp/sspak-content-' .rand(100000,999999);
+		if ($this->phar instanceof PharData) {
+			$tmpFile = '/tmp/sspak-content-' . rand(100000, 999999);
 			$process->exec(array('outputFile' => $tmpFile));
 			$this->phar->addFile($tmpFile, $filename);
 			unlink($tmpFile);
@@ -138,10 +138,10 @@ 
 	function gitRemoteDetails() {
 		$content = $this->content('git-remote');
 		$details = array();
-		foreach(explode("\n", trim($content)) as $line) {
-			if(!$line) continue;
+		foreach (explode("\n", trim($content)) as $line) {
+			if (!$line) continue;
 
-			if(preg_match('/^([^ ]+) *= *(.*)$/', $line, $matches)) {
+			if (preg_match('/^([^ ]+) *= *(.*)$/', $line, $matches)) {
 				$details[$matches[1]] = $matches[2];
 			} else {
 				throw new Exception("Bad line '$line'");

Braces +12 added lines, -4 removed lines

@@ -8,7 +8,9 @@ 
 
 	function __construct($path, $executor, $pharAlias = 'sspak.phar') {
 		parent::__construct($path, $executor);
-		if(!$this->isLocal()) throw new LogicException("Can't manipulate remote .sspak.phar files, only remote webroots.");
+		if(!$this->isLocal()) {
+			throw new LogicException("Can't manipulate remote .sspak.phar files, only remote webroots.");
+		}
 
 		$this->pharAlias = $pharAlias;
 		$this->pharPath = $path;
@@ -17,7 +19,9 @@ 
 		if(substr($path,-5) === '.phar') {
 			$this->phar = new Phar($path, FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::KEY_AS_FILENAME,
 				$this->pharAlias);
-			if(!file_exists($this->path)) $this->makeExecutable();
+			if(!file_exists($this->path)) {
+				$this->makeExecutable();
+			}
 
 		// Non-executable Tar version
 		} else {
@@ -45,7 +49,9 @@ 
 		$this->phar['bin/sspak'] = preg_replace("/^#!\/usr\/bin\/env php\n/", '', file_get_contents($root . "bin/sspak"));
 
 		foreach(scandir($srcRoot) as $file) {
-			if($file[0] == '.') continue;
+			if($file[0] == '.') {
+				continue;
+			}
 			$this->phar['src/'.$file] = file_get_contents($srcRoot . $file);
 		}
 
@@ -139,7 +145,9 @@ 
 		$content = $this->content('git-remote');
 		$details = array();
 		foreach(explode("\n", trim($content)) as $line) {
-			if(!$line) continue;
+			if(!$line) {
+				continue;
+			}
 
 			if(preg_match('/^([^ ]+) *= *(.*)$/', $line, $matches)) {
 				$details[$matches[1]] = $matches[2];

src/Webroot.php

Doc Comments +4 added lines, -2 removed lines

@@ -66,9 +66,8 @@ 
 
 	/**
 	 * Put the database from the given sspak file into this webroot.
-	 * @param array $details The previously sniffed details of this webroot
 	 * @param bool $dropdb Drop the DB prior to install
-	 * @param string $sspakFile Filename
+	 * @param SSPakFile $sspak Filename
 	 */
 	function putdb($sspak, $dropdb) {
 		$details = $this->details();
@@ -131,6 +130,9 @@ 
 		fclose($stream);
 	}
 
+	/**
+	 * @param SSPakFile $sspak
+	 */
 	function putassets($sspak) {
 		$details = $this->details();
 		$assetsPath = $details['assets_path'];

Spacing +22 added lines, -22 removed lines

@@ -16,7 +16,7 @@ 
 	 * Calls sniff once and then caches
 	 */
 	function details() {
-		if(!$this->details) $this->details = $this->sniff();
+		if (!$this->details) $this->details = $this->sniff();
 		return $this->details;
 	}
 
@@ -26,16 +26,16 @@ 
 	function sniff() {
 		global $snifferFileContent;
 
-		if(!$snifferFileContent) $snifferFileContent = file_get_contents(PACKAGE_ROOT . 'src/sspak-sniffer.php');
+		if (!$snifferFileContent) $snifferFileContent = file_get_contents(PACKAGE_ROOT . 'src/sspak-sniffer.php');
 
-		$remoteSniffer = '/tmp/sspak-sniffer-' . rand(100000,999999) . '.php';
+		$remoteSniffer = '/tmp/sspak-sniffer-' . rand(100000, 999999) . '.php';
 		$this->uploadContent($snifferFileContent, $remoteSniffer);
 
 		$result = $this->execSudo(array('/usr/bin/env', 'php', $remoteSniffer, $this->path));
 		$this->unlink($remoteSniffer);
 
 		$parsed = @unserialize($result['output']);
-		if(!$parsed) throw new Exception("Could not parse sspak-sniffer content:\n{$result['output']}\n");
+		if (!$parsed) throw new Exception("Could not parse sspak-sniffer content:\n{$result['output']}\n");
 		return $parsed;
 	}
 
@@ -44,16 +44,16 @@ 
 	 * @param  string $command Shell command, either a fully escaped string or an array
 	 */
 	function execSudo($command) {
-		if($this->sudo) {
-			if(is_array($command)) $command = $this->executor->commandArrayToString($command);
+		if ($this->sudo) {
+			if (is_array($command)) $command = $this->executor->commandArrayToString($command);
 			// Try running sudo without asking for a password
 			try {
 				return $this->exec("sudo -n -u " . escapeshellarg($this->sudo) . " " . $command);
 
 			// Otherwise capture SUDO password ourselves and pass it in through STDIN
-			} catch(Exception $e) {
+			} catch (Exception $e) {
 				echo "[sspak sudo] Enter your password: ";
-				$stdin = fopen( 'php://stdin', 'r');
+				$stdin = fopen('php://stdin', 'r');
 				$password = fgets($stdin);
 
 				return $this->exec("sudo -S -p '' -u " . escapeshellarg($this->sudo) . " " . $command, array('inputContent' => $password));
@@ -74,8 +74,8 @@ 
 		$details = $this->details();
 
 		// Check the database type
-		$dbFunction = 'putdb_'.$details['db_type'];
-		if(!method_exists($this,$dbFunction)) {
+		$dbFunction = 'putdb_' . $details['db_type'];
+		if (!method_exists($this, $dbFunction)) {
 			throw new Exception("Can't process database type '" . $details['db_type'] . "'");
 		}
 
@@ -84,24 +84,24 @@ 
 	}
 
 	function putdb_MySQLDatabase($conf, $sspak, $dropdb) {
-		$usernameArg = escapeshellarg("--user=".$conf['db_username']);
-		$passwordArg = escapeshellarg("--password=".$conf['db_password']);
+		$usernameArg = escapeshellarg("--user=" . $conf['db_username']);
+		$passwordArg = escapeshellarg("--password=" . $conf['db_password']);
 		$databaseArg = escapeshellarg($conf['db_database']);
 
 		$hostArg = '';
 		$portArg = '';
 		if (!empty($conf['db_server']) && $conf['db_server'] != 'localhost') {
-			if (strpos($conf['db_server'], ':')!==false) {
+			if (strpos($conf['db_server'], ':') !== false) {
 				// Handle "server:port" format.
 				$server = explode(':', $conf['db_server'], 2);
-				$hostArg = escapeshellarg("--host=".$server[0]);
-				$portArg = escapeshellarg("--port=".$server[1]);
+				$hostArg = escapeshellarg("--host=" . $server[0]);
+				$portArg = escapeshellarg("--port=" . $server[1]);
 			} else {
-				$hostArg = escapeshellarg("--host=".$conf['db_server']);
+				$hostArg = escapeshellarg("--host=" . $conf['db_server']);
 			}
 		}
 		$dbCommand = "create database if not exists `" . addslashes($conf['db_database']) . "`";
-		if($dropdb) {
+		if ($dropdb) {
 			$dbCommand = "drop database if exists `" . addslashes($conf['db_database']) . "`; " . $dbCommand;
 		}
 
@@ -115,14 +115,14 @@ 
 
 	function putdb_PostgreSQLDatabase($conf, $sspak, $dropdb) {
 		// TODO: Support dropdb for postgresql
-		$usernameArg = escapeshellarg("--username=".$conf['db_username']);
-		$passwordArg = "PGPASSWORD=".escapeshellarg($conf['db_password']);
+		$usernameArg = escapeshellarg("--username=" . $conf['db_username']);
+		$passwordArg = "PGPASSWORD=" . escapeshellarg($conf['db_password']);
 		$databaseArg = escapeshellarg($conf['db_database']);
-		$hostArg = escapeshellarg("--host=".$conf['db_server']);
+		$hostArg = escapeshellarg("--host=" . $conf['db_server']);
 
 		// Create database if needed
 		$result = $this->exec("echo \"select count(*) from pg_catalog.pg_database where datname = $databaseArg\" | $passwordArg psql $usernameArg $hostArg $databaseArg -qt");
-		if(trim($result['output']) == '0') {
+		if (trim($result['output']) == '0') {
 			$this->exec("$passwordArg createdb $usernameArg $hostArg $databaseArg");
 		}
 
@@ -137,7 +137,7 @@ 
 
 		$assetsParentArg = escapeshellarg(dirname($assetsPath));
 		$assetsBaseArg = escapeshellarg(basename($assetsPath));
-		$assetsBaseOldArg = escapeshellarg(basename($assetsPath).'.old');
+		$assetsBaseOldArg = escapeshellarg(basename($assetsPath) . '.old');
 
 		// Move existing assets to assets.old
 		$this->exec("if [ -d $assetsBaseArg ]; then mv $assetsBaseArg $assetsBaseOldArg; fi");

Braces +12 added lines, -4 removed lines

@@ -16,7 +16,9 @@ 
 	 * Calls sniff once and then caches
 	 */
 	function details() {
-		if(!$this->details) $this->details = $this->sniff();
+		if(!$this->details) {
+			$this->details = $this->sniff();
+		}
 		return $this->details;
 	}
 
@@ -26,7 +28,9 @@ 
 	function sniff() {
 		global $snifferFileContent;
 
-		if(!$snifferFileContent) $snifferFileContent = file_get_contents(PACKAGE_ROOT . 'src/sspak-sniffer.php');
+		if(!$snifferFileContent) {
+			$snifferFileContent = file_get_contents(PACKAGE_ROOT . 'src/sspak-sniffer.php');
+		}
 
 		$remoteSniffer = '/tmp/sspak-sniffer-' . rand(100000,999999) . '.php';
 		$this->uploadContent($snifferFileContent, $remoteSniffer);
@@ -35,7 +39,9 @@ 
 		$this->unlink($remoteSniffer);
 
 		$parsed = @unserialize($result['output']);
-		if(!$parsed) throw new Exception("Could not parse sspak-sniffer content:\n{$result['output']}\n");
+		if(!$parsed) {
+			throw new Exception("Could not parse sspak-sniffer content:\n{$result['output']}\n");
+		}
 		return $parsed;
 	}
 
@@ -45,7 +51,9 @@ 
 	 */
 	function execSudo($command) {
 		if($this->sudo) {
-			if(is_array($command)) $command = $this->executor->commandArrayToString($command);
+			if(is_array($command)) {
+				$command = $this->executor->commandArrayToString($command);
+			}
 			// Try running sudo without asking for a password
 			try {
 				return $this->exec("sudo -n -u " . escapeshellarg($this->sudo) . " " . $command);

src/sspak-sniffer.php

Spacing +7 added lines, -7 removed lines

@@ -7,13 +7,13 @@ 
  */
 
 // Argument parsing
-if(empty($_SERVER['argv'][1])) {
+if (empty($_SERVER['argv'][1])) {
 	echo "Usage: {$_SERVER['argv'][0]} (site-docroot)\n";
 	exit(1);
 }
 
 $basePath = $_SERVER['argv'][1];
-if($basePath[0] != '/') $basePath = getcwd() . '/' . $basePath;
+if ($basePath[0] != '/') $basePath = getcwd() . '/' . $basePath;
 
 // SilverStripe bootstrap
 define('BASE_PATH', $basePath);
@@ -21,17 +21,17 @@ 
 $_SERVER['HTTP_HOST'] = 'localhost';
 chdir(BASE_PATH);
 
-if(file_exists(BASE_PATH.'/framework/core/Core.php')) {
-	require_once(BASE_PATH. '/framework/core/Core.php');
-} else if(file_exists(BASE_PATH.'/sapphire/core/Core.php')) {
-	require_once(BASE_PATH. '/sapphire/core/Core.php');
+if (file_exists(BASE_PATH . '/framework/core/Core.php')) {
+	require_once(BASE_PATH . '/framework/core/Core.php');
+} else if (file_exists(BASE_PATH . '/sapphire/core/Core.php')) {
+	require_once(BASE_PATH . '/sapphire/core/Core.php');
 } else {
 	echo "No framework/core/Core.php or sapphire/core/Core.php included in project.  Perhaps " . BASE_PATH . " is not a SilverStripe project?\n";
 	exit(2);
 }
 
 $output = array();
-foreach($databaseConfig as $k => $v) {
+foreach ($databaseConfig as $k => $v) {
 	$output['db_' . $k] = $v;
 }
 $output['assets_path'] = ASSETS_PATH;

Braces +3 added lines, -1 removed lines

@@ -13,7 +13,9 @@
 }
 
 $basePath = $_SERVER['argv'][1];
-if($basePath[0] != '/') $basePath = getcwd() . '/' . $basePath;
+if($basePath[0] != '/') {
+	$basePath = getcwd() . '/' . $basePath;
+}
 
 // SilverStripe bootstrap
 define('BASE_PATH', $basePath);

src/Args.php

Spacing +8 added lines, -8 removed lines

@@ -11,10 +11,10 @@ 
 	function __construct($args) {
 		array_shift($args);
 
-		foreach($args as $arg) {
-			if(preg_match('/^--([^=]+)=(.*)$/', $arg, $matches)) {
+		foreach ($args as $arg) {
+			if (preg_match('/^--([^=]+)=(.*)$/', $arg, $matches)) {
 				$this->namedArgs[$matches[1]] = $matches[2];
-			} else if(preg_match('/^--([^=]+)$/', $arg, $matches)) {
+			} else if (preg_match('/^--([^=]+)$/', $arg, $matches)) {
 				$this->namedArgs[$matches[1]] = true;
 			} else {
 				$this->unnamedArgs[] = $arg;
@@ -51,8 +51,8 @@ 
 	 * Return the sudo argument, preferring a more specific one with the given optional prefix
 	 */
 	function sudo($optionalPrefix) {
-		if(!empty($this->namedArgs[$optionalPrefix . '-sudo'])) return $this->namedArgs[$optionalPrefix . '-sudo'];
-		else if(!empty($this->namedArgs['sudo'])) return $this->namedArgs['sudo'];
+		if (!empty($this->namedArgs[$optionalPrefix . '-sudo'])) return $this->namedArgs[$optionalPrefix . '-sudo'];
+		else if (!empty($this->namedArgs['sudo'])) return $this->namedArgs['sudo'];
 		else return null;
 	}
 
@@ -62,17 +62,17 @@ 
 	function pakParts() {
 		// Look up which parts of the sspak are going to be saved
 		$pakParks = array();
-		foreach(array('assets','db','git-remote') as $part) {
+		foreach (array('assets', 'db', 'git-remote') as $part) {
 			$pakParts[$part] = !empty($this->namedArgs[$part]);
 		}
 
 		// Default to db and assets
-		if(!array_filter($pakParts)) $pakParts = array('db' => true, 'assets' => true, 'git-remote' => true);
+		if (!array_filter($pakParts)) $pakParts = array('db' => true, 'assets' => true, 'git-remote' => true);
 		return $pakParts;
 	}
 
 	function requireUnnamed($items) {
-		if(sizeof($this->unnamedArgs) < sizeof($items)) {
+		if (sizeof($this->unnamedArgs) < sizeof($items)) {
 			echo "Usage: {$_SERVER['argv'][0]} " . $this->action . " (";
 			echo implode(") (", $items);
 			echo ")\n";

Braces +10 added lines, -4 removed lines

@@ -51,9 +51,13 @@ 
 	 * Return the sudo argument, preferring a more specific one with the given optional prefix
 	 */
 	function sudo($optionalPrefix) {
-		if(!empty($this->namedArgs[$optionalPrefix . '-sudo'])) return $this->namedArgs[$optionalPrefix . '-sudo'];
-		else if(!empty($this->namedArgs['sudo'])) return $this->namedArgs['sudo'];
-		else return null;
+		if(!empty($this->namedArgs[$optionalPrefix . '-sudo'])) {
+			return $this->namedArgs[$optionalPrefix . '-sudo'];
+		} else if(!empty($this->namedArgs['sudo'])) {
+			return $this->namedArgs['sudo'];
+		} else {
+			return null;
+		}
 	}
 
 	/**
@@ -67,7 +71,9 @@ 
 		}
 
 		// Default to db and assets
-		if(!array_filter($pakParts)) $pakParts = array('db' => true, 'assets' => true, 'git-remote' => true);
+		if(!array_filter($pakParts)) {
+			$pakParts = array('db' => true, 'assets' => true, 'git-remote' => true);
+		}
 		return $pakParts;
 	}