@@ -1142,7 +1142,7 @@ discard block |
||
1142 | 1142 | * @author Vova Feldman (@svovaf) |
1143 | 1143 | * @since 1.0.1 |
1144 | 1144 | * |
1145 | - * @param $plugin_file |
|
1145 | + * @param string $plugin_file |
|
1146 | 1146 | * |
1147 | 1147 | * @return false|Freemius |
1148 | 1148 | */ |
@@ -2973,10 +2973,16 @@ discard block |
||
2973 | 2973 | return ! empty( $options[ $key ] ) ? $options[ $key ] : $default; |
2974 | 2974 | } |
2975 | 2975 | |
2976 | + /** |
|
2977 | + * @param string $key |
|
2978 | + */ |
|
2976 | 2979 | private function get_bool_option( &$options, $key, $default = false ) { |
2977 | 2980 | return isset( $options[ $key ] ) && is_bool( $options[ $key ] ) ? $options[ $key ] : $default; |
2978 | 2981 | } |
2979 | 2982 | |
2983 | + /** |
|
2984 | + * @param string $key |
|
2985 | + */ |
|
2980 | 2986 | private function get_numeric_option( &$options, $key, $default = false ) { |
2981 | 2987 | return isset( $options[ $key ] ) && is_numeric( $options[ $key ] ) ? $options[ $key ] : $default; |
2982 | 2988 | } |
@@ -5111,7 +5117,7 @@ discard block |
||
5111 | 5117 | * @author Vova Feldman (@svovaf) |
5112 | 5118 | * @since 1.0.4 |
5113 | 5119 | * |
5114 | - * @return mixed Plugin secret key. |
|
5120 | + * @return string Plugin secret key. |
|
5115 | 5121 | */ |
5116 | 5122 | function get_secret_key() { |
5117 | 5123 | return $this->_plugin->secret_key; |
@@ -6704,7 +6710,7 @@ discard block |
||
6704 | 6710 | * @author Vova Feldman (@svovaf) |
6705 | 6711 | * @since 1.2.0 |
6706 | 6712 | * |
6707 | - * @param array|string $actions Collection of AJAX actions. |
|
6713 | + * @param string $actions Collection of AJAX actions. |
|
6708 | 6714 | * @param string $slug |
6709 | 6715 | * |
6710 | 6716 | * @return bool |
@@ -7261,7 +7267,7 @@ discard block |
||
7261 | 7267 | * |
7262 | 7268 | * @param array $override_with |
7263 | 7269 | * |
7264 | - * @return array |
|
7270 | + * @return string|boolean |
|
7265 | 7271 | */ |
7266 | 7272 | function get_opt_in_params( $override_with = array() ) { |
7267 | 7273 | $this->_logger->entrance(); |
@@ -8594,8 +8600,6 @@ discard block |
||
8594 | 8600 | * @since 1.0.1 |
8595 | 8601 | * |
8596 | 8602 | * @param string $tag The name of the action to be executed. |
8597 | - * @param mixed $arg,... Optional. Additional arguments which are passed on to the |
|
8598 | - * functions hooked to the action. Default empty. |
|
8599 | 8603 | * |
8600 | 8604 | * @uses do_action() |
8601 | 8605 | */ |
@@ -9405,7 +9409,7 @@ discard block |
||
9405 | 9409 | * @author Vova Feldman (@svovaf) |
9406 | 9410 | * @since 1.0.5 |
9407 | 9411 | * |
9408 | - * @param bool|number $plugin_id |
|
9412 | + * @param boolean $plugin_id |
|
9409 | 9413 | * @param bool $flush Since 1.1.7.3 |
9410 | 9414 | * |
9411 | 9415 | * @return bool|FS_Plugin_Tag |
@@ -11613,8 +11617,8 @@ discard block |
||
11613 | 11617 | * @author Vova Feldman (@svovaf) |
11614 | 11618 | * @since 1.0.0 |
11615 | 11619 | * |
11616 | - * @param $label |
|
11617 | - * @param $url |
|
11620 | + * @param string $label |
|
11621 | + * @param string $url |
|
11618 | 11622 | * @param bool $external |
11619 | 11623 | * @param int $priority |
11620 | 11624 | * @param bool $key |
@@ -37,6 +37,9 @@ discard block |
||
37 | 37 | private static $CNT = 0; |
38 | 38 | private static $_HOOKED_FOOTER = false; |
39 | 39 | |
40 | + /** |
|
41 | + * @param string $id |
|
42 | + */ |
|
40 | 43 | private function __construct( $id, $on = false, $echo = false ) { |
41 | 44 | $this->_id = $id; |
42 | 45 | |
@@ -142,6 +145,9 @@ discard block |
||
142 | 145 | return $this->_file_start; |
143 | 146 | } |
144 | 147 | |
148 | + /** |
|
149 | + * @param boolean $wrapper |
|
150 | + */ |
|
145 | 151 | private function _log( &$message, $type = 'log', $wrapper ) { |
146 | 152 | if ( ! $this->is_on() ) { |
147 | 153 | return; |
@@ -193,6 +199,9 @@ discard block |
||
193 | 199 | } |
194 | 200 | } |
195 | 201 | |
202 | + /** |
|
203 | + * @param string $message |
|
204 | + */ |
|
196 | 205 | function log( $message, $wrapper = false ) { |
197 | 206 | $this->_log( $message, 'log', $wrapper ); |
198 | 207 | } |
@@ -201,10 +210,16 @@ discard block |
||
201 | 210 | $this->_log( $message, 'info', $wrapper ); |
202 | 211 | } |
203 | 212 | |
213 | + /** |
|
214 | + * @param string $message |
|
215 | + */ |
|
204 | 216 | function warn( $message, $wrapper = false ) { |
205 | 217 | $this->_log( $message, 'warn', $wrapper ); |
206 | 218 | } |
207 | 219 | |
220 | + /** |
|
221 | + * @param string $message |
|
222 | + */ |
|
208 | 223 | function error( $message, $wrapper = false ) { |
209 | 224 | $this->_log( $message, 'error', $wrapper ); |
210 | 225 | } |
@@ -16,7 +16,7 @@ |
||
16 | 16 | * @author Vova Feldman (@svovaf) |
17 | 17 | * @since 1.0.0 |
18 | 18 | * |
19 | - * @param object $object |
|
19 | + * @param FS_Entity $object |
|
20 | 20 | * |
21 | 21 | * @return array |
22 | 22 | */ |
@@ -120,7 +120,7 @@ |
||
120 | 120 | * @author Vova Feldman (@svovaf) |
121 | 121 | * @since 1.1.8 |
122 | 122 | * |
123 | - * @return int |
|
123 | + * @return double |
|
124 | 124 | */ |
125 | 125 | function annual_discount_percentage() { |
126 | 126 | return floor( $this->annual_savings() / ( $this->monthly_price * 12 * ( $this->is_unlimited() ? 1 : $this->licenses ) ) * 100 ); |
@@ -38,16 +38,25 @@ discard block |
||
38 | 38 | include_once fs_get_template_path( $path ); |
39 | 39 | } |
40 | 40 | |
41 | + /** |
|
42 | + * @param string $path |
|
43 | + */ |
|
41 | 44 | function fs_require_template( $path, &$params = null ) { |
42 | 45 | $VARS = &$params; |
43 | 46 | require fs_get_template_path( $path ); |
44 | 47 | } |
45 | 48 | |
49 | + /** |
|
50 | + * @param string $path |
|
51 | + */ |
|
46 | 52 | function fs_require_once_template( $path, &$params = null ) { |
47 | 53 | $VARS = &$params; |
48 | 54 | require_once fs_get_template_path( $path ); |
49 | 55 | } |
50 | 56 | |
57 | + /** |
|
58 | + * @param string $path |
|
59 | + */ |
|
51 | 60 | function fs_get_template( $path, &$params = null ) { |
52 | 61 | ob_start(); |
53 | 62 | |
@@ -60,10 +69,19 @@ discard block |
||
60 | 69 | |
61 | 70 | /* Scripts and styles including. |
62 | 71 | --------------------------------------------------------------------------------------------*/ |
72 | + |
|
73 | + /** |
|
74 | + * @param string $handle |
|
75 | + * @param string $path |
|
76 | + */ |
|
63 | 77 | function fs_enqueue_local_style( $handle, $path, $deps = array(), $ver = false, $media = 'all' ) { |
64 | 78 | wp_enqueue_style( $handle, plugins_url( plugin_basename( WP_FS__DIR_CSS . '/' . trim( $path, '/' ) ) ), $deps, $ver, $media ); |
65 | 79 | } |
66 | 80 | |
81 | + /** |
|
82 | + * @param string $handle |
|
83 | + * @param string $path |
|
84 | + */ |
|
67 | 85 | function fs_enqueue_local_script( $handle, $path, $deps = array(), $ver = false, $in_footer = 'all' ) { |
68 | 86 | wp_enqueue_script( $handle, plugins_url( plugin_basename( WP_FS__DIR_JS . '/' . trim( $path, '/' ) ) ), $deps, $ver, $in_footer ); |
69 | 87 | } |
@@ -103,6 +121,9 @@ discard block |
||
103 | 121 | return $value; |
104 | 122 | } |
105 | 123 | |
124 | + /** |
|
125 | + * @param string $key |
|
126 | + */ |
|
106 | 127 | function fs_request_has( $key ) { |
107 | 128 | return isset( $_REQUEST[ $key ] ); |
108 | 129 | } |
@@ -147,6 +168,9 @@ discard block |
||
147 | 168 | return false; |
148 | 169 | } |
149 | 170 | |
171 | + /** |
|
172 | + * @param string $action |
|
173 | + */ |
|
150 | 174 | function fs_request_is_action( $action, $action_key = 'action' ) { |
151 | 175 | return ( strtolower( $action ) === fs_get_action( $action_key ) ); |
152 | 176 | } |
@@ -185,6 +209,9 @@ discard block |
||
185 | 209 | return true; |
186 | 210 | } |
187 | 211 | |
212 | + /** |
|
213 | + * @param string $page_slug |
|
214 | + */ |
|
188 | 215 | function fs_is_plugin_page( $page_slug ) { |
189 | 216 | return ( is_admin() && $page_slug === fs_request_get('page') ); |
190 | 217 | } |
@@ -326,7 +353,7 @@ discard block |
||
326 | 353 | * @since ~1.1.3 |
327 | 354 | * |
328 | 355 | * @param string $actionurl URL to add nonce action. |
329 | - * @param int|string $action Optional. Nonce action name. Default -1. |
|
356 | + * @param integer $action Optional. Nonce action name. Default -1. |
|
330 | 357 | * @param string $name Optional. Nonce name. Default '_wpnonce'. |
331 | 358 | * |
332 | 359 | * @return string Escaped URL with nonce action added. |
@@ -45,7 +45,7 @@ discard block |
||
45 | 45 | * @param bool $exit If true, exit after redirect (Since 1.2.1.5). |
46 | 46 | * @param int $status Status code to use. |
47 | 47 | * |
48 | - * @return bool False if $location is not set |
|
48 | + * @return null|boolean False if $location is not set |
|
49 | 49 | */ |
50 | 50 | function fs_redirect( $location, $exit = true, $status = 302 ) { |
51 | 51 | global $is_IIS; |
@@ -443,7 +443,7 @@ discard block |
||
443 | 443 | * @param string $tag The name of the filter hook. |
444 | 444 | * @param mixed $value The value on which the filters hooked to `$tag` are applied on. |
445 | 445 | * |
446 | - * @return mixed The filtered value after all hooked functions are applied to it. |
|
446 | + * @return string|boolean The filtered value after all hooked functions are applied to it. |
|
447 | 447 | * |
448 | 448 | * @uses apply_filters() |
449 | 449 | */ |
@@ -101,6 +101,9 @@ discard block |
||
101 | 101 | return self::$_instances[ $plugin_slug ]; |
102 | 102 | } |
103 | 103 | |
104 | + /** |
|
105 | + * @param string $plugin_slug |
|
106 | + */ |
|
104 | 107 | protected function __construct( $plugin_slug ) { |
105 | 108 | $this->_logger = FS_Logger::get_logger( WP_FS__SLUG . '_' . $plugin_slug . '_admin_menu', WP_FS__DEBUG_SDK, WP_FS__ECHO_DEBUG_SDK ); |
106 | 109 | |
@@ -111,10 +114,16 @@ discard block |
||
111 | 114 | |
112 | 115 | #region Helpers |
113 | 116 | |
117 | + /** |
|
118 | + * @param string $key |
|
119 | + */ |
|
114 | 120 | private function get_option( &$options, $key, $default = false ) { |
115 | 121 | return ! empty( $options[ $key ] ) ? $options[ $key ] : $default; |
116 | 122 | } |
117 | 123 | |
124 | + /** |
|
125 | + * @param string $key |
|
126 | + */ |
|
118 | 127 | private function get_bool_option( &$options, $key, $default = false ) { |
119 | 128 | return isset( $options[ $key ] ) && is_bool( $options[ $key ] ) ? $options[ $key ] : $default; |
120 | 129 | } |
@@ -50,6 +50,9 @@ discard block |
||
50 | 50 | return self::$_instances[ $slug ]; |
51 | 51 | } |
52 | 52 | |
53 | + /** |
|
54 | + * @param string $slug |
|
55 | + */ |
|
53 | 56 | protected function __construct( $slug, $title = '' ) { |
54 | 57 | $this->_logger = FS_Logger::get_logger( WP_FS__SLUG . '_' . $slug . '_data', WP_FS__DEBUG_SDK, WP_FS__ECHO_DEBUG_SDK ); |
55 | 58 | |
@@ -258,7 +261,7 @@ discard block |
||
258 | 261 | * @author Vova Feldman (@svovaf) |
259 | 262 | * @since 1.0.9 |
260 | 263 | * |
261 | - * @param $id |
|
264 | + * @param string $id |
|
262 | 265 | * |
263 | 266 | * @return bool |
264 | 267 | */ |
@@ -44,7 +44,7 @@ |
||
44 | 44 | * @author Vova Feldman (@svovaf) |
45 | 45 | * @since 1.1.6 |
46 | 46 | * |
47 | - * @param $id |
|
47 | + * @param string $id |
|
48 | 48 | * |
49 | 49 | * @return FS_Cache_Manager |
50 | 50 | */ |