Skip to content

Commit 33f5b8b

Browse files
committed
Improved the wording
1 parent be242d4 commit 33f5b8b

File tree

1 file changed

+14
-17
lines changed

1 file changed

+14
-17
lines changed

docs/migration/wsc54/forum_subscriptions.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,12 @@
22

33
## Subscriptions
44

5-
With WoltLab Suite Forum 5.5 we introduced a new system to subscribe threads and boards including the possibility to ignore threads and boards.
6-
[You can read more about this feature in our blog](https://www.woltlab.com/article/260-new-features-in-woltlab-suite-5-5-revision-of-buttons-and-ignoring-threads/).
7-
The new system uses an own system to manage the subscribed forums as well as the subscribed threads.
8-
This has made the previously used object type `com.woltlab.wcf.user.objectWatch` obsolete, as it no longer meets the requirements we need for the new more flexible system.
9-
In addition, having our own implementation also makes it much easier to use, as we work with our own tables and we can thus create correct foreign keys.
10-
Therefore, we had to create a new API to manage subscriptions.
5+
With WoltLab Suite Forum 5.5 we have introduced a new system for subscribing to threads and boards, which also offers the possibility to ignore threads and boards.
6+
[You can learn more about this feature in our blog](https://www.woltlab.com/article/260-new-features-in-woltlab-suite-5-5-revision-of-buttons-and-ignoring-threads/).
7+
The new system uses a separate mechanism to track the subscribed forums as well as the subscribed threads.
8+
The previously used object type `com.woltlab.wcf.user.objectWatch` is now discontinued, because the object watch system turned out to be too limited for the complex logic behind thread and forum subscriptions.
119

12-
### Subscribe to threads
10+
### Subscribe to Threads
1311

1412
#### Previously
1513

@@ -34,25 +32,25 @@ ThreadStatusHandler::saveSubscriptionStatus(
3432
### Filter Ignored Threads
3533

3634
To filter ignored threads from a given `ThreadList`, you can use the method `ThreadStatusHandler::addFilterForIgnoredThreads()` to append the filter for ignored threads.
37-
The `ViewableThreadList` filters ignored threads by default.
35+
The `ViewableThreadList` filters out ignored threads by default.
3836

39-
As an example:
37+
Example:
4038

4139
```php
40+
$user = new User(123);
4241
$threadList = new ThreadList();
4342
ThreadStatusHandler::addFilterForIgnoredThreads(
4443
$threadList,
45-
// This parameter is optional. If null, the current user will be used. Otherwise, the filter is executed
46-
// for the given user.
47-
WCF::getUser()
44+
// This parameter specifies the target user. Defaults to the current user if the parameter
45+
// is omitted or `null`.
46+
$user
4847
);
4948
$threadList->readObjects();
5049
```
5150

5251
### Filter Ignored Users
5352

54-
Ignoring threads should surpress the notifications for the user.
55-
Therefore we ship also a method, which can filter the `userIDs`, which are ignoring a specific thread.
53+
Avoid issuing notifications to users that have ignored the target thread by filtering those out.
5654

5755
```php
5856
$userIDs = [1, 2, 3];
@@ -62,7 +60,7 @@ $users = ThreadStatusHandler::filterIgnoredUserIDs(
6260
);
6361
```
6462

65-
### Subscribe to boards
63+
### Subscribe to Boards
6664

6765
#### Previously
6866

@@ -86,8 +84,7 @@ BoardStatusHandler::saveSubscriptionStatus(
8684

8785
### Filter Ignored Boards
8886

89-
With the new system, notifications from ignored boards should be surpressed.
90-
Therefore, we introduced a method, which filters userIDs which ignoring a specific board.
87+
Similar to ignored threads you will also have to avoid issuing notifications for boards that a user has ignored.
9188

9289
```php
9390
$userIDs = [1, 2, 3];

0 commit comments

Comments
 (0)