cookiebot / src / lib / Settings_Service_Interface.php

Settings_Service_Interface.php in Cookiebot by Usercentrics – Automatic Cookie Banner for GDPR/CCPA & Google Consent Mode 4.7.3, at src/lib/Settings_Service_Interface.php

107 lines 1.9 KB

Raw Download Zip

1	<?php
2
3	namespace cybot\cookiebot\lib;
4
5	use Exception;
6	use Generator;
7
8	/**
9	* Interface Settings_Service_Interface
10	*
11	* @package cybot\cookiebot\lib
12	*/
13	interface Settings_Service_Interface {
14
15
16	/**
17	* Settings_Service constructor.
18	*
19	* @param $container Dependency_Container
20	*
21	* @since 1.3.0
22	*/
23	public function __construct( $container );
24
25	/**
26	* Returns true if the addon is enabled in the backend
27	*
28	* @param $addon string option name
29	*
30	* @return mixed
31	*
32	* @since 1.3.0
33	*/
34	public function is_addon_enabled( $addon );
35
36	/**
37	* Returns all cookie type for given addon
38	*
39	* @param $addon string option name
40	* @param $default array default cookie types
41	*
42	* @return array
43	*
44	* @since 1.3.0
45	*/
46	public function get_cookie_types( $addon, $default = array() );
47
48	/**
49	* Returns regex for given addon
50	*
51	* @param $addon string option name
52	* @param $default string default regex
53	*
54	* @return string
55	*
56	* @since 2.4.5
57	*/
58	public function get_addon_regex( $addon, $default = '' );
59
60	/**
61	* Returns addons one by one through a generator
62	*
63	* @return Generator
64	* @throws Exception
65	*
66	* @since 1.3.0
67	*/
68	public function get_addons();
69
70	/**
71	* Returns active addons
72	*
73	* @return array
74	* @throws Exception
75	*
76	* @since 1.3.0
77	*/
78	public function get_active_addons();
79
80	/**
81	* returns the placeholder if it does exist
82	*
83	* @param $option_key
84	* @param $default_placeholder
85	* @param $cookies
86	* @param string $src
87	*
88	* @return mixed
89	*/
90	public function get_placeholder( $option_key, $default_placeholder, $cookies, $src = '' );
91
92	/**
93	* The cookiebot plugin is deactivated
94	* so run this function to cleanup the addons.
95	*
96	* @since 2.2.0
97	*/
98	public function cookiebot_deactivated();
99
100	/**
101	* The cookiebot plugin is activated and the addon settings is activated
102	*
103	* @since 3.6.3
104	*/
105	public function cookiebot_activated();
106	}
107