@@ -1,5 +1,5 @@ discard block |
||
1 | -<?php if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) { |
|
2 | - exit( 'No direct script access allowed' ); |
|
1 | +<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
2 | + exit('No direct script access allowed'); |
|
3 | 3 | } |
4 | 4 | |
5 | 5 | |
@@ -61,23 +61,23 @@ discard block |
||
61 | 61 | * @param string $min_core_version |
62 | 62 | * @return string always like '4.3.0.rc.000' |
63 | 63 | */ |
64 | - protected static function _effective_version( $min_core_version ) { |
|
64 | + protected static function _effective_version($min_core_version) { |
|
65 | 65 | // versions: 4 . 3 . 1 . p . 123 |
66 | 66 | // offsets: 0 . 1 . 2 . 3 . 4 |
67 | - $version_parts = explode( '.', $min_core_version ); |
|
67 | + $version_parts = explode('.', $min_core_version); |
|
68 | 68 | //check they specified the micro version (after 2nd period) |
69 | - if ( ! isset( $version_parts[2] ) ) { |
|
69 | + if ( ! isset($version_parts[2])) { |
|
70 | 70 | $version_parts[2] = '0'; |
71 | 71 | } |
72 | 72 | //if they didn't specify the 'p', or 'rc' part. Just assume the lowest possible |
73 | 73 | //soon we can assume that's 'rc', but this current version is 'alpha' |
74 | - if ( ! isset( $version_parts[3] ) ) { |
|
74 | + if ( ! isset($version_parts[3])) { |
|
75 | 75 | $version_parts[3] = 'dev'; |
76 | 76 | } |
77 | - if ( ! isset( $version_parts[4] ) ) { |
|
77 | + if ( ! isset($version_parts[4])) { |
|
78 | 78 | $version_parts[4] = '000'; |
79 | 79 | } |
80 | - return implode( '.', $version_parts ); |
|
80 | + return implode('.', $version_parts); |
|
81 | 81 | } |
82 | 82 | |
83 | 83 | |
@@ -94,8 +94,8 @@ discard block |
||
94 | 94 | $actual_core_version = EVENT_ESPRESSO_VERSION |
95 | 95 | ) { |
96 | 96 | return version_compare( |
97 | - self::_effective_version( $actual_core_version ), |
|
98 | - self::_effective_version( $min_core_version ), |
|
97 | + self::_effective_version($actual_core_version), |
|
98 | + self::_effective_version($min_core_version), |
|
99 | 99 | '>=' |
100 | 100 | ); |
101 | 101 | } |
@@ -217,7 +217,7 @@ discard block |
||
217 | 217 | * @throws EE_Error |
218 | 218 | * @return void |
219 | 219 | */ |
220 | - public static function register( $addon_name = '', $setup_args = array() ) { |
|
220 | + public static function register($addon_name = '', $setup_args = array()) { |
|
221 | 221 | // required fields MUST be present, so let's make sure they are. |
222 | 222 | \EE_Register_Addon::_verify_parameters($addon_name, $setup_args); |
223 | 223 | // get class name for addon |
@@ -227,13 +227,13 @@ discard block |
||
227 | 227 | // setup PUE |
228 | 228 | \EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args); |
229 | 229 | // does this addon work with this version of core or WordPress ? |
230 | - if ( ! \EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings) ) { |
|
230 | + if ( ! \EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) { |
|
231 | 231 | return; |
232 | 232 | } |
233 | 233 | // register namespaces |
234 | 234 | \EE_Register_Addon::_setup_namespaces($addon_settings); |
235 | 235 | // check if this is an activation request |
236 | - if ( \EE_Register_Addon::_addon_activation($addon_name, $addon_settings)) { |
|
236 | + if (\EE_Register_Addon::_addon_activation($addon_name, $addon_settings)) { |
|
237 | 237 | // dont bother setting up the rest of the addon atm |
238 | 238 | return; |
239 | 239 | } |
@@ -326,7 +326,7 @@ discard block |
||
326 | 326 | } else { |
327 | 327 | $class_name = $setup_args['class_name']; |
328 | 328 | } |
329 | - return strpos($class_name, 'EE_') === 0 ? $class_name : 'EE_' . $class_name; |
|
329 | + return strpos($class_name, 'EE_') === 0 ? $class_name : 'EE_'.$class_name; |
|
330 | 330 | } |
331 | 331 | |
332 | 332 | |
@@ -344,105 +344,105 @@ discard block |
||
344 | 344 | 'class_name' => $class_name, |
345 | 345 | // the addon slug for use in URLs, etc |
346 | 346 | 'plugin_slug' => isset($setup_args['plugin_slug']) |
347 | - ? (string)$setup_args['plugin_slug'] |
|
347 | + ? (string) $setup_args['plugin_slug'] |
|
348 | 348 | : '', |
349 | 349 | // page slug to be used when generating the "Settings" link on the WP plugin page |
350 | 350 | 'plugin_action_slug' => isset($setup_args['plugin_action_slug']) |
351 | - ? (string)$setup_args['plugin_action_slug'] |
|
351 | + ? (string) $setup_args['plugin_action_slug'] |
|
352 | 352 | : '', |
353 | 353 | // the "software" version for the addon |
354 | 354 | 'version' => isset($setup_args['version']) |
355 | - ? (string)$setup_args['version'] |
|
355 | + ? (string) $setup_args['version'] |
|
356 | 356 | : '', |
357 | 357 | // the minimum version of EE Core that the addon will work with |
358 | 358 | 'min_core_version' => isset($setup_args['min_core_version']) |
359 | - ? (string)$setup_args['min_core_version'] |
|
359 | + ? (string) $setup_args['min_core_version'] |
|
360 | 360 | : '', |
361 | 361 | // the minimum version of WordPress that the addon will work with |
362 | 362 | 'min_wp_version' => isset($setup_args['min_wp_version']) |
363 | - ? (string)$setup_args['min_wp_version'] |
|
363 | + ? (string) $setup_args['min_wp_version'] |
|
364 | 364 | : EE_MIN_WP_VER_REQUIRED, |
365 | 365 | // full server path to main file (file loaded directly by WP) |
366 | 366 | 'main_file_path' => isset($setup_args['main_file_path']) |
367 | - ? (string)$setup_args['main_file_path'] |
|
367 | + ? (string) $setup_args['main_file_path'] |
|
368 | 368 | : '', |
369 | 369 | // path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages |
370 | 370 | 'admin_path' => isset($setup_args['admin_path']) |
371 | - ? (string)$setup_args['admin_path'] : '', |
|
371 | + ? (string) $setup_args['admin_path'] : '', |
|
372 | 372 | // a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page |
373 | 373 | 'admin_callback' => isset($setup_args['admin_callback']) |
374 | - ? (string)$setup_args['admin_callback'] |
|
374 | + ? (string) $setup_args['admin_callback'] |
|
375 | 375 | : '', |
376 | 376 | // the section name for this addon's configuration settings section (defaults to "addons") |
377 | 377 | 'config_section' => isset($setup_args['config_section']) |
378 | - ? (string)$setup_args['config_section'] |
|
378 | + ? (string) $setup_args['config_section'] |
|
379 | 379 | : 'addons', |
380 | 380 | // the class name for this addon's configuration settings object |
381 | 381 | 'config_class' => isset($setup_args['config_class']) |
382 | - ? (string)$setup_args['config_class'] : '', |
|
382 | + ? (string) $setup_args['config_class'] : '', |
|
383 | 383 | //the name given to the config for this addons' configuration settings object (optional) |
384 | 384 | 'config_name' => isset($setup_args['config_name']) |
385 | - ? (string)$setup_args['config_name'] : '', |
|
385 | + ? (string) $setup_args['config_name'] : '', |
|
386 | 386 | // an array of "class names" => "full server paths" for any classes that might be invoked by the addon |
387 | 387 | 'autoloader_paths' => isset($setup_args['autoloader_paths']) |
388 | - ? (array)$setup_args['autoloader_paths'] |
|
388 | + ? (array) $setup_args['autoloader_paths'] |
|
389 | 389 | : array(), |
390 | 390 | // an array of "full server paths" for any folders containing classes that might be invoked by the addon |
391 | 391 | 'autoloader_folders' => isset($setup_args['autoloader_folders']) |
392 | - ? (array)$setup_args['autoloader_folders'] |
|
392 | + ? (array) $setup_args['autoloader_folders'] |
|
393 | 393 | : array(), |
394 | 394 | // array of full server paths to any EE_DMS data migration scripts used by the addon |
395 | 395 | 'dms_paths' => isset($setup_args['dms_paths']) |
396 | - ? (array)$setup_args['dms_paths'] |
|
396 | + ? (array) $setup_args['dms_paths'] |
|
397 | 397 | : array(), |
398 | 398 | // array of full server paths to any EED_Modules used by the addon |
399 | 399 | 'module_paths' => isset($setup_args['module_paths']) |
400 | - ? (array)$setup_args['module_paths'] |
|
400 | + ? (array) $setup_args['module_paths'] |
|
401 | 401 | : array(), |
402 | 402 | // array of full server paths to any EES_Shortcodes used by the addon |
403 | 403 | 'shortcode_paths' => isset($setup_args['shortcode_paths']) |
404 | - ? (array)$setup_args['shortcode_paths'] |
|
404 | + ? (array) $setup_args['shortcode_paths'] |
|
405 | 405 | : array(), |
406 | 406 | // array of full server paths to any WP_Widgets used by the addon |
407 | 407 | 'widget_paths' => isset($setup_args['widget_paths']) |
408 | - ? (array)$setup_args['widget_paths'] |
|
408 | + ? (array) $setup_args['widget_paths'] |
|
409 | 409 | : array(), |
410 | 410 | // array of PUE options used by the addon |
411 | 411 | 'pue_options' => isset($setup_args['pue_options']) |
412 | - ? (array)$setup_args['pue_options'] |
|
412 | + ? (array) $setup_args['pue_options'] |
|
413 | 413 | : array(), |
414 | 414 | 'message_types' => isset($setup_args['message_types']) |
415 | - ? (array)$setup_args['message_types'] |
|
415 | + ? (array) $setup_args['message_types'] |
|
416 | 416 | : array(), |
417 | 417 | 'capabilities' => isset($setup_args['capabilities']) |
418 | - ? (array)$setup_args['capabilities'] |
|
418 | + ? (array) $setup_args['capabilities'] |
|
419 | 419 | : array(), |
420 | 420 | 'capability_maps' => isset($setup_args['capability_maps']) |
421 | - ? (array)$setup_args['capability_maps'] |
|
421 | + ? (array) $setup_args['capability_maps'] |
|
422 | 422 | : array(), |
423 | 423 | 'model_paths' => isset($setup_args['model_paths']) |
424 | - ? (array)$setup_args['model_paths'] |
|
424 | + ? (array) $setup_args['model_paths'] |
|
425 | 425 | : array(), |
426 | 426 | 'class_paths' => isset($setup_args['class_paths']) |
427 | - ? (array)$setup_args['class_paths'] |
|
427 | + ? (array) $setup_args['class_paths'] |
|
428 | 428 | : array(), |
429 | 429 | 'model_extension_paths' => isset($setup_args['model_extension_paths']) |
430 | - ? (array)$setup_args['model_extension_paths'] |
|
430 | + ? (array) $setup_args['model_extension_paths'] |
|
431 | 431 | : array(), |
432 | 432 | 'class_extension_paths' => isset($setup_args['class_extension_paths']) |
433 | - ? (array)$setup_args['class_extension_paths'] |
|
433 | + ? (array) $setup_args['class_extension_paths'] |
|
434 | 434 | : array(), |
435 | 435 | 'custom_post_types' => isset($setup_args['custom_post_types']) |
436 | - ? (array)$setup_args['custom_post_types'] |
|
436 | + ? (array) $setup_args['custom_post_types'] |
|
437 | 437 | : array(), |
438 | 438 | 'custom_taxonomies' => isset($setup_args['custom_taxonomies']) |
439 | - ? (array)$setup_args['custom_taxonomies'] |
|
439 | + ? (array) $setup_args['custom_taxonomies'] |
|
440 | 440 | : array(), |
441 | 441 | 'payment_method_paths' => isset($setup_args['payment_method_paths']) |
442 | - ? (array)$setup_args['payment_method_paths'] |
|
442 | + ? (array) $setup_args['payment_method_paths'] |
|
443 | 443 | : array(), |
444 | 444 | 'default_terms' => isset($setup_args['default_terms']) |
445 | - ? (array)$setup_args['default_terms'] |
|
445 | + ? (array) $setup_args['default_terms'] |
|
446 | 446 | : array(), |
447 | 447 | // if not empty, inserts a new table row after this plugin's row on the WP Plugins page |
448 | 448 | // that can be used for adding upgrading/marketing info |
@@ -454,7 +454,7 @@ discard block |
||
454 | 454 | $setup_args['namespace']['FQNS'], |
455 | 455 | $setup_args['namespace']['DIR'] |
456 | 456 | ) |
457 | - ? (array)$setup_args['namespace'] |
|
457 | + ? (array) $setup_args['namespace'] |
|
458 | 458 | : array(), |
459 | 459 | ); |
460 | 460 | // if plugin_action_slug is NOT set, but an admin page path IS set, |
@@ -475,7 +475,7 @@ discard block |
||
475 | 475 | * @param array $addon_settings |
476 | 476 | * @return boolean |
477 | 477 | */ |
478 | - private static function _addon_is_compatible( $addon_name, array $addon_settings ) { |
|
478 | + private static function _addon_is_compatible($addon_name, array $addon_settings) { |
|
479 | 479 | global $wp_version; |
480 | 480 | $incompatibility_message = ''; |
481 | 481 | //check whether this addon version is compatible with EE core |
@@ -551,20 +551,20 @@ discard block |
||
551 | 551 | * @param array $setup_args |
552 | 552 | * @return void |
553 | 553 | */ |
554 | - private static function _parse_pue_options( $addon_name, $class_name, array $setup_args ) { |
|
554 | + private static function _parse_pue_options($addon_name, $class_name, array $setup_args) { |
|
555 | 555 | if ( ! empty($setup_args['pue_options'])) { |
556 | 556 | self::$_settings[$addon_name]['pue_options'] = array( |
557 | 557 | 'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug']) |
558 | - ? (string)$setup_args['pue_options']['pue_plugin_slug'] |
|
559 | - : 'espresso_' . strtolower($class_name), |
|
558 | + ? (string) $setup_args['pue_options']['pue_plugin_slug'] |
|
559 | + : 'espresso_'.strtolower($class_name), |
|
560 | 560 | 'plugin_basename' => isset($setup_args['pue_options']['plugin_basename']) |
561 | - ? (string)$setup_args['pue_options']['plugin_basename'] |
|
561 | + ? (string) $setup_args['pue_options']['plugin_basename'] |
|
562 | 562 | : plugin_basename($setup_args['main_file_path']), |
563 | 563 | 'checkPeriod' => isset($setup_args['pue_options']['checkPeriod']) |
564 | - ? (string)$setup_args['pue_options']['checkPeriod'] |
|
564 | + ? (string) $setup_args['pue_options']['checkPeriod'] |
|
565 | 565 | : '24', |
566 | 566 | 'use_wp_update' => isset($setup_args['pue_options']['use_wp_update']) |
567 | - ? (string)$setup_args['pue_options']['use_wp_update'] |
|
567 | + ? (string) $setup_args['pue_options']['use_wp_update'] |
|
568 | 568 | : false, |
569 | 569 | ); |
570 | 570 | add_action( |
@@ -606,7 +606,7 @@ discard block |
||
606 | 606 | * @param array $addon_settings |
607 | 607 | * @return bool |
608 | 608 | */ |
609 | - private static function _addon_activation( $addon_name, array $addon_settings ) { |
|
609 | + private static function _addon_activation($addon_name, array $addon_settings) { |
|
610 | 610 | // this is an activation request |
611 | 611 | if (did_action('activate_plugin')) { |
612 | 612 | //to find if THIS is the addon that was activated, |
@@ -663,7 +663,7 @@ discard block |
||
663 | 663 | } |
664 | 664 | // setup autoloaders for folders |
665 | 665 | if ( ! empty(self::$_settings[$addon_name]['autoloader_folders'])) { |
666 | - foreach ((array)self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) { |
|
666 | + foreach ((array) self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) { |
|
667 | 667 | EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder); |
668 | 668 | } |
669 | 669 | } |
@@ -678,7 +678,7 @@ discard block |
||
678 | 678 | * @return void |
679 | 679 | * @throws \EE_Error |
680 | 680 | */ |
681 | - private static function _register_models_and_extensions( $addon_name ) { |
|
681 | + private static function _register_models_and_extensions($addon_name) { |
|
682 | 682 | // register new models |
683 | 683 | if ( |
684 | 684 | ! empty(self::$_settings[$addon_name]['model_paths']) |
@@ -714,7 +714,7 @@ discard block |
||
714 | 714 | * @return void |
715 | 715 | * @throws \EE_Error |
716 | 716 | */ |
717 | - private static function _register_data_migration_scripts( $addon_name ) { |
|
717 | + private static function _register_data_migration_scripts($addon_name) { |
|
718 | 718 | // setup DMS |
719 | 719 | if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) { |
720 | 720 | EE_Register_Data_Migration_Scripts::register( |
@@ -730,7 +730,7 @@ discard block |
||
730 | 730 | * @return void |
731 | 731 | * @throws \EE_Error |
732 | 732 | */ |
733 | - private static function _register_config( $addon_name ) { |
|
733 | + private static function _register_config($addon_name) { |
|
734 | 734 | // if config_class is present let's register config. |
735 | 735 | if ( ! empty(self::$_settings[$addon_name]['config_class'])) { |
736 | 736 | EE_Register_Config::register( |
@@ -749,7 +749,7 @@ discard block |
||
749 | 749 | * @return void |
750 | 750 | * @throws \EE_Error |
751 | 751 | */ |
752 | - private static function _register_admin_pages( $addon_name ) { |
|
752 | + private static function _register_admin_pages($addon_name) { |
|
753 | 753 | if ( ! empty(self::$_settings[$addon_name]['admin_path'])) { |
754 | 754 | EE_Register_Admin_Page::register( |
755 | 755 | $addon_name, |
@@ -764,7 +764,7 @@ discard block |
||
764 | 764 | * @return void |
765 | 765 | * @throws \EE_Error |
766 | 766 | */ |
767 | - private static function _register_modules( $addon_name ) { |
|
767 | + private static function _register_modules($addon_name) { |
|
768 | 768 | if ( ! empty(self::$_settings[$addon_name]['module_paths'])) { |
769 | 769 | EE_Register_Module::register( |
770 | 770 | $addon_name, |
@@ -779,7 +779,7 @@ discard block |
||
779 | 779 | * @return void |
780 | 780 | * @throws \EE_Error |
781 | 781 | */ |
782 | - private static function _register_shortcodes( $addon_name ) { |
|
782 | + private static function _register_shortcodes($addon_name) { |
|
783 | 783 | if ( ! empty(self::$_settings[$addon_name]['shortcode_paths'])) { |
784 | 784 | EE_Register_Shortcode::register( |
785 | 785 | $addon_name, |
@@ -794,7 +794,7 @@ discard block |
||
794 | 794 | * @return void |
795 | 795 | * @throws \EE_Error |
796 | 796 | */ |
797 | - private static function _register_widgets( $addon_name ) { |
|
797 | + private static function _register_widgets($addon_name) { |
|
798 | 798 | if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) { |
799 | 799 | EE_Register_Widget::register( |
800 | 800 | $addon_name, |
@@ -809,7 +809,7 @@ discard block |
||
809 | 809 | * @return void |
810 | 810 | * @throws \EE_Error |
811 | 811 | */ |
812 | - private static function _register_capabilities( $addon_name ) { |
|
812 | + private static function _register_capabilities($addon_name) { |
|
813 | 813 | if ( ! empty(self::$_settings[$addon_name]['capabilities'])) { |
814 | 814 | EE_Register_Capabilities::register( |
815 | 815 | $addon_name, |
@@ -827,7 +827,7 @@ discard block |
||
827 | 827 | * @return void |
828 | 828 | * @throws \EE_Error |
829 | 829 | */ |
830 | - private static function _register_message_types( $addon_name ) { |
|
830 | + private static function _register_message_types($addon_name) { |
|
831 | 831 | if ( ! empty(self::$_settings[$addon_name]['message_types'])) { |
832 | 832 | add_action( |
833 | 833 | 'EE_Brewing_Regular___messages_caf', |
@@ -842,7 +842,7 @@ discard block |
||
842 | 842 | * @return void |
843 | 843 | * @throws \EE_Error |
844 | 844 | */ |
845 | - private static function _register_custom_post_types( $addon_name ) { |
|
845 | + private static function _register_custom_post_types($addon_name) { |
|
846 | 846 | if ( |
847 | 847 | ! empty(self::$_settings[$addon_name]['custom_post_types']) |
848 | 848 | || ! empty(self::$_settings[$addon_name]['custom_taxonomies']) |
@@ -864,7 +864,7 @@ discard block |
||
864 | 864 | * @return void |
865 | 865 | * @throws \EE_Error |
866 | 866 | */ |
867 | - private static function _register_payment_methods( $addon_name ) { |
|
867 | + private static function _register_payment_methods($addon_name) { |
|
868 | 868 | if ( ! empty(self::$_settings[$addon_name]['payment_method_paths'])) { |
869 | 869 | EE_Register_Payment_Method::register( |
870 | 870 | $addon_name, |
@@ -881,25 +881,25 @@ discard block |
||
881 | 881 | * @param string $addon_name |
882 | 882 | * @return EE_Addon |
883 | 883 | */ |
884 | - private static function _load_and_init_addon_class( $addon_name ) { |
|
884 | + private static function _load_and_init_addon_class($addon_name) { |
|
885 | 885 | $addon = EE_Registry::instance()->load_addon( |
886 | - dirname( self::$_settings[ $addon_name ]['main_file_path'] ), |
|
887 | - self::$_settings[ $addon_name ]['class_name'] |
|
886 | + dirname(self::$_settings[$addon_name]['main_file_path']), |
|
887 | + self::$_settings[$addon_name]['class_name'] |
|
888 | 888 | ); |
889 | - $addon->set_name( $addon_name ); |
|
890 | - $addon->set_plugin_slug( self::$_settings[ $addon_name ]['plugin_slug'] ); |
|
891 | - $addon->set_plugin_basename( self::$_settings[ $addon_name ]['plugin_basename'] ); |
|
892 | - $addon->set_main_plugin_file( self::$_settings[ $addon_name ]['main_file_path'] ); |
|
893 | - $addon->set_plugin_action_slug( self::$_settings[ $addon_name ]['plugin_action_slug'] ); |
|
894 | - $addon->set_plugins_page_row( self::$_settings[ $addon_name ]['plugins_page_row'] ); |
|
895 | - $addon->set_version( self::$_settings[ $addon_name ]['version'] ); |
|
896 | - $addon->set_min_core_version( self::_effective_version( self::$_settings[ $addon_name ]['min_core_version'] ) ); |
|
897 | - $addon->set_config_section( self::$_settings[ $addon_name ]['config_section'] ); |
|
898 | - $addon->set_config_class( self::$_settings[ $addon_name ]['config_class'] ); |
|
899 | - $addon->set_config_name( self::$_settings[ $addon_name ]['config_name'] ); |
|
889 | + $addon->set_name($addon_name); |
|
890 | + $addon->set_plugin_slug(self::$_settings[$addon_name]['plugin_slug']); |
|
891 | + $addon->set_plugin_basename(self::$_settings[$addon_name]['plugin_basename']); |
|
892 | + $addon->set_main_plugin_file(self::$_settings[$addon_name]['main_file_path']); |
|
893 | + $addon->set_plugin_action_slug(self::$_settings[$addon_name]['plugin_action_slug']); |
|
894 | + $addon->set_plugins_page_row(self::$_settings[$addon_name]['plugins_page_row']); |
|
895 | + $addon->set_version(self::$_settings[$addon_name]['version']); |
|
896 | + $addon->set_min_core_version(self::_effective_version(self::$_settings[$addon_name]['min_core_version'])); |
|
897 | + $addon->set_config_section(self::$_settings[$addon_name]['config_section']); |
|
898 | + $addon->set_config_class(self::$_settings[$addon_name]['config_class']); |
|
899 | + $addon->set_config_name(self::$_settings[$addon_name]['config_name']); |
|
900 | 900 | //unfortunately this can't be hooked in upon construction, because we don't have |
901 | 901 | //the plugin mainfile's path upon construction. |
902 | - register_deactivation_hook( $addon->get_main_plugin_file(), array( $addon, 'deactivation' ) ); |
|
902 | + register_deactivation_hook($addon->get_main_plugin_file(), array($addon, 'deactivation')); |
|
903 | 903 | // call any additional admin_callback functions during load_admin_controller hook |
904 | 904 | if ( ! empty(self::$_settings[$addon_name]['admin_callback'])) { |
905 | 905 | add_action( |
@@ -919,18 +919,18 @@ discard block |
||
919 | 919 | */ |
920 | 920 | public static function load_pue_update() { |
921 | 921 | // load PUE client |
922 | - require_once EE_THIRD_PARTY . 'pue' . DS . 'pue-client.php'; |
|
922 | + require_once EE_THIRD_PARTY.'pue'.DS.'pue-client.php'; |
|
923 | 923 | // cycle thru settings |
924 | - foreach ( self::$_settings as $settings ) { |
|
925 | - if ( ! empty( $settings['pue_options'] ) ) { |
|
924 | + foreach (self::$_settings as $settings) { |
|
925 | + if ( ! empty($settings['pue_options'])) { |
|
926 | 926 | // initiate the class and start the plugin update engine! |
927 | 927 | new PluginUpdateEngineChecker( |
928 | 928 | // host file URL |
929 | 929 | 'https://eventespresso.com', |
930 | 930 | // plugin slug(s) |
931 | 931 | array( |
932 | - 'premium' => array( 'p' => $settings['pue_options']['pue_plugin_slug'] ), |
|
933 | - 'prerelease' => array( 'beta' => $settings['pue_options']['pue_plugin_slug'] . '-pr' ), |
|
932 | + 'premium' => array('p' => $settings['pue_options']['pue_plugin_slug']), |
|
933 | + 'prerelease' => array('beta' => $settings['pue_options']['pue_plugin_slug'].'-pr'), |
|
934 | 934 | ), |
935 | 935 | // options |
936 | 936 | array( |
@@ -958,9 +958,9 @@ discard block |
||
958 | 958 | * @throws \EE_Error |
959 | 959 | */ |
960 | 960 | public static function register_message_types() { |
961 | - foreach ( self::$_settings as $addon_name => $settings ) { |
|
961 | + foreach (self::$_settings as $addon_name => $settings) { |
|
962 | 962 | if ( ! empty($settings['message_types'])) { |
963 | - foreach ((array)$settings['message_types'] as $message_type => $message_type_settings) { |
|
963 | + foreach ((array) $settings['message_types'] as $message_type => $message_type_settings) { |
|
964 | 964 | EE_Register_Message_Type::register($message_type, $message_type_settings); |
965 | 965 | } |
966 | 966 | } |
@@ -977,73 +977,73 @@ discard block |
||
977 | 977 | * @throws EE_Error |
978 | 978 | * @return void |
979 | 979 | */ |
980 | - public static function deregister( $addon_name = null ) { |
|
981 | - if ( isset( self::$_settings[ $addon_name ] ) ) { |
|
982 | - $class_name = self::$_settings[ $addon_name ]['class_name']; |
|
983 | - if ( ! empty( self::$_settings[ $addon_name ]['dms_paths'] ) ) { |
|
980 | + public static function deregister($addon_name = null) { |
|
981 | + if (isset(self::$_settings[$addon_name])) { |
|
982 | + $class_name = self::$_settings[$addon_name]['class_name']; |
|
983 | + if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) { |
|
984 | 984 | // setup DMS |
985 | - EE_Register_Data_Migration_Scripts::deregister( $addon_name ); |
|
985 | + EE_Register_Data_Migration_Scripts::deregister($addon_name); |
|
986 | 986 | } |
987 | - if ( ! empty( self::$_settings[ $addon_name ]['admin_path'] ) ) { |
|
987 | + if ( ! empty(self::$_settings[$addon_name]['admin_path'])) { |
|
988 | 988 | // register admin page |
989 | - EE_Register_Admin_Page::deregister( $addon_name ); |
|
989 | + EE_Register_Admin_Page::deregister($addon_name); |
|
990 | 990 | } |
991 | - if ( ! empty( self::$_settings[ $addon_name ]['module_paths'] ) ) { |
|
991 | + if ( ! empty(self::$_settings[$addon_name]['module_paths'])) { |
|
992 | 992 | // add to list of modules to be registered |
993 | - EE_Register_Module::deregister( $addon_name ); |
|
993 | + EE_Register_Module::deregister($addon_name); |
|
994 | 994 | } |
995 | - if ( ! empty( self::$_settings[ $addon_name ]['shortcode_paths'] ) ) { |
|
995 | + if ( ! empty(self::$_settings[$addon_name]['shortcode_paths'])) { |
|
996 | 996 | // add to list of shortcodes to be registered |
997 | - EE_Register_Shortcode::deregister( $addon_name ); |
|
997 | + EE_Register_Shortcode::deregister($addon_name); |
|
998 | 998 | } |
999 | - if ( ! empty( self::$_settings[ $addon_name ]['config_class'] ) ) { |
|
999 | + if ( ! empty(self::$_settings[$addon_name]['config_class'])) { |
|
1000 | 1000 | // if config_class present let's register config. |
1001 | - EE_Register_Config::deregister( self::$_settings[ $addon_name ]['config_class'] ); |
|
1001 | + EE_Register_Config::deregister(self::$_settings[$addon_name]['config_class']); |
|
1002 | 1002 | } |
1003 | - if ( ! empty( self::$_settings[ $addon_name ]['widget_paths'] ) ) { |
|
1003 | + if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) { |
|
1004 | 1004 | // add to list of widgets to be registered |
1005 | - EE_Register_Widget::deregister( $addon_name ); |
|
1005 | + EE_Register_Widget::deregister($addon_name); |
|
1006 | 1006 | } |
1007 | - if ( ! empty( self::$_settings[ $addon_name ]['model_paths'] ) |
|
1007 | + if ( ! empty(self::$_settings[$addon_name]['model_paths']) |
|
1008 | 1008 | || |
1009 | - ! empty( self::$_settings[ $addon_name ]['class_paths'] ) |
|
1009 | + ! empty(self::$_settings[$addon_name]['class_paths']) |
|
1010 | 1010 | ) { |
1011 | 1011 | // add to list of shortcodes to be registered |
1012 | - EE_Register_Model::deregister( $addon_name ); |
|
1012 | + EE_Register_Model::deregister($addon_name); |
|
1013 | 1013 | } |
1014 | - if ( ! empty( self::$_settings[ $addon_name ]['model_extension_paths'] ) |
|
1014 | + if ( ! empty(self::$_settings[$addon_name]['model_extension_paths']) |
|
1015 | 1015 | || |
1016 | - ! empty( self::$_settings[ $addon_name ]['class_extension_paths'] ) |
|
1016 | + ! empty(self::$_settings[$addon_name]['class_extension_paths']) |
|
1017 | 1017 | ) { |
1018 | 1018 | // add to list of shortcodes to be registered |
1019 | - EE_Register_Model_Extensions::deregister( $addon_name ); |
|
1019 | + EE_Register_Model_Extensions::deregister($addon_name); |
|
1020 | 1020 | } |
1021 | - if ( ! empty( self::$_settings[ $addon_name ]['message_types'] ) ) { |
|
1022 | - foreach ((array)self::$_settings[ $addon_name ]['message_types'] as $message_type => $message_type_settings ) |
|
1021 | + if ( ! empty(self::$_settings[$addon_name]['message_types'])) { |
|
1022 | + foreach ((array) self::$_settings[$addon_name]['message_types'] as $message_type => $message_type_settings) |
|
1023 | 1023 | { |
1024 | - EE_Register_Message_Type::deregister( $message_type ); |
|
1024 | + EE_Register_Message_Type::deregister($message_type); |
|
1025 | 1025 | } |
1026 | 1026 | } |
1027 | 1027 | //deregister capabilities for addon |
1028 | 1028 | if ( |
1029 | - ! empty( self::$_settings[ $addon_name ]['capabilities'] ) |
|
1030 | - || ! empty( self::$_settings[ $addon_name ]['capability_maps'] ) |
|
1029 | + ! empty(self::$_settings[$addon_name]['capabilities']) |
|
1030 | + || ! empty(self::$_settings[$addon_name]['capability_maps']) |
|
1031 | 1031 | ) { |
1032 | - EE_Register_Capabilities::deregister( $addon_name ); |
|
1032 | + EE_Register_Capabilities::deregister($addon_name); |
|
1033 | 1033 | } |
1034 | 1034 | //deregister custom_post_types for addon |
1035 | - if ( ! empty( self::$_settings[ $addon_name ]['custom_post_types'] ) ) { |
|
1036 | - EE_Register_CPT::deregister( $addon_name ); |
|
1035 | + if ( ! empty(self::$_settings[$addon_name]['custom_post_types'])) { |
|
1036 | + EE_Register_CPT::deregister($addon_name); |
|
1037 | 1037 | } |
1038 | 1038 | remove_action( |
1039 | - 'deactivate_' . EE_Registry::instance()->addons->{$class_name}->get_main_plugin_file_basename(), |
|
1040 | - array( EE_Registry::instance()->addons->{$class_name}, 'deactivation' ) |
|
1039 | + 'deactivate_'.EE_Registry::instance()->addons->{$class_name}->get_main_plugin_file_basename(), |
|
1040 | + array(EE_Registry::instance()->addons->{$class_name}, 'deactivation') |
|
1041 | 1041 | ); |
1042 | 1042 | remove_action( |
1043 | 1043 | 'AHEE__EE_System__perform_activations_upgrades_and_migrations', |
1044 | - array( EE_Registry::instance()->addons->{$class_name}, 'initialize_db_if_no_migrations_required' ) |
|
1044 | + array(EE_Registry::instance()->addons->{$class_name}, 'initialize_db_if_no_migrations_required') |
|
1045 | 1045 | ); |
1046 | - unset( EE_Registry::instance()->addons->{$class_name}, self::$_settings[ $addon_name ] ); |
|
1046 | + unset(EE_Registry::instance()->addons->{$class_name}, self::$_settings[$addon_name]); |
|
1047 | 1047 | } |
1048 | 1048 | } |
1049 | 1049 |
@@ -48,7 +48,7 @@ discard block |
||
48 | 48 | protected static $_incompatible_addons = array( |
49 | 49 | 'Multi_Event_Registration' => '2.0.11.rc.002', |
50 | 50 | 'Promotions' => '1.0.0.rc.084', |
51 | - ); |
|
51 | + ); |
|
52 | 52 | |
53 | 53 | |
54 | 54 | |
@@ -219,660 +219,660 @@ discard block |
||
219 | 219 | */ |
220 | 220 | public static function register( $addon_name = '', $setup_args = array() ) { |
221 | 221 | // required fields MUST be present, so let's make sure they are. |
222 | - \EE_Register_Addon::_verify_parameters($addon_name, $setup_args); |
|
223 | - // get class name for addon |
|
222 | + \EE_Register_Addon::_verify_parameters($addon_name, $setup_args); |
|
223 | + // get class name for addon |
|
224 | 224 | $class_name = \EE_Register_Addon::_parse_class_name($addon_name, $setup_args); |
225 | 225 | //setup $_settings array from incoming values. |
226 | - $addon_settings = \EE_Register_Addon::_get_addon_settings($class_name, $setup_args); |
|
227 | - // setup PUE |
|
228 | - \EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args); |
|
229 | - // does this addon work with this version of core or WordPress ? |
|
230 | - if ( ! \EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings) ) { |
|
231 | - return; |
|
226 | + $addon_settings = \EE_Register_Addon::_get_addon_settings($class_name, $setup_args); |
|
227 | + // setup PUE |
|
228 | + \EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args); |
|
229 | + // does this addon work with this version of core or WordPress ? |
|
230 | + if ( ! \EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings) ) { |
|
231 | + return; |
|
232 | 232 | } |
233 | 233 | // register namespaces |
234 | - \EE_Register_Addon::_setup_namespaces($addon_settings); |
|
235 | - // check if this is an activation request |
|
236 | - if ( \EE_Register_Addon::_addon_activation($addon_name, $addon_settings)) { |
|
237 | - // dont bother setting up the rest of the addon atm |
|
238 | - return; |
|
239 | - } |
|
240 | - // we need cars |
|
241 | - \EE_Register_Addon::_setup_autoloaders($addon_name); |
|
242 | - // register new models and extensions |
|
243 | - \EE_Register_Addon::_register_models_and_extensions($addon_name); |
|
244 | - // setup DMS |
|
245 | - \EE_Register_Addon::_register_data_migration_scripts($addon_name); |
|
246 | - // if config_class is present let's register config. |
|
247 | - \EE_Register_Addon::_register_config($addon_name); |
|
248 | - // register admin pages |
|
249 | - \EE_Register_Addon::_register_admin_pages($addon_name); |
|
250 | - // add to list of modules to be registered |
|
251 | - \EE_Register_Addon::_register_modules($addon_name); |
|
252 | - // add to list of shortcodes to be registered |
|
253 | - \EE_Register_Addon::_register_shortcodes($addon_name); |
|
254 | - // add to list of widgets to be registered |
|
255 | - \EE_Register_Addon::_register_widgets($addon_name); |
|
256 | - // register capability related stuff. |
|
257 | - \EE_Register_Addon::_register_capabilities($addon_name); |
|
258 | - // any message type to register? |
|
259 | - \EE_Register_Addon::_register_message_types($addon_name); |
|
234 | + \EE_Register_Addon::_setup_namespaces($addon_settings); |
|
235 | + // check if this is an activation request |
|
236 | + if ( \EE_Register_Addon::_addon_activation($addon_name, $addon_settings)) { |
|
237 | + // dont bother setting up the rest of the addon atm |
|
238 | + return; |
|
239 | + } |
|
240 | + // we need cars |
|
241 | + \EE_Register_Addon::_setup_autoloaders($addon_name); |
|
242 | + // register new models and extensions |
|
243 | + \EE_Register_Addon::_register_models_and_extensions($addon_name); |
|
244 | + // setup DMS |
|
245 | + \EE_Register_Addon::_register_data_migration_scripts($addon_name); |
|
246 | + // if config_class is present let's register config. |
|
247 | + \EE_Register_Addon::_register_config($addon_name); |
|
248 | + // register admin pages |
|
249 | + \EE_Register_Addon::_register_admin_pages($addon_name); |
|
250 | + // add to list of modules to be registered |
|
251 | + \EE_Register_Addon::_register_modules($addon_name); |
|
252 | + // add to list of shortcodes to be registered |
|
253 | + \EE_Register_Addon::_register_shortcodes($addon_name); |
|
254 | + // add to list of widgets to be registered |
|
255 | + \EE_Register_Addon::_register_widgets($addon_name); |
|
256 | + // register capability related stuff. |
|
257 | + \EE_Register_Addon::_register_capabilities($addon_name); |
|
258 | + // any message type to register? |
|
259 | + \EE_Register_Addon::_register_message_types($addon_name); |
|
260 | 260 | // any custom post type/ custom capabilities or default terms to register |
261 | - \EE_Register_Addon::_register_custom_post_types($addon_name); |
|
262 | - // and any payment methods |
|
263 | - \EE_Register_Addon::_register_payment_methods($addon_name); |
|
261 | + \EE_Register_Addon::_register_custom_post_types($addon_name); |
|
262 | + // and any payment methods |
|
263 | + \EE_Register_Addon::_register_payment_methods($addon_name); |
|
264 | 264 | // load and instantiate main addon class |
265 | - $addon = \EE_Register_Addon::_load_and_init_addon_class($addon_name); |
|
266 | - $addon->after_registration(); |
|
267 | - } |
|
268 | - |
|
269 | - |
|
270 | - |
|
271 | - /** |
|
272 | - * @param string $addon_name |
|
273 | - * @param array $setup_args |
|
274 | - * @return void |
|
275 | - * @throws \EE_Error |
|
276 | - */ |
|
277 | - private static function _verify_parameters($addon_name, array $setup_args) |
|
278 | - { |
|
279 | - // required fields MUST be present, so let's make sure they are. |
|
280 | - if (empty($addon_name) || ! is_array($setup_args)) { |
|
281 | - throw new EE_Error( |
|
282 | - __( |
|
283 | - 'In order to register an EE_Addon with EE_Register_Addon::register(), you must include the "addon_name" (the name of the addon), and an array of arguments.', |
|
284 | - 'event_espresso' |
|
285 | - ) |
|
286 | - ); |
|
287 | - } |
|
288 | - if ( ! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) { |
|
289 | - throw new EE_Error( |
|
290 | - sprintf( |
|
291 | - __( |
|
292 | - 'When registering an addon, you didn\'t provide the "main_file_path", which is the full path to the main file loaded directly by Wordpress. You only provided %s', |
|
293 | - 'event_espresso' |
|
294 | - ), |
|
295 | - implode(',', array_keys($setup_args)) |
|
296 | - ) |
|
297 | - ); |
|
298 | - } |
|
299 | - // check that addon has not already been registered with that name |
|
300 | - if (isset(self::$_settings[$addon_name]) && ! did_action('activate_plugin')) { |
|
301 | - throw new EE_Error( |
|
302 | - sprintf( |
|
303 | - __( |
|
304 | - 'An EE_Addon with the name "%s" has already been registered and each EE_Addon requires a unique name.', |
|
305 | - 'event_espresso' |
|
306 | - ), |
|
307 | - $addon_name |
|
308 | - ) |
|
309 | - ); |
|
310 | - } |
|
265 | + $addon = \EE_Register_Addon::_load_and_init_addon_class($addon_name); |
|
266 | + $addon->after_registration(); |
|
267 | + } |
|
268 | + |
|
269 | + |
|
270 | + |
|
271 | + /** |
|
272 | + * @param string $addon_name |
|
273 | + * @param array $setup_args |
|
274 | + * @return void |
|
275 | + * @throws \EE_Error |
|
276 | + */ |
|
277 | + private static function _verify_parameters($addon_name, array $setup_args) |
|
278 | + { |
|
279 | + // required fields MUST be present, so let's make sure they are. |
|
280 | + if (empty($addon_name) || ! is_array($setup_args)) { |
|
281 | + throw new EE_Error( |
|
282 | + __( |
|
283 | + 'In order to register an EE_Addon with EE_Register_Addon::register(), you must include the "addon_name" (the name of the addon), and an array of arguments.', |
|
284 | + 'event_espresso' |
|
285 | + ) |
|
286 | + ); |
|
287 | + } |
|
288 | + if ( ! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) { |
|
289 | + throw new EE_Error( |
|
290 | + sprintf( |
|
291 | + __( |
|
292 | + 'When registering an addon, you didn\'t provide the "main_file_path", which is the full path to the main file loaded directly by Wordpress. You only provided %s', |
|
293 | + 'event_espresso' |
|
294 | + ), |
|
295 | + implode(',', array_keys($setup_args)) |
|
296 | + ) |
|
297 | + ); |
|
298 | + } |
|
299 | + // check that addon has not already been registered with that name |
|
300 | + if (isset(self::$_settings[$addon_name]) && ! did_action('activate_plugin')) { |
|
301 | + throw new EE_Error( |
|
302 | + sprintf( |
|
303 | + __( |
|
304 | + 'An EE_Addon with the name "%s" has already been registered and each EE_Addon requires a unique name.', |
|
305 | + 'event_espresso' |
|
306 | + ), |
|
307 | + $addon_name |
|
308 | + ) |
|
309 | + ); |
|
310 | + } |
|
311 | 311 | } |
312 | 312 | |
313 | 313 | |
314 | 314 | |
315 | - /** |
|
316 | - * @param string $addon_name |
|
317 | - * @param array $setup_args |
|
318 | - * @return string |
|
319 | - */ |
|
320 | - private static function _parse_class_name($addon_name, array $setup_args) |
|
321 | - { |
|
322 | - if (empty($setup_args['class_name'])) { |
|
323 | - // generate one by first separating name with spaces |
|
324 | - $class_name = str_replace(array('-', '_'), ' ', trim($addon_name)); |
|
325 | - //capitalize, then replace spaces with underscores |
|
326 | - $class_name = str_replace(' ', '_', ucwords($class_name)); |
|
327 | - } else { |
|
328 | - $class_name = $setup_args['class_name']; |
|
329 | - } |
|
330 | - return strpos($class_name, 'EE_') === 0 ? $class_name : 'EE_' . $class_name; |
|
331 | - } |
|
332 | - |
|
333 | - |
|
334 | - |
|
335 | - /** |
|
336 | - * @param string $class_name |
|
337 | - * @param array $setup_args |
|
338 | - * @return array |
|
339 | - */ |
|
340 | - private static function _get_addon_settings($class_name, array $setup_args) |
|
341 | - { |
|
342 | - //setup $_settings array from incoming values. |
|
343 | - $addon_settings = array( |
|
344 | - // generated from the addon name, changes something like "calendar" to "EE_Calendar" |
|
345 | - 'class_name' => $class_name, |
|
346 | - // the addon slug for use in URLs, etc |
|
347 | - 'plugin_slug' => isset($setup_args['plugin_slug']) |
|
348 | - ? (string)$setup_args['plugin_slug'] |
|
349 | - : '', |
|
350 | - // page slug to be used when generating the "Settings" link on the WP plugin page |
|
351 | - 'plugin_action_slug' => isset($setup_args['plugin_action_slug']) |
|
352 | - ? (string)$setup_args['plugin_action_slug'] |
|
353 | - : '', |
|
354 | - // the "software" version for the addon |
|
355 | - 'version' => isset($setup_args['version']) |
|
356 | - ? (string)$setup_args['version'] |
|
357 | - : '', |
|
358 | - // the minimum version of EE Core that the addon will work with |
|
359 | - 'min_core_version' => isset($setup_args['min_core_version']) |
|
360 | - ? (string)$setup_args['min_core_version'] |
|
361 | - : '', |
|
362 | - // the minimum version of WordPress that the addon will work with |
|
363 | - 'min_wp_version' => isset($setup_args['min_wp_version']) |
|
364 | - ? (string)$setup_args['min_wp_version'] |
|
365 | - : EE_MIN_WP_VER_REQUIRED, |
|
366 | - // full server path to main file (file loaded directly by WP) |
|
367 | - 'main_file_path' => isset($setup_args['main_file_path']) |
|
368 | - ? (string)$setup_args['main_file_path'] |
|
369 | - : '', |
|
370 | - // path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages |
|
371 | - 'admin_path' => isset($setup_args['admin_path']) |
|
372 | - ? (string)$setup_args['admin_path'] : '', |
|
373 | - // a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page |
|
374 | - 'admin_callback' => isset($setup_args['admin_callback']) |
|
375 | - ? (string)$setup_args['admin_callback'] |
|
376 | - : '', |
|
377 | - // the section name for this addon's configuration settings section (defaults to "addons") |
|
378 | - 'config_section' => isset($setup_args['config_section']) |
|
379 | - ? (string)$setup_args['config_section'] |
|
380 | - : 'addons', |
|
381 | - // the class name for this addon's configuration settings object |
|
382 | - 'config_class' => isset($setup_args['config_class']) |
|
383 | - ? (string)$setup_args['config_class'] : '', |
|
384 | - //the name given to the config for this addons' configuration settings object (optional) |
|
385 | - 'config_name' => isset($setup_args['config_name']) |
|
386 | - ? (string)$setup_args['config_name'] : '', |
|
387 | - // an array of "class names" => "full server paths" for any classes that might be invoked by the addon |
|
388 | - 'autoloader_paths' => isset($setup_args['autoloader_paths']) |
|
389 | - ? (array)$setup_args['autoloader_paths'] |
|
390 | - : array(), |
|
391 | - // an array of "full server paths" for any folders containing classes that might be invoked by the addon |
|
392 | - 'autoloader_folders' => isset($setup_args['autoloader_folders']) |
|
393 | - ? (array)$setup_args['autoloader_folders'] |
|
394 | - : array(), |
|
395 | - // array of full server paths to any EE_DMS data migration scripts used by the addon |
|
396 | - 'dms_paths' => isset($setup_args['dms_paths']) |
|
397 | - ? (array)$setup_args['dms_paths'] |
|
398 | - : array(), |
|
399 | - // array of full server paths to any EED_Modules used by the addon |
|
400 | - 'module_paths' => isset($setup_args['module_paths']) |
|
401 | - ? (array)$setup_args['module_paths'] |
|
402 | - : array(), |
|
403 | - // array of full server paths to any EES_Shortcodes used by the addon |
|
404 | - 'shortcode_paths' => isset($setup_args['shortcode_paths']) |
|
405 | - ? (array)$setup_args['shortcode_paths'] |
|
406 | - : array(), |
|
407 | - // array of full server paths to any WP_Widgets used by the addon |
|
408 | - 'widget_paths' => isset($setup_args['widget_paths']) |
|
409 | - ? (array)$setup_args['widget_paths'] |
|
410 | - : array(), |
|
411 | - // array of PUE options used by the addon |
|
412 | - 'pue_options' => isset($setup_args['pue_options']) |
|
413 | - ? (array)$setup_args['pue_options'] |
|
414 | - : array(), |
|
415 | - 'message_types' => isset($setup_args['message_types']) |
|
416 | - ? (array)$setup_args['message_types'] |
|
417 | - : array(), |
|
418 | - 'capabilities' => isset($setup_args['capabilities']) |
|
419 | - ? (array)$setup_args['capabilities'] |
|
420 | - : array(), |
|
421 | - 'capability_maps' => isset($setup_args['capability_maps']) |
|
422 | - ? (array)$setup_args['capability_maps'] |
|
423 | - : array(), |
|
424 | - 'model_paths' => isset($setup_args['model_paths']) |
|
425 | - ? (array)$setup_args['model_paths'] |
|
426 | - : array(), |
|
427 | - 'class_paths' => isset($setup_args['class_paths']) |
|
428 | - ? (array)$setup_args['class_paths'] |
|
429 | - : array(), |
|
430 | - 'model_extension_paths' => isset($setup_args['model_extension_paths']) |
|
431 | - ? (array)$setup_args['model_extension_paths'] |
|
432 | - : array(), |
|
433 | - 'class_extension_paths' => isset($setup_args['class_extension_paths']) |
|
434 | - ? (array)$setup_args['class_extension_paths'] |
|
435 | - : array(), |
|
436 | - 'custom_post_types' => isset($setup_args['custom_post_types']) |
|
437 | - ? (array)$setup_args['custom_post_types'] |
|
438 | - : array(), |
|
439 | - 'custom_taxonomies' => isset($setup_args['custom_taxonomies']) |
|
440 | - ? (array)$setup_args['custom_taxonomies'] |
|
441 | - : array(), |
|
442 | - 'payment_method_paths' => isset($setup_args['payment_method_paths']) |
|
443 | - ? (array)$setup_args['payment_method_paths'] |
|
444 | - : array(), |
|
445 | - 'default_terms' => isset($setup_args['default_terms']) |
|
446 | - ? (array)$setup_args['default_terms'] |
|
447 | - : array(), |
|
448 | - // if not empty, inserts a new table row after this plugin's row on the WP Plugins page |
|
449 | - // that can be used for adding upgrading/marketing info |
|
450 | - 'plugins_page_row' => isset($setup_args['plugins_page_row']) |
|
451 | - ? $setup_args['plugins_page_row'] |
|
452 | - : '', |
|
453 | - 'namespace' => isset( |
|
454 | - $setup_args['namespace'], |
|
455 | - $setup_args['namespace']['FQNS'], |
|
456 | - $setup_args['namespace']['DIR'] |
|
457 | - ) |
|
458 | - ? (array)$setup_args['namespace'] |
|
459 | - : array(), |
|
460 | - ); |
|
461 | - // if plugin_action_slug is NOT set, but an admin page path IS set, |
|
462 | - // then let's just use the plugin_slug since that will be used for linking to the admin page |
|
463 | - $addon_settings['plugin_action_slug'] = empty($addon_settings['plugin_action_slug']) |
|
464 | - && ! empty($addon_settings['admin_path']) |
|
465 | - ? $addon_settings['plugin_slug'] |
|
466 | - : $addon_settings['plugin_action_slug']; |
|
467 | - // full server path to main file (file loaded directly by WP) |
|
468 | - $addon_settings['plugin_basename'] = plugin_basename($addon_settings['main_file_path']); |
|
469 | - return $addon_settings; |
|
315 | + /** |
|
316 | + * @param string $addon_name |
|
317 | + * @param array $setup_args |
|
318 | + * @return string |
|
319 | + */ |
|
320 | + private static function _parse_class_name($addon_name, array $setup_args) |
|
321 | + { |
|
322 | + if (empty($setup_args['class_name'])) { |
|
323 | + // generate one by first separating name with spaces |
|
324 | + $class_name = str_replace(array('-', '_'), ' ', trim($addon_name)); |
|
325 | + //capitalize, then replace spaces with underscores |
|
326 | + $class_name = str_replace(' ', '_', ucwords($class_name)); |
|
327 | + } else { |
|
328 | + $class_name = $setup_args['class_name']; |
|
329 | + } |
|
330 | + return strpos($class_name, 'EE_') === 0 ? $class_name : 'EE_' . $class_name; |
|
470 | 331 | } |
471 | 332 | |
472 | 333 | |
473 | 334 | |
474 | - /** |
|
475 | - * @param string $addon_name |
|
476 | - * @param array $addon_settings |
|
477 | - * @return boolean |
|
478 | - */ |
|
335 | + /** |
|
336 | + * @param string $class_name |
|
337 | + * @param array $setup_args |
|
338 | + * @return array |
|
339 | + */ |
|
340 | + private static function _get_addon_settings($class_name, array $setup_args) |
|
341 | + { |
|
342 | + //setup $_settings array from incoming values. |
|
343 | + $addon_settings = array( |
|
344 | + // generated from the addon name, changes something like "calendar" to "EE_Calendar" |
|
345 | + 'class_name' => $class_name, |
|
346 | + // the addon slug for use in URLs, etc |
|
347 | + 'plugin_slug' => isset($setup_args['plugin_slug']) |
|
348 | + ? (string)$setup_args['plugin_slug'] |
|
349 | + : '', |
|
350 | + // page slug to be used when generating the "Settings" link on the WP plugin page |
|
351 | + 'plugin_action_slug' => isset($setup_args['plugin_action_slug']) |
|
352 | + ? (string)$setup_args['plugin_action_slug'] |
|
353 | + : '', |
|
354 | + // the "software" version for the addon |
|
355 | + 'version' => isset($setup_args['version']) |
|
356 | + ? (string)$setup_args['version'] |
|
357 | + : '', |
|
358 | + // the minimum version of EE Core that the addon will work with |
|
359 | + 'min_core_version' => isset($setup_args['min_core_version']) |
|
360 | + ? (string)$setup_args['min_core_version'] |
|
361 | + : '', |
|
362 | + // the minimum version of WordPress that the addon will work with |
|
363 | + 'min_wp_version' => isset($setup_args['min_wp_version']) |
|
364 | + ? (string)$setup_args['min_wp_version'] |
|
365 | + : EE_MIN_WP_VER_REQUIRED, |
|
366 | + // full server path to main file (file loaded directly by WP) |
|
367 | + 'main_file_path' => isset($setup_args['main_file_path']) |
|
368 | + ? (string)$setup_args['main_file_path'] |
|
369 | + : '', |
|
370 | + // path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages |
|
371 | + 'admin_path' => isset($setup_args['admin_path']) |
|
372 | + ? (string)$setup_args['admin_path'] : '', |
|
373 | + // a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page |
|
374 | + 'admin_callback' => isset($setup_args['admin_callback']) |
|
375 | + ? (string)$setup_args['admin_callback'] |
|
376 | + : '', |
|
377 | + // the section name for this addon's configuration settings section (defaults to "addons") |
|
378 | + 'config_section' => isset($setup_args['config_section']) |
|
379 | + ? (string)$setup_args['config_section'] |
|
380 | + : 'addons', |
|
381 | + // the class name for this addon's configuration settings object |
|
382 | + 'config_class' => isset($setup_args['config_class']) |
|
383 | + ? (string)$setup_args['config_class'] : '', |
|
384 | + //the name given to the config for this addons' configuration settings object (optional) |
|
385 | + 'config_name' => isset($setup_args['config_name']) |
|
386 | + ? (string)$setup_args['config_name'] : '', |
|
387 | + // an array of "class names" => "full server paths" for any classes that might be invoked by the addon |
|
388 | + 'autoloader_paths' => isset($setup_args['autoloader_paths']) |
|
389 | + ? (array)$setup_args['autoloader_paths'] |
|
390 | + : array(), |
|
391 | + // an array of "full server paths" for any folders containing classes that might be invoked by the addon |
|
392 | + 'autoloader_folders' => isset($setup_args['autoloader_folders']) |
|
393 | + ? (array)$setup_args['autoloader_folders'] |
|
394 | + : array(), |
|
395 | + // array of full server paths to any EE_DMS data migration scripts used by the addon |
|
396 | + 'dms_paths' => isset($setup_args['dms_paths']) |
|
397 | + ? (array)$setup_args['dms_paths'] |
|
398 | + : array(), |
|
399 | + // array of full server paths to any EED_Modules used by the addon |
|
400 | + 'module_paths' => isset($setup_args['module_paths']) |
|
401 | + ? (array)$setup_args['module_paths'] |
|
402 | + : array(), |
|
403 | + // array of full server paths to any EES_Shortcodes used by the addon |
|
404 | + 'shortcode_paths' => isset($setup_args['shortcode_paths']) |
|
405 | + ? (array)$setup_args['shortcode_paths'] |
|
406 | + : array(), |
|
407 | + // array of full server paths to any WP_Widgets used by the addon |
|
408 | + 'widget_paths' => isset($setup_args['widget_paths']) |
|
409 | + ? (array)$setup_args['widget_paths'] |
|
410 | + : array(), |
|
411 | + // array of PUE options used by the addon |
|
412 | + 'pue_options' => isset($setup_args['pue_options']) |
|
413 | + ? (array)$setup_args['pue_options'] |
|
414 | + : array(), |
|
415 | + 'message_types' => isset($setup_args['message_types']) |
|
416 | + ? (array)$setup_args['message_types'] |
|
417 | + : array(), |
|
418 | + 'capabilities' => isset($setup_args['capabilities']) |
|
419 | + ? (array)$setup_args['capabilities'] |
|
420 | + : array(), |
|
421 | + 'capability_maps' => isset($setup_args['capability_maps']) |
|
422 | + ? (array)$setup_args['capability_maps'] |
|
423 | + : array(), |
|
424 | + 'model_paths' => isset($setup_args['model_paths']) |
|
425 | + ? (array)$setup_args['model_paths'] |
|
426 | + : array(), |
|
427 | + 'class_paths' => isset($setup_args['class_paths']) |
|
428 | + ? (array)$setup_args['class_paths'] |
|
429 | + : array(), |
|
430 | + 'model_extension_paths' => isset($setup_args['model_extension_paths']) |
|
431 | + ? (array)$setup_args['model_extension_paths'] |
|
432 | + : array(), |
|
433 | + 'class_extension_paths' => isset($setup_args['class_extension_paths']) |
|
434 | + ? (array)$setup_args['class_extension_paths'] |
|
435 | + : array(), |
|
436 | + 'custom_post_types' => isset($setup_args['custom_post_types']) |
|
437 | + ? (array)$setup_args['custom_post_types'] |
|
438 | + : array(), |
|
439 | + 'custom_taxonomies' => isset($setup_args['custom_taxonomies']) |
|
440 | + ? (array)$setup_args['custom_taxonomies'] |
|
441 | + : array(), |
|
442 | + 'payment_method_paths' => isset($setup_args['payment_method_paths']) |
|
443 | + ? (array)$setup_args['payment_method_paths'] |
|
444 | + : array(), |
|
445 | + 'default_terms' => isset($setup_args['default_terms']) |
|
446 | + ? (array)$setup_args['default_terms'] |
|
447 | + : array(), |
|
448 | + // if not empty, inserts a new table row after this plugin's row on the WP Plugins page |
|
449 | + // that can be used for adding upgrading/marketing info |
|
450 | + 'plugins_page_row' => isset($setup_args['plugins_page_row']) |
|
451 | + ? $setup_args['plugins_page_row'] |
|
452 | + : '', |
|
453 | + 'namespace' => isset( |
|
454 | + $setup_args['namespace'], |
|
455 | + $setup_args['namespace']['FQNS'], |
|
456 | + $setup_args['namespace']['DIR'] |
|
457 | + ) |
|
458 | + ? (array)$setup_args['namespace'] |
|
459 | + : array(), |
|
460 | + ); |
|
461 | + // if plugin_action_slug is NOT set, but an admin page path IS set, |
|
462 | + // then let's just use the plugin_slug since that will be used for linking to the admin page |
|
463 | + $addon_settings['plugin_action_slug'] = empty($addon_settings['plugin_action_slug']) |
|
464 | + && ! empty($addon_settings['admin_path']) |
|
465 | + ? $addon_settings['plugin_slug'] |
|
466 | + : $addon_settings['plugin_action_slug']; |
|
467 | + // full server path to main file (file loaded directly by WP) |
|
468 | + $addon_settings['plugin_basename'] = plugin_basename($addon_settings['main_file_path']); |
|
469 | + return $addon_settings; |
|
470 | + } |
|
471 | + |
|
472 | + |
|
473 | + |
|
474 | + /** |
|
475 | + * @param string $addon_name |
|
476 | + * @param array $addon_settings |
|
477 | + * @return boolean |
|
478 | + */ |
|
479 | 479 | private static function _addon_is_compatible( $addon_name, array $addon_settings ) { |
480 | - global $wp_version; |
|
481 | - $incompatibility_message = ''; |
|
482 | - //check whether this addon version is compatible with EE core |
|
483 | - if ( |
|
484 | - isset(EE_Register_Addon::$_incompatible_addons[$addon_name]) |
|
485 | - && ! self::_meets_min_core_version_requirement( |
|
486 | - EE_Register_Addon::$_incompatible_addons[$addon_name], |
|
487 | - $addon_settings['version'] |
|
488 | - ) |
|
489 | - ) { |
|
490 | - $incompatibility_message = sprintf( |
|
491 | - __( |
|
492 | - '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon is not compatible with this version of Event Espresso.%2$sPlease upgrade your "%1$s" addon to version %3$s or newer to resolve this issue.' |
|
493 | - ), |
|
494 | - $addon_name, |
|
495 | - '<br />', |
|
496 | - EE_Register_Addon::$_incompatible_addons[$addon_name], |
|
497 | - '<span style="font-weight: bold; color: #D54E21;">', |
|
498 | - '</span><br />' |
|
499 | - ); |
|
500 | - } else if ( |
|
501 | - ! self::_meets_min_core_version_requirement($addon_settings['min_core_version'], espresso_version()) |
|
502 | - ) { |
|
503 | - $incompatibility_message = sprintf( |
|
504 | - __( |
|
505 | - '%5$sIMPORTANT!%6$sThe Event Espresso "%1$s" addon requires Event Espresso Core version "%2$s" or higher in order to run.%4$sYour version of Event Espresso Core is currently at "%3$s". Please upgrade Event Espresso Core first and then re-activate "%1$s".', |
|
506 | - 'event_espresso' |
|
507 | - ), |
|
508 | - $addon_name, |
|
509 | - self::_effective_version($addon_settings['min_core_version']), |
|
510 | - self::_effective_version(espresso_version()), |
|
511 | - '<br />', |
|
512 | - '<span style="font-weight: bold; color: #D54E21;">', |
|
513 | - '</span><br />' |
|
514 | - ); |
|
515 | - } else if (version_compare($wp_version, $addon_settings['min_wp_version'], '<')) { |
|
516 | - $incompatibility_message = sprintf( |
|
517 | - __( |
|
518 | - '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon requires WordPress version "%2$s" or greater.%3$sPlease update your version of WordPress to use the "%1$s" addon and to keep your site secure.', |
|
519 | - 'event_espresso' |
|
520 | - ), |
|
521 | - $addon_name, |
|
522 | - $addon_settings['min_wp_version'], |
|
523 | - '<br />', |
|
524 | - '<span style="font-weight: bold; color: #D54E21;">', |
|
525 | - '</span><br />' |
|
526 | - ); |
|
527 | - } |
|
528 | - if ( ! empty($incompatibility_message)) { |
|
529 | - // remove 'activate' from the REQUEST |
|
530 | - // so WP doesn't erroneously tell the user the plugin activated fine when it didn't |
|
531 | - unset($_GET['activate'], $_REQUEST['activate']); |
|
532 | - if (current_user_can('activate_plugins')) { |
|
533 | - // show an error message indicating the plugin didn't activate properly |
|
534 | - EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__); |
|
535 | - } |
|
536 | - // BAIL FROM THE ADDON REGISTRATION PROCESS |
|
537 | - return false; |
|
538 | - } |
|
539 | - // addon IS compatible |
|
540 | - return true; |
|
480 | + global $wp_version; |
|
481 | + $incompatibility_message = ''; |
|
482 | + //check whether this addon version is compatible with EE core |
|
483 | + if ( |
|
484 | + isset(EE_Register_Addon::$_incompatible_addons[$addon_name]) |
|
485 | + && ! self::_meets_min_core_version_requirement( |
|
486 | + EE_Register_Addon::$_incompatible_addons[$addon_name], |
|
487 | + $addon_settings['version'] |
|
488 | + ) |
|
489 | + ) { |
|
490 | + $incompatibility_message = sprintf( |
|
491 | + __( |
|
492 | + '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon is not compatible with this version of Event Espresso.%2$sPlease upgrade your "%1$s" addon to version %3$s or newer to resolve this issue.' |
|
493 | + ), |
|
494 | + $addon_name, |
|
495 | + '<br />', |
|
496 | + EE_Register_Addon::$_incompatible_addons[$addon_name], |
|
497 | + '<span style="font-weight: bold; color: #D54E21;">', |
|
498 | + '</span><br />' |
|
499 | + ); |
|
500 | + } else if ( |
|
501 | + ! self::_meets_min_core_version_requirement($addon_settings['min_core_version'], espresso_version()) |
|
502 | + ) { |
|
503 | + $incompatibility_message = sprintf( |
|
504 | + __( |
|
505 | + '%5$sIMPORTANT!%6$sThe Event Espresso "%1$s" addon requires Event Espresso Core version "%2$s" or higher in order to run.%4$sYour version of Event Espresso Core is currently at "%3$s". Please upgrade Event Espresso Core first and then re-activate "%1$s".', |
|
506 | + 'event_espresso' |
|
507 | + ), |
|
508 | + $addon_name, |
|
509 | + self::_effective_version($addon_settings['min_core_version']), |
|
510 | + self::_effective_version(espresso_version()), |
|
511 | + '<br />', |
|
512 | + '<span style="font-weight: bold; color: #D54E21;">', |
|
513 | + '</span><br />' |
|
514 | + ); |
|
515 | + } else if (version_compare($wp_version, $addon_settings['min_wp_version'], '<')) { |
|
516 | + $incompatibility_message = sprintf( |
|
517 | + __( |
|
518 | + '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon requires WordPress version "%2$s" or greater.%3$sPlease update your version of WordPress to use the "%1$s" addon and to keep your site secure.', |
|
519 | + 'event_espresso' |
|
520 | + ), |
|
521 | + $addon_name, |
|
522 | + $addon_settings['min_wp_version'], |
|
523 | + '<br />', |
|
524 | + '<span style="font-weight: bold; color: #D54E21;">', |
|
525 | + '</span><br />' |
|
526 | + ); |
|
527 | + } |
|
528 | + if ( ! empty($incompatibility_message)) { |
|
529 | + // remove 'activate' from the REQUEST |
|
530 | + // so WP doesn't erroneously tell the user the plugin activated fine when it didn't |
|
531 | + unset($_GET['activate'], $_REQUEST['activate']); |
|
532 | + if (current_user_can('activate_plugins')) { |
|
533 | + // show an error message indicating the plugin didn't activate properly |
|
534 | + EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__); |
|
535 | + } |
|
536 | + // BAIL FROM THE ADDON REGISTRATION PROCESS |
|
537 | + return false; |
|
538 | + } |
|
539 | + // addon IS compatible |
|
540 | + return true; |
|
541 | 541 | } |
542 | 542 | |
543 | 543 | |
544 | 544 | |
545 | - /** |
|
546 | - * if plugin update engine is being used for auto-updates, |
|
547 | - * then let's set that up now before going any further so that ALL addons can be updated |
|
548 | - * (not needed if PUE is not being used) |
|
549 | - * |
|
550 | - * @param string $addon_name |
|
551 | - * @param string $class_name |
|
552 | - * @param array $setup_args |
|
553 | - * @return void |
|
554 | - */ |
|
545 | + /** |
|
546 | + * if plugin update engine is being used for auto-updates, |
|
547 | + * then let's set that up now before going any further so that ALL addons can be updated |
|
548 | + * (not needed if PUE is not being used) |
|
549 | + * |
|
550 | + * @param string $addon_name |
|
551 | + * @param string $class_name |
|
552 | + * @param array $setup_args |
|
553 | + * @return void |
|
554 | + */ |
|
555 | 555 | private static function _parse_pue_options( $addon_name, $class_name, array $setup_args ) { |
556 | - if ( ! empty($setup_args['pue_options'])) { |
|
557 | - self::$_settings[$addon_name]['pue_options'] = array( |
|
558 | - 'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug']) |
|
559 | - ? (string)$setup_args['pue_options']['pue_plugin_slug'] |
|
560 | - : 'espresso_' . strtolower($class_name), |
|
561 | - 'plugin_basename' => isset($setup_args['pue_options']['plugin_basename']) |
|
562 | - ? (string)$setup_args['pue_options']['plugin_basename'] |
|
563 | - : plugin_basename($setup_args['main_file_path']), |
|
564 | - 'checkPeriod' => isset($setup_args['pue_options']['checkPeriod']) |
|
565 | - ? (string)$setup_args['pue_options']['checkPeriod'] |
|
566 | - : '24', |
|
567 | - 'use_wp_update' => isset($setup_args['pue_options']['use_wp_update']) |
|
568 | - ? (string)$setup_args['pue_options']['use_wp_update'] |
|
569 | - : false, |
|
570 | - ); |
|
571 | - add_action( |
|
572 | - 'AHEE__EE_System__brew_espresso__after_pue_init', |
|
573 | - array('EE_Register_Addon', 'load_pue_update') |
|
574 | - ); |
|
575 | - } |
|
556 | + if ( ! empty($setup_args['pue_options'])) { |
|
557 | + self::$_settings[$addon_name]['pue_options'] = array( |
|
558 | + 'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug']) |
|
559 | + ? (string)$setup_args['pue_options']['pue_plugin_slug'] |
|
560 | + : 'espresso_' . strtolower($class_name), |
|
561 | + 'plugin_basename' => isset($setup_args['pue_options']['plugin_basename']) |
|
562 | + ? (string)$setup_args['pue_options']['plugin_basename'] |
|
563 | + : plugin_basename($setup_args['main_file_path']), |
|
564 | + 'checkPeriod' => isset($setup_args['pue_options']['checkPeriod']) |
|
565 | + ? (string)$setup_args['pue_options']['checkPeriod'] |
|
566 | + : '24', |
|
567 | + 'use_wp_update' => isset($setup_args['pue_options']['use_wp_update']) |
|
568 | + ? (string)$setup_args['pue_options']['use_wp_update'] |
|
569 | + : false, |
|
570 | + ); |
|
571 | + add_action( |
|
572 | + 'AHEE__EE_System__brew_espresso__after_pue_init', |
|
573 | + array('EE_Register_Addon', 'load_pue_update') |
|
574 | + ); |
|
575 | + } |
|
576 | 576 | } |
577 | 577 | |
578 | 578 | |
579 | 579 | |
580 | - /** |
|
581 | - * register namespaces right away before any other files or classes get loaded, but AFTER the version checks |
|
582 | - * |
|
583 | - * @param array $addon_settings |
|
584 | - * @return void |
|
585 | - */ |
|
586 | - private static function _setup_namespaces(array $addon_settings) |
|
587 | - { |
|
588 | - // |
|
589 | - if ( |
|
590 | - isset( |
|
591 | - $addon_settings['namespace'], |
|
592 | - $addon_settings['namespace']['FQNS'], |
|
593 | - $addon_settings['namespace']['DIR'] |
|
594 | - ) |
|
595 | - ) { |
|
596 | - EE_Psr4AutoloaderInit::psr4_loader()->addNamespace( |
|
597 | - $addon_settings['namespace']['FQNS'], |
|
598 | - $addon_settings['namespace']['DIR'] |
|
599 | - ); |
|
600 | - } |
|
601 | - } |
|
602 | - |
|
603 | - |
|
604 | - |
|
605 | - /** |
|
606 | - * @param string $addon_name |
|
607 | - * @param array $addon_settings |
|
608 | - * @return bool |
|
609 | - */ |
|
580 | + /** |
|
581 | + * register namespaces right away before any other files or classes get loaded, but AFTER the version checks |
|
582 | + * |
|
583 | + * @param array $addon_settings |
|
584 | + * @return void |
|
585 | + */ |
|
586 | + private static function _setup_namespaces(array $addon_settings) |
|
587 | + { |
|
588 | + // |
|
589 | + if ( |
|
590 | + isset( |
|
591 | + $addon_settings['namespace'], |
|
592 | + $addon_settings['namespace']['FQNS'], |
|
593 | + $addon_settings['namespace']['DIR'] |
|
594 | + ) |
|
595 | + ) { |
|
596 | + EE_Psr4AutoloaderInit::psr4_loader()->addNamespace( |
|
597 | + $addon_settings['namespace']['FQNS'], |
|
598 | + $addon_settings['namespace']['DIR'] |
|
599 | + ); |
|
600 | + } |
|
601 | + } |
|
602 | + |
|
603 | + |
|
604 | + |
|
605 | + /** |
|
606 | + * @param string $addon_name |
|
607 | + * @param array $addon_settings |
|
608 | + * @return bool |
|
609 | + */ |
|
610 | 610 | private static function _addon_activation( $addon_name, array $addon_settings ) { |
611 | - // this is an activation request |
|
612 | - if (did_action('activate_plugin')) { |
|
613 | - //to find if THIS is the addon that was activated, |
|
614 | - //just check if we have already registered it or not |
|
615 | - //(as the newly-activated addon wasn't around the first time addons were registered) |
|
616 | - if ( ! isset(self::$_settings[$addon_name])) { |
|
617 | - self::$_settings[$addon_name] = $addon_settings; |
|
618 | - $addon = self::_load_and_init_addon_class($addon_name); |
|
619 | - $addon->set_activation_indicator_option(); |
|
620 | - // dont bother setting up the rest of the addon. |
|
621 | - // we know it was just activated and the request will end soon |
|
622 | - } |
|
623 | - return true; |
|
624 | - } else { |
|
625 | - // make sure this was called in the right place! |
|
626 | - if ( |
|
627 | - ! did_action('AHEE__EE_System__load_espresso_addons') |
|
628 | - || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin') |
|
629 | - ) { |
|
630 | - EE_Error::doing_it_wrong( |
|
631 | - __METHOD__, |
|
632 | - sprintf( |
|
633 | - __( |
|
634 | - 'An attempt to register an EE_Addon named "%s" has failed because it was not registered at the correct time. Please use the "AHEE__EE_System__load_espresso_addons" hook to register addons.', |
|
635 | - 'event_espresso' |
|
636 | - ), |
|
637 | - $addon_name |
|
638 | - ), |
|
639 | - '4.3.0' |
|
640 | - ); |
|
641 | - } |
|
642 | - // make sure addon settings are set correctly without overwriting anything existing |
|
643 | - if (isset(self::$_settings[$addon_name])) { |
|
644 | - self::$_settings[$addon_name] += $addon_settings; |
|
645 | - } else { |
|
646 | - self::$_settings[$addon_name] = $addon_settings; |
|
647 | - } |
|
648 | - } |
|
649 | - return false; |
|
650 | - } |
|
651 | - |
|
652 | - |
|
653 | - |
|
654 | - /** |
|
655 | - * @param string $addon_name |
|
656 | - * @return void |
|
657 | - * @throws \EE_Error |
|
658 | - */ |
|
659 | - private static function _setup_autoloaders($addon_name) |
|
660 | - { |
|
661 | - if ( ! empty(self::$_settings[$addon_name]['autoloader_paths'])) { |
|
662 | - // setup autoloader for single file |
|
663 | - EEH_Autoloader::instance()->register_autoloader(self::$_settings[$addon_name]['autoloader_paths']); |
|
664 | - } |
|
665 | - // setup autoloaders for folders |
|
666 | - if ( ! empty(self::$_settings[$addon_name]['autoloader_folders'])) { |
|
667 | - foreach ((array)self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) { |
|
668 | - EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder); |
|
669 | - } |
|
670 | - } |
|
671 | - } |
|
672 | - |
|
673 | - |
|
674 | - |
|
675 | - /** |
|
676 | - * register new models and extensions |
|
677 | - * |
|
678 | - * @param string $addon_name |
|
679 | - * @return void |
|
680 | - * @throws \EE_Error |
|
681 | - */ |
|
611 | + // this is an activation request |
|
612 | + if (did_action('activate_plugin')) { |
|
613 | + //to find if THIS is the addon that was activated, |
|
614 | + //just check if we have already registered it or not |
|
615 | + //(as the newly-activated addon wasn't around the first time addons were registered) |
|
616 | + if ( ! isset(self::$_settings[$addon_name])) { |
|
617 | + self::$_settings[$addon_name] = $addon_settings; |
|
618 | + $addon = self::_load_and_init_addon_class($addon_name); |
|
619 | + $addon->set_activation_indicator_option(); |
|
620 | + // dont bother setting up the rest of the addon. |
|
621 | + // we know it was just activated and the request will end soon |
|
622 | + } |
|
623 | + return true; |
|
624 | + } else { |
|
625 | + // make sure this was called in the right place! |
|
626 | + if ( |
|
627 | + ! did_action('AHEE__EE_System__load_espresso_addons') |
|
628 | + || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin') |
|
629 | + ) { |
|
630 | + EE_Error::doing_it_wrong( |
|
631 | + __METHOD__, |
|
632 | + sprintf( |
|
633 | + __( |
|
634 | + 'An attempt to register an EE_Addon named "%s" has failed because it was not registered at the correct time. Please use the "AHEE__EE_System__load_espresso_addons" hook to register addons.', |
|
635 | + 'event_espresso' |
|
636 | + ), |
|
637 | + $addon_name |
|
638 | + ), |
|
639 | + '4.3.0' |
|
640 | + ); |
|
641 | + } |
|
642 | + // make sure addon settings are set correctly without overwriting anything existing |
|
643 | + if (isset(self::$_settings[$addon_name])) { |
|
644 | + self::$_settings[$addon_name] += $addon_settings; |
|
645 | + } else { |
|
646 | + self::$_settings[$addon_name] = $addon_settings; |
|
647 | + } |
|
648 | + } |
|
649 | + return false; |
|
650 | + } |
|
651 | + |
|
652 | + |
|
653 | + |
|
654 | + /** |
|
655 | + * @param string $addon_name |
|
656 | + * @return void |
|
657 | + * @throws \EE_Error |
|
658 | + */ |
|
659 | + private static function _setup_autoloaders($addon_name) |
|
660 | + { |
|
661 | + if ( ! empty(self::$_settings[$addon_name]['autoloader_paths'])) { |
|
662 | + // setup autoloader for single file |
|
663 | + EEH_Autoloader::instance()->register_autoloader(self::$_settings[$addon_name]['autoloader_paths']); |
|
664 | + } |
|
665 | + // setup autoloaders for folders |
|
666 | + if ( ! empty(self::$_settings[$addon_name]['autoloader_folders'])) { |
|
667 | + foreach ((array)self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) { |
|
668 | + EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder); |
|
669 | + } |
|
670 | + } |
|
671 | + } |
|
672 | + |
|
673 | + |
|
674 | + |
|
675 | + /** |
|
676 | + * register new models and extensions |
|
677 | + * |
|
678 | + * @param string $addon_name |
|
679 | + * @return void |
|
680 | + * @throws \EE_Error |
|
681 | + */ |
|
682 | 682 | private static function _register_models_and_extensions( $addon_name ) { |
683 | - // register new models |
|
684 | - if ( |
|
685 | - ! empty(self::$_settings[$addon_name]['model_paths']) |
|
686 | - || ! empty(self::$_settings[$addon_name]['class_paths']) |
|
687 | - ) { |
|
688 | - EE_Register_Model::register( |
|
689 | - $addon_name, |
|
690 | - array( |
|
691 | - 'model_paths' => self::$_settings[$addon_name]['model_paths'], |
|
692 | - 'class_paths' => self::$_settings[$addon_name]['class_paths'], |
|
693 | - ) |
|
694 | - ); |
|
695 | - } |
|
696 | - // register model extensions |
|
697 | - if ( |
|
698 | - ! empty(self::$_settings[$addon_name]['model_extension_paths']) |
|
699 | - || ! empty(self::$_settings[$addon_name]['class_extension_paths']) |
|
700 | - ) { |
|
701 | - EE_Register_Model_Extensions::register( |
|
702 | - $addon_name, |
|
703 | - array( |
|
704 | - 'model_extension_paths' => self::$_settings[$addon_name]['model_extension_paths'], |
|
705 | - 'class_extension_paths' => self::$_settings[$addon_name]['class_extension_paths'], |
|
706 | - ) |
|
707 | - ); |
|
708 | - } |
|
709 | - } |
|
710 | - |
|
711 | - |
|
712 | - |
|
713 | - /** |
|
714 | - * @param string $addon_name |
|
715 | - * @return void |
|
716 | - * @throws \EE_Error |
|
717 | - */ |
|
683 | + // register new models |
|
684 | + if ( |
|
685 | + ! empty(self::$_settings[$addon_name]['model_paths']) |
|
686 | + || ! empty(self::$_settings[$addon_name]['class_paths']) |
|
687 | + ) { |
|
688 | + EE_Register_Model::register( |
|
689 | + $addon_name, |
|
690 | + array( |
|
691 | + 'model_paths' => self::$_settings[$addon_name]['model_paths'], |
|
692 | + 'class_paths' => self::$_settings[$addon_name]['class_paths'], |
|
693 | + ) |
|
694 | + ); |
|
695 | + } |
|
696 | + // register model extensions |
|
697 | + if ( |
|
698 | + ! empty(self::$_settings[$addon_name]['model_extension_paths']) |
|
699 | + || ! empty(self::$_settings[$addon_name]['class_extension_paths']) |
|
700 | + ) { |
|
701 | + EE_Register_Model_Extensions::register( |
|
702 | + $addon_name, |
|
703 | + array( |
|
704 | + 'model_extension_paths' => self::$_settings[$addon_name]['model_extension_paths'], |
|
705 | + 'class_extension_paths' => self::$_settings[$addon_name]['class_extension_paths'], |
|
706 | + ) |
|
707 | + ); |
|
708 | + } |
|
709 | + } |
|
710 | + |
|
711 | + |
|
712 | + |
|
713 | + /** |
|
714 | + * @param string $addon_name |
|
715 | + * @return void |
|
716 | + * @throws \EE_Error |
|
717 | + */ |
|
718 | 718 | private static function _register_data_migration_scripts( $addon_name ) { |
719 | - // setup DMS |
|
720 | - if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) { |
|
721 | - EE_Register_Data_Migration_Scripts::register( |
|
722 | - $addon_name, |
|
723 | - array('dms_paths' => self::$_settings[$addon_name]['dms_paths']) |
|
724 | - ); |
|
725 | - } |
|
726 | - } |
|
727 | - |
|
728 | - |
|
729 | - /** |
|
730 | - * @param string $addon_name |
|
731 | - * @return void |
|
732 | - * @throws \EE_Error |
|
733 | - */ |
|
719 | + // setup DMS |
|
720 | + if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) { |
|
721 | + EE_Register_Data_Migration_Scripts::register( |
|
722 | + $addon_name, |
|
723 | + array('dms_paths' => self::$_settings[$addon_name]['dms_paths']) |
|
724 | + ); |
|
725 | + } |
|
726 | + } |
|
727 | + |
|
728 | + |
|
729 | + /** |
|
730 | + * @param string $addon_name |
|
731 | + * @return void |
|
732 | + * @throws \EE_Error |
|
733 | + */ |
|
734 | 734 | private static function _register_config( $addon_name ) { |
735 | - // if config_class is present let's register config. |
|
736 | - if ( ! empty(self::$_settings[$addon_name]['config_class'])) { |
|
737 | - EE_Register_Config::register( |
|
738 | - self::$_settings[$addon_name]['config_class'], |
|
739 | - array( |
|
740 | - 'config_section' => self::$_settings[$addon_name]['config_section'], |
|
741 | - 'config_name' => self::$_settings[$addon_name]['config_name'], |
|
742 | - ) |
|
743 | - ); |
|
744 | - } |
|
745 | - } |
|
746 | - |
|
747 | - |
|
748 | - /** |
|
749 | - * @param string $addon_name |
|
750 | - * @return void |
|
751 | - * @throws \EE_Error |
|
752 | - */ |
|
735 | + // if config_class is present let's register config. |
|
736 | + if ( ! empty(self::$_settings[$addon_name]['config_class'])) { |
|
737 | + EE_Register_Config::register( |
|
738 | + self::$_settings[$addon_name]['config_class'], |
|
739 | + array( |
|
740 | + 'config_section' => self::$_settings[$addon_name]['config_section'], |
|
741 | + 'config_name' => self::$_settings[$addon_name]['config_name'], |
|
742 | + ) |
|
743 | + ); |
|
744 | + } |
|
745 | + } |
|
746 | + |
|
747 | + |
|
748 | + /** |
|
749 | + * @param string $addon_name |
|
750 | + * @return void |
|
751 | + * @throws \EE_Error |
|
752 | + */ |
|
753 | 753 | private static function _register_admin_pages( $addon_name ) { |
754 | - if ( ! empty(self::$_settings[$addon_name]['admin_path'])) { |
|
755 | - EE_Register_Admin_Page::register( |
|
756 | - $addon_name, |
|
757 | - array('page_path' => self::$_settings[$addon_name]['admin_path']) |
|
758 | - ); |
|
759 | - } |
|
760 | - } |
|
761 | - |
|
762 | - |
|
763 | - /** |
|
764 | - * @param string $addon_name |
|
765 | - * @return void |
|
766 | - * @throws \EE_Error |
|
767 | - */ |
|
754 | + if ( ! empty(self::$_settings[$addon_name]['admin_path'])) { |
|
755 | + EE_Register_Admin_Page::register( |
|
756 | + $addon_name, |
|
757 | + array('page_path' => self::$_settings[$addon_name]['admin_path']) |
|
758 | + ); |
|
759 | + } |
|
760 | + } |
|
761 | + |
|
762 | + |
|
763 | + /** |
|
764 | + * @param string $addon_name |
|
765 | + * @return void |
|
766 | + * @throws \EE_Error |
|
767 | + */ |
|
768 | 768 | private static function _register_modules( $addon_name ) { |
769 | - if ( ! empty(self::$_settings[$addon_name]['module_paths'])) { |
|
770 | - EE_Register_Module::register( |
|
771 | - $addon_name, |
|
772 | - array('module_paths' => self::$_settings[$addon_name]['module_paths']) |
|
773 | - ); |
|
774 | - } |
|
775 | - } |
|
776 | - |
|
777 | - |
|
778 | - /** |
|
779 | - * @param string $addon_name |
|
780 | - * @return void |
|
781 | - * @throws \EE_Error |
|
782 | - */ |
|
769 | + if ( ! empty(self::$_settings[$addon_name]['module_paths'])) { |
|
770 | + EE_Register_Module::register( |
|
771 | + $addon_name, |
|
772 | + array('module_paths' => self::$_settings[$addon_name]['module_paths']) |
|
773 | + ); |
|
774 | + } |
|
775 | + } |
|
776 | + |
|
777 | + |
|
778 | + /** |
|
779 | + * @param string $addon_name |
|
780 | + * @return void |
|
781 | + * @throws \EE_Error |
|
782 | + */ |
|
783 | 783 | private static function _register_shortcodes( $addon_name ) { |
784 | - if ( ! empty(self::$_settings[$addon_name]['shortcode_paths'])) { |
|
785 | - EE_Register_Shortcode::register( |
|
786 | - $addon_name, |
|
787 | - array('shortcode_paths' => self::$_settings[$addon_name]['shortcode_paths']) |
|
788 | - ); |
|
789 | - } |
|
790 | - } |
|
791 | - |
|
792 | - |
|
793 | - /** |
|
794 | - * @param string $addon_name |
|
795 | - * @return void |
|
796 | - * @throws \EE_Error |
|
797 | - */ |
|
784 | + if ( ! empty(self::$_settings[$addon_name]['shortcode_paths'])) { |
|
785 | + EE_Register_Shortcode::register( |
|
786 | + $addon_name, |
|
787 | + array('shortcode_paths' => self::$_settings[$addon_name]['shortcode_paths']) |
|
788 | + ); |
|
789 | + } |
|
790 | + } |
|
791 | + |
|
792 | + |
|
793 | + /** |
|
794 | + * @param string $addon_name |
|
795 | + * @return void |
|
796 | + * @throws \EE_Error |
|
797 | + */ |
|
798 | 798 | private static function _register_widgets( $addon_name ) { |
799 | - if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) { |
|
800 | - EE_Register_Widget::register( |
|
801 | - $addon_name, |
|
802 | - array('widget_paths' => self::$_settings[$addon_name]['widget_paths']) |
|
803 | - ); |
|
804 | - } |
|
805 | - } |
|
806 | - |
|
807 | - |
|
808 | - /** |
|
809 | - * @param string $addon_name |
|
810 | - * @return void |
|
811 | - * @throws \EE_Error |
|
812 | - */ |
|
799 | + if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) { |
|
800 | + EE_Register_Widget::register( |
|
801 | + $addon_name, |
|
802 | + array('widget_paths' => self::$_settings[$addon_name]['widget_paths']) |
|
803 | + ); |
|
804 | + } |
|
805 | + } |
|
806 | + |
|
807 | + |
|
808 | + /** |
|
809 | + * @param string $addon_name |
|
810 | + * @return void |
|
811 | + * @throws \EE_Error |
|
812 | + */ |
|
813 | 813 | private static function _register_capabilities( $addon_name ) { |
814 | - if ( ! empty(self::$_settings[$addon_name]['capabilities'])) { |
|
815 | - EE_Register_Capabilities::register( |
|
816 | - $addon_name, |
|
817 | - array( |
|
818 | - 'capabilities' => self::$_settings[$addon_name]['capabilities'], |
|
819 | - 'capability_maps' => self::$_settings[$addon_name]['capability_maps'], |
|
820 | - ) |
|
821 | - ); |
|
822 | - } |
|
823 | - } |
|
824 | - |
|
825 | - |
|
826 | - /** |
|
827 | - * @param string $addon_name |
|
828 | - * @return void |
|
829 | - * @throws \EE_Error |
|
830 | - */ |
|
814 | + if ( ! empty(self::$_settings[$addon_name]['capabilities'])) { |
|
815 | + EE_Register_Capabilities::register( |
|
816 | + $addon_name, |
|
817 | + array( |
|
818 | + 'capabilities' => self::$_settings[$addon_name]['capabilities'], |
|
819 | + 'capability_maps' => self::$_settings[$addon_name]['capability_maps'], |
|
820 | + ) |
|
821 | + ); |
|
822 | + } |
|
823 | + } |
|
824 | + |
|
825 | + |
|
826 | + /** |
|
827 | + * @param string $addon_name |
|
828 | + * @return void |
|
829 | + * @throws \EE_Error |
|
830 | + */ |
|
831 | 831 | private static function _register_message_types( $addon_name ) { |
832 | - if ( ! empty(self::$_settings[$addon_name]['message_types'])) { |
|
833 | - add_action( |
|
834 | - 'EE_Brewing_Regular___messages_caf', |
|
835 | - array('EE_Register_Addon', 'register_message_types') |
|
836 | - ); |
|
837 | - } |
|
838 | - } |
|
839 | - |
|
840 | - |
|
841 | - /** |
|
842 | - * @param string $addon_name |
|
843 | - * @return void |
|
844 | - * @throws \EE_Error |
|
845 | - */ |
|
832 | + if ( ! empty(self::$_settings[$addon_name]['message_types'])) { |
|
833 | + add_action( |
|
834 | + 'EE_Brewing_Regular___messages_caf', |
|
835 | + array('EE_Register_Addon', 'register_message_types') |
|
836 | + ); |
|
837 | + } |
|
838 | + } |
|
839 | + |
|
840 | + |
|
841 | + /** |
|
842 | + * @param string $addon_name |
|
843 | + * @return void |
|
844 | + * @throws \EE_Error |
|
845 | + */ |
|
846 | 846 | private static function _register_custom_post_types( $addon_name ) { |
847 | - if ( |
|
848 | - ! empty(self::$_settings[$addon_name]['custom_post_types']) |
|
849 | - || ! empty(self::$_settings[$addon_name]['custom_taxonomies']) |
|
850 | - ) { |
|
851 | - EE_Register_CPT::register( |
|
852 | - $addon_name, |
|
853 | - array( |
|
854 | - 'cpts' => self::$_settings[$addon_name]['custom_post_types'], |
|
855 | - 'cts' => self::$_settings[$addon_name]['custom_taxonomies'], |
|
856 | - 'default_terms' => self::$_settings[$addon_name]['default_terms'], |
|
857 | - ) |
|
858 | - ); |
|
859 | - } |
|
860 | - } |
|
861 | - |
|
862 | - |
|
863 | - /** |
|
864 | - * @param string $addon_name |
|
865 | - * @return void |
|
866 | - * @throws \EE_Error |
|
867 | - */ |
|
847 | + if ( |
|
848 | + ! empty(self::$_settings[$addon_name]['custom_post_types']) |
|
849 | + || ! empty(self::$_settings[$addon_name]['custom_taxonomies']) |
|
850 | + ) { |
|
851 | + EE_Register_CPT::register( |
|
852 | + $addon_name, |
|
853 | + array( |
|
854 | + 'cpts' => self::$_settings[$addon_name]['custom_post_types'], |
|
855 | + 'cts' => self::$_settings[$addon_name]['custom_taxonomies'], |
|
856 | + 'default_terms' => self::$_settings[$addon_name]['default_terms'], |
|
857 | + ) |
|
858 | + ); |
|
859 | + } |
|
860 | + } |
|
861 | + |
|
862 | + |
|
863 | + /** |
|
864 | + * @param string $addon_name |
|
865 | + * @return void |
|
866 | + * @throws \EE_Error |
|
867 | + */ |
|
868 | 868 | private static function _register_payment_methods( $addon_name ) { |
869 | - if ( ! empty(self::$_settings[$addon_name]['payment_method_paths'])) { |
|
870 | - EE_Register_Payment_Method::register( |
|
871 | - $addon_name, |
|
872 | - array('payment_method_paths' => self::$_settings[$addon_name]['payment_method_paths']) |
|
873 | - ); |
|
874 | - } |
|
875 | - } |
|
869 | + if ( ! empty(self::$_settings[$addon_name]['payment_method_paths'])) { |
|
870 | + EE_Register_Payment_Method::register( |
|
871 | + $addon_name, |
|
872 | + array('payment_method_paths' => self::$_settings[$addon_name]['payment_method_paths']) |
|
873 | + ); |
|
874 | + } |
|
875 | + } |
|
876 | 876 | |
877 | 877 | |
878 | 878 | |
@@ -901,14 +901,14 @@ discard block |
||
901 | 901 | //unfortunately this can't be hooked in upon construction, because we don't have |
902 | 902 | //the plugin mainfile's path upon construction. |
903 | 903 | register_deactivation_hook( $addon->get_main_plugin_file(), array( $addon, 'deactivation' ) ); |
904 | - // call any additional admin_callback functions during load_admin_controller hook |
|
905 | - if ( ! empty(self::$_settings[$addon_name]['admin_callback'])) { |
|
906 | - add_action( |
|
907 | - 'AHEE__EE_System__load_controllers__load_admin_controllers', |
|
908 | - array($addon, self::$_settings[$addon_name]['admin_callback']) |
|
909 | - ); |
|
910 | - } |
|
911 | - return $addon; |
|
904 | + // call any additional admin_callback functions during load_admin_controller hook |
|
905 | + if ( ! empty(self::$_settings[$addon_name]['admin_callback'])) { |
|
906 | + add_action( |
|
907 | + 'AHEE__EE_System__load_controllers__load_admin_controllers', |
|
908 | + array($addon, self::$_settings[$addon_name]['admin_callback']) |
|
909 | + ); |
|
910 | + } |
|
911 | + return $addon; |
|
912 | 912 | } |
913 | 913 | |
914 | 914 | |
@@ -924,7 +924,7 @@ discard block |
||
924 | 924 | // cycle thru settings |
925 | 925 | foreach ( self::$_settings as $settings ) { |
926 | 926 | if ( ! empty( $settings['pue_options'] ) ) { |
927 | - // initiate the class and start the plugin update engine! |
|
927 | + // initiate the class and start the plugin update engine! |
|
928 | 928 | new PluginUpdateEngineChecker( |
929 | 929 | // host file URL |
930 | 930 | 'https://eventespresso.com', |
@@ -960,11 +960,11 @@ discard block |
||
960 | 960 | */ |
961 | 961 | public static function register_message_types() { |
962 | 962 | foreach ( self::$_settings as $addon_name => $settings ) { |
963 | - if ( ! empty($settings['message_types'])) { |
|
964 | - foreach ((array)$settings['message_types'] as $message_type => $message_type_settings) { |
|
965 | - EE_Register_Message_Type::register($message_type, $message_type_settings); |
|
966 | - } |
|
967 | - } |
|
963 | + if ( ! empty($settings['message_types'])) { |
|
964 | + foreach ((array)$settings['message_types'] as $message_type => $message_type_settings) { |
|
965 | + EE_Register_Message_Type::register($message_type, $message_type_settings); |
|
966 | + } |
|
967 | + } |
|
968 | 968 | } |
969 | 969 | } |
970 | 970 | |
@@ -1006,15 +1006,15 @@ discard block |
||
1006 | 1006 | EE_Register_Widget::deregister( $addon_name ); |
1007 | 1007 | } |
1008 | 1008 | if ( ! empty( self::$_settings[ $addon_name ]['model_paths'] ) |
1009 | - || |
|
1010 | - ! empty( self::$_settings[ $addon_name ]['class_paths'] ) |
|
1009 | + || |
|
1010 | + ! empty( self::$_settings[ $addon_name ]['class_paths'] ) |
|
1011 | 1011 | ) { |
1012 | 1012 | // add to list of shortcodes to be registered |
1013 | 1013 | EE_Register_Model::deregister( $addon_name ); |
1014 | 1014 | } |
1015 | 1015 | if ( ! empty( self::$_settings[ $addon_name ]['model_extension_paths'] ) |
1016 | - || |
|
1017 | - ! empty( self::$_settings[ $addon_name ]['class_extension_paths'] ) |
|
1016 | + || |
|
1017 | + ! empty( self::$_settings[ $addon_name ]['class_extension_paths'] ) |
|
1018 | 1018 | ) { |
1019 | 1019 | // add to list of shortcodes to be registered |
1020 | 1020 | EE_Register_Model_Extensions::deregister( $addon_name ); |
@@ -1,5 +1,5 @@ discard block |
||
1 | -<?php if ( !defined( 'EVENT_ESPRESSO_VERSION' ) ) { |
|
2 | - exit( 'No direct script access allowed' ); |
|
1 | +<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
2 | + exit('No direct script access allowed'); |
|
3 | 3 | } |
4 | 4 | /** |
5 | 5 | * |
@@ -95,7 +95,7 @@ discard block |
||
95 | 95 | * class constructor |
96 | 96 | */ |
97 | 97 | public function __construct() { |
98 | - add_action( 'AHEE__EE_System__load_controllers__load_admin_controllers', array( $this, 'admin_init' ) ); |
|
98 | + add_action('AHEE__EE_System__load_controllers__load_admin_controllers', array($this, 'admin_init')); |
|
99 | 99 | } |
100 | 100 | |
101 | 101 | |
@@ -103,7 +103,7 @@ discard block |
||
103 | 103 | /** |
104 | 104 | * @param mixed $version |
105 | 105 | */ |
106 | - public function set_version( $version = NULL ) { |
|
106 | + public function set_version($version = NULL) { |
|
107 | 107 | $this->_version = $version; |
108 | 108 | } |
109 | 109 | |
@@ -121,7 +121,7 @@ discard block |
||
121 | 121 | /** |
122 | 122 | * @param mixed $min_core_version |
123 | 123 | */ |
124 | - public function set_min_core_version( $min_core_version = NULL ) { |
|
124 | + public function set_min_core_version($min_core_version = NULL) { |
|
125 | 125 | $this->_min_core_version = $min_core_version; |
126 | 126 | } |
127 | 127 | |
@@ -142,7 +142,7 @@ discard block |
||
142 | 142 | * @param string $addon_name |
143 | 143 | * @return boolean |
144 | 144 | */ |
145 | - public function set_name( $addon_name ) { |
|
145 | + public function set_name($addon_name) { |
|
146 | 146 | return $this->_addon_name = $addon_name; |
147 | 147 | } |
148 | 148 | |
@@ -170,7 +170,7 @@ discard block |
||
170 | 170 | /** |
171 | 171 | * @param string $plugin_basename |
172 | 172 | */ |
173 | - public function set_plugin_basename( $plugin_basename ) { |
|
173 | + public function set_plugin_basename($plugin_basename) { |
|
174 | 174 | |
175 | 175 | $this->_plugin_basename = $plugin_basename; |
176 | 176 | } |
@@ -190,7 +190,7 @@ discard block |
||
190 | 190 | /** |
191 | 191 | * @param string $plugin_slug |
192 | 192 | */ |
193 | - public function set_plugin_slug( $plugin_slug ) { |
|
193 | + public function set_plugin_slug($plugin_slug) { |
|
194 | 194 | |
195 | 195 | $this->_plugin_slug = $plugin_slug; |
196 | 196 | } |
@@ -210,7 +210,7 @@ discard block |
||
210 | 210 | /** |
211 | 211 | * @param string $plugin_action_slug |
212 | 212 | */ |
213 | - public function set_plugin_action_slug( $plugin_action_slug ) { |
|
213 | + public function set_plugin_action_slug($plugin_action_slug) { |
|
214 | 214 | |
215 | 215 | $this->_plugin_action_slug = $plugin_action_slug; |
216 | 216 | } |
@@ -230,9 +230,9 @@ discard block |
||
230 | 230 | /** |
231 | 231 | * @param array $plugins_page_row |
232 | 232 | */ |
233 | - public function set_plugins_page_row( $plugins_page_row = array() ) { |
|
233 | + public function set_plugins_page_row($plugins_page_row = array()) { |
|
234 | 234 | // sigh.... check for example content that I stupidly merged to master and remove it if found |
235 | - if ( ! is_array( $plugins_page_row ) && strpos( $plugins_page_row, '<h3>Promotions Addon Upsell Info</h3>' ) !== false ) { |
|
235 | + if ( ! is_array($plugins_page_row) && strpos($plugins_page_row, '<h3>Promotions Addon Upsell Info</h3>') !== false) { |
|
236 | 236 | $plugins_page_row = ''; |
237 | 237 | } |
238 | 238 | $this->_plugins_page_row = $plugins_page_row; |
@@ -250,7 +250,7 @@ discard block |
||
250 | 250 | do_action("AHEE__{$classname}__new_install"); |
251 | 251 | do_action('AHEE__EE_Addon__new_install', $this); |
252 | 252 | EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old(); |
253 | - add_action( 'AHEE__EE_System__perform_activations_upgrades_and_migrations', array( $this, 'initialize_db_if_no_migrations_required' ) ); |
|
253 | + add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations', array($this, 'initialize_db_if_no_migrations_required')); |
|
254 | 254 | } |
255 | 255 | |
256 | 256 | |
@@ -265,18 +265,18 @@ discard block |
||
265 | 265 | do_action("AHEE__{$classname}__reactivation"); |
266 | 266 | do_action('AHEE__EE_Addon__reactivation', $this); |
267 | 267 | EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old(); |
268 | - add_action( 'AHEE__EE_System__perform_activations_upgrades_and_migrations', array( $this, 'initialize_db_if_no_migrations_required' ) ); |
|
268 | + add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations', array($this, 'initialize_db_if_no_migrations_required')); |
|
269 | 269 | } |
270 | 270 | |
271 | 271 | |
272 | 272 | |
273 | - public function deactivation(){ |
|
273 | + public function deactivation() { |
|
274 | 274 | $classname = get_class($this); |
275 | 275 | // echo "Deactivating $classname";die; |
276 | 276 | do_action("AHEE__{$classname}__deactivation"); |
277 | 277 | do_action('AHEE__EE_Addon__deactivation', $this); |
278 | 278 | //check if the site no longer needs to be in maintenance mode |
279 | - EE_Register_Addon::deregister( $this->name() ); |
|
279 | + EE_Register_Addon::deregister($this->name()); |
|
280 | 280 | EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old(); |
281 | 281 | } |
282 | 282 | |
@@ -292,16 +292,16 @@ discard block |
||
292 | 292 | * @return void |
293 | 293 | * @throws \EE_Error |
294 | 294 | */ |
295 | - public function initialize_db_if_no_migrations_required( $verify_schema = true ) { |
|
296 | - if( $verify_schema === '' ) { |
|
295 | + public function initialize_db_if_no_migrations_required($verify_schema = true) { |
|
296 | + if ($verify_schema === '') { |
|
297 | 297 | //wp core bug imo: if no args are passed to `do_action('some_hook_name')` besides the hook's name |
298 | 298 | //(ie, no 2nd or 3rd arguments), instead of calling the registered callbacks with no arguments, it |
299 | 299 | //calls them with an argument of an empty string (ie ""), which evaluates to false |
300 | 300 | //so we need to treat the empty string as if nothing had been passed, and should instead use the default |
301 | 301 | $verify_schema = true; |
302 | 302 | } |
303 | - if ( EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance ) { |
|
304 | - if( $verify_schema ) { |
|
303 | + if (EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) { |
|
304 | + if ($verify_schema) { |
|
305 | 305 | $this->initialize_db(); |
306 | 306 | } |
307 | 307 | $this->initialize_default_data(); |
@@ -319,15 +319,15 @@ discard block |
||
319 | 319 | * other data needs to be verified) |
320 | 320 | */ |
321 | 321 | EEH_Activation::initialize_db_content(); |
322 | - update_option( 'ee_flush_rewrite_rules', TRUE ); |
|
322 | + update_option('ee_flush_rewrite_rules', TRUE); |
|
323 | 323 | //in case there are lots of addons being activated at once, let's force garbage collection |
324 | 324 | //to help avoid memory limit errors |
325 | 325 | //EEH_Debug_Tools::instance()->measure_memory( 'db content initialized for ' . get_class( $this), true ); |
326 | 326 | gc_collect_cycles(); |
327 | - }else{ |
|
327 | + } else { |
|
328 | 328 | //ask the data migration manager to init this addon's data |
329 | 329 | //when migrations are finished because we can't do it now |
330 | - EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for( $this->name() ); |
|
330 | + EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for($this->name()); |
|
331 | 331 | } |
332 | 332 | } |
333 | 333 | |
@@ -341,15 +341,15 @@ discard block |
||
341 | 341 | */ |
342 | 342 | public function initialize_db() { |
343 | 343 | //find the migration script that sets the database to be compatible with the code |
344 | - $current_dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms( $this->name() ); |
|
345 | - if( $current_dms_name ){ |
|
346 | - $current_data_migration_script = EE_Registry::instance()->load_dms( $current_dms_name ); |
|
347 | - $current_data_migration_script->set_migrating( FALSE ); |
|
344 | + $current_dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms($this->name()); |
|
345 | + if ($current_dms_name) { |
|
346 | + $current_data_migration_script = EE_Registry::instance()->load_dms($current_dms_name); |
|
347 | + $current_data_migration_script->set_migrating(FALSE); |
|
348 | 348 | $current_data_migration_script->schema_changes_before_migration(); |
349 | 349 | $current_data_migration_script->schema_changes_after_migration(); |
350 | - if ( $current_data_migration_script->get_errors() ) { |
|
351 | - foreach( $current_data_migration_script->get_errors() as $error ) { |
|
352 | - EE_Error::add_error( $error, __FILE__, __FUNCTION__, __LINE__ ); |
|
350 | + if ($current_data_migration_script->get_errors()) { |
|
351 | + foreach ($current_data_migration_script->get_errors() as $error) { |
|
352 | + EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__); |
|
353 | 353 | } |
354 | 354 | } |
355 | 355 | } |
@@ -381,7 +381,7 @@ discard block |
||
381 | 381 | * default data) |
382 | 382 | * @param EE_Addon $addon the addon that called this |
383 | 383 | */ |
384 | - do_action( 'AHEE__EE_Addon__initialize_default_data__begin', $this ); |
|
384 | + do_action('AHEE__EE_Addon__initialize_default_data__begin', $this); |
|
385 | 385 | //override to insert default data. It is safe to use the models here |
386 | 386 | //because the site should not be in maintenance mode |
387 | 387 | } |
@@ -401,7 +401,7 @@ discard block |
||
401 | 401 | EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old(); |
402 | 402 | //also it's possible there is new default data that needs to be added |
403 | 403 | add_action( |
404 | - 'AHEE__EE_System__perform_activations_upgrades_and_migrations', array( $this, 'initialize_db_if_no_migrations_required' ) |
|
404 | + 'AHEE__EE_System__perform_activations_upgrades_and_migrations', array($this, 'initialize_db_if_no_migrations_required') |
|
405 | 405 | ); |
406 | 406 | } |
407 | 407 | |
@@ -415,7 +415,7 @@ discard block |
||
415 | 415 | do_action("AHEE__{$classname}__downgrade"); |
416 | 416 | do_action('AHEE__EE_Addon__downgrade', $this); |
417 | 417 | //it's possible there's old default data that needs to be double-checked |
418 | - add_action( 'AHEE__EE_System__perform_activations_upgrades_and_migrations', array( $this, 'initialize_db_if_no_migrations_required' ) ); |
|
418 | + add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations', array($this, 'initialize_db_if_no_migrations_required')); |
|
419 | 419 | } |
420 | 420 | |
421 | 421 | |
@@ -426,7 +426,7 @@ discard block |
||
426 | 426 | * plugin activation only. In the future, we'll want to do it on plugin updates too |
427 | 427 | * @return bool |
428 | 428 | */ |
429 | - public function set_db_update_option_name(){ |
|
429 | + public function set_db_update_option_name() { |
|
430 | 430 | EE_Error::doing_it_wrong(__FUNCTION__, __('EE_Addon::set_db_update_option_name was renamed to EE_Addon::set_activation_indicator_option', 'event_espresso'), '4.3.0.alpha.016'); |
431 | 431 | //let's just handle this on the next request, ok? right now we're just not really ready |
432 | 432 | return $this->set_activation_indicator_option(); |
@@ -454,7 +454,7 @@ discard block |
||
454 | 454 | */ |
455 | 455 | public function set_activation_indicator_option() { |
456 | 456 | // let's just handle this on the next request, ok? right now we're just not really ready |
457 | - return update_option( $this->get_activation_indicator_option_name(), TRUE ); |
|
457 | + return update_option($this->get_activation_indicator_option_name(), TRUE); |
|
458 | 458 | } |
459 | 459 | |
460 | 460 | |
@@ -462,8 +462,8 @@ discard block |
||
462 | 462 | * Gets the name of the wp option which is used to temporarily indicate that this addon was activated |
463 | 463 | * @return string |
464 | 464 | */ |
465 | - public function get_activation_indicator_option_name(){ |
|
466 | - return 'ee_activation_' . $this->name(); |
|
465 | + public function get_activation_indicator_option_name() { |
|
466 | + return 'ee_activation_'.$this->name(); |
|
467 | 467 | } |
468 | 468 | |
469 | 469 | |
@@ -473,7 +473,7 @@ discard block |
||
473 | 473 | * Used by EE_System to set the request type of this addon. Should not be used by addon developers |
474 | 474 | * @param int $req_type |
475 | 475 | */ |
476 | - public function set_req_type( $req_type ) { |
|
476 | + public function set_req_type($req_type) { |
|
477 | 477 | $this->_req_type = $req_type; |
478 | 478 | } |
479 | 479 | |
@@ -484,7 +484,7 @@ discard block |
||
484 | 484 | * of addons |
485 | 485 | */ |
486 | 486 | public function detect_req_type() { |
487 | - if( ! $this->_req_type ){ |
|
487 | + if ( ! $this->_req_type) { |
|
488 | 488 | $this->detect_activation_or_upgrade(); |
489 | 489 | } |
490 | 490 | return $this->_req_type; |
@@ -497,36 +497,36 @@ discard block |
||
497 | 497 | * Should only be called once per request |
498 | 498 | * @return void |
499 | 499 | */ |
500 | - public function detect_activation_or_upgrade(){ |
|
500 | + public function detect_activation_or_upgrade() { |
|
501 | 501 | $activation_history_for_addon = $this->get_activation_history(); |
502 | 502 | // d($activation_history_for_addon); |
503 | 503 | $request_type = EE_System::detect_req_type_given_activation_history($activation_history_for_addon, $this->get_activation_indicator_option_name(), $this->version()); |
504 | 504 | $this->set_req_type($request_type); |
505 | 505 | $classname = get_class($this); |
506 | - switch($request_type){ |
|
506 | + switch ($request_type) { |
|
507 | 507 | case EE_System::req_type_new_activation: |
508 | - do_action( "AHEE__{$classname}__detect_activations_or_upgrades__new_activation" ); |
|
509 | - do_action( 'AHEE__EE_Addon__detect_activations_or_upgrades__new_activation', $this ); |
|
508 | + do_action("AHEE__{$classname}__detect_activations_or_upgrades__new_activation"); |
|
509 | + do_action('AHEE__EE_Addon__detect_activations_or_upgrades__new_activation', $this); |
|
510 | 510 | $this->new_install(); |
511 | - $this->update_list_of_installed_versions( $activation_history_for_addon ); |
|
511 | + $this->update_list_of_installed_versions($activation_history_for_addon); |
|
512 | 512 | break; |
513 | 513 | case EE_System::req_type_reactivation: |
514 | - do_action( "AHEE__{$classname}__detect_activations_or_upgrades__reactivation" ); |
|
515 | - do_action( 'AHEE__EE_Addon__detect_activations_or_upgrades__reactivation', $this ); |
|
514 | + do_action("AHEE__{$classname}__detect_activations_or_upgrades__reactivation"); |
|
515 | + do_action('AHEE__EE_Addon__detect_activations_or_upgrades__reactivation', $this); |
|
516 | 516 | $this->reactivation(); |
517 | - $this->update_list_of_installed_versions( $activation_history_for_addon ); |
|
517 | + $this->update_list_of_installed_versions($activation_history_for_addon); |
|
518 | 518 | break; |
519 | 519 | case EE_System::req_type_upgrade: |
520 | - do_action( "AHEE__{$classname}__detect_activations_or_upgrades__upgrade" ); |
|
521 | - do_action( 'AHEE__EE_Addon__detect_activations_or_upgrades__upgrade', $this ); |
|
520 | + do_action("AHEE__{$classname}__detect_activations_or_upgrades__upgrade"); |
|
521 | + do_action('AHEE__EE_Addon__detect_activations_or_upgrades__upgrade', $this); |
|
522 | 522 | $this->upgrade(); |
523 | - $this->update_list_of_installed_versions($activation_history_for_addon ); |
|
523 | + $this->update_list_of_installed_versions($activation_history_for_addon); |
|
524 | 524 | break; |
525 | 525 | case EE_System::req_type_downgrade: |
526 | - do_action( "AHEE__{$classname}__detect_activations_or_upgrades__downgrade" ); |
|
527 | - do_action( 'AHEE__EE_Addon__detect_activations_or_upgrades__downgrade', $this ); |
|
526 | + do_action("AHEE__{$classname}__detect_activations_or_upgrades__downgrade"); |
|
527 | + do_action('AHEE__EE_Addon__detect_activations_or_upgrades__downgrade', $this); |
|
528 | 528 | $this->downgrade(); |
529 | - $this->update_list_of_installed_versions($activation_history_for_addon ); |
|
529 | + $this->update_list_of_installed_versions($activation_history_for_addon); |
|
530 | 530 | break; |
531 | 531 | case EE_System::req_type_normal: |
532 | 532 | default: |
@@ -534,7 +534,7 @@ discard block |
||
534 | 534 | break; |
535 | 535 | } |
536 | 536 | |
537 | - do_action( "AHEE__{$classname}__detect_if_activation_or_upgrade__complete" ); |
|
537 | + do_action("AHEE__{$classname}__detect_if_activation_or_upgrade__complete"); |
|
538 | 538 | } |
539 | 539 | |
540 | 540 | /** |
@@ -543,17 +543,17 @@ discard block |
||
543 | 543 | * @param string $current_version_to_add |
544 | 544 | * @return boolean success |
545 | 545 | */ |
546 | - public function update_list_of_installed_versions($version_history = NULL,$current_version_to_add = NULL) { |
|
547 | - if( ! $version_history ) { |
|
546 | + public function update_list_of_installed_versions($version_history = NULL, $current_version_to_add = NULL) { |
|
547 | + if ( ! $version_history) { |
|
548 | 548 | $version_history = $this->get_activation_history(); |
549 | 549 | } |
550 | - if( $current_version_to_add === NULL){ |
|
550 | + if ($current_version_to_add === NULL) { |
|
551 | 551 | $current_version_to_add = $this->version(); |
552 | 552 | } |
553 | - $version_history[ $current_version_to_add ][] = date( 'Y-m-d H:i:s',time() ); |
|
553 | + $version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time()); |
|
554 | 554 | // resave |
555 | 555 | // echo "updating list of installed versions:".$this->get_activation_history_option_name();d($version_history); |
556 | - return update_option( $this->get_activation_history_option_name(), $version_history ); |
|
556 | + return update_option($this->get_activation_history_option_name(), $version_history); |
|
557 | 557 | } |
558 | 558 | |
559 | 559 | /** |
@@ -561,8 +561,8 @@ discard block |
||
561 | 561 | * of this addon |
562 | 562 | * @return string |
563 | 563 | */ |
564 | - public function get_activation_history_option_name(){ |
|
565 | - return self::ee_addon_version_history_option_prefix . $this->name(); |
|
564 | + public function get_activation_history_option_name() { |
|
565 | + return self::ee_addon_version_history_option_prefix.$this->name(); |
|
566 | 566 | } |
567 | 567 | |
568 | 568 | |
@@ -571,7 +571,7 @@ discard block |
||
571 | 571 | * Gets the wp option which stores the activation history for this addon |
572 | 572 | * @return array |
573 | 573 | */ |
574 | - public function get_activation_history(){ |
|
574 | + public function get_activation_history() { |
|
575 | 575 | return get_option($this->get_activation_history_option_name(), NULL); |
576 | 576 | } |
577 | 577 | |
@@ -580,8 +580,8 @@ discard block |
||
580 | 580 | /** |
581 | 581 | * @param string $config_section |
582 | 582 | */ |
583 | - public function set_config_section( $config_section = '' ) { |
|
584 | - $this->_config_section = ! empty( $config_section ) ? $config_section : 'addons'; |
|
583 | + public function set_config_section($config_section = '') { |
|
584 | + $this->_config_section = ! empty($config_section) ? $config_section : 'addons'; |
|
585 | 585 | } |
586 | 586 | /** |
587 | 587 | * filepath to the main file, which can be used for register_activation_hook, register_deactivation_hook, etc. |
@@ -594,14 +594,14 @@ discard block |
||
594 | 594 | * Sets the filepath to the main plugin file |
595 | 595 | * @param string $filepath |
596 | 596 | */ |
597 | - public function set_main_plugin_file( $filepath ) { |
|
597 | + public function set_main_plugin_file($filepath) { |
|
598 | 598 | $this->_main_plugin_file = $filepath; |
599 | 599 | } |
600 | 600 | /** |
601 | 601 | * gets the filepath to teh main file |
602 | 602 | * @return string |
603 | 603 | */ |
604 | - public function get_main_plugin_file(){ |
|
604 | + public function get_main_plugin_file() { |
|
605 | 605 | return $this->_main_plugin_file; |
606 | 606 | } |
607 | 607 | |
@@ -611,15 +611,15 @@ discard block |
||
611 | 611 | * @return string |
612 | 612 | */ |
613 | 613 | public function get_main_plugin_file_basename() { |
614 | - return plugin_basename( $this->get_main_plugin_file() ); |
|
614 | + return plugin_basename($this->get_main_plugin_file()); |
|
615 | 615 | } |
616 | 616 | |
617 | 617 | /** |
618 | 618 | * Gets the folder name which contains the main plugin file |
619 | 619 | * @return string |
620 | 620 | */ |
621 | - public function get_main_plugin_file_dirname(){ |
|
622 | - return dirname( $this->get_main_plugin_file() ); |
|
621 | + public function get_main_plugin_file_dirname() { |
|
622 | + return dirname($this->get_main_plugin_file()); |
|
623 | 623 | } |
624 | 624 | |
625 | 625 | |
@@ -628,11 +628,11 @@ discard block |
||
628 | 628 | * |
629 | 629 | * @return void |
630 | 630 | */ |
631 | - public function admin_init(){ |
|
631 | + public function admin_init() { |
|
632 | 632 | // is admin and not in M-Mode ? |
633 | - if ( is_admin() && ! EE_Maintenance_Mode::instance()->level() ) { |
|
634 | - add_filter( 'plugin_action_links', array( $this, 'plugin_action_links' ), 10, 2 ); |
|
635 | - add_filter( 'after_plugin_row_' . $this->_plugin_basename, array( $this, 'after_plugin_row' ), 10, 3 ); |
|
633 | + if (is_admin() && ! EE_Maintenance_Mode::instance()->level()) { |
|
634 | + add_filter('plugin_action_links', array($this, 'plugin_action_links'), 10, 2); |
|
635 | + add_filter('after_plugin_row_'.$this->_plugin_basename, array($this, 'after_plugin_row'), 10, 3); |
|
636 | 636 | } |
637 | 637 | } |
638 | 638 | |
@@ -647,10 +647,10 @@ discard block |
||
647 | 647 | * @param $file |
648 | 648 | * @return array |
649 | 649 | */ |
650 | - public function plugin_action_links( $links, $file ) { |
|
651 | - if ( $file === $this->plugin_basename() && $this->plugin_action_slug() !== '' ) { |
|
650 | + public function plugin_action_links($links, $file) { |
|
651 | + if ($file === $this->plugin_basename() && $this->plugin_action_slug() !== '') { |
|
652 | 652 | // before other links |
653 | - array_unshift( $links, '<a href="admin.php?page=' . $this->plugin_action_slug() . '">' . __( 'Settings' ) . '</a>' ); |
|
653 | + array_unshift($links, '<a href="admin.php?page='.$this->plugin_action_slug().'">'.__('Settings').'</a>'); |
|
654 | 654 | } |
655 | 655 | return $links; |
656 | 656 | } |
@@ -668,17 +668,17 @@ discard block |
||
668 | 668 | * @param $status |
669 | 669 | * @return void |
670 | 670 | */ |
671 | - public function after_plugin_row( $plugin_file, $plugin_data, $status ) { |
|
671 | + public function after_plugin_row($plugin_file, $plugin_data, $status) { |
|
672 | 672 | |
673 | 673 | $after_plugin_row = ''; |
674 | - if ( $plugin_file === $this->plugin_basename() && $this->get_plugins_page_row() !== '' ) { |
|
674 | + if ($plugin_file === $this->plugin_basename() && $this->get_plugins_page_row() !== '') { |
|
675 | 675 | $class = $status ? 'active' : 'inactive'; |
676 | 676 | $plugins_page_row = $this->get_plugins_page_row(); |
677 | - $link_text = isset( $plugins_page_row[ 'link_text' ] ) ? $plugins_page_row[ 'link_text' ] : ''; |
|
678 | - $link_url = isset( $plugins_page_row[ 'link_url' ] ) ? $plugins_page_row[ 'link_url' ] : ''; |
|
679 | - $description = isset( $plugins_page_row[ 'description' ] ) ? $plugins_page_row[ 'description' ] : $plugins_page_row; |
|
680 | - if ( ! empty( $link_text ) && ! empty( $link_url ) && ! empty( $description )) { |
|
681 | - $after_plugin_row .= '<tr id="' . sanitize_title( $plugin_file ) . '-ee-addon" class="' . $class . '">'; |
|
677 | + $link_text = isset($plugins_page_row['link_text']) ? $plugins_page_row['link_text'] : ''; |
|
678 | + $link_url = isset($plugins_page_row['link_url']) ? $plugins_page_row['link_url'] : ''; |
|
679 | + $description = isset($plugins_page_row['description']) ? $plugins_page_row['description'] : $plugins_page_row; |
|
680 | + if ( ! empty($link_text) && ! empty($link_url) && ! empty($description)) { |
|
681 | + $after_plugin_row .= '<tr id="'.sanitize_title($plugin_file).'-ee-addon" class="'.$class.'">'; |
|
682 | 682 | $after_plugin_row .= '<th class="check-column" scope="row"></th>'; |
683 | 683 | $after_plugin_row .= '<td class="ee-addon-upsell-info-title-td plugin-title column-primary">'; |
684 | 684 | $after_plugin_row .= '<style> |
@@ -720,7 +720,7 @@ discard block |
||
720 | 720 | </style>'; |
721 | 721 | $after_plugin_row .= ' |
722 | 722 | <p class="ee-addon-upsell-info-dv"> |
723 | - <a class="ee-button" href="' . $link_url . '">' . $link_text . ' <span class="dashicons dashicons-arrow-right-alt2" style="margin:0;"></span></a> |
|
723 | + <a class="ee-button" href="' . $link_url.'">'.$link_text.' <span class="dashicons dashicons-arrow-right-alt2" style="margin:0;"></span></a> |
|
724 | 724 | </p>'; |
725 | 725 | $after_plugin_row .= '</td>'; |
726 | 726 | $after_plugin_row .= '<td class="ee-addon-upsell-info-desc-td column-description desc">'; |
@@ -282,16 +282,16 @@ discard block |
||
282 | 282 | |
283 | 283 | |
284 | 284 | |
285 | - /** |
|
286 | - * Takes care of double-checking that we're not in maintenance mode, and then |
|
287 | - * initializing this addon's necessary initial data. This is called by default on new activations |
|
288 | - * and reactivations |
|
289 | - * |
|
290 | - * @param boolean $verify_schema whether to verify the database's schema for this addon, or just its data. |
|
291 | - * This is a resource-intensive job so we prefer to only do it when necessary |
|
292 | - * @return void |
|
293 | - * @throws \EE_Error |
|
294 | - */ |
|
285 | + /** |
|
286 | + * Takes care of double-checking that we're not in maintenance mode, and then |
|
287 | + * initializing this addon's necessary initial data. This is called by default on new activations |
|
288 | + * and reactivations |
|
289 | + * |
|
290 | + * @param boolean $verify_schema whether to verify the database's schema for this addon, or just its data. |
|
291 | + * This is a resource-intensive job so we prefer to only do it when necessary |
|
292 | + * @return void |
|
293 | + * @throws \EE_Error |
|
294 | + */ |
|
295 | 295 | public function initialize_db_if_no_migrations_required( $verify_schema = true ) { |
296 | 296 | if( $verify_schema === '' ) { |
297 | 297 | //wp core bug imo: if no args are passed to `do_action('some_hook_name')` besides the hook's name |
@@ -307,11 +307,11 @@ discard block |
||
307 | 307 | $this->initialize_default_data(); |
308 | 308 | //@todo: this will probably need to be adjusted in 4.4 as the array changed formats I believe |
309 | 309 | EE_Data_Migration_Manager::instance()->update_current_database_state_to( |
310 | - array( |
|
311 | - 'slug' => $this->name(), |
|
312 | - 'version' => $this->version() |
|
313 | - ) |
|
314 | - ); |
|
310 | + array( |
|
311 | + 'slug' => $this->name(), |
|
312 | + 'version' => $this->version() |
|
313 | + ) |
|
314 | + ); |
|
315 | 315 | /* make sure core's data is a-ok |
316 | 316 | * (at the time of writing, we especially want to verify all the caps are present |
317 | 317 | * because payment method type capabilities are added dynamically, and it's |
@@ -355,11 +355,11 @@ discard block |
||
355 | 355 | } |
356 | 356 | //if not DMS was found that should be ok. This addon just doesn't require any database changes |
357 | 357 | EE_Data_Migration_Manager::instance()->update_current_database_state_to( |
358 | - array( |
|
359 | - 'slug' => $this->name(), |
|
360 | - 'version' => $this->version() |
|
361 | - ) |
|
362 | - ); |
|
358 | + array( |
|
359 | + 'slug' => $this->name(), |
|
360 | + 'version' => $this->version() |
|
361 | + ) |
|
362 | + ); |
|
363 | 363 | } |
364 | 364 | |
365 | 365 | |
@@ -401,8 +401,8 @@ discard block |
||
401 | 401 | EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old(); |
402 | 402 | //also it's possible there is new default data that needs to be added |
403 | 403 | add_action( |
404 | - 'AHEE__EE_System__perform_activations_upgrades_and_migrations', array( $this, 'initialize_db_if_no_migrations_required' ) |
|
405 | - ); |
|
404 | + 'AHEE__EE_System__perform_activations_upgrades_and_migrations', array( $this, 'initialize_db_if_no_migrations_required' ) |
|
405 | + ); |
|
406 | 406 | } |
407 | 407 | |
408 | 408 | |
@@ -624,9 +624,9 @@ discard block |
||
624 | 624 | |
625 | 625 | |
626 | 626 | /** |
627 | - * sets hooks used in the admin |
|
628 | - * |
|
629 | - * @return void |
|
627 | + * sets hooks used in the admin |
|
628 | + * |
|
629 | + * @return void |
|
630 | 630 | */ |
631 | 631 | public function admin_init(){ |
632 | 632 | // is admin and not in M-Mode ? |
@@ -737,16 +737,16 @@ discard block |
||
737 | 737 | |
738 | 738 | |
739 | 739 | |
740 | - /** |
|
741 | - * a safe space for addons to add additional logic like setting hooks |
|
742 | - * that will run immediately after addon registration |
|
743 | - * making this a great place for code that needs to be "omnipresent" |
|
744 | - * |
|
745 | - * @since 4.9.26 |
|
746 | - */ |
|
740 | + /** |
|
741 | + * a safe space for addons to add additional logic like setting hooks |
|
742 | + * that will run immediately after addon registration |
|
743 | + * making this a great place for code that needs to be "omnipresent" |
|
744 | + * |
|
745 | + * @since 4.9.26 |
|
746 | + */ |
|
747 | 747 | public function after_registration() |
748 | - { |
|
749 | - // cricket chirp... cricket chirp... |
|
748 | + { |
|
749 | + // cricket chirp... cricket chirp... |
|
750 | 750 | } |
751 | 751 | |
752 | 752 |
@@ -1,5 +1,5 @@ discard block |
||
1 | 1 | <?php if ( ! defined('ABSPATH')) { |
2 | - exit('No direct script access allowed'); |
|
2 | + exit('No direct script access allowed'); |
|
3 | 3 | } |
4 | 4 | /* |
5 | 5 | Plugin Name: Event Espresso |
@@ -40,239 +40,239 @@ discard block |
||
40 | 40 | * @since 4.0 |
41 | 41 | */ |
42 | 42 | if (function_exists('espresso_version')) { |
43 | - /** |
|
44 | - * espresso_duplicate_plugin_error |
|
45 | - * displays if more than one version of EE is activated at the same time |
|
46 | - */ |
|
47 | - function espresso_duplicate_plugin_error() |
|
48 | - { |
|
49 | - ?> |
|
43 | + /** |
|
44 | + * espresso_duplicate_plugin_error |
|
45 | + * displays if more than one version of EE is activated at the same time |
|
46 | + */ |
|
47 | + function espresso_duplicate_plugin_error() |
|
48 | + { |
|
49 | + ?> |
|
50 | 50 | <div class="error"> |
51 | 51 | <p> |
52 | 52 | <?php echo esc_html__( |
53 | - 'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.', |
|
54 | - 'event_espresso' |
|
55 | - ); ?> |
|
53 | + 'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.', |
|
54 | + 'event_espresso' |
|
55 | + ); ?> |
|
56 | 56 | </p> |
57 | 57 | </div> |
58 | 58 | <?php |
59 | - espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
60 | - } |
|
59 | + espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
60 | + } |
|
61 | 61 | |
62 | - add_action('admin_notices', 'espresso_duplicate_plugin_error', 1); |
|
62 | + add_action('admin_notices', 'espresso_duplicate_plugin_error', 1); |
|
63 | 63 | } else { |
64 | - define('EE_MIN_PHP_VER_REQUIRED', '5.3.9'); |
|
65 | - if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) { |
|
66 | - /** |
|
67 | - * espresso_minimum_php_version_error |
|
68 | - * |
|
69 | - * @return void |
|
70 | - */ |
|
71 | - function espresso_minimum_php_version_error() |
|
72 | - { |
|
73 | - ?> |
|
64 | + define('EE_MIN_PHP_VER_REQUIRED', '5.3.9'); |
|
65 | + if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) { |
|
66 | + /** |
|
67 | + * espresso_minimum_php_version_error |
|
68 | + * |
|
69 | + * @return void |
|
70 | + */ |
|
71 | + function espresso_minimum_php_version_error() |
|
72 | + { |
|
73 | + ?> |
|
74 | 74 | <div class="error"> |
75 | 75 | <p> |
76 | 76 | <?php |
77 | - printf( |
|
78 | - esc_html__( |
|
79 | - 'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.', |
|
80 | - 'event_espresso' |
|
81 | - ), |
|
82 | - EE_MIN_PHP_VER_REQUIRED, |
|
83 | - PHP_VERSION, |
|
84 | - '<br/>', |
|
85 | - '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>' |
|
86 | - ); |
|
87 | - ?> |
|
77 | + printf( |
|
78 | + esc_html__( |
|
79 | + 'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.', |
|
80 | + 'event_espresso' |
|
81 | + ), |
|
82 | + EE_MIN_PHP_VER_REQUIRED, |
|
83 | + PHP_VERSION, |
|
84 | + '<br/>', |
|
85 | + '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>' |
|
86 | + ); |
|
87 | + ?> |
|
88 | 88 | </p> |
89 | 89 | </div> |
90 | 90 | <?php |
91 | - espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
92 | - } |
|
91 | + espresso_deactivate_plugin(plugin_basename(__FILE__)); |
|
92 | + } |
|
93 | 93 | |
94 | - add_action('admin_notices', 'espresso_minimum_php_version_error', 1); |
|
95 | - } else { |
|
96 | - /** |
|
97 | - * espresso_version |
|
98 | - * Returns the plugin version |
|
99 | - * |
|
100 | - * @return string |
|
101 | - */ |
|
102 | - function espresso_version() |
|
103 | - { |
|
104 | - return apply_filters('FHEE__espresso__espresso_version', '4.9.27.rc.000'); |
|
105 | - } |
|
94 | + add_action('admin_notices', 'espresso_minimum_php_version_error', 1); |
|
95 | + } else { |
|
96 | + /** |
|
97 | + * espresso_version |
|
98 | + * Returns the plugin version |
|
99 | + * |
|
100 | + * @return string |
|
101 | + */ |
|
102 | + function espresso_version() |
|
103 | + { |
|
104 | + return apply_filters('FHEE__espresso__espresso_version', '4.9.27.rc.000'); |
|
105 | + } |
|
106 | 106 | |
107 | - // define versions |
|
108 | - define('EVENT_ESPRESSO_VERSION', espresso_version()); |
|
109 | - define('EE_MIN_WP_VER_REQUIRED', '4.1'); |
|
110 | - define('EE_MIN_WP_VER_RECOMMENDED', '4.4.2'); |
|
111 | - define('EE_MIN_PHP_VER_RECOMMENDED', '5.4.44'); |
|
112 | - define('EVENT_ESPRESSO_MAIN_FILE', __FILE__); |
|
113 | - //used to be DIRECTORY_SEPARATOR, but that caused issues on windows |
|
114 | - if ( ! defined('DS')) { |
|
115 | - define('DS', '/'); |
|
116 | - } |
|
117 | - if ( ! defined('PS')) { |
|
118 | - define('PS', PATH_SEPARATOR); |
|
119 | - } |
|
120 | - if ( ! defined('SP')) { |
|
121 | - define('SP', ' '); |
|
122 | - } |
|
123 | - if ( ! defined('EENL')) { |
|
124 | - define('EENL', "\n"); |
|
125 | - } |
|
126 | - define('EE_SUPPORT_EMAIL', '[email protected]'); |
|
127 | - // define the plugin directory and URL |
|
128 | - define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE)); |
|
129 | - define('EE_PLUGIN_DIR_PATH', plugin_dir_path(EVENT_ESPRESSO_MAIN_FILE)); |
|
130 | - define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE)); |
|
131 | - // main root folder paths |
|
132 | - define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages' . DS); |
|
133 | - define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core' . DS); |
|
134 | - define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules' . DS); |
|
135 | - define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public' . DS); |
|
136 | - define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes' . DS); |
|
137 | - define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets' . DS); |
|
138 | - define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods' . DS); |
|
139 | - define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated' . DS); |
|
140 | - // core system paths |
|
141 | - define('EE_ADMIN', EE_CORE . 'admin' . DS); |
|
142 | - define('EE_CPTS', EE_CORE . 'CPTs' . DS); |
|
143 | - define('EE_CLASSES', EE_CORE . 'db_classes' . DS); |
|
144 | - define('EE_INTERFACES', EE_CORE . 'interfaces' . DS); |
|
145 | - define('EE_BUSINESS', EE_CORE . 'business' . DS); |
|
146 | - define('EE_MODELS', EE_CORE . 'db_models' . DS); |
|
147 | - define('EE_HELPERS', EE_CORE . 'helpers' . DS); |
|
148 | - define('EE_LIBRARIES', EE_CORE . 'libraries' . DS); |
|
149 | - define('EE_TEMPLATES', EE_CORE . 'templates' . DS); |
|
150 | - define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs' . DS); |
|
151 | - define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets' . DS); |
|
152 | - define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections' . DS); |
|
153 | - // gateways |
|
154 | - define('EE_GATEWAYS', EE_MODULES . 'gateways' . DS); |
|
155 | - define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules' . DS . 'gateways' . DS); |
|
156 | - // asset URL paths |
|
157 | - define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'templates' . DS); |
|
158 | - define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets' . DS); |
|
159 | - define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images' . DS); |
|
160 | - define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'third_party_libs' . DS); |
|
161 | - define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/'); |
|
162 | - define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/'); |
|
163 | - // define upload paths |
|
164 | - $uploads = wp_upload_dir(); |
|
165 | - // define the uploads directory and URL |
|
166 | - define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . DS . 'espresso' . DS); |
|
167 | - define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . DS . 'espresso' . DS); |
|
168 | - // define the templates directory and URL |
|
169 | - define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'templates' . DS); |
|
170 | - define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'templates' . DS); |
|
171 | - // define the gateway directory and URL |
|
172 | - define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'gateways' . DS); |
|
173 | - define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'gateways' . DS); |
|
174 | - // languages folder/path |
|
175 | - define('EE_LANGUAGES_SAFE_LOC', '..' . DS . 'uploads' . DS . 'espresso' . DS . 'languages' . DS); |
|
176 | - define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS); |
|
177 | - //check for dompdf fonts in uploads |
|
178 | - if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS)) { |
|
179 | - define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS); |
|
180 | - } |
|
181 | - //ajax constants |
|
182 | - define( |
|
183 | - 'EE_FRONT_AJAX', |
|
184 | - isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax']) ? true : false |
|
185 | - ); |
|
186 | - define( |
|
187 | - 'EE_ADMIN_AJAX', |
|
188 | - isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax']) ? true : false |
|
189 | - ); |
|
190 | - //just a handy constant occasionally needed for finding values representing infinity in the DB |
|
191 | - //you're better to use this than its straight value (currently -1) in case you ever |
|
192 | - //want to change its default value! or find when -1 means infinity |
|
193 | - define('EE_INF_IN_DB', -1); |
|
194 | - define('EE_INF', INF > (float)PHP_INT_MAX ? INF : PHP_INT_MAX); |
|
195 | - define('EE_DEBUG', false); |
|
196 | - /** |
|
197 | - * espresso_plugin_activation |
|
198 | - * adds a wp-option to indicate that EE has been activated via the WP admin plugins page |
|
199 | - */ |
|
200 | - function espresso_plugin_activation() |
|
201 | - { |
|
202 | - update_option('ee_espresso_activation', true); |
|
203 | - } |
|
107 | + // define versions |
|
108 | + define('EVENT_ESPRESSO_VERSION', espresso_version()); |
|
109 | + define('EE_MIN_WP_VER_REQUIRED', '4.1'); |
|
110 | + define('EE_MIN_WP_VER_RECOMMENDED', '4.4.2'); |
|
111 | + define('EE_MIN_PHP_VER_RECOMMENDED', '5.4.44'); |
|
112 | + define('EVENT_ESPRESSO_MAIN_FILE', __FILE__); |
|
113 | + //used to be DIRECTORY_SEPARATOR, but that caused issues on windows |
|
114 | + if ( ! defined('DS')) { |
|
115 | + define('DS', '/'); |
|
116 | + } |
|
117 | + if ( ! defined('PS')) { |
|
118 | + define('PS', PATH_SEPARATOR); |
|
119 | + } |
|
120 | + if ( ! defined('SP')) { |
|
121 | + define('SP', ' '); |
|
122 | + } |
|
123 | + if ( ! defined('EENL')) { |
|
124 | + define('EENL', "\n"); |
|
125 | + } |
|
126 | + define('EE_SUPPORT_EMAIL', '[email protected]'); |
|
127 | + // define the plugin directory and URL |
|
128 | + define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE)); |
|
129 | + define('EE_PLUGIN_DIR_PATH', plugin_dir_path(EVENT_ESPRESSO_MAIN_FILE)); |
|
130 | + define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE)); |
|
131 | + // main root folder paths |
|
132 | + define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages' . DS); |
|
133 | + define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core' . DS); |
|
134 | + define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules' . DS); |
|
135 | + define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public' . DS); |
|
136 | + define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes' . DS); |
|
137 | + define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets' . DS); |
|
138 | + define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods' . DS); |
|
139 | + define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated' . DS); |
|
140 | + // core system paths |
|
141 | + define('EE_ADMIN', EE_CORE . 'admin' . DS); |
|
142 | + define('EE_CPTS', EE_CORE . 'CPTs' . DS); |
|
143 | + define('EE_CLASSES', EE_CORE . 'db_classes' . DS); |
|
144 | + define('EE_INTERFACES', EE_CORE . 'interfaces' . DS); |
|
145 | + define('EE_BUSINESS', EE_CORE . 'business' . DS); |
|
146 | + define('EE_MODELS', EE_CORE . 'db_models' . DS); |
|
147 | + define('EE_HELPERS', EE_CORE . 'helpers' . DS); |
|
148 | + define('EE_LIBRARIES', EE_CORE . 'libraries' . DS); |
|
149 | + define('EE_TEMPLATES', EE_CORE . 'templates' . DS); |
|
150 | + define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs' . DS); |
|
151 | + define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets' . DS); |
|
152 | + define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections' . DS); |
|
153 | + // gateways |
|
154 | + define('EE_GATEWAYS', EE_MODULES . 'gateways' . DS); |
|
155 | + define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules' . DS . 'gateways' . DS); |
|
156 | + // asset URL paths |
|
157 | + define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'templates' . DS); |
|
158 | + define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets' . DS); |
|
159 | + define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images' . DS); |
|
160 | + define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'third_party_libs' . DS); |
|
161 | + define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/'); |
|
162 | + define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/'); |
|
163 | + // define upload paths |
|
164 | + $uploads = wp_upload_dir(); |
|
165 | + // define the uploads directory and URL |
|
166 | + define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . DS . 'espresso' . DS); |
|
167 | + define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . DS . 'espresso' . DS); |
|
168 | + // define the templates directory and URL |
|
169 | + define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'templates' . DS); |
|
170 | + define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'templates' . DS); |
|
171 | + // define the gateway directory and URL |
|
172 | + define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'gateways' . DS); |
|
173 | + define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'gateways' . DS); |
|
174 | + // languages folder/path |
|
175 | + define('EE_LANGUAGES_SAFE_LOC', '..' . DS . 'uploads' . DS . 'espresso' . DS . 'languages' . DS); |
|
176 | + define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS); |
|
177 | + //check for dompdf fonts in uploads |
|
178 | + if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS)) { |
|
179 | + define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS); |
|
180 | + } |
|
181 | + //ajax constants |
|
182 | + define( |
|
183 | + 'EE_FRONT_AJAX', |
|
184 | + isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax']) ? true : false |
|
185 | + ); |
|
186 | + define( |
|
187 | + 'EE_ADMIN_AJAX', |
|
188 | + isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax']) ? true : false |
|
189 | + ); |
|
190 | + //just a handy constant occasionally needed for finding values representing infinity in the DB |
|
191 | + //you're better to use this than its straight value (currently -1) in case you ever |
|
192 | + //want to change its default value! or find when -1 means infinity |
|
193 | + define('EE_INF_IN_DB', -1); |
|
194 | + define('EE_INF', INF > (float)PHP_INT_MAX ? INF : PHP_INT_MAX); |
|
195 | + define('EE_DEBUG', false); |
|
196 | + /** |
|
197 | + * espresso_plugin_activation |
|
198 | + * adds a wp-option to indicate that EE has been activated via the WP admin plugins page |
|
199 | + */ |
|
200 | + function espresso_plugin_activation() |
|
201 | + { |
|
202 | + update_option('ee_espresso_activation', true); |
|
203 | + } |
|
204 | 204 | |
205 | - register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation'); |
|
206 | - /** |
|
207 | - * espresso_load_error_handling |
|
208 | - * this function loads EE's class for handling exceptions and errors |
|
209 | - */ |
|
210 | - function espresso_load_error_handling() |
|
211 | - { |
|
212 | - // load debugging tools |
|
213 | - if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) { |
|
214 | - require_once(EE_HELPERS . 'EEH_Debug_Tools.helper.php'); |
|
215 | - EEH_Debug_Tools::instance(); |
|
216 | - } |
|
217 | - // load error handling |
|
218 | - if (is_readable(EE_CORE . 'EE_Error.core.php')) { |
|
219 | - require_once(EE_CORE . 'EE_Error.core.php'); |
|
220 | - } else { |
|
221 | - wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso')); |
|
222 | - } |
|
223 | - } |
|
205 | + register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation'); |
|
206 | + /** |
|
207 | + * espresso_load_error_handling |
|
208 | + * this function loads EE's class for handling exceptions and errors |
|
209 | + */ |
|
210 | + function espresso_load_error_handling() |
|
211 | + { |
|
212 | + // load debugging tools |
|
213 | + if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) { |
|
214 | + require_once(EE_HELPERS . 'EEH_Debug_Tools.helper.php'); |
|
215 | + EEH_Debug_Tools::instance(); |
|
216 | + } |
|
217 | + // load error handling |
|
218 | + if (is_readable(EE_CORE . 'EE_Error.core.php')) { |
|
219 | + require_once(EE_CORE . 'EE_Error.core.php'); |
|
220 | + } else { |
|
221 | + wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso')); |
|
222 | + } |
|
223 | + } |
|
224 | 224 | |
225 | - /** |
|
226 | - * espresso_load_required |
|
227 | - * given a class name and path, this function will load that file or throw an exception |
|
228 | - * |
|
229 | - * @param string $classname |
|
230 | - * @param string $full_path_to_file |
|
231 | - * @throws EE_Error |
|
232 | - */ |
|
233 | - function espresso_load_required($classname, $full_path_to_file) |
|
234 | - { |
|
235 | - static $error_handling_loaded = false; |
|
236 | - if ( ! $error_handling_loaded) { |
|
237 | - espresso_load_error_handling(); |
|
238 | - $error_handling_loaded = true; |
|
239 | - } |
|
240 | - if (is_readable($full_path_to_file)) { |
|
241 | - require_once($full_path_to_file); |
|
242 | - } else { |
|
243 | - throw new EE_Error ( |
|
244 | - sprintf( |
|
245 | - esc_html__( |
|
246 | - 'The %s class file could not be located or is not readable due to file permissions.', |
|
247 | - 'event_espresso' |
|
248 | - ), |
|
249 | - $classname |
|
250 | - ) |
|
251 | - ); |
|
252 | - } |
|
253 | - } |
|
225 | + /** |
|
226 | + * espresso_load_required |
|
227 | + * given a class name and path, this function will load that file or throw an exception |
|
228 | + * |
|
229 | + * @param string $classname |
|
230 | + * @param string $full_path_to_file |
|
231 | + * @throws EE_Error |
|
232 | + */ |
|
233 | + function espresso_load_required($classname, $full_path_to_file) |
|
234 | + { |
|
235 | + static $error_handling_loaded = false; |
|
236 | + if ( ! $error_handling_loaded) { |
|
237 | + espresso_load_error_handling(); |
|
238 | + $error_handling_loaded = true; |
|
239 | + } |
|
240 | + if (is_readable($full_path_to_file)) { |
|
241 | + require_once($full_path_to_file); |
|
242 | + } else { |
|
243 | + throw new EE_Error ( |
|
244 | + sprintf( |
|
245 | + esc_html__( |
|
246 | + 'The %s class file could not be located or is not readable due to file permissions.', |
|
247 | + 'event_espresso' |
|
248 | + ), |
|
249 | + $classname |
|
250 | + ) |
|
251 | + ); |
|
252 | + } |
|
253 | + } |
|
254 | 254 | |
255 | - espresso_load_required('EEH_Base', EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php'); |
|
256 | - espresso_load_required('EEH_File', EE_CORE . 'helpers' . DS . 'EEH_File.helper.php'); |
|
257 | - espresso_load_required('EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php'); |
|
258 | - new EE_Bootstrap(); |
|
259 | - } |
|
255 | + espresso_load_required('EEH_Base', EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php'); |
|
256 | + espresso_load_required('EEH_File', EE_CORE . 'helpers' . DS . 'EEH_File.helper.php'); |
|
257 | + espresso_load_required('EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php'); |
|
258 | + new EE_Bootstrap(); |
|
259 | + } |
|
260 | 260 | } |
261 | 261 | if ( ! function_exists('espresso_deactivate_plugin')) { |
262 | - /** |
|
263 | - * deactivate_plugin |
|
264 | - * usage: espresso_deactivate_plugin( plugin_basename( __FILE__ )); |
|
265 | - * |
|
266 | - * @access public |
|
267 | - * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file |
|
268 | - * @return void |
|
269 | - */ |
|
270 | - function espresso_deactivate_plugin($plugin_basename = '') |
|
271 | - { |
|
272 | - if ( ! function_exists('deactivate_plugins')) { |
|
273 | - require_once(ABSPATH . 'wp-admin/includes/plugin.php'); |
|
274 | - } |
|
275 | - unset($_GET['activate'], $_REQUEST['activate']); |
|
276 | - deactivate_plugins($plugin_basename); |
|
277 | - } |
|
262 | + /** |
|
263 | + * deactivate_plugin |
|
264 | + * usage: espresso_deactivate_plugin( plugin_basename( __FILE__ )); |
|
265 | + * |
|
266 | + * @access public |
|
267 | + * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file |
|
268 | + * @return void |
|
269 | + */ |
|
270 | + function espresso_deactivate_plugin($plugin_basename = '') |
|
271 | + { |
|
272 | + if ( ! function_exists('deactivate_plugins')) { |
|
273 | + require_once(ABSPATH . 'wp-admin/includes/plugin.php'); |
|
274 | + } |
|
275 | + unset($_GET['activate'], $_REQUEST['activate']); |
|
276 | + deactivate_plugins($plugin_basename); |
|
277 | + } |
|
278 | 278 | } |
@@ -1,5 +1,5 @@ discard block |
||
1 | 1 | <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
2 | - exit('NO direct script access allowed'); |
|
2 | + exit('NO direct script access allowed'); |
|
3 | 3 | } |
4 | 4 | |
5 | 5 | /** |
@@ -17,2213 +17,2213 @@ discard block |
||
17 | 17 | class Messages_Admin_Page extends EE_Admin_Page |
18 | 18 | { |
19 | 19 | |
20 | - /** |
|
21 | - * @type EE_Message_Resource_Manager $_message_resource_manager |
|
22 | - */ |
|
23 | - protected $_message_resource_manager; |
|
24 | - |
|
25 | - /** |
|
26 | - * @type string $_active_message_type_name |
|
27 | - */ |
|
28 | - protected $_active_message_type_name = ''; |
|
29 | - |
|
30 | - /** |
|
31 | - * @type EE_messenger $_active_messenger |
|
32 | - */ |
|
33 | - protected $_active_messenger; |
|
34 | - protected $_activate_state; |
|
35 | - protected $_activate_meta_box_type; |
|
36 | - protected $_current_message_meta_box; |
|
37 | - protected $_current_message_meta_box_object; |
|
38 | - protected $_context_switcher; |
|
39 | - protected $_shortcodes = array(); |
|
40 | - protected $_active_messengers = array(); |
|
41 | - protected $_active_message_types = array(); |
|
42 | - |
|
43 | - /** |
|
44 | - * @var EE_Message_Template_Group $_message_template_group |
|
45 | - */ |
|
46 | - protected $_message_template_group; |
|
47 | - protected $_m_mt_settings = array(); |
|
48 | - |
|
49 | - |
|
50 | - /** |
|
51 | - * This is set via the _set_message_template_group method and holds whatever the template pack for the group is. |
|
52 | - * IF there is no group then it gets automatically set to the Default template pack. |
|
53 | - * |
|
54 | - * @since 4.5.0 |
|
55 | - * |
|
56 | - * @var EE_Messages_Template_Pack |
|
57 | - */ |
|
58 | - protected $_template_pack; |
|
59 | - |
|
60 | - |
|
61 | - /** |
|
62 | - * This is set via the _set_message_template_group method and holds whatever the template pack variation for the |
|
63 | - * group is. If there is no group then it automatically gets set to default. |
|
64 | - * |
|
65 | - * @since 4.5.0 |
|
66 | - * |
|
67 | - * @var string |
|
68 | - */ |
|
69 | - protected $_variation; |
|
70 | - |
|
71 | - |
|
72 | - /** |
|
73 | - * @param bool $routing |
|
74 | - */ |
|
75 | - public function __construct($routing = true) |
|
76 | - { |
|
77 | - //make sure messages autoloader is running |
|
78 | - EED_Messages::set_autoloaders(); |
|
79 | - parent::__construct($routing); |
|
80 | - } |
|
81 | - |
|
82 | - |
|
83 | - protected function _init_page_props() |
|
84 | - { |
|
85 | - $this->page_slug = EE_MSG_PG_SLUG; |
|
86 | - $this->page_label = __('Messages Settings', 'event_espresso'); |
|
87 | - $this->_admin_base_url = EE_MSG_ADMIN_URL; |
|
88 | - $this->_admin_base_path = EE_MSG_ADMIN; |
|
89 | - |
|
90 | - $this->_activate_state = isset($this->_req_data['activate_state']) ? (array)$this->_req_data['activate_state'] : array(); |
|
91 | - |
|
92 | - $this->_active_messenger = isset($this->_req_data['messenger']) ? $this->_req_data['messenger'] : null; |
|
93 | - $this->_load_message_resource_manager(); |
|
94 | - } |
|
95 | - |
|
96 | - |
|
97 | - /** |
|
98 | - * loads messenger objects into the $_active_messengers property (so we can access the needed methods) |
|
99 | - * |
|
100 | - * |
|
101 | - * @throws EE_Error |
|
102 | - */ |
|
103 | - protected function _load_message_resource_manager() |
|
104 | - { |
|
105 | - $this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager'); |
|
106 | - } |
|
107 | - |
|
108 | - |
|
109 | - /** |
|
110 | - * @deprecated 4.9.9.rc.014 |
|
111 | - * @return array |
|
112 | - */ |
|
113 | - public function get_messengers_for_list_table() |
|
114 | - { |
|
115 | - EE_Error::doing_it_wrong( |
|
116 | - __METHOD__, |
|
117 | - __('This method is no longer in use. There is no replacement for it. The method was used to generate a set of |
|
20 | + /** |
|
21 | + * @type EE_Message_Resource_Manager $_message_resource_manager |
|
22 | + */ |
|
23 | + protected $_message_resource_manager; |
|
24 | + |
|
25 | + /** |
|
26 | + * @type string $_active_message_type_name |
|
27 | + */ |
|
28 | + protected $_active_message_type_name = ''; |
|
29 | + |
|
30 | + /** |
|
31 | + * @type EE_messenger $_active_messenger |
|
32 | + */ |
|
33 | + protected $_active_messenger; |
|
34 | + protected $_activate_state; |
|
35 | + protected $_activate_meta_box_type; |
|
36 | + protected $_current_message_meta_box; |
|
37 | + protected $_current_message_meta_box_object; |
|
38 | + protected $_context_switcher; |
|
39 | + protected $_shortcodes = array(); |
|
40 | + protected $_active_messengers = array(); |
|
41 | + protected $_active_message_types = array(); |
|
42 | + |
|
43 | + /** |
|
44 | + * @var EE_Message_Template_Group $_message_template_group |
|
45 | + */ |
|
46 | + protected $_message_template_group; |
|
47 | + protected $_m_mt_settings = array(); |
|
48 | + |
|
49 | + |
|
50 | + /** |
|
51 | + * This is set via the _set_message_template_group method and holds whatever the template pack for the group is. |
|
52 | + * IF there is no group then it gets automatically set to the Default template pack. |
|
53 | + * |
|
54 | + * @since 4.5.0 |
|
55 | + * |
|
56 | + * @var EE_Messages_Template_Pack |
|
57 | + */ |
|
58 | + protected $_template_pack; |
|
59 | + |
|
60 | + |
|
61 | + /** |
|
62 | + * This is set via the _set_message_template_group method and holds whatever the template pack variation for the |
|
63 | + * group is. If there is no group then it automatically gets set to default. |
|
64 | + * |
|
65 | + * @since 4.5.0 |
|
66 | + * |
|
67 | + * @var string |
|
68 | + */ |
|
69 | + protected $_variation; |
|
70 | + |
|
71 | + |
|
72 | + /** |
|
73 | + * @param bool $routing |
|
74 | + */ |
|
75 | + public function __construct($routing = true) |
|
76 | + { |
|
77 | + //make sure messages autoloader is running |
|
78 | + EED_Messages::set_autoloaders(); |
|
79 | + parent::__construct($routing); |
|
80 | + } |
|
81 | + |
|
82 | + |
|
83 | + protected function _init_page_props() |
|
84 | + { |
|
85 | + $this->page_slug = EE_MSG_PG_SLUG; |
|
86 | + $this->page_label = __('Messages Settings', 'event_espresso'); |
|
87 | + $this->_admin_base_url = EE_MSG_ADMIN_URL; |
|
88 | + $this->_admin_base_path = EE_MSG_ADMIN; |
|
89 | + |
|
90 | + $this->_activate_state = isset($this->_req_data['activate_state']) ? (array)$this->_req_data['activate_state'] : array(); |
|
91 | + |
|
92 | + $this->_active_messenger = isset($this->_req_data['messenger']) ? $this->_req_data['messenger'] : null; |
|
93 | + $this->_load_message_resource_manager(); |
|
94 | + } |
|
95 | + |
|
96 | + |
|
97 | + /** |
|
98 | + * loads messenger objects into the $_active_messengers property (so we can access the needed methods) |
|
99 | + * |
|
100 | + * |
|
101 | + * @throws EE_Error |
|
102 | + */ |
|
103 | + protected function _load_message_resource_manager() |
|
104 | + { |
|
105 | + $this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager'); |
|
106 | + } |
|
107 | + |
|
108 | + |
|
109 | + /** |
|
110 | + * @deprecated 4.9.9.rc.014 |
|
111 | + * @return array |
|
112 | + */ |
|
113 | + public function get_messengers_for_list_table() |
|
114 | + { |
|
115 | + EE_Error::doing_it_wrong( |
|
116 | + __METHOD__, |
|
117 | + __('This method is no longer in use. There is no replacement for it. The method was used to generate a set of |
|
118 | 118 | values for use in creating a messenger filter dropdown which is now generated differently via |
119 | 119 | Messages_Admin_Page::get_messengers_select_input', 'event_espresso'), |
120 | - '4.9.9.rc.014' |
|
121 | - ); |
|
122 | - |
|
123 | - $m_values = array(); |
|
124 | - $active_messengers = EEM_Message::instance()->get_all(array('group_by' => 'MSG_messenger')); |
|
125 | - //setup messengers for selects |
|
126 | - $i = 1; |
|
127 | - foreach ($active_messengers as $active_messenger) { |
|
128 | - if ($active_messenger instanceof EE_Message) { |
|
129 | - $m_values[$i]['id'] = $active_messenger->messenger(); |
|
130 | - $m_values[$i]['text'] = ucwords($active_messenger->messenger_label()); |
|
131 | - $i++; |
|
132 | - } |
|
133 | - } |
|
134 | - |
|
135 | - return $m_values; |
|
136 | - } |
|
137 | - |
|
138 | - |
|
139 | - /** |
|
140 | - * @deprecated 4.9.9.rc.014 |
|
141 | - * @return array |
|
142 | - */ |
|
143 | - public function get_message_types_for_list_table() |
|
144 | - { |
|
145 | - EE_Error::doing_it_wrong( |
|
146 | - __METHOD__, |
|
147 | - __('This method is no longer in use. There is no replacement for it. The method was used to generate a set of |
|
120 | + '4.9.9.rc.014' |
|
121 | + ); |
|
122 | + |
|
123 | + $m_values = array(); |
|
124 | + $active_messengers = EEM_Message::instance()->get_all(array('group_by' => 'MSG_messenger')); |
|
125 | + //setup messengers for selects |
|
126 | + $i = 1; |
|
127 | + foreach ($active_messengers as $active_messenger) { |
|
128 | + if ($active_messenger instanceof EE_Message) { |
|
129 | + $m_values[$i]['id'] = $active_messenger->messenger(); |
|
130 | + $m_values[$i]['text'] = ucwords($active_messenger->messenger_label()); |
|
131 | + $i++; |
|
132 | + } |
|
133 | + } |
|
134 | + |
|
135 | + return $m_values; |
|
136 | + } |
|
137 | + |
|
138 | + |
|
139 | + /** |
|
140 | + * @deprecated 4.9.9.rc.014 |
|
141 | + * @return array |
|
142 | + */ |
|
143 | + public function get_message_types_for_list_table() |
|
144 | + { |
|
145 | + EE_Error::doing_it_wrong( |
|
146 | + __METHOD__, |
|
147 | + __('This method is no longer in use. There is no replacement for it. The method was used to generate a set of |
|
148 | 148 | values for use in creating a message type filter dropdown which is now generated differently via |
149 | 149 | Messages_Admin_Page::get_message_types_select_input', 'event_espresso'), |
150 | - '4.9.9.rc.014' |
|
151 | - ); |
|
152 | - |
|
153 | - $mt_values = array(); |
|
154 | - $active_messages = EEM_Message::instance()->get_all(array('group_by' => 'MSG_message_type')); |
|
155 | - $i = 1; |
|
156 | - foreach ($active_messages as $active_message) { |
|
157 | - if ($active_message instanceof EE_Message) { |
|
158 | - $mt_values[$i]['id'] = $active_message->message_type(); |
|
159 | - $mt_values[$i]['text'] = ucwords($active_message->message_type_label()); |
|
160 | - $i++; |
|
161 | - } |
|
162 | - } |
|
163 | - |
|
164 | - return $mt_values; |
|
165 | - } |
|
166 | - |
|
167 | - |
|
168 | - /** |
|
169 | - * @deprecated 4.9.9.rc.014 |
|
170 | - * @return array |
|
171 | - */ |
|
172 | - public function get_contexts_for_message_types_for_list_table() |
|
173 | - { |
|
174 | - EE_Error::doing_it_wrong( |
|
175 | - __METHOD__, |
|
176 | - __('This method is no longer in use. There is no replacement for it. The method was used to generate a set of |
|
150 | + '4.9.9.rc.014' |
|
151 | + ); |
|
152 | + |
|
153 | + $mt_values = array(); |
|
154 | + $active_messages = EEM_Message::instance()->get_all(array('group_by' => 'MSG_message_type')); |
|
155 | + $i = 1; |
|
156 | + foreach ($active_messages as $active_message) { |
|
157 | + if ($active_message instanceof EE_Message) { |
|
158 | + $mt_values[$i]['id'] = $active_message->message_type(); |
|
159 | + $mt_values[$i]['text'] = ucwords($active_message->message_type_label()); |
|
160 | + $i++; |
|
161 | + } |
|
162 | + } |
|
163 | + |
|
164 | + return $mt_values; |
|
165 | + } |
|
166 | + |
|
167 | + |
|
168 | + /** |
|
169 | + * @deprecated 4.9.9.rc.014 |
|
170 | + * @return array |
|
171 | + */ |
|
172 | + public function get_contexts_for_message_types_for_list_table() |
|
173 | + { |
|
174 | + EE_Error::doing_it_wrong( |
|
175 | + __METHOD__, |
|
176 | + __('This method is no longer in use. There is no replacement for it. The method was used to generate a set of |
|
177 | 177 | values for use in creating a message type context filter dropdown which is now generated differently via |
178 | 178 | Messages_Admin_Page::get_contexts_for_message_types_select_input', 'event_espresso'), |
179 | - '4.9.9.rc.014' |
|
180 | - ); |
|
181 | - |
|
182 | - $contexts = array(); |
|
183 | - $active_message_contexts = EEM_Message::instance()->get_all(array('group_by' => 'MSG_context')); |
|
184 | - foreach ($active_message_contexts as $active_message) { |
|
185 | - if ($active_message instanceof EE_Message) { |
|
186 | - $message_type = $active_message->message_type_object(); |
|
187 | - if ($message_type instanceof EE_message_type) { |
|
188 | - $message_type_contexts = $message_type->get_contexts(); |
|
189 | - foreach ($message_type_contexts as $context => $context_details) { |
|
190 | - $contexts[$context] = $context_details['label']; |
|
191 | - } |
|
192 | - } |
|
193 | - } |
|
194 | - } |
|
195 | - |
|
196 | - return $contexts; |
|
197 | - } |
|
198 | - |
|
199 | - |
|
200 | - /** |
|
201 | - * Generate select input with provided messenger options array. |
|
202 | - * |
|
203 | - * @param array $messenger_options Array of messengers indexed by messenger slug and values are the messenger |
|
204 | - * labels. |
|
205 | - * |
|
206 | - * @return string |
|
207 | - */ |
|
208 | - public function get_messengers_select_input($messenger_options) |
|
209 | - { |
|
210 | - //if empty or just one value then just return an empty string |
|
211 | - if (empty($messenger_options) |
|
212 | - || ! is_array($messenger_options) |
|
213 | - || count($messenger_options) === 1 |
|
214 | - ) { |
|
215 | - return ''; |
|
216 | - } |
|
217 | - //merge in default |
|
218 | - $messenger_options = array_merge( |
|
219 | - array('none_selected' => __('Show All Messengers', 'event_espresso')), |
|
220 | - $messenger_options |
|
221 | - ); |
|
222 | - $input = new EE_Select_Input( |
|
223 | - $messenger_options, |
|
224 | - array( |
|
225 | - 'html_name' => 'ee_messenger_filter_by', |
|
226 | - 'html_id' => 'ee_messenger_filter_by', |
|
227 | - 'html_class' => 'wide', |
|
228 | - 'default' => isset($this->_req_data['ee_messenger_filter_by']) |
|
229 | - ? sanitize_title($this->_req_data['ee_messenger_filter_by']) |
|
230 | - : 'none_selected' |
|
231 | - ) |
|
232 | - ); |
|
233 | - |
|
234 | - return $input->get_html_for_input(); |
|
235 | - } |
|
236 | - |
|
237 | - |
|
238 | - /** |
|
239 | - * Generate select input with provided message type options array. |
|
240 | - * |
|
241 | - * @param array $message_type_options Array of message types indexed by message type slug, and values are the |
|
242 | - * message type labels |
|
243 | - * |
|
244 | - * @return string |
|
245 | - */ |
|
246 | - public function get_message_types_select_input($message_type_options) |
|
247 | - { |
|
248 | - //if empty or count of options is 1 then just return an empty string |
|
249 | - if (empty($message_type_options) |
|
250 | - || ! is_array($message_type_options) |
|
251 | - || count($message_type_options) === 1 |
|
252 | - ) { |
|
253 | - return ''; |
|
254 | - } |
|
255 | - //merge in default |
|
256 | - $message_type_options = array_merge( |
|
257 | - array('none_selected' => __('Show All Message Types', 'event_espresso')), |
|
258 | - $message_type_options |
|
259 | - ); |
|
260 | - $input = new EE_Select_Input( |
|
261 | - $message_type_options, |
|
262 | - array( |
|
263 | - 'html_name' => 'ee_message_type_filter_by', |
|
264 | - 'html_id' => 'ee_message_type_filter_by', |
|
265 | - 'html_class' => 'wide', |
|
266 | - 'default' => isset($this->_req_data['ee_message_type_filter_by']) |
|
267 | - ? sanitize_title($this->_req_data['ee_message_type_filter_by']) |
|
268 | - : 'none_selected', |
|
269 | - ) |
|
270 | - ); |
|
271 | - |
|
272 | - return $input->get_html_for_input(); |
|
273 | - } |
|
274 | - |
|
275 | - |
|
276 | - /** |
|
277 | - * Generate select input with provide message type contexts array. |
|
278 | - * |
|
279 | - * @param array $context_options Array of message type contexts indexed by context slug, and values are the |
|
280 | - * context label. |
|
281 | - * |
|
282 | - * @return string |
|
283 | - */ |
|
284 | - public function get_contexts_for_message_types_select_input($context_options) |
|
285 | - { |
|
286 | - //if empty or count of options is one then just return empty string |
|
287 | - if (empty($context_options) |
|
288 | - || ! is_array($context_options) |
|
289 | - || count($context_options) === 1 |
|
290 | - ) { |
|
291 | - return ''; |
|
292 | - } |
|
293 | - //merge in default |
|
294 | - $context_options = array_merge( |
|
295 | - array('none_selected' => __('Show all Contexts', 'event_espresso')), |
|
296 | - $context_options |
|
297 | - ); |
|
298 | - $input = new EE_Select_Input( |
|
299 | - $context_options, |
|
300 | - array( |
|
301 | - 'html_name' => 'ee_context_filter_by', |
|
302 | - 'html_id' => 'ee_context_filter_by', |
|
303 | - 'html_class' => 'wide', |
|
304 | - 'default' => isset($this->_req_data['ee_context_filter_by']) |
|
305 | - ? sanitize_title($this->_req_data['ee_context_filter_by']) |
|
306 | - : 'none_selected', |
|
307 | - ) |
|
308 | - ); |
|
309 | - |
|
310 | - return $input->get_html_for_input(); |
|
311 | - } |
|
312 | - |
|
313 | - |
|
314 | - protected function _ajax_hooks() |
|
315 | - { |
|
316 | - add_action('wp_ajax_activate_messenger', array($this, 'activate_messenger_toggle')); |
|
317 | - add_action('wp_ajax_activate_mt', array($this, 'activate_mt_toggle')); |
|
318 | - add_action('wp_ajax_ee_msgs_save_settings', array($this, 'save_settings')); |
|
319 | - add_action('wp_ajax_ee_msgs_update_mt_form', array($this, 'update_mt_form')); |
|
320 | - add_action('wp_ajax_switch_template_pack', array($this, 'switch_template_pack')); |
|
321 | - } |
|
322 | - |
|
323 | - |
|
324 | - protected function _define_page_props() |
|
325 | - { |
|
326 | - $this->_admin_page_title = $this->page_label; |
|
327 | - $this->_labels = array( |
|
328 | - 'buttons' => array( |
|
329 | - 'add' => __('Add New Message Template', 'event_espresso'), |
|
330 | - 'edit' => __('Edit Message Template', 'event_espresso'), |
|
331 | - 'delete' => __('Delete Message Template', 'event_espresso') |
|
332 | - ), |
|
333 | - 'publishbox' => __('Update Actions', 'event_espresso') |
|
334 | - ); |
|
335 | - } |
|
336 | - |
|
337 | - |
|
338 | - /** |
|
339 | - * an array for storing key => value pairs of request actions and their corresponding methods |
|
340 | - * @access protected |
|
341 | - * @return void |
|
342 | - */ |
|
343 | - protected function _set_page_routes() |
|
344 | - { |
|
345 | - $grp_id = ! empty($this->_req_data['GRP_ID']) && ! is_array($this->_req_data['GRP_ID']) |
|
346 | - ? $this->_req_data['GRP_ID'] |
|
347 | - : 0; |
|
348 | - $grp_id = empty($grp_id) && ! empty($this->_req_data['id']) |
|
349 | - ? $this->_req_data['id'] |
|
350 | - : $grp_id; |
|
351 | - $msg_id = ! empty($this->_req_data['MSG_ID']) && ! is_array($this->_req_data['MSG_ID']) |
|
352 | - ? $this->_req_data['MSG_ID'] |
|
353 | - : 0; |
|
354 | - |
|
355 | - $this->_page_routes = array( |
|
356 | - 'default' => array( |
|
357 | - 'func' => '_message_queue_list_table', |
|
358 | - 'capability' => 'ee_read_global_messages' |
|
359 | - ), |
|
360 | - 'global_mtps' => array( |
|
361 | - 'func' => '_ee_default_messages_overview_list_table', |
|
362 | - 'capability' => 'ee_read_global_messages' |
|
363 | - ), |
|
364 | - 'custom_mtps' => array( |
|
365 | - 'func' => '_custom_mtps_preview', |
|
366 | - 'capability' => 'ee_read_messages' |
|
367 | - ), |
|
368 | - 'add_new_message_template' => array( |
|
369 | - 'func' => '_add_message_template', |
|
370 | - 'capability' => 'ee_edit_messages', |
|
371 | - 'noheader' => true |
|
372 | - ), |
|
373 | - 'edit_message_template' => array( |
|
374 | - 'func' => '_edit_message_template', |
|
375 | - 'capability' => 'ee_edit_message', |
|
376 | - 'obj_id' => $grp_id |
|
377 | - ), |
|
378 | - 'preview_message' => array( |
|
379 | - 'func' => '_preview_message', |
|
380 | - 'capability' => 'ee_read_message', |
|
381 | - 'obj_id' => $grp_id, |
|
382 | - 'noheader' => true, |
|
383 | - 'headers_sent_route' => 'display_preview_message' |
|
384 | - ), |
|
385 | - 'display_preview_message' => array( |
|
386 | - 'func' => '_display_preview_message', |
|
387 | - 'capability' => 'ee_read_message', |
|
388 | - 'obj_id' => $grp_id |
|
389 | - ), |
|
390 | - 'insert_message_template' => array( |
|
391 | - 'func' => '_insert_or_update_message_template', |
|
392 | - 'capability' => 'ee_edit_messages', |
|
393 | - 'args' => array('new_template' => true), |
|
394 | - 'noheader' => true |
|
395 | - ), |
|
396 | - 'update_message_template' => array( |
|
397 | - 'func' => '_insert_or_update_message_template', |
|
398 | - 'capability' => 'ee_edit_message', |
|
399 | - 'obj_id' => $grp_id, |
|
400 | - 'args' => array('new_template' => false), |
|
401 | - 'noheader' => true |
|
402 | - ), |
|
403 | - 'trash_message_template' => array( |
|
404 | - 'func' => '_trash_or_restore_message_template', |
|
405 | - 'capability' => 'ee_delete_message', |
|
406 | - 'obj_id' => $grp_id, |
|
407 | - 'args' => array('trash' => true, 'all' => true), |
|
408 | - 'noheader' => true |
|
409 | - ), |
|
410 | - 'trash_message_template_context' => array( |
|
411 | - 'func' => '_trash_or_restore_message_template', |
|
412 | - 'capability' => 'ee_delete_message', |
|
413 | - 'obj_id' => $grp_id, |
|
414 | - 'args' => array('trash' => true), |
|
415 | - 'noheader' => true |
|
416 | - ), |
|
417 | - 'restore_message_template' => array( |
|
418 | - 'func' => '_trash_or_restore_message_template', |
|
419 | - 'capability' => 'ee_delete_message', |
|
420 | - 'obj_id' => $grp_id, |
|
421 | - 'args' => array('trash' => false, 'all' => true), |
|
422 | - 'noheader' => true |
|
423 | - ), |
|
424 | - 'restore_message_template_context' => array( |
|
425 | - 'func' => '_trash_or_restore_message_template', |
|
426 | - 'capability' => 'ee_delete_message', |
|
427 | - 'obj_id' => $grp_id, |
|
428 | - 'args' => array('trash' => false), |
|
429 | - 'noheader' => true |
|
430 | - ), |
|
431 | - 'delete_message_template' => array( |
|
432 | - 'func' => '_delete_message_template', |
|
433 | - 'capability' => 'ee_delete_message', |
|
434 | - 'obj_id' => $grp_id, |
|
435 | - 'noheader' => true |
|
436 | - ), |
|
437 | - 'reset_to_default' => array( |
|
438 | - 'func' => '_reset_to_default_template', |
|
439 | - 'capability' => 'ee_edit_message', |
|
440 | - 'obj_id' => $grp_id, |
|
441 | - 'noheader' => true |
|
442 | - ), |
|
443 | - 'settings' => array( |
|
444 | - 'func' => '_settings', |
|
445 | - 'capability' => 'manage_options' |
|
446 | - ), |
|
447 | - 'update_global_settings' => array( |
|
448 | - 'func' => '_update_global_settings', |
|
449 | - 'capability' => 'manage_options', |
|
450 | - 'noheader' => true |
|
451 | - ), |
|
452 | - 'generate_now' => array( |
|
453 | - 'func' => '_generate_now', |
|
454 | - 'capability' => 'ee_send_message', |
|
455 | - 'noheader' => true |
|
456 | - ), |
|
457 | - 'generate_and_send_now' => array( |
|
458 | - 'func' => '_generate_and_send_now', |
|
459 | - 'capability' => 'ee_send_message', |
|
460 | - 'noheader' => true |
|
461 | - ), |
|
462 | - 'queue_for_resending' => array( |
|
463 | - 'func' => '_queue_for_resending', |
|
464 | - 'capability' => 'ee_send_message', |
|
465 | - 'noheader' => true |
|
466 | - ), |
|
467 | - 'send_now' => array( |
|
468 | - 'func' => '_send_now', |
|
469 | - 'capability' => 'ee_send_message', |
|
470 | - 'noheader' => true |
|
471 | - ), |
|
472 | - 'delete_ee_message' => array( |
|
473 | - 'func' => '_delete_ee_messages', |
|
474 | - 'capability' => 'ee_delete_message', |
|
475 | - 'noheader' => true |
|
476 | - ), |
|
477 | - 'delete_ee_messages' => array( |
|
478 | - 'func' => '_delete_ee_messages', |
|
479 | - 'capability' => 'ee_delete_messages', |
|
480 | - 'noheader' => true, |
|
481 | - 'obj_id' => $msg_id |
|
482 | - ) |
|
483 | - ); |
|
484 | - } |
|
485 | - |
|
486 | - |
|
487 | - protected function _set_page_config() |
|
488 | - { |
|
489 | - $this->_page_config = array( |
|
490 | - 'default' => array( |
|
491 | - 'nav' => array( |
|
492 | - 'label' => __('Message Activity', 'event_espresso'), |
|
493 | - 'order' => 10 |
|
494 | - ), |
|
495 | - 'list_table' => 'EE_Message_List_Table', |
|
496 | - // 'qtips' => array( 'EE_Message_List_Table_Tips' ), |
|
497 | - 'require_nonce' => false |
|
498 | - ), |
|
499 | - 'global_mtps' => array( |
|
500 | - 'nav' => array( |
|
501 | - 'label' => __('Default Message Templates', 'event_espresso'), |
|
502 | - 'order' => 20 |
|
503 | - ), |
|
504 | - 'list_table' => 'Messages_Template_List_Table', |
|
505 | - 'help_tabs' => array( |
|
506 | - 'messages_overview_help_tab' => array( |
|
507 | - 'title' => __('Messages Overview', 'event_espresso'), |
|
508 | - 'filename' => 'messages_overview' |
|
509 | - ), |
|
510 | - 'messages_overview_messages_table_column_headings_help_tab' => array( |
|
511 | - 'title' => __('Messages Table Column Headings', 'event_espresso'), |
|
512 | - 'filename' => 'messages_overview_table_column_headings' |
|
513 | - ), |
|
514 | - 'messages_overview_messages_filters_help_tab' => array( |
|
515 | - 'title' => __('Message Filters', 'event_espresso'), |
|
516 | - 'filename' => 'messages_overview_filters' |
|
517 | - ), |
|
518 | - 'messages_overview_messages_views_help_tab' => array( |
|
519 | - 'title' => __('Message Views', 'event_espresso'), |
|
520 | - 'filename' => 'messages_overview_views' |
|
521 | - ), |
|
522 | - 'message_overview_message_types_help_tab' => array( |
|
523 | - 'title' => __('Message Types', 'event_espresso'), |
|
524 | - 'filename' => 'messages_overview_types' |
|
525 | - ), |
|
526 | - 'messages_overview_messengers_help_tab' => array( |
|
527 | - 'title' => __('Messengers', 'event_espresso'), |
|
528 | - 'filename' => 'messages_overview_messengers', |
|
529 | - ), |
|
530 | - 'messages_overview_other_help_tab' => array( |
|
531 | - 'title' => __('Messages Other', 'event_espresso'), |
|
532 | - 'filename' => 'messages_overview_other', |
|
533 | - ), |
|
534 | - ), |
|
535 | - 'help_tour' => array('Messages_Overview_Help_Tour'), |
|
536 | - 'require_nonce' => false |
|
537 | - ), |
|
538 | - 'custom_mtps' => array( |
|
539 | - 'nav' => array( |
|
540 | - 'label' => __('Custom Message Templates', 'event_espresso'), |
|
541 | - 'order' => 30 |
|
542 | - ), |
|
543 | - 'help_tabs' => array(), |
|
544 | - 'help_tour' => array(), |
|
545 | - 'require_nonce' => false |
|
546 | - ), |
|
547 | - 'add_new_message_template' => array( |
|
548 | - 'nav' => array( |
|
549 | - 'label' => __('Add New Message Templates', 'event_espresso'), |
|
550 | - 'order' => 5, |
|
551 | - 'persistent' => false |
|
552 | - ), |
|
553 | - 'require_nonce' => false |
|
554 | - ), |
|
555 | - 'edit_message_template' => array( |
|
556 | - 'labels' => array( |
|
557 | - 'buttons' => array( |
|
558 | - 'reset' => __('Reset Templates'), |
|
559 | - ), |
|
560 | - 'publishbox' => __('Update Actions', 'event_espresso') |
|
561 | - ), |
|
562 | - 'nav' => array( |
|
563 | - 'label' => __('Edit Message Templates', 'event_espresso'), |
|
564 | - 'order' => 5, |
|
565 | - 'persistent' => false, |
|
566 | - 'url' => '' |
|
567 | - ), |
|
568 | - 'metaboxes' => array('_publish_post_box', '_register_edit_meta_boxes'), |
|
569 | - 'has_metaboxes' => true, |
|
570 | - 'help_tour' => array('Message_Templates_Edit_Help_Tour'), |
|
571 | - 'help_tabs' => array( |
|
572 | - 'edit_message_template' => array( |
|
573 | - 'title' => __('Message Template Editor', 'event_espresso'), |
|
574 | - 'callback' => 'edit_message_template_help_tab' |
|
575 | - ), |
|
576 | - 'message_templates_help_tab' => array( |
|
577 | - 'title' => __('Message Templates', 'event_espresso'), |
|
578 | - 'filename' => 'messages_templates' |
|
579 | - ), |
|
580 | - 'message_template_shortcodes' => array( |
|
581 | - 'title' => __('Message Shortcodes', 'event_espresso'), |
|
582 | - 'callback' => 'message_template_shortcodes_help_tab' |
|
583 | - ), |
|
584 | - 'message_preview_help_tab' => array( |
|
585 | - 'title' => __('Message Preview', 'event_espresso'), |
|
586 | - 'filename' => 'messages_preview' |
|
587 | - ), |
|
588 | - ), |
|
589 | - 'require_nonce' => false |
|
590 | - ), |
|
591 | - 'display_preview_message' => array( |
|
592 | - 'nav' => array( |
|
593 | - 'label' => __('Message Preview', 'event_espresso'), |
|
594 | - 'order' => 5, |
|
595 | - 'url' => '', |
|
596 | - 'persistent' => false |
|
597 | - ), |
|
598 | - 'help_tabs' => array( |
|
599 | - 'preview_message' => array( |
|
600 | - 'title' => __('About Previews', 'event_espresso'), |
|
601 | - 'callback' => 'preview_message_help_tab' |
|
602 | - ) |
|
603 | - ), |
|
604 | - 'require_nonce' => false |
|
605 | - ), |
|
606 | - 'settings' => array( |
|
607 | - 'nav' => array( |
|
608 | - 'label' => __('Settings', 'event_espresso'), |
|
609 | - 'order' => 40 |
|
610 | - ), |
|
611 | - 'metaboxes' => array('_messages_settings_metaboxes'), |
|
612 | - 'help_tabs' => array( |
|
613 | - 'messages_settings_help_tab' => array( |
|
614 | - 'title' => __('Messages Settings', 'event_espresso'), |
|
615 | - 'filename' => 'messages_settings' |
|
616 | - ), |
|
617 | - 'messages_settings_message_types_help_tab' => array( |
|
618 | - 'title' => __('Activating / Deactivating Message Types', 'event_espresso'), |
|
619 | - 'filename' => 'messages_settings_message_types' |
|
620 | - ), |
|
621 | - 'messages_settings_messengers_help_tab' => array( |
|
622 | - 'title' => __('Activating / Deactivating Messengers', 'event_espresso'), |
|
623 | - 'filename' => 'messages_settings_messengers' |
|
624 | - ), |
|
625 | - ), |
|
626 | - 'help_tour' => array('Messages_Settings_Help_Tour'), |
|
627 | - 'require_nonce' => false |
|
628 | - ) |
|
629 | - ); |
|
630 | - } |
|
631 | - |
|
632 | - |
|
633 | - protected function _add_screen_options() |
|
634 | - { |
|
635 | - //todo |
|
636 | - } |
|
637 | - |
|
638 | - |
|
639 | - protected function _add_screen_options_global_mtps() |
|
640 | - { |
|
641 | - /** |
|
642 | - * Note: the reason for the value swap here on $this->_admin_page_title is because $this->_per_page_screen_options |
|
643 | - * uses the $_admin_page_title property and we want different outputs in the different spots. |
|
644 | - */ |
|
645 | - $page_title = $this->_admin_page_title; |
|
646 | - $this->_admin_page_title = __('Global Message Templates', 'event_espresso'); |
|
647 | - $this->_per_page_screen_option(); |
|
648 | - $this->_admin_page_title = $page_title; |
|
649 | - } |
|
650 | - |
|
651 | - |
|
652 | - protected function _add_screen_options_default() |
|
653 | - { |
|
654 | - $this->_admin_page_title = __('Message Activity', 'event_espresso'); |
|
655 | - $this->_per_page_screen_option(); |
|
656 | - } |
|
657 | - |
|
658 | - |
|
659 | - //none of the below group are currently used for Messages |
|
660 | - protected function _add_feature_pointers() |
|
661 | - { |
|
662 | - } |
|
663 | - |
|
664 | - public function admin_init() |
|
665 | - { |
|
666 | - } |
|
667 | - |
|
668 | - public function admin_notices() |
|
669 | - { |
|
670 | - } |
|
671 | - |
|
672 | - public function admin_footer_scripts() |
|
673 | - { |
|
674 | - } |
|
675 | - |
|
676 | - |
|
677 | - public function messages_help_tab() |
|
678 | - { |
|
679 | - EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_help_tab.template.php'); |
|
680 | - } |
|
681 | - |
|
682 | - |
|
683 | - public function messengers_help_tab() |
|
684 | - { |
|
685 | - EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messenger_help_tab.template.php'); |
|
686 | - } |
|
687 | - |
|
688 | - |
|
689 | - public function message_types_help_tab() |
|
690 | - { |
|
691 | - EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_type_help_tab.template.php'); |
|
692 | - } |
|
693 | - |
|
694 | - |
|
695 | - public function messages_overview_help_tab() |
|
696 | - { |
|
697 | - EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_overview_help_tab.template.php'); |
|
698 | - } |
|
699 | - |
|
700 | - |
|
701 | - public function message_templates_help_tab() |
|
702 | - { |
|
703 | - EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_templates_help_tab.template.php'); |
|
704 | - } |
|
705 | - |
|
706 | - |
|
707 | - public function edit_message_template_help_tab() |
|
708 | - { |
|
709 | - $args['img1'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/editor.png' . '" alt="' . esc_attr__('Editor Title', |
|
710 | - 'event_espresso') . '" />'; |
|
711 | - $args['img2'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/switch-context.png' . '" alt="' . esc_attr__('Context Switcher and Preview', |
|
712 | - 'event_espresso') . '" />'; |
|
713 | - $args['img3'] = '<img class="left" src="' . EE_MSG_ASSETS_URL . 'images/form-fields.png' . '" alt="' . esc_attr__('Message Template Form Fields', |
|
714 | - 'event_espresso') . '" />'; |
|
715 | - $args['img4'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/shortcodes-metabox.png' . '" alt="' . esc_attr__('Shortcodes Metabox', |
|
716 | - 'event_espresso') . '" />'; |
|
717 | - $args['img5'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/publish-meta-box.png' . '" alt="' . esc_attr__('Publish Metabox', |
|
718 | - 'event_espresso') . '" />'; |
|
719 | - EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_templates_editor_help_tab.template.php', |
|
720 | - $args); |
|
721 | - } |
|
722 | - |
|
723 | - |
|
724 | - public function message_template_shortcodes_help_tab() |
|
725 | - { |
|
726 | - $this->_set_shortcodes(); |
|
727 | - $args['shortcodes'] = $this->_shortcodes; |
|
728 | - EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_shortcodes_help_tab.template.php', |
|
729 | - $args); |
|
730 | - } |
|
179 | + '4.9.9.rc.014' |
|
180 | + ); |
|
181 | + |
|
182 | + $contexts = array(); |
|
183 | + $active_message_contexts = EEM_Message::instance()->get_all(array('group_by' => 'MSG_context')); |
|
184 | + foreach ($active_message_contexts as $active_message) { |
|
185 | + if ($active_message instanceof EE_Message) { |
|
186 | + $message_type = $active_message->message_type_object(); |
|
187 | + if ($message_type instanceof EE_message_type) { |
|
188 | + $message_type_contexts = $message_type->get_contexts(); |
|
189 | + foreach ($message_type_contexts as $context => $context_details) { |
|
190 | + $contexts[$context] = $context_details['label']; |
|
191 | + } |
|
192 | + } |
|
193 | + } |
|
194 | + } |
|
195 | + |
|
196 | + return $contexts; |
|
197 | + } |
|
198 | + |
|
199 | + |
|
200 | + /** |
|
201 | + * Generate select input with provided messenger options array. |
|
202 | + * |
|
203 | + * @param array $messenger_options Array of messengers indexed by messenger slug and values are the messenger |
|
204 | + * labels. |
|
205 | + * |
|
206 | + * @return string |
|
207 | + */ |
|
208 | + public function get_messengers_select_input($messenger_options) |
|
209 | + { |
|
210 | + //if empty or just one value then just return an empty string |
|
211 | + if (empty($messenger_options) |
|
212 | + || ! is_array($messenger_options) |
|
213 | + || count($messenger_options) === 1 |
|
214 | + ) { |
|
215 | + return ''; |
|
216 | + } |
|
217 | + //merge in default |
|
218 | + $messenger_options = array_merge( |
|
219 | + array('none_selected' => __('Show All Messengers', 'event_espresso')), |
|
220 | + $messenger_options |
|
221 | + ); |
|
222 | + $input = new EE_Select_Input( |
|
223 | + $messenger_options, |
|
224 | + array( |
|
225 | + 'html_name' => 'ee_messenger_filter_by', |
|
226 | + 'html_id' => 'ee_messenger_filter_by', |
|
227 | + 'html_class' => 'wide', |
|
228 | + 'default' => isset($this->_req_data['ee_messenger_filter_by']) |
|
229 | + ? sanitize_title($this->_req_data['ee_messenger_filter_by']) |
|
230 | + : 'none_selected' |
|
231 | + ) |
|
232 | + ); |
|
233 | + |
|
234 | + return $input->get_html_for_input(); |
|
235 | + } |
|
236 | + |
|
237 | + |
|
238 | + /** |
|
239 | + * Generate select input with provided message type options array. |
|
240 | + * |
|
241 | + * @param array $message_type_options Array of message types indexed by message type slug, and values are the |
|
242 | + * message type labels |
|
243 | + * |
|
244 | + * @return string |
|
245 | + */ |
|
246 | + public function get_message_types_select_input($message_type_options) |
|
247 | + { |
|
248 | + //if empty or count of options is 1 then just return an empty string |
|
249 | + if (empty($message_type_options) |
|
250 | + || ! is_array($message_type_options) |
|
251 | + || count($message_type_options) === 1 |
|
252 | + ) { |
|
253 | + return ''; |
|
254 | + } |
|
255 | + //merge in default |
|
256 | + $message_type_options = array_merge( |
|
257 | + array('none_selected' => __('Show All Message Types', 'event_espresso')), |
|
258 | + $message_type_options |
|
259 | + ); |
|
260 | + $input = new EE_Select_Input( |
|
261 | + $message_type_options, |
|
262 | + array( |
|
263 | + 'html_name' => 'ee_message_type_filter_by', |
|
264 | + 'html_id' => 'ee_message_type_filter_by', |
|
265 | + 'html_class' => 'wide', |
|
266 | + 'default' => isset($this->_req_data['ee_message_type_filter_by']) |
|
267 | + ? sanitize_title($this->_req_data['ee_message_type_filter_by']) |
|
268 | + : 'none_selected', |
|
269 | + ) |
|
270 | + ); |
|
271 | + |
|
272 | + return $input->get_html_for_input(); |
|
273 | + } |
|
274 | + |
|
275 | + |
|
276 | + /** |
|
277 | + * Generate select input with provide message type contexts array. |
|
278 | + * |
|
279 | + * @param array $context_options Array of message type contexts indexed by context slug, and values are the |
|
280 | + * context label. |
|
281 | + * |
|
282 | + * @return string |
|
283 | + */ |
|
284 | + public function get_contexts_for_message_types_select_input($context_options) |
|
285 | + { |
|
286 | + //if empty or count of options is one then just return empty string |
|
287 | + if (empty($context_options) |
|
288 | + || ! is_array($context_options) |
|
289 | + || count($context_options) === 1 |
|
290 | + ) { |
|
291 | + return ''; |
|
292 | + } |
|
293 | + //merge in default |
|
294 | + $context_options = array_merge( |
|
295 | + array('none_selected' => __('Show all Contexts', 'event_espresso')), |
|
296 | + $context_options |
|
297 | + ); |
|
298 | + $input = new EE_Select_Input( |
|
299 | + $context_options, |
|
300 | + array( |
|
301 | + 'html_name' => 'ee_context_filter_by', |
|
302 | + 'html_id' => 'ee_context_filter_by', |
|
303 | + 'html_class' => 'wide', |
|
304 | + 'default' => isset($this->_req_data['ee_context_filter_by']) |
|
305 | + ? sanitize_title($this->_req_data['ee_context_filter_by']) |
|
306 | + : 'none_selected', |
|
307 | + ) |
|
308 | + ); |
|
309 | + |
|
310 | + return $input->get_html_for_input(); |
|
311 | + } |
|
312 | + |
|
313 | + |
|
314 | + protected function _ajax_hooks() |
|
315 | + { |
|
316 | + add_action('wp_ajax_activate_messenger', array($this, 'activate_messenger_toggle')); |
|
317 | + add_action('wp_ajax_activate_mt', array($this, 'activate_mt_toggle')); |
|
318 | + add_action('wp_ajax_ee_msgs_save_settings', array($this, 'save_settings')); |
|
319 | + add_action('wp_ajax_ee_msgs_update_mt_form', array($this, 'update_mt_form')); |
|
320 | + add_action('wp_ajax_switch_template_pack', array($this, 'switch_template_pack')); |
|
321 | + } |
|
322 | + |
|
323 | + |
|
324 | + protected function _define_page_props() |
|
325 | + { |
|
326 | + $this->_admin_page_title = $this->page_label; |
|
327 | + $this->_labels = array( |
|
328 | + 'buttons' => array( |
|
329 | + 'add' => __('Add New Message Template', 'event_espresso'), |
|
330 | + 'edit' => __('Edit Message Template', 'event_espresso'), |
|
331 | + 'delete' => __('Delete Message Template', 'event_espresso') |
|
332 | + ), |
|
333 | + 'publishbox' => __('Update Actions', 'event_espresso') |
|
334 | + ); |
|
335 | + } |
|
336 | + |
|
337 | + |
|
338 | + /** |
|
339 | + * an array for storing key => value pairs of request actions and their corresponding methods |
|
340 | + * @access protected |
|
341 | + * @return void |
|
342 | + */ |
|
343 | + protected function _set_page_routes() |
|
344 | + { |
|
345 | + $grp_id = ! empty($this->_req_data['GRP_ID']) && ! is_array($this->_req_data['GRP_ID']) |
|
346 | + ? $this->_req_data['GRP_ID'] |
|
347 | + : 0; |
|
348 | + $grp_id = empty($grp_id) && ! empty($this->_req_data['id']) |
|
349 | + ? $this->_req_data['id'] |
|
350 | + : $grp_id; |
|
351 | + $msg_id = ! empty($this->_req_data['MSG_ID']) && ! is_array($this->_req_data['MSG_ID']) |
|
352 | + ? $this->_req_data['MSG_ID'] |
|
353 | + : 0; |
|
354 | + |
|
355 | + $this->_page_routes = array( |
|
356 | + 'default' => array( |
|
357 | + 'func' => '_message_queue_list_table', |
|
358 | + 'capability' => 'ee_read_global_messages' |
|
359 | + ), |
|
360 | + 'global_mtps' => array( |
|
361 | + 'func' => '_ee_default_messages_overview_list_table', |
|
362 | + 'capability' => 'ee_read_global_messages' |
|
363 | + ), |
|
364 | + 'custom_mtps' => array( |
|
365 | + 'func' => '_custom_mtps_preview', |
|
366 | + 'capability' => 'ee_read_messages' |
|
367 | + ), |
|
368 | + 'add_new_message_template' => array( |
|
369 | + 'func' => '_add_message_template', |
|
370 | + 'capability' => 'ee_edit_messages', |
|
371 | + 'noheader' => true |
|
372 | + ), |
|
373 | + 'edit_message_template' => array( |
|
374 | + 'func' => '_edit_message_template', |
|
375 | + 'capability' => 'ee_edit_message', |
|
376 | + 'obj_id' => $grp_id |
|
377 | + ), |
|
378 | + 'preview_message' => array( |
|
379 | + 'func' => '_preview_message', |
|
380 | + 'capability' => 'ee_read_message', |
|
381 | + 'obj_id' => $grp_id, |
|
382 | + 'noheader' => true, |
|
383 | + 'headers_sent_route' => 'display_preview_message' |
|
384 | + ), |
|
385 | + 'display_preview_message' => array( |
|
386 | + 'func' => '_display_preview_message', |
|
387 | + 'capability' => 'ee_read_message', |
|
388 | + 'obj_id' => $grp_id |
|
389 | + ), |
|
390 | + 'insert_message_template' => array( |
|
391 | + 'func' => '_insert_or_update_message_template', |
|
392 | + 'capability' => 'ee_edit_messages', |
|
393 | + 'args' => array('new_template' => true), |
|
394 | + 'noheader' => true |
|
395 | + ), |
|
396 | + 'update_message_template' => array( |
|
397 | + 'func' => '_insert_or_update_message_template', |
|
398 | + 'capability' => 'ee_edit_message', |
|
399 | + 'obj_id' => $grp_id, |
|
400 | + 'args' => array('new_template' => false), |
|
401 | + 'noheader' => true |
|
402 | + ), |
|
403 | + 'trash_message_template' => array( |
|
404 | + 'func' => '_trash_or_restore_message_template', |
|
405 | + 'capability' => 'ee_delete_message', |
|
406 | + 'obj_id' => $grp_id, |
|
407 | + 'args' => array('trash' => true, 'all' => true), |
|
408 | + 'noheader' => true |
|
409 | + ), |
|
410 | + 'trash_message_template_context' => array( |
|
411 | + 'func' => '_trash_or_restore_message_template', |
|
412 | + 'capability' => 'ee_delete_message', |
|
413 | + 'obj_id' => $grp_id, |
|
414 | + 'args' => array('trash' => true), |
|
415 | + 'noheader' => true |
|
416 | + ), |
|
417 | + 'restore_message_template' => array( |
|
418 | + 'func' => '_trash_or_restore_message_template', |
|
419 | + 'capability' => 'ee_delete_message', |
|
420 | + 'obj_id' => $grp_id, |
|
421 | + 'args' => array('trash' => false, 'all' => true), |
|
422 | + 'noheader' => true |
|
423 | + ), |
|
424 | + 'restore_message_template_context' => array( |
|
425 | + 'func' => '_trash_or_restore_message_template', |
|
426 | + 'capability' => 'ee_delete_message', |
|
427 | + 'obj_id' => $grp_id, |
|
428 | + 'args' => array('trash' => false), |
|
429 | + 'noheader' => true |
|
430 | + ), |
|
431 | + 'delete_message_template' => array( |
|
432 | + 'func' => '_delete_message_template', |
|
433 | + 'capability' => 'ee_delete_message', |
|
434 | + 'obj_id' => $grp_id, |
|
435 | + 'noheader' => true |
|
436 | + ), |
|
437 | + 'reset_to_default' => array( |
|
438 | + 'func' => '_reset_to_default_template', |
|
439 | + 'capability' => 'ee_edit_message', |
|
440 | + 'obj_id' => $grp_id, |
|
441 | + 'noheader' => true |
|
442 | + ), |
|
443 | + 'settings' => array( |
|
444 | + 'func' => '_settings', |
|
445 | + 'capability' => 'manage_options' |
|
446 | + ), |
|
447 | + 'update_global_settings' => array( |
|
448 | + 'func' => '_update_global_settings', |
|
449 | + 'capability' => 'manage_options', |
|
450 | + 'noheader' => true |
|
451 | + ), |
|
452 | + 'generate_now' => array( |
|
453 | + 'func' => '_generate_now', |
|
454 | + 'capability' => 'ee_send_message', |
|
455 | + 'noheader' => true |
|
456 | + ), |
|
457 | + 'generate_and_send_now' => array( |
|
458 | + 'func' => '_generate_and_send_now', |
|
459 | + 'capability' => 'ee_send_message', |
|
460 | + 'noheader' => true |
|
461 | + ), |
|
462 | + 'queue_for_resending' => array( |
|
463 | + 'func' => '_queue_for_resending', |
|
464 | + 'capability' => 'ee_send_message', |
|
465 | + 'noheader' => true |
|
466 | + ), |
|
467 | + 'send_now' => array( |
|
468 | + 'func' => '_send_now', |
|
469 | + 'capability' => 'ee_send_message', |
|
470 | + 'noheader' => true |
|
471 | + ), |
|
472 | + 'delete_ee_message' => array( |
|
473 | + 'func' => '_delete_ee_messages', |
|
474 | + 'capability' => 'ee_delete_message', |
|
475 | + 'noheader' => true |
|
476 | + ), |
|
477 | + 'delete_ee_messages' => array( |
|
478 | + 'func' => '_delete_ee_messages', |
|
479 | + 'capability' => 'ee_delete_messages', |
|
480 | + 'noheader' => true, |
|
481 | + 'obj_id' => $msg_id |
|
482 | + ) |
|
483 | + ); |
|
484 | + } |
|
485 | + |
|
486 | + |
|
487 | + protected function _set_page_config() |
|
488 | + { |
|
489 | + $this->_page_config = array( |
|
490 | + 'default' => array( |
|
491 | + 'nav' => array( |
|
492 | + 'label' => __('Message Activity', 'event_espresso'), |
|
493 | + 'order' => 10 |
|
494 | + ), |
|
495 | + 'list_table' => 'EE_Message_List_Table', |
|
496 | + // 'qtips' => array( 'EE_Message_List_Table_Tips' ), |
|
497 | + 'require_nonce' => false |
|
498 | + ), |
|
499 | + 'global_mtps' => array( |
|
500 | + 'nav' => array( |
|
501 | + 'label' => __('Default Message Templates', 'event_espresso'), |
|
502 | + 'order' => 20 |
|
503 | + ), |
|
504 | + 'list_table' => 'Messages_Template_List_Table', |
|
505 | + 'help_tabs' => array( |
|
506 | + 'messages_overview_help_tab' => array( |
|
507 | + 'title' => __('Messages Overview', 'event_espresso'), |
|
508 | + 'filename' => 'messages_overview' |
|
509 | + ), |
|
510 | + 'messages_overview_messages_table_column_headings_help_tab' => array( |
|
511 | + 'title' => __('Messages Table Column Headings', 'event_espresso'), |
|
512 | + 'filename' => 'messages_overview_table_column_headings' |
|
513 | + ), |
|
514 | + 'messages_overview_messages_filters_help_tab' => array( |
|
515 | + 'title' => __('Message Filters', 'event_espresso'), |
|
516 | + 'filename' => 'messages_overview_filters' |
|
517 | + ), |
|
518 | + 'messages_overview_messages_views_help_tab' => array( |
|
519 | + 'title' => __('Message Views', 'event_espresso'), |
|
520 | + 'filename' => 'messages_overview_views' |
|
521 | + ), |
|
522 | + 'message_overview_message_types_help_tab' => array( |
|
523 | + 'title' => __('Message Types', 'event_espresso'), |
|
524 | + 'filename' => 'messages_overview_types' |
|
525 | + ), |
|
526 | + 'messages_overview_messengers_help_tab' => array( |
|
527 | + 'title' => __('Messengers', 'event_espresso'), |
|
528 | + 'filename' => 'messages_overview_messengers', |
|
529 | + ), |
|
530 | + 'messages_overview_other_help_tab' => array( |
|
531 | + 'title' => __('Messages Other', 'event_espresso'), |
|
532 | + 'filename' => 'messages_overview_other', |
|
533 | + ), |
|
534 | + ), |
|
535 | + 'help_tour' => array('Messages_Overview_Help_Tour'), |
|
536 | + 'require_nonce' => false |
|
537 | + ), |
|
538 | + 'custom_mtps' => array( |
|
539 | + 'nav' => array( |
|
540 | + 'label' => __('Custom Message Templates', 'event_espresso'), |
|
541 | + 'order' => 30 |
|
542 | + ), |
|
543 | + 'help_tabs' => array(), |
|
544 | + 'help_tour' => array(), |
|
545 | + 'require_nonce' => false |
|
546 | + ), |
|
547 | + 'add_new_message_template' => array( |
|
548 | + 'nav' => array( |
|
549 | + 'label' => __('Add New Message Templates', 'event_espresso'), |
|
550 | + 'order' => 5, |
|
551 | + 'persistent' => false |
|
552 | + ), |
|
553 | + 'require_nonce' => false |
|
554 | + ), |
|
555 | + 'edit_message_template' => array( |
|
556 | + 'labels' => array( |
|
557 | + 'buttons' => array( |
|
558 | + 'reset' => __('Reset Templates'), |
|
559 | + ), |
|
560 | + 'publishbox' => __('Update Actions', 'event_espresso') |
|
561 | + ), |
|
562 | + 'nav' => array( |
|
563 | + 'label' => __('Edit Message Templates', 'event_espresso'), |
|
564 | + 'order' => 5, |
|
565 | + 'persistent' => false, |
|
566 | + 'url' => '' |
|
567 | + ), |
|
568 | + 'metaboxes' => array('_publish_post_box', '_register_edit_meta_boxes'), |
|
569 | + 'has_metaboxes' => true, |
|
570 | + 'help_tour' => array('Message_Templates_Edit_Help_Tour'), |
|
571 | + 'help_tabs' => array( |
|
572 | + 'edit_message_template' => array( |
|
573 | + 'title' => __('Message Template Editor', 'event_espresso'), |
|
574 | + 'callback' => 'edit_message_template_help_tab' |
|
575 | + ), |
|
576 | + 'message_templates_help_tab' => array( |
|
577 | + 'title' => __('Message Templates', 'event_espresso'), |
|
578 | + 'filename' => 'messages_templates' |
|
579 | + ), |
|
580 | + 'message_template_shortcodes' => array( |
|
581 | + 'title' => __('Message Shortcodes', 'event_espresso'), |
|
582 | + 'callback' => 'message_template_shortcodes_help_tab' |
|
583 | + ), |
|
584 | + 'message_preview_help_tab' => array( |
|
585 | + 'title' => __('Message Preview', 'event_espresso'), |
|
586 | + 'filename' => 'messages_preview' |
|
587 | + ), |
|
588 | + ), |
|
589 | + 'require_nonce' => false |
|
590 | + ), |
|
591 | + 'display_preview_message' => array( |
|
592 | + 'nav' => array( |
|
593 | + 'label' => __('Message Preview', 'event_espresso'), |
|
594 | + 'order' => 5, |
|
595 | + 'url' => '', |
|
596 | + 'persistent' => false |
|
597 | + ), |
|
598 | + 'help_tabs' => array( |
|
599 | + 'preview_message' => array( |
|
600 | + 'title' => __('About Previews', 'event_espresso'), |
|
601 | + 'callback' => 'preview_message_help_tab' |
|
602 | + ) |
|
603 | + ), |
|
604 | + 'require_nonce' => false |
|
605 | + ), |
|
606 | + 'settings' => array( |
|
607 | + 'nav' => array( |
|
608 | + 'label' => __('Settings', 'event_espresso'), |
|
609 | + 'order' => 40 |
|
610 | + ), |
|
611 | + 'metaboxes' => array('_messages_settings_metaboxes'), |
|
612 | + 'help_tabs' => array( |
|
613 | + 'messages_settings_help_tab' => array( |
|
614 | + 'title' => __('Messages Settings', 'event_espresso'), |
|
615 | + 'filename' => 'messages_settings' |
|
616 | + ), |
|
617 | + 'messages_settings_message_types_help_tab' => array( |
|
618 | + 'title' => __('Activating / Deactivating Message Types', 'event_espresso'), |
|
619 | + 'filename' => 'messages_settings_message_types' |
|
620 | + ), |
|
621 | + 'messages_settings_messengers_help_tab' => array( |
|
622 | + 'title' => __('Activating / Deactivating Messengers', 'event_espresso'), |
|
623 | + 'filename' => 'messages_settings_messengers' |
|
624 | + ), |
|
625 | + ), |
|
626 | + 'help_tour' => array('Messages_Settings_Help_Tour'), |
|
627 | + 'require_nonce' => false |
|
628 | + ) |
|
629 | + ); |
|
630 | + } |
|
631 | + |
|
632 | + |
|
633 | + protected function _add_screen_options() |
|
634 | + { |
|
635 | + //todo |
|
636 | + } |
|
637 | + |
|
638 | + |
|
639 | + protected function _add_screen_options_global_mtps() |
|
640 | + { |
|
641 | + /** |
|
642 | + * Note: the reason for the value swap here on $this->_admin_page_title is because $this->_per_page_screen_options |
|
643 | + * uses the $_admin_page_title property and we want different outputs in the different spots. |
|
644 | + */ |
|
645 | + $page_title = $this->_admin_page_title; |
|
646 | + $this->_admin_page_title = __('Global Message Templates', 'event_espresso'); |
|
647 | + $this->_per_page_screen_option(); |
|
648 | + $this->_admin_page_title = $page_title; |
|
649 | + } |
|
650 | + |
|
651 | + |
|
652 | + protected function _add_screen_options_default() |
|
653 | + { |
|
654 | + $this->_admin_page_title = __('Message Activity', 'event_espresso'); |
|
655 | + $this->_per_page_screen_option(); |
|
656 | + } |
|
657 | + |
|
658 | + |
|
659 | + //none of the below group are currently used for Messages |
|
660 | + protected function _add_feature_pointers() |
|
661 | + { |
|
662 | + } |
|
663 | + |
|
664 | + public function admin_init() |
|
665 | + { |
|
666 | + } |
|
667 | + |
|
668 | + public function admin_notices() |
|
669 | + { |
|
670 | + } |
|
671 | + |
|
672 | + public function admin_footer_scripts() |
|
673 | + { |
|
674 | + } |
|
675 | + |
|
676 | + |
|
677 | + public function messages_help_tab() |
|
678 | + { |
|
679 | + EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_help_tab.template.php'); |
|
680 | + } |
|
681 | + |
|
682 | + |
|
683 | + public function messengers_help_tab() |
|
684 | + { |
|
685 | + EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messenger_help_tab.template.php'); |
|
686 | + } |
|
687 | + |
|
688 | + |
|
689 | + public function message_types_help_tab() |
|
690 | + { |
|
691 | + EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_type_help_tab.template.php'); |
|
692 | + } |
|
693 | + |
|
694 | + |
|
695 | + public function messages_overview_help_tab() |
|
696 | + { |
|
697 | + EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_overview_help_tab.template.php'); |
|
698 | + } |
|
699 | + |
|
700 | + |
|
701 | + public function message_templates_help_tab() |
|
702 | + { |
|
703 | + EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_message_templates_help_tab.template.php'); |
|
704 | + } |
|
705 | + |
|
706 | + |
|
707 | + public function edit_message_template_help_tab() |
|
708 | + { |
|
709 | + $args['img1'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/editor.png' . '" alt="' . esc_attr__('Editor Title', |
|
710 | + 'event_espresso') . '" />'; |
|
711 | + $args['img2'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/switch-context.png' . '" alt="' . esc_attr__('Context Switcher and Preview', |
|
712 | + 'event_espresso') . '" />'; |
|
713 | + $args['img3'] = '<img class="left" src="' . EE_MSG_ASSETS_URL . 'images/form-fields.png' . '" alt="' . esc_attr__('Message Template Form Fields', |
|
714 | + 'event_espresso') . '" />'; |
|
715 | + $args['img4'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/shortcodes-metabox.png' . '" alt="' . esc_attr__('Shortcodes Metabox', |
|
716 | + 'event_espresso') . '" />'; |
|
717 | + $args['img5'] = '<img class="right" src="' . EE_MSG_ASSETS_URL . 'images/publish-meta-box.png' . '" alt="' . esc_attr__('Publish Metabox', |
|
718 | + 'event_espresso') . '" />'; |
|
719 | + EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_templates_editor_help_tab.template.php', |
|
720 | + $args); |
|
721 | + } |
|
722 | + |
|
723 | + |
|
724 | + public function message_template_shortcodes_help_tab() |
|
725 | + { |
|
726 | + $this->_set_shortcodes(); |
|
727 | + $args['shortcodes'] = $this->_shortcodes; |
|
728 | + EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_shortcodes_help_tab.template.php', |
|
729 | + $args); |
|
730 | + } |
|
731 | 731 | |
732 | 732 | |
733 | - public function preview_message_help_tab() |
|
734 | - { |
|
735 | - EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_preview_help_tab.template.php'); |
|
736 | - } |
|
733 | + public function preview_message_help_tab() |
|
734 | + { |
|
735 | + EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_preview_help_tab.template.php'); |
|
736 | + } |
|
737 | 737 | |
738 | - |
|
739 | - public function settings_help_tab() |
|
740 | - { |
|
741 | - $args['img1'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-active.png' . '" alt="' . esc_attr__('Active Email Tab', |
|
742 | - 'event_espresso') . '" />'; |
|
743 | - $args['img2'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-inactive.png' . '" alt="' . esc_attr__('Inactive Email Tab', |
|
744 | - 'event_espresso') . '" />'; |
|
745 | - $args['img3'] = '<div class="switch"><input id="ee-on-off-toggle-on" class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox" checked="checked"><label for="ee-on-off-toggle-on"></label>'; |
|
746 | - $args['img4'] = '<div class="switch"><input id="ee-on-off-toggle-on" class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox"><label for="ee-on-off-toggle-on"></label>'; |
|
747 | - EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_settings_help_tab.template.php', $args); |
|
748 | - } |
|
738 | + |
|
739 | + public function settings_help_tab() |
|
740 | + { |
|
741 | + $args['img1'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-active.png' . '" alt="' . esc_attr__('Active Email Tab', |
|
742 | + 'event_espresso') . '" />'; |
|
743 | + $args['img2'] = '<img class="inline-text" src="' . EE_MSG_ASSETS_URL . 'images/email-tab-inactive.png' . '" alt="' . esc_attr__('Inactive Email Tab', |
|
744 | + 'event_espresso') . '" />'; |
|
745 | + $args['img3'] = '<div class="switch"><input id="ee-on-off-toggle-on" class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox" checked="checked"><label for="ee-on-off-toggle-on"></label>'; |
|
746 | + $args['img4'] = '<div class="switch"><input id="ee-on-off-toggle-on" class="ee-on-off-toggle ee-toggle-round-flat" type="checkbox"><label for="ee-on-off-toggle-on"></label>'; |
|
747 | + EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'ee_msg_messages_settings_help_tab.template.php', $args); |
|
748 | + } |
|
749 | 749 | |
750 | 750 | |
751 | - public function load_scripts_styles() |
|
752 | - { |
|
753 | - wp_register_style('espresso_ee_msg', EE_MSG_ASSETS_URL . 'ee_message_admin.css', EVENT_ESPRESSO_VERSION); |
|
754 | - wp_enqueue_style('espresso_ee_msg'); |
|
751 | + public function load_scripts_styles() |
|
752 | + { |
|
753 | + wp_register_style('espresso_ee_msg', EE_MSG_ASSETS_URL . 'ee_message_admin.css', EVENT_ESPRESSO_VERSION); |
|
754 | + wp_enqueue_style('espresso_ee_msg'); |
|
755 | 755 | |
756 | - wp_register_script('ee-messages-settings', EE_MSG_ASSETS_URL . 'ee-messages-settings.js', |
|
757 | - array('jquery-ui-droppable', 'ee-serialize-full-array'), EVENT_ESPRESSO_VERSION, true); |
|
758 | - wp_register_script('ee-msg-list-table-js', EE_MSG_ASSETS_URL . 'ee_message_admin_list_table.js', |
|
759 | - array('ee-dialog'), EVENT_ESPRESSO_VERSION); |
|
760 | - } |
|
756 | + wp_register_script('ee-messages-settings', EE_MSG_ASSETS_URL . 'ee-messages-settings.js', |
|
757 | + array('jquery-ui-droppable', 'ee-serialize-full-array'), EVENT_ESPRESSO_VERSION, true); |
|
758 | + wp_register_script('ee-msg-list-table-js', EE_MSG_ASSETS_URL . 'ee_message_admin_list_table.js', |
|
759 | + array('ee-dialog'), EVENT_ESPRESSO_VERSION); |
|
760 | + } |
|
761 | 761 | |
762 | 762 | |
763 | - public function load_scripts_styles_default() |
|
764 | - { |
|
765 | - wp_enqueue_script('ee-msg-list-table-js'); |
|
766 | - } |
|
763 | + public function load_scripts_styles_default() |
|
764 | + { |
|
765 | + wp_enqueue_script('ee-msg-list-table-js'); |
|
766 | + } |
|
767 | 767 | |
768 | 768 | |
769 | - public function wp_editor_css($mce_css) |
|
770 | - { |
|
771 | - //if we're on the edit_message_template route |
|
772 | - if ($this->_req_action == 'edit_message_template' && $this->_active_messenger instanceof EE_messenger) { |
|
773 | - $message_type_name = $this->_active_message_type_name; |
|
769 | + public function wp_editor_css($mce_css) |
|
770 | + { |
|
771 | + //if we're on the edit_message_template route |
|
772 | + if ($this->_req_action == 'edit_message_template' && $this->_active_messenger instanceof EE_messenger) { |
|
773 | + $message_type_name = $this->_active_message_type_name; |
|
774 | 774 | |
775 | - //we're going to REPLACE the existing mce css |
|
776 | - //we need to get the css file location from the active messenger |
|
777 | - $mce_css = $this->_active_messenger->get_variation($this->_template_pack, $message_type_name, true, |
|
778 | - 'wpeditor', $this->_variation); |
|
779 | - } |
|
775 | + //we're going to REPLACE the existing mce css |
|
776 | + //we need to get the css file location from the active messenger |
|
777 | + $mce_css = $this->_active_messenger->get_variation($this->_template_pack, $message_type_name, true, |
|
778 | + 'wpeditor', $this->_variation); |
|
779 | + } |
|
780 | 780 | |
781 | - return $mce_css; |
|
782 | - } |
|
783 | - |
|
784 | - |
|
785 | - public function load_scripts_styles_edit_message_template() |
|
786 | - { |
|
787 | - |
|
788 | - $this->_set_shortcodes(); |
|
781 | + return $mce_css; |
|
782 | + } |
|
783 | + |
|
784 | + |
|
785 | + public function load_scripts_styles_edit_message_template() |
|
786 | + { |
|
787 | + |
|
788 | + $this->_set_shortcodes(); |
|
789 | 789 | |
790 | - EE_Registry::$i18n_js_strings['confirm_default_reset'] = sprintf( |
|
791 | - __('Are you sure you want to reset the %s %s message templates? Remember continuing will reset the templates for all contexts in this messenger and message type group.', |
|
792 | - 'event_espresso'), |
|
793 | - $this->_message_template_group->messenger_obj()->label['singular'], |
|
794 | - $this->_message_template_group->message_type_obj()->label['singular'] |
|
795 | - ); |
|
796 | - EE_Registry::$i18n_js_strings['confirm_switch_template_pack'] = __('Switching the template pack for a messages template will reset the content for the template so the new layout is loaded. Any custom content in the existing template will be lost. Are you sure you wish to do this?', |
|
797 | - 'event_espresso'); |
|
798 | - |
|
799 | - wp_register_script('ee_msgs_edit_js', EE_MSG_ASSETS_URL . 'ee_message_editor.js', array('jquery'), |
|
800 | - EVENT_ESPRESSO_VERSION); |
|
801 | - |
|
802 | - wp_enqueue_script('ee_admin_js'); |
|
803 | - wp_enqueue_script('ee_msgs_edit_js'); |
|
804 | - |
|
805 | - //add in special css for tiny_mce |
|
806 | - add_filter('mce_css', array($this, 'wp_editor_css')); |
|
807 | - } |
|
808 | - |
|
809 | - |
|
810 | - public function load_scripts_styles_display_preview_message() |
|
811 | - { |
|
812 | - |
|
813 | - $this->_set_message_template_group(); |
|
814 | - |
|
815 | - if (isset($this->_req_data['messenger'])) { |
|
816 | - $this->_active_messenger = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']); |
|
817 | - } |
|
818 | - |
|
819 | - $message_type_name = isset($this->_req_data['message_type']) ? $this->_req_data['message_type'] : ''; |
|
820 | - |
|
821 | - |
|
822 | - wp_enqueue_style('espresso_preview_css', |
|
823 | - $this->_active_messenger->get_variation($this->_template_pack, $message_type_name, true, 'preview', |
|
824 | - $this->_variation)); |
|
825 | - } |
|
826 | - |
|
827 | - |
|
828 | - public function load_scripts_styles_settings() |
|
829 | - { |
|
830 | - wp_register_style('ee-message-settings', EE_MSG_ASSETS_URL . 'ee_message_settings.css', array(), |
|
831 | - EVENT_ESPRESSO_VERSION); |
|
832 | - wp_enqueue_style('ee-text-links'); |
|
833 | - wp_enqueue_style('ee-message-settings'); |
|
834 | - |
|
835 | - wp_enqueue_script('ee-messages-settings'); |
|
836 | - } |
|
837 | - |
|
838 | - |
|
839 | - /** |
|
840 | - * set views array for List Table |
|
841 | - */ |
|
842 | - public function _set_list_table_views_global_mtps() |
|
843 | - { |
|
844 | - $this->_views = array( |
|
845 | - 'in_use' => array( |
|
846 | - 'slug' => 'in_use', |
|
847 | - 'label' => __('In Use', 'event_espresso'), |
|
848 | - 'count' => 0, |
|
849 | - 'bulk_action' => array( |
|
850 | - 'trash_message_template' => __('Move to Trash', 'event_espresso') |
|
851 | - ) |
|
852 | - ) |
|
853 | - ); |
|
854 | - } |
|
855 | - |
|
856 | - |
|
857 | - /** |
|
858 | - * set views array for message queue list table |
|
859 | - */ |
|
860 | - public function _set_list_table_views_default() |
|
861 | - { |
|
862 | - EE_Registry::instance()->load_helper('Template'); |
|
863 | - |
|
864 | - $common_bulk_actions = EE_Registry::instance()->CAP->current_user_can('ee_send_message', |
|
865 | - 'message_list_table_bulk_actions') |
|
866 | - ? array( |
|
867 | - 'generate_now' => __('Generate Now', 'event_espresso'), |
|
868 | - 'generate_and_send_now' => __('Generate and Send Now', 'event_espresso'), |
|
869 | - 'queue_for_resending' => __('Queue for Resending', 'event_espresso'), |
|
870 | - 'send_now' => __('Send Now', 'event_espresso') |
|
871 | - ) |
|
872 | - : array(); |
|
873 | - |
|
874 | - $delete_bulk_action = EE_Registry::instance()->CAP->current_user_can('ee_delete_messages', |
|
875 | - 'message_list_table_bulk_actions') |
|
876 | - ? array('delete_ee_messages' => __('Delete Messages', 'event_espresso')) |
|
877 | - : array(); |
|
878 | - |
|
879 | - |
|
880 | - $this->_views = array( |
|
881 | - 'all' => array( |
|
882 | - 'slug' => 'all', |
|
883 | - 'label' => __('All', 'event_espresso'), |
|
884 | - 'count' => 0, |
|
885 | - 'bulk_action' => array_merge($common_bulk_actions, $delete_bulk_action) |
|
886 | - ) |
|
887 | - ); |
|
888 | - |
|
889 | - |
|
890 | - foreach (EEM_Message::instance()->all_statuses() as $status) { |
|
891 | - if ($status === EEM_Message::status_debug_only && ! EEM_Message::debug()) { |
|
892 | - continue; |
|
893 | - } |
|
894 | - $status_bulk_actions = $common_bulk_actions; |
|
895 | - //unset bulk actions not applying to status |
|
896 | - if (! empty($status_bulk_actions)) { |
|
897 | - switch ($status) { |
|
898 | - case EEM_Message::status_idle: |
|
899 | - case EEM_Message::status_resend: |
|
900 | - $status_bulk_actions['send_now'] = $common_bulk_actions['send_now']; |
|
901 | - break; |
|
790 | + EE_Registry::$i18n_js_strings['confirm_default_reset'] = sprintf( |
|
791 | + __('Are you sure you want to reset the %s %s message templates? Remember continuing will reset the templates for all contexts in this messenger and message type group.', |
|
792 | + 'event_espresso'), |
|
793 | + $this->_message_template_group->messenger_obj()->label['singular'], |
|
794 | + $this->_message_template_group->message_type_obj()->label['singular'] |
|
795 | + ); |
|
796 | + EE_Registry::$i18n_js_strings['confirm_switch_template_pack'] = __('Switching the template pack for a messages template will reset the content for the template so the new layout is loaded. Any custom content in the existing template will be lost. Are you sure you wish to do this?', |
|
797 | + 'event_espresso'); |
|
798 | + |
|
799 | + wp_register_script('ee_msgs_edit_js', EE_MSG_ASSETS_URL . 'ee_message_editor.js', array('jquery'), |
|
800 | + EVENT_ESPRESSO_VERSION); |
|
801 | + |
|
802 | + wp_enqueue_script('ee_admin_js'); |
|
803 | + wp_enqueue_script('ee_msgs_edit_js'); |
|
804 | + |
|
805 | + //add in special css for tiny_mce |
|
806 | + add_filter('mce_css', array($this, 'wp_editor_css')); |
|
807 | + } |
|
808 | + |
|
809 | + |
|
810 | + public function load_scripts_styles_display_preview_message() |
|
811 | + { |
|
812 | + |
|
813 | + $this->_set_message_template_group(); |
|
814 | + |
|
815 | + if (isset($this->_req_data['messenger'])) { |
|
816 | + $this->_active_messenger = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']); |
|
817 | + } |
|
818 | + |
|
819 | + $message_type_name = isset($this->_req_data['message_type']) ? $this->_req_data['message_type'] : ''; |
|
820 | + |
|
821 | + |
|
822 | + wp_enqueue_style('espresso_preview_css', |
|
823 | + $this->_active_messenger->get_variation($this->_template_pack, $message_type_name, true, 'preview', |
|
824 | + $this->_variation)); |
|
825 | + } |
|
826 | + |
|
827 | + |
|
828 | + public function load_scripts_styles_settings() |
|
829 | + { |
|
830 | + wp_register_style('ee-message-settings', EE_MSG_ASSETS_URL . 'ee_message_settings.css', array(), |
|
831 | + EVENT_ESPRESSO_VERSION); |
|
832 | + wp_enqueue_style('ee-text-links'); |
|
833 | + wp_enqueue_style('ee-message-settings'); |
|
834 | + |
|
835 | + wp_enqueue_script('ee-messages-settings'); |
|
836 | + } |
|
837 | + |
|
838 | + |
|
839 | + /** |
|
840 | + * set views array for List Table |
|
841 | + */ |
|
842 | + public function _set_list_table_views_global_mtps() |
|
843 | + { |
|
844 | + $this->_views = array( |
|
845 | + 'in_use' => array( |
|
846 | + 'slug' => 'in_use', |
|
847 | + 'label' => __('In Use', 'event_espresso'), |
|
848 | + 'count' => 0, |
|
849 | + 'bulk_action' => array( |
|
850 | + 'trash_message_template' => __('Move to Trash', 'event_espresso') |
|
851 | + ) |
|
852 | + ) |
|
853 | + ); |
|
854 | + } |
|
855 | + |
|
856 | + |
|
857 | + /** |
|
858 | + * set views array for message queue list table |
|
859 | + */ |
|
860 | + public function _set_list_table_views_default() |
|
861 | + { |
|
862 | + EE_Registry::instance()->load_helper('Template'); |
|
863 | + |
|
864 | + $common_bulk_actions = EE_Registry::instance()->CAP->current_user_can('ee_send_message', |
|
865 | + 'message_list_table_bulk_actions') |
|
866 | + ? array( |
|
867 | + 'generate_now' => __('Generate Now', 'event_espresso'), |
|
868 | + 'generate_and_send_now' => __('Generate and Send Now', 'event_espresso'), |
|
869 | + 'queue_for_resending' => __('Queue for Resending', 'event_espresso'), |
|
870 | + 'send_now' => __('Send Now', 'event_espresso') |
|
871 | + ) |
|
872 | + : array(); |
|
873 | + |
|
874 | + $delete_bulk_action = EE_Registry::instance()->CAP->current_user_can('ee_delete_messages', |
|
875 | + 'message_list_table_bulk_actions') |
|
876 | + ? array('delete_ee_messages' => __('Delete Messages', 'event_espresso')) |
|
877 | + : array(); |
|
878 | + |
|
879 | + |
|
880 | + $this->_views = array( |
|
881 | + 'all' => array( |
|
882 | + 'slug' => 'all', |
|
883 | + 'label' => __('All', 'event_espresso'), |
|
884 | + 'count' => 0, |
|
885 | + 'bulk_action' => array_merge($common_bulk_actions, $delete_bulk_action) |
|
886 | + ) |
|
887 | + ); |
|
888 | + |
|
889 | + |
|
890 | + foreach (EEM_Message::instance()->all_statuses() as $status) { |
|
891 | + if ($status === EEM_Message::status_debug_only && ! EEM_Message::debug()) { |
|
892 | + continue; |
|
893 | + } |
|
894 | + $status_bulk_actions = $common_bulk_actions; |
|
895 | + //unset bulk actions not applying to status |
|
896 | + if (! empty($status_bulk_actions)) { |
|
897 | + switch ($status) { |
|
898 | + case EEM_Message::status_idle: |
|
899 | + case EEM_Message::status_resend: |
|
900 | + $status_bulk_actions['send_now'] = $common_bulk_actions['send_now']; |
|
901 | + break; |
|
902 | 902 | |
903 | - case EEM_Message::status_failed: |
|
904 | - case EEM_Message::status_debug_only: |
|
905 | - case EEM_Message::status_messenger_executing: |
|
906 | - $status_bulk_actions = array(); |
|
907 | - break; |
|
903 | + case EEM_Message::status_failed: |
|
904 | + case EEM_Message::status_debug_only: |
|
905 | + case EEM_Message::status_messenger_executing: |
|
906 | + $status_bulk_actions = array(); |
|
907 | + break; |
|
908 | 908 | |
909 | - case EEM_Message::status_incomplete: |
|
910 | - unset($status_bulk_actions['queue_for_resending'], $status_bulk_actions['send_now']); |
|
911 | - break; |
|
909 | + case EEM_Message::status_incomplete: |
|
910 | + unset($status_bulk_actions['queue_for_resending'], $status_bulk_actions['send_now']); |
|
911 | + break; |
|
912 | 912 | |
913 | - case EEM_Message::status_retry: |
|
914 | - case EEM_Message::status_sent: |
|
915 | - unset($status_bulk_actions['generate_now'], $status_bulk_actions['generate_and_send_now']); |
|
916 | - break; |
|
917 | - } |
|
918 | - } |
|
913 | + case EEM_Message::status_retry: |
|
914 | + case EEM_Message::status_sent: |
|
915 | + unset($status_bulk_actions['generate_now'], $status_bulk_actions['generate_and_send_now']); |
|
916 | + break; |
|
917 | + } |
|
918 | + } |
|
919 | 919 | |
920 | - //skip adding messenger executing status to views because it will be included with the Failed view. |
|
921 | - if ( $status === EEM_Message::status_messenger_executing ) { |
|
922 | - continue; |
|
923 | - } |
|
920 | + //skip adding messenger executing status to views because it will be included with the Failed view. |
|
921 | + if ( $status === EEM_Message::status_messenger_executing ) { |
|
922 | + continue; |
|
923 | + } |
|
924 | 924 | |
925 | - $this->_views[strtolower($status)] = array( |
|
926 | - 'slug' => strtolower($status), |
|
927 | - 'label' => EEH_Template::pretty_status($status, false, 'sentence'), |
|
928 | - 'count' => 0, |
|
929 | - 'bulk_action' => array_merge($status_bulk_actions, $delete_bulk_action) |
|
930 | - ); |
|
931 | - } |
|
932 | - } |
|
933 | - |
|
934 | - |
|
935 | - protected function _ee_default_messages_overview_list_table() |
|
936 | - { |
|
937 | - $this->_admin_page_title = __('Default Message Templates', 'event_espresso'); |
|
938 | - $this->display_admin_list_table_page_with_no_sidebar(); |
|
939 | - } |
|
940 | - |
|
941 | - |
|
942 | - protected function _message_queue_list_table() |
|
943 | - { |
|
944 | - $this->_search_btn_label = __('Message Activity', 'event_espresso'); |
|
945 | - $this->_template_args['per_column'] = 6; |
|
946 | - $this->_template_args['after_list_table'] = $this->_display_legend($this->_message_legend_items()); |
|
947 | - $this->_template_args['before_list_table'] = '<h3>' . EEM_Message::instance()->get_pretty_label_for_results() . '</h3>'; |
|
948 | - $this->display_admin_list_table_page_with_no_sidebar(); |
|
949 | - } |
|
950 | - |
|
951 | - |
|
952 | - protected function _message_legend_items() |
|
953 | - { |
|
954 | - |
|
955 | - $action_css_classes = EEH_MSG_Template::get_message_action_icons(); |
|
956 | - $action_items = array(); |
|
957 | - |
|
958 | - foreach ($action_css_classes as $action_item => $action_details) { |
|
959 | - if ($action_item === 'see_notifications_for') { |
|
960 | - continue; |
|
961 | - } |
|
962 | - $action_items[$action_item] = array( |
|
963 | - 'class' => $action_details['css_class'], |
|
964 | - 'desc' => $action_details['label'] |
|
965 | - ); |
|
966 | - } |
|
967 | - |
|
968 | - /** @type array $status_items status legend setup */ |
|
969 | - $status_items = array( |
|
970 | - 'sent_status' => array( |
|
971 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_sent, |
|
972 | - 'desc' => EEH_Template::pretty_status(EEM_Message::status_sent, false, 'sentence') |
|
973 | - ), |
|
974 | - 'idle_status' => array( |
|
975 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_idle, |
|
976 | - 'desc' => EEH_Template::pretty_status(EEM_Message::status_idle, false, 'sentence') |
|
977 | - ), |
|
978 | - 'failed_status' => array( |
|
979 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_failed, |
|
980 | - 'desc' => EEH_Template::pretty_status(EEM_Message::status_failed, false, 'sentence') |
|
981 | - ), |
|
982 | - 'messenger_executing_status' => array( |
|
983 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_messenger_executing, |
|
984 | - 'desc' => EEH_Template::pretty_status(EEM_Message::status_messenger_executing, false, 'sentence') |
|
985 | - ), |
|
986 | - 'resend_status' => array( |
|
987 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_resend, |
|
988 | - 'desc' => EEH_Template::pretty_status(EEM_Message::status_resend, false, 'sentence') |
|
989 | - ), |
|
990 | - 'incomplete_status' => array( |
|
991 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_incomplete, |
|
992 | - 'desc' => EEH_Template::pretty_status(EEM_Message::status_incomplete, false, 'sentence') |
|
993 | - ), |
|
994 | - 'retry_status' => array( |
|
995 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_retry, |
|
996 | - 'desc' => EEH_Template::pretty_status(EEM_Message::status_retry, false, 'sentence') |
|
997 | - ) |
|
998 | - ); |
|
999 | - if (EEM_Message::debug()) { |
|
1000 | - $status_items['debug_only_status'] = array( |
|
1001 | - 'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_debug_only, |
|
1002 | - 'desc' => EEH_Template::pretty_status(EEM_Message::status_debug_only, false, 'sentence') |
|
1003 | - ); |
|
1004 | - } |
|
1005 | - |
|
1006 | - return array_merge($action_items, $status_items); |
|
1007 | - } |
|
1008 | - |
|
1009 | - |
|
1010 | - protected function _custom_mtps_preview() |
|
1011 | - { |
|
1012 | - $this->_admin_page_title = __('Custom Message Templates (Preview)', 'event_espresso'); |
|
1013 | - $this->_template_args['preview_img'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/custom_mtps_preview.png" alt="' . esc_attr__('Preview Custom Message Templates screenshot', |
|
1014 | - 'event_espresso') . '" />'; |
|
1015 | - $this->_template_args['preview_text'] = '<strong>' . __('Custom Message Templates is a feature that is only available in the caffeinated version of Event Espresso. With the Custom Message Templates feature, you are able to create custom templates and set them per event.', |
|
1016 | - 'event_espresso') . '</strong>'; |
|
1017 | - $this->display_admin_caf_preview_page('custom_message_types', false); |
|
1018 | - } |
|
1019 | - |
|
1020 | - |
|
1021 | - /** |
|
1022 | - * get_message_templates |
|
1023 | - * This gets all the message templates for listing on the overview list. |
|
1024 | - * |
|
1025 | - * @access public |
|
1026 | - * |
|
1027 | - * @param int $perpage the amount of templates groups to show per page |
|
1028 | - * @param string $type the current _view we're getting templates for |
|
1029 | - * @param bool $count return count? |
|
1030 | - * @param bool $all disregard any paging info (get all data); |
|
1031 | - * @param bool $global whether to return just global (true) or custom templates (false) |
|
1032 | - * |
|
1033 | - * @return array |
|
1034 | - */ |
|
1035 | - public function get_message_templates($perpage = 10, $type = 'in_use', $count = false, $all = false, $global = true) |
|
1036 | - { |
|
1037 | - |
|
1038 | - $MTP = EEM_Message_Template_Group::instance(); |
|
1039 | - |
|
1040 | - $this->_req_data['orderby'] = empty($this->_req_data['orderby']) ? 'GRP_ID' : $this->_req_data['orderby']; |
|
1041 | - $orderby = $this->_req_data['orderby']; |
|
1042 | - |
|
1043 | - $order = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order'] : 'ASC'; |
|
1044 | - |
|
1045 | - $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged']) ? $this->_req_data['paged'] : 1; |
|
1046 | - $per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage']) ? $this->_req_data['perpage'] : $perpage; |
|
1047 | - |
|
1048 | - $offset = ($current_page - 1) * $per_page; |
|
1049 | - $limit = $all ? null : array($offset, $per_page); |
|
1050 | - |
|
1051 | - |
|
1052 | - //options will match what is in the _views array property |
|
1053 | - switch ($type) { |
|
925 | + $this->_views[strtolower($status)] = array( |
|
926 | + 'slug' => strtolower($status), |
|
927 | + 'label' => EEH_Template::pretty_status($status, false, 'sentence'), |
|
928 | + 'count' => 0, |
|
929 | + 'bulk_action' => array_merge($status_bulk_actions, $delete_bulk_action) |
|
930 | + ); |
|
931 | + } |
|
932 | + } |
|
933 | + |
|
934 | + |
|
935 | + protected function _ee_default_messages_overview_list_table() |
|
936 | + { |
|
937 | + $this->_admin_page_title = __('Default Message Templates', 'event_espresso'); |
|
938 | + $this->display_admin_list_table_page_with_no_sidebar(); |
|
939 | + } |
|
940 | + |
|
941 | + |
|
942 | + protected function _message_queue_list_table() |
|
943 | + { |
|
944 | + $this->_search_btn_label = __('Message Activity', 'event_espresso'); |
|
945 | + $this->_template_args['per_column'] = 6; |
|
946 | + $this->_template_args['after_list_table'] = $this->_display_legend($this->_message_legend_items()); |
|
947 | + $this->_template_args['before_list_table'] = '<h3>' . EEM_Message::instance()->get_pretty_label_for_results() . '</h3>'; |
|
948 | + $this->display_admin_list_table_page_with_no_sidebar(); |
|
949 | + } |
|
950 | + |
|
951 | + |
|
952 | + protected function _message_legend_items() |
|
953 | + { |
|
954 | + |
|
955 | + $action_css_classes = EEH_MSG_Template::get_message_action_icons(); |
|
956 | + $action_items = array(); |
|
957 | + |
|
958 | + foreach ($action_css_classes as $action_item => $action_details) { |
|
959 | + if ($action_item === 'see_notifications_for') { |
|
960 | + continue; |
|
961 | + } |
|
962 | + $action_items[$action_item] = array( |
|
963 | + 'class' => $action_details['css_class'], |
|
964 | + 'desc' => $action_details['label'] |
|
965 | + ); |
|
966 | + } |
|
967 | + |
|
968 | + /** @type array $status_items status legend setup */ |
|
969 | + $status_items = array( |
|
970 | + 'sent_status' => array( |
|
971 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_sent, |
|
972 | + 'desc' => EEH_Template::pretty_status(EEM_Message::status_sent, false, 'sentence') |
|
973 | + ), |
|
974 | + 'idle_status' => array( |
|
975 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_idle, |
|
976 | + 'desc' => EEH_Template::pretty_status(EEM_Message::status_idle, false, 'sentence') |
|
977 | + ), |
|
978 | + 'failed_status' => array( |
|
979 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_failed, |
|
980 | + 'desc' => EEH_Template::pretty_status(EEM_Message::status_failed, false, 'sentence') |
|
981 | + ), |
|
982 | + 'messenger_executing_status' => array( |
|
983 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_messenger_executing, |
|
984 | + 'desc' => EEH_Template::pretty_status(EEM_Message::status_messenger_executing, false, 'sentence') |
|
985 | + ), |
|
986 | + 'resend_status' => array( |
|
987 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_resend, |
|
988 | + 'desc' => EEH_Template::pretty_status(EEM_Message::status_resend, false, 'sentence') |
|
989 | + ), |
|
990 | + 'incomplete_status' => array( |
|
991 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_incomplete, |
|
992 | + 'desc' => EEH_Template::pretty_status(EEM_Message::status_incomplete, false, 'sentence') |
|
993 | + ), |
|
994 | + 'retry_status' => array( |
|
995 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_retry, |
|
996 | + 'desc' => EEH_Template::pretty_status(EEM_Message::status_retry, false, 'sentence') |
|
997 | + ) |
|
998 | + ); |
|
999 | + if (EEM_Message::debug()) { |
|
1000 | + $status_items['debug_only_status'] = array( |
|
1001 | + 'class' => 'ee-status-legend ee-status-legend-' . EEM_Message::status_debug_only, |
|
1002 | + 'desc' => EEH_Template::pretty_status(EEM_Message::status_debug_only, false, 'sentence') |
|
1003 | + ); |
|
1004 | + } |
|
1005 | + |
|
1006 | + return array_merge($action_items, $status_items); |
|
1007 | + } |
|
1008 | + |
|
1009 | + |
|
1010 | + protected function _custom_mtps_preview() |
|
1011 | + { |
|
1012 | + $this->_admin_page_title = __('Custom Message Templates (Preview)', 'event_espresso'); |
|
1013 | + $this->_template_args['preview_img'] = '<img src="' . EE_MSG_ASSETS_URL . 'images/custom_mtps_preview.png" alt="' . esc_attr__('Preview Custom Message Templates screenshot', |
|
1014 | + 'event_espresso') . '" />'; |
|
1015 | + $this->_template_args['preview_text'] = '<strong>' . __('Custom Message Templates is a feature that is only available in the caffeinated version of Event Espresso. With the Custom Message Templates feature, you are able to create custom templates and set them per event.', |
|
1016 | + 'event_espresso') . '</strong>'; |
|
1017 | + $this->display_admin_caf_preview_page('custom_message_types', false); |
|
1018 | + } |
|
1019 | + |
|
1020 | + |
|
1021 | + /** |
|
1022 | + * get_message_templates |
|
1023 | + * This gets all the message templates for listing on the overview list. |
|
1024 | + * |
|
1025 | + * @access public |
|
1026 | + * |
|
1027 | + * @param int $perpage the amount of templates groups to show per page |
|
1028 | + * @param string $type the current _view we're getting templates for |
|
1029 | + * @param bool $count return count? |
|
1030 | + * @param bool $all disregard any paging info (get all data); |
|
1031 | + * @param bool $global whether to return just global (true) or custom templates (false) |
|
1032 | + * |
|
1033 | + * @return array |
|
1034 | + */ |
|
1035 | + public function get_message_templates($perpage = 10, $type = 'in_use', $count = false, $all = false, $global = true) |
|
1036 | + { |
|
1037 | + |
|
1038 | + $MTP = EEM_Message_Template_Group::instance(); |
|
1039 | + |
|
1040 | + $this->_req_data['orderby'] = empty($this->_req_data['orderby']) ? 'GRP_ID' : $this->_req_data['orderby']; |
|
1041 | + $orderby = $this->_req_data['orderby']; |
|
1042 | + |
|
1043 | + $order = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order'] : 'ASC'; |
|
1044 | + |
|
1045 | + $current_page = isset($this->_req_data['paged']) && ! empty($this->_req_data['paged']) ? $this->_req_data['paged'] : 1; |
|
1046 | + $per_page = isset($this->_req_data['perpage']) && ! empty($this->_req_data['perpage']) ? $this->_req_data['perpage'] : $perpage; |
|
1047 | + |
|
1048 | + $offset = ($current_page - 1) * $per_page; |
|
1049 | + $limit = $all ? null : array($offset, $per_page); |
|
1050 | + |
|
1051 | + |
|
1052 | + //options will match what is in the _views array property |
|
1053 | + switch ($type) { |
|
1054 | 1054 | |
1055 | - case 'in_use': |
|
1056 | - $templates = $MTP->get_all_active_message_templates($orderby, $order, $limit, $count, $global, true); |
|
1057 | - break; |
|
1055 | + case 'in_use': |
|
1056 | + $templates = $MTP->get_all_active_message_templates($orderby, $order, $limit, $count, $global, true); |
|
1057 | + break; |
|
1058 | 1058 | |
1059 | - default: |
|
1060 | - $templates = $MTP->get_all_trashed_grouped_message_templates($orderby, $order, $limit, $count, $global); |
|
1059 | + default: |
|
1060 | + $templates = $MTP->get_all_trashed_grouped_message_templates($orderby, $order, $limit, $count, $global); |
|
1061 | 1061 | |
1062 | - } |
|
1063 | - |
|
1064 | - return $templates; |
|
1065 | - } |
|
1066 | - |
|
1067 | - |
|
1068 | - /** |
|
1069 | - * filters etc might need a list of installed message_types |
|
1070 | - * @return array an array of message type objects |
|
1071 | - */ |
|
1072 | - public function get_installed_message_types() |
|
1073 | - { |
|
1074 | - $installed_message_types = $this->_message_resource_manager->installed_message_types(); |
|
1075 | - $installed = array(); |
|
1076 | - |
|
1077 | - foreach ($installed_message_types as $message_type) { |
|
1078 | - $installed[$message_type->name] = $message_type; |
|
1079 | - } |
|
1080 | - |
|
1081 | - return $installed; |
|
1082 | - } |
|
1083 | - |
|
1084 | - |
|
1085 | - /** |
|
1086 | - * _add_message_template |
|
1087 | - * |
|
1088 | - * This is used when creating a custom template. All Custom Templates start based off another template. |
|
1089 | - * |
|
1090 | - * @param string $message_type |
|
1091 | - * @param string $messenger |
|
1092 | - * @param string $GRP_ID |
|
1093 | - * |
|
1094 | - * @throws EE_error |
|
1095 | - */ |
|
1096 | - protected function _add_message_template($message_type = '', $messenger = '', $GRP_ID = '') |
|
1097 | - { |
|
1098 | - //set values override any request data |
|
1099 | - $message_type = ! empty($message_type) ? $message_type : ''; |
|
1100 | - $message_type = empty($message_type) && ! empty($this->_req_data['message_type']) ? $this->_req_data['message_type'] : $message_type; |
|
1101 | - |
|
1102 | - $messenger = ! empty($messenger) ? $messenger : ''; |
|
1103 | - $messenger = empty($messenger) && ! empty($this->_req_data['messenger']) ? $this->_req_data['messenger'] : $messenger; |
|
1104 | - |
|
1105 | - $GRP_ID = ! empty($GRP_ID) ? $GRP_ID : ''; |
|
1106 | - $GRP_ID = empty($GRP_ID) && ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : $GRP_ID; |
|
1107 | - |
|
1108 | - //we need messenger and message type. They should be coming from the event editor. If not here then return error |
|
1109 | - if (empty($message_type) || empty($messenger)) { |
|
1110 | - throw new EE_error(__('Sorry, but we can\'t create new templates because we\'re missing the messenger or message type', |
|
1111 | - 'event_espresso')); |
|
1112 | - } |
|
1113 | - |
|
1114 | - //we need the GRP_ID for the template being used as the base for the new template |
|
1115 | - if (empty($GRP_ID)) { |
|
1116 | - throw new EE_Error(__('In order to create a custom message template the GRP_ID of the template being used as a base is needed', |
|
1117 | - 'event_espresso')); |
|
1118 | - } |
|
1119 | - |
|
1120 | - //let's just make sure the template gets generated! |
|
1121 | - |
|
1122 | - //we need to reassign some variables for what the insert is expecting |
|
1123 | - $this->_req_data['MTP_messenger'] = $messenger; |
|
1124 | - $this->_req_data['MTP_message_type'] = $message_type; |
|
1125 | - $this->_req_data['GRP_ID'] = $GRP_ID; |
|
1126 | - $this->_insert_or_update_message_template(true); |
|
1127 | - } |
|
1128 | - |
|
1129 | - |
|
1130 | - /** |
|
1131 | - * public wrapper for the _add_message_template method |
|
1132 | - * |
|
1133 | - * @param string $message_type message type slug |
|
1134 | - * @param string $messenger messenger slug |
|
1135 | - * @param int $GRP_ID GRP_ID for the related message template group this new template will be based |
|
1136 | - * off of. |
|
1137 | - */ |
|
1138 | - public function add_message_template($message_type, $messenger, $GRP_ID) |
|
1139 | - { |
|
1140 | - $this->_add_message_template($message_type, $messenger, $GRP_ID); |
|
1141 | - } |
|
1142 | - |
|
1143 | - |
|
1144 | - /** |
|
1145 | - * _edit_message_template |
|
1146 | - * |
|
1147 | - * @access protected |
|
1148 | - * @return void |
|
1149 | - */ |
|
1150 | - protected function _edit_message_template() |
|
1151 | - { |
|
1152 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
1153 | - $template_fields = ''; |
|
1154 | - $sidebar_fields = ''; |
|
1155 | - //we filter the tinyMCE settings to remove the validation since message templates by their nature will not have valid html in the templates. |
|
1156 | - add_filter('tiny_mce_before_init', array($this, 'filter_tinymce_init'), 10, 2); |
|
1157 | - |
|
1158 | - $GRP_ID = isset($this->_req_data['id']) && ! empty($this->_req_data['id']) |
|
1159 | - ? absint($this->_req_data['id']) |
|
1160 | - : false; |
|
1161 | - |
|
1162 | - $this->_set_shortcodes(); //this also sets the _message_template property. |
|
1163 | - $message_template_group = $this->_message_template_group; |
|
1164 | - $c_label = $message_template_group->context_label(); |
|
1165 | - $c_config = $message_template_group->contexts_config(); |
|
1166 | - |
|
1167 | - reset($c_config); |
|
1168 | - $context = isset($this->_req_data['context']) && ! empty($this->_req_data['context']) |
|
1169 | - ? strtolower($this->_req_data['context']) |
|
1170 | - : key($c_config); |
|
1171 | - |
|
1172 | - |
|
1173 | - if (empty($GRP_ID)) { |
|
1174 | - $action = 'insert_message_template'; |
|
1175 | - //$button_both = false; |
|
1176 | - //$button_text = array( __( 'Save','event_espresso') ); |
|
1177 | - //$button_actions = array('something_different'); |
|
1178 | - //$referrer = false; |
|
1179 | - $edit_message_template_form_url = add_query_arg( |
|
1180 | - array('action' => $action, 'noheader' => true), |
|
1181 | - EE_MSG_ADMIN_URL |
|
1182 | - ); |
|
1183 | - } else { |
|
1184 | - $action = 'update_message_template'; |
|
1185 | - //$button_both = true; |
|
1186 | - //$button_text = array(); |
|
1187 | - //$button_actions = array(); |
|
1188 | - //$referrer = $this->_admin_base_url; |
|
1189 | - $edit_message_template_form_url = add_query_arg( |
|
1190 | - array('action' => $action, 'noheader' => true), |
|
1191 | - EE_MSG_ADMIN_URL |
|
1192 | - ); |
|
1193 | - } |
|
1194 | - |
|
1195 | - //set active messenger for this view |
|
1196 | - $this->_active_messenger = $this->_message_resource_manager->get_active_messenger( |
|
1197 | - $message_template_group->messenger() |
|
1198 | - ); |
|
1199 | - $this->_active_message_type_name = $message_template_group->message_type(); |
|
1200 | - |
|
1201 | - |
|
1202 | - //Do we have any validation errors? |
|
1203 | - $validators = $this->_get_transient(); |
|
1204 | - $v_fields = ! empty($validators) ? array_keys($validators) : array(); |
|
1205 | - |
|
1206 | - |
|
1207 | - //we need to assemble the title from Various details |
|
1208 | - $context_label = sprintf( |
|
1209 | - __('(%s %s)', 'event_espresso'), |
|
1210 | - $c_config[$context]['label'], |
|
1211 | - ucwords($c_label['label']) |
|
1212 | - ); |
|
1213 | - |
|
1214 | - $title = sprintf( |
|
1215 | - __(' %s %s Template %s', 'event_espresso'), |
|
1216 | - ucwords($message_template_group->messenger_obj()->label['singular']), |
|
1217 | - ucwords($message_template_group->message_type_obj()->label['singular']), |
|
1218 | - $context_label |
|
1219 | - ); |
|
1220 | - |
|
1221 | - $this->_template_args['GRP_ID'] = $GRP_ID; |
|
1222 | - $this->_template_args['message_template'] = $message_template_group; |
|
1223 | - $this->_template_args['is_extra_fields'] = false; |
|
1224 | - |
|
1225 | - |
|
1226 | - //let's get EEH_MSG_Template so we can get template form fields |
|
1227 | - $template_field_structure = EEH_MSG_Template::get_fields( |
|
1228 | - $message_template_group->messenger(), |
|
1229 | - $message_template_group->message_type() |
|
1230 | - ); |
|
1231 | - |
|
1232 | - if ( ! $template_field_structure) { |
|
1233 | - $template_field_structure = false; |
|
1234 | - $template_fields = __('There was an error in assembling the fields for this display (you should see an error message)', |
|
1235 | - 'event_espresso'); |
|
1236 | - } |
|
1237 | - |
|
1238 | - |
|
1239 | - $message_templates = $message_template_group->context_templates(); |
|
1240 | - |
|
1241 | - |
|
1242 | - //if we have the extra key.. then we need to remove the content index from the template_field_structure as it will get handled in the "extra" array. |
|
1243 | - if (is_array($template_field_structure[$context]) && isset($template_field_structure[$context]['extra'])) { |
|
1244 | - foreach ($template_field_structure[$context]['extra'] as $reference_field => $new_fields) { |
|
1245 | - unset($template_field_structure[$context][$reference_field]); |
|
1246 | - } |
|
1247 | - } |
|
1248 | - |
|
1249 | - //let's loop through the template_field_structure and actually assemble the input fields! |
|
1250 | - if ( ! empty($template_field_structure)) { |
|
1251 | - foreach ($template_field_structure[$context] as $template_field => $field_setup_array) { |
|
1252 | - //if this is an 'extra' template field then we need to remove any existing fields that are keyed up in the extra array and reset them. |
|
1253 | - if ($template_field == 'extra') { |
|
1254 | - $this->_template_args['is_extra_fields'] = true; |
|
1255 | - foreach ($field_setup_array as $reference_field => $new_fields_array) { |
|
1256 | - $message_template = $message_templates[$context][$reference_field]; |
|
1257 | - $content = $message_template instanceof EE_Message_Template |
|
1258 | - ? $message_template->get('MTP_content') |
|
1259 | - : ''; |
|
1260 | - foreach ($new_fields_array as $extra_field => $extra_array) { |
|
1261 | - //let's verify if we need this extra field via the shortcodes parameter. |
|
1262 | - $continue = false; |
|
1263 | - if (isset($extra_array['shortcodes_required'])) { |
|
1264 | - foreach ((array)$extra_array['shortcodes_required'] as $shortcode) { |
|
1265 | - if ( ! array_key_exists($shortcode, $this->_shortcodes)) { |
|
1266 | - $continue = true; |
|
1267 | - } |
|
1268 | - } |
|
1269 | - if ($continue) { |
|
1270 | - continue; |
|
1271 | - } |
|
1272 | - } |
|
1062 | + } |
|
1063 | + |
|
1064 | + return $templates; |
|
1065 | + } |
|
1066 | + |
|
1067 | + |
|
1068 | + /** |
|
1069 | + * filters etc might need a list of installed message_types |
|
1070 | + * @return array an array of message type objects |
|
1071 | + */ |
|
1072 | + public function get_installed_message_types() |
|
1073 | + { |
|
1074 | + $installed_message_types = $this->_message_resource_manager->installed_message_types(); |
|
1075 | + $installed = array(); |
|
1076 | + |
|
1077 | + foreach ($installed_message_types as $message_type) { |
|
1078 | + $installed[$message_type->name] = $message_type; |
|
1079 | + } |
|
1080 | + |
|
1081 | + return $installed; |
|
1082 | + } |
|
1083 | + |
|
1084 | + |
|
1085 | + /** |
|
1086 | + * _add_message_template |
|
1087 | + * |
|
1088 | + * This is used when creating a custom template. All Custom Templates start based off another template. |
|
1089 | + * |
|
1090 | + * @param string $message_type |
|
1091 | + * @param string $messenger |
|
1092 | + * @param string $GRP_ID |
|
1093 | + * |
|
1094 | + * @throws EE_error |
|
1095 | + */ |
|
1096 | + protected function _add_message_template($message_type = '', $messenger = '', $GRP_ID = '') |
|
1097 | + { |
|
1098 | + //set values override any request data |
|
1099 | + $message_type = ! empty($message_type) ? $message_type : ''; |
|
1100 | + $message_type = empty($message_type) && ! empty($this->_req_data['message_type']) ? $this->_req_data['message_type'] : $message_type; |
|
1101 | + |
|
1102 | + $messenger = ! empty($messenger) ? $messenger : ''; |
|
1103 | + $messenger = empty($messenger) && ! empty($this->_req_data['messenger']) ? $this->_req_data['messenger'] : $messenger; |
|
1104 | + |
|
1105 | + $GRP_ID = ! empty($GRP_ID) ? $GRP_ID : ''; |
|
1106 | + $GRP_ID = empty($GRP_ID) && ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : $GRP_ID; |
|
1107 | + |
|
1108 | + //we need messenger and message type. They should be coming from the event editor. If not here then return error |
|
1109 | + if (empty($message_type) || empty($messenger)) { |
|
1110 | + throw new EE_error(__('Sorry, but we can\'t create new templates because we\'re missing the messenger or message type', |
|
1111 | + 'event_espresso')); |
|
1112 | + } |
|
1113 | + |
|
1114 | + //we need the GRP_ID for the template being used as the base for the new template |
|
1115 | + if (empty($GRP_ID)) { |
|
1116 | + throw new EE_Error(__('In order to create a custom message template the GRP_ID of the template being used as a base is needed', |
|
1117 | + 'event_espresso')); |
|
1118 | + } |
|
1119 | + |
|
1120 | + //let's just make sure the template gets generated! |
|
1121 | + |
|
1122 | + //we need to reassign some variables for what the insert is expecting |
|
1123 | + $this->_req_data['MTP_messenger'] = $messenger; |
|
1124 | + $this->_req_data['MTP_message_type'] = $message_type; |
|
1125 | + $this->_req_data['GRP_ID'] = $GRP_ID; |
|
1126 | + $this->_insert_or_update_message_template(true); |
|
1127 | + } |
|
1128 | + |
|
1129 | + |
|
1130 | + /** |
|
1131 | + * public wrapper for the _add_message_template method |
|
1132 | + * |
|
1133 | + * @param string $message_type message type slug |
|
1134 | + * @param string $messenger messenger slug |
|
1135 | + * @param int $GRP_ID GRP_ID for the related message template group this new template will be based |
|
1136 | + * off of. |
|
1137 | + */ |
|
1138 | + public function add_message_template($message_type, $messenger, $GRP_ID) |
|
1139 | + { |
|
1140 | + $this->_add_message_template($message_type, $messenger, $GRP_ID); |
|
1141 | + } |
|
1142 | + |
|
1143 | + |
|
1144 | + /** |
|
1145 | + * _edit_message_template |
|
1146 | + * |
|
1147 | + * @access protected |
|
1148 | + * @return void |
|
1149 | + */ |
|
1150 | + protected function _edit_message_template() |
|
1151 | + { |
|
1152 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
1153 | + $template_fields = ''; |
|
1154 | + $sidebar_fields = ''; |
|
1155 | + //we filter the tinyMCE settings to remove the validation since message templates by their nature will not have valid html in the templates. |
|
1156 | + add_filter('tiny_mce_before_init', array($this, 'filter_tinymce_init'), 10, 2); |
|
1157 | + |
|
1158 | + $GRP_ID = isset($this->_req_data['id']) && ! empty($this->_req_data['id']) |
|
1159 | + ? absint($this->_req_data['id']) |
|
1160 | + : false; |
|
1161 | + |
|
1162 | + $this->_set_shortcodes(); //this also sets the _message_template property. |
|
1163 | + $message_template_group = $this->_message_template_group; |
|
1164 | + $c_label = $message_template_group->context_label(); |
|
1165 | + $c_config = $message_template_group->contexts_config(); |
|
1166 | + |
|
1167 | + reset($c_config); |
|
1168 | + $context = isset($this->_req_data['context']) && ! empty($this->_req_data['context']) |
|
1169 | + ? strtolower($this->_req_data['context']) |
|
1170 | + : key($c_config); |
|
1171 | + |
|
1172 | + |
|
1173 | + if (empty($GRP_ID)) { |
|
1174 | + $action = 'insert_message_template'; |
|
1175 | + //$button_both = false; |
|
1176 | + //$button_text = array( __( 'Save','event_espresso') ); |
|
1177 | + //$button_actions = array('something_different'); |
|
1178 | + //$referrer = false; |
|
1179 | + $edit_message_template_form_url = add_query_arg( |
|
1180 | + array('action' => $action, 'noheader' => true), |
|
1181 | + EE_MSG_ADMIN_URL |
|
1182 | + ); |
|
1183 | + } else { |
|
1184 | + $action = 'update_message_template'; |
|
1185 | + //$button_both = true; |
|
1186 | + //$button_text = array(); |
|
1187 | + //$button_actions = array(); |
|
1188 | + //$referrer = $this->_admin_base_url; |
|
1189 | + $edit_message_template_form_url = add_query_arg( |
|
1190 | + array('action' => $action, 'noheader' => true), |
|
1191 | + EE_MSG_ADMIN_URL |
|
1192 | + ); |
|
1193 | + } |
|
1194 | + |
|
1195 | + //set active messenger for this view |
|
1196 | + $this->_active_messenger = $this->_message_resource_manager->get_active_messenger( |
|
1197 | + $message_template_group->messenger() |
|
1198 | + ); |
|
1199 | + $this->_active_message_type_name = $message_template_group->message_type(); |
|
1200 | + |
|
1201 | + |
|
1202 | + //Do we have any validation errors? |
|
1203 | + $validators = $this->_get_transient(); |
|
1204 | + $v_fields = ! empty($validators) ? array_keys($validators) : array(); |
|
1205 | + |
|
1206 | + |
|
1207 | + //we need to assemble the title from Various details |
|
1208 | + $context_label = sprintf( |
|
1209 | + __('(%s %s)', 'event_espresso'), |
|
1210 | + $c_config[$context]['label'], |
|
1211 | + ucwords($c_label['label']) |
|
1212 | + ); |
|
1213 | + |
|
1214 | + $title = sprintf( |
|
1215 | + __(' %s %s Template %s', 'event_espresso'), |
|
1216 | + ucwords($message_template_group->messenger_obj()->label['singular']), |
|
1217 | + ucwords($message_template_group->message_type_obj()->label['singular']), |
|
1218 | + $context_label |
|
1219 | + ); |
|
1220 | + |
|
1221 | + $this->_template_args['GRP_ID'] = $GRP_ID; |
|
1222 | + $this->_template_args['message_template'] = $message_template_group; |
|
1223 | + $this->_template_args['is_extra_fields'] = false; |
|
1224 | + |
|
1225 | + |
|
1226 | + //let's get EEH_MSG_Template so we can get template form fields |
|
1227 | + $template_field_structure = EEH_MSG_Template::get_fields( |
|
1228 | + $message_template_group->messenger(), |
|
1229 | + $message_template_group->message_type() |
|
1230 | + ); |
|
1231 | + |
|
1232 | + if ( ! $template_field_structure) { |
|
1233 | + $template_field_structure = false; |
|
1234 | + $template_fields = __('There was an error in assembling the fields for this display (you should see an error message)', |
|
1235 | + 'event_espresso'); |
|
1236 | + } |
|
1237 | + |
|
1238 | + |
|
1239 | + $message_templates = $message_template_group->context_templates(); |
|
1240 | + |
|
1241 | + |
|
1242 | + //if we have the extra key.. then we need to remove the content index from the template_field_structure as it will get handled in the "extra" array. |
|
1243 | + if (is_array($template_field_structure[$context]) && isset($template_field_structure[$context]['extra'])) { |
|
1244 | + foreach ($template_field_structure[$context]['extra'] as $reference_field => $new_fields) { |
|
1245 | + unset($template_field_structure[$context][$reference_field]); |
|
1246 | + } |
|
1247 | + } |
|
1248 | + |
|
1249 | + //let's loop through the template_field_structure and actually assemble the input fields! |
|
1250 | + if ( ! empty($template_field_structure)) { |
|
1251 | + foreach ($template_field_structure[$context] as $template_field => $field_setup_array) { |
|
1252 | + //if this is an 'extra' template field then we need to remove any existing fields that are keyed up in the extra array and reset them. |
|
1253 | + if ($template_field == 'extra') { |
|
1254 | + $this->_template_args['is_extra_fields'] = true; |
|
1255 | + foreach ($field_setup_array as $reference_field => $new_fields_array) { |
|
1256 | + $message_template = $message_templates[$context][$reference_field]; |
|
1257 | + $content = $message_template instanceof EE_Message_Template |
|
1258 | + ? $message_template->get('MTP_content') |
|
1259 | + : ''; |
|
1260 | + foreach ($new_fields_array as $extra_field => $extra_array) { |
|
1261 | + //let's verify if we need this extra field via the shortcodes parameter. |
|
1262 | + $continue = false; |
|
1263 | + if (isset($extra_array['shortcodes_required'])) { |
|
1264 | + foreach ((array)$extra_array['shortcodes_required'] as $shortcode) { |
|
1265 | + if ( ! array_key_exists($shortcode, $this->_shortcodes)) { |
|
1266 | + $continue = true; |
|
1267 | + } |
|
1268 | + } |
|
1269 | + if ($continue) { |
|
1270 | + continue; |
|
1271 | + } |
|
1272 | + } |
|
1273 | 1273 | |
1274 | - $field_id = $reference_field . '-' . $extra_field . '-content'; |
|
1275 | - $template_form_fields[$field_id] = $extra_array; |
|
1276 | - $template_form_fields[$field_id]['name'] = 'MTP_template_fields[' . $reference_field . '][content][' . $extra_field . ']'; |
|
1277 | - $css_class = isset($extra_array['css_class']) ? $extra_array['css_class'] : ''; |
|
1274 | + $field_id = $reference_field . '-' . $extra_field . '-content'; |
|
1275 | + $template_form_fields[$field_id] = $extra_array; |
|
1276 | + $template_form_fields[$field_id]['name'] = 'MTP_template_fields[' . $reference_field . '][content][' . $extra_field . ']'; |
|
1277 | + $css_class = isset($extra_array['css_class']) ? $extra_array['css_class'] : ''; |
|
1278 | 1278 | |
1279 | - $template_form_fields[$field_id]['css_class'] = ! empty($v_fields) |
|
1280 | - && in_array($extra_field, $v_fields) |
|
1281 | - && |
|
1282 | - ( |
|
1283 | - is_array($validators[$extra_field]) |
|
1284 | - && isset($validators[$extra_field]['msg']) |
|
1285 | - ) |
|
1286 | - ? 'validate-error ' . $css_class |
|
1287 | - : $css_class; |
|
1279 | + $template_form_fields[$field_id]['css_class'] = ! empty($v_fields) |
|
1280 | + && in_array($extra_field, $v_fields) |
|
1281 | + && |
|
1282 | + ( |
|
1283 | + is_array($validators[$extra_field]) |
|
1284 | + && isset($validators[$extra_field]['msg']) |
|
1285 | + ) |
|
1286 | + ? 'validate-error ' . $css_class |
|
1287 | + : $css_class; |
|
1288 | 1288 | |
1289 | - $template_form_fields[$field_id]['value'] = ! empty($message_templates) && isset($content[$extra_field]) |
|
1290 | - ? stripslashes(html_entity_decode($content[$extra_field], ENT_QUOTES, "UTF-8")) |
|
1291 | - : ''; |
|
1289 | + $template_form_fields[$field_id]['value'] = ! empty($message_templates) && isset($content[$extra_field]) |
|
1290 | + ? stripslashes(html_entity_decode($content[$extra_field], ENT_QUOTES, "UTF-8")) |
|
1291 | + : ''; |
|
1292 | 1292 | |
1293 | - //do we have a validation error? if we do then let's use that value instead |
|
1294 | - $template_form_fields[$field_id]['value'] = isset($validators[$extra_field]) ? $validators[$extra_field]['value'] : $template_form_fields[$field_id]['value']; |
|
1293 | + //do we have a validation error? if we do then let's use that value instead |
|
1294 | + $template_form_fields[$field_id]['value'] = isset($validators[$extra_field]) ? $validators[$extra_field]['value'] : $template_form_fields[$field_id]['value']; |
|
1295 | 1295 | |
1296 | 1296 | |
1297 | - $template_form_fields[$field_id]['db-col'] = 'MTP_content'; |
|
1297 | + $template_form_fields[$field_id]['db-col'] = 'MTP_content'; |
|
1298 | 1298 | |
1299 | - //shortcode selector |
|
1300 | - $field_name_to_use = $extra_field == 'main' ? 'content' : $extra_field; |
|
1301 | - $template_form_fields[$field_id]['append_content'] = $this->_get_shortcode_selector( |
|
1302 | - $field_name_to_use, |
|
1303 | - $field_id |
|
1304 | - ); |
|
1299 | + //shortcode selector |
|
1300 | + $field_name_to_use = $extra_field == 'main' ? 'content' : $extra_field; |
|
1301 | + $template_form_fields[$field_id]['append_content'] = $this->_get_shortcode_selector( |
|
1302 | + $field_name_to_use, |
|
1303 | + $field_id |
|
1304 | + ); |
|
1305 | 1305 | |
1306 | - if (isset($extra_array['input']) && $extra_array['input'] == 'wp_editor') { |
|
1307 | - //we want to decode the entities |
|
1308 | - $template_form_fields[$field_id]['value'] = stripslashes( |
|
1309 | - html_entity_decode($template_form_fields[$field_id]['value'], ENT_QUOTES, "UTF-8") |
|
1310 | - ); |
|
1306 | + if (isset($extra_array['input']) && $extra_array['input'] == 'wp_editor') { |
|
1307 | + //we want to decode the entities |
|
1308 | + $template_form_fields[$field_id]['value'] = stripslashes( |
|
1309 | + html_entity_decode($template_form_fields[$field_id]['value'], ENT_QUOTES, "UTF-8") |
|
1310 | + ); |
|
1311 | 1311 | |
1312 | - }/**/ |
|
1313 | - } |
|
1314 | - $templatefield_MTP_id = $reference_field . '-MTP_ID'; |
|
1315 | - $templatefield_templatename_id = $reference_field . '-name'; |
|
1312 | + }/**/ |
|
1313 | + } |
|
1314 | + $templatefield_MTP_id = $reference_field . '-MTP_ID'; |
|
1315 | + $templatefield_templatename_id = $reference_field . '-name'; |
|
1316 | 1316 | |
1317 | - $template_form_fields[$templatefield_MTP_id] = array( |
|
1318 | - 'name' => 'MTP_template_fields[' . $reference_field . '][MTP_ID]', |
|
1319 | - 'label' => null, |
|
1320 | - 'input' => 'hidden', |
|
1321 | - 'type' => 'int', |
|
1322 | - 'required' => false, |
|
1323 | - 'validation' => false, |
|
1324 | - 'value' => ! empty($message_templates) ? $message_template->ID() : '', |
|
1325 | - 'css_class' => '', |
|
1326 | - 'format' => '%d', |
|
1327 | - 'db-col' => 'MTP_ID' |
|
1328 | - ); |
|
1317 | + $template_form_fields[$templatefield_MTP_id] = array( |
|
1318 | + 'name' => 'MTP_template_fields[' . $reference_field . '][MTP_ID]', |
|
1319 | + 'label' => null, |
|
1320 | + 'input' => 'hidden', |
|
1321 | + 'type' => 'int', |
|
1322 | + 'required' => false, |
|
1323 | + 'validation' => false, |
|
1324 | + 'value' => ! empty($message_templates) ? $message_template->ID() : '', |
|
1325 | + 'css_class' => '', |
|
1326 | + 'format' => '%d', |
|
1327 | + 'db-col' => 'MTP_ID' |
|
1328 | + ); |
|
1329 | 1329 | |
1330 | - $template_form_fields[$templatefield_templatename_id] = array( |
|
1331 | - 'name' => 'MTP_template_fields[' . $reference_field . '][name]', |
|
1332 | - 'label' => null, |
|
1333 | - 'input' => 'hidden', |
|
1334 | - 'type' => 'string', |
|
1335 | - 'required' => false, |
|
1336 | - 'validation' => true, |
|
1337 | - 'value' => $reference_field, |
|
1338 | - 'css_class' => '', |
|
1339 | - 'format' => '%s', |
|
1340 | - 'db-col' => 'MTP_template_field' |
|
1341 | - ); |
|
1342 | - } |
|
1343 | - continue; //skip the next stuff, we got the necessary fields here for this dataset. |
|
1344 | - } else { |
|
1345 | - $field_id = $template_field . '-content'; |
|
1346 | - $template_form_fields[$field_id] = $field_setup_array; |
|
1347 | - $template_form_fields[$field_id]['name'] = 'MTP_template_fields[' . $template_field . '][content]'; |
|
1348 | - $message_template = isset($message_templates[$context][$template_field]) |
|
1349 | - ? $message_templates[$context][$template_field] |
|
1350 | - : null; |
|
1351 | - $template_form_fields[$field_id]['value'] = ! empty($message_templates) |
|
1352 | - && is_array($message_templates[$context]) |
|
1353 | - && $message_template instanceof EE_Message_Template |
|
1354 | - ? $message_template->get('MTP_content') |
|
1355 | - : ''; |
|
1330 | + $template_form_fields[$templatefield_templatename_id] = array( |
|
1331 | + 'name' => 'MTP_template_fields[' . $reference_field . '][name]', |
|
1332 | + 'label' => null, |
|
1333 | + 'input' => 'hidden', |
|
1334 | + 'type' => 'string', |
|
1335 | + 'required' => false, |
|
1336 | + 'validation' => true, |
|
1337 | + 'value' => $reference_field, |
|
1338 | + 'css_class' => '', |
|
1339 | + 'format' => '%s', |
|
1340 | + 'db-col' => 'MTP_template_field' |
|
1341 | + ); |
|
1342 | + } |
|
1343 | + continue; //skip the next stuff, we got the necessary fields here for this dataset. |
|
1344 | + } else { |
|
1345 | + $field_id = $template_field . '-content'; |
|
1346 | + $template_form_fields[$field_id] = $field_setup_array; |
|
1347 | + $template_form_fields[$field_id]['name'] = 'MTP_template_fields[' . $template_field . '][content]'; |
|
1348 | + $message_template = isset($message_templates[$context][$template_field]) |
|
1349 | + ? $message_templates[$context][$template_field] |
|
1350 | + : null; |
|
1351 | + $template_form_fields[$field_id]['value'] = ! empty($message_templates) |
|
1352 | + && is_array($message_templates[$context]) |
|
1353 | + && $message_template instanceof EE_Message_Template |
|
1354 | + ? $message_template->get('MTP_content') |
|
1355 | + : ''; |
|
1356 | 1356 | |
1357 | - //do we have a validator error for this field? if we do then we'll use that value instead |
|
1358 | - $template_form_fields[$field_id]['value'] = isset($validators[$template_field]) |
|
1359 | - ? $validators[$template_field]['value'] |
|
1360 | - : $template_form_fields[$field_id]['value']; |
|
1357 | + //do we have a validator error for this field? if we do then we'll use that value instead |
|
1358 | + $template_form_fields[$field_id]['value'] = isset($validators[$template_field]) |
|
1359 | + ? $validators[$template_field]['value'] |
|
1360 | + : $template_form_fields[$field_id]['value']; |
|
1361 | 1361 | |
1362 | 1362 | |
1363 | - $template_form_fields[$field_id]['db-col'] = 'MTP_content'; |
|
1364 | - $css_class = isset($field_setup_array['css_class']) ? $field_setup_array['css_class'] : ''; |
|
1365 | - $template_form_fields[$field_id]['css_class'] = ! empty($v_fields) |
|
1366 | - && in_array($template_field, $v_fields) |
|
1367 | - && isset($validators[$template_field]['msg']) |
|
1368 | - ? 'validate-error ' . $css_class |
|
1369 | - : $css_class; |
|
1363 | + $template_form_fields[$field_id]['db-col'] = 'MTP_content'; |
|
1364 | + $css_class = isset($field_setup_array['css_class']) ? $field_setup_array['css_class'] : ''; |
|
1365 | + $template_form_fields[$field_id]['css_class'] = ! empty($v_fields) |
|
1366 | + && in_array($template_field, $v_fields) |
|
1367 | + && isset($validators[$template_field]['msg']) |
|
1368 | + ? 'validate-error ' . $css_class |
|
1369 | + : $css_class; |
|
1370 | 1370 | |
1371 | - //shortcode selector |
|
1372 | - $template_form_fields[$field_id]['append_content'] = $this->_get_shortcode_selector( |
|
1373 | - $template_field, $field_id |
|
1374 | - ); |
|
1375 | - } |
|
1371 | + //shortcode selector |
|
1372 | + $template_form_fields[$field_id]['append_content'] = $this->_get_shortcode_selector( |
|
1373 | + $template_field, $field_id |
|
1374 | + ); |
|
1375 | + } |
|
1376 | 1376 | |
1377 | - //k took care of content field(s) now let's take care of others. |
|
1377 | + //k took care of content field(s) now let's take care of others. |
|
1378 | 1378 | |
1379 | - $templatefield_MTP_id = $template_field . '-MTP_ID'; |
|
1380 | - $templatefield_field_templatename_id = $template_field . '-name'; |
|
1379 | + $templatefield_MTP_id = $template_field . '-MTP_ID'; |
|
1380 | + $templatefield_field_templatename_id = $template_field . '-name'; |
|
1381 | 1381 | |
1382 | - //foreach template field there are actually two form fields created |
|
1383 | - $template_form_fields[$templatefield_MTP_id] = array( |
|
1384 | - 'name' => 'MTP_template_fields[' . $template_field . '][MTP_ID]', |
|
1385 | - 'label' => null, |
|
1386 | - 'input' => 'hidden', |
|
1387 | - 'type' => 'int', |
|
1388 | - 'required' => false, |
|
1389 | - 'validation' => true, |
|
1390 | - 'value' => $message_template instanceof EE_Message_Template ? $message_template->ID() : '', |
|
1391 | - 'css_class' => '', |
|
1392 | - 'format' => '%d', |
|
1393 | - 'db-col' => 'MTP_ID' |
|
1394 | - ); |
|
1382 | + //foreach template field there are actually two form fields created |
|
1383 | + $template_form_fields[$templatefield_MTP_id] = array( |
|
1384 | + 'name' => 'MTP_template_fields[' . $template_field . '][MTP_ID]', |
|
1385 | + 'label' => null, |
|
1386 | + 'input' => 'hidden', |
|
1387 | + 'type' => 'int', |
|
1388 | + 'required' => false, |
|
1389 | + 'validation' => true, |
|
1390 | + 'value' => $message_template instanceof EE_Message_Template ? $message_template->ID() : '', |
|
1391 | + 'css_class' => '', |
|
1392 | + 'format' => '%d', |
|
1393 | + 'db-col' => 'MTP_ID' |
|
1394 | + ); |
|
1395 | 1395 | |
1396 | - $template_form_fields[$templatefield_field_templatename_id] = array( |
|
1397 | - 'name' => 'MTP_template_fields[' . $template_field . '][name]', |
|
1398 | - 'label' => null, |
|
1399 | - 'input' => 'hidden', |
|
1400 | - 'type' => 'string', |
|
1401 | - 'required' => false, |
|
1402 | - 'validation' => true, |
|
1403 | - 'value' => $template_field, |
|
1404 | - 'css_class' => '', |
|
1405 | - 'format' => '%s', |
|
1406 | - 'db-col' => 'MTP_template_field' |
|
1407 | - ); |
|
1396 | + $template_form_fields[$templatefield_field_templatename_id] = array( |
|
1397 | + 'name' => 'MTP_template_fields[' . $template_field . '][name]', |
|
1398 | + 'label' => null, |
|
1399 | + 'input' => 'hidden', |
|
1400 | + 'type' => 'string', |
|
1401 | + 'required' => false, |
|
1402 | + 'validation' => true, |
|
1403 | + 'value' => $template_field, |
|
1404 | + 'css_class' => '', |
|
1405 | + 'format' => '%s', |
|
1406 | + 'db-col' => 'MTP_template_field' |
|
1407 | + ); |
|
1408 | 1408 | |
1409 | - } |
|
1409 | + } |
|
1410 | 1410 | |
1411 | - //add other fields |
|
1412 | - $template_form_fields['ee-msg-current-context'] = array( |
|
1413 | - 'name' => 'MTP_context', |
|
1414 | - 'label' => null, |
|
1415 | - 'input' => 'hidden', |
|
1416 | - 'type' => 'string', |
|
1417 | - 'required' => false, |
|
1418 | - 'validation' => true, |
|
1419 | - 'value' => $context, |
|
1420 | - 'css_class' => '', |
|
1421 | - 'format' => '%s', |
|
1422 | - 'db-col' => 'MTP_context' |
|
1423 | - ); |
|
1411 | + //add other fields |
|
1412 | + $template_form_fields['ee-msg-current-context'] = array( |
|
1413 | + 'name' => 'MTP_context', |
|
1414 | + 'label' => null, |
|
1415 | + 'input' => 'hidden', |
|
1416 | + 'type' => 'string', |
|
1417 | + 'required' => false, |
|
1418 | + 'validation' => true, |
|
1419 | + 'value' => $context, |
|
1420 | + 'css_class' => '', |
|
1421 | + 'format' => '%s', |
|
1422 | + 'db-col' => 'MTP_context' |
|
1423 | + ); |
|
1424 | 1424 | |
1425 | - $template_form_fields['ee-msg-grp-id'] = array( |
|
1426 | - 'name' => 'GRP_ID', |
|
1427 | - 'label' => null, |
|
1428 | - 'input' => 'hidden', |
|
1429 | - 'type' => 'int', |
|
1430 | - 'required' => false, |
|
1431 | - 'validation' => true, |
|
1432 | - 'value' => $GRP_ID, |
|
1433 | - 'css_class' => '', |
|
1434 | - 'format' => '%d', |
|
1435 | - 'db-col' => 'GRP_ID' |
|
1436 | - ); |
|
1425 | + $template_form_fields['ee-msg-grp-id'] = array( |
|
1426 | + 'name' => 'GRP_ID', |
|
1427 | + 'label' => null, |
|
1428 | + 'input' => 'hidden', |
|
1429 | + 'type' => 'int', |
|
1430 | + 'required' => false, |
|
1431 | + 'validation' => true, |
|
1432 | + 'value' => $GRP_ID, |
|
1433 | + 'css_class' => '', |
|
1434 | + 'format' => '%d', |
|
1435 | + 'db-col' => 'GRP_ID' |
|
1436 | + ); |
|
1437 | 1437 | |
1438 | - $template_form_fields['ee-msg-messenger'] = array( |
|
1439 | - 'name' => 'MTP_messenger', |
|
1440 | - 'label' => null, |
|
1441 | - 'input' => 'hidden', |
|
1442 | - 'type' => 'string', |
|
1443 | - 'required' => false, |
|
1444 | - 'validation' => true, |
|
1445 | - 'value' => $message_template_group->messenger(), |
|
1446 | - 'css_class' => '', |
|
1447 | - 'format' => '%s', |
|
1448 | - 'db-col' => 'MTP_messenger' |
|
1449 | - ); |
|
1438 | + $template_form_fields['ee-msg-messenger'] = array( |
|
1439 | + 'name' => 'MTP_messenger', |
|
1440 | + 'label' => null, |
|
1441 | + 'input' => 'hidden', |
|
1442 | + 'type' => 'string', |
|
1443 | + 'required' => false, |
|
1444 | + 'validation' => true, |
|
1445 | + 'value' => $message_template_group->messenger(), |
|
1446 | + 'css_class' => '', |
|
1447 | + 'format' => '%s', |
|
1448 | + 'db-col' => 'MTP_messenger' |
|
1449 | + ); |
|
1450 | 1450 | |
1451 | - $template_form_fields['ee-msg-message-type'] = array( |
|
1452 | - 'name' => 'MTP_message_type', |
|
1453 | - 'label' => null, |
|
1454 | - 'input' => 'hidden', |
|
1455 | - 'type' => 'string', |
|
1456 | - 'required' => false, |
|
1457 | - 'validation' => true, |
|
1458 | - 'value' => $message_template_group->message_type(), |
|
1459 | - 'css_class' => '', |
|
1460 | - 'format' => '%s', |
|
1461 | - 'db-col' => 'MTP_message_type' |
|
1462 | - ); |
|
1451 | + $template_form_fields['ee-msg-message-type'] = array( |
|
1452 | + 'name' => 'MTP_message_type', |
|
1453 | + 'label' => null, |
|
1454 | + 'input' => 'hidden', |
|
1455 | + 'type' => 'string', |
|
1456 | + 'required' => false, |
|
1457 | + 'validation' => true, |
|
1458 | + 'value' => $message_template_group->message_type(), |
|
1459 | + 'css_class' => '', |
|
1460 | + 'format' => '%s', |
|
1461 | + 'db-col' => 'MTP_message_type' |
|
1462 | + ); |
|
1463 | 1463 | |
1464 | - $sidebar_form_fields['ee-msg-is-global'] = array( |
|
1465 | - 'name' => 'MTP_is_global', |
|
1466 | - 'label' => __('Global Template', 'event_espresso'), |
|
1467 | - 'input' => 'hidden', |
|
1468 | - 'type' => 'int', |
|
1469 | - 'required' => false, |
|
1470 | - 'validation' => true, |
|
1471 | - 'value' => $message_template_group->get('MTP_is_global'), |
|
1472 | - 'css_class' => '', |
|
1473 | - 'format' => '%d', |
|
1474 | - 'db-col' => 'MTP_is_global' |
|
1475 | - ); |
|
1464 | + $sidebar_form_fields['ee-msg-is-global'] = array( |
|
1465 | + 'name' => 'MTP_is_global', |
|
1466 | + 'label' => __('Global Template', 'event_espresso'), |
|
1467 | + 'input' => 'hidden', |
|
1468 | + 'type' => 'int', |
|
1469 | + 'required' => false, |
|
1470 | + 'validation' => true, |
|
1471 | + 'value' => $message_template_group->get('MTP_is_global'), |
|
1472 | + 'css_class' => '', |
|
1473 | + 'format' => '%d', |
|
1474 | + 'db-col' => 'MTP_is_global' |
|
1475 | + ); |
|
1476 | 1476 | |
1477 | - $sidebar_form_fields['ee-msg-is-override'] = array( |
|
1478 | - 'name' => 'MTP_is_override', |
|
1479 | - 'label' => __('Override all custom', 'event_espresso'), |
|
1480 | - 'input' => $message_template_group->is_global() ? 'checkbox' : 'hidden', |
|
1481 | - 'type' => 'int', |
|
1482 | - 'required' => false, |
|
1483 | - 'validation' => true, |
|
1484 | - 'value' => $message_template_group->get('MTP_is_override'), |
|
1485 | - 'css_class' => '', |
|
1486 | - 'format' => '%d', |
|
1487 | - 'db-col' => 'MTP_is_override' |
|
1488 | - ); |
|
1477 | + $sidebar_form_fields['ee-msg-is-override'] = array( |
|
1478 | + 'name' => 'MTP_is_override', |
|
1479 | + 'label' => __('Override all custom', 'event_espresso'), |
|
1480 | + 'input' => $message_template_group->is_global() ? 'checkbox' : 'hidden', |
|
1481 | + 'type' => 'int', |
|
1482 | + 'required' => false, |
|
1483 | + 'validation' => true, |
|
1484 | + 'value' => $message_template_group->get('MTP_is_override'), |
|
1485 | + 'css_class' => '', |
|
1486 | + 'format' => '%d', |
|
1487 | + 'db-col' => 'MTP_is_override' |
|
1488 | + ); |
|
1489 | 1489 | |
1490 | - $sidebar_form_fields['ee-msg-is-active'] = array( |
|
1491 | - 'name' => 'MTP_is_active', |
|
1492 | - 'label' => __('Active Template', 'event_espresso'), |
|
1493 | - 'input' => 'hidden', |
|
1494 | - 'type' => 'int', |
|
1495 | - 'required' => false, |
|
1496 | - 'validation' => true, |
|
1497 | - 'value' => $message_template_group->is_active(), |
|
1498 | - 'css_class' => '', |
|
1499 | - 'format' => '%d', |
|
1500 | - 'db-col' => 'MTP_is_active' |
|
1501 | - ); |
|
1490 | + $sidebar_form_fields['ee-msg-is-active'] = array( |
|
1491 | + 'name' => 'MTP_is_active', |
|
1492 | + 'label' => __('Active Template', 'event_espresso'), |
|
1493 | + 'input' => 'hidden', |
|
1494 | + 'type' => 'int', |
|
1495 | + 'required' => false, |
|
1496 | + 'validation' => true, |
|
1497 | + 'value' => $message_template_group->is_active(), |
|
1498 | + 'css_class' => '', |
|
1499 | + 'format' => '%d', |
|
1500 | + 'db-col' => 'MTP_is_active' |
|
1501 | + ); |
|
1502 | 1502 | |
1503 | - $sidebar_form_fields['ee-msg-deleted'] = array( |
|
1504 | - 'name' => 'MTP_deleted', |
|
1505 | - 'label' => null, |
|
1506 | - 'input' => 'hidden', |
|
1507 | - 'type' => 'int', |
|
1508 | - 'required' => false, |
|
1509 | - 'validation' => true, |
|
1510 | - 'value' => $message_template_group->get('MTP_deleted'), |
|
1511 | - 'css_class' => '', |
|
1512 | - 'format' => '%d', |
|
1513 | - 'db-col' => 'MTP_deleted' |
|
1514 | - ); |
|
1515 | - $sidebar_form_fields['ee-msg-author'] = array( |
|
1516 | - 'name' => 'MTP_user_id', |
|
1517 | - 'label' => __('Author', 'event_espresso'), |
|
1518 | - 'input' => 'hidden', |
|
1519 | - 'type' => 'int', |
|
1520 | - 'required' => false, |
|
1521 | - 'validation' => false, |
|
1522 | - 'value' => $message_template_group->user(), |
|
1523 | - 'format' => '%d', |
|
1524 | - 'db-col' => 'MTP_user_id' |
|
1525 | - ); |
|
1503 | + $sidebar_form_fields['ee-msg-deleted'] = array( |
|
1504 | + 'name' => 'MTP_deleted', |
|
1505 | + 'label' => null, |
|
1506 | + 'input' => 'hidden', |
|
1507 | + 'type' => 'int', |
|
1508 | + 'required' => false, |
|
1509 | + 'validation' => true, |
|
1510 | + 'value' => $message_template_group->get('MTP_deleted'), |
|
1511 | + 'css_class' => '', |
|
1512 | + 'format' => '%d', |
|
1513 | + 'db-col' => 'MTP_deleted' |
|
1514 | + ); |
|
1515 | + $sidebar_form_fields['ee-msg-author'] = array( |
|
1516 | + 'name' => 'MTP_user_id', |
|
1517 | + 'label' => __('Author', 'event_espresso'), |
|
1518 | + 'input' => 'hidden', |
|
1519 | + 'type' => 'int', |
|
1520 | + 'required' => false, |
|
1521 | + 'validation' => false, |
|
1522 | + 'value' => $message_template_group->user(), |
|
1523 | + 'format' => '%d', |
|
1524 | + 'db-col' => 'MTP_user_id' |
|
1525 | + ); |
|
1526 | 1526 | |
1527 | - $sidebar_form_fields['ee-msg-route'] = array( |
|
1528 | - 'name' => 'action', |
|
1529 | - 'input' => 'hidden', |
|
1530 | - 'type' => 'string', |
|
1531 | - 'value' => $action |
|
1532 | - ); |
|
1527 | + $sidebar_form_fields['ee-msg-route'] = array( |
|
1528 | + 'name' => 'action', |
|
1529 | + 'input' => 'hidden', |
|
1530 | + 'type' => 'string', |
|
1531 | + 'value' => $action |
|
1532 | + ); |
|
1533 | 1533 | |
1534 | - $sidebar_form_fields['ee-msg-id'] = array( |
|
1535 | - 'name' => 'id', |
|
1536 | - 'input' => 'hidden', |
|
1537 | - 'type' => 'int', |
|
1538 | - 'value' => $GRP_ID |
|
1539 | - ); |
|
1540 | - $sidebar_form_fields['ee-msg-evt-nonce'] = array( |
|
1541 | - 'name' => $action . '_nonce', |
|
1542 | - 'input' => 'hidden', |
|
1543 | - 'type' => 'string', |
|
1544 | - 'value' => wp_create_nonce($action . '_nonce') |
|
1545 | - ); |
|
1534 | + $sidebar_form_fields['ee-msg-id'] = array( |
|
1535 | + 'name' => 'id', |
|
1536 | + 'input' => 'hidden', |
|
1537 | + 'type' => 'int', |
|
1538 | + 'value' => $GRP_ID |
|
1539 | + ); |
|
1540 | + $sidebar_form_fields['ee-msg-evt-nonce'] = array( |
|
1541 | + 'name' => $action . '_nonce', |
|
1542 | + 'input' => 'hidden', |
|
1543 | + 'type' => 'string', |
|
1544 | + 'value' => wp_create_nonce($action . '_nonce') |
|
1545 | + ); |
|
1546 | 1546 | |
1547 | - if (isset($this->_req_data['template_switch']) && $this->_req_data['template_switch']) { |
|
1548 | - $sidebar_form_fields['ee-msg-template-switch'] = array( |
|
1549 | - 'name' => 'template_switch', |
|
1550 | - 'input' => 'hidden', |
|
1551 | - 'type' => 'int', |
|
1552 | - 'value' => 1 |
|
1553 | - ); |
|
1554 | - } |
|
1547 | + if (isset($this->_req_data['template_switch']) && $this->_req_data['template_switch']) { |
|
1548 | + $sidebar_form_fields['ee-msg-template-switch'] = array( |
|
1549 | + 'name' => 'template_switch', |
|
1550 | + 'input' => 'hidden', |
|
1551 | + 'type' => 'int', |
|
1552 | + 'value' => 1 |
|
1553 | + ); |
|
1554 | + } |
|
1555 | 1555 | |
1556 | 1556 | |
1557 | - $template_fields = $this->_generate_admin_form_fields($template_form_fields); |
|
1558 | - $sidebar_fields = $this->_generate_admin_form_fields($sidebar_form_fields); |
|
1557 | + $template_fields = $this->_generate_admin_form_fields($template_form_fields); |
|
1558 | + $sidebar_fields = $this->_generate_admin_form_fields($sidebar_form_fields); |
|
1559 | 1559 | |
1560 | 1560 | |
1561 | - } //end if ( !empty($template_field_structure) ) |
|
1561 | + } //end if ( !empty($template_field_structure) ) |
|
1562 | 1562 | |
1563 | - //set extra content for publish box |
|
1564 | - $this->_template_args['publish_box_extra_content'] = $sidebar_fields; |
|
1565 | - $this->_set_publish_post_box_vars( |
|
1566 | - 'id', |
|
1567 | - $GRP_ID, |
|
1568 | - false, |
|
1569 | - add_query_arg( |
|
1570 | - array('action' => 'global_mtps'), |
|
1571 | - $this->_admin_base_url |
|
1572 | - ) |
|
1573 | - ); |
|
1574 | - |
|
1575 | - //add preview button |
|
1576 | - $preview_url = parent::add_query_args_and_nonce( |
|
1577 | - array( |
|
1578 | - 'message_type' => $message_template_group->message_type(), |
|
1579 | - 'messenger' => $message_template_group->messenger(), |
|
1580 | - 'context' => $context, |
|
1581 | - 'GRP_ID' => $GRP_ID, |
|
1582 | - 'action' => 'preview_message' |
|
1583 | - ), |
|
1584 | - $this->_admin_base_url |
|
1585 | - ); |
|
1586 | - $preview_button = '<a href="' . $preview_url . '" class="button-secondary messages-preview-button">' . __('Preview', |
|
1587 | - 'event_espresso') . '</a>'; |
|
1588 | - |
|
1589 | - |
|
1590 | - //setup context switcher |
|
1591 | - $context_switcher_args = array( |
|
1592 | - 'page' => 'espresso_messages', |
|
1593 | - 'action' => 'edit_message_template', |
|
1594 | - 'id' => $GRP_ID, |
|
1595 | - 'context' => $context, |
|
1596 | - 'extra' => $preview_button |
|
1597 | - ); |
|
1598 | - $this->_set_context_switcher($message_template_group, $context_switcher_args); |
|
1599 | - |
|
1600 | - |
|
1601 | - //main box |
|
1602 | - $this->_template_args['template_fields'] = $template_fields; |
|
1603 | - $this->_template_args['sidebar_box_id'] = 'details'; |
|
1604 | - $this->_template_args['action'] = $action; |
|
1605 | - $this->_template_args['context'] = $context; |
|
1606 | - $this->_template_args['edit_message_template_form_url'] = $edit_message_template_form_url; |
|
1607 | - $this->_template_args['learn_more_about_message_templates_link'] = $this->_learn_more_about_message_templates_link(); |
|
1608 | - |
|
1609 | - |
|
1610 | - $this->_template_args['before_admin_page_content'] = $this->add_context_switcher(); |
|
1611 | - $this->_template_args['before_admin_page_content'] .= $this->_add_form_element_before(); |
|
1612 | - $this->_template_args['after_admin_page_content'] = $this->_add_form_element_after(); |
|
1613 | - |
|
1614 | - $this->_template_path = $this->_template_args['GRP_ID'] |
|
1615 | - ? EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_edit_meta_box.template.php' |
|
1616 | - : EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_add_meta_box.template.php'; |
|
1617 | - |
|
1618 | - //send along EE_Message_Template_Group object for further template use. |
|
1619 | - $this->_template_args['MTP'] = $message_template_group; |
|
1620 | - |
|
1621 | - $this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path, |
|
1622 | - $this->_template_args, true); |
|
1623 | - |
|
1624 | - |
|
1625 | - //finally, let's set the admin_page title |
|
1626 | - $this->_admin_page_title = sprintf(__('Editing %s', 'event_espresso'), $title); |
|
1627 | - |
|
1628 | - |
|
1629 | - //we need to take care of setting the shortcodes property for use elsewhere. |
|
1630 | - $this->_set_shortcodes(); |
|
1631 | - |
|
1632 | - |
|
1633 | - //final template wrapper |
|
1634 | - $this->display_admin_page_with_sidebar(); |
|
1635 | - } |
|
1636 | - |
|
1637 | - |
|
1638 | - public function filter_tinymce_init($mceInit, $editor_id) |
|
1639 | - { |
|
1640 | - return $mceInit; |
|
1641 | - } |
|
1642 | - |
|
1643 | - |
|
1644 | - public function add_context_switcher() |
|
1645 | - { |
|
1646 | - return $this->_context_switcher; |
|
1647 | - } |
|
1648 | - |
|
1649 | - public function _add_form_element_before() |
|
1650 | - { |
|
1651 | - return '<form method="post" action="' . $this->_template_args["edit_message_template_form_url"] . '" id="ee-msg-edit-frm">'; |
|
1652 | - } |
|
1653 | - |
|
1654 | - public function _add_form_element_after() |
|
1655 | - { |
|
1656 | - return '</form>'; |
|
1657 | - } |
|
1658 | - |
|
1659 | - |
|
1660 | - /** |
|
1661 | - * This executes switching the template pack for a message template. |
|
1662 | - * |
|
1663 | - * @since 4.5.0 |
|
1664 | - * |
|
1665 | - */ |
|
1666 | - public function switch_template_pack() |
|
1667 | - { |
|
1668 | - $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0; |
|
1669 | - $template_pack = ! empty($this->_req_data['template_pack']) ? $this->_req_data['template_pack'] : ''; |
|
1670 | - |
|
1671 | - //verify we have needed values. |
|
1672 | - if (empty($GRP_ID) || empty($template_pack)) { |
|
1673 | - $this->_template_args['error'] = true; |
|
1674 | - EE_Error::add_error(__('The required date for switching templates is not available.', 'event_espresso'), |
|
1675 | - __FILE__, __FUNCTION__, __LINE__); |
|
1676 | - } else { |
|
1677 | - //get template, set the new template_pack and then reset to default |
|
1678 | - /** @type EE_Message_Template_Group $message_template_group */ |
|
1679 | - $message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID); |
|
1563 | + //set extra content for publish box |
|
1564 | + $this->_template_args['publish_box_extra_content'] = $sidebar_fields; |
|
1565 | + $this->_set_publish_post_box_vars( |
|
1566 | + 'id', |
|
1567 | + $GRP_ID, |
|
1568 | + false, |
|
1569 | + add_query_arg( |
|
1570 | + array('action' => 'global_mtps'), |
|
1571 | + $this->_admin_base_url |
|
1572 | + ) |
|
1573 | + ); |
|
1574 | + |
|
1575 | + //add preview button |
|
1576 | + $preview_url = parent::add_query_args_and_nonce( |
|
1577 | + array( |
|
1578 | + 'message_type' => $message_template_group->message_type(), |
|
1579 | + 'messenger' => $message_template_group->messenger(), |
|
1580 | + 'context' => $context, |
|
1581 | + 'GRP_ID' => $GRP_ID, |
|
1582 | + 'action' => 'preview_message' |
|
1583 | + ), |
|
1584 | + $this->_admin_base_url |
|
1585 | + ); |
|
1586 | + $preview_button = '<a href="' . $preview_url . '" class="button-secondary messages-preview-button">' . __('Preview', |
|
1587 | + 'event_espresso') . '</a>'; |
|
1588 | + |
|
1589 | + |
|
1590 | + //setup context switcher |
|
1591 | + $context_switcher_args = array( |
|
1592 | + 'page' => 'espresso_messages', |
|
1593 | + 'action' => 'edit_message_template', |
|
1594 | + 'id' => $GRP_ID, |
|
1595 | + 'context' => $context, |
|
1596 | + 'extra' => $preview_button |
|
1597 | + ); |
|
1598 | + $this->_set_context_switcher($message_template_group, $context_switcher_args); |
|
1599 | + |
|
1600 | + |
|
1601 | + //main box |
|
1602 | + $this->_template_args['template_fields'] = $template_fields; |
|
1603 | + $this->_template_args['sidebar_box_id'] = 'details'; |
|
1604 | + $this->_template_args['action'] = $action; |
|
1605 | + $this->_template_args['context'] = $context; |
|
1606 | + $this->_template_args['edit_message_template_form_url'] = $edit_message_template_form_url; |
|
1607 | + $this->_template_args['learn_more_about_message_templates_link'] = $this->_learn_more_about_message_templates_link(); |
|
1608 | + |
|
1609 | + |
|
1610 | + $this->_template_args['before_admin_page_content'] = $this->add_context_switcher(); |
|
1611 | + $this->_template_args['before_admin_page_content'] .= $this->_add_form_element_before(); |
|
1612 | + $this->_template_args['after_admin_page_content'] = $this->_add_form_element_after(); |
|
1613 | + |
|
1614 | + $this->_template_path = $this->_template_args['GRP_ID'] |
|
1615 | + ? EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_edit_meta_box.template.php' |
|
1616 | + : EE_MSG_TEMPLATE_PATH . 'ee_msg_details_main_add_meta_box.template.php'; |
|
1617 | + |
|
1618 | + //send along EE_Message_Template_Group object for further template use. |
|
1619 | + $this->_template_args['MTP'] = $message_template_group; |
|
1620 | + |
|
1621 | + $this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path, |
|
1622 | + $this->_template_args, true); |
|
1623 | + |
|
1624 | + |
|
1625 | + //finally, let's set the admin_page title |
|
1626 | + $this->_admin_page_title = sprintf(__('Editing %s', 'event_espresso'), $title); |
|
1627 | + |
|
1628 | + |
|
1629 | + //we need to take care of setting the shortcodes property for use elsewhere. |
|
1630 | + $this->_set_shortcodes(); |
|
1631 | + |
|
1632 | + |
|
1633 | + //final template wrapper |
|
1634 | + $this->display_admin_page_with_sidebar(); |
|
1635 | + } |
|
1636 | + |
|
1637 | + |
|
1638 | + public function filter_tinymce_init($mceInit, $editor_id) |
|
1639 | + { |
|
1640 | + return $mceInit; |
|
1641 | + } |
|
1642 | + |
|
1643 | + |
|
1644 | + public function add_context_switcher() |
|
1645 | + { |
|
1646 | + return $this->_context_switcher; |
|
1647 | + } |
|
1648 | + |
|
1649 | + public function _add_form_element_before() |
|
1650 | + { |
|
1651 | + return '<form method="post" action="' . $this->_template_args["edit_message_template_form_url"] . '" id="ee-msg-edit-frm">'; |
|
1652 | + } |
|
1653 | + |
|
1654 | + public function _add_form_element_after() |
|
1655 | + { |
|
1656 | + return '</form>'; |
|
1657 | + } |
|
1658 | + |
|
1659 | + |
|
1660 | + /** |
|
1661 | + * This executes switching the template pack for a message template. |
|
1662 | + * |
|
1663 | + * @since 4.5.0 |
|
1664 | + * |
|
1665 | + */ |
|
1666 | + public function switch_template_pack() |
|
1667 | + { |
|
1668 | + $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0; |
|
1669 | + $template_pack = ! empty($this->_req_data['template_pack']) ? $this->_req_data['template_pack'] : ''; |
|
1670 | + |
|
1671 | + //verify we have needed values. |
|
1672 | + if (empty($GRP_ID) || empty($template_pack)) { |
|
1673 | + $this->_template_args['error'] = true; |
|
1674 | + EE_Error::add_error(__('The required date for switching templates is not available.', 'event_espresso'), |
|
1675 | + __FILE__, __FUNCTION__, __LINE__); |
|
1676 | + } else { |
|
1677 | + //get template, set the new template_pack and then reset to default |
|
1678 | + /** @type EE_Message_Template_Group $message_template_group */ |
|
1679 | + $message_template_group = EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID); |
|
1680 | 1680 | |
1681 | - $message_template_group->set_template_pack_name($template_pack); |
|
1682 | - $this->_req_data['msgr'] = $message_template_group->messenger(); |
|
1683 | - $this->_req_data['mt'] = $message_template_group->message_type(); |
|
1681 | + $message_template_group->set_template_pack_name($template_pack); |
|
1682 | + $this->_req_data['msgr'] = $message_template_group->messenger(); |
|
1683 | + $this->_req_data['mt'] = $message_template_group->message_type(); |
|
1684 | 1684 | |
1685 | - $query_args = $this->_reset_to_default_template(); |
|
1685 | + $query_args = $this->_reset_to_default_template(); |
|
1686 | 1686 | |
1687 | - if (empty($query_args['id'])) { |
|
1688 | - EE_Error::add_error( |
|
1689 | - __( |
|
1690 | - 'Something went wrong with switching the template pack. Please try again or contact EE support', |
|
1691 | - 'event_espresso' |
|
1692 | - ), |
|
1693 | - __FILE__, __FUNCTION__, __LINE__ |
|
1694 | - ); |
|
1695 | - $this->_template_args['error'] = true; |
|
1696 | - } else { |
|
1697 | - $template_label = $message_template_group->get_template_pack()->label; |
|
1698 | - $template_pack_labels = $message_template_group->messenger_obj()->get_supports_labels(); |
|
1699 | - EE_Error::add_success( |
|
1700 | - sprintf( |
|
1701 | - __( |
|
1702 | - 'This message template has been successfully switched to use the %1$s %2$s. Please wait while the page reloads with your new template.', |
|
1703 | - 'event_espresso' |
|
1704 | - ), |
|
1705 | - $template_label, |
|
1706 | - $template_pack_labels->template_pack |
|
1707 | - ) |
|
1708 | - ); |
|
1709 | - //generate the redirect url for js. |
|
1710 | - $url = self::add_query_args_and_nonce($query_args, |
|
1711 | - $this->_admin_base_url); |
|
1712 | - $this->_template_args['data']['redirect_url'] = $url; |
|
1713 | - $this->_template_args['success'] = true; |
|
1714 | - } |
|
1687 | + if (empty($query_args['id'])) { |
|
1688 | + EE_Error::add_error( |
|
1689 | + __( |
|
1690 | + 'Something went wrong with switching the template pack. Please try again or contact EE support', |
|
1691 | + 'event_espresso' |
|
1692 | + ), |
|
1693 | + __FILE__, __FUNCTION__, __LINE__ |
|
1694 | + ); |
|
1695 | + $this->_template_args['error'] = true; |
|
1696 | + } else { |
|
1697 | + $template_label = $message_template_group->get_template_pack()->label; |
|
1698 | + $template_pack_labels = $message_template_group->messenger_obj()->get_supports_labels(); |
|
1699 | + EE_Error::add_success( |
|
1700 | + sprintf( |
|
1701 | + __( |
|
1702 | + 'This message template has been successfully switched to use the %1$s %2$s. Please wait while the page reloads with your new template.', |
|
1703 | + 'event_espresso' |
|
1704 | + ), |
|
1705 | + $template_label, |
|
1706 | + $template_pack_labels->template_pack |
|
1707 | + ) |
|
1708 | + ); |
|
1709 | + //generate the redirect url for js. |
|
1710 | + $url = self::add_query_args_and_nonce($query_args, |
|
1711 | + $this->_admin_base_url); |
|
1712 | + $this->_template_args['data']['redirect_url'] = $url; |
|
1713 | + $this->_template_args['success'] = true; |
|
1714 | + } |
|
1715 | 1715 | |
1716 | - $this->_return_json(); |
|
1716 | + $this->_return_json(); |
|
1717 | 1717 | |
1718 | - } |
|
1719 | - } |
|
1720 | - |
|
1721 | - |
|
1722 | - /** |
|
1723 | - * This handles resetting the template for the given messenger/message_type so that users can start from scratch if |
|
1724 | - * they want. |
|
1725 | - * |
|
1726 | - * @access protected |
|
1727 | - * @return array|null |
|
1728 | - */ |
|
1729 | - protected function _reset_to_default_template() |
|
1730 | - { |
|
1731 | - |
|
1732 | - $templates = array(); |
|
1733 | - $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0; |
|
1734 | - //we need to make sure we've got the info we need. |
|
1735 | - if ( ! isset($this->_req_data['msgr'], $this->_req_data['mt'], $this->_req_data['GRP_ID'])) { |
|
1736 | - EE_Error::add_error( |
|
1737 | - __( |
|
1738 | - 'In order to reset the template to its default we require the messenger, message type, and message template GRP_ID to know what is being reset. At least one of these is missing.', |
|
1739 | - 'event_espresso' |
|
1740 | - ), |
|
1741 | - __FILE__, __FUNCTION__, __LINE__ |
|
1742 | - ); |
|
1743 | - } |
|
1744 | - |
|
1745 | - // all templates will be reset to whatever the defaults are |
|
1746 | - // for the global template matching the messenger and message type. |
|
1747 | - $success = ! empty($GRP_ID) ? true : false; |
|
1748 | - |
|
1749 | - if ($success) { |
|
1718 | + } |
|
1719 | + } |
|
1720 | + |
|
1721 | + |
|
1722 | + /** |
|
1723 | + * This handles resetting the template for the given messenger/message_type so that users can start from scratch if |
|
1724 | + * they want. |
|
1725 | + * |
|
1726 | + * @access protected |
|
1727 | + * @return array|null |
|
1728 | + */ |
|
1729 | + protected function _reset_to_default_template() |
|
1730 | + { |
|
1731 | + |
|
1732 | + $templates = array(); |
|
1733 | + $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0; |
|
1734 | + //we need to make sure we've got the info we need. |
|
1735 | + if ( ! isset($this->_req_data['msgr'], $this->_req_data['mt'], $this->_req_data['GRP_ID'])) { |
|
1736 | + EE_Error::add_error( |
|
1737 | + __( |
|
1738 | + 'In order to reset the template to its default we require the messenger, message type, and message template GRP_ID to know what is being reset. At least one of these is missing.', |
|
1739 | + 'event_espresso' |
|
1740 | + ), |
|
1741 | + __FILE__, __FUNCTION__, __LINE__ |
|
1742 | + ); |
|
1743 | + } |
|
1744 | + |
|
1745 | + // all templates will be reset to whatever the defaults are |
|
1746 | + // for the global template matching the messenger and message type. |
|
1747 | + $success = ! empty($GRP_ID) ? true : false; |
|
1748 | + |
|
1749 | + if ($success) { |
|
1750 | 1750 | |
1751 | - //let's first determine if the incoming template is a global template, |
|
1752 | - // if it isn't then we need to get the global template matching messenger and message type. |
|
1753 | - //$MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID( $GRP_ID ); |
|
1751 | + //let's first determine if the incoming template is a global template, |
|
1752 | + // if it isn't then we need to get the global template matching messenger and message type. |
|
1753 | + //$MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID( $GRP_ID ); |
|
1754 | 1754 | |
1755 | 1755 | |
1756 | - //note this is ONLY deleting the template fields (Message Template rows) NOT the message template group. |
|
1757 | - $success = $this->_delete_mtp_permanently($GRP_ID, false); |
|
1756 | + //note this is ONLY deleting the template fields (Message Template rows) NOT the message template group. |
|
1757 | + $success = $this->_delete_mtp_permanently($GRP_ID, false); |
|
1758 | 1758 | |
1759 | - if ($success) { |
|
1760 | - // if successfully deleted, lets generate the new ones. |
|
1761 | - // Note. We set GLOBAL to true, because resets on ANY template |
|
1762 | - // will use the related global template defaults for regeneration. |
|
1763 | - // This means that if a custom template is reset it resets to whatever the related global template is. |
|
1764 | - // HOWEVER, we DO keep the template pack and template variation set |
|
1765 | - // for the current custom template when resetting. |
|
1766 | - $templates = $this->_generate_new_templates( |
|
1767 | - $this->_req_data['msgr'], |
|
1768 | - $this->_req_data['mt'], |
|
1769 | - $GRP_ID, |
|
1770 | - true |
|
1771 | - ); |
|
1772 | - } |
|
1759 | + if ($success) { |
|
1760 | + // if successfully deleted, lets generate the new ones. |
|
1761 | + // Note. We set GLOBAL to true, because resets on ANY template |
|
1762 | + // will use the related global template defaults for regeneration. |
|
1763 | + // This means that if a custom template is reset it resets to whatever the related global template is. |
|
1764 | + // HOWEVER, we DO keep the template pack and template variation set |
|
1765 | + // for the current custom template when resetting. |
|
1766 | + $templates = $this->_generate_new_templates( |
|
1767 | + $this->_req_data['msgr'], |
|
1768 | + $this->_req_data['mt'], |
|
1769 | + $GRP_ID, |
|
1770 | + true |
|
1771 | + ); |
|
1772 | + } |
|
1773 | 1773 | |
1774 | - } |
|
1775 | - |
|
1776 | - //any error messages? |
|
1777 | - if ( ! $success) { |
|
1778 | - EE_Error::add_error( |
|
1779 | - __('Something went wrong with deleting existing templates. Unable to reset to default', |
|
1780 | - 'event_espresso'), |
|
1781 | - __FILE__, __FUNCTION__, __LINE__ |
|
1782 | - ); |
|
1783 | - } |
|
1784 | - |
|
1785 | - //all good, let's add a success message! |
|
1786 | - if ($success && ! empty($templates)) { |
|
1787 | - $templates = $templates[0]; //the info for the template we generated is the first element in the returned array. |
|
1788 | - EE_Error::overwrite_success(); |
|
1789 | - EE_Error::add_success(__('Templates have been reset to defaults.', 'event_espresso')); |
|
1790 | - } |
|
1791 | - |
|
1792 | - |
|
1793 | - $query_args = array( |
|
1794 | - 'id' => isset($templates['GRP_ID']) ? $templates['GRP_ID'] : null, |
|
1795 | - 'context' => isset($templates['MTP_context']) ? $templates['MTP_context'] : null, |
|
1796 | - 'action' => isset($templates['GRP_ID']) ? 'edit_message_template' : 'global_mtps' |
|
1797 | - ); |
|
1798 | - |
|
1799 | - //if called via ajax then we return query args otherwise redirect |
|
1800 | - if (defined('DOING_AJAX') && DOING_AJAX) { |
|
1801 | - return $query_args; |
|
1802 | - } else { |
|
1803 | - $this->_redirect_after_action(false, '', '', $query_args, true); |
|
1774 | + } |
|
1775 | + |
|
1776 | + //any error messages? |
|
1777 | + if ( ! $success) { |
|
1778 | + EE_Error::add_error( |
|
1779 | + __('Something went wrong with deleting existing templates. Unable to reset to default', |
|
1780 | + 'event_espresso'), |
|
1781 | + __FILE__, __FUNCTION__, __LINE__ |
|
1782 | + ); |
|
1783 | + } |
|
1784 | + |
|
1785 | + //all good, let's add a success message! |
|
1786 | + if ($success && ! empty($templates)) { |
|
1787 | + $templates = $templates[0]; //the info for the template we generated is the first element in the returned array. |
|
1788 | + EE_Error::overwrite_success(); |
|
1789 | + EE_Error::add_success(__('Templates have been reset to defaults.', 'event_espresso')); |
|
1790 | + } |
|
1791 | + |
|
1792 | + |
|
1793 | + $query_args = array( |
|
1794 | + 'id' => isset($templates['GRP_ID']) ? $templates['GRP_ID'] : null, |
|
1795 | + 'context' => isset($templates['MTP_context']) ? $templates['MTP_context'] : null, |
|
1796 | + 'action' => isset($templates['GRP_ID']) ? 'edit_message_template' : 'global_mtps' |
|
1797 | + ); |
|
1798 | + |
|
1799 | + //if called via ajax then we return query args otherwise redirect |
|
1800 | + if (defined('DOING_AJAX') && DOING_AJAX) { |
|
1801 | + return $query_args; |
|
1802 | + } else { |
|
1803 | + $this->_redirect_after_action(false, '', '', $query_args, true); |
|
1804 | 1804 | |
1805 | - return null; |
|
1806 | - } |
|
1807 | - } |
|
1808 | - |
|
1809 | - |
|
1810 | - /** |
|
1811 | - * Retrieve and set the message preview for display. |
|
1812 | - * |
|
1813 | - * @param bool $send if TRUE then we are doing an actual TEST send with the results of the preview. |
|
1814 | - * |
|
1815 | - * @return string |
|
1816 | - */ |
|
1817 | - public function _preview_message($send = false) |
|
1818 | - { |
|
1819 | - //first make sure we've got the necessary parameters |
|
1820 | - if ( |
|
1821 | - ! isset( |
|
1822 | - $this->_req_data['message_type'], |
|
1823 | - $this->_req_data['messenger'], |
|
1824 | - $this->_req_data['messenger'], |
|
1825 | - $this->_req_data['GRP_ID'] |
|
1826 | - ) |
|
1827 | - ) { |
|
1828 | - EE_Error::add_error( |
|
1829 | - __('Missing necessary parameters for displaying preview', 'event_espresso'), |
|
1830 | - __FILE__, __FUNCTION__, __LINE__ |
|
1831 | - ); |
|
1832 | - } |
|
1833 | - |
|
1834 | - EE_Registry::instance()->REQ->set('GRP_ID', $this->_req_data['GRP_ID']); |
|
1835 | - |
|
1836 | - |
|
1837 | - //get the preview! |
|
1838 | - $preview = EED_Messages::preview_message($this->_req_data['message_type'], $this->_req_data['context'], |
|
1839 | - $this->_req_data['messenger'], $send); |
|
1840 | - |
|
1841 | - if ($send) { |
|
1842 | - return $preview; |
|
1843 | - } |
|
1844 | - |
|
1845 | - //let's add a button to go back to the edit view |
|
1846 | - $query_args = array( |
|
1847 | - 'id' => $this->_req_data['GRP_ID'], |
|
1848 | - 'context' => $this->_req_data['context'], |
|
1849 | - 'action' => 'edit_message_template' |
|
1850 | - ); |
|
1851 | - $go_back_url = parent::add_query_args_and_nonce($query_args, $this->_admin_base_url); |
|
1852 | - $preview_button = '<a href="' . $go_back_url . '" class="button-secondary messages-preview-go-back-button">' . __('Go Back to Edit', |
|
1853 | - 'event_espresso') . '</a>'; |
|
1854 | - $message_types = $this->get_installed_message_types(); |
|
1855 | - $active_messenger = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']); |
|
1856 | - $active_messenger_label = $active_messenger instanceof EE_messenger |
|
1857 | - ? ucwords($active_messenger->label['singular']) |
|
1858 | - : esc_html__('Unknown Messenger', 'event_espresso'); |
|
1859 | - //let's provide a helpful title for context |
|
1860 | - $preview_title = sprintf( |
|
1861 | - __('Viewing Preview for %s %s Message Template', 'event_espresso'), |
|
1862 | - $active_messenger_label, |
|
1863 | - ucwords($message_types[$this->_req_data['message_type']]->label['singular']) |
|
1864 | - ); |
|
1865 | - //setup display of preview. |
|
1866 | - $this->_admin_page_title = $preview_title; |
|
1867 | - $this->_template_args['admin_page_content'] = $preview_button . '<br />' . stripslashes($preview); |
|
1868 | - $this->_template_args['data']['force_json'] = true; |
|
1869 | - |
|
1870 | - return ''; |
|
1871 | - } |
|
1872 | - |
|
1873 | - |
|
1874 | - /** |
|
1875 | - * The initial _preview_message is on a no headers route. It will optionally call this if necessary otherwise it |
|
1876 | - * gets called automatically. |
|
1877 | - * |
|
1878 | - * @since 4.5.0 |
|
1879 | - * |
|
1880 | - * @return string |
|
1881 | - */ |
|
1882 | - protected function _display_preview_message() |
|
1883 | - { |
|
1884 | - $this->display_admin_page_with_no_sidebar(); |
|
1885 | - } |
|
1886 | - |
|
1887 | - |
|
1888 | - /** |
|
1889 | - * registers metaboxes that should show up on the "edit_message_template" page |
|
1890 | - * |
|
1891 | - * @access protected |
|
1892 | - * @return void |
|
1893 | - */ |
|
1894 | - protected function _register_edit_meta_boxes() |
|
1895 | - { |
|
1896 | - add_meta_box('mtp_valid_shortcodes', __('Valid Shortcodes', 'event_espresso'), |
|
1897 | - array($this, 'shortcode_meta_box'), $this->_current_screen->id, 'side', 'default'); |
|
1898 | - add_meta_box('mtp_extra_actions', __('Extra Actions', 'event_espresso'), array($this, 'extra_actions_meta_box'), |
|
1899 | - $this->_current_screen->id, 'side', 'high'); |
|
1900 | - add_meta_box('mtp_templates', __('Template Styles', 'event_espresso'), array($this, 'template_pack_meta_box'), |
|
1901 | - $this->_current_screen->id, 'side', 'high'); |
|
1902 | - } |
|
1903 | - |
|
1904 | - |
|
1905 | - /** |
|
1906 | - * metabox content for all template pack and variation selection. |
|
1907 | - * |
|
1908 | - * @since 4.5.0 |
|
1909 | - * |
|
1910 | - * @return string |
|
1911 | - */ |
|
1912 | - public function template_pack_meta_box() |
|
1913 | - { |
|
1914 | - $this->_set_message_template_group(); |
|
1915 | - |
|
1916 | - $tp_collection = EEH_MSG_Template::get_template_pack_collection(); |
|
1917 | - |
|
1918 | - $tp_select_values = array(); |
|
1919 | - |
|
1920 | - foreach ($tp_collection as $tp) { |
|
1921 | - //only include template packs that support this messenger and message type! |
|
1922 | - $supports = $tp->get_supports(); |
|
1923 | - if ( |
|
1924 | - ! isset($supports[$this->_message_template_group->messenger()]) |
|
1925 | - || ! in_array( |
|
1926 | - $this->_message_template_group->message_type(), |
|
1927 | - $supports[$this->_message_template_group->messenger()] |
|
1928 | - ) |
|
1929 | - ) { |
|
1930 | - //not supported |
|
1931 | - continue; |
|
1932 | - } |
|
1805 | + return null; |
|
1806 | + } |
|
1807 | + } |
|
1808 | + |
|
1809 | + |
|
1810 | + /** |
|
1811 | + * Retrieve and set the message preview for display. |
|
1812 | + * |
|
1813 | + * @param bool $send if TRUE then we are doing an actual TEST send with the results of the preview. |
|
1814 | + * |
|
1815 | + * @return string |
|
1816 | + */ |
|
1817 | + public function _preview_message($send = false) |
|
1818 | + { |
|
1819 | + //first make sure we've got the necessary parameters |
|
1820 | + if ( |
|
1821 | + ! isset( |
|
1822 | + $this->_req_data['message_type'], |
|
1823 | + $this->_req_data['messenger'], |
|
1824 | + $this->_req_data['messenger'], |
|
1825 | + $this->_req_data['GRP_ID'] |
|
1826 | + ) |
|
1827 | + ) { |
|
1828 | + EE_Error::add_error( |
|
1829 | + __('Missing necessary parameters for displaying preview', 'event_espresso'), |
|
1830 | + __FILE__, __FUNCTION__, __LINE__ |
|
1831 | + ); |
|
1832 | + } |
|
1833 | + |
|
1834 | + EE_Registry::instance()->REQ->set('GRP_ID', $this->_req_data['GRP_ID']); |
|
1835 | + |
|
1836 | + |
|
1837 | + //get the preview! |
|
1838 | + $preview = EED_Messages::preview_message($this->_req_data['message_type'], $this->_req_data['context'], |
|
1839 | + $this->_req_data['messenger'], $send); |
|
1840 | + |
|
1841 | + if ($send) { |
|
1842 | + return $preview; |
|
1843 | + } |
|
1844 | + |
|
1845 | + //let's add a button to go back to the edit view |
|
1846 | + $query_args = array( |
|
1847 | + 'id' => $this->_req_data['GRP_ID'], |
|
1848 | + 'context' => $this->_req_data['context'], |
|
1849 | + 'action' => 'edit_message_template' |
|
1850 | + ); |
|
1851 | + $go_back_url = parent::add_query_args_and_nonce($query_args, $this->_admin_base_url); |
|
1852 | + $preview_button = '<a href="' . $go_back_url . '" class="button-secondary messages-preview-go-back-button">' . __('Go Back to Edit', |
|
1853 | + 'event_espresso') . '</a>'; |
|
1854 | + $message_types = $this->get_installed_message_types(); |
|
1855 | + $active_messenger = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']); |
|
1856 | + $active_messenger_label = $active_messenger instanceof EE_messenger |
|
1857 | + ? ucwords($active_messenger->label['singular']) |
|
1858 | + : esc_html__('Unknown Messenger', 'event_espresso'); |
|
1859 | + //let's provide a helpful title for context |
|
1860 | + $preview_title = sprintf( |
|
1861 | + __('Viewing Preview for %s %s Message Template', 'event_espresso'), |
|
1862 | + $active_messenger_label, |
|
1863 | + ucwords($message_types[$this->_req_data['message_type']]->label['singular']) |
|
1864 | + ); |
|
1865 | + //setup display of preview. |
|
1866 | + $this->_admin_page_title = $preview_title; |
|
1867 | + $this->_template_args['admin_page_content'] = $preview_button . '<br />' . stripslashes($preview); |
|
1868 | + $this->_template_args['data']['force_json'] = true; |
|
1869 | + |
|
1870 | + return ''; |
|
1871 | + } |
|
1872 | + |
|
1873 | + |
|
1874 | + /** |
|
1875 | + * The initial _preview_message is on a no headers route. It will optionally call this if necessary otherwise it |
|
1876 | + * gets called automatically. |
|
1877 | + * |
|
1878 | + * @since 4.5.0 |
|
1879 | + * |
|
1880 | + * @return string |
|
1881 | + */ |
|
1882 | + protected function _display_preview_message() |
|
1883 | + { |
|
1884 | + $this->display_admin_page_with_no_sidebar(); |
|
1885 | + } |
|
1886 | + |
|
1887 | + |
|
1888 | + /** |
|
1889 | + * registers metaboxes that should show up on the "edit_message_template" page |
|
1890 | + * |
|
1891 | + * @access protected |
|
1892 | + * @return void |
|
1893 | + */ |
|
1894 | + protected function _register_edit_meta_boxes() |
|
1895 | + { |
|
1896 | + add_meta_box('mtp_valid_shortcodes', __('Valid Shortcodes', 'event_espresso'), |
|
1897 | + array($this, 'shortcode_meta_box'), $this->_current_screen->id, 'side', 'default'); |
|
1898 | + add_meta_box('mtp_extra_actions', __('Extra Actions', 'event_espresso'), array($this, 'extra_actions_meta_box'), |
|
1899 | + $this->_current_screen->id, 'side', 'high'); |
|
1900 | + add_meta_box('mtp_templates', __('Template Styles', 'event_espresso'), array($this, 'template_pack_meta_box'), |
|
1901 | + $this->_current_screen->id, 'side', 'high'); |
|
1902 | + } |
|
1903 | + |
|
1904 | + |
|
1905 | + /** |
|
1906 | + * metabox content for all template pack and variation selection. |
|
1907 | + * |
|
1908 | + * @since 4.5.0 |
|
1909 | + * |
|
1910 | + * @return string |
|
1911 | + */ |
|
1912 | + public function template_pack_meta_box() |
|
1913 | + { |
|
1914 | + $this->_set_message_template_group(); |
|
1915 | + |
|
1916 | + $tp_collection = EEH_MSG_Template::get_template_pack_collection(); |
|
1917 | + |
|
1918 | + $tp_select_values = array(); |
|
1919 | + |
|
1920 | + foreach ($tp_collection as $tp) { |
|
1921 | + //only include template packs that support this messenger and message type! |
|
1922 | + $supports = $tp->get_supports(); |
|
1923 | + if ( |
|
1924 | + ! isset($supports[$this->_message_template_group->messenger()]) |
|
1925 | + || ! in_array( |
|
1926 | + $this->_message_template_group->message_type(), |
|
1927 | + $supports[$this->_message_template_group->messenger()] |
|
1928 | + ) |
|
1929 | + ) { |
|
1930 | + //not supported |
|
1931 | + continue; |
|
1932 | + } |
|
1933 | 1933 | |
1934 | - $tp_select_values[] = array( |
|
1935 | - 'text' => $tp->label, |
|
1936 | - 'id' => $tp->dbref |
|
1937 | - ); |
|
1938 | - } |
|
1939 | - |
|
1940 | - //if empty $tp_select_values then we make sure default is set because EVERY message type should be supported by the default template pack. This still allows for the odd template pack to override. |
|
1941 | - if (empty($tp_select_values)) { |
|
1942 | - $tp_select_values[] = array( |
|
1943 | - 'text' => __('Default', 'event_espresso'), |
|
1944 | - 'id' => 'default' |
|
1945 | - ); |
|
1946 | - } |
|
1947 | - |
|
1948 | - //setup variation select values for the currently selected template. |
|
1949 | - $variations = $this->_message_template_group->get_template_pack()->get_variations( |
|
1950 | - $this->_message_template_group->messenger(), |
|
1951 | - $this->_message_template_group->message_type() |
|
1952 | - ); |
|
1953 | - $variations_select_values = array(); |
|
1954 | - foreach ($variations as $variation => $label) { |
|
1955 | - $variations_select_values[] = array( |
|
1956 | - 'text' => $label, |
|
1957 | - 'id' => $variation |
|
1958 | - ); |
|
1959 | - } |
|
1960 | - |
|
1961 | - $template_pack_labels = $this->_message_template_group->messenger_obj()->get_supports_labels(); |
|
1962 | - |
|
1963 | - $template_args['template_packs_selector'] = EEH_Form_Fields::select_input( |
|
1964 | - 'MTP_template_pack', |
|
1965 | - $tp_select_values, |
|
1966 | - $this->_message_template_group->get_template_pack_name() |
|
1967 | - ); |
|
1968 | - $template_args['variations_selector'] = EEH_Form_Fields::select_input( |
|
1969 | - 'MTP_template_variation', |
|
1970 | - $variations_select_values, |
|
1971 | - $this->_message_template_group->get_template_pack_variation() |
|
1972 | - ); |
|
1973 | - $template_args['template_pack_label'] = $template_pack_labels->template_pack; |
|
1974 | - $template_args['template_variation_label'] = $template_pack_labels->template_variation; |
|
1975 | - $template_args['template_pack_description'] = $template_pack_labels->template_pack_description; |
|
1976 | - $template_args['template_variation_description'] = $template_pack_labels->template_variation_description; |
|
1977 | - |
|
1978 | - $template = EE_MSG_TEMPLATE_PATH . 'template_pack_and_variations_metabox.template.php'; |
|
1979 | - |
|
1980 | - EEH_Template::display_template($template, $template_args); |
|
1981 | - } |
|
1982 | - |
|
1983 | - |
|
1984 | - /** |
|
1985 | - * This meta box holds any extra actions related to Message Templates |
|
1986 | - * For now, this includes Resetting templates to defaults and sending a test email. |
|
1987 | - * |
|
1988 | - * @access public |
|
1989 | - * @return void |
|
1990 | - * @throws \EE_Error |
|
1991 | - */ |
|
1992 | - public function extra_actions_meta_box() |
|
1993 | - { |
|
1994 | - $template_form_fields = array(); |
|
1995 | - |
|
1996 | - $extra_args = array( |
|
1997 | - 'msgr' => $this->_message_template_group->messenger(), |
|
1998 | - 'mt' => $this->_message_template_group->message_type(), |
|
1999 | - 'GRP_ID' => $this->_message_template_group->GRP_ID() |
|
2000 | - ); |
|
2001 | - //first we need to see if there are any fields |
|
2002 | - $fields = $this->_message_template_group->messenger_obj()->get_test_settings_fields(); |
|
2003 | - |
|
2004 | - if ( ! empty($fields)) { |
|
2005 | - //yup there be fields |
|
2006 | - foreach ($fields as $field => $config) { |
|
2007 | - $field_id = $this->_message_template_group->messenger() . '_' . $field; |
|
2008 | - $existing = $this->_message_template_group->messenger_obj()->get_existing_test_settings(); |
|
2009 | - $default = isset($config['default']) ? $config['default'] : ''; |
|
2010 | - $default = isset($config['value']) ? $config['value'] : $default; |
|
1934 | + $tp_select_values[] = array( |
|
1935 | + 'text' => $tp->label, |
|
1936 | + 'id' => $tp->dbref |
|
1937 | + ); |
|
1938 | + } |
|
1939 | + |
|
1940 | + //if empty $tp_select_values then we make sure default is set because EVERY message type should be supported by the default template pack. This still allows for the odd template pack to override. |
|
1941 | + if (empty($tp_select_values)) { |
|
1942 | + $tp_select_values[] = array( |
|
1943 | + 'text' => __('Default', 'event_espresso'), |
|
1944 | + 'id' => 'default' |
|
1945 | + ); |
|
1946 | + } |
|
1947 | + |
|
1948 | + //setup variation select values for the currently selected template. |
|
1949 | + $variations = $this->_message_template_group->get_template_pack()->get_variations( |
|
1950 | + $this->_message_template_group->messenger(), |
|
1951 | + $this->_message_template_group->message_type() |
|
1952 | + ); |
|
1953 | + $variations_select_values = array(); |
|
1954 | + foreach ($variations as $variation => $label) { |
|
1955 | + $variations_select_values[] = array( |
|
1956 | + 'text' => $label, |
|
1957 | + 'id' => $variation |
|
1958 | + ); |
|
1959 | + } |
|
1960 | + |
|
1961 | + $template_pack_labels = $this->_message_template_group->messenger_obj()->get_supports_labels(); |
|
1962 | + |
|
1963 | + $template_args['template_packs_selector'] = EEH_Form_Fields::select_input( |
|
1964 | + 'MTP_template_pack', |
|
1965 | + $tp_select_values, |
|
1966 | + $this->_message_template_group->get_template_pack_name() |
|
1967 | + ); |
|
1968 | + $template_args['variations_selector'] = EEH_Form_Fields::select_input( |
|
1969 | + 'MTP_template_variation', |
|
1970 | + $variations_select_values, |
|
1971 | + $this->_message_template_group->get_template_pack_variation() |
|
1972 | + ); |
|
1973 | + $template_args['template_pack_label'] = $template_pack_labels->template_pack; |
|
1974 | + $template_args['template_variation_label'] = $template_pack_labels->template_variation; |
|
1975 | + $template_args['template_pack_description'] = $template_pack_labels->template_pack_description; |
|
1976 | + $template_args['template_variation_description'] = $template_pack_labels->template_variation_description; |
|
1977 | + |
|
1978 | + $template = EE_MSG_TEMPLATE_PATH . 'template_pack_and_variations_metabox.template.php'; |
|
1979 | + |
|
1980 | + EEH_Template::display_template($template, $template_args); |
|
1981 | + } |
|
1982 | + |
|
1983 | + |
|
1984 | + /** |
|
1985 | + * This meta box holds any extra actions related to Message Templates |
|
1986 | + * For now, this includes Resetting templates to defaults and sending a test email. |
|
1987 | + * |
|
1988 | + * @access public |
|
1989 | + * @return void |
|
1990 | + * @throws \EE_Error |
|
1991 | + */ |
|
1992 | + public function extra_actions_meta_box() |
|
1993 | + { |
|
1994 | + $template_form_fields = array(); |
|
1995 | + |
|
1996 | + $extra_args = array( |
|
1997 | + 'msgr' => $this->_message_template_group->messenger(), |
|
1998 | + 'mt' => $this->_message_template_group->message_type(), |
|
1999 | + 'GRP_ID' => $this->_message_template_group->GRP_ID() |
|
2000 | + ); |
|
2001 | + //first we need to see if there are any fields |
|
2002 | + $fields = $this->_message_template_group->messenger_obj()->get_test_settings_fields(); |
|
2003 | + |
|
2004 | + if ( ! empty($fields)) { |
|
2005 | + //yup there be fields |
|
2006 | + foreach ($fields as $field => $config) { |
|
2007 | + $field_id = $this->_message_template_group->messenger() . '_' . $field; |
|
2008 | + $existing = $this->_message_template_group->messenger_obj()->get_existing_test_settings(); |
|
2009 | + $default = isset($config['default']) ? $config['default'] : ''; |
|
2010 | + $default = isset($config['value']) ? $config['value'] : $default; |
|
2011 | 2011 | |
2012 | - // if type is hidden and the value is empty |
|
2013 | - // something may have gone wrong so let's correct with the defaults |
|
2014 | - $fix = $config['input'] === 'hidden' && isset($existing[$field]) && empty($existing[$field]) |
|
2015 | - ? $default |
|
2016 | - : ''; |
|
2017 | - $existing[$field] = isset($existing[$field]) && empty($fix) |
|
2018 | - ? $existing[$field] |
|
2019 | - : $fix; |
|
2012 | + // if type is hidden and the value is empty |
|
2013 | + // something may have gone wrong so let's correct with the defaults |
|
2014 | + $fix = $config['input'] === 'hidden' && isset($existing[$field]) && empty($existing[$field]) |
|
2015 | + ? $default |
|
2016 | + : ''; |
|
2017 | + $existing[$field] = isset($existing[$field]) && empty($fix) |
|
2018 | + ? $existing[$field] |
|
2019 | + : $fix; |
|
2020 | 2020 | |
2021 | - $template_form_fields[$field_id] = array( |
|
2022 | - 'name' => 'test_settings_fld[' . $field . ']', |
|
2023 | - 'label' => $config['label'], |
|
2024 | - 'input' => $config['input'], |
|
2025 | - 'type' => $config['type'], |
|
2026 | - 'required' => $config['required'], |
|
2027 | - 'validation' => $config['validation'], |
|
2028 | - 'value' => isset($existing[$field]) ? $existing[$field] : $default, |
|
2029 | - 'css_class' => $config['css_class'], |
|
2030 | - 'options' => isset($config['options']) ? $config['options'] : array(), |
|
2031 | - 'default' => $default, |
|
2032 | - 'format' => $config['format'] |
|
2033 | - ); |
|
2034 | - } |
|
2035 | - } |
|
2036 | - |
|
2037 | - $test_settings_fields = ! empty($template_form_fields) |
|
2038 | - ? $this->_generate_admin_form_fields($template_form_fields, 'string', 'ee_tst_settings_flds') |
|
2039 | - : ''; |
|
2040 | - |
|
2041 | - $test_settings_html = ''; |
|
2042 | - //print out $test_settings_fields |
|
2043 | - if ( ! empty($test_settings_fields)) { |
|
2044 | - echo $test_settings_fields; |
|
2045 | - $test_settings_html = '<input type="submit" class="button-primary mtp-test-button alignright" '; |
|
2046 | - $test_settings_html .= 'name="test_button" value="'; |
|
2047 | - $test_settings_html .= __('Test Send', 'event_espresso'); |
|
2048 | - $test_settings_html .= '" /><div style="clear:both"></div>'; |
|
2049 | - } |
|
2050 | - |
|
2051 | - //and button |
|
2052 | - $test_settings_html .= '<p>' . __('Need to reset this message type and start over?', 'event_espresso') . '</p>'; |
|
2053 | - $test_settings_html .= '<div class="publishing-action alignright resetbutton">'; |
|
2054 | - $test_settings_html .= $this->get_action_link_or_button( |
|
2055 | - 'reset_to_default', |
|
2056 | - 'reset', |
|
2057 | - $extra_args, |
|
2058 | - 'button-primary reset-default-button' |
|
2059 | - ); |
|
2060 | - $test_settings_html .= '</div><div style="clear:both"></div>'; |
|
2061 | - echo $test_settings_html; |
|
2062 | - } |
|
2063 | - |
|
2064 | - |
|
2065 | - /** |
|
2066 | - * This returns the shortcode selector skeleton for a given context and field. |
|
2067 | - * |
|
2068 | - * @since 4.9.rc.000 |
|
2069 | - * |
|
2070 | - * @param string $field The name of the field retrieving shortcodes for. |
|
2071 | - * @param string $linked_input_id The css id of the input that the shortcodes get added to. |
|
2072 | - * |
|
2073 | - * @return string |
|
2074 | - */ |
|
2075 | - protected function _get_shortcode_selector($field, $linked_input_id) |
|
2076 | - { |
|
2077 | - $template_args = array( |
|
2078 | - 'shortcodes' => $this->_get_shortcodes(array($field), true), |
|
2079 | - 'fieldname' => $field, |
|
2080 | - 'linked_input_id' => $linked_input_id |
|
2081 | - ); |
|
2082 | - |
|
2083 | - return EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'shortcode_selector_skeleton.template.php', |
|
2084 | - $template_args, true); |
|
2085 | - } |
|
2086 | - |
|
2087 | - |
|
2088 | - /** |
|
2089 | - * This just takes care of returning the meta box content for shortcodes (only used on the edit message template |
|
2090 | - * page) |
|
2091 | - * |
|
2092 | - * @access public |
|
2093 | - * @return void |
|
2094 | - */ |
|
2095 | - public function shortcode_meta_box() |
|
2096 | - { |
|
2097 | - $shortcodes = $this->_get_shortcodes(array(), false); //just make sure shortcodes property is set |
|
2098 | - //$messenger = $this->_message_template_group->messenger_obj(); |
|
2099 | - //now let's set the content depending on the status of the shortcodes array |
|
2100 | - if (empty($shortcodes)) { |
|
2101 | - $content = '<p>' . __('There are no valid shortcodes available', 'event_espresso') . '</p>'; |
|
2102 | - echo $content; |
|
2103 | - } else { |
|
2104 | - //$alt = 0; |
|
2105 | - ?> |
|
2021 | + $template_form_fields[$field_id] = array( |
|
2022 | + 'name' => 'test_settings_fld[' . $field . ']', |
|
2023 | + 'label' => $config['label'], |
|
2024 | + 'input' => $config['input'], |
|
2025 | + 'type' => $config['type'], |
|
2026 | + 'required' => $config['required'], |
|
2027 | + 'validation' => $config['validation'], |
|
2028 | + 'value' => isset($existing[$field]) ? $existing[$field] : $default, |
|
2029 | + 'css_class' => $config['css_class'], |
|
2030 | + 'options' => isset($config['options']) ? $config['options'] : array(), |
|
2031 | + 'default' => $default, |
|
2032 | + 'format' => $config['format'] |
|
2033 | + ); |
|
2034 | + } |
|
2035 | + } |
|
2036 | + |
|
2037 | + $test_settings_fields = ! empty($template_form_fields) |
|
2038 | + ? $this->_generate_admin_form_fields($template_form_fields, 'string', 'ee_tst_settings_flds') |
|
2039 | + : ''; |
|
2040 | + |
|
2041 | + $test_settings_html = ''; |
|
2042 | + //print out $test_settings_fields |
|
2043 | + if ( ! empty($test_settings_fields)) { |
|
2044 | + echo $test_settings_fields; |
|
2045 | + $test_settings_html = '<input type="submit" class="button-primary mtp-test-button alignright" '; |
|
2046 | + $test_settings_html .= 'name="test_button" value="'; |
|
2047 | + $test_settings_html .= __('Test Send', 'event_espresso'); |
|
2048 | + $test_settings_html .= '" /><div style="clear:both"></div>'; |
|
2049 | + } |
|
2050 | + |
|
2051 | + //and button |
|
2052 | + $test_settings_html .= '<p>' . __('Need to reset this message type and start over?', 'event_espresso') . '</p>'; |
|
2053 | + $test_settings_html .= '<div class="publishing-action alignright resetbutton">'; |
|
2054 | + $test_settings_html .= $this->get_action_link_or_button( |
|
2055 | + 'reset_to_default', |
|
2056 | + 'reset', |
|
2057 | + $extra_args, |
|
2058 | + 'button-primary reset-default-button' |
|
2059 | + ); |
|
2060 | + $test_settings_html .= '</div><div style="clear:both"></div>'; |
|
2061 | + echo $test_settings_html; |
|
2062 | + } |
|
2063 | + |
|
2064 | + |
|
2065 | + /** |
|
2066 | + * This returns the shortcode selector skeleton for a given context and field. |
|
2067 | + * |
|
2068 | + * @since 4.9.rc.000 |
|
2069 | + * |
|
2070 | + * @param string $field The name of the field retrieving shortcodes for. |
|
2071 | + * @param string $linked_input_id The css id of the input that the shortcodes get added to. |
|
2072 | + * |
|
2073 | + * @return string |
|
2074 | + */ |
|
2075 | + protected function _get_shortcode_selector($field, $linked_input_id) |
|
2076 | + { |
|
2077 | + $template_args = array( |
|
2078 | + 'shortcodes' => $this->_get_shortcodes(array($field), true), |
|
2079 | + 'fieldname' => $field, |
|
2080 | + 'linked_input_id' => $linked_input_id |
|
2081 | + ); |
|
2082 | + |
|
2083 | + return EEH_Template::display_template(EE_MSG_TEMPLATE_PATH . 'shortcode_selector_skeleton.template.php', |
|
2084 | + $template_args, true); |
|
2085 | + } |
|
2086 | + |
|
2087 | + |
|
2088 | + /** |
|
2089 | + * This just takes care of returning the meta box content for shortcodes (only used on the edit message template |
|
2090 | + * page) |
|
2091 | + * |
|
2092 | + * @access public |
|
2093 | + * @return void |
|
2094 | + */ |
|
2095 | + public function shortcode_meta_box() |
|
2096 | + { |
|
2097 | + $shortcodes = $this->_get_shortcodes(array(), false); //just make sure shortcodes property is set |
|
2098 | + //$messenger = $this->_message_template_group->messenger_obj(); |
|
2099 | + //now let's set the content depending on the status of the shortcodes array |
|
2100 | + if (empty($shortcodes)) { |
|
2101 | + $content = '<p>' . __('There are no valid shortcodes available', 'event_espresso') . '</p>'; |
|
2102 | + echo $content; |
|
2103 | + } else { |
|
2104 | + //$alt = 0; |
|
2105 | + ?> |
|
2106 | 2106 | <div |
2107 | 2107 | style="float:right; margin-top:10px"><?php echo $this->_get_help_tab_link('message_template_shortcodes'); ?></div> |
2108 | 2108 | <p class="small-text"><?php printf(__('You can view the shortcodes usable in your template by clicking the %s icon next to each field.', |
2109 | - 'event_espresso'), '<span class="dashicons dashicons-menu"></span>'); ?></p> |
|
2109 | + 'event_espresso'), '<span class="dashicons dashicons-menu"></span>'); ?></p> |
|
2110 | 2110 | <?php |
2111 | - } |
|
2112 | - |
|
2113 | - |
|
2114 | - } |
|
2115 | - |
|
2116 | - |
|
2117 | - /** |
|
2118 | - * used to set the $_shortcodes property for when its needed elsewhere. |
|
2119 | - * |
|
2120 | - * @access protected |
|
2121 | - * @return void |
|
2122 | - */ |
|
2123 | - protected function _set_shortcodes() |
|
2124 | - { |
|
2125 | - |
|
2126 | - //no need to run this if the property is already set |
|
2127 | - if ( ! empty($this->_shortcodes)) { |
|
2128 | - return; |
|
2129 | - } |
|
2130 | - |
|
2131 | - $this->_shortcodes = $this->_get_shortcodes(); |
|
2132 | - } |
|
2133 | - |
|
2134 | - |
|
2135 | - /** |
|
2136 | - * get's all shortcodes for a given template group. (typically used by _set_shortcodes to set the $_shortcodes |
|
2137 | - * property) |
|
2138 | - * |
|
2139 | - * @access protected |
|
2140 | - * |
|
2141 | - * @param array $fields include an array of specific field names that you want to be used to get the shortcodes |
|
2142 | - * for. Defaults to all (for the given context) |
|
2143 | - * @param boolean $merged Whether to merge all the shortcodes into one list of unique shortcodes |
|
2144 | - * |
|
2145 | - * @return array Shortcodes indexed by fieldname and the an array of shortcode/label pairs OR if merged is |
|
2146 | - * true just an array of shortcode/label pairs. |
|
2147 | - */ |
|
2148 | - protected function _get_shortcodes($fields = array(), $merged = true) |
|
2149 | - { |
|
2150 | - $this->_set_message_template_group(); |
|
2151 | - |
|
2152 | - //we need the messenger and message template to retrieve the valid shortcodes array. |
|
2153 | - $GRP_ID = isset($this->_req_data['id']) && ! empty($this->_req_data['id']) ? absint($this->_req_data['id']) : false; |
|
2154 | - $context = isset($this->_req_data['context']) ? $this->_req_data['context'] : key($this->_message_template_group->contexts_config()); |
|
2155 | - |
|
2156 | - return ! empty($GRP_ID) ? $this->_message_template_group->get_shortcodes($context, $fields, $merged) : array(); |
|
2157 | - } |
|
2158 | - |
|
2159 | - |
|
2160 | - /** |
|
2161 | - * This sets the _message_template property (containing the called message_template object) |
|
2162 | - * |
|
2163 | - * @access protected |
|
2164 | - * @return void |
|
2165 | - */ |
|
2166 | - protected function _set_message_template_group() |
|
2167 | - { |
|
2168 | - |
|
2169 | - if ( ! empty($this->_message_template_group)) { |
|
2170 | - return; |
|
2171 | - } //get out if this is already set. |
|
2172 | - |
|
2173 | - $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? absint($this->_req_data['GRP_ID']) : false; |
|
2174 | - $GRP_ID = empty($GRP_ID) && ! empty($this->_req_data['id']) ? $this->_req_data['id'] : $GRP_ID; |
|
2175 | - |
|
2176 | - //let's get the message templates |
|
2177 | - $MTP = EEM_Message_Template_Group::instance(); |
|
2178 | - |
|
2179 | - if (empty($GRP_ID)) { |
|
2180 | - $this->_message_template_group = $MTP->create_default_object(); |
|
2181 | - } else { |
|
2182 | - $this->_message_template_group = $MTP->get_one_by_ID($GRP_ID); |
|
2183 | - } |
|
2184 | - |
|
2185 | - $this->_template_pack = $this->_message_template_group->get_template_pack(); |
|
2186 | - $this->_variation = $this->_message_template_group->get_template_pack_variation(); |
|
2187 | - |
|
2188 | - } |
|
2189 | - |
|
2190 | - |
|
2191 | - /** |
|
2192 | - * sets up a context switcher for edit forms |
|
2193 | - * |
|
2194 | - * @access protected |
|
2195 | - * |
|
2196 | - * @param EE_Message_Template_Group $template_group_object the template group object being displayed on the form |
|
2197 | - * @param array $args various things the context switcher needs. |
|
2198 | - * |
|
2199 | - */ |
|
2200 | - protected function _set_context_switcher(EE_Message_Template_Group $template_group_object, $args) |
|
2201 | - { |
|
2202 | - $context_details = $template_group_object->contexts_config(); |
|
2203 | - $context_label = $template_group_object->context_label(); |
|
2204 | - ob_start(); |
|
2205 | - ?> |
|
2111 | + } |
|
2112 | + |
|
2113 | + |
|
2114 | + } |
|
2115 | + |
|
2116 | + |
|
2117 | + /** |
|
2118 | + * used to set the $_shortcodes property for when its needed elsewhere. |
|
2119 | + * |
|
2120 | + * @access protected |
|
2121 | + * @return void |
|
2122 | + */ |
|
2123 | + protected function _set_shortcodes() |
|
2124 | + { |
|
2125 | + |
|
2126 | + //no need to run this if the property is already set |
|
2127 | + if ( ! empty($this->_shortcodes)) { |
|
2128 | + return; |
|
2129 | + } |
|
2130 | + |
|
2131 | + $this->_shortcodes = $this->_get_shortcodes(); |
|
2132 | + } |
|
2133 | + |
|
2134 | + |
|
2135 | + /** |
|
2136 | + * get's all shortcodes for a given template group. (typically used by _set_shortcodes to set the $_shortcodes |
|
2137 | + * property) |
|
2138 | + * |
|
2139 | + * @access protected |
|
2140 | + * |
|
2141 | + * @param array $fields include an array of specific field names that you want to be used to get the shortcodes |
|
2142 | + * for. Defaults to all (for the given context) |
|
2143 | + * @param boolean $merged Whether to merge all the shortcodes into one list of unique shortcodes |
|
2144 | + * |
|
2145 | + * @return array Shortcodes indexed by fieldname and the an array of shortcode/label pairs OR if merged is |
|
2146 | + * true just an array of shortcode/label pairs. |
|
2147 | + */ |
|
2148 | + protected function _get_shortcodes($fields = array(), $merged = true) |
|
2149 | + { |
|
2150 | + $this->_set_message_template_group(); |
|
2151 | + |
|
2152 | + //we need the messenger and message template to retrieve the valid shortcodes array. |
|
2153 | + $GRP_ID = isset($this->_req_data['id']) && ! empty($this->_req_data['id']) ? absint($this->_req_data['id']) : false; |
|
2154 | + $context = isset($this->_req_data['context']) ? $this->_req_data['context'] : key($this->_message_template_group->contexts_config()); |
|
2155 | + |
|
2156 | + return ! empty($GRP_ID) ? $this->_message_template_group->get_shortcodes($context, $fields, $merged) : array(); |
|
2157 | + } |
|
2158 | + |
|
2159 | + |
|
2160 | + /** |
|
2161 | + * This sets the _message_template property (containing the called message_template object) |
|
2162 | + * |
|
2163 | + * @access protected |
|
2164 | + * @return void |
|
2165 | + */ |
|
2166 | + protected function _set_message_template_group() |
|
2167 | + { |
|
2168 | + |
|
2169 | + if ( ! empty($this->_message_template_group)) { |
|
2170 | + return; |
|
2171 | + } //get out if this is already set. |
|
2172 | + |
|
2173 | + $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? absint($this->_req_data['GRP_ID']) : false; |
|
2174 | + $GRP_ID = empty($GRP_ID) && ! empty($this->_req_data['id']) ? $this->_req_data['id'] : $GRP_ID; |
|
2175 | + |
|
2176 | + //let's get the message templates |
|
2177 | + $MTP = EEM_Message_Template_Group::instance(); |
|
2178 | + |
|
2179 | + if (empty($GRP_ID)) { |
|
2180 | + $this->_message_template_group = $MTP->create_default_object(); |
|
2181 | + } else { |
|
2182 | + $this->_message_template_group = $MTP->get_one_by_ID($GRP_ID); |
|
2183 | + } |
|
2184 | + |
|
2185 | + $this->_template_pack = $this->_message_template_group->get_template_pack(); |
|
2186 | + $this->_variation = $this->_message_template_group->get_template_pack_variation(); |
|
2187 | + |
|
2188 | + } |
|
2189 | + |
|
2190 | + |
|
2191 | + /** |
|
2192 | + * sets up a context switcher for edit forms |
|
2193 | + * |
|
2194 | + * @access protected |
|
2195 | + * |
|
2196 | + * @param EE_Message_Template_Group $template_group_object the template group object being displayed on the form |
|
2197 | + * @param array $args various things the context switcher needs. |
|
2198 | + * |
|
2199 | + */ |
|
2200 | + protected function _set_context_switcher(EE_Message_Template_Group $template_group_object, $args) |
|
2201 | + { |
|
2202 | + $context_details = $template_group_object->contexts_config(); |
|
2203 | + $context_label = $template_group_object->context_label(); |
|
2204 | + ob_start(); |
|
2205 | + ?> |
|
2206 | 2206 | <div class="ee-msg-switcher-container"> |
2207 | 2207 | <form method="get" action="<?php echo EE_MSG_ADMIN_URL; ?>" id="ee-msg-context-switcher-frm"> |
2208 | 2208 | <?php |
2209 | - foreach ($args as $name => $value) { |
|
2210 | - if ($name == 'context' || empty($value) || $name == 'extra') { |
|
2211 | - continue; |
|
2212 | - } |
|
2213 | - ?> |
|
2209 | + foreach ($args as $name => $value) { |
|
2210 | + if ($name == 'context' || empty($value) || $name == 'extra') { |
|
2211 | + continue; |
|
2212 | + } |
|
2213 | + ?> |
|
2214 | 2214 | <input type="hidden" name="<?php echo $name; ?>" value="<?php echo $value; ?>"/> |
2215 | 2215 | <?php |
2216 | - } |
|
2217 | - //setup nonce_url |
|
2218 | - wp_nonce_field($args['action'] . '_nonce', $args['action'] . '_nonce', false); |
|
2219 | - ?> |
|
2216 | + } |
|
2217 | + //setup nonce_url |
|
2218 | + wp_nonce_field($args['action'] . '_nonce', $args['action'] . '_nonce', false); |
|
2219 | + ?> |
|
2220 | 2220 | <select name="context"> |
2221 | 2221 | <?php |
2222 | - $context_templates = $template_group_object->context_templates(); |
|
2223 | - if (is_array($context_templates)) : |
|
2224 | - foreach ($context_templates as $context => $template_fields) : |
|
2225 | - $checked = ($context == $args['context']) ? 'selected="selected"' : ''; |
|
2226 | - ?> |
|
2222 | + $context_templates = $template_group_object->context_templates(); |
|
2223 | + if (is_array($context_templates)) : |
|
2224 | + foreach ($context_templates as $context => $template_fields) : |
|
2225 | + $checked = ($context == $args['context']) ? 'selected="selected"' : ''; |
|
2226 | + ?> |
|
2227 | 2227 | <option value="<?php echo $context; ?>" <?php echo $checked; ?>> |
2228 | 2228 | <?php echo $context_details[$context]['label']; ?> |
2229 | 2229 | </option> |
@@ -2236,1560 +2236,1560 @@ discard block |
||
2236 | 2236 | <?php echo $args['extra']; ?> |
2237 | 2237 | </div> <!-- end .ee-msg-switcher-container --> |
2238 | 2238 | <?php |
2239 | - $output = ob_get_contents(); |
|
2240 | - ob_clean(); |
|
2241 | - $this->_context_switcher = $output; |
|
2242 | - } |
|
2243 | - |
|
2244 | - |
|
2245 | - /** |
|
2246 | - * utility for sanitizing new values coming in. |
|
2247 | - * Note: this is only used when updating a context. |
|
2248 | - * |
|
2249 | - * @access protected |
|
2250 | - * |
|
2251 | - * @param int $index This helps us know which template field to select from the request array. |
|
2252 | - * |
|
2253 | - * @return array |
|
2254 | - */ |
|
2255 | - protected function _set_message_template_column_values($index) |
|
2256 | - { |
|
2257 | - if (is_array($this->_req_data['MTP_template_fields'][$index]['content'])) { |
|
2258 | - foreach ($this->_req_data['MTP_template_fields'][$index]['content'] as $field => $value) { |
|
2259 | - $this->_req_data['MTP_template_fields'][$index]['content'][$field] = $value; |
|
2260 | - } |
|
2261 | - } /*else { |
|
2239 | + $output = ob_get_contents(); |
|
2240 | + ob_clean(); |
|
2241 | + $this->_context_switcher = $output; |
|
2242 | + } |
|
2243 | + |
|
2244 | + |
|
2245 | + /** |
|
2246 | + * utility for sanitizing new values coming in. |
|
2247 | + * Note: this is only used when updating a context. |
|
2248 | + * |
|
2249 | + * @access protected |
|
2250 | + * |
|
2251 | + * @param int $index This helps us know which template field to select from the request array. |
|
2252 | + * |
|
2253 | + * @return array |
|
2254 | + */ |
|
2255 | + protected function _set_message_template_column_values($index) |
|
2256 | + { |
|
2257 | + if (is_array($this->_req_data['MTP_template_fields'][$index]['content'])) { |
|
2258 | + foreach ($this->_req_data['MTP_template_fields'][$index]['content'] as $field => $value) { |
|
2259 | + $this->_req_data['MTP_template_fields'][$index]['content'][$field] = $value; |
|
2260 | + } |
|
2261 | + } /*else { |
|
2262 | 2262 | $this->_req_data['MTP_template_fields'][$index]['content'] = $this->_req_data['MTP_template_fields'][$index]['content']; |
2263 | 2263 | }*/ |
2264 | 2264 | |
2265 | 2265 | |
2266 | - $set_column_values = array( |
|
2267 | - 'MTP_ID' => absint($this->_req_data['MTP_template_fields'][$index]['MTP_ID']), |
|
2268 | - 'GRP_ID' => absint($this->_req_data['GRP_ID']), |
|
2269 | - 'MTP_user_id' => absint($this->_req_data['MTP_user_id']), |
|
2270 | - 'MTP_messenger' => strtolower($this->_req_data['MTP_messenger']), |
|
2271 | - 'MTP_message_type' => strtolower($this->_req_data['MTP_message_type']), |
|
2272 | - 'MTP_template_field' => strtolower($this->_req_data['MTP_template_fields'][$index]['name']), |
|
2273 | - 'MTP_context' => strtolower($this->_req_data['MTP_context']), |
|
2274 | - 'MTP_content' => $this->_req_data['MTP_template_fields'][$index]['content'], |
|
2275 | - 'MTP_is_global' => isset($this->_req_data['MTP_is_global']) |
|
2276 | - ? absint($this->_req_data['MTP_is_global']) |
|
2277 | - : 0, |
|
2278 | - 'MTP_is_override' => isset($this->_req_data['MTP_is_override']) |
|
2279 | - ? absint($this->_req_data['MTP_is_override']) |
|
2280 | - : 0, |
|
2281 | - 'MTP_deleted' => absint($this->_req_data['MTP_deleted']), |
|
2282 | - 'MTP_is_active' => absint($this->_req_data['MTP_is_active']) |
|
2283 | - ); |
|
2284 | - |
|
2285 | - |
|
2286 | - return $set_column_values; |
|
2287 | - } |
|
2288 | - |
|
2289 | - |
|
2290 | - protected function _insert_or_update_message_template($new = false) |
|
2291 | - { |
|
2292 | - |
|
2293 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
2294 | - $success = 0; |
|
2295 | - $override = false; |
|
2296 | - |
|
2297 | - //setup notices description |
|
2298 | - $messenger_slug = ! empty($this->_req_data['MTP_messenger']) ? $this->_req_data['MTP_messenger'] : ''; |
|
2299 | - |
|
2300 | - //need the message type and messenger objects to be able to use the labels for the notices |
|
2301 | - $messenger_object = $this->_message_resource_manager->get_messenger($messenger_slug); |
|
2302 | - $messenger_label = $messenger_object instanceof EE_messenger ? ucwords($messenger_object->label['singular']) : ''; |
|
2303 | - |
|
2304 | - $message_type_slug = ! empty($this->_req_data['MTP_message_type']) ? $this->_req_data['MTP_message_type'] : ''; |
|
2305 | - $message_type_object = $this->_message_resource_manager->get_message_type($message_type_slug); |
|
2306 | - |
|
2307 | - $message_type_label = $message_type_object instanceof EE_message_type |
|
2308 | - ? ucwords($message_type_object->label['singular']) |
|
2309 | - : ''; |
|
2310 | - |
|
2311 | - $context_slug = ! empty($this->_req_data['MTP_context']) |
|
2312 | - ? $this->_req_data['MTP_context'] |
|
2313 | - : ''; |
|
2314 | - $context = ucwords(str_replace('_', ' ', $context_slug)); |
|
2315 | - |
|
2316 | - $item_desc = $messenger_label && $message_type_label ? $messenger_label . ' ' . $message_type_label . ' ' . $context . ' ' : ''; |
|
2317 | - $item_desc .= 'Message Template'; |
|
2318 | - $query_args = array(); |
|
2319 | - $edit_array = array(); |
|
2320 | - $action_desc = ''; |
|
2321 | - |
|
2322 | - //if this is "new" then we need to generate the default contexts for the selected messenger/message_type for user to edit. |
|
2323 | - if ($new) { |
|
2324 | - $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0; |
|
2325 | - if ($edit_array = $this->_generate_new_templates($messenger_slug, $message_type_slug, $GRP_ID)) { |
|
2326 | - if (empty($edit_array)) { |
|
2327 | - $success = 0; |
|
2328 | - } else { |
|
2329 | - $success = 1; |
|
2330 | - $edit_array = $edit_array[0]; |
|
2331 | - $query_args = array( |
|
2332 | - 'id' => $edit_array['GRP_ID'], |
|
2333 | - 'context' => $edit_array['MTP_context'], |
|
2334 | - 'action' => 'edit_message_template' |
|
2335 | - ); |
|
2336 | - } |
|
2337 | - } |
|
2338 | - $action_desc = 'created'; |
|
2339 | - } else { |
|
2340 | - $MTPG = EEM_Message_Template_Group::instance(); |
|
2341 | - $MTP = EEM_Message_Template::instance(); |
|
2266 | + $set_column_values = array( |
|
2267 | + 'MTP_ID' => absint($this->_req_data['MTP_template_fields'][$index]['MTP_ID']), |
|
2268 | + 'GRP_ID' => absint($this->_req_data['GRP_ID']), |
|
2269 | + 'MTP_user_id' => absint($this->_req_data['MTP_user_id']), |
|
2270 | + 'MTP_messenger' => strtolower($this->_req_data['MTP_messenger']), |
|
2271 | + 'MTP_message_type' => strtolower($this->_req_data['MTP_message_type']), |
|
2272 | + 'MTP_template_field' => strtolower($this->_req_data['MTP_template_fields'][$index]['name']), |
|
2273 | + 'MTP_context' => strtolower($this->_req_data['MTP_context']), |
|
2274 | + 'MTP_content' => $this->_req_data['MTP_template_fields'][$index]['content'], |
|
2275 | + 'MTP_is_global' => isset($this->_req_data['MTP_is_global']) |
|
2276 | + ? absint($this->_req_data['MTP_is_global']) |
|
2277 | + : 0, |
|
2278 | + 'MTP_is_override' => isset($this->_req_data['MTP_is_override']) |
|
2279 | + ? absint($this->_req_data['MTP_is_override']) |
|
2280 | + : 0, |
|
2281 | + 'MTP_deleted' => absint($this->_req_data['MTP_deleted']), |
|
2282 | + 'MTP_is_active' => absint($this->_req_data['MTP_is_active']) |
|
2283 | + ); |
|
2284 | + |
|
2285 | + |
|
2286 | + return $set_column_values; |
|
2287 | + } |
|
2288 | + |
|
2289 | + |
|
2290 | + protected function _insert_or_update_message_template($new = false) |
|
2291 | + { |
|
2292 | + |
|
2293 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
2294 | + $success = 0; |
|
2295 | + $override = false; |
|
2296 | + |
|
2297 | + //setup notices description |
|
2298 | + $messenger_slug = ! empty($this->_req_data['MTP_messenger']) ? $this->_req_data['MTP_messenger'] : ''; |
|
2299 | + |
|
2300 | + //need the message type and messenger objects to be able to use the labels for the notices |
|
2301 | + $messenger_object = $this->_message_resource_manager->get_messenger($messenger_slug); |
|
2302 | + $messenger_label = $messenger_object instanceof EE_messenger ? ucwords($messenger_object->label['singular']) : ''; |
|
2303 | + |
|
2304 | + $message_type_slug = ! empty($this->_req_data['MTP_message_type']) ? $this->_req_data['MTP_message_type'] : ''; |
|
2305 | + $message_type_object = $this->_message_resource_manager->get_message_type($message_type_slug); |
|
2306 | + |
|
2307 | + $message_type_label = $message_type_object instanceof EE_message_type |
|
2308 | + ? ucwords($message_type_object->label['singular']) |
|
2309 | + : ''; |
|
2310 | + |
|
2311 | + $context_slug = ! empty($this->_req_data['MTP_context']) |
|
2312 | + ? $this->_req_data['MTP_context'] |
|
2313 | + : ''; |
|
2314 | + $context = ucwords(str_replace('_', ' ', $context_slug)); |
|
2315 | + |
|
2316 | + $item_desc = $messenger_label && $message_type_label ? $messenger_label . ' ' . $message_type_label . ' ' . $context . ' ' : ''; |
|
2317 | + $item_desc .= 'Message Template'; |
|
2318 | + $query_args = array(); |
|
2319 | + $edit_array = array(); |
|
2320 | + $action_desc = ''; |
|
2321 | + |
|
2322 | + //if this is "new" then we need to generate the default contexts for the selected messenger/message_type for user to edit. |
|
2323 | + if ($new) { |
|
2324 | + $GRP_ID = ! empty($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : 0; |
|
2325 | + if ($edit_array = $this->_generate_new_templates($messenger_slug, $message_type_slug, $GRP_ID)) { |
|
2326 | + if (empty($edit_array)) { |
|
2327 | + $success = 0; |
|
2328 | + } else { |
|
2329 | + $success = 1; |
|
2330 | + $edit_array = $edit_array[0]; |
|
2331 | + $query_args = array( |
|
2332 | + 'id' => $edit_array['GRP_ID'], |
|
2333 | + 'context' => $edit_array['MTP_context'], |
|
2334 | + 'action' => 'edit_message_template' |
|
2335 | + ); |
|
2336 | + } |
|
2337 | + } |
|
2338 | + $action_desc = 'created'; |
|
2339 | + } else { |
|
2340 | + $MTPG = EEM_Message_Template_Group::instance(); |
|
2341 | + $MTP = EEM_Message_Template::instance(); |
|
2342 | 2342 | |
2343 | 2343 | |
2344 | - //run update for each template field in displayed context |
|
2345 | - if ( ! isset($this->_req_data['MTP_template_fields']) && empty($this->_req_data['MTP_template_fields'])) { |
|
2346 | - EE_Error::add_error( |
|
2347 | - __('There was a problem saving the template fields from the form because I didn\'t receive any actual template field data.', |
|
2348 | - 'event_espresso'), |
|
2349 | - __FILE__, __FUNCTION__, __LINE__ |
|
2350 | - ); |
|
2351 | - $success = 0; |
|
2344 | + //run update for each template field in displayed context |
|
2345 | + if ( ! isset($this->_req_data['MTP_template_fields']) && empty($this->_req_data['MTP_template_fields'])) { |
|
2346 | + EE_Error::add_error( |
|
2347 | + __('There was a problem saving the template fields from the form because I didn\'t receive any actual template field data.', |
|
2348 | + 'event_espresso'), |
|
2349 | + __FILE__, __FUNCTION__, __LINE__ |
|
2350 | + ); |
|
2351 | + $success = 0; |
|
2352 | 2352 | |
2353 | - } else { |
|
2354 | - //first validate all fields! |
|
2355 | - $validates = $MTPG->validate($this->_req_data['MTP_template_fields'], $context_slug, $messenger_slug, |
|
2356 | - $message_type_slug); |
|
2353 | + } else { |
|
2354 | + //first validate all fields! |
|
2355 | + $validates = $MTPG->validate($this->_req_data['MTP_template_fields'], $context_slug, $messenger_slug, |
|
2356 | + $message_type_slug); |
|
2357 | 2357 | |
2358 | - //if $validate returned error messages (i.e. is_array()) then we need to process them and setup an appropriate response. HMM, dang this isn't correct, $validates will ALWAYS be an array. WE need to make sure there is no actual error messages in validates. |
|
2359 | - if (is_array($validates) && ! empty($validates)) { |
|
2360 | - //add the transient so when the form loads we know which fields to highlight |
|
2361 | - $this->_add_transient('edit_message_template', $validates); |
|
2358 | + //if $validate returned error messages (i.e. is_array()) then we need to process them and setup an appropriate response. HMM, dang this isn't correct, $validates will ALWAYS be an array. WE need to make sure there is no actual error messages in validates. |
|
2359 | + if (is_array($validates) && ! empty($validates)) { |
|
2360 | + //add the transient so when the form loads we know which fields to highlight |
|
2361 | + $this->_add_transient('edit_message_template', $validates); |
|
2362 | 2362 | |
2363 | - $success = 0; |
|
2363 | + $success = 0; |
|
2364 | 2364 | |
2365 | - //setup notices |
|
2366 | - foreach ($validates as $field => $error) { |
|
2367 | - if (isset($error['msg'])) { |
|
2368 | - EE_Error::add_error($error['msg'], __FILE__, __FUNCTION__, __LINE__); |
|
2369 | - } |
|
2370 | - } |
|
2365 | + //setup notices |
|
2366 | + foreach ($validates as $field => $error) { |
|
2367 | + if (isset($error['msg'])) { |
|
2368 | + EE_Error::add_error($error['msg'], __FILE__, __FUNCTION__, __LINE__); |
|
2369 | + } |
|
2370 | + } |
|
2371 | 2371 | |
2372 | - } else { |
|
2373 | - $set_column_values = array(); |
|
2374 | - foreach ($this->_req_data['MTP_template_fields'] as $template_field => $content) { |
|
2375 | - $set_column_values = $this->_set_message_template_column_values($template_field); |
|
2372 | + } else { |
|
2373 | + $set_column_values = array(); |
|
2374 | + foreach ($this->_req_data['MTP_template_fields'] as $template_field => $content) { |
|
2375 | + $set_column_values = $this->_set_message_template_column_values($template_field); |
|
2376 | 2376 | |
2377 | - $where_cols_n_values = array( |
|
2378 | - 'MTP_ID' => $this->_req_data['MTP_template_fields'][$template_field]['MTP_ID'] |
|
2379 | - ); |
|
2377 | + $where_cols_n_values = array( |
|
2378 | + 'MTP_ID' => $this->_req_data['MTP_template_fields'][$template_field]['MTP_ID'] |
|
2379 | + ); |
|
2380 | 2380 | |
2381 | - $message_template_fields = array( |
|
2382 | - 'GRP_ID' => $set_column_values['GRP_ID'], |
|
2383 | - 'MTP_template_field' => $set_column_values['MTP_template_field'], |
|
2384 | - 'MTP_context' => $set_column_values['MTP_context'], |
|
2385 | - 'MTP_content' => $set_column_values['MTP_content'] |
|
2386 | - ); |
|
2387 | - if ($updated = $MTP->update($message_template_fields, array($where_cols_n_values))) { |
|
2388 | - if ($updated === false) { |
|
2389 | - EE_Error::add_error( |
|
2390 | - sprintf( |
|
2391 | - __('%s field was NOT updated for some reason', 'event_espresso'), |
|
2392 | - $template_field |
|
2393 | - ), |
|
2394 | - __FILE__, __FUNCTION__, __LINE__ |
|
2395 | - ); |
|
2396 | - } else { |
|
2397 | - $success = 1; |
|
2398 | - } |
|
2399 | - } |
|
2400 | - $action_desc = 'updated'; |
|
2401 | - } |
|
2381 | + $message_template_fields = array( |
|
2382 | + 'GRP_ID' => $set_column_values['GRP_ID'], |
|
2383 | + 'MTP_template_field' => $set_column_values['MTP_template_field'], |
|
2384 | + 'MTP_context' => $set_column_values['MTP_context'], |
|
2385 | + 'MTP_content' => $set_column_values['MTP_content'] |
|
2386 | + ); |
|
2387 | + if ($updated = $MTP->update($message_template_fields, array($where_cols_n_values))) { |
|
2388 | + if ($updated === false) { |
|
2389 | + EE_Error::add_error( |
|
2390 | + sprintf( |
|
2391 | + __('%s field was NOT updated for some reason', 'event_espresso'), |
|
2392 | + $template_field |
|
2393 | + ), |
|
2394 | + __FILE__, __FUNCTION__, __LINE__ |
|
2395 | + ); |
|
2396 | + } else { |
|
2397 | + $success = 1; |
|
2398 | + } |
|
2399 | + } |
|
2400 | + $action_desc = 'updated'; |
|
2401 | + } |
|
2402 | 2402 | |
2403 | - //we can use the last set_column_values for the MTPG update (because its the same for all of these specific MTPs) |
|
2404 | - $mtpg_fields = array( |
|
2405 | - 'MTP_user_id' => $set_column_values['MTP_user_id'], |
|
2406 | - 'MTP_messenger' => $set_column_values['MTP_messenger'], |
|
2407 | - 'MTP_message_type' => $set_column_values['MTP_message_type'], |
|
2408 | - 'MTP_is_global' => $set_column_values['MTP_is_global'], |
|
2409 | - 'MTP_is_override' => $set_column_values['MTP_is_override'], |
|
2410 | - 'MTP_deleted' => $set_column_values['MTP_deleted'], |
|
2411 | - 'MTP_is_active' => $set_column_values['MTP_is_active'], |
|
2412 | - 'MTP_name' => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_name']) |
|
2413 | - ? $this->_req_data['ee_msg_non_global_fields']['MTP_name'] |
|
2414 | - : '', |
|
2415 | - 'MTP_description' => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_description']) |
|
2416 | - ? $this->_req_data['ee_msg_non_global_fields']['MTP_description'] |
|
2417 | - : '' |
|
2418 | - ); |
|
2403 | + //we can use the last set_column_values for the MTPG update (because its the same for all of these specific MTPs) |
|
2404 | + $mtpg_fields = array( |
|
2405 | + 'MTP_user_id' => $set_column_values['MTP_user_id'], |
|
2406 | + 'MTP_messenger' => $set_column_values['MTP_messenger'], |
|
2407 | + 'MTP_message_type' => $set_column_values['MTP_message_type'], |
|
2408 | + 'MTP_is_global' => $set_column_values['MTP_is_global'], |
|
2409 | + 'MTP_is_override' => $set_column_values['MTP_is_override'], |
|
2410 | + 'MTP_deleted' => $set_column_values['MTP_deleted'], |
|
2411 | + 'MTP_is_active' => $set_column_values['MTP_is_active'], |
|
2412 | + 'MTP_name' => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_name']) |
|
2413 | + ? $this->_req_data['ee_msg_non_global_fields']['MTP_name'] |
|
2414 | + : '', |
|
2415 | + 'MTP_description' => ! empty($this->_req_data['ee_msg_non_global_fields']['MTP_description']) |
|
2416 | + ? $this->_req_data['ee_msg_non_global_fields']['MTP_description'] |
|
2417 | + : '' |
|
2418 | + ); |
|
2419 | 2419 | |
2420 | - $mtpg_where = array('GRP_ID' => $set_column_values['GRP_ID']); |
|
2421 | - $updated = $MTPG->update($mtpg_fields, array($mtpg_where)); |
|
2420 | + $mtpg_where = array('GRP_ID' => $set_column_values['GRP_ID']); |
|
2421 | + $updated = $MTPG->update($mtpg_fields, array($mtpg_where)); |
|
2422 | 2422 | |
2423 | - if ($updated === false) { |
|
2424 | - EE_Error::add_error( |
|
2425 | - sprintf( |
|
2426 | - __('The Message Template Group (%d) was NOT updated for some reason', 'event_espresso'), |
|
2427 | - $set_column_values['GRP_ID'] |
|
2428 | - ), |
|
2429 | - __FILE__, __FUNCTION__, __LINE__ |
|
2430 | - ); |
|
2431 | - } else { |
|
2432 | - //k now we need to ensure the template_pack and template_variation fields are set. |
|
2433 | - $template_pack = ! empty($this->_req_data['MTP_template_pack']) |
|
2434 | - ? $this->_req_data['MTP_template_pack'] |
|
2435 | - : 'default'; |
|
2423 | + if ($updated === false) { |
|
2424 | + EE_Error::add_error( |
|
2425 | + sprintf( |
|
2426 | + __('The Message Template Group (%d) was NOT updated for some reason', 'event_espresso'), |
|
2427 | + $set_column_values['GRP_ID'] |
|
2428 | + ), |
|
2429 | + __FILE__, __FUNCTION__, __LINE__ |
|
2430 | + ); |
|
2431 | + } else { |
|
2432 | + //k now we need to ensure the template_pack and template_variation fields are set. |
|
2433 | + $template_pack = ! empty($this->_req_data['MTP_template_pack']) |
|
2434 | + ? $this->_req_data['MTP_template_pack'] |
|
2435 | + : 'default'; |
|
2436 | 2436 | |
2437 | - $template_variation = ! empty($this->_req_data['MTP_template_variation']) |
|
2438 | - ? $this->_req_data['MTP_template_variation'] |
|
2439 | - : 'default'; |
|
2437 | + $template_variation = ! empty($this->_req_data['MTP_template_variation']) |
|
2438 | + ? $this->_req_data['MTP_template_variation'] |
|
2439 | + : 'default'; |
|
2440 | 2440 | |
2441 | - $mtpg_obj = $MTPG->get_one_by_ID($set_column_values['GRP_ID']); |
|
2442 | - if ($mtpg_obj instanceof EE_Message_Template_Group) { |
|
2443 | - $mtpg_obj->set_template_pack_name($template_pack); |
|
2444 | - $mtpg_obj->set_template_pack_variation($template_variation); |
|
2445 | - } |
|
2446 | - $success = 1; |
|
2447 | - } |
|
2448 | - } |
|
2449 | - } |
|
2441 | + $mtpg_obj = $MTPG->get_one_by_ID($set_column_values['GRP_ID']); |
|
2442 | + if ($mtpg_obj instanceof EE_Message_Template_Group) { |
|
2443 | + $mtpg_obj->set_template_pack_name($template_pack); |
|
2444 | + $mtpg_obj->set_template_pack_variation($template_variation); |
|
2445 | + } |
|
2446 | + $success = 1; |
|
2447 | + } |
|
2448 | + } |
|
2449 | + } |
|
2450 | 2450 | |
2451 | - } |
|
2452 | - |
|
2453 | - //we return things differently if doing ajax |
|
2454 | - if (defined('DOING_AJAX') && DOING_AJAX) { |
|
2455 | - $this->_template_args['success'] = $success; |
|
2456 | - $this->_template_args['error'] = ! $success ? true : false; |
|
2457 | - $this->_template_args['content'] = ''; |
|
2458 | - $this->_template_args['data'] = array( |
|
2459 | - 'grpID' => $edit_array['GRP_ID'], |
|
2460 | - 'templateName' => $edit_array['template_name'] |
|
2461 | - ); |
|
2462 | - if ($success) { |
|
2463 | - EE_Error::overwrite_success(); |
|
2464 | - EE_Error::add_success(__('The new template has been created and automatically selected for this event. You can edit the new template by clicking the edit button. Note before this template is assigned to this event, the event must be saved.', |
|
2465 | - 'event_espresso')); |
|
2466 | - } |
|
2451 | + } |
|
2452 | + |
|
2453 | + //we return things differently if doing ajax |
|
2454 | + if (defined('DOING_AJAX') && DOING_AJAX) { |
|
2455 | + $this->_template_args['success'] = $success; |
|
2456 | + $this->_template_args['error'] = ! $success ? true : false; |
|
2457 | + $this->_template_args['content'] = ''; |
|
2458 | + $this->_template_args['data'] = array( |
|
2459 | + 'grpID' => $edit_array['GRP_ID'], |
|
2460 | + 'templateName' => $edit_array['template_name'] |
|
2461 | + ); |
|
2462 | + if ($success) { |
|
2463 | + EE_Error::overwrite_success(); |
|
2464 | + EE_Error::add_success(__('The new template has been created and automatically selected for this event. You can edit the new template by clicking the edit button. Note before this template is assigned to this event, the event must be saved.', |
|
2465 | + 'event_espresso')); |
|
2466 | + } |
|
2467 | 2467 | |
2468 | - $this->_return_json(); |
|
2469 | - } |
|
2470 | - |
|
2471 | - |
|
2472 | - //was a test send triggered? |
|
2473 | - if (isset($this->_req_data['test_button'])) { |
|
2474 | - EE_Error::overwrite_success(); |
|
2475 | - $this->_do_test_send($context_slug, $messenger_slug, $message_type_slug); |
|
2476 | - $override = true; |
|
2477 | - } |
|
2478 | - |
|
2479 | - if (empty($query_args)) { |
|
2480 | - $query_args = array( |
|
2481 | - 'id' => $this->_req_data['GRP_ID'], |
|
2482 | - 'context' => $context_slug, |
|
2483 | - 'action' => 'edit_message_template' |
|
2484 | - ); |
|
2485 | - } |
|
2486 | - |
|
2487 | - $this->_redirect_after_action($success, $item_desc, $action_desc, $query_args, $override); |
|
2488 | - } |
|
2489 | - |
|
2490 | - |
|
2491 | - /** |
|
2492 | - * processes a test send request to do an actual messenger delivery test for the given message template being tested |
|
2493 | - * |
|
2494 | - * @param string $context what context being tested |
|
2495 | - * @param string $messenger messenger being tested |
|
2496 | - * @param string $message_type message type being tested |
|
2497 | - * |
|
2498 | - */ |
|
2499 | - protected function _do_test_send($context, $messenger, $message_type) |
|
2500 | - { |
|
2501 | - //set things up for preview |
|
2502 | - $this->_req_data['messenger'] = $messenger; |
|
2503 | - $this->_req_data['message_type'] = $message_type; |
|
2504 | - $this->_req_data['context'] = $context; |
|
2505 | - $this->_req_data['GRP_ID'] = isset($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : ''; |
|
2506 | - $active_messenger = $this->_message_resource_manager->get_active_messenger($messenger); |
|
2507 | - |
|
2508 | - //let's save any existing fields that might be required by the messenger |
|
2509 | - if ( |
|
2510 | - isset($this->_req_data['test_settings_fld']) |
|
2511 | - && $active_messenger instanceof EE_messenger |
|
2512 | - && apply_filters( |
|
2513 | - 'FHEE__Messages_Admin_Page__do_test_send__set_existing_test_settings', |
|
2514 | - true, |
|
2515 | - $this->_req_data['test_settings_fld'], |
|
2516 | - $active_messenger |
|
2517 | - ) |
|
2518 | - ) { |
|
2519 | - $active_messenger->set_existing_test_settings($this->_req_data['test_settings_fld']); |
|
2520 | - } |
|
2521 | - |
|
2522 | - $success = $this->_preview_message(true); |
|
2523 | - |
|
2524 | - if ($success) { |
|
2525 | - EE_Error::add_success(__('Test message sent', 'event_espresso')); |
|
2526 | - } else { |
|
2527 | - EE_Error::add_error(__('The test message was not sent', 'event_espresso'), __FILE__, __FUNCTION__, |
|
2528 | - __LINE__); |
|
2529 | - } |
|
2530 | - } |
|
2531 | - |
|
2532 | - |
|
2533 | - /** |
|
2534 | - * _generate_new_templates |
|
2535 | - * This will handle the messenger, message_type selection when "adding a new custom template" for an event and will |
|
2536 | - * automatically create the defaults for the event. The user would then be redirected to edit the default context |
|
2537 | - * for the event. |
|
2538 | - * |
|
2539 | - * |
|
2540 | - * @param string $messenger the messenger we are generating templates for |
|
2541 | - * @param array $message_types array of message types that the templates are generated for. |
|
2542 | - * @param int $GRP_ID If this is a custom template being generated then a GRP_ID needs to be included to |
|
2543 | - * indicate the message_template_group being used as the base. |
|
2544 | - * |
|
2545 | - * @param bool $global |
|
2546 | - * |
|
2547 | - * @return array|bool array of data required for the redirect to the correct edit page or bool if |
|
2548 | - * encountering problems. |
|
2549 | - * @throws \EE_Error |
|
2550 | - */ |
|
2551 | - protected function _generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false) |
|
2552 | - { |
|
2553 | - |
|
2554 | - //if no $message_types are given then that's okay... this may be a messenger that just adds shortcodes, so we just don't generate any templates. |
|
2555 | - if (empty($message_types)) { |
|
2556 | - return true; |
|
2557 | - } |
|
2558 | - |
|
2559 | - return EEH_MSG_Template::generate_new_templates($messenger, $message_types, $GRP_ID, $global); |
|
2560 | - } |
|
2561 | - |
|
2562 | - |
|
2563 | - /** |
|
2564 | - * [_trash_or_restore_message_template] |
|
2565 | - * |
|
2566 | - * @param boolean $trash whether to move an item to trash/restore (TRUE) or restore it (FALSE) |
|
2567 | - * @param boolean $all whether this is going to trash/restore all contexts within a template group (TRUE) OR just |
|
2568 | - * an individual context (FALSE). |
|
2569 | - * |
|
2570 | - * @return void |
|
2571 | - */ |
|
2572 | - protected function _trash_or_restore_message_template($trash = true, $all = false) |
|
2573 | - { |
|
2574 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
2575 | - $MTP = EEM_Message_Template_Group::instance(); |
|
2576 | - |
|
2577 | - $success = 1; |
|
2578 | - |
|
2579 | - //incoming GRP_IDs |
|
2580 | - if ($all) { |
|
2581 | - //Checkboxes |
|
2582 | - if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) { |
|
2583 | - //if array has more than one element then success message should be plural. |
|
2584 | - //todo: what about nonce? |
|
2585 | - $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1; |
|
2468 | + $this->_return_json(); |
|
2469 | + } |
|
2470 | + |
|
2471 | + |
|
2472 | + //was a test send triggered? |
|
2473 | + if (isset($this->_req_data['test_button'])) { |
|
2474 | + EE_Error::overwrite_success(); |
|
2475 | + $this->_do_test_send($context_slug, $messenger_slug, $message_type_slug); |
|
2476 | + $override = true; |
|
2477 | + } |
|
2478 | + |
|
2479 | + if (empty($query_args)) { |
|
2480 | + $query_args = array( |
|
2481 | + 'id' => $this->_req_data['GRP_ID'], |
|
2482 | + 'context' => $context_slug, |
|
2483 | + 'action' => 'edit_message_template' |
|
2484 | + ); |
|
2485 | + } |
|
2486 | + |
|
2487 | + $this->_redirect_after_action($success, $item_desc, $action_desc, $query_args, $override); |
|
2488 | + } |
|
2489 | + |
|
2490 | + |
|
2491 | + /** |
|
2492 | + * processes a test send request to do an actual messenger delivery test for the given message template being tested |
|
2493 | + * |
|
2494 | + * @param string $context what context being tested |
|
2495 | + * @param string $messenger messenger being tested |
|
2496 | + * @param string $message_type message type being tested |
|
2497 | + * |
|
2498 | + */ |
|
2499 | + protected function _do_test_send($context, $messenger, $message_type) |
|
2500 | + { |
|
2501 | + //set things up for preview |
|
2502 | + $this->_req_data['messenger'] = $messenger; |
|
2503 | + $this->_req_data['message_type'] = $message_type; |
|
2504 | + $this->_req_data['context'] = $context; |
|
2505 | + $this->_req_data['GRP_ID'] = isset($this->_req_data['GRP_ID']) ? $this->_req_data['GRP_ID'] : ''; |
|
2506 | + $active_messenger = $this->_message_resource_manager->get_active_messenger($messenger); |
|
2507 | + |
|
2508 | + //let's save any existing fields that might be required by the messenger |
|
2509 | + if ( |
|
2510 | + isset($this->_req_data['test_settings_fld']) |
|
2511 | + && $active_messenger instanceof EE_messenger |
|
2512 | + && apply_filters( |
|
2513 | + 'FHEE__Messages_Admin_Page__do_test_send__set_existing_test_settings', |
|
2514 | + true, |
|
2515 | + $this->_req_data['test_settings_fld'], |
|
2516 | + $active_messenger |
|
2517 | + ) |
|
2518 | + ) { |
|
2519 | + $active_messenger->set_existing_test_settings($this->_req_data['test_settings_fld']); |
|
2520 | + } |
|
2521 | + |
|
2522 | + $success = $this->_preview_message(true); |
|
2523 | + |
|
2524 | + if ($success) { |
|
2525 | + EE_Error::add_success(__('Test message sent', 'event_espresso')); |
|
2526 | + } else { |
|
2527 | + EE_Error::add_error(__('The test message was not sent', 'event_espresso'), __FILE__, __FUNCTION__, |
|
2528 | + __LINE__); |
|
2529 | + } |
|
2530 | + } |
|
2531 | + |
|
2532 | + |
|
2533 | + /** |
|
2534 | + * _generate_new_templates |
|
2535 | + * This will handle the messenger, message_type selection when "adding a new custom template" for an event and will |
|
2536 | + * automatically create the defaults for the event. The user would then be redirected to edit the default context |
|
2537 | + * for the event. |
|
2538 | + * |
|
2539 | + * |
|
2540 | + * @param string $messenger the messenger we are generating templates for |
|
2541 | + * @param array $message_types array of message types that the templates are generated for. |
|
2542 | + * @param int $GRP_ID If this is a custom template being generated then a GRP_ID needs to be included to |
|
2543 | + * indicate the message_template_group being used as the base. |
|
2544 | + * |
|
2545 | + * @param bool $global |
|
2546 | + * |
|
2547 | + * @return array|bool array of data required for the redirect to the correct edit page or bool if |
|
2548 | + * encountering problems. |
|
2549 | + * @throws \EE_Error |
|
2550 | + */ |
|
2551 | + protected function _generate_new_templates($messenger, $message_types, $GRP_ID = 0, $global = false) |
|
2552 | + { |
|
2553 | + |
|
2554 | + //if no $message_types are given then that's okay... this may be a messenger that just adds shortcodes, so we just don't generate any templates. |
|
2555 | + if (empty($message_types)) { |
|
2556 | + return true; |
|
2557 | + } |
|
2558 | + |
|
2559 | + return EEH_MSG_Template::generate_new_templates($messenger, $message_types, $GRP_ID, $global); |
|
2560 | + } |
|
2561 | + |
|
2562 | + |
|
2563 | + /** |
|
2564 | + * [_trash_or_restore_message_template] |
|
2565 | + * |
|
2566 | + * @param boolean $trash whether to move an item to trash/restore (TRUE) or restore it (FALSE) |
|
2567 | + * @param boolean $all whether this is going to trash/restore all contexts within a template group (TRUE) OR just |
|
2568 | + * an individual context (FALSE). |
|
2569 | + * |
|
2570 | + * @return void |
|
2571 | + */ |
|
2572 | + protected function _trash_or_restore_message_template($trash = true, $all = false) |
|
2573 | + { |
|
2574 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
2575 | + $MTP = EEM_Message_Template_Group::instance(); |
|
2576 | + |
|
2577 | + $success = 1; |
|
2578 | + |
|
2579 | + //incoming GRP_IDs |
|
2580 | + if ($all) { |
|
2581 | + //Checkboxes |
|
2582 | + if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) { |
|
2583 | + //if array has more than one element then success message should be plural. |
|
2584 | + //todo: what about nonce? |
|
2585 | + $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1; |
|
2586 | 2586 | |
2587 | - //cycle through checkboxes |
|
2588 | - while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) { |
|
2589 | - $trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID); |
|
2590 | - if ( ! $trashed_or_restored) { |
|
2591 | - $success = 0; |
|
2592 | - } |
|
2593 | - } |
|
2594 | - } else { |
|
2595 | - //grab single GRP_ID and handle |
|
2596 | - $GRP_ID = isset($this->_req_data['id']) ? absint($this->_req_data['id']) : 0; |
|
2597 | - if ( ! empty($GRP_ID)) { |
|
2598 | - $trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID); |
|
2599 | - if ( ! $trashed_or_restored) { |
|
2600 | - $success = 0; |
|
2601 | - } |
|
2602 | - } else { |
|
2603 | - $success = 0; |
|
2604 | - } |
|
2605 | - } |
|
2587 | + //cycle through checkboxes |
|
2588 | + while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) { |
|
2589 | + $trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID); |
|
2590 | + if ( ! $trashed_or_restored) { |
|
2591 | + $success = 0; |
|
2592 | + } |
|
2593 | + } |
|
2594 | + } else { |
|
2595 | + //grab single GRP_ID and handle |
|
2596 | + $GRP_ID = isset($this->_req_data['id']) ? absint($this->_req_data['id']) : 0; |
|
2597 | + if ( ! empty($GRP_ID)) { |
|
2598 | + $trashed_or_restored = $trash ? $MTP->delete_by_ID($GRP_ID) : $MTP->restore_by_ID($GRP_ID); |
|
2599 | + if ( ! $trashed_or_restored) { |
|
2600 | + $success = 0; |
|
2601 | + } |
|
2602 | + } else { |
|
2603 | + $success = 0; |
|
2604 | + } |
|
2605 | + } |
|
2606 | 2606 | |
2607 | - } |
|
2607 | + } |
|
2608 | 2608 | |
2609 | - $action_desc = $trash ? __('moved to the trash', 'event_espresso') : __('restored', 'event_espresso'); |
|
2609 | + $action_desc = $trash ? __('moved to the trash', 'event_espresso') : __('restored', 'event_espresso'); |
|
2610 | 2610 | |
2611 | - $action_desc = ! empty($this->_req_data['template_switch']) ? __('switched') : $action_desc; |
|
2611 | + $action_desc = ! empty($this->_req_data['template_switch']) ? __('switched') : $action_desc; |
|
2612 | 2612 | |
2613 | - $item_desc = $all ? _n('Message Template Group', 'Message Template Groups', $success, |
|
2614 | - 'event_espresso') : _n('Message Template Context', 'Message Template Contexts', $success, 'event_espresso'); |
|
2613 | + $item_desc = $all ? _n('Message Template Group', 'Message Template Groups', $success, |
|
2614 | + 'event_espresso') : _n('Message Template Context', 'Message Template Contexts', $success, 'event_espresso'); |
|
2615 | 2615 | |
2616 | - $item_desc = ! empty($this->_req_data['template_switch']) ? _n('template', 'templates', $success, |
|
2617 | - 'event_espresso') : $item_desc; |
|
2616 | + $item_desc = ! empty($this->_req_data['template_switch']) ? _n('template', 'templates', $success, |
|
2617 | + 'event_espresso') : $item_desc; |
|
2618 | 2618 | |
2619 | - $this->_redirect_after_action($success, $item_desc, $action_desc, array()); |
|
2619 | + $this->_redirect_after_action($success, $item_desc, $action_desc, array()); |
|
2620 | 2620 | |
2621 | - } |
|
2621 | + } |
|
2622 | 2622 | |
2623 | 2623 | |
2624 | - /** |
|
2625 | - * [_delete_message_template] |
|
2626 | - * NOTE: this handles not only the deletion of the groups but also all the templates belonging to that group. |
|
2627 | - * @return void |
|
2628 | - */ |
|
2629 | - protected function _delete_message_template() |
|
2630 | - { |
|
2631 | - do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
2624 | + /** |
|
2625 | + * [_delete_message_template] |
|
2626 | + * NOTE: this handles not only the deletion of the groups but also all the templates belonging to that group. |
|
2627 | + * @return void |
|
2628 | + */ |
|
2629 | + protected function _delete_message_template() |
|
2630 | + { |
|
2631 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
2632 | 2632 | |
2633 | - //checkboxes |
|
2634 | - if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) { |
|
2635 | - //if array has more than one element then success message should be plural |
|
2636 | - $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1; |
|
2633 | + //checkboxes |
|
2634 | + if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) { |
|
2635 | + //if array has more than one element then success message should be plural |
|
2636 | + $success = count($this->_req_data['checkbox']) > 1 ? 2 : 1; |
|
2637 | 2637 | |
2638 | - //cycle through bulk action checkboxes |
|
2639 | - while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) { |
|
2640 | - $success = $this->_delete_mtp_permanently($GRP_ID); |
|
2641 | - } |
|
2642 | - } else { |
|
2643 | - //grab single grp_id and delete |
|
2644 | - $GRP_ID = absint($this->_req_data['id']); |
|
2645 | - $success = $this->_delete_mtp_permanently($GRP_ID); |
|
2646 | - } |
|
2647 | - |
|
2648 | - $this->_redirect_after_action($success, 'Message Templates', 'deleted', array()); |
|
2649 | - |
|
2650 | - } |
|
2651 | - |
|
2652 | - |
|
2653 | - /** |
|
2654 | - * helper for permanently deleting a mtP group and all related message_templates |
|
2655 | - * |
|
2656 | - * @param int $GRP_ID The group being deleted |
|
2657 | - * @param bool $include_group whether to delete the Message Template Group as well. |
|
2658 | - * |
|
2659 | - * @return bool boolean to indicate the success of the deletes or not. |
|
2660 | - */ |
|
2661 | - private function _delete_mtp_permanently($GRP_ID, $include_group = true) |
|
2662 | - { |
|
2663 | - $success = 1; |
|
2664 | - $MTPG = EEM_Message_Template_Group::instance(); |
|
2665 | - //first let's GET this group |
|
2666 | - $MTG = $MTPG->get_one_by_ID($GRP_ID); |
|
2667 | - //then delete permanently all the related Message Templates |
|
2668 | - $deleted = $MTG->delete_related_permanently('Message_Template'); |
|
2669 | - |
|
2670 | - if ($deleted === 0) { |
|
2671 | - $success = 0; |
|
2672 | - } |
|
2673 | - |
|
2674 | - //now delete permanently this particular group |
|
2675 | - |
|
2676 | - if ($include_group && ! $MTG->delete_permanently()) { |
|
2677 | - $success = 0; |
|
2678 | - } |
|
2679 | - |
|
2680 | - return $success; |
|
2681 | - } |
|
2682 | - |
|
2683 | - |
|
2684 | - /** |
|
2685 | - * _learn_more_about_message_templates_link |
|
2686 | - * @access protected |
|
2687 | - * @return string |
|
2688 | - */ |
|
2689 | - protected function _learn_more_about_message_templates_link() |
|
2690 | - { |
|
2691 | - return '<a class="hidden" style="margin:0 20px; cursor:pointer; font-size:12px;" >' . __('learn more about how message templates works', |
|
2692 | - 'event_espresso') . '</a>'; |
|
2693 | - } |
|
2694 | - |
|
2695 | - |
|
2696 | - /** |
|
2697 | - * Used for setting up messenger/message type activation. This loads up the initial view. The rest is handled by |
|
2698 | - * ajax and other routes. |
|
2699 | - * @return void |
|
2700 | - */ |
|
2701 | - protected function _settings() |
|
2702 | - { |
|
2703 | - |
|
2704 | - |
|
2705 | - $this->_set_m_mt_settings(); |
|
2706 | - |
|
2707 | - $selected_messenger = isset($this->_req_data['selected_messenger']) ? $this->_req_data['selected_messenger'] : 'email'; |
|
2708 | - |
|
2709 | - //let's setup the messenger tabs |
|
2710 | - $this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links($this->_m_mt_settings['messenger_tabs'], |
|
2711 | - 'messenger_links', '|', $selected_messenger); |
|
2712 | - $this->_template_args['before_admin_page_content'] = '<div class="ui-widget ui-helper-clearfix">'; |
|
2713 | - $this->_template_args['after_admin_page_content'] = '</div><!-- end .ui-widget -->'; |
|
2714 | - |
|
2715 | - $this->display_admin_page_with_sidebar(); |
|
2716 | - |
|
2717 | - } |
|
2718 | - |
|
2719 | - |
|
2720 | - /** |
|
2721 | - * This sets the $_m_mt_settings property for when needed (used on the Messages settings page) |
|
2722 | - * |
|
2723 | - * @access protected |
|
2724 | - * @return void |
|
2725 | - */ |
|
2726 | - protected function _set_m_mt_settings() |
|
2727 | - { |
|
2728 | - //first if this is already set then lets get out no need to regenerate data. |
|
2729 | - if ( ! empty($this->_m_mt_settings)) { |
|
2730 | - return; |
|
2731 | - } |
|
2732 | - |
|
2733 | - //$selected_messenger = isset( $this->_req_data['selected_messenger'] ) ? $this->_req_data['selected_messenger'] : 'email'; |
|
2734 | - |
|
2735 | - //get all installed messengers and message_types |
|
2736 | - /** @type EE_messenger[] $messengers */ |
|
2737 | - $messengers = $this->_message_resource_manager->installed_messengers(); |
|
2738 | - /** @type EE_message_type[] $message_types */ |
|
2739 | - $message_types = $this->_message_resource_manager->installed_message_types(); |
|
2740 | - |
|
2741 | - |
|
2742 | - //assemble the array for the _tab_text_links helper |
|
2743 | - |
|
2744 | - foreach ($messengers as $messenger) { |
|
2745 | - $this->_m_mt_settings['messenger_tabs'][$messenger->name] = array( |
|
2746 | - 'label' => ucwords($messenger->label['singular']), |
|
2747 | - 'class' => $this->_message_resource_manager->is_messenger_active($messenger->name) ? 'messenger-active' : '', |
|
2748 | - 'href' => $messenger->name, |
|
2749 | - 'title' => __('Modify this Messenger', 'event_espresso'), |
|
2750 | - 'slug' => $messenger->name, |
|
2751 | - 'obj' => $messenger |
|
2752 | - ); |
|
2638 | + //cycle through bulk action checkboxes |
|
2639 | + while (list($GRP_ID, $value) = each($this->_req_data['checkbox'])) { |
|
2640 | + $success = $this->_delete_mtp_permanently($GRP_ID); |
|
2641 | + } |
|
2642 | + } else { |
|
2643 | + //grab single grp_id and delete |
|
2644 | + $GRP_ID = absint($this->_req_data['id']); |
|
2645 | + $success = $this->_delete_mtp_permanently($GRP_ID); |
|
2646 | + } |
|
2647 | + |
|
2648 | + $this->_redirect_after_action($success, 'Message Templates', 'deleted', array()); |
|
2649 | + |
|
2650 | + } |
|
2651 | + |
|
2652 | + |
|
2653 | + /** |
|
2654 | + * helper for permanently deleting a mtP group and all related message_templates |
|
2655 | + * |
|
2656 | + * @param int $GRP_ID The group being deleted |
|
2657 | + * @param bool $include_group whether to delete the Message Template Group as well. |
|
2658 | + * |
|
2659 | + * @return bool boolean to indicate the success of the deletes or not. |
|
2660 | + */ |
|
2661 | + private function _delete_mtp_permanently($GRP_ID, $include_group = true) |
|
2662 | + { |
|
2663 | + $success = 1; |
|
2664 | + $MTPG = EEM_Message_Template_Group::instance(); |
|
2665 | + //first let's GET this group |
|
2666 | + $MTG = $MTPG->get_one_by_ID($GRP_ID); |
|
2667 | + //then delete permanently all the related Message Templates |
|
2668 | + $deleted = $MTG->delete_related_permanently('Message_Template'); |
|
2669 | + |
|
2670 | + if ($deleted === 0) { |
|
2671 | + $success = 0; |
|
2672 | + } |
|
2673 | + |
|
2674 | + //now delete permanently this particular group |
|
2675 | + |
|
2676 | + if ($include_group && ! $MTG->delete_permanently()) { |
|
2677 | + $success = 0; |
|
2678 | + } |
|
2679 | + |
|
2680 | + return $success; |
|
2681 | + } |
|
2682 | + |
|
2683 | + |
|
2684 | + /** |
|
2685 | + * _learn_more_about_message_templates_link |
|
2686 | + * @access protected |
|
2687 | + * @return string |
|
2688 | + */ |
|
2689 | + protected function _learn_more_about_message_templates_link() |
|
2690 | + { |
|
2691 | + return '<a class="hidden" style="margin:0 20px; cursor:pointer; font-size:12px;" >' . __('learn more about how message templates works', |
|
2692 | + 'event_espresso') . '</a>'; |
|
2693 | + } |
|
2694 | + |
|
2695 | + |
|
2696 | + /** |
|
2697 | + * Used for setting up messenger/message type activation. This loads up the initial view. The rest is handled by |
|
2698 | + * ajax and other routes. |
|
2699 | + * @return void |
|
2700 | + */ |
|
2701 | + protected function _settings() |
|
2702 | + { |
|
2703 | + |
|
2704 | + |
|
2705 | + $this->_set_m_mt_settings(); |
|
2706 | + |
|
2707 | + $selected_messenger = isset($this->_req_data['selected_messenger']) ? $this->_req_data['selected_messenger'] : 'email'; |
|
2708 | + |
|
2709 | + //let's setup the messenger tabs |
|
2710 | + $this->_template_args['admin_page_header'] = EEH_Tabbed_Content::tab_text_links($this->_m_mt_settings['messenger_tabs'], |
|
2711 | + 'messenger_links', '|', $selected_messenger); |
|
2712 | + $this->_template_args['before_admin_page_content'] = '<div class="ui-widget ui-helper-clearfix">'; |
|
2713 | + $this->_template_args['after_admin_page_content'] = '</div><!-- end .ui-widget -->'; |
|
2714 | + |
|
2715 | + $this->display_admin_page_with_sidebar(); |
|
2716 | + |
|
2717 | + } |
|
2718 | + |
|
2719 | + |
|
2720 | + /** |
|
2721 | + * This sets the $_m_mt_settings property for when needed (used on the Messages settings page) |
|
2722 | + * |
|
2723 | + * @access protected |
|
2724 | + * @return void |
|
2725 | + */ |
|
2726 | + protected function _set_m_mt_settings() |
|
2727 | + { |
|
2728 | + //first if this is already set then lets get out no need to regenerate data. |
|
2729 | + if ( ! empty($this->_m_mt_settings)) { |
|
2730 | + return; |
|
2731 | + } |
|
2732 | + |
|
2733 | + //$selected_messenger = isset( $this->_req_data['selected_messenger'] ) ? $this->_req_data['selected_messenger'] : 'email'; |
|
2734 | + |
|
2735 | + //get all installed messengers and message_types |
|
2736 | + /** @type EE_messenger[] $messengers */ |
|
2737 | + $messengers = $this->_message_resource_manager->installed_messengers(); |
|
2738 | + /** @type EE_message_type[] $message_types */ |
|
2739 | + $message_types = $this->_message_resource_manager->installed_message_types(); |
|
2740 | + |
|
2741 | + |
|
2742 | + //assemble the array for the _tab_text_links helper |
|
2743 | + |
|
2744 | + foreach ($messengers as $messenger) { |
|
2745 | + $this->_m_mt_settings['messenger_tabs'][$messenger->name] = array( |
|
2746 | + 'label' => ucwords($messenger->label['singular']), |
|
2747 | + 'class' => $this->_message_resource_manager->is_messenger_active($messenger->name) ? 'messenger-active' : '', |
|
2748 | + 'href' => $messenger->name, |
|
2749 | + 'title' => __('Modify this Messenger', 'event_espresso'), |
|
2750 | + 'slug' => $messenger->name, |
|
2751 | + 'obj' => $messenger |
|
2752 | + ); |
|
2753 | 2753 | |
2754 | 2754 | |
2755 | - $message_types_for_messenger = $messenger->get_valid_message_types(); |
|
2755 | + $message_types_for_messenger = $messenger->get_valid_message_types(); |
|
2756 | 2756 | |
2757 | - foreach ($message_types as $message_type) { |
|
2758 | - //first we need to verify that this message type is valid with this messenger. Cause if it isn't then it shouldn't show in either the inactive OR active metabox. |
|
2759 | - if ( ! in_array($message_type->name, $message_types_for_messenger)) { |
|
2760 | - continue; |
|
2761 | - } |
|
2757 | + foreach ($message_types as $message_type) { |
|
2758 | + //first we need to verify that this message type is valid with this messenger. Cause if it isn't then it shouldn't show in either the inactive OR active metabox. |
|
2759 | + if ( ! in_array($message_type->name, $message_types_for_messenger)) { |
|
2760 | + continue; |
|
2761 | + } |
|
2762 | 2762 | |
2763 | - $a_or_i = $this->_message_resource_manager->is_message_type_active_for_messenger($messenger->name, |
|
2764 | - $message_type->name) ? 'active' : 'inactive'; |
|
2763 | + $a_or_i = $this->_message_resource_manager->is_message_type_active_for_messenger($messenger->name, |
|
2764 | + $message_type->name) ? 'active' : 'inactive'; |
|
2765 | 2765 | |
2766 | - $this->_m_mt_settings['message_type_tabs'][$messenger->name][$a_or_i][$message_type->name] = array( |
|
2767 | - 'label' => ucwords($message_type->label['singular']), |
|
2768 | - 'class' => 'message-type-' . $a_or_i, |
|
2769 | - 'slug_id' => $message_type->name . '-messagetype-' . $messenger->name, |
|
2770 | - 'mt_nonce' => wp_create_nonce($message_type->name . '_nonce'), |
|
2771 | - 'href' => 'espresso_' . $message_type->name . '_message_type_settings', |
|
2772 | - 'title' => $a_or_i == 'active' |
|
2773 | - ? __('Drag this message type to the Inactive window to deactivate', 'event_espresso') |
|
2774 | - : __('Drag this message type to the messenger to activate', 'event_espresso'), |
|
2775 | - 'content' => $a_or_i == 'active' |
|
2776 | - ? $this->_message_type_settings_content($message_type, $messenger, true) |
|
2777 | - : $this->_message_type_settings_content($message_type, $messenger), |
|
2778 | - 'slug' => $message_type->name, |
|
2779 | - 'active' => $a_or_i == 'active' ? true : false, |
|
2780 | - 'obj' => $message_type |
|
2781 | - ); |
|
2782 | - } |
|
2783 | - } |
|
2784 | - } |
|
2785 | - |
|
2786 | - |
|
2787 | - /** |
|
2788 | - * This just prepares the content for the message type settings |
|
2789 | - * |
|
2790 | - * @param object $message_type The message type object |
|
2791 | - * @param object $messenger The messenger object |
|
2792 | - * @param boolean $active Whether the message type is active or not |
|
2793 | - * |
|
2794 | - * @return string html output for the content |
|
2795 | - */ |
|
2796 | - protected function _message_type_settings_content($message_type, $messenger, $active = false) |
|
2797 | - { |
|
2798 | - //get message type fields |
|
2799 | - $fields = $message_type->get_admin_settings_fields(); |
|
2800 | - $settings_template_args['template_form_fields'] = ''; |
|
2801 | - |
|
2802 | - if ( ! empty($fields) && $active) { |
|
2766 | + $this->_m_mt_settings['message_type_tabs'][$messenger->name][$a_or_i][$message_type->name] = array( |
|
2767 | + 'label' => ucwords($message_type->label['singular']), |
|
2768 | + 'class' => 'message-type-' . $a_or_i, |
|
2769 | + 'slug_id' => $message_type->name . '-messagetype-' . $messenger->name, |
|
2770 | + 'mt_nonce' => wp_create_nonce($message_type->name . '_nonce'), |
|
2771 | + 'href' => 'espresso_' . $message_type->name . '_message_type_settings', |
|
2772 | + 'title' => $a_or_i == 'active' |
|
2773 | + ? __('Drag this message type to the Inactive window to deactivate', 'event_espresso') |
|
2774 | + : __('Drag this message type to the messenger to activate', 'event_espresso'), |
|
2775 | + 'content' => $a_or_i == 'active' |
|
2776 | + ? $this->_message_type_settings_content($message_type, $messenger, true) |
|
2777 | + : $this->_message_type_settings_content($message_type, $messenger), |
|
2778 | + 'slug' => $message_type->name, |
|
2779 | + 'active' => $a_or_i == 'active' ? true : false, |
|
2780 | + 'obj' => $message_type |
|
2781 | + ); |
|
2782 | + } |
|
2783 | + } |
|
2784 | + } |
|
2785 | + |
|
2786 | + |
|
2787 | + /** |
|
2788 | + * This just prepares the content for the message type settings |
|
2789 | + * |
|
2790 | + * @param object $message_type The message type object |
|
2791 | + * @param object $messenger The messenger object |
|
2792 | + * @param boolean $active Whether the message type is active or not |
|
2793 | + * |
|
2794 | + * @return string html output for the content |
|
2795 | + */ |
|
2796 | + protected function _message_type_settings_content($message_type, $messenger, $active = false) |
|
2797 | + { |
|
2798 | + //get message type fields |
|
2799 | + $fields = $message_type->get_admin_settings_fields(); |
|
2800 | + $settings_template_args['template_form_fields'] = ''; |
|
2801 | + |
|
2802 | + if ( ! empty($fields) && $active) { |
|
2803 | 2803 | |
2804 | - $existing_settings = $message_type->get_existing_admin_settings($messenger->name); |
|
2804 | + $existing_settings = $message_type->get_existing_admin_settings($messenger->name); |
|
2805 | 2805 | |
2806 | - foreach ($fields as $fldname => $fldprops) { |
|
2807 | - $field_id = $messenger->name . '-' . $message_type->name . '-' . $fldname; |
|
2808 | - $template_form_field[$field_id] = array( |
|
2809 | - 'name' => 'message_type_settings[' . $fldname . ']', |
|
2810 | - 'label' => $fldprops['label'], |
|
2811 | - 'input' => $fldprops['field_type'], |
|
2812 | - 'type' => $fldprops['value_type'], |
|
2813 | - 'required' => $fldprops['required'], |
|
2814 | - 'validation' => $fldprops['validation'], |
|
2815 | - 'value' => isset($existing_settings[$fldname]) ? $existing_settings[$fldname] : $fldprops['default'], |
|
2816 | - 'options' => isset($fldprops['options']) ? $fldprops['options'] : array(), |
|
2817 | - 'default' => isset($existing_settings[$fldname]) ? $existing_settings[$fldname] : $fldprops['default'], |
|
2818 | - 'css_class' => 'no-drag', |
|
2819 | - 'format' => $fldprops['format'] |
|
2820 | - ); |
|
2821 | - } |
|
2806 | + foreach ($fields as $fldname => $fldprops) { |
|
2807 | + $field_id = $messenger->name . '-' . $message_type->name . '-' . $fldname; |
|
2808 | + $template_form_field[$field_id] = array( |
|
2809 | + 'name' => 'message_type_settings[' . $fldname . ']', |
|
2810 | + 'label' => $fldprops['label'], |
|
2811 | + 'input' => $fldprops['field_type'], |
|
2812 | + 'type' => $fldprops['value_type'], |
|
2813 | + 'required' => $fldprops['required'], |
|
2814 | + 'validation' => $fldprops['validation'], |
|
2815 | + 'value' => isset($existing_settings[$fldname]) ? $existing_settings[$fldname] : $fldprops['default'], |
|
2816 | + 'options' => isset($fldprops['options']) ? $fldprops['options'] : array(), |
|
2817 | + 'default' => isset($existing_settings[$fldname]) ? $existing_settings[$fldname] : $fldprops['default'], |
|
2818 | + 'css_class' => 'no-drag', |
|
2819 | + 'format' => $fldprops['format'] |
|
2820 | + ); |
|
2821 | + } |
|
2822 | 2822 | |
2823 | 2823 | |
2824 | - $settings_template_args['template_form_fields'] = ! empty($template_form_field) ? $this->_generate_admin_form_fields($template_form_field, |
|
2825 | - 'string', 'ee_mt_activate_form') : ''; |
|
2826 | - } |
|
2827 | - |
|
2828 | - $settings_template_args['description'] = $message_type->description; |
|
2829 | - //we also need some hidden fields |
|
2830 | - $settings_template_args['hidden_fields'] = array( |
|
2831 | - 'message_type_settings[messenger]' => array( |
|
2832 | - 'type' => 'hidden', |
|
2833 | - 'value' => $messenger->name |
|
2834 | - ), |
|
2835 | - 'message_type_settings[message_type]' => array( |
|
2836 | - 'type' => 'hidden', |
|
2837 | - 'value' => $message_type->name |
|
2838 | - ), |
|
2839 | - 'type' => array( |
|
2840 | - 'type' => 'hidden', |
|
2841 | - 'value' => 'message_type' |
|
2842 | - ) |
|
2843 | - ); |
|
2844 | - |
|
2845 | - $settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields($settings_template_args['hidden_fields'], |
|
2846 | - 'array'); |
|
2847 | - $settings_template_args['show_form'] = empty($settings_template_args['template_form_fields']) ? ' hidden' : ''; |
|
2848 | - |
|
2849 | - |
|
2850 | - $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_mt_settings_content.template.php'; |
|
2851 | - $content = EEH_Template::display_template($template, $settings_template_args, true); |
|
2852 | - |
|
2853 | - return $content; |
|
2854 | - } |
|
2855 | - |
|
2856 | - |
|
2857 | - /** |
|
2858 | - * Generate all the metaboxes for the message types and register them for the messages settings page. |
|
2859 | - * |
|
2860 | - * @access protected |
|
2861 | - * @return void |
|
2862 | - */ |
|
2863 | - protected function _messages_settings_metaboxes() |
|
2864 | - { |
|
2865 | - $this->_set_m_mt_settings(); |
|
2866 | - $m_boxes = $mt_boxes = array(); |
|
2867 | - $m_template_args = $mt_template_args = array(); |
|
2868 | - |
|
2869 | - $selected_messenger = isset($this->_req_data['selected_messenger']) ? $this->_req_data['selected_messenger'] : 'email'; |
|
2870 | - |
|
2871 | - if (isset($this->_m_mt_settings['messenger_tabs'])) { |
|
2872 | - foreach ($this->_m_mt_settings['messenger_tabs'] as $messenger => $tab_array) { |
|
2873 | - $hide_on_message = $this->_message_resource_manager->is_messenger_active($messenger) ? '' : 'hidden'; |
|
2874 | - $hide_off_message = $this->_message_resource_manager->is_messenger_active($messenger) ? 'hidden' : ''; |
|
2875 | - //messenger meta boxes |
|
2876 | - $active = $selected_messenger == $messenger ? true : false; |
|
2877 | - $active_mt_tabs = isset($this->_m_mt_settings['message_type_tabs'][$messenger]['active']) |
|
2878 | - ? $this->_m_mt_settings['message_type_tabs'][$messenger]['active'] |
|
2879 | - : ''; |
|
2880 | - $m_boxes[$messenger . '_a_box'] = sprintf( |
|
2881 | - __('%s Settings', 'event_espresso'), |
|
2882 | - $tab_array['label'] |
|
2883 | - ); |
|
2884 | - $m_template_args[$messenger . '_a_box'] = array( |
|
2885 | - 'active_message_types' => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '', |
|
2886 | - 'inactive_message_types' => isset($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive']) |
|
2887 | - ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive']) |
|
2888 | - : '', |
|
2889 | - 'content' => $this->_get_messenger_box_content($tab_array['obj']), |
|
2890 | - 'hidden' => $active ? '' : ' hidden', |
|
2891 | - 'hide_on_message' => $hide_on_message, |
|
2892 | - 'messenger' => $messenger, |
|
2893 | - 'active' => $active |
|
2894 | - ); |
|
2895 | - // message type meta boxes |
|
2896 | - // (which is really just the inactive container for each messenger |
|
2897 | - // showing inactive message types for that messenger) |
|
2898 | - $mt_boxes[$messenger . '_i_box'] = __('Inactive Message Types', 'event_espresso'); |
|
2899 | - $mt_template_args[$messenger . '_i_box'] = array( |
|
2900 | - 'active_message_types' => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '', |
|
2901 | - 'inactive_message_types' => isset($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive']) |
|
2902 | - ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive']) |
|
2903 | - : '', |
|
2904 | - 'hidden' => $active ? '' : ' hidden', |
|
2905 | - 'hide_on_message' => $hide_on_message, |
|
2906 | - 'hide_off_message' => $hide_off_message, |
|
2907 | - 'messenger' => $messenger, |
|
2908 | - 'active' => $active |
|
2909 | - ); |
|
2910 | - } |
|
2911 | - } |
|
2912 | - |
|
2913 | - |
|
2914 | - //register messenger metaboxes |
|
2915 | - $m_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_mt_meta_box.template.php'; |
|
2916 | - foreach ($m_boxes as $box => $label) { |
|
2917 | - $callback_args = array('template_path' => $m_template_path, 'template_args' => $m_template_args[$box]); |
|
2918 | - $msgr = str_replace('_a_box', '', $box); |
|
2919 | - add_meta_box( |
|
2920 | - 'espresso_' . $msgr . '_settings', |
|
2921 | - $label, |
|
2922 | - function ($post, $metabox) { |
|
2923 | - echo EEH_Template::display_template($metabox["args"]["template_path"], |
|
2924 | - $metabox["args"]["template_args"], true); |
|
2925 | - }, |
|
2926 | - $this->_current_screen->id, |
|
2927 | - 'normal', |
|
2928 | - 'high', |
|
2929 | - $callback_args |
|
2930 | - ); |
|
2931 | - } |
|
2932 | - |
|
2933 | - //register message type metaboxes |
|
2934 | - $mt_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_meta_box.template.php'; |
|
2935 | - foreach ($mt_boxes as $box => $label) { |
|
2936 | - $callback_args = array( |
|
2937 | - 'template_path' => $mt_template_path, |
|
2938 | - 'template_args' => $mt_template_args[$box] |
|
2939 | - ); |
|
2940 | - $mt = str_replace('_i_box', '', $box); |
|
2941 | - add_meta_box( |
|
2942 | - 'espresso_' . $mt . '_inactive_mts', |
|
2943 | - $label, |
|
2944 | - function ($post, $metabox) { |
|
2945 | - echo EEH_Template::display_template($metabox["args"]["template_path"], |
|
2946 | - $metabox["args"]["template_args"], true); |
|
2947 | - }, |
|
2948 | - $this->_current_screen->id, |
|
2949 | - 'side', |
|
2950 | - 'high', |
|
2951 | - $callback_args |
|
2952 | - ); |
|
2953 | - } |
|
2954 | - |
|
2955 | - //register metabox for global messages settings but only when on the main site. On single site installs this will |
|
2956 | - //always result in the metabox showing, on multisite installs the metabox will only show on the main site. |
|
2957 | - if (is_main_site()) { |
|
2958 | - add_meta_box( |
|
2959 | - 'espresso_global_message_settings', |
|
2960 | - __('Global Message Settings', 'event_espresso'), |
|
2961 | - array($this, 'global_messages_settings_metabox_content'), |
|
2962 | - $this->_current_screen->id, |
|
2963 | - 'normal', |
|
2964 | - 'low', |
|
2965 | - array() |
|
2966 | - ); |
|
2967 | - } |
|
2968 | - |
|
2969 | - } |
|
2970 | - |
|
2971 | - |
|
2972 | - /** |
|
2973 | - * This generates the content for the global messages settings metabox. |
|
2974 | - * @return string |
|
2975 | - */ |
|
2976 | - public function global_messages_settings_metabox_content() |
|
2977 | - { |
|
2978 | - $form = $this->_generate_global_settings_form(); |
|
2979 | - echo $form->form_open( |
|
2980 | - $this->add_query_args_and_nonce(array('action' => 'update_global_settings'), EE_MSG_ADMIN_URL), |
|
2981 | - 'POST' |
|
2982 | - ) |
|
2983 | - . $form->get_html() |
|
2984 | - . $form->form_close(); |
|
2985 | - } |
|
2986 | - |
|
2987 | - |
|
2988 | - /** |
|
2989 | - * This generates and returns the form object for the global messages settings. |
|
2990 | - * @return EE_Form_Section_Proper |
|
2991 | - */ |
|
2992 | - protected function _generate_global_settings_form() |
|
2993 | - { |
|
2994 | - EE_Registry::instance()->load_helper('HTML'); |
|
2995 | - /** @var EE_Network_Core_Config $network_config */ |
|
2996 | - $network_config = EE_Registry::instance()->NET_CFG->core; |
|
2997 | - |
|
2998 | - return new EE_Form_Section_Proper( |
|
2999 | - array( |
|
3000 | - 'name' => 'global_messages_settings', |
|
3001 | - 'html_id' => 'global_messages_settings', |
|
3002 | - 'html_class' => 'form-table', |
|
3003 | - 'layout_strategy' => new EE_Admin_Two_Column_Layout(), |
|
3004 | - 'subsections' => apply_filters( |
|
3005 | - 'FHEE__Messages_Admin_Page__global_messages_settings_metabox_content__form_subsections', |
|
3006 | - array( |
|
3007 | - 'do_messages_on_same_request' => new EE_Select_Input( |
|
3008 | - array( |
|
3009 | - true => __("On the same request", "event_espresso"), |
|
3010 | - false => __("On a separate request", "event_espresso") |
|
3011 | - ), |
|
3012 | - array( |
|
3013 | - 'default' => $network_config->do_messages_on_same_request, |
|
3014 | - 'html_label_text' => __('Generate and send all messages:', 'event_espresso'), |
|
3015 | - 'html_help_text' => __('By default the messages system uses a more efficient means of processing messages on separate requests and utilizes the wp-cron scheduling system. This makes things execute faster for people registering for your events. However, if the wp-cron system is disabled on your site and there is no alternative in place, then you can change this so messages are always executed on the same request.', |
|
3016 | - 'event_espresso'), |
|
3017 | - ) |
|
3018 | - ), |
|
3019 | - 'update_settings' => new EE_Submit_Input( |
|
3020 | - array( |
|
3021 | - 'default' => __('Update', 'event_espresso'), |
|
3022 | - 'html_label_text' => ' ' |
|
3023 | - ) |
|
3024 | - ) |
|
3025 | - ) |
|
3026 | - ) |
|
3027 | - ) |
|
3028 | - ); |
|
3029 | - } |
|
3030 | - |
|
3031 | - |
|
3032 | - /** |
|
3033 | - * This handles updating the global settings set on the admin page. |
|
3034 | - * @throws \EE_Error |
|
3035 | - */ |
|
3036 | - protected function _update_global_settings() |
|
3037 | - { |
|
3038 | - /** @var EE_Network_Core_Config $network_config */ |
|
3039 | - $network_config = EE_Registry::instance()->NET_CFG->core; |
|
3040 | - $form = $this->_generate_global_settings_form(); |
|
3041 | - if ($form->was_submitted()) { |
|
3042 | - $form->receive_form_submission(); |
|
3043 | - if ($form->is_valid()) { |
|
3044 | - $valid_data = $form->valid_data(); |
|
3045 | - foreach ($valid_data as $property => $value) { |
|
3046 | - $setter = 'set_' . $property; |
|
3047 | - if (method_exists($network_config, $setter)) { |
|
3048 | - $network_config->{$setter}($value); |
|
3049 | - } else if ( |
|
3050 | - property_exists($network_config, $property) |
|
3051 | - && $network_config->{$property} !== $value |
|
3052 | - ) { |
|
3053 | - $network_config->{$property} = $value; |
|
3054 | - } |
|
3055 | - } |
|
3056 | - //only update if the form submission was valid! |
|
3057 | - EE_Registry::instance()->NET_CFG->update_config(true, false); |
|
3058 | - EE_Error::overwrite_success(); |
|
3059 | - EE_Error::add_success(__('Global message settings were updated', 'event_espresso')); |
|
3060 | - } |
|
3061 | - } |
|
3062 | - $this->_redirect_after_action(0, '', '', array('action' => 'settings'), true); |
|
3063 | - } |
|
3064 | - |
|
3065 | - |
|
3066 | - /** |
|
3067 | - * this prepares the messenger tabs that can be dragged in and out of messenger boxes to activate/deactivate |
|
3068 | - * |
|
3069 | - * @param array $tab_array This is an array of message type tab details used to generate the tabs |
|
3070 | - * |
|
3071 | - * @return string html formatted tabs |
|
3072 | - */ |
|
3073 | - protected function _get_mt_tabs($tab_array) |
|
3074 | - { |
|
3075 | - $tab_array = (array)$tab_array; |
|
3076 | - $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_mt_settings_tab_item.template.php'; |
|
3077 | - $tabs = ''; |
|
3078 | - |
|
3079 | - foreach ($tab_array as $tab) { |
|
3080 | - $tabs .= EEH_Template::display_template($template, $tab, true); |
|
3081 | - } |
|
3082 | - |
|
3083 | - return $tabs; |
|
3084 | - } |
|
3085 | - |
|
3086 | - |
|
3087 | - /** |
|
3088 | - * This prepares the content of the messenger meta box admin settings |
|
3089 | - * |
|
3090 | - * @param EE_messenger $messenger The messenger we're setting up content for |
|
3091 | - * |
|
3092 | - * @return string html formatted content |
|
3093 | - */ |
|
3094 | - protected function _get_messenger_box_content(EE_messenger $messenger) |
|
3095 | - { |
|
3096 | - |
|
3097 | - $fields = $messenger->get_admin_settings_fields(); |
|
3098 | - $settings_template_args['template_form_fields'] = ''; |
|
3099 | - |
|
3100 | - //is $messenger active? |
|
3101 | - $settings_template_args['active'] = $this->_message_resource_manager->is_messenger_active($messenger->name); |
|
3102 | - |
|
3103 | - |
|
3104 | - if ( ! empty($fields)) { |
|
2824 | + $settings_template_args['template_form_fields'] = ! empty($template_form_field) ? $this->_generate_admin_form_fields($template_form_field, |
|
2825 | + 'string', 'ee_mt_activate_form') : ''; |
|
2826 | + } |
|
2827 | + |
|
2828 | + $settings_template_args['description'] = $message_type->description; |
|
2829 | + //we also need some hidden fields |
|
2830 | + $settings_template_args['hidden_fields'] = array( |
|
2831 | + 'message_type_settings[messenger]' => array( |
|
2832 | + 'type' => 'hidden', |
|
2833 | + 'value' => $messenger->name |
|
2834 | + ), |
|
2835 | + 'message_type_settings[message_type]' => array( |
|
2836 | + 'type' => 'hidden', |
|
2837 | + 'value' => $message_type->name |
|
2838 | + ), |
|
2839 | + 'type' => array( |
|
2840 | + 'type' => 'hidden', |
|
2841 | + 'value' => 'message_type' |
|
2842 | + ) |
|
2843 | + ); |
|
2844 | + |
|
2845 | + $settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields($settings_template_args['hidden_fields'], |
|
2846 | + 'array'); |
|
2847 | + $settings_template_args['show_form'] = empty($settings_template_args['template_form_fields']) ? ' hidden' : ''; |
|
2848 | + |
|
2849 | + |
|
2850 | + $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_mt_settings_content.template.php'; |
|
2851 | + $content = EEH_Template::display_template($template, $settings_template_args, true); |
|
2852 | + |
|
2853 | + return $content; |
|
2854 | + } |
|
2855 | + |
|
2856 | + |
|
2857 | + /** |
|
2858 | + * Generate all the metaboxes for the message types and register them for the messages settings page. |
|
2859 | + * |
|
2860 | + * @access protected |
|
2861 | + * @return void |
|
2862 | + */ |
|
2863 | + protected function _messages_settings_metaboxes() |
|
2864 | + { |
|
2865 | + $this->_set_m_mt_settings(); |
|
2866 | + $m_boxes = $mt_boxes = array(); |
|
2867 | + $m_template_args = $mt_template_args = array(); |
|
2868 | + |
|
2869 | + $selected_messenger = isset($this->_req_data['selected_messenger']) ? $this->_req_data['selected_messenger'] : 'email'; |
|
2870 | + |
|
2871 | + if (isset($this->_m_mt_settings['messenger_tabs'])) { |
|
2872 | + foreach ($this->_m_mt_settings['messenger_tabs'] as $messenger => $tab_array) { |
|
2873 | + $hide_on_message = $this->_message_resource_manager->is_messenger_active($messenger) ? '' : 'hidden'; |
|
2874 | + $hide_off_message = $this->_message_resource_manager->is_messenger_active($messenger) ? 'hidden' : ''; |
|
2875 | + //messenger meta boxes |
|
2876 | + $active = $selected_messenger == $messenger ? true : false; |
|
2877 | + $active_mt_tabs = isset($this->_m_mt_settings['message_type_tabs'][$messenger]['active']) |
|
2878 | + ? $this->_m_mt_settings['message_type_tabs'][$messenger]['active'] |
|
2879 | + : ''; |
|
2880 | + $m_boxes[$messenger . '_a_box'] = sprintf( |
|
2881 | + __('%s Settings', 'event_espresso'), |
|
2882 | + $tab_array['label'] |
|
2883 | + ); |
|
2884 | + $m_template_args[$messenger . '_a_box'] = array( |
|
2885 | + 'active_message_types' => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '', |
|
2886 | + 'inactive_message_types' => isset($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive']) |
|
2887 | + ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive']) |
|
2888 | + : '', |
|
2889 | + 'content' => $this->_get_messenger_box_content($tab_array['obj']), |
|
2890 | + 'hidden' => $active ? '' : ' hidden', |
|
2891 | + 'hide_on_message' => $hide_on_message, |
|
2892 | + 'messenger' => $messenger, |
|
2893 | + 'active' => $active |
|
2894 | + ); |
|
2895 | + // message type meta boxes |
|
2896 | + // (which is really just the inactive container for each messenger |
|
2897 | + // showing inactive message types for that messenger) |
|
2898 | + $mt_boxes[$messenger . '_i_box'] = __('Inactive Message Types', 'event_espresso'); |
|
2899 | + $mt_template_args[$messenger . '_i_box'] = array( |
|
2900 | + 'active_message_types' => ! empty($active_mt_tabs) ? $this->_get_mt_tabs($active_mt_tabs) : '', |
|
2901 | + 'inactive_message_types' => isset($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive']) |
|
2902 | + ? $this->_get_mt_tabs($this->_m_mt_settings['message_type_tabs'][$messenger]['inactive']) |
|
2903 | + : '', |
|
2904 | + 'hidden' => $active ? '' : ' hidden', |
|
2905 | + 'hide_on_message' => $hide_on_message, |
|
2906 | + 'hide_off_message' => $hide_off_message, |
|
2907 | + 'messenger' => $messenger, |
|
2908 | + 'active' => $active |
|
2909 | + ); |
|
2910 | + } |
|
2911 | + } |
|
2912 | + |
|
2913 | + |
|
2914 | + //register messenger metaboxes |
|
2915 | + $m_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_mt_meta_box.template.php'; |
|
2916 | + foreach ($m_boxes as $box => $label) { |
|
2917 | + $callback_args = array('template_path' => $m_template_path, 'template_args' => $m_template_args[$box]); |
|
2918 | + $msgr = str_replace('_a_box', '', $box); |
|
2919 | + add_meta_box( |
|
2920 | + 'espresso_' . $msgr . '_settings', |
|
2921 | + $label, |
|
2922 | + function ($post, $metabox) { |
|
2923 | + echo EEH_Template::display_template($metabox["args"]["template_path"], |
|
2924 | + $metabox["args"]["template_args"], true); |
|
2925 | + }, |
|
2926 | + $this->_current_screen->id, |
|
2927 | + 'normal', |
|
2928 | + 'high', |
|
2929 | + $callback_args |
|
2930 | + ); |
|
2931 | + } |
|
2932 | + |
|
2933 | + //register message type metaboxes |
|
2934 | + $mt_template_path = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_messenger_meta_box.template.php'; |
|
2935 | + foreach ($mt_boxes as $box => $label) { |
|
2936 | + $callback_args = array( |
|
2937 | + 'template_path' => $mt_template_path, |
|
2938 | + 'template_args' => $mt_template_args[$box] |
|
2939 | + ); |
|
2940 | + $mt = str_replace('_i_box', '', $box); |
|
2941 | + add_meta_box( |
|
2942 | + 'espresso_' . $mt . '_inactive_mts', |
|
2943 | + $label, |
|
2944 | + function ($post, $metabox) { |
|
2945 | + echo EEH_Template::display_template($metabox["args"]["template_path"], |
|
2946 | + $metabox["args"]["template_args"], true); |
|
2947 | + }, |
|
2948 | + $this->_current_screen->id, |
|
2949 | + 'side', |
|
2950 | + 'high', |
|
2951 | + $callback_args |
|
2952 | + ); |
|
2953 | + } |
|
2954 | + |
|
2955 | + //register metabox for global messages settings but only when on the main site. On single site installs this will |
|
2956 | + //always result in the metabox showing, on multisite installs the metabox will only show on the main site. |
|
2957 | + if (is_main_site()) { |
|
2958 | + add_meta_box( |
|
2959 | + 'espresso_global_message_settings', |
|
2960 | + __('Global Message Settings', 'event_espresso'), |
|
2961 | + array($this, 'global_messages_settings_metabox_content'), |
|
2962 | + $this->_current_screen->id, |
|
2963 | + 'normal', |
|
2964 | + 'low', |
|
2965 | + array() |
|
2966 | + ); |
|
2967 | + } |
|
2968 | + |
|
2969 | + } |
|
2970 | + |
|
2971 | + |
|
2972 | + /** |
|
2973 | + * This generates the content for the global messages settings metabox. |
|
2974 | + * @return string |
|
2975 | + */ |
|
2976 | + public function global_messages_settings_metabox_content() |
|
2977 | + { |
|
2978 | + $form = $this->_generate_global_settings_form(); |
|
2979 | + echo $form->form_open( |
|
2980 | + $this->add_query_args_and_nonce(array('action' => 'update_global_settings'), EE_MSG_ADMIN_URL), |
|
2981 | + 'POST' |
|
2982 | + ) |
|
2983 | + . $form->get_html() |
|
2984 | + . $form->form_close(); |
|
2985 | + } |
|
2986 | + |
|
2987 | + |
|
2988 | + /** |
|
2989 | + * This generates and returns the form object for the global messages settings. |
|
2990 | + * @return EE_Form_Section_Proper |
|
2991 | + */ |
|
2992 | + protected function _generate_global_settings_form() |
|
2993 | + { |
|
2994 | + EE_Registry::instance()->load_helper('HTML'); |
|
2995 | + /** @var EE_Network_Core_Config $network_config */ |
|
2996 | + $network_config = EE_Registry::instance()->NET_CFG->core; |
|
2997 | + |
|
2998 | + return new EE_Form_Section_Proper( |
|
2999 | + array( |
|
3000 | + 'name' => 'global_messages_settings', |
|
3001 | + 'html_id' => 'global_messages_settings', |
|
3002 | + 'html_class' => 'form-table', |
|
3003 | + 'layout_strategy' => new EE_Admin_Two_Column_Layout(), |
|
3004 | + 'subsections' => apply_filters( |
|
3005 | + 'FHEE__Messages_Admin_Page__global_messages_settings_metabox_content__form_subsections', |
|
3006 | + array( |
|
3007 | + 'do_messages_on_same_request' => new EE_Select_Input( |
|
3008 | + array( |
|
3009 | + true => __("On the same request", "event_espresso"), |
|
3010 | + false => __("On a separate request", "event_espresso") |
|
3011 | + ), |
|
3012 | + array( |
|
3013 | + 'default' => $network_config->do_messages_on_same_request, |
|
3014 | + 'html_label_text' => __('Generate and send all messages:', 'event_espresso'), |
|
3015 | + 'html_help_text' => __('By default the messages system uses a more efficient means of processing messages on separate requests and utilizes the wp-cron scheduling system. This makes things execute faster for people registering for your events. However, if the wp-cron system is disabled on your site and there is no alternative in place, then you can change this so messages are always executed on the same request.', |
|
3016 | + 'event_espresso'), |
|
3017 | + ) |
|
3018 | + ), |
|
3019 | + 'update_settings' => new EE_Submit_Input( |
|
3020 | + array( |
|
3021 | + 'default' => __('Update', 'event_espresso'), |
|
3022 | + 'html_label_text' => ' ' |
|
3023 | + ) |
|
3024 | + ) |
|
3025 | + ) |
|
3026 | + ) |
|
3027 | + ) |
|
3028 | + ); |
|
3029 | + } |
|
3030 | + |
|
3031 | + |
|
3032 | + /** |
|
3033 | + * This handles updating the global settings set on the admin page. |
|
3034 | + * @throws \EE_Error |
|
3035 | + */ |
|
3036 | + protected function _update_global_settings() |
|
3037 | + { |
|
3038 | + /** @var EE_Network_Core_Config $network_config */ |
|
3039 | + $network_config = EE_Registry::instance()->NET_CFG->core; |
|
3040 | + $form = $this->_generate_global_settings_form(); |
|
3041 | + if ($form->was_submitted()) { |
|
3042 | + $form->receive_form_submission(); |
|
3043 | + if ($form->is_valid()) { |
|
3044 | + $valid_data = $form->valid_data(); |
|
3045 | + foreach ($valid_data as $property => $value) { |
|
3046 | + $setter = 'set_' . $property; |
|
3047 | + if (method_exists($network_config, $setter)) { |
|
3048 | + $network_config->{$setter}($value); |
|
3049 | + } else if ( |
|
3050 | + property_exists($network_config, $property) |
|
3051 | + && $network_config->{$property} !== $value |
|
3052 | + ) { |
|
3053 | + $network_config->{$property} = $value; |
|
3054 | + } |
|
3055 | + } |
|
3056 | + //only update if the form submission was valid! |
|
3057 | + EE_Registry::instance()->NET_CFG->update_config(true, false); |
|
3058 | + EE_Error::overwrite_success(); |
|
3059 | + EE_Error::add_success(__('Global message settings were updated', 'event_espresso')); |
|
3060 | + } |
|
3061 | + } |
|
3062 | + $this->_redirect_after_action(0, '', '', array('action' => 'settings'), true); |
|
3063 | + } |
|
3064 | + |
|
3065 | + |
|
3066 | + /** |
|
3067 | + * this prepares the messenger tabs that can be dragged in and out of messenger boxes to activate/deactivate |
|
3068 | + * |
|
3069 | + * @param array $tab_array This is an array of message type tab details used to generate the tabs |
|
3070 | + * |
|
3071 | + * @return string html formatted tabs |
|
3072 | + */ |
|
3073 | + protected function _get_mt_tabs($tab_array) |
|
3074 | + { |
|
3075 | + $tab_array = (array)$tab_array; |
|
3076 | + $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_details_mt_settings_tab_item.template.php'; |
|
3077 | + $tabs = ''; |
|
3078 | + |
|
3079 | + foreach ($tab_array as $tab) { |
|
3080 | + $tabs .= EEH_Template::display_template($template, $tab, true); |
|
3081 | + } |
|
3082 | + |
|
3083 | + return $tabs; |
|
3084 | + } |
|
3085 | + |
|
3086 | + |
|
3087 | + /** |
|
3088 | + * This prepares the content of the messenger meta box admin settings |
|
3089 | + * |
|
3090 | + * @param EE_messenger $messenger The messenger we're setting up content for |
|
3091 | + * |
|
3092 | + * @return string html formatted content |
|
3093 | + */ |
|
3094 | + protected function _get_messenger_box_content(EE_messenger $messenger) |
|
3095 | + { |
|
3096 | + |
|
3097 | + $fields = $messenger->get_admin_settings_fields(); |
|
3098 | + $settings_template_args['template_form_fields'] = ''; |
|
3099 | + |
|
3100 | + //is $messenger active? |
|
3101 | + $settings_template_args['active'] = $this->_message_resource_manager->is_messenger_active($messenger->name); |
|
3102 | + |
|
3103 | + |
|
3104 | + if ( ! empty($fields)) { |
|
3105 | 3105 | |
3106 | - $existing_settings = $messenger->get_existing_admin_settings(); |
|
3106 | + $existing_settings = $messenger->get_existing_admin_settings(); |
|
3107 | 3107 | |
3108 | - foreach ($fields as $fldname => $fldprops) { |
|
3109 | - $field_id = $messenger->name . '-' . $fldname; |
|
3110 | - $template_form_field[$field_id] = array( |
|
3111 | - 'name' => 'messenger_settings[' . $field_id . ']', |
|
3112 | - 'label' => $fldprops['label'], |
|
3113 | - 'input' => $fldprops['field_type'], |
|
3114 | - 'type' => $fldprops['value_type'], |
|
3115 | - 'required' => $fldprops['required'], |
|
3116 | - 'validation' => $fldprops['validation'], |
|
3117 | - 'value' => isset($existing_settings[$field_id]) |
|
3118 | - ? $existing_settings[$field_id] |
|
3119 | - : $fldprops['default'], |
|
3120 | - 'css_class' => '', |
|
3121 | - 'format' => $fldprops['format'] |
|
3122 | - ); |
|
3123 | - } |
|
3108 | + foreach ($fields as $fldname => $fldprops) { |
|
3109 | + $field_id = $messenger->name . '-' . $fldname; |
|
3110 | + $template_form_field[$field_id] = array( |
|
3111 | + 'name' => 'messenger_settings[' . $field_id . ']', |
|
3112 | + 'label' => $fldprops['label'], |
|
3113 | + 'input' => $fldprops['field_type'], |
|
3114 | + 'type' => $fldprops['value_type'], |
|
3115 | + 'required' => $fldprops['required'], |
|
3116 | + 'validation' => $fldprops['validation'], |
|
3117 | + 'value' => isset($existing_settings[$field_id]) |
|
3118 | + ? $existing_settings[$field_id] |
|
3119 | + : $fldprops['default'], |
|
3120 | + 'css_class' => '', |
|
3121 | + 'format' => $fldprops['format'] |
|
3122 | + ); |
|
3123 | + } |
|
3124 | 3124 | |
3125 | 3125 | |
3126 | - $settings_template_args['template_form_fields'] = ! empty($template_form_field) |
|
3127 | - ? $this->_generate_admin_form_fields($template_form_field, 'string', 'ee_m_activate_form') |
|
3128 | - : ''; |
|
3129 | - } |
|
3130 | - |
|
3131 | - //we also need some hidden fields |
|
3132 | - $settings_template_args['hidden_fields'] = array( |
|
3133 | - 'messenger_settings[messenger]' => array( |
|
3134 | - 'type' => 'hidden', |
|
3135 | - 'value' => $messenger->name |
|
3136 | - ), |
|
3137 | - 'type' => array( |
|
3138 | - 'type' => 'hidden', |
|
3139 | - 'value' => 'messenger' |
|
3140 | - ) |
|
3141 | - ); |
|
3142 | - |
|
3143 | - //make sure any active message types that are existing are included in the hidden fields |
|
3144 | - if (isset($this->_m_mt_settings['message_type_tabs'][$messenger->name]['active'])) { |
|
3145 | - foreach ($this->_m_mt_settings['message_type_tabs'][$messenger->name]['active'] as $mt => $values) { |
|
3146 | - $settings_template_args['hidden_fields']['messenger_settings[message_types][' . $mt . ']'] = array( |
|
3147 | - 'type' => 'hidden', |
|
3148 | - 'value' => $mt |
|
3149 | - ); |
|
3150 | - } |
|
3151 | - } |
|
3152 | - $settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields( |
|
3153 | - $settings_template_args['hidden_fields'], |
|
3154 | - 'array' |
|
3155 | - ); |
|
3156 | - $active = $this->_message_resource_manager->is_messenger_active($messenger->name); |
|
3157 | - |
|
3158 | - $settings_template_args['messenger'] = $messenger->name; |
|
3159 | - $settings_template_args['description'] = $messenger->description; |
|
3160 | - $settings_template_args['show_hide_edit_form'] = $active ? '' : ' hidden'; |
|
3161 | - |
|
3162 | - |
|
3163 | - $settings_template_args['show_hide_edit_form'] = $this->_message_resource_manager->is_messenger_active($messenger->name) |
|
3164 | - ? $settings_template_args['show_hide_edit_form'] |
|
3165 | - : ' hidden'; |
|
3166 | - |
|
3167 | - $settings_template_args['show_hide_edit_form'] = empty($settings_template_args['template_form_fields']) |
|
3168 | - ? ' hidden' |
|
3169 | - : $settings_template_args['show_hide_edit_form']; |
|
3170 | - |
|
3171 | - |
|
3172 | - $settings_template_args['on_off_action'] = $active ? 'messenger-off' : 'messenger-on'; |
|
3173 | - $settings_template_args['nonce'] = wp_create_nonce('activate_' . $messenger->name . '_toggle_nonce'); |
|
3174 | - $settings_template_args['on_off_status'] = $active ? true : false; |
|
3175 | - $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_m_settings_content.template.php'; |
|
3176 | - $content = EEH_Template::display_template($template, $settings_template_args, |
|
3177 | - true); |
|
3178 | - |
|
3179 | - return $content; |
|
3180 | - } |
|
3181 | - |
|
3182 | - |
|
3183 | - /** |
|
3184 | - * used by ajax on the messages settings page to activate|deactivate the messenger |
|
3185 | - */ |
|
3186 | - public function activate_messenger_toggle() |
|
3187 | - { |
|
3188 | - $success = true; |
|
3189 | - $this->_prep_default_response_for_messenger_or_message_type_toggle(); |
|
3190 | - //let's check that we have required data |
|
3191 | - if ( ! isset($this->_req_data['messenger'])) { |
|
3192 | - EE_Error::add_error( |
|
3193 | - __('Messenger name needed to toggle activation. None given', 'event_espresso'), |
|
3194 | - __FILE__, |
|
3195 | - __FUNCTION__, |
|
3196 | - __LINE__ |
|
3197 | - ); |
|
3198 | - $success = false; |
|
3199 | - } |
|
3200 | - |
|
3201 | - //do a nonce check here since we're not arriving via a normal route |
|
3202 | - $nonce = isset($this->_req_data['activate_nonce']) ? sanitize_text_field($this->_req_data['activate_nonce']) : ''; |
|
3203 | - $nonce_ref = 'activate_' . $this->_req_data['messenger'] . '_toggle_nonce'; |
|
3204 | - |
|
3205 | - $this->_verify_nonce($nonce, $nonce_ref); |
|
3206 | - |
|
3207 | - |
|
3208 | - if ( ! isset($this->_req_data['status'])) { |
|
3209 | - EE_Error::add_error( |
|
3210 | - __( |
|
3211 | - 'Messenger status needed to know whether activation or deactivation is happening. No status is given', |
|
3212 | - 'event_espresso' |
|
3213 | - ), |
|
3214 | - __FILE__, |
|
3215 | - __FUNCTION__, |
|
3216 | - __LINE__ |
|
3217 | - ); |
|
3218 | - $success = false; |
|
3219 | - } |
|
3220 | - |
|
3221 | - //do check to verify we have a valid status. |
|
3222 | - $status = $this->_req_data['status']; |
|
3223 | - |
|
3224 | - if ($status != 'off' && $status != 'on') { |
|
3225 | - EE_Error::add_error( |
|
3226 | - sprintf( |
|
3227 | - __('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'), |
|
3228 | - $this->_req_data['status'] |
|
3229 | - ), |
|
3230 | - __FILE__, |
|
3231 | - __FUNCTION__, |
|
3232 | - __LINE__ |
|
3233 | - ); |
|
3234 | - $success = false; |
|
3235 | - } |
|
3236 | - |
|
3237 | - if ($success) { |
|
3238 | - //made it here? Stop dawdling then!! |
|
3239 | - $success = $status == 'off' |
|
3240 | - ? $this->_deactivate_messenger($this->_req_data['messenger']) |
|
3241 | - : $this->_activate_messenger($this->_req_data['messenger']); |
|
3242 | - } |
|
3243 | - |
|
3244 | - $this->_template_args['success'] = $success; |
|
3245 | - |
|
3246 | - //no special instructions so let's just do the json return (which should automatically do all the special stuff). |
|
3247 | - $this->_return_json(); |
|
3248 | - |
|
3249 | - } |
|
3250 | - |
|
3251 | - |
|
3252 | - /** |
|
3253 | - * used by ajax from the messages settings page to activate|deactivate a message type |
|
3254 | - * |
|
3255 | - */ |
|
3256 | - public function activate_mt_toggle() |
|
3257 | - { |
|
3258 | - $success = true; |
|
3259 | - $this->_prep_default_response_for_messenger_or_message_type_toggle(); |
|
3260 | - |
|
3261 | - //let's make sure we have the necessary data |
|
3262 | - if ( ! isset($this->_req_data['message_type'])) { |
|
3263 | - EE_Error::add_error( |
|
3264 | - __('Message Type name needed to toggle activation. None given', 'event_espresso'), |
|
3265 | - __FILE__, __FUNCTION__, __LINE__ |
|
3266 | - ); |
|
3267 | - $success = false; |
|
3268 | - } |
|
3269 | - |
|
3270 | - if ( ! isset($this->_req_data['messenger'])) { |
|
3271 | - EE_Error::add_error( |
|
3272 | - __('Messenger name needed to toggle activation. None given', 'event_espresso'), |
|
3273 | - __FILE__, __FUNCTION__, __LINE__ |
|
3274 | - ); |
|
3275 | - $success = false; |
|
3276 | - } |
|
3277 | - |
|
3278 | - if ( ! isset($this->_req_data['status'])) { |
|
3279 | - EE_Error::add_error( |
|
3280 | - __('Messenger status needed to know whether activation or deactivation is happening. No status is given', |
|
3281 | - 'event_espresso'), |
|
3282 | - __FILE__, __FUNCTION__, __LINE__ |
|
3283 | - ); |
|
3284 | - $success = false; |
|
3285 | - } |
|
3286 | - |
|
3287 | - |
|
3288 | - //do check to verify we have a valid status. |
|
3289 | - $status = $this->_req_data['status']; |
|
3290 | - |
|
3291 | - if ($status != 'activate' && $status != 'deactivate') { |
|
3292 | - EE_Error::add_error( |
|
3293 | - sprintf( |
|
3294 | - __('The given status (%s) is not valid. Must be "active" or "inactive"', 'event_espresso'), |
|
3295 | - $this->_req_data['status'] |
|
3296 | - ), |
|
3297 | - __FILE__, __FUNCTION__, __LINE__ |
|
3298 | - ); |
|
3299 | - $success = false; |
|
3300 | - } |
|
3301 | - |
|
3302 | - |
|
3303 | - //do a nonce check here since we're not arriving via a normal route |
|
3304 | - $nonce = isset($this->_req_data['mt_nonce']) ? sanitize_text_field($this->_req_data['mt_nonce']) : ''; |
|
3305 | - $nonce_ref = $this->_req_data['message_type'] . '_nonce'; |
|
3306 | - |
|
3307 | - $this->_verify_nonce($nonce, $nonce_ref); |
|
3308 | - |
|
3309 | - if ($success) { |
|
3310 | - //made it here? um, what are you waiting for then? |
|
3311 | - $success = $status == 'deactivate' |
|
3312 | - ? $this->_deactivate_message_type_for_messenger($this->_req_data['messenger'], |
|
3313 | - $this->_req_data['message_type']) |
|
3314 | - : $this->_activate_message_type_for_messenger($this->_req_data['messenger'], |
|
3315 | - $this->_req_data['message_type']); |
|
3316 | - } |
|
3317 | - |
|
3318 | - $this->_template_args['success'] = $success; |
|
3319 | - $this->_return_json(); |
|
3320 | - } |
|
3321 | - |
|
3322 | - |
|
3323 | - /** |
|
3324 | - * Takes care of processing activating a messenger and preparing the appropriate response. |
|
3325 | - * |
|
3326 | - * @param string $messenger_name The name of the messenger being activated |
|
3327 | - * |
|
3328 | - * @return bool |
|
3329 | - */ |
|
3330 | - protected function _activate_messenger($messenger_name) |
|
3331 | - { |
|
3332 | - /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */ |
|
3333 | - $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name); |
|
3334 | - $message_types_to_activate = $active_messenger instanceof EE_Messenger ? $active_messenger->get_default_message_types() : array(); |
|
3335 | - |
|
3336 | - //ensure is active |
|
3337 | - $this->_message_resource_manager->activate_messenger($messenger_name, $message_types_to_activate); |
|
3338 | - |
|
3339 | - //set response_data for reload |
|
3340 | - foreach ($message_types_to_activate as $message_type_name) { |
|
3341 | - /** @var EE_message_type $message_type */ |
|
3342 | - $message_type = $this->_message_resource_manager->get_message_type($message_type_name); |
|
3343 | - if ($this->_message_resource_manager->is_message_type_active_for_messenger($messenger_name, |
|
3344 | - $message_type_name) |
|
3345 | - && $message_type instanceof EE_message_type |
|
3346 | - ) { |
|
3347 | - $this->_template_args['data']['active_mts'][] = $message_type_name; |
|
3348 | - if ($message_type->get_admin_settings_fields()) { |
|
3349 | - $this->_template_args['data']['mt_reload'][] = $message_type_name; |
|
3350 | - } |
|
3351 | - } |
|
3352 | - } |
|
3353 | - |
|
3354 | - //add success message for activating messenger |
|
3355 | - return $this->_setup_response_message_for_activating_messenger_with_message_types($active_messenger); |
|
3356 | - |
|
3357 | - } |
|
3358 | - |
|
3359 | - |
|
3360 | - /** |
|
3361 | - * Takes care of processing deactivating a messenger and preparing the appropriate response. |
|
3362 | - * |
|
3363 | - * @param string $messenger_name The name of the messenger being activated |
|
3364 | - * |
|
3365 | - * @return bool |
|
3366 | - */ |
|
3367 | - protected function _deactivate_messenger($messenger_name) |
|
3368 | - { |
|
3369 | - /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */ |
|
3370 | - $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name); |
|
3371 | - $this->_message_resource_manager->deactivate_messenger($messenger_name); |
|
3372 | - |
|
3373 | - return $this->_setup_response_message_for_deactivating_messenger_with_message_types($active_messenger); |
|
3374 | - } |
|
3375 | - |
|
3376 | - |
|
3377 | - /** |
|
3378 | - * Takes care of processing activating a message type for a messenger and preparing the appropriate response. |
|
3379 | - * |
|
3380 | - * @param string $messenger_name The name of the messenger the message type is being activated for. |
|
3381 | - * @param string $message_type_name The name of the message type being activated for the messenger |
|
3382 | - * |
|
3383 | - * @return bool |
|
3384 | - */ |
|
3385 | - protected function _activate_message_type_for_messenger($messenger_name, $message_type_name) |
|
3386 | - { |
|
3387 | - /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */ |
|
3388 | - $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name); |
|
3389 | - /** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */ |
|
3390 | - $message_type_to_activate = $this->_message_resource_manager->get_message_type($message_type_name); |
|
3391 | - |
|
3392 | - //ensure is active |
|
3393 | - $this->_message_resource_manager->activate_messenger($messenger_name, $message_type_name); |
|
3394 | - |
|
3395 | - //set response for load |
|
3396 | - if ($this->_message_resource_manager->is_message_type_active_for_messenger($messenger_name, |
|
3397 | - $message_type_name) |
|
3398 | - ) { |
|
3399 | - $this->_template_args['data']['active_mts'][] = $message_type_name; |
|
3400 | - if ($message_type_to_activate->get_admin_settings_fields()) { |
|
3401 | - $this->_template_args['data']['mt_reload'][] = $message_type_name; |
|
3402 | - } |
|
3403 | - } |
|
3404 | - |
|
3405 | - return $this->_setup_response_message_for_activating_messenger_with_message_types($active_messenger, |
|
3406 | - $message_type_to_activate); |
|
3407 | - } |
|
3408 | - |
|
3409 | - |
|
3410 | - /** |
|
3411 | - * Takes care of processing deactivating a message type for a messenger and preparing the appropriate response. |
|
3412 | - * |
|
3413 | - * @param string $messenger_name The name of the messenger the message type is being deactivated for. |
|
3414 | - * @param string $message_type_name The name of the message type being deactivated for the messenger |
|
3415 | - * |
|
3416 | - * @return bool |
|
3417 | - */ |
|
3418 | - protected function _deactivate_message_type_for_messenger($messenger_name, $message_type_name) |
|
3419 | - { |
|
3420 | - /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */ |
|
3421 | - $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name); |
|
3422 | - /** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */ |
|
3423 | - $message_type_to_deactivate = $this->_message_resource_manager->get_message_type($message_type_name); |
|
3424 | - $this->_message_resource_manager->deactivate_message_type_for_messenger($message_type_name, $messenger_name); |
|
3425 | - |
|
3426 | - return $this->_setup_response_message_for_deactivating_messenger_with_message_types($active_messenger, |
|
3427 | - $message_type_to_deactivate); |
|
3428 | - } |
|
3429 | - |
|
3430 | - |
|
3431 | - /** |
|
3432 | - * This just initializes the defaults for activating messenger and message type responses. |
|
3433 | - */ |
|
3434 | - protected function _prep_default_response_for_messenger_or_message_type_toggle() |
|
3435 | - { |
|
3436 | - $this->_template_args['data']['active_mts'] = array(); |
|
3437 | - $this->_template_args['data']['mt_reload'] = array(); |
|
3438 | - } |
|
3439 | - |
|
3440 | - |
|
3441 | - /** |
|
3442 | - * Setup appropriate response for activating a messenger and/or message types |
|
3443 | - * |
|
3444 | - * @param EE_messenger $messenger |
|
3445 | - * @param EE_message_type|null $message_type |
|
3446 | - * |
|
3447 | - * @return bool |
|
3448 | - * @throws EE_Error |
|
3449 | - */ |
|
3450 | - protected function _setup_response_message_for_activating_messenger_with_message_types( |
|
3451 | - $messenger, |
|
3452 | - EE_Message_Type $message_type = null |
|
3453 | - ) { |
|
3454 | - //if $messenger isn't a valid messenger object then get out. |
|
3455 | - if ( ! $messenger instanceof EE_Messenger) { |
|
3456 | - EE_Error::add_error( |
|
3457 | - __('The messenger being activated is not a valid messenger', 'event_espresso'), |
|
3458 | - __FILE__, |
|
3459 | - __FUNCTION__, |
|
3460 | - __LINE__ |
|
3461 | - ); |
|
3126 | + $settings_template_args['template_form_fields'] = ! empty($template_form_field) |
|
3127 | + ? $this->_generate_admin_form_fields($template_form_field, 'string', 'ee_m_activate_form') |
|
3128 | + : ''; |
|
3129 | + } |
|
3130 | + |
|
3131 | + //we also need some hidden fields |
|
3132 | + $settings_template_args['hidden_fields'] = array( |
|
3133 | + 'messenger_settings[messenger]' => array( |
|
3134 | + 'type' => 'hidden', |
|
3135 | + 'value' => $messenger->name |
|
3136 | + ), |
|
3137 | + 'type' => array( |
|
3138 | + 'type' => 'hidden', |
|
3139 | + 'value' => 'messenger' |
|
3140 | + ) |
|
3141 | + ); |
|
3142 | + |
|
3143 | + //make sure any active message types that are existing are included in the hidden fields |
|
3144 | + if (isset($this->_m_mt_settings['message_type_tabs'][$messenger->name]['active'])) { |
|
3145 | + foreach ($this->_m_mt_settings['message_type_tabs'][$messenger->name]['active'] as $mt => $values) { |
|
3146 | + $settings_template_args['hidden_fields']['messenger_settings[message_types][' . $mt . ']'] = array( |
|
3147 | + 'type' => 'hidden', |
|
3148 | + 'value' => $mt |
|
3149 | + ); |
|
3150 | + } |
|
3151 | + } |
|
3152 | + $settings_template_args['hidden_fields'] = $this->_generate_admin_form_fields( |
|
3153 | + $settings_template_args['hidden_fields'], |
|
3154 | + 'array' |
|
3155 | + ); |
|
3156 | + $active = $this->_message_resource_manager->is_messenger_active($messenger->name); |
|
3157 | + |
|
3158 | + $settings_template_args['messenger'] = $messenger->name; |
|
3159 | + $settings_template_args['description'] = $messenger->description; |
|
3160 | + $settings_template_args['show_hide_edit_form'] = $active ? '' : ' hidden'; |
|
3161 | + |
|
3162 | + |
|
3163 | + $settings_template_args['show_hide_edit_form'] = $this->_message_resource_manager->is_messenger_active($messenger->name) |
|
3164 | + ? $settings_template_args['show_hide_edit_form'] |
|
3165 | + : ' hidden'; |
|
3166 | + |
|
3167 | + $settings_template_args['show_hide_edit_form'] = empty($settings_template_args['template_form_fields']) |
|
3168 | + ? ' hidden' |
|
3169 | + : $settings_template_args['show_hide_edit_form']; |
|
3170 | + |
|
3171 | + |
|
3172 | + $settings_template_args['on_off_action'] = $active ? 'messenger-off' : 'messenger-on'; |
|
3173 | + $settings_template_args['nonce'] = wp_create_nonce('activate_' . $messenger->name . '_toggle_nonce'); |
|
3174 | + $settings_template_args['on_off_status'] = $active ? true : false; |
|
3175 | + $template = EE_MSG_TEMPLATE_PATH . 'ee_msg_m_settings_content.template.php'; |
|
3176 | + $content = EEH_Template::display_template($template, $settings_template_args, |
|
3177 | + true); |
|
3178 | + |
|
3179 | + return $content; |
|
3180 | + } |
|
3181 | + |
|
3182 | + |
|
3183 | + /** |
|
3184 | + * used by ajax on the messages settings page to activate|deactivate the messenger |
|
3185 | + */ |
|
3186 | + public function activate_messenger_toggle() |
|
3187 | + { |
|
3188 | + $success = true; |
|
3189 | + $this->_prep_default_response_for_messenger_or_message_type_toggle(); |
|
3190 | + //let's check that we have required data |
|
3191 | + if ( ! isset($this->_req_data['messenger'])) { |
|
3192 | + EE_Error::add_error( |
|
3193 | + __('Messenger name needed to toggle activation. None given', 'event_espresso'), |
|
3194 | + __FILE__, |
|
3195 | + __FUNCTION__, |
|
3196 | + __LINE__ |
|
3197 | + ); |
|
3198 | + $success = false; |
|
3199 | + } |
|
3200 | + |
|
3201 | + //do a nonce check here since we're not arriving via a normal route |
|
3202 | + $nonce = isset($this->_req_data['activate_nonce']) ? sanitize_text_field($this->_req_data['activate_nonce']) : ''; |
|
3203 | + $nonce_ref = 'activate_' . $this->_req_data['messenger'] . '_toggle_nonce'; |
|
3204 | + |
|
3205 | + $this->_verify_nonce($nonce, $nonce_ref); |
|
3206 | + |
|
3207 | + |
|
3208 | + if ( ! isset($this->_req_data['status'])) { |
|
3209 | + EE_Error::add_error( |
|
3210 | + __( |
|
3211 | + 'Messenger status needed to know whether activation or deactivation is happening. No status is given', |
|
3212 | + 'event_espresso' |
|
3213 | + ), |
|
3214 | + __FILE__, |
|
3215 | + __FUNCTION__, |
|
3216 | + __LINE__ |
|
3217 | + ); |
|
3218 | + $success = false; |
|
3219 | + } |
|
3220 | + |
|
3221 | + //do check to verify we have a valid status. |
|
3222 | + $status = $this->_req_data['status']; |
|
3223 | + |
|
3224 | + if ($status != 'off' && $status != 'on') { |
|
3225 | + EE_Error::add_error( |
|
3226 | + sprintf( |
|
3227 | + __('The given status (%s) is not valid. Must be "off" or "on"', 'event_espresso'), |
|
3228 | + $this->_req_data['status'] |
|
3229 | + ), |
|
3230 | + __FILE__, |
|
3231 | + __FUNCTION__, |
|
3232 | + __LINE__ |
|
3233 | + ); |
|
3234 | + $success = false; |
|
3235 | + } |
|
3236 | + |
|
3237 | + if ($success) { |
|
3238 | + //made it here? Stop dawdling then!! |
|
3239 | + $success = $status == 'off' |
|
3240 | + ? $this->_deactivate_messenger($this->_req_data['messenger']) |
|
3241 | + : $this->_activate_messenger($this->_req_data['messenger']); |
|
3242 | + } |
|
3243 | + |
|
3244 | + $this->_template_args['success'] = $success; |
|
3245 | + |
|
3246 | + //no special instructions so let's just do the json return (which should automatically do all the special stuff). |
|
3247 | + $this->_return_json(); |
|
3248 | + |
|
3249 | + } |
|
3250 | + |
|
3251 | + |
|
3252 | + /** |
|
3253 | + * used by ajax from the messages settings page to activate|deactivate a message type |
|
3254 | + * |
|
3255 | + */ |
|
3256 | + public function activate_mt_toggle() |
|
3257 | + { |
|
3258 | + $success = true; |
|
3259 | + $this->_prep_default_response_for_messenger_or_message_type_toggle(); |
|
3260 | + |
|
3261 | + //let's make sure we have the necessary data |
|
3262 | + if ( ! isset($this->_req_data['message_type'])) { |
|
3263 | + EE_Error::add_error( |
|
3264 | + __('Message Type name needed to toggle activation. None given', 'event_espresso'), |
|
3265 | + __FILE__, __FUNCTION__, __LINE__ |
|
3266 | + ); |
|
3267 | + $success = false; |
|
3268 | + } |
|
3269 | + |
|
3270 | + if ( ! isset($this->_req_data['messenger'])) { |
|
3271 | + EE_Error::add_error( |
|
3272 | + __('Messenger name needed to toggle activation. None given', 'event_espresso'), |
|
3273 | + __FILE__, __FUNCTION__, __LINE__ |
|
3274 | + ); |
|
3275 | + $success = false; |
|
3276 | + } |
|
3277 | + |
|
3278 | + if ( ! isset($this->_req_data['status'])) { |
|
3279 | + EE_Error::add_error( |
|
3280 | + __('Messenger status needed to know whether activation or deactivation is happening. No status is given', |
|
3281 | + 'event_espresso'), |
|
3282 | + __FILE__, __FUNCTION__, __LINE__ |
|
3283 | + ); |
|
3284 | + $success = false; |
|
3285 | + } |
|
3286 | + |
|
3287 | + |
|
3288 | + //do check to verify we have a valid status. |
|
3289 | + $status = $this->_req_data['status']; |
|
3290 | + |
|
3291 | + if ($status != 'activate' && $status != 'deactivate') { |
|
3292 | + EE_Error::add_error( |
|
3293 | + sprintf( |
|
3294 | + __('The given status (%s) is not valid. Must be "active" or "inactive"', 'event_espresso'), |
|
3295 | + $this->_req_data['status'] |
|
3296 | + ), |
|
3297 | + __FILE__, __FUNCTION__, __LINE__ |
|
3298 | + ); |
|
3299 | + $success = false; |
|
3300 | + } |
|
3301 | + |
|
3302 | + |
|
3303 | + //do a nonce check here since we're not arriving via a normal route |
|
3304 | + $nonce = isset($this->_req_data['mt_nonce']) ? sanitize_text_field($this->_req_data['mt_nonce']) : ''; |
|
3305 | + $nonce_ref = $this->_req_data['message_type'] . '_nonce'; |
|
3306 | + |
|
3307 | + $this->_verify_nonce($nonce, $nonce_ref); |
|
3308 | + |
|
3309 | + if ($success) { |
|
3310 | + //made it here? um, what are you waiting for then? |
|
3311 | + $success = $status == 'deactivate' |
|
3312 | + ? $this->_deactivate_message_type_for_messenger($this->_req_data['messenger'], |
|
3313 | + $this->_req_data['message_type']) |
|
3314 | + : $this->_activate_message_type_for_messenger($this->_req_data['messenger'], |
|
3315 | + $this->_req_data['message_type']); |
|
3316 | + } |
|
3317 | + |
|
3318 | + $this->_template_args['success'] = $success; |
|
3319 | + $this->_return_json(); |
|
3320 | + } |
|
3321 | + |
|
3322 | + |
|
3323 | + /** |
|
3324 | + * Takes care of processing activating a messenger and preparing the appropriate response. |
|
3325 | + * |
|
3326 | + * @param string $messenger_name The name of the messenger being activated |
|
3327 | + * |
|
3328 | + * @return bool |
|
3329 | + */ |
|
3330 | + protected function _activate_messenger($messenger_name) |
|
3331 | + { |
|
3332 | + /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */ |
|
3333 | + $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name); |
|
3334 | + $message_types_to_activate = $active_messenger instanceof EE_Messenger ? $active_messenger->get_default_message_types() : array(); |
|
3335 | + |
|
3336 | + //ensure is active |
|
3337 | + $this->_message_resource_manager->activate_messenger($messenger_name, $message_types_to_activate); |
|
3338 | + |
|
3339 | + //set response_data for reload |
|
3340 | + foreach ($message_types_to_activate as $message_type_name) { |
|
3341 | + /** @var EE_message_type $message_type */ |
|
3342 | + $message_type = $this->_message_resource_manager->get_message_type($message_type_name); |
|
3343 | + if ($this->_message_resource_manager->is_message_type_active_for_messenger($messenger_name, |
|
3344 | + $message_type_name) |
|
3345 | + && $message_type instanceof EE_message_type |
|
3346 | + ) { |
|
3347 | + $this->_template_args['data']['active_mts'][] = $message_type_name; |
|
3348 | + if ($message_type->get_admin_settings_fields()) { |
|
3349 | + $this->_template_args['data']['mt_reload'][] = $message_type_name; |
|
3350 | + } |
|
3351 | + } |
|
3352 | + } |
|
3353 | + |
|
3354 | + //add success message for activating messenger |
|
3355 | + return $this->_setup_response_message_for_activating_messenger_with_message_types($active_messenger); |
|
3356 | + |
|
3357 | + } |
|
3358 | + |
|
3359 | + |
|
3360 | + /** |
|
3361 | + * Takes care of processing deactivating a messenger and preparing the appropriate response. |
|
3362 | + * |
|
3363 | + * @param string $messenger_name The name of the messenger being activated |
|
3364 | + * |
|
3365 | + * @return bool |
|
3366 | + */ |
|
3367 | + protected function _deactivate_messenger($messenger_name) |
|
3368 | + { |
|
3369 | + /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */ |
|
3370 | + $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name); |
|
3371 | + $this->_message_resource_manager->deactivate_messenger($messenger_name); |
|
3372 | + |
|
3373 | + return $this->_setup_response_message_for_deactivating_messenger_with_message_types($active_messenger); |
|
3374 | + } |
|
3375 | + |
|
3376 | + |
|
3377 | + /** |
|
3378 | + * Takes care of processing activating a message type for a messenger and preparing the appropriate response. |
|
3379 | + * |
|
3380 | + * @param string $messenger_name The name of the messenger the message type is being activated for. |
|
3381 | + * @param string $message_type_name The name of the message type being activated for the messenger |
|
3382 | + * |
|
3383 | + * @return bool |
|
3384 | + */ |
|
3385 | + protected function _activate_message_type_for_messenger($messenger_name, $message_type_name) |
|
3386 | + { |
|
3387 | + /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */ |
|
3388 | + $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name); |
|
3389 | + /** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */ |
|
3390 | + $message_type_to_activate = $this->_message_resource_manager->get_message_type($message_type_name); |
|
3391 | + |
|
3392 | + //ensure is active |
|
3393 | + $this->_message_resource_manager->activate_messenger($messenger_name, $message_type_name); |
|
3394 | + |
|
3395 | + //set response for load |
|
3396 | + if ($this->_message_resource_manager->is_message_type_active_for_messenger($messenger_name, |
|
3397 | + $message_type_name) |
|
3398 | + ) { |
|
3399 | + $this->_template_args['data']['active_mts'][] = $message_type_name; |
|
3400 | + if ($message_type_to_activate->get_admin_settings_fields()) { |
|
3401 | + $this->_template_args['data']['mt_reload'][] = $message_type_name; |
|
3402 | + } |
|
3403 | + } |
|
3404 | + |
|
3405 | + return $this->_setup_response_message_for_activating_messenger_with_message_types($active_messenger, |
|
3406 | + $message_type_to_activate); |
|
3407 | + } |
|
3408 | + |
|
3409 | + |
|
3410 | + /** |
|
3411 | + * Takes care of processing deactivating a message type for a messenger and preparing the appropriate response. |
|
3412 | + * |
|
3413 | + * @param string $messenger_name The name of the messenger the message type is being deactivated for. |
|
3414 | + * @param string $message_type_name The name of the message type being deactivated for the messenger |
|
3415 | + * |
|
3416 | + * @return bool |
|
3417 | + */ |
|
3418 | + protected function _deactivate_message_type_for_messenger($messenger_name, $message_type_name) |
|
3419 | + { |
|
3420 | + /** @var EE_messenger $active_messenger This will be present because it can't be toggled if it isn't */ |
|
3421 | + $active_messenger = $this->_message_resource_manager->get_messenger($messenger_name); |
|
3422 | + /** @var EE_message_type $message_type_to_activate This will be present because it can't be toggled if it isn't */ |
|
3423 | + $message_type_to_deactivate = $this->_message_resource_manager->get_message_type($message_type_name); |
|
3424 | + $this->_message_resource_manager->deactivate_message_type_for_messenger($message_type_name, $messenger_name); |
|
3425 | + |
|
3426 | + return $this->_setup_response_message_for_deactivating_messenger_with_message_types($active_messenger, |
|
3427 | + $message_type_to_deactivate); |
|
3428 | + } |
|
3429 | + |
|
3430 | + |
|
3431 | + /** |
|
3432 | + * This just initializes the defaults for activating messenger and message type responses. |
|
3433 | + */ |
|
3434 | + protected function _prep_default_response_for_messenger_or_message_type_toggle() |
|
3435 | + { |
|
3436 | + $this->_template_args['data']['active_mts'] = array(); |
|
3437 | + $this->_template_args['data']['mt_reload'] = array(); |
|
3438 | + } |
|
3439 | + |
|
3440 | + |
|
3441 | + /** |
|
3442 | + * Setup appropriate response for activating a messenger and/or message types |
|
3443 | + * |
|
3444 | + * @param EE_messenger $messenger |
|
3445 | + * @param EE_message_type|null $message_type |
|
3446 | + * |
|
3447 | + * @return bool |
|
3448 | + * @throws EE_Error |
|
3449 | + */ |
|
3450 | + protected function _setup_response_message_for_activating_messenger_with_message_types( |
|
3451 | + $messenger, |
|
3452 | + EE_Message_Type $message_type = null |
|
3453 | + ) { |
|
3454 | + //if $messenger isn't a valid messenger object then get out. |
|
3455 | + if ( ! $messenger instanceof EE_Messenger) { |
|
3456 | + EE_Error::add_error( |
|
3457 | + __('The messenger being activated is not a valid messenger', 'event_espresso'), |
|
3458 | + __FILE__, |
|
3459 | + __FUNCTION__, |
|
3460 | + __LINE__ |
|
3461 | + ); |
|
3462 | 3462 | |
3463 | - return false; |
|
3464 | - } |
|
3465 | - //activated |
|
3466 | - if ($this->_template_args['data']['active_mts']) { |
|
3467 | - EE_Error::overwrite_success(); |
|
3468 | - //activated a message type with the messenger |
|
3469 | - if ($message_type instanceof EE_message_type) { |
|
3470 | - EE_Error::add_success( |
|
3471 | - sprintf( |
|
3472 | - __('%s message type has been successfully activated with the %s messenger', 'event_espresso'), |
|
3473 | - ucwords($message_type->label['singular']), |
|
3474 | - ucwords($messenger->label['singular']) |
|
3475 | - ) |
|
3476 | - ); |
|
3463 | + return false; |
|
3464 | + } |
|
3465 | + //activated |
|
3466 | + if ($this->_template_args['data']['active_mts']) { |
|
3467 | + EE_Error::overwrite_success(); |
|
3468 | + //activated a message type with the messenger |
|
3469 | + if ($message_type instanceof EE_message_type) { |
|
3470 | + EE_Error::add_success( |
|
3471 | + sprintf( |
|
3472 | + __('%s message type has been successfully activated with the %s messenger', 'event_espresso'), |
|
3473 | + ucwords($message_type->label['singular']), |
|
3474 | + ucwords($messenger->label['singular']) |
|
3475 | + ) |
|
3476 | + ); |
|
3477 | 3477 | |
3478 | - //if message type was invoice then let's make sure we activate the invoice payment method. |
|
3479 | - if ($message_type->name == 'invoice') { |
|
3480 | - EE_Registry::instance()->load_lib('Payment_Method_Manager'); |
|
3481 | - $pm = EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice'); |
|
3482 | - if ($pm instanceof EE_Payment_Method) { |
|
3483 | - EE_Error::add_attention(__('Activating the invoice message type also automatically activates the invoice payment method. If you do not wish the invoice payment method to be active, or to change its settings, visit the payment method admin page.', |
|
3484 | - 'event_espresso')); |
|
3485 | - } |
|
3486 | - } |
|
3487 | - //just toggles the entire messenger |
|
3488 | - } else { |
|
3489 | - EE_Error::add_success( |
|
3490 | - sprintf( |
|
3491 | - __('%s messenger has been successfully activated', 'event_espresso'), |
|
3492 | - ucwords($messenger->label['singular']) |
|
3493 | - ) |
|
3494 | - ); |
|
3495 | - } |
|
3478 | + //if message type was invoice then let's make sure we activate the invoice payment method. |
|
3479 | + if ($message_type->name == 'invoice') { |
|
3480 | + EE_Registry::instance()->load_lib('Payment_Method_Manager'); |
|
3481 | + $pm = EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice'); |
|
3482 | + if ($pm instanceof EE_Payment_Method) { |
|
3483 | + EE_Error::add_attention(__('Activating the invoice message type also automatically activates the invoice payment method. If you do not wish the invoice payment method to be active, or to change its settings, visit the payment method admin page.', |
|
3484 | + 'event_espresso')); |
|
3485 | + } |
|
3486 | + } |
|
3487 | + //just toggles the entire messenger |
|
3488 | + } else { |
|
3489 | + EE_Error::add_success( |
|
3490 | + sprintf( |
|
3491 | + __('%s messenger has been successfully activated', 'event_espresso'), |
|
3492 | + ucwords($messenger->label['singular']) |
|
3493 | + ) |
|
3494 | + ); |
|
3495 | + } |
|
3496 | 3496 | |
3497 | - return true; |
|
3497 | + return true; |
|
3498 | 3498 | |
3499 | - //possible error condition. This will happen when our active_mts data is empty because it is validated for actual active |
|
3500 | - //message types after the activation process. However its possible some messengers don't HAVE any default_message_types |
|
3501 | - //in which case we just give a success message for the messenger being successfully activated. |
|
3502 | - } else { |
|
3503 | - if ( ! $messenger->get_default_message_types()) { |
|
3504 | - //messenger doesn't have any default message types so still a success. |
|
3505 | - EE_Error::add_success( |
|
3506 | - sprintf( |
|
3507 | - __('%s messenger was successfully activated.', 'event_espresso'), |
|
3508 | - ucwords($messenger->label['singular']) |
|
3509 | - ) |
|
3510 | - ); |
|
3499 | + //possible error condition. This will happen when our active_mts data is empty because it is validated for actual active |
|
3500 | + //message types after the activation process. However its possible some messengers don't HAVE any default_message_types |
|
3501 | + //in which case we just give a success message for the messenger being successfully activated. |
|
3502 | + } else { |
|
3503 | + if ( ! $messenger->get_default_message_types()) { |
|
3504 | + //messenger doesn't have any default message types so still a success. |
|
3505 | + EE_Error::add_success( |
|
3506 | + sprintf( |
|
3507 | + __('%s messenger was successfully activated.', 'event_espresso'), |
|
3508 | + ucwords($messenger->label['singular']) |
|
3509 | + ) |
|
3510 | + ); |
|
3511 | 3511 | |
3512 | - return true; |
|
3513 | - } else { |
|
3514 | - EE_Error::add_error( |
|
3515 | - $message_type instanceof EE_message_type |
|
3516 | - ? sprintf( |
|
3517 | - __('%s message type was not successfully activated with the %s messenger', 'event_espresso'), |
|
3518 | - ucwords($message_type->label['singular']), |
|
3519 | - ucwords($messenger->label['singular']) |
|
3520 | - ) |
|
3521 | - : sprintf( |
|
3522 | - __('%s messenger was not successfully activated', 'event_espresso'), |
|
3523 | - ucwords($messenger->label['singular']) |
|
3524 | - ), |
|
3525 | - __FILE__, |
|
3526 | - __FUNCTION__, |
|
3527 | - __LINE__ |
|
3528 | - ); |
|
3512 | + return true; |
|
3513 | + } else { |
|
3514 | + EE_Error::add_error( |
|
3515 | + $message_type instanceof EE_message_type |
|
3516 | + ? sprintf( |
|
3517 | + __('%s message type was not successfully activated with the %s messenger', 'event_espresso'), |
|
3518 | + ucwords($message_type->label['singular']), |
|
3519 | + ucwords($messenger->label['singular']) |
|
3520 | + ) |
|
3521 | + : sprintf( |
|
3522 | + __('%s messenger was not successfully activated', 'event_espresso'), |
|
3523 | + ucwords($messenger->label['singular']) |
|
3524 | + ), |
|
3525 | + __FILE__, |
|
3526 | + __FUNCTION__, |
|
3527 | + __LINE__ |
|
3528 | + ); |
|
3529 | 3529 | |
3530 | - return false; |
|
3531 | - } |
|
3532 | - } |
|
3533 | - } |
|
3534 | - |
|
3535 | - |
|
3536 | - /** |
|
3537 | - * This sets up the appropriate response for deactivating a messenger and/or message type. |
|
3538 | - * |
|
3539 | - * @param EE_messenger $messenger |
|
3540 | - * @param EE_message_type|null $message_type |
|
3541 | - * |
|
3542 | - * @return bool |
|
3543 | - */ |
|
3544 | - protected function _setup_response_message_for_deactivating_messenger_with_message_types( |
|
3545 | - $messenger, |
|
3546 | - EE_message_type $message_type = null |
|
3547 | - ) { |
|
3548 | - EE_Error::overwrite_success(); |
|
3549 | - |
|
3550 | - //if $messenger isn't a valid messenger object then get out. |
|
3551 | - if ( ! $messenger instanceof EE_Messenger) { |
|
3552 | - EE_Error::add_error( |
|
3553 | - __('The messenger being deactivated is not a valid messenger', 'event_espresso'), |
|
3554 | - __FILE__, |
|
3555 | - __FUNCTION__, |
|
3556 | - __LINE__ |
|
3557 | - ); |
|
3530 | + return false; |
|
3531 | + } |
|
3532 | + } |
|
3533 | + } |
|
3534 | + |
|
3535 | + |
|
3536 | + /** |
|
3537 | + * This sets up the appropriate response for deactivating a messenger and/or message type. |
|
3538 | + * |
|
3539 | + * @param EE_messenger $messenger |
|
3540 | + * @param EE_message_type|null $message_type |
|
3541 | + * |
|
3542 | + * @return bool |
|
3543 | + */ |
|
3544 | + protected function _setup_response_message_for_deactivating_messenger_with_message_types( |
|
3545 | + $messenger, |
|
3546 | + EE_message_type $message_type = null |
|
3547 | + ) { |
|
3548 | + EE_Error::overwrite_success(); |
|
3549 | + |
|
3550 | + //if $messenger isn't a valid messenger object then get out. |
|
3551 | + if ( ! $messenger instanceof EE_Messenger) { |
|
3552 | + EE_Error::add_error( |
|
3553 | + __('The messenger being deactivated is not a valid messenger', 'event_espresso'), |
|
3554 | + __FILE__, |
|
3555 | + __FUNCTION__, |
|
3556 | + __LINE__ |
|
3557 | + ); |
|
3558 | 3558 | |
3559 | - return false; |
|
3560 | - } |
|
3561 | - |
|
3562 | - if ($message_type instanceof EE_message_type) { |
|
3563 | - $message_type_name = $message_type->name; |
|
3564 | - EE_Error::add_success( |
|
3565 | - sprintf( |
|
3566 | - __('%s message type has been successfully deactivated for the %s messenger.', 'event_espresso'), |
|
3567 | - ucwords($message_type->label['singular']), |
|
3568 | - ucwords($messenger->label['singular']) |
|
3569 | - ) |
|
3570 | - ); |
|
3571 | - } else { |
|
3572 | - $message_type_name = ''; |
|
3573 | - EE_Error::add_success( |
|
3574 | - sprintf( |
|
3575 | - __('%s messenger has been successfully deactivated.', 'event_espresso'), |
|
3576 | - ucwords($messenger->label['singular']) |
|
3577 | - ) |
|
3578 | - ); |
|
3579 | - } |
|
3580 | - |
|
3581 | - //if messenger was html or message type was invoice then let's make sure we deactivate invoice payment method. |
|
3582 | - if ($messenger->name == 'html' || $message_type_name == 'invoice') { |
|
3583 | - EE_Registry::instance()->load_lib('Payment_Method_Manager'); |
|
3584 | - $count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method('invoice'); |
|
3585 | - if ($count_updated > 0) { |
|
3586 | - $msg = $message_type_name == 'invoice' |
|
3587 | - ? __('Deactivating the invoice message type also automatically deactivates the invoice payment method. In order for invoices to be generated the invoice message type must be active. If you completed this action by mistake, simply reactivate the invoice message type and then visit the payment methods admin page to reactivate the invoice payment method.', |
|
3588 | - 'event_espresso') |
|
3589 | - : __('Deactivating the html messenger also automatically deactivates the invoice payment method. In order for invoices to be generated the html messenger must be be active. If you completed this action by mistake, simply reactivate the html messenger, then visit the payment methods admin page to reactivate the invoice payment method.', |
|
3590 | - 'event_espresso'); |
|
3591 | - EE_Error::add_attention($msg); |
|
3592 | - } |
|
3593 | - } |
|
3594 | - |
|
3595 | - return true; |
|
3596 | - } |
|
3597 | - |
|
3598 | - |
|
3599 | - /** |
|
3600 | - * handles updating a message type form on messenger activation IF the message type has settings fields. (via ajax) |
|
3601 | - */ |
|
3602 | - public function update_mt_form() |
|
3603 | - { |
|
3604 | - if ( ! isset($this->_req_data['messenger']) || ! isset($this->_req_data['message_type'])) { |
|
3605 | - EE_Error::add_error(__('Require message type or messenger to send an updated form'), __FILE__, __FUNCTION__, |
|
3606 | - __LINE__); |
|
3607 | - $this->_return_json(); |
|
3608 | - } |
|
3609 | - |
|
3610 | - $message_types = $this->get_installed_message_types(); |
|
3611 | - |
|
3612 | - $message_type = $message_types[$this->_req_data['message_type']]; |
|
3613 | - $messenger = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']); |
|
3614 | - |
|
3615 | - $content = $this->_message_type_settings_content($message_type, $messenger, true); |
|
3616 | - $this->_template_args['success'] = true; |
|
3617 | - $this->_template_args['content'] = $content; |
|
3618 | - $this->_return_json(); |
|
3619 | - } |
|
3620 | - |
|
3621 | - |
|
3622 | - /** |
|
3623 | - * this handles saving the settings for a messenger or message type |
|
3624 | - * |
|
3625 | - */ |
|
3626 | - public function save_settings() |
|
3627 | - { |
|
3628 | - if ( ! isset($this->_req_data['type'])) { |
|
3629 | - EE_Error::add_error(__('Cannot save settings because type is unknown (messenger settings or messsage type settings?)', |
|
3630 | - 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
3631 | - $this->_template_args['error'] = true; |
|
3632 | - $this->_return_json(); |
|
3633 | - } |
|
3634 | - |
|
3635 | - |
|
3636 | - if ($this->_req_data['type'] == 'messenger') { |
|
3637 | - $settings = $this->_req_data['messenger_settings']; //this should be an array. |
|
3638 | - $messenger = $settings['messenger']; |
|
3639 | - //let's setup the settings data |
|
3640 | - foreach ($settings as $key => $value) { |
|
3641 | - switch ($key) { |
|
3642 | - case 'messenger' : |
|
3643 | - unset($settings['messenger']); |
|
3644 | - break; |
|
3645 | - case 'message_types' : |
|
3646 | - unset($settings['message_types']); |
|
3647 | - break; |
|
3648 | - default : |
|
3649 | - $settings[$key] = $value; |
|
3650 | - break; |
|
3651 | - } |
|
3652 | - } |
|
3653 | - $this->_message_resource_manager->add_settings_for_messenger($messenger, $settings); |
|
3654 | - } else if ($this->_req_data['type'] == 'message_type') { |
|
3655 | - $settings = $this->_req_data['message_type_settings']; |
|
3656 | - $messenger = $settings['messenger']; |
|
3657 | - $message_type = $settings['message_type']; |
|
3559 | + return false; |
|
3560 | + } |
|
3561 | + |
|
3562 | + if ($message_type instanceof EE_message_type) { |
|
3563 | + $message_type_name = $message_type->name; |
|
3564 | + EE_Error::add_success( |
|
3565 | + sprintf( |
|
3566 | + __('%s message type has been successfully deactivated for the %s messenger.', 'event_espresso'), |
|
3567 | + ucwords($message_type->label['singular']), |
|
3568 | + ucwords($messenger->label['singular']) |
|
3569 | + ) |
|
3570 | + ); |
|
3571 | + } else { |
|
3572 | + $message_type_name = ''; |
|
3573 | + EE_Error::add_success( |
|
3574 | + sprintf( |
|
3575 | + __('%s messenger has been successfully deactivated.', 'event_espresso'), |
|
3576 | + ucwords($messenger->label['singular']) |
|
3577 | + ) |
|
3578 | + ); |
|
3579 | + } |
|
3580 | + |
|
3581 | + //if messenger was html or message type was invoice then let's make sure we deactivate invoice payment method. |
|
3582 | + if ($messenger->name == 'html' || $message_type_name == 'invoice') { |
|
3583 | + EE_Registry::instance()->load_lib('Payment_Method_Manager'); |
|
3584 | + $count_updated = EE_Payment_Method_Manager::instance()->deactivate_payment_method('invoice'); |
|
3585 | + if ($count_updated > 0) { |
|
3586 | + $msg = $message_type_name == 'invoice' |
|
3587 | + ? __('Deactivating the invoice message type also automatically deactivates the invoice payment method. In order for invoices to be generated the invoice message type must be active. If you completed this action by mistake, simply reactivate the invoice message type and then visit the payment methods admin page to reactivate the invoice payment method.', |
|
3588 | + 'event_espresso') |
|
3589 | + : __('Deactivating the html messenger also automatically deactivates the invoice payment method. In order for invoices to be generated the html messenger must be be active. If you completed this action by mistake, simply reactivate the html messenger, then visit the payment methods admin page to reactivate the invoice payment method.', |
|
3590 | + 'event_espresso'); |
|
3591 | + EE_Error::add_attention($msg); |
|
3592 | + } |
|
3593 | + } |
|
3594 | + |
|
3595 | + return true; |
|
3596 | + } |
|
3597 | + |
|
3598 | + |
|
3599 | + /** |
|
3600 | + * handles updating a message type form on messenger activation IF the message type has settings fields. (via ajax) |
|
3601 | + */ |
|
3602 | + public function update_mt_form() |
|
3603 | + { |
|
3604 | + if ( ! isset($this->_req_data['messenger']) || ! isset($this->_req_data['message_type'])) { |
|
3605 | + EE_Error::add_error(__('Require message type or messenger to send an updated form'), __FILE__, __FUNCTION__, |
|
3606 | + __LINE__); |
|
3607 | + $this->_return_json(); |
|
3608 | + } |
|
3609 | + |
|
3610 | + $message_types = $this->get_installed_message_types(); |
|
3611 | + |
|
3612 | + $message_type = $message_types[$this->_req_data['message_type']]; |
|
3613 | + $messenger = $this->_message_resource_manager->get_active_messenger($this->_req_data['messenger']); |
|
3614 | + |
|
3615 | + $content = $this->_message_type_settings_content($message_type, $messenger, true); |
|
3616 | + $this->_template_args['success'] = true; |
|
3617 | + $this->_template_args['content'] = $content; |
|
3618 | + $this->_return_json(); |
|
3619 | + } |
|
3620 | + |
|
3621 | + |
|
3622 | + /** |
|
3623 | + * this handles saving the settings for a messenger or message type |
|
3624 | + * |
|
3625 | + */ |
|
3626 | + public function save_settings() |
|
3627 | + { |
|
3628 | + if ( ! isset($this->_req_data['type'])) { |
|
3629 | + EE_Error::add_error(__('Cannot save settings because type is unknown (messenger settings or messsage type settings?)', |
|
3630 | + 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
3631 | + $this->_template_args['error'] = true; |
|
3632 | + $this->_return_json(); |
|
3633 | + } |
|
3634 | + |
|
3635 | + |
|
3636 | + if ($this->_req_data['type'] == 'messenger') { |
|
3637 | + $settings = $this->_req_data['messenger_settings']; //this should be an array. |
|
3638 | + $messenger = $settings['messenger']; |
|
3639 | + //let's setup the settings data |
|
3640 | + foreach ($settings as $key => $value) { |
|
3641 | + switch ($key) { |
|
3642 | + case 'messenger' : |
|
3643 | + unset($settings['messenger']); |
|
3644 | + break; |
|
3645 | + case 'message_types' : |
|
3646 | + unset($settings['message_types']); |
|
3647 | + break; |
|
3648 | + default : |
|
3649 | + $settings[$key] = $value; |
|
3650 | + break; |
|
3651 | + } |
|
3652 | + } |
|
3653 | + $this->_message_resource_manager->add_settings_for_messenger($messenger, $settings); |
|
3654 | + } else if ($this->_req_data['type'] == 'message_type') { |
|
3655 | + $settings = $this->_req_data['message_type_settings']; |
|
3656 | + $messenger = $settings['messenger']; |
|
3657 | + $message_type = $settings['message_type']; |
|
3658 | 3658 | |
3659 | - foreach ($settings as $key => $value) { |
|
3660 | - switch ($key) { |
|
3661 | - case 'messenger' : |
|
3662 | - unset($settings['messenger']); |
|
3663 | - break; |
|
3664 | - case 'message_type' : |
|
3665 | - unset($settings['message_type']); |
|
3666 | - break; |
|
3667 | - default : |
|
3668 | - $settings[$key] = $value; |
|
3669 | - break; |
|
3670 | - } |
|
3671 | - } |
|
3659 | + foreach ($settings as $key => $value) { |
|
3660 | + switch ($key) { |
|
3661 | + case 'messenger' : |
|
3662 | + unset($settings['messenger']); |
|
3663 | + break; |
|
3664 | + case 'message_type' : |
|
3665 | + unset($settings['message_type']); |
|
3666 | + break; |
|
3667 | + default : |
|
3668 | + $settings[$key] = $value; |
|
3669 | + break; |
|
3670 | + } |
|
3671 | + } |
|
3672 | 3672 | |
3673 | - $this->_message_resource_manager->add_settings_for_message_type($messenger, $message_type, $settings); |
|
3674 | - } |
|
3675 | - |
|
3676 | - //okay we should have the data all setup. Now we just update! |
|
3677 | - $success = $this->_message_resource_manager->update_active_messengers_option(); |
|
3678 | - |
|
3679 | - if ($success) { |
|
3680 | - EE_Error::add_success(__('Settings updated', 'event_espresso')); |
|
3681 | - } else { |
|
3682 | - EE_Error::add_error(__('Settings did not get updated', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
3683 | - } |
|
3684 | - |
|
3685 | - $this->_template_args['success'] = $success; |
|
3686 | - $this->_return_json(); |
|
3687 | - } |
|
3688 | - |
|
3689 | - |
|
3690 | - |
|
3691 | - |
|
3692 | - /** EE MESSAGE PROCESSING ACTIONS **/ |
|
3693 | - |
|
3694 | - |
|
3695 | - /** |
|
3696 | - * This immediately generates any EE_Message ID's that are selected that are EEM_Message::status_incomplete |
|
3697 | - * However, this does not send immediately, it just queues for sending. |
|
3698 | - * |
|
3699 | - * @since 4.9.0 |
|
3700 | - */ |
|
3701 | - protected function _generate_now() |
|
3702 | - { |
|
3703 | - $msg_ids = $this->_get_msg_ids_from_request(); |
|
3704 | - EED_Messages::generate_now($msg_ids); |
|
3705 | - $this->_redirect_after_action(false, '', '', array(), true); |
|
3706 | - } |
|
3707 | - |
|
3708 | - |
|
3709 | - /** |
|
3710 | - * This immediately generates AND sends any EE_Message's selected that are EEM_Message::status_incomplete or that |
|
3711 | - * are EEM_Message::status_resend or EEM_Message::status_idle |
|
3712 | - * |
|
3713 | - * @since 4.9.0 |
|
3714 | - * |
|
3715 | - */ |
|
3716 | - protected function _generate_and_send_now() |
|
3717 | - { |
|
3718 | - $this->_generate_now(); |
|
3719 | - $this->_send_now(); |
|
3720 | - $this->_redirect_after_action(false, '', '', array(), true); |
|
3721 | - } |
|
3722 | - |
|
3723 | - |
|
3724 | - /** |
|
3725 | - * This queues any EEM_Message::status_sent EE_Message ids in the request for resending. |
|
3726 | - * |
|
3727 | - * @since 4.9.0 |
|
3728 | - */ |
|
3729 | - protected function _queue_for_resending() |
|
3730 | - { |
|
3731 | - $msg_ids = $this->_get_msg_ids_from_request(); |
|
3732 | - EED_Messages::queue_for_resending($msg_ids); |
|
3733 | - $this->_redirect_after_action(false, '', '', array(), true); |
|
3734 | - } |
|
3735 | - |
|
3736 | - |
|
3737 | - /** |
|
3738 | - * This sends immediately any EEM_Message::status_idle or EEM_Message::status_resend messages in the queue |
|
3739 | - * |
|
3740 | - * @since 4.9.0 |
|
3741 | - */ |
|
3742 | - protected function _send_now() |
|
3743 | - { |
|
3744 | - $msg_ids = $this->_get_msg_ids_from_request(); |
|
3745 | - EED_Messages::send_now($msg_ids); |
|
3746 | - $this->_redirect_after_action(false, '', '', array(), true); |
|
3747 | - } |
|
3748 | - |
|
3749 | - |
|
3750 | - /** |
|
3751 | - * Deletes EE_messages for IDs in the request. |
|
3752 | - * |
|
3753 | - * @since 4.9.0 |
|
3754 | - */ |
|
3755 | - protected function _delete_ee_messages() |
|
3756 | - { |
|
3757 | - $msg_ids = $this->_get_msg_ids_from_request(); |
|
3758 | - $deleted_count = 0; |
|
3759 | - foreach ($msg_ids as $msg_id) { |
|
3760 | - if (EEM_Message::instance()->delete_by_ID($msg_id)) { |
|
3761 | - $deleted_count++; |
|
3762 | - } |
|
3763 | - } |
|
3764 | - if ($deleted_count) { |
|
3765 | - $this->_redirect_after_action( |
|
3766 | - true, |
|
3767 | - _n('message', 'messages', $deleted_count, 'event_espresso'), |
|
3768 | - __('deleted', 'event_espresso') |
|
3769 | - ); |
|
3770 | - } else { |
|
3771 | - EE_Error::add_error( |
|
3772 | - _n('The message was not deleted.', 'The messages were not deleted', count($msg_ids), 'event_espresso'), |
|
3773 | - __FILE__, __FUNCTION__, __LINE__ |
|
3774 | - ); |
|
3775 | - $this->_redirect_after_action(false, '', '', array(), true); |
|
3776 | - } |
|
3777 | - } |
|
3778 | - |
|
3779 | - |
|
3780 | - /** |
|
3781 | - * This looks for 'MSG_ID' key in the request and returns an array of MSG_ID's if present. |
|
3782 | - * @since 4.9.0 |
|
3783 | - * @return array |
|
3784 | - */ |
|
3785 | - protected function _get_msg_ids_from_request() |
|
3786 | - { |
|
3787 | - if ( ! isset($this->_req_data['MSG_ID'])) { |
|
3788 | - return array(); |
|
3789 | - } |
|
3790 | - |
|
3791 | - return is_array($this->_req_data['MSG_ID']) ? array_keys($this->_req_data['MSG_ID']) : array($this->_req_data['MSG_ID']); |
|
3792 | - } |
|
3673 | + $this->_message_resource_manager->add_settings_for_message_type($messenger, $message_type, $settings); |
|
3674 | + } |
|
3675 | + |
|
3676 | + //okay we should have the data all setup. Now we just update! |
|
3677 | + $success = $this->_message_resource_manager->update_active_messengers_option(); |
|
3678 | + |
|
3679 | + if ($success) { |
|
3680 | + EE_Error::add_success(__('Settings updated', 'event_espresso')); |
|
3681 | + } else { |
|
3682 | + EE_Error::add_error(__('Settings did not get updated', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
3683 | + } |
|
3684 | + |
|
3685 | + $this->_template_args['success'] = $success; |
|
3686 | + $this->_return_json(); |
|
3687 | + } |
|
3688 | + |
|
3689 | + |
|
3690 | + |
|
3691 | + |
|
3692 | + /** EE MESSAGE PROCESSING ACTIONS **/ |
|
3693 | + |
|
3694 | + |
|
3695 | + /** |
|
3696 | + * This immediately generates any EE_Message ID's that are selected that are EEM_Message::status_incomplete |
|
3697 | + * However, this does not send immediately, it just queues for sending. |
|
3698 | + * |
|
3699 | + * @since 4.9.0 |
|
3700 | + */ |
|
3701 | + protected function _generate_now() |
|
3702 | + { |
|
3703 | + $msg_ids = $this->_get_msg_ids_from_request(); |
|
3704 | + EED_Messages::generate_now($msg_ids); |
|
3705 | + $this->_redirect_after_action(false, '', '', array(), true); |
|
3706 | + } |
|
3707 | + |
|
3708 | + |
|
3709 | + /** |
|
3710 | + * This immediately generates AND sends any EE_Message's selected that are EEM_Message::status_incomplete or that |
|
3711 | + * are EEM_Message::status_resend or EEM_Message::status_idle |
|
3712 | + * |
|
3713 | + * @since 4.9.0 |
|
3714 | + * |
|
3715 | + */ |
|
3716 | + protected function _generate_and_send_now() |
|
3717 | + { |
|
3718 | + $this->_generate_now(); |
|
3719 | + $this->_send_now(); |
|
3720 | + $this->_redirect_after_action(false, '', '', array(), true); |
|
3721 | + } |
|
3722 | + |
|
3723 | + |
|
3724 | + /** |
|
3725 | + * This queues any EEM_Message::status_sent EE_Message ids in the request for resending. |
|
3726 | + * |
|
3727 | + * @since 4.9.0 |
|
3728 | + */ |
|
3729 | + protected function _queue_for_resending() |
|
3730 | + { |
|
3731 | + $msg_ids = $this->_get_msg_ids_from_request(); |
|
3732 | + EED_Messages::queue_for_resending($msg_ids); |
|
3733 | + $this->_redirect_after_action(false, '', '', array(), true); |
|
3734 | + } |
|
3735 | + |
|
3736 | + |
|
3737 | + /** |
|
3738 | + * This sends immediately any EEM_Message::status_idle or EEM_Message::status_resend messages in the queue |
|
3739 | + * |
|
3740 | + * @since 4.9.0 |
|
3741 | + */ |
|
3742 | + protected function _send_now() |
|
3743 | + { |
|
3744 | + $msg_ids = $this->_get_msg_ids_from_request(); |
|
3745 | + EED_Messages::send_now($msg_ids); |
|
3746 | + $this->_redirect_after_action(false, '', '', array(), true); |
|
3747 | + } |
|
3748 | + |
|
3749 | + |
|
3750 | + /** |
|
3751 | + * Deletes EE_messages for IDs in the request. |
|
3752 | + * |
|
3753 | + * @since 4.9.0 |
|
3754 | + */ |
|
3755 | + protected function _delete_ee_messages() |
|
3756 | + { |
|
3757 | + $msg_ids = $this->_get_msg_ids_from_request(); |
|
3758 | + $deleted_count = 0; |
|
3759 | + foreach ($msg_ids as $msg_id) { |
|
3760 | + if (EEM_Message::instance()->delete_by_ID($msg_id)) { |
|
3761 | + $deleted_count++; |
|
3762 | + } |
|
3763 | + } |
|
3764 | + if ($deleted_count) { |
|
3765 | + $this->_redirect_after_action( |
|
3766 | + true, |
|
3767 | + _n('message', 'messages', $deleted_count, 'event_espresso'), |
|
3768 | + __('deleted', 'event_espresso') |
|
3769 | + ); |
|
3770 | + } else { |
|
3771 | + EE_Error::add_error( |
|
3772 | + _n('The message was not deleted.', 'The messages were not deleted', count($msg_ids), 'event_espresso'), |
|
3773 | + __FILE__, __FUNCTION__, __LINE__ |
|
3774 | + ); |
|
3775 | + $this->_redirect_after_action(false, '', '', array(), true); |
|
3776 | + } |
|
3777 | + } |
|
3778 | + |
|
3779 | + |
|
3780 | + /** |
|
3781 | + * This looks for 'MSG_ID' key in the request and returns an array of MSG_ID's if present. |
|
3782 | + * @since 4.9.0 |
|
3783 | + * @return array |
|
3784 | + */ |
|
3785 | + protected function _get_msg_ids_from_request() |
|
3786 | + { |
|
3787 | + if ( ! isset($this->_req_data['MSG_ID'])) { |
|
3788 | + return array(); |
|
3789 | + } |
|
3790 | + |
|
3791 | + return is_array($this->_req_data['MSG_ID']) ? array_keys($this->_req_data['MSG_ID']) : array($this->_req_data['MSG_ID']); |
|
3792 | + } |
|
3793 | 3793 | |
3794 | 3794 | |
3795 | 3795 | } |