eventespresso / event-espresso-core

core/libraries/messages/data_class/EE_Messages_Registrations_incoming_data.class.php

Indentation +114 added lines, -114 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -16,117 +16,117 @@ 
 {
 
 
-    /**
-     * Constructor.
-     *
-     * @param  EE_Registration[] $data expecting an array of EE_Registration objects.
-     * @throws EE_Error
-     * @access protected
-     */
-    public function __construct($data = array())
-    {
-
-        //validate that the first element in the array is an EE_Registration object.
-        if (! reset($data) instanceof EE_Registration) {
-            throw new EE_Error(__('The EE_Message_Registrations_incoming_data class expects an array of EE_Registration objects.',
-                'event_espresso'));
-        }
-        parent::__construct($data);
-    }
-
-
-    /**
-     * setup the data.
-     * Sets up the expected data object for the messages prep using incoming registration objects.
-     *
-     * @return void
-     * @access protected
-     */
-    protected function _setup_data()
-    {
-        //we'll loop through each contact and setup the data needed.  Note that many properties will just be set as empty
-        //because this data handler is for a very specific set of data (i.e. just what's related to the registration).
-
-        $this->reg_objs = $this->data();
-        $this->txn      = $this->_maybe_get_transaction();
-        $this->_assemble_data();
-    }
-
-
-    /**
-     * If the incoming registrations all share the same transaction then this will return the transaction object shared
-     * among the registrations. Otherwise the transaction object is set to null because its intended to only represent
-     * one transaction.
-     *
-     * @return EE_Transaction|null
-     */
-    protected function _maybe_get_transaction()
-    {
-        $transactions = array();
-        foreach ($this->reg_objs as $registration) {
-            if ($registration instanceof EE_Registration) {
-                $transaction = $registration->transaction();
-                if ($transaction instanceof EE_Transaction) {
-                    $transactions[$transaction->ID()] = $transaction;
-                }
-            }
-        }
-        return count($transactions) === 1 ? reset($transactions) : null;
-    }
-
-
-    /**
-     * Returns database safe representation of the data later used to when instantiating this object.
-     *
-     * @param array $registrations The incoming data to be prepped.
-     * @return EE_Registration[]   The data being prepared for the db
-     */
-    static public function convert_data_for_persistent_storage($registrations)
-    {
-        if (
-            ! is_array($registrations)
-            || ! reset($registrations) instanceof EE_Registration
-        ) {
-            return array();
-        }
-
-        $registration_ids = array();
-
-        $registration_ids = array_filter(
-            array_map(
-                function ($registration) {
-                    if ($registration instanceof EE_Registration) {
-                        return $registration->ID();
-                    }
-                    return false;
-                },
-                $registrations
-            )
-        );
-
-        return $registration_ids;
-    }
-
-
-    /**
-     * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
-     * can be sent into this method and converted back into the format used for instantiating with this data handler.
-     *
-     * @param array $data
-     * @return EE_Registration[]
-     */
-    static public function convert_data_from_persistent_storage($data)
-    {
-        //since this was added later, we need to account of possible back compat issues where data already queued for generation
-        //is in the old format, which is an array of EE_Registration objects.  So if that's the case, then let's just return them
-        //@see https://events.codebasehq.com/projects/event-espresso/tickets/10127
-        if (is_array($data) && reset($data) instanceof EE_Registration) {
-            return $data;
-        }
-
-        $registrations = is_array($data)
-            ? EEM_Registration::instance()->get_all(array(array('REG_ID' => array('IN', $data))))
-            : array();
-        return $registrations;
-    }
+	/**
+	 * Constructor.
+	 *
+	 * @param  EE_Registration[] $data expecting an array of EE_Registration objects.
+	 * @throws EE_Error
+	 * @access protected
+	 */
+	public function __construct($data = array())
+	{
+
+		//validate that the first element in the array is an EE_Registration object.
+		if (! reset($data) instanceof EE_Registration) {
+			throw new EE_Error(__('The EE_Message_Registrations_incoming_data class expects an array of EE_Registration objects.',
+				'event_espresso'));
+		}
+		parent::__construct($data);
+	}
+
+
+	/**
+	 * setup the data.
+	 * Sets up the expected data object for the messages prep using incoming registration objects.
+	 *
+	 * @return void
+	 * @access protected
+	 */
+	protected function _setup_data()
+	{
+		//we'll loop through each contact and setup the data needed.  Note that many properties will just be set as empty
+		//because this data handler is for a very specific set of data (i.e. just what's related to the registration).
+
+		$this->reg_objs = $this->data();
+		$this->txn      = $this->_maybe_get_transaction();
+		$this->_assemble_data();
+	}
+
+
+	/**
+	 * If the incoming registrations all share the same transaction then this will return the transaction object shared
+	 * among the registrations. Otherwise the transaction object is set to null because its intended to only represent
+	 * one transaction.
+	 *
+	 * @return EE_Transaction|null
+	 */
+	protected function _maybe_get_transaction()
+	{
+		$transactions = array();
+		foreach ($this->reg_objs as $registration) {
+			if ($registration instanceof EE_Registration) {
+				$transaction = $registration->transaction();
+				if ($transaction instanceof EE_Transaction) {
+					$transactions[$transaction->ID()] = $transaction;
+				}
+			}
+		}
+		return count($transactions) === 1 ? reset($transactions) : null;
+	}
+
+
+	/**
+	 * Returns database safe representation of the data later used to when instantiating this object.
+	 *
+	 * @param array $registrations The incoming data to be prepped.
+	 * @return EE_Registration[]   The data being prepared for the db
+	 */
+	static public function convert_data_for_persistent_storage($registrations)
+	{
+		if (
+			! is_array($registrations)
+			|| ! reset($registrations) instanceof EE_Registration
+		) {
+			return array();
+		}
+
+		$registration_ids = array();
+
+		$registration_ids = array_filter(
+			array_map(
+				function ($registration) {
+					if ($registration instanceof EE_Registration) {
+						return $registration->ID();
+					}
+					return false;
+				},
+				$registrations
+			)
+		);
+
+		return $registration_ids;
+	}
+
+
+	/**
+	 * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
+	 * can be sent into this method and converted back into the format used for instantiating with this data handler.
+	 *
+	 * @param array $data
+	 * @return EE_Registration[]
+	 */
+	static public function convert_data_from_persistent_storage($data)
+	{
+		//since this was added later, we need to account of possible back compat issues where data already queued for generation
+		//is in the old format, which is an array of EE_Registration objects.  So if that's the case, then let's just return them
+		//@see https://events.codebasehq.com/projects/event-espresso/tickets/10127
+		if (is_array($data) && reset($data) instanceof EE_Registration) {
+			return $data;
+		}
+
+		$registrations = is_array($data)
+			? EEM_Registration::instance()->get_all(array(array('REG_ID' => array('IN', $data))))
+			: array();
+		return $registrations;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -27,7 +27,7 @@ 
     {
 
         //validate that the first element in the array is an EE_Registration object.
-        if (! reset($data) instanceof EE_Registration) {
+        if ( ! reset($data) instanceof EE_Registration) {
             throw new EE_Error(__('The EE_Message_Registrations_incoming_data class expects an array of EE_Registration objects.',
                 'event_espresso'));
         }
@@ -94,7 +94,7 @@ 
 
         $registration_ids = array_filter(
             array_map(
-                function ($registration) {
+                function($registration) {
                     if ($registration instanceof EE_Registration) {
                         return $registration->ID();
                     }

core/helpers/EEH_Parse_Shortcodes.helper.php

Spacing +6 added lines, -6 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
 }
 
@@ -186,7 +186,7 @@ 
     {
         //now let's get a list of shortcodes that are found in the given template
         preg_match_all('/(\[.+?\])/', $this->_template, $matches);
-        $shortcodes = (array)$matches[0]; //this should be an array of shortcodes in the template string.
+        $shortcodes = (array) $matches[0]; //this should be an array of shortcodes in the template string.
 
         $matched_code = array();
         $sc_values    = array();
@@ -220,14 +220,14 @@ 
                 if ($sc_obj instanceof EE_Shortcodes) {
                     //we need to setup any dynamic shortcodes so that they work with the array_key_exists
                     preg_match_all('/(\[[A-Za-z0-9\_]+_\*)/', $shortcode, $matches);
-                    $sc_to_verify = ! empty($matches[0]) ? $matches[0][0] . ']' : $shortcode;
+                    $sc_to_verify = ! empty($matches[0]) ? $matches[0][0].']' : $shortcode;
 
-                    if (! array_key_exists($sc_to_verify, $sc_obj->get_shortcodes())) {
+                    if ( ! array_key_exists($sc_to_verify, $sc_obj->get_shortcodes())) {
                         continue; //the given shortcode isn't in this object
                     }
 
                     //if this isn't  a "list" type shortcode then we'll send along the data vanilla instead of in an array.
-                    if (! in_array($sc_to_verify, $list_type_shortcodes)) {
+                    if ( ! in_array($sc_to_verify, $list_type_shortcodes)) {
                         $data_send = ! is_object($this->_data) && isset($this->_data['data']) ? $this->_data['data'] : $this->_data;
                     } else {
                         $data_send = $this->_data;
@@ -261,7 +261,7 @@ 
         foreach ($valid_shortcodes as $shortcode_ref) {
             $ref       = ucwords(str_replace('_', ' ', $shortcode_ref));
             $ref       = str_replace(' ', '_', $ref);
-            $classname = 'EE_' . $ref . '_Shortcodes';
+            $classname = 'EE_'.$ref.'_Shortcodes';
             if (class_exists($classname)) {
                 $this->_shortcode_objs[] = new $classname;
             }

Indentation +264 added lines, -264 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 /**
@@ -26,269 +26,269 @@ 
 {
 
 
-    /**
-     * holds the template
-     *
-     * @access private
-     * @var mixed (string|array)
-     */
-    private $_template;
-
-
-    /**
-     * holds the incoming data object
-     *
-     * @access private
-     * @var object
-     */
-    private $_data;
-
-
-    /**
-     * will hold an array of EE_Shortcodes library objects.
-     *
-     * @access private
-     * @var EE_Shortcodes[]
-     */
-    private $_shortcode_objs = array();
-
-
-    public function __construct()
-    {
-    }
-
-
-    /**
-     * This kicks off the parsing of shortcodes in message templates
-     *
-     * @param  string                $template         This is the incoming string to be parsed
-     * @param  EE_Messages_Addressee $data             This is the incoming data object
-     * @param  array                 $valid_shortcodes An array of strings that correspond to EE_Shortcode libraries
-     * @param EE_message_type        $message_type     The message type that called the parser
-     * @param EE_messenger           $messenger        The active messenger for this parsing session.
-     * @param EE_Message             $message
-     * @return string                   The parsed template string
-     */
-    public function parse_message_template(
-        $template,
-        EE_Messages_Addressee $data,
-        $valid_shortcodes,
-        EE_message_type $message_type,
-        EE_messenger $messenger,
-        EE_Message $message
-    ) {
-        $extra_data = array(
-            'messenger'    => $messenger,
-            'message_type' => $message_type,
-            'message'      => $message,
-        );
-        $this->_init_data($template, $data, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['main'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    public function parse_attendee_list_template(
-        $template,
-        EE_Registration $registration,
-        $valid_shortcodes,
-        $extra_data = array()
-    ) {
-        $this->_init_data($template, $registration, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['attendee_list'] : $template;
-        return $this->_parse_message_template();
-    }
-
-    public function parse_event_list_template($template, EE_Event $event, $valid_shortcodes, $extra_data = array())
-    {
-        $this->_init_data($template, $event, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['event_list'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    public function parse_ticket_list_template($template, EE_Ticket $ticket, $valid_shortcodes, $extra_data = array())
-    {
-        $this->_init_data($template, $ticket, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['ticket_list'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    public function parse_line_item_list_template(
-        $template,
-        EE_Line_Item $line_item,
-        $valid_shortcodes,
-        $extra_data = array()
-    ) {
-        $this->_init_data($template, $line_item, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['ticket_line_item_no_pms'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    public function parse_payment_list_template(
-        $template,
-        EE_Payment $payment_item,
-        $valid_shortcodes,
-        $extra_data = array()
-    ) {
-        $this->_init_data($template, $payment_item, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['payment_list'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    public function parse_datetime_list_template(
-        $template,
-        EE_Datetime $datetime,
-        $valid_shortcodes,
-        $extra_data = array()
-    ) {
-        $this->_init_data($template, $datetime, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['datetime_list'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    public function parse_question_list_template($template, EE_Answer $answer, $valid_shortcodes, $extra_data = array())
-    {
-        $this->_init_data($template, $answer, $valid_shortcodes, $extra_data);
-        $this->_template = is_array($template) ? $template['question_list'] : $template;
-        return $this->_parse_message_template();
-    }
-
-
-    private function _init_data($template, $data, $valid_shortcodes, $extra_data = array())
-    {
-        $this->_reset_props();
-        $this->_data['template']   = $template;
-        $this->_data['data']       = $data;
-        $this->_data['extra_data'] = $extra_data;
-        $this->_set_shortcodes($valid_shortcodes);
-    }
-
-
-    private function _reset_props()
-    {
-        $this->_template       = $this->_data = null;
-        $this->_shortcode_objs = array();
-    }
-
-
-    /**
-     * takes the given template and parses it with the $_shortcodes property
-     *
-     * @access private
-     * @return string
-     */
-    private function _parse_message_template()
-    {
-        //now let's get a list of shortcodes that are found in the given template
-        preg_match_all('/(\[.+?\])/', $this->_template, $matches);
-        $shortcodes = (array)$matches[0]; //this should be an array of shortcodes in the template string.
-
-        $matched_code = array();
-        $sc_values    = array();
-
-        $list_type_shortcodes = array(
-            '[ATTENDEE_LIST]',
-            '[EVENT_LIST]',
-            '[TICKET_LIST]',
-            '[DATETIME_LIST]',
-            '[QUESTION_LIST]',
-            '[RECIPIENT_QUESTION_LIST]',
-            '[PRIMARY_REGISTRANT_QUESTION_LIST]',
-            '[RECIPIENT_TICKET_LIST]',
-            '[PRIMARY_REGISTRANT_TICKET_LIST]',
-            '[RECIPIENT_DATETIME_LIST]',
-            '[PRIMARY_REGISTRANT_DATETIME_LIST]',
-            '[TICKET_LINE_ITEM_LIST]',
-            '[TAX_LINE_ITEM_LIST]',
-            '[ADDITIONAL_LINE_ITEM_LIST]',
-            '[PRICE_MODIFIER_LINE_ITEM_LIST]',
-            '[PAYMENT_LIST_*]',
-        );
-
-        $list_type_shortcodes = apply_filters('FHEE__EEH_Parse_Shortcodes___parse_message_template__list_type_shortcodes',
-            $list_type_shortcodes);
-
-        //now lets go ahead and loop through our parsers for each shortcode and setup the values
-        foreach ($shortcodes as $shortcode) {
-
-            foreach ($this->_shortcode_objs as $sc_obj) {
-                if ($sc_obj instanceof EE_Shortcodes) {
-                    //we need to setup any dynamic shortcodes so that they work with the array_key_exists
-                    preg_match_all('/(\[[A-Za-z0-9\_]+_\*)/', $shortcode, $matches);
-                    $sc_to_verify = ! empty($matches[0]) ? $matches[0][0] . ']' : $shortcode;
-
-                    if (! array_key_exists($sc_to_verify, $sc_obj->get_shortcodes())) {
-                        continue; //the given shortcode isn't in this object
-                    }
-
-                    //if this isn't  a "list" type shortcode then we'll send along the data vanilla instead of in an array.
-                    if (! in_array($sc_to_verify, $list_type_shortcodes)) {
-                        $data_send = ! is_object($this->_data) && isset($this->_data['data']) ? $this->_data['data'] : $this->_data;
-                    } else {
-                        $data_send = $this->_data;
-                    }
-
-                    //is this a conditional type shortcode?  If it is then we actually parse the template here.
-                    if ($this->_is_conditional_shortcode($shortcode)) {
-                        //most shortcode parsers are not going to have a match for this shortcode and will return an
-                        //empty string so we need to make sure that we're only replacing the template when there is a non empty string.
-                        $parsed = $sc_obj->parser($shortcode, $data_send, $this->_data['extra_data']);
-                        if ($parsed) {
-                            $this->_template = $parsed;
-                        }
-                    }
-
-                    $parsed = $sc_obj->parser($shortcode, $data_send, $this->_data['extra_data']);
-
-                    $matched_code[] = $shortcode;
-                    $sc_values[]    = $parsed;
-                }
-            }
-        }
-
-        //now we've got parsed values for all the shortcodes in the template so we can go ahead and swap the shortcodes out.
-        $parsed = str_replace(array_values($matched_code), array_values($sc_values), $this->_template);
-        return $parsed;
-    }
-
-
-    /**
-     * Simply returns whether the given shortcode matches the structure for a conditional shortcode.
-     *
-     * Does it match this format: `[IF_`
-     *
-     * @param $shortcode
-     */
-    protected function _is_conditional_shortcode($shortcode)
-    {
-        return strpos($shortcode, '[IF_') === 0;
-    }
-
-
-    /**
-     * This sets the shortcodes property from the incoming array of valid shortcodes that corresponds to names of
-     * various EE_Shortcode library objects
-     *
-     * @access private
-     * @param array $valid_shortcodes an array of strings corresponding to EE_Shortcode Library objects
-     * @return void
-     */
-    private function _set_shortcodes($valid_shortcodes)
-    {
-        foreach ($valid_shortcodes as $shortcode_ref) {
-            $ref       = ucwords(str_replace('_', ' ', $shortcode_ref));
-            $ref       = str_replace(' ', '_', $ref);
-            $classname = 'EE_' . $ref . '_Shortcodes';
-            if (class_exists($classname)) {
-                $this->_shortcode_objs[] = new $classname;
-            }
-        }
-    }
+	/**
+	 * holds the template
+	 *
+	 * @access private
+	 * @var mixed (string|array)
+	 */
+	private $_template;
+
+
+	/**
+	 * holds the incoming data object
+	 *
+	 * @access private
+	 * @var object
+	 */
+	private $_data;
+
+
+	/**
+	 * will hold an array of EE_Shortcodes library objects.
+	 *
+	 * @access private
+	 * @var EE_Shortcodes[]
+	 */
+	private $_shortcode_objs = array();
+
+
+	public function __construct()
+	{
+	}
+
+
+	/**
+	 * This kicks off the parsing of shortcodes in message templates
+	 *
+	 * @param  string                $template         This is the incoming string to be parsed
+	 * @param  EE_Messages_Addressee $data             This is the incoming data object
+	 * @param  array                 $valid_shortcodes An array of strings that correspond to EE_Shortcode libraries
+	 * @param EE_message_type        $message_type     The message type that called the parser
+	 * @param EE_messenger           $messenger        The active messenger for this parsing session.
+	 * @param EE_Message             $message
+	 * @return string                   The parsed template string
+	 */
+	public function parse_message_template(
+		$template,
+		EE_Messages_Addressee $data,
+		$valid_shortcodes,
+		EE_message_type $message_type,
+		EE_messenger $messenger,
+		EE_Message $message
+	) {
+		$extra_data = array(
+			'messenger'    => $messenger,
+			'message_type' => $message_type,
+			'message'      => $message,
+		);
+		$this->_init_data($template, $data, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['main'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	public function parse_attendee_list_template(
+		$template,
+		EE_Registration $registration,
+		$valid_shortcodes,
+		$extra_data = array()
+	) {
+		$this->_init_data($template, $registration, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['attendee_list'] : $template;
+		return $this->_parse_message_template();
+	}
+
+	public function parse_event_list_template($template, EE_Event $event, $valid_shortcodes, $extra_data = array())
+	{
+		$this->_init_data($template, $event, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['event_list'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	public function parse_ticket_list_template($template, EE_Ticket $ticket, $valid_shortcodes, $extra_data = array())
+	{
+		$this->_init_data($template, $ticket, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['ticket_list'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	public function parse_line_item_list_template(
+		$template,
+		EE_Line_Item $line_item,
+		$valid_shortcodes,
+		$extra_data = array()
+	) {
+		$this->_init_data($template, $line_item, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['ticket_line_item_no_pms'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	public function parse_payment_list_template(
+		$template,
+		EE_Payment $payment_item,
+		$valid_shortcodes,
+		$extra_data = array()
+	) {
+		$this->_init_data($template, $payment_item, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['payment_list'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	public function parse_datetime_list_template(
+		$template,
+		EE_Datetime $datetime,
+		$valid_shortcodes,
+		$extra_data = array()
+	) {
+		$this->_init_data($template, $datetime, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['datetime_list'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	public function parse_question_list_template($template, EE_Answer $answer, $valid_shortcodes, $extra_data = array())
+	{
+		$this->_init_data($template, $answer, $valid_shortcodes, $extra_data);
+		$this->_template = is_array($template) ? $template['question_list'] : $template;
+		return $this->_parse_message_template();
+	}
+
+
+	private function _init_data($template, $data, $valid_shortcodes, $extra_data = array())
+	{
+		$this->_reset_props();
+		$this->_data['template']   = $template;
+		$this->_data['data']       = $data;
+		$this->_data['extra_data'] = $extra_data;
+		$this->_set_shortcodes($valid_shortcodes);
+	}
+
+
+	private function _reset_props()
+	{
+		$this->_template       = $this->_data = null;
+		$this->_shortcode_objs = array();
+	}
+
+
+	/**
+	 * takes the given template and parses it with the $_shortcodes property
+	 *
+	 * @access private
+	 * @return string
+	 */
+	private function _parse_message_template()
+	{
+		//now let's get a list of shortcodes that are found in the given template
+		preg_match_all('/(\[.+?\])/', $this->_template, $matches);
+		$shortcodes = (array)$matches[0]; //this should be an array of shortcodes in the template string.
+
+		$matched_code = array();
+		$sc_values    = array();
+
+		$list_type_shortcodes = array(
+			'[ATTENDEE_LIST]',
+			'[EVENT_LIST]',
+			'[TICKET_LIST]',
+			'[DATETIME_LIST]',
+			'[QUESTION_LIST]',
+			'[RECIPIENT_QUESTION_LIST]',
+			'[PRIMARY_REGISTRANT_QUESTION_LIST]',
+			'[RECIPIENT_TICKET_LIST]',
+			'[PRIMARY_REGISTRANT_TICKET_LIST]',
+			'[RECIPIENT_DATETIME_LIST]',
+			'[PRIMARY_REGISTRANT_DATETIME_LIST]',
+			'[TICKET_LINE_ITEM_LIST]',
+			'[TAX_LINE_ITEM_LIST]',
+			'[ADDITIONAL_LINE_ITEM_LIST]',
+			'[PRICE_MODIFIER_LINE_ITEM_LIST]',
+			'[PAYMENT_LIST_*]',
+		);
+
+		$list_type_shortcodes = apply_filters('FHEE__EEH_Parse_Shortcodes___parse_message_template__list_type_shortcodes',
+			$list_type_shortcodes);
+
+		//now lets go ahead and loop through our parsers for each shortcode and setup the values
+		foreach ($shortcodes as $shortcode) {
+
+			foreach ($this->_shortcode_objs as $sc_obj) {
+				if ($sc_obj instanceof EE_Shortcodes) {
+					//we need to setup any dynamic shortcodes so that they work with the array_key_exists
+					preg_match_all('/(\[[A-Za-z0-9\_]+_\*)/', $shortcode, $matches);
+					$sc_to_verify = ! empty($matches[0]) ? $matches[0][0] . ']' : $shortcode;
+
+					if (! array_key_exists($sc_to_verify, $sc_obj->get_shortcodes())) {
+						continue; //the given shortcode isn't in this object
+					}
+
+					//if this isn't  a "list" type shortcode then we'll send along the data vanilla instead of in an array.
+					if (! in_array($sc_to_verify, $list_type_shortcodes)) {
+						$data_send = ! is_object($this->_data) && isset($this->_data['data']) ? $this->_data['data'] : $this->_data;
+					} else {
+						$data_send = $this->_data;
+					}
+
+					//is this a conditional type shortcode?  If it is then we actually parse the template here.
+					if ($this->_is_conditional_shortcode($shortcode)) {
+						//most shortcode parsers are not going to have a match for this shortcode and will return an
+						//empty string so we need to make sure that we're only replacing the template when there is a non empty string.
+						$parsed = $sc_obj->parser($shortcode, $data_send, $this->_data['extra_data']);
+						if ($parsed) {
+							$this->_template = $parsed;
+						}
+					}
+
+					$parsed = $sc_obj->parser($shortcode, $data_send, $this->_data['extra_data']);
+
+					$matched_code[] = $shortcode;
+					$sc_values[]    = $parsed;
+				}
+			}
+		}
+
+		//now we've got parsed values for all the shortcodes in the template so we can go ahead and swap the shortcodes out.
+		$parsed = str_replace(array_values($matched_code), array_values($sc_values), $this->_template);
+		return $parsed;
+	}
+
+
+	/**
+	 * Simply returns whether the given shortcode matches the structure for a conditional shortcode.
+	 *
+	 * Does it match this format: `[IF_`
+	 *
+	 * @param $shortcode
+	 */
+	protected function _is_conditional_shortcode($shortcode)
+	{
+		return strpos($shortcode, '[IF_') === 0;
+	}
+
+
+	/**
+	 * This sets the shortcodes property from the incoming array of valid shortcodes that corresponds to names of
+	 * various EE_Shortcode library objects
+	 *
+	 * @access private
+	 * @param array $valid_shortcodes an array of strings corresponding to EE_Shortcode Library objects
+	 * @return void
+	 */
+	private function _set_shortcodes($valid_shortcodes)
+	{
+		foreach ($valid_shortcodes as $shortcode_ref) {
+			$ref       = ucwords(str_replace('_', ' ', $shortcode_ref));
+			$ref       = str_replace(' ', '_', $ref);
+			$classname = 'EE_' . $ref . '_Shortcodes';
+			if (class_exists($classname)) {
+				$this->_shortcode_objs[] = new $classname;
+			}
+		}
+	}
 
 
 } //end EEH_Parse_Shortcodes

core/db_classes/EE_Line_Item.class.php

Spacing +209 added lines, -209 removed lines

@@ -1,5 +1,5 @@ 
-<?php if ( !defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 /**
  * Event Espresso
@@ -50,9 +50,9 @@ 
 	 *                             		    date_format and the second value is the time format
 	 * @return EE_Line_Item
 	 */
-	public static function new_instance( $props_n_values = array(), $timezone = null, $date_formats = array() ) {
-		$has_object = parent::_check_for_object( $props_n_values, __CLASS__, $timezone, $date_formats );
-		return $has_object ? $has_object : new self( $props_n_values, false, $timezone, $date_formats );
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) {
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
 	}
 
 
@@ -63,8 +63,8 @@ 
 	 *                          		the website will be used.
 	 * @return EE_Line_Item
 	 */
-	public static function new_instance_from_db( $props_n_values = array(), $timezone = null ) {
-		return new self( $props_n_values, TRUE, $timezone );
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null) {
+		return new self($props_n_values, TRUE, $timezone);
 	}
 
 
@@ -75,10 +75,10 @@ 
 	 * @param bool   $bydb
 	 * @param string $timezone
 	 */
-	protected function __construct( $fieldValues = array(), $bydb = FALSE, $timezone = '' ) {
-		parent::__construct( $fieldValues, $bydb, $timezone );
-		if ( ! $this->get( 'LIN_code' ) ) {
-			$this->set_code( $this->generate_code() );
+	protected function __construct($fieldValues = array(), $bydb = FALSE, $timezone = '') {
+		parent::__construct($fieldValues, $bydb, $timezone);
+		if ( ! $this->get('LIN_code')) {
+			$this->set_code($this->generate_code());
 		}
 	}
 
@@ -89,7 +89,7 @@ 
 	 * @return int
 	 */
 	public function ID() {
-		return $this->get( 'LIN_ID' );
+		return $this->get('LIN_ID');
 	}
 
 
@@ -99,7 +99,7 @@ 
 	 * @return int
 	 */
 	public function TXN_ID() {
-		return $this->get( 'TXN_ID' );
+		return $this->get('TXN_ID');
 	}
 
 
@@ -108,8 +108,8 @@ 
 	 * Sets TXN_ID
 	 * @param int $TXN_ID
 	 */
-	public function set_TXN_ID( $TXN_ID ) {
-		$this->set( 'TXN_ID', $TXN_ID );
+	public function set_TXN_ID($TXN_ID) {
+		$this->set('TXN_ID', $TXN_ID);
 	}
 
 
@@ -119,9 +119,9 @@ 
 	 * @return string
 	 */
 	public function name() {
-		$name =  $this->get( 'LIN_name' );
-		if( ! $name ){
-			$name = ucwords( str_replace( '-', ' ', $this->type() ) );
+		$name = $this->get('LIN_name');
+		if ( ! $name) {
+			$name = ucwords(str_replace('-', ' ', $this->type()));
 		}
 		return $name;
 	}
@@ -132,8 +132,8 @@ 
 	 * Sets name
 	 * @param string $name
 	 */
-	public function set_name( $name ) {
-		$this->set( 'LIN_name', $name );
+	public function set_name($name) {
+		$this->set('LIN_name', $name);
 	}
 
 
@@ -143,7 +143,7 @@ 
 	 * @return string
 	 */
 	public function desc() {
-		return $this->get( 'LIN_desc' );
+		return $this->get('LIN_desc');
 	}
 
 
@@ -152,8 +152,8 @@ 
 	 * Sets desc
 	 * @param string $desc
 	 */
-	public function set_desc( $desc ) {
-		$this->set( 'LIN_desc', $desc );
+	public function set_desc($desc) {
+		$this->set('LIN_desc', $desc);
 	}
 
 
@@ -163,7 +163,7 @@ 
 	 * @return int
 	 */
 	public function quantity() {
-		return $this->get( 'LIN_quantity' );
+		return $this->get('LIN_quantity');
 	}
 
 
@@ -172,8 +172,8 @@ 
 	 * Sets quantity
 	 * @param int $quantity
 	 */
-    public function set_quantity( $quantity ) {
-		$this->set( 'LIN_quantity', max( $quantity, 0 ) );
+    public function set_quantity($quantity) {
+		$this->set('LIN_quantity', max($quantity, 0));
 	}
 
 
@@ -183,7 +183,7 @@ 
 	 * @return string
 	 */
 	public function OBJ_ID() {
-		return $this->get( 'OBJ_ID' );
+		return $this->get('OBJ_ID');
 	}
 
 
@@ -192,8 +192,8 @@ 
 	 * Sets item_id
 	 * @param string $item_id
 	 */
-	public function set_OBJ_ID( $item_id ) {
-		$this->set( 'OBJ_ID', $item_id );
+	public function set_OBJ_ID($item_id) {
+		$this->set('OBJ_ID', $item_id);
 	}
 
 
@@ -203,7 +203,7 @@ 
 	 * @return string
 	 */
 	public function OBJ_type() {
-		return $this->get( 'OBJ_type' );
+		return $this->get('OBJ_type');
 	}
 
 
@@ -240,8 +240,8 @@ 
 	 * Sets item_type
 	 * @param string $OBJ_type
 	 */
-	public function set_OBJ_type( $OBJ_type ) {
-		$this->set( 'OBJ_type', $OBJ_type );
+	public function set_OBJ_type($OBJ_type) {
+		$this->set('OBJ_type', $OBJ_type);
 	}
 
 
@@ -251,7 +251,7 @@ 
 	 * @return float
 	 */
 	public function unit_price() {
-		return $this->get( 'LIN_unit_price' );
+		return $this->get('LIN_unit_price');
 	}
 
 
@@ -261,8 +261,8 @@ 
 	 *
 	 * @param float $unit_price
 	 */
-	public function set_unit_price( $unit_price ) {
-		$this->set( 'LIN_unit_price', $unit_price );
+	public function set_unit_price($unit_price) {
+		$this->set('LIN_unit_price', $unit_price);
 	}
 
 
@@ -273,19 +273,19 @@ 
 	 * @return boolean
 	 */
 	public function is_percent() {
-		if( $this->is_tax_sub_total() ) {
+		if ($this->is_tax_sub_total()) {
 			//tax subtotals HAVE a percent on them, that percentage only applies
 			//to taxable items, so its' an exception. Treat it like a flat line item
 			return false;
 		}
-		$unit_price = abs( $this->get( 'LIN_unit_price' ) );
-		$percent = abs( $this->get( 'LIN_percent' ) );
-		if ( $unit_price < .001 && $percent ) {
+		$unit_price = abs($this->get('LIN_unit_price'));
+		$percent = abs($this->get('LIN_percent'));
+		if ($unit_price < .001 && $percent) {
 			return TRUE;
-		} elseif ( $unit_price >= .001 && !$percent ) {
+		} elseif ($unit_price >= .001 && ! $percent) {
 			return FALSE;
-		} elseif ( $unit_price >= .001 && $percent ) {
-			throw new EE_Error( sprintf( __( "A Line Item can not have a unit price of (%s) AND a percent (%s)!", "event_espresso" ), $unit_price, $percent ) );
+		} elseif ($unit_price >= .001 && $percent) {
+			throw new EE_Error(sprintf(__("A Line Item can not have a unit price of (%s) AND a percent (%s)!", "event_espresso"), $unit_price, $percent));
 		} else {
 			// if they're both 0, assume its not a percent item
 			return FALSE;
@@ -299,7 +299,7 @@ 
 	 * @return float
 	 */
 	public function percent() {
-		return $this->get( 'LIN_percent' );
+		return $this->get('LIN_percent');
 	}
 
 
@@ -308,8 +308,8 @@ 
 	 * Sets percent (between 100-0.01)
 	 * @param float $percent
 	 */
-	public function set_percent( $percent ) {
-		$this->set( 'LIN_percent', $percent );
+	public function set_percent($percent) {
+		$this->set('LIN_percent', $percent);
 	}
 
 
@@ -319,7 +319,7 @@ 
 	 * @return float
 	 */
 	public function total() {
-		return $this->get( 'LIN_total' );
+		return $this->get('LIN_total');
 	}
 
 
@@ -328,8 +328,8 @@ 
 	 * Sets total
 	 * @param float $total
 	 */
-	public function set_total( $total ) {
-		$this->set( 'LIN_total', $total );
+	public function set_total($total) {
+		$this->set('LIN_total', $total);
 	}
 
 
@@ -339,7 +339,7 @@ 
 	 * @return int
 	 */
 	public function order() {
-		return $this->get( 'LIN_order' );
+		return $this->get('LIN_order');
 	}
 
 
@@ -348,8 +348,8 @@ 
 	 * Sets order
 	 * @param int $order
 	 */
-	public function set_order( $order ) {
-		$this->set( 'LIN_order', $order );
+	public function set_order($order) {
+		$this->set('LIN_order', $order);
 	}
 
 
@@ -359,7 +359,7 @@ 
 	 * @return int
 	 */
 	public function parent_ID() {
-		return $this->get( 'LIN_parent' );
+		return $this->get('LIN_parent');
 	}
 
 
@@ -368,8 +368,8 @@ 
 	 * Sets parent
 	 * @param int $parent
 	 */
-	public function set_parent_ID( $parent ) {
-		$this->set( 'LIN_parent', $parent );
+	public function set_parent_ID($parent) {
+		$this->set('LIN_parent', $parent);
 	}
 
 
@@ -379,7 +379,7 @@ 
 	 * @return string
 	 */
 	public function type() {
-		return $this->get( 'LIN_type' );
+		return $this->get('LIN_type');
 	}
 
 
@@ -388,8 +388,8 @@ 
 	 * Sets type
 	 * @param string $type
 	 */
-	public function set_type( $type ) {
-		$this->set( 'LIN_type', $type );
+	public function set_type($type) {
+		$this->set('LIN_type', $type);
 	}
 
 
@@ -402,8 +402,8 @@ 
 	 * @return EE_Line_Item
 	 */
 	public function parent() {
-		if( $this->ID() ) {
-			return $this->get_model()->get_one_by_ID( $this->parent_ID() );
+		if ($this->ID()) {
+			return $this->get_model()->get_one_by_ID($this->parent_ID());
 		} else {
 			return $this->_parent;
 		}
@@ -416,13 +416,13 @@ 
 	 * @return EE_Line_Item[]
 	 */
 	public function children() {
-		if ( $this->ID() ) {
+		if ($this->ID()) {
 			return $this->get_model()->get_all(
 					array(
-						array( 'LIN_parent' => $this->ID() ),
-						'order_by' => array( 'LIN_order' => 'ASC' ) ) );
+						array('LIN_parent' => $this->ID()),
+						'order_by' => array('LIN_order' => 'ASC') ) );
 		} else {
-			if ( ! is_array( $this->_children ) ) {
+			if ( ! is_array($this->_children)) {
 				$this->_children = array();
 			}
 			return $this->_children;
@@ -436,7 +436,7 @@ 
 	 * @return string
 	 */
 	public function code() {
-		return $this->get( 'LIN_code' );
+		return $this->get('LIN_code');
 	}
 
 
@@ -445,8 +445,8 @@ 
 	 * Sets code
 	 * @param string $code
 	 */
-	public function set_code( $code ) {
-		$this->set( 'LIN_code', $code );
+	public function set_code($code) {
+		$this->set('LIN_code', $code);
 	}
 
 
@@ -456,7 +456,7 @@ 
 	 * @return boolean
 	 */
 	public function is_taxable() {
-		return $this->get( 'LIN_is_taxable' );
+		return $this->get('LIN_is_taxable');
 	}
 
 
@@ -465,8 +465,8 @@ 
 	 * Sets is_taxable
 	 * @param boolean $is_taxable
 	 */
-	public function set_is_taxable( $is_taxable ) {
-		$this->set( 'LIN_is_taxable', $is_taxable );
+	public function set_is_taxable($is_taxable) {
+		$this->set('LIN_is_taxable', $is_taxable);
 	}
 
 
@@ -481,7 +481,7 @@ 
 	 */
 	public function get_object() {
 		$model_name_of_related_obj = $this->OBJ_type();
-		return $this->get_model()->has_relation(  $model_name_of_related_obj ) ? $this->get_first_related( $model_name_of_related_obj ) : NULL;
+		return $this->get_model()->has_relation($model_name_of_related_obj) ? $this->get_first_related($model_name_of_related_obj) : NULL;
 	}
 
 
@@ -492,11 +492,11 @@ 
 	 * @param array $query_params
 	 * @return EE_Ticket
 	 */
-	public function ticket( $query_params = array() ) {
+	public function ticket($query_params = array()) {
 		//we're going to assume that when this method is called we always want to receive the attached ticket EVEN if that ticket is archived.  This can be overridden via the incoming $query_params argument
-		$remove_defaults = array( 'default_where_conditions' => 'none' );
-		$query_params = array_merge( $remove_defaults, $query_params );
-		return $this->get_first_related( 'Ticket', $query_params );
+		$remove_defaults = array('default_where_conditions' => 'none');
+		$query_params = array_merge($remove_defaults, $query_params);
+		return $this->get_first_related('Ticket', $query_params);
 	}
 
 
@@ -506,11 +506,11 @@ 
 	 * @return EE_Datetime | NULL
 	 */
 	public function get_ticket_datetime() {
-		if ( $this->OBJ_type() === 'Ticket' ) {
+		if ($this->OBJ_type() === 'Ticket') {
 			$ticket = $this->ticket();
-			if ( $ticket instanceof EE_Ticket ) {
+			if ($ticket instanceof EE_Ticket) {
 				$datetime = $ticket->first_datetime();
-				if ( $datetime instanceof EE_Datetime ) {
+				if ($datetime instanceof EE_Datetime) {
 					return $datetime;
 				}
 			}
@@ -526,9 +526,9 @@ 
 	 * @return string
 	 */
 	public function ticket_event_name() {
-		$event_name = __( "Unknown", "event_espresso" );
+		$event_name = __("Unknown", "event_espresso");
 		$event = $this->ticket_event();
-		if ( $event instanceof EE_Event ) {
+		if ($event instanceof EE_Event) {
 			$event_name = $event->name();
 		}
 		return $event_name;
@@ -542,9 +542,9 @@ 
 	public function ticket_event() {
 		$event = null;
 		$ticket = $this->ticket();
-		if ( $ticket instanceof EE_Ticket ) {
+		if ($ticket instanceof EE_Ticket) {
 			$datetime = $ticket->first_datetime();
-			if ( $datetime instanceof EE_Datetime ) {
+			if ($datetime instanceof EE_Datetime) {
 				$event = $datetime->event();
 			}
 		}
@@ -559,11 +559,11 @@ 
 	 * @param string $time_format
 	 * @return string
 	 */
-	public function ticket_datetime_start( $date_format = '', $time_format = '' ) {
-		$first_datetime_string = __( "Unknown", "event_espresso" );
+	public function ticket_datetime_start($date_format = '', $time_format = '') {
+		$first_datetime_string = __("Unknown", "event_espresso");
 		$datetime = $this->get_ticket_datetime();
-		if ( $datetime ) {
-			$first_datetime_string = $datetime->start_date_and_time( $date_format, $time_format );
+		if ($datetime) {
+			$first_datetime_string = $datetime->start_date_and_time($date_format, $time_format);
 		}
 		return $first_datetime_string;
 	}
@@ -578,26 +578,26 @@ 
 	 * @return bool success
 	 * @throws \EE_Error
 	 */
-	public function add_child_line_item( EEI_Line_Item $line_item, $set_order = true ) {
+	public function add_child_line_item(EEI_Line_Item $line_item, $set_order = true) {
 		// should we calculate the LIN_order for this line item ?
-		if ( $set_order || $line_item->order() === null ) {
-			$line_item->set_order( count( $this->children() ) );
+		if ($set_order || $line_item->order() === null) {
+			$line_item->set_order(count($this->children()));
 		}
-		if ( $this->ID() ) {
+		if ($this->ID()) {
 			//check for any duplicate line items (with the same code), if so, this replaces it
-			$line_item_with_same_code = $this->get_child_line_item(  $line_item->code() );
-			if( $line_item_with_same_code instanceof EE_Line_Item && $line_item_with_same_code !== $line_item ) {
-				$this->delete_child_line_item( $line_item_with_same_code->code() );
+			$line_item_with_same_code = $this->get_child_line_item($line_item->code());
+			if ($line_item_with_same_code instanceof EE_Line_Item && $line_item_with_same_code !== $line_item) {
+				$this->delete_child_line_item($line_item_with_same_code->code());
 			}
-			$line_item->set_parent_ID( $this->ID() );
-			if( $this->TXN_ID() ){
-				$line_item->set_TXN_ID( $this->TXN_ID() );
+			$line_item->set_parent_ID($this->ID());
+			if ($this->TXN_ID()) {
+				$line_item->set_TXN_ID($this->TXN_ID());
 			}
 			return $line_item->save();
 		} else {
-			$this->_children[ $line_item->code() ] = $line_item;
-			if( $line_item->parent() != $this ) {
-				$line_item->set_parent( $this );
+			$this->_children[$line_item->code()] = $line_item;
+			if ($line_item->parent() != $this) {
+				$line_item->set_parent($this);
 			}
 			return TRUE;
 		}
@@ -611,16 +611,16 @@ 
 	 * @param EE_Line_Item $line_item
 	 *
 	 */
-	public function set_parent( $line_item ) {
-		if ( $this->ID() ) {
-			if( ! $line_item->ID() ) {
+	public function set_parent($line_item) {
+		if ($this->ID()) {
+			if ( ! $line_item->ID()) {
 				$line_item->save();
 			}
-			$this->set_parent_ID( $line_item->ID() );
+			$this->set_parent_ID($line_item->ID());
 			$this->save();
 		} else {
 			$this->_parent = $line_item;
-			$this->set_parent_ID( $line_item->ID() );
+			$this->set_parent_ID($line_item->ID());
 		}
 	}
 
@@ -633,11 +633,11 @@ 
 	 * @param string $code
 	 * @return EE_Line_Item
 	 */
-	public function get_child_line_item( $code ) {
-		if ( $this->ID() ) {
-			return $this->get_model()->get_one( array( array( 'LIN_parent' => $this->ID(), 'LIN_code' => $code ) ) );
+	public function get_child_line_item($code) {
+		if ($this->ID()) {
+			return $this->get_model()->get_one(array(array('LIN_parent' => $this->ID(), 'LIN_code' => $code)));
 		} else {
-			return isset( $this->_children[ $code ] ) ? $this->_children[ $code ] : null;
+			return isset($this->_children[$code]) ? $this->_children[$code] : null;
 		}
 	}
 
@@ -648,10 +648,10 @@ 
 	 * @return int
 	 */
 	public function delete_children_line_items() {
-		if ( $this->ID() ) {
-			return $this->get_model()->delete( array( array( 'LIN_parent' => $this->ID() ) ) );
+		if ($this->ID()) {
+			return $this->get_model()->delete(array(array('LIN_parent' => $this->ID())));
 		} else {
-			$count = count( $this->_children );
+			$count = count($this->_children);
 			$this->_children = array();
 			return $count;
 		}
@@ -668,25 +668,25 @@ 
 	 * @param bool $stop_search_once_found
 	 * @return int count of items deleted (or simply removed from the line item's cache, if not has not been saved to the DB yet)
 	 */
-	public function delete_child_line_item( $code, $stop_search_once_found = true ) {
-		if ( $this->ID() ) {
+	public function delete_child_line_item($code, $stop_search_once_found = true) {
+		if ($this->ID()) {
 			$items_deleted = 0;
-			if( $this->code() == $code ) {
-				$items_deleted += EEH_Line_Item::delete_all_child_items( $this );
+			if ($this->code() == $code) {
+				$items_deleted += EEH_Line_Item::delete_all_child_items($this);
 				$items_deleted += (int) $this->delete();
-				if( $stop_search_once_found ){
+				if ($stop_search_once_found) {
 					return $items_deleted;
 				}
 			}
-			foreach( $this->children() as $child_line_item ) {
-				$items_deleted += $child_line_item->delete_child_line_item( $code, $stop_search_once_found );
+			foreach ($this->children() as $child_line_item) {
+				$items_deleted += $child_line_item->delete_child_line_item($code, $stop_search_once_found);
 			}
 			return $items_deleted;
 		} else {
-			if( isset( $this->_children[ $code ] ) ) {
-				unset( $this->_children[ $code ] );
+			if (isset($this->_children[$code])) {
+				unset($this->_children[$code]);
 				return 1;
-			}else{
+			} else {
 				return 0;
 			}
 		}
@@ -699,9 +699,9 @@ 
 	 * @return boolean
 	 */
 	public function delete_if_childless_subtotal() {
-		if( $this->ID() &&
+		if ($this->ID() &&
 				$this->type() == EEM_Line_Item::type_sub_total &&
-				! $this->children() ) {
+				! $this->children()) {
 			return $this->delete();
 		} else {
 			return false;
@@ -716,7 +716,7 @@ 
 	 */
 	public function generate_code() {
 		// each line item in the cart requires a unique identifier
-		return md5( $this->get( 'OBJ_type' ) . $this->get( 'OBJ_ID' ) . microtime() );
+		return md5($this->get('OBJ_type').$this->get('OBJ_ID').microtime());
 	}
 
 
@@ -799,7 +799,7 @@ 
 	 * @return string like '2, 004.00', formatted according to the localized currency
 	 */
 	public function unit_price_no_code() {
-		return $this->get_pretty( 'LIN_unit_price', 'no_currency_code' );
+		return $this->get_pretty('LIN_unit_price', 'no_currency_code');
 	}
 
 
@@ -809,7 +809,7 @@ 
 	 * @return string like '2, 004.00', formatted according to the localized currency
 	 */
 	public function total_no_code() {
-		return $this->get_pretty( 'LIN_total', 'no_currency_code' );
+		return $this->get_pretty('LIN_total', 'no_currency_code');
 	}
 
 
@@ -829,17 +829,17 @@ 
 		$tax_total = $this->recalculate_taxes_and_tax_total();
 		$total = $pre_tax_total + $tax_total;
 		// no negative totals plz
-		$total = max( $total, 0 );
-		$this->set_total( $total );
+		$total = max($total, 0);
+		$this->set_total($total);
 		//only update the related transaction's total
 		//if we intend to save this line item and its a grand total
-		if(
+		if (
 			$this->allow_persist() &&
 			$this->type() === EEM_Line_Item::type_total &&
 			$this->transaction() instanceof EE_Transaction
-		){
-			$this->transaction()->set_total( $total );
-			if ( $this->transaction()->ID() ) {
+		) {
+			$this->transaction()->set_total($total);
+			if ($this->transaction()->ID()) {
 				$this->transaction()->save();
 			}
 		}
@@ -858,47 +858,47 @@ 
 	public function recalculate_pre_tax_total() {
 		$total = 0;
 		$my_children = $this->children();
-		$has_children = ! empty( $my_children );
-		if ( $has_children && $this->is_line_item() ) {
-			$total = $this->_recalculate_pretax_total_for_line_item( $total, $my_children );
-		} elseif ( ! $has_children && ( $this->is_sub_line_item() || $this->is_line_item() ) ) {
+		$has_children = ! empty($my_children);
+		if ($has_children && $this->is_line_item()) {
+			$total = $this->_recalculate_pretax_total_for_line_item($total, $my_children);
+		} elseif ( ! $has_children && ($this->is_sub_line_item() || $this->is_line_item())) {
 			$total = $this->unit_price() * $this->quantity();
-		} elseif( $this->is_sub_total() || $this->is_total() ) {
-			$total = $this->_recalculate_pretax_total_for_subtotal( $total, $my_children );
-		} elseif ( $this->is_tax_sub_total() || $this->is_tax() || $this->is_cancelled() ) {
+		} elseif ($this->is_sub_total() || $this->is_total()) {
+			$total = $this->_recalculate_pretax_total_for_subtotal($total, $my_children);
+		} elseif ($this->is_tax_sub_total() || $this->is_tax() || $this->is_cancelled()) {
 			// completely ignore tax totals, tax sub-totals, and cancelled line items, when calculating the pre-tax-total
 			return 0;
 		}
 		// ensure all non-line items and non-sub-line-items have a quantity of 1 (except for Events)
-		if(
+		if (
 			! $this->is_line_item() &&
 			! $this->is_sub_line_item() &&
 			! $this->is_cancellation()
 		) {
-			if ( $this->OBJ_type() !== 'Event' ) {
-				$this->set_quantity( 1 );
+			if ($this->OBJ_type() !== 'Event') {
+				$this->set_quantity(1);
 			}
-			if( ! $this->is_percent() ) {
-				$this->set_unit_price( $this->total() );
+			if ( ! $this->is_percent()) {
+				$this->set_unit_price($this->total());
 			}
 		}
 
 		//we don't want to bother saving grand totals, because that needs to factor in taxes anyways
 		//so it ought to be
-		if( ! $this->is_total() ) {
-			$this->set_total( $total );
+		if ( ! $this->is_total()) {
+			$this->set_total($total);
 			//if not a percent line item, make sure we keep the unit price in sync
-			if(
+			if (
 				$has_children
 				&& $this->is_line_item()
 				&& ! $this->is_percent()
 			) {
-				if( $this->quantity() === 0 ){
+				if ($this->quantity() === 0) {
 					$new_unit_price = 0;
 				} else {
 					$new_unit_price = $this->total() / $this->quantity();
 				}
-				$this->set_unit_price( $new_unit_price );
+				$this->set_unit_price($new_unit_price);
 			}
 			$this->maybe_save();
 		}
@@ -918,39 +918,39 @@ 
 	 * @return float
 	 * @throws \EE_Error
 	 */
-	protected function _recalculate_pretax_total_for_subtotal( $calculated_total_so_far, $my_children = null ) {
-		if( $my_children === null ) {
+	protected function _recalculate_pretax_total_for_subtotal($calculated_total_so_far, $my_children = null) {
+		if ($my_children === null) {
 			$my_children = $this->children();
 		}
 		//get the total of all its children
-		foreach ( $my_children as $child_line_item ) {
-			if ( $child_line_item instanceof EE_Line_Item && ! $child_line_item->is_cancellation() ) {
+		foreach ($my_children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item && ! $child_line_item->is_cancellation()) {
 				// percentage line items are based on total so far
-				if ( $child_line_item->is_percent() ) {
+				if ($child_line_item->is_percent()) {
 					//round as we go so that the line items add up ok
 					$percent_total = round(
 						$calculated_total_so_far * $child_line_item->percent() / 100,
 						EE_Registry::instance()->CFG->currency->dec_plc
 					);
-					$child_line_item->set_total( $percent_total );
+					$child_line_item->set_total($percent_total);
 					//so far all percent line items should have a quantity of 1
 					//(ie, no double percent discounts. Although that might be requested someday)
-					$child_line_item->set_quantity( 1 );
+					$child_line_item->set_quantity(1);
 					$child_line_item->maybe_save();
 					$calculated_total_so_far += $percent_total;
 				} else {
 					//verify flat sub-line-item quantities match their parent
-					if( $child_line_item->is_sub_line_item() ) {
-						$child_line_item->set_quantity( $this->quantity() );
+					if ($child_line_item->is_sub_line_item()) {
+						$child_line_item->set_quantity($this->quantity());
 					}
 					$calculated_total_so_far += $child_line_item->recalculate_pre_tax_total();
 				}
 			}
 		}
 
-		if( $this->is_sub_total() ){
+		if ($this->is_sub_total()) {
 			// no negative totals plz
-			$calculated_total_so_far = max( $calculated_total_so_far, 0 );
+			$calculated_total_so_far = max($calculated_total_so_far, 0);
 		}
 		return $calculated_total_so_far;
 	}
@@ -968,8 +968,8 @@ 
 	 * @return float
 	 * @throws \EE_Error
 	 */
-	protected function _recalculate_pretax_total_for_line_item( $calculated_total_so_far, $my_children = null ) {
-		if( $my_children === null ) {
+	protected function _recalculate_pretax_total_for_line_item($calculated_total_so_far, $my_children = null) {
+		if ($my_children === null) {
 			$my_children = $this->children();
 		}
 		//we need to keep track of the running total for a single item,
@@ -977,10 +977,10 @@ 
 		$unit_price_for_total = 0;
 		$quantity_for_total = 1;
 		//get the total of all its children
-		foreach ( $my_children as $child_line_item ) {
-			if ( $child_line_item instanceof EE_Line_Item &&
+		foreach ($my_children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item &&
 					! $child_line_item->is_cancellation()) {
-				if ( $child_line_item->is_percent() ) {
+				if ($child_line_item->is_percent()) {
 					//it should be the unit-price-so-far multiplied by teh percent multiplied by the quantity
 					//not total multiplied by percent, because that ignores rounding along-the-way
 					$percent_unit_price = round(
@@ -988,17 +988,17 @@ 
 						EE_Registry::instance()->CFG->currency->dec_plc
 					);
 					$percent_total = $percent_unit_price * $quantity_for_total;
-					$child_line_item->set_total( $percent_total );
+					$child_line_item->set_total($percent_total);
 					//so far all percent line items should have a quantity of 1
 					//(ie, no double percent discounts. Although that might be requested someday)
-					$child_line_item->set_quantity( 1 );
+					$child_line_item->set_quantity(1);
 					$child_line_item->maybe_save();
 					$calculated_total_so_far += $percent_total;
 					$unit_price_for_total += $percent_unit_price;
 				} else {
 					//verify flat sub-line-item quantities match their parent
-					if( $child_line_item->is_sub_line_item() ) {
-						$child_line_item->set_quantity( $this->quantity() );
+					if ($child_line_item->is_sub_line_item()) {
+						$child_line_item->set_quantity($this->quantity());
 					}
 					$quantity_for_total = $child_line_item->quantity();
 					$calculated_total_so_far += $child_line_item->recalculate_pre_tax_total();
@@ -1022,10 +1022,10 @@ 
 		//calculate the pretax total
 		$taxable_total = $this->taxable_total();
 		$tax_total = 0;
-		foreach ( $taxes as $tax ) {
+		foreach ($taxes as $tax) {
 			$total_on_this_tax = $taxable_total * $tax->percent() / 100;
 			//remember the total on this line item
-			$tax->set_total( $total_on_this_tax );
+			$tax->set_total($total_on_this_tax);
 			$tax_total += $tax->total();
 		}
 		$this->_recalculate_tax_sub_total();
@@ -1039,21 +1039,21 @@ 
 	 * @return void
 	 */
 	private function _recalculate_tax_sub_total() {
-		if ( $this->is_tax_sub_total() ) {
+		if ($this->is_tax_sub_total()) {
 			$total = 0;
 			$total_percent = 0;
 			//simply loop through all its children (which should be taxes) and sum their total
-			foreach ( $this->children() as $child_tax ) {
-				if ( $child_tax instanceof EE_Line_Item ) {
+			foreach ($this->children() as $child_tax) {
+				if ($child_tax instanceof EE_Line_Item) {
 					$total += $child_tax->total();
 					$total_percent += $child_tax->percent();
 				}
 			}
-			$this->set_total( $total );
-			$this->set_percent( $total_percent );
-		} elseif ( $this->is_total() ) {
-			foreach ( $this->children() as $maybe_tax_subtotal ) {
-				if ( $maybe_tax_subtotal instanceof EE_Line_Item ) {
+			$this->set_total($total);
+			$this->set_percent($total_percent);
+		} elseif ($this->is_total()) {
+			foreach ($this->children() as $maybe_tax_subtotal) {
+				if ($maybe_tax_subtotal instanceof EE_Line_Item) {
 					$maybe_tax_subtotal->_recalculate_tax_sub_total();
 				}
 			}
@@ -1069,8 +1069,8 @@ 
 	public function get_total_tax() {
 		$this->_recalculate_tax_sub_total();
 		$total = 0;
-		foreach ( $this->tax_descendants() as $tax_line_item ) {
-			if ( $tax_line_item instanceof EE_Line_Item ) {
+		foreach ($this->tax_descendants() as $tax_line_item) {
+			if ($tax_line_item instanceof EE_Line_Item) {
 				$total += $tax_line_item->total();
 			}
 		}
@@ -1084,15 +1084,15 @@ 
 	 */
 	public function get_items_total() {
 		//by default, let's make sure we're consistent with the existing line item
-		if( $this->is_total() ) {
-			$pretax_subtotal_li = EEH_Line_Item::get_pre_tax_subtotal( $this );
-			if( $pretax_subtotal_li instanceof EE_Line_Item ) {
+		if ($this->is_total()) {
+			$pretax_subtotal_li = EEH_Line_Item::get_pre_tax_subtotal($this);
+			if ($pretax_subtotal_li instanceof EE_Line_Item) {
 				return $pretax_subtotal_li->total();
 			}
 		}
 		$total = 0;
-		foreach ( $this->get_items() as $item ) {
-			if ( $item instanceof EE_Line_Item ) {
+		foreach ($this->get_items() as $item) {
+			if ($item instanceof EE_Line_Item) {
 				$total += $item->total();
 			}
 		}
@@ -1107,7 +1107,7 @@ 
 	 * @return EE_Line_Item[]
 	 */
 	public function tax_descendants() {
-		return EEH_Line_Item::get_tax_descendants( $this );
+		return EEH_Line_Item::get_tax_descendants($this);
 	}
 
 
@@ -1117,7 +1117,7 @@ 
 	 * @return EE_Line_Item[]
 	 */
 	public function get_items() {
-		return EEH_Line_Item::get_line_item_descendants( $this );
+		return EEH_Line_Item::get_line_item_descendants($this);
 	}
 
 
@@ -1133,22 +1133,22 @@ 
 	 */
 	public function taxable_total() {
 		$total = 0;
-		if ( $this->children() ) {
-			foreach ( $this->children() as $child_line_item ) {
-				if ( $child_line_item->type() === EEM_Line_Item::type_line_item && $child_line_item->is_taxable()) {
+		if ($this->children()) {
+			foreach ($this->children() as $child_line_item) {
+				if ($child_line_item->type() === EEM_Line_Item::type_line_item && $child_line_item->is_taxable()) {
 					//if it's a percent item, only take into account the percent
 					//that's taxable too (the taxable total so far)
-					if( $child_line_item->is_percent() ) {
-						$total = $total + ( $total * $child_line_item->percent() / 100 );
-					}else{
+					if ($child_line_item->is_percent()) {
+						$total = $total + ($total * $child_line_item->percent() / 100);
+					} else {
 						$total += $child_line_item->total();
 					}
-				}elseif( $child_line_item->type() === EEM_Line_Item::type_sub_total ){
+				}elseif ($child_line_item->type() === EEM_Line_Item::type_sub_total) {
 					$total += $child_line_item->taxable_total();
 				}
 			}
 		}
-		return max( $total, 0 );
+		return max($total, 0);
 	}
 
 
@@ -1158,7 +1158,7 @@ 
 	 * @return EE_Transaction
 	 */
 	public function transaction() {
-		return $this->get_first_related( 'Transaction' );
+		return $this->get_first_related('Transaction');
 	}
 
 
@@ -1171,18 +1171,18 @@ 
 	 * @param int $txn_id if none is provided, assumes $this->TXN_ID()
 	 * @return int count of items saved
 	 */
-	public function save_this_and_descendants_to_txn( $txn_id = NULL ) {
+	public function save_this_and_descendants_to_txn($txn_id = NULL) {
 		$count = 0;
-		if ( ! $txn_id ) {
+		if ( ! $txn_id) {
 			$txn_id = $this->TXN_ID();
 		}
-		$this->set_TXN_ID( $txn_id );
+		$this->set_TXN_ID($txn_id);
 		$children = $this->children();
 		$count += $this->save() ? 1 : 0;
-		foreach ( $children as $child_line_item ) {
-			if ( $child_line_item instanceof EE_Line_Item ) {
-				$child_line_item->set_parent_ID( $this->ID() );
-				$count += $child_line_item->save_this_and_descendants_to_txn( $txn_id );
+		foreach ($children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				$child_line_item->set_parent_ID($this->ID());
+				$count += $child_line_item->save_this_and_descendants_to_txn($txn_id);
 			}
 		}
 		return $count;
@@ -1199,9 +1199,9 @@ 
 		$count = 0;
 		$children = $this->children();
 		$count += $this->save() ? 1 : 0;
-		foreach ( $children as $child_line_item ) {
-			if ( $child_line_item instanceof EE_Line_Item ) {
-				$child_line_item->set_parent_ID( $this->ID() );
+		foreach ($children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				$child_line_item->set_parent_ID($this->ID());
 				$count += $child_line_item->save_this_and_descendants();
 			}
 		}
@@ -1215,8 +1215,8 @@ 
 	 * @return EE_Line_Item[]
 	 */
 	public function get_cancellations() {
-		EE_Registry::instance()->load_helper( 'Line_Item' );
-		return EEH_Line_Item::get_descendants_of_type( $this, EEM_Line_Item::type_cancellation );
+		EE_Registry::instance()->load_helper('Line_Item');
+		return EEH_Line_Item::get_descendants_of_type($this, EEM_Line_Item::type_cancellation);
 	}
 
 
@@ -1227,7 +1227,7 @@ 
 	 * @return int count of items saved
 	 */
 	public function maybe_save() {
-		if ( $this->ID() ) {
+		if ($this->ID()) {
 			return $this->save();
 		}
 		return false;

Indentation +52 added lines, -52 removed lines

@@ -172,7 +172,7 @@ 
 	 * Sets quantity
 	 * @param int $quantity
 	 */
-    public function set_quantity( $quantity ) {
+	public function set_quantity( $quantity ) {
 		$this->set( 'LIN_quantity', max( $quantity, 0 ) );
 	}
 
@@ -212,25 +212,25 @@ 
 	 * Gets item_type
 	 * @return string
 	 */
-    public function OBJ_type_i18n() {
-	    $obj_type = $this->OBJ_type();
-        switch ($obj_type) {
-            case 'Event':
-                $obj_type = __('Event', 'event_espresso');
-                break;
-            case 'Price':
-                $obj_type = __('Price', 'event_espresso');
-                break;
-            case 'Promotion':
-                $obj_type = __('Promotion', 'event_espresso');
-                break;
-            case 'Ticket':
-                $obj_type = __('Ticket', 'event_espresso');
-                break;
-            case 'Transaction':
-                $obj_type = __('Transaction', 'event_espresso');
-                break;
-        }
+	public function OBJ_type_i18n() {
+		$obj_type = $this->OBJ_type();
+		switch ($obj_type) {
+			case 'Event':
+				$obj_type = __('Event', 'event_espresso');
+				break;
+			case 'Price':
+				$obj_type = __('Price', 'event_espresso');
+				break;
+			case 'Promotion':
+				$obj_type = __('Promotion', 'event_espresso');
+				break;
+			case 'Ticket':
+				$obj_type = __('Ticket', 'event_espresso');
+				break;
+			case 'Transaction':
+				$obj_type = __('Transaction', 'event_espresso');
+				break;
+		}
 		return apply_filters('FHEE__EE_Line_Item__OBJ_type_i18n', $obj_type, $this);
 	}
 
@@ -1244,48 +1244,48 @@ 
 
 
 
-    /**
-     * @param bool $raw
-     * @return int
-     * @throws \EE_Error
-     */
-    public function timestamp($raw = false)
-    {
-        return $raw ? $this->get_raw('LIN_timestamp') : $this->get('LIN_timestamp');
-    }
+	/**
+	 * @param bool $raw
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public function timestamp($raw = false)
+	{
+		return $raw ? $this->get_raw('LIN_timestamp') : $this->get('LIN_timestamp');
+	}
 
 
 
 
-    /************************* DEPRECATED *************************/
+	/************************* DEPRECATED *************************/
 
 
 
-    /**
-     * @deprecated 4.6.0
-     * @param string $type one of the constants on EEM_Line_Item
-     * @return EE_Line_Item[]
-     */
-    protected function _get_descendants_of_type($type)
-    {
-        EE_Error::doing_it_wrong('EE_Line_Item::_get_descendants_of_type()',
-            __('Method replaced with EEH_Line_Item::get_descendants_of_type()', 'event_espresso'), '4.6.0');
-        return EEH_Line_Item::get_descendants_of_type($this, $type);
-    }
+	/**
+	 * @deprecated 4.6.0
+	 * @param string $type one of the constants on EEM_Line_Item
+	 * @return EE_Line_Item[]
+	 */
+	protected function _get_descendants_of_type($type)
+	{
+		EE_Error::doing_it_wrong('EE_Line_Item::_get_descendants_of_type()',
+			__('Method replaced with EEH_Line_Item::get_descendants_of_type()', 'event_espresso'), '4.6.0');
+		return EEH_Line_Item::get_descendants_of_type($this, $type);
+	}
 
 
 
-    /**
-     * @deprecated 4.6.0
-     * @param string $type like one of the EEM_Line_Item::type_*
-     * @return EE_Line_Item
-     */
-    public function get_nearest_descendant_of_type($type)
-    {
-        EE_Error::doing_it_wrong('EE_Line_Item::get_nearest_descendant_of_type()',
-            __('Method replaced with EEH_Line_Item::get_nearest_descendant_of_type()', 'event_espresso'), '4.6.0');
-        return EEH_Line_Item::get_nearest_descendant_of_type($this, $type);
-    }
+	/**
+	 * @deprecated 4.6.0
+	 * @param string $type like one of the EEM_Line_Item::type_*
+	 * @return EE_Line_Item
+	 */
+	public function get_nearest_descendant_of_type($type)
+	{
+		EE_Error::doing_it_wrong('EE_Line_Item::get_nearest_descendant_of_type()',
+			__('Method replaced with EEH_Line_Item::get_nearest_descendant_of_type()', 'event_espresso'), '4.6.0');
+		return EEH_Line_Item::get_nearest_descendant_of_type($this, $type);
+	}
 
 
 

core/libraries/shortcodes/EE_Shortcodes.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -352,7 +352,7 @@
      *
      * Note: regex comes in part from the WP `get_shortcode_regex` expression in \wp-includes\shortcodes.php
      *
-     * @param $shortcode
+     * @param string $shortcode
      * @since 4.9.32
      * @return string
      */

Indentation +427 added lines, -427 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 /**
@@ -30,432 +30,432 @@ 
 abstract class EE_Shortcodes extends EE_Base
 {
 
-    /**
-     * holds label for library
-     * This is used for referencing the library label
-     *
-     * @access public
-     * @var string
-     */
-    public $label;
-
-
-    /**
-     * This property is used for referencing a short description of the library
-     *
-     * @access public
-     * @var string
-     */
-    public $description;
-
-
-    /**
-     * This will hold an array of shortcodes with the key as the shortcode ([shortcode]) and the value as a
-     * label/description for the shortcode.
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_shortcodes;
-
-
-    /**
-     * This will hold the incoming data item sent to the parser method
-     *
-     * @access protected
-     * @var mixed (array|object)
-     */
-    protected $_data;
-
-
-    /**
-     * some shortcodes may require extra data to parse.  This property is provided for that.
-     *
-     * @var array
-     */
-    protected $_extra_data;
-
-
-    /**
-     * EE_messenger used to generate the template being parsed.
-     *
-     * @since 4.5.0
-     * @var EE_messenger
-     */
-    protected $_messenger;
-
-
-    /**
-     * message type used to generate the template being parsed.
-     *
-     * @since 4.5.0
-     * @var EE_message_type
-     */
-    protected $_message_type;
-
-
-    /**
-     * context used for the template being parsed
-     *
-     * @since 4.5.0
-     * @var string
-     */
-    protected $_context;
-
-
-    /**
-     * Specific Message Template Group ID
-     *
-     * @since 4.5.0
-     * @var int
-     */
-    protected $_GRP_ID;
-
-
-    /**
-     * @since 4.9.0
-     * @type EE_Message
-     */
-    protected $_message;
-
-
-    /**
-     * This will hold an instance of the EEH_Parse_Shortcodes helper that will be used when handling list type
-     * shortcodes
-     *
-     * @var EEH_Parse_Shortcodes
-     */
-    protected $_shortcode_helper;
-
-
-    public function __construct()
-    {
-        $this->_set_defaults();
-        $this->_init_props();
-    }
-
-
-    /**
-     * This sets the defaults for the properties.  Child classes will override these properties in their _init_props
-     * method
-     */
-    private function _set_defaults()
-    {
-        $this->name        = $this->description = '';
-        $this->_shortcodes = array();
-        $this->_set_shortcode_helper();
-    }
-
-
-    /**
-     * loads an instance of the EE_Shortcode_Parser helper when requested
-     */
-    protected function _set_shortcode_helper()
-    {
-        //get shortcode_replace instance- set when _get_messages is called in child...
-        $this->_shortcode_helper = new EEH_Parse_Shortcodes();
-    }
-
-
-    public function get_shortcode_helper()
-    {
-        if (! $this->_shortcode_helper instanceof EEH_Parse_Shortcodes) {
-            $this->_set_shortcode_helper();
-        }
-        return $this->_shortcode_helper;
-    }
-
-
-    /**
-     * This is the public method for kicking of the parser included with each child.  It can be overridden by child
-     * classes if necessary (see EE_Questions_Answers for example)
-     *
-     * @param  string               $shortcode  incoming shortcode to be parsed
-     * @param  mixed (object|array) $data       incoming data to be be used for parsing
-     * @param  mixed (object|array) $extra_data extra incoming data (usually EE_Messages_Addressee)
-     * @return string            parsed shortcode.
-     */
-    public function parser($shortcode, $data, $extra_data = array())
-    {
-
-        //filter setup shortcodes
-        $this->_shortcodes = $this->get_shortcodes();
-
-        //we need to setup any dynamic shortcodes so that they work with the array_key_exists
-        $sc           = preg_match_all('/(\[[A-Za-z0-9\_]+_\*)/', $shortcode, $matches);
-        $sc_to_verify = ! empty($matches[0]) ? $matches[0][0] . ']' : $shortcode;
-
-        //first we want to make sure this is a valid shortcode
-        if (! array_key_exists($sc_to_verify, $this->_shortcodes)) {
-            return false;
-        } //get out, this parser doesn't handle the incoming shortcode.
-        $this->_data       = $data;
-        $this->_extra_data = $extra_data;
-        $this->_set_messages_properties();
-        $parsed = apply_filters('FHEE__' . get_class($this) . '__parser_after', $this->_parser($shortcode), $shortcode,
-            $data, $extra_data, $this);
-
-        //note the below filter applies to ALL shortcode parsers... be careful!
-        $parsed = apply_filters('FHEE__EE_Shortcodes__parser_after', $parsed, $shortcode, $data, $extra_data, $this);
-        return $parsed;
-    }
-
-
-    /**
-     * This method just returns the shortcodes in the $_shortcodes array property.
-     *
-     * @access public
-     * @return array array of shortcodes => description pairs
-     */
-    public function get_shortcodes()
-    {
-        $this->_shortcodes = apply_filters('FHEE__' . get_class($this) . '__shortcodes', $this->_shortcodes, $this);
-
-        //note the below filter applies to ALL shortcode parsers... be careful!
-        $this->_shortcodes = apply_filters('FHEE__EE_Shortcodes__shortcodes', $this->_shortcodes, $this);
-
-        return $this->_shortcodes;
-    }
-
-
-    /**
-     * Child classes use this method to set the $name, $description, and $_shortcodes properties.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _init_props();
-
-
-    /**
-     * This method will give parsing instructions for each shortcode defined in the _shortcodes array.  Child methods
-     * will have to take care of handling.
-     *
-     * @abstract
-     * @access protected
-     * @param string               $shortcode the shortcode to be parsed.
-     * @param mixed (object|array) $data      incoming data for the parser.  The data could be either an object or
-     *                             array because there are some shortcodes that might be replaced by prepared data that
-     *                             has multiple items in a list (i.e. list of attendees in an event and we're showing
-     *                             fname/lname for each attendee).  In this case data will be in an array.  Otherwise
-     *                             the data shoudl be in a properly formatted object.  The
-     *                             EEH_Parse_Shortcodes.helper.php describes the data object we're expecting.
-     * @return string parsed shortcode
-     */
-    abstract protected function _parser($shortcode);
-
-
-    /**
-     * This just validates incoming data for list type shortcode parsers (and they call this method) to make sure it
-     * meets their requirements
-     *
-     * @return mixed (void|exception) If validation fails we'll throw an exception.
-     */
-    protected function _validate_list_requirements()
-    {
-
-        //first test to make sure we've got an array!
-        if (! is_array($this->_data)) {
-            throw new EE_Error(sprintf(__('Expecting an array for the data sent to %s. Instead it was %s',
-                'event_espresso'), get_class($this), gettype($this->_data)));
-        }
-
-        //next test to make sure we've got the required template in the index!
-        if (! isset($this->_data['template'])) {
-            throw new EE_Error(sprintf(__('The incoming data does not have the required template index in its array',
-                'event_espresso')));
-        }
-
-        //next test to make sure we've got got a data index in the incoming data array
-        if (! isset($this->_data['data'])) {
-            throw new EE_Error(__('The incoming data does not have the required data index in its array',
-                'event_espresso'));
-        }
-
-        //all is well let's make sure _extra_data always has the values needed.
-        //let's make sure that extra_data includes all templates (for later parsing if necessary)
-        if (empty($this->_extra_data) || (empty($this->_extra_data['data']) && empty($this->_extra_data['template']))) {
-            $this->_extra_data['data']     = $this->_data['data'];
-            $this->_extra_data['template'] = $this->_data['template'];
-        }
-
-    }
-
-
-    /**
-     * This returns any attributes that may be existing on an EE_Shortcode
-     *
-     * @since 4.5.0
-     * @param string $shortcode incoming shortcode
-     * @return array An array with the attributes
-     */
-    protected function _get_shortcode_attrs($shortcode)
-    {
-        //make sure the required wp helper function is present
-        //require the shortcode file if necessary
-        if (! function_exists('shortcode_parse_atts')) {
-            require_once(ABSPATH . WPINC . '/shortcodes.php');
-        }
-
-        //let's get any attributes that may be present and set the defaults.
-        $shortcode_to_parse = str_replace('[', '', str_replace(']', '', $shortcode));
-        return shortcode_parse_atts($shortcode_to_parse);
-    }
-
-
-    /**
-     * Conditional blocks are shortcode patterns with an opening conditional tag `[IF_*]` and a corresponding
-     * closing tag (eg `[/IF_*]`).  The content within the tags will be displayed/hidden depending on whatever conditions
-     * existed in the opening tag.  This method handles parsing the actual template to show/hide this conditional content.
-     *
-     * @since 4.9.32
-     *
-     * @param string $shortcode  This should be original shortcode as used in the template and passed to the parser.
-     * @param bool $show  true means the opening and closing tags are removed and the content is left showing, false
-     *                    means the opening and closing tags and the contained content are removed.
-     * @return string     The template for the shortcode is returned.
-     */
-    protected function _mutate_conditional_block_in_template($shortcode, $show = true)
-    {
-        //first let's get all the matches in the template for this particular shortcode.
-        preg_match_all('~' . $this->_get_conditional_block_regex($shortcode) . '~', $this->_data['template'], $matches);
-
-        if ($matches && is_array($matches[0]) && !empty($matches[0])) {
-            //we need to hide all instances of the matches
-            foreach ($matches[0] as $index => $content_to_show_or_hide) {
-                $content_to_show_or_hide = preg_quote($content_to_show_or_hide);
-                $replacement = $show ? $matches[4][$index] : '';
-                $this->_data['template'] = preg_replace(
-                    '~' . $content_to_show_or_hide . '~',
-                    $replacement,
-                    $this->_data['template']
-                );
-            }
-        }
-        //return $template
-        return $this->_data['template'];
-    }
-
-
-    /**
-     * This returns the regex pattern to use for conditional shortcodes parsing.
-     *
-     * Note: regex comes in part from the WP `get_shortcode_regex` expression in \wp-includes\shortcodes.php
-     *
-     * @param $shortcode
-     * @since 4.9.32
-     * @return string
-     */
-    private function _get_conditional_block_regex($shortcode)
-    {
-        //get just the shortcode tag for the match
-        preg_match('@\[([^<>&/\[\]\x00-\x20=]++)@', $shortcode, $shortcode_tag_matches);
-        if (empty($shortcode_tag_matches[1])) {
-            return $this->_data['template'];
-        }
-
-        $shortcode_tag = $shortcode_tag_matches[1];
-        //get attributes_part_of_tag
-        $attributes_part = preg_quote(str_replace(array($shortcode_tag,'[',']'), '', $shortcode));
-        //escape
-        $shortcode_tag = preg_quote($shortcode_tag);
-
-        return
-              '\['                                  //Opening Bracket
-            . "($shortcode_tag)$attributes_part"    //1: Shortcode Name
-            . '(?![\w-])'                           //Not followed by word character or hyphen
-            . '('                                   //2: Unroll the loop: Inside the opening shortcode tag
-            .   '[^\]\/]*'                          //Not a closing bracket or forward slash
-            .   '(?:'
-            .       '\/(?!\])'                      //A forward slash not followed by a closing bracket
-            .       '[^\]\/]*'                      //Not a closing bracket or forward slash.
-            .   ')*?'
-            . ')'
-            . '(?:'
-            .   '(\/)'                              //3. Self closing tag ...
-            .   '\]'                                // ... and closing bracket
-            . '|'
-            .   '\]'                                //Closing bracket
-            .   '(?:'
-            .       '('                             //4: Unroll the loop: Optionally, anything between the opening and closing brackets
-            .           '[^\[]*+'                   //Not an opening bracket
-            .           '(?:'
-            .               '\[(?!\/\1\])'          //An opening bracket not followed by the closing shortcode tag.
-            .               '[^\[]*+'               //Not an opening bracket
-            .           ')*+'
-            .       ')'
-            .       '\[\/\1\]'                      //Closing shortcode tag
-            .   ')?'
-            . ')';
-    }
-
-
-    /**
-     * This sets the properties related to the messages system
-     *
-     * @since 4.5.0
-     * @return void
-     */
-    protected function _set_messages_properties()
-    {
-        //should be in _extra_data
-        if (isset($this->_extra_data['messenger'])) {
-            $this->_messenger    = $this->_extra_data['messenger'];
-            $this->_message_type = $this->_extra_data['message_type'];
-            $this->_context      = $this->_extra_data['message'] instanceof EE_Message ? $this->_extra_data['message']->context() : '';
-            $this->_GRP_ID       = $this->_extra_data['message'] instanceof EE_Message ? $this->_extra_data['message']->GRP_ID() : 0;
-            $this->_message      = $this->_extra_data['message'] instanceof EE_Message ? $this->_extra_data['message'] : null;
-        }
-    }
-
-
-    /**
-     * This returns whatever the set message type object is that was set on this shortcode parser.
-     *
-     * @since 4.5.0
-     * @return EE_message_type
-     */
-    public function get_set_message_type()
-    {
-        return $this->_message_type;
-    }
-
-
-    /**
-     * This returns whatever the set messenger object is that was set on this shortcode parser
-     *
-     * @since 4.5.0
-     * @return EE_messenger
-     */
-    public function get_set_messenger()
-    {
-        return $this->_messenger;
-    }
-
-
-    /**
-     * This returns whatever the set context string is on this shortcode parser.
-     *
-     * @since 4.5.0
-     * @return string
-     */
-    public function get_set_context()
-    {
-        return $this->_context;
-    }
-
-
-    /**
-     * This returns whatever the set EE_Message object is on this shortcode.
-     *
-     * @since 4.9.0
-     * @return EE_Message
-     */
-    public function get_set_message()
-    {
-        return $this->_message;
-    }
+	/**
+	 * holds label for library
+	 * This is used for referencing the library label
+	 *
+	 * @access public
+	 * @var string
+	 */
+	public $label;
+
+
+	/**
+	 * This property is used for referencing a short description of the library
+	 *
+	 * @access public
+	 * @var string
+	 */
+	public $description;
+
+
+	/**
+	 * This will hold an array of shortcodes with the key as the shortcode ([shortcode]) and the value as a
+	 * label/description for the shortcode.
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_shortcodes;
+
+
+	/**
+	 * This will hold the incoming data item sent to the parser method
+	 *
+	 * @access protected
+	 * @var mixed (array|object)
+	 */
+	protected $_data;
+
+
+	/**
+	 * some shortcodes may require extra data to parse.  This property is provided for that.
+	 *
+	 * @var array
+	 */
+	protected $_extra_data;
+
+
+	/**
+	 * EE_messenger used to generate the template being parsed.
+	 *
+	 * @since 4.5.0
+	 * @var EE_messenger
+	 */
+	protected $_messenger;
+
+
+	/**
+	 * message type used to generate the template being parsed.
+	 *
+	 * @since 4.5.0
+	 * @var EE_message_type
+	 */
+	protected $_message_type;
+
+
+	/**
+	 * context used for the template being parsed
+	 *
+	 * @since 4.5.0
+	 * @var string
+	 */
+	protected $_context;
+
+
+	/**
+	 * Specific Message Template Group ID
+	 *
+	 * @since 4.5.0
+	 * @var int
+	 */
+	protected $_GRP_ID;
+
+
+	/**
+	 * @since 4.9.0
+	 * @type EE_Message
+	 */
+	protected $_message;
+
+
+	/**
+	 * This will hold an instance of the EEH_Parse_Shortcodes helper that will be used when handling list type
+	 * shortcodes
+	 *
+	 * @var EEH_Parse_Shortcodes
+	 */
+	protected $_shortcode_helper;
+
+
+	public function __construct()
+	{
+		$this->_set_defaults();
+		$this->_init_props();
+	}
+
+
+	/**
+	 * This sets the defaults for the properties.  Child classes will override these properties in their _init_props
+	 * method
+	 */
+	private function _set_defaults()
+	{
+		$this->name        = $this->description = '';
+		$this->_shortcodes = array();
+		$this->_set_shortcode_helper();
+	}
+
+
+	/**
+	 * loads an instance of the EE_Shortcode_Parser helper when requested
+	 */
+	protected function _set_shortcode_helper()
+	{
+		//get shortcode_replace instance- set when _get_messages is called in child...
+		$this->_shortcode_helper = new EEH_Parse_Shortcodes();
+	}
+
+
+	public function get_shortcode_helper()
+	{
+		if (! $this->_shortcode_helper instanceof EEH_Parse_Shortcodes) {
+			$this->_set_shortcode_helper();
+		}
+		return $this->_shortcode_helper;
+	}
+
+
+	/**
+	 * This is the public method for kicking of the parser included with each child.  It can be overridden by child
+	 * classes if necessary (see EE_Questions_Answers for example)
+	 *
+	 * @param  string               $shortcode  incoming shortcode to be parsed
+	 * @param  mixed (object|array) $data       incoming data to be be used for parsing
+	 * @param  mixed (object|array) $extra_data extra incoming data (usually EE_Messages_Addressee)
+	 * @return string            parsed shortcode.
+	 */
+	public function parser($shortcode, $data, $extra_data = array())
+	{
+
+		//filter setup shortcodes
+		$this->_shortcodes = $this->get_shortcodes();
+
+		//we need to setup any dynamic shortcodes so that they work with the array_key_exists
+		$sc           = preg_match_all('/(\[[A-Za-z0-9\_]+_\*)/', $shortcode, $matches);
+		$sc_to_verify = ! empty($matches[0]) ? $matches[0][0] . ']' : $shortcode;
+
+		//first we want to make sure this is a valid shortcode
+		if (! array_key_exists($sc_to_verify, $this->_shortcodes)) {
+			return false;
+		} //get out, this parser doesn't handle the incoming shortcode.
+		$this->_data       = $data;
+		$this->_extra_data = $extra_data;
+		$this->_set_messages_properties();
+		$parsed = apply_filters('FHEE__' . get_class($this) . '__parser_after', $this->_parser($shortcode), $shortcode,
+			$data, $extra_data, $this);
+
+		//note the below filter applies to ALL shortcode parsers... be careful!
+		$parsed = apply_filters('FHEE__EE_Shortcodes__parser_after', $parsed, $shortcode, $data, $extra_data, $this);
+		return $parsed;
+	}
+
+
+	/**
+	 * This method just returns the shortcodes in the $_shortcodes array property.
+	 *
+	 * @access public
+	 * @return array array of shortcodes => description pairs
+	 */
+	public function get_shortcodes()
+	{
+		$this->_shortcodes = apply_filters('FHEE__' . get_class($this) . '__shortcodes', $this->_shortcodes, $this);
+
+		//note the below filter applies to ALL shortcode parsers... be careful!
+		$this->_shortcodes = apply_filters('FHEE__EE_Shortcodes__shortcodes', $this->_shortcodes, $this);
+
+		return $this->_shortcodes;
+	}
+
+
+	/**
+	 * Child classes use this method to set the $name, $description, and $_shortcodes properties.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _init_props();
+
+
+	/**
+	 * This method will give parsing instructions for each shortcode defined in the _shortcodes array.  Child methods
+	 * will have to take care of handling.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @param string               $shortcode the shortcode to be parsed.
+	 * @param mixed (object|array) $data      incoming data for the parser.  The data could be either an object or
+	 *                             array because there are some shortcodes that might be replaced by prepared data that
+	 *                             has multiple items in a list (i.e. list of attendees in an event and we're showing
+	 *                             fname/lname for each attendee).  In this case data will be in an array.  Otherwise
+	 *                             the data shoudl be in a properly formatted object.  The
+	 *                             EEH_Parse_Shortcodes.helper.php describes the data object we're expecting.
+	 * @return string parsed shortcode
+	 */
+	abstract protected function _parser($shortcode);
+
+
+	/**
+	 * This just validates incoming data for list type shortcode parsers (and they call this method) to make sure it
+	 * meets their requirements
+	 *
+	 * @return mixed (void|exception) If validation fails we'll throw an exception.
+	 */
+	protected function _validate_list_requirements()
+	{
+
+		//first test to make sure we've got an array!
+		if (! is_array($this->_data)) {
+			throw new EE_Error(sprintf(__('Expecting an array for the data sent to %s. Instead it was %s',
+				'event_espresso'), get_class($this), gettype($this->_data)));
+		}
+
+		//next test to make sure we've got the required template in the index!
+		if (! isset($this->_data['template'])) {
+			throw new EE_Error(sprintf(__('The incoming data does not have the required template index in its array',
+				'event_espresso')));
+		}
+
+		//next test to make sure we've got got a data index in the incoming data array
+		if (! isset($this->_data['data'])) {
+			throw new EE_Error(__('The incoming data does not have the required data index in its array',
+				'event_espresso'));
+		}
+
+		//all is well let's make sure _extra_data always has the values needed.
+		//let's make sure that extra_data includes all templates (for later parsing if necessary)
+		if (empty($this->_extra_data) || (empty($this->_extra_data['data']) && empty($this->_extra_data['template']))) {
+			$this->_extra_data['data']     = $this->_data['data'];
+			$this->_extra_data['template'] = $this->_data['template'];
+		}
+
+	}
+
+
+	/**
+	 * This returns any attributes that may be existing on an EE_Shortcode
+	 *
+	 * @since 4.5.0
+	 * @param string $shortcode incoming shortcode
+	 * @return array An array with the attributes
+	 */
+	protected function _get_shortcode_attrs($shortcode)
+	{
+		//make sure the required wp helper function is present
+		//require the shortcode file if necessary
+		if (! function_exists('shortcode_parse_atts')) {
+			require_once(ABSPATH . WPINC . '/shortcodes.php');
+		}
+
+		//let's get any attributes that may be present and set the defaults.
+		$shortcode_to_parse = str_replace('[', '', str_replace(']', '', $shortcode));
+		return shortcode_parse_atts($shortcode_to_parse);
+	}
+
+
+	/**
+	 * Conditional blocks are shortcode patterns with an opening conditional tag `[IF_*]` and a corresponding
+	 * closing tag (eg `[/IF_*]`).  The content within the tags will be displayed/hidden depending on whatever conditions
+	 * existed in the opening tag.  This method handles parsing the actual template to show/hide this conditional content.
+	 *
+	 * @since 4.9.32
+	 *
+	 * @param string $shortcode  This should be original shortcode as used in the template and passed to the parser.
+	 * @param bool $show  true means the opening and closing tags are removed and the content is left showing, false
+	 *                    means the opening and closing tags and the contained content are removed.
+	 * @return string     The template for the shortcode is returned.
+	 */
+	protected function _mutate_conditional_block_in_template($shortcode, $show = true)
+	{
+		//first let's get all the matches in the template for this particular shortcode.
+		preg_match_all('~' . $this->_get_conditional_block_regex($shortcode) . '~', $this->_data['template'], $matches);
+
+		if ($matches && is_array($matches[0]) && !empty($matches[0])) {
+			//we need to hide all instances of the matches
+			foreach ($matches[0] as $index => $content_to_show_or_hide) {
+				$content_to_show_or_hide = preg_quote($content_to_show_or_hide);
+				$replacement = $show ? $matches[4][$index] : '';
+				$this->_data['template'] = preg_replace(
+					'~' . $content_to_show_or_hide . '~',
+					$replacement,
+					$this->_data['template']
+				);
+			}
+		}
+		//return $template
+		return $this->_data['template'];
+	}
+
+
+	/**
+	 * This returns the regex pattern to use for conditional shortcodes parsing.
+	 *
+	 * Note: regex comes in part from the WP `get_shortcode_regex` expression in \wp-includes\shortcodes.php
+	 *
+	 * @param $shortcode
+	 * @since 4.9.32
+	 * @return string
+	 */
+	private function _get_conditional_block_regex($shortcode)
+	{
+		//get just the shortcode tag for the match
+		preg_match('@\[([^<>&/\[\]\x00-\x20=]++)@', $shortcode, $shortcode_tag_matches);
+		if (empty($shortcode_tag_matches[1])) {
+			return $this->_data['template'];
+		}
+
+		$shortcode_tag = $shortcode_tag_matches[1];
+		//get attributes_part_of_tag
+		$attributes_part = preg_quote(str_replace(array($shortcode_tag,'[',']'), '', $shortcode));
+		//escape
+		$shortcode_tag = preg_quote($shortcode_tag);
+
+		return
+			  '\['                                  //Opening Bracket
+			. "($shortcode_tag)$attributes_part"    //1: Shortcode Name
+			. '(?![\w-])'                           //Not followed by word character or hyphen
+			. '('                                   //2: Unroll the loop: Inside the opening shortcode tag
+			.   '[^\]\/]*'                          //Not a closing bracket or forward slash
+			.   '(?:'
+			.       '\/(?!\])'                      //A forward slash not followed by a closing bracket
+			.       '[^\]\/]*'                      //Not a closing bracket or forward slash.
+			.   ')*?'
+			. ')'
+			. '(?:'
+			.   '(\/)'                              //3. Self closing tag ...
+			.   '\]'                                // ... and closing bracket
+			. '|'
+			.   '\]'                                //Closing bracket
+			.   '(?:'
+			.       '('                             //4: Unroll the loop: Optionally, anything between the opening and closing brackets
+			.           '[^\[]*+'                   //Not an opening bracket
+			.           '(?:'
+			.               '\[(?!\/\1\])'          //An opening bracket not followed by the closing shortcode tag.
+			.               '[^\[]*+'               //Not an opening bracket
+			.           ')*+'
+			.       ')'
+			.       '\[\/\1\]'                      //Closing shortcode tag
+			.   ')?'
+			. ')';
+	}
+
+
+	/**
+	 * This sets the properties related to the messages system
+	 *
+	 * @since 4.5.0
+	 * @return void
+	 */
+	protected function _set_messages_properties()
+	{
+		//should be in _extra_data
+		if (isset($this->_extra_data['messenger'])) {
+			$this->_messenger    = $this->_extra_data['messenger'];
+			$this->_message_type = $this->_extra_data['message_type'];
+			$this->_context      = $this->_extra_data['message'] instanceof EE_Message ? $this->_extra_data['message']->context() : '';
+			$this->_GRP_ID       = $this->_extra_data['message'] instanceof EE_Message ? $this->_extra_data['message']->GRP_ID() : 0;
+			$this->_message      = $this->_extra_data['message'] instanceof EE_Message ? $this->_extra_data['message'] : null;
+		}
+	}
+
+
+	/**
+	 * This returns whatever the set message type object is that was set on this shortcode parser.
+	 *
+	 * @since 4.5.0
+	 * @return EE_message_type
+	 */
+	public function get_set_message_type()
+	{
+		return $this->_message_type;
+	}
+
+
+	/**
+	 * This returns whatever the set messenger object is that was set on this shortcode parser
+	 *
+	 * @since 4.5.0
+	 * @return EE_messenger
+	 */
+	public function get_set_messenger()
+	{
+		return $this->_messenger;
+	}
+
+
+	/**
+	 * This returns whatever the set context string is on this shortcode parser.
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 */
+	public function get_set_context()
+	{
+		return $this->_context;
+	}
+
+
+	/**
+	 * This returns whatever the set EE_Message object is on this shortcode.
+	 *
+	 * @since 4.9.0
+	 * @return EE_Message
+	 */
+	public function get_set_message()
+	{
+		return $this->_message;
+	}
 
 
 } //end EE_Shortcodes

Spacing +15 added lines, -15 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
 }
 
@@ -159,7 +159,7 @@ 
 
     public function get_shortcode_helper()
     {
-        if (! $this->_shortcode_helper instanceof EEH_Parse_Shortcodes) {
+        if ( ! $this->_shortcode_helper instanceof EEH_Parse_Shortcodes) {
             $this->_set_shortcode_helper();
         }
         return $this->_shortcode_helper;
@@ -183,16 +183,16 @@ 
 
         //we need to setup any dynamic shortcodes so that they work with the array_key_exists
         $sc           = preg_match_all('/(\[[A-Za-z0-9\_]+_\*)/', $shortcode, $matches);
-        $sc_to_verify = ! empty($matches[0]) ? $matches[0][0] . ']' : $shortcode;
+        $sc_to_verify = ! empty($matches[0]) ? $matches[0][0].']' : $shortcode;
 
         //first we want to make sure this is a valid shortcode
-        if (! array_key_exists($sc_to_verify, $this->_shortcodes)) {
+        if ( ! array_key_exists($sc_to_verify, $this->_shortcodes)) {
             return false;
         } //get out, this parser doesn't handle the incoming shortcode.
         $this->_data       = $data;
         $this->_extra_data = $extra_data;
         $this->_set_messages_properties();
-        $parsed = apply_filters('FHEE__' . get_class($this) . '__parser_after', $this->_parser($shortcode), $shortcode,
+        $parsed = apply_filters('FHEE__'.get_class($this).'__parser_after', $this->_parser($shortcode), $shortcode,
             $data, $extra_data, $this);
 
         //note the below filter applies to ALL shortcode parsers... be careful!
@@ -209,7 +209,7 @@ 
      */
     public function get_shortcodes()
     {
-        $this->_shortcodes = apply_filters('FHEE__' . get_class($this) . '__shortcodes', $this->_shortcodes, $this);
+        $this->_shortcodes = apply_filters('FHEE__'.get_class($this).'__shortcodes', $this->_shortcodes, $this);
 
         //note the below filter applies to ALL shortcode parsers... be careful!
         $this->_shortcodes = apply_filters('FHEE__EE_Shortcodes__shortcodes', $this->_shortcodes, $this);
@@ -256,19 +256,19 @@ 
     {
 
         //first test to make sure we've got an array!
-        if (! is_array($this->_data)) {
+        if ( ! is_array($this->_data)) {
             throw new EE_Error(sprintf(__('Expecting an array for the data sent to %s. Instead it was %s',
                 'event_espresso'), get_class($this), gettype($this->_data)));
         }
 
         //next test to make sure we've got the required template in the index!
-        if (! isset($this->_data['template'])) {
+        if ( ! isset($this->_data['template'])) {
             throw new EE_Error(sprintf(__('The incoming data does not have the required template index in its array',
                 'event_espresso')));
         }
 
         //next test to make sure we've got got a data index in the incoming data array
-        if (! isset($this->_data['data'])) {
+        if ( ! isset($this->_data['data'])) {
             throw new EE_Error(__('The incoming data does not have the required data index in its array',
                 'event_espresso'));
         }
@@ -294,8 +294,8 @@ 
     {
         //make sure the required wp helper function is present
         //require the shortcode file if necessary
-        if (! function_exists('shortcode_parse_atts')) {
-            require_once(ABSPATH . WPINC . '/shortcodes.php');
+        if ( ! function_exists('shortcode_parse_atts')) {
+            require_once(ABSPATH.WPINC.'/shortcodes.php');
         }
 
         //let's get any attributes that may be present and set the defaults.
@@ -319,15 +319,15 @@ 
     protected function _mutate_conditional_block_in_template($shortcode, $show = true)
     {
         //first let's get all the matches in the template for this particular shortcode.
-        preg_match_all('~' . $this->_get_conditional_block_regex($shortcode) . '~', $this->_data['template'], $matches);
+        preg_match_all('~'.$this->_get_conditional_block_regex($shortcode).'~', $this->_data['template'], $matches);
 
-        if ($matches && is_array($matches[0]) && !empty($matches[0])) {
+        if ($matches && is_array($matches[0]) && ! empty($matches[0])) {
             //we need to hide all instances of the matches
             foreach ($matches[0] as $index => $content_to_show_or_hide) {
                 $content_to_show_or_hide = preg_quote($content_to_show_or_hide);
                 $replacement = $show ? $matches[4][$index] : '';
                 $this->_data['template'] = preg_replace(
-                    '~' . $content_to_show_or_hide . '~',
+                    '~'.$content_to_show_or_hide.'~',
                     $replacement,
                     $this->_data['template']
                 );
@@ -357,7 +357,7 @@ 
 
         $shortcode_tag = $shortcode_tag_matches[1];
         //get attributes_part_of_tag
-        $attributes_part = preg_quote(str_replace(array($shortcode_tag,'[',']'), '', $shortcode));
+        $attributes_part = preg_quote(str_replace(array($shortcode_tag, '[', ']'), '', $shortcode));
         //escape
         $shortcode_tag = preg_quote($shortcode_tag);
 

core/db_models/EEM_Line_Item.model.php

Indentation +56 added lines, -56 removed lines

@@ -362,62 +362,62 @@
 
 
 
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws \EE_Error
-     */
-    public function get_total_line_items_with_no_transaction()
-    {
-        return $this->get_total_line_items_for_carts();
-    }
-
-
-
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws \EE_Error
-     */
-    public function get_total_line_items_for_active_carts()
-    {
-        return $this->get_total_line_items_for_carts(false);
-    }
-
-
-
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws \EE_Error
-     */
-    public function get_total_line_items_for_expired_carts()
-    {
-        return $this->get_total_line_items_for_carts(true);
-    }
-
-
-
-    /**
-     * Returns an array of grand total line items where the TXN_ID is 0.
-     * If $expired is set to true, then only line items for expired sessions will be returned.
-     * If $expired is set to false, then only line items for active sessions will be returned.
-     *
-     * @param bool|null $expired
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws \EE_Error
-     */
-    private function get_total_line_items_for_carts($expired = null)
-    {
-        $where_params = array(
-            'TXN_ID'        => 0,
-            'LIN_type'      => 'total',
-        );
-        if ($expired !== null) {
-            $where_params['LIN_timestamp'] = array(
-                $expired ? '<=' : '>',
-                time() - EE_Registry::instance()->SSN->lifespan(),
-            );
-        }
-        return $this->get_all(array($where_params));
-    }
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws \EE_Error
+	 */
+	public function get_total_line_items_with_no_transaction()
+	{
+		return $this->get_total_line_items_for_carts();
+	}
+
+
+
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws \EE_Error
+	 */
+	public function get_total_line_items_for_active_carts()
+	{
+		return $this->get_total_line_items_for_carts(false);
+	}
+
+
+
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws \EE_Error
+	 */
+	public function get_total_line_items_for_expired_carts()
+	{
+		return $this->get_total_line_items_for_carts(true);
+	}
+
+
+
+	/**
+	 * Returns an array of grand total line items where the TXN_ID is 0.
+	 * If $expired is set to true, then only line items for expired sessions will be returned.
+	 * If $expired is set to false, then only line items for active sessions will be returned.
+	 *
+	 * @param bool|null $expired
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws \EE_Error
+	 */
+	private function get_total_line_items_for_carts($expired = null)
+	{
+		$where_params = array(
+			'TXN_ID'        => 0,
+			'LIN_type'      => 'total',
+		);
+		if ($expired !== null) {
+			$where_params['LIN_timestamp'] = array(
+				$expired ? '<=' : '>',
+				time() - EE_Registry::instance()->SSN->lifespan(),
+			);
+		}
+		return $this->get_all(array($where_params));
+	}
 
 
 

caffeinated/payment_methods/Mijireh/EEG_Mijireh.gateway.php

Indentation +84 added lines, -84 removed lines

@@ -103,7 +103,7 @@ 
 		}
 		$order = apply_filters( 'FHEE__EEG_Mijireh__set_redirection_info__order_arguments', $order, $payment, $primary_registrant );
 		do_action( 'AHEE_log', __FILE__, __FUNCTION__, serialize(get_object_vars($this)) );
-        $order = $this->_get_unsupported_character_remover()->formatArray($order);
+		$order = $this->_get_unsupported_character_remover()->formatArray($order);
 
 		$args = array(
 			'headers' => array(
@@ -113,45 +113,45 @@ 
 			'body'=>  wp_json_encode($order)
 		);
 		$response = wp_remote_post( $this->_mijireh_api_orders_url, $args );
-                $problems_string = false;
+				$problems_string = false;
 		$this->log(array('get checkout url request_args' => $args, 'response' => $response ), $payment);
 		if( ! $response instanceof WP_Error ){
 			$response_body = json_decode($response['body']);
 			if($response_body && isset($response_body->checkout_url)){
-                            $payment->set_redirect_url($response_body->checkout_url);
-                            $payment->set_txn_id_chq_nmbr($response_body->order_number);
-                            $payment->set_details($response['body']);
+							$payment->set_redirect_url($response_body->checkout_url);
+							$payment->set_txn_id_chq_nmbr($response_body->order_number);
+							$payment->set_details($response['body']);
 			} else {
-                           if( is_array( $response_body ) || is_object( $response_body)){
-                                    $response_body_as_array = (array)$response_body;
-                                    foreach($response_body_as_array as $problem_parameter => $problems){
-                                            $problems_string.= sprintf(__('\nProblems with %s: %s','event_espresso'),$problem_parameter,implode(", ",$problems));
-                                    }
-                            }else{
-                                    $problems_string = $response['body'];
-                            }
-                            if( ! $problems_string ) {
-                                //no message to show? wack
-                                if( isset( $response[ 'headers' ][ 'status' ] ) ){
-                                        $problems_string = $response[ 'headers' ][ 'status' ];
-                                }else{
-                                        $problems_string = __( 'No response from Mijireh', 'event_espresso' );
-                                }
-                            }
-                        }
+						   if( is_array( $response_body ) || is_object( $response_body)){
+									$response_body_as_array = (array)$response_body;
+									foreach($response_body_as_array as $problem_parameter => $problems){
+											$problems_string.= sprintf(__('\nProblems with %s: %s','event_espresso'),$problem_parameter,implode(", ",$problems));
+									}
+							}else{
+									$problems_string = $response['body'];
+							}
+							if( ! $problems_string ) {
+								//no message to show? wack
+								if( isset( $response[ 'headers' ][ 'status' ] ) ){
+										$problems_string = $response[ 'headers' ][ 'status' ];
+								}else{
+										$problems_string = __( 'No response from Mijireh', 'event_espresso' );
+								}
+							}
+						}
 		}else{
-                    $problems_string = implode( ",", $response->get_error_messages() );
+					$problems_string = implode( ",", $response->get_error_messages() );
 		}
                 
-                if( $problems_string ) {
-                    $payment->set_gateway_response( sprintf( __( 'Errors occurred communicating with Mijireh: %1$s', 'event_espresso'), $problems_string ) );
-                    $payment->set_details( $response );
-                    $payment->set_redirect_url( null );
-                    //even though the payment's status is failed at this point anyways,
-                    //let's be explicit about it. The fact that the redirect url is null
-                    //should be enough to client code that they can't redirect the user
-                    $payment->set_status( $this->_pay_model->failed_status() );
-                }
+				if( $problems_string ) {
+					$payment->set_gateway_response( sprintf( __( 'Errors occurred communicating with Mijireh: %1$s', 'event_espresso'), $problems_string ) );
+					$payment->set_details( $response );
+					$payment->set_redirect_url( null );
+					//even though the payment's status is failed at this point anyways,
+					//let's be explicit about it. The fact that the redirect url is null
+					//should be enough to client code that they can't redirect the user
+					$payment->set_status( $this->_pay_model->failed_status() );
+				}
 		return $payment;
 	}
 
@@ -188,70 +188,70 @@ 
 	 * @param array $update_info unused. We just use the $transaction
 	 * @param EEI_Transaction $transaction
 	 * @return \EEI_Payment
-     * @throws EE_Error
+	 * @throws EE_Error
 	 */
 	public function handle_payment_update($update_info, $transaction) {
-        foreach( $transaction->pending_payments() as $payment){
-		    $payment = $this->check_payment_in_mijireh($payment);
-            if( $payment->status() === $this->_pay_model->approved_status()){
-                return $payment;
-            }
-        }
-        $payment = $transaction instanceof EEI_Transaction ? $transaction->last_payment() : NULL;
+		foreach( $transaction->pending_payments() as $payment){
+			$payment = $this->check_payment_in_mijireh($payment);
+			if( $payment->status() === $this->_pay_model->approved_status()){
+				return $payment;
+			}
+		}
+		$payment = $transaction instanceof EEI_Transaction ? $transaction->last_payment() : NULL;
 
-        if ( ! $payment instanceof EEI_Payment ){
-            throw new EE_Error( sprintf( __( "Could not find Mijireh payment for transaction %s", 'event_espresso' ), $transaction->ID() ) );
-        }
-        return $payment;
+		if ( ! $payment instanceof EEI_Payment ){
+			throw new EE_Error( sprintf( __( "Could not find Mijireh payment for transaction %s", 'event_espresso' ), $transaction->ID() ) );
+		}
+		return $payment;
 	}
 
 
 
-    /**
-     * Checks the payment's status in Mijireh for this specific payment
-     * @param \EEI_Payment $payment
-     * @return \EEI_Payment
-     */
+	/**
+	 * Checks the payment's status in Mijireh for this specific payment
+	 * @param \EEI_Payment $payment
+	 * @return \EEI_Payment
+	 */
 	public function check_payment_in_mijireh( EEI_Payment $payment ){
-        $request_args = array(
-            'headers' => array(
-                'Authorization' => 'Basic ' . base64_encode( $this->_access_key . ':' ),
-                'Accept'=>'application/json'
-            )
-        );
+		$request_args = array(
+			'headers' => array(
+				'Authorization' => 'Basic ' . base64_encode( $this->_access_key . ':' ),
+				'Accept'=>'application/json'
+			)
+		);
 
-        $response = wp_remote_get(
-            $this->_mijireh_api_orders_url . '/' . $payment->txn_id_chq_nmbr(),
-            $request_args
-        );
+		$response = wp_remote_get(
+			$this->_mijireh_api_orders_url . '/' . $payment->txn_id_chq_nmbr(),
+			$request_args
+		);
 
-        $this->log(
-            array( 'get payment status request_args' => $request_args, 'response' => $response ),
-            $payment
-        );
-        // validate response
-        $response_body = isset( $response[ 'body' ] ) ? json_decode( $response[ 'body' ] ) : '';
-        if( $response && $response_body ){
-            switch( $response_body->status ){
-                case 'paid':
-                    $payment->set_status($this->_pay_model->approved_status());
-                    break;
-                case 'pending':
-                    $payment->set_status($this->_pay_model->pending_status());
-                    break;
-                default:
-                    $payment->set_status($this->_pay_model->declined_status());
-            }
+		$this->log(
+			array( 'get payment status request_args' => $request_args, 'response' => $response ),
+			$payment
+		);
+		// validate response
+		$response_body = isset( $response[ 'body' ] ) ? json_decode( $response[ 'body' ] ) : '';
+		if( $response && $response_body ){
+			switch( $response_body->status ){
+				case 'paid':
+					$payment->set_status($this->_pay_model->approved_status());
+					break;
+				case 'pending':
+					$payment->set_status($this->_pay_model->pending_status());
+					break;
+				default:
+					$payment->set_status($this->_pay_model->declined_status());
+			}
 
-        } else {
-            $payment->set_gateway_response( __( 'Response from Mijireh could not be understood.', 'event_espresso' ) );
-            $payment->set_details( $response );
-            $payment->set_status( $this->_pay_model->failed_status() );
-        }
-        // the following is ONLY for testing the Mijireh IPN and should NEVER be uncommented for real usage
+		} else {
+			$payment->set_gateway_response( __( 'Response from Mijireh could not be understood.', 'event_espresso' ) );
+			$payment->set_details( $response );
+			$payment->set_status( $this->_pay_model->failed_status() );
+		}
+		// the following is ONLY for testing the Mijireh IPN and should NEVER be uncommented for real usage
 //		$payment->set_status( $this->_pay_model->pending_status() );
-        return $payment;
-    }
+		return $payment;
+	}
 
 }
 

Spacing +62 added lines, -62 removed lines

@@ -8,7 +8,7 @@ 
  * @author				Mike Nelson
  *
  */
-class EEG_Mijireh extends EE_Offsite_Gateway{
+class EEG_Mijireh extends EE_Offsite_Gateway {
 
 	protected $_access_key;
 
@@ -37,14 +37,14 @@ 
 		$primary_attendee = $primary_registrant->attendee();
 		$items = array();
 		//if we're are charging for the full amount, show the normal line items
-		if( $this->_can_easily_itemize_transaction_for( $payment )){
+		if ($this->_can_easily_itemize_transaction_for($payment)) {
 			$total_line_item = $transaction->total_line_item();
 			$tax_total = $total_line_item->get_total_tax();
-			foreach($total_line_item->get_items() as $line_item){
+			foreach ($total_line_item->get_items() as $line_item) {
 				$items[] = array(
 					'name'=>apply_filters(
 						'FHEE__EEG_Mijireh__set_redirection_info__full_amount_line_item_name',
-						$this->_format_line_item_name( $line_item, $payment ),
+						$this->_format_line_item_name($line_item, $payment),
 						$line_item,
 						$payment,
 						$primary_registrant
@@ -54,13 +54,13 @@ 
 					'quantity'=>$line_item->quantity()
 				);
 			}
-		}else{//its a partial payment
+		} else {//its a partial payment
 			$tax_total = 0;
 			//partial payment, so just add 1 item
 			$items[] = array(
 				'name'=> apply_filters(
 					'FHEE__EEG_Mijireh__set_redirection_info__partial_amount_line_item_name',
-					$this->_format_partial_payment_line_item_name( $payment ),
+					$this->_format_partial_payment_line_item_name($payment),
 					$payment,
 					$primary_registrant
 				),
@@ -72,18 +72,18 @@ 
 		$order = array(
 			'total'=>$this->format_currency($payment->amount()),
 			'return_url'=>$return_url,
-			'items'=>$this->_prepare_for_mijireh( $items ),
+			'items'=>$this->_prepare_for_mijireh($items),
 			'email'=>$primary_attendee->email(),
 			'first_name'=>$primary_attendee->fname(),
 			'last_name'=>$primary_attendee->lname(),
 			'tax'=>$this->format_currency($tax_total),
 			'partner_id'=>'ee');
 		//setup address?
-		if(		$primary_attendee->address()  &&
-				$primary_attendee->city()  &&
-				$primary_attendee->state_ID()  &&
-				$primary_attendee->country_ID()  &&
-				$primary_attendee->zip()  ){
+		if ($primary_attendee->address() &&
+				$primary_attendee->city() &&
+				$primary_attendee->state_ID() &&
+				$primary_attendee->country_ID() &&
+				$primary_attendee->zip()) {
 			$shipping_address = array(
 				'first_name'=>$primary_attendee->fname(),
 				'last_name'=>$primary_attendee->lname(),
@@ -93,64 +93,64 @@ 
 				'zip_code' => $primary_attendee->zip(),
 				'country' => $primary_attendee->country_ID()
 			);
-			if( $primary_attendee->address2() ){
-				$shipping_address[ 'apt_suite' ] = $primary_attendee->address2();
+			if ($primary_attendee->address2()) {
+				$shipping_address['apt_suite'] = $primary_attendee->address2();
 			}
-			if( $primary_attendee->phone() ){
-				$shipping_address[ 'phone' ] = $primary_attendee->phone();
+			if ($primary_attendee->phone()) {
+				$shipping_address['phone'] = $primary_attendee->phone();
 			}
-			$order[ 'shipping_address' ] = $shipping_address;
+			$order['shipping_address'] = $shipping_address;
 		}
-		$order = apply_filters( 'FHEE__EEG_Mijireh__set_redirection_info__order_arguments', $order, $payment, $primary_registrant );
-		do_action( 'AHEE_log', __FILE__, __FUNCTION__, serialize(get_object_vars($this)) );
+		$order = apply_filters('FHEE__EEG_Mijireh__set_redirection_info__order_arguments', $order, $payment, $primary_registrant);
+		do_action('AHEE_log', __FILE__, __FUNCTION__, serialize(get_object_vars($this)));
         $order = $this->_get_unsupported_character_remover()->formatArray($order);
 
 		$args = array(
 			'headers' => array(
-				'Authorization' => 'Basic ' . base64_encode( $this->_access_key . ':' ),
+				'Authorization' => 'Basic '.base64_encode($this->_access_key.':'),
 				'Accept'=>'application/json'
 			),
 			'body'=>  wp_json_encode($order)
 		);
-		$response = wp_remote_post( $this->_mijireh_api_orders_url, $args );
+		$response = wp_remote_post($this->_mijireh_api_orders_url, $args);
                 $problems_string = false;
-		$this->log(array('get checkout url request_args' => $args, 'response' => $response ), $payment);
-		if( ! $response instanceof WP_Error ){
+		$this->log(array('get checkout url request_args' => $args, 'response' => $response), $payment);
+		if ( ! $response instanceof WP_Error) {
 			$response_body = json_decode($response['body']);
-			if($response_body && isset($response_body->checkout_url)){
+			if ($response_body && isset($response_body->checkout_url)) {
                             $payment->set_redirect_url($response_body->checkout_url);
                             $payment->set_txn_id_chq_nmbr($response_body->order_number);
                             $payment->set_details($response['body']);
 			} else {
-                           if( is_array( $response_body ) || is_object( $response_body)){
-                                    $response_body_as_array = (array)$response_body;
-                                    foreach($response_body_as_array as $problem_parameter => $problems){
-                                            $problems_string.= sprintf(__('\nProblems with %s: %s','event_espresso'),$problem_parameter,implode(", ",$problems));
+                           if (is_array($response_body) || is_object($response_body)) {
+                                    $response_body_as_array = (array) $response_body;
+                                    foreach ($response_body_as_array as $problem_parameter => $problems) {
+                                            $problems_string .= sprintf(__('\nProblems with %s: %s', 'event_espresso'), $problem_parameter, implode(", ", $problems));
                                     }
-                            }else{
+                            } else {
                                     $problems_string = $response['body'];
                             }
-                            if( ! $problems_string ) {
+                            if ( ! $problems_string) {
                                 //no message to show? wack
-                                if( isset( $response[ 'headers' ][ 'status' ] ) ){
-                                        $problems_string = $response[ 'headers' ][ 'status' ];
-                                }else{
-                                        $problems_string = __( 'No response from Mijireh', 'event_espresso' );
+                                if (isset($response['headers']['status'])) {
+                                        $problems_string = $response['headers']['status'];
+                                } else {
+                                        $problems_string = __('No response from Mijireh', 'event_espresso');
                                 }
                             }
                         }
-		}else{
-                    $problems_string = implode( ",", $response->get_error_messages() );
+		} else {
+                    $problems_string = implode(",", $response->get_error_messages());
 		}
                 
-                if( $problems_string ) {
-                    $payment->set_gateway_response( sprintf( __( 'Errors occurred communicating with Mijireh: %1$s', 'event_espresso'), $problems_string ) );
-                    $payment->set_details( $response );
-                    $payment->set_redirect_url( null );
+                if ($problems_string) {
+                    $payment->set_gateway_response(sprintf(__('Errors occurred communicating with Mijireh: %1$s', 'event_espresso'), $problems_string));
+                    $payment->set_details($response);
+                    $payment->set_redirect_url(null);
                     //even though the payment's status is failed at this point anyways,
                     //let's be explicit about it. The fact that the redirect url is null
                     //should be enough to client code that they can't redirect the user
-                    $payment->set_status( $this->_pay_model->failed_status() );
+                    $payment->set_status($this->_pay_model->failed_status());
                 }
 		return $payment;
 	}
@@ -163,16 +163,16 @@ 
 	 * @param mixed $data
 	 * @return mixed same type as $data
 	 */
-	private function _prepare_for_mijireh( $data ){
-		if( is_array( $data ) ){
+	private function _prepare_for_mijireh($data) {
+		if (is_array($data)) {
 			$prepared_data = array();
-			foreach($data as $key => $datum ){
-				$prepared_data[ $key ] = $this->_prepare_for_mijireh( $datum );
+			foreach ($data as $key => $datum) {
+				$prepared_data[$key] = $this->_prepare_for_mijireh($datum);
 			}
 			return $prepared_data;
-		}elseif(is_string( $data ) ){
-			return str_replace( '%', 'percent', $data );
-		}else{
+		}elseif (is_string($data)) {
+			return str_replace('%', 'percent', $data);
+		} else {
 			return $data;
 		}
 	}
@@ -191,16 +191,16 @@ 
      * @throws EE_Error
 	 */
 	public function handle_payment_update($update_info, $transaction) {
-        foreach( $transaction->pending_payments() as $payment){
+        foreach ($transaction->pending_payments() as $payment) {
 		    $payment = $this->check_payment_in_mijireh($payment);
-            if( $payment->status() === $this->_pay_model->approved_status()){
+            if ($payment->status() === $this->_pay_model->approved_status()) {
                 return $payment;
             }
         }
         $payment = $transaction instanceof EEI_Transaction ? $transaction->last_payment() : NULL;
 
-        if ( ! $payment instanceof EEI_Payment ){
-            throw new EE_Error( sprintf( __( "Could not find Mijireh payment for transaction %s", 'event_espresso' ), $transaction->ID() ) );
+        if ( ! $payment instanceof EEI_Payment) {
+            throw new EE_Error(sprintf(__("Could not find Mijireh payment for transaction %s", 'event_espresso'), $transaction->ID()));
         }
         return $payment;
 	}
@@ -212,27 +212,27 @@ 
      * @param \EEI_Payment $payment
      * @return \EEI_Payment
      */
-	public function check_payment_in_mijireh( EEI_Payment $payment ){
+	public function check_payment_in_mijireh(EEI_Payment $payment) {
         $request_args = array(
             'headers' => array(
-                'Authorization' => 'Basic ' . base64_encode( $this->_access_key . ':' ),
+                'Authorization' => 'Basic '.base64_encode($this->_access_key.':'),
                 'Accept'=>'application/json'
             )
         );
 
         $response = wp_remote_get(
-            $this->_mijireh_api_orders_url . '/' . $payment->txn_id_chq_nmbr(),
+            $this->_mijireh_api_orders_url.'/'.$payment->txn_id_chq_nmbr(),
             $request_args
         );
 
         $this->log(
-            array( 'get payment status request_args' => $request_args, 'response' => $response ),
+            array('get payment status request_args' => $request_args, 'response' => $response),
             $payment
         );
         // validate response
-        $response_body = isset( $response[ 'body' ] ) ? json_decode( $response[ 'body' ] ) : '';
-        if( $response && $response_body ){
-            switch( $response_body->status ){
+        $response_body = isset($response['body']) ? json_decode($response['body']) : '';
+        if ($response && $response_body) {
+            switch ($response_body->status) {
                 case 'paid':
                     $payment->set_status($this->_pay_model->approved_status());
                     break;
@@ -244,9 +244,9 @@ 
             }
 
         } else {
-            $payment->set_gateway_response( __( 'Response from Mijireh could not be understood.', 'event_espresso' ) );
-            $payment->set_details( $response );
-            $payment->set_status( $this->_pay_model->failed_status() );
+            $payment->set_gateway_response(__('Response from Mijireh could not be understood.', 'event_espresso'));
+            $payment->set_details($response);
+            $payment->set_status($this->_pay_model->failed_status());
         }
         // the following is ONLY for testing the Mijireh IPN and should NEVER be uncommented for real usage
 //		$payment->set_status( $this->_pay_model->pending_status() );

core/services/formatters/FormatterBase.php

Indentation +22 added lines, -22 removed lines

@@ -18,27 +18,27 @@
 abstract class FormatterBase implements FormatterInterface
 {
 
-    /**
-     * Recursively applies the formatting to all VALUES in this multi-dimensional array
-     *
-     * @param array $input
-     * @return array
-     * @throws InvalidDataTypeException if $input is not an array
-     */
-    public function formatArray($input)
-    {
-        if (! is_array($input)) {
-            throw new InvalidDataTypeException('input', $input, 'array');
-        }
-        //we can use $this inside the closure in PHP 5.3, so pass in a variable pointing to this instead
-        $formatter = $this;
-        array_walk_recursive(
-            $input,
-            function (&$value, $key) use ($formatter) {
-                $value = $formatter->format($value);
-            }
-        );
-        return $input;
-    }}
+	/**
+	 * Recursively applies the formatting to all VALUES in this multi-dimensional array
+	 *
+	 * @param array $input
+	 * @return array
+	 * @throws InvalidDataTypeException if $input is not an array
+	 */
+	public function formatArray($input)
+	{
+		if (! is_array($input)) {
+			throw new InvalidDataTypeException('input', $input, 'array');
+		}
+		//we can use $this inside the closure in PHP 5.3, so pass in a variable pointing to this instead
+		$formatter = $this;
+		array_walk_recursive(
+			$input,
+			function (&$value, $key) use ($formatter) {
+				$value = $formatter->format($value);
+			}
+		);
+		return $input;
+	}}
 // End of file FormatterBase.php
 // Location: core\services\formatters/FormatterBase.php
\ No newline at end of file

Spacing +2 added lines, -2 removed lines

@@ -27,14 +27,14 @@
      */
     public function formatArray($input)
     {
-        if (! is_array($input)) {
+        if ( ! is_array($input)) {
             throw new InvalidDataTypeException('input', $input, 'array');
         }
         //we can use $this inside the closure in PHP 5.3, so pass in a variable pointing to this instead
         $formatter = $this;
         array_walk_recursive(
             $input,
-            function (&$value, $key) use ($formatter) {
+            function(&$value, $key) use ($formatter) {
                 $value = $formatter->format($value);
             }
         );

modules/core_rest_api/EED_Core_Rest_Api.module.php

Indentation +791 added lines, -791 removed lines

@@ -18,807 +18,807 @@
 class EED_Core_Rest_Api extends \EED_Module
 {
 
-    const ee_api_namespace           = 'ee/v';
+	const ee_api_namespace           = 'ee/v';
 
-    const ee_api_namespace_for_regex = 'ee\/v([^/]*)\/';
+	const ee_api_namespace_for_regex = 'ee\/v([^/]*)\/';
 
-    const saved_routes_option_names  = 'ee_core_routes';
+	const saved_routes_option_names  = 'ee_core_routes';
 
-    /**
-     * string used in _links response bodies to make them globally unique.
-     *
-     * @see http://v2.wp-api.org/extending/linking/
-     */
-    const ee_api_link_namespace = 'https://api.eventespresso.com/';
+	/**
+	 * string used in _links response bodies to make them globally unique.
+	 *
+	 * @see http://v2.wp-api.org/extending/linking/
+	 */
+	const ee_api_link_namespace = 'https://api.eventespresso.com/';
 
-    /**
-     * @var Calculated_Model_Fields
-     */
-    protected static $_field_calculator = null;
+	/**
+	 * @var Calculated_Model_Fields
+	 */
+	protected static $_field_calculator = null;
 
 
 
-    /**
-     * @return EED_Core_Rest_Api
-     */
-    public static function instance()
-    {
-        self::$_field_calculator = new Calculated_Model_Fields();
-        return parent::get_instance(__CLASS__);
-    }
+	/**
+	 * @return EED_Core_Rest_Api
+	 */
+	public static function instance()
+	{
+		self::$_field_calculator = new Calculated_Model_Fields();
+		return parent::get_instance(__CLASS__);
+	}
 
 
 
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        self::set_hooks_both();
-    }
-
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        self::set_hooks_both();
-    }
-
-
-
-    public static function set_hooks_both()
-    {
-        add_action('rest_api_init', array('EED_Core_Rest_Api', 'register_routes'), 10);
-        add_action('rest_api_init', array('EED_Core_Rest_Api', 'set_hooks_rest_api'), 5);
-        add_filter('rest_route_data', array('EED_Core_Rest_Api', 'hide_old_endpoints'), 10, 2);
-        add_filter('rest_index',
-            array('EventEspresso\core\libraries\rest_api\controllers\model\Meta', 'filter_ee_metadata_into_index'));
-        EED_Core_Rest_Api::invalidate_cached_route_data_on_version_change();
-    }
-
-
-
-    /**
-     * sets up hooks which only need to be included as part of REST API requests;
-     * other requests like to the frontend or admin etc don't need them
-     */
-    public static function set_hooks_rest_api()
-    {
-        //set hooks which account for changes made to the API
-        EED_Core_Rest_Api::_set_hooks_for_changes();
-    }
-
-
-
-    /**
-     * public wrapper of _set_hooks_for_changes.
-     * Loads all the hooks which make requests to old versions of the API
-     * appear the same as they always did
-     */
-    public static function set_hooks_for_changes()
-    {
-        self::_set_hooks_for_changes();
-    }
-
-
-
-
-
-
-
-    /**
-     * Loads all the hooks which make requests to old versions of the API
-     * appear the same as they always did
-     */
-    protected static function _set_hooks_for_changes()
-    {
-        $folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES . 'rest_api' . DS . 'changes'), false);
-        foreach ($folder_contents as $classname_in_namespace => $filepath) {
-            //ignore the base parent class
-            if ($classname_in_namespace === 'Changes_In_Base') {
-                continue;
-            }
-            $full_classname = 'EventEspresso\core\libraries\rest_api\changes\\' . $classname_in_namespace;
-            if (class_exists($full_classname)) {
-                $instance_of_class = new $full_classname;
-                if ($instance_of_class instanceof Changes_In_Base) {
-                    $instance_of_class->set_hooks();
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * Filters the WP routes to add our EE-related ones. This takes a bit of time
-     * so we actually prefer to only do it when an EE plugin is activated or upgraded
-     */
-    public static function register_routes()
-    {
-        foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
-            foreach ($relative_urls as $endpoint => $routes) {
-                foreach ($routes as $route) {
-                    $route_args = array(
-                        array(
-                            'callback' => $route['callback'],
-                            'methods'  => $route['methods'],
-                            'args'     => isset($route['args']) ? $route['args'] : array(),
-                        )
-                    );
-                    if (isset($route['schema_callback'])) {
-                        $model_name = isset($route['schema_callback'][0])
-                            ? $route['schema_callback'][0]
-                            : '';
-                        $version = isset( $route['schema_callback'][1])
-                            ? $route['schema_callback'][1]
-                            : '';
-                        if (! empty($model_name) && ! empty($version)) {
-                            $route_args['schema'] = function () use ($model_name, $version) {
-                                return ModelRead::handle_schema_request(
-                                    $model_name,
-                                    $version
-                                );
-                            };
-                        }
-                    }
-                    register_rest_route(
-                        $namespace,
-                        $endpoint,
-                        $route_args
-                    );
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * Checks if there was a version change or something that merits invalidating the cached
-     * route data. If so, invalidates the cached route data so that it gets refreshed
-     * next time the WP API is used
-     */
-    public static function invalidate_cached_route_data_on_version_change()
-    {
-        if (EE_System::instance()->detect_req_type() != EE_System::req_type_normal) {
-            EED_Core_Rest_Api::invalidate_cached_route_data();
-        }
-        foreach (EE_Registry::instance()->addons as $addon) {
-            if ($addon instanceof EE_Addon && $addon->detect_req_type() != EE_System::req_type_normal) {
-                EED_Core_Rest_Api::invalidate_cached_route_data();
-            }
-        }
-    }
-
-
-
-    /**
-     * Removes the cached route data so it will get refreshed next time the WP API is used
-     */
-    public static function invalidate_cached_route_data()
-    {
-        //delete the saved EE REST API routes
-        foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden) {
-            delete_option(EED_Core_Rest_Api::saved_routes_option_names . $version);
-        }
-    }
-
-
-
-    /**
-     * Gets the EE route data
-     *
-     * @return array top-level key is the namespace, next-level key is the route and its value is array{
-     * @type string|array $callback
-     * @type string       $methods
-     * @type boolean      $hidden_endpoint
-     * }
-     */
-    public static function get_ee_route_data()
-    {
-        $ee_routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoints) {
-            $ee_routes[self::ee_api_namespace . $version] = self::_get_ee_route_data_for_version($version,
-                $hidden_endpoints);
-        }
-        return $ee_routes;
-    }
-
-
-
-    /**
-     * Gets the EE route data from the wp options if it exists already,
-     * otherwise re-generates it and saves it to the option
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoints
-     * @return array
-     */
-    protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
-    {
-        $ee_routes = get_option(self::saved_routes_option_names . $version, null);
-        if ( ! $ee_routes || (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE)) {
-            $ee_routes = self::_save_ee_route_data_for_version($version, $hidden_endpoints);
-        }
-        return $ee_routes;
-    }
-
-
-
-    /**
-     * Saves the EE REST API route data to a wp option and returns it
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoints
-     * @return mixed|null|void
-     */
-    protected static function _save_ee_route_data_for_version($version, $hidden_endpoints = false)
-    {
-        $instance = self::instance();
-        $routes = apply_filters(
-            'EED_Core_Rest_Api__save_ee_route_data_for_version__routes',
-            array_replace_recursive(
-                $instance->_get_config_route_data_for_version($version, $hidden_endpoints),
-                $instance->_get_meta_route_data_for_version($version, $hidden_endpoints),
-                $instance->_get_model_route_data_for_version($version, $hidden_endpoints),
-                $instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
-            )
-        );
-        $option_name = self::saved_routes_option_names . $version;
-        if (get_option($option_name)) {
-            update_option($option_name, $routes, true);
-        } else {
-            add_option($option_name, $routes, null, 'no');
-        }
-        return $routes;
-    }
-
-
-
-    /**
-     * Calculates all the EE routes and saves it to a wordpress option so we don't
-     * need to calculate it on every request
-     *
-     * @deprecated since version 4.9.1
-     * @return void
-     */
-    public static function save_ee_routes()
-    {
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            $instance = self::instance();
-            $routes = apply_filters(
-                'EED_Core_Rest_Api__save_ee_routes__routes',
-                array_replace_recursive(
-                    $instance->_register_config_routes(),
-                    $instance->_register_meta_routes(),
-                    $instance->_register_model_routes(),
-                    $instance->_register_rpc_routes()
-                )
-            );
-            update_option(self::saved_routes_option_names, $routes, true);
-        }
-    }
-
-
-
-    /**
-     * Gets all the route information relating to EE models
-     *
-     * @return array @see get_ee_route_data
-     * @deprecated since version 4.9.1
-     */
-    protected function _register_model_routes()
-    {
-        $model_routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $model_routes[EED_Core_Rest_Api::ee_api_namespace
-                          . $version] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
-        }
-        return $model_routes;
-    }
-
-
-
-    /**
-     * Gets the route data for EE models in the specified version
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     */
-    protected function _get_model_route_data_for_version($version, $hidden_endpoint = false)
-    {
-        $model_version_info = new Model_Version_Info($version);
-        $models_to_register = apply_filters(
-            'FHEE__EED_Core_REST_API___register_model_routes',
-            $model_version_info->models_for_requested_version()
-        );
-        //let's not bother having endpoints for extra metas
-        unset($models_to_register['Extra_Meta']);
-        unset($models_to_register['Extra_Join']);
-        $model_routes = array();
-        foreach ($models_to_register as $model_name => $model_classname) {
-            $model = \EE_Registry::instance()->load_model($model_name);
-
-            //if this isn't a valid model then let's skip iterate to the next item in the loop.
-            if (! $model instanceof EEM_Base) {
-                continue;
-            }
-
-            //yes we could just register one route for ALL models, but then they wouldn't show up in the index
-            $plural_model_route = EEH_Inflector::pluralize_and_lower($model_name);
-            $singular_model_route = $plural_model_route . '/(?P<id>\d+)';
-            $model_routes[$plural_model_route] = array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                        'handle_request_get_all',
-                    ),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'args'            => $this->_get_read_query_params($model, $version),
-                    '_links'          => array(
-                        'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
-                    ),
-                    'schema_callback' => array($model_name, $version)
-                ),
-                //						array(
-                //							'callback' => array(
-                //								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                //								'handle_request_create_one' ),
-                //							'methods' => WP_REST_Server::CREATABLE,
-                //							'hidden_endpoint' => $hidden_endpoint
-                //						)
-            );
-            $model_routes[$singular_model_route] = array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                        'handle_request_get_one',
-                    ),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'args'            => $this->_get_response_selection_query_params($model, $version),
-                ),
-                //						array(
-                //							'callback' => array(
-                //								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                //								'handle_request_edit_one' ),
-                //							'methods' => WP_REST_Server::EDITABLE,
-                //							'hidden_endpoint' => $hidden_endpoint
-                //							),
-            );
-            //@todo: also handle  DELETE for a single item
-            foreach ($model_version_info->relation_settings($model) as $relation_name => $relation_obj) {
-                $related_model_name_endpoint_part = ModelRead::get_related_entity_name(
-                    $relation_name,
-                    $relation_obj
-                );
-                $model_routes[$singular_model_route . '/' . $related_model_name_endpoint_part] = array(
-                    array(
-                        'callback'        => array(
-                            'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                            'handle_request_get_related',
-                        ),
-                        'methods'         => WP_REST_Server::READABLE,
-                        'hidden_endpoint' => $hidden_endpoint,
-                        'args'            => $this->_get_read_query_params($relation_obj->get_other_model(), $version),
-                    ),
-                    //							array(
-                    //								'callback' => array(
-                    //									'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                    //									'handle_request_create_or_update_related' ),
-                    //								'methods' => WP_REST_Server::EDITABLE,
-                    //								'hidden_endpoint' => $hidden_endpoint
-                    //							)
-                );
-                //@todo: handle delete related and possibly remove relation (not sure hwo to distinguish)
-            }
-        }
-        return $model_routes;
-    }
-
-
-
-    /**
-     * Adds all the RPC-style routes (remote procedure call-like routes, ie
-     * routes that don't conform to the traditional REST CRUD-style).
-     *
-     * @deprecated since 4.9.1
-     */
-    protected function _register_rpc_routes()
-    {
-        $routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $routes[self::ee_api_namespace . $version] = $this->_get_rpc_route_data_for_version($version,
-                $hidden_endpoint);
-        }
-        return $routes;
-    }
-
-
-
-    /**
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     */
-    protected function _get_rpc_route_data_for_version($version, $hidden_endpoint = false)
-    {
-        $this_versions_routes = array();
-        //checkin endpoint
-        $this_versions_routes['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)'] = array(
-            array(
-                'callback'        => array(
-                    'EventEspresso\core\libraries\rest_api\controllers\rpc\Checkin',
-                    'handle_request_toggle_checkin',
-                ),
-                'methods'         => WP_REST_Server::CREATABLE,
-                'hidden_endpoint' => $hidden_endpoint,
-                'args'            => array(
-                    'force' => array(
-                        'required'    => false,
-                        'default'     => false,
-                        'description' => __('Whether to force toggle checkin, or to verify the registration status and allowed ticket uses',
-                            'event_espresso'),
-                    ),
-                ),
-            ),
-        );
-        return apply_filters(
-            'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
-            $this_versions_routes,
-            $version,
-            $hidden_endpoint
-        );
-    }
-
-
-
-    /**
-     * Gets the query params that can be used when request one or many
-     *
-     * @param EEM_Base $model
-     * @param string   $version
-     * @return array
-     */
-    protected function _get_response_selection_query_params(\EEM_Base $model, $version)
-    {
-        return apply_filters(
-            'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
-            array(
-                'include'   => array(
-                    'required' => false,
-                    'default'  => '*',
-                ),
-                'calculate' => array(
-                    'required' => false,
-                    'default'  => '',
-                    'enum'     => self::$_field_calculator->retrieve_calculated_fields_for_model($model),
-                ),
-            ),
-            $model,
-            $version
-        );
-    }
-
-
-
-    /**
-     * Gets info about reading query params that are acceptable
-     *
-     * @param \EEM_Base $model eg 'Event' or 'Venue'
-     * @param  string   $version
-     * @return array    describing the args acceptable when querying this model
-     * @throws \EE_Error
-     */
-    protected function _get_read_query_params(\EEM_Base $model, $version)
-    {
-        $default_orderby = array();
-        foreach ($model->get_combined_primary_key_fields() as $key_field) {
-            $default_orderby[$key_field->get_name()] = 'ASC';
-        }
-        return array_merge(
-            $this->_get_response_selection_query_params($model, $version),
-            array(
-                'where'    => array(
-                    'required' => false,
-                    'default'  => array(),
-                ),
-                'limit'    => array(
-                    'required' => false,
-                    'default'  => EED_Core_Rest_Api::get_default_query_limit(),
-                ),
-                'order_by' => array(
-                    'required' => false,
-                    'default'  => $default_orderby,
-                ),
-                'group_by' => array(
-                    'required' => false,
-                    'default'  => null,
-                ),
-                'having'   => array(
-                    'required' => false,
-                    'default'  => null,
-                ),
-                'caps'     => array(
-                    'required' => false,
-                    'default'  => EEM_Base::caps_read,
-                ),
-            )
-        );
-    }
-
-
-
-    /**
-     * Gets routes for the config
-     *
-     * @return array @see _register_model_routes
-     * @deprecated since version 4.9.1
-     */
-    protected function _register_config_routes()
-    {
-        $config_routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $config_routes[self::ee_api_namespace . $version] = $this->_get_config_route_data_for_version($version,
-                $hidden_endpoint);
-        }
-        return $config_routes;
-    }
-
-
-
-    /**
-     * Gets routes for the config for the specified version
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     */
-    protected function _get_config_route_data_for_version($version, $hidden_endpoint)
-    {
-        return array(
-            'config'    => array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\config\Read',
-                        'handle_request',
-                    ),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                ),
-            ),
-            'site_info' => array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\config\Read',
-                        'handle_request_site_info',
-                    ),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                ),
-            ),
-        );
-    }
-
-
-
-    /**
-     * Gets the meta info routes
-     *
-     * @return array @see _register_model_routes
-     * @deprecated since version 4.9.1
-     */
-    protected function _register_meta_routes()
-    {
-        $meta_routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $meta_routes[self::ee_api_namespace . $version] = $this->_get_meta_route_data_for_version($version,
-                $hidden_endpoint);
-        }
-        return $meta_routes;
-    }
-
-
-
-    /**
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     */
-    protected function _get_meta_route_data_for_version($version, $hidden_endpoint = false)
-    {
-        return array(
-            'resources' => array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Meta',
-                        'handle_request_models_meta',
-                    ),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                ),
-            ),
-        );
-    }
-
-
-
-    /**
-     * Tries to hide old 4.6 endpoints from the
-     *
-     * @param array $route_data
-     * @return array
-     */
-    public static function hide_old_endpoints($route_data)
-    {
-        //allow API clients to override which endpoints get hidden, in case
-        //they want to discover particular endpoints
-        //also, we don't have access to the request so we have to just grab it from the superglobal
-        $force_show_ee_namespace = ltrim(
-            EEH_Array::is_set($_REQUEST, 'force_show_ee_namespace', ''),
-            '/'
-        );
-        foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
-            foreach ($relative_urls as $endpoint => $routes) {
-                foreach ($routes as $route) {
-                    //by default, hide "hidden_endpoint"s, unless the request indicates
-                    //to $force_show_ee_namespace, in which case only show that one
-                    //namespace's endpoints (and hide all others)
-                    if (($route['hidden_endpoint'] && $force_show_ee_namespace === '')
-                        || ($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace)
-                    ) {
-                        $full_route = '/' . ltrim($namespace, '/') . '/' . ltrim($endpoint, '/');
-                        unset($route_data[$full_route]);
-                    }
-                }
-            }
-        }
-        return $route_data;
-    }
-
-
-
-    /**
-     * Returns an array describing which versions of core support serving requests for.
-     * Keys are core versions' major and minor version, and values are the
-     * LOWEST requested version they can serve. Eg, 4.7 can serve requests for 4.6-like
-     * data by just removing a few models and fields from the responses. However, 4.15 might remove
-     * the answers table entirely, in which case it would be very difficult for
-     * it to serve 4.6-style responses.
-     * Versions of core that are missing from this array are unknowns.
-     * previous ver
-     *
-     * @return array
-     */
-    public static function version_compatibilities()
-    {
-        return apply_filters(
-            'FHEE__EED_Core_REST_API__version_compatibilities',
-            array(
-                '4.8.29' => '4.8.29',
-                '4.8.33' => '4.8.29',
-                '4.8.34' => '4.8.29',
-                '4.8.36' => '4.8.29',
-            )
-        );
-    }
-
-
-
-    /**
-     * Gets the latest API version served. Eg if there
-     * are two versions served of the API, 4.8.29 and 4.8.32, and
-     * we are on core version 4.8.34, it will return the string "4.8.32"
-     *
-     * @return string
-     */
-    public static function latest_rest_api_version()
-    {
-        $versions_served = \EED_Core_Rest_Api::versions_served();
-        $versions_served_keys = array_keys($versions_served);
-        return end($versions_served_keys);
-    }
-
-
-
-    /**
-     * Using EED_Core_Rest_Api::version_compatibilities(), determines what version of
-     * EE the API can serve requests for. Eg, if we are on 4.15 of core, and
-     * we can serve requests from 4.12 or later, this will return array( '4.12', '4.13', '4.14', '4.15' ).
-     * We also indicate whether or not this version should be put in the index or not
-     *
-     * @return array keys are API version numbers (just major and minor numbers), and values
-     * are whether or not they should be hidden
-     */
-    public static function versions_served()
-    {
-        $versions_served = array();
-        $possibly_served_versions = EED_Core_Rest_Api::version_compatibilities();
-        $lowest_compatible_version = end($possibly_served_versions);
-        reset($possibly_served_versions);
-        $versions_served_historically = array_keys($possibly_served_versions);
-        $latest_version = end($versions_served_historically);
-        reset($versions_served_historically);
-        //for each version of core we have ever served:
-        foreach ($versions_served_historically as $key_versioned_endpoint) {
-            //if it's not above the current core version, and it's compatible with the current version of core
-            if ($key_versioned_endpoint == $latest_version) {
-                //don't hide the latest version in the index
-                $versions_served[$key_versioned_endpoint] = false;
-            } else if (
-                $key_versioned_endpoint < EED_Core_Rest_Api::core_version()
-                && $key_versioned_endpoint >= $lowest_compatible_version
-            ) {
-                //include, but hide, previous versions which are still supported
-                $versions_served[$key_versioned_endpoint] = true;
-            } elseif (
-            apply_filters(
-                'FHEE__EED_Core_Rest_Api__versions_served__include_incompatible_versions',
-                false,
-                $possibly_served_versions
-            )
-            ) {
-                //if a version is no longer supported, don't include it in index or list of versions served
-                $versions_served[$key_versioned_endpoint] = true;
-            }
-        }
-        return $versions_served;
-    }
-
-
-
-    /**
-     * Gets the major and minor version of EE core's version string
-     *
-     * @return string
-     */
-    public static function core_version()
-    {
-        return apply_filters('FHEE__EED_Core_REST_API__core_version',
-            implode('.', array_slice(explode('.', espresso_version()), 0, 3)));
-    }
-
-
-
-    /**
-     * Gets the default limit that should be used when querying for resources
-     *
-     * @return int
-     */
-    public static function get_default_query_limit()
-    {
-        //we actually don't use a const because we want folks to always use
-        //this method, not the const directly
-        return apply_filters(
-            'FHEE__EED_Core_Rest_Api__get_default_query_limit',
-            50
-        );
-    }
-
-
-
-    /**
-     *    run - initial module setup
-     *
-     * @access    public
-     * @param  WP $WP
-     * @return    void
-     */
-    public function run($WP)
-    {
-    }
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		self::set_hooks_both();
+	}
+
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		self::set_hooks_both();
+	}
+
+
+
+	public static function set_hooks_both()
+	{
+		add_action('rest_api_init', array('EED_Core_Rest_Api', 'register_routes'), 10);
+		add_action('rest_api_init', array('EED_Core_Rest_Api', 'set_hooks_rest_api'), 5);
+		add_filter('rest_route_data', array('EED_Core_Rest_Api', 'hide_old_endpoints'), 10, 2);
+		add_filter('rest_index',
+			array('EventEspresso\core\libraries\rest_api\controllers\model\Meta', 'filter_ee_metadata_into_index'));
+		EED_Core_Rest_Api::invalidate_cached_route_data_on_version_change();
+	}
+
+
+
+	/**
+	 * sets up hooks which only need to be included as part of REST API requests;
+	 * other requests like to the frontend or admin etc don't need them
+	 */
+	public static function set_hooks_rest_api()
+	{
+		//set hooks which account for changes made to the API
+		EED_Core_Rest_Api::_set_hooks_for_changes();
+	}
+
+
+
+	/**
+	 * public wrapper of _set_hooks_for_changes.
+	 * Loads all the hooks which make requests to old versions of the API
+	 * appear the same as they always did
+	 */
+	public static function set_hooks_for_changes()
+	{
+		self::_set_hooks_for_changes();
+	}
+
+
+
+
+
+
+
+	/**
+	 * Loads all the hooks which make requests to old versions of the API
+	 * appear the same as they always did
+	 */
+	protected static function _set_hooks_for_changes()
+	{
+		$folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES . 'rest_api' . DS . 'changes'), false);
+		foreach ($folder_contents as $classname_in_namespace => $filepath) {
+			//ignore the base parent class
+			if ($classname_in_namespace === 'Changes_In_Base') {
+				continue;
+			}
+			$full_classname = 'EventEspresso\core\libraries\rest_api\changes\\' . $classname_in_namespace;
+			if (class_exists($full_classname)) {
+				$instance_of_class = new $full_classname;
+				if ($instance_of_class instanceof Changes_In_Base) {
+					$instance_of_class->set_hooks();
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * Filters the WP routes to add our EE-related ones. This takes a bit of time
+	 * so we actually prefer to only do it when an EE plugin is activated or upgraded
+	 */
+	public static function register_routes()
+	{
+		foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
+			foreach ($relative_urls as $endpoint => $routes) {
+				foreach ($routes as $route) {
+					$route_args = array(
+						array(
+							'callback' => $route['callback'],
+							'methods'  => $route['methods'],
+							'args'     => isset($route['args']) ? $route['args'] : array(),
+						)
+					);
+					if (isset($route['schema_callback'])) {
+						$model_name = isset($route['schema_callback'][0])
+							? $route['schema_callback'][0]
+							: '';
+						$version = isset( $route['schema_callback'][1])
+							? $route['schema_callback'][1]
+							: '';
+						if (! empty($model_name) && ! empty($version)) {
+							$route_args['schema'] = function () use ($model_name, $version) {
+								return ModelRead::handle_schema_request(
+									$model_name,
+									$version
+								);
+							};
+						}
+					}
+					register_rest_route(
+						$namespace,
+						$endpoint,
+						$route_args
+					);
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * Checks if there was a version change or something that merits invalidating the cached
+	 * route data. If so, invalidates the cached route data so that it gets refreshed
+	 * next time the WP API is used
+	 */
+	public static function invalidate_cached_route_data_on_version_change()
+	{
+		if (EE_System::instance()->detect_req_type() != EE_System::req_type_normal) {
+			EED_Core_Rest_Api::invalidate_cached_route_data();
+		}
+		foreach (EE_Registry::instance()->addons as $addon) {
+			if ($addon instanceof EE_Addon && $addon->detect_req_type() != EE_System::req_type_normal) {
+				EED_Core_Rest_Api::invalidate_cached_route_data();
+			}
+		}
+	}
+
+
+
+	/**
+	 * Removes the cached route data so it will get refreshed next time the WP API is used
+	 */
+	public static function invalidate_cached_route_data()
+	{
+		//delete the saved EE REST API routes
+		foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden) {
+			delete_option(EED_Core_Rest_Api::saved_routes_option_names . $version);
+		}
+	}
+
+
+
+	/**
+	 * Gets the EE route data
+	 *
+	 * @return array top-level key is the namespace, next-level key is the route and its value is array{
+	 * @type string|array $callback
+	 * @type string       $methods
+	 * @type boolean      $hidden_endpoint
+	 * }
+	 */
+	public static function get_ee_route_data()
+	{
+		$ee_routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoints) {
+			$ee_routes[self::ee_api_namespace . $version] = self::_get_ee_route_data_for_version($version,
+				$hidden_endpoints);
+		}
+		return $ee_routes;
+	}
+
+
+
+	/**
+	 * Gets the EE route data from the wp options if it exists already,
+	 * otherwise re-generates it and saves it to the option
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoints
+	 * @return array
+	 */
+	protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
+	{
+		$ee_routes = get_option(self::saved_routes_option_names . $version, null);
+		if ( ! $ee_routes || (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE)) {
+			$ee_routes = self::_save_ee_route_data_for_version($version, $hidden_endpoints);
+		}
+		return $ee_routes;
+	}
+
+
+
+	/**
+	 * Saves the EE REST API route data to a wp option and returns it
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoints
+	 * @return mixed|null|void
+	 */
+	protected static function _save_ee_route_data_for_version($version, $hidden_endpoints = false)
+	{
+		$instance = self::instance();
+		$routes = apply_filters(
+			'EED_Core_Rest_Api__save_ee_route_data_for_version__routes',
+			array_replace_recursive(
+				$instance->_get_config_route_data_for_version($version, $hidden_endpoints),
+				$instance->_get_meta_route_data_for_version($version, $hidden_endpoints),
+				$instance->_get_model_route_data_for_version($version, $hidden_endpoints),
+				$instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
+			)
+		);
+		$option_name = self::saved_routes_option_names . $version;
+		if (get_option($option_name)) {
+			update_option($option_name, $routes, true);
+		} else {
+			add_option($option_name, $routes, null, 'no');
+		}
+		return $routes;
+	}
+
+
+
+	/**
+	 * Calculates all the EE routes and saves it to a wordpress option so we don't
+	 * need to calculate it on every request
+	 *
+	 * @deprecated since version 4.9.1
+	 * @return void
+	 */
+	public static function save_ee_routes()
+	{
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			$instance = self::instance();
+			$routes = apply_filters(
+				'EED_Core_Rest_Api__save_ee_routes__routes',
+				array_replace_recursive(
+					$instance->_register_config_routes(),
+					$instance->_register_meta_routes(),
+					$instance->_register_model_routes(),
+					$instance->_register_rpc_routes()
+				)
+			);
+			update_option(self::saved_routes_option_names, $routes, true);
+		}
+	}
+
+
+
+	/**
+	 * Gets all the route information relating to EE models
+	 *
+	 * @return array @see get_ee_route_data
+	 * @deprecated since version 4.9.1
+	 */
+	protected function _register_model_routes()
+	{
+		$model_routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$model_routes[EED_Core_Rest_Api::ee_api_namespace
+						  . $version] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
+		}
+		return $model_routes;
+	}
+
+
+
+	/**
+	 * Gets the route data for EE models in the specified version
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 */
+	protected function _get_model_route_data_for_version($version, $hidden_endpoint = false)
+	{
+		$model_version_info = new Model_Version_Info($version);
+		$models_to_register = apply_filters(
+			'FHEE__EED_Core_REST_API___register_model_routes',
+			$model_version_info->models_for_requested_version()
+		);
+		//let's not bother having endpoints for extra metas
+		unset($models_to_register['Extra_Meta']);
+		unset($models_to_register['Extra_Join']);
+		$model_routes = array();
+		foreach ($models_to_register as $model_name => $model_classname) {
+			$model = \EE_Registry::instance()->load_model($model_name);
+
+			//if this isn't a valid model then let's skip iterate to the next item in the loop.
+			if (! $model instanceof EEM_Base) {
+				continue;
+			}
+
+			//yes we could just register one route for ALL models, but then they wouldn't show up in the index
+			$plural_model_route = EEH_Inflector::pluralize_and_lower($model_name);
+			$singular_model_route = $plural_model_route . '/(?P<id>\d+)';
+			$model_routes[$plural_model_route] = array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+						'handle_request_get_all',
+					),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'args'            => $this->_get_read_query_params($model, $version),
+					'_links'          => array(
+						'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
+					),
+					'schema_callback' => array($model_name, $version)
+				),
+				//						array(
+				//							'callback' => array(
+				//								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+				//								'handle_request_create_one' ),
+				//							'methods' => WP_REST_Server::CREATABLE,
+				//							'hidden_endpoint' => $hidden_endpoint
+				//						)
+			);
+			$model_routes[$singular_model_route] = array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+						'handle_request_get_one',
+					),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'args'            => $this->_get_response_selection_query_params($model, $version),
+				),
+				//						array(
+				//							'callback' => array(
+				//								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+				//								'handle_request_edit_one' ),
+				//							'methods' => WP_REST_Server::EDITABLE,
+				//							'hidden_endpoint' => $hidden_endpoint
+				//							),
+			);
+			//@todo: also handle  DELETE for a single item
+			foreach ($model_version_info->relation_settings($model) as $relation_name => $relation_obj) {
+				$related_model_name_endpoint_part = ModelRead::get_related_entity_name(
+					$relation_name,
+					$relation_obj
+				);
+				$model_routes[$singular_model_route . '/' . $related_model_name_endpoint_part] = array(
+					array(
+						'callback'        => array(
+							'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+							'handle_request_get_related',
+						),
+						'methods'         => WP_REST_Server::READABLE,
+						'hidden_endpoint' => $hidden_endpoint,
+						'args'            => $this->_get_read_query_params($relation_obj->get_other_model(), $version),
+					),
+					//							array(
+					//								'callback' => array(
+					//									'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+					//									'handle_request_create_or_update_related' ),
+					//								'methods' => WP_REST_Server::EDITABLE,
+					//								'hidden_endpoint' => $hidden_endpoint
+					//							)
+				);
+				//@todo: handle delete related and possibly remove relation (not sure hwo to distinguish)
+			}
+		}
+		return $model_routes;
+	}
+
+
+
+	/**
+	 * Adds all the RPC-style routes (remote procedure call-like routes, ie
+	 * routes that don't conform to the traditional REST CRUD-style).
+	 *
+	 * @deprecated since 4.9.1
+	 */
+	protected function _register_rpc_routes()
+	{
+		$routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$routes[self::ee_api_namespace . $version] = $this->_get_rpc_route_data_for_version($version,
+				$hidden_endpoint);
+		}
+		return $routes;
+	}
+
+
+
+	/**
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 */
+	protected function _get_rpc_route_data_for_version($version, $hidden_endpoint = false)
+	{
+		$this_versions_routes = array();
+		//checkin endpoint
+		$this_versions_routes['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)'] = array(
+			array(
+				'callback'        => array(
+					'EventEspresso\core\libraries\rest_api\controllers\rpc\Checkin',
+					'handle_request_toggle_checkin',
+				),
+				'methods'         => WP_REST_Server::CREATABLE,
+				'hidden_endpoint' => $hidden_endpoint,
+				'args'            => array(
+					'force' => array(
+						'required'    => false,
+						'default'     => false,
+						'description' => __('Whether to force toggle checkin, or to verify the registration status and allowed ticket uses',
+							'event_espresso'),
+					),
+				),
+			),
+		);
+		return apply_filters(
+			'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
+			$this_versions_routes,
+			$version,
+			$hidden_endpoint
+		);
+	}
+
+
+
+	/**
+	 * Gets the query params that can be used when request one or many
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $version
+	 * @return array
+	 */
+	protected function _get_response_selection_query_params(\EEM_Base $model, $version)
+	{
+		return apply_filters(
+			'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
+			array(
+				'include'   => array(
+					'required' => false,
+					'default'  => '*',
+				),
+				'calculate' => array(
+					'required' => false,
+					'default'  => '',
+					'enum'     => self::$_field_calculator->retrieve_calculated_fields_for_model($model),
+				),
+			),
+			$model,
+			$version
+		);
+	}
+
+
+
+	/**
+	 * Gets info about reading query params that are acceptable
+	 *
+	 * @param \EEM_Base $model eg 'Event' or 'Venue'
+	 * @param  string   $version
+	 * @return array    describing the args acceptable when querying this model
+	 * @throws \EE_Error
+	 */
+	protected function _get_read_query_params(\EEM_Base $model, $version)
+	{
+		$default_orderby = array();
+		foreach ($model->get_combined_primary_key_fields() as $key_field) {
+			$default_orderby[$key_field->get_name()] = 'ASC';
+		}
+		return array_merge(
+			$this->_get_response_selection_query_params($model, $version),
+			array(
+				'where'    => array(
+					'required' => false,
+					'default'  => array(),
+				),
+				'limit'    => array(
+					'required' => false,
+					'default'  => EED_Core_Rest_Api::get_default_query_limit(),
+				),
+				'order_by' => array(
+					'required' => false,
+					'default'  => $default_orderby,
+				),
+				'group_by' => array(
+					'required' => false,
+					'default'  => null,
+				),
+				'having'   => array(
+					'required' => false,
+					'default'  => null,
+				),
+				'caps'     => array(
+					'required' => false,
+					'default'  => EEM_Base::caps_read,
+				),
+			)
+		);
+	}
+
+
+
+	/**
+	 * Gets routes for the config
+	 *
+	 * @return array @see _register_model_routes
+	 * @deprecated since version 4.9.1
+	 */
+	protected function _register_config_routes()
+	{
+		$config_routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$config_routes[self::ee_api_namespace . $version] = $this->_get_config_route_data_for_version($version,
+				$hidden_endpoint);
+		}
+		return $config_routes;
+	}
+
+
+
+	/**
+	 * Gets routes for the config for the specified version
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 */
+	protected function _get_config_route_data_for_version($version, $hidden_endpoint)
+	{
+		return array(
+			'config'    => array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\config\Read',
+						'handle_request',
+					),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+				),
+			),
+			'site_info' => array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\config\Read',
+						'handle_request_site_info',
+					),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+				),
+			),
+		);
+	}
+
+
+
+	/**
+	 * Gets the meta info routes
+	 *
+	 * @return array @see _register_model_routes
+	 * @deprecated since version 4.9.1
+	 */
+	protected function _register_meta_routes()
+	{
+		$meta_routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$meta_routes[self::ee_api_namespace . $version] = $this->_get_meta_route_data_for_version($version,
+				$hidden_endpoint);
+		}
+		return $meta_routes;
+	}
+
+
+
+	/**
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 */
+	protected function _get_meta_route_data_for_version($version, $hidden_endpoint = false)
+	{
+		return array(
+			'resources' => array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\model\Meta',
+						'handle_request_models_meta',
+					),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+				),
+			),
+		);
+	}
+
+
+
+	/**
+	 * Tries to hide old 4.6 endpoints from the
+	 *
+	 * @param array $route_data
+	 * @return array
+	 */
+	public static function hide_old_endpoints($route_data)
+	{
+		//allow API clients to override which endpoints get hidden, in case
+		//they want to discover particular endpoints
+		//also, we don't have access to the request so we have to just grab it from the superglobal
+		$force_show_ee_namespace = ltrim(
+			EEH_Array::is_set($_REQUEST, 'force_show_ee_namespace', ''),
+			'/'
+		);
+		foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
+			foreach ($relative_urls as $endpoint => $routes) {
+				foreach ($routes as $route) {
+					//by default, hide "hidden_endpoint"s, unless the request indicates
+					//to $force_show_ee_namespace, in which case only show that one
+					//namespace's endpoints (and hide all others)
+					if (($route['hidden_endpoint'] && $force_show_ee_namespace === '')
+						|| ($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace)
+					) {
+						$full_route = '/' . ltrim($namespace, '/') . '/' . ltrim($endpoint, '/');
+						unset($route_data[$full_route]);
+					}
+				}
+			}
+		}
+		return $route_data;
+	}
+
+
+
+	/**
+	 * Returns an array describing which versions of core support serving requests for.
+	 * Keys are core versions' major and minor version, and values are the
+	 * LOWEST requested version they can serve. Eg, 4.7 can serve requests for 4.6-like
+	 * data by just removing a few models and fields from the responses. However, 4.15 might remove
+	 * the answers table entirely, in which case it would be very difficult for
+	 * it to serve 4.6-style responses.
+	 * Versions of core that are missing from this array are unknowns.
+	 * previous ver
+	 *
+	 * @return array
+	 */
+	public static function version_compatibilities()
+	{
+		return apply_filters(
+			'FHEE__EED_Core_REST_API__version_compatibilities',
+			array(
+				'4.8.29' => '4.8.29',
+				'4.8.33' => '4.8.29',
+				'4.8.34' => '4.8.29',
+				'4.8.36' => '4.8.29',
+			)
+		);
+	}
+
+
+
+	/**
+	 * Gets the latest API version served. Eg if there
+	 * are two versions served of the API, 4.8.29 and 4.8.32, and
+	 * we are on core version 4.8.34, it will return the string "4.8.32"
+	 *
+	 * @return string
+	 */
+	public static function latest_rest_api_version()
+	{
+		$versions_served = \EED_Core_Rest_Api::versions_served();
+		$versions_served_keys = array_keys($versions_served);
+		return end($versions_served_keys);
+	}
+
+
+
+	/**
+	 * Using EED_Core_Rest_Api::version_compatibilities(), determines what version of
+	 * EE the API can serve requests for. Eg, if we are on 4.15 of core, and
+	 * we can serve requests from 4.12 or later, this will return array( '4.12', '4.13', '4.14', '4.15' ).
+	 * We also indicate whether or not this version should be put in the index or not
+	 *
+	 * @return array keys are API version numbers (just major and minor numbers), and values
+	 * are whether or not they should be hidden
+	 */
+	public static function versions_served()
+	{
+		$versions_served = array();
+		$possibly_served_versions = EED_Core_Rest_Api::version_compatibilities();
+		$lowest_compatible_version = end($possibly_served_versions);
+		reset($possibly_served_versions);
+		$versions_served_historically = array_keys($possibly_served_versions);
+		$latest_version = end($versions_served_historically);
+		reset($versions_served_historically);
+		//for each version of core we have ever served:
+		foreach ($versions_served_historically as $key_versioned_endpoint) {
+			//if it's not above the current core version, and it's compatible with the current version of core
+			if ($key_versioned_endpoint == $latest_version) {
+				//don't hide the latest version in the index
+				$versions_served[$key_versioned_endpoint] = false;
+			} else if (
+				$key_versioned_endpoint < EED_Core_Rest_Api::core_version()
+				&& $key_versioned_endpoint >= $lowest_compatible_version
+			) {
+				//include, but hide, previous versions which are still supported
+				$versions_served[$key_versioned_endpoint] = true;
+			} elseif (
+			apply_filters(
+				'FHEE__EED_Core_Rest_Api__versions_served__include_incompatible_versions',
+				false,
+				$possibly_served_versions
+			)
+			) {
+				//if a version is no longer supported, don't include it in index or list of versions served
+				$versions_served[$key_versioned_endpoint] = true;
+			}
+		}
+		return $versions_served;
+	}
+
+
+
+	/**
+	 * Gets the major and minor version of EE core's version string
+	 *
+	 * @return string
+	 */
+	public static function core_version()
+	{
+		return apply_filters('FHEE__EED_Core_REST_API__core_version',
+			implode('.', array_slice(explode('.', espresso_version()), 0, 3)));
+	}
+
+
+
+	/**
+	 * Gets the default limit that should be used when querying for resources
+	 *
+	 * @return int
+	 */
+	public static function get_default_query_limit()
+	{
+		//we actually don't use a const because we want folks to always use
+		//this method, not the const directly
+		return apply_filters(
+			'FHEE__EED_Core_Rest_Api__get_default_query_limit',
+			50
+		);
+	}
+
+
+
+	/**
+	 *    run - initial module setup
+	 *
+	 * @access    public
+	 * @param  WP $WP
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+	}
 }
 
 // End of file EED_Core_Rest_Api.module.php

core/libraries/form_sections/inputs/EE_Datepicker_Input.php

Spacing +11 added lines, -11 removed lines

@@ -6,21 +6,21 @@ 
  * @subpackage
  * @author				Mike Nelson
  */
-class EE_Datepicker_Input extends EE_Form_Input_Base{
+class EE_Datepicker_Input extends EE_Form_Input_Base {
 
 	/**
 	 * @param array $input_settings
 	 */
-	function __construct( $input_settings = array() ){
-		$this->_set_display_strategy( new EE_Text_Input_Display_Strategy( 'datepicker' ) );
-		$this->_set_normalization_strategy( new EE_Text_Normalization() );
+	function __construct($input_settings = array()) {
+		$this->_set_display_strategy(new EE_Text_Input_Display_Strategy('datepicker'));
+		$this->_set_normalization_strategy(new EE_Text_Normalization());
 		//we could do better for validation, but at least verify its plaintext
-		$this->_add_validation_strategy( new EE_Plaintext_Validation_Strategy( isset( $input_settings[ 'validation_error_message' ] ) ? $input_settings[ 'validation_error_message' ] : NULL ) );
-		parent::__construct( $input_settings );
-		$this->set_html_class( $this->html_class() . ' datepicker' );
+		$this->_add_validation_strategy(new EE_Plaintext_Validation_Strategy(isset($input_settings['validation_error_message']) ? $input_settings['validation_error_message'] : NULL));
+		parent::__construct($input_settings);
+		$this->set_html_class($this->html_class().' datepicker');
 		// add some style and make it dance
-		add_action( 'wp_enqueue_scripts', array( 'EE_Datepicker_Input', 'enqueue_styles_and_scripts' ));
-		add_action( 'admin_enqueue_scripts', array( 'EE_Datepicker_Input', 'enqueue_styles_and_scripts' ));
+		add_action('wp_enqueue_scripts', array('EE_Datepicker_Input', 'enqueue_styles_and_scripts'));
+		add_action('admin_enqueue_scripts', array('EE_Datepicker_Input', 'enqueue_styles_and_scripts'));
 	}
 
 
@@ -33,8 +33,8 @@ 
 	 */
 	public static function enqueue_styles_and_scripts() {
 		// load css
-		wp_register_style( 'espresso-ui-theme', EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css', array(), EVENT_ESPRESSO_VERSION );
-		wp_enqueue_style( 'espresso-ui-theme');
+		wp_register_style('espresso-ui-theme', EE_GLOBAL_ASSETS_URL.'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css', array(), EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('espresso-ui-theme');
 	}