Update README.md, composer.json, and PHPStan configuration; enhance contact form layout and functionality. (#90)

terabytesoftw · web-flow · commit 6e16572a19d8 · 2025-06-09T17:28:41.000-04:00
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -27,4 +27,4 @@ jobs:
       os: >-
         ['ubuntu-latest', 'windows-latest']
       php: >-
-        ['8.2', '8.3', '8.4']
+        ['8.1', '8.2', '8.3', '8.4']
diff --git a/.github/workflows/dependency-check.yml b/.github/workflows/dependency-check.yml
@@ -26,4 +26,4 @@ jobs:
       os: >-
         ['ubuntu-latest']
       php: >-
-        ['8.2']
+        ['8.4']
diff --git a/.github/workflows/ecs.yml b/.github/workflows/ecs.yml
@@ -25,4 +25,4 @@ jobs:
       os: >-
         ['ubuntu-latest']
       php: >-
-        ['8.2']
+        ['8.4']
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -18,12 +18,12 @@ on:
 name: static analysis
 
 jobs:
-  psalm:
+  phpstan:
     uses: php-forge/actions/.github/workflows/phpstan.yml@main
     secrets:
       AUTH_TOKEN: ${{ secrets.AUTH_TOKEN }}
     with:
       os: >-
         ['ubuntu-latest']
       php: >-
-        ['8.2']
+        ['8.1', '8.2', '8.3', '8.4']
diff --git a/README.md b/README.md
@@ -148,7 +148,7 @@ Root directory
 
 ## Quality code
 
-[![phpstan-level](https://img.shields.io/badge/PHPStan%20level-5-blue)](https://github.com/yii2-extensions/app-basic/actions/workflows/static.yml)
+[![phpstan-level](https://img.shields.io/badge/PHPStan%20level-9-blue)](https://github.com/yii2-extensions/app-basic/actions/workflows/static.yml)
 [![StyleCI](https://github.styleci.io/repos/698621511/shield?branch=main)](https://github.styleci.io/repos/698621511?branch=main)
 
 ## Tests
diff --git a/composer.json b/composer.json
@@ -12,12 +12,12 @@
     "minimum-stability": "dev",
     "prefer-stable": true,
     "require": {
-        "php": ">=8.2",
+        "php": ">=8.1",
         "php-forge/foxy": "^0.1",
         "ui-awesome/html": "^0.3",
         "ui-awesome/html-component-bootstrap5": "^1.0@dev",
         "ui-awesome/html-svg":"^0.2",
-        "yii2-extensions/localeurls": "dev-main",
+        "yii2-extensions/localeurls": "^0.1.0",
         "yiisoft/config": "^1.4",
         "yiisoft/yii2": "22.0.x-dev",
         "yiisoft/yii2-bootstrap5": "22.x-dev",
@@ -32,11 +32,13 @@
         "codeception/module-yii2": "^1.1",
         "codeception/verify": "^3.0",
         "maglnet/composer-require-checker": "^4.6",
-        "phpstan/phpstan": "^2.1",
+        "phpstan/extension-installer": "^1.4",
+        "phpstan/phpstan-strict-rules": "^2.0.3",
         "rector/rector": "^2.0",
         "symfony/browser-kit": "^6.3",
         "symfony/process": "^6.3",
         "symplify/easy-coding-standard": "^12.3",
+        "yii2-extensions/phpstan": "^0.2.3",
         "yiisoft/yii2-debug": "22.x-dev",
         "yiisoft/yii2-gii": "22.x-dev"
     },
@@ -62,7 +64,8 @@
             "yiisoft/yii2-composer": true,
             "composer/installers": true,
             "yiisoft/config": true,
-            "php-forge/foxy": true
+            "php-forge/foxy": true,
+            "phpstan/extension-installer": true
         }
     },
     "scripts": {
diff --git a/docs/contact.png b/docs/contact.png
diff --git a/phpstan.neon b/phpstan.neon
@@ -2,20 +2,7 @@ parameters:
     bootstrapFiles:
         - tests/_bootstrap.php
 
-    dynamicConstantNames:
-        - YII_DEBUG
-        - YII_ENV
-        - YII_ENV_DEV
-        - YII_ENV_PROD
-        - YII_ENV_TEST
-
-    level: 5
+    level: 9
 
     paths:
         - src
-
-    scanFiles:
-        - vendor/yiisoft/yii2/Yii.php
-
-    excludePaths:
-        - vendor/**
diff --git a/src/framework/asset/AppAsset.php b/src/framework/asset/AppAsset.php
@@ -4,7 +4,7 @@
 
 namespace app\framework\asset;
 
-use yii\bootstrap5\{BootstrapAsset, BootstrapPluginAsset};
+use yii\bootstrap5\{BootstrapAsset, BootstrapIconAsset, BootstrapPluginAsset};
 use yii\web\{AssetBundle, YiiAsset};
 
 final class AppAsset extends AssetBundle
@@ -17,6 +17,7 @@ final class AppAsset extends AssetBundle
 
     public $depends = [
         BootstrapAsset::class,
+        BootstrapIconAsset::class,
         BootstrapPluginAsset::class,
         YiiAsset::class,
     ];
diff --git a/src/framework/event/ContactEventHandler.php b/src/framework/event/ContactEventHandler.php
@@ -7,26 +7,25 @@
 use app\usecase\contact\{ContactEvent, IndexAction};
 use Yii;
 use yii\base\{BootstrapInterface, Event};
-use yii\web\Application;
 
 final class ContactEventHandler implements BootstrapInterface
 {
-    /**
-     * @param Application $app
-     */
     public function bootstrap($app): void
     {
         Event::on(
             IndexAction::class,
             ContactEvent::EVENT_AFTER_SEND,
             static function () use ($app): void {
-                $app->session->setFlash(
-                    'success',
-                    Yii::t(
-                        'app.basic',
-                        'Thank you for contacting us. We will respond to you as soon as possible.',
-                    ),
+                $title = Yii::t(
+                    'app.basic',
+                    'Message sent successfully!.',
                 );
+                $message = Yii::t(
+                    'app.basic',
+                    'Thank you for contacting us. We will respond to you as soon as possible.',
+                );
+
+                $app->session->setFlash('success', "{$title}<br>{$message}");
             },
         );
     }
diff --git a/src/framework/resource/css/site.css b/src/framework/resource/css/site.css
@@ -1,13 +1,8 @@
 /**
- * site.css
- *
  * Css web application basic
  */
 
-/**********************************************************************************************************************
- * MAIN                                                                                                               *
- **********************************************************************************************************************/
- :root {
+:root {
     --input-padding-x: .75rem;
     --input-padding-y: .75rem;
 }
@@ -26,11 +21,30 @@ html, body {
 	height: 100vh;
 }
 
-/**********************************************************************************************************************
- * BREADCRUMBS                                                                                                        *
- **********************************************************************************************************************/
 .breadcrumb > li + li:before {
-    color: #7c8695;
+    color: var(--bs-tertiary-color);
     content: "/\00a0";
     padding: 0 5px;
 }
+
+[data-bs-theme=light] .contact-title {
+    color: var(--bs-body-color);
+}
+
+[data-bs-theme=dark] .contact-title {
+    color: var(--bs-light);
+}
+
+[data-bs-theme=light] .contact-subtitle {
+    color: var(--bs-body-color);
+}
+
+[data-bs-theme=dark] .contact-subtitle {
+    color: var(--bs-light);
+}
+
+[data-bs-theme=dark] #contactform-verifycode-image {
+    background-color: var(--bs-secondary-color);
+    border: 1px solid rgba(255, 255, 255, 0.1);
+    box-shadow: 0 1px 3px rgba(0,0,0,0.3);
+}
diff --git a/src/framework/resource/layout/component/alert.php b/src/framework/resource/layout/component/alert.php
@@ -4,7 +4,7 @@
 
 use UIAwesome\Html\{Component\Bootstrap5\Alert};
 
-$session = Yii::$app->getSession();
+$session = Yii::$app->session;
 $flashMessages = $session->getAllFlashes();
 $html = [];
 
diff --git a/src/usecase/Controller.php b/src/usecase/Controller.php
@@ -9,11 +9,11 @@
 
 class Controller extends \yii\web\Controller
 {
-    /**
-     * @var string the default layout for the controller view.
-     */
     public $layout = '@resource/layout/main';
 
+    /**
+     * @phpstan-return array<array-key, array<array-key, mixed>>
+     */
     public function actions(): array
     {
         return [
diff --git a/src/usecase/contact/ContactController.php b/src/usecase/contact/ContactController.php
@@ -11,21 +11,19 @@
 final class ContactController extends Controller
 {
     /**
-     * @phpstan-var class-string<ContactForm>
+     * @phpstan-return array<array-key, array<array-key, mixed>>
      */
-    public string $formModelClass = ContactForm::class;
-
     public function actions(): array
     {
         return ArrayHelper::merge(
             [
                 'index' => [
                     'class' => IndexAction::class,
-                    'formModelClass' => $this->formModelClass,
                 ],
                 'captcha' => [
                     'class' => CaptchaAction::class,
                     'fixedVerifyCode' => (YII_ENV === 'tests') ? 'testme' : null,
+                    'transparent' => true,
                 ],
             ],
             parent::actions(),
diff --git a/src/usecase/contact/ContactForm.php b/src/usecase/contact/ContactForm.php
@@ -18,6 +18,9 @@ final class ContactForm extends Model
     public string $verifyCode = '';
     public string $date = '';
 
+    /**
+     * @return array<string, string>
+     */
     public function attributeLabels(): array
     {
         return [
@@ -41,6 +44,9 @@ public function rules(): array
         ];
     }
 
+    /**
+     * @phpstan-param array<array-key, mixed> $params
+     */
     public function sendContact(MailerInterface $mailer, array $params): bool
     {
         return $mailer->compose()
diff --git a/src/usecase/contact/IndexAction.php b/src/usecase/contact/IndexAction.php
@@ -4,18 +4,20 @@
 
 namespace app\usecase\contact;
 
-use yii\base\{Action, InvalidConfigException};
+use yii\base\Action;
 use yii\symfonymailer\Mailer;
 use yii\web\{Controller, Request, Session};
 
 final class IndexAction extends Action
 {
-    public string $formModelClass = '';
-
+    /**
+     * @phpstan-param array<array-key, mixed> $config
+     */
     public function __construct(
         string $id,
         Controller $controller,
         private readonly Mailer $mailer,
+        private readonly Request $request,
         private readonly Session $session,
         array $config = [],
     ) {
@@ -24,22 +26,13 @@ public function __construct(
 
     public function run(): string
     {
-        if ($this->formModelClass === '') {
-            throw new InvalidConfigException('The "formModelClass" property must be set.');
-        }
+        $contactForm = new ContactForm();
 
-        $contactForm = new $this->formModelClass();
-        $contactEvent = new ContactEvent();
+        $post = $this->request->post();
 
-        if (
-            $this->controller->request instanceof Request &&
-            $contactForm->load($this->controller->request->post()) &&
-            $contactForm->validate()
-        ) {
+        if (is_array($post) && $contactForm->load($post) && $contactForm->validate()) {
             if ($contactForm->sendContact($this->mailer, $this->controller->module->params)) {
-                $this->session->setFlash('contactFormSubmitted');
-
-                $this->trigger(ContactEvent::EVENT_AFTER_SEND, $contactEvent);
+                $this->trigger(ContactEvent::EVENT_AFTER_SEND, new ContactEvent());
             }
         }
 
diff --git a/src/usecase/contact/view/index.php b/src/usecase/contact/view/index.php
diff --git a/src/usecase/site/SiteController.php b/src/usecase/site/SiteController.php
diff --git a/tests/Functional/ContactCest.php b/tests/Functional/ContactCest.php
diff --git a/tests/Unit/ContactControllerCest.php b/tests/Unit/ContactControllerCest.php

-Original file line number
+Diff line change
       os: >-
         ['ubuntu-latest']
       php: >-
 -        ['8.2']
 +        ['8.4']