eventespresso / event-espresso-core

modules/ticket_selector/TicketSelectorSimple.php

Spacing +1 added lines, -1 removed lines

@@ -72,6 +72,6 @@
         }
         $this->template_args['ticket_description'] = $ticket_selector_row->getTicketDescription();
         $this->template_args['template_path']      =
-            TICKET_SELECTOR_TEMPLATES_PATH . 'simple_ticket_selector.template.php';
+            TICKET_SELECTOR_TEMPLATES_PATH.'simple_ticket_selector.template.php';
     }
 }

Indentation +51 added lines, -51 removed lines

@@ -19,59 +19,59 @@
  */
 class TicketSelectorSimple extends TicketSelector
 {
-    /**
-     * @var EE_Ticket $ticket
-     */
-    protected $ticket;
+	/**
+	 * @var EE_Ticket $ticket
+	 */
+	protected $ticket;
 
 
-    /**
-     * TicketSelectorSimple constructor.
-     *
-     * @param EE_Event  $event
-     * @param EE_Ticket $ticket
-     * @param int       $max_attendees
-     * @param array     $template_args
-     * @throws EE_Error
-     */
-    public function __construct(EE_Event $event, EE_Ticket $ticket, $max_attendees, array $template_args)
-    {
-        $this->ticket = $ticket;
-        parent::__construct(
-            $event,
-            [$this->ticket],
-            $max_attendees,
-            $template_args
-        );
-    }
+	/**
+	 * TicketSelectorSimple constructor.
+	 *
+	 * @param EE_Event  $event
+	 * @param EE_Ticket $ticket
+	 * @param int       $max_attendees
+	 * @param array     $template_args
+	 * @throws EE_Error
+	 */
+	public function __construct(EE_Event $event, EE_Ticket $ticket, $max_attendees, array $template_args)
+	{
+		$this->ticket = $ticket;
+		parent::__construct(
+			$event,
+			[$this->ticket],
+			$max_attendees,
+			$template_args
+		);
+	}
 
 
-    /**
-     * sets any and all template args that are required for this Ticket Selector
-     *
-     * @return void
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function addTemplateArgs()
-    {
-        $this->ticket_rows = 1;
-        unset($this->template_args['tickets']);
-        $this->template_args['ticket'] = $this->ticket;
-        $ticket_selector_row           = new TicketSelectorRowSimple(
-            $this->ticket,
-            $this->max_attendees,
-            $this->template_args['date_format'],
-            $this->template_args['event_status']
-        );
-        $this->template_args['TKT_ID'] = $this->ticket->ID();
-        $ticket_selector_row->setupTicketStatusDisplay();
-        $this->template_args['ticket_status_display'] = $ticket_selector_row->getTicketStatusDisplay();
-        if (empty($this->template_args['ticket_status_display'])) {
-            add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
-        }
-        $this->template_args['ticket_description'] = $ticket_selector_row->getTicketDescription();
-        $this->template_args['template_path']      =
-            TICKET_SELECTOR_TEMPLATES_PATH . 'simple_ticket_selector.template.php';
-    }
+	/**
+	 * sets any and all template args that are required for this Ticket Selector
+	 *
+	 * @return void
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function addTemplateArgs()
+	{
+		$this->ticket_rows = 1;
+		unset($this->template_args['tickets']);
+		$this->template_args['ticket'] = $this->ticket;
+		$ticket_selector_row           = new TicketSelectorRowSimple(
+			$this->ticket,
+			$this->max_attendees,
+			$this->template_args['date_format'],
+			$this->template_args['event_status']
+		);
+		$this->template_args['TKT_ID'] = $this->ticket->ID();
+		$ticket_selector_row->setupTicketStatusDisplay();
+		$this->template_args['ticket_status_display'] = $ticket_selector_row->getTicketStatusDisplay();
+		if (empty($this->template_args['ticket_status_display'])) {
+			add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
+		}
+		$this->template_args['ticket_description'] = $ticket_selector_row->getTicketDescription();
+		$this->template_args['template_path']      =
+			TICKET_SELECTOR_TEMPLATES_PATH . 'simple_ticket_selector.template.php';
+	}
 }

modules/single_page_checkout/inc/EE_SPCO_Reg_Step.class.php

Spacing +15 added lines, -15 removed lines

@@ -228,7 +228,7 @@ 
      */
     public function set_submit_button_text($submit_button_text = '')
     {
-        if (! empty($submit_button_text)) {
+        if ( ! empty($submit_button_text)) {
             $this->_submit_button_text = $submit_button_text;
         } elseif ($this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
             if ($this->checkout->revisit) {
@@ -388,7 +388,7 @@ 
     public function reg_form_name()
     {
         if (empty($this->_reg_form_name)) {
-            $this->set_reg_form_name('ee-spco-' . $this->slug() . '-reg-step-form');
+            $this->set_reg_form_name('ee-spco-'.$this->slug().'-reg-step-form');
         }
         return $this->_reg_form_name;
     }
@@ -412,7 +412,7 @@ 
     public function reg_step_url($action = '')
     {
         $query_args = ['step' => $this->slug()];
-        if (! empty($action)) {
+        if ( ! empty($action)) {
             $query_args['action'] = $action;
         }
         // final step has no display
@@ -442,12 +442,12 @@ 
             return new EE_Form_Section_Proper(
                 [
                     'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                    'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
+                    'html_id'         => 'ee-'.$this->slug().'-hidden-inputs',
                     'subsections'     => [
                         'next_step' => new EE_Fixed_Hidden_Input(
                             [
                                 'html_name' => 'next_step',
-                                'html_id'   => 'spco-' . $this->slug() . '-next-step',
+                                'html_id'   => 'spco-'.$this->slug().'-next-step',
                                 'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
                                     ? $this->checkout->next_step->slug()
                                     : '',
@@ -461,12 +461,12 @@ 
         return new EE_Form_Section_Proper(
             [
                 'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
+                'html_id'         => 'ee-'.$this->slug().'-hidden-inputs',
                 'subsections'     => [
                     'action'         => new EE_Fixed_Hidden_Input(
                         [
                             'html_name' => 'action',
-                            'html_id'   => 'spco-' . $this->slug() . '-action',
+                            'html_id'   => 'spco-'.$this->slug().'-action',
                             'default'   => apply_filters(
                                 'FHEE__EE_SPCO_Reg_Step__reg_step_hidden_inputs__default_form_action',
                                 empty($this->checkout->reg_url_link)
@@ -479,7 +479,7 @@ 
                     'next_step'      => new EE_Fixed_Hidden_Input(
                         [
                             'html_name' => 'next_step',
-                            'html_id'   => 'spco-' . $this->slug() . '-next-step',
+                            'html_id'   => 'spco-'.$this->slug().'-next-step',
                             'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
                                 ? $this->checkout->next_step->slug()
                                 : '',
@@ -513,7 +513,7 @@ 
      */
     public function generate_reg_form_for_actions($actions = [])
     {
-        $actions                           = array_merge(
+        $actions = array_merge(
             [
                 'generate_reg_form',
                 'display_spco_reg_step',
@@ -556,7 +556,7 @@ 
      */
     public function reg_step_submit_button()
     {
-        if (! $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
+        if ( ! $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
             return '';
         }
         ob_start();
@@ -570,18 +570,18 @@ 
         // generate submit button
         $submit_btn = new EE_Submit_Input(
             [
-                'html_name'             => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
-                'html_id'               => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
+                'html_name'             => 'spco-go-to-step-'.$this->checkout->next_step->slug(),
+                'html_id'               => 'spco-go-to-step-'.$this->checkout->next_step->slug(),
                 'html_class'            => 'spco-next-step-btn',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
+                'other_html_attributes' => ' rel="'.$this->slug().'"',
                 'default'               => $this->submit_button_text(),
             ]
         );
         $submit_btn->set_button_css_attributes(true, 'large');
         $submit_btn_html = $submit_btn->get_html_for_input();
-        $html            .= EEH_HTML::div(
+        $html .= EEH_HTML::div(
             apply_filters('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', $submit_btn_html, $this),
-            'spco-' . $this->slug() . '-whats-next-buttons-dv',
+            'spco-'.$this->slug().'-whats-next-buttons-dv',
             'spco-whats-next-buttons'
         );
         return $html;

Indentation +653 added lines, -653 removed lines

@@ -13,657 +13,657 @@
  */
 abstract class EE_SPCO_Reg_Step
 {
-    /**
-     *    $_completed - TRUE if this step has fully completed it's duties
-     *
-     * @access protected
-     * @type bool $_completed
-     */
-    protected $_completed = false;
-
-    /**
-     *    $_is_current_step - TRUE if this is the current step
-     *
-     * @access protected
-     * @type bool $_is_current_step
-     */
-    protected $_is_current_step = false;
-
-    /**
-     *    $_order - when the reg step should be run relative to other steps
-     *
-     * @access protected
-     * @type int $_template
-     */
-    protected $_order = 0;
-
-    /**
-     *    $_slug - URL param for this step
-     *
-     * @access protected
-     * @type string $_slug
-     */
-    protected $_slug;
-
-    /**
-     *    $_name - Step Name - translatable string
-     *
-     * @access protected
-     * @type string $_slug
-     */
-    protected $_name;
-
-    /**
-     *    $_submit_button_text - translatable string that appears on this step's submit button
-     *
-     * @access protected
-     * @type string $_slug
-     */
-    protected $_submit_button_text;
-
-    /**
-     *    $_template - template name
-     *
-     * @access protected
-     * @type string $_template
-     */
-    protected $_template;
-
-    /**
-     *    $_reg_form_name - the form input name and id attribute
-     *
-     * @access protected
-     * @var string $_reg_form_name
-     */
-    protected $_reg_form_name;
-
-    /**
-     *    $_success_message - text to display upon successful form submission
-     *
-     * @access private
-     * @var string $_success_message
-     */
-    protected $_success_message;
-
-    /**
-     *    $_instructions - a brief description of how to complete the reg step.
-     *    Usually displayed in conjunction with the previous step's success message.
-     *
-     * @access private
-     * @var string $_instructions
-     */
-    protected $_instructions;
-
-    /**
-     *    $_valid_data - the normalized and validated data for this step
-     *
-     * @access public
-     * @var array $_valid_data
-     */
-    protected $_valid_data = [];
-
-    /**
-     *    $reg_form - the registration form for this step
-     *
-     * @access public
-     * @var EE_Form_Section_Proper $reg_form
-     */
-    public $reg_form;
-
-    /**
-     *    $checkout - EE_Checkout object for handling the properties of the current checkout process
-     *
-     * @access public
-     * @var EE_Checkout $checkout
-     */
-    public $checkout;
-
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
-
-
-    /**
-     * @return void
-     */
-    abstract public function translate_js_strings();
-
-
-    /**
-     * @return void
-     */
-    abstract public function enqueue_styles_and_scripts();
-
-
-    /**
-     * @return boolean
-     */
-    abstract public function initialize_reg_step();
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     */
-    abstract public function generate_reg_form();
-
-
-    /**
-     * @return boolean
-     */
-    abstract public function process_reg_step();
-
-
-    /**
-     * @return boolean
-     */
-    abstract public function update_reg_step();
-
-
-    /**
-     * @return boolean
-     */
-    public function completed()
-    {
-        return $this->_completed;
-    }
-
-
-    /**
-     * set_completed - toggles $_completed to TRUE
-     */
-    public function set_completed()
-    {
-        // DEBUG LOG
-        // $this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
-        $this->_completed = apply_filters('FHEE__EE_SPCO_Reg_Step__set_completed___completed', true, $this);
-    }
-
-
-    /**
-     * set_completed - toggles $_completed to FALSE
-     */
-    public function set_not_completed()
-    {
-        $this->_completed = false;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function name()
-    {
-        return $this->_name;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->_slug;
-    }
-
-
-    /**
-     * submit_button_text
-     * the text that appears on the reg step form submit button
-     *
-     * @return string
-     */
-    public function submit_button_text()
-    {
-        return $this->_submit_button_text;
-    }
-
-
-    /**
-     * set_submit_button_text
-     * sets the text that appears on the reg step form submit button
-     *
-     * @param string $submit_button_text
-     */
-    public function set_submit_button_text($submit_button_text = '')
-    {
-        if (! empty($submit_button_text)) {
-            $this->_submit_button_text = $submit_button_text;
-        } elseif ($this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
-            if ($this->checkout->revisit) {
-                $this->_submit_button_text = sprintf(
-                    esc_html__('Update %s', 'event_espresso'),
-                    $this->checkout->current_step->name()
-                );
-            } else {
-                $this->_submit_button_text = sprintf(
-                    esc_html__('Proceed to %s', 'event_espresso'),
-                    $this->checkout->next_step->name()
-                );
-            }
-        }
-        // filters the submit button text
-        $this->_submit_button_text = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
-            $this->_submit_button_text,
-            $this->checkout
-        );
-    }
-
-
-    /**
-     * @param boolean $is_current_step
-     */
-    public function set_is_current_step($is_current_step)
-    {
-        $this->_is_current_step = $is_current_step;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function is_current_step()
-    {
-        return $this->_is_current_step;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function is_final_step()
-    {
-        return $this instanceof EE_SPCO_Reg_Step_Finalize_Registration;
-    }
-
-
-    /**
-     * @param int $order
-     */
-    public function set_order($order)
-    {
-        $this->_order = $order;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function order()
-    {
-        return $this->_order;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function template(): string
-    {
-        return $this->_template;
-    }
-
-
-    /**
-     * @param string $template
-     */
-    public function setTemplate(string $template): void
-    {
-        $this->_template = $template;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function success_message()
-    {
-        return $this->_success_message;
-    }
-
-
-    /**
-     * _set_success_message
-     *
-     * @param string $success_message
-     */
-    protected function _set_success_message($success_message)
-    {
-        $this->_success_message = $success_message;
-    }
-
-
-    /**
-     * _reset_success_message
-     *
-     * @return void
-     */
-    protected function _reset_success_message()
-    {
-        $this->_success_message = '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function _instructions()
-    {
-        return $this->_instructions;
-    }
-
-
-    /**
-     * @param string $instructions
-     */
-    public function set_instructions($instructions)
-    {
-        $this->_instructions = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step__set_instructions__instructions',
-            $instructions,
-            $this
-        );
-    }
-
-
-    /**
-     * @param array $valid_data
-     */
-    public function set_valid_data($valid_data)
-    {
-        $this->_valid_data = $valid_data;
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function valid_data()
-    {
-        if (empty($this->_valid_data)) {
-            $this->_valid_data = $this->reg_form->valid_data();
-        }
-        return $this->_valid_data;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function reg_form_name()
-    {
-        if (empty($this->_reg_form_name)) {
-            $this->set_reg_form_name('ee-spco-' . $this->slug() . '-reg-step-form');
-        }
-        return $this->_reg_form_name;
-    }
-
-
-    /**
-     * @param string $reg_form_name
-     */
-    protected function set_reg_form_name($reg_form_name)
-    {
-        $this->_reg_form_name = $reg_form_name;
-    }
-
-
-    /**
-     * reg_step_url
-     *
-     * @param string $action
-     * @return string
-     */
-    public function reg_step_url($action = '')
-    {
-        $query_args = ['step' => $this->slug()];
-        if (! empty($action)) {
-            $query_args['action'] = $action;
-        }
-        // final step has no display
-        if ($this instanceof EE_SPCO_Reg_Step_Finalize_Registration && $action === 'display_spco_reg_step') {
-            $query_args['action'] = 'process_reg_step';
-        }
-        if ($this->checkout->revisit) {
-            $query_args['revisit'] = true;
-        }
-        if ($this->checkout->reg_url_link) {
-            $query_args['e_reg_url_link'] = $this->checkout->reg_url_link;
-        }
-        return add_query_arg($query_args, $this->checkout->reg_page_base_url);
-    }
-
-
-    /**
-     * creates the default hidden inputs section
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    public function reg_step_hidden_inputs()
-    {
-        // hidden inputs for admin registrations
-        if ($this->checkout->admin_request) {
-            return new EE_Form_Section_Proper(
-                [
-                    'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                    'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
-                    'subsections'     => [
-                        'next_step' => new EE_Fixed_Hidden_Input(
-                            [
-                                'html_name' => 'next_step',
-                                'html_id'   => 'spco-' . $this->slug() . '-next-step',
-                                'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
-                                    ? $this->checkout->next_step->slug()
-                                    : '',
-                            ]
-                        ),
-                    ],
-                ]
-            );
-        }
-        // hidden inputs for frontend registrations
-        return new EE_Form_Section_Proper(
-            [
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
-                'subsections'     => [
-                    'action'         => new EE_Fixed_Hidden_Input(
-                        [
-                            'html_name' => 'action',
-                            'html_id'   => 'spco-' . $this->slug() . '-action',
-                            'default'   => apply_filters(
-                                'FHEE__EE_SPCO_Reg_Step__reg_step_hidden_inputs__default_form_action',
-                                empty($this->checkout->reg_url_link)
-                                    ? 'process_reg_step'
-                                    : 'update_reg_step',
-                                $this
-                            ),
-                        ]
-                    ),
-                    'next_step'      => new EE_Fixed_Hidden_Input(
-                        [
-                            'html_name' => 'next_step',
-                            'html_id'   => 'spco-' . $this->slug() . '-next-step',
-                            'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
-                                ? $this->checkout->next_step->slug()
-                                : '',
-                        ]
-                    ),
-                    'e_reg_url_link' => new EE_Fixed_Hidden_Input(
-                        [
-                            'html_name' => 'e_reg_url_link',
-                            'html_id'   => 'spco-reg_url_link',
-                            'default'   => $this->checkout->reg_url_link,
-                        ]
-                    ),
-                    'revisit'        => new EE_Fixed_Hidden_Input(
-                        [
-                            'html_name' => 'revisit',
-                            'html_id'   => 'spco-revisit',
-                            'default'   => $this->checkout->revisit,
-                        ]
-                    ),
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * generate_reg_form_for_actions
-     *
-     * @param array $actions
-     * @return void
-     */
-    public function generate_reg_form_for_actions($actions = [])
-    {
-        $actions                           = array_merge(
-            [
-                'generate_reg_form',
-                'display_spco_reg_step',
-                'process_reg_step',
-                'update_reg_step',
-            ],
-            $actions
-        );
-        $this->checkout->generate_reg_form = in_array($this->checkout->action, $actions, true);
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function display_reg_form()
-    {
-        $html = '';
-        if ($this->reg_form instanceof EE_Form_Section_Proper) {
-            do_action('AHEE__EE_SPCO_Reg_Step__display_reg_form__reg_form', $this->reg_form, $this);
-            $html .= ! $this->checkout->admin_request ? $this->reg_form->form_open($this->reg_step_url()) : '';
-            if ($this->request->isAjax()) {
-                $this->reg_form->localize_validation_rules();
-                $this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
-            }
-            $html .= $this->reg_form->get_html();
-            $html .= ! $this->checkout->admin_request ? $this->reg_step_submit_button() : '';
-            $html .= ! $this->checkout->admin_request ? $this->reg_form->form_close() : '';
-        }
-        return $html;
-    }
-
-
-    /**
-     * div_class - returns nothing for current step, but a css class of "hidden" for others
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function reg_step_submit_button()
-    {
-        if (! $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
-            return '';
-        }
-        ob_start();
-        do_action(
-            'AHEE__before_spco_whats_next_buttons',
-            $this->slug(),
-            $this->checkout->next_step->slug(),
-            $this->checkout
-        );
-        $html = ob_get_clean();
-        // generate submit button
-        $submit_btn = new EE_Submit_Input(
-            [
-                'html_name'             => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
-                'html_id'               => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
-                'html_class'            => 'spco-next-step-btn',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
-                'default'               => $this->submit_button_text(),
-            ]
-        );
-        $submit_btn->set_button_css_attributes(true, 'large');
-        $submit_btn_html = $submit_btn->get_html_for_input();
-        $html            .= EEH_HTML::div(
-            apply_filters('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', $submit_btn_html, $this),
-            'spco-' . $this->slug() . '-whats-next-buttons-dv',
-            'spco-whats-next-buttons'
-        );
-        return $html;
-    }
-
-
-    /**
-     * div_class - returns nothing for current step, but a css class of "hidden" for others
-     *
-     * @return string
-     */
-    public function div_class()
-    {
-        return $this->is_current_step() ? '' : ' hidden';
-    }
-
-
-    /**
-     * div_class - returns  a css class of "hidden" for current step, but nothing for others
-     *
-     * @return string
-     */
-    public function edit_lnk_url()
-    {
-        return add_query_arg(['step' => $this->slug()], $this->checkout->reg_page_base_url);
-    }
-
-
-    /**
-     * div_class - returns  a css class of "hidden" for current step, but nothing for others
-     *
-     * @return string
-     */
-    public function edit_link_class()
-    {
-        return $this->is_current_step() ? ' hidden' : '';
-    }
-
-
-    /**
-     * update_checkout with changes that have been made to the cart
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function update_checkout()
-    {
-        // grab the cart grand total and reset TXN total
-        $this->checkout->transaction->set_total($this->checkout->cart->get_cart_grand_total());
-        $this->checkout->stash_transaction_and_checkout();
-    }
-
-
-    /**
-     *    __sleep
-     * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon
-     * serialization EE_Checkout will handle the reimplementation of itself upon waking, but we won't bother with the
-     * reg form, because if needed, it will be regenerated anyways
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        // remove the reg form and the checkout
-        return array_diff(array_keys(get_object_vars($this)), ['reg_form', 'checkout']);
-    }
-
-
-    /**
-     * @param RequestInterface $request
-     */
-    public function setRequest(RequestInterface $request)
-    {
-        $this->request = $request;
-    }
+	/**
+	 *    $_completed - TRUE if this step has fully completed it's duties
+	 *
+	 * @access protected
+	 * @type bool $_completed
+	 */
+	protected $_completed = false;
+
+	/**
+	 *    $_is_current_step - TRUE if this is the current step
+	 *
+	 * @access protected
+	 * @type bool $_is_current_step
+	 */
+	protected $_is_current_step = false;
+
+	/**
+	 *    $_order - when the reg step should be run relative to other steps
+	 *
+	 * @access protected
+	 * @type int $_template
+	 */
+	protected $_order = 0;
+
+	/**
+	 *    $_slug - URL param for this step
+	 *
+	 * @access protected
+	 * @type string $_slug
+	 */
+	protected $_slug;
+
+	/**
+	 *    $_name - Step Name - translatable string
+	 *
+	 * @access protected
+	 * @type string $_slug
+	 */
+	protected $_name;
+
+	/**
+	 *    $_submit_button_text - translatable string that appears on this step's submit button
+	 *
+	 * @access protected
+	 * @type string $_slug
+	 */
+	protected $_submit_button_text;
+
+	/**
+	 *    $_template - template name
+	 *
+	 * @access protected
+	 * @type string $_template
+	 */
+	protected $_template;
+
+	/**
+	 *    $_reg_form_name - the form input name and id attribute
+	 *
+	 * @access protected
+	 * @var string $_reg_form_name
+	 */
+	protected $_reg_form_name;
+
+	/**
+	 *    $_success_message - text to display upon successful form submission
+	 *
+	 * @access private
+	 * @var string $_success_message
+	 */
+	protected $_success_message;
+
+	/**
+	 *    $_instructions - a brief description of how to complete the reg step.
+	 *    Usually displayed in conjunction with the previous step's success message.
+	 *
+	 * @access private
+	 * @var string $_instructions
+	 */
+	protected $_instructions;
+
+	/**
+	 *    $_valid_data - the normalized and validated data for this step
+	 *
+	 * @access public
+	 * @var array $_valid_data
+	 */
+	protected $_valid_data = [];
+
+	/**
+	 *    $reg_form - the registration form for this step
+	 *
+	 * @access public
+	 * @var EE_Form_Section_Proper $reg_form
+	 */
+	public $reg_form;
+
+	/**
+	 *    $checkout - EE_Checkout object for handling the properties of the current checkout process
+	 *
+	 * @access public
+	 * @var EE_Checkout $checkout
+	 */
+	public $checkout;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
+
+
+	/**
+	 * @return void
+	 */
+	abstract public function translate_js_strings();
+
+
+	/**
+	 * @return void
+	 */
+	abstract public function enqueue_styles_and_scripts();
+
+
+	/**
+	 * @return boolean
+	 */
+	abstract public function initialize_reg_step();
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 */
+	abstract public function generate_reg_form();
+
+
+	/**
+	 * @return boolean
+	 */
+	abstract public function process_reg_step();
+
+
+	/**
+	 * @return boolean
+	 */
+	abstract public function update_reg_step();
+
+
+	/**
+	 * @return boolean
+	 */
+	public function completed()
+	{
+		return $this->_completed;
+	}
+
+
+	/**
+	 * set_completed - toggles $_completed to TRUE
+	 */
+	public function set_completed()
+	{
+		// DEBUG LOG
+		// $this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
+		$this->_completed = apply_filters('FHEE__EE_SPCO_Reg_Step__set_completed___completed', true, $this);
+	}
+
+
+	/**
+	 * set_completed - toggles $_completed to FALSE
+	 */
+	public function set_not_completed()
+	{
+		$this->_completed = false;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function name()
+	{
+		return $this->_name;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->_slug;
+	}
+
+
+	/**
+	 * submit_button_text
+	 * the text that appears on the reg step form submit button
+	 *
+	 * @return string
+	 */
+	public function submit_button_text()
+	{
+		return $this->_submit_button_text;
+	}
+
+
+	/**
+	 * set_submit_button_text
+	 * sets the text that appears on the reg step form submit button
+	 *
+	 * @param string $submit_button_text
+	 */
+	public function set_submit_button_text($submit_button_text = '')
+	{
+		if (! empty($submit_button_text)) {
+			$this->_submit_button_text = $submit_button_text;
+		} elseif ($this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
+			if ($this->checkout->revisit) {
+				$this->_submit_button_text = sprintf(
+					esc_html__('Update %s', 'event_espresso'),
+					$this->checkout->current_step->name()
+				);
+			} else {
+				$this->_submit_button_text = sprintf(
+					esc_html__('Proceed to %s', 'event_espresso'),
+					$this->checkout->next_step->name()
+				);
+			}
+		}
+		// filters the submit button text
+		$this->_submit_button_text = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
+			$this->_submit_button_text,
+			$this->checkout
+		);
+	}
+
+
+	/**
+	 * @param boolean $is_current_step
+	 */
+	public function set_is_current_step($is_current_step)
+	{
+		$this->_is_current_step = $is_current_step;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function is_current_step()
+	{
+		return $this->_is_current_step;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function is_final_step()
+	{
+		return $this instanceof EE_SPCO_Reg_Step_Finalize_Registration;
+	}
+
+
+	/**
+	 * @param int $order
+	 */
+	public function set_order($order)
+	{
+		$this->_order = $order;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function order()
+	{
+		return $this->_order;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function template(): string
+	{
+		return $this->_template;
+	}
+
+
+	/**
+	 * @param string $template
+	 */
+	public function setTemplate(string $template): void
+	{
+		$this->_template = $template;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function success_message()
+	{
+		return $this->_success_message;
+	}
+
+
+	/**
+	 * _set_success_message
+	 *
+	 * @param string $success_message
+	 */
+	protected function _set_success_message($success_message)
+	{
+		$this->_success_message = $success_message;
+	}
+
+
+	/**
+	 * _reset_success_message
+	 *
+	 * @return void
+	 */
+	protected function _reset_success_message()
+	{
+		$this->_success_message = '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function _instructions()
+	{
+		return $this->_instructions;
+	}
+
+
+	/**
+	 * @param string $instructions
+	 */
+	public function set_instructions($instructions)
+	{
+		$this->_instructions = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step__set_instructions__instructions',
+			$instructions,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param array $valid_data
+	 */
+	public function set_valid_data($valid_data)
+	{
+		$this->_valid_data = $valid_data;
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function valid_data()
+	{
+		if (empty($this->_valid_data)) {
+			$this->_valid_data = $this->reg_form->valid_data();
+		}
+		return $this->_valid_data;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function reg_form_name()
+	{
+		if (empty($this->_reg_form_name)) {
+			$this->set_reg_form_name('ee-spco-' . $this->slug() . '-reg-step-form');
+		}
+		return $this->_reg_form_name;
+	}
+
+
+	/**
+	 * @param string $reg_form_name
+	 */
+	protected function set_reg_form_name($reg_form_name)
+	{
+		$this->_reg_form_name = $reg_form_name;
+	}
+
+
+	/**
+	 * reg_step_url
+	 *
+	 * @param string $action
+	 * @return string
+	 */
+	public function reg_step_url($action = '')
+	{
+		$query_args = ['step' => $this->slug()];
+		if (! empty($action)) {
+			$query_args['action'] = $action;
+		}
+		// final step has no display
+		if ($this instanceof EE_SPCO_Reg_Step_Finalize_Registration && $action === 'display_spco_reg_step') {
+			$query_args['action'] = 'process_reg_step';
+		}
+		if ($this->checkout->revisit) {
+			$query_args['revisit'] = true;
+		}
+		if ($this->checkout->reg_url_link) {
+			$query_args['e_reg_url_link'] = $this->checkout->reg_url_link;
+		}
+		return add_query_arg($query_args, $this->checkout->reg_page_base_url);
+	}
+
+
+	/**
+	 * creates the default hidden inputs section
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	public function reg_step_hidden_inputs()
+	{
+		// hidden inputs for admin registrations
+		if ($this->checkout->admin_request) {
+			return new EE_Form_Section_Proper(
+				[
+					'layout_strategy' => new EE_Div_Per_Section_Layout(),
+					'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
+					'subsections'     => [
+						'next_step' => new EE_Fixed_Hidden_Input(
+							[
+								'html_name' => 'next_step',
+								'html_id'   => 'spco-' . $this->slug() . '-next-step',
+								'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
+									? $this->checkout->next_step->slug()
+									: '',
+							]
+						),
+					],
+				]
+			);
+		}
+		// hidden inputs for frontend registrations
+		return new EE_Form_Section_Proper(
+			[
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+				'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
+				'subsections'     => [
+					'action'         => new EE_Fixed_Hidden_Input(
+						[
+							'html_name' => 'action',
+							'html_id'   => 'spco-' . $this->slug() . '-action',
+							'default'   => apply_filters(
+								'FHEE__EE_SPCO_Reg_Step__reg_step_hidden_inputs__default_form_action',
+								empty($this->checkout->reg_url_link)
+									? 'process_reg_step'
+									: 'update_reg_step',
+								$this
+							),
+						]
+					),
+					'next_step'      => new EE_Fixed_Hidden_Input(
+						[
+							'html_name' => 'next_step',
+							'html_id'   => 'spco-' . $this->slug() . '-next-step',
+							'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
+								? $this->checkout->next_step->slug()
+								: '',
+						]
+					),
+					'e_reg_url_link' => new EE_Fixed_Hidden_Input(
+						[
+							'html_name' => 'e_reg_url_link',
+							'html_id'   => 'spco-reg_url_link',
+							'default'   => $this->checkout->reg_url_link,
+						]
+					),
+					'revisit'        => new EE_Fixed_Hidden_Input(
+						[
+							'html_name' => 'revisit',
+							'html_id'   => 'spco-revisit',
+							'default'   => $this->checkout->revisit,
+						]
+					),
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * generate_reg_form_for_actions
+	 *
+	 * @param array $actions
+	 * @return void
+	 */
+	public function generate_reg_form_for_actions($actions = [])
+	{
+		$actions                           = array_merge(
+			[
+				'generate_reg_form',
+				'display_spco_reg_step',
+				'process_reg_step',
+				'update_reg_step',
+			],
+			$actions
+		);
+		$this->checkout->generate_reg_form = in_array($this->checkout->action, $actions, true);
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function display_reg_form()
+	{
+		$html = '';
+		if ($this->reg_form instanceof EE_Form_Section_Proper) {
+			do_action('AHEE__EE_SPCO_Reg_Step__display_reg_form__reg_form', $this->reg_form, $this);
+			$html .= ! $this->checkout->admin_request ? $this->reg_form->form_open($this->reg_step_url()) : '';
+			if ($this->request->isAjax()) {
+				$this->reg_form->localize_validation_rules();
+				$this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
+			}
+			$html .= $this->reg_form->get_html();
+			$html .= ! $this->checkout->admin_request ? $this->reg_step_submit_button() : '';
+			$html .= ! $this->checkout->admin_request ? $this->reg_form->form_close() : '';
+		}
+		return $html;
+	}
+
+
+	/**
+	 * div_class - returns nothing for current step, but a css class of "hidden" for others
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function reg_step_submit_button()
+	{
+		if (! $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
+			return '';
+		}
+		ob_start();
+		do_action(
+			'AHEE__before_spco_whats_next_buttons',
+			$this->slug(),
+			$this->checkout->next_step->slug(),
+			$this->checkout
+		);
+		$html = ob_get_clean();
+		// generate submit button
+		$submit_btn = new EE_Submit_Input(
+			[
+				'html_name'             => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
+				'html_id'               => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
+				'html_class'            => 'spco-next-step-btn',
+				'other_html_attributes' => ' rel="' . $this->slug() . '"',
+				'default'               => $this->submit_button_text(),
+			]
+		);
+		$submit_btn->set_button_css_attributes(true, 'large');
+		$submit_btn_html = $submit_btn->get_html_for_input();
+		$html            .= EEH_HTML::div(
+			apply_filters('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', $submit_btn_html, $this),
+			'spco-' . $this->slug() . '-whats-next-buttons-dv',
+			'spco-whats-next-buttons'
+		);
+		return $html;
+	}
+
+
+	/**
+	 * div_class - returns nothing for current step, but a css class of "hidden" for others
+	 *
+	 * @return string
+	 */
+	public function div_class()
+	{
+		return $this->is_current_step() ? '' : ' hidden';
+	}
+
+
+	/**
+	 * div_class - returns  a css class of "hidden" for current step, but nothing for others
+	 *
+	 * @return string
+	 */
+	public function edit_lnk_url()
+	{
+		return add_query_arg(['step' => $this->slug()], $this->checkout->reg_page_base_url);
+	}
+
+
+	/**
+	 * div_class - returns  a css class of "hidden" for current step, but nothing for others
+	 *
+	 * @return string
+	 */
+	public function edit_link_class()
+	{
+		return $this->is_current_step() ? ' hidden' : '';
+	}
+
+
+	/**
+	 * update_checkout with changes that have been made to the cart
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function update_checkout()
+	{
+		// grab the cart grand total and reset TXN total
+		$this->checkout->transaction->set_total($this->checkout->cart->get_cart_grand_total());
+		$this->checkout->stash_transaction_and_checkout();
+	}
+
+
+	/**
+	 *    __sleep
+	 * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon
+	 * serialization EE_Checkout will handle the reimplementation of itself upon waking, but we won't bother with the
+	 * reg form, because if needed, it will be regenerated anyways
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		// remove the reg form and the checkout
+		return array_diff(array_keys(get_object_vars($this)), ['reg_form', 'checkout']);
+	}
+
+
+	/**
+	 * @param RequestInterface $request
+	 */
+	public function setRequest(RequestInterface $request)
+	{
+		$this->request = $request;
+	}
 }

core/services/request/files/FilesDataHandler.php

Indentation +251 added lines, -251 removed lines

@@ -40,279 +40,279 @@
  */
 class FilesDataHandler
 {
-    /**
-     * @var Request
-     */
-    protected $request;
+	/**
+	 * @var Request
+	 */
+	protected $request;
 
-    /**
-     * @var CollectionInterface | FileSubmissionInterface[]
-     */
-    protected $file_objects;
+	/**
+	 * @var CollectionInterface | FileSubmissionInterface[]
+	 */
+	protected $file_objects;
 
-    /**
-     * @var bool
-     */
-    protected $initialized = false;
+	/**
+	 * @var bool
+	 */
+	protected $initialized = false;
 
 
-    /**
-     * FilesDataHandler constructor.
-     *
-     * @param Request $request
-     */
-    public function __construct(Request $request)
-    {
-        $this->request = $request;
-    }
+	/**
+	 * FilesDataHandler constructor.
+	 *
+	 * @param Request $request
+	 */
+	public function __construct(Request $request)
+	{
+		$this->request = $request;
+	}
 
 
-    /**
-     * @return CollectionInterface | FileSubmissionInterface[]
-     * @throws UnexpectedValueException
-     * @throws InvalidArgumentException
-     * @since 4.9.80.p
-     */
-    protected function getFileObjects()
-    {
-        $this->initialize();
-        return $this->file_objects;
-    }
+	/**
+	 * @return CollectionInterface | FileSubmissionInterface[]
+	 * @throws UnexpectedValueException
+	 * @throws InvalidArgumentException
+	 * @since 4.9.80.p
+	 */
+	protected function getFileObjects()
+	{
+		$this->initialize();
+		return $this->file_objects;
+	}
 
 
-    /**
-     * Sets up the file objects from the request's $_FILES data.
-     *
-     * @throws UnexpectedValueException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @since 4.9.80.p
-     */
-    protected function initialize()
-    {
-        if ($this->initialized) {
-            return;
-        }
-        $this->file_objects = new Collection(
-        // collection interface
-            'EventEspresso\core\services\request\files\FileSubmissionInterface',
-            // collection name
-            'submitted_files'
-        );
-        $files_raw_data     = $this->request->filesParams();
-        if (empty($files_raw_data)) {
-            return;
-        }
-        if ($this->isStrangeFilesArray($files_raw_data)) {
-            $data = $this->fixFilesDataArray($files_raw_data);
-        } else {
-            $data = $files_raw_data;
-        }
-        $this->createFileObjects($data);
-        $this->initialized = true;
-    }
+	/**
+	 * Sets up the file objects from the request's $_FILES data.
+	 *
+	 * @throws UnexpectedValueException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @since 4.9.80.p
+	 */
+	protected function initialize()
+	{
+		if ($this->initialized) {
+			return;
+		}
+		$this->file_objects = new Collection(
+		// collection interface
+			'EventEspresso\core\services\request\files\FileSubmissionInterface',
+			// collection name
+			'submitted_files'
+		);
+		$files_raw_data     = $this->request->filesParams();
+		if (empty($files_raw_data)) {
+			return;
+		}
+		if ($this->isStrangeFilesArray($files_raw_data)) {
+			$data = $this->fixFilesDataArray($files_raw_data);
+		} else {
+			$data = $files_raw_data;
+		}
+		$this->createFileObjects($data);
+		$this->initialized = true;
+	}
 
 
-    /**
-     * Detects if $_FILES is a weird multi-dimensional array that needs fixing or not.
-     *
-     * @param $files_data
-     * @return bool
-     * @throws UnexpectedValueException
-     * @since 4.9.80.p
-     */
-    protected function isStrangeFilesArray($files_data)
-    {
-        if (! is_array($files_data)) {
-            throw new UnexpectedValueException(
-                sprintf(
-                    esc_html__(
-                        'Unexpected PHP $_FILES data format. "%1$s" was expected to be an array.',
-                        'event_espresso'
-                    ),
-                    (string) $files_data
-                )
-            );
-        }
-        $first_value = reset($files_data);
-        if (! is_array($first_value)) {
-            throw new UnexpectedValueException(
-                sprintf(
-                    esc_html__(
-                        'Unexpected PHP $_FILES data format. "%1$s" was expected to be an array.',
-                        'event_espresso'
-                    ),
-                    (string) $first_value
-                )
-            );
-        }
-        $first_sub_array_item = reset($first_value);
-        if (is_array($first_sub_array_item)) {
-            // not just a 2d array
-            return true;
-        }
-        // yep, just 2d array
-        return false;
-    }
+	/**
+	 * Detects if $_FILES is a weird multi-dimensional array that needs fixing or not.
+	 *
+	 * @param $files_data
+	 * @return bool
+	 * @throws UnexpectedValueException
+	 * @since 4.9.80.p
+	 */
+	protected function isStrangeFilesArray($files_data)
+	{
+		if (! is_array($files_data)) {
+			throw new UnexpectedValueException(
+				sprintf(
+					esc_html__(
+						'Unexpected PHP $_FILES data format. "%1$s" was expected to be an array.',
+						'event_espresso'
+					),
+					(string) $files_data
+				)
+			);
+		}
+		$first_value = reset($files_data);
+		if (! is_array($first_value)) {
+			throw new UnexpectedValueException(
+				sprintf(
+					esc_html__(
+						'Unexpected PHP $_FILES data format. "%1$s" was expected to be an array.',
+						'event_espresso'
+					),
+					(string) $first_value
+				)
+			);
+		}
+		$first_sub_array_item = reset($first_value);
+		if (is_array($first_sub_array_item)) {
+			// not just a 2d array
+			return true;
+		}
+		// yep, just 2d array
+		return false;
+	}
 
 
-    /**
-     * Takes into account that $_FILES does a weird thing when you have hierarchical form names (eg `<input type="file"
-     * name="my[hierarchical][form]">`): it leaves the top-level form part alone, but replaces the SECOND part with
-     * "name", "size", "tmp_name", etc. So that file's data is located at "my[name][hierarchical][form]",
-     * "my[size][hierarchical][form]", "my[tmp_name][hierarchical][form]", etc. It's really weird.
-     *
-     * @param $files_data
-     * @return array
-     * @since 4.9.80.p
-     */
-    protected function fixFilesDataArray($files_data)
-    {
-        $sane_files_array = [];
-        foreach ($files_data as $top_level_name => $top_level_children) {
-            $sub_array                           = [];
-            $sane_files_array[ $top_level_name ] = [];
-            foreach ($top_level_children as $file_data_part => $second_level_children) {
-                foreach ($second_level_children as $next_level_name => $sub_values) {
-                    $sub_array[ $next_level_name ] = $this->organizeFilesData($sub_values, $file_data_part);
-                }
-                $sane_files_array[ $top_level_name ] = array_replace_recursive(
-                    $sub_array,
-                    $sane_files_array[ $top_level_name ]
-                );
-            }
-        }
-        return $sane_files_array;
-    }
+	/**
+	 * Takes into account that $_FILES does a weird thing when you have hierarchical form names (eg `<input type="file"
+	 * name="my[hierarchical][form]">`): it leaves the top-level form part alone, but replaces the SECOND part with
+	 * "name", "size", "tmp_name", etc. So that file's data is located at "my[name][hierarchical][form]",
+	 * "my[size][hierarchical][form]", "my[tmp_name][hierarchical][form]", etc. It's really weird.
+	 *
+	 * @param $files_data
+	 * @return array
+	 * @since 4.9.80.p
+	 */
+	protected function fixFilesDataArray($files_data)
+	{
+		$sane_files_array = [];
+		foreach ($files_data as $top_level_name => $top_level_children) {
+			$sub_array                           = [];
+			$sane_files_array[ $top_level_name ] = [];
+			foreach ($top_level_children as $file_data_part => $second_level_children) {
+				foreach ($second_level_children as $next_level_name => $sub_values) {
+					$sub_array[ $next_level_name ] = $this->organizeFilesData($sub_values, $file_data_part);
+				}
+				$sane_files_array[ $top_level_name ] = array_replace_recursive(
+					$sub_array,
+					$sane_files_array[ $top_level_name ]
+				);
+			}
+		}
+		return $sane_files_array;
+	}
 
 
-    /**
-     * Recursively explores the array until it finds a leaf node, and tacks `$type` as a final index in front of it.
-     *
-     * @param $data array|string
-     * @param $type 'name', 'tmp_name', 'size', or 'error'
-     * @return array
-     * @since 4.9.80.p
-     */
-    protected function organizeFilesData($data, $type)
-    {
-        if (! is_array($data)) {
-            return [
-                $type => $data,
-            ];
-        }
-        $organized_data = [];
-        foreach ($data as $input_name_part => $sub_inputs_or_value) {
-            if (is_array($sub_inputs_or_value)) {
-                $organized_data[ $input_name_part ] = $this->organizeFilesData($sub_inputs_or_value, $type);
-            } else {
-                $organized_data[ $input_name_part ][ $type ] = $sub_inputs_or_value;
-            }
-        }
-        return $organized_data;
-    }
+	/**
+	 * Recursively explores the array until it finds a leaf node, and tacks `$type` as a final index in front of it.
+	 *
+	 * @param $data array|string
+	 * @param $type 'name', 'tmp_name', 'size', or 'error'
+	 * @return array
+	 * @since 4.9.80.p
+	 */
+	protected function organizeFilesData($data, $type)
+	{
+		if (! is_array($data)) {
+			return [
+				$type => $data,
+			];
+		}
+		$organized_data = [];
+		foreach ($data as $input_name_part => $sub_inputs_or_value) {
+			if (is_array($sub_inputs_or_value)) {
+				$organized_data[ $input_name_part ] = $this->organizeFilesData($sub_inputs_or_value, $type);
+			} else {
+				$organized_data[ $input_name_part ][ $type ] = $sub_inputs_or_value;
+			}
+		}
+		return $organized_data;
+	}
 
 
-    /**
-     * Takes the organized $_FILES array (where all file info is located at the same spot as you'd expect an input
-     * to be in post data, with all the file's data located side-by-side in an array) and creates a
-     * multi-dimensional array of FileSubmissionInterface objects. Stores it in `$this->file_objects`.
-     *
-     * @param array $organized_files   $_FILES but organized like $_POST
-     * @param array $name_parts_so_far for multidimensional HTML form names,
-     * @throws UnexpectedValueException
-     * @throws InvalidArgumentException
-     * @since 4.9.80.p
-     */
-    protected function createFileObjects($organized_files, $name_parts_so_far = [])
-    {
-        if (! is_array($organized_files)) {
-            throw new UnexpectedValueException(
-                sprintf(
-                    esc_html__(
-                        'Unexpected PHP $organized_files data format. "%1$s" was expected to be an array.',
-                        'event_espresso'
-                    ),
-                    (string) $organized_files
-                )
-            );
-        }
-        foreach ($organized_files as $key => $value) {
-            $this_input_name_parts = $name_parts_so_far;
-            array_push(
-                $this_input_name_parts,
-                $key
-            );
-            if (isset($value['name'], $value['tmp_name'], $value['size'])) {
-                $html_name = $this->inputNameFromParts($this_input_name_parts);
-                $this->file_objects->add(
-                    new FileSubmission(
-                        $value['name'],
-                        $value['tmp_name'],
-                        $value['size'],
-                        $value['error']
-                    ),
-                    $html_name
-                );
-            } else {
-                $this->createFileObjects($value, $this_input_name_parts);
-            }
-        }
-    }
+	/**
+	 * Takes the organized $_FILES array (where all file info is located at the same spot as you'd expect an input
+	 * to be in post data, with all the file's data located side-by-side in an array) and creates a
+	 * multi-dimensional array of FileSubmissionInterface objects. Stores it in `$this->file_objects`.
+	 *
+	 * @param array $organized_files   $_FILES but organized like $_POST
+	 * @param array $name_parts_so_far for multidimensional HTML form names,
+	 * @throws UnexpectedValueException
+	 * @throws InvalidArgumentException
+	 * @since 4.9.80.p
+	 */
+	protected function createFileObjects($organized_files, $name_parts_so_far = [])
+	{
+		if (! is_array($organized_files)) {
+			throw new UnexpectedValueException(
+				sprintf(
+					esc_html__(
+						'Unexpected PHP $organized_files data format. "%1$s" was expected to be an array.',
+						'event_espresso'
+					),
+					(string) $organized_files
+				)
+			);
+		}
+		foreach ($organized_files as $key => $value) {
+			$this_input_name_parts = $name_parts_so_far;
+			array_push(
+				$this_input_name_parts,
+				$key
+			);
+			if (isset($value['name'], $value['tmp_name'], $value['size'])) {
+				$html_name = $this->inputNameFromParts($this_input_name_parts);
+				$this->file_objects->add(
+					new FileSubmission(
+						$value['name'],
+						$value['tmp_name'],
+						$value['size'],
+						$value['error']
+					),
+					$html_name
+				);
+			} else {
+				$this->createFileObjects($value, $this_input_name_parts);
+			}
+		}
+	}
 
 
-    /**
-     * Takes the input name parts, like `['my', 'great', 'file', 'input1']`
-     * and returns the HTML name for it, "my[great][file][input1]"
-     *
-     * @throws UnexpectedValueException
-     * @since 4.9.80.p
-     */
-    protected function inputNameFromParts($parts)
-    {
-        if (! is_array($parts)) {
-            throw new UnexpectedValueException(esc_html__('Name parts should be an array.', 'event_espresso'));
-        }
-        $generated_string = '';
-        foreach ($parts as $part) {
-            $part = (string) $part;
-            // wrap all but the first part in []
-            $generated_string .= $generated_string === '' ? $part : '[' . $part . ']';
-        }
-        return $generated_string;
-    }
+	/**
+	 * Takes the input name parts, like `['my', 'great', 'file', 'input1']`
+	 * and returns the HTML name for it, "my[great][file][input1]"
+	 *
+	 * @throws UnexpectedValueException
+	 * @since 4.9.80.p
+	 */
+	protected function inputNameFromParts($parts)
+	{
+		if (! is_array($parts)) {
+			throw new UnexpectedValueException(esc_html__('Name parts should be an array.', 'event_espresso'));
+		}
+		$generated_string = '';
+		foreach ($parts as $part) {
+			$part = (string) $part;
+			// wrap all but the first part in []
+			$generated_string .= $generated_string === '' ? $part : '[' . $part . ']';
+		}
+		return $generated_string;
+	}
 
 
-    /**
-     * Gets the input by the indicated $name_parts.
-     * Eg if you're looking for an input named "my[great][file][input1]", $name_parts
-     * should be `['my', 'great', 'file', 'input1']`.
-     * Alternatively, you could use `FileDataHandler::getFileObject('my[great][file][input1]');`
-     *
-     * @param $name_parts
-     * @return FileSubmissionInterface
-     * @throws UnexpectedValueException
-     * @since 4.9.80.p
-     */
-    public function getFileObjectFromNameParts($name_parts)
-    {
-        return $this->getFileObjects()->get($this->inputNameFromParts($name_parts));
-    }
+	/**
+	 * Gets the input by the indicated $name_parts.
+	 * Eg if you're looking for an input named "my[great][file][input1]", $name_parts
+	 * should be `['my', 'great', 'file', 'input1']`.
+	 * Alternatively, you could use `FileDataHandler::getFileObject('my[great][file][input1]');`
+	 *
+	 * @param $name_parts
+	 * @return FileSubmissionInterface
+	 * @throws UnexpectedValueException
+	 * @since 4.9.80.p
+	 */
+	public function getFileObjectFromNameParts($name_parts)
+	{
+		return $this->getFileObjects()->get($this->inputNameFromParts($name_parts));
+	}
 
 
-    /**
-     * Gets the FileSubmissionInterface corresponding to the HTML name provided.
-     *
-     * @param $html_name
-     * @return mixed
-     * @throws InvalidArgumentException
-     * @throws UnexpectedValueException
-     * @since 4.9.80.p
-     */
-    public function getFileObject($html_name)
-    {
-        return $this->getFileObjects()->get($html_name);
-    }
+	/**
+	 * Gets the FileSubmissionInterface corresponding to the HTML name provided.
+	 *
+	 * @param $html_name
+	 * @return mixed
+	 * @throws InvalidArgumentException
+	 * @throws UnexpectedValueException
+	 * @since 4.9.80.p
+	 */
+	public function getFileObject($html_name)
+	{
+		return $this->getFileObjects()->get($html_name);
+	}
 }
 // End of file FilesDataHandler.php
 // Location: EventEspresso\core\services\request\files/FilesDataHandler.php

Spacing +13 added lines, -13 removed lines

@@ -99,7 +99,7 @@ 
             // collection name
             'submitted_files'
         );
-        $files_raw_data     = $this->request->filesParams();
+        $files_raw_data = $this->request->filesParams();
         if (empty($files_raw_data)) {
             return;
         }
@@ -123,7 +123,7 @@ 
      */
     protected function isStrangeFilesArray($files_data)
     {
-        if (! is_array($files_data)) {
+        if ( ! is_array($files_data)) {
             throw new UnexpectedValueException(
                 sprintf(
                     esc_html__(
@@ -135,7 +135,7 @@ 
             );
         }
         $first_value = reset($files_data);
-        if (! is_array($first_value)) {
+        if ( ! is_array($first_value)) {
             throw new UnexpectedValueException(
                 sprintf(
                     esc_html__(
@@ -171,14 +171,14 @@ 
         $sane_files_array = [];
         foreach ($files_data as $top_level_name => $top_level_children) {
             $sub_array                           = [];
-            $sane_files_array[ $top_level_name ] = [];
+            $sane_files_array[$top_level_name] = [];
             foreach ($top_level_children as $file_data_part => $second_level_children) {
                 foreach ($second_level_children as $next_level_name => $sub_values) {
-                    $sub_array[ $next_level_name ] = $this->organizeFilesData($sub_values, $file_data_part);
+                    $sub_array[$next_level_name] = $this->organizeFilesData($sub_values, $file_data_part);
                 }
-                $sane_files_array[ $top_level_name ] = array_replace_recursive(
+                $sane_files_array[$top_level_name] = array_replace_recursive(
                     $sub_array,
-                    $sane_files_array[ $top_level_name ]
+                    $sane_files_array[$top_level_name]
                 );
             }
         }
@@ -196,7 +196,7 @@ 
      */
     protected function organizeFilesData($data, $type)
     {
-        if (! is_array($data)) {
+        if ( ! is_array($data)) {
             return [
                 $type => $data,
             ];
@@ -204,9 +204,9 @@ 
         $organized_data = [];
         foreach ($data as $input_name_part => $sub_inputs_or_value) {
             if (is_array($sub_inputs_or_value)) {
-                $organized_data[ $input_name_part ] = $this->organizeFilesData($sub_inputs_or_value, $type);
+                $organized_data[$input_name_part] = $this->organizeFilesData($sub_inputs_or_value, $type);
             } else {
-                $organized_data[ $input_name_part ][ $type ] = $sub_inputs_or_value;
+                $organized_data[$input_name_part][$type] = $sub_inputs_or_value;
             }
         }
         return $organized_data;
@@ -226,7 +226,7 @@ 
      */
     protected function createFileObjects($organized_files, $name_parts_so_far = [])
     {
-        if (! is_array($organized_files)) {
+        if ( ! is_array($organized_files)) {
             throw new UnexpectedValueException(
                 sprintf(
                     esc_html__(
@@ -270,14 +270,14 @@ 
      */
     protected function inputNameFromParts($parts)
     {
-        if (! is_array($parts)) {
+        if ( ! is_array($parts)) {
             throw new UnexpectedValueException(esc_html__('Name parts should be an array.', 'event_espresso'));
         }
         $generated_string = '';
         foreach ($parts as $part) {
             $part = (string) $part;
             // wrap all but the first part in []
-            $generated_string .= $generated_string === '' ? $part : '[' . $part . ']';
+            $generated_string .= $generated_string === '' ? $part : '['.$part.']';
         }
         return $generated_string;
     }

core/espresso_definitions.php

Indentation +7 added lines, -7 removed lines

@@ -7,16 +7,16 @@ 
 define('EE_SUPPORT_EMAIL', 'support@eventespresso.com');
 // used to be DIRECTORY_SEPARATOR, but that caused issues on windows
 if (! defined('DS')) {
-    define('DS', '/');
+	define('DS', '/');
 }
 if (! defined('PS')) {
-    define('PS', PATH_SEPARATOR);
+	define('PS', PATH_SEPARATOR);
 }
 if (! defined('SP')) {
-    define('SP', ' ');
+	define('SP', ' ');
 }
 if (! defined('EENL')) {
-    define('EENL', "\n");
+	define('EENL', "\n");
 }
 // define the plugin directory and URL
 define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
@@ -70,7 +70,7 @@ 
 define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages/');
 // check for DOMPDF fonts in uploads
 if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts/')) {
-    define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts/');
+	define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts/');
 }
 // just a handy constant occasionally needed for finding values representing infinity in the DB
 // you're better to use this than its straight value (currently -1) in case you ever
@@ -78,9 +78,9 @@ 
 define('EE_INF_IN_DB', -1);
 define('EE_INF', INF > (float) PHP_INT_MAX ? INF : PHP_INT_MAX);
 if (! defined('EE_DEBUG')) {
-    define('EE_DEBUG', false);
+	define('EE_DEBUG', false);
 }
 // for older WP versions
 if (! defined('MONTH_IN_SECONDS')) {
-    define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
+	define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
 }

Spacing +43 added lines, -43 removed lines

@@ -7,78 +7,78 @@
 define('EE_MIN_PHP_VER_RECOMMENDED', '7.4');
 define('EE_SUPPORT_EMAIL', 'support@eventespresso.com');
 // used to be DIRECTORY_SEPARATOR, but that caused issues on windows
-if (! defined('DS')) {
+if ( ! defined('DS')) {
     define('DS', '/');
 }
-if (! defined('PS')) {
+if ( ! defined('PS')) {
     define('PS', PATH_SEPARATOR);
 }
-if (! defined('SP')) {
+if ( ! defined('SP')) {
     define('SP', ' ');
 }
-if (! defined('EENL')) {
+if ( ! defined('EENL')) {
     define('EENL', "\n");
 }
 // define the plugin directory and URL
 define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
-define('EE_PLUGIN_DIR_PATH', dirname(EVENT_ESPRESSO_MAIN_FILE) . '/');
+define('EE_PLUGIN_DIR_PATH', dirname(EVENT_ESPRESSO_MAIN_FILE).'/');
 define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE));
 // main root folder paths
-define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages/');
-define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core/');
-define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules/');
-define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public/');
-define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes/');
-define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets/');
-define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods/');
-define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated/');
+define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH.'admin_pages/');
+define('EE_CORE', EE_PLUGIN_DIR_PATH.'core/');
+define('EE_MODULES', EE_PLUGIN_DIR_PATH.'modules/');
+define('EE_PUBLIC', EE_PLUGIN_DIR_PATH.'public/');
+define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH.'shortcodes/');
+define('EE_WIDGETS', EE_PLUGIN_DIR_PATH.'widgets/');
+define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH.'payment_methods/');
+define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH.'caffeinated/');
 // core system paths
-define('EE_ADMIN', EE_CORE . 'admin/');
-define('EE_CPTS', EE_CORE . 'CPTs/');
-define('EE_CLASSES', EE_CORE . 'db_classes/');
-define('EE_INTERFACES', EE_CORE . 'interfaces/');
-define('EE_BUSINESS', EE_CORE . 'business/');
-define('EE_MODELS', EE_CORE . 'db_models/');
-define('EE_HELPERS', EE_CORE . 'helpers/');
-define('EE_LIBRARIES', EE_CORE . 'libraries/');
-define('EE_TEMPLATES', EE_CORE . 'templates/');
-define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs/');
-define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets/');
-define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections/');
+define('EE_ADMIN', EE_CORE.'admin/');
+define('EE_CPTS', EE_CORE.'CPTs/');
+define('EE_CLASSES', EE_CORE.'db_classes/');
+define('EE_INTERFACES', EE_CORE.'interfaces/');
+define('EE_BUSINESS', EE_CORE.'business/');
+define('EE_MODELS', EE_CORE.'db_models/');
+define('EE_HELPERS', EE_CORE.'helpers/');
+define('EE_LIBRARIES', EE_CORE.'libraries/');
+define('EE_TEMPLATES', EE_CORE.'templates/');
+define('EE_THIRD_PARTY', EE_CORE.'third_party_libs/');
+define('EE_GLOBAL_ASSETS', EE_TEMPLATES.'global_assets/');
+define('EE_FORM_SECTIONS', EE_LIBRARIES.'form_sections/');
 // gateways
-define('EE_GATEWAYS', EE_MODULES . 'gateways/');
-define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules/gateways/');
+define('EE_GATEWAYS', EE_MODULES.'gateways/');
+define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL.'modules/gateways/');
 // asset URL paths
-define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core/templates/');
-define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets/');
-define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images/');
-define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core/third_party_libs/');
-define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/');
-define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/');
+define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL.'core/templates/');
+define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL.'global_assets/');
+define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL.'images/');
+define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL.'core/third_party_libs/');
+define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL.'core/helpers/assets/');
+define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL.'core/libraries/');
 // define upload paths
 $uploads = wp_upload_dir();
 // define the uploads directory and URL
-define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . '/espresso/');
-define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . '/espresso/');
+define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'].'/espresso/');
+define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'].'/espresso/');
 // define the templates directory and URL
-define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . '/espresso/templates/');
-define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . '/espresso/templates/');
+define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'].'/espresso/templates/');
+define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'].'/espresso/templates/');
 // languages folder/path
-define('EE_LANGUAGES_SAFE_LOC', '../' . 'uploads/' . 'espresso/languages/');
-define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages/');
+define('EE_LANGUAGES_SAFE_LOC', '../'.'uploads/'.'espresso/languages/');
+define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR.'languages/');
 // check for DOMPDF fonts in uploads
-if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts/')) {
-    define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts/');
+if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR.'fonts/')) {
+    define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR.'fonts/');
 }
 // just a handy constant occasionally needed for finding values representing infinity in the DB
 // you're better to use this than its straight value (currently -1) in case you ever
 // want to change its default value! or find when -1 means infinity
 define('EE_INF_IN_DB', -1);
 define('EE_INF', INF > (float) PHP_INT_MAX ? INF : PHP_INT_MAX);
-if (! defined('EE_DEBUG')) {
+if ( ! defined('EE_DEBUG')) {
     define('EE_DEBUG', false);
 }
 // for older WP versions
-if (! defined('MONTH_IN_SECONDS')) {
+if ( ! defined('MONTH_IN_SECONDS')) {
     define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
 }

core/EE_Log.core.php

Spacing +13 added lines, -13 removed lines

@@ -48,7 +48,7 @@ 
      */
     public static function instance()
     {
-        if (! self::$_instance instanceof EE_Log) {
+        if ( ! self::$_instance instanceof EE_Log) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -61,7 +61,7 @@ 
     private function __construct()
     {
 
-        if (! EE_Registry::instance()->CFG->admin->use_remote_logging) {
+        if ( ! EE_Registry::instance()->CFG->admin->use_remote_logging) {
             return;
         }
 
@@ -105,14 +105,14 @@ 
      */
     private function _format_message($file = '', $function = '', $message = '', $type = '')
     {
-        $msg = '----------------------------------------------------------------------------------------' . PHP_EOL;
-        $msg .= '[' . current_time('mysql') . '] ';
+        $msg = '----------------------------------------------------------------------------------------'.PHP_EOL;
+        $msg .= '['.current_time('mysql').'] ';
         $msg .= ! empty($file) ? basename($file) : '';
         $msg .= ! empty($file) && ! empty($function) ? ' -> ' : '';
-        $msg .= ! empty($function) ? $function . '()' : '';
+        $msg .= ! empty($function) ? $function.'()' : '';
         $msg .= PHP_EOL;
         $type = ! empty($type) ? $type : 'log message';
-        $msg .= ! empty($message) ? "\t" . '[' . $type . '] ' . $message . PHP_EOL : '';
+        $msg .= ! empty($message) ? "\t".'['.$type.'] '.$message.PHP_EOL : '';
         return $msg;
     }
 
@@ -164,18 +164,18 @@ 
 
         /** @var RequestInterface $request */
         $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $data = 'domain=' . $request->getServerParam('HTTP_HOST');
-        $data .= '&ip=' . $request->getServerParam('SERVER_ADDR');
-        $data .= '&server_type=' . $request->getServerParam('SERVER_SOFTWARE');
-        $data .= '&time=' . time();
-        $data .= '&remote_log=' . $this->_log;
+        $data = 'domain='.$request->getServerParam('HTTP_HOST');
+        $data .= '&ip='.$request->getServerParam('SERVER_ADDR');
+        $data .= '&server_type='.$request->getServerParam('SERVER_SOFTWARE');
+        $data .= '&time='.time();
+        $data .= '&remote_log='.$this->_log;
         $data .= '&action=save';
 
         if (defined('EELOGGING_PASS')) {
-            $data .= '&pass=' . EELOGGING_PASS;
+            $data .= '&pass='.EELOGGING_PASS;
         }
         if (defined('EELOGGING_KEY')) {
-            $data .= '&key=' . EELOGGING_KEY;
+            $data .= '&key='.EELOGGING_KEY;
         }
 
         $c = curl_init($this->_remote_logging_url);

Indentation +193 added lines, -193 removed lines

@@ -19,197 +19,197 @@
  */
 class EE_Log
 {
-    /**
-     * @var string
-     */
-    private $_log = '';
-
-    /**
-     * Used for remote logging
-     *
-     * @var string
-     */
-    private $_remote_logging_url = '';
-
-    /**
-     * @var string
-     */
-    private $_remote_log = '';
-
-    /**
-     * @var EE_Log
-     */
-    private static $_instance;
-
-
-    /**
-     * @return EE_Log
-     */
-    public static function instance()
-    {
-        if (! self::$_instance instanceof EE_Log) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-    /**
-     * @access private
-     * @return EE_Log
-     */
-    private function __construct()
-    {
-
-        if (! EE_Registry::instance()->CFG->admin->use_remote_logging) {
-            return;
-        }
-
-        $this->_remote_logging_url = EE_Registry::instance()->CFG->admin->remote_logging_url;
-        $this->_remote_log = '';
-
-        if (EE_Registry::instance()->CFG->admin->use_remote_logging) {
-            add_action('shutdown', array($this, 'send_log'), 9999);
-        }
-    }
-
-
-    /**
-     *    verify_filesystem
-     * tests that the required files and folders exist and are writable
-     *
-     */
-    public function verify_filesystem()
-    {
-        $msg = esc_html__(
-            'The Local File Logging functionality was removed permanently. Remote Logging is recommended instead.',
-            'event_espresso'
-        );
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            $msg,
-            '4.10.1.p'
-        );
-    }
-
-
-    /**
-     *    _format_message
-     *    makes yer log entries look all purdy
-     *
-     * @param string $file
-     * @param string $function
-     * @param string $message
-     * @param string $type
-     * @return string
-     */
-    private function _format_message($file = '', $function = '', $message = '', $type = '')
-    {
-        $msg = '----------------------------------------------------------------------------------------' . PHP_EOL;
-        $msg .= '[' . current_time('mysql') . '] ';
-        $msg .= ! empty($file) ? basename($file) : '';
-        $msg .= ! empty($file) && ! empty($function) ? ' -> ' : '';
-        $msg .= ! empty($function) ? $function . '()' : '';
-        $msg .= PHP_EOL;
-        $type = ! empty($type) ? $type : 'log message';
-        $msg .= ! empty($message) ? "\t" . '[' . $type . '] ' . $message . PHP_EOL : '';
-        return $msg;
-    }
-
-
-    /**
-     *    log
-     * adds content to the EE_Log->_log property which gets written to file during the WP 'shutdown' hookpoint via the
-     * EE_Log::write_log() callback
-     *
-     * @param string $file
-     * @param string $function
-     * @param string $message
-     * @param string $type
-     */
-    public function log($file = '', $function = '', $message = '', $type = '')
-    {
-        $this->_log .= $this->_format_message($file, $function, $message, $type);
-    }
-
-
-    /**
-     * write_log
-     * appends the results of the 'AHEE_log' filter to the espresso log file
-     */
-    public function write_log()
-    {
-        $msg = esc_html__(
-            'The Local File Logging functionality was removed permanently. Remote Logging is recommended instead.',
-            'event_espresso'
-        );
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            $msg,
-            '4.10.1.p'
-        );
-    }
-
-
-    /**
-     * send_log
-     * sends the espresso log to a remote URL via a PHP cURL request
-     */
-    public function send_log()
-    {
-
-        if (empty($this->_remote_logging_url)) {
-            return;
-        }
-
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $data = 'domain=' . $request->getServerParam('HTTP_HOST');
-        $data .= '&ip=' . $request->getServerParam('SERVER_ADDR');
-        $data .= '&server_type=' . $request->getServerParam('SERVER_SOFTWARE');
-        $data .= '&time=' . time();
-        $data .= '&remote_log=' . $this->_log;
-        $data .= '&action=save';
-
-        if (defined('EELOGGING_PASS')) {
-            $data .= '&pass=' . EELOGGING_PASS;
-        }
-        if (defined('EELOGGING_KEY')) {
-            $data .= '&key=' . EELOGGING_KEY;
-        }
-
-        $c = curl_init($this->_remote_logging_url);
-        curl_setopt($c, CURLOPT_POST, true);
-        curl_setopt($c, CURLOPT_POSTFIELDS, $data);
-        curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
-        curl_exec($c);
-        curl_close($c);
-    }
-
-
-    /**
-     * write_debug
-     * writes the contents of the current request's data to a log file.
-     * previous entries are overwritten
-     */
-    public function write_debug()
-    {
-        $msg = esc_html__(
-            'The Local File Logging functionality was removed permanently. Remote Logging is recommended instead.',
-            'event_espresso'
-        );
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            $msg,
-            '4.10.1.p'
-        );
-    }
-
-
-    /**
-     * __clone
-     */
-    public function __clone()
-    {
-        trigger_error(esc_html__('Clone is not allowed.', 'event_espresso'), E_USER_ERROR);
-    }
+	/**
+	 * @var string
+	 */
+	private $_log = '';
+
+	/**
+	 * Used for remote logging
+	 *
+	 * @var string
+	 */
+	private $_remote_logging_url = '';
+
+	/**
+	 * @var string
+	 */
+	private $_remote_log = '';
+
+	/**
+	 * @var EE_Log
+	 */
+	private static $_instance;
+
+
+	/**
+	 * @return EE_Log
+	 */
+	public static function instance()
+	{
+		if (! self::$_instance instanceof EE_Log) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+	/**
+	 * @access private
+	 * @return EE_Log
+	 */
+	private function __construct()
+	{
+
+		if (! EE_Registry::instance()->CFG->admin->use_remote_logging) {
+			return;
+		}
+
+		$this->_remote_logging_url = EE_Registry::instance()->CFG->admin->remote_logging_url;
+		$this->_remote_log = '';
+
+		if (EE_Registry::instance()->CFG->admin->use_remote_logging) {
+			add_action('shutdown', array($this, 'send_log'), 9999);
+		}
+	}
+
+
+	/**
+	 *    verify_filesystem
+	 * tests that the required files and folders exist and are writable
+	 *
+	 */
+	public function verify_filesystem()
+	{
+		$msg = esc_html__(
+			'The Local File Logging functionality was removed permanently. Remote Logging is recommended instead.',
+			'event_espresso'
+		);
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			$msg,
+			'4.10.1.p'
+		);
+	}
+
+
+	/**
+	 *    _format_message
+	 *    makes yer log entries look all purdy
+	 *
+	 * @param string $file
+	 * @param string $function
+	 * @param string $message
+	 * @param string $type
+	 * @return string
+	 */
+	private function _format_message($file = '', $function = '', $message = '', $type = '')
+	{
+		$msg = '----------------------------------------------------------------------------------------' . PHP_EOL;
+		$msg .= '[' . current_time('mysql') . '] ';
+		$msg .= ! empty($file) ? basename($file) : '';
+		$msg .= ! empty($file) && ! empty($function) ? ' -> ' : '';
+		$msg .= ! empty($function) ? $function . '()' : '';
+		$msg .= PHP_EOL;
+		$type = ! empty($type) ? $type : 'log message';
+		$msg .= ! empty($message) ? "\t" . '[' . $type . '] ' . $message . PHP_EOL : '';
+		return $msg;
+	}
+
+
+	/**
+	 *    log
+	 * adds content to the EE_Log->_log property which gets written to file during the WP 'shutdown' hookpoint via the
+	 * EE_Log::write_log() callback
+	 *
+	 * @param string $file
+	 * @param string $function
+	 * @param string $message
+	 * @param string $type
+	 */
+	public function log($file = '', $function = '', $message = '', $type = '')
+	{
+		$this->_log .= $this->_format_message($file, $function, $message, $type);
+	}
+
+
+	/**
+	 * write_log
+	 * appends the results of the 'AHEE_log' filter to the espresso log file
+	 */
+	public function write_log()
+	{
+		$msg = esc_html__(
+			'The Local File Logging functionality was removed permanently. Remote Logging is recommended instead.',
+			'event_espresso'
+		);
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			$msg,
+			'4.10.1.p'
+		);
+	}
+
+
+	/**
+	 * send_log
+	 * sends the espresso log to a remote URL via a PHP cURL request
+	 */
+	public function send_log()
+	{
+
+		if (empty($this->_remote_logging_url)) {
+			return;
+		}
+
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$data = 'domain=' . $request->getServerParam('HTTP_HOST');
+		$data .= '&ip=' . $request->getServerParam('SERVER_ADDR');
+		$data .= '&server_type=' . $request->getServerParam('SERVER_SOFTWARE');
+		$data .= '&time=' . time();
+		$data .= '&remote_log=' . $this->_log;
+		$data .= '&action=save';
+
+		if (defined('EELOGGING_PASS')) {
+			$data .= '&pass=' . EELOGGING_PASS;
+		}
+		if (defined('EELOGGING_KEY')) {
+			$data .= '&key=' . EELOGGING_KEY;
+		}
+
+		$c = curl_init($this->_remote_logging_url);
+		curl_setopt($c, CURLOPT_POST, true);
+		curl_setopt($c, CURLOPT_POSTFIELDS, $data);
+		curl_setopt($c, CURLOPT_RETURNTRANSFER, true);
+		curl_exec($c);
+		curl_close($c);
+	}
+
+
+	/**
+	 * write_debug
+	 * writes the contents of the current request's data to a log file.
+	 * previous entries are overwritten
+	 */
+	public function write_debug()
+	{
+		$msg = esc_html__(
+			'The Local File Logging functionality was removed permanently. Remote Logging is recommended instead.',
+			'event_espresso'
+		);
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			$msg,
+			'4.10.1.p'
+		);
+	}
+
+
+	/**
+	 * __clone
+	 */
+	public function __clone()
+	{
+		trigger_error(esc_html__('Clone is not allowed.', 'event_espresso'), E_USER_ERROR);
+	}
 }

core/db_classes/EE_Import.class.php

Spacing +40 added lines, -40 removed lines

@@ -141,7 +141,7 @@ 
     public function import()
     {
 
-        require_once(EE_CLASSES . 'EE_CSV.class.php');
+        require_once(EE_CLASSES.'EE_CSV.class.php');
         $this->EE_CSV = EE_CSV::instance();
 
         /** @var RequestInterface $request */
@@ -188,18 +188,18 @@ 
                     break;
             }
 
-            if (! $error_msg) {
+            if ( ! $error_msg) {
                 $filename = $files['file']['name'][0];
                 $file_ext = substr(strrchr($filename, '.'), 1);
                 $file_type = $files['file']['type'][0];
                 $temp_file = $files['file']['tmp_name'][0];
-                $filesize = $files['file']['size'][0] / 1024;// convert from bytes to KB
+                $filesize = $files['file']['size'][0] / 1024; // convert from bytes to KB
 
                 if ($file_ext == 'csv') {
-                    $max_upload = $this->EE_CSV->get_max_upload_size();// max upload size in KB
+                    $max_upload = $this->EE_CSV->get_max_upload_size(); // max upload size in KB
                     if ($filesize < $max_upload || true) {
                         $wp_upload_dir = str_replace(array('\\', '/'), '/', wp_upload_dir());
-                        $path_to_file = $wp_upload_dir['basedir'] . '/espresso/' . $filename;
+                        $path_to_file = $wp_upload_dir['basedir'].'/espresso/'.$filename;
 
                         if (move_uploaded_file($temp_file, $path_to_file)) {
                             // convert csv to array
@@ -334,8 +334,8 @@ 
         // begin looking through the $csv_data_array, expecting the toplevel key to be the model's name...
         $old_site_url = 'none-specified';
         // hanlde metadata
-        if (isset($csv_data_array[ EE_CSV::metadata_header ])) {
-            $csv_metadata = array_shift($csv_data_array[ EE_CSV::metadata_header ]);
+        if (isset($csv_data_array[EE_CSV::metadata_header])) {
+            $csv_metadata = array_shift($csv_data_array[EE_CSV::metadata_header]);
             // ok so its metadata, dont try to save it to ehte db obviously...
             if (isset($csv_metadata['site_url']) && $csv_metadata['site_url'] == site_url()) {
                 EE_Error::add_attention(
@@ -360,14 +360,14 @@ 
                     )
                 );
             };
-            unset($csv_data_array[ EE_CSV::metadata_header ]);
+            unset($csv_data_array[EE_CSV::metadata_header]);
         }
         /**
          * @var $old_db_to_new_db_mapping 2d array: toplevel keys being model names, bottom-level keys being the original key, and
          * the value will be the newly-inserted ID.
          * If we have already imported data from the same website via CSV, it shoudl be kept in this wp option
          */
-        $old_db_to_new_db_mapping = get_option('ee_id_mapping_from' . sanitize_title($old_site_url), array());
+        $old_db_to_new_db_mapping = get_option('ee_id_mapping_from'.sanitize_title($old_site_url), array());
         if ($old_db_to_new_db_mapping) {
             EE_Error::add_attention(
                 sprintf(
@@ -387,7 +387,7 @@ 
         );
 
         // save the mapping from old db to new db in case they try re-importing the same data from the same website again
-        update_option('ee_id_mapping_from' . sanitize_title($old_site_url), $old_db_to_new_db_mapping);
+        update_option('ee_id_mapping_from'.sanitize_title($old_site_url), $old_db_to_new_db_mapping);
 
         if ($this->_total_updates > 0) {
             EE_Error::add_success(
@@ -510,7 +510,7 @@ 
                 // find the PK in the row of data (or a combined key if
                 // there is no primary key)
                 if ($model->has_primary_key_field()) {
-                    $id_in_csv = $model_object_data[ $model->primary_key_name() ];
+                    $id_in_csv = $model_object_data[$model->primary_key_name()];
                 } else {
                     $id_in_csv = $model->get_index_primary_key_string($model_object_data);
                 }
@@ -554,14 +554,14 @@ 
                         $what_to_do = self::do_update;
                         // and if this model has a primary key, remember its mapping
                         if ($model->has_primary_key_field()) {
-                            $old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ] = $conflicting->ID();
-                            $model_object_data[ $model->primary_key_name() ] = $conflicting->ID();
+                            $old_db_to_new_db_mapping[$model_name][$id_in_csv] = $conflicting->ID();
+                            $model_object_data[$model->primary_key_name()] = $conflicting->ID();
                         } else {
                             // we want to update this conflicting item, instead of inserting a conflicting item
                             // so we need to make sure they match entirely (its possible that they only conflicted on one field, but we need them to match on other fields
                             // for the WHERE conditions in the update). At the time of this comment, there were no models like this
                             foreach ($model->get_combined_primary_key_fields() as $key_field) {
-                                $model_object_data[ $key_field->get_name() ] = $conflicting->get(
+                                $model_object_data[$key_field->get_name()] = $conflicting->get(
                                     $key_field->get_name()
                                 );
                             }
@@ -621,7 +621,7 @@ 
         $model_name = $model->get_this_model_name();
         // if it's a site-to-site export-and-import, see if this modelobject's id
         // in the old data that we know of
-        if (isset($old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ])) {
+        if (isset($old_db_to_new_db_mapping[$model_name][$id_in_csv])) {
             return self::do_update;
         } else {
             return self::do_insert;
@@ -677,13 +677,13 @@ 
         if (
             $model->has_primary_key_field() &&
             $model->get_primary_key_field()->is_auto_increment() &&
-            isset($old_db_to_new_db_mapping[ $model->get_this_model_name() ]) &&
+            isset($old_db_to_new_db_mapping[$model->get_this_model_name()]) &&
             isset(
-                $old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $model_object_data[ $model->primary_key_name() ] ]
+                $old_db_to_new_db_mapping[$model->get_this_model_name()][$model_object_data[$model->primary_key_name()]]
             )
         ) {
-            $model_object_data[ $model->primary_key_name() ] = $old_db_to_new_db_mapping[ $model->get_this_model_name(
-            ) ][ $model_object_data[ $model->primary_key_name() ] ];
+            $model_object_data[$model->primary_key_name()] = $old_db_to_new_db_mapping[$model->get_this_model_name(
+            )][$model_object_data[$model->primary_key_name()]];
         }
 
         try {
@@ -699,10 +699,10 @@ 
                 $found_a_mapping = false;
                 foreach ($models_pointed_to as $model_pointed_to_by_fk) {
                     if ($model_name_field) {
-                        $value_of_model_name_field = $model_object_data[ $model_name_field->get_name() ];
+                        $value_of_model_name_field = $model_object_data[$model_name_field->get_name()];
                         if ($value_of_model_name_field == $model_pointed_to_by_fk) {
-                            $model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
-                                $model_object_data[ $field_obj->get_name() ],
+                            $model_object_data[$field_obj->get_name()] = $this->_find_mapping_in(
+                                $model_object_data[$field_obj->get_name()],
                                 $model_pointed_to_by_fk,
                                 $old_db_to_new_db_mapping,
                                 $export_from_site_a_to_b
@@ -711,8 +711,8 @@ 
                             break;
                         }
                     } else {
-                        $model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
-                            $model_object_data[ $field_obj->get_name() ],
+                        $model_object_data[$field_obj->get_name()] = $this->_find_mapping_in(
+                            $model_object_data[$field_obj->get_name()],
                             $model_pointed_to_by_fk,
                             $old_db_to_new_db_mapping,
                             $export_from_site_a_to_b
@@ -777,8 +777,8 @@ 
      */
     protected function _find_mapping_in($object_id, $model_name, $old_db_to_new_db_mapping, $export_from_site_a_to_b)
     {
-        if (isset($old_db_to_new_db_mapping[ $model_name ][ $object_id ])) {
-            return $old_db_to_new_db_mapping[ $model_name ][ $object_id ];
+        if (isset($old_db_to_new_db_mapping[$model_name][$object_id])) {
+            return $old_db_to_new_db_mapping[$model_name][$object_id];
         } elseif ($object_id == '0' || $object_id == '') {
             // leave as-is
             return $object_id;
@@ -786,7 +786,7 @@ 
             // we couldn't find a mapping for this, and it's from a different site,
             // so blank it out
             return null;
-        } elseif (! $export_from_site_a_to_b) {
+        } elseif ( ! $export_from_site_a_to_b) {
             // we coudln't find a mapping for this, but it's from thsi DB anyway
             // so let's just leave it as-is
             return $object_id;
@@ -806,8 +806,8 @@ 
         // remove the primary key, if there is one (we don't want it for inserts OR updates)
         // we'll put it back in if we need it
         if ($model->has_primary_key_field() && $model->get_primary_key_field()->is_auto_increment()) {
-            $effective_id = $model_object_data[ $model->primary_key_name() ];
-            unset($model_object_data[ $model->primary_key_name() ]);
+            $effective_id = $model_object_data[$model->primary_key_name()];
+            unset($model_object_data[$model->primary_key_name()]);
         } else {
             $effective_id = $model->get_index_primary_key_string($model_object_data);
         }
@@ -815,7 +815,7 @@ 
         try {
             $new_id = $model->insert($model_object_data);
             if ($new_id) {
-                $old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_id;
+                $old_db_to_new_db_mapping[$model->get_this_model_name()][$id_in_csv] = $new_id;
                 $this->_total_inserts++;
                 EE_Error::add_success(
                     sprintf(
@@ -829,7 +829,7 @@ 
                 $this->_total_insert_errors++;
                 // put the ID used back in there for the error message
                 if ($model->has_primary_key_field()) {
-                    $model_object_data[ $model->primary_key_name() ] = $effective_id;
+                    $model_object_data[$model->primary_key_name()] = $effective_id;
                 }
                 EE_Error::add_error(
                     sprintf(
@@ -845,7 +845,7 @@ 
         } catch (EE_Error $e) {
             $this->_total_insert_errors++;
             if ($model->has_primary_key_field()) {
-                $model_object_data[ $model->primary_key_name() ] = $effective_id;
+                $model_object_data[$model->primary_key_name()] = $effective_id;
             }
             EE_Error::add_error(
                 sprintf(
@@ -878,17 +878,17 @@ 
             // one for performing an update, one for everthing else
             $model_object_data_for_update = $model_object_data;
             if ($model->has_primary_key_field()) {
-                $conditions = array($model->primary_key_name() => $model_object_data[ $model->primary_key_name() ]);
+                $conditions = array($model->primary_key_name() => $model_object_data[$model->primary_key_name()]);
                 // remove the primary key because we shouldn't use it for updating
-                unset($model_object_data_for_update[ $model->primary_key_name() ]);
+                unset($model_object_data_for_update[$model->primary_key_name()]);
             } elseif ($model->get_combined_primary_key_fields() > 1) {
                 $conditions = array();
                 foreach ($model->get_combined_primary_key_fields() as $key_field) {
-                    $conditions[ $key_field->get_name() ] = $model_object_data[ $key_field->get_name() ];
+                    $conditions[$key_field->get_name()] = $model_object_data[$key_field->get_name()];
                 }
             } else {
                 $model->primary_key_name(
-                );// this shoudl just throw an exception, explaining that we dont have a primary key (or a combine dkey)
+                ); // this shoudl just throw an exception, explaining that we dont have a primary key (or a combine dkey)
             }
 
             $success = $model->update($model_object_data_for_update, array($conditions));
@@ -906,15 +906,15 @@ 
                 // we would have last-minute decided to update. So we'd like to know what we updated
                 // and so we record what record ended up being updated using the mapping
                 if ($model->has_primary_key_field()) {
-                    $new_key_for_mapping = $model_object_data[ $model->primary_key_name() ];
+                    $new_key_for_mapping = $model_object_data[$model->primary_key_name()];
                 } else {
                     // no primary key just a combined key
                     $new_key_for_mapping = $model->get_index_primary_key_string($model_object_data);
                 }
-                $old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_key_for_mapping;
+                $old_db_to_new_db_mapping[$model->get_this_model_name()][$id_in_csv] = $new_key_for_mapping;
             } else {
                 $matched_items = $model->get_all(array($conditions));
-                if (! $matched_items) {
+                if ( ! $matched_items) {
                     // no items were matched (so we shouldn't have updated)... but then we should have inserted? what the heck?
                     $this->_total_update_errors++;
                     EE_Error::add_error(
@@ -953,7 +953,7 @@ 
                 implode(",", $model_object_data),
                 $e->getMessage()
             );
-            $debug_message = $basic_message . ' Stack trace: ' . $e->getTraceAsString();
+            $debug_message = $basic_message.' Stack trace: '.$e->getTraceAsString();
             EE_Error::add_error("$basic_message | $debug_message", __FILE__, __FUNCTION__, __LINE__);
         }
         return $old_db_to_new_db_mapping;

Indentation +964 added lines, -964 removed lines

@@ -13,97 +13,97 @@ 
  */
 class EE_Import implements ResettableInterface
 {
-    const do_insert = 'insert';
-    const do_update = 'update';
-    const do_nothing = 'nothing';
-
-
-    // instance of the EE_Import object
-    private static $_instance;
-
-    private static $_csv_array = array();
-
-    /**
-     *
-     * @var array of model names
-     */
-    private static $_model_list = array();
-
-    private static $_columns_to_save = array();
-
-    protected $_total_inserts = 0;
-    protected $_total_updates = 0;
-    protected $_total_insert_errors = 0;
-    protected $_total_update_errors = 0;
-
-    /**
-     * @var EE_CSV
-     * @since 4.10.14.p
-     */
-    private $EE_CSV;
-
-
-    /**
-     *        private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access private
-     * @return void
-     */
-    private function __construct()
-    {
-        $this->_total_inserts = 0;
-        $this->_total_updates = 0;
-        $this->_total_insert_errors = 0;
-        $this->_total_update_errors = 0;
-    }
-
-
-    /**
-     *    @ singleton method used to instantiate class object
-     *    @ access public
-     *
-     * @return EE_Import
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (self::$_instance === null or ! is_object(self::$_instance) or ! (self::$_instance instanceof EE_Import)) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-    /**
-     * Resets the importer
-     *
-     * @return EE_Import
-     */
-    public static function reset()
-    {
-        self::$_instance = null;
-        return self::instance();
-    }
-
-
-    /**
-     *    @ generates HTML for a file upload input and form
-     *    @ access    public
-     *
-     * @param    string $title  - heading for the form
-     * @param    string $intro  - additional text explaing what to do
-     * @param    string $page   - EE Admin page to direct form to - in the form "espresso_{pageslug}"
-     * @param    string $action - EE Admin page route array "action" that form will direct to
-     * @param    string $type   - type of file to import
-     *                          @ return    string
-     */
-    public function upload_form($title, $intro, $form_url, $action, $type)
-    {
-
-        $form_url = EE_Admin_Page::add_query_args_and_nonce(array('action' => $action), $form_url);
-
-        ob_start();
-        ?>
+	const do_insert = 'insert';
+	const do_update = 'update';
+	const do_nothing = 'nothing';
+
+
+	// instance of the EE_Import object
+	private static $_instance;
+
+	private static $_csv_array = array();
+
+	/**
+	 *
+	 * @var array of model names
+	 */
+	private static $_model_list = array();
+
+	private static $_columns_to_save = array();
+
+	protected $_total_inserts = 0;
+	protected $_total_updates = 0;
+	protected $_total_insert_errors = 0;
+	protected $_total_update_errors = 0;
+
+	/**
+	 * @var EE_CSV
+	 * @since 4.10.14.p
+	 */
+	private $EE_CSV;
+
+
+	/**
+	 *        private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access private
+	 * @return void
+	 */
+	private function __construct()
+	{
+		$this->_total_inserts = 0;
+		$this->_total_updates = 0;
+		$this->_total_insert_errors = 0;
+		$this->_total_update_errors = 0;
+	}
+
+
+	/**
+	 *    @ singleton method used to instantiate class object
+	 *    @ access public
+	 *
+	 * @return EE_Import
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (self::$_instance === null or ! is_object(self::$_instance) or ! (self::$_instance instanceof EE_Import)) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+	/**
+	 * Resets the importer
+	 *
+	 * @return EE_Import
+	 */
+	public static function reset()
+	{
+		self::$_instance = null;
+		return self::instance();
+	}
+
+
+	/**
+	 *    @ generates HTML for a file upload input and form
+	 *    @ access    public
+	 *
+	 * @param    string $title  - heading for the form
+	 * @param    string $intro  - additional text explaing what to do
+	 * @param    string $page   - EE Admin page to direct form to - in the form "espresso_{pageslug}"
+	 * @param    string $action - EE Admin page route array "action" that form will direct to
+	 * @param    string $type   - type of file to import
+	 *                          @ return    string
+	 */
+	public function upload_form($title, $intro, $form_url, $action, $type)
+	{
+
+		$form_url = EE_Admin_Page::add_query_args_and_nonce(array('action' => $action), $form_url);
+
+		ob_start();
+		?>
         <div class="ee-upload-form-dv">
             <h3><?php echo esc_html($title); ?></h3>
             <p><?php echo esc_html($intro); ?></p>
@@ -119,882 +119,882 @@ 
                 <b><?php esc_html_e('Attention', 'event_espresso'); ?></b><br/>
                 <?php echo sprintf(esc_html__('Accepts .%s file types only.', 'event_espresso'), $type); ?>
                 <?php echo esc_html__(
-                    'Please only import CSV files exported from Event Espresso, or compatible 3rd-party software.',
-                    'event_espresso'
-                ); ?>
+					'Please only import CSV files exported from Event Espresso, or compatible 3rd-party software.',
+					'event_espresso'
+				); ?>
             </p>
 
         </div>
 
         <?php
-        $uploader = ob_get_clean();
-        return $uploader;
-    }
-
-
-    /**
-     * @Import Event Espresso data - some code "borrowed" from event espresso csv_import.php
-     * @access public
-     * @return boolean success
-     */
-    public function import()
-    {
-
-        require_once(EE_CLASSES . 'EE_CSV.class.php');
-        $this->EE_CSV = EE_CSV::instance();
-
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-
-        if ($request->requestParamIsSet('import') && $request->requestParamIsSet('csv_submitted')) {
-            $files = $request->filesParams();
-            switch ($files['file']['error'][0]) {
-                case UPLOAD_ERR_OK:
-                    $error_msg = false;
-                    break;
-                case UPLOAD_ERR_INI_SIZE:
-                    $error_msg = esc_html__(
-                        "'The uploaded file exceeds the upload_max_filesize directive in php.ini.'",
-                        "event_espresso"
-                    );
-                    break;
-                case UPLOAD_ERR_FORM_SIZE:
-                    $error_msg = esc_html__(
-                        'The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form.',
-                        "event_espresso"
-                    );
-                    break;
-                case UPLOAD_ERR_PARTIAL:
-                    $error_msg = esc_html__('The uploaded file was only partially uploaded.', "event_espresso");
-                    break;
-                case UPLOAD_ERR_NO_FILE:
-                    $error_msg = esc_html__('No file was uploaded.', "event_espresso");
-                    break;
-                case UPLOAD_ERR_NO_TMP_DIR:
-                    $error_msg = esc_html__('Missing a temporary folder.', "event_espresso");
-                    break;
-                case UPLOAD_ERR_CANT_WRITE:
-                    $error_msg = esc_html__('Failed to write file to disk.', "event_espresso");
-                    break;
-                case UPLOAD_ERR_EXTENSION:
-                    $error_msg = esc_html__('File upload stopped by extension.', "event_espresso");
-                    break;
-                default:
-                    $error_msg = esc_html__(
-                        'An unknown error occurred and the file could not be uploaded',
-                        "event_espresso"
-                    );
-                    break;
-            }
-
-            if (! $error_msg) {
-                $filename = $files['file']['name'][0];
-                $file_ext = substr(strrchr($filename, '.'), 1);
-                $file_type = $files['file']['type'][0];
-                $temp_file = $files['file']['tmp_name'][0];
-                $filesize = $files['file']['size'][0] / 1024;// convert from bytes to KB
-
-                if ($file_ext == 'csv') {
-                    $max_upload = $this->EE_CSV->get_max_upload_size();// max upload size in KB
-                    if ($filesize < $max_upload || true) {
-                        $wp_upload_dir = str_replace(array('\\', '/'), '/', wp_upload_dir());
-                        $path_to_file = $wp_upload_dir['basedir'] . '/espresso/' . $filename;
-
-                        if (move_uploaded_file($temp_file, $path_to_file)) {
-                            // convert csv to array
-                            $this->csv_array = $this->EE_CSV->import_csv_to_model_data_array($path_to_file);
-
-                            $action = $request->getRequestParam('action');
-
-                            // was data successfully stored in an array?
-                            if (is_array($this->csv_array)) {
-                                $import_what = str_replace('csv_import_', '', $action);
-                                $import_what = str_replace('_', ' ', ucwords($import_what));
-                                $processed_data = $this->csv_array;
-                                $this->columns_to_save = false;
-
-                                // if any imports require funky processing, we'll catch them in the switch
-                                switch ($action) {
-                                    case "import_events":
-                                    case "event_list":
-                                        $import_what = 'Event Details';
-                                        break;
-
-                                    case 'groupon_import_csv':
-                                        $import_what = 'Groupon Codes';
-                                        $processed_data = $this->process_groupon_codes();
-                                        break;
-                                }
-                                // save processed codes to db
-                                if ($this->save_csv_data_array_to_db($processed_data, $this->columns_to_save)) {
-                                    return true;
-                                }
-                            } else {
-                                // no array? must be an error
-                                EE_Error::add_error(
-                                    sprintf(esc_html__("No file seems to have been uploaded", "event_espresso")),
-                                    __FILE__,
-                                    __FUNCTION__,
-                                    __LINE__
-                                );
-                                return false;
-                            }
-                        } else {
-                            EE_Error::add_error(
-                                sprintf(esc_html__("%s was not successfully uploaded", "event_espresso"), $filename),
-                                __FILE__,
-                                __FUNCTION__,
-                                __LINE__
-                            );
-                            return false;
-                        }
-                    } else {
-                        EE_Error::add_error(
-                            sprintf(
-                                esc_html__(
-                                    "%s was too large of a file and could not be uploaded. The max filesize is %s' KB.",
-                                    "event_espresso"
-                                ),
-                                $filename,
-                                $max_upload
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                        return false;
-                    }
-                } else {
-                    EE_Error::add_error(
-                        sprintf(esc_html__("%s  had an invalid file extension, not uploaded", "event_espresso"), $filename),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                }
-            } else {
-                EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-                return false;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     *    Given an array of data (usually from a CSV import) attempts to save that data to the db.
-     *    If $model_name ISN'T provided, assumes that this is a 3d array, with toplevel keys being model names,
-     *    next level being numeric indexes adn each value representing a model object, and the last layer down
-     *    being keys of model fields and their proposed values.
-     *    If $model_name IS provided, assumes a 2d array of the bottom two layers previously mentioned.
-     *    If the CSV data says (in the metadata row) that it's from the SAME database,
-     *    we treat the IDs in the CSV as the normal IDs, and try to update those records. However, if those
-     *    IDs DON'T exist in the database, they're treated as temporary IDs,
-     *    which can used elsewhere to refer to the same object. Once an item
-     *    with a temporary ID gets inserted, we record its mapping from temporary
-     *    ID to real ID, and use the real ID in place of the temporary ID
-     *    when that temporary ID was used as a foreign key.
-     *    If the CSV data says (in the metadata again) that it's from a DIFFERENT database,
-     *    we treat all the IDs in the CSV as temporary ID- eg, if the CSV specifies an event with
-     *    ID 1, and the database already has an event with ID 1, we assume that's just a coincidence,
-     *    and insert a new event, and map it's temporary ID of 1 over to its new real ID.
-     *    An important exception are non-auto-increment primary keys. If one entry in the
-     *    CSV file has the same ID as one in the DB, we assume they are meant to be
-     *    the same item, and instead update the item in the DB with that same ID.
-     *    Also note, we remember the mappings permanently. So the 2nd, 3rd, and 10000th
-     *    time you import a CSV from a different site, we remember their mappings, and
-     * will try to update the item in the DB instead of inserting another item (eg
-     * if we previously imported an event with temporary ID 1, and then it got a
-     * real ID of 123, we remember that. So the next time we import an event with
-     * temporary ID, from the same site, we know that it's real ID is 123, and will
-     * update that event, instead of adding a new event).
-     *
-     * @access public
-     * @param array $csv_data_array - the array containing the csv data produced from
-     *                              EE_CSV::import_csv_to_model_data_array()
-     * @param array $fields_to_save - an array containing the csv column names as keys with the corresponding db table
-     *                              fields they will be saved to
-     * @return TRUE on success, FALSE on fail
-     * @throws \EE_Error
-     */
-    public function save_csv_data_array_to_db($csv_data_array, $model_name = false)
-    {
-        $success = false;
-        $error = false;
-        // whther to treat this import as if it's data froma different database or not
-        // ie, if it IS from a different database, ignore foreign keys whihf
-        $export_from_site_a_to_b = true;
-        // first level of array is not table information but a table name was passed to the function
-        // array is only two levels deep, so let's fix that by adding a level, else the next steps will fail
-        if ($model_name) {
-            $csv_data_array = array($csv_data_array);
-        }
-        // begin looking through the $csv_data_array, expecting the toplevel key to be the model's name...
-        $old_site_url = 'none-specified';
-        // hanlde metadata
-        if (isset($csv_data_array[ EE_CSV::metadata_header ])) {
-            $csv_metadata = array_shift($csv_data_array[ EE_CSV::metadata_header ]);
-            // ok so its metadata, dont try to save it to ehte db obviously...
-            if (isset($csv_metadata['site_url']) && $csv_metadata['site_url'] == site_url()) {
-                EE_Error::add_attention(
-                    sprintf(
-                        esc_html__(
-                            "CSV Data appears to be from the same database, so attempting to update data",
-                            "event_espresso"
-                        )
-                    )
-                );
-                $export_from_site_a_to_b = false;
-            } else {
-                $old_site_url = isset($csv_metadata['site_url']) ? $csv_metadata['site_url'] : $old_site_url;
-                EE_Error::add_attention(
-                    sprintf(
-                        esc_html__(
-                            "CSV Data appears to be from a different database (%s instead of %s), so we assume IDs in the CSV data DO NOT correspond to IDs in this database",
-                            "event_espresso"
-                        ),
-                        $old_site_url,
-                        site_url()
-                    )
-                );
-            };
-            unset($csv_data_array[ EE_CSV::metadata_header ]);
-        }
-        /**
-         * @var $old_db_to_new_db_mapping 2d array: toplevel keys being model names, bottom-level keys being the original key, and
-         * the value will be the newly-inserted ID.
-         * If we have already imported data from the same website via CSV, it shoudl be kept in this wp option
-         */
-        $old_db_to_new_db_mapping = get_option('ee_id_mapping_from' . sanitize_title($old_site_url), array());
-        if ($old_db_to_new_db_mapping) {
-            EE_Error::add_attention(
-                sprintf(
-                    esc_html__(
-                        "We noticed you have imported data via CSV from %s before. Because of this, IDs in your CSV have been mapped to their new IDs in %s",
-                        "event_espresso"
-                    ),
-                    $old_site_url,
-                    site_url()
-                )
-            );
-        }
-        $old_db_to_new_db_mapping = $this->save_data_rows_to_db(
-            $csv_data_array,
-            $export_from_site_a_to_b,
-            $old_db_to_new_db_mapping
-        );
-
-        // save the mapping from old db to new db in case they try re-importing the same data from the same website again
-        update_option('ee_id_mapping_from' . sanitize_title($old_site_url), $old_db_to_new_db_mapping);
-
-        if ($this->_total_updates > 0) {
-            EE_Error::add_success(
-                sprintf(
-                    esc_html__("%s existing records in the database were updated.", "event_espresso"),
-                    $this->_total_updates
-                )
-            );
-            $success = true;
-        }
-        if ($this->_total_inserts > 0) {
-            EE_Error::add_success(
-                sprintf(esc_html__("%s new records were added to the database.", "event_espresso"), $this->_total_inserts)
-            );
-            $success = true;
-        }
-
-        if ($this->_total_update_errors > 0) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        "'One or more errors occurred, and a total of %s existing records in the database were <strong>not</strong> updated.'",
-                        "event_espresso"
-                    ),
-                    $this->_total_update_errors
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $error = true;
-        }
-        if ($this->_total_insert_errors > 0) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        "One or more errors occurred, and a total of %s new records were <strong>not</strong> added to the database.'",
-                        "event_espresso"
-                    ),
-                    $this->_total_insert_errors
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $error = true;
-        }
-
-        // lastly, we need to update the datetime and ticket sold amounts
-        // as those may have been affected by this
-        EEM_Ticket::instance()->update_tickets_sold(EEM_Ticket::instance()->get_all());
-
-        // if there was at least one success and absolutely no errors
-        if ($success && ! $error) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * Processes the array of data, given the knowledge that it's from the same database or a different one,
-     * and the mapping from temporary IDs to real IDs.
-     * If the data is from a different database, we treat the primary keys and their corresponding
-     * foreign keys as "temp Ids", basically identifiers that get mapped to real primary keys
-     * in the real target database. As items are inserted, their temporary primary keys
-     * are mapped to the real IDs in the target database. Also, before doing any update or
-     * insert, we replace all the temp ID which are foreign keys with their mapped real IDs.
-     * An exception: string primary keys are treated as real IDs, or else we'd need to
-     * dynamically generate new string primary keys which would be very awkard for the country table etc.
-     * Also, models with no primary key are strange too. We combine use their primar key INDEX (a
-     * combination of fields) to create a unique string identifying the row and store
-     * those in the mapping.
-     *
-     * If the data is from the same database, we usually treat primary keys as real IDs.
-     * An exception is if there is nothing in the database for that ID. If that's the case,
-     * we need to insert a new row for that ID, and then map from the non-existent ID
-     * to the newly-inserted real ID.
-     *
-     * @param type $csv_data_array
-     * @param type $export_from_site_a_to_b
-     * @param type $old_db_to_new_db_mapping
-     * @return array updated $old_db_to_new_db_mapping
-     */
-    public function save_data_rows_to_db($csv_data_array, $export_from_site_a_to_b, $old_db_to_new_db_mapping)
-    {
-        foreach ($csv_data_array as $model_name_in_csv_data => $model_data_from_import) {
-            // now check that assumption was correct. If
-            if (EE_Registry::instance()->is_model_name($model_name_in_csv_data)) {
-                $model_name = $model_name_in_csv_data;
-            } else {
-                // no table info in the array and no table name passed to the function?? FAIL
-                EE_Error::add_error(
-                    esc_html__(
-                        'No table information was specified and/or found, therefore the import could not be completed',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-            /* @var $model EEM_Base */
-            $model = EE_Registry::instance()->load_model($model_name);
-
-            // so without further ado, scanning all the data provided for primary keys and their inital values
-            foreach ($model_data_from_import as $model_object_data) {
-                // before we do ANYTHING, make sure the csv row wasn't just completely blank
-                $row_is_completely_empty = true;
-                foreach ($model_object_data as $field) {
-                    if ($field) {
-                        $row_is_completely_empty = false;
-                    }
-                }
-                if ($row_is_completely_empty) {
-                    continue;
-                }
-                // find the PK in the row of data (or a combined key if
-                // there is no primary key)
-                if ($model->has_primary_key_field()) {
-                    $id_in_csv = $model_object_data[ $model->primary_key_name() ];
-                } else {
-                    $id_in_csv = $model->get_index_primary_key_string($model_object_data);
-                }
-
-
-                $model_object_data = $this->_replace_temp_ids_with_mappings(
-                    $model_object_data,
-                    $model,
-                    $old_db_to_new_db_mapping,
-                    $export_from_site_a_to_b
-                );
-                // now we need to decide if we're going to add a new model object given the $model_object_data,
-                // or just update.
-                if ($export_from_site_a_to_b) {
-                    $what_to_do = $this->_decide_whether_to_insert_or_update_given_data_from_other_db(
-                        $id_in_csv,
-                        $model_object_data,
-                        $model,
-                        $old_db_to_new_db_mapping
-                    );
-                } else {// this is just a re-import
-                    $what_to_do = $this->_decide_whether_to_insert_or_update_given_data_from_same_db(
-                        $id_in_csv,
-                        $model_object_data,
-                        $model,
-                        $old_db_to_new_db_mapping
-                    );
-                }
-                if ($what_to_do == self::do_nothing) {
-                    continue;
-                }
-
-                // double-check we actually want to insert, if that's what we're planning
-                // based on whether this item would be unique in the DB or not
-                if ($what_to_do == self::do_insert) {
-                    // we're supposed to be inserting. But wait, will this thing
-                    // be acceptable if inserted?
-                    $conflicting = $model->get_one_conflicting($model_object_data, false);
-                    if ($conflicting) {
-                        // ok, this item would conflict if inserted. Just update the item that it conflicts with.
-                        $what_to_do = self::do_update;
-                        // and if this model has a primary key, remember its mapping
-                        if ($model->has_primary_key_field()) {
-                            $old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ] = $conflicting->ID();
-                            $model_object_data[ $model->primary_key_name() ] = $conflicting->ID();
-                        } else {
-                            // we want to update this conflicting item, instead of inserting a conflicting item
-                            // so we need to make sure they match entirely (its possible that they only conflicted on one field, but we need them to match on other fields
-                            // for the WHERE conditions in the update). At the time of this comment, there were no models like this
-                            foreach ($model->get_combined_primary_key_fields() as $key_field) {
-                                $model_object_data[ $key_field->get_name() ] = $conflicting->get(
-                                    $key_field->get_name()
-                                );
-                            }
-                        }
-                    }
-                }
-                if ($what_to_do == self::do_insert) {
-                    $old_db_to_new_db_mapping = $this->_insert_from_data_array(
-                        $id_in_csv,
-                        $model_object_data,
-                        $model,
-                        $old_db_to_new_db_mapping
-                    );
-                } elseif ($what_to_do == self::do_update) {
-                    $old_db_to_new_db_mapping = $this->_update_from_data_array(
-                        $id_in_csv,
-                        $model_object_data,
-                        $model,
-                        $old_db_to_new_db_mapping
-                    );
-                } else {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                'Programming error. We shoudl be inserting or updating, but instead we are being told to "%s", whifh is invalid',
-                                'event_espresso'
-                            ),
-                            $what_to_do
-                        )
-                    );
-                }
-            }
-        }
-        return $old_db_to_new_db_mapping;
-    }
-
-
-    /**
-     * Decides whether or not to insert, given that this data is from another database.
-     * So, if the primary key of this $model_object_data already exists in the database,
-     * it's just a coincidence and we should still insert. The only time we should
-     * update is when we know what it maps to, or there's something that would
-     * conflict (and we should instead just update that conflicting thing)
-     *
-     * @param string   $id_in_csv
-     * @param array    $model_object_data        by reference so it can be modified
-     * @param EEM_Base $model
-     * @param array    $old_db_to_new_db_mapping by reference so it can be modified
-     * @return string one of the consts on this class that starts with do_*
-     */
-    protected function _decide_whether_to_insert_or_update_given_data_from_other_db(
-        $id_in_csv,
-        $model_object_data,
-        $model,
-        $old_db_to_new_db_mapping
-    ) {
-        $model_name = $model->get_this_model_name();
-        // if it's a site-to-site export-and-import, see if this modelobject's id
-        // in the old data that we know of
-        if (isset($old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ])) {
-            return self::do_update;
-        } else {
-            return self::do_insert;
-        }
-    }
-
-    /**
-     * If this thing basically already exists in the database, we want to update it;
-     * otherwise insert it (ie, someone tweaked the CSV file, or the item was
-     * deleted in the database so it should be re-inserted)
-     *
-     * @param type     $id_in_csv
-     * @param type     $model_object_data
-     * @param EEM_Base $model
-     * @param type     $old_db_to_new_db_mapping
-     * @return
-     */
-    protected function _decide_whether_to_insert_or_update_given_data_from_same_db(
-        $id_in_csv,
-        $model_object_data,
-        $model
-    ) {
-        // in this case, check if this thing ACTUALLY exists in the database
-        if ($model->get_one_conflicting($model_object_data)) {
-            return self::do_update;
-        } else {
-            return self::do_insert;
-        }
-    }
-
-    /**
-     * Using the $old_db_to_new_db_mapping array, replaces all the temporary IDs
-     * with their mapped real IDs. Eg, if importing from site A to B, the mapping
-     * file may indicate that the ID "my_event_id" maps to an actual event ID of 123.
-     * So this function searches for any event temp Ids called "my_event_id" and
-     * replaces them with 123.
-     * Also, if there is no temp ID for the INT foreign keys from another database,
-     * replaces them with 0 or the field's default.
-     *
-     * @param type     $model_object_data
-     * @param EEM_Base $model
-     * @param type     $old_db_to_new_db_mapping
-     * @param boolean  $export_from_site_a_to_b
-     * @return array updated model object data with temp IDs removed
-     */
-    protected function _replace_temp_ids_with_mappings(
-        $model_object_data,
-        $model,
-        $old_db_to_new_db_mapping,
-        $export_from_site_a_to_b
-    ) {
-        // if this model object's primary key is in the mapping, replace it
-        if (
-            $model->has_primary_key_field() &&
-            $model->get_primary_key_field()->is_auto_increment() &&
-            isset($old_db_to_new_db_mapping[ $model->get_this_model_name() ]) &&
-            isset(
-                $old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $model_object_data[ $model->primary_key_name() ] ]
-            )
-        ) {
-            $model_object_data[ $model->primary_key_name() ] = $old_db_to_new_db_mapping[ $model->get_this_model_name(
-            ) ][ $model_object_data[ $model->primary_key_name() ] ];
-        }
-
-        try {
-            $model_name_field = $model->get_field_containing_related_model_name();
-            $models_pointed_to_by_model_name_field = $model_name_field->get_model_names_pointed_to();
-        } catch (EE_Error $e) {
-            $model_name_field = null;
-            $models_pointed_to_by_model_name_field = array();
-        }
-        foreach ($model->field_settings(true) as $field_obj) {
-            if ($field_obj instanceof EE_Foreign_Key_Int_Field) {
-                $models_pointed_to = $field_obj->get_model_names_pointed_to();
-                $found_a_mapping = false;
-                foreach ($models_pointed_to as $model_pointed_to_by_fk) {
-                    if ($model_name_field) {
-                        $value_of_model_name_field = $model_object_data[ $model_name_field->get_name() ];
-                        if ($value_of_model_name_field == $model_pointed_to_by_fk) {
-                            $model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
-                                $model_object_data[ $field_obj->get_name() ],
-                                $model_pointed_to_by_fk,
-                                $old_db_to_new_db_mapping,
-                                $export_from_site_a_to_b
-                            );
-                            $found_a_mapping = true;
-                            break;
-                        }
-                    } else {
-                        $model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
-                            $model_object_data[ $field_obj->get_name() ],
-                            $model_pointed_to_by_fk,
-                            $old_db_to_new_db_mapping,
-                            $export_from_site_a_to_b
-                        );
-                        $found_a_mapping = true;
-                    }
-                    // once we've found a mapping for this field no need to continue
-                    if ($found_a_mapping) {
-                        break;
-                    }
-                }
-            } else {
-                // it's a string foreign key (which we leave alone, because those are things
-                // like country names, which we'd really rather not make 2 USAs etc (we'd actually
-                // prefer to just update one)
-                // or it's just a regular value that ought to be replaced
-            }
-        }
-        //
-        if ($model instanceof EEM_Term_Taxonomy) {
-            $model_object_data = $this->_handle_split_term_ids($model_object_data);
-        }
-        return $model_object_data;
-    }
-
-    /**
-     * If the data was exported PRE-4.2, but then imported POST-4.2, then the term_id
-     * this term-taxonomy refers to may be out-of-date so we need to update it.
-     * see https://make.wordpress.org/core/2015/02/16/taxonomy-term-splitting-in-4-2-a-developer-guide/
-     *
-     * @param type $model_object_data
-     * @return array new model object data
-     */
-    protected function _handle_split_term_ids($model_object_data)
-    {
-        if (
-            isset($model_object_data['term_id'])
-            && isset($model_object_data['taxonomy'])
-            && apply_filters(
-                'FHEE__EE_Import__handle_split_term_ids__function_exists',
-                function_exists('wp_get_split_term'),
-                $model_object_data
-            )
-        ) {
-            $new_term_id = wp_get_split_term($model_object_data['term_id'], $model_object_data['taxonomy']);
-            if ($new_term_id) {
-                $model_object_data['term_id'] = $new_term_id;
-            }
-        }
-        return $model_object_data;
-    }
-
-    /**
-     * Given the object's ID and its model's name, find it int he mapping data,
-     * bearing in mind where it came from
-     *
-     * @param type   $object_id
-     * @param string $model_name
-     * @param array  $old_db_to_new_db_mapping
-     * @param type   $export_from_site_a_to_b
-     * @return int
-     */
-    protected function _find_mapping_in($object_id, $model_name, $old_db_to_new_db_mapping, $export_from_site_a_to_b)
-    {
-        if (isset($old_db_to_new_db_mapping[ $model_name ][ $object_id ])) {
-            return $old_db_to_new_db_mapping[ $model_name ][ $object_id ];
-        } elseif ($object_id == '0' || $object_id == '') {
-            // leave as-is
-            return $object_id;
-        } elseif ($export_from_site_a_to_b) {
-            // we couldn't find a mapping for this, and it's from a different site,
-            // so blank it out
-            return null;
-        } elseif (! $export_from_site_a_to_b) {
-            // we coudln't find a mapping for this, but it's from thsi DB anyway
-            // so let's just leave it as-is
-            return $object_id;
-        }
-    }
-
-    /**
-     *
-     * @param type     $id_in_csv
-     * @param type     $model_object_data
-     * @param EEM_Base $model
-     * @param type     $old_db_to_new_db_mapping
-     * @return array updated $old_db_to_new_db_mapping
-     */
-    protected function _insert_from_data_array($id_in_csv, $model_object_data, $model, $old_db_to_new_db_mapping)
-    {
-        // remove the primary key, if there is one (we don't want it for inserts OR updates)
-        // we'll put it back in if we need it
-        if ($model->has_primary_key_field() && $model->get_primary_key_field()->is_auto_increment()) {
-            $effective_id = $model_object_data[ $model->primary_key_name() ];
-            unset($model_object_data[ $model->primary_key_name() ]);
-        } else {
-            $effective_id = $model->get_index_primary_key_string($model_object_data);
-        }
-        // the model takes care of validating the CSV's input
-        try {
-            $new_id = $model->insert($model_object_data);
-            if ($new_id) {
-                $old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_id;
-                $this->_total_inserts++;
-                EE_Error::add_success(
-                    sprintf(
-                        esc_html__("Successfully added new %s (with id %s) with csv data %s", "event_espresso"),
-                        $model->get_this_model_name(),
-                        $new_id,
-                        implode(",", $model_object_data)
-                    )
-                );
-            } else {
-                $this->_total_insert_errors++;
-                // put the ID used back in there for the error message
-                if ($model->has_primary_key_field()) {
-                    $model_object_data[ $model->primary_key_name() ] = $effective_id;
-                }
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__("Could not insert new %s with the csv data: %s", "event_espresso"),
-                        $model->get_this_model_name(),
-                        http_build_query($model_object_data)
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        } catch (EE_Error $e) {
-            $this->_total_insert_errors++;
-            if ($model->has_primary_key_field()) {
-                $model_object_data[ $model->primary_key_name() ] = $effective_id;
-            }
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__("Could not insert new %s with the csv data: %s because %s", "event_espresso"),
-                    $model->get_this_model_name(),
-                    implode(",", $model_object_data),
-                    $e->getMessage()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return $old_db_to_new_db_mapping;
-    }
-
-    /**
-     * Given the model object data, finds the row to update and updates it
-     *
-     * @param string|int $id_in_csv
-     * @param array      $model_object_data
-     * @param EEM_Base   $model
-     * @param array      $old_db_to_new_db_mapping
-     * @return array updated $old_db_to_new_db_mapping
-     */
-    protected function _update_from_data_array($id_in_csv, $model_object_data, $model, $old_db_to_new_db_mapping)
-    {
-        try {
-            // let's keep two copies of the model object data:
-            // one for performing an update, one for everthing else
-            $model_object_data_for_update = $model_object_data;
-            if ($model->has_primary_key_field()) {
-                $conditions = array($model->primary_key_name() => $model_object_data[ $model->primary_key_name() ]);
-                // remove the primary key because we shouldn't use it for updating
-                unset($model_object_data_for_update[ $model->primary_key_name() ]);
-            } elseif ($model->get_combined_primary_key_fields() > 1) {
-                $conditions = array();
-                foreach ($model->get_combined_primary_key_fields() as $key_field) {
-                    $conditions[ $key_field->get_name() ] = $model_object_data[ $key_field->get_name() ];
-                }
-            } else {
-                $model->primary_key_name(
-                );// this shoudl just throw an exception, explaining that we dont have a primary key (or a combine dkey)
-            }
-
-            $success = $model->update($model_object_data_for_update, array($conditions));
-            if ($success) {
-                $this->_total_updates++;
-                EE_Error::add_success(
-                    sprintf(
-                        esc_html__("Successfully updated %s with csv data %s", "event_espresso"),
-                        $model->get_this_model_name(),
-                        implode(",", $model_object_data_for_update)
-                    )
-                );
-                // we should still record the mapping even though it was an update
-                // because if we were going to insert somethign but it was going to conflict
-                // we would have last-minute decided to update. So we'd like to know what we updated
-                // and so we record what record ended up being updated using the mapping
-                if ($model->has_primary_key_field()) {
-                    $new_key_for_mapping = $model_object_data[ $model->primary_key_name() ];
-                } else {
-                    // no primary key just a combined key
-                    $new_key_for_mapping = $model->get_index_primary_key_string($model_object_data);
-                }
-                $old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_key_for_mapping;
-            } else {
-                $matched_items = $model->get_all(array($conditions));
-                if (! $matched_items) {
-                    // no items were matched (so we shouldn't have updated)... but then we should have inserted? what the heck?
-                    $this->_total_update_errors++;
-                    EE_Error::add_error(
-                        sprintf(
-                            esc_html__(
-                                "Could not update %s with the csv data: '%s' for an unknown reason (using WHERE conditions %s)",
-                                "event_espresso"
-                            ),
-                            $model->get_this_model_name(),
-                            http_build_query($model_object_data),
-                            http_build_query($conditions)
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                } else {
-                    $this->_total_updates++;
-                    EE_Error::add_success(
-                        sprintf(
-                            esc_html__(
-                                "%s with csv data '%s' was found in the database and didn't need updating because all the data is identical.",
-                                "event_espresso"
-                            ),
-                            $model->get_this_model_name(),
-                            implode(",", $model_object_data)
-                        )
-                    );
-                }
-            }
-        } catch (EE_Error $e) {
-            $this->_total_update_errors++;
-            $basic_message = sprintf(
-                esc_html__("Could not update %s with the csv data: %s because %s", "event_espresso"),
-                $model->get_this_model_name(),
-                implode(",", $model_object_data),
-                $e->getMessage()
-            );
-            $debug_message = $basic_message . ' Stack trace: ' . $e->getTraceAsString();
-            EE_Error::add_error("$basic_message | $debug_message", __FILE__, __FUNCTION__, __LINE__);
-        }
-        return $old_db_to_new_db_mapping;
-    }
-
-    /**
-     * Gets the number of inserts performed since importer was instantiated or reset
-     *
-     * @return int
-     */
-    public function get_total_inserts()
-    {
-        return $this->_total_inserts;
-    }
-
-    /**
-     *  Gets the number of insert errors since importer was instantiated or reset
-     *
-     * @return int
-     */
-    public function get_total_insert_errors()
-    {
-        return $this->_total_insert_errors;
-    }
-
-    /**
-     *  Gets the number of updates performed since importer was instantiated or reset
-     *
-     * @return int
-     */
-    public function get_total_updates()
-    {
-        return $this->_total_updates;
-    }
-
-    /**
-     *  Gets the number of update errors since importer was instantiated or reset
-     *
-     * @return int
-     */
-    public function get_total_update_errors()
-    {
-        return $this->_total_update_errors;
-    }
+		$uploader = ob_get_clean();
+		return $uploader;
+	}
+
+
+	/**
+	 * @Import Event Espresso data - some code "borrowed" from event espresso csv_import.php
+	 * @access public
+	 * @return boolean success
+	 */
+	public function import()
+	{
+
+		require_once(EE_CLASSES . 'EE_CSV.class.php');
+		$this->EE_CSV = EE_CSV::instance();
+
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+
+		if ($request->requestParamIsSet('import') && $request->requestParamIsSet('csv_submitted')) {
+			$files = $request->filesParams();
+			switch ($files['file']['error'][0]) {
+				case UPLOAD_ERR_OK:
+					$error_msg = false;
+					break;
+				case UPLOAD_ERR_INI_SIZE:
+					$error_msg = esc_html__(
+						"'The uploaded file exceeds the upload_max_filesize directive in php.ini.'",
+						"event_espresso"
+					);
+					break;
+				case UPLOAD_ERR_FORM_SIZE:
+					$error_msg = esc_html__(
+						'The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form.',
+						"event_espresso"
+					);
+					break;
+				case UPLOAD_ERR_PARTIAL:
+					$error_msg = esc_html__('The uploaded file was only partially uploaded.', "event_espresso");
+					break;
+				case UPLOAD_ERR_NO_FILE:
+					$error_msg = esc_html__('No file was uploaded.', "event_espresso");
+					break;
+				case UPLOAD_ERR_NO_TMP_DIR:
+					$error_msg = esc_html__('Missing a temporary folder.', "event_espresso");
+					break;
+				case UPLOAD_ERR_CANT_WRITE:
+					$error_msg = esc_html__('Failed to write file to disk.', "event_espresso");
+					break;
+				case UPLOAD_ERR_EXTENSION:
+					$error_msg = esc_html__('File upload stopped by extension.', "event_espresso");
+					break;
+				default:
+					$error_msg = esc_html__(
+						'An unknown error occurred and the file could not be uploaded',
+						"event_espresso"
+					);
+					break;
+			}
+
+			if (! $error_msg) {
+				$filename = $files['file']['name'][0];
+				$file_ext = substr(strrchr($filename, '.'), 1);
+				$file_type = $files['file']['type'][0];
+				$temp_file = $files['file']['tmp_name'][0];
+				$filesize = $files['file']['size'][0] / 1024;// convert from bytes to KB
+
+				if ($file_ext == 'csv') {
+					$max_upload = $this->EE_CSV->get_max_upload_size();// max upload size in KB
+					if ($filesize < $max_upload || true) {
+						$wp_upload_dir = str_replace(array('\\', '/'), '/', wp_upload_dir());
+						$path_to_file = $wp_upload_dir['basedir'] . '/espresso/' . $filename;
+
+						if (move_uploaded_file($temp_file, $path_to_file)) {
+							// convert csv to array
+							$this->csv_array = $this->EE_CSV->import_csv_to_model_data_array($path_to_file);
+
+							$action = $request->getRequestParam('action');
+
+							// was data successfully stored in an array?
+							if (is_array($this->csv_array)) {
+								$import_what = str_replace('csv_import_', '', $action);
+								$import_what = str_replace('_', ' ', ucwords($import_what));
+								$processed_data = $this->csv_array;
+								$this->columns_to_save = false;
+
+								// if any imports require funky processing, we'll catch them in the switch
+								switch ($action) {
+									case "import_events":
+									case "event_list":
+										$import_what = 'Event Details';
+										break;
+
+									case 'groupon_import_csv':
+										$import_what = 'Groupon Codes';
+										$processed_data = $this->process_groupon_codes();
+										break;
+								}
+								// save processed codes to db
+								if ($this->save_csv_data_array_to_db($processed_data, $this->columns_to_save)) {
+									return true;
+								}
+							} else {
+								// no array? must be an error
+								EE_Error::add_error(
+									sprintf(esc_html__("No file seems to have been uploaded", "event_espresso")),
+									__FILE__,
+									__FUNCTION__,
+									__LINE__
+								);
+								return false;
+							}
+						} else {
+							EE_Error::add_error(
+								sprintf(esc_html__("%s was not successfully uploaded", "event_espresso"), $filename),
+								__FILE__,
+								__FUNCTION__,
+								__LINE__
+							);
+							return false;
+						}
+					} else {
+						EE_Error::add_error(
+							sprintf(
+								esc_html__(
+									"%s was too large of a file and could not be uploaded. The max filesize is %s' KB.",
+									"event_espresso"
+								),
+								$filename,
+								$max_upload
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+						return false;
+					}
+				} else {
+					EE_Error::add_error(
+						sprintf(esc_html__("%s  had an invalid file extension, not uploaded", "event_espresso"), $filename),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+				}
+			} else {
+				EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+				return false;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 *    Given an array of data (usually from a CSV import) attempts to save that data to the db.
+	 *    If $model_name ISN'T provided, assumes that this is a 3d array, with toplevel keys being model names,
+	 *    next level being numeric indexes adn each value representing a model object, and the last layer down
+	 *    being keys of model fields and their proposed values.
+	 *    If $model_name IS provided, assumes a 2d array of the bottom two layers previously mentioned.
+	 *    If the CSV data says (in the metadata row) that it's from the SAME database,
+	 *    we treat the IDs in the CSV as the normal IDs, and try to update those records. However, if those
+	 *    IDs DON'T exist in the database, they're treated as temporary IDs,
+	 *    which can used elsewhere to refer to the same object. Once an item
+	 *    with a temporary ID gets inserted, we record its mapping from temporary
+	 *    ID to real ID, and use the real ID in place of the temporary ID
+	 *    when that temporary ID was used as a foreign key.
+	 *    If the CSV data says (in the metadata again) that it's from a DIFFERENT database,
+	 *    we treat all the IDs in the CSV as temporary ID- eg, if the CSV specifies an event with
+	 *    ID 1, and the database already has an event with ID 1, we assume that's just a coincidence,
+	 *    and insert a new event, and map it's temporary ID of 1 over to its new real ID.
+	 *    An important exception are non-auto-increment primary keys. If one entry in the
+	 *    CSV file has the same ID as one in the DB, we assume they are meant to be
+	 *    the same item, and instead update the item in the DB with that same ID.
+	 *    Also note, we remember the mappings permanently. So the 2nd, 3rd, and 10000th
+	 *    time you import a CSV from a different site, we remember their mappings, and
+	 * will try to update the item in the DB instead of inserting another item (eg
+	 * if we previously imported an event with temporary ID 1, and then it got a
+	 * real ID of 123, we remember that. So the next time we import an event with
+	 * temporary ID, from the same site, we know that it's real ID is 123, and will
+	 * update that event, instead of adding a new event).
+	 *
+	 * @access public
+	 * @param array $csv_data_array - the array containing the csv data produced from
+	 *                              EE_CSV::import_csv_to_model_data_array()
+	 * @param array $fields_to_save - an array containing the csv column names as keys with the corresponding db table
+	 *                              fields they will be saved to
+	 * @return TRUE on success, FALSE on fail
+	 * @throws \EE_Error
+	 */
+	public function save_csv_data_array_to_db($csv_data_array, $model_name = false)
+	{
+		$success = false;
+		$error = false;
+		// whther to treat this import as if it's data froma different database or not
+		// ie, if it IS from a different database, ignore foreign keys whihf
+		$export_from_site_a_to_b = true;
+		// first level of array is not table information but a table name was passed to the function
+		// array is only two levels deep, so let's fix that by adding a level, else the next steps will fail
+		if ($model_name) {
+			$csv_data_array = array($csv_data_array);
+		}
+		// begin looking through the $csv_data_array, expecting the toplevel key to be the model's name...
+		$old_site_url = 'none-specified';
+		// hanlde metadata
+		if (isset($csv_data_array[ EE_CSV::metadata_header ])) {
+			$csv_metadata = array_shift($csv_data_array[ EE_CSV::metadata_header ]);
+			// ok so its metadata, dont try to save it to ehte db obviously...
+			if (isset($csv_metadata['site_url']) && $csv_metadata['site_url'] == site_url()) {
+				EE_Error::add_attention(
+					sprintf(
+						esc_html__(
+							"CSV Data appears to be from the same database, so attempting to update data",
+							"event_espresso"
+						)
+					)
+				);
+				$export_from_site_a_to_b = false;
+			} else {
+				$old_site_url = isset($csv_metadata['site_url']) ? $csv_metadata['site_url'] : $old_site_url;
+				EE_Error::add_attention(
+					sprintf(
+						esc_html__(
+							"CSV Data appears to be from a different database (%s instead of %s), so we assume IDs in the CSV data DO NOT correspond to IDs in this database",
+							"event_espresso"
+						),
+						$old_site_url,
+						site_url()
+					)
+				);
+			};
+			unset($csv_data_array[ EE_CSV::metadata_header ]);
+		}
+		/**
+		 * @var $old_db_to_new_db_mapping 2d array: toplevel keys being model names, bottom-level keys being the original key, and
+		 * the value will be the newly-inserted ID.
+		 * If we have already imported data from the same website via CSV, it shoudl be kept in this wp option
+		 */
+		$old_db_to_new_db_mapping = get_option('ee_id_mapping_from' . sanitize_title($old_site_url), array());
+		if ($old_db_to_new_db_mapping) {
+			EE_Error::add_attention(
+				sprintf(
+					esc_html__(
+						"We noticed you have imported data via CSV from %s before. Because of this, IDs in your CSV have been mapped to their new IDs in %s",
+						"event_espresso"
+					),
+					$old_site_url,
+					site_url()
+				)
+			);
+		}
+		$old_db_to_new_db_mapping = $this->save_data_rows_to_db(
+			$csv_data_array,
+			$export_from_site_a_to_b,
+			$old_db_to_new_db_mapping
+		);
+
+		// save the mapping from old db to new db in case they try re-importing the same data from the same website again
+		update_option('ee_id_mapping_from' . sanitize_title($old_site_url), $old_db_to_new_db_mapping);
+
+		if ($this->_total_updates > 0) {
+			EE_Error::add_success(
+				sprintf(
+					esc_html__("%s existing records in the database were updated.", "event_espresso"),
+					$this->_total_updates
+				)
+			);
+			$success = true;
+		}
+		if ($this->_total_inserts > 0) {
+			EE_Error::add_success(
+				sprintf(esc_html__("%s new records were added to the database.", "event_espresso"), $this->_total_inserts)
+			);
+			$success = true;
+		}
+
+		if ($this->_total_update_errors > 0) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						"'One or more errors occurred, and a total of %s existing records in the database were <strong>not</strong> updated.'",
+						"event_espresso"
+					),
+					$this->_total_update_errors
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$error = true;
+		}
+		if ($this->_total_insert_errors > 0) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						"One or more errors occurred, and a total of %s new records were <strong>not</strong> added to the database.'",
+						"event_espresso"
+					),
+					$this->_total_insert_errors
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$error = true;
+		}
+
+		// lastly, we need to update the datetime and ticket sold amounts
+		// as those may have been affected by this
+		EEM_Ticket::instance()->update_tickets_sold(EEM_Ticket::instance()->get_all());
+
+		// if there was at least one success and absolutely no errors
+		if ($success && ! $error) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Processes the array of data, given the knowledge that it's from the same database or a different one,
+	 * and the mapping from temporary IDs to real IDs.
+	 * If the data is from a different database, we treat the primary keys and their corresponding
+	 * foreign keys as "temp Ids", basically identifiers that get mapped to real primary keys
+	 * in the real target database. As items are inserted, their temporary primary keys
+	 * are mapped to the real IDs in the target database. Also, before doing any update or
+	 * insert, we replace all the temp ID which are foreign keys with their mapped real IDs.
+	 * An exception: string primary keys are treated as real IDs, or else we'd need to
+	 * dynamically generate new string primary keys which would be very awkard for the country table etc.
+	 * Also, models with no primary key are strange too. We combine use their primar key INDEX (a
+	 * combination of fields) to create a unique string identifying the row and store
+	 * those in the mapping.
+	 *
+	 * If the data is from the same database, we usually treat primary keys as real IDs.
+	 * An exception is if there is nothing in the database for that ID. If that's the case,
+	 * we need to insert a new row for that ID, and then map from the non-existent ID
+	 * to the newly-inserted real ID.
+	 *
+	 * @param type $csv_data_array
+	 * @param type $export_from_site_a_to_b
+	 * @param type $old_db_to_new_db_mapping
+	 * @return array updated $old_db_to_new_db_mapping
+	 */
+	public function save_data_rows_to_db($csv_data_array, $export_from_site_a_to_b, $old_db_to_new_db_mapping)
+	{
+		foreach ($csv_data_array as $model_name_in_csv_data => $model_data_from_import) {
+			// now check that assumption was correct. If
+			if (EE_Registry::instance()->is_model_name($model_name_in_csv_data)) {
+				$model_name = $model_name_in_csv_data;
+			} else {
+				// no table info in the array and no table name passed to the function?? FAIL
+				EE_Error::add_error(
+					esc_html__(
+						'No table information was specified and/or found, therefore the import could not be completed',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+			/* @var $model EEM_Base */
+			$model = EE_Registry::instance()->load_model($model_name);
+
+			// so without further ado, scanning all the data provided for primary keys and their inital values
+			foreach ($model_data_from_import as $model_object_data) {
+				// before we do ANYTHING, make sure the csv row wasn't just completely blank
+				$row_is_completely_empty = true;
+				foreach ($model_object_data as $field) {
+					if ($field) {
+						$row_is_completely_empty = false;
+					}
+				}
+				if ($row_is_completely_empty) {
+					continue;
+				}
+				// find the PK in the row of data (or a combined key if
+				// there is no primary key)
+				if ($model->has_primary_key_field()) {
+					$id_in_csv = $model_object_data[ $model->primary_key_name() ];
+				} else {
+					$id_in_csv = $model->get_index_primary_key_string($model_object_data);
+				}
+
+
+				$model_object_data = $this->_replace_temp_ids_with_mappings(
+					$model_object_data,
+					$model,
+					$old_db_to_new_db_mapping,
+					$export_from_site_a_to_b
+				);
+				// now we need to decide if we're going to add a new model object given the $model_object_data,
+				// or just update.
+				if ($export_from_site_a_to_b) {
+					$what_to_do = $this->_decide_whether_to_insert_or_update_given_data_from_other_db(
+						$id_in_csv,
+						$model_object_data,
+						$model,
+						$old_db_to_new_db_mapping
+					);
+				} else {// this is just a re-import
+					$what_to_do = $this->_decide_whether_to_insert_or_update_given_data_from_same_db(
+						$id_in_csv,
+						$model_object_data,
+						$model,
+						$old_db_to_new_db_mapping
+					);
+				}
+				if ($what_to_do == self::do_nothing) {
+					continue;
+				}
+
+				// double-check we actually want to insert, if that's what we're planning
+				// based on whether this item would be unique in the DB or not
+				if ($what_to_do == self::do_insert) {
+					// we're supposed to be inserting. But wait, will this thing
+					// be acceptable if inserted?
+					$conflicting = $model->get_one_conflicting($model_object_data, false);
+					if ($conflicting) {
+						// ok, this item would conflict if inserted. Just update the item that it conflicts with.
+						$what_to_do = self::do_update;
+						// and if this model has a primary key, remember its mapping
+						if ($model->has_primary_key_field()) {
+							$old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ] = $conflicting->ID();
+							$model_object_data[ $model->primary_key_name() ] = $conflicting->ID();
+						} else {
+							// we want to update this conflicting item, instead of inserting a conflicting item
+							// so we need to make sure they match entirely (its possible that they only conflicted on one field, but we need them to match on other fields
+							// for the WHERE conditions in the update). At the time of this comment, there were no models like this
+							foreach ($model->get_combined_primary_key_fields() as $key_field) {
+								$model_object_data[ $key_field->get_name() ] = $conflicting->get(
+									$key_field->get_name()
+								);
+							}
+						}
+					}
+				}
+				if ($what_to_do == self::do_insert) {
+					$old_db_to_new_db_mapping = $this->_insert_from_data_array(
+						$id_in_csv,
+						$model_object_data,
+						$model,
+						$old_db_to_new_db_mapping
+					);
+				} elseif ($what_to_do == self::do_update) {
+					$old_db_to_new_db_mapping = $this->_update_from_data_array(
+						$id_in_csv,
+						$model_object_data,
+						$model,
+						$old_db_to_new_db_mapping
+					);
+				} else {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								'Programming error. We shoudl be inserting or updating, but instead we are being told to "%s", whifh is invalid',
+								'event_espresso'
+							),
+							$what_to_do
+						)
+					);
+				}
+			}
+		}
+		return $old_db_to_new_db_mapping;
+	}
+
+
+	/**
+	 * Decides whether or not to insert, given that this data is from another database.
+	 * So, if the primary key of this $model_object_data already exists in the database,
+	 * it's just a coincidence and we should still insert. The only time we should
+	 * update is when we know what it maps to, or there's something that would
+	 * conflict (and we should instead just update that conflicting thing)
+	 *
+	 * @param string   $id_in_csv
+	 * @param array    $model_object_data        by reference so it can be modified
+	 * @param EEM_Base $model
+	 * @param array    $old_db_to_new_db_mapping by reference so it can be modified
+	 * @return string one of the consts on this class that starts with do_*
+	 */
+	protected function _decide_whether_to_insert_or_update_given_data_from_other_db(
+		$id_in_csv,
+		$model_object_data,
+		$model,
+		$old_db_to_new_db_mapping
+	) {
+		$model_name = $model->get_this_model_name();
+		// if it's a site-to-site export-and-import, see if this modelobject's id
+		// in the old data that we know of
+		if (isset($old_db_to_new_db_mapping[ $model_name ][ $id_in_csv ])) {
+			return self::do_update;
+		} else {
+			return self::do_insert;
+		}
+	}
+
+	/**
+	 * If this thing basically already exists in the database, we want to update it;
+	 * otherwise insert it (ie, someone tweaked the CSV file, or the item was
+	 * deleted in the database so it should be re-inserted)
+	 *
+	 * @param type     $id_in_csv
+	 * @param type     $model_object_data
+	 * @param EEM_Base $model
+	 * @param type     $old_db_to_new_db_mapping
+	 * @return
+	 */
+	protected function _decide_whether_to_insert_or_update_given_data_from_same_db(
+		$id_in_csv,
+		$model_object_data,
+		$model
+	) {
+		// in this case, check if this thing ACTUALLY exists in the database
+		if ($model->get_one_conflicting($model_object_data)) {
+			return self::do_update;
+		} else {
+			return self::do_insert;
+		}
+	}
+
+	/**
+	 * Using the $old_db_to_new_db_mapping array, replaces all the temporary IDs
+	 * with their mapped real IDs. Eg, if importing from site A to B, the mapping
+	 * file may indicate that the ID "my_event_id" maps to an actual event ID of 123.
+	 * So this function searches for any event temp Ids called "my_event_id" and
+	 * replaces them with 123.
+	 * Also, if there is no temp ID for the INT foreign keys from another database,
+	 * replaces them with 0 or the field's default.
+	 *
+	 * @param type     $model_object_data
+	 * @param EEM_Base $model
+	 * @param type     $old_db_to_new_db_mapping
+	 * @param boolean  $export_from_site_a_to_b
+	 * @return array updated model object data with temp IDs removed
+	 */
+	protected function _replace_temp_ids_with_mappings(
+		$model_object_data,
+		$model,
+		$old_db_to_new_db_mapping,
+		$export_from_site_a_to_b
+	) {
+		// if this model object's primary key is in the mapping, replace it
+		if (
+			$model->has_primary_key_field() &&
+			$model->get_primary_key_field()->is_auto_increment() &&
+			isset($old_db_to_new_db_mapping[ $model->get_this_model_name() ]) &&
+			isset(
+				$old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $model_object_data[ $model->primary_key_name() ] ]
+			)
+		) {
+			$model_object_data[ $model->primary_key_name() ] = $old_db_to_new_db_mapping[ $model->get_this_model_name(
+			) ][ $model_object_data[ $model->primary_key_name() ] ];
+		}
+
+		try {
+			$model_name_field = $model->get_field_containing_related_model_name();
+			$models_pointed_to_by_model_name_field = $model_name_field->get_model_names_pointed_to();
+		} catch (EE_Error $e) {
+			$model_name_field = null;
+			$models_pointed_to_by_model_name_field = array();
+		}
+		foreach ($model->field_settings(true) as $field_obj) {
+			if ($field_obj instanceof EE_Foreign_Key_Int_Field) {
+				$models_pointed_to = $field_obj->get_model_names_pointed_to();
+				$found_a_mapping = false;
+				foreach ($models_pointed_to as $model_pointed_to_by_fk) {
+					if ($model_name_field) {
+						$value_of_model_name_field = $model_object_data[ $model_name_field->get_name() ];
+						if ($value_of_model_name_field == $model_pointed_to_by_fk) {
+							$model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
+								$model_object_data[ $field_obj->get_name() ],
+								$model_pointed_to_by_fk,
+								$old_db_to_new_db_mapping,
+								$export_from_site_a_to_b
+							);
+							$found_a_mapping = true;
+							break;
+						}
+					} else {
+						$model_object_data[ $field_obj->get_name() ] = $this->_find_mapping_in(
+							$model_object_data[ $field_obj->get_name() ],
+							$model_pointed_to_by_fk,
+							$old_db_to_new_db_mapping,
+							$export_from_site_a_to_b
+						);
+						$found_a_mapping = true;
+					}
+					// once we've found a mapping for this field no need to continue
+					if ($found_a_mapping) {
+						break;
+					}
+				}
+			} else {
+				// it's a string foreign key (which we leave alone, because those are things
+				// like country names, which we'd really rather not make 2 USAs etc (we'd actually
+				// prefer to just update one)
+				// or it's just a regular value that ought to be replaced
+			}
+		}
+		//
+		if ($model instanceof EEM_Term_Taxonomy) {
+			$model_object_data = $this->_handle_split_term_ids($model_object_data);
+		}
+		return $model_object_data;
+	}
+
+	/**
+	 * If the data was exported PRE-4.2, but then imported POST-4.2, then the term_id
+	 * this term-taxonomy refers to may be out-of-date so we need to update it.
+	 * see https://make.wordpress.org/core/2015/02/16/taxonomy-term-splitting-in-4-2-a-developer-guide/
+	 *
+	 * @param type $model_object_data
+	 * @return array new model object data
+	 */
+	protected function _handle_split_term_ids($model_object_data)
+	{
+		if (
+			isset($model_object_data['term_id'])
+			&& isset($model_object_data['taxonomy'])
+			&& apply_filters(
+				'FHEE__EE_Import__handle_split_term_ids__function_exists',
+				function_exists('wp_get_split_term'),
+				$model_object_data
+			)
+		) {
+			$new_term_id = wp_get_split_term($model_object_data['term_id'], $model_object_data['taxonomy']);
+			if ($new_term_id) {
+				$model_object_data['term_id'] = $new_term_id;
+			}
+		}
+		return $model_object_data;
+	}
+
+	/**
+	 * Given the object's ID and its model's name, find it int he mapping data,
+	 * bearing in mind where it came from
+	 *
+	 * @param type   $object_id
+	 * @param string $model_name
+	 * @param array  $old_db_to_new_db_mapping
+	 * @param type   $export_from_site_a_to_b
+	 * @return int
+	 */
+	protected function _find_mapping_in($object_id, $model_name, $old_db_to_new_db_mapping, $export_from_site_a_to_b)
+	{
+		if (isset($old_db_to_new_db_mapping[ $model_name ][ $object_id ])) {
+			return $old_db_to_new_db_mapping[ $model_name ][ $object_id ];
+		} elseif ($object_id == '0' || $object_id == '') {
+			// leave as-is
+			return $object_id;
+		} elseif ($export_from_site_a_to_b) {
+			// we couldn't find a mapping for this, and it's from a different site,
+			// so blank it out
+			return null;
+		} elseif (! $export_from_site_a_to_b) {
+			// we coudln't find a mapping for this, but it's from thsi DB anyway
+			// so let's just leave it as-is
+			return $object_id;
+		}
+	}
+
+	/**
+	 *
+	 * @param type     $id_in_csv
+	 * @param type     $model_object_data
+	 * @param EEM_Base $model
+	 * @param type     $old_db_to_new_db_mapping
+	 * @return array updated $old_db_to_new_db_mapping
+	 */
+	protected function _insert_from_data_array($id_in_csv, $model_object_data, $model, $old_db_to_new_db_mapping)
+	{
+		// remove the primary key, if there is one (we don't want it for inserts OR updates)
+		// we'll put it back in if we need it
+		if ($model->has_primary_key_field() && $model->get_primary_key_field()->is_auto_increment()) {
+			$effective_id = $model_object_data[ $model->primary_key_name() ];
+			unset($model_object_data[ $model->primary_key_name() ]);
+		} else {
+			$effective_id = $model->get_index_primary_key_string($model_object_data);
+		}
+		// the model takes care of validating the CSV's input
+		try {
+			$new_id = $model->insert($model_object_data);
+			if ($new_id) {
+				$old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_id;
+				$this->_total_inserts++;
+				EE_Error::add_success(
+					sprintf(
+						esc_html__("Successfully added new %s (with id %s) with csv data %s", "event_espresso"),
+						$model->get_this_model_name(),
+						$new_id,
+						implode(",", $model_object_data)
+					)
+				);
+			} else {
+				$this->_total_insert_errors++;
+				// put the ID used back in there for the error message
+				if ($model->has_primary_key_field()) {
+					$model_object_data[ $model->primary_key_name() ] = $effective_id;
+				}
+				EE_Error::add_error(
+					sprintf(
+						esc_html__("Could not insert new %s with the csv data: %s", "event_espresso"),
+						$model->get_this_model_name(),
+						http_build_query($model_object_data)
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		} catch (EE_Error $e) {
+			$this->_total_insert_errors++;
+			if ($model->has_primary_key_field()) {
+				$model_object_data[ $model->primary_key_name() ] = $effective_id;
+			}
+			EE_Error::add_error(
+				sprintf(
+					esc_html__("Could not insert new %s with the csv data: %s because %s", "event_espresso"),
+					$model->get_this_model_name(),
+					implode(",", $model_object_data),
+					$e->getMessage()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return $old_db_to_new_db_mapping;
+	}
+
+	/**
+	 * Given the model object data, finds the row to update and updates it
+	 *
+	 * @param string|int $id_in_csv
+	 * @param array      $model_object_data
+	 * @param EEM_Base   $model
+	 * @param array      $old_db_to_new_db_mapping
+	 * @return array updated $old_db_to_new_db_mapping
+	 */
+	protected function _update_from_data_array($id_in_csv, $model_object_data, $model, $old_db_to_new_db_mapping)
+	{
+		try {
+			// let's keep two copies of the model object data:
+			// one for performing an update, one for everthing else
+			$model_object_data_for_update = $model_object_data;
+			if ($model->has_primary_key_field()) {
+				$conditions = array($model->primary_key_name() => $model_object_data[ $model->primary_key_name() ]);
+				// remove the primary key because we shouldn't use it for updating
+				unset($model_object_data_for_update[ $model->primary_key_name() ]);
+			} elseif ($model->get_combined_primary_key_fields() > 1) {
+				$conditions = array();
+				foreach ($model->get_combined_primary_key_fields() as $key_field) {
+					$conditions[ $key_field->get_name() ] = $model_object_data[ $key_field->get_name() ];
+				}
+			} else {
+				$model->primary_key_name(
+				);// this shoudl just throw an exception, explaining that we dont have a primary key (or a combine dkey)
+			}
+
+			$success = $model->update($model_object_data_for_update, array($conditions));
+			if ($success) {
+				$this->_total_updates++;
+				EE_Error::add_success(
+					sprintf(
+						esc_html__("Successfully updated %s with csv data %s", "event_espresso"),
+						$model->get_this_model_name(),
+						implode(",", $model_object_data_for_update)
+					)
+				);
+				// we should still record the mapping even though it was an update
+				// because if we were going to insert somethign but it was going to conflict
+				// we would have last-minute decided to update. So we'd like to know what we updated
+				// and so we record what record ended up being updated using the mapping
+				if ($model->has_primary_key_field()) {
+					$new_key_for_mapping = $model_object_data[ $model->primary_key_name() ];
+				} else {
+					// no primary key just a combined key
+					$new_key_for_mapping = $model->get_index_primary_key_string($model_object_data);
+				}
+				$old_db_to_new_db_mapping[ $model->get_this_model_name() ][ $id_in_csv ] = $new_key_for_mapping;
+			} else {
+				$matched_items = $model->get_all(array($conditions));
+				if (! $matched_items) {
+					// no items were matched (so we shouldn't have updated)... but then we should have inserted? what the heck?
+					$this->_total_update_errors++;
+					EE_Error::add_error(
+						sprintf(
+							esc_html__(
+								"Could not update %s with the csv data: '%s' for an unknown reason (using WHERE conditions %s)",
+								"event_espresso"
+							),
+							$model->get_this_model_name(),
+							http_build_query($model_object_data),
+							http_build_query($conditions)
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				} else {
+					$this->_total_updates++;
+					EE_Error::add_success(
+						sprintf(
+							esc_html__(
+								"%s with csv data '%s' was found in the database and didn't need updating because all the data is identical.",
+								"event_espresso"
+							),
+							$model->get_this_model_name(),
+							implode(",", $model_object_data)
+						)
+					);
+				}
+			}
+		} catch (EE_Error $e) {
+			$this->_total_update_errors++;
+			$basic_message = sprintf(
+				esc_html__("Could not update %s with the csv data: %s because %s", "event_espresso"),
+				$model->get_this_model_name(),
+				implode(",", $model_object_data),
+				$e->getMessage()
+			);
+			$debug_message = $basic_message . ' Stack trace: ' . $e->getTraceAsString();
+			EE_Error::add_error("$basic_message | $debug_message", __FILE__, __FUNCTION__, __LINE__);
+		}
+		return $old_db_to_new_db_mapping;
+	}
+
+	/**
+	 * Gets the number of inserts performed since importer was instantiated or reset
+	 *
+	 * @return int
+	 */
+	public function get_total_inserts()
+	{
+		return $this->_total_inserts;
+	}
+
+	/**
+	 *  Gets the number of insert errors since importer was instantiated or reset
+	 *
+	 * @return int
+	 */
+	public function get_total_insert_errors()
+	{
+		return $this->_total_insert_errors;
+	}
+
+	/**
+	 *  Gets the number of updates performed since importer was instantiated or reset
+	 *
+	 * @return int
+	 */
+	public function get_total_updates()
+	{
+		return $this->_total_updates;
+	}
+
+	/**
+	 *  Gets the number of update errors since importer was instantiated or reset
+	 *
+	 * @return int
+	 */
+	public function get_total_update_errors()
+	{
+		return $this->_total_update_errors;
+	}
 }

core/services/orm/tree_traversal/ModelObjNode.php

Spacing +4 added lines, -4 removed lines

@@ -69,7 +69,7 @@ 
                 continue;
             }
             if ($relation instanceof EE_Has_Many_Relation) {
-                $this->nodes[ $relationName ] = new RelationNode(
+                $this->nodes[$relationName] = new RelationNode(
                     $this->id,
                     $this->model,
                     $relation->get_other_model(),
@@ -82,7 +82,7 @@ 
                     $this->dont_traverse_models
                 )
             ) {
-                $this->nodes[ $relation->get_join_model()->get_this_model_name() ] = new RelationNode(
+                $this->nodes[$relation->get_join_model()->get_this_model_name()] = new RelationNode(
                     $this->id,
                     $this->model,
                     $relation->get_join_model(),
@@ -130,7 +130,7 @@ 
             // To save on space when serializing, only bother keeping a record of relation nodes that actually found
             // related model objects.
             if ($relation_node->isComplete() && $relation_node->countSubNodes() === 0) {
-                unset($this->nodes[ $model_name ]);
+                unset($this->nodes[$model_name]);
             }
             if ($num_identified >= $model_objects_to_identify) {
                 // ...but admit we're wrong if the work exceeded the budget.
@@ -161,7 +161,7 @@ 
             $tree['rels'] = null;
         } else {
             foreach ($this->nodes as $relation_name => $relation_node) {
-                $tree['rels'][ $relation_name ] = $relation_node->toArray();
+                $tree['rels'][$relation_name] = $relation_node->toArray();
             }
         }
         return $tree;

Indentation +212 added lines, -212 removed lines

@@ -23,218 +23,218 @@
  */
 class ModelObjNode extends BaseNode
 {
-    /**
-     * @var int|string
-     */
-    protected $id;
-
-    /**
-     * @var EEM_Base
-     */
-    protected $model;
-
-    /**
-     * @var RelationNode[]
-     */
-    protected $nodes;
-
-
-    /**
-     * We don't pass the model objects because this needs to serialize to something tiny for effiency.
-     *
-     * @param          $model_obj_id
-     * @param EEM_Base $model
-     * @param array    $dont_traverse_models array of model names we DON'T want to traverse.
-     */
-    public function __construct($model_obj_id, EEM_Base $model, array $dont_traverse_models = [])
-    {
-        $this->id                   = $model_obj_id;
-        $this->model                = $model;
-        $this->dont_traverse_models = $dont_traverse_models;
-    }
-
-
-    /**
-     * Creates a relation node for each relation of this model's relations.
-     * Does NOT call `discover` on them yet though.
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @since 4.10.12.p
-     */
-    protected function discover()
-    {
-        $this->nodes = [];
-        foreach ($this->model->relation_settings() as $relationName => $relation) {
-            // Make sure this isn't one of the models we were told to not traverse into.
-            if (in_array($relationName, $this->dont_traverse_models)) {
-                continue;
-            }
-            if ($relation instanceof EE_Has_Many_Relation) {
-                $this->nodes[ $relationName ] = new RelationNode(
-                    $this->id,
-                    $this->model,
-                    $relation->get_other_model(),
-                    $this->dont_traverse_models
-                );
-            } elseif (
-                $relation instanceof EE_HABTM_Relation &&
-                ! in_array(
-                    $relation->get_join_model()->get_this_model_name(),
-                    $this->dont_traverse_models
-                )
-            ) {
-                $this->nodes[ $relation->get_join_model()->get_this_model_name() ] = new RelationNode(
-                    $this->id,
-                    $this->model,
-                    $relation->get_join_model(),
-                    $this->dont_traverse_models
-                );
-            }
-        }
-        ksort($this->nodes);
-    }
-
-
-    /**
-     * Whether this item has already been initialized
-     */
-    protected function isDiscovered()
-    {
-        return $this->nodes !== null && is_array($this->nodes);
-    }
-
-    /**
-     * @since 4.10.12.p
-     * @return boolean
-     */
-    public function isComplete()
-    {
-        if ($this->complete === null) {
-            $this->complete = false;
-        }
-        return $this->complete;
-    }
-
-
-    /**
-     * Triggers working on each child relation node that has work to do.
-     *
-     * @param $model_objects_to_identify
-     * @return int units of work done
-     * @since 4.10.12.p
-     */
-    protected function work($model_objects_to_identify)
-    {
-        $num_identified = 0;
-        // Begin assuming we'll finish all the work on this node and its children...
-        $this->complete = true;
-        foreach ($this->nodes as $model_name => $relation_node) {
-            $num_identified += $relation_node->visit($model_objects_to_identify - $num_identified);
-            // To save on space when serializing, only bother keeping a record of relation nodes that actually found
-            // related model objects.
-            if ($relation_node->isComplete() && $relation_node->countSubNodes() === 0) {
-                unset($this->nodes[ $model_name ]);
-            }
-            if ($num_identified >= $model_objects_to_identify) {
-                // ...but admit we're wrong if the work exceeded the budget.
-                $this->complete = false;
-                break;
-            }
-        }
-        return $num_identified;
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @since 4.10.12.p
-     */
-    public function toArray()
-    {
-        $tree = [
-            'id'       => $this->id,
-            'complete' => $this->isComplete(),
-            'rels'     => [],
-        ];
-        if ($this->nodes === null) {
-            $tree['rels'] = null;
-        } else {
-            foreach ($this->nodes as $relation_name => $relation_node) {
-                $tree['rels'][ $relation_name ] = $relation_node->toArray();
-            }
-        }
-        return $tree;
-    }
-
-
-    /**
-     * @return array|mixed
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws EE_Error
-     * @since 4.10.12.p
-     */
-    public function getIds()
-    {
-        $ids = [
-            $this->model->get_this_model_name() => [
-                $this->id => $this->id,
-            ],
-        ];
-        if ($this->nodes && is_array($this->nodes)) {
-            foreach ($this->nodes as $relation_node) {
-                $ids = array_replace_recursive($ids, $relation_node->getIds());
-            }
-        }
-        return $ids;
-    }
-
-
-    /**
-     * Don't serialize the models. Just record their names on some dynamic properties.
-     *
-     * @since 4.10.12.p
-     */
-    public function __sleep()
-    {
-        $this->m = $this->model->get_this_model_name();
-        return array_merge(
-            [
-                'm',
-                'id',
-                'nodes',
-            ],
-            parent::__sleep()
-        );
-    }
-
-
-    /**
-     * Use the dynamic properties to instantiate the models we use.
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.10.12.p
-     */
-    public function __wakeup()
-    {
-        $this->model = EE_Registry::instance()->load_model($this->m);
-        parent::__wakeup();
-    }
+	/**
+	 * @var int|string
+	 */
+	protected $id;
+
+	/**
+	 * @var EEM_Base
+	 */
+	protected $model;
+
+	/**
+	 * @var RelationNode[]
+	 */
+	protected $nodes;
+
+
+	/**
+	 * We don't pass the model objects because this needs to serialize to something tiny for effiency.
+	 *
+	 * @param          $model_obj_id
+	 * @param EEM_Base $model
+	 * @param array    $dont_traverse_models array of model names we DON'T want to traverse.
+	 */
+	public function __construct($model_obj_id, EEM_Base $model, array $dont_traverse_models = [])
+	{
+		$this->id                   = $model_obj_id;
+		$this->model                = $model;
+		$this->dont_traverse_models = $dont_traverse_models;
+	}
+
+
+	/**
+	 * Creates a relation node for each relation of this model's relations.
+	 * Does NOT call `discover` on them yet though.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @since 4.10.12.p
+	 */
+	protected function discover()
+	{
+		$this->nodes = [];
+		foreach ($this->model->relation_settings() as $relationName => $relation) {
+			// Make sure this isn't one of the models we were told to not traverse into.
+			if (in_array($relationName, $this->dont_traverse_models)) {
+				continue;
+			}
+			if ($relation instanceof EE_Has_Many_Relation) {
+				$this->nodes[ $relationName ] = new RelationNode(
+					$this->id,
+					$this->model,
+					$relation->get_other_model(),
+					$this->dont_traverse_models
+				);
+			} elseif (
+				$relation instanceof EE_HABTM_Relation &&
+				! in_array(
+					$relation->get_join_model()->get_this_model_name(),
+					$this->dont_traverse_models
+				)
+			) {
+				$this->nodes[ $relation->get_join_model()->get_this_model_name() ] = new RelationNode(
+					$this->id,
+					$this->model,
+					$relation->get_join_model(),
+					$this->dont_traverse_models
+				);
+			}
+		}
+		ksort($this->nodes);
+	}
+
+
+	/**
+	 * Whether this item has already been initialized
+	 */
+	protected function isDiscovered()
+	{
+		return $this->nodes !== null && is_array($this->nodes);
+	}
+
+	/**
+	 * @since 4.10.12.p
+	 * @return boolean
+	 */
+	public function isComplete()
+	{
+		if ($this->complete === null) {
+			$this->complete = false;
+		}
+		return $this->complete;
+	}
+
+
+	/**
+	 * Triggers working on each child relation node that has work to do.
+	 *
+	 * @param $model_objects_to_identify
+	 * @return int units of work done
+	 * @since 4.10.12.p
+	 */
+	protected function work($model_objects_to_identify)
+	{
+		$num_identified = 0;
+		// Begin assuming we'll finish all the work on this node and its children...
+		$this->complete = true;
+		foreach ($this->nodes as $model_name => $relation_node) {
+			$num_identified += $relation_node->visit($model_objects_to_identify - $num_identified);
+			// To save on space when serializing, only bother keeping a record of relation nodes that actually found
+			// related model objects.
+			if ($relation_node->isComplete() && $relation_node->countSubNodes() === 0) {
+				unset($this->nodes[ $model_name ]);
+			}
+			if ($num_identified >= $model_objects_to_identify) {
+				// ...but admit we're wrong if the work exceeded the budget.
+				$this->complete = false;
+				break;
+			}
+		}
+		return $num_identified;
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @since 4.10.12.p
+	 */
+	public function toArray()
+	{
+		$tree = [
+			'id'       => $this->id,
+			'complete' => $this->isComplete(),
+			'rels'     => [],
+		];
+		if ($this->nodes === null) {
+			$tree['rels'] = null;
+		} else {
+			foreach ($this->nodes as $relation_name => $relation_node) {
+				$tree['rels'][ $relation_name ] = $relation_node->toArray();
+			}
+		}
+		return $tree;
+	}
+
+
+	/**
+	 * @return array|mixed
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 * @since 4.10.12.p
+	 */
+	public function getIds()
+	{
+		$ids = [
+			$this->model->get_this_model_name() => [
+				$this->id => $this->id,
+			],
+		];
+		if ($this->nodes && is_array($this->nodes)) {
+			foreach ($this->nodes as $relation_node) {
+				$ids = array_replace_recursive($ids, $relation_node->getIds());
+			}
+		}
+		return $ids;
+	}
+
+
+	/**
+	 * Don't serialize the models. Just record their names on some dynamic properties.
+	 *
+	 * @since 4.10.12.p
+	 */
+	public function __sleep()
+	{
+		$this->m = $this->model->get_this_model_name();
+		return array_merge(
+			[
+				'm',
+				'id',
+				'nodes',
+			],
+			parent::__sleep()
+		);
+	}
+
+
+	/**
+	 * Use the dynamic properties to instantiate the models we use.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.10.12.p
+	 */
+	public function __wakeup()
+	{
+		$this->model = EE_Registry::instance()->load_model($this->m);
+		parent::__wakeup();
+	}
 }
 // End of file Visitor.php
 // Location: EventEspresso\core\services\orm\tree_traversal/Visitor.php

core/EED_Module.module.php

Spacing +2 added lines, -2 removed lines

@@ -133,7 +133,7 @@ 
     protected static function getRequest()
     {
         static $request;
-        if (! $request instanceof RequestInterface) {
+        if ( ! $request instanceof RequestInterface) {
             $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
         }
         return $request;
@@ -147,7 +147,7 @@ 
     protected static function getResponse()
     {
         static $response;
-        if (! $response instanceof RequestInterface) {
+        if ( ! $response instanceof RequestInterface) {
             $response = LoaderFactory::getLoader()->getShared(ResponseInterface::class);
         }
         return $response;

Indentation +137 added lines, -137 removed lines

@@ -14,141 +14,141 @@
  */
 abstract class EED_Module extends EE_Configurable implements ResettableInterface
 {
-    /**
-     * rendered output to be returned to WP
-     *
-     * @var    string $output
-     */
-    protected $output = '';
-
-    /**
-     * the current active espresso template theme
-     *
-     * @var    string $theme
-     */
-    protected $theme = '';
-
-
-    /**
-     * @return void
-     */
-    public static function reset()
-    {
-        $module_name = get_called_class();
-        new $module_name();
-    }
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-    }
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-    }
-
-
-    /**
-     *    run - initial module setup
-     *    this method is primarily used for activating resources in the EE_Front_Controller thru the use of filters
-     *
-     * @access    public
-     * @var            WP $WP
-     * @return    void
-     */
-    abstract public function run($WP);
-
-
-    /**
-     * EED_Module constructor.
-     */
-    final public function __construct()
-    {
-        $this->theme = EE_Config::get_current_theme();
-        $module_name = $this->module_name();
-        EE_Registry::instance()->modules->{$module_name} = $this;
-    }
-
-
-    /**
-     * @param string $module_name
-     * @return EED_Module|mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected static function get_instance($module_name = '')
-    {
-        $module_name = ! empty($module_name)
-            ? $module_name
-            : get_called_class();
-        if (
-            ! isset(EE_Registry::instance()->modules->{$module_name})
-            || ! EE_Registry::instance()->modules->{$module_name} instanceof EED_Module
-        ) {
-            EE_Registry::instance()->add_module($module_name);
-        }
-        return EE_Registry::instance()->get_module($module_name);
-    }
-
-
-    /**
-     *    module_name
-     *
-     * @access    public
-     * @return    string
-     */
-    public function module_name()
-    {
-        return get_class($this);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function theme()
-    {
-        return $this->theme;
-    }
-
-
-    /**
-     * @return RequestInterface
-     * @since   4.10.14.p
-     */
-    protected static function getRequest()
-    {
-        static $request;
-        if (! $request instanceof RequestInterface) {
-            $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        }
-        return $request;
-    }
-
-
-    /**
-     * @return ResponseInterface
-     * @since   4.10.14.p
-     */
-    protected static function getResponse()
-    {
-        static $response;
-        if (! $response instanceof RequestInterface) {
-            $response = LoaderFactory::getLoader()->getShared(ResponseInterface::class);
-        }
-        return $response;
-    }
+	/**
+	 * rendered output to be returned to WP
+	 *
+	 * @var    string $output
+	 */
+	protected $output = '';
+
+	/**
+	 * the current active espresso template theme
+	 *
+	 * @var    string $theme
+	 */
+	protected $theme = '';
+
+
+	/**
+	 * @return void
+	 */
+	public static function reset()
+	{
+		$module_name = get_called_class();
+		new $module_name();
+	}
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+	}
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+	}
+
+
+	/**
+	 *    run - initial module setup
+	 *    this method is primarily used for activating resources in the EE_Front_Controller thru the use of filters
+	 *
+	 * @access    public
+	 * @var            WP $WP
+	 * @return    void
+	 */
+	abstract public function run($WP);
+
+
+	/**
+	 * EED_Module constructor.
+	 */
+	final public function __construct()
+	{
+		$this->theme = EE_Config::get_current_theme();
+		$module_name = $this->module_name();
+		EE_Registry::instance()->modules->{$module_name} = $this;
+	}
+
+
+	/**
+	 * @param string $module_name
+	 * @return EED_Module|mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected static function get_instance($module_name = '')
+	{
+		$module_name = ! empty($module_name)
+			? $module_name
+			: get_called_class();
+		if (
+			! isset(EE_Registry::instance()->modules->{$module_name})
+			|| ! EE_Registry::instance()->modules->{$module_name} instanceof EED_Module
+		) {
+			EE_Registry::instance()->add_module($module_name);
+		}
+		return EE_Registry::instance()->get_module($module_name);
+	}
+
+
+	/**
+	 *    module_name
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public function module_name()
+	{
+		return get_class($this);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function theme()
+	{
+		return $this->theme;
+	}
+
+
+	/**
+	 * @return RequestInterface
+	 * @since   4.10.14.p
+	 */
+	protected static function getRequest()
+	{
+		static $request;
+		if (! $request instanceof RequestInterface) {
+			$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		}
+		return $request;
+	}
+
+
+	/**
+	 * @return ResponseInterface
+	 * @since   4.10.14.p
+	 */
+	protected static function getResponse()
+	{
+		static $response;
+		if (! $response instanceof RequestInterface) {
+			$response = LoaderFactory::getLoader()->getShared(ResponseInterface::class);
+		}
+		return $response;
+	}
 }

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 +98 added lines, -98 removed lines

@@ -15,113 +15,113 @@
  */
 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'
+			),
+		];
+	}
 
 
-    /**
-     * @param string $shortcode
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _parser($shortcode)
-    {
-        switch ($shortcode) {
-            case '[QUESTION_LIST]':
-                return $this->_get_question_list();
-        }
-        return '';
-    }
+	/**
+	 * @param string $shortcode
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _parser($shortcode)
+	{
+		switch ($shortcode) {
+			case '[QUESTION_LIST]':
+				return $this->_get_question_list();
+		}
+		return '';
+	}
 
 
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_question_list()
-    {
-        $this->_validate_list_requirements();
+	/**
+	 * @return string
+	 * @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 [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 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;
+	}
 }