Merge pull request #9 from dmstr/feature/context-menu-interface

Implemented context menu interface

Author: eluhr

src/widgets/HtmlWidget.php

@@ -9,6 +9,7 @@
  */
 namespace dmstr\modules\prototype\widgets;
 
+use dmstr\modules\backend\interfaces\ContextMenuItemsInterface;
 use rmrevin\yii\fontawesome\FA;
 use yii\base\Event;
 use yii\base\Widget;
@@ -25,12 +26,12 @@
  * @property bool $renderEmpty
  * @property Html $_model
  */
-class HtmlWidget extends Widget
+class HtmlWidget extends Widget implements ContextMenuItemsInterface
 {
     const SETTINGS_SECTION = 'app.html';
     const ACCESS_ROLE = 'Editor';
 
-    public $key = null;
+    public $key;
     public $enableFlash = false;
     public $moduleId = 'prototype';
     public $registerMenuItems = true;
@@ -47,6 +48,9 @@ public function init()
         }
     }
 
+    /**
+     * @return string
+     */
     public function run()
     {
         $this->_model = $model = HtmlModel::findOne(['key' => $this->generateKey()]);
@@ -73,6 +77,9 @@ public function run()
         return $html;
     }
 
+    /**
+     * @return array
+     */
     public function getMenuItems()
     {
         return [
@@ -84,6 +91,9 @@ public function getMenuItems()
         ];
     }
 
+    /**
+     * @return null|string
+     */
     private function generateKey()
     {
         if ($this->key) {
@@ -94,28 +104,47 @@ private function generateKey()
         return \Yii::$app->language.'/'.\Yii::$app->controller->route.($key ? '/'.$key : '');
     }
 
+    /**
+     * @return string
+     */
     private function generateCreateLink()
     {
 
         return Html::a(FA::icon(FA::_PLUS_SQUARE) . ' HTML',
             ['/' . $this->moduleId . '/html/create', 'Html' => ['key' => $this->generateKey()]]);
     }
 
+    /**
+     * @param $id
+     *
+     * @return string
+     */
     private function generateEditLink($id)
     {
         return Html::a($this->moduleId . ' module', ['/' . $this->moduleId . '/html/update', 'id' => $id]);
     }
 
+    /**
+     * @return array
+     */
     private function generateCreateRoute()
     {
         return ['/' . $this->moduleId . '/html/create', 'Html' => ['key' => $this->generateKey()]];
     }
 
+    /**
+     * @param $id
+     *
+     * @return array
+     */
     private function generateEditRoute($id)
     {
         return ['/' . $this->moduleId . '/html/update', 'id' => $id];
     }
 
+    /**
+     * @return string
+     */
     private function renderEmpty()
     {
         return '<div class="alert alert-info">'.$this->generateCreateLink().'</div>';

src/widgets/TwigWidget.php

@@ -11,6 +11,7 @@
 namespace dmstr\modules\prototype\widgets;
 
 use dmstr\db\traits\ActiveRecordAccessTrait;
+use dmstr\modules\backend\interfaces\ContextMenuItemsInterface;
 use dmstr\modules\prototype\models\Twig;
 use rmrevin\yii\fontawesome\FA;
 use yii\base\Event;
@@ -29,20 +30,20 @@
  * @property bool $localized
  * @property string $queryParam
  */
-class TwigWidget extends Widget
+class TwigWidget extends Widget implements ContextMenuItemsInterface
 {
     const SETTINGS_SECTION = 'app.html';
     const ACCESS_ROLE = 'prototype_twig';
     const TEMP_ALIAS = '@runtime/TwigWidget';
 
     public $moduleId = 'prototype';
     public $queryParam = 'pageId';
-    public $key = null;
+    public $key;
     public $localized = true;
     public $enableFlash = false;
     public $registerMenuItems = true;
     public $renderEmpty = true;
-    public $position = null;
+    public $position;
     public $params = [];
 
     private $_model;
@@ -57,6 +58,9 @@ public function init()
         }
     }
 
+    /**
+     * @return string
+     */
     public function run()
     {
         Url::remember('', $this->generateKey());
@@ -102,6 +106,9 @@ public function run()
     }
 
 
+    /**
+     * @return array
+     */
     public function getMenuItems()
     {
         return [
@@ -118,6 +125,7 @@ public function getMenuItems()
 
     /**
      * Generates a key based on the current route/queryParam
+     *
      * @return null|string
      */
     private function generateKey()
@@ -136,23 +144,37 @@ private function generateKey()
             ($this->position ? '#' . $this->position : '');
     }
 
+    /**
+     * @return string
+     */
     private function generateCreateLink()
     {
 
         return Html::a(FA::icon(FA::_PLUS_SQUARE) . ' ' . $this->generateKey() . ' Twig',
             ['/' . $this->moduleId . '/twig/create', 'Twig' => ['key' => $this->generateKey()]]);
     }
 
+    /**
+     * @return array
+     */
     private function generateCreateRoute()
     {
         return ['/' . $this->moduleId . '/twig/create', 'Twig' => ['key' => $this->generateKey()]];
     }
 
+    /**
+     * @param $id
+     *
+     * @return array
+     */
     private function generateEditRoute($id)
     {
         return ['/' . $this->moduleId . '/twig/update', 'id' => $id];
     }
 
+    /**
+     * @return string
+     */
     private function renderEmpty()
     {
         return '<div class="alert alert-info">' . $this->generateCreateLink() . '</div>';