About notifications

[adriendupuis]

Question	Answer
JIRA Ticket
Versions
Edition

Inspired by ibexa/recipes-dev#257

• Details when and to whom the notification are sent.
• Info about which notification type a channel accept is needed even for built-in type subscriptions, so I moved/merged the table up.
• Link to this table.
• I showed default subscriptions for admin and site, I did it with 257 applied.
• I made few edits in other pages I'm targetting.
  • Details a bit more participant types and scopes, opportunity to add PHP API Ref links.
  • Add /from-invite/register to the self registering user permission case.
  • format permission the way (downcase and slash) that seem usual in the rest of the doc.

Checklist

• Text renders correctly
• Text has been checked with vale
• Description metadata is up to date
• Redirects cover removed/moved pages
• Code samples are working
• PHP code samples have been fixed with PHP CS fixer
• Added link to this PR in relevant JIRA ticket or code PR

[github-actions]

Preview of modified files

Preview of modified Markdown:

• docs/api/notification_channels.md
• docs/content_management/collaborative_editing/collaborative_editing_api.md
• docs/permissions/permission_use_cases.md
• docs/users/invitations.md

[github-actions]

Summary

Status	Count
🔍 Total	750745
🔗 Unique	15067
✅ Successful	6307
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	744438
❓ Unknown	0
🚫 Errors	0
⛔ Unsupported	0

Full Github Actions output

[github-actions]

code_samples/ change report

Before (on target branch)	After (in current PR)
code_samples/api/notifications/notification_send.php	code_samples/api/notifications/notification_send.php
docs/api/notification_channels.md@152:``` php hl_lines="11-14" docs/api/notification_channels.md@153:[[= include_code('code_samples/api/notifications/notification_send.php', 2) =]] docs/api/notification_channels.md@154:```	docs/api/notification_channels.md@228:``` php hl_lines="13-16" docs/api/notification_channels.md@229:[[= include_code('code_samples/api/notifications/notification_send.php', 2) =]] docs/api/notification_channels.md@230:```
001⫶use App\Notifications\MyNotification; // extends Symfony\Component\Notifier\Notification\Notification 002⫶use Ibexa\Contracts\Notifications\Value\Notification\SymfonyNotificationAdapter; 003⫶use Ibexa\Contracts\Notifications\Value\Recipent\SymfonyRecipientAdapter; 004⫶use Ibexa\Contracts\Notifications\Value\Recipent\UserRecipient; 005⫶ 006⫶$subject = 'My subject'; 007⫶	001⫶use App\Notifications\MyNotification; // extends Symfony\Component\Notifier\Notification\Notification 002⫶use Ibexa\Contracts\Notifications\Value\Notification\SymfonyNotificationAdapter; 003⫶use Ibexa\Contracts\Notifications\Value\Recipent\SymfonyRecipientAdapter; 004⫶use Ibexa\Contracts\Notifications\Value\Recipent\UserRecipient; 005⫶ 006⫶$subject = 'My subject'; 007⫶
008⫶/** @var \Ibexa\Contracts\Notifications\Service\NotificationServiceInterface $notificationService */ 009⫶/** @var \Ibexa\Contracts\Core\Repository\UserService $userService */ 010⫶/** @var \Ibexa\Contracts\Core\Repository\PermissionResolver $permissionResolver */ 011❇️$notificationService->send( 012❇️ new SymfonyNotificationAdapter(new MyNotification($subject)), 013❇️ [new SymfonyRecipientAdapter(new UserRecipient($userService->loadUser($permissionResolver->getCurrentUserReference()->getUserId())))],	008⫶/** 009⫶ * @var \Ibexa\Contracts\Notifications\Service\NotificationServiceInterface $notificationService 010⫶ * @var \Ibexa\Contracts\Core\Repository\UserService $userService 011⫶ * @var \Ibexa\Contracts\Core\Repository\PermissionResolver $permissionResolver 012⫶ */ 013❇️$notificationService->send( 014❇️ new SymfonyNotificationAdapter(new MyNotification($subject)), 015❇️ [new SymfonyRecipientAdapter(new UserRecipient($userService->loadUser($permissionResolver->getCurrentUserReference()->getUserId())))],

Download colorized diff