luyadev / luya

core/helpers/Url.php

Doc Comments +2 added lines, -2 removed lines

@@ -19,7 +19,7 @@ 
 
     /**
      * This helper method will not concern any context informations
-     * @param array $routeParams Example array to route `['/module/controller/action']`.
+     * @param string[] $routeParams Example array to route `['/module/controller/action']`.
      * @param boolean $scheme Whether to return the absolute url or not
      */
     public static function toInternal(array $routeParams, $scheme = false)
@@ -37,7 +37,7 @@ 
      *
      * @param string $route
      * @param array  $params
-     * @param boolean $sheme Whether to return static url or not
+     * @param boolean $scheme Whether to return static url or not
      * @todo we have to remove this method as it provides no additinal functions to the yii\helpers\url to method
      */
     public static function toManager($route, array $params = [], $scheme = false)

modules/admin/src/base/Filter.php

Doc Comments +1 added lines, -1 removed lines

@@ -142,7 +142,7 @@
     /**
      * Get an array with all the effect param options, based on the effect params defintion.
      *
-     * @param array $effectParamsDefintion
+     * @param array $effectParams
      *
      * @throws Exception When the vars key does not exists in the effect definition.
      *

modules/admin/src/base/RestVerbController.php

Doc Comments +3 added lines

@@ -48,6 +48,9 @@
         $this->throwException(__METHOD__);
     }
 
+    /**
+     * @param string $method
+     */
     private function throwException($method)
     {
         throw new \Exception('The action '.$method.' is not yet supported.');

modules/admin/src/components/Auth.php

Doc Comments +15 added lines, -3 removed lines

@@ -25,6 +25,9 @@ 
         return ($create + $update + $delete);
     }
 
+    /**
+     * @param integer $permissionWeight
+     */
     public function permissionVerify($type, $permissionWeight)
     {
         $numbers = [];
@@ -76,10 +79,9 @@ 
     /**
      * see if the user id matches against the moduleName, controllerName, actionName inside of the rights database.
      *
-     * @param string $moduleName     Module Name
-     * @param string $controllerName The name of the controller without suffix "Controller"
-     * @param string $actionName     The name of the action without prefix "action";
      *
+     * @param integer $userId
+     * @param string $route
      * @return bool
      */
     public function matchRoute($userId, $route)
@@ -97,6 +99,11 @@ 
         return false;
     }
 
+    /**
+     * @param string $moduleName
+     * @param string $route
+     * @param string $name
+     */
     public function addRoute($moduleName, $route, $name)
     {
         $handler = (new Query())->select('COUNT(*) AS count')->from('admin_auth')->where(['route' => $route])->one();
@@ -118,6 +125,11 @@ 
         }
     }
 
+    /**
+     * @param string $moduleName
+     * @param string $apiEndpoint
+     * @param string $name
+     */
     public function addApi($moduleName, $apiEndpoint, $name)
     {
         $handler = (new Query())->select('COUNT(*) AS count')->from('admin_auth')->where(['api' => $apiEndpoint])->one();

modules/admin/src/components/StorageContainer.php

Doc Comments +4 added lines, -1 removed lines

@@ -417,7 +417,7 @@ 
     /**
      * 
      * @param unknown $folderName
-     * @param number $parentFolderId
+     * @param integer $parentFolderId
      * @return boolean
      */
     public function addFolder($folderName, $parentFolderId = 0)
@@ -453,6 +453,9 @@ 
         return (isset($this->filtersArray[$filterIdentifier])) ? $this->filtersArray[$filterIdentifier] : false;
     }
     
+    /**
+     * @param string $key
+     */
     protected function getQueryCacheHelper(\yii\db\Query $query, $key)
     {
         $data = $this->getHasCache($key);

modules/admin/src/helpers/Storage.php

Doc Comments +3 added lines, -2 removed lines

@@ -29,6 +29,7 @@ 
      * So you need to use the "%u" formatter of sprintf() or printf() to get the string representation of the unsigned crc32() checksum in decimal format.
      *
      * @var string
+     * @param string $fileName
      */
     public static function createFileHash($fileName)
     {
@@ -133,7 +134,7 @@ 
     /**
      * 
      * @param array $fileArray Its an entry of the files array like $_FILEs['logo_image'];
-     * @param number $toFolder
+     * @param integer $toFolder
      * @param string $isHidden
      */
     public static function uploadFromFileArray(array $fileArray, $toFolder = 0, $isHidden = false)
@@ -194,7 +195,7 @@ 
     /**
      * 
      * @param array $filesArray Use $_FILES
-     * @param number $toFolder
+     * @param integer $toFolder
      * @param string $isHidden
      * 
      * @todo what happen if $files does have more then one entry, as the response is limit to 1

modules/admin/src/image/Item.php

Doc Comments +2 added lines, -2 removed lines

@@ -38,7 +38,7 @@ 
     
     /**
      * 
-     * @return string|boolean
+     * @return string|false
      */
     public function getSource()
     {
@@ -53,7 +53,7 @@ 
     
     /**
      * 
-     * @return string|boolean
+     * @return string|false
      */
     public function getServerSource()
     {

modules/admin/src/importers/FilterImporter.php

Doc Comments +3 added lines

@@ -7,6 +7,9 @@
 
 class FilterImporter extends \luya\base\Importer
 {
+    /**
+     * @param string $identifier
+     */
     private function refresh($identifier, $fields)
     {
         $model = StorageEffect::find()->where(['identifier' => $identifier])->one();

modules/admin/src/models/Config.php

Doc Comments +12 added lines

@@ -9,11 +9,17 @@ 
         return 'admin_config';
     }
 
+    /**
+     * @param string $name
+     */
     public static function has($name)
     {
         return (self::find()->where(['name' => $name])->one()) ? true : false;
     }
 
+    /**
+     * @param string $name
+     */
     public static function get($name)
     {
         $model = self::find()->where(['name' => $name])->asArray()->one();
@@ -25,6 +31,9 @@ 
         return;
     }
 
+    /**
+     * @param string $name
+     */
     public static function set($name, $value)
     {
         $model = self::find()->where(['name' => $name])->one();
@@ -42,6 +51,9 @@ 
         return $model->insert(false);
     }
 
+    /**
+     * @param string $name
+     */
     public static function remove($name)
     {
         $model = self::find()->where(['name' => $name])->one();