Merge pull request #2614 from nextcloud/backport/2572/stable34

[stable34] refactor(types): add native parameter and return types to UserSettings

Author: AndyScherzinger

lib/UserSettings.php

@@ -51,7 +51,7 @@ public function __construct(
 	 * @param string $type One of the activity types, 'batchtime' or 'self'
 	 * @return bool|int
 	 */
-	public function getUserSetting($user, $method, $type) {
+	public function getUserSetting(string $user, string $method, string $type): bool|int {
 		if ($method === 'email' && $this->config->getAppValue('activity', 'enable_email', 'yes') === 'no') {
 			return false;
 		}
@@ -86,7 +86,7 @@ public function getUserSetting($user, $method, $type) {
 	 * @param string $type
 	 * @return bool|int
 	 */
-	public function getAdminSetting($method, $type) {
+	public function getAdminSetting(string $method, string $type): bool|int {
 		$defaultSetting = $this->getDefaultSetting($method, $type);
 		if (is_bool($defaultSetting)) {
 			return (bool)$this->config->getAppValue(
@@ -110,7 +110,7 @@ public function getAdminSetting($method, $type) {
 	 * @param string $type One of the activity types, 'batchtime', 'self' or 'selfemail'
 	 * @return bool|int
 	 */
-	protected function getDefaultSetting($method, $type) {
+	protected function getDefaultSetting(string $method, string $type): bool|int {
 		if ($method === 'setting') {
 			if ($type === 'batchtime') {
 				return self::BATCH_TIME_HOURLY;
@@ -149,7 +149,7 @@ protected function getDefaultSetting($method, $type) {
 	 * @param string $type One of the activity types, 'batchtime', 'self' or 'selfemail'
 	 * @return bool
 	 */
-	protected function canModifySetting($method, $type) {
+	protected function canModifySetting(string $method, string $type): bool {
 		if ($method === 'setting') {
 			return true;
 		}
@@ -172,7 +172,7 @@ protected function canModifySetting($method, $type) {
 	/**
 	 * Get a list with all notification types
 	 */
-	public function getNotificationTypes() {
+	public function getNotificationTypes(): array {
 		$settings = $this->manager->getSettings();
 
 		$return = array_map(function (ActivitySettings $setting) {
@@ -198,7 +198,7 @@ public function getNotificationTypes() {
 	 * @return array Returns a "username => b:true" Map for method = notification
 	 *               Returns a "username => i:batchtime" Map for method = email
 	 */
-	public function filterUsersBySetting($users, $method, $type) {
+	public function filterUsersBySetting(array $users, string $method, string $type): array {
 		if (empty($users)) {
 			return [];
 		}

tests/ConsumerTest.php

@@ -82,17 +82,25 @@ protected function setUp(): void {
 			->method('get')
 			->with('activity')
 			->willReturn($l10n);
+		$map = [
+			['affectedUser', 'notification', 'type', true],
+			['affectedUser2', 'notification', 'type', true],
+			['affectedUser', 'email', 'type', true],
+			['affectedUser2', 'email', 'type', true],
+			['affectedUser', 'setting', 'batchtime', 10],
+			['affectedUser2', 'setting', 'batchtime', 10],
+		];
 		$this->userSettings
 			->method('getUserSetting')
 			->with($this->stringContains('affectedUser'), $this->anything(), $this->anything())
-			->willReturnMap([
-				['affectedUser', 'notification', 'type', true],
-				['affectedUser2', 'notification', 'type', true],
-				['affectedUser', 'email', 'type', true],
-				['affectedUser2', 'email', 'type', true],
-				['affectedUser', 'setting', 'batchtime', 10],
-				['affectedUser2', 'setting', 'batchtime', 10],
-			]);
+			->willReturnCallback(function ($user, $method, $type) use ($map): bool|int {
+				foreach ($map as [$u, $m, $t, $v]) {
+					if ($u === $user && $m === $method && $t === $type) {
+						return $v;
+					}
+				}
+				return false;
+			});
 
 		$this->consumer = new Consumer(
 			$this->data,

tests/FilesHooksTest.php

@@ -722,8 +722,14 @@ public function testShareWithGroup(array $usersInGroup, int $settingCalls, int $
 
 		$this->settings->expects($this->exactly($settingCalls))
 			->method('filterUsersBySetting')
-			#->with($settingUsers, $this->anything(), Files_Sharing::TYPE_SHARED)
-			->willReturnMap($settingsReturn);
+			->willReturnCallback(function ($users, $method, $type) use ($settingsReturn): array {
+				foreach ($settingsReturn as [$u, $m, $t, $v]) {
+					if ($u === $users && $m === $method && $t === $type) {
+						return $v;
+					}
+				}
+				return [];
+			});
 
 		$filesHooks->expects($this->once())
 			->method('shareNotificationForSharer')