Changed Active Window $alias property to $label. Use defaultLabel() in

order to set a default label. #1574

CHANGELOG.md

@@ -13,6 +13,7 @@ All notable changes to this project will be documented in this file. This projec
 - [#1522](https://github.com/luyadev/luya/issues/1522) Text and Textarea NgRest plugins auto encode input data after find.
 - [#1505](https://github.com/luyadev/luya/issues/1505) Minor API Breaks and removed deprecated methods.
 - [#1341](https://github.com/luyadev/luya/issues/1341) Changed signature of `changePassword($newPassword)` in `luya\admin\aws\ChangePasswordInterface`.
+- [#1574](https://github.com/luyadev/luya/issues/1574) Changed Active Window $alias property to $label. Use defaultLabel() in order to set a default label.
 - [#1567](https://github.com/luyadev/luya/issues/1567) Discontinue development of Exporter Module.
 
 ### Added

docs/guide/lesson-activewindow.md

@@ -23,7 +23,7 @@ As stated in the [ActiveWindow Documentation]() we'll have to add the button for
 public function ngRestActiveWindows()
 {
  return [
- ['class' => \app\modules\addressbook\admin\aws\GroupEmailActiveWindow::className(), 'alias' => 'Email to group', 'icon' => 'email'],
+ ['class' => \app\modules\addressbook\admin\aws\GroupEmailActiveWindow::className(), 'label' => 'Email to group', 'icon' => 'email'],
  ];
 }
 ```
@@ -78,10 +78,6 @@ class GroupEmailActiveWindow extends ActiveWindow
 {
  public $module = '@addressbookadmin';
 
- public $alias = 'Group Email Active Window';
-
- public $icon = 'extension';
-
  public function index()
  {
  return $this->render('index', [

docs/guide/ngrest-activewindow.md

@@ -46,13 +46,13 @@ Working with callbacks
 
 ## Attaching the Class
 
-In order to add an Active Window into your NgRest config, you have to add the config in the {{luya\admin\ngrest\base\NgRestModel::ngRestActiveWindows()}} method. As the Active Window contains the {{yii\base\Object}} as extend class you can configure all public properties while loading the class. Below an example of how to load an Active Window class and defined `alias` and `icon` public properties. The alias and icon propierties does exist in every Active Window an can always be overwritten.
+In order to add an Active Window into your NgRest config, you have to add the config in the {{luya\admin\ngrest\base\NgRestModel::ngRestActiveWindows()}} method. As the Active Window contains the {{yii\base\Object}} as extend class you can configure all public properties while loading the class. Below an example of how to load an Active Window class and defined `label` and `icon` public properties. The alias and icon propierties does exist in every Active Window an can always be overwritten.
 
 ```php
 public function ngRestActiveWindows()
 {
  return [
- ['class' => \luya\admin\aws\TestActiveWindow::className(), 'alias' => 'My Window Alias', 'icon' => 'extension'],
+ ['class' => \luya\admin\aws\TestActiveWindow::className(), 'label' => 'My Window Alias', 'icon' => 'extension'],
  ];
 }
 ```

modules/admin/src/aws/ChangePasswordActiveWindow.php

@@ -22,16 +22,12 @@ class ChangePasswordActiveWindow extends ActiveWindow
  * @var string The name of the module where the active windows is located in order to finde the view path.
  */
  public $module = 'admin';
-
- /**
- * @var string The icon name from goolges material icon set (https://material.io/icons/)
- */
- public $icon = 'vpn_key';
 
  /**
  * @var integer The minimum length of the password.
  */
  public $minCharLength = 8;
+
  /**
  * The default action which is going to be requested when clicking the active window.
  *
@@ -42,6 +38,14 @@ public function index()
  return $this->render('index');
  }
 
+ /**
+ * @inheritdoc
+ */
+ public function defaultIcon()
+ {
+ return 'vpn_key';
+ }
+
  /**
  * The method which is going to change the password on the current model.
  *

modules/admin/src/aws/CoordinatesActiveWindow.php

@@ -19,17 +19,7 @@ class CoordinatesActiveWindow extends ActiveWindow
  * @var string The name of the module where the active windows is located in order to finde the view path.
  */
  public $module = '@admin';
-
- /**
- * @var string The name of of the ActiveWindow. This is displayed in the CRUD list.
- */
- public $alias = 'Coordinates';
-
- /**
- * @var string The icon name from goolges material icon set (https://material.io/icons/)
- */
- public $icon = 'pin_drop';
-
+
  /**
  * @var string Register your maps application and enter your api key here
  * while configure the active window (https://console.developers.google.com).
@@ -46,6 +36,22 @@ public function init()
  }
  }
 
+ /**
+ * @inheritdoc
+ */
+ public function defaultLabel()
+ {
+ return 'Coordinates';
+ }
+
+ /**
+ * @inheritdoc
+ */
+ public function defaultIcon()
+ {
+ return 'pin_drop';
+ }
+
  /**
  * Renders the index file of the ActiveWindow.
  *

modules/admin/src/aws/DetailViewActiveWindow.php

@@ -50,16 +50,6 @@ class DetailViewActiveWindow extends ActiveWindow
  */
  public $module = '@admin';
 
- /**
- * @var string The name of of the ActiveWindow. This is displayed in the CRUD list.
- */
- public $alias = 'Detail';
-
- /**
- * @var string The icon name from goolges material icon set (https://material.io/icons/)
- */
- public $icon = 'zoom_in';
-
  /**
  * @var array a list of attributes to be displayed in the detail view. Each array element
  * represents the specification for displaying one particular attribute.
@@ -95,6 +85,22 @@ class DetailViewActiveWindow extends ActiveWindow
  */
  public $attributes;
 
+ /**
+ * @inheritdoc
+ */
+ public function defaultLabel()
+ {
+ return 'Detail';
+ }
+
+ /**
+ * @inheritdoc
+ */
+ public function defaultIcon()
+ {
+ return 'zoom_in';
+ }
+
  /**
  * Renders the index file of the ActiveWindow.
  *

modules/admin/src/aws/FlowActiveWindow.php

@@ -23,7 +23,7 @@
  * public function ngRestActiveWindows()
  * {
  * return [
- * ['class' => \luya\admin\aws\FlowActiveWindow::class, 'alias' => 'My Gallery'],
+ * ['class' => \luya\admin\aws\FlowActiveWindow::class, 'label' => 'My Gallery'],
  * ];
  * }
  * ```
@@ -43,14 +43,28 @@ class FlowActiveWindow extends ActiveWindow
  public $module = '@admin';
 
  /**
- * @var string The name of of the ActiveWindow. This is displayed in the CRUD list.
+ * @inheritdoc
  */
- public $alias = 'Flow Uploader';
+ public function index()
+ {
+ return $this->render('index');
+ }
+
+ /**
+ * @inheritdoc
+ */
+ public function defaultLabel()
+ {
+ return 'Flow Uploader';
+ }
 
  /**
- * @var string The icon name from goolges material icon set (https://material.io/icons/)
+ * @inheritdoc
  */
- public $icon = 'cloud_upload';
+ public function defaultIcon()
+ {
+ return 'cloud_upload';
+ }
 
  /**
  * @inheritdoc
@@ -66,14 +80,6 @@ public function getModel()
  return $model;
  }
 
- /**
- * @inheritdoc
- */
- public function index()
- {
- return $this->render('index');
- }
-
  /**
  * Returns a list of uploaded images.
  *

modules/admin/src/aws/GroupAuthActiveWindow.php

@@ -4,6 +4,7 @@
 
 use Yii;
 use luya\admin\ngrest\base\ActiveWindow;
+use luya\admin\Module;
 
 /**
  * Active Window to set permissions for a specific Group, used in groups ngrest model.
@@ -18,11 +19,6 @@ class GroupAuthActiveWindow extends ActiveWindow
  */
  public $module = 'admin';
 
- /**
- * @var string The icon name from goolges material icon set (https://material.io/icons/)
- */
- public $icon = 'verified_user';
-
  /**
  * The default action which is going to be requested when clicking the ActiveWindow.
  *
@@ -32,7 +28,27 @@ public function index()
  {
  return $this->render('index');
  }
+
+ /**
+ * @inheritdoc
+ */
+ public function defaultLabel()
+ {
+ return Module::t('model_group_btn_aws_groupauth');
+ }
+
+ /**
+ * @inheritdoc
+ */
+ public function defaultIcon()
+ {
+ return 'verified_user';
+ }
 
+ /**
+ * 
+ * @return boolean[]
+ */
  public function callbackSaveRights()
  {
  $rights = Yii::$app->request->post('data', []);
@@ -60,6 +76,10 @@ public function callbackSaveRights()
  return ['success' => true];
  }
 
+ /**
+ * 
+ * @return number[][][]|string[]|array[]
+ */
  public function callbackGetRights()
  {
  return [
@@ -68,6 +88,10 @@ public function callbackGetRights()
  ];
  }
 
+ /**
+ * 
+ * @return string|array
+ */
  private function getAuthData()
  {
  $data = (new \yii\db\Query())->select('*')->from('admin_auth')->orderBy('module_name, alias_name ASC')->all();
@@ -85,6 +109,10 @@ private function getAuthData()
  return $data;
  }
 
+ /**
+ * 
+ * @return number[][]
+ */
  private function getRightsData()
  {
  $query = (new \yii\db\Query())->select('*')->from('admin_group_auth')->where(['group_id' => $this->getItemId()])->all();

modules/admin/src/aws/ImageSelectCollectionActiveWindow.php

@@ -71,11 +71,6 @@ class ImageSelectCollectionActiveWindow extends ActiveWindow
  */
  public $module = 'admin';
 
- /**
- * @var string The icon name from goolges material icon set (https://material.io/icons/)
- */
- public $icon = 'photo_library';
-
  /**
  * @inheritdoc
  */
@@ -99,6 +94,14 @@ public function index()
  'sortIndexFieldName' => $this->sortIndexFieldName,
  ]);
  }
+
+ /**
+ * @inheritdoc
+ */
+ public function defaultIcon()
+ {
+ return 'photo_library';
+ }
 
  /**
  * Load all images.