matiasdelellis / facerecognition

lib/Command/Analyze.php

Doc Comments +6 added lines

@@ -274,10 +274,16 @@
 		$this->output->writeln(count($facesFound).' faces(s) found.');
 	}
 
+	/**
+	 * @param integer $progress
+	 */
 	private function updateProgress($progress) {
 		$this->config->setAppValue('facerecognition', 'queue-done', $progress);
 	}
 
+	/**
+	 * @param integer $time
+	 */
 	private function setStartTime($time) {
 		$this->config->setAppValue('facerecognition', 'starttime', $time);
 	}

lib/Db/ImageMapper.php

Doc Comments +6 added lines

@@ -53,6 +53,9 @@ 
 		return $row ? (int)$row['id'] : null;
 	}
 
+	/**
+	 * @param integer $model
+	 */
 	public function countUserImages(string $userId, $model): int {
 		$qb = $this->db->getQueryBuilder();
 		$query = $qb
@@ -69,6 +72,9 @@ 
 		return (int)$data[0];
 	}
 
+	/**
+	 * @param integer $model
+	 */
 	public function countUserProcessedImages(string $userId, $model): int {
 		$qb = $this->db->getQueryBuilder();
 		$query = $qb

lib/Helper/PythonAnalyzer.php

Doc Comments +8 added lines

@@ -11,6 +11,11 @@ 
 	protected $model;
 	protected $fileList;
 
+	/**
+	 * @param string $command
+	 * @param string $predictor
+	 * @param string $model
+	 */
 	function __construct($command, $predictor, $model) {
 		$this->command = $command;
 		$this->predictor = $predictor;
@@ -18,6 +23,9 @@ 
 		$this->fileList = "";
 	}
 
+	/**
+	 * @param string $filename
+	 */
 	public function appendFile ($filename)
 	{
 		$this->fileList .= " ".escapeshellarg($filename);

lib/Helper/Requirements.php

Doc Comments +1 added lines, -1 removed lines

@@ -124,7 +124,7 @@
 	 * Based on that and the fact that Nextcloud is superset of these, these are supported image types.
 	 *
 	 * @param string $mimeType MIME type to check if it supported
-	 * @return true if MIME type is supported, false otherwise
+	 * @return boolean if MIME type is supported, false otherwise
 	 */
 	public static function isImageTypeSupported(string $mimeType): bool {
 		if (

lib/Db/FaceNewMapper.php

Doc Comments +6 added lines

@@ -22,6 +22,9 @@ 
 		return $faces;
 	}
 
+	/**
+	 * @param integer $model
+	 */
 	public function countFaces(string $userId, $model): int {
 		$qb = $this->db->getQueryBuilder();
 		$query = $qb
@@ -39,6 +42,9 @@ 
 		return (int)$data[0];
 	}
 
+	/**
+	 * @param integer $model
+	 */
 	public function getFaces(string $userId, $model): array {
 		$qb = $this->db->getQueryBuilder();
 		$query = $qb

lib/BackgroundJob/Tasks/ImageProcessingTask.php

Doc Comments +1 added lines, -1 removed lines

@@ -273,7 +273,7 @@
 	 *
 	 * @param \FaceLandmarkDetection $fld Landmark detection model
 	 * @param \FaceRecognition $fr Face recognition model
-	 * @param ImageProcessingContext Image processing context
+	 * @param ImageProcessingContext ImageProcessingContext processing context
 	 */
 	private function populateDescriptors(\FaceLandmarkDetection $fld, \FaceRecognition $fr, ImageProcessingContext $imageProcessingContext) {
 		$faces = $imageProcessingContext->getFaces();

lib/Db/FaceMapper.php

Doc Comments +23 added lines

@@ -22,16 +22,27 @@ 
 		return $this->findEntities($sql, [$userId]);
 	}
 
+	/**
+	 * @param string $userId
+	 * @param integer $limit
+	 * @param integer $offset
+	 */
 	public function findAllQueued($userId, $limit = null, $offset = null) {
 		$sql = 'SELECT * FROM *PREFIX*face_recognition WHERE uid = ? AND distance = -1 AND encoding IS NULL';
 		return $this->findEntities($sql, [$userId], $limit, $offset);
 	}
 
+	/**
+	 * @param string $userId
+	 */
 	public function findAllKnown($userId) {
 		$sql = 'SELECT * FROM *PREFIX*face_recognition WHERE uid = ? AND distance = 0 AND encoding IS NOT NULL';
 		return $this->findEntities($sql, [$userId]);
 	}
 
+	/**
+	 * @param string $userId
+	 */
 	public function findAllUnknown($userId) {
 		$sql = 'SELECT * FROM *PREFIX*face_recognition WHERE uid = ? AND distance > 0 AND encoding IS NOT NULL';
 		return $this->findEntities($sql, [$userId]);
@@ -42,6 +53,9 @@ 
 		return $this->findEntities($sql, [$userId]);
 	}
 
+	/**
+	 * @param integer $limit
+	 */
 	public function findAllNamed($userId, $query, $limit = null, $offset = null) {
 		$sql = 'SELECT id, name, distance FROM *PREFIX*face_recognition WHERE uid = ? AND encoding IS NOT NULL AND LOWER(name) LIKE LOWER(?)';
 		return $this->findEntities($sql, [$userId, $query], $limit, $offset);
@@ -57,11 +71,17 @@ 
 		return $this->findEntities($sql, [$userId]);
 	}
 
+	/**
+	 * @param integer $fileId
+	 */
 	public function findNewFile($userId, $fileId) {
 		$sql = 'SELECT * FROM *PREFIX*face_recognition WHERE uid = ? AND file = ? AND distance = -1 AND encoding IS NULL';
 		return $this->findEntities($sql, [$userId, $fileId]);
 	}
 
+	/**
+	 * @param integer $fileId
+	 */
 	public function findFile($userId, $fileId) {
 		$sql = 'SELECT * FROM *PREFIX*face_recognition WHERE uid = ? AND file = ?';
 		return $this->findEntities($sql, [$userId, $fileId]);
@@ -78,6 +98,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $userId
+	 */
 	public function countUserQueue($userId) {
 		$sql = 'SELECT count(*) AS ct FROM *PREFIX*face_recognition WHERE uid = ? AND distance = -1 AND encoding IS NULL';
 		$query = \OCP\DB::prepare($sql);

lib/Controller/FaceController.php

Doc Comments +3 added lines

@@ -82,6 +82,9 @@
 		return $this->getFaceThumb ($fileId, $face);
 	}
 
+	/**
+	 * @param \OCP\AppFramework\Db\Entity $face
+	 */
 	private function getFaceThumb ($fileId, $face) {
 		$userFolder = $this->rootFolder->getUserFolder($this->userId);
 		$nodes = $userFolder->getById($fileId);