Files
UNIT3D-Community-Edition/app/Notifications/NewComment.php
Roardom 160a3c7e11 update: improve notification wording
Remove title casing, change verb tense and other adjustments.
2026-03-02 08:38:00 +00:00

137 lines
4.6 KiB
PHP

<?php
declare(strict_types=1);
/**
* NOTICE OF LICENSE.
*
* UNIT3D Community Edition is open-sourced software licensed under the GNU Affero General Public License v3.0
* The details is bundled with this project in the file LICENSE.txt.
*
* @project UNIT3D Community Edition
*
* @author HDVinnie <hdinnovations@protonmail.com>
* @license https://www.gnu.org/licenses/agpl-3.0.en.html/ GNU Affero General Public License v3.0
*/
namespace App\Notifications;
use App\Models\Article;
use App\Models\Comment;
use App\Models\Playlist;
use App\Models\Ticket;
use App\Models\Torrent;
use App\Models\TorrentRequest;
use App\Models\User;
use Illuminate\Bus\Queueable;
use Illuminate\Notifications\Notification;
class NewComment extends Notification
{
use Queueable;
/**
* NewComment Constructor.
*/
public function __construct(public Torrent|TorrentRequest|Ticket|Playlist|Article $model, public Comment $comment)
{
}
/**
* Get the notification's delivery channels.
*
* @return array<int, string>
*/
public function via(object $notifiable): array
{
return ['database'];
}
/**
* Determine if the notification should be sent.
*/
public function shouldSend(User $notifiable): bool
{
// Do not notify self
if ($this->comment->user_id === $notifiable->id) {
return false;
}
// Enforce non-anonymous staff notifications to be sent
if ($this->comment->user->group->is_modo &&
! $this->comment->anon) {
return true;
}
// Evaluate general settings
if ($notifiable->notification?->block_notifications === 1) {
return false;
}
// Evaluate model based settings
switch ($this->model::class) {
case Torrent::class:
if ($notifiable->notification?->show_torrent_comment === 0) {
return false;
}
// If the sender's group ID is found in the "Block all notifications from the selected groups" array,
// the expression will return false.
return ! \in_array($this->comment->user->group_id, $notifiable->notification?->json_torrent_groups ?? [], true);
case TorrentRequest::class:
if ($notifiable->notification?->show_request_comment === 0) {
return false;
}
// If the sender's group ID is found in the "Block all notifications from the selected groups" array,
// the expression will return false.
return ! \in_array($this->comment->user->group_id, $notifiable->notification?->json_request_groups ?? [], true);
case Ticket::class:
return $notifiable->id !== $this->comment->user_id;
case Playlist::class:
case Article::class:
break;
}
return true;
}
/**
* Get the array representation of the notification.
*
* @return array<string, mixed>
*/
public function toArray(object $notifiable): array
{
$username = $this->comment->anon ? 'Anonymous' : $this->comment->user->username;
return match ($this->model::class) {
Torrent::class => [
'title' => 'Torrent comment',
'body' => $username.' commented on torrent '.$this->model->name,
'url' => '/torrents/'.$this->model->id.'#comment-'.$this->comment->id,
],
TorrentRequest::class => [
'title' => 'Request comment',
'body' => $username.' commented on torrent request '.$this->model->name,
'url' => '/requests/'.$this->model->id.'#comment-'.$this->comment->id,
],
Ticket::class => [
'title' => 'Ticket comment',
'body' => $username.' commented on ticket '.$this->model->subject,
'url' => '/tickets/'.$this->model->id.'#comment-'.$this->comment->id,
],
Playlist::class => [
'title' => 'Playlist comment',
'body' => $username.' commented on playlist '.$this->model->name,
'url' => '/playlists/'.$this->model->id.'#comment-'.$this->comment->id,
],
Article::class => [
'title' => 'Article comment',
'body' => $username.' commented on article '.$this->model->title,
'url' => '/articles/'.$this->model->id.'#comment-'.$this->comment->id,
],
};
}
}