From 61ed57b757201541b2038ccab10b092a77c4fb64 Mon Sep 17 00:00:00 2001
From: Joas Schilling <coding@schilljs.com>
Date: Wed, 10 Mar 2021 20:30:29 +0100
Subject: Rename some parameters and methods to make the API more clear

Signed-off-by: Joas Schilling <coding@schilljs.com>
---
 lib/private/KnownUser/KnownUserMapper.php  |  4 ++-
 lib/private/KnownUser/KnownUserService.php | 39 ++++++++++++++++++++++++------
 2 files changed, 35 insertions(+), 8 deletions(-)

(limited to 'lib')

diff --git a/lib/private/KnownUser/KnownUserMapper.php b/lib/private/KnownUser/KnownUserMapper.php
index 1144e2fd212..e77e4752702 100644
--- a/lib/private/KnownUser/KnownUserMapper.php
+++ b/lib/private/KnownUser/KnownUserMapper.php
@@ -63,10 +63,12 @@ class KnownUserMapper extends QBMapper {
 	}
 
 	/**
+	 * Returns all "known users" for the given "known to" user
+	 *
 	 * @param string $knownTo
 	 * @return KnownUser[]
 	 */
-	public function getKnownTo(string $knownTo): array {
+	public function getKnownUsers(string $knownTo): array {
 		$query = $this->db->getQueryBuilder();
 		$query->select('*')
 			->from($this->getTableName())
diff --git a/lib/private/KnownUser/KnownUserService.php b/lib/private/KnownUser/KnownUserService.php
index 3a97b967c3a..96af21c836f 100644
--- a/lib/private/KnownUser/KnownUserService.php
+++ b/lib/private/KnownUser/KnownUserService.php
@@ -33,30 +33,55 @@ class KnownUserService {
 		$this->mapper = $mapper;
 	}
 
+	/**
+	 * Delete all matches where the given user is the owner of the phonebook
+	 *
+	 * @param string $knownTo
+	 * @return int Number of deleted matches
+	 */
 	public function deleteKnownTo(string $knownTo): int {
 		return $this->mapper->deleteKnownTo($knownTo);
 	}
 
-	public function deleteKnownUser(string $knownUser): int {
-		return $this->mapper->deleteKnownUser($knownUser);
+	/**
+	 * Delete all matches where the given user is the one in the phonebook
+	 *
+	 * @param string $contactUserId
+	 * @return int Number of deleted matches
+	 */
+	public function deleteByContactUserId(string $contactUserId): int {
+		return $this->mapper->deleteKnownUser($contactUserId);
 	}
 
-	public function storeIsKnownToUser(string $knownTo, string $knownUser): void {
+	/**
+	 * Store a match because $knownTo has $contactUserId in his phonebook
+	 *
+	 * @param string $knownTo User id of the owner of the phonebook
+	 * @param string $contactUserId User id of the contact in the phonebook
+	 */
+	public function storeIsKnownToUser(string $knownTo, string $contactUserId): void {
 		$entity = new KnownUser();
 		$entity->setKnownTo($knownTo);
-		$entity->setKnownUser($knownUser);
+		$entity->setKnownUser($contactUserId);
 		$this->mapper->insert($entity);
 	}
 
-	public function isKnownToUser(string $knownTo, string $user): bool {
+	/**
+	 * Check if $contactUserId is in the phonebook of $knownTo
+	 *
+	 * @param string $knownTo User id of the owner of the phonebook
+	 * @param string $contactUserId User id of the contact in the phonebook
+	 * @return bool
+	 */
+	public function isKnownToUser(string $knownTo, string $contactUserId): bool {
 		if (!isset($this->knownUsers[$knownTo])) {
-			$entities = $this->mapper->getKnownTo($knownTo);
+			$entities = $this->mapper->getKnownUsers($knownTo);
 			$this->knownUsers[$knownTo] = [];
 			foreach ($entities as $entity) {
 				$this->knownUsers[$knownTo][$entity->getKnownUser()] = true;
 			}
 		}
 
-		return isset($this->knownUsers[$knownTo][$user]);
+		return isset($this->knownUsers[$knownTo][$contactUserId]);
 	}
 }
-- 
cgit v1.2.3