BlockCompatibility.php
3 weeks ago
FlexibleWishlistReview.php
3 weeks ago
Notice.php
3 weeks ago
NoticeIntegration.php
3 weeks ago
ReviewNotice.php
3 weeks ago
Notice.php
50 lines
| 1 | <?php |
| 2 | |
| 3 | namespace WPDesk\FCF\Free\Notice; |
| 4 | |
| 5 | /** |
| 6 | * Interface for class that supports notice displayed in admin panel. |
| 7 | */ |
| 8 | interface Notice { |
| 9 | |
| 10 | /** |
| 11 | * Returns unique key of notice. |
| 12 | * |
| 13 | * @return string |
| 14 | */ |
| 15 | public function get_notice_name(): string; |
| 16 | |
| 17 | /** |
| 18 | * Returns status if notice is active. |
| 19 | * |
| 20 | * @return bool Do show notice? |
| 21 | */ |
| 22 | public function is_active(): bool; |
| 23 | |
| 24 | /** |
| 25 | * Returns server path for view template. |
| 26 | * |
| 27 | * @return string Server path relative to plugin /templates directory. |
| 28 | */ |
| 29 | public function get_template_path(): string; |
| 30 | |
| 31 | /** |
| 32 | * Returns variables with values using in view template. |
| 33 | * |
| 34 | * @return string[] Args extract in view template. |
| 35 | */ |
| 36 | public function get_vars_for_view(): array; |
| 37 | |
| 38 | /** |
| 39 | * Disables visible notice. |
| 40 | * |
| 41 | * @param bool $is_permanently . |
| 42 | * |
| 43 | * @return void |
| 44 | * @internal |
| 45 | */ |
| 46 | public function set_notice_as_hidden( bool $is_permanently ); |
| 47 | |
| 48 | public function add_notice_scripts(): void; |
| 49 | } |
| 50 |