Add the possibility to add a custom sentence to the footer instead the configured app name

- Add the possibility of adding a custom sentence to the footer instead the configured app name
- Updating PHPDocs
- Adding some tests
- Update the readme

Author: Devonab

README.md

@@ -20,6 +20,7 @@ This filament Plugin provides an easy and flexible way to add a customizable foo
 - [Usage](#usage)
 - [Configurations](#configurations)
     - [Footer position](#footer-position)
+    - [Custom sentence](#custom-sentence)
     - [Show GitHub version](#show-github-version)
     - [Show load time](#load-time)
     - [Custom logo with link](#custom-logo-with-link)
@@ -135,6 +136,37 @@ use Devonab\FilamentEasyFooter\EasyFooterPlugin;
 ```
 ![Filament Easy Footer sidebar footer position](./art/position_sidebar_footer.webp)
 
+### Custom sentence
+![Filament Easy Footer custom sentence](./art/custom_sentence.webp)
+
+By default, the plugin will display the name of your application (configured from your .ENV) next to the copyright. You can change the phrase by publishing the plugin configuration file.
+
+If you prefer a more personalized approach, you can use the following method:
+
+```php
+use Devonab\FilamentEasyFooter\EasyFooterPlugin;
+
+->plugins([
+    EasyFooterPlugin::make()
+    ->withSentence('your sentence'),
+])
+```
+
+The method accepts a string or HTMLString as a parameter.
+With this, you can get the result you want. For example, for the result shown in the image above :
+
+```php
+use Devonab\FilamentEasyFooter\EasyFooterPlugin;
+
+->plugins([
+    EasyFooterPlugin::make()
+    ->withSentence(new HtmlString('<img src="https://static.cdnlogo.com/logos/l/23/laravel.svg" style="margin-right:.5rem;" alt="Laravel Logo" width="20" height="20"> Laravel'))
+,
+])
+```
+The authorized tags are as follows: `<strong><img><em><span><b><i><small>`.
+
+
 ### Show GitHub version
 ![Filament Easy Footer github](./art/github_version.webp)
 

art/custom_sentence.webp

@@ -35,7 +35,17 @@
         } => $footerPosition === 'footer',
     ])
 >
-    <span>&copy; {{ now()->format('Y') }} - {{ config('filament-easy-footer.app_name') }}</span>
+    <span @class(['flex gap-2' => $isHtmlSentence])>&copy; {{ now()->format('Y') }} -
+        @if($sentence)
+            @if($isHtmlSentence)
+                <span class="flex">{!! $sentence !!}</span>
+            @else
+                {{ $sentence }}
+            @endif
+        @else
+            {{ config('filament-easy-footer.app_name') }}
+        @endif
+    </span>
 
     @if($githubEnabled)
         <livewire:devonab.filament-easy-footer.github-version

resources/views/easy-footer.blade.php

@@ -5,6 +5,7 @@
 use Devonab\FilamentEasyFooter\Services\GitHubService;
 use Filament\Contracts\Plugin;
 use Filament\Panel;
+use Illuminate\Support\HtmlString;
 
 class EasyFooterPlugin implements Plugin
 {
@@ -26,6 +27,9 @@ class EasyFooterPlugin implements Plugin
 
     protected ?string $loadTimePrefix = null;
 
+    protected ?string $sentence = null;
+    protected bool $isHtmlSentence = false;
+
     protected string $footerPosition = 'footer';
 
     protected array $links = [];
@@ -98,6 +102,8 @@ protected function renderFooter(float $startTime): string
             'loadTime' => $this->loadTimeEnabled ? $this->calculateLoadTime($startTime) : false,
             'loadTimePrefix' => $this->loadTimePrefix,
             'links' => $this->links,
+            'sentence' => $this->sentence,
+            'isHtmlSentence' => $this->isHtmlSentence
         ])->render();
     }
 
@@ -227,6 +233,24 @@ public function withLogo(string $path, ?string $url = null, int $height = 20): s
         return $this;
     }
 
+    /**
+     *  Set a custom sentence that replaces the app name in the copyright text
+     *  Only allows basic HTML tags for text formatting
+     *
+     * @param string|HtmlString $sentence Custom text or HTML to display
+     * @return static
+     */
+    public function withSentence(string|HtmlString $sentence): static
+    {
+        if ($sentence instanceof HtmlString) {
+            $sentence = $sentence->toHtml();
+            $this->isHtmlSentence = true;
+        }
+
+        $this->sentence = strip_tags($sentence, '<strong><img><em><span><b><i><small>');
+        return $this;
+    }
+
     /**
      * Check if load time is enabled
      */
@@ -275,6 +299,24 @@ public function getLogoHeight(): int
         return $this->logoHeight;
     }
 
+    /**
+     * Get the current sentence
+     * @return string|null
+     */
+    public function getSentence(): ?string
+    {
+        return $this->sentence;
+    }
+
+    /**
+     * Check if the sentence is HTML
+     * @return bool
+     */
+    public function isHtmlSentence(): bool
+    {
+        return $this->isHtmlSentence;
+    }
+
     /**
      * Boot the plugin
      */

src/EasyFooterPlugin.php

@@ -2,6 +2,7 @@
 
 use Devonab\FilamentEasyFooter\EasyFooterPlugin;
 use Illuminate\Http\Request;
+use Illuminate\Support\HtmlString;
 
 it('has correct plugin ID')
     ->expect(fn () => EasyFooterPlugin::make()->getId())
@@ -105,6 +106,33 @@
         ]);
 });
 
+it('can set plain text sentence', function () {
+    $plugin = EasyFooterPlugin::make()
+        ->withSentence('Custom Footer Text');
+
+    expect($plugin->getSentence())->toBe('Custom Footer Text');
+});
+
+it('allows safe HTML tags', function () {
+    $plugin = EasyFooterPlugin::make()
+        ->withSentence(new HtmlString('<strong>Custom</strong> <em>Footer</em> Text'));
+
+    expect($plugin->getSentence())->toBe('<strong>Custom</strong> <em>Footer</em> Text');
+});
+
+it('strips unsafe HTML tags but keeps content', function () {
+    $plugin = EasyFooterPlugin::make()
+        ->withSentence(new HtmlString('<script>alert("I\'m a hacker yiek yiek")</script><strong>Safe</strong>'));
+
+    expect($plugin->getSentence())->toBe('alert("I\'m a hacker yiek yiek")<strong>Safe</strong>');
+});
+
+it('defaults to null sentence', function () {
+    $plugin = EasyFooterPlugin::make();
+
+    expect($plugin->getSentence())->toBeNull();
+});
+
 test('make creates new instance')
     ->expect(fn () => EasyFooterPlugin::make())
     ->toBeInstanceOf(EasyFooterPlugin::class);