@@ -42,6 +42,11 @@ |
||
42 | 42 | } |
43 | 43 | } |
44 | 44 | |
45 | + /** |
|
46 | + * @param string|boolean $module |
|
47 | + * |
|
48 | + * @return string |
|
49 | + */ |
|
45 | 50 | private function getModuleMigrationDirectorie($module) |
46 | 51 | { |
47 | 52 | if (!array_key_exists($module, $this->moduleMigrationDirectories)) { |
@@ -45,7 +45,7 @@ |
||
45 | 45 | /** |
46 | 46 | * Get the $moduleName without admin suffix (if any). |
47 | 47 | * |
48 | - * @return mixed Return the module name without admin suffix. |
|
48 | + * @return string Return the module name without admin suffix. |
|
49 | 49 | */ |
50 | 50 | public function getModuleNameWithoutAdminSuffix() |
51 | 51 | { |
@@ -431,7 +431,7 @@ discard block |
||
431 | 431 | $this->apiEndpoint, |
432 | 432 | $this->getDbTableShema(), |
433 | 433 | $this->enableI18n |
434 | - ), |
|
434 | + ), |
|
435 | 435 | ]; |
436 | 436 | |
437 | 437 | foreach ($files as $file) { |
@@ -487,7 +487,7 @@ discard block |
||
487 | 487 | $apiEndpoint, |
488 | 488 | Yii::$app->db->getTableSchema($object->tableName(), true), |
489 | 489 | $i18n |
490 | - ), |
|
490 | + ), |
|
491 | 491 | ]; |
492 | 492 | |
493 | 493 | $this->generateFile($data); |
@@ -17,6 +17,7 @@ |
||
17 | 17 | /** |
18 | 18 | * Humanize the class name |
19 | 19 | * |
20 | + * @param string $name |
|
20 | 21 | * @return string The humanized name. |
21 | 22 | */ |
22 | 23 | public function humanizeName($name) |
@@ -398,7 +398,7 @@ |
||
398 | 398 | * |
399 | 399 | * @see ArrayAccess::offsetGet() |
400 | 400 | * @param string $offset The key to get from the array. |
401 | - * @return mixed The value for the offset key from the array. |
|
401 | + * @return string|boolean The value for the offset key from the array. |
|
402 | 402 | */ |
403 | 403 | public function offsetGet($offset) |
404 | 404 | { |
@@ -187,7 +187,7 @@ |
||
187 | 187 | * Remove the base url from a route |
188 | 188 | * |
189 | 189 | * @param string $route The route where the baseUrl should be removed from. |
190 | - * @return mixed |
|
190 | + * @return string |
|
191 | 191 | */ |
192 | 192 | public function removeBaseUrl($route) |
193 | 193 | { |
@@ -79,34 +79,34 @@ |
||
79 | 79 | return $this->_cachable; |
80 | 80 | } |
81 | 81 | |
82 | - /** |
|
83 | - * Method combines both [[setHasCache()]] and [[getHasCache()]] methods to retrieve value identified by a $key, |
|
84 | - * or to store the result of $closure execution if there is no cache available for the $key. |
|
85 | - * |
|
86 | - * Usage example: |
|
87 | - * |
|
88 | - * ```php |
|
89 | - * use CacheableTrait; |
|
90 | - * |
|
91 | - * public function getTopProducts($count = 10) |
|
92 | - * { |
|
93 | - * return $this->getOrSetHasCache(['top-n-products', 'n' => $count], function ($cache) use ($count) { |
|
94 | - * return Products::find()->mostPopular()->limit(10)->all(); |
|
95 | - * }, 1000); |
|
96 | - * } |
|
97 | - * ``` |
|
98 | - * |
|
99 | - * @param mixed $key a key identifying the value to be cached. This can be a simple string or |
|
100 | - * a complex data structure consisting of factors representing the key. |
|
101 | - * @param \Closure $closure the closure that will be used to generate a value to be cached. |
|
102 | - * In case $closure returns `false`, the value will not be cached. |
|
103 | - * @param int $duration default duration in seconds before the cache will expire. If not set, |
|
104 | - * [[defaultDuration]] value will be used. |
|
105 | - * @param Dependency $dependency dependency of the cached item. If the dependency changes, |
|
106 | - * the corresponding value in the cache will be invalidated when it is fetched via [[get()]]. |
|
107 | - * This parameter is ignored if [[serializer]] is `false`. |
|
108 | - * @return mixed result of $closure execution |
|
109 | - */ |
|
82 | + /** |
|
83 | + * Method combines both [[setHasCache()]] and [[getHasCache()]] methods to retrieve value identified by a $key, |
|
84 | + * or to store the result of $closure execution if there is no cache available for the $key. |
|
85 | + * |
|
86 | + * Usage example: |
|
87 | + * |
|
88 | + * ```php |
|
89 | + * use CacheableTrait; |
|
90 | + * |
|
91 | + * public function getTopProducts($count = 10) |
|
92 | + * { |
|
93 | + * return $this->getOrSetHasCache(['top-n-products', 'n' => $count], function ($cache) use ($count) { |
|
94 | + * return Products::find()->mostPopular()->limit(10)->all(); |
|
95 | + * }, 1000); |
|
96 | + * } |
|
97 | + * ``` |
|
98 | + * |
|
99 | + * @param mixed $key a key identifying the value to be cached. This can be a simple string or |
|
100 | + * a complex data structure consisting of factors representing the key. |
|
101 | + * @param \Closure $closure the closure that will be used to generate a value to be cached. |
|
102 | + * In case $closure returns `false`, the value will not be cached. |
|
103 | + * @param int $duration default duration in seconds before the cache will expire. If not set, |
|
104 | + * [[defaultDuration]] value will be used. |
|
105 | + * @param Dependency $dependency dependency of the cached item. If the dependency changes, |
|
106 | + * the corresponding value in the cache will be invalidated when it is fetched via [[get()]]. |
|
107 | + * This parameter is ignored if [[serializer]] is `false`. |
|
108 | + * @return mixed result of $closure execution |
|
109 | + */ |
|
110 | 110 | public function getOrSetHasCache($key, \Closure $closure, $duration = null, $dependency = null) |
111 | 111 | { |
112 | 112 | if (($value = $this->getHasCache($key)) !== false) { |
@@ -105,7 +105,7 @@ |
||
105 | 105 | * @param string $search Search string to look for. |
106 | 106 | * @param string $replace Replacement value for the first found occurrence. |
107 | 107 | * @param string $subject The string you want to look up to replace the first element. |
108 | - * @return mixed Replaced string |
|
108 | + * @return string Replaced string |
|
109 | 109 | */ |
110 | 110 | public static function replaceFirst($search, $replace, $subject) |
111 | 111 | { |
@@ -202,14 +202,14 @@ |
||
202 | 202 | */ |
203 | 203 | public function getAdminModules() |
204 | 204 | { |
205 | - $modules = []; |
|
205 | + $modules = []; |
|
206 | 206 | |
207 | - foreach ($this->getModules() as $id => $obj) { |
|
208 | - if ($obj instanceof Module && $obj instanceof AdminModuleInterface) { |
|
209 | - $modules[$id] = $obj; |
|
210 | - } |
|
211 | - } |
|
207 | + foreach ($this->getModules() as $id => $obj) { |
|
208 | + if ($obj instanceof Module && $obj instanceof AdminModuleInterface) { |
|
209 | + $modules[$id] = $obj; |
|
210 | + } |
|
211 | + } |
|
212 | 212 | |
213 | - return $modules; |
|
213 | + return $modules; |
|
214 | 214 | } |
215 | 215 | } |
@@ -261,7 +261,7 @@ |
||
261 | 261 | */ |
262 | 262 | public function render($file, array $args = []) |
263 | 263 | { |
264 | - $view = new View(); |
|
264 | + $view = new View(); |
|
265 | 265 | return $view->renderPhpFile(rtrim($this->getFolder(), DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR . FileHelper::ensureExtension($file, 'php'), $args); |
266 | 266 | |
267 | 267 | } |