More fixes (#2)

* Fix console config
* Clean up ignore patterns
* Export .editorconfig and .gitignore
* Fix readme and typo
* Hint $params in configs
* Update .htaccess
* Cleanup views
* More cleanup and parameter renaming
* Fix changelog
* Add security advisories package
* Fix image path in readme

.gitattributes

@@ -23,9 +23,7 @@
 
 # Ignore some meta files when creating an archive of this repository
 /.github            export-ignore
-/.editorconfig      export-ignore
 /.gitattributes     export-ignore
-/.gitignore         export-ignore
 /.scrutinizer.yml   export-ignore
 
 # CHANGELOG

CHANGELOG.md

@@ -1,4 +1,4 @@
-# _____ Change Log
+# Yii 3 Application Template Change Log
 
 ## 1.0.0 under development
 

README.md

@@ -14,7 +14,7 @@
 
 <p align="center">
     <a href="https://github.com/yiisoft/app" target="_blank">
-        <img src="docs\images\home.png" >
+        <img src="docs/images/home.png" >
     </a>
 </p>
 
@@ -76,7 +76,7 @@ return [
         '@views' => '@root/resources/views'
     ],
 
-    'yiisoft/app' => [
+    'app' => [
         'brandurl' => '/',
         'charset' => 'UTF-8',
         'hero.options' => ['class' => 'hero is-fullheight is-light'],
@@ -89,8 +89,8 @@ return [
         'hero.footer.column.left.options' => ['class' => 'column has-text-left has-text-light'],
         'hero.footer.column.center' => 'Center',
         'hero.footer.column.center.options' => ['class' => 'column has-text-centered has-text-light'],
-        'hero.footer.column.rigth' => 'Rigth',
-        'hero.footer.column.rigth.options' => ['class' => 'column has-text-right has-text-light'],
+        'hero.footer.column.right' => 'Right',
+        'hero.footer.column.right.options' => ['class' => 'column has-text-right has-text-light'],
         'language' => 'en',
         'logo' => '/images/yii-logo.jpg',
         'name' => 'My Project',

composer.json

@@ -28,6 +28,7 @@
         "yiisoft/yii-web": "@dev"
     },
     "require-dev": {
+        "roave/security-advisories": "dev-master",
         "codeception/codeception": "^4.1.5",
         "codeception/module-asserts": "@dev",
         "codeception/module-phpbrowser": "@dev",

config/common.php

@@ -5,6 +5,8 @@
 use Psr\Container\ContainerInterface;
 use Yiisoft\Aliases\Aliases;
 
+/* @var array $params */
+
 return [
     ContainerInterface::class => static function (ContainerInterface $container) {
         return $container;

config/console.php

@@ -0,0 +1,7 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+
+];

config/params.php

@@ -29,8 +29,8 @@
         'hero.footer.column.left.options' => ['class' => 'column has-text-left has-text-light'],
         'hero.footer.column.center' => 'Center',
         'hero.footer.column.center.options' => ['class' => 'column has-text-centered has-text-light'],
-        'hero.footer.column.rigth' => 'Rigth',
-        'hero.footer.column.rigth.options' => ['class' => 'column has-text-right has-text-light'],
+        'hero.footer.column.right' => 'Right',
+        'hero.footer.column.right.options' => ['class' => 'column has-text-right has-text-light'],
         'language' => 'en',
         'logo' => '/images/yii-logo.jpg',
         'name' => 'My Project',

config/web.php

@@ -2,10 +2,12 @@
 
 declare(strict_types=1);
 
-use App\LayoutParameters;
+use App\ApplicationParameters;
 use Yiisoft\Yii\Web\Session\Session;
 use Yiisoft\Yii\Web\Session\SessionInterface;
 
+/* @var array $params */
+
 return [
     SessionInterface::class => [
         '__class' => Session::class,
@@ -15,10 +17,10 @@
         ],
     ],
 
-    LayoutParameters::class => static function () use ($params) {
-        $layoutParameters = new LayoutParameters();
+    ApplicationParameters::class => static function () use ($params) {
+        $applicationParameters = new ApplicationParameters();
 
-        return $layoutParameters
+        return $applicationParameters
             ->brandUrl($params['app']['brandurl'])
             ->charset($params['app']['charset'])
             ->heroOptions($params['app']['hero.options'])
@@ -31,8 +33,8 @@
             ->heroFooterColumnLeftOptions($params['app']['hero.footer.column.left.options'])
             ->heroFooterColumnCenter($params['app']['hero.footer.column.center'])
             ->heroFooterColumnCenterOptions($params['app']['hero.footer.column.center.options'])
-            ->heroFooterColumnRigth($params['app']['hero.footer.column.rigth'])
-            ->heroFooterColumnRigthOptions($params['app']['hero.footer.column.rigth.options'])
+            ->heroFooterColumnRight($params['app']['hero.footer.column.right'])
+            ->heroFooterColumnRightOptions($params['app']['hero.footer.column.right.options'])
             ->language($params['app']['language'])
             ->logo($params['app']['logo'])
             ->name($params['app']['name'])

public/.htaccess

@@ -1,13 +1,12 @@
-# rewrite ^/(.*)/$ /$1 permanent;
+# use mod_rewrite for pretty URL support
+RewriteEngine on
 
-# if (!-d $request_filename && !-f $request_filename) {
-#     rewrite ^/ index.php last;
-# }
+# if $showScriptName is false in UrlManager, do not allow accessing URLs with script name
+RewriteRule ^index.php/ - [L,R=404]
 
+# If a directory or a file exists, use the request directly
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteCond %{REQUEST_FILENAME} !-d
 
-RewriteEngine on
-# if a directory or a file exists, use it directly 
-RewriteCond %{REQUEST_FILENAME} !-f 
-RewriteCond %{REQUEST_FILENAME} !-d 
-# otherwise forward it to index.php 
-RewriteRule . index.php
+# Otherwise forward the request to index.php
+RewriteRule . index.php

public/assets/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

resources/layout/_footer.php

@@ -4,21 +4,19 @@
 
 use Yiisoft\Html\Html;
 
-/** @var \App\LayoutParameters $layoutParameters */
+/** @var \App\ApplicationParameters $applicationParameters */
 ?>
+<?= Html::beginTag('div', $applicationParameters->getHeroFooterColumnOptions()) ?>
 
-<?= Html::beginTag('div', $layoutParameters->getHeroFooterColumnOptions()) ?>
-
-    <?= Html::beginTag('div', $layoutParameters->getHeroFooterColumnLeftOptions()) ?>
-        <?= $layoutParameters->getHeroFooterColumnLeft() ?>
+    <?= Html::beginTag('div', $applicationParameters->getHeroFooterColumnLeftOptions()) ?>
+        <?= $applicationParameters->getHeroFooterColumnLeft() ?>
     <?= Html::endTag('div') ?>
 
-    <?= Html::beginTag('div', $layoutParameters->getHeroFooterColumnCenterOptions()) ?>
-        <?= $layoutParameters->getHeroFooterColumnCenter() ?>
+    <?= Html::beginTag('div', $applicationParameters->getHeroFooterColumnCenterOptions()) ?>
+        <?= $applicationParameters->getHeroFooterColumnCenter() ?>
     <?= Html::endTag('div') ?>
 
-    <?= Html::beginTag('div', $layoutParameters->getHeroFooterColumnRigthOptions()) ?>
-        <?= $layoutParameters->getHeroFooterColumnRigth() ?>
+    <?= Html::beginTag('div', $applicationParameters->getHeroFooterColumnRightOptions()) ?>
+        <?= $applicationParameters->getHeroFooterColumnRight() ?>
     <?= Html::endTag('div') ?>
-
-<?= Html::tag('div');
+<?= Html::endTag('div') ?>

resources/layout/_head.php

@@ -5,18 +5,16 @@
 use Yiisoft\Html\Html;
 
 /**
- * @var \App\LayoutParameters $layoutParameters
+ * @var \App\ApplicationParameters $applicationParameters
  * @var string $csrf
  */
 ?>
-
-<?= Html::beginTag('head') ?>
-    <?= Html::tag('meta', '', ['charset' => $layoutParameters->getCharset()]) ?>
+<head>
+    <?= Html::tag('meta', '', ['charset' => $applicationParameters->getCharset()]) ?>
     <?= Html::tag('meta', '', ['http-equiv' => 'X-UA-Compatible', 'content' => 'IE=edge']) ?>
     <?= Html::tag('meta', '', ['name' => 'viewport', 'content' => 'width=device-width, initial-scale=1']) ?>
     <?= Html::tag('meta', '', ['name' => 'csrf', 'content' => $csrf]) ?>
     <?= Html::tag('title', Html::encode($this->getTitle())) ?>
 
     <?php $this->head() ?>
-
-<?= Html::endTag('head');
+</head>

resources/layout/_menu.php

@@ -4,22 +4,19 @@
 
 use Yiisoft\Html\Html;
 
-/** @var \App\LayoutParameters $layoutParameters */
+/** @var \App\ApplicationParameters $applicationParameters */
 ?>
-
-<?= Html::beginTag('div', $layoutParameters->getNavBarOptions()) ?>
-
-    <?= Html::beginTag('div', $layoutParameters->getNavBarBrandOptions()) ?>
+<?= Html::beginTag('div', $applicationParameters->getNavBarOptions()) ?>
+    <?= Html::beginTag('div', $applicationParameters->getNavBarBrandOptions()) ?>
         <?= Html::tag(
             'span',
-            Html::img($layoutParameters->getLogo()),
-            $layoutParameters->getNavBarBrandLogoOptions()
+            Html::img($applicationParameters->getLogo()),
+            $applicationParameters->getNavBarBrandLogoOptions()
         ) ?>
         <?=  Html::a(
-            $layoutParameters->getName(),
-            $layoutParameters->getbrandUrl(),
-            $layoutParameters->getNavBarBrandTitleOptions()
+            $applicationParameters->getName(),
+            $applicationParameters->getbrandUrl(),
+            $applicationParameters->getNavBarBrandTitleOptions()
         ) ?>
     <?= Html::endTag('div') ?>
-
-<?= Html::endTag('div');
+<?= Html::endTag('div') ?>

resources/layout/main.php

@@ -6,8 +6,10 @@
 use Yiisoft\Html\Html;
 
 /**
- * @var \Yiisoft\Assets\AssetsManager $assetManager
- * @var \App\LayoutParameters $layoutParameters
+ * @var \Yiisoft\Assets\AssetManager $assetManager
+ * @var \App\ApplicationParameters $applicationParameters
+ * @var string $csrf
+ * @var string $content
  */
 
 $assetManager->register([
@@ -18,36 +20,33 @@
 $this->setJsFiles($assetManager->getJsFiles());
 
 ?>
-
 <?php $this->beginPage() ?>
     <!DOCTYPE html>
-    <?= Html::beginTag('html', ['lang' => $layoutParameters->getLanguage()]) ?>
+    <?= Html::beginTag('html', ['lang' => $applicationParameters->getLanguage()]) ?>
 
         <?= $this->render('_head', ['csrf' => $csrf]) ?>
 
         <?php $this->beginBody() ?>
 
-            <?= Html::beginTag('body') ?>
-
-                <?= Html::beginTag('section', $layoutParameters->getHeroOptions()) ?>
+            <body>
+                <?= Html::beginTag('section', $applicationParameters->getHeroOptions()) ?>
 
-                    <?= Html::beginTag('div', $layoutParameters->getHeroHeadOptions()) ?>
+                    <?= Html::beginTag('div', $applicationParameters->getHeroHeadOptions()) ?>
                         <?= $this->render('_menu') ?>
                     <?= Html::endTag('div') ?>
 
-                    <?= Html::beginTag('div', $layoutParameters->getHeroBodyOptions()) ?>
-                        <?= Html::beginTag('div', $layoutParameters->getHeroContainerOptions()) ?>
+                    <?= Html::beginTag('div', $applicationParameters->getHeroBodyOptions()) ?>
+                        <?= Html::beginTag('div', $applicationParameters->getHeroContainerOptions()) ?>
                             <?= $content ?>
                         <?= Html::endTag('div') ?>
                     <?= Html::endTag('div') ?>
 
-                    <?= Html::beginTag('div', $layoutParameters->getHeroFooterOptions()) ?>
+                    <?= Html::beginTag('div', $applicationParameters->getHeroFooterOptions()) ?>
                         <?= $this->render('_footer') ?>
                     <?= Html::endTag('div') ?>
 
                 <?= Html::endTag('section') ?>
-
-            <?= Html::endTag('body') ?>
+            </body>
 
         <?php $this->endBody() ?>
 

resources/views/site/index.php

@@ -2,14 +2,13 @@
 
 declare(strict_types=1);
 
-use Yiisoft\Html\Html;
-
-/** @var \App\LayoutParameters $layoutParameters */
+/** @var \App\ApplicationParameters $applicationParameters */
 
 $this->params['breadcrumbs'] = '/';
 
-$this->setTitle($layoutParameters->getName());
+$this->setTitle($applicationParameters->getName());
 ?>
 
-<?= Html::tag('h1', 'Hello World', ['class' => 'title']) ?>
-<?= Html::tag('p', 'My first website with <strong>Yii 3.0</strong>!', ['class' => 'subtitle']);
+<h1 class="title">Hello World</h1>
+
+<p class="subtitle">My first website with <strong>Yii 3.0</strong>!</p>

runtime/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

src/LayoutParameters.php → src/ApplicationParameters.php

@@ -6,7 +6,7 @@
 
 use Yiisoft\Assets\AssetBundle;
 
-final class LayoutParameters extends AssetBundle
+final class ApplicationParameters extends AssetBundle
 {
     private string $brandUrl;
     private string $charset;
@@ -20,8 +20,8 @@ final class LayoutParameters extends AssetBundle
     private array $heroFooterColumnCenterOptions = [];
     private string $heroFooterColumnLeft;
     private array $heroFooterColumnLeftOptions = [];
-    private string $heroFooterColumnRigth;
-    private array $heroFooterColumnRigthOptions = [];
+    private string $heroFooterColumnRight;
+    private array $heroFooterColumnRightOptions = [];
     private string $language;
     private string $logo;
     private array $menu = [];
@@ -97,14 +97,14 @@ public function getHeroFooterColumnLeftOptions(): array
         return $this->heroFooterColumnLeftOptions;
     }
 
-    public function getHeroFooterColumnRigth(): string
+    public function getHeroFooterColumnRight(): string
     {
-        return $this->heroFooterColumnRigth;
+        return $this->heroFooterColumnRight;
     }
 
-    public function getHeroFooterColumnRigthOptions(): array
+    public function getHeroFooterColumnRightOptions(): array
     {
-        return $this->heroFooterColumnRigthOptions;
+        return $this->heroFooterColumnRightOptions;
     }
 
     public function getLanguage(): string
@@ -254,17 +254,17 @@ public function heroFooterColumnLeftOptions(array $value): self
         return $new;
     }
 
-    public function heroFooterColumnRigth(string $value): self
+    public function heroFooterColumnRight(string $value): self
     {
         $new = clone $this;
-        $new->heroFooterColumnRigth = $value;
+        $new->heroFooterColumnRight = $value;
         return $new;
     }
 
-    public function heroFooterColumnRigthOptions(array $value): self
+    public function heroFooterColumnRightOptions(array $value): self
     {
         $new = clone $this;
-        $new->heroFooterColumnRigthOptions = $value;
+        $new->heroFooterColumnRightOptions = $value;
         return $new;
     }
 

src/Provider/EventDispatcherProvider.php

@@ -4,7 +4,6 @@
 
 namespace App\Provider;
 
-use Psr\Container\ContainerInterface;
 use Psr\EventDispatcher\EventDispatcherInterface;
 use Psr\EventDispatcher\ListenerProviderInterface;
 use Yiisoft\Di\Container;