Add modified query examples

Author: dabrt

code_samples/back_office/notifications/src/Notification/ListRenderer.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Notification;
+
+use Ibexa\Contracts\Core\Repository\Values\Notification\Notification;
+use Ibexa\Core\Notification\Renderer\NotificationRenderer;
+use Symfony\Component\HttpFoundation\RequestStack;
+use Symfony\Component\Routing\RouterInterface;
+use Twig\Environment;
+
+class ListRenderer implements NotificationRenderer
+{
+    protected Environment $twig;
+
+    protected RouterInterface $router;
+
+    protected RequestStack $requestStack;
+
+    public function __construct(Environment $twig, RouterInterface $router, RequestStack $requestStack)
+    {
+        $this->twig = $twig;
+        $this->router = $router;
+        $this->requestStack = $requestStack;
+    }
+
+    public function render(Notification $notification): string
+    {
+        $templateToExtend = '@ibexadesign/account/notifications/list_item.html.twig';
+        $currentRequest = $this->requestStack->getCurrentRequest();
+        if ($currentRequest && $currentRequest->attributes->getBoolean('render_all')) {
+            $templateToExtend = '@ibexadesign/account/notifications/list_item_all.html.twig';
+        }
+        return $this->twig->render('@ibexadesign/notification.html.twig', [
+            'notification' => $notification,
+            'template_to_extend' => $templateToExtend,
+        ]);
+    }
+    
+    public function generateUrl(Notification $notification): ?string
+    {
+        if (array_key_exists('content_id', $notification->data)) {
+            return $this->router->generate('ibexa.content.view', [
+                'contentId' => $notification->data['content_id'],
+            ]);
+        }
+        return null;
+    }
+}

code_samples/notifications/Src/Query/search.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+use DateTimeImmutable;
+use Ibexa\Contracts\Core\Repository\Values\Notification\Query\Criterion;
+use Ibexa\Contracts\Core\Repository\Values\NotificationQuery;
+
+$repository = $this->getRepository();
+$notificationService = $repository->getNotificationService();
+$query = new NotificationQuery([], 0, 25);
+
+$query->addCriterion(new Type('Workflow:Review'));
+$query->addCriterion(new Status(['unread']));
+
+$from = new \DateTimeImmutable('-7 days');
+$to = new \DateTimeImmutable();
+
+$query->addCriterion(new DateCreated($from, $to));
+
+$notificationList = $notificationService->findNotifications($query);

docs/administration/back_office/notifications.md

@@ -63,7 +63,9 @@ Example:
 [[= include_file('code_samples/back_office/notifications/src/EventListener/ContentPublishEventListener.php') =]]
 ```
 
-To display the notification, write a renderer and tag it as a service.
+### Display single notification
+
+To display a single notification, write a renderer and tag it as a service.
 
 The example below presents a renderer that uses Twig to render a view:
 
@@ -83,6 +85,18 @@ Finally, you need to add an entry to `config/services.yaml`:
 [[= include_file('code_samples/back_office/notifications/config/custom_services.yaml') =]]
 ```
 
+### Display notification list
+
+To display a list of notifications, expand the above renderer.
+
+The example below presents a modified renderer that uses Twig to render a list view:
+
+```php
+[[= include_file('code_samples/back_office/notifications/src/Notification/ListRenderer.php') =]]
+```
+
+Then, add the templates that are defined above as a response to `render_all` request:
+
 ## Notification timeout
 
 To define the timeout for hiding Back-Office notification bars, per notification type, use the `ibexa.system.<scope>.notifications.<notification_type>.timeout` [configuration key](configuration.md#configuration-files):

docs/search/criteria_reference/notification_datecreated_criterion.md

@@ -16,11 +16,6 @@ The `DateCreated` Search Criterion searches for notifications based on the date
 
 ### PHP
 
-``` php
-$criteria = new Ibexa\Contracts\Core\Repository\Values\Notification\Query\Criterion\DateCreated(
-    new DateTime('2023-03-01 14:07:02'),
-    'GTE'
-);
-
-$query = new NotificationQuery($criteria);
+```php hl_lines="19"
+[[= include_file('code_samples/notifications/src/Query/Search.php') =]]
 ```

docs/search/criteria_reference/notification_status_criterion.md

@@ -15,8 +15,6 @@ The `Status` Search Criterion searches for notifications based on notification s
 
 ### PHP
 
-``` php
-$criteria = new Ibexa\Contracts\Core\Repository\Values\Notification\Query\Criterion\(0);
-
-$query = new NotificationQuery($criteria);
+```php hl_lines="14"
+[[= include_file('code_samples/notifications/src/Query/Search.php') =]]
 ```

docs/search/criteria_reference/notification_type_criterion.md

@@ -15,8 +15,6 @@ The `Type` Search Criterion searches for notifications by their types.
 
 ### PHP
 
-``` php
-$criteria = new Ibexa\Contracts\Core\Repository\Values\Notification\Query\Criterion\Type('Workflow:Reject');
-
-$query = new NotificationQuery($criteria);
+```php hl_lines="13"
+[[= include_file('code_samples/notifications/src/Query/Search.php') =]]
 ```