luyadev / luya

modules/cms/menu/Query.php

Doc Comments +2 added lines, -4 removed lines

@@ -155,8 +155,6 @@ 
     }
 
     /**
-     * @param string|array $with can be a string  containg "hidden" or an array with multiple patters
-     * for example `['hidden']`. Further with statements upcoming.
      * @return \cms\menu\Query
      */
     public function with($types)
@@ -239,7 +237,7 @@ 
      * Retrieve all found rows based on the filtering options and returns the the QueryIterator object
      * which is represents an array.
      * 
-     * @return \cms\menu\QueryIterator Returns the QueryIterator object.
+     * @return QueryIteratorFilter Returns the QueryIterator object.
      */
     public function all()
     {
@@ -262,7 +260,7 @@ 
      * 
      * @param array $data The filtere results where the iterator object should be created with
      * @param string $langContext The language short code context, if any.
-     * @return \cms\menu\QueryIterator
+     * @return QueryIteratorFilter
      */
     public static function createArrayIterator(array $data, $langContext)
     {

Spacing +1 added lines, -1 removed lines

@@ -284,7 +284,7 @@
     
     protected function filter(array $whereExpression, $containerData)
     {
-        $data = array_filter($containerData, function ($item) {
+        $data = array_filter($containerData, function($item) {
             foreach ($item as $field => $value) {
                 if (!$this->arrayFilter($value, $field)) {
                     return false;

modules/cmsadmin/apis/MenuController.php

Unused Use Statements -1 removed lines

@@ -4,7 +4,6 @@
 
 use yii\db\Query;
 use luya\helpers\ArrayHelper;
-use cmsadmin\models\NavContainer;
 use admin\models\Lang;
 
 class MenuController extends \admin\base\RestController

modules/cmsadmin/apis/NavController.php

Doc Comments +3 added lines, -1 removed lines

@@ -19,6 +19,9 @@ 
  */
 class NavController extends \admin\base\RestController
 {
+    /**
+     * @param string $name
+     */
     private function postArg($name)
     {
         return Yii::$app->request->post($name, null);
@@ -170,7 +173,6 @@ 
     /**
      * creates a new nav entry for the type page (nav_id will be created.
      *
-     * @param array $_POST:
      */
     public function actionCreatePage()
     {

modules/cmsadmin/components/Menu.php

Doc Comments +1 added lines, -1 removed lines

@@ -91,7 +91,7 @@
      * ]
      * ```
      *
-     * @param int $node parent_nav_id value
+     * @param integer $parentNavId
      */
     private function getFromParentNode($parentNavId)
     {

modules/cmsadmin/models/Block.php

Doc Comments +3 added lines

@@ -71,6 +71,9 @@
         parent::afterDelete();
     }
 
+    /**
+     * @param string $context
+     */
     public static function objectId($blockId, $id, $context, $pageObject = null)
     {
         $block = self::find()->where(['id' => $blockId])->asArray()->one();

modules/cmsadmin/models/NavItem.php

Doc Comments +5 added lines, -5 removed lines

@@ -183,7 +183,7 @@ 
      * 
      * @todo fix me above!
      *
-     * @param unknown $moduleName
+     * @param string $moduleName
      */
     public static function fromModule($moduleName)
     {
@@ -235,7 +235,7 @@ 
     /**
      * @todo use AR or queryCommand? NavItem::find()->leftJoin('cms_nav_item_module', 'nav_item_type_id=cms_nav_item_module.id')->where(['nav_item_type' => 2, 'cms_nav_item_module.module_name' => $moduleName])->asArray()->one()
      *
-     * @param unknown $moduleName
+     * @param string $moduleName
      *
      * @return unknown
      */
@@ -266,7 +266,7 @@ 
      *
      * Copy content of type cms_nav_item_page to a target nav item. This will create a new entry in cms_nav_item_page and for every used block a new entry in cms_nav_item_page_block_item
      *
-     * @param $targetNavItem nav item object
+     * @param \yii\db\ActiveRecord $targetNavItem nav item object
      * @return bool
      */
     public function copyPageItem($targetNavItem)
@@ -320,7 +320,7 @@ 
      *
      * Copy content of type cms_nav_item_module to a target nav item. This will create a new entry in cms_nav_item_module.
      *
-     * @param $targetNavItem
+     * @param \yii\db\ActiveRecord $targetNavItem
      * @return bool
      */
     public function copyModuleItem($targetNavItem)
@@ -348,7 +348,7 @@ 
      *
      * Copy content of type cms_nav_item_redirect to a target nav item. This will create a new entry in cms_nav_item_redirect.
      *
-     * @param $targetNavItem
+     * @param \yii\db\ActiveRecord $targetNavItem
      * @return bool
      */
     public function copyRedirectItem($targetNavItem)

modules/cmsadmin/models/NavItemModule.php

Doc Comments +3 added lines

@@ -20,6 +20,9 @@
 
     private $_module = null;
 
+    /**
+     * @return \luya\base\Module
+     */
     private function getModule()
     {
         if ($this->_module !== null) {

modules/cmsadmin/models/NavItemPage.php

Doc Comments +9 added lines

@@ -79,6 +79,9 @@ 
         throw new Exception("Could not find the requested cms layout id '".$this->layout_id."' for nav item page id '". $this->id . "'. Make sure your page does not have an old inactive/deleted cms layout selected.");
     }
     
+    /**
+     * @param string $key
+     */
     private function setHasCache($key, $value, $expirationTime)
     {
         if (Yii::$app->has('cache')) {
@@ -86,6 +89,9 @@ 
         }
     }
     
+    /**
+     * @param string $key
+     */
     private function getHasCache($key)
     {
         if (Yii::$app->has('cache')) {
@@ -98,6 +104,9 @@ 
         return false;
     }
 
+    /**
+     * @param integer $prevId
+     */
     public function renderPlaceholder($navItemPageId, $placeholderVar, $prevId)
     {
         $string = '';

Spacing +2 added lines, -2 removed lines

@@ -76,7 +76,7 @@ 
             return $data;
         }
 
-        throw new Exception("Could not find the requested cms layout id '".$this->layout_id."' for nav item page id '". $this->id . "'. Make sure your page does not have an old inactive/deleted cms layout selected.");
+        throw new Exception("Could not find the requested cms layout id '".$this->layout_id."' for nav item page id '".$this->id."'. Make sure your page does not have an old inactive/deleted cms layout selected.");
     }
     
     private function setHasCache($key, $value, $expirationTime)
@@ -144,7 +144,7 @@ 
                 }
             }
             
-            $string.= $blockResponse;
+            $string .= $blockResponse;
         }
 
         return $string;

modules/cmsadmin/Module.php

Doc Comments +3 added lines

@@ -85,6 +85,9 @@
         ],
     ];
     
+    /**
+     * @param string $message
+     */
     public static function t($message, array $params = [])
     {
         return Yii::t('cmsadmin', $message, $params, Yii::$app->luyaLanguage);