eventespresso / event-espresso-core

core/libraries/plugin_api/EE_Register_Personal_Data_Eraser.lib.php

Spacing +2 added lines, -2 removed lines

@@ -29,7 +29,7 @@ 
      */
     public static function register(string $addon_name = '', array $setup_args = []): bool
     {
-        self::$erasers[ $addon_name ] = $setup_args;
+        self::$erasers[$addon_name] = $setup_args;
         // add to list of modules to be registered
         add_filter(
             'FHEE__EventEspresso_core_services_privacy_erasure_PersonalDataEraserManager__erasers',
@@ -44,7 +44,7 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        unset(self::$erasers[ $addon_name ]);
+        unset(self::$erasers[$addon_name]);
     }
 
 

Indentation +39 added lines, -39 removed lines

@@ -12,51 +12,51 @@
  */
 class EE_Register_Personal_Data_Eraser implements EEI_Plugin_API
 {
-    /**
-     * FQCN for all privacy policy generators
-     *
-     * @var array keys are plugin_ids, and values are an array of FQCNs or FQCNs
-     */
-    protected static $erasers = [];
+	/**
+	 * FQCN for all privacy policy generators
+	 *
+	 * @var array keys are plugin_ids, and values are an array of FQCNs or FQCNs
+	 */
+	protected static $erasers = [];
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $setup_args can be the fully qualified namespaces each containing only privacy policies,
-     *                           OR fully qualified class names of privacy policies
-     * @return bool
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
-        self::$erasers[ $addon_name ] = $setup_args;
-        // add to list of modules to be registered
-        add_filter(
-            'FHEE__EventEspresso_core_services_privacy_erasure_PersonalDataEraserManager__erasers',
-            ['EE_Register_Personal_Data_Eraser', 'addErasers']
-        );
-        return true;
-    }
+	/**
+	 * @param string $addon_name
+	 * @param array  $setup_args can be the fully qualified namespaces each containing only privacy policies,
+	 *                           OR fully qualified class names of privacy policies
+	 * @return bool
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
+		self::$erasers[ $addon_name ] = $setup_args;
+		// add to list of modules to be registered
+		add_filter(
+			'FHEE__EventEspresso_core_services_privacy_erasure_PersonalDataEraserManager__erasers',
+			['EE_Register_Personal_Data_Eraser', 'addErasers']
+		);
+		return true;
+	}
 
 
-    /**
-     * @param string $addon_name
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        unset(self::$erasers[ $addon_name ]);
-    }
+	/**
+	 * @param string $addon_name
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		unset(self::$erasers[ $addon_name ]);
+	}
 
 
-    /**
-     * Adds our personal data erasers registered by add-ons
-     *
-     * @param string[] $erasers
-     * @return string[]
-     */
-    public static function addErasers(array $erasers): array
-    {
-        return array_merge($erasers, ...self::$erasers);
-    }
+	/**
+	 * Adds our personal data erasers registered by add-ons
+	 *
+	 * @param string[] $erasers
+	 * @return string[]
+	 */
+	public static function addErasers(array $erasers): array
+	{
+		return array_merge($erasers, ...self::$erasers);
+	}
 }
 // End of file EE_Register_Personal_Data_Eraser.lib.php
 // Location: ${NAMESPACE}/EE_Register_Personal_Data_Eraser.lib.php

core/libraries/plugin_api/EE_Register_Widget.lib.php

Spacing +3 added lines, -3 removed lines

@@ -48,7 +48,7 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_settings[ $addon_name ])) {
+        if (isset(self::$_settings[$addon_name])) {
             return true;
         }
 
@@ -68,7 +68,7 @@ 
             );
         }
         // setup $_settings array from incoming values.
-        self::$_settings[ $addon_name ] = [
+        self::$_settings[$addon_name] = [
             // 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'] : [],
         ];
@@ -109,6 +109,6 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        unset(self::$_settings[ $addon_name ]);
+        unset(self::$_settings[$addon_name]);
     }
 }

Indentation +86 added lines, -86 removed lines

@@ -14,100 +14,100 @@
  */
 class EE_Register_Widget implements EEI_Plugin_API
 {
-    /**
-     * Holds values for registered widgets
-     *
-     * @var array
-     */
-    protected static $_settings = [];
+	/**
+	 * Holds values for registered widgets
+	 *
+	 * @var array
+	 */
+	protected static $_settings = [];
 
 
-    /**
-     *    Method for registering new EED_Widgets
-     *
-     * @param string $addon_name 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
-     * @return bool
-     * @throws EE_Error
-     * @since    4.3.0
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
+	/**
+	 *    Method for registering new EED_Widgets
+	 *
+	 * @param string $addon_name 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
+	 * @return bool
+	 * @throws EE_Error
+	 * @since    4.3.0
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
 
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['widget_paths'])) {
-            throw new EE_Error(
-                esc_html__(
-                    '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($addon_name) || ! is_array($setup_args) || empty($setup_args['widget_paths'])) {
+			throw new EE_Error(
+				esc_html__(
+					'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[ $addon_name ])) {
-            return true;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_settings[ $addon_name ])) {
+			return true;
+		}
 
 
-        // 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 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[ $addon_name ] = [
-            // 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'] : [],
-        ];
-        // add to list of widgets to be registered
-        add_filter(
-            'FHEE__EE_Config__register_widgets__widgets_to_register',
-            ['EE_Register_Widget', 'add_widgets']
-        );
-        return true;
-    }
+		// 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 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[ $addon_name ] = [
+			// 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'] : [],
+		];
+		// add to list of widgets to be registered
+		add_filter(
+			'FHEE__EE_Config__register_widgets__widgets_to_register',
+			['EE_Register_Widget', 'add_widgets']
+		);
+		return true;
+	}
 
 
-    /**
-     * 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(array $widgets_to_register = []): array
-    {
-        $widget_paths = [];
-        foreach (self::$_settings as $settings) {
-            $widget_paths[] = $settings['widget_paths'];
-        }
-        return array_merge($widgets_to_register, ...$widget_paths);
-    }
+	/**
+	 * 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(array $widgets_to_register = []): array
+	{
+		$widget_paths = [];
+		foreach (self::$_settings as $settings) {
+			$widget_paths[] = $settings['widget_paths'];
+		}
+		return array_merge($widgets_to_register, ...$widget_paths);
+	}
 
 
-    /**
-     * This deregisters a widget that was previously registered with a specific $addon_name.
-     *
-     * @param string $addon_name the name for the widget that was previously registered
-     * @return void
-     * @since    4.3.0
-     *
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        unset(self::$_settings[ $addon_name ]);
-    }
+	/**
+	 * This deregisters a widget that was previously registered with a specific $addon_name.
+	 *
+	 * @param string $addon_name the name for the widget that was previously registered
+	 * @return void
+	 * @since    4.3.0
+	 *
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		unset(self::$_settings[ $addon_name ]);
+	}
 }

core/libraries/plugin_api/EE_Register_Messages_Shortcode_Library.lib.php

Spacing +9 added lines, -9 removed lines

@@ -65,7 +65,7 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_ee_messages_shortcode_registry[ $addon_name ])) {
+        if (isset(self::$_ee_messages_shortcode_registry[$addon_name])) {
             return true;
         }
 
@@ -87,7 +87,7 @@ 
             );
         }
 
-        self::$_ee_messages_shortcode_registry[ $addon_name ] = [
+        self::$_ee_messages_shortcode_registry[$addon_name] = [
             'autoloadpaths'        => (array) $setup_args['autoloadpaths'],
             'list_type_shortcodes' => ! empty($setup_args['list_type_shortcodes'])
                 ? (array) $setup_args['list_type_shortcodes'] : [],
@@ -101,19 +101,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',
                 ['EE_Register_Messages_Shortcode_Library', 'register_list_type_shortcodes'],
@@ -133,7 +133,7 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        unset(self::$_ee_messages_shortcode_registry[ $addon_name ]);
+        unset(self::$_ee_messages_shortcode_registry[$addon_name]);
     }
 
 
@@ -148,7 +148,7 @@ 
     public static function register_msgs_autoload_paths(array $paths): array
     {
         $autoload_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;
@@ -176,7 +176,7 @@ 
         }
         $shortcodes = [];
         foreach (self::$_ee_messages_shortcode_registry as $sc_reg) {
-            if (! empty($sc_reg['list_type_shortcodes'])) {
+            if ( ! empty($sc_reg['list_type_shortcodes'])) {
                 $shortcodes[] = $sc_reg['list_type_shortcodes'];
             }
         }

Indentation +170 added lines, -170 removed lines

@@ -10,174 +10,174 @@
  */
 class EE_Register_Messages_Shortcode_Library implements EEI_Plugin_API
 {
-    /**
-     * holds values for registered messages shortcode libraries
-     *
-     * @var array
-     */
-    protected static $_ee_messages_shortcode_registry = [];
-
-
-    /**
-     * Helper method for registering 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.
-     *
-     * @param string $addon_name    What is the name of this shortcode library (e.g. 'question_list');
-     * @param array  $setup_args    An array of arguments provided for registering the new messages shortcode library.
-     *                              {
-     *
-     * @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 bool
-     * @throws EE_Error
-     * @throws EE_Error
-     * @since    4.3.0
-     *
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
-
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['autoloadpaths'])) {
-            throw new EE_Error(
-                esc_html__(
-                    '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[ $addon_name ])) {
-            return true;
-        }
-
-        // 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(
-                    esc_html__(
-                        'Should be only called on the "EE_Brewing_Regular___messages_caf" hook (Trying to register a library named %s).',
-                        'event_espresso'
-                    ),
-                    $addon_name
-                ),
-                '4.3.0'
-            );
-        }
-
-        self::$_ee_messages_shortcode_registry[ $addon_name ] = [
-            'autoloadpaths'        => (array) $setup_args['autoloadpaths'],
-            'list_type_shortcodes' => ! empty($setup_args['list_type_shortcodes'])
-                ? (array) $setup_args['list_type_shortcodes'] : [],
-        ];
-
-        // add filters
-        add_filter(
-            'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
-            ['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',
-                ['EE_Register_Messages_Shortcode_Library', 'register_list_type_shortcodes'],
-                10
-            );
-        }
-        return true;
-    }
-
-
-    /**
-     * This deregisters any messages shortcode library previously registered with the given name.
-     *
-     * @param string $addon_name name used to register the shortcode library.
-     * @return  void
-     * @since    4.3.0
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        unset(self::$_ee_messages_shortcode_registry[ $addon_name ]);
-    }
-
-
-    /**
-     * callback for FHEE__EED_Messages___set_messages_paths___MSG_PATHS filter.
-     *
-     * @param array $paths array of paths to be checked by EE_messages autoloader.
-     * @return array
-     * @since    4.3.0
-     *
-     */
-    public static function register_msgs_autoload_paths(array $paths): array
-    {
-        $autoload_paths = [];
-        if (! empty(self::$_ee_messages_shortcode_registry)) {
-            foreach (self::$_ee_messages_shortcode_registry as $st_reg) {
-                if (empty($st_reg['autoloadpaths'])) {
-                    continue;
-                }
-                $autoload_paths[] = $st_reg['autoloadpaths'];
-            }
-        }
-        return array_merge($paths, ...$autoload_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.
-     *
-     * @param array $original_shortcodes
-     * @return  array                                   Modifications to original shortcodes.
-     * @since 4.3.0
-     *
-     */
-    public static function register_list_type_shortcodes(array $original_shortcodes): array
-    {
-        if (empty(self::$_ee_messages_shortcode_registry)) {
-            return $original_shortcodes;
-        }
-        $shortcodes = [];
-        foreach (self::$_ee_messages_shortcode_registry as $sc_reg) {
-            if (! empty($sc_reg['list_type_shortcodes'])) {
-                $shortcodes[] = $sc_reg['list_type_shortcodes'];
-            }
-        }
-        return array_merge($original_shortcodes, ...$shortcodes);
-    }
+	/**
+	 * holds values for registered messages shortcode libraries
+	 *
+	 * @var array
+	 */
+	protected static $_ee_messages_shortcode_registry = [];
+
+
+	/**
+	 * Helper method for registering 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.
+	 *
+	 * @param string $addon_name    What is the name of this shortcode library (e.g. 'question_list');
+	 * @param array  $setup_args    An array of arguments provided for registering the new messages shortcode library.
+	 *                              {
+	 *
+	 * @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 bool
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @since    4.3.0
+	 *
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
+
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['autoloadpaths'])) {
+			throw new EE_Error(
+				esc_html__(
+					'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[ $addon_name ])) {
+			return true;
+		}
+
+		// 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(
+					esc_html__(
+						'Should be only called on the "EE_Brewing_Regular___messages_caf" hook (Trying to register a library named %s).',
+						'event_espresso'
+					),
+					$addon_name
+				),
+				'4.3.0'
+			);
+		}
+
+		self::$_ee_messages_shortcode_registry[ $addon_name ] = [
+			'autoloadpaths'        => (array) $setup_args['autoloadpaths'],
+			'list_type_shortcodes' => ! empty($setup_args['list_type_shortcodes'])
+				? (array) $setup_args['list_type_shortcodes'] : [],
+		];
+
+		// add filters
+		add_filter(
+			'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
+			['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',
+				['EE_Register_Messages_Shortcode_Library', 'register_list_type_shortcodes'],
+				10
+			);
+		}
+		return true;
+	}
+
+
+	/**
+	 * This deregisters any messages shortcode library previously registered with the given name.
+	 *
+	 * @param string $addon_name name used to register the shortcode library.
+	 * @return  void
+	 * @since    4.3.0
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		unset(self::$_ee_messages_shortcode_registry[ $addon_name ]);
+	}
+
+
+	/**
+	 * callback for FHEE__EED_Messages___set_messages_paths___MSG_PATHS filter.
+	 *
+	 * @param array $paths array of paths to be checked by EE_messages autoloader.
+	 * @return array
+	 * @since    4.3.0
+	 *
+	 */
+	public static function register_msgs_autoload_paths(array $paths): array
+	{
+		$autoload_paths = [];
+		if (! empty(self::$_ee_messages_shortcode_registry)) {
+			foreach (self::$_ee_messages_shortcode_registry as $st_reg) {
+				if (empty($st_reg['autoloadpaths'])) {
+					continue;
+				}
+				$autoload_paths[] = $st_reg['autoloadpaths'];
+			}
+		}
+		return array_merge($paths, ...$autoload_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.
+	 *
+	 * @param array $original_shortcodes
+	 * @return  array                                   Modifications to original shortcodes.
+	 * @since 4.3.0
+	 *
+	 */
+	public static function register_list_type_shortcodes(array $original_shortcodes): array
+	{
+		if (empty(self::$_ee_messages_shortcode_registry)) {
+			return $original_shortcodes;
+		}
+		$shortcodes = [];
+		foreach (self::$_ee_messages_shortcode_registry as $sc_reg) {
+			if (! empty($sc_reg['list_type_shortcodes'])) {
+				$shortcodes[] = $sc_reg['list_type_shortcodes'];
+			}
+		}
+		return array_merge($original_shortcodes, ...$shortcodes);
+	}
 }

core/libraries/plugin_api/EE_Register_Data_Migration_Scripts.lib.php

Spacing +5 added lines, -5 removed lines

@@ -48,7 +48,7 @@ 
             );
         }
         // make sure we don't register twice
-        if (isset(self::$_settings[ $addon_name ])) {
+        if (isset(self::$_settings[$addon_name])) {
             return true;
         }
         // make sure this was called in the right place!
@@ -66,13 +66,13 @@ 
             );
         }
         // setup $_settings array from incoming values.
-        self::$_settings[ $addon_name ] = ['dms_paths' => (array) $setup_args['dms_paths']];
+        self::$_settings[$addon_name] = ['dms_paths' => (array) $setup_args['dms_paths']];
         // setup DMS
         $filters_set = has_filter(
             'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders',
             ['EE_Register_Data_Migration_Scripts', 'add_data_migration_script_folders']
         );
-        if (! $filters_set) {
+        if ( ! $filters_set) {
             add_filter(
                 'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders',
                 ['EE_Register_Data_Migration_Scripts', 'add_data_migration_script_folders']
@@ -96,7 +96,7 @@ 
                 // so if for some reason an addon has multiple dms paths,
                 // we append one or more * to the classname
                 // which will get stripped out later on
-                $dms_paths[ $addon_name . str_repeat('*', $wildcards) ] = $dms_path;
+                $dms_paths[$addon_name.str_repeat('*', $wildcards)] = $dms_path;
                 $wildcards++;
             }
         }
@@ -114,6 +114,6 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        unset(self::$_settings[ $addon_name ]);
+        unset(self::$_settings[$addon_name]);
     }
 }

Indentation +95 added lines, -95 removed lines

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

core/libraries/plugin_api/EE_Register_Privacy_Policy.lib.php

Spacing +2 added lines, -2 removed lines

@@ -29,7 +29,7 @@ 
      */
     public static function register(string $addon_name = '', array $setup_args = []): bool
     {
-        self::$privacy_policies[ $addon_name ] = $setup_args;
+        self::$privacy_policies[$addon_name] = $setup_args;
         // add to list of modules to be registered
         add_filter(
             'FHEE__EventEspresso_core_services_privacy_policy_PrivacyPolicyManager__privacy_policies',
@@ -44,7 +44,7 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        unset(self::$privacy_policies[ $addon_name ]);
+        unset(self::$privacy_policies[$addon_name]);
     }
 
 

Indentation +39 added lines, -39 removed lines

@@ -12,51 +12,51 @@
  */
 class EE_Register_Privacy_Policy implements EEI_Plugin_API
 {
-    /**
-     * FQCN for all privacy policy generators
-     *
-     * @var array keys are plugin_ids, and values are an array of FQCNs or FQCNs
-     */
-    protected static $privacy_policies = [];
+	/**
+	 * FQCN for all privacy policy generators
+	 *
+	 * @var array keys are plugin_ids, and values are an array of FQCNs or FQCNs
+	 */
+	protected static $privacy_policies = [];
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $setup_args can be the fully qualified namespaces each containing only privacy policies,
-     *                           OR fully qualified class names of privacy policies
-     * @return bool
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
-        self::$privacy_policies[ $addon_name ] = $setup_args;
-        // add to list of modules to be registered
-        add_filter(
-            'FHEE__EventEspresso_core_services_privacy_policy_PrivacyPolicyManager__privacy_policies',
-            ['EE_Register_Privacy_Policy', 'addPrivacyPolicies']
-        );
-        return true;
-    }
+	/**
+	 * @param string $addon_name
+	 * @param array  $setup_args can be the fully qualified namespaces each containing only privacy policies,
+	 *                           OR fully qualified class names of privacy policies
+	 * @return bool
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
+		self::$privacy_policies[ $addon_name ] = $setup_args;
+		// add to list of modules to be registered
+		add_filter(
+			'FHEE__EventEspresso_core_services_privacy_policy_PrivacyPolicyManager__privacy_policies',
+			['EE_Register_Privacy_Policy', 'addPrivacyPolicies']
+		);
+		return true;
+	}
 
 
-    /**
-     * @param string $addon_name
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        unset(self::$privacy_policies[ $addon_name ]);
-    }
+	/**
+	 * @param string $addon_name
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		unset(self::$privacy_policies[ $addon_name ]);
+	}
 
 
-    /**
-     * Adds our privacy policy generators registered by add-ons
-     *
-     * @param string[] $privacy_policies
-     * @return string[]
-     */
-    public static function addPrivacyPolicies(array $privacy_policies): array
-    {
-        return array_merge($privacy_policies, ...self::$privacy_policies);
-    }
+	/**
+	 * Adds our privacy policy generators registered by add-ons
+	 *
+	 * @param string[] $privacy_policies
+	 * @return string[]
+	 */
+	public static function addPrivacyPolicies(array $privacy_policies): array
+	{
+		return array_merge($privacy_policies, ...self::$privacy_policies);
+	}
 }
 // End of file EE_Register_Privacy_Policy.lib.php
 // Location: ${NAMESPACE}/EE_Register_Privacy_Policy.lib.php

core/libraries/plugin_api/EE_Register_Payment_Method.lib.php

Spacing +8 added lines, -8 removed lines

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

Indentation +151 added lines, -151 removed lines

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

core/libraries/plugin_api/EE_Register_Shortcode.lib.php

Spacing +6 added lines, -6 removed lines

@@ -60,7 +60,7 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_settings[ $addon_name ])) {
+        if (isset(self::$_settings[$addon_name])) {
             return true;
         }
 
@@ -79,7 +79,7 @@ 
             );
         }
         // setup $_settings array from incoming values.
-        self::$_settings[ $addon_name ] = [
+        self::$_settings[$addon_name] = [
             // 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']
@@ -136,9 +136,9 @@ 
         CollectionInterface $shortcodes_collection
     ): CollectionInterface {
         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__(
@@ -149,7 +149,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,
@@ -175,6 +175,6 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        unset(self::$_settings[ $addon_name ]);
+        unset(self::$_settings[$addon_name]);
     }
 }

Indentation +148 added lines, -148 removed lines

@@ -19,163 +19,163 @@
  */
 class EE_Register_Shortcode implements EEI_Plugin_API
 {
-    /**
-     * Holds values for registered shortcodes
-     *
-     * @var array
-     */
-    protected static $_settings = [];
+	/**
+	 * Holds values for registered shortcodes
+	 *
+	 * @var array
+	 */
+	protected static $_settings = [];
 
 
-    /**
-     *    Method for registering new EE_Shortcodes
-     *
-     * @param string $addon_name    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.
-     * @return bool
-     * @throws EE_Error
-     * @since    4.3.0
-     * @since    4.9.46.rc.025  for the new `shortcode_fqcns` array argument.
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (
-            empty($addon_name)
-            || ! 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
+	 *
+	 * @param string $addon_name    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.
+	 * @return bool
+	 * @throws EE_Error
+	 * @since    4.3.0
+	 * @since    4.9.46.rc.025  for the new `shortcode_fqcns` array argument.
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (
+			empty($addon_name)
+			|| ! 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[ $addon_name ])) {
-            return true;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_settings[ $addon_name ])) {
+			return true;
+		}
 
-        // 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[ $addon_name ] = [
-            // 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']
-                : [],
-            'shortcode_fqcns' => isset($setup_args['shortcode_fqcns'])
-                ? (array) $setup_args['shortcode_fqcns']
-                : [],
-        ];
-        // add to list of shortcodes to be registered
-        add_filter(
-            'FHEE__EE_Config__register_shortcodes__shortcodes_to_register',
-            ['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[ $addon_name ] = [
+			// 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']
+				: [],
+			'shortcode_fqcns' => isset($setup_args['shortcode_fqcns'])
+				? (array) $setup_args['shortcode_fqcns']
+				: [],
+		];
+		// add to list of shortcodes to be registered
+		add_filter(
+			'FHEE__EE_Config__register_shortcodes__shortcodes_to_register',
+			['EE_Register_Shortcode', 'add_shortcodes']
+		);
 
-        add_filter(
-            'FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection',
-            ['EE_Register_Shortcode', 'instantiateAndAddToShortcodeCollection']
-        );
-        return true;
-    }
+		add_filter(
+			'FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection',
+			['EE_Register_Shortcode', 'instantiateAndAddToShortcodeCollection']
+		);
+		return true;
+	}
 
 
-    /**
-     * 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(array $shortcodes_to_register): array
-    {
-        $shortcode_paths = [];
-        foreach (self::$_settings as $settings) {
-            $shortcode_paths[] = $settings['shortcode_paths'];
-        }
-        return array_merge($shortcodes_to_register, ...$shortcode_paths);
-    }
+	/**
+	 * 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(array $shortcodes_to_register): array
+	{
+		$shortcode_paths = [];
+		foreach (self::$_settings as $settings) {
+			$shortcode_paths[] = $settings['shortcode_paths'];
+		}
+		return array_merge($shortcodes_to_register, ...$shortcode_paths);
+	}
 
 
-    /**
-     * 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 InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function instantiateAndAddToShortcodeCollection(
-        CollectionInterface $shortcodes_collection
-    ): CollectionInterface {
-        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,
-                            [
-                                '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 InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function instantiateAndAddToShortcodeCollection(
+		CollectionInterface $shortcodes_collection
+	): CollectionInterface {
+		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,
+							[
+								'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 $addon_name.
-     *
-     * @param string $addon_name the name for the shortcode that was previously registered
-     * @return void
-     * @since    4.3.0
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        unset(self::$_settings[ $addon_name ]);
-    }
+	/**
+	 * This deregisters a shortcode that was previously registered with a specific $addon_name.
+	 *
+	 * @param string $addon_name the name for the shortcode that was previously registered
+	 * @return void
+	 * @since    4.3.0
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		unset(self::$_settings[ $addon_name ]);
+	}
 }

core/libraries/plugin_api/EE_Register_Module.lib.php

Spacing +3 added lines, -3 removed lines

@@ -48,7 +48,7 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_settings[ $addon_name ])) {
+        if (isset(self::$_settings[$addon_name])) {
             return true;
         }
 
@@ -67,7 +67,7 @@ 
             );
         }
         // setup $_settings array from incoming values.
-        self::$_settings[ $addon_name ] = [
+        self::$_settings[$addon_name] = [
             // 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'] : [],
         ];
@@ -107,6 +107,6 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        unset(self::$_settings[ $addon_name ]);
+        unset(self::$_settings[$addon_name]);
     }
 }

Indentation +86 added lines, -86 removed lines

@@ -14,98 +14,98 @@
  */
 class EE_Register_Module implements EEI_Plugin_API
 {
-    /**
-     * Holds values for registered modules
-     *
-     * @var array
-     */
-    protected static $_settings = [];
+	/**
+	 * Holds values for registered modules
+	 *
+	 * @var array
+	 */
+	protected static $_settings = [];
 
 
-    /**
-     *    Method for registering new EED_Modules
-     *
-     * @param string $addon_name 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
-     * @return bool
-     * @throws EE_Error
-     * @since    4.3.0
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['module_paths'])) {
-            throw new EE_Error(
-                esc_html__(
-                    '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'
-                )
-            );
-        }
+	/**
+	 *    Method for registering new EED_Modules
+	 *
+	 * @param string $addon_name 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
+	 * @return bool
+	 * @throws EE_Error
+	 * @since    4.3.0
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['module_paths'])) {
+			throw new EE_Error(
+				esc_html__(
+					'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[ $addon_name ])) {
-            return true;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_settings[ $addon_name ])) {
+			return true;
+		}
 
-        // make sure this was called in the right place!
-        if (
-            ! did_action('AHEE__EE_System__load_espresso_addons')
-            || did_action('AHEE__EE_System__register_shortcodes_modules_and_widgets')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                esc_html__(
-                    'An attempt to register modules has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__register_shortcodes_modules_and_widgets" hook to register modules.',
-                    'event_espresso'
-                ),
-                '4.3.0'
-            );
-        }
-        // setup $_settings array from incoming values.
-        self::$_settings[ $addon_name ] = [
-            // 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'] : [],
-        ];
-        // add to list of modules to be registered
-        add_filter(
-            'FHEE__EE_Config__register_modules__modules_to_register',
-            ['EE_Register_Module', 'add_modules']
-        );
-        return true;
-    }
+		// make sure this was called in the right place!
+		if (
+			! did_action('AHEE__EE_System__load_espresso_addons')
+			|| did_action('AHEE__EE_System__register_shortcodes_modules_and_widgets')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				esc_html__(
+					'An attempt to register modules has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__register_shortcodes_modules_and_widgets" hook to register modules.',
+					'event_espresso'
+				),
+				'4.3.0'
+			);
+		}
+		// setup $_settings array from incoming values.
+		self::$_settings[ $addon_name ] = [
+			// 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'] : [],
+		];
+		// add to list of modules to be registered
+		add_filter(
+			'FHEE__EE_Config__register_modules__modules_to_register',
+			['EE_Register_Module', 'add_modules']
+		);
+		return true;
+	}
 
 
-    /**
-     * 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(array $modules_to_register): array
-    {
-        $module_paths = [];
-        foreach (self::$_settings as $settings) {
-            $module_paths[] = $settings['module_paths'];
-        }
-        return array_merge($modules_to_register, ...$module_paths);
-    }
+	/**
+	 * 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(array $modules_to_register): array
+	{
+		$module_paths = [];
+		foreach (self::$_settings as $settings) {
+			$module_paths[] = $settings['module_paths'];
+		}
+		return array_merge($modules_to_register, ...$module_paths);
+	}
 
 
-    /**
-     * This deregisters a module that was previously registered with a specific $addon_name.
-     *
-     * @param string $addon_name the name for the module that was previously registered
-     * @return void
-     * @since    4.3.0
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        unset(self::$_settings[ $addon_name ]);
-    }
+	/**
+	 * This deregisters a module that was previously registered with a specific $addon_name.
+	 *
+	 * @param string $addon_name the name for the module that was previously registered
+	 * @return void
+	 * @since    4.3.0
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		unset(self::$_settings[ $addon_name ]);
+	}
 }

core/db_classes/EE_Form_Section.class.php

Spacing +6 added lines, -6 removed lines

@@ -101,7 +101,7 @@ 
      */
     public function setUUID(string $UUID)
     {
-        if (! Cuid::isCuid($UUID)) {
+        if ( ! Cuid::isCuid($UUID)) {
             throw new InvalidArgumentException(
                 sprintf(
                     /* translators: 1: UUID value, 2: UUID generator function. */
@@ -177,7 +177,7 @@ 
      */
     public function attributes(): ?Attributes
     {
-        if (! $this->attributes instanceof Attributes) {
+        if ( ! $this->attributes instanceof Attributes) {
             $this->attributes = Attributes::fromJson($this->get('FSC_attributes'));
         }
         return $this->attributes;
@@ -243,7 +243,7 @@ 
         $form_elements = $this->get_many_related('Form_Element', ['order_by' => ['FIN_order' => 'ASC']]);
         foreach ($form_elements as $form_element) {
             if ($form_element instanceof EE_Form_Element) {
-                $this->form_elements[ $form_element->UUID() ] = $form_element;
+                $this->form_elements[$form_element->UUID()] = $form_element;
             }
         }
         return $this->form_elements;
@@ -260,7 +260,7 @@ 
         foreach ($form_elements as $form_element) {
             if ($form_element instanceof EE_Form_Element) {
                 $this->_add_relation_to($form_element->UUID(), 'Form_Element');
-                $this->form_elements[ $form_element->UUID() ] = $form_element;
+                $this->form_elements[$form_element->UUID()] = $form_element;
             }
         }
     }
@@ -291,7 +291,7 @@ 
     public function formElementFilter(): Closure
     {
         $FSC_UUID = strtolower($this->UUID());
-        return function ($form_element) use ($FSC_UUID) {
+        return function($form_element) use ($FSC_UUID) {
             return $form_element instanceof EE_Form_Element && strtolower($form_element->belongsTo()) === $FSC_UUID;
         };
     }
@@ -306,7 +306,7 @@ 
      */
     public function label(): ?FormLabel
     {
-        if (! $this->label instanceof FormLabel) {
+        if ( ! $this->label instanceof FormLabel) {
             $this->label = FormLabel::fromJson($this->get('FSC_label'));
         }
         return $this->label;

Indentation +490 added lines, -490 removed lines

@@ -25,494 +25,494 @@
  */
 class EE_Form_Section extends EE_Base_Class
 {
-    /**
-     * @var Attributes
-     */
-    private $attributes;
-
-    /**
-     * @var EE_Form_Element[]
-     */
-    private $form_elements = [];
-
-    /**
-     * @var FormLabel
-     */
-    private $label;
-
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Form_Section
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance(array $props_n_values = []): EE_Form_Section
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ?: new self($props_n_values);
-    }
-
-
-    /**
-     * @param array $props_n_values
-     * @return EE_Form_Section
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function new_instance_from_db(array $props_n_values = []): EE_Form_Section
-    {
-        return new self($props_n_values, true);
-    }
-
-
-    /**
-     * Form Section UUID (universally unique identifier)
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function UUID(): string
-    {
-        return $this->get('FSC_UUID');
-    }
-
-
-    /**
-     * last 8 characters of the UUID
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function uuidSlug(): string
-    {
-        return substr($this->UUID(), -8);
-    }
-
-
-    /**
-     * @param string $UUID
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setUUID(string $UUID)
-    {
-        if (! Cuid::isCuid($UUID)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    /* translators: 1: UUID value, 2: UUID generator function. */
-                    esc_html__(
-                        'The supplied UUID "%1$s" is invalid or missing. Please use %2$s to generate a valid one.',
-                        'event_espresso'
-                    ),
-                    $UUID,
-                    "`Cuid::cuid()`"
-                )
-            );
-        }
-        $this->set('FSC_UUID', $UUID);
-    }
-
-
-    /**
-     * Form user types that this form section should be presented to.
-     * Values correspond to the EEM_Form_Section::APPLIES_TO_* constants.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function appliesTo(): string
-    {
-        return $this->get('FSC_appliesTo');
-    }
-
-
-    /**
-     * Form user types that this form section should be presented to.
-     * Values correspond to the EEM_Form_Section::APPLIES_TO_* constants.
-     *
-     * @param EE_Registration|string $registrant
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function appliesToRegistrant($registrant): bool
-    {
-        switch ($this->appliesTo()) {
-            case EEM_Form_Section::APPLIES_TO_PRIMARY:
-                return $registrant instanceof EE_Registration && $registrant->is_primary_registrant();
-            case EEM_Form_Section::APPLIES_TO_PURCHASER:
-                return $registrant === 'purchaser';
-            case EEM_Form_Section::APPLIES_TO_REGISTRANTS:
-                return $registrant instanceof EE_Registration && ! $registrant->is_primary_registrant();
-            case EEM_Form_Section::APPLIES_TO_ALL:
-            default:
-                return true;
-        }
-    }
-
-
-    /**
-     * @param string $user_type
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setAppliesTo(string $user_type)
-    {
-        $this->set('FSC_appliesTo', $user_type);
-    }
-
-
-    /**
-     * JSON string of HTML attributes, such as class, to be applied to this form section\'s container.
-     *
-     * @return Attributes
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function attributes(): ?Attributes
-    {
-        if (! $this->attributes instanceof Attributes) {
-            $this->attributes = Attributes::fromJson($this->get('FSC_attributes'));
-        }
-        return $this->attributes;
-    }
-
-
-    /**
-     * @param Attributes $attributes
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setAttributes(Attributes $attributes)
-    {
-        // set local object
-        $this->attributes = $attributes;
-        // then pass to model as an array which will get converted to JSON by the model field
-        $this->set('FSC_attributes', $attributes->toArray());
-    }
-
-
-    /**
-     * UUID or ID of related entity this form section belongs to.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function belongsTo(): ?string
-    {
-        return $this->get('FSC_belongsTo');
-    }
-
-
-    /**
-     * @param string $parent_UUID
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setBelongsTo(string $parent_UUID)
-    {
-        $this->set('FSC_belongsTo', $parent_UUID);
-    }
-
-
-    /**
-     * @return EE_Form_Element[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function formElements(): array
-    {
-        return $this->form_elements ?: $this->getFormElements();
-    }
-
-
-    /**
-     * @return EE_Form_Element[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function getFormElements(): array
-    {
-        $form_elements = $this->get_many_related('Form_Element', ['order_by' => ['FIN_order' => 'ASC']]);
-        foreach ($form_elements as $form_element) {
-            if ($form_element instanceof EE_Form_Element) {
-                $this->form_elements[ $form_element->UUID() ] = $form_element;
-            }
-        }
-        return $this->form_elements;
-    }
-
-
-    /**
-     * @param EE_Form_Element[] $form_elements
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setFormElements(array $form_elements): void
-    {
-        foreach ($form_elements as $form_element) {
-            if ($form_element instanceof EE_Form_Element) {
-                $this->_add_relation_to($form_element->UUID(), 'Form_Element');
-                $this->form_elements[ $form_element->UUID() ] = $form_element;
-            }
-        }
-    }
-
-
-    /**
-     * @param EE_Form_Element[] $all_form_elements
-     * @return EE_Form_Element[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function filterFormElements(array $all_form_elements): array
-    {
-        return array_filter($all_form_elements, $this->formElementFilter());
-    }
-
-
-    /**
-     * returns a closure that can be used to filter form elements for this form section
-     * usage:
-     *  $filter = EEM_Form_Element::formElementFilter();
-     *  $filtered_form_elements = array_filter( $all_form_elements, $filter );
-     *
-     * @return Closure
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function formElementFilter(): Closure
-    {
-        $FSC_UUID = strtolower($this->UUID());
-        return function ($form_element) use ($FSC_UUID) {
-            return $form_element instanceof EE_Form_Element && strtolower($form_element->belongsTo()) === $FSC_UUID;
-        };
-    }
-
-
-    /**
-     * returns a FormLabel object for managing form section labels, ie: the form section heading
-     *
-     * @return FormLabel
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function label(): ?FormLabel
-    {
-        if (! $this->label instanceof FormLabel) {
-            $this->label = FormLabel::fromJson($this->get('FSC_label'));
-        }
-        return $this->label;
-    }
-
-
-    /**
-     * @param FormLabel $label
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setLabel(FormLabel $label)
-    {
-        // set local object
-        $this->label = $label;
-        // then pass to model as an array which will get converted to JSON by the model field
-        $this->set('FSC_label', $label->toJson());
-    }
-
-
-    /**
-     * Order in which form section appears in a form.
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function order(): int
-    {
-        return $this->get('FSC_order');
-    }
-
-
-    /**
-     * @param int $order
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setOrder(int $order)
-    {
-        $this->set('FSC_order', $order);
-    }
-
-
-    /**
-     * combination of public label and UUID slug for use in identifiers
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function slug(): ?string
-    {
-        $label = sanitize_title($this->label()->publicLabel());
-        return "{$label}-{$this->uuidSlug()}";
-    }
-
-
-    /**
-     * Whether form section is active, archived, trashed, or used as a default on new forms.
-     * Values correspond to the EEM_Form_Section::STATUS_* constants.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function status(): ?string
-    {
-        return $this->get('FSC_status');
-    }
-
-
-    /**
-     * Whether form section is active, archived, trashed, or used as a default on new forms.
-     * Values correspond to the EEM_Form_Section::STATUS_* constants.
-     *
-     * @param string $status
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setStatus(string $status)
-    {
-        $this->set('FSC_status', $status);
-    }
-
-
-    /**
-     * returns the id the wordpress user who created this question
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function wp_user(): int
-    {
-        return $this->get('FSC_wpUser');
-    }
-
-
-    /**
-     * @param int $wp_user
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function setWpUser(int $wp_user)
-    {
-        $this->set('FSC_wpUser', $wp_user);
-    }
-
-
-    /**
-     * @param array $set_cols_n_values
-     * @return bool|int|string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function save($set_cols_n_values = [])
-    {
-        // make sure internal versions for all composite objects are updated
-        $this->set('FSC_attributes', $this->attributes()->toArray());
-        $this->set('FSC_label', $this->label()->toArray());
-        return parent::save($set_cols_n_values);
-    }
-
-    /**
-     * Whether the section is active.
-     *
-     * @return boolean  TRUE if is active, FALSE if not.
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function isActive(): bool
-    {
-        return $this->status() === FormStatus::ACTIVE;
-    }
-
-    /**
-     * Whether the section is archived.
-     *
-     * @return boolean  TRUE if is archived, FALSE if not.
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function isArchived(): bool
-    {
-        return $this->status() === FormStatus::ARCHIVED;
-    }
-
-    /**
-     * Whether the section is a default one.
-     *
-     * @return boolean  TRUE if is default, FALSE if not.
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function isDefault(): bool
-    {
-        return $this->status() === FormStatus::DEFAULT;
-    }
-
-    /**
-     * Whether the section is a shared one.
-     *
-     * @return boolean  TRUE if is shared, FALSE if not.
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function isShared(): bool
-    {
-        return $this->status() === FormStatus::SHARED;
-    }
-
-    /**
-     * Whether the section is trashed.
-     *
-     * @return boolean  TRUE if is trashed, FALSE if not.
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function isTrashed(): bool
-    {
-        return $this->status() === FormStatus::TRASHED;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function isTopLevelFormSection(): bool
-    {
-        return empty($this->belongsTo());
-    }
+	/**
+	 * @var Attributes
+	 */
+	private $attributes;
+
+	/**
+	 * @var EE_Form_Element[]
+	 */
+	private $form_elements = [];
+
+	/**
+	 * @var FormLabel
+	 */
+	private $label;
+
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Form_Section
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance(array $props_n_values = []): EE_Form_Section
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ?: new self($props_n_values);
+	}
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Form_Section
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function new_instance_from_db(array $props_n_values = []): EE_Form_Section
+	{
+		return new self($props_n_values, true);
+	}
+
+
+	/**
+	 * Form Section UUID (universally unique identifier)
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function UUID(): string
+	{
+		return $this->get('FSC_UUID');
+	}
+
+
+	/**
+	 * last 8 characters of the UUID
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function uuidSlug(): string
+	{
+		return substr($this->UUID(), -8);
+	}
+
+
+	/**
+	 * @param string $UUID
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setUUID(string $UUID)
+	{
+		if (! Cuid::isCuid($UUID)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					/* translators: 1: UUID value, 2: UUID generator function. */
+					esc_html__(
+						'The supplied UUID "%1$s" is invalid or missing. Please use %2$s to generate a valid one.',
+						'event_espresso'
+					),
+					$UUID,
+					"`Cuid::cuid()`"
+				)
+			);
+		}
+		$this->set('FSC_UUID', $UUID);
+	}
+
+
+	/**
+	 * Form user types that this form section should be presented to.
+	 * Values correspond to the EEM_Form_Section::APPLIES_TO_* constants.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function appliesTo(): string
+	{
+		return $this->get('FSC_appliesTo');
+	}
+
+
+	/**
+	 * Form user types that this form section should be presented to.
+	 * Values correspond to the EEM_Form_Section::APPLIES_TO_* constants.
+	 *
+	 * @param EE_Registration|string $registrant
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function appliesToRegistrant($registrant): bool
+	{
+		switch ($this->appliesTo()) {
+			case EEM_Form_Section::APPLIES_TO_PRIMARY:
+				return $registrant instanceof EE_Registration && $registrant->is_primary_registrant();
+			case EEM_Form_Section::APPLIES_TO_PURCHASER:
+				return $registrant === 'purchaser';
+			case EEM_Form_Section::APPLIES_TO_REGISTRANTS:
+				return $registrant instanceof EE_Registration && ! $registrant->is_primary_registrant();
+			case EEM_Form_Section::APPLIES_TO_ALL:
+			default:
+				return true;
+		}
+	}
+
+
+	/**
+	 * @param string $user_type
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setAppliesTo(string $user_type)
+	{
+		$this->set('FSC_appliesTo', $user_type);
+	}
+
+
+	/**
+	 * JSON string of HTML attributes, such as class, to be applied to this form section\'s container.
+	 *
+	 * @return Attributes
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function attributes(): ?Attributes
+	{
+		if (! $this->attributes instanceof Attributes) {
+			$this->attributes = Attributes::fromJson($this->get('FSC_attributes'));
+		}
+		return $this->attributes;
+	}
+
+
+	/**
+	 * @param Attributes $attributes
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setAttributes(Attributes $attributes)
+	{
+		// set local object
+		$this->attributes = $attributes;
+		// then pass to model as an array which will get converted to JSON by the model field
+		$this->set('FSC_attributes', $attributes->toArray());
+	}
+
+
+	/**
+	 * UUID or ID of related entity this form section belongs to.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function belongsTo(): ?string
+	{
+		return $this->get('FSC_belongsTo');
+	}
+
+
+	/**
+	 * @param string $parent_UUID
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setBelongsTo(string $parent_UUID)
+	{
+		$this->set('FSC_belongsTo', $parent_UUID);
+	}
+
+
+	/**
+	 * @return EE_Form_Element[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function formElements(): array
+	{
+		return $this->form_elements ?: $this->getFormElements();
+	}
+
+
+	/**
+	 * @return EE_Form_Element[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function getFormElements(): array
+	{
+		$form_elements = $this->get_many_related('Form_Element', ['order_by' => ['FIN_order' => 'ASC']]);
+		foreach ($form_elements as $form_element) {
+			if ($form_element instanceof EE_Form_Element) {
+				$this->form_elements[ $form_element->UUID() ] = $form_element;
+			}
+		}
+		return $this->form_elements;
+	}
+
+
+	/**
+	 * @param EE_Form_Element[] $form_elements
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setFormElements(array $form_elements): void
+	{
+		foreach ($form_elements as $form_element) {
+			if ($form_element instanceof EE_Form_Element) {
+				$this->_add_relation_to($form_element->UUID(), 'Form_Element');
+				$this->form_elements[ $form_element->UUID() ] = $form_element;
+			}
+		}
+	}
+
+
+	/**
+	 * @param EE_Form_Element[] $all_form_elements
+	 * @return EE_Form_Element[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function filterFormElements(array $all_form_elements): array
+	{
+		return array_filter($all_form_elements, $this->formElementFilter());
+	}
+
+
+	/**
+	 * returns a closure that can be used to filter form elements for this form section
+	 * usage:
+	 *  $filter = EEM_Form_Element::formElementFilter();
+	 *  $filtered_form_elements = array_filter( $all_form_elements, $filter );
+	 *
+	 * @return Closure
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function formElementFilter(): Closure
+	{
+		$FSC_UUID = strtolower($this->UUID());
+		return function ($form_element) use ($FSC_UUID) {
+			return $form_element instanceof EE_Form_Element && strtolower($form_element->belongsTo()) === $FSC_UUID;
+		};
+	}
+
+
+	/**
+	 * returns a FormLabel object for managing form section labels, ie: the form section heading
+	 *
+	 * @return FormLabel
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function label(): ?FormLabel
+	{
+		if (! $this->label instanceof FormLabel) {
+			$this->label = FormLabel::fromJson($this->get('FSC_label'));
+		}
+		return $this->label;
+	}
+
+
+	/**
+	 * @param FormLabel $label
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setLabel(FormLabel $label)
+	{
+		// set local object
+		$this->label = $label;
+		// then pass to model as an array which will get converted to JSON by the model field
+		$this->set('FSC_label', $label->toJson());
+	}
+
+
+	/**
+	 * Order in which form section appears in a form.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function order(): int
+	{
+		return $this->get('FSC_order');
+	}
+
+
+	/**
+	 * @param int $order
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setOrder(int $order)
+	{
+		$this->set('FSC_order', $order);
+	}
+
+
+	/**
+	 * combination of public label and UUID slug for use in identifiers
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function slug(): ?string
+	{
+		$label = sanitize_title($this->label()->publicLabel());
+		return "{$label}-{$this->uuidSlug()}";
+	}
+
+
+	/**
+	 * Whether form section is active, archived, trashed, or used as a default on new forms.
+	 * Values correspond to the EEM_Form_Section::STATUS_* constants.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function status(): ?string
+	{
+		return $this->get('FSC_status');
+	}
+
+
+	/**
+	 * Whether form section is active, archived, trashed, or used as a default on new forms.
+	 * Values correspond to the EEM_Form_Section::STATUS_* constants.
+	 *
+	 * @param string $status
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setStatus(string $status)
+	{
+		$this->set('FSC_status', $status);
+	}
+
+
+	/**
+	 * returns the id the wordpress user who created this question
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function wp_user(): int
+	{
+		return $this->get('FSC_wpUser');
+	}
+
+
+	/**
+	 * @param int $wp_user
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function setWpUser(int $wp_user)
+	{
+		$this->set('FSC_wpUser', $wp_user);
+	}
+
+
+	/**
+	 * @param array $set_cols_n_values
+	 * @return bool|int|string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function save($set_cols_n_values = [])
+	{
+		// make sure internal versions for all composite objects are updated
+		$this->set('FSC_attributes', $this->attributes()->toArray());
+		$this->set('FSC_label', $this->label()->toArray());
+		return parent::save($set_cols_n_values);
+	}
+
+	/**
+	 * Whether the section is active.
+	 *
+	 * @return boolean  TRUE if is active, FALSE if not.
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function isActive(): bool
+	{
+		return $this->status() === FormStatus::ACTIVE;
+	}
+
+	/**
+	 * Whether the section is archived.
+	 *
+	 * @return boolean  TRUE if is archived, FALSE if not.
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function isArchived(): bool
+	{
+		return $this->status() === FormStatus::ARCHIVED;
+	}
+
+	/**
+	 * Whether the section is a default one.
+	 *
+	 * @return boolean  TRUE if is default, FALSE if not.
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function isDefault(): bool
+	{
+		return $this->status() === FormStatus::DEFAULT;
+	}
+
+	/**
+	 * Whether the section is a shared one.
+	 *
+	 * @return boolean  TRUE if is shared, FALSE if not.
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function isShared(): bool
+	{
+		return $this->status() === FormStatus::SHARED;
+	}
+
+	/**
+	 * Whether the section is trashed.
+	 *
+	 * @return boolean  TRUE if is trashed, FALSE if not.
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function isTrashed(): bool
+	{
+		return $this->status() === FormStatus::TRASHED;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function isTopLevelFormSection(): bool
+	{
+		return empty($this->belongsTo());
+	}
 }