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()) {

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

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

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

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'];