Skip to content

Commit 77c4e5c

Browse files
committed
Improve the naming of classes and functions
1 parent a2d0978 commit 77c4e5c

File tree

14 files changed

+44
-46
lines changed

14 files changed

+44
-46
lines changed

phpstan-baseline.neon

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,5 @@
11
parameters:
22
ignoreErrors:
3-
-
4-
message: '#^Variable \$this might not be defined\.$#'
5-
identifier: variable.undefined
6-
count: 1
7-
path: wcfsetup/install/files/acp/update_com.woltlab.wcf_6.1_spider_step1.php
8-
93
-
104
message: '#^Property wcf\\acp\\form\\AbstractCategoryAddForm\:\:\$categoryNodeTree \(wcf\\data\\category\\UncachedCategoryNodeTree\) does not accept wcf\\data\\category\\CategoryNodeTree\.$#'
115
identifier: assign.propertyType

ts/WoltLabSuite/Core/Api/ModerationQueues/GetModerationUserMenuItems.ts renamed to ts/WoltLabSuite/Core/Api/ModerationQueues/GetUserMenuItems.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ type Response = {
1717
items: UserMenuData[];
1818
};
1919

20-
export async function getModerationUserMenuItems(): Promise<ApiResult<Response>> {
20+
export async function getUserMenuItems(): Promise<ApiResult<Response>> {
2121
let response: Response;
2222

2323
try {

ts/WoltLabSuite/Core/Api/ModerationQueues/MarkAllModerationQueuesAsRead.ts renamed to ts/WoltLabSuite/Core/Api/ModerationQueues/MarkAllAsRead.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
import { prepareRequest } from "WoltLabSuite/Core/Ajax/Backend";
1212
import { ApiResult, apiResultFromError, apiResultFromValue } from "../Result";
1313

14-
export async function markAllModerationQueuesAsRead(): Promise<ApiResult<[]>> {
14+
export async function markAllAsRead(): Promise<ApiResult<[]>> {
1515
try {
1616
await prepareRequest(`${window.WSC_RPC_API_URL}core/moderation-queues/mark-all-as-read`).post().fetchAsJson();
1717
} catch (e) {

ts/WoltLabSuite/Core/Api/ModerationQueues/MarkModerationQueueAsRead.ts renamed to ts/WoltLabSuite/Core/Api/ModerationQueues/MarkAsRead.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Mark a moderation queue as read.
2+
* Marks a moderation queue as read.
33
*
44
* @author Olaf Braun
55
* @copyright 2001-2025 WoltLab GmbH
@@ -15,7 +15,7 @@ type Response = {
1515
unreadModerationItems: number;
1616
};
1717

18-
export async function markModerationQueueAsRead(queueId: number): Promise<ApiResult<Response>> {
18+
export async function markAsRead(queueId: number): Promise<ApiResult<Response>> {
1919
let response: Response;
2020

2121
try {

ts/WoltLabSuite/Core/Ui/Moderation/MarkAllAsRead.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Marks all moderation queue entries as read.
2+
* Marks all moderation queues as read.
33
*
44
* @author Marcel Werk
55
* @copyright 2001-2022 WoltLab GmbH
@@ -8,10 +8,10 @@
88
*/
99

1010
import { showDefaultSuccessSnackbar } from "WoltLabSuite/Core/Component/Snackbar";
11-
import { markAllModerationQueuesAsRead } from "WoltLabSuite/Core/Api/ModerationQueues/MarkAllModerationQueuesAsRead";
11+
import { markAllAsRead as apiMarkAllAsRead } from "WoltLabSuite/Core/Api/ModerationQueues/MarkAllAsRead";
1212

1313
async function markAllAsRead(): Promise<void> {
14-
await markAllModerationQueuesAsRead();
14+
(await apiMarkAllAsRead()).unwrap();
1515

1616
const gridViewTable = document.getElementById("wcf-system-gridView-user-ModerationQueueGridView_table")!;
1717
gridViewTable.dispatchEvent(new CustomEvent("interaction:invalidate-all"));

ts/WoltLabSuite/Core/Ui/User/Menu/Data/ModerationQueue.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@
1010
import UserMenuView from "../View";
1111
import { EventUpdateCounter, UserMenuButton, UserMenuData, UserMenuFooter, UserMenuProvider } from "./Provider";
1212
import { registerProvider } from "../Manager";
13-
import { markModerationQueueAsRead } from "WoltLabSuite/Core/Api/ModerationQueues/MarkModerationQueueAsRead";
14-
import { markAllModerationQueuesAsRead } from "WoltLabSuite/Core/Api/ModerationQueues/MarkAllModerationQueuesAsRead";
15-
import { getModerationUserMenuItems } from "WoltLabSuite/Core/Api/ModerationQueues/GetModerationUserMenuItems";
13+
import { getUserMenuItems } from "WoltLabSuite/Core/Api/ModerationQueues/GetUserMenuItems";
14+
import { markAsRead } from "WoltLabSuite/Core/Api/ModerationQueues/MarkAsRead";
15+
import { markAllAsRead } from "WoltLabSuite/Core/Api/ModerationQueues/MarkAllAsRead";
1616

1717
type Options = {
1818
noItems: string;
@@ -64,7 +64,7 @@ class UserMenuDataModerationQueue implements UserMenuProvider {
6464
}
6565

6666
async getData(): Promise<UserMenuData[]> {
67-
const response = await getModerationUserMenuItems();
67+
const response = await getUserMenuItems();
6868
if (!response.ok) {
6969
throw new Error("Moderation queue items could not be loaded.");
7070
}
@@ -127,13 +127,13 @@ class UserMenuDataModerationQueue implements UserMenuProvider {
127127
}
128128

129129
async markAsRead(objectId: number): Promise<void> {
130-
const { unreadModerationItems } = (await markModerationQueueAsRead(objectId)).unwrap();
130+
const { unreadModerationItems } = (await markAsRead(objectId)).unwrap();
131131

132132
this.updateCounter(unreadModerationItems);
133133
}
134134

135135
async markAllAsRead(): Promise<void> {
136-
await markAllModerationQueuesAsRead();
136+
(await markAllAsRead()).unwrap();
137137

138138
this.updateCounter(0);
139139
}

wcfsetup/install/files/js/WoltLabSuite/Core/Api/ModerationQueues/GetModerationUserMenuItems.js renamed to wcfsetup/install/files/js/WoltLabSuite/Core/Api/ModerationQueues/GetUserMenuItems.js

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

wcfsetup/install/files/js/WoltLabSuite/Core/Api/ModerationQueues/MarkAllModerationQueuesAsRead.js renamed to wcfsetup/install/files/js/WoltLabSuite/Core/Api/ModerationQueues/MarkAllAsRead.js

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

wcfsetup/install/files/js/WoltLabSuite/Core/Api/ModerationQueues/MarkModerationQueueAsRead.js renamed to wcfsetup/install/files/js/WoltLabSuite/Core/Api/ModerationQueues/MarkAsRead.js

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

wcfsetup/install/files/js/WoltLabSuite/Core/Ui/Moderation/MarkAllAsRead.js

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)