eventespresso / event-espresso-core

modules/batch/EED_Batch.module.php

Indentation +310 added lines, -310 removed lines

@@ -23,336 +23,336 @@
 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;
 
-    /**
-     * 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'));
+	}
 
-    /**
-     * 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 = new 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 = new 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 = new 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 = new 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 = new 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 = new 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)
+	{
+	}
 }

caffeinated/modules/recaptcha_invisible/EED_Recaptcha_Invisible.module.php

Indentation +328 added lines, -328 removed lines

@@ -18,332 +18,332 @@
 class EED_Recaptcha_Invisible extends EED_Module
 {
 
-    /**
-     * @var EE_Registration_Config $config
-     */
-    private static $config;
-
-
-    /**
-     * @return EED_Module|EED_Recaptcha
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public static function set_hooks()
-    {
-        EED_Recaptcha_Invisible::setProperties();
-        if (EED_Recaptcha_Invisible::useInvisibleRecaptcha()) {
-            if (EED_Recaptcha_Invisible::protectForm('ticket_selector')) {
-                // ticket selection
-                add_filter(
-                    'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
-                    array('EED_Recaptcha_Invisible', 'ticketSelectorForm'),
-                    10,
-                    3
-                );
-                add_action(
-                    'EED_Ticket_Selector__process_ticket_selections__before',
-                    array('EED_Recaptcha_Invisible', 'processTicketSelectorForm')
-                );
-            }
-            if (EED_Recaptcha_Invisible::protectForm('registration_form')) {
-                // checkout
-                add_action(
-                    'AHEE__EE_SPCO_Reg_Step__display_reg_form__reg_form',
-                    array('EED_Recaptcha_Invisible', 'spcoRegStepForm')
-                );
-                add_filter(
-                    'FHEE__EE_Form_Section_Proper__receive_form_submission__req_data',
-                    array('EED_Recaptcha_Invisible', 'receiveSpcoRegStepForm'),
-                    10,
-                    2
-                );
-            }
-            add_action('loop_end', array('EED_Recaptcha_Invisible', 'localizeScriptVars'));
-        }
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public static function set_hooks_admin()
-    {
-        EED_Recaptcha_Invisible::setProperties();
-        if (EED_Recaptcha_Invisible::protectForm('ticket_selector')) {
-            add_action(
-                'EED_Ticket_Selector__process_ticket_selections__before',
-                array('EED_Recaptcha_Invisible', 'processTicketSelectorForm')
-            );
-        }
-        if (EED_Recaptcha_Invisible::protectForm('registration_form')) {
-            add_filter(
-                'FHEE__EE_Form_Section_Proper__receive_form_submission__req_data',
-                array('EED_Recaptcha_Invisible', 'receiveSpcoRegStepForm'),
-                10,
-                2
-            );
-        }
-        // admin settings
-        add_action(
-            'AHEE__Extend_Registration_Form_Admin_Page___reg_form_settings_template',
-            array('EED_Recaptcha_Invisible', 'adminSettings')
-        );
-        add_filter(
-            'FHEE__Extend_Registration_Form_Admin_Page___update_reg_form_settings__CFG_registration',
-            array('EED_Recaptcha_Invisible', 'updateAdminSettings')
-        );
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public static function setProperties()
-    {
-
-        EED_Recaptcha_Invisible::$config = EE_Registry::instance()->CFG->registration;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public static function useInvisibleRecaptcha()
-    {
-        return EED_Recaptcha_Invisible::$config->use_captcha
-               && EED_Recaptcha_Invisible::$config->recaptcha_theme === 'invisible';
-    }
-
-
-    /**
-     * @param string $form
-     * @return boolean
-     */
-    public static function protectForm($form)
-    {
-        return is_array(EED_Recaptcha_Invisible::$config->recaptcha_protected_forms)
-               && in_array($form, EED_Recaptcha_Invisible::$config->recaptcha_protected_forms, true);
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public static function localizeScriptVars()
-    {
-        /** @var \EventEspresso\core\services\request\Request $request */
-        $request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\Request');
-        // Invisible Recaptcha is ONLY ever required for the frontend and admin
-        // so we don't need to load any JS assets for other types of requests (like AJAX or API).
-        if (! ($request->isAdmin() || $request->isFrontend())) {
-            return;
-        }
-        wp_localize_script(
-            EE_Invisible_Recaptcha_Input::SCRIPT_HANDLE_ESPRESSO_INVISIBLE_RECAPTCHA,
-            'eeRecaptcha',
-            RecaptchaFactory::create()->getLocalizedVars()
-        );
-    }
-
-
-    /**
-     * @return string
-     */
-    public static function assetsUrl()
-    {
-        return plugin_dir_url(__FILE__) . 'assets' . DS;
-    }
-
-
-    /**
-     * @param \WP $WP
-     */
-    public function run($WP)
-    {
-    }
-
-
-    /**
-     * @param RequestInterface $request
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     */
-    public static function verifyToken(RequestInterface $request)
-    {
-        return RecaptchaFactory::create()->verifyToken($request);
-    }
-
-
-    /**
-     * @param EE_Form_Section_Proper $reg_form
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws DomainException
-     */
-    public static function spcoRegStepForm(EE_Form_Section_Proper $reg_form)
-    {
-        // do nothing if form isn't for a reg step or test has already been passed
-        if (! EED_Recaptcha_Invisible::processSpcoRegStepForm($reg_form)) {
-            return;
-        }
-        $default_hidden_inputs = $reg_form->get_subsection('default_hidden_inputs');
-        if ($default_hidden_inputs instanceof EE_Form_Section_Proper) {
-            $invisible_recaptcha = RecaptchaFactory::create();
-            $invisible_recaptcha->addToFormSection($default_hidden_inputs);
-        }
-    }
-
-
-    /**
-     * @param EE_Form_Section_Proper $reg_form
-     * @return bool
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public static function processSpcoRegStepForm(EE_Form_Section_Proper $reg_form)
-    {
-        return strpos($reg_form->name(), 'reg-step-form') !== false
-               && ! RecaptchaFactory::create()->recaptchaPassed();
-    }
-
-
-    /**
-     * @param array|null             $req_data
-     * @param EE_Form_Section_Proper $reg_form
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     */
-    public static function receiveSpcoRegStepForm($req_data = array(), EE_Form_Section_Proper $reg_form)
-    {
-        // do nothing if form isn't for a reg step or test has already been passed
-        if (! EED_Recaptcha_Invisible::processSpcoRegStepForm($reg_form)) {
-            return $req_data;
-        }
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
-        if (! EED_Recaptcha_Invisible::verifyToken($request)) {
-            if ($request->isAjax()) {
-                $json_response = new EE_SPCO_JSON_Response();
-                $json_response->echoAndExit();
-            }
-            EEH_URL::safeRedirectAndExit(
-                EE_Registry::instance()->CFG->core->reg_page_url()
-            );
-        }
-        return $req_data;
-    }
-
-
-    /**
-     * @param string   $html
-     * @param EE_Event $event
-     * @param bool     $iframe
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws DomainException
-     */
-    public static function ticketSelectorForm($html = '', EE_Event $event, $iframe = false)
-    {
-        $recaptcha = RecaptchaFactory::create();
-        // do nothing if test has  already  been passed
-        if ($recaptcha->recaptchaPassed()) {
-            return $html;
-        }
-        $html .= $recaptcha->getInputHtml(
-            array(
-                'recaptcha_id'   => $event->ID(),
-                'iframe'         => $iframe,
-                'localized_vars' => $recaptcha->getLocalizedVars(),
-            )
-        );
-        return $html;
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws RuntimeException
-     */
-    public static function processTicketSelectorForm()
-    {
-        // do nothing if test has  already  been passed
-        if (RecaptchaFactory::create()->recaptchaPassed()) {
-            return;
-        }
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
-        if (! EED_Recaptcha_Invisible::verifyToken($request)) {
-            $event_id = $request->getRequestParam('tkt-slctr-event-id');
-            $return_url = $request->requestParamIsSet("tkt-slctr-return-url-{$event_id}")
-                ? $request->getRequestParam("tkt-slctr-return-url-{$event_id}")
-                : get_permalink($event_id);
-            EEH_URL::safeRedirectAndExit($return_url);
-        }
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function adminSettings()
-    {
-        RecaptchaFactory::getAdminModule()->adminSettings();
-    }
-
-
-    /**
-     * @param EE_Registration_Config $EE_Registration_Config
-     * @return EE_Registration_Config
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function updateAdminSettings(EE_Registration_Config $EE_Registration_Config)
-    {
-        return RecaptchaFactory::getAdminModule()->updateAdminSettings($EE_Registration_Config);
-    }
+	/**
+	 * @var EE_Registration_Config $config
+	 */
+	private static $config;
+
+
+	/**
+	 * @return EED_Module|EED_Recaptcha
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public static function set_hooks()
+	{
+		EED_Recaptcha_Invisible::setProperties();
+		if (EED_Recaptcha_Invisible::useInvisibleRecaptcha()) {
+			if (EED_Recaptcha_Invisible::protectForm('ticket_selector')) {
+				// ticket selection
+				add_filter(
+					'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
+					array('EED_Recaptcha_Invisible', 'ticketSelectorForm'),
+					10,
+					3
+				);
+				add_action(
+					'EED_Ticket_Selector__process_ticket_selections__before',
+					array('EED_Recaptcha_Invisible', 'processTicketSelectorForm')
+				);
+			}
+			if (EED_Recaptcha_Invisible::protectForm('registration_form')) {
+				// checkout
+				add_action(
+					'AHEE__EE_SPCO_Reg_Step__display_reg_form__reg_form',
+					array('EED_Recaptcha_Invisible', 'spcoRegStepForm')
+				);
+				add_filter(
+					'FHEE__EE_Form_Section_Proper__receive_form_submission__req_data',
+					array('EED_Recaptcha_Invisible', 'receiveSpcoRegStepForm'),
+					10,
+					2
+				);
+			}
+			add_action('loop_end', array('EED_Recaptcha_Invisible', 'localizeScriptVars'));
+		}
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public static function set_hooks_admin()
+	{
+		EED_Recaptcha_Invisible::setProperties();
+		if (EED_Recaptcha_Invisible::protectForm('ticket_selector')) {
+			add_action(
+				'EED_Ticket_Selector__process_ticket_selections__before',
+				array('EED_Recaptcha_Invisible', 'processTicketSelectorForm')
+			);
+		}
+		if (EED_Recaptcha_Invisible::protectForm('registration_form')) {
+			add_filter(
+				'FHEE__EE_Form_Section_Proper__receive_form_submission__req_data',
+				array('EED_Recaptcha_Invisible', 'receiveSpcoRegStepForm'),
+				10,
+				2
+			);
+		}
+		// admin settings
+		add_action(
+			'AHEE__Extend_Registration_Form_Admin_Page___reg_form_settings_template',
+			array('EED_Recaptcha_Invisible', 'adminSettings')
+		);
+		add_filter(
+			'FHEE__Extend_Registration_Form_Admin_Page___update_reg_form_settings__CFG_registration',
+			array('EED_Recaptcha_Invisible', 'updateAdminSettings')
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public static function setProperties()
+	{
+
+		EED_Recaptcha_Invisible::$config = EE_Registry::instance()->CFG->registration;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public static function useInvisibleRecaptcha()
+	{
+		return EED_Recaptcha_Invisible::$config->use_captcha
+			   && EED_Recaptcha_Invisible::$config->recaptcha_theme === 'invisible';
+	}
+
+
+	/**
+	 * @param string $form
+	 * @return boolean
+	 */
+	public static function protectForm($form)
+	{
+		return is_array(EED_Recaptcha_Invisible::$config->recaptcha_protected_forms)
+			   && in_array($form, EED_Recaptcha_Invisible::$config->recaptcha_protected_forms, true);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public static function localizeScriptVars()
+	{
+		/** @var \EventEspresso\core\services\request\Request $request */
+		$request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\Request');
+		// Invisible Recaptcha is ONLY ever required for the frontend and admin
+		// so we don't need to load any JS assets for other types of requests (like AJAX or API).
+		if (! ($request->isAdmin() || $request->isFrontend())) {
+			return;
+		}
+		wp_localize_script(
+			EE_Invisible_Recaptcha_Input::SCRIPT_HANDLE_ESPRESSO_INVISIBLE_RECAPTCHA,
+			'eeRecaptcha',
+			RecaptchaFactory::create()->getLocalizedVars()
+		);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public static function assetsUrl()
+	{
+		return plugin_dir_url(__FILE__) . 'assets' . DS;
+	}
+
+
+	/**
+	 * @param \WP $WP
+	 */
+	public function run($WP)
+	{
+	}
+
+
+	/**
+	 * @param RequestInterface $request
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 */
+	public static function verifyToken(RequestInterface $request)
+	{
+		return RecaptchaFactory::create()->verifyToken($request);
+	}
+
+
+	/**
+	 * @param EE_Form_Section_Proper $reg_form
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws DomainException
+	 */
+	public static function spcoRegStepForm(EE_Form_Section_Proper $reg_form)
+	{
+		// do nothing if form isn't for a reg step or test has already been passed
+		if (! EED_Recaptcha_Invisible::processSpcoRegStepForm($reg_form)) {
+			return;
+		}
+		$default_hidden_inputs = $reg_form->get_subsection('default_hidden_inputs');
+		if ($default_hidden_inputs instanceof EE_Form_Section_Proper) {
+			$invisible_recaptcha = RecaptchaFactory::create();
+			$invisible_recaptcha->addToFormSection($default_hidden_inputs);
+		}
+	}
+
+
+	/**
+	 * @param EE_Form_Section_Proper $reg_form
+	 * @return bool
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public static function processSpcoRegStepForm(EE_Form_Section_Proper $reg_form)
+	{
+		return strpos($reg_form->name(), 'reg-step-form') !== false
+			   && ! RecaptchaFactory::create()->recaptchaPassed();
+	}
+
+
+	/**
+	 * @param array|null             $req_data
+	 * @param EE_Form_Section_Proper $reg_form
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 */
+	public static function receiveSpcoRegStepForm($req_data = array(), EE_Form_Section_Proper $reg_form)
+	{
+		// do nothing if form isn't for a reg step or test has already been passed
+		if (! EED_Recaptcha_Invisible::processSpcoRegStepForm($reg_form)) {
+			return $req_data;
+		}
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
+		if (! EED_Recaptcha_Invisible::verifyToken($request)) {
+			if ($request->isAjax()) {
+				$json_response = new EE_SPCO_JSON_Response();
+				$json_response->echoAndExit();
+			}
+			EEH_URL::safeRedirectAndExit(
+				EE_Registry::instance()->CFG->core->reg_page_url()
+			);
+		}
+		return $req_data;
+	}
+
+
+	/**
+	 * @param string   $html
+	 * @param EE_Event $event
+	 * @param bool     $iframe
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws DomainException
+	 */
+	public static function ticketSelectorForm($html = '', EE_Event $event, $iframe = false)
+	{
+		$recaptcha = RecaptchaFactory::create();
+		// do nothing if test has  already  been passed
+		if ($recaptcha->recaptchaPassed()) {
+			return $html;
+		}
+		$html .= $recaptcha->getInputHtml(
+			array(
+				'recaptcha_id'   => $event->ID(),
+				'iframe'         => $iframe,
+				'localized_vars' => $recaptcha->getLocalizedVars(),
+			)
+		);
+		return $html;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws RuntimeException
+	 */
+	public static function processTicketSelectorForm()
+	{
+		// do nothing if test has  already  been passed
+		if (RecaptchaFactory::create()->recaptchaPassed()) {
+			return;
+		}
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
+		if (! EED_Recaptcha_Invisible::verifyToken($request)) {
+			$event_id = $request->getRequestParam('tkt-slctr-event-id');
+			$return_url = $request->requestParamIsSet("tkt-slctr-return-url-{$event_id}")
+				? $request->getRequestParam("tkt-slctr-return-url-{$event_id}")
+				: get_permalink($event_id);
+			EEH_URL::safeRedirectAndExit($return_url);
+		}
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function adminSettings()
+	{
+		RecaptchaFactory::getAdminModule()->adminSettings();
+	}
+
+
+	/**
+	 * @param EE_Registration_Config $EE_Registration_Config
+	 * @return EE_Registration_Config
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function updateAdminSettings(EE_Registration_Config $EE_Registration_Config)
+	{
+		return RecaptchaFactory::getAdminModule()->updateAdminSettings($EE_Registration_Config);
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -155,7 +155,7 @@ 
         $request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\Request');
         // Invisible Recaptcha is ONLY ever required for the frontend and admin
         // so we don't need to load any JS assets for other types of requests (like AJAX or API).
-        if (! ($request->isAdmin() || $request->isFrontend())) {
+        if ( ! ($request->isAdmin() || $request->isFrontend())) {
             return;
         }
         wp_localize_script(
@@ -171,7 +171,7 @@ 
      */
     public static function assetsUrl()
     {
-        return plugin_dir_url(__FILE__) . 'assets' . DS;
+        return plugin_dir_url(__FILE__).'assets'.DS;
     }
 
 
@@ -209,7 +209,7 @@ 
     public static function spcoRegStepForm(EE_Form_Section_Proper $reg_form)
     {
         // do nothing if form isn't for a reg step or test has already been passed
-        if (! EED_Recaptcha_Invisible::processSpcoRegStepForm($reg_form)) {
+        if ( ! EED_Recaptcha_Invisible::processSpcoRegStepForm($reg_form)) {
             return;
         }
         $default_hidden_inputs = $reg_form->get_subsection('default_hidden_inputs');
@@ -248,12 +248,12 @@ 
     public static function receiveSpcoRegStepForm($req_data = array(), EE_Form_Section_Proper $reg_form)
     {
         // do nothing if form isn't for a reg step or test has already been passed
-        if (! EED_Recaptcha_Invisible::processSpcoRegStepForm($reg_form)) {
+        if ( ! EED_Recaptcha_Invisible::processSpcoRegStepForm($reg_form)) {
             return $req_data;
         }
         /** @var RequestInterface $request */
         $request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
-        if (! EED_Recaptcha_Invisible::verifyToken($request)) {
+        if ( ! EED_Recaptcha_Invisible::verifyToken($request)) {
             if ($request->isAjax()) {
                 $json_response = new EE_SPCO_JSON_Response();
                 $json_response->echoAndExit();
@@ -311,7 +311,7 @@ 
         }
         /** @var RequestInterface $request */
         $request = LoaderFactory::getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
-        if (! EED_Recaptcha_Invisible::verifyToken($request)) {
+        if ( ! EED_Recaptcha_Invisible::verifyToken($request)) {
             $event_id = $request->getRequestParam('tkt-slctr-event-id');
             $return_url = $request->requestParamIsSet("tkt-slctr-return-url-{$event_id}")
                 ? $request->getRequestParam("tkt-slctr-return-url-{$event_id}")

caffeinated/modules/recaptcha_invisible/InvisibleRecaptcha.php

Indentation +228 added lines, -228 removed lines

@@ -27,258 +27,258 @@
 class InvisibleRecaptcha
 {
 
-    const URL_GOOGLE_RECAPTCHA_API          = 'https://www.google.com/recaptcha/api/siteverify';
+	const URL_GOOGLE_RECAPTCHA_API          = 'https://www.google.com/recaptcha/api/siteverify';
 
-    const SESSION_DATA_KEY_RECAPTCHA_PASSED = 'recaptcha_passed';
+	const SESSION_DATA_KEY_RECAPTCHA_PASSED = 'recaptcha_passed';
 
-    /**
-     * @var EE_Registration_Config $config
-     */
-    private $config;
+	/**
+	 * @var EE_Registration_Config $config
+	 */
+	private $config;
 
-    /**
-     * @var EE_Session $session
-     */
-    private $session;
+	/**
+	 * @var EE_Session $session
+	 */
+	private $session;
 
-    /**
-     * @var boolean $recaptcha_passed
-     */
-    private $recaptcha_passed;
+	/**
+	 * @var boolean $recaptcha_passed
+	 */
+	private $recaptcha_passed;
 
 
-    /**
-     * InvisibleRecaptcha constructor.
-     *
-     * @param EE_Registration_Config $registration_config
-     * @param EE_Session             $session
-     */
-    public function __construct(EE_Registration_Config $registration_config, EE_Session $session)
-    {
-        $this->config = $registration_config;
-        $this->session = $session;
-    }
+	/**
+	 * InvisibleRecaptcha constructor.
+	 *
+	 * @param EE_Registration_Config $registration_config
+	 * @param EE_Session             $session
+	 */
+	public function __construct(EE_Registration_Config $registration_config, EE_Session $session)
+	{
+		$this->config = $registration_config;
+		$this->session = $session;
+	}
 
 
-    /**
-     * @return boolean
-     */
-    public function useInvisibleRecaptcha()
-    {
-        return $this->config->use_captcha && $this->config->recaptcha_theme === 'invisible';
-    }
+	/**
+	 * @return boolean
+	 */
+	public function useInvisibleRecaptcha()
+	{
+		return $this->config->use_captcha && $this->config->recaptcha_theme === 'invisible';
+	}
 
 
-    /**
-     * @param array $input_settings
-     * @return EE_Invisible_Recaptcha_Input
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws DomainException
-     */
-    public function getInput(array $input_settings = array())
-    {
-        return new EE_Invisible_Recaptcha_Input(
-            $input_settings,
-            $this->config
-        );
-    }
+	/**
+	 * @param array $input_settings
+	 * @return EE_Invisible_Recaptcha_Input
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws DomainException
+	 */
+	public function getInput(array $input_settings = array())
+	{
+		return new EE_Invisible_Recaptcha_Input(
+			$input_settings,
+			$this->config
+		);
+	}
 
 
-    /**
-     * @param array $input_settings
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws DomainException
-     */
-    public function getInputHtml(array $input_settings = array())
-    {
-        return $this->getInput($input_settings)->get_html_for_input();
-    }
+	/**
+	 * @param array $input_settings
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws DomainException
+	 */
+	public function getInputHtml(array $input_settings = array())
+	{
+		return $this->getInput($input_settings)->get_html_for_input();
+	}
 
 
-    /**
-     * @param EE_Form_Section_Proper $form
-     * @param array                  $input_settings
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws DomainException
-     */
-    public function addToFormSection(EE_Form_Section_Proper $form, array $input_settings = array())
-    {
-        $form->add_subsections(
-            array(
-                'espresso_recaptcha' => $this->getInput($input_settings),
-            ),
-            null,
-            false
-        );
-    }
+	/**
+	 * @param EE_Form_Section_Proper $form
+	 * @param array                  $input_settings
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws DomainException
+	 */
+	public function addToFormSection(EE_Form_Section_Proper $form, array $input_settings = array())
+	{
+		$form->add_subsections(
+			array(
+				'espresso_recaptcha' => $this->getInput($input_settings),
+			),
+			null,
+			false
+		);
+	}
 
 
-    /**
-     * @param RequestInterface $request
-     * @return boolean
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RuntimeException
-     */
-    public function verifyToken(RequestInterface $request)
-    {
-        static $previous_recaptcha_response = array();
-        $grecaptcha_response = $request->getRequestParam('g-recaptcha-response');
-        if ($grecaptcha_response === null) {
-            $this->generateError(
-                sprintf(
-                    esc_html__(
-                        'The "%1$s" parameter is missing.',
-                        'event_espresso'
-                    ),
-                    'g-recaptcha-response'
-                ),
-                true
-            );
-            return false;
-        }
-        // if this token has already been verified, then return previous response
-        if (isset($previous_recaptcha_response[ $grecaptcha_response ])) {
-            return $previous_recaptcha_response[ $grecaptcha_response ];
-        }
-        // will update to true if everything passes
-        $previous_recaptcha_response[ $grecaptcha_response ] = false;
-        $response                                            = wp_safe_remote_post(
-            InvisibleRecaptcha::URL_GOOGLE_RECAPTCHA_API,
-            array(
-                'body' => array(
-                    'secret'   => $this->config->recaptcha_privatekey,
-                    'response' => $grecaptcha_response,
-                    'remoteip' => $request->ipAddress(),
-                ),
-            )
-        );
-        if ($response instanceof WP_Error) {
-            $this->generateError($response->get_error_messages());
-            return false;
-        }
-        $results = json_decode(wp_remote_retrieve_body($response), true);
-        if (filter_var($results['success'], FILTER_VALIDATE_BOOLEAN) !== true) {
-            $errors   = array_map(
-                array($this, 'getErrorCode'),
-                $results['error-codes']
-            );
-            if (isset($results['challenge_ts'])) {
-                $errors[] = 'challenge timestamp: ' . $results['challenge_ts'] . '.';
-            }
-            $this->generateError(implode(' ', $errors), true);
-        }
-        $previous_recaptcha_response[ $grecaptcha_response ] = true;
-        add_action('shutdown', array($this, 'setSessionData'));
-        return true;
-    }
+	/**
+	 * @param RequestInterface $request
+	 * @return boolean
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RuntimeException
+	 */
+	public function verifyToken(RequestInterface $request)
+	{
+		static $previous_recaptcha_response = array();
+		$grecaptcha_response = $request->getRequestParam('g-recaptcha-response');
+		if ($grecaptcha_response === null) {
+			$this->generateError(
+				sprintf(
+					esc_html__(
+						'The "%1$s" parameter is missing.',
+						'event_espresso'
+					),
+					'g-recaptcha-response'
+				),
+				true
+			);
+			return false;
+		}
+		// if this token has already been verified, then return previous response
+		if (isset($previous_recaptcha_response[ $grecaptcha_response ])) {
+			return $previous_recaptcha_response[ $grecaptcha_response ];
+		}
+		// will update to true if everything passes
+		$previous_recaptcha_response[ $grecaptcha_response ] = false;
+		$response                                            = wp_safe_remote_post(
+			InvisibleRecaptcha::URL_GOOGLE_RECAPTCHA_API,
+			array(
+				'body' => array(
+					'secret'   => $this->config->recaptcha_privatekey,
+					'response' => $grecaptcha_response,
+					'remoteip' => $request->ipAddress(),
+				),
+			)
+		);
+		if ($response instanceof WP_Error) {
+			$this->generateError($response->get_error_messages());
+			return false;
+		}
+		$results = json_decode(wp_remote_retrieve_body($response), true);
+		if (filter_var($results['success'], FILTER_VALIDATE_BOOLEAN) !== true) {
+			$errors   = array_map(
+				array($this, 'getErrorCode'),
+				$results['error-codes']
+			);
+			if (isset($results['challenge_ts'])) {
+				$errors[] = 'challenge timestamp: ' . $results['challenge_ts'] . '.';
+			}
+			$this->generateError(implode(' ', $errors), true);
+		}
+		$previous_recaptcha_response[ $grecaptcha_response ] = true;
+		add_action('shutdown', array($this, 'setSessionData'));
+		return true;
+	}
 
 
-    /**
-     * @param string $error_response
-     * @param bool   $show_errors
-     * @return void
-     * @throws RuntimeException
-     */
-    public function generateError($error_response = '', $show_errors = false)
-    {
-        throw new RuntimeException(
-            sprintf(
-                esc_html__(
-                    'We\'re sorry but an attempt to verify the form\'s reCAPTCHA has failed. %1$s %2$s Please try again.',
-                    'event_espresso'
-                ),
-                '<br />',
-                $show_errors || current_user_can('manage_options') ? $error_response : ''
-            )
-        );
-    }
+	/**
+	 * @param string $error_response
+	 * @param bool   $show_errors
+	 * @return void
+	 * @throws RuntimeException
+	 */
+	public function generateError($error_response = '', $show_errors = false)
+	{
+		throw new RuntimeException(
+			sprintf(
+				esc_html__(
+					'We\'re sorry but an attempt to verify the form\'s reCAPTCHA has failed. %1$s %2$s Please try again.',
+					'event_espresso'
+				),
+				'<br />',
+				$show_errors || current_user_can('manage_options') ? $error_response : ''
+			)
+		);
+	}
 
 
-    /**
-     * @param string $error_code
-     * @return string
-     */
-    public function getErrorCode(&$error_code)
-    {
-        $error_codes = array(
-            'missing-input-secret'   => 'The secret parameter is missing.',
-            'invalid-input-secret'   => 'The secret parameter is invalid or malformed.',
-            'missing-input-response' => 'The response parameter is missing.',
-            'invalid-input-response' => 'The response parameter is invalid or malformed.',
-            'bad-request'            => 'The request is invalid or malformed.',
-            'timeout-or-duplicate'   => 'The request took too long to be sent or was a duplicate of a previous request.',
-        );
-        return isset($error_codes[ $error_code ]) ? $error_codes[ $error_code ] : '';
-    }
+	/**
+	 * @param string $error_code
+	 * @return string
+	 */
+	public function getErrorCode(&$error_code)
+	{
+		$error_codes = array(
+			'missing-input-secret'   => 'The secret parameter is missing.',
+			'invalid-input-secret'   => 'The secret parameter is invalid or malformed.',
+			'missing-input-response' => 'The response parameter is missing.',
+			'invalid-input-response' => 'The response parameter is invalid or malformed.',
+			'bad-request'            => 'The request is invalid or malformed.',
+			'timeout-or-duplicate'   => 'The request took too long to be sent or was a duplicate of a previous request.',
+		);
+		return isset($error_codes[ $error_code ]) ? $error_codes[ $error_code ] : '';
+	}
 
 
-    /**
-     * @return array
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function getLocalizedVars()
-    {
-        return (array) apply_filters(
-            'FHEE__EventEspresso_caffeinated_modules_recaptcha_invisible_InvisibleRecaptcha__getLocalizedVars__localized_vars',
-            array(
-                'siteKey'          => $this->config->recaptcha_publickey,
-                'recaptcha_passed' => $this->recaptchaPassed(),
-                'wp_debug'         => WP_DEBUG,
-                'disable_submit'   => defined('EE_EVENT_QUEUE_BASE_URL'),
-            )
-        );
-    }
+	/**
+	 * @return array
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function getLocalizedVars()
+	{
+		return (array) apply_filters(
+			'FHEE__EventEspresso_caffeinated_modules_recaptcha_invisible_InvisibleRecaptcha__getLocalizedVars__localized_vars',
+			array(
+				'siteKey'          => $this->config->recaptcha_publickey,
+				'recaptcha_passed' => $this->recaptchaPassed(),
+				'wp_debug'         => WP_DEBUG,
+				'disable_submit'   => defined('EE_EVENT_QUEUE_BASE_URL'),
+			)
+		);
+	}
 
 
-    /**
-     * @return boolean
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function recaptchaPassed()
-    {
-        if ($this->recaptcha_passed !== null) {
-            return $this->recaptcha_passed;
-        }
-        // logged in means you have already passed a turing test of sorts
-        if ($this->useInvisibleRecaptcha() === false || is_user_logged_in()) {
-            $this->recaptcha_passed = true;
-            return $this->recaptcha_passed;
-        }
-        // was test already passed?
-        $this->recaptcha_passed = filter_var(
-            $this->session->get_session_data(
-                InvisibleRecaptcha::SESSION_DATA_KEY_RECAPTCHA_PASSED
-            ),
-            FILTER_VALIDATE_BOOLEAN
-        );
-        return $this->recaptcha_passed;
-    }
+	/**
+	 * @return boolean
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function recaptchaPassed()
+	{
+		if ($this->recaptcha_passed !== null) {
+			return $this->recaptcha_passed;
+		}
+		// logged in means you have already passed a turing test of sorts
+		if ($this->useInvisibleRecaptcha() === false || is_user_logged_in()) {
+			$this->recaptcha_passed = true;
+			return $this->recaptcha_passed;
+		}
+		// was test already passed?
+		$this->recaptcha_passed = filter_var(
+			$this->session->get_session_data(
+				InvisibleRecaptcha::SESSION_DATA_KEY_RECAPTCHA_PASSED
+			),
+			FILTER_VALIDATE_BOOLEAN
+		);
+		return $this->recaptcha_passed;
+	}
 
 
-    /**
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function setSessionData()
-    {
-        $this->session->set_session_data(
-            array(InvisibleRecaptcha::SESSION_DATA_KEY_RECAPTCHA_PASSED => true)
-        );
-    }
+	/**
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function setSessionData()
+	{
+		$this->session->set_session_data(
+			array(InvisibleRecaptcha::SESSION_DATA_KEY_RECAPTCHA_PASSED => true)
+		);
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -148,11 +148,11 @@ 
             return false;
         }
         // if this token has already been verified, then return previous response
-        if (isset($previous_recaptcha_response[ $grecaptcha_response ])) {
-            return $previous_recaptcha_response[ $grecaptcha_response ];
+        if (isset($previous_recaptcha_response[$grecaptcha_response])) {
+            return $previous_recaptcha_response[$grecaptcha_response];
         }
         // will update to true if everything passes
-        $previous_recaptcha_response[ $grecaptcha_response ] = false;
+        $previous_recaptcha_response[$grecaptcha_response] = false;
         $response                                            = wp_safe_remote_post(
             InvisibleRecaptcha::URL_GOOGLE_RECAPTCHA_API,
             array(
@@ -169,16 +169,16 @@ 
         }
         $results = json_decode(wp_remote_retrieve_body($response), true);
         if (filter_var($results['success'], FILTER_VALIDATE_BOOLEAN) !== true) {
-            $errors   = array_map(
+            $errors = array_map(
                 array($this, 'getErrorCode'),
                 $results['error-codes']
             );
             if (isset($results['challenge_ts'])) {
-                $errors[] = 'challenge timestamp: ' . $results['challenge_ts'] . '.';
+                $errors[] = 'challenge timestamp: '.$results['challenge_ts'].'.';
             }
             $this->generateError(implode(' ', $errors), true);
         }
-        $previous_recaptcha_response[ $grecaptcha_response ] = true;
+        $previous_recaptcha_response[$grecaptcha_response] = true;
         add_action('shutdown', array($this, 'setSessionData'));
         return true;
     }
@@ -219,7 +219,7 @@ 
             'bad-request'            => 'The request is invalid or malformed.',
             'timeout-or-duplicate'   => 'The request took too long to be sent or was a duplicate of a previous request.',
         );
-        return isset($error_codes[ $error_code ]) ? $error_codes[ $error_code ] : '';
+        return isset($error_codes[$error_code]) ? $error_codes[$error_code] : '';
     }
 
 

admin_pages/messages/Messages_Template_List_Table.class.php

Indentation +335 added lines, -335 removed lines

@@ -13,339 +13,339 @@
 {
 
 
-    /**
-     * @return Messages_Admin_Page
-     */
-    public function get_admin_page()
-    {
-        return $this->_admin_page;
-    }
-
-
-    /**
-     * Setup data object
-     */
-    protected function _setup_data()
-    {
-        $this->_data = $this->get_admin_page()->get_message_templates(
-            $this->_per_page,
-            $this->_view,
-            false
-        );
-        $this->_all_data_count = $this->get_admin_page()->get_message_templates(
-            $this->_per_page,
-            $this->_view,
-            true,
-            true
-        );
-    }
-
-
-    /**
-     * Set internal properties
-     */
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = array(
-            'singular' => esc_html__('Message Template Group', 'event_espresso'),
-            'plural'   => esc_html__('Message Template', 'event_espresso'),
-            'ajax'     => true, // for now,
-            'screen'   => $this->get_admin_page()->get_current_screen()->id,
-        );
-        $this->_columns = array(
-            // 'cb' => '<input type="checkbox" />', //no deleting default (global) templates!
-            'message_type' => esc_html__('Message Type', 'event_espresso'),
-            'messenger'    => esc_html__('Messenger', 'event_espresso'),
-            'description'  => esc_html__('Description', 'event_espresso'),
-        );
-
-        $this->_sortable_columns = array(
-            'messenger' => array('MTP_messenger' => true),
-        );
-
-        $this->_hidden_columns = array();
-    }
-
-
-    /**
-     * Overriding the single_row method from parent to verify whether the $item has an accessible
-     * message_type or messenger object before generating the row.
-     *
-     * @param EE_Message_Template_Group $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function single_row($item)
-    {
-        $message_type = $item->message_type_obj();
-        $messenger = $item->messenger_obj();
-
-        if (! $message_type instanceof EE_message_type || ! $messenger instanceof EE_messenger) {
-            echo '';
-            return;
-        }
-
-        parent::single_row($item);
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_table_filters()
-    {
-        $filters = array();
-
-        // get select inputs
-        $select_inputs = array(
-            $this->_get_messengers_dropdown_filter(),
-            $this->_get_message_types_dropdown_filter(),
-        );
-
-        // set filters to select inputs if they aren't empty
-        foreach ($select_inputs as $select_input) {
-            if ($select_input) {
-                $filters[] = $select_input;
-            }
-        }
-        return $filters;
-    }
-
-    /**
-     * We're just removing the search box for message templates, not needed.
-     *
-     * @param string $text
-     * @param string $input_id
-     * @return string ;
-     */
-    public function search_box($text, $input_id)
-    {
-        return '';
-    }
-
-
-    /**
-     * Add counts to the _views property
-     */
-    protected function _add_view_counts()
-    {
-        foreach ($this->_views as $view => $args) {
-            $this->_views[ $view ]['count'] = $this->get_admin_page()->get_message_templates(
-                $this->_per_page,
-                $view,
-                true,
-                true
-            );
-        }
-    }
-
-
-    /**
-     * @param EE_Message_Template_Group $item
-     * @return string
-     */
-    public function column_cb($item)
-    {
-        return '';
-    }
-
-
-    /**
-     * @param EE_Message_Template_Group $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_description($item)
-    {
-        return '<p>' . $item->message_type_obj()->description . '</p>';
-    }
-
-
-    /**
-     * @param EE_Message_Template_Group $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_messenger($item)
-    {
-        // Return the name contents
-        return sprintf(
-            '%1$s <span style="color:silver">(id:%2$s)</span><br />%3$s',
-            /* $1%s */
-            ucwords($item->messenger_obj()->label['singular']),
-            /* $2%s */
-            $item->GRP_ID(),
-            /* %4$s */
-            $this->_get_context_links($item)
-        );
-    }
-
-    /**
-     * column_message_type
-     *
-     * @param  EE_Message_Template_Group $item message info for the row
-     * @return string message_type name
-     * @throws EE_Error
-     */
-    public function column_message_type($item)
-    {
-        return ucwords($item->message_type_obj()->label['singular']);
-    }
-
-
-    /**
-     * Generate dropdown filter select input for messengers
-     *
-     * @param bool $global
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_messengers_dropdown_filter($global = true)
-    {
-        $messenger_options = array();
-        $active_message_template_groups_grouped_by_messenger = EEM_Message_Template_Group::instance()->get_all(
-            array(
-                array(
-                    'MTP_is_active' => true,
-                    'MTP_is_global' => $global,
-                ),
-                'group_by' => 'MTP_messenger',
-            )
-        );
-
-        foreach ($active_message_template_groups_grouped_by_messenger as $active_message_template_group) {
-            if ($active_message_template_group instanceof EE_Message_Template_Group) {
-                $messenger = $active_message_template_group->messenger_obj();
-                $messenger_label = $messenger instanceof EE_messenger
-                    ? $messenger->label['singular']
-                    : $active_message_template_group->messenger();
-                $messenger_options[ $active_message_template_group->messenger() ] = ucwords($messenger_label);
-            }
-        }
-        return $this->get_admin_page()->get_messengers_select_input($messenger_options);
-    }
-
-
-    /**
-     * Generate dropdown filter select input for message types
-     *
-     * @param bool $global
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_message_types_dropdown_filter($global = true)
-    {
-        $message_type_options = array();
-        $active_message_template_groups_grouped_by_message_type = EEM_Message_Template_Group::instance()->get_all(
-            array(
-                array(
-                    'MTP_is_active' => true,
-                    'MTP_is_global' => true,
-                ),
-                'group_by' => 'MTP_message_type',
-            )
-        );
-
-        foreach ($active_message_template_groups_grouped_by_message_type as $active_message_template_group) {
-            if ($active_message_template_group instanceof EE_Message_Template_Group) {
-                $message_type = $active_message_template_group->message_type_obj();
-                $message_type_label = $message_type instanceof EE_message_type
-                    ? $message_type->label['singular']
-                    : $active_message_template_group->message_type();
-                $message_type_options[ $active_message_template_group->message_type() ] = ucwords($message_type_label);
-            }
-        }
-        return $this->get_admin_page()->get_message_types_select_input($message_type_options);
-    }
-
-
-    /**
-     * Return the edit url for the message template group.
-     *
-     * @param EE_Message_Template_Group $item
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_edit_url(EE_Message_Template_Group $item)
-    {
-        $edit_url = '';
-        // edit link but only if item isn't trashed.
-        if (! $item->get('MTP_deleted')
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_message',
-                'espresso_messages_edit_message_template',
-                $item->ID()
-            )) {
-            $edit_url = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action' => 'edit_message_template',
-                    'id'     => $item->GRP_ID(),
-                ),
-                EE_MSG_ADMIN_URL
-            );
-        }
-        return $edit_url;
-    }
-
-
-    /**
-     * Get the context link string for the messenger column.
-     *
-     * @param EE_Message_Template_Group $item
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_context_links(EE_Message_Template_Group $item)
-    {
-        // first check if we even show the context links or not.
-        if (! EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_message',
-            'espresso_messages_edit_message_template',
-            $item->ID()
-        )
-            || $item->get('MTP_deleted')
-        ) {
-            return '';
-        }
-        // we want to display the contexts in here so we need to set them up
-        $c_label = $item->context_label();
-        $c_configs = $item->contexts_config();
-        $ctxt = array();
-        $context_templates = $item->context_templates();
-        foreach ($context_templates as $context => $template_fields) {
-            $mtp_to = ! empty($context_templates[ $context ]['to'])
-                      && $context_templates[ $context ]['to'] instanceof EE_Message_Template
-                ? $context_templates[ $context ]['to']->get('MTP_content')
-                : null;
-            $inactive_class = (
-                                  empty($mtp_to)
-                                  && ! empty($context_templates[ $context ]['to'])
-                              )
-                              || ! $item->is_context_active($context)
-                ? ' mtp-inactive'
-                : '';
-            $context_title = sprintf(
-                /* translators: Placeholder represents the context label. Example "Edit Event Admin" */
-                esc_html__('Edit %1$s', 'event_espresso'),
-                ucwords($c_configs[ $context ]['label'])
-            );
-            $edit_link = EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action'  => 'edit_message_template',
-                    'id'      => $item->GRP_ID(),
-                    'context' => $context,
-                ),
-                EE_MSG_ADMIN_URL
-            );
-            $ctxt[] = '<a'
-                      . ' href="' . $edit_link . '"'
-                      . ' class="' . $item->message_type() . '-' . $context . '-edit-link' . $inactive_class . '"'
-                      . ' title="' . esc_attr__('Edit Context', 'event_espresso') . '">'
-                      . $context_title
-                      . '</a>';
-        }
-
-        return sprintf('<strong>%s:</strong> ', ucwords($c_label['plural'])) . implode(' | ', $ctxt);
-    }
+	/**
+	 * @return Messages_Admin_Page
+	 */
+	public function get_admin_page()
+	{
+		return $this->_admin_page;
+	}
+
+
+	/**
+	 * Setup data object
+	 */
+	protected function _setup_data()
+	{
+		$this->_data = $this->get_admin_page()->get_message_templates(
+			$this->_per_page,
+			$this->_view,
+			false
+		);
+		$this->_all_data_count = $this->get_admin_page()->get_message_templates(
+			$this->_per_page,
+			$this->_view,
+			true,
+			true
+		);
+	}
+
+
+	/**
+	 * Set internal properties
+	 */
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = array(
+			'singular' => esc_html__('Message Template Group', 'event_espresso'),
+			'plural'   => esc_html__('Message Template', 'event_espresso'),
+			'ajax'     => true, // for now,
+			'screen'   => $this->get_admin_page()->get_current_screen()->id,
+		);
+		$this->_columns = array(
+			// 'cb' => '<input type="checkbox" />', //no deleting default (global) templates!
+			'message_type' => esc_html__('Message Type', 'event_espresso'),
+			'messenger'    => esc_html__('Messenger', 'event_espresso'),
+			'description'  => esc_html__('Description', 'event_espresso'),
+		);
+
+		$this->_sortable_columns = array(
+			'messenger' => array('MTP_messenger' => true),
+		);
+
+		$this->_hidden_columns = array();
+	}
+
+
+	/**
+	 * Overriding the single_row method from parent to verify whether the $item has an accessible
+	 * message_type or messenger object before generating the row.
+	 *
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function single_row($item)
+	{
+		$message_type = $item->message_type_obj();
+		$messenger = $item->messenger_obj();
+
+		if (! $message_type instanceof EE_message_type || ! $messenger instanceof EE_messenger) {
+			echo '';
+			return;
+		}
+
+		parent::single_row($item);
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_table_filters()
+	{
+		$filters = array();
+
+		// get select inputs
+		$select_inputs = array(
+			$this->_get_messengers_dropdown_filter(),
+			$this->_get_message_types_dropdown_filter(),
+		);
+
+		// set filters to select inputs if they aren't empty
+		foreach ($select_inputs as $select_input) {
+			if ($select_input) {
+				$filters[] = $select_input;
+			}
+		}
+		return $filters;
+	}
+
+	/**
+	 * We're just removing the search box for message templates, not needed.
+	 *
+	 * @param string $text
+	 * @param string $input_id
+	 * @return string ;
+	 */
+	public function search_box($text, $input_id)
+	{
+		return '';
+	}
+
+
+	/**
+	 * Add counts to the _views property
+	 */
+	protected function _add_view_counts()
+	{
+		foreach ($this->_views as $view => $args) {
+			$this->_views[ $view ]['count'] = $this->get_admin_page()->get_message_templates(
+				$this->_per_page,
+				$view,
+				true,
+				true
+			);
+		}
+	}
+
+
+	/**
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 */
+	public function column_cb($item)
+	{
+		return '';
+	}
+
+
+	/**
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_description($item)
+	{
+		return '<p>' . $item->message_type_obj()->description . '</p>';
+	}
+
+
+	/**
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_messenger($item)
+	{
+		// Return the name contents
+		return sprintf(
+			'%1$s <span style="color:silver">(id:%2$s)</span><br />%3$s',
+			/* $1%s */
+			ucwords($item->messenger_obj()->label['singular']),
+			/* $2%s */
+			$item->GRP_ID(),
+			/* %4$s */
+			$this->_get_context_links($item)
+		);
+	}
+
+	/**
+	 * column_message_type
+	 *
+	 * @param  EE_Message_Template_Group $item message info for the row
+	 * @return string message_type name
+	 * @throws EE_Error
+	 */
+	public function column_message_type($item)
+	{
+		return ucwords($item->message_type_obj()->label['singular']);
+	}
+
+
+	/**
+	 * Generate dropdown filter select input for messengers
+	 *
+	 * @param bool $global
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_messengers_dropdown_filter($global = true)
+	{
+		$messenger_options = array();
+		$active_message_template_groups_grouped_by_messenger = EEM_Message_Template_Group::instance()->get_all(
+			array(
+				array(
+					'MTP_is_active' => true,
+					'MTP_is_global' => $global,
+				),
+				'group_by' => 'MTP_messenger',
+			)
+		);
+
+		foreach ($active_message_template_groups_grouped_by_messenger as $active_message_template_group) {
+			if ($active_message_template_group instanceof EE_Message_Template_Group) {
+				$messenger = $active_message_template_group->messenger_obj();
+				$messenger_label = $messenger instanceof EE_messenger
+					? $messenger->label['singular']
+					: $active_message_template_group->messenger();
+				$messenger_options[ $active_message_template_group->messenger() ] = ucwords($messenger_label);
+			}
+		}
+		return $this->get_admin_page()->get_messengers_select_input($messenger_options);
+	}
+
+
+	/**
+	 * Generate dropdown filter select input for message types
+	 *
+	 * @param bool $global
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_message_types_dropdown_filter($global = true)
+	{
+		$message_type_options = array();
+		$active_message_template_groups_grouped_by_message_type = EEM_Message_Template_Group::instance()->get_all(
+			array(
+				array(
+					'MTP_is_active' => true,
+					'MTP_is_global' => true,
+				),
+				'group_by' => 'MTP_message_type',
+			)
+		);
+
+		foreach ($active_message_template_groups_grouped_by_message_type as $active_message_template_group) {
+			if ($active_message_template_group instanceof EE_Message_Template_Group) {
+				$message_type = $active_message_template_group->message_type_obj();
+				$message_type_label = $message_type instanceof EE_message_type
+					? $message_type->label['singular']
+					: $active_message_template_group->message_type();
+				$message_type_options[ $active_message_template_group->message_type() ] = ucwords($message_type_label);
+			}
+		}
+		return $this->get_admin_page()->get_message_types_select_input($message_type_options);
+	}
+
+
+	/**
+	 * Return the edit url for the message template group.
+	 *
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_edit_url(EE_Message_Template_Group $item)
+	{
+		$edit_url = '';
+		// edit link but only if item isn't trashed.
+		if (! $item->get('MTP_deleted')
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_message',
+				'espresso_messages_edit_message_template',
+				$item->ID()
+			)) {
+			$edit_url = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action' => 'edit_message_template',
+					'id'     => $item->GRP_ID(),
+				),
+				EE_MSG_ADMIN_URL
+			);
+		}
+		return $edit_url;
+	}
+
+
+	/**
+	 * Get the context link string for the messenger column.
+	 *
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_context_links(EE_Message_Template_Group $item)
+	{
+		// first check if we even show the context links or not.
+		if (! EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_message',
+			'espresso_messages_edit_message_template',
+			$item->ID()
+		)
+			|| $item->get('MTP_deleted')
+		) {
+			return '';
+		}
+		// we want to display the contexts in here so we need to set them up
+		$c_label = $item->context_label();
+		$c_configs = $item->contexts_config();
+		$ctxt = array();
+		$context_templates = $item->context_templates();
+		foreach ($context_templates as $context => $template_fields) {
+			$mtp_to = ! empty($context_templates[ $context ]['to'])
+					  && $context_templates[ $context ]['to'] instanceof EE_Message_Template
+				? $context_templates[ $context ]['to']->get('MTP_content')
+				: null;
+			$inactive_class = (
+								  empty($mtp_to)
+								  && ! empty($context_templates[ $context ]['to'])
+							  )
+							  || ! $item->is_context_active($context)
+				? ' mtp-inactive'
+				: '';
+			$context_title = sprintf(
+				/* translators: Placeholder represents the context label. Example "Edit Event Admin" */
+				esc_html__('Edit %1$s', 'event_espresso'),
+				ucwords($c_configs[ $context ]['label'])
+			);
+			$edit_link = EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action'  => 'edit_message_template',
+					'id'      => $item->GRP_ID(),
+					'context' => $context,
+				),
+				EE_MSG_ADMIN_URL
+			);
+			$ctxt[] = '<a'
+					  . ' href="' . $edit_link . '"'
+					  . ' class="' . $item->message_type() . '-' . $context . '-edit-link' . $inactive_class . '"'
+					  . ' title="' . esc_attr__('Edit Context', 'event_espresso') . '">'
+					  . $context_title
+					  . '</a>';
+		}
+
+		return sprintf('<strong>%s:</strong> ', ucwords($c_label['plural'])) . implode(' | ', $ctxt);
+	}
 }

Spacing +16 added lines, -16 removed lines

@@ -80,7 +80,7 @@ 
         $message_type = $item->message_type_obj();
         $messenger = $item->messenger_obj();
 
-        if (! $message_type instanceof EE_message_type || ! $messenger instanceof EE_messenger) {
+        if ( ! $message_type instanceof EE_message_type || ! $messenger instanceof EE_messenger) {
             echo '';
             return;
         }
@@ -131,7 +131,7 @@ 
     protected function _add_view_counts()
     {
         foreach ($this->_views as $view => $args) {
-            $this->_views[ $view ]['count'] = $this->get_admin_page()->get_message_templates(
+            $this->_views[$view]['count'] = $this->get_admin_page()->get_message_templates(
                 $this->_per_page,
                 $view,
                 true,
@@ -158,7 +158,7 @@ 
      */
     public function column_description($item)
     {
-        return '<p>' . $item->message_type_obj()->description . '</p>';
+        return '<p>'.$item->message_type_obj()->description.'</p>';
     }
 
 
@@ -220,7 +220,7 @@ 
                 $messenger_label = $messenger instanceof EE_messenger
                     ? $messenger->label['singular']
                     : $active_message_template_group->messenger();
-                $messenger_options[ $active_message_template_group->messenger() ] = ucwords($messenger_label);
+                $messenger_options[$active_message_template_group->messenger()] = ucwords($messenger_label);
             }
         }
         return $this->get_admin_page()->get_messengers_select_input($messenger_options);
@@ -253,7 +253,7 @@ 
                 $message_type_label = $message_type instanceof EE_message_type
                     ? $message_type->label['singular']
                     : $active_message_template_group->message_type();
-                $message_type_options[ $active_message_template_group->message_type() ] = ucwords($message_type_label);
+                $message_type_options[$active_message_template_group->message_type()] = ucwords($message_type_label);
             }
         }
         return $this->get_admin_page()->get_message_types_select_input($message_type_options);
@@ -271,7 +271,7 @@ 
     {
         $edit_url = '';
         // edit link but only if item isn't trashed.
-        if (! $item->get('MTP_deleted')
+        if ( ! $item->get('MTP_deleted')
             && EE_Registry::instance()->CAP->current_user_can(
                 'ee_edit_message',
                 'espresso_messages_edit_message_template',
@@ -299,7 +299,7 @@ 
     protected function _get_context_links(EE_Message_Template_Group $item)
     {
         // first check if we even show the context links or not.
-        if (! EE_Registry::instance()->CAP->current_user_can(
+        if ( ! EE_Registry::instance()->CAP->current_user_can(
             'ee_edit_message',
             'espresso_messages_edit_message_template',
             $item->ID()
@@ -314,13 +314,13 @@ 
         $ctxt = array();
         $context_templates = $item->context_templates();
         foreach ($context_templates as $context => $template_fields) {
-            $mtp_to = ! empty($context_templates[ $context ]['to'])
-                      && $context_templates[ $context ]['to'] instanceof EE_Message_Template
-                ? $context_templates[ $context ]['to']->get('MTP_content')
+            $mtp_to = ! empty($context_templates[$context]['to'])
+                      && $context_templates[$context]['to'] instanceof EE_Message_Template
+                ? $context_templates[$context]['to']->get('MTP_content')
                 : null;
             $inactive_class = (
                                   empty($mtp_to)
-                                  && ! empty($context_templates[ $context ]['to'])
+                                  && ! empty($context_templates[$context]['to'])
                               )
                               || ! $item->is_context_active($context)
                 ? ' mtp-inactive'
@@ -328,7 +328,7 @@ 
             $context_title = sprintf(
                 /* translators: Placeholder represents the context label. Example "Edit Event Admin" */
                 esc_html__('Edit %1$s', 'event_espresso'),
-                ucwords($c_configs[ $context ]['label'])
+                ucwords($c_configs[$context]['label'])
             );
             $edit_link = EE_Admin_Page::add_query_args_and_nonce(
                 array(
@@ -339,13 +339,13 @@ 
                 EE_MSG_ADMIN_URL
             );
             $ctxt[] = '<a'
-                      . ' href="' . $edit_link . '"'
-                      . ' class="' . $item->message_type() . '-' . $context . '-edit-link' . $inactive_class . '"'
-                      . ' title="' . esc_attr__('Edit Context', 'event_espresso') . '">'
+                      . ' href="'.$edit_link.'"'
+                      . ' class="'.$item->message_type().'-'.$context.'-edit-link'.$inactive_class.'"'
+                      . ' title="'.esc_attr__('Edit Context', 'event_espresso').'">'
                       . $context_title
                       . '</a>';
         }
 
-        return sprintf('<strong>%s:</strong> ', ucwords($c_label['plural'])) . implode(' | ', $ctxt);
+        return sprintf('<strong>%s:</strong> ', ucwords($c_label['plural'])).implode(' | ', $ctxt);
     }
 }

core/db_models/relations/EE_HABTM_Relation.php

Indentation +234 added lines, -234 removed lines

@@ -9,261 +9,261 @@
  */
 class EE_HABTM_Relation extends EE_Model_Relation_Base
 {
-    /**
-     * Model which defines the relation between two other models. Eg, the EE_Event_Question_Group model,
-     * which joins EE_Event and EE_Question_Group
-     *
-     * @var EEM_Base
-     */
-    protected $_joining_model_name;
+	/**
+	 * Model which defines the relation between two other models. Eg, the EE_Event_Question_Group model,
+	 * which joins EE_Event and EE_Question_Group
+	 *
+	 * @var EEM_Base
+	 */
+	protected $_joining_model_name;
 
-    protected $_model_relation_chain_to_join_model;
+	protected $_model_relation_chain_to_join_model;
 
 
-    /**
-     * Object representing the relationship between two models. HasAndBelongsToMany relations always use a join-table
-     * (and an ee joining-model.) This knows how to join the models,
-     * get related models across the relation, and add-and-remove the relationships.
-     *
-     * @param bool    $joining_model_name
-     * @param boolean $block_deletes                 for this type of relation, we block by default for now. if there
-     *                                               are related models across this relation, block (prevent and add an
-     *                                               error) the deletion of this model
-     * @param string  $blocking_delete_error_message a customized error message on blocking deletes instead of the
-     *                                               default
-     */
-    public function __construct($joining_model_name, $block_deletes = true, $blocking_delete_error_message = '')
-    {
-        $this->_joining_model_name = $joining_model_name;
-        parent::__construct($block_deletes, $blocking_delete_error_message);
-    }
+	/**
+	 * Object representing the relationship between two models. HasAndBelongsToMany relations always use a join-table
+	 * (and an ee joining-model.) This knows how to join the models,
+	 * get related models across the relation, and add-and-remove the relationships.
+	 *
+	 * @param bool    $joining_model_name
+	 * @param boolean $block_deletes                 for this type of relation, we block by default for now. if there
+	 *                                               are related models across this relation, block (prevent and add an
+	 *                                               error) the deletion of this model
+	 * @param string  $blocking_delete_error_message a customized error message on blocking deletes instead of the
+	 *                                               default
+	 */
+	public function __construct($joining_model_name, $block_deletes = true, $blocking_delete_error_message = '')
+	{
+		$this->_joining_model_name = $joining_model_name;
+		parent::__construct($block_deletes, $blocking_delete_error_message);
+	}
 
-    /**
-     * Gets the joining model's object
-     *
-     * @return EEM_Base
-     */
-    public function get_join_model()
-    {
-        return $this->_get_model($this->_joining_model_name);
-    }
+	/**
+	 * Gets the joining model's object
+	 *
+	 * @return EEM_Base
+	 */
+	public function get_join_model()
+	{
+		return $this->_get_model($this->_joining_model_name);
+	}
 
 
-    /**
-     * Gets the SQL string for joining the main model's table containing the pk to the join table. Eg "LEFT JOIN
-     * real_join_table AS join_table_alias ON this_table_alias.pk = join_table_alias.fk_to_this_table"
-     *
-     * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
-     * @return string of SQL
-     * @throws \EE_Error
-     */
-    public function get_join_to_intermediate_model_statement($model_relation_chain)
-    {
-        // create sql like
-        // LEFT JOIN join_table AS join_table_alias ON this_table_alias.this_table_pk = join_table_alias.join_table_fk_to_this
-        // LEFT JOIN other_table AS other_table_alias ON join_table_alias.join_table_fk_to_other = other_table_alias.other_table_pk
-        // remember the model relation chain to the JOIN model, because we'll
-        // need it for get_join_statement()
-        $this->_model_relation_chain_to_join_model = $model_relation_chain;
-        $this_table_pk_field                       = $this->get_this_model()->get_primary_key_field();// get_foreign_key_to($this->get_other_model()->get_this_model_name());
-        $join_table_fk_field_to_this_table         = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        $this_table_alias                          = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
-            $model_relation_chain,
-            $this->get_this_model()->get_this_model_name()
-        ) . $this_table_pk_field->get_table_alias();
+	/**
+	 * Gets the SQL string for joining the main model's table containing the pk to the join table. Eg "LEFT JOIN
+	 * real_join_table AS join_table_alias ON this_table_alias.pk = join_table_alias.fk_to_this_table"
+	 *
+	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
+	 * @return string of SQL
+	 * @throws \EE_Error
+	 */
+	public function get_join_to_intermediate_model_statement($model_relation_chain)
+	{
+		// create sql like
+		// LEFT JOIN join_table AS join_table_alias ON this_table_alias.this_table_pk = join_table_alias.join_table_fk_to_this
+		// LEFT JOIN other_table AS other_table_alias ON join_table_alias.join_table_fk_to_other = other_table_alias.other_table_pk
+		// remember the model relation chain to the JOIN model, because we'll
+		// need it for get_join_statement()
+		$this->_model_relation_chain_to_join_model = $model_relation_chain;
+		$this_table_pk_field                       = $this->get_this_model()->get_primary_key_field();// get_foreign_key_to($this->get_other_model()->get_this_model_name());
+		$join_table_fk_field_to_this_table         = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		$this_table_alias                          = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+			$model_relation_chain,
+			$this->get_this_model()->get_this_model_name()
+		) . $this_table_pk_field->get_table_alias();
 
-        $join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
-            $model_relation_chain,
-            $this->get_join_model()->get_this_model_name()
-        ) . $join_table_fk_field_to_this_table->get_table_alias();
-        $join_table       = $this->get_join_model()->get_table_for_alias($join_table_alias);
-        // phew! ok, we have all the info we need, now we can create the SQL join string
-        $SQL = $this->_left_join(
-            $join_table,
-            $join_table_alias,
-            $join_table_fk_field_to_this_table->get_table_column(),
-            $this_table_alias,
-            $this_table_pk_field->get_table_column()
-        ) . $this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
+		$join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+			$model_relation_chain,
+			$this->get_join_model()->get_this_model_name()
+		) . $join_table_fk_field_to_this_table->get_table_alias();
+		$join_table       = $this->get_join_model()->get_table_for_alias($join_table_alias);
+		// phew! ok, we have all the info we need, now we can create the SQL join string
+		$SQL = $this->_left_join(
+			$join_table,
+			$join_table_alias,
+			$join_table_fk_field_to_this_table->get_table_column(),
+			$this_table_alias,
+			$this_table_pk_field->get_table_column()
+		) . $this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
 
-        return $SQL;
-    }
+		return $SQL;
+	}
 
 
-    /**
-     * Gets the SQL string for joining the join table to the other model's pk's table. Eg "LEFT JOIN real_other_table
-     * AS other_table_alias ON join_table_alias.fk_to_other_table = other_table_alias.pk" If you want to join between
-     * modelA -> joinModelAB -> modelB (eg, Event -> Event_Question_Group -> Question_Group), you should prepend the
-     * result of this function with results from get_join_to_intermediate_model_statement(), so that you join first to
-     * the intermediate join table, and then to the other model's pk's table
-     *
-     * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
-     * @return string of SQL
-     * @throws \EE_Error
-     */
-    public function get_join_statement($model_relation_chain)
-    {
-        if ($this->_model_relation_chain_to_join_model === null) {
-            throw new EE_Error(sprintf(__(
-                'When using EE_HABTM_Relation to create a join, you must call get_join_to_intermediate_model_statement BEFORE get_join_statement',
-                'event_espresso'
-            )));
-        }
-        $join_table_fk_field_to_this_table  = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        $join_table_alias                   = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
-            $this->_model_relation_chain_to_join_model,
-            $this->get_join_model()->get_this_model_name()
-        ) . $join_table_fk_field_to_this_table->get_table_alias();
-        $other_table_pk_field               = $this->get_other_model()->get_primary_key_field();
-        $join_table_fk_field_to_other_table = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
-        $other_table_alias                  = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
-            $model_relation_chain,
-            $this->get_other_model()->get_this_model_name()
-        ) . $other_table_pk_field->get_table_alias();
-        $other_table                        = $this->get_other_model()->get_table_for_alias($other_table_alias);
+	/**
+	 * Gets the SQL string for joining the join table to the other model's pk's table. Eg "LEFT JOIN real_other_table
+	 * AS other_table_alias ON join_table_alias.fk_to_other_table = other_table_alias.pk" If you want to join between
+	 * modelA -> joinModelAB -> modelB (eg, Event -> Event_Question_Group -> Question_Group), you should prepend the
+	 * result of this function with results from get_join_to_intermediate_model_statement(), so that you join first to
+	 * the intermediate join table, and then to the other model's pk's table
+	 *
+	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
+	 * @return string of SQL
+	 * @throws \EE_Error
+	 */
+	public function get_join_statement($model_relation_chain)
+	{
+		if ($this->_model_relation_chain_to_join_model === null) {
+			throw new EE_Error(sprintf(__(
+				'When using EE_HABTM_Relation to create a join, you must call get_join_to_intermediate_model_statement BEFORE get_join_statement',
+				'event_espresso'
+			)));
+		}
+		$join_table_fk_field_to_this_table  = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		$join_table_alias                   = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+			$this->_model_relation_chain_to_join_model,
+			$this->get_join_model()->get_this_model_name()
+		) . $join_table_fk_field_to_this_table->get_table_alias();
+		$other_table_pk_field               = $this->get_other_model()->get_primary_key_field();
+		$join_table_fk_field_to_other_table = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
+		$other_table_alias                  = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+			$model_relation_chain,
+			$this->get_other_model()->get_this_model_name()
+		) . $other_table_pk_field->get_table_alias();
+		$other_table                        = $this->get_other_model()->get_table_for_alias($other_table_alias);
 
-        $SQL = $this->_left_join(
-            $other_table,
-            $other_table_alias,
-            $other_table_pk_field->get_table_column(),
-            $join_table_alias,
-            $join_table_fk_field_to_other_table->get_table_column()
-        ) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
-        return $SQL;
-    }
+		$SQL = $this->_left_join(
+			$other_table,
+			$other_table_alias,
+			$other_table_pk_field->get_table_column(),
+			$join_table_alias,
+			$join_table_fk_field_to_other_table->get_table_column()
+		) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
+		return $SQL;
+	}
 
 
-    /**
-     * Ensures there is an entry in the join table between these two models. Feel free to do this manually if you like.
-     * If the join table has additional columns (eg, the Event_Question_Group table has a is_primary column), then
-     * you'll want to directly use the EEM_Event_Question_Group model to add the entry to the table and set those extra
-     * columns' values
-     *
-     * @param EE_Base_Class|int $this_obj_or_id
-     * @param EE_Base_Class|int $other_obj_or_id
-     * @param array             $extra_join_model_fields_n_values col=>val pairs that are used as extra conditions for
-     *                                                            checking existing values and for setting new rows if
-     *                                                            no exact matches.
-     * @return EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function add_relation_to($this_obj_or_id, $other_obj_or_id, $extra_join_model_fields_n_values = array())
-    {
-        $this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
-        $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
-        // check if such a relationship already exists
-        $join_model_fk_to_this_model  = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        $join_model_fk_to_other_model = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
+	/**
+	 * Ensures there is an entry in the join table between these two models. Feel free to do this manually if you like.
+	 * If the join table has additional columns (eg, the Event_Question_Group table has a is_primary column), then
+	 * you'll want to directly use the EEM_Event_Question_Group model to add the entry to the table and set those extra
+	 * columns' values
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param EE_Base_Class|int $other_obj_or_id
+	 * @param array             $extra_join_model_fields_n_values col=>val pairs that are used as extra conditions for
+	 *                                                            checking existing values and for setting new rows if
+	 *                                                            no exact matches.
+	 * @return EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function add_relation_to($this_obj_or_id, $other_obj_or_id, $extra_join_model_fields_n_values = array())
+	{
+		$this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
+		$other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
+		// check if such a relationship already exists
+		$join_model_fk_to_this_model  = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		$join_model_fk_to_other_model = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
 
-        $foreign_keys = $all_fields = array(
-            $join_model_fk_to_this_model->get_name()  => $this_model_obj->ID(),
-            $join_model_fk_to_other_model->get_name() => $other_model_obj->ID(),
-        );
+		$foreign_keys = $all_fields = array(
+			$join_model_fk_to_this_model->get_name()  => $this_model_obj->ID(),
+			$join_model_fk_to_other_model->get_name() => $other_model_obj->ID(),
+		);
 
-        // if $where_query exists lets add them to the query_params.
-        if (! empty($extra_join_model_fields_n_values)) {
-            // make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
-            // make sure we strip THIS models name from the query param
-            $parsed_query = array();
-            foreach ($extra_join_model_fields_n_values as $query_param => $val) {
-                $query_param                = str_replace(
-                    $this->get_join_model()->get_this_model_name() . ".",
-                    "",
-                    $query_param
-                );
-                $parsed_query[ $query_param ] = $val;
-            }
-            $all_fields = array_merge($foreign_keys, $parsed_query);
-        }
+		// if $where_query exists lets add them to the query_params.
+		if (! empty($extra_join_model_fields_n_values)) {
+			// make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
+			// make sure we strip THIS models name from the query param
+			$parsed_query = array();
+			foreach ($extra_join_model_fields_n_values as $query_param => $val) {
+				$query_param                = str_replace(
+					$this->get_join_model()->get_this_model_name() . ".",
+					"",
+					$query_param
+				);
+				$parsed_query[ $query_param ] = $val;
+			}
+			$all_fields = array_merge($foreign_keys, $parsed_query);
+		}
 
-        $existing_entry_in_join_table = $this->get_join_model()->get_one(array($all_fields));
-        // If there is already an entry in the join table, indicating a relationship, update it instead of adding a
-        // new row.
-        // Again, if you want more sophisticated logic or insertions (handling more columns than just 2 foreign keys to
-        // the other tables) use the joining model directly!
-        if (! $existing_entry_in_join_table) {
-            $this->get_join_model()->insert($all_fields);
-        }
-        return $other_model_obj;
-    }
+		$existing_entry_in_join_table = $this->get_join_model()->get_one(array($all_fields));
+		// If there is already an entry in the join table, indicating a relationship, update it instead of adding a
+		// new row.
+		// Again, if you want more sophisticated logic or insertions (handling more columns than just 2 foreign keys to
+		// the other tables) use the joining model directly!
+		if (! $existing_entry_in_join_table) {
+			$this->get_join_model()->insert($all_fields);
+		}
+		return $other_model_obj;
+	}
 
 
-    /**
-     * Deletes any rows in the join table that have foreign keys matching the other model objects specified
-     *
-     * @param EE_Base_Class|int $this_obj_or_id
-     * @param EE_Base_Class|int $other_obj_or_id
-     * @param array             $where_query col=>val pairs that are used as extra conditions for checking existing
-     *                                       values and for removing existing rows if exact matches exist.
-     * @return EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array())
-    {
-        $this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
-        $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
-        // check if such a relationship already exists
-        $join_model_fk_to_this_model  = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        $join_model_fk_to_other_model = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
+	/**
+	 * Deletes any rows in the join table that have foreign keys matching the other model objects specified
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param EE_Base_Class|int $other_obj_or_id
+	 * @param array             $where_query col=>val pairs that are used as extra conditions for checking existing
+	 *                                       values and for removing existing rows if exact matches exist.
+	 * @return EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array())
+	{
+		$this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
+		$other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
+		// check if such a relationship already exists
+		$join_model_fk_to_this_model  = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		$join_model_fk_to_other_model = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
 
-        $cols_n_values = array(
-            $join_model_fk_to_this_model->get_name()  => $this_model_obj->ID(),
-            $join_model_fk_to_other_model->get_name() => $other_model_obj->ID(),
-        );
+		$cols_n_values = array(
+			$join_model_fk_to_this_model->get_name()  => $this_model_obj->ID(),
+			$join_model_fk_to_other_model->get_name() => $other_model_obj->ID(),
+		);
 
-        // if $where_query exists lets add them to the query_params.
-        if (! empty($where_query)) {
-            // make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
-            // make sure we strip THIS models name from the query param
-            $parsed_query = array();
-            foreach ($where_query as $query_param => $val) {
-                $query_param                = str_replace(
-                    $this->get_join_model()->get_this_model_name() . ".",
-                    "",
-                    $query_param
-                );
-                $parsed_query[ $query_param ] = $val;
-            }
-            $cols_n_values = array_merge($cols_n_values, $parsed_query);
-        }
+		// if $where_query exists lets add them to the query_params.
+		if (! empty($where_query)) {
+			// make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
+			// make sure we strip THIS models name from the query param
+			$parsed_query = array();
+			foreach ($where_query as $query_param => $val) {
+				$query_param                = str_replace(
+					$this->get_join_model()->get_this_model_name() . ".",
+					"",
+					$query_param
+				);
+				$parsed_query[ $query_param ] = $val;
+			}
+			$cols_n_values = array_merge($cols_n_values, $parsed_query);
+		}
 
-        $this->get_join_model()->delete(array($cols_n_values));
-        return $other_model_obj;
-    }
+		$this->get_join_model()->delete(array($cols_n_values));
+		return $other_model_obj;
+	}
 
-    /**
-     * Gets all the non-key fields (ie, not the primary key and not foreign keys) on the join model.
-     * @since 4.9.76.p
-     * @return EE_Model_Field_Base[]
-     * @throws EE_Error
-     */
-    public function getNonKeyFields()
-    {
-        // all fields besides the primary key and two foreign keys should be parameters
-        $join_model = $this->get_join_model();
-        $standard_fields = array();
-        if ($join_model->has_primary_key_field()) {
-            $standard_fields[] = $join_model->primary_key_name();
-        }
-        if ($this->get_this_model()->has_primary_key_field()) {
-            $standard_fields[] = $this->get_this_model()->primary_key_name();
-        }
-        if ($this->get_other_model()->has_primary_key_field()) {
-            $standard_fields[] = $this->get_other_model()->primary_key_name();
-        }
-        return array_diff_key(
-            $join_model->field_settings(),
-            array_flip($standard_fields)
-        );
-    }
+	/**
+	 * Gets all the non-key fields (ie, not the primary key and not foreign keys) on the join model.
+	 * @since 4.9.76.p
+	 * @return EE_Model_Field_Base[]
+	 * @throws EE_Error
+	 */
+	public function getNonKeyFields()
+	{
+		// all fields besides the primary key and two foreign keys should be parameters
+		$join_model = $this->get_join_model();
+		$standard_fields = array();
+		if ($join_model->has_primary_key_field()) {
+			$standard_fields[] = $join_model->primary_key_name();
+		}
+		if ($this->get_this_model()->has_primary_key_field()) {
+			$standard_fields[] = $this->get_this_model()->primary_key_name();
+		}
+		if ($this->get_other_model()->has_primary_key_field()) {
+			$standard_fields[] = $this->get_other_model()->primary_key_name();
+		}
+		return array_diff_key(
+			$join_model->field_settings(),
+			array_flip($standard_fields)
+		);
+	}
 
-    /**
-     * Returns true if the join model has non-key fields (ie, fields that aren't the primary key or foreign keys.)
-     * @since 4.9.76.p
-     * @return boolean
-     */
-    public function hasNonKeyFields()
-    {
-        return count($this->get_join_model()->field_settings()) > 3;
-    }
+	/**
+	 * Returns true if the join model has non-key fields (ie, fields that aren't the primary key or foreign keys.)
+	 * @since 4.9.76.p
+	 * @return boolean
+	 */
+	public function hasNonKeyFields()
+	{
+		return count($this->get_join_model()->field_settings()) > 3;
+	}
 }

core/libraries/rest_api/controllers/model/Write.php

Indentation +546 added lines, -546 removed lines

@@ -39,573 +39,573 @@
 {
 
 
-    public function __construct()
-    {
-        parent::__construct();
-        EE_Registry::instance()->load_helper('Inflector');
-    }
+	public function __construct()
+	{
+		parent::__construct();
+		EE_Registry::instance()->load_helper('Inflector');
+	}
 
 
-    /**
-     * Handles requests to get all (or a filtered subset) of entities for a particular model
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @param string          $model_name
-     * @return WP_REST_Response|\WP_Error
-     */
-    public static function handleRequestInsert(WP_REST_Request $request, $version, $model_name)
-    {
-        $controller = new Write();
-        try {
-            $controller->setRequestedVersion($version);
-            return $controller->sendResponse(
-                $controller->insert(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
+	/**
+	 * Handles requests to get all (or a filtered subset) of entities for a particular model
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @return WP_REST_Response|\WP_Error
+	 */
+	public static function handleRequestInsert(WP_REST_Request $request, $version, $model_name)
+	{
+		$controller = new Write();
+		try {
+			$controller->setRequestedVersion($version);
+			return $controller->sendResponse(
+				$controller->insert(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
 
 
-    /**
-     * Handles a request from \WP_REST_Server to update an EE model
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @param string          $model_name
-     * @return WP_REST_Response|\WP_Error
-     */
-    public static function handleRequestUpdate(WP_REST_Request $request, $version, $model_name)
-    {
-        $controller = new Write();
-        try {
-            $controller->setRequestedVersion($version);
-            return $controller->sendResponse(
-                $controller->update(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
+	/**
+	 * Handles a request from \WP_REST_Server to update an EE model
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @return WP_REST_Response|\WP_Error
+	 */
+	public static function handleRequestUpdate(WP_REST_Request $request, $version, $model_name)
+	{
+		$controller = new Write();
+		try {
+			$controller->setRequestedVersion($version);
+			return $controller->sendResponse(
+				$controller->update(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
 
 
-    /**
-     * Deletes a single model object and returns it. Unless
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @param string          $model_name
-     * @return WP_REST_Response|\WP_Error
-     */
-    public static function handleRequestDelete(WP_REST_Request $request, $version, $model_name)
-    {
-        $controller = new Write();
-        try {
-            $controller->setRequestedVersion($version);
-            return $controller->sendResponse(
-                $controller->delete(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
+	/**
+	 * Deletes a single model object and returns it. Unless
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @return WP_REST_Response|\WP_Error
+	 */
+	public static function handleRequestDelete(WP_REST_Request $request, $version, $model_name)
+	{
+		$controller = new Write();
+		try {
+			$controller->setRequestedVersion($version);
+			return $controller->sendResponse(
+				$controller->delete(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
 
 
-    /**
-     * Inserts a new model object according to the $request
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @return array
-     * @throws EE_Error
-     * @throws RestException
-     */
-    public function insert(EEM_Base $model, WP_REST_Request $request)
-    {
-        Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'create');
-        $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (! current_user_can($default_cap_to_check_for)) {
-            throw new RestException(
-                'rest_cannot_create_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
-                sprintf(
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to insert data into Event Espresso.',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $default_cap_to_check_for
-                ),
-                array('status' => 403)
-            );
-        }
-        $submitted_json_data = array_merge((array) $request->get_body_params(), (array) $request->get_json_params());
-        $model_data = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-            $submitted_json_data,
-            $model,
-            $this->getModelVersionInfo()->requestedVersion(),
-            true
-        );
-        $model_obj = EE_Registry::instance()->load_class(
-            $model->get_this_model_name(),
-            array($model_data, $model->get_timezone()),
-            false,
-            false
-        );
-        $model_obj->save();
-        $new_id = $model_obj->ID();
-        if (! $new_id) {
-            throw new RestException(
-                'rest_insertion_failed',
-                sprintf(__('Could not insert new %1$s', 'event_espresso'), $model->get_this_model_name())
-            );
-        }
-        return $this->returnModelObjAsJsonResponse($model_obj, $request);
-    }
+	/**
+	 * Inserts a new model object according to the $request
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @return array
+	 * @throws EE_Error
+	 * @throws RestException
+	 */
+	public function insert(EEM_Base $model, WP_REST_Request $request)
+	{
+		Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'create');
+		$default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
+		if (! current_user_can($default_cap_to_check_for)) {
+			throw new RestException(
+				'rest_cannot_create_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
+				sprintf(
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to insert data into Event Espresso.',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$default_cap_to_check_for
+				),
+				array('status' => 403)
+			);
+		}
+		$submitted_json_data = array_merge((array) $request->get_body_params(), (array) $request->get_json_params());
+		$model_data = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+			$submitted_json_data,
+			$model,
+			$this->getModelVersionInfo()->requestedVersion(),
+			true
+		);
+		$model_obj = EE_Registry::instance()->load_class(
+			$model->get_this_model_name(),
+			array($model_data, $model->get_timezone()),
+			false,
+			false
+		);
+		$model_obj->save();
+		$new_id = $model_obj->ID();
+		if (! $new_id) {
+			throw new RestException(
+				'rest_insertion_failed',
+				sprintf(__('Could not insert new %1$s', 'event_espresso'), $model->get_this_model_name())
+			);
+		}
+		return $this->returnModelObjAsJsonResponse($model_obj, $request);
+	}
 
 
-    /**
-     * Updates an existing model object according to the $request
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @return array
-     * @throws EE_Error
-     */
-    public function update(EEM_Base $model, WP_REST_Request $request)
-    {
-        Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'edit');
-        $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (! current_user_can($default_cap_to_check_for)) {
-            throw new RestException(
-                'rest_cannot_edit_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
-                sprintf(
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to update data into Event Espresso.',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $default_cap_to_check_for
-                ),
-                array('status' => 403)
-            );
-        }
-        $obj_id = $request->get_param('id');
-        if (! $obj_id) {
-            throw new RestException(
-                'rest_edit_failed',
-                sprintf(__('Could not edit %1$s', 'event_espresso'), $model->get_this_model_name())
-            );
-        }
-        $model_data = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-            $this->getBodyParams($request),
-            $model,
-            $this->getModelVersionInfo()->requestedVersion(),
-            true
-        );
-        $model_obj = $model->get_one_by_ID($obj_id);
-        if (! $model_obj instanceof EE_Base_Class) {
-            $lowercase_model_name = strtolower($model->get_this_model_name());
-            throw new RestException(
-                sprintf('rest_%s_invalid_id', $lowercase_model_name),
-                sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
-                array('status' => 404)
-            );
-        }
-        $model_obj->save($model_data);
-        return $this->returnModelObjAsJsonResponse($model_obj, $request);
-    }
+	/**
+	 * Updates an existing model object according to the $request
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function update(EEM_Base $model, WP_REST_Request $request)
+	{
+		Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'edit');
+		$default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
+		if (! current_user_can($default_cap_to_check_for)) {
+			throw new RestException(
+				'rest_cannot_edit_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
+				sprintf(
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to update data into Event Espresso.',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$default_cap_to_check_for
+				),
+				array('status' => 403)
+			);
+		}
+		$obj_id = $request->get_param('id');
+		if (! $obj_id) {
+			throw new RestException(
+				'rest_edit_failed',
+				sprintf(__('Could not edit %1$s', 'event_espresso'), $model->get_this_model_name())
+			);
+		}
+		$model_data = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+			$this->getBodyParams($request),
+			$model,
+			$this->getModelVersionInfo()->requestedVersion(),
+			true
+		);
+		$model_obj = $model->get_one_by_ID($obj_id);
+		if (! $model_obj instanceof EE_Base_Class) {
+			$lowercase_model_name = strtolower($model->get_this_model_name());
+			throw new RestException(
+				sprintf('rest_%s_invalid_id', $lowercase_model_name),
+				sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
+				array('status' => 404)
+			);
+		}
+		$model_obj->save($model_data);
+		return $this->returnModelObjAsJsonResponse($model_obj, $request);
+	}
 
 
-    /**
-     * Updates an existing model object according to the $request
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @return array of either the soft-deleted item, or
-     * @throws EE_Error
-     */
-    public function delete(EEM_Base $model, WP_REST_Request $request)
-    {
-        Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_delete, 'delete');
-        $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (! current_user_can($default_cap_to_check_for)) {
-            throw new RestException(
-                'rest_cannot_delete_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
-                sprintf(
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to delete data into Event Espresso.',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $default_cap_to_check_for
-                ),
-                array('status' => 403)
-            );
-        }
-        $obj_id = $request->get_param('id');
-        // this is where we would apply more fine-grained caps
-        $model_obj = $model->get_one_by_ID($obj_id);
-        if (! $model_obj instanceof EE_Base_Class) {
-            $lowercase_model_name = strtolower($model->get_this_model_name());
-            throw new RestException(
-                sprintf('rest_%s_invalid_id', $lowercase_model_name),
-                sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
-                array('status' => 404)
-            );
-        }
-        $requested_permanent_delete = filter_var($request->get_param('force'), FILTER_VALIDATE_BOOLEAN);
-        $requested_allow_blocking = filter_var($request->get_param('allow_blocking'), FILTER_VALIDATE_BOOLEAN);
-        if ($requested_permanent_delete) {
-            $previous = $this->returnModelObjAsJsonResponse($model_obj, $request);
-            $deleted = (bool) $model->delete_permanently_by_ID($obj_id, $requested_allow_blocking);
-            return array(
-                'deleted'  => $deleted,
-                'previous' => $previous,
-            );
-        } else {
-            if ($model instanceof EEM_Soft_Delete_Base) {
-                $model->delete_by_ID($obj_id, $requested_allow_blocking);
-                return $this->returnModelObjAsJsonResponse($model_obj, $request);
-            } else {
-                throw new RestException(
-                    'rest_trash_not_supported',
-                    501,
-                    sprintf(
-                        esc_html__('%1$s do not support trashing. Set force=1 to delete.', 'event_espresso'),
-                        EEH_Inflector::pluralize($model->get_this_model_name())
-                    )
-                );
-            }
-        }
-    }
+	/**
+	 * Updates an existing model object according to the $request
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @return array of either the soft-deleted item, or
+	 * @throws EE_Error
+	 */
+	public function delete(EEM_Base $model, WP_REST_Request $request)
+	{
+		Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_delete, 'delete');
+		$default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
+		if (! current_user_can($default_cap_to_check_for)) {
+			throw new RestException(
+				'rest_cannot_delete_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
+				sprintf(
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to delete data into Event Espresso.',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$default_cap_to_check_for
+				),
+				array('status' => 403)
+			);
+		}
+		$obj_id = $request->get_param('id');
+		// this is where we would apply more fine-grained caps
+		$model_obj = $model->get_one_by_ID($obj_id);
+		if (! $model_obj instanceof EE_Base_Class) {
+			$lowercase_model_name = strtolower($model->get_this_model_name());
+			throw new RestException(
+				sprintf('rest_%s_invalid_id', $lowercase_model_name),
+				sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
+				array('status' => 404)
+			);
+		}
+		$requested_permanent_delete = filter_var($request->get_param('force'), FILTER_VALIDATE_BOOLEAN);
+		$requested_allow_blocking = filter_var($request->get_param('allow_blocking'), FILTER_VALIDATE_BOOLEAN);
+		if ($requested_permanent_delete) {
+			$previous = $this->returnModelObjAsJsonResponse($model_obj, $request);
+			$deleted = (bool) $model->delete_permanently_by_ID($obj_id, $requested_allow_blocking);
+			return array(
+				'deleted'  => $deleted,
+				'previous' => $previous,
+			);
+		} else {
+			if ($model instanceof EEM_Soft_Delete_Base) {
+				$model->delete_by_ID($obj_id, $requested_allow_blocking);
+				return $this->returnModelObjAsJsonResponse($model_obj, $request);
+			} else {
+				throw new RestException(
+					'rest_trash_not_supported',
+					501,
+					sprintf(
+						esc_html__('%1$s do not support trashing. Set force=1 to delete.', 'event_espresso'),
+						EEH_Inflector::pluralize($model->get_this_model_name())
+					)
+				);
+			}
+		}
+	}
 
 
-    /**
-     * Returns an array ready to be converted into a JSON response, based solely on the model object
-     *
-     * @param EE_Base_Class   $model_obj
-     * @param WP_REST_Request $request
-     * @return array ready for a response
-     */
-    protected function returnModelObjAsJsonResponse(EE_Base_Class $model_obj, WP_REST_Request $request)
-    {
-        $model = $model_obj->get_model();
-        // create an array exactly like the wpdb results row,
-        // so we can pass it to controllers/model/Read::create_entity_from_wpdb_result()
-        $simulated_db_row = array();
-        foreach ($model->field_settings(true) as $field_name => $field_obj) {
-            // we need to reconstruct the normal wpdb results, including the db-only fields
-            // like a secondary table's primary key. The models expect those (but don't care what value they have)
-            if ($field_obj instanceof EE_DB_Only_Field_Base) {
-                $raw_value = true;
-            } elseif ($field_obj instanceof EE_Datetime_Field) {
-                $raw_value = $model_obj->get_DateTime_object($field_name);
-            } else {
-                $raw_value = $model_obj->get_raw($field_name);
-            }
-            $simulated_db_row[ $field_obj->get_qualified_column() ] = $field_obj->prepare_for_use_in_db($raw_value);
-        }
-        $read_controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
-        $read_controller->setRequestedVersion($this->getRequestedVersion());
-        // the simulates request really doesn't need any info downstream
-        $simulated_request = new WP_REST_Request('GET');
-        // set the caps context on the simulated according to the original request.
-        switch ($request->get_method()) {
-            case 'POST':
-            case 'PUT':
-                $caps_context = EEM_Base::caps_edit;
-                break;
-            case 'DELETE':
-                $caps_context = EEM_Base::caps_delete;
-                break;
-            default:
-                $caps_context = EEM_Base::caps_read_admin;
-        }
-        $simulated_request->set_param('caps', $caps_context);
-        return $read_controller->createEntityFromWpdbResult(
-            $model_obj->get_model(),
-            $simulated_db_row,
-            $simulated_request
-        );
-    }
+	/**
+	 * Returns an array ready to be converted into a JSON response, based solely on the model object
+	 *
+	 * @param EE_Base_Class   $model_obj
+	 * @param WP_REST_Request $request
+	 * @return array ready for a response
+	 */
+	protected function returnModelObjAsJsonResponse(EE_Base_Class $model_obj, WP_REST_Request $request)
+	{
+		$model = $model_obj->get_model();
+		// create an array exactly like the wpdb results row,
+		// so we can pass it to controllers/model/Read::create_entity_from_wpdb_result()
+		$simulated_db_row = array();
+		foreach ($model->field_settings(true) as $field_name => $field_obj) {
+			// we need to reconstruct the normal wpdb results, including the db-only fields
+			// like a secondary table's primary key. The models expect those (but don't care what value they have)
+			if ($field_obj instanceof EE_DB_Only_Field_Base) {
+				$raw_value = true;
+			} elseif ($field_obj instanceof EE_Datetime_Field) {
+				$raw_value = $model_obj->get_DateTime_object($field_name);
+			} else {
+				$raw_value = $model_obj->get_raw($field_name);
+			}
+			$simulated_db_row[ $field_obj->get_qualified_column() ] = $field_obj->prepare_for_use_in_db($raw_value);
+		}
+		$read_controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
+		$read_controller->setRequestedVersion($this->getRequestedVersion());
+		// the simulates request really doesn't need any info downstream
+		$simulated_request = new WP_REST_Request('GET');
+		// set the caps context on the simulated according to the original request.
+		switch ($request->get_method()) {
+			case 'POST':
+			case 'PUT':
+				$caps_context = EEM_Base::caps_edit;
+				break;
+			case 'DELETE':
+				$caps_context = EEM_Base::caps_delete;
+				break;
+			default:
+				$caps_context = EEM_Base::caps_read_admin;
+		}
+		$simulated_request->set_param('caps', $caps_context);
+		return $read_controller->createEntityFromWpdbResult(
+			$model_obj->get_model(),
+			$simulated_db_row,
+			$simulated_request
+		);
+	}
 
 
-    /**
-     * Gets the item affected by this request
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @param  int|string     $obj_id
-     * @return \WP_Error|array
-     */
-    protected function getOneBasedOnRequest(EEM_Base $model, WP_REST_Request $request, $obj_id)
-    {
-        $requested_version = $this->getRequestedVersion($request->get_route());
-        $get_request = new WP_REST_Request(
-            'GET',
-            EED_Core_Rest_Api::ee_api_namespace
-            . $requested_version
-            . '/'
-            . EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-            . '/'
-            . $obj_id
-        );
-        $get_request->set_url_params(
-            array(
-                'id'      => $obj_id,
-                'include' => $request->get_param('include'),
-            )
-        );
-        $read_controller = new Read();
-        $read_controller->setRequestedVersion($this->getRequestedVersion());
-        return $read_controller->getEntityFromModel($model, $get_request);
-    }
+	/**
+	 * Gets the item affected by this request
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @param  int|string     $obj_id
+	 * @return \WP_Error|array
+	 */
+	protected function getOneBasedOnRequest(EEM_Base $model, WP_REST_Request $request, $obj_id)
+	{
+		$requested_version = $this->getRequestedVersion($request->get_route());
+		$get_request = new WP_REST_Request(
+			'GET',
+			EED_Core_Rest_Api::ee_api_namespace
+			. $requested_version
+			. '/'
+			. EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+			. '/'
+			. $obj_id
+		);
+		$get_request->set_url_params(
+			array(
+				'id'      => $obj_id,
+				'include' => $request->get_param('include'),
+			)
+		);
+		$read_controller = new Read();
+		$read_controller->setRequestedVersion($this->getRequestedVersion());
+		return $read_controller->getEntityFromModel($model, $get_request);
+	}
 
-    /**
-     * Adds a relation between the specified models (if it doesn't already exist.)
-     * @since 4.9.76.p
-     * @param WP_REST_Request $request
-     * @return WP_REST_Response
-     */
-    public static function handleRequestAddRelation(WP_REST_Request $request, $version, $model_name, $related_model_name)
-    {
-        $controller = new Write();
-        try {
-            $controller->setRequestedVersion($version);
-            $main_model = $controller->validateModel($model_name);
-            $controller->validateModel($related_model_name);
-            return $controller->sendResponse(
-                $controller->addRelation(
-                    $main_model,
-                    $main_model->related_settings_for($related_model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
+	/**
+	 * Adds a relation between the specified models (if it doesn't already exist.)
+	 * @since 4.9.76.p
+	 * @param WP_REST_Request $request
+	 * @return WP_REST_Response
+	 */
+	public static function handleRequestAddRelation(WP_REST_Request $request, $version, $model_name, $related_model_name)
+	{
+		$controller = new Write();
+		try {
+			$controller->setRequestedVersion($version);
+			$main_model = $controller->validateModel($model_name);
+			$controller->validateModel($related_model_name);
+			return $controller->sendResponse(
+				$controller->addRelation(
+					$main_model,
+					$main_model->related_settings_for($related_model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
 
-    /**
-     * Adds a relation between the two model specified model objects.
-     * @since 4.9.76.p
-     * @param EEM_Base $model
-     * @param EE_Model_Relation_Base $relation
-     * @param WP_REST_Request $request
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RestException
-     * @throws DomainException
-     */
-    public function addRelation(EEM_Base $model, EE_Model_Relation_Base $relation, WP_REST_Request $request)
-    {
-        list($model_obj, $other_obj) = $this->getBothModelObjects($model, $relation, $request);
-        $extra_params = array();
-        if ($relation instanceof EE_HABTM_Relation) {
-            $extra_params = array_intersect_key(
-                ModelDataTranslator::prepareConditionsQueryParamsForModels(
-                    $request->get_body_params(),
-                    $relation->get_join_model(),
-                    $this->getModelVersionInfo()->requestedVersion(),
-                    true
-                ),
-                $relation->getNonKeyFields()
-            );
-        }
-        // Add a relation.
-        $related_obj = $model_obj->_add_relation_to(
-            $other_obj,
-            $relation->get_other_model()->get_this_model_name(),
-            $extra_params
-        );
-        $response = array(
-            strtolower($model->get_this_model_name()) => $this->returnModelObjAsJsonResponse($model_obj, $request),
-            strtolower($relation->get_other_model()->get_this_model_name()) => $this->returnModelObjAsJsonResponse($related_obj, $request),
-        );
-        if ($relation instanceof EE_HABTM_Relation) {
-            $join_model_obj = $relation->get_join_model()->get_one(
-                array(
-                    array(
-                        $model->primary_key_name() => $model_obj->ID(),
-                        $relation->get_other_model()->primary_key_name() => $related_obj->ID()
-                    )
-                )
-            );
-            $response['join'][ strtolower($relation->get_join_model()->get_this_model_name()) ] = $this->returnModelObjAsJsonResponse($join_model_obj, $request);
-        }
-        return $response;
-    }
+	/**
+	 * Adds a relation between the two model specified model objects.
+	 * @since 4.9.76.p
+	 * @param EEM_Base $model
+	 * @param EE_Model_Relation_Base $relation
+	 * @param WP_REST_Request $request
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RestException
+	 * @throws DomainException
+	 */
+	public function addRelation(EEM_Base $model, EE_Model_Relation_Base $relation, WP_REST_Request $request)
+	{
+		list($model_obj, $other_obj) = $this->getBothModelObjects($model, $relation, $request);
+		$extra_params = array();
+		if ($relation instanceof EE_HABTM_Relation) {
+			$extra_params = array_intersect_key(
+				ModelDataTranslator::prepareConditionsQueryParamsForModels(
+					$request->get_body_params(),
+					$relation->get_join_model(),
+					$this->getModelVersionInfo()->requestedVersion(),
+					true
+				),
+				$relation->getNonKeyFields()
+			);
+		}
+		// Add a relation.
+		$related_obj = $model_obj->_add_relation_to(
+			$other_obj,
+			$relation->get_other_model()->get_this_model_name(),
+			$extra_params
+		);
+		$response = array(
+			strtolower($model->get_this_model_name()) => $this->returnModelObjAsJsonResponse($model_obj, $request),
+			strtolower($relation->get_other_model()->get_this_model_name()) => $this->returnModelObjAsJsonResponse($related_obj, $request),
+		);
+		if ($relation instanceof EE_HABTM_Relation) {
+			$join_model_obj = $relation->get_join_model()->get_one(
+				array(
+					array(
+						$model->primary_key_name() => $model_obj->ID(),
+						$relation->get_other_model()->primary_key_name() => $related_obj->ID()
+					)
+				)
+			);
+			$response['join'][ strtolower($relation->get_join_model()->get_this_model_name()) ] = $this->returnModelObjAsJsonResponse($join_model_obj, $request);
+		}
+		return $response;
+	}
 
 
-    /**
-     * Removes the relation between the specified models (if it exists).
-     * @since 4.9.76.p
-     * @param WP_REST_Request $request
-     * @return WP_REST_Response
-     */
-    public static function handleRequestRemoveRelation(WP_REST_Request $request, $version, $model_name, $related_model_name)
-    {
-        $controller = new Write();
-        try {
-            $controller->setRequestedVersion($version);
-            $main_model = $controller->getModelVersionInfo()->loadModel($model_name);
-            return $controller->sendResponse(
-                $controller->removeRelation(
-                    $main_model,
-                    $main_model->related_settings_for($related_model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
+	/**
+	 * Removes the relation between the specified models (if it exists).
+	 * @since 4.9.76.p
+	 * @param WP_REST_Request $request
+	 * @return WP_REST_Response
+	 */
+	public static function handleRequestRemoveRelation(WP_REST_Request $request, $version, $model_name, $related_model_name)
+	{
+		$controller = new Write();
+		try {
+			$controller->setRequestedVersion($version);
+			$main_model = $controller->getModelVersionInfo()->loadModel($model_name);
+			return $controller->sendResponse(
+				$controller->removeRelation(
+					$main_model,
+					$main_model->related_settings_for($related_model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
 
-    /**
-     * Adds a relation between the two model specified model objects.
-     * @since 4.9.76.p
-     * @param EEM_Base $model
-     * @param EE_Model_Relation_Base $relation
-     * @param WP_REST_Request $request
-     * @return array
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RestException
-     */
-    public function removeRelation(EEM_Base $model, EE_Model_Relation_Base $relation, WP_REST_Request $request)
-    {
-        // This endpoint doesn't accept body parameters (it's understandable to think it might, so let developers know
-        // up-front that it doesn't.)
-        if (!empty($request->get_body_params())) {
-            $body_params = $request->get_body_params();
-            throw new RestException(
-                'invalid_field',
-                sprintf(
-                    esc_html__('This endpoint doesn\'t accept post body arguments, you sent in %1$s', 'event_espresso'),
-                    implode(array_keys($body_params))
-                )
-            );
-        }
-        list($model_obj, $other_obj) = $this->getBothModelObjects($model, $relation, $request);
-        // Remember the old relation, if it used a join entry.
-        $join_model_obj = null;
-        if ($relation instanceof EE_HABTM_Relation) {
-            $join_model_obj = $relation->get_join_model()->get_one(
-                array(
-                    array(
-                        $model->primary_key_name() => $model_obj->ID(),
-                        $relation->get_other_model()->primary_key_name() => $other_obj->ID()
-                    )
-                )
-            );
-        }
-        // Remove the relation.
-        $related_obj = $model_obj->_remove_relation_to(
-            $other_obj,
-            $relation->get_other_model()->get_this_model_name()
-        );
-        $response = array(
-            strtolower($model->get_this_model_name()) => $this->returnModelObjAsJsonResponse($model_obj, $request),
-            strtolower($relation->get_other_model()->get_this_model_name()) => $this->returnModelObjAsJsonResponse($related_obj, $request),
-        );
-        if ($relation instanceof EE_HABTM_Relation) {
-            $join_model_obj_after_removal = $relation->get_join_model()->get_one(
-                array(
-                    array(
-                        $model->primary_key_name() => $model_obj->ID(),
-                        $relation->get_other_model()->primary_key_name() => $other_obj->ID()
-                    )
-                )
-            );
-            if ($join_model_obj instanceof EE_Base_Class) {
-                $response['join'][ strtolower($relation->get_join_model()->get_this_model_name()) ] = $this->returnModelObjAsJsonResponse($join_model_obj, $request);
-            } else {
-                $response['join'][ strtolower($relation->get_join_model()->get_this_model_name()) ] = null;
-            }
-        }
-        return $response;
-    }
+	/**
+	 * Adds a relation between the two model specified model objects.
+	 * @since 4.9.76.p
+	 * @param EEM_Base $model
+	 * @param EE_Model_Relation_Base $relation
+	 * @param WP_REST_Request $request
+	 * @return array
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RestException
+	 */
+	public function removeRelation(EEM_Base $model, EE_Model_Relation_Base $relation, WP_REST_Request $request)
+	{
+		// This endpoint doesn't accept body parameters (it's understandable to think it might, so let developers know
+		// up-front that it doesn't.)
+		if (!empty($request->get_body_params())) {
+			$body_params = $request->get_body_params();
+			throw new RestException(
+				'invalid_field',
+				sprintf(
+					esc_html__('This endpoint doesn\'t accept post body arguments, you sent in %1$s', 'event_espresso'),
+					implode(array_keys($body_params))
+				)
+			);
+		}
+		list($model_obj, $other_obj) = $this->getBothModelObjects($model, $relation, $request);
+		// Remember the old relation, if it used a join entry.
+		$join_model_obj = null;
+		if ($relation instanceof EE_HABTM_Relation) {
+			$join_model_obj = $relation->get_join_model()->get_one(
+				array(
+					array(
+						$model->primary_key_name() => $model_obj->ID(),
+						$relation->get_other_model()->primary_key_name() => $other_obj->ID()
+					)
+				)
+			);
+		}
+		// Remove the relation.
+		$related_obj = $model_obj->_remove_relation_to(
+			$other_obj,
+			$relation->get_other_model()->get_this_model_name()
+		);
+		$response = array(
+			strtolower($model->get_this_model_name()) => $this->returnModelObjAsJsonResponse($model_obj, $request),
+			strtolower($relation->get_other_model()->get_this_model_name()) => $this->returnModelObjAsJsonResponse($related_obj, $request),
+		);
+		if ($relation instanceof EE_HABTM_Relation) {
+			$join_model_obj_after_removal = $relation->get_join_model()->get_one(
+				array(
+					array(
+						$model->primary_key_name() => $model_obj->ID(),
+						$relation->get_other_model()->primary_key_name() => $other_obj->ID()
+					)
+				)
+			);
+			if ($join_model_obj instanceof EE_Base_Class) {
+				$response['join'][ strtolower($relation->get_join_model()->get_this_model_name()) ] = $this->returnModelObjAsJsonResponse($join_model_obj, $request);
+			} else {
+				$response['join'][ strtolower($relation->get_join_model()->get_this_model_name()) ] = null;
+			}
+		}
+		return $response;
+	}
 
-    /**
-     * Gets the model objects indicated by the model, relation object, and request.
-     * Throws an exception if the first object doesn't exist, and currently if the related object also doesn't exist.
-     * However, this behaviour may change, as we may add support for simultaneously creating and relating data.
-     * @since 4.9.76.p
-     * @param EEM_Base $model
-     * @param EE_Model_Relation_Base $relation
-     * @param WP_REST_Request $request
-     * @return array {
-     * @type EE_Base_Class $model_obj
-     * @type EE_Base_Class|null $other_model_obj
-     * }
-     * @throws RestException
-     */
-    protected function getBothModelObjects(EEM_Base $model, EE_Model_Relation_Base $relation, WP_REST_Request $request)
-    {
-        // Check generic caps. For now, we're only allowing access to this endpoint to full admins.
-        Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'edit');
-        $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (! current_user_can($default_cap_to_check_for)) {
-            throw new RestException(
-                'rest_cannot_edit_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
-                sprintf(
-                    esc_html__(
-                        // @codingStandardsIgnoreStart
-                        'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to add relations in Event Espresso.',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $default_cap_to_check_for
-                ),
-                array('status' => 403)
-            );
-        }
-        // Get the main model object.
-        $model_obj = $this->getOneOrThrowException($model, $request->get_param('id'));
-        // For now, we require the other model object to exist too. This might be relaxed later.
-        $other_obj = $this->getOneOrThrowException($relation->get_other_model(), $request->get_param('related_id'));
-        return array($model_obj,$other_obj);
-    }
+	/**
+	 * Gets the model objects indicated by the model, relation object, and request.
+	 * Throws an exception if the first object doesn't exist, and currently if the related object also doesn't exist.
+	 * However, this behaviour may change, as we may add support for simultaneously creating and relating data.
+	 * @since 4.9.76.p
+	 * @param EEM_Base $model
+	 * @param EE_Model_Relation_Base $relation
+	 * @param WP_REST_Request $request
+	 * @return array {
+	 * @type EE_Base_Class $model_obj
+	 * @type EE_Base_Class|null $other_model_obj
+	 * }
+	 * @throws RestException
+	 */
+	protected function getBothModelObjects(EEM_Base $model, EE_Model_Relation_Base $relation, WP_REST_Request $request)
+	{
+		// Check generic caps. For now, we're only allowing access to this endpoint to full admins.
+		Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'edit');
+		$default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
+		if (! current_user_can($default_cap_to_check_for)) {
+			throw new RestException(
+				'rest_cannot_edit_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
+				sprintf(
+					esc_html__(
+						// @codingStandardsIgnoreStart
+						'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to add relations in Event Espresso.',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$default_cap_to_check_for
+				),
+				array('status' => 403)
+			);
+		}
+		// Get the main model object.
+		$model_obj = $this->getOneOrThrowException($model, $request->get_param('id'));
+		// For now, we require the other model object to exist too. This might be relaxed later.
+		$other_obj = $this->getOneOrThrowException($relation->get_other_model(), $request->get_param('related_id'));
+		return array($model_obj,$other_obj);
+	}
 
-    /**
-     * Gets the model with that ID or throws a REST exception.
-     * @since 4.9.76.p
-     * @param EEM_Base $model
-     * @param $id
-     * @return EE_Base_Class
-     * @throws RestException
-     */
-    protected function getOneOrThrowException(EEM_Base $model, $id)
-    {
-        $model_obj = $model->get_one_by_ID($id);
-        // @todo: check they can permission for it. For now unnecessary because only full admins can use this endpoint.
-        if ($model_obj instanceof EE_Base_Class) {
-            return $model_obj;
-        }
-        $lowercase_model_name = strtolower($model->get_this_model_name());
-        throw new RestException(
-            sprintf('rest_%s_invalid_id', $lowercase_model_name),
-            sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
-            array('status' => 404)
-        );
-    }
+	/**
+	 * Gets the model with that ID or throws a REST exception.
+	 * @since 4.9.76.p
+	 * @param EEM_Base $model
+	 * @param $id
+	 * @return EE_Base_Class
+	 * @throws RestException
+	 */
+	protected function getOneOrThrowException(EEM_Base $model, $id)
+	{
+		$model_obj = $model->get_one_by_ID($id);
+		// @todo: check they can permission for it. For now unnecessary because only full admins can use this endpoint.
+		if ($model_obj instanceof EE_Base_Class) {
+			return $model_obj;
+		}
+		$lowercase_model_name = strtolower($model->get_this_model_name());
+		throw new RestException(
+			sprintf('rest_%s_invalid_id', $lowercase_model_name),
+			sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
+			array('status' => 404)
+		);
+	}
 }

core/libraries/rest_api/controllers/model/Base.php

Indentation +80 added lines, -80 removed lines

@@ -18,95 +18,95 @@
 class Base extends Controller_Base
 {
 
-    /**
-     * Holds reference to the model version info, which knows the requested version
-     *
-     * @var ModelVersionInfo
-     */
-    protected $model_version_info;
+	/**
+	 * Holds reference to the model version info, which knows the requested version
+	 *
+	 * @var ModelVersionInfo
+	 */
+	protected $model_version_info;
 
 
 
-    /**
-     * Sets the version the user requested
-     *
-     * @param string $version eg '4.8'
-     */
-    public function setRequestedVersion($version)
-    {
-        parent::setRequestedVersion($version);
-        $this->model_version_info = new ModelVersionInfo($version);
-    }
+	/**
+	 * Sets the version the user requested
+	 *
+	 * @param string $version eg '4.8'
+	 */
+	public function setRequestedVersion($version)
+	{
+		parent::setRequestedVersion($version);
+		$this->model_version_info = new ModelVersionInfo($version);
+	}
 
 
 
-    /**
-     * Gets the object that should be used for getting any info from the models,
-     * because it's takes the requested and current core version into account
-     *
-     * @return \EventEspresso\core\libraries\rest_api\ModelVersionInfo
-     * @throws EE_Error
-     */
-    public function getModelVersionInfo()
-    {
-        if (! $this->model_version_info) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'Cannot use model version info before setting the requested version in the controller',
-                        'event_espresso'
-                    )
-                )
-            );
-        }
-        return $this->model_version_info;
-    }
+	/**
+	 * Gets the object that should be used for getting any info from the models,
+	 * because it's takes the requested and current core version into account
+	 *
+	 * @return \EventEspresso\core\libraries\rest_api\ModelVersionInfo
+	 * @throws EE_Error
+	 */
+	public function getModelVersionInfo()
+	{
+		if (! $this->model_version_info) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'Cannot use model version info before setting the requested version in the controller',
+						'event_espresso'
+					)
+				)
+			);
+		}
+		return $this->model_version_info;
+	}
 
 
 
-    /**
-     * Determines if $object is of one of the classes of $classes. Similar to
-     * in_array(), except this checks if $object is a subclass of the classnames provided
-     * in $classnames
-     *
-     * @param object $object
-     * @param array  $classnames
-     * @return boolean
-     */
-    public function isSubclassOfOne($object, $classnames)
-    {
-        foreach ($classnames as $classname) {
-            if (is_a($object, $classname)) {
-                return true;
-            }
-        }
-        return false;
-    }
+	/**
+	 * Determines if $object is of one of the classes of $classes. Similar to
+	 * in_array(), except this checks if $object is a subclass of the classnames provided
+	 * in $classnames
+	 *
+	 * @param object $object
+	 * @param array  $classnames
+	 * @return boolean
+	 */
+	public function isSubclassOfOne($object, $classnames)
+	{
+		foreach ($classnames as $classname) {
+			if (is_a($object, $classname)) {
+				return true;
+			}
+		}
+		return false;
+	}
 
-    /**
-     * Verifies the model name provided was valid. If so, returns the model (as an object). Otherwise, throws an
-     * exception. Must be called after `setRequestedVersion()`.
-     * @since 4.9.76.p
-     * @param $model_name
-     * @return EEM_Base
-     * @throws EE_Error
-     * @throws RestException
-     */
-    protected function validateModel($model_name)
-    {
-        if (! $this->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-            throw new RestException(
-                'endpoint_parsing_error',
-                sprintf(
-                    __(
-                        'There is no model for endpoint %s. Please contact event espresso support',
-                        'event_espresso'
-                    ),
-                    $model_name
-                )
-            );
-        }
-        return $this->getModelVersionInfo()->loadModel($model_name);
-    }
+	/**
+	 * Verifies the model name provided was valid. If so, returns the model (as an object). Otherwise, throws an
+	 * exception. Must be called after `setRequestedVersion()`.
+	 * @since 4.9.76.p
+	 * @param $model_name
+	 * @return EEM_Base
+	 * @throws EE_Error
+	 * @throws RestException
+	 */
+	protected function validateModel($model_name)
+	{
+		if (! $this->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+			throw new RestException(
+				'endpoint_parsing_error',
+				sprintf(
+					__(
+						'There is no model for endpoint %s. Please contact event espresso support',
+						'event_espresso'
+					),
+					$model_name
+				)
+			);
+		}
+		return $this->getModelVersionInfo()->loadModel($model_name);
+	}
 }
 // End of file Base.php

core/domain/services/admin/ajax/WordpressHeartbeat.php

Indentation +41 added lines, -41 removed lines

@@ -17,50 +17,50 @@
 class WordpressHeartbeat
 {
 
-    /**
-     * @var LoaderInterface $loader
-     */
-    protected $loader;
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	protected $loader;
 
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
 
 
-    /**
-     * WordpressHeartbeat constructor.
-     *
-     * @param LoaderInterface  $loader
-     * @param RequestInterface $request
-     */
-    public function __construct(
-        LoaderInterface $loader,
-        RequestInterface $request
-    ) {
-        $this->loader = $loader;
-        $this->request = $request;
-        do_action('AHEE__EventEspresso_core_domain_services_admin_ajax_WordpressHeartbeat__constructor', $this);
-        add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'resolveRoutes'));
-    }
+	/**
+	 * WordpressHeartbeat constructor.
+	 *
+	 * @param LoaderInterface  $loader
+	 * @param RequestInterface $request
+	 */
+	public function __construct(
+		LoaderInterface $loader,
+		RequestInterface $request
+	) {
+		$this->loader = $loader;
+		$this->request = $request;
+		do_action('AHEE__EventEspresso_core_domain_services_admin_ajax_WordpressHeartbeat__constructor', $this);
+		add_action('AHEE__EE_System__core_loaded_and_ready', array($this, 'resolveRoutes'));
+	}
 
 
-    /**
-     * @since 4.9.76.p
-     * @throws InvalidClassException
-     */
-    public function resolveRoutes()
-    {
-        $screenID = $this->request->getRequestParam('screen_id');
-        $heartbeat_data = $this->request->getRequestParam('data', []);
-        if ($screenID === 'espresso_events') {
-            $this->loader->getShared(
-                'EventEspresso\core\domain\services\admin\ajax\EventEditorHeartbeat'
-            );
-        } elseif ($screenID === 'front' && ! empty($heartbeat_data['espresso_thank_you_page'])) {
-            $this->loader->getShared(
-                'EventEspresso\core\domain\services\admin\ajax\ThankYouPageIpnMonitor'
-            );
-        }
-    }
+	/**
+	 * @since 4.9.76.p
+	 * @throws InvalidClassException
+	 */
+	public function resolveRoutes()
+	{
+		$screenID = $this->request->getRequestParam('screen_id');
+		$heartbeat_data = $this->request->getRequestParam('data', []);
+		if ($screenID === 'espresso_events') {
+			$this->loader->getShared(
+				'EventEspresso\core\domain\services\admin\ajax\EventEditorHeartbeat'
+			);
+		} elseif ($screenID === 'front' && ! empty($heartbeat_data['espresso_thank_you_page'])) {
+			$this->loader->getShared(
+				'EventEspresso\core\domain\services\admin\ajax\ThankYouPageIpnMonitor'
+			);
+		}
+	}
 }

core/services/address/CountrySubRegionDao.php

Indentation +223 added lines, -223 removed lines

@@ -26,248 +26,248 @@
 class CountrySubRegionDao
 {
 
-    const REPO_URL = 'https://raw.githubusercontent.com/eventespresso/countries-and-subregions/master/';
+	const REPO_URL = 'https://raw.githubusercontent.com/eventespresso/countries-and-subregions/master/';
 
-    const OPTION_NAME_COUNTRY_DATA_VERSION = 'espresso-country-sub-region-data-version';
+	const OPTION_NAME_COUNTRY_DATA_VERSION = 'espresso-country-sub-region-data-version';
 
-    /**
-     * @var EEM_State $state_model
-     */
-    private $state_model;
+	/**
+	 * @var EEM_State $state_model
+	 */
+	private $state_model;
 
-    /**
-     * @var JsonValidator $json_validator
-     */
-    private $json_validator;
+	/**
+	 * @var JsonValidator $json_validator
+	 */
+	private $json_validator;
 
-    /**
-     * @var string $data_version
-     */
-    private $data_version;
+	/**
+	 * @var string $data_version
+	 */
+	private $data_version;
 
-    /**
-     * @var array $countries
-     */
-    private $countries = array();
+	/**
+	 * @var array $countries
+	 */
+	private $countries = array();
 
 
-    /**
-     * CountrySubRegionDao constructor.
-     *
-     * @param EEM_State     $state_model
-     * @param JsonValidator $json_validator
-     */
-    public function __construct(EEM_State $state_model, JsonValidator $json_validator)
-    {
-        $this->state_model = $state_model;
-        $this->json_validator = $json_validator;
-    }
+	/**
+	 * CountrySubRegionDao constructor.
+	 *
+	 * @param EEM_State     $state_model
+	 * @param JsonValidator $json_validator
+	 */
+	public function __construct(EEM_State $state_model, JsonValidator $json_validator)
+	{
+		$this->state_model = $state_model;
+		$this->json_validator = $json_validator;
+	}
 
 
-    /**
-     * @param EE_Country $country_object
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function saveCountrySubRegions(EE_Country $country_object)
-    {
-        $CNT_ISO = $country_object->ID();
-        $has_sub_regions = $this->state_model->count(array(array('Country.CNT_ISO' => $CNT_ISO)));
-        $data = [];
-        if (empty($this->countries)) {
-            $this->data_version = $this->getCountrySubRegionDataVersion();
-            $data = $this->retrieveJsonData(self::REPO_URL . 'countries.json');
-        }
-        if (empty($data)) {
-            EE_Error::add_error(
-                'Country Subregion Data could not be retrieved',
-                __FILE__,
-                __METHOD__,
-                __LINE__
-            );
-        }
-        if (! $has_sub_regions
-            || (isset($data->version) && version_compare($data->version, $this->data_version))
-        ) {
-            if (isset($data->countries)
-                && $this->processCountryData($CNT_ISO, $data->countries) > 0
-            ) {
-                $this->countries = $data->countries;
-                $this->updateCountrySubRegionDataVersion($data->version);
-                return true;
-            }
-        }
-        return false;
-    }
+	/**
+	 * @param EE_Country $country_object
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function saveCountrySubRegions(EE_Country $country_object)
+	{
+		$CNT_ISO = $country_object->ID();
+		$has_sub_regions = $this->state_model->count(array(array('Country.CNT_ISO' => $CNT_ISO)));
+		$data = [];
+		if (empty($this->countries)) {
+			$this->data_version = $this->getCountrySubRegionDataVersion();
+			$data = $this->retrieveJsonData(self::REPO_URL . 'countries.json');
+		}
+		if (empty($data)) {
+			EE_Error::add_error(
+				'Country Subregion Data could not be retrieved',
+				__FILE__,
+				__METHOD__,
+				__LINE__
+			);
+		}
+		if (! $has_sub_regions
+			|| (isset($data->version) && version_compare($data->version, $this->data_version))
+		) {
+			if (isset($data->countries)
+				&& $this->processCountryData($CNT_ISO, $data->countries) > 0
+			) {
+				$this->countries = $data->countries;
+				$this->updateCountrySubRegionDataVersion($data->version);
+				return true;
+			}
+		}
+		return false;
+	}
 
 
-    /**
-     * @since 4.9.70.p
-     * @return string
-     */
-    private function getCountrySubRegionDataVersion()
-    {
-        return get_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, null);
-    }
+	/**
+	 * @since 4.9.70.p
+	 * @return string
+	 */
+	private function getCountrySubRegionDataVersion()
+	{
+		return get_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, null);
+	}
 
 
-    /**
-     * @param string $version
-     */
-    private function updateCountrySubRegionDataVersion($version = '')
-    {
-        // add version option if it has never been added before, or update existing
-        if ($this->data_version === null) {
-            add_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, $version, '', false);
-        } else {
-            update_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, $version);
-        }
-    }
+	/**
+	 * @param string $version
+	 */
+	private function updateCountrySubRegionDataVersion($version = '')
+	{
+		// add version option if it has never been added before, or update existing
+		if ($this->data_version === null) {
+			add_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, $version, '', false);
+		} else {
+			update_option(self::OPTION_NAME_COUNTRY_DATA_VERSION, $version);
+		}
+	}
 
 
-    /**
-     * @param string $CNT_ISO
-     * @param array  $countries
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.9.70.p
-     */
-    private function processCountryData($CNT_ISO, $countries = array())
-    {
-        if (! empty($countries)) {
-            foreach ($countries as $key => $country) {
-                if ($country instanceof stdClass
-                    && $country->code === $CNT_ISO
-                    && empty($country->sub_regions)
-                    && ! empty($country->filename)
-                ) {
-                    $country->sub_regions = $this->retrieveJsonData(
-                        self::REPO_URL . 'countries/' . $country->filename . '.json'
-                    );
-                    return $this->saveSubRegionData($country, $country->sub_regions);
-                }
-            }
-        }
-        return 0;
-    }
+	/**
+	 * @param string $CNT_ISO
+	 * @param array  $countries
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.9.70.p
+	 */
+	private function processCountryData($CNT_ISO, $countries = array())
+	{
+		if (! empty($countries)) {
+			foreach ($countries as $key => $country) {
+				if ($country instanceof stdClass
+					&& $country->code === $CNT_ISO
+					&& empty($country->sub_regions)
+					&& ! empty($country->filename)
+				) {
+					$country->sub_regions = $this->retrieveJsonData(
+						self::REPO_URL . 'countries/' . $country->filename . '.json'
+					);
+					return $this->saveSubRegionData($country, $country->sub_regions);
+				}
+			}
+		}
+		return 0;
+	}
 
 
-    /**
-     * @param string $url
-     * @return array
-     */
-    private function retrieveJsonData($url)
-    {
-        if (empty($url)) {
-            EE_Error::add_error(
-                'No URL was provided!',
-                __FILE__,
-                __METHOD__,
-                __LINE__
-            );
-            return array();
-        }
-        $request = wp_safe_remote_get($url);
-        if ($request instanceof WP_Error) {
-            EE_Error::add_error(
-                $request->get_error_message(),
-                __FILE__,
-                __METHOD__,
-                __LINE__
-            );
-            return array();
-        }
-        $body = wp_remote_retrieve_body($request);
-        $json = json_decode($body);
-        if ($this->json_validator->isValid(__FILE__, __METHOD__, __LINE__)) {
-            return $json;
-        }
-        return array();
-    }
+	/**
+	 * @param string $url
+	 * @return array
+	 */
+	private function retrieveJsonData($url)
+	{
+		if (empty($url)) {
+			EE_Error::add_error(
+				'No URL was provided!',
+				__FILE__,
+				__METHOD__,
+				__LINE__
+			);
+			return array();
+		}
+		$request = wp_safe_remote_get($url);
+		if ($request instanceof WP_Error) {
+			EE_Error::add_error(
+				$request->get_error_message(),
+				__FILE__,
+				__METHOD__,
+				__LINE__
+			);
+			return array();
+		}
+		$body = wp_remote_retrieve_body($request);
+		$json = json_decode($body);
+		if ($this->json_validator->isValid(__FILE__, __METHOD__, __LINE__)) {
+			return $json;
+		}
+		return array();
+	}
 
 
-    /**
-     * @param stdClass $country
-     * @param array    $sub_regions
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function saveSubRegionData(stdClass $country, $sub_regions = array())
-    {
-        $results = 0;
-        if (is_array($sub_regions)) {
-            $existing_sub_regions = $this->getExistingStateAbbreviations($country->code);
-            foreach ($sub_regions as $sub_region) {
-                // remove country code from sub region code
-                $abbrev = str_replace(
-                    $country->code . '-',
-                    '',
-                    sanitize_text_field($sub_region->code)
-                );
-                // but NOT if sub region code results in only a number
-                if (absint($abbrev) !== 0) {
-                    $abbrev = sanitize_text_field($sub_region->code);
-                }
-                if (! in_array($abbrev, $existing_sub_regions, true)
-                    && $this->state_model->insert(
-                        [
-                            // STA_ID CNT_ISO STA_abbrev STA_name STA_active
-                            'CNT_ISO'    => $country->code,
-                            'STA_abbrev' => $abbrev,
-                            'STA_name'   => sanitize_text_field($sub_region->name),
-                            'STA_active' => 1,
-                        ]
-                    )
-                ) {
-                    $results++;
-                }
-            }
-        }
-        return $results;
-    }
+	/**
+	 * @param stdClass $country
+	 * @param array    $sub_regions
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function saveSubRegionData(stdClass $country, $sub_regions = array())
+	{
+		$results = 0;
+		if (is_array($sub_regions)) {
+			$existing_sub_regions = $this->getExistingStateAbbreviations($country->code);
+			foreach ($sub_regions as $sub_region) {
+				// remove country code from sub region code
+				$abbrev = str_replace(
+					$country->code . '-',
+					'',
+					sanitize_text_field($sub_region->code)
+				);
+				// but NOT if sub region code results in only a number
+				if (absint($abbrev) !== 0) {
+					$abbrev = sanitize_text_field($sub_region->code);
+				}
+				if (! in_array($abbrev, $existing_sub_regions, true)
+					&& $this->state_model->insert(
+						[
+							// STA_ID CNT_ISO STA_abbrev STA_name STA_active
+							'CNT_ISO'    => $country->code,
+							'STA_abbrev' => $abbrev,
+							'STA_name'   => sanitize_text_field($sub_region->name),
+							'STA_active' => 1,
+						]
+					)
+				) {
+					$results++;
+				}
+			}
+		}
+		return $results;
+	}
 
 
-    /**
-     * @param string $CNT_ISO
-     * @since 4.9.76.p
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function getExistingStateAbbreviations($CNT_ISO)
-    {
-        $existing_sub_region_IDs = [];
-        $existing_sub_regions = $this->state_model->get_all(array(
-            array(
-                'Country.CNT_ISO' => array(
-                    'IN',
-                    [$CNT_ISO]
-                )
-            ),
-            'order_by' => array('Country.CNT_name' => 'ASC', 'STA_name' => 'ASC')
-        ));
-        if (is_array($existing_sub_regions)) {
-            foreach ($existing_sub_regions as $existing_sub_region) {
-                if ($existing_sub_region instanceof EE_State) {
-                    $existing_sub_region_IDs[] = $existing_sub_region->abbrev();
-                }
-            }
-        }
-        return $existing_sub_region_IDs;
-    }
+	/**
+	 * @param string $CNT_ISO
+	 * @since 4.9.76.p
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function getExistingStateAbbreviations($CNT_ISO)
+	{
+		$existing_sub_region_IDs = [];
+		$existing_sub_regions = $this->state_model->get_all(array(
+			array(
+				'Country.CNT_ISO' => array(
+					'IN',
+					[$CNT_ISO]
+				)
+			),
+			'order_by' => array('Country.CNT_name' => 'ASC', 'STA_name' => 'ASC')
+		));
+		if (is_array($existing_sub_regions)) {
+			foreach ($existing_sub_regions as $existing_sub_region) {
+				if ($existing_sub_region instanceof EE_State) {
+					$existing_sub_region_IDs[] = $existing_sub_region->abbrev();
+				}
+			}
+		}
+		return $existing_sub_region_IDs;
+	}
 }