Introduce PrimaryButtonDecorator

Author: sukhwinder33445

src/Compat/CompatForm.php

@@ -13,6 +13,7 @@
 use ipl\Html\HtmlDocument;
 use ipl\Html\HtmlString;
 use ipl\I18n\Translation;
+use ipl\Web\Compat\FormDecorator\PrimaryButtonDecorator;
 use ipl\Web\FormDecorator\IcingaFormDecorator;
 use ipl\Web\Compat\FormDecorator\LabelDecorator;
 
@@ -42,8 +43,12 @@ public function applyDefaultElementDecorators(): static
             ['ipl\\Web\\Compat\\FormDecorator', 'Decorator']
         ]);
 
-        $this->getDecorators()->addDecorator('Required', LabelDecorator::class, [
-            'uniqueName' => fn(string $name) => Icinga::app()->getRequest()->protectId($name)
+        $this->getDecorators()->addDecorators([
+            'PrimaryButton' => new PrimaryButtonDecorator(),
+            'Required' => [
+                'name' => LabelDecorator::class,
+                'options' => ['uniqueName' => fn(string $name) => Icinga::app()->getRequest()->protectId($name)]
+            ]
         ]);
 
         $this->setDefaultElementDecorators([

src/Compat/FormDecorator/PrimaryButtonDecorator.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace ipl\Web\Compat\FormDecorator;
+
+use ipl\Html\Attribute;
+use ipl\Html\Contract\DecorationResult;
+use ipl\Html\Contract\Form;
+use ipl\Html\Contract\FormDecoration;
+use ipl\Html\Contract\FormSubmitElement;
+
+class PrimaryButtonDecorator implements FormDecoration
+{
+    public function decorateForm(DecorationResult $result, Form $form): void
+    {
+        foreach ($form->getElements() as $element) {
+            if ($element instanceof FormSubmitElement) {
+                $element->getAttributes()->addAttribute(new Attribute('class', 'btn-primary'));
+            }
+        }
+    }
+}

tests/Compat/CompatFormTest.php

@@ -314,7 +314,7 @@ public function testFormControlsDecoration(): void
         $expected = <<<'HTML'
     <form class="icinga-form icinga-controls" method="POST">
         <div class="control-group form-controls">
-            <input name="foo" type="submit" value="Submit Form"/>
+            <input name="foo" type="submit" class="btn-primary" value="Submit Form"/>
         </div>
     </form>
 HTML;
@@ -378,7 +378,7 @@ public function testMethodApplyDefaultElementDecorators(): void
         <span class="sr-only" id="desc_fooBar-id">Fieldset Description</span>
       </div>
       <div class="control-group form-controls">
-        <input name="submit_form" type="submit" value="Submit Form"/>
+        <input name="submit_form" type="submit" class="btn-primary" value="Submit Form"/>
       </div>
     </form>
 HTML;

tests/Compat/FormDecorator/PrimaryButtonDecoratorTest.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace ipl\Tests\Web\Compat\FormDecorator;
+
+use ipl\Html\FormDecoration\FormElementDecorationResult;
+use ipl\Tests\Web\TestCase;
+use ipl\Web\Compat\CompatForm;
+use ipl\Web\Compat\FormDecorator\PrimaryButtonDecorator;
+
+class PrimaryButtonDecoratorTest extends TestCase
+{
+    protected PrimaryButtonDecorator $decorator;
+
+    public function setUp(): void
+    {
+        $this->decorator = new PrimaryButtonDecorator();
+    }
+
+    public function testEveryButtonIsMarkedAsPrimaryButton(): void
+    {
+        $form = (new CompatForm())
+            ->addElement('submit','btn-1')
+            ->addElement('submit', 'btn-2', ['class' => 'test'])
+            ->addElement('submit', 'btn-3', ['class' => 'btn-remove'])
+            ->addElement('submit', 'btn-4', ['class' => 'btn-primary']);
+
+        $this->decorator->decorateForm(new FormElementDecorationResult(), $form);
+
+        $this->assertSame(
+            'class="btn-primary"',
+            $form->getElement('btn-1')->getAttributes()->get('class')->render()
+        );
+
+        $this->assertSame(
+            'class="test btn-primary"',
+            $form->getElement('btn-2')->getAttributes()->get('class')->render()
+        );
+
+        $this->assertSame(
+            'class="btn-remove btn-primary"',
+            $form->getElement('btn-3')->getAttributes()->get('class')->render()
+        );
+
+        $this->assertSame(
+            'class="btn-primary btn-primary"',
+            $form->getElement('btn-4')->getAttributes()->get('class')->render()
+        );
+    }
+
+    public function testElementsOtherThanSubmitButtonsAreIgnored(): void
+    {
+        $form = (new CompatForm())
+            ->addElement('text', 'username', ['class' => 'test'])
+            ->addElement('password', 'pwd', ['class' => 'test']);
+
+        $this->decorator->decorateForm(new FormElementDecorationResult(), $form);
+
+        $this->assertSame('class="test"', $form->getElement('username')->getAttributes()->get('class')->render());
+        $this->assertSame('class="test"', $form->getElement('pwd')->getAttributes()->get('class')->render());
+    }
+}