Merge pull request #4 from justcoded/develop

Settings component IDE support, updated configs, replaced params usage to settings

Author: aprokopenko

CHANGELOG.md

@@ -3,6 +3,12 @@ CHANGELOG for Yii2 STARTER PROJECT TEMPLATE
 
 *should be replaced with real project changelog later*
 
+v0.6
+---------------------
+* Added app components settings class to support IDE for modelsMap
+* Overwrite all params usage to settings usage
+* Updated AppSettingsForm sender* properties to system* properties. 
+
 v0.5
 ---------------------
 * Added settings extension with settings component

README.md

@@ -238,80 +238,3 @@ vendor/bin/codecept run functional,unit -- --coverage-html --coverage-xml
 ```
 
 You can see code coverage output under the `tests/_output` directory.
-
-### Settings extension
-
-For now this extension allows to store settings only in database. To run migration for creating
-settings table you need to configure the migrationPath in app-console.php
-
----------
-```php
-'migrate' => [
-    'migrationPath' => [
-        '@app/extensions/settings/migrations'
-    ],
-],
-```
-and run the migrate command or just run the next command
-```
-yii migrate --migrationPath=@app/extensions/settings/migrations
-```
-
-**Component Setup**
-
-To use the Setting Component, you need to configure the components array in your application configuration:
-
-```php
-'components' => [
-    'settings' => [
-        'class'     => 'justcoded\yii2\settings\components\DbSettings',
-    ],
-],
-```
-
-and add component name to bootstrap array
-
-```php
-    'bootstrap'  => ['settings'],
-```
-
-**Usage**
-
-```php
-// To set value
-Yii::$app->settings->set('section_name', 'key', 'value');
-
-// To get value
-$value = Yii::$app->settings->get('section_name', 'key');
-```
-
-There is a possibility to use models as some setting group object. To do this you have to
-add modelsMap param to component config:
-
-```php
-    'settings' => [
-        'class'     => 'justcoded\yii2\settings\components\DbSettings',
-        'modelsMap' => [
-            'custom_model_name' => 'path\to\CustomModel',
-        ],
-    ],
-```
-
-Add action to controller to get settings form with keys according to the model's properties
-
-```php
-    public function actions()
-    {
-        return [
-            'action_name' => [
-                'class' => 'justcoded\yii2\settings\actions\SettingsAction',
-                'modelClass' => 'path\to\CustomModel',
-            ],
-        ];
-    }
-```
-and create view with form displaying. Now you can get settings this way:
-
-```php
-$value = Yii::$app->settings->custom_model_name->property_name;
-```

app/components/Settings.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace app\components;
+
+use justcoded\yii2\settings\components\DbSettings;
+use justcoded\yii2\settings\forms\AppSettingsForm;
+
+/**
+ * Class Settings
+ *
+ * @property AppSettingsForm $app
+ *
+ * @package app\components
+ */
+class Settings extends DbSettings
+{
+
+}

app/console/Application.php

@@ -7,7 +7,7 @@
  * Custom App class to allow custom components IDE
  *
  * @property \app\i18n\Formatter $formatter The main formatter for app
- * @property \justcoded\yii2\settings\components\Settings $settings Configuration params
+ * @property \app\components\Settings $settings Configuration params
  */
 class Application extends \yii\console\Application
 {

app/extensions/README.md

@@ -0,0 +1,121 @@
+<p align="center">
+    <a href="https://github.com/yiisoft" target="_blank">
+        <img src="https://avatars0.githubusercontent.com/u/993323" height="100px">
+    </a>
+    <h1 align="center">Yii2 Settings Extension</h1>
+    <br>
+</p>
+
+
+Replacement for Yii app params. Easy to use component to store application settings.
+Supports only DB storage for now.
+Have ready to use base Settings form model and controller Action.
+
+### Installation
+
+The preferred way to install this extension is through composer.
+
+Either run
+
+```bash
+php composer.phar require --prefer-dist yii2mod/yii2-settings "*"
+```
+
+or add
+
+```
+"yii2mod/yii2-settings": "*"
+```
+
+to the require section of your composer.json.
+
+### Configuration
+
+#### Database migration
+
+Before usage this extension, we'll also need to prepare the database.
+
+You can add migrations path to your console config and then run `migrate` command:
+
+```php
+'migrate' => [
+    'migrationPath' => [
+        '@vendor/justcoded/yii2-settings/migrations'
+    ],
+],
+```
+
+or you can run the command below:
+
+```
+php yii migrate --migrationPath=@vendor/justcoded/yii2-settings/migrations
+```
+
+### Component Setup
+
+To use the Setting Component, you need to configure the components array in your application configuration:
+
+```php
+'components' => [
+    'settings' => [
+        'class'     => 'justcoded\yii2\settings\components\DbSettings',
+    ],
+],
+```
+
+and add component name to bootstrap array
+
+```php
+    'bootstrap'  => ['log', 'settings'],
+```
+
+### Usage
+
+```php
+// set value
+Yii::$app->settings->set('section_name', 'key', 'value');
+
+// get value
+$value = Yii::$app->settings->get('section_name', 'key');
+```
+
+There is a possibility to use models as some setting group object. To do this you have to
+add modelsMap array to component's configuration:
+
+```php
+    'settings' => [
+        'class'     => 'justcoded\yii2\settings\components\DbSettings',
+        'modelsMap' => [
+            'section1' => 'app\models\MySettingsForm1',
+            'section2' => 'app\models\MySettingsForm2',
+        ],
+    ],
+```
+
+Add action to controller to get settings form with keys according to the model's properties
+
+```php
+    public function actions()
+    {
+        return [
+            'actionName' => [
+                'class' => 'justcoded\yii2\settings\actions\SettingsAction',
+                'modelClass' => 'app\models\MySettingsForm1',
+            ],
+        ];
+    }
+```
+and create view with some active form. (You can copy a template from extension "views" folder) 
+
+Now you can get settings in better way:
+
+```php
+$value = Yii::$app->settings->section1->myPropertyName;
+```
+
+This is very useful, if you overwrite Yii/Application classes and specify correct PHPDoc comments. 
+In this way IDE will highlight all sections and properties.
+
+### Example
+
+You can check the example on our [Yii2 starter kit](https://github.com/justcoded/yii2-starter).

app/extensions/rbac/commands/RbacController.php

@@ -229,13 +229,28 @@ protected function scanControllerRoutes(array $controllers)
 			}
 
 			foreach ($methods as $method) {
-				if (! preg_match('/^action([A-Z]([a-zA-Z0-9]+))$/', $method->getName(), $actionMatch)) {
+				if (! preg_match('/^action([A-Z]([a-zA-Z0-9]+))$/', $method->getName(), $actionMatch)
+					&& !('actions' === $method->getName() && $reflection->getName() === $method->class)
+				) {
 					continue;
 				}
 				$controllerId = Inflector::slug(Inflector::camel2words($classMatch[2]));
-				$actionId = Inflector::slug(Inflector::camel2words($actionMatch[1]));
 
-				$actions[] = $moduleId . $controllerId . '/' . $actionId;
+				if ('actions' === $method->getName()) {
+					try {
+						$controllerObj = Yii::createObject($method->class, [$controllerId, Yii::$app]);
+						$customActions = $controllerObj->actions();
+						foreach ($customActions as $actionId => $params) {
+							$actions[] = $moduleId . $controllerId . '/' . $actionId;
+						}
+					} catch (\Exception $e) {
+						$this->error("\t\tcan't scan custom actions from {$method->class}::actions(). You will need to add them manually.");
+					}
+
+				} else {
+					$actionId = Inflector::slug(Inflector::camel2words($actionMatch[1]));
+					$actions[] = $moduleId . $controllerId . '/' . $actionId;
+				}
 			}
 		}
 

app/extensions/settings/forms/AppSettingsForm.php

@@ -4,6 +4,10 @@
 
 /**
  * Class AppSettingsForm
+ *
+ * @property array adminFriendlyEmail
+ * @property array systemFriendlyEmail
+ *
  * @package justcoded\yii2\settings\forms
  */
 class AppSettingsForm extends SettingsForm
@@ -27,14 +31,14 @@ class AppSettingsForm extends SettingsForm
 	 *
 	 * @var string
 	 */
-	public $senderEmail;
+	public $systemEmail;
 
 	/**
 	 * Name, which will be set in 'from' mail column
 	 *
 	 * @var string
 	 */
-	public $senderName;
+	public $systemName;
 
 	/**
 	 * In minuts
@@ -56,9 +60,9 @@ class AppSettingsForm extends SettingsForm
 	public function rules()
 	{
 		return [
-			[['adminEmail', 'adminName', 'senderName', 'senderEmail'], 'string'],
-			[['adminEmail', 'senderEmail'], 'email'],
-			[['passwordResetToken', 'rememberMeExpiration', 'senderEmail', 'adminEmail'], 'required'],
+			[['adminEmail', 'adminName', 'systemEmail', 'systemName'], 'string'],
+			[['adminEmail', 'systemEmail'], 'email'],
+			[['passwordResetToken', 'rememberMeExpiration', 'systemEmail', 'adminEmail'], 'required'],
 			[['passwordResetToken', 'rememberMeExpiration'], 'integer'],
 		];
 	}
@@ -71,8 +75,8 @@ public function attributeLabels()
 		return [
 			'adminEmail' => 'Admin email',
 			'adminName' => 'Admin name',
-			'senderEmail' => 'Sender email',
-			'senderName' => 'Sender name',
+			'systemEmail' => 'System email',
+			'systemName' => 'System email name',
 			'passwordResetToken' => 'Password reset token',
 			'rememberMeExpiration' => 'Remember me expiration',
 		];
@@ -99,8 +103,8 @@ public function getAdminFriendlyEmail()
 	/**
 	 * @return array
 	 */
-	public function getSenderFriendlyEmail()
+	public function getSystemFriendlyEmail()
 	{
-		return [$this->senderEmail => $this->senderName];
+		return [$this->systemEmail => $this->systemName];
 	}
 }

app/extensions/settings/views/app.php

@@ -23,9 +23,9 @@
 
 						<?= $form->field($model, 'adminEmail')->textInput() ?>
 
-						<?= $form->field($model, 'senderName')->textInput() ?>
+						<?= $form->field($model, 'systemName')->textInput() ?>
 
-						<?= $form->field($model, 'senderEmail')->textInput() ?>
+						<?= $form->field($model, 'systemEmail')->textInput() ?>
 
 						<?= $form->field($model, 'passwordResetToken')->input('number') ?>
 

app/forms/ContactForm.php

@@ -51,8 +51,8 @@ public function contact()
 	{
 		if ($this->validate()) {
 			Yii::$app->mailer->compose()
-				->setTo(Yii::$app->params['adminEmail'])
-				->setFrom([$this->email => $this->name])
+				->setTo(settings()->app->adminFriendlyEmail)
+				->setFrom([settings()->app->systemEmail => $this->name])
 				->setSubject($this->subject)
 				->setTextBody($this->body)
 				->send();

app/forms/LoginForm.php

@@ -63,7 +63,7 @@ public function validatePassword($attribute, $params)
 	public function login()
 	{
 		if ($this->validate()) {
-			return Yii::$app->user->login($this->getUser(), $this->rememberMe ? 3600 * 24 * 30 : 0);
+			return Yii::$app->user->login($this->getUser(), $this->rememberMe ? settings()->app->rememberMeExpiration : 0);
 		}
 
 		return false;