janis91 / ocr

lib/Db/OcrStatus.php

Doc Comments +5 added lines, -5 removed lines

@@ -73,13 +73,13 @@
 	/**
 	 * OcrStatus constructor.
 	 *
-	 * @param null $status
-	 * @param null $source
-	 * @param null $target
+	 * @param string $status
+	 * @param string $source
+	 * @param string $target
 	 * @param null $tempFile
-	 * @param null $type
+	 * @param string $type
 	 * @param null $userId
-	 * @param null $errorDisplayed
+	 * @param boolean $errorDisplayed
 	 */
 	public function __construct($status = null, $source = null, $target = null, $tempFile = null, $type = null, $userId = null, $errorDisplayed = null) {
 		$this->setStatus($status);

Indentation +20 added lines, -20 removed lines

@@ -91,24 +91,24 @@
 		$this->setErrorDisplayed($errorDisplayed);
 	}
 
-    /**
-     * Specify data which should be serialized to JSON
-     * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
-     * @return mixed data which can be serialized by <b>json_encode</b>,
-     * which is a value of any type other than a resource.
-     * @since 5.4.0
-     */
-    function jsonSerialize()
-    {
-        return [
-            'id' => $this->id,
-            'status' => $this->status,
-            'source' => $this->source,
-            'target' => $this->target,
-            'tempFile' => $this->tempFile,
-            'type' => $this->type,
-            'userId' => $this->userId,
-            'errorDisplayed' => $this->errorDisplayed
-        ];
-    }
+	/**
+	 * Specify data which should be serialized to JSON
+	 * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
+	 * @return mixed data which can be serialized by <b>json_encode</b>,
+	 * which is a value of any type other than a resource.
+	 * @since 5.4.0
+	 */
+	function jsonSerialize()
+	{
+		return [
+			'id' => $this->id,
+			'status' => $this->status,
+			'source' => $this->source,
+			'target' => $this->target,
+			'tempFile' => $this->tempFile,
+			'type' => $this->type,
+			'userId' => $this->userId,
+			'errorDisplayed' => $this->errorDisplayed
+		];
+	}
 }
\ No newline at end of file

lib/Service/OcrService.php

Doc Comments +3 added lines, -2 removed lines

@@ -252,6 +252,7 @@ 
 	 * The PersonalSettingsController will have the opportunity to delete ocr status objects.
 	 *
 	 * @param $statusId
+	 * @param string $userId
 	 * @return OcrStatus
 	 */
 	public function deleteStatus($statusId, $userId) {
@@ -281,7 +282,7 @@ 
 	/**
 	 * Gets all status objects for a specific user in order to list them on the personal settings page.
 	 *
-	 * @param $userId
+	 * @param string $userId
 	 * @return array
 	 */
 	public function getAllForPersonal($userId) {
@@ -429,7 +430,7 @@ 
 
 	/**
 	 * @param File $fileInfo
-	 * @return bool
+	 * @return boolean|null
 	 */
 	private function checkSharedWithInitiator($fileInfo) {
 		try {

Indentation +19 added lines, -19 removed lines

@@ -212,7 +212,7 @@ 
 		try {
 			// TODO: release lock
 
-            // returns user specific processed files
+			// returns user specific processed files
 			$processed = $this->handleProcessed();
 
 			$pending = $this->statusMapper->findAllPending($this->userId);
@@ -263,18 +263,18 @@ 
 				$status = $this->statusMapper->delete($status);
 			}
 			$status->setTarget($this->removeFileExtension($status));
-            $status->setSource(null);
-            $status->setTempFile(null);
-            $status->setType(null);
-            $status->setErrorDisplayed(null);
+			$status->setSource(null);
+			$status->setTempFile(null);
+			$status->setType(null);
+			$status->setErrorDisplayed(null);
 			return $status;
 		} catch (Exception $e) {
-		    if ($e instanceof DoesNotExistException) {
-		        $ex = new NotFoundException($this->l10n->t('Cannot delete. Wrong id.'));
-                $this->handleException($ex);
-            } else {
-		        $this->handleException($e);
-		    }
+			if ($e instanceof DoesNotExistException) {
+				$ex = new NotFoundException($this->l10n->t('Cannot delete. Wrong id.'));
+				$this->handleException($ex);
+			} else {
+				$this->handleException($e);
+			}
 		}
 	}
 
@@ -285,9 +285,9 @@ 
 	 * @return array
 	 */
 	public function getAllForPersonal($userId) {
-	    try {
-            $status = $this->statusMapper->findAll($userId);
-            $statusNew = array();
+		try {
+			$status = $this->statusMapper->findAll($userId);
+			$statusNew = array();
 			for ($x = 0; $x < count($status); $x++) {
 				$newName = $this->removeFileExtension($status[$x]);
 				$status[$x]->setTarget($newName);
@@ -297,11 +297,11 @@ 
 				$status[$x]->setErrorDisplayed(null);
 				array_push($statusNew, $status[$x]);
 			}
-            return $statusNew;
-        } catch (Exception $e) {
-	        $this->handleException($e);
-        }
-    }
+			return $statusNew;
+		} catch (Exception $e) {
+			$this->handleException($e);
+		}
+	}
 
 	/**
 	 * Returns a not existing file name for pdf or image processing

Spacing +6 added lines, -6 removed lines

@@ -169,7 +169,7 @@ 
 					$source = $fInfo->getPath();
 					if ($this->checkSharedWithInitiator($fInfo)) {
 						// Shared Item
-						$source = str_replace('home::','',$fInfo->getStoragename()) . '/' . $source;
+						$source = str_replace('home::', '', $fInfo->getStoragename()) . '/' . $source;
 						$target = $this->buildTargetForShared($fInfo);
 					} else {
 						// Not Shared
@@ -313,7 +313,7 @@ 
 	 */
 	protected function buildTargetForShared(File $fileInfo) {
 		try {
-			$share = $this->shareMapper->find($fileInfo->getFileid(), $this->userId, str_replace('home::','',$fileInfo->getStoragename()));
+			$share = $this->shareMapper->find($fileInfo->getFileid(), $this->userId, str_replace('home::', '', $fileInfo->getStoragename()));
 
 			// get rid of the .png or .pdf and so on
 			$fileName = substr($share->getFileTarget(), 0, -4); // '/thedom.png' => '/thedom' || '/Test/thedom.png' => '/Test/thedom'
@@ -362,7 +362,7 @@ 
 			$filePath = str_replace('files', '', $filePath); // 'files/Test/' => '/Test/' || 'files/' => '/'
 
 			// remove the last slash
-			$filePath = substr_replace($filePath,'',strrpos($filePath,'/'),strlen('/')); // '/Test/' => '/Test' || '/' => ''
+			$filePath = substr_replace($filePath, '', strrpos($filePath, '/'), strlen('/')); // '/Test/' => '/Test' || '/' => ''
 
 			// replace the first slash
 			$pos = strpos($filePath, '/');
@@ -433,8 +433,8 @@ 
 	 */
 	private function checkSharedWithInitiator($fileInfo) {
 		try {
-			$owner = str_replace('home::','',$fileInfo->getStoragename());
-			if ($this->userId === $owner){
+			$owner = str_replace('home::', '', $fileInfo->getStoragename());
+			if ($this->userId === $owner) {
 				// user is owner (no shared file)
 				return false;
 			} else {
@@ -488,7 +488,7 @@ 
 	 */
 	private function removeFileExtension($status) {
 		try {
-			return substr($status->getTarget(), 0, strrpos($status->getTarget(),'_OCR'));
+			return substr($status->getTarget(), 0, strrpos($status->getTarget(), '_OCR'));
 		} catch (Exception $e) {
 			$this->handleException($e);
 		}