Merge pull request #139 from sumocoders/page-title-service

Add page title service to generate pagetitle based on the breadcrumbs

Author: Bjorn Van Acker

config/services.php

@@ -4,6 +4,8 @@
 
 use SumoCoders\FrameworkCoreBundle\Command\SecretsGetCommand;
 use SumoCoders\FrameworkCoreBundle\Command\TranslateCommand;
+use SumoCoders\FrameworkCoreBundle\EventListener\TitleListener;
+use SumoCoders\FrameworkCoreBundle\Service\PageTitle;
 use SumoCoders\FrameworkCoreBundle\Twig\ContentExtension;
 use Symfony\Component\Form\Extension\Core\Type\TimeType;
 use SumoCoders\FrameworkCoreBundle\Service\Fallbacks;
@@ -40,71 +42,71 @@
          * Services
          */
         ->set('framework.fallbacks', Fallbacks::class)
-            ->args([
-                param('fallbacks')
-            ])
+        ->args([
+            param('fallbacks')
+        ])
 
         /*
          * Menu
          */
         ->set('framework.menu_builder', MenuBuilder::class)
-            ->args([
-                service('knp_menu.factory'),
-                service('event_dispatcher')
-            ])
-            ->tag('knp_menu.menu_builder', ['method' => 'createMainMenu', 'alias' => 'side_menu'])
+        ->args([
+            service('knp_menu.factory'),
+            service('event_dispatcher')
+        ])
+        ->tag('knp_menu.menu_builder', ['method' => 'createMainMenu', 'alias' => 'side_menu'])
 
         /*
          * Forms
          */
         ->set('framework.date_type_extension', DateTypeExtension::class)
-            ->tag('form.type_extension', ['extended_type' => DateType::class])
+        ->tag('form.type_extension', ['extended_type' => DateType::class])
 
         ->set('framework.time_type_extension', TimeTypeExtension::class)
-            ->tag('form.type_extension', ['extended_type' => TimeType::class])
+        ->tag('form.type_extension', ['extended_type' => TimeType::class])
 
         ->set('framework.date_time_type_extension', DateTimeTypeExtension::class)
-            ->tag('form.type_extension', ['extended_type' => DateTimeType::class])
+        ->tag('form.type_extension', ['extended_type' => DateTimeType::class])
 
         ->set('framework.birthday_type_extension', BirthdayTypeExtension::class)
-            ->tag('form.type_extension', ['extended_type' => BirthdayType::class])
+        ->tag('form.type_extension', ['extended_type' => BirthdayType::class])
 
         ->set('framework.collection_type_extension', CollectionTypeExtension::class)
-            ->tag('form.type_extension', ['extended_type' => CollectionType::class])
+        ->tag('form.type_extension', ['extended_type' => CollectionType::class])
 
         ->set('framework.image_type', ImageType::class)
-            ->tag('form.type', ['alias' => 'image'])
+        ->tag('form.type', ['alias' => 'image'])
 
         ->set('framework.file_type', FileType::class)
-            ->tag('form.type', ['alias' => 'sumoFile'])
+        ->tag('form.type', ['alias' => 'sumoFile'])
 
         /*
          * Secure headers
          */
         ->set('framework.response_securer', ResponseSecurer::class)
-            ->args([
-                param('kernel.debug'),
-                param('sumo_coders_framework_core.content_security_policy'),
-                param('sumo_coders_framework_core.extra_content_security_policy'),
-                param('sumo_coders_framework_core.x_frame_options'),
-                param('sumo_coders_framework_core.x_content_type_options'),
-            ])
-            ->tag('kernel.event_listener', ['event' => 'kernel.response', 'method' => 'onKernelResponse'])
+        ->args([
+            param('kernel.debug'),
+            param('sumo_coders_framework_core.content_security_policy'),
+            param('sumo_coders_framework_core.extra_content_security_policy'),
+            param('sumo_coders_framework_core.x_frame_options'),
+            param('sumo_coders_framework_core.x_content_type_options'),
+        ])
+        ->tag('kernel.event_listener', ['event' => 'kernel.response', 'method' => 'onKernelResponse'])
 
         /*
          * Twig extensions
          */
         ->set('framework.framework_extension', FrameworkExtension::class)
-            ->tag('twig.extension')
+        ->tag('twig.extension')
 
         ->set('framework.paginator_extension', PaginatorExtension::class)
-            ->tag('twig.extension')
+        ->tag('twig.extension')
 
         ->set('framework.paginator_runtime', PaginatorRuntime::class)
-            ->tag('twig.runtime')
+        ->tag('twig.runtime')
 
         ->set('framework.content_extension', ContentExtension::class)
-            ->tag('twig.extension')
+        ->tag('twig.extension')
 
         /*
          * Breadcrumbs
@@ -113,24 +115,50 @@
         ->alias(BreadcrumbTrail::class, 'framework.breadcrumb_trail')
 
         ->set('framework.breadcrumb_listener', BreadcrumbListener::class)
-            ->tag(
-                'kernel.event_listener',
-                [
-                    'event' => 'kernel.controller',
-                    'method' => 'onKernelController',
-                    'priority' => -1
-                ]
-            )
+        ->tag(
+            'kernel.event_listener',
+            [
+                'event' => 'kernel.controller',
+                'method' => 'onKernelController',
+                'priority' => -1
+            ]
+        )
+
+        ->set('framework.title_listener', TitleListener::class)
+        ->args([
+            service('framework.page_title'),
+            service('framework.fallbacks'),
+            service('router')
+        ])
+        ->tag(
+            'kernel.event_listener',
+            [
+                'event' => 'kernel.controller',
+                'method' => 'onKernelController',
+                'priority' => -1
+            ]
+        )
+
+        /*
+         * Page title
+         */
+        ->set('framework.page_title', PageTitle::class)
+        ->args([
+            service('framework.breadcrumb_trail'),
+            service('framework.fallbacks'),
+            service('translator')
+        ])
+        ->alias(PageTitle::class, 'framework.page_title')
 
         /*
          * Commands
          */
         ->set(TranslateCommand::class)
-            ->tag('console.command')
+        ->tag('console.command')
 
         ->set(SecretsGetCommand::class)
-            ->args([
-                service('secrets.vault')
-            ])
-            ->tag('console.command');
+        ->args([
+            service('secrets.vault')
+        ])
+        ->tag('console.command');
 };

docs/development/title.md

@@ -0,0 +1,57 @@
+# The page title
+By default no page title should be set. This is because by default the `fallback.site_title` is used. This is a configuration value that can be set in the `services.yaml` file.
+In case there are breadcrumbs configured, the reverse order of the breadcrumbs will be used as the page title.
+
+## The `Title` attribute
+
+The `Title` attribute is a custom attribute used in the framework. It is used to set the title of a page dynamically based on the controller method that is being executed. Here's a step-by-step guide on how to use it:
+
+1. Import the `Title` attribute at the top of your controller file:
+
+```php
+use SumoCoders\FrameworkCoreBundle\Attribute\Title;
+```
+
+2. Apply the `Title` attribute to a controller method. The `Title` attribute takes a string as its first argument, which is the title you want to set for the page when this method is executed.
+
+```php
+#[Title('My Page Title')]
+public function myMethod()
+{
+    // Your code here
+}
+```
+
+3. If you want the title to be extended with the parent's title, you can pass a second argument to the `Title` attribute. This argument should be an array with a `name` key that corresponds to the route name of the parent.
+
+```php
+#[Title('My Page Title', ['name' => 'parent_route'])]
+public function myMethod()
+{
+    // Your code here
+}
+```
+
+4. If you want to prevent the title from being extended with the parent's title, you can pass a third argument to the `Title` attribute. This argument should be a boolean that indicates whether the title should be extended (`true`) or not (`false`).
+
+```php
+#[Title('My Page Title', ['name' => 'parent_route'], false)]
+public function myMethod()
+{
+    // Your code here
+}
+```
+
+5. The `Title` attribute can also handle dynamic titles. If you want to include a parameter in the title, you can do so by including it in curly braces `{}` in the title string. The parameter should be available in the request attributes.
+
+```php
+#[Title('My Page Title for {id}')]
+public function myMethod($id)
+{
+    // Your code here
+}
+```
+
+6. The `TitleListener` class will automatically handle the `Title` attribute. It listens to the kernel controller event, fetches the `Title` attribute from the controller method being executed, and sets the page title accordingly.
+
+Remember to clear the Symfony cache after adding or changing attributes, as Symfony compiles and caches the attributes when the cache is built. You can clear the cache by running `bin/console cache:clear` in your terminal.

src/Attribute/Title.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace SumoCoders\FrameworkCoreBundle\Attribute;
+
+use Attribute;
+use SumoCoders\FrameworkCoreBundle\ValueObject\Route;
+
+#[Attribute(Attribute::TARGET_METHOD)]
+final class Title
+{
+    private string $title;
+    private ?Route $parent;
+
+    private bool $extend = true;
+
+    public function __construct(
+        string $title,
+        ?array $parent = null,
+        $extend = true,
+    ) {
+        $this->title = $title;
+
+        if ($parent !== null) {
+            $this->parent = new Route(
+                $parent['name'],
+                \array_key_exists('parameters', $parent) ? $parent['parameters'] : null
+            );
+        } else {
+            $this->parent = $parent;
+        }
+    }
+
+    public function getTitle(): ?string
+    {
+        return $this->title;
+    }
+
+    public function isExtend(): bool
+    {
+        return $this->extend;
+    }
+
+    public function hasParent(): bool
+    {
+        return $this->parent !== null;
+    }
+
+    public function getParent(): ?Route
+    {
+        return $this->parent;
+    }
+}