Custom date format in date plugin for list rendering. (#270)

* Block Preview styling * Tooltip preview fix #246 * Date plugin with custom format * Changelog for #270 * Refactored namespace using
luyadev · Mar 5, 2019 · 54c6527 · 54c6527
1 parent 8820619
commit 54c6527
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,25 +7,26 @@ In order to read more about upgrading and BC breaks have a look at the [UPGRADE
 
 This release contains new migrations and requires to run the `migrate` command after updating. Check the [UPGRADE Document](UPGRADE.md).
 
-## Changed
+### Changed
 
 + [#268](https://github.com/luyadev/luya-module-admin/issues/268) Deprecated classes, methods and properties has been removed.
 + [#261](https://github.com/luyadev/luya-module-admin/issues/261) Add ngRestFind() for none $is_api_user Users.
 + [#210](https://github.com/luyadev/luya-module-admin/issues/210) New tag translation option.
 + [#140](https://github.com/luyadev/luya-module-admin/issues/140) Generic Scheduler with Yii Queue integration.
 
-## Fixed
+### Fixed
 
 + [#258](https://github.com/luyadev/luya-module-admin/issues/258) NgRest Crud search with pagination problem fixed. 
 + [#226](https://github.com/luyadev/luya-module-admin/issues/226) Fixed search indicator
 + [#267](https://github.com/luyadev/luya-module-admin/pull/267) I18n::decodeFindActive returned empty value for explicitly selected lang
 
-## Added
+### Added
 
 + [#205](https://github.com/luyadev/luya-module-admin/issues/205) CRUD search works now in filters and relation calls, sorting and pagination works in searching.
 + [#216](https://github.com/luyadev/luya-module-admin/issues/216) File manager file detail view provides option to tag files.
 + [#259](https://github.com/luyadev/luya-module-admin/pull/259) SelectRelationActiveQuery supports related i18n label fields
 + [#253](https://github.com/luyadev/luya-module-admin/pull/253) Added command action to reset password for users via cli.
++ [#270](https://github.com/luyadev/luya-module-admin/pull/270) Custom date format for date plugin in listing.
 
 ## 1.2.3 (21. November 2018)
 

diff --git a/src/ngrest/plugins/Date.php b/src/ngrest/plugins/Date.php
@@ -3,6 +3,7 @@
 namespace luya\admin\ngrest\plugins;
 
 use luya\admin\ngrest\base\Plugin;
+use Yii;
 
 /**
  * Data input field
@@ -27,13 +28,21 @@ class Date extends Plugin
  */
  public $emptyMessage = '-';
 
+ /**
+ * @var string Use custom datetime format by [date filter](https://docs.angularjs.org/api/ng/filter/date). Default is 'shortDate'. Use false to take \yii\i18n\Formatter::$dateFormat as fallback.
+ * @since 2.0.0
+ */
+ public $format = 'shortDate';
+
  /**
  * @inheritdoc
  */
  public function renderList($id, $ngModel)
  {
+ $format = $this->format ?? Yii::$app->formatter->dateFormat;
+
  return [
- $this->createTag('span', null, ['ng-show' => $ngModel, 'ng-bind' => $ngModel.'*1000 | date : \'shortDate\'']),
+ $this->createTag('span', null, ['ng-show' => $ngModel, 'ng-bind' => $ngModel."*1000 | date : '$format'"]),
  $this->createTag('span', $this->emptyMessage, ['ng-show' => '!'.$ngModel]),
  ];
  }

diff --git a/src/ngrest/plugins/Datetime.php b/src/ngrest/plugins/Datetime.php
@@ -3,6 +3,7 @@
 namespace luya\admin\ngrest\plugins;
 
 use luya\admin\ngrest\base\Plugin;
+use Yii;
 
 /**
  * Date and Time input field
@@ -13,7 +14,7 @@
  * Example empty Date configuration
  *
  * ```
- * ['timestamp', ['Datetime', 'emptyMessage' => 'No Date']],
+ * ['timestamp', ['Datetime', 'emptyMessage' => 'No Date', 'format' => 'dd.MM.yyyy']],
  * ```
  *
  * @author Basil Suter <basil@nadar.io>
@@ -22,30 +23,38 @@
 class Datetime extends Plugin
 {
  /**
- * @var string This text will be displayed in the list overview when no date has been slected
+ * @var string This text will be displayed in the list overview when no date has been selected
  * or date is null/empty.
  */
  public $emptyMessage = '-';
 
+ /**
+ * @var string Use custom datetime format by [date filter](https://docs.angularjs.org/api/ng/filter/date). Default is 'short'. Use false to take \yii\i18n\Formatter::$datetimeFormat as fallback.
+ * @since 2.0.0
+ */
+ public $format = 'short';
+
  /**
  * @inheritdoc
  */
  public function renderList($id, $ngModel)
  {
+ $format = $this->format ?? Yii::$app->formatter->datetimeFormat;
+
  return [
- $this->createTag('span', null, ['ng-show' => $ngModel, 'ng-bind' => $ngModel.'*1000 | date : \'short\'']),
+ $this->createTag('span', null, ['ng-show' => $ngModel, 'ng-bind' => $ngModel."*1000 | date : '$format'"]),
  $this->createTag('span', $this->emptyMessage, ['ng-show' => '!'.$ngModel]),
  ];
  }
-
+ 
  /**
  * @inheritdoc
  */
  public function renderCreate($id, $ngModel)
  {
  return $this->createFormTag('zaa-datetime', $id, $ngModel);
  }
-
+ 
  /**
  * @inheritdoc
  */