owncloud / files_paperhive

controller/paperhivecontroller.php

Doc Comments +2 added lines, -3 removed lines

@@ -121,7 +121,7 @@ 
 	 *	 *
 	 * @param string $dir
 	 * @param string $filename
-	 * @return string/boolean - returns PaperHive ID or false in case of error
+	 * @return string - returns PaperHive ID or false in case of error
 	 */
 	private function loadPaperHiveIdFromFile($dir, $filename) {
 		$path = $dir . '/' . $filename;
@@ -228,7 +228,7 @@ 
 	 * @NoAdminRequired
 	 *
 	 * @param string $bookID
-	 * @return string/boolean
+	 * @return string
 	 */
 	private function fetchDocument($bookID) {
 		$urlDocument = $this->paperhive_base_url . $this->paperhive_api_url . $bookID;
@@ -316,7 +316,6 @@ 
 	 *
 	 * @NoAdminRequired
 	 *
-	 * @param string $bookID
 	 * @return DataResponse
 	 */
 	public function getPaperHiveDetails() {

Spacing +10 added lines, -10 removed lines

@@ -33,7 +33,7 @@ 
 use OCP\IRequest;
 use OCP\Lock\LockedException;
 
-class PaperHiveController extends Controller{
+class PaperHiveController extends Controller {
 
 	/** @var IL10N */
 	private $l;
@@ -125,7 +125,7 @@ 
 	 */
 	private function loadPaperHiveIdFromFile($dir, $filename) {
 		$path = $dir . '/' . $filename;
-		if (!$this->view->file_exists($path)){
+		if (!$this->view->file_exists($path)) {
 			return false;
 		}
 		
@@ -134,7 +134,7 @@ 
 			$paperHiveObject = json_decode($fileContents, true);
 			if (json_last_error() === JSON_ERROR_NONE && isset($paperHiveObject['id'])) {
 				$paperHiveId = $paperHiveObject['id'];
-				if($this->adjustPaperHiveExtensions($path, $paperHiveId)){
+				if ($this->adjustPaperHiveExtensions($path, $paperHiveId)) {
 					return $paperHiveId;
 				}
 			}
@@ -158,16 +158,16 @@ 
 			if (sizeof($filenameParts) > 1) {
 				// Correct, file needs filename and extension
 				if (sizeof($filenameParts) === 2 || (sizeof($filenameParts) > 2 &&
-						strpos('.'.$filenameParts[sizeof($filenameParts)-2],$this->paperhive_rev_extension) === false)){
+						strpos('.' . $filenameParts[sizeof($filenameParts) - 2], $this->paperhive_rev_extension) === false)) {
 					// File needs correction, since been renamed or is obsolete
 					$revision = $this->loadPaperHiveIdFromFile($dir, $filename);
-					if ($revision === false){
+					if ($revision === false) {
 						return new DataResponse(['message' => (string)$this->l->t('File is obsolete, incorrectly renamed or cannot be read.')], Http::STATUS_BAD_REQUEST);
 					}
 				} else {
 					// File has correct format, and revision is the second extension
 					// Add extension dot since explode removed it and replace rev extension with empty string
-					$revisionString = '.'.$filenameParts[sizeof($filenameParts)-2];
+					$revisionString = '.' . $filenameParts[sizeof($filenameParts) - 2];
 					$revision = str_replace($this->paperhive_rev_extension, '', $revisionString);
 				}
 
@@ -194,7 +194,7 @@ 
 			}
 
 		} catch (LockedException $e) {
-			$message = (string) $this->l->t('The file is locked.');
+			$message = (string)$this->l->t('The file is locked.');
 			return new DataResponse(['message' => $message], Http::STATUS_BAD_REQUEST);
 		} catch (ForbiddenException $e) {
 			return new DataResponse(['message' => $e->getMessage()], Http::STATUS_BAD_REQUEST);
@@ -274,7 +274,7 @@ 
 			$extension = $this->paperhive_rev_extension . $bookID . $this->paperhive_file_extension;
 			$filename = $paperHiveObject['title'] . $extension;
 
-			if($dir == '/') {
+			if ($dir == '/') {
 				$path = $dir . $filename;
 			} else {
 				$path = $dir . '/' . $filename;
@@ -283,14 +283,14 @@ 
 			try {
 				$exists = $this->view->file_exists($path);
 				if ($exists) {
-					$message = (string) $this->l->t('The file already exists.');
+					$message = (string)$this->l->t('The file already exists.');
 					return new DataResponse(['message' => $message], Http::STATUS_BAD_REQUEST);
 				}
 				$filecontents = iconv(mb_detect_encoding($paperHiveString), "UTF-8", $paperHiveString);
 				try {
 					$this->view->file_put_contents($path, $filecontents);
 				} catch (LockedException $e) {
-					$message = (string) $this->l->t('The file is locked.');
+					$message = (string)$this->l->t('The file is locked.');
 					return new DataResponse(['message' => $message], Http::STATUS_BAD_REQUEST);
 				} catch (ForbiddenException $e) {
 					return new DataResponse(['message' => $e->getMessage()], Http::STATUS_BAD_REQUEST);

tests/controller/paperhivecontrollertest.php

Doc Comments +3 added lines

@@ -90,6 +90,9 @@
 			$this->clientMock);
 	}
 
+	/**
+	 * @param string $title
+	 */
 	private function fakeAll($bookID, $title) {
 		$contentsDoc = '{' . '"id" : "'.$bookID .'", "title" : "'. $title .'" }';
 		$contentsDis = '{' . '"discussions" : [ "blabla", "blabla" ]' .'}';

Unused Use Statements -1 removed lines

@@ -21,7 +21,6 @@
 
 namespace OCA\Files_PaperHive\Tests\Controller;
 
-use OC\HintException;
 use OCA\Files_PaperHive\Controller\PaperHiveController;
 use OCP\Files\ForbiddenException;
 use OCP\Lock\LockedException;

Spacing +13 added lines, -13 removed lines

@@ -91,8 +91,8 @@ 
 	}
 
 	private function fakeAll($bookID, $title) {
-		$contentsDoc = '{' . '"id" : "'.$bookID .'", "title" : "'. $title .'" }';
-		$contentsDis = '{' . '"discussions" : [ "blabla", "blabla" ]' .'}';
+		$contentsDoc = '{' . '"id" : "' . $bookID . '", "title" : "' . $title . '" }';
+		$contentsDis = '{' . '"discussions" : [ "blabla", "blabla" ]' . '}';
 		$this->responseMock->expects($this->any())
 			->method('getBody')
 			->willReturnOnConsecutiveCalls($contentsDis, $contentsDoc);
@@ -141,7 +141,7 @@ 
 		$dir = '';
 		$bookID = 'Ra5WnkxImoOE';
 		$title = "Borderland City in New India";
-		$path = $dir . '/'. $title. '.renamed.paperhive';
+		$path = $dir . '/' . $title . '.renamed.paperhive';
 		$contents = $this->fakeAll($bookID, $title);
 
 		$this->viewMock->expects($this->once())
@@ -170,7 +170,7 @@ 
 		$dir = '';
 		$bookID = 'Ra5WnkxImoOE';
 		$title = "Borderland City in New India";
-		$path = $dir . '/'. $title;
+		$path = $dir . '/' . $title;
 		$contents = $this->fakeAll($bookID, $title);
 
 		$result = $this->controller->loadMetadata('/', $path, "true");
@@ -185,7 +185,7 @@ 
 		$dir = '';
 		$bookID = 'Ra5WnkxImoOE';
 		$title = "Borderland City in New India";
-		$path = $dir . '/'. $title. '.renamed.paperhive';
+		$path = $dir . '/' . $title . '.renamed.paperhive';
 		$contents = $this->fakeAll($bookID, $title);
 
 		$this->viewMock->expects($this->once())
@@ -204,7 +204,7 @@ 
 		$dir = '';
 		$bookID = 'Ra5WnkxImoOE';
 		$title = "Borderland City in New India";
-		$path = $dir . '/'. $title. '.renamed.paperhive';
+		$path = $dir . '/' . $title . '.renamed.paperhive';
 		$contents = $this->fakeAll($bookID, $title);
 
 		$this->viewMock->expects($this->once())
@@ -227,7 +227,7 @@ 
 	$dir = '';
 	$bookID = 'Ra5WnkxImoOE';
 	$title = "Borderland City in New India";
-	$path = $dir . '/'. $title. '.renamed.paperhive';
+	$path = $dir . '/' . $title . '.renamed.paperhive';
 	$contents = $this->fakeAll($bookID, $title);
 
 	$this->viewMock->expects($this->once())
@@ -254,7 +254,7 @@ 
 		$dir = '';
 		$bookID = 'Ra5WnkxImoOE';
 		$title = "Borderland City in New India";
-		$path = $dir . '/'. $title. '.renamed.paperhive';
+		$path = $dir . '/' . $title . '.renamed.paperhive';
 		$contents = $this->fakeAll($bookID, $title);
 
 		$this->viewMock->expects($this->once())
@@ -288,7 +288,7 @@ 
 		$dir = '';
 		$bookID = 'Ra5WnkxImoOE';
 		$title = "Borderland City in New India";
-		$path = $dir . '/'. $title. '.rev'.$bookID.'.paperhive';
+		$path = $dir . '/' . $title . '.rev' . $bookID . '.paperhive';
 
 		$result = $this->controller->loadMetadata('/', $path, "false");
 		$data = $result->getData();
@@ -309,7 +309,7 @@ 
 		$dir = '';
 		$bookID = 'Ra5WnkxImoOE';
 		$title = "Borderland City in New India";
-		$path = $dir . '/'. $title. '.rev'.$bookID.'.paperhive';
+		$path = $dir . '/' . $title . '.rev' . $bookID . '.paperhive';
 		$contents = $this->fakeAll($bookID, $title);
 
 		$result = $this->controller->loadMetadata('/', $path, "true");
@@ -328,7 +328,7 @@ 
 	}
 
 	public function dataTestSave() {
-		return array (
+		return array(
 			array('', 'Ra5WnkxImoOE', true, true, 200, ''),
 			array('/test', 'Ra5WnkxImoOE', true, true, 200, ''),
 			array('', 'Ra5WnkxImoOE', true, true, 400, 'The file already exists.')
@@ -347,7 +347,7 @@ 
 	 */
 	public function testGetPaperHiveDocument($dir, $bookID, $correctDiscussions, $correctDocument, $expectedStatus, $expectedMessage) {
 		$title = "Borderland City in New India";
-		$path = $dir . '/'. $title. '.rev'.$bookID.'.paperhive';
+		$path = $dir . '/' . $title . '.rev' . $bookID . '.paperhive';
 		$contents = $this->fakeAll($bookID, $title);
 
 		if ($expectedStatus === 200) {
@@ -371,7 +371,7 @@ 
 			$this->assertArrayHasKey('extension', $data);
 			$this->assertArrayHasKey('discussionCount', $data);
 			$this->assertSame(2, $data['discussionCount']);
-			$this->assertSame('.rev'.$bookID.'.paperhive', $data['extension']);
+			$this->assertSame('.rev' . $bookID . '.paperhive', $data['extension']);
 		} else {
 			$this->assertArrayHasKey('message', $data);
 			$this->assertSame($expectedMessage, $data['message']);