@@ -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) |
@@ -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 | { |
@@ -80,33 +80,33 @@ |
||
80 | 80 | } |
81 | 81 | |
82 | 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. 0 means never expire. |
|
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 | - */ |
|
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. 0 means never expire. |
|
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) { |
@@ -203,7 +203,7 @@ |
||
203 | 203 | * @param string $repo |
204 | 204 | * @param string $isFork |
205 | 205 | * @param string $exists |
206 | - * @return array |
|
206 | + * @return string[] |
|
207 | 207 | */ |
208 | 208 | private function summaryItem($repo, $isFork, $exists) |
209 | 209 | { |
@@ -241,6 +241,9 @@ |
||
241 | 241 | return $files; |
242 | 242 | } |
243 | 243 | |
244 | + /** |
|
245 | + * @param string $prefix |
|
246 | + */ |
|
244 | 247 | private function fileToName($prefix, $file) |
245 | 248 | { |
246 | 249 | $value = ltrim(str_replace([$prefix, 'Controller.php'], '', $file), DIRECTORY_SEPARATOR); |
@@ -26,7 +26,7 @@ discard block |
||
26 | 26 | /** |
27 | 27 | * Display config data and location. |
28 | 28 | * |
29 | - * @return boolean|void |
|
29 | + * @return integer|null |
|
30 | 30 | */ |
31 | 31 | public function actionConfigInfo() |
32 | 32 | { |
@@ -77,7 +77,7 @@ discard block |
||
77 | 77 | * Save a value in the config for a given key. |
78 | 78 | * |
79 | 79 | * @param string $key |
80 | - * @param mixed $value |
|
80 | + * @param string|boolean $value |
|
81 | 81 | * @return mixed |
82 | 82 | */ |
83 | 83 | protected function saveConfig($key, $value) |
@@ -160,6 +160,7 @@ discard block |
||
160 | 160 | |
161 | 161 | /** |
162 | 162 | * @param int $maximumAttendeeCapacity |
163 | + * @return void |
|
163 | 164 | */ |
164 | 165 | public function setMaximumAttendeeCapacity($maximumAttendeeCapacity); |
165 | 166 | |
@@ -247,6 +248,7 @@ discard block |
||
247 | 248 | |
248 | 249 | /** |
249 | 250 | * @param Event $subEvent |
251 | + * @return void |
|
250 | 252 | */ |
251 | 253 | public function setSubEvent(Event $subEvent); |
252 | 254 |
@@ -47,7 +47,7 @@ discard block |
||
47 | 47 | /** |
48 | 48 | * Physical address of the item. |
49 | 49 | * |
50 | - * @param PostalAddress|string $address |
|
50 | + * @param PostalAddress $address |
|
51 | 51 | * @return PersonTrait |
52 | 52 | */ |
53 | 53 | public function setAddress(PostalAddress $address) |
@@ -294,7 +294,7 @@ discard block |
||
294 | 294 | /** |
295 | 295 | * The Dun & Bradstreet DUNS number for identifying an organization or business person. |
296 | 296 | * |
297 | - * @param string $duns |
|
297 | + * @param Person $duns |
|
298 | 298 | * @return PersonTrait |
299 | 299 | */ |
300 | 300 | public function setDuns(Person $duns) |
@@ -27,7 +27,7 @@ |
||
27 | 27 | public function getAddress(); |
28 | 28 | |
29 | 29 | /** |
30 | - * @param PostalAddress|string $address |
|
30 | + * @param PostalAddress $address |
|
31 | 31 | * @return PlaceTrait |
32 | 32 | */ |
33 | 33 | public function setAddress(PostalAddress $address); |