eventespresso / event-espresso-core

modules/batch/EED_Batch.module.php

Indentation +328 added lines, -328 removed lines

@@ -28,356 +28,356 @@
 class EED_Batch extends EED_Module
 {
 
-    /**
-     * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that
-     * processes data only
-     */
-    const batch_job = 'job';
-    /**
-     * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that
-     * produces a file for download
-     */
-    const batch_file_job = 'file';
-    /**
-     * Possibly value for $_REQUEST[ 'batch' ]. Indicates this request is NOT
-     * for a batch job. It's the same as not providing the $_REQUEST[ 'batch' ]
-     * at all
-     */
-    const batch_not_job = 'none';
+	/**
+	 * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that
+	 * processes data only
+	 */
+	const batch_job = 'job';
+	/**
+	 * Possibly value for $_REQUEST[ 'batch' ]. Indicates to run a job that
+	 * produces a file for download
+	 */
+	const batch_file_job = 'file';
+	/**
+	 * Possibly value for $_REQUEST[ 'batch' ]. Indicates this request is NOT
+	 * for a batch job. It's the same as not providing the $_REQUEST[ 'batch' ]
+	 * at all
+	 */
+	const batch_not_job = 'none';
 
-    /**
-     *
-     * @var string 'file', or 'job', or false to indicate its not a batch request at all
-     */
-    protected $_batch_request_type = null;
+	/**
+	 *
+	 * @var string 'file', or 'job', or false to indicate its not a batch request at all
+	 */
+	protected $_batch_request_type = null;
 
-    /**
-     * Because we want to use the response in both the localized JS and in the body
-     * we need to make this response available between method calls
-     *
-     * @var \EventEspressoBatchRequest\Helpers\JobStepResponse
-     */
-    protected $_job_step_response = null;
+	/**
+	 * Because we want to use the response in both the localized JS and in the body
+	 * we need to make this response available between method calls
+	 *
+	 * @var \EventEspressoBatchRequest\Helpers\JobStepResponse
+	 */
+	protected $_job_step_response = null;
 
-    /**
-     * @var LoaderInterface
-     */
-    protected $loader;
+	/**
+	 * @var LoaderInterface
+	 */
+	protected $loader;
 
-    /**
-     * Gets the batch instance
-     *
-     * @return EED_Batch
-     */
-    public static function instance()
-    {
-        return self::get_instance();
-    }
+	/**
+	 * Gets the batch instance
+	 *
+	 * @return EED_Batch
+	 */
+	public static function instance()
+	{
+		return self::get_instance();
+	}
 
-    /**
-     * Sets hooks to enable batch jobs on the frontend. Disabled by default
-     * because it's an attack vector and there are currently no implementations
-     */
-    public static function set_hooks()
-    {
-        // because this is a possibel attack vector, let's have this disabled until
-        // we at least have a real use for it on the frontend
-        if (apply_filters('FHEE__EED_Batch__set_hooks__enable_frontend_batch', false)) {
-            add_action('wp_enqueue_scripts', array(self::instance(), 'enqueue_scripts'));
-            add_filter('template_include', array(self::instance(), 'override_template'), 99);
-        }
-    }
+	/**
+	 * Sets hooks to enable batch jobs on the frontend. Disabled by default
+	 * because it's an attack vector and there are currently no implementations
+	 */
+	public static function set_hooks()
+	{
+		// because this is a possibel attack vector, let's have this disabled until
+		// we at least have a real use for it on the frontend
+		if (apply_filters('FHEE__EED_Batch__set_hooks__enable_frontend_batch', false)) {
+			add_action('wp_enqueue_scripts', array(self::instance(), 'enqueue_scripts'));
+			add_filter('template_include', array(self::instance(), 'override_template'), 99);
+		}
+	}
 
-    /**
-     * Initializes some hooks for the admin in order to run batch jobs
-     */
-    public static function set_hooks_admin()
-    {
-        add_action('admin_menu', array(self::instance(), 'register_admin_pages'));
-        add_action('admin_enqueue_scripts', array(self::instance(), 'enqueue_scripts'));
+	/**
+	 * Initializes some hooks for the admin in order to run batch jobs
+	 */
+	public static function set_hooks_admin()
+	{
+		add_action('admin_menu', array(self::instance(), 'register_admin_pages'));
+		add_action('admin_enqueue_scripts', array(self::instance(), 'enqueue_scripts'));
 
-        // ajax
-        add_action('wp_ajax_espresso_batch_continue', array(self::instance(), 'batch_continue'));
-        add_action('wp_ajax_espresso_batch_cleanup', array(self::instance(), 'batch_cleanup'));
-        add_action('wp_ajax_nopriv_espresso_batch_continue', array(self::instance(), 'batch_continue'));
-        add_action('wp_ajax_nopriv_espresso_batch_cleanup', array(self::instance(), 'batch_cleanup'));
-    }
+		// ajax
+		add_action('wp_ajax_espresso_batch_continue', array(self::instance(), 'batch_continue'));
+		add_action('wp_ajax_espresso_batch_cleanup', array(self::instance(), 'batch_cleanup'));
+		add_action('wp_ajax_nopriv_espresso_batch_continue', array(self::instance(), 'batch_continue'));
+		add_action('wp_ajax_nopriv_espresso_batch_cleanup', array(self::instance(), 'batch_cleanup'));
+	}
 
-    /**
-     * @since $VID:$
-     * @return LoaderInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function getLoader()
-    {
-        if (!$this->loader instanceof LoaderInterface) {
-            $this->loader = LoaderFactory::getLoader();
-        }
-        return $this->loader;
-    }
+	/**
+	 * @since $VID:$
+	 * @return LoaderInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function getLoader()
+	{
+		if (!$this->loader instanceof LoaderInterface) {
+			$this->loader = LoaderFactory::getLoader();
+		}
+		return $this->loader;
+	}
 
-    /**
-     * Enqueues batch scripts on the frontend or admin, and creates a job
-     */
-    public function enqueue_scripts()
-    {
-        if (isset($_REQUEST['espresso_batch'])
-            ||
-            (
-                isset($_REQUEST['page'])
-                && $_REQUEST['page'] == 'espresso_batch'
-            )
-        ) {
-            switch ($this->batch_request_type()) {
-                case self::batch_job:
-                    $this->enqueue_scripts_styles_batch_create();
-                    break;
-                case self::batch_file_job:
-                    $this->enqueue_scripts_styles_batch_file_create();
-                    break;
-            }
-        }
-    }
+	/**
+	 * Enqueues batch scripts on the frontend or admin, and creates a job
+	 */
+	public function enqueue_scripts()
+	{
+		if (isset($_REQUEST['espresso_batch'])
+			||
+			(
+				isset($_REQUEST['page'])
+				&& $_REQUEST['page'] == 'espresso_batch'
+			)
+		) {
+			switch ($this->batch_request_type()) {
+				case self::batch_job:
+					$this->enqueue_scripts_styles_batch_create();
+					break;
+				case self::batch_file_job:
+					$this->enqueue_scripts_styles_batch_file_create();
+					break;
+			}
+		}
+	}
 
-    /**
-     * Create a batch job, enqueues a script to run it, and localizes some data for it
-     */
-    public function enqueue_scripts_styles_batch_create()
-    {
-        $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
-        wp_enqueue_script(
-            'batch_runner_init',
-            BATCH_URL . 'assets/batch_runner_init.js',
-            array('batch_runner'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_localize_script('batch_runner_init', 'ee_job_response', $job_response->to_array());
-        wp_localize_script(
-            'batch_runner_init',
-            'ee_job_i18n',
-            array(
-                'return_url' => $_REQUEST['return_url'],
-            )
-        );
-    }
+	/**
+	 * Create a batch job, enqueues a script to run it, and localizes some data for it
+	 */
+	public function enqueue_scripts_styles_batch_create()
+	{
+		$job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
+		wp_enqueue_script(
+			'batch_runner_init',
+			BATCH_URL . 'assets/batch_runner_init.js',
+			array('batch_runner'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_localize_script('batch_runner_init', 'ee_job_response', $job_response->to_array());
+		wp_localize_script(
+			'batch_runner_init',
+			'ee_job_i18n',
+			array(
+				'return_url' => $_REQUEST['return_url'],
+			)
+		);
+	}
 
-    /**
-     * Creates a batch job which will download a file, enqueues a script to run the job, and localizes some data for it
-     */
-    public function enqueue_scripts_styles_batch_file_create()
-    {
-        // creates a job based on the request variable
-        $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
-        wp_enqueue_script(
-            'batch_file_runner_init',
-            BATCH_URL . 'assets/batch_file_runner_init.js',
-            array('batch_runner'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_localize_script('batch_file_runner_init', 'ee_job_response', $job_response->to_array());
-        wp_localize_script(
-            'batch_file_runner_init',
-            'ee_job_i18n',
-            array(
-                'download_and_redirecting' => sprintf(
-                    __('File Generation complete. Downloading, and %1$sredirecting%2$s...', 'event_espresso'),
-                    '<a href="' . $_REQUEST['return_url'] . '">',
-                    '</a>'
-                ),
-                'return_url'               => $_REQUEST['return_url'],
-            )
-        );
-    }
+	/**
+	 * Creates a batch job which will download a file, enqueues a script to run the job, and localizes some data for it
+	 */
+	public function enqueue_scripts_styles_batch_file_create()
+	{
+		// creates a job based on the request variable
+		$job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
+		wp_enqueue_script(
+			'batch_file_runner_init',
+			BATCH_URL . 'assets/batch_file_runner_init.js',
+			array('batch_runner'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_localize_script('batch_file_runner_init', 'ee_job_response', $job_response->to_array());
+		wp_localize_script(
+			'batch_file_runner_init',
+			'ee_job_i18n',
+			array(
+				'download_and_redirecting' => sprintf(
+					__('File Generation complete. Downloading, and %1$sredirecting%2$s...', 'event_espresso'),
+					'<a href="' . $_REQUEST['return_url'] . '">',
+					'</a>'
+				),
+				'return_url'               => $_REQUEST['return_url'],
+			)
+		);
+	}
 
-    /**
-     * Enqueues scripts and styles common to any batch job, and creates
-     * a job from the request data, and stores the response in the
-     * $this->_job_step_response property
-     *
-     * @return \EventEspressoBatchRequest\Helpers\JobStepResponse
-     */
-    protected function _enqueue_batch_job_scripts_and_styles_and_start_job()
-    {
-        wp_register_script(
-            'progress_bar',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.js',
-            array('jquery')
-        );
-        wp_enqueue_style(
-            'progress_bar',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.css',
-            array(),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_script(
-            'batch_runner',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/batch_runner.js',
-            array('progress_bar')
-        );
-        // just copy the bits of EE admin's eei18n that we need in the JS
-        wp_localize_script(
-            'batch_runner',
-            'eei18n',
-            array(
-                'ajax_url'      => WP_AJAX_URL,
-                'is_admin'      => (bool) is_admin(),
-                'error_message' => esc_html__('An error occurred and the job has been stopped. Please refresh the page to try again.', 'event_espresso'),
-            )
-        );
-        $job_handler_classname = stripslashes($_GET['job_handler']);
-        $request_data = array_diff_key(
-            $_REQUEST,
-            array_flip(array('action', 'page', 'ee', 'batch'))
-        );
-        $batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor');
-        // eg 'EventEspressoBatchRequest\JobHandlers\RegistrationsReport'
-        $job_response = $batch_runner->create_job($job_handler_classname, $request_data);
-        // remember the response for later. We need it to display the page body
-        $this->_job_step_response = $job_response;
-        return $job_response;
-    }
+	/**
+	 * Enqueues scripts and styles common to any batch job, and creates
+	 * a job from the request data, and stores the response in the
+	 * $this->_job_step_response property
+	 *
+	 * @return \EventEspressoBatchRequest\Helpers\JobStepResponse
+	 */
+	protected function _enqueue_batch_job_scripts_and_styles_and_start_job()
+	{
+		wp_register_script(
+			'progress_bar',
+			EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.js',
+			array('jquery')
+		);
+		wp_enqueue_style(
+			'progress_bar',
+			EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.css',
+			array(),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_script(
+			'batch_runner',
+			EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/batch_runner.js',
+			array('progress_bar')
+		);
+		// just copy the bits of EE admin's eei18n that we need in the JS
+		wp_localize_script(
+			'batch_runner',
+			'eei18n',
+			array(
+				'ajax_url'      => WP_AJAX_URL,
+				'is_admin'      => (bool) is_admin(),
+				'error_message' => esc_html__('An error occurred and the job has been stopped. Please refresh the page to try again.', 'event_espresso'),
+			)
+		);
+		$job_handler_classname = stripslashes($_GET['job_handler']);
+		$request_data = array_diff_key(
+			$_REQUEST,
+			array_flip(array('action', 'page', 'ee', 'batch'))
+		);
+		$batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor');
+		// eg 'EventEspressoBatchRequest\JobHandlers\RegistrationsReport'
+		$job_response = $batch_runner->create_job($job_handler_classname, $request_data);
+		// remember the response for later. We need it to display the page body
+		$this->_job_step_response = $job_response;
+		return $job_response;
+	}
 
-    /**
-     * If we are doing a frontend batch job, this makes it so WP shows our template's HTML
-     *
-     * @param string $template
-     * @return string
-     */
-    public function override_template($template)
-    {
-        if (isset($_REQUEST['espresso_batch']) && isset($_REQUEST['batch'])) {
-            return EE_MODULES . 'batch' . DS . 'templates' . DS . 'batch_frontend_wrapper.template.html';
-        }
-        return $template;
-    }
+	/**
+	 * If we are doing a frontend batch job, this makes it so WP shows our template's HTML
+	 *
+	 * @param string $template
+	 * @return string
+	 */
+	public function override_template($template)
+	{
+		if (isset($_REQUEST['espresso_batch']) && isset($_REQUEST['batch'])) {
+			return EE_MODULES . 'batch' . DS . 'templates' . DS . 'batch_frontend_wrapper.template.html';
+		}
+		return $template;
+	}
 
-    /**
-     * Adds an admin page which doesn't appear in the admin menu
-     */
-    public function register_admin_pages()
-    {
-        add_submenu_page(
-            '', // parent slug. we don't want this to actually appear in the menu
-            __('Batch Job', 'event_espresso'), // page title
-            'n/a', // menu title
-            'read', // we want this page to actually be accessible to anyone,
-            'espresso_batch', // menu slug
-            array(self::instance(), 'show_admin_page')
-        );
-    }
+	/**
+	 * Adds an admin page which doesn't appear in the admin menu
+	 */
+	public function register_admin_pages()
+	{
+		add_submenu_page(
+			'', // parent slug. we don't want this to actually appear in the menu
+			__('Batch Job', 'event_espresso'), // page title
+			'n/a', // menu title
+			'read', // we want this page to actually be accessible to anyone,
+			'espresso_batch', // menu slug
+			array(self::instance(), 'show_admin_page')
+		);
+	}
 
-    /**
-     * Renders the admin page, after most of the work was already done during enqueuing scripts
-     * of creating the job and localizing some data
-     */
-    public function show_admin_page()
-    {
-        echo EEH_Template::locate_template(
-            EE_MODULES . 'batch' . DS . 'templates' . DS . 'batch_wrapper.template.html',
-            array('batch_request_type' => $this->batch_request_type())
-        );
-    }
+	/**
+	 * Renders the admin page, after most of the work was already done during enqueuing scripts
+	 * of creating the job and localizing some data
+	 */
+	public function show_admin_page()
+	{
+		echo EEH_Template::locate_template(
+			EE_MODULES . 'batch' . DS . 'templates' . DS . 'batch_wrapper.template.html',
+			array('batch_request_type' => $this->batch_request_type())
+		);
+	}
 
-    /**
-     * Receives ajax calls for continuing a job
-     */
-    public function batch_continue()
-    {
-        $job_id = sanitize_text_field($_REQUEST['job_id']);
-        $batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor');
-        $response_obj = $batch_runner->continue_job($job_id);
-        $this->_return_json($response_obj->to_array());
-    }
+	/**
+	 * Receives ajax calls for continuing a job
+	 */
+	public function batch_continue()
+	{
+		$job_id = sanitize_text_field($_REQUEST['job_id']);
+		$batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor');
+		$response_obj = $batch_runner->continue_job($job_id);
+		$this->_return_json($response_obj->to_array());
+	}
 
-    /**
-     * Receives the ajax call to cleanup a job
-     *
-     * @return type
-     */
-    public function batch_cleanup()
-    {
-        $job_id = sanitize_text_field($_REQUEST['job_id']);
-        $batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor');
-        $response_obj = $batch_runner->cleanup_job($job_id);
-        $this->_return_json($response_obj->to_array());
-    }
+	/**
+	 * Receives the ajax call to cleanup a job
+	 *
+	 * @return type
+	 */
+	public function batch_cleanup()
+	{
+		$job_id = sanitize_text_field($_REQUEST['job_id']);
+		$batch_runner = $this->getLoader()->getShared('EventEspressoBatchRequest\BatchRequestProcessor');
+		$response_obj = $batch_runner->cleanup_job($job_id);
+		$this->_return_json($response_obj->to_array());
+	}
 
 
-    /**
-     * Returns a json response
-     *
-     * @param array $data The data we want to send echo via in the JSON response's "data" element
-     *
-     * The returned json object is created from an array in the following format:
-     * array(
-     *    'notices' => '', // - contains any EE_Error formatted notices
-     *    'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js.
-     *    We're also going to include the template args with every package (so js can pick out any specific template
-     *    args that might be included in here)
-     *    'isEEajax' => true,//indicates this is a response from EE
-     * )
-     */
-    protected function _return_json($data)
-    {
-        $json = array(
-            'notices'  => EE_Error::get_notices(),
-            'data'     => $data,
-            'isEEajax' => true
-            // special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
-        );
+	/**
+	 * Returns a json response
+	 *
+	 * @param array $data The data we want to send echo via in the JSON response's "data" element
+	 *
+	 * The returned json object is created from an array in the following format:
+	 * array(
+	 *    'notices' => '', // - contains any EE_Error formatted notices
+	 *    'data' => array() //this can be any key/value pairs that a method returns for later json parsing by the js.
+	 *    We're also going to include the template args with every package (so js can pick out any specific template
+	 *    args that might be included in here)
+	 *    'isEEajax' => true,//indicates this is a response from EE
+	 * )
+	 */
+	protected function _return_json($data)
+	{
+		$json = array(
+			'notices'  => EE_Error::get_notices(),
+			'data'     => $data,
+			'isEEajax' => true
+			// special flag so any ajax.Success methods in js can identify this return package as a EEajax package.
+		);
 
 
-        // make sure there are no php errors or headers_sent.  Then we can set correct json header.
-        if (null === error_get_last() || ! headers_sent()) {
-            header('Content-Type: application/json; charset=UTF-8');
-        }
-        echo wp_json_encode($json);
-        exit();
-    }
+		// make sure there are no php errors or headers_sent.  Then we can set correct json header.
+		if (null === error_get_last() || ! headers_sent()) {
+			header('Content-Type: application/json; charset=UTF-8');
+		}
+		echo wp_json_encode($json);
+		exit();
+	}
 
-    /**
-     * Gets the job step response which was done during the enqueuing of scripts
-     *
-     * @return \EventEspressoBatchRequest\Helpers\JobStepResponse
-     */
-    public function job_step_response()
-    {
-        return $this->_job_step_response;
-    }
+	/**
+	 * Gets the job step response which was done during the enqueuing of scripts
+	 *
+	 * @return \EventEspressoBatchRequest\Helpers\JobStepResponse
+	 */
+	public function job_step_response()
+	{
+		return $this->_job_step_response;
+	}
 
-    /**
-     * Gets the batch request type indicated in the $_REQUEST
-     *
-     * @return string: EED_Batch::batch_job, EED_Batch::batch_file_job, EED_Batch::batch_not_job
-     */
-    public function batch_request_type()
-    {
-        if ($this->_batch_request_type === null) {
-            if (isset($_GET['batch'])) {
-                if ($_GET['batch'] == self::batch_job) {
-                    $this->_batch_request_type = self::batch_job;
-                } elseif ($_GET['batch'] == self::batch_file_job) {
-                    $this->_batch_request_type = self::batch_file_job;
-                }
-            }
-            // if we didn't find that it was a batch request, indicate it wasn't
-            if ($this->_batch_request_type === null) {
-                $this->_batch_request_type = self::batch_not_job;
-            }
-        }
-        return $this->_batch_request_type;
-    }
+	/**
+	 * Gets the batch request type indicated in the $_REQUEST
+	 *
+	 * @return string: EED_Batch::batch_job, EED_Batch::batch_file_job, EED_Batch::batch_not_job
+	 */
+	public function batch_request_type()
+	{
+		if ($this->_batch_request_type === null) {
+			if (isset($_GET['batch'])) {
+				if ($_GET['batch'] == self::batch_job) {
+					$this->_batch_request_type = self::batch_job;
+				} elseif ($_GET['batch'] == self::batch_file_job) {
+					$this->_batch_request_type = self::batch_file_job;
+				}
+			}
+			// if we didn't find that it was a batch request, indicate it wasn't
+			if ($this->_batch_request_type === null) {
+				$this->_batch_request_type = self::batch_not_job;
+			}
+		}
+		return $this->_batch_request_type;
+	}
 
-    /**
-     * Unnecessary
-     *
-     * @param type $WP
-     */
-    public function run($WP)
-    {
-    }
+	/**
+	 * Unnecessary
+	 *
+	 * @param type $WP
+	 */
+	public function run($WP)
+	{
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -112,7 +112,7 @@ 
      */
     protected function getLoader()
     {
-        if (!$this->loader instanceof LoaderInterface) {
+        if ( ! $this->loader instanceof LoaderInterface) {
             $this->loader = LoaderFactory::getLoader();
         }
         return $this->loader;
@@ -149,7 +149,7 @@ 
         $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
         wp_enqueue_script(
             'batch_runner_init',
-            BATCH_URL . 'assets/batch_runner_init.js',
+            BATCH_URL.'assets/batch_runner_init.js',
             array('batch_runner'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -173,7 +173,7 @@ 
         $job_response = $this->_enqueue_batch_job_scripts_and_styles_and_start_job();
         wp_enqueue_script(
             'batch_file_runner_init',
-            BATCH_URL . 'assets/batch_file_runner_init.js',
+            BATCH_URL.'assets/batch_file_runner_init.js',
             array('batch_runner'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -185,7 +185,7 @@ 
             array(
                 'download_and_redirecting' => sprintf(
                     __('File Generation complete. Downloading, and %1$sredirecting%2$s...', 'event_espresso'),
-                    '<a href="' . $_REQUEST['return_url'] . '">',
+                    '<a href="'.$_REQUEST['return_url'].'">',
                     '</a>'
                 ),
                 'return_url'               => $_REQUEST['return_url'],
@@ -204,18 +204,18 @@ 
     {
         wp_register_script(
             'progress_bar',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.js',
+            EE_PLUGIN_DIR_URL.'core/libraries/batch/Assets/progress_bar.js',
             array('jquery')
         );
         wp_enqueue_style(
             'progress_bar',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/progress_bar.css',
+            EE_PLUGIN_DIR_URL.'core/libraries/batch/Assets/progress_bar.css',
             array(),
             EVENT_ESPRESSO_VERSION
         );
         wp_enqueue_script(
             'batch_runner',
-            EE_PLUGIN_DIR_URL . 'core/libraries/batch/Assets/batch_runner.js',
+            EE_PLUGIN_DIR_URL.'core/libraries/batch/Assets/batch_runner.js',
             array('progress_bar')
         );
         // just copy the bits of EE admin's eei18n that we need in the JS
@@ -250,7 +250,7 @@ 
     public function override_template($template)
     {
         if (isset($_REQUEST['espresso_batch']) && isset($_REQUEST['batch'])) {
-            return EE_MODULES . 'batch' . DS . 'templates' . DS . 'batch_frontend_wrapper.template.html';
+            return EE_MODULES.'batch'.DS.'templates'.DS.'batch_frontend_wrapper.template.html';
         }
         return $template;
     }
@@ -277,7 +277,7 @@ 
     public function show_admin_page()
     {
         echo EEH_Template::locate_template(
-            EE_MODULES . 'batch' . DS . 'templates' . DS . 'batch_wrapper.template.html',
+            EE_MODULES.'batch'.DS.'templates'.DS.'batch_wrapper.template.html',
             array('batch_request_type' => $this->batch_request_type())
         );
     }

core/libraries/batch/BatchRequestProcessor.php

Indentation +201 added lines, -201 removed lines

@@ -25,215 +25,215 @@
  */
 class BatchRequestProcessor
 {
-    // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
-    // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
-    /**
-     * Current job's ID (if assigned)
-     *
-     * @var string|null
-     */
-    protected $_job_id;
+	// phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
+	// phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
+	/**
+	 * Current job's ID (if assigned)
+	 *
+	 * @var string|null
+	 */
+	protected $_job_id;
 
-    /**
-     * Current job's parameters
-     *
-     * @var JobParameters|null
-     */
-    protected $_job_parameters;
-    /**
-     * @var LoaderInterface
-     */
-    private $loader;
+	/**
+	 * Current job's parameters
+	 *
+	 * @var JobParameters|null
+	 */
+	protected $_job_parameters;
+	/**
+	 * @var LoaderInterface
+	 */
+	private $loader;
 
-    /**
-     * BatchRequestProcessor constructor.
-     * @param LoaderInterface $loader
-     */
-    public function __construct(LoaderInterface $loader)
-    {
-        $this->loader = $loader;
-    }
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-    /**
-     * Creates a job for the specified batch handler class (which should be autoloaded)
-     * and the specified request data
-     *
-     * @param string $batch_job_handler_class of an auto-loaded class implementing JobHandlerInterface
-     * @param array  $request_data            to be used by the batch job handler
-     * @return JobStepResponse
-     */
-    public function create_job($batch_job_handler_class, $request_data)
-    {
-        try {
-            $this->_job_id = wp_generate_password(15, false);
-            $obj = $this->instantiate_batch_job_handler_from_classname($batch_job_handler_class);
-            $this->_job_parameters = new JobParameters($this->_job_id, $batch_job_handler_class, $request_data);
-            $response = $obj->create_job($this->_job_parameters);
-            if (! $response instanceof JobStepResponse) {
-                throw new BatchRequestException(
-                    sprintf(
-                        __(
-                            'The class implementing JobHandlerInterface did not return a JobStepResponse when create_job was called with %1$s. It needs to return one or throw an Exception',
-                            'event_espresso'
-                        ),
-                        wp_json_encode($request_data)
-                    )
-                );
-            }
-            $success = $this->_job_parameters->save(true);
-            if (! $success) {
-                throw new BatchRequestException(
-                    sprintf(
-                        __(
-                            'Could not save job %1$s to the Wordpress Options table. These were the arguments used: %2$s',
-                            'event_espresso'
-                        ),
-                        $this->_job_id,
-                        wp_json_encode($request_data)
-                    )
-                );
-            }
-        } catch (\Exception $e) {
-            $response = $this->_get_error_response($e, 'create_job');
-        }
-        return $response;
-    }
+	/**
+	 * BatchRequestProcessor constructor.
+	 * @param LoaderInterface $loader
+	 */
+	public function __construct(LoaderInterface $loader)
+	{
+		$this->loader = $loader;
+	}
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+	/**
+	 * Creates a job for the specified batch handler class (which should be autoloaded)
+	 * and the specified request data
+	 *
+	 * @param string $batch_job_handler_class of an auto-loaded class implementing JobHandlerInterface
+	 * @param array  $request_data            to be used by the batch job handler
+	 * @return JobStepResponse
+	 */
+	public function create_job($batch_job_handler_class, $request_data)
+	{
+		try {
+			$this->_job_id = wp_generate_password(15, false);
+			$obj = $this->instantiate_batch_job_handler_from_classname($batch_job_handler_class);
+			$this->_job_parameters = new JobParameters($this->_job_id, $batch_job_handler_class, $request_data);
+			$response = $obj->create_job($this->_job_parameters);
+			if (! $response instanceof JobStepResponse) {
+				throw new BatchRequestException(
+					sprintf(
+						__(
+							'The class implementing JobHandlerInterface did not return a JobStepResponse when create_job was called with %1$s. It needs to return one or throw an Exception',
+							'event_espresso'
+						),
+						wp_json_encode($request_data)
+					)
+				);
+			}
+			$success = $this->_job_parameters->save(true);
+			if (! $success) {
+				throw new BatchRequestException(
+					sprintf(
+						__(
+							'Could not save job %1$s to the Wordpress Options table. These were the arguments used: %2$s',
+							'event_espresso'
+						),
+						$this->_job_id,
+						wp_json_encode($request_data)
+					)
+				);
+			}
+		} catch (\Exception $e) {
+			$response = $this->_get_error_response($e, 'create_job');
+		}
+		return $response;
+	}
 
 
-    /**
-     * Retrieves the job's arguments
-     *
-     * @param string $job_id
-     * @param int    $batch_size
-     * @return JobStepResponse
-     */
-    public function continue_job($job_id, $batch_size = 50)
-    {
-        try {
-            $this->_job_id = $job_id;
-            $batch_size = defined('EE_BATCHRUNNER_BATCH_SIZE') ? EE_BATCHRUNNER_BATCH_SIZE : $batch_size;
-            // get the corresponding WordPress option for the job
-            $this->_job_parameters = JobParameters::load($this->_job_id);
-            $handler_obj = $this->instantiate_batch_job_handler_from_classname($this->_job_parameters->classname());
-            // continue it
-            $response = $handler_obj->continue_job($this->_job_parameters, $batch_size);
-            if (! $response instanceof JobStepResponse) {
-                throw new BatchRequestException(
-                    sprintf(
-                        __(
-                            'The class implementing JobHandlerInterface did not return a JobStepResponse when continue_job was called with job %1$s. It needs to return one or throw an Exception',
-                            'event_espresso'
-                        ),
-                        $this->_job_id
-                    )
-                );
-            }
-            $this->_job_parameters->save();
-        } catch (\Exception $e) {
-            $response = $this->_get_error_response($e, 'continue_job');
-        }
-        return $response;
-    }
+	/**
+	 * Retrieves the job's arguments
+	 *
+	 * @param string $job_id
+	 * @param int    $batch_size
+	 * @return JobStepResponse
+	 */
+	public function continue_job($job_id, $batch_size = 50)
+	{
+		try {
+			$this->_job_id = $job_id;
+			$batch_size = defined('EE_BATCHRUNNER_BATCH_SIZE') ? EE_BATCHRUNNER_BATCH_SIZE : $batch_size;
+			// get the corresponding WordPress option for the job
+			$this->_job_parameters = JobParameters::load($this->_job_id);
+			$handler_obj = $this->instantiate_batch_job_handler_from_classname($this->_job_parameters->classname());
+			// continue it
+			$response = $handler_obj->continue_job($this->_job_parameters, $batch_size);
+			if (! $response instanceof JobStepResponse) {
+				throw new BatchRequestException(
+					sprintf(
+						__(
+							'The class implementing JobHandlerInterface did not return a JobStepResponse when continue_job was called with job %1$s. It needs to return one or throw an Exception',
+							'event_espresso'
+						),
+						$this->_job_id
+					)
+				);
+			}
+			$this->_job_parameters->save();
+		} catch (\Exception $e) {
+			$response = $this->_get_error_response($e, 'continue_job');
+		}
+		return $response;
+	}
 
 
-    /**
-     * Instantiates an object of type $classname, which implements
-     * JobHandlerInterface
-     *
-     * @param string $classname
-     * @return JobHandlerInterface
-     * @throws BatchRequestException
-     */
-    public function instantiate_batch_job_handler_from_classname($classname)
-    {
-        if (! class_exists($classname)) {
-            throw new BatchRequestException(
-                sprintf(
-                    __(
-                        'The class %1$s does not exist, and so could not be used for running a job. It should implement JobHandlerInterface.',
-                        'event_espresso'
-                    ),
-                    $classname
-                )
-            );
-        }
-        $obj = $this->loader->getNew($classname);
-        if (! $obj instanceof JobHandlerInterface) {
-            throw new BatchRequestException(
-                sprintf(
-                    __(
-                        'The class %1$s does not implement JobHandlerInterface and so could not be used for running a job',
-                        'event_espresso'
-                    ),
-                    $classname
-                )
-            );
-        }
-        return $obj;
-    }
+	/**
+	 * Instantiates an object of type $classname, which implements
+	 * JobHandlerInterface
+	 *
+	 * @param string $classname
+	 * @return JobHandlerInterface
+	 * @throws BatchRequestException
+	 */
+	public function instantiate_batch_job_handler_from_classname($classname)
+	{
+		if (! class_exists($classname)) {
+			throw new BatchRequestException(
+				sprintf(
+					__(
+						'The class %1$s does not exist, and so could not be used for running a job. It should implement JobHandlerInterface.',
+						'event_espresso'
+					),
+					$classname
+				)
+			);
+		}
+		$obj = $this->loader->getNew($classname);
+		if (! $obj instanceof JobHandlerInterface) {
+			throw new BatchRequestException(
+				sprintf(
+					__(
+						'The class %1$s does not implement JobHandlerInterface and so could not be used for running a job',
+						'event_espresso'
+					),
+					$classname
+				)
+			);
+		}
+		return $obj;
+	}
 
 
-    /**
-     * Forces a job to be cleaned up
-     *
-     * @param string $job_id
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     */
-    public function cleanup_job($job_id)
-    {
-        try {
-            $this->_job_id = $job_id;
-            $job_parameters = JobParameters::load($this->_job_id);
-            $handler_obj = $this->instantiate_batch_job_handler_from_classname($job_parameters->classname());
-            // continue it
-            $response = $handler_obj->cleanup_job($job_parameters);
-            if (! $response instanceof JobStepResponse) {
-                throw new BatchRequestException(
-                    sprintf(
-                        __(
-                            'The class implementing JobHandlerInterface did not return a JobStepResponse when cleanup_job was called with job %1$s. It needs to return one or throw an Exception',
-                            'event_espresso'
-                        ),
-                        $this->_job_id
-                    )
-                );
-            }
-            $job_parameters->set_status(JobParameters::status_cleaned_up);
-            $job_parameters->delete();
-            return $response;
-        } catch (\Exception $e) {
-            $response = $this->_get_error_response($e, 'cleanup_job');
-        }
-        return $response;
-    }
+	/**
+	 * Forces a job to be cleaned up
+	 *
+	 * @param string $job_id
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 */
+	public function cleanup_job($job_id)
+	{
+		try {
+			$this->_job_id = $job_id;
+			$job_parameters = JobParameters::load($this->_job_id);
+			$handler_obj = $this->instantiate_batch_job_handler_from_classname($job_parameters->classname());
+			// continue it
+			$response = $handler_obj->cleanup_job($job_parameters);
+			if (! $response instanceof JobStepResponse) {
+				throw new BatchRequestException(
+					sprintf(
+						__(
+							'The class implementing JobHandlerInterface did not return a JobStepResponse when cleanup_job was called with job %1$s. It needs to return one or throw an Exception',
+							'event_espresso'
+						),
+						$this->_job_id
+					)
+				);
+			}
+			$job_parameters->set_status(JobParameters::status_cleaned_up);
+			$job_parameters->delete();
+			return $response;
+		} catch (\Exception $e) {
+			$response = $this->_get_error_response($e, 'cleanup_job');
+		}
+		return $response;
+	}
 
 
-    /**
-     * Creates a valid JobStepResponse object from an exception and method name.
-     *
-     * @param \Exception $exception
-     * @param string     $method_name
-     * @return JobStepResponse
-     */
-    protected function _get_error_response(\Exception $exception, $method_name)
-    {
-        if (! $this->_job_parameters instanceof JobParameters) {
-            $this->_job_parameters = new JobParameters($this->_job_id, __('__Unknown__', 'event_espresso'), array());
-        }
-        $this->_job_parameters->set_status(JobParameters::status_error);
-        return new JobStepResponse(
-            $this->_job_parameters,
-            sprintf(
-                __(
-                    'An exception of type %1$s occurred while running %2$s. Its message was %3$s and had trace %4$s',
-                    'event_espresso'
-                ),
-                get_class($exception),
-                'BatchRunner::' . $method_name . '()',
-                $exception->getMessage(),
-                $exception->getTraceAsString()
-            )
-        );
-    }
+	/**
+	 * Creates a valid JobStepResponse object from an exception and method name.
+	 *
+	 * @param \Exception $exception
+	 * @param string     $method_name
+	 * @return JobStepResponse
+	 */
+	protected function _get_error_response(\Exception $exception, $method_name)
+	{
+		if (! $this->_job_parameters instanceof JobParameters) {
+			$this->_job_parameters = new JobParameters($this->_job_id, __('__Unknown__', 'event_espresso'), array());
+		}
+		$this->_job_parameters->set_status(JobParameters::status_error);
+		return new JobStepResponse(
+			$this->_job_parameters,
+			sprintf(
+				__(
+					'An exception of type %1$s occurred while running %2$s. Its message was %3$s and had trace %4$s',
+					'event_espresso'
+				),
+				get_class($exception),
+				'BatchRunner::' . $method_name . '()',
+				$exception->getMessage(),
+				$exception->getTraceAsString()
+			)
+		);
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -69,7 +69,7 @@ 
             $obj = $this->instantiate_batch_job_handler_from_classname($batch_job_handler_class);
             $this->_job_parameters = new JobParameters($this->_job_id, $batch_job_handler_class, $request_data);
             $response = $obj->create_job($this->_job_parameters);
-            if (! $response instanceof JobStepResponse) {
+            if ( ! $response instanceof JobStepResponse) {
                 throw new BatchRequestException(
                     sprintf(
                         __(
@@ -81,7 +81,7 @@ 
                 );
             }
             $success = $this->_job_parameters->save(true);
-            if (! $success) {
+            if ( ! $success) {
                 throw new BatchRequestException(
                     sprintf(
                         __(
@@ -117,7 +117,7 @@ 
             $handler_obj = $this->instantiate_batch_job_handler_from_classname($this->_job_parameters->classname());
             // continue it
             $response = $handler_obj->continue_job($this->_job_parameters, $batch_size);
-            if (! $response instanceof JobStepResponse) {
+            if ( ! $response instanceof JobStepResponse) {
                 throw new BatchRequestException(
                     sprintf(
                         __(
@@ -146,7 +146,7 @@ 
      */
     public function instantiate_batch_job_handler_from_classname($classname)
     {
-        if (! class_exists($classname)) {
+        if ( ! class_exists($classname)) {
             throw new BatchRequestException(
                 sprintf(
                     __(
@@ -158,7 +158,7 @@ 
             );
         }
         $obj = $this->loader->getNew($classname);
-        if (! $obj instanceof JobHandlerInterface) {
+        if ( ! $obj instanceof JobHandlerInterface) {
             throw new BatchRequestException(
                 sprintf(
                     __(
@@ -188,7 +188,7 @@ 
             $handler_obj = $this->instantiate_batch_job_handler_from_classname($job_parameters->classname());
             // continue it
             $response = $handler_obj->cleanup_job($job_parameters);
-            if (! $response instanceof JobStepResponse) {
+            if ( ! $response instanceof JobStepResponse) {
                 throw new BatchRequestException(
                     sprintf(
                         __(
@@ -218,7 +218,7 @@ 
      */
     protected function _get_error_response(\Exception $exception, $method_name)
     {
-        if (! $this->_job_parameters instanceof JobParameters) {
+        if ( ! $this->_job_parameters instanceof JobParameters) {
             $this->_job_parameters = new JobParameters($this->_job_id, __('__Unknown__', 'event_espresso'), array());
         }
         $this->_job_parameters->set_status(JobParameters::status_error);
@@ -230,7 +230,7 @@ 
                     'event_espresso'
                 ),
                 get_class($exception),
-                'BatchRunner::' . $method_name . '()',
+                'BatchRunner::'.$method_name.'()',
                 $exception->getMessage(),
                 $exception->getTraceAsString()
             )

core/libraries/form_sections/strategies/display/EE_File_Input_Display_Strategy.strategy.php

Indentation +7 added lines, -7 removed lines

@@ -10,11 +10,11 @@
  */
 class EE_File_Input_Display_Strategy extends EE_Text_Input_Display_Strategy
 {
-    /**
-     * Override's parent to just set the type. May someday support other arguments.
-     */
-    public function __construct()
-    {
-        parent::__construct('file');
-    }
+	/**
+	 * Override's parent to just set the type. May someday support other arguments.
+	 */
+	public function __construct()
+	{
+		parent::__construct('file');
+	}
 }

core/services/request/files/FileSubmissionInterface.php

Indentation +31 added lines, -31 removed lines

@@ -15,37 +15,37 @@
 interface FileSubmissionInterface
 {
 
-    /**
-     * @return string
-     */
-    public function getName();
-
-    /**
-     * @return string
-     */
-    public function getType();
-
-    /**
-     * @return int
-     */
-    public function getSize();
-
-    /**
-     * @return string
-     */
-    public function getTmpFile();
-
-    /**
-     * Should just return the filename.
-     * @since $VID:$
-     * @return string
-     */
-    public function __toString();
-
-    /**
-     * @return string
-     */
-    public function getErrorCode();
+	/**
+	 * @return string
+	 */
+	public function getName();
+
+	/**
+	 * @return string
+	 */
+	public function getType();
+
+	/**
+	 * @return int
+	 */
+	public function getSize();
+
+	/**
+	 * @return string
+	 */
+	public function getTmpFile();
+
+	/**
+	 * Should just return the filename.
+	 * @since $VID:$
+	 * @return string
+	 */
+	public function __toString();
+
+	/**
+	 * @return string
+	 */
+	public function getErrorCode();
 }
 // End of file FileSubmissionInterface.php
 // Location: EventEspresso\core\services\request\files/FileSubmissionInterface.php

core/libraries/form_sections/inputs/EE_File_Input.input.php

Indentation +75 added lines, -75 removed lines

@@ -19,86 +19,86 @@
  */
 class EE_File_Input extends EE_Form_Input_Base
 {
-    /**
-     * @var array
-     */
-    protected $allowed_file_extensions;
+	/**
+	 * @var array
+	 */
+	protected $allowed_file_extensions;
 
-    /**
-     * @var array
-     */
-    protected $allowed_mime_types;
+	/**
+	 * @var array
+	 */
+	protected $allowed_mime_types;
 
-    /**
-     * @param array $options
-     * @throws InvalidArgumentException
-     */
-    public function __construct($options = array())
-    {
-        if (isset($options['allowed_file_extensions'])) {
-            $this->allowed_file_extensions = (array) $options['allowed_file_extensions'];
-        } else {
-            $this->allowed_file_extensions = ['csv'];
-        }
-        if (isset($options['allowed_mime_types'])) {
-            $this->allowed_mime_types = (array) $options['allowed_file_extensions'];
-        } else {
-            $this->allowed_mime_types = ['text/csv'];
-        }
+	/**
+	 * @param array $options
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct($options = array())
+	{
+		if (isset($options['allowed_file_extensions'])) {
+			$this->allowed_file_extensions = (array) $options['allowed_file_extensions'];
+		} else {
+			$this->allowed_file_extensions = ['csv'];
+		}
+		if (isset($options['allowed_mime_types'])) {
+			$this->allowed_mime_types = (array) $options['allowed_file_extensions'];
+		} else {
+			$this->allowed_mime_types = ['text/csv'];
+		}
 
-        $this->_set_display_strategy(new EE_File_Input_Display_Strategy());
-        $this->_set_normalization_strategy(new EE_File_Normalization());
-        $this->add_validation_strategy(
-            new EE_Text_Validation_Strategy(
-                sprintf(
-                    // translators: %1$s is a list of allowed file extensions.
-                    esc_html__('Please provide a file of the requested filetype: %1$s', 'event_espresso'),
-                    implode(', ', $this->allowed_file_extensions)
-                ),
-                '~.*\.(' . implode('|', $this->allowed_file_extensions) . ')$~'
-            )
-        );
-        parent::__construct($options);
+		$this->_set_display_strategy(new EE_File_Input_Display_Strategy());
+		$this->_set_normalization_strategy(new EE_File_Normalization());
+		$this->add_validation_strategy(
+			new EE_Text_Validation_Strategy(
+				sprintf(
+					// translators: %1$s is a list of allowed file extensions.
+					esc_html__('Please provide a file of the requested filetype: %1$s', 'event_espresso'),
+					implode(', ', $this->allowed_file_extensions)
+				),
+				'~.*\.(' . implode('|', $this->allowed_file_extensions) . ')$~'
+			)
+		);
+		parent::__construct($options);
 
 //        It would be great to add this HTML attribute, but jQuery validate chokes on it.
-        $this->set_other_html_attributes(
-            $this->other_html_attributes()
-            . ' extension="'
-            . implode(
-                ',',
-                $this->allowed_file_extensions
-            )
-            . '"'
-        );
-    }
+		$this->set_other_html_attributes(
+			$this->other_html_attributes()
+			. ' extension="'
+			. implode(
+				',',
+				$this->allowed_file_extensions
+			)
+			. '"'
+		);
+	}
 
-    /**
-     * $_FILES has a really weird structure. So we let `FilesDataHandler` take care of finding the file info for
-     * this input.
-     * @since $VID:$
-     * @param array $req_data
-     * @return FileSubmissionInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function find_form_data_for_this_section($req_data)
-    {
-        // ignore $req_data. Files are in the files data handler.
-        $fileDataHandler = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\services\request\files\FilesDataHandler'
-        );
-        return $fileDataHandler->getFileObject($this->html_name());
-    }
+	/**
+	 * $_FILES has a really weird structure. So we let `FilesDataHandler` take care of finding the file info for
+	 * this input.
+	 * @since $VID:$
+	 * @param array $req_data
+	 * @return FileSubmissionInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function find_form_data_for_this_section($req_data)
+	{
+		// ignore $req_data. Files are in the files data handler.
+		$fileDataHandler = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\services\request\files\FilesDataHandler'
+		);
+		return $fileDataHandler->getFileObject($this->html_name());
+	}
 
-    /**
-     * Don't transform the file submission object into a string, thanks.
-     *
-     * @param string $value
-     * @return null|string
-     */
-    protected function _sanitize($value)
-    {
-        return $value;
-    }
+	/**
+	 * Don't transform the file submission object into a string, thanks.
+	 *
+	 * @param string $value
+	 * @return null|string
+	 */
+	protected function _sanitize($value)
+	{
+		return $value;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -55,7 +55,7 @@
                     esc_html__('Please provide a file of the requested filetype: %1$s', 'event_espresso'),
                     implode(', ', $this->allowed_file_extensions)
                 ),
-                '~.*\.(' . implode('|', $this->allowed_file_extensions) . ')$~'
+                '~.*\.('.implode('|', $this->allowed_file_extensions).')$~'
             )
         );
         parent::__construct($options);

core/libraries/form_sections/form_handlers/FormHandler.php

Indentation +635 added lines, -635 removed lines

@@ -29,639 +29,639 @@
 abstract class FormHandler implements FormHandlerInterface
 {
 
-    /**
-     * will add opening and closing HTML form tags as well as a submit button
-     */
-    const ADD_FORM_TAGS_AND_SUBMIT = 'add_form_tags_and_submit';
-
-    /**
-     * will add opening and closing HTML form tags but NOT a submit button
-     */
-    const ADD_FORM_TAGS_ONLY = 'add_form_tags_only';
-
-    /**
-     * will NOT add opening and closing HTML form tags but will add a submit button
-     */
-    const ADD_FORM_SUBMIT_ONLY = 'add_form_submit_only';
-
-    /**
-     * will NOT add opening and closing HTML form tags NOR a submit button
-     */
-    const DO_NOT_SETUP_FORM = 'do_not_setup_form';
-
-    /**
-     * if set to false, then this form has no displayable content,
-     * and will only be used for processing data sent passed via GET or POST
-     * defaults to true ( ie: form has displayable content )
-     *
-     * @var boolean $displayable
-     */
-    private $displayable = true;
-
-    /**
-     * @var string $form_name
-     */
-    private $form_name;
-
-    /**
-     * @var string $admin_name
-     */
-    private $admin_name;
-
-    /**
-     * @var string $slug
-     */
-    private $slug;
-
-    /**
-     * @var string $submit_btn_text
-     */
-    private $submit_btn_text;
-
-    /**
-     * @var string $form_action
-     */
-    private $form_action;
-
-    /**
-     * form params in key value pairs
-     * can be added to form action URL or as hidden inputs
-     *
-     * @var array $form_args
-     */
-    private $form_args = array();
-
-    /**
-     * value of one of the string constant above
-     *
-     * @var string $form_config
-     */
-    private $form_config;
-
-    /**
-     * whether or not the form was determined to be invalid
-     *
-     * @var boolean $form_has_errors
-     */
-    private $form_has_errors;
-
-    /**
-     * the absolute top level form section being used on the page
-     *
-     * @var EE_Form_Section_Proper $form
-     */
-    private $form;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    protected $registry;
-
-    // phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd
-    /**
-     * Form constructor.
-     *
-     * @param string      $form_name
-     * @param string      $admin_name
-     * @param string      $slug
-     * @param string      $form_action
-     * @param string      $form_config
-     * @param EE_Registry $registry
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     */
-    public function __construct(
-        $form_name,
-        $admin_name,
-        $slug,
-        $form_action = '',
-        $form_config = FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-        EE_Registry $registry
-    ) {
-        $this->setFormName($form_name);
-        $this->setAdminName($admin_name);
-        $this->setSlug($slug);
-        $this->setFormAction($form_action);
-        $this->setFormConfig($form_config);
-        $this->setSubmitBtnText(esc_html__('Submit', 'event_espresso'));
-        $this->registry = $registry;
-    }
-
-
-    /**
-     * @return array
-     */
-    public static function getFormConfigConstants()
-    {
-        return array(
-            FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-            FormHandler::ADD_FORM_TAGS_ONLY,
-            FormHandler::ADD_FORM_SUBMIT_ONLY,
-            FormHandler::DO_NOT_SETUP_FORM,
-        );
-    }
-
-
-    /**
-     * @param bool $for_display
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws LogicException
-     */
-    public function form($for_display = false)
-    {
-        if (! $this->formIsValid()) {
-            return null;
-        }
-        if ($for_display) {
-            $form_config = $this->formConfig();
-            if ($form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
-                || $form_config === FormHandler::ADD_FORM_SUBMIT_ONLY
-            ) {
-                $this->appendSubmitButton();
-                $this->clearFormButtonFloats();
-            }
-        }
-        return $this->form;
-    }
-
-
-    /**
-     * @return boolean
-     * @throws LogicException
-     */
-    public function formIsValid()
-    {
-        if ($this->form instanceof EE_Form_Section_Proper) {
-            return true;
-        }
-        $form = apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__formIsValid__generated_form_object',
-            $this->generate(),
-            $this
-        );
-        if ($this->verifyForm($form)) {
-            $this->setForm($form);
-        }
-        return true;
-    }
-
-
-    /**
-     * @param EE_Form_Section_Proper|null $form
-     * @return bool
-     * @throws LogicException
-     */
-    public function verifyForm(EE_Form_Section_Proper $form = null)
-    {
-        $form = $form !== null ? $form : $this->form;
-        if ($form instanceof EE_Form_Section_Proper) {
-            return true;
-        }
-        throw new LogicException(
-            sprintf(
-                esc_html__('The "%1$s" form is invalid or missing. %2$s', 'event_espresso'),
-                $this->form_name,
-                var_export($form, true)
-            )
-        );
-    }
-
-
-    /**
-     * @param EE_Form_Section_Proper $form
-     */
-    public function setForm(EE_Form_Section_Proper $form)
-    {
-        $this->form = $form;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function displayable()
-    {
-        return $this->displayable;
-    }
-
-
-    /**
-     * @param boolean $displayable
-     */
-    public function setDisplayable($displayable = false)
-    {
-        $this->displayable = filter_var($displayable, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * a public name for the form that can be displayed on the frontend of a site
-     *
-     * @return string
-     */
-    public function formName()
-    {
-        return $this->form_name;
-    }
-
-
-    /**
-     * @param string $form_name
-     * @throws InvalidDataTypeException
-     */
-    public function setFormName($form_name)
-    {
-        if (! is_string($form_name)) {
-            throw new InvalidDataTypeException('$form_name', $form_name, 'string');
-        }
-        $this->form_name = $form_name;
-    }
-
-
-    /**
-     * a public name for the form that can be displayed, but only in the admin
-     *
-     * @return string
-     */
-    public function adminName()
-    {
-        return $this->admin_name;
-    }
-
-
-    /**
-     * @param string $admin_name
-     * @throws InvalidDataTypeException
-     */
-    public function setAdminName($admin_name)
-    {
-        if (! is_string($admin_name)) {
-            throw new InvalidDataTypeException('$admin_name', $admin_name, 'string');
-        }
-        $this->admin_name = $admin_name;
-    }
-
-
-    /**
-     * a URL friendly string that can be used for identifying the form
-     *
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->slug;
-    }
-
-
-    /**
-     * @param string $slug
-     * @throws InvalidDataTypeException
-     */
-    public function setSlug($slug)
-    {
-        if (! is_string($slug)) {
-            throw new InvalidDataTypeException('$slug', $slug, 'string');
-        }
-        $this->slug = $slug;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function submitBtnText()
-    {
-        return $this->submit_btn_text;
-    }
-
-
-    /**
-     * @param string $submit_btn_text
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function setSubmitBtnText($submit_btn_text)
-    {
-        if (! is_string($submit_btn_text)) {
-            throw new InvalidDataTypeException('$submit_btn_text', $submit_btn_text, 'string');
-        }
-        if (empty($submit_btn_text)) {
-            throw new InvalidArgumentException(
-                esc_html__('Can not set Submit button text because an empty string was provided.', 'event_espresso')
-            );
-        }
-        $this->submit_btn_text = $submit_btn_text;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function formAction()
-    {
-        return ! empty($this->form_args)
-            ? add_query_arg($this->form_args, $this->form_action)
-            : $this->form_action;
-    }
-
-
-    /**
-     * @param string $form_action
-     * @throws InvalidDataTypeException
-     */
-    public function setFormAction($form_action)
-    {
-        if (! is_string($form_action)) {
-            throw new InvalidDataTypeException('$form_action', $form_action, 'string');
-        }
-        $this->form_action = $form_action;
-    }
-
-
-    /**
-     * @param array $form_args
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function addFormActionArgs($form_args = array())
-    {
-        if (is_object($form_args)) {
-            throw new InvalidDataTypeException(
-                '$form_args',
-                $form_args,
-                'anything other than an object was expected.'
-            );
-        }
-        if (empty($form_args)) {
-            throw new InvalidArgumentException(
-                esc_html__('The redirect arguments can not be an empty array.', 'event_espresso')
-            );
-        }
-        $this->form_args = array_merge($this->form_args, $form_args);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function formConfig()
-    {
-        return $this->form_config;
-    }
-
-
-    /**
-     * @param string $form_config
-     * @throws DomainException
-     */
-    public function setFormConfig($form_config)
-    {
-        if (! in_array(
-            $form_config,
-            array(
-                FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
-                FormHandler::ADD_FORM_TAGS_ONLY,
-                FormHandler::ADD_FORM_SUBMIT_ONLY,
-                FormHandler::DO_NOT_SETUP_FORM,
-            ),
-            true
-        )
-        ) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        '"%1$s" is not a valid value for the form config. Please use one of the class constants on \EventEspresso\core\libraries\form_sections\form_handlers\Form',
-                        'event_espresso'
-                    ),
-                    $form_config
-                )
-            );
-        }
-        $this->form_config = $form_config;
-    }
-
-
-    /**
-     * called after the form is instantiated
-     * and used for performing any logic that needs to occur early
-     * before any of the other methods are called.
-     * returns true if everything is ok to proceed,
-     * and false if no further form logic should be implemented
-     *
-     * @return boolean
-     */
-    public function initialize()
-    {
-        $this->form_has_errors = EE_Error::has_error(true);
-        return true;
-    }
-
-
-    /**
-     * used for setting up css and js
-     *
-     * @return void
-     * @throws LogicException
-     * @throws EE_Error
-     */
-    public function enqueueStylesAndScripts()
-    {
-        $this->form()->enqueue_js();
-    }
-
-
-    /**
-     * creates and returns the actual form
-     *
-     * @return EE_Form_Section_Proper
-     */
-    abstract public function generate();
-
-
-    /**
-     * creates and returns an EE_Submit_Input labeled "Submit"
-     *
-     * @param string $text
-     * @return EE_Submit_Input
-     */
-    public function generateSubmitButton($text = '')
-    {
-        $text = ! empty($text) ? $text : $this->submitBtnText();
-        return new EE_Submit_Input(
-            array(
-                'html_name'             => 'ee-form-submit-' . $this->slug(),
-                'html_id'               => 'ee-form-submit-' . $this->slug(),
-                'html_class'            => 'ee-form-submit',
-                'html_label'            => ' ',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
-                'default'               => $text,
-            )
-        );
-    }
-
-
-    /**
-     * calls generateSubmitButton() and appends it onto the form along with a float clearing div
-     *
-     * @param string $text
-     * @return void
-     * @throws EE_Error
-     */
-    public function appendSubmitButton($text = '')
-    {
-        if ($this->form->subsection_exists($this->slug() . '-submit-btn')) {
-            return;
-        }
-        $this->form->add_subsections(
-            array($this->slug() . '-submit-btn' => $this->generateSubmitButton($text)),
-            null,
-            false
-        );
-    }
-
-
-    /**
-     * creates and returns an EE_Submit_Input labeled "Cancel"
-     *
-     * @param string $text
-     * @return EE_Submit_Input
-     */
-    public function generateCancelButton($text = '')
-    {
-        $cancel_button = new EE_Submit_Input(
-            array(
-                'html_name'             => 'ee-form-submit-' . $this->slug(), // YES! Same name as submit !!!
-                'html_id'               => 'ee-cancel-form-' . $this->slug(),
-                'html_class'            => 'ee-cancel-form',
-                'html_label'            => ' ',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
-                'default'               => ! empty($text) ? $text : esc_html__('Cancel', 'event_espresso'),
-            )
-        );
-        $cancel_button->set_button_css_attributes(false);
-        return $cancel_button;
-    }
-
-
-    /**
-     * appends a float clearing div onto end of form
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function clearFormButtonFloats()
-    {
-        $this->form->add_subsections(
-            array(
-                'clear-submit-btn-float' => new EE_Form_Section_HTML(
-                    EEH_HTML::div('', '', 'clear-float') . EEH_HTML::divx()
-                ),
-            ),
-            null,
-            false
-        );
-    }
-
-
-    /**
-     * takes the generated form and displays it along with ony other non-form HTML that may be required
-     * returns a string of HTML that can be directly echoed in a template
-     *
-     * @return string
-     * @throws \InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws LogicException
-     * @throws EE_Error
-     */
-    public function display()
-    {
-        $form_html = apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__before_form',
-            ''
-        );
-        $form_config = $this->formConfig();
-        if ($form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
-            || $form_config === FormHandler::ADD_FORM_TAGS_ONLY
-        ) {
-            $additional_props = $this->requiresMultipartEnctype()
-                ? 'enctype="multipart/form-data"'
-                : '';
-            $form_html .= $this->form()->form_open(
-                $this->formAction(),
-                'POST',
-                $additional_props
-            );
-        }
-        $form_html .= $this->form(true)->get_html();
-        if ($form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
-            || $form_config === FormHandler::ADD_FORM_TAGS_ONLY
-        ) {
-            $form_html .= $this->form()->form_close();
-        }
-        $form_html .= apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__after_form',
-            ''
-        );
-        return $form_html;
-    }
-
-    /**
-     * Determines if this form needs "enctype='multipart/form-data'" or not.
-     * @since $VID:$
-     * @return bool
-     * @throws EE_Error
-     */
-    public function requiresMultipartEnctype()
-    {
-        foreach ($this->form()->inputs_in_subsections() as $input) {
-            if ($input instanceof EE_File_Input) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * handles processing the form submission
-     * returns true or false depending on whether the form was processed successfully or not
-     *
-     * @param array $submitted_form_data
-     * @return array
-     * @throws \InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws EE_Error
-     * @throws LogicException
-     * @throws InvalidFormSubmissionException
-     */
-    public function process($submitted_form_data = array())
-    {
-        if (! $this->form()->was_submitted($submitted_form_data)) {
-            throw new InvalidFormSubmissionException($this->form_name);
-        }
-        $this->form(true)->receive_form_submission($submitted_form_data);
-        if (! $this->form()->is_valid()) {
-            throw new InvalidFormSubmissionException(
-                $this->form_name,
-                sprintf(
-                    esc_html__(
-                        'The "%1$s" form is invalid. Please correct the following errors and resubmit: %2$s %3$s',
-                        'event_espresso'
-                    ),
-                    $this->form_name,
-                    '<br />',
-                    implode('<br />', $this->form()->get_validation_errors_accumulated())
-                )
-            );
-        }
-        return apply_filters(
-            'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__process__valid_data',
-            $this->form()->valid_data(),
-            $this
-        );
-    }
+	/**
+	 * will add opening and closing HTML form tags as well as a submit button
+	 */
+	const ADD_FORM_TAGS_AND_SUBMIT = 'add_form_tags_and_submit';
+
+	/**
+	 * will add opening and closing HTML form tags but NOT a submit button
+	 */
+	const ADD_FORM_TAGS_ONLY = 'add_form_tags_only';
+
+	/**
+	 * will NOT add opening and closing HTML form tags but will add a submit button
+	 */
+	const ADD_FORM_SUBMIT_ONLY = 'add_form_submit_only';
+
+	/**
+	 * will NOT add opening and closing HTML form tags NOR a submit button
+	 */
+	const DO_NOT_SETUP_FORM = 'do_not_setup_form';
+
+	/**
+	 * if set to false, then this form has no displayable content,
+	 * and will only be used for processing data sent passed via GET or POST
+	 * defaults to true ( ie: form has displayable content )
+	 *
+	 * @var boolean $displayable
+	 */
+	private $displayable = true;
+
+	/**
+	 * @var string $form_name
+	 */
+	private $form_name;
+
+	/**
+	 * @var string $admin_name
+	 */
+	private $admin_name;
+
+	/**
+	 * @var string $slug
+	 */
+	private $slug;
+
+	/**
+	 * @var string $submit_btn_text
+	 */
+	private $submit_btn_text;
+
+	/**
+	 * @var string $form_action
+	 */
+	private $form_action;
+
+	/**
+	 * form params in key value pairs
+	 * can be added to form action URL or as hidden inputs
+	 *
+	 * @var array $form_args
+	 */
+	private $form_args = array();
+
+	/**
+	 * value of one of the string constant above
+	 *
+	 * @var string $form_config
+	 */
+	private $form_config;
+
+	/**
+	 * whether or not the form was determined to be invalid
+	 *
+	 * @var boolean $form_has_errors
+	 */
+	private $form_has_errors;
+
+	/**
+	 * the absolute top level form section being used on the page
+	 *
+	 * @var EE_Form_Section_Proper $form
+	 */
+	private $form;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	protected $registry;
+
+	// phpcs:disable PEAR.Functions.ValidDefaultValue.NotAtEnd
+	/**
+	 * Form constructor.
+	 *
+	 * @param string      $form_name
+	 * @param string      $admin_name
+	 * @param string      $slug
+	 * @param string      $form_action
+	 * @param string      $form_config
+	 * @param EE_Registry $registry
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct(
+		$form_name,
+		$admin_name,
+		$slug,
+		$form_action = '',
+		$form_config = FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+		EE_Registry $registry
+	) {
+		$this->setFormName($form_name);
+		$this->setAdminName($admin_name);
+		$this->setSlug($slug);
+		$this->setFormAction($form_action);
+		$this->setFormConfig($form_config);
+		$this->setSubmitBtnText(esc_html__('Submit', 'event_espresso'));
+		$this->registry = $registry;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public static function getFormConfigConstants()
+	{
+		return array(
+			FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+			FormHandler::ADD_FORM_TAGS_ONLY,
+			FormHandler::ADD_FORM_SUBMIT_ONLY,
+			FormHandler::DO_NOT_SETUP_FORM,
+		);
+	}
+
+
+	/**
+	 * @param bool $for_display
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws LogicException
+	 */
+	public function form($for_display = false)
+	{
+		if (! $this->formIsValid()) {
+			return null;
+		}
+		if ($for_display) {
+			$form_config = $this->formConfig();
+			if ($form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
+				|| $form_config === FormHandler::ADD_FORM_SUBMIT_ONLY
+			) {
+				$this->appendSubmitButton();
+				$this->clearFormButtonFloats();
+			}
+		}
+		return $this->form;
+	}
+
+
+	/**
+	 * @return boolean
+	 * @throws LogicException
+	 */
+	public function formIsValid()
+	{
+		if ($this->form instanceof EE_Form_Section_Proper) {
+			return true;
+		}
+		$form = apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__formIsValid__generated_form_object',
+			$this->generate(),
+			$this
+		);
+		if ($this->verifyForm($form)) {
+			$this->setForm($form);
+		}
+		return true;
+	}
+
+
+	/**
+	 * @param EE_Form_Section_Proper|null $form
+	 * @return bool
+	 * @throws LogicException
+	 */
+	public function verifyForm(EE_Form_Section_Proper $form = null)
+	{
+		$form = $form !== null ? $form : $this->form;
+		if ($form instanceof EE_Form_Section_Proper) {
+			return true;
+		}
+		throw new LogicException(
+			sprintf(
+				esc_html__('The "%1$s" form is invalid or missing. %2$s', 'event_espresso'),
+				$this->form_name,
+				var_export($form, true)
+			)
+		);
+	}
+
+
+	/**
+	 * @param EE_Form_Section_Proper $form
+	 */
+	public function setForm(EE_Form_Section_Proper $form)
+	{
+		$this->form = $form;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function displayable()
+	{
+		return $this->displayable;
+	}
+
+
+	/**
+	 * @param boolean $displayable
+	 */
+	public function setDisplayable($displayable = false)
+	{
+		$this->displayable = filter_var($displayable, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * a public name for the form that can be displayed on the frontend of a site
+	 *
+	 * @return string
+	 */
+	public function formName()
+	{
+		return $this->form_name;
+	}
+
+
+	/**
+	 * @param string $form_name
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormName($form_name)
+	{
+		if (! is_string($form_name)) {
+			throw new InvalidDataTypeException('$form_name', $form_name, 'string');
+		}
+		$this->form_name = $form_name;
+	}
+
+
+	/**
+	 * a public name for the form that can be displayed, but only in the admin
+	 *
+	 * @return string
+	 */
+	public function adminName()
+	{
+		return $this->admin_name;
+	}
+
+
+	/**
+	 * @param string $admin_name
+	 * @throws InvalidDataTypeException
+	 */
+	public function setAdminName($admin_name)
+	{
+		if (! is_string($admin_name)) {
+			throw new InvalidDataTypeException('$admin_name', $admin_name, 'string');
+		}
+		$this->admin_name = $admin_name;
+	}
+
+
+	/**
+	 * a URL friendly string that can be used for identifying the form
+	 *
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->slug;
+	}
+
+
+	/**
+	 * @param string $slug
+	 * @throws InvalidDataTypeException
+	 */
+	public function setSlug($slug)
+	{
+		if (! is_string($slug)) {
+			throw new InvalidDataTypeException('$slug', $slug, 'string');
+		}
+		$this->slug = $slug;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function submitBtnText()
+	{
+		return $this->submit_btn_text;
+	}
+
+
+	/**
+	 * @param string $submit_btn_text
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function setSubmitBtnText($submit_btn_text)
+	{
+		if (! is_string($submit_btn_text)) {
+			throw new InvalidDataTypeException('$submit_btn_text', $submit_btn_text, 'string');
+		}
+		if (empty($submit_btn_text)) {
+			throw new InvalidArgumentException(
+				esc_html__('Can not set Submit button text because an empty string was provided.', 'event_espresso')
+			);
+		}
+		$this->submit_btn_text = $submit_btn_text;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function formAction()
+	{
+		return ! empty($this->form_args)
+			? add_query_arg($this->form_args, $this->form_action)
+			: $this->form_action;
+	}
+
+
+	/**
+	 * @param string $form_action
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFormAction($form_action)
+	{
+		if (! is_string($form_action)) {
+			throw new InvalidDataTypeException('$form_action', $form_action, 'string');
+		}
+		$this->form_action = $form_action;
+	}
+
+
+	/**
+	 * @param array $form_args
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function addFormActionArgs($form_args = array())
+	{
+		if (is_object($form_args)) {
+			throw new InvalidDataTypeException(
+				'$form_args',
+				$form_args,
+				'anything other than an object was expected.'
+			);
+		}
+		if (empty($form_args)) {
+			throw new InvalidArgumentException(
+				esc_html__('The redirect arguments can not be an empty array.', 'event_espresso')
+			);
+		}
+		$this->form_args = array_merge($this->form_args, $form_args);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function formConfig()
+	{
+		return $this->form_config;
+	}
+
+
+	/**
+	 * @param string $form_config
+	 * @throws DomainException
+	 */
+	public function setFormConfig($form_config)
+	{
+		if (! in_array(
+			$form_config,
+			array(
+				FormHandler::ADD_FORM_TAGS_AND_SUBMIT,
+				FormHandler::ADD_FORM_TAGS_ONLY,
+				FormHandler::ADD_FORM_SUBMIT_ONLY,
+				FormHandler::DO_NOT_SETUP_FORM,
+			),
+			true
+		)
+		) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'"%1$s" is not a valid value for the form config. Please use one of the class constants on \EventEspresso\core\libraries\form_sections\form_handlers\Form',
+						'event_espresso'
+					),
+					$form_config
+				)
+			);
+		}
+		$this->form_config = $form_config;
+	}
+
+
+	/**
+	 * called after the form is instantiated
+	 * and used for performing any logic that needs to occur early
+	 * before any of the other methods are called.
+	 * returns true if everything is ok to proceed,
+	 * and false if no further form logic should be implemented
+	 *
+	 * @return boolean
+	 */
+	public function initialize()
+	{
+		$this->form_has_errors = EE_Error::has_error(true);
+		return true;
+	}
+
+
+	/**
+	 * used for setting up css and js
+	 *
+	 * @return void
+	 * @throws LogicException
+	 * @throws EE_Error
+	 */
+	public function enqueueStylesAndScripts()
+	{
+		$this->form()->enqueue_js();
+	}
+
+
+	/**
+	 * creates and returns the actual form
+	 *
+	 * @return EE_Form_Section_Proper
+	 */
+	abstract public function generate();
+
+
+	/**
+	 * creates and returns an EE_Submit_Input labeled "Submit"
+	 *
+	 * @param string $text
+	 * @return EE_Submit_Input
+	 */
+	public function generateSubmitButton($text = '')
+	{
+		$text = ! empty($text) ? $text : $this->submitBtnText();
+		return new EE_Submit_Input(
+			array(
+				'html_name'             => 'ee-form-submit-' . $this->slug(),
+				'html_id'               => 'ee-form-submit-' . $this->slug(),
+				'html_class'            => 'ee-form-submit',
+				'html_label'            => '&nbsp;',
+				'other_html_attributes' => ' rel="' . $this->slug() . '"',
+				'default'               => $text,
+			)
+		);
+	}
+
+
+	/**
+	 * calls generateSubmitButton() and appends it onto the form along with a float clearing div
+	 *
+	 * @param string $text
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function appendSubmitButton($text = '')
+	{
+		if ($this->form->subsection_exists($this->slug() . '-submit-btn')) {
+			return;
+		}
+		$this->form->add_subsections(
+			array($this->slug() . '-submit-btn' => $this->generateSubmitButton($text)),
+			null,
+			false
+		);
+	}
+
+
+	/**
+	 * creates and returns an EE_Submit_Input labeled "Cancel"
+	 *
+	 * @param string $text
+	 * @return EE_Submit_Input
+	 */
+	public function generateCancelButton($text = '')
+	{
+		$cancel_button = new EE_Submit_Input(
+			array(
+				'html_name'             => 'ee-form-submit-' . $this->slug(), // YES! Same name as submit !!!
+				'html_id'               => 'ee-cancel-form-' . $this->slug(),
+				'html_class'            => 'ee-cancel-form',
+				'html_label'            => '&nbsp;',
+				'other_html_attributes' => ' rel="' . $this->slug() . '"',
+				'default'               => ! empty($text) ? $text : esc_html__('Cancel', 'event_espresso'),
+			)
+		);
+		$cancel_button->set_button_css_attributes(false);
+		return $cancel_button;
+	}
+
+
+	/**
+	 * appends a float clearing div onto end of form
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function clearFormButtonFloats()
+	{
+		$this->form->add_subsections(
+			array(
+				'clear-submit-btn-float' => new EE_Form_Section_HTML(
+					EEH_HTML::div('', '', 'clear-float') . EEH_HTML::divx()
+				),
+			),
+			null,
+			false
+		);
+	}
+
+
+	/**
+	 * takes the generated form and displays it along with ony other non-form HTML that may be required
+	 * returns a string of HTML that can be directly echoed in a template
+	 *
+	 * @return string
+	 * @throws \InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws LogicException
+	 * @throws EE_Error
+	 */
+	public function display()
+	{
+		$form_html = apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__before_form',
+			''
+		);
+		$form_config = $this->formConfig();
+		if ($form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
+			|| $form_config === FormHandler::ADD_FORM_TAGS_ONLY
+		) {
+			$additional_props = $this->requiresMultipartEnctype()
+				? 'enctype="multipart/form-data"'
+				: '';
+			$form_html .= $this->form()->form_open(
+				$this->formAction(),
+				'POST',
+				$additional_props
+			);
+		}
+		$form_html .= $this->form(true)->get_html();
+		if ($form_config === FormHandler::ADD_FORM_TAGS_AND_SUBMIT
+			|| $form_config === FormHandler::ADD_FORM_TAGS_ONLY
+		) {
+			$form_html .= $this->form()->form_close();
+		}
+		$form_html .= apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__display__after_form',
+			''
+		);
+		return $form_html;
+	}
+
+	/**
+	 * Determines if this form needs "enctype='multipart/form-data'" or not.
+	 * @since $VID:$
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function requiresMultipartEnctype()
+	{
+		foreach ($this->form()->inputs_in_subsections() as $input) {
+			if ($input instanceof EE_File_Input) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * handles processing the form submission
+	 * returns true or false depending on whether the form was processed successfully or not
+	 *
+	 * @param array $submitted_form_data
+	 * @return array
+	 * @throws \InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws LogicException
+	 * @throws InvalidFormSubmissionException
+	 */
+	public function process($submitted_form_data = array())
+	{
+		if (! $this->form()->was_submitted($submitted_form_data)) {
+			throw new InvalidFormSubmissionException($this->form_name);
+		}
+		$this->form(true)->receive_form_submission($submitted_form_data);
+		if (! $this->form()->is_valid()) {
+			throw new InvalidFormSubmissionException(
+				$this->form_name,
+				sprintf(
+					esc_html__(
+						'The "%1$s" form is invalid. Please correct the following errors and resubmit: %2$s %3$s',
+						'event_espresso'
+					),
+					$this->form_name,
+					'<br />',
+					implode('<br />', $this->form()->get_validation_errors_accumulated())
+				)
+			);
+		}
+		return apply_filters(
+			'FHEE__EventEspresso_core_libraries_form_sections_form_handlers_FormHandler__process__valid_data',
+			$this->form()->valid_data(),
+			$this
+		);
+	}
 }

core/libraries/form_sections/strategies/normalization/EE_File_Normalization.strategy.php

Indentation +34 added lines, -34 removed lines

@@ -13,40 +13,40 @@
 class EE_File_Normalization extends EE_Normalization_Strategy_Base
 {
 
-    /**
-     * Keep in mind $value_to_normalize should be a FileSubmissionInterface or null, so this shouldn't really do
-     * much (other than NOT convert it to a string or something).
-     * @param string $value_to_normalize
-     * @return FileSubmissionInterface
-     */
-    public function normalize($value_to_normalize)
-    {
-        if ($value_to_normalize instanceof FileSubmissionInterface || is_null($value_to_normalize)) {
-            return $value_to_normalize;
-        } else {
-            throw new EE_Validation_Error(
-                esc_html__('The file input has an invalid format.', 'event_espresso')
-            );
-        }
-    }
+	/**
+	 * Keep in mind $value_to_normalize should be a FileSubmissionInterface or null, so this shouldn't really do
+	 * much (other than NOT convert it to a string or something).
+	 * @param string $value_to_normalize
+	 * @return FileSubmissionInterface
+	 */
+	public function normalize($value_to_normalize)
+	{
+		if ($value_to_normalize instanceof FileSubmissionInterface || is_null($value_to_normalize)) {
+			return $value_to_normalize;
+		} else {
+			throw new EE_Validation_Error(
+				esc_html__('The file input has an invalid format.', 'event_espresso')
+			);
+		}
+	}
 
 
-    /**
-     * This may be called prematurely on submitted data, so we actually don't want to convert it into a string because
-     * we'll lose all the FileSubmissionInterface data. So prefer to leave it alone. FileSubmissionInterface
-     * can be cast to a string just fine so it's good as-is.
-     *
-     * @param string $normalized_value
-     * @return string
-     */
-    public function unnormalize($normalized_value)
-    {
-        if ($normalized_value instanceof FileSubmissionInterface || is_null($normalized_value)) {
-            // Leave it as the object, it can be treated like a string because it
-            // overrides __toString()
-            return $normalized_value;
-        } else {
-            return (string) $normalized_value;
-        }
-    }
+	/**
+	 * This may be called prematurely on submitted data, so we actually don't want to convert it into a string because
+	 * we'll lose all the FileSubmissionInterface data. So prefer to leave it alone. FileSubmissionInterface
+	 * can be cast to a string just fine so it's good as-is.
+	 *
+	 * @param string $normalized_value
+	 * @return string
+	 */
+	public function unnormalize($normalized_value)
+	{
+		if ($normalized_value instanceof FileSubmissionInterface || is_null($normalized_value)) {
+			// Leave it as the object, it can be treated like a string because it
+			// overrides __toString()
+			return $normalized_value;
+		} else {
+			return (string) $normalized_value;
+		}
+	}
 }

core/db_models/EEM_Datetime.model.php

Indentation +743 added lines, -743 removed lines

@@ -13,747 +13,747 @@
 class EEM_Datetime extends EEM_Soft_Delete_Base
 {
 
-    /**
-     * @var EEM_Datetime $_instance
-     */
-    protected static $_instance;
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param string $timezone A string representing the timezone we want to set for returned Date Time Strings
-     *                         (and any incoming timezone data that gets saved).
-     *                         Note this just sends the timezone info to the date time model field objects.
-     *                         Default is NULL
-     *                         (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     */
-    protected function __construct($timezone)
-    {
-        $this->singular_item           = esc_html__('Datetime', 'event_espresso');
-        $this->plural_item             = esc_html__('Datetimes', 'event_espresso');
-        $this->_tables                 = array(
-            'Datetime' => new EE_Primary_Table('esp_datetime', 'DTT_ID'),
-        );
-        $this->_fields                 = array(
-            'Datetime' => array(
-                'DTT_ID'          => new EE_Primary_Key_Int_Field(
-                    'DTT_ID',
-                    esc_html__('Datetime ID', 'event_espresso')
-                ),
-                'EVT_ID'          => new EE_Foreign_Key_Int_Field(
-                    'EVT_ID',
-                    esc_html__('Event ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Event'
-                ),
-                'DTT_name'        => new EE_Plain_Text_Field(
-                    'DTT_name',
-                    esc_html__('Datetime Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'DTT_description' => new EE_Post_Content_Field(
-                    'DTT_description',
-                    esc_html__('Description for Datetime', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'DTT_EVT_start'   => new EE_Datetime_Field(
-                    'DTT_EVT_start',
-                    esc_html__('Start time/date of Event', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'DTT_EVT_end'     => new EE_Datetime_Field(
-                    'DTT_EVT_end',
-                    esc_html__('End time/date of Event', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'DTT_reg_limit'   => new EE_Infinite_Integer_Field(
-                    'DTT_reg_limit',
-                    esc_html__('Registration Limit for this time', 'event_espresso'),
-                    true,
-                    EE_INF
-                ),
-                'DTT_sold'        => new EE_Integer_Field(
-                    'DTT_sold',
-                    esc_html__('How many sales for this Datetime that have occurred', 'event_espresso'),
-                    true,
-                    0
-                ),
-                'DTT_reserved'    => new EE_Integer_Field(
-                    'DTT_reserved',
-                    esc_html__('Quantity of tickets reserved, but not yet fully purchased', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'DTT_is_primary'  => new EE_Boolean_Field(
-                    'DTT_is_primary',
-                    esc_html__('Flag indicating datetime is primary one for event', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'DTT_order'       => new EE_Integer_Field(
-                    'DTT_order',
-                    esc_html__('The order in which the Datetime is displayed', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'DTT_parent'      => new EE_Integer_Field(
-                    'DTT_parent',
-                    esc_html__('Indicates what DTT_ID is the parent of this DTT_ID', 'event_espresso'),
-                    true,
-                    0
-                ),
-                'DTT_deleted'     => new EE_Trashed_Flag_Field(
-                    'DTT_deleted',
-                    esc_html__('Flag indicating datetime is archived', 'event_espresso'),
-                    false,
-                    false
-                ),
-            ),
-        );
-        $this->_model_relations        = array(
-            'Ticket'  => new EE_HABTM_Relation('Datetime_Ticket'),
-            'Event'   => new EE_Belongs_To_Relation(),
-            'Checkin' => new EE_Has_Many_Relation(),
-            'Datetime_Ticket' => new EE_Has_Many_Relation(),
-        );
-        $path_to_event_model = 'Event';
-        $this->model_chain_to_password = $path_to_event_model;
-        $this->_model_chain_to_wp_user = $path_to_event_model;
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       = new EE_Restriction_Generator_Event_Related_Public(
-            $path_to_event_model
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected(
-            $path_to_event_model
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       = new EE_Restriction_Generator_Event_Related_Protected(
-            $path_to_event_model
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     = new EE_Restriction_Generator_Event_Related_Protected(
-            $path_to_event_model,
-            EEM_Base::caps_edit
-        );
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * create new blank datetime
-     *
-     * @access public
-     * @return EE_Datetime[] array on success, FALSE on fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     * @throws InvalidInterfaceException
-     */
-    public function create_new_blank_datetime()
-    {
-        // makes sure timezone is always set.
-        $timezone_string = $this->get_timezone();
-        /**
-         * Filters the initial start date for the new datetime.
-         * Any time included in this value will be overridden later so use additional filters to modify the time.
-         *
-         * @param int $start_date Unixtimestamp representing now + 30 days in seconds.
-         * @return int unixtimestamp
-         */
-        $start_date = apply_filters(
-            'FHEE__EEM_Datetime__create_new_blank_datetime__start_date',
-            $this->current_time_for_query('DTT_EVT_start', true) + MONTH_IN_SECONDS
-        );
-        /**
-         * Filters the initial end date for the new datetime.
-         * Any time included in this value will be overridden later so use additional filters to modify the time.
-         *
-         * @param int $end_data Unixtimestamp representing now + 30 days in seconds.
-         * @return int unixtimestamp
-         */
-        $end_date = apply_filters(
-            'FHEE__EEM_Datetime__create_new_blank_datetime__end_date',
-            $this->current_time_for_query('DTT_EVT_end', true) + MONTH_IN_SECONDS
-        );
-        $blank_datetime = EE_Datetime::new_instance(
-            array(
-                'DTT_EVT_start' => $start_date,
-                'DTT_EVT_end'   => $end_date,
-                'DTT_order'     => 1,
-                'DTT_reg_limit' => EE_INF,
-            ),
-            $timezone_string
-        );
-        /**
-         * Filters the initial start time and format for the new EE_Datetime instance.
-         *
-         * @param array $start_time An array having size 2.  First element is the time, second element is the time
-         *                          format.
-         * @return array
-         */
-        $start_time = apply_filters(
-            'FHEE__EEM_Datetime__create_new_blank_datetime__start_time',
-            ['8am', 'ga']
-        );
-        /**
-         * Filters the initial end time and format for the new EE_Datetime instance.
-         *
-         * @param array $end_time An array having size 2.  First element is the time, second element is the time
-         *                        format
-         * @return array
-         */
-        $end_time = apply_filters(
-            'FHEE__EEM_Datetime__create_new_blank_datetime__end_time',
-            ['5pm', 'ga']
-        );
-        $this->validateStartAndEndTimeForBlankDate($start_time, $end_time);
-        $blank_datetime->set_start_time(
-            $this->convert_datetime_for_query(
-                'DTT_EVT_start',
-                $start_time[0],
-                $start_time[1],
-                $timezone_string
-            )
-        );
-        $blank_datetime->set_end_time(
-            $this->convert_datetime_for_query(
-                'DTT_EVT_end',
-                $end_time[0],
-                $end_time[1],
-                $timezone_string
-            )
-        );
-        return array($blank_datetime);
-    }
-
-
-    /**
-     * Validates whether the start_time and end_time are in the expected format.
-     * @param array $start_time
-     * @param array $end_time
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     */
-    private function validateStartAndEndTimeForBlankDate($start_time, $end_time)
-    {
-        if (! is_array($start_time)) {
-            throw new InvalidDataTypeException('start_time', $start_time, 'array');
-        }
-        if (! is_array($end_time)) {
-            throw new InvalidDataTypeException('end_time', $end_time, 'array');
-        }
-        if (count($start_time) !== 2) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    'The variable %1$s is expected to be an array with two elements.  The first item in the '
-                    . 'array should be a valid time string, the second item in the array should be a valid time format',
-                    '$start_time'
-                )
-            );
-        }
-        if (count($end_time) !== 2) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    'The variable %1$s is expected to be an array with two elements.  The first item in the '
-                    . 'array should be a valid time string, the second item in the array should be a valid time format',
-                    '$end_time'
-                )
-            );
-        }
-    }
-
-
-    /**
-     * get event start date from db
-     *
-     * @access public
-     * @param  int $EVT_ID
-     * @return EE_Datetime[] array on success, FALSE on fail
-     * @throws EE_Error
-     */
-    public function get_all_event_dates($EVT_ID = 0)
-    {
-        if (! $EVT_ID) { // on add_new_event event_id gets set to 0
-            return $this->create_new_blank_datetime();
-        }
-        $results = $this->get_datetimes_for_event_ordered_by_DTT_order($EVT_ID);
-        if (empty($results)) {
-            return $this->create_new_blank_datetime();
-        }
-        return $results;
-    }
-
-
-    /**
-     * get all datetimes attached to an event ordered by the DTT_order field
-     *
-     * @public
-     * @param  int    $EVT_ID     event id
-     * @param boolean $include_expired
-     * @param boolean $include_deleted
-     * @param  int    $limit      If included then limit the count of results by
-     *                            the given number
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function get_datetimes_for_event_ordered_by_DTT_order(
-        $EVT_ID,
-        $include_expired = true,
-        $include_deleted = true,
-        $limit = null
-    ) {
-        // sanitize EVT_ID
-        $EVT_ID         = absint($EVT_ID);
-        $old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
-        $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
-        $where_params = array('Event.EVT_ID' => $EVT_ID);
-        $query_params = ! empty($limit)
-            ? array(
-                $where_params,
-                'limit'                    => $limit,
-                'order_by'                 => array('DTT_order' => 'ASC'),
-                'default_where_conditions' => 'none',
-            )
-            : array(
-                $where_params,
-                'order_by'                 => array('DTT_order' => 'ASC'),
-                'default_where_conditions' => 'none',
-            );
-        if (! $include_expired) {
-            $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
-        }
-        if ($include_deleted) {
-            $query_params[0]['DTT_deleted'] = array('IN', array(true, false));
-        }
-        /** @var EE_Datetime[] $result */
-        $result = $this->get_all($query_params);
-        $this->assume_values_already_prepared_by_model_object($old_assumption);
-        return $result;
-    }
-
-
-    /**
-     * Gets the datetimes for the event (with the given limit), and orders them by "importance".
-     * By importance, we mean that the primary datetimes are most important (DEPRECATED FOR NOW),
-     * and then the earlier datetimes are the most important.
-     * Maybe we'll want this to take into account datetimes that haven't already passed, but we don't yet.
-     *
-     * @param int $EVT_ID
-     * @param int $limit
-     * @return EE_Datetime[]|EE_Base_Class[]
-     * @throws EE_Error
-     */
-    public function get_datetimes_for_event_ordered_by_importance($EVT_ID = 0, $limit = null)
-    {
-        return $this->get_all(
-            array(
-                array('Event.EVT_ID' => $EVT_ID),
-                'limit'                    => $limit,
-                'order_by'                 => array('DTT_EVT_start' => 'ASC'),
-                'default_where_conditions' => 'none',
-            )
-        );
-    }
-
-
-    /**
-     * @param int     $EVT_ID
-     * @param boolean $include_expired
-     * @param boolean $include_deleted
-     * @return EE_Datetime
-     * @throws EE_Error
-     */
-    public function get_oldest_datetime_for_event($EVT_ID, $include_expired = false, $include_deleted = false)
-    {
-        $results = $this->get_datetimes_for_event_ordered_by_start_time(
-            $EVT_ID,
-            $include_expired,
-            $include_deleted,
-            1
-        );
-        if ($results) {
-            return array_shift($results);
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the 'primary' datetime for an event.
-     *
-     * @param int  $EVT_ID
-     * @param bool $try_to_exclude_expired
-     * @param bool $try_to_exclude_deleted
-     * @return \EE_Datetime
-     * @throws EE_Error
-     */
-    public function get_primary_datetime_for_event(
-        $EVT_ID,
-        $try_to_exclude_expired = true,
-        $try_to_exclude_deleted = true
-    ) {
-        if ($try_to_exclude_expired) {
-            $non_expired = $this->get_oldest_datetime_for_event($EVT_ID, false, false);
-            if ($non_expired) {
-                return $non_expired;
-            }
-        }
-        if ($try_to_exclude_deleted) {
-            $expired_even = $this->get_oldest_datetime_for_event($EVT_ID, true);
-            if ($expired_even) {
-                return $expired_even;
-            }
-        }
-        return $this->get_oldest_datetime_for_event($EVT_ID, true, true);
-    }
-
-
-    /**
-     * Gets ALL the datetimes for an event (including trashed ones, for now), ordered
-     * only by start date
-     *
-     * @param int     $EVT_ID
-     * @param boolean $include_expired
-     * @param boolean $include_deleted
-     * @param int     $limit
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function get_datetimes_for_event_ordered_by_start_time(
-        $EVT_ID,
-        $include_expired = true,
-        $include_deleted = true,
-        $limit = null
-    ) {
-        // sanitize EVT_ID
-        $EVT_ID         = absint($EVT_ID);
-        $old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
-        $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
-        $query_params = array(array('Event.EVT_ID' => $EVT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
-        if (! $include_expired) {
-            $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
-        }
-        if ($include_deleted) {
-            $query_params[0]['DTT_deleted'] = array('IN', array(true, false));
-        }
-        if ($limit) {
-            $query_params['limit'] = $limit;
-        }
-        /** @var EE_Datetime[] $result */
-        $result = $this->get_all($query_params);
-        $this->assume_values_already_prepared_by_model_object($old_assumption);
-        return $result;
-    }
-
-
-    /**
-     * Gets ALL the datetimes for an ticket (including trashed ones, for now), ordered
-     * only by start date
-     *
-     * @param int     $TKT_ID
-     * @param boolean $include_expired
-     * @param boolean $include_deleted
-     * @param int     $limit
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function get_datetimes_for_ticket_ordered_by_start_time(
-        $TKT_ID,
-        $include_expired = true,
-        $include_deleted = true,
-        $limit = null
-    ) {
-        // sanitize TKT_ID
-        $TKT_ID         = absint($TKT_ID);
-        $old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
-        $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
-        $query_params = array(array('Ticket.TKT_ID' => $TKT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
-        if (! $include_expired) {
-            $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
-        }
-        if ($include_deleted) {
-            $query_params[0]['DTT_deleted'] = array('IN', array(true, false));
-        }
-        if ($limit) {
-            $query_params['limit'] = $limit;
-        }
-        /** @var EE_Datetime[] $result */
-        $result = $this->get_all($query_params);
-        $this->assume_values_already_prepared_by_model_object($old_assumption);
-        return $result;
-    }
-
-
-    /**
-     * Gets all the datetimes for a ticket (including trashed ones, for now), ordered by the DTT_order for the
-     * datetimes.
-     *
-     * @param  int      $TKT_ID          ID of ticket to retrieve the datetimes for
-     * @param  boolean  $include_expired whether to include expired datetimes or not
-     * @param  boolean  $include_deleted whether to include trashed datetimes or not.
-     * @param  int|null $limit           if null, no limit, if int then limit results by
-     *                                   that number
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function get_datetimes_for_ticket_ordered_by_DTT_order(
-        $TKT_ID,
-        $include_expired = true,
-        $include_deleted = true,
-        $limit = null
-    ) {
-        // sanitize id.
-        $TKT_ID         = absint($TKT_ID);
-        $old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
-        $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
-        $where_params = array('Ticket.TKT_ID' => $TKT_ID);
-        $query_params = array($where_params, 'order_by' => array('DTT_order' => 'ASC'));
-        if (! $include_expired) {
-            $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
-        }
-        if ($include_deleted) {
-            $query_params[0]['DTT_deleted'] = array('IN', array(true, false));
-        }
-        if ($limit) {
-            $query_params['limit'] = $limit;
-        }
-        /** @var EE_Datetime[] $result */
-        $result = $this->get_all($query_params);
-        $this->assume_values_already_prepared_by_model_object($old_assumption);
-        return $result;
-    }
-
-
-    /**
-     * Gets the most important datetime for a particular event (ie, the primary event usually. But if for some WACK
-     * reason it doesn't exist, we consider the earliest event the most important)
-     *
-     * @param int $EVT_ID
-     * @return EE_Datetime
-     * @throws EE_Error
-     */
-    public function get_most_important_datetime_for_event($EVT_ID)
-    {
-        $results = $this->get_datetimes_for_event_ordered_by_importance($EVT_ID, 1);
-        if ($results) {
-            return array_shift($results);
-        }
-        return null;
-    }
-
-
-    /**
-     * This returns a wpdb->results        Array of all DTT month and years matching the incoming query params and
-     * grouped by month and year.
-     *
-     * @param  array  $where_params      @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     * @param  string $evt_active_status A string representing the evt active status to filter the months by.
-     *                                   Can be:
-     *                                   - '' = no filter
-     *                                   - upcoming = Published events with at least one upcoming datetime.
-     *                                   - expired = Events with all datetimes expired.
-     *                                   - active = Events that are published and have at least one datetime that
-     *                                   starts before now and ends after now.
-     *                                   - inactive = Events that are either not published.
-     * @return EE_Base_Class[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     */
-    public function get_dtt_months_and_years($where_params, $evt_active_status = '')
-    {
-        $current_time_for_DTT_EVT_start = $this->current_time_for_query('DTT_EVT_start');
-        $current_time_for_DTT_EVT_end   = $this->current_time_for_query('DTT_EVT_end');
-        switch ($evt_active_status) {
-            case 'upcoming':
-                $where_params['Event.status'] = 'publish';
-                // if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
-                if (isset($where_params['DTT_EVT_start'])) {
-                    $where_params['DTT_EVT_start*****'] = $where_params['DTT_EVT_start'];
-                }
-                $where_params['DTT_EVT_start'] = array('>', $current_time_for_DTT_EVT_start);
-                break;
-            case 'expired':
-                if (isset($where_params['Event.status'])) {
-                    unset($where_params['Event.status']);
-                }
-                // get events to exclude
-                $exclude_query[0] = array_merge(
-                    $where_params,
-                    array('DTT_EVT_end' => array('>', $current_time_for_DTT_EVT_end))
-                );
-                // first get all events that have datetimes where its not expired.
-                $event_ids = $this->_get_all_wpdb_results(
-                    $exclude_query,
-                    OBJECT_K,
-                    'Datetime.EVT_ID'
-                );
-                $event_ids = array_keys($event_ids);
-                if (isset($where_params['DTT_EVT_end'])) {
-                    $where_params['DTT_EVT_end****'] = $where_params['DTT_EVT_end'];
-                }
-                $where_params['DTT_EVT_end']  = array('<', $current_time_for_DTT_EVT_end);
-                $where_params['Event.EVT_ID'] = array('NOT IN', $event_ids);
-                break;
-            case 'active':
-                $where_params['Event.status'] = 'publish';
-                if (isset($where_params['DTT_EVT_start'])) {
-                    $where_params['Datetime.DTT_EVT_start******'] = $where_params['DTT_EVT_start'];
-                }
-                if (isset($where_params['Datetime.DTT_EVT_end'])) {
-                    $where_params['Datetime.DTT_EVT_end*****'] = $where_params['DTT_EVT_end'];
-                }
-                $where_params['DTT_EVT_start'] = array('<', $current_time_for_DTT_EVT_start);
-                $where_params['DTT_EVT_end']   = array('>', $current_time_for_DTT_EVT_end);
-                break;
-            case 'inactive':
-                if (isset($where_params['Event.status'])) {
-                    unset($where_params['Event.status']);
-                }
-                if (isset($where_params['OR'])) {
-                    $where_params['AND']['OR'] = $where_params['OR'];
-                }
-                if (isset($where_params['DTT_EVT_end'])) {
-                    $where_params['AND']['DTT_EVT_end****'] = $where_params['DTT_EVT_end'];
-                    unset($where_params['DTT_EVT_end']);
-                }
-                if (isset($where_params['DTT_EVT_start'])) {
-                    $where_params['AND']['DTT_EVT_start'] = $where_params['DTT_EVT_start'];
-                    unset($where_params['DTT_EVT_start']);
-                }
-                $where_params['AND']['Event.status'] = array('!=', 'publish');
-                break;
-        }
-        $query_params[0]          = $where_params;
-        $query_params['group_by'] = array('dtt_year', 'dtt_month');
-        $query_params['order_by'] = array('DTT_EVT_start' => 'DESC');
-        $query_interval           = EEH_DTT_Helper::get_sql_query_interval_for_offset(
-            $this->get_timezone(),
-            'DTT_EVT_start'
-        );
-        $columns_to_select        = array(
-            'dtt_year'      => array('YEAR(' . $query_interval . ')', '%s'),
-            'dtt_month'     => array('MONTHNAME(' . $query_interval . ')', '%s'),
-            'dtt_month_num' => array('MONTH(' . $query_interval . ')', '%s'),
-        );
-        return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
-    }
-
-
-    /**
-     * Updates the DTT_sold attribute on each datetime (based on the registrations
-     * for the tickets for each datetime)
-     *
-     * @param EE_Base_Class[]|EE_Datetime[] $datetimes
-     * @throws EE_Error
-     */
-    public function update_sold($datetimes)
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__(
-                'Please use \EEM_Ticket::update_tickets_sold() instead which will in turn correctly update both the Ticket AND Datetime counts.',
-                'event_espresso'
-            ),
-            '4.9.32.rc.005'
-        );
-        foreach ($datetimes as $datetime) {
-            $datetime->update_sold();
-        }
-    }
-
-
-    /**
-     *    Gets the total number of tickets available at a particular datetime
-     *    (does NOT take into account the datetime's spaces available)
-     *
-     * @param int   $DTT_ID
-     * @param array $query_params
-     * @return int of tickets available. If sold out, return less than 1. If infinite, returns EE_INF,  IF there are NO
-     *             tickets attached to datetime then FALSE is returned.
-     */
-    public function sum_tickets_currently_available_at_datetime($DTT_ID, array $query_params = array())
-    {
-        $datetime = $this->get_one_by_ID($DTT_ID);
-        if ($datetime instanceof EE_Datetime) {
-            return $datetime->tickets_remaining($query_params);
-        }
-        return 0;
-    }
-
-
-    /**
-     * This returns an array of counts of datetimes in the database for each Datetime status that can be queried.
-     *
-     * @param  array $stati_to_include If included you can restrict the statuses we return counts for by including the
-     *                                 stati you want counts for as values in the array.  An empty array returns counts
-     *                                 for all valid stati.
-     * @param  array $query_params     If included can be used to refine the conditions for returning the count (i.e.
-     *                                 only for Datetimes connected to a specific event, or specific ticket.
-     * @return array  The value returned is an array indexed by Datetime Status and the values are the counts.  The
-     * @throws EE_Error
-     *                                 stati used as index keys are: EE_Datetime::active EE_Datetime::upcoming
-     *                                 EE_Datetime::expired
-     */
-    public function get_datetime_counts_by_status(array $stati_to_include = array(), array $query_params = array())
-    {
-        // only accept where conditions for this query.
-        $_where            = isset($query_params[0]) ? $query_params[0] : array();
-        $status_query_args = array(
-            EE_Datetime::active   => array_merge(
-                $_where,
-                array('DTT_EVT_start' => array('<', time()), 'DTT_EVT_end' => array('>', time()))
-            ),
-            EE_Datetime::upcoming => array_merge(
-                $_where,
-                array('DTT_EVT_start' => array('>', time()))
-            ),
-            EE_Datetime::expired  => array_merge(
-                $_where,
-                array('DTT_EVT_end' => array('<', time()))
-            ),
-        );
-        if (! empty($stati_to_include)) {
-            foreach (array_keys($status_query_args) as $status) {
-                if (! in_array($status, $stati_to_include, true)) {
-                    unset($status_query_args[ $status ]);
-                }
-            }
-        }
-        // loop through and query counts for each stati.
-        $status_query_results = array();
-        foreach ($status_query_args as $status => $status_where_conditions) {
-            $status_query_results[ $status ] = EEM_Datetime::count(
-                array($status_where_conditions),
-                'DTT_ID',
-                true
-            );
-        }
-        return $status_query_results;
-    }
-
-
-    /**
-     * Returns the specific count for a given Datetime status matching any given query_params.
-     *
-     * @param string $status Valid string representation for Datetime status requested. (Defaults to Active).
-     * @param array  $query_params
-     * @return int
-     * @throws EE_Error
-     */
-    public function get_datetime_count_for_status($status = EE_Datetime::active, array $query_params = array())
-    {
-        $count = $this->get_datetime_counts_by_status(array($status), $query_params);
-        return ! empty($count[ $status ]) ? $count[ $status ] : 0;
-    }
+	/**
+	 * @var EEM_Datetime $_instance
+	 */
+	protected static $_instance;
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param string $timezone A string representing the timezone we want to set for returned Date Time Strings
+	 *                         (and any incoming timezone data that gets saved).
+	 *                         Note this just sends the timezone info to the date time model field objects.
+	 *                         Default is NULL
+	 *                         (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct($timezone)
+	{
+		$this->singular_item           = esc_html__('Datetime', 'event_espresso');
+		$this->plural_item             = esc_html__('Datetimes', 'event_espresso');
+		$this->_tables                 = array(
+			'Datetime' => new EE_Primary_Table('esp_datetime', 'DTT_ID'),
+		);
+		$this->_fields                 = array(
+			'Datetime' => array(
+				'DTT_ID'          => new EE_Primary_Key_Int_Field(
+					'DTT_ID',
+					esc_html__('Datetime ID', 'event_espresso')
+				),
+				'EVT_ID'          => new EE_Foreign_Key_Int_Field(
+					'EVT_ID',
+					esc_html__('Event ID', 'event_espresso'),
+					false,
+					0,
+					'Event'
+				),
+				'DTT_name'        => new EE_Plain_Text_Field(
+					'DTT_name',
+					esc_html__('Datetime Name', 'event_espresso'),
+					false,
+					''
+				),
+				'DTT_description' => new EE_Post_Content_Field(
+					'DTT_description',
+					esc_html__('Description for Datetime', 'event_espresso'),
+					false,
+					''
+				),
+				'DTT_EVT_start'   => new EE_Datetime_Field(
+					'DTT_EVT_start',
+					esc_html__('Start time/date of Event', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'DTT_EVT_end'     => new EE_Datetime_Field(
+					'DTT_EVT_end',
+					esc_html__('End time/date of Event', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'DTT_reg_limit'   => new EE_Infinite_Integer_Field(
+					'DTT_reg_limit',
+					esc_html__('Registration Limit for this time', 'event_espresso'),
+					true,
+					EE_INF
+				),
+				'DTT_sold'        => new EE_Integer_Field(
+					'DTT_sold',
+					esc_html__('How many sales for this Datetime that have occurred', 'event_espresso'),
+					true,
+					0
+				),
+				'DTT_reserved'    => new EE_Integer_Field(
+					'DTT_reserved',
+					esc_html__('Quantity of tickets reserved, but not yet fully purchased', 'event_espresso'),
+					false,
+					0
+				),
+				'DTT_is_primary'  => new EE_Boolean_Field(
+					'DTT_is_primary',
+					esc_html__('Flag indicating datetime is primary one for event', 'event_espresso'),
+					false,
+					false
+				),
+				'DTT_order'       => new EE_Integer_Field(
+					'DTT_order',
+					esc_html__('The order in which the Datetime is displayed', 'event_espresso'),
+					false,
+					0
+				),
+				'DTT_parent'      => new EE_Integer_Field(
+					'DTT_parent',
+					esc_html__('Indicates what DTT_ID is the parent of this DTT_ID', 'event_espresso'),
+					true,
+					0
+				),
+				'DTT_deleted'     => new EE_Trashed_Flag_Field(
+					'DTT_deleted',
+					esc_html__('Flag indicating datetime is archived', 'event_espresso'),
+					false,
+					false
+				),
+			),
+		);
+		$this->_model_relations        = array(
+			'Ticket'  => new EE_HABTM_Relation('Datetime_Ticket'),
+			'Event'   => new EE_Belongs_To_Relation(),
+			'Checkin' => new EE_Has_Many_Relation(),
+			'Datetime_Ticket' => new EE_Has_Many_Relation(),
+		);
+		$path_to_event_model = 'Event';
+		$this->model_chain_to_password = $path_to_event_model;
+		$this->_model_chain_to_wp_user = $path_to_event_model;
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ]       = new EE_Restriction_Generator_Event_Related_Public(
+			$path_to_event_model
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected(
+			$path_to_event_model
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       = new EE_Restriction_Generator_Event_Related_Protected(
+			$path_to_event_model
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     = new EE_Restriction_Generator_Event_Related_Protected(
+			$path_to_event_model,
+			EEM_Base::caps_edit
+		);
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * create new blank datetime
+	 *
+	 * @access public
+	 * @return EE_Datetime[] array on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 * @throws InvalidInterfaceException
+	 */
+	public function create_new_blank_datetime()
+	{
+		// makes sure timezone is always set.
+		$timezone_string = $this->get_timezone();
+		/**
+		 * Filters the initial start date for the new datetime.
+		 * Any time included in this value will be overridden later so use additional filters to modify the time.
+		 *
+		 * @param int $start_date Unixtimestamp representing now + 30 days in seconds.
+		 * @return int unixtimestamp
+		 */
+		$start_date = apply_filters(
+			'FHEE__EEM_Datetime__create_new_blank_datetime__start_date',
+			$this->current_time_for_query('DTT_EVT_start', true) + MONTH_IN_SECONDS
+		);
+		/**
+		 * Filters the initial end date for the new datetime.
+		 * Any time included in this value will be overridden later so use additional filters to modify the time.
+		 *
+		 * @param int $end_data Unixtimestamp representing now + 30 days in seconds.
+		 * @return int unixtimestamp
+		 */
+		$end_date = apply_filters(
+			'FHEE__EEM_Datetime__create_new_blank_datetime__end_date',
+			$this->current_time_for_query('DTT_EVT_end', true) + MONTH_IN_SECONDS
+		);
+		$blank_datetime = EE_Datetime::new_instance(
+			array(
+				'DTT_EVT_start' => $start_date,
+				'DTT_EVT_end'   => $end_date,
+				'DTT_order'     => 1,
+				'DTT_reg_limit' => EE_INF,
+			),
+			$timezone_string
+		);
+		/**
+		 * Filters the initial start time and format for the new EE_Datetime instance.
+		 *
+		 * @param array $start_time An array having size 2.  First element is the time, second element is the time
+		 *                          format.
+		 * @return array
+		 */
+		$start_time = apply_filters(
+			'FHEE__EEM_Datetime__create_new_blank_datetime__start_time',
+			['8am', 'ga']
+		);
+		/**
+		 * Filters the initial end time and format for the new EE_Datetime instance.
+		 *
+		 * @param array $end_time An array having size 2.  First element is the time, second element is the time
+		 *                        format
+		 * @return array
+		 */
+		$end_time = apply_filters(
+			'FHEE__EEM_Datetime__create_new_blank_datetime__end_time',
+			['5pm', 'ga']
+		);
+		$this->validateStartAndEndTimeForBlankDate($start_time, $end_time);
+		$blank_datetime->set_start_time(
+			$this->convert_datetime_for_query(
+				'DTT_EVT_start',
+				$start_time[0],
+				$start_time[1],
+				$timezone_string
+			)
+		);
+		$blank_datetime->set_end_time(
+			$this->convert_datetime_for_query(
+				'DTT_EVT_end',
+				$end_time[0],
+				$end_time[1],
+				$timezone_string
+			)
+		);
+		return array($blank_datetime);
+	}
+
+
+	/**
+	 * Validates whether the start_time and end_time are in the expected format.
+	 * @param array $start_time
+	 * @param array $end_time
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 */
+	private function validateStartAndEndTimeForBlankDate($start_time, $end_time)
+	{
+		if (! is_array($start_time)) {
+			throw new InvalidDataTypeException('start_time', $start_time, 'array');
+		}
+		if (! is_array($end_time)) {
+			throw new InvalidDataTypeException('end_time', $end_time, 'array');
+		}
+		if (count($start_time) !== 2) {
+			throw new InvalidArgumentException(
+				sprintf(
+					'The variable %1$s is expected to be an array with two elements.  The first item in the '
+					. 'array should be a valid time string, the second item in the array should be a valid time format',
+					'$start_time'
+				)
+			);
+		}
+		if (count($end_time) !== 2) {
+			throw new InvalidArgumentException(
+				sprintf(
+					'The variable %1$s is expected to be an array with two elements.  The first item in the '
+					. 'array should be a valid time string, the second item in the array should be a valid time format',
+					'$end_time'
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * get event start date from db
+	 *
+	 * @access public
+	 * @param  int $EVT_ID
+	 * @return EE_Datetime[] array on success, FALSE on fail
+	 * @throws EE_Error
+	 */
+	public function get_all_event_dates($EVT_ID = 0)
+	{
+		if (! $EVT_ID) { // on add_new_event event_id gets set to 0
+			return $this->create_new_blank_datetime();
+		}
+		$results = $this->get_datetimes_for_event_ordered_by_DTT_order($EVT_ID);
+		if (empty($results)) {
+			return $this->create_new_blank_datetime();
+		}
+		return $results;
+	}
+
+
+	/**
+	 * get all datetimes attached to an event ordered by the DTT_order field
+	 *
+	 * @public
+	 * @param  int    $EVT_ID     event id
+	 * @param boolean $include_expired
+	 * @param boolean $include_deleted
+	 * @param  int    $limit      If included then limit the count of results by
+	 *                            the given number
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function get_datetimes_for_event_ordered_by_DTT_order(
+		$EVT_ID,
+		$include_expired = true,
+		$include_deleted = true,
+		$limit = null
+	) {
+		// sanitize EVT_ID
+		$EVT_ID         = absint($EVT_ID);
+		$old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
+		$this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
+		$where_params = array('Event.EVT_ID' => $EVT_ID);
+		$query_params = ! empty($limit)
+			? array(
+				$where_params,
+				'limit'                    => $limit,
+				'order_by'                 => array('DTT_order' => 'ASC'),
+				'default_where_conditions' => 'none',
+			)
+			: array(
+				$where_params,
+				'order_by'                 => array('DTT_order' => 'ASC'),
+				'default_where_conditions' => 'none',
+			);
+		if (! $include_expired) {
+			$query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
+		}
+		if ($include_deleted) {
+			$query_params[0]['DTT_deleted'] = array('IN', array(true, false));
+		}
+		/** @var EE_Datetime[] $result */
+		$result = $this->get_all($query_params);
+		$this->assume_values_already_prepared_by_model_object($old_assumption);
+		return $result;
+	}
+
+
+	/**
+	 * Gets the datetimes for the event (with the given limit), and orders them by "importance".
+	 * By importance, we mean that the primary datetimes are most important (DEPRECATED FOR NOW),
+	 * and then the earlier datetimes are the most important.
+	 * Maybe we'll want this to take into account datetimes that haven't already passed, but we don't yet.
+	 *
+	 * @param int $EVT_ID
+	 * @param int $limit
+	 * @return EE_Datetime[]|EE_Base_Class[]
+	 * @throws EE_Error
+	 */
+	public function get_datetimes_for_event_ordered_by_importance($EVT_ID = 0, $limit = null)
+	{
+		return $this->get_all(
+			array(
+				array('Event.EVT_ID' => $EVT_ID),
+				'limit'                    => $limit,
+				'order_by'                 => array('DTT_EVT_start' => 'ASC'),
+				'default_where_conditions' => 'none',
+			)
+		);
+	}
+
+
+	/**
+	 * @param int     $EVT_ID
+	 * @param boolean $include_expired
+	 * @param boolean $include_deleted
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function get_oldest_datetime_for_event($EVT_ID, $include_expired = false, $include_deleted = false)
+	{
+		$results = $this->get_datetimes_for_event_ordered_by_start_time(
+			$EVT_ID,
+			$include_expired,
+			$include_deleted,
+			1
+		);
+		if ($results) {
+			return array_shift($results);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the 'primary' datetime for an event.
+	 *
+	 * @param int  $EVT_ID
+	 * @param bool $try_to_exclude_expired
+	 * @param bool $try_to_exclude_deleted
+	 * @return \EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function get_primary_datetime_for_event(
+		$EVT_ID,
+		$try_to_exclude_expired = true,
+		$try_to_exclude_deleted = true
+	) {
+		if ($try_to_exclude_expired) {
+			$non_expired = $this->get_oldest_datetime_for_event($EVT_ID, false, false);
+			if ($non_expired) {
+				return $non_expired;
+			}
+		}
+		if ($try_to_exclude_deleted) {
+			$expired_even = $this->get_oldest_datetime_for_event($EVT_ID, true);
+			if ($expired_even) {
+				return $expired_even;
+			}
+		}
+		return $this->get_oldest_datetime_for_event($EVT_ID, true, true);
+	}
+
+
+	/**
+	 * Gets ALL the datetimes for an event (including trashed ones, for now), ordered
+	 * only by start date
+	 *
+	 * @param int     $EVT_ID
+	 * @param boolean $include_expired
+	 * @param boolean $include_deleted
+	 * @param int     $limit
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function get_datetimes_for_event_ordered_by_start_time(
+		$EVT_ID,
+		$include_expired = true,
+		$include_deleted = true,
+		$limit = null
+	) {
+		// sanitize EVT_ID
+		$EVT_ID         = absint($EVT_ID);
+		$old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
+		$this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
+		$query_params = array(array('Event.EVT_ID' => $EVT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
+		if (! $include_expired) {
+			$query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
+		}
+		if ($include_deleted) {
+			$query_params[0]['DTT_deleted'] = array('IN', array(true, false));
+		}
+		if ($limit) {
+			$query_params['limit'] = $limit;
+		}
+		/** @var EE_Datetime[] $result */
+		$result = $this->get_all($query_params);
+		$this->assume_values_already_prepared_by_model_object($old_assumption);
+		return $result;
+	}
+
+
+	/**
+	 * Gets ALL the datetimes for an ticket (including trashed ones, for now), ordered
+	 * only by start date
+	 *
+	 * @param int     $TKT_ID
+	 * @param boolean $include_expired
+	 * @param boolean $include_deleted
+	 * @param int     $limit
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function get_datetimes_for_ticket_ordered_by_start_time(
+		$TKT_ID,
+		$include_expired = true,
+		$include_deleted = true,
+		$limit = null
+	) {
+		// sanitize TKT_ID
+		$TKT_ID         = absint($TKT_ID);
+		$old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
+		$this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
+		$query_params = array(array('Ticket.TKT_ID' => $TKT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
+		if (! $include_expired) {
+			$query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
+		}
+		if ($include_deleted) {
+			$query_params[0]['DTT_deleted'] = array('IN', array(true, false));
+		}
+		if ($limit) {
+			$query_params['limit'] = $limit;
+		}
+		/** @var EE_Datetime[] $result */
+		$result = $this->get_all($query_params);
+		$this->assume_values_already_prepared_by_model_object($old_assumption);
+		return $result;
+	}
+
+
+	/**
+	 * Gets all the datetimes for a ticket (including trashed ones, for now), ordered by the DTT_order for the
+	 * datetimes.
+	 *
+	 * @param  int      $TKT_ID          ID of ticket to retrieve the datetimes for
+	 * @param  boolean  $include_expired whether to include expired datetimes or not
+	 * @param  boolean  $include_deleted whether to include trashed datetimes or not.
+	 * @param  int|null $limit           if null, no limit, if int then limit results by
+	 *                                   that number
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function get_datetimes_for_ticket_ordered_by_DTT_order(
+		$TKT_ID,
+		$include_expired = true,
+		$include_deleted = true,
+		$limit = null
+	) {
+		// sanitize id.
+		$TKT_ID         = absint($TKT_ID);
+		$old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
+		$this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
+		$where_params = array('Ticket.TKT_ID' => $TKT_ID);
+		$query_params = array($where_params, 'order_by' => array('DTT_order' => 'ASC'));
+		if (! $include_expired) {
+			$query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
+		}
+		if ($include_deleted) {
+			$query_params[0]['DTT_deleted'] = array('IN', array(true, false));
+		}
+		if ($limit) {
+			$query_params['limit'] = $limit;
+		}
+		/** @var EE_Datetime[] $result */
+		$result = $this->get_all($query_params);
+		$this->assume_values_already_prepared_by_model_object($old_assumption);
+		return $result;
+	}
+
+
+	/**
+	 * Gets the most important datetime for a particular event (ie, the primary event usually. But if for some WACK
+	 * reason it doesn't exist, we consider the earliest event the most important)
+	 *
+	 * @param int $EVT_ID
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function get_most_important_datetime_for_event($EVT_ID)
+	{
+		$results = $this->get_datetimes_for_event_ordered_by_importance($EVT_ID, 1);
+		if ($results) {
+			return array_shift($results);
+		}
+		return null;
+	}
+
+
+	/**
+	 * This returns a wpdb->results        Array of all DTT month and years matching the incoming query params and
+	 * grouped by month and year.
+	 *
+	 * @param  array  $where_params      @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 * @param  string $evt_active_status A string representing the evt active status to filter the months by.
+	 *                                   Can be:
+	 *                                   - '' = no filter
+	 *                                   - upcoming = Published events with at least one upcoming datetime.
+	 *                                   - expired = Events with all datetimes expired.
+	 *                                   - active = Events that are published and have at least one datetime that
+	 *                                   starts before now and ends after now.
+	 *                                   - inactive = Events that are either not published.
+	 * @return EE_Base_Class[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 */
+	public function get_dtt_months_and_years($where_params, $evt_active_status = '')
+	{
+		$current_time_for_DTT_EVT_start = $this->current_time_for_query('DTT_EVT_start');
+		$current_time_for_DTT_EVT_end   = $this->current_time_for_query('DTT_EVT_end');
+		switch ($evt_active_status) {
+			case 'upcoming':
+				$where_params['Event.status'] = 'publish';
+				// if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
+				if (isset($where_params['DTT_EVT_start'])) {
+					$where_params['DTT_EVT_start*****'] = $where_params['DTT_EVT_start'];
+				}
+				$where_params['DTT_EVT_start'] = array('>', $current_time_for_DTT_EVT_start);
+				break;
+			case 'expired':
+				if (isset($where_params['Event.status'])) {
+					unset($where_params['Event.status']);
+				}
+				// get events to exclude
+				$exclude_query[0] = array_merge(
+					$where_params,
+					array('DTT_EVT_end' => array('>', $current_time_for_DTT_EVT_end))
+				);
+				// first get all events that have datetimes where its not expired.
+				$event_ids = $this->_get_all_wpdb_results(
+					$exclude_query,
+					OBJECT_K,
+					'Datetime.EVT_ID'
+				);
+				$event_ids = array_keys($event_ids);
+				if (isset($where_params['DTT_EVT_end'])) {
+					$where_params['DTT_EVT_end****'] = $where_params['DTT_EVT_end'];
+				}
+				$where_params['DTT_EVT_end']  = array('<', $current_time_for_DTT_EVT_end);
+				$where_params['Event.EVT_ID'] = array('NOT IN', $event_ids);
+				break;
+			case 'active':
+				$where_params['Event.status'] = 'publish';
+				if (isset($where_params['DTT_EVT_start'])) {
+					$where_params['Datetime.DTT_EVT_start******'] = $where_params['DTT_EVT_start'];
+				}
+				if (isset($where_params['Datetime.DTT_EVT_end'])) {
+					$where_params['Datetime.DTT_EVT_end*****'] = $where_params['DTT_EVT_end'];
+				}
+				$where_params['DTT_EVT_start'] = array('<', $current_time_for_DTT_EVT_start);
+				$where_params['DTT_EVT_end']   = array('>', $current_time_for_DTT_EVT_end);
+				break;
+			case 'inactive':
+				if (isset($where_params['Event.status'])) {
+					unset($where_params['Event.status']);
+				}
+				if (isset($where_params['OR'])) {
+					$where_params['AND']['OR'] = $where_params['OR'];
+				}
+				if (isset($where_params['DTT_EVT_end'])) {
+					$where_params['AND']['DTT_EVT_end****'] = $where_params['DTT_EVT_end'];
+					unset($where_params['DTT_EVT_end']);
+				}
+				if (isset($where_params['DTT_EVT_start'])) {
+					$where_params['AND']['DTT_EVT_start'] = $where_params['DTT_EVT_start'];
+					unset($where_params['DTT_EVT_start']);
+				}
+				$where_params['AND']['Event.status'] = array('!=', 'publish');
+				break;
+		}
+		$query_params[0]          = $where_params;
+		$query_params['group_by'] = array('dtt_year', 'dtt_month');
+		$query_params['order_by'] = array('DTT_EVT_start' => 'DESC');
+		$query_interval           = EEH_DTT_Helper::get_sql_query_interval_for_offset(
+			$this->get_timezone(),
+			'DTT_EVT_start'
+		);
+		$columns_to_select        = array(
+			'dtt_year'      => array('YEAR(' . $query_interval . ')', '%s'),
+			'dtt_month'     => array('MONTHNAME(' . $query_interval . ')', '%s'),
+			'dtt_month_num' => array('MONTH(' . $query_interval . ')', '%s'),
+		);
+		return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
+	}
+
+
+	/**
+	 * Updates the DTT_sold attribute on each datetime (based on the registrations
+	 * for the tickets for each datetime)
+	 *
+	 * @param EE_Base_Class[]|EE_Datetime[] $datetimes
+	 * @throws EE_Error
+	 */
+	public function update_sold($datetimes)
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__(
+				'Please use \EEM_Ticket::update_tickets_sold() instead which will in turn correctly update both the Ticket AND Datetime counts.',
+				'event_espresso'
+			),
+			'4.9.32.rc.005'
+		);
+		foreach ($datetimes as $datetime) {
+			$datetime->update_sold();
+		}
+	}
+
+
+	/**
+	 *    Gets the total number of tickets available at a particular datetime
+	 *    (does NOT take into account the datetime's spaces available)
+	 *
+	 * @param int   $DTT_ID
+	 * @param array $query_params
+	 * @return int of tickets available. If sold out, return less than 1. If infinite, returns EE_INF,  IF there are NO
+	 *             tickets attached to datetime then FALSE is returned.
+	 */
+	public function sum_tickets_currently_available_at_datetime($DTT_ID, array $query_params = array())
+	{
+		$datetime = $this->get_one_by_ID($DTT_ID);
+		if ($datetime instanceof EE_Datetime) {
+			return $datetime->tickets_remaining($query_params);
+		}
+		return 0;
+	}
+
+
+	/**
+	 * This returns an array of counts of datetimes in the database for each Datetime status that can be queried.
+	 *
+	 * @param  array $stati_to_include If included you can restrict the statuses we return counts for by including the
+	 *                                 stati you want counts for as values in the array.  An empty array returns counts
+	 *                                 for all valid stati.
+	 * @param  array $query_params     If included can be used to refine the conditions for returning the count (i.e.
+	 *                                 only for Datetimes connected to a specific event, or specific ticket.
+	 * @return array  The value returned is an array indexed by Datetime Status and the values are the counts.  The
+	 * @throws EE_Error
+	 *                                 stati used as index keys are: EE_Datetime::active EE_Datetime::upcoming
+	 *                                 EE_Datetime::expired
+	 */
+	public function get_datetime_counts_by_status(array $stati_to_include = array(), array $query_params = array())
+	{
+		// only accept where conditions for this query.
+		$_where            = isset($query_params[0]) ? $query_params[0] : array();
+		$status_query_args = array(
+			EE_Datetime::active   => array_merge(
+				$_where,
+				array('DTT_EVT_start' => array('<', time()), 'DTT_EVT_end' => array('>', time()))
+			),
+			EE_Datetime::upcoming => array_merge(
+				$_where,
+				array('DTT_EVT_start' => array('>', time()))
+			),
+			EE_Datetime::expired  => array_merge(
+				$_where,
+				array('DTT_EVT_end' => array('<', time()))
+			),
+		);
+		if (! empty($stati_to_include)) {
+			foreach (array_keys($status_query_args) as $status) {
+				if (! in_array($status, $stati_to_include, true)) {
+					unset($status_query_args[ $status ]);
+				}
+			}
+		}
+		// loop through and query counts for each stati.
+		$status_query_results = array();
+		foreach ($status_query_args as $status => $status_where_conditions) {
+			$status_query_results[ $status ] = EEM_Datetime::count(
+				array($status_where_conditions),
+				'DTT_ID',
+				true
+			);
+		}
+		return $status_query_results;
+	}
+
+
+	/**
+	 * Returns the specific count for a given Datetime status matching any given query_params.
+	 *
+	 * @param string $status Valid string representation for Datetime status requested. (Defaults to Active).
+	 * @param array  $query_params
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function get_datetime_count_for_status($status = EE_Datetime::active, array $query_params = array())
+	{
+		$count = $this->get_datetime_counts_by_status(array($status), $query_params);
+		return ! empty($count[ $status ]) ? $count[ $status ] : 0;
+	}
 }

Spacing +21 added lines, -21 removed lines

@@ -121,7 +121,7 @@ 
                 ),
             ),
         );
-        $this->_model_relations        = array(
+        $this->_model_relations = array(
             'Ticket'  => new EE_HABTM_Relation('Datetime_Ticket'),
             'Event'   => new EE_Belongs_To_Relation(),
             'Checkin' => new EE_Has_Many_Relation(),
@@ -131,16 +131,16 @@ 
         $this->model_chain_to_password = $path_to_event_model;
         $this->_model_chain_to_wp_user = $path_to_event_model;
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       = new EE_Restriction_Generator_Event_Related_Public(
+        $this->_cap_restriction_generators[EEM_Base::caps_read]       = new EE_Restriction_Generator_Event_Related_Public(
             $path_to_event_model
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected(
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Event_Related_Protected(
             $path_to_event_model
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       = new EE_Restriction_Generator_Event_Related_Protected(
+        $this->_cap_restriction_generators[EEM_Base::caps_edit]       = new EE_Restriction_Generator_Event_Related_Protected(
             $path_to_event_model
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     = new EE_Restriction_Generator_Event_Related_Protected(
+        $this->_cap_restriction_generators[EEM_Base::caps_delete]     = new EE_Restriction_Generator_Event_Related_Protected(
             $path_to_event_model,
             EEM_Base::caps_edit
         );
@@ -246,10 +246,10 @@ 
      */
     private function validateStartAndEndTimeForBlankDate($start_time, $end_time)
     {
-        if (! is_array($start_time)) {
+        if ( ! is_array($start_time)) {
             throw new InvalidDataTypeException('start_time', $start_time, 'array');
         }
-        if (! is_array($end_time)) {
+        if ( ! is_array($end_time)) {
             throw new InvalidDataTypeException('end_time', $end_time, 'array');
         }
         if (count($start_time) !== 2) {
@@ -283,7 +283,7 @@ 
      */
     public function get_all_event_dates($EVT_ID = 0)
     {
-        if (! $EVT_ID) { // on add_new_event event_id gets set to 0
+        if ( ! $EVT_ID) { // on add_new_event event_id gets set to 0
             return $this->create_new_blank_datetime();
         }
         $results = $this->get_datetimes_for_event_ordered_by_DTT_order($EVT_ID);
@@ -329,7 +329,7 @@ 
                 'order_by'                 => array('DTT_order' => 'ASC'),
                 'default_where_conditions' => 'none',
             );
-        if (! $include_expired) {
+        if ( ! $include_expired) {
             $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
         }
         if ($include_deleted) {
@@ -440,7 +440,7 @@ 
         $old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
         $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
         $query_params = array(array('Event.EVT_ID' => $EVT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
-        if (! $include_expired) {
+        if ( ! $include_expired) {
             $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
         }
         if ($include_deleted) {
@@ -478,7 +478,7 @@ 
         $old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
         $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
         $query_params = array(array('Ticket.TKT_ID' => $TKT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
-        if (! $include_expired) {
+        if ( ! $include_expired) {
             $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
         }
         if ($include_deleted) {
@@ -518,7 +518,7 @@ 
         $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
         $where_params = array('Ticket.TKT_ID' => $TKT_ID);
         $query_params = array($where_params, 'order_by' => array('DTT_order' => 'ASC'));
-        if (! $include_expired) {
+        if ( ! $include_expired) {
             $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
         }
         if ($include_deleted) {
@@ -641,10 +641,10 @@ 
             $this->get_timezone(),
             'DTT_EVT_start'
         );
-        $columns_to_select        = array(
-            'dtt_year'      => array('YEAR(' . $query_interval . ')', '%s'),
-            'dtt_month'     => array('MONTHNAME(' . $query_interval . ')', '%s'),
-            'dtt_month_num' => array('MONTH(' . $query_interval . ')', '%s'),
+        $columns_to_select = array(
+            'dtt_year'      => array('YEAR('.$query_interval.')', '%s'),
+            'dtt_month'     => array('MONTHNAME('.$query_interval.')', '%s'),
+            'dtt_month_num' => array('MONTH('.$query_interval.')', '%s'),
         );
         return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
     }
@@ -723,17 +723,17 @@ 
                 array('DTT_EVT_end' => array('<', time()))
             ),
         );
-        if (! empty($stati_to_include)) {
+        if ( ! empty($stati_to_include)) {
             foreach (array_keys($status_query_args) as $status) {
-                if (! in_array($status, $stati_to_include, true)) {
-                    unset($status_query_args[ $status ]);
+                if ( ! in_array($status, $stati_to_include, true)) {
+                    unset($status_query_args[$status]);
                 }
             }
         }
         // loop through and query counts for each stati.
         $status_query_results = array();
         foreach ($status_query_args as $status => $status_where_conditions) {
-            $status_query_results[ $status ] = EEM_Datetime::count(
+            $status_query_results[$status] = EEM_Datetime::count(
                 array($status_where_conditions),
                 'DTT_ID',
                 true
@@ -754,6 +754,6 @@ 
     public function get_datetime_count_for_status($status = EE_Datetime::active, array $query_params = array())
     {
         $count = $this->get_datetime_counts_by_status(array($status), $query_params);
-        return ! empty($count[ $status ]) ? $count[ $status ] : 0;
+        return ! empty($count[$status]) ? $count[$status] : 0;
     }
 }

core/data_migration_scripts/4_1_0_stages/EE_DMS_4_1_0_attendees.dmsstage.php

Indentation +601 added lines, -605 removed lines

@@ -53,10 +53,6 @@ 
 ENGINE=InnoDB
 AUTO_INCREMENT=3
 ;
-
-
-
-
  * 4.1 Attendee tables and fields:
  * $this->_tables = array(
             'Attendee_CPT'=> new EE_Primary_Table('posts', 'ID'),
@@ -186,637 +182,637 @@ 
  */
 class EE_DMS_4_1_0_attendees extends EE_Data_Migration_Script_Stage_Table
 {
-    private $_new_attendee_cpt_table;
-    private $_new_attendee_meta_table;
-    private $_new_reg_table;
-    private $_new_transaction_table;
-    private $_new_payment_table;
-    private $_new_line_table;
-    private $_old_mer_table;
-    private $_new_ticket_table;
-    private $_new_ticket_datetime_table;
-    private $_new_datetime_table;
-    private $_new_datetime_ticket_table;
-    private $_new_price_table;
-    private $_new_ticket_price_table;
-    /**
-     * Rememebrs whether or not the mer table exists
-     * @var boolean
-     */
-    private $_mer_tables_exist = null;
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_pretty_name = __("Attendees", "event_espresso");
-        $this->_old_table = $wpdb->prefix."events_attendee";
-        // Only select the event status column from the event table.
-        $this->select_expression = 'att.*, e.event_status';
-        // Only select attendees for events that aren't deleted.
-        $this->_extra_where_sql = 'AS att
+	private $_new_attendee_cpt_table;
+	private $_new_attendee_meta_table;
+	private $_new_reg_table;
+	private $_new_transaction_table;
+	private $_new_payment_table;
+	private $_new_line_table;
+	private $_old_mer_table;
+	private $_new_ticket_table;
+	private $_new_ticket_datetime_table;
+	private $_new_datetime_table;
+	private $_new_datetime_ticket_table;
+	private $_new_price_table;
+	private $_new_ticket_price_table;
+	/**
+	 * Rememebrs whether or not the mer table exists
+	 * @var boolean
+	 */
+	private $_mer_tables_exist = null;
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_pretty_name = __("Attendees", "event_espresso");
+		$this->_old_table = $wpdb->prefix."events_attendee";
+		// Only select the event status column from the event table.
+		$this->select_expression = 'att.*, e.event_status';
+		// Only select attendees for events that aren't deleted.
+		$this->_extra_where_sql = 'AS att
             INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON att.event_id=e.id
             WHERE e.event_status!="D"';
-        $this->_old_mer_table = $wpdb->prefix."events_multi_event_registration_id_group";
-        $this->_new_attendee_cpt_table = $wpdb->posts;
-        $this->_new_attendee_meta_table = $wpdb->prefix."esp_attendee_meta";
-        $this->_new_reg_table = $wpdb->prefix."esp_registration";
-        $this->_new_transaction_table = $wpdb->prefix."esp_transaction";
-        $this->_new_payment_table = $wpdb->prefix."esp_payment";
-        $this->_new_line_table = $wpdb->prefix."esp_line_item";
-        $this->_new_ticket_table = $wpdb->prefix."esp_ticket";
-        $this->_new_ticket_datetime_table = $wpdb->prefix."esp_datetime_ticket";
-        $this->_new_datetime_table = $wpdb->prefix."esp_datetime";
-        $this->_new_datetime_ticket_table = $wpdb->prefix."esp_datetime_ticket";
-        $this->_new_price_table = $wpdb->prefix."esp_price";
-        $this->_new_ticket_price_table = $wpdb->prefix."esp_ticket_price";
-        parent::__construct();
-    }
+		$this->_old_mer_table = $wpdb->prefix."events_multi_event_registration_id_group";
+		$this->_new_attendee_cpt_table = $wpdb->posts;
+		$this->_new_attendee_meta_table = $wpdb->prefix."esp_attendee_meta";
+		$this->_new_reg_table = $wpdb->prefix."esp_registration";
+		$this->_new_transaction_table = $wpdb->prefix."esp_transaction";
+		$this->_new_payment_table = $wpdb->prefix."esp_payment";
+		$this->_new_line_table = $wpdb->prefix."esp_line_item";
+		$this->_new_ticket_table = $wpdb->prefix."esp_ticket";
+		$this->_new_ticket_datetime_table = $wpdb->prefix."esp_datetime_ticket";
+		$this->_new_datetime_table = $wpdb->prefix."esp_datetime";
+		$this->_new_datetime_ticket_table = $wpdb->prefix."esp_datetime_ticket";
+		$this->_new_price_table = $wpdb->prefix."esp_price";
+		$this->_new_ticket_price_table = $wpdb->prefix."esp_ticket_price";
+		parent::__construct();
+	}
 
-    protected function _migrate_old_row($old_row)
-    {
-        // first check if there's already a new attendee with similar characteristics
-        $new_att_id = $this->_find_attendee_cpt_matching($old_row);
-        if (! $new_att_id) {
-            $new_att_id = $this->_insert_new_attendee_cpt($old_row);
-            if (! $new_att_id) {
-                // if we couldnt even make an attendee, abandon all hope
-                return false;
-            }
-            $new_att_meta_id = $this->_insert_attendee_meta_row($old_row, $new_att_id);
-            if ($new_att_meta_id) {
-                $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_attendee_meta_table, $new_att_meta_id);
-            }
-        }
-        $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_attendee_cpt_table, $new_att_id);
+	protected function _migrate_old_row($old_row)
+	{
+		// first check if there's already a new attendee with similar characteristics
+		$new_att_id = $this->_find_attendee_cpt_matching($old_row);
+		if (! $new_att_id) {
+			$new_att_id = $this->_insert_new_attendee_cpt($old_row);
+			if (! $new_att_id) {
+				// if we couldnt even make an attendee, abandon all hope
+				return false;
+			}
+			$new_att_meta_id = $this->_insert_attendee_meta_row($old_row, $new_att_id);
+			if ($new_att_meta_id) {
+				$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_attendee_meta_table, $new_att_meta_id);
+			}
+		}
+		$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_attendee_cpt_table, $new_att_id);
 
-        $txn_id = $this->_insert_new_transaction($old_row);
-        if (! $txn_id) {
-            // if we couldnt make the transaction, also abandon all hope
-            return false;
-        }
-        $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_transaction_table, $txn_id);
-        $pay_id = $this->_insert_new_payment($old_row, $txn_id);
-        if ($pay_id) {
-            $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_payment_table, $pay_id);
-        }
+		$txn_id = $this->_insert_new_transaction($old_row);
+		if (! $txn_id) {
+			// if we couldnt make the transaction, also abandon all hope
+			return false;
+		}
+		$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_transaction_table, $txn_id);
+		$pay_id = $this->_insert_new_payment($old_row, $txn_id);
+		if ($pay_id) {
+			$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_payment_table, $pay_id);
+		}
 
 
-        // even if there was no payment, we can go ahead with adding the reg
-        $new_regs = $this->_insert_new_registrations($old_row, $new_att_id, $txn_id);
-        if ($new_regs) {
-            $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_reg_table, $new_regs);
-        }
-    }
-    /**
-     * Checks if there's already an attendee CPT in the db that has the same
-     * first and last name, and email. If so, returns its ID as an int.
-     * @global type $wpdb
-     * @param array $old_attendee
-     * @return int
-     */
-    private function _find_attendee_cpt_matching($old_attendee)
-    {
-        global $wpdb;
-        $existing_attendee_id = $wpdb->get_var($wpdb->prepare("SELECT id FROM ".$this->_new_attendee_cpt_table." AS cpt INNER JOIN ".$this->_new_attendee_meta_table." AS meta ON cpt.ID = meta.ATT_ID WHERE meta.ATT_fname = %s AND meta.ATT_lname = %s AND meta.ATT_email = %s LIMIT 1", $old_attendee['fname'], $old_attendee['lname'], $old_attendee['email']));
-        return intval($existing_attendee_id);
-    }
-    private function _insert_new_attendee_cpt($old_attendee)
-    {
-        global $wpdb;
-        $cols_n_values = array(
-            'post_title'=>stripslashes($old_attendee['fname']." ".$old_attendee['lname']),// ATT_full_name
-            'post_content'=>'',// ATT_bio
-            'post_name'=>sanitize_title($old_attendee['fname']."-".$old_attendee['lname']),// ATT_slug
-            'post_date'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),// ATT_created
-            'post_excerpt'=>'',// ATT_short_bio
-            'post_modified'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),// ATT_modified
-            'post_author'=>0,// ATT_author
-            'post_parent'=>0,// ATT_parent
-            'post_type'=>'espresso_attendees',// post_type
-            'post_status'=>'publish'// status
-        );
-        $datatypes = array(
-            '%s',// ATT_full_name
-            '%s',// ATT_bio
-            '%s',// ATT_slug
-            '%s',// ATT_created
-            '%s',// ATT_short_bio
-            '%s',// ATT_modified
-            '%d',// ATT_author
-            '%d',// ATT_parent
-            '%s',// post_type
-            '%s',// status
-        );
-        $success = $wpdb->insert($this->_new_attendee_cpt_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_cpt_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
+		// even if there was no payment, we can go ahead with adding the reg
+		$new_regs = $this->_insert_new_registrations($old_row, $new_att_id, $txn_id);
+		if ($new_regs) {
+			$this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_reg_table, $new_regs);
+		}
+	}
+	/**
+	 * Checks if there's already an attendee CPT in the db that has the same
+	 * first and last name, and email. If so, returns its ID as an int.
+	 * @global type $wpdb
+	 * @param array $old_attendee
+	 * @return int
+	 */
+	private function _find_attendee_cpt_matching($old_attendee)
+	{
+		global $wpdb;
+		$existing_attendee_id = $wpdb->get_var($wpdb->prepare("SELECT id FROM ".$this->_new_attendee_cpt_table." AS cpt INNER JOIN ".$this->_new_attendee_meta_table." AS meta ON cpt.ID = meta.ATT_ID WHERE meta.ATT_fname = %s AND meta.ATT_lname = %s AND meta.ATT_email = %s LIMIT 1", $old_attendee['fname'], $old_attendee['lname'], $old_attendee['email']));
+		return intval($existing_attendee_id);
+	}
+	private function _insert_new_attendee_cpt($old_attendee)
+	{
+		global $wpdb;
+		$cols_n_values = array(
+			'post_title'=>stripslashes($old_attendee['fname']." ".$old_attendee['lname']),// ATT_full_name
+			'post_content'=>'',// ATT_bio
+			'post_name'=>sanitize_title($old_attendee['fname']."-".$old_attendee['lname']),// ATT_slug
+			'post_date'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),// ATT_created
+			'post_excerpt'=>'',// ATT_short_bio
+			'post_modified'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),// ATT_modified
+			'post_author'=>0,// ATT_author
+			'post_parent'=>0,// ATT_parent
+			'post_type'=>'espresso_attendees',// post_type
+			'post_status'=>'publish'// status
+		);
+		$datatypes = array(
+			'%s',// ATT_full_name
+			'%s',// ATT_bio
+			'%s',// ATT_slug
+			'%s',// ATT_created
+			'%s',// ATT_short_bio
+			'%s',// ATT_modified
+			'%d',// ATT_author
+			'%d',// ATT_parent
+			'%s',// post_type
+			'%s',// status
+		);
+		$success = $wpdb->insert($this->_new_attendee_cpt_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_cpt_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
 
-    private function _insert_attendee_meta_row($old_attendee, $new_attendee_cpt_id)
-    {
-        global $wpdb;
-        // get the state and country ids from the old row
-        try {
-            $new_country = $this->get_migration_script()->get_or_create_country(stripslashes($old_attendee['country_id']));
-            $new_country_iso = $new_country['CNT_ISO'];
-        } catch (EE_Error $exception) {
-            $new_country_iso = $this->get_migration_script()->get_default_country_iso();
-        }
-        try {
-            $new_state = $this->get_migration_script()->get_or_create_state(stripslashes($old_attendee['state']), $new_country_iso);
-            $new_state_id = $new_state['STA_ID'];
-        } catch (EE_Error $exception) {
-            $new_state_id = 0;
-        }
-        $cols_n_values = array(
-            'ATT_ID'=>$new_attendee_cpt_id,
-            'ATT_fname'=>stripslashes($old_attendee['fname']),
-            'ATT_lname'=>stripslashes($old_attendee['lname']),
-            'ATT_address'=>stripslashes($old_attendee['address']),
-            'ATT_address2'=>stripslashes($old_attendee['address2']),
-            'ATT_city'=>stripslashes($old_attendee['city']),
-            'STA_ID'=>$new_state_id,
-            'CNT_ISO'=>$new_country_iso,
-            'ATT_zip'=>stripslashes($old_attendee['zip']),
-            'ATT_email'=>stripslashes($old_attendee['email']),
-            'ATT_phone'=>stripslashes($old_attendee['phone']),
-        );
-        $datatypes = array(
-            '%d',// ATT_ID
-            '%s',// ATT_fname
-            '%s',// ATT_lname
-            '%s',// ATT_address
-            '%s',// ATT_address2
-            '%s',// ATT_city
-            '%d',// STA_ID
-            '%s',// CNT_ISO
-            '%s',// ATT_zip
-            '%s',// ATT_email
-            '%s',// ATT_phone
-        );
-        $success = $wpdb->insert($this->_new_attendee_meta_table, $cols_n_values, $datatypes);
-        if (! $success) {
-            $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_meta_table, $cols_n_values, $datatypes));
-            return 0;
-        }
-        $new_id = $wpdb->insert_id;
-        return $new_id;
-    }
+	private function _insert_attendee_meta_row($old_attendee, $new_attendee_cpt_id)
+	{
+		global $wpdb;
+		// get the state and country ids from the old row
+		try {
+			$new_country = $this->get_migration_script()->get_or_create_country(stripslashes($old_attendee['country_id']));
+			$new_country_iso = $new_country['CNT_ISO'];
+		} catch (EE_Error $exception) {
+			$new_country_iso = $this->get_migration_script()->get_default_country_iso();
+		}
+		try {
+			$new_state = $this->get_migration_script()->get_or_create_state(stripslashes($old_attendee['state']), $new_country_iso);
+			$new_state_id = $new_state['STA_ID'];
+		} catch (EE_Error $exception) {
+			$new_state_id = 0;
+		}
+		$cols_n_values = array(
+			'ATT_ID'=>$new_attendee_cpt_id,
+			'ATT_fname'=>stripslashes($old_attendee['fname']),
+			'ATT_lname'=>stripslashes($old_attendee['lname']),
+			'ATT_address'=>stripslashes($old_attendee['address']),
+			'ATT_address2'=>stripslashes($old_attendee['address2']),
+			'ATT_city'=>stripslashes($old_attendee['city']),
+			'STA_ID'=>$new_state_id,
+			'CNT_ISO'=>$new_country_iso,
+			'ATT_zip'=>stripslashes($old_attendee['zip']),
+			'ATT_email'=>stripslashes($old_attendee['email']),
+			'ATT_phone'=>stripslashes($old_attendee['phone']),
+		);
+		$datatypes = array(
+			'%d',// ATT_ID
+			'%s',// ATT_fname
+			'%s',// ATT_lname
+			'%s',// ATT_address
+			'%s',// ATT_address2
+			'%s',// ATT_city
+			'%d',// STA_ID
+			'%s',// CNT_ISO
+			'%s',// ATT_zip
+			'%s',// ATT_email
+			'%s',// ATT_phone
+		);
+		$success = $wpdb->insert($this->_new_attendee_meta_table, $cols_n_values, $datatypes);
+		if (! $success) {
+			$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_meta_table, $cols_n_values, $datatypes));
+			return 0;
+		}
+		$new_id = $wpdb->insert_id;
+		return $new_id;
+	}
 
-    /**
-     * Note: we don't necessarily create a new transaction for each attendee row.
-     * Only if the old attendee 'is_primary' is true; otherwise we find the old attendee row that
-     * 'is_primary' and has the same 'txn_id', then we return ITS new transaction id
-     * @global type $wpdb
-     * @param type $old_attendee
-     * @return int new transaction id
-     */
-    private function _insert_new_transaction($old_attendee)
-    {
-        global $wpdb;
+	/**
+	 * Note: we don't necessarily create a new transaction for each attendee row.
+	 * Only if the old attendee 'is_primary' is true; otherwise we find the old attendee row that
+	 * 'is_primary' and has the same 'txn_id', then we return ITS new transaction id
+	 * @global type $wpdb
+	 * @param type $old_attendee
+	 * @return int new transaction id
+	 */
+	private function _insert_new_transaction($old_attendee)
+	{
+		global $wpdb;
 
-        // first: let's check for an existing transaction for this old attendee
-        if (intval($old_attendee['is_primary'])) {// primary attendee, so create txn
-            $txn_id = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, intval($old_attendee['id']), $this->_new_transaction_table);
-        } else { // non-primary attendee, so find its primary attendee's transaction
-            $primary_attendee_old_id = $wpdb->get_var($wpdb->prepare("SELECT id FROM ".$this->_old_table." WHERE is_primary=1 and registration_id=%s", $old_attendee['registration_id']));
-            if (! $primary_attendee_old_id) {
-                $primary_attendee = $this->_find_mer_primary_attendee_using_mer_tables($old_attendee['registration_id']);
-                $primary_attendee_old_id = is_array($primary_attendee) ? $primary_attendee['id'] : null;
-            }
-            $txn_id = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, intval($primary_attendee_old_id), $this->_new_transaction_table);
-            if (! $txn_id) {
-                $this->add_error(sprintf(__("Could not find primary attendee's new transaction. Current attendee is: %s, we think the 3.1 primary attendee for it has id %d, but there's no 4.1 transaction for that primary attendee id.", "event_espresso"), $this->_json_encode($old_attendee), $primary_attendee_old_id));
-                $txn_id = 0;
-            }
-        }
-        // if there isn't yet a transaction row for this, create one
-        // (so even if it was a non-primary attendee with no EE3 primary attendee,
-        // it ought to have SOME transaction, so we'll make one)
-        if (! $txn_id) {
-            // maps 3.1 payment stati onto 4.1 transaction stati
-            $txn_status_mapping = array(
-                'Completed'=>'TCM',
-                'Pending'=>'TIN',
-                'Payment Declined'=>'TIN',
-                'Incomplete'=>'TIN',
-                'Not Completed'=>'TIN',
-                'Cancelled'=>'TIN',
-                'Declined'=>'TIN'
-            );
-            $STS_ID = isset($txn_status_mapping[ $old_attendee['payment_status'] ]) ? $txn_status_mapping[ $old_attendee['payment_status'] ] : 'TIN';
-            $cols_n_values = array(
-                'TXN_timestamp'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),
-                'TXN_total'=>floatval($old_attendee['total_cost']),
-                'TXN_paid'=>floatval($old_attendee['amount_pd']),
-                'STS_ID'=>$STS_ID,
-                'TXN_hash_salt'=>$old_attendee['hashSalt']
-            );
-            $datatypes = array(
-                '%s',// TXN_timestamp
-                '%f',// TXN_total
-                '%f',// TXN_paid
-                '%s',// STS_ID
-                '%s',// TXN_hash_salt
-            );
-            $success = $wpdb->insert($this->_new_transaction_table, $cols_n_values, $datatypes);
-            if (! $success) {
-                $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_transaction_table, $cols_n_values, $datatypes));
-                return 0;
-            }
-            $txn_id = $wpdb->insert_id;
-        }
+		// first: let's check for an existing transaction for this old attendee
+		if (intval($old_attendee['is_primary'])) {// primary attendee, so create txn
+			$txn_id = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, intval($old_attendee['id']), $this->_new_transaction_table);
+		} else { // non-primary attendee, so find its primary attendee's transaction
+			$primary_attendee_old_id = $wpdb->get_var($wpdb->prepare("SELECT id FROM ".$this->_old_table." WHERE is_primary=1 and registration_id=%s", $old_attendee['registration_id']));
+			if (! $primary_attendee_old_id) {
+				$primary_attendee = $this->_find_mer_primary_attendee_using_mer_tables($old_attendee['registration_id']);
+				$primary_attendee_old_id = is_array($primary_attendee) ? $primary_attendee['id'] : null;
+			}
+			$txn_id = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, intval($primary_attendee_old_id), $this->_new_transaction_table);
+			if (! $txn_id) {
+				$this->add_error(sprintf(__("Could not find primary attendee's new transaction. Current attendee is: %s, we think the 3.1 primary attendee for it has id %d, but there's no 4.1 transaction for that primary attendee id.", "event_espresso"), $this->_json_encode($old_attendee), $primary_attendee_old_id));
+				$txn_id = 0;
+			}
+		}
+		// if there isn't yet a transaction row for this, create one
+		// (so even if it was a non-primary attendee with no EE3 primary attendee,
+		// it ought to have SOME transaction, so we'll make one)
+		if (! $txn_id) {
+			// maps 3.1 payment stati onto 4.1 transaction stati
+			$txn_status_mapping = array(
+				'Completed'=>'TCM',
+				'Pending'=>'TIN',
+				'Payment Declined'=>'TIN',
+				'Incomplete'=>'TIN',
+				'Not Completed'=>'TIN',
+				'Cancelled'=>'TIN',
+				'Declined'=>'TIN'
+			);
+			$STS_ID = isset($txn_status_mapping[ $old_attendee['payment_status'] ]) ? $txn_status_mapping[ $old_attendee['payment_status'] ] : 'TIN';
+			$cols_n_values = array(
+				'TXN_timestamp'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),
+				'TXN_total'=>floatval($old_attendee['total_cost']),
+				'TXN_paid'=>floatval($old_attendee['amount_pd']),
+				'STS_ID'=>$STS_ID,
+				'TXN_hash_salt'=>$old_attendee['hashSalt']
+			);
+			$datatypes = array(
+				'%s',// TXN_timestamp
+				'%f',// TXN_total
+				'%f',// TXN_paid
+				'%s',// STS_ID
+				'%s',// TXN_hash_salt
+			);
+			$success = $wpdb->insert($this->_new_transaction_table, $cols_n_values, $datatypes);
+			if (! $success) {
+				$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_transaction_table, $cols_n_values, $datatypes));
+				return 0;
+			}
+			$txn_id = $wpdb->insert_id;
+		}
 
-        return $txn_id;
-    }
-    /**
-     * Detects if the MER tables exist
-     * @global type $wpdb
-     * @return boolean
-     */
-    private function _mer_tables_exist()
-    {
-        if ($this->_mer_tables_exist === null) {
-            global $wpdb;
+		return $txn_id;
+	}
+	/**
+	 * Detects if the MER tables exist
+	 * @global type $wpdb
+	 * @return boolean
+	 */
+	private function _mer_tables_exist()
+	{
+		if ($this->_mer_tables_exist === null) {
+			global $wpdb;
 
-            if ($wpdb->get_var("SHOW TABLES LIKE '{$this->_old_mer_table}'") != $this->_old_mer_table) {
-                $this->_mer_tables_exist = false;
-            } else {
-                $this->_mer_tables_exist = true;
-            }
-        }
-        return $this->_mer_tables_exist;
-    }
+			if ($wpdb->get_var("SHOW TABLES LIKE '{$this->_old_mer_table}'") != $this->_old_mer_table) {
+				$this->_mer_tables_exist = false;
+			} else {
+				$this->_mer_tables_exist = true;
+			}
+		}
+		return $this->_mer_tables_exist;
+	}
 
-    /**
-     * Gets the 4.1 registration's status given the 3.1 attendee row. We consider
-     * whether the event required pre-approval or not,a dn the 4.1 payment status.
-     * @global type $wpdb
-     * @param type $old_attendee_row
-     * @return string
-     */
-    private function _get_reg_status_for_old_payment_status($old_attendee_row)
-    {
-        // need event default reg status and if pre_approval was required
-        global $wpdb;
-        $event_required_pre_approval = $wpdb->get_var($wpdb->prepare("SELECT require_pre_approval FROM ".$wpdb->prefix."events_detail WHERE id = %d", $old_attendee_row['event_id']));
-        return $this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID(
-            $old_attendee_row['payment_status'],
-            intval($event_required_pre_approval) && intval($old_attendee_row['pre_approve'])
-        );
-    }
-    /**
-     * Adds however many rgistrations are indicated by the old attendee's QUANTITY field,
-     * and returns an array of their IDs
-     * @global type $wpdb
-     * @param array $old_attendee
-     * @param int $new_attendee_id
-     * @param int $new_txn_id
-     * @return array of new registratio ids
-     */
-    private function _insert_new_registrations($old_attendee, $new_attendee_id, $new_txn_id)
-    {
-        global $wpdb;
+	/**
+	 * Gets the 4.1 registration's status given the 3.1 attendee row. We consider
+	 * whether the event required pre-approval or not,a dn the 4.1 payment status.
+	 * @global type $wpdb
+	 * @param type $old_attendee_row
+	 * @return string
+	 */
+	private function _get_reg_status_for_old_payment_status($old_attendee_row)
+	{
+		// need event default reg status and if pre_approval was required
+		global $wpdb;
+		$event_required_pre_approval = $wpdb->get_var($wpdb->prepare("SELECT require_pre_approval FROM ".$wpdb->prefix."events_detail WHERE id = %d", $old_attendee_row['event_id']));
+		return $this->get_migration_script()->convert_3_1_payment_status_to_4_1_STS_ID(
+			$old_attendee_row['payment_status'],
+			intval($event_required_pre_approval) && intval($old_attendee_row['pre_approve'])
+		);
+	}
+	/**
+	 * Adds however many rgistrations are indicated by the old attendee's QUANTITY field,
+	 * and returns an array of their IDs
+	 * @global type $wpdb
+	 * @param array $old_attendee
+	 * @param int $new_attendee_id
+	 * @param int $new_txn_id
+	 * @return array of new registratio ids
+	 */
+	private function _insert_new_registrations($old_attendee, $new_attendee_id, $new_txn_id)
+	{
+		global $wpdb;
 
-        $STS_ID = $this->_get_reg_status_for_old_payment_status($old_attendee);
-        $new_event_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix.'events_detail', $old_attendee['event_id'], $wpdb->posts);
-        if (! $new_event_id) {
-            $this->add_error(sprintf(__("Could not find NEW event CPT ID for old event '%d' on old attendee %s", "event_espresso"), $old_attendee['event_id'], $this->_json_encode($old_attendee)));
-        }
+		$STS_ID = $this->_get_reg_status_for_old_payment_status($old_attendee);
+		$new_event_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix.'events_detail', $old_attendee['event_id'], $wpdb->posts);
+		if (! $new_event_id) {
+			$this->add_error(sprintf(__("Could not find NEW event CPT ID for old event '%d' on old attendee %s", "event_espresso"), $old_attendee['event_id'], $this->_json_encode($old_attendee)));
+		}
 
-        $ticket_id = $this->_try_to_find_new_ticket_id($old_attendee, $new_event_id);
-        if (! $ticket_id) {
-            $ticket_id = $this->_insert_new_ticket_because_none_found($old_attendee, $new_event_id);
-            $this->add_error(sprintf(__('Could not find a ticket for old attendee with id %d for new event %d, so created a new ticket with id %d', 'event_espresso'), $old_attendee['id'], $new_event_id, $ticket_id));
-        }
-        $regs_on_this_row = intval($old_attendee['quantity']);
-        $new_regs = array();
-        // 4 cases we need to account for:
-        // 1 old attendee_details row with a quantity of X (no mer)
-        // Y old attendee_details rows with a quantity of 1 (no mer) joined by their common registration_id
-        // Y old attendee_details rows with a quantity of x (because of mer)
-        // Y old attendee_details rows with a quantity of 1 (because of mer) joined by wp_events_multi_event_registration_id_group
-        for ($count = 1; $count <= $regs_on_this_row; $count++) {
-            // sum regs on older rows
-            $regs_on_this_event_and_txn = $this->_sum_old_attendees_on_old_txn($old_attendee, true);
-            $cols_n_values = array(
-                'EVT_ID'=>$new_event_id,
-                'ATT_ID'=>$new_attendee_id,
-                'TXN_ID'=>$new_txn_id,
-                'TKT_ID'=>$ticket_id,
-                'STS_ID'=>$STS_ID,
-                'REG_date'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),
-                'REG_final_price'=>$old_attendee['final_price'],
-                'REG_session'=> substr($old_attendee['attendee_session'], 0, 44),
-                'REG_code'=>sanitize_key($old_attendee['registration_id']),
-                'REG_url_link'=>  sanitize_key($old_attendee['registration_id'].'-'.$count),
-                'REG_count'=>$regs_on_this_event_and_txn + $count,
-                'REG_group_size'=>$this->_sum_old_attendees_on_old_txn($old_attendee, false),
-                'REG_att_is_going'=>true,
-                'REG_deleted'=>false
-            );
-            $datatypes = array(
-                '%d',// EVT_ID
-                '%d',// ATT_ID
-                '%d',// TXN_ID
-                '%d',// TKT_ID
-                '%s',// STS_ID
-                '%s',// REG_date
-                '%f',// REG_final_price
-                '%s',// REG_session
-                '%s',// REG_code
-                '%s',// REG_url_link
-                '%d',// REG_count
-                '%d',// REG_group_size
-                '%d',// REG_att_is_going
-                '%d',// REG_deleted
-            );
-            $success = $wpdb->insert($this->_new_reg_table, $cols_n_values, $datatypes);
-            if (! $success) {
-                $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_reg_table, $cols_n_values, $datatypes));
-                return 0;
-            }
-            $cols_n_values['REG_ID'] = $wpdb->insert_id;
-            $new_regs[] = $wpdb->insert_id;
-        }
-        $this->_add_regs_to_ticket_and_datetimes($ticket_id, count($new_regs), $STS_ID);
-        return $new_regs;
-    }
+		$ticket_id = $this->_try_to_find_new_ticket_id($old_attendee, $new_event_id);
+		if (! $ticket_id) {
+			$ticket_id = $this->_insert_new_ticket_because_none_found($old_attendee, $new_event_id);
+			$this->add_error(sprintf(__('Could not find a ticket for old attendee with id %d for new event %d, so created a new ticket with id %d', 'event_espresso'), $old_attendee['id'], $new_event_id, $ticket_id));
+		}
+		$regs_on_this_row = intval($old_attendee['quantity']);
+		$new_regs = array();
+		// 4 cases we need to account for:
+		// 1 old attendee_details row with a quantity of X (no mer)
+		// Y old attendee_details rows with a quantity of 1 (no mer) joined by their common registration_id
+		// Y old attendee_details rows with a quantity of x (because of mer)
+		// Y old attendee_details rows with a quantity of 1 (because of mer) joined by wp_events_multi_event_registration_id_group
+		for ($count = 1; $count <= $regs_on_this_row; $count++) {
+			// sum regs on older rows
+			$regs_on_this_event_and_txn = $this->_sum_old_attendees_on_old_txn($old_attendee, true);
+			$cols_n_values = array(
+				'EVT_ID'=>$new_event_id,
+				'ATT_ID'=>$new_attendee_id,
+				'TXN_ID'=>$new_txn_id,
+				'TKT_ID'=>$ticket_id,
+				'STS_ID'=>$STS_ID,
+				'REG_date'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),
+				'REG_final_price'=>$old_attendee['final_price'],
+				'REG_session'=> substr($old_attendee['attendee_session'], 0, 44),
+				'REG_code'=>sanitize_key($old_attendee['registration_id']),
+				'REG_url_link'=>  sanitize_key($old_attendee['registration_id'].'-'.$count),
+				'REG_count'=>$regs_on_this_event_and_txn + $count,
+				'REG_group_size'=>$this->_sum_old_attendees_on_old_txn($old_attendee, false),
+				'REG_att_is_going'=>true,
+				'REG_deleted'=>false
+			);
+			$datatypes = array(
+				'%d',// EVT_ID
+				'%d',// ATT_ID
+				'%d',// TXN_ID
+				'%d',// TKT_ID
+				'%s',// STS_ID
+				'%s',// REG_date
+				'%f',// REG_final_price
+				'%s',// REG_session
+				'%s',// REG_code
+				'%s',// REG_url_link
+				'%d',// REG_count
+				'%d',// REG_group_size
+				'%d',// REG_att_is_going
+				'%d',// REG_deleted
+			);
+			$success = $wpdb->insert($this->_new_reg_table, $cols_n_values, $datatypes);
+			if (! $success) {
+				$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_reg_table, $cols_n_values, $datatypes));
+				return 0;
+			}
+			$cols_n_values['REG_ID'] = $wpdb->insert_id;
+			$new_regs[] = $wpdb->insert_id;
+		}
+		$this->_add_regs_to_ticket_and_datetimes($ticket_id, count($new_regs), $STS_ID);
+		return $new_regs;
+	}
 
-    /**
-     * Increments the sold values on the ticket and its related datetimes by the amount sold,
-     * which should be done directly after adding the rows. Yes this means we're constantly incrementing
-     * the sold amounts as we go, and is less efficient than a single big query,
-     * but its safer because we KNOW these regs have been added, rather than inferring
-     * that they WILL be added (because the attendees stage runs nearly last during
-     * the migration script)
-     * @param type $new_ticket_id
-     * @param type $sold
-     * @param type $STS_ID
-     * @return boolean whether they were successfully updated or not
-     */
-    protected function _add_regs_to_ticket_and_datetimes($new_ticket_id, $quantity_sold, $STS_ID)
-    {
-        if ($STS_ID != 'RAP') {
-            return true;
-        }
-        global $wpdb;
-        $success = $wpdb->query($wpdb->prepare("UPDATE {$this->_new_ticket_table} SET TKT_sold=TKT_sold+%d WHERE TKT_ID=%d", $quantity_sold, $new_ticket_id));
-        if ($success) {
-            // get the ticket's datetimes, and increment them too
-            $success_update_dateimtes =  $wpdb->query($wpdb->prepare("UPDATE {$this->_new_ticket_table} TKT
+	/**
+	 * Increments the sold values on the ticket and its related datetimes by the amount sold,
+	 * which should be done directly after adding the rows. Yes this means we're constantly incrementing
+	 * the sold amounts as we go, and is less efficient than a single big query,
+	 * but its safer because we KNOW these regs have been added, rather than inferring
+	 * that they WILL be added (because the attendees stage runs nearly last during
+	 * the migration script)
+	 * @param type $new_ticket_id
+	 * @param type $sold
+	 * @param type $STS_ID
+	 * @return boolean whether they were successfully updated or not
+	 */
+	protected function _add_regs_to_ticket_and_datetimes($new_ticket_id, $quantity_sold, $STS_ID)
+	{
+		if ($STS_ID != 'RAP') {
+			return true;
+		}
+		global $wpdb;
+		$success = $wpdb->query($wpdb->prepare("UPDATE {$this->_new_ticket_table} SET TKT_sold=TKT_sold+%d WHERE TKT_ID=%d", $quantity_sold, $new_ticket_id));
+		if ($success) {
+			// get the ticket's datetimes, and increment them too
+			$success_update_dateimtes =  $wpdb->query($wpdb->prepare("UPDATE {$this->_new_ticket_table} TKT
 				INNER JOIN {$this->_new_ticket_datetime_table} as DTK ON TKT.TKT_ID = DTK.TKT_ID
 				INNER JOIN {$this->_new_datetime_table} as DTT ON DTK.DTT_ID = DTT.DTT_ID
 				SET DTT.DTT_sold = DTT.DTT_sold + %d WHERE TKT.TKT_ID = %d", $quantity_sold, $new_ticket_id));
-            if (! $success_update_dateimtes) {
-                $this->add_error(sprintf(__("Could not update datetimes related to ticket with ID %d's TKT_sold by %d because %s", "event_espresso"), $new_ticket_id, $quantity_sold, $wpdb->last_error));
-            }
-        } else {
-            $this->add_error(sprintf(__("Could not update ticket with ID %d's TKT_sold by %d because %s", "event_espresso"), $new_ticket_id, $quantity_sold, $wpdb->last_error));
-        }
-        return true;
-    }
-    /**
-     * Makes a best guess at which ticket is the one the attendee purchased.
-     * Obviously, the old attendee's event_id narrows it down quite a bit;
-     * then the old attendee's orig_price and event_time, and price_option can uniquely identify the ticket
-     * however, if we don't find an exact match, see if any of those conditions match;
-     * and lastly if none of that works, just use the first ticket for the event we find
-     * @param array $old_attendee
-     */
-    private function _try_to_find_new_ticket_id($old_attendee, $new_event_id)
-    {
-        global $wpdb;
-        $tickets_table = $this->_new_ticket_table;
-        $datetime_tickets_table = $this->_new_ticket_datetime_table;
-        $datetime_table = $this->_new_datetime_table;
+			if (! $success_update_dateimtes) {
+				$this->add_error(sprintf(__("Could not update datetimes related to ticket with ID %d's TKT_sold by %d because %s", "event_espresso"), $new_ticket_id, $quantity_sold, $wpdb->last_error));
+			}
+		} else {
+			$this->add_error(sprintf(__("Could not update ticket with ID %d's TKT_sold by %d because %s", "event_espresso"), $new_ticket_id, $quantity_sold, $wpdb->last_error));
+		}
+		return true;
+	}
+	/**
+	 * Makes a best guess at which ticket is the one the attendee purchased.
+	 * Obviously, the old attendee's event_id narrows it down quite a bit;
+	 * then the old attendee's orig_price and event_time, and price_option can uniquely identify the ticket
+	 * however, if we don't find an exact match, see if any of those conditions match;
+	 * and lastly if none of that works, just use the first ticket for the event we find
+	 * @param array $old_attendee
+	 */
+	private function _try_to_find_new_ticket_id($old_attendee, $new_event_id)
+	{
+		global $wpdb;
+		$tickets_table = $this->_new_ticket_table;
+		$datetime_tickets_table = $this->_new_ticket_datetime_table;
+		$datetime_table = $this->_new_datetime_table;
 
-        $old_att_price_option = $old_attendee['price_option'];
-        $old_att_price = floatval($old_attendee['orig_price']);
+		$old_att_price_option = $old_attendee['price_option'];
+		$old_att_price = floatval($old_attendee['orig_price']);
 
-        $old_att_start_date = $old_attendee['start_date'];
-        $old_att_start_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
-        $old_att_datetime = $this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, "$old_att_start_date $old_att_start_time:00");
-        // add all conditions to an array from which we can SHIFT conditions off in order to widen our search
-        // the most important condition should be last, as it will be array_shift'ed off last
-        $conditions = array(
-            $wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime),// times match?
-            $wpdb->prepare("$tickets_table.TKT_price = %f", $old_att_price),// prices match?
-            $wpdb->prepare("$tickets_table.TKT_name = %s", $old_att_price_option),// names match?
-            $wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id),// events match?
-        );
-        $select_and_join_part = "SELECT $tickets_table.TKT_ID FROM $tickets_table INNER JOIN
+		$old_att_start_date = $old_attendee['start_date'];
+		$old_att_start_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
+		$old_att_datetime = $this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, "$old_att_start_date $old_att_start_time:00");
+		// add all conditions to an array from which we can SHIFT conditions off in order to widen our search
+		// the most important condition should be last, as it will be array_shift'ed off last
+		$conditions = array(
+			$wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime),// times match?
+			$wpdb->prepare("$tickets_table.TKT_price = %f", $old_att_price),// prices match?
+			$wpdb->prepare("$tickets_table.TKT_name = %s", $old_att_price_option),// names match?
+			$wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id),// events match?
+		);
+		$select_and_join_part = "SELECT $tickets_table.TKT_ID FROM $tickets_table INNER JOIN
 			$datetime_tickets_table ON $tickets_table.TKT_ID = $datetime_tickets_table.TKT_ID INNER JOIN
 			$datetime_table ON $datetime_tickets_table.DTT_ID = $datetime_table.DTT_ID";
-        // start running queries, widening search each time by removing a condition
-        do {
-            $full_query = $select_and_join_part." WHERE ".implode(" AND ", $conditions)." LIMIT 1";
-            $ticket_id_found = $wpdb->get_var($full_query);
-            array_shift($conditions);
-        } while (! $ticket_id_found && $conditions);
-        return $ticket_id_found;
-    }
+		// start running queries, widening search each time by removing a condition
+		do {
+			$full_query = $select_and_join_part." WHERE ".implode(" AND ", $conditions)." LIMIT 1";
+			$ticket_id_found = $wpdb->get_var($full_query);
+			array_shift($conditions);
+		} while (! $ticket_id_found && $conditions);
+		return $ticket_id_found;
+	}
 
-    /**
-     * If we couldn't find a 4.1 ticket for a 3.1 attendee row, this function creates one;
-     * and it also tries to find a datetime that works, and a inserts a price, and associates
-     * the new ticket to that datetime and price.
-     * @return int ticket id
-     */
-    private function _insert_new_ticket_because_none_found($old_attendee, $new_event_id)
-    {
-        global $wpdb;
-        $old_att_price_option = $old_attendee['price_option'];
-        $old_att_price = floatval($old_attendee['orig_price']);
+	/**
+	 * If we couldn't find a 4.1 ticket for a 3.1 attendee row, this function creates one;
+	 * and it also tries to find a datetime that works, and a inserts a price, and associates
+	 * the new ticket to that datetime and price.
+	 * @return int ticket id
+	 */
+	private function _insert_new_ticket_because_none_found($old_attendee, $new_event_id)
+	{
+		global $wpdb;
+		$old_att_price_option = $old_attendee['price_option'];
+		$old_att_price = floatval($old_attendee['orig_price']);
 
-        $old_att_start_date = $old_attendee['start_date'];
-        $old_att_start_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
-        $old_att_start_datetime = $this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, "$old_att_start_date $old_att_start_time:00");
+		$old_att_start_date = $old_attendee['start_date'];
+		$old_att_start_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
+		$old_att_start_datetime = $this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, "$old_att_start_date $old_att_start_time:00");
 
 
-        // insert new datetime unless we find one
-        $datetime_id = $wpdb->get_var($wpdb->prepare("SELECT DTT_ID FROM " . $this->_new_datetime_table . " WHERE DTT_EVT_start=%s AND EVT_ID=%d LIMIT 1", $old_att_start_datetime, $new_event_id), ARRAY_A);
-        if (! $datetime_id) {
-            $old_att_end_date = $old_attendee['start_date'];
-            $old_att_end_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
-            $old_att_end_datetime = $this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, "$old_att_end_date $old_att_end_time:00");
-            $wpdb->insert(
-                $this->_new_datetime_table,
-                array(
-                        'EVT_ID' => $new_event_id,
-                        'DTT_EVT_start' => $old_att_start_datetime,
-                        'DTT_EVT_end' => $old_att_end_datetime,
-                        'DTT_deleted' => true
-                    ),
-                array(
-                        '%d',// EVT_ID
-                        '%s',// DTT_EVT_start
-                        '%s',// DTT_EVT_end
-                        '%d',// DTT_deleted
-                    )
-            );
-            $datetime_id = $wpdb->insert_id;
-        }
+		// insert new datetime unless we find one
+		$datetime_id = $wpdb->get_var($wpdb->prepare("SELECT DTT_ID FROM " . $this->_new_datetime_table . " WHERE DTT_EVT_start=%s AND EVT_ID=%d LIMIT 1", $old_att_start_datetime, $new_event_id), ARRAY_A);
+		if (! $datetime_id) {
+			$old_att_end_date = $old_attendee['start_date'];
+			$old_att_end_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
+			$old_att_end_datetime = $this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, "$old_att_end_date $old_att_end_time:00");
+			$wpdb->insert(
+				$this->_new_datetime_table,
+				array(
+						'EVT_ID' => $new_event_id,
+						'DTT_EVT_start' => $old_att_start_datetime,
+						'DTT_EVT_end' => $old_att_end_datetime,
+						'DTT_deleted' => true
+					),
+				array(
+						'%d',// EVT_ID
+						'%s',// DTT_EVT_start
+						'%s',// DTT_EVT_end
+						'%d',// DTT_deleted
+					)
+			);
+			$datetime_id = $wpdb->insert_id;
+		}
 
-        // insert new ticket
-        $success = $wpdb->insert(
-            $wpdb->prefix . 'esp_ticket',
-            array(
-                    'TKT_name' => $old_att_price_option,
-                    'TKT_qty' => -1,
-                    'TKT_price' => $old_att_price,
-                    'TKT_start_date' => $old_att_start_datetime,// we really have no clue what the time should be, but at least it was available when they attended
-                    'TKT_end_date' => $old_att_end_datetime,
+		// insert new ticket
+		$success = $wpdb->insert(
+			$wpdb->prefix . 'esp_ticket',
+			array(
+					'TKT_name' => $old_att_price_option,
+					'TKT_qty' => -1,
+					'TKT_price' => $old_att_price,
+					'TKT_start_date' => $old_att_start_datetime,// we really have no clue what the time should be, but at least it was available when they attended
+					'TKT_end_date' => $old_att_end_datetime,
 
-                ),
-            array(
-                    '%s',// name
-                    '%d',// qty
-                    '%d',// price
-                    '%s',// start_date
-                    '%s',// end_date
-                )
-        );
-        $ticket_id = $wpdb->insert_id;
-        // associate the ticket with the datetime we found earlier
-        $wpdb->insert(
-            $this->_new_datetime_ticket_table,
-            array(
-                    'DTT_ID' => $datetime_id,
-                    'TKT_ID' => $ticket_id
-                ),
-            array(
-                    '%d',// DTT_ID
-                    '%d',// TKT_ID
-                )
-        );
-        // insert new price
-        $wpdb->insert(
-            $this->_new_price_table,
-            array(
-                    'PRC_amount' => $old_att_price,
-                    'PRT_ID' => EE_DMS_4_1_0_prices::price_type_base,
-                    'PRC_name' => $old_att_price_option,
-                    'PRC_deleted' => true
-                ),
-            array(
-                    '%d',// PRC_amount
-                    '%d',// PRT_ID
-                    '%s',// PRC_name
-                    '%d',// PRC_deleted
-                )
-        );
-        $price_id = $wpdb->insert_id;
-        // associate the price to the ticket
-        $wpdb->insert(
-            $this->_new_ticket_price_table,
-            array(
-                    'TKT_ID' => $ticket_id,
-                    'PRC_ID' => $price_id
-                ),
-            array(
-                    '%d',// TKT_ID
-                    '%d',// PRC_ID
-                )
-        );
-        return $ticket_id;
-    }
-    /**
-     * Counts all the registrations on this transaction. If $count_only_older is TRUE then returns the number added SO FAR (ie,
-     * only considers attendee rows with an ID less than this one's), but if $count_only_older is FALSe returns ALL
-     * @global type $wpdb
-     * @param array $old_attendee_row
-     * @param boolean $count_only_older true if you want the running count (ie, the total up to this row), and false if you want ALL
-     * @return int
-     */
-    private function _sum_old_attendees_on_old_txn($old_attendee_row, $count_only_older = false)
-    {
-        global $wpdb;
-        $count_only_older_sql = $count_only_older ? $wpdb->prepare(" AND id<%d", $old_attendee_row['id']) : '';
-        $count = intval($wpdb->get_var($wpdb->prepare("SELECT SUM(quantity) FROM ".$this->_old_table." WHERE registration_id=%s $count_only_older_sql", $old_attendee_row['registration_id'])));
+				),
+			array(
+					'%s',// name
+					'%d',// qty
+					'%d',// price
+					'%s',// start_date
+					'%s',// end_date
+				)
+		);
+		$ticket_id = $wpdb->insert_id;
+		// associate the ticket with the datetime we found earlier
+		$wpdb->insert(
+			$this->_new_datetime_ticket_table,
+			array(
+					'DTT_ID' => $datetime_id,
+					'TKT_ID' => $ticket_id
+				),
+			array(
+					'%d',// DTT_ID
+					'%d',// TKT_ID
+				)
+		);
+		// insert new price
+		$wpdb->insert(
+			$this->_new_price_table,
+			array(
+					'PRC_amount' => $old_att_price,
+					'PRT_ID' => EE_DMS_4_1_0_prices::price_type_base,
+					'PRC_name' => $old_att_price_option,
+					'PRC_deleted' => true
+				),
+			array(
+					'%d',// PRC_amount
+					'%d',// PRT_ID
+					'%s',// PRC_name
+					'%d',// PRC_deleted
+				)
+		);
+		$price_id = $wpdb->insert_id;
+		// associate the price to the ticket
+		$wpdb->insert(
+			$this->_new_ticket_price_table,
+			array(
+					'TKT_ID' => $ticket_id,
+					'PRC_ID' => $price_id
+				),
+			array(
+					'%d',// TKT_ID
+					'%d',// PRC_ID
+				)
+		);
+		return $ticket_id;
+	}
+	/**
+	 * Counts all the registrations on this transaction. If $count_only_older is TRUE then returns the number added SO FAR (ie,
+	 * only considers attendee rows with an ID less than this one's), but if $count_only_older is FALSe returns ALL
+	 * @global type $wpdb
+	 * @param array $old_attendee_row
+	 * @param boolean $count_only_older true if you want the running count (ie, the total up to this row), and false if you want ALL
+	 * @return int
+	 */
+	private function _sum_old_attendees_on_old_txn($old_attendee_row, $count_only_older = false)
+	{
+		global $wpdb;
+		$count_only_older_sql = $count_only_older ? $wpdb->prepare(" AND id<%d", $old_attendee_row['id']) : '';
+		$count = intval($wpdb->get_var($wpdb->prepare("SELECT SUM(quantity) FROM ".$this->_old_table." WHERE registration_id=%s $count_only_older_sql", $old_attendee_row['registration_id'])));
 
-        if ($this->_mer_tables_exist()) {
-            // if MER exists, then its a little tricky.
-            // when users registered by adding items to the cart, and it was a
-            // group registration requiring additional attendee INFO, then the attendee rows
-            // DO NOT have the same registration_id (although they probably should have)
-            // they are related just like MER attendee rows are related, through the MER group table
-            // BUT we want to count all the MER attendee rows for the same registration
-            $primary_attendee = $this->_find_mer_primary_attendee_using_mer_tables($old_attendee_row['registration_id']);
+		if ($this->_mer_tables_exist()) {
+			// if MER exists, then its a little tricky.
+			// when users registered by adding items to the cart, and it was a
+			// group registration requiring additional attendee INFO, then the attendee rows
+			// DO NOT have the same registration_id (although they probably should have)
+			// they are related just like MER attendee rows are related, through the MER group table
+			// BUT we want to count all the MER attendee rows for the same registration
+			$primary_attendee = $this->_find_mer_primary_attendee_using_mer_tables($old_attendee_row['registration_id']);
 
-            $count_using_mer_table = $wpdb->get_var($wpdb->prepare("SELECT SUM(quantity) FROM {$this->_old_table} att INNER JOIN {$this->_old_mer_table} mer ON att.registration_id = mer.registration_id WHERE att.event_id=%d AND mer.primary_registration_id = %s $count_only_older_sql", $old_attendee_row['event_id'], $primary_attendee['registration_id']));
-            $count = max($count_using_mer_table, $count);
-        }
-        return $count;
-    }
-    private function _insert_new_payment($old_attendee, $new_txn_id)
-    {
-        global $wpdb;
-        // only add a payment for primary attendees
-        $old_pay_stati_indicating_no_payment = array('Pending','Incomplete','Not Completed');
-        // if this is for a primary 3.1 attendee which WASN'T free and has a completed, cancelled, or declined payment...
-        if (intval($old_attendee['is_primary']) && floatval($old_attendee['total_cost']) && ! in_array($old_attendee['payment_status'], $old_pay_stati_indicating_no_payment)) {
-            $pay_status_mapping = array(
-                'Completed'=>'PAP',
-                'Payment Declined'=>'PDC',
-                'Cancelled'=>'PCN',
-                'Declined'=>'PDC'
-            );
-            $by_admin = $old_attendee['payment'] == 'Admin';
-            $STS_ID = isset($pay_status_mapping[ $old_attendee['payment_status'] ]) ? $pay_status_mapping[ $old_attendee['payment_status'] ] : 'PFL';// IE, if we don't recognize the status, assume payment failed
-            $cols_n_values = array(
-                'TXN_ID'=>$new_txn_id,
-                'STS_ID'=>$STS_ID,
-                'PAY_timestamp'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),
-                'PAY_method'=>'CART',
-                'PAY_amount'=>$old_attendee['amount_pd'],
-                'PAY_gateway'=>$old_attendee['txn_type'],
-                'PAY_gateway_response'=>'',
-                'PAY_txn_id_chq_nmbr'=>substr($old_attendee['txn_id'], 0, 32),
-                'PAY_via_admin'=>$by_admin,
-                'PAY_details'=>$old_attendee['transaction_details']
+			$count_using_mer_table = $wpdb->get_var($wpdb->prepare("SELECT SUM(quantity) FROM {$this->_old_table} att INNER JOIN {$this->_old_mer_table} mer ON att.registration_id = mer.registration_id WHERE att.event_id=%d AND mer.primary_registration_id = %s $count_only_older_sql", $old_attendee_row['event_id'], $primary_attendee['registration_id']));
+			$count = max($count_using_mer_table, $count);
+		}
+		return $count;
+	}
+	private function _insert_new_payment($old_attendee, $new_txn_id)
+	{
+		global $wpdb;
+		// only add a payment for primary attendees
+		$old_pay_stati_indicating_no_payment = array('Pending','Incomplete','Not Completed');
+		// if this is for a primary 3.1 attendee which WASN'T free and has a completed, cancelled, or declined payment...
+		if (intval($old_attendee['is_primary']) && floatval($old_attendee['total_cost']) && ! in_array($old_attendee['payment_status'], $old_pay_stati_indicating_no_payment)) {
+			$pay_status_mapping = array(
+				'Completed'=>'PAP',
+				'Payment Declined'=>'PDC',
+				'Cancelled'=>'PCN',
+				'Declined'=>'PDC'
+			);
+			$by_admin = $old_attendee['payment'] == 'Admin';
+			$STS_ID = isset($pay_status_mapping[ $old_attendee['payment_status'] ]) ? $pay_status_mapping[ $old_attendee['payment_status'] ] : 'PFL';// IE, if we don't recognize the status, assume payment failed
+			$cols_n_values = array(
+				'TXN_ID'=>$new_txn_id,
+				'STS_ID'=>$STS_ID,
+				'PAY_timestamp'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),
+				'PAY_method'=>'CART',
+				'PAY_amount'=>$old_attendee['amount_pd'],
+				'PAY_gateway'=>$old_attendee['txn_type'],
+				'PAY_gateway_response'=>'',
+				'PAY_txn_id_chq_nmbr'=>substr($old_attendee['txn_id'], 0, 32),
+				'PAY_via_admin'=>$by_admin,
+				'PAY_details'=>$old_attendee['transaction_details']
 
-            );
-            $datatypes = array(
-                '%d',// TXN_Id
-                '%s',// STS_ID
-                '%s',// PAY_timestamp
-                '%s',// PAY_method
-                '%f',// PAY_amount
-                '%s',// PAY_gateway
-                '%s',// PAY_gateway_response
-                '%s',// PAY_txn_id_chq_nmbr
-                '%d',// PAY_via_admin
-                '%s',// PAY_details
-            );
-            $success = $wpdb->insert($this->_new_payment_table, $cols_n_values, $datatypes);
-            if (! $success) {
-                $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_cpt_table, $cols_n_values, $datatypes));
-                return 0;
-            }
-            $new_id = $wpdb->insert_id;
-            return $new_id;
-        } else {
-            return 0;
-        }
-    }
+			);
+			$datatypes = array(
+				'%d',// TXN_Id
+				'%s',// STS_ID
+				'%s',// PAY_timestamp
+				'%s',// PAY_method
+				'%f',// PAY_amount
+				'%s',// PAY_gateway
+				'%s',// PAY_gateway_response
+				'%s',// PAY_txn_id_chq_nmbr
+				'%d',// PAY_via_admin
+				'%s',// PAY_details
+			);
+			$success = $wpdb->insert($this->_new_payment_table, $cols_n_values, $datatypes);
+			if (! $success) {
+				$this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_cpt_table, $cols_n_values, $datatypes));
+				return 0;
+			}
+			$new_id = $wpdb->insert_id;
+			return $new_id;
+		} else {
+			return 0;
+		}
+	}
 
-    /**
-     * If MER is active, if you want ot fin dthe other registrations on that attendee row
-     * @global type $wpdb
-     * @param type $old_registration_id
-     * @return array
-     */
-    private function _find_mer_primary_attendee_using_mer_tables($old_registration_id)
-    {
-        if (! $this->_mer_tables_exist()) {
-            return false;
-        }
-        global $wpdb;
-        $old_att_for_primary_reg = $wpdb->get_row($wpdb->prepare("SELECT * FROM {$this->_old_mer_table} AS mer INNER JOIN {$this->_old_table} AS att ON mer.primary_registration_id = att.registration_id WHERE mer.registration_id=%s LIMIT 1", $old_registration_id), ARRAY_A);
-        return $old_att_for_primary_reg;
-    }
+	/**
+	 * If MER is active, if you want ot fin dthe other registrations on that attendee row
+	 * @global type $wpdb
+	 * @param type $old_registration_id
+	 * @return array
+	 */
+	private function _find_mer_primary_attendee_using_mer_tables($old_registration_id)
+	{
+		if (! $this->_mer_tables_exist()) {
+			return false;
+		}
+		global $wpdb;
+		$old_att_for_primary_reg = $wpdb->get_row($wpdb->prepare("SELECT * FROM {$this->_old_mer_table} AS mer INNER JOIN {$this->_old_table} AS att ON mer.primary_registration_id = att.registration_id WHERE mer.registration_id=%s LIMIT 1", $old_registration_id), ARRAY_A);
+		return $old_att_for_primary_reg;
+	}
 }

Spacing +105 added lines, -105 removed lines

@@ -213,7 +213,7 @@ 
         $this->select_expression = 'att.*, e.event_status';
         // Only select attendees for events that aren't deleted.
         $this->_extra_where_sql = 'AS att
-            INNER JOIN ' . $wpdb->prefix . 'events_detail AS e ON att.event_id=e.id
+            INNER JOIN ' . $wpdb->prefix.'events_detail AS e ON att.event_id=e.id
             WHERE e.event_status!="D"';
         $this->_old_mer_table = $wpdb->prefix."events_multi_event_registration_id_group";
         $this->_new_attendee_cpt_table = $wpdb->posts;
@@ -235,9 +235,9 @@ 
     {
         // first check if there's already a new attendee with similar characteristics
         $new_att_id = $this->_find_attendee_cpt_matching($old_row);
-        if (! $new_att_id) {
+        if ( ! $new_att_id) {
             $new_att_id = $this->_insert_new_attendee_cpt($old_row);
-            if (! $new_att_id) {
+            if ( ! $new_att_id) {
                 // if we couldnt even make an attendee, abandon all hope
                 return false;
             }
@@ -249,7 +249,7 @@ 
         $this->get_migration_script()->set_mapping($this->_old_table, $old_row['id'], $this->_new_attendee_cpt_table, $new_att_id);
 
         $txn_id = $this->_insert_new_transaction($old_row);
-        if (! $txn_id) {
+        if ( ! $txn_id) {
             // if we couldnt make the transaction, also abandon all hope
             return false;
         }
@@ -283,31 +283,31 @@ 
     {
         global $wpdb;
         $cols_n_values = array(
-            'post_title'=>stripslashes($old_attendee['fname']." ".$old_attendee['lname']),// ATT_full_name
-            'post_content'=>'',// ATT_bio
-            'post_name'=>sanitize_title($old_attendee['fname']."-".$old_attendee['lname']),// ATT_slug
-            'post_date'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),// ATT_created
-            'post_excerpt'=>'',// ATT_short_bio
-            'post_modified'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),// ATT_modified
-            'post_author'=>0,// ATT_author
-            'post_parent'=>0,// ATT_parent
-            'post_type'=>'espresso_attendees',// post_type
+            'post_title'=>stripslashes($old_attendee['fname']." ".$old_attendee['lname']), // ATT_full_name
+            'post_content'=>'', // ATT_bio
+            'post_name'=>sanitize_title($old_attendee['fname']."-".$old_attendee['lname']), // ATT_slug
+            'post_date'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']), // ATT_created
+            'post_excerpt'=>'', // ATT_short_bio
+            'post_modified'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']), // ATT_modified
+            'post_author'=>0, // ATT_author
+            'post_parent'=>0, // ATT_parent
+            'post_type'=>'espresso_attendees', // post_type
             'post_status'=>'publish'// status
         );
         $datatypes = array(
-            '%s',// ATT_full_name
-            '%s',// ATT_bio
-            '%s',// ATT_slug
-            '%s',// ATT_created
-            '%s',// ATT_short_bio
-            '%s',// ATT_modified
-            '%d',// ATT_author
-            '%d',// ATT_parent
-            '%s',// post_type
-            '%s',// status
+            '%s', // ATT_full_name
+            '%s', // ATT_bio
+            '%s', // ATT_slug
+            '%s', // ATT_created
+            '%s', // ATT_short_bio
+            '%s', // ATT_modified
+            '%d', // ATT_author
+            '%d', // ATT_parent
+            '%s', // post_type
+            '%s', // status
         );
         $success = $wpdb->insert($this->_new_attendee_cpt_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_cpt_table, $cols_n_values, $datatypes));
             return 0;
         }
@@ -345,20 +345,20 @@ 
             'ATT_phone'=>stripslashes($old_attendee['phone']),
         );
         $datatypes = array(
-            '%d',// ATT_ID
-            '%s',// ATT_fname
-            '%s',// ATT_lname
-            '%s',// ATT_address
-            '%s',// ATT_address2
-            '%s',// ATT_city
-            '%d',// STA_ID
-            '%s',// CNT_ISO
-            '%s',// ATT_zip
-            '%s',// ATT_email
-            '%s',// ATT_phone
+            '%d', // ATT_ID
+            '%s', // ATT_fname
+            '%s', // ATT_lname
+            '%s', // ATT_address
+            '%s', // ATT_address2
+            '%s', // ATT_city
+            '%d', // STA_ID
+            '%s', // CNT_ISO
+            '%s', // ATT_zip
+            '%s', // ATT_email
+            '%s', // ATT_phone
         );
         $success = $wpdb->insert($this->_new_attendee_meta_table, $cols_n_values, $datatypes);
-        if (! $success) {
+        if ( ! $success) {
             $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_meta_table, $cols_n_values, $datatypes));
             return 0;
         }
@@ -383,12 +383,12 @@ 
             $txn_id = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, intval($old_attendee['id']), $this->_new_transaction_table);
         } else { // non-primary attendee, so find its primary attendee's transaction
             $primary_attendee_old_id = $wpdb->get_var($wpdb->prepare("SELECT id FROM ".$this->_old_table." WHERE is_primary=1 and registration_id=%s", $old_attendee['registration_id']));
-            if (! $primary_attendee_old_id) {
+            if ( ! $primary_attendee_old_id) {
                 $primary_attendee = $this->_find_mer_primary_attendee_using_mer_tables($old_attendee['registration_id']);
                 $primary_attendee_old_id = is_array($primary_attendee) ? $primary_attendee['id'] : null;
             }
             $txn_id = $this->get_migration_script()->get_mapping_new_pk($this->_old_table, intval($primary_attendee_old_id), $this->_new_transaction_table);
-            if (! $txn_id) {
+            if ( ! $txn_id) {
                 $this->add_error(sprintf(__("Could not find primary attendee's new transaction. Current attendee is: %s, we think the 3.1 primary attendee for it has id %d, but there's no 4.1 transaction for that primary attendee id.", "event_espresso"), $this->_json_encode($old_attendee), $primary_attendee_old_id));
                 $txn_id = 0;
             }
@@ -396,7 +396,7 @@ 
         // if there isn't yet a transaction row for this, create one
         // (so even if it was a non-primary attendee with no EE3 primary attendee,
         // it ought to have SOME transaction, so we'll make one)
-        if (! $txn_id) {
+        if ( ! $txn_id) {
             // maps 3.1 payment stati onto 4.1 transaction stati
             $txn_status_mapping = array(
                 'Completed'=>'TCM',
@@ -407,7 +407,7 @@ 
                 'Cancelled'=>'TIN',
                 'Declined'=>'TIN'
             );
-            $STS_ID = isset($txn_status_mapping[ $old_attendee['payment_status'] ]) ? $txn_status_mapping[ $old_attendee['payment_status'] ] : 'TIN';
+            $STS_ID = isset($txn_status_mapping[$old_attendee['payment_status']]) ? $txn_status_mapping[$old_attendee['payment_status']] : 'TIN';
             $cols_n_values = array(
                 'TXN_timestamp'=>$this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, $old_attendee['date']),
                 'TXN_total'=>floatval($old_attendee['total_cost']),
@@ -416,14 +416,14 @@ 
                 'TXN_hash_salt'=>$old_attendee['hashSalt']
             );
             $datatypes = array(
-                '%s',// TXN_timestamp
-                '%f',// TXN_total
-                '%f',// TXN_paid
-                '%s',// STS_ID
-                '%s',// TXN_hash_salt
+                '%s', // TXN_timestamp
+                '%f', // TXN_total
+                '%f', // TXN_paid
+                '%s', // STS_ID
+                '%s', // TXN_hash_salt
             );
             $success = $wpdb->insert($this->_new_transaction_table, $cols_n_values, $datatypes);
-            if (! $success) {
+            if ( ! $success) {
                 $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_transaction_table, $cols_n_values, $datatypes));
                 return 0;
             }
@@ -483,12 +483,12 @@ 
 
         $STS_ID = $this->_get_reg_status_for_old_payment_status($old_attendee);
         $new_event_id = $this->get_migration_script()->get_mapping_new_pk($wpdb->prefix.'events_detail', $old_attendee['event_id'], $wpdb->posts);
-        if (! $new_event_id) {
+        if ( ! $new_event_id) {
             $this->add_error(sprintf(__("Could not find NEW event CPT ID for old event '%d' on old attendee %s", "event_espresso"), $old_attendee['event_id'], $this->_json_encode($old_attendee)));
         }
 
         $ticket_id = $this->_try_to_find_new_ticket_id($old_attendee, $new_event_id);
-        if (! $ticket_id) {
+        if ( ! $ticket_id) {
             $ticket_id = $this->_insert_new_ticket_because_none_found($old_attendee, $new_event_id);
             $this->add_error(sprintf(__('Could not find a ticket for old attendee with id %d for new event %d, so created a new ticket with id %d', 'event_espresso'), $old_attendee['id'], $new_event_id, $ticket_id));
         }
@@ -519,23 +519,23 @@ 
                 'REG_deleted'=>false
             );
             $datatypes = array(
-                '%d',// EVT_ID
-                '%d',// ATT_ID
-                '%d',// TXN_ID
-                '%d',// TKT_ID
-                '%s',// STS_ID
-                '%s',// REG_date
-                '%f',// REG_final_price
-                '%s',// REG_session
-                '%s',// REG_code
-                '%s',// REG_url_link
-                '%d',// REG_count
-                '%d',// REG_group_size
-                '%d',// REG_att_is_going
-                '%d',// REG_deleted
+                '%d', // EVT_ID
+                '%d', // ATT_ID
+                '%d', // TXN_ID
+                '%d', // TKT_ID
+                '%s', // STS_ID
+                '%s', // REG_date
+                '%f', // REG_final_price
+                '%s', // REG_session
+                '%s', // REG_code
+                '%s', // REG_url_link
+                '%d', // REG_count
+                '%d', // REG_group_size
+                '%d', // REG_att_is_going
+                '%d', // REG_deleted
             );
             $success = $wpdb->insert($this->_new_reg_table, $cols_n_values, $datatypes);
-            if (! $success) {
+            if ( ! $success) {
                 $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_reg_table, $cols_n_values, $datatypes));
                 return 0;
             }
@@ -567,11 +567,11 @@ 
         $success = $wpdb->query($wpdb->prepare("UPDATE {$this->_new_ticket_table} SET TKT_sold=TKT_sold+%d WHERE TKT_ID=%d", $quantity_sold, $new_ticket_id));
         if ($success) {
             // get the ticket's datetimes, and increment them too
-            $success_update_dateimtes =  $wpdb->query($wpdb->prepare("UPDATE {$this->_new_ticket_table} TKT
+            $success_update_dateimtes = $wpdb->query($wpdb->prepare("UPDATE {$this->_new_ticket_table} TKT
 				INNER JOIN {$this->_new_ticket_datetime_table} as DTK ON TKT.TKT_ID = DTK.TKT_ID
 				INNER JOIN {$this->_new_datetime_table} as DTT ON DTK.DTT_ID = DTT.DTT_ID
 				SET DTT.DTT_sold = DTT.DTT_sold + %d WHERE TKT.TKT_ID = %d", $quantity_sold, $new_ticket_id));
-            if (! $success_update_dateimtes) {
+            if ( ! $success_update_dateimtes) {
                 $this->add_error(sprintf(__("Could not update datetimes related to ticket with ID %d's TKT_sold by %d because %s", "event_espresso"), $new_ticket_id, $quantity_sold, $wpdb->last_error));
             }
         } else {
@@ -603,10 +603,10 @@ 
         // add all conditions to an array from which we can SHIFT conditions off in order to widen our search
         // the most important condition should be last, as it will be array_shift'ed off last
         $conditions = array(
-            $wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime),// times match?
-            $wpdb->prepare("$tickets_table.TKT_price = %f", $old_att_price),// prices match?
-            $wpdb->prepare("$tickets_table.TKT_name = %s", $old_att_price_option),// names match?
-            $wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id),// events match?
+            $wpdb->prepare("$datetime_table.DTT_EVT_start = %s", $old_att_datetime), // times match?
+            $wpdb->prepare("$tickets_table.TKT_price = %f", $old_att_price), // prices match?
+            $wpdb->prepare("$tickets_table.TKT_name = %s", $old_att_price_option), // names match?
+            $wpdb->prepare("$datetime_table.EVT_ID = %d", $new_event_id), // events match?
         );
         $select_and_join_part = "SELECT $tickets_table.TKT_ID FROM $tickets_table INNER JOIN
 			$datetime_tickets_table ON $tickets_table.TKT_ID = $datetime_tickets_table.TKT_ID INNER JOIN
@@ -616,7 +616,7 @@ 
             $full_query = $select_and_join_part." WHERE ".implode(" AND ", $conditions)." LIMIT 1";
             $ticket_id_found = $wpdb->get_var($full_query);
             array_shift($conditions);
-        } while (! $ticket_id_found && $conditions);
+        }while ( ! $ticket_id_found && $conditions);
         return $ticket_id_found;
     }
 
@@ -638,8 +638,8 @@ 
 
 
         // insert new datetime unless we find one
-        $datetime_id = $wpdb->get_var($wpdb->prepare("SELECT DTT_ID FROM " . $this->_new_datetime_table . " WHERE DTT_EVT_start=%s AND EVT_ID=%d LIMIT 1", $old_att_start_datetime, $new_event_id), ARRAY_A);
-        if (! $datetime_id) {
+        $datetime_id = $wpdb->get_var($wpdb->prepare("SELECT DTT_ID FROM ".$this->_new_datetime_table." WHERE DTT_EVT_start=%s AND EVT_ID=%d LIMIT 1", $old_att_start_datetime, $new_event_id), ARRAY_A);
+        if ( ! $datetime_id) {
             $old_att_end_date = $old_attendee['start_date'];
             $old_att_end_time = $this->get_migration_script()->convertTimeFromAMPM($old_attendee['event_time']);
             $old_att_end_datetime = $this->get_migration_script()->convert_date_string_to_utc($this, $old_attendee, "$old_att_end_date $old_att_end_time:00");
@@ -652,10 +652,10 @@ 
                         'DTT_deleted' => true
                     ),
                 array(
-                        '%d',// EVT_ID
-                        '%s',// DTT_EVT_start
-                        '%s',// DTT_EVT_end
-                        '%d',// DTT_deleted
+                        '%d', // EVT_ID
+                        '%s', // DTT_EVT_start
+                        '%s', // DTT_EVT_end
+                        '%d', // DTT_deleted
                     )
             );
             $datetime_id = $wpdb->insert_id;
@@ -663,21 +663,21 @@ 
 
         // insert new ticket
         $success = $wpdb->insert(
-            $wpdb->prefix . 'esp_ticket',
+            $wpdb->prefix.'esp_ticket',
             array(
                     'TKT_name' => $old_att_price_option,
                     'TKT_qty' => -1,
                     'TKT_price' => $old_att_price,
-                    'TKT_start_date' => $old_att_start_datetime,// we really have no clue what the time should be, but at least it was available when they attended
+                    'TKT_start_date' => $old_att_start_datetime, // we really have no clue what the time should be, but at least it was available when they attended
                     'TKT_end_date' => $old_att_end_datetime,
 
                 ),
             array(
-                    '%s',// name
-                    '%d',// qty
-                    '%d',// price
-                    '%s',// start_date
-                    '%s',// end_date
+                    '%s', // name
+                    '%d', // qty
+                    '%d', // price
+                    '%s', // start_date
+                    '%s', // end_date
                 )
         );
         $ticket_id = $wpdb->insert_id;
@@ -689,8 +689,8 @@ 
                     'TKT_ID' => $ticket_id
                 ),
             array(
-                    '%d',// DTT_ID
-                    '%d',// TKT_ID
+                    '%d', // DTT_ID
+                    '%d', // TKT_ID
                 )
         );
         // insert new price
@@ -703,10 +703,10 @@ 
                     'PRC_deleted' => true
                 ),
             array(
-                    '%d',// PRC_amount
-                    '%d',// PRT_ID
-                    '%s',// PRC_name
-                    '%d',// PRC_deleted
+                    '%d', // PRC_amount
+                    '%d', // PRT_ID
+                    '%s', // PRC_name
+                    '%d', // PRC_deleted
                 )
         );
         $price_id = $wpdb->insert_id;
@@ -718,8 +718,8 @@ 
                     'PRC_ID' => $price_id
                 ),
             array(
-                    '%d',// TKT_ID
-                    '%d',// PRC_ID
+                    '%d', // TKT_ID
+                    '%d', // PRC_ID
                 )
         );
         return $ticket_id;
@@ -756,7 +756,7 @@ 
     {
         global $wpdb;
         // only add a payment for primary attendees
-        $old_pay_stati_indicating_no_payment = array('Pending','Incomplete','Not Completed');
+        $old_pay_stati_indicating_no_payment = array('Pending', 'Incomplete', 'Not Completed');
         // if this is for a primary 3.1 attendee which WASN'T free and has a completed, cancelled, or declined payment...
         if (intval($old_attendee['is_primary']) && floatval($old_attendee['total_cost']) && ! in_array($old_attendee['payment_status'], $old_pay_stati_indicating_no_payment)) {
             $pay_status_mapping = array(
@@ -766,7 +766,7 @@ 
                 'Declined'=>'PDC'
             );
             $by_admin = $old_attendee['payment'] == 'Admin';
-            $STS_ID = isset($pay_status_mapping[ $old_attendee['payment_status'] ]) ? $pay_status_mapping[ $old_attendee['payment_status'] ] : 'PFL';// IE, if we don't recognize the status, assume payment failed
+            $STS_ID = isset($pay_status_mapping[$old_attendee['payment_status']]) ? $pay_status_mapping[$old_attendee['payment_status']] : 'PFL'; // IE, if we don't recognize the status, assume payment failed
             $cols_n_values = array(
                 'TXN_ID'=>$new_txn_id,
                 'STS_ID'=>$STS_ID,
@@ -781,19 +781,19 @@ 
 
             );
             $datatypes = array(
-                '%d',// TXN_Id
-                '%s',// STS_ID
-                '%s',// PAY_timestamp
-                '%s',// PAY_method
-                '%f',// PAY_amount
-                '%s',// PAY_gateway
-                '%s',// PAY_gateway_response
-                '%s',// PAY_txn_id_chq_nmbr
-                '%d',// PAY_via_admin
-                '%s',// PAY_details
+                '%d', // TXN_Id
+                '%s', // STS_ID
+                '%s', // PAY_timestamp
+                '%s', // PAY_method
+                '%f', // PAY_amount
+                '%s', // PAY_gateway
+                '%s', // PAY_gateway_response
+                '%s', // PAY_txn_id_chq_nmbr
+                '%d', // PAY_via_admin
+                '%s', // PAY_details
             );
             $success = $wpdb->insert($this->_new_payment_table, $cols_n_values, $datatypes);
-            if (! $success) {
+            if ( ! $success) {
                 $this->add_error($this->get_migration_script()->_create_error_message_for_db_insertion($this->_old_table, $old_attendee, $this->_new_attendee_cpt_table, $cols_n_values, $datatypes));
                 return 0;
             }
@@ -812,7 +812,7 @@ 
      */
     private function _find_mer_primary_attendee_using_mer_tables($old_registration_id)
     {
-        if (! $this->_mer_tables_exist()) {
+        if ( ! $this->_mer_tables_exist()) {
             return false;
         }
         global $wpdb;