Plugin.php
299 lines
| 1 | <?php |
| 2 | |
| 3 | namespace EmbedPress\Plugins; |
| 4 | |
| 5 | (defined('ABSPATH') && defined('EMBEDPRESS_IS_LOADED')) or die("No direct script access allowed."); |
| 6 | |
| 7 | /** |
| 8 | * Entity that represents a model to EmbedPress plugins. |
| 9 | * |
| 10 | * @package EmbedPress |
| 11 | * @author EmbedPress <help@embedpress.com> |
| 12 | * @copyright Copyright (C) 2020 WPDeveloper. All rights reserved. |
| 13 | * @license GPLv3 or later |
| 14 | * @since 1.4.0 |
| 15 | * @abstract |
| 16 | */ |
| 17 | abstract class Plugin |
| 18 | { |
| 19 | const VERSION = '0.0.0'; |
| 20 | |
| 21 | /** |
| 22 | * Method that register all EmbedPress events. |
| 23 | * |
| 24 | * @since 1.4.0 |
| 25 | * @static |
| 26 | * |
| 27 | * @return void |
| 28 | */ |
| 29 | public static function registerEvents() |
| 30 | { |
| 31 | // do nothing |
| 32 | } |
| 33 | |
| 34 | /** |
| 35 | * Method that checks if EmbedPress is active or not. |
| 36 | * |
| 37 | * @since 1.4.0 |
| 38 | * @access protected |
| 39 | * @static |
| 40 | * |
| 41 | * @return boolean |
| 42 | */ |
| 43 | protected static function isEmbedPressActive() |
| 44 | { |
| 45 | return is_plugin_active(EMBEDPRESS_PLG_NAME . '/' . EMBEDPRESS_PLG_NAME . '.php'); |
| 46 | } |
| 47 | |
| 48 | /** |
| 49 | * Retrieve an error message based on its code. |
| 50 | * |
| 51 | * @since 1.4.0 |
| 52 | * @access protected |
| 53 | * @static |
| 54 | * |
| 55 | * @param string $err The error code. |
| 56 | * |
| 57 | * @return string |
| 58 | */ |
| 59 | protected static function getErrorMessage($err = '') |
| 60 | { |
| 61 | if ($err === 'ERR_MISSING_DEPENDENCY') { |
| 62 | return __('Please, <strong>install</strong> and <strong>activate <a href="https://wordpress.org/plugins/' . EMBEDPRESS_PLG_NAME . '" target="_blank" rel="noopener noreferrer">' . EMBEDPRESS . '</a></strong> plugin in order to make <em>' . EMBEDPRESS . ' - ' . static::NAME . '</em> to work.'); |
| 63 | } |
| 64 | |
| 65 | return $err; |
| 66 | } |
| 67 | |
| 68 | /** |
| 69 | * Callback triggered by WordPress' 'admin_init' default action. |
| 70 | * |
| 71 | * @since 1.4.0 |
| 72 | * @static |
| 73 | * |
| 74 | * @return void |
| 75 | */ |
| 76 | public static function onLoadAdminCallback() |
| 77 | { |
| 78 | $pluginSignature = EMBEDPRESS_PLG_NAME . '-' . static::SLUG . '/' . EMBEDPRESS_PLG_NAME . '-' . static::SLUG . '.php'; |
| 79 | if (is_admin() && ! self::isEmbedPressActive() && is_plugin_active($pluginSignature)) { |
| 80 | deactivate_plugins($pluginSignature); |
| 81 | } else { |
| 82 | static::registerSettings(); |
| 83 | } |
| 84 | } |
| 85 | |
| 86 | /** |
| 87 | * Callback triggered by WordPress' 'register_activation_hook' function. |
| 88 | * |
| 89 | * @since 1.4.0 |
| 90 | * @static |
| 91 | * |
| 92 | * @return void |
| 93 | */ |
| 94 | public static function onActivationCallback() |
| 95 | { |
| 96 | return true; |
| 97 | } |
| 98 | |
| 99 | /** |
| 100 | * Callback triggered by WordPress' 'register_deactivation_hook' function. |
| 101 | * |
| 102 | * @since 1.4.0 |
| 103 | * @static |
| 104 | * |
| 105 | * @return void |
| 106 | */ |
| 107 | public static function onDeactivationCallback() |
| 108 | { |
| 109 | delete_option(EMBEDPRESS_PLG_NAME . ':' . static::SLUG); |
| 110 | } |
| 111 | |
| 112 | /** |
| 113 | * Method that validates the EmbedPress plugin's settings form. |
| 114 | * |
| 115 | * @since 1.4.0 |
| 116 | * @static |
| 117 | * |
| 118 | * @param array $postData The data coming from the form via POST. |
| 119 | * |
| 120 | * @return array |
| 121 | */ |
| 122 | public static function validateForm($postData) |
| 123 | { |
| 124 | $pluginSlugNonce = EMBEDPRESS_PLG_NAME . ':' . static::SLUG . ':nonce'; |
| 125 | if ( ! check_admin_referer($pluginSlugNonce, $pluginSlugNonce)) { |
| 126 | return; |
| 127 | } |
| 128 | |
| 129 | $data = []; |
| 130 | |
| 131 | $schema = static::getOptionsSchema(); |
| 132 | foreach ($schema as $fieldSlug => $field) { |
| 133 | if (isset($postData[$fieldSlug])) { |
| 134 | $value = $postData[$fieldSlug]; |
| 135 | } else { |
| 136 | $value = isset($field['default']) ? $field['default'] : null; |
| 137 | } |
| 138 | |
| 139 | settype($value, isset($field['type']) && in_array(strtolower($field['type']), |
| 140 | ['bool', 'boolean', 'int', 'integer', 'float', 'string']) ? $field['type'] : 'string'); |
| 141 | |
| 142 | $data[$fieldSlug] = $value; |
| 143 | } |
| 144 | $data['license_key'] = true; |
| 145 | static::onAfterFormValidation($data); |
| 146 | |
| 147 | return $data; |
| 148 | } |
| 149 | |
| 150 | /** |
| 151 | * Method called right after the settings form being validated but before saving the data into DB. |
| 152 | * |
| 153 | * @since 1.4.0 |
| 154 | * @static |
| 155 | * |
| 156 | * @param array Data after validation. |
| 157 | * |
| 158 | * @return void |
| 159 | */ |
| 160 | public static function onAfterFormValidation(&$data) |
| 161 | { |
| 162 | // do nothing |
| 163 | } |
| 164 | |
| 165 | /** |
| 166 | * Method that appends a tab in EmbedPress' Settings page to the plugin. |
| 167 | * |
| 168 | * @since 1.4.0 |
| 169 | * @static |
| 170 | * |
| 171 | * @param $activeTab |
| 172 | * |
| 173 | * @return void |
| 174 | */ |
| 175 | public static function renderTab($activeTab) |
| 176 | { |
| 177 | ?> |
| 178 | |
| 179 | <a href="?page=<?php echo EMBEDPRESS_PLG_NAME; ?>&tab=<?php echo static::SLUG; ?>" |
| 180 | class="nav-tab<?php echo $activeTab === static::SLUG ? ' nav-tab-active' : ''; ?> "><?php echo static::NAME; ?></a> |
| 181 | |
| 182 | <?php |
| 183 | } |
| 184 | |
| 185 | /** |
| 186 | * Method that return the absolute path to the plugin. |
| 187 | * |
| 188 | * @since 1.4.0 |
| 189 | * @static |
| 190 | * |
| 191 | * @return void |
| 192 | */ |
| 193 | public static function registerSettings() |
| 194 | { |
| 195 | $identifier = EMBEDPRESS_PLG_NAME . ':' . static::SLUG; |
| 196 | register_setting($identifier, $identifier, [static::NAMESPACE_STRING, 'validateForm']); |
| 197 | add_settings_section($identifier, EMBEDPRESS . ' > ' . static::NAME . ' Settings', |
| 198 | [static::NAMESPACE_STRING, 'onAfterRegisterSettings'], $identifier); |
| 199 | |
| 200 | self::registerSettingsFields(); |
| 201 | } |
| 202 | |
| 203 | /** |
| 204 | * Register all plugin fields to the settings page. |
| 205 | * |
| 206 | * @since 1.4.0 |
| 207 | * @static |
| 208 | * |
| 209 | * @return void |
| 210 | */ |
| 211 | public static function registerSettingsFields() |
| 212 | { |
| 213 | $identifier = EMBEDPRESS_PLG_NAME . ':' . static::SLUG; |
| 214 | |
| 215 | $schema = static::getOptionsSchema(); |
| 216 | foreach ($schema as $fieldSlug => $field) { |
| 217 | $field['slug'] = $fieldSlug; |
| 218 | if('license_key'===$fieldSlug){ |
| 219 | continue; |
| 220 | } |
| 221 | add_settings_field($fieldSlug, $field['label'], [__NAMESPACE__ . '\Html\Field', 'render'], $identifier, |
| 222 | $identifier, [ |
| 223 | 'pluginSlug' => static::SLUG, |
| 224 | 'field' => $field, |
| 225 | ]); |
| 226 | } |
| 227 | } |
| 228 | |
| 229 | /** |
| 230 | * Callback called after the plugin's settings page has been registered and rendered. |
| 231 | * |
| 232 | * @since 1.4.0 |
| 233 | * @static |
| 234 | * |
| 235 | * @return void |
| 236 | */ |
| 237 | public static function onAfterRegisterSettings() |
| 238 | { |
| 239 | // do nothing |
| 240 | } |
| 241 | |
| 242 | /** |
| 243 | * Retrieve user defined options. |
| 244 | * |
| 245 | * @since 1.4.0 |
| 246 | * @static |
| 247 | * |
| 248 | * @return array |
| 249 | */ |
| 250 | public static function getOptions() |
| 251 | { |
| 252 | $options = (array)get_option(EMBEDPRESS_PLG_NAME . ':' . static::SLUG); |
| 253 | if (empty($options) || (count($options) === 1 && empty($options[0]))) { |
| 254 | $options = []; |
| 255 | $schema = static::getOptionsSchema(); |
| 256 | foreach ($schema as $fieldSlug => $field) { |
| 257 | $value = isset($field['default']) ? $field['default'] : ""; |
| 258 | |
| 259 | settype($value, isset($field['type']) && in_array(strtolower($field['type']), |
| 260 | ['bool', 'boolean', 'int', 'integer', 'float', 'string']) ? $field['type'] : 'string'); |
| 261 | |
| 262 | if ($fieldSlug === "license_key") { |
| 263 | $options['license'] = [ |
| 264 | 'key' => true, |
| 265 | 'status' => "missing", |
| 266 | ]; |
| 267 | } else { |
| 268 | $options[$fieldSlug] = $value; |
| 269 | } |
| 270 | } |
| 271 | } |
| 272 | |
| 273 | $options['license'] = [ |
| 274 | 'key' => true, |
| 275 | 'status' => "missing", |
| 276 | ]; |
| 277 | |
| 278 | return $options; |
| 279 | } |
| 280 | |
| 281 | /** |
| 282 | * Handle links displayed below the plugin name in the WordPress Installed Plugins page. |
| 283 | * |
| 284 | * @since 1.4.0 |
| 285 | * @static |
| 286 | * |
| 287 | * @return array |
| 288 | */ |
| 289 | public static function handleActionLinks($links, $file) |
| 290 | { |
| 291 | $settingsLink = '<a href="' . admin_url('admin.php?page=' . EMBEDPRESS_PLG_NAME . '&tab=' . static::SLUG) . '" aria-label="' . __('Open settings page', |
| 292 | 'embedpress-' . static::SLUG) . '">' . __('Settings', 'embedpress-' . static::SLUG) . '</a>'; |
| 293 | |
| 294 | array_unshift($links, $settingsLink); |
| 295 | |
| 296 | return $links; |
| 297 | } |
| 298 | } |
| 299 |