Index | Alert-system API

A

AlertService — Class in namespace Beartropy\AlertSystem
AlertSystemServiceProvider — Class in namespace Beartropy\AlertSystem: Service Provider for the Beartropy Alert System.
Alert — Class in namespace Beartropy\AlertSystem\Facades: Facade for the Alert System Service.
$ ErrorAlertMail#alertMessage — Property in class ErrorAlertMail
AlertChannel — Class in namespace Beartropy\AlertSystem\Models: Model representing an alert channel (e.g., mail, telegram).
AlertLog — Class in namespace Beartropy\AlertSystem\Models: Model representing an alert log entry.
$ AlertLog#address — Property in class AlertLog
AlertRecipient — Class in namespace Beartropy\AlertSystem\Models: Model representing an alert recipient.
$ AlertRecipient#alert_type_id — Property in class AlertRecipient
$ AlertRecipient#alert_channel_id — Property in class AlertRecipient
$ AlertRecipient#address — Property in class AlertRecipient
AlertType — Class in namespace Beartropy\AlertSystem\Models: Model representing an alert type.
AllChannelsTraits — Class in namespace Beartropy\AlertSystem\Traits\Alerts: Trait aggregating all channel notification traits.

B

AlertSystemServiceProvider::boot() — Method in class AlertSystemServiceProvider: Bootstrap any application services.
ErrorAlertMail::build() — Method in class ErrorAlertMail: Build the message.
$ AlertLog#bot — Property in class AlertLog
$ AlertRecipient#bot — Property in class AlertRecipient

C

$ ManageChannels#channelName — Property in class ManageChannels: The name of the channel being edited
ManageChannels::columns() — Method in class ManageChannels: Define the columns for the table.
ManageLogs::columns() — Method in class ManageLogs: Define the columns for the table.
ManageTypes::columns() — Method in class ManageTypes: Define the columns for the table.
$ AlertChannel#created_at — Property in class AlertChannel
$ AlertLog#casts — Property in class AlertLog
$ AlertLog#channel — Property in class AlertLog
$ AlertLog#created_at — Property in class AlertLog
$ AlertRecipient#created_at — Property in class AlertRecipient
$ AlertRecipient#channel — Property in class AlertRecipient
AlertRecipient::channel() — Method in class AlertRecipient: Get the alert channel for this recipient.
$ AlertType#created_at — Property in class AlertType
$ DiscordService#client — Property in class DiscordService
$ TelegramService#client — Property in class TelegramService

D

$ ErrorAlertMail#details — Property in class ErrorAlertMail
$ AlertLog#details — Property in class AlertLog
DiscordService — Class in namespace Beartropy\AlertSystem\Services: Service for sending alerts via Discord.
DiscordNotification — Class in namespace Beartropy\AlertSystem\Traits\Alerts\Channels: Trait for sending Discord notifications.
DiscordNotification::discordAlert() — Method in class DiscordNotification: Send an alert notification via Discord.

E

ManageChannels::editChannel() — Method in class ManageChannels: Open the modal to edit a channel.
ManageChannels::export_all() — Method in class ManageChannels: Export all data to Excel.
ManageChannels::export_filtered() — Method in class ManageChannels: Export filtered data to Excel.
ManageChannels::export_selected() — Method in class ManageChannels: Export selected rows to Excel.
ManageLogs::export_all() — Method in class ManageLogs: Export all data to Excel.
ManageLogs::export_filtered() — Method in class ManageLogs: Export filtered data to Excel.
ManageLogs::export_selected() — Method in class ManageLogs: Export selected rows to Excel.
ManageTypes::editType() — Method in class ManageTypes: Open the modal to edit an alert type.
ManageTypes::export_all() — Method in class ManageTypes: Export all data to Excel.
ManageTypes::export_filtered() — Method in class ManageTypes: Export filtered data to Excel.
ManageTypes::export_selected() — Method in class ManageTypes: Export selected rows to Excel.
ErrorAlertMail — Class in namespace Beartropy\AlertSystem\Mail: Mailable for sending error alerts.
$ AlertLog#error_message — Property in class AlertLog

F

ManageChannels::filters() — Method in class ManageChannels: Define the filters for the table.
ManageLogs::filters() — Method in class ManageLogs: Define the filters for the table.
ManageTypes::filters() — Method in class ManageTypes: Define the filters for the table.
$ AlertChannel#fillable — Property in class AlertChannel
$ AlertLog#fillable — Property in class AlertLog
$ AlertRecipient#fillable — Property in class AlertRecipient
$ AlertType#fillable — Property in class AlertType
AllChannelsTraits::flattenAlertDetails() — Method in class AllChannelsTraits: Flatten a multidimensional array of alert details into a single-level array.

G

Alert::getFacadeAccessor() — Method in class Alert: Get the registered name of the component.

H

AlertService::handleDB() — Method in class AlertService: Record the alert attempt in the database.
AlertService::handleLog() — Method in class AlertService: Log the alert attempt result.

I

AlertService::isEnvironmentAllowed() — Method in class AlertService: Check if the current environment is allowed to send alerts.
AlertService::isInCooldown() — Method in class AlertService: Check if an alert is currently in cooldown for a specific recipient.
$ AlertChannel#id — Property in class AlertChannel
$ AlertLog#id — Property in class AlertLog
$ AlertRecipient#id — Property in class AlertRecipient
$ AlertRecipient#is_active — Property in class AlertRecipient
$ AlertType#id — Property in class AlertType

L

AlertService::logCooldownSkip() — Method in class AlertService: Log that an alert was skipped due to cooldown.

M

ManageChannels — Class in namespace Beartropy\AlertSystem\Livewire: Livewire component to manage Alert Channels.
$ ManageChannels#model — Property in class ManageChannels: The model class associated with the table
ManageLogs — Class in namespace Beartropy\AlertSystem\Livewire: Livewire component to manage Alert Logs.
$ ManageLogs#model — Property in class ManageLogs: The model class associated with the table
ManageTypes — Class in namespace Beartropy\AlertSystem\Livewire: Livewire component to manage Alert Types.
$ ManageTypes#model — Property in class ManageTypes: The model class associated with the table
$ AlertLog#message — Property in class AlertLog
MailNotification — Class in namespace Beartropy\AlertSystem\Traits\Alerts\Channels: Trait for sending Mail notifications.
MailNotification::mailAlert() — Method in class MailNotification: Send an alert notification via Email.

N

$ AlertChannel#name — Property in class AlertChannel
$ AlertType#name — Property in class AlertType

O

$ ManageChannels#openEditChannelModal — Property in class ManageChannels: Whether the edit modal is open
ManageChannels::options() — Method in class ManageChannels: Define the bulk actions available for the table.
$ ManageLogs#openInfoLogModal — Property in class ManageLogs: Whether the details modal is open
ManageLogs::options() — Method in class ManageLogs: Define the bulk actions available for the table.
$ ManageTypes#openEditTypeModal — Property in class ManageTypes: Whether the edit modal is open
ManageTypes::options() — Method in class ManageTypes: Define the bulk actions available for the table.

R

AlertSystemServiceProvider::register() — Method in class AlertSystemServiceProvider: Register any application services.
ManageChannels::rules() — Method in class ManageChannels: Define the validation rules.
ManageTypes::rules() — Method in class ManageTypes: Define validation rules.
$ AlertChannel#recipients — Property in class AlertChannel
AlertChannel::recipients() — Method in class AlertChannel: Get the recipients associated with this channel.
$ AlertType#recipients — Property in class AlertType
AlertType::recipients() — Method in class AlertType: Get the recipients subscribed to this alert type.

S

AlertService::send() — Method in class AlertService: Send an alert to configured recipients based on type.
AlertService::sendAlertViaChannel() — Method in class AlertService: Dispatch the alert to the specific channel.
Alert::send() — Method in class Alert: Send an alert.
$ ManageChannels#selectedChannel — Property in class ManageChannels: The currently selected channel for editing
ManageChannels::settings() — Method in class ManageChannels: Configure the table settings.
$ ManageLogs#selectedLog — Property in class ManageLogs: The currently selected log entry for detailed view
ManageLogs::settings() — Method in class ManageLogs: Configure the table settings.
ManageLogs::showDetails() — Method in class ManageLogs: Open the modal to view log details.
$ ManageTypes#selectedType — Property in class ManageTypes: The currently selected alert type for editing
ManageTypes::settings() — Method in class ManageTypes: Configure the table settings.
$ ErrorAlertMail#subjectText — Property in class ErrorAlertMail
$ AlertLog#status — Property in class AlertLog
$ AlertLog#subject — Property in class AlertLog
$ AlertLog#sent_at — Property in class AlertLog
DiscordService::sendMessage() — Method in class DiscordService: Send a message to a Discord channel via webhook.
TelegramService::sendMessage() — Method in class TelegramService: Send a message to a Telegram chat.

T

$ ManageChannels#tableName — Property in class ManageChannels: The name of the table displayed
$ ManageLogs#tableName — Property in class ManageLogs: The name of the table displayed
$ ManageTypes#tableName — Property in class ManageTypes: The name of the table displayed
$ ManageTypes#typeName — Property in class ManageTypes: The name of the alert type being edited
$ ErrorAlertMail#type — Property in class ErrorAlertMail
$ AlertLog#type — Property in class AlertLog
$ AlertRecipient#type — Property in class AlertRecipient
AlertRecipient::type() — Method in class AlertRecipient: Get the alert type for this recipient.
TelegramService — Class in namespace Beartropy\AlertSystem\Services: Service for sending alerts via Telegram.
TelegramNotification — Class in namespace Beartropy\AlertSystem\Traits\Alerts\Channels: Trait for sending Telegram notifications.
TelegramNotification::telegramAlert() — Method in class TelegramNotification: Send an alert notification via Telegram.

U

ManageChannels::updateChannel() — Method in class ManageChannels: Update the selected channel.
ManageTypes::updateType() — Method in class ManageTypes: Update the selected alert type.
$ AlertChannel#updated_at — Property in class AlertChannel
$ AlertLog#updated_at — Property in class AlertLog
$ AlertRecipient#updated_at — Property in class AlertRecipient
$ AlertType#updated_at — Property in class AlertType

_

ErrorAlertMail::__construct() — Method in class ErrorAlertMail: Create a new message instance.
DiscordService::__construct() — Method in class DiscordService: Create a new service instance.
TelegramService::__construct() — Method in class TelegramService: Create a new service instance.