Toggle button for ngRestModel

CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/).
 In order to read more about upgrading and BC breaks have a look at the [UPGRADE Document](UPGRADE.md).
 
+## 2.2.0 (in progress)
+
+### Added
+
++ [#338](https://github.com/luyadev/luya-module-admin/pull/338) Toggle button for ngRestModel to switch between enable and disable status.
+
 ## 2.1.0 (22. July 2019)
 
 ### Fixed

src/buttons/ToggleStatusActiveButton.php

@@ -0,0 +1,139 @@
+<?php
+
+namespace luya\admin\buttons;
+
+use yii\base\InvalidArgumentException;
+use yii\base\InvalidConfigException;
+use luya\admin\Module;
+use luya\admin\ngrest\base\ActiveButton;
+use luya\admin\ngrest\base\NgRestModel;
+
+/**
+ * Set a boolean for a given attribute.
+ *
+ * This buttons allows you to save the active status for a given attribute in the model.
+ *
+ * Usage example:
+ *
+ * ```php
+ * [
+ * 'class' => 'luya\admin\buttons\ToggleStatusActiveButton',
+ * 'attribute' => 'is_active',
+ * 'label' => 'Set active',
+ * ]
+ * ```
+ *
+ * @author Bennet Klarhölter <boehsermoe@me.com>
+ * @since 2.2.0
+ */
+class ToggleStatusActiveButton extends ActiveButton
+{
+ /**
+ * @var string The attribute which should set.
+ */
+ public $attribute;
+
+ /**
+ * Value which will saved to the model as active status.
+ * @var mixed
+ */
+ public $enableValue = true;
+
+ /**
+ * Value which will saved to the model as inactive status.
+ * @var mixed
+ */
+ public $disableValue = false;
+
+ /**
+ * Keep only one model with active status and disable all other entries.
+ * @var bool
+ */
+ public $uniqueStatus = false;
+
+ /**
+ * Attribute name for the success notification.
+ * @var string
+ */
+ public $modelNameAttribute = 'id';
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getDefaultIcon()
+ {
+ return 'toggle_on';
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function getDefaultLabel()
+ {
+ return Module::t('active_button_togglestatus_label');
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function init()
+ {
+ parent::init();
+
+ if (!$this->attribute) {
+ throw new InvalidConfigException("The attribute property must be set.");
+ }
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function handle(NgRestModel $model)
+ {
+ $transaction = $model::getDb()->beginTransaction();
+
+ try {
+ $newValue = $this->toggleValue($model->getAttribute($this->attribute));
+
+ if ($this->uniqueStatus) {
+ $model::updateAll([$this->attribute => $this->disableValue]);
+ $model->updateAttributes([$this->attribute => $newValue]);
+ } else {
+ $model->updateAttributes([$this->attribute => $newValue]);
+ }
+
+ $transaction->commit();
+
+ $this->sendReloadEvent();
+ if ($newValue == $this->enableValue) {
+ return $this->sendSuccess(Module::t('active_button_togglestatus_enabled', ['modelName' => $model->{$this->modelNameAttribute}]));
+ } else {
+ return $this->sendSuccess(Module::t('active_button_togglestatus_disabled', ['modelName' => $model->{$this->modelNameAttribute}]));
+ }
+ } catch (\Throwable $ex) {
+ $transaction->rollBack();
+ throw $ex;
+ }
+
+ return $this->sendError(Module::t('active_button_togglestatus_error'));
+ }
+
+ /**
+ * Return the opposite attribute value for $enableValue or $disableValue.
+ *
+ * @param $value
+ *
+ * @return mixed
+ */
+ private function toggleValue($value)
+ {
+ switch ($value) {
+ case $this->disableValue:
+ return $this->enableValue;
+ case $this->enableValue:
+ return $this->disableValue;
+ default:
+ throw new InvalidArgumentException("The value '$value' could not toggled.");
+ }
+ }
+}

src/messages/cn/admin.php

@@ -429,4 +429,11 @@
  'status_true' => 'Yes',
  'status_false' => 'No',
  'js_jsonobject_newkey' => 'New key name',
+
+// 2.2.0
+
+ 'active_button_togglestatus_label' => 'Toggle status',
+ 'active_button_togglestatus_error' => 'Could not activated',
+ 'active_button_togglestatus_enabled' => '{modelName} enabled',
+ 'active_button_togglestatus_disabled' => '{modelName} disabled',
 ];

src/messages/de/admin.php

@@ -431,4 +431,11 @@
  'status_true' => 'Ja',
  'status_false' => 'Nein',
  'js_jsonobject_newkey' => 'Neuer Schlüssel Name',
+
+// 2.2.0
+
+ 'active_button_togglestatus_label' => 'Toggle status',
+ 'active_button_togglestatus_error' => 'Could not activated',
+ 'active_button_togglestatus_enabled' => '{modelName} enabled',
+ 'active_button_togglestatus_disabled' => '{modelName} disabled',
 ];

src/messages/el/admin.php

@@ -418,4 +418,11 @@
  'status_true' => 'Yes',
  'status_false' => 'No',
  'js_jsonobject_newkey' => 'New key name',
+
+// 2.2.0
+
+ 'active_button_togglestatus_label' => 'Toggle status',
+ 'active_button_togglestatus_error' => 'Could not activated',
+ 'active_button_togglestatus_enabled' => '{modelName} enabled',
+ 'active_button_togglestatus_disabled' => '{modelName} disabled',
 ];

src/messages/en/admin.php

@@ -429,4 +429,11 @@
  'status_true' => 'Yes',
  'status_false' => 'No',
  'js_jsonobject_newkey' => 'New key name',
+
+// 2.2.0
+
+ 'active_button_togglestatus_label' => 'Toggle status',
+ 'active_button_togglestatus_error' => 'Could not activated',
+ 'active_button_togglestatus_enabled' => '{modelName} enabled',
+ 'active_button_togglestatus_disabled' => '{modelName} disabled',
 ];

src/messages/es/admin.php

@@ -410,4 +410,11 @@
  'status_true' => 'Yes',
  'status_false' => 'No',
  'js_jsonobject_newkey' => 'New key name',
+
+// 2.2.0
+
+ 'active_button_togglestatus_label' => 'Toggle status',
+ 'active_button_togglestatus_error' => 'Could not activated',
+ 'active_button_togglestatus_enabled' => '{modelName} enabled',
+ 'active_button_togglestatus_disabled' => '{modelName} disabled',
 ];

src/messages/fa/admin.php

@@ -410,4 +410,11 @@
  'status_true' => 'Yes',
  'status_false' => 'No',
  'js_jsonobject_newkey' => 'New key name',
+
+// 2.2.0
+
+ 'active_button_togglestatus_label' => 'Toggle status',
+ 'active_button_togglestatus_error' => 'Could not activated',
+ 'active_button_togglestatus_enabled' => '{modelName} enabled',
+ 'active_button_togglestatus_disabled' => '{modelName} disabled',
 ];

src/messages/fr/admin.php

@@ -429,4 +429,11 @@
  'status_true' => 'Yes',
  'status_false' => 'No',
  'js_jsonobject_newkey' => 'New key name',
+
+// 2.2.0
+
+ 'active_button_togglestatus_label' => 'Toggle status',
+ 'active_button_togglestatus_error' => 'Could not activated',
+ 'active_button_togglestatus_enabled' => '{modelName} enabled',
+ 'active_button_togglestatus_disabled' => '{modelName} disabled',
 ];

src/messages/it/admin.php

@@ -418,4 +418,11 @@
  'status_true' => 'Yes',
  'status_false' => 'No',
  'js_jsonobject_newkey' => 'New key name',
+
+// 2.2.0
+
+ 'active_button_togglestatus_label' => 'Toggle status',
+ 'active_button_togglestatus_error' => 'Could not activated',
+ 'active_button_togglestatus_enabled' => '{modelName} enabled',
+ 'active_button_togglestatus_disabled' => '{modelName} disabled',
 ];

src/messages/nl/admin.php

@@ -403,4 +403,11 @@
  'status_true' => 'Yes',
  'status_false' => 'No',
  'js_jsonobject_newkey' => 'New key name',
+
+// 2.2.0
+
+ 'active_button_togglestatus_label' => 'Toggle status',
+ 'active_button_togglestatus_error' => 'Could not activated',
+ 'active_button_togglestatus_enabled' => '{modelName} enabled',
+ 'active_button_togglestatus_disabled' => '{modelName} disabled',
 ];

src/messages/pl/admin.php

@@ -426,4 +426,11 @@
  'status_true' => 'Yes',
  'status_false' => 'No',
  'js_jsonobject_newkey' => 'New key name',
+
+// 2.2.0
+
+ 'active_button_togglestatus_label' => 'Toggle status',
+ 'active_button_togglestatus_error' => 'Could not activated',
+ 'active_button_togglestatus_enabled' => '{modelName} enabled',
+ 'active_button_togglestatus_disabled' => '{modelName} disabled',
 ];

src/messages/pt/admin.php

@@ -430,4 +430,11 @@
  'status_true' => 'Yes',
  'status_false' => 'No',
  'js_jsonobject_newkey' => 'New key name',
+
+// 2.2.0
+
+ 'active_button_togglestatus_label' => 'Toggle status',
+ 'active_button_togglestatus_error' => 'Could not activated',
+ 'active_button_togglestatus_enabled' => '{modelName} enabled',
+ 'active_button_togglestatus_disabled' => '{modelName} disabled',
 ];

src/messages/ru/admin.php

@@ -432,4 +432,11 @@
  'status_true' => 'Yes',
  'status_false' => 'No',
  'js_jsonobject_newkey' => 'New key name',
+
+// 2.2.0
+
+ 'active_button_togglestatus_label' => 'Toggle status',
+ 'active_button_togglestatus_error' => 'Could not activated',
+ 'active_button_togglestatus_enabled' => '{modelName} enabled',
+ 'active_button_togglestatus_disabled' => '{modelName} disabled',
 ];

src/messages/tr/admin.php

@@ -429,4 +429,11 @@
  'status_true' => 'Yes',
  'status_false' => 'No',
  'js_jsonobject_newkey' => 'New key name',
+
+// 2.2.0
+
+ 'active_button_togglestatus_label' => 'Toggle status',
+ 'active_button_togglestatus_error' => 'Could not activated',
+ 'active_button_togglestatus_enabled' => '{modelName} enabled',
+ 'active_button_togglestatus_disabled' => '{modelName} disabled',
 ];

src/messages/ua/admin.php

@@ -430,4 +430,11 @@
  'status_true' => 'Yes',
  'status_false' => 'No',
  'js_jsonobject_newkey' => 'New key name',
+
+// 2.2.0
+
+ 'active_button_togglestatus_label' => 'Toggle status',
+ 'active_button_togglestatus_error' => 'Could not activated',
+ 'active_button_togglestatus_enabled' => '{modelName} enabled',
+ 'active_button_togglestatus_disabled' => '{modelName} disabled',
 ];

src/messages/vi/admin.php

@@ -429,4 +429,11 @@
  'status_true' => 'Yes',
  'status_false' => 'No',
  'js_jsonobject_newkey' => 'New key name',
+
+// 2.2.0
+
+ 'active_button_togglestatus_label' => 'Toggle status',
+ 'active_button_togglestatus_error' => 'Could not activated',
+ 'active_button_togglestatus_enabled' => '{modelName} enabled',
+ 'active_button_togglestatus_disabled' => '{modelName} disabled',
 ];