cookiebot / addons / controller / addons / cookiebot-addons-interface.php

cookiebot-addons-interface.php in Cookiebot by Usercentrics – Automatic Cookie Banner for GDPR/CCPA & Google Consent Mode 3.0.1, at addons/controller/addons/cookiebot-addons-interface.php

200 lines 3.5 KB

Raw Download Zip

1	<?php
2
3	namespace cookiebot_addons\controller\addons;
4
5	use cookiebot_addons\lib\buffer\Buffer_Output_Interface;
6	use cookiebot_addons\lib\Cookie_Consent_Interface;
7	use cookiebot_addons\lib\Settings_Service_Interface;
8	use cookiebot_addons\lib\script_loader_tag\Script_Loader_Tag_Interface;
9
10	Interface Cookiebot_Addons_Interface {
11
12	/**
13	* Cookiebot_Addons_Interface constructor.
14	*
15	* @param Settings_Service_Interface $settings
16	* @param Script_Loader_Tag_Interface $script_loader_tag
17	* @param Cookie_Consent_Interface $cookie_consent
18	* @param Buffer_Output_Interface $buffer_output
19	*/
20	public function __construct( Settings_Service_Interface $settings, Script_Loader_Tag_Interface $script_loader_tag, Cookie_Consent_Interface $cookie_consent, Buffer_Output_Interface $buffer_output );
21
22	/**
23	* Loads addon configuration
24	*
25	* @since 1.3.0
26	*/
27	public function load_configuration();
28
29	/**
30	* Return addon/plugin name
31	*
32	* @return string
33	*
34	* @since 1.3.0
35	*/
36	public function get_addon_name();
37
38	/**
39	* Default placeholder content
40	*
41	* @return string
42	*
43	* @since 1.8.0
44	*/
45	public function get_default_placeholder();
46
47	/**
48	* Get placeholder content
49	*
50	* This function will check following features:
51	* - Current language
52	*
53	* @param $src string
54	*
55	* @return bool\|mixed
56	*
57	* @since 1.8.0
58	*/
59	public function get_placeholder( $src = '' );
60
61	/**
62	* Option name in the database
63	*
64	* @return string
65	*
66	* @since 1.3.0
67	*/
68	public function get_option_name();
69
70	/**
71	* Plugin file name
72	*
73	* @return string
74	*
75	* @since 1.3.0
76	*/
77	public function get_plugin_file();
78
79	/**
80	* Returns checked cookie types
81	* @return mixed
82	*
83	* @since 1.3.0
84	*/
85	public function get_cookie_types();
86
87	/**
88	* Returns default cookie types
89	* @return mixed
90	*
91	* @since 1.3.0
92	*/
93	public function get_default_cookie_types();
94
95	/**
96	* Check if plugin is activated and checked in the backend
97	*
98	* @since 1.3.0
99	*/
100	public function is_addon_enabled();
101
102	/**
103	* Checks if addon is installed
104	*
105	* @since 1.3.0
106	*/
107	public function is_addon_installed();
108
109	/**
110	* Checks if addon is activated
111	*
112	* @since 1.3.0
113	*/
114	public function is_addon_activated();
115
116	/**
117	* Retrieves current installed version of the addon
118	*
119	* @return bool
120	*
121	* @since 2.2.1
122	*/
123	public function get_addon_version();
124
125	/**
126	* Checks if it does have custom placeholder content
127	*
128	* @return mixed
129	*
130	* @since 1.8.0
131	*/
132	public function has_placeholder();
133
134	/**
135	* returns all placeholder contents
136	*
137	* @return mixed
138	*
139	* @since 1.8.0
140	*/
141	public function get_placeholders();
142
143	/**
144	* Return true if the placeholder is enabled
145	*
146	* @return mixed
147	*
148	* @since 1.8.0
149	*/
150	public function is_placeholder_enabled();
151
152	/**
153	* Adds extra information under the label
154	*
155	* @return string
156	*
157	* @since 1.8.0
158	*/
159	public function get_extra_information();
160
161	/**
162	* Returns the url of WordPress SVN repository or another link where we can verify the plugin file.
163	*
164	* @return boolean
165	*
166	* @since 1.8.0
167	*/
168	public function get_svn_url();
169
170	/**
171	* Placeholder helper overlay in the settings page.
172	*
173	* @return string
174	*
175	* @since 1.8.0
176	*/
177	public function get_placeholder_helper();
178
179	/**
180	* Action after enabling the addon on the settings page
181	*
182	* @since 2.2.0
183	*/
184	public function post_hook_after_enabling();
185
186	/**
187	* Cookiebot plugin is deactivated
188	*
189	* @since 2.2.0
190	*/
191	public function plugin_deactivated();
192
193	/**
194	* @return mixed
195	*
196	* @since 2.4.5
197	*/
198	public function extra_available_addon_option();
199	}
200