buffer
5 years ago
ioc
6 years ago
script-loader-tag
7 years ago
autoloader.php
7 years ago
cookie-consent-interface.php
7 years ago
cookie-consent.php
7 years ago
helper.php
5 years ago
settings-service-interface.php
5 years ago
settings-service.php
5 years ago
theme-settings-service.php
5 years ago
settings-service-interface.php
162 lines
| 1 | <?php |
| 2 | |
| 3 | namespace cookiebot_addons\lib; |
| 4 | |
| 5 | use cookiebot_addons\controller\addons\Cookiebot_Addons_Interface; |
| 6 | use Cybot\Dependencies\DI; |
| 7 | |
| 8 | Interface Settings_Service_Interface { |
| 9 | |
| 10 | /** |
| 11 | * Settings_Service constructor. |
| 12 | * |
| 13 | * @param $container DI\Container |
| 14 | * |
| 15 | * @since 1.3.0 |
| 16 | */ |
| 17 | public function __construct( $container ); |
| 18 | |
| 19 | /** |
| 20 | * Returns true if the addon is enabled in the backend |
| 21 | * |
| 22 | * @param $addon string option name |
| 23 | * |
| 24 | * @return mixed |
| 25 | * |
| 26 | * @since 1.3.0 |
| 27 | */ |
| 28 | public function is_addon_enabled( $addon ); |
| 29 | |
| 30 | /** |
| 31 | * Returns true if the addon is installed |
| 32 | * |
| 33 | * @param $addon string plugin file, for example: test/test.php |
| 34 | * |
| 35 | * @return int|\WP_Error |
| 36 | * |
| 37 | * @since 1.3.0 |
| 38 | */ |
| 39 | public function is_addon_installed( $addon ); |
| 40 | |
| 41 | /** |
| 42 | * Returns true if the addon plugin is activated |
| 43 | * |
| 44 | * @param $addon string plugin file, for example: test/test.php |
| 45 | * |
| 46 | * @return bool |
| 47 | * |
| 48 | * @since 1.3.0 |
| 49 | */ |
| 50 | public function is_addon_activated( $addon ); |
| 51 | |
| 52 | /** |
| 53 | * Returns the addon version |
| 54 | * |
| 55 | * @param $addon |
| 56 | * |
| 57 | * @return bool |
| 58 | * |
| 59 | * @since 2.2.1 |
| 60 | */ |
| 61 | public function get_addon_version( $addon ); |
| 62 | |
| 63 | /** |
| 64 | * Returns all cookie type for given addon |
| 65 | * |
| 66 | * @param $addon string option name |
| 67 | * @param $default array default cookie types |
| 68 | * |
| 69 | * @return array |
| 70 | * |
| 71 | * @since 1.3.0 |
| 72 | */ |
| 73 | public function get_cookie_types( $addon, $default = array() ); |
| 74 | |
| 75 | /** |
| 76 | * Returns regex for given addon |
| 77 | * |
| 78 | * @param $addon string option name |
| 79 | * @param $default string default regex |
| 80 | * |
| 81 | * @return string |
| 82 | * |
| 83 | * @since 2.4.5 |
| 84 | */ |
| 85 | public function get_addon_regex( $addon, $default = '' ); |
| 86 | |
| 87 | /** |
| 88 | * Returns addons one by one through a generator |
| 89 | * |
| 90 | * @return \Generator |
| 91 | * @throws DI\DependencyException |
| 92 | * @throws DI\NotFoundException |
| 93 | * |
| 94 | * @since 1.3.0 |
| 95 | */ |
| 96 | public function get_addons(); |
| 97 | |
| 98 | /** |
| 99 | * Returns active addons |
| 100 | * |
| 101 | * @return array |
| 102 | * @throws DI\DependencyException |
| 103 | * @throws DI\NotFoundException |
| 104 | * |
| 105 | * @since 1.3.0 |
| 106 | */ |
| 107 | public function get_active_addons(); |
| 108 | |
| 109 | /** |
| 110 | * returns the placeholder if it does exist |
| 111 | * |
| 112 | * @param $option_key |
| 113 | * @param $default_placeholder |
| 114 | * @param $cookies |
| 115 | * |
| 116 | * @return bool|mixed |
| 117 | * |
| 118 | * @since 1.8.0 |
| 119 | */ |
| 120 | public function get_placeholder( $option_key, $default_placeholder, $cookies ); |
| 121 | |
| 122 | |
| 123 | /** |
| 124 | * Check if the previous version is active |
| 125 | * |
| 126 | * @param $addons array List of addons |
| 127 | * @param $addon_class string The name of the class |
| 128 | * |
| 129 | * @return bool |
| 130 | * |
| 131 | * @since 2.1.3 |
| 132 | */ |
| 133 | public function is_previous_version_active( $addons, $addon_class ); |
| 134 | |
| 135 | /** |
| 136 | * Checks if the addon is the latest plugin version. |
| 137 | * Latest plugin version doesn't have extended class. |
| 138 | * |
| 139 | * @param $addon |
| 140 | * |
| 141 | * @return bool |
| 142 | * |
| 143 | * @since 2.1.3 |
| 144 | */ |
| 145 | public function is_latest_plugin_version( $addon ); |
| 146 | |
| 147 | /** |
| 148 | * The cookiebot plugin is deactivated |
| 149 | * so run this function to cleanup the addons. |
| 150 | * |
| 151 | * @since 2.2.0 |
| 152 | */ |
| 153 | public function cookiebot_deactivated(); |
| 154 | |
| 155 | /** |
| 156 | * The cookiebot plugin is activated and the addon settings is activated |
| 157 | * |
| 158 | * @since 3.6.3 |
| 159 | */ |
| 160 | public function cookiebot_activated(); |
| 161 | } |
| 162 |