LLMS_Admin_AddOns
LLMS_Admin_AddOns class
Contents
Source Source
File: includes/admin/class.llms.admin.addons.php
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 | class LLMS_Admin_AddOns { /** * Data from `llms_get_add_ons()`. * * @var array * @since 3.5.0 */ public $data = array(); /** * Retrieves the current section from the query string. * * @since 3.5.0 * @since 3.22.0 Unknown. * @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`. * * @return string */ private function get_current_section() { $section = 'all'; if ( isset( $_GET['page'] ) && 'llms-dashboard' === $_GET['page'] ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended $section = 'featured'; } elseif ( isset( $_GET['section'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended $section = llms_filter_input_sanitize_string( INPUT_GET, 'section' ); } return apply_filters( 'llms_admin_add_ons_get_current_section', $section ); } /** * Retrieve addon data for the current section (tab) based off query string variables * * @return array * @since 3.5.0 * @version 3.22.0 */ private function get_current_section_content() { $sec = $this->get_current_section(); $content = apply_filters( 'llms_admin_add_ons_get_current_section_default_content', array(), $sec ); if ( ! $content ) { if ( 'all' === $sec ) { $content = $this->get_all(); } elseif ( 'featured' === $sec ) { $content = $this->get_features(); } else { $content = $this->get_products_for_cat( $sec ); } } return apply_filters( 'llms_admin_add_ons_get_current_section_content', $content, $sec ); } /** * Retrieve remote json data. * * @since 3.5.0 * @since 3.22.2 Unknown. * @since 7.1.0 Use strict comparisons for `in_array()`. * * @return array|WP_Error */ private function get_data() { $this->data = llms_get_add_ons(); if ( ! is_wp_error( $this->data ) ) { foreach ( $this->data['items'] as $key => $addon ) { // Exclude the core plugin and helper plugin. if ( in_array( $addon['id'], array( 'lifterlms-com-lifterlms', 'lifterlms-com-lifterlms-helper' ), true ) ) { unset( $this->data['items'][ $key ] ); } // Exclude uncategorized Add-ons. if ( array_key_exists( 'uncategorized', $addon['categories'] ) ) { unset( $this->data['items'][ $key ] ); } } } return $this->data; } /** * Retrieve a list of addons for use on the All section * * @return array * @since 7.5.0 * @version 7.5.0 */ private function get_all() { $all = array(); $addons = $this->data['items']; foreach ( $addons as $addon ) { // Exclude third-party Addons from the All section. if ( in_array( 'third-party', array_keys( $addon['categories'] ), true ) ) { continue; } $all[] = $addon; } return $all; } /** * Retrieve a list of 'featured' addons for use on the general settings screen * Excludes already available products from current site's activations * * @return array * @since 3.22.0 * @version 3.22.0 */ private function get_features() { $features = array(); // Addons to exclude. // Helper will filter this based on existing activations. $exclude = apply_filters( 'llms_admin_addon_features_exclude_ids', array() ); $cats = array( 'e-commerce', 'bundles', 'resources', 'courses', 'courses', ); foreach ( $cats as $cat ) { $addon = $this->get_product_from_cat( $cat, $exclude ); if ( $addon ) { $features[] = $addon; $exclude[] = $addon['id']; } if ( 3 === count( $features ) ) { return $features; } } return $features; } /** * Get a random product from a category that doesn't exist in the list of excluded product ids. * * @since 3.22.0 * @since 7.1.0 Use strict comparisons for `in_array()`. * * @param string $cat Category slug. * @param array $excludes List of product ids to exclude. * @return array|false */ public function get_product_from_cat( $cat, $excludes ) { $addons = $this->get_products_for_cat( $cat, true ); shuffle( $addons ); foreach ( $addons as $addon ) { if ( in_array( 'third-party', array_keys( $addon['categories'] ), true ) ) { continue; } if ( ! in_array( $addon['id'], $excludes, true ) ) { return $addon; } } return false; } /** * Retrieve products for a specific category. * * @since 3.22.0 * @since 7.1.0 Use strict comparisons for `in_array()`. * * @param string $cat Category slug. * @return array */ private function get_products_for_cat( $cat, $include_bundles = true ) { $products = array(); foreach ( $this->data['items'] as $item ) { $cats = array_keys( $item['categories'] ); // Exclude bundles if bundles are not being included or requested. if ( 'bundles' !== $cat && ! $include_bundles && in_array( 'bundles', $cats, true ) ) { continue; } if ( in_array( $cat, $cats, true ) ) { $products[] = $item; } } return $products; } /** * Handle form submissions for managing license keys * * @return void * @since 3.22.0 * @version 3.22.0 */ public function handle_actions() { // Activate & deactivate addons. if ( llms_verify_nonce( '_llms_manage_addon_nonce', 'llms_manage_addon' ) ) { $this->handle_manage_addons(); LLMS_Admin_Notices::output_notices(); } } /** * Handle activation and deactivation of addons * * @since 3.22.0 * @since 3.35.0 Sanitize input data. * @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`. * * @return void */ private function handle_manage_addons() { // phpcs:disable WordPress.Security.NonceVerification.Missing -- nonce is verified in $this->handle_actions() method. $actions = apply_filters( 'llms_admin_add_ons_manage_actions', array( 'activate', 'deactivate', ) ); $errors = array(); $success = array(); foreach ( $actions as $action ) { if ( empty( $_POST[ 'llms_' . $action ] ) ) { continue; } foreach ( llms_filter_input( INPUT_POST, 'llms_' . $action, FILTER_DEFAULT, FILTER_REQUIRE_ARRAY ) as $id ) { $addon = llms_get_add_on( $id ); if ( ! method_exists( $addon, $action ) ) { continue; } $ret = call_user_func( array( $addon, $action ) ); if ( is_wp_error( $ret ) ) { LLMS_Admin_Notices::flash_notice( $ret->get_error_message(), 'error' ); } else { LLMS_Admin_Notices::flash_notice( $ret ); } } } // phpcs:enable WordPress.Security.NonceVerification.Missing } /** * Output HTML for the current screen * * @since 3.5.0 * @since 3.28.0 Unknown. * @since 4.10.1 Use `hr.wp-header-end` in favor of a second (hidden) <h1> to "catch" admin notices. * * @return void */ public function output() { if ( is_wp_error( $this->get_data() ) ) { _e( 'There was an error retrieving add-ons. Please try again.', 'lifterlms' ); return; } ?> <div class="wrap lifterlms lifterlms-settings lifterlms-addons"> <div class="llms-subheader"> <h1><?php _e( 'LifterLMS Add-Ons, Courses, and Resources', 'lifterlms' ); ?></h1> <?php do_action( 'llms_addons_page_after_title' ); ?> </div> <div class="llms-inside-wrap"> <?php $this->output_navigation(); ?> <hr class="wp-header-end"> <form action="" method="POST"> <?php $this->output_content(); ?> <?php wp_nonce_field( 'llms_manage_addon', '_llms_manage_addon_nonce' ); ?> <div class="llms-addons-bulk-actions" id="llms-addons-bulk-actions"> <a class="llms-bulk-close" href="#"> <span class="screen-reader-text"><?php _e( 'Close', 'lifterlms' ); ?></span> <i class="fa fa-times-circle" aria-hidden="true"></i> </a> <div class="llms-bulk-desc update"> <i class="fa fa-cloud-download" aria-hidden="true"></i> <?php _e( 'Update', 'lifterlms' ); ?> <span></span> </div> <div class="llms-bulk-desc install"> <i class="fa fa-cloud-download" aria-hidden="true"></i> <?php _e( 'Install', 'lifterlms' ); ?> <span></span> </div> <div class="llms-bulk-desc activate"> <i class="fa fa-plug" aria-hidden="true"></i> <?php _e( 'Activate', 'lifterlms' ); ?> <span></span> </div> <div class="llms-bulk-desc deactivate"> <i class="fa fa-plug" aria-hidden="true"></i> <?php _e( 'Deactivate', 'lifterlms' ); ?> <span></span> </div> <button class="llms-button-primary" name="llms_bulk_actions_submit" value="" type="submit"><?php _e( 'Apply', 'lifterlms' ); ?></button> </div> </form> </div> </div> <?php } /** * Output HTML for a single addon * * @param array $addon associative array of add-on data * @return void * @since 3.5.0 * @version 3.22.0 */ private function output_addon( $addon ) { $current_tab = $this->get_current_section(); include 'views/addons/addon-item.php'; } /** * Output the addon list for the current section * * @return void * @since 3.5.0 * @version 3.22.0 */ private function output_content() { ?> <ul class="llms-addons-wrap section--<?php echo esc_attr( $this->get_current_section() ); ?>"> <?php do_action( 'lifterlms_before_addons' ); ?> <?php foreach ( $this->get_current_section_content() as $addon ) { $addon = llms_get_add_on( $addon ); $this->output_addon( $addon ); } ?> <?php do_action( 'lifterlms_after_addons' ); ?> </ul> <?php } /** * Outputs most popular resources * used on general settings screen |
Expand full source code Collapse full source code View on GitHub
Methods Methods
- get_current_section — Retrieves the current section from the query string.
- get_current_section_content — Retrieve addon data for the current section (tab) based off query string variables
- get_data — Retrieve remote json data
- get_features — Retrieve a list of 'featured' addons for use on the general settings screen Excludes already available products from current site's activations
- get_product_from_cat — Get a random product from a category that doesn't exist in the list of excluded product ids
- get_products_for_cat — Retrieve products for a specific category
- handle_actions — Handle form submissions for managing license keys
- handle_manage_addons — Handle activation and deactivation of addons
- output — Output HTML for the current screen
- output_addon — Output HTML for a single addon
- output_content — Output the addon list for the current section
- output_for_settings — Outputs most popular resources used on general settings screen
- output_navigation — Output the navigation bar
Changelog Changelog
| Version | Description |
|---|---|
| 3.5.0 | |
| 3.35.0 | Sanitize input data. |
| 3.30.3 | Introduced. |