@@ -1,10 +1,10 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | 2 | /** |
| 3 | - * This file contains the EE_Register_Message_Type class that implements EEI_Plugin_API |
|
| 4 | - * @package Event Espresso |
|
| 5 | - * @subpackage plugin api, messages |
|
| 6 | - * @since 4.3.0 |
|
| 7 | - */ |
|
| 3 | + * This file contains the EE_Register_Message_Type class that implements EEI_Plugin_API |
|
| 4 | + * @package Event Espresso |
|
| 5 | + * @subpackage plugin api, messages |
|
| 6 | + * @since 4.3.0 |
|
| 7 | + */ |
|
| 8 | 8 | if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed'); |
| 9 | 9 | |
| 10 | 10 | /** |
@@ -251,14 +251,14 @@ discard block |
||
| 251 | 251 | |
| 252 | 252 | |
| 253 | 253 | /** |
| 254 | - * callback for FHEE__EE_messenger__get_valid_message_types__default_types filter. |
|
| 255 | - * |
|
| 256 | - * @since 4.3.0 |
|
| 257 | - * @param array $valid_types array of message types valid with messenger ( |
|
| 258 | - * corresponds to the $name property of message type) |
|
| 259 | - * @param EE_messenger $messenger The EE_messenger the filter is called from. |
|
| 260 | - * @return array |
|
| 261 | - */ |
|
| 254 | + * callback for FHEE__EE_messenger__get_valid_message_types__default_types filter. |
|
| 255 | + * |
|
| 256 | + * @since 4.3.0 |
|
| 257 | + * @param array $valid_types array of message types valid with messenger ( |
|
| 258 | + * corresponds to the $name property of message type) |
|
| 259 | + * @param EE_messenger $messenger The EE_messenger the filter is called from. |
|
| 260 | + * @return array |
|
| 261 | + */ |
|
| 262 | 262 | public static function register_messengers_to_validate_mt_with( $valid_types, EE_messenger $messenger ) { |
| 263 | 263 | if ( empty( self::$_ee_message_type_registry ) ) { |
| 264 | 264 | return $valid_types; |
@@ -50,79 +50,79 @@ discard block |
||
| 50 | 50 | * @throws \EE_Error |
| 51 | 51 | * } |
| 52 | 52 | */ |
| 53 | - public static function register( $mt_name = NULL, $setup_args = array() ) { |
|
| 53 | + public static function register($mt_name = NULL, $setup_args = array()) { |
|
| 54 | 54 | //required fields MUST be present, so let's make sure they are. |
| 55 | 55 | if ( |
| 56 | - ! isset( $mt_name ) |
|
| 57 | - || ! is_array( $setup_args ) |
|
| 58 | - || empty( $setup_args['mtfilename'] ) || empty( $setup_args['autoloadpaths'] ) |
|
| 59 | - ){ |
|
| 56 | + ! isset($mt_name) |
|
| 57 | + || ! is_array($setup_args) |
|
| 58 | + || empty($setup_args['mtfilename']) || empty($setup_args['autoloadpaths']) |
|
| 59 | + ) { |
|
| 60 | 60 | throw new EE_Error( |
| 61 | - __( 'In order to register a message type with EE_Register_Message_Type::register, you must include a unique name for the message type, plus an array containing the following keys: "mtfilename", "autoloadpaths"', 'event_espresso' ) |
|
| 61 | + __('In order to register a message type with EE_Register_Message_Type::register, you must include a unique name for the message type, plus an array containing the following keys: "mtfilename", "autoloadpaths"', 'event_espresso') |
|
| 62 | 62 | ); |
| 63 | 63 | } |
| 64 | 64 | |
| 65 | 65 | //make sure we don't register twice |
| 66 | - if( isset( self::$_ee_message_type_registry[ $mt_name ] ) ){ |
|
| 66 | + if (isset(self::$_ee_message_type_registry[$mt_name])) { |
|
| 67 | 67 | return; |
| 68 | 68 | } |
| 69 | 69 | |
| 70 | 70 | //make sure this was called in the right place! |
| 71 | 71 | if ( |
| 72 | - ! did_action( 'EE_Brewing_Regular___messages_caf' ) |
|
| 73 | - || did_action( 'AHEE__EE_System__perform_activations_upgrades_and_migrations' ) |
|
| 72 | + ! did_action('EE_Brewing_Regular___messages_caf') |
|
| 73 | + || did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations') |
|
| 74 | 74 | ) { |
| 75 | 75 | EE_Error::doing_it_wrong( |
| 76 | 76 | __METHOD__, |
| 77 | 77 | sprintf( |
| 78 | - __('A message type named "%s" has been attempted to be registered with the EE Messages System. It may or may not work because it should be only called on the "EE_Brewing_Regular___messages_caf" hook.','event_espresso'), |
|
| 78 | + __('A message type named "%s" has been attempted to be registered with the EE Messages System. It may or may not work because it should be only called on the "EE_Brewing_Regular___messages_caf" hook.', 'event_espresso'), |
|
| 79 | 79 | $mt_name |
| 80 | 80 | ), |
| 81 | 81 | '4.3.0' |
| 82 | 82 | ); |
| 83 | 83 | } |
| 84 | 84 | //setup $__ee_message_type_registry array from incoming values. |
| 85 | - self::$_ee_message_type_registry[ $mt_name ] = array( |
|
| 85 | + self::$_ee_message_type_registry[$mt_name] = array( |
|
| 86 | 86 | 'mtfilename' => (string) $setup_args['mtfilename'], |
| 87 | 87 | 'autoloadpaths' => (array) $setup_args['autoloadpaths'], |
| 88 | - 'messengers_to_activate_with' => ! empty( $setup_args['messengers_to_activate_with'] ) |
|
| 88 | + 'messengers_to_activate_with' => ! empty($setup_args['messengers_to_activate_with']) |
|
| 89 | 89 | ? (array) $setup_args['messengers_to_activate_with'] |
| 90 | 90 | : array(), |
| 91 | - 'messengers_to_validate_with' => ! empty( $setup_args['messengers_to_validate_with'] ) |
|
| 91 | + 'messengers_to_validate_with' => ! empty($setup_args['messengers_to_validate_with']) |
|
| 92 | 92 | ? (array) $setup_args['messengers_to_validate_with'] |
| 93 | 93 | : array(), |
| 94 | - 'force_activation' => ! empty( $setup_args['force_activation'] ) |
|
| 94 | + 'force_activation' => ! empty($setup_args['force_activation']) |
|
| 95 | 95 | ? (bool) $setup_args['force_activation'] |
| 96 | 96 | : array() |
| 97 | 97 | ); |
| 98 | 98 | //add filters |
| 99 | 99 | add_filter( |
| 100 | 100 | 'FHEE__EED_Messages___set_messages_paths___MSG_PATHS', |
| 101 | - array( 'EE_Register_Message_Type', 'register_msgs_autoload_paths' ), |
|
| 101 | + array('EE_Register_Message_Type', 'register_msgs_autoload_paths'), |
|
| 102 | 102 | 10 |
| 103 | 103 | ); |
| 104 | 104 | add_filter( |
| 105 | 105 | 'FHEE__EE_messages__get_installed__messagetype_files', |
| 106 | - array( 'EE_Register_Message_Type', 'register_messagetype_files' ), |
|
| 106 | + array('EE_Register_Message_Type', 'register_messagetype_files'), |
|
| 107 | 107 | 10, |
| 108 | 108 | 1 |
| 109 | 109 | ); |
| 110 | 110 | add_filter( |
| 111 | 111 | 'FHEE__EE_messenger__get_default_message_types__default_types', |
| 112 | - array( 'EE_Register_Message_Type', 'register_messengers_to_activate_mt_with' ), |
|
| 112 | + array('EE_Register_Message_Type', 'register_messengers_to_activate_mt_with'), |
|
| 113 | 113 | 10, |
| 114 | 114 | 2 |
| 115 | 115 | ); |
| 116 | 116 | add_filter( |
| 117 | 117 | 'FHEE__EE_messenger__get_valid_message_types__valid_types', |
| 118 | - array( 'EE_Register_Message_Type', 'register_messengers_to_validate_mt_with' ), |
|
| 118 | + array('EE_Register_Message_Type', 'register_messengers_to_validate_mt_with'), |
|
| 119 | 119 | 10, |
| 120 | 120 | 2 |
| 121 | 121 | ); |
| 122 | 122 | //actions |
| 123 | 123 | add_action( |
| 124 | 124 | 'AHEE__EE_Addon__initialize_default_data__begin', |
| 125 | - array( 'EE_Register_Message_Type', 'set_defaults' ) |
|
| 125 | + array('EE_Register_Message_Type', 'set_defaults') |
|
| 126 | 126 | ); |
| 127 | 127 | } |
| 128 | 128 | |
@@ -133,15 +133,15 @@ discard block |
||
| 133 | 133 | */ |
| 134 | 134 | public static function set_defaults() { |
| 135 | 135 | /** @type EE_Message_Resource_Manager $message_resource_manager */ |
| 136 | - $message_resource_manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' ); |
|
| 136 | + $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager'); |
|
| 137 | 137 | |
| 138 | 138 | //for any message types with force activation, let's ensure they are activated |
| 139 | - foreach ( self::$_ee_message_type_registry as $message_type_name => $settings ) { |
|
| 140 | - if ( $settings['force_activation'] ) { |
|
| 141 | - foreach ( $settings['messengers_to_activate_with'] as $messenger ) { |
|
| 139 | + foreach (self::$_ee_message_type_registry as $message_type_name => $settings) { |
|
| 140 | + if ($settings['force_activation']) { |
|
| 141 | + foreach ($settings['messengers_to_activate_with'] as $messenger) { |
|
| 142 | 142 | //DO not force activation if this message type has already been activated in the system |
| 143 | - if ( ! $message_resource_manager->has_message_type_been_activated_for_messenger( $message_type_name, $messenger ) ) { |
|
| 144 | - $message_resource_manager->ensure_message_type_is_active( $message_type_name, $messenger ); |
|
| 143 | + if ( ! $message_resource_manager->has_message_type_been_activated_for_messenger($message_type_name, $messenger)) { |
|
| 144 | + $message_resource_manager->ensure_message_type_is_active($message_type_name, $messenger); |
|
| 145 | 145 | } |
| 146 | 146 | } |
| 147 | 147 | } |
@@ -158,13 +158,13 @@ discard block |
||
| 158 | 158 | * @param string $message_type_name the name for the message type that was previously registered |
| 159 | 159 | * @return void |
| 160 | 160 | */ |
| 161 | - public static function deregister( $message_type_name = null ) { |
|
| 162 | - if ( ! empty( self::$_ee_message_type_registry[ $message_type_name ] ) ) { |
|
| 161 | + public static function deregister($message_type_name = null) { |
|
| 162 | + if ( ! empty(self::$_ee_message_type_registry[$message_type_name])) { |
|
| 163 | 163 | //let's make sure that we remove any place this message type was made active |
| 164 | 164 | /** @var EE_Message_Resource_Manager $Message_Resource_Manager */ |
| 165 | - $Message_Resource_Manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' ); |
|
| 166 | - $Message_Resource_Manager->deactivate_message_type( $message_type_name ); |
|
| 167 | - unset( self::$_ee_message_type_registry[ $message_type_name ] ); |
|
| 165 | + $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager'); |
|
| 166 | + $Message_Resource_Manager->deactivate_message_type($message_type_name); |
|
| 167 | + unset(self::$_ee_message_type_registry[$message_type_name]); |
|
| 168 | 168 | } |
| 169 | 169 | } |
| 170 | 170 | |
@@ -178,12 +178,12 @@ discard block |
||
| 178 | 178 | * @param array $messagetype_files The current array of message type file names |
| 179 | 179 | * @return array Array of message type file names |
| 180 | 180 | */ |
| 181 | - public static function register_messagetype_files( $messagetype_files ) { |
|
| 182 | - if ( empty( self::$_ee_message_type_registry ) ) { |
|
| 181 | + public static function register_messagetype_files($messagetype_files) { |
|
| 182 | + if (empty(self::$_ee_message_type_registry)) { |
|
| 183 | 183 | return $messagetype_files; |
| 184 | 184 | } |
| 185 | - foreach ( self::$_ee_message_type_registry as $mt_reg ) { |
|
| 186 | - if ( empty( $mt_reg['mtfilename' ] ) ) { |
|
| 185 | + foreach (self::$_ee_message_type_registry as $mt_reg) { |
|
| 186 | + if (empty($mt_reg['mtfilename'])) { |
|
| 187 | 187 | continue; |
| 188 | 188 | } |
| 189 | 189 | $messagetype_files[] = $mt_reg['mtfilename']; |
@@ -203,13 +203,13 @@ discard block |
||
| 203 | 203 | * @param array $paths array of paths to be checked by EE_messages autoloader. |
| 204 | 204 | * @return array |
| 205 | 205 | */ |
| 206 | - public static function register_msgs_autoload_paths( $paths ) { |
|
| 207 | - if ( ! empty( self::$_ee_message_type_registry ) ) { |
|
| 208 | - foreach ( self::$_ee_message_type_registry as $mt_reg ) { |
|
| 209 | - if ( empty( $mt_reg['autoloadpaths'] ) ) { |
|
| 206 | + public static function register_msgs_autoload_paths($paths) { |
|
| 207 | + if ( ! empty(self::$_ee_message_type_registry)) { |
|
| 208 | + foreach (self::$_ee_message_type_registry as $mt_reg) { |
|
| 209 | + if (empty($mt_reg['autoloadpaths'])) { |
|
| 210 | 210 | continue; |
| 211 | 211 | } |
| 212 | - $paths = array_merge( $paths, $mt_reg['autoloadpaths'] ); |
|
| 212 | + $paths = array_merge($paths, $mt_reg['autoloadpaths']); |
|
| 213 | 213 | } |
| 214 | 214 | } |
| 215 | 215 | return $paths; |
@@ -228,18 +228,18 @@ discard block |
||
| 228 | 228 | * @param EE_messenger $messenger The EE_messenger the filter is called from. |
| 229 | 229 | * @return array |
| 230 | 230 | */ |
| 231 | - public static function register_messengers_to_activate_mt_with( $default_types, EE_messenger $messenger ) { |
|
| 232 | - if ( empty( self::$_ee_message_type_registry ) ) { |
|
| 231 | + public static function register_messengers_to_activate_mt_with($default_types, EE_messenger $messenger) { |
|
| 232 | + if (empty(self::$_ee_message_type_registry)) { |
|
| 233 | 233 | return $default_types; |
| 234 | 234 | } |
| 235 | - foreach ( self::$_ee_message_type_registry as $message_type_name => $mt_reg ) { |
|
| 236 | - if ( empty( $mt_reg['messengers_to_activate_with'] ) || empty( $mt_reg['mtfilename'] ) ) { |
|
| 235 | + foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) { |
|
| 236 | + if (empty($mt_reg['messengers_to_activate_with']) || empty($mt_reg['mtfilename'])) { |
|
| 237 | 237 | continue; |
| 238 | 238 | } |
| 239 | 239 | // loop through each of the messengers and if it matches the loaded class |
| 240 | 240 | // then we add this message type to the |
| 241 | - foreach ( $mt_reg['messengers_to_activate_with'] as $msgr ) { |
|
| 242 | - if ( $messenger->name == $msgr ) { |
|
| 241 | + foreach ($mt_reg['messengers_to_activate_with'] as $msgr) { |
|
| 242 | + if ($messenger->name == $msgr) { |
|
| 243 | 243 | $default_types[] = $message_type_name; |
| 244 | 244 | } |
| 245 | 245 | } |
@@ -259,18 +259,18 @@ discard block |
||
| 259 | 259 | * @param EE_messenger $messenger The EE_messenger the filter is called from. |
| 260 | 260 | * @return array |
| 261 | 261 | */ |
| 262 | - public static function register_messengers_to_validate_mt_with( $valid_types, EE_messenger $messenger ) { |
|
| 263 | - if ( empty( self::$_ee_message_type_registry ) ) { |
|
| 262 | + public static function register_messengers_to_validate_mt_with($valid_types, EE_messenger $messenger) { |
|
| 263 | + if (empty(self::$_ee_message_type_registry)) { |
|
| 264 | 264 | return $valid_types; |
| 265 | 265 | } |
| 266 | - foreach ( self::$_ee_message_type_registry as $message_type_name => $mt_reg ) { |
|
| 267 | - if ( empty( $mt_reg['messengers_to_validate_with'] ) || empty( $mt_reg['mtfilename'] ) ) { |
|
| 266 | + foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) { |
|
| 267 | + if (empty($mt_reg['messengers_to_validate_with']) || empty($mt_reg['mtfilename'])) { |
|
| 268 | 268 | continue; |
| 269 | 269 | } |
| 270 | 270 | // loop through each of the messengers and if it matches the loaded class |
| 271 | 271 | // then we add this message type to the |
| 272 | - foreach ( $mt_reg['messengers_to_validate_with'] as $msgr ) { |
|
| 273 | - if ( $messenger->name == $msgr ) { |
|
| 272 | + foreach ($mt_reg['messengers_to_validate_with'] as $msgr) { |
|
| 273 | + if ($messenger->name == $msgr) { |
|
| 274 | 274 | $valid_types[] = $message_type_name; |
| 275 | 275 | } |
| 276 | 276 | } |