Align with changes in plaisio/helper-html.

Author: prwater

composer.json

@@ -9,24 +9,24 @@
   "license": "MIT",
   "require": {
     "php": ">=7.4",
-    "plaisio-ts/helper-cast": "^1.0.0",
+    "plaisio-ts/helper-cast": "^1.0.2",
     "plaisio/cgi": "^1.2.0",
     "plaisio/exception": "^1.1.0",
     "plaisio/flash-message": "dev-master",
-    "plaisio/helper-html": "^3.0.0",
+    "plaisio/helper-html": "^4.0.0",
     "plaisio/kernel": "^3.1.1",
     "plaisio/page-core": "^1.4.2",
     "plaisio/request": "^0.13.0",
-    "plaisio/response-core": "^2.5.0",
+    "plaisio/response-core": "^2.6.0",
     "plaisio/session-core": "^5.1.0",
-    "symfony/polyfill-uuid": "^1.22.0"
+    "symfony/polyfill-uuid": "^1.24.0"
   },
   "minimum-stability": "dev",
   "prefer-stable": true,
   "require-dev": {
     "phing/phing": "^3.0.0-RC3",
-    "phpunit/phpunit": "^9.5.0",
-    "plaisio/console": "^2.4.8",
+    "phpunit/phpunit": "^9.5.11",
+    "plaisio/console": "^2.5.0",
     "plaisio/phing-extensions": "^3.0.0",
     "setbased/phing-extensions": "dev-master"
   },
@@ -42,6 +42,9 @@
   },
   "config": {
     "bin-dir": "bin/",
-    "sort-packages": true
+    "sort-packages": true,
+    "allow-plugins": {
+      "phing/phing-composer-configurator": true
+    }
   }
 }

package.json

@@ -6,7 +6,7 @@
     "jquery": "^3.6.0"
   },
   "devDependencies": {
-    "@types/jquery": "^3.5.8"
+    "@types/jquery": "^3.5.13"
   },
   "repository": {
     "type": "git",

src/CoreFlashMessage.php

@@ -5,6 +5,7 @@
 
 use Plaisio\Helper\Html;
 use Plaisio\Helper\HtmlElement;
+use Plaisio\Helper\RenderWalker;
 
 /**
  * Class for flash messages.
@@ -16,7 +17,7 @@ class CoreFlashMessage implements FlashMessage
 
   //--------------------------------------------------------------------------------------------------------------------
   /**
-   * If true and only true this flash message must be dismissed automatically.
+   * Whether this flash message must be dismissed automatically.
    *
    * @var bool
    */
@@ -30,8 +31,7 @@ class CoreFlashMessage implements FlashMessage
   protected string $message;
 
   /**
-   * If true and only true this flash message is shown isOnce and removed automatically from the list of flash
-   * messages.
+   * Whether this flash message is shown once and removed automatically from the list of flash messages.
    *
    * @var bool
    */
@@ -62,8 +62,6 @@ class CoreFlashMessage implements FlashMessage
   public function __construct(string $message, bool $isHtml = false)
   {
     $this->message = ($isHtml) ? $message : Html::txt2Html($message);
-
-    $this->addClass('flash-message');
   }
 
   //--------------------------------------------------------------------------------------------------------------------
@@ -74,14 +72,19 @@ public function __construct(string $message, bool $isHtml = false)
    */
   public function getHtml(): string
   {
+    $walker = new RenderWalker('flash-message');
     $this->setAttrData('auto-dismiss', ($this->autoDismiss) ? '1' : null);
+    $this->addClasses($walker->getClasses('wrapper'));
 
-    $html = Html::generateTag('div', $this->attributes);
-    $html .= $this->message;
-    $html .= '<button type="button" class="close">&times;</button>';
-    $html .= '</div>';
+    $struct = ['tag'   => 'div',
+               'attr'  => $this->attributes,
+               'inner' => [['html' => $this->message],
+                           ['tag'  => 'button',
+                            'attr' => ['class' => $walker->getClasses('close'),
+                                       'type'  => 'button'],
+                            'html' => '&times;']]];
 
-    return $html;
+    return Html::htmlNested($struct);
   }
 
   //--------------------------------------------------------------------------------------------------------------------
@@ -126,7 +129,7 @@ public function isOnce(): bool
   /**
    * Sets whether this flash message must be dismissed automatically.
    *
-   * @param bool $autoDismiss If true if and only if this flash messages must dismissed automatically.
+   * @param bool $autoDismiss Whether this flash message must be dismissed automatically.
    *
    * @return CoreFlashMessage
    */
@@ -139,10 +142,10 @@ public function setAutoDismiss(bool $autoDismiss): CoreFlashMessage
 
   //--------------------------------------------------------------------------------------------------------------------
   /**
-   * Sets whether this flash message must be shown once only.
+   * Sets whether this flash message is shown once and removed automatically from the list of flash messages.
    *
-   * @param bool $once If true and only true this flash message is shown isOnce and removed automatically from the
-   *                   list of flash messages.
+   * @param bool $once Whether this flash message is shown once and removed automatically from the list of flash
+   *                   messages.
    *
    * @return CoreFlashMessage
    */

src/CoreFlashMessageCollection.php

@@ -3,6 +3,7 @@
 
 namespace Plaisio\FlashMessage;
 
+use Plaisio\Helper\Html;
 use Plaisio\PlaisioInterface;
 use Plaisio\PlaisioObject;
 use Plaisio\Session\Session;
@@ -132,17 +133,18 @@ public function getHtml(): string
   {
     $this->sortFlashMessages();
 
-    $html = '<div class="flash-messages">';
-
+    $inner = '';
     if (!empty($this->flashMessages))
     {
       foreach ($this->flashMessages as $flashMessage)
       {
-        $html .= $flashMessage->getHtml();
+        $inner .= $flashMessage->getHtml();
       }
     }
 
-    $html .= '</div>';
+    $html = Html::htmlNested(['tag'  => 'div',
+                              'attr' => ['class' => 'flash-messages'],
+                              'html' => $inner]);
 
     $this->cleanFlashMessages();
 

test/CoreFlashMessageTest.php

@@ -38,7 +38,7 @@ public function testGetHtml1(): void
     $html         = $flashMessage->setAttrId('123456')
                                  ->addClass('first')
                                  ->getHtml();
-    $expected     = '<div class="first flash-message" id="123456">Hello &amp; world!<button type="button" class="close">&times;</button></div>';
+    $expected     = '<div id="123456" class="first flash-message-wrapper">Hello &amp; world!<button class="flash-message-close" type="button">&times;</button></div>';
     self::assertSame($expected, $html);
   }
 
@@ -52,7 +52,7 @@ public function testGetHtml2(): void
     $html         = $flashMessage->setAttrId('123456')
                                  ->addClass('first')
                                  ->getHtml();
-    $expected     = '<div class="first flash-message" id="123456">Hello<br/>world!<button type="button" class="close">&times;</button></div>';
+    $expected     = '<div id="123456" class="first flash-message-wrapper">Hello<br/>world!<button class="flash-message-close" type="button">&times;</button></div>';
     self::assertSame($expected, $html);
   }
 

www/css/Plaisio/FlashMessage/CoreFlashMessageManager.css

@@ -6,7 +6,7 @@
   width:    100%;
 }
 
-.flash-message
+.flash-message-wrapper
 {
   position:   relative;
   display:    none;
@@ -15,7 +15,7 @@
   border:     1px solid transparent;
 }
 
-.flash-message .close
+.flash-message-close
 {
   position:         absolute;
   top:              0;
@@ -27,14 +27,14 @@
   background-color: transparent;
 }
 
-.flash-message .close:hover
+.flash-message-close:hover
 {
   text-decoration: none;
   color:           #000000;
 }
 
-.flash-message .close:hover,
-.flash-message .close:focus
+.flash-message-close:hover,
+.flash-message-close:focus
 {
   font-weight: 700;
 }

www/js/Plaisio/FlashMessage/CoreFlashMessageCollection.ts

@@ -38,7 +38,7 @@ export class CoreFlashMessageCollection
 
     const that = this;
 
-    this.$flashMessage.find('button.close').on('click', function ()
+    this.$flashMessage.find('button.flash-message-close').on('click', function ()
     {
       that.close();
     });