| @@ -28,10 +28,8 @@ | ||
| 28 | 28 | } |
| 29 | 29 | |
| 30 | 30 | /** |
| 31 | 31 | * @since 4.05 |
| 32 | - * | |
| 33 | - * @return void | |
| 34 | 32 | */ |
| 35 | 33 | protected function set_cache_key() { |
| 36 | 34 | $this->cache_key = 'frm_inbox_cache'; |
| 37 | 35 | } |
| @@ -37,10 +35,8 @@ | ||
| 37 | 35 | } |
| 38 | 36 | |
| 39 | 37 | /** |
| 40 | 38 | * @since 4.05 |
| 41 | - * | |
| 42 | - * @return string | |
| 43 | 39 | */ |
| 44 | 40 | protected function api_url() { |
| 45 | 41 | return 'https://formidableforms.com/wp-json/inbox/v1/message/'; |
| 46 | 42 | } |
| @@ -46,10 +42,8 @@ | ||
| 46 | 42 | } |
| 47 | 43 | |
| 48 | 44 | /** |
| 49 | 45 | * @since 4.05 |
| 50 | - * | |
| 51 | - * @param false|string $filter | |
| 52 | 46 | */ |
| 53 | 47 | public function get_messages( $filter = false ) { |
| 54 | 48 | $messages = self::$messages; |
| 55 | 49 | if ( $filter === 'filter' ) { |
| @@ -59,10 +53,8 @@ | ||
| 59 | 53 | } |
| 60 | 54 | |
| 61 | 55 | /** |
| 62 | 56 | * @since 4.05 |
| 63 | - * | |
| 64 | - * @return void | |
| 65 | 57 | */ |
| 66 | 58 | public function set_messages() { |
| 67 | 59 | self::$messages = get_option( $this->option ); |
| 68 | 60 | if ( ! is_array( self::$messages ) ) { |
| @@ -78,10 +70,8 @@ | ||
| 78 | 70 | } |
| 79 | 71 | |
| 80 | 72 | /** |
| 81 | 73 | * @since 4.05 |
| 82 | - * | |
| 83 | - * @return void | |
| 84 | 74 | */ |
| 85 | 75 | private function add_api_messages() { |
| 86 | 76 | $api = $this->get_api_info(); |
| 87 | 77 | if ( empty( $api ) ) { |
| @@ -94,10 +84,8 @@ | ||
| 94 | 84 | } |
| 95 | 85 | |
| 96 | 86 | /** |
| 97 | 87 | * @param array|string $message |
| 98 | - * | |
| 99 | - * @return void | |
| 100 | 88 | */ |
| 101 | 89 | public function add_message( $message ) { |
| 102 | 90 | if ( ! is_array( $message ) || ! isset( $message['key'] ) ) { |
| 103 | 91 | // if the API response is invalid, $message may not be an array. |
| @@ -126,13 +114,8 @@ | ||
| 126 | 114 | |
| 127 | 115 | $this->clean_messages(); |
| 128 | 116 | } |
| 129 | 117 | |
| 130 | - /** | |
| 131 | - * @param array $message | |
| 132 | - * | |
| 133 | - * @return void | |
| 134 | - */ | |
| 135 | 118 | private function fill_message( &$message ) { |
| 136 | 119 | $defaults = array( |
| 137 | 120 | 'time' => time(), |
| 138 | 121 | 'message' => '', |
| @@ -149,11 +132,8 @@ | ||
| 149 | 132 | $message['created'] = $message['time']; |
| 150 | 133 | unset( $message['time'] ); |
| 151 | 134 | } |
| 152 | 135 | |
| 153 | - /** | |
| 154 | - * @return void | |
| 155 | - */ | |
| 156 | 136 | private function clean_messages() { |
| 157 | 137 | $removed = false; |
| 158 | 138 | foreach ( self::$messages as $t => $message ) { |
| 159 | 139 | $read = isset( $message['read'] ) && ! empty( $message['read'] ) && isset( $message['read'][ get_current_user_id() ] ) && $message['read'][ get_current_user_id() ] < strtotime( '-1 month' ); |
| @@ -169,11 +149,8 @@ | ||
| 169 | 149 | $this->update_list(); |
| 170 | 150 | } |
| 171 | 151 | } |
| 172 | 152 | |
| 173 | - /** | |
| 174 | - * @return void | |
| 175 | - */ | |
| 176 | 153 | private function filter_messages( &$messages ) { |
| 177 | 154 | $user_id = get_current_user_id(); |
| 178 | 155 | foreach ( $messages as $k => $message ) { |
| 179 | 156 | $dismissed = isset( $message['dismissed'] ) && isset( $message['dismissed'][ $user_id ] ); |
| @@ -185,13 +162,8 @@ | ||
| 185 | 162 | } |
| 186 | 163 | $messages = apply_filters( 'frm_filter_inbox', $messages ); |
| 187 | 164 | } |
| 188 | 165 | |
| 189 | - /** | |
| 190 | - * @param array $message | |
| 191 | - * | |
| 192 | - * @return bool | |
| 193 | - */ | |
| 194 | 166 | private function is_expired( $message ) { |
| 195 | 167 | return isset( $message['expires'] ) && ! empty( $message['expires'] ) && $message['expires'] < time(); |
| 196 | 168 | } |
| 197 | 169 | |
| @@ -221,10 +193,8 @@ | ||
| 221 | 193 | } |
| 222 | 194 | |
| 223 | 195 | /** |
| 224 | 196 | * @param string $key |
| 225 | - * | |
| 226 | - * @return void | |
| 227 | 197 | */ |
| 228 | 198 | public function mark_read( $key ) { |
| 229 | 199 | if ( ! $key || ! isset( self::$messages[ $key ] ) ) { |
| 230 | 200 | return; |
| @@ -241,10 +211,8 @@ | ||
| 241 | 211 | /** |
| 242 | 212 | * @param string $key |
| 243 | 213 | * |
| 244 | 214 | * @since 4.05.02 |
| 245 | - * | |
| 246 | - * @return void | |
| 247 | 215 | */ |
| 248 | 216 | public function mark_unread( $key ) { |
| 249 | 217 | $is_read = isset( self::$messages[ $key ] ) && isset( self::$messages[ $key ]['read'] ) && isset( self::$messages[ $key ]['read'][ get_current_user_id() ] ); |
| 250 | 218 | if ( $is_read ) { |
| @@ -254,10 +222,8 @@ | ||
| 254 | 222 | } |
| 255 | 223 | |
| 256 | 224 | /** |
| 257 | 225 | * @param string $key |
| 258 | - * | |
| 259 | - * @return void | |
| 260 | 226 | */ |
| 261 | 227 | public function dismiss( $key ) { |
| 262 | 228 | if ( $key === 'all' ) { |
| 263 | 229 | $this->dismiss_all(); |
| @@ -277,10 +243,8 @@ | ||
| 277 | 243 | } |
| 278 | 244 | |
| 279 | 245 | /** |
| 280 | 246 | * @since 4.06 |
| 281 | - * | |
| 282 | - * @return void | |
| 283 | 247 | */ |
| 284 | 248 | private function dismiss_all() { |
| 285 | 249 | $user_id = get_current_user_id(); |
| 286 | 250 | foreach ( self::$messages as $key => $message ) { |
| @@ -321,12 +285,8 @@ | ||
| 321 | 285 | } |
| 322 | 286 | |
| 323 | 287 | /** |
| 324 | 288 | * @since 4.05.02 |
| 325 | - * | |
| 326 | - * @param string $key | |
| 327 | - * | |
| 328 | - * @return void | |
| 329 | 289 | */ |
| 330 | 290 | public function remove( $key ) { |
| 331 | 291 | if ( isset( self::$messages[ $key ] ) ) { |
| 332 | 292 | unset( self::$messages[ $key ] ); |
| @@ -333,32 +293,20 @@ | ||
| 333 | 293 | $this->update_list(); |
| 334 | 294 | } |
| 335 | 295 | } |
| 336 | 296 | |
| 337 | - /** | |
| 338 | - * @return void | |
| 339 | - */ | |
| 340 | 297 | private function update_list() { |
| 341 | 298 | update_option( $this->option, self::$messages, 'no' ); |
| 342 | 299 | } |
| 343 | 300 | |
| 344 | - /** | |
| 345 | - * Show a banner message if one is available. | |
| 346 | - * | |
| 347 | - * @return bool True if a banner is available and shown. | |
| 348 | - */ | |
| 349 | 301 | public static function maybe_show_banner() { |
| 350 | 302 | if ( empty( self::$banner_messages ) ) { |
| 351 | - return false; | |
| 303 | + return; | |
| 352 | 304 | } |
| 353 | 305 | $message = end( self::$banner_messages ); |
| 354 | 306 | require FrmAppHelper::plugin_path() . '/classes/views/inbox/banner.php'; |
| 355 | - return true; | |
| 356 | 307 | } |
| 357 | 308 | |
| 358 | - /** | |
| 359 | - * @return void | |
| 360 | - */ | |
| 361 | 309 | public static function maybe_disable_screen_options() { |
| 362 | 310 | self::$banner_messages = self::get_banner_messages(); |
| 363 | 311 | if ( self::$banner_messages ) { |
| 364 | 312 | // disable screen options tab when displaying banner messages because it gets in the way of the banner. |