eventespresso / event-espresso-core

core/libraries/plugin_api/EE_Register_Capabilities.lib.php

Indentation +198 added lines, -198 removed lines

@@ -15,213 +15,213 @@
 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 $identifier                                                          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 void
-     * @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($identifier = '', array $setup_args = [])
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if ($identifier === null || ! is_array($setup_args) || empty($setup_args['capabilities'])) {
-            throw new EE_Error(
-                __(
-                    'In order to register capabilities with EE_Register_Capabilities::register, you must include a unique name to reference the capabilities being registered, plus an array containing the following keys: "capabilities".',
-                    'event_espresso'
-                )
-            );
-        }
-        // make sure we don't register twice
-        if (isset(self::$_registry[ $identifier ])) {
-            return;
-        }
-        // make sure this is not registered too late or too early.
-        if (! did_action('AHEE__EE_System__load_espresso_addons')
-            || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    __(
-                        '%s has been registered too late.  Please ensure that EE_Register_Capabilities::register has been called at some point before the "AHEE__EE_System___detect_if_activation_or_upgrade__begin" action hook has been called.',
-                        'event_espresso'
-                    ),
-                    $identifier
-                ),
-                '4.5.0'
-            );
-        }
-        // some preliminary sanitization and setting to the $_registry property
-        self::$_registry[ $identifier ] = [
-            'caps'     => isset($setup_args['capabilities']) && is_array($setup_args['capabilities'])
-                ? $setup_args['capabilities']
-                : [],
-            'cap_maps' => isset($setup_args['capability_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']
-        );
-    }
+	/**
+	 * Used to register capability items with EE core.
+	 *
+	 * @param string $identifier                                                          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 void
+	 * @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($identifier = '', array $setup_args = [])
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if ($identifier === null || ! is_array($setup_args) || empty($setup_args['capabilities'])) {
+			throw new EE_Error(
+				__(
+					'In order to register capabilities with EE_Register_Capabilities::register, you must include a unique name to reference the capabilities being registered, plus an array containing the following keys: "capabilities".',
+					'event_espresso'
+				)
+			);
+		}
+		// make sure we don't register twice
+		if (isset(self::$_registry[ $identifier ])) {
+			return;
+		}
+		// make sure this is not registered too late or too early.
+		if (! did_action('AHEE__EE_System__load_espresso_addons')
+			|| did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					__(
+						'%s has been registered too late.  Please ensure that EE_Register_Capabilities::register has been called at some point before the "AHEE__EE_System___detect_if_activation_or_upgrade__begin" action hook has been called.',
+						'event_espresso'
+					),
+					$identifier
+				),
+				'4.5.0'
+			);
+		}
+		// some preliminary sanitization and setting to the $_registry property
+		self::$_registry[ $identifier ] = [
+			'caps'     => isset($setup_args['capabilities']) && is_array($setup_args['capabilities'])
+				? $setup_args['capabilities']
+				: [],
+			'cap_maps' => isset($setup_args['capability_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']
+		);
+	}
 
 
-    /**
-     * 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)
-    {
-        foreach (self::$_registry as $caps_and_cap_map) {
-            $incoming_caps = array_merge_recursive($incoming_caps, $caps_and_cap_map['caps']);
-        }
-        return $incoming_caps;
-    }
+	/**
+	 * callback for FHEE__EE_Capabilities__init_caps_map__caps filter.
+	 * Takes care of registering additional capabilities to the caps map.   Note, that this also on the initial
+	 * registration ensures that new capabilities are added to existing roles.
+	 *
+	 * @param array $incoming_caps The original caps map.
+	 * @return array merged in new caps.
+	 */
+	public static function register_capabilities(array $incoming_caps)
+	{
+		foreach (self::$_registry as $caps_and_cap_map) {
+			$incoming_caps = array_merge_recursive($incoming_caps, $caps_and_cap_map['caps']);
+		}
+		return $incoming_caps;
+	}
 
 
-    /**
-     * Callback for the 'FHEE__EE_Capabilities___set_meta_caps__meta_caps' filter which registers an array of
-     * capability maps for the WP meta_caps filter called in EE_Capabilities.
-     *
-     * @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)
-    {
-        // loop through and instantiate cap maps.
-        foreach (self::$_registry as $identifier => $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)
+	{
+		// loop through and instantiate cap maps.
+		foreach (self::$_registry as $identifier => $setup) {
+			if (! isset($setup['cap_maps'])) {
+				continue;
+			}
+			foreach ($setup['cap_maps'] as $cap_class => $args) {
 
-                /**
-                 * account for cases where capability maps may be indexed
-                 * numerically to allow for the same map class to be utilized
-                 * In those cases, maps will be setup in an array like:
-                 * array(
-                 *    0 => array( 'EE_Meta_Capability' => array(
-                 *        'ee_edit_cap', array( 'Object_Name',
-                 *        'ee_edit_published_cap',
-                 *        'ee_edit_others_cap', 'ee_edit_private_cap' )
-                 *        ) )
-                 *    1 => ...
-                 * )
-                 * instead of:
-                 * array(
-                 *    'EE_Meta_Capability' => array(
-                 *        'ee_edit_cap', array( 'Object_Name',
-                 *        'ee_edit_published_cap',
-                 *        'ee_edit_others_cap', 'ee_edit_private_cap' )
-                 *        ),
-                 *    ...
-                 * )
-                 */
-                if (is_numeric($cap_class)) {
-                    $cap_class = key($args);
-                    $args      = $args[ $cap_class ];
-                }
+				/**
+				 * account for cases where capability maps may be indexed
+				 * numerically to allow for the same map class to be utilized
+				 * In those cases, maps will be setup in an array like:
+				 * array(
+				 *    0 => array( 'EE_Meta_Capability' => array(
+				 *        'ee_edit_cap', array( 'Object_Name',
+				 *        'ee_edit_published_cap',
+				 *        'ee_edit_others_cap', 'ee_edit_private_cap' )
+				 *        ) )
+				 *    1 => ...
+				 * )
+				 * instead of:
+				 * array(
+				 *    'EE_Meta_Capability' => array(
+				 *        'ee_edit_cap', array( 'Object_Name',
+				 *        'ee_edit_published_cap',
+				 *        'ee_edit_others_cap', 'ee_edit_private_cap' )
+				 *        ),
+				 *    ...
+				 * )
+				 */
+				if (is_numeric($cap_class)) {
+					$cap_class = key($args);
+					$args      = $args[ $cap_class ];
+				}
 
-                if (! class_exists($cap_class)) {
-                    throw new EE_Error(
-                        sprintf(
-                            __(
-                                'An addon (%s) has tried to register a capability map improperly.  Capability map arrays must be indexed by capability map classname, and an array for the class arguments',
-                                'event_espresso'
-                            ),
-                            $identifier
-                        )
-                    );
-                }
+				if (! class_exists($cap_class)) {
+					throw new EE_Error(
+						sprintf(
+							__(
+								'An addon (%s) has tried to register a capability map improperly.  Capability map arrays must be indexed by capability map classname, and an array for the class arguments',
+								'event_espresso'
+							),
+							$identifier
+						)
+					);
+				}
 
-                if (count($args) !== 2) {
-                    throw new EE_Error(
-                        sprintf(
-                            __(
-                                'An addon (%s) has tried to register a capability map improperly.  Capability map arrays must be indexed by capability map classname, and an array for the class arguments.  The array should have two values the first being a string and the second an array.',
-                                'event_espresso'
-                            ),
-                            $identifier
-                        )
-                    );
-                }
-                $cap_maps[] = new $cap_class($args[0], $args[1]);
-            }
-        }
-        return $cap_maps;
-    }
+				if (count($args) !== 2) {
+					throw new EE_Error(
+						sprintf(
+							__(
+								'An addon (%s) has tried to register a capability map improperly.  Capability map arrays must be indexed by capability map classname, and an array for the class arguments.  The array should have two values the first being a string and the second an array.',
+								'event_espresso'
+							),
+							$identifier
+						)
+					);
+				}
+				$cap_maps[] = new $cap_class($args[0], $args[1]);
+			}
+		}
+		return $cap_maps;
+	}
 
 
-    /**
-     * @param string $identifier
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function deregister($identifier = '')
-    {
-        if (! empty(self::$_registry[ $identifier ])) {
-            if (! empty(self::$_registry[ $identifier ]['caps'])) {
-                // if it's too early to remove capabilities, wait to do this until core is loaded and ready
-                $caps_to_remove = self::$_registry[ $identifier ]['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[ $identifier ]);
-    }
+	/**
+	 * @param string $identifier
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function deregister($identifier = '')
+	{
+		if (! empty(self::$_registry[ $identifier ])) {
+			if (! empty(self::$_registry[ $identifier ]['caps'])) {
+				// if it's too early to remove capabilities, wait to do this until core is loaded and ready
+				$caps_to_remove = self::$_registry[ $identifier ]['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[ $identifier ]);
+	}
 }

Spacing +11 added lines, -11 removed lines

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

core/libraries/plugin_api/EE_Register_Messages_Template_Variations.lib.php

Indentation +303 added lines, -303 removed lines

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

Spacing +16 added lines, -16 removed lines

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

core/libraries/plugin_api/EE_Register_Privacy_Policy.lib.php

Indentation +43 added lines, -43 removed lines

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

Spacing +2 added lines, -2 removed lines

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

core/libraries/plugin_api/EE_Register_Payment_Method.lib.php

Indentation +150 added lines, -150 removed lines

@@ -19,162 +19,162 @@
 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  $identifier           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 void
-     * @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($identifier = '', array $setup_args = [])
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($identifier) || ! 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[ $identifier ])) {
-            return;
-        }
-        // make sure this was called in the right place!
-        if (! did_action('AHEE__EE_System__load_espresso_addons')
-            || did_action('AHEE__EE_System__register_shortcodes_modules_and_widgets')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                esc_html__(
-                    'An attempt to register modules has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__register_shortcodes_modules_and_widgets" hook to register modules.',
-                    'event_espresso'
-                ),
-                '4.3.0'
-            );
-        }
-        // setup $_settings array from incoming values.
-        self::$_settings[ $identifier ] = [
-            // 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[ $identifier ]['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[ $identifier ])
-            );
-        }
-    }
+	/**
+	 * Method for registering new EE_PMT_Base children
+	 *
+	 * @param string  $identifier           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 void
+	 * @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($identifier = '', array $setup_args = [])
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($identifier) || ! 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[ $identifier ])) {
+			return;
+		}
+		// make sure this was called in the right place!
+		if (! did_action('AHEE__EE_System__load_espresso_addons')
+			|| did_action('AHEE__EE_System__register_shortcodes_modules_and_widgets')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				esc_html__(
+					'An attempt to register modules has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__register_shortcodes_modules_and_widgets" hook to register modules.',
+					'event_espresso'
+				),
+				'4.3.0'
+			);
+		}
+		// setup $_settings array from incoming values.
+		self::$_settings[ $identifier ] = [
+			// 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[ $identifier ]['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[ $identifier ])
+			);
+		}
+	}
 
 
-    /**
-     * 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)
-    {
-        foreach (self::$_settings as $settings) {
-            foreach ($settings['payment_method_paths'] as $payment_method_path) {
-                $payment_method_folders[] = $payment_method_path;
-            }
-        }
-        return $payment_method_folders;
-    }
+	/**
+	 * Filters the list of payment methods to add ours.
+	 * and they're just full filepaths to FOLDERS containing a payment method class file. Eg.
+	 *
+	 * @param array $payment_method_folders array of paths to all payment methods that require registering
+	 * @return array
+	 */
+	public static function add_payment_methods(array $payment_method_folders)
+	{
+		foreach (self::$_settings as $settings) {
+			foreach ($settings['payment_method_paths'] as $payment_method_path) {
+				$payment_method_folders[] = $payment_method_path;
+			}
+		}
+		return $payment_method_folders;
+	}
 
 
-    /**
-     * This deregisters a module that was previously registered with a specific $identifier.
-     *
-     * @param string $identifier 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($identifier = '')
-    {
-        if (isset(self::$_settings[ $identifier ])) {
-            // set action for just this module id to delay deregistration until core is loaded and ready.
-            $module_settings = self::$_settings[ $identifier ];
-            unset(self::$_settings[ $identifier ]);
-            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 $identifier.
+	 *
+	 * @param string $identifier 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($identifier = '')
+	{
+		if (isset(self::$_settings[ $identifier ])) {
+			// set action for just this module id to delay deregistration until core is loaded and ready.
+			$module_settings = self::$_settings[ $identifier ];
+			unset(self::$_settings[ $identifier ]);
+			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)
-    {
-        $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)
+	{
+		$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;
+	}
 }

Spacing +9 added lines, -9 removed lines

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

core/libraries/plugin_api/EE_Register_Model_Extensions.lib.php

Indentation +119 added lines, -119 removed lines

@@ -12,131 +12,131 @@
 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 $identifier            unique id for the extensions being setup
-     * @param array  $setup_args            {
-     * @return void
-     * @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($identifier = '', array $setup_args = [])
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($identifier)
-            || ! is_array($setup_args)
-            || (empty($setup_args['model_extension_paths']) && empty($setup_args['class_extension_paths']))
-        ) {
-            throw new EE_Error(
-                __(
-                    '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 $identifier            unique id for the extensions being setup
+	 * @param array  $setup_args            {
+	 * @return void
+	 * @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($identifier = '', array $setup_args = [])
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($identifier)
+			|| ! is_array($setup_args)
+			|| (empty($setup_args['model_extension_paths']) && empty($setup_args['class_extension_paths']))
+		) {
+			throw new EE_Error(
+				__(
+					'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[ $identifier ])) {
-            return;
-        }
-        // 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(
-                    __(
-                        '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'
-                    ),
-                    $identifier,
-                    '<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'
-            );
-        }
+		// make sure we don't register twice
+		if (isset(self::$_registry[ $identifier ])) {
+			return;
+		}
+		// 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(
+					__(
+						'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'
+					),
+					$identifier,
+					'<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'
+			);
+		}
 
-        self::$_registry[ $identifier ]   = $setup_args;
-        self::$_extensions[ $identifier ] = [];
+		self::$_registry[ $identifier ]   = $setup_args;
+		self::$_extensions[ $identifier ] = [];
 
-        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[ $identifier ]['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[ $identifier ]['classes'][ $classname ] = new $classname;
-            }
-            unset($setup_args['class_extension_paths']);
-        }
-        foreach ($setup_args as $unknown_key => $unknown_config) {
-            throw new EE_Error(
-                sprintf(__("The key '%s' is not a known key for registering a model", "event_espresso"), $unknown_key)
-            );
-        }
-    }
+		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[ $identifier ]['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[ $identifier ]['classes'][ $classname ] = new $classname;
+			}
+			unset($setup_args['class_extension_paths']);
+		}
+		foreach ($setup_args as $unknown_key => $unknown_config) {
+			throw new EE_Error(
+				sprintf(__("The key '%s' is not a known key for registering a model", "event_espresso"), $unknown_key)
+			);
+		}
+	}
 
 
-    /**
-     * deregister
-     *
-     * @param string $identifier
-     */
-    public static function deregister($identifier = '')
-    {
-        if (isset(self::$_registry[ $identifier ])) {
-            unset(self::$_registry[ $identifier ]);
-            foreach (self::$_extensions[ $identifier ] as $extension_of_type) {
-                foreach ($extension_of_type as $extension) {
-                    $extension->deregister();
-                }
-            }
-        }
-    }
+	/**
+	 * deregister
+	 *
+	 * @param string $identifier
+	 */
+	public static function deregister($identifier = '')
+	{
+		if (isset(self::$_registry[ $identifier ])) {
+			unset(self::$_registry[ $identifier ]);
+			foreach (self::$_extensions[ $identifier ] as $extension_of_type) {
+				foreach ($extension_of_type as $extension) {
+					$extension->deregister();
+				}
+			}
+		}
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -67,11 +67,11 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_registry[ $identifier ])) {
+        if (isset(self::$_registry[$identifier])) {
             return;
         }
         // check correct loading
-        if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
+        if ( ! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
             EE_Error::doing_it_wrong(
                 __METHOD__,
                 sprintf(
@@ -88,30 +88,30 @@ 
             );
         }
 
-        self::$_registry[ $identifier ]   = $setup_args;
-        self::$_extensions[ $identifier ] = [];
+        self::$_registry[$identifier]   = $setup_args;
+        self::$_extensions[$identifier] = [];
 
         if (isset($setup_args['model_extension_paths'])) {
-            require_once(EE_LIBRARIES . 'plugin_api/db/EEME_Base.lib.php');
+            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 ]);
+                    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[ $identifier ]['models'][ $classname ] = new $classname;
+                self::$_extensions[$identifier]['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');
+            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[ $identifier ]['classes'][ $classname ] = new $classname;
+                self::$_extensions[$identifier]['classes'][$classname] = new $classname;
             }
             unset($setup_args['class_extension_paths']);
         }
@@ -130,9 +130,9 @@ 
      */
     public static function deregister($identifier = '')
     {
-        if (isset(self::$_registry[ $identifier ])) {
-            unset(self::$_registry[ $identifier ]);
-            foreach (self::$_extensions[ $identifier ] as $extension_of_type) {
+        if (isset(self::$_registry[$identifier])) {
+            unset(self::$_registry[$identifier]);
+            foreach (self::$_extensions[$identifier] as $extension_of_type) {
                 foreach ($extension_of_type as $extension) {
                     $extension->deregister();
                 }

core/libraries/plugin_api/EE_Register_Shortcode.lib.php

Indentation +142 added lines, -142 removed lines

@@ -20,157 +20,157 @@
 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 $identifier    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 void
-     * @throws EE_Error
-     * @since    4.3.0
-     * @since    4.9.46.rc.025  for the new `shortcode_fqcns` array argument.
-     */
-    public static function register($identifier = '', array $setup_args = [])
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($identifier)
-            || ! 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 $identifier    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 void
+	 * @throws EE_Error
+	 * @since    4.3.0
+	 * @since    4.9.46.rc.025  for the new `shortcode_fqcns` array argument.
+	 */
+	public static function register($identifier = '', array $setup_args = [])
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($identifier)
+			|| ! 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[ $identifier ])) {
-            return;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_settings[ $identifier ])) {
+			return;
+		}
 
-        // make sure this was called in the right place!
-        if (! did_action('AHEE__EE_System__load_espresso_addons')
-            || did_action('AHEE__EE_System__register_shortcodes_modules_and_widgets')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                esc_html__(
-                    'An attempt to register shortcodes has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__register_shortcodes_modules_and_widgets" hook to register shortcodes.',
-                    'event_espresso'
-                ),
-                '4.3.0'
-            );
-        }
-        // setup $_settings array from incoming values.
-        self::$_settings[ $identifier ] = [
-            // 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[ $identifier ] = [
+			// 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']
-        );
-    }
+		add_filter(
+			'FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection',
+			['EE_Register_Shortcode', 'instantiateAndAddToShortcodeCollection']
+		);
+	}
 
 
-    /**
-     * Filters the list of shortcodes to add ours.
-     * and they're just full filepaths to FOLDERS containing a shortcode class file. Eg.
-     * array('espresso_monkey'=>'/public_html/wonder-site/wp-content/plugins/ee4/shortcodes/espresso_monkey'...)
-     *
-     * @param array $shortcodes_to_register array of paths to all shortcodes that require registering
-     * @return array
-     */
-    public static function add_shortcodes(array $shortcodes_to_register)
-    {
-        foreach (self::$_settings as $settings) {
-            $shortcodes_to_register = array_merge($shortcodes_to_register, $settings['shortcode_paths']);
-        }
-        return $shortcodes_to_register;
-    }
+	/**
+	 * Filters the list of shortcodes to add ours.
+	 * and they're just full filepaths to FOLDERS containing a shortcode class file. Eg.
+	 * array('espresso_monkey'=>'/public_html/wonder-site/wp-content/plugins/ee4/shortcodes/espresso_monkey'...)
+	 *
+	 * @param array $shortcodes_to_register array of paths to all shortcodes that require registering
+	 * @return array
+	 */
+	public static function add_shortcodes(array $shortcodes_to_register)
+	{
+		foreach (self::$_settings as $settings) {
+			$shortcodes_to_register = array_merge($shortcodes_to_register, $settings['shortcode_paths']);
+		}
+		return $shortcodes_to_register;
+	}
 
 
-    /**
-     * Hooks into
-     * FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection and
-     * registers any provided shortcode fully qualified class names.
-     *
-     * @param CollectionInterface $shortcodes_collection
-     * @return CollectionInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function instantiateAndAddToShortcodeCollection(CollectionInterface $shortcodes_collection)
-    {
-        foreach (self::$_settings as $settings) {
-            if (! empty($settings['shortcode_fqcns'])) {
-                foreach ($settings['shortcode_fqcns'] as $shortcode_fqcn) {
-                    if (! class_exists($shortcode_fqcn)) {
-                        throw new InvalidClassException(
-                            sprintf(
-                                esc_html__(
-                                    'Are you sure %s is the right fully qualified class name for the shortcode class?',
-                                    'event_espresso'
-                                ),
-                                $shortcode_fqcn
-                            )
-                        );
-                    }
-                    if (! EE_Dependency_Map::instance()->has_dependency_for_class($shortcode_fqcn)) {
-                        // register dependencies
-                        EE_Dependency_Map::register_dependencies(
-                            $shortcode_fqcn,
-                            [
-                                '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)
+	{
+		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 $identifier.
-     *
-     * @param string $identifier the name for the shortcode that was previously registered
-     * @return void
-     * @since    4.3.0
-     */
-    public static function deregister($identifier = '')
-    {
-        unset(self::$_settings[ $identifier ]);
-    }
+	/**
+	 * This deregisters a shortcode that was previously registered with a specific $identifier.
+	 *
+	 * @param string $identifier the name for the shortcode that was previously registered
+	 * @return void
+	 * @since    4.3.0
+	 */
+	public static function deregister($identifier = '')
+	{
+		unset(self::$_settings[ $identifier ]);
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -60,12 +60,12 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_settings[ $identifier ])) {
+        if (isset(self::$_settings[$identifier])) {
             return;
         }
 
         // make sure this was called in the right place!
-        if (! did_action('AHEE__EE_System__load_espresso_addons')
+        if ( ! did_action('AHEE__EE_System__load_espresso_addons')
             || did_action('AHEE__EE_System__register_shortcodes_modules_and_widgets')
         ) {
             EE_Error::doing_it_wrong(
@@ -78,7 +78,7 @@ 
             );
         }
         // setup $_settings array from incoming values.
-        self::$_settings[ $identifier ] = [
+        self::$_settings[$identifier] = [
             // 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']
@@ -132,9 +132,9 @@ 
     public static function instantiateAndAddToShortcodeCollection(CollectionInterface $shortcodes_collection)
     {
         foreach (self::$_settings as $settings) {
-            if (! empty($settings['shortcode_fqcns'])) {
+            if ( ! empty($settings['shortcode_fqcns'])) {
                 foreach ($settings['shortcode_fqcns'] as $shortcode_fqcn) {
-                    if (! class_exists($shortcode_fqcn)) {
+                    if ( ! class_exists($shortcode_fqcn)) {
                         throw new InvalidClassException(
                             sprintf(
                                 esc_html__(
@@ -145,7 +145,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,
@@ -171,6 +171,6 @@ 
      */
     public static function deregister($identifier = '')
     {
-        unset(self::$_settings[ $identifier ]);
+        unset(self::$_settings[$identifier]);
     }
 }

core/libraries/plugin_api/EEI_Plugin_API.lib.php

Indentation +17 added lines, -17 removed lines

@@ -18,23 +18,23 @@
 interface EEI_Plugin_API
 {
 
-    /**
-     * Used to register a component with EE.
-     *
-     * @param string $identifier 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 void
-     * @since 4.3.0
-     */
-    public static function register($identifier = '', array $setup_args = []);
+	/**
+	 * Used to register a component with EE.
+	 *
+	 * @param string $identifier 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 void
+	 * @since 4.3.0
+	 */
+	public static function register($identifier = '', array $setup_args = []);
 
 
-    /**
-     * Used to deregister a component with EE.
-     *
-     * @param string $identifier a unique name for the component being registered
-     * @return void
-     * @since 4.3.0
-     */
-    public static function deregister($identifier = '');
+	/**
+	 * Used to deregister a component with EE.
+	 *
+	 * @param string $identifier a unique name for the component being registered
+	 * @return void
+	 * @since 4.3.0
+	 */
+	public static function deregister($identifier = '');
 }

core/libraries/plugin_api/EE_Register_Messages_Template_Pack.lib.php

Indentation +197 added lines, -197 removed lines

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

Spacing +9 added lines, -9 removed lines

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

core/libraries/plugin_api/EE_Register_Config.lib.php

Indentation +98 added lines, -98 removed lines

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

Spacing +4 added lines, -4 removed lines

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