eventespresso / event-espresso-core

core/libraries/messages/EE_message_type.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -832,7 +832,7 @@
      * Takes care of setting up the addressee object(s) for the primary attendee.
      *
      * @access protected
-     * @return array of EE_Addressee objects
+     * @return EE_Messages_Addressee[] of EE_Addressee objects
      * @throws EE_Error
      */
     protected function _primary_attendee_addressees()

Indentation +903 added lines, -903 removed lines

@@ -20,914 +20,914 @@
 {
 
 
-    /**
-     * message type child classes will set what contexts are associated with the message type via this array.
-     * format:
-     * array(
-     * 'context' => array(
-     *        'label' => __('Context Label', 'event_espresso'),
-     *        'description' => __('Context description (for help popups)', 'event_espresso')
-     *    ));
-     *
-     * @var array
-     */
-    protected $_contexts = array();
-
-
-    /**
-     * This property is used to define what the display label will be for contexts (eg. "Recipients", "Themes" etc.)
-     * Format:
-     * array( 'label' => 'something', 'plural' => 'somethings', 'description' => 'something' );
-     *
-     * @var array
-     */
-    protected $_context_label;
-
-
-    /** MESSAGE ASSEMBLING PROPERTIES **/
-    /**
-     * This parameter simply holds all the message objects for retrieval by the controller and sending to the messenger.
-     *
-     * @var array of message objects.
-     */
-    public $messages = array();
-
-    /**
-     * The following holds the templates that will be used to assemble the message object for the messenger.
-     *
-     * @var array
-     */
-    protected $_templates;
-
-
-    /**
-     * If a specific template is being parsed, this will hold the message template group GRP_ID for that template.
-     *
-     * @var int.
-     */
-    protected $_GRP_ID;
-
-
-    /** OTHER INFO PROPERTIES **/
-    /**
-     * This will hold the count of the message objects in the messages array. This could be used for determining if
-     * batching/queueing is needed.
-     *
-     * @var int
-     */
-    public $count = 0;
-
-
-    /**
-     * This is set via the `do_messenger_hooks` method and contains the messenger being used to send the message of
-     * this message type at time of sending.
-     *
-     * @var EE_messenger
-     */
-    protected $_active_messenger;
-
-
-    /**
-     * This will hold the shortcode_replace instance for handling replacement of shortcodes in the various templates
-     *
-     * @var object
-     */
-    protected $_shortcode_replace;
-
-
-    /**
-     * The purpose for this property is to simply allow message types to indicate if the message generated is intended
-     * for only single context.  Child message types should redefine this variable (if necessary) in the
-     * _set_data_Handler() method.
-     *
-     * @var boolean
-     */
-    protected $_single_message = false;
-
-
-    /**
-     * This will hold an array of specific reg_ids that are receiving messages.
-     *
-     * @since 4.7.x
-     * @var array
-     */
-    protected $_regs_for_sending = array();
-
-
-    /**
-     * This holds the data passed to this class from the controller and also the final processed data.
-     *
-     * @var object
-     */
-    protected $_data;
-
-
-    /**
-     * this is just a flag indicating whether we're in preview mode or not.
-     *
-     * @var bool
-     */
-    protected $_preview = false;
-
-
-    /**
-     * This just holds defaults for addressee data that children merge with their data array setup
-     *
-     * @var array
-     */
-    protected $_default_addressee_data;
-
-
-    /**
-     * Child classes declare through this property what handler they want to use for the incoming data and this string
-     * is used to instantiate the EE_Messages_incoming_data child class for that handler.
-     *
-     * @var string
-     */
-    protected $_data_handler;
-
-
-    /**
-     * This holds any specific fields for holding any settings related to a message type (if any needed)
-     *
-     * @var array
-     */
-    protected $_admin_settings_fields = array();
-
-    /**
-     * this property will hold any existing setting that may have been set in the admin.
-     *
-     * @var array
-     */
-    protected $_existing_admin_settings = array();
-
-
-    /**
-     * This is used to designate the generating and alternative sending messengers for a message type.  It is set via
-     * set_with_messengers() on construct. Note, generating messenger also acts as a sending messenger for this message
-     * type.  However ONLY the generating messengers are used for creating templates for this message type. Should be
-     * in this format:
-     * {
-     *
-     * @type string $generating_messenger the name of the generating messenger.  Generating
-     *                                          messengers are used for generating templates,
-     *                                          doing validation and defining valid shortcodes.
-     *      {
-     * @type string $sending_messenger    values are the name(s) for the sending
-     *                                              messengers.  sending messengers are
-     *                                              just valid delivery vehicles that will utilize
-     *                                              the templates (and generated EE_message
-     *                                              objects from the generating messengers).
-     *      }
-     * }
-     * @since                             4.5.0
-     * @var array
-     */
-    protected $_with_messengers = array();
-
-
-    /**
-     * This holds the addressees in an array indexed by context for later retrieval when assembling the message objects.
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_addressees = array();
-
-
-    /**
-     * This allows each message type to set what alternate messenger&message type combination can be used for fallback
-     * default templates if there are no specific ones defined for this messenger and message type.  Should be in the
-     * format:
-     * array(
-     *      'messenger' => 'message_type',
-     *      'another_messenger' => another_message_type
-     * );
-     * This is set in the message type constructor.
-     *
-     * @var array
-     */
-    protected $_master_templates = array();
-
-
-    /**
-     * This holds whatever the set template pack is for a message template group when generating messages.
-     *
-     * @since 4.5.0
-     * @var EE_Messages_Template_Pack
-     */
-    protected $_template_pack;
-
-
-    /**
-     * This holds whatever the set variation is for a message template group when generating messages.
-     *
-     * @since 4.5.0
-     * @var string
-     */
-    protected $_variation;
-
-
-    /**
-     * EE_message_type constructor.
-     */
-    public function __construct()
-    {
-        $this->_messages_item_type = 'message_type';
-        $this->_set_contexts();
-        $this->_set_with_messengers();
-        parent::__construct();
-    }
-
-
-    /**
-     * This sets the data handler for the message type.  It must be used to define the _data_handler property.  It is
-     * called when messages are setup.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_data_handler();
-
-
-    /**
-     * This method should return a EE_Base_Class object (or array of EE_Base_Class objects) for the given context and
-     * ID (which should be the primary key id for the base class).  Client code doesn't have to know what a message
-     * type's data handler is.
-     *
-     * @since 4.5.0
-     * @param string          $context      This should be a string matching a valid context for the message type.
-     * @param EE_Registration $registration Need a registration to ensure that the data is valid (prevents people
-     *                                      guessing a url).
-     * @param int             $id           Optional. Integer corresponding to the value for the primary key of a
-     *                                      EE_Base_Class_Object
-     * @return mixed ( EE_Base_Class||EE_Base_Class[] )
-     */
-    abstract protected function _get_data_for_context($context, EE_Registration $registration, $id);
-
-
-    /**
-     * _set_contexts
-     * This sets up the contexts associated with the message_type
-     *
-     * @abstract
-     * @access  protected
-     * @return  void
-     */
-    abstract protected function _set_contexts();
-
-
-    /**
-     * This is used to get the "id" value fo the msg_trigger_url generated by get_url_trigger().
-     * In most cases, child classes don't need anything, (hence the default of 0), however if there is a specific
-     * EE_Base_Class that is required in generating a message for a message type recipient then the message
-     * type should override this method and use the given params to generate the correct ID.
-     *
-     * @param string          $context      The message type context.
-     * @param EE_Registration $registration Registration object
-     * @deprecated 4.9.0
-     * @return int
-     */
-    protected function _get_id_for_msg_url($context, EE_Registration $registration)
-    {
-        return 0;
-    }
-
-
-    /**
-     * This sets up any action/filter hooks this message type puts in place for a specific messenger.  Note that by
-     * default this does nothing.  Child classes will need to override if they want to add specific hooks for a
-     * messenger.
-     *
-     * @since 1.0.0
-     * @return void
-     */
-    protected function _do_messenger_hooks()
-    {
-        return;
-    }
-
-
-    /**
-     * This is a public wrapper for the protected _do_messenger_hooks() method.
-     * For backward compat reasons, this was done rather than making the protected method public.
-     *
-     * @param   EE_messenger $messenger This is used to set the $_active_messenger property, so message types are able
-     *                                  to know what messenger is being used to send the message at the time of
-     *                                  sending.
-     * @since 4.9.0
-     */
-    public function do_messenger_hooks($messenger = null)
-    {
-        $this->_active_messenger = $messenger;
-        $this->_do_messenger_hooks();
-    }
-
-
-    /**
-     * This method returns whether this message type should always generate a new copy
-     * when requested, or if links can be to the already generated copy.
-     * Note: this does NOT affect viewing/resending already generated messages in the EE_Message list table.
-     * Child classes should override this if different from the default of false.
-     *
-     * @return bool     false means can link to generated EE_Message.  true must regenerate.
-     */
-    public function always_generate()
-    {
-        return false;
-    }
-
-
-    /**
-     * Returns the priority for the message type.
-     * Priorities are defined as constants on EEM_Message.  Currently there are three priorities:
-     * - EEM_Message::priority_high
-     * - EEM_Message::priority_medium
-     * - EEM_Message::priority_low
-     * Priority is used to determine the weight the message type is given when queuing for generation and/or sending.
-     *
-     * @see    EEM_Message for more phpdocs on priority.
-     *         The default priority for all message_types is EEM_Message::priority_low.  Message Types wanting to give
-     *         a higher priority must override this method. Also note, messengers are able to override priorities
-     *         queuing instructions if their "send_now" flag is set to true. An example of this is the HTML messenger
-     *         which displays things in the browser.
-     * @since  4.9.0
-     * @return int
-     */
-    public function get_priority()
-    {
-        return EEM_Message::priority_low;
-    }
-
-
-    /**
-     * This runs the _set_data_handler() method for message types and then returns what got set.
-     *
-     * @param mixed $data This sets the data property for the message type with the incoming data used for generating.
-     * @return string (the reference for the data handler) (will be an empty string if could not be determined).
-     */
-    public function get_data_handler($data)
-    {
-        $this->_data = $data;
-        $this->_set_data_handler();
-        return apply_filters('FHEE__EE_message_type__get_data_handler', $this->_data_handler, $this);
-    }
-
-
-    /**
-     * This is called externally to reset the value of the $_data property for the message type.
-     * Please note the value of the _data is highly volatile.  It was added as an interim measure ensuring
-     * EE_Message_To_Generate objects have any changes to the _data property when `_set_data_handler` method is called
-     * (and for back compat reasons). This particular method is used in
-     * EE_Messages_Generator::_reset_current_properties to ensure that the internal _data on the message type is
-     * cleaned before subsequent EE_Message generation in the same request.
-     *
-     * @todo      This needs refactored along with the whole _set_data_handler() method in EE_message_types. Need to
-     *            ensure that there is no manipulation of the _data property during run time so there's a clear
-     *            expectation of what it is.  Likely we need to ensure that _data is not persisted IN the message type
-     *            at all.
-     * @internal  Plugin authors, do not implement this method, it is subject to change.
-     * @since     4.9
-     */
-    public function reset_data()
-    {
-        $this->_data = null;
-    }
-
-
-    /**
-     * This does some validation of incoming params gets the url trigger from the defined method in the specific child
-     * class and then filters the results.
-     *
-     * @param string          $context           The message type context
-     * @param string          $sending_messenger The sending messenger
-     * @param EE_Registration $registration      Registration object
-     * @throws EE_Error
-     * @deprecated  4.9.0  Likely 4.9.10 or 4.10.0 will remove this method completely
-     * @return string          generated url
-     */
-    public function get_url_trigger($context, $sending_messenger, EE_Registration $registration)
-    {
-        //validate context
-        //valid context?
-        if (! isset($this->_contexts[$context])) {
-            throw new EE_Error(
-                sprintf(
-                    __('The context %s is not a valid context for %s.', 'event_espresso'),
-                    $context,
-                    get_class($this)
-                )
-            );
-        }
-        //valid sending_messenger?
-        $not_valid_msgr = false;
-        foreach ($this->_with_messengers as $generating => $sendings) {
-            if (empty($sendings) || array_search($sending_messenger, $sendings) === false) {
-                $not_valid_msgr = true;
-            }
-        }
-        if ($not_valid_msgr) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The given sending messenger string (%s) does not match a valid sending messenger with the %s.  If this is incorrect, make sure that the message type has defined this messenger as a sending messenger in its $_with_messengers array.',
-                        'event_espresso'
-                    ),
-                    $sending_messenger,
-                    get_class($this)
-                )
-            );
-        }
-        return EEH_MSG_Template::generate_url_trigger(
-            $sending_messenger,
-            $this->_active_messenger->name,
-            $context,
-            $this->name,
-            $registration,
-            $this->_GRP_ID,
-            $this->_get_id_for_msg_url($context, $registration)
-        );
-    }
-
-
-    /**
-     * Wrapper for _get_data_for_context() that handles some validation before calling the main class and also allows
-     * for filtering. This is (currently) called by the EED_Messages module.
-     *
-     * @since 4.5.0
-     * @throws EE_Error
-     * @param string          $context      This should be a string matching a valid context for the message type.
-     * @param EE_Registration $registration Need a registration to ensure that the data is valid (prevents people
-     *                                      guessing a url).
-     * @param int             $id           Optional. Integer corresponding to the value for the primary key of a
-     *                                      EE_Base_Class_Object
-     * @return mixed (EE_Base_Class||EE_Base_Class[])
-     */
-    public function get_data_for_context($context, EE_Registration $registration, $id = 0)
-    {
-        //valid context?
-        if (! isset($this->_contexts[$context])) {
-            throw new EE_Error(
-                sprintf(
-                    __('The context %s is not a valid context for %s.', 'event_espresso'),
-                    $context,
-                    get_class($this)
-                )
-            );
-        }
-        //get data and apply global and class specific filters on it.
-        $data = apply_filters(
-            'FHEE__EE_message_type__get_data_for_context__data',
-            $this->_get_data_for_context($context, $registration, $id),
-            $this
-        );
-        $data = apply_filters('FHEE__' . get_class($this) . '__get_data_for_context__data', $data, $this);
-        //if empty then something went wrong!
-        if (empty($data)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'There is no data retrieved, it is possible that the id given (%d) does not match any value in the database for the corresponding EE_Base_Class used by the data handler for the %s message type.',
-                        'event_espresso'
-                    ),
-                    $id,
-                    $this->name
-                )
-            );
-        }
-        return $data;
-    }
-
-
-    /**
-     * This returns the contents of the _data property.
-     * Please note the value of the _data is highly volatile.  It was added as an interim measure ensuring
-     * EE_Message_To_Generate objects have any changes to the _data property when `_set_data_handler` method is called.
-     *
-     * @todo      This needs refactored along with the whole _set_data_handler() method in EE_message_types. Need to
-     *            ensure that there is no manipulation of the _data property during run time so there's a clear
-     *            expectation of what it is.
-     * @internal  Plugin authors, do not implement this method, it is subject to change.
-     * @return mixed
-     */
-    public function get_data()
-    {
-        return $this->_data;
-    }
-
-
-    /**
-     * used to set the $_with_messengers property. (this is a default, child classes SHOULD override)
-     *
-     * @see   property definition for description of setup.
-     * @since 4.5.0
-     * @abstract
-     * @return void
-     */
-    protected function _set_with_messengers()
-    {
-        $this->_with_messengers = array(
-            'email' => array('html'),
-        );
-    }
-
-
-    /**
-     * Return the value of the _with_messengers property
-     *
-     * @since 4.5.0
-     * @return array
-     */
-    public function with_messengers()
-    {
-        return apply_filters(
-            'FHEE__EE_message_type__get_with_messengers__with_messengers__' . get_class($this),
-            $this->_with_messengers
-        );
-    }
-
-
-    /**
-     * this public method accepts a page slug (for an EE_admin page) and will return the response from the child class
-     * callback function if that page is registered via the `_admin_registered_page` property set by the child class.
-     * *
-     *
-     * @param string $page       the slug of the EE admin page
-     * @param array  $messengers an array of active messenger objects
-     * @param string $action     the page action (to allow for more specific handling - i.e. edit vs. add pages)
-     * @param array  $extra      This is just an extra argument that can be used to pass additional data for setting up
-     *                           page content.
-     * @access public
-     * @return string
-     */
-    public function get_message_type_admin_page_content(
-        $page,
-        $action = null,
-        $extra = array(),
-        $messengers = array()
-    ) {
-        //we can also further refine the context by action (if present).
-        return $this->_get_admin_page_content($page, $action, $extra, $messengers);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_contexts()
-    {
-        return $this->_contexts;
-    }
-
-
-    /**
-     * This just returns the context label for a given context (as set in $_context_label property)
-     *
-     * @access public
-     * @return array
-     */
-    public function get_context_label()
-    {
-        return $this->_context_label;
-    }
-
-
-    /**
-     * This just returns the (filtered) _master_templates property.
-     *
-     * @see property definition for documentation.
-     * @return array
-     */
-    public function get_master_templates()
-    {
-        //first class specific filter then filter that by the global filter.
-        $master_templates = apply_filters(
-            'FHEE__' . get_class($this) . '__get_master_templates',
-            $this->_master_templates
-        );
-        return apply_filters('FHEE__EE_message_type__get_master_templates', $master_templates, $this);
-    }
-
-
-    /**
-     * Accepts an incoming data handler which contains data for processing, and returns an array of
-     * EE_Messages_Addressee objects.
-     *
-     * @param EE_Messages_incoming_data $data
-     * @param string                    $context Limit addressees to specific context.
-     * @return array An array indexed by context where each context is an array of EE_Messages_Addressee objects for
-     *                                           that context
-     * @throws EE_Error
-     */
-    public function get_addressees(EE_Messages_incoming_data $data, $context = '')
-    {
-        //override _data
-        $this->_data       = $data;
-        $addressees        = array();
-        $original_contexts = $this->_contexts;
-        //if incoming context then limit to that context
-        if (! empty($context)) {
-            $cntxt = ! empty($this->_contexts[$context]) ? $this->_contexts[$context] : '';
-            if (! empty($cntxt)) {
-                $this->_contexts           = array();
-                $this->_contexts[$context] = $cntxt;
-            }
-        }
-        $this->_set_default_addressee_data();
-        if ($this->_process_data()) {
-            $addressees = $this->_addressees;
-        }
-
-        //reset contexts and addressees
-        $this->_contexts   = $original_contexts;
-        $this->_addressees = array();
-        return $addressees;
-    }
-
-
-    /**
-     * processes the data object so we get
-     *
-     * @throws EE_Error
-     * @return bool  true means data was processed successfully, false means not.
-     */
-    protected function _process_data()
-    {
-        //at a minimum, we NEED EE_Attendee objects.
-        if (empty($this->_data->attendees)) {
-            return false;  //there's no data to process!
-        }
-        // process addressees for each context.  Child classes will have to have methods for
-        // each context defined to handle the processing of the data object within them
-        foreach ($this->_contexts as $context => $details) {
-            $xpctd_method = '_' . $context . '_addressees';
-            if (! method_exists($this, $xpctd_method)) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'The data for %1$s message type cannot be prepared because there is no set method for doing so.  The expected method name is "%2$s" please doublecheck the %1$s message type class and make sure that method is present',
-                            'event_espresso'
-                        ),
-                        $this->label['singular'],
-                        $xpctd_method
-                    )
-                );
-            }
-            $this->_addressees[$context] = call_user_func(array($this, $xpctd_method));
-        }
-        return true; //data was processed successfully.
-    }
-
-
-    /**
-     * sets the default_addressee_data property,
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_default_addressee_data()
-    {
-        $this->_default_addressee_data = array(
-            'billing'                  => $this->_data->billing,
-            'taxes'                    => $this->_data->taxes,
-            'tax_line_items'           => $this->_data->tax_line_items,
-            'additional_line_items'    => $this->_data->additional_line_items,
-            'grand_total_line_item'    => $this->_data->grand_total_line_item,
-            'txn'                      => $this->_data->txn,
-            'payments'                 => $this->_data->payments,
-            'payment'                  => isset($this->_data->payment) && $this->_data->payment instanceof EE_Payment
-                ? $this->_data->payment
-                : null,
-            'reg_objs'                 => $this->_data->reg_objs,
-            'registrations'            => $this->_data->registrations,
-            'datetimes'                => $this->_data->datetimes,
-            'tickets'                  => $this->_data->tickets,
-            'line_items_with_children' => $this->_data->line_items_with_children,
-            'questions'                => $this->_data->questions,
-            'answers'                  => $this->_data->answers,
-            'txn_status'               => $this->_data->txn_status,
-            'total_ticket_count'       => $this->_data->total_ticket_count,
-        );
-        if (is_array($this->_data->primary_attendee_data)) {
-            $this->_default_addressee_data                    = array_merge(
-                $this->_default_addressee_data,
-                $this->_data->primary_attendee_data
-            );
-            $this->_default_addressee_data['primary_att_obj'] = $this->_data->primary_attendee_data['att_obj'];
-            $this->_default_addressee_data['primary_reg_obj'] = $this->_data->primary_attendee_data['reg_obj'];
-        }
-    }
-
-
-
-    /********************
+	/**
+	 * message type child classes will set what contexts are associated with the message type via this array.
+	 * format:
+	 * array(
+	 * 'context' => array(
+	 *        'label' => __('Context Label', 'event_espresso'),
+	 *        'description' => __('Context description (for help popups)', 'event_espresso')
+	 *    ));
+	 *
+	 * @var array
+	 */
+	protected $_contexts = array();
+
+
+	/**
+	 * This property is used to define what the display label will be for contexts (eg. "Recipients", "Themes" etc.)
+	 * Format:
+	 * array( 'label' => 'something', 'plural' => 'somethings', 'description' => 'something' );
+	 *
+	 * @var array
+	 */
+	protected $_context_label;
+
+
+	/** MESSAGE ASSEMBLING PROPERTIES **/
+	/**
+	 * This parameter simply holds all the message objects for retrieval by the controller and sending to the messenger.
+	 *
+	 * @var array of message objects.
+	 */
+	public $messages = array();
+
+	/**
+	 * The following holds the templates that will be used to assemble the message object for the messenger.
+	 *
+	 * @var array
+	 */
+	protected $_templates;
+
+
+	/**
+	 * If a specific template is being parsed, this will hold the message template group GRP_ID for that template.
+	 *
+	 * @var int.
+	 */
+	protected $_GRP_ID;
+
+
+	/** OTHER INFO PROPERTIES **/
+	/**
+	 * This will hold the count of the message objects in the messages array. This could be used for determining if
+	 * batching/queueing is needed.
+	 *
+	 * @var int
+	 */
+	public $count = 0;
+
+
+	/**
+	 * This is set via the `do_messenger_hooks` method and contains the messenger being used to send the message of
+	 * this message type at time of sending.
+	 *
+	 * @var EE_messenger
+	 */
+	protected $_active_messenger;
+
+
+	/**
+	 * This will hold the shortcode_replace instance for handling replacement of shortcodes in the various templates
+	 *
+	 * @var object
+	 */
+	protected $_shortcode_replace;
+
+
+	/**
+	 * The purpose for this property is to simply allow message types to indicate if the message generated is intended
+	 * for only single context.  Child message types should redefine this variable (if necessary) in the
+	 * _set_data_Handler() method.
+	 *
+	 * @var boolean
+	 */
+	protected $_single_message = false;
+
+
+	/**
+	 * This will hold an array of specific reg_ids that are receiving messages.
+	 *
+	 * @since 4.7.x
+	 * @var array
+	 */
+	protected $_regs_for_sending = array();
+
+
+	/**
+	 * This holds the data passed to this class from the controller and also the final processed data.
+	 *
+	 * @var object
+	 */
+	protected $_data;
+
+
+	/**
+	 * this is just a flag indicating whether we're in preview mode or not.
+	 *
+	 * @var bool
+	 */
+	protected $_preview = false;
+
+
+	/**
+	 * This just holds defaults for addressee data that children merge with their data array setup
+	 *
+	 * @var array
+	 */
+	protected $_default_addressee_data;
+
+
+	/**
+	 * Child classes declare through this property what handler they want to use for the incoming data and this string
+	 * is used to instantiate the EE_Messages_incoming_data child class for that handler.
+	 *
+	 * @var string
+	 */
+	protected $_data_handler;
+
+
+	/**
+	 * This holds any specific fields for holding any settings related to a message type (if any needed)
+	 *
+	 * @var array
+	 */
+	protected $_admin_settings_fields = array();
+
+	/**
+	 * this property will hold any existing setting that may have been set in the admin.
+	 *
+	 * @var array
+	 */
+	protected $_existing_admin_settings = array();
+
+
+	/**
+	 * This is used to designate the generating and alternative sending messengers for a message type.  It is set via
+	 * set_with_messengers() on construct. Note, generating messenger also acts as a sending messenger for this message
+	 * type.  However ONLY the generating messengers are used for creating templates for this message type. Should be
+	 * in this format:
+	 * {
+	 *
+	 * @type string $generating_messenger the name of the generating messenger.  Generating
+	 *                                          messengers are used for generating templates,
+	 *                                          doing validation and defining valid shortcodes.
+	 *      {
+	 * @type string $sending_messenger    values are the name(s) for the sending
+	 *                                              messengers.  sending messengers are
+	 *                                              just valid delivery vehicles that will utilize
+	 *                                              the templates (and generated EE_message
+	 *                                              objects from the generating messengers).
+	 *      }
+	 * }
+	 * @since                             4.5.0
+	 * @var array
+	 */
+	protected $_with_messengers = array();
+
+
+	/**
+	 * This holds the addressees in an array indexed by context for later retrieval when assembling the message objects.
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_addressees = array();
+
+
+	/**
+	 * This allows each message type to set what alternate messenger&message type combination can be used for fallback
+	 * default templates if there are no specific ones defined for this messenger and message type.  Should be in the
+	 * format:
+	 * array(
+	 *      'messenger' => 'message_type',
+	 *      'another_messenger' => another_message_type
+	 * );
+	 * This is set in the message type constructor.
+	 *
+	 * @var array
+	 */
+	protected $_master_templates = array();
+
+
+	/**
+	 * This holds whatever the set template pack is for a message template group when generating messages.
+	 *
+	 * @since 4.5.0
+	 * @var EE_Messages_Template_Pack
+	 */
+	protected $_template_pack;
+
+
+	/**
+	 * This holds whatever the set variation is for a message template group when generating messages.
+	 *
+	 * @since 4.5.0
+	 * @var string
+	 */
+	protected $_variation;
+
+
+	/**
+	 * EE_message_type constructor.
+	 */
+	public function __construct()
+	{
+		$this->_messages_item_type = 'message_type';
+		$this->_set_contexts();
+		$this->_set_with_messengers();
+		parent::__construct();
+	}
+
+
+	/**
+	 * This sets the data handler for the message type.  It must be used to define the _data_handler property.  It is
+	 * called when messages are setup.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_data_handler();
+
+
+	/**
+	 * This method should return a EE_Base_Class object (or array of EE_Base_Class objects) for the given context and
+	 * ID (which should be the primary key id for the base class).  Client code doesn't have to know what a message
+	 * type's data handler is.
+	 *
+	 * @since 4.5.0
+	 * @param string          $context      This should be a string matching a valid context for the message type.
+	 * @param EE_Registration $registration Need a registration to ensure that the data is valid (prevents people
+	 *                                      guessing a url).
+	 * @param int             $id           Optional. Integer corresponding to the value for the primary key of a
+	 *                                      EE_Base_Class_Object
+	 * @return mixed ( EE_Base_Class||EE_Base_Class[] )
+	 */
+	abstract protected function _get_data_for_context($context, EE_Registration $registration, $id);
+
+
+	/**
+	 * _set_contexts
+	 * This sets up the contexts associated with the message_type
+	 *
+	 * @abstract
+	 * @access  protected
+	 * @return  void
+	 */
+	abstract protected function _set_contexts();
+
+
+	/**
+	 * This is used to get the "id" value fo the msg_trigger_url generated by get_url_trigger().
+	 * In most cases, child classes don't need anything, (hence the default of 0), however if there is a specific
+	 * EE_Base_Class that is required in generating a message for a message type recipient then the message
+	 * type should override this method and use the given params to generate the correct ID.
+	 *
+	 * @param string          $context      The message type context.
+	 * @param EE_Registration $registration Registration object
+	 * @deprecated 4.9.0
+	 * @return int
+	 */
+	protected function _get_id_for_msg_url($context, EE_Registration $registration)
+	{
+		return 0;
+	}
+
+
+	/**
+	 * This sets up any action/filter hooks this message type puts in place for a specific messenger.  Note that by
+	 * default this does nothing.  Child classes will need to override if they want to add specific hooks for a
+	 * messenger.
+	 *
+	 * @since 1.0.0
+	 * @return void
+	 */
+	protected function _do_messenger_hooks()
+	{
+		return;
+	}
+
+
+	/**
+	 * This is a public wrapper for the protected _do_messenger_hooks() method.
+	 * For backward compat reasons, this was done rather than making the protected method public.
+	 *
+	 * @param   EE_messenger $messenger This is used to set the $_active_messenger property, so message types are able
+	 *                                  to know what messenger is being used to send the message at the time of
+	 *                                  sending.
+	 * @since 4.9.0
+	 */
+	public function do_messenger_hooks($messenger = null)
+	{
+		$this->_active_messenger = $messenger;
+		$this->_do_messenger_hooks();
+	}
+
+
+	/**
+	 * This method returns whether this message type should always generate a new copy
+	 * when requested, or if links can be to the already generated copy.
+	 * Note: this does NOT affect viewing/resending already generated messages in the EE_Message list table.
+	 * Child classes should override this if different from the default of false.
+	 *
+	 * @return bool     false means can link to generated EE_Message.  true must regenerate.
+	 */
+	public function always_generate()
+	{
+		return false;
+	}
+
+
+	/**
+	 * Returns the priority for the message type.
+	 * Priorities are defined as constants on EEM_Message.  Currently there are three priorities:
+	 * - EEM_Message::priority_high
+	 * - EEM_Message::priority_medium
+	 * - EEM_Message::priority_low
+	 * Priority is used to determine the weight the message type is given when queuing for generation and/or sending.
+	 *
+	 * @see    EEM_Message for more phpdocs on priority.
+	 *         The default priority for all message_types is EEM_Message::priority_low.  Message Types wanting to give
+	 *         a higher priority must override this method. Also note, messengers are able to override priorities
+	 *         queuing instructions if their "send_now" flag is set to true. An example of this is the HTML messenger
+	 *         which displays things in the browser.
+	 * @since  4.9.0
+	 * @return int
+	 */
+	public function get_priority()
+	{
+		return EEM_Message::priority_low;
+	}
+
+
+	/**
+	 * This runs the _set_data_handler() method for message types and then returns what got set.
+	 *
+	 * @param mixed $data This sets the data property for the message type with the incoming data used for generating.
+	 * @return string (the reference for the data handler) (will be an empty string if could not be determined).
+	 */
+	public function get_data_handler($data)
+	{
+		$this->_data = $data;
+		$this->_set_data_handler();
+		return apply_filters('FHEE__EE_message_type__get_data_handler', $this->_data_handler, $this);
+	}
+
+
+	/**
+	 * This is called externally to reset the value of the $_data property for the message type.
+	 * Please note the value of the _data is highly volatile.  It was added as an interim measure ensuring
+	 * EE_Message_To_Generate objects have any changes to the _data property when `_set_data_handler` method is called
+	 * (and for back compat reasons). This particular method is used in
+	 * EE_Messages_Generator::_reset_current_properties to ensure that the internal _data on the message type is
+	 * cleaned before subsequent EE_Message generation in the same request.
+	 *
+	 * @todo      This needs refactored along with the whole _set_data_handler() method in EE_message_types. Need to
+	 *            ensure that there is no manipulation of the _data property during run time so there's a clear
+	 *            expectation of what it is.  Likely we need to ensure that _data is not persisted IN the message type
+	 *            at all.
+	 * @internal  Plugin authors, do not implement this method, it is subject to change.
+	 * @since     4.9
+	 */
+	public function reset_data()
+	{
+		$this->_data = null;
+	}
+
+
+	/**
+	 * This does some validation of incoming params gets the url trigger from the defined method in the specific child
+	 * class and then filters the results.
+	 *
+	 * @param string          $context           The message type context
+	 * @param string          $sending_messenger The sending messenger
+	 * @param EE_Registration $registration      Registration object
+	 * @throws EE_Error
+	 * @deprecated  4.9.0  Likely 4.9.10 or 4.10.0 will remove this method completely
+	 * @return string          generated url
+	 */
+	public function get_url_trigger($context, $sending_messenger, EE_Registration $registration)
+	{
+		//validate context
+		//valid context?
+		if (! isset($this->_contexts[$context])) {
+			throw new EE_Error(
+				sprintf(
+					__('The context %s is not a valid context for %s.', 'event_espresso'),
+					$context,
+					get_class($this)
+				)
+			);
+		}
+		//valid sending_messenger?
+		$not_valid_msgr = false;
+		foreach ($this->_with_messengers as $generating => $sendings) {
+			if (empty($sendings) || array_search($sending_messenger, $sendings) === false) {
+				$not_valid_msgr = true;
+			}
+		}
+		if ($not_valid_msgr) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The given sending messenger string (%s) does not match a valid sending messenger with the %s.  If this is incorrect, make sure that the message type has defined this messenger as a sending messenger in its $_with_messengers array.',
+						'event_espresso'
+					),
+					$sending_messenger,
+					get_class($this)
+				)
+			);
+		}
+		return EEH_MSG_Template::generate_url_trigger(
+			$sending_messenger,
+			$this->_active_messenger->name,
+			$context,
+			$this->name,
+			$registration,
+			$this->_GRP_ID,
+			$this->_get_id_for_msg_url($context, $registration)
+		);
+	}
+
+
+	/**
+	 * Wrapper for _get_data_for_context() that handles some validation before calling the main class and also allows
+	 * for filtering. This is (currently) called by the EED_Messages module.
+	 *
+	 * @since 4.5.0
+	 * @throws EE_Error
+	 * @param string          $context      This should be a string matching a valid context for the message type.
+	 * @param EE_Registration $registration Need a registration to ensure that the data is valid (prevents people
+	 *                                      guessing a url).
+	 * @param int             $id           Optional. Integer corresponding to the value for the primary key of a
+	 *                                      EE_Base_Class_Object
+	 * @return mixed (EE_Base_Class||EE_Base_Class[])
+	 */
+	public function get_data_for_context($context, EE_Registration $registration, $id = 0)
+	{
+		//valid context?
+		if (! isset($this->_contexts[$context])) {
+			throw new EE_Error(
+				sprintf(
+					__('The context %s is not a valid context for %s.', 'event_espresso'),
+					$context,
+					get_class($this)
+				)
+			);
+		}
+		//get data and apply global and class specific filters on it.
+		$data = apply_filters(
+			'FHEE__EE_message_type__get_data_for_context__data',
+			$this->_get_data_for_context($context, $registration, $id),
+			$this
+		);
+		$data = apply_filters('FHEE__' . get_class($this) . '__get_data_for_context__data', $data, $this);
+		//if empty then something went wrong!
+		if (empty($data)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'There is no data retrieved, it is possible that the id given (%d) does not match any value in the database for the corresponding EE_Base_Class used by the data handler for the %s message type.',
+						'event_espresso'
+					),
+					$id,
+					$this->name
+				)
+			);
+		}
+		return $data;
+	}
+
+
+	/**
+	 * This returns the contents of the _data property.
+	 * Please note the value of the _data is highly volatile.  It was added as an interim measure ensuring
+	 * EE_Message_To_Generate objects have any changes to the _data property when `_set_data_handler` method is called.
+	 *
+	 * @todo      This needs refactored along with the whole _set_data_handler() method in EE_message_types. Need to
+	 *            ensure that there is no manipulation of the _data property during run time so there's a clear
+	 *            expectation of what it is.
+	 * @internal  Plugin authors, do not implement this method, it is subject to change.
+	 * @return mixed
+	 */
+	public function get_data()
+	{
+		return $this->_data;
+	}
+
+
+	/**
+	 * used to set the $_with_messengers property. (this is a default, child classes SHOULD override)
+	 *
+	 * @see   property definition for description of setup.
+	 * @since 4.5.0
+	 * @abstract
+	 * @return void
+	 */
+	protected function _set_with_messengers()
+	{
+		$this->_with_messengers = array(
+			'email' => array('html'),
+		);
+	}
+
+
+	/**
+	 * Return the value of the _with_messengers property
+	 *
+	 * @since 4.5.0
+	 * @return array
+	 */
+	public function with_messengers()
+	{
+		return apply_filters(
+			'FHEE__EE_message_type__get_with_messengers__with_messengers__' . get_class($this),
+			$this->_with_messengers
+		);
+	}
+
+
+	/**
+	 * this public method accepts a page slug (for an EE_admin page) and will return the response from the child class
+	 * callback function if that page is registered via the `_admin_registered_page` property set by the child class.
+	 * *
+	 *
+	 * @param string $page       the slug of the EE admin page
+	 * @param array  $messengers an array of active messenger objects
+	 * @param string $action     the page action (to allow for more specific handling - i.e. edit vs. add pages)
+	 * @param array  $extra      This is just an extra argument that can be used to pass additional data for setting up
+	 *                           page content.
+	 * @access public
+	 * @return string
+	 */
+	public function get_message_type_admin_page_content(
+		$page,
+		$action = null,
+		$extra = array(),
+		$messengers = array()
+	) {
+		//we can also further refine the context by action (if present).
+		return $this->_get_admin_page_content($page, $action, $extra, $messengers);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_contexts()
+	{
+		return $this->_contexts;
+	}
+
+
+	/**
+	 * This just returns the context label for a given context (as set in $_context_label property)
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_context_label()
+	{
+		return $this->_context_label;
+	}
+
+
+	/**
+	 * This just returns the (filtered) _master_templates property.
+	 *
+	 * @see property definition for documentation.
+	 * @return array
+	 */
+	public function get_master_templates()
+	{
+		//first class specific filter then filter that by the global filter.
+		$master_templates = apply_filters(
+			'FHEE__' . get_class($this) . '__get_master_templates',
+			$this->_master_templates
+		);
+		return apply_filters('FHEE__EE_message_type__get_master_templates', $master_templates, $this);
+	}
+
+
+	/**
+	 * Accepts an incoming data handler which contains data for processing, and returns an array of
+	 * EE_Messages_Addressee objects.
+	 *
+	 * @param EE_Messages_incoming_data $data
+	 * @param string                    $context Limit addressees to specific context.
+	 * @return array An array indexed by context where each context is an array of EE_Messages_Addressee objects for
+	 *                                           that context
+	 * @throws EE_Error
+	 */
+	public function get_addressees(EE_Messages_incoming_data $data, $context = '')
+	{
+		//override _data
+		$this->_data       = $data;
+		$addressees        = array();
+		$original_contexts = $this->_contexts;
+		//if incoming context then limit to that context
+		if (! empty($context)) {
+			$cntxt = ! empty($this->_contexts[$context]) ? $this->_contexts[$context] : '';
+			if (! empty($cntxt)) {
+				$this->_contexts           = array();
+				$this->_contexts[$context] = $cntxt;
+			}
+		}
+		$this->_set_default_addressee_data();
+		if ($this->_process_data()) {
+			$addressees = $this->_addressees;
+		}
+
+		//reset contexts and addressees
+		$this->_contexts   = $original_contexts;
+		$this->_addressees = array();
+		return $addressees;
+	}
+
+
+	/**
+	 * processes the data object so we get
+	 *
+	 * @throws EE_Error
+	 * @return bool  true means data was processed successfully, false means not.
+	 */
+	protected function _process_data()
+	{
+		//at a minimum, we NEED EE_Attendee objects.
+		if (empty($this->_data->attendees)) {
+			return false;  //there's no data to process!
+		}
+		// process addressees for each context.  Child classes will have to have methods for
+		// each context defined to handle the processing of the data object within them
+		foreach ($this->_contexts as $context => $details) {
+			$xpctd_method = '_' . $context . '_addressees';
+			if (! method_exists($this, $xpctd_method)) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'The data for %1$s message type cannot be prepared because there is no set method for doing so.  The expected method name is "%2$s" please doublecheck the %1$s message type class and make sure that method is present',
+							'event_espresso'
+						),
+						$this->label['singular'],
+						$xpctd_method
+					)
+				);
+			}
+			$this->_addressees[$context] = call_user_func(array($this, $xpctd_method));
+		}
+		return true; //data was processed successfully.
+	}
+
+
+	/**
+	 * sets the default_addressee_data property,
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_default_addressee_data()
+	{
+		$this->_default_addressee_data = array(
+			'billing'                  => $this->_data->billing,
+			'taxes'                    => $this->_data->taxes,
+			'tax_line_items'           => $this->_data->tax_line_items,
+			'additional_line_items'    => $this->_data->additional_line_items,
+			'grand_total_line_item'    => $this->_data->grand_total_line_item,
+			'txn'                      => $this->_data->txn,
+			'payments'                 => $this->_data->payments,
+			'payment'                  => isset($this->_data->payment) && $this->_data->payment instanceof EE_Payment
+				? $this->_data->payment
+				: null,
+			'reg_objs'                 => $this->_data->reg_objs,
+			'registrations'            => $this->_data->registrations,
+			'datetimes'                => $this->_data->datetimes,
+			'tickets'                  => $this->_data->tickets,
+			'line_items_with_children' => $this->_data->line_items_with_children,
+			'questions'                => $this->_data->questions,
+			'answers'                  => $this->_data->answers,
+			'txn_status'               => $this->_data->txn_status,
+			'total_ticket_count'       => $this->_data->total_ticket_count,
+		);
+		if (is_array($this->_data->primary_attendee_data)) {
+			$this->_default_addressee_data                    = array_merge(
+				$this->_default_addressee_data,
+				$this->_data->primary_attendee_data
+			);
+			$this->_default_addressee_data['primary_att_obj'] = $this->_data->primary_attendee_data['att_obj'];
+			$this->_default_addressee_data['primary_reg_obj'] = $this->_data->primary_attendee_data['reg_obj'];
+		}
+	}
+
+
+
+	/********************
      * setup default shared addressee object/contexts
      * These can be utilized simply by defining the context in the child message type.
      * They can also be overridden if a specific message type needs to do something different for that context.
      ****************/
-    /**
-     * see abstract declaration in parent class for details, children message types can
-     * override these valid shortcodes if desired (we include all for all contexts by default).
-     */
-    protected function _set_valid_shortcodes()
-    {
-        $all_shortcodes = array(
-            'attendee_list',
-            'attendee',
-            'datetime_list',
-            'datetime',
-            'event_list',
-            'event_meta',
-            'event',
-            'organization',
-            'recipient_details',
-            'recipient_list',
-            'ticket_list',
-            'ticket',
-            'transaction',
-            'venue',
-            'primary_registration_details',
-            'primary_registration_list',
-            'event_author',
-            'email',
-            'messenger',
-        );
-        $contexts       = $this->get_contexts();
-        foreach ($contexts as $context => $details) {
-            $this->_valid_shortcodes[$context] = $all_shortcodes;
-            //make sure non admin context does not include the event_author shortcodes
-            if ($context != 'admin') {
-                if (($key = array_search('event_author', $this->_valid_shortcodes[$context])) !== false) {
-                    unset($this->_valid_shortcodes[$context][$key]);
-                }
-            }
-        }
-        // make sure admin context does not include the recipient_details shortcodes
-        // IF we have admin context hooked in message types might not have that context.
-        if (! empty($this->_valid_shortcodes['admin'])) {
-            if (($key = array_search('recipient_details', $this->_valid_shortcodes['admin'])) !== false) {
-                unset($this->_valid_shortcodes['admin'][$key]);
-            }
-            //make sure admin context does not include the recipient_details shortcodes
-            if (($key = array_search('recipient_list', $this->_valid_shortcodes['admin'])) !== false) {
-                unset($this->_valid_shortcodes['admin'][$key]);
-            }
-        }
-    }
-
-
-    /**
-     * Used by Validators to modify the valid shortcodes.
-     *
-     * @param  array $new_config array of valid shortcodes (by context)
-     * @return void               sets valid_shortcodes property
-     */
-    public function reset_valid_shortcodes_config($new_config)
-    {
-        foreach ($new_config as $context => $shortcodes) {
-            $this->_valid_shortcodes[$context] = $shortcodes;
-        }
-    }
-
-
-    /**
-     * returns an array of addressee objects for event_admins
-     *
-     * @access protected
-     * @return array array of EE_Messages_Addressee objects
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _admin_addressees()
-    {
-        $admin_events = array();
-        $addressees   = array();
-        // first we need to get the event admin user id for all the events
-        // and setup an addressee object for each unique admin user.
-        foreach ($this->_data->events as $line_ref => $event) {
-            $admin_id = $this->_get_event_admin_id($event['ID']);
-            //make sure we are just including the events that belong to this admin!
-            $admin_events[$admin_id][$line_ref] = $event;
-        }
-        //k now we can loop through the event_admins and setup the addressee data.
-        foreach ($admin_events as $admin_id => $event_details) {
-            $aee          = array(
-                'user_id'        => $admin_id,
-                'events'         => $event_details,
-                'attendees'      => $this->_data->attendees,
-                'recipient_id'   => $admin_id,
-                'recipient_type' => 'WP_User',
-            );
-            $aee          = array_merge($this->_default_addressee_data, $aee);
-            $addressees[] = new EE_Messages_Addressee($aee);
-        }
-        return $addressees;
-    }
-
-
-    /**
-     * Takes care of setting up the addressee object(s) for the primary attendee.
-     *
-     * @access protected
-     * @return array of EE_Addressee objects
-     * @throws EE_Error
-     */
-    protected function _primary_attendee_addressees()
-    {
-        $aee                   = $this->_default_addressee_data;
-        $aee['events']         = $this->_data->events;
-        $aee['attendees']      = $this->_data->attendees;
-        $aee['recipient_id']   = $aee['primary_att_obj'] instanceof EE_Attendee ? $aee['primary_att_obj']->ID() : 0;
-        $aee['recipient_type'] = 'Attendee';
-        //great now we can instantiate the $addressee object and return (as an array);
-        $add[] = new EE_Messages_Addressee($aee);
-        return $add;
-    }
-
-
-    /**
-     * Takes care of setting up the addressee object(s) for the registered attendees
-     *
-     * @access protected
-     * @return array of EE_Addressee objects
-     */
-    protected function _attendee_addressees()
-    {
-        $add = array();
-        //we just have to loop through the attendees.  We'll also set the attached events for each attendee.
-        //use to verify unique attendee emails... we don't want to sent multiple copies to the same attendee do we?
-        $already_processed = array();
-        foreach ($this->_data->attendees as $att_id => $details) {
-            //set the attendee array to blank on each loop;
-            $aee = array();
-            if (isset($this->_data->reg_obj)
-                && ($this->_data->reg_obj->attendee_ID() != $att_id)
-                && $this->_single_message
-            ) {
-                continue;
-            }
-            // is $this->_regs_for_sending present?
-            // If so, let's make sure we ONLY generate addressee for registrations in that array.
-            if (! empty($this->_regs_for_sending) && is_array($this->_regs_for_sending)) {
-                $regs_allowed = array_intersect_key(array_flip($this->_regs_for_sending), $details['reg_objs']);
-                if (empty($regs_allowed)) {
-                    continue;
-                }
-            }
-            if (apply_filters(
-                'FHEE__EE_message_type___attendee_addressees__prevent_duplicate_email_sends',
-                true,
-                $this->_data,
-                $this
-            )
-                && in_array($att_id, $already_processed, true)
-            ) {
-                continue;
-            }
-            $already_processed[] = $att_id;
-            foreach ($details as $item => $value) {
-                $aee[$item] = $value;
-                if ($item === 'line_ref') {
-                    foreach ($value as $event_id) {
-                        $aee['events'][$event_id] = $this->_data->events[$event_id];
-                    }
-                }
-                if ($item === 'attendee_email') {
-                    $aee['attendee_email'] = $value;
-                }
-                /*if ( $item == 'registration_id' ) {
+	/**
+	 * see abstract declaration in parent class for details, children message types can
+	 * override these valid shortcodes if desired (we include all for all contexts by default).
+	 */
+	protected function _set_valid_shortcodes()
+	{
+		$all_shortcodes = array(
+			'attendee_list',
+			'attendee',
+			'datetime_list',
+			'datetime',
+			'event_list',
+			'event_meta',
+			'event',
+			'organization',
+			'recipient_details',
+			'recipient_list',
+			'ticket_list',
+			'ticket',
+			'transaction',
+			'venue',
+			'primary_registration_details',
+			'primary_registration_list',
+			'event_author',
+			'email',
+			'messenger',
+		);
+		$contexts       = $this->get_contexts();
+		foreach ($contexts as $context => $details) {
+			$this->_valid_shortcodes[$context] = $all_shortcodes;
+			//make sure non admin context does not include the event_author shortcodes
+			if ($context != 'admin') {
+				if (($key = array_search('event_author', $this->_valid_shortcodes[$context])) !== false) {
+					unset($this->_valid_shortcodes[$context][$key]);
+				}
+			}
+		}
+		// make sure admin context does not include the recipient_details shortcodes
+		// IF we have admin context hooked in message types might not have that context.
+		if (! empty($this->_valid_shortcodes['admin'])) {
+			if (($key = array_search('recipient_details', $this->_valid_shortcodes['admin'])) !== false) {
+				unset($this->_valid_shortcodes['admin'][$key]);
+			}
+			//make sure admin context does not include the recipient_details shortcodes
+			if (($key = array_search('recipient_list', $this->_valid_shortcodes['admin'])) !== false) {
+				unset($this->_valid_shortcodes['admin'][$key]);
+			}
+		}
+	}
+
+
+	/**
+	 * Used by Validators to modify the valid shortcodes.
+	 *
+	 * @param  array $new_config array of valid shortcodes (by context)
+	 * @return void               sets valid_shortcodes property
+	 */
+	public function reset_valid_shortcodes_config($new_config)
+	{
+		foreach ($new_config as $context => $shortcodes) {
+			$this->_valid_shortcodes[$context] = $shortcodes;
+		}
+	}
+
+
+	/**
+	 * returns an array of addressee objects for event_admins
+	 *
+	 * @access protected
+	 * @return array array of EE_Messages_Addressee objects
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _admin_addressees()
+	{
+		$admin_events = array();
+		$addressees   = array();
+		// first we need to get the event admin user id for all the events
+		// and setup an addressee object for each unique admin user.
+		foreach ($this->_data->events as $line_ref => $event) {
+			$admin_id = $this->_get_event_admin_id($event['ID']);
+			//make sure we are just including the events that belong to this admin!
+			$admin_events[$admin_id][$line_ref] = $event;
+		}
+		//k now we can loop through the event_admins and setup the addressee data.
+		foreach ($admin_events as $admin_id => $event_details) {
+			$aee          = array(
+				'user_id'        => $admin_id,
+				'events'         => $event_details,
+				'attendees'      => $this->_data->attendees,
+				'recipient_id'   => $admin_id,
+				'recipient_type' => 'WP_User',
+			);
+			$aee          = array_merge($this->_default_addressee_data, $aee);
+			$addressees[] = new EE_Messages_Addressee($aee);
+		}
+		return $addressees;
+	}
+
+
+	/**
+	 * Takes care of setting up the addressee object(s) for the primary attendee.
+	 *
+	 * @access protected
+	 * @return array of EE_Addressee objects
+	 * @throws EE_Error
+	 */
+	protected function _primary_attendee_addressees()
+	{
+		$aee                   = $this->_default_addressee_data;
+		$aee['events']         = $this->_data->events;
+		$aee['attendees']      = $this->_data->attendees;
+		$aee['recipient_id']   = $aee['primary_att_obj'] instanceof EE_Attendee ? $aee['primary_att_obj']->ID() : 0;
+		$aee['recipient_type'] = 'Attendee';
+		//great now we can instantiate the $addressee object and return (as an array);
+		$add[] = new EE_Messages_Addressee($aee);
+		return $add;
+	}
+
+
+	/**
+	 * Takes care of setting up the addressee object(s) for the registered attendees
+	 *
+	 * @access protected
+	 * @return array of EE_Addressee objects
+	 */
+	protected function _attendee_addressees()
+	{
+		$add = array();
+		//we just have to loop through the attendees.  We'll also set the attached events for each attendee.
+		//use to verify unique attendee emails... we don't want to sent multiple copies to the same attendee do we?
+		$already_processed = array();
+		foreach ($this->_data->attendees as $att_id => $details) {
+			//set the attendee array to blank on each loop;
+			$aee = array();
+			if (isset($this->_data->reg_obj)
+				&& ($this->_data->reg_obj->attendee_ID() != $att_id)
+				&& $this->_single_message
+			) {
+				continue;
+			}
+			// is $this->_regs_for_sending present?
+			// If so, let's make sure we ONLY generate addressee for registrations in that array.
+			if (! empty($this->_regs_for_sending) && is_array($this->_regs_for_sending)) {
+				$regs_allowed = array_intersect_key(array_flip($this->_regs_for_sending), $details['reg_objs']);
+				if (empty($regs_allowed)) {
+					continue;
+				}
+			}
+			if (apply_filters(
+				'FHEE__EE_message_type___attendee_addressees__prevent_duplicate_email_sends',
+				true,
+				$this->_data,
+				$this
+			)
+				&& in_array($att_id, $already_processed, true)
+			) {
+				continue;
+			}
+			$already_processed[] = $att_id;
+			foreach ($details as $item => $value) {
+				$aee[$item] = $value;
+				if ($item === 'line_ref') {
+					foreach ($value as $event_id) {
+						$aee['events'][$event_id] = $this->_data->events[$event_id];
+					}
+				}
+				if ($item === 'attendee_email') {
+					$aee['attendee_email'] = $value;
+				}
+				/*if ( $item == 'registration_id' ) {
                     $aee['attendee_registration_id'] = $value;
                 }/**/
-            }
-            // note the FIRST reg object in this array is the one
-            // we'll use for this attendee as the primary registration for this attendee.
-            $aee['reg_obj']        = reset($this->_data->attendees[$att_id]['reg_objs']);
-            $aee['attendees']      = $this->_data->attendees;
-            $aee['recipient_id']   = $att_id;
-            $aee['recipient_type'] = 'Attendee';
-            //merge in the primary attendee data
-            $aee   = array_merge($this->_default_addressee_data, $aee);
-            $add[] = new EE_Messages_Addressee($aee);
-        }
-        return $add;
-    }
-
-
-    /**
-     * @param $event_id
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _get_event_admin_id($event_id)
-    {
-        $event = EEM_Event::instance()->get_one_by_ID($event_id);
-        return $event instanceof EE_Event ? $event->wp_user() : 0;
-    }
+			}
+			// note the FIRST reg object in this array is the one
+			// we'll use for this attendee as the primary registration for this attendee.
+			$aee['reg_obj']        = reset($this->_data->attendees[$att_id]['reg_objs']);
+			$aee['attendees']      = $this->_data->attendees;
+			$aee['recipient_id']   = $att_id;
+			$aee['recipient_type'] = 'Attendee';
+			//merge in the primary attendee data
+			$aee   = array_merge($this->_default_addressee_data, $aee);
+			$add[] = new EE_Messages_Addressee($aee);
+		}
+		return $add;
+	}
+
+
+	/**
+	 * @param $event_id
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _get_event_admin_id($event_id)
+	{
+		$event = EEM_Event::instance()->get_one_by_ID($event_id);
+		return $event instanceof EE_Event ? $event->wp_user() : 0;
+	}
 }
 //end EE_message_type class

Spacing +15 added lines, -15 removed lines

@@ -411,7 +411,7 @@ 
     {
         //validate context
         //valid context?
-        if (! isset($this->_contexts[$context])) {
+        if ( ! isset($this->_contexts[$context])) {
             throw new EE_Error(
                 sprintf(
                     __('The context %s is not a valid context for %s.', 'event_espresso'),
@@ -467,7 +467,7 @@ 
     public function get_data_for_context($context, EE_Registration $registration, $id = 0)
     {
         //valid context?
-        if (! isset($this->_contexts[$context])) {
+        if ( ! isset($this->_contexts[$context])) {
             throw new EE_Error(
                 sprintf(
                     __('The context %s is not a valid context for %s.', 'event_espresso'),
@@ -482,7 +482,7 @@ 
             $this->_get_data_for_context($context, $registration, $id),
             $this
         );
-        $data = apply_filters('FHEE__' . get_class($this) . '__get_data_for_context__data', $data, $this);
+        $data = apply_filters('FHEE__'.get_class($this).'__get_data_for_context__data', $data, $this);
         //if empty then something went wrong!
         if (empty($data)) {
             throw new EE_Error(
@@ -542,7 +542,7 @@ 
     public function with_messengers()
     {
         return apply_filters(
-            'FHEE__EE_message_type__get_with_messengers__with_messengers__' . get_class($this),
+            'FHEE__EE_message_type__get_with_messengers__with_messengers__'.get_class($this),
             $this->_with_messengers
         );
     }
@@ -603,7 +603,7 @@ 
     {
         //first class specific filter then filter that by the global filter.
         $master_templates = apply_filters(
-            'FHEE__' . get_class($this) . '__get_master_templates',
+            'FHEE__'.get_class($this).'__get_master_templates',
             $this->_master_templates
         );
         return apply_filters('FHEE__EE_message_type__get_master_templates', $master_templates, $this);
@@ -627,9 +627,9 @@ 
         $addressees        = array();
         $original_contexts = $this->_contexts;
         //if incoming context then limit to that context
-        if (! empty($context)) {
+        if ( ! empty($context)) {
             $cntxt = ! empty($this->_contexts[$context]) ? $this->_contexts[$context] : '';
-            if (! empty($cntxt)) {
+            if ( ! empty($cntxt)) {
                 $this->_contexts           = array();
                 $this->_contexts[$context] = $cntxt;
             }
@@ -656,13 +656,13 @@ 
     {
         //at a minimum, we NEED EE_Attendee objects.
         if (empty($this->_data->attendees)) {
-            return false;  //there's no data to process!
+            return false; //there's no data to process!
         }
         // process addressees for each context.  Child classes will have to have methods for
         // each context defined to handle the processing of the data object within them
         foreach ($this->_contexts as $context => $details) {
-            $xpctd_method = '_' . $context . '_addressees';
-            if (! method_exists($this, $xpctd_method)) {
+            $xpctd_method = '_'.$context.'_addressees';
+            if ( ! method_exists($this, $xpctd_method)) {
                 throw new EE_Error(
                     sprintf(
                         __(
@@ -710,7 +710,7 @@ 
             'total_ticket_count'       => $this->_data->total_ticket_count,
         );
         if (is_array($this->_data->primary_attendee_data)) {
-            $this->_default_addressee_data                    = array_merge(
+            $this->_default_addressee_data = array_merge(
                 $this->_default_addressee_data,
                 $this->_data->primary_attendee_data
             );
@@ -753,7 +753,7 @@ 
             'email',
             'messenger',
         );
-        $contexts       = $this->get_contexts();
+        $contexts = $this->get_contexts();
         foreach ($contexts as $context => $details) {
             $this->_valid_shortcodes[$context] = $all_shortcodes;
             //make sure non admin context does not include the event_author shortcodes
@@ -765,7 +765,7 @@ 
         }
         // make sure admin context does not include the recipient_details shortcodes
         // IF we have admin context hooked in message types might not have that context.
-        if (! empty($this->_valid_shortcodes['admin'])) {
+        if ( ! empty($this->_valid_shortcodes['admin'])) {
             if (($key = array_search('recipient_details', $this->_valid_shortcodes['admin'])) !== false) {
                 unset($this->_valid_shortcodes['admin'][$key]);
             }
@@ -814,7 +814,7 @@ 
         }
         //k now we can loop through the event_admins and setup the addressee data.
         foreach ($admin_events as $admin_id => $event_details) {
-            $aee          = array(
+            $aee = array(
                 'user_id'        => $admin_id,
                 'events'         => $event_details,
                 'attendees'      => $this->_data->attendees,
@@ -871,7 +871,7 @@ 
             }
             // is $this->_regs_for_sending present?
             // If so, let's make sure we ONLY generate addressee for registrations in that array.
-            if (! empty($this->_regs_for_sending) && is_array($this->_regs_for_sending)) {
+            if ( ! empty($this->_regs_for_sending) && is_array($this->_regs_for_sending)) {
                 $regs_allowed = array_intersect_key(array_flip($this->_regs_for_sending), $details['reg_objs']);
                 if (empty($regs_allowed)) {
                     continue;

admin_pages/registration_form/espresso_events_Registration_Form_Hooks.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -53,7 +53,7 @@
 
     /**
      * Callback for FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks hook
-     * @param $callbacks
+     * @param callable[] $callbacks
      * @return array
      */
     public function modify_callbacks($callbacks)

Indentation +189 added lines, -189 removed lines

@@ -18,207 +18,207 @@
 {
 
 
-    /**
-     * @var EE_Event|null
-     */
-    protected $_event;
-
-
-    protected function _set_hooks_properties()
-    {
-
-        $this->_name      = 'registration_form';
-        $this->_metaboxes = array(
-            0 => array(
-                'page_route' => array('edit', 'create_new'),
-                'func'       => 'primary_questions',
-                'label'      => esc_html__('Questions for Primary Registrant', 'event_espresso'),
-                'priority'   => 'default',
-                'context'    => 'side',
-            ),
-        );
-
-        //hook into the handler for saving question groups
-        add_filter(
-            'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
-            array($this, 'modify_callbacks'),
-            10
-        );
-
-        //hook into revision restores (we're hooking into the global action because EE_Admin_Hooks classes are already
-        //restricted by page)
-        add_action('AHEE_EE_Admin_Page_CPT__restore_revision', array($this, 'restore_revision'), 10, 2);
-    }
-
-
-    /**
-     * Callback for FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks hook
-     * @param $callbacks
-     * @return array
-     */
-    public function modify_callbacks($callbacks)
-    {
-        //now let's add the question group callback
-        $callbacks[] = array($this, 'primary_question_group_update');
-        return $callbacks;
-    }
-
-
-    /**
-     * Hooked into revision restores.
-     * @param $post_id
-     * @param $revision_id
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function restore_revision($post_id, $revision_id)
-    {
-        $EVT_MDL  = EE_Registry::instance()->load_model('Event');
-        $post_evt = $EVT_MDL->get_one_by_ID($post_id);
-        //restore revision for primary questions
-        $post_evt->restore_revision(
-            $revision_id,
-            array('Question_Group'),
-            array('Question_Group' => array('Event_Question_Group.EQG_primary' => 1))
-        );
-        return $post_evt;
-    }
-
-
-    /**
-     * Content of metabox.
-     * @param $post_id
-     * @param $post
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function primary_questions($post_id, $post)
-    {
-        $this->_event = $this->_adminpage_obj->get_event_object();
-        $event_id     = $this->_event->ID();
-        ?>
+	/**
+	 * @var EE_Event|null
+	 */
+	protected $_event;
+
+
+	protected function _set_hooks_properties()
+	{
+
+		$this->_name      = 'registration_form';
+		$this->_metaboxes = array(
+			0 => array(
+				'page_route' => array('edit', 'create_new'),
+				'func'       => 'primary_questions',
+				'label'      => esc_html__('Questions for Primary Registrant', 'event_espresso'),
+				'priority'   => 'default',
+				'context'    => 'side',
+			),
+		);
+
+		//hook into the handler for saving question groups
+		add_filter(
+			'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
+			array($this, 'modify_callbacks'),
+			10
+		);
+
+		//hook into revision restores (we're hooking into the global action because EE_Admin_Hooks classes are already
+		//restricted by page)
+		add_action('AHEE_EE_Admin_Page_CPT__restore_revision', array($this, 'restore_revision'), 10, 2);
+	}
+
+
+	/**
+	 * Callback for FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks hook
+	 * @param $callbacks
+	 * @return array
+	 */
+	public function modify_callbacks($callbacks)
+	{
+		//now let's add the question group callback
+		$callbacks[] = array($this, 'primary_question_group_update');
+		return $callbacks;
+	}
+
+
+	/**
+	 * Hooked into revision restores.
+	 * @param $post_id
+	 * @param $revision_id
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function restore_revision($post_id, $revision_id)
+	{
+		$EVT_MDL  = EE_Registry::instance()->load_model('Event');
+		$post_evt = $EVT_MDL->get_one_by_ID($post_id);
+		//restore revision for primary questions
+		$post_evt->restore_revision(
+			$revision_id,
+			array('Question_Group'),
+			array('Question_Group' => array('Event_Question_Group.EQG_primary' => 1))
+		);
+		return $post_evt;
+	}
+
+
+	/**
+	 * Content of metabox.
+	 * @param $post_id
+	 * @param $post
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function primary_questions($post_id, $post)
+	{
+		$this->_event = $this->_adminpage_obj->get_event_object();
+		$event_id     = $this->_event->ID();
+		?>
         <div class="inside">
             <p><strong>
                     <?php _e('Question Groups', 'event_espresso'); ?>
                 </strong><br/>
                 <?php
-                    printf(
-                        esc_html__(
-                            'Add a pre-populated %1$sgroup of questions%2$s to your event. The personal information group is required for all events',
-                            'event_espresso'
-                        ),
-                        '<a href="admin.php?page=espresso_registration_form" target="_blank">',
-                        '</a>'
-                    )
-                ?>
+					printf(
+						esc_html__(
+							'Add a pre-populated %1$sgroup of questions%2$s to your event. The personal information group is required for all events',
+							'event_espresso'
+						),
+						'<a href="admin.php?page=espresso_registration_form" target="_blank">',
+						'</a>'
+					)
+				?>
             </p>
             <?php
 
-            $qsg_where['QSG_deleted'] = false;
-            $query_params             = apply_filters(
-                'FHEE__espresso_events_Registration_Form_Hooks__primary_questions__question_group_query_parameters',
-                array($qsg_where, 'order_by' => array('QSG_order' => 'ASC'))
-            );
-            $QSGs                     = EEM_Question_Group::instance()->get_all($query_params);
-            $EQGs                     = ! empty($event_id)
-                ? $this->_event->get_many_related(
-                    'Question_Group',
-                    array(array('Event_Question_Group.EQG_primary' => 1))
-                )
-                : array();
-            $EQGids                   = array_keys($EQGs);
-
-            if (! empty($QSGs)) {
-                $html = count($QSGs) > 10 ? '<div style="height:250px;overflow:auto;">' : '';
-                foreach ($QSGs as $QSG) {
-                    $checked         = in_array($QSG->ID(), $EQGids, true)
-                                       || $QSG->get('QSG_system') === 1
-                        ? ' checked="checked"'
-                        : '';
-                    $visibility      = $QSG->get('QSG_system') === 1
-                        ? ' style="visibility:hidden"'
-                        : '';
-                    $edit_query_args = $this->_adminpage_obj->is_caf() ? array(
-                        'action' => 'edit_question_group',
-                        'QSG_ID' => $QSG->ID(),
-                    ) : array('action' => 'question_groups');
-                    $edit_link       = EE_Admin_Page::add_query_args_and_nonce(
-                        $edit_query_args,
-                        EE_FORMS_ADMIN_URL
-                    );
-
-                    $html .= '
+			$qsg_where['QSG_deleted'] = false;
+			$query_params             = apply_filters(
+				'FHEE__espresso_events_Registration_Form_Hooks__primary_questions__question_group_query_parameters',
+				array($qsg_where, 'order_by' => array('QSG_order' => 'ASC'))
+			);
+			$QSGs                     = EEM_Question_Group::instance()->get_all($query_params);
+			$EQGs                     = ! empty($event_id)
+				? $this->_event->get_many_related(
+					'Question_Group',
+					array(array('Event_Question_Group.EQG_primary' => 1))
+				)
+				: array();
+			$EQGids                   = array_keys($EQGs);
+
+			if (! empty($QSGs)) {
+				$html = count($QSGs) > 10 ? '<div style="height:250px;overflow:auto;">' : '';
+				foreach ($QSGs as $QSG) {
+					$checked         = in_array($QSG->ID(), $EQGids, true)
+									   || $QSG->get('QSG_system') === 1
+						? ' checked="checked"'
+						: '';
+					$visibility      = $QSG->get('QSG_system') === 1
+						? ' style="visibility:hidden"'
+						: '';
+					$edit_query_args = $this->_adminpage_obj->is_caf() ? array(
+						'action' => 'edit_question_group',
+						'QSG_ID' => $QSG->ID(),
+					) : array('action' => 'question_groups');
+					$edit_link       = EE_Admin_Page::add_query_args_and_nonce(
+						$edit_query_args,
+						EE_FORMS_ADMIN_URL
+					);
+
+					$html .= '
 					<p id="event-question-group-' . $QSG->ID() . '">
 						<input value="' . $QSG->ID() . '" type="checkbox"'
-                             . $visibility
-                             . ' name="question_groups[' . $QSG->ID() . ']"' . $checked . ' />
+							 . $visibility
+							 . ' name="question_groups[' . $QSG->ID() . ']"' . $checked . ' />
 						<a href="' . $edit_link . '" title="'
-                             . sprintf(
-                                 esc_attr__('Edit %s Group', 'event_espresso'),
-                                 $QSG->get('QSG_name')
-                             )
-                             . '" target="_blank">' . $QSG->get('QSG_name') . '</a>
+							 . sprintf(
+								 esc_attr__('Edit %s Group', 'event_espresso'),
+								 $QSG->get('QSG_name')
+							 )
+							 . '" target="_blank">' . $QSG->get('QSG_name') . '</a>
 					</p>';
-                }
-                $html .= count($QSGs) > 10 ? '</div>' : '';
-
-                echo $html;
-            } else {
-                 esc_html_e(
-                     'There seems to be a problem with your questions. Please contact support@eventespresso.com',
-                     'event_espresso'
-                 );
-            }
-            do_action('AHEE_event_editor_questions_notice');
-            ?>
+				}
+				$html .= count($QSGs) > 10 ? '</div>' : '';
+
+				echo $html;
+			} else {
+				 esc_html_e(
+					 'There seems to be a problem with your questions. Please contact support@eventespresso.com',
+					 'event_espresso'
+				 );
+			}
+			do_action('AHEE_event_editor_questions_notice');
+			?>
         </div>
         <?php
-    }
-
-
-    /**
-     * @param EE_Event $evtobj
-     * @param array    $data
-     * @return bool
-     * @throws EE_Error
-     */
-    public function primary_question_group_update($evtobj, $data)
-    {
-        $question_groups = ! empty($data['question_groups']) ? (array)$data['question_groups'] : array();
-        $added_qgs       = array_keys($question_groups);
-        $success         = array();
-
-        //let's get all current question groups associated with this event.
-        $current_qgs = $evtobj->get_many_related(
-            'Question_Group',
-            array(array('Event_Question_Group.EQG_primary' => 1))
-        );
-        $current_qgs = array_keys($current_qgs); //we just want the ids
-
-        //now let's get the groups selected in the editor and update (IF we have data)
-        if (! empty($question_groups)) {
-            foreach ($question_groups as $id => $val) {
-                //add to event
-                if ($val) {
-                    $qg = $evtobj->_add_relation_to($id, 'Question_Group', array('EQG_primary' => 1));
-                }
-                $success[] = ! empty($qg) ? 1 : 0;
-            }
-        }
-
-        //wait a minute... are there question groups missing in the saved groups that ARE with the current event?
-        $removed_qgs = array_diff($current_qgs, $added_qgs);
-
-        foreach ($removed_qgs as $qgid) {
-            $qg        = $evtobj->_remove_relation_to($qgid, 'Question_Group', array('EQG_primary' => 1));
-            $success[] = ! empty($qg) ? 1 : 0;
-        }
-        return in_array(0, $success, true) ? false : true;
-    }
+	}
+
+
+	/**
+	 * @param EE_Event $evtobj
+	 * @param array    $data
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function primary_question_group_update($evtobj, $data)
+	{
+		$question_groups = ! empty($data['question_groups']) ? (array)$data['question_groups'] : array();
+		$added_qgs       = array_keys($question_groups);
+		$success         = array();
+
+		//let's get all current question groups associated with this event.
+		$current_qgs = $evtobj->get_many_related(
+			'Question_Group',
+			array(array('Event_Question_Group.EQG_primary' => 1))
+		);
+		$current_qgs = array_keys($current_qgs); //we just want the ids
+
+		//now let's get the groups selected in the editor and update (IF we have data)
+		if (! empty($question_groups)) {
+			foreach ($question_groups as $id => $val) {
+				//add to event
+				if ($val) {
+					$qg = $evtobj->_add_relation_to($id, 'Question_Group', array('EQG_primary' => 1));
+				}
+				$success[] = ! empty($qg) ? 1 : 0;
+			}
+		}
+
+		//wait a minute... are there question groups missing in the saved groups that ARE with the current event?
+		$removed_qgs = array_diff($current_qgs, $added_qgs);
+
+		foreach ($removed_qgs as $qgid) {
+			$qg        = $evtobj->_remove_relation_to($qgid, 'Question_Group', array('EQG_primary' => 1));
+			$success[] = ! empty($qg) ? 1 : 0;
+		}
+		return in_array(0, $success, true) ? false : true;
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -132,12 +132,12 @@ 
                     array(array('Event_Question_Group.EQG_primary' => 1))
                 )
                 : array();
-            $EQGids                   = array_keys($EQGs);
+            $EQGids = array_keys($EQGs);
 
-            if (! empty($QSGs)) {
+            if ( ! empty($QSGs)) {
                 $html = count($QSGs) > 10 ? '<div style="height:250px;overflow:auto;">' : '';
                 foreach ($QSGs as $QSG) {
-                    $checked         = in_array($QSG->ID(), $EQGids, true)
+                    $checked = in_array($QSG->ID(), $EQGids, true)
                                        || $QSG->get('QSG_system') === 1
                         ? ' checked="checked"'
                         : '';
@@ -148,22 +148,22 @@ 
                         'action' => 'edit_question_group',
                         'QSG_ID' => $QSG->ID(),
                     ) : array('action' => 'question_groups');
-                    $edit_link       = EE_Admin_Page::add_query_args_and_nonce(
+                    $edit_link = EE_Admin_Page::add_query_args_and_nonce(
                         $edit_query_args,
                         EE_FORMS_ADMIN_URL
                     );
 
                     $html .= '
-					<p id="event-question-group-' . $QSG->ID() . '">
-						<input value="' . $QSG->ID() . '" type="checkbox"'
+					<p id="event-question-group-' . $QSG->ID().'">
+						<input value="' . $QSG->ID().'" type="checkbox"'
                              . $visibility
-                             . ' name="question_groups[' . $QSG->ID() . ']"' . $checked . ' />
-						<a href="' . $edit_link . '" title="'
+                             . ' name="question_groups['.$QSG->ID().']"'.$checked.' />
+						<a href="' . $edit_link.'" title="'
                              . sprintf(
                                  esc_attr__('Edit %s Group', 'event_espresso'),
                                  $QSG->get('QSG_name')
                              )
-                             . '" target="_blank">' . $QSG->get('QSG_name') . '</a>
+                             . '" target="_blank">'.$QSG->get('QSG_name').'</a>
 					</p>';
                 }
                 $html .= count($QSGs) > 10 ? '</div>' : '';
@@ -190,7 +190,7 @@ 
      */
     public function primary_question_group_update($evtobj, $data)
     {
-        $question_groups = ! empty($data['question_groups']) ? (array)$data['question_groups'] : array();
+        $question_groups = ! empty($data['question_groups']) ? (array) $data['question_groups'] : array();
         $added_qgs       = array_keys($question_groups);
         $success         = array();
 
@@ -202,7 +202,7 @@ 
         $current_qgs = array_keys($current_qgs); //we just want the ids
 
         //now let's get the groups selected in the editor and update (IF we have data)
-        if (! empty($question_groups)) {
+        if ( ! empty($question_groups)) {
             foreach ($question_groups as $id => $val) {
                 //add to event
                 if ($val) {

caffeinated/admin/extend/registration_form/espresso_events_Registration_Form_Hooks_Extend.class.php

Indentation +189 added lines, -189 removed lines

@@ -17,208 +17,208 @@
 class espresso_events_Registration_Form_Hooks_Extend extends espresso_events_Registration_Form_Hooks
 {
     
-    /**
-     * extending the properties set in espresso_events_Registration_From_Hooks
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _extend_properties()
-    {
-        $this->_metaboxes      = array_merge(
-            $this->_metaboxes,
-            array(
-                1 => array(
-                    'page_route' => array('create_new', 'edit'),
-                    'func'       => 'additional_questions',
-                    'label'      => esc_html__('Questions for Additional Registrants', 'event_espresso'),
-                    'priority'   => 'default',
-                    'context'    => 'side',
-                ),
-            )
-        );
-        $this->_scripts_styles = array(
-            'registers' => array(
-                'extended-event-editor' => array(
-                    'url'     => EE_CORE_CAF_ADMIN_EXTEND_URL
-                                 . 'registration_form/assets/event-editor-question-groups.js',
-                    'depends' => array('jquery'),
-                ),
-            ),
-            'enqueues'  => array(
-                'extended-event-editor' => array('edit', 'create_new'),
-            ),
-        );
-    }
-
-
-    /**
-     * @param Callable[] $callbacks
-     * @return array
-     */
-    public function modify_callbacks($callbacks)
-    {
-        $callbacks   = parent::modify_callbacks($callbacks);
-        $callbacks[] = array($this, 'additional_question_group_update');
-        return $callbacks;
-    }
-
-
-    /**
-     * Call back hooked into revision restores.
-     *
-     * @param $post_id
-     * @param $revision_id
-     * @return EE_Base_Class|void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function restore_revision($post_id, $revision_id)
-    {
-        $post_evt = parent::restore_revision($post_id, $revision_id);
-
-        //restore revision for additional questions
-        $post_evt->restore_revision(
-            $revision_id,
-            array('Question_Group'),
-            array('Question_Group' => array('Event_Question_Group.EQG_primary' => 0)
-            )
-        );
-    }
-
-
-    /**
-     * @param $post_id
-     * @param $post
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function additional_questions($post_id, $post)
-    {
-        $this->_event = $this->_adminpage_obj->get_event_object();
-        $event_id     = $this->_event->ID();
-        ?>
+	/**
+	 * extending the properties set in espresso_events_Registration_From_Hooks
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _extend_properties()
+	{
+		$this->_metaboxes      = array_merge(
+			$this->_metaboxes,
+			array(
+				1 => array(
+					'page_route' => array('create_new', 'edit'),
+					'func'       => 'additional_questions',
+					'label'      => esc_html__('Questions for Additional Registrants', 'event_espresso'),
+					'priority'   => 'default',
+					'context'    => 'side',
+				),
+			)
+		);
+		$this->_scripts_styles = array(
+			'registers' => array(
+				'extended-event-editor' => array(
+					'url'     => EE_CORE_CAF_ADMIN_EXTEND_URL
+								 . 'registration_form/assets/event-editor-question-groups.js',
+					'depends' => array('jquery'),
+				),
+			),
+			'enqueues'  => array(
+				'extended-event-editor' => array('edit', 'create_new'),
+			),
+		);
+	}
+
+
+	/**
+	 * @param Callable[] $callbacks
+	 * @return array
+	 */
+	public function modify_callbacks($callbacks)
+	{
+		$callbacks   = parent::modify_callbacks($callbacks);
+		$callbacks[] = array($this, 'additional_question_group_update');
+		return $callbacks;
+	}
+
+
+	/**
+	 * Call back hooked into revision restores.
+	 *
+	 * @param $post_id
+	 * @param $revision_id
+	 * @return EE_Base_Class|void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function restore_revision($post_id, $revision_id)
+	{
+		$post_evt = parent::restore_revision($post_id, $revision_id);
+
+		//restore revision for additional questions
+		$post_evt->restore_revision(
+			$revision_id,
+			array('Question_Group'),
+			array('Question_Group' => array('Event_Question_Group.EQG_primary' => 0)
+			)
+		);
+	}
+
+
+	/**
+	 * @param $post_id
+	 * @param $post
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function additional_questions($post_id, $post)
+	{
+		$this->_event = $this->_adminpage_obj->get_event_object();
+		$event_id     = $this->_event->ID();
+		?>
         <div class="inside">
             <p><strong>
                     <?php _e('Question Groups', 'event_espresso'); ?>
                 </strong><br/>
                 <?php
-                    printf(
-                        esc_html__(
-                            'Add a pre-populated %1$sgroup of questions%2$s to your event.',
-                            'event_espresso'
-                        ),
-                        '<a href="admin.php?page=espresso_registration_form" target="_blank">',
-                        '</a>'
-                    );
-                ?>
+					printf(
+						esc_html__(
+							'Add a pre-populated %1$sgroup of questions%2$s to your event.',
+							'event_espresso'
+						),
+						'<a href="admin.php?page=espresso_registration_form" target="_blank">',
+						'</a>'
+					);
+				?>
             </p>
             <?php
 
-            $qsg_where['QSG_deleted'] = false;
-            $query_params             = apply_filters(
-                'FHEE__espresso_events_Registration_Form_Hooks_Extend__additional_questions__question_group_query_parameters',
-                array($qsg_where, 'order_by' => array('QSG_order' => 'ASC'))
-            );
-            $QSGs                     = EEM_Question_Group::instance()->get_all($query_params);
-            $EQGs                     = ! empty($event_id)
-                ? $this->_event->get_many_related(
-                    'Question_Group',
-                    array(array('Event_Question_Group.EQG_primary' => 0))
-                )
-                : array();
-            $EQGids                   = array_keys($EQGs);
-
-            if (! empty($QSGs)) {
-                $html = count($QSGs) > 10 ? '<div style="height:250px;overflow:auto;">' : '';
-                foreach ($QSGs as $QSG) {
-                    $checked   = in_array($QSG->ID(), $EQGids, true) ? ' checked="checked" ' : '';
-                    $edit_link = EE_Admin_Page::add_query_args_and_nonce(
-                        array(
-                            'action' => 'edit_question_group',
-                            'QSG_ID' => $QSG->ID(),
-                        ),
-                        EE_FORMS_ADMIN_URL
-                    );
-
-                    $html .= '
+			$qsg_where['QSG_deleted'] = false;
+			$query_params             = apply_filters(
+				'FHEE__espresso_events_Registration_Form_Hooks_Extend__additional_questions__question_group_query_parameters',
+				array($qsg_where, 'order_by' => array('QSG_order' => 'ASC'))
+			);
+			$QSGs                     = EEM_Question_Group::instance()->get_all($query_params);
+			$EQGs                     = ! empty($event_id)
+				? $this->_event->get_many_related(
+					'Question_Group',
+					array(array('Event_Question_Group.EQG_primary' => 0))
+				)
+				: array();
+			$EQGids                   = array_keys($EQGs);
+
+			if (! empty($QSGs)) {
+				$html = count($QSGs) > 10 ? '<div style="height:250px;overflow:auto;">' : '';
+				foreach ($QSGs as $QSG) {
+					$checked   = in_array($QSG->ID(), $EQGids, true) ? ' checked="checked" ' : '';
+					$edit_link = EE_Admin_Page::add_query_args_and_nonce(
+						array(
+							'action' => 'edit_question_group',
+							'QSG_ID' => $QSG->ID(),
+						),
+						EE_FORMS_ADMIN_URL
+					);
+
+					$html .= '
 					<p id="event-question-group-' . $QSG->ID() . '">
 						<input value="' . $QSG->ID() . '"'
-                        . ' type="checkbox" name="add_attendee_question_groups[' . $QSG->ID() . ']"' . $checked . ' />
+						. ' type="checkbox" name="add_attendee_question_groups[' . $QSG->ID() . ']"' . $checked . ' />
 						<a href="' . $edit_link . '" title="'
-                             . sprintf(
-                                 esc_attr__('Edit %s Group', 'event_espresso'),
-                                 $QSG->get('QSG_name')
-                             )
-                             . '" target="_blank">' . $QSG->get('QSG_name') . '</a>
+							 . sprintf(
+								 esc_attr__('Edit %s Group', 'event_espresso'),
+								 $QSG->get('QSG_name')
+							 )
+							 . '" target="_blank">' . $QSG->get('QSG_name') . '</a>
 					</p>';
-                    if ($QSG->ID() === 2) {
-                        $html .= '
+					if ($QSG->ID() === 2) {
+						$html .= '
 					<p id="question-group-requirements-notice-pg" class="important-notice small-text" style="display: none;">'
-                        . esc_html__(
-                            'The Personal Information question group is required whenever the Address Information question group is activated.',
-                            'event_espresso'
-                        )
-                        . '</p>';
-                    }
-                }
-                $html .= count($QSGs) > 10 ? '</div>' : '';
-
-                echo $html;
-
-            } else {
-                esc_html_e(
-                    'There seems to be a problem with your questions. Please contact support@eventespresso.com',
-                    'event_espresso'
-                );
-            }
-            do_action('AHEE__espresso_events_Registration_Form_Hooks__additional_questions__after_content');
-            ?>
+						. esc_html__(
+							'The Personal Information question group is required whenever the Address Information question group is activated.',
+							'event_espresso'
+						)
+						. '</p>';
+					}
+				}
+				$html .= count($QSGs) > 10 ? '</div>' : '';
+
+				echo $html;
+
+			} else {
+				esc_html_e(
+					'There seems to be a problem with your questions. Please contact support@eventespresso.com',
+					'event_espresso'
+				);
+			}
+			do_action('AHEE__espresso_events_Registration_Form_Hooks__additional_questions__after_content');
+			?>
         </div>
         <?php
-    }
-
-
-    public function additional_question_group_update($evtobj, $data)
-    {
-        $question_groups = ! empty($data['add_attendee_question_groups'])
-            ? (array) $data['add_attendee_question_groups']
-            : array();
-        $added_qgs       = array_keys($question_groups);
-        $success         = array();
-
-        //let's get all current question groups associated with this event.
-        $current_qgs = $evtobj->get_many_related(
-            'Question_Group',
-            array(array('Event_Question_Group.EQG_primary' => 0))
-        );
-        $current_qgs = array_keys($current_qgs); //we just want the ids
-
-        //now let's get the groups selected in the editor and update (IF we have data)
-        if (! empty($question_groups)) {
-            foreach ($question_groups as $id => $val) {
-                //add to event
-                if ($val) {
-                    $qg = $evtobj->_add_relation_to($id, 'Question_Group', array('EQG_primary' => 0));
-                }
-                $success[] = ! empty($qg) ? 1 : 0;
-            }
-        }
-
-        //wait a minute... are there question groups missing in the saved groups that ARE with the current event?
-        $removed_qgs = array_diff($current_qgs, $added_qgs);
-
-        foreach ($removed_qgs as $qgid) {
-            $qg        = $evtobj->_remove_relation_to($qgid, 'Question_Group', array('EQG_primary' => 0));
-            $success[] = ! empty($qg) ? 1 : 0;
-        }
-
-
-        return in_array(0, $success, true) ? false : true;
-    }
+	}
+
+
+	public function additional_question_group_update($evtobj, $data)
+	{
+		$question_groups = ! empty($data['add_attendee_question_groups'])
+			? (array) $data['add_attendee_question_groups']
+			: array();
+		$added_qgs       = array_keys($question_groups);
+		$success         = array();
+
+		//let's get all current question groups associated with this event.
+		$current_qgs = $evtobj->get_many_related(
+			'Question_Group',
+			array(array('Event_Question_Group.EQG_primary' => 0))
+		);
+		$current_qgs = array_keys($current_qgs); //we just want the ids
+
+		//now let's get the groups selected in the editor and update (IF we have data)
+		if (! empty($question_groups)) {
+			foreach ($question_groups as $id => $val) {
+				//add to event
+				if ($val) {
+					$qg = $evtobj->_add_relation_to($id, 'Question_Group', array('EQG_primary' => 0));
+				}
+				$success[] = ! empty($qg) ? 1 : 0;
+			}
+		}
+
+		//wait a minute... are there question groups missing in the saved groups that ARE with the current event?
+		$removed_qgs = array_diff($current_qgs, $added_qgs);
+
+		foreach ($removed_qgs as $qgid) {
+			$qg        = $evtobj->_remove_relation_to($qgid, 'Question_Group', array('EQG_primary' => 0));
+			$success[] = ! empty($qg) ? 1 : 0;
+		}
+
+
+		return in_array(0, $success, true) ? false : true;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -25,7 +25,7 @@ 
      */
     protected function _extend_properties()
     {
-        $this->_metaboxes      = array_merge(
+        $this->_metaboxes = array_merge(
             $this->_metaboxes,
             array(
                 1 => array(
@@ -132,9 +132,9 @@ 
                     array(array('Event_Question_Group.EQG_primary' => 0))
                 )
                 : array();
-            $EQGids                   = array_keys($EQGs);
+            $EQGids = array_keys($EQGs);
 
-            if (! empty($QSGs)) {
+            if ( ! empty($QSGs)) {
                 $html = count($QSGs) > 10 ? '<div style="height:250px;overflow:auto;">' : '';
                 foreach ($QSGs as $QSG) {
                     $checked   = in_array($QSG->ID(), $EQGids, true) ? ' checked="checked" ' : '';
@@ -147,15 +147,15 @@ 
                     );
 
                     $html .= '
-					<p id="event-question-group-' . $QSG->ID() . '">
-						<input value="' . $QSG->ID() . '"'
-                        . ' type="checkbox" name="add_attendee_question_groups[' . $QSG->ID() . ']"' . $checked . ' />
-						<a href="' . $edit_link . '" title="'
+					<p id="event-question-group-' . $QSG->ID().'">
+						<input value="' . $QSG->ID().'"'
+                        . ' type="checkbox" name="add_attendee_question_groups['.$QSG->ID().']"'.$checked.' />
+						<a href="' . $edit_link.'" title="'
                              . sprintf(
                                  esc_attr__('Edit %s Group', 'event_espresso'),
                                  $QSG->get('QSG_name')
                              )
-                             . '" target="_blank">' . $QSG->get('QSG_name') . '</a>
+                             . '" target="_blank">'.$QSG->get('QSG_name').'</a>
 					</p>';
                     if ($QSG->ID() === 2) {
                         $html .= '
@@ -200,7 +200,7 @@ 
         $current_qgs = array_keys($current_qgs); //we just want the ids
 
         //now let's get the groups selected in the editor and update (IF we have data)
-        if (! empty($question_groups)) {
+        if ( ! empty($question_groups)) {
             foreach ($question_groups as $id => $val) {
                 //add to event
                 if ($val) {

payment_methods/Paypal_Express/EEG_Paypal_Express.gateway.php

Indentation +580 added lines, -580 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 
@@ -17,585 +17,585 @@ 
 class EEG_Paypal_Express extends EE_Offsite_Gateway
 {
 
-    /**
-     * Merchant API Username.
-     *
-     * @var string
-     */
-    protected $_api_username;
-
-    /**
-     * Merchant API Password.
-     *
-     * @var string
-     */
-    protected $_api_password;
-
-    /**
-     * API Signature.
-     *
-     * @var string
-     */
-    protected $_api_signature;
-
-    /**
-     * Request Shipping address on PP checkout page.
-     *
-     * @var string
-     */
-    protected $_request_shipping_addr;
-
-    /**
-     * Business/personal logo.
-     *
-     * @var string
-     */
-    protected $_image_url;
-
-    /**
-     * gateway URL variable
-     *
-     * @var string
-     */
-    protected $_base_gateway_url = '';
-
-
-
-    /**
-     * EEG_Paypal_Express constructor.
-     */
-    public function __construct()
-    {
-        $this->_currencies_supported = array(
-            'USD',
-            'AUD',
-            'BRL',
-            'CAD',
-            'CZK',
-            'DKK',
-            'EUR',
-            'HKD',
-            'HUF',
-            'ILS',
-            'JPY',
-            'MYR',
-            'MXN',
-            'NOK',
-            'NZD',
-            'PHP',
-            'PLN',
-            'GBP',
-            'RUB',
-            'SGD',
-            'SEK',
-            'CHF',
-            'TWD',
-            'THB',
-            'TRY',
-        );
-        parent::__construct();
-    }
-
-
-
-    /**
-     * Sets the gateway URL variable based on whether debug mode is enabled or not.
-     *
-     * @param array $settings_array
-     */
-    public function set_settings($settings_array)
-    {
-        parent::set_settings($settings_array);
-        // Redirect URL.
-        $this->_base_gateway_url = $this->_debug_mode
-            ? 'https://api-3t.sandbox.paypal.com/nvp'
-            : 'https://api-3t.paypal.com/nvp';
-    }
-
-
-
-    /**
-     * @param EEI_Payment $payment
-     * @param array       $billing_info
-     * @param string      $return_url
-     * @param string      $notify_url
-     * @param string      $cancel_url
-     * @return \EE_Payment|\EEI_Payment
-     * @throws \EE_Error
-     */
-    public function set_redirection_info(
-        $payment,
-        $billing_info = array(),
-        $return_url = null,
-        $notify_url = null,
-        $cancel_url = null
-    ) {
-        if (! $payment instanceof EEI_Payment) {
-            $payment->set_gateway_response(
-                __(
-                    'Error. No associated payment was found.',
-                    'event_espresso'
-                )
-            );
-            $payment->set_status($this->_pay_model->failed_status());
-            return $payment;
-        }
-        $transaction = $payment->transaction();
-        if (! $transaction instanceof EEI_Transaction) {
-            $payment->set_gateway_response(
-                __(
-                    'Could not process this payment because it has no associated transaction.',
-                    'event_espresso'
-                )
-            );
-            $payment->set_status($this->_pay_model->failed_status());
-            return $payment;
-        }
-        $order_description = substr($this->_format_order_description($payment), 0, 127);
-        $primary_registration = $transaction->primary_registration();
-        $primary_attendee = $primary_registration instanceof EE_Registration
-            ? $primary_registration->attendee()
-            : false;
-        $locale = explode('-', get_bloginfo('language'));
-        // Gather request parameters.
-        $token_request_dtls = array(
-            'METHOD'                         => 'SetExpressCheckout',
-            'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
-            'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
-            'PAYMENTREQUEST_0_DESC'          => $order_description,
-            'RETURNURL'                      => $return_url,
-            'CANCELURL'                      => $cancel_url,
-            'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
-            // Buyer does not need to create a PayPal account to check out.
-            // This is referred to as PayPal Account Optional.
-            'SOLUTIONTYPE'                   => 'Sole',
-            //EE will blow up if you change this
-            'BUTTONSOURCE'                   => 'EventEspresso_SP',
-            // Locale of the pages displayed by PayPal during Express Checkout.
-            'LOCALECODE'                     => $locale[1]
-        );
-        // Show itemized list.
-        if ($this->_money->compare_floats($payment->amount(), $transaction->total(), '==')) {
-            $item_num = 0;
-            $itemized_sum = 0;
-            $total_line_items = $transaction->total_line_item();
-            // Go through each item in the list.
-            foreach ($total_line_items->get_items() as $line_item) {
-                if ($line_item instanceof EE_Line_Item) {
-                    // PayPal doesn't like line items with 0.00 amount, so we may skip those.
-                    if (EEH_Money::compare_floats($line_item->total(), '0.00', '==')) {
-                        continue;
-                    }
-                    $unit_price = $line_item->unit_price();
-                    $line_item_quantity = $line_item->quantity();
-                    // This is a discount.
-                    if ($line_item->is_percent()) {
-                        $unit_price = $line_item->total();
-                        $line_item_quantity = 1;
-                    }
-                    // Item Name.
-                    $token_request_dtls['L_PAYMENTREQUEST_0_NAME' . $item_num] = substr(
-                        $this->_format_line_item_name($line_item, $payment),
-                        0,
-                        127
-                    );
-                    // Item description.
-                    $token_request_dtls['L_PAYMENTREQUEST_0_DESC' . $item_num] = substr(
-                        $this->_format_line_item_desc($line_item, $payment),
-                        0,
-                        127
-                    );
-                    // Cost of individual item.
-                    $token_request_dtls['L_PAYMENTREQUEST_0_AMT' . $item_num] = $this->format_currency($unit_price);
-                    // Item Number.
-                    $token_request_dtls['L_PAYMENTREQUEST_0_NUMBER' . $item_num] = $item_num + 1;
-                    // Item quantity.
-                    $token_request_dtls['L_PAYMENTREQUEST_0_QTY' . $item_num] = $line_item_quantity;
-                    // Digital item is sold.
-                    $token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num] = 'Physical';
-                    $itemized_sum += $line_item->total();
-                    ++$item_num;
-                }
-            }
-            // Item's sales S/H and tax amount.
-            $token_request_dtls['PAYMENTREQUEST_0_ITEMAMT'] = $total_line_items->get_items_total();
-            $token_request_dtls['PAYMENTREQUEST_0_TAXAMT'] = $total_line_items->get_total_tax();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
-            $token_request_dtls['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
-            $itemized_sum_diff_from_txn_total = round(
-                $transaction->total() - $itemized_sum - $total_line_items->get_total_tax(),
-                2
-            );
-            // If we were not able to recognize some item like promotion, surcharge or cancellation,
-            // add the difference as an extra line item.
-            if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) {
-                // Item Name.
-                $token_request_dtls['L_PAYMENTREQUEST_0_NAME' . $item_num] = substr(
-                    __(
-                        'Other (promotion/surcharge/cancellation)',
-                        'event_espresso'
-                    ),
-                    0,
-                    127
-                );
-                // Item description.
-                $token_request_dtls['L_PAYMENTREQUEST_0_DESC' . $item_num] = '';
-                // Cost of individual item.
-                $token_request_dtls['L_PAYMENTREQUEST_0_AMT' . $item_num] = $this->format_currency(
-                    $itemized_sum_diff_from_txn_total
-                );
-                // Item Number.
-                $token_request_dtls['L_PAYMENTREQUEST_0_NUMBER' . $item_num] = $item_num + 1;
-                // Item quantity.
-                $token_request_dtls['L_PAYMENTREQUEST_0_QTY' . $item_num] = 1;
-                // Digital item is sold.
-                $token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num] = 'Physical';
-                $item_num++;
-            }
-        } else {
-            // Just one Item.
-            // Item Name.
-            $token_request_dtls['L_PAYMENTREQUEST_0_NAME0'] = substr(
-                $this->_format_partial_payment_line_item_name($payment),
-                0,
-                127
-            );
-            // Item description.
-            $token_request_dtls['L_PAYMENTREQUEST_0_DESC0'] = substr(
-                $this->_format_partial_payment_line_item_desc($payment),
-                0,
-                127
-            );
-            // Cost of individual item.
-            $token_request_dtls['L_PAYMENTREQUEST_0_AMT0'] = $this->format_currency($payment->amount());
-            // Item Number.
-            $token_request_dtls['L_PAYMENTREQUEST_0_NUMBER0'] = 1;
-            // Item quantity.
-            $token_request_dtls['L_PAYMENTREQUEST_0_QTY0'] = 1;
-            // Digital item is sold.
-            $token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY0'] = 'Physical';
-            // Item's sales S/H and tax amount.
-            $token_request_dtls['PAYMENTREQUEST_0_ITEMAMT'] = $this->format_currency($payment->amount());
-            $token_request_dtls['PAYMENTREQUEST_0_TAXAMT'] = '0';
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
-            $token_request_dtls['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
-        }
-        // Automatically filling out shipping and contact information.
-        if ($this->_request_shipping_addr && $primary_attendee instanceof EEI_Attendee) {
-            //  If you do not pass the shipping address, PayPal obtains it from the buyer's account profile.
-            $token_request_dtls['NOSHIPPING'] = '2';
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET'] = $primary_attendee->address();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET2'] = $primary_attendee->address2();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOCITY'] = $primary_attendee->city();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTATE'] = $primary_attendee->state_abbrev();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE'] = $primary_attendee->country_ID();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
-            $token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
-            $token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
-        } elseif (! $this->_request_shipping_addr) {
-            // Do not request shipping details on the PP Checkout page.
-            $token_request_dtls['NOSHIPPING'] = '1';
-            $token_request_dtls['REQCONFIRMSHIPPING'] = '0';
-        }
-        // Used a business/personal logo on the PayPal page.
-        if (! empty($this->_image_url)) {
-            $token_request_dtls['LOGOIMG'] = $this->_image_url;
-        }
-        $token_request_dtls = apply_filters(
-            'FHEE__EEG_Paypal_Express__set_redirection_info__arguments',
-            $token_request_dtls,
-            $this
-        );
-        // Request PayPal token.
-        $token_request_response = $this->_ppExpress_request($token_request_dtls, 'Payment Token', $payment);
-        $token_rstatus = $this->_ppExpress_check_response($token_request_response);
-        $response_args = (isset($token_rstatus['args']) && is_array($token_rstatus['args']))
-            ? $token_rstatus['args']
-            : array();
-        if ($token_rstatus['status']) {
-            // We got the Token so we may continue with the payment and redirect the client.
-            $payment->set_details($response_args);
-            $gateway_url = $this->_debug_mode ? 'https://www.sandbox.paypal.com' : 'https://www.paypal.com';
-            $payment->set_redirect_url(
-                $gateway_url
-                . '/checkoutnow?useraction=commit&cmd=_express-checkout&token='
-                . $response_args['TOKEN']
-            );
-        } else {
-            if (isset($response_args['L_ERRORCODE'])) {
-                $payment->set_gateway_response($response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']);
-            } else {
-                $payment->set_gateway_response(
-                    esc_html__(
-                        'Error occurred while trying to setup the Express Checkout.',
-                        'event_espresso'
-                    )
-                );
-            }
-            $payment->set_details($response_args);
-            $payment->set_status($this->_pay_model->failed_status());
-        }
-        return $payment;
-    }
-
-
-
-    /**
-     * @param array           $update_info {
-     * @type string           $gateway_txn_id
-     * @type string status an EEMI_Payment status
-     *                                     }
-     * @param EEI_Transaction $transaction
-     * @return EEI_Payment
-     */
-    public function handle_payment_update($update_info, $transaction)
-    {
-        $payment = $transaction instanceof EEI_Transaction ? $transaction->last_payment() : null;
-        if ($payment instanceof EEI_Payment) {
-            $this->log(array('Return from Authorization' => $update_info), $payment);
-            $transaction = $payment->transaction();
-            if (! $transaction instanceof EEI_Transaction) {
-                $payment->set_gateway_response(
-                    __(
-                        'Could not process this payment because it has no associated transaction.',
-                        'event_espresso'
-                    )
-                );
-                $payment->set_status($this->_pay_model->failed_status());
-                return $payment;
-            }
-            $primary_registrant = $transaction->primary_registration();
-            $payment_details = $payment->details();
-            // Check if we still have the token.
-            if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
-                $payment->set_status($this->_pay_model->failed_status());
-                return $payment;
-            }
-            $cdetails_request_dtls = array(
-                'METHOD' => 'GetExpressCheckoutDetails',
-                'TOKEN'  => $payment_details['TOKEN'],
-            );
-            // Request Customer Details.
-            $cdetails_request_response = $this->_ppExpress_request(
-                $cdetails_request_dtls,
-                'Customer Details',
-                $payment
-            );
-            $cdetails_rstatus = $this->_ppExpress_check_response($cdetails_request_response);
-            $cdata_response_args = (isset($cdetails_rstatus['args']) && is_array($cdetails_rstatus['args']))
-                ? $cdetails_rstatus['args']
-                : array();
-            if ($cdetails_rstatus['status']) {
-                // We got the PayerID so now we can Complete the transaction.
-                $docheckout_request_dtls = array(
-                    'METHOD'                         => 'DoExpressCheckoutPayment',
-                    'PAYERID'                        => $cdata_response_args['PAYERID'],
-                    'TOKEN'                          => $payment_details['TOKEN'],
-                    'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
-                    'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
-                    'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
-                );
-                // Payment Checkout/Capture.
-                $docheckout_request_response = $this->_ppExpress_request(
-                    $docheckout_request_dtls,
-                    'Do Payment',
-                    $payment
-                );
-                $docheckout_rstatus = $this->_ppExpress_check_response($docheckout_request_response);
-                $docheckout_response_args = (isset($docheckout_rstatus['args']) && is_array($docheckout_rstatus['args']))
-                    ? $docheckout_rstatus['args']
-                    : array();
-                if ($docheckout_rstatus['status']) {
-                    // All is well, payment approved.
-                    $primary_registration_code = $primary_registrant instanceof EE_Registration ?
-                        $primary_registrant->reg_code()
-                        : '';
-                    $payment->set_extra_accntng($primary_registration_code);
-                    $payment->set_amount(isset($docheckout_response_args['PAYMENTINFO_0_AMT'])
-                        ? (float)$docheckout_response_args['PAYMENTINFO_0_AMT']
-                        : 0);
-                    $payment->set_txn_id_chq_nmbr(isset($docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'])
-                        ? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID']
-                        : null);
-                    $payment->set_details($cdata_response_args);
-                    $payment->set_gateway_response(isset($docheckout_response_args['PAYMENTINFO_0_ACK'])
-                        ? $docheckout_response_args['PAYMENTINFO_0_ACK']
-                        : '');
-                    $payment->set_status($this->_pay_model->approved_status());
-                } else {
-                    if (isset($docheckout_response_args['L_ERRORCODE'])) {
-                        $payment->set_gateway_response(
-                            $docheckout_response_args['L_ERRORCODE']
-                            . '; '
-                            . $docheckout_response_args['L_SHORTMESSAGE']
-                        );
-                    } else {
-                        $payment->set_gateway_response(
-                            __(
-                                'Error occurred while trying to Capture the funds.',
-                                'event_espresso'
-                            )
-                        );
-                    }
-                    $payment->set_details($docheckout_response_args);
-                    $payment->set_status($this->_pay_model->declined_status());
-                }
-            } else {
-                if (isset($cdata_response_args['L_ERRORCODE'])) {
-                    $payment->set_gateway_response(
-                        $cdata_response_args['L_ERRORCODE']
-                        . '; '
-                        . $cdata_response_args['L_SHORTMESSAGE']
-                    );
-                } else {
-                    $payment->set_gateway_response(
-                        __(
-                            'Error occurred while trying to get payment Details from PayPal.',
-                            'event_espresso'
-                        )
-                    );
-                }
-                $payment->set_details($cdata_response_args);
-                $payment->set_status($this->_pay_model->failed_status());
-            }
-        } else {
-            $payment->set_gateway_response(__('Error occurred while trying to process the payment.', 'event_espresso'));
-            $payment->set_status($this->_pay_model->failed_status());
-        }
-        return $payment;
-    }
-
-
-
-    /**
-     *  Make the Express checkout request.
-     *
-     * @param array       $request_params
-     * @param string      $request_text
-     * @param EEI_Payment $payment
-     * @return mixed
-     */
-    public function _ppExpress_request($request_params, $request_text, $payment)
-    {
-        $request_dtls = array(
-            'VERSION'   => '204.0',
-            'USER'      => urlencode($this->_api_username),
-            'PWD'       => urlencode($this->_api_password),
-            'SIGNATURE' => urlencode($this->_api_signature),
-        );
-        $dtls = array_merge($request_dtls, $request_params);
-        $this->_log_clean_request($dtls, $payment, $request_text . ' Request');
-        // Request Customer Details.
-        $request_response = wp_remote_post(
-            $this->_base_gateway_url,
-            array(
-                'method'      => 'POST',
-                'timeout'     => 45,
-                'httpversion' => '1.1',
-                'cookies'     => array(),
-                'headers'     => array(),
-                'body'        => http_build_query($dtls),
-            )
-        );
-        // Log the response.
-        $this->log(array($request_text . ' Response' => $request_response), $payment);
-        return $request_response;
-    }
-
-
-
-    /**
-     *  Check the response status.
-     *
-     * @param mixed $request_response
-     * @return array
-     */
-    public function _ppExpress_check_response($request_response)
-    {
-        if (is_wp_error($request_response) || empty($request_response['body'])) {
-            // If we got here then there was an error in this request.
-            return array('status' => false, 'args' => $request_response);
-        }
-        $response_args = array();
-        parse_str(urldecode($request_response['body']), $response_args);
-        if (! isset($response_args['ACK'])) {
-            return array('status' => false, 'args' => $request_response);
-        }
-        if (
-            (
-                isset($response_args['PAYERID'])
-                || isset($response_args['TOKEN'])
-                || isset($response_args['PAYMENTINFO_0_TRANSACTIONID'])
-                || (isset($response_args['PAYMENTSTATUS']) && $response_args['PAYMENTSTATUS'] === 'Completed')
-            )
-            && in_array($response_args['ACK'], array('Success', 'SuccessWithWarning'), true)
-        ) {
-            // Response status OK, return response parameters for further processing.
-            return array('status' => true, 'args' => $response_args);
-        }
-        $errors = $this->_get_errors($response_args);
-        return array('status' => false, 'args' => $errors);
-    }
-
-
-
-    /**
-     *  Log a "Cleared" request.
-     *
-     * @param array       $request
-     * @param EEI_Payment $payment
-     * @param string      $info
-     * @return void
-     */
-    private function _log_clean_request($request, $payment, $info)
-    {
-        $cleaned_request_data = $request;
-        unset($cleaned_request_data['PWD'], $cleaned_request_data['USER'], $cleaned_request_data['SIGNATURE']);
-        $this->log(array($info => $cleaned_request_data), $payment);
-    }
-
-
-
-    /**
-     *  Get error from the response data.
-     *
-     * @param array $data_array
-     * @return array
-     */
-    private function _get_errors($data_array)
-    {
-        $errors = array();
-        $n = 0;
-        while (isset($data_array["L_ERRORCODE{$n}"])) {
-            $l_error_code = isset($data_array["L_ERRORCODE{$n}"])
-                ? $data_array["L_ERRORCODE{$n}"]
-                : '';
-            $l_severity_code = isset($data_array["L_SEVERITYCODE{$n}"])
-                ? $data_array["L_SEVERITYCODE{$n}"]
-                : '';
-            $l_short_message = isset($data_array["L_SHORTMESSAGE{$n}"])
-                ? $data_array["L_SHORTMESSAGE{$n}"]
-                : '';
-            $l_long_message = isset($data_array["L_LONGMESSAGE{$n}"])
-                ? $data_array["L_LONGMESSAGE{$n}"]
-                : '';
-            if ($n === 0) {
-                $errors = array(
-                    'L_ERRORCODE'    => $l_error_code,
-                    'L_SHORTMESSAGE' => $l_short_message,
-                    'L_LONGMESSAGE'  => $l_long_message,
-                    'L_SEVERITYCODE' => $l_severity_code,
-                );
-            } else {
-                $errors['L_ERRORCODE'] .= ', ' . $l_error_code;
-                $errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
-                $errors['L_LONGMESSAGE'] .= ', ' . $l_long_message;
-                $errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
-            }
-            $n++;
-        }
-        return $errors;
-    }
+	/**
+	 * Merchant API Username.
+	 *
+	 * @var string
+	 */
+	protected $_api_username;
+
+	/**
+	 * Merchant API Password.
+	 *
+	 * @var string
+	 */
+	protected $_api_password;
+
+	/**
+	 * API Signature.
+	 *
+	 * @var string
+	 */
+	protected $_api_signature;
+
+	/**
+	 * Request Shipping address on PP checkout page.
+	 *
+	 * @var string
+	 */
+	protected $_request_shipping_addr;
+
+	/**
+	 * Business/personal logo.
+	 *
+	 * @var string
+	 */
+	protected $_image_url;
+
+	/**
+	 * gateway URL variable
+	 *
+	 * @var string
+	 */
+	protected $_base_gateway_url = '';
+
+
+
+	/**
+	 * EEG_Paypal_Express constructor.
+	 */
+	public function __construct()
+	{
+		$this->_currencies_supported = array(
+			'USD',
+			'AUD',
+			'BRL',
+			'CAD',
+			'CZK',
+			'DKK',
+			'EUR',
+			'HKD',
+			'HUF',
+			'ILS',
+			'JPY',
+			'MYR',
+			'MXN',
+			'NOK',
+			'NZD',
+			'PHP',
+			'PLN',
+			'GBP',
+			'RUB',
+			'SGD',
+			'SEK',
+			'CHF',
+			'TWD',
+			'THB',
+			'TRY',
+		);
+		parent::__construct();
+	}
+
+
+
+	/**
+	 * Sets the gateway URL variable based on whether debug mode is enabled or not.
+	 *
+	 * @param array $settings_array
+	 */
+	public function set_settings($settings_array)
+	{
+		parent::set_settings($settings_array);
+		// Redirect URL.
+		$this->_base_gateway_url = $this->_debug_mode
+			? 'https://api-3t.sandbox.paypal.com/nvp'
+			: 'https://api-3t.paypal.com/nvp';
+	}
+
+
+
+	/**
+	 * @param EEI_Payment $payment
+	 * @param array       $billing_info
+	 * @param string      $return_url
+	 * @param string      $notify_url
+	 * @param string      $cancel_url
+	 * @return \EE_Payment|\EEI_Payment
+	 * @throws \EE_Error
+	 */
+	public function set_redirection_info(
+		$payment,
+		$billing_info = array(),
+		$return_url = null,
+		$notify_url = null,
+		$cancel_url = null
+	) {
+		if (! $payment instanceof EEI_Payment) {
+			$payment->set_gateway_response(
+				__(
+					'Error. No associated payment was found.',
+					'event_espresso'
+				)
+			);
+			$payment->set_status($this->_pay_model->failed_status());
+			return $payment;
+		}
+		$transaction = $payment->transaction();
+		if (! $transaction instanceof EEI_Transaction) {
+			$payment->set_gateway_response(
+				__(
+					'Could not process this payment because it has no associated transaction.',
+					'event_espresso'
+				)
+			);
+			$payment->set_status($this->_pay_model->failed_status());
+			return $payment;
+		}
+		$order_description = substr($this->_format_order_description($payment), 0, 127);
+		$primary_registration = $transaction->primary_registration();
+		$primary_attendee = $primary_registration instanceof EE_Registration
+			? $primary_registration->attendee()
+			: false;
+		$locale = explode('-', get_bloginfo('language'));
+		// Gather request parameters.
+		$token_request_dtls = array(
+			'METHOD'                         => 'SetExpressCheckout',
+			'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
+			'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
+			'PAYMENTREQUEST_0_DESC'          => $order_description,
+			'RETURNURL'                      => $return_url,
+			'CANCELURL'                      => $cancel_url,
+			'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
+			// Buyer does not need to create a PayPal account to check out.
+			// This is referred to as PayPal Account Optional.
+			'SOLUTIONTYPE'                   => 'Sole',
+			//EE will blow up if you change this
+			'BUTTONSOURCE'                   => 'EventEspresso_SP',
+			// Locale of the pages displayed by PayPal during Express Checkout.
+			'LOCALECODE'                     => $locale[1]
+		);
+		// Show itemized list.
+		if ($this->_money->compare_floats($payment->amount(), $transaction->total(), '==')) {
+			$item_num = 0;
+			$itemized_sum = 0;
+			$total_line_items = $transaction->total_line_item();
+			// Go through each item in the list.
+			foreach ($total_line_items->get_items() as $line_item) {
+				if ($line_item instanceof EE_Line_Item) {
+					// PayPal doesn't like line items with 0.00 amount, so we may skip those.
+					if (EEH_Money::compare_floats($line_item->total(), '0.00', '==')) {
+						continue;
+					}
+					$unit_price = $line_item->unit_price();
+					$line_item_quantity = $line_item->quantity();
+					// This is a discount.
+					if ($line_item->is_percent()) {
+						$unit_price = $line_item->total();
+						$line_item_quantity = 1;
+					}
+					// Item Name.
+					$token_request_dtls['L_PAYMENTREQUEST_0_NAME' . $item_num] = substr(
+						$this->_format_line_item_name($line_item, $payment),
+						0,
+						127
+					);
+					// Item description.
+					$token_request_dtls['L_PAYMENTREQUEST_0_DESC' . $item_num] = substr(
+						$this->_format_line_item_desc($line_item, $payment),
+						0,
+						127
+					);
+					// Cost of individual item.
+					$token_request_dtls['L_PAYMENTREQUEST_0_AMT' . $item_num] = $this->format_currency($unit_price);
+					// Item Number.
+					$token_request_dtls['L_PAYMENTREQUEST_0_NUMBER' . $item_num] = $item_num + 1;
+					// Item quantity.
+					$token_request_dtls['L_PAYMENTREQUEST_0_QTY' . $item_num] = $line_item_quantity;
+					// Digital item is sold.
+					$token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num] = 'Physical';
+					$itemized_sum += $line_item->total();
+					++$item_num;
+				}
+			}
+			// Item's sales S/H and tax amount.
+			$token_request_dtls['PAYMENTREQUEST_0_ITEMAMT'] = $total_line_items->get_items_total();
+			$token_request_dtls['PAYMENTREQUEST_0_TAXAMT'] = $total_line_items->get_total_tax();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
+			$token_request_dtls['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
+			$itemized_sum_diff_from_txn_total = round(
+				$transaction->total() - $itemized_sum - $total_line_items->get_total_tax(),
+				2
+			);
+			// If we were not able to recognize some item like promotion, surcharge or cancellation,
+			// add the difference as an extra line item.
+			if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) {
+				// Item Name.
+				$token_request_dtls['L_PAYMENTREQUEST_0_NAME' . $item_num] = substr(
+					__(
+						'Other (promotion/surcharge/cancellation)',
+						'event_espresso'
+					),
+					0,
+					127
+				);
+				// Item description.
+				$token_request_dtls['L_PAYMENTREQUEST_0_DESC' . $item_num] = '';
+				// Cost of individual item.
+				$token_request_dtls['L_PAYMENTREQUEST_0_AMT' . $item_num] = $this->format_currency(
+					$itemized_sum_diff_from_txn_total
+				);
+				// Item Number.
+				$token_request_dtls['L_PAYMENTREQUEST_0_NUMBER' . $item_num] = $item_num + 1;
+				// Item quantity.
+				$token_request_dtls['L_PAYMENTREQUEST_0_QTY' . $item_num] = 1;
+				// Digital item is sold.
+				$token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num] = 'Physical';
+				$item_num++;
+			}
+		} else {
+			// Just one Item.
+			// Item Name.
+			$token_request_dtls['L_PAYMENTREQUEST_0_NAME0'] = substr(
+				$this->_format_partial_payment_line_item_name($payment),
+				0,
+				127
+			);
+			// Item description.
+			$token_request_dtls['L_PAYMENTREQUEST_0_DESC0'] = substr(
+				$this->_format_partial_payment_line_item_desc($payment),
+				0,
+				127
+			);
+			// Cost of individual item.
+			$token_request_dtls['L_PAYMENTREQUEST_0_AMT0'] = $this->format_currency($payment->amount());
+			// Item Number.
+			$token_request_dtls['L_PAYMENTREQUEST_0_NUMBER0'] = 1;
+			// Item quantity.
+			$token_request_dtls['L_PAYMENTREQUEST_0_QTY0'] = 1;
+			// Digital item is sold.
+			$token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY0'] = 'Physical';
+			// Item's sales S/H and tax amount.
+			$token_request_dtls['PAYMENTREQUEST_0_ITEMAMT'] = $this->format_currency($payment->amount());
+			$token_request_dtls['PAYMENTREQUEST_0_TAXAMT'] = '0';
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0';
+			$token_request_dtls['PAYMENTREQUEST_0_HANDLINGAMT'] = '0';
+		}
+		// Automatically filling out shipping and contact information.
+		if ($this->_request_shipping_addr && $primary_attendee instanceof EEI_Attendee) {
+			//  If you do not pass the shipping address, PayPal obtains it from the buyer's account profile.
+			$token_request_dtls['NOSHIPPING'] = '2';
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET'] = $primary_attendee->address();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET2'] = $primary_attendee->address2();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOCITY'] = $primary_attendee->city();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTATE'] = $primary_attendee->state_abbrev();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE'] = $primary_attendee->country_ID();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
+			$token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
+			$token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
+		} elseif (! $this->_request_shipping_addr) {
+			// Do not request shipping details on the PP Checkout page.
+			$token_request_dtls['NOSHIPPING'] = '1';
+			$token_request_dtls['REQCONFIRMSHIPPING'] = '0';
+		}
+		// Used a business/personal logo on the PayPal page.
+		if (! empty($this->_image_url)) {
+			$token_request_dtls['LOGOIMG'] = $this->_image_url;
+		}
+		$token_request_dtls = apply_filters(
+			'FHEE__EEG_Paypal_Express__set_redirection_info__arguments',
+			$token_request_dtls,
+			$this
+		);
+		// Request PayPal token.
+		$token_request_response = $this->_ppExpress_request($token_request_dtls, 'Payment Token', $payment);
+		$token_rstatus = $this->_ppExpress_check_response($token_request_response);
+		$response_args = (isset($token_rstatus['args']) && is_array($token_rstatus['args']))
+			? $token_rstatus['args']
+			: array();
+		if ($token_rstatus['status']) {
+			// We got the Token so we may continue with the payment and redirect the client.
+			$payment->set_details($response_args);
+			$gateway_url = $this->_debug_mode ? 'https://www.sandbox.paypal.com' : 'https://www.paypal.com';
+			$payment->set_redirect_url(
+				$gateway_url
+				. '/checkoutnow?useraction=commit&cmd=_express-checkout&token='
+				. $response_args['TOKEN']
+			);
+		} else {
+			if (isset($response_args['L_ERRORCODE'])) {
+				$payment->set_gateway_response($response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']);
+			} else {
+				$payment->set_gateway_response(
+					esc_html__(
+						'Error occurred while trying to setup the Express Checkout.',
+						'event_espresso'
+					)
+				);
+			}
+			$payment->set_details($response_args);
+			$payment->set_status($this->_pay_model->failed_status());
+		}
+		return $payment;
+	}
+
+
+
+	/**
+	 * @param array           $update_info {
+	 * @type string           $gateway_txn_id
+	 * @type string status an EEMI_Payment status
+	 *                                     }
+	 * @param EEI_Transaction $transaction
+	 * @return EEI_Payment
+	 */
+	public function handle_payment_update($update_info, $transaction)
+	{
+		$payment = $transaction instanceof EEI_Transaction ? $transaction->last_payment() : null;
+		if ($payment instanceof EEI_Payment) {
+			$this->log(array('Return from Authorization' => $update_info), $payment);
+			$transaction = $payment->transaction();
+			if (! $transaction instanceof EEI_Transaction) {
+				$payment->set_gateway_response(
+					__(
+						'Could not process this payment because it has no associated transaction.',
+						'event_espresso'
+					)
+				);
+				$payment->set_status($this->_pay_model->failed_status());
+				return $payment;
+			}
+			$primary_registrant = $transaction->primary_registration();
+			$payment_details = $payment->details();
+			// Check if we still have the token.
+			if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
+				$payment->set_status($this->_pay_model->failed_status());
+				return $payment;
+			}
+			$cdetails_request_dtls = array(
+				'METHOD' => 'GetExpressCheckoutDetails',
+				'TOKEN'  => $payment_details['TOKEN'],
+			);
+			// Request Customer Details.
+			$cdetails_request_response = $this->_ppExpress_request(
+				$cdetails_request_dtls,
+				'Customer Details',
+				$payment
+			);
+			$cdetails_rstatus = $this->_ppExpress_check_response($cdetails_request_response);
+			$cdata_response_args = (isset($cdetails_rstatus['args']) && is_array($cdetails_rstatus['args']))
+				? $cdetails_rstatus['args']
+				: array();
+			if ($cdetails_rstatus['status']) {
+				// We got the PayerID so now we can Complete the transaction.
+				$docheckout_request_dtls = array(
+					'METHOD'                         => 'DoExpressCheckoutPayment',
+					'PAYERID'                        => $cdata_response_args['PAYERID'],
+					'TOKEN'                          => $payment_details['TOKEN'],
+					'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale',
+					'PAYMENTREQUEST_0_AMT'           => $payment->amount(),
+					'PAYMENTREQUEST_0_CURRENCYCODE'  => $payment->currency_code(),
+				);
+				// Payment Checkout/Capture.
+				$docheckout_request_response = $this->_ppExpress_request(
+					$docheckout_request_dtls,
+					'Do Payment',
+					$payment
+				);
+				$docheckout_rstatus = $this->_ppExpress_check_response($docheckout_request_response);
+				$docheckout_response_args = (isset($docheckout_rstatus['args']) && is_array($docheckout_rstatus['args']))
+					? $docheckout_rstatus['args']
+					: array();
+				if ($docheckout_rstatus['status']) {
+					// All is well, payment approved.
+					$primary_registration_code = $primary_registrant instanceof EE_Registration ?
+						$primary_registrant->reg_code()
+						: '';
+					$payment->set_extra_accntng($primary_registration_code);
+					$payment->set_amount(isset($docheckout_response_args['PAYMENTINFO_0_AMT'])
+						? (float)$docheckout_response_args['PAYMENTINFO_0_AMT']
+						: 0);
+					$payment->set_txn_id_chq_nmbr(isset($docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'])
+						? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID']
+						: null);
+					$payment->set_details($cdata_response_args);
+					$payment->set_gateway_response(isset($docheckout_response_args['PAYMENTINFO_0_ACK'])
+						? $docheckout_response_args['PAYMENTINFO_0_ACK']
+						: '');
+					$payment->set_status($this->_pay_model->approved_status());
+				} else {
+					if (isset($docheckout_response_args['L_ERRORCODE'])) {
+						$payment->set_gateway_response(
+							$docheckout_response_args['L_ERRORCODE']
+							. '; '
+							. $docheckout_response_args['L_SHORTMESSAGE']
+						);
+					} else {
+						$payment->set_gateway_response(
+							__(
+								'Error occurred while trying to Capture the funds.',
+								'event_espresso'
+							)
+						);
+					}
+					$payment->set_details($docheckout_response_args);
+					$payment->set_status($this->_pay_model->declined_status());
+				}
+			} else {
+				if (isset($cdata_response_args['L_ERRORCODE'])) {
+					$payment->set_gateway_response(
+						$cdata_response_args['L_ERRORCODE']
+						. '; '
+						. $cdata_response_args['L_SHORTMESSAGE']
+					);
+				} else {
+					$payment->set_gateway_response(
+						__(
+							'Error occurred while trying to get payment Details from PayPal.',
+							'event_espresso'
+						)
+					);
+				}
+				$payment->set_details($cdata_response_args);
+				$payment->set_status($this->_pay_model->failed_status());
+			}
+		} else {
+			$payment->set_gateway_response(__('Error occurred while trying to process the payment.', 'event_espresso'));
+			$payment->set_status($this->_pay_model->failed_status());
+		}
+		return $payment;
+	}
+
+
+
+	/**
+	 *  Make the Express checkout request.
+	 *
+	 * @param array       $request_params
+	 * @param string      $request_text
+	 * @param EEI_Payment $payment
+	 * @return mixed
+	 */
+	public function _ppExpress_request($request_params, $request_text, $payment)
+	{
+		$request_dtls = array(
+			'VERSION'   => '204.0',
+			'USER'      => urlencode($this->_api_username),
+			'PWD'       => urlencode($this->_api_password),
+			'SIGNATURE' => urlencode($this->_api_signature),
+		);
+		$dtls = array_merge($request_dtls, $request_params);
+		$this->_log_clean_request($dtls, $payment, $request_text . ' Request');
+		// Request Customer Details.
+		$request_response = wp_remote_post(
+			$this->_base_gateway_url,
+			array(
+				'method'      => 'POST',
+				'timeout'     => 45,
+				'httpversion' => '1.1',
+				'cookies'     => array(),
+				'headers'     => array(),
+				'body'        => http_build_query($dtls),
+			)
+		);
+		// Log the response.
+		$this->log(array($request_text . ' Response' => $request_response), $payment);
+		return $request_response;
+	}
+
+
+
+	/**
+	 *  Check the response status.
+	 *
+	 * @param mixed $request_response
+	 * @return array
+	 */
+	public function _ppExpress_check_response($request_response)
+	{
+		if (is_wp_error($request_response) || empty($request_response['body'])) {
+			// If we got here then there was an error in this request.
+			return array('status' => false, 'args' => $request_response);
+		}
+		$response_args = array();
+		parse_str(urldecode($request_response['body']), $response_args);
+		if (! isset($response_args['ACK'])) {
+			return array('status' => false, 'args' => $request_response);
+		}
+		if (
+			(
+				isset($response_args['PAYERID'])
+				|| isset($response_args['TOKEN'])
+				|| isset($response_args['PAYMENTINFO_0_TRANSACTIONID'])
+				|| (isset($response_args['PAYMENTSTATUS']) && $response_args['PAYMENTSTATUS'] === 'Completed')
+			)
+			&& in_array($response_args['ACK'], array('Success', 'SuccessWithWarning'), true)
+		) {
+			// Response status OK, return response parameters for further processing.
+			return array('status' => true, 'args' => $response_args);
+		}
+		$errors = $this->_get_errors($response_args);
+		return array('status' => false, 'args' => $errors);
+	}
+
+
+
+	/**
+	 *  Log a "Cleared" request.
+	 *
+	 * @param array       $request
+	 * @param EEI_Payment $payment
+	 * @param string      $info
+	 * @return void
+	 */
+	private function _log_clean_request($request, $payment, $info)
+	{
+		$cleaned_request_data = $request;
+		unset($cleaned_request_data['PWD'], $cleaned_request_data['USER'], $cleaned_request_data['SIGNATURE']);
+		$this->log(array($info => $cleaned_request_data), $payment);
+	}
+
+
+
+	/**
+	 *  Get error from the response data.
+	 *
+	 * @param array $data_array
+	 * @return array
+	 */
+	private function _get_errors($data_array)
+	{
+		$errors = array();
+		$n = 0;
+		while (isset($data_array["L_ERRORCODE{$n}"])) {
+			$l_error_code = isset($data_array["L_ERRORCODE{$n}"])
+				? $data_array["L_ERRORCODE{$n}"]
+				: '';
+			$l_severity_code = isset($data_array["L_SEVERITYCODE{$n}"])
+				? $data_array["L_SEVERITYCODE{$n}"]
+				: '';
+			$l_short_message = isset($data_array["L_SHORTMESSAGE{$n}"])
+				? $data_array["L_SHORTMESSAGE{$n}"]
+				: '';
+			$l_long_message = isset($data_array["L_LONGMESSAGE{$n}"])
+				? $data_array["L_LONGMESSAGE{$n}"]
+				: '';
+			if ($n === 0) {
+				$errors = array(
+					'L_ERRORCODE'    => $l_error_code,
+					'L_SHORTMESSAGE' => $l_short_message,
+					'L_LONGMESSAGE'  => $l_long_message,
+					'L_SEVERITYCODE' => $l_severity_code,
+				);
+			} else {
+				$errors['L_ERRORCODE'] .= ', ' . $l_error_code;
+				$errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
+				$errors['L_LONGMESSAGE'] .= ', ' . $l_long_message;
+				$errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
+			}
+			$n++;
+		}
+		return $errors;
+	}
 
 }
 // End of file EEG_Paypal_Express.gateway.php

Spacing +28 added lines, -28 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
 }
 
@@ -130,7 +130,7 @@ 
         $notify_url = null,
         $cancel_url = null
     ) {
-        if (! $payment instanceof EEI_Payment) {
+        if ( ! $payment instanceof EEI_Payment) {
             $payment->set_gateway_response(
                 __(
                     'Error. No associated payment was found.',
@@ -141,7 +141,7 @@ 
             return $payment;
         }
         $transaction = $payment->transaction();
-        if (! $transaction instanceof EEI_Transaction) {
+        if ( ! $transaction instanceof EEI_Transaction) {
             $payment->set_gateway_response(
                 __(
                     'Could not process this payment because it has no associated transaction.',
@@ -194,25 +194,25 @@ 
                         $line_item_quantity = 1;
                     }
                     // Item Name.
-                    $token_request_dtls['L_PAYMENTREQUEST_0_NAME' . $item_num] = substr(
+                    $token_request_dtls['L_PAYMENTREQUEST_0_NAME'.$item_num] = substr(
                         $this->_format_line_item_name($line_item, $payment),
                         0,
                         127
                     );
                     // Item description.
-                    $token_request_dtls['L_PAYMENTREQUEST_0_DESC' . $item_num] = substr(
+                    $token_request_dtls['L_PAYMENTREQUEST_0_DESC'.$item_num] = substr(
                         $this->_format_line_item_desc($line_item, $payment),
                         0,
                         127
                     );
                     // Cost of individual item.
-                    $token_request_dtls['L_PAYMENTREQUEST_0_AMT' . $item_num] = $this->format_currency($unit_price);
+                    $token_request_dtls['L_PAYMENTREQUEST_0_AMT'.$item_num] = $this->format_currency($unit_price);
                     // Item Number.
-                    $token_request_dtls['L_PAYMENTREQUEST_0_NUMBER' . $item_num] = $item_num + 1;
+                    $token_request_dtls['L_PAYMENTREQUEST_0_NUMBER'.$item_num] = $item_num + 1;
                     // Item quantity.
-                    $token_request_dtls['L_PAYMENTREQUEST_0_QTY' . $item_num] = $line_item_quantity;
+                    $token_request_dtls['L_PAYMENTREQUEST_0_QTY'.$item_num] = $line_item_quantity;
                     // Digital item is sold.
-                    $token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num] = 'Physical';
+                    $token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY'.$item_num] = 'Physical';
                     $itemized_sum += $line_item->total();
                     ++$item_num;
                 }
@@ -230,7 +230,7 @@ 
             // add the difference as an extra line item.
             if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) {
                 // Item Name.
-                $token_request_dtls['L_PAYMENTREQUEST_0_NAME' . $item_num] = substr(
+                $token_request_dtls['L_PAYMENTREQUEST_0_NAME'.$item_num] = substr(
                     __(
                         'Other (promotion/surcharge/cancellation)',
                         'event_espresso'
@@ -239,17 +239,17 @@ 
                     127
                 );
                 // Item description.
-                $token_request_dtls['L_PAYMENTREQUEST_0_DESC' . $item_num] = '';
+                $token_request_dtls['L_PAYMENTREQUEST_0_DESC'.$item_num] = '';
                 // Cost of individual item.
-                $token_request_dtls['L_PAYMENTREQUEST_0_AMT' . $item_num] = $this->format_currency(
+                $token_request_dtls['L_PAYMENTREQUEST_0_AMT'.$item_num] = $this->format_currency(
                     $itemized_sum_diff_from_txn_total
                 );
                 // Item Number.
-                $token_request_dtls['L_PAYMENTREQUEST_0_NUMBER' . $item_num] = $item_num + 1;
+                $token_request_dtls['L_PAYMENTREQUEST_0_NUMBER'.$item_num] = $item_num + 1;
                 // Item quantity.
-                $token_request_dtls['L_PAYMENTREQUEST_0_QTY' . $item_num] = 1;
+                $token_request_dtls['L_PAYMENTREQUEST_0_QTY'.$item_num] = 1;
                 // Digital item is sold.
-                $token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num] = 'Physical';
+                $token_request_dtls['L_PAYMENTREQUEST_0_ITEMCATEGORY'.$item_num] = 'Physical';
                 $item_num++;
             }
         } else {
@@ -292,13 +292,13 @@ 
             $token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip();
             $token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email();
             $token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone();
-        } elseif (! $this->_request_shipping_addr) {
+        } elseif ( ! $this->_request_shipping_addr) {
             // Do not request shipping details on the PP Checkout page.
             $token_request_dtls['NOSHIPPING'] = '1';
             $token_request_dtls['REQCONFIRMSHIPPING'] = '0';
         }
         // Used a business/personal logo on the PayPal page.
-        if (! empty($this->_image_url)) {
+        if ( ! empty($this->_image_url)) {
             $token_request_dtls['LOGOIMG'] = $this->_image_url;
         }
         $token_request_dtls = apply_filters(
@@ -323,7 +323,7 @@ 
             );
         } else {
             if (isset($response_args['L_ERRORCODE'])) {
-                $payment->set_gateway_response($response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']);
+                $payment->set_gateway_response($response_args['L_ERRORCODE'].'; '.$response_args['L_SHORTMESSAGE']);
             } else {
                 $payment->set_gateway_response(
                     esc_html__(
@@ -354,7 +354,7 @@ 
         if ($payment instanceof EEI_Payment) {
             $this->log(array('Return from Authorization' => $update_info), $payment);
             $transaction = $payment->transaction();
-            if (! $transaction instanceof EEI_Transaction) {
+            if ( ! $transaction instanceof EEI_Transaction) {
                 $payment->set_gateway_response(
                     __(
                         'Could not process this payment because it has no associated transaction.',
@@ -367,7 +367,7 @@ 
             $primary_registrant = $transaction->primary_registration();
             $payment_details = $payment->details();
             // Check if we still have the token.
-            if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
+            if ( ! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) {
                 $payment->set_status($this->_pay_model->failed_status());
                 return $payment;
             }
@@ -412,7 +412,7 @@ 
                         : '';
                     $payment->set_extra_accntng($primary_registration_code);
                     $payment->set_amount(isset($docheckout_response_args['PAYMENTINFO_0_AMT'])
-                        ? (float)$docheckout_response_args['PAYMENTINFO_0_AMT']
+                        ? (float) $docheckout_response_args['PAYMENTINFO_0_AMT']
                         : 0);
                     $payment->set_txn_id_chq_nmbr(isset($docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'])
                         ? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID']
@@ -484,7 +484,7 @@ 
             'SIGNATURE' => urlencode($this->_api_signature),
         );
         $dtls = array_merge($request_dtls, $request_params);
-        $this->_log_clean_request($dtls, $payment, $request_text . ' Request');
+        $this->_log_clean_request($dtls, $payment, $request_text.' Request');
         // Request Customer Details.
         $request_response = wp_remote_post(
             $this->_base_gateway_url,
@@ -498,7 +498,7 @@ 
             )
         );
         // Log the response.
-        $this->log(array($request_text . ' Response' => $request_response), $payment);
+        $this->log(array($request_text.' Response' => $request_response), $payment);
         return $request_response;
     }
 
@@ -518,7 +518,7 @@ 
         }
         $response_args = array();
         parse_str(urldecode($request_response['body']), $response_args);
-        if (! isset($response_args['ACK'])) {
+        if ( ! isset($response_args['ACK'])) {
             return array('status' => false, 'args' => $request_response);
         }
         if (
@@ -587,10 +587,10 @@ 
                     'L_SEVERITYCODE' => $l_severity_code,
                 );
             } else {
-                $errors['L_ERRORCODE'] .= ', ' . $l_error_code;
-                $errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message;
-                $errors['L_LONGMESSAGE'] .= ', ' . $l_long_message;
-                $errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code;
+                $errors['L_ERRORCODE'] .= ', '.$l_error_code;
+                $errors['L_SHORTMESSAGE'] .= ', '.$l_short_message;
+                $errors['L_LONGMESSAGE'] .= ', '.$l_long_message;
+                $errors['L_SEVERITYCODE'] .= ', '.$l_severity_code;
             }
             $n++;
         }

espresso.php

Indentation +219 added lines, -219 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('ABSPATH')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 /*
   Plugin Name:		Event Espresso
@@ -40,243 +40,243 @@ 
  * @since            4.0
  */
 if (function_exists('espresso_version')) {
-    /**
-     *    espresso_duplicate_plugin_error
-     *    displays if more than one version of EE is activated at the same time
-     */
-    function espresso_duplicate_plugin_error()
-    {
-        ?>
+	/**
+	 *    espresso_duplicate_plugin_error
+	 *    displays if more than one version of EE is activated at the same time
+	 */
+	function espresso_duplicate_plugin_error()
+	{
+		?>
         <div class="error">
             <p>
                 <?php echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                ); ?>
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+				); ?>
             </p>
         </div>
         <?php
-        espresso_deactivate_plugin(plugin_basename(__FILE__));
-    }
+		espresso_deactivate_plugin(plugin_basename(__FILE__));
+	}
 
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
-    if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
+	if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                            esc_html__(
-                                    'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                                    'event_espresso'
-                            ),
-                            EE_MIN_PHP_VER_REQUIRED,
-                            PHP_VERSION,
-                            '<br/>',
-                            '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+							esc_html__(
+									'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+									'event_espresso'
+							),
+							EE_MIN_PHP_VER_REQUIRED,
+							PHP_VERSION,
+							'<br/>',
+							'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.47.rc.043');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.47.rc.043');
+		}
 
-        // define versions
-        define('EVENT_ESPRESSO_VERSION', espresso_version());
-        define('EE_MIN_WP_VER_REQUIRED', '4.1');
-        define('EE_MIN_WP_VER_RECOMMENDED', '4.4.2');
-        define('EE_MIN_PHP_VER_RECOMMENDED', '5.4.44');
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        //used to be DIRECTORY_SEPARATOR, but that caused issues on windows
-        if ( ! defined('DS')) {
-            define('DS', '/');
-        }
-        if ( ! defined('PS')) {
-            define('PS', PATH_SEPARATOR);
-        }
-        if ( ! defined('SP')) {
-            define('SP', ' ');
-        }
-        if ( ! defined('EENL')) {
-            define('EENL', "\n");
-        }
-        define('EE_SUPPORT_EMAIL', 'support@eventespresso.com');
-        // define the plugin directory and URL
-        define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
-        define('EE_PLUGIN_DIR_PATH', plugin_dir_path(EVENT_ESPRESSO_MAIN_FILE));
-        define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE));
-        // main root folder paths
-        define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages' . DS);
-        define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core' . DS);
-        define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules' . DS);
-        define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public' . DS);
-        define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes' . DS);
-        define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets' . DS);
-        define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods' . DS);
-        define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated' . DS);
-        // core system paths
-        define('EE_ADMIN', EE_CORE . 'admin' . DS);
-        define('EE_CPTS', EE_CORE . 'CPTs' . DS);
-        define('EE_CLASSES', EE_CORE . 'db_classes' . DS);
-        define('EE_INTERFACES', EE_CORE . 'interfaces' . DS);
-        define('EE_BUSINESS', EE_CORE . 'business' . DS);
-        define('EE_MODELS', EE_CORE . 'db_models' . DS);
-        define('EE_HELPERS', EE_CORE . 'helpers' . DS);
-        define('EE_LIBRARIES', EE_CORE . 'libraries' . DS);
-        define('EE_TEMPLATES', EE_CORE . 'templates' . DS);
-        define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs' . DS);
-        define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets' . DS);
-        define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections' . DS);
-        // gateways
-        define('EE_GATEWAYS', EE_MODULES . 'gateways' . DS);
-        define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules' . DS . 'gateways' . DS);
-        // asset URL paths
-        define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'templates' . DS);
-        define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets' . DS);
-        define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images' . DS);
-        define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'third_party_libs' . DS);
-        define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/');
-        define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/');
-        // define upload paths
-        $uploads = wp_upload_dir();
-        // define the uploads directory and URL
-        define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . DS . 'espresso' . DS);
-        define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . DS . 'espresso' . DS);
-        // define the templates directory and URL
-        define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'templates' . DS);
-        define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'templates' . DS);
-        // define the gateway directory and URL
-        define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'gateways' . DS);
-        define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'gateways' . DS);
-        // languages folder/path
-        define('EE_LANGUAGES_SAFE_LOC', '..' . DS . 'uploads' . DS . 'espresso' . DS . 'languages' . DS);
-        define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS);
-        //check for dompdf fonts in uploads
-        if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS)) {
-            define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS);
-        }
-        //ajax constants
-        define(
-                'EE_FRONT_AJAX',
-                isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax']) ? true : false
-        );
-        define(
-                'EE_ADMIN_AJAX',
-                isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax']) ? true : false
-        );
-        //just a handy constant occasionally needed for finding values representing infinity in the DB
-        //you're better to use this than its straight value (currently -1) in case you ever
-        //want to change its default value! or find when -1 means infinity
-        define('EE_INF_IN_DB', -1);
-        define('EE_INF', INF > (float)PHP_INT_MAX ? INF : PHP_INT_MAX);
-        define('EE_DEBUG', false);
-        // for older WP versions
-        if ( ! defined('MONTH_IN_SECONDS')) {
-            define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
-        }
-        /**
-         *    espresso_plugin_activation
-         *    adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		// define versions
+		define('EVENT_ESPRESSO_VERSION', espresso_version());
+		define('EE_MIN_WP_VER_REQUIRED', '4.1');
+		define('EE_MIN_WP_VER_RECOMMENDED', '4.4.2');
+		define('EE_MIN_PHP_VER_RECOMMENDED', '5.4.44');
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		//used to be DIRECTORY_SEPARATOR, but that caused issues on windows
+		if ( ! defined('DS')) {
+			define('DS', '/');
+		}
+		if ( ! defined('PS')) {
+			define('PS', PATH_SEPARATOR);
+		}
+		if ( ! defined('SP')) {
+			define('SP', ' ');
+		}
+		if ( ! defined('EENL')) {
+			define('EENL', "\n");
+		}
+		define('EE_SUPPORT_EMAIL', 'support@eventespresso.com');
+		// define the plugin directory and URL
+		define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
+		define('EE_PLUGIN_DIR_PATH', plugin_dir_path(EVENT_ESPRESSO_MAIN_FILE));
+		define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE));
+		// main root folder paths
+		define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages' . DS);
+		define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core' . DS);
+		define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules' . DS);
+		define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public' . DS);
+		define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes' . DS);
+		define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets' . DS);
+		define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods' . DS);
+		define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated' . DS);
+		// core system paths
+		define('EE_ADMIN', EE_CORE . 'admin' . DS);
+		define('EE_CPTS', EE_CORE . 'CPTs' . DS);
+		define('EE_CLASSES', EE_CORE . 'db_classes' . DS);
+		define('EE_INTERFACES', EE_CORE . 'interfaces' . DS);
+		define('EE_BUSINESS', EE_CORE . 'business' . DS);
+		define('EE_MODELS', EE_CORE . 'db_models' . DS);
+		define('EE_HELPERS', EE_CORE . 'helpers' . DS);
+		define('EE_LIBRARIES', EE_CORE . 'libraries' . DS);
+		define('EE_TEMPLATES', EE_CORE . 'templates' . DS);
+		define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs' . DS);
+		define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets' . DS);
+		define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections' . DS);
+		// gateways
+		define('EE_GATEWAYS', EE_MODULES . 'gateways' . DS);
+		define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules' . DS . 'gateways' . DS);
+		// asset URL paths
+		define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'templates' . DS);
+		define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets' . DS);
+		define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images' . DS);
+		define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'third_party_libs' . DS);
+		define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/');
+		define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/');
+		// define upload paths
+		$uploads = wp_upload_dir();
+		// define the uploads directory and URL
+		define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . DS . 'espresso' . DS);
+		define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . DS . 'espresso' . DS);
+		// define the templates directory and URL
+		define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'templates' . DS);
+		define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'templates' . DS);
+		// define the gateway directory and URL
+		define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'gateways' . DS);
+		define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'gateways' . DS);
+		// languages folder/path
+		define('EE_LANGUAGES_SAFE_LOC', '..' . DS . 'uploads' . DS . 'espresso' . DS . 'languages' . DS);
+		define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS);
+		//check for dompdf fonts in uploads
+		if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS)) {
+			define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS);
+		}
+		//ajax constants
+		define(
+				'EE_FRONT_AJAX',
+				isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax']) ? true : false
+		);
+		define(
+				'EE_ADMIN_AJAX',
+				isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax']) ? true : false
+		);
+		//just a handy constant occasionally needed for finding values representing infinity in the DB
+		//you're better to use this than its straight value (currently -1) in case you ever
+		//want to change its default value! or find when -1 means infinity
+		define('EE_INF_IN_DB', -1);
+		define('EE_INF', INF > (float)PHP_INT_MAX ? INF : PHP_INT_MAX);
+		define('EE_DEBUG', false);
+		// for older WP versions
+		if ( ! defined('MONTH_IN_SECONDS')) {
+			define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
+		}
+		/**
+		 *    espresso_plugin_activation
+		 *    adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
-        /**
-         *    espresso_load_error_handling
-         *    this function loads EE's class for handling exceptions and errors
-         */
-        function espresso_load_error_handling()
-        {
-            // load debugging tools
-            if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
-                require_once(EE_HELPERS . 'EEH_Debug_Tools.helper.php');
-                EEH_Debug_Tools::instance();
-            }
-            // load error handling
-            if (is_readable(EE_CORE . 'EE_Error.core.php')) {
-                require_once(EE_CORE . 'EE_Error.core.php');
-            } else {
-                wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
-            }
-        }
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		/**
+		 *    espresso_load_error_handling
+		 *    this function loads EE's class for handling exceptions and errors
+		 */
+		function espresso_load_error_handling()
+		{
+			// load debugging tools
+			if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
+				require_once(EE_HELPERS . 'EEH_Debug_Tools.helper.php');
+				EEH_Debug_Tools::instance();
+			}
+			// load error handling
+			if (is_readable(EE_CORE . 'EE_Error.core.php')) {
+				require_once(EE_CORE . 'EE_Error.core.php');
+			} else {
+				wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
+			}
+		}
 
-        /**
-         *    espresso_load_required
-         *    given a class name and path, this function will load that file or throw an exception
-         *
-         * @param    string $classname
-         * @param    string $full_path_to_file
-         * @throws    EE_Error
-         */
-        function espresso_load_required($classname, $full_path_to_file)
-        {
-            static $error_handling_loaded = false;
-            if ( ! $error_handling_loaded) {
-                espresso_load_error_handling();
-                $error_handling_loaded = true;
-            }
-            if (is_readable($full_path_to_file)) {
-                require_once($full_path_to_file);
-            } else {
-                throw new EE_Error (
-                        sprintf(
-                                esc_html__(
-                                        'The %s class file could not be located or is not readable due to file permissions.',
-                                        'event_espresso'
-                                ),
-                                $classname
-                        )
-                );
-            }
-        }
+		/**
+		 *    espresso_load_required
+		 *    given a class name and path, this function will load that file or throw an exception
+		 *
+		 * @param    string $classname
+		 * @param    string $full_path_to_file
+		 * @throws    EE_Error
+		 */
+		function espresso_load_required($classname, $full_path_to_file)
+		{
+			static $error_handling_loaded = false;
+			if ( ! $error_handling_loaded) {
+				espresso_load_error_handling();
+				$error_handling_loaded = true;
+			}
+			if (is_readable($full_path_to_file)) {
+				require_once($full_path_to_file);
+			} else {
+				throw new EE_Error (
+						sprintf(
+								esc_html__(
+										'The %s class file could not be located or is not readable due to file permissions.',
+										'event_espresso'
+								),
+								$classname
+						)
+				);
+			}
+		}
 
-        espresso_load_required('EEH_Base', EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php');
-        espresso_load_required('EEH_File', EE_CORE . 'helpers' . DS . 'EEH_File.helper.php');
-        espresso_load_required('EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php');
-        new EE_Bootstrap();
-    }
+		espresso_load_required('EEH_Base', EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php');
+		espresso_load_required('EEH_File', EE_CORE . 'helpers' . DS . 'EEH_File.helper.php');
+		espresso_load_required('EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php');
+		new EE_Bootstrap();
+	}
 }
 if ( ! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if ( ! function_exists('deactivate_plugins')) {
-            require_once(ABSPATH . 'wp-admin/includes/plugin.php');
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if ( ! function_exists('deactivate_plugins')) {
+			require_once(ABSPATH . 'wp-admin/includes/plugin.php');
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }
\ No newline at end of file