Files
animethemes-server/app/Events/Base/BaseRestoredEvent.php
T
paranarimasuandGitHub 6015dcbbbf refactor: migration from laravel-enum package to native php enums (#585)
* refactor: migration from laravel-enum package to native php enums

* style: fix StyleCI findings
2023-06-09 14:29:10 -05:00

56 lines
1.2 KiB
PHP

<?php
declare(strict_types=1);
namespace App\Events\Base;
use App\Contracts\Events\DiscordMessageEvent;
use App\Enums\Discord\EmbedColor;
use App\Events\BaseEvent;
use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;
use NotificationChannels\Discord\DiscordMessage;
/**
* Class BaseRestoredEvent.
*
* @template TModel of \App\Models\BaseModel
*
* @extends BaseEvent<TModel>
*/
abstract class BaseRestoredEvent extends BaseEvent implements DiscordMessageEvent
{
use Dispatchable;
use SerializesModels;
/**
* Get Discord message payload.
*
* @return DiscordMessage
*/
public function getDiscordMessage(): DiscordMessage
{
return DiscordMessage::create('', [
'description' => $this->getDiscordMessageDescription(),
'color' => EmbedColor::GREEN->value,
]);
}
/**
* Determine if the message should be sent.
*
* @return bool
*/
public function shouldSendDiscordMessage(): bool
{
return true;
}
/**
* Get the description for the Discord message payload.
*
* @return string
*/
abstract protected function getDiscordMessageDescription(): string;
}