Skip to content

Latest commit

 

History

History
73 lines (50 loc) · 2.45 KB

File metadata and controls

73 lines (50 loc) · 2.45 KB

CommonPHP Notifications Documentation

CommonPHP Notifications is the core notification package for CommonPHP applications and plain PHP projects. It provides notification message objects, recipients, channel registration, driver contracts, delivery results, and a small notifier facade.

The package intentionally stops at the shared delivery boundary. Provider-specific behavior belongs in driver packages for SMTP, SendGrid, Twilio, Slack, Teams, webhooks, or other messaging APIs.

Start Here

Notification Concepts

Examples

Development

Public API Map

Entry points:

  • CommonPHP\Notifications\Notifier
  • CommonPHP\Notifications\NotificationChannel
  • CommonPHP\Notifications\ChannelRegistry
  • CommonPHP\Notifications\NotificationsServiceProvider

Message objects:

  • CommonPHP\Notifications\Notification
  • CommonPHP\Notifications\Recipient

Delivery objects:

  • CommonPHP\Notifications\DeliveryResult
  • CommonPHP\Notifications\DeliveryReport
  • CommonPHP\Notifications\Enums\DeliveryStatus

Contracts:

  • CommonPHP\Notifications\Contracts\NotifierInterface
  • CommonPHP\Notifications\Contracts\NotificationDriverInterface
  • CommonPHP\Notifications\Contracts\AbstractNotificationDriver

Built-in drivers:

  • CommonPHP\Notifications\Drivers\ArrayNotificationDriver
  • CommonPHP\Notifications\Drivers\NullNotificationDriver

Exceptions:

  • CommonPHP\Notifications\Exceptions\NotificationException
  • CommonPHP\Notifications\Exceptions\InvalidNotificationException
  • CommonPHP\Notifications\Exceptions\InvalidNotificationChannelException
  • CommonPHP\Notifications\Exceptions\ChannelNotFoundException
  • CommonPHP\Notifications\Exceptions\ChannelAlreadyRegisteredException
  • CommonPHP\Notifications\Exceptions\UnsupportedNotificationException
  • CommonPHP\Notifications\Exceptions\NotificationDriverException
  • CommonPHP\Notifications\Exceptions\NotificationDeliveryException