eventespresso / event-espresso-core

core/libraries/plugin_api/EE_Register_Message_Type.lib.php

Indentation +445 added lines, -445 removed lines

@@ -12,475 +12,475 @@
 {
 
 
-    /**
-     * Holds values for registered message types
-     *
-     * @var array
-     */
-    protected static $_ee_message_type_registry = array();
+	/**
+	 * Holds values for registered message types
+	 *
+	 * @var array
+	 */
+	protected static $_ee_message_type_registry = array();
 
 
-    /**
-     * Method for registering new message types in the EE_messages system.
-     * Note:  All message types must have the following files in order to work:
-     * Template files for default templates getting setup.
-     * See /core/libraries/messages/defaults/default/ for examples
-     * (note that template files match a specific naming schema).
-     * These templates will need to be registered with the default template pack.
-     * - EE_Messages_Validator extended class(es).  See /core/libraries/messages/validators/email/
-     *      for examples.  Note for any new message types, there will need to be a validator for each
-     *      messenger combo this message type can activate with.
-     * - And of course the main EE_{Message_Type_Name}_message_type class that defines the new
-     *      message type and its properties.
-     *
-     * @since    4.3.0
-     * @param string $mt_name       Whatever is defined for the $name property of
-     *                              the message type you are registering (eg.
-     *                              declined_registration). Required.
-     * @param  array $setup_args    An array of arguments provided for registering the message type.
-     * @see      inline docs in the register method for what can be passed in as arguments.
-     * @throws \EE_Error
-     *                              }
-     */
-    public static function register($mt_name = null, $setup_args = array())
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (! isset($mt_name)
-            || ! is_array($setup_args)
-            || empty($setup_args['mtfilename']) || empty($setup_args['autoloadpaths'])
-        ) {
-            throw new EE_Error(
-                __(
-                    'In order to register a message type with EE_Register_Message_Type::register, you must include a unique name for the message type, plus an array containing the following keys: "mtfilename", "autoloadpaths"',
-                    'event_espresso'
-                )
-            );
-        }
+	/**
+	 * Method for registering new message types in the EE_messages system.
+	 * Note:  All message types must have the following files in order to work:
+	 * Template files for default templates getting setup.
+	 * See /core/libraries/messages/defaults/default/ for examples
+	 * (note that template files match a specific naming schema).
+	 * These templates will need to be registered with the default template pack.
+	 * - EE_Messages_Validator extended class(es).  See /core/libraries/messages/validators/email/
+	 *      for examples.  Note for any new message types, there will need to be a validator for each
+	 *      messenger combo this message type can activate with.
+	 * - And of course the main EE_{Message_Type_Name}_message_type class that defines the new
+	 *      message type and its properties.
+	 *
+	 * @since    4.3.0
+	 * @param string $mt_name       Whatever is defined for the $name property of
+	 *                              the message type you are registering (eg.
+	 *                              declined_registration). Required.
+	 * @param  array $setup_args    An array of arguments provided for registering the message type.
+	 * @see      inline docs in the register method for what can be passed in as arguments.
+	 * @throws \EE_Error
+	 *                              }
+	 */
+	public static function register($mt_name = null, $setup_args = array())
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (! isset($mt_name)
+			|| ! is_array($setup_args)
+			|| empty($setup_args['mtfilename']) || empty($setup_args['autoloadpaths'])
+		) {
+			throw new EE_Error(
+				__(
+					'In order to register a message type with EE_Register_Message_Type::register, you must include a unique name for the message type, plus an array containing the following keys: "mtfilename", "autoloadpaths"',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_ee_message_type_registry[ $mt_name ])) {
-            return;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_ee_message_type_registry[ $mt_name ])) {
+			return;
+		}
 
-        // make sure this was called in the right place!
-        if (! did_action('EE_Brewing_Regular___messages_caf')
-            || did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    __(
-                        'A message type named "%s" has been attempted to be registered with the EE Messages System.  It may or may not work because it should be only called on the "EE_Brewing_Regular___messages_caf" hook.',
-                        'event_espresso'
-                    ),
-                    $mt_name
-                ),
-                '4.3.0'
-            );
-        }
-        // setup $__ee_message_type_registry array from incoming values.
-        self::$_ee_message_type_registry[ $mt_name ] = array(
-            /**
-             * The file name for the message type being registered.
-             * Required.
-             *
-             * @type string
-             */
-            'mtfilename'                                       => (string) $setup_args['mtfilename'],
-            /**
-             * Autoload paths for classes used by the message type.
-             * Required.
-             *
-             * @type array
-             */
-            'autoloadpaths'                                    => (array) $setup_args['autoloadpaths'],
-            /**
-             * Messengers that the message type should be able to activate with.
-             * Use messenger slugs.
-             *
-             * @type array
-             */
-            'messengers_to_activate_with'                      => ! empty($setup_args['messengers_to_activate_with'])
-                ? (array) $setup_args['messengers_to_activate_with']
-                : array(),
-            /**
-             * Messengers that the message type should validate with.
-             * Use messenger slugs.
-             *
-             * @type array
-             */
-            'messengers_to_validate_with'                      => ! empty($setup_args['messengers_to_validate_with'])
-                ? (array) $setup_args['messengers_to_validate_with']
-                : array(),
-            /**
-             * Whether to force activate this message type the first time it is registered.
-             *
-             * @type bool   False means its not activated by default and left up to the end user to activate.
-             */
-            'force_activation'                                 => ! empty($setup_args['force_activation'])
-                ? (bool) $setup_args['force_activation']
-                : false,
-            /**
-             * What messengers this message type supports the default template pack for.
-             * Note: If you do not set this (or any of the following template pack/variation related arguments) to true,
-             * then it is expected that the message type being registered is doing its own custom default template
-             * pack/variation registration.
-             *
-             * If this is set and has values, then it is expected that the following arguments are also set in the incoming options
-             * $setup_arguments array as well:
-             * - 'base_path_for_default_templates'
-             *
-             * @type array   Expect an array of messengers this supports default template packs for.
-             */
-            'messengers_supporting_default_template_pack_with' => isset($setup_args['messengers_supporting_default_template_pack_with'])
-                ? (array) $setup_args['messengers_supporting_default_template_pack_with']
-                : array(),
-            /**
-             * The base path where the default templates for this message type can be found.
-             *
-             * @type string
-             */
-            'base_path_for_default_templates'                  => isset($setup_args['base_path_for_default_templates'])
-                ? $setup_args['base_path_for_default_templates']
-                : '',
-            /**
-             * The base path where the default variations for this message type can be found.
-             *
-             * @type string
-             */
-            'base_path_for_default_variation'                  => isset($setup_args['base_path_for_default_variation'])
-                ? $setup_args['base_path_for_default_variation']
-                : '',
-            /**
-             * The base url for the default variations for this message type.
-             *
-             * @type string
-             */
-            'base_url_for_default_variation'                   => isset($setup_args['base_url_for_default_variation'])
-                ? $setup_args['base_url_for_default_variation']
-                : '',
-        );
-        // add filters but only if they haven't already been set (these filters only need to be registered ONCE because
-        // the callback handles all registered message types.
-        if (false === has_filter(
-            'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
-            array('EE_Register_Message_Type', 'register_msgs_autoload_paths')
-        )) {
-            add_filter(
-                'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
-                array('EE_Register_Message_Type', 'register_msgs_autoload_paths'),
-                10
-            );
-            add_filter(
-                'FHEE__EE_messages__get_installed__messagetype_files',
-                array('EE_Register_Message_Type', 'register_messagetype_files'),
-                10,
-                1
-            );
-            add_filter(
-                'FHEE__EE_messenger__get_default_message_types__default_types',
-                array('EE_Register_Message_Type', 'register_messengers_to_activate_mt_with'),
-                10,
-                2
-            );
-            add_filter(
-                'FHEE__EE_messenger__get_valid_message_types__valid_types',
-                array('EE_Register_Message_Type', 'register_messengers_to_validate_mt_with'),
-                10,
-                2
-            );
-            // actions
-            add_action(
-                'AHEE__EE_Addon__initialize_default_data__begin',
-                array('EE_Register_Message_Type', 'set_defaults')
-            );
+		// make sure this was called in the right place!
+		if (! did_action('EE_Brewing_Regular___messages_caf')
+			|| did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					__(
+						'A message type named "%s" has been attempted to be registered with the EE Messages System.  It may or may not work because it should be only called on the "EE_Brewing_Regular___messages_caf" hook.',
+						'event_espresso'
+					),
+					$mt_name
+				),
+				'4.3.0'
+			);
+		}
+		// setup $__ee_message_type_registry array from incoming values.
+		self::$_ee_message_type_registry[ $mt_name ] = array(
+			/**
+			 * The file name for the message type being registered.
+			 * Required.
+			 *
+			 * @type string
+			 */
+			'mtfilename'                                       => (string) $setup_args['mtfilename'],
+			/**
+			 * Autoload paths for classes used by the message type.
+			 * Required.
+			 *
+			 * @type array
+			 */
+			'autoloadpaths'                                    => (array) $setup_args['autoloadpaths'],
+			/**
+			 * Messengers that the message type should be able to activate with.
+			 * Use messenger slugs.
+			 *
+			 * @type array
+			 */
+			'messengers_to_activate_with'                      => ! empty($setup_args['messengers_to_activate_with'])
+				? (array) $setup_args['messengers_to_activate_with']
+				: array(),
+			/**
+			 * Messengers that the message type should validate with.
+			 * Use messenger slugs.
+			 *
+			 * @type array
+			 */
+			'messengers_to_validate_with'                      => ! empty($setup_args['messengers_to_validate_with'])
+				? (array) $setup_args['messengers_to_validate_with']
+				: array(),
+			/**
+			 * Whether to force activate this message type the first time it is registered.
+			 *
+			 * @type bool   False means its not activated by default and left up to the end user to activate.
+			 */
+			'force_activation'                                 => ! empty($setup_args['force_activation'])
+				? (bool) $setup_args['force_activation']
+				: false,
+			/**
+			 * What messengers this message type supports the default template pack for.
+			 * Note: If you do not set this (or any of the following template pack/variation related arguments) to true,
+			 * then it is expected that the message type being registered is doing its own custom default template
+			 * pack/variation registration.
+			 *
+			 * If this is set and has values, then it is expected that the following arguments are also set in the incoming options
+			 * $setup_arguments array as well:
+			 * - 'base_path_for_default_templates'
+			 *
+			 * @type array   Expect an array of messengers this supports default template packs for.
+			 */
+			'messengers_supporting_default_template_pack_with' => isset($setup_args['messengers_supporting_default_template_pack_with'])
+				? (array) $setup_args['messengers_supporting_default_template_pack_with']
+				: array(),
+			/**
+			 * The base path where the default templates for this message type can be found.
+			 *
+			 * @type string
+			 */
+			'base_path_for_default_templates'                  => isset($setup_args['base_path_for_default_templates'])
+				? $setup_args['base_path_for_default_templates']
+				: '',
+			/**
+			 * The base path where the default variations for this message type can be found.
+			 *
+			 * @type string
+			 */
+			'base_path_for_default_variation'                  => isset($setup_args['base_path_for_default_variation'])
+				? $setup_args['base_path_for_default_variation']
+				: '',
+			/**
+			 * The base url for the default variations for this message type.
+			 *
+			 * @type string
+			 */
+			'base_url_for_default_variation'                   => isset($setup_args['base_url_for_default_variation'])
+				? $setup_args['base_url_for_default_variation']
+				: '',
+		);
+		// add filters but only if they haven't already been set (these filters only need to be registered ONCE because
+		// the callback handles all registered message types.
+		if (false === has_filter(
+			'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
+			array('EE_Register_Message_Type', 'register_msgs_autoload_paths')
+		)) {
+			add_filter(
+				'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
+				array('EE_Register_Message_Type', 'register_msgs_autoload_paths'),
+				10
+			);
+			add_filter(
+				'FHEE__EE_messages__get_installed__messagetype_files',
+				array('EE_Register_Message_Type', 'register_messagetype_files'),
+				10,
+				1
+			);
+			add_filter(
+				'FHEE__EE_messenger__get_default_message_types__default_types',
+				array('EE_Register_Message_Type', 'register_messengers_to_activate_mt_with'),
+				10,
+				2
+			);
+			add_filter(
+				'FHEE__EE_messenger__get_valid_message_types__valid_types',
+				array('EE_Register_Message_Type', 'register_messengers_to_validate_mt_with'),
+				10,
+				2
+			);
+			// actions
+			add_action(
+				'AHEE__EE_Addon__initialize_default_data__begin',
+				array('EE_Register_Message_Type', 'set_defaults')
+			);
 
-            // default template packs and variations related
-            add_filter(
-                'FHEE__EE_Messages_Template_Pack_Default__get_supports',
-                array('EE_Register_Message_Type', 'register_default_template_pack_supports')
-            );
-            add_filter(
-                'FHEE__EE_Template_Pack___get_specific_template__filtered_base_path',
-                array('EE_Register_Message_Type', 'register_base_template_path'),
-                10,
-                6
-            );
-            add_filter(
-                'FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url',
-                array('EE_Register_Message_Type', 'register_variation_base_path_or_url'),
-                10,
-                8
-            );
-            add_filter(
-                'FHEE__EE_Messages_Template_Pack__get_variation__base_path',
-                array('EE_Register_Message_Type', 'register_variation_base_path_or_url'),
-                10,
-                8
-            );
-        }
-    }
+			// default template packs and variations related
+			add_filter(
+				'FHEE__EE_Messages_Template_Pack_Default__get_supports',
+				array('EE_Register_Message_Type', 'register_default_template_pack_supports')
+			);
+			add_filter(
+				'FHEE__EE_Template_Pack___get_specific_template__filtered_base_path',
+				array('EE_Register_Message_Type', 'register_base_template_path'),
+				10,
+				6
+			);
+			add_filter(
+				'FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url',
+				array('EE_Register_Message_Type', 'register_variation_base_path_or_url'),
+				10,
+				8
+			);
+			add_filter(
+				'FHEE__EE_Messages_Template_Pack__get_variation__base_path',
+				array('EE_Register_Message_Type', 'register_variation_base_path_or_url'),
+				10,
+				8
+			);
+		}
+	}
 
 
-    /**
-     * This just ensures that when an addon registers a message type that on initial activation/reactivation the
-     * defaults the addon sets are taken care of.
-     */
-    public static function set_defaults()
-    {
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+	/**
+	 * This just ensures that when an addon registers a message type that on initial activation/reactivation the
+	 * defaults the addon sets are taken care of.
+	 */
+	public static function set_defaults()
+	{
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
 
-        // for any message types with force activation, let's ensure they are activated
-        foreach (self::$_ee_message_type_registry as $message_type_name => $settings) {
-            if ($settings['force_activation']) {
-                foreach ($settings['messengers_to_activate_with'] as $messenger) {
-                    // DO not force activation if this message type has already been activated in the system
-                    if (! $message_resource_manager->has_message_type_been_activated_for_messenger(
-                        $message_type_name,
-                        $messenger
-                    )
-                    ) {
-                        $message_resource_manager->ensure_message_type_is_active($message_type_name, $messenger);
-                    }
-                }
-            }
-        }
-    }
+		// for any message types with force activation, let's ensure they are activated
+		foreach (self::$_ee_message_type_registry as $message_type_name => $settings) {
+			if ($settings['force_activation']) {
+				foreach ($settings['messengers_to_activate_with'] as $messenger) {
+					// DO not force activation if this message type has already been activated in the system
+					if (! $message_resource_manager->has_message_type_been_activated_for_messenger(
+						$message_type_name,
+						$messenger
+					)
+					) {
+						$message_resource_manager->ensure_message_type_is_active($message_type_name, $messenger);
+					}
+				}
+			}
+		}
+	}
 
 
-    /**
-     * This deregisters a message type that was previously registered with a specific message_type_name.
-     *
-     * @since    4.3.0
-     * @param string $message_type_name the name for the message type that was previously registered
-     * @return void
-     */
-    public static function deregister($message_type_name = null)
-    {
-        if (! empty(self::$_ee_message_type_registry[ $message_type_name ])) {
-            // let's make sure that we remove any place this message type was made active
-            /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-            $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-            // ensures that if this message type is registered again that it retains its previous active state vs
-            // remaining inactive.
-            $Message_Resource_Manager->remove_message_type_has_been_activated_from_all_messengers(
-                $message_type_name,
-                true
-            );
-            $Message_Resource_Manager->deactivate_message_type($message_type_name, false);
-            unset(self::$_ee_message_type_registry[ $message_type_name ]);
-        }
-    }
+	/**
+	 * This deregisters a message type that was previously registered with a specific message_type_name.
+	 *
+	 * @since    4.3.0
+	 * @param string $message_type_name the name for the message type that was previously registered
+	 * @return void
+	 */
+	public static function deregister($message_type_name = null)
+	{
+		if (! empty(self::$_ee_message_type_registry[ $message_type_name ])) {
+			// let's make sure that we remove any place this message type was made active
+			/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
+			$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+			// ensures that if this message type is registered again that it retains its previous active state vs
+			// remaining inactive.
+			$Message_Resource_Manager->remove_message_type_has_been_activated_from_all_messengers(
+				$message_type_name,
+				true
+			);
+			$Message_Resource_Manager->deactivate_message_type($message_type_name, false);
+			unset(self::$_ee_message_type_registry[ $message_type_name ]);
+		}
+	}
 
 
-    /**
-     * callback for FHEE__EE_messages__get_installed__messagetype_files filter.
-     *
-     * @since   4.3.0
-     * @param  array $messagetype_files The current array of message type file names
-     * @return  array                                 Array of message type file names
-     */
-    public static function register_messagetype_files($messagetype_files)
-    {
-        if (empty(self::$_ee_message_type_registry)) {
-            return $messagetype_files;
-        }
-        foreach (self::$_ee_message_type_registry as $mt_reg) {
-            if (empty($mt_reg['mtfilename'])) {
-                continue;
-            }
-            $messagetype_files[] = $mt_reg['mtfilename'];
-        }
-        return $messagetype_files;
-    }
+	/**
+	 * callback for FHEE__EE_messages__get_installed__messagetype_files filter.
+	 *
+	 * @since   4.3.0
+	 * @param  array $messagetype_files The current array of message type file names
+	 * @return  array                                 Array of message type file names
+	 */
+	public static function register_messagetype_files($messagetype_files)
+	{
+		if (empty(self::$_ee_message_type_registry)) {
+			return $messagetype_files;
+		}
+		foreach (self::$_ee_message_type_registry as $mt_reg) {
+			if (empty($mt_reg['mtfilename'])) {
+				continue;
+			}
+			$messagetype_files[] = $mt_reg['mtfilename'];
+		}
+		return $messagetype_files;
+	}
 
 
-    /**
-     * callback for FHEE__EED_Messages___set_messages_paths___MSG_PATHS filter.
-     *
-     * @since    4.3.0
-     * @param array $paths array of paths to be checked by EE_messages autoloader.
-     * @return array
-     */
-    public static function register_msgs_autoload_paths($paths)
-    {
-        if (! empty(self::$_ee_message_type_registry)) {
-            foreach (self::$_ee_message_type_registry as $mt_reg) {
-                if (empty($mt_reg['autoloadpaths'])) {
-                    continue;
-                }
-                $paths = array_merge($paths, $mt_reg['autoloadpaths']);
-            }
-        }
-        return $paths;
-    }
+	/**
+	 * callback for FHEE__EED_Messages___set_messages_paths___MSG_PATHS filter.
+	 *
+	 * @since    4.3.0
+	 * @param array $paths array of paths to be checked by EE_messages autoloader.
+	 * @return array
+	 */
+	public static function register_msgs_autoload_paths($paths)
+	{
+		if (! empty(self::$_ee_message_type_registry)) {
+			foreach (self::$_ee_message_type_registry as $mt_reg) {
+				if (empty($mt_reg['autoloadpaths'])) {
+					continue;
+				}
+				$paths = array_merge($paths, $mt_reg['autoloadpaths']);
+			}
+		}
+		return $paths;
+	}
 
 
-    /**
-     * callback for FHEE__EE_messenger__get_default_message_types__default_types filter.
-     *
-     * @since  4.3.0
-     * @param  array        $default_types  array of message types activated with messenger (
-     *                                      corresponds to the $name property of message type)
-     * @param  EE_messenger $messenger      The EE_messenger the filter is called from.
-     * @return array
-     */
-    public static function register_messengers_to_activate_mt_with($default_types, EE_messenger $messenger)
-    {
-        if (empty(self::$_ee_message_type_registry)) {
-            return $default_types;
-        }
-        foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
-            if (empty($mt_reg['messengers_to_activate_with']) || empty($mt_reg['mtfilename'])) {
-                continue;
-            }
-            // loop through each of the messengers and if it matches the loaded class
-            // then we add this message type to the
-            foreach ($mt_reg['messengers_to_activate_with'] as $msgr) {
-                if ($messenger->name == $msgr) {
-                    $default_types[] = $message_type_name;
-                }
-            }
-        }
+	/**
+	 * callback for FHEE__EE_messenger__get_default_message_types__default_types filter.
+	 *
+	 * @since  4.3.0
+	 * @param  array        $default_types  array of message types activated with messenger (
+	 *                                      corresponds to the $name property of message type)
+	 * @param  EE_messenger $messenger      The EE_messenger the filter is called from.
+	 * @return array
+	 */
+	public static function register_messengers_to_activate_mt_with($default_types, EE_messenger $messenger)
+	{
+		if (empty(self::$_ee_message_type_registry)) {
+			return $default_types;
+		}
+		foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
+			if (empty($mt_reg['messengers_to_activate_with']) || empty($mt_reg['mtfilename'])) {
+				continue;
+			}
+			// loop through each of the messengers and if it matches the loaded class
+			// then we add this message type to the
+			foreach ($mt_reg['messengers_to_activate_with'] as $msgr) {
+				if ($messenger->name == $msgr) {
+					$default_types[] = $message_type_name;
+				}
+			}
+		}
 
-        return $default_types;
-    }
+		return $default_types;
+	}
 
 
-    /**
-     * callback for FHEE__EE_messenger__get_valid_message_types__default_types filter.
-     *
-     * @since   4.3.0
-     * @param  array        $valid_types    array of message types valid with messenger (
-     *                                      corresponds to the $name property of message type)
-     * @param  EE_messenger $messenger      The EE_messenger the filter is called from.
-     * @return  array
-     */
-    public static function register_messengers_to_validate_mt_with($valid_types, EE_messenger $messenger)
-    {
-        if (empty(self::$_ee_message_type_registry)) {
-            return $valid_types;
-        }
-        foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
-            if (empty($mt_reg['messengers_to_validate_with']) || empty($mt_reg['mtfilename'])) {
-                continue;
-            }
-            // loop through each of the messengers and if it matches the loaded class
-            // then we add this message type to the
-            foreach ($mt_reg['messengers_to_validate_with'] as $msgr) {
-                if ($messenger->name == $msgr) {
-                    $valid_types[] = $message_type_name;
-                }
-            }
-        }
+	/**
+	 * callback for FHEE__EE_messenger__get_valid_message_types__default_types filter.
+	 *
+	 * @since   4.3.0
+	 * @param  array        $valid_types    array of message types valid with messenger (
+	 *                                      corresponds to the $name property of message type)
+	 * @param  EE_messenger $messenger      The EE_messenger the filter is called from.
+	 * @return  array
+	 */
+	public static function register_messengers_to_validate_mt_with($valid_types, EE_messenger $messenger)
+	{
+		if (empty(self::$_ee_message_type_registry)) {
+			return $valid_types;
+		}
+		foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
+			if (empty($mt_reg['messengers_to_validate_with']) || empty($mt_reg['mtfilename'])) {
+				continue;
+			}
+			// loop through each of the messengers and if it matches the loaded class
+			// then we add this message type to the
+			foreach ($mt_reg['messengers_to_validate_with'] as $msgr) {
+				if ($messenger->name == $msgr) {
+					$valid_types[] = $message_type_name;
+				}
+			}
+		}
 
-        return $valid_types;
-    }
+		return $valid_types;
+	}
 
 
-    /**
-     * Callback for `FHEE__EE_Messages_Template_Pack_Default__get_supports` filter to register this message type as
-     * supporting the default template pack
-     *
-     * @param array $supports
-     *
-     * @return array
-     */
-    public static function register_default_template_pack_supports($supports)
-    {
-        foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
-            if (empty($mt_reg['messengers_supporting_default_template_pack_with'])) {
-                continue;
-            }
-            foreach ($mt_reg['messengers_supporting_default_template_pack_with'] as $messenger_slug) {
-                $supports[ $messenger_slug ][] = $message_type_name;
-            }
-        }
-        return $supports;
-    }
+	/**
+	 * Callback for `FHEE__EE_Messages_Template_Pack_Default__get_supports` filter to register this message type as
+	 * supporting the default template pack
+	 *
+	 * @param array $supports
+	 *
+	 * @return array
+	 */
+	public static function register_default_template_pack_supports($supports)
+	{
+		foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
+			if (empty($mt_reg['messengers_supporting_default_template_pack_with'])) {
+				continue;
+			}
+			foreach ($mt_reg['messengers_supporting_default_template_pack_with'] as $messenger_slug) {
+				$supports[ $messenger_slug ][] = $message_type_name;
+			}
+		}
+		return $supports;
+	}
 
 
-    /**
-     * Callback for FHEE__EE_Template_Pack___get_specific_template__filtered_base_path
-     *
-     * @param string                    $base_path The original base path for message templates
-     * @param EE_messenger              $messenger
-     * @param EE_message_type           $message_type
-     * @param string                    $field     The field requesting a template
-     * @param string                    $context   The context requesting a template
-     * @param EE_Messages_Template_Pack $template_pack
-     *
-     * @return string
-     */
-    public static function register_base_template_path(
-        $base_path,
-        $messenger,
-        $message_type,
-        $field,
-        $context,
-        $template_pack
-    ) {
-        if (! $template_pack instanceof EE_Messages_Template_Pack_Default
-            || ! $message_type instanceof EE_message_type
-        ) {
-            return $base_path;
-        }
-        foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
-            if ($message_type->name === $message_type_name
-                && ! empty($mt_reg['base_path_for_default_templates'])
-            ) {
-                return $mt_reg['base_path_for_default_templates'];
-            }
-        }
-        return $base_path;
-    }
+	/**
+	 * Callback for FHEE__EE_Template_Pack___get_specific_template__filtered_base_path
+	 *
+	 * @param string                    $base_path The original base path for message templates
+	 * @param EE_messenger              $messenger
+	 * @param EE_message_type           $message_type
+	 * @param string                    $field     The field requesting a template
+	 * @param string                    $context   The context requesting a template
+	 * @param EE_Messages_Template_Pack $template_pack
+	 *
+	 * @return string
+	 */
+	public static function register_base_template_path(
+		$base_path,
+		$messenger,
+		$message_type,
+		$field,
+		$context,
+		$template_pack
+	) {
+		if (! $template_pack instanceof EE_Messages_Template_Pack_Default
+			|| ! $message_type instanceof EE_message_type
+		) {
+			return $base_path;
+		}
+		foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
+			if ($message_type->name === $message_type_name
+				&& ! empty($mt_reg['base_path_for_default_templates'])
+			) {
+				return $mt_reg['base_path_for_default_templates'];
+			}
+		}
+		return $base_path;
+	}
 
 
-    /**
-     * Callback for FHEE__EE_Messages_Template_Pack__get_variation__base_path and
-     * FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url hooks
-     *
-     * @param string                    $base_path_or_url  The original incoming base url or path
-     * @param string                    $messenger_slug    The slug of the messenger the template is being generated
-     *                                                     for.
-     * @param string                    $message_type_slug The slug of the message type the template is being generated
-     *                                                     for.
-     * @param string                    $type              The "type" of css being requested.
-     * @param string                    $variation         The variation being requested.
-     * @param string                    $file_extension    What file extension is expected for the variation file.
-     * @param bool                      $url               whether a url or path is being requested.
-     * @param EE_Messages_Template_Pack $template_pack
-     *
-     * @return string
-     */
-    public static function register_variation_base_path_or_url(
-        $base_path_or_url,
-        $messenger_slug,
-        $message_type_slug,
-        $type,
-        $variation,
-        $url,
-        $file_extension,
-        $template_pack
-    ) {
-        if (! $template_pack instanceof EE_Messages_Template_Pack_Default) {
-            return $base_path_or_url;
-        }
-        foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
-            if ($message_type_name === $message_type_slug
-            ) {
-                if ($url
-                    && ! empty($mt_reg['base_url_for_default_variation'])
-                ) {
-                    return $mt_reg['base_url_for_default_variation'];
-                } elseif (! $url
-                          && ! empty($mt_reg['base_path_for_default_variation'])
-                ) {
-                    return $mt_reg['base_path_for_default_variation'];
-                }
-            }
-        }
-        return $base_path_or_url;
-    }
+	/**
+	 * Callback for FHEE__EE_Messages_Template_Pack__get_variation__base_path and
+	 * FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url hooks
+	 *
+	 * @param string                    $base_path_or_url  The original incoming base url or path
+	 * @param string                    $messenger_slug    The slug of the messenger the template is being generated
+	 *                                                     for.
+	 * @param string                    $message_type_slug The slug of the message type the template is being generated
+	 *                                                     for.
+	 * @param string                    $type              The "type" of css being requested.
+	 * @param string                    $variation         The variation being requested.
+	 * @param string                    $file_extension    What file extension is expected for the variation file.
+	 * @param bool                      $url               whether a url or path is being requested.
+	 * @param EE_Messages_Template_Pack $template_pack
+	 *
+	 * @return string
+	 */
+	public static function register_variation_base_path_or_url(
+		$base_path_or_url,
+		$messenger_slug,
+		$message_type_slug,
+		$type,
+		$variation,
+		$url,
+		$file_extension,
+		$template_pack
+	) {
+		if (! $template_pack instanceof EE_Messages_Template_Pack_Default) {
+			return $base_path_or_url;
+		}
+		foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
+			if ($message_type_name === $message_type_slug
+			) {
+				if ($url
+					&& ! empty($mt_reg['base_url_for_default_variation'])
+				) {
+					return $mt_reg['base_url_for_default_variation'];
+				} elseif (! $url
+						  && ! empty($mt_reg['base_path_for_default_variation'])
+				) {
+					return $mt_reg['base_path_for_default_variation'];
+				}
+			}
+		}
+		return $base_path_or_url;
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -45,7 +45,7 @@ 
     public static function register($mt_name = null, $setup_args = array())
     {
         // required fields MUST be present, so let's make sure they are.
-        if (! isset($mt_name)
+        if ( ! isset($mt_name)
             || ! is_array($setup_args)
             || empty($setup_args['mtfilename']) || empty($setup_args['autoloadpaths'])
         ) {
@@ -58,12 +58,12 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_ee_message_type_registry[ $mt_name ])) {
+        if (isset(self::$_ee_message_type_registry[$mt_name])) {
             return;
         }
 
         // make sure this was called in the right place!
-        if (! did_action('EE_Brewing_Regular___messages_caf')
+        if ( ! did_action('EE_Brewing_Regular___messages_caf')
             || did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
         ) {
             EE_Error::doing_it_wrong(
@@ -79,7 +79,7 @@ 
             );
         }
         // setup $__ee_message_type_registry array from incoming values.
-        self::$_ee_message_type_registry[ $mt_name ] = array(
+        self::$_ee_message_type_registry[$mt_name] = array(
             /**
              * The file name for the message type being registered.
              * Required.
@@ -236,7 +236,7 @@ 
             if ($settings['force_activation']) {
                 foreach ($settings['messengers_to_activate_with'] as $messenger) {
                     // DO not force activation if this message type has already been activated in the system
-                    if (! $message_resource_manager->has_message_type_been_activated_for_messenger(
+                    if ( ! $message_resource_manager->has_message_type_been_activated_for_messenger(
                         $message_type_name,
                         $messenger
                     )
@@ -258,7 +258,7 @@ 
      */
     public static function deregister($message_type_name = null)
     {
-        if (! empty(self::$_ee_message_type_registry[ $message_type_name ])) {
+        if ( ! empty(self::$_ee_message_type_registry[$message_type_name])) {
             // let's make sure that we remove any place this message type was made active
             /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
             $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
@@ -269,7 +269,7 @@ 
                 true
             );
             $Message_Resource_Manager->deactivate_message_type($message_type_name, false);
-            unset(self::$_ee_message_type_registry[ $message_type_name ]);
+            unset(self::$_ee_message_type_registry[$message_type_name]);
         }
     }
 
@@ -305,7 +305,7 @@ 
      */
     public static function register_msgs_autoload_paths($paths)
     {
-        if (! empty(self::$_ee_message_type_registry)) {
+        if ( ! empty(self::$_ee_message_type_registry)) {
             foreach (self::$_ee_message_type_registry as $mt_reg) {
                 if (empty($mt_reg['autoloadpaths'])) {
                     continue;
@@ -394,7 +394,7 @@ 
                 continue;
             }
             foreach ($mt_reg['messengers_supporting_default_template_pack_with'] as $messenger_slug) {
-                $supports[ $messenger_slug ][] = $message_type_name;
+                $supports[$messenger_slug][] = $message_type_name;
             }
         }
         return $supports;
@@ -421,7 +421,7 @@ 
         $context,
         $template_pack
     ) {
-        if (! $template_pack instanceof EE_Messages_Template_Pack_Default
+        if ( ! $template_pack instanceof EE_Messages_Template_Pack_Default
             || ! $message_type instanceof EE_message_type
         ) {
             return $base_path;
@@ -464,7 +464,7 @@ 
         $file_extension,
         $template_pack
     ) {
-        if (! $template_pack instanceof EE_Messages_Template_Pack_Default) {
+        if ( ! $template_pack instanceof EE_Messages_Template_Pack_Default) {
             return $base_path_or_url;
         }
         foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
@@ -474,7 +474,7 @@ 
                     && ! empty($mt_reg['base_url_for_default_variation'])
                 ) {
                     return $mt_reg['base_url_for_default_variation'];
-                } elseif (! $url
+                } elseif ( ! $url
                           && ! empty($mt_reg['base_path_for_default_variation'])
                 ) {
                     return $mt_reg['base_path_for_default_variation'];

core/libraries/plugin_api/EE_Register_Messages_Template_Variations.lib.php

Indentation +298 added lines, -298 removed lines

@@ -11,326 +11,326 @@
 class EE_Register_Messages_Template_Variations implements EEI_Plugin_API
 {
 
-    /**
-     * Holds values for registered variations
-     *
-     * @since 4.5.0
-     *
-     * @var array
-     */
-    protected static $_registry = array();
+	/**
+	 * Holds values for registered variations
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var array
+	 */
+	protected static $_registry = array();
 
 
-    /**
-     * Used to register new variations
-     *
-     * Variations are attached to template packs and do not typically change any structural layout but merely tweak the
-     * style of the layout.  The most commonly known variation is css.  CSS does not affect html structure just the
-     * style of existing structure.
-     *
-     * It's important to remember that when variation files are loaded, the file structure looked for is:
-     * '{$messenger}_{$messenger_variation_type}_{$variation_slug}.{$extension}'.
-     *
-     *    - Every variation applies to specific messengers.  That's why the variation file includes the messenger name
-     *    it.   This ensures that if a template pack the variation is registered with supports multiple variations that
-     *    you can have the correct variation loaded.
-     *    - EE_messengers also implicitly define variation "types" which typically are the context in which a specific
-     *    variation is loaded.  For instance the email messenger has: 'inline', which is the css added inline to the
-     *    email templates; 'preview', which is the same css only customized for when emails are previewed; and
-     *    'wpeditor', which is the same css only customized so that it works with the wpeditor fields for templates to
-     *    give a accurate representation of the style in the wysiwyg editor.  This means that for each variation, if
-     *    you want it to be accurately represented in various temlpate contexts you need to have that relevant
-     *    variation file available.
-     *    - $variation_slug  is simply the variation slug for that variation.
-     *    - $extension = whatever the extension is for the variation used for the messenger calling it.  In MOST cases
-     *    messenger variations are .css files. Note: if your file names are not formatted correctly then they will NOT
-     *    be loaded.  The EE messages template pack system will fallback to corresponding default template pack for the
-     *    given messenger or as a last resort (i.e. no default variation for the given messenger) will not load any
-     *    variation (so the template pack would be unstyled)
-     *
-     * @see /core/libraries/messages/defaults/default/variations/* for example variation files for the email and html
-     *      messengers.
-     *
-     * @param string $variation_ref                   unique reference used to describe this variation registry. If
-     *                                                this ISN'T unique then this method will make it unique (and it
-     *                                                becomes harder to deregister).
-     * @param array  $setup_args                      {
-     *                                                an array of required values for registering the variations.
-     * @type array   $variations                      {
-     *                                                An array indexed by template_pack->dbref. and values are an array
-     *                                                indexed by messenger name and values are an array indexed by
-     *                                                message_type and values are an array indexed by variation_slug
-     *                                                and value  is the localized label for the variation.  Note this
-     *                                                api reserves the "default" variation name for the default
-     *                                                template pack so you can't register a default variation.  Also,
-     *                                                try to use unique variation slugs to reference your variations
-     *                                                because this api checks if any existing varations are in place
-     *                                                with that name.  If there are then subsequent variations for that
-     *                                                template pack with that same name will fail to register with a
-     *                                                persistent notice put up for the user. Required.
-     *                                                'default' => array(
-     *                                                'email' => array(
-     *                                                'registration_approved' => array(
-     *                                                my_ee_addon_blue_lagoon' => __('Blue Lagoon',
-     *                                                'text_domain'),
-     *                                                'my_ee_addon_red_sunset' => __('Red Sunset',
-     *                                                'text_domain')
-     *                                                )
-     *                                                )
-     *                                                )
-     *                                                }
-     * @type string  $base_path                       The base path for where all your variations are found.  Although
-     *       the full path to your variation files should include '/variations/' in it, do not include the
-     *       'variations/' in this. Required.
-     * @type string  $base_url                        The base url for where all your variations are found. See note
-     *       above about the 'variations/' string. Required.
-     *                                                }
-     *                                                }
-     *
-     * @throws EE_Error
-     * @return void
-     */
-    public static function register($variation_ref = null, $setup_args = array())
-    {
+	/**
+	 * Used to register new variations
+	 *
+	 * Variations are attached to template packs and do not typically change any structural layout but merely tweak the
+	 * style of the layout.  The most commonly known variation is css.  CSS does not affect html structure just the
+	 * style of existing structure.
+	 *
+	 * It's important to remember that when variation files are loaded, the file structure looked for is:
+	 * '{$messenger}_{$messenger_variation_type}_{$variation_slug}.{$extension}'.
+	 *
+	 *    - Every variation applies to specific messengers.  That's why the variation file includes the messenger name
+	 *    it.   This ensures that if a template pack the variation is registered with supports multiple variations that
+	 *    you can have the correct variation loaded.
+	 *    - EE_messengers also implicitly define variation "types" which typically are the context in which a specific
+	 *    variation is loaded.  For instance the email messenger has: 'inline', which is the css added inline to the
+	 *    email templates; 'preview', which is the same css only customized for when emails are previewed; and
+	 *    'wpeditor', which is the same css only customized so that it works with the wpeditor fields for templates to
+	 *    give a accurate representation of the style in the wysiwyg editor.  This means that for each variation, if
+	 *    you want it to be accurately represented in various temlpate contexts you need to have that relevant
+	 *    variation file available.
+	 *    - $variation_slug  is simply the variation slug for that variation.
+	 *    - $extension = whatever the extension is for the variation used for the messenger calling it.  In MOST cases
+	 *    messenger variations are .css files. Note: if your file names are not formatted correctly then they will NOT
+	 *    be loaded.  The EE messages template pack system will fallback to corresponding default template pack for the
+	 *    given messenger or as a last resort (i.e. no default variation for the given messenger) will not load any
+	 *    variation (so the template pack would be unstyled)
+	 *
+	 * @see /core/libraries/messages/defaults/default/variations/* for example variation files for the email and html
+	 *      messengers.
+	 *
+	 * @param string $variation_ref                   unique reference used to describe this variation registry. If
+	 *                                                this ISN'T unique then this method will make it unique (and it
+	 *                                                becomes harder to deregister).
+	 * @param array  $setup_args                      {
+	 *                                                an array of required values for registering the variations.
+	 * @type array   $variations                      {
+	 *                                                An array indexed by template_pack->dbref. and values are an array
+	 *                                                indexed by messenger name and values are an array indexed by
+	 *                                                message_type and values are an array indexed by variation_slug
+	 *                                                and value  is the localized label for the variation.  Note this
+	 *                                                api reserves the "default" variation name for the default
+	 *                                                template pack so you can't register a default variation.  Also,
+	 *                                                try to use unique variation slugs to reference your variations
+	 *                                                because this api checks if any existing varations are in place
+	 *                                                with that name.  If there are then subsequent variations for that
+	 *                                                template pack with that same name will fail to register with a
+	 *                                                persistent notice put up for the user. Required.
+	 *                                                'default' => array(
+	 *                                                'email' => array(
+	 *                                                'registration_approved' => array(
+	 *                                                my_ee_addon_blue_lagoon' => __('Blue Lagoon',
+	 *                                                'text_domain'),
+	 *                                                'my_ee_addon_red_sunset' => __('Red Sunset',
+	 *                                                'text_domain')
+	 *                                                )
+	 *                                                )
+	 *                                                )
+	 *                                                }
+	 * @type string  $base_path                       The base path for where all your variations are found.  Although
+	 *       the full path to your variation files should include '/variations/' in it, do not include the
+	 *       'variations/' in this. Required.
+	 * @type string  $base_url                        The base url for where all your variations are found. See note
+	 *       above about the 'variations/' string. Required.
+	 *                                                }
+	 *                                                }
+	 *
+	 * @throws EE_Error
+	 * @return void
+	 */
+	public static function register($variation_ref = null, $setup_args = array())
+	{
 
-        // check for required params
-        if (empty($variation_ref)) {
-            throw new EE_Error(
-                __(
-                    'In order to register variations for a EE_Message_Template_Pack, you must include a value to reference the variations being registered',
-                    'event_espresso'
-                )
-            );
-        }
+		// check for required params
+		if (empty($variation_ref)) {
+			throw new EE_Error(
+				__(
+					'In order to register variations for a EE_Message_Template_Pack, you must include a value to reference the variations being registered',
+					'event_espresso'
+				)
+			);
+		}
 
-        if (! is_array($setup_args)
-            || empty($setup_args['variations'])
-            || empty($setup_args['base_path'])
-            || empty($setup_args['base_url'])
-        ) {
-            throw new EE_Error(
-                __(
-                    'In order to register variations for a EE_Message_Template_Pack, you must include an array containing the following keys: "variations", "base_path", "base_url", "extension"',
-                    'event_espresso'
-                )
-            );
-        }
+		if (! is_array($setup_args)
+			|| empty($setup_args['variations'])
+			|| empty($setup_args['base_path'])
+			|| empty($setup_args['base_url'])
+		) {
+			throw new EE_Error(
+				__(
+					'In order to register variations for a EE_Message_Template_Pack, you must include an array containing the following keys: "variations", "base_path", "base_url", "extension"',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_registry[ $variation_ref ])) {
-            return;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_registry[ $variation_ref ])) {
+			return;
+		}
 
-        // make sure variation ref is unique.
-        if (isset(self::$_registry[ $variation_ref ])) {
-            $variation_ref = uniqid() . '_' . $variation_ref;
-        }
+		// make sure variation ref is unique.
+		if (isset(self::$_registry[ $variation_ref ])) {
+			$variation_ref = uniqid() . '_' . $variation_ref;
+		}
 
 
-        // make sure this was called in the right place!
-        if (! did_action('EE_Brewing_Regular___messages_caf')
-            || did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    __(
-                        'Messages Templates Variations given the reference "%s" has been attempted to be registered with the EE Messages Template Pack System.  It may or may not work because it should be only called on the "EE_Brewing_Regular__messages_caf" hook.',
-                        'event_espresso'
-                    ),
-                    $variation_ref
-                ),
-                '4.5.0'
-            );
-        }
+		// make sure this was called in the right place!
+		if (! did_action('EE_Brewing_Regular___messages_caf')
+			|| did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					__(
+						'Messages Templates Variations given the reference "%s" has been attempted to be registered with the EE Messages Template Pack System.  It may or may not work because it should be only called on the "EE_Brewing_Regular__messages_caf" hook.',
+						'event_espresso'
+					),
+					$variation_ref
+				),
+				'4.5.0'
+			);
+		}
 
-        // validate/sanitize incoming args.
-        $validated = array(
-            'variations' => (array) $setup_args['variations'],
-            'base_path'  => (string) $setup_args['base_path'],
-            'base_url'   => (string) $setup_args['base_url'],
-        );
+		// validate/sanitize incoming args.
+		$validated = array(
+			'variations' => (array) $setup_args['variations'],
+			'base_path'  => (string) $setup_args['base_path'],
+			'base_url'   => (string) $setup_args['base_url'],
+		);
 
 
-        // check that no reserved variation names are in use and also checks if there are already existing variation names for a given template pack.  The former will throw an error.  The latter will remove the conflicting variation name but still register the others and will add EE_Error notice.
-        $validated = self::_verify_variations($variation_ref, $validated);
-        self::$_registry[ $variation_ref ] = $validated;
+		// check that no reserved variation names are in use and also checks if there are already existing variation names for a given template pack.  The former will throw an error.  The latter will remove the conflicting variation name but still register the others and will add EE_Error notice.
+		$validated = self::_verify_variations($variation_ref, $validated);
+		self::$_registry[ $variation_ref ] = $validated;
 
-        add_filter(
-            'FHEE__EE_Messages_Template_Pack__get_variations',
-            array('EE_Register_Messages_Template_Variations', 'get_variations'),
-            10,
-            4
-        );
-        add_filter(
-            'FHEE__EE_Messages_Template_Pack__get_variation',
-            array('EE_Register_Messages_Template_Variations', 'get_variation'),
-            10,
-            8
-        );
-    }
+		add_filter(
+			'FHEE__EE_Messages_Template_Pack__get_variations',
+			array('EE_Register_Messages_Template_Variations', 'get_variations'),
+			10,
+			4
+		);
+		add_filter(
+			'FHEE__EE_Messages_Template_Pack__get_variation',
+			array('EE_Register_Messages_Template_Variations', 'get_variation'),
+			10,
+			8
+		);
+	}
 
 
-    /**
-     * Cycles through the variations registered and makes sure there are no reserved variations being registered which
-     * throws an error.  Also checks if there is already a
-     *
-     * @since  4.5.0
-     *
-     * @param string $variation_ref        the reference for the variations being registered
-     * @param array  $validated_variations The variations setup array that's being registered (and verified).
-     * @throws EE_Error
-     * @return bool
-     */
-    private static function _verify_variations($variation_ref, $validated_variations)
-    {
-        foreach (self::$_registry as $variation_ref => $settings) {
-            foreach ($settings['variations'] as $template_pack => $messenger) {
-                foreach ($messenger as $all_variations) {
-                    if (isset($all_variations['default'])) {
-                        throw new EE_Error(
-                            sprintf(
-                                __(
-                                    'Variations registered through the EE_Register_Messages_Template_Variations api cannot override the default variation for the default template.  Please check the code registering variations with this reference, "%s" and modify.',
-                                    'event_espresso'
-                                ),
-                                $variation_ref
-                            )
-                        );
-                    }
-                }
-            }
-        }
+	/**
+	 * Cycles through the variations registered and makes sure there are no reserved variations being registered which
+	 * throws an error.  Also checks if there is already a
+	 *
+	 * @since  4.5.0
+	 *
+	 * @param string $variation_ref        the reference for the variations being registered
+	 * @param array  $validated_variations The variations setup array that's being registered (and verified).
+	 * @throws EE_Error
+	 * @return bool
+	 */
+	private static function _verify_variations($variation_ref, $validated_variations)
+	{
+		foreach (self::$_registry as $variation_ref => $settings) {
+			foreach ($settings['variations'] as $template_pack => $messenger) {
+				foreach ($messenger as $all_variations) {
+					if (isset($all_variations['default'])) {
+						throw new EE_Error(
+							sprintf(
+								__(
+									'Variations registered through the EE_Register_Messages_Template_Variations api cannot override the default variation for the default template.  Please check the code registering variations with this reference, "%s" and modify.',
+									'event_espresso'
+								),
+								$variation_ref
+							)
+						);
+					}
+				}
+			}
+		}
 
-        // is there already a variation registered with a given variation slug?
-        foreach ($validated_variations['variations'] as $template_pack => $messenger) {
-            foreach ($messenger as $message_type => $variations) {
-                foreach ($variations as $slug => $label) {
-                    foreach (self::$_registry as $registered_var => $reg_settings) {
-                        if (isset($reg_settings['variations'][ $template_pack ][ $messenger ][ $message_type ][ $slug ])) {
-                            unset($validated_variations['variations'][ $template_pack ][ $messenger ][ $message_type ][ $slug ]);
-                            EE_Error::add_error(
-                                sprintf(
-                                    __(
-                                        'Unable to register the %s variation for the %s template pack with the %s messenger and %s message_type because a variation with this slug was already registered for this template pack and messenger and message type by an addon using this key %s.',
-                                        'event_espresso'
-                                    ),
-                                    $label,
-                                    $template_pack,
-                                    $messenger,
-                                    $message_type,
-                                    $registered_var
-                                )
-                            );
-                        }
-                    }
-                }
-            }
-        }
-        return $validated_variations;
-    }
+		// is there already a variation registered with a given variation slug?
+		foreach ($validated_variations['variations'] as $template_pack => $messenger) {
+			foreach ($messenger as $message_type => $variations) {
+				foreach ($variations as $slug => $label) {
+					foreach (self::$_registry as $registered_var => $reg_settings) {
+						if (isset($reg_settings['variations'][ $template_pack ][ $messenger ][ $message_type ][ $slug ])) {
+							unset($validated_variations['variations'][ $template_pack ][ $messenger ][ $message_type ][ $slug ]);
+							EE_Error::add_error(
+								sprintf(
+									__(
+										'Unable to register the %s variation for the %s template pack with the %s messenger and %s message_type because a variation with this slug was already registered for this template pack and messenger and message type by an addon using this key %s.',
+										'event_espresso'
+									),
+									$label,
+									$template_pack,
+									$messenger,
+									$message_type,
+									$registered_var
+								)
+							);
+						}
+					}
+				}
+			}
+		}
+		return $validated_variations;
+	}
 
 
-    /**
-     * Callback for the FHEE__EE_Messages_Template_Pack__get_variation filter to ensure registered variations are used.
-     *
-     * @since 4.5.0
-     *
-     * @param string                    $variation_path The path generated for the current variation
-     * @param string                    $messenger      The messenger the variation is for
-     * @param string                    $message_type   EE_message_type->name
-     * @param string                    $type           The type of variation being requested
-     * @param string                    $variation      The slug for the variation being requested
-     * @param string                    $file_extension What the file extension is for the variation
-     * @param bool                      $url            Whether url or path is being returned.
-     * @param EE_Messages_Template_Pack $template_pack
-     *
-     * @return string                    The path to the requested variation.
-     */
-    public static function get_variation(
-        $variation_path,
-        $messenger,
-        $message_type,
-        $type,
-        $variation,
-        $file_extension,
-        $url,
-        EE_Messages_Template_Pack $template_pack
-    ) {
+	/**
+	 * Callback for the FHEE__EE_Messages_Template_Pack__get_variation filter to ensure registered variations are used.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string                    $variation_path The path generated for the current variation
+	 * @param string                    $messenger      The messenger the variation is for
+	 * @param string                    $message_type   EE_message_type->name
+	 * @param string                    $type           The type of variation being requested
+	 * @param string                    $variation      The slug for the variation being requested
+	 * @param string                    $file_extension What the file extension is for the variation
+	 * @param bool                      $url            Whether url or path is being returned.
+	 * @param EE_Messages_Template_Pack $template_pack
+	 *
+	 * @return string                    The path to the requested variation.
+	 */
+	public static function get_variation(
+		$variation_path,
+		$messenger,
+		$message_type,
+		$type,
+		$variation,
+		$file_extension,
+		$url,
+		EE_Messages_Template_Pack $template_pack
+	) {
 
-        // so let's loop through our registered variations and then pull any details matching the request.
-        foreach (self::$_registry as $registry_slug => $registry_settings) {
-            $base = $url ? $registry_settings['base_url'] : $registry_settings['base_path'];
-            $file_string = $messenger . '_' . $type . '_' . $variation . $file_extension;
-            // see if this file exists
-            if (is_readable($registry_settings['base_path'] . $file_string)) {
-                return $base . $file_string;
-            }
-        }
+		// so let's loop through our registered variations and then pull any details matching the request.
+		foreach (self::$_registry as $registry_slug => $registry_settings) {
+			$base = $url ? $registry_settings['base_url'] : $registry_settings['base_path'];
+			$file_string = $messenger . '_' . $type . '_' . $variation . $file_extension;
+			// see if this file exists
+			if (is_readable($registry_settings['base_path'] . $file_string)) {
+				return $base . $file_string;
+			}
+		}
 
-        // no match
-        return $variation_path;
-    }
+		// no match
+		return $variation_path;
+	}
 
 
-    /**
-     * callback for the FHEE__EE_Messages_Template_Pack__get_variations filter.
-     *
-     *
-     * @since 4.5.0
-     *
-     * @param array                     $variations The original contents for the template pack variations property.
-     *                                              @see $_variation property definition in EE_Messages_Template_Pack
-     * @param string                    $messenger  The messenger requesting the variations.
-     * @param EE_Messages_Template_Pack $template_pack
-     *
-     * @return array                   new variations array (or existing one if nothing registered)
-     */
-    public static function get_variations(
-        $variations,
-        $messenger,
-        $message_type,
-        EE_Messages_Template_Pack $template_pack
-    ) {
-        // first let's check if we even have registered variations and get out early.
-        if (empty(self::$_registry)) {
-            return $variations;
-        }
+	/**
+	 * callback for the FHEE__EE_Messages_Template_Pack__get_variations filter.
+	 *
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param array                     $variations The original contents for the template pack variations property.
+	 *                                              @see $_variation property definition in EE_Messages_Template_Pack
+	 * @param string                    $messenger  The messenger requesting the variations.
+	 * @param EE_Messages_Template_Pack $template_pack
+	 *
+	 * @return array                   new variations array (or existing one if nothing registered)
+	 */
+	public static function get_variations(
+		$variations,
+		$messenger,
+		$message_type,
+		EE_Messages_Template_Pack $template_pack
+	) {
+		// first let's check if we even have registered variations and get out early.
+		if (empty(self::$_registry)) {
+			return $variations;
+		}
 
-        // do we have any new variations for the given messenger, $message_type, and template packs
-        foreach (self::$_registry as $registry_slug => $registry_settings) {
-            // allow for different conditions.
-            if (empty($messenger)) {
-                $variations = array_merge($registry_settings['variations'], $variations);
-            } elseif (! empty($messenger) && empty($message_type) && ! empty($registry_settings['variations'][ $template_pack->dbref ][ $messenger ])) {
-                $variations = array_merge(
-                    $registry_settings['variations'][ $template_pack->dbref ][ $messenger ],
-                    $variations
-                );
-            } elseif (! empty($messenger) && ! empty($message_type) && ! empty($registry_settings['variations'][ $template_pack->dbref ][ $messenger ][ $message_type ])) {
-                $variations = array_merge(
-                    $registry_settings['variations'][ $template_pack->dbref ][ $messenger ][ $message_type ],
-                    $variations
-                );
-            }
-        }
-        return $variations;
-    }
+		// do we have any new variations for the given messenger, $message_type, and template packs
+		foreach (self::$_registry as $registry_slug => $registry_settings) {
+			// allow for different conditions.
+			if (empty($messenger)) {
+				$variations = array_merge($registry_settings['variations'], $variations);
+			} elseif (! empty($messenger) && empty($message_type) && ! empty($registry_settings['variations'][ $template_pack->dbref ][ $messenger ])) {
+				$variations = array_merge(
+					$registry_settings['variations'][ $template_pack->dbref ][ $messenger ],
+					$variations
+				);
+			} elseif (! empty($messenger) && ! empty($message_type) && ! empty($registry_settings['variations'][ $template_pack->dbref ][ $messenger ][ $message_type ])) {
+				$variations = array_merge(
+					$registry_settings['variations'][ $template_pack->dbref ][ $messenger ][ $message_type ],
+					$variations
+				);
+			}
+		}
+		return $variations;
+	}
 
 
-    /**
-     * This deregisters a variation set that was previously registered with the given slug.
-     *
-     * @since 4.5.0
-     *
-     * @param string $variation_ref The name for the variation set that was previously registered.
-     *
-     * @return void
-     */
-    public static function deregister($variation_ref = null)
-    {
-        if (! empty(self::$_registry[ $variation_ref ])) {
-            unset(self::$_registry[ $variation_ref ]);
-        }
-    }
+	/**
+	 * This deregisters a variation set that was previously registered with the given slug.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string $variation_ref The name for the variation set that was previously registered.
+	 *
+	 * @return void
+	 */
+	public static function deregister($variation_ref = null)
+	{
+		if (! empty(self::$_registry[ $variation_ref ])) {
+			unset(self::$_registry[ $variation_ref ]);
+		}
+	}
 }

Spacing +17 added lines, -17 removed lines

@@ -103,7 +103,7 @@ 
             );
         }
 
-        if (! is_array($setup_args)
+        if ( ! is_array($setup_args)
             || empty($setup_args['variations'])
             || empty($setup_args['base_path'])
             || empty($setup_args['base_url'])
@@ -117,18 +117,18 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_registry[ $variation_ref ])) {
+        if (isset(self::$_registry[$variation_ref])) {
             return;
         }
 
         // make sure variation ref is unique.
-        if (isset(self::$_registry[ $variation_ref ])) {
-            $variation_ref = uniqid() . '_' . $variation_ref;
+        if (isset(self::$_registry[$variation_ref])) {
+            $variation_ref = uniqid().'_'.$variation_ref;
         }
 
 
         // make sure this was called in the right place!
-        if (! did_action('EE_Brewing_Regular___messages_caf')
+        if ( ! did_action('EE_Brewing_Regular___messages_caf')
             || did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
         ) {
             EE_Error::doing_it_wrong(
@@ -154,7 +154,7 @@ 
 
         // check that no reserved variation names are in use and also checks if there are already existing variation names for a given template pack.  The former will throw an error.  The latter will remove the conflicting variation name but still register the others and will add EE_Error notice.
         $validated = self::_verify_variations($variation_ref, $validated);
-        self::$_registry[ $variation_ref ] = $validated;
+        self::$_registry[$variation_ref] = $validated;
 
         add_filter(
             'FHEE__EE_Messages_Template_Pack__get_variations',
@@ -207,8 +207,8 @@ 
             foreach ($messenger as $message_type => $variations) {
                 foreach ($variations as $slug => $label) {
                     foreach (self::$_registry as $registered_var => $reg_settings) {
-                        if (isset($reg_settings['variations'][ $template_pack ][ $messenger ][ $message_type ][ $slug ])) {
-                            unset($validated_variations['variations'][ $template_pack ][ $messenger ][ $message_type ][ $slug ]);
+                        if (isset($reg_settings['variations'][$template_pack][$messenger][$message_type][$slug])) {
+                            unset($validated_variations['variations'][$template_pack][$messenger][$message_type][$slug]);
                             EE_Error::add_error(
                                 sprintf(
                                     __(
@@ -261,10 +261,10 @@ 
         // so let's loop through our registered variations and then pull any details matching the request.
         foreach (self::$_registry as $registry_slug => $registry_settings) {
             $base = $url ? $registry_settings['base_url'] : $registry_settings['base_path'];
-            $file_string = $messenger . '_' . $type . '_' . $variation . $file_extension;
+            $file_string = $messenger.'_'.$type.'_'.$variation.$file_extension;
             // see if this file exists
-            if (is_readable($registry_settings['base_path'] . $file_string)) {
-                return $base . $file_string;
+            if (is_readable($registry_settings['base_path'].$file_string)) {
+                return $base.$file_string;
             }
         }
 
@@ -302,14 +302,14 @@ 
             // allow for different conditions.
             if (empty($messenger)) {
                 $variations = array_merge($registry_settings['variations'], $variations);
-            } elseif (! empty($messenger) && empty($message_type) && ! empty($registry_settings['variations'][ $template_pack->dbref ][ $messenger ])) {
+            } elseif ( ! empty($messenger) && empty($message_type) && ! empty($registry_settings['variations'][$template_pack->dbref][$messenger])) {
                 $variations = array_merge(
-                    $registry_settings['variations'][ $template_pack->dbref ][ $messenger ],
+                    $registry_settings['variations'][$template_pack->dbref][$messenger],
                     $variations
                 );
-            } elseif (! empty($messenger) && ! empty($message_type) && ! empty($registry_settings['variations'][ $template_pack->dbref ][ $messenger ][ $message_type ])) {
+            } elseif ( ! empty($messenger) && ! empty($message_type) && ! empty($registry_settings['variations'][$template_pack->dbref][$messenger][$message_type])) {
                 $variations = array_merge(
-                    $registry_settings['variations'][ $template_pack->dbref ][ $messenger ][ $message_type ],
+                    $registry_settings['variations'][$template_pack->dbref][$messenger][$message_type],
                     $variations
                 );
             }
@@ -329,8 +329,8 @@ 
      */
     public static function deregister($variation_ref = null)
     {
-        if (! empty(self::$_registry[ $variation_ref ])) {
-            unset(self::$_registry[ $variation_ref ]);
+        if ( ! empty(self::$_registry[$variation_ref])) {
+            unset(self::$_registry[$variation_ref]);
         }
     }
 }

core/libraries/plugin_api/EE_Register_Config.lib.php

Indentation +100 added lines, -100 removed lines

@@ -12,116 +12,116 @@
 class EE_Register_Config implements EEI_Plugin_API
 {
 
-    /**
-     * Holds registered EE_Config items
-     *
-     * @var array
-     */
-    protected static $_ee_config_registry = array();
+	/**
+	 * Holds registered EE_Config items
+	 *
+	 * @var array
+	 */
+	protected static $_ee_config_registry = array();
 
 
-    /**
-     * Handles registering the new config with the EE_Config::instance()->addons property
-     *
-     * @since    4.3.0
-     * @throws EE_Error
-     *
-     * @param  string $config_class The name of the Config class being registered.
-     *                                                    Note this class must extend EE_Config Base and must have
-     *                                                    already been registered with an autoloader.
-     * @param  array  $setup_args {
-     *
-     * @type  string  $config_name Optional.  by default the new config will be registered to
-     *        EE_Config::instance()->addons->{config_class}, but supplying a "config_name" will set the property name
-     *        that this variable is accessible by. ie: EE_Config::instance()->addons->{config_name}
-     *                            }
-     * @return void
-     */
-    public static function register($config_class = null, $setup_args = array())
-    {
+	/**
+	 * Handles registering the new config with the EE_Config::instance()->addons property
+	 *
+	 * @since    4.3.0
+	 * @throws EE_Error
+	 *
+	 * @param  string $config_class The name of the Config class being registered.
+	 *                                                    Note this class must extend EE_Config Base and must have
+	 *                                                    already been registered with an autoloader.
+	 * @param  array  $setup_args {
+	 *
+	 * @type  string  $config_name Optional.  by default the new config will be registered to
+	 *        EE_Config::instance()->addons->{config_class}, but supplying a "config_name" will set the property name
+	 *        that this variable is accessible by. ie: EE_Config::instance()->addons->{config_name}
+	 *                            }
+	 * @return void
+	 */
+	public static function register($config_class = null, $setup_args = array())
+	{
 
-        $setup_args['config_name'] = isset($setup_args['config_name']) && ! empty($setup_args['config_name'])
-            ? $setup_args['config_name'] : $config_class;
-        $setup_args['config_section'] = isset($setup_args['config_section']) && ! empty($setup_args['config_section'])
-            ? $setup_args['config_section'] : 'addons';
+		$setup_args['config_name'] = isset($setup_args['config_name']) && ! empty($setup_args['config_name'])
+			? $setup_args['config_name'] : $config_class;
+		$setup_args['config_section'] = isset($setup_args['config_section']) && ! empty($setup_args['config_section'])
+			? $setup_args['config_section'] : 'addons';
 
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($config_class) || ! is_array($setup_args) || empty($setup_args['config_name'])) {
-            throw new EE_Error(
-                __(
-                    'In order to register a Config Class with EE_Register_Config::register(), you must include a "config_class" (the actual class name for this config class). As well, you can supply an array containing the following keys: "config_section" the main section of the config object the settings will be saved under (by default the new config will be registered under EE_Config::instance()->modules or EE_Config::instance()->addons depending on what type of class is calling this), "config_name" (by default the new config will be registered to EE_Config::instance()->{config_section}->{config_class}, but supplying a "config_name" will set the property name that this variable is accessible by. ie: EE_Config::instance()->{config_section}->{config_name})',
-                    'event_espresso'
-                )
-            );
-        }
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($config_class) || ! is_array($setup_args) || empty($setup_args['config_name'])) {
+			throw new EE_Error(
+				__(
+					'In order to register a Config Class with EE_Register_Config::register(), you must include a "config_class" (the actual class name for this config class). As well, you can supply an array containing the following keys: "config_section" the main section of the config object the settings will be saved under (by default the new config will be registered under EE_Config::instance()->modules or EE_Config::instance()->addons depending on what type of class is calling this), "config_name" (by default the new config will be registered to EE_Config::instance()->{config_section}->{config_class}, but supplying a "config_name" will set the property name that this variable is accessible by. ie: EE_Config::instance()->{config_section}->{config_name})',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_ee_config_registry[ $config_class ])) {
-            return;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_ee_config_registry[ $config_class ])) {
+			return;
+		}
 
 
-        // first find out if this happened too late.
-        if (did_action('AHEE__EE_System__load_core_configuration__begin')) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    __(
-                        'An attempt to register "%s" as an EE_Config object has failed because it was not registered at the correct hookpoint.  Please register before the "AHEE__EE_System__load_core_configuration__begin" hook has fired',
-                        'event_espresso'
-                    ),
-                    $setup_args['config_name']
-                ),
-                '4.3'
-            );
-        }
-        // add incoming stuff to our registry property
-        self::$_ee_config_registry[ $config_class ] = array(
-            'section' => $setup_args['config_section'],
-            'name'    => $setup_args['config_name'],
-        );
+		// first find out if this happened too late.
+		if (did_action('AHEE__EE_System__load_core_configuration__begin')) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					__(
+						'An attempt to register "%s" as an EE_Config object has failed because it was not registered at the correct hookpoint.  Please register before the "AHEE__EE_System__load_core_configuration__begin" hook has fired',
+						'event_espresso'
+					),
+					$setup_args['config_name']
+				),
+				'4.3'
+			);
+		}
+		// add incoming stuff to our registry property
+		self::$_ee_config_registry[ $config_class ] = array(
+			'section' => $setup_args['config_section'],
+			'name'    => $setup_args['config_name'],
+		);
 
-        add_action('AHEE__EE_Config___load_core_config__end', array('EE_Register_Config', 'set_config'), 15, 1);
-        add_action('AHEE__EE_Config__update_espresso_config__end', array('EE_Register_Config', 'set_config'), 15, 1);
-    }
+		add_action('AHEE__EE_Config___load_core_config__end', array('EE_Register_Config', 'set_config'), 15, 1);
+		add_action('AHEE__EE_Config__update_espresso_config__end', array('EE_Register_Config', 'set_config'), 15, 1);
+	}
 
 
-    /**
-     * Callback for the AHEE__EE_Config___load_core_config__end hook.
-     * basically just calls EE_Config->get_config() which will take care of loading or creating our config object for us
-     *
-     * @since    4.3.0
-     * @throws EE_Error
-     * @param \EE_Config $EE_Config
-     * @return \StdClass
-     */
-    public static function set_config(EE_Config $EE_Config)
-    {
-        foreach (self::$_ee_config_registry as $config_class => $settings) {
-            // first some validation of our incoming class_name.  We'll throw an error early if its' not registered correctly
-            if (! class_exists($config_class)) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'The "%s" config class can not be registered with EE_Config because it does not exist.  Verify that an autoloader has been set for this class',
-                            'event_espresso'
-                        ),
-                        $config_class
-                    )
-                );
-            }
-            $EE_Config->get_config($settings['section'], $settings['name'], $config_class);
-        }
-    }
+	/**
+	 * Callback for the AHEE__EE_Config___load_core_config__end hook.
+	 * basically just calls EE_Config->get_config() which will take care of loading or creating our config object for us
+	 *
+	 * @since    4.3.0
+	 * @throws EE_Error
+	 * @param \EE_Config $EE_Config
+	 * @return \StdClass
+	 */
+	public static function set_config(EE_Config $EE_Config)
+	{
+		foreach (self::$_ee_config_registry as $config_class => $settings) {
+			// first some validation of our incoming class_name.  We'll throw an error early if its' not registered correctly
+			if (! class_exists($config_class)) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'The "%s" config class can not be registered with EE_Config because it does not exist.  Verify that an autoloader has been set for this class',
+							'event_espresso'
+						),
+						$config_class
+					)
+				);
+			}
+			$EE_Config->get_config($settings['section'], $settings['name'], $config_class);
+		}
+	}
 
 
-    /**
-     * @param mixed $config_class_name
-     */
-    public static function deregister($config_class_name = null)
-    {
-        if (! empty(self::$_ee_config_registry[ $config_class_name ])) {
-            unset(self::$_ee_config_registry[ $config_class_name ]);
-        }
-    }
+	/**
+	 * @param mixed $config_class_name
+	 */
+	public static function deregister($config_class_name = null)
+	{
+		if (! empty(self::$_ee_config_registry[ $config_class_name ])) {
+			unset(self::$_ee_config_registry[ $config_class_name ]);
+		}
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -56,7 +56,7 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_ee_config_registry[ $config_class ])) {
+        if (isset(self::$_ee_config_registry[$config_class])) {
             return;
         }
 
@@ -76,7 +76,7 @@ 
             );
         }
         // add incoming stuff to our registry property
-        self::$_ee_config_registry[ $config_class ] = array(
+        self::$_ee_config_registry[$config_class] = array(
             'section' => $setup_args['config_section'],
             'name'    => $setup_args['config_name'],
         );
@@ -99,7 +99,7 @@ 
     {
         foreach (self::$_ee_config_registry as $config_class => $settings) {
             // first some validation of our incoming class_name.  We'll throw an error early if its' not registered correctly
-            if (! class_exists($config_class)) {
+            if ( ! class_exists($config_class)) {
                 throw new EE_Error(
                     sprintf(
                         __(
@@ -120,8 +120,8 @@ 
      */
     public static function deregister($config_class_name = null)
     {
-        if (! empty(self::$_ee_config_registry[ $config_class_name ])) {
-            unset(self::$_ee_config_registry[ $config_class_name ]);
+        if ( ! empty(self::$_ee_config_registry[$config_class_name])) {
+            unset(self::$_ee_config_registry[$config_class_name]);
         }
     }
 }

core/libraries/plugin_api/EE_Register_Capabilities.lib.php

Indentation +201 added lines, -201 removed lines

@@ -13,216 +13,216 @@
 class EE_Register_Capabilities implements EEI_Plugin_API
 {
 
-    /**
-     * Holds the settings for a specific registration.
-     *
-     * @var array
-     */
-    protected static $_registry = array();
+	/**
+	 * Holds the settings for a specific registration.
+	 *
+	 * @var array
+	 */
+	protected static $_registry = array();
 
 
-    /**
-     * Used to register capability items with EE core.
-     *
-     * @since 4.5.0
-     * @param string $cap_reference                                                       usually will be a class name
-     *                                                                                    that references capability
-     *                                                                                    related items setup for
-     *                                                                                    something.
-     * @param array  $setup_args                                                          {
-     *                                                                                    An array of items related to
-     *                                                                                    registering capabilities.
-     * @type array   $capabilities                                                        An array mapping capability
-     *                                                                                    strings to core WP Role.
-     *                                                                                    Something like: array(
-     *                                                                                    'administrator'    => array(
-     *                                                                                    'read_cap', 'edit_cap',
-     *                                                                                    'delete_cap'),
-     *                                                                                    'author'                =>
-     *                                                                                    array( 'read_cap' )
-     *                                                                                    ).
-     * @type array   $capability_maps                                                     EE_Meta_Capability_Map[]
-     * @see   EE_Capabilities.php for php docs on these objects.
-     *                                                                                    Should be indexed by the
-     *                                                                                    classname for the capability
-     *                                                                                    map and values representing
-     *                                                                                    the arguments for the map.
-     *                                                                                    }
-     * @throws EE_Error
-     * @return void
-     */
-    public static function register($cap_reference = null, $setup_args = array())
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if ($cap_reference === null || ! is_array($setup_args) || empty($setup_args['capabilities'])) {
-            throw new EE_Error(
-                __(
-                    'In order to register capabilities with EE_Register_Capabilities::register, you must include a unique name to reference the capabilities being registered, plus an array containing the following keys: "capabilities".',
-                    'event_espresso'
-                )
-            );
-        }
-        // make sure we don't register twice
-        if (isset(self::$_registry[ $cap_reference ])) {
-            return;
-        }
-        // make sure this is not registered too late or too early.
-        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(
-                    __(
-                        '%s has been registered too late.  Please ensure that EE_Register_Capabilities::register has been called at some point before the "AHEE__EE_System___detect_if_activation_or_upgrade__begin" action hook has been called.',
-                        'event_espresso'
-                    ),
-                    $cap_reference
-                ),
-                '4.5.0'
-            );
-        }
-        // some preliminary sanitization and setting to the $_registry property
-        self::$_registry[ $cap_reference ] = array(
-            'caps'     => isset($setup_args['capabilities']) && is_array($setup_args['capabilities'])
-                ? $setup_args['capabilities']
-                : array(),
-            'cap_maps' => isset($setup_args['capability_maps'])
-                ? $setup_args['capability_maps']
-                : array(),
-        );
-        // set initial caps (note that EE_Capabilities takes care of making sure that the caps get added only once)
-        add_filter(
-            'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
-            array('EE_Register_Capabilities', 'register_capabilities')
-        );
-        // add filter for cap maps
-        add_filter(
-            'FHEE__EE_Capabilities___set_meta_caps__meta_caps',
-            array('EE_Register_Capabilities', 'register_cap_maps')
-        );
-    }
+	/**
+	 * Used to register capability items with EE core.
+	 *
+	 * @since 4.5.0
+	 * @param string $cap_reference                                                       usually will be a class name
+	 *                                                                                    that references capability
+	 *                                                                                    related items setup for
+	 *                                                                                    something.
+	 * @param array  $setup_args                                                          {
+	 *                                                                                    An array of items related to
+	 *                                                                                    registering capabilities.
+	 * @type array   $capabilities                                                        An array mapping capability
+	 *                                                                                    strings to core WP Role.
+	 *                                                                                    Something like: array(
+	 *                                                                                    'administrator'    => array(
+	 *                                                                                    'read_cap', 'edit_cap',
+	 *                                                                                    'delete_cap'),
+	 *                                                                                    'author'                =>
+	 *                                                                                    array( 'read_cap' )
+	 *                                                                                    ).
+	 * @type array   $capability_maps                                                     EE_Meta_Capability_Map[]
+	 * @see   EE_Capabilities.php for php docs on these objects.
+	 *                                                                                    Should be indexed by the
+	 *                                                                                    classname for the capability
+	 *                                                                                    map and values representing
+	 *                                                                                    the arguments for the map.
+	 *                                                                                    }
+	 * @throws EE_Error
+	 * @return void
+	 */
+	public static function register($cap_reference = null, $setup_args = array())
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if ($cap_reference === null || ! is_array($setup_args) || empty($setup_args['capabilities'])) {
+			throw new EE_Error(
+				__(
+					'In order to register capabilities with EE_Register_Capabilities::register, you must include a unique name to reference the capabilities being registered, plus an array containing the following keys: "capabilities".',
+					'event_espresso'
+				)
+			);
+		}
+		// make sure we don't register twice
+		if (isset(self::$_registry[ $cap_reference ])) {
+			return;
+		}
+		// make sure this is not registered too late or too early.
+		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(
+					__(
+						'%s has been registered too late.  Please ensure that EE_Register_Capabilities::register has been called at some point before the "AHEE__EE_System___detect_if_activation_or_upgrade__begin" action hook has been called.',
+						'event_espresso'
+					),
+					$cap_reference
+				),
+				'4.5.0'
+			);
+		}
+		// some preliminary sanitization and setting to the $_registry property
+		self::$_registry[ $cap_reference ] = array(
+			'caps'     => isset($setup_args['capabilities']) && is_array($setup_args['capabilities'])
+				? $setup_args['capabilities']
+				: array(),
+			'cap_maps' => isset($setup_args['capability_maps'])
+				? $setup_args['capability_maps']
+				: array(),
+		);
+		// set initial caps (note that EE_Capabilities takes care of making sure that the caps get added only once)
+		add_filter(
+			'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
+			array('EE_Register_Capabilities', 'register_capabilities')
+		);
+		// add filter for cap maps
+		add_filter(
+			'FHEE__EE_Capabilities___set_meta_caps__meta_caps',
+			array('EE_Register_Capabilities', 'register_cap_maps')
+		);
+	}
 
 
-    /**
-     * callback for FHEE__EE_Capabilities__init_caps_map__caps filter.
-     * Takes care of registering additional capabilities to the caps map.   Note, that this also on the initial
-     * registration ensures that new capabilities are added to existing roles.
-     *
-     * @param array $incoming_caps The original caps map.
-     * @return array merged in new caps.
-     */
-    public static function register_capabilities($incoming_caps)
-    {
-        foreach (self::$_registry as $cap_reference => $caps_and_cap_map) {
-            $incoming_caps = array_merge_recursive($incoming_caps, $caps_and_cap_map['caps']);
-        }
-        return $incoming_caps;
-    }
+	/**
+	 * callback for FHEE__EE_Capabilities__init_caps_map__caps filter.
+	 * Takes care of registering additional capabilities to the caps map.   Note, that this also on the initial
+	 * registration ensures that new capabilities are added to existing roles.
+	 *
+	 * @param array $incoming_caps The original caps map.
+	 * @return array merged in new caps.
+	 */
+	public static function register_capabilities($incoming_caps)
+	{
+		foreach (self::$_registry as $cap_reference => $caps_and_cap_map) {
+			$incoming_caps = array_merge_recursive($incoming_caps, $caps_and_cap_map['caps']);
+		}
+		return $incoming_caps;
+	}
 
 
-    /**
-     * Callback for the 'FHEE__EE_Capabilities___set_meta_caps__meta_caps' filter which registers an array of
-     * capability maps for the WP meta_caps filter called in EE_Capabilities.
-     *
-     * @since 4.5.0
-     * @param EE_Meta_Capability_Map[] $cap_maps The existing cap maps array.
-     * @return EE_Meta_Capability_Map[]
-     * @throws EE_Error
-     */
-    public static function register_cap_maps($cap_maps)
-    {
-        // loop through and instantiate cap maps.
-        foreach (self::$_registry as $cap_reference => $setup) {
-            if (! isset($setup['cap_maps'])) {
-                continue;
-            }
-            foreach ($setup['cap_maps'] as $cap_class => $args) {
+	/**
+	 * Callback for the 'FHEE__EE_Capabilities___set_meta_caps__meta_caps' filter which registers an array of
+	 * capability maps for the WP meta_caps filter called in EE_Capabilities.
+	 *
+	 * @since 4.5.0
+	 * @param EE_Meta_Capability_Map[] $cap_maps The existing cap maps array.
+	 * @return EE_Meta_Capability_Map[]
+	 * @throws EE_Error
+	 */
+	public static function register_cap_maps($cap_maps)
+	{
+		// loop through and instantiate cap maps.
+		foreach (self::$_registry as $cap_reference => $setup) {
+			if (! isset($setup['cap_maps'])) {
+				continue;
+			}
+			foreach ($setup['cap_maps'] as $cap_class => $args) {
 
-                /**
-                 * account for cases where capability maps may be indexed
-                 * numerically to allow for the same map class to be utilized
-                 * In those cases, maps will be setup in an array like:
-                 * array(
-                 *    0 => array( 'EE_Meta_Capability' => array(
-                 *        'ee_edit_cap', array( 'Object_Name',
-                 *        'ee_edit_published_cap',
-                 *        'ee_edit_others_cap', 'ee_edit_private_cap' )
-                 *        ) )
-                 *    1 => ...
-                 * )
-                 * instead of:
-                 * array(
-                 *    'EE_Meta_Capability' => array(
-                 *        'ee_edit_cap', array( 'Object_Name',
-                 *        'ee_edit_published_cap',
-                 *        'ee_edit_others_cap', 'ee_edit_private_cap' )
-                 *        ),
-                 *    ...
-                 * )
-                 */
-                if (is_numeric($cap_class)) {
-                    $cap_class = key($args);
-                    $args = $args[ $cap_class ];
-                }
+				/**
+				 * account for cases where capability maps may be indexed
+				 * numerically to allow for the same map class to be utilized
+				 * In those cases, maps will be setup in an array like:
+				 * array(
+				 *    0 => array( 'EE_Meta_Capability' => array(
+				 *        'ee_edit_cap', array( 'Object_Name',
+				 *        'ee_edit_published_cap',
+				 *        'ee_edit_others_cap', 'ee_edit_private_cap' )
+				 *        ) )
+				 *    1 => ...
+				 * )
+				 * instead of:
+				 * array(
+				 *    'EE_Meta_Capability' => array(
+				 *        'ee_edit_cap', array( 'Object_Name',
+				 *        'ee_edit_published_cap',
+				 *        'ee_edit_others_cap', 'ee_edit_private_cap' )
+				 *        ),
+				 *    ...
+				 * )
+				 */
+				if (is_numeric($cap_class)) {
+					$cap_class = key($args);
+					$args = $args[ $cap_class ];
+				}
 
-                if (! class_exists($cap_class)) {
-                    throw new EE_Error(
-                        sprintf(
-                            __(
-                                'An addon (%s) has tried to register a capability map improperly.  Capability map arrays must be indexed by capability map classname, and an array for the class arguments',
-                                'event_espresso'
-                            ),
-                            $cap_reference
-                        )
-                    );
-                }
+				if (! class_exists($cap_class)) {
+					throw new EE_Error(
+						sprintf(
+							__(
+								'An addon (%s) has tried to register a capability map improperly.  Capability map arrays must be indexed by capability map classname, and an array for the class arguments',
+								'event_espresso'
+							),
+							$cap_reference
+						)
+					);
+				}
 
-                if (count($args) !== 2) {
-                    throw new EE_Error(
-                        sprintf(
-                            __(
-                                'An addon (%s) has tried to register a capability map improperly.  Capability map arrays must be indexed by capability map classname, and an array for the class arguments.  The array should have two values the first being a string and the second an array.',
-                                'event_espresso'
-                            ),
-                            $cap_reference
-                        )
-                    );
-                }
-                $cap_maps[] = new $cap_class($args[0], $args[1]);
-            }
-        }
-        return $cap_maps;
-    }
+				if (count($args) !== 2) {
+					throw new EE_Error(
+						sprintf(
+							__(
+								'An addon (%s) has tried to register a capability map improperly.  Capability map arrays must be indexed by capability map classname, and an array for the class arguments.  The array should have two values the first being a string and the second an array.',
+								'event_espresso'
+							),
+							$cap_reference
+						)
+					);
+				}
+				$cap_maps[] = new $cap_class($args[0], $args[1]);
+			}
+		}
+		return $cap_maps;
+	}
 
 
-    /**
-     * @param string $cap_reference
-     * @throws EE_Error
-     * @throws \InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public static function deregister($cap_reference = '')
-    {
-        if (! empty(self::$_registry[ $cap_reference ])) {
-            if (! empty(self::$_registry[ $cap_reference ]['caps'])) {
-                // if it's too early to remove capabilities, wait to do this until core is loaded and ready
-                $caps_to_remove = self::$_registry[ $cap_reference ]['caps'];
-                if (did_action('AHEE__EE_System__core_loaded_and_ready')) {
-                    $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
-                    $capabilities->removeCaps($caps_to_remove);
-                } else {
-                    add_action(
-                        'AHEE__EE_System__core_loaded_and_ready',
-                        function () use ($caps_to_remove) {
-                            $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
-                            $capabilities->removeCaps($caps_to_remove);
-                        }
-                    );
-                }
-            }
-            unset(self::$_registry[ $cap_reference ]);
-        }
-    }
+	/**
+	 * @param string $cap_reference
+	 * @throws EE_Error
+	 * @throws \InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public static function deregister($cap_reference = '')
+	{
+		if (! empty(self::$_registry[ $cap_reference ])) {
+			if (! empty(self::$_registry[ $cap_reference ]['caps'])) {
+				// if it's too early to remove capabilities, wait to do this until core is loaded and ready
+				$caps_to_remove = self::$_registry[ $cap_reference ]['caps'];
+				if (did_action('AHEE__EE_System__core_loaded_and_ready')) {
+					$capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
+					$capabilities->removeCaps($caps_to_remove);
+				} else {
+					add_action(
+						'AHEE__EE_System__core_loaded_and_ready',
+						function () use ($caps_to_remove) {
+							$capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
+							$capabilities->removeCaps($caps_to_remove);
+						}
+					);
+				}
+			}
+			unset(self::$_registry[ $cap_reference ]);
+		}
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -63,11 +63,11 @@ 
             );
         }
         // make sure we don't register twice
-        if (isset(self::$_registry[ $cap_reference ])) {
+        if (isset(self::$_registry[$cap_reference])) {
             return;
         }
         // make sure this is not registered too late or too early.
-        if (! did_action('AHEE__EE_System__load_espresso_addons')
+        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(
@@ -83,7 +83,7 @@ 
             );
         }
         // some preliminary sanitization and setting to the $_registry property
-        self::$_registry[ $cap_reference ] = array(
+        self::$_registry[$cap_reference] = array(
             'caps'     => isset($setup_args['capabilities']) && is_array($setup_args['capabilities'])
                 ? $setup_args['capabilities']
                 : array(),
@@ -134,7 +134,7 @@ 
     {
         // loop through and instantiate cap maps.
         foreach (self::$_registry as $cap_reference => $setup) {
-            if (! isset($setup['cap_maps'])) {
+            if ( ! isset($setup['cap_maps'])) {
                 continue;
             }
             foreach ($setup['cap_maps'] as $cap_class => $args) {
@@ -163,10 +163,10 @@ 
                  */
                 if (is_numeric($cap_class)) {
                     $cap_class = key($args);
-                    $args = $args[ $cap_class ];
+                    $args = $args[$cap_class];
                 }
 
-                if (! class_exists($cap_class)) {
+                if ( ! class_exists($cap_class)) {
                     throw new EE_Error(
                         sprintf(
                             __(
@@ -205,24 +205,24 @@ 
      */
     public static function deregister($cap_reference = '')
     {
-        if (! empty(self::$_registry[ $cap_reference ])) {
-            if (! empty(self::$_registry[ $cap_reference ]['caps'])) {
+        if ( ! empty(self::$_registry[$cap_reference])) {
+            if ( ! empty(self::$_registry[$cap_reference]['caps'])) {
                 // if it's too early to remove capabilities, wait to do this until core is loaded and ready
-                $caps_to_remove = self::$_registry[ $cap_reference ]['caps'];
+                $caps_to_remove = self::$_registry[$cap_reference]['caps'];
                 if (did_action('AHEE__EE_System__core_loaded_and_ready')) {
                     $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
                     $capabilities->removeCaps($caps_to_remove);
                 } else {
                     add_action(
                         'AHEE__EE_System__core_loaded_and_ready',
-                        function () use ($caps_to_remove) {
+                        function() use ($caps_to_remove) {
                             $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
                             $capabilities->removeCaps($caps_to_remove);
                         }
                     );
                 }
             }
-            unset(self::$_registry[ $cap_reference ]);
+            unset(self::$_registry[$cap_reference]);
         }
     }
 }

core/libraries/plugin_api/EE_Register_Data_Migration_Scripts.lib.php

Indentation +87 added lines, -87 removed lines

@@ -15,97 +15,97 @@
 class EE_Register_Data_Migration_Scripts implements EEI_Plugin_API
 {
 
-    /**
-     * Holds values for registered DMSs
-     *
-     * @var array[][]
-     */
-    protected static $_settings = array();
+	/**
+	 * Holds values for registered DMSs
+	 *
+	 * @var array[][]
+	 */
+	protected static $_settings = array();
 
 
-    /**
-     * Method for registering new Data Migration Scripts
-     *
-     * @since 4.3.0
-     * @param string $addon_name EE_Addon class name that this set of data migration scripts belongs to
-     *                           If EE_Addon class is namespaced, then this needs to be the Fully Qualified Class Name
-     * @param array  $setup_args {
-     * @type string  $dms_paths  an array of full server paths to folders that contain data migration scripts
-     *                           }
-     * @throws EE_Error
-     * @return void
-     */
-    public static function register($addon_name = '', $setup_args = array())
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['dms_paths'])) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register Data Migration Scripts with EE_Register_Data_Migration_Scripts::register(), you must include the EE_Addon class name (used as a unique identifier for this set of data migration scripts), and an array containing the following keys: "dms_paths" (an array of full server paths to folders that contain data migration scripts)',
-                    'event_espresso'
-                )
-            );
-        }
-        // make sure we don't register twice
-        if (isset(self::$_settings[ $addon_name ])) {
-            return;
-        }
-        // 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__,
-                esc_html__(
-                    'An attempt to register Data Migration Scripts has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register Data Migration Scripts.',
-                    'event_espresso'
-                ),
-                '4.3.0'
-            );
-        }
-        // setup $_settings array from incoming values.
-        self::$_settings[ $addon_name ] = array(
-            'dms_paths' => (array) $setup_args['dms_paths'],
-        );
-        // setup DMS
-        add_filter(
-            'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders',
-            array('EE_Register_Data_Migration_Scripts', 'add_data_migration_script_folders')
-        );
-    }
+	/**
+	 * Method for registering new Data Migration Scripts
+	 *
+	 * @since 4.3.0
+	 * @param string $addon_name EE_Addon class name that this set of data migration scripts belongs to
+	 *                           If EE_Addon class is namespaced, then this needs to be the Fully Qualified Class Name
+	 * @param array  $setup_args {
+	 * @type string  $dms_paths  an array of full server paths to folders that contain data migration scripts
+	 *                           }
+	 * @throws EE_Error
+	 * @return void
+	 */
+	public static function register($addon_name = '', $setup_args = array())
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['dms_paths'])) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register Data Migration Scripts with EE_Register_Data_Migration_Scripts::register(), you must include the EE_Addon class name (used as a unique identifier for this set of data migration scripts), and an array containing the following keys: "dms_paths" (an array of full server paths to folders that contain data migration scripts)',
+					'event_espresso'
+				)
+			);
+		}
+		// make sure we don't register twice
+		if (isset(self::$_settings[ $addon_name ])) {
+			return;
+		}
+		// 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__,
+				esc_html__(
+					'An attempt to register Data Migration Scripts has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register Data Migration Scripts.',
+					'event_espresso'
+				),
+				'4.3.0'
+			);
+		}
+		// setup $_settings array from incoming values.
+		self::$_settings[ $addon_name ] = array(
+			'dms_paths' => (array) $setup_args['dms_paths'],
+		);
+		// setup DMS
+		add_filter(
+			'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders',
+			array('EE_Register_Data_Migration_Scripts', 'add_data_migration_script_folders')
+		);
+	}
 
 
-    /**
-     * @param array $dms_paths
-     * @return array
-     */
-    public static function add_data_migration_script_folders($dms_paths = array())
-    {
-        foreach (self::$_settings as $addon_name => $settings) {
-            $wildcards = 0;
-            foreach ($settings['dms_paths'] as $dms_path) {
-                // since we are using the addon name for the array key
-                // we need to ensure that the key is unique,
-                // so if for some reason an addon has multiple dms paths,
-                // we append one or more * to the classname
-                // which will get stripped out later on
-                $dms_paths[ $addon_name . str_repeat('*', $wildcards) ] = $dms_path;
-                $wildcards++;
-            }
-        }
-        return $dms_paths;
-    }
+	/**
+	 * @param array $dms_paths
+	 * @return array
+	 */
+	public static function add_data_migration_script_folders($dms_paths = array())
+	{
+		foreach (self::$_settings as $addon_name => $settings) {
+			$wildcards = 0;
+			foreach ($settings['dms_paths'] as $dms_path) {
+				// since we are using the addon name for the array key
+				// we need to ensure that the key is unique,
+				// so if for some reason an addon has multiple dms paths,
+				// we append one or more * to the classname
+				// which will get stripped out later on
+				$dms_paths[ $addon_name . str_repeat('*', $wildcards) ] = $dms_path;
+				$wildcards++;
+			}
+		}
+		return $dms_paths;
+	}
 
 
-    /**
-     * This deregisters a set of Data Migration Scripts that were previously registered with a specific dms_id
-     *
-     * @since 4.3.0
-     * @param string $addon_name EE_Addon class name that this set of data migration scripts belongs to
-     * @return void
-     */
-    public static function deregister($addon_name = '')
-    {
-        unset(self::$_settings[ $addon_name ]);
-    }
+	/**
+	 * This deregisters a set of Data Migration Scripts that were previously registered with a specific dms_id
+	 *
+	 * @since 4.3.0
+	 * @param string $addon_name EE_Addon class name that this set of data migration scripts belongs to
+	 * @return void
+	 */
+	public static function deregister($addon_name = '')
+	{
+		unset(self::$_settings[ $addon_name ]);
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -47,11 +47,11 @@ 
             );
         }
         // make sure we don't register twice
-        if (isset(self::$_settings[ $addon_name ])) {
+        if (isset(self::$_settings[$addon_name])) {
             return;
         }
         // make sure this was called in the right place!
-        if (! did_action('AHEE__EE_System__load_espresso_addons')
+        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(
@@ -64,7 +64,7 @@ 
             );
         }
         // setup $_settings array from incoming values.
-        self::$_settings[ $addon_name ] = array(
+        self::$_settings[$addon_name] = array(
             'dms_paths' => (array) $setup_args['dms_paths'],
         );
         // setup DMS
@@ -89,7 +89,7 @@ 
                 // so if for some reason an addon has multiple dms paths,
                 // we append one or more * to the classname
                 // which will get stripped out later on
-                $dms_paths[ $addon_name . str_repeat('*', $wildcards) ] = $dms_path;
+                $dms_paths[$addon_name.str_repeat('*', $wildcards)] = $dms_path;
                 $wildcards++;
             }
         }
@@ -106,6 +106,6 @@ 
      */
     public static function deregister($addon_name = '')
     {
-        unset(self::$_settings[ $addon_name ]);
+        unset(self::$_settings[$addon_name]);
     }
 }

core/libraries/plugin_api/EE_Register_Payment_Method.lib.php

Indentation +154 added lines, -154 removed lines

@@ -19,166 +19,166 @@
 class EE_Register_Payment_Method implements EEI_Plugin_API
 {
 
-    /**
-     * Holds values for registered payment methods
-     *
-     * @var array
-     */
-    protected static $_settings = array();
+	/**
+	 * Holds values for registered payment methods
+	 *
+	 * @var array
+	 */
+	protected static $_settings = array();
 
 
-    /**
-     * Method for registering new EE_PMT_Base children
-     *
-     * @since    4.5.0
-     * @param string  $payment_method_id    a unique identifier for this set of modules Required.
-     * @param  array  $setup_args           an array of arguments provided for registering modules Required.{
-     * @type string[] $payment_method_paths each element is the folder containing the EE_PMT_Base child class
-     *                                      (eg, 'public_html/wp-content/plugins/my_plugin/Payomatic/' which contains
-     *                                      the files EE_PMT_Payomatic.pm.php)
-     *                                      }
-     * @throws EE_Error
-     * @type array payment_method_paths    an array of full server paths to folders containing any EE_PMT_Base
-     *                                      children, or to the EED_Module files themselves
-     * @return void
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function register($payment_method_id = null, $setup_args = array())
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($payment_method_id) || ! is_array($setup_args) || empty($setup_args['payment_method_paths'])) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register Payment Methods with EE_Register_Payment_Method::register(), you must include a "payment_method_id" (a unique identifier for this set of modules), and an array containing the following keys: "payment_method_paths" (an array of full server paths to folders that contain modules, or to the module files themselves)',
-                    'event_espresso'
-                )
-            );
-        }
-        // make sure we don't register twice
-        if (isset(self::$_settings[ $payment_method_id ])) {
-            return;
-        }
-        // make sure this was called in the right place!
-        if (! did_action('AHEE__EE_System__load_espresso_addons')
-            || did_action('AHEE__EE_System__register_shortcodes_modules_and_widgets')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                esc_html__(
-                    'An attempt to register modules has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__register_shortcodes_modules_and_widgets" hook to register modules.',
-                    'event_espresso'
-                ),
-                '4.3.0'
-            );
-        }
-        // setup $_settings array from incoming values.
-        self::$_settings[ $payment_method_id ] = array(
-            // array of full server paths to any EE_PMT_Base children used
-            'payment_method_paths' => isset($setup_args['payment_method_paths'])
-                ? (array) $setup_args['payment_method_paths']
-                : array(),
-        );
-        // add to list of modules to be registered
-        add_filter(
-            'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
-            array('EE_Register_Payment_Method', 'add_payment_methods')
-        );
-        // If EE_Payment_Method_Manager::register_payment_methods has already been called,
-        // then we need to add our caps for this payment method manually
-        if (did_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods')) {
-            $payment_method_manager = LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
-            // register payment methods directly
-            foreach (self::$_settings[ $payment_method_id ]['payment_method_paths'] as $payment_method_path) {
-                $payment_method_manager->register_payment_method($payment_method_path);
-            }
-            $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
-            $capabilities->addCaps(
-                self::getPaymentMethodCapabilities(self::$_settings[ $payment_method_id ])
-            );
-        }
-    }
+	/**
+	 * Method for registering new EE_PMT_Base children
+	 *
+	 * @since    4.5.0
+	 * @param string  $payment_method_id    a unique identifier for this set of modules Required.
+	 * @param  array  $setup_args           an array of arguments provided for registering modules Required.{
+	 * @type string[] $payment_method_paths each element is the folder containing the EE_PMT_Base child class
+	 *                                      (eg, 'public_html/wp-content/plugins/my_plugin/Payomatic/' which contains
+	 *                                      the files EE_PMT_Payomatic.pm.php)
+	 *                                      }
+	 * @throws EE_Error
+	 * @type array payment_method_paths    an array of full server paths to folders containing any EE_PMT_Base
+	 *                                      children, or to the EED_Module files themselves
+	 * @return void
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function register($payment_method_id = null, $setup_args = array())
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($payment_method_id) || ! is_array($setup_args) || empty($setup_args['payment_method_paths'])) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register Payment Methods with EE_Register_Payment_Method::register(), you must include a "payment_method_id" (a unique identifier for this set of modules), and an array containing the following keys: "payment_method_paths" (an array of full server paths to folders that contain modules, or to the module files themselves)',
+					'event_espresso'
+				)
+			);
+		}
+		// make sure we don't register twice
+		if (isset(self::$_settings[ $payment_method_id ])) {
+			return;
+		}
+		// make sure this was called in the right place!
+		if (! did_action('AHEE__EE_System__load_espresso_addons')
+			|| did_action('AHEE__EE_System__register_shortcodes_modules_and_widgets')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				esc_html__(
+					'An attempt to register modules has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__register_shortcodes_modules_and_widgets" hook to register modules.',
+					'event_espresso'
+				),
+				'4.3.0'
+			);
+		}
+		// setup $_settings array from incoming values.
+		self::$_settings[ $payment_method_id ] = array(
+			// array of full server paths to any EE_PMT_Base children used
+			'payment_method_paths' => isset($setup_args['payment_method_paths'])
+				? (array) $setup_args['payment_method_paths']
+				: array(),
+		);
+		// add to list of modules to be registered
+		add_filter(
+			'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
+			array('EE_Register_Payment_Method', 'add_payment_methods')
+		);
+		// If EE_Payment_Method_Manager::register_payment_methods has already been called,
+		// then we need to add our caps for this payment method manually
+		if (did_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods')) {
+			$payment_method_manager = LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
+			// register payment methods directly
+			foreach (self::$_settings[ $payment_method_id ]['payment_method_paths'] as $payment_method_path) {
+				$payment_method_manager->register_payment_method($payment_method_path);
+			}
+			$capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
+			$capabilities->addCaps(
+				self::getPaymentMethodCapabilities(self::$_settings[ $payment_method_id ])
+			);
+		}
+	}
 
 
-    /**
-     * Filters the list of payment methods to add ours.
-     * and they're just full filepaths to FOLDERS containing a payment method class file. Eg.
-     *
-     * @param array $payment_method_folders array of paths to all payment methods that require registering
-     * @return array
-     */
-    public static function add_payment_methods($payment_method_folders)
-    {
-        foreach (self::$_settings as $settings) {
-            foreach ($settings['payment_method_paths'] as $payment_method_path) {
-                $payment_method_folders[] = $payment_method_path;
-            }
-        }
-        return $payment_method_folders;
-    }
+	/**
+	 * Filters the list of payment methods to add ours.
+	 * and they're just full filepaths to FOLDERS containing a payment method class file. Eg.
+	 *
+	 * @param array $payment_method_folders array of paths to all payment methods that require registering
+	 * @return array
+	 */
+	public static function add_payment_methods($payment_method_folders)
+	{
+		foreach (self::$_settings as $settings) {
+			foreach ($settings['payment_method_paths'] as $payment_method_path) {
+				$payment_method_folders[] = $payment_method_path;
+			}
+		}
+		return $payment_method_folders;
+	}
 
 
-    /**
-     * This deregisters a module that was previously registered with a specific $module_id.
-     *
-     * @since    4.3.0
-     *
-     * @param string $module_id the name for the module that was previously registered
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function deregister($module_id = null)
-    {
-        if (isset(self::$_settings[ $module_id ])) {
-            // set action for just this module id to delay deregistration until core is loaded and ready.
-            $module_settings = self::$_settings[ $module_id ];
-            unset(self::$_settings[ $module_id ]);
-            add_action(
-                'AHEE__EE_System__core_loaded_and_ready',
-                function () use ($module_settings) {
-                    $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
-                    $capabilities->removeCaps(
-                        EE_Register_Payment_Method::getPaymentMethodCapabilities($module_settings)
-                    );
-                }
-            );
-        }
-    }
+	/**
+	 * This deregisters a module that was previously registered with a specific $module_id.
+	 *
+	 * @since    4.3.0
+	 *
+	 * @param string $module_id the name for the module that was previously registered
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function deregister($module_id = null)
+	{
+		if (isset(self::$_settings[ $module_id ])) {
+			// set action for just this module id to delay deregistration until core is loaded and ready.
+			$module_settings = self::$_settings[ $module_id ];
+			unset(self::$_settings[ $module_id ]);
+			add_action(
+				'AHEE__EE_System__core_loaded_and_ready',
+				function () use ($module_settings) {
+					$capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
+					$capabilities->removeCaps(
+						EE_Register_Payment_Method::getPaymentMethodCapabilities($module_settings)
+					);
+				}
+			);
+		}
+	}
 
 
-    /**
-     * returns an array of the caps that get added when a Payment Method is registered
-     *
-     * @param array $settings
-     * @return array
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @access private  Developers do NOT use this method.  It's only public for PHP5.3 closure support (see deregister)
-     *                  When we drop support for PHP5.3 this will be made private again.  You have been warned.
-     *
-     */
-    public static function getPaymentMethodCapabilities(array $settings)
-    {
-        $payment_method_manager = LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
-        $payment_method_caps = array('administrator' => array());
-        if (isset($settings['payment_method_paths'])) {
-            foreach ($settings['payment_method_paths'] as $payment_method_path) {
-                $payment_method_caps = $payment_method_manager->addPaymentMethodCap(
-                    strtolower(basename($payment_method_path)),
-                    $payment_method_caps
-                );
-            }
-        }
-        return $payment_method_caps;
-    }
+	/**
+	 * returns an array of the caps that get added when a Payment Method is registered
+	 *
+	 * @param array $settings
+	 * @return array
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @access private  Developers do NOT use this method.  It's only public for PHP5.3 closure support (see deregister)
+	 *                  When we drop support for PHP5.3 this will be made private again.  You have been warned.
+	 *
+	 */
+	public static function getPaymentMethodCapabilities(array $settings)
+	{
+		$payment_method_manager = LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
+		$payment_method_caps = array('administrator' => array());
+		if (isset($settings['payment_method_paths'])) {
+			foreach ($settings['payment_method_paths'] as $payment_method_path) {
+				$payment_method_caps = $payment_method_manager->addPaymentMethodCap(
+					strtolower(basename($payment_method_path)),
+					$payment_method_caps
+				);
+			}
+		}
+		return $payment_method_caps;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -59,11 +59,11 @@ 
             );
         }
         // make sure we don't register twice
-        if (isset(self::$_settings[ $payment_method_id ])) {
+        if (isset(self::$_settings[$payment_method_id])) {
             return;
         }
         // make sure this was called in the right place!
-        if (! did_action('AHEE__EE_System__load_espresso_addons')
+        if ( ! did_action('AHEE__EE_System__load_espresso_addons')
             || did_action('AHEE__EE_System__register_shortcodes_modules_and_widgets')
         ) {
             EE_Error::doing_it_wrong(
@@ -76,7 +76,7 @@ 
             );
         }
         // setup $_settings array from incoming values.
-        self::$_settings[ $payment_method_id ] = array(
+        self::$_settings[$payment_method_id] = array(
             // array of full server paths to any EE_PMT_Base children used
             'payment_method_paths' => isset($setup_args['payment_method_paths'])
                 ? (array) $setup_args['payment_method_paths']
@@ -92,12 +92,12 @@ 
         if (did_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods')) {
             $payment_method_manager = LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
             // register payment methods directly
-            foreach (self::$_settings[ $payment_method_id ]['payment_method_paths'] as $payment_method_path) {
+            foreach (self::$_settings[$payment_method_id]['payment_method_paths'] as $payment_method_path) {
                 $payment_method_manager->register_payment_method($payment_method_path);
             }
             $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
             $capabilities->addCaps(
-                self::getPaymentMethodCapabilities(self::$_settings[ $payment_method_id ])
+                self::getPaymentMethodCapabilities(self::$_settings[$payment_method_id])
             );
         }
     }
@@ -136,13 +136,13 @@ 
      */
     public static function deregister($module_id = null)
     {
-        if (isset(self::$_settings[ $module_id ])) {
+        if (isset(self::$_settings[$module_id])) {
             // set action for just this module id to delay deregistration until core is loaded and ready.
-            $module_settings = self::$_settings[ $module_id ];
-            unset(self::$_settings[ $module_id ]);
+            $module_settings = self::$_settings[$module_id];
+            unset(self::$_settings[$module_id]);
             add_action(
                 'AHEE__EE_System__core_loaded_and_ready',
-                function () use ($module_settings) {
+                function() use ($module_settings) {
                     $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
                     $capabilities->removeCaps(
                         EE_Register_Payment_Method::getPaymentMethodCapabilities($module_settings)

core/libraries/plugin_api/EE_Register_Messages_Template_Pack.lib.php

Indentation +200 added lines, -200 removed lines

@@ -12,204 +12,204 @@
 {
 
 
-    /**
-     * Holds values for registered template pack
-     *
-     * @since 4.5.0
-     *
-     * @var array
-     */
-    protected static $_registry = array();
-
-
-    /**
-     * Used to register a new template pack with the messages system.
-     *
-     * Template packs are primarily defined via class extending EE_Messages_Template_Pack and are typically used to
-     * change entire layouts for a set of message templates.  This method is used to register the new template pack and
-     * automatically have it loaded in the appropriate places.
-     *
-     * This registry also verifies that there isn't already a template pack registered with the same name and if there
-     * is then it will add an EE_Error notice.
-     *
-     * Note that this only handles registering the your Template Pack class with the message template pack system.
-     * However, there is also a naming schema you must follow for templates you are providing with your template pack.
-     *
-     * @see    EE_Messages_Template_Pack_Default for an example class
-     * @see    core/libraries/messages/defaults/default/* for all the example templates the default template pack
-     *         supports.
-     *
-     *
-     * @since  4.5.0
-     * @throws EE_Error
-     *
-     * @param string $ref        The internal reference used to refer to this template pack.  Note, this is first come,
-     *                           first serve.  If there is already a template pack registered with this name then the
-     *                           registry will assign a unique reference for it so it can still be activated (but this
-     *                           makes it harder to deregister as it will be unique per load - so its best to try to
-     *                           make this a unique string!)
-     * @param array  $setup_args array {
-     *                           An array of required values for registering the template pack.
-     * @type string  $path       The path for the new template pack class.
-     * @type string  $classname  The name of the new Template Pack Class.
-     *                           }
-     *
-     * @return void
-     */
-    public static function register($ref = null, $setup_args = array())
-    {
-
-        // check for required params
-        if (empty($ref) || empty($setup_args['path']) || empty($setup_args['classname'])) {
-            throw new EE_Error(
-                __(
-                    'In order to register a new template pack for the EE Messages system, you must include a value to reference the template pack being registered and the setup_args must have the path for the new template pack class as well as the classname for the new Template Pack Class. ',
-                    'event_espresso'
-                )
-            );
-        }
-
-        // make sure we don't register twice
-        if (isset(self::$_registry[ $ref ])) {
-            return;
-        }
-
-        // check that incoming $ref doesn't already exist. If it does then we'll create a unique reference for this template pack.
-        if (isset(self::$_registry[ $ref ])) {
-            $ref = uniqid() . '_' . $ref;
-        }
-
-
-        // make sure this was called in the right place!
-        if (! did_action('EE_Brewing_Regular___messages_caf')
-            || did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    __(
-                        'A EE Messages Template Pack given the reference "%s" has been attempted to be registered with the EE Messages System.  It may or may not work because it should be only called on the "EE_Brewing_Regular__messages_caf" hook.',
-                        'event_espresso'
-                    ),
-                    $ref
-                ),
-                '4.5.0'
-            );
-        }
-
-        if (self::_verify_class_not_exist($setup_args['classname'])) {
-            self::$_registry[ $ref ] = array(
-                'path'      => (string) $setup_args['path'],
-                'classname' => (string) $setup_args['classname'],
-            );
-        }
-
-        // hook into the system
-        add_filter(
-            'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
-            array('EE_Register_Messages_Template_Pack', 'set_template_pack_path'),
-            10
-        );
-        add_filter(
-            'FHEE__EED_Messages__get_template_packs__template_packs',
-            array('EE_Register_Messages_Template_Pack', 'set_template_pack'),
-            10
-        );
-    }
-
-
-    /**
-     * Callback for the FHEE__EED_Messages___set_messages_paths___MSG_PATHS filter.  This adds this template packs path
-     * to the messages autoloader paths.
-     *
-     * @since  4.5.0
-     *
-     * @param array $paths Array of paths already registered with the messages autoloader
-     *
-     * @return array
-     */
-    public static function set_template_pack_path($paths)
-    {
-        foreach (self::$_registry as $ref => $args) {
-            $paths[] = $args['path'];
-        }
-        return $paths;
-    }
-
-
-    /**
-     * Callback for the FHEE__EED_Messages__get_template_packs__template_packs filter. This adds the instantiated,
-     * registered template pack to the template packs array when requested by client code.
-     *
-     * @since 4.5.0
-     *
-     * @param EE_Messages_Template_Pack[] $template_packs
-     * @return EE_Messages_Template_Pack[]
-     */
-    public static function set_template_pack($template_packs)
-    {
-        foreach (self::$_registry as $ref => $args) {
-            // verify class_exists
-            if (! class_exists($args['classname'])) {
-                require_once($args['path'] . '/' . $args['classname'] . '.class.php');
-            }
-
-            // check again!
-            if (class_exists($args['classname'])) {
-                $template_pack = new $args['classname'];
-                $template_packs[ $template_pack->dbref ] = $template_pack;
-            }
-        }
-
-        return $template_packs;
-    }
-
-
-    /**
-     * This verifies that the classes for each registered template pack are unique  names.
-     *
-     * @param string $classname The classname being checked
-     *
-     * @return bool
-     */
-    private static function _verify_class_not_exist($classname)
-    {
-
-        // loop through the existing registry and see if the classname is already present.
-        foreach (self::$_registry as $ref => $args) {
-            if ($args['classname'] == $classname) {
-                EE_Error::add_error(
-                    sprintf(
-                        __(
-                            'The %s template pack that you just activated cannot be registered with the messages system because there is already a template pack active using the same classname.  Contact the author of this template pack to let them know of the conflict.  To stop seeing this message you will need to deactivate this template pack.',
-                            'event_espresso'
-                        ),
-                        (string) $setup_args['classname']
-                    ),
-                    __FILE__,
-                    __LINE__,
-                    __FUNCTION__
-                );
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * This deregisters a variation set that was previously registered with the given slug.
-     *
-     * @since 4.5.0
-     *
-     * @param string $variation_ref The name for the variation set that was previously registered.
-     *
-     * @return void
-     */
-    public static function deregister($variation_ref = null)
-    {
-        if (! empty(self::$_registry[ $variation_ref ])) {
-            unset(self::$_registry[ $variation_ref ]);
-        }
-    }
+	/**
+	 * Holds values for registered template pack
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var array
+	 */
+	protected static $_registry = array();
+
+
+	/**
+	 * Used to register a new template pack with the messages system.
+	 *
+	 * Template packs are primarily defined via class extending EE_Messages_Template_Pack and are typically used to
+	 * change entire layouts for a set of message templates.  This method is used to register the new template pack and
+	 * automatically have it loaded in the appropriate places.
+	 *
+	 * This registry also verifies that there isn't already a template pack registered with the same name and if there
+	 * is then it will add an EE_Error notice.
+	 *
+	 * Note that this only handles registering the your Template Pack class with the message template pack system.
+	 * However, there is also a naming schema you must follow for templates you are providing with your template pack.
+	 *
+	 * @see    EE_Messages_Template_Pack_Default for an example class
+	 * @see    core/libraries/messages/defaults/default/* for all the example templates the default template pack
+	 *         supports.
+	 *
+	 *
+	 * @since  4.5.0
+	 * @throws EE_Error
+	 *
+	 * @param string $ref        The internal reference used to refer to this template pack.  Note, this is first come,
+	 *                           first serve.  If there is already a template pack registered with this name then the
+	 *                           registry will assign a unique reference for it so it can still be activated (but this
+	 *                           makes it harder to deregister as it will be unique per load - so its best to try to
+	 *                           make this a unique string!)
+	 * @param array  $setup_args array {
+	 *                           An array of required values for registering the template pack.
+	 * @type string  $path       The path for the new template pack class.
+	 * @type string  $classname  The name of the new Template Pack Class.
+	 *                           }
+	 *
+	 * @return void
+	 */
+	public static function register($ref = null, $setup_args = array())
+	{
+
+		// check for required params
+		if (empty($ref) || empty($setup_args['path']) || empty($setup_args['classname'])) {
+			throw new EE_Error(
+				__(
+					'In order to register a new template pack for the EE Messages system, you must include a value to reference the template pack being registered and the setup_args must have the path for the new template pack class as well as the classname for the new Template Pack Class. ',
+					'event_espresso'
+				)
+			);
+		}
+
+		// make sure we don't register twice
+		if (isset(self::$_registry[ $ref ])) {
+			return;
+		}
+
+		// check that incoming $ref doesn't already exist. If it does then we'll create a unique reference for this template pack.
+		if (isset(self::$_registry[ $ref ])) {
+			$ref = uniqid() . '_' . $ref;
+		}
+
+
+		// make sure this was called in the right place!
+		if (! did_action('EE_Brewing_Regular___messages_caf')
+			|| did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					__(
+						'A EE Messages Template Pack given the reference "%s" has been attempted to be registered with the EE Messages System.  It may or may not work because it should be only called on the "EE_Brewing_Regular__messages_caf" hook.',
+						'event_espresso'
+					),
+					$ref
+				),
+				'4.5.0'
+			);
+		}
+
+		if (self::_verify_class_not_exist($setup_args['classname'])) {
+			self::$_registry[ $ref ] = array(
+				'path'      => (string) $setup_args['path'],
+				'classname' => (string) $setup_args['classname'],
+			);
+		}
+
+		// hook into the system
+		add_filter(
+			'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
+			array('EE_Register_Messages_Template_Pack', 'set_template_pack_path'),
+			10
+		);
+		add_filter(
+			'FHEE__EED_Messages__get_template_packs__template_packs',
+			array('EE_Register_Messages_Template_Pack', 'set_template_pack'),
+			10
+		);
+	}
+
+
+	/**
+	 * Callback for the FHEE__EED_Messages___set_messages_paths___MSG_PATHS filter.  This adds this template packs path
+	 * to the messages autoloader paths.
+	 *
+	 * @since  4.5.0
+	 *
+	 * @param array $paths Array of paths already registered with the messages autoloader
+	 *
+	 * @return array
+	 */
+	public static function set_template_pack_path($paths)
+	{
+		foreach (self::$_registry as $ref => $args) {
+			$paths[] = $args['path'];
+		}
+		return $paths;
+	}
+
+
+	/**
+	 * Callback for the FHEE__EED_Messages__get_template_packs__template_packs filter. This adds the instantiated,
+	 * registered template pack to the template packs array when requested by client code.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param EE_Messages_Template_Pack[] $template_packs
+	 * @return EE_Messages_Template_Pack[]
+	 */
+	public static function set_template_pack($template_packs)
+	{
+		foreach (self::$_registry as $ref => $args) {
+			// verify class_exists
+			if (! class_exists($args['classname'])) {
+				require_once($args['path'] . '/' . $args['classname'] . '.class.php');
+			}
+
+			// check again!
+			if (class_exists($args['classname'])) {
+				$template_pack = new $args['classname'];
+				$template_packs[ $template_pack->dbref ] = $template_pack;
+			}
+		}
+
+		return $template_packs;
+	}
+
+
+	/**
+	 * This verifies that the classes for each registered template pack are unique  names.
+	 *
+	 * @param string $classname The classname being checked
+	 *
+	 * @return bool
+	 */
+	private static function _verify_class_not_exist($classname)
+	{
+
+		// loop through the existing registry and see if the classname is already present.
+		foreach (self::$_registry as $ref => $args) {
+			if ($args['classname'] == $classname) {
+				EE_Error::add_error(
+					sprintf(
+						__(
+							'The %s template pack that you just activated cannot be registered with the messages system because there is already a template pack active using the same classname.  Contact the author of this template pack to let them know of the conflict.  To stop seeing this message you will need to deactivate this template pack.',
+							'event_espresso'
+						),
+						(string) $setup_args['classname']
+					),
+					__FILE__,
+					__LINE__,
+					__FUNCTION__
+				);
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * This deregisters a variation set that was previously registered with the given slug.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string $variation_ref The name for the variation set that was previously registered.
+	 *
+	 * @return void
+	 */
+	public static function deregister($variation_ref = null)
+	{
+		if (! empty(self::$_registry[ $variation_ref ])) {
+			unset(self::$_registry[ $variation_ref ]);
+		}
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -70,18 +70,18 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_registry[ $ref ])) {
+        if (isset(self::$_registry[$ref])) {
             return;
         }
 
         // check that incoming $ref doesn't already exist. If it does then we'll create a unique reference for this template pack.
-        if (isset(self::$_registry[ $ref ])) {
-            $ref = uniqid() . '_' . $ref;
+        if (isset(self::$_registry[$ref])) {
+            $ref = uniqid().'_'.$ref;
         }
 
 
         // make sure this was called in the right place!
-        if (! did_action('EE_Brewing_Regular___messages_caf')
+        if ( ! did_action('EE_Brewing_Regular___messages_caf')
             || did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
         ) {
             EE_Error::doing_it_wrong(
@@ -98,7 +98,7 @@ 
         }
 
         if (self::_verify_class_not_exist($setup_args['classname'])) {
-            self::$_registry[ $ref ] = array(
+            self::$_registry[$ref] = array(
                 'path'      => (string) $setup_args['path'],
                 'classname' => (string) $setup_args['classname'],
             );
@@ -150,14 +150,14 @@ 
     {
         foreach (self::$_registry as $ref => $args) {
             // verify class_exists
-            if (! class_exists($args['classname'])) {
-                require_once($args['path'] . '/' . $args['classname'] . '.class.php');
+            if ( ! class_exists($args['classname'])) {
+                require_once($args['path'].'/'.$args['classname'].'.class.php');
             }
 
             // check again!
             if (class_exists($args['classname'])) {
                 $template_pack = new $args['classname'];
-                $template_packs[ $template_pack->dbref ] = $template_pack;
+                $template_packs[$template_pack->dbref] = $template_pack;
             }
         }
 
@@ -208,8 +208,8 @@ 
      */
     public static function deregister($variation_ref = null)
     {
-        if (! empty(self::$_registry[ $variation_ref ])) {
-            unset(self::$_registry[ $variation_ref ]);
+        if ( ! empty(self::$_registry[$variation_ref])) {
+            unset(self::$_registry[$variation_ref]);
         }
     }
 }

core/libraries/messages/EE_Message_Generated_From_Token.php

Indentation +107 added lines, -107 removed lines

@@ -12,111 +12,111 @@
 {
 
 
-    /**
-     * Sending messenger
-     *
-     * @type EE_messenger | string
-     */
-    protected $_sending_messenger = '';
-
-
-    /**
-     * Holds the incoming token;
-     * @type string
-     */
-    public $token = '';
-
-
-    /**
-     * Constructor
-     *
-     * @param   string    $sending_messenger_slug     This is used to set what messenger is used to "send"
-     *                                                the EE_Message retrieved from the DB via the given token.
-     * @param   string $token                         This is a token for a Message that should already exist int the db.
-     *                                                This is then used to populate the properties in here.
-     * @param   EE_Message_Resource_Manager $message_resource_manager
-     */
-    public function __construct($token, $sending_messenger_slug = 'html', EE_Message_Resource_Manager $message_resource_manager)
-    {
-        $this->token = $token;
-        $this->_sending_messenger = $this->_set_sending_messenger($sending_messenger_slug, $message_resource_manager);
-        $this->_message = $this->_generate_message();
-        // set params for parent from the message object
-        parent::__construct(
-            $this->_message->messenger(),
-            $this->_message->message_type(),
-            array(),
-            $this->_message->context(),
-            false
-        );
-    }
-
-
-
-    /**
-     * @param string                       $sending_messenger_slug
-     * @param \EE_Message_Resource_Manager $message_resource_manager
-     * @return \EE_messenger | string
-     */
-    protected function _set_sending_messenger(
-        $sending_messenger_slug,
-        EE_Message_Resource_Manager $message_resource_manager
-    ) {
-        $sending_messenger = $message_resource_manager->get_active_messenger($sending_messenger_slug);
-        return $sending_messenger instanceof EE_messenger ? $sending_messenger : $sending_messenger_slug;
-    }
-
-
-
-    /**
-     * @return EE_messenger
-     */
-    public function sending_messenger()
-    {
-        return $this->_sending_messenger;
-    }
-
-
-
-    /**
-     * generates an EE_Message using the supplied arguments and some defaults
-     *
-     * @param array $properties
-     * @return EE_Message
-     * @throws \EE_Error
-     */
-    protected function _generate_message($properties = array())
-    {
-        // a message was generated immediately but the parent class will call this again
-        if ($this->_message instanceof EE_Message) {
-            return $this->_message;
-        }
-        $message = EEM_Message::instance()->get_one_by_token($this->token);
-        if (! $message instanceof EE_Message) {
-            throw new EE_Error(
-                sprintf(
-                    __('Unable to retrieve generated message from DB using given token: "%1$s"', 'event_espresso'),
-                    $this->token
-                )
-            );
-        }
-        $message->set_STS_ID(EEM_Message::status_idle);
-
-        if (! $this->_sending_messenger instanceof EE_messenger) {
-            $message->set_STS_ID(EEM_Message::status_failed);
-            $message->set_error_message(
-                sprintf(
-                    __('Unable to send message because the "%1$s" messenger is not active or not installed', 'event_espresso'),
-                    $this->_sending_messenger
-                )
-            );
-        }
-
-        // set properties
-        $this->_valid = true;
-        $this->_messenger = $message->messenger_object();
-        $this->_message_type = $message->message_type_object();
-        $this->_send_now = $message->send_now();
-        return $message;
-    }
+	/**
+	 * Sending messenger
+	 *
+	 * @type EE_messenger | string
+	 */
+	protected $_sending_messenger = '';
+
+
+	/**
+	 * Holds the incoming token;
+	 * @type string
+	 */
+	public $token = '';
+
+
+	/**
+	 * Constructor
+	 *
+	 * @param   string    $sending_messenger_slug     This is used to set what messenger is used to "send"
+	 *                                                the EE_Message retrieved from the DB via the given token.
+	 * @param   string $token                         This is a token for a Message that should already exist int the db.
+	 *                                                This is then used to populate the properties in here.
+	 * @param   EE_Message_Resource_Manager $message_resource_manager
+	 */
+	public function __construct($token, $sending_messenger_slug = 'html', EE_Message_Resource_Manager $message_resource_manager)
+	{
+		$this->token = $token;
+		$this->_sending_messenger = $this->_set_sending_messenger($sending_messenger_slug, $message_resource_manager);
+		$this->_message = $this->_generate_message();
+		// set params for parent from the message object
+		parent::__construct(
+			$this->_message->messenger(),
+			$this->_message->message_type(),
+			array(),
+			$this->_message->context(),
+			false
+		);
+	}
+
+
+
+	/**
+	 * @param string                       $sending_messenger_slug
+	 * @param \EE_Message_Resource_Manager $message_resource_manager
+	 * @return \EE_messenger | string
+	 */
+	protected function _set_sending_messenger(
+		$sending_messenger_slug,
+		EE_Message_Resource_Manager $message_resource_manager
+	) {
+		$sending_messenger = $message_resource_manager->get_active_messenger($sending_messenger_slug);
+		return $sending_messenger instanceof EE_messenger ? $sending_messenger : $sending_messenger_slug;
+	}
+
+
+
+	/**
+	 * @return EE_messenger
+	 */
+	public function sending_messenger()
+	{
+		return $this->_sending_messenger;
+	}
+
+
+
+	/**
+	 * generates an EE_Message using the supplied arguments and some defaults
+	 *
+	 * @param array $properties
+	 * @return EE_Message
+	 * @throws \EE_Error
+	 */
+	protected function _generate_message($properties = array())
+	{
+		// a message was generated immediately but the parent class will call this again
+		if ($this->_message instanceof EE_Message) {
+			return $this->_message;
+		}
+		$message = EEM_Message::instance()->get_one_by_token($this->token);
+		if (! $message instanceof EE_Message) {
+			throw new EE_Error(
+				sprintf(
+					__('Unable to retrieve generated message from DB using given token: "%1$s"', 'event_espresso'),
+					$this->token
+				)
+			);
+		}
+		$message->set_STS_ID(EEM_Message::status_idle);
+
+		if (! $this->_sending_messenger instanceof EE_messenger) {
+			$message->set_STS_ID(EEM_Message::status_failed);
+			$message->set_error_message(
+				sprintf(
+					__('Unable to send message because the "%1$s" messenger is not active or not installed', 'event_espresso'),
+					$this->_sending_messenger
+				)
+			);
+		}
+
+		// set properties
+		$this->_valid = true;
+		$this->_messenger = $message->messenger_object();
+		$this->_message_type = $message->message_type_object();
+		$this->_send_now = $message->send_now();
+		return $message;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -92,7 +92,7 @@ 
             return $this->_message;
         }
         $message = EEM_Message::instance()->get_one_by_token($this->token);
-        if (! $message instanceof EE_Message) {
+        if ( ! $message instanceof EE_Message) {
             throw new EE_Error(
                 sprintf(
                     __('Unable to retrieve generated message from DB using given token: "%1$s"', 'event_espresso'),
@@ -102,7 +102,7 @@ 
         }
         $message->set_STS_ID(EEM_Message::status_idle);
 
-        if (! $this->_sending_messenger instanceof EE_messenger) {
+        if ( ! $this->_sending_messenger instanceof EE_messenger) {
             $message->set_STS_ID(EEM_Message::status_failed);
             $message->set_error_message(
                 sprintf(

core/libraries/messages/EE_Messages_Scheduler.lib.php

Indentation +194 added lines, -194 removed lines

@@ -11,198 +11,198 @@
 class EE_Messages_Scheduler extends EE_Base
 {
 
-    /**
-     * Number of seconds between batch sends/generates on the cron job.
-     * Defaults to 5 minutes in seconds.  If you want to change this interval, you can use the native WordPress
-     * `cron_schedules` filter and modify the existing custom `ee_message_cron` schedule interval added.
-     *
-     * @type int
-     */
-    const message_cron_schedule = 300;
-
-    /**
-     * Constructor
-     */
-    public function __construct()
-    {
-        // register tasks (and make sure only registered once).
-        if (! has_action('FHEE__EEH_Activation__get_cron_tasks', array($this, 'register_scheduled_tasks'))) {
-            add_action('FHEE__EEH_Activation__get_cron_tasks', array($this, 'register_scheduled_tasks'), 10);
-        }
-
-        // register callbacks for scheduled events (but make sure they are set only once).
-        if (! has_action(
-            'AHEE__EE_Messages_Scheduler__generation',
-            array('EE_Messages_Scheduler', 'batch_generation')
-        )) {
-            add_action('AHEE__EE_Messages_Scheduler__generation', array('EE_Messages_Scheduler', 'batch_generation'));
-            add_action('AHEE__EE_Messages_Scheduler__sending', array('EE_Messages_Scheduler', 'batch_sending'));
-            add_action('AHEE__EE_Messages_Scheduler__cleanup', array('EE_Messages_Scheduler', 'cleanup'));
-        }
-
-        // add custom schedules
-        add_filter('cron_schedules', array($this, 'custom_schedules'));
-    }
-
-
-    /**
-     * Add custom schedules for wp_cron
-     *
-     * @param $schedules
-     */
-    public function custom_schedules($schedules)
-    {
-        $schedules['ee_message_cron'] = array(
-            'interval' => self::message_cron_schedule,
-            'display'  => __(
-                'This is the cron time interval for EE Message schedules (defaults to once every 5 minutes)',
-                'event_espresso'
-            ),
-        );
-        return $schedules;
-    }
-
-
-    /**
-     * Callback for FHEE__EEH_Activation__get_cron_tasks that is used to retrieve scheduled Cron events to add and
-     * remove.
-     *
-     * @param array $tasks already existing scheduled tasks
-     * @return array
-     */
-    public function register_scheduled_tasks($tasks)
-    {
-        EE_Registry::instance()->load_helper('DTT_Helper');
-        $tasks['AHEE__EE_Messages_Scheduler__generation'] = 'ee_message_cron';
-        $tasks['AHEE__EE_Messages_Scheduler__sending']    = 'ee_message_cron';
-        $tasks['AHEE__EE_Messages_Scheduler__cleanup'] = array( EEH_DTT_Helper::tomorrow(), 'daily');
-        return $tasks;
-    }
-
-
-    /**
-     * This initiates a non-blocking separate request to execute on a scheduled task.
-     * Note: The EED_Messages module has the handlers for these requests.
-     *
-     * @param string $task The task the request is being generated for.
-     */
-    public static function initiate_scheduled_non_blocking_request($task)
-    {
-        if (apply_filters(
-            'EE_Messages_Scheduler__initiate_scheduled_non_blocking_request__do_separate_request',
-            true
-        )) {
-            $request_url  = add_query_arg(
-                array_merge(
-                    array('ee' => 'msg_cron_trigger'),
-                    EE_Messages_Scheduler::get_request_params($task)
-                ),
-                site_url()
-            );
-            $request_args = array(
-                'timeout'     => 300,
-                'blocking'    => (defined('DOING_CRON') && DOING_CRON) || (defined('DOING_AJAX') && DOING_AJAX) ? true : false,
-                'sslverify'   => false,
-                'redirection' => 10,
-            );
-            $response     = wp_remote_get($request_url, $request_args);
-            if (is_wp_error($response)) {
-                trigger_error($response->get_error_message());
-            }
-        } else {
-            EE_Messages_Scheduler::initiate_immediate_request_on_cron($task);
-        }
-    }
-
-
-    /**
-     * This returns
-     * the request params used for a scheduled message task request.
-     *
-     * @param string $task The task the request is for.
-     * @return array
-     */
-    public static function get_request_params($task)
-    {
-        // transient is used for flood control on msg_cron_trigger requests
-        $transient_key = 'ee_trans_' . uniqid($task);
-        set_transient($transient_key, 1, 5 * MINUTE_IN_SECONDS);
-        return array(
-            'type' => $task,
-            'key'  => $transient_key,
-        );
-    }
-
-
-    /**
-     * This is used to execute an immediate call to the run_cron task performed by EED_Messages
-     *
-     * @param string $task The task the request is being generated for.
-     */
-    public static function initiate_immediate_request_on_cron($task)
-    {
-        $request_args = EE_Messages_Scheduler::get_request_params($task);
-        // set those request args in the request so it gets picked up
-        foreach ($request_args as $request_key => $request_value) {
-            EE_Registry::instance()->REQ->set($request_key, $request_value);
-        }
-        EED_Messages::instance()->run_cron();
-    }
-
-
-    /**
-     * Callback for scheduled AHEE__EE_Messages_Scheduler__generation wp cron event
-     */
-    public static function batch_generation()
-    {
-        /**
-         * @see filter usage in EE_Messages_Queue::initiate_request_by_priority()
-         */
-        if (! apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
-            || ! EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
-        ) {
-            EE_Messages_Scheduler::initiate_immediate_request_on_cron('generate');
-        }
-    }
-
-
-    /**
-     * Callback for scheduled AHEE__EE_Messages_Scheduler__sending
-     */
-    public static function batch_sending()
-    {
-        /**
-         * @see filter usage in EE_Messages_Queue::initiate_request_by_priority()
-         */
-        if (! apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
-            || ! EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
-        ) {
-            EE_Messages_Scheduler::initiate_immediate_request_on_cron('send');
-        }
-    }
-
-
-    /**
-     * This is the callback for the `AHEE__EE_Messages_Scheduler__cleanup` scheduled event action.
-     * This runs once a day and if cleanup is active (set via messages settings), it will (by default) delete permanently
-     * from the database messages that have a MSG_modified date older than 30 days.
-     */
-    public static function cleanup()
-    {
-        // first check if user has cleanup turned on or if we're in maintenance mode.  If in maintenance mode we'll wait
-        // until the next scheduled event.
-        if (! EE_Registry::instance()->CFG->messages->delete_threshold
-            || ! EE_Maintenance_Mode::instance()->models_can_query()
-        ) {
-            return;
-        }
-
-        /**
-         * This filter switch allows other code (such as the EE_Worker_Queue add-on) to replace this with its own handling
-         * of deleting messages.
-         */
-        if (apply_filters('FHEE__EE_Messages_Scheduler__cleanup__handle_cleanup_on_cron', true)) {
-            EEM_Message::instance()->delete_old_messages(EE_Registry::instance()->CFG->messages->delete_threshold);
-        }
-    }
+	/**
+	 * Number of seconds between batch sends/generates on the cron job.
+	 * Defaults to 5 minutes in seconds.  If you want to change this interval, you can use the native WordPress
+	 * `cron_schedules` filter and modify the existing custom `ee_message_cron` schedule interval added.
+	 *
+	 * @type int
+	 */
+	const message_cron_schedule = 300;
+
+	/**
+	 * Constructor
+	 */
+	public function __construct()
+	{
+		// register tasks (and make sure only registered once).
+		if (! has_action('FHEE__EEH_Activation__get_cron_tasks', array($this, 'register_scheduled_tasks'))) {
+			add_action('FHEE__EEH_Activation__get_cron_tasks', array($this, 'register_scheduled_tasks'), 10);
+		}
+
+		// register callbacks for scheduled events (but make sure they are set only once).
+		if (! has_action(
+			'AHEE__EE_Messages_Scheduler__generation',
+			array('EE_Messages_Scheduler', 'batch_generation')
+		)) {
+			add_action('AHEE__EE_Messages_Scheduler__generation', array('EE_Messages_Scheduler', 'batch_generation'));
+			add_action('AHEE__EE_Messages_Scheduler__sending', array('EE_Messages_Scheduler', 'batch_sending'));
+			add_action('AHEE__EE_Messages_Scheduler__cleanup', array('EE_Messages_Scheduler', 'cleanup'));
+		}
+
+		// add custom schedules
+		add_filter('cron_schedules', array($this, 'custom_schedules'));
+	}
+
+
+	/**
+	 * Add custom schedules for wp_cron
+	 *
+	 * @param $schedules
+	 */
+	public function custom_schedules($schedules)
+	{
+		$schedules['ee_message_cron'] = array(
+			'interval' => self::message_cron_schedule,
+			'display'  => __(
+				'This is the cron time interval for EE Message schedules (defaults to once every 5 minutes)',
+				'event_espresso'
+			),
+		);
+		return $schedules;
+	}
+
+
+	/**
+	 * Callback for FHEE__EEH_Activation__get_cron_tasks that is used to retrieve scheduled Cron events to add and
+	 * remove.
+	 *
+	 * @param array $tasks already existing scheduled tasks
+	 * @return array
+	 */
+	public function register_scheduled_tasks($tasks)
+	{
+		EE_Registry::instance()->load_helper('DTT_Helper');
+		$tasks['AHEE__EE_Messages_Scheduler__generation'] = 'ee_message_cron';
+		$tasks['AHEE__EE_Messages_Scheduler__sending']    = 'ee_message_cron';
+		$tasks['AHEE__EE_Messages_Scheduler__cleanup'] = array( EEH_DTT_Helper::tomorrow(), 'daily');
+		return $tasks;
+	}
+
+
+	/**
+	 * This initiates a non-blocking separate request to execute on a scheduled task.
+	 * Note: The EED_Messages module has the handlers for these requests.
+	 *
+	 * @param string $task The task the request is being generated for.
+	 */
+	public static function initiate_scheduled_non_blocking_request($task)
+	{
+		if (apply_filters(
+			'EE_Messages_Scheduler__initiate_scheduled_non_blocking_request__do_separate_request',
+			true
+		)) {
+			$request_url  = add_query_arg(
+				array_merge(
+					array('ee' => 'msg_cron_trigger'),
+					EE_Messages_Scheduler::get_request_params($task)
+				),
+				site_url()
+			);
+			$request_args = array(
+				'timeout'     => 300,
+				'blocking'    => (defined('DOING_CRON') && DOING_CRON) || (defined('DOING_AJAX') && DOING_AJAX) ? true : false,
+				'sslverify'   => false,
+				'redirection' => 10,
+			);
+			$response     = wp_remote_get($request_url, $request_args);
+			if (is_wp_error($response)) {
+				trigger_error($response->get_error_message());
+			}
+		} else {
+			EE_Messages_Scheduler::initiate_immediate_request_on_cron($task);
+		}
+	}
+
+
+	/**
+	 * This returns
+	 * the request params used for a scheduled message task request.
+	 *
+	 * @param string $task The task the request is for.
+	 * @return array
+	 */
+	public static function get_request_params($task)
+	{
+		// transient is used for flood control on msg_cron_trigger requests
+		$transient_key = 'ee_trans_' . uniqid($task);
+		set_transient($transient_key, 1, 5 * MINUTE_IN_SECONDS);
+		return array(
+			'type' => $task,
+			'key'  => $transient_key,
+		);
+	}
+
+
+	/**
+	 * This is used to execute an immediate call to the run_cron task performed by EED_Messages
+	 *
+	 * @param string $task The task the request is being generated for.
+	 */
+	public static function initiate_immediate_request_on_cron($task)
+	{
+		$request_args = EE_Messages_Scheduler::get_request_params($task);
+		// set those request args in the request so it gets picked up
+		foreach ($request_args as $request_key => $request_value) {
+			EE_Registry::instance()->REQ->set($request_key, $request_value);
+		}
+		EED_Messages::instance()->run_cron();
+	}
+
+
+	/**
+	 * Callback for scheduled AHEE__EE_Messages_Scheduler__generation wp cron event
+	 */
+	public static function batch_generation()
+	{
+		/**
+		 * @see filter usage in EE_Messages_Queue::initiate_request_by_priority()
+		 */
+		if (! apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
+			|| ! EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
+		) {
+			EE_Messages_Scheduler::initiate_immediate_request_on_cron('generate');
+		}
+	}
+
+
+	/**
+	 * Callback for scheduled AHEE__EE_Messages_Scheduler__sending
+	 */
+	public static function batch_sending()
+	{
+		/**
+		 * @see filter usage in EE_Messages_Queue::initiate_request_by_priority()
+		 */
+		if (! apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
+			|| ! EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
+		) {
+			EE_Messages_Scheduler::initiate_immediate_request_on_cron('send');
+		}
+	}
+
+
+	/**
+	 * This is the callback for the `AHEE__EE_Messages_Scheduler__cleanup` scheduled event action.
+	 * This runs once a day and if cleanup is active (set via messages settings), it will (by default) delete permanently
+	 * from the database messages that have a MSG_modified date older than 30 days.
+	 */
+	public static function cleanup()
+	{
+		// first check if user has cleanup turned on or if we're in maintenance mode.  If in maintenance mode we'll wait
+		// until the next scheduled event.
+		if (! EE_Registry::instance()->CFG->messages->delete_threshold
+			|| ! EE_Maintenance_Mode::instance()->models_can_query()
+		) {
+			return;
+		}
+
+		/**
+		 * This filter switch allows other code (such as the EE_Worker_Queue add-on) to replace this with its own handling
+		 * of deleting messages.
+		 */
+		if (apply_filters('FHEE__EE_Messages_Scheduler__cleanup__handle_cleanup_on_cron', true)) {
+			EEM_Message::instance()->delete_old_messages(EE_Registry::instance()->CFG->messages->delete_threshold);
+		}
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -26,12 +26,12 @@ 
     public function __construct()
     {
         // register tasks (and make sure only registered once).
-        if (! has_action('FHEE__EEH_Activation__get_cron_tasks', array($this, 'register_scheduled_tasks'))) {
+        if ( ! has_action('FHEE__EEH_Activation__get_cron_tasks', array($this, 'register_scheduled_tasks'))) {
             add_action('FHEE__EEH_Activation__get_cron_tasks', array($this, 'register_scheduled_tasks'), 10);
         }
 
         // register callbacks for scheduled events (but make sure they are set only once).
-        if (! has_action(
+        if ( ! has_action(
             'AHEE__EE_Messages_Scheduler__generation',
             array('EE_Messages_Scheduler', 'batch_generation')
         )) {
@@ -75,7 +75,7 @@ 
         EE_Registry::instance()->load_helper('DTT_Helper');
         $tasks['AHEE__EE_Messages_Scheduler__generation'] = 'ee_message_cron';
         $tasks['AHEE__EE_Messages_Scheduler__sending']    = 'ee_message_cron';
-        $tasks['AHEE__EE_Messages_Scheduler__cleanup'] = array( EEH_DTT_Helper::tomorrow(), 'daily');
+        $tasks['AHEE__EE_Messages_Scheduler__cleanup'] = array(EEH_DTT_Helper::tomorrow(), 'daily');
         return $tasks;
     }
 
@@ -92,7 +92,7 @@ 
             'EE_Messages_Scheduler__initiate_scheduled_non_blocking_request__do_separate_request',
             true
         )) {
-            $request_url  = add_query_arg(
+            $request_url = add_query_arg(
                 array_merge(
                     array('ee' => 'msg_cron_trigger'),
                     EE_Messages_Scheduler::get_request_params($task)
@@ -105,7 +105,7 @@ 
                 'sslverify'   => false,
                 'redirection' => 10,
             );
-            $response     = wp_remote_get($request_url, $request_args);
+            $response = wp_remote_get($request_url, $request_args);
             if (is_wp_error($response)) {
                 trigger_error($response->get_error_message());
             }
@@ -125,7 +125,7 @@ 
     public static function get_request_params($task)
     {
         // transient is used for flood control on msg_cron_trigger requests
-        $transient_key = 'ee_trans_' . uniqid($task);
+        $transient_key = 'ee_trans_'.uniqid($task);
         set_transient($transient_key, 1, 5 * MINUTE_IN_SECONDS);
         return array(
             'type' => $task,
@@ -158,7 +158,7 @@ 
         /**
          * @see filter usage in EE_Messages_Queue::initiate_request_by_priority()
          */
-        if (! apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
+        if ( ! apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
             || ! EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
         ) {
             EE_Messages_Scheduler::initiate_immediate_request_on_cron('generate');
@@ -174,7 +174,7 @@ 
         /**
          * @see filter usage in EE_Messages_Queue::initiate_request_by_priority()
          */
-        if (! apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
+        if ( ! apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', false)
             || ! EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
         ) {
             EE_Messages_Scheduler::initiate_immediate_request_on_cron('send');
@@ -191,7 +191,7 @@ 
     {
         // first check if user has cleanup turned on or if we're in maintenance mode.  If in maintenance mode we'll wait
         // until the next scheduled event.
-        if (! EE_Registry::instance()->CFG->messages->delete_threshold
+        if ( ! EE_Registry::instance()->CFG->messages->delete_threshold
             || ! EE_Maintenance_Mode::instance()->models_can_query()
         ) {
             return;