platform/api/laravel/Notifications/NotificationSender.yaml

name: NotificationSender
class_comment: null
dependencies:
- name: ShouldQueue
  type: class
  source: Illuminate\Contracts\Queue\ShouldQueue
- name: HasLocalePreference
  type: class
  source: Illuminate\Contracts\Translation\HasLocalePreference
- name: ModelCollection
  type: class
  source: Illuminate\Database\Eloquent\Collection
- name: Model
  type: class
  source: Illuminate\Database\Eloquent\Model
- name: NotificationSending
  type: class
  source: Illuminate\Notifications\Events\NotificationSending
- name: NotificationSent
  type: class
  source: Illuminate\Notifications\Events\NotificationSent
- name: Collection
  type: class
  source: Illuminate\Support\Collection
- name: Str
  type: class
  source: Illuminate\Support\Str
- name: Localizable
  type: class
  source: Illuminate\Support\Traits\Localizable
- name: Localizable
  type: class
  source: Localizable
properties:
- name: manager
  visibility: protected
  comment: '# * The notification manager instance.

    # *

    # * @var \Illuminate\Notifications\ChannelManager'
- name: bus
  visibility: protected
  comment: '# * The Bus dispatcher instance.

    # *

    # * @var \Illuminate\Contracts\Bus\Dispatcher'
- name: events
  visibility: protected
  comment: '# * The event dispatcher.

    # *

    # * @var \Illuminate\Contracts\Events\Dispatcher'
- name: locale
  visibility: protected
  comment: '# * The locale to be used when sending notifications.

    # *

    # * @var string|null'
methods:
- name: __construct
  visibility: public
  parameters:
  - name: manager
  - name: bus
  - name: events
  - name: locale
    default: 'null'
  comment: "# * The notification manager instance.\n# *\n# * @var \\Illuminate\\Notifications\\\
    ChannelManager\n# */\n# protected $manager;\n# \n# /**\n# * The Bus dispatcher\
    \ instance.\n# *\n# * @var \\Illuminate\\Contracts\\Bus\\Dispatcher\n# */\n# protected\
    \ $bus;\n# \n# /**\n# * The event dispatcher.\n# *\n# * @var \\Illuminate\\Contracts\\\
    Events\\Dispatcher\n# */\n# protected $events;\n# \n# /**\n# * The locale to be\
    \ used when sending notifications.\n# *\n# * @var string|null\n# */\n# protected\
    \ $locale;\n# \n# /**\n# * Create a new notification sender instance.\n# *\n#\
    \ * @param  \\Illuminate\\Notifications\\ChannelManager  $manager\n# * @param\
    \  \\Illuminate\\Contracts\\Bus\\Dispatcher  $bus\n# * @param  \\Illuminate\\\
    Contracts\\Events\\Dispatcher  $events\n# * @param  string|null  $locale\n# *\
    \ @return void"
- name: send
  visibility: public
  parameters:
  - name: notifiables
  - name: notification
  comment: '# * Send the given notification to the given notifiable entities.

    # *

    # * @param  \Illuminate\Support\Collection|array|mixed  $notifiables

    # * @param  mixed  $notification

    # * @return void'
- name: sendNow
  visibility: public
  parameters:
  - name: notifiables
  - name: notification
  - name: channels
    default: 'null'
  comment: '# * Send the given notification immediately.

    # *

    # * @param  \Illuminate\Support\Collection|array|mixed  $notifiables

    # * @param  mixed  $notification

    # * @param  array|null  $channels

    # * @return void'
- name: preferredLocale
  visibility: protected
  parameters:
  - name: notifiable
  - name: notification
  comment: '# * Get the notifiable''s preferred locale for the notification.

    # *

    # * @param  mixed  $notifiable

    # * @param  mixed  $notification

    # * @return string|null'
- name: sendToNotifiable
  visibility: protected
  parameters:
  - name: notifiable
  - name: id
  - name: notification
  - name: channel
  comment: '# * Send the given notification to the given notifiable via a channel.

    # *

    # * @param  mixed  $notifiable

    # * @param  string  $id

    # * @param  mixed  $notification

    # * @param  string  $channel

    # * @return void'
- name: shouldSendNotification
  visibility: protected
  parameters:
  - name: notifiable
  - name: notification
  - name: channel
  comment: '# * Determines if the notification can be sent.

    # *

    # * @param  mixed  $notifiable

    # * @param  mixed  $notification

    # * @param  string  $channel

    # * @return bool'
- name: queueNotification
  visibility: protected
  parameters:
  - name: notifiables
  - name: notification
  comment: '# * Queue the given notification instances.

    # *

    # * @param  mixed  $notifiables

    # * @param  \Illuminate\Notifications\Notification  $notification

    # * @return void'
- name: formatNotifiables
  visibility: protected
  parameters:
  - name: notifiables
  comment: '# * Format the notifiables into a Collection / array if necessary.

    # *

    # * @param  mixed  $notifiables

    # * @return \Illuminate\Database\Eloquent\Collection|array'
traits:
- Illuminate\Contracts\Queue\ShouldQueue
- Illuminate\Contracts\Translation\HasLocalePreference
- Illuminate\Database\Eloquent\Model
- Illuminate\Notifications\Events\NotificationSending
- Illuminate\Notifications\Events\NotificationSent
- Illuminate\Support\Collection
- Illuminate\Support\Str
- Illuminate\Support\Traits\Localizable
- Localizable
interfaces: []