@@ -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 | { |
@@ -37,7 +37,7 @@ discard block |
||
37 | 37 | /** |
38 | 38 | * Create all required directories an check whether they are writeable or not. |
39 | 39 | * |
40 | - * @return string The action output. |
|
40 | + * @return integer The action output. |
|
41 | 41 | */ |
42 | 42 | public function actionIndex() |
43 | 43 | { |
@@ -97,7 +97,7 @@ discard block |
||
97 | 97 | /** |
98 | 98 | * Test Mail-Component (Use --verbose=1 to enable smtp debug output) |
99 | 99 | * |
100 | - * @return boolean Whether successfull or not. |
|
100 | + * @return integer|null Whether successfull or not. |
|
101 | 101 | * @throws Exception On smtp failure |
102 | 102 | */ |
103 | 103 | public function actionMailer() |
@@ -35,7 +35,7 @@ discard block |
||
35 | 35 | /** |
36 | 36 | * |
37 | 37 | * @param array $contentRows |
38 | - * @param unknown $delimiter |
|
38 | + * @param string $delimiter |
|
39 | 39 | * @param unknown $keys |
40 | 40 | * @param string $generateHeader |
41 | 41 | * @return string |
@@ -96,7 +96,7 @@ discard block |
||
96 | 96 | * |
97 | 97 | * @param array $row |
98 | 98 | * @param unknown $delimiter |
99 | - * @param unknown $enclose |
|
99 | + * @param string $enclose |
|
100 | 100 | * @return string |
101 | 101 | */ |
102 | 102 | protected static function generateRow(array $row, $delimiter, $enclose) |