eventespresso / event-espresso-core

admin_pages/support/templates/support_admin_details_contact_support.template.php

Indentation +68 added lines, -68 removed lines

@@ -3,102 +3,102 @@
 
     <h4>
         <?php
-        esc_html_e(
-            'You may be able to find an answer for your question or concern here:',
-            'event_espresso'
-        );
-        ?>
+		esc_html_e(
+			'You may be able to find an answer for your question or concern here:',
+			'event_espresso'
+		);
+		?>
     </h4>
     <ol>
         <li>
             <strong><em><?php esc_html_e('A known issue.', 'event_espresso'); ?></em></strong>
             <?php
-            printf(
-                esc_html__(
-                    'Some themes and plugins have %1$sknown conflicts%2$s with Event Espresso. (You can also browse the %3$sEvent Espresso support pages%2$s or %4$sEvent Espresso support forums%2$s to see if other members have experienced and solved the problem.)',
-                    'event_espresso'
-                ),
-                '<a href="https://eventespresso.com/wiki/known-third-party-plugin-theme-conflicts/" target="_blank">',
-                '</a>',
-                '<a href="https://eventespresso.com/support/documentation/versioned-docs/?doc_ver=ee4" target="_blank">',
-                '<a href="https://eventespresso.com/support/forums/" target="_blank">'
-            );
-            ?>
+			printf(
+				esc_html__(
+					'Some themes and plugins have %1$sknown conflicts%2$s with Event Espresso. (You can also browse the %3$sEvent Espresso support pages%2$s or %4$sEvent Espresso support forums%2$s to see if other members have experienced and solved the problem.)',
+					'event_espresso'
+				),
+				'<a href="https://eventespresso.com/wiki/known-third-party-plugin-theme-conflicts/" target="_blank">',
+				'</a>',
+				'<a href="https://eventespresso.com/support/documentation/versioned-docs/?doc_ver=ee4" target="_blank">',
+				'<a href="https://eventespresso.com/support/forums/" target="_blank">'
+			);
+			?>
         </li>
         <li>
             <strong><em><?php esc_html_e('A plugin conflict.', 'event_espresso'); ?></em></strong>
             <?php
-            esc_html_e(
-                'You can check to see if there is a plugin conflict by temporarily deactivating all plugins except for Event Espresso. If the problem goes away, then reactivate your plugins one by one until the issue returns. This will help you pinpoint the source of the conflict.',
-                'event_espresso'
-            );
-            ?>
+			esc_html_e(
+				'You can check to see if there is a plugin conflict by temporarily deactivating all plugins except for Event Espresso. If the problem goes away, then reactivate your plugins one by one until the issue returns. This will help you pinpoint the source of the conflict.',
+				'event_espresso'
+			);
+			?>
         </li>
         <li>
             <strong><em><?php esc_html_e('A theme conflict.', 'event_espresso'); ?></em></strong>
             <?php
-            $default_theme = wp_get_theme(WP_DEFAULT_THEME);
+			$default_theme = wp_get_theme(WP_DEFAULT_THEME);
 
-            if ($default_theme->exists()) {
-                printf(
-                    esc_html__(
-                        'If your problem is not a known issue or caused by a plugin, then try activating %s (the default WordPress theme).',
-                        'event_espresso'
-                    ),
-                    $default_theme->get('Name')
-                );
-            } else {
-                esc_html_e(
-                    'If your problem is not a known issue or caused by a plugin, then try activating the default WordPress theme.',
-                    'event_espresso'
-                );
-            }
-            ?>
+			if ($default_theme->exists()) {
+				printf(
+					esc_html__(
+						'If your problem is not a known issue or caused by a plugin, then try activating %s (the default WordPress theme).',
+						'event_espresso'
+					),
+					$default_theme->get('Name')
+				);
+			} else {
+				esc_html_e(
+					'If your problem is not a known issue or caused by a plugin, then try activating the default WordPress theme.',
+					'event_espresso'
+				);
+			}
+			?>
             <?php
-            esc_html_e(
-                'If this solves the problem for you, then something in your theme is causing this issue. Check to see if an update is available for your WordPress theme or reach out to the theme author.',
-                'event_espresso'
-            );
-            ?>
+			esc_html_e(
+				'If this solves the problem for you, then something in your theme is causing this issue. Check to see if an update is available for your WordPress theme or reach out to the theme author.',
+				'event_espresso'
+			);
+			?>
         </li>
     </ol>
 
     <p>
         <?php
-        esc_html_e(
-            'If none of the suggestions above help you find a solution, then feel free to reach out to the support team at Event Espresso.',
-            'event_espresso'
-        );
-        ?>
+		esc_html_e(
+			'If none of the suggestions above help you find a solution, then feel free to reach out to the support team at Event Espresso.',
+			'event_espresso'
+		);
+		?>
     </p>
     <p>
         <?php
-        printf(
-            esc_html__(
-                'Login to your account on EventEspresso.com and %1$screate a support post in our member support forums%2$s. Use a %3$sclear and descriptive title%4$s in your support post, %3$sdescribe the issue to the best of your knowledge%4$s, and %3$snever post any sensitive information such as login details%4$s. Be sure to also include %5$simportant information in the section below%2$s about your WordPress site.',
-                'event_espresso'
-            ),
-            '<a href="https://eventespresso.com/support/forums/" target="_blank">',
-            '</a>',
-            '<strong>',
-            '</strong>',
-            '<a href="#espresso_important_information_settings">'
-        );
-        ?>
+		printf(
+			esc_html__(
+				'Login to your account on EventEspresso.com and %1$screate a support post in our member support forums%2$s. Use a %3$sclear and descriptive title%4$s in your support post, %3$sdescribe the issue to the best of your knowledge%4$s, and %3$snever post any sensitive information such as login details%4$s. Be sure to also include %5$simportant information in the section below%2$s about your WordPress site.',
+				'event_espresso'
+			),
+			'<a href="https://eventespresso.com/support/forums/" target="_blank">',
+			'</a>',
+			'<strong>',
+			'</strong>',
+			'<a href="#espresso_important_information_settings">'
+		);
+		?>
     </p>
 
     <h4><?php esc_html_e('Have an emergency?', 'event_espresso'); ?></h4>
 
     <p>
         <?php
-        printf(
-            esc_html__(
-                'We offer support tokens to members that need help with a time-sensitive issue. A support token will provide you with up to 30 minutes of one-on-one time with a team member at Event Espresso. If you have an emergency and need help quickly, then please %1$spurchase a support token%2$s.',
-                'event_espresso'
-            ),
-            '<a href="https://eventespresso.com/product/premium-support-token/?utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=help_support_tab&utm_content=support_token" target="_blank">',
-            '</a>'
-        );
-        ?>
+		printf(
+			esc_html__(
+				'We offer support tokens to members that need help with a time-sensitive issue. A support token will provide you with up to 30 minutes of one-on-one time with a team member at Event Espresso. If you have an emergency and need help quickly, then please %1$spurchase a support token%2$s.',
+				'event_espresso'
+			),
+			'<a href="https://eventespresso.com/product/premium-support-token/?utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=help_support_tab&utm_content=support_token" target="_blank">',
+			'</a>'
+		);
+		?>
     </p>
 </div>
\ No newline at end of file

admin_pages/registration_form/Registration_Form_Admin_Page.core.php

Spacing +30 added lines, -30 removed lines

@@ -53,8 +53,8 @@ 
      */
     public function __construct($routing = true)
     {
-        require_once(EE_MODELS . 'EEM_Question.model.php');
-        require_once(EE_MODELS . 'EEM_Question_Group.model.php');
+        require_once(EE_MODELS.'EEM_Question.model.php');
+        require_once(EE_MODELS.'EEM_Question_Group.model.php');
         $this->_question_model       = EEM_Question::instance();
         $this->_question_group_model = EEM_Question_Group::instance();
         parent::__construct($routing);
@@ -91,7 +91,7 @@ 
      */
     protected function _set_page_routes()
     {
-        $qst_id             =
+        $qst_id =
             ! empty($this->_req_data['QST_ID'])
                 ? $this->_req_data['QST_ID']
                 : 0;
@@ -234,7 +234,7 @@ 
     {
         wp_register_style(
             'espresso_registration',
-            REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.css',
+            REGISTRATION_FORM_ASSETS_URL.'espresso_registration_form_admin.css',
             [],
             EVENT_ESPRESSO_VERSION
         );
@@ -291,7 +291,7 @@ 
         $this->load_scripts_styles_forms();
         wp_register_script(
             'espresso_registration_form_single',
-            REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.js',
+            REGISTRATION_FORM_ASSETS_URL.'espresso_registration_form_admin.js',
             ['jquery-ui-sortable'],
             EVENT_ESPRESSO_VERSION,
             true
@@ -310,7 +310,7 @@ 
 
     public function recaptcha_info_help_tab()
     {
-        $template = REGISTRATION_FORM_TEMPLATE_PATH . 'recaptcha_info_help_tab.template.php';
+        $template = REGISTRATION_FORM_TEMPLATE_PATH.'recaptcha_info_help_tab.template.php';
         EEH_Template::display_template($template, []);
     }
 
@@ -359,16 +359,16 @@ 
     {
         $this->_admin_page_title              = esc_html__('Question Groups (Preview)', 'event_espresso');
         $this->_template_args['preview_img']  =
-            '<img src="' . REGISTRATION_FORM_ASSETS_URL . 'caf_reg_form_preview.jpg" alt="'
+            '<img src="'.REGISTRATION_FORM_ASSETS_URL.'caf_reg_form_preview.jpg" alt="'
             . esc_attr__(
                 'Preview Question Groups Overview List Table screenshot',
                 'event_espresso'
-            ) . '" />';
+            ).'" />';
         $this->_template_args['preview_text'] = '<strong>'
                                                 . esc_html__(
                                                     'Question Groups is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Question Groups feature you are able to create new question groups, edit existing question groups, and create and edit new questions and add them to question groups.',
                                                     'event_espresso'
-                                                ) . '</strong>';
+                                                ).'</strong>';
         $this->display_admin_caf_preview_page('question_groups_tab');
     }
 
@@ -387,7 +387,7 @@ 
 
         // some initial checks for proper values.
         // if QST_admin_only, then no matter what QST_required is we disable.
-        if (! empty($this->_req_data['QST_admin_only'])) {
+        if ( ! empty($this->_req_data['QST_admin_only'])) {
             $this->_req_data['QST_required'] = 0;
         }
         // if the question shouldn't have a max length, don't let them set one
@@ -414,19 +414,19 @@ 
                 $QSG_name = isset($this->_req_data['QSG_name'])
                     ? $this->_req_data['QSG_name']
                     : '';
-                $set_column_values[ $fieldName ] = sanitize_title($QSG_name) . '-' . uniqid('', true);
+                $set_column_values[$fieldName] = sanitize_title($QSG_name).'-'.uniqid('', true);
             } elseif (
                 $fieldName === 'QST_admin_label'
                 && (isset($this->_req_data['QST_admin_label']) && empty($this->_req_data['QST_admin_label']))
             ) {
                 // the admin label is blank, use a slug version of the question text
-                $QST_text                        =
+                $QST_text =
                     isset($this->_req_data['QST_display_text'])
                         ? $this->_req_data['QST_display_text']
                         : '';
-                $set_column_values[ $fieldName ] = sanitize_title(wp_trim_words($QST_text, 10));
-            } elseif ($fieldName === 'QST_admin_only' && (! isset($this->_req_data['QST_admin_only']))) {
-                $set_column_values[ $fieldName ] = 0;
+                $set_column_values[$fieldName] = sanitize_title(wp_trim_words($QST_text, 10));
+            } elseif ($fieldName === 'QST_admin_only' && ( ! isset($this->_req_data['QST_admin_only']))) {
+                $set_column_values[$fieldName] = 0;
             } elseif ($fieldName === 'QST_max') {
                 $qst_system = EEM_Question::instance()->get_var(
                     [
@@ -438,23 +438,23 @@ 
                     ],
                     'QST_system'
                 );
-                $max_max    = EEM_Question::instance()->absolute_max_for_system_question($qst_system);
+                $max_max = EEM_Question::instance()->absolute_max_for_system_question($qst_system);
                 if (
                     empty($this->_req_data['QST_max']) || $this->_req_data['QST_max'] > $max_max
                 ) {
-                    $set_column_values[ $fieldName ] = $max_max;
+                    $set_column_values[$fieldName] = $max_max;
                 }
             }
 
 
             // only add a property to the array if it's not null (otherwise the model should just use the default value)
             if (
-                ! isset($set_column_values[ $fieldName ]) && isset($this->_req_data[ $fieldName ])
+                ! isset($set_column_values[$fieldName]) && isset($this->_req_data[$fieldName])
             ) {
-                $set_column_values[ $fieldName ] = $this->_req_data[ $fieldName ];
+                $set_column_values[$fieldName] = $this->_req_data[$fieldName];
             }
         }
-        return $set_column_values;// validation fo this data to be performed by the model before insertion.
+        return $set_column_values; // validation fo this data to be performed by the model before insertion.
     }
 
 
@@ -496,7 +496,7 @@ 
         // add PRC_ID to title if editing
         $this->_admin_page_title =
             $ID
-                ? $this->_admin_page_title . ' # ' . $ID
+                ? $this->_admin_page_title.' # '.$ID
                 : $this->_admin_page_title;
         if ($ID) {
             $question                 = $this->_question_model->get_one_by_ID($ID);
@@ -532,7 +532,7 @@ 
         $this->_template_args['question_type_descriptions'] = $this->_get_question_type_descriptions();
         $this->_set_publish_post_box_vars('id', $ID);
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            REGISTRATION_FORM_TEMPLATE_PATH . 'questions_main_meta_box.template.php',
+            REGISTRATION_FORM_TEMPLATE_PATH.'questions_main_meta_box.template.php',
             $this->_template_args,
             true
         );
@@ -554,7 +554,7 @@ 
         $question_type_descriptions = EEM_Question::instance()->question_descriptions();
         foreach ($question_type_descriptions as $type => $question_type_description) {
             if ($type == 'HTML_TEXTAREA') {
-                $html                      = new EE_Simple_HTML_Validation_Strategy();
+                $html = new EE_Simple_HTML_Validation_Strategy();
                 $question_type_description .= sprintf(
                     esc_html__('%1$s(allowed tags: %2$s)', 'event_espresso'),
                     '<br/>',
@@ -563,7 +563,7 @@ 
             }
             $descriptions .= EEH_HTML::p(
                 $question_type_description,
-                'question_type_description-' . $type,
+                'question_type_description-'.$type,
                 'question_type_description description',
                 'display:none;'
             );
@@ -598,11 +598,11 @@ 
             // trash removed options, save old ones
             // get list of all options
             $options = $question->options();
-            if (! empty($options)) {
+            if ( ! empty($options)) {
                 foreach ($options as $option_ID => $option) {
                     $option_req_index = $this->_get_option_req_data_index($option_ID);
                     if ($option_req_index !== false) {
-                        $option->save($this->_req_data['question_options'][ $option_req_index ]);
+                        $option->save($this->_req_data['question_options'][$option_req_index]);
                     } else {
                         // not found, remove it
                         $option->delete();
@@ -693,11 +693,11 @@ 
             (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
                 ? $this->_req_data['order']
                 : 'ASC';
-        $orderby_field            =
+        $orderby_field =
             $model instanceof EEM_Question
                 ? 'QST_ID'
                 : 'QSG_order';
-        $field_to_order_by        =
+        $field_to_order_by =
             empty($this->_req_data['orderby'])
                 ? $orderby_field
                 : $this->_req_data['orderby'];
@@ -706,7 +706,7 @@ 
             array_key_exists('s', $this->_req_data)
                 ? $this->_req_data['s']
                 : null;
-        if (! empty($search_string)) {
+        if ( ! empty($search_string)) {
             if ($model instanceof EEM_Question_Group) {
                 $query_params[0] = [
                     'OR' => [
@@ -768,7 +768,7 @@ 
         $QST          = EEM_Question::instance();
         $query_params = $this->get_query_params($QST, $per_page, $current_page);
         if ($count) {
-            $where   =
+            $where =
                 isset($query_params[0])
                     ? [$query_params[0]]
                     : [];

Indentation +764 added lines, -764 removed lines

@@ -15,707 +15,707 @@ 
  */
 class Registration_Form_Admin_Page extends EE_Admin_Page
 {
-    /**
-     * holds the specific question object for the question details screen
-     *
-     * @var EE_Question $_question
-     */
-    protected $_question;
-
-    /**
-     * holds the specific question group object for the question group details screen
-     *
-     * @var EE_Question_Group $_question_group
-     */
-    protected $_question_group;
-
-    /**
-     *_question_model EEM_Question model instance (for queries)
-     *
-     * @var EEM_Question $_question_model ;
-     */
-    protected $_question_model;
-
-    /**
-     * _question_group_model EEM_Question_group instance (for queries)
-     *
-     * @var EEM_Question_Group $_question_group_model
-     */
-    protected $_question_group_model;
-
-
-    /**
-     * @Constructor
-     * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct($routing = true)
-    {
-        require_once(EE_MODELS . 'EEM_Question.model.php');
-        require_once(EE_MODELS . 'EEM_Question_Group.model.php');
-        $this->_question_model       = EEM_Question::instance();
-        $this->_question_group_model = EEM_Question_Group::instance();
-        parent::__construct($routing);
-    }
-
-
-    protected function _init_page_props()
-    {
-        $this->page_slug        = REGISTRATION_FORM_PG_SLUG;
-        $this->page_label       = esc_html__('Registration Form', 'event_espresso');
-        $this->_admin_base_url  = REGISTRATION_FORM_ADMIN_URL;
-        $this->_admin_base_path = REGISTRATION_FORM_ADMIN;
-    }
-
-
-    protected function _ajax_hooks()
-    {
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = esc_html__('Registration Form', 'event_espresso');
-        $this->_labels           = [
-            'buttons' => [
-                'edit_question' => esc_html__('Edit Question', 'event_espresso'),
-            ],
-        ];
-    }
-
-
-    /**
-     *_set_page_routes
-     */
-    protected function _set_page_routes()
-    {
-        $qst_id             =
-            ! empty($this->_req_data['QST_ID'])
-                ? $this->_req_data['QST_ID']
-                : 0;
-        $this->_page_routes = [
-            'default' => [
-                'func'       => '_questions_overview_list_table',
-                'capability' => 'ee_read_questions',
-            ],
-
-            'edit_question' => [
-                'func'       => '_edit_question',
-                'capability' => 'ee_edit_question',
-                'obj_id'     => $qst_id,
-                'args'       => ['edit'],
-            ],
-
-            'question_groups' => [
-                'func'       => '_questions_groups_preview',
-                'capability' => 'ee_read_question_groups',
-            ],
-
-            'update_question' => [
-                'func'       => '_insert_or_update_question',
-                'args'       => ['new_question' => false],
-                'capability' => 'ee_edit_question',
-                'obj_id'     => $qst_id,
-                'noheader'   => true,
-            ],
-        ];
-    }
-
-
-    protected function _set_page_config()
-    {
-        $this->_page_config = [
-            'default' => [
-                'nav'           => [
-                    'label' => esc_html__('Questions', 'event_espresso'),
-                    'order' => 10,
-                ],
-                'list_table'    => 'Registration_Form_Questions_Admin_List_Table',
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'help_tabs'     => [
-                    'registration_form_questions_overview_help_tab'                           => [
-                        'title'    => esc_html__('Questions Overview', 'event_espresso'),
-                        'filename' => 'registration_form_questions_overview',
-                    ],
-                    'registration_form_questions_overview_table_column_headings_help_tab'     => [
-                        'title'    => esc_html__('Questions Overview Table Column Headings', 'event_espresso'),
-                        'filename' => 'registration_form_questions_overview_table_column_headings',
-                    ],
-                    'registration_form_questions_overview_views_bulk_actions_search_help_tab' => [
-                        'title'    => esc_html__('Question Overview Views & Bulk Actions & Search', 'event_espresso'),
-                        'filename' => 'registration_form_questions_overview_views_bulk_actions_search',
-                    ],
-                ],
-                'require_nonce' => false,
-                'qtips'         => [
-                    'EE_Registration_Form_Tips',
-                ]/**/
-            ],
-
-            'question_groups' => [
-                'nav'           => [
-                    'label' => esc_html__('Question Groups', 'event_espresso'),
-                    'order' => 20,
-                ],
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'help_tabs'     => [
-                    'registration_form_question_groups_help_tab' => [
-                        'title'    => esc_html__('Question Groups', 'event_espresso'),
-                        'filename' => 'registration_form_question_groups',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-
-            'edit_question' => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Question', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => isset($this->_req_data['question_id'])
-                        ? add_query_arg(
-                            ['question_id' => $this->_req_data['question_id']],
-                            $this->_current_page_view_url
-                        )
-                        : $this->_admin_base_url,
-                ],
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
-                'help_tabs'     => [
-                    'registration_form_edit_question_group_help_tab' => [
-                        'title'    => esc_html__('Edit Question', 'event_espresso'),
-                        'filename' => 'registration_form_edit_question',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-        ];
-    }
-
-
-    protected function _add_screen_options()
-    {
-        // todo
-    }
-
-
-    protected function _add_screen_options_default()
-    {
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Questions', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    protected function _add_screen_options_question_groups()
-    {
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Question Groups', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    // none of the below group are currently used for Event Categories
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    public function load_scripts_styles()
-    {
-        wp_register_style(
-            'espresso_registration',
-            REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_registration');
-    }
-
-
-    public function admin_init()
-    {
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    public function load_scripts_styles_default()
-    {
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    public function load_scripts_styles_add_question()
-    {
-        $this->load_scripts_styles_question_details();
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    public function load_scripts_styles_edit_question()
-    {
-        $this->load_scripts_styles_question_details();
-    }
-
-
-    /**
-     * Loads the JS required for adding or editing a question
-     *
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function load_scripts_styles_question_details()
-    {
-        $this->load_scripts_styles_forms();
-        wp_register_script(
-            'espresso_registration_form_single',
-            REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.js',
-            ['jquery-ui-sortable'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('espresso_registration_form_single');
-        wp_localize_script(
-            'espresso_registration_form_single',
-            'ee_question_data',
-            [
-                'question_types_with_max'    => EEM_Question::instance()->questionTypesWithMaxLength(),
-                'question_type_with_options' => EEM_Question::instance()->question_types_with_options(),
-            ]
-        );
-    }
-
-
-    public function recaptcha_info_help_tab()
-    {
-        $template = REGISTRATION_FORM_TEMPLATE_PATH . 'recaptcha_info_help_tab.template.php';
-        EEH_Template::display_template($template, []);
-    }
-
-
-    public function load_scripts_styles_forms()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        // scripts
-        wp_enqueue_script('ee_admin_js');
-    }
-
-
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = [
-            'all' => [
-                'slug'  => 'all',
-                'label' => esc_html__('View All Questions', 'event_espresso'),
-                'count' => 0,
-            ],
-        ];
-
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_questions',
-                'espresso_registration_form_trash_questions'
-            )
-        ) {
-            $this->_views['trash'] = [
-                'slug'  => 'trash',
-                'label' => esc_html__('Trash', 'event_espresso'),
-                'count' => 0,
-            ];
-        }
-    }
-
-
-    /**
-     * This just previews the question groups tab that comes in caffeinated.
-     *
-     * @return void html
-     * @throws EE_Error
-     */
-    protected function _questions_groups_preview()
-    {
-        $this->_admin_page_title              = esc_html__('Question Groups (Preview)', 'event_espresso');
-        $this->_template_args['preview_img']  =
-            '<img src="' . REGISTRATION_FORM_ASSETS_URL . 'caf_reg_form_preview.jpg" alt="'
-            . esc_attr__(
-                'Preview Question Groups Overview List Table screenshot',
-                'event_espresso'
-            ) . '" />';
-        $this->_template_args['preview_text'] = '<strong>'
-                                                . esc_html__(
-                                                    'Question Groups is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Question Groups feature you are able to create new question groups, edit existing question groups, and create and edit new questions and add them to question groups.',
-                                                    'event_espresso'
-                                                ) . '</strong>';
-        $this->display_admin_caf_preview_page('question_groups_tab');
-    }
-
-
-    /**
-     * Extracts the question field's values from the POST request to update or insert them
-     *
-     * @param EEM_Base $model
-     * @return array where each key is the name of a model's field/db column, and each value is its value.
-     * @throws EE_Error
-     */
-    protected function _set_column_values_for(EEM_Base $model)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $set_column_values = [];
-
-        // some initial checks for proper values.
-        // if QST_admin_only, then no matter what QST_required is we disable.
-        if (! empty($this->_req_data['QST_admin_only'])) {
-            $this->_req_data['QST_required'] = 0;
-        }
-        // if the question shouldn't have a max length, don't let them set one
-        if (
-            ! isset(
-                $this->_req_data['QST_type'],
-                $this->_req_data['QST_max']
-            )
-            || ! in_array(
-                $this->_req_data['QST_type'],
-                EEM_Question::instance()->questionTypesWithMaxLength(),
-                true
-            )
-        ) {
-            // they're not allowed to set the max
-            $this->_req_data['QST_max'] = null;
-        }
-        foreach ($model->field_settings() as $fieldName => $settings) {
-            // basically if QSG_identifier is empty or not set
-            if (
-                $fieldName === 'QSG_identifier'
-                && (isset($this->_req_data['QSG_identifier']) && empty($this->_req_data['QSG_identifier']))
-            ) {
-                $QSG_name = isset($this->_req_data['QSG_name'])
-                    ? $this->_req_data['QSG_name']
-                    : '';
-                $set_column_values[ $fieldName ] = sanitize_title($QSG_name) . '-' . uniqid('', true);
-            } elseif (
-                $fieldName === 'QST_admin_label'
-                && (isset($this->_req_data['QST_admin_label']) && empty($this->_req_data['QST_admin_label']))
-            ) {
-                // the admin label is blank, use a slug version of the question text
-                $QST_text                        =
-                    isset($this->_req_data['QST_display_text'])
-                        ? $this->_req_data['QST_display_text']
-                        : '';
-                $set_column_values[ $fieldName ] = sanitize_title(wp_trim_words($QST_text, 10));
-            } elseif ($fieldName === 'QST_admin_only' && (! isset($this->_req_data['QST_admin_only']))) {
-                $set_column_values[ $fieldName ] = 0;
-            } elseif ($fieldName === 'QST_max') {
-                $qst_system = EEM_Question::instance()->get_var(
-                    [
-                        [
-                            'QST_ID' => isset($this->_req_data['QST_ID'])
-                                ? $this->_req_data['QST_ID']
-                                : 0,
-                        ],
-                    ],
-                    'QST_system'
-                );
-                $max_max    = EEM_Question::instance()->absolute_max_for_system_question($qst_system);
-                if (
-                    empty($this->_req_data['QST_max']) || $this->_req_data['QST_max'] > $max_max
-                ) {
-                    $set_column_values[ $fieldName ] = $max_max;
-                }
-            }
-
-
-            // only add a property to the array if it's not null (otherwise the model should just use the default value)
-            if (
-                ! isset($set_column_values[ $fieldName ]) && isset($this->_req_data[ $fieldName ])
-            ) {
-                $set_column_values[ $fieldName ] = $this->_req_data[ $fieldName ];
-            }
-        }
-        return $set_column_values;// validation fo this data to be performed by the model before insertion.
-    }
-
-
-    /**
-     *_questions_overview_list_table
-     *
-     * @throws EE_Error
-     */
-    protected function _questions_overview_list_table()
-    {
-        $this->_search_btn_label = esc_html__('Questions', 'event_espresso');
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    /**
-     * _edit_question
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _edit_question()
-    {
-        $ID = isset($this->_req_data['QST_ID']) && ! empty($this->_req_data['QST_ID'])
-            ? absint($this->_req_data['QST_ID'])
-            : false;
-
-        switch ($this->_req_action) {
-            case 'add_question':
-                $this->_admin_page_title = esc_html__('Add Question', 'event_espresso');
-                break;
-            case 'edit_question':
-                $this->_admin_page_title = esc_html__('Edit Question', 'event_espresso');
-                break;
-            default:
-                $this->_admin_page_title = ucwords(str_replace('_', ' ', $this->_req_action));
-        }
-
-        // add PRC_ID to title if editing
-        $this->_admin_page_title =
-            $ID
-                ? $this->_admin_page_title . ' # ' . $ID
-                : $this->_admin_page_title;
-        if ($ID) {
-            $question                 = $this->_question_model->get_one_by_ID($ID);
-            $additional_hidden_fields = ['QST_ID' => ['type' => 'hidden', 'value' => $ID]];
-            $this->_set_add_edit_form_tags('update_question', $additional_hidden_fields);
-        } else {
-            $question = EE_Question::new_instance();
-            $question->set_order_to_latest();
-            $this->_set_add_edit_form_tags('insert_question');
-        }
-        if ($question->system_ID() === EEM_Attendee::system_question_phone) {
-            $question_types = array_intersect_key(
-                EEM_Question::instance()->allowed_question_types(),
-                array_flip(
-                    [
-                        EEM_Question::QST_type_text,
-                        EEM_Question::QST_type_us_phone,
-                    ]
-                )
-            );
-        } else {
-            $question_types = $question->has_answers()
-                ? $this->_question_model->question_types_in_same_category($question->type())
-                : $this->_question_model->allowed_question_types();
-        }
-        $this->_template_args['QST_ID']                     = $ID;
-        $this->_template_args['question']                   = $question;
-        $this->_template_args['question_types']             = $question_types;
-        $this->_template_args['max_max']                    =
-            EEM_Question::instance()->absolute_max_for_system_question(
-                $question->system_ID()
-            );
-        $this->_template_args['question_type_descriptions'] = $this->_get_question_type_descriptions();
-        $this->_set_publish_post_box_vars('id', $ID);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            REGISTRATION_FORM_TEMPLATE_PATH . 'questions_main_meta_box.template.php',
-            $this->_template_args,
-            true
-        );
-
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_question_type_descriptions()
-    {
-        EE_Registry::instance()->load_helper('HTML');
-        $descriptions               = '';
-        $question_type_descriptions = EEM_Question::instance()->question_descriptions();
-        foreach ($question_type_descriptions as $type => $question_type_description) {
-            if ($type == 'HTML_TEXTAREA') {
-                $html                      = new EE_Simple_HTML_Validation_Strategy();
-                $question_type_description .= sprintf(
-                    esc_html__('%1$s(allowed tags: %2$s)', 'event_espresso'),
-                    '<br/>',
-                    $html->get_list_of_allowed_tags()
-                );
-            }
-            $descriptions .= EEH_HTML::p(
-                $question_type_description,
-                'question_type_description-' . $type,
-                'question_type_description description',
-                'display:none;'
-            );
-        }
-        return $descriptions;
-    }
-
-
-    /**
-     * @param bool|true $new_question
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _insert_or_update_question($new_question = true)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $set_column_values = $this->_set_column_values_for($this->_question_model);
-        if ($new_question) {
-            $question    = EE_Question::new_instance($set_column_values);
-            $action_desc = 'added';
-        } else {
-            $question = EEM_Question::instance()->get_one_by_ID(absint($this->_req_data['QST_ID']));
-            foreach ($set_column_values as $field => $new_value) {
-                $question->set($field, $new_value);
-            }
-            $action_desc = 'updated';
-        }
-        $success = $question->save();
-        $ID      = $question->ID();
-        if ($ID && $question->should_have_question_options()) {
-            // save the related options
-            // trash removed options, save old ones
-            // get list of all options
-            $options = $question->options();
-            if (! empty($options)) {
-                foreach ($options as $option_ID => $option) {
-                    $option_req_index = $this->_get_option_req_data_index($option_ID);
-                    if ($option_req_index !== false) {
-                        $option->save($this->_req_data['question_options'][ $option_req_index ]);
-                    } else {
-                        // not found, remove it
-                        $option->delete();
-                    }
-                }
-            }
-            // save new related options
-            foreach ($this->_req_data['question_options'] as $index => $option_req_data) {
-                // skip $index that is from our sample
-                if ($index === 'xxcountxx') {
-                    continue;
-                }
-                // note we allow saving blank options.
-                if (empty($option_req_data['QSO_ID'])) {
-                    // no ID! save it!
-                    $new_option = EE_Question_Option::new_instance(
-                        [
-                            'QSO_value' => $option_req_data['QSO_value'],
-                            'QSO_desc'  => $option_req_data['QSO_desc'],
-                            'QSO_order' => $option_req_data['QSO_order'],
-                            'QST_ID'    => $question->ID(),
-                        ]
-                    );
-                    $new_option->save();
-                }
-            }
-        }
-        $query_args = ['action' => 'edit_question', 'QST_ID' => $ID];
-        if ($success !== 0) {
-            $msg = $new_question
-                ? sprintf(
-                    esc_html__('The %s has been created', 'event_espresso'),
-                    $this->_question_model->item_name()
-                )
-                : sprintf(
-                    esc_html__('The %s has been updated', 'event_espresso'),
-                    $this->_question_model->item_name()
-                );
-            EE_Error::add_success($msg);
-        }
-
-        $this->_redirect_after_action(false, '', $action_desc, $query_args, true);
-    }
-
-
-    /**
-     * Upon saving a question, there should be an array of 'question_options'. This array is index numerically, but not
-     * by ID
-     * (this is done because new question options don't have an ID, but we may want to add multiple simultaneously).
-     * So, this function gets the index in that request data array called question_options. Returns FALSE if not found.
-     *
-     * @param int $ID of the question option to find
-     * @return int index in question_options array if successful, FALSE if unsuccessful
-     */
-    protected function _get_option_req_data_index($ID)
-    {
-        $req_data_for_question_options = $this->_req_data['question_options'];
-        foreach ($req_data_for_question_options as $num => $option_data) {
-            if (array_key_exists('QSO_ID', $option_data) && (int) $option_data['QSO_ID'] === $ID) {
-                return $num;
-            }
-        }
-        return false;
-    }
-
-
-
-
-    /***********/
-    /* QUERIES */
-    /**
-     * For internal use in getting all the query parameters
-     * (because it's pretty well the same between question, question groups,
-     * and for both when searching for trashed and untrashed ones)
-     *
-     * @param EEM_Base $model either EEM_Question or EEM_Question_Group
-     * @param int      $per_page
-     * @param int      $current_page
-     * @return array model query params, @see
-     *               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    protected function get_query_params($model, $per_page = 10, $current_page = 10)
-    {
-        $query_params             = [];
-        $offset                   = ($current_page - 1) * $per_page;
-        $query_params['limit']    = [$offset, $per_page];
-        $order                    =
-            (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
-                ? $this->_req_data['order']
-                : 'ASC';
-        $orderby_field            =
-            $model instanceof EEM_Question
-                ? 'QST_ID'
-                : 'QSG_order';
-        $field_to_order_by        =
-            empty($this->_req_data['orderby'])
-                ? $orderby_field
-                : $this->_req_data['orderby'];
-        $query_params['order_by'] = [$field_to_order_by => $order];
-        $search_string            =
-            array_key_exists('s', $this->_req_data)
-                ? $this->_req_data['s']
-                : null;
-        if (! empty($search_string)) {
-            if ($model instanceof EEM_Question_Group) {
-                $query_params[0] = [
-                    'OR' => [
-                        'QSG_name' => ['LIKE', "%$search_string%"],
-                        'QSG_desc' => ['LIKE', "%$search_string%"],
-                    ],
-                ];
-            } else {
-                $query_params[0] = [
-                    'QST_display_text' => ['LIKE', "%$search_string%"],
-                ];
-            }
-        }
-
-        // capability checks (just leaving this commented out for reference because it illustrates some complicated query params that could be useful when fully implemented)
-        /*if ( $model instanceof EEM_Question_Group ) {
+	/**
+	 * holds the specific question object for the question details screen
+	 *
+	 * @var EE_Question $_question
+	 */
+	protected $_question;
+
+	/**
+	 * holds the specific question group object for the question group details screen
+	 *
+	 * @var EE_Question_Group $_question_group
+	 */
+	protected $_question_group;
+
+	/**
+	 *_question_model EEM_Question model instance (for queries)
+	 *
+	 * @var EEM_Question $_question_model ;
+	 */
+	protected $_question_model;
+
+	/**
+	 * _question_group_model EEM_Question_group instance (for queries)
+	 *
+	 * @var EEM_Question_Group $_question_group_model
+	 */
+	protected $_question_group_model;
+
+
+	/**
+	 * @Constructor
+	 * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct($routing = true)
+	{
+		require_once(EE_MODELS . 'EEM_Question.model.php');
+		require_once(EE_MODELS . 'EEM_Question_Group.model.php');
+		$this->_question_model       = EEM_Question::instance();
+		$this->_question_group_model = EEM_Question_Group::instance();
+		parent::__construct($routing);
+	}
+
+
+	protected function _init_page_props()
+	{
+		$this->page_slug        = REGISTRATION_FORM_PG_SLUG;
+		$this->page_label       = esc_html__('Registration Form', 'event_espresso');
+		$this->_admin_base_url  = REGISTRATION_FORM_ADMIN_URL;
+		$this->_admin_base_path = REGISTRATION_FORM_ADMIN;
+	}
+
+
+	protected function _ajax_hooks()
+	{
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = esc_html__('Registration Form', 'event_espresso');
+		$this->_labels           = [
+			'buttons' => [
+				'edit_question' => esc_html__('Edit Question', 'event_espresso'),
+			],
+		];
+	}
+
+
+	/**
+	 *_set_page_routes
+	 */
+	protected function _set_page_routes()
+	{
+		$qst_id             =
+			! empty($this->_req_data['QST_ID'])
+				? $this->_req_data['QST_ID']
+				: 0;
+		$this->_page_routes = [
+			'default' => [
+				'func'       => '_questions_overview_list_table',
+				'capability' => 'ee_read_questions',
+			],
+
+			'edit_question' => [
+				'func'       => '_edit_question',
+				'capability' => 'ee_edit_question',
+				'obj_id'     => $qst_id,
+				'args'       => ['edit'],
+			],
+
+			'question_groups' => [
+				'func'       => '_questions_groups_preview',
+				'capability' => 'ee_read_question_groups',
+			],
+
+			'update_question' => [
+				'func'       => '_insert_or_update_question',
+				'args'       => ['new_question' => false],
+				'capability' => 'ee_edit_question',
+				'obj_id'     => $qst_id,
+				'noheader'   => true,
+			],
+		];
+	}
+
+
+	protected function _set_page_config()
+	{
+		$this->_page_config = [
+			'default' => [
+				'nav'           => [
+					'label' => esc_html__('Questions', 'event_espresso'),
+					'order' => 10,
+				],
+				'list_table'    => 'Registration_Form_Questions_Admin_List_Table',
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'help_tabs'     => [
+					'registration_form_questions_overview_help_tab'                           => [
+						'title'    => esc_html__('Questions Overview', 'event_espresso'),
+						'filename' => 'registration_form_questions_overview',
+					],
+					'registration_form_questions_overview_table_column_headings_help_tab'     => [
+						'title'    => esc_html__('Questions Overview Table Column Headings', 'event_espresso'),
+						'filename' => 'registration_form_questions_overview_table_column_headings',
+					],
+					'registration_form_questions_overview_views_bulk_actions_search_help_tab' => [
+						'title'    => esc_html__('Question Overview Views & Bulk Actions & Search', 'event_espresso'),
+						'filename' => 'registration_form_questions_overview_views_bulk_actions_search',
+					],
+				],
+				'require_nonce' => false,
+				'qtips'         => [
+					'EE_Registration_Form_Tips',
+				]/**/
+			],
+
+			'question_groups' => [
+				'nav'           => [
+					'label' => esc_html__('Question Groups', 'event_espresso'),
+					'order' => 20,
+				],
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'help_tabs'     => [
+					'registration_form_question_groups_help_tab' => [
+						'title'    => esc_html__('Question Groups', 'event_espresso'),
+						'filename' => 'registration_form_question_groups',
+					],
+				],
+				'require_nonce' => false,
+			],
+
+			'edit_question' => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Question', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => isset($this->_req_data['question_id'])
+						? add_query_arg(
+							['question_id' => $this->_req_data['question_id']],
+							$this->_current_page_view_url
+						)
+						: $this->_admin_base_url,
+				],
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
+				'help_tabs'     => [
+					'registration_form_edit_question_group_help_tab' => [
+						'title'    => esc_html__('Edit Question', 'event_espresso'),
+						'filename' => 'registration_form_edit_question',
+					],
+				],
+				'require_nonce' => false,
+			],
+		];
+	}
+
+
+	protected function _add_screen_options()
+	{
+		// todo
+	}
+
+
+	protected function _add_screen_options_default()
+	{
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Questions', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	protected function _add_screen_options_question_groups()
+	{
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Question Groups', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	// none of the below group are currently used for Event Categories
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	public function load_scripts_styles()
+	{
+		wp_register_style(
+			'espresso_registration',
+			REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_registration');
+	}
+
+
+	public function admin_init()
+	{
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	public function load_scripts_styles_default()
+	{
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	public function load_scripts_styles_add_question()
+	{
+		$this->load_scripts_styles_question_details();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	public function load_scripts_styles_edit_question()
+	{
+		$this->load_scripts_styles_question_details();
+	}
+
+
+	/**
+	 * Loads the JS required for adding or editing a question
+	 *
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function load_scripts_styles_question_details()
+	{
+		$this->load_scripts_styles_forms();
+		wp_register_script(
+			'espresso_registration_form_single',
+			REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.js',
+			['jquery-ui-sortable'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('espresso_registration_form_single');
+		wp_localize_script(
+			'espresso_registration_form_single',
+			'ee_question_data',
+			[
+				'question_types_with_max'    => EEM_Question::instance()->questionTypesWithMaxLength(),
+				'question_type_with_options' => EEM_Question::instance()->question_types_with_options(),
+			]
+		);
+	}
+
+
+	public function recaptcha_info_help_tab()
+	{
+		$template = REGISTRATION_FORM_TEMPLATE_PATH . 'recaptcha_info_help_tab.template.php';
+		EEH_Template::display_template($template, []);
+	}
+
+
+	public function load_scripts_styles_forms()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		// scripts
+		wp_enqueue_script('ee_admin_js');
+	}
+
+
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = [
+			'all' => [
+				'slug'  => 'all',
+				'label' => esc_html__('View All Questions', 'event_espresso'),
+				'count' => 0,
+			],
+		];
+
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_questions',
+				'espresso_registration_form_trash_questions'
+			)
+		) {
+			$this->_views['trash'] = [
+				'slug'  => 'trash',
+				'label' => esc_html__('Trash', 'event_espresso'),
+				'count' => 0,
+			];
+		}
+	}
+
+
+	/**
+	 * This just previews the question groups tab that comes in caffeinated.
+	 *
+	 * @return void html
+	 * @throws EE_Error
+	 */
+	protected function _questions_groups_preview()
+	{
+		$this->_admin_page_title              = esc_html__('Question Groups (Preview)', 'event_espresso');
+		$this->_template_args['preview_img']  =
+			'<img src="' . REGISTRATION_FORM_ASSETS_URL . 'caf_reg_form_preview.jpg" alt="'
+			. esc_attr__(
+				'Preview Question Groups Overview List Table screenshot',
+				'event_espresso'
+			) . '" />';
+		$this->_template_args['preview_text'] = '<strong>'
+												. esc_html__(
+													'Question Groups is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Question Groups feature you are able to create new question groups, edit existing question groups, and create and edit new questions and add them to question groups.',
+													'event_espresso'
+												) . '</strong>';
+		$this->display_admin_caf_preview_page('question_groups_tab');
+	}
+
+
+	/**
+	 * Extracts the question field's values from the POST request to update or insert them
+	 *
+	 * @param EEM_Base $model
+	 * @return array where each key is the name of a model's field/db column, and each value is its value.
+	 * @throws EE_Error
+	 */
+	protected function _set_column_values_for(EEM_Base $model)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$set_column_values = [];
+
+		// some initial checks for proper values.
+		// if QST_admin_only, then no matter what QST_required is we disable.
+		if (! empty($this->_req_data['QST_admin_only'])) {
+			$this->_req_data['QST_required'] = 0;
+		}
+		// if the question shouldn't have a max length, don't let them set one
+		if (
+			! isset(
+				$this->_req_data['QST_type'],
+				$this->_req_data['QST_max']
+			)
+			|| ! in_array(
+				$this->_req_data['QST_type'],
+				EEM_Question::instance()->questionTypesWithMaxLength(),
+				true
+			)
+		) {
+			// they're not allowed to set the max
+			$this->_req_data['QST_max'] = null;
+		}
+		foreach ($model->field_settings() as $fieldName => $settings) {
+			// basically if QSG_identifier is empty or not set
+			if (
+				$fieldName === 'QSG_identifier'
+				&& (isset($this->_req_data['QSG_identifier']) && empty($this->_req_data['QSG_identifier']))
+			) {
+				$QSG_name = isset($this->_req_data['QSG_name'])
+					? $this->_req_data['QSG_name']
+					: '';
+				$set_column_values[ $fieldName ] = sanitize_title($QSG_name) . '-' . uniqid('', true);
+			} elseif (
+				$fieldName === 'QST_admin_label'
+				&& (isset($this->_req_data['QST_admin_label']) && empty($this->_req_data['QST_admin_label']))
+			) {
+				// the admin label is blank, use a slug version of the question text
+				$QST_text                        =
+					isset($this->_req_data['QST_display_text'])
+						? $this->_req_data['QST_display_text']
+						: '';
+				$set_column_values[ $fieldName ] = sanitize_title(wp_trim_words($QST_text, 10));
+			} elseif ($fieldName === 'QST_admin_only' && (! isset($this->_req_data['QST_admin_only']))) {
+				$set_column_values[ $fieldName ] = 0;
+			} elseif ($fieldName === 'QST_max') {
+				$qst_system = EEM_Question::instance()->get_var(
+					[
+						[
+							'QST_ID' => isset($this->_req_data['QST_ID'])
+								? $this->_req_data['QST_ID']
+								: 0,
+						],
+					],
+					'QST_system'
+				);
+				$max_max    = EEM_Question::instance()->absolute_max_for_system_question($qst_system);
+				if (
+					empty($this->_req_data['QST_max']) || $this->_req_data['QST_max'] > $max_max
+				) {
+					$set_column_values[ $fieldName ] = $max_max;
+				}
+			}
+
+
+			// only add a property to the array if it's not null (otherwise the model should just use the default value)
+			if (
+				! isset($set_column_values[ $fieldName ]) && isset($this->_req_data[ $fieldName ])
+			) {
+				$set_column_values[ $fieldName ] = $this->_req_data[ $fieldName ];
+			}
+		}
+		return $set_column_values;// validation fo this data to be performed by the model before insertion.
+	}
+
+
+	/**
+	 *_questions_overview_list_table
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _questions_overview_list_table()
+	{
+		$this->_search_btn_label = esc_html__('Questions', 'event_espresso');
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	/**
+	 * _edit_question
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _edit_question()
+	{
+		$ID = isset($this->_req_data['QST_ID']) && ! empty($this->_req_data['QST_ID'])
+			? absint($this->_req_data['QST_ID'])
+			: false;
+
+		switch ($this->_req_action) {
+			case 'add_question':
+				$this->_admin_page_title = esc_html__('Add Question', 'event_espresso');
+				break;
+			case 'edit_question':
+				$this->_admin_page_title = esc_html__('Edit Question', 'event_espresso');
+				break;
+			default:
+				$this->_admin_page_title = ucwords(str_replace('_', ' ', $this->_req_action));
+		}
+
+		// add PRC_ID to title if editing
+		$this->_admin_page_title =
+			$ID
+				? $this->_admin_page_title . ' # ' . $ID
+				: $this->_admin_page_title;
+		if ($ID) {
+			$question                 = $this->_question_model->get_one_by_ID($ID);
+			$additional_hidden_fields = ['QST_ID' => ['type' => 'hidden', 'value' => $ID]];
+			$this->_set_add_edit_form_tags('update_question', $additional_hidden_fields);
+		} else {
+			$question = EE_Question::new_instance();
+			$question->set_order_to_latest();
+			$this->_set_add_edit_form_tags('insert_question');
+		}
+		if ($question->system_ID() === EEM_Attendee::system_question_phone) {
+			$question_types = array_intersect_key(
+				EEM_Question::instance()->allowed_question_types(),
+				array_flip(
+					[
+						EEM_Question::QST_type_text,
+						EEM_Question::QST_type_us_phone,
+					]
+				)
+			);
+		} else {
+			$question_types = $question->has_answers()
+				? $this->_question_model->question_types_in_same_category($question->type())
+				: $this->_question_model->allowed_question_types();
+		}
+		$this->_template_args['QST_ID']                     = $ID;
+		$this->_template_args['question']                   = $question;
+		$this->_template_args['question_types']             = $question_types;
+		$this->_template_args['max_max']                    =
+			EEM_Question::instance()->absolute_max_for_system_question(
+				$question->system_ID()
+			);
+		$this->_template_args['question_type_descriptions'] = $this->_get_question_type_descriptions();
+		$this->_set_publish_post_box_vars('id', $ID);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			REGISTRATION_FORM_TEMPLATE_PATH . 'questions_main_meta_box.template.php',
+			$this->_template_args,
+			true
+		);
+
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_question_type_descriptions()
+	{
+		EE_Registry::instance()->load_helper('HTML');
+		$descriptions               = '';
+		$question_type_descriptions = EEM_Question::instance()->question_descriptions();
+		foreach ($question_type_descriptions as $type => $question_type_description) {
+			if ($type == 'HTML_TEXTAREA') {
+				$html                      = new EE_Simple_HTML_Validation_Strategy();
+				$question_type_description .= sprintf(
+					esc_html__('%1$s(allowed tags: %2$s)', 'event_espresso'),
+					'<br/>',
+					$html->get_list_of_allowed_tags()
+				);
+			}
+			$descriptions .= EEH_HTML::p(
+				$question_type_description,
+				'question_type_description-' . $type,
+				'question_type_description description',
+				'display:none;'
+			);
+		}
+		return $descriptions;
+	}
+
+
+	/**
+	 * @param bool|true $new_question
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _insert_or_update_question($new_question = true)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$set_column_values = $this->_set_column_values_for($this->_question_model);
+		if ($new_question) {
+			$question    = EE_Question::new_instance($set_column_values);
+			$action_desc = 'added';
+		} else {
+			$question = EEM_Question::instance()->get_one_by_ID(absint($this->_req_data['QST_ID']));
+			foreach ($set_column_values as $field => $new_value) {
+				$question->set($field, $new_value);
+			}
+			$action_desc = 'updated';
+		}
+		$success = $question->save();
+		$ID      = $question->ID();
+		if ($ID && $question->should_have_question_options()) {
+			// save the related options
+			// trash removed options, save old ones
+			// get list of all options
+			$options = $question->options();
+			if (! empty($options)) {
+				foreach ($options as $option_ID => $option) {
+					$option_req_index = $this->_get_option_req_data_index($option_ID);
+					if ($option_req_index !== false) {
+						$option->save($this->_req_data['question_options'][ $option_req_index ]);
+					} else {
+						// not found, remove it
+						$option->delete();
+					}
+				}
+			}
+			// save new related options
+			foreach ($this->_req_data['question_options'] as $index => $option_req_data) {
+				// skip $index that is from our sample
+				if ($index === 'xxcountxx') {
+					continue;
+				}
+				// note we allow saving blank options.
+				if (empty($option_req_data['QSO_ID'])) {
+					// no ID! save it!
+					$new_option = EE_Question_Option::new_instance(
+						[
+							'QSO_value' => $option_req_data['QSO_value'],
+							'QSO_desc'  => $option_req_data['QSO_desc'],
+							'QSO_order' => $option_req_data['QSO_order'],
+							'QST_ID'    => $question->ID(),
+						]
+					);
+					$new_option->save();
+				}
+			}
+		}
+		$query_args = ['action' => 'edit_question', 'QST_ID' => $ID];
+		if ($success !== 0) {
+			$msg = $new_question
+				? sprintf(
+					esc_html__('The %s has been created', 'event_espresso'),
+					$this->_question_model->item_name()
+				)
+				: sprintf(
+					esc_html__('The %s has been updated', 'event_espresso'),
+					$this->_question_model->item_name()
+				);
+			EE_Error::add_success($msg);
+		}
+
+		$this->_redirect_after_action(false, '', $action_desc, $query_args, true);
+	}
+
+
+	/**
+	 * Upon saving a question, there should be an array of 'question_options'. This array is index numerically, but not
+	 * by ID
+	 * (this is done because new question options don't have an ID, but we may want to add multiple simultaneously).
+	 * So, this function gets the index in that request data array called question_options. Returns FALSE if not found.
+	 *
+	 * @param int $ID of the question option to find
+	 * @return int index in question_options array if successful, FALSE if unsuccessful
+	 */
+	protected function _get_option_req_data_index($ID)
+	{
+		$req_data_for_question_options = $this->_req_data['question_options'];
+		foreach ($req_data_for_question_options as $num => $option_data) {
+			if (array_key_exists('QSO_ID', $option_data) && (int) $option_data['QSO_ID'] === $ID) {
+				return $num;
+			}
+		}
+		return false;
+	}
+
+
+
+
+	/***********/
+	/* QUERIES */
+	/**
+	 * For internal use in getting all the query parameters
+	 * (because it's pretty well the same between question, question groups,
+	 * and for both when searching for trashed and untrashed ones)
+	 *
+	 * @param EEM_Base $model either EEM_Question or EEM_Question_Group
+	 * @param int      $per_page
+	 * @param int      $current_page
+	 * @return array model query params, @see
+	 *               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	protected function get_query_params($model, $per_page = 10, $current_page = 10)
+	{
+		$query_params             = [];
+		$offset                   = ($current_page - 1) * $per_page;
+		$query_params['limit']    = [$offset, $per_page];
+		$order                    =
+			(isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
+				? $this->_req_data['order']
+				: 'ASC';
+		$orderby_field            =
+			$model instanceof EEM_Question
+				? 'QST_ID'
+				: 'QSG_order';
+		$field_to_order_by        =
+			empty($this->_req_data['orderby'])
+				? $orderby_field
+				: $this->_req_data['orderby'];
+		$query_params['order_by'] = [$field_to_order_by => $order];
+		$search_string            =
+			array_key_exists('s', $this->_req_data)
+				? $this->_req_data['s']
+				: null;
+		if (! empty($search_string)) {
+			if ($model instanceof EEM_Question_Group) {
+				$query_params[0] = [
+					'OR' => [
+						'QSG_name' => ['LIKE', "%$search_string%"],
+						'QSG_desc' => ['LIKE', "%$search_string%"],
+					],
+				];
+			} else {
+				$query_params[0] = [
+					'QST_display_text' => ['LIKE', "%$search_string%"],
+				];
+			}
+		}
+
+		// capability checks (just leaving this commented out for reference because it illustrates some complicated query params that could be useful when fully implemented)
+		/*if ( $model instanceof EEM_Question_Group ) {
             if ( ! EE_Registry::instance()->CAP->current_user_can( 'edit_others_question_groups', 'espresso_registration_form_edit_question_group' ) ) {
                 $query_params[0] = array(
                     'AND' => array(
@@ -745,67 +745,67 @@ 
             }
         }/**/
 
-        return $query_params;
-    }
-
-
-    /**
-     * @param int        $per_page
-     * @param int        $current_page
-     * @param bool|false $count
-     * @return EE_Base_Class[]|EE_Question_Group[]|EE_Soft_Delete_Base_Class[]|int
-     * @throws EE_Error
-     */
-    public function get_questions($per_page = 10, $current_page = 1, $count = false)
-    {
-        $QST          = EEM_Question::instance();
-        $query_params = $this->get_query_params($QST, $per_page, $current_page);
-        if ($count) {
-            $where   =
-                isset($query_params[0])
-                    ? [$query_params[0]]
-                    : [];
-            $results = $QST->count($where);
-        } else {
-            $results = $QST->get_all($query_params);
-        }
-        return $results;
-    }
-
-
-    /**
-     * @param            $per_page
-     * @param int        $current_page
-     * @param bool|false $count
-     * @return EE_Soft_Delete_Base_Class[]|int
-     * @throws EE_Error
-     */
-    public function get_trashed_questions($per_page, $current_page = 1, $count = false)
-    {
-        $query_params = $this->get_query_params(EEM_Question::instance(), $per_page, $current_page);
-        $where        =
-            isset($query_params[0])
-                ? [$query_params[0]]
-                : [];
-        return $count
-            ? EEM_Question::instance()->count_deleted($where)
-            : EEM_Question::instance()->get_all_deleted($query_params);
-    }
-
-
-    /**
-     * @param            $per_page
-     * @param int        $current_page
-     * @param bool|false $count
-     * @return EE_Base_Class[]|EE_Question_Group[]|EE_Soft_Delete_Base_Class[]
-     * @throws EE_Error
-     */
-    public function get_question_groups($per_page, $current_page = 1, $count = false)
-    {
-        $questionGroupModel = EEM_Question_Group::instance();
-        // note: this a subclass of EEM_Soft_Delete_Base, so this is actually only getting non-trashed items
-        return $questionGroupModel->get_all(
-            $this->get_query_params($questionGroupModel, $per_page, $current_page)
-        );
-    }
+		return $query_params;
+	}
+
+
+	/**
+	 * @param int        $per_page
+	 * @param int        $current_page
+	 * @param bool|false $count
+	 * @return EE_Base_Class[]|EE_Question_Group[]|EE_Soft_Delete_Base_Class[]|int
+	 * @throws EE_Error
+	 */
+	public function get_questions($per_page = 10, $current_page = 1, $count = false)
+	{
+		$QST          = EEM_Question::instance();
+		$query_params = $this->get_query_params($QST, $per_page, $current_page);
+		if ($count) {
+			$where   =
+				isset($query_params[0])
+					? [$query_params[0]]
+					: [];
+			$results = $QST->count($where);
+		} else {
+			$results = $QST->get_all($query_params);
+		}
+		return $results;
+	}
+
+
+	/**
+	 * @param            $per_page
+	 * @param int        $current_page
+	 * @param bool|false $count
+	 * @return EE_Soft_Delete_Base_Class[]|int
+	 * @throws EE_Error
+	 */
+	public function get_trashed_questions($per_page, $current_page = 1, $count = false)
+	{
+		$query_params = $this->get_query_params(EEM_Question::instance(), $per_page, $current_page);
+		$where        =
+			isset($query_params[0])
+				? [$query_params[0]]
+				: [];
+		return $count
+			? EEM_Question::instance()->count_deleted($where)
+			: EEM_Question::instance()->get_all_deleted($query_params);
+	}
+
+
+	/**
+	 * @param            $per_page
+	 * @param int        $current_page
+	 * @param bool|false $count
+	 * @return EE_Base_Class[]|EE_Question_Group[]|EE_Soft_Delete_Base_Class[]
+	 * @throws EE_Error
+	 */
+	public function get_question_groups($per_page, $current_page = 1, $count = false)
+	{
+		$questionGroupModel = EEM_Question_Group::instance();
+		// note: this a subclass of EEM_Soft_Delete_Base, so this is actually only getting non-trashed items
+		return $questionGroupModel->get_all(
+			$this->get_query_params($questionGroupModel, $per_page, $current_page)
+		);
+	}
 }

caffeinated/core/libraries/shortcodes/EE_Question_List_Shortcodes.lib.php

Spacing +4 added lines, -4 removed lines

@@ -94,16 +94,16 @@
             ? $this->_extra_data['template']['question_list']
             : $template;
         $ans_result       = '';
-        $answers          = ! empty($this->_extra_data['data']->registrations[ $reg_obj->ID() ]['ans_objs'])
-            ? $this->_extra_data['data']->registrations[ $reg_obj->ID() ]['ans_objs']
+        $answers          = ! empty($this->_extra_data['data']->registrations[$reg_obj->ID()]['ans_objs'])
+            ? $this->_extra_data['data']->registrations[$reg_obj->ID()]['ans_objs']
             : [];
         $questions        = ! empty($this->_extra_data['data']->questions)
             ? $this->_extra_data['data']->questions
             : [];
         foreach ($answers as $answer) {
             // first see if the question is in our $questions array.  If not then try to get from answer object
-            $question = isset($questions[ $answer->ID() ])
-                ? $questions[ $answer->ID() ]
+            $question = isset($questions[$answer->ID()])
+                ? $questions[$answer->ID()]
                 : null;
             $question = ! $question instanceof EE_Question
                 ? $answer->question()

Indentation +95 added lines, -95 removed lines

@@ -15,109 +15,109 @@
  */
 class EE_Question_List_Shortcodes extends EE_Shortcodes
 {
-    public function __construct()
-    {
-        parent::__construct();
-    }
+	public function __construct()
+	{
+		parent::__construct();
+	}
 
 
-    protected function _init_props()
-    {
-        $this->label       = esc_html__('Questions and Answers Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes related to custom questions and answers', 'event_espresso');
-        $this->_shortcodes = [
-            '[QUESTION_LIST]' => esc_html__(
-                'This is used to indicate where you want the list of questions and answers to show for the registrant.  You place this within the "[attendee_list]" field.',
-                'event_espresso'
-            ),
-        ];
-    }
+	protected function _init_props()
+	{
+		$this->label       = esc_html__('Questions and Answers Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes related to custom questions and answers', 'event_espresso');
+		$this->_shortcodes = [
+			'[QUESTION_LIST]' => esc_html__(
+				'This is used to indicate where you want the list of questions and answers to show for the registrant.  You place this within the "[attendee_list]" field.',
+				'event_espresso'
+			),
+		];
+	}
 
 
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _parser($shortcode)
-    {
-        switch ($shortcode) {
-            case '[QUESTION_LIST]':
-                return $this->_get_question_list();
-        }
-        return '';
-    }
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _parser($shortcode)
+	{
+		switch ($shortcode) {
+			case '[QUESTION_LIST]':
+				return $this->_get_question_list();
+		}
+		return '';
+	}
 
 
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_question_list()
-    {
-        $this->_validate_list_requirements();
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_question_list()
+	{
+		$this->_validate_list_requirements();
 
-        // for when [QUESTION_LIST] is used in the [attendee_list] field.
-        if ($this->_data['data'] instanceof EE_Registration) {
-            return $this->_get_question_answer_list_for_attendee();
-        }
-        // for when [QUESTION_LIST] is used in the main content field.
-        if (
-            $this->_data['data'] instanceof EE_Messages_Addressee
-            && $this->_data['data']->reg_obj instanceof EE_Registration
-        ) {
-            return $this->_get_question_answer_list_for_attendee($this->_data['data']->reg_obj);
-        }
-        return '';
-    }
+		// for when [QUESTION_LIST] is used in the [attendee_list] field.
+		if ($this->_data['data'] instanceof EE_Registration) {
+			return $this->_get_question_answer_list_for_attendee();
+		}
+		// for when [QUESTION_LIST] is used in the main content field.
+		if (
+			$this->_data['data'] instanceof EE_Messages_Addressee
+			&& $this->_data['data']->reg_obj instanceof EE_Registration
+		) {
+			return $this->_get_question_answer_list_for_attendee($this->_data['data']->reg_obj);
+		}
+		return '';
+	}
 
 
-    /**
-     * Note when we parse the "[question_list]" shortcode for attendees we're actually going to retrieve the list of
-     * answers for that attendee since that is what we really need (we can derive the questions from the answers);
-     *
-     * @param null $reg_obj
-     * @return string parsed template.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_question_answer_list_for_attendee($reg_obj = null)
-    {
-        $valid_shortcodes = ['question'];
-        $reg_obj          = $reg_obj instanceof EE_Registration
-            ? $reg_obj
-            : $this->_data['data'];
-        $template         = is_array($this->_data['template']) && isset($this->_data['template']['question_list'])
-            ? $this->_data['template']['question_list']
-            : '';
-        $template         = empty($template) && isset($this->_extra_data['template']['question_list'])
-            ? $this->_extra_data['template']['question_list']
-            : $template;
-        $ans_result       = '';
-        $answers          = ! empty($this->_extra_data['data']->registrations[ $reg_obj->ID() ]['ans_objs'])
-            ? $this->_extra_data['data']->registrations[ $reg_obj->ID() ]['ans_objs']
-            : [];
-        $questions        = ! empty($this->_extra_data['data']->questions)
-            ? $this->_extra_data['data']->questions
-            : [];
-        foreach ($answers as $answer) {
-            // first see if the question is in our $questions array.  If not then try to get from answer object
-            $question = isset($questions[ $answer->ID() ])
-                ? $questions[ $answer->ID() ]
-                : null;
-            $question = ! $question instanceof EE_Question
-                ? $answer->question()
-                : $question;
-            if ($question instanceof EE_Question and $question->admin_only()) {
-                continue;
-            }
-            $ans_result .= $this->_shortcode_helper->parse_question_list_template(
-                $template,
-                $answer,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
+	/**
+	 * Note when we parse the "[question_list]" shortcode for attendees we're actually going to retrieve the list of
+	 * answers for that attendee since that is what we really need (we can derive the questions from the answers);
+	 *
+	 * @param null $reg_obj
+	 * @return string parsed template.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_question_answer_list_for_attendee($reg_obj = null)
+	{
+		$valid_shortcodes = ['question'];
+		$reg_obj          = $reg_obj instanceof EE_Registration
+			? $reg_obj
+			: $this->_data['data'];
+		$template         = is_array($this->_data['template']) && isset($this->_data['template']['question_list'])
+			? $this->_data['template']['question_list']
+			: '';
+		$template         = empty($template) && isset($this->_extra_data['template']['question_list'])
+			? $this->_extra_data['template']['question_list']
+			: $template;
+		$ans_result       = '';
+		$answers          = ! empty($this->_extra_data['data']->registrations[ $reg_obj->ID() ]['ans_objs'])
+			? $this->_extra_data['data']->registrations[ $reg_obj->ID() ]['ans_objs']
+			: [];
+		$questions        = ! empty($this->_extra_data['data']->questions)
+			? $this->_extra_data['data']->questions
+			: [];
+		foreach ($answers as $answer) {
+			// first see if the question is in our $questions array.  If not then try to get from answer object
+			$question = isset($questions[ $answer->ID() ])
+				? $questions[ $answer->ID() ]
+				: null;
+			$question = ! $question instanceof EE_Question
+				? $answer->question()
+				: $question;
+			if ($question instanceof EE_Question and $question->admin_only()) {
+				continue;
+			}
+			$ans_result .= $this->_shortcode_helper->parse_question_list_template(
+				$template,
+				$answer,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
 
-        return $ans_result;
-    }
+		return $ans_result;
+	}
 }

caffeinated/payment_methods/Paypal_Pro/help_tabs/payment_methods_overview_paypalpro.help_tab.php

Indentation +37 added lines, -37 removed lines

@@ -4,10 +4,10 @@ 
 </p>
 <p>
     <?php printf(
-        esc_html__('See %1$shere%2$s for list of currencies supported by Paypal Pro.', 'event_espresso'),
-        "<a href='https://www.paypal.com/multicurrency' target='_blank' rel='noopener noreferrer'>",
-        "</a>"
-    ); ?>
+		esc_html__('See %1$shere%2$s for list of currencies supported by Paypal Pro.', 'event_espresso'),
+		"<a href='https://www.paypal.com/multicurrency' target='_blank' rel='noopener noreferrer'>",
+		"</a>"
+	); ?>
 </p>
 <p><strong><?php esc_html_e('PayPal Pro Settings', 'event_espresso'); ?></strong></p>
 <ul>
@@ -18,48 +18,48 @@ 
     <li>
         <strong><?php esc_html_e('PayPal API Username', 'event_espresso'); ?></strong><br/>
         <?php
-        printf(
-            esc_html__(
-                'Enter your API Username for PayPal. Learn how to find your %1$sAPI Username%2$s.',
-                'event_espresso'
-            ),
-            '<a href="https://www.paypal.com/us/cgi-bin/webscr?cmd=xpt/cps/merchant/wppro/WPProIntegrationSteps-outside#SectionB" target="_blank" rel="noopener noreferrer">',
-            '</a>'
-        );
-        ?>
+		printf(
+			esc_html__(
+				'Enter your API Username for PayPal. Learn how to find your %1$sAPI Username%2$s.',
+				'event_espresso'
+			),
+			'<a href="https://www.paypal.com/us/cgi-bin/webscr?cmd=xpt/cps/merchant/wppro/WPProIntegrationSteps-outside#SectionB" target="_blank" rel="noopener noreferrer">',
+			'</a>'
+		);
+		?>
     </li>
     <li>
         <strong><?php esc_html_e('PayPal API Password', 'event_espresso'); ?></strong><br/>
         <?php
-        printf(
-            esc_html__(
-                'Enter your API Password for PayPal. Learn how to find your %1$sAPI Password%2$s.',
-                'event_espresso'
-            ),
-            '<a href="https://www.paypal.com/us/cgi-bin/webscr?cmd=xpt/cps/merchant/wppro/WPProIntegrationSteps-outside#SectionB" target="_blank" rel="noopener noreferrer">',
-            '</a>'
-        );
-        ?>
+		printf(
+			esc_html__(
+				'Enter your API Password for PayPal. Learn how to find your %1$sAPI Password%2$s.',
+				'event_espresso'
+			),
+			'<a href="https://www.paypal.com/us/cgi-bin/webscr?cmd=xpt/cps/merchant/wppro/WPProIntegrationSteps-outside#SectionB" target="_blank" rel="noopener noreferrer">',
+			'</a>'
+		);
+		?>
     </li>
     <li>
         <strong><?php esc_html_e('PayPal API Signature', 'event_espresso'); ?></strong><br/>
         <?php
-        printf(
-            esc_html__(
-                'Enter your API Signature for PayPal. Learn how to find your %1$sAPI Signature%2$s.',
-                'event_espresso'
-            ),
-            '<a href="https://www.paypal.com/us/cgi-bin/webscr?cmd=xpt/cps/merchant/wppro/WPProIntegrationSteps-outside#SectionB" target="_blank" rel="noopener noreferrer">',
-            '</a>'
-        );
-        ?>
+		printf(
+			esc_html__(
+				'Enter your API Signature for PayPal. Learn how to find your %1$sAPI Signature%2$s.',
+				'event_espresso'
+			),
+			'<a href="https://www.paypal.com/us/cgi-bin/webscr?cmd=xpt/cps/merchant/wppro/WPProIntegrationSteps-outside#SectionB" target="_blank" rel="noopener noreferrer">',
+			'</a>'
+		);
+		?>
     </li>
     <li>
         <strong><?php esc_html_e('Country Currency', 'event_espresso'); ?></strong><br/>
         <?php esc_html_e(
-            'Select the currency for your country. Payments will be accepted in this currency.',
-            'event_espresso'
-        ); ?>
+			'Select the currency for your country. Payments will be accepted in this currency.',
+			'event_espresso'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Accepted Card Types', 'event_espresso'); ?></strong><br/>
@@ -68,9 +68,9 @@ 
     <li>
         <strong><?php esc_html_e('Use the Debugging Feature and the PayPal Sandbox', 'event_espresso'); ?></strong><br/>
         <?php esc_html_e(
-            'Specify if you want to test the payment gateway by submitting a test transaction. If this option is enabled, be sure to enter your PayPal sandbox credentials in the fields above. Be sure to turn this setting off when you are done testing.',
-            'event_espresso'
-        ); ?>
+			'Specify if you want to test the payment gateway by submitting a test transaction. If this option is enabled, be sure to enter your PayPal sandbox credentials in the fields above. Be sure to turn this setting off when you are done testing.',
+			'event_espresso'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Button Image URL', 'event_espresso'); ?></strong><br/>

caffeinated/payment_methods/Aim/help_tabs/payment_methods_overview_aim.help_tab.php

Indentation +54 added lines, -54 removed lines

@@ -6,15 +6,15 @@ 
 </p>
 <p>
     <?php
-    printf(
-        esc_html__(
-            'See %1$shere%2$s for list of currencies supported by Authorize.net AIM.',
-            'event_espresso'
-        ),
-        "<a href='https://support.authorize.net/s/article/Which-Currencies-Does-Authorize-Net-Support/' target='_blank' rel='noopener noreferrer'>",
-        "</a>"
-    );
-    ?>
+	printf(
+		esc_html__(
+			'See %1$shere%2$s for list of currencies supported by Authorize.net AIM.',
+			'event_espresso'
+		),
+		"<a href='https://support.authorize.net/s/article/Which-Currencies-Does-Authorize-Net-Support/' target='_blank' rel='noopener noreferrer'>",
+		"</a>"
+	);
+	?>
 </p>
 <p>
     <strong><?php esc_html_e('Authorize.net AIM Settings', 'event_espresso'); ?></strong>
@@ -24,70 +24,70 @@ 
         <strong><?php esc_html_e('Authorize.net API Login ID', 'event_espresso'); ?></strong>
         <br/>
         <?php
-        printf(
-            esc_html__(
-                'Enter your API Login ID for Authorize.net. Learn how to find your %1$sAPI Login%2$s ID.',
-                'event_espresso'
-            ),
-            '<a href="https://support.authorize.net/authkb/index?page=content&id=A405" target="_blank" rel="noopener noreferrer">',
-            '</a>'
-        );
-        ?>
+		printf(
+			esc_html__(
+				'Enter your API Login ID for Authorize.net. Learn how to find your %1$sAPI Login%2$s ID.',
+				'event_espresso'
+			),
+			'<a href="https://support.authorize.net/authkb/index?page=content&id=A405" target="_blank" rel="noopener noreferrer">',
+			'</a>'
+		);
+		?>
     </li>
     <li>
         <strong><?php esc_html_e('Authorize.net Transaction Key', 'event_espresso'); ?></strong>
         <br/>
         <?php
-        printf(
-            esc_html__(
-                'Enter your Transaction Key for Authorize.net. Learn how to find your %1$sTransaction Key%2$s.',
-                'event_espresso'
-            ),
-            '<a href="https://support.authorize.net/authkb/index?page=content&id=A405" target="_blank" rel="noopener noreferrer">',
-            '</a>'
-        );
-        ?>
+		printf(
+			esc_html__(
+				'Enter your Transaction Key for Authorize.net. Learn how to find your %1$sTransaction Key%2$s.',
+				'event_espresso'
+			),
+			'<a href="https://support.authorize.net/authkb/index?page=content&id=A405" target="_blank" rel="noopener noreferrer">',
+			'</a>'
+		);
+		?>
     </li>
     <li>
         <strong>
             <?php esc_html_e(
-                'Is this an account on the Authorize.net development server?',
-                'event_espresso'
-            ); ?>
+				'Is this an account on the Authorize.net development server?',
+				'event_espresso'
+			); ?>
         </strong>
         <br/>
         <?php esc_html_e(
-            'Specify whether this is a live/production account or a test account on the Authorize.net development server.',
-            'event_espresso'
-        ); ?>
+			'Specify whether this is a live/production account or a test account on the Authorize.net development server.',
+			'event_espresso'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Do you want to submit a test transaction?', 'event_espresso'); ?></strong>
         <br/>
         <?php esc_html_e(
-            'Specify if you want to test the Authorize.net AIM payment gateway by submitting a test transaction. Be sure to turn this setting off when you are done testing.',
-            'event_espresso'
-        ); ?>
+			'Specify if you want to test the Authorize.net AIM payment gateway by submitting a test transaction. Be sure to turn this setting off when you are done testing.',
+			'event_espresso'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Excluded and Required Payment Form Fields', 'event_espresso'); ?></strong>
         <br/>
         <?php esc_html_e(
-            'By logging into Authorize.net, you can change which payment fields are required by Authorize.net when processing payments. These settings affect both the Advanced Integration Method (AIM, this) and the Simple Integration Method (SIM, different). The payment method settings "Excluded Payment Form Fields" and "Required Payment Form Fields" allow you to change the billing form in Event Espresso to reflect your payment form settings in Authorize.net.',
-            'event_espresso'
-        ); ?>
+			'By logging into Authorize.net, you can change which payment fields are required by Authorize.net when processing payments. These settings affect both the Advanced Integration Method (AIM, this) and the Simple Integration Method (SIM, different). The payment method settings "Excluded Payment Form Fields" and "Required Payment Form Fields" allow you to change the billing form in Event Espresso to reflect your payment form settings in Authorize.net.',
+			'event_espresso'
+		); ?>
         <br>
         <?php printf(
-            esc_html__(
-                'To change your payment form settings in Authorize.net, %1$slog in to authorize.net%2$s, go to %3$sAccount then Payment Form%2$s, then %4$sForm Fields%2$s. It will look similar to %5$sthis%2$s. If you make a field required in Authorize.net, you should also make it required in Event Espresso. If it isn\'t required in Authorize.net, and you want to simplify the billing form in Event Espresso, you can exclude it from the Event Espresso Form too.',
-                'event_espresso'
-            ),
-            '<a href="http://authorize.net" target="_blank" rel="noopener noreferrer">',
-            '</a>',
-            '<a href="https://monosnap.com/file/nebVteOkEXcdDIos88SojStWOifP23" target="_blank" rel="noopener noreferrer">',
-            '<a href="https://monosnap.com/file/WyxGJtev87TcDmdGBEZ2oi1xaBIQAm" target="_blank" rel="noopener noreferrer">',
-            '<a href="https://monosnap.com/image/DbCJNfEesWXeSNUs1wLIpGYODFw52m" target="_blank" rel="noopener noreferrer">'
-        ); ?>
+			esc_html__(
+				'To change your payment form settings in Authorize.net, %1$slog in to authorize.net%2$s, go to %3$sAccount then Payment Form%2$s, then %4$sForm Fields%2$s. It will look similar to %5$sthis%2$s. If you make a field required in Authorize.net, you should also make it required in Event Espresso. If it isn\'t required in Authorize.net, and you want to simplify the billing form in Event Espresso, you can exclude it from the Event Espresso Form too.',
+				'event_espresso'
+			),
+			'<a href="http://authorize.net" target="_blank" rel="noopener noreferrer">',
+			'</a>',
+			'<a href="https://monosnap.com/file/nebVteOkEXcdDIos88SojStWOifP23" target="_blank" rel="noopener noreferrer">',
+			'<a href="https://monosnap.com/file/WyxGJtev87TcDmdGBEZ2oi1xaBIQAm" target="_blank" rel="noopener noreferrer">',
+			'<a href="https://monosnap.com/image/DbCJNfEesWXeSNUs1wLIpGYODFw52m" target="_blank" rel="noopener noreferrer">'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Button Image URL', 'event_espresso'); ?></strong>
@@ -97,10 +97,10 @@ 
     <li>
         <strong><?php esc_html_e('Note About Special Characters', 'event_espresso'); ?></strong>
         <?php
-        esc_html_e(
-            'If your event name, ticket name or ticket description contain special characters (eg emojis, foreign language characters, or curly quotes) they will be removed when sent to Authorize.net. This is because Authorize.net doesn\'t support them.',
-            'event_espresso'
-        );
-        ?>
+		esc_html_e(
+			'If your event name, ticket name or ticket description contain special characters (eg emojis, foreign language characters, or curly quotes) they will be removed when sent to Authorize.net. This is because Authorize.net doesn\'t support them.',
+			'event_espresso'
+		);
+		?>
     </li>
 </ul>
\ No newline at end of file

caffeinated/brewing_regular.php

Spacing +31 added lines, -31 removed lines

@@ -12,10 +12,10 @@ 
 use EventEspresso\core\services\database\TableAnalysis;
 
 // defined some new constants related to caffeinated folder
-define('EE_CAF_URL', EE_PLUGIN_DIR_URL . 'caffeinated/');
-define('EE_CAF_CORE', EE_CAFF_PATH . 'core/');
-define('EE_CAF_LIBRARIES', EE_CAF_CORE . 'libraries/');
-define('EE_CAF_PAYMENT_METHODS', EE_CAFF_PATH . 'payment_methods/');
+define('EE_CAF_URL', EE_PLUGIN_DIR_URL.'caffeinated/');
+define('EE_CAF_CORE', EE_CAFF_PATH.'core/');
+define('EE_CAF_LIBRARIES', EE_CAF_CORE.'libraries/');
+define('EE_CAF_PAYMENT_METHODS', EE_CAFF_PATH.'payment_methods/');
 
 
 /**
@@ -65,11 +65,11 @@ 
         add_filter('FHEE__EE_Registry__load_helper__helper_paths', [$this, 'caf_helper_paths'], 10);
         add_filter(
             'AHEE__EE_System__load_core_configuration__complete',
-            function () {
+            function() {
                 EE_Register_Payment_Method::register(
                     'caffeinated_payment_methods',
                     [
-                        'payment_method_paths' => glob(EE_CAF_PAYMENT_METHODS . '*', GLOB_ONLYDIR),
+                        'payment_method_paths' => glob(EE_CAF_PAYMENT_METHODS.'*', GLOB_ONLYDIR),
                     ]
                 );
             }
@@ -124,7 +124,7 @@ 
      */
     public function caf_helper_paths($paths)
     {
-        $paths[] = EE_CAF_CORE . 'helpers/';
+        $paths[] = EE_CAF_CORE.'helpers/';
         return $paths;
     }
 
@@ -145,11 +145,11 @@ 
         global $wpdb;
         // use same method of getting creator id as the version introducing the change
         $default_creator_id = apply_filters('FHEE__EE_DMS_Core_4_5_0__get_default_creator_id', get_current_user_id());
-        $price_type_table   = $wpdb->prefix . "esp_price_type";
-        $price_table        = $wpdb->prefix . "esp_price";
+        $price_type_table   = $wpdb->prefix."esp_price_type";
+        $price_table        = $wpdb->prefix."esp_price";
         if ($this->_get_table_analysis()->tableExists($price_type_table)) {
             $SQL                  =
-                'SELECT COUNT(PRT_ID) FROM ' . $price_type_table . ' WHERE PBT_ID=4';// include trashed price types
+                'SELECT COUNT(PRT_ID) FROM '.$price_type_table.' WHERE PBT_ID=4'; // include trashed price types
             $tax_price_type_count = $wpdb->get_var($SQL);
             if ($tax_price_type_count <= 1) {
                 $wpdb->insert(
@@ -163,11 +163,11 @@ 
                         'PRT_wp_user'    => $default_creator_id,
                     ],
                     [
-                        '%s',// PRT_name
-                        '%d',// PBT_id
-                        '%d',// PRT_is_percent
-                        '%d',// PRT_order
-                        '%d',// PRT_deleted
+                        '%s', // PRT_name
+                        '%d', // PBT_id
+                        '%d', // PRT_is_percent
+                        '%d', // PRT_order
+                        '%d', // PRT_deleted
                         '%d', // PRT_wp_user
                     ]
                 );
@@ -183,11 +183,11 @@ 
                         'PRT_wp_user'    => $default_creator_id,
                     ],
                     [
-                        '%s',// PRT_name
-                        '%d',// PBT_id
-                        '%d',// PRT_is_percent
-                        '%d',// PRT_order
-                        '%d',// PRT_deleted
+                        '%s', // PRT_name
+                        '%d', // PBT_id
+                        '%d', // PRT_is_percent
+                        '%d', // PRT_order
+                        '%d', // PRT_deleted
                         '%d' // PRT_wp_user
                     ]
                 );
@@ -207,15 +207,15 @@ 
                             'PRC_wp_user'    => $default_creator_id,
                         ],
                         [
-                            '%d',// PRT_id
-                            '%f',// PRC_amount
-                            '%s',// PRC_name
-                            '%s',// PRC_desc
-                            '%d',// PRC_is_default
-                            '%d',// PRC_overrides
-                            '%d',// PRC_deleted
-                            '%d',// PRC_order
-                            '%d',// PRC_parent
+                            '%d', // PRT_id
+                            '%f', // PRC_amount
+                            '%s', // PRC_name
+                            '%s', // PRC_desc
+                            '%d', // PRC_is_default
+                            '%d', // PRC_overrides
+                            '%d', // PRC_deleted
+                            '%d', // PRC_order
+                            '%d', // PRC_parent
                             '%d' // PRC_wp_user
                         ]
                     );
@@ -234,8 +234,8 @@ 
      */
     public function caffeinated_modules_to_register($modules_to_register = [])
     {
-        if (is_readable(EE_CAFF_PATH . 'modules')) {
-            $caffeinated_modules_to_register = glob(EE_CAFF_PATH . 'modules/*', GLOB_ONLYDIR);
+        if (is_readable(EE_CAFF_PATH.'modules')) {
+            $caffeinated_modules_to_register = glob(EE_CAFF_PATH.'modules/*', GLOB_ONLYDIR);
             if (is_array($caffeinated_modules_to_register) && ! empty($caffeinated_modules_to_register)) {
                 $modules_to_register = array_merge($modules_to_register, $caffeinated_modules_to_register);
             }

Indentation +315 added lines, -315 removed lines

@@ -27,323 +27,323 @@
  */
 class EE_Brewing_Regular extends EE_BASE implements InterminableInterface
 {
-    /**
-     * @var TableAnalysis $table_analysis
-     */
-    protected $_table_analysis;
-
-
-    /**
-     * EE_Brewing_Regular constructor.
-     *
-     * @param TableAnalysis $table_analysis
-     */
-    public function __construct(TableAnalysis $table_analysis)
-    {
-        $this->_table_analysis = $table_analysis;
-        if (defined('EE_CAFF_PATH')) {
-            $this->setInitializationHooks();
-            $this->setApiRegistrationHooks();
-            $this->setSwitchHooks();
-            $this->setDefaultFilterHooks();
-            // caffeinated constructed
-            do_action('AHEE__EE_Brewing_Regular__construct__complete');
-        }
-    }
-
-
-    /**
-     * Various hooks used for extending features via registration of modules or extensions.
-     */
-    private function setApiRegistrationHooks()
-    {
-        add_filter(
-            'FHEE__EE_Config__register_modules__modules_to_register',
-            [$this, 'caffeinated_modules_to_register']
-        );
-        add_filter('FHEE__EE_Registry__load_helper__helper_paths', [$this, 'caf_helper_paths'], 10);
-        add_filter(
-            'AHEE__EE_System__load_core_configuration__complete',
-            function () {
-                EE_Register_Payment_Method::register(
-                    'caffeinated_payment_methods',
-                    [
-                        'payment_method_paths' => glob(EE_CAF_PAYMENT_METHODS . '*', GLOB_ONLYDIR),
-                    ]
-                );
-            }
-        );
-    }
-
-
-    /**
-     * Various hooks used for modifying initialization or activation processes.
-     */
-    private function setInitializationHooks()
-    {
-        // activation
-        add_action('AHEE__EEH_Activation__initialize_db_content', [$this, 'initialize_caf_db_content']);
-        // load caff init
-        add_action('AHEE__EE_System__set_hooks_for_core', [$this, 'caffeinated_init']);
-        // load caff scripts
-        add_action('wp_enqueue_scripts', [$this, 'enqueue_caffeinated_scripts'], 10);
-    }
-
-
-    /**
-     * Various hooks used for switch (on/off) type filters.
-     */
-    private function setSwitchHooks()
-    {
-        // remove the "powered by" credit link from receipts and invoices
-        add_filter('FHEE_EE_Html_messenger__add_powered_by_credit_link_to_receipt_and_invoice', '__return_false');
-        // seeing how this is caf, which isn't put on WordPress.org, we can have affiliate links without a disclaimer
-        add_filter('FHEE__ee_show_affiliate_links', '__return_false');
-    }
-
-
-    /**
-     * Various filters for affecting default configuration values in the caffeinated
-     * context.
-     */
-    private function setDefaultFilterHooks()
-    {
-        add_filter(
-            'FHEE__EE_Admin_Config__show_reg_footer__default',
-            '__return_true'
-        );
-    }
-
-
-    /**
-     * callback for the FHEE__EE_Registry__load_helper__helper_paths filter to add the caffeinated paths
-     *
-     * @param array $paths original helper paths array
-     * @return array             new array of paths
-     */
-    public function caf_helper_paths($paths)
-    {
-        $paths[] = EE_CAF_CORE . 'helpers/';
-        return $paths;
-    }
-
-
-    /**
-     * Upon brand-new activation, if this is a new activation of CAF, we want to add
-     * some global prices that will show off EE4's capabilities. However, if they're upgrading
-     * from 3.1, or simply EE4.x decaf, we assume they don't want us to suddenly introduce these extra prices.
-     * This action should only be called when EE 4.x.0.P is initially activated.
-     * Right now the only CAF content are these global prices. If there's more in the future, then
-     * we should probably create a caf file to contain it all instead just a function like this.
-     * Right now, we ASSUME the only price types in the system are default ones
-     *
-     * @global wpdb $wpdb
-     */
-    public function initialize_caf_db_content()
-    {
-        global $wpdb;
-        // use same method of getting creator id as the version introducing the change
-        $default_creator_id = apply_filters('FHEE__EE_DMS_Core_4_5_0__get_default_creator_id', get_current_user_id());
-        $price_type_table   = $wpdb->prefix . "esp_price_type";
-        $price_table        = $wpdb->prefix . "esp_price";
-        if ($this->_get_table_analysis()->tableExists($price_type_table)) {
-            $SQL                  =
-                'SELECT COUNT(PRT_ID) FROM ' . $price_type_table . ' WHERE PBT_ID=4';// include trashed price types
-            $tax_price_type_count = $wpdb->get_var($SQL);
-            if ($tax_price_type_count <= 1) {
-                $wpdb->insert(
-                    $price_type_table,
-                    [
-                        'PRT_name'       => esc_html__("Regional Tax", "event_espresso"),
-                        'PBT_ID'         => 4,
-                        'PRT_is_percent' => true,
-                        'PRT_order'      => 60,
-                        'PRT_deleted'    => false,
-                        'PRT_wp_user'    => $default_creator_id,
-                    ],
-                    [
-                        '%s',// PRT_name
-                        '%d',// PBT_id
-                        '%d',// PRT_is_percent
-                        '%d',// PRT_order
-                        '%d',// PRT_deleted
-                        '%d', // PRT_wp_user
-                    ]
-                );
-                // federal tax
-                $result = $wpdb->insert(
-                    $price_type_table,
-                    [
-                        'PRT_name'       => esc_html__("Federal Tax", "event_espresso"),
-                        'PBT_ID'         => 4,
-                        'PRT_is_percent' => true,
-                        'PRT_order'      => 70,
-                        'PRT_deleted'    => false,
-                        'PRT_wp_user'    => $default_creator_id,
-                    ],
-                    [
-                        '%s',// PRT_name
-                        '%d',// PBT_id
-                        '%d',// PRT_is_percent
-                        '%d',// PRT_order
-                        '%d',// PRT_deleted
-                        '%d' // PRT_wp_user
-                    ]
-                );
-                if ($result) {
-                    $wpdb->insert(
-                        $price_table,
-                        [
-                            'PRT_ID'         => $wpdb->insert_id,
-                            'PRC_amount'     => 15.00,
-                            'PRC_name'       => esc_html__("Sales Tax", "event_espresso"),
-                            'PRC_desc'       => '',
-                            'PRC_is_default' => true,
-                            'PRC_overrides'  => null,
-                            'PRC_deleted'    => false,
-                            'PRC_order'      => 50,
-                            'PRC_parent'     => null,
-                            'PRC_wp_user'    => $default_creator_id,
-                        ],
-                        [
-                            '%d',// PRT_id
-                            '%f',// PRC_amount
-                            '%s',// PRC_name
-                            '%s',// PRC_desc
-                            '%d',// PRC_is_default
-                            '%d',// PRC_overrides
-                            '%d',// PRC_deleted
-                            '%d',// PRC_order
-                            '%d',// PRC_parent
-                            '%d' // PRC_wp_user
-                        ]
-                    );
-                }
-            }
-        }
-    }
-
-
-    /**
-     *    caffeinated_modules_to_register
-     *
-     * @access public
-     * @param array $modules_to_register
-     * @return array
-     */
-    public function caffeinated_modules_to_register($modules_to_register = [])
-    {
-        if (is_readable(EE_CAFF_PATH . 'modules')) {
-            $caffeinated_modules_to_register = glob(EE_CAFF_PATH . 'modules/*', GLOB_ONLYDIR);
-            if (is_array($caffeinated_modules_to_register) && ! empty($caffeinated_modules_to_register)) {
-                $modules_to_register = array_merge($modules_to_register, $caffeinated_modules_to_register);
-            }
-        }
-        return $modules_to_register;
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function caffeinated_init()
-    {
-        // Custom Post Type hooks
-        add_filter(
-            'FHEE__EventEspresso_core_domain_entities_custom_post_types_TaxonomyDefinitions__getTaxonomies',
-            [$this, 'filter_taxonomies']
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_entities_custom_post_types_CustomPostTypeDefinitions__getCustomPostTypes',
-            [$this, 'filter_cpts']
-        );
-        add_filter(
-            'FHEE__EE_Admin__get_extra_nav_menu_pages_items',
-            [$this, 'nav_metabox_items']
-        );
-        EE_Registry::instance()->load_file(
-            EE_CAFF_PATH,
-            'EE_Caf_Messages',
-            'class',
-            [],
-            false
-        );
-        // caffeinated_init__complete hook
-        do_action('AHEE__EE_Brewing_Regular__caffeinated_init__complete');
-    }
-
-
-    public function enqueue_caffeinated_scripts()
-    {
-        // sound of crickets...
-    }
-
-
-    /**
-     * callbacks below here
-     *
-     * @param array $taxonomy_array
-     * @return array
-     */
-    public function filter_taxonomies(array $taxonomy_array)
-    {
-        $taxonomy_array['espresso_venue_categories']['args']['show_in_nav_menus'] = true;
-        return $taxonomy_array;
-    }
-
-
-    /**
-     * @param array $cpt_array
-     * @return mixed
-     */
-    public function filter_cpts(array $cpt_array)
-    {
-        $cpt_array['espresso_venues']['args']['show_in_nav_menus'] = true;
-        return $cpt_array;
-    }
-
-
-    /**
-     * @param array $menuitems
-     * @return array
-     */
-    public function nav_metabox_items(array $menuitems)
-    {
-        $menuitems[] = [
-            'title'       => esc_html__('Venue List', 'event_espresso'),
-            'url'         => get_post_type_archive_link('espresso_venues'),
-            'description' => esc_html__('Archive page for all venues.', 'event_espresso'),
-        ];
-        return $menuitems;
-    }
-
-
-    /**
-     * Gets the injected table analyzer, or throws an exception
-     *
-     * @return TableAnalysis
-     * @throws \EE_Error
-     */
-    protected function _get_table_analysis()
-    {
-        if ($this->_table_analysis instanceof TableAnalysis) {
-            return $this->_table_analysis;
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    esc_html__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
+	/**
+	 * @var TableAnalysis $table_analysis
+	 */
+	protected $_table_analysis;
+
+
+	/**
+	 * EE_Brewing_Regular constructor.
+	 *
+	 * @param TableAnalysis $table_analysis
+	 */
+	public function __construct(TableAnalysis $table_analysis)
+	{
+		$this->_table_analysis = $table_analysis;
+		if (defined('EE_CAFF_PATH')) {
+			$this->setInitializationHooks();
+			$this->setApiRegistrationHooks();
+			$this->setSwitchHooks();
+			$this->setDefaultFilterHooks();
+			// caffeinated constructed
+			do_action('AHEE__EE_Brewing_Regular__construct__complete');
+		}
+	}
+
+
+	/**
+	 * Various hooks used for extending features via registration of modules or extensions.
+	 */
+	private function setApiRegistrationHooks()
+	{
+		add_filter(
+			'FHEE__EE_Config__register_modules__modules_to_register',
+			[$this, 'caffeinated_modules_to_register']
+		);
+		add_filter('FHEE__EE_Registry__load_helper__helper_paths', [$this, 'caf_helper_paths'], 10);
+		add_filter(
+			'AHEE__EE_System__load_core_configuration__complete',
+			function () {
+				EE_Register_Payment_Method::register(
+					'caffeinated_payment_methods',
+					[
+						'payment_method_paths' => glob(EE_CAF_PAYMENT_METHODS . '*', GLOB_ONLYDIR),
+					]
+				);
+			}
+		);
+	}
+
+
+	/**
+	 * Various hooks used for modifying initialization or activation processes.
+	 */
+	private function setInitializationHooks()
+	{
+		// activation
+		add_action('AHEE__EEH_Activation__initialize_db_content', [$this, 'initialize_caf_db_content']);
+		// load caff init
+		add_action('AHEE__EE_System__set_hooks_for_core', [$this, 'caffeinated_init']);
+		// load caff scripts
+		add_action('wp_enqueue_scripts', [$this, 'enqueue_caffeinated_scripts'], 10);
+	}
+
+
+	/**
+	 * Various hooks used for switch (on/off) type filters.
+	 */
+	private function setSwitchHooks()
+	{
+		// remove the "powered by" credit link from receipts and invoices
+		add_filter('FHEE_EE_Html_messenger__add_powered_by_credit_link_to_receipt_and_invoice', '__return_false');
+		// seeing how this is caf, which isn't put on WordPress.org, we can have affiliate links without a disclaimer
+		add_filter('FHEE__ee_show_affiliate_links', '__return_false');
+	}
+
+
+	/**
+	 * Various filters for affecting default configuration values in the caffeinated
+	 * context.
+	 */
+	private function setDefaultFilterHooks()
+	{
+		add_filter(
+			'FHEE__EE_Admin_Config__show_reg_footer__default',
+			'__return_true'
+		);
+	}
+
+
+	/**
+	 * callback for the FHEE__EE_Registry__load_helper__helper_paths filter to add the caffeinated paths
+	 *
+	 * @param array $paths original helper paths array
+	 * @return array             new array of paths
+	 */
+	public function caf_helper_paths($paths)
+	{
+		$paths[] = EE_CAF_CORE . 'helpers/';
+		return $paths;
+	}
+
+
+	/**
+	 * Upon brand-new activation, if this is a new activation of CAF, we want to add
+	 * some global prices that will show off EE4's capabilities. However, if they're upgrading
+	 * from 3.1, or simply EE4.x decaf, we assume they don't want us to suddenly introduce these extra prices.
+	 * This action should only be called when EE 4.x.0.P is initially activated.
+	 * Right now the only CAF content are these global prices. If there's more in the future, then
+	 * we should probably create a caf file to contain it all instead just a function like this.
+	 * Right now, we ASSUME the only price types in the system are default ones
+	 *
+	 * @global wpdb $wpdb
+	 */
+	public function initialize_caf_db_content()
+	{
+		global $wpdb;
+		// use same method of getting creator id as the version introducing the change
+		$default_creator_id = apply_filters('FHEE__EE_DMS_Core_4_5_0__get_default_creator_id', get_current_user_id());
+		$price_type_table   = $wpdb->prefix . "esp_price_type";
+		$price_table        = $wpdb->prefix . "esp_price";
+		if ($this->_get_table_analysis()->tableExists($price_type_table)) {
+			$SQL                  =
+				'SELECT COUNT(PRT_ID) FROM ' . $price_type_table . ' WHERE PBT_ID=4';// include trashed price types
+			$tax_price_type_count = $wpdb->get_var($SQL);
+			if ($tax_price_type_count <= 1) {
+				$wpdb->insert(
+					$price_type_table,
+					[
+						'PRT_name'       => esc_html__("Regional Tax", "event_espresso"),
+						'PBT_ID'         => 4,
+						'PRT_is_percent' => true,
+						'PRT_order'      => 60,
+						'PRT_deleted'    => false,
+						'PRT_wp_user'    => $default_creator_id,
+					],
+					[
+						'%s',// PRT_name
+						'%d',// PBT_id
+						'%d',// PRT_is_percent
+						'%d',// PRT_order
+						'%d',// PRT_deleted
+						'%d', // PRT_wp_user
+					]
+				);
+				// federal tax
+				$result = $wpdb->insert(
+					$price_type_table,
+					[
+						'PRT_name'       => esc_html__("Federal Tax", "event_espresso"),
+						'PBT_ID'         => 4,
+						'PRT_is_percent' => true,
+						'PRT_order'      => 70,
+						'PRT_deleted'    => false,
+						'PRT_wp_user'    => $default_creator_id,
+					],
+					[
+						'%s',// PRT_name
+						'%d',// PBT_id
+						'%d',// PRT_is_percent
+						'%d',// PRT_order
+						'%d',// PRT_deleted
+						'%d' // PRT_wp_user
+					]
+				);
+				if ($result) {
+					$wpdb->insert(
+						$price_table,
+						[
+							'PRT_ID'         => $wpdb->insert_id,
+							'PRC_amount'     => 15.00,
+							'PRC_name'       => esc_html__("Sales Tax", "event_espresso"),
+							'PRC_desc'       => '',
+							'PRC_is_default' => true,
+							'PRC_overrides'  => null,
+							'PRC_deleted'    => false,
+							'PRC_order'      => 50,
+							'PRC_parent'     => null,
+							'PRC_wp_user'    => $default_creator_id,
+						],
+						[
+							'%d',// PRT_id
+							'%f',// PRC_amount
+							'%s',// PRC_name
+							'%s',// PRC_desc
+							'%d',// PRC_is_default
+							'%d',// PRC_overrides
+							'%d',// PRC_deleted
+							'%d',// PRC_order
+							'%d',// PRC_parent
+							'%d' // PRC_wp_user
+						]
+					);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *    caffeinated_modules_to_register
+	 *
+	 * @access public
+	 * @param array $modules_to_register
+	 * @return array
+	 */
+	public function caffeinated_modules_to_register($modules_to_register = [])
+	{
+		if (is_readable(EE_CAFF_PATH . 'modules')) {
+			$caffeinated_modules_to_register = glob(EE_CAFF_PATH . 'modules/*', GLOB_ONLYDIR);
+			if (is_array($caffeinated_modules_to_register) && ! empty($caffeinated_modules_to_register)) {
+				$modules_to_register = array_merge($modules_to_register, $caffeinated_modules_to_register);
+			}
+		}
+		return $modules_to_register;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function caffeinated_init()
+	{
+		// Custom Post Type hooks
+		add_filter(
+			'FHEE__EventEspresso_core_domain_entities_custom_post_types_TaxonomyDefinitions__getTaxonomies',
+			[$this, 'filter_taxonomies']
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_entities_custom_post_types_CustomPostTypeDefinitions__getCustomPostTypes',
+			[$this, 'filter_cpts']
+		);
+		add_filter(
+			'FHEE__EE_Admin__get_extra_nav_menu_pages_items',
+			[$this, 'nav_metabox_items']
+		);
+		EE_Registry::instance()->load_file(
+			EE_CAFF_PATH,
+			'EE_Caf_Messages',
+			'class',
+			[],
+			false
+		);
+		// caffeinated_init__complete hook
+		do_action('AHEE__EE_Brewing_Regular__caffeinated_init__complete');
+	}
+
+
+	public function enqueue_caffeinated_scripts()
+	{
+		// sound of crickets...
+	}
+
+
+	/**
+	 * callbacks below here
+	 *
+	 * @param array $taxonomy_array
+	 * @return array
+	 */
+	public function filter_taxonomies(array $taxonomy_array)
+	{
+		$taxonomy_array['espresso_venue_categories']['args']['show_in_nav_menus'] = true;
+		return $taxonomy_array;
+	}
+
+
+	/**
+	 * @param array $cpt_array
+	 * @return mixed
+	 */
+	public function filter_cpts(array $cpt_array)
+	{
+		$cpt_array['espresso_venues']['args']['show_in_nav_menus'] = true;
+		return $cpt_array;
+	}
+
+
+	/**
+	 * @param array $menuitems
+	 * @return array
+	 */
+	public function nav_metabox_items(array $menuitems)
+	{
+		$menuitems[] = [
+			'title'       => esc_html__('Venue List', 'event_espresso'),
+			'url'         => get_post_type_archive_link('espresso_venues'),
+			'description' => esc_html__('Archive page for all venues.', 'event_espresso'),
+		];
+		return $menuitems;
+	}
+
+
+	/**
+	 * Gets the injected table analyzer, or throws an exception
+	 *
+	 * @return TableAnalysis
+	 * @throws \EE_Error
+	 */
+	protected function _get_table_analysis()
+	{
+		if ($this->_table_analysis instanceof TableAnalysis) {
+			return $this->_table_analysis;
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					esc_html__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
 }
 
 
 $brewing = new EE_Brewing_Regular(
-    EE_Registry::instance()->create('TableAnalysis', [], true)
+	EE_Registry::instance()->create('TableAnalysis', [], true)
 );

core/libraries/messages/validators/EE_Messages_Validator.core.php

Spacing +53 added lines, -53 removed lines

@@ -156,9 +156,9 @@ 
         // load messenger
         $messenger = ucwords(str_replace('_', ' ', $this->_m_name));
         $messenger = str_replace(' ', '_', $messenger);
-        $messenger = 'EE_' . $messenger . '_messenger';
+        $messenger = 'EE_'.$messenger.'_messenger';
 
-        if (! class_exists($messenger)) {
+        if ( ! class_exists($messenger)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('There is no messenger class for the given string (%s)', 'event_espresso'),
@@ -172,9 +172,9 @@ 
         // load message type
         $message_type = ucwords(str_replace('_', ' ', $this->_mt_name));
         $message_type = str_replace(' ', '_', $message_type);
-        $message_type = 'EE_' . $message_type . '_message_type';
+        $message_type = 'EE_'.$message_type.'_message_type';
 
-        if (! class_exists($message_type)) {
+        if ( ! class_exists($message_type)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('There is no message type class for the given string (%s)', 'event_espresso'),
@@ -206,7 +206,7 @@ 
 
         // we only want the valid shortcodes for the given context!
         $context  = $this->_context;
-        $mt_codes = $mt_codes[ $context ];
+        $mt_codes = $mt_codes[$context];
 
         // in this first loop we're just getting all shortcode group indexes from the msgr_validator
         // into a single array (so we can get the appropriate shortcode objects for the groups)
@@ -217,7 +217,7 @@ 
             if (empty($config) || ! isset($config['shortcodes'])) {
                 continue;
             }  //Nothing to see here.
-            $groups_per_field[ $field ] = array_intersect($config['shortcodes'], $mt_codes);
+            $groups_per_field[$field] = array_intersect($config['shortcodes'], $mt_codes);
             $shortcode_groups           = array_merge($config['shortcodes'], $shortcode_groups);
         }
 
@@ -230,11 +230,11 @@ 
         foreach ($shortcode_groups as $group) {
             $ref       = ucwords(str_replace('_', ' ', $group));
             $ref       = str_replace(' ', '_', $ref);
-            $classname = 'EE_' . $ref . '_Shortcodes';
+            $classname = 'EE_'.$ref.'_Shortcodes';
             if (class_exists($classname)) {
                 $a                         = new ReflectionClass($classname);
                 $obj                       = $a->newInstance();
-                $codes_from_objs[ $group ] = $obj->get_shortcodes();
+                $codes_from_objs[$group] = $obj->get_shortcodes();
             }
         }
 
@@ -242,7 +242,7 @@ 
         // let's just replace the $mt shortcode group indexes with the actual shortcodes (unique)
         $final_mt_codes = [];
         foreach ($mt_codes as $group) {
-            $final_mt_codes = array_merge($final_mt_codes, $codes_from_objs[ $group ]);
+            $final_mt_codes = array_merge($final_mt_codes, $codes_from_objs[$group]);
         }
 
         $mt_codes = $final_mt_codes;
@@ -260,44 +260,44 @@ 
             }
 
             // If we have an override then we use it to indicate the codes we want.
-            if (isset($this->_valid_shortcodes_modifier[ $context ][ $field ])) {
-                $this->_validators[ $field ]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
-                    $this->_valid_shortcodes_modifier[ $context ][ $field ],
+            if (isset($this->_valid_shortcodes_modifier[$context][$field])) {
+                $this->_validators[$field]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
+                    $this->_valid_shortcodes_modifier[$context][$field],
                     $codes_from_objs
                 );
-            } elseif (isset($groups_per_field[ $field ])) {
+            } elseif (isset($groups_per_field[$field])) {
                 // we have specific shortcodes for a field so we need to use them
-                $this->_validators[ $field ]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
-                    $groups_per_field[ $field ],
+                $this->_validators[$field]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
+                    $groups_per_field[$field],
                     $codes_from_objs
                 );
             } elseif (empty($config)) {
                 // no config so we're assuming we're just going to use the shortcodes from the message type context
-                $this->_validators[ $field ]['shortcodes'] = $mt_codes;
+                $this->_validators[$field]['shortcodes'] = $mt_codes;
             } elseif (isset($config['specific_shortcodes'])) {
                 // we have specific shortcodes so we need to use them
-                $this->_validators[ $field ]['shortcodes'] = $config['specific_shortcodes'];
+                $this->_validators[$field]['shortcodes'] = $config['specific_shortcodes'];
             } else {
                 // otherwise the shortcodes are what is set by the messenger for that field
                 foreach ($config['shortcodes'] as $group) {
-                    $this->_validators[ $field ]['shortcodes'] = isset($this->_validators[ $field ]['shortcodes'])
-                        ? array_merge($this->_validators[ $field ]['shortcodes'], $codes_from_objs[ $group ])
-                        : $codes_from_objs[ $group ];
+                    $this->_validators[$field]['shortcodes'] = isset($this->_validators[$field]['shortcodes'])
+                        ? array_merge($this->_validators[$field]['shortcodes'], $codes_from_objs[$group])
+                        : $codes_from_objs[$group];
                 }
             }
 
             // now let's just make sure that any excluded specific shortcodes are removed.
             $specific_excludes = $this->get_specific_shortcode_excludes();
-            if (isset($specific_excludes[ $field ])) {
-                foreach ($specific_excludes[ $field ] as $sex) {
-                    if (isset($this->_validators[ $field ]['shortcodes'][ $sex ])) {
-                        unset($this->_validators[ $field ]['shortcodes'][ $sex ]);
+            if (isset($specific_excludes[$field])) {
+                foreach ($specific_excludes[$field] as $sex) {
+                    if (isset($this->_validators[$field]['shortcodes'][$sex])) {
+                        unset($this->_validators[$field]['shortcodes'][$sex]);
                     }
                 }
             }
 
             // hey! don't forget to include the type if present!
-            $this->_validators[ $field ]['type'] =
+            $this->_validators[$field]['type'] =
                 isset($config['type'])
                     ? $config['type']
                     : null;
@@ -327,7 +327,7 @@ 
     {
         // specific validator filter
         $shortcode_excludes = apply_filters(
-            'FHEE__' . get_class($this) . '__get_specific_shortcode_excludes;',
+            'FHEE__'.get_class($this).'__get_specific_shortcode_excludes;',
             $this->_specific_shortcode_excludes,
             $this->_context
         );
@@ -354,21 +354,21 @@ 
         $template_fields = $this->_messenger->get_template_fields();
         // loop through the fields and check!
         foreach ($this->_fields as $field => $value) {
-            $this->_errors[ $field ] = [];
+            $this->_errors[$field] = [];
             $err_msg                 = '';
             $field_label             = '';
             // if field is not present in the _validators array then we continue
-            if (! isset($this->_validators[ $field ])) {
-                unset($this->_errors[ $field ]);
+            if ( ! isset($this->_validators[$field])) {
+                unset($this->_errors[$field]);
                 continue;
             }
 
             // get the translated field label!
             // first check if it's in the main fields list
-            if (isset($template_fields[ $field ])) {
+            if (isset($template_fields[$field])) {
                 // most likely the field is found in the 'extra' array.
-                $field_label = ! empty($template_fields[ $field ])
-                    ? $template_fields[ $field ]['label']
+                $field_label = ! empty($template_fields[$field])
+                    ? $template_fields[$field]['label']
                     : $field;
             }
 
@@ -392,20 +392,20 @@ 
 
             // field is present. Let's validate shortcodes first (but only if shortcodes present).
             if (
-                isset($this->_validators[ $field ]['shortcodes'])
-                && ! empty($this->_validators[ $field ]['shortcodes'])
+                isset($this->_validators[$field]['shortcodes'])
+                && ! empty($this->_validators[$field]['shortcodes'])
             ) {
-                $invalid_shortcodes = $this->_invalid_shortcodes($value, $this->_validators[ $field ]['shortcodes']);
+                $invalid_shortcodes = $this->_invalid_shortcodes($value, $this->_validators[$field]['shortcodes']);
                 // if true then that means there is a returned error message
                 // that we'll need to add to the _errors array for this field.
                 if ($invalid_shortcodes) {
-                    $v_s     = array_keys($this->_validators[ $field ]['shortcodes']);
+                    $v_s     = array_keys($this->_validators[$field]['shortcodes']);
                     $err_msg = sprintf(
                         esc_html__(
                             '%3$sThe following shortcodes were found in the "%1$s" field that ARE not valid: %2$s%4$s',
                             'event_espresso'
                         ),
-                        '<strong>' . $field_label . '</strong>',
+                        '<strong>'.$field_label.'</strong>',
                         $invalid_shortcodes,
                         '<p>',
                         '</p >'
@@ -420,10 +420,10 @@ 
             }
 
             // if there's a "type" to be validated then let's do that too.
-            if (isset($this->_validators[ $field ]['type']) && ! empty($this->_validators[ $field ]['type'])) {
-                switch ($this->_validators[ $field ]['type']) {
+            if (isset($this->_validators[$field]['type']) && ! empty($this->_validators[$field]['type'])) {
+                switch ($this->_validators[$field]['type']) {
                     case 'number':
-                        if (! is_numeric($value)) {
+                        if ( ! is_numeric($value)) {
                             $err_msg .= sprintf(
                                 esc_html__(
                                     '%3$sThe %1$s field is supposed to be a number. The value given (%2$s)  is not.  Please double-check and make sure the field contains a number%4$s',
@@ -438,7 +438,7 @@ 
                         break;
                     case 'email':
                         $valid_email = $this->_validate_email($value);
-                        if (! $valid_email) {
+                        if ( ! $valid_email) {
                             $err_msg .= htmlentities(
                                 sprintf(
                                     esc_html__(
@@ -456,18 +456,18 @@ 
             }
 
             // if $err_msg isn't empty let's setup the _errors array for this field.
-            if (! empty($err_msg)) {
-                $this->_errors[ $field ]['msg'] = $err_msg;
+            if ( ! empty($err_msg)) {
+                $this->_errors[$field]['msg'] = $err_msg;
             } else {
-                unset($this->_errors[ $field ]);
+                unset($this->_errors[$field]);
             }
         }
 
         // if we have ANY errors, then we want to make sure we return the values
         // for ALL the fields so the user doesn't have to retype them all.
-        if (! empty($this->_errors)) {
+        if ( ! empty($this->_errors)) {
             foreach ($this->_fields as $field => $value) {
-                $this->_errors[ $field ]['value'] = stripslashes($value);
+                $this->_errors[$field]['value'] = stripslashes($value);
             }
         }
 
@@ -490,7 +490,7 @@ 
     {
         $shortcodes = [];
         foreach ($groups as $group) {
-            $shortcodes = array_merge($shortcodes, $codes_from_objs[ $group ]);
+            $shortcodes = array_merge($shortcodes, $codes_from_objs[$group]);
         }
         return $shortcodes;
     }
@@ -520,8 +520,8 @@ 
                 // strip the shortcode so we just have the BASE string (i.e. [ANSWER_*] )
                 $dynamic_sc = preg_replace('/(_\*+.+)/', '_*]', $code);
                 // does this exist in the $valid_shortcodes?  If so then unset.
-                if (isset($valid_shortcodes[ $dynamic_sc ])) {
-                    unset($diff[ $ind ]);
+                if (isset($valid_shortcodes[$dynamic_sc])) {
+                    unset($diff[$ind]);
                 }
             }
         }
@@ -532,7 +532,7 @@ 
 
         // made it here? then let's assemble the error message
         $invalid_shortcodes = implode('</strong>,<strong>', $diff);
-        return '<strong>' . $invalid_shortcodes . '</strong>';
+        return '<strong>'.$invalid_shortcodes.'</strong>';
     }
 
 
@@ -568,7 +568,7 @@ 
         // its possible that this message is being "turned off" for a particular context
 
 
-        if (! empty($or_val) && empty($value)) {
+        if ( ! empty($or_val) && empty($value)) {
             return $validate;
         }
 
@@ -627,8 +627,8 @@ 
             '_MSGTYP' => '_message_type',
         ];
 
-        if (isset($expected_properties_map[ $property ])) {
-            return $this->{$expected_properties_map[ $property ]};
+        if (isset($expected_properties_map[$property])) {
+            return $this->{$expected_properties_map[$property]};
         }
 
         throw new Exception(

Indentation +622 added lines, -622 removed lines

@@ -15,626 +15,626 @@
  */
 abstract class EE_Messages_Validator extends EE_Base
 {
-    /**
-     * These properties just hold the name for the Messenger and Message Type (defined by child classes).
-     * These are used for retrieving objects etc.
-     *
-     * @var string
-     */
-    protected $_m_name;
-
-    protected $_mt_name;
-
-
-    /**
-     * This will hold any error messages from the validation process.
-     * The _errors property holds an associative array of error messages
-     * listing the field as the key and the message as the value.
-     *
-     * @var array()
-     */
-    private $_errors = [];
-
-
-    /**
-     * holds an array of fields being validated
-     *
-     * @var array
-     */
-    protected $_fields;
-
-
-    /**
-     * this will hold the incoming context
-     *
-     * @var string
-     */
-    protected $_context;
-
-
-    /**
-     * this holds an array of fields and the relevant validation information
-     * that the incoming fields data get validated against.
-     * This gets setup in the _set_props() method.
-     *
-     * @var array
-     */
-    protected $_validators;
-
-
-    /**
-     * holds the messenger object
-     *
-     * @var object
-     */
-    protected $_messenger;
-
-
-    /**
-     * holds the message type object
-     *
-     * @var object
-     */
-    protected $_message_type;
-
-
-    /**
-     * will hold any valid_shortcode modifications made by the _modify_validator() method.
-     *
-     * @var array
-     */
-    protected $_valid_shortcodes_modifier;
-
-
-    /**
-     * There may be times where a message type wants to include a shortcode group but exclude specific
-     * shortcodes.  If that's the case then it can set this property as an array of shortcodes to exclude and
-     * they will not be allowed.
-     * Array should be indexed by field and values are an array of specific shortcodes to exclude.
-     *
-     * @var array
-     */
-    protected $_specific_shortcode_excludes = [];
-
-
-    /**
-     * Runs the validator using the incoming fields array as the fields/values to check.
-     *
-     * @param array $fields The fields sent by the EEM object.
-     * @param       $context
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct($fields, $context)
-    {
-        // check that _m_name and _mt_name have been set by child class otherwise we get out.
-        if (empty($this->_m_name) || empty($this->_mt_name)) {
-            throw new EE_Error(
-                esc_html__(
-                    'EE_Messages_Validator child classes MUST set the $_m_name and $_mt_name property.  Check that the child class is doing this',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->_fields  = $fields;
-        $this->_context = $context;
-
-        // load messenger and message_type objects and the related shortcode objects.
-        $this->_load_objects();
-
-
-        // modify any messenger/message_type specific validation instructions.  This is what child classes define.
-        $this->_modify_validator();
-
-
-        // let's set validators property
-        $this->_set_validators();
-    }
-
-
-    /**
-     * Child classes instantiate this and use it to modify the _validator_config array property
-     * for the messenger using messengers set_validate_config() method.
-     * This is so we can specify specific validation instructions for a messenger/message_type combo
-     * that aren't handled by the defaults setup in the messenger.
-     *
-     * @abstract
-     * @return void
-     */
-    abstract protected function _modify_validator();
-
-
-    /**
-     * loads all objects used by validator
-     *
-     * @throws EE_Error
-     */
-    private function _load_objects()
-    {
-        // load messenger
-        $messenger = ucwords(str_replace('_', ' ', $this->_m_name));
-        $messenger = str_replace(' ', '_', $messenger);
-        $messenger = 'EE_' . $messenger . '_messenger';
-
-        if (! class_exists($messenger)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('There is no messenger class for the given string (%s)', 'event_espresso'),
-                    $this->_m_name
-                )
-            );
-        }
-
-        $this->_messenger = new $messenger();
-
-        // load message type
-        $message_type = ucwords(str_replace('_', ' ', $this->_mt_name));
-        $message_type = str_replace(' ', '_', $message_type);
-        $message_type = 'EE_' . $message_type . '_message_type';
-
-        if (! class_exists($message_type)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('There is no message type class for the given string (%s)', 'event_espresso'),
-                    $this->_mt_name
-                )
-            );
-        }
-
-        $this->_message_type = new $message_type();
-    }
-
-
-    /**
-     * used to set the $_validators property
-     *
-     * @return void
-     * @throws ReflectionException
-     */
-    private function _set_validators()
-    {
-        // let's get all valid shortcodes from mt and message type
-        // (messenger will have its set in the _validator_config property for the messenger)
-        $mt_codes = $this->_message_type->get_valid_shortcodes();
-
-
-        // get messenger validator_config
-        $msgr_validator = $this->_messenger->get_validator_config();
-
-
-        // we only want the valid shortcodes for the given context!
-        $context  = $this->_context;
-        $mt_codes = $mt_codes[ $context ];
-
-        // in this first loop we're just getting all shortcode group indexes from the msgr_validator
-        // into a single array (so we can get the appropriate shortcode objects for the groups)
-        $shortcode_groups = $mt_codes;
-        $groups_per_field = [];
-
-        foreach ($msgr_validator as $field => $config) {
-            if (empty($config) || ! isset($config['shortcodes'])) {
-                continue;
-            }  //Nothing to see here.
-            $groups_per_field[ $field ] = array_intersect($config['shortcodes'], $mt_codes);
-            $shortcode_groups           = array_merge($config['shortcodes'], $shortcode_groups);
-        }
-
-        $shortcode_groups = array_unique($shortcode_groups);
-
-        // okay now we've got our groups.
-        // Let's get the codes from the objects into an array indexed by group for easy retrieval later.
-        $codes_from_objs = [];
-
-        foreach ($shortcode_groups as $group) {
-            $ref       = ucwords(str_replace('_', ' ', $group));
-            $ref       = str_replace(' ', '_', $ref);
-            $classname = 'EE_' . $ref . '_Shortcodes';
-            if (class_exists($classname)) {
-                $a                         = new ReflectionClass($classname);
-                $obj                       = $a->newInstance();
-                $codes_from_objs[ $group ] = $obj->get_shortcodes();
-            }
-        }
-
-
-        // let's just replace the $mt shortcode group indexes with the actual shortcodes (unique)
-        $final_mt_codes = [];
-        foreach ($mt_codes as $group) {
-            $final_mt_codes = array_merge($final_mt_codes, $codes_from_objs[ $group ]);
-        }
-
-        $mt_codes = $final_mt_codes;
-
-
-        // k now in this next loop we're going to loop through $msgr_validator again
-        // and setup the _validators property from the data we've setup so far.
-        foreach ($msgr_validator as $field => $config) {
-            // if required shortcode is not in our list of codes for the given field, then we skip this field.
-            $required = isset($config['required'])
-                ? array_intersect($config['required'], array_keys($mt_codes))
-                : true;
-            if (empty($required)) {
-                continue;
-            }
-
-            // If we have an override then we use it to indicate the codes we want.
-            if (isset($this->_valid_shortcodes_modifier[ $context ][ $field ])) {
-                $this->_validators[ $field ]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
-                    $this->_valid_shortcodes_modifier[ $context ][ $field ],
-                    $codes_from_objs
-                );
-            } elseif (isset($groups_per_field[ $field ])) {
-                // we have specific shortcodes for a field so we need to use them
-                $this->_validators[ $field ]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
-                    $groups_per_field[ $field ],
-                    $codes_from_objs
-                );
-            } elseif (empty($config)) {
-                // no config so we're assuming we're just going to use the shortcodes from the message type context
-                $this->_validators[ $field ]['shortcodes'] = $mt_codes;
-            } elseif (isset($config['specific_shortcodes'])) {
-                // we have specific shortcodes so we need to use them
-                $this->_validators[ $field ]['shortcodes'] = $config['specific_shortcodes'];
-            } else {
-                // otherwise the shortcodes are what is set by the messenger for that field
-                foreach ($config['shortcodes'] as $group) {
-                    $this->_validators[ $field ]['shortcodes'] = isset($this->_validators[ $field ]['shortcodes'])
-                        ? array_merge($this->_validators[ $field ]['shortcodes'], $codes_from_objs[ $group ])
-                        : $codes_from_objs[ $group ];
-                }
-            }
-
-            // now let's just make sure that any excluded specific shortcodes are removed.
-            $specific_excludes = $this->get_specific_shortcode_excludes();
-            if (isset($specific_excludes[ $field ])) {
-                foreach ($specific_excludes[ $field ] as $sex) {
-                    if (isset($this->_validators[ $field ]['shortcodes'][ $sex ])) {
-                        unset($this->_validators[ $field ]['shortcodes'][ $sex ]);
-                    }
-                }
-            }
-
-            // hey! don't forget to include the type if present!
-            $this->_validators[ $field ]['type'] =
-                isset($config['type'])
-                    ? $config['type']
-                    : null;
-        }
-    }
-
-
-    /**
-     * This just returns the validators property that contains information
-     * about the various shortcodes and their availability with each field
-     *
-     * @return array
-     */
-    public function get_validators()
-    {
-        return $this->_validators;
-    }
-
-
-    /**
-     * This simply returns the specific shortcode_excludes property that is set.
-     *
-     * @return array
-     * @since 4.5.0
-     */
-    public function get_specific_shortcode_excludes()
-    {
-        // specific validator filter
-        $shortcode_excludes = apply_filters(
-            'FHEE__' . get_class($this) . '__get_specific_shortcode_excludes;',
-            $this->_specific_shortcode_excludes,
-            $this->_context
-        );
-        // global filter
-        return apply_filters(
-            'FHEE__EE_Messages_Validator__get_specific_shortcode_excludes',
-            $shortcode_excludes,
-            $this->_context,
-            $this
-        );
-    }
-
-
-    /**
-     * This is the main method that handles validation
-     * What it does is loop through the _fields (the ones that get validated)
-     * and checks them against the shortcodes array for the field and the 'type' indicated by the
-     *
-     * @return array|bool if errors present we return the array otherwise true
-     */
-    public function validate()
-    {
-        // some defaults
-        $template_fields = $this->_messenger->get_template_fields();
-        // loop through the fields and check!
-        foreach ($this->_fields as $field => $value) {
-            $this->_errors[ $field ] = [];
-            $err_msg                 = '';
-            $field_label             = '';
-            // if field is not present in the _validators array then we continue
-            if (! isset($this->_validators[ $field ])) {
-                unset($this->_errors[ $field ]);
-                continue;
-            }
-
-            // get the translated field label!
-            // first check if it's in the main fields list
-            if (isset($template_fields[ $field ])) {
-                // most likely the field is found in the 'extra' array.
-                $field_label = ! empty($template_fields[ $field ])
-                    ? $template_fields[ $field ]['label']
-                    : $field;
-            }
-
-            // if field label is empty OR is equal to the current field
-            // then we need to loop through the 'extra' fields in the template_fields config (if present)
-            if (isset($template_fields['extra']) && (empty($field_label) || $field_label === $field)) {
-                foreach ($template_fields['extra'] as $main_field => $secondary_field) {
-                    foreach ($secondary_field as $name => $values) {
-                        if ($name === $field) {
-                            $field_label = $values['label'];
-                        }
-
-                        // if we've got a 'main' secondary field, let's see if that matches what field we're on
-                        // which means it contains the label for this field.
-                        if ($name === 'main' && $main_field === $field_label) {
-                            $field_label = $values['label'];
-                        }
-                    }
-                }
-            }
-
-            // field is present. Let's validate shortcodes first (but only if shortcodes present).
-            if (
-                isset($this->_validators[ $field ]['shortcodes'])
-                && ! empty($this->_validators[ $field ]['shortcodes'])
-            ) {
-                $invalid_shortcodes = $this->_invalid_shortcodes($value, $this->_validators[ $field ]['shortcodes']);
-                // if true then that means there is a returned error message
-                // that we'll need to add to the _errors array for this field.
-                if ($invalid_shortcodes) {
-                    $v_s     = array_keys($this->_validators[ $field ]['shortcodes']);
-                    $err_msg = sprintf(
-                        esc_html__(
-                            '%3$sThe following shortcodes were found in the "%1$s" field that ARE not valid: %2$s%4$s',
-                            'event_espresso'
-                        ),
-                        '<strong>' . $field_label . '</strong>',
-                        $invalid_shortcodes,
-                        '<p>',
-                        '</p >'
-                    );
-                    $err_msg .= sprintf(
-                        esc_html__('%2$sValid shortcodes for this field are: %1$s%3$s', 'event_espresso'),
-                        implode(', ', $v_s),
-                        '<strong>',
-                        '</strong>'
-                    );
-                }
-            }
-
-            // if there's a "type" to be validated then let's do that too.
-            if (isset($this->_validators[ $field ]['type']) && ! empty($this->_validators[ $field ]['type'])) {
-                switch ($this->_validators[ $field ]['type']) {
-                    case 'number':
-                        if (! is_numeric($value)) {
-                            $err_msg .= sprintf(
-                                esc_html__(
-                                    '%3$sThe %1$s field is supposed to be a number. The value given (%2$s)  is not.  Please double-check and make sure the field contains a number%4$s',
-                                    'event_espresso'
-                                ),
-                                $field_label,
-                                $value,
-                                '<p>',
-                                '</p >'
-                            );
-                        }
-                        break;
-                    case 'email':
-                        $valid_email = $this->_validate_email($value);
-                        if (! $valid_email) {
-                            $err_msg .= htmlentities(
-                                sprintf(
-                                    esc_html__(
-                                        'The %1$s field has at least one string that is not a valid email address record.  Valid emails are in the format: "Name <email@something.com>" or "email@something.com" and multiple emails can be separated by a comma.',
-                                        'event_espresso'
-                                    ),
-                                    $field_label
-                                )
-                            );
-                        }
-                        break;
-                    default:
-                        break;
-                }
-            }
-
-            // if $err_msg isn't empty let's setup the _errors array for this field.
-            if (! empty($err_msg)) {
-                $this->_errors[ $field ]['msg'] = $err_msg;
-            } else {
-                unset($this->_errors[ $field ]);
-            }
-        }
-
-        // if we have ANY errors, then we want to make sure we return the values
-        // for ALL the fields so the user doesn't have to retype them all.
-        if (! empty($this->_errors)) {
-            foreach ($this->_fields as $field => $value) {
-                $this->_errors[ $field ]['value'] = stripslashes($value);
-            }
-        }
-
-        // return any errors or just TRUE if everything validates
-        return empty($this->_errors)
-            ? true
-            : $this->_errors;
-    }
-
-
-    /**
-     * Reassembles and returns an array of valid shortcodes
-     * given the array of groups and array of shortcodes indexed by group.
-     *
-     * @param array $groups          array of shortcode groups that we want shortcodes for
-     * @param array $codes_from_objs All the codes available.
-     * @return array                   an array of actual shortcodes (that will be used for validation).
-     */
-    private function _reassemble_valid_shortcodes_from_group($groups, $codes_from_objs)
-    {
-        $shortcodes = [];
-        foreach ($groups as $group) {
-            $shortcodes = array_merge($shortcodes, $codes_from_objs[ $group ]);
-        }
-        return $shortcodes;
-    }
-
-
-    /**
-     * Validates a string against a list of accepted shortcodes
-     * This function takes in an array of shortcodes
-     * and makes sure that the given string ONLY contains shortcodes in that array.
-     *
-     * @param string $value            string to evaluate
-     * @param array  $valid_shortcodes array of shortcodes that are acceptable.
-     * @return bool|string  return either a list of invalid shortcodes OR false if the shortcodes validate.
-     */
-    protected function _invalid_shortcodes($value, $valid_shortcodes)
-    {
-        // first we need to go through the string and get the shortcodes in the string
-        preg_match_all('/(\[.+?\])/', $value, $matches);
-        $incoming_shortcodes = (array) $matches[0];
-
-        // get a diff of the shortcodes in the string vs the valid shortcodes
-        $diff = array_diff($incoming_shortcodes, array_keys($valid_shortcodes));
-
-        // we need to account for custom codes so let's loop through the diff and remove any of those type of codes
-        foreach ($diff as $ind => $code) {
-            if (preg_match('/(\[[A-Za-z0-9\_]+_\*)/', $code)) {
-                // strip the shortcode so we just have the BASE string (i.e. [ANSWER_*] )
-                $dynamic_sc = preg_replace('/(_\*+.+)/', '_*]', $code);
-                // does this exist in the $valid_shortcodes?  If so then unset.
-                if (isset($valid_shortcodes[ $dynamic_sc ])) {
-                    unset($diff[ $ind ]);
-                }
-            }
-        }
-
-        if (empty($diff)) {
-            return false;
-        } //there is no diff, we have no invalid shortcodes, so return
-
-        // made it here? then let's assemble the error message
-        $invalid_shortcodes = implode('</strong>,<strong>', $diff);
-        return '<strong>' . $invalid_shortcodes . '</strong>';
-    }
-
-
-    /**
-     * Validates an incoming string and makes sure we have valid emails in the string.
-     *
-     * @param string $value incoming value to validate
-     * @return bool        true if the string validates, false if it doesn't
-     */
-    protected function _validate_email($value)
-    {
-        $validate = true;
-        $or_val   = $value;
-
-        // empty strings will validate because this is how a message template
-        // for a particular context can be "turned off" (if there is no email then no message)
-        if (empty($value)) {
-            return $validate;
-        }
-
-        // first determine if there ARE any shortcodes.
-        // If there are shortcodes and then later we find that there were no other valid emails
-        // but the field isn't empty...
-        // that means we've got extra commas that were left after stripping out shortcodes so probably still valid.
-        $has_shortcodes = preg_match('/(\[.+?\])/', $value);
-
-        // first we need to strip out all the shortcodes!
-        $value = preg_replace('/(\[.+?\])/', '', $value);
-
-        // if original value is not empty and new value is, then we've parsed out a shortcode
-        // and we now have an empty string which DOES validate.
-        // We also validate complete empty field for email because
-        // its possible that this message is being "turned off" for a particular context
-
-
-        if (! empty($or_val) && empty($value)) {
-            return $validate;
-        }
-
-        // trim any commas from beginning and end of string ( after whitespace trimmed );
-        $value = trim(trim($value), ',');
-
-
-        // next we need to split up the string if its comma delimited.
-        $emails = explode(',', $value);
-        $empty  = false; // used to indicate that there is an empty comma.
-        // now let's loop through the emails and do our checks
-        foreach ($emails as $email) {
-            if (empty($email)) {
-                $empty = true;
-                continue;
-            }
-
-            // trim whitespace
-            $email = trim($email);
-            // either its of type "bob@whatever.com", or its of type "fname lname <few@few.few>"
-            if (is_email($email)) {
-                continue;
-            }
-            $matches  = [];
-            $validate = (bool) preg_match('/(.*)<(.+)>/', $email, $matches);
-            if ($validate && is_email($matches[2])) {
-                continue;
-            }
-            return false;
-        }
-
-        return $empty && ! $has_shortcodes
-            ? false
-            : $validate;
-    }
-
-
-    /**
-     * Magic getter
-     * Using this to provide back compat with add-ons referencing deprecated properties.
-     *
-     * @param string $property Property being requested
-     * @return mixed
-     * @throws Exception
-     */
-    public function __get($property)
-    {
-        $expected_properties_map = [
-            /**
-             * @deprecated 4.9.0
-             */
-            '_MSGR'   => '_messenger',
-            /**
-             * @deprecated 4.9.0
-             */
-            '_MSGTYP' => '_message_type',
-        ];
-
-        if (isset($expected_properties_map[ $property ])) {
-            return $this->{$expected_properties_map[ $property ]};
-        }
-
-        throw new Exception(
-            sprintf(
-                esc_html__('The property %1$s being requested on %2$s does not exist', 'event_espresso'),
-                $property,
-                get_class($this)
-            )
-        );
-    }
+	/**
+	 * These properties just hold the name for the Messenger and Message Type (defined by child classes).
+	 * These are used for retrieving objects etc.
+	 *
+	 * @var string
+	 */
+	protected $_m_name;
+
+	protected $_mt_name;
+
+
+	/**
+	 * This will hold any error messages from the validation process.
+	 * The _errors property holds an associative array of error messages
+	 * listing the field as the key and the message as the value.
+	 *
+	 * @var array()
+	 */
+	private $_errors = [];
+
+
+	/**
+	 * holds an array of fields being validated
+	 *
+	 * @var array
+	 */
+	protected $_fields;
+
+
+	/**
+	 * this will hold the incoming context
+	 *
+	 * @var string
+	 */
+	protected $_context;
+
+
+	/**
+	 * this holds an array of fields and the relevant validation information
+	 * that the incoming fields data get validated against.
+	 * This gets setup in the _set_props() method.
+	 *
+	 * @var array
+	 */
+	protected $_validators;
+
+
+	/**
+	 * holds the messenger object
+	 *
+	 * @var object
+	 */
+	protected $_messenger;
+
+
+	/**
+	 * holds the message type object
+	 *
+	 * @var object
+	 */
+	protected $_message_type;
+
+
+	/**
+	 * will hold any valid_shortcode modifications made by the _modify_validator() method.
+	 *
+	 * @var array
+	 */
+	protected $_valid_shortcodes_modifier;
+
+
+	/**
+	 * There may be times where a message type wants to include a shortcode group but exclude specific
+	 * shortcodes.  If that's the case then it can set this property as an array of shortcodes to exclude and
+	 * they will not be allowed.
+	 * Array should be indexed by field and values are an array of specific shortcodes to exclude.
+	 *
+	 * @var array
+	 */
+	protected $_specific_shortcode_excludes = [];
+
+
+	/**
+	 * Runs the validator using the incoming fields array as the fields/values to check.
+	 *
+	 * @param array $fields The fields sent by the EEM object.
+	 * @param       $context
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct($fields, $context)
+	{
+		// check that _m_name and _mt_name have been set by child class otherwise we get out.
+		if (empty($this->_m_name) || empty($this->_mt_name)) {
+			throw new EE_Error(
+				esc_html__(
+					'EE_Messages_Validator child classes MUST set the $_m_name and $_mt_name property.  Check that the child class is doing this',
+					'event_espresso'
+				)
+			);
+		}
+		$this->_fields  = $fields;
+		$this->_context = $context;
+
+		// load messenger and message_type objects and the related shortcode objects.
+		$this->_load_objects();
+
+
+		// modify any messenger/message_type specific validation instructions.  This is what child classes define.
+		$this->_modify_validator();
+
+
+		// let's set validators property
+		$this->_set_validators();
+	}
+
+
+	/**
+	 * Child classes instantiate this and use it to modify the _validator_config array property
+	 * for the messenger using messengers set_validate_config() method.
+	 * This is so we can specify specific validation instructions for a messenger/message_type combo
+	 * that aren't handled by the defaults setup in the messenger.
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _modify_validator();
+
+
+	/**
+	 * loads all objects used by validator
+	 *
+	 * @throws EE_Error
+	 */
+	private function _load_objects()
+	{
+		// load messenger
+		$messenger = ucwords(str_replace('_', ' ', $this->_m_name));
+		$messenger = str_replace(' ', '_', $messenger);
+		$messenger = 'EE_' . $messenger . '_messenger';
+
+		if (! class_exists($messenger)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('There is no messenger class for the given string (%s)', 'event_espresso'),
+					$this->_m_name
+				)
+			);
+		}
+
+		$this->_messenger = new $messenger();
+
+		// load message type
+		$message_type = ucwords(str_replace('_', ' ', $this->_mt_name));
+		$message_type = str_replace(' ', '_', $message_type);
+		$message_type = 'EE_' . $message_type . '_message_type';
+
+		if (! class_exists($message_type)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('There is no message type class for the given string (%s)', 'event_espresso'),
+					$this->_mt_name
+				)
+			);
+		}
+
+		$this->_message_type = new $message_type();
+	}
+
+
+	/**
+	 * used to set the $_validators property
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 */
+	private function _set_validators()
+	{
+		// let's get all valid shortcodes from mt and message type
+		// (messenger will have its set in the _validator_config property for the messenger)
+		$mt_codes = $this->_message_type->get_valid_shortcodes();
+
+
+		// get messenger validator_config
+		$msgr_validator = $this->_messenger->get_validator_config();
+
+
+		// we only want the valid shortcodes for the given context!
+		$context  = $this->_context;
+		$mt_codes = $mt_codes[ $context ];
+
+		// in this first loop we're just getting all shortcode group indexes from the msgr_validator
+		// into a single array (so we can get the appropriate shortcode objects for the groups)
+		$shortcode_groups = $mt_codes;
+		$groups_per_field = [];
+
+		foreach ($msgr_validator as $field => $config) {
+			if (empty($config) || ! isset($config['shortcodes'])) {
+				continue;
+			}  //Nothing to see here.
+			$groups_per_field[ $field ] = array_intersect($config['shortcodes'], $mt_codes);
+			$shortcode_groups           = array_merge($config['shortcodes'], $shortcode_groups);
+		}
+
+		$shortcode_groups = array_unique($shortcode_groups);
+
+		// okay now we've got our groups.
+		// Let's get the codes from the objects into an array indexed by group for easy retrieval later.
+		$codes_from_objs = [];
+
+		foreach ($shortcode_groups as $group) {
+			$ref       = ucwords(str_replace('_', ' ', $group));
+			$ref       = str_replace(' ', '_', $ref);
+			$classname = 'EE_' . $ref . '_Shortcodes';
+			if (class_exists($classname)) {
+				$a                         = new ReflectionClass($classname);
+				$obj                       = $a->newInstance();
+				$codes_from_objs[ $group ] = $obj->get_shortcodes();
+			}
+		}
+
+
+		// let's just replace the $mt shortcode group indexes with the actual shortcodes (unique)
+		$final_mt_codes = [];
+		foreach ($mt_codes as $group) {
+			$final_mt_codes = array_merge($final_mt_codes, $codes_from_objs[ $group ]);
+		}
+
+		$mt_codes = $final_mt_codes;
+
+
+		// k now in this next loop we're going to loop through $msgr_validator again
+		// and setup the _validators property from the data we've setup so far.
+		foreach ($msgr_validator as $field => $config) {
+			// if required shortcode is not in our list of codes for the given field, then we skip this field.
+			$required = isset($config['required'])
+				? array_intersect($config['required'], array_keys($mt_codes))
+				: true;
+			if (empty($required)) {
+				continue;
+			}
+
+			// If we have an override then we use it to indicate the codes we want.
+			if (isset($this->_valid_shortcodes_modifier[ $context ][ $field ])) {
+				$this->_validators[ $field ]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
+					$this->_valid_shortcodes_modifier[ $context ][ $field ],
+					$codes_from_objs
+				);
+			} elseif (isset($groups_per_field[ $field ])) {
+				// we have specific shortcodes for a field so we need to use them
+				$this->_validators[ $field ]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
+					$groups_per_field[ $field ],
+					$codes_from_objs
+				);
+			} elseif (empty($config)) {
+				// no config so we're assuming we're just going to use the shortcodes from the message type context
+				$this->_validators[ $field ]['shortcodes'] = $mt_codes;
+			} elseif (isset($config['specific_shortcodes'])) {
+				// we have specific shortcodes so we need to use them
+				$this->_validators[ $field ]['shortcodes'] = $config['specific_shortcodes'];
+			} else {
+				// otherwise the shortcodes are what is set by the messenger for that field
+				foreach ($config['shortcodes'] as $group) {
+					$this->_validators[ $field ]['shortcodes'] = isset($this->_validators[ $field ]['shortcodes'])
+						? array_merge($this->_validators[ $field ]['shortcodes'], $codes_from_objs[ $group ])
+						: $codes_from_objs[ $group ];
+				}
+			}
+
+			// now let's just make sure that any excluded specific shortcodes are removed.
+			$specific_excludes = $this->get_specific_shortcode_excludes();
+			if (isset($specific_excludes[ $field ])) {
+				foreach ($specific_excludes[ $field ] as $sex) {
+					if (isset($this->_validators[ $field ]['shortcodes'][ $sex ])) {
+						unset($this->_validators[ $field ]['shortcodes'][ $sex ]);
+					}
+				}
+			}
+
+			// hey! don't forget to include the type if present!
+			$this->_validators[ $field ]['type'] =
+				isset($config['type'])
+					? $config['type']
+					: null;
+		}
+	}
+
+
+	/**
+	 * This just returns the validators property that contains information
+	 * about the various shortcodes and their availability with each field
+	 *
+	 * @return array
+	 */
+	public function get_validators()
+	{
+		return $this->_validators;
+	}
+
+
+	/**
+	 * This simply returns the specific shortcode_excludes property that is set.
+	 *
+	 * @return array
+	 * @since 4.5.0
+	 */
+	public function get_specific_shortcode_excludes()
+	{
+		// specific validator filter
+		$shortcode_excludes = apply_filters(
+			'FHEE__' . get_class($this) . '__get_specific_shortcode_excludes;',
+			$this->_specific_shortcode_excludes,
+			$this->_context
+		);
+		// global filter
+		return apply_filters(
+			'FHEE__EE_Messages_Validator__get_specific_shortcode_excludes',
+			$shortcode_excludes,
+			$this->_context,
+			$this
+		);
+	}
+
+
+	/**
+	 * This is the main method that handles validation
+	 * What it does is loop through the _fields (the ones that get validated)
+	 * and checks them against the shortcodes array for the field and the 'type' indicated by the
+	 *
+	 * @return array|bool if errors present we return the array otherwise true
+	 */
+	public function validate()
+	{
+		// some defaults
+		$template_fields = $this->_messenger->get_template_fields();
+		// loop through the fields and check!
+		foreach ($this->_fields as $field => $value) {
+			$this->_errors[ $field ] = [];
+			$err_msg                 = '';
+			$field_label             = '';
+			// if field is not present in the _validators array then we continue
+			if (! isset($this->_validators[ $field ])) {
+				unset($this->_errors[ $field ]);
+				continue;
+			}
+
+			// get the translated field label!
+			// first check if it's in the main fields list
+			if (isset($template_fields[ $field ])) {
+				// most likely the field is found in the 'extra' array.
+				$field_label = ! empty($template_fields[ $field ])
+					? $template_fields[ $field ]['label']
+					: $field;
+			}
+
+			// if field label is empty OR is equal to the current field
+			// then we need to loop through the 'extra' fields in the template_fields config (if present)
+			if (isset($template_fields['extra']) && (empty($field_label) || $field_label === $field)) {
+				foreach ($template_fields['extra'] as $main_field => $secondary_field) {
+					foreach ($secondary_field as $name => $values) {
+						if ($name === $field) {
+							$field_label = $values['label'];
+						}
+
+						// if we've got a 'main' secondary field, let's see if that matches what field we're on
+						// which means it contains the label for this field.
+						if ($name === 'main' && $main_field === $field_label) {
+							$field_label = $values['label'];
+						}
+					}
+				}
+			}
+
+			// field is present. Let's validate shortcodes first (but only if shortcodes present).
+			if (
+				isset($this->_validators[ $field ]['shortcodes'])
+				&& ! empty($this->_validators[ $field ]['shortcodes'])
+			) {
+				$invalid_shortcodes = $this->_invalid_shortcodes($value, $this->_validators[ $field ]['shortcodes']);
+				// if true then that means there is a returned error message
+				// that we'll need to add to the _errors array for this field.
+				if ($invalid_shortcodes) {
+					$v_s     = array_keys($this->_validators[ $field ]['shortcodes']);
+					$err_msg = sprintf(
+						esc_html__(
+							'%3$sThe following shortcodes were found in the "%1$s" field that ARE not valid: %2$s%4$s',
+							'event_espresso'
+						),
+						'<strong>' . $field_label . '</strong>',
+						$invalid_shortcodes,
+						'<p>',
+						'</p >'
+					);
+					$err_msg .= sprintf(
+						esc_html__('%2$sValid shortcodes for this field are: %1$s%3$s', 'event_espresso'),
+						implode(', ', $v_s),
+						'<strong>',
+						'</strong>'
+					);
+				}
+			}
+
+			// if there's a "type" to be validated then let's do that too.
+			if (isset($this->_validators[ $field ]['type']) && ! empty($this->_validators[ $field ]['type'])) {
+				switch ($this->_validators[ $field ]['type']) {
+					case 'number':
+						if (! is_numeric($value)) {
+							$err_msg .= sprintf(
+								esc_html__(
+									'%3$sThe %1$s field is supposed to be a number. The value given (%2$s)  is not.  Please double-check and make sure the field contains a number%4$s',
+									'event_espresso'
+								),
+								$field_label,
+								$value,
+								'<p>',
+								'</p >'
+							);
+						}
+						break;
+					case 'email':
+						$valid_email = $this->_validate_email($value);
+						if (! $valid_email) {
+							$err_msg .= htmlentities(
+								sprintf(
+									esc_html__(
+										'The %1$s field has at least one string that is not a valid email address record.  Valid emails are in the format: "Name <email@something.com>" or "email@something.com" and multiple emails can be separated by a comma.',
+										'event_espresso'
+									),
+									$field_label
+								)
+							);
+						}
+						break;
+					default:
+						break;
+				}
+			}
+
+			// if $err_msg isn't empty let's setup the _errors array for this field.
+			if (! empty($err_msg)) {
+				$this->_errors[ $field ]['msg'] = $err_msg;
+			} else {
+				unset($this->_errors[ $field ]);
+			}
+		}
+
+		// if we have ANY errors, then we want to make sure we return the values
+		// for ALL the fields so the user doesn't have to retype them all.
+		if (! empty($this->_errors)) {
+			foreach ($this->_fields as $field => $value) {
+				$this->_errors[ $field ]['value'] = stripslashes($value);
+			}
+		}
+
+		// return any errors or just TRUE if everything validates
+		return empty($this->_errors)
+			? true
+			: $this->_errors;
+	}
+
+
+	/**
+	 * Reassembles and returns an array of valid shortcodes
+	 * given the array of groups and array of shortcodes indexed by group.
+	 *
+	 * @param array $groups          array of shortcode groups that we want shortcodes for
+	 * @param array $codes_from_objs All the codes available.
+	 * @return array                   an array of actual shortcodes (that will be used for validation).
+	 */
+	private function _reassemble_valid_shortcodes_from_group($groups, $codes_from_objs)
+	{
+		$shortcodes = [];
+		foreach ($groups as $group) {
+			$shortcodes = array_merge($shortcodes, $codes_from_objs[ $group ]);
+		}
+		return $shortcodes;
+	}
+
+
+	/**
+	 * Validates a string against a list of accepted shortcodes
+	 * This function takes in an array of shortcodes
+	 * and makes sure that the given string ONLY contains shortcodes in that array.
+	 *
+	 * @param string $value            string to evaluate
+	 * @param array  $valid_shortcodes array of shortcodes that are acceptable.
+	 * @return bool|string  return either a list of invalid shortcodes OR false if the shortcodes validate.
+	 */
+	protected function _invalid_shortcodes($value, $valid_shortcodes)
+	{
+		// first we need to go through the string and get the shortcodes in the string
+		preg_match_all('/(\[.+?\])/', $value, $matches);
+		$incoming_shortcodes = (array) $matches[0];
+
+		// get a diff of the shortcodes in the string vs the valid shortcodes
+		$diff = array_diff($incoming_shortcodes, array_keys($valid_shortcodes));
+
+		// we need to account for custom codes so let's loop through the diff and remove any of those type of codes
+		foreach ($diff as $ind => $code) {
+			if (preg_match('/(\[[A-Za-z0-9\_]+_\*)/', $code)) {
+				// strip the shortcode so we just have the BASE string (i.e. [ANSWER_*] )
+				$dynamic_sc = preg_replace('/(_\*+.+)/', '_*]', $code);
+				// does this exist in the $valid_shortcodes?  If so then unset.
+				if (isset($valid_shortcodes[ $dynamic_sc ])) {
+					unset($diff[ $ind ]);
+				}
+			}
+		}
+
+		if (empty($diff)) {
+			return false;
+		} //there is no diff, we have no invalid shortcodes, so return
+
+		// made it here? then let's assemble the error message
+		$invalid_shortcodes = implode('</strong>,<strong>', $diff);
+		return '<strong>' . $invalid_shortcodes . '</strong>';
+	}
+
+
+	/**
+	 * Validates an incoming string and makes sure we have valid emails in the string.
+	 *
+	 * @param string $value incoming value to validate
+	 * @return bool        true if the string validates, false if it doesn't
+	 */
+	protected function _validate_email($value)
+	{
+		$validate = true;
+		$or_val   = $value;
+
+		// empty strings will validate because this is how a message template
+		// for a particular context can be "turned off" (if there is no email then no message)
+		if (empty($value)) {
+			return $validate;
+		}
+
+		// first determine if there ARE any shortcodes.
+		// If there are shortcodes and then later we find that there were no other valid emails
+		// but the field isn't empty...
+		// that means we've got extra commas that were left after stripping out shortcodes so probably still valid.
+		$has_shortcodes = preg_match('/(\[.+?\])/', $value);
+
+		// first we need to strip out all the shortcodes!
+		$value = preg_replace('/(\[.+?\])/', '', $value);
+
+		// if original value is not empty and new value is, then we've parsed out a shortcode
+		// and we now have an empty string which DOES validate.
+		// We also validate complete empty field for email because
+		// its possible that this message is being "turned off" for a particular context
+
+
+		if (! empty($or_val) && empty($value)) {
+			return $validate;
+		}
+
+		// trim any commas from beginning and end of string ( after whitespace trimmed );
+		$value = trim(trim($value), ',');
+
+
+		// next we need to split up the string if its comma delimited.
+		$emails = explode(',', $value);
+		$empty  = false; // used to indicate that there is an empty comma.
+		// now let's loop through the emails and do our checks
+		foreach ($emails as $email) {
+			if (empty($email)) {
+				$empty = true;
+				continue;
+			}
+
+			// trim whitespace
+			$email = trim($email);
+			// either its of type "bob@whatever.com", or its of type "fname lname <few@few.few>"
+			if (is_email($email)) {
+				continue;
+			}
+			$matches  = [];
+			$validate = (bool) preg_match('/(.*)<(.+)>/', $email, $matches);
+			if ($validate && is_email($matches[2])) {
+				continue;
+			}
+			return false;
+		}
+
+		return $empty && ! $has_shortcodes
+			? false
+			: $validate;
+	}
+
+
+	/**
+	 * Magic getter
+	 * Using this to provide back compat with add-ons referencing deprecated properties.
+	 *
+	 * @param string $property Property being requested
+	 * @return mixed
+	 * @throws Exception
+	 */
+	public function __get($property)
+	{
+		$expected_properties_map = [
+			/**
+			 * @deprecated 4.9.0
+			 */
+			'_MSGR'   => '_messenger',
+			/**
+			 * @deprecated 4.9.0
+			 */
+			'_MSGTYP' => '_message_type',
+		];
+
+		if (isset($expected_properties_map[ $property ])) {
+			return $this->{$expected_properties_map[ $property ]};
+		}
+
+		throw new Exception(
+			sprintf(
+				esc_html__('The property %1$s being requested on %2$s does not exist', 'event_espresso'),
+				$property,
+				get_class($this)
+			)
+		);
+	}
 }

core/libraries/rest_api/ModelDataTranslator.php

Spacing +16 added lines, -16 removed lines

@@ -69,7 +69,7 @@ 
         ) {
             $new_value_maybe_array = [];
             foreach ($original_value_maybe_array as $array_key => $array_item) {
-                $new_value_maybe_array[ $array_key ] = ModelDataTranslator::prepareFieldValueFromJson(
+                $new_value_maybe_array[$array_key] = ModelDataTranslator::prepareFieldValueFromJson(
                     $field_obj,
                     $array_item,
                     $requested_version,
@@ -103,7 +103,7 @@ 
         if (is_array($original_value_maybe_array)) {
             $new_value = [];
             foreach ($original_value_maybe_array as $key => $value) {
-                $new_value[ $key ] = ModelDataTranslator::prepareFieldValuesForJson(
+                $new_value[$key] = ModelDataTranslator::prepareFieldValuesForJson(
                     $field_obj,
                     $value,
                     $request_version
@@ -244,7 +244,7 @@ 
                 '0',
                 STR_PAD_LEFT
             );
-        return $original_timestamp . $offset_sign . $offset_string;
+        return $original_timestamp.$offset_sign.$offset_string;
     }
 
 
@@ -323,7 +323,7 @@ 
                     // first, check if its a MySQL timestamp in GMT
                     $datetime_obj = DateTime::createFromFormat('Y-m-d H:i:s', $original_value);
                 }
-                if (! $datetime_obj instanceof DateTime) {
+                if ( ! $datetime_obj instanceof DateTime) {
                     // so it's not a unix timestamp or a MySQL timestamp. Maybe its in the field's date/time format?
                     $datetime_obj = $field_obj->prepare_for_set($original_value);
                 }
@@ -349,7 +349,7 @@ 
                         $original_value,
                         $field_obj->get_name(),
                         $field_obj->get_model_name(),
-                        $field_obj->get_time_format() . ' ' . $field_obj->get_time_format()
+                        $field_obj->get_time_format().' '.$field_obj->get_time_format()
                     )
                 );
             }
@@ -363,7 +363,7 @@ 
         }
         // are we about to send an object? just don't. We have no good way to represent it in JSON.
         // can't just check using is_object() because that missed PHP incomplete objects
-        if (! ModelDataTranslator::isRepresentableInJson($new_value)) {
+        if ( ! ModelDataTranslator::isRepresentableInJson($new_value)) {
             $new_value = [
                 'error_code'    => 'php_object_not_return',
                 'error_message' => esc_html__(
@@ -414,7 +414,7 @@ 
             if ($query_param_meta->getField() instanceof EE_Model_Field_Base) {
                 $translated_value = $query_param_meta->determineConditionsQueryParameterValue();
                 if (
-                    (isset($query_param_for_models[ $query_param_meta->getQueryParamKey() ])
+                    (isset($query_param_for_models[$query_param_meta->getQueryParamKey()])
                      && $query_param_meta->isGmtField())
                     || $translated_value === null
                 ) {
@@ -423,11 +423,11 @@ 
                     // OR we couldn't create a translated value from their input
                     continue;
                 }
-                $query_param_for_models[ $query_param_meta->getQueryParamKey() ] = $translated_value;
+                $query_param_for_models[$query_param_meta->getQueryParamKey()] = $translated_value;
             } else {
                 $nested_query_params = $query_param_meta->determineNestedConditionQueryParameters();
                 if ($nested_query_params) {
-                    $query_param_for_models[ $query_param_meta->getQueryParamKey() ] = $nested_query_params;
+                    $query_param_for_models[$query_param_meta->getQueryParamKey()] = $nested_query_params;
                 }
             }
         }
@@ -457,7 +457,7 @@ 
      */
     public static function removeGmtFromFieldName($field_name)
     {
-        if (! ModelDataTranslator::isGmtDateFieldName($field_name)) {
+        if ( ! ModelDataTranslator::isGmtDateFieldName($field_name)) {
             return $field_name;
         }
         $query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
@@ -500,7 +500,7 @@ 
     {
         $new_array = [];
         foreach ($field_names as $key => $field_name) {
-            $new_array[ $key ] = ModelDataTranslator::prepareFieldNameFromJson($field_name);
+            $new_array[$key] = ModelDataTranslator::prepareFieldNameFromJson($field_name);
         }
         return $new_array;
     }
@@ -517,7 +517,7 @@ 
     {
         $new_array = [];
         foreach ($field_names_as_keys as $field_name => $value) {
-            $new_array[ ModelDataTranslator::prepareFieldNameFromJson($field_name) ] = $value;
+            $new_array[ModelDataTranslator::prepareFieldNameFromJson($field_name)] = $value;
         }
         return $new_array;
     }
@@ -613,10 +613,10 @@ 
                         $requested_version
                     );
                 }
-                $query_param_for_models[ $query_param_key ] = $translated_value;
+                $query_param_for_models[$query_param_key] = $translated_value;
             } else {
                 // so it's not for a field, assume it's a logic query param key
-                $query_param_for_models[ $query_param_key ] =
+                $query_param_for_models[$query_param_key] =
                     ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
                         $query_param_value,
                         $model,
@@ -668,11 +668,11 @@ 
             );
         }
         $number_of_parts       = count($query_param_parts);
-        $last_query_param_part = $query_param_parts[ count($query_param_parts) - 1 ];
+        $last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
         $field_name            = $last_query_param_part;
         if ($number_of_parts !== 1) {
             // the last part is the column name, and there are only 2parts. therefore...
-            $model = EE_Registry::instance()->load_model($query_param_parts[ $number_of_parts - 2 ]);
+            $model = EE_Registry::instance()->load_model($query_param_parts[$number_of_parts - 2]);
         }
         try {
             return $model->field_settings_for($field_name, false);

Indentation +656 added lines, -656 removed lines

@@ -38,660 +38,660 @@
  */
 class ModelDataTranslator
 {
-    /**
-     * We used to use -1 for infinity in the rest api, but that's ambiguous for
-     * fields that COULD contain -1; so we use null
-     */
-    const EE_INF_IN_REST = null;
-
-
-    /**
-     * Prepares a possible array of input values from JSON for use by the models
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed               $original_value_maybe_array
-     * @param string              $requested_version
-     * @param string              $timezone_string treat values as being in this timezone
-     * @return mixed
-     * @throws RestException
-     * @throws EE_Error
-     */
-    public static function prepareFieldValuesFromJson(
-        $field_obj,
-        $original_value_maybe_array,
-        $requested_version,
-        $timezone_string = 'UTC'
-    ) {
-        if (
-            is_array($original_value_maybe_array)
-            && ! $field_obj instanceof EE_Serialized_Text_Field
-        ) {
-            $new_value_maybe_array = [];
-            foreach ($original_value_maybe_array as $array_key => $array_item) {
-                $new_value_maybe_array[ $array_key ] = ModelDataTranslator::prepareFieldValueFromJson(
-                    $field_obj,
-                    $array_item,
-                    $requested_version,
-                    $timezone_string
-                );
-            }
-        } else {
-            $new_value_maybe_array = ModelDataTranslator::prepareFieldValueFromJson(
-                $field_obj,
-                $original_value_maybe_array,
-                $requested_version,
-                $timezone_string
-            );
-        }
-        return $new_value_maybe_array;
-    }
-
-
-    /**
-     * Prepares an array of field values FOR use in JSON/REST API
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed               $original_value_maybe_array
-     * @param string              $request_version (eg 4.8.36)
-     * @return array
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public static function prepareFieldValuesForJson($field_obj, $original_value_maybe_array, $request_version)
-    {
-        if (is_array($original_value_maybe_array)) {
-            $new_value = [];
-            foreach ($original_value_maybe_array as $key => $value) {
-                $new_value[ $key ] = ModelDataTranslator::prepareFieldValuesForJson(
-                    $field_obj,
-                    $value,
-                    $request_version
-                );
-            }
-        } else {
-            $new_value = ModelDataTranslator::prepareFieldValueForJson(
-                $field_obj,
-                $original_value_maybe_array,
-                $request_version
-            );
-        }
-        return $new_value;
-    }
-
-
-    /**
-     * Prepares incoming data from the json or request parameters for the models'
-     * "$query_params".
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed               $original_value
-     * @param string              $requested_version
-     * @param string              $timezone_string treat values as being in this timezone
-     * @return mixed
-     * @throws RestException
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public static function prepareFieldValueFromJson(
-        $field_obj,
-        $original_value,
-        $requested_version,
-        $timezone_string = 'UTC'
-    ) {
-        // check if they accidentally submitted an error value. If so throw an exception
-        if (
-            is_array($original_value)
-            && isset($original_value['error_code'], $original_value['error_message'])
-        ) {
-            throw new RestException(
-                'rest_submitted_error_value',
-                sprintf(
-                    esc_html__(
-                        'You tried to submit a JSON error object as a value for %1$s. That\'s not allowed.',
-                        'event_espresso'
-                    ),
-                    $field_obj->get_name()
-                ),
-                [
-                    'status' => 400,
-                ]
-            );
-        }
-        // double-check for serialized PHP. We never accept serialized PHP. No way Jose.
-        ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value);
-        $timezone_string =
-            $timezone_string !== ''
-                ? $timezone_string
-                : get_option('timezone_string', '');
-        // walk through the submitted data and double-check for serialized PHP. We never accept serialized PHP. No
-        // way Jose.
-        ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value);
-        if (
-            $field_obj instanceof EE_Infinite_Integer_Field
-            && in_array($original_value, [null, ''], true)
-        ) {
-            $new_value = EE_INF;
-        } elseif ($field_obj instanceof EE_Datetime_Field) {
-            $new_value = rest_parse_date(
-                self::getTimestampWithTimezoneOffset($original_value, $field_obj, $timezone_string)
-            );
-            if ($new_value === false) {
-                throw new RestException(
-                    'invalid_format_for_timestamp',
-                    sprintf(
-                        esc_html__(
-                            'Timestamps received on a request as the value for Date and Time fields must be in %1$s/%2$s format.  The timestamp provided (%3$s) is not that format.',
-                            'event_espresso'
-                        ),
-                        'RFC3339',
-                        'ISO8601',
-                        $original_value
-                    ),
-                    [
-                        'status' => 400,
-                    ]
-                );
-            }
-        } elseif ($field_obj instanceof EE_Boolean_Field) {
-            // Interpreted the strings "false", "true", "on", "off" appropriately.
-            $new_value = filter_var($original_value, FILTER_VALIDATE_BOOLEAN);
-        } else {
-            $new_value = $original_value;
-        }
-        return $new_value;
-    }
-
-
-    /**
-     * This checks if the incoming timestamp has timezone information already on it and if it doesn't then adds timezone
-     * information via details obtained from the host site.
-     *
-     * @param string            $original_timestamp
-     * @param EE_Datetime_Field $datetime_field
-     * @param                   $timezone_string
-     * @return string
-     * @throws DomainException
-     */
-    private static function getTimestampWithTimezoneOffset(
-        $original_timestamp,
-        EE_Datetime_Field $datetime_field,
-        $timezone_string
-    ) {
-        // already have timezone information?
-        if (preg_match('/Z|([+-])(\d{2}:\d{2})/', $original_timestamp)) {
-            // yes, we're ignoring the timezone.
-            return $original_timestamp;
-        }
-        // need to append timezone
-        list($offset_sign, $offset_secs) = self::parseTimezoneOffset(
-            $datetime_field->get_timezone_offset(
-                new DateTimeZone($timezone_string),
-                $original_timestamp
-            )
-        );
-        $offset_string =
-            str_pad(
-                floor($offset_secs / HOUR_IN_SECONDS),
-                2,
-                '0',
-                STR_PAD_LEFT
-            )
-            . ':'
-            . str_pad(
-                ($offset_secs % HOUR_IN_SECONDS) / MINUTE_IN_SECONDS,
-                2,
-                '0',
-                STR_PAD_LEFT
-            );
-        return $original_timestamp . $offset_sign . $offset_string;
-    }
-
-
-    /**
-     * Throws an exception if $data is a serialized PHP string (or somehow an actually PHP object, although I don't
-     * think that can happen). If $data is an array, recurses into its keys and values
-     *
-     * @param mixed $data
-     * @return void
-     * @throws RestException
-     */
-    public static function throwExceptionIfContainsSerializedData($data)
-    {
-        if (is_array($data)) {
-            foreach ($data as $key => $value) {
-                ModelDataTranslator::throwExceptionIfContainsSerializedData($key);
-                ModelDataTranslator::throwExceptionIfContainsSerializedData($value);
-            }
-        } else {
-            if (is_serialized($data) || is_object($data)) {
-                throw new RestException(
-                    'serialized_data_submission_prohibited',
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'You tried to submit a string of serialized text. Serialized PHP is prohibited over the EE4 REST API.',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    )
-                );
-            }
-        }
-    }
-
-
-    /**
-     * determines what's going on with them timezone strings
-     *
-     * @param int $timezone_offset
-     * @return array
-     */
-    private static function parseTimezoneOffset($timezone_offset)
-    {
-        $first_char = substr((string) $timezone_offset, 0, 1);
-        if ($first_char === '+' || $first_char === '-') {
-            $offset_sign = $first_char;
-            $offset_secs = substr((string) $timezone_offset, 1);
-        } else {
-            $offset_sign = '+';
-            $offset_secs = $timezone_offset;
-        }
-        return [$offset_sign, $offset_secs];
-    }
-
-
-    /**
-     * Prepares a field's value for display in the API
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed               $original_value
-     * @param string              $requested_version
-     * @return mixed
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public static function prepareFieldValueForJson($field_obj, $original_value, $requested_version)
-    {
-        if ($original_value === EE_INF) {
-            $new_value = ModelDataTranslator::EE_INF_IN_REST;
-        } elseif ($field_obj instanceof EE_Datetime_Field) {
-            if (is_string($original_value)) {
-                // did they submit a string of a unix timestamp?
-                if (is_numeric($original_value)) {
-                    $datetime_obj = new DateTime();
-                    $datetime_obj->setTimestamp((int) $original_value);
-                } else {
-                    // first, check if its a MySQL timestamp in GMT
-                    $datetime_obj = DateTime::createFromFormat('Y-m-d H:i:s', $original_value);
-                }
-                if (! $datetime_obj instanceof DateTime) {
-                    // so it's not a unix timestamp or a MySQL timestamp. Maybe its in the field's date/time format?
-                    $datetime_obj = $field_obj->prepare_for_set($original_value);
-                }
-                $original_value = $datetime_obj;
-            }
-            if ($original_value instanceof DateTime) {
-                $new_value = $original_value->format('Y-m-d H:i:s');
-            } elseif (is_int($original_value) || is_float($original_value)) {
-                $new_value = date('Y-m-d H:i:s', $original_value);
-            } elseif ($original_value === null || $original_value === '') {
-                $new_value = null;
-            } else {
-                // so it's not a datetime object, unix timestamp (as string or int),
-                // MySQL timestamp, or even a string in the field object's format. So no idea what it is
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                        // @codingStandardsIgnoreStart
-                            'The value "%1$s" for the field "%2$s" on model "%3$s" could not be understood. It should be a PHP DateTime, unix timestamp, MySQL date, or string in the format "%4$s".',
-                            // @codingStandardsIgnoreEnd
-                            'event_espresso'
-                        ),
-                        $original_value,
-                        $field_obj->get_name(),
-                        $field_obj->get_model_name(),
-                        $field_obj->get_time_format() . ' ' . $field_obj->get_time_format()
-                    )
-                );
-            }
-            if ($new_value !== null) {
-                // phpcs:disable PHPCompatibility.Extensions.RemovedExtensions.mysql_DeprecatedRemoved
-                $new_value = mysql_to_rfc3339($new_value);
-                // phpcs:enable
-            }
-        } else {
-            $new_value = $original_value;
-        }
-        // are we about to send an object? just don't. We have no good way to represent it in JSON.
-        // can't just check using is_object() because that missed PHP incomplete objects
-        if (! ModelDataTranslator::isRepresentableInJson($new_value)) {
-            $new_value = [
-                'error_code'    => 'php_object_not_return',
-                'error_message' => esc_html__(
-                    'The value of this field in the database is a PHP object, which can\'t be represented in JSON.',
-                    'event_espresso'
-                ),
-            ];
-        }
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
-            $new_value,
-            $field_obj,
-            $original_value,
-            $requested_version
-        );
-    }
-
-
-    /**
-     * Prepares condition-query-parameters (like what's in where and having) from
-     * the format expected in the API to use in the models
-     *
-     * @param array    $inputted_query_params_of_this_type
-     * @param EEM_Base $model
-     * @param string   $requested_version
-     * @param boolean  $writing whether this data will be written to the DB, or if we're just building a query.
-     *                          If we're writing to the DB, we don't expect any operators, or any logic query
-     *                          parameters, and we also won't accept serialized data unless the current user has
-     *                          unfiltered_html.
-     * @return array
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws RestException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public static function prepareConditionsQueryParamsForModels(
-        $inputted_query_params_of_this_type,
-        EEM_Base $model,
-        $requested_version,
-        $writing = false
-    ) {
-        $query_param_for_models = [];
-        $context                = new RestIncomingQueryParamContext($model, $requested_version, $writing);
-        foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
-            $query_param_meta = new RestIncomingQueryParamMetadata($query_param_key, $query_param_value, $context);
-            if ($query_param_meta->getField() instanceof EE_Model_Field_Base) {
-                $translated_value = $query_param_meta->determineConditionsQueryParameterValue();
-                if (
-                    (isset($query_param_for_models[ $query_param_meta->getQueryParamKey() ])
-                     && $query_param_meta->isGmtField())
-                    || $translated_value === null
-                ) {
-                    // they have already provided a non-gmt field, ignore the gmt one. That's what WP core
-                    // currently does (they might change it though). See https://core.trac.wordpress.org/ticket/39954
-                    // OR we couldn't create a translated value from their input
-                    continue;
-                }
-                $query_param_for_models[ $query_param_meta->getQueryParamKey() ] = $translated_value;
-            } else {
-                $nested_query_params = $query_param_meta->determineNestedConditionQueryParameters();
-                if ($nested_query_params) {
-                    $query_param_for_models[ $query_param_meta->getQueryParamKey() ] = $nested_query_params;
-                }
-            }
-        }
-        return $query_param_for_models;
-    }
-
-
-    /**
-     * Mostly checks if the last 4 characters are "_gmt", indicating its a
-     * gmt date field name
-     *
-     * @param string $field_name
-     * @return boolean
-     */
-    public static function isGmtDateFieldName($field_name)
-    {
-        $field_name = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($field_name);
-        return substr($field_name, -4, 4) === '_gmt';
-    }
-
-
-    /**
-     * Removes the last "_gmt" part of a field name (and if there is no "_gmt" at the end, leave it alone)
-     *
-     * @param string $field_name
-     * @return string
-     */
-    public static function removeGmtFromFieldName($field_name)
-    {
-        if (! ModelDataTranslator::isGmtDateFieldName($field_name)) {
-            return $field_name;
-        }
-        $query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
-            $field_name
-        );
-        $query_param_sans_gmt_and_sans_stars = substr(
-            $query_param_sans_stars,
-            0,
-            strrpos(
-                $field_name,
-                '_gmt'
-            )
-        );
-        return str_replace($query_param_sans_stars, $query_param_sans_gmt_and_sans_stars, $field_name);
-    }
-
-
-    /**
-     * Takes a field name from the REST API and prepares it for the model querying
-     *
-     * @param string $field_name
-     * @return string
-     */
-    public static function prepareFieldNameFromJson($field_name)
-    {
-        if (ModelDataTranslator::isGmtDateFieldName($field_name)) {
-            return ModelDataTranslator::removeGmtFromFieldName($field_name);
-        }
-        return $field_name;
-    }
-
-
-    /**
-     * Takes array of field names from REST API and prepares for models
-     *
-     * @param array $field_names
-     * @return array of field names (possibly include model prefixes)
-     */
-    public static function prepareFieldNamesFromJson(array $field_names)
-    {
-        $new_array = [];
-        foreach ($field_names as $key => $field_name) {
-            $new_array[ $key ] = ModelDataTranslator::prepareFieldNameFromJson($field_name);
-        }
-        return $new_array;
-    }
-
-
-    /**
-     * Takes array where array keys are field names (possibly with model path prefixes)
-     * from the REST API and prepares them for model querying
-     *
-     * @param array $field_names_as_keys
-     * @return array
-     */
-    public static function prepareFieldNamesInArrayKeysFromJson(array $field_names_as_keys)
-    {
-        $new_array = [];
-        foreach ($field_names_as_keys as $field_name => $value) {
-            $new_array[ ModelDataTranslator::prepareFieldNameFromJson($field_name) ] = $value;
-        }
-        return $new_array;
-    }
-
-
-    /**
-     * Prepares an array of model query params for use in the REST API
-     *
-     * @param array    $model_query_params
-     * @param EEM_Base $model
-     * @param string   $requested_version  eg "4.8.36". If null is provided, defaults to the latest release of the EE4
-     *                                     REST API
-     * @return array which can be passed into the EE4 REST API when querying a model resource
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function prepareQueryParamsForRestApi(
-        array $model_query_params,
-        EEM_Base $model,
-        $requested_version = null
-    ) {
-        if ($requested_version === null) {
-            $requested_version = EED_Core_Rest_Api::latest_rest_api_version();
-        }
-        $rest_query_params = $model_query_params;
-        if (isset($model_query_params[0])) {
-            $rest_query_params['where'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
-                $model_query_params[0],
-                $model,
-                $requested_version
-            );
-            unset($rest_query_params[0]);
-        }
-        if (isset($model_query_params['having'])) {
-            $rest_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
-                $model_query_params['having'],
-                $model,
-                $requested_version
-            );
-        }
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_query_params_for_rest_api',
-            $rest_query_params,
-            $model_query_params,
-            $model,
-            $requested_version
-        );
-    }
-
-
-    /**
-     * Prepares all the sub-conditions query parameters (eg having or where conditions) for use in the rest api
-     *
-     * @param array    $inputted_query_params_of_this_type  eg like the "where" or "having" conditions query params
-     * @param EEM_Base $model
-     * @param string   $requested_version                   eg "4.8.36"
-     * @return array ready for use in the rest api query params
-     * @throws EE_Error
-     * @throws RestException if somehow a PHP object were in the query params' values,*@throws
-     * @throws ReflectionException
-     *                                                      ReflectionException
-     *                                                      (which would be really unusual)
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     */
-    public static function prepareConditionsQueryParamsForRestApi(
-        $inputted_query_params_of_this_type,
-        EEM_Base $model,
-        $requested_version
-    ) {
-        $query_param_for_models = [];
-        foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
-            $field = ModelDataTranslator::deduceFieldFromQueryParam(
-                ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($query_param_key),
-                $model
-            );
-            if ($field instanceof EE_Model_Field_Base) {
-                // did they specify an operator?
-                if (is_array($query_param_value)) {
-                    $op               = $query_param_value[0];
-                    $translated_value = [$op];
-                    if (isset($query_param_value[1])) {
-                        $value               = $query_param_value[1];
-                        $translated_value[1] = ModelDataTranslator::prepareFieldValuesForJson(
-                            $field,
-                            $value,
-                            $requested_version
-                        );
-                    }
-                } else {
-                    $translated_value = ModelDataTranslator::prepareFieldValueForJson(
-                        $field,
-                        $query_param_value,
-                        $requested_version
-                    );
-                }
-                $query_param_for_models[ $query_param_key ] = $translated_value;
-            } else {
-                // so it's not for a field, assume it's a logic query param key
-                $query_param_for_models[ $query_param_key ] =
-                    ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
-                        $query_param_value,
-                        $model,
-                        $requested_version
-                    );
-            }
-        }
-        return $query_param_for_models;
-    }
-
-
-    /**
-     * @param $condition_query_param_key
-     * @return string
-     */
-    public static function removeStarsAndAnythingAfterFromConditionQueryParamKey($condition_query_param_key)
-    {
-        $pos_of_star = strpos($condition_query_param_key, '*');
-        if ($pos_of_star === false) {
-            return $condition_query_param_key;
-        }
-        return substr($condition_query_param_key, 0, $pos_of_star);
-    }
-
-
-    /**
-     * Takes the input parameter and finds the model field that it indicates.
-     *
-     * @param string   $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
-     * @param EEM_Base $model
-     * @return EE_Model_Field_Base
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function deduceFieldFromQueryParam($query_param_name, EEM_Base $model)
-    {
-        // ok, now proceed with deducing which part is the model's name, and which is the field's name
-        // which will help us find the database table and column
-        $query_param_parts = explode('.', $query_param_name);
-        if (empty($query_param_parts)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        '_extract_column_name is empty when trying to extract column and table name from %s',
-                        'event_espresso'
-                    ),
-                    $query_param_name
-                )
-            );
-        }
-        $number_of_parts       = count($query_param_parts);
-        $last_query_param_part = $query_param_parts[ count($query_param_parts) - 1 ];
-        $field_name            = $last_query_param_part;
-        if ($number_of_parts !== 1) {
-            // the last part is the column name, and there are only 2parts. therefore...
-            $model = EE_Registry::instance()->load_model($query_param_parts[ $number_of_parts - 2 ]);
-        }
-        try {
-            return $model->field_settings_for($field_name, false);
-        } catch (EE_Error $e) {
-            return null;
-        }
-    }
-
-
-    /**
-     * Returns true if $data can be easily represented in JSON.
-     * Basically, objects and resources can't be represented in JSON easily.
-     *
-     * @param mixed $data
-     * @return bool
-     */
-    protected static function isRepresentableInJson($data)
-    {
-        return is_scalar($data)
-               || is_array($data)
-               || is_null($data);
-    }
+	/**
+	 * We used to use -1 for infinity in the rest api, but that's ambiguous for
+	 * fields that COULD contain -1; so we use null
+	 */
+	const EE_INF_IN_REST = null;
+
+
+	/**
+	 * Prepares a possible array of input values from JSON for use by the models
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed               $original_value_maybe_array
+	 * @param string              $requested_version
+	 * @param string              $timezone_string treat values as being in this timezone
+	 * @return mixed
+	 * @throws RestException
+	 * @throws EE_Error
+	 */
+	public static function prepareFieldValuesFromJson(
+		$field_obj,
+		$original_value_maybe_array,
+		$requested_version,
+		$timezone_string = 'UTC'
+	) {
+		if (
+			is_array($original_value_maybe_array)
+			&& ! $field_obj instanceof EE_Serialized_Text_Field
+		) {
+			$new_value_maybe_array = [];
+			foreach ($original_value_maybe_array as $array_key => $array_item) {
+				$new_value_maybe_array[ $array_key ] = ModelDataTranslator::prepareFieldValueFromJson(
+					$field_obj,
+					$array_item,
+					$requested_version,
+					$timezone_string
+				);
+			}
+		} else {
+			$new_value_maybe_array = ModelDataTranslator::prepareFieldValueFromJson(
+				$field_obj,
+				$original_value_maybe_array,
+				$requested_version,
+				$timezone_string
+			);
+		}
+		return $new_value_maybe_array;
+	}
+
+
+	/**
+	 * Prepares an array of field values FOR use in JSON/REST API
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed               $original_value_maybe_array
+	 * @param string              $request_version (eg 4.8.36)
+	 * @return array
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public static function prepareFieldValuesForJson($field_obj, $original_value_maybe_array, $request_version)
+	{
+		if (is_array($original_value_maybe_array)) {
+			$new_value = [];
+			foreach ($original_value_maybe_array as $key => $value) {
+				$new_value[ $key ] = ModelDataTranslator::prepareFieldValuesForJson(
+					$field_obj,
+					$value,
+					$request_version
+				);
+			}
+		} else {
+			$new_value = ModelDataTranslator::prepareFieldValueForJson(
+				$field_obj,
+				$original_value_maybe_array,
+				$request_version
+			);
+		}
+		return $new_value;
+	}
+
+
+	/**
+	 * Prepares incoming data from the json or request parameters for the models'
+	 * "$query_params".
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed               $original_value
+	 * @param string              $requested_version
+	 * @param string              $timezone_string treat values as being in this timezone
+	 * @return mixed
+	 * @throws RestException
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public static function prepareFieldValueFromJson(
+		$field_obj,
+		$original_value,
+		$requested_version,
+		$timezone_string = 'UTC'
+	) {
+		// check if they accidentally submitted an error value. If so throw an exception
+		if (
+			is_array($original_value)
+			&& isset($original_value['error_code'], $original_value['error_message'])
+		) {
+			throw new RestException(
+				'rest_submitted_error_value',
+				sprintf(
+					esc_html__(
+						'You tried to submit a JSON error object as a value for %1$s. That\'s not allowed.',
+						'event_espresso'
+					),
+					$field_obj->get_name()
+				),
+				[
+					'status' => 400,
+				]
+			);
+		}
+		// double-check for serialized PHP. We never accept serialized PHP. No way Jose.
+		ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value);
+		$timezone_string =
+			$timezone_string !== ''
+				? $timezone_string
+				: get_option('timezone_string', '');
+		// walk through the submitted data and double-check for serialized PHP. We never accept serialized PHP. No
+		// way Jose.
+		ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value);
+		if (
+			$field_obj instanceof EE_Infinite_Integer_Field
+			&& in_array($original_value, [null, ''], true)
+		) {
+			$new_value = EE_INF;
+		} elseif ($field_obj instanceof EE_Datetime_Field) {
+			$new_value = rest_parse_date(
+				self::getTimestampWithTimezoneOffset($original_value, $field_obj, $timezone_string)
+			);
+			if ($new_value === false) {
+				throw new RestException(
+					'invalid_format_for_timestamp',
+					sprintf(
+						esc_html__(
+							'Timestamps received on a request as the value for Date and Time fields must be in %1$s/%2$s format.  The timestamp provided (%3$s) is not that format.',
+							'event_espresso'
+						),
+						'RFC3339',
+						'ISO8601',
+						$original_value
+					),
+					[
+						'status' => 400,
+					]
+				);
+			}
+		} elseif ($field_obj instanceof EE_Boolean_Field) {
+			// Interpreted the strings "false", "true", "on", "off" appropriately.
+			$new_value = filter_var($original_value, FILTER_VALIDATE_BOOLEAN);
+		} else {
+			$new_value = $original_value;
+		}
+		return $new_value;
+	}
+
+
+	/**
+	 * This checks if the incoming timestamp has timezone information already on it and if it doesn't then adds timezone
+	 * information via details obtained from the host site.
+	 *
+	 * @param string            $original_timestamp
+	 * @param EE_Datetime_Field $datetime_field
+	 * @param                   $timezone_string
+	 * @return string
+	 * @throws DomainException
+	 */
+	private static function getTimestampWithTimezoneOffset(
+		$original_timestamp,
+		EE_Datetime_Field $datetime_field,
+		$timezone_string
+	) {
+		// already have timezone information?
+		if (preg_match('/Z|([+-])(\d{2}:\d{2})/', $original_timestamp)) {
+			// yes, we're ignoring the timezone.
+			return $original_timestamp;
+		}
+		// need to append timezone
+		list($offset_sign, $offset_secs) = self::parseTimezoneOffset(
+			$datetime_field->get_timezone_offset(
+				new DateTimeZone($timezone_string),
+				$original_timestamp
+			)
+		);
+		$offset_string =
+			str_pad(
+				floor($offset_secs / HOUR_IN_SECONDS),
+				2,
+				'0',
+				STR_PAD_LEFT
+			)
+			. ':'
+			. str_pad(
+				($offset_secs % HOUR_IN_SECONDS) / MINUTE_IN_SECONDS,
+				2,
+				'0',
+				STR_PAD_LEFT
+			);
+		return $original_timestamp . $offset_sign . $offset_string;
+	}
+
+
+	/**
+	 * Throws an exception if $data is a serialized PHP string (or somehow an actually PHP object, although I don't
+	 * think that can happen). If $data is an array, recurses into its keys and values
+	 *
+	 * @param mixed $data
+	 * @return void
+	 * @throws RestException
+	 */
+	public static function throwExceptionIfContainsSerializedData($data)
+	{
+		if (is_array($data)) {
+			foreach ($data as $key => $value) {
+				ModelDataTranslator::throwExceptionIfContainsSerializedData($key);
+				ModelDataTranslator::throwExceptionIfContainsSerializedData($value);
+			}
+		} else {
+			if (is_serialized($data) || is_object($data)) {
+				throw new RestException(
+					'serialized_data_submission_prohibited',
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'You tried to submit a string of serialized text. Serialized PHP is prohibited over the EE4 REST API.',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					)
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * determines what's going on with them timezone strings
+	 *
+	 * @param int $timezone_offset
+	 * @return array
+	 */
+	private static function parseTimezoneOffset($timezone_offset)
+	{
+		$first_char = substr((string) $timezone_offset, 0, 1);
+		if ($first_char === '+' || $first_char === '-') {
+			$offset_sign = $first_char;
+			$offset_secs = substr((string) $timezone_offset, 1);
+		} else {
+			$offset_sign = '+';
+			$offset_secs = $timezone_offset;
+		}
+		return [$offset_sign, $offset_secs];
+	}
+
+
+	/**
+	 * Prepares a field's value for display in the API
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed               $original_value
+	 * @param string              $requested_version
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public static function prepareFieldValueForJson($field_obj, $original_value, $requested_version)
+	{
+		if ($original_value === EE_INF) {
+			$new_value = ModelDataTranslator::EE_INF_IN_REST;
+		} elseif ($field_obj instanceof EE_Datetime_Field) {
+			if (is_string($original_value)) {
+				// did they submit a string of a unix timestamp?
+				if (is_numeric($original_value)) {
+					$datetime_obj = new DateTime();
+					$datetime_obj->setTimestamp((int) $original_value);
+				} else {
+					// first, check if its a MySQL timestamp in GMT
+					$datetime_obj = DateTime::createFromFormat('Y-m-d H:i:s', $original_value);
+				}
+				if (! $datetime_obj instanceof DateTime) {
+					// so it's not a unix timestamp or a MySQL timestamp. Maybe its in the field's date/time format?
+					$datetime_obj = $field_obj->prepare_for_set($original_value);
+				}
+				$original_value = $datetime_obj;
+			}
+			if ($original_value instanceof DateTime) {
+				$new_value = $original_value->format('Y-m-d H:i:s');
+			} elseif (is_int($original_value) || is_float($original_value)) {
+				$new_value = date('Y-m-d H:i:s', $original_value);
+			} elseif ($original_value === null || $original_value === '') {
+				$new_value = null;
+			} else {
+				// so it's not a datetime object, unix timestamp (as string or int),
+				// MySQL timestamp, or even a string in the field object's format. So no idea what it is
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+						// @codingStandardsIgnoreStart
+							'The value "%1$s" for the field "%2$s" on model "%3$s" could not be understood. It should be a PHP DateTime, unix timestamp, MySQL date, or string in the format "%4$s".',
+							// @codingStandardsIgnoreEnd
+							'event_espresso'
+						),
+						$original_value,
+						$field_obj->get_name(),
+						$field_obj->get_model_name(),
+						$field_obj->get_time_format() . ' ' . $field_obj->get_time_format()
+					)
+				);
+			}
+			if ($new_value !== null) {
+				// phpcs:disable PHPCompatibility.Extensions.RemovedExtensions.mysql_DeprecatedRemoved
+				$new_value = mysql_to_rfc3339($new_value);
+				// phpcs:enable
+			}
+		} else {
+			$new_value = $original_value;
+		}
+		// are we about to send an object? just don't. We have no good way to represent it in JSON.
+		// can't just check using is_object() because that missed PHP incomplete objects
+		if (! ModelDataTranslator::isRepresentableInJson($new_value)) {
+			$new_value = [
+				'error_code'    => 'php_object_not_return',
+				'error_message' => esc_html__(
+					'The value of this field in the database is a PHP object, which can\'t be represented in JSON.',
+					'event_espresso'
+				),
+			];
+		}
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
+			$new_value,
+			$field_obj,
+			$original_value,
+			$requested_version
+		);
+	}
+
+
+	/**
+	 * Prepares condition-query-parameters (like what's in where and having) from
+	 * the format expected in the API to use in the models
+	 *
+	 * @param array    $inputted_query_params_of_this_type
+	 * @param EEM_Base $model
+	 * @param string   $requested_version
+	 * @param boolean  $writing whether this data will be written to the DB, or if we're just building a query.
+	 *                          If we're writing to the DB, we don't expect any operators, or any logic query
+	 *                          parameters, and we also won't accept serialized data unless the current user has
+	 *                          unfiltered_html.
+	 * @return array
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws RestException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public static function prepareConditionsQueryParamsForModels(
+		$inputted_query_params_of_this_type,
+		EEM_Base $model,
+		$requested_version,
+		$writing = false
+	) {
+		$query_param_for_models = [];
+		$context                = new RestIncomingQueryParamContext($model, $requested_version, $writing);
+		foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
+			$query_param_meta = new RestIncomingQueryParamMetadata($query_param_key, $query_param_value, $context);
+			if ($query_param_meta->getField() instanceof EE_Model_Field_Base) {
+				$translated_value = $query_param_meta->determineConditionsQueryParameterValue();
+				if (
+					(isset($query_param_for_models[ $query_param_meta->getQueryParamKey() ])
+					 && $query_param_meta->isGmtField())
+					|| $translated_value === null
+				) {
+					// they have already provided a non-gmt field, ignore the gmt one. That's what WP core
+					// currently does (they might change it though). See https://core.trac.wordpress.org/ticket/39954
+					// OR we couldn't create a translated value from their input
+					continue;
+				}
+				$query_param_for_models[ $query_param_meta->getQueryParamKey() ] = $translated_value;
+			} else {
+				$nested_query_params = $query_param_meta->determineNestedConditionQueryParameters();
+				if ($nested_query_params) {
+					$query_param_for_models[ $query_param_meta->getQueryParamKey() ] = $nested_query_params;
+				}
+			}
+		}
+		return $query_param_for_models;
+	}
+
+
+	/**
+	 * Mostly checks if the last 4 characters are "_gmt", indicating its a
+	 * gmt date field name
+	 *
+	 * @param string $field_name
+	 * @return boolean
+	 */
+	public static function isGmtDateFieldName($field_name)
+	{
+		$field_name = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($field_name);
+		return substr($field_name, -4, 4) === '_gmt';
+	}
+
+
+	/**
+	 * Removes the last "_gmt" part of a field name (and if there is no "_gmt" at the end, leave it alone)
+	 *
+	 * @param string $field_name
+	 * @return string
+	 */
+	public static function removeGmtFromFieldName($field_name)
+	{
+		if (! ModelDataTranslator::isGmtDateFieldName($field_name)) {
+			return $field_name;
+		}
+		$query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
+			$field_name
+		);
+		$query_param_sans_gmt_and_sans_stars = substr(
+			$query_param_sans_stars,
+			0,
+			strrpos(
+				$field_name,
+				'_gmt'
+			)
+		);
+		return str_replace($query_param_sans_stars, $query_param_sans_gmt_and_sans_stars, $field_name);
+	}
+
+
+	/**
+	 * Takes a field name from the REST API and prepares it for the model querying
+	 *
+	 * @param string $field_name
+	 * @return string
+	 */
+	public static function prepareFieldNameFromJson($field_name)
+	{
+		if (ModelDataTranslator::isGmtDateFieldName($field_name)) {
+			return ModelDataTranslator::removeGmtFromFieldName($field_name);
+		}
+		return $field_name;
+	}
+
+
+	/**
+	 * Takes array of field names from REST API and prepares for models
+	 *
+	 * @param array $field_names
+	 * @return array of field names (possibly include model prefixes)
+	 */
+	public static function prepareFieldNamesFromJson(array $field_names)
+	{
+		$new_array = [];
+		foreach ($field_names as $key => $field_name) {
+			$new_array[ $key ] = ModelDataTranslator::prepareFieldNameFromJson($field_name);
+		}
+		return $new_array;
+	}
+
+
+	/**
+	 * Takes array where array keys are field names (possibly with model path prefixes)
+	 * from the REST API and prepares them for model querying
+	 *
+	 * @param array $field_names_as_keys
+	 * @return array
+	 */
+	public static function prepareFieldNamesInArrayKeysFromJson(array $field_names_as_keys)
+	{
+		$new_array = [];
+		foreach ($field_names_as_keys as $field_name => $value) {
+			$new_array[ ModelDataTranslator::prepareFieldNameFromJson($field_name) ] = $value;
+		}
+		return $new_array;
+	}
+
+
+	/**
+	 * Prepares an array of model query params for use in the REST API
+	 *
+	 * @param array    $model_query_params
+	 * @param EEM_Base $model
+	 * @param string   $requested_version  eg "4.8.36". If null is provided, defaults to the latest release of the EE4
+	 *                                     REST API
+	 * @return array which can be passed into the EE4 REST API when querying a model resource
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function prepareQueryParamsForRestApi(
+		array $model_query_params,
+		EEM_Base $model,
+		$requested_version = null
+	) {
+		if ($requested_version === null) {
+			$requested_version = EED_Core_Rest_Api::latest_rest_api_version();
+		}
+		$rest_query_params = $model_query_params;
+		if (isset($model_query_params[0])) {
+			$rest_query_params['where'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
+				$model_query_params[0],
+				$model,
+				$requested_version
+			);
+			unset($rest_query_params[0]);
+		}
+		if (isset($model_query_params['having'])) {
+			$rest_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
+				$model_query_params['having'],
+				$model,
+				$requested_version
+			);
+		}
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_query_params_for_rest_api',
+			$rest_query_params,
+			$model_query_params,
+			$model,
+			$requested_version
+		);
+	}
+
+
+	/**
+	 * Prepares all the sub-conditions query parameters (eg having or where conditions) for use in the rest api
+	 *
+	 * @param array    $inputted_query_params_of_this_type  eg like the "where" or "having" conditions query params
+	 * @param EEM_Base $model
+	 * @param string   $requested_version                   eg "4.8.36"
+	 * @return array ready for use in the rest api query params
+	 * @throws EE_Error
+	 * @throws RestException if somehow a PHP object were in the query params' values,*@throws
+	 * @throws ReflectionException
+	 *                                                      ReflectionException
+	 *                                                      (which would be really unusual)
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 */
+	public static function prepareConditionsQueryParamsForRestApi(
+		$inputted_query_params_of_this_type,
+		EEM_Base $model,
+		$requested_version
+	) {
+		$query_param_for_models = [];
+		foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
+			$field = ModelDataTranslator::deduceFieldFromQueryParam(
+				ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($query_param_key),
+				$model
+			);
+			if ($field instanceof EE_Model_Field_Base) {
+				// did they specify an operator?
+				if (is_array($query_param_value)) {
+					$op               = $query_param_value[0];
+					$translated_value = [$op];
+					if (isset($query_param_value[1])) {
+						$value               = $query_param_value[1];
+						$translated_value[1] = ModelDataTranslator::prepareFieldValuesForJson(
+							$field,
+							$value,
+							$requested_version
+						);
+					}
+				} else {
+					$translated_value = ModelDataTranslator::prepareFieldValueForJson(
+						$field,
+						$query_param_value,
+						$requested_version
+					);
+				}
+				$query_param_for_models[ $query_param_key ] = $translated_value;
+			} else {
+				// so it's not for a field, assume it's a logic query param key
+				$query_param_for_models[ $query_param_key ] =
+					ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
+						$query_param_value,
+						$model,
+						$requested_version
+					);
+			}
+		}
+		return $query_param_for_models;
+	}
+
+
+	/**
+	 * @param $condition_query_param_key
+	 * @return string
+	 */
+	public static function removeStarsAndAnythingAfterFromConditionQueryParamKey($condition_query_param_key)
+	{
+		$pos_of_star = strpos($condition_query_param_key, '*');
+		if ($pos_of_star === false) {
+			return $condition_query_param_key;
+		}
+		return substr($condition_query_param_key, 0, $pos_of_star);
+	}
+
+
+	/**
+	 * Takes the input parameter and finds the model field that it indicates.
+	 *
+	 * @param string   $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
+	 * @param EEM_Base $model
+	 * @return EE_Model_Field_Base
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function deduceFieldFromQueryParam($query_param_name, EEM_Base $model)
+	{
+		// ok, now proceed with deducing which part is the model's name, and which is the field's name
+		// which will help us find the database table and column
+		$query_param_parts = explode('.', $query_param_name);
+		if (empty($query_param_parts)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'_extract_column_name is empty when trying to extract column and table name from %s',
+						'event_espresso'
+					),
+					$query_param_name
+				)
+			);
+		}
+		$number_of_parts       = count($query_param_parts);
+		$last_query_param_part = $query_param_parts[ count($query_param_parts) - 1 ];
+		$field_name            = $last_query_param_part;
+		if ($number_of_parts !== 1) {
+			// the last part is the column name, and there are only 2parts. therefore...
+			$model = EE_Registry::instance()->load_model($query_param_parts[ $number_of_parts - 2 ]);
+		}
+		try {
+			return $model->field_settings_for($field_name, false);
+		} catch (EE_Error $e) {
+			return null;
+		}
+	}
+
+
+	/**
+	 * Returns true if $data can be easily represented in JSON.
+	 * Basically, objects and resources can't be represented in JSON easily.
+	 *
+	 * @param mixed $data
+	 * @return bool
+	 */
+	protected static function isRepresentableInJson($data)
+	{
+		return is_scalar($data)
+			   || is_array($data)
+			   || is_null($data);
+	}
 }

core/libraries/shortcodes/EE_Attendee_Shortcodes.lib.php

Spacing +5 added lines, -5 removed lines

@@ -114,7 +114,7 @@ 
             ? null
             : $this->_data;
 
-        if (! $registration instanceof EE_Registration) {
+        if ( ! $registration instanceof EE_Registration) {
             // let's attempt to get the txn_id for the error message.
             $txn_id  = isset($this->_extra->txn) && $this->_extra->txn instanceof EE_Transaction
                 ? $this->_extra->txn->ID()
@@ -131,12 +131,12 @@ 
         }
 
         // attendee obj for this registration
-        $attendee = isset($this->_extra->registrations[ $registration->ID() ]['att_obj'])
-            ? $this->_extra->registrations[ $registration->ID() ]['att_obj']
+        $attendee = isset($this->_extra->registrations[$registration->ID()]['att_obj'])
+            ? $this->_extra->registrations[$registration->ID()]['att_obj']
             : null;
 
-        if (! $attendee instanceof EE_Attendee) {
-            $msg     = esc_html__(
+        if ( ! $attendee instanceof EE_Attendee) {
+            $msg = esc_html__(
                 'There is no EE_Attendee object in the data sent to the EE_Attendee_Shortcode parser for the messages system.',
                 'event_espresso'
             );

Indentation +188 added lines, -188 removed lines

@@ -15,192 +15,192 @@
  */
 class EE_Attendee_Shortcodes extends EE_Shortcodes
 {
-    /**
-     * hold all extra data.
-     *
-     * @var array
-     */
-    protected $_extra;
-
-
-    /**
-     * EE_Attendee_Shortcodes constructor.
-     */
-    public function __construct()
-    {
-        parent::__construct();
-    }
-
-
-    protected function _init_props()
-    {
-        $this->label       = esc_html__('Attendee Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to attendee related data', 'event_espresso');
-        $this->_shortcodes = [
-            '[FNAME]'                          => esc_html__('First Name of an attendee.', 'event_espresso'),
-            '[LNAME]'                          => esc_html__('Last Name of an attendee.', 'event_espresso'),
-            '[ATTENDEE_EMAIL]'                 => esc_html__('Email address for the attendee.', 'event_espresso'),
-            '[EDIT_ATTENDEE_LINK]'             => esc_html__(
-                'Edit Registration Link (typically you\'d only use this for messages going to event administrators)',
-                'event_espresso'
-            ),
-            '[REGISTRATION_ID]'                => esc_html__(
-                'Unique Registration ID for the registration',
-                'event_espresso'
-            ),
-            '[REGISTRATION_CODE]'              => esc_html__(
-                'Unique Registration Code for the registration',
-                'event_espresso'
-            ),
-            '[REGISTRATION_STATUS_ID]'         => esc_html__(
-                'Parses to the registration status for the attendee',
-                'event_espresso'
-            ),
-            '[REGISTRATION_STATUS_LABEL]'      => esc_html__(
-                'Parses to the status label for the registrant',
-                'event_espresso'
-            ),
-            '[REGISTRATION_TOTAL_AMOUNT_PAID]' => esc_html__(
-                'Parses to the total amount paid for this registration.',
-                'event_espresso'
-            ),
-            '[FRONTEND_EDIT_REG_LINK]'         => esc_html__(
-                'Generates a link for the given registration to edit this registration details on the frontend.',
-                'event_espresso'
-            ),
-            '[PHONE_NUMBER]'                   => esc_html__(
-                'The Phone Number for the Registration.',
-                'event_espresso'
-            ),
-            '[ADDRESS]'                        => esc_html__('The Address for the Registration', 'event_espresso'),
-            '[ADDRESS2]'                       => esc_html__(
-                'Whatever was in the address 2 field for the registration.',
-                'event_espresso'
-            ),
-            '[CITY]'                           => esc_html__('The city for the registration.', 'event_espresso'),
-            '[ZIP_PC]'                         => esc_html__(
-                'The ZIP (or Postal) Code for the Registration.',
-                'event_espresso'
-            ),
-            '[ADDRESS_STATE]'                  => esc_html__(
-                'The state/province for the registration.',
-                'event_espresso'
-            ),
-            '[COUNTRY]'                        => esc_html__('The country for the registration.', 'event_espresso'),
-        ];
-    }
-
-
-    /**
-     * handles shortcode parsing
-     *
-     * @access protected
-     * @param string $shortcode the shortcode to be parsed.
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _parser($shortcode)
-    {
-
-
-        $this->_extra = ! empty($this->_extra_data) && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-            ? $this->_extra_data['data']
-            : null;
-
-        // incoming object should only be a registration object.
-        $registration = ! $this->_data instanceof EE_Registration
-            ? null
-            : $this->_data;
-
-        if (! $registration instanceof EE_Registration) {
-            // let's attempt to get the txn_id for the error message.
-            $txn_id  = isset($this->_extra->txn) && $this->_extra->txn instanceof EE_Transaction
-                ? $this->_extra->txn->ID()
-                : esc_html__('Unknown', 'event_espresso');
-            $msg     = esc_html__(
-                'There is no EE_Registration object in the data sent to the EE_Attendee Shortcode Parser for the messages system.',
-                'event_espresso'
-            );
-            $dev_msg = sprintf(
-                esc_html__('The transaction ID for this request is: %s', 'event_espresso'),
-                $txn_id
-            );
-            throw new EE_Error("{$msg}||{$msg} {$dev_msg}");
-        }
-
-        // attendee obj for this registration
-        $attendee = isset($this->_extra->registrations[ $registration->ID() ]['att_obj'])
-            ? $this->_extra->registrations[ $registration->ID() ]['att_obj']
-            : null;
-
-        if (! $attendee instanceof EE_Attendee) {
-            $msg     = esc_html__(
-                'There is no EE_Attendee object in the data sent to the EE_Attendee_Shortcode parser for the messages system.',
-                'event_espresso'
-            );
-            $dev_msg = sprintf(
-                esc_html__('The registration ID for this request is: %s', 'event_espresso'),
-                $registration->ID()
-            );
-            throw new EE_Error("{$msg}||{$msg} {$dev_msg}");
-        }
-
-        switch ($shortcode) {
-            case '[FNAME]':
-                return $attendee->fname();
-
-            case '[LNAME]':
-                return $attendee->lname();
-
-            case '[ATTENDEE_EMAIL]':
-                return $attendee->email();
-
-            case '[EDIT_ATTENDEE_LINK]':
-                return $registration->get_admin_edit_url();
-
-            case '[REGISTRATION_CODE]':
-                return $registration->reg_code();
-
-            case '[REGISTRATION_ID]':
-                return $registration->ID();
-
-            case '[FRONTEND_EDIT_REG_LINK]':
-                return $registration->edit_attendee_information_url();
-
-            case '[PHONE_NUMBER]':
-                return $attendee->phone();
-
-            case '[ADDRESS]':
-                return $attendee->address();
-
-            case '[ADDRESS2]':
-                return $attendee->address2();
-
-            case '[CITY]':
-                return $attendee->city();
-
-            case '[ZIP_PC]':
-                return $attendee->zip();
-
-            case '[ADDRESS_STATE]':
-                $state_obj = $attendee->state_obj();
-                return $state_obj instanceof EE_State ? $state_obj->name() : '';
-
-            case '[COUNTRY]':
-                $country_obj = $attendee->country_obj();
-                return $country_obj instanceof EE_Country ? $country_obj->name() : '';
-
-            case '[REGISTRATION_STATUS_ID]':
-                return $registration->status_ID();
-
-            case '[REGISTRATION_STATUS_LABEL]':
-                return $registration->pretty_status();
-
-            case '[REGISTRATION_TOTAL_AMOUNT_PAID]':
-                return $registration->pretty_paid();
-        }
-
-        return '';
-    }
+	/**
+	 * hold all extra data.
+	 *
+	 * @var array
+	 */
+	protected $_extra;
+
+
+	/**
+	 * EE_Attendee_Shortcodes constructor.
+	 */
+	public function __construct()
+	{
+		parent::__construct();
+	}
+
+
+	protected function _init_props()
+	{
+		$this->label       = esc_html__('Attendee Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to attendee related data', 'event_espresso');
+		$this->_shortcodes = [
+			'[FNAME]'                          => esc_html__('First Name of an attendee.', 'event_espresso'),
+			'[LNAME]'                          => esc_html__('Last Name of an attendee.', 'event_espresso'),
+			'[ATTENDEE_EMAIL]'                 => esc_html__('Email address for the attendee.', 'event_espresso'),
+			'[EDIT_ATTENDEE_LINK]'             => esc_html__(
+				'Edit Registration Link (typically you\'d only use this for messages going to event administrators)',
+				'event_espresso'
+			),
+			'[REGISTRATION_ID]'                => esc_html__(
+				'Unique Registration ID for the registration',
+				'event_espresso'
+			),
+			'[REGISTRATION_CODE]'              => esc_html__(
+				'Unique Registration Code for the registration',
+				'event_espresso'
+			),
+			'[REGISTRATION_STATUS_ID]'         => esc_html__(
+				'Parses to the registration status for the attendee',
+				'event_espresso'
+			),
+			'[REGISTRATION_STATUS_LABEL]'      => esc_html__(
+				'Parses to the status label for the registrant',
+				'event_espresso'
+			),
+			'[REGISTRATION_TOTAL_AMOUNT_PAID]' => esc_html__(
+				'Parses to the total amount paid for this registration.',
+				'event_espresso'
+			),
+			'[FRONTEND_EDIT_REG_LINK]'         => esc_html__(
+				'Generates a link for the given registration to edit this registration details on the frontend.',
+				'event_espresso'
+			),
+			'[PHONE_NUMBER]'                   => esc_html__(
+				'The Phone Number for the Registration.',
+				'event_espresso'
+			),
+			'[ADDRESS]'                        => esc_html__('The Address for the Registration', 'event_espresso'),
+			'[ADDRESS2]'                       => esc_html__(
+				'Whatever was in the address 2 field for the registration.',
+				'event_espresso'
+			),
+			'[CITY]'                           => esc_html__('The city for the registration.', 'event_espresso'),
+			'[ZIP_PC]'                         => esc_html__(
+				'The ZIP (or Postal) Code for the Registration.',
+				'event_espresso'
+			),
+			'[ADDRESS_STATE]'                  => esc_html__(
+				'The state/province for the registration.',
+				'event_espresso'
+			),
+			'[COUNTRY]'                        => esc_html__('The country for the registration.', 'event_espresso'),
+		];
+	}
+
+
+	/**
+	 * handles shortcode parsing
+	 *
+	 * @access protected
+	 * @param string $shortcode the shortcode to be parsed.
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _parser($shortcode)
+	{
+
+
+		$this->_extra = ! empty($this->_extra_data) && $this->_extra_data['data'] instanceof EE_Messages_Addressee
+			? $this->_extra_data['data']
+			: null;
+
+		// incoming object should only be a registration object.
+		$registration = ! $this->_data instanceof EE_Registration
+			? null
+			: $this->_data;
+
+		if (! $registration instanceof EE_Registration) {
+			// let's attempt to get the txn_id for the error message.
+			$txn_id  = isset($this->_extra->txn) && $this->_extra->txn instanceof EE_Transaction
+				? $this->_extra->txn->ID()
+				: esc_html__('Unknown', 'event_espresso');
+			$msg     = esc_html__(
+				'There is no EE_Registration object in the data sent to the EE_Attendee Shortcode Parser for the messages system.',
+				'event_espresso'
+			);
+			$dev_msg = sprintf(
+				esc_html__('The transaction ID for this request is: %s', 'event_espresso'),
+				$txn_id
+			);
+			throw new EE_Error("{$msg}||{$msg} {$dev_msg}");
+		}
+
+		// attendee obj for this registration
+		$attendee = isset($this->_extra->registrations[ $registration->ID() ]['att_obj'])
+			? $this->_extra->registrations[ $registration->ID() ]['att_obj']
+			: null;
+
+		if (! $attendee instanceof EE_Attendee) {
+			$msg     = esc_html__(
+				'There is no EE_Attendee object in the data sent to the EE_Attendee_Shortcode parser for the messages system.',
+				'event_espresso'
+			);
+			$dev_msg = sprintf(
+				esc_html__('The registration ID for this request is: %s', 'event_espresso'),
+				$registration->ID()
+			);
+			throw new EE_Error("{$msg}||{$msg} {$dev_msg}");
+		}
+
+		switch ($shortcode) {
+			case '[FNAME]':
+				return $attendee->fname();
+
+			case '[LNAME]':
+				return $attendee->lname();
+
+			case '[ATTENDEE_EMAIL]':
+				return $attendee->email();
+
+			case '[EDIT_ATTENDEE_LINK]':
+				return $registration->get_admin_edit_url();
+
+			case '[REGISTRATION_CODE]':
+				return $registration->reg_code();
+
+			case '[REGISTRATION_ID]':
+				return $registration->ID();
+
+			case '[FRONTEND_EDIT_REG_LINK]':
+				return $registration->edit_attendee_information_url();
+
+			case '[PHONE_NUMBER]':
+				return $attendee->phone();
+
+			case '[ADDRESS]':
+				return $attendee->address();
+
+			case '[ADDRESS2]':
+				return $attendee->address2();
+
+			case '[CITY]':
+				return $attendee->city();
+
+			case '[ZIP_PC]':
+				return $attendee->zip();
+
+			case '[ADDRESS_STATE]':
+				$state_obj = $attendee->state_obj();
+				return $state_obj instanceof EE_State ? $state_obj->name() : '';
+
+			case '[COUNTRY]':
+				$country_obj = $attendee->country_obj();
+				return $country_obj instanceof EE_Country ? $country_obj->name() : '';
+
+			case '[REGISTRATION_STATUS_ID]':
+				return $registration->status_ID();
+
+			case '[REGISTRATION_STATUS_LABEL]':
+				return $registration->pretty_status();
+
+			case '[REGISTRATION_TOTAL_AMOUNT_PAID]':
+				return $registration->pretty_paid();
+		}
+
+		return '';
+	}
 }