eventespresso / event-espresso-core

core/libraries/plugin_api/EE_Register_Addon.lib.php

Indentation +639 added lines, -639 removed lines

@@ -48,7 +48,7 @@ 
 	protected static $_incompatible_addons = array(
 		'Multi_Event_Registration' => '2.0.11.rc.002',
 		'Promotions' => '1.0.0.rc.084',
-    );
+	);
 
 
 
@@ -219,660 +219,660 @@ 
 	 */
 	public static function register( $addon_name = '', $setup_args = array() ) {
 		// required fields MUST be present, so let's make sure they are.
-        \EE_Register_Addon::_verify_parameters($addon_name, $setup_args);
-        // get class name for addon
+		\EE_Register_Addon::_verify_parameters($addon_name, $setup_args);
+		// get class name for addon
 		$class_name = \EE_Register_Addon::_parse_class_name($addon_name, $setup_args);
 		//setup $_settings array from incoming values.
-        $addon_settings = \EE_Register_Addon::_get_addon_settings($class_name, $setup_args);
-        // setup PUE
-        \EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args);
-        // does this addon work with this version of core or WordPress ?
-        if ( ! \EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings) ) {
-            return;
+		$addon_settings = \EE_Register_Addon::_get_addon_settings($class_name, $setup_args);
+		// setup PUE
+		\EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args);
+		// does this addon work with this version of core or WordPress ?
+		if ( ! \EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings) ) {
+			return;
 		}
 		// register namespaces
-        \EE_Register_Addon::_setup_namespaces($addon_settings);
-        // check if this is an activation request
-        if ( \EE_Register_Addon::_addon_activation($addon_name, $addon_settings)) {
-            // dont bother setting up the rest of the addon atm
-            return;
-        }
-        // we need cars
-        \EE_Register_Addon::_setup_autoloaders($addon_name);
-        // register new models and extensions
-        \EE_Register_Addon::_register_models_and_extensions($addon_name);
-        // setup DMS
-        \EE_Register_Addon::_register_data_migration_scripts($addon_name);
-        // if config_class is present let's register config.
-        \EE_Register_Addon::_register_config($addon_name);
-        // register admin pages
-        \EE_Register_Addon::_register_admin_pages($addon_name);
-        // add to list of modules to be registered
-        \EE_Register_Addon::_register_modules($addon_name);
-        // add to list of shortcodes to be registered
-        \EE_Register_Addon::_register_shortcodes($addon_name);
-        // add to list of widgets to be registered
-        \EE_Register_Addon::_register_widgets($addon_name);
-        // register capability related stuff.
-        \EE_Register_Addon::_register_capabilities($addon_name);
-        // any message type to register?
-        \EE_Register_Addon::_register_message_types($addon_name);
+		\EE_Register_Addon::_setup_namespaces($addon_settings);
+		// check if this is an activation request
+		if ( \EE_Register_Addon::_addon_activation($addon_name, $addon_settings)) {
+			// dont bother setting up the rest of the addon atm
+			return;
+		}
+		// we need cars
+		\EE_Register_Addon::_setup_autoloaders($addon_name);
+		// register new models and extensions
+		\EE_Register_Addon::_register_models_and_extensions($addon_name);
+		// setup DMS
+		\EE_Register_Addon::_register_data_migration_scripts($addon_name);
+		// if config_class is present let's register config.
+		\EE_Register_Addon::_register_config($addon_name);
+		// register admin pages
+		\EE_Register_Addon::_register_admin_pages($addon_name);
+		// add to list of modules to be registered
+		\EE_Register_Addon::_register_modules($addon_name);
+		// add to list of shortcodes to be registered
+		\EE_Register_Addon::_register_shortcodes($addon_name);
+		// add to list of widgets to be registered
+		\EE_Register_Addon::_register_widgets($addon_name);
+		// register capability related stuff.
+		\EE_Register_Addon::_register_capabilities($addon_name);
+		// any message type to register?
+		\EE_Register_Addon::_register_message_types($addon_name);
 		// any custom post type/ custom capabilities or default terms to register
-        \EE_Register_Addon::_register_custom_post_types($addon_name);
-        // and any payment methods
-        \EE_Register_Addon::_register_payment_methods($addon_name);
+		\EE_Register_Addon::_register_custom_post_types($addon_name);
+		// and any payment methods
+		\EE_Register_Addon::_register_payment_methods($addon_name);
 		// load and instantiate main addon class
-        $addon = \EE_Register_Addon::_load_and_init_addon_class($addon_name);
-        $addon->after_registration();
-    }
-
-
-
-    /**
-     * @param string $addon_name
-     * @param array  $setup_args
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _verify_parameters($addon_name, array $setup_args)
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($addon_name) || ! is_array($setup_args)) {
-            throw new EE_Error(
-                __(
-                    'In order to register an EE_Addon with EE_Register_Addon::register(), you must include the "addon_name" (the name of the addon), and an array of arguments.',
-                    'event_espresso'
-                )
-            );
-        }
-        if ( ! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'When registering an addon, you didn\'t provide the "main_file_path", which is the full path to the main file loaded directly by Wordpress. You only provided %s',
-                        'event_espresso'
-                    ),
-                    implode(',', array_keys($setup_args))
-                )
-            );
-        }
-        // check that addon has not already been registered with that name
-        if (isset(self::$_settings[$addon_name]) && ! did_action('activate_plugin')) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'An EE_Addon with the name "%s" has already been registered and each EE_Addon requires a unique name.',
-                        'event_espresso'
-                    ),
-                    $addon_name
-                )
-            );
-        }
+		$addon = \EE_Register_Addon::_load_and_init_addon_class($addon_name);
+		$addon->after_registration();
+	}
+
+
+
+	/**
+	 * @param string $addon_name
+	 * @param array  $setup_args
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _verify_parameters($addon_name, array $setup_args)
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($addon_name) || ! is_array($setup_args)) {
+			throw new EE_Error(
+				__(
+					'In order to register an EE_Addon with EE_Register_Addon::register(), you must include the "addon_name" (the name of the addon), and an array of arguments.',
+					'event_espresso'
+				)
+			);
+		}
+		if ( ! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'When registering an addon, you didn\'t provide the "main_file_path", which is the full path to the main file loaded directly by Wordpress. You only provided %s',
+						'event_espresso'
+					),
+					implode(',', array_keys($setup_args))
+				)
+			);
+		}
+		// check that addon has not already been registered with that name
+		if (isset(self::$_settings[$addon_name]) && ! did_action('activate_plugin')) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'An EE_Addon with the name "%s" has already been registered and each EE_Addon requires a unique name.',
+						'event_espresso'
+					),
+					$addon_name
+				)
+			);
+		}
 	}
 
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $setup_args
-     * @return string
-     */
-    private static function _parse_class_name($addon_name, array $setup_args)
-    {
-        if (empty($setup_args['class_name'])) {
-            // generate one by first separating name with spaces
-            $class_name = str_replace(array('-', '_'), ' ', trim($addon_name));
-            //capitalize, then replace spaces with underscores
-            $class_name = str_replace(' ', '_', ucwords($class_name));
-        } else {
-            $class_name = $setup_args['class_name'];
-        }
-        return strpos($class_name, 'EE_') === 0 ? $class_name : 'EE_' . $class_name;
-    }
-
-
-
-    /**
-     * @param string $class_name
-     * @param array  $setup_args
-     * @return array
-     */
-    private static function _get_addon_settings($class_name, array $setup_args)
-    {
-        //setup $_settings array from incoming values.
-        $addon_settings = array(
-            // generated from the addon name, changes something like "calendar" to "EE_Calendar"
-            'class_name'            => $class_name,
-            // the addon slug for use in URLs, etc
-            'plugin_slug'           => isset($setup_args['plugin_slug'])
-                ? (string)$setup_args['plugin_slug']
-                : '',
-            // page slug to be used when generating the "Settings" link on the WP plugin page
-            'plugin_action_slug'    => isset($setup_args['plugin_action_slug'])
-                ? (string)$setup_args['plugin_action_slug']
-                : '',
-            // the "software" version for the addon
-            'version'               => isset($setup_args['version'])
-                ? (string)$setup_args['version']
-                : '',
-            // the minimum version of EE Core that the addon will work with
-            'min_core_version'      => isset($setup_args['min_core_version'])
-                ? (string)$setup_args['min_core_version']
-                : '',
-            // the minimum version of WordPress that the addon will work with
-            'min_wp_version'        => isset($setup_args['min_wp_version'])
-                ? (string)$setup_args['min_wp_version']
-                : EE_MIN_WP_VER_REQUIRED,
-            // full server path to main file (file loaded directly by WP)
-            'main_file_path'        => isset($setup_args['main_file_path'])
-                ? (string)$setup_args['main_file_path']
-                : '',
-            // path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages
-            'admin_path'            => isset($setup_args['admin_path'])
-                ? (string)$setup_args['admin_path'] : '',
-            // a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page
-            'admin_callback'        => isset($setup_args['admin_callback'])
-                ? (string)$setup_args['admin_callback']
-                : '',
-            // the section name for this addon's configuration settings section (defaults to "addons")
-            'config_section'        => isset($setup_args['config_section'])
-                ? (string)$setup_args['config_section']
-                : 'addons',
-            // the class name for this addon's configuration settings object
-            'config_class'          => isset($setup_args['config_class'])
-                ? (string)$setup_args['config_class'] : '',
-            //the name given to the config for this addons' configuration settings object (optional)
-            'config_name'           => isset($setup_args['config_name'])
-                ? (string)$setup_args['config_name'] : '',
-            // an array of "class names" => "full server paths" for any classes that might be invoked by the addon
-            'autoloader_paths'      => isset($setup_args['autoloader_paths'])
-                ? (array)$setup_args['autoloader_paths']
-                : array(),
-            // an array of  "full server paths" for any folders containing classes that might be invoked by the addon
-            'autoloader_folders'    => isset($setup_args['autoloader_folders'])
-                ? (array)$setup_args['autoloader_folders']
-                : array(),
-            // array of full server paths to any EE_DMS data migration scripts used by the addon
-            'dms_paths'             => isset($setup_args['dms_paths'])
-                ? (array)$setup_args['dms_paths']
-                : array(),
-            // array of full server paths to any EED_Modules used by the addon
-            'module_paths'          => isset($setup_args['module_paths'])
-                ? (array)$setup_args['module_paths']
-                : array(),
-            // array of full server paths to any EES_Shortcodes used by the addon
-            'shortcode_paths'       => isset($setup_args['shortcode_paths'])
-                ? (array)$setup_args['shortcode_paths']
-                : array(),
-            // array of full server paths to any WP_Widgets used by the addon
-            'widget_paths'          => isset($setup_args['widget_paths'])
-                ? (array)$setup_args['widget_paths']
-                : array(),
-            // array of PUE options used by the addon
-            'pue_options'           => isset($setup_args['pue_options'])
-                ? (array)$setup_args['pue_options']
-                : array(),
-            'message_types'         => isset($setup_args['message_types'])
-                ? (array)$setup_args['message_types']
-                : array(),
-            'capabilities'          => isset($setup_args['capabilities'])
-                ? (array)$setup_args['capabilities']
-                : array(),
-            'capability_maps'       => isset($setup_args['capability_maps'])
-                ? (array)$setup_args['capability_maps']
-                : array(),
-            'model_paths'           => isset($setup_args['model_paths'])
-                ? (array)$setup_args['model_paths']
-                : array(),
-            'class_paths'           => isset($setup_args['class_paths'])
-                ? (array)$setup_args['class_paths']
-                : array(),
-            'model_extension_paths' => isset($setup_args['model_extension_paths'])
-                ? (array)$setup_args['model_extension_paths']
-                : array(),
-            'class_extension_paths' => isset($setup_args['class_extension_paths'])
-                ? (array)$setup_args['class_extension_paths']
-                : array(),
-            'custom_post_types'     => isset($setup_args['custom_post_types'])
-                ? (array)$setup_args['custom_post_types']
-                : array(),
-            'custom_taxonomies'     => isset($setup_args['custom_taxonomies'])
-                ? (array)$setup_args['custom_taxonomies']
-                : array(),
-            'payment_method_paths'  => isset($setup_args['payment_method_paths'])
-                ? (array)$setup_args['payment_method_paths']
-                : array(),
-            'default_terms'         => isset($setup_args['default_terms'])
-                ? (array)$setup_args['default_terms']
-                : array(),
-            // if not empty, inserts a new table row after this plugin's row on the WP Plugins page
-            // that can be used for adding upgrading/marketing info
-            'plugins_page_row'      => isset($setup_args['plugins_page_row'])
-                ? $setup_args['plugins_page_row']
-                : '',
-            'namespace'             => isset(
-                $setup_args['namespace'],
-                $setup_args['namespace']['FQNS'],
-                $setup_args['namespace']['DIR']
-            )
-                ? (array)$setup_args['namespace']
-                : array(),
-        );
-        // if plugin_action_slug is NOT set, but an admin page path IS set,
-        // then let's just use the plugin_slug since that will be used for linking to the admin page
-        $addon_settings['plugin_action_slug'] = empty($addon_settings['plugin_action_slug'])
-                                                && ! empty($addon_settings['admin_path'])
-            ? $addon_settings['plugin_slug']
-            : $addon_settings['plugin_action_slug'];
-        // full server path to main file (file loaded directly by WP)
-        $addon_settings['plugin_basename'] = plugin_basename($addon_settings['main_file_path']);
-        return $addon_settings;
+	/**
+	 * @param string $addon_name
+	 * @param array  $setup_args
+	 * @return string
+	 */
+	private static function _parse_class_name($addon_name, array $setup_args)
+	{
+		if (empty($setup_args['class_name'])) {
+			// generate one by first separating name with spaces
+			$class_name = str_replace(array('-', '_'), ' ', trim($addon_name));
+			//capitalize, then replace spaces with underscores
+			$class_name = str_replace(' ', '_', ucwords($class_name));
+		} else {
+			$class_name = $setup_args['class_name'];
+		}
+		return strpos($class_name, 'EE_') === 0 ? $class_name : 'EE_' . $class_name;
 	}
 
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $addon_settings
-     * @return boolean
-     */
+	/**
+	 * @param string $class_name
+	 * @param array  $setup_args
+	 * @return array
+	 */
+	private static function _get_addon_settings($class_name, array $setup_args)
+	{
+		//setup $_settings array from incoming values.
+		$addon_settings = array(
+			// generated from the addon name, changes something like "calendar" to "EE_Calendar"
+			'class_name'            => $class_name,
+			// the addon slug for use in URLs, etc
+			'plugin_slug'           => isset($setup_args['plugin_slug'])
+				? (string)$setup_args['plugin_slug']
+				: '',
+			// page slug to be used when generating the "Settings" link on the WP plugin page
+			'plugin_action_slug'    => isset($setup_args['plugin_action_slug'])
+				? (string)$setup_args['plugin_action_slug']
+				: '',
+			// the "software" version for the addon
+			'version'               => isset($setup_args['version'])
+				? (string)$setup_args['version']
+				: '',
+			// the minimum version of EE Core that the addon will work with
+			'min_core_version'      => isset($setup_args['min_core_version'])
+				? (string)$setup_args['min_core_version']
+				: '',
+			// the minimum version of WordPress that the addon will work with
+			'min_wp_version'        => isset($setup_args['min_wp_version'])
+				? (string)$setup_args['min_wp_version']
+				: EE_MIN_WP_VER_REQUIRED,
+			// full server path to main file (file loaded directly by WP)
+			'main_file_path'        => isset($setup_args['main_file_path'])
+				? (string)$setup_args['main_file_path']
+				: '',
+			// path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages
+			'admin_path'            => isset($setup_args['admin_path'])
+				? (string)$setup_args['admin_path'] : '',
+			// a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page
+			'admin_callback'        => isset($setup_args['admin_callback'])
+				? (string)$setup_args['admin_callback']
+				: '',
+			// the section name for this addon's configuration settings section (defaults to "addons")
+			'config_section'        => isset($setup_args['config_section'])
+				? (string)$setup_args['config_section']
+				: 'addons',
+			// the class name for this addon's configuration settings object
+			'config_class'          => isset($setup_args['config_class'])
+				? (string)$setup_args['config_class'] : '',
+			//the name given to the config for this addons' configuration settings object (optional)
+			'config_name'           => isset($setup_args['config_name'])
+				? (string)$setup_args['config_name'] : '',
+			// an array of "class names" => "full server paths" for any classes that might be invoked by the addon
+			'autoloader_paths'      => isset($setup_args['autoloader_paths'])
+				? (array)$setup_args['autoloader_paths']
+				: array(),
+			// an array of  "full server paths" for any folders containing classes that might be invoked by the addon
+			'autoloader_folders'    => isset($setup_args['autoloader_folders'])
+				? (array)$setup_args['autoloader_folders']
+				: array(),
+			// array of full server paths to any EE_DMS data migration scripts used by the addon
+			'dms_paths'             => isset($setup_args['dms_paths'])
+				? (array)$setup_args['dms_paths']
+				: array(),
+			// array of full server paths to any EED_Modules used by the addon
+			'module_paths'          => isset($setup_args['module_paths'])
+				? (array)$setup_args['module_paths']
+				: array(),
+			// array of full server paths to any EES_Shortcodes used by the addon
+			'shortcode_paths'       => isset($setup_args['shortcode_paths'])
+				? (array)$setup_args['shortcode_paths']
+				: array(),
+			// array of full server paths to any WP_Widgets used by the addon
+			'widget_paths'          => isset($setup_args['widget_paths'])
+				? (array)$setup_args['widget_paths']
+				: array(),
+			// array of PUE options used by the addon
+			'pue_options'           => isset($setup_args['pue_options'])
+				? (array)$setup_args['pue_options']
+				: array(),
+			'message_types'         => isset($setup_args['message_types'])
+				? (array)$setup_args['message_types']
+				: array(),
+			'capabilities'          => isset($setup_args['capabilities'])
+				? (array)$setup_args['capabilities']
+				: array(),
+			'capability_maps'       => isset($setup_args['capability_maps'])
+				? (array)$setup_args['capability_maps']
+				: array(),
+			'model_paths'           => isset($setup_args['model_paths'])
+				? (array)$setup_args['model_paths']
+				: array(),
+			'class_paths'           => isset($setup_args['class_paths'])
+				? (array)$setup_args['class_paths']
+				: array(),
+			'model_extension_paths' => isset($setup_args['model_extension_paths'])
+				? (array)$setup_args['model_extension_paths']
+				: array(),
+			'class_extension_paths' => isset($setup_args['class_extension_paths'])
+				? (array)$setup_args['class_extension_paths']
+				: array(),
+			'custom_post_types'     => isset($setup_args['custom_post_types'])
+				? (array)$setup_args['custom_post_types']
+				: array(),
+			'custom_taxonomies'     => isset($setup_args['custom_taxonomies'])
+				? (array)$setup_args['custom_taxonomies']
+				: array(),
+			'payment_method_paths'  => isset($setup_args['payment_method_paths'])
+				? (array)$setup_args['payment_method_paths']
+				: array(),
+			'default_terms'         => isset($setup_args['default_terms'])
+				? (array)$setup_args['default_terms']
+				: array(),
+			// if not empty, inserts a new table row after this plugin's row on the WP Plugins page
+			// that can be used for adding upgrading/marketing info
+			'plugins_page_row'      => isset($setup_args['plugins_page_row'])
+				? $setup_args['plugins_page_row']
+				: '',
+			'namespace'             => isset(
+				$setup_args['namespace'],
+				$setup_args['namespace']['FQNS'],
+				$setup_args['namespace']['DIR']
+			)
+				? (array)$setup_args['namespace']
+				: array(),
+		);
+		// if plugin_action_slug is NOT set, but an admin page path IS set,
+		// then let's just use the plugin_slug since that will be used for linking to the admin page
+		$addon_settings['plugin_action_slug'] = empty($addon_settings['plugin_action_slug'])
+												&& ! empty($addon_settings['admin_path'])
+			? $addon_settings['plugin_slug']
+			: $addon_settings['plugin_action_slug'];
+		// full server path to main file (file loaded directly by WP)
+		$addon_settings['plugin_basename'] = plugin_basename($addon_settings['main_file_path']);
+		return $addon_settings;
+	}
+
+
+
+	/**
+	 * @param string $addon_name
+	 * @param array  $addon_settings
+	 * @return boolean
+	 */
 	private static function _addon_is_compatible( $addon_name, array $addon_settings ) {
-        global $wp_version;
-        $incompatibility_message = '';
-        //check whether this addon version is compatible with EE core
-        if (
-            isset(EE_Register_Addon::$_incompatible_addons[$addon_name])
-            && ! self::_meets_min_core_version_requirement(
-                EE_Register_Addon::$_incompatible_addons[$addon_name],
-                $addon_settings['version']
-            )
-        ) {
-            $incompatibility_message = sprintf(
-                __(
-                    '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon is not compatible with this version of Event Espresso.%2$sPlease upgrade your "%1$s" addon to version %3$s or newer to resolve this issue.'
-                ),
-                $addon_name,
-                '<br />',
-                EE_Register_Addon::$_incompatible_addons[$addon_name],
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        } else if (
-            ! self::_meets_min_core_version_requirement($addon_settings['min_core_version'], espresso_version())
-        ) {
-            $incompatibility_message = sprintf(
-                __(
-                    '%5$sIMPORTANT!%6$sThe Event Espresso "%1$s" addon requires Event Espresso Core version "%2$s" or higher in order to run.%4$sYour version of Event Espresso Core is currently at "%3$s". Please upgrade Event Espresso Core first and then re-activate "%1$s".',
-                    'event_espresso'
-                ),
-                $addon_name,
-                self::_effective_version($addon_settings['min_core_version']),
-                self::_effective_version(espresso_version()),
-                '<br />',
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        } else if (version_compare($wp_version, $addon_settings['min_wp_version'], '<')) {
-            $incompatibility_message = sprintf(
-                __(
-                    '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon requires WordPress version "%2$s" or greater.%3$sPlease update your version of WordPress to use the "%1$s" addon and to keep your site secure.',
-                    'event_espresso'
-                ),
-                $addon_name,
-                $addon_settings['min_wp_version'],
-                '<br />',
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        }
-        if ( ! empty($incompatibility_message)) {
-            // remove 'activate' from the REQUEST
-            // so WP doesn't erroneously tell the user the plugin activated fine when it didn't
-            unset($_GET['activate'], $_REQUEST['activate']);
-            if (current_user_can('activate_plugins')) {
-                // show an error message indicating the plugin didn't activate properly
-                EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__);
-            }
-            // BAIL FROM THE ADDON REGISTRATION PROCESS
-            return false;
-        }
-        // addon IS compatible
-        return true;
+		global $wp_version;
+		$incompatibility_message = '';
+		//check whether this addon version is compatible with EE core
+		if (
+			isset(EE_Register_Addon::$_incompatible_addons[$addon_name])
+			&& ! self::_meets_min_core_version_requirement(
+				EE_Register_Addon::$_incompatible_addons[$addon_name],
+				$addon_settings['version']
+			)
+		) {
+			$incompatibility_message = sprintf(
+				__(
+					'%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon is not compatible with this version of Event Espresso.%2$sPlease upgrade your "%1$s" addon to version %3$s or newer to resolve this issue.'
+				),
+				$addon_name,
+				'<br />',
+				EE_Register_Addon::$_incompatible_addons[$addon_name],
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		} else if (
+			! self::_meets_min_core_version_requirement($addon_settings['min_core_version'], espresso_version())
+		) {
+			$incompatibility_message = sprintf(
+				__(
+					'%5$sIMPORTANT!%6$sThe Event Espresso "%1$s" addon requires Event Espresso Core version "%2$s" or higher in order to run.%4$sYour version of Event Espresso Core is currently at "%3$s". Please upgrade Event Espresso Core first and then re-activate "%1$s".',
+					'event_espresso'
+				),
+				$addon_name,
+				self::_effective_version($addon_settings['min_core_version']),
+				self::_effective_version(espresso_version()),
+				'<br />',
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		} else if (version_compare($wp_version, $addon_settings['min_wp_version'], '<')) {
+			$incompatibility_message = sprintf(
+				__(
+					'%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon requires WordPress version "%2$s" or greater.%3$sPlease update your version of WordPress to use the "%1$s" addon and to keep your site secure.',
+					'event_espresso'
+				),
+				$addon_name,
+				$addon_settings['min_wp_version'],
+				'<br />',
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		}
+		if ( ! empty($incompatibility_message)) {
+			// remove 'activate' from the REQUEST
+			// so WP doesn't erroneously tell the user the plugin activated fine when it didn't
+			unset($_GET['activate'], $_REQUEST['activate']);
+			if (current_user_can('activate_plugins')) {
+				// show an error message indicating the plugin didn't activate properly
+				EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__);
+			}
+			// BAIL FROM THE ADDON REGISTRATION PROCESS
+			return false;
+		}
+		// addon IS compatible
+		return true;
 	}
 
 
 
-    /**
-     * if plugin update engine is being used for auto-updates,
-     * then let's set that up now before going any further so that ALL addons can be updated
-     * (not needed if PUE is not being used)
-     *
-     * @param string $addon_name
-     * @param string $class_name
-     * @param array  $setup_args
-     * @return void
-     */
+	/**
+	 * if plugin update engine is being used for auto-updates,
+	 * then let's set that up now before going any further so that ALL addons can be updated
+	 * (not needed if PUE is not being used)
+	 *
+	 * @param string $addon_name
+	 * @param string $class_name
+	 * @param array  $setup_args
+	 * @return void
+	 */
 	private static function _parse_pue_options( $addon_name, $class_name, array $setup_args ) {
-        if ( ! empty($setup_args['pue_options'])) {
-            self::$_settings[$addon_name]['pue_options'] = array(
-                'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug'])
-                    ? (string)$setup_args['pue_options']['pue_plugin_slug']
-                    : 'espresso_' . strtolower($class_name),
-                'plugin_basename' => isset($setup_args['pue_options']['plugin_basename'])
-                    ? (string)$setup_args['pue_options']['plugin_basename']
-                    : plugin_basename($setup_args['main_file_path']),
-                'checkPeriod'     => isset($setup_args['pue_options']['checkPeriod'])
-                    ? (string)$setup_args['pue_options']['checkPeriod']
-                    : '24',
-                'use_wp_update'   => isset($setup_args['pue_options']['use_wp_update'])
-                    ? (string)$setup_args['pue_options']['use_wp_update']
-                    : false,
-            );
-            add_action(
-                'AHEE__EE_System__brew_espresso__after_pue_init',
-                array('EE_Register_Addon', 'load_pue_update')
-            );
-        }
+		if ( ! empty($setup_args['pue_options'])) {
+			self::$_settings[$addon_name]['pue_options'] = array(
+				'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug'])
+					? (string)$setup_args['pue_options']['pue_plugin_slug']
+					: 'espresso_' . strtolower($class_name),
+				'plugin_basename' => isset($setup_args['pue_options']['plugin_basename'])
+					? (string)$setup_args['pue_options']['plugin_basename']
+					: plugin_basename($setup_args['main_file_path']),
+				'checkPeriod'     => isset($setup_args['pue_options']['checkPeriod'])
+					? (string)$setup_args['pue_options']['checkPeriod']
+					: '24',
+				'use_wp_update'   => isset($setup_args['pue_options']['use_wp_update'])
+					? (string)$setup_args['pue_options']['use_wp_update']
+					: false,
+			);
+			add_action(
+				'AHEE__EE_System__brew_espresso__after_pue_init',
+				array('EE_Register_Addon', 'load_pue_update')
+			);
+		}
 	}
 
 
 
-    /**
-     * register namespaces right away before any other files or classes get loaded, but AFTER the version checks
-     *
-     * @param array $addon_settings
-     * @return void
-     */
-    private static function _setup_namespaces(array $addon_settings)
-    {
-        //
-        if (
-        isset(
-            $addon_settings['namespace'],
-            $addon_settings['namespace']['FQNS'],
-            $addon_settings['namespace']['DIR']
-        )
-        ) {
-            EE_Psr4AutoloaderInit::psr4_loader()->addNamespace(
-                $addon_settings['namespace']['FQNS'],
-                $addon_settings['namespace']['DIR']
-            );
-        }
-    }
-
-
-
-    /**
-     * @param string $addon_name
-     * @param array  $addon_settings
-     * @return bool
-     */
+	/**
+	 * register namespaces right away before any other files or classes get loaded, but AFTER the version checks
+	 *
+	 * @param array $addon_settings
+	 * @return void
+	 */
+	private static function _setup_namespaces(array $addon_settings)
+	{
+		//
+		if (
+		isset(
+			$addon_settings['namespace'],
+			$addon_settings['namespace']['FQNS'],
+			$addon_settings['namespace']['DIR']
+		)
+		) {
+			EE_Psr4AutoloaderInit::psr4_loader()->addNamespace(
+				$addon_settings['namespace']['FQNS'],
+				$addon_settings['namespace']['DIR']
+			);
+		}
+	}
+
+
+
+	/**
+	 * @param string $addon_name
+	 * @param array  $addon_settings
+	 * @return bool
+	 */
 	private static function _addon_activation( $addon_name, array $addon_settings ) {
-        // this is an activation request
-        if (did_action('activate_plugin')) {
-            //to find if THIS is the addon that was activated,
-            //just check if we have already registered it or not
-            //(as the newly-activated addon wasn't around the first time addons were registered)
-            if ( ! isset(self::$_settings[$addon_name])) {
-                self::$_settings[$addon_name] = $addon_settings;
-                $addon = self::_load_and_init_addon_class($addon_name);
-                $addon->set_activation_indicator_option();
-                // dont bother setting up the rest of the addon.
-                // we know it was just activated and the request will end soon
-            }
-            return true;
-        } else {
-            // make sure this was called in the right place!
-            if (
-                ! did_action('AHEE__EE_System__load_espresso_addons')
-                || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
-            ) {
-                EE_Error::doing_it_wrong(
-                    __METHOD__,
-                    sprintf(
-                        __(
-                            'An attempt to register an EE_Addon named "%s" has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register addons.',
-                            'event_espresso'
-                        ),
-                        $addon_name
-                    ),
-                    '4.3.0'
-                );
-            }
-            // make sure addon settings are set correctly without overwriting anything existing
-            if (isset(self::$_settings[$addon_name])) {
-                self::$_settings[$addon_name] += $addon_settings;
-            } else {
-                self::$_settings[$addon_name] = $addon_settings;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _setup_autoloaders($addon_name)
-    {
-        if ( ! empty(self::$_settings[$addon_name]['autoloader_paths'])) {
-            // setup autoloader for single file
-            EEH_Autoloader::instance()->register_autoloader(self::$_settings[$addon_name]['autoloader_paths']);
-        }
-        // setup autoloaders for folders
-        if ( ! empty(self::$_settings[$addon_name]['autoloader_folders'])) {
-            foreach ((array)self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) {
-                EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder);
-            }
-        }
-    }
-
-
-
-    /**
-     * register new models and extensions
-     *
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
+		// this is an activation request
+		if (did_action('activate_plugin')) {
+			//to find if THIS is the addon that was activated,
+			//just check if we have already registered it or not
+			//(as the newly-activated addon wasn't around the first time addons were registered)
+			if ( ! isset(self::$_settings[$addon_name])) {
+				self::$_settings[$addon_name] = $addon_settings;
+				$addon = self::_load_and_init_addon_class($addon_name);
+				$addon->set_activation_indicator_option();
+				// dont bother setting up the rest of the addon.
+				// we know it was just activated and the request will end soon
+			}
+			return true;
+		} else {
+			// make sure this was called in the right place!
+			if (
+				! did_action('AHEE__EE_System__load_espresso_addons')
+				|| did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
+			) {
+				EE_Error::doing_it_wrong(
+					__METHOD__,
+					sprintf(
+						__(
+							'An attempt to register an EE_Addon named "%s" has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register addons.',
+							'event_espresso'
+						),
+						$addon_name
+					),
+					'4.3.0'
+				);
+			}
+			// make sure addon settings are set correctly without overwriting anything existing
+			if (isset(self::$_settings[$addon_name])) {
+				self::$_settings[$addon_name] += $addon_settings;
+			} else {
+				self::$_settings[$addon_name] = $addon_settings;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _setup_autoloaders($addon_name)
+	{
+		if ( ! empty(self::$_settings[$addon_name]['autoloader_paths'])) {
+			// setup autoloader for single file
+			EEH_Autoloader::instance()->register_autoloader(self::$_settings[$addon_name]['autoloader_paths']);
+		}
+		// setup autoloaders for folders
+		if ( ! empty(self::$_settings[$addon_name]['autoloader_folders'])) {
+			foreach ((array)self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) {
+				EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder);
+			}
+		}
+	}
+
+
+
+	/**
+	 * register new models and extensions
+	 *
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	private static function _register_models_and_extensions( $addon_name ) {
-        // register new models
-        if (
-            ! empty(self::$_settings[$addon_name]['model_paths'])
-            || ! empty(self::$_settings[$addon_name]['class_paths'])
-        ) {
-            EE_Register_Model::register(
-                $addon_name,
-                array(
-                    'model_paths' => self::$_settings[$addon_name]['model_paths'],
-                    'class_paths' => self::$_settings[$addon_name]['class_paths'],
-                )
-            );
-        }
-        // register model extensions
-        if (
-            ! empty(self::$_settings[$addon_name]['model_extension_paths'])
-            || ! empty(self::$_settings[$addon_name]['class_extension_paths'])
-        ) {
-            EE_Register_Model_Extensions::register(
-                $addon_name,
-                array(
-                    'model_extension_paths' => self::$_settings[$addon_name]['model_extension_paths'],
-                    'class_extension_paths' => self::$_settings[$addon_name]['class_extension_paths'],
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
+		// register new models
+		if (
+			! empty(self::$_settings[$addon_name]['model_paths'])
+			|| ! empty(self::$_settings[$addon_name]['class_paths'])
+		) {
+			EE_Register_Model::register(
+				$addon_name,
+				array(
+					'model_paths' => self::$_settings[$addon_name]['model_paths'],
+					'class_paths' => self::$_settings[$addon_name]['class_paths'],
+				)
+			);
+		}
+		// register model extensions
+		if (
+			! empty(self::$_settings[$addon_name]['model_extension_paths'])
+			|| ! empty(self::$_settings[$addon_name]['class_extension_paths'])
+		) {
+			EE_Register_Model_Extensions::register(
+				$addon_name,
+				array(
+					'model_extension_paths' => self::$_settings[$addon_name]['model_extension_paths'],
+					'class_extension_paths' => self::$_settings[$addon_name]['class_extension_paths'],
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	private static function _register_data_migration_scripts( $addon_name ) {
-        // setup DMS
-        if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) {
-            EE_Register_Data_Migration_Scripts::register(
-                $addon_name,
-                array('dms_paths' => self::$_settings[$addon_name]['dms_paths'])
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
+		// setup DMS
+		if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) {
+			EE_Register_Data_Migration_Scripts::register(
+				$addon_name,
+				array('dms_paths' => self::$_settings[$addon_name]['dms_paths'])
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	private static function _register_config( $addon_name ) {
-        // if config_class is present let's register config.
-        if ( ! empty(self::$_settings[$addon_name]['config_class'])) {
-            EE_Register_Config::register(
-                self::$_settings[$addon_name]['config_class'],
-                array(
-                    'config_section' => self::$_settings[$addon_name]['config_section'],
-                    'config_name'    => self::$_settings[$addon_name]['config_name'],
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
+		// if config_class is present let's register config.
+		if ( ! empty(self::$_settings[$addon_name]['config_class'])) {
+			EE_Register_Config::register(
+				self::$_settings[$addon_name]['config_class'],
+				array(
+					'config_section' => self::$_settings[$addon_name]['config_section'],
+					'config_name'    => self::$_settings[$addon_name]['config_name'],
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	private static function _register_admin_pages( $addon_name ) {
-        if ( ! empty(self::$_settings[$addon_name]['admin_path'])) {
-            EE_Register_Admin_Page::register(
-                $addon_name,
-                array('page_path' => self::$_settings[$addon_name]['admin_path'])
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
+		if ( ! empty(self::$_settings[$addon_name]['admin_path'])) {
+			EE_Register_Admin_Page::register(
+				$addon_name,
+				array('page_path' => self::$_settings[$addon_name]['admin_path'])
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	private static function _register_modules( $addon_name ) {
-        if ( ! empty(self::$_settings[$addon_name]['module_paths'])) {
-            EE_Register_Module::register(
-                $addon_name,
-                array('module_paths' => self::$_settings[$addon_name]['module_paths'])
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
+		if ( ! empty(self::$_settings[$addon_name]['module_paths'])) {
+			EE_Register_Module::register(
+				$addon_name,
+				array('module_paths' => self::$_settings[$addon_name]['module_paths'])
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	private static function _register_shortcodes( $addon_name ) {
-        if ( ! empty(self::$_settings[$addon_name]['shortcode_paths'])) {
-            EE_Register_Shortcode::register(
-                $addon_name,
-                array('shortcode_paths' => self::$_settings[$addon_name]['shortcode_paths'])
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
+		if ( ! empty(self::$_settings[$addon_name]['shortcode_paths'])) {
+			EE_Register_Shortcode::register(
+				$addon_name,
+				array('shortcode_paths' => self::$_settings[$addon_name]['shortcode_paths'])
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	private static function _register_widgets( $addon_name ) {
-        if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) {
-            EE_Register_Widget::register(
-                $addon_name,
-                array('widget_paths' => self::$_settings[$addon_name]['widget_paths'])
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
+		if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) {
+			EE_Register_Widget::register(
+				$addon_name,
+				array('widget_paths' => self::$_settings[$addon_name]['widget_paths'])
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	private static function _register_capabilities( $addon_name ) {
-        if ( ! empty(self::$_settings[$addon_name]['capabilities'])) {
-            EE_Register_Capabilities::register(
-                $addon_name,
-                array(
-                    'capabilities'    => self::$_settings[$addon_name]['capabilities'],
-                    'capability_maps' => self::$_settings[$addon_name]['capability_maps'],
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
+		if ( ! empty(self::$_settings[$addon_name]['capabilities'])) {
+			EE_Register_Capabilities::register(
+				$addon_name,
+				array(
+					'capabilities'    => self::$_settings[$addon_name]['capabilities'],
+					'capability_maps' => self::$_settings[$addon_name]['capability_maps'],
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	private static function _register_message_types( $addon_name ) {
-        if ( ! empty(self::$_settings[$addon_name]['message_types'])) {
-            add_action(
-                'EE_Brewing_Regular___messages_caf',
-                array('EE_Register_Addon', 'register_message_types')
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
+		if ( ! empty(self::$_settings[$addon_name]['message_types'])) {
+			add_action(
+				'EE_Brewing_Regular___messages_caf',
+				array('EE_Register_Addon', 'register_message_types')
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	private static function _register_custom_post_types( $addon_name ) {
-        if (
-            ! empty(self::$_settings[$addon_name]['custom_post_types'])
-            || ! empty(self::$_settings[$addon_name]['custom_taxonomies'])
-        ) {
-            EE_Register_CPT::register(
-                $addon_name,
-                array(
-                    'cpts'          => self::$_settings[$addon_name]['custom_post_types'],
-                    'cts'           => self::$_settings[$addon_name]['custom_taxonomies'],
-                    'default_terms' => self::$_settings[$addon_name]['default_terms'],
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
+		if (
+			! empty(self::$_settings[$addon_name]['custom_post_types'])
+			|| ! empty(self::$_settings[$addon_name]['custom_taxonomies'])
+		) {
+			EE_Register_CPT::register(
+				$addon_name,
+				array(
+					'cpts'          => self::$_settings[$addon_name]['custom_post_types'],
+					'cts'           => self::$_settings[$addon_name]['custom_taxonomies'],
+					'default_terms' => self::$_settings[$addon_name]['default_terms'],
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
 	private static function _register_payment_methods( $addon_name ) {
-        if ( ! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
-            EE_Register_Payment_Method::register(
-                $addon_name,
-                array('payment_method_paths' => self::$_settings[$addon_name]['payment_method_paths'])
-            );
-        }
-    }
+		if ( ! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
+			EE_Register_Payment_Method::register(
+				$addon_name,
+				array('payment_method_paths' => self::$_settings[$addon_name]['payment_method_paths'])
+			);
+		}
+	}
 
 
 
@@ -901,14 +901,14 @@ 
 		//unfortunately this can't be hooked in upon construction, because we don't have
 		//the plugin mainfile's path upon construction.
 		register_deactivation_hook( $addon->get_main_plugin_file(), array( $addon, 'deactivation' ) );
-        // call any additional admin_callback functions during load_admin_controller hook
-        if ( ! empty(self::$_settings[$addon_name]['admin_callback'])) {
-            add_action(
-                'AHEE__EE_System__load_controllers__load_admin_controllers',
-                array($addon, self::$_settings[$addon_name]['admin_callback'])
-            );
-        }
-        return $addon;
+		// call any additional admin_callback functions during load_admin_controller hook
+		if ( ! empty(self::$_settings[$addon_name]['admin_callback'])) {
+			add_action(
+				'AHEE__EE_System__load_controllers__load_admin_controllers',
+				array($addon, self::$_settings[$addon_name]['admin_callback'])
+			);
+		}
+		return $addon;
 	}
 
 
@@ -924,7 +924,7 @@ 
 		// cycle thru settings
 		foreach ( self::$_settings as $settings ) {
 			if ( ! empty( $settings['pue_options'] ) ) {
-                // initiate the class and start the plugin update engine!
+				// initiate the class and start the plugin update engine!
 				new PluginUpdateEngineChecker(
 				// host file URL
 					'https://eventespresso.com',
@@ -960,11 +960,11 @@ 
 	 */
 	public static function register_message_types() {
 		foreach ( self::$_settings as $addon_name => $settings ) {
-		    if ( ! empty($settings['message_types'])) {
-                foreach ((array)$settings['message_types'] as $message_type => $message_type_settings) {
-                    EE_Register_Message_Type::register($message_type, $message_type_settings);
-                }
-            }
+			if ( ! empty($settings['message_types'])) {
+				foreach ((array)$settings['message_types'] as $message_type => $message_type_settings) {
+					EE_Register_Message_Type::register($message_type, $message_type_settings);
+				}
+			}
 		}
 	}
 
@@ -980,7 +980,7 @@ 
 	 */
 	public static function deregister( $addon_name = null ) {
 		if ( isset( self::$_settings[ $addon_name ] ) ) {
-		    do_action('AHEE__EE_Register_Addon__deregister__before', $addon_name);
+			do_action('AHEE__EE_Register_Addon__deregister__before', $addon_name);
 			$class_name = self::$_settings[ $addon_name ]['class_name'];
 			if ( ! empty( self::$_settings[ $addon_name ]['dms_paths'] ) ) {
 				// setup DMS
@@ -1007,15 +1007,15 @@ 
 				EE_Register_Widget::deregister( $addon_name );
 			}
 			if ( ! empty( self::$_settings[ $addon_name ]['model_paths'] )
-			     ||
-			     ! empty( self::$_settings[ $addon_name ]['class_paths'] )
+				 ||
+				 ! empty( self::$_settings[ $addon_name ]['class_paths'] )
 			) {
 				// add to list of shortcodes to be registered
 				EE_Register_Model::deregister( $addon_name );
 			}
 			if ( ! empty( self::$_settings[ $addon_name ]['model_extension_paths'] )
-			     ||
-			     ! empty( self::$_settings[ $addon_name ]['class_extension_paths'] )
+				 ||
+				 ! empty( self::$_settings[ $addon_name ]['class_extension_paths'] )
 			) {
 				// add to list of shortcodes to be registered
 				EE_Register_Model_Extensions::deregister( $addon_name );
@@ -1046,7 +1046,7 @@ 
 				array( EE_Registry::instance()->addons->{$class_name}, 'initialize_db_if_no_migrations_required' )
 			);
 			unset( EE_Registry::instance()->addons->{$class_name}, self::$_settings[ $addon_name ] );
-            do_action('AHEE__EE_Register_Addon__deregister__after', $addon_name);
+			do_action('AHEE__EE_Register_Addon__deregister__after', $addon_name);
 		}
 	}
 

Spacing +119 added lines, -119 removed lines

@@ -1,5 +1,5 @@ 
-<?php if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -61,23 +61,23 @@ 
 	 * @param string $min_core_version
 	 * @return string always like '4.3.0.rc.000'
 	 */
-	protected static function _effective_version( $min_core_version ) {
+	protected static function _effective_version($min_core_version) {
 		// versions: 4 . 3 . 1 . p . 123
 		// offsets:    0 . 1 . 2 . 3 . 4
-		$version_parts = explode( '.', $min_core_version );
+		$version_parts = explode('.', $min_core_version);
 		//check they specified the micro version (after 2nd period)
-		if ( ! isset( $version_parts[2] ) ) {
+		if ( ! isset($version_parts[2])) {
 			$version_parts[2] = '0';
 		}
 		//if they didn't specify the 'p', or 'rc' part. Just assume the lowest possible
 		//soon we can assume that's 'rc', but this current version is 'alpha'
-		if ( ! isset( $version_parts[3] ) ) {
+		if ( ! isset($version_parts[3])) {
 			$version_parts[3] = 'dev';
 		}
-		if ( ! isset( $version_parts[4] ) ) {
+		if ( ! isset($version_parts[4])) {
 			$version_parts[4] = '000';
 		}
-		return implode( '.', $version_parts );
+		return implode('.', $version_parts);
 	}
 
 
@@ -94,8 +94,8 @@ 
 		$actual_core_version = EVENT_ESPRESSO_VERSION
 	) {
 		return version_compare(
-			self::_effective_version( $actual_core_version ),
-			self::_effective_version( $min_core_version ),
+			self::_effective_version($actual_core_version),
+			self::_effective_version($min_core_version),
 			'>='
 		);
 	}
@@ -217,7 +217,7 @@ 
 	 * @throws EE_Error
 	 * @return void
 	 */
-	public static function register( $addon_name = '', $setup_args = array() ) {
+	public static function register($addon_name = '', $setup_args = array()) {
 		// required fields MUST be present, so let's make sure they are.
         \EE_Register_Addon::_verify_parameters($addon_name, $setup_args);
         // get class name for addon
@@ -227,13 +227,13 @@ 
         // setup PUE
         \EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args);
         // does this addon work with this version of core or WordPress ?
-        if ( ! \EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings) ) {
+        if ( ! \EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
             return;
 		}
 		// register namespaces
         \EE_Register_Addon::_setup_namespaces($addon_settings);
         // check if this is an activation request
-        if ( \EE_Register_Addon::_addon_activation($addon_name, $addon_settings)) {
+        if (\EE_Register_Addon::_addon_activation($addon_name, $addon_settings)) {
             // dont bother setting up the rest of the addon atm
             return;
         }
@@ -327,7 +327,7 @@ 
         } else {
             $class_name = $setup_args['class_name'];
         }
-        return strpos($class_name, 'EE_') === 0 ? $class_name : 'EE_' . $class_name;
+        return strpos($class_name, 'EE_') === 0 ? $class_name : 'EE_'.$class_name;
     }
 
 
@@ -345,105 +345,105 @@ 
             'class_name'            => $class_name,
             // the addon slug for use in URLs, etc
             'plugin_slug'           => isset($setup_args['plugin_slug'])
-                ? (string)$setup_args['plugin_slug']
+                ? (string) $setup_args['plugin_slug']
                 : '',
             // page slug to be used when generating the "Settings" link on the WP plugin page
             'plugin_action_slug'    => isset($setup_args['plugin_action_slug'])
-                ? (string)$setup_args['plugin_action_slug']
+                ? (string) $setup_args['plugin_action_slug']
                 : '',
             // the "software" version for the addon
             'version'               => isset($setup_args['version'])
-                ? (string)$setup_args['version']
+                ? (string) $setup_args['version']
                 : '',
             // the minimum version of EE Core that the addon will work with
             'min_core_version'      => isset($setup_args['min_core_version'])
-                ? (string)$setup_args['min_core_version']
+                ? (string) $setup_args['min_core_version']
                 : '',
             // the minimum version of WordPress that the addon will work with
             'min_wp_version'        => isset($setup_args['min_wp_version'])
-                ? (string)$setup_args['min_wp_version']
+                ? (string) $setup_args['min_wp_version']
                 : EE_MIN_WP_VER_REQUIRED,
             // full server path to main file (file loaded directly by WP)
             'main_file_path'        => isset($setup_args['main_file_path'])
-                ? (string)$setup_args['main_file_path']
+                ? (string) $setup_args['main_file_path']
                 : '',
             // path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages
             'admin_path'            => isset($setup_args['admin_path'])
-                ? (string)$setup_args['admin_path'] : '',
+                ? (string) $setup_args['admin_path'] : '',
             // a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page
             'admin_callback'        => isset($setup_args['admin_callback'])
-                ? (string)$setup_args['admin_callback']
+                ? (string) $setup_args['admin_callback']
                 : '',
             // the section name for this addon's configuration settings section (defaults to "addons")
             'config_section'        => isset($setup_args['config_section'])
-                ? (string)$setup_args['config_section']
+                ? (string) $setup_args['config_section']
                 : 'addons',
             // the class name for this addon's configuration settings object
             'config_class'          => isset($setup_args['config_class'])
-                ? (string)$setup_args['config_class'] : '',
+                ? (string) $setup_args['config_class'] : '',
             //the name given to the config for this addons' configuration settings object (optional)
             'config_name'           => isset($setup_args['config_name'])
-                ? (string)$setup_args['config_name'] : '',
+                ? (string) $setup_args['config_name'] : '',
             // an array of "class names" => "full server paths" for any classes that might be invoked by the addon
             'autoloader_paths'      => isset($setup_args['autoloader_paths'])
-                ? (array)$setup_args['autoloader_paths']
+                ? (array) $setup_args['autoloader_paths']
                 : array(),
             // an array of  "full server paths" for any folders containing classes that might be invoked by the addon
             'autoloader_folders'    => isset($setup_args['autoloader_folders'])
-                ? (array)$setup_args['autoloader_folders']
+                ? (array) $setup_args['autoloader_folders']
                 : array(),
             // array of full server paths to any EE_DMS data migration scripts used by the addon
             'dms_paths'             => isset($setup_args['dms_paths'])
-                ? (array)$setup_args['dms_paths']
+                ? (array) $setup_args['dms_paths']
                 : array(),
             // array of full server paths to any EED_Modules used by the addon
             'module_paths'          => isset($setup_args['module_paths'])
-                ? (array)$setup_args['module_paths']
+                ? (array) $setup_args['module_paths']
                 : array(),
             // array of full server paths to any EES_Shortcodes used by the addon
             'shortcode_paths'       => isset($setup_args['shortcode_paths'])
-                ? (array)$setup_args['shortcode_paths']
+                ? (array) $setup_args['shortcode_paths']
                 : array(),
             // array of full server paths to any WP_Widgets used by the addon
             'widget_paths'          => isset($setup_args['widget_paths'])
-                ? (array)$setup_args['widget_paths']
+                ? (array) $setup_args['widget_paths']
                 : array(),
             // array of PUE options used by the addon
             'pue_options'           => isset($setup_args['pue_options'])
-                ? (array)$setup_args['pue_options']
+                ? (array) $setup_args['pue_options']
                 : array(),
             'message_types'         => isset($setup_args['message_types'])
-                ? (array)$setup_args['message_types']
+                ? (array) $setup_args['message_types']
                 : array(),
             'capabilities'          => isset($setup_args['capabilities'])
-                ? (array)$setup_args['capabilities']
+                ? (array) $setup_args['capabilities']
                 : array(),
             'capability_maps'       => isset($setup_args['capability_maps'])
-                ? (array)$setup_args['capability_maps']
+                ? (array) $setup_args['capability_maps']
                 : array(),
             'model_paths'           => isset($setup_args['model_paths'])
-                ? (array)$setup_args['model_paths']
+                ? (array) $setup_args['model_paths']
                 : array(),
             'class_paths'           => isset($setup_args['class_paths'])
-                ? (array)$setup_args['class_paths']
+                ? (array) $setup_args['class_paths']
                 : array(),
             'model_extension_paths' => isset($setup_args['model_extension_paths'])
-                ? (array)$setup_args['model_extension_paths']
+                ? (array) $setup_args['model_extension_paths']
                 : array(),
             'class_extension_paths' => isset($setup_args['class_extension_paths'])
-                ? (array)$setup_args['class_extension_paths']
+                ? (array) $setup_args['class_extension_paths']
                 : array(),
             'custom_post_types'     => isset($setup_args['custom_post_types'])
-                ? (array)$setup_args['custom_post_types']
+                ? (array) $setup_args['custom_post_types']
                 : array(),
             'custom_taxonomies'     => isset($setup_args['custom_taxonomies'])
-                ? (array)$setup_args['custom_taxonomies']
+                ? (array) $setup_args['custom_taxonomies']
                 : array(),
             'payment_method_paths'  => isset($setup_args['payment_method_paths'])
-                ? (array)$setup_args['payment_method_paths']
+                ? (array) $setup_args['payment_method_paths']
                 : array(),
             'default_terms'         => isset($setup_args['default_terms'])
-                ? (array)$setup_args['default_terms']
+                ? (array) $setup_args['default_terms']
                 : array(),
             // if not empty, inserts a new table row after this plugin's row on the WP Plugins page
             // that can be used for adding upgrading/marketing info
@@ -455,7 +455,7 @@ 
                 $setup_args['namespace']['FQNS'],
                 $setup_args['namespace']['DIR']
             )
-                ? (array)$setup_args['namespace']
+                ? (array) $setup_args['namespace']
                 : array(),
         );
         // if plugin_action_slug is NOT set, but an admin page path IS set,
@@ -476,7 +476,7 @@ 
      * @param array  $addon_settings
      * @return boolean
      */
-	private static function _addon_is_compatible( $addon_name, array $addon_settings ) {
+	private static function _addon_is_compatible($addon_name, array $addon_settings) {
         global $wp_version;
         $incompatibility_message = '';
         //check whether this addon version is compatible with EE core
@@ -552,20 +552,20 @@ 
      * @param array  $setup_args
      * @return void
      */
-	private static function _parse_pue_options( $addon_name, $class_name, array $setup_args ) {
+	private static function _parse_pue_options($addon_name, $class_name, array $setup_args) {
         if ( ! empty($setup_args['pue_options'])) {
             self::$_settings[$addon_name]['pue_options'] = array(
                 'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug'])
-                    ? (string)$setup_args['pue_options']['pue_plugin_slug']
-                    : 'espresso_' . strtolower($class_name),
+                    ? (string) $setup_args['pue_options']['pue_plugin_slug']
+                    : 'espresso_'.strtolower($class_name),
                 'plugin_basename' => isset($setup_args['pue_options']['plugin_basename'])
-                    ? (string)$setup_args['pue_options']['plugin_basename']
+                    ? (string) $setup_args['pue_options']['plugin_basename']
                     : plugin_basename($setup_args['main_file_path']),
                 'checkPeriod'     => isset($setup_args['pue_options']['checkPeriod'])
-                    ? (string)$setup_args['pue_options']['checkPeriod']
+                    ? (string) $setup_args['pue_options']['checkPeriod']
                     : '24',
                 'use_wp_update'   => isset($setup_args['pue_options']['use_wp_update'])
-                    ? (string)$setup_args['pue_options']['use_wp_update']
+                    ? (string) $setup_args['pue_options']['use_wp_update']
                     : false,
             );
             add_action(
@@ -607,7 +607,7 @@ 
      * @param array  $addon_settings
      * @return bool
      */
-	private static function _addon_activation( $addon_name, array $addon_settings ) {
+	private static function _addon_activation($addon_name, array $addon_settings) {
         // this is an activation request
         if (did_action('activate_plugin')) {
             //to find if THIS is the addon that was activated,
@@ -664,7 +664,7 @@ 
         }
         // setup autoloaders for folders
         if ( ! empty(self::$_settings[$addon_name]['autoloader_folders'])) {
-            foreach ((array)self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) {
+            foreach ((array) self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) {
                 EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder);
             }
         }
@@ -679,7 +679,7 @@ 
      * @return void
      * @throws \EE_Error
      */
-	private static function _register_models_and_extensions( $addon_name ) {
+	private static function _register_models_and_extensions($addon_name) {
         // register new models
         if (
             ! empty(self::$_settings[$addon_name]['model_paths'])
@@ -715,7 +715,7 @@ 
      * @return void
      * @throws \EE_Error
      */
-	private static function _register_data_migration_scripts( $addon_name ) {
+	private static function _register_data_migration_scripts($addon_name) {
         // setup DMS
         if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) {
             EE_Register_Data_Migration_Scripts::register(
@@ -731,7 +731,7 @@ 
      * @return void
      * @throws \EE_Error
      */
-	private static function _register_config( $addon_name ) {
+	private static function _register_config($addon_name) {
         // if config_class is present let's register config.
         if ( ! empty(self::$_settings[$addon_name]['config_class'])) {
             EE_Register_Config::register(
@@ -750,7 +750,7 @@ 
      * @return void
      * @throws \EE_Error
      */
-	private static function _register_admin_pages( $addon_name ) {
+	private static function _register_admin_pages($addon_name) {
         if ( ! empty(self::$_settings[$addon_name]['admin_path'])) {
             EE_Register_Admin_Page::register(
                 $addon_name,
@@ -765,7 +765,7 @@ 
      * @return void
      * @throws \EE_Error
      */
-	private static function _register_modules( $addon_name ) {
+	private static function _register_modules($addon_name) {
         if ( ! empty(self::$_settings[$addon_name]['module_paths'])) {
             EE_Register_Module::register(
                 $addon_name,
@@ -780,7 +780,7 @@ 
      * @return void
      * @throws \EE_Error
      */
-	private static function _register_shortcodes( $addon_name ) {
+	private static function _register_shortcodes($addon_name) {
         if ( ! empty(self::$_settings[$addon_name]['shortcode_paths'])) {
             EE_Register_Shortcode::register(
                 $addon_name,
@@ -795,7 +795,7 @@ 
      * @return void
      * @throws \EE_Error
      */
-	private static function _register_widgets( $addon_name ) {
+	private static function _register_widgets($addon_name) {
         if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) {
             EE_Register_Widget::register(
                 $addon_name,
@@ -810,7 +810,7 @@ 
      * @return void
      * @throws \EE_Error
      */
-	private static function _register_capabilities( $addon_name ) {
+	private static function _register_capabilities($addon_name) {
         if ( ! empty(self::$_settings[$addon_name]['capabilities'])) {
             EE_Register_Capabilities::register(
                 $addon_name,
@@ -828,7 +828,7 @@ 
      * @return void
      * @throws \EE_Error
      */
-	private static function _register_message_types( $addon_name ) {
+	private static function _register_message_types($addon_name) {
         if ( ! empty(self::$_settings[$addon_name]['message_types'])) {
             add_action(
                 'EE_Brewing_Regular___messages_caf',
@@ -843,7 +843,7 @@ 
      * @return void
      * @throws \EE_Error
      */
-	private static function _register_custom_post_types( $addon_name ) {
+	private static function _register_custom_post_types($addon_name) {
         if (
             ! empty(self::$_settings[$addon_name]['custom_post_types'])
             || ! empty(self::$_settings[$addon_name]['custom_taxonomies'])
@@ -865,7 +865,7 @@ 
      * @return void
      * @throws \EE_Error
      */
-	private static function _register_payment_methods( $addon_name ) {
+	private static function _register_payment_methods($addon_name) {
         if ( ! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
             EE_Register_Payment_Method::register(
                 $addon_name,
@@ -882,25 +882,25 @@ 
 	 * @param string $addon_name
 	 * @return EE_Addon
 	 */
-	private static function _load_and_init_addon_class( $addon_name ) {
+	private static function _load_and_init_addon_class($addon_name) {
 		$addon = EE_Registry::instance()->load_addon(
-			dirname( self::$_settings[ $addon_name ]['main_file_path'] ),
-			self::$_settings[ $addon_name ]['class_name']
+			dirname(self::$_settings[$addon_name]['main_file_path']),
+			self::$_settings[$addon_name]['class_name']
 		);
-		$addon->set_name( $addon_name );
-		$addon->set_plugin_slug( self::$_settings[ $addon_name ]['plugin_slug'] );
-		$addon->set_plugin_basename( self::$_settings[ $addon_name ]['plugin_basename'] );
-		$addon->set_main_plugin_file( self::$_settings[ $addon_name ]['main_file_path'] );
-		$addon->set_plugin_action_slug( self::$_settings[ $addon_name ]['plugin_action_slug'] );
-		$addon->set_plugins_page_row( self::$_settings[ $addon_name ]['plugins_page_row'] );
-		$addon->set_version( self::$_settings[ $addon_name ]['version'] );
-		$addon->set_min_core_version( self::_effective_version( self::$_settings[ $addon_name ]['min_core_version'] ) );
-		$addon->set_config_section( self::$_settings[ $addon_name ]['config_section'] );
-		$addon->set_config_class( self::$_settings[ $addon_name ]['config_class'] );
-		$addon->set_config_name( self::$_settings[ $addon_name ]['config_name'] );
+		$addon->set_name($addon_name);
+		$addon->set_plugin_slug(self::$_settings[$addon_name]['plugin_slug']);
+		$addon->set_plugin_basename(self::$_settings[$addon_name]['plugin_basename']);
+		$addon->set_main_plugin_file(self::$_settings[$addon_name]['main_file_path']);
+		$addon->set_plugin_action_slug(self::$_settings[$addon_name]['plugin_action_slug']);
+		$addon->set_plugins_page_row(self::$_settings[$addon_name]['plugins_page_row']);
+		$addon->set_version(self::$_settings[$addon_name]['version']);
+		$addon->set_min_core_version(self::_effective_version(self::$_settings[$addon_name]['min_core_version']));
+		$addon->set_config_section(self::$_settings[$addon_name]['config_section']);
+		$addon->set_config_class(self::$_settings[$addon_name]['config_class']);
+		$addon->set_config_name(self::$_settings[$addon_name]['config_name']);
 		//unfortunately this can't be hooked in upon construction, because we don't have
 		//the plugin mainfile's path upon construction.
-		register_deactivation_hook( $addon->get_main_plugin_file(), array( $addon, 'deactivation' ) );
+		register_deactivation_hook($addon->get_main_plugin_file(), array($addon, 'deactivation'));
         // call any additional admin_callback functions during load_admin_controller hook
         if ( ! empty(self::$_settings[$addon_name]['admin_callback'])) {
             add_action(
@@ -920,18 +920,18 @@ 
 	 */
 	public static function load_pue_update() {
 		// load PUE client
-		require_once EE_THIRD_PARTY . 'pue' . DS . 'pue-client.php';
+		require_once EE_THIRD_PARTY.'pue'.DS.'pue-client.php';
 		// cycle thru settings
-		foreach ( self::$_settings as $settings ) {
-			if ( ! empty( $settings['pue_options'] ) ) {
+		foreach (self::$_settings as $settings) {
+			if ( ! empty($settings['pue_options'])) {
                 // initiate the class and start the plugin update engine!
 				new PluginUpdateEngineChecker(
 				// host file URL
 					'https://eventespresso.com',
 					// plugin slug(s)
 					array(
-						'premium'    => array( 'p' => $settings['pue_options']['pue_plugin_slug'] ),
-						'prerelease' => array( 'beta' => $settings['pue_options']['pue_plugin_slug'] . '-pr' ),
+						'premium'    => array('p' => $settings['pue_options']['pue_plugin_slug']),
+						'prerelease' => array('beta' => $settings['pue_options']['pue_plugin_slug'].'-pr'),
 					),
 					// options
 					array(
@@ -959,9 +959,9 @@ 
 	 * @throws \EE_Error
 	 */
 	public static function register_message_types() {
-		foreach ( self::$_settings as $addon_name => $settings ) {
+		foreach (self::$_settings as $addon_name => $settings) {
 		    if ( ! empty($settings['message_types'])) {
-                foreach ((array)$settings['message_types'] as $message_type => $message_type_settings) {
+                foreach ((array) $settings['message_types'] as $message_type => $message_type_settings) {
                     EE_Register_Message_Type::register($message_type, $message_type_settings);
                 }
             }
@@ -978,74 +978,74 @@ 
 	 * @throws EE_Error
 	 * @return void
 	 */
-	public static function deregister( $addon_name = null ) {
-		if ( isset( self::$_settings[ $addon_name ] ) ) {
+	public static function deregister($addon_name = null) {
+		if (isset(self::$_settings[$addon_name])) {
 		    do_action('AHEE__EE_Register_Addon__deregister__before', $addon_name);
-			$class_name = self::$_settings[ $addon_name ]['class_name'];
-			if ( ! empty( self::$_settings[ $addon_name ]['dms_paths'] ) ) {
+			$class_name = self::$_settings[$addon_name]['class_name'];
+			if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) {
 				// setup DMS
-				EE_Register_Data_Migration_Scripts::deregister( $addon_name );
+				EE_Register_Data_Migration_Scripts::deregister($addon_name);
 			}
-			if ( ! empty( self::$_settings[ $addon_name ]['admin_path'] ) ) {
+			if ( ! empty(self::$_settings[$addon_name]['admin_path'])) {
 				// register admin page
-				EE_Register_Admin_Page::deregister( $addon_name );
+				EE_Register_Admin_Page::deregister($addon_name);
 			}
-			if ( ! empty( self::$_settings[ $addon_name ]['module_paths'] ) ) {
+			if ( ! empty(self::$_settings[$addon_name]['module_paths'])) {
 				// add to list of modules to be registered
-				EE_Register_Module::deregister( $addon_name );
+				EE_Register_Module::deregister($addon_name);
 			}
-			if ( ! empty( self::$_settings[ $addon_name ]['shortcode_paths'] ) ) {
+			if ( ! empty(self::$_settings[$addon_name]['shortcode_paths'])) {
 				// add to list of shortcodes to be registered
-				EE_Register_Shortcode::deregister( $addon_name );
+				EE_Register_Shortcode::deregister($addon_name);
 			}
-			if ( ! empty( self::$_settings[ $addon_name ]['config_class'] ) ) {
+			if ( ! empty(self::$_settings[$addon_name]['config_class'])) {
 				// if config_class present let's register config.
-				EE_Register_Config::deregister( self::$_settings[ $addon_name ]['config_class'] );
+				EE_Register_Config::deregister(self::$_settings[$addon_name]['config_class']);
 			}
-			if ( ! empty( self::$_settings[ $addon_name ]['widget_paths'] ) ) {
+			if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) {
 				// add to list of widgets to be registered
-				EE_Register_Widget::deregister( $addon_name );
+				EE_Register_Widget::deregister($addon_name);
 			}
-			if ( ! empty( self::$_settings[ $addon_name ]['model_paths'] )
+			if ( ! empty(self::$_settings[$addon_name]['model_paths'])
 			     ||
-			     ! empty( self::$_settings[ $addon_name ]['class_paths'] )
+			     ! empty(self::$_settings[$addon_name]['class_paths'])
 			) {
 				// add to list of shortcodes to be registered
-				EE_Register_Model::deregister( $addon_name );
+				EE_Register_Model::deregister($addon_name);
 			}
-			if ( ! empty( self::$_settings[ $addon_name ]['model_extension_paths'] )
+			if ( ! empty(self::$_settings[$addon_name]['model_extension_paths'])
 			     ||
-			     ! empty( self::$_settings[ $addon_name ]['class_extension_paths'] )
+			     ! empty(self::$_settings[$addon_name]['class_extension_paths'])
 			) {
 				// add to list of shortcodes to be registered
-				EE_Register_Model_Extensions::deregister( $addon_name );
+				EE_Register_Model_Extensions::deregister($addon_name);
 			}
-			if ( ! empty( self::$_settings[ $addon_name ]['message_types'] ) ) {
-				foreach ((array)self::$_settings[ $addon_name ]['message_types'] as $message_type => $message_type_settings )
+			if ( ! empty(self::$_settings[$addon_name]['message_types'])) {
+				foreach ((array) self::$_settings[$addon_name]['message_types'] as $message_type => $message_type_settings)
 				{
-					EE_Register_Message_Type::deregister( $message_type );
+					EE_Register_Message_Type::deregister($message_type);
 				}
 			}
 			//deregister capabilities for addon
 			if (
-				! empty( self::$_settings[ $addon_name ]['capabilities'] )
-				|| ! empty( self::$_settings[ $addon_name ]['capability_maps'] )
+				! empty(self::$_settings[$addon_name]['capabilities'])
+				|| ! empty(self::$_settings[$addon_name]['capability_maps'])
 			) {
-				EE_Register_Capabilities::deregister( $addon_name );
+				EE_Register_Capabilities::deregister($addon_name);
 			}
 			//deregister custom_post_types for addon
-			if ( ! empty( self::$_settings[ $addon_name ]['custom_post_types'] ) ) {
-				EE_Register_CPT::deregister( $addon_name );
+			if ( ! empty(self::$_settings[$addon_name]['custom_post_types'])) {
+				EE_Register_CPT::deregister($addon_name);
 			}
 			remove_action(
-				'deactivate_' . EE_Registry::instance()->addons->{$class_name}->get_main_plugin_file_basename(),
-				array( EE_Registry::instance()->addons->{$class_name}, 'deactivation' )
+				'deactivate_'.EE_Registry::instance()->addons->{$class_name}->get_main_plugin_file_basename(),
+				array(EE_Registry::instance()->addons->{$class_name}, 'deactivation')
 			);
 			remove_action(
 				'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-				array( EE_Registry::instance()->addons->{$class_name}, 'initialize_db_if_no_migrations_required' )
+				array(EE_Registry::instance()->addons->{$class_name}, 'initialize_db_if_no_migrations_required')
 			);
-			unset( EE_Registry::instance()->addons->{$class_name}, self::$_settings[ $addon_name ] );
+			unset(EE_Registry::instance()->addons->{$class_name}, self::$_settings[$addon_name]);
             do_action('AHEE__EE_Register_Addon__deregister__after', $addon_name);
 		}
 	}

modules/ticket_sales_monitor/EED_Ticket_Sales_Monitor.module.php

Indentation +915 added lines, -915 removed lines

@@ -2,7 +2,7 @@ 
 use EventEspresso\core\exceptions\UnexpectedEntityException;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -21,920 +21,920 @@ 
 class EED_Ticket_Sales_Monitor extends EED_Module
 {
 
-    const debug = false;    //	true false
-
-    /**
-     * an array of raw ticket data from EED_Ticket_Selector
-     *
-     * @var array $ticket_selections
-     */
-    protected $ticket_selections = array();
-
-    /**
-     * the raw ticket data from EED_Ticket_Selector is organized in rows
-     * according to how they are displayed in the actual Ticket_Selector
-     * this tracks the current row being processed
-     *
-     * @var int $current_row
-     */
-    protected $current_row = 0;
-
-    /**
-     * an array for tracking names of tickets that have sold out
-     *
-     * @var array $sold_out_tickets
-     */
-    protected $sold_out_tickets = array();
-
-    /**
-     * an array for tracking names of tickets that have had their quantities reduced
-     *
-     * @var array $decremented_tickets
-     */
-    protected $decremented_tickets = array();
-
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        // release tickets for expired carts
-        add_action('EED_Ticket_Selector__process_ticket_selections__before',
-            array('EED_Ticket_Sales_Monitor', 'release_tickets_for_expired_carts'),
-            1
-        );
-        // check ticket reserves AFTER MER does it's check (hence priority 20)
-        add_filter('FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty',
-            array('EED_Ticket_Sales_Monitor', 'validate_ticket_sale'),
-            20, 3
-        );
-        // add notices for sold out tickets
-        add_action('AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
-            array('EED_Ticket_Sales_Monitor', 'post_notices'),
-            10
-        );
-        // handle ticket quantities adjusted in cart
-        //add_action(
-        //	'FHEE__EED_Multi_Event_Registration__adjust_line_item_quantity__line_item_quantity_updated',
-        //	array( 'EED_Ticket_Sales_Monitor', 'ticket_quantity_updated' ),
-        //	10, 2
-        //);
-        // handle tickets deleted from cart
-        add_action(
-            'FHEE__EED_Multi_Event_Registration__delete_ticket__ticket_removed_from_cart',
-            array('EED_Ticket_Sales_Monitor', 'ticket_removed_from_cart'),
-            10, 2
-        );
-        // handle emptied carts
-        add_action(
-            'AHEE__EE_Session__reset_cart__before_reset',
-            array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
-            10, 1
-        );
-        add_action(
-            'AHEE__EED_Multi_Event_Registration__empty_event_cart__before_delete_cart',
-            array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
-            10, 1
-        );
-        // handle cancelled registrations
-        add_action(
-            'AHEE__EE_Session__reset_checkout__before_reset',
-            array('EED_Ticket_Sales_Monitor', 'session_checkout_reset'),
-            10, 1
-        );
-        // cron tasks
-        add_action(
-            'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions__abandoned_transaction',
-            array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
-            10, 1
-        );
-        add_action(
-            'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
-            array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
-            10, 1
-        );
-        add_action(
-            'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
-            array('EED_Ticket_Sales_Monitor', 'process_failed_transactions'),
-            10, 1
-        );
-    }
-
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        EED_Ticket_Sales_Monitor::set_hooks();
-    }
-
-
-
-    /**
-     * @return EED_Ticket_Sales_Monitor|EED_Module
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-
-    /**
-     *    run
-     *
-     * @access    public
-     * @param WP_Query $WP_Query
-     * @return    void
-     */
-    public function run($WP_Query)
-    {
-    }
-
-
-
-    /********************************** PRE_TICKET_SALES  **********************************/
-
-
-
-    /**
-     * Retrieves grand totals from the line items that have no TXN ID
-     * and timestamps less than the current time minus the session lifespan.
-     * These are carts that have been abandoned before the "registrant" even attempted to checkout.
-     * We're going to release the tickets for these line items before attempting to add more to the cart.
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    public static function release_tickets_for_expired_carts()
-    {
-        $expired_ticket_IDs = array();
-        $valid_ticket_line_items = array();
-        $total_line_items = EEM_Line_Item::instance()->get_total_line_items_with_no_transaction();
-        if(empty($total_line_items)){
-            return;
-        }
-        $expired = current_time('timestamp') - EE_Registry::instance()->SSN->lifespan();
-        foreach ($total_line_items as $total_line_item) {
-            /** @var EE_Line_Item $total_line_item */
-            $ticket_line_items = EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total($total_line_item);
-            foreach ($ticket_line_items as $ticket_line_item) {
-                if(! $ticket_line_item instanceof EE_Line_Item) {
-                    continue;
-                }
-                if ($total_line_item->timestamp(true) <= $expired ) {
-                    $expired_ticket_IDs[$ticket_line_item->OBJ_ID()] = $ticket_line_item->OBJ_ID();
-                } else {
-                    $valid_ticket_line_items[$ticket_line_item->OBJ_ID()] = $ticket_line_item;
-                }
-            }
-        }
-        EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
-            \EEM_Ticket::instance()->get_tickets_with_IDs($expired_ticket_IDs),
-            $valid_ticket_line_items
-        );
-    }
-
-
-
-    /********************************** VALIDATE_TICKET_SALE  **********************************/
-
-
-
-    /**
-     *    validate_ticket_sales
-     *    callback for 'FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data'
-     *
-     * @access    public
-     * @param int $qty
-     * @param \EE_Ticket $ticket
-     * @return bool
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    public static function validate_ticket_sale($qty = 1, EE_Ticket $ticket)
-    {
-        $qty = absint($qty);
-        if ($qty > 0) {
-            $qty = EED_Ticket_Sales_Monitor::instance()->_validate_ticket_sale($ticket, $qty);
-        }
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '()';
-            echo '<br /><br /><b> RETURNED QTY: ' . $qty . '</b>';
-        }
-        return $qty;
-    }
-
-
-
-    /**
-     *    _validate_ticket_sale
-     * checks whether an individual ticket is available for purchase based on datetime, and ticket details
-     *
-     * @access    protected
-     * @param   \EE_Ticket $ticket
-     * @param int          $qty
-     * @return int
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _validate_ticket_sale(EE_Ticket $ticket, $qty = 1)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        if ( ! $ticket instanceof EE_Ticket) {
-            return 0;
-        }
-        if (self::debug) {
-            echo '<br /><b> . ticket->ID: ' . $ticket->ID() . '</b>';
-            echo '<br /> . original ticket->reserved: ' . $ticket->reserved();
-        }
-        $ticket->refresh_from_db();
-        // first let's determine the ticket availability based on sales
-        $available = $ticket->qty('saleable');
-        if (self::debug) {
-            echo '<br /> . . . ticket->qty: ' . $ticket->qty();
-            echo '<br /> . . . ticket->sold: ' . $ticket->sold();
-            echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
-            echo '<br /> . . . ticket->qty(saleable): ' . $ticket->qty('saleable');
-            echo '<br /> . . . available: ' . $available;
-        }
-        if ($available < 1) {
-            $this->_ticket_sold_out($ticket);
-            return 0;
-        }
-        if (self::debug) {
-            echo '<br /> . . . qty: ' . $qty;
-        }
-        if ($available < $qty) {
-            $qty = $available;
-            if (self::debug) {
-                echo '<br /> . . . QTY ADJUSTED: ' . $qty;
-            }
-            $this->_ticket_quantity_decremented($ticket);
-        }
-        $this->_reserve_ticket($ticket, $qty);
-        return $qty;
-    }
-
-
-
-    /**
-     *  _reserve_ticket
-     *    increments ticket reserved based on quantity passed
-     *
-     * @access    protected
-     * @param    \EE_Ticket $ticket
-     * @param int           $quantity
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function _reserve_ticket(EE_Ticket $ticket, $quantity = 1)
-    {
-        if (self::debug) {
-            echo '<br /><br /> . . . INCREASE RESERVED: ' . $quantity;
-        }
-        $ticket->increase_reserved($quantity);
-        return $ticket->save();
-    }
-
-
-
-    /**
-     * _release_reserved_ticket
-     *
-     * @access protected
-     * @param  EE_Ticket $ticket
-     * @param  int       $quantity
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function _release_reserved_ticket(EE_Ticket $ticket, $quantity = 1)
-    {
-        if (self::debug) {
-            echo '<br /> . . . ticket->ID: ' . $ticket->ID();
-            echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
-        }
-        $ticket->decrease_reserved($quantity);
-        if (self::debug) {
-            echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
-        }
-        return $ticket->save() ? 1 : 0;
-    }
-
-
-
-    /**
-     *    _ticket_sold_out
-     *    removes quantities within the ticket selector based on zero ticket availability
-     *
-     * @access    protected
-     * @param    \EE_Ticket $ticket
-     * @return    void
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _ticket_sold_out(EE_Ticket $ticket)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo '<br /> . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
-        }
-        $this->sold_out_tickets[] = $this->_get_ticket_and_event_name($ticket);
-    }
-
-
-
-    /**
-     *    _ticket_quantity_decremented
-     *    adjusts quantities within the ticket selector based on decreased ticket availability
-     *
-     * @access    protected
-     * @param    \EE_Ticket $ticket
-     * @return void
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _ticket_quantity_decremented(EE_Ticket $ticket)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo '<br /> . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
-        }
-        $this->decremented_tickets[] = $this->_get_ticket_and_event_name($ticket);
-    }
-
-
-
-    /**
-     *    _get_ticket_and_event_name
-     *    builds string out of ticket and event name
-     *
-     * @access    protected
-     * @param    \EE_Ticket $ticket
-     * @return string
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _get_ticket_and_event_name(EE_Ticket $ticket)
-    {
-        $event = $ticket->get_related_event();
-        if ($event instanceof EE_Event) {
-            $ticket_name = sprintf(
-                _x('%1$s for %2$s', 'ticket name for event name', 'event_espresso'),
-                $ticket->name(),
-                $event->name()
-            );
-        } else {
-            $ticket_name = $ticket->name();
-        }
-        return $ticket_name;
-    }
-
-
-
-    /********************************** EVENT CART  **********************************/
-
-
-
-    /**
-     * ticket_quantity_updated
-     * releases or reserves ticket(s) based on quantity passed
-     *
-     * @access public
-     * @param  EE_Line_Item $line_item
-     * @param  int          $quantity
-     * @return void
-     * @throws EE_Error
-     */
-    public static function ticket_quantity_updated(EE_Line_Item $line_item, $quantity = 1)
-    {
-        $ticket = EEM_Ticket::instance()->get_one_by_ID(absint($line_item->OBJ_ID()));
-        if ($ticket instanceof EE_Ticket) {
-            if ($quantity > 0) {
-                EED_Ticket_Sales_Monitor::instance()->_reserve_ticket($ticket, $quantity);
-            } else {
-                EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
-            }
-        }
-    }
-
-
-
-    /**
-     * ticket_removed_from_cart
-     * releases reserved ticket(s) based on quantity passed
-     *
-     * @access public
-     * @param  EE_Ticket $ticket
-     * @param  int       $quantity
-     * @return void
-     * @throws EE_Error
-     */
-    public static function ticket_removed_from_cart(EE_Ticket $ticket, $quantity = 1)
-    {
-        EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
-    }
-
-
-
-    /********************************** POST_NOTICES  **********************************/
-
-
-
-    /**
-     *    post_notices
-     *
-     * @access    public
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function post_notices()
-    {
-        EED_Ticket_Sales_Monitor::instance()->_post_notices();
-    }
-
-
-
-    /**
-     *    _post_notices
-     *
-     * @access    protected
-     * @return    void
-     * @throws EE_Error
-     */
-    protected function _post_notices()
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        $refresh_msg = '';
-        $none_added_msg = '';
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $refresh_msg = __('Please refresh the page to view updated ticket quantities.',
-                'event_espresso');
-            $none_added_msg = __('No tickets were added for the event.', 'event_espresso');
-        }
-        if ( ! empty($this->sold_out_tickets)) {
-            EE_Error::add_attention(
-                sprintf(
-                    apply_filters(
-                        'FHEE__EED_Ticket_Sales_Monitor___post_notices__sold_out_tickets_notice',
-                        __('We\'re sorry...%1$sThe following items have sold out since you first viewed this page, and can no longer be registered for:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
-                            'event_espresso')
-                    ),
-                    '<br />',
-                    implode('<br />', $this->sold_out_tickets),
-                    $none_added_msg,
-                    $refresh_msg
-                )
-            );
-            // alter code flow in the Ticket Selector for better UX
-            add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', '__return_true');
-            add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__success', '__return_false');
-            $this->sold_out_tickets = array();
-            // and reset the cart
-            EED_Ticket_Sales_Monitor::session_cart_reset(EE_Registry::instance()->SSN);
-        }
-        if ( ! empty($this->decremented_tickets)) {
-            EE_Error::add_attention(
-                sprintf(
-                    apply_filters(
-                        'FHEE__EED_Ticket_Sales_Monitor___ticket_quantity_decremented__notice',
-                        __('We\'re sorry...%1$sDue to sales that have occurred since you first viewed the last page, the following items have had their quantities adjusted to match the current available amount:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
-                            'event_espresso')
-                    ),
-                    '<br />',
-                    implode('<br />', $this->decremented_tickets),
-                    $none_added_msg,
-                    $refresh_msg
-                )
-            );
-            $this->decremented_tickets = array();
-        }
-    }
-
-
-
-    /********************************** RELEASE_ALL_RESERVED_TICKETS_FOR_TRANSACTION  **********************************/
-
-
-
-    /**
-     *    _release_all_reserved_tickets_for_transaction
-     *    releases reserved tickets for all registrations of an EE_Transaction
-     *    by default, will NOT release tickets for finalized transactions
-     *
-     * @access    protected
-     * @param    EE_Transaction $transaction
-     * @return int
-     * @throws EE_Error
-     */
-    protected function _release_all_reserved_tickets_for_transaction(EE_Transaction $transaction)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo '<br /> . transaction->ID: ' . $transaction->ID();
-        }
-        // check if 'finalize_registration' step has been completed...
-        $finalized = $transaction->reg_step_completed('finalize_registration');
-        if (self::debug) {
-            // DEBUG LOG
-            EEH_Debug_Tools::log(
-                __CLASS__, __FUNCTION__, __LINE__,
-                array('finalized' => $finalized),
-                false, 'EE_Transaction: ' . $transaction->ID()
-            );
-        }
-        // how many tickets were released
-        $count = 0;
-        if (self::debug) {
-            echo '<br /> . . . finalized: ' . $finalized;
-        }
-        $release_tickets_with_TXN_status = array(
-            EEM_Transaction::failed_status_code,
-            EEM_Transaction::abandoned_status_code,
-            EEM_Transaction::incomplete_status_code,
-        );
-        // if the session is getting cleared BEFORE the TXN has been finalized
-        if ( ! $finalized || in_array($transaction->status_ID(), $release_tickets_with_TXN_status, true)) {
-            // let's cancel any reserved tickets
-            $registrations = $transaction->registrations();
-            if ( ! empty($registrations)) {
-                foreach ($registrations as $registration) {
-                    if ($registration instanceof EE_Registration) {
-                        $count += $this->_release_reserved_ticket_for_registration($registration, $transaction);
-                    }
-                }
-            }
-        }
-        return $count;
-    }
-
-
-
-    /**
-     *    _release_reserved_ticket_for_registration
-     *    releases reserved tickets for an EE_Registration
-     *    by default, will NOT release tickets for APPROVED registrations
-     *
-     * @access    protected
-     * @param    EE_Registration $registration
-     * @param    EE_Transaction  $transaction
-     * @return    int
-     * @throws    EE_Error
-     */
-    protected function _release_reserved_ticket_for_registration(
-        EE_Registration $registration,
-        EE_Transaction $transaction
-    ) {
-        $STS_ID = $transaction->status_ID();
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo '<br /> . . registration->ID: ' . $registration->ID();
-            echo '<br /> . . registration->status_ID: ' . $registration->status_ID();
-            echo '<br /> . . transaction->status_ID(): ' . $STS_ID;
-        }
-        if (
-            // release Tickets for Failed Transactions and Abandoned Transactions
-            $STS_ID === EEM_Transaction::failed_status_code
-            || $STS_ID === EEM_Transaction::abandoned_status_code
-            || (
-                // also release Tickets for Incomplete Transactions, but ONLY if the Registrations are NOT Approved
-                $STS_ID === EEM_Transaction::incomplete_status_code
-                && $registration->status_ID() !== EEM_Registration::status_id_approved
-            )
-        ) {
-            $ticket = $registration->ticket();
-            if ($ticket instanceof EE_Ticket) {
-                return $this->_release_reserved_ticket($ticket);
-            }
-        }
-        return 0;
-    }
-
-
-
-    /********************************** SESSION_CART_RESET  **********************************/
-
-
-
-    /**
-     *    session_cart_reset
-     * callback hooked into 'AHEE__EE_Session__reset_cart__before_reset'
-     *
-     * @access    public
-     * @param    EE_Session $session
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function session_cart_reset(EE_Session $session)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        $cart = $session->cart();
-        if ($cart instanceof EE_Cart) {
-            if (self::debug) {
-                echo '<br /><br /> cart instance of EE_Cart: ';
-            }
-            EED_Ticket_Sales_Monitor::instance()->_session_cart_reset($cart);
-        } else {
-            if (self::debug) {
-                echo '<br /><br /> invalid EE_Cart: ';
-                var_dump($cart);
-            }
-        }
-    }
-
-
-
-    /**
-     *    _session_cart_reset
-     * releases reserved tickets in the EE_Cart
-     *
-     * @access    protected
-     * @param    EE_Cart $cart
-     * @return    void
-     * @throws EE_Error
-     */
-    protected function _session_cart_reset(EE_Cart $cart)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        EE_Registry::instance()->load_helper('Line_Item');
-        $ticket_line_items = $cart->get_tickets();
-        if (empty($ticket_line_items)) {
-            return;
-        }
-        foreach ($ticket_line_items as $ticket_line_item) {
-            if (self::debug) {
-                echo '<br /> . ticket_line_item->ID(): ' . $ticket_line_item->ID();
-            }
-            if ($ticket_line_item instanceof EE_Line_Item && $ticket_line_item->OBJ_type() === 'Ticket') {
-                if (self::debug) {
-                    echo '<br /> . . ticket_line_item->OBJ_ID(): ' . $ticket_line_item->OBJ_ID();
-                }
-                $ticket = EEM_Ticket::instance()->get_one_by_ID($ticket_line_item->OBJ_ID());
-                if ($ticket instanceof EE_Ticket) {
-                    if (self::debug) {
-                        echo '<br /> . . ticket->ID(): ' . $ticket->ID();
-                        echo '<br /> . . ticket_line_item->quantity(): ' . $ticket_line_item->quantity();
-                    }
-                    $this->_release_reserved_ticket($ticket, $ticket_line_item->quantity());
-                }
-            }
-        }
-        if (self::debug) {
-            echo '<br /><br /> RESET COMPLETED ';
-        }
-    }
-
-
-
-    /********************************** SESSION_CHECKOUT_RESET  **********************************/
-
-
-
-    /**
-     *    session_checkout_reset
-     * callback hooked into 'AHEE__EE_Session__reset_checkout__before_reset'
-     *
-     * @access    public
-     * @param    EE_Session $session
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function session_checkout_reset(EE_Session $session)
-    {
-        $checkout = $session->checkout();
-        if ($checkout instanceof EE_Checkout) {
-            EED_Ticket_Sales_Monitor::instance()->_session_checkout_reset($checkout);
-        }
-    }
-
-
-
-    /**
-     *    _session_checkout_reset
-     * releases reserved tickets for the EE_Checkout->transaction
-     *
-     * @access    protected
-     * @param    EE_Checkout $checkout
-     * @return    void
-     * @throws EE_Error
-     */
-    protected function _session_checkout_reset(EE_Checkout $checkout)
-    {
-        if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        // we want to release the each registration's reserved tickets if the session was cleared, but not if this is a revisit
-        if ($checkout->revisit || ! $checkout->transaction instanceof EE_Transaction) {
-            return;
-        }
-        $this->_release_all_reserved_tickets_for_transaction($checkout->transaction);
-    }
-
-
-
-    /********************************** SESSION_EXPIRED_RESET  **********************************/
-
-
-
-    /**
-     *    session_expired_reset
-     *
-     * @access    public
-     * @param    EE_Session $session
-     * @return    void
-     */
-    public static function session_expired_reset(EE_Session $session)
-    {
-    }
-
-
-
-    /********************************** PROCESS_ABANDONED_TRANSACTIONS  **********************************/
-
-
-
-    /**
-     *    process_abandoned_transactions
-     *    releases reserved tickets for all registrations of an ABANDONED EE_Transaction
-     *    by default, will NOT release tickets for free transactions, or any that have received a payment
-     *
-     * @access    public
-     * @param    EE_Transaction $transaction
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function process_abandoned_transactions(EE_Transaction $transaction)
-    {
-        // is this TXN free or has any money been paid towards this TXN? If so, then leave it alone
-        if ($transaction->is_free() || $transaction->paid() > 0) {
-            if (self::debug) {
-                // DEBUG LOG
-                EEH_Debug_Tools::log(
-                    __CLASS__, __FUNCTION__, __LINE__,
-                    array($transaction),
-                    false, 'EE_Transaction: ' . $transaction->ID()
-                );
-            }
-            return;
-        }
-        // have their been any successful payments made ?
-        $payments = $transaction->payments();
-        foreach ($payments as $payment) {
-            if ($payment instanceof EE_Payment && $payment->status() === EEM_Payment::status_id_approved) {
-                if (self::debug) {
-                    // DEBUG LOG
-                    EEH_Debug_Tools::log(
-                        __CLASS__, __FUNCTION__, __LINE__,
-                        array($payment),
-                        false, 'EE_Transaction: ' . $transaction->ID()
-                    );
-                }
-                return;
-            }
-        }
-        // since you haven't even attempted to pay for your ticket...
-        EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
-    }
-
-
-
-    /********************************** PROCESS_FAILED_TRANSACTIONS  **********************************/
-
-
-
-    /**
-     *    process_abandoned_transactions
-     *    releases reserved tickets for absolutely ALL registrations of a FAILED EE_Transaction
-     *
-     * @access    public
-     * @param    EE_Transaction $transaction
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function process_failed_transactions(EE_Transaction $transaction)
-    {
-        // since you haven't even attempted to pay for your ticket...
-        EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
-    }
-
-
-
-    /********************************** RESET RESERVATION COUNTS  *********************************/
-
-
-
-    /**
-     * Resets all ticket and datetime reserved counts to zero
-     * Tickets that are currently associated with a Transaction that is in progress
-     *
-     * @throws \EE_Error
-     * @throws \DomainException
-     */
-    public static function reset_reservation_counts()
-    {
-        /** @var EE_Line_Item[] $valid_reserved_tickets */
-        $valid_reserved_tickets = array();
-        $transactions_in_progress = EEM_Transaction::instance()->get_transactions_in_progress();
-        foreach ($transactions_in_progress as $transaction_in_progress) {
-            // if this TXN has been fully completed, then skip it
-            if ($transaction_in_progress->reg_step_completed('finalize_registration')) {
-                continue;
-            }
-            /** @var EE_Transaction $transaction_in_progress */
-            $total_line_item = $transaction_in_progress->total_line_item();
-            // $transaction_in_progress->line
-            if (! $total_line_item instanceof EE_Line_Item) {
-                throw new DomainException(
-                    esc_html__('Transaction does not have a valid Total Line Item associated with it.', 'event_espresso')
-                );
-            }
-            $valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total(
-                $total_line_item
-            );
-        }
-        $total_line_items = EEM_Line_Item::instance()->get_total_line_items_just_added_to_cart();
-        foreach ($total_line_items as $total_line_item) {
-            $valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total(
-                $total_line_item
-            );
-        }
-        return EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
-            EEM_Ticket::instance()->get_tickets_with_reservations(),
-            $valid_reserved_tickets
-        );
-    }
-
-
-
-    /**
-     * @param EE_Line_Item $total_line_item
-     * @return EE_Line_Item[]
-     */
-    private static function get_ticket_line_items_for_grand_total(EE_Line_Item $total_line_item)
-    {
-        /** @var EE_Line_Item[] $valid_reserved_tickets */
-        $valid_reserved_tickets = array();
-        $ticket_line_items = EEH_Line_Item::get_ticket_line_items($total_line_item);
-        foreach ($ticket_line_items as $ticket_line_item) {
-            if ($ticket_line_item instanceof EE_Line_Item) {
-                $valid_reserved_tickets[] = $ticket_line_item;
-            }
-        }
-        return $valid_reserved_tickets;
-    }
-
-
-
-    /**
-     * @param EE_Ticket[] $tickets_with_reservations
-     * @param EE_Line_Item[] $valid_reserved_ticket_line_items
-     * @return int
-     * @throws \EE_Error
-     */
-    private static function release_reservations_for_tickets(
-        array $tickets_with_reservations,
-        $valid_reserved_ticket_line_items = array()
-    ) {
-        $total_tickets_released = 0;
-        foreach ($tickets_with_reservations as $ticket_with_reservations) {
-            if (! $ticket_with_reservations instanceof EE_Ticket) {
-                continue;
-            }
-            $reserved_qty = $ticket_with_reservations->reserved();
-            foreach ($valid_reserved_ticket_line_items as $valid_reserved_ticket_line_item) {
-                if (
-                    $valid_reserved_ticket_line_item instanceof EE_Line_Item
-                    && $valid_reserved_ticket_line_item->OBJ_ID() === $ticket_with_reservations->ID()
-                ) {
-                    $reserved_qty -= $valid_reserved_ticket_line_item->quantity();
-                }
-            }
-            if ($reserved_qty > 0) {
-                $ticket_with_reservations->decrease_reserved($reserved_qty);
-                $ticket_with_reservations->save();
-                $total_tickets_released += $reserved_qty;
-            }
-        }
-        return $total_tickets_released;
-    }
+	const debug = false;    //	true false
+
+	/**
+	 * an array of raw ticket data from EED_Ticket_Selector
+	 *
+	 * @var array $ticket_selections
+	 */
+	protected $ticket_selections = array();
+
+	/**
+	 * the raw ticket data from EED_Ticket_Selector is organized in rows
+	 * according to how they are displayed in the actual Ticket_Selector
+	 * this tracks the current row being processed
+	 *
+	 * @var int $current_row
+	 */
+	protected $current_row = 0;
+
+	/**
+	 * an array for tracking names of tickets that have sold out
+	 *
+	 * @var array $sold_out_tickets
+	 */
+	protected $sold_out_tickets = array();
+
+	/**
+	 * an array for tracking names of tickets that have had their quantities reduced
+	 *
+	 * @var array $decremented_tickets
+	 */
+	protected $decremented_tickets = array();
+
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		// release tickets for expired carts
+		add_action('EED_Ticket_Selector__process_ticket_selections__before',
+			array('EED_Ticket_Sales_Monitor', 'release_tickets_for_expired_carts'),
+			1
+		);
+		// check ticket reserves AFTER MER does it's check (hence priority 20)
+		add_filter('FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty',
+			array('EED_Ticket_Sales_Monitor', 'validate_ticket_sale'),
+			20, 3
+		);
+		// add notices for sold out tickets
+		add_action('AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
+			array('EED_Ticket_Sales_Monitor', 'post_notices'),
+			10
+		);
+		// handle ticket quantities adjusted in cart
+		//add_action(
+		//	'FHEE__EED_Multi_Event_Registration__adjust_line_item_quantity__line_item_quantity_updated',
+		//	array( 'EED_Ticket_Sales_Monitor', 'ticket_quantity_updated' ),
+		//	10, 2
+		//);
+		// handle tickets deleted from cart
+		add_action(
+			'FHEE__EED_Multi_Event_Registration__delete_ticket__ticket_removed_from_cart',
+			array('EED_Ticket_Sales_Monitor', 'ticket_removed_from_cart'),
+			10, 2
+		);
+		// handle emptied carts
+		add_action(
+			'AHEE__EE_Session__reset_cart__before_reset',
+			array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
+			10, 1
+		);
+		add_action(
+			'AHEE__EED_Multi_Event_Registration__empty_event_cart__before_delete_cart',
+			array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
+			10, 1
+		);
+		// handle cancelled registrations
+		add_action(
+			'AHEE__EE_Session__reset_checkout__before_reset',
+			array('EED_Ticket_Sales_Monitor', 'session_checkout_reset'),
+			10, 1
+		);
+		// cron tasks
+		add_action(
+			'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions__abandoned_transaction',
+			array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
+			10, 1
+		);
+		add_action(
+			'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
+			array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
+			10, 1
+		);
+		add_action(
+			'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
+			array('EED_Ticket_Sales_Monitor', 'process_failed_transactions'),
+			10, 1
+		);
+	}
+
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		EED_Ticket_Sales_Monitor::set_hooks();
+	}
+
+
+
+	/**
+	 * @return EED_Ticket_Sales_Monitor|EED_Module
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+
+	/**
+	 *    run
+	 *
+	 * @access    public
+	 * @param WP_Query $WP_Query
+	 * @return    void
+	 */
+	public function run($WP_Query)
+	{
+	}
+
+
+
+	/********************************** PRE_TICKET_SALES  **********************************/
+
+
+
+	/**
+	 * Retrieves grand totals from the line items that have no TXN ID
+	 * and timestamps less than the current time minus the session lifespan.
+	 * These are carts that have been abandoned before the "registrant" even attempted to checkout.
+	 * We're going to release the tickets for these line items before attempting to add more to the cart.
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public static function release_tickets_for_expired_carts()
+	{
+		$expired_ticket_IDs = array();
+		$valid_ticket_line_items = array();
+		$total_line_items = EEM_Line_Item::instance()->get_total_line_items_with_no_transaction();
+		if(empty($total_line_items)){
+			return;
+		}
+		$expired = current_time('timestamp') - EE_Registry::instance()->SSN->lifespan();
+		foreach ($total_line_items as $total_line_item) {
+			/** @var EE_Line_Item $total_line_item */
+			$ticket_line_items = EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total($total_line_item);
+			foreach ($ticket_line_items as $ticket_line_item) {
+				if(! $ticket_line_item instanceof EE_Line_Item) {
+					continue;
+				}
+				if ($total_line_item->timestamp(true) <= $expired ) {
+					$expired_ticket_IDs[$ticket_line_item->OBJ_ID()] = $ticket_line_item->OBJ_ID();
+				} else {
+					$valid_ticket_line_items[$ticket_line_item->OBJ_ID()] = $ticket_line_item;
+				}
+			}
+		}
+		EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
+			\EEM_Ticket::instance()->get_tickets_with_IDs($expired_ticket_IDs),
+			$valid_ticket_line_items
+		);
+	}
+
+
+
+	/********************************** VALIDATE_TICKET_SALE  **********************************/
+
+
+
+	/**
+	 *    validate_ticket_sales
+	 *    callback for 'FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data'
+	 *
+	 * @access    public
+	 * @param int $qty
+	 * @param \EE_Ticket $ticket
+	 * @return bool
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	public static function validate_ticket_sale($qty = 1, EE_Ticket $ticket)
+	{
+		$qty = absint($qty);
+		if ($qty > 0) {
+			$qty = EED_Ticket_Sales_Monitor::instance()->_validate_ticket_sale($ticket, $qty);
+		}
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '()';
+			echo '<br /><br /><b> RETURNED QTY: ' . $qty . '</b>';
+		}
+		return $qty;
+	}
+
+
+
+	/**
+	 *    _validate_ticket_sale
+	 * checks whether an individual ticket is available for purchase based on datetime, and ticket details
+	 *
+	 * @access    protected
+	 * @param   \EE_Ticket $ticket
+	 * @param int          $qty
+	 * @return int
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _validate_ticket_sale(EE_Ticket $ticket, $qty = 1)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		if ( ! $ticket instanceof EE_Ticket) {
+			return 0;
+		}
+		if (self::debug) {
+			echo '<br /><b> . ticket->ID: ' . $ticket->ID() . '</b>';
+			echo '<br /> . original ticket->reserved: ' . $ticket->reserved();
+		}
+		$ticket->refresh_from_db();
+		// first let's determine the ticket availability based on sales
+		$available = $ticket->qty('saleable');
+		if (self::debug) {
+			echo '<br /> . . . ticket->qty: ' . $ticket->qty();
+			echo '<br /> . . . ticket->sold: ' . $ticket->sold();
+			echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
+			echo '<br /> . . . ticket->qty(saleable): ' . $ticket->qty('saleable');
+			echo '<br /> . . . available: ' . $available;
+		}
+		if ($available < 1) {
+			$this->_ticket_sold_out($ticket);
+			return 0;
+		}
+		if (self::debug) {
+			echo '<br /> . . . qty: ' . $qty;
+		}
+		if ($available < $qty) {
+			$qty = $available;
+			if (self::debug) {
+				echo '<br /> . . . QTY ADJUSTED: ' . $qty;
+			}
+			$this->_ticket_quantity_decremented($ticket);
+		}
+		$this->_reserve_ticket($ticket, $qty);
+		return $qty;
+	}
+
+
+
+	/**
+	 *  _reserve_ticket
+	 *    increments ticket reserved based on quantity passed
+	 *
+	 * @access    protected
+	 * @param    \EE_Ticket $ticket
+	 * @param int           $quantity
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function _reserve_ticket(EE_Ticket $ticket, $quantity = 1)
+	{
+		if (self::debug) {
+			echo '<br /><br /> . . . INCREASE RESERVED: ' . $quantity;
+		}
+		$ticket->increase_reserved($quantity);
+		return $ticket->save();
+	}
+
+
+
+	/**
+	 * _release_reserved_ticket
+	 *
+	 * @access protected
+	 * @param  EE_Ticket $ticket
+	 * @param  int       $quantity
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function _release_reserved_ticket(EE_Ticket $ticket, $quantity = 1)
+	{
+		if (self::debug) {
+			echo '<br /> . . . ticket->ID: ' . $ticket->ID();
+			echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
+		}
+		$ticket->decrease_reserved($quantity);
+		if (self::debug) {
+			echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
+		}
+		return $ticket->save() ? 1 : 0;
+	}
+
+
+
+	/**
+	 *    _ticket_sold_out
+	 *    removes quantities within the ticket selector based on zero ticket availability
+	 *
+	 * @access    protected
+	 * @param    \EE_Ticket $ticket
+	 * @return    void
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _ticket_sold_out(EE_Ticket $ticket)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo '<br /> . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
+		}
+		$this->sold_out_tickets[] = $this->_get_ticket_and_event_name($ticket);
+	}
+
+
+
+	/**
+	 *    _ticket_quantity_decremented
+	 *    adjusts quantities within the ticket selector based on decreased ticket availability
+	 *
+	 * @access    protected
+	 * @param    \EE_Ticket $ticket
+	 * @return void
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _ticket_quantity_decremented(EE_Ticket $ticket)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo '<br /> . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
+		}
+		$this->decremented_tickets[] = $this->_get_ticket_and_event_name($ticket);
+	}
+
+
+
+	/**
+	 *    _get_ticket_and_event_name
+	 *    builds string out of ticket and event name
+	 *
+	 * @access    protected
+	 * @param    \EE_Ticket $ticket
+	 * @return string
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _get_ticket_and_event_name(EE_Ticket $ticket)
+	{
+		$event = $ticket->get_related_event();
+		if ($event instanceof EE_Event) {
+			$ticket_name = sprintf(
+				_x('%1$s for %2$s', 'ticket name for event name', 'event_espresso'),
+				$ticket->name(),
+				$event->name()
+			);
+		} else {
+			$ticket_name = $ticket->name();
+		}
+		return $ticket_name;
+	}
+
+
+
+	/********************************** EVENT CART  **********************************/
+
+
+
+	/**
+	 * ticket_quantity_updated
+	 * releases or reserves ticket(s) based on quantity passed
+	 *
+	 * @access public
+	 * @param  EE_Line_Item $line_item
+	 * @param  int          $quantity
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function ticket_quantity_updated(EE_Line_Item $line_item, $quantity = 1)
+	{
+		$ticket = EEM_Ticket::instance()->get_one_by_ID(absint($line_item->OBJ_ID()));
+		if ($ticket instanceof EE_Ticket) {
+			if ($quantity > 0) {
+				EED_Ticket_Sales_Monitor::instance()->_reserve_ticket($ticket, $quantity);
+			} else {
+				EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
+			}
+		}
+	}
+
+
+
+	/**
+	 * ticket_removed_from_cart
+	 * releases reserved ticket(s) based on quantity passed
+	 *
+	 * @access public
+	 * @param  EE_Ticket $ticket
+	 * @param  int       $quantity
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function ticket_removed_from_cart(EE_Ticket $ticket, $quantity = 1)
+	{
+		EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
+	}
+
+
+
+	/********************************** POST_NOTICES  **********************************/
+
+
+
+	/**
+	 *    post_notices
+	 *
+	 * @access    public
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function post_notices()
+	{
+		EED_Ticket_Sales_Monitor::instance()->_post_notices();
+	}
+
+
+
+	/**
+	 *    _post_notices
+	 *
+	 * @access    protected
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	protected function _post_notices()
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		$refresh_msg = '';
+		$none_added_msg = '';
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$refresh_msg = __('Please refresh the page to view updated ticket quantities.',
+				'event_espresso');
+			$none_added_msg = __('No tickets were added for the event.', 'event_espresso');
+		}
+		if ( ! empty($this->sold_out_tickets)) {
+			EE_Error::add_attention(
+				sprintf(
+					apply_filters(
+						'FHEE__EED_Ticket_Sales_Monitor___post_notices__sold_out_tickets_notice',
+						__('We\'re sorry...%1$sThe following items have sold out since you first viewed this page, and can no longer be registered for:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
+							'event_espresso')
+					),
+					'<br />',
+					implode('<br />', $this->sold_out_tickets),
+					$none_added_msg,
+					$refresh_msg
+				)
+			);
+			// alter code flow in the Ticket Selector for better UX
+			add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', '__return_true');
+			add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__success', '__return_false');
+			$this->sold_out_tickets = array();
+			// and reset the cart
+			EED_Ticket_Sales_Monitor::session_cart_reset(EE_Registry::instance()->SSN);
+		}
+		if ( ! empty($this->decremented_tickets)) {
+			EE_Error::add_attention(
+				sprintf(
+					apply_filters(
+						'FHEE__EED_Ticket_Sales_Monitor___ticket_quantity_decremented__notice',
+						__('We\'re sorry...%1$sDue to sales that have occurred since you first viewed the last page, the following items have had their quantities adjusted to match the current available amount:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
+							'event_espresso')
+					),
+					'<br />',
+					implode('<br />', $this->decremented_tickets),
+					$none_added_msg,
+					$refresh_msg
+				)
+			);
+			$this->decremented_tickets = array();
+		}
+	}
+
+
+
+	/********************************** RELEASE_ALL_RESERVED_TICKETS_FOR_TRANSACTION  **********************************/
+
+
+
+	/**
+	 *    _release_all_reserved_tickets_for_transaction
+	 *    releases reserved tickets for all registrations of an EE_Transaction
+	 *    by default, will NOT release tickets for finalized transactions
+	 *
+	 * @access    protected
+	 * @param    EE_Transaction $transaction
+	 * @return int
+	 * @throws EE_Error
+	 */
+	protected function _release_all_reserved_tickets_for_transaction(EE_Transaction $transaction)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo '<br /> . transaction->ID: ' . $transaction->ID();
+		}
+		// check if 'finalize_registration' step has been completed...
+		$finalized = $transaction->reg_step_completed('finalize_registration');
+		if (self::debug) {
+			// DEBUG LOG
+			EEH_Debug_Tools::log(
+				__CLASS__, __FUNCTION__, __LINE__,
+				array('finalized' => $finalized),
+				false, 'EE_Transaction: ' . $transaction->ID()
+			);
+		}
+		// how many tickets were released
+		$count = 0;
+		if (self::debug) {
+			echo '<br /> . . . finalized: ' . $finalized;
+		}
+		$release_tickets_with_TXN_status = array(
+			EEM_Transaction::failed_status_code,
+			EEM_Transaction::abandoned_status_code,
+			EEM_Transaction::incomplete_status_code,
+		);
+		// if the session is getting cleared BEFORE the TXN has been finalized
+		if ( ! $finalized || in_array($transaction->status_ID(), $release_tickets_with_TXN_status, true)) {
+			// let's cancel any reserved tickets
+			$registrations = $transaction->registrations();
+			if ( ! empty($registrations)) {
+				foreach ($registrations as $registration) {
+					if ($registration instanceof EE_Registration) {
+						$count += $this->_release_reserved_ticket_for_registration($registration, $transaction);
+					}
+				}
+			}
+		}
+		return $count;
+	}
+
+
+
+	/**
+	 *    _release_reserved_ticket_for_registration
+	 *    releases reserved tickets for an EE_Registration
+	 *    by default, will NOT release tickets for APPROVED registrations
+	 *
+	 * @access    protected
+	 * @param    EE_Registration $registration
+	 * @param    EE_Transaction  $transaction
+	 * @return    int
+	 * @throws    EE_Error
+	 */
+	protected function _release_reserved_ticket_for_registration(
+		EE_Registration $registration,
+		EE_Transaction $transaction
+	) {
+		$STS_ID = $transaction->status_ID();
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo '<br /> . . registration->ID: ' . $registration->ID();
+			echo '<br /> . . registration->status_ID: ' . $registration->status_ID();
+			echo '<br /> . . transaction->status_ID(): ' . $STS_ID;
+		}
+		if (
+			// release Tickets for Failed Transactions and Abandoned Transactions
+			$STS_ID === EEM_Transaction::failed_status_code
+			|| $STS_ID === EEM_Transaction::abandoned_status_code
+			|| (
+				// also release Tickets for Incomplete Transactions, but ONLY if the Registrations are NOT Approved
+				$STS_ID === EEM_Transaction::incomplete_status_code
+				&& $registration->status_ID() !== EEM_Registration::status_id_approved
+			)
+		) {
+			$ticket = $registration->ticket();
+			if ($ticket instanceof EE_Ticket) {
+				return $this->_release_reserved_ticket($ticket);
+			}
+		}
+		return 0;
+	}
+
+
+
+	/********************************** SESSION_CART_RESET  **********************************/
+
+
+
+	/**
+	 *    session_cart_reset
+	 * callback hooked into 'AHEE__EE_Session__reset_cart__before_reset'
+	 *
+	 * @access    public
+	 * @param    EE_Session $session
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function session_cart_reset(EE_Session $session)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		$cart = $session->cart();
+		if ($cart instanceof EE_Cart) {
+			if (self::debug) {
+				echo '<br /><br /> cart instance of EE_Cart: ';
+			}
+			EED_Ticket_Sales_Monitor::instance()->_session_cart_reset($cart);
+		} else {
+			if (self::debug) {
+				echo '<br /><br /> invalid EE_Cart: ';
+				var_dump($cart);
+			}
+		}
+	}
+
+
+
+	/**
+	 *    _session_cart_reset
+	 * releases reserved tickets in the EE_Cart
+	 *
+	 * @access    protected
+	 * @param    EE_Cart $cart
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	protected function _session_cart_reset(EE_Cart $cart)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		EE_Registry::instance()->load_helper('Line_Item');
+		$ticket_line_items = $cart->get_tickets();
+		if (empty($ticket_line_items)) {
+			return;
+		}
+		foreach ($ticket_line_items as $ticket_line_item) {
+			if (self::debug) {
+				echo '<br /> . ticket_line_item->ID(): ' . $ticket_line_item->ID();
+			}
+			if ($ticket_line_item instanceof EE_Line_Item && $ticket_line_item->OBJ_type() === 'Ticket') {
+				if (self::debug) {
+					echo '<br /> . . ticket_line_item->OBJ_ID(): ' . $ticket_line_item->OBJ_ID();
+				}
+				$ticket = EEM_Ticket::instance()->get_one_by_ID($ticket_line_item->OBJ_ID());
+				if ($ticket instanceof EE_Ticket) {
+					if (self::debug) {
+						echo '<br /> . . ticket->ID(): ' . $ticket->ID();
+						echo '<br /> . . ticket_line_item->quantity(): ' . $ticket_line_item->quantity();
+					}
+					$this->_release_reserved_ticket($ticket, $ticket_line_item->quantity());
+				}
+			}
+		}
+		if (self::debug) {
+			echo '<br /><br /> RESET COMPLETED ';
+		}
+	}
+
+
+
+	/********************************** SESSION_CHECKOUT_RESET  **********************************/
+
+
+
+	/**
+	 *    session_checkout_reset
+	 * callback hooked into 'AHEE__EE_Session__reset_checkout__before_reset'
+	 *
+	 * @access    public
+	 * @param    EE_Session $session
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function session_checkout_reset(EE_Session $session)
+	{
+		$checkout = $session->checkout();
+		if ($checkout instanceof EE_Checkout) {
+			EED_Ticket_Sales_Monitor::instance()->_session_checkout_reset($checkout);
+		}
+	}
+
+
+
+	/**
+	 *    _session_checkout_reset
+	 * releases reserved tickets for the EE_Checkout->transaction
+	 *
+	 * @access    protected
+	 * @param    EE_Checkout $checkout
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	protected function _session_checkout_reset(EE_Checkout $checkout)
+	{
+		if (self::debug) {
+			echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		// we want to release the each registration's reserved tickets if the session was cleared, but not if this is a revisit
+		if ($checkout->revisit || ! $checkout->transaction instanceof EE_Transaction) {
+			return;
+		}
+		$this->_release_all_reserved_tickets_for_transaction($checkout->transaction);
+	}
+
+
+
+	/********************************** SESSION_EXPIRED_RESET  **********************************/
+
+
+
+	/**
+	 *    session_expired_reset
+	 *
+	 * @access    public
+	 * @param    EE_Session $session
+	 * @return    void
+	 */
+	public static function session_expired_reset(EE_Session $session)
+	{
+	}
+
+
+
+	/********************************** PROCESS_ABANDONED_TRANSACTIONS  **********************************/
+
+
+
+	/**
+	 *    process_abandoned_transactions
+	 *    releases reserved tickets for all registrations of an ABANDONED EE_Transaction
+	 *    by default, will NOT release tickets for free transactions, or any that have received a payment
+	 *
+	 * @access    public
+	 * @param    EE_Transaction $transaction
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function process_abandoned_transactions(EE_Transaction $transaction)
+	{
+		// is this TXN free or has any money been paid towards this TXN? If so, then leave it alone
+		if ($transaction->is_free() || $transaction->paid() > 0) {
+			if (self::debug) {
+				// DEBUG LOG
+				EEH_Debug_Tools::log(
+					__CLASS__, __FUNCTION__, __LINE__,
+					array($transaction),
+					false, 'EE_Transaction: ' . $transaction->ID()
+				);
+			}
+			return;
+		}
+		// have their been any successful payments made ?
+		$payments = $transaction->payments();
+		foreach ($payments as $payment) {
+			if ($payment instanceof EE_Payment && $payment->status() === EEM_Payment::status_id_approved) {
+				if (self::debug) {
+					// DEBUG LOG
+					EEH_Debug_Tools::log(
+						__CLASS__, __FUNCTION__, __LINE__,
+						array($payment),
+						false, 'EE_Transaction: ' . $transaction->ID()
+					);
+				}
+				return;
+			}
+		}
+		// since you haven't even attempted to pay for your ticket...
+		EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
+	}
+
+
+
+	/********************************** PROCESS_FAILED_TRANSACTIONS  **********************************/
+
+
+
+	/**
+	 *    process_abandoned_transactions
+	 *    releases reserved tickets for absolutely ALL registrations of a FAILED EE_Transaction
+	 *
+	 * @access    public
+	 * @param    EE_Transaction $transaction
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function process_failed_transactions(EE_Transaction $transaction)
+	{
+		// since you haven't even attempted to pay for your ticket...
+		EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
+	}
+
+
+
+	/********************************** RESET RESERVATION COUNTS  *********************************/
+
+
+
+	/**
+	 * Resets all ticket and datetime reserved counts to zero
+	 * Tickets that are currently associated with a Transaction that is in progress
+	 *
+	 * @throws \EE_Error
+	 * @throws \DomainException
+	 */
+	public static function reset_reservation_counts()
+	{
+		/** @var EE_Line_Item[] $valid_reserved_tickets */
+		$valid_reserved_tickets = array();
+		$transactions_in_progress = EEM_Transaction::instance()->get_transactions_in_progress();
+		foreach ($transactions_in_progress as $transaction_in_progress) {
+			// if this TXN has been fully completed, then skip it
+			if ($transaction_in_progress->reg_step_completed('finalize_registration')) {
+				continue;
+			}
+			/** @var EE_Transaction $transaction_in_progress */
+			$total_line_item = $transaction_in_progress->total_line_item();
+			// $transaction_in_progress->line
+			if (! $total_line_item instanceof EE_Line_Item) {
+				throw new DomainException(
+					esc_html__('Transaction does not have a valid Total Line Item associated with it.', 'event_espresso')
+				);
+			}
+			$valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total(
+				$total_line_item
+			);
+		}
+		$total_line_items = EEM_Line_Item::instance()->get_total_line_items_just_added_to_cart();
+		foreach ($total_line_items as $total_line_item) {
+			$valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total(
+				$total_line_item
+			);
+		}
+		return EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
+			EEM_Ticket::instance()->get_tickets_with_reservations(),
+			$valid_reserved_tickets
+		);
+	}
+
+
+
+	/**
+	 * @param EE_Line_Item $total_line_item
+	 * @return EE_Line_Item[]
+	 */
+	private static function get_ticket_line_items_for_grand_total(EE_Line_Item $total_line_item)
+	{
+		/** @var EE_Line_Item[] $valid_reserved_tickets */
+		$valid_reserved_tickets = array();
+		$ticket_line_items = EEH_Line_Item::get_ticket_line_items($total_line_item);
+		foreach ($ticket_line_items as $ticket_line_item) {
+			if ($ticket_line_item instanceof EE_Line_Item) {
+				$valid_reserved_tickets[] = $ticket_line_item;
+			}
+		}
+		return $valid_reserved_tickets;
+	}
+
+
+
+	/**
+	 * @param EE_Ticket[] $tickets_with_reservations
+	 * @param EE_Line_Item[] $valid_reserved_ticket_line_items
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	private static function release_reservations_for_tickets(
+		array $tickets_with_reservations,
+		$valid_reserved_ticket_line_items = array()
+	) {
+		$total_tickets_released = 0;
+		foreach ($tickets_with_reservations as $ticket_with_reservations) {
+			if (! $ticket_with_reservations instanceof EE_Ticket) {
+				continue;
+			}
+			$reserved_qty = $ticket_with_reservations->reserved();
+			foreach ($valid_reserved_ticket_line_items as $valid_reserved_ticket_line_item) {
+				if (
+					$valid_reserved_ticket_line_item instanceof EE_Line_Item
+					&& $valid_reserved_ticket_line_item->OBJ_ID() === $ticket_with_reservations->ID()
+				) {
+					$reserved_qty -= $valid_reserved_ticket_line_item->quantity();
+				}
+			}
+			if ($reserved_qty > 0) {
+				$ticket_with_reservations->decrease_reserved($reserved_qty);
+				$ticket_with_reservations->save();
+				$total_tickets_released += $reserved_qty;
+			}
+		}
+		return $total_tickets_released;
+	}
 
 }
 // End of file EED_Ticket_Sales_Monitor.module.php

Spacing +44 added lines, -44 removed lines

@@ -21,7 +21,7 @@ 
 class EED_Ticket_Sales_Monitor extends EED_Module
 {
 
-    const debug = false;    //	true false
+    const debug = false; //	true false
 
     /**
      * an array of raw ticket data from EED_Ticket_Selector
@@ -181,7 +181,7 @@ 
         $expired_ticket_IDs = array();
         $valid_ticket_line_items = array();
         $total_line_items = EEM_Line_Item::instance()->get_total_line_items_with_no_transaction();
-        if(empty($total_line_items)){
+        if (empty($total_line_items)) {
             return;
         }
         $expired = current_time('timestamp') - EE_Registry::instance()->SSN->lifespan();
@@ -189,10 +189,10 @@ 
             /** @var EE_Line_Item $total_line_item */
             $ticket_line_items = EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total($total_line_item);
             foreach ($ticket_line_items as $ticket_line_item) {
-                if(! $ticket_line_item instanceof EE_Line_Item) {
+                if ( ! $ticket_line_item instanceof EE_Line_Item) {
                     continue;
                 }
-                if ($total_line_item->timestamp(true) <= $expired ) {
+                if ($total_line_item->timestamp(true) <= $expired) {
                     $expired_ticket_IDs[$ticket_line_item->OBJ_ID()] = $ticket_line_item->OBJ_ID();
                 } else {
                     $valid_ticket_line_items[$ticket_line_item->OBJ_ID()] = $ticket_line_item;
@@ -229,8 +229,8 @@ 
             $qty = EED_Ticket_Sales_Monitor::instance()->_validate_ticket_sale($ticket, $qty);
         }
         if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '()';
-            echo '<br /><br /><b> RETURNED QTY: ' . $qty . '</b>';
+            echo '<br /><br /> '.__LINE__.') '.__METHOD__.'()';
+            echo '<br /><br /><b> RETURNED QTY: '.$qty.'</b>';
         }
         return $qty;
     }
@@ -251,36 +251,36 @@ 
     protected function _validate_ticket_sale(EE_Ticket $ticket, $qty = 1)
     {
         if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo '<br /><br /> '.__LINE__.') '.__METHOD__.'() ';
         }
         if ( ! $ticket instanceof EE_Ticket) {
             return 0;
         }
         if (self::debug) {
-            echo '<br /><b> . ticket->ID: ' . $ticket->ID() . '</b>';
-            echo '<br /> . original ticket->reserved: ' . $ticket->reserved();
+            echo '<br /><b> . ticket->ID: '.$ticket->ID().'</b>';
+            echo '<br /> . original ticket->reserved: '.$ticket->reserved();
         }
         $ticket->refresh_from_db();
         // first let's determine the ticket availability based on sales
         $available = $ticket->qty('saleable');
         if (self::debug) {
-            echo '<br /> . . . ticket->qty: ' . $ticket->qty();
-            echo '<br /> . . . ticket->sold: ' . $ticket->sold();
-            echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
-            echo '<br /> . . . ticket->qty(saleable): ' . $ticket->qty('saleable');
-            echo '<br /> . . . available: ' . $available;
+            echo '<br /> . . . ticket->qty: '.$ticket->qty();
+            echo '<br /> . . . ticket->sold: '.$ticket->sold();
+            echo '<br /> . . . ticket->reserved: '.$ticket->reserved();
+            echo '<br /> . . . ticket->qty(saleable): '.$ticket->qty('saleable');
+            echo '<br /> . . . available: '.$available;
         }
         if ($available < 1) {
             $this->_ticket_sold_out($ticket);
             return 0;
         }
         if (self::debug) {
-            echo '<br /> . . . qty: ' . $qty;
+            echo '<br /> . . . qty: '.$qty;
         }
         if ($available < $qty) {
             $qty = $available;
             if (self::debug) {
-                echo '<br /> . . . QTY ADJUSTED: ' . $qty;
+                echo '<br /> . . . QTY ADJUSTED: '.$qty;
             }
             $this->_ticket_quantity_decremented($ticket);
         }
@@ -303,7 +303,7 @@ 
     protected function _reserve_ticket(EE_Ticket $ticket, $quantity = 1)
     {
         if (self::debug) {
-            echo '<br /><br /> . . . INCREASE RESERVED: ' . $quantity;
+            echo '<br /><br /> . . . INCREASE RESERVED: '.$quantity;
         }
         $ticket->increase_reserved($quantity);
         return $ticket->save();
@@ -323,12 +323,12 @@ 
     protected function _release_reserved_ticket(EE_Ticket $ticket, $quantity = 1)
     {
         if (self::debug) {
-            echo '<br /> . . . ticket->ID: ' . $ticket->ID();
-            echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
+            echo '<br /> . . . ticket->ID: '.$ticket->ID();
+            echo '<br /> . . . ticket->reserved: '.$ticket->reserved();
         }
         $ticket->decrease_reserved($quantity);
         if (self::debug) {
-            echo '<br /> . . . ticket->reserved: ' . $ticket->reserved();
+            echo '<br /> . . . ticket->reserved: '.$ticket->reserved();
         }
         return $ticket->save() ? 1 : 0;
     }
@@ -348,8 +348,8 @@ 
     protected function _ticket_sold_out(EE_Ticket $ticket)
     {
         if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo '<br /> . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
+            echo '<br /><br /> '.__LINE__.') '.__METHOD__.'() ';
+            echo '<br /> . . ticket->name: '.$this->_get_ticket_and_event_name($ticket);
         }
         $this->sold_out_tickets[] = $this->_get_ticket_and_event_name($ticket);
     }
@@ -369,8 +369,8 @@ 
     protected function _ticket_quantity_decremented(EE_Ticket $ticket)
     {
         if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo '<br /> . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
+            echo '<br /><br /> '.__LINE__.') '.__METHOD__.'() ';
+            echo '<br /> . . ticket->name: '.$this->_get_ticket_and_event_name($ticket);
         }
         $this->decremented_tickets[] = $this->_get_ticket_and_event_name($ticket);
     }
@@ -477,7 +477,7 @@ 
     protected function _post_notices()
     {
         if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo '<br /><br /> '.__LINE__.') '.__METHOD__.'() ';
         }
         $refresh_msg = '';
         $none_added_msg = '';
@@ -544,8 +544,8 @@ 
     protected function _release_all_reserved_tickets_for_transaction(EE_Transaction $transaction)
     {
         if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo '<br /> . transaction->ID: ' . $transaction->ID();
+            echo '<br /><br /> '.__LINE__.') '.__METHOD__.'() ';
+            echo '<br /> . transaction->ID: '.$transaction->ID();
         }
         // check if 'finalize_registration' step has been completed...
         $finalized = $transaction->reg_step_completed('finalize_registration');
@@ -554,13 +554,13 @@ 
             EEH_Debug_Tools::log(
                 __CLASS__, __FUNCTION__, __LINE__,
                 array('finalized' => $finalized),
-                false, 'EE_Transaction: ' . $transaction->ID()
+                false, 'EE_Transaction: '.$transaction->ID()
             );
         }
         // how many tickets were released
         $count = 0;
         if (self::debug) {
-            echo '<br /> . . . finalized: ' . $finalized;
+            echo '<br /> . . . finalized: '.$finalized;
         }
         $release_tickets_with_TXN_status = array(
             EEM_Transaction::failed_status_code,
@@ -601,10 +601,10 @@ 
     ) {
         $STS_ID = $transaction->status_ID();
         if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo '<br /> . . registration->ID: ' . $registration->ID();
-            echo '<br /> . . registration->status_ID: ' . $registration->status_ID();
-            echo '<br /> . . transaction->status_ID(): ' . $STS_ID;
+            echo '<br /><br /> '.__LINE__.') '.__METHOD__.'() ';
+            echo '<br /> . . registration->ID: '.$registration->ID();
+            echo '<br /> . . registration->status_ID: '.$registration->status_ID();
+            echo '<br /> . . transaction->status_ID(): '.$STS_ID;
         }
         if (
             // release Tickets for Failed Transactions and Abandoned Transactions
@@ -642,7 +642,7 @@ 
     public static function session_cart_reset(EE_Session $session)
     {
         if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo '<br /><br /> '.__LINE__.') '.__METHOD__.'() ';
         }
         $cart = $session->cart();
         if ($cart instanceof EE_Cart) {
@@ -672,7 +672,7 @@ 
     protected function _session_cart_reset(EE_Cart $cart)
     {
         if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo '<br /><br /> '.__LINE__.') '.__METHOD__.'() ';
         }
         EE_Registry::instance()->load_helper('Line_Item');
         $ticket_line_items = $cart->get_tickets();
@@ -681,17 +681,17 @@ 
         }
         foreach ($ticket_line_items as $ticket_line_item) {
             if (self::debug) {
-                echo '<br /> . ticket_line_item->ID(): ' . $ticket_line_item->ID();
+                echo '<br /> . ticket_line_item->ID(): '.$ticket_line_item->ID();
             }
             if ($ticket_line_item instanceof EE_Line_Item && $ticket_line_item->OBJ_type() === 'Ticket') {
                 if (self::debug) {
-                    echo '<br /> . . ticket_line_item->OBJ_ID(): ' . $ticket_line_item->OBJ_ID();
+                    echo '<br /> . . ticket_line_item->OBJ_ID(): '.$ticket_line_item->OBJ_ID();
                 }
                 $ticket = EEM_Ticket::instance()->get_one_by_ID($ticket_line_item->OBJ_ID());
                 if ($ticket instanceof EE_Ticket) {
                     if (self::debug) {
-                        echo '<br /> . . ticket->ID(): ' . $ticket->ID();
-                        echo '<br /> . . ticket_line_item->quantity(): ' . $ticket_line_item->quantity();
+                        echo '<br /> . . ticket->ID(): '.$ticket->ID();
+                        echo '<br /> . . ticket_line_item->quantity(): '.$ticket_line_item->quantity();
                     }
                     $this->_release_reserved_ticket($ticket, $ticket_line_item->quantity());
                 }
@@ -739,7 +739,7 @@ 
     protected function _session_checkout_reset(EE_Checkout $checkout)
     {
         if (self::debug) {
-            echo '<br /><br /> ' . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo '<br /><br /> '.__LINE__.') '.__METHOD__.'() ';
         }
         // we want to release the each registration's reserved tickets if the session was cleared, but not if this is a revisit
         if ($checkout->revisit || ! $checkout->transaction instanceof EE_Transaction) {
@@ -790,7 +790,7 @@ 
                 EEH_Debug_Tools::log(
                     __CLASS__, __FUNCTION__, __LINE__,
                     array($transaction),
-                    false, 'EE_Transaction: ' . $transaction->ID()
+                    false, 'EE_Transaction: '.$transaction->ID()
                 );
             }
             return;
@@ -804,7 +804,7 @@ 
                     EEH_Debug_Tools::log(
                         __CLASS__, __FUNCTION__, __LINE__,
                         array($payment),
-                        false, 'EE_Transaction: ' . $transaction->ID()
+                        false, 'EE_Transaction: '.$transaction->ID()
                     );
                 }
                 return;
@@ -861,7 +861,7 @@ 
             /** @var EE_Transaction $transaction_in_progress */
             $total_line_item = $transaction_in_progress->total_line_item();
             // $transaction_in_progress->line
-            if (! $total_line_item instanceof EE_Line_Item) {
+            if ( ! $total_line_item instanceof EE_Line_Item) {
                 throw new DomainException(
                     esc_html__('Transaction does not have a valid Total Line Item associated with it.', 'event_espresso')
                 );
@@ -915,7 +915,7 @@ 
     ) {
         $total_tickets_released = 0;
         foreach ($tickets_with_reservations as $ticket_with_reservations) {
-            if (! $ticket_with_reservations instanceof EE_Ticket) {
+            if ( ! $ticket_with_reservations instanceof EE_Ticket) {
                 continue;
             }
             $reserved_qty = $ticket_with_reservations->reserved();

modules/core_rest_api/EED_Core_Rest_Api.module.php

Indentation +791 added lines, -791 removed lines

@@ -18,807 +18,807 @@
 class EED_Core_Rest_Api extends \EED_Module
 {
 
-    const ee_api_namespace           = 'ee/v';
+	const ee_api_namespace           = 'ee/v';
 
-    const ee_api_namespace_for_regex = 'ee\/v([^/]*)\/';
+	const ee_api_namespace_for_regex = 'ee\/v([^/]*)\/';
 
-    const saved_routes_option_names  = 'ee_core_routes';
+	const saved_routes_option_names  = 'ee_core_routes';
 
-    /**
-     * string used in _links response bodies to make them globally unique.
-     *
-     * @see http://v2.wp-api.org/extending/linking/
-     */
-    const ee_api_link_namespace = 'https://api.eventespresso.com/';
+	/**
+	 * string used in _links response bodies to make them globally unique.
+	 *
+	 * @see http://v2.wp-api.org/extending/linking/
+	 */
+	const ee_api_link_namespace = 'https://api.eventespresso.com/';
 
-    /**
-     * @var Calculated_Model_Fields
-     */
-    protected static $_field_calculator = null;
+	/**
+	 * @var Calculated_Model_Fields
+	 */
+	protected static $_field_calculator = null;
 
 
 
-    /**
-     * @return EED_Core_Rest_Api
-     */
-    public static function instance()
-    {
-        self::$_field_calculator = new Calculated_Model_Fields();
-        return parent::get_instance(__CLASS__);
-    }
+	/**
+	 * @return EED_Core_Rest_Api
+	 */
+	public static function instance()
+	{
+		self::$_field_calculator = new Calculated_Model_Fields();
+		return parent::get_instance(__CLASS__);
+	}
 
 
 
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        self::set_hooks_both();
-    }
-
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        self::set_hooks_both();
-    }
-
-
-
-    public static function set_hooks_both()
-    {
-        add_action('rest_api_init', array('EED_Core_Rest_Api', 'register_routes'), 10);
-        add_action('rest_api_init', array('EED_Core_Rest_Api', 'set_hooks_rest_api'), 5);
-        add_filter('rest_route_data', array('EED_Core_Rest_Api', 'hide_old_endpoints'), 10, 2);
-        add_filter('rest_index',
-            array('EventEspresso\core\libraries\rest_api\controllers\model\Meta', 'filter_ee_metadata_into_index'));
-        EED_Core_Rest_Api::invalidate_cached_route_data_on_version_change();
-    }
-
-
-
-    /**
-     * sets up hooks which only need to be included as part of REST API requests;
-     * other requests like to the frontend or admin etc don't need them
-     */
-    public static function set_hooks_rest_api()
-    {
-        //set hooks which account for changes made to the API
-        EED_Core_Rest_Api::_set_hooks_for_changes();
-    }
-
-
-
-    /**
-     * public wrapper of _set_hooks_for_changes.
-     * Loads all the hooks which make requests to old versions of the API
-     * appear the same as they always did
-     */
-    public static function set_hooks_for_changes()
-    {
-        self::_set_hooks_for_changes();
-    }
-
-
-
-
-
-
-
-    /**
-     * Loads all the hooks which make requests to old versions of the API
-     * appear the same as they always did
-     */
-    protected static function _set_hooks_for_changes()
-    {
-        $folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES . 'rest_api' . DS . 'changes'), false);
-        foreach ($folder_contents as $classname_in_namespace => $filepath) {
-            //ignore the base parent class
-            if ($classname_in_namespace === 'Changes_In_Base') {
-                continue;
-            }
-            $full_classname = 'EventEspresso\core\libraries\rest_api\changes\\' . $classname_in_namespace;
-            if (class_exists($full_classname)) {
-                $instance_of_class = new $full_classname;
-                if ($instance_of_class instanceof Changes_In_Base) {
-                    $instance_of_class->set_hooks();
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * Filters the WP routes to add our EE-related ones. This takes a bit of time
-     * so we actually prefer to only do it when an EE plugin is activated or upgraded
-     */
-    public static function register_routes()
-    {
-        foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
-            foreach ($relative_urls as $endpoint => $routes) {
-                foreach ($routes as $route) {
-                    $route_args = array(
-                        array(
-                            'callback' => $route['callback'],
-                            'methods'  => $route['methods'],
-                            'args'     => isset($route['args']) ? $route['args'] : array(),
-                        )
-                    );
-                    if (isset($route['schema_callback'])) {
-                        $model_name = isset($route['schema_callback'][0])
-                            ? $route['schema_callback'][0]
-                            : '';
-                        $version = isset( $route['schema_callback'][1])
-                            ? $route['schema_callback'][1]
-                            : '';
-                        if (! empty($model_name) && ! empty($version)) {
-                            $route_args['schema'] = function () use ($model_name, $version) {
-                                return ModelRead::handle_schema_request(
-                                    $model_name,
-                                    $version
-                                );
-                            };
-                        }
-                    }
-                    register_rest_route(
-                        $namespace,
-                        $endpoint,
-                        $route_args
-                    );
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * Checks if there was a version change or something that merits invalidating the cached
-     * route data. If so, invalidates the cached route data so that it gets refreshed
-     * next time the WP API is used
-     */
-    public static function invalidate_cached_route_data_on_version_change()
-    {
-        if (EE_System::instance()->detect_req_type() != EE_System::req_type_normal) {
-            EED_Core_Rest_Api::invalidate_cached_route_data();
-        }
-        foreach (EE_Registry::instance()->addons as $addon) {
-            if ($addon instanceof EE_Addon && $addon->detect_req_type() != EE_System::req_type_normal) {
-                EED_Core_Rest_Api::invalidate_cached_route_data();
-            }
-        }
-    }
-
-
-
-    /**
-     * Removes the cached route data so it will get refreshed next time the WP API is used
-     */
-    public static function invalidate_cached_route_data()
-    {
-        //delete the saved EE REST API routes
-        foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden) {
-            delete_option(EED_Core_Rest_Api::saved_routes_option_names . $version);
-        }
-    }
-
-
-
-    /**
-     * Gets the EE route data
-     *
-     * @return array top-level key is the namespace, next-level key is the route and its value is array{
-     * @type string|array $callback
-     * @type string       $methods
-     * @type boolean      $hidden_endpoint
-     * }
-     */
-    public static function get_ee_route_data()
-    {
-        $ee_routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoints) {
-            $ee_routes[self::ee_api_namespace . $version] = self::_get_ee_route_data_for_version($version,
-                $hidden_endpoints);
-        }
-        return $ee_routes;
-    }
-
-
-
-    /**
-     * Gets the EE route data from the wp options if it exists already,
-     * otherwise re-generates it and saves it to the option
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoints
-     * @return array
-     */
-    protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
-    {
-        $ee_routes = get_option(self::saved_routes_option_names . $version, null);
-        if ( ! $ee_routes || (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE)) {
-            $ee_routes = self::_save_ee_route_data_for_version($version, $hidden_endpoints);
-        }
-        return $ee_routes;
-    }
-
-
-
-    /**
-     * Saves the EE REST API route data to a wp option and returns it
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoints
-     * @return mixed|null|void
-     */
-    protected static function _save_ee_route_data_for_version($version, $hidden_endpoints = false)
-    {
-        $instance = self::instance();
-        $routes = apply_filters(
-            'EED_Core_Rest_Api__save_ee_route_data_for_version__routes',
-            array_replace_recursive(
-                $instance->_get_config_route_data_for_version($version, $hidden_endpoints),
-                $instance->_get_meta_route_data_for_version($version, $hidden_endpoints),
-                $instance->_get_model_route_data_for_version($version, $hidden_endpoints),
-                $instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
-            )
-        );
-        $option_name = self::saved_routes_option_names . $version;
-        if (get_option($option_name)) {
-            update_option($option_name, $routes, true);
-        } else {
-            add_option($option_name, $routes, null, 'no');
-        }
-        return $routes;
-    }
-
-
-
-    /**
-     * Calculates all the EE routes and saves it to a wordpress option so we don't
-     * need to calculate it on every request
-     *
-     * @deprecated since version 4.9.1
-     * @return void
-     */
-    public static function save_ee_routes()
-    {
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            $instance = self::instance();
-            $routes = apply_filters(
-                'EED_Core_Rest_Api__save_ee_routes__routes',
-                array_replace_recursive(
-                    $instance->_register_config_routes(),
-                    $instance->_register_meta_routes(),
-                    $instance->_register_model_routes(),
-                    $instance->_register_rpc_routes()
-                )
-            );
-            update_option(self::saved_routes_option_names, $routes, true);
-        }
-    }
-
-
-
-    /**
-     * Gets all the route information relating to EE models
-     *
-     * @return array @see get_ee_route_data
-     * @deprecated since version 4.9.1
-     */
-    protected function _register_model_routes()
-    {
-        $model_routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $model_routes[EED_Core_Rest_Api::ee_api_namespace
-                          . $version] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
-        }
-        return $model_routes;
-    }
-
-
-
-    /**
-     * Gets the route data for EE models in the specified version
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     */
-    protected function _get_model_route_data_for_version($version, $hidden_endpoint = false)
-    {
-        $model_version_info = new Model_Version_Info($version);
-        $models_to_register = apply_filters(
-            'FHEE__EED_Core_REST_API___register_model_routes',
-            $model_version_info->models_for_requested_version()
-        );
-        //let's not bother having endpoints for extra metas
-        unset($models_to_register['Extra_Meta']);
-        unset($models_to_register['Extra_Join']);
-        $model_routes = array();
-        foreach ($models_to_register as $model_name => $model_classname) {
-            $model = \EE_Registry::instance()->load_model($model_name);
-
-            //if this isn't a valid model then let's skip iterate to the next item in the loop.
-            if (! $model instanceof EEM_Base) {
-                continue;
-            }
-
-            //yes we could just register one route for ALL models, but then they wouldn't show up in the index
-            $plural_model_route = EEH_Inflector::pluralize_and_lower($model_name);
-            $singular_model_route = $plural_model_route . '/(?P<id>\d+)';
-            $model_routes[$plural_model_route] = array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                        'handle_request_get_all',
-                    ),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'args'            => $this->_get_read_query_params($model, $version),
-                    '_links'          => array(
-                        'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
-                    ),
-                    'schema_callback' => array($model_name, $version)
-                ),
-                //						array(
-                //							'callback' => array(
-                //								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                //								'handle_request_create_one' ),
-                //							'methods' => WP_REST_Server::CREATABLE,
-                //							'hidden_endpoint' => $hidden_endpoint
-                //						)
-            );
-            $model_routes[$singular_model_route] = array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                        'handle_request_get_one',
-                    ),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'args'            => $this->_get_response_selection_query_params($model, $version),
-                ),
-                //						array(
-                //							'callback' => array(
-                //								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                //								'handle_request_edit_one' ),
-                //							'methods' => WP_REST_Server::EDITABLE,
-                //							'hidden_endpoint' => $hidden_endpoint
-                //							),
-            );
-            //@todo: also handle  DELETE for a single item
-            foreach ($model_version_info->relation_settings($model) as $relation_name => $relation_obj) {
-                $related_model_name_endpoint_part = ModelRead::get_related_entity_name(
-                    $relation_name,
-                    $relation_obj
-                );
-                $model_routes[$singular_model_route . '/' . $related_model_name_endpoint_part] = array(
-                    array(
-                        'callback'        => array(
-                            'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                            'handle_request_get_related',
-                        ),
-                        'methods'         => WP_REST_Server::READABLE,
-                        'hidden_endpoint' => $hidden_endpoint,
-                        'args'            => $this->_get_read_query_params($relation_obj->get_other_model(), $version),
-                    ),
-                    //							array(
-                    //								'callback' => array(
-                    //									'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                    //									'handle_request_create_or_update_related' ),
-                    //								'methods' => WP_REST_Server::EDITABLE,
-                    //								'hidden_endpoint' => $hidden_endpoint
-                    //							)
-                );
-                //@todo: handle delete related and possibly remove relation (not sure hwo to distinguish)
-            }
-        }
-        return $model_routes;
-    }
-
-
-
-    /**
-     * Adds all the RPC-style routes (remote procedure call-like routes, ie
-     * routes that don't conform to the traditional REST CRUD-style).
-     *
-     * @deprecated since 4.9.1
-     */
-    protected function _register_rpc_routes()
-    {
-        $routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $routes[self::ee_api_namespace . $version] = $this->_get_rpc_route_data_for_version($version,
-                $hidden_endpoint);
-        }
-        return $routes;
-    }
-
-
-
-    /**
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     */
-    protected function _get_rpc_route_data_for_version($version, $hidden_endpoint = false)
-    {
-        $this_versions_routes = array();
-        //checkin endpoint
-        $this_versions_routes['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)'] = array(
-            array(
-                'callback'        => array(
-                    'EventEspresso\core\libraries\rest_api\controllers\rpc\Checkin',
-                    'handle_request_toggle_checkin',
-                ),
-                'methods'         => WP_REST_Server::CREATABLE,
-                'hidden_endpoint' => $hidden_endpoint,
-                'args'            => array(
-                    'force' => array(
-                        'required'    => false,
-                        'default'     => false,
-                        'description' => __('Whether to force toggle checkin, or to verify the registration status and allowed ticket uses',
-                            'event_espresso'),
-                    ),
-                ),
-            ),
-        );
-        return apply_filters(
-            'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
-            $this_versions_routes,
-            $version,
-            $hidden_endpoint
-        );
-    }
-
-
-
-    /**
-     * Gets the query params that can be used when request one or many
-     *
-     * @param EEM_Base $model
-     * @param string   $version
-     * @return array
-     */
-    protected function _get_response_selection_query_params(\EEM_Base $model, $version)
-    {
-        return apply_filters(
-            'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
-            array(
-                'include'   => array(
-                    'required' => false,
-                    'default'  => '*',
-                ),
-                'calculate' => array(
-                    'required' => false,
-                    'default'  => '',
-                    'enum'     => self::$_field_calculator->retrieve_calculated_fields_for_model($model),
-                ),
-            ),
-            $model,
-            $version
-        );
-    }
-
-
-
-    /**
-     * Gets info about reading query params that are acceptable
-     *
-     * @param \EEM_Base $model eg 'Event' or 'Venue'
-     * @param  string   $version
-     * @return array    describing the args acceptable when querying this model
-     * @throws \EE_Error
-     */
-    protected function _get_read_query_params(\EEM_Base $model, $version)
-    {
-        $default_orderby = array();
-        foreach ($model->get_combined_primary_key_fields() as $key_field) {
-            $default_orderby[$key_field->get_name()] = 'ASC';
-        }
-        return array_merge(
-            $this->_get_response_selection_query_params($model, $version),
-            array(
-                'where'    => array(
-                    'required' => false,
-                    'default'  => array(),
-                ),
-                'limit'    => array(
-                    'required' => false,
-                    'default'  => EED_Core_Rest_Api::get_default_query_limit(),
-                ),
-                'order_by' => array(
-                    'required' => false,
-                    'default'  => $default_orderby,
-                ),
-                'group_by' => array(
-                    'required' => false,
-                    'default'  => null,
-                ),
-                'having'   => array(
-                    'required' => false,
-                    'default'  => null,
-                ),
-                'caps'     => array(
-                    'required' => false,
-                    'default'  => EEM_Base::caps_read,
-                ),
-            )
-        );
-    }
-
-
-
-    /**
-     * Gets routes for the config
-     *
-     * @return array @see _register_model_routes
-     * @deprecated since version 4.9.1
-     */
-    protected function _register_config_routes()
-    {
-        $config_routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $config_routes[self::ee_api_namespace . $version] = $this->_get_config_route_data_for_version($version,
-                $hidden_endpoint);
-        }
-        return $config_routes;
-    }
-
-
-
-    /**
-     * Gets routes for the config for the specified version
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     */
-    protected function _get_config_route_data_for_version($version, $hidden_endpoint)
-    {
-        return array(
-            'config'    => array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\config\Read',
-                        'handle_request',
-                    ),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                ),
-            ),
-            'site_info' => array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\config\Read',
-                        'handle_request_site_info',
-                    ),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                ),
-            ),
-        );
-    }
-
-
-
-    /**
-     * Gets the meta info routes
-     *
-     * @return array @see _register_model_routes
-     * @deprecated since version 4.9.1
-     */
-    protected function _register_meta_routes()
-    {
-        $meta_routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $meta_routes[self::ee_api_namespace . $version] = $this->_get_meta_route_data_for_version($version,
-                $hidden_endpoint);
-        }
-        return $meta_routes;
-    }
-
-
-
-    /**
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     */
-    protected function _get_meta_route_data_for_version($version, $hidden_endpoint = false)
-    {
-        return array(
-            'resources' => array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Meta',
-                        'handle_request_models_meta',
-                    ),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                ),
-            ),
-        );
-    }
-
-
-
-    /**
-     * Tries to hide old 4.6 endpoints from the
-     *
-     * @param array $route_data
-     * @return array
-     */
-    public static function hide_old_endpoints($route_data)
-    {
-        //allow API clients to override which endpoints get hidden, in case
-        //they want to discover particular endpoints
-        //also, we don't have access to the request so we have to just grab it from the superglobal
-        $force_show_ee_namespace = ltrim(
-            EEH_Array::is_set($_REQUEST, 'force_show_ee_namespace', ''),
-            '/'
-        );
-        foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
-            foreach ($relative_urls as $endpoint => $routes) {
-                foreach ($routes as $route) {
-                    //by default, hide "hidden_endpoint"s, unless the request indicates
-                    //to $force_show_ee_namespace, in which case only show that one
-                    //namespace's endpoints (and hide all others)
-                    if (($route['hidden_endpoint'] && $force_show_ee_namespace === '')
-                        || ($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace)
-                    ) {
-                        $full_route = '/' . ltrim($namespace, '/') . '/' . ltrim($endpoint, '/');
-                        unset($route_data[$full_route]);
-                    }
-                }
-            }
-        }
-        return $route_data;
-    }
-
-
-
-    /**
-     * Returns an array describing which versions of core support serving requests for.
-     * Keys are core versions' major and minor version, and values are the
-     * LOWEST requested version they can serve. Eg, 4.7 can serve requests for 4.6-like
-     * data by just removing a few models and fields from the responses. However, 4.15 might remove
-     * the answers table entirely, in which case it would be very difficult for
-     * it to serve 4.6-style responses.
-     * Versions of core that are missing from this array are unknowns.
-     * previous ver
-     *
-     * @return array
-     */
-    public static function version_compatibilities()
-    {
-        return apply_filters(
-            'FHEE__EED_Core_REST_API__version_compatibilities',
-            array(
-                '4.8.29' => '4.8.29',
-                '4.8.33' => '4.8.29',
-                '4.8.34' => '4.8.29',
-                '4.8.36' => '4.8.29',
-            )
-        );
-    }
-
-
-
-    /**
-     * Gets the latest API version served. Eg if there
-     * are two versions served of the API, 4.8.29 and 4.8.32, and
-     * we are on core version 4.8.34, it will return the string "4.8.32"
-     *
-     * @return string
-     */
-    public static function latest_rest_api_version()
-    {
-        $versions_served = \EED_Core_Rest_Api::versions_served();
-        $versions_served_keys = array_keys($versions_served);
-        return end($versions_served_keys);
-    }
-
-
-
-    /**
-     * Using EED_Core_Rest_Api::version_compatibilities(), determines what version of
-     * EE the API can serve requests for. Eg, if we are on 4.15 of core, and
-     * we can serve requests from 4.12 or later, this will return array( '4.12', '4.13', '4.14', '4.15' ).
-     * We also indicate whether or not this version should be put in the index or not
-     *
-     * @return array keys are API version numbers (just major and minor numbers), and values
-     * are whether or not they should be hidden
-     */
-    public static function versions_served()
-    {
-        $versions_served = array();
-        $possibly_served_versions = EED_Core_Rest_Api::version_compatibilities();
-        $lowest_compatible_version = end($possibly_served_versions);
-        reset($possibly_served_versions);
-        $versions_served_historically = array_keys($possibly_served_versions);
-        $latest_version = end($versions_served_historically);
-        reset($versions_served_historically);
-        //for each version of core we have ever served:
-        foreach ($versions_served_historically as $key_versioned_endpoint) {
-            //if it's not above the current core version, and it's compatible with the current version of core
-            if ($key_versioned_endpoint == $latest_version) {
-                //don't hide the latest version in the index
-                $versions_served[$key_versioned_endpoint] = false;
-            } else if (
-                $key_versioned_endpoint < EED_Core_Rest_Api::core_version()
-                && $key_versioned_endpoint >= $lowest_compatible_version
-            ) {
-                //include, but hide, previous versions which are still supported
-                $versions_served[$key_versioned_endpoint] = true;
-            } elseif (
-            apply_filters(
-                'FHEE__EED_Core_Rest_Api__versions_served__include_incompatible_versions',
-                false,
-                $possibly_served_versions
-            )
-            ) {
-                //if a version is no longer supported, don't include it in index or list of versions served
-                $versions_served[$key_versioned_endpoint] = true;
-            }
-        }
-        return $versions_served;
-    }
-
-
-
-    /**
-     * Gets the major and minor version of EE core's version string
-     *
-     * @return string
-     */
-    public static function core_version()
-    {
-        return apply_filters('FHEE__EED_Core_REST_API__core_version',
-            implode('.', array_slice(explode('.', espresso_version()), 0, 3)));
-    }
-
-
-
-    /**
-     * Gets the default limit that should be used when querying for resources
-     *
-     * @return int
-     */
-    public static function get_default_query_limit()
-    {
-        //we actually don't use a const because we want folks to always use
-        //this method, not the const directly
-        return apply_filters(
-            'FHEE__EED_Core_Rest_Api__get_default_query_limit',
-            50
-        );
-    }
-
-
-
-    /**
-     *    run - initial module setup
-     *
-     * @access    public
-     * @param  WP $WP
-     * @return    void
-     */
-    public function run($WP)
-    {
-    }
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		self::set_hooks_both();
+	}
+
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		self::set_hooks_both();
+	}
+
+
+
+	public static function set_hooks_both()
+	{
+		add_action('rest_api_init', array('EED_Core_Rest_Api', 'register_routes'), 10);
+		add_action('rest_api_init', array('EED_Core_Rest_Api', 'set_hooks_rest_api'), 5);
+		add_filter('rest_route_data', array('EED_Core_Rest_Api', 'hide_old_endpoints'), 10, 2);
+		add_filter('rest_index',
+			array('EventEspresso\core\libraries\rest_api\controllers\model\Meta', 'filter_ee_metadata_into_index'));
+		EED_Core_Rest_Api::invalidate_cached_route_data_on_version_change();
+	}
+
+
+
+	/**
+	 * sets up hooks which only need to be included as part of REST API requests;
+	 * other requests like to the frontend or admin etc don't need them
+	 */
+	public static function set_hooks_rest_api()
+	{
+		//set hooks which account for changes made to the API
+		EED_Core_Rest_Api::_set_hooks_for_changes();
+	}
+
+
+
+	/**
+	 * public wrapper of _set_hooks_for_changes.
+	 * Loads all the hooks which make requests to old versions of the API
+	 * appear the same as they always did
+	 */
+	public static function set_hooks_for_changes()
+	{
+		self::_set_hooks_for_changes();
+	}
+
+
+
+
+
+
+
+	/**
+	 * Loads all the hooks which make requests to old versions of the API
+	 * appear the same as they always did
+	 */
+	protected static function _set_hooks_for_changes()
+	{
+		$folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES . 'rest_api' . DS . 'changes'), false);
+		foreach ($folder_contents as $classname_in_namespace => $filepath) {
+			//ignore the base parent class
+			if ($classname_in_namespace === 'Changes_In_Base') {
+				continue;
+			}
+			$full_classname = 'EventEspresso\core\libraries\rest_api\changes\\' . $classname_in_namespace;
+			if (class_exists($full_classname)) {
+				$instance_of_class = new $full_classname;
+				if ($instance_of_class instanceof Changes_In_Base) {
+					$instance_of_class->set_hooks();
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * Filters the WP routes to add our EE-related ones. This takes a bit of time
+	 * so we actually prefer to only do it when an EE plugin is activated or upgraded
+	 */
+	public static function register_routes()
+	{
+		foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
+			foreach ($relative_urls as $endpoint => $routes) {
+				foreach ($routes as $route) {
+					$route_args = array(
+						array(
+							'callback' => $route['callback'],
+							'methods'  => $route['methods'],
+							'args'     => isset($route['args']) ? $route['args'] : array(),
+						)
+					);
+					if (isset($route['schema_callback'])) {
+						$model_name = isset($route['schema_callback'][0])
+							? $route['schema_callback'][0]
+							: '';
+						$version = isset( $route['schema_callback'][1])
+							? $route['schema_callback'][1]
+							: '';
+						if (! empty($model_name) && ! empty($version)) {
+							$route_args['schema'] = function () use ($model_name, $version) {
+								return ModelRead::handle_schema_request(
+									$model_name,
+									$version
+								);
+							};
+						}
+					}
+					register_rest_route(
+						$namespace,
+						$endpoint,
+						$route_args
+					);
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * Checks if there was a version change or something that merits invalidating the cached
+	 * route data. If so, invalidates the cached route data so that it gets refreshed
+	 * next time the WP API is used
+	 */
+	public static function invalidate_cached_route_data_on_version_change()
+	{
+		if (EE_System::instance()->detect_req_type() != EE_System::req_type_normal) {
+			EED_Core_Rest_Api::invalidate_cached_route_data();
+		}
+		foreach (EE_Registry::instance()->addons as $addon) {
+			if ($addon instanceof EE_Addon && $addon->detect_req_type() != EE_System::req_type_normal) {
+				EED_Core_Rest_Api::invalidate_cached_route_data();
+			}
+		}
+	}
+
+
+
+	/**
+	 * Removes the cached route data so it will get refreshed next time the WP API is used
+	 */
+	public static function invalidate_cached_route_data()
+	{
+		//delete the saved EE REST API routes
+		foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden) {
+			delete_option(EED_Core_Rest_Api::saved_routes_option_names . $version);
+		}
+	}
+
+
+
+	/**
+	 * Gets the EE route data
+	 *
+	 * @return array top-level key is the namespace, next-level key is the route and its value is array{
+	 * @type string|array $callback
+	 * @type string       $methods
+	 * @type boolean      $hidden_endpoint
+	 * }
+	 */
+	public static function get_ee_route_data()
+	{
+		$ee_routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoints) {
+			$ee_routes[self::ee_api_namespace . $version] = self::_get_ee_route_data_for_version($version,
+				$hidden_endpoints);
+		}
+		return $ee_routes;
+	}
+
+
+
+	/**
+	 * Gets the EE route data from the wp options if it exists already,
+	 * otherwise re-generates it and saves it to the option
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoints
+	 * @return array
+	 */
+	protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
+	{
+		$ee_routes = get_option(self::saved_routes_option_names . $version, null);
+		if ( ! $ee_routes || (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE)) {
+			$ee_routes = self::_save_ee_route_data_for_version($version, $hidden_endpoints);
+		}
+		return $ee_routes;
+	}
+
+
+
+	/**
+	 * Saves the EE REST API route data to a wp option and returns it
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoints
+	 * @return mixed|null|void
+	 */
+	protected static function _save_ee_route_data_for_version($version, $hidden_endpoints = false)
+	{
+		$instance = self::instance();
+		$routes = apply_filters(
+			'EED_Core_Rest_Api__save_ee_route_data_for_version__routes',
+			array_replace_recursive(
+				$instance->_get_config_route_data_for_version($version, $hidden_endpoints),
+				$instance->_get_meta_route_data_for_version($version, $hidden_endpoints),
+				$instance->_get_model_route_data_for_version($version, $hidden_endpoints),
+				$instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
+			)
+		);
+		$option_name = self::saved_routes_option_names . $version;
+		if (get_option($option_name)) {
+			update_option($option_name, $routes, true);
+		} else {
+			add_option($option_name, $routes, null, 'no');
+		}
+		return $routes;
+	}
+
+
+
+	/**
+	 * Calculates all the EE routes and saves it to a wordpress option so we don't
+	 * need to calculate it on every request
+	 *
+	 * @deprecated since version 4.9.1
+	 * @return void
+	 */
+	public static function save_ee_routes()
+	{
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			$instance = self::instance();
+			$routes = apply_filters(
+				'EED_Core_Rest_Api__save_ee_routes__routes',
+				array_replace_recursive(
+					$instance->_register_config_routes(),
+					$instance->_register_meta_routes(),
+					$instance->_register_model_routes(),
+					$instance->_register_rpc_routes()
+				)
+			);
+			update_option(self::saved_routes_option_names, $routes, true);
+		}
+	}
+
+
+
+	/**
+	 * Gets all the route information relating to EE models
+	 *
+	 * @return array @see get_ee_route_data
+	 * @deprecated since version 4.9.1
+	 */
+	protected function _register_model_routes()
+	{
+		$model_routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$model_routes[EED_Core_Rest_Api::ee_api_namespace
+						  . $version] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
+		}
+		return $model_routes;
+	}
+
+
+
+	/**
+	 * Gets the route data for EE models in the specified version
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 */
+	protected function _get_model_route_data_for_version($version, $hidden_endpoint = false)
+	{
+		$model_version_info = new Model_Version_Info($version);
+		$models_to_register = apply_filters(
+			'FHEE__EED_Core_REST_API___register_model_routes',
+			$model_version_info->models_for_requested_version()
+		);
+		//let's not bother having endpoints for extra metas
+		unset($models_to_register['Extra_Meta']);
+		unset($models_to_register['Extra_Join']);
+		$model_routes = array();
+		foreach ($models_to_register as $model_name => $model_classname) {
+			$model = \EE_Registry::instance()->load_model($model_name);
+
+			//if this isn't a valid model then let's skip iterate to the next item in the loop.
+			if (! $model instanceof EEM_Base) {
+				continue;
+			}
+
+			//yes we could just register one route for ALL models, but then they wouldn't show up in the index
+			$plural_model_route = EEH_Inflector::pluralize_and_lower($model_name);
+			$singular_model_route = $plural_model_route . '/(?P<id>\d+)';
+			$model_routes[$plural_model_route] = array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+						'handle_request_get_all',
+					),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'args'            => $this->_get_read_query_params($model, $version),
+					'_links'          => array(
+						'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
+					),
+					'schema_callback' => array($model_name, $version)
+				),
+				//						array(
+				//							'callback' => array(
+				//								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+				//								'handle_request_create_one' ),
+				//							'methods' => WP_REST_Server::CREATABLE,
+				//							'hidden_endpoint' => $hidden_endpoint
+				//						)
+			);
+			$model_routes[$singular_model_route] = array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+						'handle_request_get_one',
+					),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'args'            => $this->_get_response_selection_query_params($model, $version),
+				),
+				//						array(
+				//							'callback' => array(
+				//								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+				//								'handle_request_edit_one' ),
+				//							'methods' => WP_REST_Server::EDITABLE,
+				//							'hidden_endpoint' => $hidden_endpoint
+				//							),
+			);
+			//@todo: also handle  DELETE for a single item
+			foreach ($model_version_info->relation_settings($model) as $relation_name => $relation_obj) {
+				$related_model_name_endpoint_part = ModelRead::get_related_entity_name(
+					$relation_name,
+					$relation_obj
+				);
+				$model_routes[$singular_model_route . '/' . $related_model_name_endpoint_part] = array(
+					array(
+						'callback'        => array(
+							'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+							'handle_request_get_related',
+						),
+						'methods'         => WP_REST_Server::READABLE,
+						'hidden_endpoint' => $hidden_endpoint,
+						'args'            => $this->_get_read_query_params($relation_obj->get_other_model(), $version),
+					),
+					//							array(
+					//								'callback' => array(
+					//									'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+					//									'handle_request_create_or_update_related' ),
+					//								'methods' => WP_REST_Server::EDITABLE,
+					//								'hidden_endpoint' => $hidden_endpoint
+					//							)
+				);
+				//@todo: handle delete related and possibly remove relation (not sure hwo to distinguish)
+			}
+		}
+		return $model_routes;
+	}
+
+
+
+	/**
+	 * Adds all the RPC-style routes (remote procedure call-like routes, ie
+	 * routes that don't conform to the traditional REST CRUD-style).
+	 *
+	 * @deprecated since 4.9.1
+	 */
+	protected function _register_rpc_routes()
+	{
+		$routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$routes[self::ee_api_namespace . $version] = $this->_get_rpc_route_data_for_version($version,
+				$hidden_endpoint);
+		}
+		return $routes;
+	}
+
+
+
+	/**
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 */
+	protected function _get_rpc_route_data_for_version($version, $hidden_endpoint = false)
+	{
+		$this_versions_routes = array();
+		//checkin endpoint
+		$this_versions_routes['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)'] = array(
+			array(
+				'callback'        => array(
+					'EventEspresso\core\libraries\rest_api\controllers\rpc\Checkin',
+					'handle_request_toggle_checkin',
+				),
+				'methods'         => WP_REST_Server::CREATABLE,
+				'hidden_endpoint' => $hidden_endpoint,
+				'args'            => array(
+					'force' => array(
+						'required'    => false,
+						'default'     => false,
+						'description' => __('Whether to force toggle checkin, or to verify the registration status and allowed ticket uses',
+							'event_espresso'),
+					),
+				),
+			),
+		);
+		return apply_filters(
+			'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
+			$this_versions_routes,
+			$version,
+			$hidden_endpoint
+		);
+	}
+
+
+
+	/**
+	 * Gets the query params that can be used when request one or many
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $version
+	 * @return array
+	 */
+	protected function _get_response_selection_query_params(\EEM_Base $model, $version)
+	{
+		return apply_filters(
+			'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
+			array(
+				'include'   => array(
+					'required' => false,
+					'default'  => '*',
+				),
+				'calculate' => array(
+					'required' => false,
+					'default'  => '',
+					'enum'     => self::$_field_calculator->retrieve_calculated_fields_for_model($model),
+				),
+			),
+			$model,
+			$version
+		);
+	}
+
+
+
+	/**
+	 * Gets info about reading query params that are acceptable
+	 *
+	 * @param \EEM_Base $model eg 'Event' or 'Venue'
+	 * @param  string   $version
+	 * @return array    describing the args acceptable when querying this model
+	 * @throws \EE_Error
+	 */
+	protected function _get_read_query_params(\EEM_Base $model, $version)
+	{
+		$default_orderby = array();
+		foreach ($model->get_combined_primary_key_fields() as $key_field) {
+			$default_orderby[$key_field->get_name()] = 'ASC';
+		}
+		return array_merge(
+			$this->_get_response_selection_query_params($model, $version),
+			array(
+				'where'    => array(
+					'required' => false,
+					'default'  => array(),
+				),
+				'limit'    => array(
+					'required' => false,
+					'default'  => EED_Core_Rest_Api::get_default_query_limit(),
+				),
+				'order_by' => array(
+					'required' => false,
+					'default'  => $default_orderby,
+				),
+				'group_by' => array(
+					'required' => false,
+					'default'  => null,
+				),
+				'having'   => array(
+					'required' => false,
+					'default'  => null,
+				),
+				'caps'     => array(
+					'required' => false,
+					'default'  => EEM_Base::caps_read,
+				),
+			)
+		);
+	}
+
+
+
+	/**
+	 * Gets routes for the config
+	 *
+	 * @return array @see _register_model_routes
+	 * @deprecated since version 4.9.1
+	 */
+	protected function _register_config_routes()
+	{
+		$config_routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$config_routes[self::ee_api_namespace . $version] = $this->_get_config_route_data_for_version($version,
+				$hidden_endpoint);
+		}
+		return $config_routes;
+	}
+
+
+
+	/**
+	 * Gets routes for the config for the specified version
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 */
+	protected function _get_config_route_data_for_version($version, $hidden_endpoint)
+	{
+		return array(
+			'config'    => array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\config\Read',
+						'handle_request',
+					),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+				),
+			),
+			'site_info' => array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\config\Read',
+						'handle_request_site_info',
+					),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+				),
+			),
+		);
+	}
+
+
+
+	/**
+	 * Gets the meta info routes
+	 *
+	 * @return array @see _register_model_routes
+	 * @deprecated since version 4.9.1
+	 */
+	protected function _register_meta_routes()
+	{
+		$meta_routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$meta_routes[self::ee_api_namespace . $version] = $this->_get_meta_route_data_for_version($version,
+				$hidden_endpoint);
+		}
+		return $meta_routes;
+	}
+
+
+
+	/**
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 */
+	protected function _get_meta_route_data_for_version($version, $hidden_endpoint = false)
+	{
+		return array(
+			'resources' => array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\model\Meta',
+						'handle_request_models_meta',
+					),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+				),
+			),
+		);
+	}
+
+
+
+	/**
+	 * Tries to hide old 4.6 endpoints from the
+	 *
+	 * @param array $route_data
+	 * @return array
+	 */
+	public static function hide_old_endpoints($route_data)
+	{
+		//allow API clients to override which endpoints get hidden, in case
+		//they want to discover particular endpoints
+		//also, we don't have access to the request so we have to just grab it from the superglobal
+		$force_show_ee_namespace = ltrim(
+			EEH_Array::is_set($_REQUEST, 'force_show_ee_namespace', ''),
+			'/'
+		);
+		foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
+			foreach ($relative_urls as $endpoint => $routes) {
+				foreach ($routes as $route) {
+					//by default, hide "hidden_endpoint"s, unless the request indicates
+					//to $force_show_ee_namespace, in which case only show that one
+					//namespace's endpoints (and hide all others)
+					if (($route['hidden_endpoint'] && $force_show_ee_namespace === '')
+						|| ($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace)
+					) {
+						$full_route = '/' . ltrim($namespace, '/') . '/' . ltrim($endpoint, '/');
+						unset($route_data[$full_route]);
+					}
+				}
+			}
+		}
+		return $route_data;
+	}
+
+
+
+	/**
+	 * Returns an array describing which versions of core support serving requests for.
+	 * Keys are core versions' major and minor version, and values are the
+	 * LOWEST requested version they can serve. Eg, 4.7 can serve requests for 4.6-like
+	 * data by just removing a few models and fields from the responses. However, 4.15 might remove
+	 * the answers table entirely, in which case it would be very difficult for
+	 * it to serve 4.6-style responses.
+	 * Versions of core that are missing from this array are unknowns.
+	 * previous ver
+	 *
+	 * @return array
+	 */
+	public static function version_compatibilities()
+	{
+		return apply_filters(
+			'FHEE__EED_Core_REST_API__version_compatibilities',
+			array(
+				'4.8.29' => '4.8.29',
+				'4.8.33' => '4.8.29',
+				'4.8.34' => '4.8.29',
+				'4.8.36' => '4.8.29',
+			)
+		);
+	}
+
+
+
+	/**
+	 * Gets the latest API version served. Eg if there
+	 * are two versions served of the API, 4.8.29 and 4.8.32, and
+	 * we are on core version 4.8.34, it will return the string "4.8.32"
+	 *
+	 * @return string
+	 */
+	public static function latest_rest_api_version()
+	{
+		$versions_served = \EED_Core_Rest_Api::versions_served();
+		$versions_served_keys = array_keys($versions_served);
+		return end($versions_served_keys);
+	}
+
+
+
+	/**
+	 * Using EED_Core_Rest_Api::version_compatibilities(), determines what version of
+	 * EE the API can serve requests for. Eg, if we are on 4.15 of core, and
+	 * we can serve requests from 4.12 or later, this will return array( '4.12', '4.13', '4.14', '4.15' ).
+	 * We also indicate whether or not this version should be put in the index or not
+	 *
+	 * @return array keys are API version numbers (just major and minor numbers), and values
+	 * are whether or not they should be hidden
+	 */
+	public static function versions_served()
+	{
+		$versions_served = array();
+		$possibly_served_versions = EED_Core_Rest_Api::version_compatibilities();
+		$lowest_compatible_version = end($possibly_served_versions);
+		reset($possibly_served_versions);
+		$versions_served_historically = array_keys($possibly_served_versions);
+		$latest_version = end($versions_served_historically);
+		reset($versions_served_historically);
+		//for each version of core we have ever served:
+		foreach ($versions_served_historically as $key_versioned_endpoint) {
+			//if it's not above the current core version, and it's compatible with the current version of core
+			if ($key_versioned_endpoint == $latest_version) {
+				//don't hide the latest version in the index
+				$versions_served[$key_versioned_endpoint] = false;
+			} else if (
+				$key_versioned_endpoint < EED_Core_Rest_Api::core_version()
+				&& $key_versioned_endpoint >= $lowest_compatible_version
+			) {
+				//include, but hide, previous versions which are still supported
+				$versions_served[$key_versioned_endpoint] = true;
+			} elseif (
+			apply_filters(
+				'FHEE__EED_Core_Rest_Api__versions_served__include_incompatible_versions',
+				false,
+				$possibly_served_versions
+			)
+			) {
+				//if a version is no longer supported, don't include it in index or list of versions served
+				$versions_served[$key_versioned_endpoint] = true;
+			}
+		}
+		return $versions_served;
+	}
+
+
+
+	/**
+	 * Gets the major and minor version of EE core's version string
+	 *
+	 * @return string
+	 */
+	public static function core_version()
+	{
+		return apply_filters('FHEE__EED_Core_REST_API__core_version',
+			implode('.', array_slice(explode('.', espresso_version()), 0, 3)));
+	}
+
+
+
+	/**
+	 * Gets the default limit that should be used when querying for resources
+	 *
+	 * @return int
+	 */
+	public static function get_default_query_limit()
+	{
+		//we actually don't use a const because we want folks to always use
+		//this method, not the const directly
+		return apply_filters(
+			'FHEE__EED_Core_Rest_Api__get_default_query_limit',
+			50
+		);
+	}
+
+
+
+	/**
+	 *    run - initial module setup
+	 *
+	 * @access    public
+	 * @param  WP $WP
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+	}
 
 
 

core/db_classes/EE_Line_Item.class.php

Indentation +52 added lines, -52 removed lines

@@ -172,7 +172,7 @@ 
 	 * Sets quantity
 	 * @param int $quantity
 	 */
-    public function set_quantity( $quantity ) {
+	public function set_quantity( $quantity ) {
 		$this->set( 'LIN_quantity', max( $quantity, 0 ) );
 	}
 
@@ -212,25 +212,25 @@ 
 	 * Gets item_type
 	 * @return string
 	 */
-    public function OBJ_type_i18n() {
-	    $obj_type = $this->OBJ_type();
-        switch ($obj_type) {
-            case 'Event':
-                $obj_type = __('Event', 'event_espresso');
-                break;
-            case 'Price':
-                $obj_type = __('Price', 'event_espresso');
-                break;
-            case 'Promotion':
-                $obj_type = __('Promotion', 'event_espresso');
-                break;
-            case 'Ticket':
-                $obj_type = __('Ticket', 'event_espresso');
-                break;
-            case 'Transaction':
-                $obj_type = __('Transaction', 'event_espresso');
-                break;
-        }
+	public function OBJ_type_i18n() {
+		$obj_type = $this->OBJ_type();
+		switch ($obj_type) {
+			case 'Event':
+				$obj_type = __('Event', 'event_espresso');
+				break;
+			case 'Price':
+				$obj_type = __('Price', 'event_espresso');
+				break;
+			case 'Promotion':
+				$obj_type = __('Promotion', 'event_espresso');
+				break;
+			case 'Ticket':
+				$obj_type = __('Ticket', 'event_espresso');
+				break;
+			case 'Transaction':
+				$obj_type = __('Transaction', 'event_espresso');
+				break;
+		}
 		return apply_filters('FHEE__EE_Line_Item__OBJ_type_i18n', $obj_type, $this);
 	}
 
@@ -1244,48 +1244,48 @@ 
 
 
 
-    /**
-     * @param bool $raw
-     * @return int
-     * @throws \EE_Error
-     */
-    public function timestamp($raw = false)
-    {
-        return $raw ? $this->get_raw('LIN_timestamp') : $this->get('LIN_timestamp');
-    }
+	/**
+	 * @param bool $raw
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public function timestamp($raw = false)
+	{
+		return $raw ? $this->get_raw('LIN_timestamp') : $this->get('LIN_timestamp');
+	}
 
 
 
 
-    /************************* DEPRECATED *************************/
+	/************************* DEPRECATED *************************/
 
 
 
-    /**
-     * @deprecated
-     * @param string $type one of the constants on EEM_Line_Item
-     * @return EE_Line_Item[]
-     */
-    protected function _get_descendants_of_type($type)
-    {
-        EE_Error::doing_it_wrong('EE_Line_Item::_get_descendants_of_type()',
-            __('Method replaced with EEH_Line_Item::get_descendants_of_type()', 'event_espresso'), '4.6.0');
-        return EEH_Line_Item::get_descendants_of_type($this, $type);
-    }
+	/**
+	 * @deprecated
+	 * @param string $type one of the constants on EEM_Line_Item
+	 * @return EE_Line_Item[]
+	 */
+	protected function _get_descendants_of_type($type)
+	{
+		EE_Error::doing_it_wrong('EE_Line_Item::_get_descendants_of_type()',
+			__('Method replaced with EEH_Line_Item::get_descendants_of_type()', 'event_espresso'), '4.6.0');
+		return EEH_Line_Item::get_descendants_of_type($this, $type);
+	}
 
 
 
-    /**
-     * @deprecated
-     * @param string $type like one of the EEM_Line_Item::type_*
-     * @return EE_Line_Item
-     */
-    public function get_nearest_descendant_of_type($type)
-    {
-        EE_Error::doing_it_wrong('EE_Line_Item::get_nearest_descendant_of_type()',
-            __('Method replaced with EEH_Line_Item::get_nearest_descendant_of_type()', 'event_espresso'), '4.6.0');
-        return EEH_Line_Item::get_nearest_descendant_of_type($this, $type);
-    }
+	/**
+	 * @deprecated
+	 * @param string $type like one of the EEM_Line_Item::type_*
+	 * @return EE_Line_Item
+	 */
+	public function get_nearest_descendant_of_type($type)
+	{
+		EE_Error::doing_it_wrong('EE_Line_Item::get_nearest_descendant_of_type()',
+			__('Method replaced with EEH_Line_Item::get_nearest_descendant_of_type()', 'event_espresso'), '4.6.0');
+		return EEH_Line_Item::get_nearest_descendant_of_type($this, $type);
+	}
 
 
 

Spacing +209 added lines, -209 removed lines

@@ -1,5 +1,5 @@ 
-<?php if ( !defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 /**
  * Event Espresso
@@ -50,9 +50,9 @@ 
 	 *                             		    date_format and the second value is the time format
 	 * @return EE_Line_Item
 	 */
-	public static function new_instance( $props_n_values = array(), $timezone = null, $date_formats = array() ) {
-		$has_object = parent::_check_for_object( $props_n_values, __CLASS__, $timezone, $date_formats );
-		return $has_object ? $has_object : new self( $props_n_values, false, $timezone, $date_formats );
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) {
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
 	}
 
 
@@ -63,8 +63,8 @@ 
 	 *                          		the website will be used.
 	 * @return EE_Line_Item
 	 */
-	public static function new_instance_from_db( $props_n_values = array(), $timezone = null ) {
-		return new self( $props_n_values, TRUE, $timezone );
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null) {
+		return new self($props_n_values, TRUE, $timezone);
 	}
 
 
@@ -75,10 +75,10 @@ 
 	 * @param bool   $bydb
 	 * @param string $timezone
 	 */
-	protected function __construct( $fieldValues = array(), $bydb = FALSE, $timezone = '' ) {
-		parent::__construct( $fieldValues, $bydb, $timezone );
-		if ( ! $this->get( 'LIN_code' ) ) {
-			$this->set_code( $this->generate_code() );
+	protected function __construct($fieldValues = array(), $bydb = FALSE, $timezone = '') {
+		parent::__construct($fieldValues, $bydb, $timezone);
+		if ( ! $this->get('LIN_code')) {
+			$this->set_code($this->generate_code());
 		}
 	}
 
@@ -89,7 +89,7 @@ 
 	 * @return int
 	 */
 	public function ID() {
-		return $this->get( 'LIN_ID' );
+		return $this->get('LIN_ID');
 	}
 
 
@@ -99,7 +99,7 @@ 
 	 * @return int
 	 */
 	public function TXN_ID() {
-		return $this->get( 'TXN_ID' );
+		return $this->get('TXN_ID');
 	}
 
 
@@ -108,8 +108,8 @@ 
 	 * Sets TXN_ID
 	 * @param int $TXN_ID
 	 */
-	public function set_TXN_ID( $TXN_ID ) {
-		$this->set( 'TXN_ID', $TXN_ID );
+	public function set_TXN_ID($TXN_ID) {
+		$this->set('TXN_ID', $TXN_ID);
 	}
 
 
@@ -119,9 +119,9 @@ 
 	 * @return string
 	 */
 	public function name() {
-		$name =  $this->get( 'LIN_name' );
-		if( ! $name ){
-			$name = ucwords( str_replace( '-', ' ', $this->type() ) );
+		$name = $this->get('LIN_name');
+		if ( ! $name) {
+			$name = ucwords(str_replace('-', ' ', $this->type()));
 		}
 		return $name;
 	}
@@ -132,8 +132,8 @@ 
 	 * Sets name
 	 * @param string $name
 	 */
-	public function set_name( $name ) {
-		$this->set( 'LIN_name', $name );
+	public function set_name($name) {
+		$this->set('LIN_name', $name);
 	}
 
 
@@ -143,7 +143,7 @@ 
 	 * @return string
 	 */
 	public function desc() {
-		return $this->get( 'LIN_desc' );
+		return $this->get('LIN_desc');
 	}
 
 
@@ -152,8 +152,8 @@ 
 	 * Sets desc
 	 * @param string $desc
 	 */
-	public function set_desc( $desc ) {
-		$this->set( 'LIN_desc', $desc );
+	public function set_desc($desc) {
+		$this->set('LIN_desc', $desc);
 	}
 
 
@@ -163,7 +163,7 @@ 
 	 * @return int
 	 */
 	public function quantity() {
-		return $this->get( 'LIN_quantity' );
+		return $this->get('LIN_quantity');
 	}
 
 
@@ -172,8 +172,8 @@ 
 	 * Sets quantity
 	 * @param int $quantity
 	 */
-    public function set_quantity( $quantity ) {
-		$this->set( 'LIN_quantity', max( $quantity, 0 ) );
+    public function set_quantity($quantity) {
+		$this->set('LIN_quantity', max($quantity, 0));
 	}
 
 
@@ -183,7 +183,7 @@ 
 	 * @return string
 	 */
 	public function OBJ_ID() {
-		return $this->get( 'OBJ_ID' );
+		return $this->get('OBJ_ID');
 	}
 
 
@@ -192,8 +192,8 @@ 
 	 * Sets item_id
 	 * @param string $item_id
 	 */
-	public function set_OBJ_ID( $item_id ) {
-		$this->set( 'OBJ_ID', $item_id );
+	public function set_OBJ_ID($item_id) {
+		$this->set('OBJ_ID', $item_id);
 	}
 
 
@@ -203,7 +203,7 @@ 
 	 * @return string
 	 */
 	public function OBJ_type() {
-		return $this->get( 'OBJ_type' );
+		return $this->get('OBJ_type');
 	}
 
 
@@ -240,8 +240,8 @@ 
 	 * Sets item_type
 	 * @param string $OBJ_type
 	 */
-	public function set_OBJ_type( $OBJ_type ) {
-		$this->set( 'OBJ_type', $OBJ_type );
+	public function set_OBJ_type($OBJ_type) {
+		$this->set('OBJ_type', $OBJ_type);
 	}
 
 
@@ -251,7 +251,7 @@ 
 	 * @return float
 	 */
 	public function unit_price() {
-		return $this->get( 'LIN_unit_price' );
+		return $this->get('LIN_unit_price');
 	}
 
 
@@ -261,8 +261,8 @@ 
 	 *
 	 * @param float $unit_price
 	 */
-	public function set_unit_price( $unit_price ) {
-		$this->set( 'LIN_unit_price', $unit_price );
+	public function set_unit_price($unit_price) {
+		$this->set('LIN_unit_price', $unit_price);
 	}
 
 
@@ -273,19 +273,19 @@ 
 	 * @return boolean
 	 */
 	public function is_percent() {
-		if( $this->is_tax_sub_total() ) {
+		if ($this->is_tax_sub_total()) {
 			//tax subtotals HAVE a percent on them, that percentage only applies
 			//to taxable items, so its' an exception. Treat it like a flat line item
 			return false;
 		}
-		$unit_price = abs( $this->get( 'LIN_unit_price' ) );
-		$percent = abs( $this->get( 'LIN_percent' ) );
-		if ( $unit_price < .001 && $percent ) {
+		$unit_price = abs($this->get('LIN_unit_price'));
+		$percent = abs($this->get('LIN_percent'));
+		if ($unit_price < .001 && $percent) {
 			return TRUE;
-		} elseif ( $unit_price >= .001 && !$percent ) {
+		} elseif ($unit_price >= .001 && ! $percent) {
 			return FALSE;
-		} elseif ( $unit_price >= .001 && $percent ) {
-			throw new EE_Error( sprintf( __( "A Line Item can not have a unit price of (%s) AND a percent (%s)!", "event_espresso" ), $unit_price, $percent ) );
+		} elseif ($unit_price >= .001 && $percent) {
+			throw new EE_Error(sprintf(__("A Line Item can not have a unit price of (%s) AND a percent (%s)!", "event_espresso"), $unit_price, $percent));
 		} else {
 			// if they're both 0, assume its not a percent item
 			return FALSE;
@@ -299,7 +299,7 @@ 
 	 * @return float
 	 */
 	public function percent() {
-		return $this->get( 'LIN_percent' );
+		return $this->get('LIN_percent');
 	}
 
 
@@ -308,8 +308,8 @@ 
 	 * Sets percent (between 100-0.01)
 	 * @param float $percent
 	 */
-	public function set_percent( $percent ) {
-		$this->set( 'LIN_percent', $percent );
+	public function set_percent($percent) {
+		$this->set('LIN_percent', $percent);
 	}
 
 
@@ -319,7 +319,7 @@ 
 	 * @return float
 	 */
 	public function total() {
-		return $this->get( 'LIN_total' );
+		return $this->get('LIN_total');
 	}
 
 
@@ -328,8 +328,8 @@ 
 	 * Sets total
 	 * @param float $total
 	 */
-	public function set_total( $total ) {
-		$this->set( 'LIN_total', $total );
+	public function set_total($total) {
+		$this->set('LIN_total', $total);
 	}
 
 
@@ -339,7 +339,7 @@ 
 	 * @return int
 	 */
 	public function order() {
-		return $this->get( 'LIN_order' );
+		return $this->get('LIN_order');
 	}
 
 
@@ -348,8 +348,8 @@ 
 	 * Sets order
 	 * @param int $order
 	 */
-	public function set_order( $order ) {
-		$this->set( 'LIN_order', $order );
+	public function set_order($order) {
+		$this->set('LIN_order', $order);
 	}
 
 
@@ -359,7 +359,7 @@ 
 	 * @return int
 	 */
 	public function parent_ID() {
-		return $this->get( 'LIN_parent' );
+		return $this->get('LIN_parent');
 	}
 
 
@@ -368,8 +368,8 @@ 
 	 * Sets parent
 	 * @param int $parent
 	 */
-	public function set_parent_ID( $parent ) {
-		$this->set( 'LIN_parent', $parent );
+	public function set_parent_ID($parent) {
+		$this->set('LIN_parent', $parent);
 	}
 
 
@@ -379,7 +379,7 @@ 
 	 * @return string
 	 */
 	public function type() {
-		return $this->get( 'LIN_type' );
+		return $this->get('LIN_type');
 	}
 
 
@@ -388,8 +388,8 @@ 
 	 * Sets type
 	 * @param string $type
 	 */
-	public function set_type( $type ) {
-		$this->set( 'LIN_type', $type );
+	public function set_type($type) {
+		$this->set('LIN_type', $type);
 	}
 
 
@@ -402,8 +402,8 @@ 
 	 * @return EE_Line_Item
 	 */
 	public function parent() {
-		if( $this->ID() ) {
-			return $this->get_model()->get_one_by_ID( $this->parent_ID() );
+		if ($this->ID()) {
+			return $this->get_model()->get_one_by_ID($this->parent_ID());
 		} else {
 			return $this->_parent;
 		}
@@ -416,13 +416,13 @@ 
 	 * @return EE_Line_Item[]
 	 */
 	public function children() {
-		if ( $this->ID() ) {
+		if ($this->ID()) {
 			return $this->get_model()->get_all(
 					array(
-						array( 'LIN_parent' => $this->ID() ),
-						'order_by' => array( 'LIN_order' => 'ASC' ) ) );
+						array('LIN_parent' => $this->ID()),
+						'order_by' => array('LIN_order' => 'ASC') ) );
 		} else {
-			if ( ! is_array( $this->_children ) ) {
+			if ( ! is_array($this->_children)) {
 				$this->_children = array();
 			}
 			return $this->_children;
@@ -436,7 +436,7 @@ 
 	 * @return string
 	 */
 	public function code() {
-		return $this->get( 'LIN_code' );
+		return $this->get('LIN_code');
 	}
 
 
@@ -445,8 +445,8 @@ 
 	 * Sets code
 	 * @param string $code
 	 */
-	public function set_code( $code ) {
-		$this->set( 'LIN_code', $code );
+	public function set_code($code) {
+		$this->set('LIN_code', $code);
 	}
 
 
@@ -456,7 +456,7 @@ 
 	 * @return boolean
 	 */
 	public function is_taxable() {
-		return $this->get( 'LIN_is_taxable' );
+		return $this->get('LIN_is_taxable');
 	}
 
 
@@ -465,8 +465,8 @@ 
 	 * Sets is_taxable
 	 * @param boolean $is_taxable
 	 */
-	public function set_is_taxable( $is_taxable ) {
-		$this->set( 'LIN_is_taxable', $is_taxable );
+	public function set_is_taxable($is_taxable) {
+		$this->set('LIN_is_taxable', $is_taxable);
 	}
 
 
@@ -481,7 +481,7 @@ 
 	 */
 	public function get_object() {
 		$model_name_of_related_obj = $this->OBJ_type();
-		return $this->get_model()->has_relation(  $model_name_of_related_obj ) ? $this->get_first_related( $model_name_of_related_obj ) : NULL;
+		return $this->get_model()->has_relation($model_name_of_related_obj) ? $this->get_first_related($model_name_of_related_obj) : NULL;
 	}
 
 
@@ -492,11 +492,11 @@ 
 	 * @param array $query_params
 	 * @return EE_Ticket
 	 */
-	public function ticket( $query_params = array() ) {
+	public function ticket($query_params = array()) {
 		//we're going to assume that when this method is called we always want to receive the attached ticket EVEN if that ticket is archived.  This can be overridden via the incoming $query_params argument
-		$remove_defaults = array( 'default_where_conditions' => 'none' );
-		$query_params = array_merge( $remove_defaults, $query_params );
-		return $this->get_first_related( 'Ticket', $query_params );
+		$remove_defaults = array('default_where_conditions' => 'none');
+		$query_params = array_merge($remove_defaults, $query_params);
+		return $this->get_first_related('Ticket', $query_params);
 	}
 
 
@@ -506,11 +506,11 @@ 
 	 * @return EE_Datetime | NULL
 	 */
 	public function get_ticket_datetime() {
-		if ( $this->OBJ_type() === 'Ticket' ) {
+		if ($this->OBJ_type() === 'Ticket') {
 			$ticket = $this->ticket();
-			if ( $ticket instanceof EE_Ticket ) {
+			if ($ticket instanceof EE_Ticket) {
 				$datetime = $ticket->first_datetime();
-				if ( $datetime instanceof EE_Datetime ) {
+				if ($datetime instanceof EE_Datetime) {
 					return $datetime;
 				}
 			}
@@ -526,9 +526,9 @@ 
 	 * @return string
 	 */
 	public function ticket_event_name() {
-		$event_name = __( "Unknown", "event_espresso" );
+		$event_name = __("Unknown", "event_espresso");
 		$event = $this->ticket_event();
-		if ( $event instanceof EE_Event ) {
+		if ($event instanceof EE_Event) {
 			$event_name = $event->name();
 		}
 		return $event_name;
@@ -542,9 +542,9 @@ 
 	public function ticket_event() {
 		$event = null;
 		$ticket = $this->ticket();
-		if ( $ticket instanceof EE_Ticket ) {
+		if ($ticket instanceof EE_Ticket) {
 			$datetime = $ticket->first_datetime();
-			if ( $datetime instanceof EE_Datetime ) {
+			if ($datetime instanceof EE_Datetime) {
 				$event = $datetime->event();
 			}
 		}
@@ -559,11 +559,11 @@ 
 	 * @param string $time_format
 	 * @return string
 	 */
-	public function ticket_datetime_start( $date_format = '', $time_format = '' ) {
-		$first_datetime_string = __( "Unknown", "event_espresso" );
+	public function ticket_datetime_start($date_format = '', $time_format = '') {
+		$first_datetime_string = __("Unknown", "event_espresso");
 		$datetime = $this->get_ticket_datetime();
-		if ( $datetime ) {
-			$first_datetime_string = $datetime->start_date_and_time( $date_format, $time_format );
+		if ($datetime) {
+			$first_datetime_string = $datetime->start_date_and_time($date_format, $time_format);
 		}
 		return $first_datetime_string;
 	}
@@ -578,26 +578,26 @@ 
 	 * @return bool success
 	 * @throws \EE_Error
 	 */
-	public function add_child_line_item( EEI_Line_Item $line_item, $set_order = true ) {
+	public function add_child_line_item(EEI_Line_Item $line_item, $set_order = true) {
 		// should we calculate the LIN_order for this line item ?
-		if ( $set_order || $line_item->order() === null ) {
-			$line_item->set_order( count( $this->children() ) );
+		if ($set_order || $line_item->order() === null) {
+			$line_item->set_order(count($this->children()));
 		}
-		if ( $this->ID() ) {
+		if ($this->ID()) {
 			//check for any duplicate line items (with the same code), if so, this replaces it
-			$line_item_with_same_code = $this->get_child_line_item(  $line_item->code() );
-			if( $line_item_with_same_code instanceof EE_Line_Item && $line_item_with_same_code !== $line_item ) {
-				$this->delete_child_line_item( $line_item_with_same_code->code() );
+			$line_item_with_same_code = $this->get_child_line_item($line_item->code());
+			if ($line_item_with_same_code instanceof EE_Line_Item && $line_item_with_same_code !== $line_item) {
+				$this->delete_child_line_item($line_item_with_same_code->code());
 			}
-			$line_item->set_parent_ID( $this->ID() );
-			if( $this->TXN_ID() ){
-				$line_item->set_TXN_ID( $this->TXN_ID() );
+			$line_item->set_parent_ID($this->ID());
+			if ($this->TXN_ID()) {
+				$line_item->set_TXN_ID($this->TXN_ID());
 			}
 			return $line_item->save();
 		} else {
-			$this->_children[ $line_item->code() ] = $line_item;
-			if( $line_item->parent() != $this ) {
-				$line_item->set_parent( $this );
+			$this->_children[$line_item->code()] = $line_item;
+			if ($line_item->parent() != $this) {
+				$line_item->set_parent($this);
 			}
 			return TRUE;
 		}
@@ -611,16 +611,16 @@ 
 	 * @param EE_Line_Item $line_item
 	 *
 	 */
-	public function set_parent( $line_item ) {
-		if ( $this->ID() ) {
-			if( ! $line_item->ID() ) {
+	public function set_parent($line_item) {
+		if ($this->ID()) {
+			if ( ! $line_item->ID()) {
 				$line_item->save();
 			}
-			$this->set_parent_ID( $line_item->ID() );
+			$this->set_parent_ID($line_item->ID());
 			$this->save();
 		} else {
 			$this->_parent = $line_item;
-			$this->set_parent_ID( $line_item->ID() );
+			$this->set_parent_ID($line_item->ID());
 		}
 	}
 
@@ -633,11 +633,11 @@ 
 	 * @param string $code
 	 * @return EE_Line_Item
 	 */
-	public function get_child_line_item( $code ) {
-		if ( $this->ID() ) {
-			return $this->get_model()->get_one( array( array( 'LIN_parent' => $this->ID(), 'LIN_code' => $code ) ) );
+	public function get_child_line_item($code) {
+		if ($this->ID()) {
+			return $this->get_model()->get_one(array(array('LIN_parent' => $this->ID(), 'LIN_code' => $code)));
 		} else {
-			return isset( $this->_children[ $code ] ) ? $this->_children[ $code ] : null;
+			return isset($this->_children[$code]) ? $this->_children[$code] : null;
 		}
 	}
 
@@ -648,10 +648,10 @@ 
 	 * @return int
 	 */
 	public function delete_children_line_items() {
-		if ( $this->ID() ) {
-			return $this->get_model()->delete( array( array( 'LIN_parent' => $this->ID() ) ) );
+		if ($this->ID()) {
+			return $this->get_model()->delete(array(array('LIN_parent' => $this->ID())));
 		} else {
-			$count = count( $this->_children );
+			$count = count($this->_children);
 			$this->_children = array();
 			return $count;
 		}
@@ -668,25 +668,25 @@ 
 	 * @param bool $stop_search_once_found
 	 * @return int count of items deleted (or simply removed from the line item's cache, if not has not been saved to the DB yet)
 	 */
-	public function delete_child_line_item( $code, $stop_search_once_found = true ) {
-		if ( $this->ID() ) {
+	public function delete_child_line_item($code, $stop_search_once_found = true) {
+		if ($this->ID()) {
 			$items_deleted = 0;
-			if( $this->code() == $code ) {
-				$items_deleted += EEH_Line_Item::delete_all_child_items( $this );
+			if ($this->code() == $code) {
+				$items_deleted += EEH_Line_Item::delete_all_child_items($this);
 				$items_deleted += (int) $this->delete();
-				if( $stop_search_once_found ){
+				if ($stop_search_once_found) {
 					return $items_deleted;
 				}
 			}
-			foreach( $this->children() as $child_line_item ) {
-				$items_deleted += $child_line_item->delete_child_line_item( $code, $stop_search_once_found );
+			foreach ($this->children() as $child_line_item) {
+				$items_deleted += $child_line_item->delete_child_line_item($code, $stop_search_once_found);
 			}
 			return $items_deleted;
 		} else {
-			if( isset( $this->_children[ $code ] ) ) {
-				unset( $this->_children[ $code ] );
+			if (isset($this->_children[$code])) {
+				unset($this->_children[$code]);
 				return 1;
-			}else{
+			} else {
 				return 0;
 			}
 		}
@@ -699,9 +699,9 @@ 
 	 * @return boolean
 	 */
 	public function delete_if_childless_subtotal() {
-		if( $this->ID() &&
+		if ($this->ID() &&
 				$this->type() == EEM_Line_Item::type_sub_total &&
-				! $this->children() ) {
+				! $this->children()) {
 			return $this->delete();
 		} else {
 			return false;
@@ -716,7 +716,7 @@ 
 	 */
 	public function generate_code() {
 		// each line item in the cart requires a unique identifier
-		return md5( $this->get( 'OBJ_type' ) . $this->get( 'OBJ_ID' ) . microtime() );
+		return md5($this->get('OBJ_type').$this->get('OBJ_ID').microtime());
 	}
 
 
@@ -799,7 +799,7 @@ 
 	 * @return string like '2, 004.00', formatted according to the localized currency
 	 */
 	public function unit_price_no_code() {
-		return $this->get_pretty( 'LIN_unit_price', 'no_currency_code' );
+		return $this->get_pretty('LIN_unit_price', 'no_currency_code');
 	}
 
 
@@ -809,7 +809,7 @@ 
 	 * @return string like '2, 004.00', formatted according to the localized currency
 	 */
 	public function total_no_code() {
-		return $this->get_pretty( 'LIN_total', 'no_currency_code' );
+		return $this->get_pretty('LIN_total', 'no_currency_code');
 	}
 
 
@@ -829,17 +829,17 @@ 
 		$tax_total = $this->recalculate_taxes_and_tax_total();
 		$total = $pre_tax_total + $tax_total;
 		// no negative totals plz
-		$total = max( $total, 0 );
-		$this->set_total( $total );
+		$total = max($total, 0);
+		$this->set_total($total);
 		//only update the related transaction's total
 		//if we intend to save this line item and its a grand total
-		if(
+		if (
 			$this->allow_persist() &&
 			$this->type() === EEM_Line_Item::type_total &&
 			$this->transaction() instanceof EE_Transaction
-		){
-			$this->transaction()->set_total( $total );
-			if ( $this->transaction()->ID() ) {
+		) {
+			$this->transaction()->set_total($total);
+			if ($this->transaction()->ID()) {
 				$this->transaction()->save();
 			}
 		}
@@ -858,47 +858,47 @@ 
 	public function recalculate_pre_tax_total() {
 		$total = 0;
 		$my_children = $this->children();
-		$has_children = ! empty( $my_children );
-		if ( $has_children && $this->is_line_item() ) {
-			$total = $this->_recalculate_pretax_total_for_line_item( $total, $my_children );
-		} elseif ( ! $has_children && ( $this->is_sub_line_item() || $this->is_line_item() ) ) {
+		$has_children = ! empty($my_children);
+		if ($has_children && $this->is_line_item()) {
+			$total = $this->_recalculate_pretax_total_for_line_item($total, $my_children);
+		} elseif ( ! $has_children && ($this->is_sub_line_item() || $this->is_line_item())) {
 			$total = $this->unit_price() * $this->quantity();
-		} elseif( $this->is_sub_total() || $this->is_total() ) {
-			$total = $this->_recalculate_pretax_total_for_subtotal( $total, $my_children );
-		} elseif ( $this->is_tax_sub_total() || $this->is_tax() || $this->is_cancelled() ) {
+		} elseif ($this->is_sub_total() || $this->is_total()) {
+			$total = $this->_recalculate_pretax_total_for_subtotal($total, $my_children);
+		} elseif ($this->is_tax_sub_total() || $this->is_tax() || $this->is_cancelled()) {
 			// completely ignore tax totals, tax sub-totals, and cancelled line items, when calculating the pre-tax-total
 			return 0;
 		}
 		// ensure all non-line items and non-sub-line-items have a quantity of 1 (except for Events)
-		if(
+		if (
 			! $this->is_line_item() &&
 			! $this->is_sub_line_item() &&
 			! $this->is_cancellation()
 		) {
-			if ( $this->OBJ_type() !== 'Event' ) {
-				$this->set_quantity( 1 );
+			if ($this->OBJ_type() !== 'Event') {
+				$this->set_quantity(1);
 			}
-			if( ! $this->is_percent() ) {
-				$this->set_unit_price( $this->total() );
+			if ( ! $this->is_percent()) {
+				$this->set_unit_price($this->total());
 			}
 		}
 
 		//we don't want to bother saving grand totals, because that needs to factor in taxes anyways
 		//so it ought to be
-		if( ! $this->is_total() ) {
-			$this->set_total( $total );
+		if ( ! $this->is_total()) {
+			$this->set_total($total);
 			//if not a percent line item, make sure we keep the unit price in sync
-			if(
+			if (
 				$has_children
 				&& $this->is_line_item()
 				&& ! $this->is_percent()
 			) {
-				if( $this->quantity() === 0 ){
+				if ($this->quantity() === 0) {
 					$new_unit_price = 0;
 				} else {
 					$new_unit_price = $this->total() / $this->quantity();
 				}
-				$this->set_unit_price( $new_unit_price );
+				$this->set_unit_price($new_unit_price);
 			}
 			$this->maybe_save();
 		}
@@ -918,39 +918,39 @@ 
 	 * @return float
 	 * @throws \EE_Error
 	 */
-	protected function _recalculate_pretax_total_for_subtotal( $calculated_total_so_far, $my_children = null ) {
-		if( $my_children === null ) {
+	protected function _recalculate_pretax_total_for_subtotal($calculated_total_so_far, $my_children = null) {
+		if ($my_children === null) {
 			$my_children = $this->children();
 		}
 		//get the total of all its children
-		foreach ( $my_children as $child_line_item ) {
-			if ( $child_line_item instanceof EE_Line_Item && ! $child_line_item->is_cancellation() ) {
+		foreach ($my_children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item && ! $child_line_item->is_cancellation()) {
 				// percentage line items are based on total so far
-				if ( $child_line_item->is_percent() ) {
+				if ($child_line_item->is_percent()) {
 					//round as we go so that the line items add up ok
 					$percent_total = round(
 						$calculated_total_so_far * $child_line_item->percent() / 100,
 						EE_Registry::instance()->CFG->currency->dec_plc
 					);
-					$child_line_item->set_total( $percent_total );
+					$child_line_item->set_total($percent_total);
 					//so far all percent line items should have a quantity of 1
 					//(ie, no double percent discounts. Although that might be requested someday)
-					$child_line_item->set_quantity( 1 );
+					$child_line_item->set_quantity(1);
 					$child_line_item->maybe_save();
 					$calculated_total_so_far += $percent_total;
 				} else {
 					//verify flat sub-line-item quantities match their parent
-					if( $child_line_item->is_sub_line_item() ) {
-						$child_line_item->set_quantity( $this->quantity() );
+					if ($child_line_item->is_sub_line_item()) {
+						$child_line_item->set_quantity($this->quantity());
 					}
 					$calculated_total_so_far += $child_line_item->recalculate_pre_tax_total();
 				}
 			}
 		}
 
-		if( $this->is_sub_total() ){
+		if ($this->is_sub_total()) {
 			// no negative totals plz
-			$calculated_total_so_far = max( $calculated_total_so_far, 0 );
+			$calculated_total_so_far = max($calculated_total_so_far, 0);
 		}
 		return $calculated_total_so_far;
 	}
@@ -968,8 +968,8 @@ 
 	 * @return float
 	 * @throws \EE_Error
 	 */
-	protected function _recalculate_pretax_total_for_line_item( $calculated_total_so_far, $my_children = null ) {
-		if( $my_children === null ) {
+	protected function _recalculate_pretax_total_for_line_item($calculated_total_so_far, $my_children = null) {
+		if ($my_children === null) {
 			$my_children = $this->children();
 		}
 		//we need to keep track of the running total for a single item,
@@ -977,10 +977,10 @@ 
 		$unit_price_for_total = 0;
 		$quantity_for_total = 1;
 		//get the total of all its children
-		foreach ( $my_children as $child_line_item ) {
-			if ( $child_line_item instanceof EE_Line_Item &&
+		foreach ($my_children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item &&
 					! $child_line_item->is_cancellation()) {
-				if ( $child_line_item->is_percent() ) {
+				if ($child_line_item->is_percent()) {
 					//it should be the unit-price-so-far multiplied by teh percent multiplied by the quantity
 					//not total multiplied by percent, because that ignores rounding along-the-way
 					$percent_unit_price = round(
@@ -988,17 +988,17 @@ 
 						EE_Registry::instance()->CFG->currency->dec_plc
 					);
 					$percent_total = $percent_unit_price * $quantity_for_total;
-					$child_line_item->set_total( $percent_total );
+					$child_line_item->set_total($percent_total);
 					//so far all percent line items should have a quantity of 1
 					//(ie, no double percent discounts. Although that might be requested someday)
-					$child_line_item->set_quantity( 1 );
+					$child_line_item->set_quantity(1);
 					$child_line_item->maybe_save();
 					$calculated_total_so_far += $percent_total;
 					$unit_price_for_total += $percent_unit_price;
 				} else {
 					//verify flat sub-line-item quantities match their parent
-					if( $child_line_item->is_sub_line_item() ) {
-						$child_line_item->set_quantity( $this->quantity() );
+					if ($child_line_item->is_sub_line_item()) {
+						$child_line_item->set_quantity($this->quantity());
 					}
 					$quantity_for_total = $child_line_item->quantity();
 					$calculated_total_so_far += $child_line_item->recalculate_pre_tax_total();
@@ -1022,10 +1022,10 @@ 
 		//calculate the pretax total
 		$taxable_total = $this->taxable_total();
 		$tax_total = 0;
-		foreach ( $taxes as $tax ) {
+		foreach ($taxes as $tax) {
 			$total_on_this_tax = $taxable_total * $tax->percent() / 100;
 			//remember the total on this line item
-			$tax->set_total( $total_on_this_tax );
+			$tax->set_total($total_on_this_tax);
 			$tax_total += $tax->total();
 		}
 		$this->_recalculate_tax_sub_total();
@@ -1039,21 +1039,21 @@ 
 	 * @return void
 	 */
 	private function _recalculate_tax_sub_total() {
-		if ( $this->is_tax_sub_total() ) {
+		if ($this->is_tax_sub_total()) {
 			$total = 0;
 			$total_percent = 0;
 			//simply loop through all its children (which should be taxes) and sum their total
-			foreach ( $this->children() as $child_tax ) {
-				if ( $child_tax instanceof EE_Line_Item ) {
+			foreach ($this->children() as $child_tax) {
+				if ($child_tax instanceof EE_Line_Item) {
 					$total += $child_tax->total();
 					$total_percent += $child_tax->percent();
 				}
 			}
-			$this->set_total( $total );
-			$this->set_percent( $total_percent );
-		} elseif ( $this->is_total() ) {
-			foreach ( $this->children() as $maybe_tax_subtotal ) {
-				if ( $maybe_tax_subtotal instanceof EE_Line_Item ) {
+			$this->set_total($total);
+			$this->set_percent($total_percent);
+		} elseif ($this->is_total()) {
+			foreach ($this->children() as $maybe_tax_subtotal) {
+				if ($maybe_tax_subtotal instanceof EE_Line_Item) {
 					$maybe_tax_subtotal->_recalculate_tax_sub_total();
 				}
 			}
@@ -1069,8 +1069,8 @@ 
 	public function get_total_tax() {
 		$this->_recalculate_tax_sub_total();
 		$total = 0;
-		foreach ( $this->tax_descendants() as $tax_line_item ) {
-			if ( $tax_line_item instanceof EE_Line_Item ) {
+		foreach ($this->tax_descendants() as $tax_line_item) {
+			if ($tax_line_item instanceof EE_Line_Item) {
 				$total += $tax_line_item->total();
 			}
 		}
@@ -1084,15 +1084,15 @@ 
 	 */
 	public function get_items_total() {
 		//by default, let's make sure we're consistent with the existing line item
-		if( $this->is_total() ) {
-			$pretax_subtotal_li = EEH_Line_Item::get_pre_tax_subtotal( $this );
-			if( $pretax_subtotal_li instanceof EE_Line_Item ) {
+		if ($this->is_total()) {
+			$pretax_subtotal_li = EEH_Line_Item::get_pre_tax_subtotal($this);
+			if ($pretax_subtotal_li instanceof EE_Line_Item) {
 				return $pretax_subtotal_li->total();
 			}
 		}
 		$total = 0;
-		foreach ( $this->get_items() as $item ) {
-			if ( $item instanceof EE_Line_Item ) {
+		foreach ($this->get_items() as $item) {
+			if ($item instanceof EE_Line_Item) {
 				$total += $item->total();
 			}
 		}
@@ -1107,7 +1107,7 @@ 
 	 * @return EE_Line_Item[]
 	 */
 	public function tax_descendants() {
-		return EEH_Line_Item::get_tax_descendants( $this );
+		return EEH_Line_Item::get_tax_descendants($this);
 	}
 
 
@@ -1117,7 +1117,7 @@ 
 	 * @return EE_Line_Item[]
 	 */
 	public function get_items() {
-		return EEH_Line_Item::get_line_item_descendants( $this );
+		return EEH_Line_Item::get_line_item_descendants($this);
 	}
 
 
@@ -1133,22 +1133,22 @@ 
 	 */
 	public function taxable_total() {
 		$total = 0;
-		if ( $this->children() ) {
-			foreach ( $this->children() as $child_line_item ) {
-				if ( $child_line_item->type() === EEM_Line_Item::type_line_item && $child_line_item->is_taxable()) {
+		if ($this->children()) {
+			foreach ($this->children() as $child_line_item) {
+				if ($child_line_item->type() === EEM_Line_Item::type_line_item && $child_line_item->is_taxable()) {
 					//if it's a percent item, only take into account the percent
 					//that's taxable too (the taxable total so far)
-					if( $child_line_item->is_percent() ) {
-						$total = $total + ( $total * $child_line_item->percent() / 100 );
-					}else{
+					if ($child_line_item->is_percent()) {
+						$total = $total + ($total * $child_line_item->percent() / 100);
+					} else {
 						$total += $child_line_item->total();
 					}
-				}elseif( $child_line_item->type() === EEM_Line_Item::type_sub_total ){
+				}elseif ($child_line_item->type() === EEM_Line_Item::type_sub_total) {
 					$total += $child_line_item->taxable_total();
 				}
 			}
 		}
-		return max( $total, 0 );
+		return max($total, 0);
 	}
 
 
@@ -1158,7 +1158,7 @@ 
 	 * @return EE_Transaction
 	 */
 	public function transaction() {
-		return $this->get_first_related( 'Transaction' );
+		return $this->get_first_related('Transaction');
 	}
 
 
@@ -1171,18 +1171,18 @@ 
 	 * @param int $txn_id if none is provided, assumes $this->TXN_ID()
 	 * @return int count of items saved
 	 */
-	public function save_this_and_descendants_to_txn( $txn_id = NULL ) {
+	public function save_this_and_descendants_to_txn($txn_id = NULL) {
 		$count = 0;
-		if ( ! $txn_id ) {
+		if ( ! $txn_id) {
 			$txn_id = $this->TXN_ID();
 		}
-		$this->set_TXN_ID( $txn_id );
+		$this->set_TXN_ID($txn_id);
 		$children = $this->children();
 		$count += $this->save() ? 1 : 0;
-		foreach ( $children as $child_line_item ) {
-			if ( $child_line_item instanceof EE_Line_Item ) {
-				$child_line_item->set_parent_ID( $this->ID() );
-				$count += $child_line_item->save_this_and_descendants_to_txn( $txn_id );
+		foreach ($children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				$child_line_item->set_parent_ID($this->ID());
+				$count += $child_line_item->save_this_and_descendants_to_txn($txn_id);
 			}
 		}
 		return $count;
@@ -1199,9 +1199,9 @@ 
 		$count = 0;
 		$children = $this->children();
 		$count += $this->save() ? 1 : 0;
-		foreach ( $children as $child_line_item ) {
-			if ( $child_line_item instanceof EE_Line_Item ) {
-				$child_line_item->set_parent_ID( $this->ID() );
+		foreach ($children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				$child_line_item->set_parent_ID($this->ID());
 				$count += $child_line_item->save_this_and_descendants();
 			}
 		}
@@ -1215,8 +1215,8 @@ 
 	 * @return EE_Line_Item[]
 	 */
 	public function get_cancellations() {
-		EE_Registry::instance()->load_helper( 'Line_Item' );
-		return EEH_Line_Item::get_descendants_of_type( $this, EEM_Line_Item::type_cancellation );
+		EE_Registry::instance()->load_helper('Line_Item');
+		return EEH_Line_Item::get_descendants_of_type($this, EEM_Line_Item::type_cancellation);
 	}
 
 
@@ -1227,7 +1227,7 @@ 
 	 * @return int count of items saved
 	 */
 	public function maybe_save() {
-		if ( $this->ID() ) {
+		if ($this->ID()) {
 			return $this->save();
 		}
 		return false;

core/db_models/EEM_Line_Item.model.php

Indentation +53 added lines, -53 removed lines

@@ -362,59 +362,59 @@
 
 
 
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws \EE_Error
-     */
-    public function get_total_line_items_with_no_transaction()
-    {
-        return $this->get_total_line_items_for_carts(false, true);
-    }
-
-
-
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws \EE_Error
-     */
-    public function get_total_line_items_just_added_to_cart()
-    {
-        return $this->get_total_line_items_for_carts();
-    }
-
-
-
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws \EE_Error
-     */
-    public function get_total_line_items_for_expired_carts()
-    {
-        return $this->get_total_line_items_for_carts(true);
-    }
-
-
-
-    /**
-     * @param bool $expired
-     * @param bool $all
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws \EE_Error
-     */
-    private function get_total_line_items_for_carts($expired = false, $all = false)
-    {
-        $where_params = array(
-            'TXN_ID'        => 0,
-            'LIN_type'      => 'total',
-        );
-        if (! $all) {
-            $where_params['LIN_timestamp'] = array(
-                $expired ? '<=' : '>',
-                time() - EE_Registry::instance()->SSN->lifespan(),
-            );
-        }
-        return $this->get_all(array($where_params));
-    }
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws \EE_Error
+	 */
+	public function get_total_line_items_with_no_transaction()
+	{
+		return $this->get_total_line_items_for_carts(false, true);
+	}
+
+
+
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws \EE_Error
+	 */
+	public function get_total_line_items_just_added_to_cart()
+	{
+		return $this->get_total_line_items_for_carts();
+	}
+
+
+
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws \EE_Error
+	 */
+	public function get_total_line_items_for_expired_carts()
+	{
+		return $this->get_total_line_items_for_carts(true);
+	}
+
+
+
+	/**
+	 * @param bool $expired
+	 * @param bool $all
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws \EE_Error
+	 */
+	private function get_total_line_items_for_carts($expired = false, $all = false)
+	{
+		$where_params = array(
+			'TXN_ID'        => 0,
+			'LIN_type'      => 'total',
+		);
+		if (! $all) {
+			$where_params['LIN_timestamp'] = array(
+				$expired ? '<=' : '>',
+				time() - EE_Registry::instance()->SSN->lifespan(),
+			);
+		}
+		return $this->get_all(array($where_params));
+	}
 
 
 

Spacing +60 added lines, -60 removed lines

@@ -105,41 +105,41 @@ 
 	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
 	 * @return \EEM_Line_Item
 	 */
-	protected function __construct( $timezone ) {
-		$this->singular_item = __('Line Item','event_espresso');
-		$this->plural_item = __('Line Items','event_espresso');
+	protected function __construct($timezone) {
+		$this->singular_item = __('Line Item', 'event_espresso');
+		$this->plural_item = __('Line Items', 'event_espresso');
 
 		$this->_tables = array(
-			'Line_Item'=>new EE_Primary_Table('esp_line_item','LIN_ID')
+			'Line_Item'=>new EE_Primary_Table('esp_line_item', 'LIN_ID')
 		);
-		$line_items_can_be_for = apply_filters( 'FHEE__EEM_Line_Item__line_items_can_be_for', array('Ticket','Price', 'Event' ) );
+		$line_items_can_be_for = apply_filters('FHEE__EEM_Line_Item__line_items_can_be_for', array('Ticket', 'Price', 'Event'));
 		$this->_fields = array(
 			'Line_Item' => array(
-				'LIN_ID' 				=> new EE_Primary_Key_Int_Field( 'LIN_ID', __( "ID", "event_espresso" ) ),
-				'LIN_code' 			=> new EE_Slug_Field( 'LIN_code', __( "Code for index into Cart", "event_espresso" ), TRUE ),
-				'TXN_ID' 				=> new EE_Foreign_Key_Int_Field( 'TXN_ID', __( "Transaction ID", "event_espresso" ), TRUE, NULL, 'Transaction' ),
-				'LIN_name' 			=> new EE_Full_HTML_Field( 'LIN_name', __( "Line Item Name", "event_espresso" ), FALSE, '' ),
-				'LIN_desc' 			=> new EE_Full_HTML_Field( 'LIN_desc', __( "Line Item Description", "event_espresso" ), TRUE ),
-				'LIN_unit_price' 	=> new EE_Money_Field( 'LIN_unit_price', __( "Unit Price", "event_espresso" ), FALSE, 0 ),
-				'LIN_percent' 		=> new EE_Float_Field( 'LIN_percent', __( "Percent", "event_espresso" ), FALSE, 0 ),
-				'LIN_is_taxable' 	=> new EE_Boolean_Field( 'LIN_is_taxable', __( "Taxable", "event_espresso" ), FALSE, FALSE ),
-				'LIN_order' 			=> new EE_Integer_Field( 'LIN_order', __( "Order of Application towards total of parent", "event_espresso" ), FALSE, 1 ),
-				'LIN_total' 			=> new EE_Money_Field( 'LIN_total', __( "Total (unit price x quantity)", "event_espresso" ), FALSE, 0 ),
-				'LIN_quantity' 	=> new EE_Integer_Field( 'LIN_quantity', __( "Quantity", "event_espresso" ), TRUE, 1 ),
-				'LIN_parent' 		=> new EE_Integer_Field( 'LIN_parent', __( "Parent ID (this item goes towards that Line Item's total)", "event_espresso" ), TRUE, NULL ),
-				'LIN_type' 			=> new EE_Enum_Text_Field( 'LIN_type', __( "Type", "event_espresso" ), FALSE, 'line-item', array(
+				'LIN_ID' 				=> new EE_Primary_Key_Int_Field('LIN_ID', __("ID", "event_espresso")),
+				'LIN_code' 			=> new EE_Slug_Field('LIN_code', __("Code for index into Cart", "event_espresso"), TRUE),
+				'TXN_ID' 				=> new EE_Foreign_Key_Int_Field('TXN_ID', __("Transaction ID", "event_espresso"), TRUE, NULL, 'Transaction'),
+				'LIN_name' 			=> new EE_Full_HTML_Field('LIN_name', __("Line Item Name", "event_espresso"), FALSE, ''),
+				'LIN_desc' 			=> new EE_Full_HTML_Field('LIN_desc', __("Line Item Description", "event_espresso"), TRUE),
+				'LIN_unit_price' 	=> new EE_Money_Field('LIN_unit_price', __("Unit Price", "event_espresso"), FALSE, 0),
+				'LIN_percent' 		=> new EE_Float_Field('LIN_percent', __("Percent", "event_espresso"), FALSE, 0),
+				'LIN_is_taxable' 	=> new EE_Boolean_Field('LIN_is_taxable', __("Taxable", "event_espresso"), FALSE, FALSE),
+				'LIN_order' 			=> new EE_Integer_Field('LIN_order', __("Order of Application towards total of parent", "event_espresso"), FALSE, 1),
+				'LIN_total' 			=> new EE_Money_Field('LIN_total', __("Total (unit price x quantity)", "event_espresso"), FALSE, 0),
+				'LIN_quantity' 	=> new EE_Integer_Field('LIN_quantity', __("Quantity", "event_espresso"), TRUE, 1),
+				'LIN_parent' 		=> new EE_Integer_Field('LIN_parent', __("Parent ID (this item goes towards that Line Item's total)", "event_espresso"), TRUE, NULL),
+				'LIN_type' 			=> new EE_Enum_Text_Field('LIN_type', __("Type", "event_espresso"), FALSE, 'line-item', array(
 						self::type_line_item		=>  __("Line Item", "event_espresso"),
 						self::type_sub_line_item	=>  __("Sub-Item", "event_espresso"),
 						self::type_sub_total		=>  __("Subtotal", "event_espresso"),
 						self::type_tax_sub_total 	=> __("Tax Subtotal", "event_espresso"),
 						self::type_tax					=>  __("Tax", "event_espresso"),
 						self::type_total				=>  __("Total", "event_espresso"),
-						self::type_cancellation	=> __( 'Cancellation', 'event_espresso' )
+						self::type_cancellation	=> __('Cancellation', 'event_espresso')
 					)
 				),
-				'OBJ_ID' 					=> new EE_Foreign_Key_Int_Field( 'OBJ_ID', __( 'ID of Item purchased.', 'event_espresso' ), TRUE, NULL, $line_items_can_be_for ),
-				'OBJ_type'				=>new EE_Any_Foreign_Model_Name_Field( 'OBJ_type', __( "Model Name this Line Item is for", "event_espresso" ), TRUE, NULL, $line_items_can_be_for ),
-				'LIN_timestamp' => new EE_Datetime_Field('LIN_timestamp', __('When the line item was created','event_espresso'), false, EE_Datetime_Field::now, $timezone ),
+				'OBJ_ID' 					=> new EE_Foreign_Key_Int_Field('OBJ_ID', __('ID of Item purchased.', 'event_espresso'), TRUE, NULL, $line_items_can_be_for),
+				'OBJ_type'				=>new EE_Any_Foreign_Model_Name_Field('OBJ_type', __("Model Name this Line Item is for", "event_espresso"), TRUE, NULL, $line_items_can_be_for),
+				'LIN_timestamp' => new EE_Datetime_Field('LIN_timestamp', __('When the line item was created', 'event_espresso'), false, EE_Datetime_Field::now, $timezone),
 			)
 		);
 		$this->_model_relations = array(
@@ -150,7 +150,7 @@ 
 		);
 		$this->_model_chain_to_wp_user = 'Transaction.Registration.Event';
 		$this->_caps_slug = 'transactions';
-		parent::__construct( $timezone );
+		parent::__construct($timezone);
 	}
 
 
@@ -161,9 +161,9 @@ 
 	 * @param EE_Transaction|int $transaction
 	 * @return EE_Line_Item[]
 	 */
-	public function get_all_of_type_for_transaction( $line_item_type, $transaction ){
-		$transaction = EEM_Transaction::instance()->ensure_is_ID( $transaction );
-		return $this->get_all( array( array(
+	public function get_all_of_type_for_transaction($line_item_type, $transaction) {
+		$transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
+		return $this->get_all(array(array(
 			'LIN_type' => $line_item_type,
 			'TXN_ID' => $transaction
 		)));
@@ -177,14 +177,14 @@ 
 	 * @param EE_Transaction|int $transaction
 	 * @return EE_Line_Item[]
 	 */
-	public function get_all_non_ticket_line_items_for_transaction( $transaction ) {
-		$transaction = EEM_Transaction::instance()->ensure_is_ID( $transaction );
-		return $this->get_all( array( array(
+	public function get_all_non_ticket_line_items_for_transaction($transaction) {
+		$transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
+		return $this->get_all(array(array(
 			'LIN_type' => self::type_line_item,
 			'TXN_ID' => $transaction,
 			'OR' => array(
-				'OBJ_type*notticket' => array( '!=', 'Ticket'),
-				'OBJ_type*null' => array( 'IS_NULL' ))
+				'OBJ_type*notticket' => array('!=', 'Ticket'),
+				'OBJ_type*null' => array('IS_NULL'))
 		)));
 	}
 
@@ -194,7 +194,7 @@ 
 	 * because if there are spam bots afoot there will be LOTS of line items
 	 * @return int count of how many deleted
 	 */
-	public function delete_line_items_with_no_transaction(){
+	public function delete_line_items_with_no_transaction() {
 		/** @type WPDB $wpdb */
 		global $wpdb;
 		$time_to_leave_alone = apply_filters(
@@ -202,13 +202,13 @@ 
 		);
 		$query = $wpdb->prepare(
 				'DELETE li
-				FROM ' . $this->table() . ' li
-				LEFT JOIN ' . EEM_Transaction::instance()->table(). ' t ON li.TXN_ID = t.TXN_ID
+				FROM ' . $this->table().' li
+				LEFT JOIN ' . EEM_Transaction::instance()->table().' t ON li.TXN_ID = t.TXN_ID
 				WHERE t.TXN_ID IS NULL AND li.LIN_timestamp < %s',
 				// use GMT time because that's what TXN_timestamps are in
-				date(  'Y-m-d H:i:s', time() - $time_to_leave_alone )
+				date('Y-m-d H:i:s', time() - $time_to_leave_alone)
 				);
-		return $wpdb->query( $query );
+		return $wpdb->query($query);
 	}
 
 
@@ -221,10 +221,10 @@ 
 	 * @param \EE_Base_Class $object
 	 * @return EE_Line_Item[]
 	 */
-	public function get_line_item_for_transaction_object( $TXN_ID, EE_Base_Class $object ){
-		return $this->get_all( array( array(
+	public function get_line_item_for_transaction_object($TXN_ID, EE_Base_Class $object) {
+		return $this->get_all(array(array(
 			'TXN_ID' 		=> $TXN_ID,
-			'OBJ_type' 	=> str_replace( 'EE_', '', get_class( $object )),
+			'OBJ_type' 	=> str_replace('EE_', '', get_class($object)),
 			'OBJ_ID' 		=> $object->ID()
 		)));
 	}
@@ -240,16 +240,16 @@ 
 	 * @param array $OBJ_IDs
 	 * @return EE_Line_Item[]
 	 */
-	public function get_object_line_items_for_transaction( $TXN_ID, $OBJ_type = 'Event', $OBJ_IDs = array() ){
+	public function get_object_line_items_for_transaction($TXN_ID, $OBJ_type = 'Event', $OBJ_IDs = array()) {
 		$query_params = array(
 			'OBJ_type' 	=> $OBJ_type,
 			// if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query
-			'OBJ_ID' 		=> is_array( $OBJ_IDs ) && ! isset( $OBJ_IDs['IN'] ) ? array( 'IN', $OBJ_IDs ) : $OBJ_IDs
+			'OBJ_ID' 		=> is_array($OBJ_IDs) && ! isset($OBJ_IDs['IN']) ? array('IN', $OBJ_IDs) : $OBJ_IDs
 		);
-		if ( $TXN_ID ) {
+		if ($TXN_ID) {
 			$query_params['TXN_ID'] = $TXN_ID;
 		}
-		return $this->get_all( array( $query_params ));
+		return $this->get_all(array($query_params));
 	}
 
 
@@ -260,13 +260,13 @@ 
 	 * @param EE_Transaction $transaction
 	 * @return EE_Line_Item[]
 	 */
-	public function get_all_ticket_line_items_for_transaction( EE_Transaction $transaction ) {
-		return $this->get_all( array(
+	public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction) {
+		return $this->get_all(array(
 		   array(
 			   'TXN_ID'   => $transaction->ID(),
 			   'OBJ_type' => 'Ticket',
 		   )
-	   ) );
+	   ));
 	}
 
 
@@ -278,14 +278,14 @@ 
 	 * @param int $TKT_ID
 	 * @return \EE_Line_Item
 	 */
-	public function get_ticket_line_item_for_transaction( $TXN_ID, $TKT_ID ) {
-		return $this->get_one( array(
+	public function get_ticket_line_item_for_transaction($TXN_ID, $TKT_ID) {
+		return $this->get_one(array(
 		   array(
-			   'TXN_ID'   => EEM_Transaction::instance()->ensure_is_ID( $TXN_ID ),
+			   'TXN_ID'   => EEM_Transaction::instance()->ensure_is_ID($TXN_ID),
 			   'OBJ_ID'   => $TKT_ID,
 			   'OBJ_type' => 'Ticket',
 		   )
-	   ) );
+	   ));
 	}
 
 
@@ -300,8 +300,8 @@ 
 	 * @param EE_Promotion $promotion
 	 * @return EE_Line_Item
 	 */
-	public function get_existing_promotion_line_item( EE_Line_Item $parent_line_item, EE_Promotion $promotion ) {
-		return $this->get_one( array(
+	public function get_existing_promotion_line_item(EE_Line_Item $parent_line_item, EE_Promotion $promotion) {
+		return $this->get_one(array(
 			array(
 				'TXN_ID' 			=> $parent_line_item->TXN_ID(),
 				'LIN_parent' 	=> $parent_line_item->ID(),
@@ -322,8 +322,8 @@ 
 	 * @param EE_Line_Item $parent_line_item
 	 * @return EE_Line_Item[]
 	 */
-	public function get_all_promotion_line_items( EE_Line_Item $parent_line_item ) {
-		return $this->get_all( array(
+	public function get_all_promotion_line_items(EE_Line_Item $parent_line_item) {
+		return $this->get_all(array(
 			array(
 				'TXN_ID' 			=> $parent_line_item->TXN_ID(),
 				'LIN_parent' 	=> $parent_line_item->ID(),
@@ -340,8 +340,8 @@ 
 	 * @param EE_Registration $registration
 	 * @return EE_Line_ITem
 	 */
-	public function get_line_item_for_registration( EE_Registration $registration ) {
-		return $this->get_one( $this->line_item_for_registration_query_params( $registration ));
+	public function get_line_item_for_registration(EE_Registration $registration) {
+		return $this->get_one($this->line_item_for_registration_query_params($registration));
 	}
 
 	/**
@@ -350,14 +350,14 @@ 
 	 * @param array $original_query_params any extra query params you'd like to be merged with
 	 * @return array like EEM_Base::get_all()'s $query_params
 	 */
-	public function line_item_for_registration_query_params( EE_Registration $registration, $original_query_params = array() ) {
-		return array_replace_recursive( $original_query_params, array(
+	public function line_item_for_registration_query_params(EE_Registration $registration, $original_query_params = array()) {
+		return array_replace_recursive($original_query_params, array(
 			array(
 				'OBJ_ID' => $registration->ticket_ID(),
 				'OBJ_type' => 'Ticket',
 				'TXN_ID' => $registration->transaction_ID()
 			)
-		) );
+		));
 	}
 
 
@@ -407,7 +407,7 @@ 
             'TXN_ID'        => 0,
             'LIN_type'      => 'total',
         );
-        if (! $all) {
+        if ( ! $all) {
             $where_params['LIN_timestamp'] = array(
                 $expired ? '<=' : '>',
                 time() - EE_Registry::instance()->SSN->lifespan(),

espresso.php

Indentation +219 added lines, -219 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('ABSPATH')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 /*
   Plugin Name:		Event Espresso
@@ -40,243 +40,243 @@ 
  * @since            4.0
  */
 if (function_exists('espresso_version')) {
-    /**
-     *    espresso_duplicate_plugin_error
-     *    displays if more than one version of EE is activated at the same time
-     */
-    function espresso_duplicate_plugin_error()
-    {
-        ?>
+	/**
+	 *    espresso_duplicate_plugin_error
+	 *    displays if more than one version of EE is activated at the same time
+	 */
+	function espresso_duplicate_plugin_error()
+	{
+		?>
         <div class="error">
             <p>
                 <?php echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                ); ?>
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+				); ?>
             </p>
         </div>
         <?php
-        espresso_deactivate_plugin(plugin_basename(__FILE__));
-    }
+		espresso_deactivate_plugin(plugin_basename(__FILE__));
+	}
 
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
-    if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
+	if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                            esc_html__(
-                                    'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                                    'event_espresso'
-                            ),
-                            EE_MIN_PHP_VER_REQUIRED,
-                            PHP_VERSION,
-                            '<br/>',
-                            '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+							esc_html__(
+									'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+									'event_espresso'
+							),
+							EE_MIN_PHP_VER_REQUIRED,
+							PHP_VERSION,
+							'<br/>',
+							'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.32.rc.025');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.32.rc.025');
+		}
 
-        // define versions
-        define('EVENT_ESPRESSO_VERSION', espresso_version());
-        define('EE_MIN_WP_VER_REQUIRED', '4.1');
-        define('EE_MIN_WP_VER_RECOMMENDED', '4.4.2');
-        define('EE_MIN_PHP_VER_RECOMMENDED', '5.4.44');
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        //used to be DIRECTORY_SEPARATOR, but that caused issues on windows
-        if ( ! defined('DS')) {
-            define('DS', '/');
-        }
-        if ( ! defined('PS')) {
-            define('PS', PATH_SEPARATOR);
-        }
-        if ( ! defined('SP')) {
-            define('SP', ' ');
-        }
-        if ( ! defined('EENL')) {
-            define('EENL', "\n");
-        }
-        define('EE_SUPPORT_EMAIL', 'support@eventespresso.com');
-        // define the plugin directory and URL
-        define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
-        define('EE_PLUGIN_DIR_PATH', plugin_dir_path(EVENT_ESPRESSO_MAIN_FILE));
-        define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE));
-        // main root folder paths
-        define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages' . DS);
-        define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core' . DS);
-        define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules' . DS);
-        define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public' . DS);
-        define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes' . DS);
-        define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets' . DS);
-        define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods' . DS);
-        define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated' . DS);
-        // core system paths
-        define('EE_ADMIN', EE_CORE . 'admin' . DS);
-        define('EE_CPTS', EE_CORE . 'CPTs' . DS);
-        define('EE_CLASSES', EE_CORE . 'db_classes' . DS);
-        define('EE_INTERFACES', EE_CORE . 'interfaces' . DS);
-        define('EE_BUSINESS', EE_CORE . 'business' . DS);
-        define('EE_MODELS', EE_CORE . 'db_models' . DS);
-        define('EE_HELPERS', EE_CORE . 'helpers' . DS);
-        define('EE_LIBRARIES', EE_CORE . 'libraries' . DS);
-        define('EE_TEMPLATES', EE_CORE . 'templates' . DS);
-        define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs' . DS);
-        define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets' . DS);
-        define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections' . DS);
-        // gateways
-        define('EE_GATEWAYS', EE_MODULES . 'gateways' . DS);
-        define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules' . DS . 'gateways' . DS);
-        // asset URL paths
-        define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'templates' . DS);
-        define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets' . DS);
-        define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images' . DS);
-        define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'third_party_libs' . DS);
-        define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/');
-        define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/');
-        // define upload paths
-        $uploads = wp_upload_dir();
-        // define the uploads directory and URL
-        define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . DS . 'espresso' . DS);
-        define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . DS . 'espresso' . DS);
-        // define the templates directory and URL
-        define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'templates' . DS);
-        define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'templates' . DS);
-        // define the gateway directory and URL
-        define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'gateways' . DS);
-        define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'gateways' . DS);
-        // languages folder/path
-        define('EE_LANGUAGES_SAFE_LOC', '..' . DS . 'uploads' . DS . 'espresso' . DS . 'languages' . DS);
-        define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS);
-        //check for dompdf fonts in uploads
-        if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS)) {
-            define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS);
-        }
-        //ajax constants
-        define(
-                'EE_FRONT_AJAX',
-                isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax']) ? true : false
-        );
-        define(
-                'EE_ADMIN_AJAX',
-                isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax']) ? true : false
-        );
-        //just a handy constant occasionally needed for finding values representing infinity in the DB
-        //you're better to use this than its straight value (currently -1) in case you ever
-        //want to change its default value! or find when -1 means infinity
-        define('EE_INF_IN_DB', -1);
-        define('EE_INF', INF > (float)PHP_INT_MAX ? INF : PHP_INT_MAX);
-        define('EE_DEBUG', false);
-        // for older WP versions
-        if ( ! defined('MONTH_IN_SECONDS')) {
-            define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
-        }
-        /**
-         *    espresso_plugin_activation
-         *    adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		// define versions
+		define('EVENT_ESPRESSO_VERSION', espresso_version());
+		define('EE_MIN_WP_VER_REQUIRED', '4.1');
+		define('EE_MIN_WP_VER_RECOMMENDED', '4.4.2');
+		define('EE_MIN_PHP_VER_RECOMMENDED', '5.4.44');
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		//used to be DIRECTORY_SEPARATOR, but that caused issues on windows
+		if ( ! defined('DS')) {
+			define('DS', '/');
+		}
+		if ( ! defined('PS')) {
+			define('PS', PATH_SEPARATOR);
+		}
+		if ( ! defined('SP')) {
+			define('SP', ' ');
+		}
+		if ( ! defined('EENL')) {
+			define('EENL', "\n");
+		}
+		define('EE_SUPPORT_EMAIL', 'support@eventespresso.com');
+		// define the plugin directory and URL
+		define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
+		define('EE_PLUGIN_DIR_PATH', plugin_dir_path(EVENT_ESPRESSO_MAIN_FILE));
+		define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE));
+		// main root folder paths
+		define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages' . DS);
+		define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core' . DS);
+		define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules' . DS);
+		define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public' . DS);
+		define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes' . DS);
+		define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets' . DS);
+		define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods' . DS);
+		define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated' . DS);
+		// core system paths
+		define('EE_ADMIN', EE_CORE . 'admin' . DS);
+		define('EE_CPTS', EE_CORE . 'CPTs' . DS);
+		define('EE_CLASSES', EE_CORE . 'db_classes' . DS);
+		define('EE_INTERFACES', EE_CORE . 'interfaces' . DS);
+		define('EE_BUSINESS', EE_CORE . 'business' . DS);
+		define('EE_MODELS', EE_CORE . 'db_models' . DS);
+		define('EE_HELPERS', EE_CORE . 'helpers' . DS);
+		define('EE_LIBRARIES', EE_CORE . 'libraries' . DS);
+		define('EE_TEMPLATES', EE_CORE . 'templates' . DS);
+		define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs' . DS);
+		define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets' . DS);
+		define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections' . DS);
+		// gateways
+		define('EE_GATEWAYS', EE_MODULES . 'gateways' . DS);
+		define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules' . DS . 'gateways' . DS);
+		// asset URL paths
+		define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'templates' . DS);
+		define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets' . DS);
+		define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images' . DS);
+		define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'third_party_libs' . DS);
+		define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/');
+		define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/');
+		// define upload paths
+		$uploads = wp_upload_dir();
+		// define the uploads directory and URL
+		define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . DS . 'espresso' . DS);
+		define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . DS . 'espresso' . DS);
+		// define the templates directory and URL
+		define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'templates' . DS);
+		define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'templates' . DS);
+		// define the gateway directory and URL
+		define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'gateways' . DS);
+		define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'gateways' . DS);
+		// languages folder/path
+		define('EE_LANGUAGES_SAFE_LOC', '..' . DS . 'uploads' . DS . 'espresso' . DS . 'languages' . DS);
+		define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS);
+		//check for dompdf fonts in uploads
+		if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS)) {
+			define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS);
+		}
+		//ajax constants
+		define(
+				'EE_FRONT_AJAX',
+				isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax']) ? true : false
+		);
+		define(
+				'EE_ADMIN_AJAX',
+				isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax']) ? true : false
+		);
+		//just a handy constant occasionally needed for finding values representing infinity in the DB
+		//you're better to use this than its straight value (currently -1) in case you ever
+		//want to change its default value! or find when -1 means infinity
+		define('EE_INF_IN_DB', -1);
+		define('EE_INF', INF > (float)PHP_INT_MAX ? INF : PHP_INT_MAX);
+		define('EE_DEBUG', false);
+		// for older WP versions
+		if ( ! defined('MONTH_IN_SECONDS')) {
+			define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
+		}
+		/**
+		 *    espresso_plugin_activation
+		 *    adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
-        /**
-         *    espresso_load_error_handling
-         *    this function loads EE's class for handling exceptions and errors
-         */
-        function espresso_load_error_handling()
-        {
-            // load debugging tools
-            if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
-                require_once(EE_HELPERS . 'EEH_Debug_Tools.helper.php');
-                EEH_Debug_Tools::instance();
-            }
-            // load error handling
-            if (is_readable(EE_CORE . 'EE_Error.core.php')) {
-                require_once(EE_CORE . 'EE_Error.core.php');
-            } else {
-                wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
-            }
-        }
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		/**
+		 *    espresso_load_error_handling
+		 *    this function loads EE's class for handling exceptions and errors
+		 */
+		function espresso_load_error_handling()
+		{
+			// load debugging tools
+			if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
+				require_once(EE_HELPERS . 'EEH_Debug_Tools.helper.php');
+				EEH_Debug_Tools::instance();
+			}
+			// load error handling
+			if (is_readable(EE_CORE . 'EE_Error.core.php')) {
+				require_once(EE_CORE . 'EE_Error.core.php');
+			} else {
+				wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
+			}
+		}
 
-        /**
-         *    espresso_load_required
-         *    given a class name and path, this function will load that file or throw an exception
-         *
-         * @param    string $classname
-         * @param    string $full_path_to_file
-         * @throws    EE_Error
-         */
-        function espresso_load_required($classname, $full_path_to_file)
-        {
-            static $error_handling_loaded = false;
-            if ( ! $error_handling_loaded) {
-                espresso_load_error_handling();
-                $error_handling_loaded = true;
-            }
-            if (is_readable($full_path_to_file)) {
-                require_once($full_path_to_file);
-            } else {
-                throw new EE_Error (
-                        sprintf(
-                                esc_html__(
-                                        'The %s class file could not be located or is not readable due to file permissions.',
-                                        'event_espresso'
-                                ),
-                                $classname
-                        )
-                );
-            }
-        }
+		/**
+		 *    espresso_load_required
+		 *    given a class name and path, this function will load that file or throw an exception
+		 *
+		 * @param    string $classname
+		 * @param    string $full_path_to_file
+		 * @throws    EE_Error
+		 */
+		function espresso_load_required($classname, $full_path_to_file)
+		{
+			static $error_handling_loaded = false;
+			if ( ! $error_handling_loaded) {
+				espresso_load_error_handling();
+				$error_handling_loaded = true;
+			}
+			if (is_readable($full_path_to_file)) {
+				require_once($full_path_to_file);
+			} else {
+				throw new EE_Error (
+						sprintf(
+								esc_html__(
+										'The %s class file could not be located or is not readable due to file permissions.',
+										'event_espresso'
+								),
+								$classname
+						)
+				);
+			}
+		}
 
-        espresso_load_required('EEH_Base', EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php');
-        espresso_load_required('EEH_File', EE_CORE . 'helpers' . DS . 'EEH_File.helper.php');
-        espresso_load_required('EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php');
-        new EE_Bootstrap();
-    }
+		espresso_load_required('EEH_Base', EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php');
+		espresso_load_required('EEH_File', EE_CORE . 'helpers' . DS . 'EEH_File.helper.php');
+		espresso_load_required('EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php');
+		new EE_Bootstrap();
+	}
 }
 if ( ! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if ( ! function_exists('deactivate_plugins')) {
-            require_once(ABSPATH . 'wp-admin/includes/plugin.php');
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if ( ! function_exists('deactivate_plugins')) {
+			require_once(ABSPATH . 'wp-admin/includes/plugin.php');
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }
\ No newline at end of file