osu-web / app / Transformers / Chat / MessageTransformer.php

<?php

// Copyright (c) ppy Pty Ltd <[e-mail]>. Licensed under the GNU Affero General Public License v3.0.
// See the LICENCE file in the repository root for full licence text.

namespace App\Transformers\Chat;

use App\Models\Chat\Message;
use App\Models\DeletedUser;
use App\Transformers\TransformerAbstract;
use App\Transformers\UserCompactTransformer;

class MessageTransformer extends TransformerAbstract
{
    protected array $availableIncludes = [
        'sender',
    ];

    public function transform(Message $message)
    {
        $type = $message->is_action
            ? 'action'
            : ($message->channel->isAnnouncement() ? 'markdown' : 'plain');

        $response = [
            'channel_id' => $message->channel_id,
            'content' => $message->content,
            'is_action' => $message->is_action, // maybe deprecate?
            'message_id' => $message->message_id,
            'sender_id' => $message->user_id,
            'timestamp' => $message->timestamp_json,
            'type' => $type,
        ];

        if ($message->uuid !== null) {
            $response['uuid'] = $message->uuid;
        }

        return $response;
    }

    public function includeSender(Message $message)
    {
        return $this->item(
            $message->sender ?? (new DeletedUser()),
            new UserCompactTransformer()
        );
    }

    public function includeUuid(Message $message)
    {
        return $this->primitive($message->uuid);
    }
}