eventespresso / event-espresso-core

core/libraries/messages/EE_Message_Generated_From_Token.php

Spacing +2 added lines, -2 removed lines

@@ -93,7 +93,7 @@ 
             return $this->_message;
         }
         $message = EEM_Message::instance()->get_one_by_token($this->token);
-        if (! $message instanceof EE_Message) {
+        if ( ! $message instanceof EE_Message) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('Unable to retrieve generated message from DB using given token: "%1$s"', 'event_espresso'),
@@ -103,7 +103,7 @@ 
         }
         $message->set_STS_ID(EEM_Message::status_idle);
 
-        if (! $this->_sending_messenger instanceof EE_messenger) {
+        if ( ! $this->_sending_messenger instanceof EE_messenger) {
             $message->set_STS_ID(EEM_Message::status_failed);
             $message->set_error_message(
                 sprintf(

Indentation +107 added lines, -107 removed lines

@@ -11,111 +11,111 @@
  */
 class EE_Message_Generated_From_Token extends EE_Message_To_Generate implements EEI_Has_Sending_Messenger
 {
-    /**
-     * Sending messenger
-     *
-     * @type EE_messenger | string
-     */
-    protected $_sending_messenger = '';
-
-
-    /**
-     * Holds the incoming token;
-     * @type string
-     */
-    public $token = '';
-
-
-    /**
-     * Constructor
-     *
-     * @param   string    $sending_messenger_slug     This is used to set what messenger is used to "send"
-     *                                                the EE_Message retrieved from the DB via the given token.
-     * @param   string $token                         This is a token for a Message that should already exist int the db.
-     *                                                This is then used to populate the properties in here.
-     * @param   EE_Message_Resource_Manager $message_resource_manager
-     */
-    public function __construct($token, $sending_messenger_slug, EE_Message_Resource_Manager $message_resource_manager)
-    {
-        $this->token = $token;
-        $this->_sending_messenger = $this->_set_sending_messenger($sending_messenger_slug, $message_resource_manager);
-        $this->_message = $this->_generate_message();
-        // set params for parent from the message object
-        parent::__construct(
-            $this->_message->messenger(),
-            $this->_message->message_type(),
-            array(),
-            $this->_message->context(),
-            false
-        );
-    }
-
-
-
-    /**
-     * @param string                       $sending_messenger_slug
-     * @param \EE_Message_Resource_Manager $message_resource_manager
-     * @return \EE_messenger | string
-     */
-    protected function _set_sending_messenger(
-        $sending_messenger_slug,
-        EE_Message_Resource_Manager $message_resource_manager
-    ) {
-        $sending_messenger = $message_resource_manager->get_active_messenger($sending_messenger_slug);
-        return $sending_messenger instanceof EE_messenger ? $sending_messenger : $sending_messenger_slug;
-    }
-
-
-
-    /**
-     * @return EE_messenger
-     */
-    public function sending_messenger()
-    {
-        return $this->_sending_messenger;
-    }
-
-
-
-    /**
-     * generates an EE_Message using the supplied arguments and some defaults
-     *
-     * @param array $properties
-     * @return EE_Message
-     * @throws \EE_Error
-     */
-    protected function _generate_message($properties = array())
-    {
-        // a message was generated immediately but the parent class will call this again
-        if ($this->_message instanceof EE_Message) {
-            return $this->_message;
-        }
-        $message = EEM_Message::instance()->get_one_by_token($this->token);
-        if (! $message instanceof EE_Message) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('Unable to retrieve generated message from DB using given token: "%1$s"', 'event_espresso'),
-                    $this->token
-                )
-            );
-        }
-        $message->set_STS_ID(EEM_Message::status_idle);
-
-        if (! $this->_sending_messenger instanceof EE_messenger) {
-            $message->set_STS_ID(EEM_Message::status_failed);
-            $message->set_error_message(
-                sprintf(
-                    esc_html__('Unable to send message because the "%1$s" messenger is not active or not installed', 'event_espresso'),
-                    $this->_sending_messenger
-                )
-            );
-        }
-
-        // set properties
-        $this->_valid = true;
-        $this->_messenger = $message->messenger_object();
-        $this->_message_type = $message->message_type_object();
-        $this->_send_now = $message->send_now();
-        return $message;
-    }
+	/**
+	 * Sending messenger
+	 *
+	 * @type EE_messenger | string
+	 */
+	protected $_sending_messenger = '';
+
+
+	/**
+	 * Holds the incoming token;
+	 * @type string
+	 */
+	public $token = '';
+
+
+	/**
+	 * Constructor
+	 *
+	 * @param   string    $sending_messenger_slug     This is used to set what messenger is used to "send"
+	 *                                                the EE_Message retrieved from the DB via the given token.
+	 * @param   string $token                         This is a token for a Message that should already exist int the db.
+	 *                                                This is then used to populate the properties in here.
+	 * @param   EE_Message_Resource_Manager $message_resource_manager
+	 */
+	public function __construct($token, $sending_messenger_slug, EE_Message_Resource_Manager $message_resource_manager)
+	{
+		$this->token = $token;
+		$this->_sending_messenger = $this->_set_sending_messenger($sending_messenger_slug, $message_resource_manager);
+		$this->_message = $this->_generate_message();
+		// set params for parent from the message object
+		parent::__construct(
+			$this->_message->messenger(),
+			$this->_message->message_type(),
+			array(),
+			$this->_message->context(),
+			false
+		);
+	}
+
+
+
+	/**
+	 * @param string                       $sending_messenger_slug
+	 * @param \EE_Message_Resource_Manager $message_resource_manager
+	 * @return \EE_messenger | string
+	 */
+	protected function _set_sending_messenger(
+		$sending_messenger_slug,
+		EE_Message_Resource_Manager $message_resource_manager
+	) {
+		$sending_messenger = $message_resource_manager->get_active_messenger($sending_messenger_slug);
+		return $sending_messenger instanceof EE_messenger ? $sending_messenger : $sending_messenger_slug;
+	}
+
+
+
+	/**
+	 * @return EE_messenger
+	 */
+	public function sending_messenger()
+	{
+		return $this->_sending_messenger;
+	}
+
+
+
+	/**
+	 * generates an EE_Message using the supplied arguments and some defaults
+	 *
+	 * @param array $properties
+	 * @return EE_Message
+	 * @throws \EE_Error
+	 */
+	protected function _generate_message($properties = array())
+	{
+		// a message was generated immediately but the parent class will call this again
+		if ($this->_message instanceof EE_Message) {
+			return $this->_message;
+		}
+		$message = EEM_Message::instance()->get_one_by_token($this->token);
+		if (! $message instanceof EE_Message) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('Unable to retrieve generated message from DB using given token: "%1$s"', 'event_espresso'),
+					$this->token
+				)
+			);
+		}
+		$message->set_STS_ID(EEM_Message::status_idle);
+
+		if (! $this->_sending_messenger instanceof EE_messenger) {
+			$message->set_STS_ID(EEM_Message::status_failed);
+			$message->set_error_message(
+				sprintf(
+					esc_html__('Unable to send message because the "%1$s" messenger is not active or not installed', 'event_espresso'),
+					$this->_sending_messenger
+				)
+			);
+		}
+
+		// set properties
+		$this->_valid = true;
+		$this->_messenger = $message->messenger_object();
+		$this->_message_type = $message->message_type_object();
+		$this->_send_now = $message->send_now();
+		return $message;
+	}
 }

core/libraries/messages/EE_Registration_Base_message_type.lib.php

Spacing +7 added lines, -7 removed lines

@@ -36,7 +36,7 @@ 
     protected function _get_admin_content_events_edit_for_messenger(EE_messenger $messenger)
     {
         // this is just a test
-        return $this->name . ' Message Type for ' . $messenger->name . ' Messenger ';
+        return $this->name.' Message Type for '.$messenger->name.' Messenger ';
     }
 
 
@@ -55,7 +55,7 @@ 
                     if (isset($data_type[1]) && $data_type[1] instanceof EE_Registration) {
                         $regs = $data_type;
                     } else {
-                        $regs = is_array($data_type[0]) ? $data_type[0] : array( $maybe_reg );
+                        $regs = is_array($data_type[0]) ? $data_type[0] : array($maybe_reg);
                     }
 
                     foreach ($regs as $reg) {
@@ -63,7 +63,7 @@ 
                             $this->_regs_for_sending[] = $reg->ID();
                         }
                     }
-                    $this->_data = isset($this->_data[1]) ? array( $maybe_reg->transaction(), null, $this->_data[1] ) : array( $maybe_reg->transaction() );
+                    $this->_data = isset($this->_data[1]) ? array($maybe_reg->transaction(), null, $this->_data[1]) : array($maybe_reg->transaction());
                     $this->_data_handler = 'Gateways';
                 } else {
                     $this->_data_handler = 'Gateways';
@@ -82,17 +82,17 @@ 
 
     protected function _get_data_for_context($context, EE_Registration $registration, $id)
     {
-        if ($context  == 'admin') {
+        if ($context == 'admin') {
             // use the registration to get the transaction.
             $transaction = $registration->transaction();
 
             // bail early if no transaction
-            if (! $transaction instanceof EE_Transaction) {
+            if ( ! $transaction instanceof EE_Transaction) {
                 throw new EE_Error(esc_html__('The given registration does not have an associated transaction. Something is wrong.', 'event_espresso'));
             }
 
-            $payment = !empty($id) ? EEM_Payment::instance()->get_one(array( array( 'PAY_ID' => $id, 'TXN_ID' => $transaction->ID() ) )) : 0;
-            return array( $transaction, $payment );
+            $payment = ! empty($id) ? EEM_Payment::instance()->get_one(array(array('PAY_ID' => $id, 'TXN_ID' => $transaction->ID()))) : 0;
+            return array($transaction, $payment);
         } else {
             return $registration;
         }

Indentation +122 added lines, -122 removed lines

@@ -12,126 +12,126 @@
  */
 abstract class EE_Registration_Base_message_type extends EE_message_type
 {
-    /**
-     * @see parent::get_priority() for documentation.
-     * @return int
-     */
-    public function get_priority()
-    {
-        return EEM_Message::priority_medium;
-    }
-
-
-
-    protected function _set_admin_pages()
-    {
-        $this->admin_registered_pages = array(
-            'events_edit' => true
-            );
-    }
-
-
-    protected function _get_admin_content_events_edit_for_messenger(EE_messenger $messenger)
-    {
-        // this is just a test
-        return $this->name . ' Message Type for ' . $messenger->name . ' Messenger ';
-    }
-
-
-
-
-    protected function _set_data_handler()
-    {
-        if (is_array($this->_data)) {
-            $data_type = reset($this->_data);
-
-            if (is_array($data_type)) {
-                // grab the first item and see if its a registration.
-                $maybe_reg = isset($data_type[0]) && is_array($data_type[0]) ? reset($data_type[0]) : reset($data_type);
-                if ($maybe_reg instanceof EE_Registration) {
-                    // is $data_type itself just an array of registrations?
-                    if (isset($data_type[1]) && $data_type[1] instanceof EE_Registration) {
-                        $regs = $data_type;
-                    } else {
-                        $regs = is_array($data_type[0]) ? $data_type[0] : array( $maybe_reg );
-                    }
-
-                    foreach ($regs as $reg) {
-                        if ($reg instanceof EE_Registration) {
-                            $this->_regs_for_sending[] = $reg->ID();
-                        }
-                    }
-                    $this->_data = isset($this->_data[1]) ? array( $maybe_reg->transaction(), null, $this->_data[1] ) : array( $maybe_reg->transaction() );
-                    $this->_data_handler = 'Gateways';
-                } else {
-                    $this->_data_handler = 'Gateways';
-                }
-            } else {
-                $this->_data_handler = $data_type instanceof EE_Registration ? 'REG' : 'Gateways';
-            }
-        } else {
-            $this->_data_handler = $this->_data instanceof EE_Registration ? 'REG' : 'Gateways';
-        }
-
-        $this->_single_message = $this->_data_handler == 'REG' ? true : false;
-    }
-
-
-
-    protected function _get_data_for_context($context, EE_Registration $registration, $id)
-    {
-        if ($context  == 'admin') {
-            // use the registration to get the transaction.
-            $transaction = $registration->transaction();
-
-            // bail early if no transaction
-            if (! $transaction instanceof EE_Transaction) {
-                throw new EE_Error(esc_html__('The given registration does not have an associated transaction. Something is wrong.', 'event_espresso'));
-            }
-
-            $payment = !empty($id) ? EEM_Payment::instance()->get_one(array( array( 'PAY_ID' => $id, 'TXN_ID' => $transaction->ID() ) )) : 0;
-            return array( $transaction, $payment );
-        } else {
-            return $registration;
-        }
-    }
-
-
-
-    /**
-     * Setup admin settings for this message type.
-     */
-    protected function _set_admin_settings_fields()
-    {
-        $this->_admin_settings_fields = array();
-    }
-
-
-
-
-
-    /**
-     * returns an array of addressee objects for event_admins
-     *
-     * @access protected
-     * @return array array of EE_Messages_Addressee objects
-     */
-    protected function _admin_addressees()
-    {
-        if ($this->_single_message) {
-            return array();
-        }
-        return parent::_admin_addressees();
-    }
-
-
-
-    protected function _primary_attendee_addressees()
-    {
-        if ($this->_single_message) {
-            return array();
-        }
-
-        return parent::_primary_attendee_addressees();
-    }
+	/**
+	 * @see parent::get_priority() for documentation.
+	 * @return int
+	 */
+	public function get_priority()
+	{
+		return EEM_Message::priority_medium;
+	}
+
+
+
+	protected function _set_admin_pages()
+	{
+		$this->admin_registered_pages = array(
+			'events_edit' => true
+			);
+	}
+
+
+	protected function _get_admin_content_events_edit_for_messenger(EE_messenger $messenger)
+	{
+		// this is just a test
+		return $this->name . ' Message Type for ' . $messenger->name . ' Messenger ';
+	}
+
+
+
+
+	protected function _set_data_handler()
+	{
+		if (is_array($this->_data)) {
+			$data_type = reset($this->_data);
+
+			if (is_array($data_type)) {
+				// grab the first item and see if its a registration.
+				$maybe_reg = isset($data_type[0]) && is_array($data_type[0]) ? reset($data_type[0]) : reset($data_type);
+				if ($maybe_reg instanceof EE_Registration) {
+					// is $data_type itself just an array of registrations?
+					if (isset($data_type[1]) && $data_type[1] instanceof EE_Registration) {
+						$regs = $data_type;
+					} else {
+						$regs = is_array($data_type[0]) ? $data_type[0] : array( $maybe_reg );
+					}
+
+					foreach ($regs as $reg) {
+						if ($reg instanceof EE_Registration) {
+							$this->_regs_for_sending[] = $reg->ID();
+						}
+					}
+					$this->_data = isset($this->_data[1]) ? array( $maybe_reg->transaction(), null, $this->_data[1] ) : array( $maybe_reg->transaction() );
+					$this->_data_handler = 'Gateways';
+				} else {
+					$this->_data_handler = 'Gateways';
+				}
+			} else {
+				$this->_data_handler = $data_type instanceof EE_Registration ? 'REG' : 'Gateways';
+			}
+		} else {
+			$this->_data_handler = $this->_data instanceof EE_Registration ? 'REG' : 'Gateways';
+		}
+
+		$this->_single_message = $this->_data_handler == 'REG' ? true : false;
+	}
+
+
+
+	protected function _get_data_for_context($context, EE_Registration $registration, $id)
+	{
+		if ($context  == 'admin') {
+			// use the registration to get the transaction.
+			$transaction = $registration->transaction();
+
+			// bail early if no transaction
+			if (! $transaction instanceof EE_Transaction) {
+				throw new EE_Error(esc_html__('The given registration does not have an associated transaction. Something is wrong.', 'event_espresso'));
+			}
+
+			$payment = !empty($id) ? EEM_Payment::instance()->get_one(array( array( 'PAY_ID' => $id, 'TXN_ID' => $transaction->ID() ) )) : 0;
+			return array( $transaction, $payment );
+		} else {
+			return $registration;
+		}
+	}
+
+
+
+	/**
+	 * Setup admin settings for this message type.
+	 */
+	protected function _set_admin_settings_fields()
+	{
+		$this->_admin_settings_fields = array();
+	}
+
+
+
+
+
+	/**
+	 * returns an array of addressee objects for event_admins
+	 *
+	 * @access protected
+	 * @return array array of EE_Messages_Addressee objects
+	 */
+	protected function _admin_addressees()
+	{
+		if ($this->_single_message) {
+			return array();
+		}
+		return parent::_admin_addressees();
+	}
+
+
+
+	protected function _primary_attendee_addressees()
+	{
+		if ($this->_single_message) {
+			return array();
+		}
+
+		return parent::_primary_attendee_addressees();
+	}
 }

core/libraries/qtips/EE_Qtip_Config.lib.php

Spacing +1 added lines, -1 removed lines

@@ -207,7 +207,7 @@
     {
         foreach ($this->_qtipsa as $qt) {
             // make sure we have what we need.
-            if (! isset($qt['content_id']) || ! isset($qt['target']) || ! isset($qt['content'])) {
+            if ( ! isset($qt['content_id']) || ! isset($qt['target']) || ! isset($qt['content'])) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(

Indentation +225 added lines, -225 removed lines

@@ -14,235 +14,235 @@ 
  */
 abstract class EE_Qtip_Config extends EE_Base
 {
-    /**
-     * This will hold the qtips setup array (setup by children)
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_qtipsa;
+	/**
+	 * This will hold the qtips setup array (setup by children)
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_qtipsa;
 
 
-    /**
-     * This holds the constructed EE_Qtip objects
-     *
-     * @access protected
-     * @var EE_Qtip
-     */
-    protected $_qtips;
+	/**
+	 * This holds the constructed EE_Qtip objects
+	 *
+	 * @access protected
+	 * @var EE_Qtip
+	 */
+	protected $_qtips;
 
 
-    /**
-     * an array of default options for instantiated qtip js objects
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_default_options;
+	/**
+	 * an array of default options for instantiated qtip js objects
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_default_options;
 
 
-    /**
-     * constructor
-     *
-     * @access public
-     */
-    public function __construct()
-    {
-        $this->_qtipsa = $this->_qtips = array();
-        $this->_set_default_options();
-        $this->_set_tips_array();
-        $this->_construct_tips();
-    }
+	/**
+	 * constructor
+	 *
+	 * @access public
+	 */
+	public function __construct()
+	{
+		$this->_qtipsa = $this->_qtips = array();
+		$this->_set_default_options();
+		$this->_set_tips_array();
+		$this->_construct_tips();
+	}
 
 
-    /**
-     * Children define this method and its purpose is to setup the $_qtipsa property.  The format of this property is:
-     *
-     * $qtipsa = array(
-     *        0 => array(
-     *            'content_id' => 'some_unique_id_for_referencing_content', //just the string
-     *            'content' => 'html/text content for the qtip',
-     *            'target' => '#target-element', //use the same schema as jQuery selectors.  This will match what the
-     *            target is for the qTip in the dom (i.e. if class then '.some-class').
-     *            'options' => array() //use this to override any of the default options for this specific qtip.
-     *        )
-     * );
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_tips_array();
+	/**
+	 * Children define this method and its purpose is to setup the $_qtipsa property.  The format of this property is:
+	 *
+	 * $qtipsa = array(
+	 *        0 => array(
+	 *            'content_id' => 'some_unique_id_for_referencing_content', //just the string
+	 *            'content' => 'html/text content for the qtip',
+	 *            'target' => '#target-element', //use the same schema as jQuery selectors.  This will match what the
+	 *            target is for the qTip in the dom (i.e. if class then '.some-class').
+	 *            'options' => array() //use this to override any of the default options for this specific qtip.
+	 *        )
+	 * );
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_tips_array();
 
 
-    /**
-     * all the default options for the qtip js are defined here.  Children class can override the defaults for all the
-     * qtips defined in their config OR just leave it and have the parent default options apply.
-     *
-     * commented out options are there for reference so you know which can be defined by the child.
-     *
-     * Note: children do NOT have to define all these options.  Just define the ones to override.
-     *
-     * @link   http://qtip2.com/options
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_default_options()
-    {
-        $this->_default_options = array(
-            // 'id' => 'unique_id_referncing_qtip_instance',
-            'prerender'      => false,
-            // increases page load if true,
-            'suppress'       => true,
-            // whether default browser tooltips are suppressed.
-            'content'        => array(
-                'button' => false,
-                // what you want for the close button text/link.
-                'title'  => true,
-                // Options: "string", true.  If TRUE then the title attribute of the target will be used (if available). If "string" then we'll use that as the title.
-                'clone'  => true,
-                // Options: true|false.  if true then the text will be cloned from the content instead of removed from the dom.
-            ),
-            'show_only_once' => false,
-            // this is NOT a qtip2 library option, but is something added for EE specific use.  If set to true, this means that this particular tooltip will only show ONCE for the user and then a cookie will be saved so that it doesn't show again (after exit).
-            'position'       => array(
-                'my'        => 'top left',
-                // top left || top center || top right || right top || right center || right bottom || bottom right || bottom center || bottom left || left bottom || left center || left top
-                'at'        => 'bottom right',
-                // same options as above.
-                'target'    => 'event',
-                // if u use jQuery::#selector, js will parse to a jQuery selector || 'mouse' (at mouse cursor position) || 'event' (position at target that triggered the tooltip), or an array containing an absolute x/y position on page.
-                'container' => false,
-                // what HTML element the tooltip is appended to (it's containing element). jquery object.  Use 'jQuery::#selector' and js will parse'
-                'viewport'  => true,
-                // @link http://qtip2.com/plugins#viewport
-                'adjust'    => array(
-                    'x'      => 0,
-                    // adjust position on x axis by 0 pixels.
-                    'y'      => 0,
-                    // adjust position on y axis by 0 pixels.
-                    'mouse'  => true,
-                    // when position['target'] is set to 'mouse', tooltip will follow mouse when hovering over the target.  False, stops following.
-                    'resize' => true,
-                    // adjust tooltip position when window is resized.
-                    'scroll' => true,
-                    // position of tooltip adjusted when window (or position.container) is scrolled.
-                    'method' => 'flipinvert',
-                    // @link http://qtip2.com/plugins#viewport
-                ),
-            ),
-            'show'           => array(
-                'event'  => 'mouseenter',
-                // what event triggers tooltip to be shown.  Any jQuery standard event or custom events can be used. space separated events provide multiple triggers.
-                'target' => false,
-                // options jQuery::#selector|false.  Used to indicate which html element will trigger show event.  When false, the element the qtip() method was called upon is used.
-                'delay'  => 90,
-                // time in millisecons by which to delay showing of tooltip.
-                'solo'   => false,
-                // determines whether tooltip will hid all others when triggered. Options: true (hide all) || false (ignore) || string (parent selector for which qtips get hidden)
-                'modal'  => array(
-                    'on'         => false, // does tooltip trigger modal?
-                    'blur'       => true, // does clicking on the dimmed background hide the tooltip and remove the dim?
-                    'escape'     => true, // hitting escape key hide the tooltip and cancel modal
-                    'stealfocus' => true, // can users focus on inputs and elelments outside of tooltip when modal on?
-                ),
-            ),
-            'hide'           => array(
-                'event'    => 'mouseleave',
-                // similar as what you do for show.event.
-                'target'   => false,
-                // Options jQuery::#selector. which html element will trigger hide event. When false, the element the .qtip() method was called upon is used.
-                'delay'    => 0,
-                // set time in milliseconds for delaying the hide of the tooltip
-                'inactive' => false,
-                // if integer, time in millisecons in which the tooltip should be hidden if remains inactive (not interacted with)
-                'fixed'    => false,
-                // when set to true, the tooltip will not hide if moused over.
-                'leave'    => 'window',
-                // specify whether the tooltip will hide when leaving the window it's conained within.
-                'distance' => false,
-                // if integer, distance in pixels that the tooltip hides when the mouse is moved from the point it triggered the tooltip.
-            ),
-            'style'          => array(
-                'classes' => 'qtip-tipsy',
-                // Options "string", false.  A space separated string containing all class names which should be added ot the main qTip element. See options for styles in comment block at end of this class.
-                'def'     => true,
-                // set to false and the default qtip class does not get applied
-                'widget'  => false,
-                // whether ui-widget classes of the themeroller UI styles are applied to tooltip.
-                'width'   => false,
-                // Options: "string", integer, false.  with this you can override all applied CSS width styles for tooltip.  Can be any valid width CSS value. (does not override min/max width styles)
-                'height'  => false,
-                // same as above except applies to height.
-                'tip'     => array(
-                    'corner' => true,
-                    // where in relation to the tooltip the speech bubble tip is applied. Options: true, "corner string" (see position), false.  true inherits
-                    'mimic'  => false,
-                    // see documentation @link http://qtip2.com/plugins#tips
-                    'border' => true,
-                    // Options: true, integer. determines the width of the border that surrounds the tip element.  True inherits from tooltip.
-                    'width'  => 6,
-                    // width of rendered tip in pixels in relation to the side of the tooltip the tip is on.
-                    'height' => 6,
-                    // works the same as tip.width
-                    'offset' => 0,
-                    // use to set the offset of the tip in relation to its corner position.
-                ),
-            ),
+	/**
+	 * all the default options for the qtip js are defined here.  Children class can override the defaults for all the
+	 * qtips defined in their config OR just leave it and have the parent default options apply.
+	 *
+	 * commented out options are there for reference so you know which can be defined by the child.
+	 *
+	 * Note: children do NOT have to define all these options.  Just define the ones to override.
+	 *
+	 * @link   http://qtip2.com/options
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_default_options()
+	{
+		$this->_default_options = array(
+			// 'id' => 'unique_id_referncing_qtip_instance',
+			'prerender'      => false,
+			// increases page load if true,
+			'suppress'       => true,
+			// whether default browser tooltips are suppressed.
+			'content'        => array(
+				'button' => false,
+				// what you want for the close button text/link.
+				'title'  => true,
+				// Options: "string", true.  If TRUE then the title attribute of the target will be used (if available). If "string" then we'll use that as the title.
+				'clone'  => true,
+				// Options: true|false.  if true then the text will be cloned from the content instead of removed from the dom.
+			),
+			'show_only_once' => false,
+			// this is NOT a qtip2 library option, but is something added for EE specific use.  If set to true, this means that this particular tooltip will only show ONCE for the user and then a cookie will be saved so that it doesn't show again (after exit).
+			'position'       => array(
+				'my'        => 'top left',
+				// top left || top center || top right || right top || right center || right bottom || bottom right || bottom center || bottom left || left bottom || left center || left top
+				'at'        => 'bottom right',
+				// same options as above.
+				'target'    => 'event',
+				// if u use jQuery::#selector, js will parse to a jQuery selector || 'mouse' (at mouse cursor position) || 'event' (position at target that triggered the tooltip), or an array containing an absolute x/y position on page.
+				'container' => false,
+				// what HTML element the tooltip is appended to (it's containing element). jquery object.  Use 'jQuery::#selector' and js will parse'
+				'viewport'  => true,
+				// @link http://qtip2.com/plugins#viewport
+				'adjust'    => array(
+					'x'      => 0,
+					// adjust position on x axis by 0 pixels.
+					'y'      => 0,
+					// adjust position on y axis by 0 pixels.
+					'mouse'  => true,
+					// when position['target'] is set to 'mouse', tooltip will follow mouse when hovering over the target.  False, stops following.
+					'resize' => true,
+					// adjust tooltip position when window is resized.
+					'scroll' => true,
+					// position of tooltip adjusted when window (or position.container) is scrolled.
+					'method' => 'flipinvert',
+					// @link http://qtip2.com/plugins#viewport
+				),
+			),
+			'show'           => array(
+				'event'  => 'mouseenter',
+				// what event triggers tooltip to be shown.  Any jQuery standard event or custom events can be used. space separated events provide multiple triggers.
+				'target' => false,
+				// options jQuery::#selector|false.  Used to indicate which html element will trigger show event.  When false, the element the qtip() method was called upon is used.
+				'delay'  => 90,
+				// time in millisecons by which to delay showing of tooltip.
+				'solo'   => false,
+				// determines whether tooltip will hid all others when triggered. Options: true (hide all) || false (ignore) || string (parent selector for which qtips get hidden)
+				'modal'  => array(
+					'on'         => false, // does tooltip trigger modal?
+					'blur'       => true, // does clicking on the dimmed background hide the tooltip and remove the dim?
+					'escape'     => true, // hitting escape key hide the tooltip and cancel modal
+					'stealfocus' => true, // can users focus on inputs and elelments outside of tooltip when modal on?
+				),
+			),
+			'hide'           => array(
+				'event'    => 'mouseleave',
+				// similar as what you do for show.event.
+				'target'   => false,
+				// Options jQuery::#selector. which html element will trigger hide event. When false, the element the .qtip() method was called upon is used.
+				'delay'    => 0,
+				// set time in milliseconds for delaying the hide of the tooltip
+				'inactive' => false,
+				// if integer, time in millisecons in which the tooltip should be hidden if remains inactive (not interacted with)
+				'fixed'    => false,
+				// when set to true, the tooltip will not hide if moused over.
+				'leave'    => 'window',
+				// specify whether the tooltip will hide when leaving the window it's conained within.
+				'distance' => false,
+				// if integer, distance in pixels that the tooltip hides when the mouse is moved from the point it triggered the tooltip.
+			),
+			'style'          => array(
+				'classes' => 'qtip-tipsy',
+				// Options "string", false.  A space separated string containing all class names which should be added ot the main qTip element. See options for styles in comment block at end of this class.
+				'def'     => true,
+				// set to false and the default qtip class does not get applied
+				'widget'  => false,
+				// whether ui-widget classes of the themeroller UI styles are applied to tooltip.
+				'width'   => false,
+				// Options: "string", integer, false.  with this you can override all applied CSS width styles for tooltip.  Can be any valid width CSS value. (does not override min/max width styles)
+				'height'  => false,
+				// same as above except applies to height.
+				'tip'     => array(
+					'corner' => true,
+					// where in relation to the tooltip the speech bubble tip is applied. Options: true, "corner string" (see position), false.  true inherits
+					'mimic'  => false,
+					// see documentation @link http://qtip2.com/plugins#tips
+					'border' => true,
+					// Options: true, integer. determines the width of the border that surrounds the tip element.  True inherits from tooltip.
+					'width'  => 6,
+					// width of rendered tip in pixels in relation to the side of the tooltip the tip is on.
+					'height' => 6,
+					// works the same as tip.width
+					'offset' => 0,
+					// use to set the offset of the tip in relation to its corner position.
+				),
+			),
 
-        );
-    }
+		);
+	}
 
 
-    /**
-     * This takes the set $_qtipsa array property and loops through it to set the EE_Qtip objects and assign them to
-     * the $_qtips property
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _construct_tips()
-    {
-        foreach ($this->_qtipsa as $qt) {
-            // make sure we have what we need.
-            if (! isset($qt['content_id']) || ! isset($qt['target']) || ! isset($qt['content'])) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'There is something wrong with the _qtipsa property setup for the %s qtip config class.  The dump of the current array index is: %s.<br /><br />Please check that it is setup correctly.',
-                            'event_espresso'
-                        ),
-                        get_class($this),
-                        var_export($qt, true)
-                    )
-                );
-            }
+	/**
+	 * This takes the set $_qtipsa array property and loops through it to set the EE_Qtip objects and assign them to
+	 * the $_qtips property
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _construct_tips()
+	{
+		foreach ($this->_qtipsa as $qt) {
+			// make sure we have what we need.
+			if (! isset($qt['content_id']) || ! isset($qt['target']) || ! isset($qt['content'])) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'There is something wrong with the _qtipsa property setup for the %s qtip config class.  The dump of the current array index is: %s.<br /><br />Please check that it is setup correctly.',
+							'event_espresso'
+						),
+						get_class($this),
+						var_export($qt, true)
+					)
+				);
+			}
 
-            // make sure the options include defaults and just override via set config.
-            $options_override = isset($qt['options']) ? (array) $qt['options'] : array();
-            $options = array_merge($this->_default_options, $options_override);
-            $setup = array(
-                'content_id' => $qt['content_id'],
-                'options'    => $options,
-                'target'     => $qt['target'],
-                'content'    => $qt['content'],
-            );
-            $this->_qtips[] = new EE_Qtip($setup);
-        }
-    }
+			// make sure the options include defaults and just override via set config.
+			$options_override = isset($qt['options']) ? (array) $qt['options'] : array();
+			$options = array_merge($this->_default_options, $options_override);
+			$setup = array(
+				'content_id' => $qt['content_id'],
+				'options'    => $options,
+				'target'     => $qt['target'],
+				'content'    => $qt['content'],
+			);
+			$this->_qtips[] = new EE_Qtip($setup);
+		}
+	}
 
 
-    /**
-     * return the _qtips property contents
-     *
-     * @access public
-     * @return EE_Qtip[]
-     */
-    public function get_tips()
-    {
-        return $this->_qtips;
-    }
+	/**
+	 * return the _qtips property contents
+	 *
+	 * @access public
+	 * @return EE_Qtip[]
+	 */
+	public function get_tips()
+	{
+		return $this->_qtips;
+	}
 }
 
 // class names you can use for tooltip styles
@@ -294,17 +294,17 @@ 
  */
 class EE_Qtip extends EE_Base
 {
-    public $content_id;
-    public $options;
-    public $target;
-    public $content;
+	public $content_id;
+	public $options;
+	public $target;
+	public $content;
 
-    public function __construct($setup_array)
-    {
-        foreach ($setup_array as $prop => $value) {
-            if (EEH_Class_Tools::has_property($this, $prop)) {
-                $this->{$prop} = $value;
-            }
-        }
-    }
+	public function __construct($setup_array)
+	{
+		foreach ($setup_array as $prop => $value) {
+			if (EEH_Class_Tools::has_property($this, $prop)) {
+				$this->{$prop} = $value;
+			}
+		}
+	}
 }

core/libraries/plugin_api/db/EEME_Base.lib.php

Spacing +17 added lines, -17 removed lines

@@ -71,7 +71,7 @@ 
      */
     public function __construct()
     {
-        if (! $this->_model_name_extended) {
+        if ( ! $this->_model_name_extended) {
             throw new EE_Error(
                 esc_html__(
                     "When declaring a model extension, you must define its _model_name_extended property. It should be a model name like 'Attendee' or 'Event'",
@@ -79,7 +79,7 @@ 
                 )
             );
         }
-        $construct_end_action = 'AHEE__EEM_' . $this->_model_name_extended . '__construct__end';
+        $construct_end_action = 'AHEE__EEM_'.$this->_model_name_extended.'__construct__end';
         if (did_action($construct_end_action)) {
             throw new EE_Error(
                 sprintf(
@@ -94,15 +94,15 @@ 
             );
         }
         add_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__tables',
+            'FHEE__EEM_'.$this->_model_name_extended.'__construct__tables',
             array($this, 'add_extra_tables_on_filter')
         );
         add_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__fields',
+            'FHEE__EEM_'.$this->_model_name_extended.'__construct__fields',
             array($this, 'add_extra_fields_on_filter')
         );
         add_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__model_relations',
+            'FHEE__EEM_'.$this->_model_name_extended.'__construct__model_relations',
             array($this, 'add_extra_relations_on_filter')
         );
         $this->_register_extending_methods();
@@ -127,12 +127,12 @@ 
     {
         if ($this->_extra_fields) {
             foreach ($this->_extra_fields as $table_alias => $fields) {
-                if (! isset($existing_fields[ $table_alias ])) {
-                    $existing_fields[ $table_alias ] = array();
+                if ( ! isset($existing_fields[$table_alias])) {
+                    $existing_fields[$table_alias] = array();
                 }
-                $existing_fields[ $table_alias ] = array_merge(
-                    (array) $existing_fields[ $table_alias ],
-                    $this->_extra_fields[ $table_alias ]
+                $existing_fields[$table_alias] = array_merge(
+                    (array) $existing_fields[$table_alias],
+                    $this->_extra_fields[$table_alias]
                 );
             }
         }
@@ -163,7 +163,7 @@ 
                 $callback_name = "FHEE__EEM_{$this->_model_name_extended}__$method_name_on_model";
                 add_filter(
                     $callback_name,
-                    array($this, self::dynamic_callback_method_prefix . $method_name_on_model),
+                    array($this, self::dynamic_callback_method_prefix.$method_name_on_model),
                     10,
                     10
                 );
@@ -178,15 +178,15 @@ 
     public function deregister()
     {
         remove_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__tables',
+            'FHEE__EEM_'.$this->_model_name_extended.'__construct__tables',
             array($this, 'add_extra_tables_on_filter')
         );
         remove_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__fields',
+            'FHEE__EEM_'.$this->_model_name_extended.'__construct__fields',
             array($this, 'add_extra_fields_on_filter')
         );
         remove_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__model_relations',
+            'FHEE__EEM_'.$this->_model_name_extended.'__construct__model_relations',
             array($this, 'add_extra_relations_on_filter')
         );
         $all_methods = get_class_methods(get_class($this));
@@ -196,13 +196,13 @@ 
                 $callback_name = "FHEE__EEM_{$this->_model_name_extended}__$method_name_on_model";
                 remove_filter(
                     $callback_name,
-                    array($this, self::dynamic_callback_method_prefix . $method_name_on_model),
+                    array($this, self::dynamic_callback_method_prefix.$method_name_on_model),
                     10
                 );
             }
         }
         /** @var EEM_Base $model_to_reset */
-        $model_to_reset = 'EEM_' . $this->_model_name_extended;
+        $model_to_reset = 'EEM_'.$this->_model_name_extended;
         if (class_exists($model_to_reset)) {
             $model_to_reset::reset();
         }
@@ -224,7 +224,7 @@ 
             // phpcs:disable WordPress.WP.I18n.SingleUnderscoreGetTextFunction
             $this->_ = $model_called;
             // phpcs:enable
-            $extending_method = self::extending_method_prefix . $method_called_on_model;
+            $extending_method = self::extending_method_prefix.$method_called_on_model;
             if (method_exists($this, $extending_method)) {
                 return call_user_func_array(array($this, $extending_method), $args_provided_to_method_on_model);
             } else {

Indentation +207 added lines, -207 removed lines

@@ -43,211 +43,211 @@
  */
 abstract class EEME_Base
 {
-    const extending_method_prefix = 'ext_';
-    const dynamic_callback_method_prefix = 'dynamic_callback_method_';
-
-    protected $_extra_tables = array();
-    protected $_extra_fields = array();
-    protected $_extra_relations = array();
-
-    /**
-     * The model name that is extended (not classname)
-     *
-     * @var string
-     */
-    protected $_model_name_extended = null;
-
-    /**
-     * The model this extends
-     *
-     * @var EEM_Base
-     */
-    protected $_ = null;
-
-
-    /**
-     * @throws \EE_Error
-     */
-    public function __construct()
-    {
-        if (! $this->_model_name_extended) {
-            throw new EE_Error(
-                esc_html__(
-                    "When declaring a model extension, you must define its _model_name_extended property. It should be a model name like 'Attendee' or 'Event'",
-                    "event_espresso"
-                )
-            );
-        }
-        $construct_end_action = 'AHEE__EEM_' . $this->_model_name_extended . '__construct__end';
-        if (did_action($construct_end_action)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Hooked in model extension '%s' too late! The model %s has already been used! We know because the action %s has been fired",
-                        "event_espresso"
-                    ),
-                    get_class($this),
-                    $this->_model_name_extended,
-                    $construct_end_action
-                )
-            );
-        }
-        add_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__tables',
-            array($this, 'add_extra_tables_on_filter')
-        );
-        add_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__fields',
-            array($this, 'add_extra_fields_on_filter')
-        );
-        add_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__model_relations',
-            array($this, 'add_extra_relations_on_filter')
-        );
-        $this->_register_extending_methods();
-    }
-
-
-    /**
-     * @param array $existing_tables
-     * @return array
-     */
-    public function add_extra_tables_on_filter($existing_tables)
-    {
-        return array_merge((array) $existing_tables, $this->_extra_tables);
-    }
-
-
-    /**
-     * @param array $existing_fields
-     * @return array
-     */
-    public function add_extra_fields_on_filter($existing_fields)
-    {
-        if ($this->_extra_fields) {
-            foreach ($this->_extra_fields as $table_alias => $fields) {
-                if (! isset($existing_fields[ $table_alias ])) {
-                    $existing_fields[ $table_alias ] = array();
-                }
-                $existing_fields[ $table_alias ] = array_merge(
-                    (array) $existing_fields[ $table_alias ],
-                    $this->_extra_fields[ $table_alias ]
-                );
-            }
-        }
-        return $existing_fields;
-    }
-
-
-    /**
-     * @param array $existing_relations
-     * @return array
-     */
-    public function add_extra_relations_on_filter($existing_relations)
-    {
-        return array_merge((array) $existing_relations, $this->_extra_relations);
-    }
-
-
-    /**
-     * scans the child of EEME_Base for functions starting with ext_, and magically makes them functions on the
-     * model extended. (Internally uses filters, and the __call magic method)
-     */
-    protected function _register_extending_methods()
-    {
-        $all_methods = get_class_methods(get_class($this));
-        foreach ($all_methods as $method_name) {
-            if (strpos($method_name, self::extending_method_prefix) === 0) {
-                $method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
-                $callback_name = "FHEE__EEM_{$this->_model_name_extended}__$method_name_on_model";
-                add_filter(
-                    $callback_name,
-                    array($this, self::dynamic_callback_method_prefix . $method_name_on_model),
-                    10,
-                    10
-                );
-            }
-        }
-    }
-
-    /**
-     * scans the child of EEME_Base for functions starting with ext_, and magically REMOVES them as functions on the
-     * model extended. (Internally uses filters, and the __call magic method)
-     */
-    public function deregister()
-    {
-        remove_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__tables',
-            array($this, 'add_extra_tables_on_filter')
-        );
-        remove_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__fields',
-            array($this, 'add_extra_fields_on_filter')
-        );
-        remove_filter(
-            'FHEE__EEM_' . $this->_model_name_extended . '__construct__model_relations',
-            array($this, 'add_extra_relations_on_filter')
-        );
-        $all_methods = get_class_methods(get_class($this));
-        foreach ($all_methods as $method_name) {
-            if (strpos($method_name, self::extending_method_prefix) === 0) {
-                $method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
-                $callback_name = "FHEE__EEM_{$this->_model_name_extended}__$method_name_on_model";
-                remove_filter(
-                    $callback_name,
-                    array($this, self::dynamic_callback_method_prefix . $method_name_on_model),
-                    10
-                );
-            }
-        }
-        /** @var EEM_Base $model_to_reset */
-        $model_to_reset = 'EEM_' . $this->_model_name_extended;
-        if (class_exists($model_to_reset)) {
-            $model_to_reset::reset();
-        }
-    }
-
-
-    /**
-     * @param string $callback_method_name
-     * @param array  $args
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function __call($callback_method_name, $args)
-    {
-        if (strpos($callback_method_name, self::dynamic_callback_method_prefix) === 0) {
-            // it's a dynamic callback for a method name
-            $method_called_on_model = str_replace(self::dynamic_callback_method_prefix, '', $callback_method_name);
-            list($original_return_val, $model_called, $args_provided_to_method_on_model) = (array) $args;
-            // phpcs:disable WordPress.WP.I18n.SingleUnderscoreGetTextFunction
-            $this->_ = $model_called;
-            // phpcs:enable
-            $extending_method = self::extending_method_prefix . $method_called_on_model;
-            if (method_exists($this, $extending_method)) {
-                return call_user_func_array(array($this, $extending_method), $args_provided_to_method_on_model);
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "An odd error occurred. Model '%s' had a method called on it that it didn't recognize. So it passed it onto the model extension '%s' (because it had a function named '%s' which should be able to handle it), but the function '%s' doesnt exist!)",
-                            "event_espresso"
-                        ),
-                        $this->_model_name_extended,
-                        get_class($this),
-                        $extending_method,
-                        $extending_method
-                    )
-                );
-            }
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("There is no method named '%s' on '%s'", "event_espresso"),
-                    $callback_method_name,
-                    get_class($this)
-                )
-            );
-        }
-    }
+	const extending_method_prefix = 'ext_';
+	const dynamic_callback_method_prefix = 'dynamic_callback_method_';
+
+	protected $_extra_tables = array();
+	protected $_extra_fields = array();
+	protected $_extra_relations = array();
+
+	/**
+	 * The model name that is extended (not classname)
+	 *
+	 * @var string
+	 */
+	protected $_model_name_extended = null;
+
+	/**
+	 * The model this extends
+	 *
+	 * @var EEM_Base
+	 */
+	protected $_ = null;
+
+
+	/**
+	 * @throws \EE_Error
+	 */
+	public function __construct()
+	{
+		if (! $this->_model_name_extended) {
+			throw new EE_Error(
+				esc_html__(
+					"When declaring a model extension, you must define its _model_name_extended property. It should be a model name like 'Attendee' or 'Event'",
+					"event_espresso"
+				)
+			);
+		}
+		$construct_end_action = 'AHEE__EEM_' . $this->_model_name_extended . '__construct__end';
+		if (did_action($construct_end_action)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Hooked in model extension '%s' too late! The model %s has already been used! We know because the action %s has been fired",
+						"event_espresso"
+					),
+					get_class($this),
+					$this->_model_name_extended,
+					$construct_end_action
+				)
+			);
+		}
+		add_filter(
+			'FHEE__EEM_' . $this->_model_name_extended . '__construct__tables',
+			array($this, 'add_extra_tables_on_filter')
+		);
+		add_filter(
+			'FHEE__EEM_' . $this->_model_name_extended . '__construct__fields',
+			array($this, 'add_extra_fields_on_filter')
+		);
+		add_filter(
+			'FHEE__EEM_' . $this->_model_name_extended . '__construct__model_relations',
+			array($this, 'add_extra_relations_on_filter')
+		);
+		$this->_register_extending_methods();
+	}
+
+
+	/**
+	 * @param array $existing_tables
+	 * @return array
+	 */
+	public function add_extra_tables_on_filter($existing_tables)
+	{
+		return array_merge((array) $existing_tables, $this->_extra_tables);
+	}
+
+
+	/**
+	 * @param array $existing_fields
+	 * @return array
+	 */
+	public function add_extra_fields_on_filter($existing_fields)
+	{
+		if ($this->_extra_fields) {
+			foreach ($this->_extra_fields as $table_alias => $fields) {
+				if (! isset($existing_fields[ $table_alias ])) {
+					$existing_fields[ $table_alias ] = array();
+				}
+				$existing_fields[ $table_alias ] = array_merge(
+					(array) $existing_fields[ $table_alias ],
+					$this->_extra_fields[ $table_alias ]
+				);
+			}
+		}
+		return $existing_fields;
+	}
+
+
+	/**
+	 * @param array $existing_relations
+	 * @return array
+	 */
+	public function add_extra_relations_on_filter($existing_relations)
+	{
+		return array_merge((array) $existing_relations, $this->_extra_relations);
+	}
+
+
+	/**
+	 * scans the child of EEME_Base for functions starting with ext_, and magically makes them functions on the
+	 * model extended. (Internally uses filters, and the __call magic method)
+	 */
+	protected function _register_extending_methods()
+	{
+		$all_methods = get_class_methods(get_class($this));
+		foreach ($all_methods as $method_name) {
+			if (strpos($method_name, self::extending_method_prefix) === 0) {
+				$method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
+				$callback_name = "FHEE__EEM_{$this->_model_name_extended}__$method_name_on_model";
+				add_filter(
+					$callback_name,
+					array($this, self::dynamic_callback_method_prefix . $method_name_on_model),
+					10,
+					10
+				);
+			}
+		}
+	}
+
+	/**
+	 * scans the child of EEME_Base for functions starting with ext_, and magically REMOVES them as functions on the
+	 * model extended. (Internally uses filters, and the __call magic method)
+	 */
+	public function deregister()
+	{
+		remove_filter(
+			'FHEE__EEM_' . $this->_model_name_extended . '__construct__tables',
+			array($this, 'add_extra_tables_on_filter')
+		);
+		remove_filter(
+			'FHEE__EEM_' . $this->_model_name_extended . '__construct__fields',
+			array($this, 'add_extra_fields_on_filter')
+		);
+		remove_filter(
+			'FHEE__EEM_' . $this->_model_name_extended . '__construct__model_relations',
+			array($this, 'add_extra_relations_on_filter')
+		);
+		$all_methods = get_class_methods(get_class($this));
+		foreach ($all_methods as $method_name) {
+			if (strpos($method_name, self::extending_method_prefix) === 0) {
+				$method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
+				$callback_name = "FHEE__EEM_{$this->_model_name_extended}__$method_name_on_model";
+				remove_filter(
+					$callback_name,
+					array($this, self::dynamic_callback_method_prefix . $method_name_on_model),
+					10
+				);
+			}
+		}
+		/** @var EEM_Base $model_to_reset */
+		$model_to_reset = 'EEM_' . $this->_model_name_extended;
+		if (class_exists($model_to_reset)) {
+			$model_to_reset::reset();
+		}
+	}
+
+
+	/**
+	 * @param string $callback_method_name
+	 * @param array  $args
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function __call($callback_method_name, $args)
+	{
+		if (strpos($callback_method_name, self::dynamic_callback_method_prefix) === 0) {
+			// it's a dynamic callback for a method name
+			$method_called_on_model = str_replace(self::dynamic_callback_method_prefix, '', $callback_method_name);
+			list($original_return_val, $model_called, $args_provided_to_method_on_model) = (array) $args;
+			// phpcs:disable WordPress.WP.I18n.SingleUnderscoreGetTextFunction
+			$this->_ = $model_called;
+			// phpcs:enable
+			$extending_method = self::extending_method_prefix . $method_called_on_model;
+			if (method_exists($this, $extending_method)) {
+				return call_user_func_array(array($this, $extending_method), $args_provided_to_method_on_model);
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"An odd error occurred. Model '%s' had a method called on it that it didn't recognize. So it passed it onto the model extension '%s' (because it had a function named '%s' which should be able to handle it), but the function '%s' doesnt exist!)",
+							"event_espresso"
+						),
+						$this->_model_name_extended,
+						get_class($this),
+						$extending_method,
+						$extending_method
+					)
+				);
+			}
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__("There is no method named '%s' on '%s'", "event_espresso"),
+					$callback_method_name,
+					get_class($this)
+				)
+			);
+		}
+	}
 }

core/libraries/shortcodes/EE_Payment_List_Shortcodes.lib.php

Spacing +4 added lines, -4 removed lines

@@ -29,15 +29,15 @@ 
                 'Outputs a list of payment items. Note, this is a dynamic shortcode in that it accepts some attributes for setting certain defaults.  Attributes that are available are:',
                 'event_espresso'
             )
-                                  . '<p><ul>' .
-                                  '<li><strong>no_payments</strong>:' . sprintf(
+                                  . '<p><ul>'.
+                                  '<li><strong>no_payments</strong>:'.sprintf(
                                       esc_html__(
                                           'Indicate with this attribute what will be used if there are no payments present.  Default is: "%sNo approved payments have been received.%s"',
                                           'event_espresso'
                                       ),
                                       htmlspecialchars('<td class="aln-cntr" colspan="6">'),
                                       htmlspecialchars('</td>')
-                                  ) . '</li>' .
+                                  ).'</li>'.
                                   '</ul></p>',
         );
     }
@@ -67,7 +67,7 @@ 
         $this->_validate_list_requirements();
 
 
-        if (! $this->_data['data'] instanceof EE_Messages_Addressee) {
+        if ( ! $this->_data['data'] instanceof EE_Messages_Addressee) {
             return '';
         }
 

Indentation +69 added lines, -69 removed lines

@@ -18,87 +18,87 @@
  */
 class EE_Payment_List_Shortcodes extends EE_Shortcodes
 {
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Payment List Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to payment lists', 'event_espresso');
-        $this->_shortcodes = array(
-            '[PAYMENT_LIST_*]' => esc_html__(
-                'Outputs a list of payment items. Note, this is a dynamic shortcode in that it accepts some attributes for setting certain defaults.  Attributes that are available are:',
-                'event_espresso'
-            )
-                                  . '<p><ul>' .
-                                  '<li><strong>no_payments</strong>:' . sprintf(
-                                      esc_html__(
-                                          'Indicate with this attribute what will be used if there are no payments present.  Default is: "%sNo approved payments have been received.%s"',
-                                          'event_espresso'
-                                      ),
-                                      htmlspecialchars('<td class="aln-cntr" colspan="6">'),
-                                      htmlspecialchars('</td>')
-                                  ) . '</li>' .
-                                  '</ul></p>',
-        );
-    }
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Payment List Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to payment lists', 'event_espresso');
+		$this->_shortcodes = array(
+			'[PAYMENT_LIST_*]' => esc_html__(
+				'Outputs a list of payment items. Note, this is a dynamic shortcode in that it accepts some attributes for setting certain defaults.  Attributes that are available are:',
+				'event_espresso'
+			)
+								  . '<p><ul>' .
+								  '<li><strong>no_payments</strong>:' . sprintf(
+									  esc_html__(
+										  'Indicate with this attribute what will be used if there are no payments present.  Default is: "%sNo approved payments have been received.%s"',
+										  'event_espresso'
+									  ),
+									  htmlspecialchars('<td class="aln-cntr" colspan="6">'),
+									  htmlspecialchars('</td>')
+								  ) . '</li>' .
+								  '</ul></p>',
+		);
+	}
 
 
-    protected function _parser($shortcode)
-    {
-        if (strpos($shortcode, '[PAYMENT_LIST_*') !== false) {
-            return $this->_get_payment_list($shortcode);
-        }
-        return '';
-    }
+	protected function _parser($shortcode)
+	{
+		if (strpos($shortcode, '[PAYMENT_LIST_*') !== false) {
+			return $this->_get_payment_list($shortcode);
+		}
+		return '';
+	}
 
 
-    /**
-     * verify incoming data contains what is needed for retrieving and parsing each payment for transaction.
-     *
-     * @since 4.5.0
-     *
-     * @param string $shortcode The incoming shortcode.
-     *
-     * @return string parsed ticket line item list.
-     */
-    private function _get_payment_list($shortcode)
-    {
-        $this->_validate_list_requirements();
+	/**
+	 * verify incoming data contains what is needed for retrieving and parsing each payment for transaction.
+	 *
+	 * @since 4.5.0
+	 *
+	 * @param string $shortcode The incoming shortcode.
+	 *
+	 * @return string parsed ticket line item list.
+	 */
+	private function _get_payment_list($shortcode)
+	{
+		$this->_validate_list_requirements();
 
 
-        if (! $this->_data['data'] instanceof EE_Messages_Addressee) {
-            return '';
-        }
+		if (! $this->_data['data'] instanceof EE_Messages_Addressee) {
+			return '';
+		}
 
-        $valid_shortcodes = array('payment');
+		$valid_shortcodes = array('payment');
 
-        $addressee_obj = $this->_data['data'];
-        $templates = $this->_extra_data['template'];
-        $payments = apply_filters(
-            'FHEE__Payment_List_Shortcodes___get_payments_list__payments',
-            $addressee_obj->payments
-        );
+		$addressee_obj = $this->_data['data'];
+		$templates = $this->_extra_data['template'];
+		$payments = apply_filters(
+			'FHEE__Payment_List_Shortcodes___get_payments_list__payments',
+			$addressee_obj->payments
+		);
 
-        // let's get any attributes that may be present and set the defaults.
-        $atts = $this->_get_shortcode_attrs($shortcode);
+		// let's get any attributes that may be present and set the defaults.
+		$atts = $this->_get_shortcode_attrs($shortcode);
 
-        $no_payments_msg = empty($atts['no_payments']) ? esc_html__(
-            'No approved payments have been received.',
-            'event_espresso'
-        ) : $atts['no_payments'];
+		$no_payments_msg = empty($atts['no_payments']) ? esc_html__(
+			'No approved payments have been received.',
+			'event_espresso'
+		) : $atts['no_payments'];
 
-        // made it here so we have an array of paymnets, so we should have what we need.
-        $payment_content = empty($payments) ? $no_payments_msg : '';
+		// made it here so we have an array of paymnets, so we should have what we need.
+		$payment_content = empty($payments) ? $no_payments_msg : '';
 
-        $payments = (array) $payments;
+		$payments = (array) $payments;
 
-        foreach ($payments as $payment) {
-            $payment_content .= $this->_shortcode_helper->parse_payment_list_template(
-                $templates['payment_list'],
-                $payment,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
+		foreach ($payments as $payment) {
+			$payment_content .= $this->_shortcode_helper->parse_payment_list_template(
+				$templates['payment_list'],
+				$payment,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
 
-        return $payment_content;
-    }
+		return $payment_content;
+	}
 }

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

Spacing +2 added lines, -2 removed lines

@@ -50,7 +50,7 @@ 
      */
     public function getModelVersionInfo()
     {
-        if (! $this->model_version_info) {
+        if ( ! $this->model_version_info) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -95,7 +95,7 @@ 
      */
     protected function validateModel($model_name)
     {
-        if (! $this->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+        if ( ! $this->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
             throw new RestException(
                 'endpoint_parsing_error',
                 sprintf(

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 ModelVersionInfo
-     * @throws EE_Error
-     */
-    public function getModelVersionInfo()
-    {
-        if (! $this->model_version_info) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        '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 ModelVersionInfo
+	 * @throws EE_Error
+	 */
+	public function getModelVersionInfo()
+	{
+		if (! $this->model_version_info) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'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(
-                    esc_html__(
-                        '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(
+					esc_html__(
+						'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/libraries/rest_api/controllers/model/Write.php

Spacing +18 added lines, -18 removed lines

@@ -134,9 +134,9 @@ 
     {
         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)) {
+        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())),
+                'rest_cannot_create_'.EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
                 sprintf(
                     esc_html__(
                     // @codingStandardsIgnoreStart
@@ -164,7 +164,7 @@ 
         );
         $model_obj->save();
         $new_id = $model_obj->ID();
-        if (! $new_id) {
+        if ( ! $new_id) {
             throw new RestException(
                 'rest_insertion_failed',
                 sprintf(esc_html__('Could not insert new %1$s', 'event_espresso'), $model->get_this_model_name())
@@ -186,9 +186,9 @@ 
     {
         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)) {
+        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())),
+                'rest_cannot_edit_'.EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
                 sprintf(
                     esc_html__(
                     // @codingStandardsIgnoreStart
@@ -202,7 +202,7 @@ 
             );
         }
         $obj_id = $request->get_param('id');
-        if (! $obj_id) {
+        if ( ! $obj_id) {
             throw new RestException(
                 'rest_edit_failed',
                 sprintf(esc_html__('Could not edit %1$s', 'event_espresso'), $model->get_this_model_name())
@@ -215,7 +215,7 @@ 
             true
         );
         $model_obj = $model->get_one_by_ID($obj_id);
-        if (! $model_obj instanceof EE_Base_Class) {
+        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),
@@ -240,9 +240,9 @@ 
     {
         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)) {
+        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())),
+                'rest_cannot_delete_'.EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
                 sprintf(
                     esc_html__(
                     // @codingStandardsIgnoreStart
@@ -258,7 +258,7 @@ 
         $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) {
+        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),
@@ -316,7 +316,7 @@ 
             } 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);
+            $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());
@@ -447,7 +447,7 @@ 
                     )
                 )
             );
-            $response['join'][ strtolower($relation->get_join_model()->get_this_model_name()) ] = $this->returnModelObjAsJsonResponse($join_model_obj, $request);
+            $response['join'][strtolower($relation->get_join_model()->get_this_model_name())] = $this->returnModelObjAsJsonResponse($join_model_obj, $request);
         }
         return $response;
     }
@@ -495,7 +495,7 @@ 
     {
         // 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())) {
+        if ( ! empty($request->get_body_params())) {
             $body_params = $request->get_body_params();
             throw new RestException(
                 'invalid_field',
@@ -537,9 +537,9 @@ 
                 )
             );
             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);
+                $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;
+                $response['join'][strtolower($relation->get_join_model()->get_this_model_name())] = null;
             }
         }
         return $response;
@@ -564,9 +564,9 @@ 
         // 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)) {
+        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())),
+                'rest_cannot_edit_'.EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
                 sprintf(
                     esc_html__(
                         // @codingStandardsIgnoreStart
@@ -583,7 +583,7 @@ 
         $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);
+        return array($model_obj, $other_obj);
     }
 
     /**

Indentation +546 added lines, -546 removed lines

@@ -37,573 +37,573 @@
  */
 class Write extends Base
 {
-    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(esc_html__('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(esc_html__('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(esc_html__('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(esc_html__('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(esc_html__('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(esc_html__('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(esc_html__('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(esc_html__('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(
-                        $relation->get_join_model()->get_foreign_key_to($model->get_this_model_name())->get_name() => $model_obj->ID(),
-                        $relation->get_join_model()->get_foreign_key_to($relation->get_other_model()->get_this_model_name())->get_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(
+						$relation->get_join_model()->get_foreign_key_to($model->get_this_model_name())->get_name() => $model_obj->ID(),
+						$relation->get_join_model()->get_foreign_key_to($relation->get_other_model()->get_this_model_name())->get_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(esc_html__('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(esc_html__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
+			array('status' => 404)
+		);
+	}
 }

core/libraries/rest_api/changes/ChangesInBase.php

Indentation +64 added lines, -64 removed lines

@@ -37,74 +37,74 @@
 abstract class ChangesInBase
 {
 
-    /**
-     * The version that these changes happened
-     *
-     * @var string
-     */
-    protected $version = null;
+	/**
+	 * The version that these changes happened
+	 *
+	 * @var string
+	 */
+	protected $version = null;
 
 
-    /**
-     * Called when an EE4 REST API request is made to an earlier version than
-     * what is indicated in this class' name.
-     * Uses WordPress' add_filter and add_action to modify the EE4 REST API's response
-     * so that regardless of what version of EE4 core is running, API clients
-     * will have a consistent response
-     *
-     * @return void
-     */
-    abstract public function setHooks();
+	/**
+	 * Called when an EE4 REST API request is made to an earlier version than
+	 * what is indicated in this class' name.
+	 * Uses WordPress' add_filter and add_action to modify the EE4 REST API's response
+	 * so that regardless of what version of EE4 core is running, API clients
+	 * will have a consistent response
+	 *
+	 * @return void
+	 */
+	abstract public function setHooks();
 
 
-    /**
-     * Returns whether or not this class' name indicates its hooks should
-     * apply when a request comes in for $requested_version. A class can use
-     * other conditions when determining whether to perform their callbacks or not,
-     * but this will typically be enough
-     *
-     * @param string $requested_version eg "4.8.33"
-     * @return boolean true: this class' name indicates its filters and actions
-     *                                  should take effect. False: this class' name indicates it shouldn't do anything
-     */
-    public function appliesToVersion($requested_version)
-    {
-        if ($this->version() > $requested_version) {
-            return true;
-        }
-        return false;
-    }
+	/**
+	 * Returns whether or not this class' name indicates its hooks should
+	 * apply when a request comes in for $requested_version. A class can use
+	 * other conditions when determining whether to perform their callbacks or not,
+	 * but this will typically be enough
+	 *
+	 * @param string $requested_version eg "4.8.33"
+	 * @return boolean true: this class' name indicates its filters and actions
+	 *                                  should take effect. False: this class' name indicates it shouldn't do anything
+	 */
+	public function appliesToVersion($requested_version)
+	{
+		if ($this->version() > $requested_version) {
+			return true;
+		}
+		return false;
+	}
 
 
-    /**
-     * Gets the EE core version when this changes were made to the rest api.
-     * Any requests to earlier versions should have modifications made to them
-     * by the callbacks of this class.
-     *
-     * @return string eg "4.8.33"
-     * @throws EE_Error
-     */
-    public function version()
-    {
-        if ($this->version === null) {
-            $matches = array();
-            $regex = '~ChangesIn(\d)(\d\d)(\d\d)$~';
-            $success = preg_match(
-                $regex,
-                get_class($this),
-                $matches
-            );
-            if (! $success) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__('The class %1$s was misnamed. It name should match the regex "%2$s"', 'event_espresso'),
-                        get_class($this),
-                        $regex
-                    )
-                );
-            }
-            $this->version = (int) $matches[1] . '.' . (int) $matches[2] . '.' . (int) $matches[3];
-        }
-        return $this->version;
-    }
+	/**
+	 * Gets the EE core version when this changes were made to the rest api.
+	 * Any requests to earlier versions should have modifications made to them
+	 * by the callbacks of this class.
+	 *
+	 * @return string eg "4.8.33"
+	 * @throws EE_Error
+	 */
+	public function version()
+	{
+		if ($this->version === null) {
+			$matches = array();
+			$regex = '~ChangesIn(\d)(\d\d)(\d\d)$~';
+			$success = preg_match(
+				$regex,
+				get_class($this),
+				$matches
+			);
+			if (! $success) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__('The class %1$s was misnamed. It name should match the regex "%2$s"', 'event_espresso'),
+						get_class($this),
+						$regex
+					)
+				);
+			}
+			$this->version = (int) $matches[1] . '.' . (int) $matches[2] . '.' . (int) $matches[3];
+		}
+		return $this->version;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -94,7 +94,7 @@ 
                 get_class($this),
                 $matches
             );
-            if (! $success) {
+            if ( ! $success) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__('The class %1$s was misnamed. It name should match the regex "%2$s"', 'event_espresso'),
@@ -103,7 +103,7 @@ 
                     )
                 );
             }
-            $this->version = (int) $matches[1] . '.' . (int) $matches[2] . '.' . (int) $matches[3];
+            $this->version = (int) $matches[1].'.'.(int) $matches[2].'.'.(int) $matches[3];
         }
         return $this->version;
     }

core/libraries/rest_api/calculations/Datetime.php

Spacing +3 added lines, -3 removed lines

@@ -87,7 +87,7 @@ 
      */
     public function registrationsCheckedInCount($wpdb_row, $request, $controller)
     {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+        if ( ! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -121,7 +121,7 @@ 
      */
     public function registrationsCheckedOutCount($wpdb_row, $request, $controller)
     {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+        if ( ! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -156,7 +156,7 @@ 
      */
     public function spotsTakenPendingPayment($wpdb_row, $request, $controller)
     {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+        if ( ! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(

Indentation +200 added lines, -200 removed lines

@@ -18,214 +18,214 @@
 
 class Datetime extends DatetimeCalculationBase
 {
-    /**
-     * @var EEM_Datetime
-     */
-    protected $datetime_model;
+	/**
+	 * @var EEM_Datetime
+	 */
+	protected $datetime_model;
 
-    /**
-     * @var EEM_Registration
-     */
-    protected $registration_model;
-    public function __construct(EEM_Datetime $datetime_model, EEM_Registration $registration_model)
-    {
-        $this->datetime_model = $datetime_model;
-        $this->registration_model = $registration_model;
-    }
+	/**
+	 * @var EEM_Registration
+	 */
+	protected $registration_model;
+	public function __construct(EEM_Datetime $datetime_model, EEM_Registration $registration_model)
+	{
+		$this->datetime_model = $datetime_model;
+		$this->registration_model = $registration_model;
+	}
 
-    /**
-     * Calculates the total spaces available on the datetime, taking into account
-     * ticket limits too.
-     *
-     * @see EE_Datetime::spaces_remaining( true )
-     * @param array            $wpdb_row
-     * @param WP_REST_Request $request
-     * @param DatetimeControllerBase  $controller
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function spacesRemainingConsideringTickets($wpdb_row, $request, $controller)
-    {
-        if (is_array($wpdb_row) && isset($wpdb_row['Datetime.DTT_ID'])) {
-            $dtt_obj = $this->datetime_model->get_one_by_ID($wpdb_row['Datetime.DTT_ID']);
-        } else {
-            $dtt_obj = null;
-        }
-        if ($dtt_obj instanceof EE_Datetime) {
-            return $dtt_obj->spaces_remaining(true);
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                // @codingStandardsIgnoreStart
-                    'Cannot calculate spaces_remaining_considering_tickets because the datetime with ID %1$s (from database row %2$s) was not found',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                $wpdb_row['Datetime.DTT_ID'],
-                print_r($wpdb_row, true)
-            )
-        );
-    }
+	/**
+	 * Calculates the total spaces available on the datetime, taking into account
+	 * ticket limits too.
+	 *
+	 * @see EE_Datetime::spaces_remaining( true )
+	 * @param array            $wpdb_row
+	 * @param WP_REST_Request $request
+	 * @param DatetimeControllerBase  $controller
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function spacesRemainingConsideringTickets($wpdb_row, $request, $controller)
+	{
+		if (is_array($wpdb_row) && isset($wpdb_row['Datetime.DTT_ID'])) {
+			$dtt_obj = $this->datetime_model->get_one_by_ID($wpdb_row['Datetime.DTT_ID']);
+		} else {
+			$dtt_obj = null;
+		}
+		if ($dtt_obj instanceof EE_Datetime) {
+			return $dtt_obj->spaces_remaining(true);
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+				// @codingStandardsIgnoreStart
+					'Cannot calculate spaces_remaining_considering_tickets because the datetime with ID %1$s (from database row %2$s) was not found',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				$wpdb_row['Datetime.DTT_ID'],
+				print_r($wpdb_row, true)
+			)
+		);
+	}
 
 
-    /**
-     * Counts registrations who have checked into this datetime
-     *
-     * @param array           $wpdb_row
-     * @param WP_REST_Request $request
-     * @param DatetimeControllerBase $controller
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RestException
-     */
-    public function registrationsCheckedInCount($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        $this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_in_count');
-        return $this->registration_model
-                               ->count_registrations_checked_into_datetime($wpdb_row['Datetime.DTT_ID'], true);
-    }
+	/**
+	 * Counts registrations who have checked into this datetime
+	 *
+	 * @param array           $wpdb_row
+	 * @param WP_REST_Request $request
+	 * @param DatetimeControllerBase $controller
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RestException
+	 */
+	public function registrationsCheckedInCount($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		$this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_in_count');
+		return $this->registration_model
+							   ->count_registrations_checked_into_datetime($wpdb_row['Datetime.DTT_ID'], true);
+	}
 
 
-    /**
-     * Counts registrations who have checked out of this datetime
-     *
-     * @param array           $wpdb_row
-     * @param WP_REST_Request $request
-     * @param DatetimeControllerBase $controller
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RestException
-     */
-    public function registrationsCheckedOutCount($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        $this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_out_count');
-        return $this->registration_model
-                               ->count_registrations_checked_into_datetime($wpdb_row['Datetime.DTT_ID'], false);
-    }
+	/**
+	 * Counts registrations who have checked out of this datetime
+	 *
+	 * @param array           $wpdb_row
+	 * @param WP_REST_Request $request
+	 * @param DatetimeControllerBase $controller
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RestException
+	 */
+	public function registrationsCheckedOutCount($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		$this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_out_count');
+		return $this->registration_model
+							   ->count_registrations_checked_into_datetime($wpdb_row['Datetime.DTT_ID'], false);
+	}
 
 
-    /**
-     * Counts the number of pending-payment registrations for this event (regardless
-     * of how many datetimes each registrations' ticket purchase is for)
-     *
-     * @param array           $wpdb_row
-     * @param WP_REST_Request $request
-     * @param DatetimeControllerBase $controller
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RestException
-     */
-    public function spotsTakenPendingPayment($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        $this->verifyCurrentUserCan('ee_read_registrations', 'spots_taken_pending_payment');
-        return $this->registration_model->count(
-            array(
-                array(
-                    'Ticket.Datetime.DTT_ID' => $wpdb_row['Datetime.DTT_ID'],
-                    'STS_ID'                 => RegStatus::PENDING_PAYMENT,
-                ),
-            ),
-            'REG_ID',
-            true
-        );
-    }
+	/**
+	 * Counts the number of pending-payment registrations for this event (regardless
+	 * of how many datetimes each registrations' ticket purchase is for)
+	 *
+	 * @param array           $wpdb_row
+	 * @param WP_REST_Request $request
+	 * @param DatetimeControllerBase $controller
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RestException
+	 */
+	public function spotsTakenPendingPayment($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		$this->verifyCurrentUserCan('ee_read_registrations', 'spots_taken_pending_payment');
+		return $this->registration_model->count(
+			array(
+				array(
+					'Ticket.Datetime.DTT_ID' => $wpdb_row['Datetime.DTT_ID'],
+					'STS_ID'                 => RegStatus::PENDING_PAYMENT,
+				),
+			),
+			'REG_ID',
+			true
+		);
+	}
 
 
-    /**
-     * Provides an array for all the calculations possible that outlines a json schema for those calculations.
-     * Array is indexed by calculation (snake case) and value is the schema for that calculation.
-     *
-     * @since 4.9.68.p
-     * @return array
-     */
-    public function schemaForCalculations()
-    {
-        return array(
-            'spaces_remaining_considering_tickets' => array(
-                'description' => esc_html__(
-                    'Calculates the total spaces available on the datetime, taking into account ticket limits too.',
-                    'event_espresso'
-                ),
-                'type' => 'number',
-                'protected' => true,
-            ),
-            'registrations_checked_in_count' => array(
-                'description' => esc_html__(
-                    'Counts registrations who have checked into this datetime.',
-                    'event_espresso'
-                ),
-                'type' => 'number',
-                'protected' => true,
-            ),
-            'registrations_checked_out_count' => array(
-                'description' => esc_html__(
-                    'Counts registrations who have checked out of this datetime.',
-                    'event_espresso'
-                ),
-                'type' => 'number',
-                'protected' => true,
-            ),
-            'spots_taken_pending_payment' => array(
-                'description' => esc_html__(
-                    'The count of pending-payment registrations for this event (regardless of how many datetimes each registration\'s ticket purchase is for',
-                    'event_espresso'
-                ),
-                'type' => 'number',
-                'protected' => true,
-            ),
-        );
-    }
+	/**
+	 * Provides an array for all the calculations possible that outlines a json schema for those calculations.
+	 * Array is indexed by calculation (snake case) and value is the schema for that calculation.
+	 *
+	 * @since 4.9.68.p
+	 * @return array
+	 */
+	public function schemaForCalculations()
+	{
+		return array(
+			'spaces_remaining_considering_tickets' => array(
+				'description' => esc_html__(
+					'Calculates the total spaces available on the datetime, taking into account ticket limits too.',
+					'event_espresso'
+				),
+				'type' => 'number',
+				'protected' => true,
+			),
+			'registrations_checked_in_count' => array(
+				'description' => esc_html__(
+					'Counts registrations who have checked into this datetime.',
+					'event_espresso'
+				),
+				'type' => 'number',
+				'protected' => true,
+			),
+			'registrations_checked_out_count' => array(
+				'description' => esc_html__(
+					'Counts registrations who have checked out of this datetime.',
+					'event_espresso'
+				),
+				'type' => 'number',
+				'protected' => true,
+			),
+			'spots_taken_pending_payment' => array(
+				'description' => esc_html__(
+					'The count of pending-payment registrations for this event (regardless of how many datetimes each registration\'s ticket purchase is for',
+					'event_espresso'
+				),
+				'type' => 'number',
+				'protected' => true,
+			),
+		);
+	}
 }