stripe / src / AdminNotice / AdminNoticeInterface.php

AdminNoticeInterface.php in Stripe Payment Forms by WP Simple Pay – Accept Credit Card Payments + Subscriptions with Stripe trunk, at src/AdminNotice/AdminNoticeInterface.php

103 lines 1.6 KB

Raw Download Zip

1	<?php
2	/**
3	* Admin notice: Interface
4	*
5	* @package SimplePay
6	* @subpackage Core
7	* @copyright Copyright (c) 2021, Sandhills Development, LLC
8	* @license http://opensource.org/licenses/gpl-2.0.php GNU Public License
9	* @since 4.4.1
10	*/
11
12	namespace SimplePay\Core\AdminNotice;
13
14	/**
15	* AdminNoticeInterface interface.
16	*
17	* @since 4.4.1
18	*/
19	interface AdminNoticeInterface {
20
21	/**
22	* Returns the admin notice ID.
23	*
24	* @since 4.4.1
25	*
26	* @return string
27	*/
28	public function get_id();
29
30	/**
31	* Returns the admin notice type.
32	*
33	* @since 4.4.1
34	*
35	* @return 'error'\|'warning'\|'success'\|'info'
36	*/
37	public function get_type();
38
39	/**
40	* Determines if the notice can be dismissed.
41	*
42	* @since 4.4.1
43	*
44	* @return bool
45	*/
46	public function is_dismissible();
47
48	/**
49	* Returns the length of time (in seconds) the notice should be dismissed before reappearing.
50	*
51	* @since 4.4.1
52	*
53	* @return int
54	*/
55	public function get_dismissal_length();
56
57	/**
58	* Determines if the admin notice has been dismissed.
59	*
60	* @since 4.4.1
61	*
62	* @return bool
63	*/
64	public function is_dismissed();
65
66	/**
67	* Determines if the admin notice should be displayed.
68	*
69	* @since 4.4.1
70	*
71	* @return bool
72	*/
73	public function should_display();
74
75	/**
76	* Returns the notice's data.
77	*
78	* @since 4.4.1
79	*
80	* @return array<mixed>
81	*/
82	public function get_notice_data();
83
84	/**
85	* Returns the full path to the notice view.
86	*
87	* @since 4.4.1
88	*
89	* @return string
90	*/
91	public function get_view();
92
93	/**
94	* Renders the admin notice view.
95	*
96	* @since 4.4.1
97	*
98	* @return void
99	*/
100	public function render();
101
102	}
103