eventespresso / event-espresso-core

core/libraries/plugin_api/EE_Register_Message_Type.lib.php

Indentation +453 added lines, -453 removed lines

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

core/libraries/plugin_api/EE_Register_Capabilities.lib.php

Indentation +206 added lines, -206 removed lines

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

Spacing +10 added lines, -10 removed lines

@@ -64,7 +64,7 @@ 
             );
         }
         // make sure we don't register twice
-        if (isset(self::$_registry[ $addon_name ])) {
+        if (isset(self::$_registry[$addon_name])) {
             return true;
         }
         // make sure this is not registered too late or too early.
@@ -86,7 +86,7 @@ 
             return false;
         }
         // some preliminary sanitization and setting to the $_registry property
-        self::$_registry[ $addon_name ] = [
+        self::$_registry[$addon_name] = [
             'caps'     => isset($setup_args['capabilities']) && is_array($setup_args['capabilities'])
                 ? $setup_args['capabilities']
                 : [],
@@ -137,7 +137,7 @@ 
     {
         // loop through and instantiate cap maps.
         foreach (self::$_registry as $addon_name => $setup) {
-            if (! isset($setup['cap_maps'])) {
+            if ( ! isset($setup['cap_maps'])) {
                 continue;
             }
             foreach ($setup['cap_maps'] as $cap_class => $args) {
@@ -166,10 +166,10 @@ 
                  */
                 if (is_numeric($cap_class)) {
                     $cap_class = key($args);
-                    $args      = $args[ $cap_class ];
+                    $args      = $args[$cap_class];
                 }
 
-                if (! class_exists($cap_class)) {
+                if ( ! class_exists($cap_class)) {
                     throw new EE_Error(
                         sprintf(
                             esc_html__(
@@ -207,17 +207,17 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        if (! empty(self::$_registry[ $addon_name ])) {
-            if (! empty(self::$_registry[ $addon_name ]['caps'])) {
+        if ( ! empty(self::$_registry[$addon_name])) {
+            if ( ! empty(self::$_registry[$addon_name]['caps'])) {
                 // if it's too early to remove capabilities, wait to do this until core is loaded and ready
-                $caps_to_remove = self::$_registry[ $addon_name ]['caps'];
+                $caps_to_remove = self::$_registry[$addon_name]['caps'];
                 if (did_action('AHEE__EE_System__core_loaded_and_ready')) {
                     $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
                     $capabilities->removeCaps($caps_to_remove);
                 } else {
                     add_action(
                         'AHEE__EE_System__core_loaded_and_ready',
-                        function () use ($caps_to_remove) {
+                        function() use ($caps_to_remove) {
                             $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
                             $capabilities->removeCaps($caps_to_remove);
                         }
@@ -225,7 +225,7 @@ 
                 }
             }
         }
-        unset(self::$_registry[ $addon_name ]);
+        unset(self::$_registry[$addon_name]);
     }
 
     public static function reset(): void

core/libraries/plugin_api/EE_Register_Payment_Method.lib.php

Indentation +155 added lines, -155 removed lines

@@ -18,169 +18,169 @@
  */
 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;
+	}
 
 
-    public static function reset(): void
-    {
-        self::$_settings = [];
-    }
+	public static function reset(): void
+	{
+		self::$_settings = [];
+	}
 }

core/libraries/plugin_api/EE_Register_Personal_Data_Exporter.lib.php

Indentation +43 added lines, -43 removed lines

@@ -12,57 +12,57 @@
  */
 class EE_Register_Personal_Data_Exporter 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 $exporters = [];
+	/**
+	 * FQCN for all privacy policy generators
+	 *
+	 * @var array keys are plugin_ids, and values are an array of FQCNs or FQCNs
+	 */
+	protected static $exporters = [];
 
 
-    /**
-     * @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::$exporters[ $addon_name ] = $setup_args;
-        // add to list of modules to be registered
-        add_filter(
-            'FHEE__EventEspresso_core_services_privacy_export_PersonalDataExporterManager__exporters',
-            ['EE_Register_Personal_Data_Exporter', 'addExporters']
-        );
-        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::$exporters[ $addon_name ] = $setup_args;
+		// add to list of modules to be registered
+		add_filter(
+			'FHEE__EventEspresso_core_services_privacy_export_PersonalDataExporterManager__exporters',
+			['EE_Register_Personal_Data_Exporter', 'addExporters']
+		);
+		return true;
+	}
 
 
-    /**
-     * @param string $addon_name
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        unset(self::$exporters[ $addon_name ]);
-    }
+	/**
+	 * @param string $addon_name
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		unset(self::$exporters[ $addon_name ]);
+	}
 
 
-    /**
-     * Adds our personal data exporters registered by add-ons
-     *
-     * @param string[] $exporters
-     * @return string[]
-     */
-    public static function addExporters(array $exporters): array
-    {
-        return array_merge($exporters, ...self::$exporters);
-    }
+	/**
+	 * Adds our personal data exporters registered by add-ons
+	 *
+	 * @param string[] $exporters
+	 * @return string[]
+	 */
+	public static function addExporters(array $exporters): array
+	{
+		return array_merge($exporters, ...self::$exporters);
+	}
 
 
-    public static function reset(): void
-    {
-        self::$exporters = [];
-    }
+	public static function reset(): void
+	{
+		self::$exporters = [];
+	}
 }
 // End of file EE_Register_Personal_Data_Exporter.lib.php
 // Location: ${NAMESPACE}/EE_Register_Personal_Data_Exporter.lib.php

core/libraries/plugin_api/EE_Register_Shortcode.lib.php

Indentation +152 added lines, -152 removed lines

@@ -19,169 +19,169 @@
  */
 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 ]);
+	}
 
 
-    public static function reset(): void
-    {
-        self::$_settings = [];
-    }
+	public static function reset(): void
+	{
+		self::$_settings = [];
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -61,7 +61,7 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_settings[ $addon_name ])) {
+        if (isset(self::$_settings[$addon_name])) {
             return true;
         }
 
@@ -80,7 +80,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']
@@ -137,9 +137,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__(
@@ -150,7 +150,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,
@@ -176,7 +176,7 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        unset(self::$_settings[ $addon_name ]);
+        unset(self::$_settings[$addon_name]);
     }
 
 

core/libraries/plugin_api/EEI_Plugin_API.lib.php

Indentation +22 added lines, -22 removed lines

@@ -17,30 +17,30 @@
  */
 interface EEI_Plugin_API
 {
-    /**
-     * Used to register a component with EE.
-     *
-     * @param string $addon_name a unique name for the component being registered
-     * @param array  $setup_args an array of key value pairs of info for registering the component
-     * @return bool
-     * @since 4.3.0
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool;
+	/**
+	 * Used to register a component with EE.
+	 *
+	 * @param string $addon_name a unique name for the component being registered
+	 * @param array  $setup_args an array of key value pairs of info for registering the component
+	 * @return bool
+	 * @since 4.3.0
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool;
 
 
-    /**
-     * Used to deregister a component with EE.
-     *
-     * @param string $addon_name a unique name for the component being registered
-     * @return void
-     * @since 4.3.0
-     */
-    public static function deregister(string $addon_name = '');
+	/**
+	 * Used to deregister a component with EE.
+	 *
+	 * @param string $addon_name a unique name for the component being registered
+	 * @return void
+	 * @since 4.3.0
+	 */
+	public static function deregister(string $addon_name = '');
 
 
-    /**
-     * @return void
-     * @since 5.0.8.p
-     */
-    public static function reset(): void;
+	/**
+	 * @return void
+	 * @since 5.0.8.p
+	 */
+	public static function reset(): void;
 }

core/libraries/plugin_api/EE_Register_Model_Extensions.lib.php

Indentation +130 added lines, -130 removed lines

@@ -11,144 +11,144 @@
  */
 class EE_Register_Model_Extensions implements EEI_Plugin_API
 {
-    protected static $_registry;
+	protected static $_registry;
 
-    protected static $_extensions = [];
+	protected static $_extensions = [];
 
 
-    /**
-     * register method for setting up model extensions
-     *
-     * @param string $addon_name            unique id for the extensions being setup
-     * @param array  $setup_args            {
-     * @return bool
-     * @throws EE_Error
-     * @type  array  $model_extension_paths array of folders containing DB model extensions, where each file follows
-     *                                      the models naming convention, which is:
-     *                                      EEME_{your_plugin_slug}_model_name_extended}.model_ext.php.
-     *                                      Where {your_plugin_slug} is really anything you want (but something having
-     *                                      to do with your addon, like 'Calendar' or '3D_View') and
-     *                                      model_name_extended} is the model extended.
-     *                                      The class contained in teh file should extend
-     *                                      EEME_Base_{model_name_extended}.model_ext.php.
-     *                                      Where {your_plugin_slug} is really anything you want (but something
-     *                                      having to do with your addon, like 'Calendar' or '3D_View') and
-     *                                      {model_name_extended} is the model extended. The class contained in teh
-     *                                      file should extend EEME_Base
-     * @type array   $class_extension_paths array of folders containing DB class extensions, where each file follows
-     *                                      the model class extension naming convention, which is:
-     *                                      EEE_{your_plugin_slug}_model_name_extended}.class_ext.php.
-     *                                      Where {your_plugin_slug} is something like 'Calendar','MailChimp',etc,
-     *                                      and model_name_extended} is the name of the model extended, eg
-     *                                      'Attendee','Event',etc.
-     *                                      The class contained in the file should extend EEE_Base_Class
-     *                                      ._{model_name_extended}.class_ext.php.
-     *                                      Where {your_plugin_slug} is something like 'Calendar','MailChimp',etc,
-     *                                      and {model_name_extended} is the name of the model extended, eg
-     *                                      'Attendee','Event',etc. The class contained in the file should extend
-     *                                      EEE_Base_Class.
-     *                                      }
-     *
-     */
-    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['model_extension_paths'])
-                && empty($setup_args['class_extension_paths'])
-            )
-        ) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register Model extensions with EE_Register_Model_Extensions::register(), you must include a "model_id" (a unique identifier for this set of models), and an array containing the following keys: "model_extension_paths" (an array of full server paths to folders that contain model extensions), and "class_extension_paths" (an array of full server paths to folders that contain class extensions)',
-                    'event_espresso'
-                )
-            );
-        }
+	/**
+	 * register method for setting up model extensions
+	 *
+	 * @param string $addon_name            unique id for the extensions being setup
+	 * @param array  $setup_args            {
+	 * @return bool
+	 * @throws EE_Error
+	 * @type  array  $model_extension_paths array of folders containing DB model extensions, where each file follows
+	 *                                      the models naming convention, which is:
+	 *                                      EEME_{your_plugin_slug}_model_name_extended}.model_ext.php.
+	 *                                      Where {your_plugin_slug} is really anything you want (but something having
+	 *                                      to do with your addon, like 'Calendar' or '3D_View') and
+	 *                                      model_name_extended} is the model extended.
+	 *                                      The class contained in teh file should extend
+	 *                                      EEME_Base_{model_name_extended}.model_ext.php.
+	 *                                      Where {your_plugin_slug} is really anything you want (but something
+	 *                                      having to do with your addon, like 'Calendar' or '3D_View') and
+	 *                                      {model_name_extended} is the model extended. The class contained in teh
+	 *                                      file should extend EEME_Base
+	 * @type array   $class_extension_paths array of folders containing DB class extensions, where each file follows
+	 *                                      the model class extension naming convention, which is:
+	 *                                      EEE_{your_plugin_slug}_model_name_extended}.class_ext.php.
+	 *                                      Where {your_plugin_slug} is something like 'Calendar','MailChimp',etc,
+	 *                                      and model_name_extended} is the name of the model extended, eg
+	 *                                      'Attendee','Event',etc.
+	 *                                      The class contained in the file should extend EEE_Base_Class
+	 *                                      ._{model_name_extended}.class_ext.php.
+	 *                                      Where {your_plugin_slug} is something like 'Calendar','MailChimp',etc,
+	 *                                      and {model_name_extended} is the name of the model extended, eg
+	 *                                      'Attendee','Event',etc. The class contained in the file should extend
+	 *                                      EEE_Base_Class.
+	 *                                      }
+	 *
+	 */
+	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['model_extension_paths'])
+				&& empty($setup_args['class_extension_paths'])
+			)
+		) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register Model extensions with EE_Register_Model_Extensions::register(), you must include a "model_id" (a unique identifier for this set of models), and an array containing the following keys: "model_extension_paths" (an array of full server paths to folders that contain model extensions), and "class_extension_paths" (an array of full server paths to folders that contain class extensions)',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_registry[ $addon_name ])) {
-            return true;
-        }
-        // check correct loading
-        if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    esc_html__(
-                        'An attempt was made to register "%1$s" as a Model extension has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register models.%2$s Hook Status: %2$s "AHEE__EE_System__load_espresso_addons" : %3$s %2$s "AHEE__EE_Admin__loaded" : %4$s%2$s',
-                        'event_espresso'
-                    ),
-                    $addon_name,
-                    '<br />',
-                    did_action('AHEE__EE_System__load_espresso_addons') ? 'action done' : 'action NOT done',
-                    did_action('AHEE__EE_Admin__loaded') ? 'action done' : 'action NOT done'
-                ),
-                '4.3'
-            );
-            return false;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_registry[ $addon_name ])) {
+			return true;
+		}
+		// check correct loading
+		if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					esc_html__(
+						'An attempt was made to register "%1$s" as a Model extension has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register models.%2$s Hook Status: %2$s "AHEE__EE_System__load_espresso_addons" : %3$s %2$s "AHEE__EE_Admin__loaded" : %4$s%2$s',
+						'event_espresso'
+					),
+					$addon_name,
+					'<br />',
+					did_action('AHEE__EE_System__load_espresso_addons') ? 'action done' : 'action NOT done',
+					did_action('AHEE__EE_Admin__loaded') ? 'action done' : 'action NOT done'
+				),
+				'4.3'
+			);
+			return false;
+		}
 
-        self::$_registry[ $addon_name ]   = $setup_args;
-        self::$_extensions[ $addon_name ] = [];
+		self::$_registry[ $addon_name ]   = $setup_args;
+		self::$_extensions[ $addon_name ] = [];
 
-        if (isset($setup_args['model_extension_paths'])) {
-            require_once(EE_LIBRARIES . 'plugin_api/db/EEME_Base.lib.php');
-            $class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['model_extension_paths']);
-            // remove all files that are not PHP
-            foreach ($class_to_filepath_map as $class => $path) {
-                if (substr($path, strlen($path) - 3) !== 'php') {
-                    unset($class_to_filepath_map[ $class ]);
-                }
-            }
-            EEH_Autoloader::register_autoloader($class_to_filepath_map);
-            foreach (array_keys($class_to_filepath_map) as $classname) {
-                self::$_extensions[ $addon_name ]['models'][ $classname ] = new $classname();
-            }
-            unset($setup_args['model_extension_paths']);
-        }
-        if (isset($setup_args['class_extension_paths'])) {
-            require_once(EE_LIBRARIES . 'plugin_api/db/EEE_Base_Class.lib.php');
-            $class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['class_extension_paths']);
-            EEH_Autoloader::register_autoloader($class_to_filepath_map);
-            foreach (array_keys($class_to_filepath_map) as $classname) {
-                self::$_extensions[ $addon_name ]['classes'][ $classname ] = new $classname();
-            }
-            unset($setup_args['class_extension_paths']);
-        }
-        foreach ($setup_args as $unknown_key => $unknown_config) {
-            throw new EE_Error(
-                sprintf(esc_html__("The key '%s' is not a known key for registering a model", "event_espresso"), $unknown_key)
-            );
-        }
-        return true;
-    }
+		if (isset($setup_args['model_extension_paths'])) {
+			require_once(EE_LIBRARIES . 'plugin_api/db/EEME_Base.lib.php');
+			$class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['model_extension_paths']);
+			// remove all files that are not PHP
+			foreach ($class_to_filepath_map as $class => $path) {
+				if (substr($path, strlen($path) - 3) !== 'php') {
+					unset($class_to_filepath_map[ $class ]);
+				}
+			}
+			EEH_Autoloader::register_autoloader($class_to_filepath_map);
+			foreach (array_keys($class_to_filepath_map) as $classname) {
+				self::$_extensions[ $addon_name ]['models'][ $classname ] = new $classname();
+			}
+			unset($setup_args['model_extension_paths']);
+		}
+		if (isset($setup_args['class_extension_paths'])) {
+			require_once(EE_LIBRARIES . 'plugin_api/db/EEE_Base_Class.lib.php');
+			$class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['class_extension_paths']);
+			EEH_Autoloader::register_autoloader($class_to_filepath_map);
+			foreach (array_keys($class_to_filepath_map) as $classname) {
+				self::$_extensions[ $addon_name ]['classes'][ $classname ] = new $classname();
+			}
+			unset($setup_args['class_extension_paths']);
+		}
+		foreach ($setup_args as $unknown_key => $unknown_config) {
+			throw new EE_Error(
+				sprintf(esc_html__("The key '%s' is not a known key for registering a model", "event_espresso"), $unknown_key)
+			);
+		}
+		return true;
+	}
 
 
-    /**
-     * deregister
-     *
-     * @param string $addon_name
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        if (isset(self::$_registry[ $addon_name ])) {
-            unset(self::$_registry[ $addon_name ]);
-            foreach (self::$_extensions[ $addon_name ] as $extension_of_type) {
-                foreach ($extension_of_type as $extension) {
-                    $extension->deregister();
-                }
-            }
-        }
-    }
+	/**
+	 * deregister
+	 *
+	 * @param string $addon_name
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		if (isset(self::$_registry[ $addon_name ])) {
+			unset(self::$_registry[ $addon_name ]);
+			foreach (self::$_extensions[ $addon_name ] as $extension_of_type) {
+				foreach ($extension_of_type as $extension) {
+					$extension->deregister();
+				}
+			}
+		}
+	}
 
 
-    public static function reset(): void
-    {
-        self::$_registry = [];
-        self::$_extensions = [];
-    }
+	public static function reset(): void
+	{
+		self::$_registry = [];
+		self::$_extensions = [];
+	}
 }

core/libraries/plugin_api/EE_Register_Personal_Data_Eraser.lib.php

Indentation +43 added lines, -43 removed lines

@@ -12,57 +12,57 @@
  */
 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);
+	}
 
 
-    public static function reset(): void
-    {
-        self::$erasers = [];
-    }
+	public static function reset(): void
+	{
+		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_CPT.lib.php

Indentation +233 added lines, -233 removed lines

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

Spacing +10 added lines, -10 removed lines

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