@@ -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 | { |
@@ -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) |
@@ -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. |
|
| 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. |
|
| 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) { |
@@ -28,7 +28,7 @@ discard block |
||
| 28 | 28 | |
| 29 | 29 | /** |
| 30 | 30 | * @param string $additionalType |
| 31 | - * @return Thing |
|
| 31 | + * @return ThingTrait |
|
| 32 | 32 | */ |
| 33 | 33 | public function setAdditionalType($additionalType) |
| 34 | 34 | { |
@@ -53,7 +53,7 @@ discard block |
||
| 53 | 53 | |
| 54 | 54 | /** |
| 55 | 55 | * @param string $alternateName |
| 56 | - * @return Thing |
|
| 56 | + * @return ThingTrait |
|
| 57 | 57 | */ |
| 58 | 58 | public function setAlternateName($alternateName) |
| 59 | 59 | { |
@@ -78,7 +78,7 @@ discard block |
||
| 78 | 78 | |
| 79 | 79 | /** |
| 80 | 80 | * @param string $description |
| 81 | - * @return Thing |
|
| 81 | + * @return ThingTrait |
|
| 82 | 82 | */ |
| 83 | 83 | public function setDescription($description) |
| 84 | 84 | { |
@@ -104,7 +104,7 @@ discard block |
||
| 104 | 104 | |
| 105 | 105 | /** |
| 106 | 106 | * @param string $disambiguatingDescription |
| 107 | - * @return Thing |
|
| 107 | + * @return ThingTrait |
|
| 108 | 108 | */ |
| 109 | 109 | public function setDisambiguatingDescription($disambiguatingDescription) |
| 110 | 110 | { |
@@ -129,7 +129,7 @@ discard block |
||
| 129 | 129 | |
| 130 | 130 | /** |
| 131 | 131 | * @param PropertyValue|URL|string $identifier |
| 132 | - * @return Thing |
|
| 132 | + * @return ThingTrait |
|
| 133 | 133 | */ |
| 134 | 134 | public function setIdentifier($identifier) |
| 135 | 135 | { |
@@ -155,7 +155,7 @@ discard block |
||
| 155 | 155 | |
| 156 | 156 | /** |
| 157 | 157 | * @param ImageObject|URL $image |
| 158 | - * @return Thing |
|
| 158 | + * @return ThingTrait |
|
| 159 | 159 | */ |
| 160 | 160 | public function setImage($image) |
| 161 | 161 | { |
@@ -181,7 +181,7 @@ discard block |
||
| 181 | 181 | |
| 182 | 182 | /** |
| 183 | 183 | * @param CreativeWork|URL $mainEntityOfPage |
| 184 | - * @return Thing |
|
| 184 | + * @return ThingTrait |
|
| 185 | 185 | */ |
| 186 | 186 | public function setMainEntityOfPage($mainEntityOfPage) |
| 187 | 187 | { |
@@ -206,7 +206,7 @@ discard block |
||
| 206 | 206 | |
| 207 | 207 | /** |
| 208 | 208 | * @param string $name |
| 209 | - * @return Thing |
|
| 209 | + * @return ThingTrait |
|
| 210 | 210 | */ |
| 211 | 211 | public function setName($name) |
| 212 | 212 | { |
@@ -231,7 +231,7 @@ discard block |
||
| 231 | 231 | |
| 232 | 232 | /** |
| 233 | 233 | * @param Action $potentialAction |
| 234 | - * @return Thing |
|
| 234 | + * @return ThingTrait |
|
| 235 | 235 | */ |
| 236 | 236 | public function setPotentialAction($potentialAction) |
| 237 | 237 | { |
@@ -257,7 +257,7 @@ discard block |
||
| 257 | 257 | |
| 258 | 258 | /** |
| 259 | 259 | * @param URL $sameAs |
| 260 | - * @return Thing |
|
| 260 | + * @return ThingTrait |
|
| 261 | 261 | */ |
| 262 | 262 | public function setSameAs($sameAs) |
| 263 | 263 | { |
@@ -283,7 +283,7 @@ discard block |
||
| 283 | 283 | |
| 284 | 284 | /** |
| 285 | 285 | * @param CreativeWork|Event $subjectOf |
| 286 | - * @return Thing |
|
| 286 | + * @return ThingTrait |
|
| 287 | 287 | */ |
| 288 | 288 | public function setSubjectOf($subjectOf) |
| 289 | 289 | { |
@@ -308,7 +308,7 @@ discard block |
||
| 308 | 308 | |
| 309 | 309 | /** |
| 310 | 310 | * @param URL $url |
| 311 | - * @return Thing |
|
| 311 | + * @return ThingTrait |
|
| 312 | 312 | */ |
| 313 | 313 | public function setUrl($url) |
| 314 | 314 | { |
@@ -27,22 +27,22 @@ discard block |
||
| 27 | 27 | */ |
| 28 | 28 | public function resolveGetterMethods() |
| 29 | 29 | { |
| 30 | - $resolved = []; |
|
| 31 | - $methods = get_class_methods($this); |
|
| 30 | + $resolved = []; |
|
| 31 | + $methods = get_class_methods($this); |
|
| 32 | 32 | |
| 33 | - if (!$methods) { |
|
| 34 | - return []; |
|
| 35 | - } |
|
| 33 | + if (!$methods) { |
|
| 34 | + return []; |
|
| 35 | + } |
|
| 36 | 36 | |
| 37 | - foreach ($methods as $method) { |
|
| 38 | - if (StringHelper::startsWith($method, 'get', true)) { |
|
| 39 | - $resolved[] = lcfirst(StringHelper::replaceFirst('get', '', $method)); |
|
| 40 | - } |
|
| 41 | - } |
|
| 37 | + foreach ($methods as $method) { |
|
| 38 | + if (StringHelper::startsWith($method, 'get', true)) { |
|
| 39 | + $resolved[] = lcfirst(StringHelper::replaceFirst('get', '', $method)); |
|
| 40 | + } |
|
| 41 | + } |
|
| 42 | 42 | |
| 43 | - asort($resolved); |
|
| 43 | + asort($resolved); |
|
| 44 | 44 | |
| 45 | - return $resolved; |
|
| 45 | + return $resolved; |
|
| 46 | 46 | } |
| 47 | 47 | |
| 48 | 48 | /** |
@@ -58,7 +58,7 @@ discard block |
||
| 58 | 58 | */ |
| 59 | 59 | public function fields() |
| 60 | 60 | { |
| 61 | - return $this->resolveGetterMethods(); |
|
| 61 | + return $this->resolveGetterMethods(); |
|
| 62 | 62 | } |
| 63 | 63 | |
| 64 | 64 | /** |