@@ -23,14 +23,14 @@ |
||
| 23 | 23 | class CartFactory |
| 24 | 24 | { |
| 25 | 25 | |
| 26 | - /** |
|
| 27 | - * @return EE_Cart |
|
| 28 | - * @throws InvalidArgumentException |
|
| 29 | - * @throws InvalidInterfaceException |
|
| 30 | - * @throws InvalidDataTypeException |
|
| 31 | - */ |
|
| 32 | - public static function getCart() |
|
| 33 | - { |
|
| 34 | - return LoaderFactory::getLoader()->getShared('EE_Cart'); |
|
| 35 | - } |
|
| 26 | + /** |
|
| 27 | + * @return EE_Cart |
|
| 28 | + * @throws InvalidArgumentException |
|
| 29 | + * @throws InvalidInterfaceException |
|
| 30 | + * @throws InvalidDataTypeException |
|
| 31 | + */ |
|
| 32 | + public static function getCart() |
|
| 33 | + { |
|
| 34 | + return LoaderFactory::getLoader()->getShared('EE_Cart'); |
|
| 35 | + } |
|
| 36 | 36 | } |
@@ -533,7 +533,7 @@ discard block |
||
| 533 | 533 | * @param string $name |
| 534 | 534 | * @param string $config_class |
| 535 | 535 | * @param EE_Config_Base $config_obj |
| 536 | - * @param array $tests_to_run |
|
| 536 | + * @param integer[] $tests_to_run |
|
| 537 | 537 | * @param bool $display_errors |
| 538 | 538 | * @return bool TRUE on success, FALSE on fail |
| 539 | 539 | */ |
@@ -797,7 +797,7 @@ discard block |
||
| 797 | 797 | * @access public |
| 798 | 798 | * @param string $section |
| 799 | 799 | * @param string $name |
| 800 | - * @param EE_Config_Base|string $config_obj |
|
| 800 | + * @param EE_Config_Base $config_obj |
|
| 801 | 801 | * @param bool $throw_errors |
| 802 | 802 | * @return bool |
| 803 | 803 | */ |
@@ -1764,7 +1764,7 @@ discard block |
||
| 1764 | 1764 | |
| 1765 | 1765 | |
| 1766 | 1766 | /** |
| 1767 | - * @return array |
|
| 1767 | + * @return integer[] |
|
| 1768 | 1768 | */ |
| 1769 | 1769 | public function get_critical_pages_array() |
| 1770 | 1770 | { |
@@ -1779,7 +1779,7 @@ discard block |
||
| 1779 | 1779 | |
| 1780 | 1780 | |
| 1781 | 1781 | /** |
| 1782 | - * @return array |
|
| 1782 | + * @return string[] |
|
| 1783 | 1783 | */ |
| 1784 | 1784 | public function get_critical_pages_shortcodes_array() |
| 1785 | 1785 | { |
@@ -3122,7 +3122,7 @@ discard block |
||
| 3122 | 3122 | * according to max_input_vars |
| 3123 | 3123 | * |
| 3124 | 3124 | * @param int $input_count the count of input vars. |
| 3125 | - * @return array { |
|
| 3125 | + * @return string { |
|
| 3126 | 3126 | * An array that represents whether available space and if no available space the error |
| 3127 | 3127 | * message. |
| 3128 | 3128 | * @type bool $has_space whether more inputs can be added. |
@@ -145,7 +145,7 @@ discard block |
||
| 145 | 145 | public static function instance() |
| 146 | 146 | { |
| 147 | 147 | // check if class object is instantiated, and instantiated properly |
| 148 | - if (! self::$_instance instanceof EE_Config) { |
|
| 148 | + if ( ! self::$_instance instanceof EE_Config) { |
|
| 149 | 149 | self::$_instance = new self(); |
| 150 | 150 | } |
| 151 | 151 | return self::$_instance; |
@@ -283,7 +283,7 @@ discard block |
||
| 283 | 283 | $this |
| 284 | 284 | ); |
| 285 | 285 | if (is_object($settings) && property_exists($this, $config)) { |
| 286 | - $this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__' . $config, $settings); |
|
| 286 | + $this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__'.$config, $settings); |
|
| 287 | 287 | // call configs populate method to ensure any defaults are set for empty values. |
| 288 | 288 | if (method_exists($settings, 'populate')) { |
| 289 | 289 | $this->{$config}->populate(); |
@@ -556,7 +556,7 @@ discard block |
||
| 556 | 556 | break; |
| 557 | 557 | // TEST #2 : check that settings section exists |
| 558 | 558 | case 2: |
| 559 | - if (! isset($this->{$section})) { |
|
| 559 | + if ( ! isset($this->{$section})) { |
|
| 560 | 560 | if ($display_errors) { |
| 561 | 561 | throw new EE_Error( |
| 562 | 562 | sprintf( |
@@ -570,7 +570,7 @@ discard block |
||
| 570 | 570 | break; |
| 571 | 571 | // TEST #3 : check that section is the proper format |
| 572 | 572 | case 3: |
| 573 | - if (! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass) |
|
| 573 | + if ( ! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass) |
|
| 574 | 574 | ) { |
| 575 | 575 | if ($display_errors) { |
| 576 | 576 | throw new EE_Error( |
@@ -616,7 +616,7 @@ discard block |
||
| 616 | 616 | break; |
| 617 | 617 | // TEST #6 : verify config class is accessible |
| 618 | 618 | case 6: |
| 619 | - if (! class_exists($config_class)) { |
|
| 619 | + if ( ! class_exists($config_class)) { |
|
| 620 | 620 | if ($display_errors) { |
| 621 | 621 | throw new EE_Error( |
| 622 | 622 | sprintf( |
@@ -633,7 +633,7 @@ discard block |
||
| 633 | 633 | break; |
| 634 | 634 | // TEST #7 : check that config has even been set |
| 635 | 635 | case 7: |
| 636 | - if (! isset($this->{$section}->{$name})) { |
|
| 636 | + if ( ! isset($this->{$section}->{$name})) { |
|
| 637 | 637 | if ($display_errors) { |
| 638 | 638 | throw new EE_Error( |
| 639 | 639 | sprintf( |
@@ -651,7 +651,7 @@ discard block |
||
| 651 | 651 | break; |
| 652 | 652 | // TEST #8 : check that config is the requested type |
| 653 | 653 | case 8: |
| 654 | - if (! $this->{$section}->{$name} instanceof $config_class) { |
|
| 654 | + if ( ! $this->{$section}->{$name} instanceof $config_class) { |
|
| 655 | 655 | if ($display_errors) { |
| 656 | 656 | throw new EE_Error( |
| 657 | 657 | sprintf( |
@@ -670,7 +670,7 @@ discard block |
||
| 670 | 670 | break; |
| 671 | 671 | // TEST #9 : verify config object |
| 672 | 672 | case 9: |
| 673 | - if (! $config_obj instanceof EE_Config_Base) { |
|
| 673 | + if ( ! $config_obj instanceof EE_Config_Base) { |
|
| 674 | 674 | if ($display_errors) { |
| 675 | 675 | throw new EE_Error( |
| 676 | 676 | sprintf( |
@@ -702,7 +702,7 @@ discard block |
||
| 702 | 702 | */ |
| 703 | 703 | private function _generate_config_option_name($section = '', $name = '') |
| 704 | 704 | { |
| 705 | - return 'ee_config-' . strtolower($section . '-' . str_replace(array('EE_', 'EED_'), '', $name)); |
|
| 705 | + return 'ee_config-'.strtolower($section.'-'.str_replace(array('EE_', 'EED_'), '', $name)); |
|
| 706 | 706 | } |
| 707 | 707 | |
| 708 | 708 | |
@@ -719,7 +719,7 @@ discard block |
||
| 719 | 719 | { |
| 720 | 720 | return ! empty($config_class) |
| 721 | 721 | ? $config_class |
| 722 | - : str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))) . '_Config'; |
|
| 722 | + : str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))).'_Config'; |
|
| 723 | 723 | } |
| 724 | 724 | |
| 725 | 725 | |
@@ -738,17 +738,17 @@ discard block |
||
| 738 | 738 | // ensure config class is set to something |
| 739 | 739 | $config_class = $this->_set_config_class($config_class, $name); |
| 740 | 740 | // run tests 1-4, 6, and 7 to verify all config params are set and valid |
| 741 | - if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) { |
|
| 741 | + if ( ! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) { |
|
| 742 | 742 | return null; |
| 743 | 743 | } |
| 744 | 744 | $config_option_name = $this->_generate_config_option_name($section, $name); |
| 745 | 745 | // if the config option name hasn't been added yet to the list of option names we're tracking, then do so now |
| 746 | - if (! isset($this->_addon_option_names[ $config_option_name ])) { |
|
| 747 | - $this->_addon_option_names[ $config_option_name ] = $config_class; |
|
| 746 | + if ( ! isset($this->_addon_option_names[$config_option_name])) { |
|
| 747 | + $this->_addon_option_names[$config_option_name] = $config_class; |
|
| 748 | 748 | $this->update_addon_option_names(); |
| 749 | 749 | } |
| 750 | 750 | // verify the incoming config object but suppress errors |
| 751 | - if (! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) { |
|
| 751 | + if ( ! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) { |
|
| 752 | 752 | $config_obj = new $config_class(); |
| 753 | 753 | } |
| 754 | 754 | if (get_option($config_option_name)) { |
@@ -795,7 +795,7 @@ discard block |
||
| 795 | 795 | // get class name of the incoming object |
| 796 | 796 | $config_class = get_class($config_obj); |
| 797 | 797 | // run tests 1-5 and 9 to verify config |
| 798 | - if (! $this->_verify_config_params( |
|
| 798 | + if ( ! $this->_verify_config_params( |
|
| 799 | 799 | $section, |
| 800 | 800 | $name, |
| 801 | 801 | $config_class, |
@@ -807,7 +807,7 @@ discard block |
||
| 807 | 807 | } |
| 808 | 808 | $config_option_name = $this->_generate_config_option_name($section, $name); |
| 809 | 809 | // check if config object has been added to db by seeing if config option name is in $this->_addon_option_names array |
| 810 | - if (! isset($this->_addon_option_names[ $config_option_name ])) { |
|
| 810 | + if ( ! isset($this->_addon_option_names[$config_option_name])) { |
|
| 811 | 811 | // save new config to db |
| 812 | 812 | if ($this->set_config($section, $name, $config_class, $config_obj)) { |
| 813 | 813 | return true; |
@@ -833,7 +833,7 @@ discard block |
||
| 833 | 833 | 'event_espresso' |
| 834 | 834 | ), |
| 835 | 835 | $config_class, |
| 836 | - 'EE_Config->' . $section . '->' . $name |
|
| 836 | + 'EE_Config->'.$section.'->'.$name |
|
| 837 | 837 | ), |
| 838 | 838 | __FILE__, |
| 839 | 839 | __FUNCTION__, |
@@ -859,7 +859,7 @@ discard block |
||
| 859 | 859 | // ensure config class is set to something |
| 860 | 860 | $config_class = $this->_set_config_class($config_class, $name); |
| 861 | 861 | // run tests 1-4, 6 and 7 to verify that all params have been set |
| 862 | - if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) { |
|
| 862 | + if ( ! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) { |
|
| 863 | 863 | return null; |
| 864 | 864 | } |
| 865 | 865 | // now test if the requested config object exists, but suppress errors |
@@ -904,7 +904,7 @@ discard block |
||
| 904 | 904 | // retrieve the wp-option for this config class. |
| 905 | 905 | $config_option = maybe_unserialize(get_option($config_option_name, array())); |
| 906 | 906 | if (empty($config_option)) { |
| 907 | - EE_Config::log($config_option_name . '-NOT-FOUND'); |
|
| 907 | + EE_Config::log($config_option_name.'-NOT-FOUND'); |
|
| 908 | 908 | } |
| 909 | 909 | return $config_option; |
| 910 | 910 | } |
@@ -922,7 +922,7 @@ discard block |
||
| 922 | 922 | // copy incoming $_REQUEST and sanitize it so we can save it |
| 923 | 923 | $_request = $_REQUEST; |
| 924 | 924 | array_walk_recursive($_request, 'sanitize_text_field'); |
| 925 | - $config_log[ (string) microtime(true) ] = array( |
|
| 925 | + $config_log[(string) microtime(true)] = array( |
|
| 926 | 926 | 'config_name' => $config_option_name, |
| 927 | 927 | 'request' => $_request, |
| 928 | 928 | ); |
@@ -937,7 +937,7 @@ discard block |
||
| 937 | 937 | */ |
| 938 | 938 | public static function trim_log() |
| 939 | 939 | { |
| 940 | - if (! EE_Config::logging_enabled()) { |
|
| 940 | + if ( ! EE_Config::logging_enabled()) { |
|
| 941 | 941 | return; |
| 942 | 942 | } |
| 943 | 943 | $config_log = maybe_unserialize(get_option(EE_Config::LOG_NAME, array())); |
@@ -961,7 +961,7 @@ discard block |
||
| 961 | 961 | public static function get_page_for_posts() |
| 962 | 962 | { |
| 963 | 963 | $page_for_posts = get_option('page_for_posts'); |
| 964 | - if (! $page_for_posts) { |
|
| 964 | + if ( ! $page_for_posts) { |
|
| 965 | 965 | return 'posts'; |
| 966 | 966 | } |
| 967 | 967 | /** @type WPDB $wpdb */ |
@@ -1011,20 +1011,20 @@ discard block |
||
| 1011 | 1011 | { |
| 1012 | 1012 | // only init widgets on admin pages when not in complete maintenance, and |
| 1013 | 1013 | // on frontend when not in any maintenance mode |
| 1014 | - if (! EE_Maintenance_Mode::instance()->level() |
|
| 1014 | + if ( ! EE_Maintenance_Mode::instance()->level() |
|
| 1015 | 1015 | || ( |
| 1016 | 1016 | is_admin() |
| 1017 | 1017 | && EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance |
| 1018 | 1018 | ) |
| 1019 | 1019 | ) { |
| 1020 | 1020 | // grab list of installed widgets |
| 1021 | - $widgets_to_register = glob(EE_WIDGETS . '*', GLOB_ONLYDIR); |
|
| 1021 | + $widgets_to_register = glob(EE_WIDGETS.'*', GLOB_ONLYDIR); |
|
| 1022 | 1022 | // filter list of modules to register |
| 1023 | 1023 | $widgets_to_register = apply_filters( |
| 1024 | 1024 | 'FHEE__EE_Config__register_widgets__widgets_to_register', |
| 1025 | 1025 | $widgets_to_register |
| 1026 | 1026 | ); |
| 1027 | - if (! empty($widgets_to_register)) { |
|
| 1027 | + if ( ! empty($widgets_to_register)) { |
|
| 1028 | 1028 | // cycle thru widget folders |
| 1029 | 1029 | foreach ($widgets_to_register as $widget_path) { |
| 1030 | 1030 | // add to list of installed widget modules |
@@ -1074,31 +1074,31 @@ discard block |
||
| 1074 | 1074 | // create classname from widget directory name |
| 1075 | 1075 | $widget = str_replace(' ', '_', ucwords(str_replace('_', ' ', $widget))); |
| 1076 | 1076 | // add class prefix |
| 1077 | - $widget_class = 'EEW_' . $widget; |
|
| 1077 | + $widget_class = 'EEW_'.$widget; |
|
| 1078 | 1078 | // does the widget exist ? |
| 1079 | - if (! is_readable($widget_path . DS . $widget_class . $widget_ext)) { |
|
| 1079 | + if ( ! is_readable($widget_path.DS.$widget_class.$widget_ext)) { |
|
| 1080 | 1080 | $msg = sprintf( |
| 1081 | 1081 | __( |
| 1082 | 1082 | 'The requested %s widget file could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s', |
| 1083 | 1083 | 'event_espresso' |
| 1084 | 1084 | ), |
| 1085 | 1085 | $widget_class, |
| 1086 | - $widget_path . DS . $widget_class . $widget_ext |
|
| 1086 | + $widget_path.DS.$widget_class.$widget_ext |
|
| 1087 | 1087 | ); |
| 1088 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1088 | + EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1089 | 1089 | return; |
| 1090 | 1090 | } |
| 1091 | 1091 | // load the widget class file |
| 1092 | - require_once($widget_path . DS . $widget_class . $widget_ext); |
|
| 1092 | + require_once($widget_path.DS.$widget_class.$widget_ext); |
|
| 1093 | 1093 | // verify that class exists |
| 1094 | - if (! class_exists($widget_class)) { |
|
| 1094 | + if ( ! class_exists($widget_class)) { |
|
| 1095 | 1095 | $msg = sprintf(__('The requested %s widget class does not exist.', 'event_espresso'), $widget_class); |
| 1096 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1096 | + EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1097 | 1097 | return; |
| 1098 | 1098 | } |
| 1099 | 1099 | register_widget($widget_class); |
| 1100 | 1100 | // add to array of registered widgets |
| 1101 | - EE_Registry::instance()->widgets->{$widget_class} = $widget_path . DS . $widget_class . $widget_ext; |
|
| 1101 | + EE_Registry::instance()->widgets->{$widget_class} = $widget_path.DS.$widget_class.$widget_ext; |
|
| 1102 | 1102 | } |
| 1103 | 1103 | |
| 1104 | 1104 | |
@@ -1111,18 +1111,18 @@ discard block |
||
| 1111 | 1111 | private function _register_modules() |
| 1112 | 1112 | { |
| 1113 | 1113 | // grab list of installed modules |
| 1114 | - $modules_to_register = glob(EE_MODULES . '*', GLOB_ONLYDIR); |
|
| 1114 | + $modules_to_register = glob(EE_MODULES.'*', GLOB_ONLYDIR); |
|
| 1115 | 1115 | // filter list of modules to register |
| 1116 | 1116 | $modules_to_register = apply_filters( |
| 1117 | 1117 | 'FHEE__EE_Config__register_modules__modules_to_register', |
| 1118 | 1118 | $modules_to_register |
| 1119 | 1119 | ); |
| 1120 | - if (! empty($modules_to_register)) { |
|
| 1120 | + if ( ! empty($modules_to_register)) { |
|
| 1121 | 1121 | // loop through folders |
| 1122 | 1122 | foreach ($modules_to_register as $module_path) { |
| 1123 | 1123 | /**TEMPORARILY EXCLUDE gateways from modules for time being**/ |
| 1124 | - if ($module_path !== EE_MODULES . 'zzz-copy-this-module-template' |
|
| 1125 | - && $module_path !== EE_MODULES . 'gateways' |
|
| 1124 | + if ($module_path !== EE_MODULES.'zzz-copy-this-module-template' |
|
| 1125 | + && $module_path !== EE_MODULES.'gateways' |
|
| 1126 | 1126 | ) { |
| 1127 | 1127 | // add to list of installed modules |
| 1128 | 1128 | EE_Config::register_module($module_path); |
@@ -1159,25 +1159,25 @@ discard block |
||
| 1159 | 1159 | // remove last segment |
| 1160 | 1160 | array_pop($module_path); |
| 1161 | 1161 | // glue it back together |
| 1162 | - $module_path = implode(DS, $module_path) . DS; |
|
| 1162 | + $module_path = implode(DS, $module_path).DS; |
|
| 1163 | 1163 | // take first segment from file name pieces and sanitize it |
| 1164 | 1164 | $module = preg_replace('/[^a-zA-Z0-9_\-]/', '', $module_file[0]); |
| 1165 | 1165 | // ensure class prefix is added |
| 1166 | - $module_class = strpos($module, 'EED_') !== 0 ? 'EED_' . $module : $module; |
|
| 1166 | + $module_class = strpos($module, 'EED_') !== 0 ? 'EED_'.$module : $module; |
|
| 1167 | 1167 | } else { |
| 1168 | 1168 | // we need to generate the filename based off of the folder name |
| 1169 | 1169 | // grab and sanitize module name |
| 1170 | 1170 | $module = strtolower(basename($module_path)); |
| 1171 | 1171 | $module = preg_replace('/[^a-z0-9_\-]/', '', $module); |
| 1172 | 1172 | // like trailingslashit() |
| 1173 | - $module_path = rtrim($module_path, DS) . DS; |
|
| 1173 | + $module_path = rtrim($module_path, DS).DS; |
|
| 1174 | 1174 | // create classname from module directory name |
| 1175 | 1175 | $module = str_replace(' ', '_', ucwords(str_replace('_', ' ', $module))); |
| 1176 | 1176 | // add class prefix |
| 1177 | - $module_class = 'EED_' . $module; |
|
| 1177 | + $module_class = 'EED_'.$module; |
|
| 1178 | 1178 | } |
| 1179 | 1179 | // does the module exist ? |
| 1180 | - if (! is_readable($module_path . DS . $module_class . $module_ext)) { |
|
| 1180 | + if ( ! is_readable($module_path.DS.$module_class.$module_ext)) { |
|
| 1181 | 1181 | $msg = sprintf( |
| 1182 | 1182 | __( |
| 1183 | 1183 | 'The requested %s module file could not be found or is not readable due to file permissions.', |
@@ -1185,19 +1185,19 @@ discard block |
||
| 1185 | 1185 | ), |
| 1186 | 1186 | $module |
| 1187 | 1187 | ); |
| 1188 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1188 | + EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1189 | 1189 | return false; |
| 1190 | 1190 | } |
| 1191 | 1191 | // load the module class file |
| 1192 | - require_once($module_path . $module_class . $module_ext); |
|
| 1192 | + require_once($module_path.$module_class.$module_ext); |
|
| 1193 | 1193 | // verify that class exists |
| 1194 | - if (! class_exists($module_class)) { |
|
| 1194 | + if ( ! class_exists($module_class)) { |
|
| 1195 | 1195 | $msg = sprintf(__('The requested %s module class does not exist.', 'event_espresso'), $module_class); |
| 1196 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1196 | + EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1197 | 1197 | return false; |
| 1198 | 1198 | } |
| 1199 | 1199 | // add to array of registered modules |
| 1200 | - EE_Registry::instance()->modules->{$module_class} = $module_path . $module_class . $module_ext; |
|
| 1200 | + EE_Registry::instance()->modules->{$module_class} = $module_path.$module_class.$module_ext; |
|
| 1201 | 1201 | do_action( |
| 1202 | 1202 | 'AHEE__EE_Config__register_module__complete', |
| 1203 | 1203 | $module_class, |
@@ -1248,26 +1248,26 @@ discard block |
||
| 1248 | 1248 | { |
| 1249 | 1249 | do_action('AHEE__EE_Config__register_route__begin', $route, $module, $method_name); |
| 1250 | 1250 | $module = str_replace('EED_', '', $module); |
| 1251 | - $module_class = 'EED_' . $module; |
|
| 1252 | - if (! isset(EE_Registry::instance()->modules->{$module_class})) { |
|
| 1251 | + $module_class = 'EED_'.$module; |
|
| 1252 | + if ( ! isset(EE_Registry::instance()->modules->{$module_class})) { |
|
| 1253 | 1253 | $msg = sprintf(__('The module %s has not been registered.', 'event_espresso'), $module); |
| 1254 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1254 | + EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1255 | 1255 | return false; |
| 1256 | 1256 | } |
| 1257 | 1257 | if (empty($route)) { |
| 1258 | 1258 | $msg = sprintf(__('No route has been supplied.', 'event_espresso'), $route); |
| 1259 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1259 | + EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1260 | 1260 | return false; |
| 1261 | 1261 | } |
| 1262 | - if (! method_exists('EED_' . $module, $method_name)) { |
|
| 1262 | + if ( ! method_exists('EED_'.$module, $method_name)) { |
|
| 1263 | 1263 | $msg = sprintf( |
| 1264 | 1264 | __('A valid class method for the %s route has not been supplied.', 'event_espresso'), |
| 1265 | 1265 | $route |
| 1266 | 1266 | ); |
| 1267 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1267 | + EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1268 | 1268 | return false; |
| 1269 | 1269 | } |
| 1270 | - EE_Config::$_module_route_map[ (string) $key ][ (string) $route ] = array('EED_' . $module, $method_name); |
|
| 1270 | + EE_Config::$_module_route_map[(string) $key][(string) $route] = array('EED_'.$module, $method_name); |
|
| 1271 | 1271 | return true; |
| 1272 | 1272 | } |
| 1273 | 1273 | |
@@ -1284,8 +1284,8 @@ discard block |
||
| 1284 | 1284 | { |
| 1285 | 1285 | do_action('AHEE__EE_Config__get_route__begin', $route); |
| 1286 | 1286 | $route = (string) apply_filters('FHEE__EE_Config__get_route', $route); |
| 1287 | - if (isset(EE_Config::$_module_route_map[ $key ][ $route ])) { |
|
| 1288 | - return EE_Config::$_module_route_map[ $key ][ $route ]; |
|
| 1287 | + if (isset(EE_Config::$_module_route_map[$key][$route])) { |
|
| 1288 | + return EE_Config::$_module_route_map[$key][$route]; |
|
| 1289 | 1289 | } |
| 1290 | 1290 | return null; |
| 1291 | 1291 | } |
@@ -1317,47 +1317,47 @@ discard block |
||
| 1317 | 1317 | public static function register_forward($route = null, $status = 0, $forward = null, $key = 'ee') |
| 1318 | 1318 | { |
| 1319 | 1319 | do_action('AHEE__EE_Config__register_forward', $route, $status, $forward); |
| 1320 | - if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) { |
|
| 1320 | + if ( ! isset(EE_Config::$_module_route_map[$key][$route]) || empty($route)) { |
|
| 1321 | 1321 | $msg = sprintf( |
| 1322 | 1322 | __('The module route %s for this forward has not been registered.', 'event_espresso'), |
| 1323 | 1323 | $route |
| 1324 | 1324 | ); |
| 1325 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1325 | + EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1326 | 1326 | return false; |
| 1327 | 1327 | } |
| 1328 | 1328 | if (empty($forward)) { |
| 1329 | 1329 | $msg = sprintf(__('No forwarding route has been supplied.', 'event_espresso'), $route); |
| 1330 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1330 | + EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1331 | 1331 | return false; |
| 1332 | 1332 | } |
| 1333 | 1333 | if (is_array($forward)) { |
| 1334 | - if (! isset($forward[1])) { |
|
| 1334 | + if ( ! isset($forward[1])) { |
|
| 1335 | 1335 | $msg = sprintf( |
| 1336 | 1336 | __('A class method for the %s forwarding route has not been supplied.', 'event_espresso'), |
| 1337 | 1337 | $route |
| 1338 | 1338 | ); |
| 1339 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1339 | + EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1340 | 1340 | return false; |
| 1341 | 1341 | } |
| 1342 | - if (! method_exists($forward[0], $forward[1])) { |
|
| 1342 | + if ( ! method_exists($forward[0], $forward[1])) { |
|
| 1343 | 1343 | $msg = sprintf( |
| 1344 | 1344 | __('The class method %s for the %s forwarding route is in invalid.', 'event_espresso'), |
| 1345 | 1345 | $forward[1], |
| 1346 | 1346 | $route |
| 1347 | 1347 | ); |
| 1348 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1348 | + EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1349 | 1349 | return false; |
| 1350 | 1350 | } |
| 1351 | - } elseif (! function_exists($forward)) { |
|
| 1351 | + } elseif ( ! function_exists($forward)) { |
|
| 1352 | 1352 | $msg = sprintf( |
| 1353 | 1353 | __('The function %s for the %s forwarding route is in invalid.', 'event_espresso'), |
| 1354 | 1354 | $forward, |
| 1355 | 1355 | $route |
| 1356 | 1356 | ); |
| 1357 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1357 | + EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1358 | 1358 | return false; |
| 1359 | 1359 | } |
| 1360 | - EE_Config::$_module_forward_map[ $key ][ $route ][ absint($status) ] = $forward; |
|
| 1360 | + EE_Config::$_module_forward_map[$key][$route][absint($status)] = $forward; |
|
| 1361 | 1361 | return true; |
| 1362 | 1362 | } |
| 1363 | 1363 | |
@@ -1375,10 +1375,10 @@ discard block |
||
| 1375 | 1375 | public static function get_forward($route = null, $status = 0, $key = 'ee') |
| 1376 | 1376 | { |
| 1377 | 1377 | do_action('AHEE__EE_Config__get_forward__begin', $route, $status); |
| 1378 | - if (isset(EE_Config::$_module_forward_map[ $key ][ $route ][ $status ])) { |
|
| 1378 | + if (isset(EE_Config::$_module_forward_map[$key][$route][$status])) { |
|
| 1379 | 1379 | return apply_filters( |
| 1380 | 1380 | 'FHEE__EE_Config__get_forward', |
| 1381 | - EE_Config::$_module_forward_map[ $key ][ $route ][ $status ], |
|
| 1381 | + EE_Config::$_module_forward_map[$key][$route][$status], |
|
| 1382 | 1382 | $route, |
| 1383 | 1383 | $status |
| 1384 | 1384 | ); |
@@ -1402,15 +1402,15 @@ discard block |
||
| 1402 | 1402 | public static function register_view($route = null, $status = 0, $view = null, $key = 'ee') |
| 1403 | 1403 | { |
| 1404 | 1404 | do_action('AHEE__EE_Config__register_view__begin', $route, $status, $view); |
| 1405 | - if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) { |
|
| 1405 | + if ( ! isset(EE_Config::$_module_route_map[$key][$route]) || empty($route)) { |
|
| 1406 | 1406 | $msg = sprintf( |
| 1407 | 1407 | __('The module route %s for this view has not been registered.', 'event_espresso'), |
| 1408 | 1408 | $route |
| 1409 | 1409 | ); |
| 1410 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1410 | + EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1411 | 1411 | return false; |
| 1412 | 1412 | } |
| 1413 | - if (! is_readable($view)) { |
|
| 1413 | + if ( ! is_readable($view)) { |
|
| 1414 | 1414 | $msg = sprintf( |
| 1415 | 1415 | __( |
| 1416 | 1416 | 'The %s view file could not be found or is not readable due to file permissions.', |
@@ -1418,10 +1418,10 @@ discard block |
||
| 1418 | 1418 | ), |
| 1419 | 1419 | $view |
| 1420 | 1420 | ); |
| 1421 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1421 | + EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1422 | 1422 | return false; |
| 1423 | 1423 | } |
| 1424 | - EE_Config::$_module_view_map[ $key ][ $route ][ absint($status) ] = $view; |
|
| 1424 | + EE_Config::$_module_view_map[$key][$route][absint($status)] = $view; |
|
| 1425 | 1425 | return true; |
| 1426 | 1426 | } |
| 1427 | 1427 | |
@@ -1439,10 +1439,10 @@ discard block |
||
| 1439 | 1439 | public static function get_view($route = null, $status = 0, $key = 'ee') |
| 1440 | 1440 | { |
| 1441 | 1441 | do_action('AHEE__EE_Config__get_view__begin', $route, $status); |
| 1442 | - if (isset(EE_Config::$_module_view_map[ $key ][ $route ][ $status ])) { |
|
| 1442 | + if (isset(EE_Config::$_module_view_map[$key][$route][$status])) { |
|
| 1443 | 1443 | return apply_filters( |
| 1444 | 1444 | 'FHEE__EE_Config__get_view', |
| 1445 | - EE_Config::$_module_view_map[ $key ][ $route ][ $status ], |
|
| 1445 | + EE_Config::$_module_view_map[$key][$route][$status], |
|
| 1446 | 1446 | $route, |
| 1447 | 1447 | $status |
| 1448 | 1448 | ); |
@@ -1469,7 +1469,7 @@ discard block |
||
| 1469 | 1469 | public static function getLegacyShortcodesManager() |
| 1470 | 1470 | { |
| 1471 | 1471 | |
| 1472 | - if (! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) { |
|
| 1472 | + if ( ! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) { |
|
| 1473 | 1473 | EE_Config::instance()->legacy_shortcodes_manager = new LegacyShortcodesManager( |
| 1474 | 1474 | EE_Registry::instance() |
| 1475 | 1475 | ); |
@@ -1516,7 +1516,7 @@ discard block |
||
| 1516 | 1516 | */ |
| 1517 | 1517 | public function get_pretty($property) |
| 1518 | 1518 | { |
| 1519 | - if (! property_exists($this, $property)) { |
|
| 1519 | + if ( ! property_exists($this, $property)) { |
|
| 1520 | 1520 | throw new EE_Error( |
| 1521 | 1521 | sprintf( |
| 1522 | 1522 | __( |
@@ -1745,11 +1745,11 @@ discard block |
||
| 1745 | 1745 | */ |
| 1746 | 1746 | public function reg_page_url() |
| 1747 | 1747 | { |
| 1748 | - if (! $this->reg_page_url) { |
|
| 1748 | + if ( ! $this->reg_page_url) { |
|
| 1749 | 1749 | $this->reg_page_url = add_query_arg( |
| 1750 | 1750 | array('uts' => time()), |
| 1751 | 1751 | get_permalink($this->reg_page_id) |
| 1752 | - ) . '#checkout'; |
|
| 1752 | + ).'#checkout'; |
|
| 1753 | 1753 | } |
| 1754 | 1754 | return $this->reg_page_url; |
| 1755 | 1755 | } |
@@ -1765,7 +1765,7 @@ discard block |
||
| 1765 | 1765 | */ |
| 1766 | 1766 | public function txn_page_url($query_args = array()) |
| 1767 | 1767 | { |
| 1768 | - if (! $this->txn_page_url) { |
|
| 1768 | + if ( ! $this->txn_page_url) { |
|
| 1769 | 1769 | $this->txn_page_url = get_permalink($this->txn_page_id); |
| 1770 | 1770 | } |
| 1771 | 1771 | if ($query_args) { |
@@ -1786,7 +1786,7 @@ discard block |
||
| 1786 | 1786 | */ |
| 1787 | 1787 | public function thank_you_page_url($query_args = array()) |
| 1788 | 1788 | { |
| 1789 | - if (! $this->thank_you_page_url) { |
|
| 1789 | + if ( ! $this->thank_you_page_url) { |
|
| 1790 | 1790 | $this->thank_you_page_url = get_permalink($this->thank_you_page_id); |
| 1791 | 1791 | } |
| 1792 | 1792 | if ($query_args) { |
@@ -1805,7 +1805,7 @@ discard block |
||
| 1805 | 1805 | */ |
| 1806 | 1806 | public function cancel_page_url() |
| 1807 | 1807 | { |
| 1808 | - if (! $this->cancel_page_url) { |
|
| 1808 | + if ( ! $this->cancel_page_url) { |
|
| 1809 | 1809 | $this->cancel_page_url = get_permalink($this->cancel_page_id); |
| 1810 | 1810 | } |
| 1811 | 1811 | return $this->cancel_page_url; |
@@ -1848,13 +1848,13 @@ discard block |
||
| 1848 | 1848 | $current_main_site_id = ! empty($current_network_main_site) ? $current_network_main_site->blog_id : 1; |
| 1849 | 1849 | $option = self::OPTION_NAME_UXIP; |
| 1850 | 1850 | // set correct table for query |
| 1851 | - $table_name = $wpdb->get_blog_prefix($current_main_site_id) . 'options'; |
|
| 1851 | + $table_name = $wpdb->get_blog_prefix($current_main_site_id).'options'; |
|
| 1852 | 1852 | // rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because |
| 1853 | 1853 | // get_blog_option() does a switch_to_blog an that could cause infinite recursion because EE_Core_Config might be |
| 1854 | 1854 | // re-constructed on the blog switch. Note, we are still executing any core wp filters on this option retrieval. |
| 1855 | 1855 | // this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog |
| 1856 | 1856 | // for the purpose of caching. |
| 1857 | - $pre = apply_filters('pre_option_' . $option, false, $option); |
|
| 1857 | + $pre = apply_filters('pre_option_'.$option, false, $option); |
|
| 1858 | 1858 | if (false !== $pre) { |
| 1859 | 1859 | EE_Core_Config::$ee_ueip_option = $pre; |
| 1860 | 1860 | return EE_Core_Config::$ee_ueip_option; |
@@ -1868,10 +1868,10 @@ discard block |
||
| 1868 | 1868 | if (is_object($row)) { |
| 1869 | 1869 | $value = $row->option_value; |
| 1870 | 1870 | } else { // option does not exist so use default. |
| 1871 | - EE_Core_Config::$ee_ueip_option = apply_filters('default_option_' . $option, false, $option); |
|
| 1871 | + EE_Core_Config::$ee_ueip_option = apply_filters('default_option_'.$option, false, $option); |
|
| 1872 | 1872 | return EE_Core_Config::$ee_ueip_option; |
| 1873 | 1873 | } |
| 1874 | - EE_Core_Config::$ee_ueip_option = apply_filters('option_' . $option, maybe_unserialize($value), $option); |
|
| 1874 | + EE_Core_Config::$ee_ueip_option = apply_filters('option_'.$option, maybe_unserialize($value), $option); |
|
| 1875 | 1875 | return EE_Core_Config::$ee_ueip_option; |
| 1876 | 1876 | } |
| 1877 | 1877 | |
@@ -2125,37 +2125,37 @@ discard block |
||
| 2125 | 2125 | // but override if requested |
| 2126 | 2126 | $CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : $ORG_CNT; |
| 2127 | 2127 | // so if that all went well, and we are not in M-Mode (cuz you can't query the db in M-Mode) and double-check the countries table exists |
| 2128 | - if (! empty($CNT_ISO) |
|
| 2128 | + if ( ! empty($CNT_ISO) |
|
| 2129 | 2129 | && EE_Maintenance_Mode::instance()->models_can_query() |
| 2130 | 2130 | && $table_analysis->tableExists(EE_Registry::instance()->load_model('Country')->table()) |
| 2131 | 2131 | ) { |
| 2132 | 2132 | // retrieve the country settings from the db, just in case they have been customized |
| 2133 | 2133 | $country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($CNT_ISO); |
| 2134 | 2134 | if ($country instanceof EE_Country) { |
| 2135 | - $this->code = $country->currency_code(); // currency code: USD, CAD, EUR |
|
| 2136 | - $this->name = $country->currency_name_single(); // Dollar |
|
| 2137 | - $this->plural = $country->currency_name_plural(); // Dollars |
|
| 2138 | - $this->sign = $country->currency_sign(); // currency sign: $ |
|
| 2135 | + $this->code = $country->currency_code(); // currency code: USD, CAD, EUR |
|
| 2136 | + $this->name = $country->currency_name_single(); // Dollar |
|
| 2137 | + $this->plural = $country->currency_name_plural(); // Dollars |
|
| 2138 | + $this->sign = $country->currency_sign(); // currency sign: $ |
|
| 2139 | 2139 | $this->sign_b4 = $country->currency_sign_before( |
| 2140 | - ); // currency sign before or after: $TRUE or FALSE$ |
|
| 2141 | - $this->dec_plc = $country->currency_decimal_places(); // decimal places: 2 = 0.00 3 = 0.000 |
|
| 2140 | + ); // currency sign before or after: $TRUE or FALSE$ |
|
| 2141 | + $this->dec_plc = $country->currency_decimal_places(); // decimal places: 2 = 0.00 3 = 0.000 |
|
| 2142 | 2142 | $this->dec_mrk = $country->currency_decimal_mark( |
| 2143 | - ); // decimal mark: (comma) ',' = 0,01 or (decimal) '.' = 0.01 |
|
| 2143 | + ); // decimal mark: (comma) ',' = 0,01 or (decimal) '.' = 0.01 |
|
| 2144 | 2144 | $this->thsnds = $country->currency_thousands_separator( |
| 2145 | - ); // thousands separator: (comma) ',' = 1,000 or (decimal) '.' = 1.000 |
|
| 2145 | + ); // thousands separator: (comma) ',' = 1,000 or (decimal) '.' = 1.000 |
|
| 2146 | 2146 | } |
| 2147 | 2147 | } |
| 2148 | 2148 | // fallback to hardcoded defaults, in case the above failed |
| 2149 | 2149 | if (empty($this->code)) { |
| 2150 | 2150 | // set default currency settings |
| 2151 | - $this->code = 'USD'; // currency code: USD, CAD, EUR |
|
| 2152 | - $this->name = __('Dollar', 'event_espresso'); // Dollar |
|
| 2153 | - $this->plural = __('Dollars', 'event_espresso'); // Dollars |
|
| 2154 | - $this->sign = '$'; // currency sign: $ |
|
| 2155 | - $this->sign_b4 = true; // currency sign before or after: $TRUE or FALSE$ |
|
| 2156 | - $this->dec_plc = 2; // decimal places: 2 = 0.00 3 = 0.000 |
|
| 2157 | - $this->dec_mrk = '.'; // decimal mark: (comma) ',' = 0,01 or (decimal) '.' = 0.01 |
|
| 2158 | - $this->thsnds = ','; // thousands separator: (comma) ',' = 1,000 or (decimal) '.' = 1.000 |
|
| 2151 | + $this->code = 'USD'; // currency code: USD, CAD, EUR |
|
| 2152 | + $this->name = __('Dollar', 'event_espresso'); // Dollar |
|
| 2153 | + $this->plural = __('Dollars', 'event_espresso'); // Dollars |
|
| 2154 | + $this->sign = '$'; // currency sign: $ |
|
| 2155 | + $this->sign_b4 = true; // currency sign before or after: $TRUE or FALSE$ |
|
| 2156 | + $this->dec_plc = 2; // decimal places: 2 = 0.00 3 = 0.000 |
|
| 2157 | + $this->dec_mrk = '.'; // decimal mark: (comma) ',' = 0,01 or (decimal) '.' = 0.01 |
|
| 2158 | + $this->thsnds = ','; // thousands separator: (comma) ',' = 1,000 or (decimal) '.' = 1.000 |
|
| 2159 | 2159 | } |
| 2160 | 2160 | } |
| 2161 | 2161 | } |
@@ -2414,8 +2414,8 @@ discard block |
||
| 2414 | 2414 | $closing_a_tag = ''; |
| 2415 | 2415 | if (function_exists('get_privacy_policy_url')) { |
| 2416 | 2416 | $privacy_page_url = get_privacy_policy_url(); |
| 2417 | - if (! empty($privacy_page_url)) { |
|
| 2418 | - $opening_a_tag = '<a href="' . $privacy_page_url . '" target="_blank">'; |
|
| 2417 | + if ( ! empty($privacy_page_url)) { |
|
| 2418 | + $opening_a_tag = '<a href="'.$privacy_page_url.'" target="_blank">'; |
|
| 2419 | 2419 | $closing_a_tag = '</a>'; |
| 2420 | 2420 | } |
| 2421 | 2421 | } |
@@ -2627,7 +2627,7 @@ discard block |
||
| 2627 | 2627 | public function log_file_name($reset = false) |
| 2628 | 2628 | { |
| 2629 | 2629 | if (empty($this->log_file_name) || $reset) { |
| 2630 | - $this->log_file_name = sanitize_key('espresso_log_' . md5(uniqid('', true))) . '.txt'; |
|
| 2630 | + $this->log_file_name = sanitize_key('espresso_log_'.md5(uniqid('', true))).'.txt'; |
|
| 2631 | 2631 | EE_Config::instance()->update_espresso_config(false, false); |
| 2632 | 2632 | } |
| 2633 | 2633 | return $this->log_file_name; |
@@ -2641,7 +2641,7 @@ discard block |
||
| 2641 | 2641 | public function debug_file_name($reset = false) |
| 2642 | 2642 | { |
| 2643 | 2643 | if (empty($this->debug_file_name) || $reset) { |
| 2644 | - $this->debug_file_name = sanitize_key('espresso_debug_' . md5(uniqid('', true))) . '.txt'; |
|
| 2644 | + $this->debug_file_name = sanitize_key('espresso_debug_'.md5(uniqid('', true))).'.txt'; |
|
| 2645 | 2645 | EE_Config::instance()->update_espresso_config(false, false); |
| 2646 | 2646 | } |
| 2647 | 2647 | return $this->debug_file_name; |
@@ -2845,21 +2845,21 @@ discard block |
||
| 2845 | 2845 | $this->use_google_maps = true; |
| 2846 | 2846 | $this->google_map_api_key = ''; |
| 2847 | 2847 | // for event details pages (reg page) |
| 2848 | - $this->event_details_map_width = 585; // ee_map_width_single |
|
| 2849 | - $this->event_details_map_height = 362; // ee_map_height_single |
|
| 2850 | - $this->event_details_map_zoom = 14; // ee_map_zoom_single |
|
| 2851 | - $this->event_details_display_nav = true; // ee_map_nav_display_single |
|
| 2852 | - $this->event_details_nav_size = false; // ee_map_nav_size_single |
|
| 2853 | - $this->event_details_control_type = 'default'; // ee_map_type_control_single |
|
| 2854 | - $this->event_details_map_align = 'center'; // ee_map_align_single |
|
| 2848 | + $this->event_details_map_width = 585; // ee_map_width_single |
|
| 2849 | + $this->event_details_map_height = 362; // ee_map_height_single |
|
| 2850 | + $this->event_details_map_zoom = 14; // ee_map_zoom_single |
|
| 2851 | + $this->event_details_display_nav = true; // ee_map_nav_display_single |
|
| 2852 | + $this->event_details_nav_size = false; // ee_map_nav_size_single |
|
| 2853 | + $this->event_details_control_type = 'default'; // ee_map_type_control_single |
|
| 2854 | + $this->event_details_map_align = 'center'; // ee_map_align_single |
|
| 2855 | 2855 | // for event list pages |
| 2856 | - $this->event_list_map_width = 300; // ee_map_width |
|
| 2857 | - $this->event_list_map_height = 185; // ee_map_height |
|
| 2858 | - $this->event_list_map_zoom = 12; // ee_map_zoom |
|
| 2859 | - $this->event_list_display_nav = false; // ee_map_nav_display |
|
| 2860 | - $this->event_list_nav_size = true; // ee_map_nav_size |
|
| 2861 | - $this->event_list_control_type = 'dropdown'; // ee_map_type_control |
|
| 2862 | - $this->event_list_map_align = 'center'; // ee_map_align |
|
| 2856 | + $this->event_list_map_width = 300; // ee_map_width |
|
| 2857 | + $this->event_list_map_height = 185; // ee_map_height |
|
| 2858 | + $this->event_list_map_zoom = 12; // ee_map_zoom |
|
| 2859 | + $this->event_list_display_nav = false; // ee_map_nav_display |
|
| 2860 | + $this->event_list_nav_size = true; // ee_map_nav_size |
|
| 2861 | + $this->event_list_control_type = 'dropdown'; // ee_map_type_control |
|
| 2862 | + $this->event_list_map_align = 'center'; // ee_map_align |
|
| 2863 | 2863 | } |
| 2864 | 2864 | } |
| 2865 | 2865 | |
@@ -3177,7 +3177,7 @@ discard block |
||
| 3177 | 3177 | */ |
| 3178 | 3178 | public function max_input_vars_limit_check($input_count = 0) |
| 3179 | 3179 | { |
| 3180 | - if (! empty($this->php->max_input_vars) |
|
| 3180 | + if ( ! empty($this->php->max_input_vars) |
|
| 3181 | 3181 | && ($input_count >= $this->php->max_input_vars) |
| 3182 | 3182 | ) { |
| 3183 | 3183 | // check the server setting because the config value could be stale |
@@ -14,2509 +14,2509 @@ discard block |
||
| 14 | 14 | final class EE_Config implements ResettableInterface |
| 15 | 15 | { |
| 16 | 16 | |
| 17 | - const OPTION_NAME = 'ee_config'; |
|
| 18 | - |
|
| 19 | - const LOG_NAME = 'ee_config_log'; |
|
| 20 | - |
|
| 21 | - const LOG_LENGTH = 100; |
|
| 22 | - |
|
| 23 | - const ADDON_OPTION_NAMES = 'ee_config_option_names'; |
|
| 24 | - |
|
| 25 | - /** |
|
| 26 | - * instance of the EE_Config object |
|
| 27 | - * |
|
| 28 | - * @var EE_Config $_instance |
|
| 29 | - * @access private |
|
| 30 | - */ |
|
| 31 | - private static $_instance; |
|
| 32 | - |
|
| 33 | - /** |
|
| 34 | - * @var boolean $_logging_enabled |
|
| 35 | - */ |
|
| 36 | - private static $_logging_enabled = false; |
|
| 37 | - |
|
| 38 | - /** |
|
| 39 | - * @var LegacyShortcodesManager $legacy_shortcodes_manager |
|
| 40 | - */ |
|
| 41 | - private $legacy_shortcodes_manager; |
|
| 42 | - |
|
| 43 | - /** |
|
| 44 | - * An StdClass whose property names are addon slugs, |
|
| 45 | - * and values are their config classes |
|
| 46 | - * |
|
| 47 | - * @var StdClass |
|
| 48 | - */ |
|
| 49 | - public $addons; |
|
| 50 | - |
|
| 51 | - /** |
|
| 52 | - * @var EE_Admin_Config |
|
| 53 | - */ |
|
| 54 | - public $admin; |
|
| 55 | - |
|
| 56 | - /** |
|
| 57 | - * @var EE_Core_Config |
|
| 58 | - */ |
|
| 59 | - public $core; |
|
| 60 | - |
|
| 61 | - /** |
|
| 62 | - * @var EE_Currency_Config |
|
| 63 | - */ |
|
| 64 | - public $currency; |
|
| 65 | - |
|
| 66 | - /** |
|
| 67 | - * @var EE_Organization_Config |
|
| 68 | - */ |
|
| 69 | - public $organization; |
|
| 70 | - |
|
| 71 | - /** |
|
| 72 | - * @var EE_Registration_Config |
|
| 73 | - */ |
|
| 74 | - public $registration; |
|
| 75 | - |
|
| 76 | - /** |
|
| 77 | - * @var EE_Template_Config |
|
| 78 | - */ |
|
| 79 | - public $template_settings; |
|
| 80 | - |
|
| 81 | - /** |
|
| 82 | - * Holds EE environment values. |
|
| 83 | - * |
|
| 84 | - * @var EE_Environment_Config |
|
| 85 | - */ |
|
| 86 | - public $environment; |
|
| 87 | - |
|
| 88 | - /** |
|
| 89 | - * settings pertaining to Google maps |
|
| 90 | - * |
|
| 91 | - * @var EE_Map_Config |
|
| 92 | - */ |
|
| 93 | - public $map_settings; |
|
| 94 | - |
|
| 95 | - /** |
|
| 96 | - * settings pertaining to Taxes |
|
| 97 | - * |
|
| 98 | - * @var EE_Tax_Config |
|
| 99 | - */ |
|
| 100 | - public $tax_settings; |
|
| 101 | - |
|
| 102 | - /** |
|
| 103 | - * Settings pertaining to global messages settings. |
|
| 104 | - * |
|
| 105 | - * @var EE_Messages_Config |
|
| 106 | - */ |
|
| 107 | - public $messages; |
|
| 108 | - |
|
| 109 | - /** |
|
| 110 | - * @deprecated |
|
| 111 | - * @var EE_Gateway_Config |
|
| 112 | - */ |
|
| 113 | - public $gateway; |
|
| 114 | - |
|
| 115 | - /** |
|
| 116 | - * @var array $_addon_option_names |
|
| 117 | - * @access private |
|
| 118 | - */ |
|
| 119 | - private $_addon_option_names = array(); |
|
| 120 | - |
|
| 121 | - /** |
|
| 122 | - * @var array $_module_route_map |
|
| 123 | - * @access private |
|
| 124 | - */ |
|
| 125 | - private static $_module_route_map = array(); |
|
| 126 | - |
|
| 127 | - /** |
|
| 128 | - * @var array $_module_forward_map |
|
| 129 | - * @access private |
|
| 130 | - */ |
|
| 131 | - private static $_module_forward_map = array(); |
|
| 132 | - |
|
| 133 | - /** |
|
| 134 | - * @var array $_module_view_map |
|
| 135 | - * @access private |
|
| 136 | - */ |
|
| 137 | - private static $_module_view_map = array(); |
|
| 138 | - |
|
| 139 | - |
|
| 140 | - /** |
|
| 141 | - * @singleton method used to instantiate class object |
|
| 142 | - * @access public |
|
| 143 | - * @return EE_Config instance |
|
| 144 | - */ |
|
| 145 | - public static function instance() |
|
| 146 | - { |
|
| 147 | - // check if class object is instantiated, and instantiated properly |
|
| 148 | - if (! self::$_instance instanceof EE_Config) { |
|
| 149 | - self::$_instance = new self(); |
|
| 150 | - } |
|
| 151 | - return self::$_instance; |
|
| 152 | - } |
|
| 153 | - |
|
| 154 | - |
|
| 155 | - /** |
|
| 156 | - * Resets the config |
|
| 157 | - * |
|
| 158 | - * @param bool $hard_reset if TRUE, sets EE_CONFig back to its original settings in the database. If FALSE |
|
| 159 | - * (default) leaves the database alone, and merely resets the EE_Config object to |
|
| 160 | - * reflect its state in the database |
|
| 161 | - * @param boolean $reinstantiate if TRUE (default) call instance() and return it. Otherwise, just leave |
|
| 162 | - * $_instance as NULL. Useful in case you want to forget about the old instance on |
|
| 163 | - * EE_Config, but might not be ready to instantiate EE_Config currently (eg if the |
|
| 164 | - * site was put into maintenance mode) |
|
| 165 | - * @return EE_Config |
|
| 166 | - */ |
|
| 167 | - public static function reset($hard_reset = false, $reinstantiate = true) |
|
| 168 | - { |
|
| 169 | - if (self::$_instance instanceof EE_Config) { |
|
| 170 | - if ($hard_reset) { |
|
| 171 | - self::$_instance->legacy_shortcodes_manager = null; |
|
| 172 | - self::$_instance->_addon_option_names = array(); |
|
| 173 | - self::$_instance->_initialize_config(); |
|
| 174 | - self::$_instance->update_espresso_config(); |
|
| 175 | - } |
|
| 176 | - self::$_instance->update_addon_option_names(); |
|
| 177 | - } |
|
| 178 | - self::$_instance = null; |
|
| 179 | - // we don't need to reset the static properties imo because those should |
|
| 180 | - // only change when a module is added or removed. Currently we don't |
|
| 181 | - // support removing a module during a request when it previously existed |
|
| 182 | - if ($reinstantiate) { |
|
| 183 | - return self::instance(); |
|
| 184 | - } else { |
|
| 185 | - return null; |
|
| 186 | - } |
|
| 187 | - } |
|
| 188 | - |
|
| 189 | - |
|
| 190 | - /** |
|
| 191 | - * class constructor |
|
| 192 | - * |
|
| 193 | - * @access private |
|
| 194 | - */ |
|
| 195 | - private function __construct() |
|
| 196 | - { |
|
| 197 | - do_action('AHEE__EE_Config__construct__begin', $this); |
|
| 198 | - EE_Config::$_logging_enabled = apply_filters('FHEE__EE_Config___construct__logging_enabled', false); |
|
| 199 | - // setup empty config classes |
|
| 200 | - $this->_initialize_config(); |
|
| 201 | - // load existing EE site settings |
|
| 202 | - $this->_load_core_config(); |
|
| 203 | - // confirm everything loaded correctly and set filtered defaults if not |
|
| 204 | - $this->_verify_config(); |
|
| 205 | - // register shortcodes and modules |
|
| 206 | - add_action( |
|
| 207 | - 'AHEE__EE_System__register_shortcodes_modules_and_widgets', |
|
| 208 | - array($this, 'register_shortcodes_and_modules'), |
|
| 209 | - 999 |
|
| 210 | - ); |
|
| 211 | - // initialize shortcodes and modules |
|
| 212 | - add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'initialize_shortcodes_and_modules')); |
|
| 213 | - // register widgets |
|
| 214 | - add_action('widgets_init', array($this, 'widgets_init'), 10); |
|
| 215 | - // shutdown |
|
| 216 | - add_action('shutdown', array($this, 'shutdown'), 10); |
|
| 217 | - // construct__end hook |
|
| 218 | - do_action('AHEE__EE_Config__construct__end', $this); |
|
| 219 | - // hardcoded hack |
|
| 220 | - $this->template_settings->current_espresso_theme = 'Espresso_Arabica_2014'; |
|
| 221 | - } |
|
| 222 | - |
|
| 223 | - |
|
| 224 | - /** |
|
| 225 | - * @return boolean |
|
| 226 | - */ |
|
| 227 | - public static function logging_enabled() |
|
| 228 | - { |
|
| 229 | - return self::$_logging_enabled; |
|
| 230 | - } |
|
| 231 | - |
|
| 232 | - |
|
| 233 | - /** |
|
| 234 | - * use to get the current theme if needed from static context |
|
| 235 | - * |
|
| 236 | - * @return string current theme set. |
|
| 237 | - */ |
|
| 238 | - public static function get_current_theme() |
|
| 239 | - { |
|
| 240 | - return isset(self::$_instance->template_settings->current_espresso_theme) |
|
| 241 | - ? self::$_instance->template_settings->current_espresso_theme : 'Espresso_Arabica_2014'; |
|
| 242 | - } |
|
| 243 | - |
|
| 244 | - |
|
| 245 | - /** |
|
| 246 | - * _initialize_config |
|
| 247 | - * |
|
| 248 | - * @access private |
|
| 249 | - * @return void |
|
| 250 | - */ |
|
| 251 | - private function _initialize_config() |
|
| 252 | - { |
|
| 253 | - EE_Config::trim_log(); |
|
| 254 | - // set defaults |
|
| 255 | - $this->_addon_option_names = get_option(EE_Config::ADDON_OPTION_NAMES, array()); |
|
| 256 | - $this->addons = new stdClass(); |
|
| 257 | - // set _module_route_map |
|
| 258 | - EE_Config::$_module_route_map = array(); |
|
| 259 | - // set _module_forward_map |
|
| 260 | - EE_Config::$_module_forward_map = array(); |
|
| 261 | - // set _module_view_map |
|
| 262 | - EE_Config::$_module_view_map = array(); |
|
| 263 | - } |
|
| 264 | - |
|
| 265 | - |
|
| 266 | - /** |
|
| 267 | - * load core plugin configuration |
|
| 268 | - * |
|
| 269 | - * @access private |
|
| 270 | - * @return void |
|
| 271 | - */ |
|
| 272 | - private function _load_core_config() |
|
| 273 | - { |
|
| 274 | - // load_core_config__start hook |
|
| 275 | - do_action('AHEE__EE_Config___load_core_config__start', $this); |
|
| 276 | - $espresso_config = $this->get_espresso_config(); |
|
| 277 | - foreach ($espresso_config as $config => $settings) { |
|
| 278 | - // load_core_config__start hook |
|
| 279 | - $settings = apply_filters( |
|
| 280 | - 'FHEE__EE_Config___load_core_config__config_settings', |
|
| 281 | - $settings, |
|
| 282 | - $config, |
|
| 283 | - $this |
|
| 284 | - ); |
|
| 285 | - if (is_object($settings) && property_exists($this, $config)) { |
|
| 286 | - $this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__' . $config, $settings); |
|
| 287 | - // call configs populate method to ensure any defaults are set for empty values. |
|
| 288 | - if (method_exists($settings, 'populate')) { |
|
| 289 | - $this->{$config}->populate(); |
|
| 290 | - } |
|
| 291 | - if (method_exists($settings, 'do_hooks')) { |
|
| 292 | - $this->{$config}->do_hooks(); |
|
| 293 | - } |
|
| 294 | - } |
|
| 295 | - } |
|
| 296 | - if (apply_filters('FHEE__EE_Config___load_core_config__update_espresso_config', false)) { |
|
| 297 | - $this->update_espresso_config(); |
|
| 298 | - } |
|
| 299 | - // load_core_config__end hook |
|
| 300 | - do_action('AHEE__EE_Config___load_core_config__end', $this); |
|
| 301 | - } |
|
| 302 | - |
|
| 303 | - |
|
| 304 | - /** |
|
| 305 | - * _verify_config |
|
| 306 | - * |
|
| 307 | - * @access protected |
|
| 308 | - * @return void |
|
| 309 | - */ |
|
| 310 | - protected function _verify_config() |
|
| 311 | - { |
|
| 312 | - $this->core = $this->core instanceof EE_Core_Config |
|
| 313 | - ? $this->core |
|
| 314 | - : new EE_Core_Config(); |
|
| 315 | - $this->core = apply_filters('FHEE__EE_Config___initialize_config__core', $this->core); |
|
| 316 | - $this->organization = $this->organization instanceof EE_Organization_Config |
|
| 317 | - ? $this->organization |
|
| 318 | - : new EE_Organization_Config(); |
|
| 319 | - $this->organization = apply_filters( |
|
| 320 | - 'FHEE__EE_Config___initialize_config__organization', |
|
| 321 | - $this->organization |
|
| 322 | - ); |
|
| 323 | - $this->currency = $this->currency instanceof EE_Currency_Config |
|
| 324 | - ? $this->currency |
|
| 325 | - : new EE_Currency_Config(); |
|
| 326 | - $this->currency = apply_filters('FHEE__EE_Config___initialize_config__currency', $this->currency); |
|
| 327 | - $this->registration = $this->registration instanceof EE_Registration_Config |
|
| 328 | - ? $this->registration |
|
| 329 | - : new EE_Registration_Config(); |
|
| 330 | - $this->registration = apply_filters( |
|
| 331 | - 'FHEE__EE_Config___initialize_config__registration', |
|
| 332 | - $this->registration |
|
| 333 | - ); |
|
| 334 | - $this->admin = $this->admin instanceof EE_Admin_Config |
|
| 335 | - ? $this->admin |
|
| 336 | - : new EE_Admin_Config(); |
|
| 337 | - $this->admin = apply_filters('FHEE__EE_Config___initialize_config__admin', $this->admin); |
|
| 338 | - $this->template_settings = $this->template_settings instanceof EE_Template_Config |
|
| 339 | - ? $this->template_settings |
|
| 340 | - : new EE_Template_Config(); |
|
| 341 | - $this->template_settings = apply_filters( |
|
| 342 | - 'FHEE__EE_Config___initialize_config__template_settings', |
|
| 343 | - $this->template_settings |
|
| 344 | - ); |
|
| 345 | - $this->map_settings = $this->map_settings instanceof EE_Map_Config |
|
| 346 | - ? $this->map_settings |
|
| 347 | - : new EE_Map_Config(); |
|
| 348 | - $this->map_settings = apply_filters( |
|
| 349 | - 'FHEE__EE_Config___initialize_config__map_settings', |
|
| 350 | - $this->map_settings |
|
| 351 | - ); |
|
| 352 | - $this->environment = $this->environment instanceof EE_Environment_Config |
|
| 353 | - ? $this->environment |
|
| 354 | - : new EE_Environment_Config(); |
|
| 355 | - $this->environment = apply_filters( |
|
| 356 | - 'FHEE__EE_Config___initialize_config__environment', |
|
| 357 | - $this->environment |
|
| 358 | - ); |
|
| 359 | - $this->tax_settings = $this->tax_settings instanceof EE_Tax_Config |
|
| 360 | - ? $this->tax_settings |
|
| 361 | - : new EE_Tax_Config(); |
|
| 362 | - $this->tax_settings = apply_filters( |
|
| 363 | - 'FHEE__EE_Config___initialize_config__tax_settings', |
|
| 364 | - $this->tax_settings |
|
| 365 | - ); |
|
| 366 | - $this->messages = apply_filters('FHEE__EE_Config__initialize_config__messages', $this->messages); |
|
| 367 | - $this->messages = $this->messages instanceof EE_Messages_Config |
|
| 368 | - ? $this->messages |
|
| 369 | - : new EE_Messages_Config(); |
|
| 370 | - $this->gateway = $this->gateway instanceof EE_Gateway_Config |
|
| 371 | - ? $this->gateway |
|
| 372 | - : new EE_Gateway_Config(); |
|
| 373 | - $this->gateway = apply_filters('FHEE__EE_Config___initialize_config__gateway', $this->gateway); |
|
| 374 | - $this->legacy_shortcodes_manager = null; |
|
| 375 | - } |
|
| 376 | - |
|
| 377 | - |
|
| 378 | - /** |
|
| 379 | - * get_espresso_config |
|
| 380 | - * |
|
| 381 | - * @access public |
|
| 382 | - * @return array of espresso config stuff |
|
| 383 | - */ |
|
| 384 | - public function get_espresso_config() |
|
| 385 | - { |
|
| 386 | - // grab espresso configuration |
|
| 387 | - return apply_filters( |
|
| 388 | - 'FHEE__EE_Config__get_espresso_config__CFG', |
|
| 389 | - get_option(EE_Config::OPTION_NAME, array()) |
|
| 390 | - ); |
|
| 391 | - } |
|
| 392 | - |
|
| 393 | - |
|
| 394 | - /** |
|
| 395 | - * double_check_config_comparison |
|
| 396 | - * |
|
| 397 | - * @access public |
|
| 398 | - * @param string $option |
|
| 399 | - * @param $old_value |
|
| 400 | - * @param $value |
|
| 401 | - */ |
|
| 402 | - public function double_check_config_comparison($option = '', $old_value, $value) |
|
| 403 | - { |
|
| 404 | - // make sure we're checking the ee config |
|
| 405 | - if ($option === EE_Config::OPTION_NAME) { |
|
| 406 | - // run a loose comparison of the old value against the new value for type and properties, |
|
| 407 | - // but NOT exact instance like WP update_option does (ie: NOT type safe comparison) |
|
| 408 | - if ($value != $old_value) { |
|
| 409 | - // if they are NOT the same, then remove the hook, |
|
| 410 | - // which means the subsequent update results will be based solely on the update query results |
|
| 411 | - // the reason we do this is because, as stated above, |
|
| 412 | - // WP update_option performs an exact instance comparison (===) on any update values passed to it |
|
| 413 | - // this happens PRIOR to serialization and any subsequent update. |
|
| 414 | - // If values are found to match their previous old value, |
|
| 415 | - // then WP bails before performing any update. |
|
| 416 | - // Since we are passing the EE_Config object, it is comparing the EXACT instance of the saved version |
|
| 417 | - // it just pulled from the db, with the one being passed to it (which will not match). |
|
| 418 | - // HOWEVER, once the object is serialized and passed off to MySQL to update, |
|
| 419 | - // MySQL MAY ALSO NOT perform the update because |
|
| 420 | - // the string it sees in the db looks the same as the new one it has been passed!!! |
|
| 421 | - // This results in the query returning an "affected rows" value of ZERO, |
|
| 422 | - // which gets returned immediately by WP update_option and looks like an error. |
|
| 423 | - remove_action('update_option', array($this, 'check_config_updated')); |
|
| 424 | - } |
|
| 425 | - } |
|
| 426 | - } |
|
| 427 | - |
|
| 428 | - |
|
| 429 | - /** |
|
| 430 | - * update_espresso_config |
|
| 431 | - * |
|
| 432 | - * @access public |
|
| 433 | - */ |
|
| 434 | - protected function _reset_espresso_addon_config() |
|
| 435 | - { |
|
| 436 | - $this->_addon_option_names = array(); |
|
| 437 | - foreach ($this->addons as $addon_name => $addon_config_obj) { |
|
| 438 | - $addon_config_obj = maybe_unserialize($addon_config_obj); |
|
| 439 | - if ($addon_config_obj instanceof EE_Config_Base) { |
|
| 440 | - $this->update_config('addons', $addon_name, $addon_config_obj, false); |
|
| 441 | - } |
|
| 442 | - $this->addons->{$addon_name} = null; |
|
| 443 | - } |
|
| 444 | - } |
|
| 445 | - |
|
| 446 | - |
|
| 447 | - /** |
|
| 448 | - * update_espresso_config |
|
| 449 | - * |
|
| 450 | - * @access public |
|
| 451 | - * @param bool $add_success |
|
| 452 | - * @param bool $add_error |
|
| 453 | - * @return bool |
|
| 454 | - */ |
|
| 455 | - public function update_espresso_config($add_success = false, $add_error = true) |
|
| 456 | - { |
|
| 457 | - // don't allow config updates during WP heartbeats |
|
| 458 | - if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') { |
|
| 459 | - return false; |
|
| 460 | - } |
|
| 461 | - // commented out the following re: https://events.codebasehq.com/projects/event-espresso/tickets/8197 |
|
| 462 | - // $clone = clone( self::$_instance ); |
|
| 463 | - // self::$_instance = NULL; |
|
| 464 | - do_action('AHEE__EE_Config__update_espresso_config__begin', $this); |
|
| 465 | - $this->_reset_espresso_addon_config(); |
|
| 466 | - // hook into update_option because that happens AFTER the ( $value === $old_value ) conditional |
|
| 467 | - // but BEFORE the actual update occurs |
|
| 468 | - add_action('update_option', array($this, 'double_check_config_comparison'), 1, 3); |
|
| 469 | - // don't want to persist legacy_shortcodes_manager, but don't want to lose it either |
|
| 470 | - $legacy_shortcodes_manager = $this->legacy_shortcodes_manager; |
|
| 471 | - $this->legacy_shortcodes_manager = null; |
|
| 472 | - // now update "ee_config" |
|
| 473 | - $saved = update_option(EE_Config::OPTION_NAME, $this); |
|
| 474 | - $this->legacy_shortcodes_manager = $legacy_shortcodes_manager; |
|
| 475 | - EE_Config::log(EE_Config::OPTION_NAME); |
|
| 476 | - // if not saved... check if the hook we just added still exists; |
|
| 477 | - // if it does, it means one of two things: |
|
| 478 | - // that update_option bailed at the($value === $old_value) conditional, |
|
| 479 | - // or... |
|
| 480 | - // the db update query returned 0 rows affected |
|
| 481 | - // (probably because the data value was the same from it's perspective) |
|
| 482 | - // so the existence of the hook means that a negative result from update_option is NOT an error, |
|
| 483 | - // but just means no update occurred, so don't display an error to the user. |
|
| 484 | - // BUT... if update_option returns FALSE, AND the hook is missing, |
|
| 485 | - // then it means that something truly went wrong |
|
| 486 | - $saved = ! $saved ? has_action('update_option', array($this, 'double_check_config_comparison')) : $saved; |
|
| 487 | - // remove our action since we don't want it in the system anymore |
|
| 488 | - remove_action('update_option', array($this, 'double_check_config_comparison'), 1); |
|
| 489 | - do_action('AHEE__EE_Config__update_espresso_config__end', $this, $saved); |
|
| 490 | - // self::$_instance = $clone; |
|
| 491 | - // unset( $clone ); |
|
| 492 | - // if config remains the same or was updated successfully |
|
| 493 | - if ($saved) { |
|
| 494 | - if ($add_success) { |
|
| 495 | - EE_Error::add_success( |
|
| 496 | - __('The Event Espresso Configuration Settings have been successfully updated.', 'event_espresso'), |
|
| 497 | - __FILE__, |
|
| 498 | - __FUNCTION__, |
|
| 499 | - __LINE__ |
|
| 500 | - ); |
|
| 501 | - } |
|
| 502 | - return true; |
|
| 503 | - } else { |
|
| 504 | - if ($add_error) { |
|
| 505 | - EE_Error::add_error( |
|
| 506 | - __('The Event Espresso Configuration Settings were not updated.', 'event_espresso'), |
|
| 507 | - __FILE__, |
|
| 508 | - __FUNCTION__, |
|
| 509 | - __LINE__ |
|
| 510 | - ); |
|
| 511 | - } |
|
| 512 | - return false; |
|
| 513 | - } |
|
| 514 | - } |
|
| 515 | - |
|
| 516 | - |
|
| 517 | - /** |
|
| 518 | - * _verify_config_params |
|
| 519 | - * |
|
| 520 | - * @access private |
|
| 521 | - * @param string $section |
|
| 522 | - * @param string $name |
|
| 523 | - * @param string $config_class |
|
| 524 | - * @param EE_Config_Base $config_obj |
|
| 525 | - * @param array $tests_to_run |
|
| 526 | - * @param bool $display_errors |
|
| 527 | - * @return bool TRUE on success, FALSE on fail |
|
| 528 | - */ |
|
| 529 | - private function _verify_config_params( |
|
| 530 | - $section = '', |
|
| 531 | - $name = '', |
|
| 532 | - $config_class = '', |
|
| 533 | - $config_obj = null, |
|
| 534 | - $tests_to_run = array(1, 2, 3, 4, 5, 6, 7, 8), |
|
| 535 | - $display_errors = true |
|
| 536 | - ) { |
|
| 537 | - try { |
|
| 538 | - foreach ($tests_to_run as $test) { |
|
| 539 | - switch ($test) { |
|
| 540 | - // TEST #1 : check that section was set |
|
| 541 | - case 1: |
|
| 542 | - if (empty($section)) { |
|
| 543 | - if ($display_errors) { |
|
| 544 | - throw new EE_Error( |
|
| 545 | - sprintf( |
|
| 546 | - __( |
|
| 547 | - 'No configuration section has been provided while attempting to save "%s".', |
|
| 548 | - 'event_espresso' |
|
| 549 | - ), |
|
| 550 | - $config_class |
|
| 551 | - ) |
|
| 552 | - ); |
|
| 553 | - } |
|
| 554 | - return false; |
|
| 555 | - } |
|
| 556 | - break; |
|
| 557 | - // TEST #2 : check that settings section exists |
|
| 558 | - case 2: |
|
| 559 | - if (! isset($this->{$section})) { |
|
| 560 | - if ($display_errors) { |
|
| 561 | - throw new EE_Error( |
|
| 562 | - sprintf( |
|
| 563 | - __('The "%s" configuration section does not exist.', 'event_espresso'), |
|
| 564 | - $section |
|
| 565 | - ) |
|
| 566 | - ); |
|
| 567 | - } |
|
| 568 | - return false; |
|
| 569 | - } |
|
| 570 | - break; |
|
| 571 | - // TEST #3 : check that section is the proper format |
|
| 572 | - case 3: |
|
| 573 | - if (! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass) |
|
| 574 | - ) { |
|
| 575 | - if ($display_errors) { |
|
| 576 | - throw new EE_Error( |
|
| 577 | - sprintf( |
|
| 578 | - __( |
|
| 579 | - 'The "%s" configuration settings have not been formatted correctly.', |
|
| 580 | - 'event_espresso' |
|
| 581 | - ), |
|
| 582 | - $section |
|
| 583 | - ) |
|
| 584 | - ); |
|
| 585 | - } |
|
| 586 | - return false; |
|
| 587 | - } |
|
| 588 | - break; |
|
| 589 | - // TEST #4 : check that config section name has been set |
|
| 590 | - case 4: |
|
| 591 | - if (empty($name)) { |
|
| 592 | - if ($display_errors) { |
|
| 593 | - throw new EE_Error( |
|
| 594 | - __( |
|
| 595 | - 'No name has been provided for the specific configuration section.', |
|
| 596 | - 'event_espresso' |
|
| 597 | - ) |
|
| 598 | - ); |
|
| 599 | - } |
|
| 600 | - return false; |
|
| 601 | - } |
|
| 602 | - break; |
|
| 603 | - // TEST #5 : check that a config class name has been set |
|
| 604 | - case 5: |
|
| 605 | - if (empty($config_class)) { |
|
| 606 | - if ($display_errors) { |
|
| 607 | - throw new EE_Error( |
|
| 608 | - __( |
|
| 609 | - 'No class name has been provided for the specific configuration section.', |
|
| 610 | - 'event_espresso' |
|
| 611 | - ) |
|
| 612 | - ); |
|
| 613 | - } |
|
| 614 | - return false; |
|
| 615 | - } |
|
| 616 | - break; |
|
| 617 | - // TEST #6 : verify config class is accessible |
|
| 618 | - case 6: |
|
| 619 | - if (! class_exists($config_class)) { |
|
| 620 | - if ($display_errors) { |
|
| 621 | - throw new EE_Error( |
|
| 622 | - sprintf( |
|
| 623 | - __( |
|
| 624 | - 'The "%s" class does not exist. Please ensure that an autoloader has been set for it.', |
|
| 625 | - 'event_espresso' |
|
| 626 | - ), |
|
| 627 | - $config_class |
|
| 628 | - ) |
|
| 629 | - ); |
|
| 630 | - } |
|
| 631 | - return false; |
|
| 632 | - } |
|
| 633 | - break; |
|
| 634 | - // TEST #7 : check that config has even been set |
|
| 635 | - case 7: |
|
| 636 | - if (! isset($this->{$section}->{$name})) { |
|
| 637 | - if ($display_errors) { |
|
| 638 | - throw new EE_Error( |
|
| 639 | - sprintf( |
|
| 640 | - __('No configuration has been set for "%1$s->%2$s".', 'event_espresso'), |
|
| 641 | - $section, |
|
| 642 | - $name |
|
| 643 | - ) |
|
| 644 | - ); |
|
| 645 | - } |
|
| 646 | - return false; |
|
| 647 | - } else { |
|
| 648 | - // and make sure it's not serialized |
|
| 649 | - $this->{$section}->{$name} = maybe_unserialize($this->{$section}->{$name}); |
|
| 650 | - } |
|
| 651 | - break; |
|
| 652 | - // TEST #8 : check that config is the requested type |
|
| 653 | - case 8: |
|
| 654 | - if (! $this->{$section}->{$name} instanceof $config_class) { |
|
| 655 | - if ($display_errors) { |
|
| 656 | - throw new EE_Error( |
|
| 657 | - sprintf( |
|
| 658 | - __( |
|
| 659 | - 'The configuration for "%1$s->%2$s" is not of the "%3$s" class.', |
|
| 660 | - 'event_espresso' |
|
| 661 | - ), |
|
| 662 | - $section, |
|
| 663 | - $name, |
|
| 664 | - $config_class |
|
| 665 | - ) |
|
| 666 | - ); |
|
| 667 | - } |
|
| 668 | - return false; |
|
| 669 | - } |
|
| 670 | - break; |
|
| 671 | - // TEST #9 : verify config object |
|
| 672 | - case 9: |
|
| 673 | - if (! $config_obj instanceof EE_Config_Base) { |
|
| 674 | - if ($display_errors) { |
|
| 675 | - throw new EE_Error( |
|
| 676 | - sprintf( |
|
| 677 | - __('The "%s" class is not an instance of EE_Config_Base.', 'event_espresso'), |
|
| 678 | - print_r($config_obj, true) |
|
| 679 | - ) |
|
| 680 | - ); |
|
| 681 | - } |
|
| 682 | - return false; |
|
| 683 | - } |
|
| 684 | - break; |
|
| 685 | - } |
|
| 686 | - } |
|
| 687 | - } catch (EE_Error $e) { |
|
| 688 | - $e->get_error(); |
|
| 689 | - } |
|
| 690 | - // you have successfully run the gauntlet |
|
| 691 | - return true; |
|
| 692 | - } |
|
| 693 | - |
|
| 694 | - |
|
| 695 | - /** |
|
| 696 | - * _generate_config_option_name |
|
| 697 | - * |
|
| 698 | - * @access protected |
|
| 699 | - * @param string $section |
|
| 700 | - * @param string $name |
|
| 701 | - * @return string |
|
| 702 | - */ |
|
| 703 | - private function _generate_config_option_name($section = '', $name = '') |
|
| 704 | - { |
|
| 705 | - return 'ee_config-' . strtolower($section . '-' . str_replace(array('EE_', 'EED_'), '', $name)); |
|
| 706 | - } |
|
| 707 | - |
|
| 708 | - |
|
| 709 | - /** |
|
| 710 | - * _set_config_class |
|
| 711 | - * ensures that a config class is set, either from a passed config class or one generated from the config name |
|
| 712 | - * |
|
| 713 | - * @access private |
|
| 714 | - * @param string $config_class |
|
| 715 | - * @param string $name |
|
| 716 | - * @return string |
|
| 717 | - */ |
|
| 718 | - private function _set_config_class($config_class = '', $name = '') |
|
| 719 | - { |
|
| 720 | - return ! empty($config_class) |
|
| 721 | - ? $config_class |
|
| 722 | - : str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))) . '_Config'; |
|
| 723 | - } |
|
| 724 | - |
|
| 725 | - |
|
| 726 | - /** |
|
| 727 | - * set_config |
|
| 728 | - * |
|
| 729 | - * @access protected |
|
| 730 | - * @param string $section |
|
| 731 | - * @param string $name |
|
| 732 | - * @param string $config_class |
|
| 733 | - * @param EE_Config_Base $config_obj |
|
| 734 | - * @return EE_Config_Base |
|
| 735 | - */ |
|
| 736 | - public function set_config($section = '', $name = '', $config_class = '', EE_Config_Base $config_obj = null) |
|
| 737 | - { |
|
| 738 | - // ensure config class is set to something |
|
| 739 | - $config_class = $this->_set_config_class($config_class, $name); |
|
| 740 | - // run tests 1-4, 6, and 7 to verify all config params are set and valid |
|
| 741 | - if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) { |
|
| 742 | - return null; |
|
| 743 | - } |
|
| 744 | - $config_option_name = $this->_generate_config_option_name($section, $name); |
|
| 745 | - // if the config option name hasn't been added yet to the list of option names we're tracking, then do so now |
|
| 746 | - if (! isset($this->_addon_option_names[ $config_option_name ])) { |
|
| 747 | - $this->_addon_option_names[ $config_option_name ] = $config_class; |
|
| 748 | - $this->update_addon_option_names(); |
|
| 749 | - } |
|
| 750 | - // verify the incoming config object but suppress errors |
|
| 751 | - if (! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) { |
|
| 752 | - $config_obj = new $config_class(); |
|
| 753 | - } |
|
| 754 | - if (get_option($config_option_name)) { |
|
| 755 | - EE_Config::log($config_option_name); |
|
| 756 | - update_option($config_option_name, $config_obj); |
|
| 757 | - $this->{$section}->{$name} = $config_obj; |
|
| 758 | - return $this->{$section}->{$name}; |
|
| 759 | - } else { |
|
| 760 | - // create a wp-option for this config |
|
| 761 | - if (add_option($config_option_name, $config_obj, '', 'no')) { |
|
| 762 | - $this->{$section}->{$name} = maybe_unserialize($config_obj); |
|
| 763 | - return $this->{$section}->{$name}; |
|
| 764 | - } else { |
|
| 765 | - EE_Error::add_error( |
|
| 766 | - sprintf(__('The "%s" could not be saved to the database.', 'event_espresso'), $config_class), |
|
| 767 | - __FILE__, |
|
| 768 | - __FUNCTION__, |
|
| 769 | - __LINE__ |
|
| 770 | - ); |
|
| 771 | - return null; |
|
| 772 | - } |
|
| 773 | - } |
|
| 774 | - } |
|
| 775 | - |
|
| 776 | - |
|
| 777 | - /** |
|
| 778 | - * update_config |
|
| 779 | - * Important: the config object must ALREADY be set, otherwise this will produce an error. |
|
| 780 | - * |
|
| 781 | - * @access public |
|
| 782 | - * @param string $section |
|
| 783 | - * @param string $name |
|
| 784 | - * @param EE_Config_Base|string $config_obj |
|
| 785 | - * @param bool $throw_errors |
|
| 786 | - * @return bool |
|
| 787 | - */ |
|
| 788 | - public function update_config($section = '', $name = '', $config_obj = '', $throw_errors = true) |
|
| 789 | - { |
|
| 790 | - // don't allow config updates during WP heartbeats |
|
| 791 | - if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') { |
|
| 792 | - return false; |
|
| 793 | - } |
|
| 794 | - $config_obj = maybe_unserialize($config_obj); |
|
| 795 | - // get class name of the incoming object |
|
| 796 | - $config_class = get_class($config_obj); |
|
| 797 | - // run tests 1-5 and 9 to verify config |
|
| 798 | - if (! $this->_verify_config_params( |
|
| 799 | - $section, |
|
| 800 | - $name, |
|
| 801 | - $config_class, |
|
| 802 | - $config_obj, |
|
| 803 | - array(1, 2, 3, 4, 7, 9) |
|
| 804 | - ) |
|
| 805 | - ) { |
|
| 806 | - return false; |
|
| 807 | - } |
|
| 808 | - $config_option_name = $this->_generate_config_option_name($section, $name); |
|
| 809 | - // check if config object has been added to db by seeing if config option name is in $this->_addon_option_names array |
|
| 810 | - if (! isset($this->_addon_option_names[ $config_option_name ])) { |
|
| 811 | - // save new config to db |
|
| 812 | - if ($this->set_config($section, $name, $config_class, $config_obj)) { |
|
| 813 | - return true; |
|
| 814 | - } |
|
| 815 | - } else { |
|
| 816 | - // first check if the record already exists |
|
| 817 | - $existing_config = get_option($config_option_name); |
|
| 818 | - $config_obj = serialize($config_obj); |
|
| 819 | - // just return if db record is already up to date (NOT type safe comparison) |
|
| 820 | - if ($existing_config == $config_obj) { |
|
| 821 | - $this->{$section}->{$name} = $config_obj; |
|
| 822 | - return true; |
|
| 823 | - } elseif (update_option($config_option_name, $config_obj)) { |
|
| 824 | - EE_Config::log($config_option_name); |
|
| 825 | - // update wp-option for this config class |
|
| 826 | - $this->{$section}->{$name} = $config_obj; |
|
| 827 | - return true; |
|
| 828 | - } elseif ($throw_errors) { |
|
| 829 | - EE_Error::add_error( |
|
| 830 | - sprintf( |
|
| 831 | - __( |
|
| 832 | - 'The "%1$s" object stored at"%2$s" was not successfully updated in the database.', |
|
| 833 | - 'event_espresso' |
|
| 834 | - ), |
|
| 835 | - $config_class, |
|
| 836 | - 'EE_Config->' . $section . '->' . $name |
|
| 837 | - ), |
|
| 838 | - __FILE__, |
|
| 839 | - __FUNCTION__, |
|
| 840 | - __LINE__ |
|
| 841 | - ); |
|
| 842 | - } |
|
| 843 | - } |
|
| 844 | - return false; |
|
| 845 | - } |
|
| 846 | - |
|
| 847 | - |
|
| 848 | - /** |
|
| 849 | - * get_config |
|
| 850 | - * |
|
| 851 | - * @access public |
|
| 852 | - * @param string $section |
|
| 853 | - * @param string $name |
|
| 854 | - * @param string $config_class |
|
| 855 | - * @return mixed EE_Config_Base | NULL |
|
| 856 | - */ |
|
| 857 | - public function get_config($section = '', $name = '', $config_class = '') |
|
| 858 | - { |
|
| 859 | - // ensure config class is set to something |
|
| 860 | - $config_class = $this->_set_config_class($config_class, $name); |
|
| 861 | - // run tests 1-4, 6 and 7 to verify that all params have been set |
|
| 862 | - if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) { |
|
| 863 | - return null; |
|
| 864 | - } |
|
| 865 | - // now test if the requested config object exists, but suppress errors |
|
| 866 | - if ($this->_verify_config_params($section, $name, $config_class, null, array(7, 8), false)) { |
|
| 867 | - // config already exists, so pass it back |
|
| 868 | - return $this->{$section}->{$name}; |
|
| 869 | - } |
|
| 870 | - // load config option from db if it exists |
|
| 871 | - $config_obj = $this->get_config_option($this->_generate_config_option_name($section, $name)); |
|
| 872 | - // verify the newly retrieved config object, but suppress errors |
|
| 873 | - if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) { |
|
| 874 | - // config is good, so set it and pass it back |
|
| 875 | - $this->{$section}->{$name} = $config_obj; |
|
| 876 | - return $this->{$section}->{$name}; |
|
| 877 | - } |
|
| 878 | - // oops! $config_obj is not already set and does not exist in the db, so create a new one |
|
| 879 | - $config_obj = $this->set_config($section, $name, $config_class); |
|
| 880 | - // verify the newly created config object |
|
| 881 | - if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9))) { |
|
| 882 | - return $this->{$section}->{$name}; |
|
| 883 | - } else { |
|
| 884 | - EE_Error::add_error( |
|
| 885 | - sprintf(__('The "%s" could not be retrieved from the database.', 'event_espresso'), $config_class), |
|
| 886 | - __FILE__, |
|
| 887 | - __FUNCTION__, |
|
| 888 | - __LINE__ |
|
| 889 | - ); |
|
| 890 | - } |
|
| 891 | - return null; |
|
| 892 | - } |
|
| 893 | - |
|
| 894 | - |
|
| 895 | - /** |
|
| 896 | - * get_config_option |
|
| 897 | - * |
|
| 898 | - * @access public |
|
| 899 | - * @param string $config_option_name |
|
| 900 | - * @return mixed EE_Config_Base | FALSE |
|
| 901 | - */ |
|
| 902 | - public function get_config_option($config_option_name = '') |
|
| 903 | - { |
|
| 904 | - // retrieve the wp-option for this config class. |
|
| 905 | - $config_option = maybe_unserialize(get_option($config_option_name, array())); |
|
| 906 | - if (empty($config_option)) { |
|
| 907 | - EE_Config::log($config_option_name . '-NOT-FOUND'); |
|
| 908 | - } |
|
| 909 | - return $config_option; |
|
| 910 | - } |
|
| 911 | - |
|
| 912 | - |
|
| 913 | - /** |
|
| 914 | - * log |
|
| 915 | - * |
|
| 916 | - * @param string $config_option_name |
|
| 917 | - */ |
|
| 918 | - public static function log($config_option_name = '') |
|
| 919 | - { |
|
| 920 | - if (EE_Config::logging_enabled() && ! empty($config_option_name)) { |
|
| 921 | - $config_log = get_option(EE_Config::LOG_NAME, array()); |
|
| 922 | - // copy incoming $_REQUEST and sanitize it so we can save it |
|
| 923 | - $_request = $_REQUEST; |
|
| 924 | - array_walk_recursive($_request, 'sanitize_text_field'); |
|
| 925 | - $config_log[ (string) microtime(true) ] = array( |
|
| 926 | - 'config_name' => $config_option_name, |
|
| 927 | - 'request' => $_request, |
|
| 928 | - ); |
|
| 929 | - update_option(EE_Config::LOG_NAME, $config_log); |
|
| 930 | - } |
|
| 931 | - } |
|
| 932 | - |
|
| 933 | - |
|
| 934 | - /** |
|
| 935 | - * trim_log |
|
| 936 | - * reduces the size of the config log to the length specified by EE_Config::LOG_LENGTH |
|
| 937 | - */ |
|
| 938 | - public static function trim_log() |
|
| 939 | - { |
|
| 940 | - if (! EE_Config::logging_enabled()) { |
|
| 941 | - return; |
|
| 942 | - } |
|
| 943 | - $config_log = maybe_unserialize(get_option(EE_Config::LOG_NAME, array())); |
|
| 944 | - $log_length = count($config_log); |
|
| 945 | - if ($log_length > EE_Config::LOG_LENGTH) { |
|
| 946 | - ksort($config_log); |
|
| 947 | - $config_log = array_slice($config_log, $log_length - EE_Config::LOG_LENGTH, null, true); |
|
| 948 | - update_option(EE_Config::LOG_NAME, $config_log); |
|
| 949 | - } |
|
| 950 | - } |
|
| 951 | - |
|
| 952 | - |
|
| 953 | - /** |
|
| 954 | - * get_page_for_posts |
|
| 955 | - * if the wp-option "show_on_front" is set to "page", then this is the post_name for the post set in the |
|
| 956 | - * wp-option "page_for_posts", or "posts" if no page is selected |
|
| 957 | - * |
|
| 958 | - * @access public |
|
| 959 | - * @return string |
|
| 960 | - */ |
|
| 961 | - public static function get_page_for_posts() |
|
| 962 | - { |
|
| 963 | - $page_for_posts = get_option('page_for_posts'); |
|
| 964 | - if (! $page_for_posts) { |
|
| 965 | - return 'posts'; |
|
| 966 | - } |
|
| 967 | - /** @type WPDB $wpdb */ |
|
| 968 | - global $wpdb; |
|
| 969 | - $SQL = "SELECT post_name from $wpdb->posts WHERE post_type='posts' OR post_type='page' AND post_status='publish' AND ID=%d"; |
|
| 970 | - return $wpdb->get_var($wpdb->prepare($SQL, $page_for_posts)); |
|
| 971 | - } |
|
| 972 | - |
|
| 973 | - |
|
| 974 | - /** |
|
| 975 | - * register_shortcodes_and_modules. |
|
| 976 | - * At this point, it's too early to tell if we're maintenance mode or not. |
|
| 977 | - * In fact, this is where we give modules a chance to let core know they exist |
|
| 978 | - * so they can help trigger maintenance mode if it's needed |
|
| 979 | - * |
|
| 980 | - * @access public |
|
| 981 | - * @return void |
|
| 982 | - */ |
|
| 983 | - public function register_shortcodes_and_modules() |
|
| 984 | - { |
|
| 985 | - // allow modules to set hooks for the rest of the system |
|
| 986 | - EE_Registry::instance()->modules = $this->_register_modules(); |
|
| 987 | - } |
|
| 988 | - |
|
| 989 | - |
|
| 990 | - /** |
|
| 991 | - * initialize_shortcodes_and_modules |
|
| 992 | - * meaning they can start adding their hooks to get stuff done |
|
| 993 | - * |
|
| 994 | - * @access public |
|
| 995 | - * @return void |
|
| 996 | - */ |
|
| 997 | - public function initialize_shortcodes_and_modules() |
|
| 998 | - { |
|
| 999 | - // allow modules to set hooks for the rest of the system |
|
| 1000 | - $this->_initialize_modules(); |
|
| 1001 | - } |
|
| 1002 | - |
|
| 1003 | - |
|
| 1004 | - /** |
|
| 1005 | - * widgets_init |
|
| 1006 | - * |
|
| 1007 | - * @access private |
|
| 1008 | - * @return void |
|
| 1009 | - */ |
|
| 1010 | - public function widgets_init() |
|
| 1011 | - { |
|
| 1012 | - // only init widgets on admin pages when not in complete maintenance, and |
|
| 1013 | - // on frontend when not in any maintenance mode |
|
| 1014 | - if (! EE_Maintenance_Mode::instance()->level() |
|
| 1015 | - || ( |
|
| 1016 | - is_admin() |
|
| 1017 | - && EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance |
|
| 1018 | - ) |
|
| 1019 | - ) { |
|
| 1020 | - // grab list of installed widgets |
|
| 1021 | - $widgets_to_register = glob(EE_WIDGETS . '*', GLOB_ONLYDIR); |
|
| 1022 | - // filter list of modules to register |
|
| 1023 | - $widgets_to_register = apply_filters( |
|
| 1024 | - 'FHEE__EE_Config__register_widgets__widgets_to_register', |
|
| 1025 | - $widgets_to_register |
|
| 1026 | - ); |
|
| 1027 | - if (! empty($widgets_to_register)) { |
|
| 1028 | - // cycle thru widget folders |
|
| 1029 | - foreach ($widgets_to_register as $widget_path) { |
|
| 1030 | - // add to list of installed widget modules |
|
| 1031 | - EE_Config::register_ee_widget($widget_path); |
|
| 1032 | - } |
|
| 1033 | - } |
|
| 1034 | - // filter list of installed modules |
|
| 1035 | - EE_Registry::instance()->widgets = apply_filters( |
|
| 1036 | - 'FHEE__EE_Config__register_widgets__installed_widgets', |
|
| 1037 | - EE_Registry::instance()->widgets |
|
| 1038 | - ); |
|
| 1039 | - } |
|
| 1040 | - } |
|
| 1041 | - |
|
| 1042 | - |
|
| 1043 | - /** |
|
| 1044 | - * register_ee_widget - makes core aware of this widget |
|
| 1045 | - * |
|
| 1046 | - * @access public |
|
| 1047 | - * @param string $widget_path - full path up to and including widget folder |
|
| 1048 | - * @return void |
|
| 1049 | - */ |
|
| 1050 | - public static function register_ee_widget($widget_path = null) |
|
| 1051 | - { |
|
| 1052 | - do_action('AHEE__EE_Config__register_widget__begin', $widget_path); |
|
| 1053 | - $widget_ext = '.widget.php'; |
|
| 1054 | - // make all separators match |
|
| 1055 | - $widget_path = rtrim(str_replace('\\', DS, $widget_path), DS); |
|
| 1056 | - // does the file path INCLUDE the actual file name as part of the path ? |
|
| 1057 | - if (strpos($widget_path, $widget_ext) !== false) { |
|
| 1058 | - // grab and shortcode file name from directory name and break apart at dots |
|
| 1059 | - $file_name = explode('.', basename($widget_path)); |
|
| 1060 | - // take first segment from file name pieces and remove class prefix if it exists |
|
| 1061 | - $widget = strpos($file_name[0], 'EEW_') === 0 ? substr($file_name[0], 4) : $file_name[0]; |
|
| 1062 | - // sanitize shortcode directory name |
|
| 1063 | - $widget = sanitize_key($widget); |
|
| 1064 | - // now we need to rebuild the shortcode path |
|
| 1065 | - $widget_path = explode(DS, $widget_path); |
|
| 1066 | - // remove last segment |
|
| 1067 | - array_pop($widget_path); |
|
| 1068 | - // glue it back together |
|
| 1069 | - $widget_path = implode(DS, $widget_path); |
|
| 1070 | - } else { |
|
| 1071 | - // grab and sanitize widget directory name |
|
| 1072 | - $widget = sanitize_key(basename($widget_path)); |
|
| 1073 | - } |
|
| 1074 | - // create classname from widget directory name |
|
| 1075 | - $widget = str_replace(' ', '_', ucwords(str_replace('_', ' ', $widget))); |
|
| 1076 | - // add class prefix |
|
| 1077 | - $widget_class = 'EEW_' . $widget; |
|
| 1078 | - // does the widget exist ? |
|
| 1079 | - if (! is_readable($widget_path . DS . $widget_class . $widget_ext)) { |
|
| 1080 | - $msg = sprintf( |
|
| 1081 | - __( |
|
| 1082 | - 'The requested %s widget file could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s', |
|
| 1083 | - 'event_espresso' |
|
| 1084 | - ), |
|
| 1085 | - $widget_class, |
|
| 1086 | - $widget_path . DS . $widget_class . $widget_ext |
|
| 1087 | - ); |
|
| 1088 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1089 | - return; |
|
| 1090 | - } |
|
| 1091 | - // load the widget class file |
|
| 1092 | - require_once($widget_path . DS . $widget_class . $widget_ext); |
|
| 1093 | - // verify that class exists |
|
| 1094 | - if (! class_exists($widget_class)) { |
|
| 1095 | - $msg = sprintf(__('The requested %s widget class does not exist.', 'event_espresso'), $widget_class); |
|
| 1096 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1097 | - return; |
|
| 1098 | - } |
|
| 1099 | - register_widget($widget_class); |
|
| 1100 | - // add to array of registered widgets |
|
| 1101 | - EE_Registry::instance()->widgets->{$widget_class} = $widget_path . DS . $widget_class . $widget_ext; |
|
| 1102 | - } |
|
| 1103 | - |
|
| 1104 | - |
|
| 1105 | - /** |
|
| 1106 | - * _register_modules |
|
| 1107 | - * |
|
| 1108 | - * @access private |
|
| 1109 | - * @return array |
|
| 1110 | - */ |
|
| 1111 | - private function _register_modules() |
|
| 1112 | - { |
|
| 1113 | - // grab list of installed modules |
|
| 1114 | - $modules_to_register = glob(EE_MODULES . '*', GLOB_ONLYDIR); |
|
| 1115 | - // filter list of modules to register |
|
| 1116 | - $modules_to_register = apply_filters( |
|
| 1117 | - 'FHEE__EE_Config__register_modules__modules_to_register', |
|
| 1118 | - $modules_to_register |
|
| 1119 | - ); |
|
| 1120 | - if (! empty($modules_to_register)) { |
|
| 1121 | - // loop through folders |
|
| 1122 | - foreach ($modules_to_register as $module_path) { |
|
| 1123 | - /**TEMPORARILY EXCLUDE gateways from modules for time being**/ |
|
| 1124 | - if ($module_path !== EE_MODULES . 'zzz-copy-this-module-template' |
|
| 1125 | - && $module_path !== EE_MODULES . 'gateways' |
|
| 1126 | - ) { |
|
| 1127 | - // add to list of installed modules |
|
| 1128 | - EE_Config::register_module($module_path); |
|
| 1129 | - } |
|
| 1130 | - } |
|
| 1131 | - } |
|
| 1132 | - // filter list of installed modules |
|
| 1133 | - return apply_filters( |
|
| 1134 | - 'FHEE__EE_Config___register_modules__installed_modules', |
|
| 1135 | - EE_Registry::instance()->modules |
|
| 1136 | - ); |
|
| 1137 | - } |
|
| 1138 | - |
|
| 1139 | - |
|
| 1140 | - /** |
|
| 1141 | - * register_module - makes core aware of this module |
|
| 1142 | - * |
|
| 1143 | - * @access public |
|
| 1144 | - * @param string $module_path - full path up to and including module folder |
|
| 1145 | - * @return bool |
|
| 1146 | - */ |
|
| 1147 | - public static function register_module($module_path = null) |
|
| 1148 | - { |
|
| 1149 | - do_action('AHEE__EE_Config__register_module__begin', $module_path); |
|
| 1150 | - $module_ext = '.module.php'; |
|
| 1151 | - // make all separators match |
|
| 1152 | - $module_path = str_replace(array('\\', '/'), DS, $module_path); |
|
| 1153 | - // does the file path INCLUDE the actual file name as part of the path ? |
|
| 1154 | - if (strpos($module_path, $module_ext) !== false) { |
|
| 1155 | - // grab and shortcode file name from directory name and break apart at dots |
|
| 1156 | - $module_file = explode('.', basename($module_path)); |
|
| 1157 | - // now we need to rebuild the shortcode path |
|
| 1158 | - $module_path = explode(DS, $module_path); |
|
| 1159 | - // remove last segment |
|
| 1160 | - array_pop($module_path); |
|
| 1161 | - // glue it back together |
|
| 1162 | - $module_path = implode(DS, $module_path) . DS; |
|
| 1163 | - // take first segment from file name pieces and sanitize it |
|
| 1164 | - $module = preg_replace('/[^a-zA-Z0-9_\-]/', '', $module_file[0]); |
|
| 1165 | - // ensure class prefix is added |
|
| 1166 | - $module_class = strpos($module, 'EED_') !== 0 ? 'EED_' . $module : $module; |
|
| 1167 | - } else { |
|
| 1168 | - // we need to generate the filename based off of the folder name |
|
| 1169 | - // grab and sanitize module name |
|
| 1170 | - $module = strtolower(basename($module_path)); |
|
| 1171 | - $module = preg_replace('/[^a-z0-9_\-]/', '', $module); |
|
| 1172 | - // like trailingslashit() |
|
| 1173 | - $module_path = rtrim($module_path, DS) . DS; |
|
| 1174 | - // create classname from module directory name |
|
| 1175 | - $module = str_replace(' ', '_', ucwords(str_replace('_', ' ', $module))); |
|
| 1176 | - // add class prefix |
|
| 1177 | - $module_class = 'EED_' . $module; |
|
| 1178 | - } |
|
| 1179 | - // does the module exist ? |
|
| 1180 | - if (! is_readable($module_path . DS . $module_class . $module_ext)) { |
|
| 1181 | - $msg = sprintf( |
|
| 1182 | - __( |
|
| 1183 | - 'The requested %s module file could not be found or is not readable due to file permissions.', |
|
| 1184 | - 'event_espresso' |
|
| 1185 | - ), |
|
| 1186 | - $module |
|
| 1187 | - ); |
|
| 1188 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1189 | - return false; |
|
| 1190 | - } |
|
| 1191 | - // load the module class file |
|
| 1192 | - require_once($module_path . $module_class . $module_ext); |
|
| 1193 | - // verify that class exists |
|
| 1194 | - if (! class_exists($module_class)) { |
|
| 1195 | - $msg = sprintf(__('The requested %s module class does not exist.', 'event_espresso'), $module_class); |
|
| 1196 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1197 | - return false; |
|
| 1198 | - } |
|
| 1199 | - // add to array of registered modules |
|
| 1200 | - EE_Registry::instance()->modules->{$module_class} = $module_path . $module_class . $module_ext; |
|
| 1201 | - do_action( |
|
| 1202 | - 'AHEE__EE_Config__register_module__complete', |
|
| 1203 | - $module_class, |
|
| 1204 | - EE_Registry::instance()->modules->{$module_class} |
|
| 1205 | - ); |
|
| 1206 | - return true; |
|
| 1207 | - } |
|
| 1208 | - |
|
| 1209 | - |
|
| 1210 | - /** |
|
| 1211 | - * _initialize_modules |
|
| 1212 | - * allow modules to set hooks for the rest of the system |
|
| 1213 | - * |
|
| 1214 | - * @access private |
|
| 1215 | - * @return void |
|
| 1216 | - */ |
|
| 1217 | - private function _initialize_modules() |
|
| 1218 | - { |
|
| 1219 | - // cycle thru shortcode folders |
|
| 1220 | - foreach (EE_Registry::instance()->modules as $module_class => $module_path) { |
|
| 1221 | - // fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system |
|
| 1222 | - // which set hooks ? |
|
| 1223 | - if (is_admin()) { |
|
| 1224 | - // fire immediately |
|
| 1225 | - call_user_func(array($module_class, 'set_hooks_admin')); |
|
| 1226 | - } else { |
|
| 1227 | - // delay until other systems are online |
|
| 1228 | - add_action( |
|
| 1229 | - 'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons', |
|
| 1230 | - array($module_class, 'set_hooks') |
|
| 1231 | - ); |
|
| 1232 | - } |
|
| 1233 | - } |
|
| 1234 | - } |
|
| 1235 | - |
|
| 1236 | - |
|
| 1237 | - /** |
|
| 1238 | - * register_route - adds module method routes to route_map |
|
| 1239 | - * |
|
| 1240 | - * @access public |
|
| 1241 | - * @param string $route - "pretty" public alias for module method |
|
| 1242 | - * @param string $module - module name (classname without EED_ prefix) |
|
| 1243 | - * @param string $method_name - the actual module method to be routed to |
|
| 1244 | - * @param string $key - url param key indicating a route is being called |
|
| 1245 | - * @return bool |
|
| 1246 | - */ |
|
| 1247 | - public static function register_route($route = null, $module = null, $method_name = null, $key = 'ee') |
|
| 1248 | - { |
|
| 1249 | - do_action('AHEE__EE_Config__register_route__begin', $route, $module, $method_name); |
|
| 1250 | - $module = str_replace('EED_', '', $module); |
|
| 1251 | - $module_class = 'EED_' . $module; |
|
| 1252 | - if (! isset(EE_Registry::instance()->modules->{$module_class})) { |
|
| 1253 | - $msg = sprintf(__('The module %s has not been registered.', 'event_espresso'), $module); |
|
| 1254 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1255 | - return false; |
|
| 1256 | - } |
|
| 1257 | - if (empty($route)) { |
|
| 1258 | - $msg = sprintf(__('No route has been supplied.', 'event_espresso'), $route); |
|
| 1259 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1260 | - return false; |
|
| 1261 | - } |
|
| 1262 | - if (! method_exists('EED_' . $module, $method_name)) { |
|
| 1263 | - $msg = sprintf( |
|
| 1264 | - __('A valid class method for the %s route has not been supplied.', 'event_espresso'), |
|
| 1265 | - $route |
|
| 1266 | - ); |
|
| 1267 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1268 | - return false; |
|
| 1269 | - } |
|
| 1270 | - EE_Config::$_module_route_map[ (string) $key ][ (string) $route ] = array('EED_' . $module, $method_name); |
|
| 1271 | - return true; |
|
| 1272 | - } |
|
| 1273 | - |
|
| 1274 | - |
|
| 1275 | - /** |
|
| 1276 | - * get_route - get module method route |
|
| 1277 | - * |
|
| 1278 | - * @access public |
|
| 1279 | - * @param string $route - "pretty" public alias for module method |
|
| 1280 | - * @param string $key - url param key indicating a route is being called |
|
| 1281 | - * @return string |
|
| 1282 | - */ |
|
| 1283 | - public static function get_route($route = null, $key = 'ee') |
|
| 1284 | - { |
|
| 1285 | - do_action('AHEE__EE_Config__get_route__begin', $route); |
|
| 1286 | - $route = (string) apply_filters('FHEE__EE_Config__get_route', $route); |
|
| 1287 | - if (isset(EE_Config::$_module_route_map[ $key ][ $route ])) { |
|
| 1288 | - return EE_Config::$_module_route_map[ $key ][ $route ]; |
|
| 1289 | - } |
|
| 1290 | - return null; |
|
| 1291 | - } |
|
| 1292 | - |
|
| 1293 | - |
|
| 1294 | - /** |
|
| 1295 | - * get_routes - get ALL module method routes |
|
| 1296 | - * |
|
| 1297 | - * @access public |
|
| 1298 | - * @return array |
|
| 1299 | - */ |
|
| 1300 | - public static function get_routes() |
|
| 1301 | - { |
|
| 1302 | - return EE_Config::$_module_route_map; |
|
| 1303 | - } |
|
| 1304 | - |
|
| 1305 | - |
|
| 1306 | - /** |
|
| 1307 | - * register_forward - allows modules to forward request to another module for further processing |
|
| 1308 | - * |
|
| 1309 | - * @access public |
|
| 1310 | - * @param string $route - "pretty" public alias for module method |
|
| 1311 | - * @param integer $status - integer value corresponding to status constant strings set in module parent |
|
| 1312 | - * class, allows different forwards to be served based on status |
|
| 1313 | - * @param array|string $forward - function name or array( class, method ) |
|
| 1314 | - * @param string $key - url param key indicating a route is being called |
|
| 1315 | - * @return bool |
|
| 1316 | - */ |
|
| 1317 | - public static function register_forward($route = null, $status = 0, $forward = null, $key = 'ee') |
|
| 1318 | - { |
|
| 1319 | - do_action('AHEE__EE_Config__register_forward', $route, $status, $forward); |
|
| 1320 | - if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) { |
|
| 1321 | - $msg = sprintf( |
|
| 1322 | - __('The module route %s for this forward has not been registered.', 'event_espresso'), |
|
| 1323 | - $route |
|
| 1324 | - ); |
|
| 1325 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1326 | - return false; |
|
| 1327 | - } |
|
| 1328 | - if (empty($forward)) { |
|
| 1329 | - $msg = sprintf(__('No forwarding route has been supplied.', 'event_espresso'), $route); |
|
| 1330 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1331 | - return false; |
|
| 1332 | - } |
|
| 1333 | - if (is_array($forward)) { |
|
| 1334 | - if (! isset($forward[1])) { |
|
| 1335 | - $msg = sprintf( |
|
| 1336 | - __('A class method for the %s forwarding route has not been supplied.', 'event_espresso'), |
|
| 1337 | - $route |
|
| 1338 | - ); |
|
| 1339 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1340 | - return false; |
|
| 1341 | - } |
|
| 1342 | - if (! method_exists($forward[0], $forward[1])) { |
|
| 1343 | - $msg = sprintf( |
|
| 1344 | - __('The class method %s for the %s forwarding route is in invalid.', 'event_espresso'), |
|
| 1345 | - $forward[1], |
|
| 1346 | - $route |
|
| 1347 | - ); |
|
| 1348 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1349 | - return false; |
|
| 1350 | - } |
|
| 1351 | - } elseif (! function_exists($forward)) { |
|
| 1352 | - $msg = sprintf( |
|
| 1353 | - __('The function %s for the %s forwarding route is in invalid.', 'event_espresso'), |
|
| 1354 | - $forward, |
|
| 1355 | - $route |
|
| 1356 | - ); |
|
| 1357 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1358 | - return false; |
|
| 1359 | - } |
|
| 1360 | - EE_Config::$_module_forward_map[ $key ][ $route ][ absint($status) ] = $forward; |
|
| 1361 | - return true; |
|
| 1362 | - } |
|
| 1363 | - |
|
| 1364 | - |
|
| 1365 | - /** |
|
| 1366 | - * get_forward - get forwarding route |
|
| 1367 | - * |
|
| 1368 | - * @access public |
|
| 1369 | - * @param string $route - "pretty" public alias for module method |
|
| 1370 | - * @param integer $status - integer value corresponding to status constant strings set in module parent class, |
|
| 1371 | - * allows different forwards to be served based on status |
|
| 1372 | - * @param string $key - url param key indicating a route is being called |
|
| 1373 | - * @return string |
|
| 1374 | - */ |
|
| 1375 | - public static function get_forward($route = null, $status = 0, $key = 'ee') |
|
| 1376 | - { |
|
| 1377 | - do_action('AHEE__EE_Config__get_forward__begin', $route, $status); |
|
| 1378 | - if (isset(EE_Config::$_module_forward_map[ $key ][ $route ][ $status ])) { |
|
| 1379 | - return apply_filters( |
|
| 1380 | - 'FHEE__EE_Config__get_forward', |
|
| 1381 | - EE_Config::$_module_forward_map[ $key ][ $route ][ $status ], |
|
| 1382 | - $route, |
|
| 1383 | - $status |
|
| 1384 | - ); |
|
| 1385 | - } |
|
| 1386 | - return null; |
|
| 1387 | - } |
|
| 1388 | - |
|
| 1389 | - |
|
| 1390 | - /** |
|
| 1391 | - * register_forward - allows modules to specify different view templates for different method routes and status |
|
| 1392 | - * results |
|
| 1393 | - * |
|
| 1394 | - * @access public |
|
| 1395 | - * @param string $route - "pretty" public alias for module method |
|
| 1396 | - * @param integer $status - integer value corresponding to status constant strings set in module parent class, |
|
| 1397 | - * allows different views to be served based on status |
|
| 1398 | - * @param string $view |
|
| 1399 | - * @param string $key - url param key indicating a route is being called |
|
| 1400 | - * @return bool |
|
| 1401 | - */ |
|
| 1402 | - public static function register_view($route = null, $status = 0, $view = null, $key = 'ee') |
|
| 1403 | - { |
|
| 1404 | - do_action('AHEE__EE_Config__register_view__begin', $route, $status, $view); |
|
| 1405 | - if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) { |
|
| 1406 | - $msg = sprintf( |
|
| 1407 | - __('The module route %s for this view has not been registered.', 'event_espresso'), |
|
| 1408 | - $route |
|
| 1409 | - ); |
|
| 1410 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1411 | - return false; |
|
| 1412 | - } |
|
| 1413 | - if (! is_readable($view)) { |
|
| 1414 | - $msg = sprintf( |
|
| 1415 | - __( |
|
| 1416 | - 'The %s view file could not be found or is not readable due to file permissions.', |
|
| 1417 | - 'event_espresso' |
|
| 1418 | - ), |
|
| 1419 | - $view |
|
| 1420 | - ); |
|
| 1421 | - EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1422 | - return false; |
|
| 1423 | - } |
|
| 1424 | - EE_Config::$_module_view_map[ $key ][ $route ][ absint($status) ] = $view; |
|
| 1425 | - return true; |
|
| 1426 | - } |
|
| 1427 | - |
|
| 1428 | - |
|
| 1429 | - /** |
|
| 1430 | - * get_view - get view for route and status |
|
| 1431 | - * |
|
| 1432 | - * @access public |
|
| 1433 | - * @param string $route - "pretty" public alias for module method |
|
| 1434 | - * @param integer $status - integer value corresponding to status constant strings set in module parent class, |
|
| 1435 | - * allows different views to be served based on status |
|
| 1436 | - * @param string $key - url param key indicating a route is being called |
|
| 1437 | - * @return string |
|
| 1438 | - */ |
|
| 1439 | - public static function get_view($route = null, $status = 0, $key = 'ee') |
|
| 1440 | - { |
|
| 1441 | - do_action('AHEE__EE_Config__get_view__begin', $route, $status); |
|
| 1442 | - if (isset(EE_Config::$_module_view_map[ $key ][ $route ][ $status ])) { |
|
| 1443 | - return apply_filters( |
|
| 1444 | - 'FHEE__EE_Config__get_view', |
|
| 1445 | - EE_Config::$_module_view_map[ $key ][ $route ][ $status ], |
|
| 1446 | - $route, |
|
| 1447 | - $status |
|
| 1448 | - ); |
|
| 1449 | - } |
|
| 1450 | - return null; |
|
| 1451 | - } |
|
| 1452 | - |
|
| 1453 | - |
|
| 1454 | - public function update_addon_option_names() |
|
| 1455 | - { |
|
| 1456 | - update_option(EE_Config::ADDON_OPTION_NAMES, $this->_addon_option_names); |
|
| 1457 | - } |
|
| 1458 | - |
|
| 1459 | - |
|
| 1460 | - public function shutdown() |
|
| 1461 | - { |
|
| 1462 | - $this->update_addon_option_names(); |
|
| 1463 | - } |
|
| 1464 | - |
|
| 1465 | - |
|
| 1466 | - /** |
|
| 1467 | - * @return LegacyShortcodesManager |
|
| 1468 | - */ |
|
| 1469 | - public static function getLegacyShortcodesManager() |
|
| 1470 | - { |
|
| 1471 | - |
|
| 1472 | - if (! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) { |
|
| 1473 | - EE_Config::instance()->legacy_shortcodes_manager = new LegacyShortcodesManager( |
|
| 1474 | - EE_Registry::instance() |
|
| 1475 | - ); |
|
| 1476 | - } |
|
| 1477 | - return EE_Config::instance()->legacy_shortcodes_manager; |
|
| 1478 | - } |
|
| 1479 | - |
|
| 1480 | - |
|
| 1481 | - /** |
|
| 1482 | - * register_shortcode - makes core aware of this shortcode |
|
| 1483 | - * |
|
| 1484 | - * @deprecated 4.9.26 |
|
| 1485 | - * @param string $shortcode_path - full path up to and including shortcode folder |
|
| 1486 | - * @return bool |
|
| 1487 | - */ |
|
| 1488 | - public static function register_shortcode($shortcode_path = null) |
|
| 1489 | - { |
|
| 1490 | - EE_Error::doing_it_wrong( |
|
| 1491 | - __METHOD__, |
|
| 1492 | - __( |
|
| 1493 | - 'Usage is deprecated. Use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::registerShortcode() as direct replacement, or better yet, please see the new \EventEspresso\core\services\shortcodes\ShortcodesManager class.', |
|
| 1494 | - 'event_espresso' |
|
| 1495 | - ), |
|
| 1496 | - '4.9.26' |
|
| 1497 | - ); |
|
| 1498 | - return EE_Config::instance()->getLegacyShortcodesManager()->registerShortcode($shortcode_path); |
|
| 1499 | - } |
|
| 1500 | -} |
|
| 1501 | - |
|
| 1502 | -/** |
|
| 1503 | - * Base class used for config classes. These classes should generally not have |
|
| 1504 | - * magic functions in use, except we'll allow them to magically set and get stuff... |
|
| 1505 | - * basically, they should just be well-defined stdClasses |
|
| 1506 | - */ |
|
| 1507 | -class EE_Config_Base |
|
| 1508 | -{ |
|
| 1509 | - |
|
| 1510 | - /** |
|
| 1511 | - * Utility function for escaping the value of a property and returning. |
|
| 1512 | - * |
|
| 1513 | - * @param string $property property name (checks to see if exists). |
|
| 1514 | - * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned. |
|
| 1515 | - * @throws \EE_Error |
|
| 1516 | - */ |
|
| 1517 | - public function get_pretty($property) |
|
| 1518 | - { |
|
| 1519 | - if (! property_exists($this, $property)) { |
|
| 1520 | - throw new EE_Error( |
|
| 1521 | - sprintf( |
|
| 1522 | - __( |
|
| 1523 | - '%1$s::get_pretty() has been called with the property %2$s which does not exist on the %1$s config class.', |
|
| 1524 | - 'event_espresso' |
|
| 1525 | - ), |
|
| 1526 | - get_class($this), |
|
| 1527 | - $property |
|
| 1528 | - ) |
|
| 1529 | - ); |
|
| 1530 | - } |
|
| 1531 | - // just handling escaping of strings for now. |
|
| 1532 | - if (is_string($this->{$property})) { |
|
| 1533 | - return stripslashes($this->{$property}); |
|
| 1534 | - } |
|
| 1535 | - return $this->{$property}; |
|
| 1536 | - } |
|
| 1537 | - |
|
| 1538 | - |
|
| 1539 | - public function populate() |
|
| 1540 | - { |
|
| 1541 | - // grab defaults via a new instance of this class. |
|
| 1542 | - $class_name = get_class($this); |
|
| 1543 | - $defaults = new $class_name; |
|
| 1544 | - // loop through the properties for this class and see if they are set. If they are NOT, then grab the |
|
| 1545 | - // default from our $defaults object. |
|
| 1546 | - foreach (get_object_vars($defaults) as $property => $value) { |
|
| 1547 | - if ($this->{$property} === null) { |
|
| 1548 | - $this->{$property} = $value; |
|
| 1549 | - } |
|
| 1550 | - } |
|
| 1551 | - // cleanup |
|
| 1552 | - unset($defaults); |
|
| 1553 | - } |
|
| 1554 | - |
|
| 1555 | - |
|
| 1556 | - /** |
|
| 1557 | - * __isset |
|
| 1558 | - * |
|
| 1559 | - * @param $a |
|
| 1560 | - * @return bool |
|
| 1561 | - */ |
|
| 1562 | - public function __isset($a) |
|
| 1563 | - { |
|
| 1564 | - return false; |
|
| 1565 | - } |
|
| 1566 | - |
|
| 1567 | - |
|
| 1568 | - /** |
|
| 1569 | - * __unset |
|
| 1570 | - * |
|
| 1571 | - * @param $a |
|
| 1572 | - * @return bool |
|
| 1573 | - */ |
|
| 1574 | - public function __unset($a) |
|
| 1575 | - { |
|
| 1576 | - return false; |
|
| 1577 | - } |
|
| 1578 | - |
|
| 1579 | - |
|
| 1580 | - /** |
|
| 1581 | - * __clone |
|
| 1582 | - */ |
|
| 1583 | - public function __clone() |
|
| 1584 | - { |
|
| 1585 | - } |
|
| 1586 | - |
|
| 1587 | - |
|
| 1588 | - /** |
|
| 1589 | - * __wakeup |
|
| 1590 | - */ |
|
| 1591 | - public function __wakeup() |
|
| 1592 | - { |
|
| 1593 | - } |
|
| 1594 | - |
|
| 1595 | - |
|
| 1596 | - /** |
|
| 1597 | - * __destruct |
|
| 1598 | - */ |
|
| 1599 | - public function __destruct() |
|
| 1600 | - { |
|
| 1601 | - } |
|
| 1602 | -} |
|
| 1603 | - |
|
| 1604 | -/** |
|
| 1605 | - * Class for defining what's in the EE_Config relating to registration settings |
|
| 1606 | - */ |
|
| 1607 | -class EE_Core_Config extends EE_Config_Base |
|
| 1608 | -{ |
|
| 1609 | - |
|
| 1610 | - const OPTION_NAME_UXIP = 'ee_ueip_optin'; |
|
| 1611 | - |
|
| 1612 | - |
|
| 1613 | - public $current_blog_id; |
|
| 1614 | - |
|
| 1615 | - public $ee_ueip_optin; |
|
| 1616 | - |
|
| 1617 | - public $ee_ueip_has_notified; |
|
| 1618 | - |
|
| 1619 | - /** |
|
| 1620 | - * Not to be confused with the 4 critical page variables (See |
|
| 1621 | - * get_critical_pages_array()), this is just an array of wp posts that have EE |
|
| 1622 | - * shortcodes in them. Keys are slugs, values are arrays with only 1 element: where the key is the shortcode |
|
| 1623 | - * in the page, and the value is the page's ID. The key 'posts' is basically a duplicate of this same array. |
|
| 1624 | - * |
|
| 1625 | - * @var array |
|
| 1626 | - */ |
|
| 1627 | - public $post_shortcodes; |
|
| 1628 | - |
|
| 1629 | - public $module_route_map; |
|
| 1630 | - |
|
| 1631 | - public $module_forward_map; |
|
| 1632 | - |
|
| 1633 | - public $module_view_map; |
|
| 1634 | - |
|
| 1635 | - /** |
|
| 1636 | - * The next 4 vars are the IDs of critical EE pages. |
|
| 1637 | - * |
|
| 1638 | - * @var int |
|
| 1639 | - */ |
|
| 1640 | - public $reg_page_id; |
|
| 1641 | - |
|
| 1642 | - public $txn_page_id; |
|
| 1643 | - |
|
| 1644 | - public $thank_you_page_id; |
|
| 1645 | - |
|
| 1646 | - public $cancel_page_id; |
|
| 1647 | - |
|
| 1648 | - /** |
|
| 1649 | - * The next 4 vars are the URLs of critical EE pages. |
|
| 1650 | - * |
|
| 1651 | - * @var int |
|
| 1652 | - */ |
|
| 1653 | - public $reg_page_url; |
|
| 1654 | - |
|
| 1655 | - public $txn_page_url; |
|
| 1656 | - |
|
| 1657 | - public $thank_you_page_url; |
|
| 1658 | - |
|
| 1659 | - public $cancel_page_url; |
|
| 1660 | - |
|
| 1661 | - /** |
|
| 1662 | - * The next vars relate to the custom slugs for EE CPT routes |
|
| 1663 | - */ |
|
| 1664 | - public $event_cpt_slug; |
|
| 1665 | - |
|
| 1666 | - /** |
|
| 1667 | - * This caches the _ee_ueip_option in case this config is reset in the same |
|
| 1668 | - * request across blog switches in a multisite context. |
|
| 1669 | - * Avoids extra queries to the db for this option. |
|
| 1670 | - * |
|
| 1671 | - * @var bool |
|
| 1672 | - */ |
|
| 1673 | - public static $ee_ueip_option; |
|
| 1674 | - |
|
| 1675 | - |
|
| 1676 | - /** |
|
| 1677 | - * class constructor |
|
| 1678 | - * |
|
| 1679 | - * @access public |
|
| 1680 | - */ |
|
| 1681 | - public function __construct() |
|
| 1682 | - { |
|
| 1683 | - // set default organization settings |
|
| 1684 | - $this->current_blog_id = get_current_blog_id(); |
|
| 1685 | - $this->current_blog_id = $this->current_blog_id === null ? 1 : $this->current_blog_id; |
|
| 1686 | - $this->ee_ueip_optin = $this->_get_main_ee_ueip_optin(); |
|
| 1687 | - $this->ee_ueip_has_notified = is_main_site() ? get_option('ee_ueip_has_notified', false) : true; |
|
| 1688 | - $this->post_shortcodes = array(); |
|
| 1689 | - $this->module_route_map = array(); |
|
| 1690 | - $this->module_forward_map = array(); |
|
| 1691 | - $this->module_view_map = array(); |
|
| 1692 | - // critical EE page IDs |
|
| 1693 | - $this->reg_page_id = 0; |
|
| 1694 | - $this->txn_page_id = 0; |
|
| 1695 | - $this->thank_you_page_id = 0; |
|
| 1696 | - $this->cancel_page_id = 0; |
|
| 1697 | - // critical EE page URLs |
|
| 1698 | - $this->reg_page_url = ''; |
|
| 1699 | - $this->txn_page_url = ''; |
|
| 1700 | - $this->thank_you_page_url = ''; |
|
| 1701 | - $this->cancel_page_url = ''; |
|
| 1702 | - // cpt slugs |
|
| 1703 | - $this->event_cpt_slug = __('events', 'event_espresso'); |
|
| 1704 | - // ueip constant check |
|
| 1705 | - if (defined('EE_DISABLE_UXIP') && EE_DISABLE_UXIP) { |
|
| 1706 | - $this->ee_ueip_optin = false; |
|
| 1707 | - $this->ee_ueip_has_notified = true; |
|
| 1708 | - } |
|
| 1709 | - } |
|
| 1710 | - |
|
| 1711 | - |
|
| 1712 | - /** |
|
| 1713 | - * @return array |
|
| 1714 | - */ |
|
| 1715 | - public function get_critical_pages_array() |
|
| 1716 | - { |
|
| 1717 | - return array( |
|
| 1718 | - $this->reg_page_id, |
|
| 1719 | - $this->txn_page_id, |
|
| 1720 | - $this->thank_you_page_id, |
|
| 1721 | - $this->cancel_page_id, |
|
| 1722 | - ); |
|
| 1723 | - } |
|
| 1724 | - |
|
| 1725 | - |
|
| 1726 | - /** |
|
| 1727 | - * @return array |
|
| 1728 | - */ |
|
| 1729 | - public function get_critical_pages_shortcodes_array() |
|
| 1730 | - { |
|
| 1731 | - return array( |
|
| 1732 | - $this->reg_page_id => 'ESPRESSO_CHECKOUT', |
|
| 1733 | - $this->txn_page_id => 'ESPRESSO_TXN_PAGE', |
|
| 1734 | - $this->thank_you_page_id => 'ESPRESSO_THANK_YOU', |
|
| 1735 | - $this->cancel_page_id => 'ESPRESSO_CANCELLED', |
|
| 1736 | - ); |
|
| 1737 | - } |
|
| 1738 | - |
|
| 1739 | - |
|
| 1740 | - /** |
|
| 1741 | - * gets/returns URL for EE reg_page |
|
| 1742 | - * |
|
| 1743 | - * @access public |
|
| 1744 | - * @return string |
|
| 1745 | - */ |
|
| 1746 | - public function reg_page_url() |
|
| 1747 | - { |
|
| 1748 | - if (! $this->reg_page_url) { |
|
| 1749 | - $this->reg_page_url = add_query_arg( |
|
| 1750 | - array('uts' => time()), |
|
| 1751 | - get_permalink($this->reg_page_id) |
|
| 1752 | - ) . '#checkout'; |
|
| 1753 | - } |
|
| 1754 | - return $this->reg_page_url; |
|
| 1755 | - } |
|
| 1756 | - |
|
| 1757 | - |
|
| 1758 | - /** |
|
| 1759 | - * gets/returns URL for EE txn_page |
|
| 1760 | - * |
|
| 1761 | - * @param array $query_args like what gets passed to |
|
| 1762 | - * add_query_arg() as the first argument |
|
| 1763 | - * @access public |
|
| 1764 | - * @return string |
|
| 1765 | - */ |
|
| 1766 | - public function txn_page_url($query_args = array()) |
|
| 1767 | - { |
|
| 1768 | - if (! $this->txn_page_url) { |
|
| 1769 | - $this->txn_page_url = get_permalink($this->txn_page_id); |
|
| 1770 | - } |
|
| 1771 | - if ($query_args) { |
|
| 1772 | - return add_query_arg($query_args, $this->txn_page_url); |
|
| 1773 | - } else { |
|
| 1774 | - return $this->txn_page_url; |
|
| 1775 | - } |
|
| 1776 | - } |
|
| 1777 | - |
|
| 1778 | - |
|
| 1779 | - /** |
|
| 1780 | - * gets/returns URL for EE thank_you_page |
|
| 1781 | - * |
|
| 1782 | - * @param array $query_args like what gets passed to |
|
| 1783 | - * add_query_arg() as the first argument |
|
| 1784 | - * @access public |
|
| 1785 | - * @return string |
|
| 1786 | - */ |
|
| 1787 | - public function thank_you_page_url($query_args = array()) |
|
| 1788 | - { |
|
| 1789 | - if (! $this->thank_you_page_url) { |
|
| 1790 | - $this->thank_you_page_url = get_permalink($this->thank_you_page_id); |
|
| 1791 | - } |
|
| 1792 | - if ($query_args) { |
|
| 1793 | - return add_query_arg($query_args, $this->thank_you_page_url); |
|
| 1794 | - } else { |
|
| 1795 | - return $this->thank_you_page_url; |
|
| 1796 | - } |
|
| 1797 | - } |
|
| 1798 | - |
|
| 1799 | - |
|
| 1800 | - /** |
|
| 1801 | - * gets/returns URL for EE cancel_page |
|
| 1802 | - * |
|
| 1803 | - * @access public |
|
| 1804 | - * @return string |
|
| 1805 | - */ |
|
| 1806 | - public function cancel_page_url() |
|
| 1807 | - { |
|
| 1808 | - if (! $this->cancel_page_url) { |
|
| 1809 | - $this->cancel_page_url = get_permalink($this->cancel_page_id); |
|
| 1810 | - } |
|
| 1811 | - return $this->cancel_page_url; |
|
| 1812 | - } |
|
| 1813 | - |
|
| 1814 | - |
|
| 1815 | - /** |
|
| 1816 | - * Resets all critical page urls to their original state. Used primarily by the __sleep() magic method currently. |
|
| 1817 | - * |
|
| 1818 | - * @since 4.7.5 |
|
| 1819 | - */ |
|
| 1820 | - protected function _reset_urls() |
|
| 1821 | - { |
|
| 1822 | - $this->reg_page_url = ''; |
|
| 1823 | - $this->txn_page_url = ''; |
|
| 1824 | - $this->cancel_page_url = ''; |
|
| 1825 | - $this->thank_you_page_url = ''; |
|
| 1826 | - } |
|
| 1827 | - |
|
| 1828 | - |
|
| 1829 | - /** |
|
| 1830 | - * Used to return what the optin value is set for the EE User Experience Program. |
|
| 1831 | - * This accounts for multisite and this value being requested for a subsite. In multisite, the value is set |
|
| 1832 | - * on the main site only. |
|
| 1833 | - * |
|
| 1834 | - * @return bool |
|
| 1835 | - */ |
|
| 1836 | - protected function _get_main_ee_ueip_optin() |
|
| 1837 | - { |
|
| 1838 | - // if this is the main site then we can just bypass our direct query. |
|
| 1839 | - if (is_main_site()) { |
|
| 1840 | - return get_option(self::OPTION_NAME_UXIP, false); |
|
| 1841 | - } |
|
| 1842 | - // is this already cached for this request? If so use it. |
|
| 1843 | - if (EE_Core_Config::$ee_ueip_option !== null) { |
|
| 1844 | - return EE_Core_Config::$ee_ueip_option; |
|
| 1845 | - } |
|
| 1846 | - global $wpdb; |
|
| 1847 | - $current_network_main_site = is_multisite() ? get_current_site() : null; |
|
| 1848 | - $current_main_site_id = ! empty($current_network_main_site) ? $current_network_main_site->blog_id : 1; |
|
| 1849 | - $option = self::OPTION_NAME_UXIP; |
|
| 1850 | - // set correct table for query |
|
| 1851 | - $table_name = $wpdb->get_blog_prefix($current_main_site_id) . 'options'; |
|
| 1852 | - // rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because |
|
| 1853 | - // get_blog_option() does a switch_to_blog an that could cause infinite recursion because EE_Core_Config might be |
|
| 1854 | - // re-constructed on the blog switch. Note, we are still executing any core wp filters on this option retrieval. |
|
| 1855 | - // this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog |
|
| 1856 | - // for the purpose of caching. |
|
| 1857 | - $pre = apply_filters('pre_option_' . $option, false, $option); |
|
| 1858 | - if (false !== $pre) { |
|
| 1859 | - EE_Core_Config::$ee_ueip_option = $pre; |
|
| 1860 | - return EE_Core_Config::$ee_ueip_option; |
|
| 1861 | - } |
|
| 1862 | - $row = $wpdb->get_row( |
|
| 1863 | - $wpdb->prepare( |
|
| 1864 | - "SELECT option_value FROM $table_name WHERE option_name = %s LIMIT 1", |
|
| 1865 | - $option |
|
| 1866 | - ) |
|
| 1867 | - ); |
|
| 1868 | - if (is_object($row)) { |
|
| 1869 | - $value = $row->option_value; |
|
| 1870 | - } else { // option does not exist so use default. |
|
| 1871 | - EE_Core_Config::$ee_ueip_option = apply_filters('default_option_' . $option, false, $option); |
|
| 1872 | - return EE_Core_Config::$ee_ueip_option; |
|
| 1873 | - } |
|
| 1874 | - EE_Core_Config::$ee_ueip_option = apply_filters('option_' . $option, maybe_unserialize($value), $option); |
|
| 1875 | - return EE_Core_Config::$ee_ueip_option; |
|
| 1876 | - } |
|
| 1877 | - |
|
| 1878 | - |
|
| 1879 | - /** |
|
| 1880 | - * Utility function for escaping the value of a property and returning. |
|
| 1881 | - * |
|
| 1882 | - * @param string $property property name (checks to see if exists). |
|
| 1883 | - * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned. |
|
| 1884 | - * @throws \EE_Error |
|
| 1885 | - */ |
|
| 1886 | - public function get_pretty($property) |
|
| 1887 | - { |
|
| 1888 | - if ($property === self::OPTION_NAME_UXIP) { |
|
| 1889 | - return $this->ee_ueip_optin ? 'yes' : 'no'; |
|
| 1890 | - } |
|
| 1891 | - return parent::get_pretty($property); |
|
| 1892 | - } |
|
| 1893 | - |
|
| 1894 | - |
|
| 1895 | - /** |
|
| 1896 | - * Currently used to ensure critical page urls have initial values saved to the db instead of any current set values |
|
| 1897 | - * on the object. |
|
| 1898 | - * |
|
| 1899 | - * @return array |
|
| 1900 | - */ |
|
| 1901 | - public function __sleep() |
|
| 1902 | - { |
|
| 1903 | - // reset all url properties |
|
| 1904 | - $this->_reset_urls(); |
|
| 1905 | - // return what to save to db |
|
| 1906 | - return array_keys(get_object_vars($this)); |
|
| 1907 | - } |
|
| 1908 | -} |
|
| 1909 | - |
|
| 1910 | -/** |
|
| 1911 | - * Config class for storing info on the Organization |
|
| 1912 | - */ |
|
| 1913 | -class EE_Organization_Config extends EE_Config_Base |
|
| 1914 | -{ |
|
| 1915 | - |
|
| 1916 | - /** |
|
| 1917 | - * @var string $name |
|
| 1918 | - * eg EE4.1 |
|
| 1919 | - */ |
|
| 1920 | - public $name; |
|
| 1921 | - |
|
| 1922 | - /** |
|
| 1923 | - * @var string $address_1 |
|
| 1924 | - * eg 123 Onna Road |
|
| 1925 | - */ |
|
| 1926 | - public $address_1 = ''; |
|
| 1927 | - |
|
| 1928 | - /** |
|
| 1929 | - * @var string $address_2 |
|
| 1930 | - * eg PO Box 123 |
|
| 1931 | - */ |
|
| 1932 | - public $address_2 = ''; |
|
| 1933 | - |
|
| 1934 | - /** |
|
| 1935 | - * @var string $city |
|
| 1936 | - * eg Inna City |
|
| 1937 | - */ |
|
| 1938 | - public $city = ''; |
|
| 1939 | - |
|
| 1940 | - /** |
|
| 1941 | - * @var int $STA_ID |
|
| 1942 | - * eg 4 |
|
| 1943 | - */ |
|
| 1944 | - public $STA_ID = 0; |
|
| 1945 | - |
|
| 1946 | - /** |
|
| 1947 | - * @var string $CNT_ISO |
|
| 1948 | - * eg US |
|
| 1949 | - */ |
|
| 1950 | - public $CNT_ISO = ''; |
|
| 1951 | - |
|
| 1952 | - /** |
|
| 1953 | - * @var string $zip |
|
| 1954 | - * eg 12345 or V1A 2B3 |
|
| 1955 | - */ |
|
| 1956 | - public $zip = ''; |
|
| 1957 | - |
|
| 1958 | - /** |
|
| 1959 | - * @var string $email |
|
| 1960 | - * eg [email protected] |
|
| 1961 | - */ |
|
| 1962 | - public $email; |
|
| 1963 | - |
|
| 1964 | - /** |
|
| 1965 | - * @var string $phone |
|
| 1966 | - * eg. 111-111-1111 |
|
| 1967 | - */ |
|
| 1968 | - public $phone = ''; |
|
| 1969 | - |
|
| 1970 | - /** |
|
| 1971 | - * @var string $vat |
|
| 1972 | - * VAT/Tax Number |
|
| 1973 | - */ |
|
| 1974 | - public $vat = ''; |
|
| 1975 | - |
|
| 1976 | - /** |
|
| 1977 | - * @var string $logo_url |
|
| 1978 | - * eg http://www.somedomain.com/wp-content/uploads/kittehs.jpg |
|
| 1979 | - */ |
|
| 1980 | - public $logo_url = ''; |
|
| 1981 | - |
|
| 1982 | - /** |
|
| 1983 | - * The below are all various properties for holding links to organization social network profiles |
|
| 1984 | - * |
|
| 1985 | - * @var string |
|
| 1986 | - */ |
|
| 1987 | - /** |
|
| 1988 | - * facebook (facebook.com/profile.name) |
|
| 1989 | - * |
|
| 1990 | - * @var string |
|
| 1991 | - */ |
|
| 1992 | - public $facebook = ''; |
|
| 1993 | - |
|
| 1994 | - /** |
|
| 1995 | - * twitter (twitter.com/twitter_handle) |
|
| 1996 | - * |
|
| 1997 | - * @var string |
|
| 1998 | - */ |
|
| 1999 | - public $twitter = ''; |
|
| 2000 | - |
|
| 2001 | - /** |
|
| 2002 | - * linkedin (linkedin.com/in/profile_name) |
|
| 2003 | - * |
|
| 2004 | - * @var string |
|
| 2005 | - */ |
|
| 2006 | - public $linkedin = ''; |
|
| 2007 | - |
|
| 2008 | - /** |
|
| 2009 | - * pinterest (www.pinterest.com/profile_name) |
|
| 2010 | - * |
|
| 2011 | - * @var string |
|
| 2012 | - */ |
|
| 2013 | - public $pinterest = ''; |
|
| 2014 | - |
|
| 2015 | - /** |
|
| 2016 | - * google+ (google.com/+profileName) |
|
| 2017 | - * |
|
| 2018 | - * @var string |
|
| 2019 | - */ |
|
| 2020 | - public $google = ''; |
|
| 2021 | - |
|
| 2022 | - /** |
|
| 2023 | - * instagram (instagram.com/handle) |
|
| 2024 | - * |
|
| 2025 | - * @var string |
|
| 2026 | - */ |
|
| 2027 | - public $instagram = ''; |
|
| 2028 | - |
|
| 2029 | - |
|
| 2030 | - /** |
|
| 2031 | - * class constructor |
|
| 2032 | - * |
|
| 2033 | - * @access public |
|
| 2034 | - */ |
|
| 2035 | - public function __construct() |
|
| 2036 | - { |
|
| 2037 | - // set default organization settings |
|
| 2038 | - // decode HTML entities from the WP blogname, because it's stored in the DB with HTML entities encoded |
|
| 2039 | - $this->name = wp_specialchars_decode(get_bloginfo('name'), ENT_QUOTES); |
|
| 2040 | - $this->email = get_bloginfo('admin_email'); |
|
| 2041 | - } |
|
| 2042 | -} |
|
| 2043 | - |
|
| 2044 | -/** |
|
| 2045 | - * Class for defining what's in the EE_Config relating to currency |
|
| 2046 | - */ |
|
| 2047 | -class EE_Currency_Config extends EE_Config_Base |
|
| 2048 | -{ |
|
| 2049 | - |
|
| 2050 | - /** |
|
| 2051 | - * @var string $code |
|
| 2052 | - * eg 'US' |
|
| 2053 | - */ |
|
| 2054 | - public $code; |
|
| 2055 | - |
|
| 2056 | - /** |
|
| 2057 | - * @var string $name |
|
| 2058 | - * eg 'Dollar' |
|
| 2059 | - */ |
|
| 2060 | - public $name; |
|
| 2061 | - |
|
| 2062 | - /** |
|
| 2063 | - * plural name |
|
| 2064 | - * |
|
| 2065 | - * @var string $plural |
|
| 2066 | - * eg 'Dollars' |
|
| 2067 | - */ |
|
| 2068 | - public $plural; |
|
| 2069 | - |
|
| 2070 | - /** |
|
| 2071 | - * currency sign |
|
| 2072 | - * |
|
| 2073 | - * @var string $sign |
|
| 2074 | - * eg '$' |
|
| 2075 | - */ |
|
| 2076 | - public $sign; |
|
| 2077 | - |
|
| 2078 | - /** |
|
| 2079 | - * Whether the currency sign should come before the number or not |
|
| 2080 | - * |
|
| 2081 | - * @var boolean $sign_b4 |
|
| 2082 | - */ |
|
| 2083 | - public $sign_b4; |
|
| 2084 | - |
|
| 2085 | - /** |
|
| 2086 | - * How many digits should come after the decimal place |
|
| 2087 | - * |
|
| 2088 | - * @var int $dec_plc |
|
| 2089 | - */ |
|
| 2090 | - public $dec_plc; |
|
| 2091 | - |
|
| 2092 | - /** |
|
| 2093 | - * Symbol to use for decimal mark |
|
| 2094 | - * |
|
| 2095 | - * @var string $dec_mrk |
|
| 2096 | - * eg '.' |
|
| 2097 | - */ |
|
| 2098 | - public $dec_mrk; |
|
| 2099 | - |
|
| 2100 | - /** |
|
| 2101 | - * Symbol to use for thousands |
|
| 2102 | - * |
|
| 2103 | - * @var string $thsnds |
|
| 2104 | - * eg ',' |
|
| 2105 | - */ |
|
| 2106 | - public $thsnds; |
|
| 2107 | - |
|
| 2108 | - |
|
| 2109 | - /** |
|
| 2110 | - * class constructor |
|
| 2111 | - * |
|
| 2112 | - * @access public |
|
| 2113 | - * @param string $CNT_ISO |
|
| 2114 | - * @throws \EE_Error |
|
| 2115 | - */ |
|
| 2116 | - public function __construct($CNT_ISO = '') |
|
| 2117 | - { |
|
| 2118 | - /** @var \EventEspresso\core\services\database\TableAnalysis $table_analysis */ |
|
| 2119 | - $table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true); |
|
| 2120 | - // get country code from organization settings or use default |
|
| 2121 | - $ORG_CNT = isset(EE_Registry::instance()->CFG->organization) |
|
| 2122 | - && EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config |
|
| 2123 | - ? EE_Registry::instance()->CFG->organization->CNT_ISO |
|
| 2124 | - : ''; |
|
| 2125 | - // but override if requested |
|
| 2126 | - $CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : $ORG_CNT; |
|
| 2127 | - // so if that all went well, and we are not in M-Mode (cuz you can't query the db in M-Mode) and double-check the countries table exists |
|
| 2128 | - if (! empty($CNT_ISO) |
|
| 2129 | - && EE_Maintenance_Mode::instance()->models_can_query() |
|
| 2130 | - && $table_analysis->tableExists(EE_Registry::instance()->load_model('Country')->table()) |
|
| 2131 | - ) { |
|
| 2132 | - // retrieve the country settings from the db, just in case they have been customized |
|
| 2133 | - $country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($CNT_ISO); |
|
| 2134 | - if ($country instanceof EE_Country) { |
|
| 2135 | - $this->code = $country->currency_code(); // currency code: USD, CAD, EUR |
|
| 2136 | - $this->name = $country->currency_name_single(); // Dollar |
|
| 2137 | - $this->plural = $country->currency_name_plural(); // Dollars |
|
| 2138 | - $this->sign = $country->currency_sign(); // currency sign: $ |
|
| 2139 | - $this->sign_b4 = $country->currency_sign_before( |
|
| 2140 | - ); // currency sign before or after: $TRUE or FALSE$ |
|
| 2141 | - $this->dec_plc = $country->currency_decimal_places(); // decimal places: 2 = 0.00 3 = 0.000 |
|
| 2142 | - $this->dec_mrk = $country->currency_decimal_mark( |
|
| 2143 | - ); // decimal mark: (comma) ',' = 0,01 or (decimal) '.' = 0.01 |
|
| 2144 | - $this->thsnds = $country->currency_thousands_separator( |
|
| 2145 | - ); // thousands separator: (comma) ',' = 1,000 or (decimal) '.' = 1.000 |
|
| 2146 | - } |
|
| 2147 | - } |
|
| 2148 | - // fallback to hardcoded defaults, in case the above failed |
|
| 2149 | - if (empty($this->code)) { |
|
| 2150 | - // set default currency settings |
|
| 2151 | - $this->code = 'USD'; // currency code: USD, CAD, EUR |
|
| 2152 | - $this->name = __('Dollar', 'event_espresso'); // Dollar |
|
| 2153 | - $this->plural = __('Dollars', 'event_espresso'); // Dollars |
|
| 2154 | - $this->sign = '$'; // currency sign: $ |
|
| 2155 | - $this->sign_b4 = true; // currency sign before or after: $TRUE or FALSE$ |
|
| 2156 | - $this->dec_plc = 2; // decimal places: 2 = 0.00 3 = 0.000 |
|
| 2157 | - $this->dec_mrk = '.'; // decimal mark: (comma) ',' = 0,01 or (decimal) '.' = 0.01 |
|
| 2158 | - $this->thsnds = ','; // thousands separator: (comma) ',' = 1,000 or (decimal) '.' = 1.000 |
|
| 2159 | - } |
|
| 2160 | - } |
|
| 2161 | -} |
|
| 2162 | - |
|
| 2163 | -/** |
|
| 2164 | - * Class for defining what's in the EE_Config relating to registration settings |
|
| 2165 | - */ |
|
| 2166 | -class EE_Registration_Config extends EE_Config_Base |
|
| 2167 | -{ |
|
| 2168 | - |
|
| 2169 | - /** |
|
| 2170 | - * Default registration status |
|
| 2171 | - * |
|
| 2172 | - * @var string $default_STS_ID |
|
| 2173 | - * eg 'RPP' |
|
| 2174 | - */ |
|
| 2175 | - public $default_STS_ID; |
|
| 2176 | - |
|
| 2177 | - /** |
|
| 2178 | - * For new events, this will be the default value for the maximum number of tickets (equivalent to maximum number of |
|
| 2179 | - * registrations) |
|
| 2180 | - * |
|
| 2181 | - * @var int |
|
| 2182 | - */ |
|
| 2183 | - public $default_maximum_number_of_tickets; |
|
| 2184 | - |
|
| 2185 | - /** |
|
| 2186 | - * level of validation to apply to email addresses |
|
| 2187 | - * |
|
| 2188 | - * @var string $email_validation_level |
|
| 2189 | - * options: 'basic', 'wp_default', 'i18n', 'i18n_dns' |
|
| 2190 | - */ |
|
| 2191 | - public $email_validation_level; |
|
| 2192 | - |
|
| 2193 | - /** |
|
| 2194 | - * whether or not to show alternate payment options during the reg process if payment status is pending |
|
| 2195 | - * |
|
| 2196 | - * @var boolean $show_pending_payment_options |
|
| 2197 | - */ |
|
| 2198 | - public $show_pending_payment_options; |
|
| 2199 | - |
|
| 2200 | - /** |
|
| 2201 | - * Whether to skip the registration confirmation page |
|
| 2202 | - * |
|
| 2203 | - * @var boolean $skip_reg_confirmation |
|
| 2204 | - */ |
|
| 2205 | - public $skip_reg_confirmation; |
|
| 2206 | - |
|
| 2207 | - /** |
|
| 2208 | - * an array of SPCO reg steps where: |
|
| 2209 | - * the keys denotes the reg step order |
|
| 2210 | - * each element consists of an array with the following elements: |
|
| 2211 | - * "file_path" => the file path to the EE_SPCO_Reg_Step class |
|
| 2212 | - * "class_name" => the specific EE_SPCO_Reg_Step child class name |
|
| 2213 | - * "slug" => the URL param used to trigger the reg step |
|
| 2214 | - * |
|
| 2215 | - * @var array $reg_steps |
|
| 2216 | - */ |
|
| 2217 | - public $reg_steps; |
|
| 2218 | - |
|
| 2219 | - /** |
|
| 2220 | - * Whether registration confirmation should be the last page of SPCO |
|
| 2221 | - * |
|
| 2222 | - * @var boolean $reg_confirmation_last |
|
| 2223 | - */ |
|
| 2224 | - public $reg_confirmation_last; |
|
| 2225 | - |
|
| 2226 | - /** |
|
| 2227 | - * Whether or not to enable the EE Bot Trap |
|
| 2228 | - * |
|
| 2229 | - * @var boolean $use_bot_trap |
|
| 2230 | - */ |
|
| 2231 | - public $use_bot_trap; |
|
| 2232 | - |
|
| 2233 | - /** |
|
| 2234 | - * Whether or not to encrypt some data sent by the EE Bot Trap |
|
| 2235 | - * |
|
| 2236 | - * @var boolean $use_encryption |
|
| 2237 | - */ |
|
| 2238 | - public $use_encryption; |
|
| 2239 | - |
|
| 2240 | - /** |
|
| 2241 | - * Whether or not to use ReCaptcha |
|
| 2242 | - * |
|
| 2243 | - * @var boolean $use_captcha |
|
| 2244 | - */ |
|
| 2245 | - public $use_captcha; |
|
| 2246 | - |
|
| 2247 | - /** |
|
| 2248 | - * ReCaptcha Theme |
|
| 2249 | - * |
|
| 2250 | - * @var string $recaptcha_theme |
|
| 2251 | - * options: 'dark', 'light', 'invisible' |
|
| 2252 | - */ |
|
| 2253 | - public $recaptcha_theme; |
|
| 2254 | - |
|
| 2255 | - /** |
|
| 2256 | - * ReCaptcha Badge - determines the position of the reCAPTCHA badge if using Invisible ReCaptcha. |
|
| 2257 | - * |
|
| 2258 | - * @var string $recaptcha_badge |
|
| 2259 | - * options: 'bottomright', 'bottomleft', 'inline' |
|
| 2260 | - */ |
|
| 2261 | - public $recaptcha_badge; |
|
| 17 | + const OPTION_NAME = 'ee_config'; |
|
| 18 | + |
|
| 19 | + const LOG_NAME = 'ee_config_log'; |
|
| 20 | + |
|
| 21 | + const LOG_LENGTH = 100; |
|
| 22 | + |
|
| 23 | + const ADDON_OPTION_NAMES = 'ee_config_option_names'; |
|
| 24 | + |
|
| 25 | + /** |
|
| 26 | + * instance of the EE_Config object |
|
| 27 | + * |
|
| 28 | + * @var EE_Config $_instance |
|
| 29 | + * @access private |
|
| 30 | + */ |
|
| 31 | + private static $_instance; |
|
| 32 | + |
|
| 33 | + /** |
|
| 34 | + * @var boolean $_logging_enabled |
|
| 35 | + */ |
|
| 36 | + private static $_logging_enabled = false; |
|
| 37 | + |
|
| 38 | + /** |
|
| 39 | + * @var LegacyShortcodesManager $legacy_shortcodes_manager |
|
| 40 | + */ |
|
| 41 | + private $legacy_shortcodes_manager; |
|
| 42 | + |
|
| 43 | + /** |
|
| 44 | + * An StdClass whose property names are addon slugs, |
|
| 45 | + * and values are their config classes |
|
| 46 | + * |
|
| 47 | + * @var StdClass |
|
| 48 | + */ |
|
| 49 | + public $addons; |
|
| 50 | + |
|
| 51 | + /** |
|
| 52 | + * @var EE_Admin_Config |
|
| 53 | + */ |
|
| 54 | + public $admin; |
|
| 55 | + |
|
| 56 | + /** |
|
| 57 | + * @var EE_Core_Config |
|
| 58 | + */ |
|
| 59 | + public $core; |
|
| 60 | + |
|
| 61 | + /** |
|
| 62 | + * @var EE_Currency_Config |
|
| 63 | + */ |
|
| 64 | + public $currency; |
|
| 65 | + |
|
| 66 | + /** |
|
| 67 | + * @var EE_Organization_Config |
|
| 68 | + */ |
|
| 69 | + public $organization; |
|
| 70 | + |
|
| 71 | + /** |
|
| 72 | + * @var EE_Registration_Config |
|
| 73 | + */ |
|
| 74 | + public $registration; |
|
| 75 | + |
|
| 76 | + /** |
|
| 77 | + * @var EE_Template_Config |
|
| 78 | + */ |
|
| 79 | + public $template_settings; |
|
| 80 | + |
|
| 81 | + /** |
|
| 82 | + * Holds EE environment values. |
|
| 83 | + * |
|
| 84 | + * @var EE_Environment_Config |
|
| 85 | + */ |
|
| 86 | + public $environment; |
|
| 87 | + |
|
| 88 | + /** |
|
| 89 | + * settings pertaining to Google maps |
|
| 90 | + * |
|
| 91 | + * @var EE_Map_Config |
|
| 92 | + */ |
|
| 93 | + public $map_settings; |
|
| 94 | + |
|
| 95 | + /** |
|
| 96 | + * settings pertaining to Taxes |
|
| 97 | + * |
|
| 98 | + * @var EE_Tax_Config |
|
| 99 | + */ |
|
| 100 | + public $tax_settings; |
|
| 101 | + |
|
| 102 | + /** |
|
| 103 | + * Settings pertaining to global messages settings. |
|
| 104 | + * |
|
| 105 | + * @var EE_Messages_Config |
|
| 106 | + */ |
|
| 107 | + public $messages; |
|
| 108 | + |
|
| 109 | + /** |
|
| 110 | + * @deprecated |
|
| 111 | + * @var EE_Gateway_Config |
|
| 112 | + */ |
|
| 113 | + public $gateway; |
|
| 114 | + |
|
| 115 | + /** |
|
| 116 | + * @var array $_addon_option_names |
|
| 117 | + * @access private |
|
| 118 | + */ |
|
| 119 | + private $_addon_option_names = array(); |
|
| 120 | + |
|
| 121 | + /** |
|
| 122 | + * @var array $_module_route_map |
|
| 123 | + * @access private |
|
| 124 | + */ |
|
| 125 | + private static $_module_route_map = array(); |
|
| 126 | + |
|
| 127 | + /** |
|
| 128 | + * @var array $_module_forward_map |
|
| 129 | + * @access private |
|
| 130 | + */ |
|
| 131 | + private static $_module_forward_map = array(); |
|
| 132 | + |
|
| 133 | + /** |
|
| 134 | + * @var array $_module_view_map |
|
| 135 | + * @access private |
|
| 136 | + */ |
|
| 137 | + private static $_module_view_map = array(); |
|
| 138 | + |
|
| 139 | + |
|
| 140 | + /** |
|
| 141 | + * @singleton method used to instantiate class object |
|
| 142 | + * @access public |
|
| 143 | + * @return EE_Config instance |
|
| 144 | + */ |
|
| 145 | + public static function instance() |
|
| 146 | + { |
|
| 147 | + // check if class object is instantiated, and instantiated properly |
|
| 148 | + if (! self::$_instance instanceof EE_Config) { |
|
| 149 | + self::$_instance = new self(); |
|
| 150 | + } |
|
| 151 | + return self::$_instance; |
|
| 152 | + } |
|
| 153 | + |
|
| 154 | + |
|
| 155 | + /** |
|
| 156 | + * Resets the config |
|
| 157 | + * |
|
| 158 | + * @param bool $hard_reset if TRUE, sets EE_CONFig back to its original settings in the database. If FALSE |
|
| 159 | + * (default) leaves the database alone, and merely resets the EE_Config object to |
|
| 160 | + * reflect its state in the database |
|
| 161 | + * @param boolean $reinstantiate if TRUE (default) call instance() and return it. Otherwise, just leave |
|
| 162 | + * $_instance as NULL. Useful in case you want to forget about the old instance on |
|
| 163 | + * EE_Config, but might not be ready to instantiate EE_Config currently (eg if the |
|
| 164 | + * site was put into maintenance mode) |
|
| 165 | + * @return EE_Config |
|
| 166 | + */ |
|
| 167 | + public static function reset($hard_reset = false, $reinstantiate = true) |
|
| 168 | + { |
|
| 169 | + if (self::$_instance instanceof EE_Config) { |
|
| 170 | + if ($hard_reset) { |
|
| 171 | + self::$_instance->legacy_shortcodes_manager = null; |
|
| 172 | + self::$_instance->_addon_option_names = array(); |
|
| 173 | + self::$_instance->_initialize_config(); |
|
| 174 | + self::$_instance->update_espresso_config(); |
|
| 175 | + } |
|
| 176 | + self::$_instance->update_addon_option_names(); |
|
| 177 | + } |
|
| 178 | + self::$_instance = null; |
|
| 179 | + // we don't need to reset the static properties imo because those should |
|
| 180 | + // only change when a module is added or removed. Currently we don't |
|
| 181 | + // support removing a module during a request when it previously existed |
|
| 182 | + if ($reinstantiate) { |
|
| 183 | + return self::instance(); |
|
| 184 | + } else { |
|
| 185 | + return null; |
|
| 186 | + } |
|
| 187 | + } |
|
| 188 | + |
|
| 189 | + |
|
| 190 | + /** |
|
| 191 | + * class constructor |
|
| 192 | + * |
|
| 193 | + * @access private |
|
| 194 | + */ |
|
| 195 | + private function __construct() |
|
| 196 | + { |
|
| 197 | + do_action('AHEE__EE_Config__construct__begin', $this); |
|
| 198 | + EE_Config::$_logging_enabled = apply_filters('FHEE__EE_Config___construct__logging_enabled', false); |
|
| 199 | + // setup empty config classes |
|
| 200 | + $this->_initialize_config(); |
|
| 201 | + // load existing EE site settings |
|
| 202 | + $this->_load_core_config(); |
|
| 203 | + // confirm everything loaded correctly and set filtered defaults if not |
|
| 204 | + $this->_verify_config(); |
|
| 205 | + // register shortcodes and modules |
|
| 206 | + add_action( |
|
| 207 | + 'AHEE__EE_System__register_shortcodes_modules_and_widgets', |
|
| 208 | + array($this, 'register_shortcodes_and_modules'), |
|
| 209 | + 999 |
|
| 210 | + ); |
|
| 211 | + // initialize shortcodes and modules |
|
| 212 | + add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'initialize_shortcodes_and_modules')); |
|
| 213 | + // register widgets |
|
| 214 | + add_action('widgets_init', array($this, 'widgets_init'), 10); |
|
| 215 | + // shutdown |
|
| 216 | + add_action('shutdown', array($this, 'shutdown'), 10); |
|
| 217 | + // construct__end hook |
|
| 218 | + do_action('AHEE__EE_Config__construct__end', $this); |
|
| 219 | + // hardcoded hack |
|
| 220 | + $this->template_settings->current_espresso_theme = 'Espresso_Arabica_2014'; |
|
| 221 | + } |
|
| 222 | + |
|
| 223 | + |
|
| 224 | + /** |
|
| 225 | + * @return boolean |
|
| 226 | + */ |
|
| 227 | + public static function logging_enabled() |
|
| 228 | + { |
|
| 229 | + return self::$_logging_enabled; |
|
| 230 | + } |
|
| 231 | + |
|
| 232 | + |
|
| 233 | + /** |
|
| 234 | + * use to get the current theme if needed from static context |
|
| 235 | + * |
|
| 236 | + * @return string current theme set. |
|
| 237 | + */ |
|
| 238 | + public static function get_current_theme() |
|
| 239 | + { |
|
| 240 | + return isset(self::$_instance->template_settings->current_espresso_theme) |
|
| 241 | + ? self::$_instance->template_settings->current_espresso_theme : 'Espresso_Arabica_2014'; |
|
| 242 | + } |
|
| 243 | + |
|
| 244 | + |
|
| 245 | + /** |
|
| 246 | + * _initialize_config |
|
| 247 | + * |
|
| 248 | + * @access private |
|
| 249 | + * @return void |
|
| 250 | + */ |
|
| 251 | + private function _initialize_config() |
|
| 252 | + { |
|
| 253 | + EE_Config::trim_log(); |
|
| 254 | + // set defaults |
|
| 255 | + $this->_addon_option_names = get_option(EE_Config::ADDON_OPTION_NAMES, array()); |
|
| 256 | + $this->addons = new stdClass(); |
|
| 257 | + // set _module_route_map |
|
| 258 | + EE_Config::$_module_route_map = array(); |
|
| 259 | + // set _module_forward_map |
|
| 260 | + EE_Config::$_module_forward_map = array(); |
|
| 261 | + // set _module_view_map |
|
| 262 | + EE_Config::$_module_view_map = array(); |
|
| 263 | + } |
|
| 264 | + |
|
| 265 | + |
|
| 266 | + /** |
|
| 267 | + * load core plugin configuration |
|
| 268 | + * |
|
| 269 | + * @access private |
|
| 270 | + * @return void |
|
| 271 | + */ |
|
| 272 | + private function _load_core_config() |
|
| 273 | + { |
|
| 274 | + // load_core_config__start hook |
|
| 275 | + do_action('AHEE__EE_Config___load_core_config__start', $this); |
|
| 276 | + $espresso_config = $this->get_espresso_config(); |
|
| 277 | + foreach ($espresso_config as $config => $settings) { |
|
| 278 | + // load_core_config__start hook |
|
| 279 | + $settings = apply_filters( |
|
| 280 | + 'FHEE__EE_Config___load_core_config__config_settings', |
|
| 281 | + $settings, |
|
| 282 | + $config, |
|
| 283 | + $this |
|
| 284 | + ); |
|
| 285 | + if (is_object($settings) && property_exists($this, $config)) { |
|
| 286 | + $this->{$config} = apply_filters('FHEE__EE_Config___load_core_config__' . $config, $settings); |
|
| 287 | + // call configs populate method to ensure any defaults are set for empty values. |
|
| 288 | + if (method_exists($settings, 'populate')) { |
|
| 289 | + $this->{$config}->populate(); |
|
| 290 | + } |
|
| 291 | + if (method_exists($settings, 'do_hooks')) { |
|
| 292 | + $this->{$config}->do_hooks(); |
|
| 293 | + } |
|
| 294 | + } |
|
| 295 | + } |
|
| 296 | + if (apply_filters('FHEE__EE_Config___load_core_config__update_espresso_config', false)) { |
|
| 297 | + $this->update_espresso_config(); |
|
| 298 | + } |
|
| 299 | + // load_core_config__end hook |
|
| 300 | + do_action('AHEE__EE_Config___load_core_config__end', $this); |
|
| 301 | + } |
|
| 302 | + |
|
| 303 | + |
|
| 304 | + /** |
|
| 305 | + * _verify_config |
|
| 306 | + * |
|
| 307 | + * @access protected |
|
| 308 | + * @return void |
|
| 309 | + */ |
|
| 310 | + protected function _verify_config() |
|
| 311 | + { |
|
| 312 | + $this->core = $this->core instanceof EE_Core_Config |
|
| 313 | + ? $this->core |
|
| 314 | + : new EE_Core_Config(); |
|
| 315 | + $this->core = apply_filters('FHEE__EE_Config___initialize_config__core', $this->core); |
|
| 316 | + $this->organization = $this->organization instanceof EE_Organization_Config |
|
| 317 | + ? $this->organization |
|
| 318 | + : new EE_Organization_Config(); |
|
| 319 | + $this->organization = apply_filters( |
|
| 320 | + 'FHEE__EE_Config___initialize_config__organization', |
|
| 321 | + $this->organization |
|
| 322 | + ); |
|
| 323 | + $this->currency = $this->currency instanceof EE_Currency_Config |
|
| 324 | + ? $this->currency |
|
| 325 | + : new EE_Currency_Config(); |
|
| 326 | + $this->currency = apply_filters('FHEE__EE_Config___initialize_config__currency', $this->currency); |
|
| 327 | + $this->registration = $this->registration instanceof EE_Registration_Config |
|
| 328 | + ? $this->registration |
|
| 329 | + : new EE_Registration_Config(); |
|
| 330 | + $this->registration = apply_filters( |
|
| 331 | + 'FHEE__EE_Config___initialize_config__registration', |
|
| 332 | + $this->registration |
|
| 333 | + ); |
|
| 334 | + $this->admin = $this->admin instanceof EE_Admin_Config |
|
| 335 | + ? $this->admin |
|
| 336 | + : new EE_Admin_Config(); |
|
| 337 | + $this->admin = apply_filters('FHEE__EE_Config___initialize_config__admin', $this->admin); |
|
| 338 | + $this->template_settings = $this->template_settings instanceof EE_Template_Config |
|
| 339 | + ? $this->template_settings |
|
| 340 | + : new EE_Template_Config(); |
|
| 341 | + $this->template_settings = apply_filters( |
|
| 342 | + 'FHEE__EE_Config___initialize_config__template_settings', |
|
| 343 | + $this->template_settings |
|
| 344 | + ); |
|
| 345 | + $this->map_settings = $this->map_settings instanceof EE_Map_Config |
|
| 346 | + ? $this->map_settings |
|
| 347 | + : new EE_Map_Config(); |
|
| 348 | + $this->map_settings = apply_filters( |
|
| 349 | + 'FHEE__EE_Config___initialize_config__map_settings', |
|
| 350 | + $this->map_settings |
|
| 351 | + ); |
|
| 352 | + $this->environment = $this->environment instanceof EE_Environment_Config |
|
| 353 | + ? $this->environment |
|
| 354 | + : new EE_Environment_Config(); |
|
| 355 | + $this->environment = apply_filters( |
|
| 356 | + 'FHEE__EE_Config___initialize_config__environment', |
|
| 357 | + $this->environment |
|
| 358 | + ); |
|
| 359 | + $this->tax_settings = $this->tax_settings instanceof EE_Tax_Config |
|
| 360 | + ? $this->tax_settings |
|
| 361 | + : new EE_Tax_Config(); |
|
| 362 | + $this->tax_settings = apply_filters( |
|
| 363 | + 'FHEE__EE_Config___initialize_config__tax_settings', |
|
| 364 | + $this->tax_settings |
|
| 365 | + ); |
|
| 366 | + $this->messages = apply_filters('FHEE__EE_Config__initialize_config__messages', $this->messages); |
|
| 367 | + $this->messages = $this->messages instanceof EE_Messages_Config |
|
| 368 | + ? $this->messages |
|
| 369 | + : new EE_Messages_Config(); |
|
| 370 | + $this->gateway = $this->gateway instanceof EE_Gateway_Config |
|
| 371 | + ? $this->gateway |
|
| 372 | + : new EE_Gateway_Config(); |
|
| 373 | + $this->gateway = apply_filters('FHEE__EE_Config___initialize_config__gateway', $this->gateway); |
|
| 374 | + $this->legacy_shortcodes_manager = null; |
|
| 375 | + } |
|
| 376 | + |
|
| 377 | + |
|
| 378 | + /** |
|
| 379 | + * get_espresso_config |
|
| 380 | + * |
|
| 381 | + * @access public |
|
| 382 | + * @return array of espresso config stuff |
|
| 383 | + */ |
|
| 384 | + public function get_espresso_config() |
|
| 385 | + { |
|
| 386 | + // grab espresso configuration |
|
| 387 | + return apply_filters( |
|
| 388 | + 'FHEE__EE_Config__get_espresso_config__CFG', |
|
| 389 | + get_option(EE_Config::OPTION_NAME, array()) |
|
| 390 | + ); |
|
| 391 | + } |
|
| 392 | + |
|
| 393 | + |
|
| 394 | + /** |
|
| 395 | + * double_check_config_comparison |
|
| 396 | + * |
|
| 397 | + * @access public |
|
| 398 | + * @param string $option |
|
| 399 | + * @param $old_value |
|
| 400 | + * @param $value |
|
| 401 | + */ |
|
| 402 | + public function double_check_config_comparison($option = '', $old_value, $value) |
|
| 403 | + { |
|
| 404 | + // make sure we're checking the ee config |
|
| 405 | + if ($option === EE_Config::OPTION_NAME) { |
|
| 406 | + // run a loose comparison of the old value against the new value for type and properties, |
|
| 407 | + // but NOT exact instance like WP update_option does (ie: NOT type safe comparison) |
|
| 408 | + if ($value != $old_value) { |
|
| 409 | + // if they are NOT the same, then remove the hook, |
|
| 410 | + // which means the subsequent update results will be based solely on the update query results |
|
| 411 | + // the reason we do this is because, as stated above, |
|
| 412 | + // WP update_option performs an exact instance comparison (===) on any update values passed to it |
|
| 413 | + // this happens PRIOR to serialization and any subsequent update. |
|
| 414 | + // If values are found to match their previous old value, |
|
| 415 | + // then WP bails before performing any update. |
|
| 416 | + // Since we are passing the EE_Config object, it is comparing the EXACT instance of the saved version |
|
| 417 | + // it just pulled from the db, with the one being passed to it (which will not match). |
|
| 418 | + // HOWEVER, once the object is serialized and passed off to MySQL to update, |
|
| 419 | + // MySQL MAY ALSO NOT perform the update because |
|
| 420 | + // the string it sees in the db looks the same as the new one it has been passed!!! |
|
| 421 | + // This results in the query returning an "affected rows" value of ZERO, |
|
| 422 | + // which gets returned immediately by WP update_option and looks like an error. |
|
| 423 | + remove_action('update_option', array($this, 'check_config_updated')); |
|
| 424 | + } |
|
| 425 | + } |
|
| 426 | + } |
|
| 427 | + |
|
| 428 | + |
|
| 429 | + /** |
|
| 430 | + * update_espresso_config |
|
| 431 | + * |
|
| 432 | + * @access public |
|
| 433 | + */ |
|
| 434 | + protected function _reset_espresso_addon_config() |
|
| 435 | + { |
|
| 436 | + $this->_addon_option_names = array(); |
|
| 437 | + foreach ($this->addons as $addon_name => $addon_config_obj) { |
|
| 438 | + $addon_config_obj = maybe_unserialize($addon_config_obj); |
|
| 439 | + if ($addon_config_obj instanceof EE_Config_Base) { |
|
| 440 | + $this->update_config('addons', $addon_name, $addon_config_obj, false); |
|
| 441 | + } |
|
| 442 | + $this->addons->{$addon_name} = null; |
|
| 443 | + } |
|
| 444 | + } |
|
| 445 | + |
|
| 446 | + |
|
| 447 | + /** |
|
| 448 | + * update_espresso_config |
|
| 449 | + * |
|
| 450 | + * @access public |
|
| 451 | + * @param bool $add_success |
|
| 452 | + * @param bool $add_error |
|
| 453 | + * @return bool |
|
| 454 | + */ |
|
| 455 | + public function update_espresso_config($add_success = false, $add_error = true) |
|
| 456 | + { |
|
| 457 | + // don't allow config updates during WP heartbeats |
|
| 458 | + if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') { |
|
| 459 | + return false; |
|
| 460 | + } |
|
| 461 | + // commented out the following re: https://events.codebasehq.com/projects/event-espresso/tickets/8197 |
|
| 462 | + // $clone = clone( self::$_instance ); |
|
| 463 | + // self::$_instance = NULL; |
|
| 464 | + do_action('AHEE__EE_Config__update_espresso_config__begin', $this); |
|
| 465 | + $this->_reset_espresso_addon_config(); |
|
| 466 | + // hook into update_option because that happens AFTER the ( $value === $old_value ) conditional |
|
| 467 | + // but BEFORE the actual update occurs |
|
| 468 | + add_action('update_option', array($this, 'double_check_config_comparison'), 1, 3); |
|
| 469 | + // don't want to persist legacy_shortcodes_manager, but don't want to lose it either |
|
| 470 | + $legacy_shortcodes_manager = $this->legacy_shortcodes_manager; |
|
| 471 | + $this->legacy_shortcodes_manager = null; |
|
| 472 | + // now update "ee_config" |
|
| 473 | + $saved = update_option(EE_Config::OPTION_NAME, $this); |
|
| 474 | + $this->legacy_shortcodes_manager = $legacy_shortcodes_manager; |
|
| 475 | + EE_Config::log(EE_Config::OPTION_NAME); |
|
| 476 | + // if not saved... check if the hook we just added still exists; |
|
| 477 | + // if it does, it means one of two things: |
|
| 478 | + // that update_option bailed at the($value === $old_value) conditional, |
|
| 479 | + // or... |
|
| 480 | + // the db update query returned 0 rows affected |
|
| 481 | + // (probably because the data value was the same from it's perspective) |
|
| 482 | + // so the existence of the hook means that a negative result from update_option is NOT an error, |
|
| 483 | + // but just means no update occurred, so don't display an error to the user. |
|
| 484 | + // BUT... if update_option returns FALSE, AND the hook is missing, |
|
| 485 | + // then it means that something truly went wrong |
|
| 486 | + $saved = ! $saved ? has_action('update_option', array($this, 'double_check_config_comparison')) : $saved; |
|
| 487 | + // remove our action since we don't want it in the system anymore |
|
| 488 | + remove_action('update_option', array($this, 'double_check_config_comparison'), 1); |
|
| 489 | + do_action('AHEE__EE_Config__update_espresso_config__end', $this, $saved); |
|
| 490 | + // self::$_instance = $clone; |
|
| 491 | + // unset( $clone ); |
|
| 492 | + // if config remains the same or was updated successfully |
|
| 493 | + if ($saved) { |
|
| 494 | + if ($add_success) { |
|
| 495 | + EE_Error::add_success( |
|
| 496 | + __('The Event Espresso Configuration Settings have been successfully updated.', 'event_espresso'), |
|
| 497 | + __FILE__, |
|
| 498 | + __FUNCTION__, |
|
| 499 | + __LINE__ |
|
| 500 | + ); |
|
| 501 | + } |
|
| 502 | + return true; |
|
| 503 | + } else { |
|
| 504 | + if ($add_error) { |
|
| 505 | + EE_Error::add_error( |
|
| 506 | + __('The Event Espresso Configuration Settings were not updated.', 'event_espresso'), |
|
| 507 | + __FILE__, |
|
| 508 | + __FUNCTION__, |
|
| 509 | + __LINE__ |
|
| 510 | + ); |
|
| 511 | + } |
|
| 512 | + return false; |
|
| 513 | + } |
|
| 514 | + } |
|
| 515 | + |
|
| 516 | + |
|
| 517 | + /** |
|
| 518 | + * _verify_config_params |
|
| 519 | + * |
|
| 520 | + * @access private |
|
| 521 | + * @param string $section |
|
| 522 | + * @param string $name |
|
| 523 | + * @param string $config_class |
|
| 524 | + * @param EE_Config_Base $config_obj |
|
| 525 | + * @param array $tests_to_run |
|
| 526 | + * @param bool $display_errors |
|
| 527 | + * @return bool TRUE on success, FALSE on fail |
|
| 528 | + */ |
|
| 529 | + private function _verify_config_params( |
|
| 530 | + $section = '', |
|
| 531 | + $name = '', |
|
| 532 | + $config_class = '', |
|
| 533 | + $config_obj = null, |
|
| 534 | + $tests_to_run = array(1, 2, 3, 4, 5, 6, 7, 8), |
|
| 535 | + $display_errors = true |
|
| 536 | + ) { |
|
| 537 | + try { |
|
| 538 | + foreach ($tests_to_run as $test) { |
|
| 539 | + switch ($test) { |
|
| 540 | + // TEST #1 : check that section was set |
|
| 541 | + case 1: |
|
| 542 | + if (empty($section)) { |
|
| 543 | + if ($display_errors) { |
|
| 544 | + throw new EE_Error( |
|
| 545 | + sprintf( |
|
| 546 | + __( |
|
| 547 | + 'No configuration section has been provided while attempting to save "%s".', |
|
| 548 | + 'event_espresso' |
|
| 549 | + ), |
|
| 550 | + $config_class |
|
| 551 | + ) |
|
| 552 | + ); |
|
| 553 | + } |
|
| 554 | + return false; |
|
| 555 | + } |
|
| 556 | + break; |
|
| 557 | + // TEST #2 : check that settings section exists |
|
| 558 | + case 2: |
|
| 559 | + if (! isset($this->{$section})) { |
|
| 560 | + if ($display_errors) { |
|
| 561 | + throw new EE_Error( |
|
| 562 | + sprintf( |
|
| 563 | + __('The "%s" configuration section does not exist.', 'event_espresso'), |
|
| 564 | + $section |
|
| 565 | + ) |
|
| 566 | + ); |
|
| 567 | + } |
|
| 568 | + return false; |
|
| 569 | + } |
|
| 570 | + break; |
|
| 571 | + // TEST #3 : check that section is the proper format |
|
| 572 | + case 3: |
|
| 573 | + if (! ($this->{$section} instanceof EE_Config_Base || $this->{$section} instanceof stdClass) |
|
| 574 | + ) { |
|
| 575 | + if ($display_errors) { |
|
| 576 | + throw new EE_Error( |
|
| 577 | + sprintf( |
|
| 578 | + __( |
|
| 579 | + 'The "%s" configuration settings have not been formatted correctly.', |
|
| 580 | + 'event_espresso' |
|
| 581 | + ), |
|
| 582 | + $section |
|
| 583 | + ) |
|
| 584 | + ); |
|
| 585 | + } |
|
| 586 | + return false; |
|
| 587 | + } |
|
| 588 | + break; |
|
| 589 | + // TEST #4 : check that config section name has been set |
|
| 590 | + case 4: |
|
| 591 | + if (empty($name)) { |
|
| 592 | + if ($display_errors) { |
|
| 593 | + throw new EE_Error( |
|
| 594 | + __( |
|
| 595 | + 'No name has been provided for the specific configuration section.', |
|
| 596 | + 'event_espresso' |
|
| 597 | + ) |
|
| 598 | + ); |
|
| 599 | + } |
|
| 600 | + return false; |
|
| 601 | + } |
|
| 602 | + break; |
|
| 603 | + // TEST #5 : check that a config class name has been set |
|
| 604 | + case 5: |
|
| 605 | + if (empty($config_class)) { |
|
| 606 | + if ($display_errors) { |
|
| 607 | + throw new EE_Error( |
|
| 608 | + __( |
|
| 609 | + 'No class name has been provided for the specific configuration section.', |
|
| 610 | + 'event_espresso' |
|
| 611 | + ) |
|
| 612 | + ); |
|
| 613 | + } |
|
| 614 | + return false; |
|
| 615 | + } |
|
| 616 | + break; |
|
| 617 | + // TEST #6 : verify config class is accessible |
|
| 618 | + case 6: |
|
| 619 | + if (! class_exists($config_class)) { |
|
| 620 | + if ($display_errors) { |
|
| 621 | + throw new EE_Error( |
|
| 622 | + sprintf( |
|
| 623 | + __( |
|
| 624 | + 'The "%s" class does not exist. Please ensure that an autoloader has been set for it.', |
|
| 625 | + 'event_espresso' |
|
| 626 | + ), |
|
| 627 | + $config_class |
|
| 628 | + ) |
|
| 629 | + ); |
|
| 630 | + } |
|
| 631 | + return false; |
|
| 632 | + } |
|
| 633 | + break; |
|
| 634 | + // TEST #7 : check that config has even been set |
|
| 635 | + case 7: |
|
| 636 | + if (! isset($this->{$section}->{$name})) { |
|
| 637 | + if ($display_errors) { |
|
| 638 | + throw new EE_Error( |
|
| 639 | + sprintf( |
|
| 640 | + __('No configuration has been set for "%1$s->%2$s".', 'event_espresso'), |
|
| 641 | + $section, |
|
| 642 | + $name |
|
| 643 | + ) |
|
| 644 | + ); |
|
| 645 | + } |
|
| 646 | + return false; |
|
| 647 | + } else { |
|
| 648 | + // and make sure it's not serialized |
|
| 649 | + $this->{$section}->{$name} = maybe_unserialize($this->{$section}->{$name}); |
|
| 650 | + } |
|
| 651 | + break; |
|
| 652 | + // TEST #8 : check that config is the requested type |
|
| 653 | + case 8: |
|
| 654 | + if (! $this->{$section}->{$name} instanceof $config_class) { |
|
| 655 | + if ($display_errors) { |
|
| 656 | + throw new EE_Error( |
|
| 657 | + sprintf( |
|
| 658 | + __( |
|
| 659 | + 'The configuration for "%1$s->%2$s" is not of the "%3$s" class.', |
|
| 660 | + 'event_espresso' |
|
| 661 | + ), |
|
| 662 | + $section, |
|
| 663 | + $name, |
|
| 664 | + $config_class |
|
| 665 | + ) |
|
| 666 | + ); |
|
| 667 | + } |
|
| 668 | + return false; |
|
| 669 | + } |
|
| 670 | + break; |
|
| 671 | + // TEST #9 : verify config object |
|
| 672 | + case 9: |
|
| 673 | + if (! $config_obj instanceof EE_Config_Base) { |
|
| 674 | + if ($display_errors) { |
|
| 675 | + throw new EE_Error( |
|
| 676 | + sprintf( |
|
| 677 | + __('The "%s" class is not an instance of EE_Config_Base.', 'event_espresso'), |
|
| 678 | + print_r($config_obj, true) |
|
| 679 | + ) |
|
| 680 | + ); |
|
| 681 | + } |
|
| 682 | + return false; |
|
| 683 | + } |
|
| 684 | + break; |
|
| 685 | + } |
|
| 686 | + } |
|
| 687 | + } catch (EE_Error $e) { |
|
| 688 | + $e->get_error(); |
|
| 689 | + } |
|
| 690 | + // you have successfully run the gauntlet |
|
| 691 | + return true; |
|
| 692 | + } |
|
| 693 | + |
|
| 694 | + |
|
| 695 | + /** |
|
| 696 | + * _generate_config_option_name |
|
| 697 | + * |
|
| 698 | + * @access protected |
|
| 699 | + * @param string $section |
|
| 700 | + * @param string $name |
|
| 701 | + * @return string |
|
| 702 | + */ |
|
| 703 | + private function _generate_config_option_name($section = '', $name = '') |
|
| 704 | + { |
|
| 705 | + return 'ee_config-' . strtolower($section . '-' . str_replace(array('EE_', 'EED_'), '', $name)); |
|
| 706 | + } |
|
| 707 | + |
|
| 708 | + |
|
| 709 | + /** |
|
| 710 | + * _set_config_class |
|
| 711 | + * ensures that a config class is set, either from a passed config class or one generated from the config name |
|
| 712 | + * |
|
| 713 | + * @access private |
|
| 714 | + * @param string $config_class |
|
| 715 | + * @param string $name |
|
| 716 | + * @return string |
|
| 717 | + */ |
|
| 718 | + private function _set_config_class($config_class = '', $name = '') |
|
| 719 | + { |
|
| 720 | + return ! empty($config_class) |
|
| 721 | + ? $config_class |
|
| 722 | + : str_replace(' ', '_', ucwords(str_replace('_', ' ', $name))) . '_Config'; |
|
| 723 | + } |
|
| 724 | + |
|
| 725 | + |
|
| 726 | + /** |
|
| 727 | + * set_config |
|
| 728 | + * |
|
| 729 | + * @access protected |
|
| 730 | + * @param string $section |
|
| 731 | + * @param string $name |
|
| 732 | + * @param string $config_class |
|
| 733 | + * @param EE_Config_Base $config_obj |
|
| 734 | + * @return EE_Config_Base |
|
| 735 | + */ |
|
| 736 | + public function set_config($section = '', $name = '', $config_class = '', EE_Config_Base $config_obj = null) |
|
| 737 | + { |
|
| 738 | + // ensure config class is set to something |
|
| 739 | + $config_class = $this->_set_config_class($config_class, $name); |
|
| 740 | + // run tests 1-4, 6, and 7 to verify all config params are set and valid |
|
| 741 | + if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) { |
|
| 742 | + return null; |
|
| 743 | + } |
|
| 744 | + $config_option_name = $this->_generate_config_option_name($section, $name); |
|
| 745 | + // if the config option name hasn't been added yet to the list of option names we're tracking, then do so now |
|
| 746 | + if (! isset($this->_addon_option_names[ $config_option_name ])) { |
|
| 747 | + $this->_addon_option_names[ $config_option_name ] = $config_class; |
|
| 748 | + $this->update_addon_option_names(); |
|
| 749 | + } |
|
| 750 | + // verify the incoming config object but suppress errors |
|
| 751 | + if (! $this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) { |
|
| 752 | + $config_obj = new $config_class(); |
|
| 753 | + } |
|
| 754 | + if (get_option($config_option_name)) { |
|
| 755 | + EE_Config::log($config_option_name); |
|
| 756 | + update_option($config_option_name, $config_obj); |
|
| 757 | + $this->{$section}->{$name} = $config_obj; |
|
| 758 | + return $this->{$section}->{$name}; |
|
| 759 | + } else { |
|
| 760 | + // create a wp-option for this config |
|
| 761 | + if (add_option($config_option_name, $config_obj, '', 'no')) { |
|
| 762 | + $this->{$section}->{$name} = maybe_unserialize($config_obj); |
|
| 763 | + return $this->{$section}->{$name}; |
|
| 764 | + } else { |
|
| 765 | + EE_Error::add_error( |
|
| 766 | + sprintf(__('The "%s" could not be saved to the database.', 'event_espresso'), $config_class), |
|
| 767 | + __FILE__, |
|
| 768 | + __FUNCTION__, |
|
| 769 | + __LINE__ |
|
| 770 | + ); |
|
| 771 | + return null; |
|
| 772 | + } |
|
| 773 | + } |
|
| 774 | + } |
|
| 775 | + |
|
| 776 | + |
|
| 777 | + /** |
|
| 778 | + * update_config |
|
| 779 | + * Important: the config object must ALREADY be set, otherwise this will produce an error. |
|
| 780 | + * |
|
| 781 | + * @access public |
|
| 782 | + * @param string $section |
|
| 783 | + * @param string $name |
|
| 784 | + * @param EE_Config_Base|string $config_obj |
|
| 785 | + * @param bool $throw_errors |
|
| 786 | + * @return bool |
|
| 787 | + */ |
|
| 788 | + public function update_config($section = '', $name = '', $config_obj = '', $throw_errors = true) |
|
| 789 | + { |
|
| 790 | + // don't allow config updates during WP heartbeats |
|
| 791 | + if (\EE_Registry::instance()->REQ->get('action', '') === 'heartbeat') { |
|
| 792 | + return false; |
|
| 793 | + } |
|
| 794 | + $config_obj = maybe_unserialize($config_obj); |
|
| 795 | + // get class name of the incoming object |
|
| 796 | + $config_class = get_class($config_obj); |
|
| 797 | + // run tests 1-5 and 9 to verify config |
|
| 798 | + if (! $this->_verify_config_params( |
|
| 799 | + $section, |
|
| 800 | + $name, |
|
| 801 | + $config_class, |
|
| 802 | + $config_obj, |
|
| 803 | + array(1, 2, 3, 4, 7, 9) |
|
| 804 | + ) |
|
| 805 | + ) { |
|
| 806 | + return false; |
|
| 807 | + } |
|
| 808 | + $config_option_name = $this->_generate_config_option_name($section, $name); |
|
| 809 | + // check if config object has been added to db by seeing if config option name is in $this->_addon_option_names array |
|
| 810 | + if (! isset($this->_addon_option_names[ $config_option_name ])) { |
|
| 811 | + // save new config to db |
|
| 812 | + if ($this->set_config($section, $name, $config_class, $config_obj)) { |
|
| 813 | + return true; |
|
| 814 | + } |
|
| 815 | + } else { |
|
| 816 | + // first check if the record already exists |
|
| 817 | + $existing_config = get_option($config_option_name); |
|
| 818 | + $config_obj = serialize($config_obj); |
|
| 819 | + // just return if db record is already up to date (NOT type safe comparison) |
|
| 820 | + if ($existing_config == $config_obj) { |
|
| 821 | + $this->{$section}->{$name} = $config_obj; |
|
| 822 | + return true; |
|
| 823 | + } elseif (update_option($config_option_name, $config_obj)) { |
|
| 824 | + EE_Config::log($config_option_name); |
|
| 825 | + // update wp-option for this config class |
|
| 826 | + $this->{$section}->{$name} = $config_obj; |
|
| 827 | + return true; |
|
| 828 | + } elseif ($throw_errors) { |
|
| 829 | + EE_Error::add_error( |
|
| 830 | + sprintf( |
|
| 831 | + __( |
|
| 832 | + 'The "%1$s" object stored at"%2$s" was not successfully updated in the database.', |
|
| 833 | + 'event_espresso' |
|
| 834 | + ), |
|
| 835 | + $config_class, |
|
| 836 | + 'EE_Config->' . $section . '->' . $name |
|
| 837 | + ), |
|
| 838 | + __FILE__, |
|
| 839 | + __FUNCTION__, |
|
| 840 | + __LINE__ |
|
| 841 | + ); |
|
| 842 | + } |
|
| 843 | + } |
|
| 844 | + return false; |
|
| 845 | + } |
|
| 846 | + |
|
| 847 | + |
|
| 848 | + /** |
|
| 849 | + * get_config |
|
| 850 | + * |
|
| 851 | + * @access public |
|
| 852 | + * @param string $section |
|
| 853 | + * @param string $name |
|
| 854 | + * @param string $config_class |
|
| 855 | + * @return mixed EE_Config_Base | NULL |
|
| 856 | + */ |
|
| 857 | + public function get_config($section = '', $name = '', $config_class = '') |
|
| 858 | + { |
|
| 859 | + // ensure config class is set to something |
|
| 860 | + $config_class = $this->_set_config_class($config_class, $name); |
|
| 861 | + // run tests 1-4, 6 and 7 to verify that all params have been set |
|
| 862 | + if (! $this->_verify_config_params($section, $name, $config_class, null, array(1, 2, 3, 4, 5, 6))) { |
|
| 863 | + return null; |
|
| 864 | + } |
|
| 865 | + // now test if the requested config object exists, but suppress errors |
|
| 866 | + if ($this->_verify_config_params($section, $name, $config_class, null, array(7, 8), false)) { |
|
| 867 | + // config already exists, so pass it back |
|
| 868 | + return $this->{$section}->{$name}; |
|
| 869 | + } |
|
| 870 | + // load config option from db if it exists |
|
| 871 | + $config_obj = $this->get_config_option($this->_generate_config_option_name($section, $name)); |
|
| 872 | + // verify the newly retrieved config object, but suppress errors |
|
| 873 | + if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9), false)) { |
|
| 874 | + // config is good, so set it and pass it back |
|
| 875 | + $this->{$section}->{$name} = $config_obj; |
|
| 876 | + return $this->{$section}->{$name}; |
|
| 877 | + } |
|
| 878 | + // oops! $config_obj is not already set and does not exist in the db, so create a new one |
|
| 879 | + $config_obj = $this->set_config($section, $name, $config_class); |
|
| 880 | + // verify the newly created config object |
|
| 881 | + if ($this->_verify_config_params($section, $name, $config_class, $config_obj, array(9))) { |
|
| 882 | + return $this->{$section}->{$name}; |
|
| 883 | + } else { |
|
| 884 | + EE_Error::add_error( |
|
| 885 | + sprintf(__('The "%s" could not be retrieved from the database.', 'event_espresso'), $config_class), |
|
| 886 | + __FILE__, |
|
| 887 | + __FUNCTION__, |
|
| 888 | + __LINE__ |
|
| 889 | + ); |
|
| 890 | + } |
|
| 891 | + return null; |
|
| 892 | + } |
|
| 893 | + |
|
| 894 | + |
|
| 895 | + /** |
|
| 896 | + * get_config_option |
|
| 897 | + * |
|
| 898 | + * @access public |
|
| 899 | + * @param string $config_option_name |
|
| 900 | + * @return mixed EE_Config_Base | FALSE |
|
| 901 | + */ |
|
| 902 | + public function get_config_option($config_option_name = '') |
|
| 903 | + { |
|
| 904 | + // retrieve the wp-option for this config class. |
|
| 905 | + $config_option = maybe_unserialize(get_option($config_option_name, array())); |
|
| 906 | + if (empty($config_option)) { |
|
| 907 | + EE_Config::log($config_option_name . '-NOT-FOUND'); |
|
| 908 | + } |
|
| 909 | + return $config_option; |
|
| 910 | + } |
|
| 911 | + |
|
| 912 | + |
|
| 913 | + /** |
|
| 914 | + * log |
|
| 915 | + * |
|
| 916 | + * @param string $config_option_name |
|
| 917 | + */ |
|
| 918 | + public static function log($config_option_name = '') |
|
| 919 | + { |
|
| 920 | + if (EE_Config::logging_enabled() && ! empty($config_option_name)) { |
|
| 921 | + $config_log = get_option(EE_Config::LOG_NAME, array()); |
|
| 922 | + // copy incoming $_REQUEST and sanitize it so we can save it |
|
| 923 | + $_request = $_REQUEST; |
|
| 924 | + array_walk_recursive($_request, 'sanitize_text_field'); |
|
| 925 | + $config_log[ (string) microtime(true) ] = array( |
|
| 926 | + 'config_name' => $config_option_name, |
|
| 927 | + 'request' => $_request, |
|
| 928 | + ); |
|
| 929 | + update_option(EE_Config::LOG_NAME, $config_log); |
|
| 930 | + } |
|
| 931 | + } |
|
| 932 | + |
|
| 933 | + |
|
| 934 | + /** |
|
| 935 | + * trim_log |
|
| 936 | + * reduces the size of the config log to the length specified by EE_Config::LOG_LENGTH |
|
| 937 | + */ |
|
| 938 | + public static function trim_log() |
|
| 939 | + { |
|
| 940 | + if (! EE_Config::logging_enabled()) { |
|
| 941 | + return; |
|
| 942 | + } |
|
| 943 | + $config_log = maybe_unserialize(get_option(EE_Config::LOG_NAME, array())); |
|
| 944 | + $log_length = count($config_log); |
|
| 945 | + if ($log_length > EE_Config::LOG_LENGTH) { |
|
| 946 | + ksort($config_log); |
|
| 947 | + $config_log = array_slice($config_log, $log_length - EE_Config::LOG_LENGTH, null, true); |
|
| 948 | + update_option(EE_Config::LOG_NAME, $config_log); |
|
| 949 | + } |
|
| 950 | + } |
|
| 951 | + |
|
| 952 | + |
|
| 953 | + /** |
|
| 954 | + * get_page_for_posts |
|
| 955 | + * if the wp-option "show_on_front" is set to "page", then this is the post_name for the post set in the |
|
| 956 | + * wp-option "page_for_posts", or "posts" if no page is selected |
|
| 957 | + * |
|
| 958 | + * @access public |
|
| 959 | + * @return string |
|
| 960 | + */ |
|
| 961 | + public static function get_page_for_posts() |
|
| 962 | + { |
|
| 963 | + $page_for_posts = get_option('page_for_posts'); |
|
| 964 | + if (! $page_for_posts) { |
|
| 965 | + return 'posts'; |
|
| 966 | + } |
|
| 967 | + /** @type WPDB $wpdb */ |
|
| 968 | + global $wpdb; |
|
| 969 | + $SQL = "SELECT post_name from $wpdb->posts WHERE post_type='posts' OR post_type='page' AND post_status='publish' AND ID=%d"; |
|
| 970 | + return $wpdb->get_var($wpdb->prepare($SQL, $page_for_posts)); |
|
| 971 | + } |
|
| 972 | + |
|
| 973 | + |
|
| 974 | + /** |
|
| 975 | + * register_shortcodes_and_modules. |
|
| 976 | + * At this point, it's too early to tell if we're maintenance mode or not. |
|
| 977 | + * In fact, this is where we give modules a chance to let core know they exist |
|
| 978 | + * so they can help trigger maintenance mode if it's needed |
|
| 979 | + * |
|
| 980 | + * @access public |
|
| 981 | + * @return void |
|
| 982 | + */ |
|
| 983 | + public function register_shortcodes_and_modules() |
|
| 984 | + { |
|
| 985 | + // allow modules to set hooks for the rest of the system |
|
| 986 | + EE_Registry::instance()->modules = $this->_register_modules(); |
|
| 987 | + } |
|
| 988 | + |
|
| 989 | + |
|
| 990 | + /** |
|
| 991 | + * initialize_shortcodes_and_modules |
|
| 992 | + * meaning they can start adding their hooks to get stuff done |
|
| 993 | + * |
|
| 994 | + * @access public |
|
| 995 | + * @return void |
|
| 996 | + */ |
|
| 997 | + public function initialize_shortcodes_and_modules() |
|
| 998 | + { |
|
| 999 | + // allow modules to set hooks for the rest of the system |
|
| 1000 | + $this->_initialize_modules(); |
|
| 1001 | + } |
|
| 1002 | + |
|
| 1003 | + |
|
| 1004 | + /** |
|
| 1005 | + * widgets_init |
|
| 1006 | + * |
|
| 1007 | + * @access private |
|
| 1008 | + * @return void |
|
| 1009 | + */ |
|
| 1010 | + public function widgets_init() |
|
| 1011 | + { |
|
| 1012 | + // only init widgets on admin pages when not in complete maintenance, and |
|
| 1013 | + // on frontend when not in any maintenance mode |
|
| 1014 | + if (! EE_Maintenance_Mode::instance()->level() |
|
| 1015 | + || ( |
|
| 1016 | + is_admin() |
|
| 1017 | + && EE_Maintenance_Mode::instance()->level() !== EE_Maintenance_Mode::level_2_complete_maintenance |
|
| 1018 | + ) |
|
| 1019 | + ) { |
|
| 1020 | + // grab list of installed widgets |
|
| 1021 | + $widgets_to_register = glob(EE_WIDGETS . '*', GLOB_ONLYDIR); |
|
| 1022 | + // filter list of modules to register |
|
| 1023 | + $widgets_to_register = apply_filters( |
|
| 1024 | + 'FHEE__EE_Config__register_widgets__widgets_to_register', |
|
| 1025 | + $widgets_to_register |
|
| 1026 | + ); |
|
| 1027 | + if (! empty($widgets_to_register)) { |
|
| 1028 | + // cycle thru widget folders |
|
| 1029 | + foreach ($widgets_to_register as $widget_path) { |
|
| 1030 | + // add to list of installed widget modules |
|
| 1031 | + EE_Config::register_ee_widget($widget_path); |
|
| 1032 | + } |
|
| 1033 | + } |
|
| 1034 | + // filter list of installed modules |
|
| 1035 | + EE_Registry::instance()->widgets = apply_filters( |
|
| 1036 | + 'FHEE__EE_Config__register_widgets__installed_widgets', |
|
| 1037 | + EE_Registry::instance()->widgets |
|
| 1038 | + ); |
|
| 1039 | + } |
|
| 1040 | + } |
|
| 1041 | + |
|
| 1042 | + |
|
| 1043 | + /** |
|
| 1044 | + * register_ee_widget - makes core aware of this widget |
|
| 1045 | + * |
|
| 1046 | + * @access public |
|
| 1047 | + * @param string $widget_path - full path up to and including widget folder |
|
| 1048 | + * @return void |
|
| 1049 | + */ |
|
| 1050 | + public static function register_ee_widget($widget_path = null) |
|
| 1051 | + { |
|
| 1052 | + do_action('AHEE__EE_Config__register_widget__begin', $widget_path); |
|
| 1053 | + $widget_ext = '.widget.php'; |
|
| 1054 | + // make all separators match |
|
| 1055 | + $widget_path = rtrim(str_replace('\\', DS, $widget_path), DS); |
|
| 1056 | + // does the file path INCLUDE the actual file name as part of the path ? |
|
| 1057 | + if (strpos($widget_path, $widget_ext) !== false) { |
|
| 1058 | + // grab and shortcode file name from directory name and break apart at dots |
|
| 1059 | + $file_name = explode('.', basename($widget_path)); |
|
| 1060 | + // take first segment from file name pieces and remove class prefix if it exists |
|
| 1061 | + $widget = strpos($file_name[0], 'EEW_') === 0 ? substr($file_name[0], 4) : $file_name[0]; |
|
| 1062 | + // sanitize shortcode directory name |
|
| 1063 | + $widget = sanitize_key($widget); |
|
| 1064 | + // now we need to rebuild the shortcode path |
|
| 1065 | + $widget_path = explode(DS, $widget_path); |
|
| 1066 | + // remove last segment |
|
| 1067 | + array_pop($widget_path); |
|
| 1068 | + // glue it back together |
|
| 1069 | + $widget_path = implode(DS, $widget_path); |
|
| 1070 | + } else { |
|
| 1071 | + // grab and sanitize widget directory name |
|
| 1072 | + $widget = sanitize_key(basename($widget_path)); |
|
| 1073 | + } |
|
| 1074 | + // create classname from widget directory name |
|
| 1075 | + $widget = str_replace(' ', '_', ucwords(str_replace('_', ' ', $widget))); |
|
| 1076 | + // add class prefix |
|
| 1077 | + $widget_class = 'EEW_' . $widget; |
|
| 1078 | + // does the widget exist ? |
|
| 1079 | + if (! is_readable($widget_path . DS . $widget_class . $widget_ext)) { |
|
| 1080 | + $msg = sprintf( |
|
| 1081 | + __( |
|
| 1082 | + 'The requested %s widget file could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s', |
|
| 1083 | + 'event_espresso' |
|
| 1084 | + ), |
|
| 1085 | + $widget_class, |
|
| 1086 | + $widget_path . DS . $widget_class . $widget_ext |
|
| 1087 | + ); |
|
| 1088 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1089 | + return; |
|
| 1090 | + } |
|
| 1091 | + // load the widget class file |
|
| 1092 | + require_once($widget_path . DS . $widget_class . $widget_ext); |
|
| 1093 | + // verify that class exists |
|
| 1094 | + if (! class_exists($widget_class)) { |
|
| 1095 | + $msg = sprintf(__('The requested %s widget class does not exist.', 'event_espresso'), $widget_class); |
|
| 1096 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1097 | + return; |
|
| 1098 | + } |
|
| 1099 | + register_widget($widget_class); |
|
| 1100 | + // add to array of registered widgets |
|
| 1101 | + EE_Registry::instance()->widgets->{$widget_class} = $widget_path . DS . $widget_class . $widget_ext; |
|
| 1102 | + } |
|
| 1103 | + |
|
| 1104 | + |
|
| 1105 | + /** |
|
| 1106 | + * _register_modules |
|
| 1107 | + * |
|
| 1108 | + * @access private |
|
| 1109 | + * @return array |
|
| 1110 | + */ |
|
| 1111 | + private function _register_modules() |
|
| 1112 | + { |
|
| 1113 | + // grab list of installed modules |
|
| 1114 | + $modules_to_register = glob(EE_MODULES . '*', GLOB_ONLYDIR); |
|
| 1115 | + // filter list of modules to register |
|
| 1116 | + $modules_to_register = apply_filters( |
|
| 1117 | + 'FHEE__EE_Config__register_modules__modules_to_register', |
|
| 1118 | + $modules_to_register |
|
| 1119 | + ); |
|
| 1120 | + if (! empty($modules_to_register)) { |
|
| 1121 | + // loop through folders |
|
| 1122 | + foreach ($modules_to_register as $module_path) { |
|
| 1123 | + /**TEMPORARILY EXCLUDE gateways from modules for time being**/ |
|
| 1124 | + if ($module_path !== EE_MODULES . 'zzz-copy-this-module-template' |
|
| 1125 | + && $module_path !== EE_MODULES . 'gateways' |
|
| 1126 | + ) { |
|
| 1127 | + // add to list of installed modules |
|
| 1128 | + EE_Config::register_module($module_path); |
|
| 1129 | + } |
|
| 1130 | + } |
|
| 1131 | + } |
|
| 1132 | + // filter list of installed modules |
|
| 1133 | + return apply_filters( |
|
| 1134 | + 'FHEE__EE_Config___register_modules__installed_modules', |
|
| 1135 | + EE_Registry::instance()->modules |
|
| 1136 | + ); |
|
| 1137 | + } |
|
| 1138 | + |
|
| 1139 | + |
|
| 1140 | + /** |
|
| 1141 | + * register_module - makes core aware of this module |
|
| 1142 | + * |
|
| 1143 | + * @access public |
|
| 1144 | + * @param string $module_path - full path up to and including module folder |
|
| 1145 | + * @return bool |
|
| 1146 | + */ |
|
| 1147 | + public static function register_module($module_path = null) |
|
| 1148 | + { |
|
| 1149 | + do_action('AHEE__EE_Config__register_module__begin', $module_path); |
|
| 1150 | + $module_ext = '.module.php'; |
|
| 1151 | + // make all separators match |
|
| 1152 | + $module_path = str_replace(array('\\', '/'), DS, $module_path); |
|
| 1153 | + // does the file path INCLUDE the actual file name as part of the path ? |
|
| 1154 | + if (strpos($module_path, $module_ext) !== false) { |
|
| 1155 | + // grab and shortcode file name from directory name and break apart at dots |
|
| 1156 | + $module_file = explode('.', basename($module_path)); |
|
| 1157 | + // now we need to rebuild the shortcode path |
|
| 1158 | + $module_path = explode(DS, $module_path); |
|
| 1159 | + // remove last segment |
|
| 1160 | + array_pop($module_path); |
|
| 1161 | + // glue it back together |
|
| 1162 | + $module_path = implode(DS, $module_path) . DS; |
|
| 1163 | + // take first segment from file name pieces and sanitize it |
|
| 1164 | + $module = preg_replace('/[^a-zA-Z0-9_\-]/', '', $module_file[0]); |
|
| 1165 | + // ensure class prefix is added |
|
| 1166 | + $module_class = strpos($module, 'EED_') !== 0 ? 'EED_' . $module : $module; |
|
| 1167 | + } else { |
|
| 1168 | + // we need to generate the filename based off of the folder name |
|
| 1169 | + // grab and sanitize module name |
|
| 1170 | + $module = strtolower(basename($module_path)); |
|
| 1171 | + $module = preg_replace('/[^a-z0-9_\-]/', '', $module); |
|
| 1172 | + // like trailingslashit() |
|
| 1173 | + $module_path = rtrim($module_path, DS) . DS; |
|
| 1174 | + // create classname from module directory name |
|
| 1175 | + $module = str_replace(' ', '_', ucwords(str_replace('_', ' ', $module))); |
|
| 1176 | + // add class prefix |
|
| 1177 | + $module_class = 'EED_' . $module; |
|
| 1178 | + } |
|
| 1179 | + // does the module exist ? |
|
| 1180 | + if (! is_readable($module_path . DS . $module_class . $module_ext)) { |
|
| 1181 | + $msg = sprintf( |
|
| 1182 | + __( |
|
| 1183 | + 'The requested %s module file could not be found or is not readable due to file permissions.', |
|
| 1184 | + 'event_espresso' |
|
| 1185 | + ), |
|
| 1186 | + $module |
|
| 1187 | + ); |
|
| 1188 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1189 | + return false; |
|
| 1190 | + } |
|
| 1191 | + // load the module class file |
|
| 1192 | + require_once($module_path . $module_class . $module_ext); |
|
| 1193 | + // verify that class exists |
|
| 1194 | + if (! class_exists($module_class)) { |
|
| 1195 | + $msg = sprintf(__('The requested %s module class does not exist.', 'event_espresso'), $module_class); |
|
| 1196 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1197 | + return false; |
|
| 1198 | + } |
|
| 1199 | + // add to array of registered modules |
|
| 1200 | + EE_Registry::instance()->modules->{$module_class} = $module_path . $module_class . $module_ext; |
|
| 1201 | + do_action( |
|
| 1202 | + 'AHEE__EE_Config__register_module__complete', |
|
| 1203 | + $module_class, |
|
| 1204 | + EE_Registry::instance()->modules->{$module_class} |
|
| 1205 | + ); |
|
| 1206 | + return true; |
|
| 1207 | + } |
|
| 1208 | + |
|
| 1209 | + |
|
| 1210 | + /** |
|
| 1211 | + * _initialize_modules |
|
| 1212 | + * allow modules to set hooks for the rest of the system |
|
| 1213 | + * |
|
| 1214 | + * @access private |
|
| 1215 | + * @return void |
|
| 1216 | + */ |
|
| 1217 | + private function _initialize_modules() |
|
| 1218 | + { |
|
| 1219 | + // cycle thru shortcode folders |
|
| 1220 | + foreach (EE_Registry::instance()->modules as $module_class => $module_path) { |
|
| 1221 | + // fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system |
|
| 1222 | + // which set hooks ? |
|
| 1223 | + if (is_admin()) { |
|
| 1224 | + // fire immediately |
|
| 1225 | + call_user_func(array($module_class, 'set_hooks_admin')); |
|
| 1226 | + } else { |
|
| 1227 | + // delay until other systems are online |
|
| 1228 | + add_action( |
|
| 1229 | + 'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons', |
|
| 1230 | + array($module_class, 'set_hooks') |
|
| 1231 | + ); |
|
| 1232 | + } |
|
| 1233 | + } |
|
| 1234 | + } |
|
| 1235 | + |
|
| 1236 | + |
|
| 1237 | + /** |
|
| 1238 | + * register_route - adds module method routes to route_map |
|
| 1239 | + * |
|
| 1240 | + * @access public |
|
| 1241 | + * @param string $route - "pretty" public alias for module method |
|
| 1242 | + * @param string $module - module name (classname without EED_ prefix) |
|
| 1243 | + * @param string $method_name - the actual module method to be routed to |
|
| 1244 | + * @param string $key - url param key indicating a route is being called |
|
| 1245 | + * @return bool |
|
| 1246 | + */ |
|
| 1247 | + public static function register_route($route = null, $module = null, $method_name = null, $key = 'ee') |
|
| 1248 | + { |
|
| 1249 | + do_action('AHEE__EE_Config__register_route__begin', $route, $module, $method_name); |
|
| 1250 | + $module = str_replace('EED_', '', $module); |
|
| 1251 | + $module_class = 'EED_' . $module; |
|
| 1252 | + if (! isset(EE_Registry::instance()->modules->{$module_class})) { |
|
| 1253 | + $msg = sprintf(__('The module %s has not been registered.', 'event_espresso'), $module); |
|
| 1254 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1255 | + return false; |
|
| 1256 | + } |
|
| 1257 | + if (empty($route)) { |
|
| 1258 | + $msg = sprintf(__('No route has been supplied.', 'event_espresso'), $route); |
|
| 1259 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1260 | + return false; |
|
| 1261 | + } |
|
| 1262 | + if (! method_exists('EED_' . $module, $method_name)) { |
|
| 1263 | + $msg = sprintf( |
|
| 1264 | + __('A valid class method for the %s route has not been supplied.', 'event_espresso'), |
|
| 1265 | + $route |
|
| 1266 | + ); |
|
| 1267 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1268 | + return false; |
|
| 1269 | + } |
|
| 1270 | + EE_Config::$_module_route_map[ (string) $key ][ (string) $route ] = array('EED_' . $module, $method_name); |
|
| 1271 | + return true; |
|
| 1272 | + } |
|
| 1273 | + |
|
| 1274 | + |
|
| 1275 | + /** |
|
| 1276 | + * get_route - get module method route |
|
| 1277 | + * |
|
| 1278 | + * @access public |
|
| 1279 | + * @param string $route - "pretty" public alias for module method |
|
| 1280 | + * @param string $key - url param key indicating a route is being called |
|
| 1281 | + * @return string |
|
| 1282 | + */ |
|
| 1283 | + public static function get_route($route = null, $key = 'ee') |
|
| 1284 | + { |
|
| 1285 | + do_action('AHEE__EE_Config__get_route__begin', $route); |
|
| 1286 | + $route = (string) apply_filters('FHEE__EE_Config__get_route', $route); |
|
| 1287 | + if (isset(EE_Config::$_module_route_map[ $key ][ $route ])) { |
|
| 1288 | + return EE_Config::$_module_route_map[ $key ][ $route ]; |
|
| 1289 | + } |
|
| 1290 | + return null; |
|
| 1291 | + } |
|
| 1292 | + |
|
| 1293 | + |
|
| 1294 | + /** |
|
| 1295 | + * get_routes - get ALL module method routes |
|
| 1296 | + * |
|
| 1297 | + * @access public |
|
| 1298 | + * @return array |
|
| 1299 | + */ |
|
| 1300 | + public static function get_routes() |
|
| 1301 | + { |
|
| 1302 | + return EE_Config::$_module_route_map; |
|
| 1303 | + } |
|
| 1304 | + |
|
| 1305 | + |
|
| 1306 | + /** |
|
| 1307 | + * register_forward - allows modules to forward request to another module for further processing |
|
| 1308 | + * |
|
| 1309 | + * @access public |
|
| 1310 | + * @param string $route - "pretty" public alias for module method |
|
| 1311 | + * @param integer $status - integer value corresponding to status constant strings set in module parent |
|
| 1312 | + * class, allows different forwards to be served based on status |
|
| 1313 | + * @param array|string $forward - function name or array( class, method ) |
|
| 1314 | + * @param string $key - url param key indicating a route is being called |
|
| 1315 | + * @return bool |
|
| 1316 | + */ |
|
| 1317 | + public static function register_forward($route = null, $status = 0, $forward = null, $key = 'ee') |
|
| 1318 | + { |
|
| 1319 | + do_action('AHEE__EE_Config__register_forward', $route, $status, $forward); |
|
| 1320 | + if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) { |
|
| 1321 | + $msg = sprintf( |
|
| 1322 | + __('The module route %s for this forward has not been registered.', 'event_espresso'), |
|
| 1323 | + $route |
|
| 1324 | + ); |
|
| 1325 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1326 | + return false; |
|
| 1327 | + } |
|
| 1328 | + if (empty($forward)) { |
|
| 1329 | + $msg = sprintf(__('No forwarding route has been supplied.', 'event_espresso'), $route); |
|
| 1330 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1331 | + return false; |
|
| 1332 | + } |
|
| 1333 | + if (is_array($forward)) { |
|
| 1334 | + if (! isset($forward[1])) { |
|
| 1335 | + $msg = sprintf( |
|
| 1336 | + __('A class method for the %s forwarding route has not been supplied.', 'event_espresso'), |
|
| 1337 | + $route |
|
| 1338 | + ); |
|
| 1339 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1340 | + return false; |
|
| 1341 | + } |
|
| 1342 | + if (! method_exists($forward[0], $forward[1])) { |
|
| 1343 | + $msg = sprintf( |
|
| 1344 | + __('The class method %s for the %s forwarding route is in invalid.', 'event_espresso'), |
|
| 1345 | + $forward[1], |
|
| 1346 | + $route |
|
| 1347 | + ); |
|
| 1348 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1349 | + return false; |
|
| 1350 | + } |
|
| 1351 | + } elseif (! function_exists($forward)) { |
|
| 1352 | + $msg = sprintf( |
|
| 1353 | + __('The function %s for the %s forwarding route is in invalid.', 'event_espresso'), |
|
| 1354 | + $forward, |
|
| 1355 | + $route |
|
| 1356 | + ); |
|
| 1357 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1358 | + return false; |
|
| 1359 | + } |
|
| 1360 | + EE_Config::$_module_forward_map[ $key ][ $route ][ absint($status) ] = $forward; |
|
| 1361 | + return true; |
|
| 1362 | + } |
|
| 1363 | + |
|
| 1364 | + |
|
| 1365 | + /** |
|
| 1366 | + * get_forward - get forwarding route |
|
| 1367 | + * |
|
| 1368 | + * @access public |
|
| 1369 | + * @param string $route - "pretty" public alias for module method |
|
| 1370 | + * @param integer $status - integer value corresponding to status constant strings set in module parent class, |
|
| 1371 | + * allows different forwards to be served based on status |
|
| 1372 | + * @param string $key - url param key indicating a route is being called |
|
| 1373 | + * @return string |
|
| 1374 | + */ |
|
| 1375 | + public static function get_forward($route = null, $status = 0, $key = 'ee') |
|
| 1376 | + { |
|
| 1377 | + do_action('AHEE__EE_Config__get_forward__begin', $route, $status); |
|
| 1378 | + if (isset(EE_Config::$_module_forward_map[ $key ][ $route ][ $status ])) { |
|
| 1379 | + return apply_filters( |
|
| 1380 | + 'FHEE__EE_Config__get_forward', |
|
| 1381 | + EE_Config::$_module_forward_map[ $key ][ $route ][ $status ], |
|
| 1382 | + $route, |
|
| 1383 | + $status |
|
| 1384 | + ); |
|
| 1385 | + } |
|
| 1386 | + return null; |
|
| 1387 | + } |
|
| 1388 | + |
|
| 1389 | + |
|
| 1390 | + /** |
|
| 1391 | + * register_forward - allows modules to specify different view templates for different method routes and status |
|
| 1392 | + * results |
|
| 1393 | + * |
|
| 1394 | + * @access public |
|
| 1395 | + * @param string $route - "pretty" public alias for module method |
|
| 1396 | + * @param integer $status - integer value corresponding to status constant strings set in module parent class, |
|
| 1397 | + * allows different views to be served based on status |
|
| 1398 | + * @param string $view |
|
| 1399 | + * @param string $key - url param key indicating a route is being called |
|
| 1400 | + * @return bool |
|
| 1401 | + */ |
|
| 1402 | + public static function register_view($route = null, $status = 0, $view = null, $key = 'ee') |
|
| 1403 | + { |
|
| 1404 | + do_action('AHEE__EE_Config__register_view__begin', $route, $status, $view); |
|
| 1405 | + if (! isset(EE_Config::$_module_route_map[ $key ][ $route ]) || empty($route)) { |
|
| 1406 | + $msg = sprintf( |
|
| 1407 | + __('The module route %s for this view has not been registered.', 'event_espresso'), |
|
| 1408 | + $route |
|
| 1409 | + ); |
|
| 1410 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1411 | + return false; |
|
| 1412 | + } |
|
| 1413 | + if (! is_readable($view)) { |
|
| 1414 | + $msg = sprintf( |
|
| 1415 | + __( |
|
| 1416 | + 'The %s view file could not be found or is not readable due to file permissions.', |
|
| 1417 | + 'event_espresso' |
|
| 1418 | + ), |
|
| 1419 | + $view |
|
| 1420 | + ); |
|
| 1421 | + EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 1422 | + return false; |
|
| 1423 | + } |
|
| 1424 | + EE_Config::$_module_view_map[ $key ][ $route ][ absint($status) ] = $view; |
|
| 1425 | + return true; |
|
| 1426 | + } |
|
| 1427 | + |
|
| 1428 | + |
|
| 1429 | + /** |
|
| 1430 | + * get_view - get view for route and status |
|
| 1431 | + * |
|
| 1432 | + * @access public |
|
| 1433 | + * @param string $route - "pretty" public alias for module method |
|
| 1434 | + * @param integer $status - integer value corresponding to status constant strings set in module parent class, |
|
| 1435 | + * allows different views to be served based on status |
|
| 1436 | + * @param string $key - url param key indicating a route is being called |
|
| 1437 | + * @return string |
|
| 1438 | + */ |
|
| 1439 | + public static function get_view($route = null, $status = 0, $key = 'ee') |
|
| 1440 | + { |
|
| 1441 | + do_action('AHEE__EE_Config__get_view__begin', $route, $status); |
|
| 1442 | + if (isset(EE_Config::$_module_view_map[ $key ][ $route ][ $status ])) { |
|
| 1443 | + return apply_filters( |
|
| 1444 | + 'FHEE__EE_Config__get_view', |
|
| 1445 | + EE_Config::$_module_view_map[ $key ][ $route ][ $status ], |
|
| 1446 | + $route, |
|
| 1447 | + $status |
|
| 1448 | + ); |
|
| 1449 | + } |
|
| 1450 | + return null; |
|
| 1451 | + } |
|
| 1452 | + |
|
| 1453 | + |
|
| 1454 | + public function update_addon_option_names() |
|
| 1455 | + { |
|
| 1456 | + update_option(EE_Config::ADDON_OPTION_NAMES, $this->_addon_option_names); |
|
| 1457 | + } |
|
| 1458 | + |
|
| 1459 | + |
|
| 1460 | + public function shutdown() |
|
| 1461 | + { |
|
| 1462 | + $this->update_addon_option_names(); |
|
| 1463 | + } |
|
| 1464 | + |
|
| 1465 | + |
|
| 1466 | + /** |
|
| 1467 | + * @return LegacyShortcodesManager |
|
| 1468 | + */ |
|
| 1469 | + public static function getLegacyShortcodesManager() |
|
| 1470 | + { |
|
| 1471 | + |
|
| 1472 | + if (! EE_Config::instance()->legacy_shortcodes_manager instanceof LegacyShortcodesManager) { |
|
| 1473 | + EE_Config::instance()->legacy_shortcodes_manager = new LegacyShortcodesManager( |
|
| 1474 | + EE_Registry::instance() |
|
| 1475 | + ); |
|
| 1476 | + } |
|
| 1477 | + return EE_Config::instance()->legacy_shortcodes_manager; |
|
| 1478 | + } |
|
| 1479 | + |
|
| 1480 | + |
|
| 1481 | + /** |
|
| 1482 | + * register_shortcode - makes core aware of this shortcode |
|
| 1483 | + * |
|
| 1484 | + * @deprecated 4.9.26 |
|
| 1485 | + * @param string $shortcode_path - full path up to and including shortcode folder |
|
| 1486 | + * @return bool |
|
| 1487 | + */ |
|
| 1488 | + public static function register_shortcode($shortcode_path = null) |
|
| 1489 | + { |
|
| 1490 | + EE_Error::doing_it_wrong( |
|
| 1491 | + __METHOD__, |
|
| 1492 | + __( |
|
| 1493 | + 'Usage is deprecated. Use \EventEspresso\core\services\shortcodes\LegacyShortcodesManager::registerShortcode() as direct replacement, or better yet, please see the new \EventEspresso\core\services\shortcodes\ShortcodesManager class.', |
|
| 1494 | + 'event_espresso' |
|
| 1495 | + ), |
|
| 1496 | + '4.9.26' |
|
| 1497 | + ); |
|
| 1498 | + return EE_Config::instance()->getLegacyShortcodesManager()->registerShortcode($shortcode_path); |
|
| 1499 | + } |
|
| 1500 | +} |
|
| 2262 | 1501 | |
| 2263 | - /** |
|
| 2264 | - * ReCaptcha Type |
|
| 2265 | - * |
|
| 2266 | - * @var string $recaptcha_type |
|
| 2267 | - * options: 'audio', 'image' |
|
| 2268 | - */ |
|
| 2269 | - public $recaptcha_type; |
|
| 1502 | +/** |
|
| 1503 | + * Base class used for config classes. These classes should generally not have |
|
| 1504 | + * magic functions in use, except we'll allow them to magically set and get stuff... |
|
| 1505 | + * basically, they should just be well-defined stdClasses |
|
| 1506 | + */ |
|
| 1507 | +class EE_Config_Base |
|
| 1508 | +{ |
|
| 2270 | 1509 | |
| 2271 | - /** |
|
| 2272 | - * ReCaptcha language |
|
| 2273 | - * |
|
| 2274 | - * @var string $recaptcha_language |
|
| 2275 | - * eg 'en' |
|
| 2276 | - */ |
|
| 2277 | - public $recaptcha_language; |
|
| 1510 | + /** |
|
| 1511 | + * Utility function for escaping the value of a property and returning. |
|
| 1512 | + * |
|
| 1513 | + * @param string $property property name (checks to see if exists). |
|
| 1514 | + * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned. |
|
| 1515 | + * @throws \EE_Error |
|
| 1516 | + */ |
|
| 1517 | + public function get_pretty($property) |
|
| 1518 | + { |
|
| 1519 | + if (! property_exists($this, $property)) { |
|
| 1520 | + throw new EE_Error( |
|
| 1521 | + sprintf( |
|
| 1522 | + __( |
|
| 1523 | + '%1$s::get_pretty() has been called with the property %2$s which does not exist on the %1$s config class.', |
|
| 1524 | + 'event_espresso' |
|
| 1525 | + ), |
|
| 1526 | + get_class($this), |
|
| 1527 | + $property |
|
| 1528 | + ) |
|
| 1529 | + ); |
|
| 1530 | + } |
|
| 1531 | + // just handling escaping of strings for now. |
|
| 1532 | + if (is_string($this->{$property})) { |
|
| 1533 | + return stripslashes($this->{$property}); |
|
| 1534 | + } |
|
| 1535 | + return $this->{$property}; |
|
| 1536 | + } |
|
| 1537 | + |
|
| 1538 | + |
|
| 1539 | + public function populate() |
|
| 1540 | + { |
|
| 1541 | + // grab defaults via a new instance of this class. |
|
| 1542 | + $class_name = get_class($this); |
|
| 1543 | + $defaults = new $class_name; |
|
| 1544 | + // loop through the properties for this class and see if they are set. If they are NOT, then grab the |
|
| 1545 | + // default from our $defaults object. |
|
| 1546 | + foreach (get_object_vars($defaults) as $property => $value) { |
|
| 1547 | + if ($this->{$property} === null) { |
|
| 1548 | + $this->{$property} = $value; |
|
| 1549 | + } |
|
| 1550 | + } |
|
| 1551 | + // cleanup |
|
| 1552 | + unset($defaults); |
|
| 1553 | + } |
|
| 1554 | + |
|
| 1555 | + |
|
| 1556 | + /** |
|
| 1557 | + * __isset |
|
| 1558 | + * |
|
| 1559 | + * @param $a |
|
| 1560 | + * @return bool |
|
| 1561 | + */ |
|
| 1562 | + public function __isset($a) |
|
| 1563 | + { |
|
| 1564 | + return false; |
|
| 1565 | + } |
|
| 1566 | + |
|
| 1567 | + |
|
| 1568 | + /** |
|
| 1569 | + * __unset |
|
| 1570 | + * |
|
| 1571 | + * @param $a |
|
| 1572 | + * @return bool |
|
| 1573 | + */ |
|
| 1574 | + public function __unset($a) |
|
| 1575 | + { |
|
| 1576 | + return false; |
|
| 1577 | + } |
|
| 1578 | + |
|
| 1579 | + |
|
| 1580 | + /** |
|
| 1581 | + * __clone |
|
| 1582 | + */ |
|
| 1583 | + public function __clone() |
|
| 1584 | + { |
|
| 1585 | + } |
|
| 1586 | + |
|
| 1587 | + |
|
| 1588 | + /** |
|
| 1589 | + * __wakeup |
|
| 1590 | + */ |
|
| 1591 | + public function __wakeup() |
|
| 1592 | + { |
|
| 1593 | + } |
|
| 1594 | + |
|
| 1595 | + |
|
| 1596 | + /** |
|
| 1597 | + * __destruct |
|
| 1598 | + */ |
|
| 1599 | + public function __destruct() |
|
| 1600 | + { |
|
| 1601 | + } |
|
| 1602 | +} |
|
| 2278 | 1603 | |
| 2279 | - /** |
|
| 2280 | - * ReCaptcha public key |
|
| 2281 | - * |
|
| 2282 | - * @var string $recaptcha_publickey |
|
| 2283 | - */ |
|
| 2284 | - public $recaptcha_publickey; |
|
| 1604 | +/** |
|
| 1605 | + * Class for defining what's in the EE_Config relating to registration settings |
|
| 1606 | + */ |
|
| 1607 | +class EE_Core_Config extends EE_Config_Base |
|
| 1608 | +{ |
|
| 2285 | 1609 | |
| 2286 | - /** |
|
| 2287 | - * ReCaptcha private key |
|
| 2288 | - * |
|
| 2289 | - * @var string $recaptcha_privatekey |
|
| 2290 | - */ |
|
| 2291 | - public $recaptcha_privatekey; |
|
| 1610 | + const OPTION_NAME_UXIP = 'ee_ueip_optin'; |
|
| 1611 | + |
|
| 1612 | + |
|
| 1613 | + public $current_blog_id; |
|
| 1614 | + |
|
| 1615 | + public $ee_ueip_optin; |
|
| 1616 | + |
|
| 1617 | + public $ee_ueip_has_notified; |
|
| 1618 | + |
|
| 1619 | + /** |
|
| 1620 | + * Not to be confused with the 4 critical page variables (See |
|
| 1621 | + * get_critical_pages_array()), this is just an array of wp posts that have EE |
|
| 1622 | + * shortcodes in them. Keys are slugs, values are arrays with only 1 element: where the key is the shortcode |
|
| 1623 | + * in the page, and the value is the page's ID. The key 'posts' is basically a duplicate of this same array. |
|
| 1624 | + * |
|
| 1625 | + * @var array |
|
| 1626 | + */ |
|
| 1627 | + public $post_shortcodes; |
|
| 1628 | + |
|
| 1629 | + public $module_route_map; |
|
| 1630 | + |
|
| 1631 | + public $module_forward_map; |
|
| 1632 | + |
|
| 1633 | + public $module_view_map; |
|
| 1634 | + |
|
| 1635 | + /** |
|
| 1636 | + * The next 4 vars are the IDs of critical EE pages. |
|
| 1637 | + * |
|
| 1638 | + * @var int |
|
| 1639 | + */ |
|
| 1640 | + public $reg_page_id; |
|
| 1641 | + |
|
| 1642 | + public $txn_page_id; |
|
| 1643 | + |
|
| 1644 | + public $thank_you_page_id; |
|
| 1645 | + |
|
| 1646 | + public $cancel_page_id; |
|
| 1647 | + |
|
| 1648 | + /** |
|
| 1649 | + * The next 4 vars are the URLs of critical EE pages. |
|
| 1650 | + * |
|
| 1651 | + * @var int |
|
| 1652 | + */ |
|
| 1653 | + public $reg_page_url; |
|
| 1654 | + |
|
| 1655 | + public $txn_page_url; |
|
| 1656 | + |
|
| 1657 | + public $thank_you_page_url; |
|
| 1658 | + |
|
| 1659 | + public $cancel_page_url; |
|
| 1660 | + |
|
| 1661 | + /** |
|
| 1662 | + * The next vars relate to the custom slugs for EE CPT routes |
|
| 1663 | + */ |
|
| 1664 | + public $event_cpt_slug; |
|
| 1665 | + |
|
| 1666 | + /** |
|
| 1667 | + * This caches the _ee_ueip_option in case this config is reset in the same |
|
| 1668 | + * request across blog switches in a multisite context. |
|
| 1669 | + * Avoids extra queries to the db for this option. |
|
| 1670 | + * |
|
| 1671 | + * @var bool |
|
| 1672 | + */ |
|
| 1673 | + public static $ee_ueip_option; |
|
| 1674 | + |
|
| 1675 | + |
|
| 1676 | + /** |
|
| 1677 | + * class constructor |
|
| 1678 | + * |
|
| 1679 | + * @access public |
|
| 1680 | + */ |
|
| 1681 | + public function __construct() |
|
| 1682 | + { |
|
| 1683 | + // set default organization settings |
|
| 1684 | + $this->current_blog_id = get_current_blog_id(); |
|
| 1685 | + $this->current_blog_id = $this->current_blog_id === null ? 1 : $this->current_blog_id; |
|
| 1686 | + $this->ee_ueip_optin = $this->_get_main_ee_ueip_optin(); |
|
| 1687 | + $this->ee_ueip_has_notified = is_main_site() ? get_option('ee_ueip_has_notified', false) : true; |
|
| 1688 | + $this->post_shortcodes = array(); |
|
| 1689 | + $this->module_route_map = array(); |
|
| 1690 | + $this->module_forward_map = array(); |
|
| 1691 | + $this->module_view_map = array(); |
|
| 1692 | + // critical EE page IDs |
|
| 1693 | + $this->reg_page_id = 0; |
|
| 1694 | + $this->txn_page_id = 0; |
|
| 1695 | + $this->thank_you_page_id = 0; |
|
| 1696 | + $this->cancel_page_id = 0; |
|
| 1697 | + // critical EE page URLs |
|
| 1698 | + $this->reg_page_url = ''; |
|
| 1699 | + $this->txn_page_url = ''; |
|
| 1700 | + $this->thank_you_page_url = ''; |
|
| 1701 | + $this->cancel_page_url = ''; |
|
| 1702 | + // cpt slugs |
|
| 1703 | + $this->event_cpt_slug = __('events', 'event_espresso'); |
|
| 1704 | + // ueip constant check |
|
| 1705 | + if (defined('EE_DISABLE_UXIP') && EE_DISABLE_UXIP) { |
|
| 1706 | + $this->ee_ueip_optin = false; |
|
| 1707 | + $this->ee_ueip_has_notified = true; |
|
| 1708 | + } |
|
| 1709 | + } |
|
| 1710 | + |
|
| 1711 | + |
|
| 1712 | + /** |
|
| 1713 | + * @return array |
|
| 1714 | + */ |
|
| 1715 | + public function get_critical_pages_array() |
|
| 1716 | + { |
|
| 1717 | + return array( |
|
| 1718 | + $this->reg_page_id, |
|
| 1719 | + $this->txn_page_id, |
|
| 1720 | + $this->thank_you_page_id, |
|
| 1721 | + $this->cancel_page_id, |
|
| 1722 | + ); |
|
| 1723 | + } |
|
| 1724 | + |
|
| 1725 | + |
|
| 1726 | + /** |
|
| 1727 | + * @return array |
|
| 1728 | + */ |
|
| 1729 | + public function get_critical_pages_shortcodes_array() |
|
| 1730 | + { |
|
| 1731 | + return array( |
|
| 1732 | + $this->reg_page_id => 'ESPRESSO_CHECKOUT', |
|
| 1733 | + $this->txn_page_id => 'ESPRESSO_TXN_PAGE', |
|
| 1734 | + $this->thank_you_page_id => 'ESPRESSO_THANK_YOU', |
|
| 1735 | + $this->cancel_page_id => 'ESPRESSO_CANCELLED', |
|
| 1736 | + ); |
|
| 1737 | + } |
|
| 1738 | + |
|
| 1739 | + |
|
| 1740 | + /** |
|
| 1741 | + * gets/returns URL for EE reg_page |
|
| 1742 | + * |
|
| 1743 | + * @access public |
|
| 1744 | + * @return string |
|
| 1745 | + */ |
|
| 1746 | + public function reg_page_url() |
|
| 1747 | + { |
|
| 1748 | + if (! $this->reg_page_url) { |
|
| 1749 | + $this->reg_page_url = add_query_arg( |
|
| 1750 | + array('uts' => time()), |
|
| 1751 | + get_permalink($this->reg_page_id) |
|
| 1752 | + ) . '#checkout'; |
|
| 1753 | + } |
|
| 1754 | + return $this->reg_page_url; |
|
| 1755 | + } |
|
| 1756 | + |
|
| 1757 | + |
|
| 1758 | + /** |
|
| 1759 | + * gets/returns URL for EE txn_page |
|
| 1760 | + * |
|
| 1761 | + * @param array $query_args like what gets passed to |
|
| 1762 | + * add_query_arg() as the first argument |
|
| 1763 | + * @access public |
|
| 1764 | + * @return string |
|
| 1765 | + */ |
|
| 1766 | + public function txn_page_url($query_args = array()) |
|
| 1767 | + { |
|
| 1768 | + if (! $this->txn_page_url) { |
|
| 1769 | + $this->txn_page_url = get_permalink($this->txn_page_id); |
|
| 1770 | + } |
|
| 1771 | + if ($query_args) { |
|
| 1772 | + return add_query_arg($query_args, $this->txn_page_url); |
|
| 1773 | + } else { |
|
| 1774 | + return $this->txn_page_url; |
|
| 1775 | + } |
|
| 1776 | + } |
|
| 1777 | + |
|
| 1778 | + |
|
| 1779 | + /** |
|
| 1780 | + * gets/returns URL for EE thank_you_page |
|
| 1781 | + * |
|
| 1782 | + * @param array $query_args like what gets passed to |
|
| 1783 | + * add_query_arg() as the first argument |
|
| 1784 | + * @access public |
|
| 1785 | + * @return string |
|
| 1786 | + */ |
|
| 1787 | + public function thank_you_page_url($query_args = array()) |
|
| 1788 | + { |
|
| 1789 | + if (! $this->thank_you_page_url) { |
|
| 1790 | + $this->thank_you_page_url = get_permalink($this->thank_you_page_id); |
|
| 1791 | + } |
|
| 1792 | + if ($query_args) { |
|
| 1793 | + return add_query_arg($query_args, $this->thank_you_page_url); |
|
| 1794 | + } else { |
|
| 1795 | + return $this->thank_you_page_url; |
|
| 1796 | + } |
|
| 1797 | + } |
|
| 1798 | + |
|
| 1799 | + |
|
| 1800 | + /** |
|
| 1801 | + * gets/returns URL for EE cancel_page |
|
| 1802 | + * |
|
| 1803 | + * @access public |
|
| 1804 | + * @return string |
|
| 1805 | + */ |
|
| 1806 | + public function cancel_page_url() |
|
| 1807 | + { |
|
| 1808 | + if (! $this->cancel_page_url) { |
|
| 1809 | + $this->cancel_page_url = get_permalink($this->cancel_page_id); |
|
| 1810 | + } |
|
| 1811 | + return $this->cancel_page_url; |
|
| 1812 | + } |
|
| 1813 | + |
|
| 1814 | + |
|
| 1815 | + /** |
|
| 1816 | + * Resets all critical page urls to their original state. Used primarily by the __sleep() magic method currently. |
|
| 1817 | + * |
|
| 1818 | + * @since 4.7.5 |
|
| 1819 | + */ |
|
| 1820 | + protected function _reset_urls() |
|
| 1821 | + { |
|
| 1822 | + $this->reg_page_url = ''; |
|
| 1823 | + $this->txn_page_url = ''; |
|
| 1824 | + $this->cancel_page_url = ''; |
|
| 1825 | + $this->thank_you_page_url = ''; |
|
| 1826 | + } |
|
| 1827 | + |
|
| 1828 | + |
|
| 1829 | + /** |
|
| 1830 | + * Used to return what the optin value is set for the EE User Experience Program. |
|
| 1831 | + * This accounts for multisite and this value being requested for a subsite. In multisite, the value is set |
|
| 1832 | + * on the main site only. |
|
| 1833 | + * |
|
| 1834 | + * @return bool |
|
| 1835 | + */ |
|
| 1836 | + protected function _get_main_ee_ueip_optin() |
|
| 1837 | + { |
|
| 1838 | + // if this is the main site then we can just bypass our direct query. |
|
| 1839 | + if (is_main_site()) { |
|
| 1840 | + return get_option(self::OPTION_NAME_UXIP, false); |
|
| 1841 | + } |
|
| 1842 | + // is this already cached for this request? If so use it. |
|
| 1843 | + if (EE_Core_Config::$ee_ueip_option !== null) { |
|
| 1844 | + return EE_Core_Config::$ee_ueip_option; |
|
| 1845 | + } |
|
| 1846 | + global $wpdb; |
|
| 1847 | + $current_network_main_site = is_multisite() ? get_current_site() : null; |
|
| 1848 | + $current_main_site_id = ! empty($current_network_main_site) ? $current_network_main_site->blog_id : 1; |
|
| 1849 | + $option = self::OPTION_NAME_UXIP; |
|
| 1850 | + // set correct table for query |
|
| 1851 | + $table_name = $wpdb->get_blog_prefix($current_main_site_id) . 'options'; |
|
| 1852 | + // rather than getting blog option for the $current_main_site_id, we do a direct $wpdb query because |
|
| 1853 | + // get_blog_option() does a switch_to_blog an that could cause infinite recursion because EE_Core_Config might be |
|
| 1854 | + // re-constructed on the blog switch. Note, we are still executing any core wp filters on this option retrieval. |
|
| 1855 | + // this bit of code is basically a direct copy of get_option without any caching because we are NOT switched to the blog |
|
| 1856 | + // for the purpose of caching. |
|
| 1857 | + $pre = apply_filters('pre_option_' . $option, false, $option); |
|
| 1858 | + if (false !== $pre) { |
|
| 1859 | + EE_Core_Config::$ee_ueip_option = $pre; |
|
| 1860 | + return EE_Core_Config::$ee_ueip_option; |
|
| 1861 | + } |
|
| 1862 | + $row = $wpdb->get_row( |
|
| 1863 | + $wpdb->prepare( |
|
| 1864 | + "SELECT option_value FROM $table_name WHERE option_name = %s LIMIT 1", |
|
| 1865 | + $option |
|
| 1866 | + ) |
|
| 1867 | + ); |
|
| 1868 | + if (is_object($row)) { |
|
| 1869 | + $value = $row->option_value; |
|
| 1870 | + } else { // option does not exist so use default. |
|
| 1871 | + EE_Core_Config::$ee_ueip_option = apply_filters('default_option_' . $option, false, $option); |
|
| 1872 | + return EE_Core_Config::$ee_ueip_option; |
|
| 1873 | + } |
|
| 1874 | + EE_Core_Config::$ee_ueip_option = apply_filters('option_' . $option, maybe_unserialize($value), $option); |
|
| 1875 | + return EE_Core_Config::$ee_ueip_option; |
|
| 1876 | + } |
|
| 1877 | + |
|
| 1878 | + |
|
| 1879 | + /** |
|
| 1880 | + * Utility function for escaping the value of a property and returning. |
|
| 1881 | + * |
|
| 1882 | + * @param string $property property name (checks to see if exists). |
|
| 1883 | + * @return mixed if a detected type found return the escaped value, otherwise just the raw value is returned. |
|
| 1884 | + * @throws \EE_Error |
|
| 1885 | + */ |
|
| 1886 | + public function get_pretty($property) |
|
| 1887 | + { |
|
| 1888 | + if ($property === self::OPTION_NAME_UXIP) { |
|
| 1889 | + return $this->ee_ueip_optin ? 'yes' : 'no'; |
|
| 1890 | + } |
|
| 1891 | + return parent::get_pretty($property); |
|
| 1892 | + } |
|
| 1893 | + |
|
| 1894 | + |
|
| 1895 | + /** |
|
| 1896 | + * Currently used to ensure critical page urls have initial values saved to the db instead of any current set values |
|
| 1897 | + * on the object. |
|
| 1898 | + * |
|
| 1899 | + * @return array |
|
| 1900 | + */ |
|
| 1901 | + public function __sleep() |
|
| 1902 | + { |
|
| 1903 | + // reset all url properties |
|
| 1904 | + $this->_reset_urls(); |
|
| 1905 | + // return what to save to db |
|
| 1906 | + return array_keys(get_object_vars($this)); |
|
| 1907 | + } |
|
| 1908 | +} |
|
| 2292 | 1909 | |
| 2293 | - /** |
|
| 2294 | - * array of form names protected by ReCaptcha |
|
| 2295 | - * |
|
| 2296 | - * @var array $recaptcha_protected_forms |
|
| 2297 | - */ |
|
| 2298 | - public $recaptcha_protected_forms; |
|
| 1910 | +/** |
|
| 1911 | + * Config class for storing info on the Organization |
|
| 1912 | + */ |
|
| 1913 | +class EE_Organization_Config extends EE_Config_Base |
|
| 1914 | +{ |
|
| 2299 | 1915 | |
| 2300 | - /** |
|
| 2301 | - * ReCaptcha width |
|
| 2302 | - * |
|
| 2303 | - * @var int $recaptcha_width |
|
| 2304 | - * @deprecated |
|
| 2305 | - */ |
|
| 2306 | - public $recaptcha_width; |
|
| 1916 | + /** |
|
| 1917 | + * @var string $name |
|
| 1918 | + * eg EE4.1 |
|
| 1919 | + */ |
|
| 1920 | + public $name; |
|
| 1921 | + |
|
| 1922 | + /** |
|
| 1923 | + * @var string $address_1 |
|
| 1924 | + * eg 123 Onna Road |
|
| 1925 | + */ |
|
| 1926 | + public $address_1 = ''; |
|
| 1927 | + |
|
| 1928 | + /** |
|
| 1929 | + * @var string $address_2 |
|
| 1930 | + * eg PO Box 123 |
|
| 1931 | + */ |
|
| 1932 | + public $address_2 = ''; |
|
| 1933 | + |
|
| 1934 | + /** |
|
| 1935 | + * @var string $city |
|
| 1936 | + * eg Inna City |
|
| 1937 | + */ |
|
| 1938 | + public $city = ''; |
|
| 1939 | + |
|
| 1940 | + /** |
|
| 1941 | + * @var int $STA_ID |
|
| 1942 | + * eg 4 |
|
| 1943 | + */ |
|
| 1944 | + public $STA_ID = 0; |
|
| 1945 | + |
|
| 1946 | + /** |
|
| 1947 | + * @var string $CNT_ISO |
|
| 1948 | + * eg US |
|
| 1949 | + */ |
|
| 1950 | + public $CNT_ISO = ''; |
|
| 1951 | + |
|
| 1952 | + /** |
|
| 1953 | + * @var string $zip |
|
| 1954 | + * eg 12345 or V1A 2B3 |
|
| 1955 | + */ |
|
| 1956 | + public $zip = ''; |
|
| 1957 | + |
|
| 1958 | + /** |
|
| 1959 | + * @var string $email |
|
| 1960 | + * eg [email protected] |
|
| 1961 | + */ |
|
| 1962 | + public $email; |
|
| 1963 | + |
|
| 1964 | + /** |
|
| 1965 | + * @var string $phone |
|
| 1966 | + * eg. 111-111-1111 |
|
| 1967 | + */ |
|
| 1968 | + public $phone = ''; |
|
| 1969 | + |
|
| 1970 | + /** |
|
| 1971 | + * @var string $vat |
|
| 1972 | + * VAT/Tax Number |
|
| 1973 | + */ |
|
| 1974 | + public $vat = ''; |
|
| 1975 | + |
|
| 1976 | + /** |
|
| 1977 | + * @var string $logo_url |
|
| 1978 | + * eg http://www.somedomain.com/wp-content/uploads/kittehs.jpg |
|
| 1979 | + */ |
|
| 1980 | + public $logo_url = ''; |
|
| 1981 | + |
|
| 1982 | + /** |
|
| 1983 | + * The below are all various properties for holding links to organization social network profiles |
|
| 1984 | + * |
|
| 1985 | + * @var string |
|
| 1986 | + */ |
|
| 1987 | + /** |
|
| 1988 | + * facebook (facebook.com/profile.name) |
|
| 1989 | + * |
|
| 1990 | + * @var string |
|
| 1991 | + */ |
|
| 1992 | + public $facebook = ''; |
|
| 1993 | + |
|
| 1994 | + /** |
|
| 1995 | + * twitter (twitter.com/twitter_handle) |
|
| 1996 | + * |
|
| 1997 | + * @var string |
|
| 1998 | + */ |
|
| 1999 | + public $twitter = ''; |
|
| 2000 | + |
|
| 2001 | + /** |
|
| 2002 | + * linkedin (linkedin.com/in/profile_name) |
|
| 2003 | + * |
|
| 2004 | + * @var string |
|
| 2005 | + */ |
|
| 2006 | + public $linkedin = ''; |
|
| 2007 | + |
|
| 2008 | + /** |
|
| 2009 | + * pinterest (www.pinterest.com/profile_name) |
|
| 2010 | + * |
|
| 2011 | + * @var string |
|
| 2012 | + */ |
|
| 2013 | + public $pinterest = ''; |
|
| 2014 | + |
|
| 2015 | + /** |
|
| 2016 | + * google+ (google.com/+profileName) |
|
| 2017 | + * |
|
| 2018 | + * @var string |
|
| 2019 | + */ |
|
| 2020 | + public $google = ''; |
|
| 2021 | + |
|
| 2022 | + /** |
|
| 2023 | + * instagram (instagram.com/handle) |
|
| 2024 | + * |
|
| 2025 | + * @var string |
|
| 2026 | + */ |
|
| 2027 | + public $instagram = ''; |
|
| 2028 | + |
|
| 2029 | + |
|
| 2030 | + /** |
|
| 2031 | + * class constructor |
|
| 2032 | + * |
|
| 2033 | + * @access public |
|
| 2034 | + */ |
|
| 2035 | + public function __construct() |
|
| 2036 | + { |
|
| 2037 | + // set default organization settings |
|
| 2038 | + // decode HTML entities from the WP blogname, because it's stored in the DB with HTML entities encoded |
|
| 2039 | + $this->name = wp_specialchars_decode(get_bloginfo('name'), ENT_QUOTES); |
|
| 2040 | + $this->email = get_bloginfo('admin_email'); |
|
| 2041 | + } |
|
| 2042 | +} |
|
| 2307 | 2043 | |
| 2308 | - /** |
|
| 2309 | - * Whether or not invalid attempts to directly access the registration checkout page should be tracked. |
|
| 2310 | - * |
|
| 2311 | - * @var boolean $track_invalid_checkout_access |
|
| 2312 | - */ |
|
| 2313 | - protected $track_invalid_checkout_access = true; |
|
| 2044 | +/** |
|
| 2045 | + * Class for defining what's in the EE_Config relating to currency |
|
| 2046 | + */ |
|
| 2047 | +class EE_Currency_Config extends EE_Config_Base |
|
| 2048 | +{ |
|
| 2314 | 2049 | |
| 2315 | - /** |
|
| 2316 | - * Whether or not to show the privacy policy consent checkbox |
|
| 2317 | - * |
|
| 2318 | - * @var bool |
|
| 2319 | - */ |
|
| 2320 | - public $consent_checkbox_enabled; |
|
| 2050 | + /** |
|
| 2051 | + * @var string $code |
|
| 2052 | + * eg 'US' |
|
| 2053 | + */ |
|
| 2054 | + public $code; |
|
| 2055 | + |
|
| 2056 | + /** |
|
| 2057 | + * @var string $name |
|
| 2058 | + * eg 'Dollar' |
|
| 2059 | + */ |
|
| 2060 | + public $name; |
|
| 2061 | + |
|
| 2062 | + /** |
|
| 2063 | + * plural name |
|
| 2064 | + * |
|
| 2065 | + * @var string $plural |
|
| 2066 | + * eg 'Dollars' |
|
| 2067 | + */ |
|
| 2068 | + public $plural; |
|
| 2069 | + |
|
| 2070 | + /** |
|
| 2071 | + * currency sign |
|
| 2072 | + * |
|
| 2073 | + * @var string $sign |
|
| 2074 | + * eg '$' |
|
| 2075 | + */ |
|
| 2076 | + public $sign; |
|
| 2077 | + |
|
| 2078 | + /** |
|
| 2079 | + * Whether the currency sign should come before the number or not |
|
| 2080 | + * |
|
| 2081 | + * @var boolean $sign_b4 |
|
| 2082 | + */ |
|
| 2083 | + public $sign_b4; |
|
| 2084 | + |
|
| 2085 | + /** |
|
| 2086 | + * How many digits should come after the decimal place |
|
| 2087 | + * |
|
| 2088 | + * @var int $dec_plc |
|
| 2089 | + */ |
|
| 2090 | + public $dec_plc; |
|
| 2091 | + |
|
| 2092 | + /** |
|
| 2093 | + * Symbol to use for decimal mark |
|
| 2094 | + * |
|
| 2095 | + * @var string $dec_mrk |
|
| 2096 | + * eg '.' |
|
| 2097 | + */ |
|
| 2098 | + public $dec_mrk; |
|
| 2099 | + |
|
| 2100 | + /** |
|
| 2101 | + * Symbol to use for thousands |
|
| 2102 | + * |
|
| 2103 | + * @var string $thsnds |
|
| 2104 | + * eg ',' |
|
| 2105 | + */ |
|
| 2106 | + public $thsnds; |
|
| 2107 | + |
|
| 2108 | + |
|
| 2109 | + /** |
|
| 2110 | + * class constructor |
|
| 2111 | + * |
|
| 2112 | + * @access public |
|
| 2113 | + * @param string $CNT_ISO |
|
| 2114 | + * @throws \EE_Error |
|
| 2115 | + */ |
|
| 2116 | + public function __construct($CNT_ISO = '') |
|
| 2117 | + { |
|
| 2118 | + /** @var \EventEspresso\core\services\database\TableAnalysis $table_analysis */ |
|
| 2119 | + $table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true); |
|
| 2120 | + // get country code from organization settings or use default |
|
| 2121 | + $ORG_CNT = isset(EE_Registry::instance()->CFG->organization) |
|
| 2122 | + && EE_Registry::instance()->CFG->organization instanceof EE_Organization_Config |
|
| 2123 | + ? EE_Registry::instance()->CFG->organization->CNT_ISO |
|
| 2124 | + : ''; |
|
| 2125 | + // but override if requested |
|
| 2126 | + $CNT_ISO = ! empty($CNT_ISO) ? $CNT_ISO : $ORG_CNT; |
|
| 2127 | + // so if that all went well, and we are not in M-Mode (cuz you can't query the db in M-Mode) and double-check the countries table exists |
|
| 2128 | + if (! empty($CNT_ISO) |
|
| 2129 | + && EE_Maintenance_Mode::instance()->models_can_query() |
|
| 2130 | + && $table_analysis->tableExists(EE_Registry::instance()->load_model('Country')->table()) |
|
| 2131 | + ) { |
|
| 2132 | + // retrieve the country settings from the db, just in case they have been customized |
|
| 2133 | + $country = EE_Registry::instance()->load_model('Country')->get_one_by_ID($CNT_ISO); |
|
| 2134 | + if ($country instanceof EE_Country) { |
|
| 2135 | + $this->code = $country->currency_code(); // currency code: USD, CAD, EUR |
|
| 2136 | + $this->name = $country->currency_name_single(); // Dollar |
|
| 2137 | + $this->plural = $country->currency_name_plural(); // Dollars |
|
| 2138 | + $this->sign = $country->currency_sign(); // currency sign: $ |
|
| 2139 | + $this->sign_b4 = $country->currency_sign_before( |
|
| 2140 | + ); // currency sign before or after: $TRUE or FALSE$ |
|
| 2141 | + $this->dec_plc = $country->currency_decimal_places(); // decimal places: 2 = 0.00 3 = 0.000 |
|
| 2142 | + $this->dec_mrk = $country->currency_decimal_mark( |
|
| 2143 | + ); // decimal mark: (comma) ',' = 0,01 or (decimal) '.' = 0.01 |
|
| 2144 | + $this->thsnds = $country->currency_thousands_separator( |
|
| 2145 | + ); // thousands separator: (comma) ',' = 1,000 or (decimal) '.' = 1.000 |
|
| 2146 | + } |
|
| 2147 | + } |
|
| 2148 | + // fallback to hardcoded defaults, in case the above failed |
|
| 2149 | + if (empty($this->code)) { |
|
| 2150 | + // set default currency settings |
|
| 2151 | + $this->code = 'USD'; // currency code: USD, CAD, EUR |
|
| 2152 | + $this->name = __('Dollar', 'event_espresso'); // Dollar |
|
| 2153 | + $this->plural = __('Dollars', 'event_espresso'); // Dollars |
|
| 2154 | + $this->sign = '$'; // currency sign: $ |
|
| 2155 | + $this->sign_b4 = true; // currency sign before or after: $TRUE or FALSE$ |
|
| 2156 | + $this->dec_plc = 2; // decimal places: 2 = 0.00 3 = 0.000 |
|
| 2157 | + $this->dec_mrk = '.'; // decimal mark: (comma) ',' = 0,01 or (decimal) '.' = 0.01 |
|
| 2158 | + $this->thsnds = ','; // thousands separator: (comma) ',' = 1,000 or (decimal) '.' = 1.000 |
|
| 2159 | + } |
|
| 2160 | + } |
|
| 2161 | +} |
|
| 2321 | 2162 | |
| 2322 | - /** |
|
| 2323 | - * Label text to show on the checkbox |
|
| 2324 | - * |
|
| 2325 | - * @var string |
|
| 2326 | - */ |
|
| 2327 | - public $consent_checkbox_label_text; |
|
| 2163 | +/** |
|
| 2164 | + * Class for defining what's in the EE_Config relating to registration settings |
|
| 2165 | + */ |
|
| 2166 | +class EE_Registration_Config extends EE_Config_Base |
|
| 2167 | +{ |
|
| 2328 | 2168 | |
| 2329 | - /* |
|
| 2169 | + /** |
|
| 2170 | + * Default registration status |
|
| 2171 | + * |
|
| 2172 | + * @var string $default_STS_ID |
|
| 2173 | + * eg 'RPP' |
|
| 2174 | + */ |
|
| 2175 | + public $default_STS_ID; |
|
| 2176 | + |
|
| 2177 | + /** |
|
| 2178 | + * For new events, this will be the default value for the maximum number of tickets (equivalent to maximum number of |
|
| 2179 | + * registrations) |
|
| 2180 | + * |
|
| 2181 | + * @var int |
|
| 2182 | + */ |
|
| 2183 | + public $default_maximum_number_of_tickets; |
|
| 2184 | + |
|
| 2185 | + /** |
|
| 2186 | + * level of validation to apply to email addresses |
|
| 2187 | + * |
|
| 2188 | + * @var string $email_validation_level |
|
| 2189 | + * options: 'basic', 'wp_default', 'i18n', 'i18n_dns' |
|
| 2190 | + */ |
|
| 2191 | + public $email_validation_level; |
|
| 2192 | + |
|
| 2193 | + /** |
|
| 2194 | + * whether or not to show alternate payment options during the reg process if payment status is pending |
|
| 2195 | + * |
|
| 2196 | + * @var boolean $show_pending_payment_options |
|
| 2197 | + */ |
|
| 2198 | + public $show_pending_payment_options; |
|
| 2199 | + |
|
| 2200 | + /** |
|
| 2201 | + * Whether to skip the registration confirmation page |
|
| 2202 | + * |
|
| 2203 | + * @var boolean $skip_reg_confirmation |
|
| 2204 | + */ |
|
| 2205 | + public $skip_reg_confirmation; |
|
| 2206 | + |
|
| 2207 | + /** |
|
| 2208 | + * an array of SPCO reg steps where: |
|
| 2209 | + * the keys denotes the reg step order |
|
| 2210 | + * each element consists of an array with the following elements: |
|
| 2211 | + * "file_path" => the file path to the EE_SPCO_Reg_Step class |
|
| 2212 | + * "class_name" => the specific EE_SPCO_Reg_Step child class name |
|
| 2213 | + * "slug" => the URL param used to trigger the reg step |
|
| 2214 | + * |
|
| 2215 | + * @var array $reg_steps |
|
| 2216 | + */ |
|
| 2217 | + public $reg_steps; |
|
| 2218 | + |
|
| 2219 | + /** |
|
| 2220 | + * Whether registration confirmation should be the last page of SPCO |
|
| 2221 | + * |
|
| 2222 | + * @var boolean $reg_confirmation_last |
|
| 2223 | + */ |
|
| 2224 | + public $reg_confirmation_last; |
|
| 2225 | + |
|
| 2226 | + /** |
|
| 2227 | + * Whether or not to enable the EE Bot Trap |
|
| 2228 | + * |
|
| 2229 | + * @var boolean $use_bot_trap |
|
| 2230 | + */ |
|
| 2231 | + public $use_bot_trap; |
|
| 2232 | + |
|
| 2233 | + /** |
|
| 2234 | + * Whether or not to encrypt some data sent by the EE Bot Trap |
|
| 2235 | + * |
|
| 2236 | + * @var boolean $use_encryption |
|
| 2237 | + */ |
|
| 2238 | + public $use_encryption; |
|
| 2239 | + |
|
| 2240 | + /** |
|
| 2241 | + * Whether or not to use ReCaptcha |
|
| 2242 | + * |
|
| 2243 | + * @var boolean $use_captcha |
|
| 2244 | + */ |
|
| 2245 | + public $use_captcha; |
|
| 2246 | + |
|
| 2247 | + /** |
|
| 2248 | + * ReCaptcha Theme |
|
| 2249 | + * |
|
| 2250 | + * @var string $recaptcha_theme |
|
| 2251 | + * options: 'dark', 'light', 'invisible' |
|
| 2252 | + */ |
|
| 2253 | + public $recaptcha_theme; |
|
| 2254 | + |
|
| 2255 | + /** |
|
| 2256 | + * ReCaptcha Badge - determines the position of the reCAPTCHA badge if using Invisible ReCaptcha. |
|
| 2257 | + * |
|
| 2258 | + * @var string $recaptcha_badge |
|
| 2259 | + * options: 'bottomright', 'bottomleft', 'inline' |
|
| 2260 | + */ |
|
| 2261 | + public $recaptcha_badge; |
|
| 2262 | + |
|
| 2263 | + /** |
|
| 2264 | + * ReCaptcha Type |
|
| 2265 | + * |
|
| 2266 | + * @var string $recaptcha_type |
|
| 2267 | + * options: 'audio', 'image' |
|
| 2268 | + */ |
|
| 2269 | + public $recaptcha_type; |
|
| 2270 | + |
|
| 2271 | + /** |
|
| 2272 | + * ReCaptcha language |
|
| 2273 | + * |
|
| 2274 | + * @var string $recaptcha_language |
|
| 2275 | + * eg 'en' |
|
| 2276 | + */ |
|
| 2277 | + public $recaptcha_language; |
|
| 2278 | + |
|
| 2279 | + /** |
|
| 2280 | + * ReCaptcha public key |
|
| 2281 | + * |
|
| 2282 | + * @var string $recaptcha_publickey |
|
| 2283 | + */ |
|
| 2284 | + public $recaptcha_publickey; |
|
| 2285 | + |
|
| 2286 | + /** |
|
| 2287 | + * ReCaptcha private key |
|
| 2288 | + * |
|
| 2289 | + * @var string $recaptcha_privatekey |
|
| 2290 | + */ |
|
| 2291 | + public $recaptcha_privatekey; |
|
| 2292 | + |
|
| 2293 | + /** |
|
| 2294 | + * array of form names protected by ReCaptcha |
|
| 2295 | + * |
|
| 2296 | + * @var array $recaptcha_protected_forms |
|
| 2297 | + */ |
|
| 2298 | + public $recaptcha_protected_forms; |
|
| 2299 | + |
|
| 2300 | + /** |
|
| 2301 | + * ReCaptcha width |
|
| 2302 | + * |
|
| 2303 | + * @var int $recaptcha_width |
|
| 2304 | + * @deprecated |
|
| 2305 | + */ |
|
| 2306 | + public $recaptcha_width; |
|
| 2307 | + |
|
| 2308 | + /** |
|
| 2309 | + * Whether or not invalid attempts to directly access the registration checkout page should be tracked. |
|
| 2310 | + * |
|
| 2311 | + * @var boolean $track_invalid_checkout_access |
|
| 2312 | + */ |
|
| 2313 | + protected $track_invalid_checkout_access = true; |
|
| 2314 | + |
|
| 2315 | + /** |
|
| 2316 | + * Whether or not to show the privacy policy consent checkbox |
|
| 2317 | + * |
|
| 2318 | + * @var bool |
|
| 2319 | + */ |
|
| 2320 | + public $consent_checkbox_enabled; |
|
| 2321 | + |
|
| 2322 | + /** |
|
| 2323 | + * Label text to show on the checkbox |
|
| 2324 | + * |
|
| 2325 | + * @var string |
|
| 2326 | + */ |
|
| 2327 | + public $consent_checkbox_label_text; |
|
| 2328 | + |
|
| 2329 | + /* |
|
| 2330 | 2330 | * String describing how long to keep payment logs. Passed into DateTime constructor |
| 2331 | 2331 | * @var string |
| 2332 | 2332 | */ |
| 2333 | - public $gateway_log_lifespan = '1 week'; |
|
| 2334 | - |
|
| 2335 | - |
|
| 2336 | - /** |
|
| 2337 | - * class constructor |
|
| 2338 | - * |
|
| 2339 | - * @access public |
|
| 2340 | - */ |
|
| 2341 | - public function __construct() |
|
| 2342 | - { |
|
| 2343 | - // set default registration settings |
|
| 2344 | - $this->default_STS_ID = EEM_Registration::status_id_pending_payment; |
|
| 2345 | - $this->email_validation_level = 'wp_default'; |
|
| 2346 | - $this->show_pending_payment_options = true; |
|
| 2347 | - $this->skip_reg_confirmation = true; |
|
| 2348 | - $this->reg_steps = array(); |
|
| 2349 | - $this->reg_confirmation_last = false; |
|
| 2350 | - $this->use_bot_trap = true; |
|
| 2351 | - $this->use_encryption = true; |
|
| 2352 | - $this->use_captcha = false; |
|
| 2353 | - $this->recaptcha_theme = 'light'; |
|
| 2354 | - $this->recaptcha_badge = 'bottomleft'; |
|
| 2355 | - $this->recaptcha_type = 'image'; |
|
| 2356 | - $this->recaptcha_language = 'en'; |
|
| 2357 | - $this->recaptcha_publickey = null; |
|
| 2358 | - $this->recaptcha_privatekey = null; |
|
| 2359 | - $this->recaptcha_protected_forms = array(); |
|
| 2360 | - $this->recaptcha_width = 500; |
|
| 2361 | - $this->default_maximum_number_of_tickets = 10; |
|
| 2362 | - $this->consent_checkbox_enabled = false; |
|
| 2363 | - $this->consent_checkbox_label_text = ''; |
|
| 2364 | - $this->gateway_log_lifespan = '7 days'; |
|
| 2365 | - } |
|
| 2366 | - |
|
| 2367 | - |
|
| 2368 | - /** |
|
| 2369 | - * This is called by the config loader and hooks are initialized AFTER the config has been populated. |
|
| 2370 | - * |
|
| 2371 | - * @since 4.8.8.rc.019 |
|
| 2372 | - */ |
|
| 2373 | - public function do_hooks() |
|
| 2374 | - { |
|
| 2375 | - add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_reg_status_on_EEM_Event')); |
|
| 2376 | - add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_max_ticket_on_EEM_Event')); |
|
| 2377 | - add_action('setup_theme', array($this, 'setDefaultCheckboxLabelText')); |
|
| 2378 | - } |
|
| 2379 | - |
|
| 2380 | - |
|
| 2381 | - /** |
|
| 2382 | - * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the |
|
| 2383 | - * EVT_default_registration_status field matches the config setting for default_STS_ID. |
|
| 2384 | - */ |
|
| 2385 | - public function set_default_reg_status_on_EEM_Event() |
|
| 2386 | - { |
|
| 2387 | - EEM_Event::set_default_reg_status($this->default_STS_ID); |
|
| 2388 | - } |
|
| 2389 | - |
|
| 2390 | - |
|
| 2391 | - /** |
|
| 2392 | - * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the EVT_additional_limit field |
|
| 2393 | - * for Events matches the config setting for default_maximum_number_of_tickets |
|
| 2394 | - */ |
|
| 2395 | - public function set_default_max_ticket_on_EEM_Event() |
|
| 2396 | - { |
|
| 2397 | - EEM_Event::set_default_additional_limit($this->default_maximum_number_of_tickets); |
|
| 2398 | - } |
|
| 2399 | - |
|
| 2400 | - |
|
| 2401 | - /** |
|
| 2402 | - * Sets the default consent checkbox text. This needs to be done a bit later than when EE_Registration_Config is |
|
| 2403 | - * constructed because that happens before we can get the privacy policy page's permalink. |
|
| 2404 | - * |
|
| 2405 | - * @throws InvalidArgumentException |
|
| 2406 | - * @throws \EventEspresso\core\exceptions\InvalidDataTypeException |
|
| 2407 | - * @throws \EventEspresso\core\exceptions\InvalidInterfaceException |
|
| 2408 | - */ |
|
| 2409 | - public function setDefaultCheckboxLabelText() |
|
| 2410 | - { |
|
| 2411 | - if ($this->getConsentCheckboxLabelText() === null |
|
| 2412 | - || $this->getConsentCheckboxLabelText() === '') { |
|
| 2413 | - $opening_a_tag = ''; |
|
| 2414 | - $closing_a_tag = ''; |
|
| 2415 | - if (function_exists('get_privacy_policy_url')) { |
|
| 2416 | - $privacy_page_url = get_privacy_policy_url(); |
|
| 2417 | - if (! empty($privacy_page_url)) { |
|
| 2418 | - $opening_a_tag = '<a href="' . $privacy_page_url . '" target="_blank">'; |
|
| 2419 | - $closing_a_tag = '</a>'; |
|
| 2420 | - } |
|
| 2421 | - } |
|
| 2422 | - $loader = LoaderFactory::getLoader(); |
|
| 2423 | - $org_config = $loader->getShared('EE_Organization_Config'); |
|
| 2424 | - /** |
|
| 2425 | - * @var $org_config EE_Organization_Config |
|
| 2426 | - */ |
|
| 2427 | - |
|
| 2428 | - $this->setConsentCheckboxLabelText( |
|
| 2429 | - sprintf( |
|
| 2430 | - esc_html__( |
|
| 2431 | - 'I consent to %1$s storing and using my personal information, according to their %2$sprivacy policy%3$s.', |
|
| 2432 | - 'event_espresso' |
|
| 2433 | - ), |
|
| 2434 | - $org_config->name, |
|
| 2435 | - $opening_a_tag, |
|
| 2436 | - $closing_a_tag |
|
| 2437 | - ) |
|
| 2438 | - ); |
|
| 2439 | - } |
|
| 2440 | - } |
|
| 2441 | - |
|
| 2442 | - |
|
| 2443 | - /** |
|
| 2444 | - * @return boolean |
|
| 2445 | - */ |
|
| 2446 | - public function track_invalid_checkout_access() |
|
| 2447 | - { |
|
| 2448 | - return $this->track_invalid_checkout_access; |
|
| 2449 | - } |
|
| 2450 | - |
|
| 2451 | - |
|
| 2452 | - /** |
|
| 2453 | - * @param boolean $track_invalid_checkout_access |
|
| 2454 | - */ |
|
| 2455 | - public function set_track_invalid_checkout_access($track_invalid_checkout_access) |
|
| 2456 | - { |
|
| 2457 | - $this->track_invalid_checkout_access = filter_var( |
|
| 2458 | - $track_invalid_checkout_access, |
|
| 2459 | - FILTER_VALIDATE_BOOLEAN |
|
| 2460 | - ); |
|
| 2461 | - } |
|
| 2462 | - |
|
| 2463 | - |
|
| 2464 | - /** |
|
| 2465 | - * Gets the options to make availalbe for the gateway log lifespan |
|
| 2466 | - * @return array |
|
| 2467 | - */ |
|
| 2468 | - public function gatewayLogLifespanOptions() |
|
| 2469 | - { |
|
| 2470 | - return (array) apply_filters( |
|
| 2471 | - 'FHEE_EE_Admin_Config__gatewayLogLifespanOptions', |
|
| 2472 | - array( |
|
| 2473 | - '1 second' => esc_html__('Don\'t Log At All', 'event_espresso'), |
|
| 2474 | - '1 day' => esc_html__('1 Day', 'event_espresso'), |
|
| 2475 | - '7 days' => esc_html__('7 Days', 'event_espresso'), |
|
| 2476 | - '14 days' => esc_html__('14 Days', 'event_espresso'), |
|
| 2477 | - '30 days' => esc_html__('30 Days', 'event_espresso') |
|
| 2478 | - ) |
|
| 2479 | - ); |
|
| 2480 | - } |
|
| 2481 | - |
|
| 2482 | - |
|
| 2483 | - /** |
|
| 2484 | - * @return bool |
|
| 2485 | - */ |
|
| 2486 | - public function isConsentCheckboxEnabled() |
|
| 2487 | - { |
|
| 2488 | - return $this->consent_checkbox_enabled; |
|
| 2489 | - } |
|
| 2490 | - |
|
| 2491 | - |
|
| 2492 | - /** |
|
| 2493 | - * @param bool $consent_checkbox_enabled |
|
| 2494 | - */ |
|
| 2495 | - public function setConsentCheckboxEnabled($consent_checkbox_enabled) |
|
| 2496 | - { |
|
| 2497 | - $this->consent_checkbox_enabled = filter_var( |
|
| 2498 | - $consent_checkbox_enabled, |
|
| 2499 | - FILTER_VALIDATE_BOOLEAN |
|
| 2500 | - ); |
|
| 2501 | - } |
|
| 2502 | - |
|
| 2503 | - |
|
| 2504 | - /** |
|
| 2505 | - * @return string |
|
| 2506 | - */ |
|
| 2507 | - public function getConsentCheckboxLabelText() |
|
| 2508 | - { |
|
| 2509 | - return $this->consent_checkbox_label_text; |
|
| 2510 | - } |
|
| 2511 | - |
|
| 2512 | - |
|
| 2513 | - /** |
|
| 2514 | - * @param string $consent_checkbox_label_text |
|
| 2515 | - */ |
|
| 2516 | - public function setConsentCheckboxLabelText($consent_checkbox_label_text) |
|
| 2517 | - { |
|
| 2518 | - $this->consent_checkbox_label_text = (string) $consent_checkbox_label_text; |
|
| 2519 | - } |
|
| 2333 | + public $gateway_log_lifespan = '1 week'; |
|
| 2334 | + |
|
| 2335 | + |
|
| 2336 | + /** |
|
| 2337 | + * class constructor |
|
| 2338 | + * |
|
| 2339 | + * @access public |
|
| 2340 | + */ |
|
| 2341 | + public function __construct() |
|
| 2342 | + { |
|
| 2343 | + // set default registration settings |
|
| 2344 | + $this->default_STS_ID = EEM_Registration::status_id_pending_payment; |
|
| 2345 | + $this->email_validation_level = 'wp_default'; |
|
| 2346 | + $this->show_pending_payment_options = true; |
|
| 2347 | + $this->skip_reg_confirmation = true; |
|
| 2348 | + $this->reg_steps = array(); |
|
| 2349 | + $this->reg_confirmation_last = false; |
|
| 2350 | + $this->use_bot_trap = true; |
|
| 2351 | + $this->use_encryption = true; |
|
| 2352 | + $this->use_captcha = false; |
|
| 2353 | + $this->recaptcha_theme = 'light'; |
|
| 2354 | + $this->recaptcha_badge = 'bottomleft'; |
|
| 2355 | + $this->recaptcha_type = 'image'; |
|
| 2356 | + $this->recaptcha_language = 'en'; |
|
| 2357 | + $this->recaptcha_publickey = null; |
|
| 2358 | + $this->recaptcha_privatekey = null; |
|
| 2359 | + $this->recaptcha_protected_forms = array(); |
|
| 2360 | + $this->recaptcha_width = 500; |
|
| 2361 | + $this->default_maximum_number_of_tickets = 10; |
|
| 2362 | + $this->consent_checkbox_enabled = false; |
|
| 2363 | + $this->consent_checkbox_label_text = ''; |
|
| 2364 | + $this->gateway_log_lifespan = '7 days'; |
|
| 2365 | + } |
|
| 2366 | + |
|
| 2367 | + |
|
| 2368 | + /** |
|
| 2369 | + * This is called by the config loader and hooks are initialized AFTER the config has been populated. |
|
| 2370 | + * |
|
| 2371 | + * @since 4.8.8.rc.019 |
|
| 2372 | + */ |
|
| 2373 | + public function do_hooks() |
|
| 2374 | + { |
|
| 2375 | + add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_reg_status_on_EEM_Event')); |
|
| 2376 | + add_action('AHEE__EE_Config___load_core_config__end', array($this, 'set_default_max_ticket_on_EEM_Event')); |
|
| 2377 | + add_action('setup_theme', array($this, 'setDefaultCheckboxLabelText')); |
|
| 2378 | + } |
|
| 2379 | + |
|
| 2380 | + |
|
| 2381 | + /** |
|
| 2382 | + * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the |
|
| 2383 | + * EVT_default_registration_status field matches the config setting for default_STS_ID. |
|
| 2384 | + */ |
|
| 2385 | + public function set_default_reg_status_on_EEM_Event() |
|
| 2386 | + { |
|
| 2387 | + EEM_Event::set_default_reg_status($this->default_STS_ID); |
|
| 2388 | + } |
|
| 2389 | + |
|
| 2390 | + |
|
| 2391 | + /** |
|
| 2392 | + * Hooked into `AHEE__EE_Config___load_core_config__end` to ensure the default for the EVT_additional_limit field |
|
| 2393 | + * for Events matches the config setting for default_maximum_number_of_tickets |
|
| 2394 | + */ |
|
| 2395 | + public function set_default_max_ticket_on_EEM_Event() |
|
| 2396 | + { |
|
| 2397 | + EEM_Event::set_default_additional_limit($this->default_maximum_number_of_tickets); |
|
| 2398 | + } |
|
| 2399 | + |
|
| 2400 | + |
|
| 2401 | + /** |
|
| 2402 | + * Sets the default consent checkbox text. This needs to be done a bit later than when EE_Registration_Config is |
|
| 2403 | + * constructed because that happens before we can get the privacy policy page's permalink. |
|
| 2404 | + * |
|
| 2405 | + * @throws InvalidArgumentException |
|
| 2406 | + * @throws \EventEspresso\core\exceptions\InvalidDataTypeException |
|
| 2407 | + * @throws \EventEspresso\core\exceptions\InvalidInterfaceException |
|
| 2408 | + */ |
|
| 2409 | + public function setDefaultCheckboxLabelText() |
|
| 2410 | + { |
|
| 2411 | + if ($this->getConsentCheckboxLabelText() === null |
|
| 2412 | + || $this->getConsentCheckboxLabelText() === '') { |
|
| 2413 | + $opening_a_tag = ''; |
|
| 2414 | + $closing_a_tag = ''; |
|
| 2415 | + if (function_exists('get_privacy_policy_url')) { |
|
| 2416 | + $privacy_page_url = get_privacy_policy_url(); |
|
| 2417 | + if (! empty($privacy_page_url)) { |
|
| 2418 | + $opening_a_tag = '<a href="' . $privacy_page_url . '" target="_blank">'; |
|
| 2419 | + $closing_a_tag = '</a>'; |
|
| 2420 | + } |
|
| 2421 | + } |
|
| 2422 | + $loader = LoaderFactory::getLoader(); |
|
| 2423 | + $org_config = $loader->getShared('EE_Organization_Config'); |
|
| 2424 | + /** |
|
| 2425 | + * @var $org_config EE_Organization_Config |
|
| 2426 | + */ |
|
| 2427 | + |
|
| 2428 | + $this->setConsentCheckboxLabelText( |
|
| 2429 | + sprintf( |
|
| 2430 | + esc_html__( |
|
| 2431 | + 'I consent to %1$s storing and using my personal information, according to their %2$sprivacy policy%3$s.', |
|
| 2432 | + 'event_espresso' |
|
| 2433 | + ), |
|
| 2434 | + $org_config->name, |
|
| 2435 | + $opening_a_tag, |
|
| 2436 | + $closing_a_tag |
|
| 2437 | + ) |
|
| 2438 | + ); |
|
| 2439 | + } |
|
| 2440 | + } |
|
| 2441 | + |
|
| 2442 | + |
|
| 2443 | + /** |
|
| 2444 | + * @return boolean |
|
| 2445 | + */ |
|
| 2446 | + public function track_invalid_checkout_access() |
|
| 2447 | + { |
|
| 2448 | + return $this->track_invalid_checkout_access; |
|
| 2449 | + } |
|
| 2450 | + |
|
| 2451 | + |
|
| 2452 | + /** |
|
| 2453 | + * @param boolean $track_invalid_checkout_access |
|
| 2454 | + */ |
|
| 2455 | + public function set_track_invalid_checkout_access($track_invalid_checkout_access) |
|
| 2456 | + { |
|
| 2457 | + $this->track_invalid_checkout_access = filter_var( |
|
| 2458 | + $track_invalid_checkout_access, |
|
| 2459 | + FILTER_VALIDATE_BOOLEAN |
|
| 2460 | + ); |
|
| 2461 | + } |
|
| 2462 | + |
|
| 2463 | + |
|
| 2464 | + /** |
|
| 2465 | + * Gets the options to make availalbe for the gateway log lifespan |
|
| 2466 | + * @return array |
|
| 2467 | + */ |
|
| 2468 | + public function gatewayLogLifespanOptions() |
|
| 2469 | + { |
|
| 2470 | + return (array) apply_filters( |
|
| 2471 | + 'FHEE_EE_Admin_Config__gatewayLogLifespanOptions', |
|
| 2472 | + array( |
|
| 2473 | + '1 second' => esc_html__('Don\'t Log At All', 'event_espresso'), |
|
| 2474 | + '1 day' => esc_html__('1 Day', 'event_espresso'), |
|
| 2475 | + '7 days' => esc_html__('7 Days', 'event_espresso'), |
|
| 2476 | + '14 days' => esc_html__('14 Days', 'event_espresso'), |
|
| 2477 | + '30 days' => esc_html__('30 Days', 'event_espresso') |
|
| 2478 | + ) |
|
| 2479 | + ); |
|
| 2480 | + } |
|
| 2481 | + |
|
| 2482 | + |
|
| 2483 | + /** |
|
| 2484 | + * @return bool |
|
| 2485 | + */ |
|
| 2486 | + public function isConsentCheckboxEnabled() |
|
| 2487 | + { |
|
| 2488 | + return $this->consent_checkbox_enabled; |
|
| 2489 | + } |
|
| 2490 | + |
|
| 2491 | + |
|
| 2492 | + /** |
|
| 2493 | + * @param bool $consent_checkbox_enabled |
|
| 2494 | + */ |
|
| 2495 | + public function setConsentCheckboxEnabled($consent_checkbox_enabled) |
|
| 2496 | + { |
|
| 2497 | + $this->consent_checkbox_enabled = filter_var( |
|
| 2498 | + $consent_checkbox_enabled, |
|
| 2499 | + FILTER_VALIDATE_BOOLEAN |
|
| 2500 | + ); |
|
| 2501 | + } |
|
| 2502 | + |
|
| 2503 | + |
|
| 2504 | + /** |
|
| 2505 | + * @return string |
|
| 2506 | + */ |
|
| 2507 | + public function getConsentCheckboxLabelText() |
|
| 2508 | + { |
|
| 2509 | + return $this->consent_checkbox_label_text; |
|
| 2510 | + } |
|
| 2511 | + |
|
| 2512 | + |
|
| 2513 | + /** |
|
| 2514 | + * @param string $consent_checkbox_label_text |
|
| 2515 | + */ |
|
| 2516 | + public function setConsentCheckboxLabelText($consent_checkbox_label_text) |
|
| 2517 | + { |
|
| 2518 | + $this->consent_checkbox_label_text = (string) $consent_checkbox_label_text; |
|
| 2519 | + } |
|
| 2520 | 2520 | } |
| 2521 | 2521 | |
| 2522 | 2522 | /** |
@@ -2525,157 +2525,157 @@ discard block |
||
| 2525 | 2525 | class EE_Admin_Config extends EE_Config_Base |
| 2526 | 2526 | { |
| 2527 | 2527 | |
| 2528 | - /** |
|
| 2529 | - * @var boolean $use_personnel_manager |
|
| 2530 | - */ |
|
| 2531 | - public $use_personnel_manager; |
|
| 2532 | - |
|
| 2533 | - /** |
|
| 2534 | - * @var boolean $use_dashboard_widget |
|
| 2535 | - */ |
|
| 2536 | - public $use_dashboard_widget; |
|
| 2537 | - |
|
| 2538 | - /** |
|
| 2539 | - * @var int $events_in_dashboard |
|
| 2540 | - */ |
|
| 2541 | - public $events_in_dashboard; |
|
| 2542 | - |
|
| 2543 | - /** |
|
| 2544 | - * @var boolean $use_event_timezones |
|
| 2545 | - */ |
|
| 2546 | - public $use_event_timezones; |
|
| 2547 | - |
|
| 2548 | - /** |
|
| 2549 | - * @var boolean $use_full_logging |
|
| 2550 | - */ |
|
| 2551 | - public $use_full_logging; |
|
| 2552 | - |
|
| 2553 | - /** |
|
| 2554 | - * @var string $log_file_name |
|
| 2555 | - */ |
|
| 2556 | - public $log_file_name; |
|
| 2557 | - |
|
| 2558 | - /** |
|
| 2559 | - * @var string $debug_file_name |
|
| 2560 | - */ |
|
| 2561 | - public $debug_file_name; |
|
| 2562 | - |
|
| 2563 | - /** |
|
| 2564 | - * @var boolean $use_remote_logging |
|
| 2565 | - */ |
|
| 2566 | - public $use_remote_logging; |
|
| 2567 | - |
|
| 2568 | - /** |
|
| 2569 | - * @var string $remote_logging_url |
|
| 2570 | - */ |
|
| 2571 | - public $remote_logging_url; |
|
| 2572 | - |
|
| 2573 | - /** |
|
| 2574 | - * @var boolean $show_reg_footer |
|
| 2575 | - */ |
|
| 2576 | - public $show_reg_footer; |
|
| 2577 | - |
|
| 2578 | - /** |
|
| 2579 | - * @var string $affiliate_id |
|
| 2580 | - */ |
|
| 2581 | - public $affiliate_id; |
|
| 2582 | - |
|
| 2583 | - /** |
|
| 2584 | - * help tours on or off (global setting) |
|
| 2585 | - * |
|
| 2586 | - * @var boolean |
|
| 2587 | - */ |
|
| 2588 | - public $help_tour_activation; |
|
| 2589 | - |
|
| 2590 | - /** |
|
| 2591 | - * adds extra layer of encoding to session data to prevent serialization errors |
|
| 2592 | - * but is incompatible with some server configuration errors |
|
| 2593 | - * if you get "500 internal server errors" during registration, try turning this on |
|
| 2594 | - * if you get PHP fatal errors regarding base 64 methods not defined, then turn this off |
|
| 2595 | - * |
|
| 2596 | - * @var boolean $encode_session_data |
|
| 2597 | - */ |
|
| 2598 | - private $encode_session_data = false; |
|
| 2599 | - |
|
| 2600 | - |
|
| 2601 | - /** |
|
| 2602 | - * class constructor |
|
| 2603 | - * |
|
| 2604 | - * @access public |
|
| 2605 | - */ |
|
| 2606 | - public function __construct() |
|
| 2607 | - { |
|
| 2608 | - // set default general admin settings |
|
| 2609 | - $this->use_personnel_manager = true; |
|
| 2610 | - $this->use_dashboard_widget = true; |
|
| 2611 | - $this->events_in_dashboard = 30; |
|
| 2612 | - $this->use_event_timezones = false; |
|
| 2613 | - $this->use_full_logging = false; |
|
| 2614 | - $this->use_remote_logging = false; |
|
| 2615 | - $this->remote_logging_url = null; |
|
| 2616 | - $this->show_reg_footer = apply_filters( |
|
| 2617 | - 'FHEE__EE_Admin_Config__show_reg_footer__default', |
|
| 2618 | - false |
|
| 2619 | - ); |
|
| 2620 | - $this->affiliate_id = 'default'; |
|
| 2621 | - $this->help_tour_activation = true; |
|
| 2622 | - $this->encode_session_data = false; |
|
| 2623 | - } |
|
| 2624 | - |
|
| 2625 | - |
|
| 2626 | - /** |
|
| 2627 | - * @param bool $reset |
|
| 2628 | - * @return string |
|
| 2629 | - */ |
|
| 2630 | - public function log_file_name($reset = false) |
|
| 2631 | - { |
|
| 2632 | - if (empty($this->log_file_name) || $reset) { |
|
| 2633 | - $this->log_file_name = sanitize_key('espresso_log_' . md5(uniqid('', true))) . '.txt'; |
|
| 2634 | - EE_Config::instance()->update_espresso_config(false, false); |
|
| 2635 | - } |
|
| 2636 | - return $this->log_file_name; |
|
| 2637 | - } |
|
| 2638 | - |
|
| 2639 | - |
|
| 2640 | - /** |
|
| 2641 | - * @param bool $reset |
|
| 2642 | - * @return string |
|
| 2643 | - */ |
|
| 2644 | - public function debug_file_name($reset = false) |
|
| 2645 | - { |
|
| 2646 | - if (empty($this->debug_file_name) || $reset) { |
|
| 2647 | - $this->debug_file_name = sanitize_key('espresso_debug_' . md5(uniqid('', true))) . '.txt'; |
|
| 2648 | - EE_Config::instance()->update_espresso_config(false, false); |
|
| 2649 | - } |
|
| 2650 | - return $this->debug_file_name; |
|
| 2651 | - } |
|
| 2652 | - |
|
| 2653 | - |
|
| 2654 | - /** |
|
| 2655 | - * @return string |
|
| 2656 | - */ |
|
| 2657 | - public function affiliate_id() |
|
| 2658 | - { |
|
| 2659 | - return ! empty($this->affiliate_id) ? $this->affiliate_id : 'default'; |
|
| 2660 | - } |
|
| 2661 | - |
|
| 2662 | - |
|
| 2663 | - /** |
|
| 2664 | - * @return boolean |
|
| 2665 | - */ |
|
| 2666 | - public function encode_session_data() |
|
| 2667 | - { |
|
| 2668 | - return filter_var($this->encode_session_data, FILTER_VALIDATE_BOOLEAN); |
|
| 2669 | - } |
|
| 2670 | - |
|
| 2671 | - |
|
| 2672 | - /** |
|
| 2673 | - * @param boolean $encode_session_data |
|
| 2674 | - */ |
|
| 2675 | - public function set_encode_session_data($encode_session_data) |
|
| 2676 | - { |
|
| 2677 | - $this->encode_session_data = filter_var($encode_session_data, FILTER_VALIDATE_BOOLEAN); |
|
| 2678 | - } |
|
| 2528 | + /** |
|
| 2529 | + * @var boolean $use_personnel_manager |
|
| 2530 | + */ |
|
| 2531 | + public $use_personnel_manager; |
|
| 2532 | + |
|
| 2533 | + /** |
|
| 2534 | + * @var boolean $use_dashboard_widget |
|
| 2535 | + */ |
|
| 2536 | + public $use_dashboard_widget; |
|
| 2537 | + |
|
| 2538 | + /** |
|
| 2539 | + * @var int $events_in_dashboard |
|
| 2540 | + */ |
|
| 2541 | + public $events_in_dashboard; |
|
| 2542 | + |
|
| 2543 | + /** |
|
| 2544 | + * @var boolean $use_event_timezones |
|
| 2545 | + */ |
|
| 2546 | + public $use_event_timezones; |
|
| 2547 | + |
|
| 2548 | + /** |
|
| 2549 | + * @var boolean $use_full_logging |
|
| 2550 | + */ |
|
| 2551 | + public $use_full_logging; |
|
| 2552 | + |
|
| 2553 | + /** |
|
| 2554 | + * @var string $log_file_name |
|
| 2555 | + */ |
|
| 2556 | + public $log_file_name; |
|
| 2557 | + |
|
| 2558 | + /** |
|
| 2559 | + * @var string $debug_file_name |
|
| 2560 | + */ |
|
| 2561 | + public $debug_file_name; |
|
| 2562 | + |
|
| 2563 | + /** |
|
| 2564 | + * @var boolean $use_remote_logging |
|
| 2565 | + */ |
|
| 2566 | + public $use_remote_logging; |
|
| 2567 | + |
|
| 2568 | + /** |
|
| 2569 | + * @var string $remote_logging_url |
|
| 2570 | + */ |
|
| 2571 | + public $remote_logging_url; |
|
| 2572 | + |
|
| 2573 | + /** |
|
| 2574 | + * @var boolean $show_reg_footer |
|
| 2575 | + */ |
|
| 2576 | + public $show_reg_footer; |
|
| 2577 | + |
|
| 2578 | + /** |
|
| 2579 | + * @var string $affiliate_id |
|
| 2580 | + */ |
|
| 2581 | + public $affiliate_id; |
|
| 2582 | + |
|
| 2583 | + /** |
|
| 2584 | + * help tours on or off (global setting) |
|
| 2585 | + * |
|
| 2586 | + * @var boolean |
|
| 2587 | + */ |
|
| 2588 | + public $help_tour_activation; |
|
| 2589 | + |
|
| 2590 | + /** |
|
| 2591 | + * adds extra layer of encoding to session data to prevent serialization errors |
|
| 2592 | + * but is incompatible with some server configuration errors |
|
| 2593 | + * if you get "500 internal server errors" during registration, try turning this on |
|
| 2594 | + * if you get PHP fatal errors regarding base 64 methods not defined, then turn this off |
|
| 2595 | + * |
|
| 2596 | + * @var boolean $encode_session_data |
|
| 2597 | + */ |
|
| 2598 | + private $encode_session_data = false; |
|
| 2599 | + |
|
| 2600 | + |
|
| 2601 | + /** |
|
| 2602 | + * class constructor |
|
| 2603 | + * |
|
| 2604 | + * @access public |
|
| 2605 | + */ |
|
| 2606 | + public function __construct() |
|
| 2607 | + { |
|
| 2608 | + // set default general admin settings |
|
| 2609 | + $this->use_personnel_manager = true; |
|
| 2610 | + $this->use_dashboard_widget = true; |
|
| 2611 | + $this->events_in_dashboard = 30; |
|
| 2612 | + $this->use_event_timezones = false; |
|
| 2613 | + $this->use_full_logging = false; |
|
| 2614 | + $this->use_remote_logging = false; |
|
| 2615 | + $this->remote_logging_url = null; |
|
| 2616 | + $this->show_reg_footer = apply_filters( |
|
| 2617 | + 'FHEE__EE_Admin_Config__show_reg_footer__default', |
|
| 2618 | + false |
|
| 2619 | + ); |
|
| 2620 | + $this->affiliate_id = 'default'; |
|
| 2621 | + $this->help_tour_activation = true; |
|
| 2622 | + $this->encode_session_data = false; |
|
| 2623 | + } |
|
| 2624 | + |
|
| 2625 | + |
|
| 2626 | + /** |
|
| 2627 | + * @param bool $reset |
|
| 2628 | + * @return string |
|
| 2629 | + */ |
|
| 2630 | + public function log_file_name($reset = false) |
|
| 2631 | + { |
|
| 2632 | + if (empty($this->log_file_name) || $reset) { |
|
| 2633 | + $this->log_file_name = sanitize_key('espresso_log_' . md5(uniqid('', true))) . '.txt'; |
|
| 2634 | + EE_Config::instance()->update_espresso_config(false, false); |
|
| 2635 | + } |
|
| 2636 | + return $this->log_file_name; |
|
| 2637 | + } |
|
| 2638 | + |
|
| 2639 | + |
|
| 2640 | + /** |
|
| 2641 | + * @param bool $reset |
|
| 2642 | + * @return string |
|
| 2643 | + */ |
|
| 2644 | + public function debug_file_name($reset = false) |
|
| 2645 | + { |
|
| 2646 | + if (empty($this->debug_file_name) || $reset) { |
|
| 2647 | + $this->debug_file_name = sanitize_key('espresso_debug_' . md5(uniqid('', true))) . '.txt'; |
|
| 2648 | + EE_Config::instance()->update_espresso_config(false, false); |
|
| 2649 | + } |
|
| 2650 | + return $this->debug_file_name; |
|
| 2651 | + } |
|
| 2652 | + |
|
| 2653 | + |
|
| 2654 | + /** |
|
| 2655 | + * @return string |
|
| 2656 | + */ |
|
| 2657 | + public function affiliate_id() |
|
| 2658 | + { |
|
| 2659 | + return ! empty($this->affiliate_id) ? $this->affiliate_id : 'default'; |
|
| 2660 | + } |
|
| 2661 | + |
|
| 2662 | + |
|
| 2663 | + /** |
|
| 2664 | + * @return boolean |
|
| 2665 | + */ |
|
| 2666 | + public function encode_session_data() |
|
| 2667 | + { |
|
| 2668 | + return filter_var($this->encode_session_data, FILTER_VALIDATE_BOOLEAN); |
|
| 2669 | + } |
|
| 2670 | + |
|
| 2671 | + |
|
| 2672 | + /** |
|
| 2673 | + * @param boolean $encode_session_data |
|
| 2674 | + */ |
|
| 2675 | + public function set_encode_session_data($encode_session_data) |
|
| 2676 | + { |
|
| 2677 | + $this->encode_session_data = filter_var($encode_session_data, FILTER_VALIDATE_BOOLEAN); |
|
| 2678 | + } |
|
| 2679 | 2679 | } |
| 2680 | 2680 | |
| 2681 | 2681 | /** |
@@ -2684,70 +2684,70 @@ discard block |
||
| 2684 | 2684 | class EE_Template_Config extends EE_Config_Base |
| 2685 | 2685 | { |
| 2686 | 2686 | |
| 2687 | - /** |
|
| 2688 | - * @var boolean $enable_default_style |
|
| 2689 | - */ |
|
| 2690 | - public $enable_default_style; |
|
| 2691 | - |
|
| 2692 | - /** |
|
| 2693 | - * @var string $custom_style_sheet |
|
| 2694 | - */ |
|
| 2695 | - public $custom_style_sheet; |
|
| 2696 | - |
|
| 2697 | - /** |
|
| 2698 | - * @var boolean $display_address_in_regform |
|
| 2699 | - */ |
|
| 2700 | - public $display_address_in_regform; |
|
| 2701 | - |
|
| 2702 | - /** |
|
| 2703 | - * @var int $display_description_on_multi_reg_page |
|
| 2704 | - */ |
|
| 2705 | - public $display_description_on_multi_reg_page; |
|
| 2706 | - |
|
| 2707 | - /** |
|
| 2708 | - * @var boolean $use_custom_templates |
|
| 2709 | - */ |
|
| 2710 | - public $use_custom_templates; |
|
| 2711 | - |
|
| 2712 | - /** |
|
| 2713 | - * @var string $current_espresso_theme |
|
| 2714 | - */ |
|
| 2715 | - public $current_espresso_theme; |
|
| 2716 | - |
|
| 2717 | - /** |
|
| 2718 | - * @var EE_Ticket_Selector_Config $EED_Ticket_Selector |
|
| 2719 | - */ |
|
| 2720 | - public $EED_Ticket_Selector; |
|
| 2721 | - |
|
| 2722 | - /** |
|
| 2723 | - * @var EE_Event_Single_Config $EED_Event_Single |
|
| 2724 | - */ |
|
| 2725 | - public $EED_Event_Single; |
|
| 2726 | - |
|
| 2727 | - /** |
|
| 2728 | - * @var EE_Events_Archive_Config $EED_Events_Archive |
|
| 2729 | - */ |
|
| 2730 | - public $EED_Events_Archive; |
|
| 2731 | - |
|
| 2732 | - |
|
| 2733 | - /** |
|
| 2734 | - * class constructor |
|
| 2735 | - * |
|
| 2736 | - * @access public |
|
| 2737 | - */ |
|
| 2738 | - public function __construct() |
|
| 2739 | - { |
|
| 2740 | - // set default template settings |
|
| 2741 | - $this->enable_default_style = true; |
|
| 2742 | - $this->custom_style_sheet = null; |
|
| 2743 | - $this->display_address_in_regform = true; |
|
| 2744 | - $this->display_description_on_multi_reg_page = false; |
|
| 2745 | - $this->use_custom_templates = false; |
|
| 2746 | - $this->current_espresso_theme = 'Espresso_Arabica_2014'; |
|
| 2747 | - $this->EED_Event_Single = null; |
|
| 2748 | - $this->EED_Events_Archive = null; |
|
| 2749 | - $this->EED_Ticket_Selector = null; |
|
| 2750 | - } |
|
| 2687 | + /** |
|
| 2688 | + * @var boolean $enable_default_style |
|
| 2689 | + */ |
|
| 2690 | + public $enable_default_style; |
|
| 2691 | + |
|
| 2692 | + /** |
|
| 2693 | + * @var string $custom_style_sheet |
|
| 2694 | + */ |
|
| 2695 | + public $custom_style_sheet; |
|
| 2696 | + |
|
| 2697 | + /** |
|
| 2698 | + * @var boolean $display_address_in_regform |
|
| 2699 | + */ |
|
| 2700 | + public $display_address_in_regform; |
|
| 2701 | + |
|
| 2702 | + /** |
|
| 2703 | + * @var int $display_description_on_multi_reg_page |
|
| 2704 | + */ |
|
| 2705 | + public $display_description_on_multi_reg_page; |
|
| 2706 | + |
|
| 2707 | + /** |
|
| 2708 | + * @var boolean $use_custom_templates |
|
| 2709 | + */ |
|
| 2710 | + public $use_custom_templates; |
|
| 2711 | + |
|
| 2712 | + /** |
|
| 2713 | + * @var string $current_espresso_theme |
|
| 2714 | + */ |
|
| 2715 | + public $current_espresso_theme; |
|
| 2716 | + |
|
| 2717 | + /** |
|
| 2718 | + * @var EE_Ticket_Selector_Config $EED_Ticket_Selector |
|
| 2719 | + */ |
|
| 2720 | + public $EED_Ticket_Selector; |
|
| 2721 | + |
|
| 2722 | + /** |
|
| 2723 | + * @var EE_Event_Single_Config $EED_Event_Single |
|
| 2724 | + */ |
|
| 2725 | + public $EED_Event_Single; |
|
| 2726 | + |
|
| 2727 | + /** |
|
| 2728 | + * @var EE_Events_Archive_Config $EED_Events_Archive |
|
| 2729 | + */ |
|
| 2730 | + public $EED_Events_Archive; |
|
| 2731 | + |
|
| 2732 | + |
|
| 2733 | + /** |
|
| 2734 | + * class constructor |
|
| 2735 | + * |
|
| 2736 | + * @access public |
|
| 2737 | + */ |
|
| 2738 | + public function __construct() |
|
| 2739 | + { |
|
| 2740 | + // set default template settings |
|
| 2741 | + $this->enable_default_style = true; |
|
| 2742 | + $this->custom_style_sheet = null; |
|
| 2743 | + $this->display_address_in_regform = true; |
|
| 2744 | + $this->display_description_on_multi_reg_page = false; |
|
| 2745 | + $this->use_custom_templates = false; |
|
| 2746 | + $this->current_espresso_theme = 'Espresso_Arabica_2014'; |
|
| 2747 | + $this->EED_Event_Single = null; |
|
| 2748 | + $this->EED_Events_Archive = null; |
|
| 2749 | + $this->EED_Ticket_Selector = null; |
|
| 2750 | + } |
|
| 2751 | 2751 | } |
| 2752 | 2752 | |
| 2753 | 2753 | /** |
@@ -2756,114 +2756,114 @@ discard block |
||
| 2756 | 2756 | class EE_Map_Config extends EE_Config_Base |
| 2757 | 2757 | { |
| 2758 | 2758 | |
| 2759 | - /** |
|
| 2760 | - * @var boolean $use_google_maps |
|
| 2761 | - */ |
|
| 2762 | - public $use_google_maps; |
|
| 2763 | - |
|
| 2764 | - /** |
|
| 2765 | - * @var string $api_key |
|
| 2766 | - */ |
|
| 2767 | - public $google_map_api_key; |
|
| 2768 | - |
|
| 2769 | - /** |
|
| 2770 | - * @var int $event_details_map_width |
|
| 2771 | - */ |
|
| 2772 | - public $event_details_map_width; |
|
| 2773 | - |
|
| 2774 | - /** |
|
| 2775 | - * @var int $event_details_map_height |
|
| 2776 | - */ |
|
| 2777 | - public $event_details_map_height; |
|
| 2778 | - |
|
| 2779 | - /** |
|
| 2780 | - * @var int $event_details_map_zoom |
|
| 2781 | - */ |
|
| 2782 | - public $event_details_map_zoom; |
|
| 2783 | - |
|
| 2784 | - /** |
|
| 2785 | - * @var boolean $event_details_display_nav |
|
| 2786 | - */ |
|
| 2787 | - public $event_details_display_nav; |
|
| 2788 | - |
|
| 2789 | - /** |
|
| 2790 | - * @var boolean $event_details_nav_size |
|
| 2791 | - */ |
|
| 2792 | - public $event_details_nav_size; |
|
| 2793 | - |
|
| 2794 | - /** |
|
| 2795 | - * @var string $event_details_control_type |
|
| 2796 | - */ |
|
| 2797 | - public $event_details_control_type; |
|
| 2798 | - |
|
| 2799 | - /** |
|
| 2800 | - * @var string $event_details_map_align |
|
| 2801 | - */ |
|
| 2802 | - public $event_details_map_align; |
|
| 2803 | - |
|
| 2804 | - /** |
|
| 2805 | - * @var int $event_list_map_width |
|
| 2806 | - */ |
|
| 2807 | - public $event_list_map_width; |
|
| 2808 | - |
|
| 2809 | - /** |
|
| 2810 | - * @var int $event_list_map_height |
|
| 2811 | - */ |
|
| 2812 | - public $event_list_map_height; |
|
| 2813 | - |
|
| 2814 | - /** |
|
| 2815 | - * @var int $event_list_map_zoom |
|
| 2816 | - */ |
|
| 2817 | - public $event_list_map_zoom; |
|
| 2818 | - |
|
| 2819 | - /** |
|
| 2820 | - * @var boolean $event_list_display_nav |
|
| 2821 | - */ |
|
| 2822 | - public $event_list_display_nav; |
|
| 2823 | - |
|
| 2824 | - /** |
|
| 2825 | - * @var boolean $event_list_nav_size |
|
| 2826 | - */ |
|
| 2827 | - public $event_list_nav_size; |
|
| 2828 | - |
|
| 2829 | - /** |
|
| 2830 | - * @var string $event_list_control_type |
|
| 2831 | - */ |
|
| 2832 | - public $event_list_control_type; |
|
| 2833 | - |
|
| 2834 | - /** |
|
| 2835 | - * @var string $event_list_map_align |
|
| 2836 | - */ |
|
| 2837 | - public $event_list_map_align; |
|
| 2838 | - |
|
| 2839 | - |
|
| 2840 | - /** |
|
| 2841 | - * class constructor |
|
| 2842 | - * |
|
| 2843 | - * @access public |
|
| 2844 | - */ |
|
| 2845 | - public function __construct() |
|
| 2846 | - { |
|
| 2847 | - // set default map settings |
|
| 2848 | - $this->use_google_maps = true; |
|
| 2849 | - $this->google_map_api_key = ''; |
|
| 2850 | - // for event details pages (reg page) |
|
| 2851 | - $this->event_details_map_width = 585; // ee_map_width_single |
|
| 2852 | - $this->event_details_map_height = 362; // ee_map_height_single |
|
| 2853 | - $this->event_details_map_zoom = 14; // ee_map_zoom_single |
|
| 2854 | - $this->event_details_display_nav = true; // ee_map_nav_display_single |
|
| 2855 | - $this->event_details_nav_size = false; // ee_map_nav_size_single |
|
| 2856 | - $this->event_details_control_type = 'default'; // ee_map_type_control_single |
|
| 2857 | - $this->event_details_map_align = 'center'; // ee_map_align_single |
|
| 2858 | - // for event list pages |
|
| 2859 | - $this->event_list_map_width = 300; // ee_map_width |
|
| 2860 | - $this->event_list_map_height = 185; // ee_map_height |
|
| 2861 | - $this->event_list_map_zoom = 12; // ee_map_zoom |
|
| 2862 | - $this->event_list_display_nav = false; // ee_map_nav_display |
|
| 2863 | - $this->event_list_nav_size = true; // ee_map_nav_size |
|
| 2864 | - $this->event_list_control_type = 'dropdown'; // ee_map_type_control |
|
| 2865 | - $this->event_list_map_align = 'center'; // ee_map_align |
|
| 2866 | - } |
|
| 2759 | + /** |
|
| 2760 | + * @var boolean $use_google_maps |
|
| 2761 | + */ |
|
| 2762 | + public $use_google_maps; |
|
| 2763 | + |
|
| 2764 | + /** |
|
| 2765 | + * @var string $api_key |
|
| 2766 | + */ |
|
| 2767 | + public $google_map_api_key; |
|
| 2768 | + |
|
| 2769 | + /** |
|
| 2770 | + * @var int $event_details_map_width |
|
| 2771 | + */ |
|
| 2772 | + public $event_details_map_width; |
|
| 2773 | + |
|
| 2774 | + /** |
|
| 2775 | + * @var int $event_details_map_height |
|
| 2776 | + */ |
|
| 2777 | + public $event_details_map_height; |
|
| 2778 | + |
|
| 2779 | + /** |
|
| 2780 | + * @var int $event_details_map_zoom |
|
| 2781 | + */ |
|
| 2782 | + public $event_details_map_zoom; |
|
| 2783 | + |
|
| 2784 | + /** |
|
| 2785 | + * @var boolean $event_details_display_nav |
|
| 2786 | + */ |
|
| 2787 | + public $event_details_display_nav; |
|
| 2788 | + |
|
| 2789 | + /** |
|
| 2790 | + * @var boolean $event_details_nav_size |
|
| 2791 | + */ |
|
| 2792 | + public $event_details_nav_size; |
|
| 2793 | + |
|
| 2794 | + /** |
|
| 2795 | + * @var string $event_details_control_type |
|
| 2796 | + */ |
|
| 2797 | + public $event_details_control_type; |
|
| 2798 | + |
|
| 2799 | + /** |
|
| 2800 | + * @var string $event_details_map_align |
|
| 2801 | + */ |
|
| 2802 | + public $event_details_map_align; |
|
| 2803 | + |
|
| 2804 | + /** |
|
| 2805 | + * @var int $event_list_map_width |
|
| 2806 | + */ |
|
| 2807 | + public $event_list_map_width; |
|
| 2808 | + |
|
| 2809 | + /** |
|
| 2810 | + * @var int $event_list_map_height |
|
| 2811 | + */ |
|
| 2812 | + public $event_list_map_height; |
|
| 2813 | + |
|
| 2814 | + /** |
|
| 2815 | + * @var int $event_list_map_zoom |
|
| 2816 | + */ |
|
| 2817 | + public $event_list_map_zoom; |
|
| 2818 | + |
|
| 2819 | + /** |
|
| 2820 | + * @var boolean $event_list_display_nav |
|
| 2821 | + */ |
|
| 2822 | + public $event_list_display_nav; |
|
| 2823 | + |
|
| 2824 | + /** |
|
| 2825 | + * @var boolean $event_list_nav_size |
|
| 2826 | + */ |
|
| 2827 | + public $event_list_nav_size; |
|
| 2828 | + |
|
| 2829 | + /** |
|
| 2830 | + * @var string $event_list_control_type |
|
| 2831 | + */ |
|
| 2832 | + public $event_list_control_type; |
|
| 2833 | + |
|
| 2834 | + /** |
|
| 2835 | + * @var string $event_list_map_align |
|
| 2836 | + */ |
|
| 2837 | + public $event_list_map_align; |
|
| 2838 | + |
|
| 2839 | + |
|
| 2840 | + /** |
|
| 2841 | + * class constructor |
|
| 2842 | + * |
|
| 2843 | + * @access public |
|
| 2844 | + */ |
|
| 2845 | + public function __construct() |
|
| 2846 | + { |
|
| 2847 | + // set default map settings |
|
| 2848 | + $this->use_google_maps = true; |
|
| 2849 | + $this->google_map_api_key = ''; |
|
| 2850 | + // for event details pages (reg page) |
|
| 2851 | + $this->event_details_map_width = 585; // ee_map_width_single |
|
| 2852 | + $this->event_details_map_height = 362; // ee_map_height_single |
|
| 2853 | + $this->event_details_map_zoom = 14; // ee_map_zoom_single |
|
| 2854 | + $this->event_details_display_nav = true; // ee_map_nav_display_single |
|
| 2855 | + $this->event_details_nav_size = false; // ee_map_nav_size_single |
|
| 2856 | + $this->event_details_control_type = 'default'; // ee_map_type_control_single |
|
| 2857 | + $this->event_details_map_align = 'center'; // ee_map_align_single |
|
| 2858 | + // for event list pages |
|
| 2859 | + $this->event_list_map_width = 300; // ee_map_width |
|
| 2860 | + $this->event_list_map_height = 185; // ee_map_height |
|
| 2861 | + $this->event_list_map_zoom = 12; // ee_map_zoom |
|
| 2862 | + $this->event_list_display_nav = false; // ee_map_nav_display |
|
| 2863 | + $this->event_list_nav_size = true; // ee_map_nav_size |
|
| 2864 | + $this->event_list_control_type = 'dropdown'; // ee_map_type_control |
|
| 2865 | + $this->event_list_map_align = 'center'; // ee_map_align |
|
| 2866 | + } |
|
| 2867 | 2867 | } |
| 2868 | 2868 | |
| 2869 | 2869 | /** |
@@ -2872,46 +2872,46 @@ discard block |
||
| 2872 | 2872 | class EE_Events_Archive_Config extends EE_Config_Base |
| 2873 | 2873 | { |
| 2874 | 2874 | |
| 2875 | - public $display_status_banner; |
|
| 2875 | + public $display_status_banner; |
|
| 2876 | 2876 | |
| 2877 | - public $display_description; |
|
| 2877 | + public $display_description; |
|
| 2878 | 2878 | |
| 2879 | - public $display_ticket_selector; |
|
| 2879 | + public $display_ticket_selector; |
|
| 2880 | 2880 | |
| 2881 | - public $display_datetimes; |
|
| 2881 | + public $display_datetimes; |
|
| 2882 | 2882 | |
| 2883 | - public $display_venue; |
|
| 2883 | + public $display_venue; |
|
| 2884 | 2884 | |
| 2885 | - public $display_expired_events; |
|
| 2885 | + public $display_expired_events; |
|
| 2886 | 2886 | |
| 2887 | - public $use_sortable_display_order; |
|
| 2887 | + public $use_sortable_display_order; |
|
| 2888 | 2888 | |
| 2889 | - public $display_order_tickets; |
|
| 2889 | + public $display_order_tickets; |
|
| 2890 | 2890 | |
| 2891 | - public $display_order_datetimes; |
|
| 2891 | + public $display_order_datetimes; |
|
| 2892 | 2892 | |
| 2893 | - public $display_order_event; |
|
| 2893 | + public $display_order_event; |
|
| 2894 | 2894 | |
| 2895 | - public $display_order_venue; |
|
| 2895 | + public $display_order_venue; |
|
| 2896 | 2896 | |
| 2897 | 2897 | |
| 2898 | - /** |
|
| 2899 | - * class constructor |
|
| 2900 | - */ |
|
| 2901 | - public function __construct() |
|
| 2902 | - { |
|
| 2903 | - $this->display_status_banner = 0; |
|
| 2904 | - $this->display_description = 1; |
|
| 2905 | - $this->display_ticket_selector = 0; |
|
| 2906 | - $this->display_datetimes = 1; |
|
| 2907 | - $this->display_venue = 0; |
|
| 2908 | - $this->display_expired_events = 0; |
|
| 2909 | - $this->use_sortable_display_order = false; |
|
| 2910 | - $this->display_order_tickets = 100; |
|
| 2911 | - $this->display_order_datetimes = 110; |
|
| 2912 | - $this->display_order_event = 120; |
|
| 2913 | - $this->display_order_venue = 130; |
|
| 2914 | - } |
|
| 2898 | + /** |
|
| 2899 | + * class constructor |
|
| 2900 | + */ |
|
| 2901 | + public function __construct() |
|
| 2902 | + { |
|
| 2903 | + $this->display_status_banner = 0; |
|
| 2904 | + $this->display_description = 1; |
|
| 2905 | + $this->display_ticket_selector = 0; |
|
| 2906 | + $this->display_datetimes = 1; |
|
| 2907 | + $this->display_venue = 0; |
|
| 2908 | + $this->display_expired_events = 0; |
|
| 2909 | + $this->use_sortable_display_order = false; |
|
| 2910 | + $this->display_order_tickets = 100; |
|
| 2911 | + $this->display_order_datetimes = 110; |
|
| 2912 | + $this->display_order_event = 120; |
|
| 2913 | + $this->display_order_venue = 130; |
|
| 2914 | + } |
|
| 2915 | 2915 | } |
| 2916 | 2916 | |
| 2917 | 2917 | /** |
@@ -2920,34 +2920,34 @@ discard block |
||
| 2920 | 2920 | class EE_Event_Single_Config extends EE_Config_Base |
| 2921 | 2921 | { |
| 2922 | 2922 | |
| 2923 | - public $display_status_banner_single; |
|
| 2923 | + public $display_status_banner_single; |
|
| 2924 | 2924 | |
| 2925 | - public $display_venue; |
|
| 2925 | + public $display_venue; |
|
| 2926 | 2926 | |
| 2927 | - public $use_sortable_display_order; |
|
| 2927 | + public $use_sortable_display_order; |
|
| 2928 | 2928 | |
| 2929 | - public $display_order_tickets; |
|
| 2929 | + public $display_order_tickets; |
|
| 2930 | 2930 | |
| 2931 | - public $display_order_datetimes; |
|
| 2931 | + public $display_order_datetimes; |
|
| 2932 | 2932 | |
| 2933 | - public $display_order_event; |
|
| 2933 | + public $display_order_event; |
|
| 2934 | 2934 | |
| 2935 | - public $display_order_venue; |
|
| 2935 | + public $display_order_venue; |
|
| 2936 | 2936 | |
| 2937 | 2937 | |
| 2938 | - /** |
|
| 2939 | - * class constructor |
|
| 2940 | - */ |
|
| 2941 | - public function __construct() |
|
| 2942 | - { |
|
| 2943 | - $this->display_status_banner_single = 0; |
|
| 2944 | - $this->display_venue = 1; |
|
| 2945 | - $this->use_sortable_display_order = false; |
|
| 2946 | - $this->display_order_tickets = 100; |
|
| 2947 | - $this->display_order_datetimes = 110; |
|
| 2948 | - $this->display_order_event = 120; |
|
| 2949 | - $this->display_order_venue = 130; |
|
| 2950 | - } |
|
| 2938 | + /** |
|
| 2939 | + * class constructor |
|
| 2940 | + */ |
|
| 2941 | + public function __construct() |
|
| 2942 | + { |
|
| 2943 | + $this->display_status_banner_single = 0; |
|
| 2944 | + $this->display_venue = 1; |
|
| 2945 | + $this->use_sortable_display_order = false; |
|
| 2946 | + $this->display_order_tickets = 100; |
|
| 2947 | + $this->display_order_datetimes = 110; |
|
| 2948 | + $this->display_order_event = 120; |
|
| 2949 | + $this->display_order_venue = 130; |
|
| 2950 | + } |
|
| 2951 | 2951 | } |
| 2952 | 2952 | |
| 2953 | 2953 | /** |
@@ -2956,172 +2956,172 @@ discard block |
||
| 2956 | 2956 | class EE_Ticket_Selector_Config extends EE_Config_Base |
| 2957 | 2957 | { |
| 2958 | 2958 | |
| 2959 | - /** |
|
| 2960 | - * constant to indicate that a datetime selector should NEVER be shown for ticket selectors |
|
| 2961 | - */ |
|
| 2962 | - const DO_NOT_SHOW_DATETIME_SELECTOR = 'no_datetime_selector'; |
|
| 2963 | - |
|
| 2964 | - /** |
|
| 2965 | - * constant to indicate that a datetime selector should only be shown for ticket selectors |
|
| 2966 | - * when the number of datetimes for the event matches the value set for $datetime_selector_threshold |
|
| 2967 | - */ |
|
| 2968 | - const MAYBE_SHOW_DATETIME_SELECTOR = 'maybe_datetime_selector'; |
|
| 2969 | - |
|
| 2970 | - /** |
|
| 2971 | - * @var boolean $show_ticket_sale_columns |
|
| 2972 | - */ |
|
| 2973 | - public $show_ticket_sale_columns; |
|
| 2974 | - |
|
| 2975 | - /** |
|
| 2976 | - * @var boolean $show_ticket_details |
|
| 2977 | - */ |
|
| 2978 | - public $show_ticket_details; |
|
| 2979 | - |
|
| 2980 | - /** |
|
| 2981 | - * @var boolean $show_expired_tickets |
|
| 2982 | - */ |
|
| 2983 | - public $show_expired_tickets; |
|
| 2984 | - |
|
| 2985 | - /** |
|
| 2986 | - * whether or not to display a dropdown box populated with event datetimes |
|
| 2987 | - * that toggles which tickets are displayed for a ticket selector. |
|
| 2988 | - * uses one of the *_DATETIME_SELECTOR constants defined above |
|
| 2989 | - * |
|
| 2990 | - * @var string $show_datetime_selector |
|
| 2991 | - */ |
|
| 2992 | - private $show_datetime_selector = 'no_datetime_selector'; |
|
| 2993 | - |
|
| 2994 | - /** |
|
| 2995 | - * the number of datetimes an event has to have before conditionally displaying a datetime selector |
|
| 2996 | - * |
|
| 2997 | - * @var int $datetime_selector_threshold |
|
| 2998 | - */ |
|
| 2999 | - private $datetime_selector_threshold = 3; |
|
| 3000 | - |
|
| 3001 | - /** |
|
| 3002 | - * determines the maximum number of "checked" dates in the date and time filter |
|
| 3003 | - * |
|
| 3004 | - * @var int $datetime_selector_checked |
|
| 3005 | - */ |
|
| 3006 | - private $datetime_selector_max_checked = 10; |
|
| 3007 | - |
|
| 3008 | - |
|
| 3009 | - /** |
|
| 3010 | - * class constructor |
|
| 3011 | - */ |
|
| 3012 | - public function __construct() |
|
| 3013 | - { |
|
| 3014 | - $this->show_ticket_sale_columns = true; |
|
| 3015 | - $this->show_ticket_details = true; |
|
| 3016 | - $this->show_expired_tickets = true; |
|
| 3017 | - $this->show_datetime_selector = \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR; |
|
| 3018 | - $this->datetime_selector_threshold = 3; |
|
| 3019 | - $this->datetime_selector_max_checked = 10; |
|
| 3020 | - } |
|
| 3021 | - |
|
| 3022 | - |
|
| 3023 | - /** |
|
| 3024 | - * returns true if a datetime selector should be displayed |
|
| 3025 | - * |
|
| 3026 | - * @param array $datetimes |
|
| 3027 | - * @return bool |
|
| 3028 | - */ |
|
| 3029 | - public function showDatetimeSelector(array $datetimes) |
|
| 3030 | - { |
|
| 3031 | - // if the settings are NOT: don't show OR below threshold, THEN active = true |
|
| 3032 | - return ! ( |
|
| 3033 | - $this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR |
|
| 3034 | - || ( |
|
| 3035 | - $this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR |
|
| 3036 | - && count($datetimes) < $this->getDatetimeSelectorThreshold() |
|
| 3037 | - ) |
|
| 3038 | - ); |
|
| 3039 | - } |
|
| 3040 | - |
|
| 3041 | - |
|
| 3042 | - /** |
|
| 3043 | - * @return string |
|
| 3044 | - */ |
|
| 3045 | - public function getShowDatetimeSelector() |
|
| 3046 | - { |
|
| 3047 | - return $this->show_datetime_selector; |
|
| 3048 | - } |
|
| 3049 | - |
|
| 3050 | - |
|
| 3051 | - /** |
|
| 3052 | - * @param bool $keys_only |
|
| 3053 | - * @return array |
|
| 3054 | - */ |
|
| 3055 | - public function getShowDatetimeSelectorOptions($keys_only = true) |
|
| 3056 | - { |
|
| 3057 | - return $keys_only |
|
| 3058 | - ? array( |
|
| 3059 | - \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR, |
|
| 3060 | - \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR, |
|
| 3061 | - ) |
|
| 3062 | - : array( |
|
| 3063 | - \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR => esc_html__( |
|
| 3064 | - 'Do not show date & time filter', |
|
| 3065 | - 'event_espresso' |
|
| 3066 | - ), |
|
| 3067 | - \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR => esc_html__( |
|
| 3068 | - 'Maybe show date & time filter', |
|
| 3069 | - 'event_espresso' |
|
| 3070 | - ), |
|
| 3071 | - ); |
|
| 3072 | - } |
|
| 3073 | - |
|
| 3074 | - |
|
| 3075 | - /** |
|
| 3076 | - * @param string $show_datetime_selector |
|
| 3077 | - */ |
|
| 3078 | - public function setShowDatetimeSelector($show_datetime_selector) |
|
| 3079 | - { |
|
| 3080 | - $this->show_datetime_selector = in_array( |
|
| 3081 | - $show_datetime_selector, |
|
| 3082 | - $this->getShowDatetimeSelectorOptions(), |
|
| 3083 | - true |
|
| 3084 | - ) |
|
| 3085 | - ? $show_datetime_selector |
|
| 3086 | - : \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR; |
|
| 3087 | - } |
|
| 3088 | - |
|
| 3089 | - |
|
| 3090 | - /** |
|
| 3091 | - * @return int |
|
| 3092 | - */ |
|
| 3093 | - public function getDatetimeSelectorThreshold() |
|
| 3094 | - { |
|
| 3095 | - return $this->datetime_selector_threshold; |
|
| 3096 | - } |
|
| 3097 | - |
|
| 3098 | - |
|
| 3099 | - /** |
|
| 3100 | - * @param int $datetime_selector_threshold |
|
| 3101 | - */ |
|
| 3102 | - public function setDatetimeSelectorThreshold($datetime_selector_threshold) |
|
| 3103 | - { |
|
| 3104 | - $datetime_selector_threshold = absint($datetime_selector_threshold); |
|
| 3105 | - $this->datetime_selector_threshold = $datetime_selector_threshold ? $datetime_selector_threshold : 3; |
|
| 3106 | - } |
|
| 3107 | - |
|
| 3108 | - |
|
| 3109 | - /** |
|
| 3110 | - * @return int |
|
| 3111 | - */ |
|
| 3112 | - public function getDatetimeSelectorMaxChecked() |
|
| 3113 | - { |
|
| 3114 | - return $this->datetime_selector_max_checked; |
|
| 3115 | - } |
|
| 3116 | - |
|
| 3117 | - |
|
| 3118 | - /** |
|
| 3119 | - * @param int $datetime_selector_max_checked |
|
| 3120 | - */ |
|
| 3121 | - public function setDatetimeSelectorMaxChecked($datetime_selector_max_checked) |
|
| 3122 | - { |
|
| 3123 | - $this->datetime_selector_max_checked = absint($datetime_selector_max_checked); |
|
| 3124 | - } |
|
| 2959 | + /** |
|
| 2960 | + * constant to indicate that a datetime selector should NEVER be shown for ticket selectors |
|
| 2961 | + */ |
|
| 2962 | + const DO_NOT_SHOW_DATETIME_SELECTOR = 'no_datetime_selector'; |
|
| 2963 | + |
|
| 2964 | + /** |
|
| 2965 | + * constant to indicate that a datetime selector should only be shown for ticket selectors |
|
| 2966 | + * when the number of datetimes for the event matches the value set for $datetime_selector_threshold |
|
| 2967 | + */ |
|
| 2968 | + const MAYBE_SHOW_DATETIME_SELECTOR = 'maybe_datetime_selector'; |
|
| 2969 | + |
|
| 2970 | + /** |
|
| 2971 | + * @var boolean $show_ticket_sale_columns |
|
| 2972 | + */ |
|
| 2973 | + public $show_ticket_sale_columns; |
|
| 2974 | + |
|
| 2975 | + /** |
|
| 2976 | + * @var boolean $show_ticket_details |
|
| 2977 | + */ |
|
| 2978 | + public $show_ticket_details; |
|
| 2979 | + |
|
| 2980 | + /** |
|
| 2981 | + * @var boolean $show_expired_tickets |
|
| 2982 | + */ |
|
| 2983 | + public $show_expired_tickets; |
|
| 2984 | + |
|
| 2985 | + /** |
|
| 2986 | + * whether or not to display a dropdown box populated with event datetimes |
|
| 2987 | + * that toggles which tickets are displayed for a ticket selector. |
|
| 2988 | + * uses one of the *_DATETIME_SELECTOR constants defined above |
|
| 2989 | + * |
|
| 2990 | + * @var string $show_datetime_selector |
|
| 2991 | + */ |
|
| 2992 | + private $show_datetime_selector = 'no_datetime_selector'; |
|
| 2993 | + |
|
| 2994 | + /** |
|
| 2995 | + * the number of datetimes an event has to have before conditionally displaying a datetime selector |
|
| 2996 | + * |
|
| 2997 | + * @var int $datetime_selector_threshold |
|
| 2998 | + */ |
|
| 2999 | + private $datetime_selector_threshold = 3; |
|
| 3000 | + |
|
| 3001 | + /** |
|
| 3002 | + * determines the maximum number of "checked" dates in the date and time filter |
|
| 3003 | + * |
|
| 3004 | + * @var int $datetime_selector_checked |
|
| 3005 | + */ |
|
| 3006 | + private $datetime_selector_max_checked = 10; |
|
| 3007 | + |
|
| 3008 | + |
|
| 3009 | + /** |
|
| 3010 | + * class constructor |
|
| 3011 | + */ |
|
| 3012 | + public function __construct() |
|
| 3013 | + { |
|
| 3014 | + $this->show_ticket_sale_columns = true; |
|
| 3015 | + $this->show_ticket_details = true; |
|
| 3016 | + $this->show_expired_tickets = true; |
|
| 3017 | + $this->show_datetime_selector = \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR; |
|
| 3018 | + $this->datetime_selector_threshold = 3; |
|
| 3019 | + $this->datetime_selector_max_checked = 10; |
|
| 3020 | + } |
|
| 3021 | + |
|
| 3022 | + |
|
| 3023 | + /** |
|
| 3024 | + * returns true if a datetime selector should be displayed |
|
| 3025 | + * |
|
| 3026 | + * @param array $datetimes |
|
| 3027 | + * @return bool |
|
| 3028 | + */ |
|
| 3029 | + public function showDatetimeSelector(array $datetimes) |
|
| 3030 | + { |
|
| 3031 | + // if the settings are NOT: don't show OR below threshold, THEN active = true |
|
| 3032 | + return ! ( |
|
| 3033 | + $this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR |
|
| 3034 | + || ( |
|
| 3035 | + $this->getShowDatetimeSelector() === \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR |
|
| 3036 | + && count($datetimes) < $this->getDatetimeSelectorThreshold() |
|
| 3037 | + ) |
|
| 3038 | + ); |
|
| 3039 | + } |
|
| 3040 | + |
|
| 3041 | + |
|
| 3042 | + /** |
|
| 3043 | + * @return string |
|
| 3044 | + */ |
|
| 3045 | + public function getShowDatetimeSelector() |
|
| 3046 | + { |
|
| 3047 | + return $this->show_datetime_selector; |
|
| 3048 | + } |
|
| 3049 | + |
|
| 3050 | + |
|
| 3051 | + /** |
|
| 3052 | + * @param bool $keys_only |
|
| 3053 | + * @return array |
|
| 3054 | + */ |
|
| 3055 | + public function getShowDatetimeSelectorOptions($keys_only = true) |
|
| 3056 | + { |
|
| 3057 | + return $keys_only |
|
| 3058 | + ? array( |
|
| 3059 | + \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR, |
|
| 3060 | + \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR, |
|
| 3061 | + ) |
|
| 3062 | + : array( |
|
| 3063 | + \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR => esc_html__( |
|
| 3064 | + 'Do not show date & time filter', |
|
| 3065 | + 'event_espresso' |
|
| 3066 | + ), |
|
| 3067 | + \EE_Ticket_Selector_Config::MAYBE_SHOW_DATETIME_SELECTOR => esc_html__( |
|
| 3068 | + 'Maybe show date & time filter', |
|
| 3069 | + 'event_espresso' |
|
| 3070 | + ), |
|
| 3071 | + ); |
|
| 3072 | + } |
|
| 3073 | + |
|
| 3074 | + |
|
| 3075 | + /** |
|
| 3076 | + * @param string $show_datetime_selector |
|
| 3077 | + */ |
|
| 3078 | + public function setShowDatetimeSelector($show_datetime_selector) |
|
| 3079 | + { |
|
| 3080 | + $this->show_datetime_selector = in_array( |
|
| 3081 | + $show_datetime_selector, |
|
| 3082 | + $this->getShowDatetimeSelectorOptions(), |
|
| 3083 | + true |
|
| 3084 | + ) |
|
| 3085 | + ? $show_datetime_selector |
|
| 3086 | + : \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR; |
|
| 3087 | + } |
|
| 3088 | + |
|
| 3089 | + |
|
| 3090 | + /** |
|
| 3091 | + * @return int |
|
| 3092 | + */ |
|
| 3093 | + public function getDatetimeSelectorThreshold() |
|
| 3094 | + { |
|
| 3095 | + return $this->datetime_selector_threshold; |
|
| 3096 | + } |
|
| 3097 | + |
|
| 3098 | + |
|
| 3099 | + /** |
|
| 3100 | + * @param int $datetime_selector_threshold |
|
| 3101 | + */ |
|
| 3102 | + public function setDatetimeSelectorThreshold($datetime_selector_threshold) |
|
| 3103 | + { |
|
| 3104 | + $datetime_selector_threshold = absint($datetime_selector_threshold); |
|
| 3105 | + $this->datetime_selector_threshold = $datetime_selector_threshold ? $datetime_selector_threshold : 3; |
|
| 3106 | + } |
|
| 3107 | + |
|
| 3108 | + |
|
| 3109 | + /** |
|
| 3110 | + * @return int |
|
| 3111 | + */ |
|
| 3112 | + public function getDatetimeSelectorMaxChecked() |
|
| 3113 | + { |
|
| 3114 | + return $this->datetime_selector_max_checked; |
|
| 3115 | + } |
|
| 3116 | + |
|
| 3117 | + |
|
| 3118 | + /** |
|
| 3119 | + * @param int $datetime_selector_max_checked |
|
| 3120 | + */ |
|
| 3121 | + public function setDatetimeSelectorMaxChecked($datetime_selector_max_checked) |
|
| 3122 | + { |
|
| 3123 | + $this->datetime_selector_max_checked = absint($datetime_selector_max_checked); |
|
| 3124 | + } |
|
| 3125 | 3125 | } |
| 3126 | 3126 | |
| 3127 | 3127 | /** |
@@ -3134,86 +3134,86 @@ discard block |
||
| 3134 | 3134 | class EE_Environment_Config extends EE_Config_Base |
| 3135 | 3135 | { |
| 3136 | 3136 | |
| 3137 | - /** |
|
| 3138 | - * Hold any php environment variables that we want to track. |
|
| 3139 | - * |
|
| 3140 | - * @var stdClass; |
|
| 3141 | - */ |
|
| 3142 | - public $php; |
|
| 3143 | - |
|
| 3144 | - |
|
| 3145 | - /** |
|
| 3146 | - * constructor |
|
| 3147 | - */ |
|
| 3148 | - public function __construct() |
|
| 3149 | - { |
|
| 3150 | - $this->php = new stdClass(); |
|
| 3151 | - $this->_set_php_values(); |
|
| 3152 | - } |
|
| 3153 | - |
|
| 3154 | - |
|
| 3155 | - /** |
|
| 3156 | - * This sets the php environment variables. |
|
| 3157 | - * |
|
| 3158 | - * @since 4.4.0 |
|
| 3159 | - * @return void |
|
| 3160 | - */ |
|
| 3161 | - protected function _set_php_values() |
|
| 3162 | - { |
|
| 3163 | - $this->php->max_input_vars = ini_get('max_input_vars'); |
|
| 3164 | - $this->php->version = phpversion(); |
|
| 3165 | - } |
|
| 3166 | - |
|
| 3167 | - |
|
| 3168 | - /** |
|
| 3169 | - * helper method for determining whether input_count is |
|
| 3170 | - * reaching the potential maximum the server can handle |
|
| 3171 | - * according to max_input_vars |
|
| 3172 | - * |
|
| 3173 | - * @param int $input_count the count of input vars. |
|
| 3174 | - * @return array { |
|
| 3175 | - * An array that represents whether available space and if no available space the error |
|
| 3176 | - * message. |
|
| 3177 | - * @type bool $has_space whether more inputs can be added. |
|
| 3178 | - * @type string $msg Any message to be displayed. |
|
| 3179 | - * } |
|
| 3180 | - */ |
|
| 3181 | - public function max_input_vars_limit_check($input_count = 0) |
|
| 3182 | - { |
|
| 3183 | - if (! empty($this->php->max_input_vars) |
|
| 3184 | - && ($input_count >= $this->php->max_input_vars) |
|
| 3185 | - ) { |
|
| 3186 | - // check the server setting because the config value could be stale |
|
| 3187 | - $max_input_vars = ini_get('max_input_vars'); |
|
| 3188 | - if ($input_count >= $max_input_vars) { |
|
| 3189 | - return sprintf( |
|
| 3190 | - esc_html__( |
|
| 3191 | - 'The maximum number of inputs on this page has been exceeded. You cannot make edits to this page because of your server\'s PHP "max_input_vars" setting.%1$sThere are %2$d inputs and the maximum amount currently allowed by your server is %3$d.%1$sPlease contact your web host and ask them to raise the "max_input_vars" limit.', |
|
| 3192 | - 'event_espresso' |
|
| 3193 | - ), |
|
| 3194 | - '<br>', |
|
| 3195 | - $input_count, |
|
| 3196 | - $max_input_vars |
|
| 3197 | - ); |
|
| 3198 | - } else { |
|
| 3199 | - return ''; |
|
| 3200 | - } |
|
| 3201 | - } else { |
|
| 3202 | - return ''; |
|
| 3203 | - } |
|
| 3204 | - } |
|
| 3205 | - |
|
| 3206 | - |
|
| 3207 | - /** |
|
| 3208 | - * The purpose of this method is just to force rechecking php values so if they've changed, they get updated. |
|
| 3209 | - * |
|
| 3210 | - * @since 4.4.1 |
|
| 3211 | - * @return void |
|
| 3212 | - */ |
|
| 3213 | - public function recheck_values() |
|
| 3214 | - { |
|
| 3215 | - $this->_set_php_values(); |
|
| 3216 | - } |
|
| 3137 | + /** |
|
| 3138 | + * Hold any php environment variables that we want to track. |
|
| 3139 | + * |
|
| 3140 | + * @var stdClass; |
|
| 3141 | + */ |
|
| 3142 | + public $php; |
|
| 3143 | + |
|
| 3144 | + |
|
| 3145 | + /** |
|
| 3146 | + * constructor |
|
| 3147 | + */ |
|
| 3148 | + public function __construct() |
|
| 3149 | + { |
|
| 3150 | + $this->php = new stdClass(); |
|
| 3151 | + $this->_set_php_values(); |
|
| 3152 | + } |
|
| 3153 | + |
|
| 3154 | + |
|
| 3155 | + /** |
|
| 3156 | + * This sets the php environment variables. |
|
| 3157 | + * |
|
| 3158 | + * @since 4.4.0 |
|
| 3159 | + * @return void |
|
| 3160 | + */ |
|
| 3161 | + protected function _set_php_values() |
|
| 3162 | + { |
|
| 3163 | + $this->php->max_input_vars = ini_get('max_input_vars'); |
|
| 3164 | + $this->php->version = phpversion(); |
|
| 3165 | + } |
|
| 3166 | + |
|
| 3167 | + |
|
| 3168 | + /** |
|
| 3169 | + * helper method for determining whether input_count is |
|
| 3170 | + * reaching the potential maximum the server can handle |
|
| 3171 | + * according to max_input_vars |
|
| 3172 | + * |
|
| 3173 | + * @param int $input_count the count of input vars. |
|
| 3174 | + * @return array { |
|
| 3175 | + * An array that represents whether available space and if no available space the error |
|
| 3176 | + * message. |
|
| 3177 | + * @type bool $has_space whether more inputs can be added. |
|
| 3178 | + * @type string $msg Any message to be displayed. |
|
| 3179 | + * } |
|
| 3180 | + */ |
|
| 3181 | + public function max_input_vars_limit_check($input_count = 0) |
|
| 3182 | + { |
|
| 3183 | + if (! empty($this->php->max_input_vars) |
|
| 3184 | + && ($input_count >= $this->php->max_input_vars) |
|
| 3185 | + ) { |
|
| 3186 | + // check the server setting because the config value could be stale |
|
| 3187 | + $max_input_vars = ini_get('max_input_vars'); |
|
| 3188 | + if ($input_count >= $max_input_vars) { |
|
| 3189 | + return sprintf( |
|
| 3190 | + esc_html__( |
|
| 3191 | + 'The maximum number of inputs on this page has been exceeded. You cannot make edits to this page because of your server\'s PHP "max_input_vars" setting.%1$sThere are %2$d inputs and the maximum amount currently allowed by your server is %3$d.%1$sPlease contact your web host and ask them to raise the "max_input_vars" limit.', |
|
| 3192 | + 'event_espresso' |
|
| 3193 | + ), |
|
| 3194 | + '<br>', |
|
| 3195 | + $input_count, |
|
| 3196 | + $max_input_vars |
|
| 3197 | + ); |
|
| 3198 | + } else { |
|
| 3199 | + return ''; |
|
| 3200 | + } |
|
| 3201 | + } else { |
|
| 3202 | + return ''; |
|
| 3203 | + } |
|
| 3204 | + } |
|
| 3205 | + |
|
| 3206 | + |
|
| 3207 | + /** |
|
| 3208 | + * The purpose of this method is just to force rechecking php values so if they've changed, they get updated. |
|
| 3209 | + * |
|
| 3210 | + * @since 4.4.1 |
|
| 3211 | + * @return void |
|
| 3212 | + */ |
|
| 3213 | + public function recheck_values() |
|
| 3214 | + { |
|
| 3215 | + $this->_set_php_values(); |
|
| 3216 | + } |
|
| 3217 | 3217 | } |
| 3218 | 3218 | |
| 3219 | 3219 | /** |
@@ -3226,21 +3226,21 @@ discard block |
||
| 3226 | 3226 | class EE_Tax_Config extends EE_Config_Base |
| 3227 | 3227 | { |
| 3228 | 3228 | |
| 3229 | - /* |
|
| 3229 | + /* |
|
| 3230 | 3230 | * flag to indicate whether or not to display ticket prices with the taxes included |
| 3231 | 3231 | * |
| 3232 | 3232 | * @var boolean $prices_displayed_including_taxes |
| 3233 | 3233 | */ |
| 3234 | - public $prices_displayed_including_taxes; |
|
| 3234 | + public $prices_displayed_including_taxes; |
|
| 3235 | 3235 | |
| 3236 | 3236 | |
| 3237 | - /** |
|
| 3238 | - * class constructor |
|
| 3239 | - */ |
|
| 3240 | - public function __construct() |
|
| 3241 | - { |
|
| 3242 | - $this->prices_displayed_including_taxes = true; |
|
| 3243 | - } |
|
| 3237 | + /** |
|
| 3238 | + * class constructor |
|
| 3239 | + */ |
|
| 3240 | + public function __construct() |
|
| 3241 | + { |
|
| 3242 | + $this->prices_displayed_including_taxes = true; |
|
| 3243 | + } |
|
| 3244 | 3244 | } |
| 3245 | 3245 | |
| 3246 | 3246 | /** |
@@ -3254,19 +3254,19 @@ discard block |
||
| 3254 | 3254 | class EE_Messages_Config extends EE_Config_Base |
| 3255 | 3255 | { |
| 3256 | 3256 | |
| 3257 | - /** |
|
| 3258 | - * This is an integer representing the deletion threshold in months for when old messages will get deleted. |
|
| 3259 | - * A value of 0 represents never deleting. Default is 0. |
|
| 3260 | - * |
|
| 3261 | - * @var integer |
|
| 3262 | - */ |
|
| 3263 | - public $delete_threshold; |
|
| 3257 | + /** |
|
| 3258 | + * This is an integer representing the deletion threshold in months for when old messages will get deleted. |
|
| 3259 | + * A value of 0 represents never deleting. Default is 0. |
|
| 3260 | + * |
|
| 3261 | + * @var integer |
|
| 3262 | + */ |
|
| 3263 | + public $delete_threshold; |
|
| 3264 | 3264 | |
| 3265 | 3265 | |
| 3266 | - public function __construct() |
|
| 3267 | - { |
|
| 3268 | - $this->delete_threshold = 0; |
|
| 3269 | - } |
|
| 3266 | + public function __construct() |
|
| 3267 | + { |
|
| 3268 | + $this->delete_threshold = 0; |
|
| 3269 | + } |
|
| 3270 | 3270 | } |
| 3271 | 3271 | |
| 3272 | 3272 | /** |
@@ -3277,31 +3277,31 @@ discard block |
||
| 3277 | 3277 | class EE_Gateway_Config extends EE_Config_Base |
| 3278 | 3278 | { |
| 3279 | 3279 | |
| 3280 | - /** |
|
| 3281 | - * Array with keys that are payment gateways slugs, and values are arrays |
|
| 3282 | - * with any config info the gateway wants to store |
|
| 3283 | - * |
|
| 3284 | - * @var array |
|
| 3285 | - */ |
|
| 3286 | - public $payment_settings; |
|
| 3287 | - |
|
| 3288 | - /** |
|
| 3289 | - * Where keys are gateway slugs, and values are booleans indicating whether or not |
|
| 3290 | - * the gateway is stored in the uploads directory |
|
| 3291 | - * |
|
| 3292 | - * @var array |
|
| 3293 | - */ |
|
| 3294 | - public $active_gateways; |
|
| 3295 | - |
|
| 3296 | - |
|
| 3297 | - /** |
|
| 3298 | - * class constructor |
|
| 3299 | - * |
|
| 3300 | - * @deprecated |
|
| 3301 | - */ |
|
| 3302 | - public function __construct() |
|
| 3303 | - { |
|
| 3304 | - $this->payment_settings = array(); |
|
| 3305 | - $this->active_gateways = array('Invoice' => false); |
|
| 3306 | - } |
|
| 3280 | + /** |
|
| 3281 | + * Array with keys that are payment gateways slugs, and values are arrays |
|
| 3282 | + * with any config info the gateway wants to store |
|
| 3283 | + * |
|
| 3284 | + * @var array |
|
| 3285 | + */ |
|
| 3286 | + public $payment_settings; |
|
| 3287 | + |
|
| 3288 | + /** |
|
| 3289 | + * Where keys are gateway slugs, and values are booleans indicating whether or not |
|
| 3290 | + * the gateway is stored in the uploads directory |
|
| 3291 | + * |
|
| 3292 | + * @var array |
|
| 3293 | + */ |
|
| 3294 | + public $active_gateways; |
|
| 3295 | + |
|
| 3296 | + |
|
| 3297 | + /** |
|
| 3298 | + * class constructor |
|
| 3299 | + * |
|
| 3300 | + * @deprecated |
|
| 3301 | + */ |
|
| 3302 | + public function __construct() |
|
| 3303 | + { |
|
| 3304 | + $this->payment_settings = array(); |
|
| 3305 | + $this->active_gateways = array('Invoice' => false); |
|
| 3306 | + } |
|
| 3307 | 3307 | } |
@@ -303,7 +303,7 @@ discard block |
||
| 303 | 303 | * ATT_address column |
| 304 | 304 | * |
| 305 | 305 | * @param EE_Attendee $attendee |
| 306 | - * @return mixed |
|
| 306 | + * @return string |
|
| 307 | 307 | * @throws EE_Error |
| 308 | 308 | */ |
| 309 | 309 | public function column_ATT_address(EE_Attendee $attendee) |
@@ -316,7 +316,7 @@ discard block |
||
| 316 | 316 | * ATT_city column |
| 317 | 317 | * |
| 318 | 318 | * @param EE_Attendee $attendee |
| 319 | - * @return mixed |
|
| 319 | + * @return string |
|
| 320 | 320 | * @throws EE_Error |
| 321 | 321 | */ |
| 322 | 322 | public function column_ATT_city(EE_Attendee $attendee) |
@@ -369,7 +369,7 @@ discard block |
||
| 369 | 369 | * Phone Number column |
| 370 | 370 | * |
| 371 | 371 | * @param EE_Attendee $attendee |
| 372 | - * @return mixed |
|
| 372 | + * @return string |
|
| 373 | 373 | * @throws EE_Error |
| 374 | 374 | */ |
| 375 | 375 | public function column_ATT_phone(EE_Attendee $attendee) |
@@ -12,374 +12,374 @@ |
||
| 12 | 12 | */ |
| 13 | 13 | class EE_Attendee_Contact_List_Table extends EE_Admin_List_Table |
| 14 | 14 | { |
| 15 | - /** |
|
| 16 | - * Initial setup of data (called by parent). |
|
| 17 | - */ |
|
| 18 | - protected function _setup_data() |
|
| 19 | - { |
|
| 20 | - $this->_data = $this->_view !== 'trash' |
|
| 21 | - ? $this->_admin_page->get_attendees($this->_per_page) |
|
| 22 | - : $this->_admin_page->get_attendees($this->_per_page, false, true); |
|
| 23 | - $this->_all_data_count = $this->_view !== 'trash' |
|
| 24 | - ? $this->_admin_page->get_attendees($this->_per_page, true) |
|
| 25 | - : $this->_admin_page->get_attendees($this->_per_page, true, true); |
|
| 26 | - } |
|
| 27 | - |
|
| 28 | - |
|
| 29 | - /** |
|
| 30 | - * Initial setup of properties. |
|
| 31 | - */ |
|
| 32 | - protected function _set_properties() |
|
| 33 | - { |
|
| 34 | - $this->_wp_list_args = array( |
|
| 35 | - 'singular' => esc_html__('attendee', 'event_espresso'), |
|
| 36 | - 'plural' => esc_html__('attendees', 'event_espresso'), |
|
| 37 | - 'ajax' => true, |
|
| 38 | - 'screen' => $this->_admin_page->get_current_screen()->id, |
|
| 39 | - ); |
|
| 40 | - |
|
| 41 | - $this->_columns = array( |
|
| 42 | - 'cb' => '<input type="checkbox" />', // Render a checkbox instead of text |
|
| 43 | - 'ATT_ID' => esc_html__('ID', 'event_espresso'), |
|
| 44 | - 'ATT_fname' => esc_html__('First Name', 'event_espresso'), |
|
| 45 | - 'ATT_lname' => esc_html__('Last Name', 'event_espresso'), |
|
| 46 | - 'ATT_email' => esc_html__('Email Address', 'event_espresso'), |
|
| 47 | - 'Registration_Count' => esc_html__('# Registrations', 'event_espresso'), |
|
| 48 | - 'ATT_phone' => esc_html__('Phone', 'event_espresso'), |
|
| 49 | - 'ATT_address' => esc_html__('Address', 'event_espresso'), |
|
| 50 | - 'ATT_city' => esc_html__('City', 'event_espresso'), |
|
| 51 | - 'STA_ID' => esc_html__('State/Province', 'event_espresso'), |
|
| 52 | - 'CNT_ISO' => esc_html__('Country', 'event_espresso'), |
|
| 53 | - ); |
|
| 54 | - |
|
| 55 | - $this->_sortable_columns = array( |
|
| 56 | - 'ATT_ID' => array('ATT_ID' => false), |
|
| 57 | - 'ATT_lname' => array('ATT_lname' => true), // true means its already sorted |
|
| 58 | - 'ATT_fname' => array('ATT_fname' => false), |
|
| 59 | - 'ATT_email' => array('ATT_email' => false), |
|
| 60 | - 'Registration_Count' => array('Registration_Count' => false), |
|
| 61 | - 'ATT_city' => array('ATT_city' => false), |
|
| 62 | - 'STA_ID' => array('STA_ID' => false), |
|
| 63 | - 'CNT_ISO' => array('CNT_ISO' => false), |
|
| 64 | - ); |
|
| 65 | - |
|
| 66 | - $this->_hidden_columns = array( |
|
| 67 | - 'ATT_phone', |
|
| 68 | - 'ATT_address', |
|
| 69 | - 'ATT_city', |
|
| 70 | - 'STA_ID', |
|
| 71 | - 'CNT_ISO', |
|
| 72 | - ); |
|
| 73 | - } |
|
| 74 | - |
|
| 75 | - |
|
| 76 | - /** |
|
| 77 | - * Initial setup of filters |
|
| 78 | - * |
|
| 79 | - * @return array |
|
| 80 | - */ |
|
| 81 | - protected function _get_table_filters() |
|
| 82 | - { |
|
| 83 | - return array(); |
|
| 84 | - } |
|
| 85 | - |
|
| 86 | - |
|
| 87 | - /** |
|
| 88 | - * Initial setup of counts for views |
|
| 89 | - * |
|
| 90 | - * @throws InvalidArgumentException |
|
| 91 | - * @throws InvalidDataTypeException |
|
| 92 | - * @throws InvalidInterfaceException |
|
| 93 | - */ |
|
| 94 | - protected function _add_view_counts() |
|
| 95 | - { |
|
| 96 | - $this->_views['in_use']['count'] = $this->_admin_page->get_attendees($this->_per_page, true); |
|
| 97 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
| 98 | - 'ee_delete_contacts', |
|
| 99 | - 'espresso_registrations_delete_registration' |
|
| 100 | - )) { |
|
| 101 | - $this->_views['trash']['count'] = $this->_admin_page->get_attendees($this->_per_page, true, true); |
|
| 102 | - } |
|
| 103 | - } |
|
| 104 | - |
|
| 105 | - |
|
| 106 | - /** |
|
| 107 | - * Get count of attendees. |
|
| 108 | - * |
|
| 109 | - * @return int |
|
| 110 | - * @throws EE_Error |
|
| 111 | - * @throws InvalidArgumentException |
|
| 112 | - * @throws InvalidDataTypeException |
|
| 113 | - * @throws InvalidInterfaceException |
|
| 114 | - */ |
|
| 115 | - protected function _get_attendees_count() |
|
| 116 | - { |
|
| 117 | - return EEM_Attendee::instance()->count(); |
|
| 118 | - } |
|
| 119 | - |
|
| 120 | - |
|
| 121 | - /** |
|
| 122 | - * Checkbox column |
|
| 123 | - * |
|
| 124 | - * @param EE_Attendee $attendee Unable to typehint this method because overrides parent. |
|
| 125 | - * @return string |
|
| 126 | - * @throws EE_Error |
|
| 127 | - */ |
|
| 128 | - public function column_cb($attendee) |
|
| 129 | - { |
|
| 130 | - if (! $attendee instanceof EE_Attendee) { |
|
| 131 | - return ''; |
|
| 132 | - } |
|
| 133 | - return sprintf( |
|
| 134 | - '<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />', |
|
| 135 | - $attendee->ID() |
|
| 136 | - ); |
|
| 137 | - } |
|
| 138 | - |
|
| 139 | - |
|
| 140 | - /** |
|
| 141 | - * ATT_ID column |
|
| 142 | - * |
|
| 143 | - * @param EE_Attendee $attendee |
|
| 144 | - * @return string |
|
| 145 | - * @throws EE_Error |
|
| 146 | - */ |
|
| 147 | - public function column_ATT_ID(EE_Attendee $attendee) |
|
| 148 | - { |
|
| 149 | - $content = $attendee->ID(); |
|
| 150 | - $attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : ''; |
|
| 151 | - $content .= ' <span class="show-on-mobile-view-only">' . $attendee_name . '</span>'; |
|
| 152 | - return $content; |
|
| 153 | - } |
|
| 154 | - |
|
| 155 | - |
|
| 156 | - /** |
|
| 157 | - * ATT_lname column |
|
| 158 | - * |
|
| 159 | - * @param EE_Attendee $attendee |
|
| 160 | - * @return string |
|
| 161 | - * @throws InvalidArgumentException |
|
| 162 | - * @throws InvalidDataTypeException |
|
| 163 | - * @throws InvalidInterfaceException |
|
| 164 | - * @throws EE_Error |
|
| 165 | - */ |
|
| 166 | - public function column_ATT_lname(EE_Attendee $attendee) |
|
| 167 | - { |
|
| 168 | - // edit attendee link |
|
| 169 | - $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
| 170 | - array( |
|
| 171 | - 'action' => 'edit_attendee', |
|
| 172 | - 'post' => $attendee->ID(), |
|
| 173 | - ), |
|
| 174 | - REG_ADMIN_URL |
|
| 175 | - ); |
|
| 176 | - $name_link = EE_Registry::instance()->CAP->current_user_can( |
|
| 177 | - 'ee_edit_contacts', |
|
| 178 | - 'espresso_registrations_edit_attendee' |
|
| 179 | - ) |
|
| 180 | - ? '<a href="' . $edit_lnk_url . '" title="' |
|
| 181 | - . esc_attr__('Edit Contact', 'event_espresso') . '">' |
|
| 182 | - . $attendee->lname() . '</a>' |
|
| 183 | - : $attendee->lname(); |
|
| 184 | - return $name_link; |
|
| 185 | - } |
|
| 186 | - |
|
| 187 | - |
|
| 188 | - /** |
|
| 189 | - * ATT_fname column |
|
| 190 | - * |
|
| 191 | - * @param EE_Attendee $attendee |
|
| 192 | - * @return string |
|
| 193 | - * @throws InvalidArgumentException |
|
| 194 | - * @throws InvalidDataTypeException |
|
| 195 | - * @throws InvalidInterfaceException |
|
| 196 | - * @throws EE_Error |
|
| 197 | - */ |
|
| 198 | - public function column_ATT_fname(EE_Attendee $attendee) |
|
| 199 | - { |
|
| 200 | - // Build row actions |
|
| 201 | - $actions = array(); |
|
| 202 | - // edit attendee link |
|
| 203 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
| 204 | - 'ee_edit_contacts', |
|
| 205 | - 'espresso_registrations_edit_attendee' |
|
| 206 | - )) { |
|
| 207 | - $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
| 208 | - array( |
|
| 209 | - 'action' => 'edit_attendee', |
|
| 210 | - 'post' => $attendee->ID(), |
|
| 211 | - ), |
|
| 212 | - REG_ADMIN_URL |
|
| 213 | - ); |
|
| 214 | - $actions['edit'] = '<a href="' . $edit_lnk_url . '" title="' |
|
| 215 | - . esc_attr__('Edit Contact', 'event_espresso') . '">' |
|
| 216 | - . esc_html__('Edit', 'event_espresso') . '</a>'; |
|
| 217 | - } |
|
| 218 | - |
|
| 219 | - if ($this->_view === 'in_use') { |
|
| 220 | - // trash attendee link |
|
| 221 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
| 222 | - 'ee_delete_contacts', |
|
| 223 | - 'espresso_registrations_trash_attendees' |
|
| 224 | - )) { |
|
| 225 | - $trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
| 226 | - array( |
|
| 227 | - 'action' => 'trash_attendee', |
|
| 228 | - 'ATT_ID' => $attendee->ID(), |
|
| 229 | - ), |
|
| 230 | - REG_ADMIN_URL |
|
| 231 | - ); |
|
| 232 | - $actions['trash'] = '<a href="' . $trash_lnk_url . '" title="' |
|
| 233 | - . esc_attr__('Move Contact to Trash', 'event_espresso') |
|
| 234 | - . '">' . esc_html__('Trash', 'event_espresso') . '</a>'; |
|
| 235 | - } |
|
| 236 | - } else { |
|
| 237 | - if (EE_Registry::instance()->CAP->current_user_can( |
|
| 238 | - 'ee_delete_contacts', |
|
| 239 | - 'espresso_registrations_restore_attendees' |
|
| 240 | - )) { |
|
| 241 | - // restore attendee link |
|
| 242 | - $restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
| 243 | - array( |
|
| 244 | - 'action' => 'restore_attendees', |
|
| 245 | - 'ATT_ID' => $attendee->ID(), |
|
| 246 | - ), |
|
| 247 | - REG_ADMIN_URL |
|
| 248 | - ); |
|
| 249 | - $actions['restore'] = '<a href="' . $restore_lnk_url . '" title="' |
|
| 250 | - . esc_attr__('Restore Contact', 'event_espresso') . '">' |
|
| 251 | - . esc_html__('Restore', 'event_espresso') . '</a>'; |
|
| 252 | - } |
|
| 253 | - } |
|
| 254 | - |
|
| 255 | - $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
| 256 | - array( |
|
| 257 | - 'action' => 'edit_attendee', |
|
| 258 | - 'post' => $attendee->ID(), |
|
| 259 | - ), |
|
| 260 | - REG_ADMIN_URL |
|
| 261 | - ); |
|
| 262 | - $name_link = EE_Registry::instance()->CAP->current_user_can( |
|
| 263 | - 'ee_edit_contacts', |
|
| 264 | - 'espresso_registrations_edit_attendee' |
|
| 265 | - ) |
|
| 266 | - ? '<a href="' . $edit_lnk_url . '" title="' |
|
| 267 | - . esc_attr__('Edit Contact', 'event_espresso') . '">' . $attendee->fname() . '</a>' |
|
| 268 | - : $attendee->fname(); |
|
| 269 | - |
|
| 270 | - // Return the name contents |
|
| 271 | - return sprintf('%1$s %2$s', $name_link, $this->row_actions($actions)); |
|
| 272 | - } |
|
| 273 | - |
|
| 274 | - |
|
| 275 | - /** |
|
| 276 | - * Email Column |
|
| 277 | - * |
|
| 278 | - * @param EE_Attendee $attendee |
|
| 279 | - * @return string |
|
| 280 | - * @throws EE_Error |
|
| 281 | - */ |
|
| 282 | - public function column_ATT_email(EE_Attendee $attendee) |
|
| 283 | - { |
|
| 284 | - return '<a href="mailto:' . $attendee->email() . '">' . $attendee->email() . '</a>'; |
|
| 285 | - } |
|
| 286 | - |
|
| 287 | - |
|
| 288 | - /** |
|
| 289 | - * Column displaying count of registrations attached to Attendee. |
|
| 290 | - * |
|
| 291 | - * @param EE_Attendee $attendee |
|
| 292 | - * @return string |
|
| 293 | - * @throws EE_Error |
|
| 294 | - */ |
|
| 295 | - public function column_Registration_Count(EE_Attendee $attendee) |
|
| 296 | - { |
|
| 297 | - $link = EEH_URL::add_query_args_and_nonce( |
|
| 298 | - array( |
|
| 299 | - 'action' => 'default', |
|
| 300 | - 'ATT_ID' => $attendee->ID(), |
|
| 301 | - ), |
|
| 302 | - REG_ADMIN_URL |
|
| 303 | - ); |
|
| 304 | - return '<a href="' . $link . '">' . $attendee->getCustomSelect('Registration_Count') . '</a>'; |
|
| 305 | - } |
|
| 306 | - |
|
| 307 | - |
|
| 308 | - /** |
|
| 309 | - * ATT_address column |
|
| 310 | - * |
|
| 311 | - * @param EE_Attendee $attendee |
|
| 312 | - * @return mixed |
|
| 313 | - * @throws EE_Error |
|
| 314 | - */ |
|
| 315 | - public function column_ATT_address(EE_Attendee $attendee) |
|
| 316 | - { |
|
| 317 | - return $attendee->address(); |
|
| 318 | - } |
|
| 319 | - |
|
| 320 | - |
|
| 321 | - /** |
|
| 322 | - * ATT_city column |
|
| 323 | - * |
|
| 324 | - * @param EE_Attendee $attendee |
|
| 325 | - * @return mixed |
|
| 326 | - * @throws EE_Error |
|
| 327 | - */ |
|
| 328 | - public function column_ATT_city(EE_Attendee $attendee) |
|
| 329 | - { |
|
| 330 | - return $attendee->city(); |
|
| 331 | - } |
|
| 332 | - |
|
| 333 | - |
|
| 334 | - /** |
|
| 335 | - * State Column |
|
| 336 | - * |
|
| 337 | - * @param EE_Attendee $attendee |
|
| 338 | - * @return string |
|
| 339 | - * @throws EE_Error |
|
| 340 | - * @throws InvalidArgumentException |
|
| 341 | - * @throws InvalidDataTypeException |
|
| 342 | - * @throws InvalidInterfaceException |
|
| 343 | - */ |
|
| 344 | - public function column_STA_ID(EE_Attendee $attendee) |
|
| 345 | - { |
|
| 346 | - $states = EEM_State::instance()->get_all_states(); |
|
| 347 | - $state = isset($states[ $attendee->state_ID() ]) |
|
| 348 | - ? $states[ $attendee->state_ID() ]->get('STA_name') |
|
| 349 | - : $attendee->state_ID(); |
|
| 350 | - return ! is_numeric($state) ? $state : ''; |
|
| 351 | - } |
|
| 352 | - |
|
| 353 | - |
|
| 354 | - /** |
|
| 355 | - * Country Column |
|
| 356 | - * |
|
| 357 | - * @param EE_Attendee $attendee |
|
| 358 | - * @return string |
|
| 359 | - * @throws EE_Error |
|
| 360 | - * @throws InvalidArgumentException |
|
| 361 | - * @throws InvalidDataTypeException |
|
| 362 | - * @throws InvalidInterfaceException |
|
| 363 | - */ |
|
| 364 | - public function column_CNT_ISO(EE_Attendee $attendee) |
|
| 365 | - { |
|
| 366 | - $countries = EEM_Country::instance()->get_all_countries(); |
|
| 367 | - $country = isset($countries[ $attendee->country_ID() ]) |
|
| 368 | - ? $countries[ $attendee->country_ID() ]->get('CNT_name') |
|
| 369 | - : $attendee->country_ID(); |
|
| 370 | - return ! is_numeric($country) ? $country : ''; |
|
| 371 | - } |
|
| 372 | - |
|
| 373 | - |
|
| 374 | - /** |
|
| 375 | - * Phone Number column |
|
| 376 | - * |
|
| 377 | - * @param EE_Attendee $attendee |
|
| 378 | - * @return mixed |
|
| 379 | - * @throws EE_Error |
|
| 380 | - */ |
|
| 381 | - public function column_ATT_phone(EE_Attendee $attendee) |
|
| 382 | - { |
|
| 383 | - return $attendee->phone(); |
|
| 384 | - } |
|
| 15 | + /** |
|
| 16 | + * Initial setup of data (called by parent). |
|
| 17 | + */ |
|
| 18 | + protected function _setup_data() |
|
| 19 | + { |
|
| 20 | + $this->_data = $this->_view !== 'trash' |
|
| 21 | + ? $this->_admin_page->get_attendees($this->_per_page) |
|
| 22 | + : $this->_admin_page->get_attendees($this->_per_page, false, true); |
|
| 23 | + $this->_all_data_count = $this->_view !== 'trash' |
|
| 24 | + ? $this->_admin_page->get_attendees($this->_per_page, true) |
|
| 25 | + : $this->_admin_page->get_attendees($this->_per_page, true, true); |
|
| 26 | + } |
|
| 27 | + |
|
| 28 | + |
|
| 29 | + /** |
|
| 30 | + * Initial setup of properties. |
|
| 31 | + */ |
|
| 32 | + protected function _set_properties() |
|
| 33 | + { |
|
| 34 | + $this->_wp_list_args = array( |
|
| 35 | + 'singular' => esc_html__('attendee', 'event_espresso'), |
|
| 36 | + 'plural' => esc_html__('attendees', 'event_espresso'), |
|
| 37 | + 'ajax' => true, |
|
| 38 | + 'screen' => $this->_admin_page->get_current_screen()->id, |
|
| 39 | + ); |
|
| 40 | + |
|
| 41 | + $this->_columns = array( |
|
| 42 | + 'cb' => '<input type="checkbox" />', // Render a checkbox instead of text |
|
| 43 | + 'ATT_ID' => esc_html__('ID', 'event_espresso'), |
|
| 44 | + 'ATT_fname' => esc_html__('First Name', 'event_espresso'), |
|
| 45 | + 'ATT_lname' => esc_html__('Last Name', 'event_espresso'), |
|
| 46 | + 'ATT_email' => esc_html__('Email Address', 'event_espresso'), |
|
| 47 | + 'Registration_Count' => esc_html__('# Registrations', 'event_espresso'), |
|
| 48 | + 'ATT_phone' => esc_html__('Phone', 'event_espresso'), |
|
| 49 | + 'ATT_address' => esc_html__('Address', 'event_espresso'), |
|
| 50 | + 'ATT_city' => esc_html__('City', 'event_espresso'), |
|
| 51 | + 'STA_ID' => esc_html__('State/Province', 'event_espresso'), |
|
| 52 | + 'CNT_ISO' => esc_html__('Country', 'event_espresso'), |
|
| 53 | + ); |
|
| 54 | + |
|
| 55 | + $this->_sortable_columns = array( |
|
| 56 | + 'ATT_ID' => array('ATT_ID' => false), |
|
| 57 | + 'ATT_lname' => array('ATT_lname' => true), // true means its already sorted |
|
| 58 | + 'ATT_fname' => array('ATT_fname' => false), |
|
| 59 | + 'ATT_email' => array('ATT_email' => false), |
|
| 60 | + 'Registration_Count' => array('Registration_Count' => false), |
|
| 61 | + 'ATT_city' => array('ATT_city' => false), |
|
| 62 | + 'STA_ID' => array('STA_ID' => false), |
|
| 63 | + 'CNT_ISO' => array('CNT_ISO' => false), |
|
| 64 | + ); |
|
| 65 | + |
|
| 66 | + $this->_hidden_columns = array( |
|
| 67 | + 'ATT_phone', |
|
| 68 | + 'ATT_address', |
|
| 69 | + 'ATT_city', |
|
| 70 | + 'STA_ID', |
|
| 71 | + 'CNT_ISO', |
|
| 72 | + ); |
|
| 73 | + } |
|
| 74 | + |
|
| 75 | + |
|
| 76 | + /** |
|
| 77 | + * Initial setup of filters |
|
| 78 | + * |
|
| 79 | + * @return array |
|
| 80 | + */ |
|
| 81 | + protected function _get_table_filters() |
|
| 82 | + { |
|
| 83 | + return array(); |
|
| 84 | + } |
|
| 85 | + |
|
| 86 | + |
|
| 87 | + /** |
|
| 88 | + * Initial setup of counts for views |
|
| 89 | + * |
|
| 90 | + * @throws InvalidArgumentException |
|
| 91 | + * @throws InvalidDataTypeException |
|
| 92 | + * @throws InvalidInterfaceException |
|
| 93 | + */ |
|
| 94 | + protected function _add_view_counts() |
|
| 95 | + { |
|
| 96 | + $this->_views['in_use']['count'] = $this->_admin_page->get_attendees($this->_per_page, true); |
|
| 97 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
| 98 | + 'ee_delete_contacts', |
|
| 99 | + 'espresso_registrations_delete_registration' |
|
| 100 | + )) { |
|
| 101 | + $this->_views['trash']['count'] = $this->_admin_page->get_attendees($this->_per_page, true, true); |
|
| 102 | + } |
|
| 103 | + } |
|
| 104 | + |
|
| 105 | + |
|
| 106 | + /** |
|
| 107 | + * Get count of attendees. |
|
| 108 | + * |
|
| 109 | + * @return int |
|
| 110 | + * @throws EE_Error |
|
| 111 | + * @throws InvalidArgumentException |
|
| 112 | + * @throws InvalidDataTypeException |
|
| 113 | + * @throws InvalidInterfaceException |
|
| 114 | + */ |
|
| 115 | + protected function _get_attendees_count() |
|
| 116 | + { |
|
| 117 | + return EEM_Attendee::instance()->count(); |
|
| 118 | + } |
|
| 119 | + |
|
| 120 | + |
|
| 121 | + /** |
|
| 122 | + * Checkbox column |
|
| 123 | + * |
|
| 124 | + * @param EE_Attendee $attendee Unable to typehint this method because overrides parent. |
|
| 125 | + * @return string |
|
| 126 | + * @throws EE_Error |
|
| 127 | + */ |
|
| 128 | + public function column_cb($attendee) |
|
| 129 | + { |
|
| 130 | + if (! $attendee instanceof EE_Attendee) { |
|
| 131 | + return ''; |
|
| 132 | + } |
|
| 133 | + return sprintf( |
|
| 134 | + '<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />', |
|
| 135 | + $attendee->ID() |
|
| 136 | + ); |
|
| 137 | + } |
|
| 138 | + |
|
| 139 | + |
|
| 140 | + /** |
|
| 141 | + * ATT_ID column |
|
| 142 | + * |
|
| 143 | + * @param EE_Attendee $attendee |
|
| 144 | + * @return string |
|
| 145 | + * @throws EE_Error |
|
| 146 | + */ |
|
| 147 | + public function column_ATT_ID(EE_Attendee $attendee) |
|
| 148 | + { |
|
| 149 | + $content = $attendee->ID(); |
|
| 150 | + $attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : ''; |
|
| 151 | + $content .= ' <span class="show-on-mobile-view-only">' . $attendee_name . '</span>'; |
|
| 152 | + return $content; |
|
| 153 | + } |
|
| 154 | + |
|
| 155 | + |
|
| 156 | + /** |
|
| 157 | + * ATT_lname column |
|
| 158 | + * |
|
| 159 | + * @param EE_Attendee $attendee |
|
| 160 | + * @return string |
|
| 161 | + * @throws InvalidArgumentException |
|
| 162 | + * @throws InvalidDataTypeException |
|
| 163 | + * @throws InvalidInterfaceException |
|
| 164 | + * @throws EE_Error |
|
| 165 | + */ |
|
| 166 | + public function column_ATT_lname(EE_Attendee $attendee) |
|
| 167 | + { |
|
| 168 | + // edit attendee link |
|
| 169 | + $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
| 170 | + array( |
|
| 171 | + 'action' => 'edit_attendee', |
|
| 172 | + 'post' => $attendee->ID(), |
|
| 173 | + ), |
|
| 174 | + REG_ADMIN_URL |
|
| 175 | + ); |
|
| 176 | + $name_link = EE_Registry::instance()->CAP->current_user_can( |
|
| 177 | + 'ee_edit_contacts', |
|
| 178 | + 'espresso_registrations_edit_attendee' |
|
| 179 | + ) |
|
| 180 | + ? '<a href="' . $edit_lnk_url . '" title="' |
|
| 181 | + . esc_attr__('Edit Contact', 'event_espresso') . '">' |
|
| 182 | + . $attendee->lname() . '</a>' |
|
| 183 | + : $attendee->lname(); |
|
| 184 | + return $name_link; |
|
| 185 | + } |
|
| 186 | + |
|
| 187 | + |
|
| 188 | + /** |
|
| 189 | + * ATT_fname column |
|
| 190 | + * |
|
| 191 | + * @param EE_Attendee $attendee |
|
| 192 | + * @return string |
|
| 193 | + * @throws InvalidArgumentException |
|
| 194 | + * @throws InvalidDataTypeException |
|
| 195 | + * @throws InvalidInterfaceException |
|
| 196 | + * @throws EE_Error |
|
| 197 | + */ |
|
| 198 | + public function column_ATT_fname(EE_Attendee $attendee) |
|
| 199 | + { |
|
| 200 | + // Build row actions |
|
| 201 | + $actions = array(); |
|
| 202 | + // edit attendee link |
|
| 203 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
| 204 | + 'ee_edit_contacts', |
|
| 205 | + 'espresso_registrations_edit_attendee' |
|
| 206 | + )) { |
|
| 207 | + $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
| 208 | + array( |
|
| 209 | + 'action' => 'edit_attendee', |
|
| 210 | + 'post' => $attendee->ID(), |
|
| 211 | + ), |
|
| 212 | + REG_ADMIN_URL |
|
| 213 | + ); |
|
| 214 | + $actions['edit'] = '<a href="' . $edit_lnk_url . '" title="' |
|
| 215 | + . esc_attr__('Edit Contact', 'event_espresso') . '">' |
|
| 216 | + . esc_html__('Edit', 'event_espresso') . '</a>'; |
|
| 217 | + } |
|
| 218 | + |
|
| 219 | + if ($this->_view === 'in_use') { |
|
| 220 | + // trash attendee link |
|
| 221 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
| 222 | + 'ee_delete_contacts', |
|
| 223 | + 'espresso_registrations_trash_attendees' |
|
| 224 | + )) { |
|
| 225 | + $trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
| 226 | + array( |
|
| 227 | + 'action' => 'trash_attendee', |
|
| 228 | + 'ATT_ID' => $attendee->ID(), |
|
| 229 | + ), |
|
| 230 | + REG_ADMIN_URL |
|
| 231 | + ); |
|
| 232 | + $actions['trash'] = '<a href="' . $trash_lnk_url . '" title="' |
|
| 233 | + . esc_attr__('Move Contact to Trash', 'event_espresso') |
|
| 234 | + . '">' . esc_html__('Trash', 'event_espresso') . '</a>'; |
|
| 235 | + } |
|
| 236 | + } else { |
|
| 237 | + if (EE_Registry::instance()->CAP->current_user_can( |
|
| 238 | + 'ee_delete_contacts', |
|
| 239 | + 'espresso_registrations_restore_attendees' |
|
| 240 | + )) { |
|
| 241 | + // restore attendee link |
|
| 242 | + $restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
| 243 | + array( |
|
| 244 | + 'action' => 'restore_attendees', |
|
| 245 | + 'ATT_ID' => $attendee->ID(), |
|
| 246 | + ), |
|
| 247 | + REG_ADMIN_URL |
|
| 248 | + ); |
|
| 249 | + $actions['restore'] = '<a href="' . $restore_lnk_url . '" title="' |
|
| 250 | + . esc_attr__('Restore Contact', 'event_espresso') . '">' |
|
| 251 | + . esc_html__('Restore', 'event_espresso') . '</a>'; |
|
| 252 | + } |
|
| 253 | + } |
|
| 254 | + |
|
| 255 | + $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
| 256 | + array( |
|
| 257 | + 'action' => 'edit_attendee', |
|
| 258 | + 'post' => $attendee->ID(), |
|
| 259 | + ), |
|
| 260 | + REG_ADMIN_URL |
|
| 261 | + ); |
|
| 262 | + $name_link = EE_Registry::instance()->CAP->current_user_can( |
|
| 263 | + 'ee_edit_contacts', |
|
| 264 | + 'espresso_registrations_edit_attendee' |
|
| 265 | + ) |
|
| 266 | + ? '<a href="' . $edit_lnk_url . '" title="' |
|
| 267 | + . esc_attr__('Edit Contact', 'event_espresso') . '">' . $attendee->fname() . '</a>' |
|
| 268 | + : $attendee->fname(); |
|
| 269 | + |
|
| 270 | + // Return the name contents |
|
| 271 | + return sprintf('%1$s %2$s', $name_link, $this->row_actions($actions)); |
|
| 272 | + } |
|
| 273 | + |
|
| 274 | + |
|
| 275 | + /** |
|
| 276 | + * Email Column |
|
| 277 | + * |
|
| 278 | + * @param EE_Attendee $attendee |
|
| 279 | + * @return string |
|
| 280 | + * @throws EE_Error |
|
| 281 | + */ |
|
| 282 | + public function column_ATT_email(EE_Attendee $attendee) |
|
| 283 | + { |
|
| 284 | + return '<a href="mailto:' . $attendee->email() . '">' . $attendee->email() . '</a>'; |
|
| 285 | + } |
|
| 286 | + |
|
| 287 | + |
|
| 288 | + /** |
|
| 289 | + * Column displaying count of registrations attached to Attendee. |
|
| 290 | + * |
|
| 291 | + * @param EE_Attendee $attendee |
|
| 292 | + * @return string |
|
| 293 | + * @throws EE_Error |
|
| 294 | + */ |
|
| 295 | + public function column_Registration_Count(EE_Attendee $attendee) |
|
| 296 | + { |
|
| 297 | + $link = EEH_URL::add_query_args_and_nonce( |
|
| 298 | + array( |
|
| 299 | + 'action' => 'default', |
|
| 300 | + 'ATT_ID' => $attendee->ID(), |
|
| 301 | + ), |
|
| 302 | + REG_ADMIN_URL |
|
| 303 | + ); |
|
| 304 | + return '<a href="' . $link . '">' . $attendee->getCustomSelect('Registration_Count') . '</a>'; |
|
| 305 | + } |
|
| 306 | + |
|
| 307 | + |
|
| 308 | + /** |
|
| 309 | + * ATT_address column |
|
| 310 | + * |
|
| 311 | + * @param EE_Attendee $attendee |
|
| 312 | + * @return mixed |
|
| 313 | + * @throws EE_Error |
|
| 314 | + */ |
|
| 315 | + public function column_ATT_address(EE_Attendee $attendee) |
|
| 316 | + { |
|
| 317 | + return $attendee->address(); |
|
| 318 | + } |
|
| 319 | + |
|
| 320 | + |
|
| 321 | + /** |
|
| 322 | + * ATT_city column |
|
| 323 | + * |
|
| 324 | + * @param EE_Attendee $attendee |
|
| 325 | + * @return mixed |
|
| 326 | + * @throws EE_Error |
|
| 327 | + */ |
|
| 328 | + public function column_ATT_city(EE_Attendee $attendee) |
|
| 329 | + { |
|
| 330 | + return $attendee->city(); |
|
| 331 | + } |
|
| 332 | + |
|
| 333 | + |
|
| 334 | + /** |
|
| 335 | + * State Column |
|
| 336 | + * |
|
| 337 | + * @param EE_Attendee $attendee |
|
| 338 | + * @return string |
|
| 339 | + * @throws EE_Error |
|
| 340 | + * @throws InvalidArgumentException |
|
| 341 | + * @throws InvalidDataTypeException |
|
| 342 | + * @throws InvalidInterfaceException |
|
| 343 | + */ |
|
| 344 | + public function column_STA_ID(EE_Attendee $attendee) |
|
| 345 | + { |
|
| 346 | + $states = EEM_State::instance()->get_all_states(); |
|
| 347 | + $state = isset($states[ $attendee->state_ID() ]) |
|
| 348 | + ? $states[ $attendee->state_ID() ]->get('STA_name') |
|
| 349 | + : $attendee->state_ID(); |
|
| 350 | + return ! is_numeric($state) ? $state : ''; |
|
| 351 | + } |
|
| 352 | + |
|
| 353 | + |
|
| 354 | + /** |
|
| 355 | + * Country Column |
|
| 356 | + * |
|
| 357 | + * @param EE_Attendee $attendee |
|
| 358 | + * @return string |
|
| 359 | + * @throws EE_Error |
|
| 360 | + * @throws InvalidArgumentException |
|
| 361 | + * @throws InvalidDataTypeException |
|
| 362 | + * @throws InvalidInterfaceException |
|
| 363 | + */ |
|
| 364 | + public function column_CNT_ISO(EE_Attendee $attendee) |
|
| 365 | + { |
|
| 366 | + $countries = EEM_Country::instance()->get_all_countries(); |
|
| 367 | + $country = isset($countries[ $attendee->country_ID() ]) |
|
| 368 | + ? $countries[ $attendee->country_ID() ]->get('CNT_name') |
|
| 369 | + : $attendee->country_ID(); |
|
| 370 | + return ! is_numeric($country) ? $country : ''; |
|
| 371 | + } |
|
| 372 | + |
|
| 373 | + |
|
| 374 | + /** |
|
| 375 | + * Phone Number column |
|
| 376 | + * |
|
| 377 | + * @param EE_Attendee $attendee |
|
| 378 | + * @return mixed |
|
| 379 | + * @throws EE_Error |
|
| 380 | + */ |
|
| 381 | + public function column_ATT_phone(EE_Attendee $attendee) |
|
| 382 | + { |
|
| 383 | + return $attendee->phone(); |
|
| 384 | + } |
|
| 385 | 385 | } |
@@ -127,7 +127,7 @@ discard block |
||
| 127 | 127 | */ |
| 128 | 128 | public function column_cb($attendee) |
| 129 | 129 | { |
| 130 | - if (! $attendee instanceof EE_Attendee) { |
|
| 130 | + if ( ! $attendee instanceof EE_Attendee) { |
|
| 131 | 131 | return ''; |
| 132 | 132 | } |
| 133 | 133 | return sprintf( |
@@ -148,7 +148,7 @@ discard block |
||
| 148 | 148 | { |
| 149 | 149 | $content = $attendee->ID(); |
| 150 | 150 | $attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : ''; |
| 151 | - $content .= ' <span class="show-on-mobile-view-only">' . $attendee_name . '</span>'; |
|
| 151 | + $content .= ' <span class="show-on-mobile-view-only">'.$attendee_name.'</span>'; |
|
| 152 | 152 | return $content; |
| 153 | 153 | } |
| 154 | 154 | |
@@ -177,9 +177,9 @@ discard block |
||
| 177 | 177 | 'ee_edit_contacts', |
| 178 | 178 | 'espresso_registrations_edit_attendee' |
| 179 | 179 | ) |
| 180 | - ? '<a href="' . $edit_lnk_url . '" title="' |
|
| 181 | - . esc_attr__('Edit Contact', 'event_espresso') . '">' |
|
| 182 | - . $attendee->lname() . '</a>' |
|
| 180 | + ? '<a href="'.$edit_lnk_url.'" title="' |
|
| 181 | + . esc_attr__('Edit Contact', 'event_espresso').'">' |
|
| 182 | + . $attendee->lname().'</a>' |
|
| 183 | 183 | : $attendee->lname(); |
| 184 | 184 | return $name_link; |
| 185 | 185 | } |
@@ -211,9 +211,9 @@ discard block |
||
| 211 | 211 | ), |
| 212 | 212 | REG_ADMIN_URL |
| 213 | 213 | ); |
| 214 | - $actions['edit'] = '<a href="' . $edit_lnk_url . '" title="' |
|
| 215 | - . esc_attr__('Edit Contact', 'event_espresso') . '">' |
|
| 216 | - . esc_html__('Edit', 'event_espresso') . '</a>'; |
|
| 214 | + $actions['edit'] = '<a href="'.$edit_lnk_url.'" title="' |
|
| 215 | + . esc_attr__('Edit Contact', 'event_espresso').'">' |
|
| 216 | + . esc_html__('Edit', 'event_espresso').'</a>'; |
|
| 217 | 217 | } |
| 218 | 218 | |
| 219 | 219 | if ($this->_view === 'in_use') { |
@@ -229,9 +229,9 @@ discard block |
||
| 229 | 229 | ), |
| 230 | 230 | REG_ADMIN_URL |
| 231 | 231 | ); |
| 232 | - $actions['trash'] = '<a href="' . $trash_lnk_url . '" title="' |
|
| 232 | + $actions['trash'] = '<a href="'.$trash_lnk_url.'" title="' |
|
| 233 | 233 | . esc_attr__('Move Contact to Trash', 'event_espresso') |
| 234 | - . '">' . esc_html__('Trash', 'event_espresso') . '</a>'; |
|
| 234 | + . '">'.esc_html__('Trash', 'event_espresso').'</a>'; |
|
| 235 | 235 | } |
| 236 | 236 | } else { |
| 237 | 237 | if (EE_Registry::instance()->CAP->current_user_can( |
@@ -246,9 +246,9 @@ discard block |
||
| 246 | 246 | ), |
| 247 | 247 | REG_ADMIN_URL |
| 248 | 248 | ); |
| 249 | - $actions['restore'] = '<a href="' . $restore_lnk_url . '" title="' |
|
| 250 | - . esc_attr__('Restore Contact', 'event_espresso') . '">' |
|
| 251 | - . esc_html__('Restore', 'event_espresso') . '</a>'; |
|
| 249 | + $actions['restore'] = '<a href="'.$restore_lnk_url.'" title="' |
|
| 250 | + . esc_attr__('Restore Contact', 'event_espresso').'">' |
|
| 251 | + . esc_html__('Restore', 'event_espresso').'</a>'; |
|
| 252 | 252 | } |
| 253 | 253 | } |
| 254 | 254 | |
@@ -263,8 +263,8 @@ discard block |
||
| 263 | 263 | 'ee_edit_contacts', |
| 264 | 264 | 'espresso_registrations_edit_attendee' |
| 265 | 265 | ) |
| 266 | - ? '<a href="' . $edit_lnk_url . '" title="' |
|
| 267 | - . esc_attr__('Edit Contact', 'event_espresso') . '">' . $attendee->fname() . '</a>' |
|
| 266 | + ? '<a href="'.$edit_lnk_url.'" title="' |
|
| 267 | + . esc_attr__('Edit Contact', 'event_espresso').'">'.$attendee->fname().'</a>' |
|
| 268 | 268 | : $attendee->fname(); |
| 269 | 269 | |
| 270 | 270 | // Return the name contents |
@@ -281,7 +281,7 @@ discard block |
||
| 281 | 281 | */ |
| 282 | 282 | public function column_ATT_email(EE_Attendee $attendee) |
| 283 | 283 | { |
| 284 | - return '<a href="mailto:' . $attendee->email() . '">' . $attendee->email() . '</a>'; |
|
| 284 | + return '<a href="mailto:'.$attendee->email().'">'.$attendee->email().'</a>'; |
|
| 285 | 285 | } |
| 286 | 286 | |
| 287 | 287 | |
@@ -301,7 +301,7 @@ discard block |
||
| 301 | 301 | ), |
| 302 | 302 | REG_ADMIN_URL |
| 303 | 303 | ); |
| 304 | - return '<a href="' . $link . '">' . $attendee->getCustomSelect('Registration_Count') . '</a>'; |
|
| 304 | + return '<a href="'.$link.'">'.$attendee->getCustomSelect('Registration_Count').'</a>'; |
|
| 305 | 305 | } |
| 306 | 306 | |
| 307 | 307 | |
@@ -344,8 +344,8 @@ discard block |
||
| 344 | 344 | public function column_STA_ID(EE_Attendee $attendee) |
| 345 | 345 | { |
| 346 | 346 | $states = EEM_State::instance()->get_all_states(); |
| 347 | - $state = isset($states[ $attendee->state_ID() ]) |
|
| 348 | - ? $states[ $attendee->state_ID() ]->get('STA_name') |
|
| 347 | + $state = isset($states[$attendee->state_ID()]) |
|
| 348 | + ? $states[$attendee->state_ID()]->get('STA_name') |
|
| 349 | 349 | : $attendee->state_ID(); |
| 350 | 350 | return ! is_numeric($state) ? $state : ''; |
| 351 | 351 | } |
@@ -364,8 +364,8 @@ discard block |
||
| 364 | 364 | public function column_CNT_ISO(EE_Attendee $attendee) |
| 365 | 365 | { |
| 366 | 366 | $countries = EEM_Country::instance()->get_all_countries(); |
| 367 | - $country = isset($countries[ $attendee->country_ID() ]) |
|
| 368 | - ? $countries[ $attendee->country_ID() ]->get('CNT_name') |
|
| 367 | + $country = isset($countries[$attendee->country_ID()]) |
|
| 368 | + ? $countries[$attendee->country_ID()]->get('CNT_name') |
|
| 369 | 369 | : $attendee->country_ID(); |
| 370 | 370 | return ! is_numeric($country) ? $country : ''; |
| 371 | 371 | } |
@@ -25,17 +25,17 @@ |
||
| 25 | 25 | class ModelFactory |
| 26 | 26 | { |
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * @param string $model_name |
|
| 30 | - * @return bool|EEM_Base |
|
| 31 | - * @throws EE_Error |
|
| 32 | - * @throws InvalidDataTypeException |
|
| 33 | - * @throws InvalidInterfaceException |
|
| 34 | - * @throws InvalidArgumentException |
|
| 35 | - * @throws ReflectionException |
|
| 36 | - */ |
|
| 37 | - public static function getModel($model_name) |
|
| 38 | - { |
|
| 39 | - return EE_Registry::instance()->load_model($model_name); |
|
| 40 | - } |
|
| 28 | + /** |
|
| 29 | + * @param string $model_name |
|
| 30 | + * @return bool|EEM_Base |
|
| 31 | + * @throws EE_Error |
|
| 32 | + * @throws InvalidDataTypeException |
|
| 33 | + * @throws InvalidInterfaceException |
|
| 34 | + * @throws InvalidArgumentException |
|
| 35 | + * @throws ReflectionException |
|
| 36 | + */ |
|
| 37 | + public static function getModel($model_name) |
|
| 38 | + { |
|
| 39 | + return EE_Registry::instance()->load_model($model_name); |
|
| 40 | + } |
|
| 41 | 41 | } |
@@ -66,24 +66,24 @@ discard block |
||
| 66 | 66 | public function ticketDatetimeAvailability(EE_Ticket $ticket, $get_original_ticket_spaces = false) |
| 67 | 67 | { |
| 68 | 68 | // if the $_available_spaces array has not been set up yet... |
| 69 | - if (! isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
| 69 | + if ( ! isset($this->available_spaces['tickets'][$ticket->ID()])) { |
|
| 70 | 70 | $this->setInitialTicketDatetimeAvailability($ticket); |
| 71 | 71 | } |
| 72 | 72 | $available_spaces = $ticket->qty() - $ticket->sold(); |
| 73 | - if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
| 73 | + if (isset($this->available_spaces['tickets'][$ticket->ID()])) { |
|
| 74 | 74 | // loop thru tickets, which will ALSO include individual ticket records AND a total |
| 75 | - foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) { |
|
| 75 | + foreach ($this->available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) { |
|
| 76 | 76 | // if we want the original datetime availability BEFORE we started subtracting tickets ? |
| 77 | 77 | if ($get_original_ticket_spaces) { |
| 78 | 78 | // then grab the available spaces from the "tickets" array |
| 79 | 79 | // and compare with the above to get the lowest number |
| 80 | 80 | $available_spaces = min( |
| 81 | 81 | $available_spaces, |
| 82 | - $this->available_spaces['tickets'][ $ticket->ID() ][ $DTD_ID ] |
|
| 82 | + $this->available_spaces['tickets'][$ticket->ID()][$DTD_ID] |
|
| 83 | 83 | ); |
| 84 | 84 | } else { |
| 85 | 85 | // we want the updated ticket availability as stored in the "datetimes" array |
| 86 | - $available_spaces = min($available_spaces, $this->available_spaces['datetimes'][ $DTD_ID ]); |
|
| 86 | + $available_spaces = min($available_spaces, $this->available_spaces['datetimes'][$DTD_ID]); |
|
| 87 | 87 | } |
| 88 | 88 | } |
| 89 | 89 | } |
@@ -114,7 +114,7 @@ discard block |
||
| 114 | 114 | 'order_by' => array('DTT_EVT_start' => 'ASC'), |
| 115 | 115 | ) |
| 116 | 116 | ); |
| 117 | - if (! empty($datetimes)) { |
|
| 117 | + if ( ! empty($datetimes)) { |
|
| 118 | 118 | // now loop thru all of the datetimes |
| 119 | 119 | foreach ($datetimes as $datetime) { |
| 120 | 120 | if ($datetime instanceof EE_Datetime) { |
@@ -122,17 +122,17 @@ discard block |
||
| 122 | 122 | $spaces_remaining = $datetime->spaces_remaining(); |
| 123 | 123 | // save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold |
| 124 | 124 | // or the datetime spaces remaining) to this ticket using the datetime ID as the key |
| 125 | - $this->available_spaces['tickets'][ $ticket->ID() ][ $datetime->ID() ] = min( |
|
| 125 | + $this->available_spaces['tickets'][$ticket->ID()][$datetime->ID()] = min( |
|
| 126 | 126 | $ticket->qty() - $ticket->sold(), |
| 127 | 127 | $spaces_remaining |
| 128 | 128 | ); |
| 129 | 129 | // if the remaining spaces for this datetime is already set, |
| 130 | 130 | // then compare that against the datetime spaces remaining, and take the lowest number, |
| 131 | 131 | // else just take the datetime spaces remaining, and assign to the datetimes array |
| 132 | - $this->available_spaces['datetimes'][ $datetime->ID() ] = isset( |
|
| 133 | - $this->available_spaces['datetimes'][ $datetime->ID() ] |
|
| 132 | + $this->available_spaces['datetimes'][$datetime->ID()] = isset( |
|
| 133 | + $this->available_spaces['datetimes'][$datetime->ID()] |
|
| 134 | 134 | ) |
| 135 | - ? min($this->available_spaces['datetimes'][ $datetime->ID() ], $spaces_remaining) |
|
| 135 | + ? min($this->available_spaces['datetimes'][$datetime->ID()], $spaces_remaining) |
|
| 136 | 136 | : $spaces_remaining; |
| 137 | 137 | } |
| 138 | 138 | } |
@@ -148,11 +148,11 @@ discard block |
||
| 148 | 148 | */ |
| 149 | 149 | public function recalculateTicketDatetimeAvailability(EE_Ticket $ticket, $qty = 0) |
| 150 | 150 | { |
| 151 | - if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
| 151 | + if (isset($this->available_spaces['tickets'][$ticket->ID()])) { |
|
| 152 | 152 | // loop thru tickets, which will ALSO include individual ticket records AND a total |
| 153 | - foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) { |
|
| 153 | + foreach ($this->available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) { |
|
| 154 | 154 | // subtract the qty of selected tickets from each datetime's available spaces this ticket has access to, |
| 155 | - $this->available_spaces['datetimes'][ $DTD_ID ] -= $qty; |
|
| 155 | + $this->available_spaces['datetimes'][$DTD_ID] -= $qty; |
|
| 156 | 156 | } |
| 157 | 157 | } |
| 158 | 158 | } |
@@ -22,215 +22,215 @@ |
||
| 22 | 22 | class TicketDatetimeAvailabilityTracker |
| 23 | 23 | { |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * array of datetimes and the spaces available for them |
|
| 27 | - * |
|
| 28 | - * @var array[][] |
|
| 29 | - */ |
|
| 30 | - private $available_spaces = array(); |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * @var EEM_Datetime $datetime_model |
|
| 34 | - */ |
|
| 35 | - private $datetime_model; |
|
| 36 | - |
|
| 37 | - |
|
| 38 | - /** |
|
| 39 | - * TicketDatetimeAvailabilityTracker constructor. |
|
| 40 | - * |
|
| 41 | - * @param EEM_Datetime $datetime_model |
|
| 42 | - */ |
|
| 43 | - public function __construct(EEM_Datetime $datetime_model) |
|
| 44 | - { |
|
| 45 | - $this->datetime_model = $datetime_model; |
|
| 46 | - } |
|
| 47 | - |
|
| 48 | - |
|
| 49 | - /** |
|
| 50 | - * ticketDatetimeAvailability |
|
| 51 | - * creates an array of tickets plus all of the datetimes available to each ticket |
|
| 52 | - * and tracks the spaces remaining for each of those datetimes |
|
| 53 | - * |
|
| 54 | - * @param EE_Ticket $ticket - selected ticket |
|
| 55 | - * @param bool $get_original_ticket_spaces |
|
| 56 | - * @return int |
|
| 57 | - * @throws EE_Error |
|
| 58 | - * @throws InvalidArgumentException |
|
| 59 | - * @throws InvalidDataTypeException |
|
| 60 | - * @throws InvalidInterfaceException |
|
| 61 | - */ |
|
| 62 | - public function ticketDatetimeAvailability(EE_Ticket $ticket, $get_original_ticket_spaces = false) |
|
| 63 | - { |
|
| 64 | - // if the $_available_spaces array has not been set up yet... |
|
| 65 | - if (! isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
| 66 | - $this->setInitialTicketDatetimeAvailability($ticket); |
|
| 67 | - } |
|
| 68 | - $available_spaces = $ticket->qty() - $ticket->sold(); |
|
| 69 | - if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
| 70 | - // loop thru tickets, which will ALSO include individual ticket records AND a total |
|
| 71 | - foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) { |
|
| 72 | - // if we want the original datetime availability BEFORE we started subtracting tickets ? |
|
| 73 | - if ($get_original_ticket_spaces) { |
|
| 74 | - // then grab the available spaces from the "tickets" array |
|
| 75 | - // and compare with the above to get the lowest number |
|
| 76 | - $available_spaces = min( |
|
| 77 | - $available_spaces, |
|
| 78 | - $this->available_spaces['tickets'][ $ticket->ID() ][ $DTD_ID ] |
|
| 79 | - ); |
|
| 80 | - } else { |
|
| 81 | - // we want the updated ticket availability as stored in the "datetimes" array |
|
| 82 | - $available_spaces = min($available_spaces, $this->available_spaces['datetimes'][ $DTD_ID ]); |
|
| 83 | - } |
|
| 84 | - } |
|
| 85 | - } |
|
| 86 | - return $available_spaces; |
|
| 87 | - } |
|
| 88 | - |
|
| 89 | - |
|
| 90 | - /** |
|
| 91 | - * @param EE_Ticket $ticket |
|
| 92 | - * @return void |
|
| 93 | - * @throws InvalidArgumentException |
|
| 94 | - * @throws InvalidInterfaceException |
|
| 95 | - * @throws InvalidDataTypeException |
|
| 96 | - * @throws EE_Error |
|
| 97 | - */ |
|
| 98 | - private function setInitialTicketDatetimeAvailability(EE_Ticket $ticket) |
|
| 99 | - { |
|
| 100 | - // first, get all of the datetimes that are available to this ticket |
|
| 101 | - $datetimes = $ticket->get_many_related( |
|
| 102 | - 'Datetime', |
|
| 103 | - array( |
|
| 104 | - array( |
|
| 105 | - 'DTT_EVT_end' => array( |
|
| 106 | - '>=', |
|
| 107 | - $this->datetime_model->current_time_for_query('DTT_EVT_end'), |
|
| 108 | - ), |
|
| 109 | - ), |
|
| 110 | - 'order_by' => array('DTT_EVT_start' => 'ASC'), |
|
| 111 | - ) |
|
| 112 | - ); |
|
| 113 | - if (! empty($datetimes)) { |
|
| 114 | - // now loop thru all of the datetimes |
|
| 115 | - foreach ($datetimes as $datetime) { |
|
| 116 | - if ($datetime instanceof EE_Datetime) { |
|
| 117 | - // the number of spaces available for the datetime without considering individual ticket quantities |
|
| 118 | - $spaces_remaining = $datetime->spaces_remaining(); |
|
| 119 | - // save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold |
|
| 120 | - // or the datetime spaces remaining) to this ticket using the datetime ID as the key |
|
| 121 | - $this->available_spaces['tickets'][ $ticket->ID() ][ $datetime->ID() ] = min( |
|
| 122 | - $ticket->qty() - $ticket->sold(), |
|
| 123 | - $spaces_remaining |
|
| 124 | - ); |
|
| 125 | - // if the remaining spaces for this datetime is already set, |
|
| 126 | - // then compare that against the datetime spaces remaining, and take the lowest number, |
|
| 127 | - // else just take the datetime spaces remaining, and assign to the datetimes array |
|
| 128 | - $this->available_spaces['datetimes'][ $datetime->ID() ] = isset( |
|
| 129 | - $this->available_spaces['datetimes'][ $datetime->ID() ] |
|
| 130 | - ) |
|
| 131 | - ? min($this->available_spaces['datetimes'][ $datetime->ID() ], $spaces_remaining) |
|
| 132 | - : $spaces_remaining; |
|
| 133 | - } |
|
| 134 | - } |
|
| 135 | - } |
|
| 136 | - } |
|
| 137 | - |
|
| 138 | - |
|
| 139 | - /** |
|
| 140 | - * @param EE_Ticket $ticket |
|
| 141 | - * @param int $qty |
|
| 142 | - * @return void |
|
| 143 | - * @throws EE_Error |
|
| 144 | - */ |
|
| 145 | - public function recalculateTicketDatetimeAvailability(EE_Ticket $ticket, $qty = 0) |
|
| 146 | - { |
|
| 147 | - if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
| 148 | - // loop thru tickets, which will ALSO include individual ticket records AND a total |
|
| 149 | - foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) { |
|
| 150 | - // subtract the qty of selected tickets from each datetime's available spaces this ticket has access to, |
|
| 151 | - $this->available_spaces['datetimes'][ $DTD_ID ] -= $qty; |
|
| 152 | - } |
|
| 153 | - } |
|
| 154 | - } |
|
| 155 | - |
|
| 156 | - |
|
| 157 | - /** |
|
| 158 | - * @param EE_Ticket $ticket |
|
| 159 | - * @param $qty |
|
| 160 | - * @param int $total_ticket_count |
|
| 161 | - * @throws EE_Error |
|
| 162 | - * @throws InvalidArgumentException |
|
| 163 | - * @throws InvalidDataTypeException |
|
| 164 | - * @throws InvalidInterfaceException |
|
| 165 | - */ |
|
| 166 | - public function processAvailabilityError(EE_Ticket $ticket, $qty, $total_ticket_count = 1) |
|
| 167 | - { |
|
| 168 | - // tickets can not be purchased but let's find the exact number left |
|
| 169 | - // for the last ticket selected PRIOR to subtracting tickets |
|
| 170 | - $available_spaces = $this->ticketDatetimeAvailability($ticket, true); |
|
| 171 | - // greedy greedy greedy eh? |
|
| 172 | - if ($available_spaces > 0) { |
|
| 173 | - if (apply_filters( |
|
| 174 | - 'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_display_availability_error', |
|
| 175 | - true, |
|
| 176 | - $ticket, |
|
| 177 | - $qty, |
|
| 178 | - $available_spaces |
|
| 179 | - )) { |
|
| 180 | - $this->availabilityError( |
|
| 181 | - $available_spaces, |
|
| 182 | - $total_ticket_count |
|
| 183 | - ); |
|
| 184 | - } |
|
| 185 | - } else { |
|
| 186 | - EE_Error::add_error( |
|
| 187 | - esc_html__( |
|
| 188 | - 'We\'re sorry, but there are no available spaces left for this event at this particular date and time.', |
|
| 189 | - 'event_espresso' |
|
| 190 | - ), |
|
| 191 | - __FILE__, |
|
| 192 | - __FUNCTION__, |
|
| 193 | - __LINE__ |
|
| 194 | - ); |
|
| 195 | - } |
|
| 196 | - } |
|
| 197 | - |
|
| 198 | - |
|
| 199 | - /** |
|
| 200 | - * @param int $available_spaces |
|
| 201 | - * @param int $total_ticket_count |
|
| 202 | - */ |
|
| 203 | - private function availabilityError($available_spaces = 1, $total_ticket_count = 1) |
|
| 204 | - { |
|
| 205 | - // add error messaging - we're using the _n function that will generate |
|
| 206 | - // the appropriate singular or plural message based on the number of $available_spaces |
|
| 207 | - if ($total_ticket_count) { |
|
| 208 | - $msg = sprintf( |
|
| 209 | - esc_html( |
|
| 210 | - _n( |
|
| 211 | - 'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.', |
|
| 212 | - 'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.', |
|
| 213 | - $available_spaces, |
|
| 214 | - 'event_espresso' |
|
| 215 | - ) |
|
| 216 | - ), |
|
| 217 | - $available_spaces, |
|
| 218 | - '<br />' |
|
| 219 | - ); |
|
| 220 | - } else { |
|
| 221 | - $msg = sprintf( |
|
| 222 | - esc_html( |
|
| 223 | - _n( |
|
| 224 | - 'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets.', |
|
| 225 | - 'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets.', |
|
| 226 | - $available_spaces, |
|
| 227 | - 'event_espresso' |
|
| 228 | - ) |
|
| 229 | - ), |
|
| 230 | - $available_spaces, |
|
| 231 | - '<br />' |
|
| 232 | - ); |
|
| 233 | - } |
|
| 234 | - EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 235 | - } |
|
| 25 | + /** |
|
| 26 | + * array of datetimes and the spaces available for them |
|
| 27 | + * |
|
| 28 | + * @var array[][] |
|
| 29 | + */ |
|
| 30 | + private $available_spaces = array(); |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * @var EEM_Datetime $datetime_model |
|
| 34 | + */ |
|
| 35 | + private $datetime_model; |
|
| 36 | + |
|
| 37 | + |
|
| 38 | + /** |
|
| 39 | + * TicketDatetimeAvailabilityTracker constructor. |
|
| 40 | + * |
|
| 41 | + * @param EEM_Datetime $datetime_model |
|
| 42 | + */ |
|
| 43 | + public function __construct(EEM_Datetime $datetime_model) |
|
| 44 | + { |
|
| 45 | + $this->datetime_model = $datetime_model; |
|
| 46 | + } |
|
| 47 | + |
|
| 48 | + |
|
| 49 | + /** |
|
| 50 | + * ticketDatetimeAvailability |
|
| 51 | + * creates an array of tickets plus all of the datetimes available to each ticket |
|
| 52 | + * and tracks the spaces remaining for each of those datetimes |
|
| 53 | + * |
|
| 54 | + * @param EE_Ticket $ticket - selected ticket |
|
| 55 | + * @param bool $get_original_ticket_spaces |
|
| 56 | + * @return int |
|
| 57 | + * @throws EE_Error |
|
| 58 | + * @throws InvalidArgumentException |
|
| 59 | + * @throws InvalidDataTypeException |
|
| 60 | + * @throws InvalidInterfaceException |
|
| 61 | + */ |
|
| 62 | + public function ticketDatetimeAvailability(EE_Ticket $ticket, $get_original_ticket_spaces = false) |
|
| 63 | + { |
|
| 64 | + // if the $_available_spaces array has not been set up yet... |
|
| 65 | + if (! isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
| 66 | + $this->setInitialTicketDatetimeAvailability($ticket); |
|
| 67 | + } |
|
| 68 | + $available_spaces = $ticket->qty() - $ticket->sold(); |
|
| 69 | + if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
| 70 | + // loop thru tickets, which will ALSO include individual ticket records AND a total |
|
| 71 | + foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) { |
|
| 72 | + // if we want the original datetime availability BEFORE we started subtracting tickets ? |
|
| 73 | + if ($get_original_ticket_spaces) { |
|
| 74 | + // then grab the available spaces from the "tickets" array |
|
| 75 | + // and compare with the above to get the lowest number |
|
| 76 | + $available_spaces = min( |
|
| 77 | + $available_spaces, |
|
| 78 | + $this->available_spaces['tickets'][ $ticket->ID() ][ $DTD_ID ] |
|
| 79 | + ); |
|
| 80 | + } else { |
|
| 81 | + // we want the updated ticket availability as stored in the "datetimes" array |
|
| 82 | + $available_spaces = min($available_spaces, $this->available_spaces['datetimes'][ $DTD_ID ]); |
|
| 83 | + } |
|
| 84 | + } |
|
| 85 | + } |
|
| 86 | + return $available_spaces; |
|
| 87 | + } |
|
| 88 | + |
|
| 89 | + |
|
| 90 | + /** |
|
| 91 | + * @param EE_Ticket $ticket |
|
| 92 | + * @return void |
|
| 93 | + * @throws InvalidArgumentException |
|
| 94 | + * @throws InvalidInterfaceException |
|
| 95 | + * @throws InvalidDataTypeException |
|
| 96 | + * @throws EE_Error |
|
| 97 | + */ |
|
| 98 | + private function setInitialTicketDatetimeAvailability(EE_Ticket $ticket) |
|
| 99 | + { |
|
| 100 | + // first, get all of the datetimes that are available to this ticket |
|
| 101 | + $datetimes = $ticket->get_many_related( |
|
| 102 | + 'Datetime', |
|
| 103 | + array( |
|
| 104 | + array( |
|
| 105 | + 'DTT_EVT_end' => array( |
|
| 106 | + '>=', |
|
| 107 | + $this->datetime_model->current_time_for_query('DTT_EVT_end'), |
|
| 108 | + ), |
|
| 109 | + ), |
|
| 110 | + 'order_by' => array('DTT_EVT_start' => 'ASC'), |
|
| 111 | + ) |
|
| 112 | + ); |
|
| 113 | + if (! empty($datetimes)) { |
|
| 114 | + // now loop thru all of the datetimes |
|
| 115 | + foreach ($datetimes as $datetime) { |
|
| 116 | + if ($datetime instanceof EE_Datetime) { |
|
| 117 | + // the number of spaces available for the datetime without considering individual ticket quantities |
|
| 118 | + $spaces_remaining = $datetime->spaces_remaining(); |
|
| 119 | + // save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold |
|
| 120 | + // or the datetime spaces remaining) to this ticket using the datetime ID as the key |
|
| 121 | + $this->available_spaces['tickets'][ $ticket->ID() ][ $datetime->ID() ] = min( |
|
| 122 | + $ticket->qty() - $ticket->sold(), |
|
| 123 | + $spaces_remaining |
|
| 124 | + ); |
|
| 125 | + // if the remaining spaces for this datetime is already set, |
|
| 126 | + // then compare that against the datetime spaces remaining, and take the lowest number, |
|
| 127 | + // else just take the datetime spaces remaining, and assign to the datetimes array |
|
| 128 | + $this->available_spaces['datetimes'][ $datetime->ID() ] = isset( |
|
| 129 | + $this->available_spaces['datetimes'][ $datetime->ID() ] |
|
| 130 | + ) |
|
| 131 | + ? min($this->available_spaces['datetimes'][ $datetime->ID() ], $spaces_remaining) |
|
| 132 | + : $spaces_remaining; |
|
| 133 | + } |
|
| 134 | + } |
|
| 135 | + } |
|
| 136 | + } |
|
| 137 | + |
|
| 138 | + |
|
| 139 | + /** |
|
| 140 | + * @param EE_Ticket $ticket |
|
| 141 | + * @param int $qty |
|
| 142 | + * @return void |
|
| 143 | + * @throws EE_Error |
|
| 144 | + */ |
|
| 145 | + public function recalculateTicketDatetimeAvailability(EE_Ticket $ticket, $qty = 0) |
|
| 146 | + { |
|
| 147 | + if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) { |
|
| 148 | + // loop thru tickets, which will ALSO include individual ticket records AND a total |
|
| 149 | + foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) { |
|
| 150 | + // subtract the qty of selected tickets from each datetime's available spaces this ticket has access to, |
|
| 151 | + $this->available_spaces['datetimes'][ $DTD_ID ] -= $qty; |
|
| 152 | + } |
|
| 153 | + } |
|
| 154 | + } |
|
| 155 | + |
|
| 156 | + |
|
| 157 | + /** |
|
| 158 | + * @param EE_Ticket $ticket |
|
| 159 | + * @param $qty |
|
| 160 | + * @param int $total_ticket_count |
|
| 161 | + * @throws EE_Error |
|
| 162 | + * @throws InvalidArgumentException |
|
| 163 | + * @throws InvalidDataTypeException |
|
| 164 | + * @throws InvalidInterfaceException |
|
| 165 | + */ |
|
| 166 | + public function processAvailabilityError(EE_Ticket $ticket, $qty, $total_ticket_count = 1) |
|
| 167 | + { |
|
| 168 | + // tickets can not be purchased but let's find the exact number left |
|
| 169 | + // for the last ticket selected PRIOR to subtracting tickets |
|
| 170 | + $available_spaces = $this->ticketDatetimeAvailability($ticket, true); |
|
| 171 | + // greedy greedy greedy eh? |
|
| 172 | + if ($available_spaces > 0) { |
|
| 173 | + if (apply_filters( |
|
| 174 | + 'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_display_availability_error', |
|
| 175 | + true, |
|
| 176 | + $ticket, |
|
| 177 | + $qty, |
|
| 178 | + $available_spaces |
|
| 179 | + )) { |
|
| 180 | + $this->availabilityError( |
|
| 181 | + $available_spaces, |
|
| 182 | + $total_ticket_count |
|
| 183 | + ); |
|
| 184 | + } |
|
| 185 | + } else { |
|
| 186 | + EE_Error::add_error( |
|
| 187 | + esc_html__( |
|
| 188 | + 'We\'re sorry, but there are no available spaces left for this event at this particular date and time.', |
|
| 189 | + 'event_espresso' |
|
| 190 | + ), |
|
| 191 | + __FILE__, |
|
| 192 | + __FUNCTION__, |
|
| 193 | + __LINE__ |
|
| 194 | + ); |
|
| 195 | + } |
|
| 196 | + } |
|
| 197 | + |
|
| 198 | + |
|
| 199 | + /** |
|
| 200 | + * @param int $available_spaces |
|
| 201 | + * @param int $total_ticket_count |
|
| 202 | + */ |
|
| 203 | + private function availabilityError($available_spaces = 1, $total_ticket_count = 1) |
|
| 204 | + { |
|
| 205 | + // add error messaging - we're using the _n function that will generate |
|
| 206 | + // the appropriate singular or plural message based on the number of $available_spaces |
|
| 207 | + if ($total_ticket_count) { |
|
| 208 | + $msg = sprintf( |
|
| 209 | + esc_html( |
|
| 210 | + _n( |
|
| 211 | + 'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.', |
|
| 212 | + 'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.', |
|
| 213 | + $available_spaces, |
|
| 214 | + 'event_espresso' |
|
| 215 | + ) |
|
| 216 | + ), |
|
| 217 | + $available_spaces, |
|
| 218 | + '<br />' |
|
| 219 | + ); |
|
| 220 | + } else { |
|
| 221 | + $msg = sprintf( |
|
| 222 | + esc_html( |
|
| 223 | + _n( |
|
| 224 | + 'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets.', |
|
| 225 | + 'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets.', |
|
| 226 | + $available_spaces, |
|
| 227 | + 'event_espresso' |
|
| 228 | + ) |
|
| 229 | + ), |
|
| 230 | + $available_spaces, |
|
| 231 | + '<br />' |
|
| 232 | + ); |
|
| 233 | + } |
|
| 234 | + EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__); |
|
| 235 | + } |
|
| 236 | 236 | } |
@@ -130,7 +130,7 @@ discard block |
||
| 130 | 130 | */ |
| 131 | 131 | private function setName($name) |
| 132 | 132 | { |
| 133 | - if (! is_string($name)) { |
|
| 133 | + if ( ! is_string($name)) { |
|
| 134 | 134 | throw new InvalidDataTypeException('$name', $name, 'string'); |
| 135 | 135 | } |
| 136 | 136 | $this->name = sanitize_key($name); |
@@ -154,7 +154,7 @@ discard block |
||
| 154 | 154 | */ |
| 155 | 155 | private function setMessage($message) |
| 156 | 156 | { |
| 157 | - if (! is_string($message)) { |
|
| 157 | + if ( ! is_string($message)) { |
|
| 158 | 158 | throw new InvalidDataTypeException('$message', $message, 'string'); |
| 159 | 159 | } |
| 160 | 160 | global $allowedtags; |
@@ -200,7 +200,7 @@ discard block |
||
| 200 | 200 | */ |
| 201 | 201 | private function setCapability($capability) |
| 202 | 202 | { |
| 203 | - if (! is_string($capability)) { |
|
| 203 | + if ( ! is_string($capability)) { |
|
| 204 | 204 | throw new InvalidDataTypeException('$capability', $capability, 'string'); |
| 205 | 205 | } |
| 206 | 206 | $this->capability = ! empty($capability) ? $capability : 'manage_options'; |
@@ -224,7 +224,7 @@ discard block |
||
| 224 | 224 | */ |
| 225 | 225 | private function setCapContext($cap_context) |
| 226 | 226 | { |
| 227 | - if (! is_string($cap_context)) { |
|
| 227 | + if ( ! is_string($cap_context)) { |
|
| 228 | 228 | throw new InvalidDataTypeException('$cap_context', $cap_context, 'string'); |
| 229 | 229 | } |
| 230 | 230 | $this->cap_context = ! empty($cap_context) ? $cap_context : 'view persistent admin notice'; |
@@ -258,7 +258,7 @@ discard block |
||
| 258 | 258 | */ |
| 259 | 259 | public function getCapCheck() |
| 260 | 260 | { |
| 261 | - if (! $this->cap_check instanceof CapCheckInterface) { |
|
| 261 | + if ( ! $this->cap_check instanceof CapCheckInterface) { |
|
| 262 | 262 | $this->setCapCheck( |
| 263 | 263 | new CapCheck( |
| 264 | 264 | $this->capability, |
@@ -343,10 +343,10 @@ discard block |
||
| 343 | 343 | */ |
| 344 | 344 | public function confirmRegistered() |
| 345 | 345 | { |
| 346 | - if (! apply_filters('PersistentAdminNoticeManager__registerAndSaveNotices__complete', false)) { |
|
| 346 | + if ( ! apply_filters('PersistentAdminNoticeManager__registerAndSaveNotices__complete', false)) { |
|
| 347 | 347 | PersistentAdminNoticeManager::loadRegisterAndSaveNotices(); |
| 348 | 348 | } |
| 349 | - if (! $this->registered && WP_DEBUG) { |
|
| 349 | + if ( ! $this->registered && WP_DEBUG) { |
|
| 350 | 350 | throw new DomainException( |
| 351 | 351 | sprintf( |
| 352 | 352 | esc_html__( |
@@ -25,316 +25,316 @@ |
||
| 25 | 25 | class PersistentAdminNotice implements RequiresCapCheckInterface |
| 26 | 26 | { |
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * @var string $name |
|
| 30 | - */ |
|
| 31 | - protected $name = ''; |
|
| 32 | - |
|
| 33 | - /** |
|
| 34 | - * @var string $message |
|
| 35 | - */ |
|
| 36 | - protected $message = ''; |
|
| 37 | - |
|
| 38 | - /** |
|
| 39 | - * @var boolean $force_update |
|
| 40 | - */ |
|
| 41 | - protected $force_update = false; |
|
| 42 | - |
|
| 43 | - /** |
|
| 44 | - * @var string $capability |
|
| 45 | - */ |
|
| 46 | - protected $capability = 'manage_options'; |
|
| 47 | - |
|
| 48 | - /** |
|
| 49 | - * @var string $cap_context |
|
| 50 | - */ |
|
| 51 | - protected $cap_context = 'view persistent admin notice'; |
|
| 52 | - |
|
| 53 | - /** |
|
| 54 | - * @var boolean $dismissed |
|
| 55 | - */ |
|
| 56 | - protected $dismissed = false; |
|
| 57 | - |
|
| 58 | - /** |
|
| 59 | - * @var CapCheckInterface $cap_check |
|
| 60 | - */ |
|
| 61 | - protected $cap_check; |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * if true, then this notice will be deleted from the database |
|
| 65 | - * |
|
| 66 | - * @var boolean $purge |
|
| 67 | - */ |
|
| 68 | - protected $purge = false; |
|
| 69 | - |
|
| 70 | - /** |
|
| 71 | - * gets set to true if notice is successfully registered with the PersistentAdminNoticeManager |
|
| 72 | - * if false, and WP_DEBUG is on, then an exception will be thrown in the admin footer |
|
| 73 | - * |
|
| 74 | - * @var boolean $registered |
|
| 75 | - */ |
|
| 76 | - private $registered = false; |
|
| 77 | - |
|
| 78 | - |
|
| 79 | - /** |
|
| 80 | - * PersistentAdminNotice constructor |
|
| 81 | - * |
|
| 82 | - * @param string $name [required] the name, or key of the Persistent Admin Notice to be stored |
|
| 83 | - * @param string $message [required] the message to be stored persistently until dismissed |
|
| 84 | - * @param bool $force_update enforce the reappearance of a persistent message |
|
| 85 | - * @param string $capability user capability required to view this notice |
|
| 86 | - * @param string $cap_context description for why the cap check is being performed |
|
| 87 | - * @param bool $dismissed whether or not the user has already dismissed/viewed this notice |
|
| 88 | - * @throws InvalidDataTypeException |
|
| 89 | - */ |
|
| 90 | - public function __construct( |
|
| 91 | - $name, |
|
| 92 | - $message, |
|
| 93 | - $force_update = false, |
|
| 94 | - $capability = 'manage_options', |
|
| 95 | - $cap_context = 'view persistent admin notice', |
|
| 96 | - $dismissed = false |
|
| 97 | - ) { |
|
| 98 | - $this->setName($name); |
|
| 99 | - $this->setMessage($message); |
|
| 100 | - $this->setForceUpdate($force_update); |
|
| 101 | - $this->setCapability($capability); |
|
| 102 | - $this->setCapContext($cap_context); |
|
| 103 | - $this->setDismissed($dismissed); |
|
| 104 | - add_action( |
|
| 105 | - 'AHEE__EventEspresso_core_services_notifications_PersistentAdminNoticeManager__registerNotices', |
|
| 106 | - array($this, 'registerPersistentAdminNotice') |
|
| 107 | - ); |
|
| 108 | - add_action('shutdown', array($this, 'confirmRegistered'), 999); |
|
| 109 | - } |
|
| 110 | - |
|
| 111 | - |
|
| 112 | - /** |
|
| 113 | - * @return string |
|
| 114 | - */ |
|
| 115 | - public function getName() |
|
| 116 | - { |
|
| 117 | - return $this->name; |
|
| 118 | - } |
|
| 119 | - |
|
| 120 | - |
|
| 121 | - /** |
|
| 122 | - * @param string $name |
|
| 123 | - * @throws InvalidDataTypeException |
|
| 124 | - */ |
|
| 125 | - private function setName($name) |
|
| 126 | - { |
|
| 127 | - if (! is_string($name)) { |
|
| 128 | - throw new InvalidDataTypeException('$name', $name, 'string'); |
|
| 129 | - } |
|
| 130 | - $this->name = sanitize_key($name); |
|
| 131 | - } |
|
| 132 | - |
|
| 133 | - |
|
| 134 | - /** |
|
| 135 | - * @return string |
|
| 136 | - */ |
|
| 137 | - public function getMessage() |
|
| 138 | - { |
|
| 139 | - return $this->message; |
|
| 140 | - } |
|
| 141 | - |
|
| 142 | - |
|
| 143 | - /** |
|
| 144 | - * @param string $message |
|
| 145 | - * @throws InvalidDataTypeException |
|
| 146 | - */ |
|
| 147 | - private function setMessage($message) |
|
| 148 | - { |
|
| 149 | - if (! is_string($message)) { |
|
| 150 | - throw new InvalidDataTypeException('$message', $message, 'string'); |
|
| 151 | - } |
|
| 152 | - global $allowedtags; |
|
| 153 | - $allowedtags['br'] = array(); |
|
| 154 | - $this->message = wp_kses($message, $allowedtags); |
|
| 155 | - } |
|
| 156 | - |
|
| 157 | - |
|
| 158 | - /** |
|
| 159 | - * @return bool |
|
| 160 | - */ |
|
| 161 | - public function getForceUpdate() |
|
| 162 | - { |
|
| 163 | - return $this->force_update; |
|
| 164 | - } |
|
| 165 | - |
|
| 166 | - |
|
| 167 | - /** |
|
| 168 | - * @param bool $force_update |
|
| 169 | - */ |
|
| 170 | - private function setForceUpdate($force_update) |
|
| 171 | - { |
|
| 172 | - $this->force_update = filter_var($force_update, FILTER_VALIDATE_BOOLEAN); |
|
| 173 | - } |
|
| 174 | - |
|
| 175 | - |
|
| 176 | - /** |
|
| 177 | - * @return string |
|
| 178 | - */ |
|
| 179 | - public function getCapability() |
|
| 180 | - { |
|
| 181 | - return $this->capability; |
|
| 182 | - } |
|
| 183 | - |
|
| 184 | - |
|
| 185 | - /** |
|
| 186 | - * @param string $capability |
|
| 187 | - * @throws InvalidDataTypeException |
|
| 188 | - */ |
|
| 189 | - private function setCapability($capability) |
|
| 190 | - { |
|
| 191 | - if (! is_string($capability)) { |
|
| 192 | - throw new InvalidDataTypeException('$capability', $capability, 'string'); |
|
| 193 | - } |
|
| 194 | - $this->capability = ! empty($capability) ? $capability : 'manage_options'; |
|
| 195 | - } |
|
| 196 | - |
|
| 197 | - |
|
| 198 | - /** |
|
| 199 | - * @return string |
|
| 200 | - */ |
|
| 201 | - public function getCapContext() |
|
| 202 | - { |
|
| 203 | - return $this->cap_context; |
|
| 204 | - } |
|
| 205 | - |
|
| 206 | - |
|
| 207 | - /** |
|
| 208 | - * @param string $cap_context |
|
| 209 | - * @throws InvalidDataTypeException |
|
| 210 | - */ |
|
| 211 | - private function setCapContext($cap_context) |
|
| 212 | - { |
|
| 213 | - if (! is_string($cap_context)) { |
|
| 214 | - throw new InvalidDataTypeException('$cap_context', $cap_context, 'string'); |
|
| 215 | - } |
|
| 216 | - $this->cap_context = ! empty($cap_context) ? $cap_context : 'view persistent admin notice'; |
|
| 217 | - } |
|
| 218 | - |
|
| 219 | - |
|
| 220 | - /** |
|
| 221 | - * @return bool |
|
| 222 | - */ |
|
| 223 | - public function getDismissed() |
|
| 224 | - { |
|
| 225 | - return $this->dismissed; |
|
| 226 | - } |
|
| 227 | - |
|
| 228 | - |
|
| 229 | - /** |
|
| 230 | - * @param bool $dismissed |
|
| 231 | - */ |
|
| 232 | - public function setDismissed($dismissed) |
|
| 233 | - { |
|
| 234 | - $this->dismissed = filter_var($dismissed, FILTER_VALIDATE_BOOLEAN); |
|
| 235 | - } |
|
| 236 | - |
|
| 237 | - |
|
| 238 | - /** |
|
| 239 | - * @return CapCheckInterface |
|
| 240 | - * @throws InvalidDataTypeException |
|
| 241 | - */ |
|
| 242 | - public function getCapCheck() |
|
| 243 | - { |
|
| 244 | - if (! $this->cap_check instanceof CapCheckInterface) { |
|
| 245 | - $this->setCapCheck( |
|
| 246 | - new CapCheck( |
|
| 247 | - $this->capability, |
|
| 248 | - $this->cap_context |
|
| 249 | - ) |
|
| 250 | - ); |
|
| 251 | - } |
|
| 252 | - return $this->cap_check; |
|
| 253 | - } |
|
| 254 | - |
|
| 255 | - |
|
| 256 | - /** |
|
| 257 | - * @param CapCheckInterface $cap_check |
|
| 258 | - */ |
|
| 259 | - private function setCapCheck(CapCheckInterface $cap_check) |
|
| 260 | - { |
|
| 261 | - $this->cap_check = $cap_check; |
|
| 262 | - } |
|
| 263 | - |
|
| 264 | - |
|
| 265 | - /** |
|
| 266 | - * @return bool |
|
| 267 | - */ |
|
| 268 | - public function getPurge() |
|
| 269 | - { |
|
| 270 | - return $this->purge; |
|
| 271 | - } |
|
| 272 | - |
|
| 273 | - |
|
| 274 | - /** |
|
| 275 | - * @param bool $purge |
|
| 276 | - */ |
|
| 277 | - public function setPurge($purge) |
|
| 278 | - { |
|
| 279 | - $this->purge = filter_var($purge, FILTER_VALIDATE_BOOLEAN); |
|
| 280 | - } |
|
| 281 | - |
|
| 282 | - |
|
| 283 | - /** |
|
| 284 | - * given a valid PersistentAdminNotice Collection, |
|
| 285 | - * this notice will be added if it is not already found in the collection (using its name as the identifier) |
|
| 286 | - * if an existing notice is found that has already been dismissed, |
|
| 287 | - * but we are overriding with a forced update, then we will toggle its dismissed state, |
|
| 288 | - * so that the notice is displayed again |
|
| 289 | - * |
|
| 290 | - * @param Collection $persistent_admin_notice_collection |
|
| 291 | - * @throws InvalidEntityException |
|
| 292 | - * @throws InvalidDataTypeException |
|
| 293 | - * @throws DuplicateCollectionIdentifierException |
|
| 294 | - */ |
|
| 295 | - public function registerPersistentAdminNotice(Collection $persistent_admin_notice_collection) |
|
| 296 | - { |
|
| 297 | - if ($this->registered) { |
|
| 298 | - return; |
|
| 299 | - } |
|
| 300 | - // first check if this notice has already been added to the collection |
|
| 301 | - if ($persistent_admin_notice_collection->has($this->name)) { |
|
| 302 | - /** @var PersistentAdminNotice $existing */ |
|
| 303 | - $existing = $persistent_admin_notice_collection->get($this->name); |
|
| 304 | - // we don't need to add it again (we can't actually) |
|
| 305 | - // but if it has already been dismissed, and we are overriding with a forced update |
|
| 306 | - if ($existing->getDismissed() && $this->getForceUpdate()) { |
|
| 307 | - // then toggle the notice's dismissed state to true |
|
| 308 | - // so that it gets displayed again |
|
| 309 | - $existing->setDismissed(false); |
|
| 310 | - // and make sure the message is set |
|
| 311 | - $existing->setMessage($this->message); |
|
| 312 | - } |
|
| 313 | - } else { |
|
| 314 | - $persistent_admin_notice_collection->add($this, $this->name); |
|
| 315 | - } |
|
| 316 | - $this->registered = true; |
|
| 317 | - } |
|
| 318 | - |
|
| 319 | - |
|
| 320 | - /** |
|
| 321 | - * @throws Exception |
|
| 322 | - */ |
|
| 323 | - public function confirmRegistered() |
|
| 324 | - { |
|
| 325 | - if (! apply_filters('PersistentAdminNoticeManager__registerAndSaveNotices__complete', false)) { |
|
| 326 | - PersistentAdminNoticeManager::loadRegisterAndSaveNotices(); |
|
| 327 | - } |
|
| 328 | - if (! $this->registered && WP_DEBUG) { |
|
| 329 | - throw new DomainException( |
|
| 330 | - sprintf( |
|
| 331 | - esc_html__( |
|
| 332 | - 'The "%1$s" PersistentAdminNotice was not successfully registered. Please ensure that it is being created prior to either the "admin_notices" or "network_admin_notices" hooks being triggered.', |
|
| 333 | - 'event_espresso' |
|
| 334 | - ), |
|
| 335 | - $this->name |
|
| 336 | - ) |
|
| 337 | - ); |
|
| 338 | - } |
|
| 339 | - } |
|
| 28 | + /** |
|
| 29 | + * @var string $name |
|
| 30 | + */ |
|
| 31 | + protected $name = ''; |
|
| 32 | + |
|
| 33 | + /** |
|
| 34 | + * @var string $message |
|
| 35 | + */ |
|
| 36 | + protected $message = ''; |
|
| 37 | + |
|
| 38 | + /** |
|
| 39 | + * @var boolean $force_update |
|
| 40 | + */ |
|
| 41 | + protected $force_update = false; |
|
| 42 | + |
|
| 43 | + /** |
|
| 44 | + * @var string $capability |
|
| 45 | + */ |
|
| 46 | + protected $capability = 'manage_options'; |
|
| 47 | + |
|
| 48 | + /** |
|
| 49 | + * @var string $cap_context |
|
| 50 | + */ |
|
| 51 | + protected $cap_context = 'view persistent admin notice'; |
|
| 52 | + |
|
| 53 | + /** |
|
| 54 | + * @var boolean $dismissed |
|
| 55 | + */ |
|
| 56 | + protected $dismissed = false; |
|
| 57 | + |
|
| 58 | + /** |
|
| 59 | + * @var CapCheckInterface $cap_check |
|
| 60 | + */ |
|
| 61 | + protected $cap_check; |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * if true, then this notice will be deleted from the database |
|
| 65 | + * |
|
| 66 | + * @var boolean $purge |
|
| 67 | + */ |
|
| 68 | + protected $purge = false; |
|
| 69 | + |
|
| 70 | + /** |
|
| 71 | + * gets set to true if notice is successfully registered with the PersistentAdminNoticeManager |
|
| 72 | + * if false, and WP_DEBUG is on, then an exception will be thrown in the admin footer |
|
| 73 | + * |
|
| 74 | + * @var boolean $registered |
|
| 75 | + */ |
|
| 76 | + private $registered = false; |
|
| 77 | + |
|
| 78 | + |
|
| 79 | + /** |
|
| 80 | + * PersistentAdminNotice constructor |
|
| 81 | + * |
|
| 82 | + * @param string $name [required] the name, or key of the Persistent Admin Notice to be stored |
|
| 83 | + * @param string $message [required] the message to be stored persistently until dismissed |
|
| 84 | + * @param bool $force_update enforce the reappearance of a persistent message |
|
| 85 | + * @param string $capability user capability required to view this notice |
|
| 86 | + * @param string $cap_context description for why the cap check is being performed |
|
| 87 | + * @param bool $dismissed whether or not the user has already dismissed/viewed this notice |
|
| 88 | + * @throws InvalidDataTypeException |
|
| 89 | + */ |
|
| 90 | + public function __construct( |
|
| 91 | + $name, |
|
| 92 | + $message, |
|
| 93 | + $force_update = false, |
|
| 94 | + $capability = 'manage_options', |
|
| 95 | + $cap_context = 'view persistent admin notice', |
|
| 96 | + $dismissed = false |
|
| 97 | + ) { |
|
| 98 | + $this->setName($name); |
|
| 99 | + $this->setMessage($message); |
|
| 100 | + $this->setForceUpdate($force_update); |
|
| 101 | + $this->setCapability($capability); |
|
| 102 | + $this->setCapContext($cap_context); |
|
| 103 | + $this->setDismissed($dismissed); |
|
| 104 | + add_action( |
|
| 105 | + 'AHEE__EventEspresso_core_services_notifications_PersistentAdminNoticeManager__registerNotices', |
|
| 106 | + array($this, 'registerPersistentAdminNotice') |
|
| 107 | + ); |
|
| 108 | + add_action('shutdown', array($this, 'confirmRegistered'), 999); |
|
| 109 | + } |
|
| 110 | + |
|
| 111 | + |
|
| 112 | + /** |
|
| 113 | + * @return string |
|
| 114 | + */ |
|
| 115 | + public function getName() |
|
| 116 | + { |
|
| 117 | + return $this->name; |
|
| 118 | + } |
|
| 119 | + |
|
| 120 | + |
|
| 121 | + /** |
|
| 122 | + * @param string $name |
|
| 123 | + * @throws InvalidDataTypeException |
|
| 124 | + */ |
|
| 125 | + private function setName($name) |
|
| 126 | + { |
|
| 127 | + if (! is_string($name)) { |
|
| 128 | + throw new InvalidDataTypeException('$name', $name, 'string'); |
|
| 129 | + } |
|
| 130 | + $this->name = sanitize_key($name); |
|
| 131 | + } |
|
| 132 | + |
|
| 133 | + |
|
| 134 | + /** |
|
| 135 | + * @return string |
|
| 136 | + */ |
|
| 137 | + public function getMessage() |
|
| 138 | + { |
|
| 139 | + return $this->message; |
|
| 140 | + } |
|
| 141 | + |
|
| 142 | + |
|
| 143 | + /** |
|
| 144 | + * @param string $message |
|
| 145 | + * @throws InvalidDataTypeException |
|
| 146 | + */ |
|
| 147 | + private function setMessage($message) |
|
| 148 | + { |
|
| 149 | + if (! is_string($message)) { |
|
| 150 | + throw new InvalidDataTypeException('$message', $message, 'string'); |
|
| 151 | + } |
|
| 152 | + global $allowedtags; |
|
| 153 | + $allowedtags['br'] = array(); |
|
| 154 | + $this->message = wp_kses($message, $allowedtags); |
|
| 155 | + } |
|
| 156 | + |
|
| 157 | + |
|
| 158 | + /** |
|
| 159 | + * @return bool |
|
| 160 | + */ |
|
| 161 | + public function getForceUpdate() |
|
| 162 | + { |
|
| 163 | + return $this->force_update; |
|
| 164 | + } |
|
| 165 | + |
|
| 166 | + |
|
| 167 | + /** |
|
| 168 | + * @param bool $force_update |
|
| 169 | + */ |
|
| 170 | + private function setForceUpdate($force_update) |
|
| 171 | + { |
|
| 172 | + $this->force_update = filter_var($force_update, FILTER_VALIDATE_BOOLEAN); |
|
| 173 | + } |
|
| 174 | + |
|
| 175 | + |
|
| 176 | + /** |
|
| 177 | + * @return string |
|
| 178 | + */ |
|
| 179 | + public function getCapability() |
|
| 180 | + { |
|
| 181 | + return $this->capability; |
|
| 182 | + } |
|
| 183 | + |
|
| 184 | + |
|
| 185 | + /** |
|
| 186 | + * @param string $capability |
|
| 187 | + * @throws InvalidDataTypeException |
|
| 188 | + */ |
|
| 189 | + private function setCapability($capability) |
|
| 190 | + { |
|
| 191 | + if (! is_string($capability)) { |
|
| 192 | + throw new InvalidDataTypeException('$capability', $capability, 'string'); |
|
| 193 | + } |
|
| 194 | + $this->capability = ! empty($capability) ? $capability : 'manage_options'; |
|
| 195 | + } |
|
| 196 | + |
|
| 197 | + |
|
| 198 | + /** |
|
| 199 | + * @return string |
|
| 200 | + */ |
|
| 201 | + public function getCapContext() |
|
| 202 | + { |
|
| 203 | + return $this->cap_context; |
|
| 204 | + } |
|
| 205 | + |
|
| 206 | + |
|
| 207 | + /** |
|
| 208 | + * @param string $cap_context |
|
| 209 | + * @throws InvalidDataTypeException |
|
| 210 | + */ |
|
| 211 | + private function setCapContext($cap_context) |
|
| 212 | + { |
|
| 213 | + if (! is_string($cap_context)) { |
|
| 214 | + throw new InvalidDataTypeException('$cap_context', $cap_context, 'string'); |
|
| 215 | + } |
|
| 216 | + $this->cap_context = ! empty($cap_context) ? $cap_context : 'view persistent admin notice'; |
|
| 217 | + } |
|
| 218 | + |
|
| 219 | + |
|
| 220 | + /** |
|
| 221 | + * @return bool |
|
| 222 | + */ |
|
| 223 | + public function getDismissed() |
|
| 224 | + { |
|
| 225 | + return $this->dismissed; |
|
| 226 | + } |
|
| 227 | + |
|
| 228 | + |
|
| 229 | + /** |
|
| 230 | + * @param bool $dismissed |
|
| 231 | + */ |
|
| 232 | + public function setDismissed($dismissed) |
|
| 233 | + { |
|
| 234 | + $this->dismissed = filter_var($dismissed, FILTER_VALIDATE_BOOLEAN); |
|
| 235 | + } |
|
| 236 | + |
|
| 237 | + |
|
| 238 | + /** |
|
| 239 | + * @return CapCheckInterface |
|
| 240 | + * @throws InvalidDataTypeException |
|
| 241 | + */ |
|
| 242 | + public function getCapCheck() |
|
| 243 | + { |
|
| 244 | + if (! $this->cap_check instanceof CapCheckInterface) { |
|
| 245 | + $this->setCapCheck( |
|
| 246 | + new CapCheck( |
|
| 247 | + $this->capability, |
|
| 248 | + $this->cap_context |
|
| 249 | + ) |
|
| 250 | + ); |
|
| 251 | + } |
|
| 252 | + return $this->cap_check; |
|
| 253 | + } |
|
| 254 | + |
|
| 255 | + |
|
| 256 | + /** |
|
| 257 | + * @param CapCheckInterface $cap_check |
|
| 258 | + */ |
|
| 259 | + private function setCapCheck(CapCheckInterface $cap_check) |
|
| 260 | + { |
|
| 261 | + $this->cap_check = $cap_check; |
|
| 262 | + } |
|
| 263 | + |
|
| 264 | + |
|
| 265 | + /** |
|
| 266 | + * @return bool |
|
| 267 | + */ |
|
| 268 | + public function getPurge() |
|
| 269 | + { |
|
| 270 | + return $this->purge; |
|
| 271 | + } |
|
| 272 | + |
|
| 273 | + |
|
| 274 | + /** |
|
| 275 | + * @param bool $purge |
|
| 276 | + */ |
|
| 277 | + public function setPurge($purge) |
|
| 278 | + { |
|
| 279 | + $this->purge = filter_var($purge, FILTER_VALIDATE_BOOLEAN); |
|
| 280 | + } |
|
| 281 | + |
|
| 282 | + |
|
| 283 | + /** |
|
| 284 | + * given a valid PersistentAdminNotice Collection, |
|
| 285 | + * this notice will be added if it is not already found in the collection (using its name as the identifier) |
|
| 286 | + * if an existing notice is found that has already been dismissed, |
|
| 287 | + * but we are overriding with a forced update, then we will toggle its dismissed state, |
|
| 288 | + * so that the notice is displayed again |
|
| 289 | + * |
|
| 290 | + * @param Collection $persistent_admin_notice_collection |
|
| 291 | + * @throws InvalidEntityException |
|
| 292 | + * @throws InvalidDataTypeException |
|
| 293 | + * @throws DuplicateCollectionIdentifierException |
|
| 294 | + */ |
|
| 295 | + public function registerPersistentAdminNotice(Collection $persistent_admin_notice_collection) |
|
| 296 | + { |
|
| 297 | + if ($this->registered) { |
|
| 298 | + return; |
|
| 299 | + } |
|
| 300 | + // first check if this notice has already been added to the collection |
|
| 301 | + if ($persistent_admin_notice_collection->has($this->name)) { |
|
| 302 | + /** @var PersistentAdminNotice $existing */ |
|
| 303 | + $existing = $persistent_admin_notice_collection->get($this->name); |
|
| 304 | + // we don't need to add it again (we can't actually) |
|
| 305 | + // but if it has already been dismissed, and we are overriding with a forced update |
|
| 306 | + if ($existing->getDismissed() && $this->getForceUpdate()) { |
|
| 307 | + // then toggle the notice's dismissed state to true |
|
| 308 | + // so that it gets displayed again |
|
| 309 | + $existing->setDismissed(false); |
|
| 310 | + // and make sure the message is set |
|
| 311 | + $existing->setMessage($this->message); |
|
| 312 | + } |
|
| 313 | + } else { |
|
| 314 | + $persistent_admin_notice_collection->add($this, $this->name); |
|
| 315 | + } |
|
| 316 | + $this->registered = true; |
|
| 317 | + } |
|
| 318 | + |
|
| 319 | + |
|
| 320 | + /** |
|
| 321 | + * @throws Exception |
|
| 322 | + */ |
|
| 323 | + public function confirmRegistered() |
|
| 324 | + { |
|
| 325 | + if (! apply_filters('PersistentAdminNoticeManager__registerAndSaveNotices__complete', false)) { |
|
| 326 | + PersistentAdminNoticeManager::loadRegisterAndSaveNotices(); |
|
| 327 | + } |
|
| 328 | + if (! $this->registered && WP_DEBUG) { |
|
| 329 | + throw new DomainException( |
|
| 330 | + sprintf( |
|
| 331 | + esc_html__( |
|
| 332 | + 'The "%1$s" PersistentAdminNotice was not successfully registered. Please ensure that it is being created prior to either the "admin_notices" or "network_admin_notices" hooks being triggered.', |
|
| 333 | + 'event_espresso' |
|
| 334 | + ), |
|
| 335 | + $this->name |
|
| 336 | + ) |
|
| 337 | + ); |
|
| 338 | + } |
|
| 339 | + } |
|
| 340 | 340 | } |
@@ -14,133 +14,133 @@ |
||
| 14 | 14 | trait EventsAdmin |
| 15 | 15 | { |
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * @param string $additional_params |
|
| 19 | - */ |
|
| 20 | - public function amOnDefaultEventsListTablePage($additional_params = '') |
|
| 21 | - { |
|
| 22 | - $this->actor()->amOnAdminPage(EventsPage::defaultEventsListTableUrl($additional_params)); |
|
| 23 | - } |
|
| 24 | - |
|
| 25 | - |
|
| 26 | - /** |
|
| 27 | - * Triggers the publishing of the Event. |
|
| 28 | - */ |
|
| 29 | - public function publishEvent() |
|
| 30 | - { |
|
| 31 | - $this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR); |
|
| 32 | - $this->actor()->wait(3); |
|
| 33 | - $this->actor()->click(EventsPage::EVENT_EDITOR_PUBLISH_BUTTON_SELECTOR); |
|
| 34 | - $this->actor()->waitForText('Event published.', 30); |
|
| 35 | - } |
|
| 36 | - |
|
| 37 | - |
|
| 38 | - /** |
|
| 39 | - * Triggers saving the Event. |
|
| 40 | - */ |
|
| 41 | - public function saveEvent() |
|
| 42 | - { |
|
| 43 | - $this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR); |
|
| 44 | - $this->actor()->wait(2); |
|
| 45 | - $this->actor()->click(EventsPage::EVENT_EDITOR_SAVE_BUTTON_SELECTOR); |
|
| 46 | - } |
|
| 47 | - |
|
| 48 | - |
|
| 49 | - /** |
|
| 50 | - * Navigates the actor to the event list table page and will attempt to edit the event for the given title. |
|
| 51 | - * First this will search using the given title and then attempt to edit from the results of the search. |
|
| 52 | - * |
|
| 53 | - * Assumes actor is already logged in. |
|
| 54 | - * @param $event_title |
|
| 55 | - */ |
|
| 56 | - public function amEditingTheEventWithTitle($event_title) |
|
| 57 | - { |
|
| 58 | - $this->amOnDefaultEventsListTablePage(); |
|
| 59 | - $this->actor()->fillField(EventsPage::EVENT_LIST_TABLE_SEARCH_INPUT_SELECTOR, $event_title); |
|
| 60 | - $this->actor()->click(CoreAdmin::LIST_TABLE_SEARCH_SUBMIT_SELECTOR); |
|
| 61 | - $this->actor()->waitForText($event_title, 15); |
|
| 62 | - $this->actor()->click(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title)); |
|
| 63 | - } |
|
| 64 | - |
|
| 65 | - |
|
| 66 | - /** |
|
| 67 | - * Navigates the user to the single event page (frontend view) for the given event title via clicking the "View" |
|
| 68 | - * link for the event in the event list table. |
|
| 69 | - * Assumes the actor is already logged in and on the Event list table page. |
|
| 70 | - * |
|
| 71 | - * @param string $event_title |
|
| 72 | - */ |
|
| 73 | - public function amOnEventPageAfterClickingViewLinkInListTableForEvent($event_title) |
|
| 74 | - { |
|
| 75 | - $this->actor()->moveMouseOver(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title)); |
|
| 76 | - $this->actor()->click(EventsPage::eventListTableEventTitleViewLinkSelectorForTitle($event_title)); |
|
| 77 | - } |
|
| 78 | - |
|
| 79 | - |
|
| 80 | - /** |
|
| 81 | - * Used to retrieve the event id for the event via the list table and for the given event. |
|
| 82 | - * @param string $event_title |
|
| 83 | - */ |
|
| 84 | - public function observeEventIdInListTableForEvent($event_title) |
|
| 85 | - { |
|
| 86 | - return $this->actor()->observeValueFromInputAt(EventsPage::eventListTableEventIdSelectorForTitle($event_title)); |
|
| 87 | - } |
|
| 88 | - |
|
| 89 | - |
|
| 90 | - /** |
|
| 91 | - * This performs the click action on the gear icon that triggers the advanced settings view state. |
|
| 92 | - * Assumes the actor is already logged in and editing an event. |
|
| 93 | - * |
|
| 94 | - * @param int $row_number What ticket row to toggle open/close. |
|
| 95 | - */ |
|
| 96 | - public function toggleAdvancedSettingsViewForTicketRow($row_number = 1) |
|
| 97 | - { |
|
| 98 | - $this->actor()->click(EventsPage::eventEditorTicketAdvancedDetailsSelector($row_number)); |
|
| 99 | - } |
|
| 100 | - |
|
| 101 | - |
|
| 102 | - /** |
|
| 103 | - * Toggles the TKT_is_taxable checkbox for the ticket in the given row. |
|
| 104 | - * Assumes the actor is already logged in and editing an event and that the advanced settings view state for that |
|
| 105 | - * ticket is "open". |
|
| 106 | - * |
|
| 107 | - * @param int $row_number What ticket row to toggle the checkbox for. |
|
| 108 | - */ |
|
| 109 | - public function toggleTicketIsTaxableForTicketRow($row_number = 1) |
|
| 110 | - { |
|
| 111 | - $this->actor()->click(EventsPage::eventEditorTicketTaxableCheckboxSelector($row_number)); |
|
| 112 | - } |
|
| 113 | - |
|
| 114 | - |
|
| 115 | - /** |
|
| 116 | - * Use to change the default registration status for the event. |
|
| 117 | - * Assumes the view is already on the event editor. |
|
| 118 | - * @param $registration_status |
|
| 119 | - */ |
|
| 120 | - public function changeDefaultRegistrationStatusTo($registration_status) |
|
| 121 | - { |
|
| 122 | - $this->actor()->selectOption( |
|
| 123 | - EventsPage::EVENT_EDITOR_DEFAULT_REGISTRATION_STATUS_FIELD_SELECTOR, |
|
| 124 | - $registration_status |
|
| 125 | - ); |
|
| 126 | - } |
|
| 127 | - |
|
| 128 | - |
|
| 129 | - /** |
|
| 130 | - * Use this from the context of the event editor to select the given custom template for a given message type and |
|
| 131 | - * messenger. |
|
| 132 | - * |
|
| 133 | - * @param string $message_type_label The visible label for the message type (eg Registration Approved) |
|
| 134 | - * @param string $messenger_slug The slug for the messenger (eg 'email') |
|
| 135 | - * @param string $custom_template_label The visible label in the select input for the custom template you want |
|
| 136 | - * selected. |
|
| 137 | - */ |
|
| 138 | - public function selectCustomTemplateFor($message_type_label, $messenger_slug, $custom_template_label) |
|
| 139 | - { |
|
| 140 | - $this->actor()->click(EventsPage::eventEditorNotificationsMetaBoxMessengerTabSelector($messenger_slug)); |
|
| 141 | - $this->actor()->selectOption( |
|
| 142 | - EventsPage::eventEditorNotificationsMetaBoxSelectSelectorForMessageType($message_type_label), |
|
| 143 | - $custom_template_label |
|
| 144 | - ); |
|
| 145 | - } |
|
| 17 | + /** |
|
| 18 | + * @param string $additional_params |
|
| 19 | + */ |
|
| 20 | + public function amOnDefaultEventsListTablePage($additional_params = '') |
|
| 21 | + { |
|
| 22 | + $this->actor()->amOnAdminPage(EventsPage::defaultEventsListTableUrl($additional_params)); |
|
| 23 | + } |
|
| 24 | + |
|
| 25 | + |
|
| 26 | + /** |
|
| 27 | + * Triggers the publishing of the Event. |
|
| 28 | + */ |
|
| 29 | + public function publishEvent() |
|
| 30 | + { |
|
| 31 | + $this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR); |
|
| 32 | + $this->actor()->wait(3); |
|
| 33 | + $this->actor()->click(EventsPage::EVENT_EDITOR_PUBLISH_BUTTON_SELECTOR); |
|
| 34 | + $this->actor()->waitForText('Event published.', 30); |
|
| 35 | + } |
|
| 36 | + |
|
| 37 | + |
|
| 38 | + /** |
|
| 39 | + * Triggers saving the Event. |
|
| 40 | + */ |
|
| 41 | + public function saveEvent() |
|
| 42 | + { |
|
| 43 | + $this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR); |
|
| 44 | + $this->actor()->wait(2); |
|
| 45 | + $this->actor()->click(EventsPage::EVENT_EDITOR_SAVE_BUTTON_SELECTOR); |
|
| 46 | + } |
|
| 47 | + |
|
| 48 | + |
|
| 49 | + /** |
|
| 50 | + * Navigates the actor to the event list table page and will attempt to edit the event for the given title. |
|
| 51 | + * First this will search using the given title and then attempt to edit from the results of the search. |
|
| 52 | + * |
|
| 53 | + * Assumes actor is already logged in. |
|
| 54 | + * @param $event_title |
|
| 55 | + */ |
|
| 56 | + public function amEditingTheEventWithTitle($event_title) |
|
| 57 | + { |
|
| 58 | + $this->amOnDefaultEventsListTablePage(); |
|
| 59 | + $this->actor()->fillField(EventsPage::EVENT_LIST_TABLE_SEARCH_INPUT_SELECTOR, $event_title); |
|
| 60 | + $this->actor()->click(CoreAdmin::LIST_TABLE_SEARCH_SUBMIT_SELECTOR); |
|
| 61 | + $this->actor()->waitForText($event_title, 15); |
|
| 62 | + $this->actor()->click(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title)); |
|
| 63 | + } |
|
| 64 | + |
|
| 65 | + |
|
| 66 | + /** |
|
| 67 | + * Navigates the user to the single event page (frontend view) for the given event title via clicking the "View" |
|
| 68 | + * link for the event in the event list table. |
|
| 69 | + * Assumes the actor is already logged in and on the Event list table page. |
|
| 70 | + * |
|
| 71 | + * @param string $event_title |
|
| 72 | + */ |
|
| 73 | + public function amOnEventPageAfterClickingViewLinkInListTableForEvent($event_title) |
|
| 74 | + { |
|
| 75 | + $this->actor()->moveMouseOver(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title)); |
|
| 76 | + $this->actor()->click(EventsPage::eventListTableEventTitleViewLinkSelectorForTitle($event_title)); |
|
| 77 | + } |
|
| 78 | + |
|
| 79 | + |
|
| 80 | + /** |
|
| 81 | + * Used to retrieve the event id for the event via the list table and for the given event. |
|
| 82 | + * @param string $event_title |
|
| 83 | + */ |
|
| 84 | + public function observeEventIdInListTableForEvent($event_title) |
|
| 85 | + { |
|
| 86 | + return $this->actor()->observeValueFromInputAt(EventsPage::eventListTableEventIdSelectorForTitle($event_title)); |
|
| 87 | + } |
|
| 88 | + |
|
| 89 | + |
|
| 90 | + /** |
|
| 91 | + * This performs the click action on the gear icon that triggers the advanced settings view state. |
|
| 92 | + * Assumes the actor is already logged in and editing an event. |
|
| 93 | + * |
|
| 94 | + * @param int $row_number What ticket row to toggle open/close. |
|
| 95 | + */ |
|
| 96 | + public function toggleAdvancedSettingsViewForTicketRow($row_number = 1) |
|
| 97 | + { |
|
| 98 | + $this->actor()->click(EventsPage::eventEditorTicketAdvancedDetailsSelector($row_number)); |
|
| 99 | + } |
|
| 100 | + |
|
| 101 | + |
|
| 102 | + /** |
|
| 103 | + * Toggles the TKT_is_taxable checkbox for the ticket in the given row. |
|
| 104 | + * Assumes the actor is already logged in and editing an event and that the advanced settings view state for that |
|
| 105 | + * ticket is "open". |
|
| 106 | + * |
|
| 107 | + * @param int $row_number What ticket row to toggle the checkbox for. |
|
| 108 | + */ |
|
| 109 | + public function toggleTicketIsTaxableForTicketRow($row_number = 1) |
|
| 110 | + { |
|
| 111 | + $this->actor()->click(EventsPage::eventEditorTicketTaxableCheckboxSelector($row_number)); |
|
| 112 | + } |
|
| 113 | + |
|
| 114 | + |
|
| 115 | + /** |
|
| 116 | + * Use to change the default registration status for the event. |
|
| 117 | + * Assumes the view is already on the event editor. |
|
| 118 | + * @param $registration_status |
|
| 119 | + */ |
|
| 120 | + public function changeDefaultRegistrationStatusTo($registration_status) |
|
| 121 | + { |
|
| 122 | + $this->actor()->selectOption( |
|
| 123 | + EventsPage::EVENT_EDITOR_DEFAULT_REGISTRATION_STATUS_FIELD_SELECTOR, |
|
| 124 | + $registration_status |
|
| 125 | + ); |
|
| 126 | + } |
|
| 127 | + |
|
| 128 | + |
|
| 129 | + /** |
|
| 130 | + * Use this from the context of the event editor to select the given custom template for a given message type and |
|
| 131 | + * messenger. |
|
| 132 | + * |
|
| 133 | + * @param string $message_type_label The visible label for the message type (eg Registration Approved) |
|
| 134 | + * @param string $messenger_slug The slug for the messenger (eg 'email') |
|
| 135 | + * @param string $custom_template_label The visible label in the select input for the custom template you want |
|
| 136 | + * selected. |
|
| 137 | + */ |
|
| 138 | + public function selectCustomTemplateFor($message_type_label, $messenger_slug, $custom_template_label) |
|
| 139 | + { |
|
| 140 | + $this->actor()->click(EventsPage::eventEditorNotificationsMetaBoxMessengerTabSelector($messenger_slug)); |
|
| 141 | + $this->actor()->selectOption( |
|
| 142 | + EventsPage::eventEditorNotificationsMetaBoxSelectSelectorForMessageType($message_type_label), |
|
| 143 | + $custom_template_label |
|
| 144 | + ); |
|
| 145 | + } |
|
| 146 | 146 | } |
| 147 | 147 | \ No newline at end of file |
@@ -101,7 +101,7 @@ |
||
| 101 | 101 | /** |
| 102 | 102 | * _get_table_filters |
| 103 | 103 | * |
| 104 | - * @return array |
|
| 104 | + * @return string[] |
|
| 105 | 105 | */ |
| 106 | 106 | protected function _get_table_filters() |
| 107 | 107 | { |
@@ -56,7 +56,7 @@ |
||
| 56 | 56 | . __( |
| 57 | 57 | 'Download Results', |
| 58 | 58 | 'event_espresso' |
| 59 | - ) . "'>"; |
|
| 59 | + )."'>"; |
|
| 60 | 60 | } |
| 61 | 61 | |
| 62 | 62 | |
@@ -13,111 +13,111 @@ discard block |
||
| 13 | 13 | class Payment_Log_Admin_List_Table extends EE_Admin_List_Table |
| 14 | 14 | { |
| 15 | 15 | |
| 16 | - /** |
|
| 17 | - * @param \EE_Admin_Page $admin_page |
|
| 18 | - * @return Payment_Log_Admin_List_Table |
|
| 19 | - */ |
|
| 20 | - public function __construct($admin_page) |
|
| 21 | - { |
|
| 22 | - parent::__construct($admin_page); |
|
| 23 | - } |
|
| 24 | - |
|
| 25 | - |
|
| 26 | - /** |
|
| 27 | - * _setup_data |
|
| 28 | - * |
|
| 29 | - * @return void |
|
| 30 | - */ |
|
| 31 | - protected function _setup_data() |
|
| 32 | - { |
|
| 33 | - $this->_data = $this->_admin_page->get_payment_logs($this->_per_page, $this->_current_page); |
|
| 34 | - // if (isset($this->_req_data['status']) && $this->_req_data['status'] == 'trash') { |
|
| 35 | - // $this->_data = $this->_admin_page->get_trashed_questions($this->_per_page, $this->_current_page, false); |
|
| 36 | - // } else { |
|
| 37 | - // $this->_data = $this->_admin_page->get_questions($this->_per_page, $this->_current_page, false); |
|
| 38 | - // } |
|
| 39 | - $this->_all_data_count = $this->_admin_page->get_payment_logs($this->_per_page, $this->_current_page, true); |
|
| 40 | - add_action( |
|
| 41 | - 'AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons', |
|
| 42 | - array($this, 'add_download_logs_checkbox') |
|
| 43 | - ); |
|
| 44 | - } |
|
| 45 | - |
|
| 46 | - |
|
| 47 | - /** |
|
| 48 | - * add_download_logs_checkbox |
|
| 49 | - * adds a checkbox to the bottom of the list table, instead of at the top with the rest of the filters |
|
| 50 | - * |
|
| 51 | - * @return void |
|
| 52 | - */ |
|
| 53 | - public function add_download_logs_checkbox() |
|
| 54 | - { |
|
| 55 | - echo "<input type='submit' class='button-primary' id='download_results' name='download_results' value='" |
|
| 56 | - . __( |
|
| 57 | - 'Download Results', |
|
| 58 | - 'event_espresso' |
|
| 59 | - ) . "'>"; |
|
| 60 | - } |
|
| 61 | - |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * _set_properties |
|
| 65 | - * |
|
| 66 | - * @return void |
|
| 67 | - */ |
|
| 68 | - protected function _set_properties() |
|
| 69 | - { |
|
| 70 | - $this->_wp_list_args = array( |
|
| 71 | - 'singular' => __('payment log', 'event_espresso'), |
|
| 72 | - 'plural' => __('payment logs', 'event_espresso'), |
|
| 73 | - 'ajax' => true, // for now, |
|
| 74 | - 'screen' => $this->_admin_page->get_current_screen()->id, |
|
| 75 | - ); |
|
| 76 | - $this->_columns = array( |
|
| 77 | - 'cb' => '<input type="checkbox" />', |
|
| 78 | - 'id' => __('ID', 'event_espresso'), |
|
| 79 | - 'LOG_time' => __('Time', 'event_espresso'), |
|
| 80 | - 'PMD_ID' => __('Payment Method', 'event_espresso'), |
|
| 81 | - 'TXN_ID' => __('Transaction ID', 'event_espresso'), |
|
| 82 | - ); |
|
| 83 | - $this->_sortable_columns = array( |
|
| 84 | - 'LOG_time' => array('LOG_time' => true), |
|
| 85 | - ); |
|
| 86 | - $this->_hidden_columns = array(); |
|
| 87 | - } |
|
| 88 | - |
|
| 89 | - |
|
| 90 | - /** |
|
| 91 | - * _get_table_filters |
|
| 92 | - * |
|
| 93 | - * @return array |
|
| 94 | - */ |
|
| 95 | - protected function _get_table_filters() |
|
| 96 | - { |
|
| 97 | - $filters = array(); |
|
| 98 | - // todo we're currently using old functions here. We need to move things into the Events_Admin_Page() class as methods. |
|
| 99 | - $payment_methods = EEM_Payment_Method::instance()->get_all(); |
|
| 100 | - $payment_method_names = array( |
|
| 101 | - array('id' => 'all', 'text' => __("All", 'event_espresso')), |
|
| 102 | - array('id' => '0', 'text' => __("Unknown Payment Method", 'event_espresso')), |
|
| 103 | - ); |
|
| 104 | - foreach ($payment_methods as $payment_method) { |
|
| 105 | - $payment_method_names[] = array('id' => $payment_method->ID(), 'text' => $payment_method->admin_name()); |
|
| 106 | - } |
|
| 107 | - $filters[] = EEH_Form_Fields::select_input( |
|
| 108 | - '_payment_method', |
|
| 109 | - $payment_method_names, |
|
| 110 | - isset($this->_req_data['_payment_method']) |
|
| 111 | - ? $this->_req_data['_payment_method'] : 'all' |
|
| 112 | - ); |
|
| 113 | - $start_date = isset($this->_req_data['payment-filter-start-date']) ? wp_strip_all_tags( |
|
| 114 | - $this->_req_data['payment-filter-start-date'] |
|
| 115 | - ) : date('m/d/Y', strtotime('-6 months')); |
|
| 116 | - $end_date = isset($this->_req_data['payment-filter-end-date']) ? wp_strip_all_tags( |
|
| 117 | - $this->_req_data['payment-filter-end-date'] |
|
| 118 | - ) : date('m/d/Y'); |
|
| 119 | - ob_start(); |
|
| 120 | - ?> |
|
| 16 | + /** |
|
| 17 | + * @param \EE_Admin_Page $admin_page |
|
| 18 | + * @return Payment_Log_Admin_List_Table |
|
| 19 | + */ |
|
| 20 | + public function __construct($admin_page) |
|
| 21 | + { |
|
| 22 | + parent::__construct($admin_page); |
|
| 23 | + } |
|
| 24 | + |
|
| 25 | + |
|
| 26 | + /** |
|
| 27 | + * _setup_data |
|
| 28 | + * |
|
| 29 | + * @return void |
|
| 30 | + */ |
|
| 31 | + protected function _setup_data() |
|
| 32 | + { |
|
| 33 | + $this->_data = $this->_admin_page->get_payment_logs($this->_per_page, $this->_current_page); |
|
| 34 | + // if (isset($this->_req_data['status']) && $this->_req_data['status'] == 'trash') { |
|
| 35 | + // $this->_data = $this->_admin_page->get_trashed_questions($this->_per_page, $this->_current_page, false); |
|
| 36 | + // } else { |
|
| 37 | + // $this->_data = $this->_admin_page->get_questions($this->_per_page, $this->_current_page, false); |
|
| 38 | + // } |
|
| 39 | + $this->_all_data_count = $this->_admin_page->get_payment_logs($this->_per_page, $this->_current_page, true); |
|
| 40 | + add_action( |
|
| 41 | + 'AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons', |
|
| 42 | + array($this, 'add_download_logs_checkbox') |
|
| 43 | + ); |
|
| 44 | + } |
|
| 45 | + |
|
| 46 | + |
|
| 47 | + /** |
|
| 48 | + * add_download_logs_checkbox |
|
| 49 | + * adds a checkbox to the bottom of the list table, instead of at the top with the rest of the filters |
|
| 50 | + * |
|
| 51 | + * @return void |
|
| 52 | + */ |
|
| 53 | + public function add_download_logs_checkbox() |
|
| 54 | + { |
|
| 55 | + echo "<input type='submit' class='button-primary' id='download_results' name='download_results' value='" |
|
| 56 | + . __( |
|
| 57 | + 'Download Results', |
|
| 58 | + 'event_espresso' |
|
| 59 | + ) . "'>"; |
|
| 60 | + } |
|
| 61 | + |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * _set_properties |
|
| 65 | + * |
|
| 66 | + * @return void |
|
| 67 | + */ |
|
| 68 | + protected function _set_properties() |
|
| 69 | + { |
|
| 70 | + $this->_wp_list_args = array( |
|
| 71 | + 'singular' => __('payment log', 'event_espresso'), |
|
| 72 | + 'plural' => __('payment logs', 'event_espresso'), |
|
| 73 | + 'ajax' => true, // for now, |
|
| 74 | + 'screen' => $this->_admin_page->get_current_screen()->id, |
|
| 75 | + ); |
|
| 76 | + $this->_columns = array( |
|
| 77 | + 'cb' => '<input type="checkbox" />', |
|
| 78 | + 'id' => __('ID', 'event_espresso'), |
|
| 79 | + 'LOG_time' => __('Time', 'event_espresso'), |
|
| 80 | + 'PMD_ID' => __('Payment Method', 'event_espresso'), |
|
| 81 | + 'TXN_ID' => __('Transaction ID', 'event_espresso'), |
|
| 82 | + ); |
|
| 83 | + $this->_sortable_columns = array( |
|
| 84 | + 'LOG_time' => array('LOG_time' => true), |
|
| 85 | + ); |
|
| 86 | + $this->_hidden_columns = array(); |
|
| 87 | + } |
|
| 88 | + |
|
| 89 | + |
|
| 90 | + /** |
|
| 91 | + * _get_table_filters |
|
| 92 | + * |
|
| 93 | + * @return array |
|
| 94 | + */ |
|
| 95 | + protected function _get_table_filters() |
|
| 96 | + { |
|
| 97 | + $filters = array(); |
|
| 98 | + // todo we're currently using old functions here. We need to move things into the Events_Admin_Page() class as methods. |
|
| 99 | + $payment_methods = EEM_Payment_Method::instance()->get_all(); |
|
| 100 | + $payment_method_names = array( |
|
| 101 | + array('id' => 'all', 'text' => __("All", 'event_espresso')), |
|
| 102 | + array('id' => '0', 'text' => __("Unknown Payment Method", 'event_espresso')), |
|
| 103 | + ); |
|
| 104 | + foreach ($payment_methods as $payment_method) { |
|
| 105 | + $payment_method_names[] = array('id' => $payment_method->ID(), 'text' => $payment_method->admin_name()); |
|
| 106 | + } |
|
| 107 | + $filters[] = EEH_Form_Fields::select_input( |
|
| 108 | + '_payment_method', |
|
| 109 | + $payment_method_names, |
|
| 110 | + isset($this->_req_data['_payment_method']) |
|
| 111 | + ? $this->_req_data['_payment_method'] : 'all' |
|
| 112 | + ); |
|
| 113 | + $start_date = isset($this->_req_data['payment-filter-start-date']) ? wp_strip_all_tags( |
|
| 114 | + $this->_req_data['payment-filter-start-date'] |
|
| 115 | + ) : date('m/d/Y', strtotime('-6 months')); |
|
| 116 | + $end_date = isset($this->_req_data['payment-filter-end-date']) ? wp_strip_all_tags( |
|
| 117 | + $this->_req_data['payment-filter-end-date'] |
|
| 118 | + ) : date('m/d/Y'); |
|
| 119 | + ob_start(); |
|
| 120 | + ?> |
|
| 121 | 121 | <label for="txn-filter-start-date"><?php _e('Display Transactions from ', 'event_espresso'); ?></label> |
| 122 | 122 | <input id="payment-filter-start-date" class="datepicker" type="text" value="<?php echo $start_date; ?>" |
| 123 | 123 | name="payment-filter-start-date" size="15"/> |
@@ -125,124 +125,124 @@ discard block |
||
| 125 | 125 | <input id="payment-filter-end-date" class="datepicker" type="text" value="<?php echo $end_date; ?>" |
| 126 | 126 | name="payment-filter-end-date" size="15"/> |
| 127 | 127 | <?php |
| 128 | - $filters[] = ob_get_clean(); |
|
| 129 | - return $filters; |
|
| 130 | - } |
|
| 131 | - |
|
| 132 | - |
|
| 133 | - /** |
|
| 134 | - * _add_view_counts |
|
| 135 | - * |
|
| 136 | - * @return void |
|
| 137 | - */ |
|
| 138 | - protected function _add_view_counts() |
|
| 139 | - { |
|
| 140 | - $this->_views['all']['count'] = $this->_admin_page->get_payment_logs( |
|
| 141 | - $this->_per_page, |
|
| 142 | - $this->_current_page, |
|
| 143 | - true |
|
| 144 | - ); |
|
| 145 | - } |
|
| 146 | - |
|
| 147 | - |
|
| 148 | - /** |
|
| 149 | - * column_cb |
|
| 150 | - * |
|
| 151 | - * @param \EE_Change_Log $item |
|
| 152 | - * @return string |
|
| 153 | - */ |
|
| 154 | - public function column_cb($item) |
|
| 155 | - { |
|
| 156 | - return sprintf('<input type="checkbox" class="option_id" name="checkbox[%1$d]" value="%1$d" />', $item->ID()); |
|
| 157 | - } |
|
| 158 | - |
|
| 159 | - |
|
| 160 | - /** |
|
| 161 | - * column_id |
|
| 162 | - * |
|
| 163 | - * @param \EE_Change_Log $item |
|
| 164 | - * @return string |
|
| 165 | - */ |
|
| 166 | - public function column_id(EE_Change_Log $item) |
|
| 167 | - { |
|
| 168 | - $details_query_args = array( |
|
| 169 | - 'action' => 'payment_log_details', |
|
| 170 | - 'ID' => $item->ID(), |
|
| 171 | - ); |
|
| 172 | - $url = EE_Admin_Page::add_query_args_and_nonce($details_query_args, EE_PAYMENTS_ADMIN_URL); |
|
| 173 | - return "<a href='$url'>{$item->ID()}</a>"; |
|
| 174 | - } |
|
| 175 | - |
|
| 176 | - |
|
| 177 | - /** |
|
| 178 | - * column_LOG_time |
|
| 179 | - * |
|
| 180 | - * @param \EE_Change_Log $item |
|
| 181 | - * @return string |
|
| 182 | - */ |
|
| 183 | - public function column_LOG_time(EE_Change_Log $item) |
|
| 184 | - { |
|
| 185 | - return $item->get_datetime('LOG_time'); |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - |
|
| 189 | - /** |
|
| 190 | - * column_PMD_ID |
|
| 191 | - * |
|
| 192 | - * @param \EE_Change_Log $item |
|
| 193 | - * @return string |
|
| 194 | - */ |
|
| 195 | - public function column_PMD_ID(EE_Change_Log $item) |
|
| 196 | - { |
|
| 197 | - if ($item->object() instanceof EE_Payment_Method) { |
|
| 198 | - return $item->object()->admin_name(); |
|
| 199 | - } elseif ($item->object() instanceof EE_Payment && $item->object()->payment_method()) { |
|
| 200 | - return $item->object()->payment_method()->admin_name(); |
|
| 201 | - } elseif ($item->object() instanceof EE_Transaction) { |
|
| 202 | - return esc_html__('Unknown', 'event_espresso'); |
|
| 203 | - } else { |
|
| 204 | - return esc_html__("No longer exists", 'event_espresso'); |
|
| 205 | - } |
|
| 206 | - } |
|
| 207 | - |
|
| 208 | - |
|
| 209 | - /** |
|
| 210 | - * column_TXN_ID |
|
| 211 | - * |
|
| 212 | - * @param \EE_Change_Log $item |
|
| 213 | - * @return string |
|
| 214 | - */ |
|
| 215 | - public function column_TXN_ID(EE_Change_Log $item) |
|
| 216 | - { |
|
| 217 | - if ($item->object() instanceof EE_Payment) { |
|
| 218 | - $transaction_id = $item->object()->TXN_ID(); |
|
| 219 | - } elseif ($item->object() instanceof EE_Transaction) { |
|
| 220 | - $transaction_id = $item->object()->ID(); |
|
| 221 | - } else { |
|
| 222 | - $transaction_id = null; |
|
| 223 | - } |
|
| 224 | - if ($transaction_id |
|
| 225 | - && EE_Registry::instance()->CAP->current_user_can( |
|
| 226 | - 'ee_read_transaction', |
|
| 227 | - 'espresso_transactions_view_transaction', |
|
| 228 | - $transaction_id |
|
| 229 | - )) { |
|
| 230 | - $view_txn_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
| 231 | - array('action' => 'view_transaction', 'TXN_ID' => $transaction_id), |
|
| 232 | - TXN_ADMIN_URL |
|
| 233 | - ); |
|
| 234 | - return '<a href="' |
|
| 235 | - . $view_txn_lnk_url |
|
| 236 | - . '" title="' |
|
| 237 | - . sprintf( |
|
| 238 | - esc_attr__('click to view transaction #%s', 'event_espresso'), |
|
| 239 | - $transaction_id |
|
| 240 | - ) |
|
| 241 | - . '">' |
|
| 242 | - . sprintf(esc_html__('view txn %s', 'event_espresso'), $transaction_id) |
|
| 243 | - . '</a>'; |
|
| 244 | - } |
|
| 245 | - // No transaction id or use can not view the transaction. |
|
| 246 | - return __("Unable to find transaction", 'event_espresso'); |
|
| 247 | - } |
|
| 128 | + $filters[] = ob_get_clean(); |
|
| 129 | + return $filters; |
|
| 130 | + } |
|
| 131 | + |
|
| 132 | + |
|
| 133 | + /** |
|
| 134 | + * _add_view_counts |
|
| 135 | + * |
|
| 136 | + * @return void |
|
| 137 | + */ |
|
| 138 | + protected function _add_view_counts() |
|
| 139 | + { |
|
| 140 | + $this->_views['all']['count'] = $this->_admin_page->get_payment_logs( |
|
| 141 | + $this->_per_page, |
|
| 142 | + $this->_current_page, |
|
| 143 | + true |
|
| 144 | + ); |
|
| 145 | + } |
|
| 146 | + |
|
| 147 | + |
|
| 148 | + /** |
|
| 149 | + * column_cb |
|
| 150 | + * |
|
| 151 | + * @param \EE_Change_Log $item |
|
| 152 | + * @return string |
|
| 153 | + */ |
|
| 154 | + public function column_cb($item) |
|
| 155 | + { |
|
| 156 | + return sprintf('<input type="checkbox" class="option_id" name="checkbox[%1$d]" value="%1$d" />', $item->ID()); |
|
| 157 | + } |
|
| 158 | + |
|
| 159 | + |
|
| 160 | + /** |
|
| 161 | + * column_id |
|
| 162 | + * |
|
| 163 | + * @param \EE_Change_Log $item |
|
| 164 | + * @return string |
|
| 165 | + */ |
|
| 166 | + public function column_id(EE_Change_Log $item) |
|
| 167 | + { |
|
| 168 | + $details_query_args = array( |
|
| 169 | + 'action' => 'payment_log_details', |
|
| 170 | + 'ID' => $item->ID(), |
|
| 171 | + ); |
|
| 172 | + $url = EE_Admin_Page::add_query_args_and_nonce($details_query_args, EE_PAYMENTS_ADMIN_URL); |
|
| 173 | + return "<a href='$url'>{$item->ID()}</a>"; |
|
| 174 | + } |
|
| 175 | + |
|
| 176 | + |
|
| 177 | + /** |
|
| 178 | + * column_LOG_time |
|
| 179 | + * |
|
| 180 | + * @param \EE_Change_Log $item |
|
| 181 | + * @return string |
|
| 182 | + */ |
|
| 183 | + public function column_LOG_time(EE_Change_Log $item) |
|
| 184 | + { |
|
| 185 | + return $item->get_datetime('LOG_time'); |
|
| 186 | + } |
|
| 187 | + |
|
| 188 | + |
|
| 189 | + /** |
|
| 190 | + * column_PMD_ID |
|
| 191 | + * |
|
| 192 | + * @param \EE_Change_Log $item |
|
| 193 | + * @return string |
|
| 194 | + */ |
|
| 195 | + public function column_PMD_ID(EE_Change_Log $item) |
|
| 196 | + { |
|
| 197 | + if ($item->object() instanceof EE_Payment_Method) { |
|
| 198 | + return $item->object()->admin_name(); |
|
| 199 | + } elseif ($item->object() instanceof EE_Payment && $item->object()->payment_method()) { |
|
| 200 | + return $item->object()->payment_method()->admin_name(); |
|
| 201 | + } elseif ($item->object() instanceof EE_Transaction) { |
|
| 202 | + return esc_html__('Unknown', 'event_espresso'); |
|
| 203 | + } else { |
|
| 204 | + return esc_html__("No longer exists", 'event_espresso'); |
|
| 205 | + } |
|
| 206 | + } |
|
| 207 | + |
|
| 208 | + |
|
| 209 | + /** |
|
| 210 | + * column_TXN_ID |
|
| 211 | + * |
|
| 212 | + * @param \EE_Change_Log $item |
|
| 213 | + * @return string |
|
| 214 | + */ |
|
| 215 | + public function column_TXN_ID(EE_Change_Log $item) |
|
| 216 | + { |
|
| 217 | + if ($item->object() instanceof EE_Payment) { |
|
| 218 | + $transaction_id = $item->object()->TXN_ID(); |
|
| 219 | + } elseif ($item->object() instanceof EE_Transaction) { |
|
| 220 | + $transaction_id = $item->object()->ID(); |
|
| 221 | + } else { |
|
| 222 | + $transaction_id = null; |
|
| 223 | + } |
|
| 224 | + if ($transaction_id |
|
| 225 | + && EE_Registry::instance()->CAP->current_user_can( |
|
| 226 | + 'ee_read_transaction', |
|
| 227 | + 'espresso_transactions_view_transaction', |
|
| 228 | + $transaction_id |
|
| 229 | + )) { |
|
| 230 | + $view_txn_lnk_url = EE_Admin_Page::add_query_args_and_nonce( |
|
| 231 | + array('action' => 'view_transaction', 'TXN_ID' => $transaction_id), |
|
| 232 | + TXN_ADMIN_URL |
|
| 233 | + ); |
|
| 234 | + return '<a href="' |
|
| 235 | + . $view_txn_lnk_url |
|
| 236 | + . '" title="' |
|
| 237 | + . sprintf( |
|
| 238 | + esc_attr__('click to view transaction #%s', 'event_espresso'), |
|
| 239 | + $transaction_id |
|
| 240 | + ) |
|
| 241 | + . '">' |
|
| 242 | + . sprintf(esc_html__('view txn %s', 'event_espresso'), $transaction_id) |
|
| 243 | + . '</a>'; |
|
| 244 | + } |
|
| 245 | + // No transaction id or use can not view the transaction. |
|
| 246 | + return __("Unable to find transaction", 'event_espresso'); |
|
| 247 | + } |
|
| 248 | 248 | } |
@@ -3,7 +3,6 @@ |
||
| 3 | 3 | use EventEspresso\core\exceptions\InvalidDataTypeException; |
| 4 | 4 | use EventEspresso\core\exceptions\InvalidInterfaceException; |
| 5 | 5 | use EventEspresso\core\interfaces\ResettableInterface; |
| 6 | - |
|
| 7 | 6 | use EventEspresso\core\services\database\TableManager; |
| 8 | 7 | use EventEspresso\core\services\database\TableAnalysis; |
| 9 | 8 | |
@@ -32,1238 +32,1238 @@ |
||
| 32 | 32 | class EE_Data_Migration_Manager implements ResettableInterface |
| 33 | 33 | { |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * |
|
| 37 | - * @var EE_Registry |
|
| 38 | - */ |
|
| 39 | - // protected $EE; |
|
| 40 | - /** |
|
| 41 | - * name of the wordpress option which stores an array of data about |
|
| 42 | - */ |
|
| 43 | - const data_migrations_option_name = 'ee_data_migration'; |
|
| 44 | - |
|
| 45 | - |
|
| 46 | - const data_migration_script_option_prefix = 'ee_data_migration_script_'; |
|
| 47 | - |
|
| 48 | - const data_migration_script_mapping_option_prefix = 'ee_dms_map_'; |
|
| 49 | - |
|
| 50 | - /** |
|
| 51 | - * name of the wordpress option which stores the database' current version. IE, the code may be at version 4.2.0, |
|
| 52 | - * but as migrations are performed the database will progress from 3.1.35 to 4.1.0 etc. |
|
| 53 | - */ |
|
| 54 | - const current_database_state = 'ee_data_migration_current_db_state'; |
|
| 55 | - |
|
| 56 | - /** |
|
| 57 | - * Special status string returned when we're positive there are no more data migration |
|
| 58 | - * scripts that can be run. |
|
| 59 | - */ |
|
| 60 | - const status_no_more_migration_scripts = 'no_more_migration_scripts'; |
|
| 61 | - /** |
|
| 62 | - * string indicating the migration should continue |
|
| 63 | - */ |
|
| 64 | - const status_continue = 'status_continue'; |
|
| 65 | - /** |
|
| 66 | - * string indicating the migration has completed and should be ended |
|
| 67 | - */ |
|
| 68 | - const status_completed = 'status_completed'; |
|
| 69 | - /** |
|
| 70 | - * string indicating a fatal error occurred and the data migration should be completely aborted |
|
| 71 | - */ |
|
| 72 | - const status_fatal_error = 'status_fatal_error'; |
|
| 73 | - |
|
| 74 | - /** |
|
| 75 | - * the number of 'items' (usually DB rows) to migrate on each 'step' (ajax request sent |
|
| 76 | - * during migration) |
|
| 77 | - */ |
|
| 78 | - const step_size = 50; |
|
| 79 | - |
|
| 80 | - /** |
|
| 81 | - * option name that stores the queue of ee plugins needing to have |
|
| 82 | - * their data initialized (or re-initialized) once we are done migrations |
|
| 83 | - */ |
|
| 84 | - const db_init_queue_option_name = 'ee_db_init_queue'; |
|
| 85 | - /** |
|
| 86 | - * Array of information concerning data migrations that have ran in the history |
|
| 87 | - * of this EE installation. Keys should be the name of the version the script upgraded to |
|
| 88 | - * |
|
| 89 | - * @var EE_Data_Migration_Script_Base[] |
|
| 90 | - */ |
|
| 91 | - private $_data_migrations_ran = null; |
|
| 92 | - /** |
|
| 93 | - * The last ran script. It's nice to store this somewhere accessible, as its easiest |
|
| 94 | - * to know which was the last run by which is the newest wp option; but in most of the code |
|
| 95 | - * we just use the local $_data_migration_ran array, which organized the scripts differently |
|
| 96 | - * |
|
| 97 | - * @var EE_Data_Migration_Script_Base |
|
| 98 | - */ |
|
| 99 | - private $_last_ran_script = null; |
|
| 100 | - |
|
| 101 | - /** |
|
| 102 | - * Similarly to _last_ran_script, but this is the last INCOMPLETE migration script. |
|
| 103 | - * |
|
| 104 | - * @var EE_Data_Migration_Script_Base |
|
| 105 | - */ |
|
| 106 | - private $_last_ran_incomplete_script = null; |
|
| 107 | - /** |
|
| 108 | - * array where keys are classnames, and values are filepaths of all the known migration scripts |
|
| 109 | - * |
|
| 110 | - * @var array |
|
| 111 | - */ |
|
| 112 | - private $_data_migration_class_to_filepath_map; |
|
| 113 | - |
|
| 114 | - /** |
|
| 115 | - * the following 4 properties are fully set on construction. |
|
| 116 | - * Note: the first two apply to whether to continue running ALL migration scripts (ie, even though we're finished |
|
| 117 | - * one, we may want to start the next one); whereas the last two indicate whether to continue running a single |
|
| 118 | - * data migration script |
|
| 119 | - * |
|
| 120 | - * @var array |
|
| 121 | - */ |
|
| 122 | - public $stati_that_indicate_to_continue_migrations = array(); |
|
| 123 | - |
|
| 124 | - public $stati_that_indicate_to_stop_migrations = array(); |
|
| 125 | - |
|
| 126 | - public $stati_that_indicate_to_continue_single_migration_script = array(); |
|
| 127 | - |
|
| 128 | - public $stati_that_indicate_to_stop_single_migration_script = array(); |
|
| 129 | - |
|
| 130 | - /** |
|
| 131 | - * @var \EventEspresso\core\services\database\TableManager $table_manager |
|
| 132 | - */ |
|
| 133 | - protected $_table_manager; |
|
| 134 | - |
|
| 135 | - /** |
|
| 136 | - * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis |
|
| 137 | - */ |
|
| 138 | - protected $_table_analysis; |
|
| 139 | - |
|
| 140 | - /** |
|
| 141 | - * @var array $script_migration_versions |
|
| 142 | - */ |
|
| 143 | - protected $script_migration_versions; |
|
| 144 | - |
|
| 145 | - /** |
|
| 146 | - * @var EE_Data_Migration_Manager $_instance |
|
| 147 | - * @access private |
|
| 148 | - */ |
|
| 149 | - private static $_instance = null; |
|
| 150 | - |
|
| 151 | - |
|
| 152 | - /** |
|
| 153 | - * @singleton method used to instantiate class object |
|
| 154 | - * @access public |
|
| 155 | - * @return EE_Data_Migration_Manager instance |
|
| 156 | - */ |
|
| 157 | - public static function instance() |
|
| 158 | - { |
|
| 159 | - // check if class object is instantiated |
|
| 160 | - if (! self::$_instance instanceof EE_Data_Migration_Manager) { |
|
| 161 | - self::$_instance = new self(); |
|
| 162 | - } |
|
| 163 | - return self::$_instance; |
|
| 164 | - } |
|
| 165 | - |
|
| 166 | - /** |
|
| 167 | - * resets the singleton to its brand-new state (but does NOT delete old references to the old singleton. Meaning, |
|
| 168 | - * all new usages of the singleton should be made with Classname::instance()) and returns it |
|
| 169 | - * |
|
| 170 | - * @return EE_Data_Migration_Manager |
|
| 171 | - */ |
|
| 172 | - public static function reset() |
|
| 173 | - { |
|
| 174 | - self::$_instance = null; |
|
| 175 | - return self::instance(); |
|
| 176 | - } |
|
| 177 | - |
|
| 178 | - |
|
| 179 | - /** |
|
| 180 | - * constructor |
|
| 181 | - */ |
|
| 182 | - private function __construct() |
|
| 183 | - { |
|
| 184 | - $this->stati_that_indicate_to_continue_migrations = array( |
|
| 185 | - self::status_continue, |
|
| 186 | - self::status_completed, |
|
| 187 | - ); |
|
| 188 | - $this->stati_that_indicate_to_stop_migrations = array( |
|
| 189 | - self::status_fatal_error, |
|
| 190 | - self::status_no_more_migration_scripts, |
|
| 191 | - ); |
|
| 192 | - $this->stati_that_indicate_to_continue_single_migration_script = array( |
|
| 193 | - self::status_continue, |
|
| 194 | - ); |
|
| 195 | - $this->stati_that_indicate_to_stop_single_migration_script = array( |
|
| 196 | - self::status_completed, |
|
| 197 | - self::status_fatal_error |
|
| 198 | - // note: status_no_more_migration_scripts doesn't apply |
|
| 199 | - ); |
|
| 200 | - // make sure we've included the base migration script, because we may need the EE_DMS_Unknown_1_0_0 class |
|
| 201 | - // to be defined, because right now it doesn't get autoloaded on its own |
|
| 202 | - EE_Registry::instance()->load_core('Data_Migration_Class_Base', array(), true); |
|
| 203 | - EE_Registry::instance()->load_core('Data_Migration_Script_Base', array(), true); |
|
| 204 | - EE_Registry::instance()->load_core('DMS_Unknown_1_0_0', array(), true); |
|
| 205 | - EE_Registry::instance()->load_core('Data_Migration_Script_Stage', array(), true); |
|
| 206 | - EE_Registry::instance()->load_core('Data_Migration_Script_Stage_Table', array(), true); |
|
| 207 | - $this->_table_manager = EE_Registry::instance()->create('TableManager', array(), true); |
|
| 208 | - $this->_table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true); |
|
| 209 | - } |
|
| 210 | - |
|
| 211 | - |
|
| 212 | - /** |
|
| 213 | - * Deciphers, from an option's name, what plugin and version it relates to (see _save_migrations_ran to see what |
|
| 214 | - * the option names are like, but generally they're like |
|
| 215 | - * 'ee_data_migration_script_Core.4.1.0' in 4.2 or 'ee_data_migration_script_4.1.0' before that). |
|
| 216 | - * The option name shouldn't ever be like 'ee_data_migration_script_Core.4.1.0.reg' because it's derived, |
|
| 217 | - * indirectly, from the data migration's classname, which should always be like EE_DMS_%s_%d_%d_%d.dms.php (eg |
|
| 218 | - * EE_DMS_Core_4_1_0.dms.php) |
|
| 219 | - * |
|
| 220 | - * @param string $option_name (see EE_Data_Migration_Manage::_save_migrations_ran() where the option name is set) |
|
| 221 | - * @return array where the first item is the plugin slug (eg 'Core','Calendar',etc) and the 2nd is the version of |
|
| 222 | - * that plugin (eg '4.1.0') |
|
| 223 | - */ |
|
| 224 | - private function _get_plugin_slug_and_version_string_from_dms_option_name($option_name) |
|
| 225 | - { |
|
| 226 | - $plugin_slug_and_version_string = str_replace( |
|
| 227 | - EE_Data_Migration_Manager::data_migration_script_option_prefix, |
|
| 228 | - "", |
|
| 229 | - $option_name |
|
| 230 | - ); |
|
| 231 | - // check if $plugin_slug_and_version_string is like '4.1.0' (4.1-style) or 'Core.4.1.0' (4.2-style) |
|
| 232 | - $parts = explode(".", $plugin_slug_and_version_string); |
|
| 233 | - |
|
| 234 | - if (count($parts) == 4) { |
|
| 235 | - // it's 4.2-style.eg Core.4.1.0 |
|
| 236 | - $plugin_slug = $parts[0];// eg Core |
|
| 237 | - $version_string = $parts[1] . "." . $parts[2] . "." . $parts[3]; // eg 4.1.0 |
|
| 238 | - } else { |
|
| 239 | - // it's 4.1-style: eg 4.1.0 |
|
| 240 | - $plugin_slug = 'Core'; |
|
| 241 | - $version_string = $plugin_slug_and_version_string;// eg 4.1.0 |
|
| 242 | - } |
|
| 243 | - return array($plugin_slug, $version_string); |
|
| 244 | - } |
|
| 245 | - |
|
| 246 | - /** |
|
| 247 | - * Gets the DMS class from the wordpress option, otherwise throws an EE_Error if it's not |
|
| 248 | - * for a known DMS class. |
|
| 249 | - * |
|
| 250 | - * @param string $dms_option_name |
|
| 251 | - * @param string $dms_option_value (serialized) |
|
| 252 | - * @return EE_Data_Migration_Script_Base |
|
| 253 | - * @throws EE_Error |
|
| 254 | - */ |
|
| 255 | - private function _get_dms_class_from_wp_option($dms_option_name, $dms_option_value) |
|
| 256 | - { |
|
| 257 | - $data_migration_data = maybe_unserialize($dms_option_value); |
|
| 258 | - if (isset($data_migration_data['class']) && class_exists($data_migration_data['class'])) { |
|
| 259 | - $class = new $data_migration_data['class']; |
|
| 260 | - if ($class instanceof EE_Data_Migration_Script_Base) { |
|
| 261 | - $class->instantiate_from_array_of_properties($data_migration_data); |
|
| 262 | - return $class; |
|
| 263 | - } else { |
|
| 264 | - // huh, so its an object but not a data migration script?? that shouldn't happen |
|
| 265 | - // just leave it as an array (which will probably just get ignored) |
|
| 266 | - throw new EE_Error( |
|
| 267 | - sprintf( |
|
| 268 | - __( |
|
| 269 | - "Trying to retrieve DMS class from wp option. No DMS by the name '%s' exists", |
|
| 270 | - 'event_espresso' |
|
| 271 | - ), |
|
| 272 | - $data_migration_data['class'] |
|
| 273 | - ) |
|
| 274 | - ); |
|
| 275 | - } |
|
| 276 | - } else { |
|
| 277 | - // so the data doesn't specify a class. So it must either be a legacy array of info or some array (which we'll probably just ignore), or a class that no longer exists |
|
| 278 | - throw new EE_Error( |
|
| 279 | - sprintf(__("The wp option with key '%s' does not represent a DMS", 'event_espresso'), $dms_option_name) |
|
| 280 | - ); |
|
| 281 | - } |
|
| 282 | - } |
|
| 283 | - |
|
| 284 | - /** |
|
| 285 | - * Gets the array describing what data migrations have run. Also has a side-effect of recording which was the last |
|
| 286 | - * ran, and which was the last ran which hasn't finished yet |
|
| 287 | - * |
|
| 288 | - * @return array where each element should be an array of EE_Data_Migration_Script_Base (but also has a few legacy |
|
| 289 | - * arrays in there - which should probably be ignored) |
|
| 290 | - */ |
|
| 291 | - public function get_data_migrations_ran() |
|
| 292 | - { |
|
| 293 | - if (! $this->_data_migrations_ran) { |
|
| 294 | - // setup autoloaders for each of the scripts in there |
|
| 295 | - $this->get_all_data_migration_scripts_available(); |
|
| 296 | - $data_migrations_options = $this->get_all_migration_script_options( |
|
| 297 | - );// get_option(EE_Data_Migration_Manager::data_migrations_option_name,get_option('espresso_data_migrations',array())); |
|
| 298 | - |
|
| 299 | - $data_migrations_ran = array(); |
|
| 300 | - // convert into data migration script classes where possible |
|
| 301 | - foreach ($data_migrations_options as $data_migration_option) { |
|
| 302 | - list($plugin_slug, $version_string) = $this->_get_plugin_slug_and_version_string_from_dms_option_name( |
|
| 303 | - $data_migration_option['option_name'] |
|
| 304 | - ); |
|
| 305 | - |
|
| 306 | - try { |
|
| 307 | - $class = $this->_get_dms_class_from_wp_option( |
|
| 308 | - $data_migration_option['option_name'], |
|
| 309 | - $data_migration_option['option_value'] |
|
| 310 | - ); |
|
| 311 | - $data_migrations_ran[ $plugin_slug ][ $version_string ] = $class; |
|
| 312 | - // ok so far THIS is the 'last-ran-script'... unless we find another on next iteration |
|
| 313 | - $this->_last_ran_script = $class; |
|
| 314 | - if (! $class->is_completed()) { |
|
| 315 | - // sometimes we also like to know which was the last incomplete script (or if there are any at all) |
|
| 316 | - $this->_last_ran_incomplete_script = $class; |
|
| 317 | - } |
|
| 318 | - } catch (EE_Error $e) { |
|
| 319 | - // ok so its not a DMS. We'll just keep it, although other code will need to expect non-DMSs |
|
| 320 | - $data_migrations_ran[ $plugin_slug ][ $version_string ] = maybe_unserialize( |
|
| 321 | - $data_migration_option['option_value'] |
|
| 322 | - ); |
|
| 323 | - } |
|
| 324 | - } |
|
| 325 | - // so here the array of $data_migrations_ran is actually a mix of classes and a few legacy arrays |
|
| 326 | - $this->_data_migrations_ran = $data_migrations_ran; |
|
| 327 | - if (! $this->_data_migrations_ran || ! is_array($this->_data_migrations_ran)) { |
|
| 328 | - $this->_data_migrations_ran = array(); |
|
| 329 | - } |
|
| 330 | - } |
|
| 331 | - return $this->_data_migrations_ran; |
|
| 332 | - } |
|
| 333 | - |
|
| 334 | - |
|
| 335 | - /** |
|
| 336 | - * |
|
| 337 | - * @param string $script_name eg 'DMS_Core_4_1_0' |
|
| 338 | - * @param string $old_table eg 'wp_events_detail' |
|
| 339 | - * @param string $old_pk eg 'wp_esp_posts' |
|
| 340 | - * @param $new_table |
|
| 341 | - * @return mixed string or int |
|
| 342 | - */ |
|
| 343 | - public function get_mapping_new_pk($script_name, $old_table, $old_pk, $new_table) |
|
| 344 | - { |
|
| 345 | - $script = EE_Registry::instance()->load_dms($script_name); |
|
| 346 | - $mapping = $script->get_mapping_new_pk($old_table, $old_pk, $new_table); |
|
| 347 | - return $mapping; |
|
| 348 | - } |
|
| 349 | - |
|
| 350 | - /** |
|
| 351 | - * Gets all the options containing migration scripts that have been run. Ordering is important: it's assumed that |
|
| 352 | - * the last option returned in this array is the most-recently ran DMS option |
|
| 353 | - * |
|
| 354 | - * @return array |
|
| 355 | - */ |
|
| 356 | - public function get_all_migration_script_options() |
|
| 357 | - { |
|
| 358 | - global $wpdb; |
|
| 359 | - return $wpdb->get_results( |
|
| 360 | - "SELECT * FROM {$wpdb->options} WHERE option_name like '" . EE_Data_Migration_Manager::data_migration_script_option_prefix . "%' ORDER BY option_id ASC", |
|
| 361 | - ARRAY_A |
|
| 362 | - ); |
|
| 363 | - } |
|
| 364 | - |
|
| 365 | - /** |
|
| 366 | - * Gets the array of folders which contain data migration scripts. Also adds them to be auto-loaded |
|
| 367 | - * |
|
| 368 | - * @return array where each value is the full folder path of a folder containing data migration scripts, WITH |
|
| 369 | - * slashes at the end of the folder name. |
|
| 370 | - */ |
|
| 371 | - public function get_data_migration_script_folders() |
|
| 372 | - { |
|
| 373 | - return apply_filters( |
|
| 374 | - 'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders', |
|
| 375 | - array('Core' => EE_CORE . 'data_migration_scripts') |
|
| 376 | - ); |
|
| 377 | - } |
|
| 378 | - |
|
| 379 | - /** |
|
| 380 | - * Gets the version the migration script upgrades to |
|
| 381 | - * |
|
| 382 | - * @param string $migration_script_name eg 'EE_DMS_Core_4_1_0' |
|
| 383 | - * @return array { |
|
| 384 | - * @type string $slug like 'Core','Calendar',etc |
|
| 385 | - * @type string $version like 4.3.0 |
|
| 386 | - * } |
|
| 387 | - * @throws EE_Error |
|
| 388 | - */ |
|
| 389 | - public function script_migrates_to_version($migration_script_name, $eeAddonClass = '') |
|
| 390 | - { |
|
| 391 | - if (isset($this->script_migration_versions[ $migration_script_name ])) { |
|
| 392 | - return $this->script_migration_versions[ $migration_script_name ]; |
|
| 393 | - } |
|
| 394 | - $dms_info = $this->parse_dms_classname($migration_script_name); |
|
| 395 | - $this->script_migration_versions[ $migration_script_name ] = array( |
|
| 396 | - 'slug' => $eeAddonClass !== '' ? $eeAddonClass : $dms_info['slug'], |
|
| 397 | - 'version' => $dms_info['major_version'] . "." . $dms_info['minor_version'] . "." . $dms_info['micro_version'], |
|
| 398 | - ); |
|
| 399 | - return $this->script_migration_versions[ $migration_script_name ]; |
|
| 400 | - } |
|
| 401 | - |
|
| 402 | - /** |
|
| 403 | - * Gets the juicy details out of a dms filename like 'EE_DMS_Core_4_1_0' |
|
| 404 | - * |
|
| 405 | - * @param string $classname |
|
| 406 | - * @return array with keys 'slug','major_version','minor_version', and 'micro_version' (the last 3 are ints) |
|
| 407 | - * @throws EE_Error |
|
| 408 | - */ |
|
| 409 | - public function parse_dms_classname($classname) |
|
| 410 | - { |
|
| 411 | - $matches = array(); |
|
| 412 | - preg_match('~EE_DMS_(.*)_([0-9]*)_([0-9]*)_([0-9]*)~', $classname, $matches); |
|
| 413 | - if (! $matches || ! (isset($matches[1]) && isset($matches[2]) && isset($matches[3]))) { |
|
| 414 | - throw new EE_Error( |
|
| 415 | - sprintf( |
|
| 416 | - __( |
|
| 417 | - "%s is not a valid Data Migration Script. The classname should be like EE_DMS_w_x_y_z, where w is either 'Core' or the slug of an addon and x, y and z are numbers, ", |
|
| 418 | - "event_espresso" |
|
| 419 | - ), |
|
| 420 | - $classname |
|
| 421 | - ) |
|
| 422 | - ); |
|
| 423 | - } |
|
| 424 | - return array( |
|
| 425 | - 'slug' => $matches[1], |
|
| 426 | - 'major_version' => intval($matches[2]), |
|
| 427 | - 'minor_version' => intval($matches[3]), |
|
| 428 | - 'micro_version' => intval($matches[4]), |
|
| 429 | - ); |
|
| 430 | - } |
|
| 431 | - |
|
| 432 | - /** |
|
| 433 | - * Ensures that the option indicating the current DB version is set. This should only be |
|
| 434 | - * a concern when activating EE for the first time, THEORETICALLY. |
|
| 435 | - * If we detect that we're activating EE4 over top of EE3.1, then we set the current db state to 3.1.x, otherwise |
|
| 436 | - * to 4.1.x. |
|
| 437 | - * |
|
| 438 | - * @return string of current db state |
|
| 439 | - */ |
|
| 440 | - public function ensure_current_database_state_is_set() |
|
| 441 | - { |
|
| 442 | - $espresso_db_core_updates = get_option('espresso_db_update', array()); |
|
| 443 | - $db_state = get_option(EE_Data_Migration_Manager::current_database_state); |
|
| 444 | - if (! $db_state) { |
|
| 445 | - // mark the DB as being in the state as the last version in there. |
|
| 446 | - // this is done to trigger maintenance mode and do data migration scripts |
|
| 447 | - // if the admin installed this version of EE over 3.1.x or 4.0.x |
|
| 448 | - // otherwise, the normal maintenance mode code is fine |
|
| 449 | - $previous_versions_installed = array_keys($espresso_db_core_updates); |
|
| 450 | - $previous_version_installed = end($previous_versions_installed); |
|
| 451 | - if (version_compare('4.1.0', $previous_version_installed)) { |
|
| 452 | - // last installed version was less than 4.1 |
|
| 453 | - // so we want the data migrations to happen. SO, we're going to say the DB is at that state |
|
| 454 | - $db_state = array('Core' => $previous_version_installed); |
|
| 455 | - } else { |
|
| 456 | - $db_state = array('Core' => EVENT_ESPRESSO_VERSION); |
|
| 457 | - } |
|
| 458 | - update_option(EE_Data_Migration_Manager::current_database_state, $db_state); |
|
| 459 | - } |
|
| 460 | - // in 4.1, $db_state would have only been a simple string like '4.1.0', |
|
| 461 | - // but in 4.2+ it should be an array with at least key 'Core' and the value of that plugin's |
|
| 462 | - // db, and possibly other keys for other addons like 'Calendar','Permissions',etc |
|
| 463 | - if (! is_array($db_state)) { |
|
| 464 | - $db_state = array('Core' => $db_state); |
|
| 465 | - update_option(EE_Data_Migration_Manager::current_database_state, $db_state); |
|
| 466 | - } |
|
| 467 | - return $db_state; |
|
| 468 | - } |
|
| 469 | - |
|
| 470 | - /** |
|
| 471 | - * Checks if there are any data migration scripts that ought to be run. If found, |
|
| 472 | - * returns the instantiated classes. If none are found (ie, they've all already been run |
|
| 473 | - * or they don't apply), returns an empty array |
|
| 474 | - * |
|
| 475 | - * @return EE_Data_Migration_Script_Base[] |
|
| 476 | - */ |
|
| 477 | - public function check_for_applicable_data_migration_scripts() |
|
| 478 | - { |
|
| 479 | - // get the option describing what options have already run |
|
| 480 | - $scripts_ran = $this->get_data_migrations_ran(); |
|
| 481 | - // $scripts_ran = array('4.1.0.core'=>array('monkey'=>null)); |
|
| 482 | - $script_class_and_filepaths_available = $this->get_all_data_migration_scripts_available(); |
|
| 483 | - |
|
| 484 | - |
|
| 485 | - $current_database_state = $this->ensure_current_database_state_is_set(); |
|
| 486 | - // determine which have already been run |
|
| 487 | - $script_classes_that_should_run_per_iteration = array(); |
|
| 488 | - $iteration = 0; |
|
| 489 | - $next_database_state_to_consider = $current_database_state; |
|
| 490 | - $theoretical_database_state = null; |
|
| 491 | - do { |
|
| 492 | - // the next state after the currently-considered one will start off looking the same as the current, but we may make additions... |
|
| 493 | - $theoretical_database_state = $next_database_state_to_consider; |
|
| 494 | - // the next db state to consider is "what would the DB be like had we run all the scripts we found that applied last time?) |
|
| 495 | - foreach ($script_class_and_filepaths_available as $classname => $filepath) { |
|
| 496 | - $migrates_to_version = $this->script_migrates_to_version($classname); |
|
| 497 | - $script_converts_plugin_slug = $migrates_to_version['slug']; |
|
| 498 | - $script_converts_to_version = $migrates_to_version['version']; |
|
| 499 | - // check if this version script is DONE or not; or if it's never been ran |
|
| 500 | - if (! $scripts_ran || |
|
| 501 | - ! isset($scripts_ran[ $script_converts_plugin_slug ]) || |
|
| 502 | - ! isset($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ])) { |
|
| 503 | - // we haven't ran this conversion script before |
|
| 504 | - // now check if it applies... note that we've added an autoloader for it on get_all_data_migration_scripts_available |
|
| 505 | - $script = new $classname($this->_get_table_manager(), $this->_get_table_analysis()); |
|
| 506 | - /* @var $script EE_Data_Migration_Script_Base */ |
|
| 507 | - $can_migrate = $script->can_migrate_from_version($theoretical_database_state); |
|
| 508 | - if ($can_migrate) { |
|
| 509 | - $script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script; |
|
| 510 | - $migrates_to_version = $script->migrates_to_version(); |
|
| 511 | - $next_database_state_to_consider[ $migrates_to_version['slug'] ] = $migrates_to_version['version']; |
|
| 512 | - unset($script_class_and_filepaths_available[ $classname ]); |
|
| 513 | - } |
|
| 514 | - } elseif ($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ] instanceof EE_Data_Migration_Script_Base) { |
|
| 515 | - // this script has been ran, or at least started |
|
| 516 | - $script = $scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ]; |
|
| 517 | - if ($script->get_status() != self::status_completed) { |
|
| 518 | - // this script is already underway... keep going with it |
|
| 519 | - $script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script; |
|
| 520 | - $migrates_to_version = $script->migrates_to_version(); |
|
| 521 | - $next_database_state_to_consider[ $migrates_to_version['slug'] ] = $migrates_to_version['version']; |
|
| 522 | - unset($script_class_and_filepaths_available[ $classname ]); |
|
| 523 | - } else { |
|
| 524 | - // it must have a status that indicates it has finished, so we don't want to try and run it again |
|
| 525 | - } |
|
| 526 | - } else { |
|
| 527 | - // it exists but it's not a proper data migration script |
|
| 528 | - // maybe the script got renamed? or was simply removed from EE? |
|
| 529 | - // either way, its certainly not runnable! |
|
| 530 | - } |
|
| 531 | - } |
|
| 532 | - $iteration++; |
|
| 533 | - } while ($next_database_state_to_consider != $theoretical_database_state && $iteration < 6); |
|
| 534 | - // ok we have all the scripts that should run, now let's make them into flat array |
|
| 535 | - $scripts_that_should_run = array(); |
|
| 536 | - foreach ($script_classes_that_should_run_per_iteration as $scripts_at_priority) { |
|
| 537 | - ksort($scripts_at_priority); |
|
| 538 | - foreach ($scripts_at_priority as $scripts) { |
|
| 539 | - foreach ($scripts as $script) { |
|
| 540 | - $scripts_that_should_run[ get_class($script) ] = $script; |
|
| 541 | - } |
|
| 542 | - } |
|
| 543 | - } |
|
| 544 | - |
|
| 545 | - do_action( |
|
| 546 | - 'AHEE__EE_Data_Migration_Manager__check_for_applicable_data_migration_scripts__scripts_that_should_run', |
|
| 547 | - $scripts_that_should_run |
|
| 548 | - ); |
|
| 549 | - return $scripts_that_should_run; |
|
| 550 | - } |
|
| 551 | - |
|
| 552 | - |
|
| 553 | - /** |
|
| 554 | - * Gets the script which is currently being ran, if there is one. If $include_completed_scripts is set to TRUE |
|
| 555 | - * it will return the last ran script even if its complete. |
|
| 556 | - * This means: if you want to find the currently-executing script, leave it as FALSE. |
|
| 557 | - * If you really just want to find the script which ran most recently, regardless of status, leave it as TRUE. |
|
| 558 | - * |
|
| 559 | - * @param bool $include_completed_scripts |
|
| 560 | - * @return EE_Data_Migration_Script_Base |
|
| 561 | - */ |
|
| 562 | - public function get_last_ran_script($include_completed_scripts = false) |
|
| 563 | - { |
|
| 564 | - // make sure we've setup the class properties _last_ran_script and _last_ran_incomplete_script |
|
| 565 | - if (! $this->_data_migrations_ran) { |
|
| 566 | - $this->get_data_migrations_ran(); |
|
| 567 | - } |
|
| 568 | - if ($include_completed_scripts) { |
|
| 569 | - return $this->_last_ran_script; |
|
| 570 | - } else { |
|
| 571 | - return $this->_last_ran_incomplete_script; |
|
| 572 | - } |
|
| 573 | - } |
|
| 574 | - |
|
| 575 | - |
|
| 576 | - /** |
|
| 577 | - * Runs the data migration scripts (well, each request to this method calls one of the |
|
| 578 | - * data migration scripts' migration_step() functions). |
|
| 579 | - * |
|
| 580 | - * @param int $step_size |
|
| 581 | - * @throws EE_Error |
|
| 582 | - * @return array { |
|
| 583 | - * // where the first item is one EE_Data_Migration_Script_Base's stati, |
|
| 584 | - * //and the second item is a string describing what was done |
|
| 585 | - * @type int $records_to_migrate from the current migration script |
|
| 586 | - * @type int $records_migrated |
|
| 587 | - * @type string $status one of EE_Data_Migration_Manager::status_* |
|
| 588 | - * @type string $script verbose name of the current DMS |
|
| 589 | - * @type string $message string describing what was done during this step |
|
| 590 | - * } |
|
| 591 | - */ |
|
| 592 | - public function migration_step($step_size = 0) |
|
| 593 | - { |
|
| 594 | - |
|
| 595 | - // bandaid fix for issue https://events.codebasehq.com/projects/event-espresso/tickets/7535 |
|
| 596 | - if (class_exists('EE_CPT_Strategy')) { |
|
| 597 | - remove_action('pre_get_posts', array(EE_CPT_Strategy::instance(), 'pre_get_posts'), 5); |
|
| 598 | - } |
|
| 599 | - |
|
| 600 | - try { |
|
| 601 | - $currently_executing_script = $this->get_last_ran_script(); |
|
| 602 | - if (! $currently_executing_script) { |
|
| 603 | - // Find the next script that needs to execute |
|
| 604 | - $scripts = $this->check_for_applicable_data_migration_scripts(); |
|
| 605 | - if (! $scripts) { |
|
| 606 | - // huh, no more scripts to run... apparently we're done! |
|
| 607 | - // but dont forget to make sure initial data is there |
|
| 608 | - // we should be good to allow them to exit maintenance mode now |
|
| 609 | - EE_Maintenance_Mode::instance()->set_maintenance_level( |
|
| 610 | - intval(EE_Maintenance_Mode::level_0_not_in_maintenance) |
|
| 611 | - ); |
|
| 612 | - // saving migrations ran should actually be unnecessary, but leaving in place just in case |
|
| 613 | - // remember this migration was finished (even if we timeout initing db for core and plugins) |
|
| 614 | - $this->_save_migrations_ran(); |
|
| 615 | - // make sure DB was updated AFTER we've recorded the migration was done |
|
| 616 | - $this->initialize_db_for_enqueued_ee_plugins(); |
|
| 617 | - return array( |
|
| 618 | - 'records_to_migrate' => 1, |
|
| 619 | - 'records_migrated' => 1, |
|
| 620 | - 'status' => self::status_no_more_migration_scripts, |
|
| 621 | - 'script' => __("Data Migration Completed Successfully", "event_espresso"), |
|
| 622 | - 'message' => __("All done!", "event_espresso"), |
|
| 623 | - ); |
|
| 624 | - } |
|
| 625 | - $currently_executing_script = array_shift($scripts); |
|
| 626 | - // and add to the array/wp option showing the scripts ran |
|
| 627 | - |
|
| 628 | - $migrates_to = $this->script_migrates_to_version(get_class($currently_executing_script)); |
|
| 629 | - $plugin_slug = $migrates_to['slug']; |
|
| 630 | - $version = $migrates_to['version']; |
|
| 631 | - $this->_data_migrations_ran[ $plugin_slug ][ $version ] = $currently_executing_script; |
|
| 632 | - } |
|
| 633 | - $current_script_name = get_class($currently_executing_script); |
|
| 634 | - } catch (Exception $e) { |
|
| 635 | - // an exception occurred while trying to get migration scripts |
|
| 636 | - |
|
| 637 | - $message = sprintf( |
|
| 638 | - __("Error Message: %sStack Trace:%s", "event_espresso"), |
|
| 639 | - $e->getMessage() . '<br>', |
|
| 640 | - $e->getTraceAsString() |
|
| 641 | - ); |
|
| 642 | - // record it on the array of data migration scripts ran. This will be overwritten next time we try and try to run data migrations |
|
| 643 | - // but that's ok-- it's just an FYI to support that we couldn't even run any data migrations |
|
| 644 | - $this->add_error_to_migrations_ran( |
|
| 645 | - sprintf(__("Could not run data migrations because: %s", "event_espresso"), $message) |
|
| 646 | - ); |
|
| 647 | - return array( |
|
| 648 | - 'records_to_migrate' => 1, |
|
| 649 | - 'records_migrated' => 0, |
|
| 650 | - 'status' => self::status_fatal_error, |
|
| 651 | - 'script' => __("Error loading data migration scripts", "event_espresso"), |
|
| 652 | - 'message' => $message, |
|
| 653 | - ); |
|
| 654 | - } |
|
| 655 | - // ok so we definitely have a data migration script |
|
| 656 | - try { |
|
| 657 | - // how big of a bite do we want to take? Allow users to easily override via their wp-config |
|
| 658 | - if (absint($step_size) < 1) { |
|
| 659 | - $step_size = defined('EE_MIGRATION_STEP_SIZE') && absint(EE_MIGRATION_STEP_SIZE) |
|
| 660 | - ? EE_MIGRATION_STEP_SIZE : EE_Data_Migration_Manager::step_size; |
|
| 661 | - } |
|
| 662 | - // do what we came to do! |
|
| 663 | - $currently_executing_script->migration_step($step_size); |
|
| 664 | - // can we wrap it up and verify default data? |
|
| 665 | - $init_dbs = false; |
|
| 666 | - switch ($currently_executing_script->get_status()) { |
|
| 667 | - case EE_Data_Migration_Manager::status_continue: |
|
| 668 | - $response_array = array( |
|
| 669 | - 'records_to_migrate' => $currently_executing_script->count_records_to_migrate(), |
|
| 670 | - 'records_migrated' => $currently_executing_script->count_records_migrated(), |
|
| 671 | - 'status' => EE_Data_Migration_Manager::status_continue, |
|
| 672 | - 'message' => $currently_executing_script->get_feedback_message(), |
|
| 673 | - 'script' => $currently_executing_script->pretty_name(), |
|
| 674 | - ); |
|
| 675 | - break; |
|
| 676 | - case EE_Data_Migration_Manager::status_completed: |
|
| 677 | - // ok so THAT script has completed |
|
| 678 | - $this->update_current_database_state_to($this->script_migrates_to_version($current_script_name)); |
|
| 679 | - $response_array = array( |
|
| 680 | - 'records_to_migrate' => $currently_executing_script->count_records_to_migrate(), |
|
| 681 | - 'records_migrated' => $currently_executing_script->count_records_migrated(), |
|
| 682 | - 'status' => EE_Data_Migration_Manager::status_completed, |
|
| 683 | - 'message' => $currently_executing_script->get_feedback_message(), |
|
| 684 | - 'script' => sprintf( |
|
| 685 | - __("%s Completed", 'event_espresso'), |
|
| 686 | - $currently_executing_script->pretty_name() |
|
| 687 | - ), |
|
| 688 | - ); |
|
| 689 | - // check if there are any more after this one. |
|
| 690 | - $scripts_remaining = $this->check_for_applicable_data_migration_scripts(); |
|
| 691 | - if (! $scripts_remaining) { |
|
| 692 | - // we should be good to allow them to exit maintenance mode now |
|
| 693 | - EE_Maintenance_Mode::instance()->set_maintenance_level( |
|
| 694 | - intval(EE_Maintenance_Mode::level_0_not_in_maintenance) |
|
| 695 | - ); |
|
| 696 | - // huh, no more scripts to run... apparently we're done! |
|
| 697 | - // but dont forget to make sure initial data is there |
|
| 698 | - $init_dbs = true; |
|
| 699 | - $response_array['status'] = self::status_no_more_migration_scripts; |
|
| 700 | - } |
|
| 701 | - break; |
|
| 702 | - default: |
|
| 703 | - $response_array = array( |
|
| 704 | - 'records_to_migrate' => $currently_executing_script->count_records_to_migrate(), |
|
| 705 | - 'records_migrated' => $currently_executing_script->count_records_migrated(), |
|
| 706 | - 'status' => $currently_executing_script->get_status(), |
|
| 707 | - 'message' => sprintf( |
|
| 708 | - __("Minor errors occurred during %s: %s", "event_espresso"), |
|
| 709 | - $currently_executing_script->pretty_name(), |
|
| 710 | - implode(", ", $currently_executing_script->get_errors()) |
|
| 711 | - ), |
|
| 712 | - 'script' => $currently_executing_script->pretty_name(), |
|
| 713 | - ); |
|
| 714 | - break; |
|
| 715 | - } |
|
| 716 | - } catch (Exception $e) { |
|
| 717 | - // ok so some exception was thrown which killed the data migration script |
|
| 718 | - // double-check we have a real script |
|
| 719 | - if ($currently_executing_script instanceof EE_Data_Migration_Script_Base) { |
|
| 720 | - $script_name = $currently_executing_script->pretty_name(); |
|
| 721 | - $currently_executing_script->set_broken(); |
|
| 722 | - $currently_executing_script->add_error($e->getMessage()); |
|
| 723 | - } else { |
|
| 724 | - $script_name = __("Error getting Migration Script", "event_espresso"); |
|
| 725 | - } |
|
| 726 | - $response_array = array( |
|
| 727 | - 'records_to_migrate' => 1, |
|
| 728 | - 'records_migrated' => 0, |
|
| 729 | - 'status' => self::status_fatal_error, |
|
| 730 | - 'message' => sprintf( |
|
| 731 | - __("A fatal error occurred during the migration: %s", "event_espresso"), |
|
| 732 | - $e->getMessage() |
|
| 733 | - ), |
|
| 734 | - 'script' => $script_name, |
|
| 735 | - ); |
|
| 736 | - } |
|
| 737 | - $successful_save = $this->_save_migrations_ran(); |
|
| 738 | - if ($successful_save !== true) { |
|
| 739 | - // ok so the current wp option didn't save. that's tricky, because we'd like to update it |
|
| 740 | - // and mark it as having a fatal error, but remember- WE CAN'T SAVE THIS WP OPTION! |
|
| 741 | - // however, if we throw an exception, and return that, then the next request |
|
| 742 | - // won't have as much info in it, and it may be able to save |
|
| 743 | - throw new EE_Error( |
|
| 744 | - sprintf( |
|
| 745 | - __( |
|
| 746 | - "The error '%s' occurred updating the status of the migration. This is a FATAL ERROR, but the error is preventing the system from remembering that. Please contact event espresso support.", |
|
| 747 | - "event_espresso" |
|
| 748 | - ), |
|
| 749 | - $successful_save |
|
| 750 | - ) |
|
| 751 | - ); |
|
| 752 | - } |
|
| 753 | - // if we're all done, initialize EE plugins' default data etc. |
|
| 754 | - if ($init_dbs) { |
|
| 755 | - $this->initialize_db_for_enqueued_ee_plugins(); |
|
| 756 | - } |
|
| 757 | - return $response_array; |
|
| 758 | - } |
|
| 759 | - |
|
| 760 | - |
|
| 761 | - /** |
|
| 762 | - * Echo out JSON response to migration script AJAX requests. Takes precautions |
|
| 763 | - * to buffer output so that we don't throw junk into our json. |
|
| 764 | - * |
|
| 765 | - * @return array with keys: |
|
| 766 | - * 'records_to_migrate' which counts ALL the records for the current migration, and should remain constant. (ie, |
|
| 767 | - * it's NOT the count of hwo many remain) |
|
| 768 | - * 'records_migrated' which also counts ALL the records which have been migrated (ie, percent_complete = |
|
| 769 | - * records_migrated/records_to_migrate) |
|
| 770 | - * 'status'=>a string, one of EE_Data_migration_Manager::status_* |
|
| 771 | - * 'message'=>a string, containing any message you want to show to the user. We may decide to split this up into |
|
| 772 | - * errors, notifications, and successes |
|
| 773 | - * 'script'=>a pretty name of the script currently running |
|
| 774 | - */ |
|
| 775 | - public function response_to_migration_ajax_request() |
|
| 776 | - { |
|
| 777 | - ob_start(); |
|
| 778 | - try { |
|
| 779 | - $response = $this->migration_step(); |
|
| 780 | - } catch (Exception $e) { |
|
| 781 | - $response = array( |
|
| 782 | - 'records_to_migrate' => 0, |
|
| 783 | - 'records_migrated' => 0, |
|
| 784 | - 'status' => EE_Data_Migration_Manager::status_fatal_error, |
|
| 785 | - 'message' => sprintf( |
|
| 786 | - __("Unknown fatal error occurred: %s", "event_espresso"), |
|
| 787 | - $e->getMessage() |
|
| 788 | - ), |
|
| 789 | - 'script' => 'Unknown', |
|
| 790 | - ); |
|
| 791 | - $this->add_error_to_migrations_ran($e->getMessage() . "; Stack trace:" . $e->getTraceAsString()); |
|
| 792 | - } |
|
| 793 | - $warnings_etc = @ob_get_contents(); |
|
| 794 | - ob_end_clean(); |
|
| 795 | - $response['message'] .= $warnings_etc; |
|
| 796 | - return $response; |
|
| 797 | - } |
|
| 798 | - |
|
| 799 | - /** |
|
| 800 | - * Updates the wordpress option that keeps track of which which EE version the database |
|
| 801 | - * is at (ie, the code may be at 4.1.0, but the database is still at 3.1.35) |
|
| 802 | - * |
|
| 803 | - * @param array $slug_and_version { |
|
| 804 | - * @type string $slug like 'Core' or 'Calendar', |
|
| 805 | - * @type string $version like '4.1.0' |
|
| 806 | - * } |
|
| 807 | - * @return void |
|
| 808 | - */ |
|
| 809 | - public function update_current_database_state_to($slug_and_version = null) |
|
| 810 | - { |
|
| 811 | - if (! $slug_and_version) { |
|
| 812 | - // no version was provided, assume it should be at the current code version |
|
| 813 | - $slug_and_version = array('slug' => 'Core', 'version' => espresso_version()); |
|
| 814 | - } |
|
| 815 | - $current_database_state = get_option(self::current_database_state); |
|
| 816 | - $current_database_state[ $slug_and_version['slug'] ] = $slug_and_version['version']; |
|
| 817 | - update_option(self::current_database_state, $current_database_state); |
|
| 818 | - } |
|
| 819 | - |
|
| 820 | - /** |
|
| 821 | - * Determines if the database is currently at a state matching what's indicated in $slug and $version. |
|
| 822 | - * |
|
| 823 | - * @param array $slug_and_version { |
|
| 824 | - * @type string $slug like 'Core' or 'Calendar', |
|
| 825 | - * @type string $version like '4.1.0' |
|
| 826 | - * } |
|
| 827 | - * @return boolean |
|
| 828 | - */ |
|
| 829 | - public function database_needs_updating_to($slug_and_version) |
|
| 830 | - { |
|
| 831 | - |
|
| 832 | - $slug = $slug_and_version['slug']; |
|
| 833 | - $version = $slug_and_version['version']; |
|
| 834 | - $current_database_state = get_option(self::current_database_state); |
|
| 835 | - if (! isset($current_database_state[ $slug ])) { |
|
| 836 | - return true; |
|
| 837 | - } else { |
|
| 838 | - // just compare the first 3 parts of version string, eg "4.7.1", not "4.7.1.dev.032" because DBs shouldn't change on nano version changes |
|
| 839 | - $version_parts_current_db_state = array_slice(explode('.', $current_database_state[ $slug ]), 0, 3); |
|
| 840 | - $version_parts_of_provided_db_state = array_slice(explode('.', $version), 0, 3); |
|
| 841 | - $needs_updating = false; |
|
| 842 | - foreach ($version_parts_current_db_state as $offset => $version_part_in_current_db_state) { |
|
| 843 | - if ($version_part_in_current_db_state < $version_parts_of_provided_db_state[ $offset ]) { |
|
| 844 | - $needs_updating = true; |
|
| 845 | - break; |
|
| 846 | - } |
|
| 847 | - } |
|
| 848 | - return $needs_updating; |
|
| 849 | - } |
|
| 850 | - } |
|
| 851 | - |
|
| 852 | - |
|
| 853 | - /** |
|
| 854 | - * Gets all the data migration scripts available in the core folder and folders |
|
| 855 | - * in addons. Has the side effect of adding them for autoloading |
|
| 856 | - * |
|
| 857 | - * @return array keys are expected classnames, values are their filepaths |
|
| 858 | - * @throws InvalidInterfaceException |
|
| 859 | - * @throws InvalidDataTypeException |
|
| 860 | - * @throws EE_Error |
|
| 861 | - * @throws InvalidArgumentException |
|
| 862 | - */ |
|
| 863 | - public function get_all_data_migration_scripts_available() |
|
| 864 | - { |
|
| 865 | - if (! $this->_data_migration_class_to_filepath_map) { |
|
| 866 | - $this->_data_migration_class_to_filepath_map = array(); |
|
| 867 | - foreach ($this->get_data_migration_script_folders() as $eeAddonClass => $folder_path) { |
|
| 868 | - // strip any placeholders added to classname to make it a unique array key |
|
| 869 | - $eeAddonClass = trim($eeAddonClass, '*'); |
|
| 870 | - $eeAddonClass = $eeAddonClass === 'Core' || class_exists($eeAddonClass) |
|
| 871 | - ? $eeAddonClass |
|
| 872 | - : ''; |
|
| 873 | - $folder_path = EEH_File::end_with_directory_separator($folder_path); |
|
| 874 | - $files = glob($folder_path . '*.dms.php'); |
|
| 875 | - if (empty($files)) { |
|
| 876 | - continue; |
|
| 877 | - } |
|
| 878 | - foreach ($files as $file) { |
|
| 879 | - $pos_of_last_slash = strrpos($file, DS); |
|
| 880 | - $classname = str_replace('.dms.php', '', substr($file, $pos_of_last_slash + 1)); |
|
| 881 | - $migrates_to = $this->script_migrates_to_version($classname, $eeAddonClass); |
|
| 882 | - $slug = $migrates_to['slug']; |
|
| 883 | - // check that the slug as contained in the DMS is associated with |
|
| 884 | - // the slug of an addon or core |
|
| 885 | - if ($slug !== 'Core' && EE_Registry::instance()->get_addon_by_name($slug) === null) { |
|
| 886 | - EE_Error::doing_it_wrong( |
|
| 887 | - __FUNCTION__, |
|
| 888 | - sprintf( |
|
| 889 | - esc_html__( |
|
| 890 | - 'The data migration script "%s" migrates the "%s" data, but there is no EE addon with that name. There is only: %s. ', |
|
| 891 | - 'event_espresso' |
|
| 892 | - ), |
|
| 893 | - $classname, |
|
| 894 | - $slug, |
|
| 895 | - implode(', ', array_keys(EE_Registry::instance()->get_addons_by_name())) |
|
| 896 | - ), |
|
| 897 | - '4.3.0.alpha.019' |
|
| 898 | - ); |
|
| 899 | - } |
|
| 900 | - $this->_data_migration_class_to_filepath_map[ $classname ] = $file; |
|
| 901 | - } |
|
| 902 | - } |
|
| 903 | - EEH_Autoloader::register_autoloader($this->_data_migration_class_to_filepath_map); |
|
| 904 | - } |
|
| 905 | - return $this->_data_migration_class_to_filepath_map; |
|
| 906 | - } |
|
| 907 | - |
|
| 908 | - |
|
| 909 | - /** |
|
| 910 | - * Once we have an addon that works with EE4.1, we will actually want to fetch the PUE slugs |
|
| 911 | - * from each addon, and check if they need updating, |
|
| 912 | - * |
|
| 913 | - * @return boolean |
|
| 914 | - */ |
|
| 915 | - public function addons_need_updating() |
|
| 916 | - { |
|
| 917 | - return false; |
|
| 918 | - } |
|
| 919 | - |
|
| 920 | - /** |
|
| 921 | - * Adds this error string to the data_migrations_ran array, but we dont necessarily know |
|
| 922 | - * where to put it, so we just throw it in there... better than nothing... |
|
| 923 | - * |
|
| 924 | - * @param string $error_message |
|
| 925 | - * @throws EE_Error |
|
| 926 | - */ |
|
| 927 | - public function add_error_to_migrations_ran($error_message) |
|
| 928 | - { |
|
| 929 | - // get last-ran migration script |
|
| 930 | - global $wpdb; |
|
| 931 | - $last_migration_script_option = $wpdb->get_row( |
|
| 932 | - "SELECT * FROM $wpdb->options WHERE option_name like '" . EE_Data_Migration_Manager::data_migration_script_option_prefix . "%' ORDER BY option_id DESC LIMIT 1", |
|
| 933 | - ARRAY_A |
|
| 934 | - ); |
|
| 935 | - |
|
| 936 | - $last_ran_migration_script_properties = isset($last_migration_script_option['option_value']) |
|
| 937 | - ? maybe_unserialize($last_migration_script_option['option_value']) : null; |
|
| 938 | - // now, tread lightly because we're here because a FATAL non-catchable error |
|
| 939 | - // was thrown last time when we were trying to run a data migration script |
|
| 940 | - // so the fatal error could have happened while getting the migration script |
|
| 941 | - // or doing running it... |
|
| 942 | - $versions_migrated_to = isset($last_migration_script_option['option_name']) ? str_replace( |
|
| 943 | - EE_Data_Migration_Manager::data_migration_script_option_prefix, |
|
| 944 | - "", |
|
| 945 | - $last_migration_script_option['option_name'] |
|
| 946 | - ) : null; |
|
| 947 | - |
|
| 948 | - // check if it THINKS its a data migration script and especially if it's one that HASN'T finished yet |
|
| 949 | - // because if it has finished, then it obviously couldn't be the cause of this error, right? (because its all done) |
|
| 950 | - if (isset($last_ran_migration_script_properties['class']) && isset($last_ran_migration_script_properties['_status']) && $last_ran_migration_script_properties['_status'] != self::status_completed) { |
|
| 951 | - // ok then just add this error to its list of errors |
|
| 952 | - $last_ran_migration_script_properties['_errors'][] = $error_message; |
|
| 953 | - $last_ran_migration_script_properties['_status'] = self::status_fatal_error; |
|
| 954 | - } else { |
|
| 955 | - // so we don't even know which script was last running |
|
| 956 | - // use the data migration error stub, which is designed specifically for this type of thing |
|
| 957 | - $general_migration_error = new EE_DMS_Unknown_1_0_0(); |
|
| 958 | - $general_migration_error->add_error($error_message); |
|
| 959 | - $general_migration_error->set_broken(); |
|
| 960 | - $last_ran_migration_script_properties = $general_migration_error->properties_as_array(); |
|
| 961 | - $versions_migrated_to = 'Unknown.1.0.0'; |
|
| 962 | - // now just to make sure appears as last (in case the were previously a fatal error like this) |
|
| 963 | - // delete the old one |
|
| 964 | - delete_option(self::data_migration_script_option_prefix . $versions_migrated_to); |
|
| 965 | - } |
|
| 966 | - update_option( |
|
| 967 | - self::data_migration_script_option_prefix . $versions_migrated_to, |
|
| 968 | - $last_ran_migration_script_properties |
|
| 969 | - ); |
|
| 970 | - } |
|
| 971 | - |
|
| 972 | - /** |
|
| 973 | - * saves what data migrations have ran to the database |
|
| 974 | - * |
|
| 975 | - * @return mixed TRUE if successfully saved migrations ran, string if an error occurred |
|
| 976 | - */ |
|
| 977 | - protected function _save_migrations_ran() |
|
| 978 | - { |
|
| 979 | - if ($this->_data_migrations_ran == null) { |
|
| 980 | - $this->get_data_migrations_ran(); |
|
| 981 | - } |
|
| 982 | - // now, we don't want to save actual classes to the DB because that's messy |
|
| 983 | - $successful_updates = true; |
|
| 984 | - foreach ($this->_data_migrations_ran as $plugin_slug => $migrations_ran_for_plugin) { |
|
| 985 | - foreach ($migrations_ran_for_plugin as $version_string => $array_or_migration_obj) { |
|
| 986 | - $plugin_slug_for_use_in_option_name = $plugin_slug . "."; |
|
| 987 | - $option_name = self::data_migration_script_option_prefix . $plugin_slug_for_use_in_option_name . $version_string; |
|
| 988 | - $old_option_value = get_option($option_name); |
|
| 989 | - if ($array_or_migration_obj instanceof EE_Data_Migration_Script_Base) { |
|
| 990 | - $script_array_for_saving = $array_or_migration_obj->properties_as_array(); |
|
| 991 | - if ($old_option_value != $script_array_for_saving) { |
|
| 992 | - $successful_updates = update_option($option_name, $script_array_for_saving); |
|
| 993 | - } |
|
| 994 | - } else {// we don't know what this array-thing is. So just save it as-is |
|
| 995 | - if ($old_option_value != $array_or_migration_obj) { |
|
| 996 | - $successful_updates = update_option($option_name, $array_or_migration_obj); |
|
| 997 | - } |
|
| 998 | - } |
|
| 999 | - if (! $successful_updates) { |
|
| 1000 | - global $wpdb; |
|
| 1001 | - return $wpdb->last_error; |
|
| 1002 | - } |
|
| 1003 | - } |
|
| 1004 | - } |
|
| 1005 | - return true; |
|
| 1006 | - // $updated = update_option(self::data_migrations_option_name, $array_of_migrations); |
|
| 1007 | - // if ($updated !== true) { |
|
| 1008 | - // global $wpdb; |
|
| 1009 | - // return $wpdb->last_error; |
|
| 1010 | - // } else { |
|
| 1011 | - // return true; |
|
| 1012 | - // } |
|
| 1013 | - // wp_mail( |
|
| 1014 | - // "[email protected]", |
|
| 1015 | - // time() . " price debug info", |
|
| 1016 | - // "updated: $updated, last error: $last_error, byte length of option: " . strlen( |
|
| 1017 | - // serialize($array_of_migrations) |
|
| 1018 | - // ) |
|
| 1019 | - // ); |
|
| 1020 | - } |
|
| 1021 | - |
|
| 1022 | - /** |
|
| 1023 | - * Takes an array of data migration script properties and re-creates the class from |
|
| 1024 | - * them. The argument $properties_array is assumed to have been made by |
|
| 1025 | - * EE_Data_Migration_Script_Base::properties_as_array() |
|
| 1026 | - * |
|
| 1027 | - * @param array $properties_array |
|
| 1028 | - * @return EE_Data_Migration_Script_Base |
|
| 1029 | - * @throws EE_Error |
|
| 1030 | - */ |
|
| 1031 | - public function _instantiate_script_from_properties_array($properties_array) |
|
| 1032 | - { |
|
| 1033 | - if (! isset($properties_array['class'])) { |
|
| 1034 | - throw new EE_Error( |
|
| 1035 | - sprintf( |
|
| 1036 | - __("Properties array has no 'class' properties. Here's what it has: %s", "event_espresso"), |
|
| 1037 | - implode(",", $properties_array) |
|
| 1038 | - ) |
|
| 1039 | - ); |
|
| 1040 | - } |
|
| 1041 | - $class_name = $properties_array['class']; |
|
| 1042 | - if (! class_exists($class_name)) { |
|
| 1043 | - throw new EE_Error(sprintf(__("There is no migration script named %s", "event_espresso"), $class_name)); |
|
| 1044 | - } |
|
| 1045 | - $class = new $class_name; |
|
| 1046 | - if (! $class instanceof EE_Data_Migration_Script_Base) { |
|
| 1047 | - throw new EE_Error( |
|
| 1048 | - sprintf( |
|
| 1049 | - __("Class '%s' is supposed to be a migration script. Its not, its a '%s'", "event_espresso"), |
|
| 1050 | - $class_name, |
|
| 1051 | - get_class($class) |
|
| 1052 | - ) |
|
| 1053 | - ); |
|
| 1054 | - } |
|
| 1055 | - $class->instantiate_from_array_of_properties($properties_array); |
|
| 1056 | - return $class; |
|
| 1057 | - } |
|
| 1058 | - |
|
| 1059 | - /** |
|
| 1060 | - * Gets the classname for the most up-to-date DMS (ie, the one that will finally |
|
| 1061 | - * leave the DB in a state usable by the current plugin code). |
|
| 1062 | - * |
|
| 1063 | - * @param string $plugin_slug the slug for the ee plugin we are searching for. Default is 'Core' |
|
| 1064 | - * @return string |
|
| 1065 | - */ |
|
| 1066 | - public function get_most_up_to_date_dms($plugin_slug = 'Core') |
|
| 1067 | - { |
|
| 1068 | - $class_to_filepath_map = $this->get_all_data_migration_scripts_available(); |
|
| 1069 | - $most_up_to_date_dms_classname = null; |
|
| 1070 | - foreach ($class_to_filepath_map as $classname => $filepath) { |
|
| 1071 | - if ($most_up_to_date_dms_classname === null) { |
|
| 1072 | - $migrates_to = $this->script_migrates_to_version($classname); |
|
| 1073 | - $this_plugin_slug = $migrates_to['slug']; |
|
| 1074 | - if ($this_plugin_slug == $plugin_slug) { |
|
| 1075 | - // if it's for core, it wins |
|
| 1076 | - $most_up_to_date_dms_classname = $classname; |
|
| 1077 | - } |
|
| 1078 | - // if it wasn't for core, we must keep searching for one that is! |
|
| 1079 | - continue; |
|
| 1080 | - } else { |
|
| 1081 | - $champion_migrates_to = $this->script_migrates_to_version($most_up_to_date_dms_classname); |
|
| 1082 | - $contender_migrates_to = $this->script_migrates_to_version($classname); |
|
| 1083 | - if ($contender_migrates_to['slug'] == $plugin_slug |
|
| 1084 | - && version_compare( |
|
| 1085 | - $champion_migrates_to['version'], |
|
| 1086 | - $contender_migrates_to['version'], |
|
| 1087 | - '<' |
|
| 1088 | - )) { |
|
| 1089 | - // so the contenders version is higher and its for Core |
|
| 1090 | - $most_up_to_date_dms_classname = $classname; |
|
| 1091 | - } |
|
| 1092 | - } |
|
| 1093 | - } |
|
| 1094 | - return $most_up_to_date_dms_classname; |
|
| 1095 | - } |
|
| 1096 | - |
|
| 1097 | - /** |
|
| 1098 | - * Gets the migration script specified but ONLY if it has already ran. |
|
| 1099 | - * |
|
| 1100 | - * Eg, if you wanted to see if 'EE_DMS_Core_4_1_0' has ran, you would run the following code: |
|
| 1101 | - * <code> $core_4_1_0_dms_ran = EE_Data_Migration_Manager::instance()->get_migration_ran( '4.1.0', 'Core' ) !== |
|
| 1102 | - * NULL;</code> This is especially useful in addons' data migration scripts, this way they can tell if a core (or |
|
| 1103 | - * other addon) DMS has ran, in case the current DMS depends on it. |
|
| 1104 | - * |
|
| 1105 | - * @param string $version the version the DMS searched for migrates to. Usually just the content before the 3rd |
|
| 1106 | - * period. Eg '4.1.0' |
|
| 1107 | - * @param string $plugin_slug like 'Core', 'Mailchimp', 'Calendar', etc |
|
| 1108 | - * @return EE_Data_Migration_Script_Base |
|
| 1109 | - */ |
|
| 1110 | - public function get_migration_ran($version, $plugin_slug = 'Core') |
|
| 1111 | - { |
|
| 1112 | - $migrations_ran = $this->get_data_migrations_ran(); |
|
| 1113 | - if (isset($migrations_ran[ $plugin_slug ]) && isset($migrations_ran[ $plugin_slug ][ $version ])) { |
|
| 1114 | - return $migrations_ran[ $plugin_slug ][ $version ]; |
|
| 1115 | - } else { |
|
| 1116 | - return null; |
|
| 1117 | - } |
|
| 1118 | - } |
|
| 1119 | - |
|
| 1120 | - /** |
|
| 1121 | - * Resets the borked data migration scripts so they're no longer borked |
|
| 1122 | - * so we can again attempt to migrate |
|
| 1123 | - * |
|
| 1124 | - * @return bool |
|
| 1125 | - * @throws EE_Error |
|
| 1126 | - */ |
|
| 1127 | - public function reattempt() |
|
| 1128 | - { |
|
| 1129 | - // find if the last-ran script was borked |
|
| 1130 | - // set it as being non-borked (we shouldn't ever get DMSs that we don't recognize) |
|
| 1131 | - // add an 'error' saying that we attempted to reset |
|
| 1132 | - // does it have a stage that was borked too? if so make it no longer borked |
|
| 1133 | - // add an 'error' saying we attempted to reset |
|
| 1134 | - $last_ran_script = $this->get_last_ran_script(); |
|
| 1135 | - if ($last_ran_script instanceof EE_DMS_Unknown_1_0_0) { |
|
| 1136 | - // if it was an error DMS, just mark it as complete (if another error occurs it will overwrite it) |
|
| 1137 | - $last_ran_script->set_completed(); |
|
| 1138 | - } elseif ($last_ran_script instanceof EE_Data_Migration_Script_Base) { |
|
| 1139 | - $last_ran_script->reattempt(); |
|
| 1140 | - } else { |
|
| 1141 | - throw new EE_Error( |
|
| 1142 | - sprintf( |
|
| 1143 | - __( |
|
| 1144 | - 'Unable to reattempt the last ran migration script because it was not a valid migration script. || It was %s', |
|
| 1145 | - 'event_espresso' |
|
| 1146 | - ), |
|
| 1147 | - print_r($last_ran_script, true) |
|
| 1148 | - ) |
|
| 1149 | - ); |
|
| 1150 | - } |
|
| 1151 | - return $this->_save_migrations_ran(); |
|
| 1152 | - } |
|
| 1153 | - |
|
| 1154 | - /** |
|
| 1155 | - * Gets whether or not this particular migration has run or not |
|
| 1156 | - * |
|
| 1157 | - * @param string $version the version the DMS searched for migrates to. Usually just the content before the 3rd |
|
| 1158 | - * period. Eg '4.1.0' |
|
| 1159 | - * @param string $plugin_slug like 'Core', 'Mailchimp', 'Calendar', etc |
|
| 1160 | - * @return boolean |
|
| 1161 | - */ |
|
| 1162 | - public function migration_has_ran($version, $plugin_slug = 'Core') |
|
| 1163 | - { |
|
| 1164 | - return $this->get_migration_ran($version, $plugin_slug) !== null; |
|
| 1165 | - } |
|
| 1166 | - |
|
| 1167 | - /** |
|
| 1168 | - * Enqueues this ee plugin to have its data initialized |
|
| 1169 | - * |
|
| 1170 | - * @param string $plugin_slug either 'Core' or EE_Addon::name()'s return value |
|
| 1171 | - */ |
|
| 1172 | - public function enqueue_db_initialization_for($plugin_slug) |
|
| 1173 | - { |
|
| 1174 | - $queue = $this->get_db_initialization_queue(); |
|
| 1175 | - if (! in_array($plugin_slug, $queue)) { |
|
| 1176 | - $queue[] = $plugin_slug; |
|
| 1177 | - } |
|
| 1178 | - update_option(self::db_init_queue_option_name, $queue); |
|
| 1179 | - } |
|
| 1180 | - |
|
| 1181 | - /** |
|
| 1182 | - * Calls EE_Addon::initialize_db_if_no_migrations_required() on each addon |
|
| 1183 | - * specified in EE_Data_Migration_Manager::get_db_init_queue(), and if 'Core' is |
|
| 1184 | - * in the queue, calls EE_System::initialize_db_if_no_migrations_required(). |
|
| 1185 | - */ |
|
| 1186 | - public function initialize_db_for_enqueued_ee_plugins() |
|
| 1187 | - { |
|
| 1188 | - $queue = $this->get_db_initialization_queue(); |
|
| 1189 | - foreach ($queue as $plugin_slug) { |
|
| 1190 | - $most_up_to_date_dms = $this->get_most_up_to_date_dms($plugin_slug); |
|
| 1191 | - if (! $most_up_to_date_dms) { |
|
| 1192 | - // if there is NO DMS for this plugin, obviously there's no schema to verify anyways |
|
| 1193 | - $verify_db = false; |
|
| 1194 | - } else { |
|
| 1195 | - $most_up_to_date_dms_migrates_to = $this->script_migrates_to_version($most_up_to_date_dms); |
|
| 1196 | - $verify_db = $this->database_needs_updating_to($most_up_to_date_dms_migrates_to); |
|
| 1197 | - } |
|
| 1198 | - if ($plugin_slug == 'Core') { |
|
| 1199 | - EE_System::instance()->initialize_db_if_no_migrations_required( |
|
| 1200 | - false, |
|
| 1201 | - $verify_db |
|
| 1202 | - ); |
|
| 1203 | - } else { |
|
| 1204 | - // just loop through the addons to make sure their database is setup |
|
| 1205 | - foreach (EE_Registry::instance()->addons as $addon) { |
|
| 1206 | - if ($addon->name() == $plugin_slug) { |
|
| 1207 | - $addon->initialize_db_if_no_migrations_required($verify_db); |
|
| 1208 | - break; |
|
| 1209 | - } |
|
| 1210 | - } |
|
| 1211 | - } |
|
| 1212 | - } |
|
| 1213 | - // because we just initialized the DBs for the enqueued ee plugins |
|
| 1214 | - // we don't need to keep remembering which ones needed to be initialized |
|
| 1215 | - delete_option(self::db_init_queue_option_name); |
|
| 1216 | - } |
|
| 1217 | - |
|
| 1218 | - /** |
|
| 1219 | - * Gets a numerically-indexed array of plugin slugs that need to have their databases |
|
| 1220 | - * (re-)initialized after migrations are complete. ie, each element should be either |
|
| 1221 | - * 'Core', or the return value of EE_Addon::name() for an addon |
|
| 1222 | - * |
|
| 1223 | - * @return array |
|
| 1224 | - */ |
|
| 1225 | - public function get_db_initialization_queue() |
|
| 1226 | - { |
|
| 1227 | - return get_option(self::db_init_queue_option_name, array()); |
|
| 1228 | - } |
|
| 1229 | - |
|
| 1230 | - /** |
|
| 1231 | - * Gets the injected table analyzer, or throws an exception |
|
| 1232 | - * |
|
| 1233 | - * @return TableAnalysis |
|
| 1234 | - * @throws EE_Error |
|
| 1235 | - */ |
|
| 1236 | - protected function _get_table_analysis() |
|
| 1237 | - { |
|
| 1238 | - if ($this->_table_analysis instanceof TableAnalysis) { |
|
| 1239 | - return $this->_table_analysis; |
|
| 1240 | - } else { |
|
| 1241 | - throw new EE_Error( |
|
| 1242 | - sprintf( |
|
| 1243 | - __('Table analysis class on class %1$s is not set properly.', 'event_espresso'), |
|
| 1244 | - get_class($this) |
|
| 1245 | - ) |
|
| 1246 | - ); |
|
| 1247 | - } |
|
| 1248 | - } |
|
| 1249 | - |
|
| 1250 | - /** |
|
| 1251 | - * Gets the injected table manager, or throws an exception |
|
| 1252 | - * |
|
| 1253 | - * @return TableManager |
|
| 1254 | - * @throws EE_Error |
|
| 1255 | - */ |
|
| 1256 | - protected function _get_table_manager() |
|
| 1257 | - { |
|
| 1258 | - if ($this->_table_manager instanceof TableManager) { |
|
| 1259 | - return $this->_table_manager; |
|
| 1260 | - } else { |
|
| 1261 | - throw new EE_Error( |
|
| 1262 | - sprintf( |
|
| 1263 | - __('Table manager class on class %1$s is not set properly.', 'event_espresso'), |
|
| 1264 | - get_class($this) |
|
| 1265 | - ) |
|
| 1266 | - ); |
|
| 1267 | - } |
|
| 1268 | - } |
|
| 35 | + /** |
|
| 36 | + * |
|
| 37 | + * @var EE_Registry |
|
| 38 | + */ |
|
| 39 | + // protected $EE; |
|
| 40 | + /** |
|
| 41 | + * name of the wordpress option which stores an array of data about |
|
| 42 | + */ |
|
| 43 | + const data_migrations_option_name = 'ee_data_migration'; |
|
| 44 | + |
|
| 45 | + |
|
| 46 | + const data_migration_script_option_prefix = 'ee_data_migration_script_'; |
|
| 47 | + |
|
| 48 | + const data_migration_script_mapping_option_prefix = 'ee_dms_map_'; |
|
| 49 | + |
|
| 50 | + /** |
|
| 51 | + * name of the wordpress option which stores the database' current version. IE, the code may be at version 4.2.0, |
|
| 52 | + * but as migrations are performed the database will progress from 3.1.35 to 4.1.0 etc. |
|
| 53 | + */ |
|
| 54 | + const current_database_state = 'ee_data_migration_current_db_state'; |
|
| 55 | + |
|
| 56 | + /** |
|
| 57 | + * Special status string returned when we're positive there are no more data migration |
|
| 58 | + * scripts that can be run. |
|
| 59 | + */ |
|
| 60 | + const status_no_more_migration_scripts = 'no_more_migration_scripts'; |
|
| 61 | + /** |
|
| 62 | + * string indicating the migration should continue |
|
| 63 | + */ |
|
| 64 | + const status_continue = 'status_continue'; |
|
| 65 | + /** |
|
| 66 | + * string indicating the migration has completed and should be ended |
|
| 67 | + */ |
|
| 68 | + const status_completed = 'status_completed'; |
|
| 69 | + /** |
|
| 70 | + * string indicating a fatal error occurred and the data migration should be completely aborted |
|
| 71 | + */ |
|
| 72 | + const status_fatal_error = 'status_fatal_error'; |
|
| 73 | + |
|
| 74 | + /** |
|
| 75 | + * the number of 'items' (usually DB rows) to migrate on each 'step' (ajax request sent |
|
| 76 | + * during migration) |
|
| 77 | + */ |
|
| 78 | + const step_size = 50; |
|
| 79 | + |
|
| 80 | + /** |
|
| 81 | + * option name that stores the queue of ee plugins needing to have |
|
| 82 | + * their data initialized (or re-initialized) once we are done migrations |
|
| 83 | + */ |
|
| 84 | + const db_init_queue_option_name = 'ee_db_init_queue'; |
|
| 85 | + /** |
|
| 86 | + * Array of information concerning data migrations that have ran in the history |
|
| 87 | + * of this EE installation. Keys should be the name of the version the script upgraded to |
|
| 88 | + * |
|
| 89 | + * @var EE_Data_Migration_Script_Base[] |
|
| 90 | + */ |
|
| 91 | + private $_data_migrations_ran = null; |
|
| 92 | + /** |
|
| 93 | + * The last ran script. It's nice to store this somewhere accessible, as its easiest |
|
| 94 | + * to know which was the last run by which is the newest wp option; but in most of the code |
|
| 95 | + * we just use the local $_data_migration_ran array, which organized the scripts differently |
|
| 96 | + * |
|
| 97 | + * @var EE_Data_Migration_Script_Base |
|
| 98 | + */ |
|
| 99 | + private $_last_ran_script = null; |
|
| 100 | + |
|
| 101 | + /** |
|
| 102 | + * Similarly to _last_ran_script, but this is the last INCOMPLETE migration script. |
|
| 103 | + * |
|
| 104 | + * @var EE_Data_Migration_Script_Base |
|
| 105 | + */ |
|
| 106 | + private $_last_ran_incomplete_script = null; |
|
| 107 | + /** |
|
| 108 | + * array where keys are classnames, and values are filepaths of all the known migration scripts |
|
| 109 | + * |
|
| 110 | + * @var array |
|
| 111 | + */ |
|
| 112 | + private $_data_migration_class_to_filepath_map; |
|
| 113 | + |
|
| 114 | + /** |
|
| 115 | + * the following 4 properties are fully set on construction. |
|
| 116 | + * Note: the first two apply to whether to continue running ALL migration scripts (ie, even though we're finished |
|
| 117 | + * one, we may want to start the next one); whereas the last two indicate whether to continue running a single |
|
| 118 | + * data migration script |
|
| 119 | + * |
|
| 120 | + * @var array |
|
| 121 | + */ |
|
| 122 | + public $stati_that_indicate_to_continue_migrations = array(); |
|
| 123 | + |
|
| 124 | + public $stati_that_indicate_to_stop_migrations = array(); |
|
| 125 | + |
|
| 126 | + public $stati_that_indicate_to_continue_single_migration_script = array(); |
|
| 127 | + |
|
| 128 | + public $stati_that_indicate_to_stop_single_migration_script = array(); |
|
| 129 | + |
|
| 130 | + /** |
|
| 131 | + * @var \EventEspresso\core\services\database\TableManager $table_manager |
|
| 132 | + */ |
|
| 133 | + protected $_table_manager; |
|
| 134 | + |
|
| 135 | + /** |
|
| 136 | + * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis |
|
| 137 | + */ |
|
| 138 | + protected $_table_analysis; |
|
| 139 | + |
|
| 140 | + /** |
|
| 141 | + * @var array $script_migration_versions |
|
| 142 | + */ |
|
| 143 | + protected $script_migration_versions; |
|
| 144 | + |
|
| 145 | + /** |
|
| 146 | + * @var EE_Data_Migration_Manager $_instance |
|
| 147 | + * @access private |
|
| 148 | + */ |
|
| 149 | + private static $_instance = null; |
|
| 150 | + |
|
| 151 | + |
|
| 152 | + /** |
|
| 153 | + * @singleton method used to instantiate class object |
|
| 154 | + * @access public |
|
| 155 | + * @return EE_Data_Migration_Manager instance |
|
| 156 | + */ |
|
| 157 | + public static function instance() |
|
| 158 | + { |
|
| 159 | + // check if class object is instantiated |
|
| 160 | + if (! self::$_instance instanceof EE_Data_Migration_Manager) { |
|
| 161 | + self::$_instance = new self(); |
|
| 162 | + } |
|
| 163 | + return self::$_instance; |
|
| 164 | + } |
|
| 165 | + |
|
| 166 | + /** |
|
| 167 | + * resets the singleton to its brand-new state (but does NOT delete old references to the old singleton. Meaning, |
|
| 168 | + * all new usages of the singleton should be made with Classname::instance()) and returns it |
|
| 169 | + * |
|
| 170 | + * @return EE_Data_Migration_Manager |
|
| 171 | + */ |
|
| 172 | + public static function reset() |
|
| 173 | + { |
|
| 174 | + self::$_instance = null; |
|
| 175 | + return self::instance(); |
|
| 176 | + } |
|
| 177 | + |
|
| 178 | + |
|
| 179 | + /** |
|
| 180 | + * constructor |
|
| 181 | + */ |
|
| 182 | + private function __construct() |
|
| 183 | + { |
|
| 184 | + $this->stati_that_indicate_to_continue_migrations = array( |
|
| 185 | + self::status_continue, |
|
| 186 | + self::status_completed, |
|
| 187 | + ); |
|
| 188 | + $this->stati_that_indicate_to_stop_migrations = array( |
|
| 189 | + self::status_fatal_error, |
|
| 190 | + self::status_no_more_migration_scripts, |
|
| 191 | + ); |
|
| 192 | + $this->stati_that_indicate_to_continue_single_migration_script = array( |
|
| 193 | + self::status_continue, |
|
| 194 | + ); |
|
| 195 | + $this->stati_that_indicate_to_stop_single_migration_script = array( |
|
| 196 | + self::status_completed, |
|
| 197 | + self::status_fatal_error |
|
| 198 | + // note: status_no_more_migration_scripts doesn't apply |
|
| 199 | + ); |
|
| 200 | + // make sure we've included the base migration script, because we may need the EE_DMS_Unknown_1_0_0 class |
|
| 201 | + // to be defined, because right now it doesn't get autoloaded on its own |
|
| 202 | + EE_Registry::instance()->load_core('Data_Migration_Class_Base', array(), true); |
|
| 203 | + EE_Registry::instance()->load_core('Data_Migration_Script_Base', array(), true); |
|
| 204 | + EE_Registry::instance()->load_core('DMS_Unknown_1_0_0', array(), true); |
|
| 205 | + EE_Registry::instance()->load_core('Data_Migration_Script_Stage', array(), true); |
|
| 206 | + EE_Registry::instance()->load_core('Data_Migration_Script_Stage_Table', array(), true); |
|
| 207 | + $this->_table_manager = EE_Registry::instance()->create('TableManager', array(), true); |
|
| 208 | + $this->_table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true); |
|
| 209 | + } |
|
| 210 | + |
|
| 211 | + |
|
| 212 | + /** |
|
| 213 | + * Deciphers, from an option's name, what plugin and version it relates to (see _save_migrations_ran to see what |
|
| 214 | + * the option names are like, but generally they're like |
|
| 215 | + * 'ee_data_migration_script_Core.4.1.0' in 4.2 or 'ee_data_migration_script_4.1.0' before that). |
|
| 216 | + * The option name shouldn't ever be like 'ee_data_migration_script_Core.4.1.0.reg' because it's derived, |
|
| 217 | + * indirectly, from the data migration's classname, which should always be like EE_DMS_%s_%d_%d_%d.dms.php (eg |
|
| 218 | + * EE_DMS_Core_4_1_0.dms.php) |
|
| 219 | + * |
|
| 220 | + * @param string $option_name (see EE_Data_Migration_Manage::_save_migrations_ran() where the option name is set) |
|
| 221 | + * @return array where the first item is the plugin slug (eg 'Core','Calendar',etc) and the 2nd is the version of |
|
| 222 | + * that plugin (eg '4.1.0') |
|
| 223 | + */ |
|
| 224 | + private function _get_plugin_slug_and_version_string_from_dms_option_name($option_name) |
|
| 225 | + { |
|
| 226 | + $plugin_slug_and_version_string = str_replace( |
|
| 227 | + EE_Data_Migration_Manager::data_migration_script_option_prefix, |
|
| 228 | + "", |
|
| 229 | + $option_name |
|
| 230 | + ); |
|
| 231 | + // check if $plugin_slug_and_version_string is like '4.1.0' (4.1-style) or 'Core.4.1.0' (4.2-style) |
|
| 232 | + $parts = explode(".", $plugin_slug_and_version_string); |
|
| 233 | + |
|
| 234 | + if (count($parts) == 4) { |
|
| 235 | + // it's 4.2-style.eg Core.4.1.0 |
|
| 236 | + $plugin_slug = $parts[0];// eg Core |
|
| 237 | + $version_string = $parts[1] . "." . $parts[2] . "." . $parts[3]; // eg 4.1.0 |
|
| 238 | + } else { |
|
| 239 | + // it's 4.1-style: eg 4.1.0 |
|
| 240 | + $plugin_slug = 'Core'; |
|
| 241 | + $version_string = $plugin_slug_and_version_string;// eg 4.1.0 |
|
| 242 | + } |
|
| 243 | + return array($plugin_slug, $version_string); |
|
| 244 | + } |
|
| 245 | + |
|
| 246 | + /** |
|
| 247 | + * Gets the DMS class from the wordpress option, otherwise throws an EE_Error if it's not |
|
| 248 | + * for a known DMS class. |
|
| 249 | + * |
|
| 250 | + * @param string $dms_option_name |
|
| 251 | + * @param string $dms_option_value (serialized) |
|
| 252 | + * @return EE_Data_Migration_Script_Base |
|
| 253 | + * @throws EE_Error |
|
| 254 | + */ |
|
| 255 | + private function _get_dms_class_from_wp_option($dms_option_name, $dms_option_value) |
|
| 256 | + { |
|
| 257 | + $data_migration_data = maybe_unserialize($dms_option_value); |
|
| 258 | + if (isset($data_migration_data['class']) && class_exists($data_migration_data['class'])) { |
|
| 259 | + $class = new $data_migration_data['class']; |
|
| 260 | + if ($class instanceof EE_Data_Migration_Script_Base) { |
|
| 261 | + $class->instantiate_from_array_of_properties($data_migration_data); |
|
| 262 | + return $class; |
|
| 263 | + } else { |
|
| 264 | + // huh, so its an object but not a data migration script?? that shouldn't happen |
|
| 265 | + // just leave it as an array (which will probably just get ignored) |
|
| 266 | + throw new EE_Error( |
|
| 267 | + sprintf( |
|
| 268 | + __( |
|
| 269 | + "Trying to retrieve DMS class from wp option. No DMS by the name '%s' exists", |
|
| 270 | + 'event_espresso' |
|
| 271 | + ), |
|
| 272 | + $data_migration_data['class'] |
|
| 273 | + ) |
|
| 274 | + ); |
|
| 275 | + } |
|
| 276 | + } else { |
|
| 277 | + // so the data doesn't specify a class. So it must either be a legacy array of info or some array (which we'll probably just ignore), or a class that no longer exists |
|
| 278 | + throw new EE_Error( |
|
| 279 | + sprintf(__("The wp option with key '%s' does not represent a DMS", 'event_espresso'), $dms_option_name) |
|
| 280 | + ); |
|
| 281 | + } |
|
| 282 | + } |
|
| 283 | + |
|
| 284 | + /** |
|
| 285 | + * Gets the array describing what data migrations have run. Also has a side-effect of recording which was the last |
|
| 286 | + * ran, and which was the last ran which hasn't finished yet |
|
| 287 | + * |
|
| 288 | + * @return array where each element should be an array of EE_Data_Migration_Script_Base (but also has a few legacy |
|
| 289 | + * arrays in there - which should probably be ignored) |
|
| 290 | + */ |
|
| 291 | + public function get_data_migrations_ran() |
|
| 292 | + { |
|
| 293 | + if (! $this->_data_migrations_ran) { |
|
| 294 | + // setup autoloaders for each of the scripts in there |
|
| 295 | + $this->get_all_data_migration_scripts_available(); |
|
| 296 | + $data_migrations_options = $this->get_all_migration_script_options( |
|
| 297 | + );// get_option(EE_Data_Migration_Manager::data_migrations_option_name,get_option('espresso_data_migrations',array())); |
|
| 298 | + |
|
| 299 | + $data_migrations_ran = array(); |
|
| 300 | + // convert into data migration script classes where possible |
|
| 301 | + foreach ($data_migrations_options as $data_migration_option) { |
|
| 302 | + list($plugin_slug, $version_string) = $this->_get_plugin_slug_and_version_string_from_dms_option_name( |
|
| 303 | + $data_migration_option['option_name'] |
|
| 304 | + ); |
|
| 305 | + |
|
| 306 | + try { |
|
| 307 | + $class = $this->_get_dms_class_from_wp_option( |
|
| 308 | + $data_migration_option['option_name'], |
|
| 309 | + $data_migration_option['option_value'] |
|
| 310 | + ); |
|
| 311 | + $data_migrations_ran[ $plugin_slug ][ $version_string ] = $class; |
|
| 312 | + // ok so far THIS is the 'last-ran-script'... unless we find another on next iteration |
|
| 313 | + $this->_last_ran_script = $class; |
|
| 314 | + if (! $class->is_completed()) { |
|
| 315 | + // sometimes we also like to know which was the last incomplete script (or if there are any at all) |
|
| 316 | + $this->_last_ran_incomplete_script = $class; |
|
| 317 | + } |
|
| 318 | + } catch (EE_Error $e) { |
|
| 319 | + // ok so its not a DMS. We'll just keep it, although other code will need to expect non-DMSs |
|
| 320 | + $data_migrations_ran[ $plugin_slug ][ $version_string ] = maybe_unserialize( |
|
| 321 | + $data_migration_option['option_value'] |
|
| 322 | + ); |
|
| 323 | + } |
|
| 324 | + } |
|
| 325 | + // so here the array of $data_migrations_ran is actually a mix of classes and a few legacy arrays |
|
| 326 | + $this->_data_migrations_ran = $data_migrations_ran; |
|
| 327 | + if (! $this->_data_migrations_ran || ! is_array($this->_data_migrations_ran)) { |
|
| 328 | + $this->_data_migrations_ran = array(); |
|
| 329 | + } |
|
| 330 | + } |
|
| 331 | + return $this->_data_migrations_ran; |
|
| 332 | + } |
|
| 333 | + |
|
| 334 | + |
|
| 335 | + /** |
|
| 336 | + * |
|
| 337 | + * @param string $script_name eg 'DMS_Core_4_1_0' |
|
| 338 | + * @param string $old_table eg 'wp_events_detail' |
|
| 339 | + * @param string $old_pk eg 'wp_esp_posts' |
|
| 340 | + * @param $new_table |
|
| 341 | + * @return mixed string or int |
|
| 342 | + */ |
|
| 343 | + public function get_mapping_new_pk($script_name, $old_table, $old_pk, $new_table) |
|
| 344 | + { |
|
| 345 | + $script = EE_Registry::instance()->load_dms($script_name); |
|
| 346 | + $mapping = $script->get_mapping_new_pk($old_table, $old_pk, $new_table); |
|
| 347 | + return $mapping; |
|
| 348 | + } |
|
| 349 | + |
|
| 350 | + /** |
|
| 351 | + * Gets all the options containing migration scripts that have been run. Ordering is important: it's assumed that |
|
| 352 | + * the last option returned in this array is the most-recently ran DMS option |
|
| 353 | + * |
|
| 354 | + * @return array |
|
| 355 | + */ |
|
| 356 | + public function get_all_migration_script_options() |
|
| 357 | + { |
|
| 358 | + global $wpdb; |
|
| 359 | + return $wpdb->get_results( |
|
| 360 | + "SELECT * FROM {$wpdb->options} WHERE option_name like '" . EE_Data_Migration_Manager::data_migration_script_option_prefix . "%' ORDER BY option_id ASC", |
|
| 361 | + ARRAY_A |
|
| 362 | + ); |
|
| 363 | + } |
|
| 364 | + |
|
| 365 | + /** |
|
| 366 | + * Gets the array of folders which contain data migration scripts. Also adds them to be auto-loaded |
|
| 367 | + * |
|
| 368 | + * @return array where each value is the full folder path of a folder containing data migration scripts, WITH |
|
| 369 | + * slashes at the end of the folder name. |
|
| 370 | + */ |
|
| 371 | + public function get_data_migration_script_folders() |
|
| 372 | + { |
|
| 373 | + return apply_filters( |
|
| 374 | + 'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders', |
|
| 375 | + array('Core' => EE_CORE . 'data_migration_scripts') |
|
| 376 | + ); |
|
| 377 | + } |
|
| 378 | + |
|
| 379 | + /** |
|
| 380 | + * Gets the version the migration script upgrades to |
|
| 381 | + * |
|
| 382 | + * @param string $migration_script_name eg 'EE_DMS_Core_4_1_0' |
|
| 383 | + * @return array { |
|
| 384 | + * @type string $slug like 'Core','Calendar',etc |
|
| 385 | + * @type string $version like 4.3.0 |
|
| 386 | + * } |
|
| 387 | + * @throws EE_Error |
|
| 388 | + */ |
|
| 389 | + public function script_migrates_to_version($migration_script_name, $eeAddonClass = '') |
|
| 390 | + { |
|
| 391 | + if (isset($this->script_migration_versions[ $migration_script_name ])) { |
|
| 392 | + return $this->script_migration_versions[ $migration_script_name ]; |
|
| 393 | + } |
|
| 394 | + $dms_info = $this->parse_dms_classname($migration_script_name); |
|
| 395 | + $this->script_migration_versions[ $migration_script_name ] = array( |
|
| 396 | + 'slug' => $eeAddonClass !== '' ? $eeAddonClass : $dms_info['slug'], |
|
| 397 | + 'version' => $dms_info['major_version'] . "." . $dms_info['minor_version'] . "." . $dms_info['micro_version'], |
|
| 398 | + ); |
|
| 399 | + return $this->script_migration_versions[ $migration_script_name ]; |
|
| 400 | + } |
|
| 401 | + |
|
| 402 | + /** |
|
| 403 | + * Gets the juicy details out of a dms filename like 'EE_DMS_Core_4_1_0' |
|
| 404 | + * |
|
| 405 | + * @param string $classname |
|
| 406 | + * @return array with keys 'slug','major_version','minor_version', and 'micro_version' (the last 3 are ints) |
|
| 407 | + * @throws EE_Error |
|
| 408 | + */ |
|
| 409 | + public function parse_dms_classname($classname) |
|
| 410 | + { |
|
| 411 | + $matches = array(); |
|
| 412 | + preg_match('~EE_DMS_(.*)_([0-9]*)_([0-9]*)_([0-9]*)~', $classname, $matches); |
|
| 413 | + if (! $matches || ! (isset($matches[1]) && isset($matches[2]) && isset($matches[3]))) { |
|
| 414 | + throw new EE_Error( |
|
| 415 | + sprintf( |
|
| 416 | + __( |
|
| 417 | + "%s is not a valid Data Migration Script. The classname should be like EE_DMS_w_x_y_z, where w is either 'Core' or the slug of an addon and x, y and z are numbers, ", |
|
| 418 | + "event_espresso" |
|
| 419 | + ), |
|
| 420 | + $classname |
|
| 421 | + ) |
|
| 422 | + ); |
|
| 423 | + } |
|
| 424 | + return array( |
|
| 425 | + 'slug' => $matches[1], |
|
| 426 | + 'major_version' => intval($matches[2]), |
|
| 427 | + 'minor_version' => intval($matches[3]), |
|
| 428 | + 'micro_version' => intval($matches[4]), |
|
| 429 | + ); |
|
| 430 | + } |
|
| 431 | + |
|
| 432 | + /** |
|
| 433 | + * Ensures that the option indicating the current DB version is set. This should only be |
|
| 434 | + * a concern when activating EE for the first time, THEORETICALLY. |
|
| 435 | + * If we detect that we're activating EE4 over top of EE3.1, then we set the current db state to 3.1.x, otherwise |
|
| 436 | + * to 4.1.x. |
|
| 437 | + * |
|
| 438 | + * @return string of current db state |
|
| 439 | + */ |
|
| 440 | + public function ensure_current_database_state_is_set() |
|
| 441 | + { |
|
| 442 | + $espresso_db_core_updates = get_option('espresso_db_update', array()); |
|
| 443 | + $db_state = get_option(EE_Data_Migration_Manager::current_database_state); |
|
| 444 | + if (! $db_state) { |
|
| 445 | + // mark the DB as being in the state as the last version in there. |
|
| 446 | + // this is done to trigger maintenance mode and do data migration scripts |
|
| 447 | + // if the admin installed this version of EE over 3.1.x or 4.0.x |
|
| 448 | + // otherwise, the normal maintenance mode code is fine |
|
| 449 | + $previous_versions_installed = array_keys($espresso_db_core_updates); |
|
| 450 | + $previous_version_installed = end($previous_versions_installed); |
|
| 451 | + if (version_compare('4.1.0', $previous_version_installed)) { |
|
| 452 | + // last installed version was less than 4.1 |
|
| 453 | + // so we want the data migrations to happen. SO, we're going to say the DB is at that state |
|
| 454 | + $db_state = array('Core' => $previous_version_installed); |
|
| 455 | + } else { |
|
| 456 | + $db_state = array('Core' => EVENT_ESPRESSO_VERSION); |
|
| 457 | + } |
|
| 458 | + update_option(EE_Data_Migration_Manager::current_database_state, $db_state); |
|
| 459 | + } |
|
| 460 | + // in 4.1, $db_state would have only been a simple string like '4.1.0', |
|
| 461 | + // but in 4.2+ it should be an array with at least key 'Core' and the value of that plugin's |
|
| 462 | + // db, and possibly other keys for other addons like 'Calendar','Permissions',etc |
|
| 463 | + if (! is_array($db_state)) { |
|
| 464 | + $db_state = array('Core' => $db_state); |
|
| 465 | + update_option(EE_Data_Migration_Manager::current_database_state, $db_state); |
|
| 466 | + } |
|
| 467 | + return $db_state; |
|
| 468 | + } |
|
| 469 | + |
|
| 470 | + /** |
|
| 471 | + * Checks if there are any data migration scripts that ought to be run. If found, |
|
| 472 | + * returns the instantiated classes. If none are found (ie, they've all already been run |
|
| 473 | + * or they don't apply), returns an empty array |
|
| 474 | + * |
|
| 475 | + * @return EE_Data_Migration_Script_Base[] |
|
| 476 | + */ |
|
| 477 | + public function check_for_applicable_data_migration_scripts() |
|
| 478 | + { |
|
| 479 | + // get the option describing what options have already run |
|
| 480 | + $scripts_ran = $this->get_data_migrations_ran(); |
|
| 481 | + // $scripts_ran = array('4.1.0.core'=>array('monkey'=>null)); |
|
| 482 | + $script_class_and_filepaths_available = $this->get_all_data_migration_scripts_available(); |
|
| 483 | + |
|
| 484 | + |
|
| 485 | + $current_database_state = $this->ensure_current_database_state_is_set(); |
|
| 486 | + // determine which have already been run |
|
| 487 | + $script_classes_that_should_run_per_iteration = array(); |
|
| 488 | + $iteration = 0; |
|
| 489 | + $next_database_state_to_consider = $current_database_state; |
|
| 490 | + $theoretical_database_state = null; |
|
| 491 | + do { |
|
| 492 | + // the next state after the currently-considered one will start off looking the same as the current, but we may make additions... |
|
| 493 | + $theoretical_database_state = $next_database_state_to_consider; |
|
| 494 | + // the next db state to consider is "what would the DB be like had we run all the scripts we found that applied last time?) |
|
| 495 | + foreach ($script_class_and_filepaths_available as $classname => $filepath) { |
|
| 496 | + $migrates_to_version = $this->script_migrates_to_version($classname); |
|
| 497 | + $script_converts_plugin_slug = $migrates_to_version['slug']; |
|
| 498 | + $script_converts_to_version = $migrates_to_version['version']; |
|
| 499 | + // check if this version script is DONE or not; or if it's never been ran |
|
| 500 | + if (! $scripts_ran || |
|
| 501 | + ! isset($scripts_ran[ $script_converts_plugin_slug ]) || |
|
| 502 | + ! isset($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ])) { |
|
| 503 | + // we haven't ran this conversion script before |
|
| 504 | + // now check if it applies... note that we've added an autoloader for it on get_all_data_migration_scripts_available |
|
| 505 | + $script = new $classname($this->_get_table_manager(), $this->_get_table_analysis()); |
|
| 506 | + /* @var $script EE_Data_Migration_Script_Base */ |
|
| 507 | + $can_migrate = $script->can_migrate_from_version($theoretical_database_state); |
|
| 508 | + if ($can_migrate) { |
|
| 509 | + $script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script; |
|
| 510 | + $migrates_to_version = $script->migrates_to_version(); |
|
| 511 | + $next_database_state_to_consider[ $migrates_to_version['slug'] ] = $migrates_to_version['version']; |
|
| 512 | + unset($script_class_and_filepaths_available[ $classname ]); |
|
| 513 | + } |
|
| 514 | + } elseif ($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ] instanceof EE_Data_Migration_Script_Base) { |
|
| 515 | + // this script has been ran, or at least started |
|
| 516 | + $script = $scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ]; |
|
| 517 | + if ($script->get_status() != self::status_completed) { |
|
| 518 | + // this script is already underway... keep going with it |
|
| 519 | + $script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script; |
|
| 520 | + $migrates_to_version = $script->migrates_to_version(); |
|
| 521 | + $next_database_state_to_consider[ $migrates_to_version['slug'] ] = $migrates_to_version['version']; |
|
| 522 | + unset($script_class_and_filepaths_available[ $classname ]); |
|
| 523 | + } else { |
|
| 524 | + // it must have a status that indicates it has finished, so we don't want to try and run it again |
|
| 525 | + } |
|
| 526 | + } else { |
|
| 527 | + // it exists but it's not a proper data migration script |
|
| 528 | + // maybe the script got renamed? or was simply removed from EE? |
|
| 529 | + // either way, its certainly not runnable! |
|
| 530 | + } |
|
| 531 | + } |
|
| 532 | + $iteration++; |
|
| 533 | + } while ($next_database_state_to_consider != $theoretical_database_state && $iteration < 6); |
|
| 534 | + // ok we have all the scripts that should run, now let's make them into flat array |
|
| 535 | + $scripts_that_should_run = array(); |
|
| 536 | + foreach ($script_classes_that_should_run_per_iteration as $scripts_at_priority) { |
|
| 537 | + ksort($scripts_at_priority); |
|
| 538 | + foreach ($scripts_at_priority as $scripts) { |
|
| 539 | + foreach ($scripts as $script) { |
|
| 540 | + $scripts_that_should_run[ get_class($script) ] = $script; |
|
| 541 | + } |
|
| 542 | + } |
|
| 543 | + } |
|
| 544 | + |
|
| 545 | + do_action( |
|
| 546 | + 'AHEE__EE_Data_Migration_Manager__check_for_applicable_data_migration_scripts__scripts_that_should_run', |
|
| 547 | + $scripts_that_should_run |
|
| 548 | + ); |
|
| 549 | + return $scripts_that_should_run; |
|
| 550 | + } |
|
| 551 | + |
|
| 552 | + |
|
| 553 | + /** |
|
| 554 | + * Gets the script which is currently being ran, if there is one. If $include_completed_scripts is set to TRUE |
|
| 555 | + * it will return the last ran script even if its complete. |
|
| 556 | + * This means: if you want to find the currently-executing script, leave it as FALSE. |
|
| 557 | + * If you really just want to find the script which ran most recently, regardless of status, leave it as TRUE. |
|
| 558 | + * |
|
| 559 | + * @param bool $include_completed_scripts |
|
| 560 | + * @return EE_Data_Migration_Script_Base |
|
| 561 | + */ |
|
| 562 | + public function get_last_ran_script($include_completed_scripts = false) |
|
| 563 | + { |
|
| 564 | + // make sure we've setup the class properties _last_ran_script and _last_ran_incomplete_script |
|
| 565 | + if (! $this->_data_migrations_ran) { |
|
| 566 | + $this->get_data_migrations_ran(); |
|
| 567 | + } |
|
| 568 | + if ($include_completed_scripts) { |
|
| 569 | + return $this->_last_ran_script; |
|
| 570 | + } else { |
|
| 571 | + return $this->_last_ran_incomplete_script; |
|
| 572 | + } |
|
| 573 | + } |
|
| 574 | + |
|
| 575 | + |
|
| 576 | + /** |
|
| 577 | + * Runs the data migration scripts (well, each request to this method calls one of the |
|
| 578 | + * data migration scripts' migration_step() functions). |
|
| 579 | + * |
|
| 580 | + * @param int $step_size |
|
| 581 | + * @throws EE_Error |
|
| 582 | + * @return array { |
|
| 583 | + * // where the first item is one EE_Data_Migration_Script_Base's stati, |
|
| 584 | + * //and the second item is a string describing what was done |
|
| 585 | + * @type int $records_to_migrate from the current migration script |
|
| 586 | + * @type int $records_migrated |
|
| 587 | + * @type string $status one of EE_Data_Migration_Manager::status_* |
|
| 588 | + * @type string $script verbose name of the current DMS |
|
| 589 | + * @type string $message string describing what was done during this step |
|
| 590 | + * } |
|
| 591 | + */ |
|
| 592 | + public function migration_step($step_size = 0) |
|
| 593 | + { |
|
| 594 | + |
|
| 595 | + // bandaid fix for issue https://events.codebasehq.com/projects/event-espresso/tickets/7535 |
|
| 596 | + if (class_exists('EE_CPT_Strategy')) { |
|
| 597 | + remove_action('pre_get_posts', array(EE_CPT_Strategy::instance(), 'pre_get_posts'), 5); |
|
| 598 | + } |
|
| 599 | + |
|
| 600 | + try { |
|
| 601 | + $currently_executing_script = $this->get_last_ran_script(); |
|
| 602 | + if (! $currently_executing_script) { |
|
| 603 | + // Find the next script that needs to execute |
|
| 604 | + $scripts = $this->check_for_applicable_data_migration_scripts(); |
|
| 605 | + if (! $scripts) { |
|
| 606 | + // huh, no more scripts to run... apparently we're done! |
|
| 607 | + // but dont forget to make sure initial data is there |
|
| 608 | + // we should be good to allow them to exit maintenance mode now |
|
| 609 | + EE_Maintenance_Mode::instance()->set_maintenance_level( |
|
| 610 | + intval(EE_Maintenance_Mode::level_0_not_in_maintenance) |
|
| 611 | + ); |
|
| 612 | + // saving migrations ran should actually be unnecessary, but leaving in place just in case |
|
| 613 | + // remember this migration was finished (even if we timeout initing db for core and plugins) |
|
| 614 | + $this->_save_migrations_ran(); |
|
| 615 | + // make sure DB was updated AFTER we've recorded the migration was done |
|
| 616 | + $this->initialize_db_for_enqueued_ee_plugins(); |
|
| 617 | + return array( |
|
| 618 | + 'records_to_migrate' => 1, |
|
| 619 | + 'records_migrated' => 1, |
|
| 620 | + 'status' => self::status_no_more_migration_scripts, |
|
| 621 | + 'script' => __("Data Migration Completed Successfully", "event_espresso"), |
|
| 622 | + 'message' => __("All done!", "event_espresso"), |
|
| 623 | + ); |
|
| 624 | + } |
|
| 625 | + $currently_executing_script = array_shift($scripts); |
|
| 626 | + // and add to the array/wp option showing the scripts ran |
|
| 627 | + |
|
| 628 | + $migrates_to = $this->script_migrates_to_version(get_class($currently_executing_script)); |
|
| 629 | + $plugin_slug = $migrates_to['slug']; |
|
| 630 | + $version = $migrates_to['version']; |
|
| 631 | + $this->_data_migrations_ran[ $plugin_slug ][ $version ] = $currently_executing_script; |
|
| 632 | + } |
|
| 633 | + $current_script_name = get_class($currently_executing_script); |
|
| 634 | + } catch (Exception $e) { |
|
| 635 | + // an exception occurred while trying to get migration scripts |
|
| 636 | + |
|
| 637 | + $message = sprintf( |
|
| 638 | + __("Error Message: %sStack Trace:%s", "event_espresso"), |
|
| 639 | + $e->getMessage() . '<br>', |
|
| 640 | + $e->getTraceAsString() |
|
| 641 | + ); |
|
| 642 | + // record it on the array of data migration scripts ran. This will be overwritten next time we try and try to run data migrations |
|
| 643 | + // but that's ok-- it's just an FYI to support that we couldn't even run any data migrations |
|
| 644 | + $this->add_error_to_migrations_ran( |
|
| 645 | + sprintf(__("Could not run data migrations because: %s", "event_espresso"), $message) |
|
| 646 | + ); |
|
| 647 | + return array( |
|
| 648 | + 'records_to_migrate' => 1, |
|
| 649 | + 'records_migrated' => 0, |
|
| 650 | + 'status' => self::status_fatal_error, |
|
| 651 | + 'script' => __("Error loading data migration scripts", "event_espresso"), |
|
| 652 | + 'message' => $message, |
|
| 653 | + ); |
|
| 654 | + } |
|
| 655 | + // ok so we definitely have a data migration script |
|
| 656 | + try { |
|
| 657 | + // how big of a bite do we want to take? Allow users to easily override via their wp-config |
|
| 658 | + if (absint($step_size) < 1) { |
|
| 659 | + $step_size = defined('EE_MIGRATION_STEP_SIZE') && absint(EE_MIGRATION_STEP_SIZE) |
|
| 660 | + ? EE_MIGRATION_STEP_SIZE : EE_Data_Migration_Manager::step_size; |
|
| 661 | + } |
|
| 662 | + // do what we came to do! |
|
| 663 | + $currently_executing_script->migration_step($step_size); |
|
| 664 | + // can we wrap it up and verify default data? |
|
| 665 | + $init_dbs = false; |
|
| 666 | + switch ($currently_executing_script->get_status()) { |
|
| 667 | + case EE_Data_Migration_Manager::status_continue: |
|
| 668 | + $response_array = array( |
|
| 669 | + 'records_to_migrate' => $currently_executing_script->count_records_to_migrate(), |
|
| 670 | + 'records_migrated' => $currently_executing_script->count_records_migrated(), |
|
| 671 | + 'status' => EE_Data_Migration_Manager::status_continue, |
|
| 672 | + 'message' => $currently_executing_script->get_feedback_message(), |
|
| 673 | + 'script' => $currently_executing_script->pretty_name(), |
|
| 674 | + ); |
|
| 675 | + break; |
|
| 676 | + case EE_Data_Migration_Manager::status_completed: |
|
| 677 | + // ok so THAT script has completed |
|
| 678 | + $this->update_current_database_state_to($this->script_migrates_to_version($current_script_name)); |
|
| 679 | + $response_array = array( |
|
| 680 | + 'records_to_migrate' => $currently_executing_script->count_records_to_migrate(), |
|
| 681 | + 'records_migrated' => $currently_executing_script->count_records_migrated(), |
|
| 682 | + 'status' => EE_Data_Migration_Manager::status_completed, |
|
| 683 | + 'message' => $currently_executing_script->get_feedback_message(), |
|
| 684 | + 'script' => sprintf( |
|
| 685 | + __("%s Completed", 'event_espresso'), |
|
| 686 | + $currently_executing_script->pretty_name() |
|
| 687 | + ), |
|
| 688 | + ); |
|
| 689 | + // check if there are any more after this one. |
|
| 690 | + $scripts_remaining = $this->check_for_applicable_data_migration_scripts(); |
|
| 691 | + if (! $scripts_remaining) { |
|
| 692 | + // we should be good to allow them to exit maintenance mode now |
|
| 693 | + EE_Maintenance_Mode::instance()->set_maintenance_level( |
|
| 694 | + intval(EE_Maintenance_Mode::level_0_not_in_maintenance) |
|
| 695 | + ); |
|
| 696 | + // huh, no more scripts to run... apparently we're done! |
|
| 697 | + // but dont forget to make sure initial data is there |
|
| 698 | + $init_dbs = true; |
|
| 699 | + $response_array['status'] = self::status_no_more_migration_scripts; |
|
| 700 | + } |
|
| 701 | + break; |
|
| 702 | + default: |
|
| 703 | + $response_array = array( |
|
| 704 | + 'records_to_migrate' => $currently_executing_script->count_records_to_migrate(), |
|
| 705 | + 'records_migrated' => $currently_executing_script->count_records_migrated(), |
|
| 706 | + 'status' => $currently_executing_script->get_status(), |
|
| 707 | + 'message' => sprintf( |
|
| 708 | + __("Minor errors occurred during %s: %s", "event_espresso"), |
|
| 709 | + $currently_executing_script->pretty_name(), |
|
| 710 | + implode(", ", $currently_executing_script->get_errors()) |
|
| 711 | + ), |
|
| 712 | + 'script' => $currently_executing_script->pretty_name(), |
|
| 713 | + ); |
|
| 714 | + break; |
|
| 715 | + } |
|
| 716 | + } catch (Exception $e) { |
|
| 717 | + // ok so some exception was thrown which killed the data migration script |
|
| 718 | + // double-check we have a real script |
|
| 719 | + if ($currently_executing_script instanceof EE_Data_Migration_Script_Base) { |
|
| 720 | + $script_name = $currently_executing_script->pretty_name(); |
|
| 721 | + $currently_executing_script->set_broken(); |
|
| 722 | + $currently_executing_script->add_error($e->getMessage()); |
|
| 723 | + } else { |
|
| 724 | + $script_name = __("Error getting Migration Script", "event_espresso"); |
|
| 725 | + } |
|
| 726 | + $response_array = array( |
|
| 727 | + 'records_to_migrate' => 1, |
|
| 728 | + 'records_migrated' => 0, |
|
| 729 | + 'status' => self::status_fatal_error, |
|
| 730 | + 'message' => sprintf( |
|
| 731 | + __("A fatal error occurred during the migration: %s", "event_espresso"), |
|
| 732 | + $e->getMessage() |
|
| 733 | + ), |
|
| 734 | + 'script' => $script_name, |
|
| 735 | + ); |
|
| 736 | + } |
|
| 737 | + $successful_save = $this->_save_migrations_ran(); |
|
| 738 | + if ($successful_save !== true) { |
|
| 739 | + // ok so the current wp option didn't save. that's tricky, because we'd like to update it |
|
| 740 | + // and mark it as having a fatal error, but remember- WE CAN'T SAVE THIS WP OPTION! |
|
| 741 | + // however, if we throw an exception, and return that, then the next request |
|
| 742 | + // won't have as much info in it, and it may be able to save |
|
| 743 | + throw new EE_Error( |
|
| 744 | + sprintf( |
|
| 745 | + __( |
|
| 746 | + "The error '%s' occurred updating the status of the migration. This is a FATAL ERROR, but the error is preventing the system from remembering that. Please contact event espresso support.", |
|
| 747 | + "event_espresso" |
|
| 748 | + ), |
|
| 749 | + $successful_save |
|
| 750 | + ) |
|
| 751 | + ); |
|
| 752 | + } |
|
| 753 | + // if we're all done, initialize EE plugins' default data etc. |
|
| 754 | + if ($init_dbs) { |
|
| 755 | + $this->initialize_db_for_enqueued_ee_plugins(); |
|
| 756 | + } |
|
| 757 | + return $response_array; |
|
| 758 | + } |
|
| 759 | + |
|
| 760 | + |
|
| 761 | + /** |
|
| 762 | + * Echo out JSON response to migration script AJAX requests. Takes precautions |
|
| 763 | + * to buffer output so that we don't throw junk into our json. |
|
| 764 | + * |
|
| 765 | + * @return array with keys: |
|
| 766 | + * 'records_to_migrate' which counts ALL the records for the current migration, and should remain constant. (ie, |
|
| 767 | + * it's NOT the count of hwo many remain) |
|
| 768 | + * 'records_migrated' which also counts ALL the records which have been migrated (ie, percent_complete = |
|
| 769 | + * records_migrated/records_to_migrate) |
|
| 770 | + * 'status'=>a string, one of EE_Data_migration_Manager::status_* |
|
| 771 | + * 'message'=>a string, containing any message you want to show to the user. We may decide to split this up into |
|
| 772 | + * errors, notifications, and successes |
|
| 773 | + * 'script'=>a pretty name of the script currently running |
|
| 774 | + */ |
|
| 775 | + public function response_to_migration_ajax_request() |
|
| 776 | + { |
|
| 777 | + ob_start(); |
|
| 778 | + try { |
|
| 779 | + $response = $this->migration_step(); |
|
| 780 | + } catch (Exception $e) { |
|
| 781 | + $response = array( |
|
| 782 | + 'records_to_migrate' => 0, |
|
| 783 | + 'records_migrated' => 0, |
|
| 784 | + 'status' => EE_Data_Migration_Manager::status_fatal_error, |
|
| 785 | + 'message' => sprintf( |
|
| 786 | + __("Unknown fatal error occurred: %s", "event_espresso"), |
|
| 787 | + $e->getMessage() |
|
| 788 | + ), |
|
| 789 | + 'script' => 'Unknown', |
|
| 790 | + ); |
|
| 791 | + $this->add_error_to_migrations_ran($e->getMessage() . "; Stack trace:" . $e->getTraceAsString()); |
|
| 792 | + } |
|
| 793 | + $warnings_etc = @ob_get_contents(); |
|
| 794 | + ob_end_clean(); |
|
| 795 | + $response['message'] .= $warnings_etc; |
|
| 796 | + return $response; |
|
| 797 | + } |
|
| 798 | + |
|
| 799 | + /** |
|
| 800 | + * Updates the wordpress option that keeps track of which which EE version the database |
|
| 801 | + * is at (ie, the code may be at 4.1.0, but the database is still at 3.1.35) |
|
| 802 | + * |
|
| 803 | + * @param array $slug_and_version { |
|
| 804 | + * @type string $slug like 'Core' or 'Calendar', |
|
| 805 | + * @type string $version like '4.1.0' |
|
| 806 | + * } |
|
| 807 | + * @return void |
|
| 808 | + */ |
|
| 809 | + public function update_current_database_state_to($slug_and_version = null) |
|
| 810 | + { |
|
| 811 | + if (! $slug_and_version) { |
|
| 812 | + // no version was provided, assume it should be at the current code version |
|
| 813 | + $slug_and_version = array('slug' => 'Core', 'version' => espresso_version()); |
|
| 814 | + } |
|
| 815 | + $current_database_state = get_option(self::current_database_state); |
|
| 816 | + $current_database_state[ $slug_and_version['slug'] ] = $slug_and_version['version']; |
|
| 817 | + update_option(self::current_database_state, $current_database_state); |
|
| 818 | + } |
|
| 819 | + |
|
| 820 | + /** |
|
| 821 | + * Determines if the database is currently at a state matching what's indicated in $slug and $version. |
|
| 822 | + * |
|
| 823 | + * @param array $slug_and_version { |
|
| 824 | + * @type string $slug like 'Core' or 'Calendar', |
|
| 825 | + * @type string $version like '4.1.0' |
|
| 826 | + * } |
|
| 827 | + * @return boolean |
|
| 828 | + */ |
|
| 829 | + public function database_needs_updating_to($slug_and_version) |
|
| 830 | + { |
|
| 831 | + |
|
| 832 | + $slug = $slug_and_version['slug']; |
|
| 833 | + $version = $slug_and_version['version']; |
|
| 834 | + $current_database_state = get_option(self::current_database_state); |
|
| 835 | + if (! isset($current_database_state[ $slug ])) { |
|
| 836 | + return true; |
|
| 837 | + } else { |
|
| 838 | + // just compare the first 3 parts of version string, eg "4.7.1", not "4.7.1.dev.032" because DBs shouldn't change on nano version changes |
|
| 839 | + $version_parts_current_db_state = array_slice(explode('.', $current_database_state[ $slug ]), 0, 3); |
|
| 840 | + $version_parts_of_provided_db_state = array_slice(explode('.', $version), 0, 3); |
|
| 841 | + $needs_updating = false; |
|
| 842 | + foreach ($version_parts_current_db_state as $offset => $version_part_in_current_db_state) { |
|
| 843 | + if ($version_part_in_current_db_state < $version_parts_of_provided_db_state[ $offset ]) { |
|
| 844 | + $needs_updating = true; |
|
| 845 | + break; |
|
| 846 | + } |
|
| 847 | + } |
|
| 848 | + return $needs_updating; |
|
| 849 | + } |
|
| 850 | + } |
|
| 851 | + |
|
| 852 | + |
|
| 853 | + /** |
|
| 854 | + * Gets all the data migration scripts available in the core folder and folders |
|
| 855 | + * in addons. Has the side effect of adding them for autoloading |
|
| 856 | + * |
|
| 857 | + * @return array keys are expected classnames, values are their filepaths |
|
| 858 | + * @throws InvalidInterfaceException |
|
| 859 | + * @throws InvalidDataTypeException |
|
| 860 | + * @throws EE_Error |
|
| 861 | + * @throws InvalidArgumentException |
|
| 862 | + */ |
|
| 863 | + public function get_all_data_migration_scripts_available() |
|
| 864 | + { |
|
| 865 | + if (! $this->_data_migration_class_to_filepath_map) { |
|
| 866 | + $this->_data_migration_class_to_filepath_map = array(); |
|
| 867 | + foreach ($this->get_data_migration_script_folders() as $eeAddonClass => $folder_path) { |
|
| 868 | + // strip any placeholders added to classname to make it a unique array key |
|
| 869 | + $eeAddonClass = trim($eeAddonClass, '*'); |
|
| 870 | + $eeAddonClass = $eeAddonClass === 'Core' || class_exists($eeAddonClass) |
|
| 871 | + ? $eeAddonClass |
|
| 872 | + : ''; |
|
| 873 | + $folder_path = EEH_File::end_with_directory_separator($folder_path); |
|
| 874 | + $files = glob($folder_path . '*.dms.php'); |
|
| 875 | + if (empty($files)) { |
|
| 876 | + continue; |
|
| 877 | + } |
|
| 878 | + foreach ($files as $file) { |
|
| 879 | + $pos_of_last_slash = strrpos($file, DS); |
|
| 880 | + $classname = str_replace('.dms.php', '', substr($file, $pos_of_last_slash + 1)); |
|
| 881 | + $migrates_to = $this->script_migrates_to_version($classname, $eeAddonClass); |
|
| 882 | + $slug = $migrates_to['slug']; |
|
| 883 | + // check that the slug as contained in the DMS is associated with |
|
| 884 | + // the slug of an addon or core |
|
| 885 | + if ($slug !== 'Core' && EE_Registry::instance()->get_addon_by_name($slug) === null) { |
|
| 886 | + EE_Error::doing_it_wrong( |
|
| 887 | + __FUNCTION__, |
|
| 888 | + sprintf( |
|
| 889 | + esc_html__( |
|
| 890 | + 'The data migration script "%s" migrates the "%s" data, but there is no EE addon with that name. There is only: %s. ', |
|
| 891 | + 'event_espresso' |
|
| 892 | + ), |
|
| 893 | + $classname, |
|
| 894 | + $slug, |
|
| 895 | + implode(', ', array_keys(EE_Registry::instance()->get_addons_by_name())) |
|
| 896 | + ), |
|
| 897 | + '4.3.0.alpha.019' |
|
| 898 | + ); |
|
| 899 | + } |
|
| 900 | + $this->_data_migration_class_to_filepath_map[ $classname ] = $file; |
|
| 901 | + } |
|
| 902 | + } |
|
| 903 | + EEH_Autoloader::register_autoloader($this->_data_migration_class_to_filepath_map); |
|
| 904 | + } |
|
| 905 | + return $this->_data_migration_class_to_filepath_map; |
|
| 906 | + } |
|
| 907 | + |
|
| 908 | + |
|
| 909 | + /** |
|
| 910 | + * Once we have an addon that works with EE4.1, we will actually want to fetch the PUE slugs |
|
| 911 | + * from each addon, and check if they need updating, |
|
| 912 | + * |
|
| 913 | + * @return boolean |
|
| 914 | + */ |
|
| 915 | + public function addons_need_updating() |
|
| 916 | + { |
|
| 917 | + return false; |
|
| 918 | + } |
|
| 919 | + |
|
| 920 | + /** |
|
| 921 | + * Adds this error string to the data_migrations_ran array, but we dont necessarily know |
|
| 922 | + * where to put it, so we just throw it in there... better than nothing... |
|
| 923 | + * |
|
| 924 | + * @param string $error_message |
|
| 925 | + * @throws EE_Error |
|
| 926 | + */ |
|
| 927 | + public function add_error_to_migrations_ran($error_message) |
|
| 928 | + { |
|
| 929 | + // get last-ran migration script |
|
| 930 | + global $wpdb; |
|
| 931 | + $last_migration_script_option = $wpdb->get_row( |
|
| 932 | + "SELECT * FROM $wpdb->options WHERE option_name like '" . EE_Data_Migration_Manager::data_migration_script_option_prefix . "%' ORDER BY option_id DESC LIMIT 1", |
|
| 933 | + ARRAY_A |
|
| 934 | + ); |
|
| 935 | + |
|
| 936 | + $last_ran_migration_script_properties = isset($last_migration_script_option['option_value']) |
|
| 937 | + ? maybe_unserialize($last_migration_script_option['option_value']) : null; |
|
| 938 | + // now, tread lightly because we're here because a FATAL non-catchable error |
|
| 939 | + // was thrown last time when we were trying to run a data migration script |
|
| 940 | + // so the fatal error could have happened while getting the migration script |
|
| 941 | + // or doing running it... |
|
| 942 | + $versions_migrated_to = isset($last_migration_script_option['option_name']) ? str_replace( |
|
| 943 | + EE_Data_Migration_Manager::data_migration_script_option_prefix, |
|
| 944 | + "", |
|
| 945 | + $last_migration_script_option['option_name'] |
|
| 946 | + ) : null; |
|
| 947 | + |
|
| 948 | + // check if it THINKS its a data migration script and especially if it's one that HASN'T finished yet |
|
| 949 | + // because if it has finished, then it obviously couldn't be the cause of this error, right? (because its all done) |
|
| 950 | + if (isset($last_ran_migration_script_properties['class']) && isset($last_ran_migration_script_properties['_status']) && $last_ran_migration_script_properties['_status'] != self::status_completed) { |
|
| 951 | + // ok then just add this error to its list of errors |
|
| 952 | + $last_ran_migration_script_properties['_errors'][] = $error_message; |
|
| 953 | + $last_ran_migration_script_properties['_status'] = self::status_fatal_error; |
|
| 954 | + } else { |
|
| 955 | + // so we don't even know which script was last running |
|
| 956 | + // use the data migration error stub, which is designed specifically for this type of thing |
|
| 957 | + $general_migration_error = new EE_DMS_Unknown_1_0_0(); |
|
| 958 | + $general_migration_error->add_error($error_message); |
|
| 959 | + $general_migration_error->set_broken(); |
|
| 960 | + $last_ran_migration_script_properties = $general_migration_error->properties_as_array(); |
|
| 961 | + $versions_migrated_to = 'Unknown.1.0.0'; |
|
| 962 | + // now just to make sure appears as last (in case the were previously a fatal error like this) |
|
| 963 | + // delete the old one |
|
| 964 | + delete_option(self::data_migration_script_option_prefix . $versions_migrated_to); |
|
| 965 | + } |
|
| 966 | + update_option( |
|
| 967 | + self::data_migration_script_option_prefix . $versions_migrated_to, |
|
| 968 | + $last_ran_migration_script_properties |
|
| 969 | + ); |
|
| 970 | + } |
|
| 971 | + |
|
| 972 | + /** |
|
| 973 | + * saves what data migrations have ran to the database |
|
| 974 | + * |
|
| 975 | + * @return mixed TRUE if successfully saved migrations ran, string if an error occurred |
|
| 976 | + */ |
|
| 977 | + protected function _save_migrations_ran() |
|
| 978 | + { |
|
| 979 | + if ($this->_data_migrations_ran == null) { |
|
| 980 | + $this->get_data_migrations_ran(); |
|
| 981 | + } |
|
| 982 | + // now, we don't want to save actual classes to the DB because that's messy |
|
| 983 | + $successful_updates = true; |
|
| 984 | + foreach ($this->_data_migrations_ran as $plugin_slug => $migrations_ran_for_plugin) { |
|
| 985 | + foreach ($migrations_ran_for_plugin as $version_string => $array_or_migration_obj) { |
|
| 986 | + $plugin_slug_for_use_in_option_name = $plugin_slug . "."; |
|
| 987 | + $option_name = self::data_migration_script_option_prefix . $plugin_slug_for_use_in_option_name . $version_string; |
|
| 988 | + $old_option_value = get_option($option_name); |
|
| 989 | + if ($array_or_migration_obj instanceof EE_Data_Migration_Script_Base) { |
|
| 990 | + $script_array_for_saving = $array_or_migration_obj->properties_as_array(); |
|
| 991 | + if ($old_option_value != $script_array_for_saving) { |
|
| 992 | + $successful_updates = update_option($option_name, $script_array_for_saving); |
|
| 993 | + } |
|
| 994 | + } else {// we don't know what this array-thing is. So just save it as-is |
|
| 995 | + if ($old_option_value != $array_or_migration_obj) { |
|
| 996 | + $successful_updates = update_option($option_name, $array_or_migration_obj); |
|
| 997 | + } |
|
| 998 | + } |
|
| 999 | + if (! $successful_updates) { |
|
| 1000 | + global $wpdb; |
|
| 1001 | + return $wpdb->last_error; |
|
| 1002 | + } |
|
| 1003 | + } |
|
| 1004 | + } |
|
| 1005 | + return true; |
|
| 1006 | + // $updated = update_option(self::data_migrations_option_name, $array_of_migrations); |
|
| 1007 | + // if ($updated !== true) { |
|
| 1008 | + // global $wpdb; |
|
| 1009 | + // return $wpdb->last_error; |
|
| 1010 | + // } else { |
|
| 1011 | + // return true; |
|
| 1012 | + // } |
|
| 1013 | + // wp_mail( |
|
| 1014 | + // "[email protected]", |
|
| 1015 | + // time() . " price debug info", |
|
| 1016 | + // "updated: $updated, last error: $last_error, byte length of option: " . strlen( |
|
| 1017 | + // serialize($array_of_migrations) |
|
| 1018 | + // ) |
|
| 1019 | + // ); |
|
| 1020 | + } |
|
| 1021 | + |
|
| 1022 | + /** |
|
| 1023 | + * Takes an array of data migration script properties and re-creates the class from |
|
| 1024 | + * them. The argument $properties_array is assumed to have been made by |
|
| 1025 | + * EE_Data_Migration_Script_Base::properties_as_array() |
|
| 1026 | + * |
|
| 1027 | + * @param array $properties_array |
|
| 1028 | + * @return EE_Data_Migration_Script_Base |
|
| 1029 | + * @throws EE_Error |
|
| 1030 | + */ |
|
| 1031 | + public function _instantiate_script_from_properties_array($properties_array) |
|
| 1032 | + { |
|
| 1033 | + if (! isset($properties_array['class'])) { |
|
| 1034 | + throw new EE_Error( |
|
| 1035 | + sprintf( |
|
| 1036 | + __("Properties array has no 'class' properties. Here's what it has: %s", "event_espresso"), |
|
| 1037 | + implode(",", $properties_array) |
|
| 1038 | + ) |
|
| 1039 | + ); |
|
| 1040 | + } |
|
| 1041 | + $class_name = $properties_array['class']; |
|
| 1042 | + if (! class_exists($class_name)) { |
|
| 1043 | + throw new EE_Error(sprintf(__("There is no migration script named %s", "event_espresso"), $class_name)); |
|
| 1044 | + } |
|
| 1045 | + $class = new $class_name; |
|
| 1046 | + if (! $class instanceof EE_Data_Migration_Script_Base) { |
|
| 1047 | + throw new EE_Error( |
|
| 1048 | + sprintf( |
|
| 1049 | + __("Class '%s' is supposed to be a migration script. Its not, its a '%s'", "event_espresso"), |
|
| 1050 | + $class_name, |
|
| 1051 | + get_class($class) |
|
| 1052 | + ) |
|
| 1053 | + ); |
|
| 1054 | + } |
|
| 1055 | + $class->instantiate_from_array_of_properties($properties_array); |
|
| 1056 | + return $class; |
|
| 1057 | + } |
|
| 1058 | + |
|
| 1059 | + /** |
|
| 1060 | + * Gets the classname for the most up-to-date DMS (ie, the one that will finally |
|
| 1061 | + * leave the DB in a state usable by the current plugin code). |
|
| 1062 | + * |
|
| 1063 | + * @param string $plugin_slug the slug for the ee plugin we are searching for. Default is 'Core' |
|
| 1064 | + * @return string |
|
| 1065 | + */ |
|
| 1066 | + public function get_most_up_to_date_dms($plugin_slug = 'Core') |
|
| 1067 | + { |
|
| 1068 | + $class_to_filepath_map = $this->get_all_data_migration_scripts_available(); |
|
| 1069 | + $most_up_to_date_dms_classname = null; |
|
| 1070 | + foreach ($class_to_filepath_map as $classname => $filepath) { |
|
| 1071 | + if ($most_up_to_date_dms_classname === null) { |
|
| 1072 | + $migrates_to = $this->script_migrates_to_version($classname); |
|
| 1073 | + $this_plugin_slug = $migrates_to['slug']; |
|
| 1074 | + if ($this_plugin_slug == $plugin_slug) { |
|
| 1075 | + // if it's for core, it wins |
|
| 1076 | + $most_up_to_date_dms_classname = $classname; |
|
| 1077 | + } |
|
| 1078 | + // if it wasn't for core, we must keep searching for one that is! |
|
| 1079 | + continue; |
|
| 1080 | + } else { |
|
| 1081 | + $champion_migrates_to = $this->script_migrates_to_version($most_up_to_date_dms_classname); |
|
| 1082 | + $contender_migrates_to = $this->script_migrates_to_version($classname); |
|
| 1083 | + if ($contender_migrates_to['slug'] == $plugin_slug |
|
| 1084 | + && version_compare( |
|
| 1085 | + $champion_migrates_to['version'], |
|
| 1086 | + $contender_migrates_to['version'], |
|
| 1087 | + '<' |
|
| 1088 | + )) { |
|
| 1089 | + // so the contenders version is higher and its for Core |
|
| 1090 | + $most_up_to_date_dms_classname = $classname; |
|
| 1091 | + } |
|
| 1092 | + } |
|
| 1093 | + } |
|
| 1094 | + return $most_up_to_date_dms_classname; |
|
| 1095 | + } |
|
| 1096 | + |
|
| 1097 | + /** |
|
| 1098 | + * Gets the migration script specified but ONLY if it has already ran. |
|
| 1099 | + * |
|
| 1100 | + * Eg, if you wanted to see if 'EE_DMS_Core_4_1_0' has ran, you would run the following code: |
|
| 1101 | + * <code> $core_4_1_0_dms_ran = EE_Data_Migration_Manager::instance()->get_migration_ran( '4.1.0', 'Core' ) !== |
|
| 1102 | + * NULL;</code> This is especially useful in addons' data migration scripts, this way they can tell if a core (or |
|
| 1103 | + * other addon) DMS has ran, in case the current DMS depends on it. |
|
| 1104 | + * |
|
| 1105 | + * @param string $version the version the DMS searched for migrates to. Usually just the content before the 3rd |
|
| 1106 | + * period. Eg '4.1.0' |
|
| 1107 | + * @param string $plugin_slug like 'Core', 'Mailchimp', 'Calendar', etc |
|
| 1108 | + * @return EE_Data_Migration_Script_Base |
|
| 1109 | + */ |
|
| 1110 | + public function get_migration_ran($version, $plugin_slug = 'Core') |
|
| 1111 | + { |
|
| 1112 | + $migrations_ran = $this->get_data_migrations_ran(); |
|
| 1113 | + if (isset($migrations_ran[ $plugin_slug ]) && isset($migrations_ran[ $plugin_slug ][ $version ])) { |
|
| 1114 | + return $migrations_ran[ $plugin_slug ][ $version ]; |
|
| 1115 | + } else { |
|
| 1116 | + return null; |
|
| 1117 | + } |
|
| 1118 | + } |
|
| 1119 | + |
|
| 1120 | + /** |
|
| 1121 | + * Resets the borked data migration scripts so they're no longer borked |
|
| 1122 | + * so we can again attempt to migrate |
|
| 1123 | + * |
|
| 1124 | + * @return bool |
|
| 1125 | + * @throws EE_Error |
|
| 1126 | + */ |
|
| 1127 | + public function reattempt() |
|
| 1128 | + { |
|
| 1129 | + // find if the last-ran script was borked |
|
| 1130 | + // set it as being non-borked (we shouldn't ever get DMSs that we don't recognize) |
|
| 1131 | + // add an 'error' saying that we attempted to reset |
|
| 1132 | + // does it have a stage that was borked too? if so make it no longer borked |
|
| 1133 | + // add an 'error' saying we attempted to reset |
|
| 1134 | + $last_ran_script = $this->get_last_ran_script(); |
|
| 1135 | + if ($last_ran_script instanceof EE_DMS_Unknown_1_0_0) { |
|
| 1136 | + // if it was an error DMS, just mark it as complete (if another error occurs it will overwrite it) |
|
| 1137 | + $last_ran_script->set_completed(); |
|
| 1138 | + } elseif ($last_ran_script instanceof EE_Data_Migration_Script_Base) { |
|
| 1139 | + $last_ran_script->reattempt(); |
|
| 1140 | + } else { |
|
| 1141 | + throw new EE_Error( |
|
| 1142 | + sprintf( |
|
| 1143 | + __( |
|
| 1144 | + 'Unable to reattempt the last ran migration script because it was not a valid migration script. || It was %s', |
|
| 1145 | + 'event_espresso' |
|
| 1146 | + ), |
|
| 1147 | + print_r($last_ran_script, true) |
|
| 1148 | + ) |
|
| 1149 | + ); |
|
| 1150 | + } |
|
| 1151 | + return $this->_save_migrations_ran(); |
|
| 1152 | + } |
|
| 1153 | + |
|
| 1154 | + /** |
|
| 1155 | + * Gets whether or not this particular migration has run or not |
|
| 1156 | + * |
|
| 1157 | + * @param string $version the version the DMS searched for migrates to. Usually just the content before the 3rd |
|
| 1158 | + * period. Eg '4.1.0' |
|
| 1159 | + * @param string $plugin_slug like 'Core', 'Mailchimp', 'Calendar', etc |
|
| 1160 | + * @return boolean |
|
| 1161 | + */ |
|
| 1162 | + public function migration_has_ran($version, $plugin_slug = 'Core') |
|
| 1163 | + { |
|
| 1164 | + return $this->get_migration_ran($version, $plugin_slug) !== null; |
|
| 1165 | + } |
|
| 1166 | + |
|
| 1167 | + /** |
|
| 1168 | + * Enqueues this ee plugin to have its data initialized |
|
| 1169 | + * |
|
| 1170 | + * @param string $plugin_slug either 'Core' or EE_Addon::name()'s return value |
|
| 1171 | + */ |
|
| 1172 | + public function enqueue_db_initialization_for($plugin_slug) |
|
| 1173 | + { |
|
| 1174 | + $queue = $this->get_db_initialization_queue(); |
|
| 1175 | + if (! in_array($plugin_slug, $queue)) { |
|
| 1176 | + $queue[] = $plugin_slug; |
|
| 1177 | + } |
|
| 1178 | + update_option(self::db_init_queue_option_name, $queue); |
|
| 1179 | + } |
|
| 1180 | + |
|
| 1181 | + /** |
|
| 1182 | + * Calls EE_Addon::initialize_db_if_no_migrations_required() on each addon |
|
| 1183 | + * specified in EE_Data_Migration_Manager::get_db_init_queue(), and if 'Core' is |
|
| 1184 | + * in the queue, calls EE_System::initialize_db_if_no_migrations_required(). |
|
| 1185 | + */ |
|
| 1186 | + public function initialize_db_for_enqueued_ee_plugins() |
|
| 1187 | + { |
|
| 1188 | + $queue = $this->get_db_initialization_queue(); |
|
| 1189 | + foreach ($queue as $plugin_slug) { |
|
| 1190 | + $most_up_to_date_dms = $this->get_most_up_to_date_dms($plugin_slug); |
|
| 1191 | + if (! $most_up_to_date_dms) { |
|
| 1192 | + // if there is NO DMS for this plugin, obviously there's no schema to verify anyways |
|
| 1193 | + $verify_db = false; |
|
| 1194 | + } else { |
|
| 1195 | + $most_up_to_date_dms_migrates_to = $this->script_migrates_to_version($most_up_to_date_dms); |
|
| 1196 | + $verify_db = $this->database_needs_updating_to($most_up_to_date_dms_migrates_to); |
|
| 1197 | + } |
|
| 1198 | + if ($plugin_slug == 'Core') { |
|
| 1199 | + EE_System::instance()->initialize_db_if_no_migrations_required( |
|
| 1200 | + false, |
|
| 1201 | + $verify_db |
|
| 1202 | + ); |
|
| 1203 | + } else { |
|
| 1204 | + // just loop through the addons to make sure their database is setup |
|
| 1205 | + foreach (EE_Registry::instance()->addons as $addon) { |
|
| 1206 | + if ($addon->name() == $plugin_slug) { |
|
| 1207 | + $addon->initialize_db_if_no_migrations_required($verify_db); |
|
| 1208 | + break; |
|
| 1209 | + } |
|
| 1210 | + } |
|
| 1211 | + } |
|
| 1212 | + } |
|
| 1213 | + // because we just initialized the DBs for the enqueued ee plugins |
|
| 1214 | + // we don't need to keep remembering which ones needed to be initialized |
|
| 1215 | + delete_option(self::db_init_queue_option_name); |
|
| 1216 | + } |
|
| 1217 | + |
|
| 1218 | + /** |
|
| 1219 | + * Gets a numerically-indexed array of plugin slugs that need to have their databases |
|
| 1220 | + * (re-)initialized after migrations are complete. ie, each element should be either |
|
| 1221 | + * 'Core', or the return value of EE_Addon::name() for an addon |
|
| 1222 | + * |
|
| 1223 | + * @return array |
|
| 1224 | + */ |
|
| 1225 | + public function get_db_initialization_queue() |
|
| 1226 | + { |
|
| 1227 | + return get_option(self::db_init_queue_option_name, array()); |
|
| 1228 | + } |
|
| 1229 | + |
|
| 1230 | + /** |
|
| 1231 | + * Gets the injected table analyzer, or throws an exception |
|
| 1232 | + * |
|
| 1233 | + * @return TableAnalysis |
|
| 1234 | + * @throws EE_Error |
|
| 1235 | + */ |
|
| 1236 | + protected function _get_table_analysis() |
|
| 1237 | + { |
|
| 1238 | + if ($this->_table_analysis instanceof TableAnalysis) { |
|
| 1239 | + return $this->_table_analysis; |
|
| 1240 | + } else { |
|
| 1241 | + throw new EE_Error( |
|
| 1242 | + sprintf( |
|
| 1243 | + __('Table analysis class on class %1$s is not set properly.', 'event_espresso'), |
|
| 1244 | + get_class($this) |
|
| 1245 | + ) |
|
| 1246 | + ); |
|
| 1247 | + } |
|
| 1248 | + } |
|
| 1249 | + |
|
| 1250 | + /** |
|
| 1251 | + * Gets the injected table manager, or throws an exception |
|
| 1252 | + * |
|
| 1253 | + * @return TableManager |
|
| 1254 | + * @throws EE_Error |
|
| 1255 | + */ |
|
| 1256 | + protected function _get_table_manager() |
|
| 1257 | + { |
|
| 1258 | + if ($this->_table_manager instanceof TableManager) { |
|
| 1259 | + return $this->_table_manager; |
|
| 1260 | + } else { |
|
| 1261 | + throw new EE_Error( |
|
| 1262 | + sprintf( |
|
| 1263 | + __('Table manager class on class %1$s is not set properly.', 'event_espresso'), |
|
| 1264 | + get_class($this) |
|
| 1265 | + ) |
|
| 1266 | + ); |
|
| 1267 | + } |
|
| 1268 | + } |
|
| 1269 | 1269 | } |
@@ -157,7 +157,7 @@ discard block |
||
| 157 | 157 | public static function instance() |
| 158 | 158 | { |
| 159 | 159 | // check if class object is instantiated |
| 160 | - if (! self::$_instance instanceof EE_Data_Migration_Manager) { |
|
| 160 | + if ( ! self::$_instance instanceof EE_Data_Migration_Manager) { |
|
| 161 | 161 | self::$_instance = new self(); |
| 162 | 162 | } |
| 163 | 163 | return self::$_instance; |
@@ -233,12 +233,12 @@ discard block |
||
| 233 | 233 | |
| 234 | 234 | if (count($parts) == 4) { |
| 235 | 235 | // it's 4.2-style.eg Core.4.1.0 |
| 236 | - $plugin_slug = $parts[0];// eg Core |
|
| 237 | - $version_string = $parts[1] . "." . $parts[2] . "." . $parts[3]; // eg 4.1.0 |
|
| 236 | + $plugin_slug = $parts[0]; // eg Core |
|
| 237 | + $version_string = $parts[1].".".$parts[2].".".$parts[3]; // eg 4.1.0 |
|
| 238 | 238 | } else { |
| 239 | 239 | // it's 4.1-style: eg 4.1.0 |
| 240 | 240 | $plugin_slug = 'Core'; |
| 241 | - $version_string = $plugin_slug_and_version_string;// eg 4.1.0 |
|
| 241 | + $version_string = $plugin_slug_and_version_string; // eg 4.1.0 |
|
| 242 | 242 | } |
| 243 | 243 | return array($plugin_slug, $version_string); |
| 244 | 244 | } |
@@ -290,11 +290,11 @@ discard block |
||
| 290 | 290 | */ |
| 291 | 291 | public function get_data_migrations_ran() |
| 292 | 292 | { |
| 293 | - if (! $this->_data_migrations_ran) { |
|
| 293 | + if ( ! $this->_data_migrations_ran) { |
|
| 294 | 294 | // setup autoloaders for each of the scripts in there |
| 295 | 295 | $this->get_all_data_migration_scripts_available(); |
| 296 | 296 | $data_migrations_options = $this->get_all_migration_script_options( |
| 297 | - );// get_option(EE_Data_Migration_Manager::data_migrations_option_name,get_option('espresso_data_migrations',array())); |
|
| 297 | + ); // get_option(EE_Data_Migration_Manager::data_migrations_option_name,get_option('espresso_data_migrations',array())); |
|
| 298 | 298 | |
| 299 | 299 | $data_migrations_ran = array(); |
| 300 | 300 | // convert into data migration script classes where possible |
@@ -308,23 +308,23 @@ discard block |
||
| 308 | 308 | $data_migration_option['option_name'], |
| 309 | 309 | $data_migration_option['option_value'] |
| 310 | 310 | ); |
| 311 | - $data_migrations_ran[ $plugin_slug ][ $version_string ] = $class; |
|
| 311 | + $data_migrations_ran[$plugin_slug][$version_string] = $class; |
|
| 312 | 312 | // ok so far THIS is the 'last-ran-script'... unless we find another on next iteration |
| 313 | 313 | $this->_last_ran_script = $class; |
| 314 | - if (! $class->is_completed()) { |
|
| 314 | + if ( ! $class->is_completed()) { |
|
| 315 | 315 | // sometimes we also like to know which was the last incomplete script (or if there are any at all) |
| 316 | 316 | $this->_last_ran_incomplete_script = $class; |
| 317 | 317 | } |
| 318 | 318 | } catch (EE_Error $e) { |
| 319 | 319 | // ok so its not a DMS. We'll just keep it, although other code will need to expect non-DMSs |
| 320 | - $data_migrations_ran[ $plugin_slug ][ $version_string ] = maybe_unserialize( |
|
| 320 | + $data_migrations_ran[$plugin_slug][$version_string] = maybe_unserialize( |
|
| 321 | 321 | $data_migration_option['option_value'] |
| 322 | 322 | ); |
| 323 | 323 | } |
| 324 | 324 | } |
| 325 | 325 | // so here the array of $data_migrations_ran is actually a mix of classes and a few legacy arrays |
| 326 | 326 | $this->_data_migrations_ran = $data_migrations_ran; |
| 327 | - if (! $this->_data_migrations_ran || ! is_array($this->_data_migrations_ran)) { |
|
| 327 | + if ( ! $this->_data_migrations_ran || ! is_array($this->_data_migrations_ran)) { |
|
| 328 | 328 | $this->_data_migrations_ran = array(); |
| 329 | 329 | } |
| 330 | 330 | } |
@@ -357,7 +357,7 @@ discard block |
||
| 357 | 357 | { |
| 358 | 358 | global $wpdb; |
| 359 | 359 | return $wpdb->get_results( |
| 360 | - "SELECT * FROM {$wpdb->options} WHERE option_name like '" . EE_Data_Migration_Manager::data_migration_script_option_prefix . "%' ORDER BY option_id ASC", |
|
| 360 | + "SELECT * FROM {$wpdb->options} WHERE option_name like '".EE_Data_Migration_Manager::data_migration_script_option_prefix."%' ORDER BY option_id ASC", |
|
| 361 | 361 | ARRAY_A |
| 362 | 362 | ); |
| 363 | 363 | } |
@@ -372,7 +372,7 @@ discard block |
||
| 372 | 372 | { |
| 373 | 373 | return apply_filters( |
| 374 | 374 | 'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders', |
| 375 | - array('Core' => EE_CORE . 'data_migration_scripts') |
|
| 375 | + array('Core' => EE_CORE.'data_migration_scripts') |
|
| 376 | 376 | ); |
| 377 | 377 | } |
| 378 | 378 | |
@@ -388,15 +388,15 @@ discard block |
||
| 388 | 388 | */ |
| 389 | 389 | public function script_migrates_to_version($migration_script_name, $eeAddonClass = '') |
| 390 | 390 | { |
| 391 | - if (isset($this->script_migration_versions[ $migration_script_name ])) { |
|
| 392 | - return $this->script_migration_versions[ $migration_script_name ]; |
|
| 391 | + if (isset($this->script_migration_versions[$migration_script_name])) { |
|
| 392 | + return $this->script_migration_versions[$migration_script_name]; |
|
| 393 | 393 | } |
| 394 | 394 | $dms_info = $this->parse_dms_classname($migration_script_name); |
| 395 | - $this->script_migration_versions[ $migration_script_name ] = array( |
|
| 395 | + $this->script_migration_versions[$migration_script_name] = array( |
|
| 396 | 396 | 'slug' => $eeAddonClass !== '' ? $eeAddonClass : $dms_info['slug'], |
| 397 | - 'version' => $dms_info['major_version'] . "." . $dms_info['minor_version'] . "." . $dms_info['micro_version'], |
|
| 397 | + 'version' => $dms_info['major_version'].".".$dms_info['minor_version'].".".$dms_info['micro_version'], |
|
| 398 | 398 | ); |
| 399 | - return $this->script_migration_versions[ $migration_script_name ]; |
|
| 399 | + return $this->script_migration_versions[$migration_script_name]; |
|
| 400 | 400 | } |
| 401 | 401 | |
| 402 | 402 | /** |
@@ -410,7 +410,7 @@ discard block |
||
| 410 | 410 | { |
| 411 | 411 | $matches = array(); |
| 412 | 412 | preg_match('~EE_DMS_(.*)_([0-9]*)_([0-9]*)_([0-9]*)~', $classname, $matches); |
| 413 | - if (! $matches || ! (isset($matches[1]) && isset($matches[2]) && isset($matches[3]))) { |
|
| 413 | + if ( ! $matches || ! (isset($matches[1]) && isset($matches[2]) && isset($matches[3]))) { |
|
| 414 | 414 | throw new EE_Error( |
| 415 | 415 | sprintf( |
| 416 | 416 | __( |
@@ -441,7 +441,7 @@ discard block |
||
| 441 | 441 | { |
| 442 | 442 | $espresso_db_core_updates = get_option('espresso_db_update', array()); |
| 443 | 443 | $db_state = get_option(EE_Data_Migration_Manager::current_database_state); |
| 444 | - if (! $db_state) { |
|
| 444 | + if ( ! $db_state) { |
|
| 445 | 445 | // mark the DB as being in the state as the last version in there. |
| 446 | 446 | // this is done to trigger maintenance mode and do data migration scripts |
| 447 | 447 | // if the admin installed this version of EE over 3.1.x or 4.0.x |
@@ -460,7 +460,7 @@ discard block |
||
| 460 | 460 | // in 4.1, $db_state would have only been a simple string like '4.1.0', |
| 461 | 461 | // but in 4.2+ it should be an array with at least key 'Core' and the value of that plugin's |
| 462 | 462 | // db, and possibly other keys for other addons like 'Calendar','Permissions',etc |
| 463 | - if (! is_array($db_state)) { |
|
| 463 | + if ( ! is_array($db_state)) { |
|
| 464 | 464 | $db_state = array('Core' => $db_state); |
| 465 | 465 | update_option(EE_Data_Migration_Manager::current_database_state, $db_state); |
| 466 | 466 | } |
@@ -497,29 +497,29 @@ discard block |
||
| 497 | 497 | $script_converts_plugin_slug = $migrates_to_version['slug']; |
| 498 | 498 | $script_converts_to_version = $migrates_to_version['version']; |
| 499 | 499 | // check if this version script is DONE or not; or if it's never been ran |
| 500 | - if (! $scripts_ran || |
|
| 501 | - ! isset($scripts_ran[ $script_converts_plugin_slug ]) || |
|
| 502 | - ! isset($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ])) { |
|
| 500 | + if ( ! $scripts_ran || |
|
| 501 | + ! isset($scripts_ran[$script_converts_plugin_slug]) || |
|
| 502 | + ! isset($scripts_ran[$script_converts_plugin_slug][$script_converts_to_version])) { |
|
| 503 | 503 | // we haven't ran this conversion script before |
| 504 | 504 | // now check if it applies... note that we've added an autoloader for it on get_all_data_migration_scripts_available |
| 505 | 505 | $script = new $classname($this->_get_table_manager(), $this->_get_table_analysis()); |
| 506 | 506 | /* @var $script EE_Data_Migration_Script_Base */ |
| 507 | 507 | $can_migrate = $script->can_migrate_from_version($theoretical_database_state); |
| 508 | 508 | if ($can_migrate) { |
| 509 | - $script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script; |
|
| 509 | + $script_classes_that_should_run_per_iteration[$iteration][$script->priority()][] = $script; |
|
| 510 | 510 | $migrates_to_version = $script->migrates_to_version(); |
| 511 | - $next_database_state_to_consider[ $migrates_to_version['slug'] ] = $migrates_to_version['version']; |
|
| 512 | - unset($script_class_and_filepaths_available[ $classname ]); |
|
| 511 | + $next_database_state_to_consider[$migrates_to_version['slug']] = $migrates_to_version['version']; |
|
| 512 | + unset($script_class_and_filepaths_available[$classname]); |
|
| 513 | 513 | } |
| 514 | - } elseif ($scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ] instanceof EE_Data_Migration_Script_Base) { |
|
| 514 | + } elseif ($scripts_ran[$script_converts_plugin_slug][$script_converts_to_version] instanceof EE_Data_Migration_Script_Base) { |
|
| 515 | 515 | // this script has been ran, or at least started |
| 516 | - $script = $scripts_ran[ $script_converts_plugin_slug ][ $script_converts_to_version ]; |
|
| 516 | + $script = $scripts_ran[$script_converts_plugin_slug][$script_converts_to_version]; |
|
| 517 | 517 | if ($script->get_status() != self::status_completed) { |
| 518 | 518 | // this script is already underway... keep going with it |
| 519 | - $script_classes_that_should_run_per_iteration[ $iteration ][ $script->priority() ][] = $script; |
|
| 519 | + $script_classes_that_should_run_per_iteration[$iteration][$script->priority()][] = $script; |
|
| 520 | 520 | $migrates_to_version = $script->migrates_to_version(); |
| 521 | - $next_database_state_to_consider[ $migrates_to_version['slug'] ] = $migrates_to_version['version']; |
|
| 522 | - unset($script_class_and_filepaths_available[ $classname ]); |
|
| 521 | + $next_database_state_to_consider[$migrates_to_version['slug']] = $migrates_to_version['version']; |
|
| 522 | + unset($script_class_and_filepaths_available[$classname]); |
|
| 523 | 523 | } else { |
| 524 | 524 | // it must have a status that indicates it has finished, so we don't want to try and run it again |
| 525 | 525 | } |
@@ -530,14 +530,14 @@ discard block |
||
| 530 | 530 | } |
| 531 | 531 | } |
| 532 | 532 | $iteration++; |
| 533 | - } while ($next_database_state_to_consider != $theoretical_database_state && $iteration < 6); |
|
| 533 | + }while ($next_database_state_to_consider != $theoretical_database_state && $iteration < 6); |
|
| 534 | 534 | // ok we have all the scripts that should run, now let's make them into flat array |
| 535 | 535 | $scripts_that_should_run = array(); |
| 536 | 536 | foreach ($script_classes_that_should_run_per_iteration as $scripts_at_priority) { |
| 537 | 537 | ksort($scripts_at_priority); |
| 538 | 538 | foreach ($scripts_at_priority as $scripts) { |
| 539 | 539 | foreach ($scripts as $script) { |
| 540 | - $scripts_that_should_run[ get_class($script) ] = $script; |
|
| 540 | + $scripts_that_should_run[get_class($script)] = $script; |
|
| 541 | 541 | } |
| 542 | 542 | } |
| 543 | 543 | } |
@@ -562,7 +562,7 @@ discard block |
||
| 562 | 562 | public function get_last_ran_script($include_completed_scripts = false) |
| 563 | 563 | { |
| 564 | 564 | // make sure we've setup the class properties _last_ran_script and _last_ran_incomplete_script |
| 565 | - if (! $this->_data_migrations_ran) { |
|
| 565 | + if ( ! $this->_data_migrations_ran) { |
|
| 566 | 566 | $this->get_data_migrations_ran(); |
| 567 | 567 | } |
| 568 | 568 | if ($include_completed_scripts) { |
@@ -599,10 +599,10 @@ discard block |
||
| 599 | 599 | |
| 600 | 600 | try { |
| 601 | 601 | $currently_executing_script = $this->get_last_ran_script(); |
| 602 | - if (! $currently_executing_script) { |
|
| 602 | + if ( ! $currently_executing_script) { |
|
| 603 | 603 | // Find the next script that needs to execute |
| 604 | 604 | $scripts = $this->check_for_applicable_data_migration_scripts(); |
| 605 | - if (! $scripts) { |
|
| 605 | + if ( ! $scripts) { |
|
| 606 | 606 | // huh, no more scripts to run... apparently we're done! |
| 607 | 607 | // but dont forget to make sure initial data is there |
| 608 | 608 | // we should be good to allow them to exit maintenance mode now |
@@ -628,7 +628,7 @@ discard block |
||
| 628 | 628 | $migrates_to = $this->script_migrates_to_version(get_class($currently_executing_script)); |
| 629 | 629 | $plugin_slug = $migrates_to['slug']; |
| 630 | 630 | $version = $migrates_to['version']; |
| 631 | - $this->_data_migrations_ran[ $plugin_slug ][ $version ] = $currently_executing_script; |
|
| 631 | + $this->_data_migrations_ran[$plugin_slug][$version] = $currently_executing_script; |
|
| 632 | 632 | } |
| 633 | 633 | $current_script_name = get_class($currently_executing_script); |
| 634 | 634 | } catch (Exception $e) { |
@@ -636,7 +636,7 @@ discard block |
||
| 636 | 636 | |
| 637 | 637 | $message = sprintf( |
| 638 | 638 | __("Error Message: %sStack Trace:%s", "event_espresso"), |
| 639 | - $e->getMessage() . '<br>', |
|
| 639 | + $e->getMessage().'<br>', |
|
| 640 | 640 | $e->getTraceAsString() |
| 641 | 641 | ); |
| 642 | 642 | // record it on the array of data migration scripts ran. This will be overwritten next time we try and try to run data migrations |
@@ -688,7 +688,7 @@ discard block |
||
| 688 | 688 | ); |
| 689 | 689 | // check if there are any more after this one. |
| 690 | 690 | $scripts_remaining = $this->check_for_applicable_data_migration_scripts(); |
| 691 | - if (! $scripts_remaining) { |
|
| 691 | + if ( ! $scripts_remaining) { |
|
| 692 | 692 | // we should be good to allow them to exit maintenance mode now |
| 693 | 693 | EE_Maintenance_Mode::instance()->set_maintenance_level( |
| 694 | 694 | intval(EE_Maintenance_Mode::level_0_not_in_maintenance) |
@@ -788,7 +788,7 @@ discard block |
||
| 788 | 788 | ), |
| 789 | 789 | 'script' => 'Unknown', |
| 790 | 790 | ); |
| 791 | - $this->add_error_to_migrations_ran($e->getMessage() . "; Stack trace:" . $e->getTraceAsString()); |
|
| 791 | + $this->add_error_to_migrations_ran($e->getMessage()."; Stack trace:".$e->getTraceAsString()); |
|
| 792 | 792 | } |
| 793 | 793 | $warnings_etc = @ob_get_contents(); |
| 794 | 794 | ob_end_clean(); |
@@ -808,12 +808,12 @@ discard block |
||
| 808 | 808 | */ |
| 809 | 809 | public function update_current_database_state_to($slug_and_version = null) |
| 810 | 810 | { |
| 811 | - if (! $slug_and_version) { |
|
| 811 | + if ( ! $slug_and_version) { |
|
| 812 | 812 | // no version was provided, assume it should be at the current code version |
| 813 | 813 | $slug_and_version = array('slug' => 'Core', 'version' => espresso_version()); |
| 814 | 814 | } |
| 815 | 815 | $current_database_state = get_option(self::current_database_state); |
| 816 | - $current_database_state[ $slug_and_version['slug'] ] = $slug_and_version['version']; |
|
| 816 | + $current_database_state[$slug_and_version['slug']] = $slug_and_version['version']; |
|
| 817 | 817 | update_option(self::current_database_state, $current_database_state); |
| 818 | 818 | } |
| 819 | 819 | |
@@ -832,15 +832,15 @@ discard block |
||
| 832 | 832 | $slug = $slug_and_version['slug']; |
| 833 | 833 | $version = $slug_and_version['version']; |
| 834 | 834 | $current_database_state = get_option(self::current_database_state); |
| 835 | - if (! isset($current_database_state[ $slug ])) { |
|
| 835 | + if ( ! isset($current_database_state[$slug])) { |
|
| 836 | 836 | return true; |
| 837 | 837 | } else { |
| 838 | 838 | // just compare the first 3 parts of version string, eg "4.7.1", not "4.7.1.dev.032" because DBs shouldn't change on nano version changes |
| 839 | - $version_parts_current_db_state = array_slice(explode('.', $current_database_state[ $slug ]), 0, 3); |
|
| 839 | + $version_parts_current_db_state = array_slice(explode('.', $current_database_state[$slug]), 0, 3); |
|
| 840 | 840 | $version_parts_of_provided_db_state = array_slice(explode('.', $version), 0, 3); |
| 841 | 841 | $needs_updating = false; |
| 842 | 842 | foreach ($version_parts_current_db_state as $offset => $version_part_in_current_db_state) { |
| 843 | - if ($version_part_in_current_db_state < $version_parts_of_provided_db_state[ $offset ]) { |
|
| 843 | + if ($version_part_in_current_db_state < $version_parts_of_provided_db_state[$offset]) { |
|
| 844 | 844 | $needs_updating = true; |
| 845 | 845 | break; |
| 846 | 846 | } |
@@ -862,7 +862,7 @@ discard block |
||
| 862 | 862 | */ |
| 863 | 863 | public function get_all_data_migration_scripts_available() |
| 864 | 864 | { |
| 865 | - if (! $this->_data_migration_class_to_filepath_map) { |
|
| 865 | + if ( ! $this->_data_migration_class_to_filepath_map) { |
|
| 866 | 866 | $this->_data_migration_class_to_filepath_map = array(); |
| 867 | 867 | foreach ($this->get_data_migration_script_folders() as $eeAddonClass => $folder_path) { |
| 868 | 868 | // strip any placeholders added to classname to make it a unique array key |
@@ -871,7 +871,7 @@ discard block |
||
| 871 | 871 | ? $eeAddonClass |
| 872 | 872 | : ''; |
| 873 | 873 | $folder_path = EEH_File::end_with_directory_separator($folder_path); |
| 874 | - $files = glob($folder_path . '*.dms.php'); |
|
| 874 | + $files = glob($folder_path.'*.dms.php'); |
|
| 875 | 875 | if (empty($files)) { |
| 876 | 876 | continue; |
| 877 | 877 | } |
@@ -897,7 +897,7 @@ discard block |
||
| 897 | 897 | '4.3.0.alpha.019' |
| 898 | 898 | ); |
| 899 | 899 | } |
| 900 | - $this->_data_migration_class_to_filepath_map[ $classname ] = $file; |
|
| 900 | + $this->_data_migration_class_to_filepath_map[$classname] = $file; |
|
| 901 | 901 | } |
| 902 | 902 | } |
| 903 | 903 | EEH_Autoloader::register_autoloader($this->_data_migration_class_to_filepath_map); |
@@ -929,7 +929,7 @@ discard block |
||
| 929 | 929 | // get last-ran migration script |
| 930 | 930 | global $wpdb; |
| 931 | 931 | $last_migration_script_option = $wpdb->get_row( |
| 932 | - "SELECT * FROM $wpdb->options WHERE option_name like '" . EE_Data_Migration_Manager::data_migration_script_option_prefix . "%' ORDER BY option_id DESC LIMIT 1", |
|
| 932 | + "SELECT * FROM $wpdb->options WHERE option_name like '".EE_Data_Migration_Manager::data_migration_script_option_prefix."%' ORDER BY option_id DESC LIMIT 1", |
|
| 933 | 933 | ARRAY_A |
| 934 | 934 | ); |
| 935 | 935 | |
@@ -961,10 +961,10 @@ discard block |
||
| 961 | 961 | $versions_migrated_to = 'Unknown.1.0.0'; |
| 962 | 962 | // now just to make sure appears as last (in case the were previously a fatal error like this) |
| 963 | 963 | // delete the old one |
| 964 | - delete_option(self::data_migration_script_option_prefix . $versions_migrated_to); |
|
| 964 | + delete_option(self::data_migration_script_option_prefix.$versions_migrated_to); |
|
| 965 | 965 | } |
| 966 | 966 | update_option( |
| 967 | - self::data_migration_script_option_prefix . $versions_migrated_to, |
|
| 967 | + self::data_migration_script_option_prefix.$versions_migrated_to, |
|
| 968 | 968 | $last_ran_migration_script_properties |
| 969 | 969 | ); |
| 970 | 970 | } |
@@ -983,8 +983,8 @@ discard block |
||
| 983 | 983 | $successful_updates = true; |
| 984 | 984 | foreach ($this->_data_migrations_ran as $plugin_slug => $migrations_ran_for_plugin) { |
| 985 | 985 | foreach ($migrations_ran_for_plugin as $version_string => $array_or_migration_obj) { |
| 986 | - $plugin_slug_for_use_in_option_name = $plugin_slug . "."; |
|
| 987 | - $option_name = self::data_migration_script_option_prefix . $plugin_slug_for_use_in_option_name . $version_string; |
|
| 986 | + $plugin_slug_for_use_in_option_name = $plugin_slug."."; |
|
| 987 | + $option_name = self::data_migration_script_option_prefix.$plugin_slug_for_use_in_option_name.$version_string; |
|
| 988 | 988 | $old_option_value = get_option($option_name); |
| 989 | 989 | if ($array_or_migration_obj instanceof EE_Data_Migration_Script_Base) { |
| 990 | 990 | $script_array_for_saving = $array_or_migration_obj->properties_as_array(); |
@@ -996,7 +996,7 @@ discard block |
||
| 996 | 996 | $successful_updates = update_option($option_name, $array_or_migration_obj); |
| 997 | 997 | } |
| 998 | 998 | } |
| 999 | - if (! $successful_updates) { |
|
| 999 | + if ( ! $successful_updates) { |
|
| 1000 | 1000 | global $wpdb; |
| 1001 | 1001 | return $wpdb->last_error; |
| 1002 | 1002 | } |
@@ -1030,7 +1030,7 @@ discard block |
||
| 1030 | 1030 | */ |
| 1031 | 1031 | public function _instantiate_script_from_properties_array($properties_array) |
| 1032 | 1032 | { |
| 1033 | - if (! isset($properties_array['class'])) { |
|
| 1033 | + if ( ! isset($properties_array['class'])) { |
|
| 1034 | 1034 | throw new EE_Error( |
| 1035 | 1035 | sprintf( |
| 1036 | 1036 | __("Properties array has no 'class' properties. Here's what it has: %s", "event_espresso"), |
@@ -1039,11 +1039,11 @@ discard block |
||
| 1039 | 1039 | ); |
| 1040 | 1040 | } |
| 1041 | 1041 | $class_name = $properties_array['class']; |
| 1042 | - if (! class_exists($class_name)) { |
|
| 1042 | + if ( ! class_exists($class_name)) { |
|
| 1043 | 1043 | throw new EE_Error(sprintf(__("There is no migration script named %s", "event_espresso"), $class_name)); |
| 1044 | 1044 | } |
| 1045 | 1045 | $class = new $class_name; |
| 1046 | - if (! $class instanceof EE_Data_Migration_Script_Base) { |
|
| 1046 | + if ( ! $class instanceof EE_Data_Migration_Script_Base) { |
|
| 1047 | 1047 | throw new EE_Error( |
| 1048 | 1048 | sprintf( |
| 1049 | 1049 | __("Class '%s' is supposed to be a migration script. Its not, its a '%s'", "event_espresso"), |
@@ -1110,8 +1110,8 @@ discard block |
||
| 1110 | 1110 | public function get_migration_ran($version, $plugin_slug = 'Core') |
| 1111 | 1111 | { |
| 1112 | 1112 | $migrations_ran = $this->get_data_migrations_ran(); |
| 1113 | - if (isset($migrations_ran[ $plugin_slug ]) && isset($migrations_ran[ $plugin_slug ][ $version ])) { |
|
| 1114 | - return $migrations_ran[ $plugin_slug ][ $version ]; |
|
| 1113 | + if (isset($migrations_ran[$plugin_slug]) && isset($migrations_ran[$plugin_slug][$version])) { |
|
| 1114 | + return $migrations_ran[$plugin_slug][$version]; |
|
| 1115 | 1115 | } else { |
| 1116 | 1116 | return null; |
| 1117 | 1117 | } |
@@ -1172,7 +1172,7 @@ discard block |
||
| 1172 | 1172 | public function enqueue_db_initialization_for($plugin_slug) |
| 1173 | 1173 | { |
| 1174 | 1174 | $queue = $this->get_db_initialization_queue(); |
| 1175 | - if (! in_array($plugin_slug, $queue)) { |
|
| 1175 | + if ( ! in_array($plugin_slug, $queue)) { |
|
| 1176 | 1176 | $queue[] = $plugin_slug; |
| 1177 | 1177 | } |
| 1178 | 1178 | update_option(self::db_init_queue_option_name, $queue); |
@@ -1188,7 +1188,7 @@ discard block |
||
| 1188 | 1188 | $queue = $this->get_db_initialization_queue(); |
| 1189 | 1189 | foreach ($queue as $plugin_slug) { |
| 1190 | 1190 | $most_up_to_date_dms = $this->get_most_up_to_date_dms($plugin_slug); |
| 1191 | - if (! $most_up_to_date_dms) { |
|
| 1191 | + if ( ! $most_up_to_date_dms) { |
|
| 1192 | 1192 | // if there is NO DMS for this plugin, obviously there's no schema to verify anyways |
| 1193 | 1193 | $verify_db = false; |
| 1194 | 1194 | } else { |