eventespresso / event-espresso-core

modules/single_page_checkout/inc/EE_SPCO_JSON_Response.php

Indentation +399 added lines, -399 removed lines

@@ -15,403 +15,403 @@
 class EE_SPCO_JSON_Response
 {
 
-    /**
-     * @var string
-     */
-    protected $_errors = '';
-
-    /**
-     * @var string
-     */
-    protected $_unexpected_errors = '';
-
-    /**
-     * @var string
-     */
-    protected $_attention = '';
-
-    /**
-     * @var string
-     */
-    protected $_success = '';
-
-    /**
-     * @var string
-     */
-    protected $_plz_select_method_of_payment = '';
-
-    /**
-     * @var string
-     */
-    protected $_redirect_url = '';
-
-    /**
-     * @var string
-     */
-    protected $_registration_time_limit = '';
-
-    /**
-     * @var string
-     */
-    protected $_redirect_form = '';
-
-    /**
-     * @var string
-     */
-    protected $_reg_step_html = '';
-
-    /**
-     * @var string
-     */
-    protected $_method_of_payment = '';
-
-    /**
-     * @var float
-     */
-    protected $_payment_amount;
-
-    /**
-     * @var array
-     */
-    protected $_return_data = array();
-
-
-    /**
-     * @var array
-     */
-    protected $_validation_rules = array();
-
-
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-    }
-
-
-    /**
-     *    __toString
-     *
-     *        allows you to simply echo or print an EE_SPCO_JSON_Response object to produce a  JSON encoded string
-     *        ie: $json_response = new EE_SPCO_JSON_Response();
-     *        echo $json_response;
-     *
-     * @access    public
-     * @return    string
-     */
-    public function __toString()
-    {
-        $JSON_response = array();
-        // grab notices
-        $notices = EE_Error::get_notices(false);
-        $this->set_attention(isset($notices['attention']) ? $notices['attention'] : '');
-        $this->set_errors(isset($notices['errors']) ? $notices['errors'] : '');
-        $this->set_success(isset($notices['success']) ? $notices['success'] : '');
-        // add notices to JSON response, but only if they exist
-        if ($this->attention()) {
-            $JSON_response['attention'] = $this->attention();
-        }
-        if ($this->errors()) {
-            $JSON_response['errors'] = $this->errors();
-        }
-        if ($this->unexpected_errors()) {
-            $JSON_response['unexpected_errors'] = $this->unexpected_errors();
-        }
-        if ($this->success()) {
-            $JSON_response['success'] = $this->success();
-        }
-        // but if NO notices are set... at least set the "success" as a key so that the JS knows everything worked
-        if (! isset($JSON_response['attention']) && ! isset($JSON_response['errors']) && ! isset($JSON_response['success'])) {
-            $JSON_response['success'] = null;
-        }
-        // set redirect_url, IF it exists
-        if ($this->redirect_url()) {
-            $JSON_response['redirect_url'] = $this->redirect_url();
-        }
-        // set registration_time_limit, IF it exists
-        if ($this->registration_time_limit()) {
-            $JSON_response['registration_time_limit'] = $this->registration_time_limit();
-        }
-        // set payment_amount, IF it exists
-        if ($this->payment_amount() !== null) {
-            $JSON_response['payment_amount'] = $this->payment_amount();
-        }
-        // grab generic return data
-        $return_data = $this->return_data();
-        // add billing form validation rules
-        if ($this->validation_rules()) {
-            $return_data['validation_rules'] = $this->validation_rules();
-        }
-        // set reg_step_html, IF it exists
-        if ($this->reg_step_html()) {
-            $return_data['reg_step_html'] = $this->reg_step_html();
-        }
-        // set method of payment, IF it exists
-        if ($this->method_of_payment()) {
-            $return_data['method_of_payment'] = $this->method_of_payment();
-        }
-        // set "plz_select_method_of_payment" message, IF it exists
-        if ($this->plz_select_method_of_payment()) {
-            $return_data['plz_select_method_of_payment'] = $this->plz_select_method_of_payment();
-        }
-        // set redirect_form, IF it exists
-        if ($this->redirect_form()) {
-            $return_data['redirect_form'] = $this->redirect_form();
-        }
-        // and finally, add return_data array to main JSON response array, IF it contains anything
-        // why did we add some of the above properties to the return data array?
-        // because it is easier and cleaner in the Javascript to deal with this way
-        if (! empty($return_data)) {
-            $JSON_response['return_data'] = $return_data;
-        }
-        // filter final array
-        $JSON_response = apply_filters('FHEE__EE_SPCO_JSON_Response___toString__JSON_response', $JSON_response);
-        // return encoded array
-        return (string) wp_json_encode($JSON_response);
-    }
-
-
-    /**
-     * @param string $attention
-     */
-    public function set_attention($attention)
-    {
-        $this->_attention = $attention;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function attention()
-    {
-        return $this->_attention;
-    }
-
-
-    /**
-     * @param string $errors
-     */
-    public function set_errors($errors)
-    {
-        $this->_errors = $errors;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function errors()
-    {
-        return $this->_errors;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function unexpected_errors()
-    {
-        return $this->_unexpected_errors;
-    }
-
-
-    /**
-     * @param string $unexpected_errors
-     */
-    public function set_unexpected_errors($unexpected_errors)
-    {
-        $this->_unexpected_errors = $unexpected_errors;
-    }
-
-
-    /**
-     * @param string $success
-     */
-    public function set_success($success)
-    {
-        $this->_success = $success;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function success()
-    {
-        return $this->_success;
-    }
-
-
-    /**
-     * @param string $method_of_payment
-     */
-    public function set_method_of_payment($method_of_payment)
-    {
-        $this->_method_of_payment = $method_of_payment;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function method_of_payment()
-    {
-        return $this->_method_of_payment;
-    }
-
-
-    /**
-     * @return float
-     */
-    public function payment_amount()
-    {
-        return $this->_payment_amount;
-    }
-
-
-    /**
-     * @param float $payment_amount
-     * @throws EE_Error
-     */
-    public function set_payment_amount($payment_amount)
-    {
-        $this->_payment_amount = (float) $payment_amount;
-    }
-
-
-    /**
-     * @param string $next_step_html
-     */
-    public function set_reg_step_html($next_step_html)
-    {
-        $this->_reg_step_html = $next_step_html;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function reg_step_html()
-    {
-        return $this->_reg_step_html;
-    }
-
-
-    /**
-     * @param string $redirect_form
-     */
-    public function set_redirect_form($redirect_form)
-    {
-        $this->_redirect_form = $redirect_form;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function redirect_form()
-    {
-        return ! empty($this->_redirect_form) ? $this->_redirect_form : false;
-    }
-
-
-    /**
-     * @param string $plz_select_method_of_payment
-     */
-    public function set_plz_select_method_of_payment($plz_select_method_of_payment)
-    {
-        $this->_plz_select_method_of_payment = $plz_select_method_of_payment;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function plz_select_method_of_payment()
-    {
-        return $this->_plz_select_method_of_payment;
-    }
-
-
-    /**
-     * @param string $redirect_url
-     */
-    public function set_redirect_url($redirect_url)
-    {
-        $this->_redirect_url = $redirect_url;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function redirect_url()
-    {
-        return $this->_redirect_url;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function registration_time_limit()
-    {
-        return $this->_registration_time_limit;
-    }
-
-
-    /**
-     * @param string $registration_time_limit
-     */
-    public function set_registration_time_limit($registration_time_limit)
-    {
-        $this->_registration_time_limit = $registration_time_limit;
-    }
-
-
-    /**
-     * @param array $return_data
-     */
-    public function set_return_data($return_data)
-    {
-        $this->_return_data = array_merge($this->_return_data, $return_data);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function return_data()
-    {
-        return $this->_return_data;
-    }
-
-
-    /**
-     * @param array $validation_rules
-     */
-    public function add_validation_rules(array $validation_rules = array())
-    {
-        if (is_array($validation_rules) && ! empty($validation_rules)) {
-            $this->_validation_rules = array_merge($this->_validation_rules, $validation_rules);
-        }
-    }
-
-
-    /**
-     * @return array | bool
-     */
-    public function validation_rules()
-    {
-        return ! empty($this->_validation_rules) ? $this->_validation_rules : false;
-    }
-
-
-    public function echoAndExit()
-    {
-        echo $this;
-        exit();
-    }
+	/**
+	 * @var string
+	 */
+	protected $_errors = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_unexpected_errors = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_attention = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_success = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_plz_select_method_of_payment = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_redirect_url = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_registration_time_limit = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_redirect_form = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_reg_step_html = '';
+
+	/**
+	 * @var string
+	 */
+	protected $_method_of_payment = '';
+
+	/**
+	 * @var float
+	 */
+	protected $_payment_amount;
+
+	/**
+	 * @var array
+	 */
+	protected $_return_data = array();
+
+
+	/**
+	 * @var array
+	 */
+	protected $_validation_rules = array();
+
+
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+	}
+
+
+	/**
+	 *    __toString
+	 *
+	 *        allows you to simply echo or print an EE_SPCO_JSON_Response object to produce a  JSON encoded string
+	 *        ie: $json_response = new EE_SPCO_JSON_Response();
+	 *        echo $json_response;
+	 *
+	 * @access    public
+	 * @return    string
+	 */
+	public function __toString()
+	{
+		$JSON_response = array();
+		// grab notices
+		$notices = EE_Error::get_notices(false);
+		$this->set_attention(isset($notices['attention']) ? $notices['attention'] : '');
+		$this->set_errors(isset($notices['errors']) ? $notices['errors'] : '');
+		$this->set_success(isset($notices['success']) ? $notices['success'] : '');
+		// add notices to JSON response, but only if they exist
+		if ($this->attention()) {
+			$JSON_response['attention'] = $this->attention();
+		}
+		if ($this->errors()) {
+			$JSON_response['errors'] = $this->errors();
+		}
+		if ($this->unexpected_errors()) {
+			$JSON_response['unexpected_errors'] = $this->unexpected_errors();
+		}
+		if ($this->success()) {
+			$JSON_response['success'] = $this->success();
+		}
+		// but if NO notices are set... at least set the "success" as a key so that the JS knows everything worked
+		if (! isset($JSON_response['attention']) && ! isset($JSON_response['errors']) && ! isset($JSON_response['success'])) {
+			$JSON_response['success'] = null;
+		}
+		// set redirect_url, IF it exists
+		if ($this->redirect_url()) {
+			$JSON_response['redirect_url'] = $this->redirect_url();
+		}
+		// set registration_time_limit, IF it exists
+		if ($this->registration_time_limit()) {
+			$JSON_response['registration_time_limit'] = $this->registration_time_limit();
+		}
+		// set payment_amount, IF it exists
+		if ($this->payment_amount() !== null) {
+			$JSON_response['payment_amount'] = $this->payment_amount();
+		}
+		// grab generic return data
+		$return_data = $this->return_data();
+		// add billing form validation rules
+		if ($this->validation_rules()) {
+			$return_data['validation_rules'] = $this->validation_rules();
+		}
+		// set reg_step_html, IF it exists
+		if ($this->reg_step_html()) {
+			$return_data['reg_step_html'] = $this->reg_step_html();
+		}
+		// set method of payment, IF it exists
+		if ($this->method_of_payment()) {
+			$return_data['method_of_payment'] = $this->method_of_payment();
+		}
+		// set "plz_select_method_of_payment" message, IF it exists
+		if ($this->plz_select_method_of_payment()) {
+			$return_data['plz_select_method_of_payment'] = $this->plz_select_method_of_payment();
+		}
+		// set redirect_form, IF it exists
+		if ($this->redirect_form()) {
+			$return_data['redirect_form'] = $this->redirect_form();
+		}
+		// and finally, add return_data array to main JSON response array, IF it contains anything
+		// why did we add some of the above properties to the return data array?
+		// because it is easier and cleaner in the Javascript to deal with this way
+		if (! empty($return_data)) {
+			$JSON_response['return_data'] = $return_data;
+		}
+		// filter final array
+		$JSON_response = apply_filters('FHEE__EE_SPCO_JSON_Response___toString__JSON_response', $JSON_response);
+		// return encoded array
+		return (string) wp_json_encode($JSON_response);
+	}
+
+
+	/**
+	 * @param string $attention
+	 */
+	public function set_attention($attention)
+	{
+		$this->_attention = $attention;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function attention()
+	{
+		return $this->_attention;
+	}
+
+
+	/**
+	 * @param string $errors
+	 */
+	public function set_errors($errors)
+	{
+		$this->_errors = $errors;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function errors()
+	{
+		return $this->_errors;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function unexpected_errors()
+	{
+		return $this->_unexpected_errors;
+	}
+
+
+	/**
+	 * @param string $unexpected_errors
+	 */
+	public function set_unexpected_errors($unexpected_errors)
+	{
+		$this->_unexpected_errors = $unexpected_errors;
+	}
+
+
+	/**
+	 * @param string $success
+	 */
+	public function set_success($success)
+	{
+		$this->_success = $success;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function success()
+	{
+		return $this->_success;
+	}
+
+
+	/**
+	 * @param string $method_of_payment
+	 */
+	public function set_method_of_payment($method_of_payment)
+	{
+		$this->_method_of_payment = $method_of_payment;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function method_of_payment()
+	{
+		return $this->_method_of_payment;
+	}
+
+
+	/**
+	 * @return float
+	 */
+	public function payment_amount()
+	{
+		return $this->_payment_amount;
+	}
+
+
+	/**
+	 * @param float $payment_amount
+	 * @throws EE_Error
+	 */
+	public function set_payment_amount($payment_amount)
+	{
+		$this->_payment_amount = (float) $payment_amount;
+	}
+
+
+	/**
+	 * @param string $next_step_html
+	 */
+	public function set_reg_step_html($next_step_html)
+	{
+		$this->_reg_step_html = $next_step_html;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function reg_step_html()
+	{
+		return $this->_reg_step_html;
+	}
+
+
+	/**
+	 * @param string $redirect_form
+	 */
+	public function set_redirect_form($redirect_form)
+	{
+		$this->_redirect_form = $redirect_form;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function redirect_form()
+	{
+		return ! empty($this->_redirect_form) ? $this->_redirect_form : false;
+	}
+
+
+	/**
+	 * @param string $plz_select_method_of_payment
+	 */
+	public function set_plz_select_method_of_payment($plz_select_method_of_payment)
+	{
+		$this->_plz_select_method_of_payment = $plz_select_method_of_payment;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function plz_select_method_of_payment()
+	{
+		return $this->_plz_select_method_of_payment;
+	}
+
+
+	/**
+	 * @param string $redirect_url
+	 */
+	public function set_redirect_url($redirect_url)
+	{
+		$this->_redirect_url = $redirect_url;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function redirect_url()
+	{
+		return $this->_redirect_url;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function registration_time_limit()
+	{
+		return $this->_registration_time_limit;
+	}
+
+
+	/**
+	 * @param string $registration_time_limit
+	 */
+	public function set_registration_time_limit($registration_time_limit)
+	{
+		$this->_registration_time_limit = $registration_time_limit;
+	}
+
+
+	/**
+	 * @param array $return_data
+	 */
+	public function set_return_data($return_data)
+	{
+		$this->_return_data = array_merge($this->_return_data, $return_data);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function return_data()
+	{
+		return $this->_return_data;
+	}
+
+
+	/**
+	 * @param array $validation_rules
+	 */
+	public function add_validation_rules(array $validation_rules = array())
+	{
+		if (is_array($validation_rules) && ! empty($validation_rules)) {
+			$this->_validation_rules = array_merge($this->_validation_rules, $validation_rules);
+		}
+	}
+
+
+	/**
+	 * @return array | bool
+	 */
+	public function validation_rules()
+	{
+		return ! empty($this->_validation_rules) ? $this->_validation_rules : false;
+	}
+
+
+	public function echoAndExit()
+	{
+		echo $this;
+		exit();
+	}
 }

modules/ical/EED_Ical.module.php

Spacing +13 added lines, -13 removed lines

@@ -86,24 +86,24 @@ 
             switch ($iCal_type) {
                 // submit buttons appear as buttons and are very compatible with a theme's style
                 case 'submit':
-                    $html .= '<form id="download-iCal-frm-' . $datetime->ID();
-                    $html .= '" class="download-iCal-frm" action="' . $URL . '" method="post" >';
+                    $html .= '<form id="download-iCal-frm-'.$datetime->ID();
+                    $html .= '" class="download-iCal-frm" action="'.$URL.'" method="post" >';
                     $html .= '<input type="submit" class="ee-ical-sbmt" value="&#xf145;" title="';
-                    $html .= esc_html__('Add to iCal Calendar', 'event_espresso') . '"/>';
+                    $html .= esc_html__('Add to iCal Calendar', 'event_espresso').'"/>';
                     $html .= '</form>';
                     break;
                 // buttons are just links that have been styled to appear as buttons,
                 // but may not be blend with a theme as well as submit buttons
                 case 'button':
-                    $html .= '<a class="ee-ical-btn small ee-button ee-roundish" href="' . $URL;
-                    $html .= '" title="' . esc_html__('Add to iCal Calendar', 'event_espresso') . '">';
+                    $html .= '<a class="ee-ical-btn small ee-button ee-roundish" href="'.$URL;
+                    $html .= '" title="'.esc_html__('Add to iCal Calendar', 'event_espresso').'">';
                     $html .= ' <span class="dashicons dashicons-calendar"></span>';
                     $html .= '</a>';
                     break;
                 // links are just links that use the calendar dashicon
                 case 'icon':
-                    $html .= '<a class="ee-ical-lnk" href="' . $URL . '" title="';
-                    $html .= esc_html__('Add to iCal Calendar', 'event_espresso') . '">';
+                    $html .= '<a class="ee-ical-lnk" href="'.$URL.'" title="';
+                    $html .= esc_html__('Add to iCal Calendar', 'event_espresso').'">';
                     $html .= ' <span class="dashicons dashicons-calendar"></span>';
                     $html .= '</a>';
                     break;
@@ -144,7 +144,7 @@ 
                     }
 
                     // Generate filename
-                    $filename = $event->slug() . '-' . $datetime->start_date('Y-m-d') . '.ics';
+                    $filename = $event->slug().'-'.$datetime->start_date('Y-m-d').'.ics';
 
                     // Check the datetime status has not been cancelled and set the ics value accordingly
                     $status = $datetime->get_active_status();
@@ -153,7 +153,7 @@ 
                     // Create array of ics details, escape strings, convert timestamps to ics format, etc
                     $ics_data = [
                         'ORGANIZER_NAME' => EE_Registry::instance()->CFG->organization->name,
-                        'UID'            => md5($event->name() . $event->ID() . $datetime->ID()),
+                        'UID'            => md5($event->name().$event->ID().$datetime->ID()),
                         'ORGANIZER'      => EE_Registry::instance()->CFG->organization->email,
                         'DTSTAMP'        => date(EED_Ical::iCal_datetime_format),
                         'LOCATION'       => $location,
@@ -174,9 +174,9 @@ 
                     foreach ($ics_data as $key => $value) {
                         // Description is escaped differently from all all values
                         if ($key === 'DESCRIPTION') {
-                            $ics_data[ $key ] = EED_Ical::_escape_ICal_description(wp_strip_all_tags($value));
+                            $ics_data[$key] = EED_Ical::_escape_ICal_description(wp_strip_all_tags($value));
                         } else {
-                            $ics_data[ $key ] = EED_Ical::_escape_ICal_data($value);
+                            $ics_data[$key] = EED_Ical::_escape_ICal_data($value);
                         }
                     }
 
@@ -186,7 +186,7 @@ 
 
                     // set headers
                     header('Content-type: text/calendar; charset=utf-8');
-                    header('Content-Disposition: attachment; filename="' . $filename . '"');
+                    header('Content-Disposition: attachment; filename="'.$filename.'"');
                     header('Cache-Control: private, max-age=0, must-revalidate');
                     header('Pragma: public');
                     header('Content-Type: application/octet-stream');
@@ -204,7 +204,7 @@ 
 
                     // Output all remaining values from ics_data.
                     foreach ($ics_data as $key => $value) {
-                        echo $key . ':' . $value . "\r\n";
+                        echo $key.':'.$value."\r\n";
                     }
 
                     echo "END:VEVENT\r\n";

Indentation +231 added lines, -231 removed lines

@@ -13,235 +13,235 @@
 class EED_Ical extends EED_Module
 {
 
-    const iCal_datetime_format = 'Ymd\THis\Z';
-
-
-    /**
-     * @return EED_Ical|EED_Module
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        // create download buttons
-        add_filter(
-            'FHEE__espresso_list_of_event_dates__datetime_html',
-            ['EED_Ical', 'generate_add_to_iCal_button'],
-            10,
-            2
-        );
-        // process ics download request
-        EE_Config::register_route('download_ics_file', 'EED_Ical', 'download_ics_file');
-    }
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-    }
-
-
-    /**
-     *    run - initial module setup
-     *
-     * @param WP $WP
-     * @return    void
-     */
-    public function run($WP)
-    {
-    }
-
-
-    /**
-     * @param $html
-     * @param $datetime
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function generate_add_to_iCal_button($html, $datetime)
-    {
-        // first verify a proper datetime object has been received
-        if ($datetime instanceof EE_Datetime) {
-            // set whether a link or submit button is shown
-            $iCal_type = apply_filters('FHEE__EED_Ical__generate_add_to_iCal_button__iCal_type', 'submit');
-            // generate a link to the route we registered in set_hooks()
-            $URL = add_query_arg(['ee' => 'download_ics_file', 'ics_id' => $datetime->ID()], site_url());
-            $URL = esc_url_Raw($URL);
-            // what type ?
-            switch ($iCal_type) {
-                // submit buttons appear as buttons and are very compatible with a theme's style
-                case 'submit':
-                    $html .= '<form id="download-iCal-frm-' . $datetime->ID();
-                    $html .= '" class="download-iCal-frm" action="' . $URL . '" method="post" >';
-                    $html .= '<input type="submit" class="ee-ical-sbmt" value="&#xf145;" title="';
-                    $html .= esc_html__('Add to iCal Calendar', 'event_espresso') . '"/>';
-                    $html .= '</form>';
-                    break;
-                // buttons are just links that have been styled to appear as buttons,
-                // but may not be blend with a theme as well as submit buttons
-                case 'button':
-                    $html .= '<a class="ee-ical-btn small ee-button ee-roundish" href="' . $URL;
-                    $html .= '" title="' . esc_html__('Add to iCal Calendar', 'event_espresso') . '">';
-                    $html .= ' <span class="dashicons dashicons-calendar"></span>';
-                    $html .= '</a>';
-                    break;
-                // links are just links that use the calendar dashicon
-                case 'icon':
-                    $html .= '<a class="ee-ical-lnk" href="' . $URL . '" title="';
-                    $html .= esc_html__('Add to iCal Calendar', 'event_espresso') . '">';
-                    $html .= ' <span class="dashicons dashicons-calendar"></span>';
-                    $html .= '</a>';
-                    break;
-            }
-        }
-        return $html;
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function download_ics_file()
-    {
-        $request = self::getRequest();
-        if ($request->requestParamIsSet('ics_id')) {
-            $DTT_ID   = $request->getRequestParam('ics_id', 0, 'int');
-            $datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
-            if ($datetime instanceof EE_Datetime) {
-                // get related event, venues, and event categories
-                $event = $datetime->event();
-                if ($event instanceof EE_Event) {
-                    // get related category Term object and it's name
-                    $category = $event->first_event_category();
-                    if ($category instanceof EE_Term) {
-                        $category = $category->name();
-                    }
-                    $location = '';
-                    // get first related venue and convert to CSV string
-                    $venue = $event->venues(['limit' => 1]);
-                    if (is_array($venue) && ! empty($venue)) {
-                        $venue = array_shift($venue);
-                        if ($venue instanceof EE_Venue) {
-                            $location = espresso_venue_raw_address('inline', $venue->ID(), false);
-                        }
-                    }
-
-                    // Generate filename
-                    $filename = $event->slug() . '-' . $datetime->start_date('Y-m-d') . '.ics';
-
-                    // Check the datetime status has not been cancelled and set the ics value accordingly
-                    $status = $datetime->get_active_status();
-                    $status = $status === EE_Datetime::cancelled ? 'CANCELLED' : 'CONFIRMED';
-
-                    // Create array of ics details, escape strings, convert timestamps to ics format, etc
-                    $ics_data = [
-                        'ORGANIZER_NAME' => EE_Registry::instance()->CFG->organization->name,
-                        'UID'            => md5($event->name() . $event->ID() . $datetime->ID()),
-                        'ORGANIZER'      => EE_Registry::instance()->CFG->organization->email,
-                        'DTSTAMP'        => date(EED_Ical::iCal_datetime_format),
-                        'LOCATION'       => $location,
-                        'SUMMARY'        => $event->name(),
-                        'DESCRIPTION'    => wp_strip_all_tags($event->description()),
-                        'STATUS'         => $status,
-                        'CATEGORIES'     => $category,
-                        'URL;VALUE=URI'  => get_permalink($event->ID()),
-                        'DTSTART'        => date(EED_Ical::iCal_datetime_format, $datetime->start()),
-                        'DTEND'          => date(EED_Ical::iCal_datetime_format, $datetime->end()),
-                    ];
-
-                    // Filter the values used within the ics output.
-                    // NOTE - all values within ics_data will be escaped automatically.
-                    $ics_data = apply_filters('FHEE__EED_Ical__download_ics_file_ics_data', $ics_data, $datetime);
-
-                    // Escape all ics data
-                    foreach ($ics_data as $key => $value) {
-                        // Description is escaped differently from all all values
-                        if ($key === 'DESCRIPTION') {
-                            $ics_data[ $key ] = EED_Ical::_escape_ICal_description(wp_strip_all_tags($value));
-                        } else {
-                            $ics_data[ $key ] = EED_Ical::_escape_ICal_data($value);
-                        }
-                    }
-
-                    // Pull the organizer name from ics_data and remove it from the array.
-                    $organizer_name = isset($ics_data['ORGANIZER_NAME'])
-                        ? $ics_data['ORGANIZER_NAME']
-                        : '';
-                    unset($ics_data['ORGANIZER_NAME']);
-
-                    // set headers
-                    header('Content-type: text/calendar; charset=utf-8');
-                    header('Content-Disposition: attachment; filename="' . $filename . '"');
-                    header('Cache-Control: private, max-age=0, must-revalidate');
-                    header('Pragma: public');
-                    header('Content-Type: application/octet-stream');
-                    header('Content-Type: application/force-download');
-                    header('Cache-Control: no-cache, must-revalidate');
-                    header('Content-Transfer-Encoding: binary');
-                    header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // past date
-                    ini_set('zlib.output_compression', '0');
-                    // echo the output
-                    echo "BEGIN:VCALENDAR\r\n";
-                    echo "VERSION:2.0\r\n";
-                    echo "PRODID:-//{$organizer_name}//NONSGML PDA Calendar Version 1.0//EN\r\n";
-                    echo "CALSCALE:GREGORIAN\r\n";
-                    echo "BEGIN:VEVENT\r\n";
-
-                    // Output all remaining values from ics_data.
-                    foreach ($ics_data as $key => $value) {
-                        echo $key . ':' . $value . "\r\n";
-                    }
-
-                    echo "END:VEVENT\r\n";
-                    echo "END:VCALENDAR\r\n";
-                }
-            }
-        }
-        die();
-    }
-
-
-    /**
-     *    _escape_ICal_data
-     *
-     * @param string $string
-     * @return    string
-     */
-    private static function _escape_ICal_data($string = '')
-    {
-        return preg_replace('/([\,;])/', '\\\$1', $string);
-    }
-
-
-    /**
-     *    _escape_ICal_description
-     *
-     * @param string $description
-     * @return    string
-     */
-    private static function _escape_ICal_description($description = '')
-    {
-        // Escape special chars within the description
-        $description = EED_Ical::_escape_ICal_data($description);
-        // Remove line breaks and output in iCal format
-        return str_replace(["\r\n", "\n"], '\n', $description);
-    }
+	const iCal_datetime_format = 'Ymd\THis\Z';
+
+
+	/**
+	 * @return EED_Ical|EED_Module
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		// create download buttons
+		add_filter(
+			'FHEE__espresso_list_of_event_dates__datetime_html',
+			['EED_Ical', 'generate_add_to_iCal_button'],
+			10,
+			2
+		);
+		// process ics download request
+		EE_Config::register_route('download_ics_file', 'EED_Ical', 'download_ics_file');
+	}
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+	}
+
+
+	/**
+	 *    run - initial module setup
+	 *
+	 * @param WP $WP
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+	}
+
+
+	/**
+	 * @param $html
+	 * @param $datetime
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function generate_add_to_iCal_button($html, $datetime)
+	{
+		// first verify a proper datetime object has been received
+		if ($datetime instanceof EE_Datetime) {
+			// set whether a link or submit button is shown
+			$iCal_type = apply_filters('FHEE__EED_Ical__generate_add_to_iCal_button__iCal_type', 'submit');
+			// generate a link to the route we registered in set_hooks()
+			$URL = add_query_arg(['ee' => 'download_ics_file', 'ics_id' => $datetime->ID()], site_url());
+			$URL = esc_url_Raw($URL);
+			// what type ?
+			switch ($iCal_type) {
+				// submit buttons appear as buttons and are very compatible with a theme's style
+				case 'submit':
+					$html .= '<form id="download-iCal-frm-' . $datetime->ID();
+					$html .= '" class="download-iCal-frm" action="' . $URL . '" method="post" >';
+					$html .= '<input type="submit" class="ee-ical-sbmt" value="&#xf145;" title="';
+					$html .= esc_html__('Add to iCal Calendar', 'event_espresso') . '"/>';
+					$html .= '</form>';
+					break;
+				// buttons are just links that have been styled to appear as buttons,
+				// but may not be blend with a theme as well as submit buttons
+				case 'button':
+					$html .= '<a class="ee-ical-btn small ee-button ee-roundish" href="' . $URL;
+					$html .= '" title="' . esc_html__('Add to iCal Calendar', 'event_espresso') . '">';
+					$html .= ' <span class="dashicons dashicons-calendar"></span>';
+					$html .= '</a>';
+					break;
+				// links are just links that use the calendar dashicon
+				case 'icon':
+					$html .= '<a class="ee-ical-lnk" href="' . $URL . '" title="';
+					$html .= esc_html__('Add to iCal Calendar', 'event_espresso') . '">';
+					$html .= ' <span class="dashicons dashicons-calendar"></span>';
+					$html .= '</a>';
+					break;
+			}
+		}
+		return $html;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function download_ics_file()
+	{
+		$request = self::getRequest();
+		if ($request->requestParamIsSet('ics_id')) {
+			$DTT_ID   = $request->getRequestParam('ics_id', 0, 'int');
+			$datetime = EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
+			if ($datetime instanceof EE_Datetime) {
+				// get related event, venues, and event categories
+				$event = $datetime->event();
+				if ($event instanceof EE_Event) {
+					// get related category Term object and it's name
+					$category = $event->first_event_category();
+					if ($category instanceof EE_Term) {
+						$category = $category->name();
+					}
+					$location = '';
+					// get first related venue and convert to CSV string
+					$venue = $event->venues(['limit' => 1]);
+					if (is_array($venue) && ! empty($venue)) {
+						$venue = array_shift($venue);
+						if ($venue instanceof EE_Venue) {
+							$location = espresso_venue_raw_address('inline', $venue->ID(), false);
+						}
+					}
+
+					// Generate filename
+					$filename = $event->slug() . '-' . $datetime->start_date('Y-m-d') . '.ics';
+
+					// Check the datetime status has not been cancelled and set the ics value accordingly
+					$status = $datetime->get_active_status();
+					$status = $status === EE_Datetime::cancelled ? 'CANCELLED' : 'CONFIRMED';
+
+					// Create array of ics details, escape strings, convert timestamps to ics format, etc
+					$ics_data = [
+						'ORGANIZER_NAME' => EE_Registry::instance()->CFG->organization->name,
+						'UID'            => md5($event->name() . $event->ID() . $datetime->ID()),
+						'ORGANIZER'      => EE_Registry::instance()->CFG->organization->email,
+						'DTSTAMP'        => date(EED_Ical::iCal_datetime_format),
+						'LOCATION'       => $location,
+						'SUMMARY'        => $event->name(),
+						'DESCRIPTION'    => wp_strip_all_tags($event->description()),
+						'STATUS'         => $status,
+						'CATEGORIES'     => $category,
+						'URL;VALUE=URI'  => get_permalink($event->ID()),
+						'DTSTART'        => date(EED_Ical::iCal_datetime_format, $datetime->start()),
+						'DTEND'          => date(EED_Ical::iCal_datetime_format, $datetime->end()),
+					];
+
+					// Filter the values used within the ics output.
+					// NOTE - all values within ics_data will be escaped automatically.
+					$ics_data = apply_filters('FHEE__EED_Ical__download_ics_file_ics_data', $ics_data, $datetime);
+
+					// Escape all ics data
+					foreach ($ics_data as $key => $value) {
+						// Description is escaped differently from all all values
+						if ($key === 'DESCRIPTION') {
+							$ics_data[ $key ] = EED_Ical::_escape_ICal_description(wp_strip_all_tags($value));
+						} else {
+							$ics_data[ $key ] = EED_Ical::_escape_ICal_data($value);
+						}
+					}
+
+					// Pull the organizer name from ics_data and remove it from the array.
+					$organizer_name = isset($ics_data['ORGANIZER_NAME'])
+						? $ics_data['ORGANIZER_NAME']
+						: '';
+					unset($ics_data['ORGANIZER_NAME']);
+
+					// set headers
+					header('Content-type: text/calendar; charset=utf-8');
+					header('Content-Disposition: attachment; filename="' . $filename . '"');
+					header('Cache-Control: private, max-age=0, must-revalidate');
+					header('Pragma: public');
+					header('Content-Type: application/octet-stream');
+					header('Content-Type: application/force-download');
+					header('Cache-Control: no-cache, must-revalidate');
+					header('Content-Transfer-Encoding: binary');
+					header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // past date
+					ini_set('zlib.output_compression', '0');
+					// echo the output
+					echo "BEGIN:VCALENDAR\r\n";
+					echo "VERSION:2.0\r\n";
+					echo "PRODID:-//{$organizer_name}//NONSGML PDA Calendar Version 1.0//EN\r\n";
+					echo "CALSCALE:GREGORIAN\r\n";
+					echo "BEGIN:VEVENT\r\n";
+
+					// Output all remaining values from ics_data.
+					foreach ($ics_data as $key => $value) {
+						echo $key . ':' . $value . "\r\n";
+					}
+
+					echo "END:VEVENT\r\n";
+					echo "END:VCALENDAR\r\n";
+				}
+			}
+		}
+		die();
+	}
+
+
+	/**
+	 *    _escape_ICal_data
+	 *
+	 * @param string $string
+	 * @return    string
+	 */
+	private static function _escape_ICal_data($string = '')
+	{
+		return preg_replace('/([\,;])/', '\\\$1', $string);
+	}
+
+
+	/**
+	 *    _escape_ICal_description
+	 *
+	 * @param string $description
+	 * @return    string
+	 */
+	private static function _escape_ICal_description($description = '')
+	{
+		// Escape special chars within the description
+		$description = EED_Ical::_escape_ICal_data($description);
+		// Remove line breaks and output in iCal format
+		return str_replace(["\r\n", "\n"], '\n', $description);
+	}
 }

core/libraries/shortcodes/EE_Transaction_Shortcodes.lib.php

Indentation +775 added lines, -775 removed lines

@@ -17,783 +17,783 @@
 class EE_Transaction_Shortcodes extends EE_Shortcodes
 {
 
-    /**
-     * @var EE_Payment_Method $_invoice_pm the invoice payment method for use in invoices etc
-     */
-    protected $_invoice_pm;
-
-
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Transaction Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes specific to transaction related data', 'event_espresso');
-        $this->_shortcodes = array(
-            '[TXN_ID]'                          => esc_html__('The transaction id for the purchase.', 'event_espresso'),
-            '[PAYMENT_URL]'                     => esc_html__(
-                'This is a link to make a payment for the event',
-                'event_espresso'
-            ),
-            '[PAYMENT_LINK_IF_NEEDED_*]'        => esc_html__(
-                'This is a special dynamic shortcode that allows one to insert a payment link conditional on there being amount owing on the transaction. Three params are available on this shortcode:',
-                'event_espresso'
-            )
-                                                   . '<ul>'
-                                                   . '<li>'
-                                                   . sprintf(
-                                                       esc_html__(
-                                                           '%sclass:%s This can be used to indicate css class is given to the containing css element (default is "callout").',
-                                                           'event_espresso'
-                                                       ),
-                                                       '<strong>',
-                                                       '</strong>'
-                                                   )
-                                                   . '</li>'
-                                                   . '<li>'
-                                                   . sprintf(
-                                                       esc_html__(
-                                                           '%scustom_text:%s This should be a sprintf format text string (with %%s for where the hyperlink tags go) that is used for the generated link text (The default is "You can %%smake a payment here »%%s.)',
-                                                           'event_espresso'
-                                                       ),
-                                                       '<strong>',
-                                                       '</strong>'
-                                                   )
-                                                   . '</li>'
-                                                   . '<li>'
-                                                   . sprintf(
-                                                       esc_html__(
-                                                           '%scontainer_tag:%s Use this to indicate what container tag you want surrounding the payment link (default is "p").',
-                                                           'event_espresso'
-                                                       ),
-                                                       '<strong>',
-                                                       '</strong>'
-                                                   )
-                                                   . '</li>'
-                                                   . '</ul>',
-            '[PAYMENT_DUE_DATE_*]'              => esc_html__(
-                'This is a special dynamic shortcode that allows one to output a payment due date.  It will only result in a date shown if there is money owing.  Three parameters are available on this shortcode:',
-                'event_espresso'
-            )
-                                                   . '<ul>'
-                                                   . '<li>'
-                                                   . sprintf(
-                                                       esc_html__(
-                                                           '%sformat:%s This is used to indicate what format the date is in.  Default is whatever is set as date formats for your website.',
-                                                           'event_espresso'
-                                                       ),
-                                                       '<strong>',
-                                                       '</strong>'
-                                                   )
-                                                   . '</li>'
-                                                   . '<li>'
-                                                   . sprintf(
-                                                       esc_html__(
-                                                           '%sdays_until_due:%s This is the number of days form the transaction creation date that the payment is due.  Defaults to 30.',
-                                                           'event_espresso'
-                                                       ),
-                                                       '<strong>',
-                                                       '</strong>'
-                                                   )
-                                                   . '</li>'
-                                                   . '<li>'
-                                                   . sprintf(
-                                                       esc_html__(
-                                                           '%sprefix_text:%s You can use this to indicate what text will prefix the date string.  Defaults to "Payment in full due by:"',
-                                                           'event_espresso'
-                                                       ),
-                                                       '<strong>',
-                                                       '</strong>'
-                                                   )
-                                                   . '</li>',
-            '[INVOICE_LINK]'                    => esc_html__(
-                'This is a full html link to the invoice',
-                'event_espresso'
-            ),
-            '[INVOICE_URL]'                     => esc_html__(
-                'This is just the url for the invoice',
-                'event_espresso'
-            ),
-            '[INVOICE_LOGO_URL]'                => esc_html__(
-                'This returns the url for the logo uploaded via the invoice settings page.',
-                'event_espresso'
-            ),
-            '[INVOICE_LOGO]'                    => esc_html__(
-                'This returns the logo uploaded via the invoice settings page wrapped in img_tags and with a "logo screen" classes. The image size is also set in the img tags automatically to match the uploaded logo.',
-                'event_espresso'
-            ),
-            '[INVOICE_PAYEE_NAME]'              => esc_html__(
-                'This will parse to either: the value of the "Company Name" field in the invoice payment method settings; if that is blank, then the value of the Company Name in the "Your Organization Settings", if that is blank then an empty string.',
-                'event_espresso'
-            ),
-            '[INVOICE_PAYEE_ADDRESS]'           => esc_html__(
-                'This will parse to either: the value of the "Company Address" field in the invoice payment method settings; if that is blank, then the value of the Company Address in the "Your Organization Settings", if that is blank then an empty string.',
-                'event_espresso'
-            ),
-            '[INVOICE_PAYMENT_INSTRUCTIONS]'    => esc_html__(
-                'This will parse to the value of the "Payment Instructions" field found on the Invoice payment methods settings page',
-                'event_espresso'
-            ),
-            '[INVOICE_PAYEE_EMAIL]'             => esc_html__(
-                'This will parse to either: the value of the "Company Email" field in the invoice payment method settings; if that is blank, then the value of the Company Email in the "Your Organization Settings", if that is blank then an empty string.',
-                'event_espresso'
-            ),
-            '[INVOICE_PAYEE_TAX_NUMBER_*]'      => sprintf(
-                esc_html__(
-                    'This will parse to either: the value of the "Company Tax Number" field in the invoice payment method settings; if that is blank, then the value of the Company Tax Number in the "Your Organization Settings", if that is blank then an empty string. Note this is also a special dynamic shortcode. You can use the "prefix" parameter to indicate what text you want to use as a prefix before this tax number.  It defaults to "VAT/Tax Number:". To change this prefix you do the following format for this shortcode: %1$s[INVOICE_PAYEE_TAX_NUMBER_* prefix="GST:"]%2$s and that will output: GST: 12345t56.  If you have no tax number in your settings, then no prefix will be output either.',
-                    'event_espresso'
-                ),
-                '<code>',
-                '</code>'
-            ),
-            '[TOTAL_COST]'                      => esc_html__('The total cost for the transaction', 'event_espresso'),
-            '[TXN_STATUS]'                      => esc_html__(
-                'The transaction status for the transaction.',
-                'event_espresso'
-            ),
-            '[TXN_STATUS_ID]'                   => esc_html__(
-                'The ID representing the transaction status as saved in the db.  This tends to be useful for including with css classes for styling certain statuses differently from others.',
-                'event_espresso'
-            ),
-            '[PAYMENT_STATUS]'                  => esc_html__(
-                'The transaction status for the transaction. This parses to the same value as the [TXN_STATUS] shortcode and still remains here for legacy support.',
-                'event_espresso'
-            ),
-            '[PAYMENT_GATEWAY]'                 => esc_html__(
-                'The payment gateway used for the transaction',
-                'event_espresso'
-            ),
-            '[AMOUNT_PAID]'                     => esc_html__(
-                'The amount paid or refunded.  This will only have a value if there was a payment or refund at the time of generating the message.',
-                'event_espresso'
-            ),
-            '[LAST_AMOUNT_PAID]'                => esc_html__(
-                'This is the last payment or refund made on the transaction related to the message being generated.',
-                'event_espresso'
-            ),
-            '[TOTAL_AMOUNT_PAID]'               => esc_html__(
-                'This parses to the total amount paid over all payments',
-                'event_espresso'
-            ),
-            '[TOTAL_OWING]'                     => esc_html__(
-                'The total owing on a transaction with no attributes.',
-                'event_espresso'
-            ),
-            '[TXN_SUBTOTAL]'                    => esc_html__('The subtotal for all txn line items.', 'event_espresso'),
-            '[TXN_TAX_SUBTOTAL]'                => esc_html__('The subtotal for all tax line items.', 'event_espresso'),
-            '[OWING_STATUS_MESSAGE_*]'          => esc_html__(
-                'A dynamic shortcode for adjusting how total owing gets shown. The acceptable attributes on the shortcode are:',
-                'event_espresso'
-            )
-                                                   . '<p></ul>'
-                                                   . '<li><strong>still_owing</strong>:'
-                                                   . esc_html__(
-                                                       'If the transaction is not paid in full, then whatever is set for this attribute is shown (otherwise its just the amount owing). The default is:',
-                                                       'event_espresso'
-                                                   )
-                                                   . sprintf(
-                                                       esc_html__('%sPlease make a payment.%s', 'event_espresso'),
-                                                       '<a href="[PAYMENT_URL]" class="noPrint">',
-                                                       '</a>'
-                                                   )
-                                                   . '</li>'
-                                                   .
-                                                   '<li><strong>none_owing</strong>:'
-                                                   . esc_html__(
-                                                       'If the transaction is paid in full, then you can indicate how this gets displayed.  Note, that it defaults to just be the total owing.',
-                                                       'event_espresso'
-                                                   )
-                                                   . '</li></ul></p>',
-            '[TXN_TOTAL_TICKETS]'               => esc_html__(
-                'The total number of all tickets purchased in a transaction',
-                'event_espresso'
-            ),
-            '[TKT_QTY_PURCHASED]'               => sprintf(
-                esc_html__(
-                    'The total number of all tickets purchased in a transaction. %1$sNOTE: This shortcode is good to use in the "[TICKET_LIST]" field but has been deprecated from all other contexts in favor of the more explicit [TXN_TOTAL_TICKETS] shortcode.%2$s',
-                    'event_espresso'
-                ),
-                '<strong>',
-                '</strong>'
-            ),
-            '[TRANSACTION_ADMIN_URL]'           => esc_html__(
-                'The url to the admin page for this transaction',
-                'event_espresso'
-            ),
-            '[RECEIPT_URL]'                     => esc_html__(
-                'This parses to the generated url for retrieving the receipt for the transaction',
-                'event_espresso'
-            ),
-            '[INVOICE_RECEIPT_SWITCHER_URL]'    => esc_html__(
-                'This parses to the url that will switch to the receipt if an invoice is displayed, and switch to the invoice if receipt is displayed. If a message type OTHER than invoice or receipt is displayed then this will just return the url for the invoice. If the related message type is not active  then will parse to an empty string.',
-                'event_espresso'
-            ),
-            '[INVOICE_RECEIPT_SWITCHER_BUTTON]' => sprintf(
-                esc_html__(
-                    'The same as %1$s%2$s except this returns the html for a button linked to the invoice or receipt.',
-                    'event_espresso'
-                ),
-                '<code>[INVOICE_RECEIPT_SWITCHER_URL]',
-                '</code>'
-            ),
-            '[LAST_PAYMENT_TRANSACTION_ID]'     => esc_html__(
-                'This will output the value of the payment transaction id for the last payment made on the transaction. Note, if a specific payment was included for message generation, that will be used when parsing the shortcode.',
-                'event_espresso'
-            ),
-        );
-    }
-
-
-    /**
-     * @param  string $shortcode the shortcode to be parsed.
-     * @return string parsed shortcode
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _parser($shortcode)
-    {
-        // attempt to get the transaction.  Since this is potentially used in more fields, we may have to look in the
-        // _extra_data for the transaction.
-        $transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null;
-        $transaction = ! $transaction instanceof EE_Transaction
-                       && is_array($this->_extra_data)
-                       && isset($this->_extra_data['data'])
-                       && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-            ? $this->_extra_data['data']->txn
-            : $transaction;
-        // payment
-        $payment = $this->_data->payment instanceof EE_Payment ? $this->_data->payment : null;
-        $payment = ! $payment instanceof EE_Payment
-                   && is_array($this->_extra_data)
-                   && isset($this->_extra_data['data'])
-                   && $this->_extra_data['data'] instanceof EE_Messages_Addressee ? $this->_extra_data['data']->payment
-            : $payment;
-        if (! $transaction instanceof EE_Transaction) {
-            return '';
-        }
-        switch ($shortcode) {
-            case '[TXN_ID]':
-                return $transaction->ID();
-                break;
-            case '[PAYMENT_URL]':
-                $payment_url = $transaction->payment_overview_url();
-                return empty($payment_url)
-                    ? esc_html__('http://dummypaymenturlforpreview.com', 'event_espresso')
-                    : $payment_url;
-                break;
-            case '[INVOICE_LINK]':
-                $invoice_url = $transaction->invoice_url();
-                $invoice_url = empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
-                return sprintf(
-                    esc_html__('%sClick here for Invoice%s', 'event_espresso'),
-                    '<a href="' . $invoice_url . '">',
-                    '</a>'
-                );
-                break;
-            case '[INVOICE_URL]':
-                $invoice_url = $transaction->invoice_url();
-                return empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
-                break;
-            case '[INVOICE_LOGO_URL]':
-                return $this->_get_invoice_logo();
-                break;
-            case '[INVOICE_LOGO]':
-                return $this->_get_invoice_logo(true);
-                break;
-            case '[INVOICE_PAYEE_NAME]':
-                return $this->_get_invoice_payee_name();
-                break;
-            case '[INVOICE_PAYEE_ADDRESS]':
-                return $this->_get_invoice_payee_address();
-                break;
-            case '[INVOICE_PAYMENT_INSTRUCTIONS]':
-                return $this->_get_invoice_payment_instructions();
-                break;
-            case '[INVOICE_PAYEE_EMAIL]':
-                return $this->_get_invoice_payee_email();
-                break;
-            case '[TOTAL_COST]':
-                $total = $transaction->total();
-                return ! empty($total) ? EEH_Template::format_currency($total) : '';
-                break;
-            case '[PAYMENT_STATUS]':
-                $status = $transaction->pretty_status();
-                return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso');
-                break; /**/
-            // note the [payment_status] shortcode is kind of misleading because payment status might be different
-            // from txn status so I'm adding this here for clarity.
-            case '[TXN_STATUS]':
-                $status = $transaction->pretty_status();
-                return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso');
-                break;
-            case '[TXN_STATUS_ID]':
-                return $transaction->status_ID();
-                break;
-            case '[PAYMENT_GATEWAY]':
-                return $this->_get_payment_gateway($transaction);
-                break;
-            case '[AMOUNT_PAID]':
-                return $payment instanceof EE_Payment
-                    ? EEH_Template::format_currency($payment->amount())
-                    : EEH_Template::format_currency(0);
-                break;
-            case '[LAST_AMOUNT_PAID]':
-                $last_payment = $transaction->last_payment();
-                return $last_payment instanceof EE_Payment
-                    ? EEH_Template::format_currency($last_payment->amount())
-                    : EEH_Template::format_currency(0);
-            case '[TOTAL_AMOUNT_PAID]':
-                return EEH_Template::format_currency($transaction->paid());
-                break;
-            case '[TOTAL_OWING]':
-                $total_owing = $transaction->remaining();
-                return EEH_Template::format_currency($total_owing);
-                break;
-            case '[TXN_SUBTOTAL]':
-                return EEH_Template::format_currency($this->_get_subtotal());
-                break;
-            case '[TXN_TAX_SUBTOTAL]':
-                return EEH_Template::format_currency($this->_get_subtotal(true));
-                break;
-            case '[TKT_QTY_PURCHASED]':
-            case '[TXN_TOTAL_TICKETS]':
-                return $this->_data->total_ticket_count;
-                break;
-            case '[TRANSACTION_ADMIN_URL]':
-                require_once EE_CORE . 'admin/EE_Admin_Page.core.php';
-                $query_args = array(
-                    'page'   => 'espresso_transactions',
-                    'action' => 'view_transaction',
-                    'TXN_ID' => $transaction->ID(),
-                );
-                $url = EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php'));
-                return $url;
-                break;
-            case '[RECEIPT_URL]':
-                // get primary_registration
-                $reg = $this->_data->primary_reg_obj;
-                if (! $reg instanceof EE_Registration) {
-                    return '';
-                }
-                return $reg->receipt_url();
-                break;
-            case '[INVOICE_RECEIPT_SWITCHER_URL]':
-                return $this->_get_invoice_receipt_switcher(false);
-                break;
-            case '[INVOICE_RECEIPT_SWITCHER_BUTTON]':
-                return $this->_get_invoice_receipt_switcher();
-                break;
-            case '[LAST_PAYMENT_TRANSACTION_ID]':
-                $id = '';
-                $payment = $payment instanceof EE_Payment && $payment->ID() !== 0
-                    ? $payment
-                    : $transaction->last_payment();
-                if ($payment instanceof EE_Payment) {
-                    $id = $payment->txn_id_chq_nmbr();
-                }
-                return $id;
-                break;
-        }
-        if (strpos($shortcode, '[OWING_STATUS_MESSAGE_*') !== false) {
-            return $this->_get_custom_total_owing($shortcode);
-        }
-        if (strpos($shortcode, '[INVOICE_PAYEE_TAX_NUMBER_*') !== false) {
-            return $this->_get_invoice_payee_tax_number($shortcode);
-        }
-        if (strpos($shortcode, '[PAYMENT_LINK_IF_NEEDED_*') !== false) {
-            return $this->_get_payment_link_if_needed($shortcode);
-        }
-        if (strpos($shortcode, '[PAYMENT_DUE_DATE_*') !== false) {
-            return $this->_get_payment_due_date($shortcode, $transaction);
-        }
-        return '';
-    }
-
-
-    /**
-     * parser for the [OWING_STATUS_MESSAGE_*] attribute type shortcode
-     *
-     * @since 4.5.0
-     * @param string $shortcode the incoming shortcode
-     * @return string parsed.
-     * @throws EE_Error
-     */
-    private function _get_custom_total_owing($shortcode)
-    {
-        $valid_shortcodes = array('transaction');
-        $attrs = $this->_get_shortcode_attrs($shortcode);
-        // ensure default is set.
-        $addressee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-        $total_owing = $addressee instanceof EE_Messages_Addressee && $addressee->txn instanceof EE_Transaction
-            ? $addressee->txn->remaining() : 0;
-        if ($total_owing > 0) {
-            $owing_content = ! empty($attrs['still_owing'])
-                ? $attrs['still_owing']
-                : sprintf(
-                    esc_html__('%sPlease make a payment.%s', 'event_espresso'),
-                    '<a href="[PAYMENT_URL]" class="noPrint">',
-                    '</a>'
-                );
-            $owing_content = $this->_shortcode_helper->parse_message_template(
-                $owing_content,
-                $addressee,
-                $valid_shortcodes,
-                $this->_message_type,
-                $this->_messenger,
-                $this->_message
-            );
-        } else {
-            $owing_content = ! empty($attrs['none_owing']) ? $attrs['none_owing'] : '';
-        }
-        return $owing_content;
-    }
-
-
-    /**
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     */
-    private function _get_payment_gateway($transaction)
-    {
-        if ($transaction instanceof EE_Transaction) {
-            $pm = $transaction->payment_method();
-        } else {
-            $pm = null;
-        }
-        return $pm instanceof EE_Payment_Method ? $pm->name() : '';
-    }
-
-
-    /**
-     * This retrieves a logo to be used for the invoice from whatever is set on the invoice logo settings page.  If its
-     * not present then the organization logo is used if its found (set on the organization settings page).
-     *
-     * @since 4.5.0
-     * @param bool $img_tags TRUE means to return with the img tag wrappers.  False just returns the url to the image.
-     * @return string url or html
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_invoice_logo($img_tags = false)
-    {
-        $invoice_logo_url = '';
-        // try to get the invoice payment method's logo for this transaction image first
-        $pm = $this->_get_invoice_payment_method();
-        if ($pm instanceof EE_Payment_Method) {
-            $invoice_logo_url = $pm->get_extra_meta('pdf_logo_image', true);
-        }
-        if (empty($invoice_logo_url)) {
-            $invoice_logo_url = EE_Registry::instance()->CFG->organization->logo_url;
-        }
-        if (empty($invoice_logo_url)) {
-            return '';
-        }
-        if (! $img_tags) {
-            return $invoice_logo_url;
-        }
-        // image tags have been requested.
-        $image_size = getimagesize($invoice_logo_url);
-        // if image is wider than 300px, set the width to 300
-        if ($image_size[0] > 300) {
-            $image_width = 300;
-        } else {
-            $image_width = $image_size[0];
-        }
-        return '<img class="logo screen" src="' . esc_url_raw($invoice_logo_url) . '" width="' . esc_attr($image_width) . '" alt="logo" />';
-    }
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payee name shortcode
-     *
-     * @since 4.5.0
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_invoice_payee_name()
-    {
-        $payee_name = null;
-        $pm = $this->_get_invoice_payment_method();
-        if ($pm instanceof EE_Payment_Method) {
-            $payee_name = $pm->get_extra_meta('pdf_payee_name', true);
-        }
-        $payee_name = empty($payee_name) ? EE_Registry::instance()->CFG->organization->get_pretty('name') : $payee_name;
-        return $payee_name;
-    }
-
-
-    /**
-     * gets the default invoice payment method, but has a filter so it can be overridden
-     *
-     * @return EE_Payment_Method|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_invoice_payment_method()
-    {
-        if (! $this->_invoice_pm instanceof EE_Payment_Method) {
-            $transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null;
-            $transaction = ! $transaction instanceof EE_Transaction
-                           && is_array($this->_extra_data)
-                           && isset($this->_extra_data['data'])
-                           && $this->_extra_data['data'] instanceof EE_Messages_Addressee
-                ? $this->_extra_data['data']->txn : $transaction;
-            // get the invoice payment method, and remember it for the next call too
-            $this->_invoice_pm = apply_filters(
-                'FHEE__EE_Transaction_Shortcodes__get_payment_method__default',
-                EEM_Payment_Method::instance()->get_one_of_type('Invoice'),
-                $transaction
-            );
-        }
-        return $this->_invoice_pm;
-    }
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payee email shortcode
-     *
-     * @since 4.5.0
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_invoice_payee_email()
-    {
-        $payee_email = null;
-        $pm = $this->_get_invoice_payment_method();
-        if ($pm instanceof EE_Payment_Method) {
-            $payee_email = $pm->get_extra_meta('pdf_payee_email', true);
-        }
-        $payee_email = empty($payee_email) ? EE_Registry::instance()->CFG->organization->get_pretty('email')
-            : $payee_email;
-        return $payee_email;
-    }
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payee tax number shortcode
-     *
-     * @since 4.5.0
-     * @param string $shortcode
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_invoice_payee_tax_number($shortcode)
-    {
-        $payee_tax_number = null;
-        $pm = $this->_get_invoice_payment_method();
-        if ($pm instanceof EE_Payment_Method) {
-            $payee_tax_number = $pm->get_extra_meta('pdf_payee_tax_number', true);
-        }
-        $payee_tax_number = empty($payee_tax_number) ? EE_Registry::instance()->CFG->organization->vat
-            : $payee_tax_number;
-        if (empty($payee_tax_number)) {
-            return '';
-        }
-        // any attributes?
-        $attrs = $this->_get_shortcode_attrs($shortcode);
-        // prefix?
-        $prefix = isset($attrs['prefix']) ? $attrs['prefix'] : esc_html__('VAT/Tax Number: ', 'event_espresso');
-        return $prefix . $payee_tax_number;
-    }
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payee address shortcode.
-     *
-     * @since 4.5.0
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_invoice_payee_address()
-    {
-        $payee_address = null;
-        $pm = $this->_get_invoice_payment_method();
-        if ($pm instanceof EE_Payment_Method) {
-            $payee_address = $pm->get_extra_meta('pdf_payee_address', true);
-        }
-        if (empty($payee_address)) {
-            $organization = EE_Registry::instance()->CFG->organization;
-            $payee_address = $organization->get_pretty('address_1') . '<br>';
-            $payee_address .= ! empty($organization->address_2)
-                ? $organization->get_pretty('address_2') . '<br>'
-                : '';
-            $payee_address .= $organization->get_pretty('city') . '<br>';
-            // state
-            $state = EE_Registry::instance()->load_model('State')->get_one_by_ID($organization->STA_ID);
-            $payee_address .= $state instanceof EE_State ? $state->name() : '';
-            // Country
-            $payee_address .= ! empty($organization->CNT_ISO) ? ', ' . $organization->CNT_ISO . '<br>' : '';
-            $payee_address .= ! empty($organization->zip) ? $organization->zip : '';
-        }
-        return $payee_address;
-    }
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payment instructions shortcode.
-     *
-     * @since 4.5.0
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_invoice_payment_instructions()
-    {
-        $instructions = null;
-        $pm = $this->_get_invoice_payment_method();
-        return ($pm instanceof EE_Payment_Method) ? $pm->get_extra_meta('pdf_instructions', true) : '';
-    }
-
-
-    /**
-     * get invoice/receipt switch button or url.
-     *
-     * @param bool $button true (default) returns the html for a button, false just returns the url.
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_invoice_receipt_switcher($button = true)
-    {
-        $reg = $this->_data->primary_reg_obj;
-        $message_type = isset($this->_extra_data['message_type']) ? $this->_extra_data['message_type'] : '';
-        if (! $reg instanceof EE_Registration || empty($message_type)) {
-            return '';
-        }
-        $switch_to_invoice = ! $message_type instanceof EE_Invoice_message_type ? true : false;
-        $switch_to_label = $switch_to_invoice && ! $message_type instanceof EE_Receipt_message_type
-            ? esc_html__('View Invoice', 'event_espresso') : esc_html__('Switch to Invoice', 'event_espresso');
-        $switch_to_label = ! $switch_to_invoice ? esc_html__('Switch to Receipt', 'event_espresso') : $switch_to_label;
-        $switch_to_url = $switch_to_invoice ? $reg->invoice_url() : $reg->receipt_url();
-        if (! $button) {
-            return $switch_to_url;
-        }
-        if (! empty($switch_to_url)) {
-            return '
+	/**
+	 * @var EE_Payment_Method $_invoice_pm the invoice payment method for use in invoices etc
+	 */
+	protected $_invoice_pm;
+
+
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Transaction Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes specific to transaction related data', 'event_espresso');
+		$this->_shortcodes = array(
+			'[TXN_ID]'                          => esc_html__('The transaction id for the purchase.', 'event_espresso'),
+			'[PAYMENT_URL]'                     => esc_html__(
+				'This is a link to make a payment for the event',
+				'event_espresso'
+			),
+			'[PAYMENT_LINK_IF_NEEDED_*]'        => esc_html__(
+				'This is a special dynamic shortcode that allows one to insert a payment link conditional on there being amount owing on the transaction. Three params are available on this shortcode:',
+				'event_espresso'
+			)
+												   . '<ul>'
+												   . '<li>'
+												   . sprintf(
+													   esc_html__(
+														   '%sclass:%s This can be used to indicate css class is given to the containing css element (default is "callout").',
+														   'event_espresso'
+													   ),
+													   '<strong>',
+													   '</strong>'
+												   )
+												   . '</li>'
+												   . '<li>'
+												   . sprintf(
+													   esc_html__(
+														   '%scustom_text:%s This should be a sprintf format text string (with %%s for where the hyperlink tags go) that is used for the generated link text (The default is "You can %%smake a payment here »%%s.)',
+														   'event_espresso'
+													   ),
+													   '<strong>',
+													   '</strong>'
+												   )
+												   . '</li>'
+												   . '<li>'
+												   . sprintf(
+													   esc_html__(
+														   '%scontainer_tag:%s Use this to indicate what container tag you want surrounding the payment link (default is "p").',
+														   'event_espresso'
+													   ),
+													   '<strong>',
+													   '</strong>'
+												   )
+												   . '</li>'
+												   . '</ul>',
+			'[PAYMENT_DUE_DATE_*]'              => esc_html__(
+				'This is a special dynamic shortcode that allows one to output a payment due date.  It will only result in a date shown if there is money owing.  Three parameters are available on this shortcode:',
+				'event_espresso'
+			)
+												   . '<ul>'
+												   . '<li>'
+												   . sprintf(
+													   esc_html__(
+														   '%sformat:%s This is used to indicate what format the date is in.  Default is whatever is set as date formats for your website.',
+														   'event_espresso'
+													   ),
+													   '<strong>',
+													   '</strong>'
+												   )
+												   . '</li>'
+												   . '<li>'
+												   . sprintf(
+													   esc_html__(
+														   '%sdays_until_due:%s This is the number of days form the transaction creation date that the payment is due.  Defaults to 30.',
+														   'event_espresso'
+													   ),
+													   '<strong>',
+													   '</strong>'
+												   )
+												   . '</li>'
+												   . '<li>'
+												   . sprintf(
+													   esc_html__(
+														   '%sprefix_text:%s You can use this to indicate what text will prefix the date string.  Defaults to "Payment in full due by:"',
+														   'event_espresso'
+													   ),
+													   '<strong>',
+													   '</strong>'
+												   )
+												   . '</li>',
+			'[INVOICE_LINK]'                    => esc_html__(
+				'This is a full html link to the invoice',
+				'event_espresso'
+			),
+			'[INVOICE_URL]'                     => esc_html__(
+				'This is just the url for the invoice',
+				'event_espresso'
+			),
+			'[INVOICE_LOGO_URL]'                => esc_html__(
+				'This returns the url for the logo uploaded via the invoice settings page.',
+				'event_espresso'
+			),
+			'[INVOICE_LOGO]'                    => esc_html__(
+				'This returns the logo uploaded via the invoice settings page wrapped in img_tags and with a "logo screen" classes. The image size is also set in the img tags automatically to match the uploaded logo.',
+				'event_espresso'
+			),
+			'[INVOICE_PAYEE_NAME]'              => esc_html__(
+				'This will parse to either: the value of the "Company Name" field in the invoice payment method settings; if that is blank, then the value of the Company Name in the "Your Organization Settings", if that is blank then an empty string.',
+				'event_espresso'
+			),
+			'[INVOICE_PAYEE_ADDRESS]'           => esc_html__(
+				'This will parse to either: the value of the "Company Address" field in the invoice payment method settings; if that is blank, then the value of the Company Address in the "Your Organization Settings", if that is blank then an empty string.',
+				'event_espresso'
+			),
+			'[INVOICE_PAYMENT_INSTRUCTIONS]'    => esc_html__(
+				'This will parse to the value of the "Payment Instructions" field found on the Invoice payment methods settings page',
+				'event_espresso'
+			),
+			'[INVOICE_PAYEE_EMAIL]'             => esc_html__(
+				'This will parse to either: the value of the "Company Email" field in the invoice payment method settings; if that is blank, then the value of the Company Email in the "Your Organization Settings", if that is blank then an empty string.',
+				'event_espresso'
+			),
+			'[INVOICE_PAYEE_TAX_NUMBER_*]'      => sprintf(
+				esc_html__(
+					'This will parse to either: the value of the "Company Tax Number" field in the invoice payment method settings; if that is blank, then the value of the Company Tax Number in the "Your Organization Settings", if that is blank then an empty string. Note this is also a special dynamic shortcode. You can use the "prefix" parameter to indicate what text you want to use as a prefix before this tax number.  It defaults to "VAT/Tax Number:". To change this prefix you do the following format for this shortcode: %1$s[INVOICE_PAYEE_TAX_NUMBER_* prefix="GST:"]%2$s and that will output: GST: 12345t56.  If you have no tax number in your settings, then no prefix will be output either.',
+					'event_espresso'
+				),
+				'<code>',
+				'</code>'
+			),
+			'[TOTAL_COST]'                      => esc_html__('The total cost for the transaction', 'event_espresso'),
+			'[TXN_STATUS]'                      => esc_html__(
+				'The transaction status for the transaction.',
+				'event_espresso'
+			),
+			'[TXN_STATUS_ID]'                   => esc_html__(
+				'The ID representing the transaction status as saved in the db.  This tends to be useful for including with css classes for styling certain statuses differently from others.',
+				'event_espresso'
+			),
+			'[PAYMENT_STATUS]'                  => esc_html__(
+				'The transaction status for the transaction. This parses to the same value as the [TXN_STATUS] shortcode and still remains here for legacy support.',
+				'event_espresso'
+			),
+			'[PAYMENT_GATEWAY]'                 => esc_html__(
+				'The payment gateway used for the transaction',
+				'event_espresso'
+			),
+			'[AMOUNT_PAID]'                     => esc_html__(
+				'The amount paid or refunded.  This will only have a value if there was a payment or refund at the time of generating the message.',
+				'event_espresso'
+			),
+			'[LAST_AMOUNT_PAID]'                => esc_html__(
+				'This is the last payment or refund made on the transaction related to the message being generated.',
+				'event_espresso'
+			),
+			'[TOTAL_AMOUNT_PAID]'               => esc_html__(
+				'This parses to the total amount paid over all payments',
+				'event_espresso'
+			),
+			'[TOTAL_OWING]'                     => esc_html__(
+				'The total owing on a transaction with no attributes.',
+				'event_espresso'
+			),
+			'[TXN_SUBTOTAL]'                    => esc_html__('The subtotal for all txn line items.', 'event_espresso'),
+			'[TXN_TAX_SUBTOTAL]'                => esc_html__('The subtotal for all tax line items.', 'event_espresso'),
+			'[OWING_STATUS_MESSAGE_*]'          => esc_html__(
+				'A dynamic shortcode for adjusting how total owing gets shown. The acceptable attributes on the shortcode are:',
+				'event_espresso'
+			)
+												   . '<p></ul>'
+												   . '<li><strong>still_owing</strong>:'
+												   . esc_html__(
+													   'If the transaction is not paid in full, then whatever is set for this attribute is shown (otherwise its just the amount owing). The default is:',
+													   'event_espresso'
+												   )
+												   . sprintf(
+													   esc_html__('%sPlease make a payment.%s', 'event_espresso'),
+													   '<a href="[PAYMENT_URL]" class="noPrint">',
+													   '</a>'
+												   )
+												   . '</li>'
+												   .
+												   '<li><strong>none_owing</strong>:'
+												   . esc_html__(
+													   'If the transaction is paid in full, then you can indicate how this gets displayed.  Note, that it defaults to just be the total owing.',
+													   'event_espresso'
+												   )
+												   . '</li></ul></p>',
+			'[TXN_TOTAL_TICKETS]'               => esc_html__(
+				'The total number of all tickets purchased in a transaction',
+				'event_espresso'
+			),
+			'[TKT_QTY_PURCHASED]'               => sprintf(
+				esc_html__(
+					'The total number of all tickets purchased in a transaction. %1$sNOTE: This shortcode is good to use in the "[TICKET_LIST]" field but has been deprecated from all other contexts in favor of the more explicit [TXN_TOTAL_TICKETS] shortcode.%2$s',
+					'event_espresso'
+				),
+				'<strong>',
+				'</strong>'
+			),
+			'[TRANSACTION_ADMIN_URL]'           => esc_html__(
+				'The url to the admin page for this transaction',
+				'event_espresso'
+			),
+			'[RECEIPT_URL]'                     => esc_html__(
+				'This parses to the generated url for retrieving the receipt for the transaction',
+				'event_espresso'
+			),
+			'[INVOICE_RECEIPT_SWITCHER_URL]'    => esc_html__(
+				'This parses to the url that will switch to the receipt if an invoice is displayed, and switch to the invoice if receipt is displayed. If a message type OTHER than invoice or receipt is displayed then this will just return the url for the invoice. If the related message type is not active  then will parse to an empty string.',
+				'event_espresso'
+			),
+			'[INVOICE_RECEIPT_SWITCHER_BUTTON]' => sprintf(
+				esc_html__(
+					'The same as %1$s%2$s except this returns the html for a button linked to the invoice or receipt.',
+					'event_espresso'
+				),
+				'<code>[INVOICE_RECEIPT_SWITCHER_URL]',
+				'</code>'
+			),
+			'[LAST_PAYMENT_TRANSACTION_ID]'     => esc_html__(
+				'This will output the value of the payment transaction id for the last payment made on the transaction. Note, if a specific payment was included for message generation, that will be used when parsing the shortcode.',
+				'event_espresso'
+			),
+		);
+	}
+
+
+	/**
+	 * @param  string $shortcode the shortcode to be parsed.
+	 * @return string parsed shortcode
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _parser($shortcode)
+	{
+		// attempt to get the transaction.  Since this is potentially used in more fields, we may have to look in the
+		// _extra_data for the transaction.
+		$transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null;
+		$transaction = ! $transaction instanceof EE_Transaction
+					   && is_array($this->_extra_data)
+					   && isset($this->_extra_data['data'])
+					   && $this->_extra_data['data'] instanceof EE_Messages_Addressee
+			? $this->_extra_data['data']->txn
+			: $transaction;
+		// payment
+		$payment = $this->_data->payment instanceof EE_Payment ? $this->_data->payment : null;
+		$payment = ! $payment instanceof EE_Payment
+				   && is_array($this->_extra_data)
+				   && isset($this->_extra_data['data'])
+				   && $this->_extra_data['data'] instanceof EE_Messages_Addressee ? $this->_extra_data['data']->payment
+			: $payment;
+		if (! $transaction instanceof EE_Transaction) {
+			return '';
+		}
+		switch ($shortcode) {
+			case '[TXN_ID]':
+				return $transaction->ID();
+				break;
+			case '[PAYMENT_URL]':
+				$payment_url = $transaction->payment_overview_url();
+				return empty($payment_url)
+					? esc_html__('http://dummypaymenturlforpreview.com', 'event_espresso')
+					: $payment_url;
+				break;
+			case '[INVOICE_LINK]':
+				$invoice_url = $transaction->invoice_url();
+				$invoice_url = empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
+				return sprintf(
+					esc_html__('%sClick here for Invoice%s', 'event_espresso'),
+					'<a href="' . $invoice_url . '">',
+					'</a>'
+				);
+				break;
+			case '[INVOICE_URL]':
+				$invoice_url = $transaction->invoice_url();
+				return empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
+				break;
+			case '[INVOICE_LOGO_URL]':
+				return $this->_get_invoice_logo();
+				break;
+			case '[INVOICE_LOGO]':
+				return $this->_get_invoice_logo(true);
+				break;
+			case '[INVOICE_PAYEE_NAME]':
+				return $this->_get_invoice_payee_name();
+				break;
+			case '[INVOICE_PAYEE_ADDRESS]':
+				return $this->_get_invoice_payee_address();
+				break;
+			case '[INVOICE_PAYMENT_INSTRUCTIONS]':
+				return $this->_get_invoice_payment_instructions();
+				break;
+			case '[INVOICE_PAYEE_EMAIL]':
+				return $this->_get_invoice_payee_email();
+				break;
+			case '[TOTAL_COST]':
+				$total = $transaction->total();
+				return ! empty($total) ? EEH_Template::format_currency($total) : '';
+				break;
+			case '[PAYMENT_STATUS]':
+				$status = $transaction->pretty_status();
+				return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso');
+				break; /**/
+			// note the [payment_status] shortcode is kind of misleading because payment status might be different
+			// from txn status so I'm adding this here for clarity.
+			case '[TXN_STATUS]':
+				$status = $transaction->pretty_status();
+				return ! empty($status) ? $status : esc_html__('Unknown', 'event_espresso');
+				break;
+			case '[TXN_STATUS_ID]':
+				return $transaction->status_ID();
+				break;
+			case '[PAYMENT_GATEWAY]':
+				return $this->_get_payment_gateway($transaction);
+				break;
+			case '[AMOUNT_PAID]':
+				return $payment instanceof EE_Payment
+					? EEH_Template::format_currency($payment->amount())
+					: EEH_Template::format_currency(0);
+				break;
+			case '[LAST_AMOUNT_PAID]':
+				$last_payment = $transaction->last_payment();
+				return $last_payment instanceof EE_Payment
+					? EEH_Template::format_currency($last_payment->amount())
+					: EEH_Template::format_currency(0);
+			case '[TOTAL_AMOUNT_PAID]':
+				return EEH_Template::format_currency($transaction->paid());
+				break;
+			case '[TOTAL_OWING]':
+				$total_owing = $transaction->remaining();
+				return EEH_Template::format_currency($total_owing);
+				break;
+			case '[TXN_SUBTOTAL]':
+				return EEH_Template::format_currency($this->_get_subtotal());
+				break;
+			case '[TXN_TAX_SUBTOTAL]':
+				return EEH_Template::format_currency($this->_get_subtotal(true));
+				break;
+			case '[TKT_QTY_PURCHASED]':
+			case '[TXN_TOTAL_TICKETS]':
+				return $this->_data->total_ticket_count;
+				break;
+			case '[TRANSACTION_ADMIN_URL]':
+				require_once EE_CORE . 'admin/EE_Admin_Page.core.php';
+				$query_args = array(
+					'page'   => 'espresso_transactions',
+					'action' => 'view_transaction',
+					'TXN_ID' => $transaction->ID(),
+				);
+				$url = EE_Admin_Page::add_query_args_and_nonce($query_args, admin_url('admin.php'));
+				return $url;
+				break;
+			case '[RECEIPT_URL]':
+				// get primary_registration
+				$reg = $this->_data->primary_reg_obj;
+				if (! $reg instanceof EE_Registration) {
+					return '';
+				}
+				return $reg->receipt_url();
+				break;
+			case '[INVOICE_RECEIPT_SWITCHER_URL]':
+				return $this->_get_invoice_receipt_switcher(false);
+				break;
+			case '[INVOICE_RECEIPT_SWITCHER_BUTTON]':
+				return $this->_get_invoice_receipt_switcher();
+				break;
+			case '[LAST_PAYMENT_TRANSACTION_ID]':
+				$id = '';
+				$payment = $payment instanceof EE_Payment && $payment->ID() !== 0
+					? $payment
+					: $transaction->last_payment();
+				if ($payment instanceof EE_Payment) {
+					$id = $payment->txn_id_chq_nmbr();
+				}
+				return $id;
+				break;
+		}
+		if (strpos($shortcode, '[OWING_STATUS_MESSAGE_*') !== false) {
+			return $this->_get_custom_total_owing($shortcode);
+		}
+		if (strpos($shortcode, '[INVOICE_PAYEE_TAX_NUMBER_*') !== false) {
+			return $this->_get_invoice_payee_tax_number($shortcode);
+		}
+		if (strpos($shortcode, '[PAYMENT_LINK_IF_NEEDED_*') !== false) {
+			return $this->_get_payment_link_if_needed($shortcode);
+		}
+		if (strpos($shortcode, '[PAYMENT_DUE_DATE_*') !== false) {
+			return $this->_get_payment_due_date($shortcode, $transaction);
+		}
+		return '';
+	}
+
+
+	/**
+	 * parser for the [OWING_STATUS_MESSAGE_*] attribute type shortcode
+	 *
+	 * @since 4.5.0
+	 * @param string $shortcode the incoming shortcode
+	 * @return string parsed.
+	 * @throws EE_Error
+	 */
+	private function _get_custom_total_owing($shortcode)
+	{
+		$valid_shortcodes = array('transaction');
+		$attrs = $this->_get_shortcode_attrs($shortcode);
+		// ensure default is set.
+		$addressee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+		$total_owing = $addressee instanceof EE_Messages_Addressee && $addressee->txn instanceof EE_Transaction
+			? $addressee->txn->remaining() : 0;
+		if ($total_owing > 0) {
+			$owing_content = ! empty($attrs['still_owing'])
+				? $attrs['still_owing']
+				: sprintf(
+					esc_html__('%sPlease make a payment.%s', 'event_espresso'),
+					'<a href="[PAYMENT_URL]" class="noPrint">',
+					'</a>'
+				);
+			$owing_content = $this->_shortcode_helper->parse_message_template(
+				$owing_content,
+				$addressee,
+				$valid_shortcodes,
+				$this->_message_type,
+				$this->_messenger,
+				$this->_message
+			);
+		} else {
+			$owing_content = ! empty($attrs['none_owing']) ? $attrs['none_owing'] : '';
+		}
+		return $owing_content;
+	}
+
+
+	/**
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 */
+	private function _get_payment_gateway($transaction)
+	{
+		if ($transaction instanceof EE_Transaction) {
+			$pm = $transaction->payment_method();
+		} else {
+			$pm = null;
+		}
+		return $pm instanceof EE_Payment_Method ? $pm->name() : '';
+	}
+
+
+	/**
+	 * This retrieves a logo to be used for the invoice from whatever is set on the invoice logo settings page.  If its
+	 * not present then the organization logo is used if its found (set on the organization settings page).
+	 *
+	 * @since 4.5.0
+	 * @param bool $img_tags TRUE means to return with the img tag wrappers.  False just returns the url to the image.
+	 * @return string url or html
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_invoice_logo($img_tags = false)
+	{
+		$invoice_logo_url = '';
+		// try to get the invoice payment method's logo for this transaction image first
+		$pm = $this->_get_invoice_payment_method();
+		if ($pm instanceof EE_Payment_Method) {
+			$invoice_logo_url = $pm->get_extra_meta('pdf_logo_image', true);
+		}
+		if (empty($invoice_logo_url)) {
+			$invoice_logo_url = EE_Registry::instance()->CFG->organization->logo_url;
+		}
+		if (empty($invoice_logo_url)) {
+			return '';
+		}
+		if (! $img_tags) {
+			return $invoice_logo_url;
+		}
+		// image tags have been requested.
+		$image_size = getimagesize($invoice_logo_url);
+		// if image is wider than 300px, set the width to 300
+		if ($image_size[0] > 300) {
+			$image_width = 300;
+		} else {
+			$image_width = $image_size[0];
+		}
+		return '<img class="logo screen" src="' . esc_url_raw($invoice_logo_url) . '" width="' . esc_attr($image_width) . '" alt="logo" />';
+	}
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payee name shortcode
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_invoice_payee_name()
+	{
+		$payee_name = null;
+		$pm = $this->_get_invoice_payment_method();
+		if ($pm instanceof EE_Payment_Method) {
+			$payee_name = $pm->get_extra_meta('pdf_payee_name', true);
+		}
+		$payee_name = empty($payee_name) ? EE_Registry::instance()->CFG->organization->get_pretty('name') : $payee_name;
+		return $payee_name;
+	}
+
+
+	/**
+	 * gets the default invoice payment method, but has a filter so it can be overridden
+	 *
+	 * @return EE_Payment_Method|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_invoice_payment_method()
+	{
+		if (! $this->_invoice_pm instanceof EE_Payment_Method) {
+			$transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null;
+			$transaction = ! $transaction instanceof EE_Transaction
+						   && is_array($this->_extra_data)
+						   && isset($this->_extra_data['data'])
+						   && $this->_extra_data['data'] instanceof EE_Messages_Addressee
+				? $this->_extra_data['data']->txn : $transaction;
+			// get the invoice payment method, and remember it for the next call too
+			$this->_invoice_pm = apply_filters(
+				'FHEE__EE_Transaction_Shortcodes__get_payment_method__default',
+				EEM_Payment_Method::instance()->get_one_of_type('Invoice'),
+				$transaction
+			);
+		}
+		return $this->_invoice_pm;
+	}
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payee email shortcode
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_invoice_payee_email()
+	{
+		$payee_email = null;
+		$pm = $this->_get_invoice_payment_method();
+		if ($pm instanceof EE_Payment_Method) {
+			$payee_email = $pm->get_extra_meta('pdf_payee_email', true);
+		}
+		$payee_email = empty($payee_email) ? EE_Registry::instance()->CFG->organization->get_pretty('email')
+			: $payee_email;
+		return $payee_email;
+	}
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payee tax number shortcode
+	 *
+	 * @since 4.5.0
+	 * @param string $shortcode
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_invoice_payee_tax_number($shortcode)
+	{
+		$payee_tax_number = null;
+		$pm = $this->_get_invoice_payment_method();
+		if ($pm instanceof EE_Payment_Method) {
+			$payee_tax_number = $pm->get_extra_meta('pdf_payee_tax_number', true);
+		}
+		$payee_tax_number = empty($payee_tax_number) ? EE_Registry::instance()->CFG->organization->vat
+			: $payee_tax_number;
+		if (empty($payee_tax_number)) {
+			return '';
+		}
+		// any attributes?
+		$attrs = $this->_get_shortcode_attrs($shortcode);
+		// prefix?
+		$prefix = isset($attrs['prefix']) ? $attrs['prefix'] : esc_html__('VAT/Tax Number: ', 'event_espresso');
+		return $prefix . $payee_tax_number;
+	}
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payee address shortcode.
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_invoice_payee_address()
+	{
+		$payee_address = null;
+		$pm = $this->_get_invoice_payment_method();
+		if ($pm instanceof EE_Payment_Method) {
+			$payee_address = $pm->get_extra_meta('pdf_payee_address', true);
+		}
+		if (empty($payee_address)) {
+			$organization = EE_Registry::instance()->CFG->organization;
+			$payee_address = $organization->get_pretty('address_1') . '<br>';
+			$payee_address .= ! empty($organization->address_2)
+				? $organization->get_pretty('address_2') . '<br>'
+				: '';
+			$payee_address .= $organization->get_pretty('city') . '<br>';
+			// state
+			$state = EE_Registry::instance()->load_model('State')->get_one_by_ID($organization->STA_ID);
+			$payee_address .= $state instanceof EE_State ? $state->name() : '';
+			// Country
+			$payee_address .= ! empty($organization->CNT_ISO) ? ', ' . $organization->CNT_ISO . '<br>' : '';
+			$payee_address .= ! empty($organization->zip) ? $organization->zip : '';
+		}
+		return $payee_address;
+	}
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payment instructions shortcode.
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_invoice_payment_instructions()
+	{
+		$instructions = null;
+		$pm = $this->_get_invoice_payment_method();
+		return ($pm instanceof EE_Payment_Method) ? $pm->get_extra_meta('pdf_instructions', true) : '';
+	}
+
+
+	/**
+	 * get invoice/receipt switch button or url.
+	 *
+	 * @param bool $button true (default) returns the html for a button, false just returns the url.
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_invoice_receipt_switcher($button = true)
+	{
+		$reg = $this->_data->primary_reg_obj;
+		$message_type = isset($this->_extra_data['message_type']) ? $this->_extra_data['message_type'] : '';
+		if (! $reg instanceof EE_Registration || empty($message_type)) {
+			return '';
+		}
+		$switch_to_invoice = ! $message_type instanceof EE_Invoice_message_type ? true : false;
+		$switch_to_label = $switch_to_invoice && ! $message_type instanceof EE_Receipt_message_type
+			? esc_html__('View Invoice', 'event_espresso') : esc_html__('Switch to Invoice', 'event_espresso');
+		$switch_to_label = ! $switch_to_invoice ? esc_html__('Switch to Receipt', 'event_espresso') : $switch_to_label;
+		$switch_to_url = $switch_to_invoice ? $reg->invoice_url() : $reg->receipt_url();
+		if (! $button) {
+			return $switch_to_url;
+		}
+		if (! empty($switch_to_url)) {
+			return '
 	<form method="post" action="' . $switch_to_url . '" >
 		<input class="print_button" type="submit" value="' . $switch_to_label . '" />
 	</form>
 			';
-        }
-        return '';
-    }
-
-
-    /**
-     * This returns a subtotal.
-     *
-     * @param bool $tax if true then return the subtotal for tax otherwise return subtotal.
-     * @return int
-     * @throws EE_Error
-     */
-    private function _get_subtotal($tax = false)
-    {
-        $grand_total = isset($this->_data->grand_total_line_item) ? $this->_data->grand_total_line_item : null;
-        if (! $grand_total instanceof EE_Line_Item) {
-            return 0;
-        }
-        return $tax ? $grand_total->get_total_tax() : $grand_total->get_items_total();
-    }
-
-
-    /**
-     * parser for the [PAYMENT_LINK_IF_NEEDED_*] attribute type shortcode
-     *
-     * @since 4.7.0
-     * @param string $shortcode the incoming shortcode
-     * @return string parsed.
-     * @throws EE_Error
-     */
-    private function _get_payment_link_if_needed($shortcode)
-    {
-        $valid_shortcodes = array('transaction');
-        $attrs = $this->_get_shortcode_attrs($shortcode);
-        // ensure default is set.
-        $addressee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
-        $total_owing = $addressee instanceof EE_Messages_Addressee && $addressee->txn instanceof EE_Transaction
-            ? $addressee->txn->remaining() : 0;
-        if ($total_owing > 0) {
-            $class = isset($attrs['class']) ? $attrs['class'] : 'callout';
-            $custom_text = isset($attrs['custom_text']) ? $attrs['custom_text'] : 'You can %smake a payment here »%s.';
-            $container_tag = isset($attrs['container_tag']) ? $attrs['container_tag'] : 'p';
-            $opening_tag = ! empty($container_tag) ? '<' . $container_tag : '';
-            $opening_tag .= ! empty($opening_tag) && ! empty($class) ? ' class="' . $class . '"' : $opening_tag;
-            $opening_tag .= ! empty($opening_tag) ? '>' : $opening_tag;
-            $closing_tag = ! empty($container_tag) ? '</' . $container_tag . '>' : '';
-            $content = $opening_tag . sprintf($custom_text, '<a href="[PAYMENT_URL]">', '</a>') . $closing_tag;
-            // we need to re run this string through the parser to catch any shortcodes that are in it.
-            $owing_content = $this->_shortcode_helper->parse_message_template(
-                $content,
-                $addressee,
-                $valid_shortcodes,
-                $this->_message_type,
-                $this->_messenger,
-                $this->_message
-            );
-        } else {
-            return '';
-        }
-        return $owing_content;
-    }
-
-
-    /**
-     * Parser for the [PAYMENT_DUE_DATE_*] attribute type shortcode
-     *
-     * @since 4.8.28.rc.011
-     * @param string         $shortcode The shortcode being parsed.
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_payment_due_date($shortcode, EE_Transaction $transaction)
-    {
-        // if transaction is paid in full then we can just return an empty string
-        if ($transaction->remaining() === 0) {
-            return '';
-        }
-        $attrs = $this->_get_shortcode_attrs($shortcode);
-        $format = isset($attrs['format']) ? $attrs['format'] : get_option('date_format');
-        $days_until_due = isset($attrs['days_until_due']) ? (int) $attrs['days_until_due'] : 30;
-        $prefix_text = isset($attrs['prefix_text']) ? $attrs['prefix_text']
-            : esc_html__('Payment in full due by: ', 'event_espresso');
-        $transaction_created = $transaction->get_DateTime_object('TXN_timestamp');
-        // setup date due:
-        try {
-            if ($transaction_created instanceof DateTime) {
-                $date_due = $transaction_created->add(
-                    new DateInterval('P' . $days_until_due . 'D')
-                )->format($format);
-            } else {
-                throw new Exception();
-            }
-        } catch (Exception $e) {
-            // format was likely invalid.
-            $date_due = esc_html__(
-                'Unable to calculate date due, likely the format string is invalid.',
-                'event_espresso'
-            );
-        }
-        return $prefix_text . $date_due;
-    }
+		}
+		return '';
+	}
+
+
+	/**
+	 * This returns a subtotal.
+	 *
+	 * @param bool $tax if true then return the subtotal for tax otherwise return subtotal.
+	 * @return int
+	 * @throws EE_Error
+	 */
+	private function _get_subtotal($tax = false)
+	{
+		$grand_total = isset($this->_data->grand_total_line_item) ? $this->_data->grand_total_line_item : null;
+		if (! $grand_total instanceof EE_Line_Item) {
+			return 0;
+		}
+		return $tax ? $grand_total->get_total_tax() : $grand_total->get_items_total();
+	}
+
+
+	/**
+	 * parser for the [PAYMENT_LINK_IF_NEEDED_*] attribute type shortcode
+	 *
+	 * @since 4.7.0
+	 * @param string $shortcode the incoming shortcode
+	 * @return string parsed.
+	 * @throws EE_Error
+	 */
+	private function _get_payment_link_if_needed($shortcode)
+	{
+		$valid_shortcodes = array('transaction');
+		$attrs = $this->_get_shortcode_attrs($shortcode);
+		// ensure default is set.
+		$addressee = $this->_data instanceof EE_Messages_Addressee ? $this->_data : null;
+		$total_owing = $addressee instanceof EE_Messages_Addressee && $addressee->txn instanceof EE_Transaction
+			? $addressee->txn->remaining() : 0;
+		if ($total_owing > 0) {
+			$class = isset($attrs['class']) ? $attrs['class'] : 'callout';
+			$custom_text = isset($attrs['custom_text']) ? $attrs['custom_text'] : 'You can %smake a payment here »%s.';
+			$container_tag = isset($attrs['container_tag']) ? $attrs['container_tag'] : 'p';
+			$opening_tag = ! empty($container_tag) ? '<' . $container_tag : '';
+			$opening_tag .= ! empty($opening_tag) && ! empty($class) ? ' class="' . $class . '"' : $opening_tag;
+			$opening_tag .= ! empty($opening_tag) ? '>' : $opening_tag;
+			$closing_tag = ! empty($container_tag) ? '</' . $container_tag . '>' : '';
+			$content = $opening_tag . sprintf($custom_text, '<a href="[PAYMENT_URL]">', '</a>') . $closing_tag;
+			// we need to re run this string through the parser to catch any shortcodes that are in it.
+			$owing_content = $this->_shortcode_helper->parse_message_template(
+				$content,
+				$addressee,
+				$valid_shortcodes,
+				$this->_message_type,
+				$this->_messenger,
+				$this->_message
+			);
+		} else {
+			return '';
+		}
+		return $owing_content;
+	}
+
+
+	/**
+	 * Parser for the [PAYMENT_DUE_DATE_*] attribute type shortcode
+	 *
+	 * @since 4.8.28.rc.011
+	 * @param string         $shortcode The shortcode being parsed.
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_payment_due_date($shortcode, EE_Transaction $transaction)
+	{
+		// if transaction is paid in full then we can just return an empty string
+		if ($transaction->remaining() === 0) {
+			return '';
+		}
+		$attrs = $this->_get_shortcode_attrs($shortcode);
+		$format = isset($attrs['format']) ? $attrs['format'] : get_option('date_format');
+		$days_until_due = isset($attrs['days_until_due']) ? (int) $attrs['days_until_due'] : 30;
+		$prefix_text = isset($attrs['prefix_text']) ? $attrs['prefix_text']
+			: esc_html__('Payment in full due by: ', 'event_espresso');
+		$transaction_created = $transaction->get_DateTime_object('TXN_timestamp');
+		// setup date due:
+		try {
+			if ($transaction_created instanceof DateTime) {
+				$date_due = $transaction_created->add(
+					new DateInterval('P' . $days_until_due . 'D')
+				)->format($format);
+			} else {
+				throw new Exception();
+			}
+		} catch (Exception $e) {
+			// format was likely invalid.
+			$date_due = esc_html__(
+				'Unable to calculate date due, likely the format string is invalid.',
+				'event_espresso'
+			);
+		}
+		return $prefix_text . $date_due;
+	}
 }

Spacing +24 added lines, -24 removed lines

@@ -269,7 +269,7 @@ 
                    && isset($this->_extra_data['data'])
                    && $this->_extra_data['data'] instanceof EE_Messages_Addressee ? $this->_extra_data['data']->payment
             : $payment;
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             return '';
         }
         switch ($shortcode) {
@@ -287,7 +287,7 @@ 
                 $invoice_url = empty($invoice_url) ? 'http://dummyinvoicelinksforpreview.com' : $invoice_url;
                 return sprintf(
                     esc_html__('%sClick here for Invoice%s', 'event_espresso'),
-                    '<a href="' . $invoice_url . '">',
+                    '<a href="'.$invoice_url.'">',
                     '</a>'
                 );
                 break;
@@ -361,7 +361,7 @@ 
                 return $this->_data->total_ticket_count;
                 break;
             case '[TRANSACTION_ADMIN_URL]':
-                require_once EE_CORE . 'admin/EE_Admin_Page.core.php';
+                require_once EE_CORE.'admin/EE_Admin_Page.core.php';
                 $query_args = array(
                     'page'   => 'espresso_transactions',
                     'action' => 'view_transaction',
@@ -373,7 +373,7 @@ 
             case '[RECEIPT_URL]':
                 // get primary_registration
                 $reg = $this->_data->primary_reg_obj;
-                if (! $reg instanceof EE_Registration) {
+                if ( ! $reg instanceof EE_Registration) {
                     return '';
                 }
                 return $reg->receipt_url();
@@ -492,7 +492,7 @@ 
         if (empty($invoice_logo_url)) {
             return '';
         }
-        if (! $img_tags) {
+        if ( ! $img_tags) {
             return $invoice_logo_url;
         }
         // image tags have been requested.
@@ -503,7 +503,7 @@ 
         } else {
             $image_width = $image_size[0];
         }
-        return '<img class="logo screen" src="' . esc_url_raw($invoice_logo_url) . '" width="' . esc_attr($image_width) . '" alt="logo" />';
+        return '<img class="logo screen" src="'.esc_url_raw($invoice_logo_url).'" width="'.esc_attr($image_width).'" alt="logo" />';
     }
 
 
@@ -540,7 +540,7 @@ 
      */
     private function _get_invoice_payment_method()
     {
-        if (! $this->_invoice_pm instanceof EE_Payment_Method) {
+        if ( ! $this->_invoice_pm instanceof EE_Payment_Method) {
             $transaction = $this->_data->txn instanceof EE_Transaction ? $this->_data->txn : null;
             $transaction = ! $transaction instanceof EE_Transaction
                            && is_array($this->_extra_data)
@@ -608,7 +608,7 @@ 
         $attrs = $this->_get_shortcode_attrs($shortcode);
         // prefix?
         $prefix = isset($attrs['prefix']) ? $attrs['prefix'] : esc_html__('VAT/Tax Number: ', 'event_espresso');
-        return $prefix . $payee_tax_number;
+        return $prefix.$payee_tax_number;
     }
 
 
@@ -632,16 +632,16 @@ 
         }
         if (empty($payee_address)) {
             $organization = EE_Registry::instance()->CFG->organization;
-            $payee_address = $organization->get_pretty('address_1') . '<br>';
+            $payee_address = $organization->get_pretty('address_1').'<br>';
             $payee_address .= ! empty($organization->address_2)
-                ? $organization->get_pretty('address_2') . '<br>'
+                ? $organization->get_pretty('address_2').'<br>'
                 : '';
-            $payee_address .= $organization->get_pretty('city') . '<br>';
+            $payee_address .= $organization->get_pretty('city').'<br>';
             // state
             $state = EE_Registry::instance()->load_model('State')->get_one_by_ID($organization->STA_ID);
             $payee_address .= $state instanceof EE_State ? $state->name() : '';
             // Country
-            $payee_address .= ! empty($organization->CNT_ISO) ? ', ' . $organization->CNT_ISO . '<br>' : '';
+            $payee_address .= ! empty($organization->CNT_ISO) ? ', '.$organization->CNT_ISO.'<br>' : '';
             $payee_address .= ! empty($organization->zip) ? $organization->zip : '';
         }
         return $payee_address;
@@ -677,7 +677,7 @@ 
     {
         $reg = $this->_data->primary_reg_obj;
         $message_type = isset($this->_extra_data['message_type']) ? $this->_extra_data['message_type'] : '';
-        if (! $reg instanceof EE_Registration || empty($message_type)) {
+        if ( ! $reg instanceof EE_Registration || empty($message_type)) {
             return '';
         }
         $switch_to_invoice = ! $message_type instanceof EE_Invoice_message_type ? true : false;
@@ -685,13 +685,13 @@ 
             ? esc_html__('View Invoice', 'event_espresso') : esc_html__('Switch to Invoice', 'event_espresso');
         $switch_to_label = ! $switch_to_invoice ? esc_html__('Switch to Receipt', 'event_espresso') : $switch_to_label;
         $switch_to_url = $switch_to_invoice ? $reg->invoice_url() : $reg->receipt_url();
-        if (! $button) {
+        if ( ! $button) {
             return $switch_to_url;
         }
-        if (! empty($switch_to_url)) {
+        if ( ! empty($switch_to_url)) {
             return '
-	<form method="post" action="' . $switch_to_url . '" >
-		<input class="print_button" type="submit" value="' . $switch_to_label . '" />
+	<form method="post" action="' . $switch_to_url.'" >
+		<input class="print_button" type="submit" value="' . $switch_to_label.'" />
 	</form>
 			';
         }
@@ -709,7 +709,7 @@ 
     private function _get_subtotal($tax = false)
     {
         $grand_total = isset($this->_data->grand_total_line_item) ? $this->_data->grand_total_line_item : null;
-        if (! $grand_total instanceof EE_Line_Item) {
+        if ( ! $grand_total instanceof EE_Line_Item) {
             return 0;
         }
         return $tax ? $grand_total->get_total_tax() : $grand_total->get_items_total();
@@ -736,11 +736,11 @@ 
             $class = isset($attrs['class']) ? $attrs['class'] : 'callout';
             $custom_text = isset($attrs['custom_text']) ? $attrs['custom_text'] : 'You can %smake a payment here »%s.';
             $container_tag = isset($attrs['container_tag']) ? $attrs['container_tag'] : 'p';
-            $opening_tag = ! empty($container_tag) ? '<' . $container_tag : '';
-            $opening_tag .= ! empty($opening_tag) && ! empty($class) ? ' class="' . $class . '"' : $opening_tag;
+            $opening_tag = ! empty($container_tag) ? '<'.$container_tag : '';
+            $opening_tag .= ! empty($opening_tag) && ! empty($class) ? ' class="'.$class.'"' : $opening_tag;
             $opening_tag .= ! empty($opening_tag) ? '>' : $opening_tag;
-            $closing_tag = ! empty($container_tag) ? '</' . $container_tag . '>' : '';
-            $content = $opening_tag . sprintf($custom_text, '<a href="[PAYMENT_URL]">', '</a>') . $closing_tag;
+            $closing_tag = ! empty($container_tag) ? '</'.$container_tag.'>' : '';
+            $content = $opening_tag.sprintf($custom_text, '<a href="[PAYMENT_URL]">', '</a>').$closing_tag;
             // we need to re run this string through the parser to catch any shortcodes that are in it.
             $owing_content = $this->_shortcode_helper->parse_message_template(
                 $content,
@@ -782,7 +782,7 @@ 
         try {
             if ($transaction_created instanceof DateTime) {
                 $date_due = $transaction_created->add(
-                    new DateInterval('P' . $days_until_due . 'D')
+                    new DateInterval('P'.$days_until_due.'D')
                 )->format($format);
             } else {
                 throw new Exception();
@@ -794,6 +794,6 @@ 
                 'event_espresso'
             );
         }
-        return $prefix_text . $date_due;
+        return $prefix_text.$date_due;
     }
 }

modules/gateways/Invoice/lib/templates/invoice_body.template.php

Indentation +74 added lines, -74 removed lines

@@ -76,20 +76,20 @@ 
         </thead>
         <tbody>
         <?php
-        /**
-         * Recursive function for traversing all the sub-items of each line item
-         * and displaying them in the table
-         *
-         * @param EE_Line_Item $line_item
-         * @param boolean      $odd for indicating whether to style this line item as an 'odd' or 'even'
-         */
-        function ee_invoice_display_line_item(EE_Line_Item $line_item, $show_line_item_description, $odd = false)
-        {
-            switch ($line_item->type()) {
-                case EEM_Line_Item::type_total:
-                    foreach ($line_item->children() as $child_line_item) {
-                        ee_invoice_display_line_item($child_line_item, $show_line_item_description);
-                    } ?>
+		/**
+		 * Recursive function for traversing all the sub-items of each line item
+		 * and displaying them in the table
+		 *
+		 * @param EE_Line_Item $line_item
+		 * @param boolean      $odd for indicating whether to style this line item as an 'odd' or 'even'
+		 */
+		function ee_invoice_display_line_item(EE_Line_Item $line_item, $show_line_item_description, $odd = false)
+		{
+			switch ($line_item->type()) {
+				case EEM_Line_Item::type_total:
+					foreach ($line_item->children() as $child_line_item) {
+						ee_invoice_display_line_item($child_line_item, $show_line_item_description);
+					} ?>
                     <tr>
                         <td colspan="<?php echo ($show_line_item_description ? 5 : 4) ?>">
                             <hr>
@@ -101,50 +101,50 @@ 
                         <td class="total"><?php echo wp_kses($line_item->total_no_code(), AllowedTags::getAllowedTags()); ?></td>
                     </tr>
                     <?php
-                    break;
+					break;
 
 
-                case EEM_Line_Item::type_sub_total:
-                    foreach ($line_item->children() as $child_line_item) {
-                        // $odd = !$odd;
-                        ee_invoice_display_line_item($child_line_item, $show_line_item_description, $odd);
-                    } ?>
+				case EEM_Line_Item::type_sub_total:
+					foreach ($line_item->children() as $child_line_item) {
+						// $odd = !$odd;
+						ee_invoice_display_line_item($child_line_item, $show_line_item_description, $odd);
+					} ?>
                     <tr class="total_tr odd">
                         <td colspan="<?php echo ($show_line_item_description ? 2 : 1) ?>">&nbsp;</td>
                         <td colspan="2" class="total" id="total_currency">
                             <?php esc_html_e(
-                                'Sub-Total',
-                                'event_espresso'
-                            ); ?></td>
+								'Sub-Total',
+								'event_espresso'
+							); ?></td>
                         <td class="total"><?php echo wp_kses($line_item->total_no_code(), AllowedTags::getAllowedTags()); ?></td>
                     </tr>
                     <?php
-                    break;
+					break;
 
 
-                case EEM_Line_Item::type_tax_sub_total:
-                    foreach ($line_item->children() as $child_line_item) {
-                        $odd = ! $odd;
-                        ee_invoice_display_line_item($child_line_item, $show_line_item_description, $odd);
-                    } ?>
+				case EEM_Line_Item::type_tax_sub_total:
+					foreach ($line_item->children() as $child_line_item) {
+						$odd = ! $odd;
+						ee_invoice_display_line_item($child_line_item, $show_line_item_description, $odd);
+					} ?>
                     <tr class="total_tr odd">
                         <td colspan="<?php echo ($show_line_item_description ? 2 : 1) ?>">&nbsp;</td>
                         <td colspan="2" class="total" id="total_currency">
                             <?php esc_html_e(
-                                'Tax Total',
-                                'event_espresso'
-                            ); ?></td>
+								'Tax Total',
+								'event_espresso'
+							); ?></td>
                         <td class="total"><?php echo wp_kses($line_item->total_no_code(), AllowedTags::getAllowedTags()); ?></td>
                     </tr>
                     <?php
-                    break;
+					break;
 
 
-                case EEM_Line_Item::type_line_item:
-                    $subitems = $line_item->children();
-                    $has_subitems = count($subitems) > 1;
-                    if ($has_subitems) {
-                        ?>
+				case EEM_Line_Item::type_line_item:
+					$subitems = $line_item->children();
+					$has_subitems = count($subitems) > 1;
+					if ($has_subitems) {
+						?>
                         <tr class="item <?php echo ($odd ? 'odd' : ''); ?>">
                             <td class="item_l"><?php echo esc_html($line_item->name()) ?></td>
                             <?php if ($show_line_item_description) { ?>
@@ -155,18 +155,18 @@ 
                             <td class="item_c"><?php echo esc_html($line_item->unit_price_no_code()) ?></td>
 
                             <td class="item_r"> <?php echo wp_kses($line_item->total_no_code(), AllowedTags::getAllowedTags());
-                                echo ($line_item->is_taxable() ? '*' : ''); ?> </td>
+								echo ($line_item->is_taxable() ? '*' : ''); ?> </td>
                             <?php // <td class="item_l"><?php  $datetimes_strings = array(); foreach($datetimes as $datetime){ $datetimes_strings[]= $datetime->start_date_and_time();} echo implode(", ",$datetimes_strings);
-                            ?>
+							?>
                         </tr>
                         <?php
-                        if ($has_subitems) {
-                            foreach ($line_item->children() as $child_line_item) {
-                                ee_invoice_display_line_item($child_line_item, $show_line_item_description, $odd);
-                            }
-                        }
-                    } else {// no subitems - just show this line item
-                        ?>
+						if ($has_subitems) {
+							foreach ($line_item->children() as $child_line_item) {
+								ee_invoice_display_line_item($child_line_item, $show_line_item_description, $odd);
+							}
+						}
+					} else {// no subitems - just show this line item
+						?>
                         <tr class="item <?php echo ($odd ? 'odd' : ''); ?>">
                             <td class="item_l"><?php echo esc_html($line_item->name()); ?></td>
                             <?php if ($show_line_item_description) { ?>
@@ -175,15 +175,15 @@ 
                             <td class="item_l"><?php echo esc_html($line_item->quantity()); ?></td>
                             <td class="item_c"><?php echo wp_kses($line_item->unit_price_no_code(), AllowedTags::getAllowedTags()); ?></td>
                             <td class="item_r"> <?php echo wp_kses($line_item->total_no_code(), AllowedTags::getAllowedTags());
-                                echo ($line_item->is_taxable() ? '*' : ''); ?> </td>
+								echo ($line_item->is_taxable() ? '*' : ''); ?> </td>
                             <?php // <td class="item_l"><?php  $datetimes_strings = array(); foreach($datetimes as $datetime){ $datetimes_strings[]= $datetime->start_date_and_time();} echo implode(", ",$datetimes_strings);
-                            ?>
+							?>
                         </tr>
                     <?php }
 
-                    break;
-                case EEM_Line_Item::type_sub_line_item:
-                    ?>
+					break;
+				case EEM_Line_Item::type_sub_line_item:
+					?>
                     <tr class="item subitem-row">
                         <td class="item_l subitem"><?php echo esc_html($line_item->name()); ?></td>
                         <?php if ($show_line_item_description) { ?>
@@ -199,9 +199,9 @@ 
                         <td class="item_r"><?php echo wp_kses($line_item->total_no_code(), AllowedTags::getAllowedTags()); ?></td>
                     </tr>
                     <?php
-                    break;
-                case EEM_Line_Item::type_tax:
-                    ?>
+					break;
+				case EEM_Line_Item::type_tax:
+					?>
                     <tr class="item sub-item tax-total">
                     <td class="item_l"><?php echo esc_html($line_item->name()); ?></td>
                     <?php if ($show_line_item_description) { ?>
@@ -211,15 +211,15 @@ 
 
                     <td class="item_r"><?php echo wp_kses($line_item->total_no_code(), AllowedTags::getAllowedTags()); ?></td>
                     </tr><?php
-                    break;
-            }
-        }
+					break;
+			}
+		}
 
-        $c = false;
-        /* @var $transaction EE_Transaction */
-        $total_line_item = $transaction->total_line_item();
-        ee_invoice_display_line_item($total_line_item, $show_line_item_description);
-        /* foreach($transaction->registrations() as $registration){
+		$c = false;
+		/* @var $transaction EE_Transaction */
+		$total_line_item = $transaction->total_line_item();
+		ee_invoice_display_line_item($total_line_item, $show_line_item_description);
+		/* foreach($transaction->registrations() as $registration){
              ?>
             <tr class="item <?php echo ($c = !$c) ? ' odd' : ''; ?>">
                 <td class="item_l">1</td>
@@ -248,11 +248,11 @@ 
         </thead>
         <tbody>
         <?php
-        $c = false;
-        if (! empty($payments)) {
-            foreach ($payments as $payment) {
-                /* @var $payment EE_Payment */
-                ?>
+		$c = false;
+		if (! empty($payments)) {
+			foreach ($payments as $payment) {
+				/* @var $payment EE_Payment */
+				?>
                 <tr class='item <?php echo(($c = ! $c) ? ' odd' : '') ?>'>
                     <td><?php $payment->e('PAY_gateway') ?></td>
                     <td><?php echo esc_html($payment->timestamp('D M j, Y')); ?></td>
@@ -262,17 +262,17 @@ 
                     <td class='item_r'><?php echo EEH_Template::format_currency($payment->amount()); ?></td>
                 </tr>
             <?php }
-        } else {
-            ?>
+		} else {
+			?>
             <tr class='item'>
                 <td class='aln-cntr' colspan=6>
                     <?php esc_html_e(
-                        "No approved payments have been received",
-                        'event_espresso'
-                    ) ?></td>
+						"No approved payments have been received",
+						'event_espresso'
+					) ?></td>
             </tr>
         <?php }
-        ?>
+		?>
         </tbody>
         <tfoot>
         <tr class='total_tr'>

Spacing +2 added lines, -2 removed lines

@@ -54,7 +54,7 @@ 
         <div class="fn">[name]</div>
         <div class="adr">
             <div class="street-address"><?php echo wp_kses($attendee_address, AllowedTags::getAllowedTags()); ?></div>
-            <div class="locality"><?php echo wp_kses($attendee_city . ' ' . $attendee_state, AllowedTags::getAllowedTags()); ?></div>
+            <div class="locality"><?php echo wp_kses($attendee_city.' '.$attendee_state, AllowedTags::getAllowedTags()); ?></div>
             <div id="client-postcode"><?php echo wp_kses($attendee_zip, AllowedTags::getAllowedTags()); ?></div>
         </div>
     </div>
@@ -249,7 +249,7 @@ 
         <tbody>
         <?php
         $c = false;
-        if (! empty($payments)) {
+        if ( ! empty($payments)) {
             foreach ($payments as $payment) {
                 /* @var $payment EE_Payment */
                 ?>

modules/gateways/Invoice/lib/templates/receipt_body.template.php

Indentation +112 added lines, -112 removed lines

@@ -64,10 +64,10 @@ 
             <h3 class="section-title event-name">
                 <img class="icon" src="<?php echo EE_IMAGES_URL . 'calendar_year-24x24.png'; ?>">
                 <?php
-                esc_html_e(
-                    "Event Name:",
-                    "event_espresso"
-                ) ?>
+				esc_html_e(
+					"Event Name:",
+					"event_espresso"
+				) ?>
                 <span class="plain-text"><?php echo wp_kses($event->name(), AllowedTags::getAllowedTags()); ?></span>
                 <span class="small-text link">
                 [ <a href='<?php echo esc_url_raw($event->get_permalink()) ?>'><?php esc_html_e('view', 'event_espresso'); ?></a> ]
@@ -78,14 +78,14 @@ 
             <?php } ?>
             <ul class="tickets-per-event">
                 <?php
-                foreach ($ticket_line_items_per_event[ $event_id ] as $line_item_id => $line_item) {
-                    $ticket       = $line_item->ticket();
-                    $taxable_html = $ticket->taxable()
-                            ? '*'
-                            : '';
-                    $subitems     = $line_item->children();
-                    $ticket_uses  = $ticket->get_pretty('TKT_uses', esc_html__("any", "event_espresso"));
-                    ?>
+				foreach ($ticket_line_items_per_event[ $event_id ] as $line_item_id => $line_item) {
+					$ticket       = $line_item->ticket();
+					$taxable_html = $ticket->taxable()
+							? '*'
+							: '';
+					$subitems     = $line_item->children();
+					$ticket_uses  = $ticket->get_pretty('TKT_uses', esc_html__("any", "event_espresso"));
+					?>
                     <li class="event-ticket">
                         <div class="ticket-details">
                             <table class="invoice-amount">
@@ -94,10 +94,10 @@ 
                                     <th class="name-column"><?php esc_html_e("Ticket", "event_espresso"); ?></th>
                                     <th colspan="2" class="desc-column">
                                         <?php
-                                        esc_html_e(
-                                            "Description",
-                                            "event_espresso"
-                                        ); ?></th>
+										esc_html_e(
+											"Description",
+											"event_espresso"
+										); ?></th>
                                     <th class="number-column item_c"><?php esc_html_e("Quantity", "event_espresso"); ?></th>
                                     <th class="number-column item_c"><?php esc_html_e("Price", "event_espresso"); ?></th>
                                     <th class="number-column item_r"><?php esc_html_e("Total", "event_espresso"); ?></th>
@@ -105,20 +105,20 @@ 
                                 </thead>
                                 <tbody>
                                 <?php
-                                if (count($subitems) < 2) { ?>
+								if (count($subitems) < 2) { ?>
                                     <tr class="item">
                                         <td><?php echo esc_html($line_item->name() . $taxable_html); ?></td>
                                         <td colspan="2">
                                             <?php echo esc_html($line_item->desc()); ?>
                                             <p class="ticket-note">
                                                 <?php
-                                                echo sprintf(
-                                                    esc_html__(
-                                                        'This ticket can be used once at %s of the dates/times below.',
-                                                        'event_espresso'
-                                                    ),
-                                                    $ticket_uses
-                                                ); ?>
+												echo sprintf(
+													esc_html__(
+														'This ticket can be used once at %s of the dates/times below.',
+														'event_espresso'
+													),
+													$ticket_uses
+												); ?>
                                             </p>
                                         </td>
                                         <td class="item_c"><?php echo esc_html($line_item->quantity()); ?></td>
@@ -126,7 +126,7 @@ 
                                         <td class="item_r"><?php echo wp_kses($line_item->total_no_code(), AllowedTags::getAllowedTags());  ?></td>
                                     </tr>
                                     <?php
-                                } else { ?>
+								} else { ?>
                                     <tr class="item">
                                         <td class="aln-left">
                                             <?php echo esc_html($line_item->name() . $taxable_html); ?>
@@ -134,13 +134,13 @@ 
                                         <td colspan="2"><?php echo esc_html($line_item->desc()); ?>
                                             <p class="ticket-note">
                                                 <?php
-                                                echo sprintf(
-                                                    esc_html__(
-                                                        'This ticket can be used once at %s of the dates/times below.',
-                                                        'event_espresso'
-                                                    ),
-                                                    $ticket_uses
-                                                ); ?>
+												echo sprintf(
+													esc_html__(
+														'This ticket can be used once at %s of the dates/times below.',
+														'event_espresso'
+													),
+													$ticket_uses
+												); ?>
                                             </p>
                                         </td>
                                         <td class="item_c">
@@ -154,8 +154,8 @@ 
                                         </td>
                                     </tr>
                                     <?php
-                                    foreach ($subitems as $sub_line_item) {
-                                        $is_percent = $sub_line_item->is_percent(); ?>
+									foreach ($subitems as $sub_line_item) {
+										$is_percent = $sub_line_item->is_percent(); ?>
                                         <tr class="subitem-row">
                                             <td class="subitem">
                                                 <?php echo esc_html($sub_line_item->name()); ?>
@@ -167,14 +167,14 @@ 
                                                 <?php // echo $is_percent ? '' : $sub_line_item->quantity()?>
                                             </td>
                                             <td class="item_c"><?php
-                                                echo ($is_percent
-                                                    ? $sub_line_item->percent() . "%"
-                                                    : $sub_line_item->unit_price_no_code()); ?>
+												echo ($is_percent
+													? $sub_line_item->percent() . "%"
+													: $sub_line_item->unit_price_no_code()); ?>
                                             </td>
                                             <td class="item_r"><?php echo wp_kses($sub_line_item->total_no_code(), AllowedTags::getAllowedTags()); ?></td>
                                         </tr>
                                         <?php
-                                    } ?>
+									} ?>
                                     <tr class="total_tr odd">
                                         <td colspan="4"></td>
                                         <td class="total" nowrap="nowrap">
@@ -185,7 +185,7 @@ 
                                         </td>
                                     </tr>
                                     <?php
-                                } ?>
+								} ?>
                                 </tbody>
                             </table>
 
@@ -196,49 +196,49 @@ 
                                     <h4 class="sub-section-title no-bottom-margin">
                                         <img class="icon" src="<?php echo esc_url_raw(EE_IMAGES_URL . 'clock-16x16.png'); ?>">
                                         <?php
-                                        echo _n(
-                                            "Date/Time:",
-                                            "Dates/Times:",
-                                            count($ticket->datetimes()),
-                                            "event_espresso"
-                                        ); ?></h4>
+										echo _n(
+											"Date/Time:",
+											"Dates/Times:",
+											count($ticket->datetimes()),
+											"event_espresso"
+										); ?></h4>
                                     <ul class="event-dates">
                                         <?php
-                                        foreach ($ticket->datetimes_ordered() as $datetime) {
-                                            /* @var $datetime EE_Datetime */ ?>
+										foreach ($ticket->datetimes_ordered() as $datetime) {
+											/* @var $datetime EE_Datetime */ ?>
                                             <li><?php
-                                                echo ($datetime->name()
-                                                    ? '<b>' . esc_html($datetime->name()) . ' </b>'
-                                                    : '');
-                                                echo sprintf(
-                                                    esc_html__("%s - %s (%s)", "event_espresso"),
-                                                    $datetime->start_date_and_time(),
-                                                    $datetime->end_date_and_time(),
-                                                    $datetime->get_timezone()
-                                                );
-                                                echo ($datetime->description()
-                                                    ? '<p class="ticket-note">' . wp_kses($datetime->description(), AllowedTags::getAllowedTags()) . '</p>'
-                                                    : ''); ?></li>
+												echo ($datetime->name()
+													? '<b>' . esc_html($datetime->name()) . ' </b>'
+													: '');
+												echo sprintf(
+													esc_html__("%s - %s (%s)", "event_espresso"),
+													$datetime->start_date_and_time(),
+													$datetime->end_date_and_time(),
+													$datetime->get_timezone()
+												);
+												echo ($datetime->description()
+													? '<p class="ticket-note">' . wp_kses($datetime->description(), AllowedTags::getAllowedTags()) . '</p>'
+													: ''); ?></li>
                                             <?php
-                                        } ?>
+										} ?>
                                     </ul>
                                 </div>
                                 <?php
-                                if ($event->venues()) { ?>
+								if ($event->venues()) { ?>
                                     <div class="ticket-place-details">
                                         <h4 class="sub-section-title no-bottom-margin">
                                             <img class="icon" src="<?php
-                                            echo esc_url_raw(EE_IMAGES_URL . 'location-pin-16x16.png'); ?>">
+											echo esc_url_raw(EE_IMAGES_URL . 'location-pin-16x16.png'); ?>">
                                             <?php
-                                            echo _n(
-                                                "Venue:",
-                                                "Venues:",
-                                                count($event->venues()),
-                                                "event_espresso"
-                                            ); ?></h4>
+											echo _n(
+												"Venue:",
+												"Venues:",
+												count($event->venues()),
+												"event_espresso"
+											); ?></h4>
                                         <ul class="event-venues">
                                             <?php
-                                            foreach ($event->venues() as $venue) { ?>
+											foreach ($event->venues() as $venue) { ?>
                                                 <li><?php echo esc_html($venue->name()) ?>
                                                     <span class="small-text">
                                                 [
@@ -249,18 +249,18 @@ 
                                             </span>
                                                 </li>
                                                 <?php
-                                            } ?>
+											} ?>
                                         </ul>
                                     </div>
                                     <?php
-                                } ?>
+								} ?>
                             </div>
                             <div class="ticket-registrations-area">
                                 <h4 class="sub-section-title">
                                     <img class="icon" src="<?php
-                                    echo esc_url_raw(EE_IMAGES_URL . 'users-16x16.png'); ?>">
+									echo esc_url_raw(EE_IMAGES_URL . 'users-16x16.png'); ?>">
                                     <?php
-                                    echo esc_html__("Registration Details", "event_espresso"); ?>
+									echo esc_html__("Registration Details", "event_espresso"); ?>
                                     <span class="small-text link">[
                                 <a class="print_button noPrint" href="<?php echo esc_url_raw($edit_reg_info_url); ?>">
                                     <?php esc_html_e('edit', 'event_espresso'); ?>
@@ -270,12 +270,12 @@ 
                                 </h4>
                                 <ul class="ticket-registrations-list">
                                     <?php
-                                    foreach ($registrations_per_line_item[ $line_item_id ] as $registration) {
-                                        /* @var $registration EE_Registration */
-                                        $attendee = $registration->attendee();
-                                        $answers  = $registration->answers(
-                                            ['order_by' => ['Question.Question_Group_Question.QGQ_order' => 'ASC']]
-                                        ); ?>
+									foreach ($registrations_per_line_item[ $line_item_id ] as $registration) {
+										/* @var $registration EE_Registration */
+										$attendee = $registration->attendee();
+										$answers  = $registration->answers(
+											['order_by' => ['Question.Question_Group_Question.QGQ_order' => 'ASC']]
+										); ?>
                                         <li class="ticket-registration">
                                             <table class="registration-details">
                                                 <tr class="odd">
@@ -290,7 +290,7 @@ 
                                                     </td>
                                                 </tr>
                                                 <?php
-                                                foreach ($event->question_groups() as $question_group) { ?>
+												foreach ($event->question_groups() as $question_group) { ?>
                                                     <tr>
                                                         <th>
                                                             <?php $question_group->e('QSG_name'); ?>
@@ -298,12 +298,12 @@ 
                                                         <td></td>
                                                     </tr>
                                                     <?php $has_personal_info = false;
-                                                    foreach ($question_group->questions() as $question) {
-                                                        if (in_array($question->system_ID(), $questions_to_skip)) {
-                                                            $has_personal_info = true;
-                                                            continue;
-                                                        }
-                                                        ?>
+													foreach ($question_group->questions() as $question) {
+														if (in_array($question->system_ID(), $questions_to_skip)) {
+															$has_personal_info = true;
+															continue;
+														}
+														?>
                                                         <tr>
                                                             <th>
                                                                 <?php echo wp_kses($question->display_text(), AllowedTags::getAllowedTags()); ?>
@@ -313,26 +313,26 @@ 
                                                             </td>
                                                         </tr>
                                                     <?php }
-                                                    if ($has_personal_info) { ?>
+													if ($has_personal_info) { ?>
                                                         <tr>
                                                             <th><?php esc_html_e('Attendee', 'event_espresso'); ?></th>
                                                             <td>
                                                                 <?php
-                                                                echo sprintf(
-                                                                    esc_html__('%s (%s)', "event_espresso"),
-                                                                    esc_html($attendee->full_name()),
-                                                                    sanitize_email($attendee->email())
-                                                                ) ?>
+																echo sprintf(
+																	esc_html__('%s (%s)', "event_espresso"),
+																	esc_html($attendee->full_name()),
+																	sanitize_email($attendee->email())
+																) ?>
                                                             </td>
                                                         </tr>
                                                         <?php
-                                                    }
-                                                }
-                                                ?>
+													}
+												}
+												?>
                                             </table>
                                         </li>
                                         <?php
-                                    } ?>
+									} ?>
                                 </ul>
                             </div>
                         </div>
@@ -376,10 +376,10 @@ 
     <div class="grand-total-dv">
         <h2 class="grand-total">
             <?php
-            printf(
-                esc_html__("Grand Total: %s", "event_espresso"),
-                EEH_Template::format_currency($total_cost)
-            ); ?>
+			printf(
+				esc_html__("Grand Total: %s", "event_espresso"),
+				EEH_Template::format_currency($total_cost)
+			); ?>
         </h2>
     </div>
     <div class="payment-dv">
@@ -398,13 +398,13 @@ 
             </thead>
             <tbody>
             <?php
-            $c = false;
-            if (! empty($payments)) {
-                foreach ($payments as $payment) {
-                    /* @var $payment EE_Payment */ ?>
+			$c = false;
+			if (! empty($payments)) {
+				foreach ($payments as $payment) {
+					/* @var $payment EE_Payment */ ?>
                     <tr class='item <?php echo(($c = ! $c)
-                        ? ' odd'
-                        : '') ?>'>
+						? ' odd'
+						: '') ?>'>
                         <td><?php $payment->e('PAY_gateway') ?></td>
                         <td><?php echo esc_html($payment->timestamp()); ?></td>
                         <td><?php $payment->e('PAY_txn_id_chq_nmbr') ?></td>
@@ -413,14 +413,14 @@ 
                         <td class='item_r'><?php echo wp_kses($payment->amount_no_code(), AllowedTags::getAllowedTags()); ?></td>
                     </tr>
                 <?php }
-            } else { ?>
+			} else { ?>
                 <tr class='item'>
                     <td class='aln-cntr' colspan="6">
                         <?php
-                        esc_html_e(
-                            "No approved payments have been received.",
-                            'event_espresso'
-                        ) ?>
+						esc_html_e(
+							"No approved payments have been received.",
+							'event_espresso'
+						) ?>
                     </td>
                 </tr>
             <?php } ?>
@@ -457,7 +457,7 @@ 
             <?php if ($venues_for_events) { ?>
             <h2>
                 <?php
-                echo _n("Venue Details:", "Venues Details:", count($venues_for_events), "event_espresso"); ?>
+				echo _n("Venue Details:", "Venues Details:", count($venues_for_events), "event_espresso"); ?>
             </h2>
             <table class="venue-list">
                 <?php foreach ($venues_for_events as $venue) { ?>

Spacing +13 added lines, -13 removed lines

@@ -62,7 +62,7 @@ 
     <div class="events">
         <?php foreach ($events_for_txn as $event_id => $event) { ?>
             <h3 class="section-title event-name">
-                <img class="icon" src="<?php echo EE_IMAGES_URL . 'calendar_year-24x24.png'; ?>">
+                <img class="icon" src="<?php echo EE_IMAGES_URL.'calendar_year-24x24.png'; ?>">
                 <?php
                 esc_html_e(
                     "Event Name:",
@@ -78,7 +78,7 @@ 
             <?php } ?>
             <ul class="tickets-per-event">
                 <?php
-                foreach ($ticket_line_items_per_event[ $event_id ] as $line_item_id => $line_item) {
+                foreach ($ticket_line_items_per_event[$event_id] as $line_item_id => $line_item) {
                     $ticket       = $line_item->ticket();
                     $taxable_html = $ticket->taxable()
                             ? '*'
@@ -107,7 +107,7 @@ 
                                 <?php
                                 if (count($subitems) < 2) { ?>
                                     <tr class="item">
-                                        <td><?php echo esc_html($line_item->name() . $taxable_html); ?></td>
+                                        <td><?php echo esc_html($line_item->name().$taxable_html); ?></td>
                                         <td colspan="2">
                                             <?php echo esc_html($line_item->desc()); ?>
                                             <p class="ticket-note">
@@ -123,13 +123,13 @@ 
                                         </td>
                                         <td class="item_c"><?php echo esc_html($line_item->quantity()); ?></td>
                                         <td class="item_c"><?php echo wp_kses($line_item->unit_price_no_code(), AllowedTags::getAllowedTags()); ?></td>
-                                        <td class="item_r"><?php echo wp_kses($line_item->total_no_code(), AllowedTags::getAllowedTags());  ?></td>
+                                        <td class="item_r"><?php echo wp_kses($line_item->total_no_code(), AllowedTags::getAllowedTags()); ?></td>
                                     </tr>
                                     <?php
                                 } else { ?>
                                     <tr class="item">
                                         <td class="aln-left">
-                                            <?php echo esc_html($line_item->name() . $taxable_html); ?>
+                                            <?php echo esc_html($line_item->name().$taxable_html); ?>
                                         </td>
                                         <td colspan="2"><?php echo esc_html($line_item->desc()); ?>
                                             <p class="ticket-note">
@@ -168,7 +168,7 @@ 
                                             </td>
                                             <td class="item_c"><?php
                                                 echo ($is_percent
-                                                    ? $sub_line_item->percent() . "%"
+                                                    ? $sub_line_item->percent()."%"
                                                     : $sub_line_item->unit_price_no_code()); ?>
                                             </td>
                                             <td class="item_r"><?php echo wp_kses($sub_line_item->total_no_code(), AllowedTags::getAllowedTags()); ?></td>
@@ -194,7 +194,7 @@ 
                             <div class="ticket-time-and-place-details">
                                 <div class="ticket-time-details">
                                     <h4 class="sub-section-title no-bottom-margin">
-                                        <img class="icon" src="<?php echo esc_url_raw(EE_IMAGES_URL . 'clock-16x16.png'); ?>">
+                                        <img class="icon" src="<?php echo esc_url_raw(EE_IMAGES_URL.'clock-16x16.png'); ?>">
                                         <?php
                                         echo _n(
                                             "Date/Time:",
@@ -208,7 +208,7 @@ 
                                             /* @var $datetime EE_Datetime */ ?>
                                             <li><?php
                                                 echo ($datetime->name()
-                                                    ? '<b>' . esc_html($datetime->name()) . ' </b>'
+                                                    ? '<b>'.esc_html($datetime->name()).' </b>'
                                                     : '');
                                                 echo sprintf(
                                                     esc_html__("%s - %s (%s)", "event_espresso"),
@@ -217,7 +217,7 @@ 
                                                     $datetime->get_timezone()
                                                 );
                                                 echo ($datetime->description()
-                                                    ? '<p class="ticket-note">' . wp_kses($datetime->description(), AllowedTags::getAllowedTags()) . '</p>'
+                                                    ? '<p class="ticket-note">'.wp_kses($datetime->description(), AllowedTags::getAllowedTags()).'</p>'
                                                     : ''); ?></li>
                                             <?php
                                         } ?>
@@ -228,7 +228,7 @@ 
                                     <div class="ticket-place-details">
                                         <h4 class="sub-section-title no-bottom-margin">
                                             <img class="icon" src="<?php
-                                            echo esc_url_raw(EE_IMAGES_URL . 'location-pin-16x16.png'); ?>">
+                                            echo esc_url_raw(EE_IMAGES_URL.'location-pin-16x16.png'); ?>">
                                             <?php
                                             echo _n(
                                                 "Venue:",
@@ -258,7 +258,7 @@ 
                             <div class="ticket-registrations-area">
                                 <h4 class="sub-section-title">
                                     <img class="icon" src="<?php
-                                    echo esc_url_raw(EE_IMAGES_URL . 'users-16x16.png'); ?>">
+                                    echo esc_url_raw(EE_IMAGES_URL.'users-16x16.png'); ?>">
                                     <?php
                                     echo esc_html__("Registration Details", "event_espresso"); ?>
                                     <span class="small-text link">[
@@ -270,7 +270,7 @@ 
                                 </h4>
                                 <ul class="ticket-registrations-list">
                                     <?php
-                                    foreach ($registrations_per_line_item[ $line_item_id ] as $registration) {
+                                    foreach ($registrations_per_line_item[$line_item_id] as $registration) {
                                         /* @var $registration EE_Registration */
                                         $attendee = $registration->attendee();
                                         $answers  = $registration->answers(
@@ -399,7 +399,7 @@ 
             <tbody>
             <?php
             $c = false;
-            if (! empty($payments)) {
+            if ( ! empty($payments)) {
                 foreach ($payments as $payment) {
                     /* @var $payment EE_Payment */ ?>
                     <tr class='item <?php echo(($c = ! $c)

modules/gateways/Invoice/lib/Invoice.class.php

Indentation +429 added lines, -429 removed lines

@@ -13,433 +13,433 @@
 class Invoice
 {
 
-    /**
-     *
-     * @var EE_Registration
-     */
-    private $registration;
-
-    /**
-     *
-     * @var EE_Transaction
-     */
-    private $transaction;
-
-    /**
-     *
-     * @var EE_Payment_Method
-     */
-    private $invoice_payment_method;
-
-
-    /**
-     * Invoice constructor.
-     *
-     * @param int $url_link
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated 4.9.13
-     */
-    public function __construct($url_link = 0)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__,
-            esc_html__(
-                'This class has been deprecated and replaced by the new Messages library.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        /** @var EEM_Registration $reg_model */
-        $reg_model = EE_Registry::instance()->load_model('Registration');
-        if ($this->registration = $reg_model->get_registration_for_reg_url_link($url_link)) {
-            $this->transaction = $this->registration->transaction();
-            EE_Config::instance()->gateway->payment_settings;
-            $this->invoice_payment_method = EEM_Payment_Method::instance()->get_one_of_type('Invoice');
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'Your request appears to be missing some required data, and no information for your transaction could be retrieved.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * @param false $download
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function send_invoice($download = false)
-    {
-        $template_args = [];
-        $EE            = EE_Registry::instance();
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $theme   = $request->getRequestParam('theme', 0, 'int');
-        // allow the request to override the default theme defined in the invoice settings
-        $theme_requested = $theme > 0 && $theme < 8
-                ? $theme
-                : null;
-        $themes          = [
-            1 => "simple.css",
-            2 => "bauhaus.css",
-            3 => "ejs.css",
-            4 => "horizon.css",
-            5 => "lola.css",
-            6 => "tranquility.css",
-            7 => "union.css",
-        ];
-        // Get the CSS file
-        if (isset($themes[ $theme_requested ])) {
-            $template_args['invoice_css'] = $themes[ $theme_requested ];
-        } else {
-            $template_args['invoice_css'] = $this->invoice_payment_method->get_extra_meta(
-                'legacy_invoice_css',
-                true,
-                'simple.css'
-            );
-        }
-
-        if (is_dir(EVENT_ESPRESSO_GATEWAY_DIR . '/invoice')) {
-            $template_args['base_url'] = EVENT_ESPRESSO_GATEWAY_URL . 'Invoice/lib/templates/';
-        } else {
-            $template_args['base_url'] = EE_GATEWAYS . '/Invoice/lib/templates/';
-        }
-        $primary_attendee = $this->transaction->primary_registration()->attendee();
-
-        $template_args['organization'] = $EE->CFG->organization->get_pretty('name');
-        $template_args['street']       = empty($EE->CFG->organization->address_2)
-                ? $EE->CFG->organization->get_pretty('address_1')
-                : $EE->CFG->organization->get_pretty('address_1')
-                  . '<br>'
-                  . $EE->CFG->organization->get_pretty('address_2');
-        $template_args['city']         = $EE->CFG->organization->get_pretty('city');
-        $template_args['state']        = EE_Registry::instance()->load_model('State')->get_one_by_ID(
-            $EE->CFG->organization->STA_ID
-        );
-        $template_args['country']      = EE_Registry::instance()->load_model('Country')->get_one_by_ID(
-            $EE->CFG->organization->CNT_ISO
-        );
-        $template_args['zip']          = $EE->CFG->organization->get_pretty('zip');
-        $template_args['email']        = $EE->CFG->organization->get_pretty('email');
-
-        $template_args['registration_code'] = $this->registration->reg_code();
-        $template_args['registration_date'] = $this->registration->date();
-        $template_args['name']              = $primary_attendee->full_name();
-        $template_args['attendee_address']  = $primary_attendee->address();
-        $template_args['attendee_address2'] = $primary_attendee->address2();
-        $template_args['attendee_city']     = $primary_attendee->city();
-        $attendee_state                     = $primary_attendee->state_obj();
-        if ($attendee_state) {
-            $attendee_state_name = $attendee_state->name();
-        } else {
-            $attendee_state_name = '';
-        }
-        $template_args['attendee_state'] = $attendee_state_name;
-        $template_args['attendee_zip']   = $primary_attendee->zip();
-
-        $template_args['ship_name']    = $template_args['name'];
-        $template_args['ship_address'] = $template_args['attendee_address'];
-        $template_args['ship_city']    = $template_args['attendee_city'];
-        $template_args['ship_state']   = $template_args['attendee_state'];
-        $template_args['ship_zip']     = $template_args['attendee_zip'];
-
-        $template_args['total_cost']                 = number_format($this->transaction->total(), 2, '.', '');
-        $template_args['transaction']                = $this->transaction;
-        $template_args['amount_pd']                  = $this->transaction->paid();
-        $template_args['amount_owed']                = $this->transaction->total() - $this->transaction->paid();
-        $template_args['payments']                   = $this->transaction->approved_payments();
-        $template_args['net_total']                  = '';
-        $template_args['edit_reg_info_url']          = $this->registration->edit_attendee_information_url();
-        $template_args['retry_payment_url']          = $this->registration->payment_overview_url();
-        $template_args['show_line_item_description'] = $this->check_if_any_line_items_have_a_description(
-            $this->transaction->total_line_item()
-        );
-        if ($template_args['amount_pd'] != $template_args['total_cost']) {
-            // $template_args['net_total'] = $this->espressoInvoiceTotals(
-            //      esc_html__('SubTotal', 'event_espresso'),
-            //      $this->transaction->total());
-            //      $this->session_data['cart']['REG']['sub_total']
-            // );
-            $tax_items = $this->transaction->tax_items();
-            if (! empty($tax_items)) {
-                foreach ($tax_items as $tax) {
-                    $template_args['net_total'] .= $this->espressoInvoiceTotals($tax->name(), $tax->total());
-                }
-            }
-
-            $difference = $template_args['amount_pd'] - $template_args['total_cost'];
-            if ($difference < 0) {
-                $text = esc_html__('Discount', 'event_espresso');
-            } else {
-                $text = esc_html__('Extra', 'event_espresso');
-            }
-            $template_args['discount'] = $this->espressoInvoiceTotals($text, $difference);
-        }
-
-        $template_args['currency_symbol']               = $EE->CFG->currency->sign;
-        $template_args['template_payment_instructions'] = wpautop(
-            stripslashes_deep(
-                html_entity_decode($this->invoice_payment_method->get_extra_meta('pdf_instructions', true), ENT_QUOTES)
-            )
-        );
-        $template_args['shameless_plug']                = apply_filters(
-            'FHEE_Invoice__send_invoice__shameless_plug',
-            true
-        );
-        $receipt = $request->getRequestParam('receipt');
-        if ($receipt) {
-            // receipt-specific stuff
-            $events_for_txn              = EEM_Event::instance()->get_all(
-                [['Registration.TXN_ID' => $this->transaction->ID()]]
-            );
-            $ticket_line_items_per_event = [];
-            $registrations_per_line_item = [];
-            $venues_for_events           = [];
-            foreach ($events_for_txn as $event_id => $event) {
-                $line_items_for_this_event                = EEM_Line_Item::instance()->get_all(
-                    [['Ticket.Datetime.EVT_ID' => $event_id, 'TXN_ID' => $this->transaction->ID()]]
-                );
-                $ticket_line_items_per_event[ $event_id ] = $line_items_for_this_event;
-                foreach ($line_items_for_this_event as $line_item_id => $line_item) {
-                    if (! $line_item instanceof EE_Line_Item) {
-                        continue;
-                    }
-                    $ticket                                       = $line_item->ticket();
-                    $registrations_for_this_ticket                = EEM_Registration::instance()->get_all(
-                        [['TKT_ID' => $ticket->ID(), 'TXN_ID' => $this->transaction->ID()]]
-                    );
-                    $registrations_per_line_item[ $line_item_id ] = $registrations_for_this_ticket;
-                }
-                if ($event instanceof EE_Event) {
-                    $venues_for_events += $event->venues();
-                }
-            }
-            $tax_total_line_item = EEM_Line_Item::instance()->get_one(
-                [['TXN_ID' => $this->transaction->ID(), 'LIN_type' => EEM_Line_Item::type_tax_sub_total]]
-            );
-            $questions_to_skip   = [
-                EEM_Attendee::system_question_fname,
-                EEM_Attendee::system_question_lname,
-                EEM_Attendee::system_question_email,
-            ];
-
-
-            $template_args['events_for_txn']              = $events_for_txn;
-            $template_args['ticket_line_items_per_event'] = $ticket_line_items_per_event;
-            $template_args['registrations_per_line_item'] = $registrations_per_line_item;
-            $template_args['venues_for_events']           = $venues_for_events;
-            $template_args['tax_total_line_item']         = $tax_total_line_item;
-            $template_args['questions_to_skip']           = $questions_to_skip;
-            // d($template_args);
-            $template_args['download_link'] = $this->registration->receipt_url('download');
-        } else {
-            // it's just an invoice we're accessing
-            $template_args['download_link'] = $this->registration->invoice_url('download');
-        }
-
-        // Get the HTML as an object
-        $templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
-        $template_header         = EEH_Template::locate_template(
-            $templates_relative_path . 'invoice_header.template.php',
-            $template_args
-        );
-        if ($receipt) {
-            $template_body = EEH_Template::locate_template(
-                $templates_relative_path . 'receipt_body.template.php',
-                $template_args
-            );
-        } else {
-            $template_body = EEH_Template::locate_template(
-                $templates_relative_path . 'invoice_body.template.php',
-                $template_args
-            );
-        }
-
-
-        $template_footer = EEH_Template::locate_template(
-            $templates_relative_path . 'invoice_footer.template.php',
-            $template_args
-        );
-
-        $copies = $request->getRequestParam('copies', 1, 'int');
-
-        $content = $this->espresso_replace_invoice_shortcodes($template_header);
-        for ($x = 1; $x <= $copies; $x++) {
-            $content .= $this->espresso_replace_invoice_shortcodes($template_body);
-        }
-        $content .= $this->espresso_replace_invoice_shortcodes($template_footer);
-
-        // Check if debugging or mobile is set
-        if ($request->getRequestParam('html')) {
-            echo wp_kses($content, AllowedTags::getWithFormTags());
-            exit(0);
-        }
-        $invoice_name = $template_args['organization'] . ' ';
-        $invoice_name .= esc_html__('Invoice #', 'event_espresso');
-        $invoice_name .= $template_args['registration_code'];
-        $invoice_name .= esc_html__(' for ', 'event_espresso') . $template_args['name'];
-        $invoice_name = str_replace(' ', '_', $invoice_name);
-        // Create the PDF
-        if ($request->requestParamIsSet('html')) {
-            echo wp_kses($content, AllowedTags::getWithFormTags());
-        } else {
-            // only load dompdf if nobody else has yet...
-            if (! class_exists('Dompdf\Dompdf')) {
-                require_once(EE_THIRD_PARTY . 'dompdf/src/Autoloader.php');
-                Dompdf\Autoloader::register();
-            }
-            $options = new Dompdf\Options();
-            $options->set('isRemoteEnabled', true);
-            $options->set('isJavascriptEnabled', false);
-            if (defined('DOMPDF_FONT_DIR')) {
-                $options->setFontDir(DOMPDF_FONT_DIR);
-                $options->setFontCache(DOMPDF_FONT_DIR);
-            }
-            $dompdf = new Dompdf\Dompdf($options);
-            $dompdf->loadHtml($content);
-            $dompdf->render();
-            $dompdf->stream($invoice_name . ".pdf", ['Attachment' => $download]);
-        }
-        exit(0);
-    }
-
-
-    /**
-     * Checks if this line item, or any of its children, actually has a description.
-     * If none do, then the template can decide to not show any description column
-     *
-     * @param EE_Line_Item $line_item
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function check_if_any_line_items_have_a_description(EE_Line_Item $line_item)
-    {
-        if ($line_item->desc()) {
-            return true;
-        } else {
-            foreach ($line_item->children() as $child_line_item) {
-                if ($this->check_if_any_line_items_have_a_description($child_line_item)) {
-                    return true;
-                }
-            }
-            // well, if I and my children don't have descriptions, I guess not
-            return false;
-        }
-    }
-
-
-    /**
-     * Perform the shortcode replacement
-     *
-     * @param $content
-     * @return array|string|string[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function espresso_replace_invoice_shortcodes($content)
-    {
-
-        $EE = EE_Registry::instance();
-        // Create the logo
-        $invoice_logo_url = $this->invoice_payment_method->get_extra_meta(
-            'pdf_logo_image',
-            true,
-            $EE->CFG->organization->logo_url
-        );
-        if (! empty($invoice_logo_url)) {
-            $image_size         = getimagesize($invoice_logo_url);
-            $invoice_logo_image =
-                '<img class="logo screen" src="' . $invoice_logo_url . '" ' . $image_size[3] . ' alt="logo" /> ';
-        } else {
-            $invoice_logo_image = '';
-        }
-        $SearchValues     = [
-            "[organization]",
-            "[registration_code]",
-            "[transaction_id]",
-            "[name]",
-            "[base_url]",
-            "[download_link]",
-            "[invoice_logo_image]",
-            "[street]",
-            "[city]",
-            "[state]",
-            "[zip]",
-            "[email]",
-            "[vat]",
-            "[registration_date]",
-            "[instructions]",
-        ];
-        $primary_attendee = $this->transaction->primary_registration()->attendee();
-        $org_state        = EE_Registry::instance()->load_model('State')->get_one_by_ID($EE->CFG->organization->STA_ID);
-        if ($org_state) {
-            $org_state_name = $org_state->name();
-        } else {
-            $org_state_name = '';
-        }
-        $ReplaceValues = [
-            $EE->CFG->organization->get_pretty('name'),
-            $this->registration->reg_code(),
-            $this->transaction->ID(),
-            $primary_attendee->full_name(),
-            (is_dir(EVENT_ESPRESSO_GATEWAY_DIR . '/invoice'))
-                ? EVENT_ESPRESSO_GATEWAY_URL . 'Invoice/lib/templates/'
-                : EE_GATEWAYS_URL . 'Invoice/lib/templates/',
-            $this->registration->invoice_url(),
-            // home_url() . '/?download_invoice=true&amp;id=' . $this->registration->reg_url_link(),
-            $invoice_logo_image,
-            empty($EE->CFG->organization->address_2)
-                ? $EE->CFG->organization->get_pretty('address_1')
-                : $EE->CFG->organization->get_pretty('address_1') . '<br>' . $EE->CFG->organization->get_pretty(
-                    'address_2'
-                ),
-            $EE->CFG->organization->get_pretty('city'),
-            $org_state_name,
-            $EE->CFG->organization->get_pretty('zip'),
-            $EE->CFG->organization->get_pretty('email'),
-            $EE->CFG->organization->vat,
-            $this->registration->get_i18n_datetime('REG_date', get_option('date_format')),
-            $this->invoice_payment_method->get_extra_meta('pdf_instructions', true),
-        ];
-
-        return str_replace($SearchValues, $ReplaceValues, $content);
-    }
-
-
-    public function espressoLoadData($items)
-    {
-        $lines = $items;
-        $data  = [];
-        foreach ($lines as $line) {
-            $data[] = explode(';', chop($line));
-        }
-
-        return $data;
-    }
-
-
-    public function espressoInvoiceTotals($text, $total_cost)
-    {
-        $html = '';
-        if ($total_cost < 0) {
-            $total_cost = (-1) * $total_cost;
-        }
-        $find    = [' '];
-        $replace = ['-'];
-        $row_id  = strtolower(str_replace($find, $replace, $text));
-        $html    .= '<tr id="' . $row_id . '-tr"><td colspan="4">&nbsp;</td>';
-        $html    .= '<td class="item_r">' . $text . '</td>';
-        $html    .= '<td class="item_r">' . $total_cost . '</td>';
-        $html    .= '</tr>';
-        return $html;
-    }
+	/**
+	 *
+	 * @var EE_Registration
+	 */
+	private $registration;
+
+	/**
+	 *
+	 * @var EE_Transaction
+	 */
+	private $transaction;
+
+	/**
+	 *
+	 * @var EE_Payment_Method
+	 */
+	private $invoice_payment_method;
+
+
+	/**
+	 * Invoice constructor.
+	 *
+	 * @param int $url_link
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated 4.9.13
+	 */
+	public function __construct($url_link = 0)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__,
+			esc_html__(
+				'This class has been deprecated and replaced by the new Messages library.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		/** @var EEM_Registration $reg_model */
+		$reg_model = EE_Registry::instance()->load_model('Registration');
+		if ($this->registration = $reg_model->get_registration_for_reg_url_link($url_link)) {
+			$this->transaction = $this->registration->transaction();
+			EE_Config::instance()->gateway->payment_settings;
+			$this->invoice_payment_method = EEM_Payment_Method::instance()->get_one_of_type('Invoice');
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'Your request appears to be missing some required data, and no information for your transaction could be retrieved.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * @param false $download
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function send_invoice($download = false)
+	{
+		$template_args = [];
+		$EE            = EE_Registry::instance();
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$theme   = $request->getRequestParam('theme', 0, 'int');
+		// allow the request to override the default theme defined in the invoice settings
+		$theme_requested = $theme > 0 && $theme < 8
+				? $theme
+				: null;
+		$themes          = [
+			1 => "simple.css",
+			2 => "bauhaus.css",
+			3 => "ejs.css",
+			4 => "horizon.css",
+			5 => "lola.css",
+			6 => "tranquility.css",
+			7 => "union.css",
+		];
+		// Get the CSS file
+		if (isset($themes[ $theme_requested ])) {
+			$template_args['invoice_css'] = $themes[ $theme_requested ];
+		} else {
+			$template_args['invoice_css'] = $this->invoice_payment_method->get_extra_meta(
+				'legacy_invoice_css',
+				true,
+				'simple.css'
+			);
+		}
+
+		if (is_dir(EVENT_ESPRESSO_GATEWAY_DIR . '/invoice')) {
+			$template_args['base_url'] = EVENT_ESPRESSO_GATEWAY_URL . 'Invoice/lib/templates/';
+		} else {
+			$template_args['base_url'] = EE_GATEWAYS . '/Invoice/lib/templates/';
+		}
+		$primary_attendee = $this->transaction->primary_registration()->attendee();
+
+		$template_args['organization'] = $EE->CFG->organization->get_pretty('name');
+		$template_args['street']       = empty($EE->CFG->organization->address_2)
+				? $EE->CFG->organization->get_pretty('address_1')
+				: $EE->CFG->organization->get_pretty('address_1')
+				  . '<br>'
+				  . $EE->CFG->organization->get_pretty('address_2');
+		$template_args['city']         = $EE->CFG->organization->get_pretty('city');
+		$template_args['state']        = EE_Registry::instance()->load_model('State')->get_one_by_ID(
+			$EE->CFG->organization->STA_ID
+		);
+		$template_args['country']      = EE_Registry::instance()->load_model('Country')->get_one_by_ID(
+			$EE->CFG->organization->CNT_ISO
+		);
+		$template_args['zip']          = $EE->CFG->organization->get_pretty('zip');
+		$template_args['email']        = $EE->CFG->organization->get_pretty('email');
+
+		$template_args['registration_code'] = $this->registration->reg_code();
+		$template_args['registration_date'] = $this->registration->date();
+		$template_args['name']              = $primary_attendee->full_name();
+		$template_args['attendee_address']  = $primary_attendee->address();
+		$template_args['attendee_address2'] = $primary_attendee->address2();
+		$template_args['attendee_city']     = $primary_attendee->city();
+		$attendee_state                     = $primary_attendee->state_obj();
+		if ($attendee_state) {
+			$attendee_state_name = $attendee_state->name();
+		} else {
+			$attendee_state_name = '';
+		}
+		$template_args['attendee_state'] = $attendee_state_name;
+		$template_args['attendee_zip']   = $primary_attendee->zip();
+
+		$template_args['ship_name']    = $template_args['name'];
+		$template_args['ship_address'] = $template_args['attendee_address'];
+		$template_args['ship_city']    = $template_args['attendee_city'];
+		$template_args['ship_state']   = $template_args['attendee_state'];
+		$template_args['ship_zip']     = $template_args['attendee_zip'];
+
+		$template_args['total_cost']                 = number_format($this->transaction->total(), 2, '.', '');
+		$template_args['transaction']                = $this->transaction;
+		$template_args['amount_pd']                  = $this->transaction->paid();
+		$template_args['amount_owed']                = $this->transaction->total() - $this->transaction->paid();
+		$template_args['payments']                   = $this->transaction->approved_payments();
+		$template_args['net_total']                  = '';
+		$template_args['edit_reg_info_url']          = $this->registration->edit_attendee_information_url();
+		$template_args['retry_payment_url']          = $this->registration->payment_overview_url();
+		$template_args['show_line_item_description'] = $this->check_if_any_line_items_have_a_description(
+			$this->transaction->total_line_item()
+		);
+		if ($template_args['amount_pd'] != $template_args['total_cost']) {
+			// $template_args['net_total'] = $this->espressoInvoiceTotals(
+			//      esc_html__('SubTotal', 'event_espresso'),
+			//      $this->transaction->total());
+			//      $this->session_data['cart']['REG']['sub_total']
+			// );
+			$tax_items = $this->transaction->tax_items();
+			if (! empty($tax_items)) {
+				foreach ($tax_items as $tax) {
+					$template_args['net_total'] .= $this->espressoInvoiceTotals($tax->name(), $tax->total());
+				}
+			}
+
+			$difference = $template_args['amount_pd'] - $template_args['total_cost'];
+			if ($difference < 0) {
+				$text = esc_html__('Discount', 'event_espresso');
+			} else {
+				$text = esc_html__('Extra', 'event_espresso');
+			}
+			$template_args['discount'] = $this->espressoInvoiceTotals($text, $difference);
+		}
+
+		$template_args['currency_symbol']               = $EE->CFG->currency->sign;
+		$template_args['template_payment_instructions'] = wpautop(
+			stripslashes_deep(
+				html_entity_decode($this->invoice_payment_method->get_extra_meta('pdf_instructions', true), ENT_QUOTES)
+			)
+		);
+		$template_args['shameless_plug']                = apply_filters(
+			'FHEE_Invoice__send_invoice__shameless_plug',
+			true
+		);
+		$receipt = $request->getRequestParam('receipt');
+		if ($receipt) {
+			// receipt-specific stuff
+			$events_for_txn              = EEM_Event::instance()->get_all(
+				[['Registration.TXN_ID' => $this->transaction->ID()]]
+			);
+			$ticket_line_items_per_event = [];
+			$registrations_per_line_item = [];
+			$venues_for_events           = [];
+			foreach ($events_for_txn as $event_id => $event) {
+				$line_items_for_this_event                = EEM_Line_Item::instance()->get_all(
+					[['Ticket.Datetime.EVT_ID' => $event_id, 'TXN_ID' => $this->transaction->ID()]]
+				);
+				$ticket_line_items_per_event[ $event_id ] = $line_items_for_this_event;
+				foreach ($line_items_for_this_event as $line_item_id => $line_item) {
+					if (! $line_item instanceof EE_Line_Item) {
+						continue;
+					}
+					$ticket                                       = $line_item->ticket();
+					$registrations_for_this_ticket                = EEM_Registration::instance()->get_all(
+						[['TKT_ID' => $ticket->ID(), 'TXN_ID' => $this->transaction->ID()]]
+					);
+					$registrations_per_line_item[ $line_item_id ] = $registrations_for_this_ticket;
+				}
+				if ($event instanceof EE_Event) {
+					$venues_for_events += $event->venues();
+				}
+			}
+			$tax_total_line_item = EEM_Line_Item::instance()->get_one(
+				[['TXN_ID' => $this->transaction->ID(), 'LIN_type' => EEM_Line_Item::type_tax_sub_total]]
+			);
+			$questions_to_skip   = [
+				EEM_Attendee::system_question_fname,
+				EEM_Attendee::system_question_lname,
+				EEM_Attendee::system_question_email,
+			];
+
+
+			$template_args['events_for_txn']              = $events_for_txn;
+			$template_args['ticket_line_items_per_event'] = $ticket_line_items_per_event;
+			$template_args['registrations_per_line_item'] = $registrations_per_line_item;
+			$template_args['venues_for_events']           = $venues_for_events;
+			$template_args['tax_total_line_item']         = $tax_total_line_item;
+			$template_args['questions_to_skip']           = $questions_to_skip;
+			// d($template_args);
+			$template_args['download_link'] = $this->registration->receipt_url('download');
+		} else {
+			// it's just an invoice we're accessing
+			$template_args['download_link'] = $this->registration->invoice_url('download');
+		}
+
+		// Get the HTML as an object
+		$templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
+		$template_header         = EEH_Template::locate_template(
+			$templates_relative_path . 'invoice_header.template.php',
+			$template_args
+		);
+		if ($receipt) {
+			$template_body = EEH_Template::locate_template(
+				$templates_relative_path . 'receipt_body.template.php',
+				$template_args
+			);
+		} else {
+			$template_body = EEH_Template::locate_template(
+				$templates_relative_path . 'invoice_body.template.php',
+				$template_args
+			);
+		}
+
+
+		$template_footer = EEH_Template::locate_template(
+			$templates_relative_path . 'invoice_footer.template.php',
+			$template_args
+		);
+
+		$copies = $request->getRequestParam('copies', 1, 'int');
+
+		$content = $this->espresso_replace_invoice_shortcodes($template_header);
+		for ($x = 1; $x <= $copies; $x++) {
+			$content .= $this->espresso_replace_invoice_shortcodes($template_body);
+		}
+		$content .= $this->espresso_replace_invoice_shortcodes($template_footer);
+
+		// Check if debugging or mobile is set
+		if ($request->getRequestParam('html')) {
+			echo wp_kses($content, AllowedTags::getWithFormTags());
+			exit(0);
+		}
+		$invoice_name = $template_args['organization'] . ' ';
+		$invoice_name .= esc_html__('Invoice #', 'event_espresso');
+		$invoice_name .= $template_args['registration_code'];
+		$invoice_name .= esc_html__(' for ', 'event_espresso') . $template_args['name'];
+		$invoice_name = str_replace(' ', '_', $invoice_name);
+		// Create the PDF
+		if ($request->requestParamIsSet('html')) {
+			echo wp_kses($content, AllowedTags::getWithFormTags());
+		} else {
+			// only load dompdf if nobody else has yet...
+			if (! class_exists('Dompdf\Dompdf')) {
+				require_once(EE_THIRD_PARTY . 'dompdf/src/Autoloader.php');
+				Dompdf\Autoloader::register();
+			}
+			$options = new Dompdf\Options();
+			$options->set('isRemoteEnabled', true);
+			$options->set('isJavascriptEnabled', false);
+			if (defined('DOMPDF_FONT_DIR')) {
+				$options->setFontDir(DOMPDF_FONT_DIR);
+				$options->setFontCache(DOMPDF_FONT_DIR);
+			}
+			$dompdf = new Dompdf\Dompdf($options);
+			$dompdf->loadHtml($content);
+			$dompdf->render();
+			$dompdf->stream($invoice_name . ".pdf", ['Attachment' => $download]);
+		}
+		exit(0);
+	}
+
+
+	/**
+	 * Checks if this line item, or any of its children, actually has a description.
+	 * If none do, then the template can decide to not show any description column
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function check_if_any_line_items_have_a_description(EE_Line_Item $line_item)
+	{
+		if ($line_item->desc()) {
+			return true;
+		} else {
+			foreach ($line_item->children() as $child_line_item) {
+				if ($this->check_if_any_line_items_have_a_description($child_line_item)) {
+					return true;
+				}
+			}
+			// well, if I and my children don't have descriptions, I guess not
+			return false;
+		}
+	}
+
+
+	/**
+	 * Perform the shortcode replacement
+	 *
+	 * @param $content
+	 * @return array|string|string[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function espresso_replace_invoice_shortcodes($content)
+	{
+
+		$EE = EE_Registry::instance();
+		// Create the logo
+		$invoice_logo_url = $this->invoice_payment_method->get_extra_meta(
+			'pdf_logo_image',
+			true,
+			$EE->CFG->organization->logo_url
+		);
+		if (! empty($invoice_logo_url)) {
+			$image_size         = getimagesize($invoice_logo_url);
+			$invoice_logo_image =
+				'<img class="logo screen" src="' . $invoice_logo_url . '" ' . $image_size[3] . ' alt="logo" /> ';
+		} else {
+			$invoice_logo_image = '';
+		}
+		$SearchValues     = [
+			"[organization]",
+			"[registration_code]",
+			"[transaction_id]",
+			"[name]",
+			"[base_url]",
+			"[download_link]",
+			"[invoice_logo_image]",
+			"[street]",
+			"[city]",
+			"[state]",
+			"[zip]",
+			"[email]",
+			"[vat]",
+			"[registration_date]",
+			"[instructions]",
+		];
+		$primary_attendee = $this->transaction->primary_registration()->attendee();
+		$org_state        = EE_Registry::instance()->load_model('State')->get_one_by_ID($EE->CFG->organization->STA_ID);
+		if ($org_state) {
+			$org_state_name = $org_state->name();
+		} else {
+			$org_state_name = '';
+		}
+		$ReplaceValues = [
+			$EE->CFG->organization->get_pretty('name'),
+			$this->registration->reg_code(),
+			$this->transaction->ID(),
+			$primary_attendee->full_name(),
+			(is_dir(EVENT_ESPRESSO_GATEWAY_DIR . '/invoice'))
+				? EVENT_ESPRESSO_GATEWAY_URL . 'Invoice/lib/templates/'
+				: EE_GATEWAYS_URL . 'Invoice/lib/templates/',
+			$this->registration->invoice_url(),
+			// home_url() . '/?download_invoice=true&amp;id=' . $this->registration->reg_url_link(),
+			$invoice_logo_image,
+			empty($EE->CFG->organization->address_2)
+				? $EE->CFG->organization->get_pretty('address_1')
+				: $EE->CFG->organization->get_pretty('address_1') . '<br>' . $EE->CFG->organization->get_pretty(
+					'address_2'
+				),
+			$EE->CFG->organization->get_pretty('city'),
+			$org_state_name,
+			$EE->CFG->organization->get_pretty('zip'),
+			$EE->CFG->organization->get_pretty('email'),
+			$EE->CFG->organization->vat,
+			$this->registration->get_i18n_datetime('REG_date', get_option('date_format')),
+			$this->invoice_payment_method->get_extra_meta('pdf_instructions', true),
+		];
+
+		return str_replace($SearchValues, $ReplaceValues, $content);
+	}
+
+
+	public function espressoLoadData($items)
+	{
+		$lines = $items;
+		$data  = [];
+		foreach ($lines as $line) {
+			$data[] = explode(';', chop($line));
+		}
+
+		return $data;
+	}
+
+
+	public function espressoInvoiceTotals($text, $total_cost)
+	{
+		$html = '';
+		if ($total_cost < 0) {
+			$total_cost = (-1) * $total_cost;
+		}
+		$find    = [' '];
+		$replace = ['-'];
+		$row_id  = strtolower(str_replace($find, $replace, $text));
+		$html    .= '<tr id="' . $row_id . '-tr"><td colspan="4">&nbsp;</td>';
+		$html    .= '<td class="item_r">' . $text . '</td>';
+		$html    .= '<td class="item_r">' . $total_cost . '</td>';
+		$html    .= '</tr>';
+		return $html;
+	}
 }

Spacing +28 added lines, -28 removed lines

@@ -97,8 +97,8 @@ 
             7 => "union.css",
         ];
         // Get the CSS file
-        if (isset($themes[ $theme_requested ])) {
-            $template_args['invoice_css'] = $themes[ $theme_requested ];
+        if (isset($themes[$theme_requested])) {
+            $template_args['invoice_css'] = $themes[$theme_requested];
         } else {
             $template_args['invoice_css'] = $this->invoice_payment_method->get_extra_meta(
                 'legacy_invoice_css',
@@ -107,10 +107,10 @@ 
             );
         }
 
-        if (is_dir(EVENT_ESPRESSO_GATEWAY_DIR . '/invoice')) {
-            $template_args['base_url'] = EVENT_ESPRESSO_GATEWAY_URL . 'Invoice/lib/templates/';
+        if (is_dir(EVENT_ESPRESSO_GATEWAY_DIR.'/invoice')) {
+            $template_args['base_url'] = EVENT_ESPRESSO_GATEWAY_URL.'Invoice/lib/templates/';
         } else {
-            $template_args['base_url'] = EE_GATEWAYS . '/Invoice/lib/templates/';
+            $template_args['base_url'] = EE_GATEWAYS.'/Invoice/lib/templates/';
         }
         $primary_attendee = $this->transaction->primary_registration()->attendee();
 
@@ -169,7 +169,7 @@ 
             //      $this->session_data['cart']['REG']['sub_total']
             // );
             $tax_items = $this->transaction->tax_items();
-            if (! empty($tax_items)) {
+            if ( ! empty($tax_items)) {
                 foreach ($tax_items as $tax) {
                     $template_args['net_total'] .= $this->espressoInvoiceTotals($tax->name(), $tax->total());
                 }
@@ -190,7 +190,7 @@ 
                 html_entity_decode($this->invoice_payment_method->get_extra_meta('pdf_instructions', true), ENT_QUOTES)
             )
         );
-        $template_args['shameless_plug']                = apply_filters(
+        $template_args['shameless_plug'] = apply_filters(
             'FHEE_Invoice__send_invoice__shameless_plug',
             true
         );
@@ -207,16 +207,16 @@ 
                 $line_items_for_this_event                = EEM_Line_Item::instance()->get_all(
                     [['Ticket.Datetime.EVT_ID' => $event_id, 'TXN_ID' => $this->transaction->ID()]]
                 );
-                $ticket_line_items_per_event[ $event_id ] = $line_items_for_this_event;
+                $ticket_line_items_per_event[$event_id] = $line_items_for_this_event;
                 foreach ($line_items_for_this_event as $line_item_id => $line_item) {
-                    if (! $line_item instanceof EE_Line_Item) {
+                    if ( ! $line_item instanceof EE_Line_Item) {
                         continue;
                     }
                     $ticket                                       = $line_item->ticket();
                     $registrations_for_this_ticket                = EEM_Registration::instance()->get_all(
                         [['TKT_ID' => $ticket->ID(), 'TXN_ID' => $this->transaction->ID()]]
                     );
-                    $registrations_per_line_item[ $line_item_id ] = $registrations_for_this_ticket;
+                    $registrations_per_line_item[$line_item_id] = $registrations_for_this_ticket;
                 }
                 if ($event instanceof EE_Event) {
                     $venues_for_events += $event->venues();
@@ -248,24 +248,24 @@ 
         // Get the HTML as an object
         $templates_relative_path = 'modules/gateways/Invoice/lib/templates/';
         $template_header         = EEH_Template::locate_template(
-            $templates_relative_path . 'invoice_header.template.php',
+            $templates_relative_path.'invoice_header.template.php',
             $template_args
         );
         if ($receipt) {
             $template_body = EEH_Template::locate_template(
-                $templates_relative_path . 'receipt_body.template.php',
+                $templates_relative_path.'receipt_body.template.php',
                 $template_args
             );
         } else {
             $template_body = EEH_Template::locate_template(
-                $templates_relative_path . 'invoice_body.template.php',
+                $templates_relative_path.'invoice_body.template.php',
                 $template_args
             );
         }
 
 
         $template_footer = EEH_Template::locate_template(
-            $templates_relative_path . 'invoice_footer.template.php',
+            $templates_relative_path.'invoice_footer.template.php',
             $template_args
         );
 
@@ -282,18 +282,18 @@ 
             echo wp_kses($content, AllowedTags::getWithFormTags());
             exit(0);
         }
-        $invoice_name = $template_args['organization'] . ' ';
+        $invoice_name = $template_args['organization'].' ';
         $invoice_name .= esc_html__('Invoice #', 'event_espresso');
         $invoice_name .= $template_args['registration_code'];
-        $invoice_name .= esc_html__(' for ', 'event_espresso') . $template_args['name'];
+        $invoice_name .= esc_html__(' for ', 'event_espresso').$template_args['name'];
         $invoice_name = str_replace(' ', '_', $invoice_name);
         // Create the PDF
         if ($request->requestParamIsSet('html')) {
             echo wp_kses($content, AllowedTags::getWithFormTags());
         } else {
             // only load dompdf if nobody else has yet...
-            if (! class_exists('Dompdf\Dompdf')) {
-                require_once(EE_THIRD_PARTY . 'dompdf/src/Autoloader.php');
+            if ( ! class_exists('Dompdf\Dompdf')) {
+                require_once(EE_THIRD_PARTY.'dompdf/src/Autoloader.php');
                 Dompdf\Autoloader::register();
             }
             $options = new Dompdf\Options();
@@ -306,7 +306,7 @@ 
             $dompdf = new Dompdf\Dompdf($options);
             $dompdf->loadHtml($content);
             $dompdf->render();
-            $dompdf->stream($invoice_name . ".pdf", ['Attachment' => $download]);
+            $dompdf->stream($invoice_name.".pdf", ['Attachment' => $download]);
         }
         exit(0);
     }
@@ -355,14 +355,14 @@ 
             true,
             $EE->CFG->organization->logo_url
         );
-        if (! empty($invoice_logo_url)) {
+        if ( ! empty($invoice_logo_url)) {
             $image_size         = getimagesize($invoice_logo_url);
             $invoice_logo_image =
-                '<img class="logo screen" src="' . $invoice_logo_url . '" ' . $image_size[3] . ' alt="logo" /> ';
+                '<img class="logo screen" src="'.$invoice_logo_url.'" '.$image_size[3].' alt="logo" /> ';
         } else {
             $invoice_logo_image = '';
         }
-        $SearchValues     = [
+        $SearchValues = [
             "[organization]",
             "[registration_code]",
             "[transaction_id]",
@@ -391,15 +391,15 @@ 
             $this->registration->reg_code(),
             $this->transaction->ID(),
             $primary_attendee->full_name(),
-            (is_dir(EVENT_ESPRESSO_GATEWAY_DIR . '/invoice'))
+            (is_dir(EVENT_ESPRESSO_GATEWAY_DIR.'/invoice'))
                 ? EVENT_ESPRESSO_GATEWAY_URL . 'Invoice/lib/templates/'
-                : EE_GATEWAYS_URL . 'Invoice/lib/templates/',
+                : EE_GATEWAYS_URL.'Invoice/lib/templates/',
             $this->registration->invoice_url(),
             // home_url() . '/?download_invoice=true&amp;id=' . $this->registration->reg_url_link(),
             $invoice_logo_image,
             empty($EE->CFG->organization->address_2)
                 ? $EE->CFG->organization->get_pretty('address_1')
-                : $EE->CFG->organization->get_pretty('address_1') . '<br>' . $EE->CFG->organization->get_pretty(
+                : $EE->CFG->organization->get_pretty('address_1').'<br>'.$EE->CFG->organization->get_pretty(
                     'address_2'
                 ),
             $EE->CFG->organization->get_pretty('city'),
@@ -436,9 +436,9 @@ 
         $find    = [' '];
         $replace = ['-'];
         $row_id  = strtolower(str_replace($find, $replace, $text));
-        $html    .= '<tr id="' . $row_id . '-tr"><td colspan="4">&nbsp;</td>';
-        $html    .= '<td class="item_r">' . $text . '</td>';
-        $html    .= '<td class="item_r">' . $total_cost . '</td>';
+        $html    .= '<tr id="'.$row_id.'-tr"><td colspan="4">&nbsp;</td>';
+        $html    .= '<td class="item_r">'.$text.'</td>';
+        $html    .= '<td class="item_r">'.$total_cost.'</td>';
         $html    .= '</tr>';
         return $html;
     }

modules/ticket_selector/templates/simple_ticket_selector.template.php

Spacing +2 added lines, -2 removed lines

@@ -27,7 +27,7 @@ 
 if ($ticket instanceof EE_Ticket) {
     do_action('AHEE__ticket_selector_chart__template__before_ticket_selector', $event);
     $ticket_description .= ! empty($ticket_description)
-        ? '<br />' . $ticket_status_display
+        ? '<br />'.$ticket_status_display
         : $ticket_status_display;
     if (strpos($ticket_description, '<div') === false) {
         $ticket_description = "<p>{$ticket_description}</p>";
@@ -36,7 +36,7 @@ 
 <div id="no-tkt-slctr-ticket-dv-<?php echo esc_attr($EVT_ID); ?>" class="no-tkt-slctr-ticket-dv">
     <div class="no-tkt-slctr-ticket-content-dv">
         <h5><?php echo esc_html($ticket->name()); ?></h5>
-        <?php if (! empty($ticket_description)) { ?>
+        <?php if ( ! empty($ticket_description)) { ?>
             <?php echo wp_kses($ticket_description, AllowedTags::getAllowedTags()); ?>
         <?php } ?>
     </div><!-- .no-tkt-slctr-ticket-content-dv -->

modules/ticket_selector/templates/ticket_details.template.php

Indentation +122 added lines, -122 removed lines

@@ -21,28 +21,28 @@ 
 use EventEspresso\modules\ticket_selector\TicketDetails;
 
 $event_date_label = apply_filters(
-    'FHEE__ticket_selector_chart_template__ticket_details_event_access_table_event_date',
-    esc_html__('Event Date ', 'event_espresso')
+	'FHEE__ticket_selector_chart_template__ticket_details_event_access_table_event_date',
+	esc_html__('Event Date ', 'event_espresso')
 );
 
 $sold_label = apply_filters(
-    'FHEE__ticket_selector_chart_template__ticket_details_event_access_table_this_ticket_sold',
-    esc_html__('Sold', 'event_espresso')
+	'FHEE__ticket_selector_chart_template__ticket_details_event_access_table_this_ticket_sold',
+	esc_html__('Sold', 'event_espresso')
 );
 
 $remaining_label = apply_filters(
-    'FHEE__ticket_selector_chart_template__ticket_details_event_access_table_this_ticket_left',
-    esc_html__('Remaining', 'event_espresso')
+	'FHEE__ticket_selector_chart_template__ticket_details_event_access_table_this_ticket_left',
+	esc_html__('Remaining', 'event_espresso')
 );
 
 $total_sold_label = apply_filters(
-    'FHEE__ticket_selector_chart_template__ticket_details_event_access_table_total_ticket_sold',
-    esc_html__('Total Sold', 'event_espresso')
+	'FHEE__ticket_selector_chart_template__ticket_details_event_access_table_total_ticket_sold',
+	esc_html__('Total Sold', 'event_espresso')
 );
 
 $spaces_left_label = apply_filters(
-    'FHEE__ticket_selector_chart_template__ticket_details_event_access_table_total_ticket_left',
-    esc_html__('Total Spaces Left', 'event_espresso')
+	'FHEE__ticket_selector_chart_template__ticket_details_event_access_table_total_ticket_left',
+	esc_html__('Total Spaces Left', 'event_espresso')
 );
 
 ?>
@@ -56,32 +56,32 @@ 
                     <p><?php echo wp_kses($ticket->description(), AllowedTags::getAllowedTags()); ?></p>
 
                     <?php
-                    do_action(
-                        'AHEE__ticket_selector_chart_template__ticket_details__after_description',
-                        $ticket,
-                        $ticket_price,
-                        $display_ticket_price
-                    );
-                    ?>
+					do_action(
+						'AHEE__ticket_selector_chart_template__ticket_details__after_description',
+						$ticket,
+						$ticket_price,
+						$display_ticket_price
+					);
+					?>
                     <section class="tckt-slctr-tkt-sale-dates-sctn">
                         <h5>
                             <?php echo apply_filters(
-                                'FHEE__ticket_selector_chart_template__ticket_details_sales_date_heading',
-                                esc_html__('Sale Dates', 'event_espresso')
-                            ); ?>
+								'FHEE__ticket_selector_chart_template__ticket_details_sales_date_heading',
+								esc_html__('Sale Dates', 'event_espresso')
+							); ?>
                         </h5>
                         <span class="drk-grey-text small-text no-bold"> -
                             <?php echo apply_filters(
-                                'FHEE__ticket_selector_chart_template__ticket_details_dates_available_message',
-                                esc_html__('The dates when this option is available for purchase.', 'event_espresso')
-                            ); ?>
+								'FHEE__ticket_selector_chart_template__ticket_details_dates_available_message',
+								esc_html__('The dates when this option is available for purchase.', 'event_espresso')
+							); ?>
                         </span>
                         <br />
                         <span class="ticket-details-label-spn drk-grey-text">
                             <?php echo apply_filters(
-                                'FHEE__ticket_selector_chart_template__ticket_details_goes_on_sale',
-                                esc_html__('Goes On Sale:', 'event_espresso')
-                            ); ?>
+								'FHEE__ticket_selector_chart_template__ticket_details_goes_on_sale',
+								esc_html__('Goes On Sale:', 'event_espresso')
+							); ?>
                         </span>
                         <span class="dashicons dashicons-calendar"></span>
                         <?php echo esc_html($ticket->get_i18n_datetime('TKT_start_date', $date_format)) . ' &nbsp; '; ?>
@@ -90,9 +90,9 @@ 
                         <br />
                         <span class="ticket-details-label-spn drk-grey-text">
                             <?php echo apply_filters(
-                                'FHEE__ticket_selector_chart_template__ticket_details_sales_end',
-                                esc_html__('Sales End:', 'event_espresso')
-                            ); ?>
+								'FHEE__ticket_selector_chart_template__ticket_details_sales_end',
+								esc_html__('Sales End:', 'event_espresso')
+							); ?>
                         </span>
                         <span class="dashicons dashicons-calendar"></span>
                         <?php echo esc_html($ticket->get_i18n_datetime('TKT_end_date', $date_format)) . ' &nbsp; '; ?>
@@ -108,53 +108,53 @@ 
                         <section class="tckt-slctr-tkt-quantities-sctn">
                             <h5>
                                 <?php echo apply_filters(
-                                    'FHEE__ticket_selector_chart_template__ticket_details_purchasable_quantities_heading',
-                                    esc_html__('Purchasable Quantities', 'event_espresso')
-                                ); ?>
+									'FHEE__ticket_selector_chart_template__ticket_details_purchasable_quantities_heading',
+									esc_html__('Purchasable Quantities', 'event_espresso')
+								); ?>
                             </h5>
                             <span class="drk-grey-text small-text no-bold"> -
                                 <?php echo apply_filters(
-                                    'FHEE__ticket_selector_chart_template__ticket_details_purchasable_quantities_message',
-                                    esc_html__(
-                                        'The number of tickets that can be purchased per transaction (if available).',
-                                        'event_espresso'
-                                    )
-                                ); ?>
+									'FHEE__ticket_selector_chart_template__ticket_details_purchasable_quantities_message',
+									esc_html__(
+										'The number of tickets that can be purchased per transaction (if available).',
+										'event_espresso'
+									)
+								); ?>
                             </span>
                             <br />
                             <span class="ticket-details-label-spn drk-grey-text">
                                 <?php echo apply_filters(
-                                    'FHEE__ticket_selector_chart_template__ticket_details_purchasable_quantities_min_qty',
-                                    esc_html__('Minimum Qty:', 'event_espresso')
-                                ); ?>
+									'FHEE__ticket_selector_chart_template__ticket_details_purchasable_quantities_min_qty',
+									esc_html__('Minimum Qty:', 'event_espresso')
+								); ?>
                             </span>
                             <?php
-                            echo ($ticket->min() > 0 ? $ticket->min() : 0);
+							echo ($ticket->min() > 0 ? $ticket->min() : 0);
 
-                            if ($ticket->min() > $remaining) {
-                                ?> &nbsp;
+							if ($ticket->min() > $remaining) {
+								?> &nbsp;
                                 <span class="important-notice small-text">
                                 <?php echo apply_filters(
-                                    'FHEE__ticket_selector_chart_template__ticket_details_purchasable_quantities_min_qty_message',
-                                    esc_html__(
-                                        'The Minimum Quantity purchasable for this ticket exceeds the number of spaces remaining',
-                                        'event_espresso'
-                                    )
-                                ); ?>
+									'FHEE__ticket_selector_chart_template__ticket_details_purchasable_quantities_min_qty_message',
+									esc_html__(
+										'The Minimum Quantity purchasable for this ticket exceeds the number of spaces remaining',
+										'event_espresso'
+									)
+								); ?>
                                 </span>
                             <?php } ?>
                             <br />
                             <?php // $max = min( $max, $max_atndz );?>
                             <span class="ticket-details-label-spn drk-grey-text">
                                 <?php echo apply_filters(
-                                    'FHEE__ticket_selector_chart_template__ticket_details_purchasable_quantities_max_qty',
-                                    esc_html__('Maximum Qty:', 'event_espresso')
-                                ); ?>
+									'FHEE__ticket_selector_chart_template__ticket_details_purchasable_quantities_max_qty',
+									esc_html__('Maximum Qty:', 'event_espresso')
+								); ?>
                             </span>
                             <?php echo ($ticket->max() === EE_INF
-                                ? esc_html__('no limit', 'event_espresso')
-                                : max($ticket->max(), 1));
-                            ?>
+								? esc_html__('no limit', 'event_espresso')
+								: max($ticket->max(), 1));
+							?>
                             <br />
                         </section>
                         <br />
@@ -164,31 +164,31 @@ 
                         <section class="tckt-slctr-tkt-uses-sctn">
                             <h5>
                                 <?php echo apply_filters(
-                                    'FHEE__ticket_selector_chart_template__ticket_details_event_date_ticket_uses_heading',
-                                    esc_html__('Event Date Ticket Uses', 'event_espresso')
-                                ); ?>
+									'FHEE__ticket_selector_chart_template__ticket_details_event_date_ticket_uses_heading',
+									esc_html__('Event Date Ticket Uses', 'event_espresso')
+								); ?>
                             </h5>
                             <span class="drk-grey-text small-text no-bold"> -
                                 <?php echo apply_filters(
-                                    'FHEE__ticket_selector_chart_template__ticket_details_event_date_ticket_uses_message',
-                                    sprintf(
-                                        esc_html__(
-                                            'The number of separate event datetimes (see table below) that this ticket can be used to gain admittance to.%1$s%2$sAdmission is always one person per ticket.%3$s',
-                                            'event_espresso'
-                                        ),
-                                        '<br/>',
-                                        '<strong>',
-                                        '</strong>'
-                                    )
-                                );
-                                ?>
+									'FHEE__ticket_selector_chart_template__ticket_details_event_date_ticket_uses_message',
+									sprintf(
+										esc_html__(
+											'The number of separate event datetimes (see table below) that this ticket can be used to gain admittance to.%1$s%2$sAdmission is always one person per ticket.%3$s',
+											'event_espresso'
+										),
+										'<br/>',
+										'<strong>',
+										'</strong>'
+									)
+								);
+								?>
                             </span>
                             <br />
                             <span class="ticket-details-label-spn drk-grey-text">
                                 <?php echo apply_filters(
-                                    'FHEE__ticket_selector_chart_template__ticket_details_event_date_number_datetimes',
-                                    esc_html__('# Datetimes:', 'event_espresso')
-                                ); ?>
+									'FHEE__ticket_selector_chart_template__ticket_details_event_date_number_datetimes',
+									esc_html__('# Datetimes:', 'event_espresso')
+								); ?>
                             </span>
                             <?php echo wp_kses($ticket->uses(), AllowedTags::getAllowedTags()); ?>
                             <br />
@@ -196,24 +196,24 @@ 
                     <?php } ?>
 
                     <?php
-                    $datetimes          = $ticket->datetimes_ordered($event_is_expired, false);
-                    $chart_column_width = $show_ticket_sale_columns ? ' ee-fourth-width' : ' ee-half-width';
-                    if (! empty($datetimes)) { ?>
+					$datetimes          = $ticket->datetimes_ordered($event_is_expired, false);
+					$chart_column_width = $show_ticket_sale_columns ? ' ee-fourth-width' : ' ee-half-width';
+					if (! empty($datetimes)) { ?>
                         <section class="tckt-slctr-tkt-datetimes-sctn">
                             <h5>
                                 <?php echo apply_filters(
-                                    'FHEE__ticket_selector_chart_template__ticket_details_event_access_heading',
-                                    esc_html__('Access', 'event_espresso')
-                                ); ?>
+									'FHEE__ticket_selector_chart_template__ticket_details_event_access_heading',
+									esc_html__('Access', 'event_espresso')
+								); ?>
                             </h5>
                             <span class="drk-grey-text small-text no-bold"> -
                                 <?php echo apply_filters(
-                                    'FHEE__ticket_selector_chart_template__ticket_details_event_access_message',
-                                    esc_html__(
-                                        'This option allows access to the following dates and times.',
-                                        'event_espresso'
-                                    )
-                                ); ?>
+									'FHEE__ticket_selector_chart_template__ticket_details_event_access_message',
+									esc_html__(
+										'This option allows access to the following dates and times.',
+										'event_espresso'
+									)
+								); ?>
                             </span>
                         <div class="tckt-slctr-tkt-details-tbl-wrap-dv">
                             <table class="tckt-slctr-tkt-details-tbl">
@@ -223,9 +223,9 @@ 
                                             <span class="dashicons dashicons-calendar"></span>
                                             <span class="small-text">
                                             <?php echo apply_filters(
-                                                'FHEE__ticket_selector_chart_template__ticket_details_event_access_table_event_date',
-                                                esc_html__('Date ', 'event_espresso')
-                                            ); ?>
+												'FHEE__ticket_selector_chart_template__ticket_details_event_access_table_event_date',
+												esc_html__('Date ', 'event_espresso')
+											); ?>
                                         </span>
                                         </th>
                                         <th class="tckt-slctr-tkt-details-time-th <?php echo esc_attr($chart_column_width); ?>">
@@ -238,33 +238,33 @@ 
                                         <th class="tckt-slctr-tkt-details-this-ticket-sold-th ee-fourth-width cntr">
                                             <span class="smaller-text">
                                                 <?php echo apply_filters(
-                                                    'FHEE__ticket_selector_chart_template__ticket_details_event_access_table_this_ticket_sold',
-                                                    sprintf(esc_html__('Sold', 'event_espresso'), '<br/>')
-                                                ); ?>
+													'FHEE__ticket_selector_chart_template__ticket_details_event_access_table_this_ticket_sold',
+													sprintf(esc_html__('Sold', 'event_espresso'), '<br/>')
+												); ?>
                                             </span>
                                         </th>
                                         <th class="tckt-slctr-tkt-details-this-ticket-left-th ee-fourth-width cntr">
                                             <span class="smaller-text">
                                                 <?php echo apply_filters(
-                                                    'FHEE__ticket_selector_chart_template__ticket_details_event_access_table_this_ticket_left',
-                                                    sprintf(esc_html__('Remaining', 'event_espresso'), '<br/>')
-                                                ); ?>
+													'FHEE__ticket_selector_chart_template__ticket_details_event_access_table_this_ticket_left',
+													sprintf(esc_html__('Remaining', 'event_espresso'), '<br/>')
+												); ?>
                                             </span>
                                         </th>
                                         <th class="tckt-slctr-tkt-details-total-tickets-sold-th ee-fourth-width cntr">
                                             <span class="smaller-text">
                                                 <?php echo apply_filters(
-                                                    'FHEE__ticket_selector_chart_template__ticket_details_event_access_table_total_ticket_sold',
-                                                    sprintf(esc_html__('Total%sSold', 'event_espresso'), '<br/>')
-                                                ); ?>
+													'FHEE__ticket_selector_chart_template__ticket_details_event_access_table_total_ticket_sold',
+													sprintf(esc_html__('Total%sSold', 'event_espresso'), '<br/>')
+												); ?>
                                             </span>
                                         </th>
                                         <th class="tckt-slctr-tkt-details-total-tickets-left-th ee-fourth-width cntr">
                                             <span class="smaller-text">
                                                 <?php echo apply_filters(
-                                                    'FHEE__ticket_selector_chart_template__ticket_details_event_access_table_total_ticket_left',
-                                                    sprintf(esc_html__('Total Spaces%sLeft', 'event_espresso'), '<br/>')
-                                                ); ?>
+													'FHEE__ticket_selector_chart_template__ticket_details_event_access_table_total_ticket_left',
+													sprintf(esc_html__('Total Spaces%sLeft', 'event_espresso'), '<br/>')
+												); ?>
                                             </span>
                                         </th>
                                         <?php endif; // end $show_ticket_sale_columns conditional ?>
@@ -272,25 +272,25 @@ 
                                 </thead>
                                 <tbody>
                                 <?php foreach ($datetimes as $datetime) {
-                                    if ($datetime instanceof EE_Datetime) { ?>
+									if ($datetime instanceof EE_Datetime) { ?>
                                     <tr>
                                         <td data-th="<?php echo esc_attr($event_date_label); ?>" class="small-text">
                                             <?php $datetime_name = $datetime->name(); ?>
                                             <?php echo ! empty($datetime_name)
-                                            ? '<b>' . esc_html($datetime_name) . '</b><br/>'
-                                            : ''; ?>
+											? '<b>' . esc_html($datetime_name) . '</b><br/>'
+											: ''; ?>
                                             <?php echo esc_html($datetime->date_range(
-                                                $date_format,
-                                                esc_html__(' to  ', 'event_espresso')
-                                            )); ?>
+												$date_format,
+												esc_html__(' to  ', 'event_espresso')
+											)); ?>
                                         </td>
                                         <td data-th="<?php esc_html_e('Time ', 'event_espresso'); ?>"
                                             class="cntr small-text"
                                         >
                                             <?php echo esc_html($datetime->time_range(
-                                                $time_format,
-                                                esc_html__(' to  ', 'event_espresso')
-                                            )); ?>
+												$time_format,
+												esc_html__(' to  ', 'event_espresso')
+											)); ?>
                                         </td>
                                         <?php if ($show_ticket_sale_columns) : ?>
                                         <td data-th="<?php echo esc_attr($sold_label); ?>" class="cntr small-text">
@@ -298,25 +298,25 @@ 
                                         </td>
                                         <td data-th="<?php echo esc_attr($remaining_label); ?>" class="cntr small-text">
                                             <?php echo ($remaining === EE_INF
-                                                ? '<span class="smaller-text">'
-                                                  . esc_html__('unlimited ', 'event_espresso')
-                                                  . '</span>'
-                                                : $remaining); ?>
+												? '<span class="smaller-text">'
+												  . esc_html__('unlimited ', 'event_espresso')
+												  . '</span>'
+												: $remaining); ?>
                                         </td>
                                         <td data-th="<?php echo esc_attr($total_sold_label); ?>" class="cntr small-text">
                                             <?php echo esc_html($datetime->sold()); ?>
                                         </td>
                                             <?php $tkts_left = $datetime->sold_out()
-                                                ? '<span class="sold-out smaller-text">'
-                                                  . esc_html__('Sold&nbsp;Out', 'event_espresso')
-                                                  . '</span>'
-                                                : $datetime->spaces_remaining(); ?>
+												? '<span class="sold-out smaller-text">'
+												  . esc_html__('Sold&nbsp;Out', 'event_espresso')
+												  . '</span>'
+												: $datetime->spaces_remaining(); ?>
                                         <td data-th="<?php echo esc_attr($spaces_left_label); ?>" class="cntr small-text">
                                             <?php echo ($tkts_left === EE_INF
-                                                ? '<span class="smaller-text">'
-                                                  . esc_html__('unlimited ', 'event_espresso')
-                                                  . '</span>'
-                                                : $tkts_left); ?>
+												? '<span class="smaller-text">'
+												  . esc_html__('unlimited ', 'event_espresso')
+												  . '</span>'
+												: $tkts_left); ?>
                                         </td>
                                         <?php endif; // end $show_ticket_sale_columns conditional ?>
                                     </tr>

Spacing +6 added lines, -6 removed lines

@@ -84,7 +84,7 @@ 
                             ); ?>
                         </span>
                         <span class="dashicons dashicons-calendar"></span>
-                        <?php echo esc_html($ticket->get_i18n_datetime('TKT_start_date', $date_format)) . ' &nbsp; '; ?>
+                        <?php echo esc_html($ticket->get_i18n_datetime('TKT_start_date', $date_format)).' &nbsp; '; ?>
                         <span class="dashicons dashicons-clock"></span>
                         <?php echo esc_html($ticket->get_i18n_datetime('TKT_start_date', $time_format)); ?>
                         <br />
@@ -95,7 +95,7 @@ 
                             ); ?>
                         </span>
                         <span class="dashicons dashicons-calendar"></span>
-                        <?php echo esc_html($ticket->get_i18n_datetime('TKT_end_date', $date_format)) . ' &nbsp; '; ?>
+                        <?php echo esc_html($ticket->get_i18n_datetime('TKT_end_date', $date_format)).' &nbsp; '; ?>
                         <span class="dashicons dashicons-clock"></span>
                         <?php echo esc_html($ticket->get_i18n_datetime('TKT_end_date', $time_format)); ?>
                         <br />
@@ -160,7 +160,7 @@ 
                         <br />
                     <?php } ?>
 
-                    <?php if ((! defined('EE_DECAF') || EE_DECAF !== true) && $ticket->uses() !== EE_INF) { ?>
+                    <?php if (( ! defined('EE_DECAF') || EE_DECAF !== true) && $ticket->uses() !== EE_INF) { ?>
                         <section class="tckt-slctr-tkt-uses-sctn">
                             <h5>
                                 <?php echo apply_filters(
@@ -198,7 +198,7 @@ 
                     <?php
                     $datetimes          = $ticket->datetimes_ordered($event_is_expired, false);
                     $chart_column_width = $show_ticket_sale_columns ? ' ee-fourth-width' : ' ee-half-width';
-                    if (! empty($datetimes)) { ?>
+                    if ( ! empty($datetimes)) { ?>
                         <section class="tckt-slctr-tkt-datetimes-sctn">
                             <h5>
                                 <?php echo apply_filters(
@@ -277,7 +277,7 @@ 
                                         <td data-th="<?php echo esc_attr($event_date_label); ?>" class="small-text">
                                             <?php $datetime_name = $datetime->name(); ?>
                                             <?php echo ! empty($datetime_name)
-                                            ? '<b>' . esc_html($datetime_name) . '</b><br/>'
+                                            ? '<b>'.esc_html($datetime_name).'</b><br/>'
                                             : ''; ?>
                                             <?php echo esc_html($datetime->date_range(
                                                 $date_format,
@@ -334,4 +334,4 @@ 
             </div>
         </td>
     </tr>
-<?php endif;  // end template_settings->show_ticket_details check
+<?php endif; // end template_settings->show_ticket_details check

modules/bot_trap/EED_Bot_Trap.module.php

Indentation +276 added lines, -276 removed lines

@@ -18,305 +18,305 @@
 class EED_Bot_Trap extends EED_Module
 {
 
-    /**
-     * @return EED_Module|EED_Bot_Trap
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
+	/**
+	 * @return EED_Module|EED_Bot_Trap
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
 
 
-    /**
-     * set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return void
-     */
-    public static function set_hooks()
-    {
-        if (
-            apply_filters('FHEE__EED_Bot_Trap__set_hooks__use_bot_trap', true) &&
-            EE_Registry::instance()->CFG->registration->use_bot_trap
-        ) {
-            EED_Bot_Trap::set_trap();
-            // redirect bots to bogus success page
-            EE_Config::register_route(
-                'ticket_selection_received',
-                'EED_Bot_Trap',
-                'display_bot_trap_success'
-            );
-        }
-    }
+	/**
+	 * set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return void
+	 */
+	public static function set_hooks()
+	{
+		if (
+			apply_filters('FHEE__EED_Bot_Trap__set_hooks__use_bot_trap', true) &&
+			EE_Registry::instance()->CFG->registration->use_bot_trap
+		) {
+			EED_Bot_Trap::set_trap();
+			// redirect bots to bogus success page
+			EE_Config::register_route(
+				'ticket_selection_received',
+				'EED_Bot_Trap',
+				'display_bot_trap_success'
+			);
+		}
+	}
 
 
-    /**
-     * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @return void
-     */
-    public static function set_trap()
-    {
-        define('EE_BOT_TRAP_BASE_URL', plugin_dir_url(__FILE__) . '/');
-        add_action(
-            'AHEE__ticket_selector_chart__template__after_ticket_selector',
-            array('EED_Bot_Trap', 'generate_bot_trap'),
-            10,
-            2
-        );
-        add_action(
-            'EED_Ticket_Selector__process_ticket_selections__before',
-            array('EED_Bot_Trap', 'process_bot_trap'),
-            1,
-            2
-        );
-    }
+	/**
+	 * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @return void
+	 */
+	public static function set_trap()
+	{
+		define('EE_BOT_TRAP_BASE_URL', plugin_dir_url(__FILE__) . '/');
+		add_action(
+			'AHEE__ticket_selector_chart__template__after_ticket_selector',
+			array('EED_Bot_Trap', 'generate_bot_trap'),
+			10,
+			2
+		);
+		add_action(
+			'EED_Ticket_Selector__process_ticket_selections__before',
+			array('EED_Bot_Trap', 'process_bot_trap'),
+			1,
+			2
+		);
+	}
 
 
-    /**
-     * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @return void
-     */
-    public static function set_hooks_admin()
-    {
-        if (
-            EED_Bot_Trap::getRequest()->isAjax()
-            && apply_filters('FHEE__EED_Bot_Trap__set_hooks__use_bot_trap', true)
-            && EE_Registry::instance()->CFG->registration->use_bot_trap
-        ) {
-            EED_Bot_Trap::set_trap();
-        }
-        add_action(
-            'AHEE__Extend_Registration_Form_Admin_Page___reg_form_settings_template',
-            array('EED_Bot_Trap', 'bot_trap_settings_form'),
-            5
-        );
-        add_filter(
-            'FHEE__Extend_Registration_Form_Admin_Page___update_reg_form_settings__CFG_registration',
-            array('EED_Bot_Trap', 'update_bot_trap_settings_form'),
-            10,
-            1
-        );
-    }
+	/**
+	 * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @return void
+	 */
+	public static function set_hooks_admin()
+	{
+		if (
+			EED_Bot_Trap::getRequest()->isAjax()
+			&& apply_filters('FHEE__EED_Bot_Trap__set_hooks__use_bot_trap', true)
+			&& EE_Registry::instance()->CFG->registration->use_bot_trap
+		) {
+			EED_Bot_Trap::set_trap();
+		}
+		add_action(
+			'AHEE__Extend_Registration_Form_Admin_Page___reg_form_settings_template',
+			array('EED_Bot_Trap', 'bot_trap_settings_form'),
+			5
+		);
+		add_filter(
+			'FHEE__Extend_Registration_Form_Admin_Page___update_reg_form_settings__CFG_registration',
+			array('EED_Bot_Trap', 'update_bot_trap_settings_form'),
+			10,
+			1
+		);
+	}
 
 
-    /**
-     * run - initial module setup
-     *
-     * @param WP $WP
-     * @return void
-     */
-    public function run($WP)
-    {
-    }
+	/**
+	 * run - initial module setup
+	 *
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function run($WP)
+	{
+	}
 
 
-    /**
-     * generate_bot_trap
-     *
-     * @return void
-     * @throws RuntimeException
-     */
-    public static function generate_bot_trap()
-    {
-        $time = microtime(true);
-        $html = '<div class="tkt-slctr-request-processor-dv" style="float:left; margin:0 0 0 -999em; height: 0;">';
-        $html .= '<label for="tkt-slctr-request-processor-email-' . esc_attr($time) . '">' . esc_html__('please do not enter anything in this input', 'event_espresso') . '</label>';
-        $html .= '<input type="email" id="tkt-slctr-request-processor-email-';
-        $html .= esc_attr($time) . '" name="tkt-slctr-request-processor-email" value=""/>';
-        $html .= '</div>';
-        echo wp_kses($html, AllowedTags::getWithFormTags());
-    }
+	/**
+	 * generate_bot_trap
+	 *
+	 * @return void
+	 * @throws RuntimeException
+	 */
+	public static function generate_bot_trap()
+	{
+		$time = microtime(true);
+		$html = '<div class="tkt-slctr-request-processor-dv" style="float:left; margin:0 0 0 -999em; height: 0;">';
+		$html .= '<label for="tkt-slctr-request-processor-email-' . esc_attr($time) . '">' . esc_html__('please do not enter anything in this input', 'event_espresso') . '</label>';
+		$html .= '<input type="email" id="tkt-slctr-request-processor-email-';
+		$html .= esc_attr($time) . '" name="tkt-slctr-request-processor-email" value=""/>';
+		$html .= '</div>';
+		echo wp_kses($html, AllowedTags::getWithFormTags());
+	}
 
 
-    /**
-     * process_bot_trap
-     *
-     * @param array|string $triggered_trap_callback Callback that will be executed for handling the
-     *                                              response if the bot trap is triggered.
-     *                                              It should receive one argument: a boolean indicating
-     *                                              whether the trap was triggered by suspicious timing or not.
-     * @throws RuntimeException
-     */
-    public static function process_bot_trap($triggered_trap_callback = array())
-    {
-        // what's your email address Mr. Bot ?
-        $empty_trap = EED_Bot_Trap::getRequest()->getRequestParam('tkt-slctr-request-processor-email') === '';
-        // are we human ?
-        if ($empty_trap) {
-            do_action('AHEE__EED_Bot_Trap__process_bot_trap__trap_not_triggered');
-            return;
-        }
-        // check the given callback is valid first before executing
-        if (! is_callable($triggered_trap_callback)) {
-            // invalid callback so lets just sub in our default.
-            $triggered_trap_callback = array('EED_Bot_Trap', 'triggered_trap_response');
-        }
-        call_user_func($triggered_trap_callback);
-    }
+	/**
+	 * process_bot_trap
+	 *
+	 * @param array|string $triggered_trap_callback Callback that will be executed for handling the
+	 *                                              response if the bot trap is triggered.
+	 *                                              It should receive one argument: a boolean indicating
+	 *                                              whether the trap was triggered by suspicious timing or not.
+	 * @throws RuntimeException
+	 */
+	public static function process_bot_trap($triggered_trap_callback = array())
+	{
+		// what's your email address Mr. Bot ?
+		$empty_trap = EED_Bot_Trap::getRequest()->getRequestParam('tkt-slctr-request-processor-email') === '';
+		// are we human ?
+		if ($empty_trap) {
+			do_action('AHEE__EED_Bot_Trap__process_bot_trap__trap_not_triggered');
+			return;
+		}
+		// check the given callback is valid first before executing
+		if (! is_callable($triggered_trap_callback)) {
+			// invalid callback so lets just sub in our default.
+			$triggered_trap_callback = array('EED_Bot_Trap', 'triggered_trap_response');
+		}
+		call_user_func($triggered_trap_callback);
+	}
 
 
-    /**
-     * This is the default callback executed by EED_Bot_Trap::process_bot_trap that handles the response.
-     *
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function triggered_trap_response()
-    {
-        // UH OH...
-        $redirect_url = apply_filters(
-            'FHEE__EED_Bot_Trap__process_bot_trap__redirect_url',
-            add_query_arg(
-                array('ee' => 'ticket_selection_received'),
-                EE_Registry::instance()->CFG->core->reg_page_url()
-            )
-        );
-        // if AJAX, return the redirect URL
-        if (EED_Bot_Trap::getRequest()->isAjax()) {
-            echo wp_json_encode(
-                array_merge(
-                    EE_Error::get_notices(false),
-                    array(
-                        'redirect_url' => $redirect_url,
-                    )
-                )
-            );
-            exit();
-        }
-        wp_safe_redirect($redirect_url);
-        exit();
-    }
+	/**
+	 * This is the default callback executed by EED_Bot_Trap::process_bot_trap that handles the response.
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function triggered_trap_response()
+	{
+		// UH OH...
+		$redirect_url = apply_filters(
+			'FHEE__EED_Bot_Trap__process_bot_trap__redirect_url',
+			add_query_arg(
+				array('ee' => 'ticket_selection_received'),
+				EE_Registry::instance()->CFG->core->reg_page_url()
+			)
+		);
+		// if AJAX, return the redirect URL
+		if (EED_Bot_Trap::getRequest()->isAjax()) {
+			echo wp_json_encode(
+				array_merge(
+					EE_Error::get_notices(false),
+					array(
+						'redirect_url' => $redirect_url,
+					)
+				)
+			);
+			exit();
+		}
+		wp_safe_redirect($redirect_url);
+		exit();
+	}
 
 
-    /**
-     * display_bot_trap_success
-     * shows a "success" screen to bots so that they (ie: the ppl managing them)
-     * think the form was submitted successfully
-     *
-     * @return void
-     */
-    public static function display_bot_trap_success()
-    {
-        add_filter('FHEE__EED_Single_Page_Checkout__run', '__return_false');
-        $bot_notice = EED_Bot_Trap::getRequest()->getRequestParam(
-            'ee-notice',
-            esc_html__(
-                'Thank you so much. Your ticket selections have been received for consideration.',
-                'event_espresso'
-            )
-        );
-        EED_Bot_Trap::getResponse()->addOutput(EEH_HTML::div($bot_notice, '', 'ee-attention'));
-    }
+	/**
+	 * display_bot_trap_success
+	 * shows a "success" screen to bots so that they (ie: the ppl managing them)
+	 * think the form was submitted successfully
+	 *
+	 * @return void
+	 */
+	public static function display_bot_trap_success()
+	{
+		add_filter('FHEE__EED_Single_Page_Checkout__run', '__return_false');
+		$bot_notice = EED_Bot_Trap::getRequest()->getRequestParam(
+			'ee-notice',
+			esc_html__(
+				'Thank you so much. Your ticket selections have been received for consideration.',
+				'event_espresso'
+			)
+		);
+		EED_Bot_Trap::getResponse()->addOutput(EEH_HTML::div($bot_notice, '', 'ee-attention'));
+	}
 
 
 
-    /***********************************    ADMIN    **********************************/
+	/***********************************    ADMIN    **********************************/
 
 
-    /**
-     * bot_trap_settings_form
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function bot_trap_settings_form()
-    {
-        EED_Bot_Trap::_bot_trap_settings_form()->enqueue_js();
-        echo EED_Bot_Trap::_bot_trap_settings_form()->get_html(); // already escaped
-    }
+	/**
+	 * bot_trap_settings_form
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function bot_trap_settings_form()
+	{
+		EED_Bot_Trap::_bot_trap_settings_form()->enqueue_js();
+		echo EED_Bot_Trap::_bot_trap_settings_form()->get_html(); // already escaped
+	}
 
 
-    /**
-     * _bot_trap_settings_form
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    protected static function _bot_trap_settings_form()
-    {
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => 'bot_trap_settings',
-                'html_id'         => 'bot_trap_settings',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => array(
-                    'bot_trap_hdr' => new EE_Form_Section_HTML(
-                        EEH_HTML::h2(esc_html__('Bot Trap Settings', 'event_espresso'))
-                    ),
-                    'use_bot_trap' => new EE_Yes_No_Input(
-                        array(
-                            'html_label_text' => esc_html__('Enable Bot Trap', 'event_espresso'),
-                            'html_help_text'  => esc_html__(
-                                'The Event Espresso Bot Trap will insert a fake input into your Ticket Selector forms that is hidden from regular site visitors, but visible to spam bots. Because the input asks for an email address, it is irresistible to spam bots who will of course enter text into it. Since regular site visitors can not see this input, any value detected during form submission means a bot has been detected, which will then be blocked from submitting the form.',
-                                'event_espresso'
-                            ),
-                            'default'         => EE_Registry::instance()->CFG->registration->use_bot_trap !== null
-                                ? EE_Registry::instance()->CFG->registration->use_bot_trap
-                                : true,
-                            'required'        => false,
-                        )
-                    ),
-                ),
-            )
-        );
-    }
+	/**
+	 * _bot_trap_settings_form
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	protected static function _bot_trap_settings_form()
+	{
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => 'bot_trap_settings',
+				'html_id'         => 'bot_trap_settings',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => array(
+					'bot_trap_hdr' => new EE_Form_Section_HTML(
+						EEH_HTML::h2(esc_html__('Bot Trap Settings', 'event_espresso'))
+					),
+					'use_bot_trap' => new EE_Yes_No_Input(
+						array(
+							'html_label_text' => esc_html__('Enable Bot Trap', 'event_espresso'),
+							'html_help_text'  => esc_html__(
+								'The Event Espresso Bot Trap will insert a fake input into your Ticket Selector forms that is hidden from regular site visitors, but visible to spam bots. Because the input asks for an email address, it is irresistible to spam bots who will of course enter text into it. Since regular site visitors can not see this input, any value detected during form submission means a bot has been detected, which will then be blocked from submitting the form.',
+								'event_espresso'
+							),
+							'default'         => EE_Registry::instance()->CFG->registration->use_bot_trap !== null
+								? EE_Registry::instance()->CFG->registration->use_bot_trap
+								: true,
+							'required'        => false,
+						)
+					),
+				),
+			)
+		);
+	}
 
 
-    /**
-     * update_bot_trap_settings_form
-     *
-     * @param EE_Registration_Config $EE_Registration_Config
-     * @return EE_Registration_Config
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function update_bot_trap_settings_form(EE_Registration_Config $EE_Registration_Config)
-    {
-        try {
-            $bot_trap_settings_form = EED_Bot_Trap::_bot_trap_settings_form();
-            // if not displaying a form, then check for form submission
-            if ($bot_trap_settings_form->was_submitted()) {
-                // capture form data
-                $bot_trap_settings_form->receive_form_submission();
-                // validate form data
-                if ($bot_trap_settings_form->is_valid()) {
-                    // grab validated data from form
-                    $valid_data = $bot_trap_settings_form->valid_data();
-                    if (isset($valid_data['use_bot_trap'])) {
-                        $EE_Registration_Config->use_bot_trap = $valid_data['use_bot_trap'];
-                    } else {
-                        EE_Error::add_error(
-                            esc_html__(
-                                'Invalid or missing Bot Trap settings. Please refresh the form and try again.',
-                                'event_espresso'
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                    }
-                } elseif ($bot_trap_settings_form->submission_error_message() !== '') {
-                    EE_Error::add_error(
-                        $bot_trap_settings_form->submission_error_message(),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            }
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-        return $EE_Registration_Config;
-    }
+	/**
+	 * update_bot_trap_settings_form
+	 *
+	 * @param EE_Registration_Config $EE_Registration_Config
+	 * @return EE_Registration_Config
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function update_bot_trap_settings_form(EE_Registration_Config $EE_Registration_Config)
+	{
+		try {
+			$bot_trap_settings_form = EED_Bot_Trap::_bot_trap_settings_form();
+			// if not displaying a form, then check for form submission
+			if ($bot_trap_settings_form->was_submitted()) {
+				// capture form data
+				$bot_trap_settings_form->receive_form_submission();
+				// validate form data
+				if ($bot_trap_settings_form->is_valid()) {
+					// grab validated data from form
+					$valid_data = $bot_trap_settings_form->valid_data();
+					if (isset($valid_data['use_bot_trap'])) {
+						$EE_Registration_Config->use_bot_trap = $valid_data['use_bot_trap'];
+					} else {
+						EE_Error::add_error(
+							esc_html__(
+								'Invalid or missing Bot Trap settings. Please refresh the form and try again.',
+								'event_espresso'
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+					}
+				} elseif ($bot_trap_settings_form->submission_error_message() !== '') {
+					EE_Error::add_error(
+						$bot_trap_settings_form->submission_error_message(),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			}
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+		return $EE_Registration_Config;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -58,7 +58,7 @@ 
      */
     public static function set_trap()
     {
-        define('EE_BOT_TRAP_BASE_URL', plugin_dir_url(__FILE__) . '/');
+        define('EE_BOT_TRAP_BASE_URL', plugin_dir_url(__FILE__).'/');
         add_action(
             'AHEE__ticket_selector_chart__template__after_ticket_selector',
             array('EED_Bot_Trap', 'generate_bot_trap'),
@@ -123,9 +123,9 @@ 
     {
         $time = microtime(true);
         $html = '<div class="tkt-slctr-request-processor-dv" style="float:left; margin:0 0 0 -999em; height: 0;">';
-        $html .= '<label for="tkt-slctr-request-processor-email-' . esc_attr($time) . '">' . esc_html__('please do not enter anything in this input', 'event_espresso') . '</label>';
+        $html .= '<label for="tkt-slctr-request-processor-email-'.esc_attr($time).'">'.esc_html__('please do not enter anything in this input', 'event_espresso').'</label>';
         $html .= '<input type="email" id="tkt-slctr-request-processor-email-';
-        $html .= esc_attr($time) . '" name="tkt-slctr-request-processor-email" value=""/>';
+        $html .= esc_attr($time).'" name="tkt-slctr-request-processor-email" value=""/>';
         $html .= '</div>';
         echo wp_kses($html, AllowedTags::getWithFormTags());
     }
@@ -150,7 +150,7 @@ 
             return;
         }
         // check the given callback is valid first before executing
-        if (! is_callable($triggered_trap_callback)) {
+        if ( ! is_callable($triggered_trap_callback)) {
             // invalid callback so lets just sub in our default.
             $triggered_trap_callback = array('EED_Bot_Trap', 'triggered_trap_response');
         }