Skip to content

[Notifier] Adjust notifier documentation #14035

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 21, 2020
Merged

[Notifier] Adjust notifier documentation #14035

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 14 additions & 13 deletions notifier.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@ To send a notification, autowire the

use Symfony\Component\Notifier\Notification\Notification;
use Symfony\Component\Notifier\NotifierInterface;
use Symfony\Component\Notifier\Recipient\AdminRecipient;
use Symfony\Component\Notifier\Recipient\Recipient;

class InvoiceController extends AbstractController
{
Expand All @@ -355,7 +355,7 @@ To send a notification, autowire the
->content('You got a new invoice for 15 EUR.');

// The receiver of the Notification
$recipient = new AdminRecipient(
$recipient = new Recipient(
$user->getEmail(),
$user->getPhonenumber()
);
Expand All @@ -375,22 +375,23 @@ both an email and sms notification to the user.
The default notification also has a ``content()`` and ``emoji()`` method to
set the notification content and icon.

Symfony provides three types of recipients:
Symfony provides the following recipients:

:class:`Symfony\\Component\\Notifier\\Recipient\\NoRecipient`
This is the default and is useful when there is no need to have
information about the receiver. For example, the browser channel uses
the current requests's :ref:`session flashbag <flash-messages>`;

:class:`Symfony\\Component\\Notifier\\Recipient\\Recipient`
This contains only the email address of the user and can be used for
messages on the email and browser channel;

:class:`Symfony\\Component\\Notifier\\Recipient\\AdminRecipient`
This can contain both email address and phonenumber of the user. This
recipient can be used for all channels (depending on whether they are
actually set).

.. versionadded:: 5.2

The ``AdminRecipient`` class was removed in Symfony 5.2, you should use
``Recipient`` instead.

Configuring Channel Policies
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -505,7 +506,8 @@ very high and the recipient has a phone number::
namespace App\Notifier;

use Symfony\Component\Notifier\Notification\Notification;
use Symfony\Component\Notifier\Recipient\Recipient;
use Symfony\Component\Notifier\Recipient\RecipientInterface;
use Symfony\Component\Notifier\Recipient\SmsRecipientInterface;

class InvoiceNotification extends Notification
{
Expand All @@ -516,12 +518,11 @@ very high and the recipient has a phone number::
$this->price = $price;
}

public function getChannels(Recipient $recipient)
public function getChannels(RecipientInterface $recipient)
{
if (
$this->price > 10000
&& $recipient instanceof AdminRecipient
&& null !== $recipient->getPhone()
&& $recipient instanceof SmsRecipientInterface
) {
return ['sms'];
}
Expand All @@ -545,7 +546,7 @@ and its ``asChatMessage()`` method::
use Symfony\Component\Notifier\Message\ChatMessage;
use Symfony\Component\Notifier\Notification\ChatNotificationInterface;
use Symfony\Component\Notifier\Notification\Notification;
use Symfony\Component\Notifier\Recipient\Recipient;
use Symfony\Component\Notifier\Recipient\SmsRecipientInterface;

class InvoiceNotification extends Notification implements ChatNotificationInterface
{
Expand All @@ -556,7 +557,7 @@ and its ``asChatMessage()`` method::
$this->price = $price;
}

public function asChatMessage(Recipient $recipient, string $transport = null): ?ChatMessage
public function asChatMessage(RecipientInterface $recipient, string $transport = null): ?ChatMessage
{
// Add a custom emoji if the message is sent to Slack
if ('slack' === $transport) {
Expand Down