eventespresso / event-espresso-core

core/libraries/plugin_api/EE_Register_Messages_Shortcode_Library.lib.php

Indentation +182 added lines, -182 removed lines

@@ -12,186 +12,186 @@
 {
 
 
-    /**
-     * holds values for registered messages shortcode libraries
-     *
-     * @var array
-     */
-    protected static $_ee_messages_shortcode_registry = array();
-
-
-    /**
-     * Helper method for registring a new shortcodes library class for the messages system.
-     *
-     * Note this is not used for adding shortcodes to existing libraries.  It's for registering anything
-     * related to registering a new EE_{shortcode_library_name}_Shortcodes.lib.php class.
-     *
-     * @since    4.3.0
-     *
-     * @param  array $setup_args                    {
-     *                                              An array of arguments provided for registering the new messages
-     *                                              shortcode library.
-     *
-     * @type string  $name                          What is the name of this shortcode library
-     *                                                                              (e.g. 'question_list');
-     * @type array   $autoloadpaths                 An array of paths to add to the messages
-     *                                                                              autoloader for the new shortcode
-     *                                                                              library class file.
-     * @type string  $msgr_validator_callback       Callback for a method that will register the
-     *                                                                              library with the messenger
-     *                                                                              _validator_config. Optional.
-     * @type string  $msgr_template_fields_callback Callback for changing adding the
-     *                                                                              _template_fields property for
-     *                                                                              messenger. For example, the
-     *                                                                              shortcode library may add a new
-     *                                                                              field to the message templates.
-     *                                                                              Optional.
-     * @type string  $valid_shortcodes_callback     Callback for message types
-     *                                                                              _valid_shortcodes array setup.
-     *                                                                              Optional.
-     * @type array   $list_type_shortcodes          If there are any specific shortcodes with this
-     *                                                                             message shortcode library that
-     *                                                                             should be considered "list type"
-     *                                                                             then include them in an array.  List
-     *                                                                             Type shortcodes are shortcodes that
-     *                                                                             have a corresponding field that
-     *                                                                             indicates how they are parsed.
-     *                                                                             Optional.
-     * }
-     * @return void
-     */
-    public static function register($name = null, $setup_args = array())
-    {
-
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($name) || ! is_array($setup_args) || empty($setup_args['autoloadpaths'])) {
-            throw new EE_Error(
-                __(
-                    'In order to register a messages shortcode library with EE_Register_Messages_Shortcode_Library::register, you must include a "name" (a unique identifier for this set of message shortcodes), and an array containing the following keys: : "autoload_paths"',
-                    'event_espresso'
-                )
-            );
-        }
-
-        // make sure we don't register twice
-        if (isset(self::$_ee_messages_shortcode_registry[ $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(
-                    __(
-                        'Should be only called on the "EE_Brewing_Regular___messages_caf" hook (Trying to register a library named %s).',
-                        'event_espresso'
-                    ),
-                    $name
-                ),
-                '4.3.0'
-            );
-        }
-
-        $name = (string) $name;
-        self::$_ee_messages_shortcode_registry[ $name ] = array(
-            'autoloadpaths'        => (array) $setup_args['autoloadpaths'],
-            'list_type_shortcodes' => ! empty($setup_args['list_type_shortcodes'])
-                ? (array) $setup_args['list_type_shortcodes'] : array(),
-        );
-
-        // add filters
-        add_filter(
-            'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
-            array('EE_Register_Messages_Shortcode_Library', 'register_msgs_autoload_paths'),
-            10
-        );
-
-        // add below filters if the required callback is provided.
-        if (! empty($setup_args['msgr_validator_callback'])) {
-            add_filter('FHEE__EE_messenger__get_validator_config', $setup_args['msgr_validator_callback'], 10, 2);
-        }
-
-        if (! empty($setup_args['msgr_template_fields_callback'])) {
-            add_filter('FHEE__EE_messenger__get_template_fields', $setup_args['msgr_template_fields_callback'], 10, 2);
-        }
-
-        if (! empty($setup_args['valid_shortcodes_callback'])) {
-            add_filter('FHEE__EE_Messages_Base__get_valid_shortcodes', $setup_args['valid_shortcodes_callback'], 10, 2);
-        }
-
-        if (! empty($setup_args['list_type_shortcodes'])) {
-            add_filter(
-                'FHEE__EEH_Parse_Shortcodes___parse_message_template__list_type_shortcodes',
-                array('EE_Register_Messages_Shortcode_Library', 'register_list_type_shortcodes'),
-                10
-            );
-        }
-    }
-
-
-    /**
-     * This deregisters any messages shortcode library previously registered with the given name.
-     *
-     * @since    4.3.0
-     * @param  string $name name used to register the shortcode library.
-     * @return  void
-     */
-    public static function deregister($name = null)
-    {
-        if (! empty(self::$_ee_messages_shortcode_registry[ $name ])) {
-            unset(self::$_ee_messages_shortcode_registry[ $name ]);
-        }
-    }
-
-
-    /**
-     * 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_messages_shortcode_registry)) {
-            foreach (self::$_ee_messages_shortcode_registry as $st_reg) {
-                if (empty($st_reg['autoloadpaths'])) {
-                    continue;
-                }
-                $paths = array_merge($paths, $st_reg['autoloadpaths']);
-            }
-        }
-
-        return $paths;
-    }
-
-
-    /**
-     * This is the callback for the FHEE__EEH_Parse_Shortcodes___parse_message_template__list_type_shortcodes
-     * filter which is used to add additional list type shortcodes.
-     *
-     * @since 4.3.0
-     *
-     * @param  array $original_shortcodes
-     * @return  array                                   Modifications to original shortcodes.
-     */
-    public static function register_list_type_shortcodes($original_shortcodes)
-    {
-        if (empty(self::$_ee_messages_shortcode_registry)) {
-            return $original_shortcodes;
-        }
-
-        foreach (self::$_ee_messages_shortcode_registry as $sc_reg) {
-            if (! empty($sc_reg['list_type_shortcodes'])) {
-                $original_shortcodes = array_merge($original_shortcodes, $sc_reg['list_type_shortcodes']);
-            }
-        }
-
-        return $original_shortcodes;
-    }
+	/**
+	 * holds values for registered messages shortcode libraries
+	 *
+	 * @var array
+	 */
+	protected static $_ee_messages_shortcode_registry = array();
+
+
+	/**
+	 * Helper method for registring a new shortcodes library class for the messages system.
+	 *
+	 * Note this is not used for adding shortcodes to existing libraries.  It's for registering anything
+	 * related to registering a new EE_{shortcode_library_name}_Shortcodes.lib.php class.
+	 *
+	 * @since    4.3.0
+	 *
+	 * @param  array $setup_args                    {
+	 *                                              An array of arguments provided for registering the new messages
+	 *                                              shortcode library.
+	 *
+	 * @type string  $name                          What is the name of this shortcode library
+	 *                                                                              (e.g. 'question_list');
+	 * @type array   $autoloadpaths                 An array of paths to add to the messages
+	 *                                                                              autoloader for the new shortcode
+	 *                                                                              library class file.
+	 * @type string  $msgr_validator_callback       Callback for a method that will register the
+	 *                                                                              library with the messenger
+	 *                                                                              _validator_config. Optional.
+	 * @type string  $msgr_template_fields_callback Callback for changing adding the
+	 *                                                                              _template_fields property for
+	 *                                                                              messenger. For example, the
+	 *                                                                              shortcode library may add a new
+	 *                                                                              field to the message templates.
+	 *                                                                              Optional.
+	 * @type string  $valid_shortcodes_callback     Callback for message types
+	 *                                                                              _valid_shortcodes array setup.
+	 *                                                                              Optional.
+	 * @type array   $list_type_shortcodes          If there are any specific shortcodes with this
+	 *                                                                             message shortcode library that
+	 *                                                                             should be considered "list type"
+	 *                                                                             then include them in an array.  List
+	 *                                                                             Type shortcodes are shortcodes that
+	 *                                                                             have a corresponding field that
+	 *                                                                             indicates how they are parsed.
+	 *                                                                             Optional.
+	 * }
+	 * @return void
+	 */
+	public static function register($name = null, $setup_args = array())
+	{
+
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($name) || ! is_array($setup_args) || empty($setup_args['autoloadpaths'])) {
+			throw new EE_Error(
+				__(
+					'In order to register a messages shortcode library with EE_Register_Messages_Shortcode_Library::register, you must include a "name" (a unique identifier for this set of message shortcodes), and an array containing the following keys: : "autoload_paths"',
+					'event_espresso'
+				)
+			);
+		}
+
+		// make sure we don't register twice
+		if (isset(self::$_ee_messages_shortcode_registry[ $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(
+					__(
+						'Should be only called on the "EE_Brewing_Regular___messages_caf" hook (Trying to register a library named %s).',
+						'event_espresso'
+					),
+					$name
+				),
+				'4.3.0'
+			);
+		}
+
+		$name = (string) $name;
+		self::$_ee_messages_shortcode_registry[ $name ] = array(
+			'autoloadpaths'        => (array) $setup_args['autoloadpaths'],
+			'list_type_shortcodes' => ! empty($setup_args['list_type_shortcodes'])
+				? (array) $setup_args['list_type_shortcodes'] : array(),
+		);
+
+		// add filters
+		add_filter(
+			'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
+			array('EE_Register_Messages_Shortcode_Library', 'register_msgs_autoload_paths'),
+			10
+		);
+
+		// add below filters if the required callback is provided.
+		if (! empty($setup_args['msgr_validator_callback'])) {
+			add_filter('FHEE__EE_messenger__get_validator_config', $setup_args['msgr_validator_callback'], 10, 2);
+		}
+
+		if (! empty($setup_args['msgr_template_fields_callback'])) {
+			add_filter('FHEE__EE_messenger__get_template_fields', $setup_args['msgr_template_fields_callback'], 10, 2);
+		}
+
+		if (! empty($setup_args['valid_shortcodes_callback'])) {
+			add_filter('FHEE__EE_Messages_Base__get_valid_shortcodes', $setup_args['valid_shortcodes_callback'], 10, 2);
+		}
+
+		if (! empty($setup_args['list_type_shortcodes'])) {
+			add_filter(
+				'FHEE__EEH_Parse_Shortcodes___parse_message_template__list_type_shortcodes',
+				array('EE_Register_Messages_Shortcode_Library', 'register_list_type_shortcodes'),
+				10
+			);
+		}
+	}
+
+
+	/**
+	 * This deregisters any messages shortcode library previously registered with the given name.
+	 *
+	 * @since    4.3.0
+	 * @param  string $name name used to register the shortcode library.
+	 * @return  void
+	 */
+	public static function deregister($name = null)
+	{
+		if (! empty(self::$_ee_messages_shortcode_registry[ $name ])) {
+			unset(self::$_ee_messages_shortcode_registry[ $name ]);
+		}
+	}
+
+
+	/**
+	 * 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_messages_shortcode_registry)) {
+			foreach (self::$_ee_messages_shortcode_registry as $st_reg) {
+				if (empty($st_reg['autoloadpaths'])) {
+					continue;
+				}
+				$paths = array_merge($paths, $st_reg['autoloadpaths']);
+			}
+		}
+
+		return $paths;
+	}
+
+
+	/**
+	 * This is the callback for the FHEE__EEH_Parse_Shortcodes___parse_message_template__list_type_shortcodes
+	 * filter which is used to add additional list type shortcodes.
+	 *
+	 * @since 4.3.0
+	 *
+	 * @param  array $original_shortcodes
+	 * @return  array                                   Modifications to original shortcodes.
+	 */
+	public static function register_list_type_shortcodes($original_shortcodes)
+	{
+		if (empty(self::$_ee_messages_shortcode_registry)) {
+			return $original_shortcodes;
+		}
+
+		foreach (self::$_ee_messages_shortcode_registry as $sc_reg) {
+			if (! empty($sc_reg['list_type_shortcodes'])) {
+				$original_shortcodes = array_merge($original_shortcodes, $sc_reg['list_type_shortcodes']);
+			}
+		}
+
+		return $original_shortcodes;
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -74,12 +74,12 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_ee_messages_shortcode_registry[ $name ])) {
+        if (isset(self::$_ee_messages_shortcode_registry[$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(
@@ -96,7 +96,7 @@ 
         }
 
         $name = (string) $name;
-        self::$_ee_messages_shortcode_registry[ $name ] = array(
+        self::$_ee_messages_shortcode_registry[$name] = array(
             'autoloadpaths'        => (array) $setup_args['autoloadpaths'],
             'list_type_shortcodes' => ! empty($setup_args['list_type_shortcodes'])
                 ? (array) $setup_args['list_type_shortcodes'] : array(),
@@ -110,19 +110,19 @@ 
         );
 
         // add below filters if the required callback is provided.
-        if (! empty($setup_args['msgr_validator_callback'])) {
+        if ( ! empty($setup_args['msgr_validator_callback'])) {
             add_filter('FHEE__EE_messenger__get_validator_config', $setup_args['msgr_validator_callback'], 10, 2);
         }
 
-        if (! empty($setup_args['msgr_template_fields_callback'])) {
+        if ( ! empty($setup_args['msgr_template_fields_callback'])) {
             add_filter('FHEE__EE_messenger__get_template_fields', $setup_args['msgr_template_fields_callback'], 10, 2);
         }
 
-        if (! empty($setup_args['valid_shortcodes_callback'])) {
+        if ( ! empty($setup_args['valid_shortcodes_callback'])) {
             add_filter('FHEE__EE_Messages_Base__get_valid_shortcodes', $setup_args['valid_shortcodes_callback'], 10, 2);
         }
 
-        if (! empty($setup_args['list_type_shortcodes'])) {
+        if ( ! empty($setup_args['list_type_shortcodes'])) {
             add_filter(
                 'FHEE__EEH_Parse_Shortcodes___parse_message_template__list_type_shortcodes',
                 array('EE_Register_Messages_Shortcode_Library', 'register_list_type_shortcodes'),
@@ -141,8 +141,8 @@ 
      */
     public static function deregister($name = null)
     {
-        if (! empty(self::$_ee_messages_shortcode_registry[ $name ])) {
-            unset(self::$_ee_messages_shortcode_registry[ $name ]);
+        if ( ! empty(self::$_ee_messages_shortcode_registry[$name])) {
+            unset(self::$_ee_messages_shortcode_registry[$name]);
         }
     }
 
@@ -158,7 +158,7 @@ 
     public static function register_msgs_autoload_paths($paths)
     {
 
-        if (! empty(self::$_ee_messages_shortcode_registry)) {
+        if ( ! empty(self::$_ee_messages_shortcode_registry)) {
             foreach (self::$_ee_messages_shortcode_registry as $st_reg) {
                 if (empty($st_reg['autoloadpaths'])) {
                     continue;
@@ -187,7 +187,7 @@ 
         }
 
         foreach (self::$_ee_messages_shortcode_registry as $sc_reg) {
-            if (! empty($sc_reg['list_type_shortcodes'])) {
+            if ( ! empty($sc_reg['list_type_shortcodes'])) {
                 $original_shortcodes = array_merge($original_shortcodes, $sc_reg['list_type_shortcodes']);
             }
         }

core/libraries/plugin_api/EE_Register_Widget.lib.php

Indentation +85 added lines, -85 removed lines

@@ -14,99 +14,99 @@
 class EE_Register_Widget implements EEI_Plugin_API
 {
 
-    /**
-     * Holds values for registered widgets
-     *
-     * @var array
-     */
-    protected static $_settings = array();
+	/**
+	 * Holds values for registered widgets
+	 *
+	 * @var array
+	 */
+	protected static $_settings = array();
 
 
-    /**
-     *    Method for registering new EED_Widgets
-     *
-     * @since    4.3.0
-     * @param string $widget_id a unique identifier for this set of widgets
-     * @param  array $setup_args an array of arguments provided for registering widgets
-     * @type array widget_paths        an array of full server paths to folders containing any EED_Widgets, or to the
-     *       EED_Widget files themselves
-     * @throws EE_Error
-     * @return void
-     */
-    public static function register($widget_id = null, $setup_args = array())
-    {
+	/**
+	 *    Method for registering new EED_Widgets
+	 *
+	 * @since    4.3.0
+	 * @param string $widget_id a unique identifier for this set of widgets
+	 * @param  array $setup_args an array of arguments provided for registering widgets
+	 * @type array widget_paths        an array of full server paths to folders containing any EED_Widgets, or to the
+	 *       EED_Widget files themselves
+	 * @throws EE_Error
+	 * @return void
+	 */
+	public static function register($widget_id = null, $setup_args = array())
+	{
 
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($widget_id) || ! is_array($setup_args) || empty($setup_args['widget_paths'])) {
-            throw new EE_Error(
-                __(
-                    'In order to register Widgets with EE_Register_Widget::register(), you must include a "widget_id" (a unique identifier for this set of widgets), and an array containing the following keys: "widget_paths" (an array of full server paths to folders that contain widgets, or to the widget files themselves)',
-                    'event_espresso'
-                )
-            );
-        }
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($widget_id) || ! is_array($setup_args) || empty($setup_args['widget_paths'])) {
+			throw new EE_Error(
+				__(
+					'In order to register Widgets with EE_Register_Widget::register(), you must include a "widget_id" (a unique identifier for this set of widgets), and an array containing the following keys: "widget_paths" (an array of full server paths to folders that contain widgets, or to the widget files themselves)',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_settings[ $widget_id ])) {
-            return;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_settings[ $widget_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__,
-                __(
-                    'An attempt to register widgets 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 widgets.',
-                    'event_espresso'
-                ),
-                '4.3.0'
-            );
-        }
-        // setup $_settings array from incoming values.
-        self::$_settings[ $widget_id ] = array(
-            // array of full server paths to any EED_Widgets used by the widget
-            'widget_paths' => isset($setup_args['widget_paths']) ? (array) $setup_args['widget_paths'] : array(),
-        );
-        // add to list of widgets to be registered
-        add_filter(
-            'FHEE__EE_Config__register_widgets__widgets_to_register',
-            array('EE_Register_Widget', 'add_widgets')
-        );
-    }
+		// 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__,
+				__(
+					'An attempt to register widgets 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 widgets.',
+					'event_espresso'
+				),
+				'4.3.0'
+			);
+		}
+		// setup $_settings array from incoming values.
+		self::$_settings[ $widget_id ] = array(
+			// array of full server paths to any EED_Widgets used by the widget
+			'widget_paths' => isset($setup_args['widget_paths']) ? (array) $setup_args['widget_paths'] : array(),
+		);
+		// add to list of widgets to be registered
+		add_filter(
+			'FHEE__EE_Config__register_widgets__widgets_to_register',
+			array('EE_Register_Widget', 'add_widgets')
+		);
+	}
 
 
-    /**
-     * Filters the list of widgets to add ours.
-     * and they're just full filepaths to FOLDERS containing a shortcode class file. Eg.
-     * array('espresso_monkey'=>'/public_html/wonder-site/wp-content/plugins/ee4/widgets/espresso_monkey',...)
-     *
-     * @param array $widgets_to_register array of paths to all widgets that require registering
-     * @return array
-     */
-    public static function add_widgets($widgets_to_register = array())
-    {
-        foreach (self::$_settings as $settings) {
-            $widgets_to_register = array_merge($widgets_to_register, $settings['widget_paths']);
-        }
-        return $widgets_to_register;
-    }
+	/**
+	 * Filters the list of widgets to add ours.
+	 * and they're just full filepaths to FOLDERS containing a shortcode class file. Eg.
+	 * array('espresso_monkey'=>'/public_html/wonder-site/wp-content/plugins/ee4/widgets/espresso_monkey',...)
+	 *
+	 * @param array $widgets_to_register array of paths to all widgets that require registering
+	 * @return array
+	 */
+	public static function add_widgets($widgets_to_register = array())
+	{
+		foreach (self::$_settings as $settings) {
+			$widgets_to_register = array_merge($widgets_to_register, $settings['widget_paths']);
+		}
+		return $widgets_to_register;
+	}
 
 
-    /**
-     * This deregisters a widget that was previously registered with a specific $widget_id.
-     *
-     * @since    4.3.0
-     *
-     * @param string $widget_id the name for the widget that was previously registered
-     * @return void
-     */
-    public static function deregister($widget_id = null)
-    {
-        if (isset(self::$_settings[ $widget_id ])) {
-            unset(self::$_settings[ $widget_id ]);
-        }
-    }
+	/**
+	 * This deregisters a widget that was previously registered with a specific $widget_id.
+	 *
+	 * @since    4.3.0
+	 *
+	 * @param string $widget_id the name for the widget that was previously registered
+	 * @return void
+	 */
+	public static function deregister($widget_id = null)
+	{
+		if (isset(self::$_settings[ $widget_id ])) {
+			unset(self::$_settings[ $widget_id ]);
+		}
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -47,13 +47,13 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_settings[ $widget_id ])) {
+        if (isset(self::$_settings[$widget_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(
@@ -66,7 +66,7 @@ 
             );
         }
         // setup $_settings array from incoming values.
-        self::$_settings[ $widget_id ] = array(
+        self::$_settings[$widget_id] = array(
             // array of full server paths to any EED_Widgets used by the widget
             'widget_paths' => isset($setup_args['widget_paths']) ? (array) $setup_args['widget_paths'] : array(),
         );
@@ -105,8 +105,8 @@ 
      */
     public static function deregister($widget_id = null)
     {
-        if (isset(self::$_settings[ $widget_id ])) {
-            unset(self::$_settings[ $widget_id ]);
+        if (isset(self::$_settings[$widget_id])) {
+            unset(self::$_settings[$widget_id]);
         }
     }
 }

core/libraries/plugin_api/EE_Register_Module.lib.php

Indentation +86 added lines, -86 removed lines

@@ -14,99 +14,99 @@
 class EE_Register_Module implements EEI_Plugin_API
 {
 
-    /**
-     * Holds values for registered modules
-     *
-     * @var array
-     */
-    protected static $_settings = array();
+	/**
+	 * Holds values for registered modules
+	 *
+	 * @var array
+	 */
+	protected static $_settings = array();
 
 
-    /**
-     *    Method for registering new EED_Modules
-     *
-     * @since    4.3.0
-     * @param string $module_id a unique identifier for this set of modules Required.
-     * @param  array $setup_args an array of full server paths to folders containing any EED_Modules, or to the
-     *                           EED_Module files themselves Required.
-     * @type    array module_paths    an array of full server paths to folders containing any EED_Modules, or to the
-     *          EED_Module files themselves
-     * @throws EE_Error
-     * @return void
-     */
-    public static function register($module_id = null, $setup_args = array())
-    {
+	/**
+	 *    Method for registering new EED_Modules
+	 *
+	 * @since    4.3.0
+	 * @param string $module_id a unique identifier for this set of modules Required.
+	 * @param  array $setup_args an array of full server paths to folders containing any EED_Modules, or to the
+	 *                           EED_Module files themselves Required.
+	 * @type    array module_paths    an array of full server paths to folders containing any EED_Modules, or to the
+	 *          EED_Module files themselves
+	 * @throws EE_Error
+	 * @return void
+	 */
+	public static function register($module_id = null, $setup_args = array())
+	{
 
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($module_id) || ! is_array($setup_args) || empty($setup_args['module_paths'])) {
-            throw new EE_Error(
-                __(
-                    'In order to register Modules with EE_Register_Module::register(), you must include a "module_id" (a unique identifier for this set of modules), and an array containing the following keys: "module_paths" (an array of full server paths to folders that contain modules, or to the module files themselves)',
-                    'event_espresso'
-                )
-            );
-        }
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($module_id) || ! is_array($setup_args) || empty($setup_args['module_paths'])) {
+			throw new EE_Error(
+				__(
+					'In order to register Modules with EE_Register_Module::register(), you must include a "module_id" (a unique identifier for this set of modules), and an array containing the following keys: "module_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[ $module_id ])) {
-            return;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_settings[ $module_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__,
-                __(
-                    '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[ $module_id ] = array(
-            // array of full server paths to any EED_Modules used by the module
-            'module_paths' => isset($setup_args['module_paths']) ? (array) $setup_args['module_paths'] : array(),
-        );
-        // add to list of modules to be registered
-        add_filter(
-            'FHEE__EE_Config__register_modules__modules_to_register',
-            array('EE_Register_Module', 'add_modules')
-        );
-    }
+		// 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__,
+				__(
+					'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[ $module_id ] = array(
+			// array of full server paths to any EED_Modules used by the module
+			'module_paths' => isset($setup_args['module_paths']) ? (array) $setup_args['module_paths'] : array(),
+		);
+		// add to list of modules to be registered
+		add_filter(
+			'FHEE__EE_Config__register_modules__modules_to_register',
+			array('EE_Register_Module', 'add_modules')
+		);
+	}
 
 
-    /**
-     * Filters the list of modules to add ours.
-     * and they're just full filepaths to FOLDERS containing a module class file. Eg.
-     * array('espresso_monkey'=>'/public_html/wonder-site/wp-content/plugins/ee4/shortcodes/espresso_monkey',...)
-     *
-     * @param array $modules_to_register array of paths to all modules that require registering
-     * @return array
-     */
-    public static function add_modules($modules_to_register)
-    {
-        foreach (self::$_settings as $settings) {
-            $modules_to_register = array_merge($modules_to_register, $settings['module_paths']);
-        }
-        return $modules_to_register;
-    }
+	/**
+	 * Filters the list of modules to add ours.
+	 * and they're just full filepaths to FOLDERS containing a module class file. Eg.
+	 * array('espresso_monkey'=>'/public_html/wonder-site/wp-content/plugins/ee4/shortcodes/espresso_monkey',...)
+	 *
+	 * @param array $modules_to_register array of paths to all modules that require registering
+	 * @return array
+	 */
+	public static function add_modules($modules_to_register)
+	{
+		foreach (self::$_settings as $settings) {
+			$modules_to_register = array_merge($modules_to_register, $settings['module_paths']);
+		}
+		return $modules_to_register;
+	}
 
 
-    /**
-     * 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
-     */
-    public static function deregister($module_id = null)
-    {
-        if (isset(self::$_settings[ $module_id ])) {
-            unset(self::$_settings[ $module_id ]);
-        }
-    }
+	/**
+	 * 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
+	 */
+	public static function deregister($module_id = null)
+	{
+		if (isset(self::$_settings[ $module_id ])) {
+			unset(self::$_settings[ $module_id ]);
+		}
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -48,12 +48,12 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_settings[ $module_id ])) {
+        if (isset(self::$_settings[$module_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(
@@ -66,7 +66,7 @@ 
             );
         }
         // setup $_settings array from incoming values.
-        self::$_settings[ $module_id ] = array(
+        self::$_settings[$module_id] = array(
             // array of full server paths to any EED_Modules used by the module
             'module_paths' => isset($setup_args['module_paths']) ? (array) $setup_args['module_paths'] : array(),
         );
@@ -105,8 +105,8 @@ 
      */
     public static function deregister($module_id = null)
     {
-        if (isset(self::$_settings[ $module_id ])) {
-            unset(self::$_settings[ $module_id ]);
+        if (isset(self::$_settings[$module_id])) {
+            unset(self::$_settings[$module_id]);
         }
     }
 }

core/libraries/plugin_api/EE_Register_Shortcode.lib.php

Indentation +147 added lines, -147 removed lines

@@ -18,162 +18,162 @@
 class EE_Register_Shortcode implements EEI_Plugin_API
 {
 
-    /**
-     * Holds values for registered shortcodes
-     *
-     * @var array
-     */
-    protected static $_settings = array();
+	/**
+	 * Holds values for registered shortcodes
+	 *
+	 * @var array
+	 */
+	protected static $_settings = array();
 
 
-    /**
-     *    Method for registering new EE_Shortcodes
-     *
-     * @since    4.3.0
-     * @since    4.9.46.rc.025  for the new `shortcode_fqcns` array argument.
-     * @param string $shortcode_id                      a unique identifier for this set of modules Required.
-     * @param  array $setup_args                        an array of arguments provided for registering shortcodes
-     *                                                  Required.
-     * @type array shortcode_paths        an array of full server paths to folders containing any
-     *                                                  EES_Shortcodes
-     * @type array shortcode_fqcns        an array of fully qualified class names for any new shortcode
-     *                                                  classes to register.  Shortcode classes should extend
-     *                                                  EspressoShortcode and be properly namespaced so they are
-     *                                                  autoloaded.
-     * @throws EE_Error
-     * @return void
-     */
-    public static function register($shortcode_id = null, $setup_args = array())
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($shortcode_id)
-            || ! is_array($setup_args)
-            || (
-               empty($setup_args['shortcode_paths']))
-               && empty($setup_args['shortcode_fqcns'])
-        ) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register Modules with EE_Register_Shortcode::register(), you must include a "shortcode_id" (a unique identifier for this set of shortcodes), and an array containing the following keys: "shortcode_paths" (an array of full server paths to folders that contain shortcodes, or to the shortcode files themselves)',
-                    'event_espresso'
-                )
-            );
-        }
+	/**
+	 *    Method for registering new EE_Shortcodes
+	 *
+	 * @since    4.3.0
+	 * @since    4.9.46.rc.025  for the new `shortcode_fqcns` array argument.
+	 * @param string $shortcode_id                      a unique identifier for this set of modules Required.
+	 * @param  array $setup_args                        an array of arguments provided for registering shortcodes
+	 *                                                  Required.
+	 * @type array shortcode_paths        an array of full server paths to folders containing any
+	 *                                                  EES_Shortcodes
+	 * @type array shortcode_fqcns        an array of fully qualified class names for any new shortcode
+	 *                                                  classes to register.  Shortcode classes should extend
+	 *                                                  EspressoShortcode and be properly namespaced so they are
+	 *                                                  autoloaded.
+	 * @throws EE_Error
+	 * @return void
+	 */
+	public static function register($shortcode_id = null, $setup_args = array())
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($shortcode_id)
+			|| ! is_array($setup_args)
+			|| (
+			   empty($setup_args['shortcode_paths']))
+			   && empty($setup_args['shortcode_fqcns'])
+		) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register Modules with EE_Register_Shortcode::register(), you must include a "shortcode_id" (a unique identifier for this set of shortcodes), and an array containing the following keys: "shortcode_paths" (an array of full server paths to folders that contain shortcodes, or to the shortcode files themselves)',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_settings[ $shortcode_id ])) {
-            return;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_settings[ $shortcode_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 shortcodes 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 shortcodes.',
-                    'event_espresso'
-                ),
-                '4.3.0'
-            );
-        }
-        // setup $_settings array from incoming values.
-        self::$_settings[ $shortcode_id ] = array(
-            // array of full server paths to any EES_Shortcodes used by the shortcode
-            'shortcode_paths' => isset($setup_args['shortcode_paths'])
-                ? (array) $setup_args['shortcode_paths']
-                : array(),
-            'shortcode_fqcns' => isset($setup_args['shortcode_fqcns'])
-                ? (array) $setup_args['shortcode_fqcns']
-                : array(),
-        );
-        // add to list of shortcodes to be registered
-        add_filter(
-            'FHEE__EE_Config__register_shortcodes__shortcodes_to_register',
-            array('EE_Register_Shortcode', 'add_shortcodes')
-        );
+		// 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 shortcodes 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 shortcodes.',
+					'event_espresso'
+				),
+				'4.3.0'
+			);
+		}
+		// setup $_settings array from incoming values.
+		self::$_settings[ $shortcode_id ] = array(
+			// array of full server paths to any EES_Shortcodes used by the shortcode
+			'shortcode_paths' => isset($setup_args['shortcode_paths'])
+				? (array) $setup_args['shortcode_paths']
+				: array(),
+			'shortcode_fqcns' => isset($setup_args['shortcode_fqcns'])
+				? (array) $setup_args['shortcode_fqcns']
+				: array(),
+		);
+		// add to list of shortcodes to be registered
+		add_filter(
+			'FHEE__EE_Config__register_shortcodes__shortcodes_to_register',
+			array('EE_Register_Shortcode', 'add_shortcodes')
+		);
 
-        add_filter(
-            'FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection',
-            array('EE_Register_Shortcode', 'instantiateAndAddToShortcodeCollection')
-        );
-    }
+		add_filter(
+			'FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection',
+			array('EE_Register_Shortcode', 'instantiateAndAddToShortcodeCollection')
+		);
+	}
 
 
-    /**
-     * Filters the list of shortcodes to add ours.
-     * and they're just full filepaths to FOLDERS containing a shortcode class file. Eg.
-     * array('espresso_monkey'=>'/public_html/wonder-site/wp-content/plugins/ee4/shortcodes/espresso_monkey',...)
-     *
-     * @param array $shortcodes_to_register array of paths to all shortcodes that require registering
-     * @return array
-     */
-    public static function add_shortcodes($shortcodes_to_register)
-    {
-        foreach (self::$_settings as $settings) {
-            $shortcodes_to_register = array_merge($shortcodes_to_register, $settings['shortcode_paths']);
-        }
-        return $shortcodes_to_register;
-    }
+	/**
+	 * Filters the list of shortcodes to add ours.
+	 * and they're just full filepaths to FOLDERS containing a shortcode class file. Eg.
+	 * array('espresso_monkey'=>'/public_html/wonder-site/wp-content/plugins/ee4/shortcodes/espresso_monkey',...)
+	 *
+	 * @param array $shortcodes_to_register array of paths to all shortcodes that require registering
+	 * @return array
+	 */
+	public static function add_shortcodes($shortcodes_to_register)
+	{
+		foreach (self::$_settings as $settings) {
+			$shortcodes_to_register = array_merge($shortcodes_to_register, $settings['shortcode_paths']);
+		}
+		return $shortcodes_to_register;
+	}
 
 
-    /**
-     * Hooks into
-     * FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection and
-     * registers any provided shortcode fully qualified class names.
-     *
-     * @param CollectionInterface $shortcodes_collection
-     * @return CollectionInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidClassException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public static function instantiateAndAddToShortcodeCollection(CollectionInterface $shortcodes_collection)
-    {
-        foreach (self::$_settings as $settings) {
-            if (! empty($settings['shortcode_fqcns'])) {
-                foreach ($settings['shortcode_fqcns'] as $shortcode_fqcn) {
-                    if (! class_exists($shortcode_fqcn)) {
-                        throw new InvalidClassException(
-                            sprintf(
-                                esc_html__(
-                                    'Are you sure %s is the right fully qualified class name for the shortcode class?',
-                                    'event_espresso'
-                                ),
-                                $shortcode_fqcn
-                            )
-                        );
-                    }
-                    if (! EE_Dependency_Map::instance()->has_dependency_for_class($shortcode_fqcn)) {
-                        // register dependencies
-                        EE_Dependency_Map::register_dependencies(
-                            $shortcode_fqcn,
-                            array(
-                                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-                            )
-                        );
-                    }
-                    $shortcodes_collection->add(LoaderFactory::getLoader()->getShared($shortcode_fqcn));
-                }
-            }
-        }
-        return $shortcodes_collection;
-    }
+	/**
+	 * Hooks into
+	 * FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection and
+	 * registers any provided shortcode fully qualified class names.
+	 *
+	 * @param CollectionInterface $shortcodes_collection
+	 * @return CollectionInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidClassException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public static function instantiateAndAddToShortcodeCollection(CollectionInterface $shortcodes_collection)
+	{
+		foreach (self::$_settings as $settings) {
+			if (! empty($settings['shortcode_fqcns'])) {
+				foreach ($settings['shortcode_fqcns'] as $shortcode_fqcn) {
+					if (! class_exists($shortcode_fqcn)) {
+						throw new InvalidClassException(
+							sprintf(
+								esc_html__(
+									'Are you sure %s is the right fully qualified class name for the shortcode class?',
+									'event_espresso'
+								),
+								$shortcode_fqcn
+							)
+						);
+					}
+					if (! EE_Dependency_Map::instance()->has_dependency_for_class($shortcode_fqcn)) {
+						// register dependencies
+						EE_Dependency_Map::register_dependencies(
+							$shortcode_fqcn,
+							array(
+								'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+							)
+						);
+					}
+					$shortcodes_collection->add(LoaderFactory::getLoader()->getShared($shortcode_fqcn));
+				}
+			}
+		}
+		return $shortcodes_collection;
+	}
 
 
-    /**
-     * This deregisters a shortcode that was previously registered with a specific $shortcode_id.
-     *
-     * @since    4.3.0
-     * @param string $shortcode_id the name for the shortcode that was previously registered
-     * @return void
-     */
-    public static function deregister($shortcode_id = null)
-    {
-        if (isset(self::$_settings[ $shortcode_id ])) {
-            unset(self::$_settings[ $shortcode_id ]);
-        }
-    }
+	/**
+	 * This deregisters a shortcode that was previously registered with a specific $shortcode_id.
+	 *
+	 * @since    4.3.0
+	 * @param string $shortcode_id the name for the shortcode that was previously registered
+	 * @return void
+	 */
+	public static function deregister($shortcode_id = null)
+	{
+		if (isset(self::$_settings[ $shortcode_id ])) {
+			unset(self::$_settings[ $shortcode_id ]);
+		}
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -61,12 +61,12 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_settings[ $shortcode_id ])) {
+        if (isset(self::$_settings[$shortcode_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(
@@ -79,7 +79,7 @@ 
             );
         }
         // setup $_settings array from incoming values.
-        self::$_settings[ $shortcode_id ] = array(
+        self::$_settings[$shortcode_id] = array(
             // array of full server paths to any EES_Shortcodes used by the shortcode
             'shortcode_paths' => isset($setup_args['shortcode_paths'])
                 ? (array) $setup_args['shortcode_paths']
@@ -133,9 +133,9 @@ 
     public static function instantiateAndAddToShortcodeCollection(CollectionInterface $shortcodes_collection)
     {
         foreach (self::$_settings as $settings) {
-            if (! empty($settings['shortcode_fqcns'])) {
+            if ( ! empty($settings['shortcode_fqcns'])) {
                 foreach ($settings['shortcode_fqcns'] as $shortcode_fqcn) {
-                    if (! class_exists($shortcode_fqcn)) {
+                    if ( ! class_exists($shortcode_fqcn)) {
                         throw new InvalidClassException(
                             sprintf(
                                 esc_html__(
@@ -146,7 +146,7 @@ 
                             )
                         );
                     }
-                    if (! EE_Dependency_Map::instance()->has_dependency_for_class($shortcode_fqcn)) {
+                    if ( ! EE_Dependency_Map::instance()->has_dependency_for_class($shortcode_fqcn)) {
                         // register dependencies
                         EE_Dependency_Map::register_dependencies(
                             $shortcode_fqcn,
@@ -172,8 +172,8 @@ 
      */
     public static function deregister($shortcode_id = null)
     {
-        if (isset(self::$_settings[ $shortcode_id ])) {
-            unset(self::$_settings[ $shortcode_id ]);
+        if (isset(self::$_settings[$shortcode_id])) {
+            unset(self::$_settings[$shortcode_id]);
         }
     }
 }

core/libraries/plugin_api/EE_Register_CPT.lib.php

Spacing +11 added lines, -11 removed lines

@@ -73,7 +73,7 @@ 
             );
         }
 
-        if (! is_array($setup_args) || (empty($setup_args['cpts']) && empty($setup_args['cts']))) {
+        if ( ! is_array($setup_args) || (empty($setup_args['cpts']) && empty($setup_args['cts']))) {
             throw new EE_Error(
                 __(
                     'In order to register custom post types or custom taxonomies, you must include an array containing either an array of custom post types to register (key "cpts"), an array of custom taxonomies ("cts") or both.',
@@ -83,13 +83,13 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_registry[ $cpt_ref ])) {
+        if (isset(self::$_registry[$cpt_ref])) {
             return;
         }
 
         // make sure cpt ref is unique.
-        if (isset(self::$_registry[ $cpt_ref ])) {
-            $cpt_ref = uniqid() . '_' . $cpt_ref;
+        if (isset(self::$_registry[$cpt_ref])) {
+            $cpt_ref = uniqid().'_'.$cpt_ref;
         }
 
         // make sure this was called in the right place!
@@ -119,7 +119,7 @@ 
                 : array(),
         );
 
-        self::$_registry[ $cpt_ref ] = $validated;
+        self::$_registry[$cpt_ref] = $validated;
 
         // hook into to cpt system
         add_filter(
@@ -152,7 +152,7 @@ 
     {
         foreach (self::$_registry as $registries) {
             foreach ($registries['cpts'] as $cpt_name => $cpt_settings) {
-                $custom_post_type_definitions[ $cpt_name ] = $cpt_settings;
+                $custom_post_type_definitions[$cpt_name] = $cpt_settings;
             }
         }
         return $custom_post_type_definitions;
@@ -171,7 +171,7 @@ 
     {
         foreach (self::$_registry as $registries) {
             foreach ($registries['cts'] as $ct_name => $ct_settings) {
-                $custom_taxonomy_definitions[ $ct_name ] = $ct_settings;
+                $custom_taxonomy_definitions[$ct_name] = $ct_settings;
             }
         }
         return $custom_taxonomy_definitions;
@@ -211,7 +211,7 @@ 
     {
         foreach (self::$_registry as $registries) {
             foreach ($registries['cpts'] as $cpt_name => $cpt_settings) {
-                $cpts[ $cpt_name ] = $cpt_settings;
+                $cpts[$cpt_name] = $cpt_settings;
             }
         }
         return $cpts;
@@ -227,7 +227,7 @@ 
     {
         foreach (self::$_registry as $registries) {
             foreach ($registries['cts'] as $ct_name => $ct_settings) {
-                $cts[ $ct_name ] = $ct_settings;
+                $cts[$ct_name] = $ct_settings;
             }
         }
         return $cts;
@@ -262,8 +262,8 @@ 
      */
     public static function deregister($cpt_ref = null)
     {
-        if (! empty(self::$_registry[ $cpt_ref ])) {
-            unset(self::$_registry[ $cpt_ref ]);
+        if ( ! empty(self::$_registry[$cpt_ref])) {
+            unset(self::$_registry[$cpt_ref]);
         }
     }
 }

Indentation +230 added lines, -230 removed lines

@@ -13,257 +13,257 @@
 class EE_Register_CPT 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 CPTs and Taxonomies.
-     *
-     * @param string $cpt_ref                 reference used for the addon registering cpts and cts
-     * @param array  $setup_args              {
-     *                                        An array of required values for registering the cpts and taxonomies
-     * @type array   $cpts                    {
-     *                                        An array of cpts and their arguments.(short example below)
-     * @see CustomPostTypeDefinitions::setDefinitions for a more complete example.
-     *                                        'people' => array(
-     *                                        'singular_name' => __('People', 'event_espresso'),
-     *                                        'plural_name' => __('People', 'event_espresso'),
-     *                                        'singular_slug' => __('people', 'event_espresso'),
-     *                                        'plural_slug' => __('peoples', 'event_espresso'),
-     *                                        'class_name' => 'EE_People'
-     *                                        )
-     *                                        },
-     * @type array   $cts                     {
-     *                                        An array of custom taxonomies and their arguments (short example below).
-     * @see CustomTaxonomyDefinitions::setTaxonomies() for a more complete example.
-     *                                        'espresso_people_type' => array(
-     *                                        'singular_name' => __('People Type', 'event_espresso'),
-     *                                        'plural_name' => __('People Types', 'event_espresso'),
-     *                                        'args' => array()
-     *                                        )
-     *                                        },
-     * @type array   $default_terms           {
-     *                                        An array of terms to set as the default for a given taxonomy and the
-     *                                        custom post types applied to.
-     *                                        'taxonomy_name' => array(
-     *                                        'term' => array( 'cpt_a_name', 'cpt_b_name' )
-     *                                        )
-     *                                        }
-     *                                        }
-     * @throws  EE_Error
-     * @return void
-     */
-    public static function register($cpt_ref = null, $setup_args = array())
-    {
+	/**
+	 * Used to register new CPTs and Taxonomies.
+	 *
+	 * @param string $cpt_ref                 reference used for the addon registering cpts and cts
+	 * @param array  $setup_args              {
+	 *                                        An array of required values for registering the cpts and taxonomies
+	 * @type array   $cpts                    {
+	 *                                        An array of cpts and their arguments.(short example below)
+	 * @see CustomPostTypeDefinitions::setDefinitions for a more complete example.
+	 *                                        'people' => array(
+	 *                                        'singular_name' => __('People', 'event_espresso'),
+	 *                                        'plural_name' => __('People', 'event_espresso'),
+	 *                                        'singular_slug' => __('people', 'event_espresso'),
+	 *                                        'plural_slug' => __('peoples', 'event_espresso'),
+	 *                                        'class_name' => 'EE_People'
+	 *                                        )
+	 *                                        },
+	 * @type array   $cts                     {
+	 *                                        An array of custom taxonomies and their arguments (short example below).
+	 * @see CustomTaxonomyDefinitions::setTaxonomies() for a more complete example.
+	 *                                        'espresso_people_type' => array(
+	 *                                        'singular_name' => __('People Type', 'event_espresso'),
+	 *                                        'plural_name' => __('People Types', 'event_espresso'),
+	 *                                        'args' => array()
+	 *                                        )
+	 *                                        },
+	 * @type array   $default_terms           {
+	 *                                        An array of terms to set as the default for a given taxonomy and the
+	 *                                        custom post types applied to.
+	 *                                        'taxonomy_name' => array(
+	 *                                        'term' => array( 'cpt_a_name', 'cpt_b_name' )
+	 *                                        )
+	 *                                        }
+	 *                                        }
+	 * @throws  EE_Error
+	 * @return void
+	 */
+	public static function register($cpt_ref = null, $setup_args = array())
+	{
 
-        // check for required params
-        if (empty($cpt_ref)) {
-            throw new EE_Error(
-                __(
-                    'In order to register custom post types and custom taxonomies, you must include a value to reference what had been registered',
-                    'event_espresso'
-                )
-            );
-        }
+		// check for required params
+		if (empty($cpt_ref)) {
+			throw new EE_Error(
+				__(
+					'In order to register custom post types and custom taxonomies, you must include a value to reference what had been registered',
+					'event_espresso'
+				)
+			);
+		}
 
-        if (! is_array($setup_args) || (empty($setup_args['cpts']) && empty($setup_args['cts']))) {
-            throw new EE_Error(
-                __(
-                    'In order to register custom post types or custom taxonomies, you must include an array containing either an array of custom post types to register (key "cpts"), an array of custom taxonomies ("cts") or both.',
-                    'event_espresso'
-                )
-            );
-        }
+		if (! is_array($setup_args) || (empty($setup_args['cpts']) && empty($setup_args['cts']))) {
+			throw new EE_Error(
+				__(
+					'In order to register custom post types or custom taxonomies, you must include an array containing either an array of custom post types to register (key "cpts"), an array of custom taxonomies ("cts") or both.',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_registry[ $cpt_ref ])) {
-            return;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_registry[ $cpt_ref ])) {
+			return;
+		}
 
-        // make sure cpt ref is unique.
-        if (isset(self::$_registry[ $cpt_ref ])) {
-            $cpt_ref = uniqid() . '_' . $cpt_ref;
-        }
+		// make sure cpt ref is unique.
+		if (isset(self::$_registry[ $cpt_ref ])) {
+			$cpt_ref = uniqid() . '_' . $cpt_ref;
+		}
 
-        // make sure this was called in the right place!
-        if (did_action('AHEE__EE_System__load_CPTs_and_session__complete')) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    __(
-                        'EE_Register_CPT has been called and given a reference of "%s".  It may or may not work because it should be called on or before "AHEE__EE_System__load_CPTs_and_session__complete" action hook.',
-                        'event_espresso'
-                    ),
-                    $cpt_ref
-                ),
-                '4.5.0'
-            );
-        }
-        // validate incoming args
-        $validated = array(
-            'cpts'          => isset($setup_args['cpts'])
-                ? (array) $setup_args['cpts']
-                : array(),
-            'cts'           => isset($setup_args['cts'])
-                ? (array) $setup_args['cts']
-                : array(),
-            'default_terms' => isset($setup_args['default_terms'])
-                ? (array) $setup_args['default_terms']
-                : array(),
-        );
+		// make sure this was called in the right place!
+		if (did_action('AHEE__EE_System__load_CPTs_and_session__complete')) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					__(
+						'EE_Register_CPT has been called and given a reference of "%s".  It may or may not work because it should be called on or before "AHEE__EE_System__load_CPTs_and_session__complete" action hook.',
+						'event_espresso'
+					),
+					$cpt_ref
+				),
+				'4.5.0'
+			);
+		}
+		// validate incoming args
+		$validated = array(
+			'cpts'          => isset($setup_args['cpts'])
+				? (array) $setup_args['cpts']
+				: array(),
+			'cts'           => isset($setup_args['cts'])
+				? (array) $setup_args['cts']
+				: array(),
+			'default_terms' => isset($setup_args['default_terms'])
+				? (array) $setup_args['default_terms']
+				: array(),
+		);
 
-        self::$_registry[ $cpt_ref ] = $validated;
+		self::$_registry[ $cpt_ref ] = $validated;
 
-        // hook into to cpt system
-        add_filter(
-            'FHEE__EventEspresso_core_domain_entities_custom_post_types_CustomPostTypeDefinitions__getCustomPostTypes',
-            array(__CLASS__, 'filterCustomPostTypeDefinitions'),
-            5
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_entities_custom_post_types_TaxonomyDefinitions__getTaxonomies',
-            array(__CLASS__, 'filterCustomTaxonomyDefinitions'),
-            5
-        );
-        add_action(
-            'AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end',
-            array(__CLASS__, 'registerCustomTaxonomyTerm'),
-            5
-        );
-    }
+		// hook into to cpt system
+		add_filter(
+			'FHEE__EventEspresso_core_domain_entities_custom_post_types_CustomPostTypeDefinitions__getCustomPostTypes',
+			array(__CLASS__, 'filterCustomPostTypeDefinitions'),
+			5
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_entities_custom_post_types_TaxonomyDefinitions__getTaxonomies',
+			array(__CLASS__, 'filterCustomTaxonomyDefinitions'),
+			5
+		);
+		add_action(
+			'AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end',
+			array(__CLASS__, 'registerCustomTaxonomyTerm'),
+			5
+		);
+	}
 
 
-    /**
-     * Callback for
-     * FHEE__EventEspresso_core_domain_entities_custom_post_types_CustomPostTypeDefinitions__getCustomPostTypes
-     * that adds additional custom post types to be registered.
-     *
-     * @param array $custom_post_type_definitions array of cpts that are already set
-     * @return array new array of cpts and their registration information
-     */
-    public static function filterCustomPostTypeDefinitions($custom_post_type_definitions)
-    {
-        foreach (self::$_registry as $registries) {
-            foreach ($registries['cpts'] as $cpt_name => $cpt_settings) {
-                $custom_post_type_definitions[ $cpt_name ] = $cpt_settings;
-            }
-        }
-        return $custom_post_type_definitions;
-    }
+	/**
+	 * Callback for
+	 * FHEE__EventEspresso_core_domain_entities_custom_post_types_CustomPostTypeDefinitions__getCustomPostTypes
+	 * that adds additional custom post types to be registered.
+	 *
+	 * @param array $custom_post_type_definitions array of cpts that are already set
+	 * @return array new array of cpts and their registration information
+	 */
+	public static function filterCustomPostTypeDefinitions($custom_post_type_definitions)
+	{
+		foreach (self::$_registry as $registries) {
+			foreach ($registries['cpts'] as $cpt_name => $cpt_settings) {
+				$custom_post_type_definitions[ $cpt_name ] = $cpt_settings;
+			}
+		}
+		return $custom_post_type_definitions;
+	}
 
 
-    /**
-     * Callback for
-     * FHEE__EventEspresso_core_domain_entities_custom_post_types_TaxonomyDefinitions__getTaxonomies
-     * that adds additional custom taxonomies to be registered.
-     *
-     * @param array $custom_taxonomy_definitions array of cts that are already set.
-     * @return array new array of cts and their registration information.
-     */
-    public static function filterCustomTaxonomyDefinitions($custom_taxonomy_definitions)
-    {
-        foreach (self::$_registry as $registries) {
-            foreach ($registries['cts'] as $ct_name => $ct_settings) {
-                $custom_taxonomy_definitions[ $ct_name ] = $ct_settings;
-            }
-        }
-        return $custom_taxonomy_definitions;
-    }
+	/**
+	 * Callback for
+	 * FHEE__EventEspresso_core_domain_entities_custom_post_types_TaxonomyDefinitions__getTaxonomies
+	 * that adds additional custom taxonomies to be registered.
+	 *
+	 * @param array $custom_taxonomy_definitions array of cts that are already set.
+	 * @return array new array of cts and their registration information.
+	 */
+	public static function filterCustomTaxonomyDefinitions($custom_taxonomy_definitions)
+	{
+		foreach (self::$_registry as $registries) {
+			foreach ($registries['cts'] as $ct_name => $ct_settings) {
+				$custom_taxonomy_definitions[ $ct_name ] = $ct_settings;
+			}
+		}
+		return $custom_taxonomy_definitions;
+	}
 
 
-    /**
-     * Callback for
-     * AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end
-     * which is used to set the default terms
-     *
-     * @param RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms
-     * @return void
-     */
-    public static function registerCustomTaxonomyTerm(RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms)
-    {
-        foreach (self::$_registry as $registries) {
-            foreach ($registries['default_terms'] as $taxonomy => $terms) {
-                foreach ($terms as $term => $cpts) {
-                    $register_custom_taxonomy_terms->registerCustomTaxonomyTerm(
-                        $taxonomy,
-                        $term,
-                        $cpts
-                    );
-                }
-            }
-        }
-    }
+	/**
+	 * Callback for
+	 * AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end
+	 * which is used to set the default terms
+	 *
+	 * @param RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms
+	 * @return void
+	 */
+	public static function registerCustomTaxonomyTerm(RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms)
+	{
+		foreach (self::$_registry as $registries) {
+			foreach ($registries['default_terms'] as $taxonomy => $terms) {
+				foreach ($terms as $term => $cpts) {
+					$register_custom_taxonomy_terms->registerCustomTaxonomyTerm(
+						$taxonomy,
+						$term,
+						$cpts
+					);
+				}
+			}
+		}
+	}
 
 
-    /**
-     * @deprecated 4.9.62.p
-     * @param array $cpts array of cpts that are already set
-     * @return array new array of cpts and their registration information
-     */
-    public static function filter_cpts($cpts)
-    {
-        foreach (self::$_registry as $registries) {
-            foreach ($registries['cpts'] as $cpt_name => $cpt_settings) {
-                $cpts[ $cpt_name ] = $cpt_settings;
-            }
-        }
-        return $cpts;
-    }
+	/**
+	 * @deprecated 4.9.62.p
+	 * @param array $cpts array of cpts that are already set
+	 * @return array new array of cpts and their registration information
+	 */
+	public static function filter_cpts($cpts)
+	{
+		foreach (self::$_registry as $registries) {
+			foreach ($registries['cpts'] as $cpt_name => $cpt_settings) {
+				$cpts[ $cpt_name ] = $cpt_settings;
+			}
+		}
+		return $cpts;
+	}
 
 
-    /**
-     * @deprecated 4.9.62.p
-     * @param array $cts array of cts that are already set.
-     * @return array new array of cts and their registration information.
-     */
-    public static function filter_cts($cts)
-    {
-        foreach (self::$_registry as $registries) {
-            foreach ($registries['cts'] as $ct_name => $ct_settings) {
-                $cts[ $ct_name ] = $ct_settings;
-            }
-        }
-        return $cts;
-    }
+	/**
+	 * @deprecated 4.9.62.p
+	 * @param array $cts array of cts that are already set.
+	 * @return array new array of cts and their registration information.
+	 */
+	public static function filter_cts($cts)
+	{
+		foreach (self::$_registry as $registries) {
+			foreach ($registries['cts'] as $ct_name => $ct_settings) {
+				$cts[ $ct_name ] = $ct_settings;
+			}
+		}
+		return $cts;
+	}
 
 
-    /**
-     * @deprecated 4.9.62.p
-     * @param EE_Register_CPTs $cpt_class
-     * @return void
-     */
-    public static function default_terms(EE_Register_CPTs $cpt_class)
-    {
-        foreach (self::$_registry as $registries) {
-            foreach ($registries['default_terms'] as $taxonomy => $terms) {
-                foreach ($terms as $term => $cpts) {
-                    $cpt_class->set_default_term($taxonomy, $term, $cpts);
-                }
-            }
-        }
-    }
+	/**
+	 * @deprecated 4.9.62.p
+	 * @param EE_Register_CPTs $cpt_class
+	 * @return void
+	 */
+	public static function default_terms(EE_Register_CPTs $cpt_class)
+	{
+		foreach (self::$_registry as $registries) {
+			foreach ($registries['default_terms'] as $taxonomy => $terms) {
+				foreach ($terms as $term => $cpts) {
+					$cpt_class->set_default_term($taxonomy, $term, $cpts);
+				}
+			}
+		}
+	}
 
 
-    /**
-     * This deregisters whats been registered on this class (for the given slug).
-     *
-     * @since 4.5.0
-     *
-     * @param string $cpt_ref The reference for the item registered to be removed.
-     *
-     * @return void
-     */
-    public static function deregister($cpt_ref = null)
-    {
-        if (! empty(self::$_registry[ $cpt_ref ])) {
-            unset(self::$_registry[ $cpt_ref ]);
-        }
-    }
+	/**
+	 * This deregisters whats been registered on this class (for the given slug).
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string $cpt_ref The reference for the item registered to be removed.
+	 *
+	 * @return void
+	 */
+	public static function deregister($cpt_ref = null)
+	{
+		if (! empty(self::$_registry[ $cpt_ref ])) {
+			unset(self::$_registry[ $cpt_ref ]);
+		}
+	}
 }

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]);
         }
     }
 }