eventespresso / event-espresso-core

modules/ticket_selector/EED_Ticket_Selector.module.php

Indentation +259 added lines, -259 removed lines

@@ -22,15 +22,15 @@ 
  */
 class EED_Ticket_Selector extends  EED_Module {
 
-    /**
-     * @var EventEspresso\modules\ticket_selector\DisplayTicketSelector $ticket_selector
-     */
-    private static $ticket_selector;
+	/**
+	 * @var EventEspresso\modules\ticket_selector\DisplayTicketSelector $ticket_selector
+	 */
+	private static $ticket_selector;
 
-    /**
-     * @var EventEspresso\modules\ticket_selector\TicketSelectorIframeEmbedButton $iframe_embed_button
-     */
-    private static $iframe_embed_button;
+	/**
+	 * @var EventEspresso\modules\ticket_selector\TicketSelectorIframeEmbedButton $iframe_embed_button
+	 */
+	private static $iframe_embed_button;
 
 
 
@@ -61,13 +61,13 @@ 
 		// routing
 		EE_Config::register_route( 'iframe', 'EED_Ticket_Selector', 'ticket_selector_iframe', 'ticket_selector' );
 		EE_Config::register_route( 'process_ticket_selections', 'EED_Ticket_Selector', 'process_ticket_selections' );
-        EE_Config::register_route('cancel_ticket_selections', 'EED_Ticket_Selector', 'cancel_ticket_selections');
-        add_action( 'wp_loaded', array( 'EED_Ticket_Selector', 'set_definitions' ), 2 );
+		EE_Config::register_route('cancel_ticket_selections', 'EED_Ticket_Selector', 'cancel_ticket_selections');
+		add_action( 'wp_loaded', array( 'EED_Ticket_Selector', 'set_definitions' ), 2 );
 		add_action( 'AHEE_event_details_header_bottom', array( 'EED_Ticket_Selector', 'display_ticket_selector' ), 10, 1 );
-        add_action( 'wp_enqueue_scripts', array( 'EED_Ticket_Selector', 'translate_js_strings' ), 0 );
-        add_action( 'wp_enqueue_scripts', array( 'EED_Ticket_Selector', 'load_tckt_slctr_assets' ), 10 );
-        EED_Ticket_Selector::loadIframeAssets();
-    }
+		add_action( 'wp_enqueue_scripts', array( 'EED_Ticket_Selector', 'translate_js_strings' ), 0 );
+		add_action( 'wp_enqueue_scripts', array( 'EED_Ticket_Selector', 'load_tckt_slctr_assets' ), 10 );
+		EED_Ticket_Selector::loadIframeAssets();
+	}
 
 
 
@@ -86,16 +86,16 @@ 
 			10
 		);
 
-        /**
-         * Make sure assets for the ticket selector are loaded on the espresso registrations route so  admin side
-         * registrations work.
-         */
+		/**
+		 * Make sure assets for the ticket selector are loaded on the espresso registrations route so  admin side
+		 * registrations work.
+		 */
 		add_action(
-		    'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_registrations__new_registration',
-            array('EED_Ticket_Selector', 'set_definitions'),
-            10
-        );
-    }
+			'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_registrations__new_registration',
+			array('EED_Ticket_Selector', 'set_definitions'),
+			10
+		);
+	}
 
 
 
@@ -111,23 +111,23 @@ 
 
 		//if config is not set, initialize
 		if ( ! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config ) {
-            \EED_Ticket_Selector::instance()->set_config();
-            \EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector = \EED_Ticket_Selector::instance()->config();
+			\EED_Ticket_Selector::instance()->set_config();
+			\EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector = \EED_Ticket_Selector::instance()->config();
 		}
 	}
 
 
 
 	/**
-     * @return \EventEspresso\modules\ticket_selector\DisplayTicketSelector
-     */
-    public static function ticketSelector()
-    {
-        if ( ! EED_Ticket_Selector::$ticket_selector instanceof DisplayTicketSelector) {
-            EED_Ticket_Selector::$ticket_selector = new DisplayTicketSelector();
-        }
-        return EED_Ticket_Selector::$ticket_selector;
-    }
+	 * @return \EventEspresso\modules\ticket_selector\DisplayTicketSelector
+	 */
+	public static function ticketSelector()
+	{
+		if ( ! EED_Ticket_Selector::$ticket_selector instanceof DisplayTicketSelector) {
+			EED_Ticket_Selector::$ticket_selector = new DisplayTicketSelector();
+		}
+		return EED_Ticket_Selector::$ticket_selector;
+	}
 
 
 	/**
@@ -180,15 +180,15 @@ 
 
 
 
-    /**
-     *    creates buttons for selecting number of attendees for an event
-     *
-     * @access    public
-     * @param    WP_Post|int $event
-     * @param    bool        $view_details
-     * @return    string
-     * @throws \EE_Error
-     */
+	/**
+	 *    creates buttons for selecting number of attendees for an event
+	 *
+	 * @access    public
+	 * @param    WP_Post|int $event
+	 * @param    bool        $view_details
+	 * @return    string
+	 * @throws \EE_Error
+	 */
 	public static function display_ticket_selector( $event = NULL, $view_details = FALSE ) {
 		return EED_Ticket_Selector::ticketSelector()->display( $event, $view_details );
 	}
@@ -209,244 +209,244 @@ 
 
 
 
-    /**
-     * cancel_ticket_selections
-     *
-     * @access        public
-     * @return        string
-     */
-    public static function cancel_ticket_selections()
-    {
-        $form = new ProcessTicketSelector();
-        return $form->cancelTicketSelections();
-    }
+	/**
+	 * cancel_ticket_selections
+	 *
+	 * @access        public
+	 * @return        string
+	 */
+	public static function cancel_ticket_selections()
+	{
+		$form = new ProcessTicketSelector();
+		return $form->cancelTicketSelections();
+	}
 
 
 
 	/**
-	* @return void
-	*/
+	 * @return void
+	 */
 	public static function translate_js_strings() {
-        EE_Registry::$i18n_js_strings['please_select_date_filter_notice'] = esc_html__(
-            'please select a datetime', 'event_espresso'
-        );
-    }
+		EE_Registry::$i18n_js_strings['please_select_date_filter_notice'] = esc_html__(
+			'please select a datetime', 'event_espresso'
+		);
+	}
 
 
 
 	/**
-	* 	load js
-	*
-	* 	@access 		public
-	* 	@return 		void
-	*/
+	 * 	load js
+	 *
+	 * 	@access 		public
+	 * 	@return 		void
+	 */
 	public static function load_tckt_slctr_assets() {
 		if ( apply_filters( 'FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', FALSE ) ) {
-            // add some style
-            wp_register_style(
-                'ticket_selector', 
-                TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css',
-                array(),
-                EVENT_ESPRESSO_VERSION
-            );
-            wp_enqueue_style('ticket_selector');
-            // make it dance
-            wp_register_script(
-                'ticket_selector', 
-                TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js', 
-                array('espresso_core'), 
-                EVENT_ESPRESSO_VERSION, 
-                TRUE
-            );
+			// add some style
+			wp_register_style(
+				'ticket_selector', 
+				TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css',
+				array(),
+				EVENT_ESPRESSO_VERSION
+			);
+			wp_enqueue_style('ticket_selector');
+			// make it dance
+			wp_register_script(
+				'ticket_selector', 
+				TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js', 
+				array('espresso_core'), 
+				EVENT_ESPRESSO_VERSION, 
+				TRUE
+			);
 			wp_enqueue_script('ticket_selector');
-            require_once( EE_LIBRARIES.'form_sections/strategies/display/EE_Checkbox_Dropdown_Selector_Display_Strategy.strategy.php');
-            \EE_Checkbox_Dropdown_Selector_Display_Strategy::enqueue_styles_and_scripts();
-        }
+			require_once( EE_LIBRARIES.'form_sections/strategies/display/EE_Checkbox_Dropdown_Selector_Display_Strategy.strategy.php');
+			\EE_Checkbox_Dropdown_Selector_Display_Strategy::enqueue_styles_and_scripts();
+		}
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public static function loadIframeAssets()
+	{
+		// for event lists
+		add_filter(
+			'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
+			array('EED_Ticket_Selector', 'iframeCss')
+		);
+		add_filter(
+			'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
+			array('EED_Ticket_Selector', 'iframeJs')
+		);
+		// for ticket selectors
+		add_filter(
+			'FHEE__EED_Ticket_Selector__ticket_selector_iframe__css',
+			array('EED_Ticket_Selector', 'iframeCss')
+		);
+		add_filter(
+			'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
+			array('EED_Ticket_Selector', 'iframeJs')
+		);
+	}
+
+
+
+	/**
+	 * Informs the rest of the forms system what CSS and JS is needed to display the input
+	 *
+	 * @param array $iframe_css
+	 * @return array
+	 */
+	public static function iframeCss(array $iframe_css)
+	{
+		$iframe_css['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css';
+		return $iframe_css;
 	}
 
 
 
-    /**
-     * @return void
-     */
-    public static function loadIframeAssets()
-    {
-        // for event lists
-        add_filter(
-            'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
-            array('EED_Ticket_Selector', 'iframeCss')
-        );
-        add_filter(
-            'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
-            array('EED_Ticket_Selector', 'iframeJs')
-        );
-        // for ticket selectors
-        add_filter(
-            'FHEE__EED_Ticket_Selector__ticket_selector_iframe__css',
-            array('EED_Ticket_Selector', 'iframeCss')
-        );
-        add_filter(
-            'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
-            array('EED_Ticket_Selector', 'iframeJs')
-        );
-    }
-
-
-
-    /**
-     * Informs the rest of the forms system what CSS and JS is needed to display the input
-     *
-     * @param array $iframe_css
-     * @return array
-     */
-    public static function iframeCss(array $iframe_css)
-    {
-        $iframe_css['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css';
-        return $iframe_css;
-    }
-
-
-
-    /**
-     * Informs the rest of the forms system what CSS and JS is needed to display the input
-     *
-     * @param array $iframe_js
-     * @return array
-     */
-    public static function iframeJs(array $iframe_js)
-    {
-        $iframe_js['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js';
-        return $iframe_js;
-    }
+	/**
+	 * Informs the rest of the forms system what CSS and JS is needed to display the input
+	 *
+	 * @param array $iframe_js
+	 * @return array
+	 */
+	public static function iframeJs(array $iframe_js)
+	{
+		$iframe_js['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js';
+		return $iframe_js;
+	}
 
 
 	/****************************** DEPRECATED ******************************/
 
 
 
-    /**
-     * @deprecated
-     * @return string
-     * @throws \EE_Error
-     */
-    public static function display_view_details_btn()
-    {
-        // todo add doing_it_wrong() notice during next major version
-        return EED_Ticket_Selector::ticketSelector()->displayViewDetailsButton();
-    }
-
-
-
-    /**
-     * @deprecated
-     * @return string
-     * @throws \EE_Error
-     */
-    public static function display_ticket_selector_submit()
-    {
-        // todo add doing_it_wrong() notice during next major version
-        return EED_Ticket_Selector::ticketSelector()->displaySubmitButton();
-    }
-
-
-
-    /**
-     * @deprecated
-     * @param string $permalink_string
-     * @param int    $id
-     * @param string $new_title
-     * @param string $new_slug
-     * @return string
-     */
-    public static function iframe_code_button($permalink_string, $id, $new_title = '', $new_slug = '')
-    {
-        // todo add doing_it_wrong() notice during next major version
-        if (
-        	\EE_Registry::instance()->REQ->get('page') === 'espresso_events'
-        	&& \EE_Registry::instance()->REQ->get('action') === 'edit'
-        ) {
-            $iframe_embed_button = \EED_Ticket_Selector::getIframeEmbedButton();
-            $iframe_embed_button->addEventEditorIframeEmbedButton();
-        }
-        return '';
-    }
-
-
-
-    /**
-     * @deprecated
-     * @param int    $ID
-     * @param string $external_url
-     * @return string
-     */
-    public static function ticket_selector_form_open($ID = 0, $external_url = '')
-    {
-        // todo add doing_it_wrong() notice during next major version
-        return EED_Ticket_Selector::ticketSelector()->formOpen($ID, $external_url);
-    }
-
-
-
-    /**
-     * @deprecated
-     * @return string
-     */
-    public static function ticket_selector_form_close()
-    {
-        // todo add doing_it_wrong() notice during next major version
-        return EED_Ticket_Selector::ticketSelector()->formClose();
-    }
-
-
-
-    /**
-     * @deprecated
-     * @return string
-     */
-    public static function no_tkt_slctr_end_dv()
-    {
-        // todo add doing_it_wrong() notice during next major version
-        return EED_Ticket_Selector::ticketSelector()->ticketSelectorEndDiv();
-    }
-
-
-
-    /**
-     * @deprecated 4.9.13
-     * @return string
-     */
-    public static function tkt_slctr_end_dv()
-    {
-        return EED_Ticket_Selector::ticketSelector()->clearTicketSelector();
-    }
-
-
-
-    /**
-     * @deprecated
-     * @return string
-     */
-    public static function clear_tkt_slctr()
-    {
-        return EED_Ticket_Selector::ticketSelector()->clearTicketSelector();
-    }
-
-
-
-    /**
-     * @deprecated
-     */
-    public static function load_tckt_slctr_assets_admin()
-    {
-        // todo add doing_it_wrong() notice during next major version
-	    if (
-		    \EE_Registry::instance()->REQ->get( 'page' ) === 'espresso_events'
-		    && \EE_Registry::instance()->REQ->get( 'action' ) === 'edit'
-	    ) {
-		    $iframe_embed_button = \EED_Ticket_Selector::getIframeEmbedButton();
-            $iframe_embed_button->embedButtonAssets();
-        }
-    }
+	/**
+	 * @deprecated
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public static function display_view_details_btn()
+	{
+		// todo add doing_it_wrong() notice during next major version
+		return EED_Ticket_Selector::ticketSelector()->displayViewDetailsButton();
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public static function display_ticket_selector_submit()
+	{
+		// todo add doing_it_wrong() notice during next major version
+		return EED_Ticket_Selector::ticketSelector()->displaySubmitButton();
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @param string $permalink_string
+	 * @param int    $id
+	 * @param string $new_title
+	 * @param string $new_slug
+	 * @return string
+	 */
+	public static function iframe_code_button($permalink_string, $id, $new_title = '', $new_slug = '')
+	{
+		// todo add doing_it_wrong() notice during next major version
+		if (
+			\EE_Registry::instance()->REQ->get('page') === 'espresso_events'
+			&& \EE_Registry::instance()->REQ->get('action') === 'edit'
+		) {
+			$iframe_embed_button = \EED_Ticket_Selector::getIframeEmbedButton();
+			$iframe_embed_button->addEventEditorIframeEmbedButton();
+		}
+		return '';
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @param int    $ID
+	 * @param string $external_url
+	 * @return string
+	 */
+	public static function ticket_selector_form_open($ID = 0, $external_url = '')
+	{
+		// todo add doing_it_wrong() notice during next major version
+		return EED_Ticket_Selector::ticketSelector()->formOpen($ID, $external_url);
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @return string
+	 */
+	public static function ticket_selector_form_close()
+	{
+		// todo add doing_it_wrong() notice during next major version
+		return EED_Ticket_Selector::ticketSelector()->formClose();
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @return string
+	 */
+	public static function no_tkt_slctr_end_dv()
+	{
+		// todo add doing_it_wrong() notice during next major version
+		return EED_Ticket_Selector::ticketSelector()->ticketSelectorEndDiv();
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.13
+	 * @return string
+	 */
+	public static function tkt_slctr_end_dv()
+	{
+		return EED_Ticket_Selector::ticketSelector()->clearTicketSelector();
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @return string
+	 */
+	public static function clear_tkt_slctr()
+	{
+		return EED_Ticket_Selector::ticketSelector()->clearTicketSelector();
+	}
+
+
+
+	/**
+	 * @deprecated
+	 */
+	public static function load_tckt_slctr_assets_admin()
+	{
+		// todo add doing_it_wrong() notice during next major version
+		if (
+			\EE_Registry::instance()->REQ->get( 'page' ) === 'espresso_events'
+			&& \EE_Registry::instance()->REQ->get( 'action' ) === 'edit'
+		) {
+			$iframe_embed_button = \EED_Ticket_Selector::getIframeEmbedButton();
+			$iframe_embed_button->embedButtonAssets();
+		}
+	}
 
 
 }

Spacing +29 added lines, -29 removed lines

@@ -3,8 +3,8 @@ 
 use EventEspresso\modules\ticket_selector\TicketSelectorIframe;
 use EventEspresso\modules\ticket_selector\TicketSelectorIframeEmbedButton;
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -38,15 +38,15 @@ 
 	 * @return EED_Ticket_Selector
 	 */
 	public static function instance() {
-		return parent::get_instance( __CLASS__ );
+		return parent::get_instance(__CLASS__);
 	}
 
 
 
-	protected function set_config(){
-		$this->set_config_section( 'template_settings' );
-		$this->set_config_class( 'EE_Ticket_Selector_Config' );
-		$this->set_config_name( 'EED_Ticket_Selector' );
+	protected function set_config() {
+		$this->set_config_section('template_settings');
+		$this->set_config_class('EE_Ticket_Selector_Config');
+		$this->set_config_name('EED_Ticket_Selector');
 	}
 
 
@@ -59,13 +59,13 @@ 
 	 */
 	public static function set_hooks() {
 		// routing
-		EE_Config::register_route( 'iframe', 'EED_Ticket_Selector', 'ticket_selector_iframe', 'ticket_selector' );
-		EE_Config::register_route( 'process_ticket_selections', 'EED_Ticket_Selector', 'process_ticket_selections' );
+		EE_Config::register_route('iframe', 'EED_Ticket_Selector', 'ticket_selector_iframe', 'ticket_selector');
+		EE_Config::register_route('process_ticket_selections', 'EED_Ticket_Selector', 'process_ticket_selections');
         EE_Config::register_route('cancel_ticket_selections', 'EED_Ticket_Selector', 'cancel_ticket_selections');
-        add_action( 'wp_loaded', array( 'EED_Ticket_Selector', 'set_definitions' ), 2 );
-		add_action( 'AHEE_event_details_header_bottom', array( 'EED_Ticket_Selector', 'display_ticket_selector' ), 10, 1 );
-        add_action( 'wp_enqueue_scripts', array( 'EED_Ticket_Selector', 'translate_js_strings' ), 0 );
-        add_action( 'wp_enqueue_scripts', array( 'EED_Ticket_Selector', 'load_tckt_slctr_assets' ), 10 );
+        add_action('wp_loaded', array('EED_Ticket_Selector', 'set_definitions'), 2);
+		add_action('AHEE_event_details_header_bottom', array('EED_Ticket_Selector', 'display_ticket_selector'), 10, 1);
+        add_action('wp_enqueue_scripts', array('EED_Ticket_Selector', 'translate_js_strings'), 0);
+        add_action('wp_enqueue_scripts', array('EED_Ticket_Selector', 'load_tckt_slctr_assets'), 10);
         EED_Ticket_Selector::loadIframeAssets();
     }
 
@@ -82,7 +82,7 @@ 
 		// to load assets for "espresso_events" page on the "edit" route (action)
 		add_action(
 			'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__edit',
-			array( 'EED_Ticket_Selector', 'ticket_selector_iframe_embed_button' ),
+			array('EED_Ticket_Selector', 'ticket_selector_iframe_embed_button'),
 			10
 		);
 
@@ -106,11 +106,11 @@ 
 	 *  @return 	void
 	 */
 	public static function set_definitions() {
-		define( 'TICKET_SELECTOR_ASSETS_URL', plugin_dir_url( __FILE__ ) . 'assets' . DS );
-		define( 'TICKET_SELECTOR_TEMPLATES_PATH', str_replace( '\\', DS, plugin_dir_path( __FILE__ )) . 'templates' . DS );
+		define('TICKET_SELECTOR_ASSETS_URL', plugin_dir_url(__FILE__).'assets'.DS);
+		define('TICKET_SELECTOR_TEMPLATES_PATH', str_replace('\\', DS, plugin_dir_path(__FILE__)).'templates'.DS);
 
 		//if config is not set, initialize
-		if ( ! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config ) {
+		if ( ! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config) {
             \EED_Ticket_Selector::instance()->set_config();
             \EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector = \EED_Ticket_Selector::instance()->config();
 		}
@@ -137,7 +137,7 @@ 
 	 * 	@param	WP $WP
 	 * 	@return void
 	 */
-	public function run( $WP ) {}
+	public function run($WP) {}
 
 
 
@@ -145,7 +145,7 @@ 
 	 * @return \EventEspresso\modules\ticket_selector\TicketSelectorIframeEmbedButton
 	 */
 	public static function getIframeEmbedButton() {
-		if ( ! self::$iframe_embed_button instanceof TicketSelectorIframeEmbedButton ) {
+		if ( ! self::$iframe_embed_button instanceof TicketSelectorIframeEmbedButton) {
 			self::$iframe_embed_button = new TicketSelectorIframeEmbedButton();
 		}
 		return self::$iframe_embed_button;
@@ -189,8 +189,8 @@ 
      * @return    string
      * @throws \EE_Error
      */
-	public static function display_ticket_selector( $event = NULL, $view_details = FALSE ) {
-		return EED_Ticket_Selector::ticketSelector()->display( $event, $view_details );
+	public static function display_ticket_selector($event = NULL, $view_details = FALSE) {
+		return EED_Ticket_Selector::ticketSelector()->display($event, $view_details);
 	}
 
 
@@ -241,11 +241,11 @@ 
 	* 	@return 		void
 	*/
 	public static function load_tckt_slctr_assets() {
-		if ( apply_filters( 'FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', FALSE ) ) {
+		if (apply_filters('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', FALSE)) {
             // add some style
             wp_register_style(
                 'ticket_selector', 
-                TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css',
+                TICKET_SELECTOR_ASSETS_URL.'ticket_selector.css',
                 array(),
                 EVENT_ESPRESSO_VERSION
             );
@@ -253,13 +253,13 @@ 
             // make it dance
             wp_register_script(
                 'ticket_selector', 
-                TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js', 
+                TICKET_SELECTOR_ASSETS_URL.'ticket_selector.js', 
                 array('espresso_core'), 
                 EVENT_ESPRESSO_VERSION, 
                 TRUE
             );
 			wp_enqueue_script('ticket_selector');
-            require_once( EE_LIBRARIES.'form_sections/strategies/display/EE_Checkbox_Dropdown_Selector_Display_Strategy.strategy.php');
+            require_once(EE_LIBRARIES.'form_sections/strategies/display/EE_Checkbox_Dropdown_Selector_Display_Strategy.strategy.php');
             \EE_Checkbox_Dropdown_Selector_Display_Strategy::enqueue_styles_and_scripts();
         }
 	}
@@ -301,7 +301,7 @@ 
      */
     public static function iframeCss(array $iframe_css)
     {
-        $iframe_css['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css';
+        $iframe_css['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL.'ticket_selector.css';
         return $iframe_css;
     }
 
@@ -315,7 +315,7 @@ 
      */
     public static function iframeJs(array $iframe_js)
     {
-        $iframe_js['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js';
+        $iframe_js['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL.'ticket_selector.js';
         return $iframe_js;
     }
 
@@ -440,8 +440,8 @@ 
     {
         // todo add doing_it_wrong() notice during next major version
 	    if (
-		    \EE_Registry::instance()->REQ->get( 'page' ) === 'espresso_events'
-		    && \EE_Registry::instance()->REQ->get( 'action' ) === 'edit'
+		    \EE_Registry::instance()->REQ->get('page') === 'espresso_events'
+		    && \EE_Registry::instance()->REQ->get('action') === 'edit'
 	    ) {
 		    $iframe_embed_button = \EED_Ticket_Selector::getIframeEmbedButton();
             $iframe_embed_button->embedButtonAssets();

modules/ticket_selector/TicketSelectorRowStandard.php

Indentation +398 added lines, -398 removed lines

@@ -19,404 +19,404 @@
 class TicketSelectorRowStandard extends TicketSelectorRow
 {
 
-    /**
-     * @var TicketDetails $ticket_details
-     */
-    protected $ticket_details;
-
-    /**
-     * @var \EE_Ticket_Selector_Config $template_settings
-     */
-    protected $template_settings;
-
-    /**
-     * @var \EE_Tax_Config $tax_settings
-     */
-    protected $tax_settings;
-
-    /**
-     * @var boolean $prices_displayed_including_taxes
-     */
-    protected $prices_displayed_including_taxes;
-
-    /**
-     * @var int $row
-     */
-    protected $row;
-
-    /**
-     * @var int $cols
-     */
-    protected $cols;
-
-    /**
-     * @var boolean $hidden_input_qty
-     */
-    protected $hidden_input_qty;
-
-    /**
-     * @var string $ticket_datetime_classes
-     */
-    protected $ticket_datetime_classes;
-
-
-
-    /**
-     * TicketDetails constructor.
-     *
-     * @param TicketDetails  $ticket_details
-     * @param \EE_Tax_Config $tax_settings
-     * @param int            $total_tickets
-     * @param int            $max_atndz
-     * @param int            $row
-     * @param int            $cols
-     * @param boolean        $required_ticket_sold_out
-     * @param string         $event_status
-     * @param string         $ticket_datetime_classes
-     * @throws EE_Error
-     * @throws UnexpectedEntityException
-     */
-    public function __construct(
-        TicketDetails $ticket_details,
-        \EE_Tax_Config $tax_settings,
-        $total_tickets,
-        $max_atndz,
-        $row,
-        $cols,
-        $required_ticket_sold_out,
-        $event_status,
-        $ticket_datetime_classes
-    ) {
-        $this->ticket = $ticket_details->getTicket();
-        $this->ticket_details = $ticket_details;
-        $this->template_settings = $ticket_details->getTemplateSettings();
-        $this->tax_settings = $tax_settings;
-        $this->total_tickets = $total_tickets;
-        $this->max_atndz = $max_atndz;
-        $this->row = $row;
-        $this->cols = $cols;
-        $this->date_format = $ticket_details->getDateFormat();
-        $this->ticket_datetime_classes = $ticket_datetime_classes;
-        parent::__construct($this->ticket, $max_atndz, $this->date_format, $event_status, $required_ticket_sold_out);
-    }
-
-
-
-    /**
-     * other ticket rows will need to know if a required ticket is sold out,
-     * so that they are not offered for sale
-     *
-     * @return boolean
-     */
-    public function getRequiredTicketSoldOut()
-    {
-        return $this->required_ticket_sold_out;
-    }
-
-
-
-    /**
-     * @return int
-     */
-    public function getCols()
-    {
-        return $this->cols;
-    }
-
-
-
-    /**
-     * getHtml
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function getHtml()
-    {
-        $min = 0;
-        $max = $this->ticket->max();
-        $remaining = $this->ticket->remaining();
-        if ($this->ticket->is_on_sale() && $this->ticket->is_remaining()) {
-            list($min, $max) = $this->setTicketMinAndMax($remaining);
-        } else {
-            // set flag if ticket is required (flag is set to start date so that future tickets are not blocked)
-            $this->required_ticket_sold_out = $this->ticket->required() && ! $remaining
-                ? $this->ticket->start_date()
-                : $this->required_ticket_sold_out;
-        }
-        list($ticket_price, $ticket_bundle) = $this->getTicketPriceDetails();
-        list($tkt_status, $ticket_status, $status_class) = $this->getTicketStatusClasses($remaining);
-        /**
-         * Allow plugins to hook in and abort the generation and display of this row to do
-         * something else if they want.
-         * For an addon to abort things, all they have to do is register a filter with this hook, and
-         * return a value that is NOT false.  Whatever is returned gets echoed instead of the
-         * current row.
-         *
-         * @var string|bool
-         */
-        $ticket_selector_row_html = apply_filters(
-            'FHEE__ticket_selector_chart_template__do_ticket_entire_row',
-            false,
-            $this->ticket,
-            $max,
-            $min,
-            $this->required_ticket_sold_out,
-            $ticket_price,
-            $ticket_bundle,
-            $ticket_status,
-            $status_class
-        );
-        if ($ticket_selector_row_html !== false) {
-            return $ticket_selector_row_html;
-        }
-        $ticket_selector_row_html = \EEH_HTML::tr(
-            '', '',
-            "tckt-slctr-tbl-tr {$status_class}{$this->ticket_datetime_classes} " . espresso_get_object_css_class($this->ticket)
-        );
-        /**
-         * Allow plugins to hook in and abort the generation and display of the contents of this
-         * row to do something else if they want.
-         * For an addon to abort things, all they have to do is register a filter with this hook, and
-         * return a value that is NOT false.  Whatever is returned gets echoed instead of the
-         * current row.
-         *
-         * @var string|bool
-         */
-        $new_row_cells_content = apply_filters(
-            'FHEE__ticket_selector_chart_template__do_ticket_inside_row',
-            false,
-            $this->ticket,
-            $max,
-            $min,
-            $this->required_ticket_sold_out,
-            $ticket_price,
-            $ticket_bundle,
-            $ticket_status,
-            $status_class
-        );
-        if ($new_row_cells_content !== false && $this->max_atndz === 1) {
-            return $ticket_selector_row_html
-                   . $new_row_cells_content
-                   . $this->ticketQtyAndIdHiddenInputs()
-                   . \EEH_HTML::trx();
-        }
-        if ($new_row_cells_content !== false) {
-            return $ticket_selector_row_html
-                   . $new_row_cells_content
-                   . \EEH_HTML::trx();
-        }
-        $this->hidden_input_qty = $this->max_atndz > 1 ? true : false;
-
-        $ticket_selector_row_html .= $this->ticketNameTableCell();
-        $ticket_selector_row_html .= $this->ticketPriceTableCell($ticket_price, $ticket_bundle);
-        $ticket_selector_row_html .= \EEH_HTML::td('', '', 'tckt-slctr-tbl-td-qty cntr');
-        $this->setTicketStatusDisplay($tkt_status, $ticket_status, $remaining);
-        if (empty($this->ticket_status_display)) {
-            if ($this->max_atndz === 1) {
-                // only ONE attendee is allowed to register at a time
-                $ticket_selector_row_html .= $this->onlyOneAttendeeCanRegister();
-            } else if ($max > 0) {
-                $ticket_selector_row_html .= $this->ticketQuantitySelector($min, $max);
-            }
-        }
-        $ticket_selector_row_html .= $this->ticket_status_display;
-        $ticket_selector_row_html .= $this->ticketQtyAndIdHiddenInputs();
-        $ticket_selector_row_html .= $this->ticket_details->display($ticket_price, $remaining, $this->cols);
-        $ticket_selector_row_html .= \EEH_HTML::tdx();
-        $ticket_selector_row_html .= \EEH_HTML::trx();
-
-
-        $this->row++;
-        return $ticket_selector_row_html;
-    }
-
-
-
-    /**
-     * setTicketMinAndMax
-     *
-     * @param int $remaining
-     * @return array
-     * @throws EE_Error
-     */
-    protected function setTicketMinAndMax($remaining)
-    {
-        // offer the number of $tickets_remaining or $this->max_atndz, whichever is smaller
-        $max = min($remaining, $this->max_atndz);
-        // but... we also want to restrict the number of tickets by the ticket max setting,
-        // however, the max still can't be higher than what was just set above
-        $max = $this->ticket->max() > 0 ? min($this->ticket->max(), $max) : $max;
-        // and we also want to restrict the minimum number of tickets by the ticket min setting
-        $min = $this->ticket->min() > 0 ? $this->ticket->min() : 0;
-        // and if the ticket is required, then make sure that min qty is at least 1
-        $min = $this->ticket->required() ? max($min, 1) : $min;
-        return array($min, $max);
-    }
-
-
-
-    /**
-     * getTicketPriceDetails
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    protected function getTicketPriceDetails()
-    {
-        $ticket_price = $this->tax_settings->prices_displayed_including_taxes
-            ? $this->ticket->get_ticket_total_with_taxes()
-            : $this->ticket->get_ticket_subtotal();
-        $ticket_bundle = false;
-        $ticket_min = $this->ticket->min();
-        // for ticket bundles, set min and max qty the same
-        if ($ticket_min !== 0 && $ticket_min === $this->ticket->max()) {
-            $ticket_price *= $ticket_min;
-            $ticket_bundle = true;
-        }
-        $ticket_price = apply_filters(
-            'FHEE__ticket_selector_chart_template__ticket_price',
-            $ticket_price,
-            $this->ticket
-        );
-        return array($ticket_price, $ticket_bundle);
-    }
-
-
-
-
-    /**
-     * ticketNameTableCell
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function ticketNameTableCell()
-    {
-        $html = \EEH_HTML::td('', '', 'tckt-slctr-tbl-td-name');
-        $html .= \EEH_HTML::strong($this->ticket->get_pretty('TKT_name'));
-        $html .= $this->ticket_details->getShowHideLinks();
-        if ($this->ticket->required()) {
-            $html .= \EEH_HTML::p(
-                    apply_filters(
-                            'FHEE__ticket_selector_chart_template__ticket_required_message',
-                            esc_html__('This ticket is required and must be purchased.', 'event_espresso')
-                    ),
-                    '', 'ticket-required-pg'
-            );
-        }
-        $html .= \EEH_HTML::tdx();
-        return $html;
-    }
-
-
-
-    /**
-     * ticketPriceTableCell
-     *
-     * @param float $ticket_price
-     * @param bool  $ticket_bundle
-     * @return string
-     * @throws EE_Error
-     */
-    protected function ticketPriceTableCell($ticket_price, $ticket_bundle)
-    {
-        $html = '';
-        if (apply_filters('FHEE__ticket_selector_chart_template__display_ticket_price_details', true)) {
-            $html .= \EEH_HTML::td('', '', 'tckt-slctr-tbl-td-price jst-rght');
-            $html .= \EEH_Template::format_currency($ticket_price);
-            $html .= $this->ticket->taxable()
-                ? \EEH_HTML::span( '*', '', 'taxable-tickets-asterisk grey-text' )
-                : '';
-            $html .= ' ';
-            $html .= \EEH_HTML::span(
-                $ticket_bundle
-                    ? apply_filters(
-                        'FHEE__ticket_selector_chart_template__per_ticket_bundle_text',
-                        __(' / bundle', 'event_espresso')
-                    )
-                    : apply_filters(
-                        'FHEE__ticket_selector_chart_template__per_ticket_text',
-                        __('', 'event_espresso')
-                    ),
-                '', 'smaller-text no-bold'
-            );
-            $html .= ' ';
-            $html .= \EEH_HTML::tdx();
-            $this->cols++;
-        }
-        return $html;
-    }
-
-
-
-    /**
-     * onlyOneAttendeeCanRegister
-     *
-     * @return string
-     */
-    protected function onlyOneAttendeeCanRegister()
-    {
-        // display submit button since we have tickets available
-        add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
-        $this->hidden_input_qty = false;
-        $html = '<input type="radio" name="tkt-slctr-qty-' . $this->EVT_ID . '"';
-        $html .= ' id="ticket-selector-tbl-qty-slct-' . $this->EVT_ID . '-' . $this->row . '"';
-        $html .= ' class="ticket-selector-tbl-qty-slct" value="' . $this->row . '-1"';
-        $html .= $this->total_tickets === 1 ? ' checked="checked"' : '';
-        $html .= ' title=""/>';
-        return $html;
-    }
-
-
-
-    /**
-     * ticketQuantitySelector
-     *
-     * @param int $min
-     * @param int $max
-     * @return string
-     * @throws EE_Error
-     */
-    protected function ticketQuantitySelector($min = 0, $max = 0)
-    {
-        // display submit button since we have tickets available
-        add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
-        $this->hidden_input_qty = false;
-        $html = '<select name="tkt-slctr-qty-' . $this->EVT_ID . '[]"';
-        $html .= ' id="ticket-selector-tbl-qty-slct-' . $this->EVT_ID . '-' . $this->row . '"';
-        $html .= ' class="ticket-selector-tbl-qty-slct">';
-        // this ensures that non-required tickets with non-zero MIN QTYs don't HAVE to be purchased
-        if ($min !== 0 && ! $this->ticket->required()) {
-            $html .= '<option value="0">&nbsp;0&nbsp;</option>';
-        }
-        // offer ticket quantities from the min to the max
-        for ($i = $min; $i <= $max; $i++) {
-            $html .= '<option value="' . $i . '">&nbsp;' . $i . '&nbsp;</option>';
-        }
-        $html .= '</select>';
-        return $html;
-    }
-
-
-
-    /**
-     * getHiddenInputs
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function ticketQtyAndIdHiddenInputs()
-    {
-        $html = '';
-        // depending on group reg we need to change the format for qty
-        if ($this->hidden_input_qty) {
-            $html .= '<input type="hidden" name="tkt-slctr-qty-' . $this->EVT_ID . '[]" value="0"/>';
-        }
-        $html .= '<input type="hidden" name="tkt-slctr-ticket-id-' . $this->EVT_ID . '[]"';
-        $html .= ' value="' . $this->ticket->ID() . '"/>';
-        return $html;
-    }
+	/**
+	 * @var TicketDetails $ticket_details
+	 */
+	protected $ticket_details;
+
+	/**
+	 * @var \EE_Ticket_Selector_Config $template_settings
+	 */
+	protected $template_settings;
+
+	/**
+	 * @var \EE_Tax_Config $tax_settings
+	 */
+	protected $tax_settings;
+
+	/**
+	 * @var boolean $prices_displayed_including_taxes
+	 */
+	protected $prices_displayed_including_taxes;
+
+	/**
+	 * @var int $row
+	 */
+	protected $row;
+
+	/**
+	 * @var int $cols
+	 */
+	protected $cols;
+
+	/**
+	 * @var boolean $hidden_input_qty
+	 */
+	protected $hidden_input_qty;
+
+	/**
+	 * @var string $ticket_datetime_classes
+	 */
+	protected $ticket_datetime_classes;
+
+
+
+	/**
+	 * TicketDetails constructor.
+	 *
+	 * @param TicketDetails  $ticket_details
+	 * @param \EE_Tax_Config $tax_settings
+	 * @param int            $total_tickets
+	 * @param int            $max_atndz
+	 * @param int            $row
+	 * @param int            $cols
+	 * @param boolean        $required_ticket_sold_out
+	 * @param string         $event_status
+	 * @param string         $ticket_datetime_classes
+	 * @throws EE_Error
+	 * @throws UnexpectedEntityException
+	 */
+	public function __construct(
+		TicketDetails $ticket_details,
+		\EE_Tax_Config $tax_settings,
+		$total_tickets,
+		$max_atndz,
+		$row,
+		$cols,
+		$required_ticket_sold_out,
+		$event_status,
+		$ticket_datetime_classes
+	) {
+		$this->ticket = $ticket_details->getTicket();
+		$this->ticket_details = $ticket_details;
+		$this->template_settings = $ticket_details->getTemplateSettings();
+		$this->tax_settings = $tax_settings;
+		$this->total_tickets = $total_tickets;
+		$this->max_atndz = $max_atndz;
+		$this->row = $row;
+		$this->cols = $cols;
+		$this->date_format = $ticket_details->getDateFormat();
+		$this->ticket_datetime_classes = $ticket_datetime_classes;
+		parent::__construct($this->ticket, $max_atndz, $this->date_format, $event_status, $required_ticket_sold_out);
+	}
+
+
+
+	/**
+	 * other ticket rows will need to know if a required ticket is sold out,
+	 * so that they are not offered for sale
+	 *
+	 * @return boolean
+	 */
+	public function getRequiredTicketSoldOut()
+	{
+		return $this->required_ticket_sold_out;
+	}
+
+
+
+	/**
+	 * @return int
+	 */
+	public function getCols()
+	{
+		return $this->cols;
+	}
+
+
+
+	/**
+	 * getHtml
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function getHtml()
+	{
+		$min = 0;
+		$max = $this->ticket->max();
+		$remaining = $this->ticket->remaining();
+		if ($this->ticket->is_on_sale() && $this->ticket->is_remaining()) {
+			list($min, $max) = $this->setTicketMinAndMax($remaining);
+		} else {
+			// set flag if ticket is required (flag is set to start date so that future tickets are not blocked)
+			$this->required_ticket_sold_out = $this->ticket->required() && ! $remaining
+				? $this->ticket->start_date()
+				: $this->required_ticket_sold_out;
+		}
+		list($ticket_price, $ticket_bundle) = $this->getTicketPriceDetails();
+		list($tkt_status, $ticket_status, $status_class) = $this->getTicketStatusClasses($remaining);
+		/**
+		 * Allow plugins to hook in and abort the generation and display of this row to do
+		 * something else if they want.
+		 * For an addon to abort things, all they have to do is register a filter with this hook, and
+		 * return a value that is NOT false.  Whatever is returned gets echoed instead of the
+		 * current row.
+		 *
+		 * @var string|bool
+		 */
+		$ticket_selector_row_html = apply_filters(
+			'FHEE__ticket_selector_chart_template__do_ticket_entire_row',
+			false,
+			$this->ticket,
+			$max,
+			$min,
+			$this->required_ticket_sold_out,
+			$ticket_price,
+			$ticket_bundle,
+			$ticket_status,
+			$status_class
+		);
+		if ($ticket_selector_row_html !== false) {
+			return $ticket_selector_row_html;
+		}
+		$ticket_selector_row_html = \EEH_HTML::tr(
+			'', '',
+			"tckt-slctr-tbl-tr {$status_class}{$this->ticket_datetime_classes} " . espresso_get_object_css_class($this->ticket)
+		);
+		/**
+		 * Allow plugins to hook in and abort the generation and display of the contents of this
+		 * row to do something else if they want.
+		 * For an addon to abort things, all they have to do is register a filter with this hook, and
+		 * return a value that is NOT false.  Whatever is returned gets echoed instead of the
+		 * current row.
+		 *
+		 * @var string|bool
+		 */
+		$new_row_cells_content = apply_filters(
+			'FHEE__ticket_selector_chart_template__do_ticket_inside_row',
+			false,
+			$this->ticket,
+			$max,
+			$min,
+			$this->required_ticket_sold_out,
+			$ticket_price,
+			$ticket_bundle,
+			$ticket_status,
+			$status_class
+		);
+		if ($new_row_cells_content !== false && $this->max_atndz === 1) {
+			return $ticket_selector_row_html
+				   . $new_row_cells_content
+				   . $this->ticketQtyAndIdHiddenInputs()
+				   . \EEH_HTML::trx();
+		}
+		if ($new_row_cells_content !== false) {
+			return $ticket_selector_row_html
+				   . $new_row_cells_content
+				   . \EEH_HTML::trx();
+		}
+		$this->hidden_input_qty = $this->max_atndz > 1 ? true : false;
+
+		$ticket_selector_row_html .= $this->ticketNameTableCell();
+		$ticket_selector_row_html .= $this->ticketPriceTableCell($ticket_price, $ticket_bundle);
+		$ticket_selector_row_html .= \EEH_HTML::td('', '', 'tckt-slctr-tbl-td-qty cntr');
+		$this->setTicketStatusDisplay($tkt_status, $ticket_status, $remaining);
+		if (empty($this->ticket_status_display)) {
+			if ($this->max_atndz === 1) {
+				// only ONE attendee is allowed to register at a time
+				$ticket_selector_row_html .= $this->onlyOneAttendeeCanRegister();
+			} else if ($max > 0) {
+				$ticket_selector_row_html .= $this->ticketQuantitySelector($min, $max);
+			}
+		}
+		$ticket_selector_row_html .= $this->ticket_status_display;
+		$ticket_selector_row_html .= $this->ticketQtyAndIdHiddenInputs();
+		$ticket_selector_row_html .= $this->ticket_details->display($ticket_price, $remaining, $this->cols);
+		$ticket_selector_row_html .= \EEH_HTML::tdx();
+		$ticket_selector_row_html .= \EEH_HTML::trx();
+
+
+		$this->row++;
+		return $ticket_selector_row_html;
+	}
+
+
+
+	/**
+	 * setTicketMinAndMax
+	 *
+	 * @param int $remaining
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function setTicketMinAndMax($remaining)
+	{
+		// offer the number of $tickets_remaining or $this->max_atndz, whichever is smaller
+		$max = min($remaining, $this->max_atndz);
+		// but... we also want to restrict the number of tickets by the ticket max setting,
+		// however, the max still can't be higher than what was just set above
+		$max = $this->ticket->max() > 0 ? min($this->ticket->max(), $max) : $max;
+		// and we also want to restrict the minimum number of tickets by the ticket min setting
+		$min = $this->ticket->min() > 0 ? $this->ticket->min() : 0;
+		// and if the ticket is required, then make sure that min qty is at least 1
+		$min = $this->ticket->required() ? max($min, 1) : $min;
+		return array($min, $max);
+	}
+
+
+
+	/**
+	 * getTicketPriceDetails
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function getTicketPriceDetails()
+	{
+		$ticket_price = $this->tax_settings->prices_displayed_including_taxes
+			? $this->ticket->get_ticket_total_with_taxes()
+			: $this->ticket->get_ticket_subtotal();
+		$ticket_bundle = false;
+		$ticket_min = $this->ticket->min();
+		// for ticket bundles, set min and max qty the same
+		if ($ticket_min !== 0 && $ticket_min === $this->ticket->max()) {
+			$ticket_price *= $ticket_min;
+			$ticket_bundle = true;
+		}
+		$ticket_price = apply_filters(
+			'FHEE__ticket_selector_chart_template__ticket_price',
+			$ticket_price,
+			$this->ticket
+		);
+		return array($ticket_price, $ticket_bundle);
+	}
+
+
+
+
+	/**
+	 * ticketNameTableCell
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function ticketNameTableCell()
+	{
+		$html = \EEH_HTML::td('', '', 'tckt-slctr-tbl-td-name');
+		$html .= \EEH_HTML::strong($this->ticket->get_pretty('TKT_name'));
+		$html .= $this->ticket_details->getShowHideLinks();
+		if ($this->ticket->required()) {
+			$html .= \EEH_HTML::p(
+					apply_filters(
+							'FHEE__ticket_selector_chart_template__ticket_required_message',
+							esc_html__('This ticket is required and must be purchased.', 'event_espresso')
+					),
+					'', 'ticket-required-pg'
+			);
+		}
+		$html .= \EEH_HTML::tdx();
+		return $html;
+	}
+
+
+
+	/**
+	 * ticketPriceTableCell
+	 *
+	 * @param float $ticket_price
+	 * @param bool  $ticket_bundle
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function ticketPriceTableCell($ticket_price, $ticket_bundle)
+	{
+		$html = '';
+		if (apply_filters('FHEE__ticket_selector_chart_template__display_ticket_price_details', true)) {
+			$html .= \EEH_HTML::td('', '', 'tckt-slctr-tbl-td-price jst-rght');
+			$html .= \EEH_Template::format_currency($ticket_price);
+			$html .= $this->ticket->taxable()
+				? \EEH_HTML::span( '*', '', 'taxable-tickets-asterisk grey-text' )
+				: '';
+			$html .= '&nbsp;';
+			$html .= \EEH_HTML::span(
+				$ticket_bundle
+					? apply_filters(
+						'FHEE__ticket_selector_chart_template__per_ticket_bundle_text',
+						__(' / bundle', 'event_espresso')
+					)
+					: apply_filters(
+						'FHEE__ticket_selector_chart_template__per_ticket_text',
+						__('', 'event_espresso')
+					),
+				'', 'smaller-text no-bold'
+			);
+			$html .= '&nbsp;';
+			$html .= \EEH_HTML::tdx();
+			$this->cols++;
+		}
+		return $html;
+	}
+
+
+
+	/**
+	 * onlyOneAttendeeCanRegister
+	 *
+	 * @return string
+	 */
+	protected function onlyOneAttendeeCanRegister()
+	{
+		// display submit button since we have tickets available
+		add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
+		$this->hidden_input_qty = false;
+		$html = '<input type="radio" name="tkt-slctr-qty-' . $this->EVT_ID . '"';
+		$html .= ' id="ticket-selector-tbl-qty-slct-' . $this->EVT_ID . '-' . $this->row . '"';
+		$html .= ' class="ticket-selector-tbl-qty-slct" value="' . $this->row . '-1"';
+		$html .= $this->total_tickets === 1 ? ' checked="checked"' : '';
+		$html .= ' title=""/>';
+		return $html;
+	}
+
+
+
+	/**
+	 * ticketQuantitySelector
+	 *
+	 * @param int $min
+	 * @param int $max
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function ticketQuantitySelector($min = 0, $max = 0)
+	{
+		// display submit button since we have tickets available
+		add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
+		$this->hidden_input_qty = false;
+		$html = '<select name="tkt-slctr-qty-' . $this->EVT_ID . '[]"';
+		$html .= ' id="ticket-selector-tbl-qty-slct-' . $this->EVT_ID . '-' . $this->row . '"';
+		$html .= ' class="ticket-selector-tbl-qty-slct">';
+		// this ensures that non-required tickets with non-zero MIN QTYs don't HAVE to be purchased
+		if ($min !== 0 && ! $this->ticket->required()) {
+			$html .= '<option value="0">&nbsp;0&nbsp;</option>';
+		}
+		// offer ticket quantities from the min to the max
+		for ($i = $min; $i <= $max; $i++) {
+			$html .= '<option value="' . $i . '">&nbsp;' . $i . '&nbsp;</option>';
+		}
+		$html .= '</select>';
+		return $html;
+	}
+
+
+
+	/**
+	 * getHiddenInputs
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function ticketQtyAndIdHiddenInputs()
+	{
+		$html = '';
+		// depending on group reg we need to change the format for qty
+		if ($this->hidden_input_qty) {
+			$html .= '<input type="hidden" name="tkt-slctr-qty-' . $this->EVT_ID . '[]" value="0"/>';
+		}
+		$html .= '<input type="hidden" name="tkt-slctr-ticket-id-' . $this->EVT_ID . '[]"';
+		$html .= ' value="' . $this->ticket->ID() . '"/>';
+		return $html;
+	}
 
 }
 // End of file TicketSelectorRowStandard.php

core/libraries/rest_api/controllers/rpc/Checkin.php

Indentation +110 added lines, -110 removed lines

@@ -14,7 +14,7 @@ 
 use EventEspresso\core\libraries\rest_api\controllers\model\Read;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -31,116 +31,116 @@ 
 class Checkin extends Base
 {
 
-    /**
-     * @param WP_REST_Request $request
-     * @return WP_Error|WP_REST_Response
-     */
-    public static function handle_request_toggle_checkin(WP_REST_Request $request)
-    {
-        $controller = new Checkin();
-        return $controller->_create_checkin_checkout_object($request);
-    }
+	/**
+	 * @param WP_REST_Request $request
+	 * @return WP_Error|WP_REST_Response
+	 */
+	public static function handle_request_toggle_checkin(WP_REST_Request $request)
+	{
+		$controller = new Checkin();
+		return $controller->_create_checkin_checkout_object($request);
+	}
 
 
 
-    /**
-     * Toggles whether the user is checked in or not.
-     *
-     * @param WP_REST_Request $request
-     * @return WP_Error|WP_REST_Response
-     */
-    protected function _create_checkin_checkout_object(WP_REST_Request $request)
-    {
-        $reg_id = $request->get_param('REG_ID');
-        $dtt_id = $request->get_param('DTT_ID');
-        $force = $request->get_param('force');
-        if ($force == 'true') {
-            $force = true;
-        } else {
-            $force = false;
-        }
-        $reg = EEM_Registration::instance()->get_one_by_ID($reg_id);
-        if (! $reg instanceof EE_Registration) {
-            return $this->send_response(
-                new WP_Error(
-                    'rest_registration_toggle_checkin_invalid_id',
-                    sprintf(
-                        __('You cannot checkin registration with ID %1$s because it doesn\'t exist.',
-                            'event_espresso'),
-                        $reg_id
-                    ),
-                    array('status' => 422)
-                )
-            );
-        }
-        if (! EE_Capabilities::instance()
-                             ->current_user_can('ee_edit_checkin', 'rest_api_checkin_endpoint', $reg_id)
-        ) {
-            return $this->send_response(
-                new WP_Error(
-                    'rest_user_cannot_toggle_checkin',
-                    sprintf(
-                        __('You are not allowed to checkin registration with ID %1$s.', 'event_espresso'),
-                        $reg_id
-                    ),
-                    array('status' => 403)
-                )
-            );
-        }
-        $success = $reg->toggle_checkin_status($dtt_id, ! $force);
-        if ($success === false) {
-            //check if we know they can't check in because they're not approved and we aren't forcing
-            if (! $reg->is_approved() && ! $force) {
-                //rely on EE_Error::add_error messages to have been added to give more data about why it failed
-                return $this->send_response(
-                    new WP_Error(
-                        'rest_toggle_checkin_failed',
-                        __('Registration check-in failed because the registration is not approved. You may attempt to force checking in though.',
-                            'event_espresso')
-                    )
-                );
-            }
-            return $this->send_response(
-                new WP_Error(
-                    'rest_toggle_checkin_failed_not_forceable',
-                    __('Registration checkin failed. Please see additional error data.', 'event_espresso')
-                )
-            );
-        }
-        $checkin = EEM_Checkin::instance()->get_one(
-            array(
-                array(
-                    'REG_ID' => $reg_id,
-                    'DTT_ID' => $dtt_id,
-                ),
-                'order_by' => array(
-                    'CHK_timestamp' => 'DESC',
-                ),
-            )
-        );
-        if (! $checkin instanceof EE_Checkin) {
-            return $this->send_response(
-                new WP_Error(
-                    'rest_toggle_checkin_error',
-                    sprintf(
-                        __('Supposedly we created a new checkin object for registration %1$s at datetime %2$s, but we can\'t find it.',
-                            'event_espresso'),
-                        $reg_id,
-                        $dtt_id
-                    )
-                )
-            );
-        }
-        $requested_version = $this->get_requested_version($request->get_route());
-        $get_request = new WP_REST_Request(
-            'GET',
-            EED_Core_Rest_Api::ee_api_namespace . $requested_version . '/checkins/' . $checkin->ID()
-        );
-        $get_request->set_url_params(
-            array(
-                'id' => $checkin->ID(),
-            )
-        );
-        return Read::handle_request_get_one($get_request);
-    }
+	/**
+	 * Toggles whether the user is checked in or not.
+	 *
+	 * @param WP_REST_Request $request
+	 * @return WP_Error|WP_REST_Response
+	 */
+	protected function _create_checkin_checkout_object(WP_REST_Request $request)
+	{
+		$reg_id = $request->get_param('REG_ID');
+		$dtt_id = $request->get_param('DTT_ID');
+		$force = $request->get_param('force');
+		if ($force == 'true') {
+			$force = true;
+		} else {
+			$force = false;
+		}
+		$reg = EEM_Registration::instance()->get_one_by_ID($reg_id);
+		if (! $reg instanceof EE_Registration) {
+			return $this->send_response(
+				new WP_Error(
+					'rest_registration_toggle_checkin_invalid_id',
+					sprintf(
+						__('You cannot checkin registration with ID %1$s because it doesn\'t exist.',
+							'event_espresso'),
+						$reg_id
+					),
+					array('status' => 422)
+				)
+			);
+		}
+		if (! EE_Capabilities::instance()
+							 ->current_user_can('ee_edit_checkin', 'rest_api_checkin_endpoint', $reg_id)
+		) {
+			return $this->send_response(
+				new WP_Error(
+					'rest_user_cannot_toggle_checkin',
+					sprintf(
+						__('You are not allowed to checkin registration with ID %1$s.', 'event_espresso'),
+						$reg_id
+					),
+					array('status' => 403)
+				)
+			);
+		}
+		$success = $reg->toggle_checkin_status($dtt_id, ! $force);
+		if ($success === false) {
+			//check if we know they can't check in because they're not approved and we aren't forcing
+			if (! $reg->is_approved() && ! $force) {
+				//rely on EE_Error::add_error messages to have been added to give more data about why it failed
+				return $this->send_response(
+					new WP_Error(
+						'rest_toggle_checkin_failed',
+						__('Registration check-in failed because the registration is not approved. You may attempt to force checking in though.',
+							'event_espresso')
+					)
+				);
+			}
+			return $this->send_response(
+				new WP_Error(
+					'rest_toggle_checkin_failed_not_forceable',
+					__('Registration checkin failed. Please see additional error data.', 'event_espresso')
+				)
+			);
+		}
+		$checkin = EEM_Checkin::instance()->get_one(
+			array(
+				array(
+					'REG_ID' => $reg_id,
+					'DTT_ID' => $dtt_id,
+				),
+				'order_by' => array(
+					'CHK_timestamp' => 'DESC',
+				),
+			)
+		);
+		if (! $checkin instanceof EE_Checkin) {
+			return $this->send_response(
+				new WP_Error(
+					'rest_toggle_checkin_error',
+					sprintf(
+						__('Supposedly we created a new checkin object for registration %1$s at datetime %2$s, but we can\'t find it.',
+							'event_espresso'),
+						$reg_id,
+						$dtt_id
+					)
+				)
+			);
+		}
+		$requested_version = $this->get_requested_version($request->get_route());
+		$get_request = new WP_REST_Request(
+			'GET',
+			EED_Core_Rest_Api::ee_api_namespace . $requested_version . '/checkins/' . $checkin->ID()
+		);
+		$get_request->set_url_params(
+			array(
+				'id' => $checkin->ID(),
+			)
+		);
+		return Read::handle_request_get_one($get_request);
+	}
 }
\ No newline at end of file

Spacing +6 added lines, -6 removed lines

@@ -13,7 +13,7 @@ 
 use EventEspresso\core\libraries\rest_api\controllers\Base as Base;
 use EventEspresso\core\libraries\rest_api\controllers\model\Read;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -60,7 +60,7 @@ 
             $force = false;
         }
         $reg = EEM_Registration::instance()->get_one_by_ID($reg_id);
-        if (! $reg instanceof EE_Registration) {
+        if ( ! $reg instanceof EE_Registration) {
             return $this->send_response(
                 new WP_Error(
                     'rest_registration_toggle_checkin_invalid_id',
@@ -73,7 +73,7 @@ 
                 )
             );
         }
-        if (! EE_Capabilities::instance()
+        if ( ! EE_Capabilities::instance()
                              ->current_user_can('ee_edit_checkin', 'rest_api_checkin_endpoint', $reg_id)
         ) {
             return $this->send_response(
@@ -90,7 +90,7 @@ 
         $success = $reg->toggle_checkin_status($dtt_id, ! $force);
         if ($success === false) {
             //check if we know they can't check in because they're not approved and we aren't forcing
-            if (! $reg->is_approved() && ! $force) {
+            if ( ! $reg->is_approved() && ! $force) {
                 //rely on EE_Error::add_error messages to have been added to give more data about why it failed
                 return $this->send_response(
                     new WP_Error(
@@ -118,7 +118,7 @@ 
                 ),
             )
         );
-        if (! $checkin instanceof EE_Checkin) {
+        if ( ! $checkin instanceof EE_Checkin) {
             return $this->send_response(
                 new WP_Error(
                     'rest_toggle_checkin_error',
@@ -134,7 +134,7 @@ 
         $requested_version = $this->get_requested_version($request->get_route());
         $get_request = new WP_REST_Request(
             'GET',
-            EED_Core_Rest_Api::ee_api_namespace . $requested_version . '/checkins/' . $checkin->ID()
+            EED_Core_Rest_Api::ee_api_namespace.$requested_version.'/checkins/'.$checkin->ID()
         );
         $get_request->set_url_params(
             array(

core/libraries/shortcodes/EE_Transaction_Shortcodes.lib.php

Indentation +608 added lines, -608 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 
@@ -28,616 +28,616 @@ 
 class EE_Transaction_Shortcodes extends EE_Shortcodes
 {
 
-    /**
-     * @var EE_Payment_Method $_invoice_pm the invoiec payment method for use in invoices etc
-     */
-    protected $_invoice_pm;
-
-
-
-    /**
-     * EE_Transaction_Shortcodes constructor.
-     */
-    public function __construct()
-    {
-        parent::__construct();
-    }
-
-
-
-    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[INVOICE_RECEIPT_SWITCHER_URL]%2$s except this returns the html for a button linked to the invoice or receipt.',
-                'event_espresso'), '<code>', '</code>'),
-        );
-    }
-
-
-
-    /**
-     * @access protected
-     * @param  string $shortcode the shortcode to be parsed.
-     * @return string parsed shortcode
-     */
-    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;
-        }
-        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.
-     */
-    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
-     */
-    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
-     */
-    private function _get_invoice_logo($img_tags = false)
-    {
-        //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);
-        } else {
-            $invoice_logo_url = null;
-        }
-        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="' . $invoice_logo_url . '" width="' . $image_width . '" alt="logo" />';
-    }
-
-
-
-    /**
-     * Used to retrieve the appropriate content for the invoice payee name shortcode
-     *
-     * @since 4.5.0
-     * @return string
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    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
-     */
-    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 invoiec payment method for use in invoices etc
+	 */
+	protected $_invoice_pm;
+
+
+
+	/**
+	 * EE_Transaction_Shortcodes constructor.
+	 */
+	public function __construct()
+	{
+		parent::__construct();
+	}
+
+
+
+	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[INVOICE_RECEIPT_SWITCHER_URL]%2$s except this returns the html for a button linked to the invoice or receipt.',
+				'event_espresso'), '<code>', '</code>'),
+		);
+	}
+
+
+
+	/**
+	 * @access protected
+	 * @param  string $shortcode the shortcode to be parsed.
+	 * @return string parsed shortcode
+	 */
+	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;
+		}
+		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.
+	 */
+	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
+	 */
+	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
+	 */
+	private function _get_invoice_logo($img_tags = false)
+	{
+		//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);
+		} else {
+			$invoice_logo_url = null;
+		}
+		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="' . $invoice_logo_url . '" width="' . $image_width . '" alt="logo" />';
+	}
+
+
+
+	/**
+	 * Used to retrieve the appropriate content for the invoice payee name shortcode
+	 *
+	 * @since 4.5.0
+	 * @return string
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	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
+	 */
+	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
-     */
-    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.
-     */
-    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
-     */
-    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 = 'Unable to calculate date due, likely the format string is invalid.';
-        }
-        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
+	 */
+	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.
+	 */
+	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
+	 */
+	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 = 'Unable to calculate date due, likely the format string is invalid.';
+		}
+		return $prefix_text . $date_due;
+	}
 
 } //end EE_Transaction Shortcodes library

Spacing +27 added lines, -27 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
 }
 
@@ -173,7 +173,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) {
@@ -189,7 +189,7 @@ 
                 $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>');
+                    '<a href="'.$invoice_url.'">', '</a>');
                 break; /**/
             case '[INVOICE_URL]' :
                 $invoice_url = $transaction->invoice_url();
@@ -260,7 +260,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',
@@ -272,7 +272,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();
@@ -337,7 +337,7 @@ 
      */
     private function _get_payment_gateway($transaction)
     {
-        if($transaction instanceof EE_Transaction){
+        if ($transaction instanceof EE_Transaction) {
             $pm = $transaction->payment_method();
         } else {
             $pm = null;
@@ -370,7 +370,7 @@ 
         if (empty($invoice_logo_url)) {
             return '';
         }
-        if (! $img_tags) {
+        if ( ! $img_tags) {
             return $invoice_logo_url;
         }
         //image tags have been requested.
@@ -381,7 +381,7 @@ 
         } else {
             $image_width = $image_size[0];
         }
-        return '<img class="logo screen" src="' . $invoice_logo_url . '" width="' . $image_width . '" alt="logo" />';
+        return '<img class="logo screen" src="'.$invoice_logo_url.'" width="'.$image_width.'" alt="logo" />';
     }
 
 
@@ -412,7 +412,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)
@@ -471,7 +471,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;
     }
 
 
@@ -491,14 +491,14 @@ 
         }
         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>';
+            $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->CNT_ISO) ? ', '.$organization->CNT_ISO.'<br>' : '';
             $payee_address .= ! empty($organization->zip) ? $organization->zip : '';
         }
         return $payee_address;
@@ -531,7 +531,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;
@@ -539,13 +539,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>
 			';
         }
@@ -563,7 +563,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();
@@ -590,11 +590,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, $addressee, $valid_shortcodes,
                 $this->_message_type, $this->_messenger, $this->_message);
@@ -622,14 +622,14 @@ 
         }
         $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;
+        $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);
+                $date_due = $transaction_created->add(new DateInterval('P'.$days_until_due.'D'))->format($format);
             } else {
                 throw new Exception();
             }
@@ -637,7 +637,7 @@ 
             //format was likely invalid.
             $date_due = 'Unable to calculate date due, likely the format string is invalid.';
         }
-        return $prefix_text . $date_due;
+        return $prefix_text.$date_due;
     }
 
 } //end EE_Transaction Shortcodes library

core/db_models/EEM_Payment_Method.model.php

Spacing +91 added lines, -91 removed lines

@@ -1,5 +1,5 @@ 
-<?php if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 /**
  *
@@ -37,33 +37,33 @@ 
 	 * @access   protected
 	 * @return EEM_Payment_Method
 	 */
-	protected function __construct( $timezone = NULL ) {
-		$this->singlular_item = __( 'Payment Method', 'event_espresso' );
-		$this->plural_item = __( 'Payment Methods', 'event_espresso' );
-		$this->_tables = array( 'Payment_Method' => new EE_Primary_Table( 'esp_payment_method', 'PMD_ID' ) );
+	protected function __construct($timezone = NULL) {
+		$this->singlular_item = __('Payment Method', 'event_espresso');
+		$this->plural_item = __('Payment Methods', 'event_espresso');
+		$this->_tables = array('Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID'));
 		$this->_fields = array(
 			'Payment_Method' => array(
-				'PMD_ID' => new EE_Primary_Key_Int_Field( 'PMD_ID', __( "ID", 'event_espresso' ) ),
-				'PMD_type' => new EE_Plain_Text_Field( 'PMD_type', __( "Payment Method Type", 'event_espresso' ), FALSE, 'Admin_Only' ),
-				'PMD_name' => new EE_Plain_Text_Field( 'PMD_name', __( "Name", 'event_espresso' ), FALSE ),
-				'PMD_desc' => new EE_Post_Content_Field( 'PMD_desc', __( "Description", 'event_espresso' ), FALSE, '' ),
-				'PMD_admin_name' => new EE_Plain_Text_Field( 'PMD_admin_name', __( "Admin-Only Name", 'event_espresso' ), TRUE ),
-				'PMD_admin_desc' => new EE_Post_Content_Field( 'PMD_admin_desc', __( "Admin-Only Description", 'event_espresso' ), TRUE ),
-				'PMD_slug' => new EE_Slug_Field( 'PMD_slug', __( "Slug", 'event_espresso' ), FALSE ),
-				'PMD_order' => new EE_Integer_Field( 'PMD_order', __( "Order", 'event_espresso' ), FALSE, 0 ),
-				'PMD_debug_mode' => new EE_Boolean_Field( 'PMD_debug_mode', __( "Debug Mode On?", 'event_espresso' ), FALSE, FALSE ),
-				'PMD_wp_user' => new EE_WP_User_Field( 'PMD_wp_user', __( "Payment Method Creator ID", 'event_espresso' ), FALSE ),
-				'PMD_open_by_default' => new EE_Boolean_Field( 'PMD_open_by_default', __( "Open by Default?", 'event_espresso' ), FALSE, FALSE ), 'PMD_button_url' => new EE_Plain_Text_Field( 'PMD_button_url', __( "Button URL", 'event_espresso' ), TRUE, '' ),
-				'PMD_scope' => new EE_Serialized_Text_Field( 'PMD_scope', __( "Usable From?", 'event_espresso' ), FALSE, array() ), //possible values currently are 'CART','ADMIN','API'
+				'PMD_ID' => new EE_Primary_Key_Int_Field('PMD_ID', __("ID", 'event_espresso')),
+				'PMD_type' => new EE_Plain_Text_Field('PMD_type', __("Payment Method Type", 'event_espresso'), FALSE, 'Admin_Only'),
+				'PMD_name' => new EE_Plain_Text_Field('PMD_name', __("Name", 'event_espresso'), FALSE),
+				'PMD_desc' => new EE_Post_Content_Field('PMD_desc', __("Description", 'event_espresso'), FALSE, ''),
+				'PMD_admin_name' => new EE_Plain_Text_Field('PMD_admin_name', __("Admin-Only Name", 'event_espresso'), TRUE),
+				'PMD_admin_desc' => new EE_Post_Content_Field('PMD_admin_desc', __("Admin-Only Description", 'event_espresso'), TRUE),
+				'PMD_slug' => new EE_Slug_Field('PMD_slug', __("Slug", 'event_espresso'), FALSE),
+				'PMD_order' => new EE_Integer_Field('PMD_order', __("Order", 'event_espresso'), FALSE, 0),
+				'PMD_debug_mode' => new EE_Boolean_Field('PMD_debug_mode', __("Debug Mode On?", 'event_espresso'), FALSE, FALSE),
+				'PMD_wp_user' => new EE_WP_User_Field('PMD_wp_user', __("Payment Method Creator ID", 'event_espresso'), FALSE),
+				'PMD_open_by_default' => new EE_Boolean_Field('PMD_open_by_default', __("Open by Default?", 'event_espresso'), FALSE, FALSE), 'PMD_button_url' => new EE_Plain_Text_Field('PMD_button_url', __("Button URL", 'event_espresso'), TRUE, ''),
+				'PMD_scope' => new EE_Serialized_Text_Field('PMD_scope', __("Usable From?", 'event_espresso'), FALSE, array()), //possible values currently are 'CART','ADMIN','API'
 		) );
 		$this->_model_relations = array(
  //			'Event'=>new EE_HABTM_Relation('Event_Payment_Method'),
 			'Payment' => new EE_Has_Many_Relation(),
-			'Currency' => new EE_HABTM_Relation( 'Currency_Payment_Method' ),
+			'Currency' => new EE_HABTM_Relation('Currency_Payment_Method'),
 			'Transaction' => new EE_Has_Many_Relation(),
 			'WP_User' => new EE_Belongs_To_Relation(),
 		);
-		parent::__construct( $timezone );
+		parent::__construct($timezone);
 	}
 
 
@@ -73,8 +73,8 @@ 
 	 * @param string $slug
 	 * @return EE_Payment_Method
 	 */
-	public function get_one_by_slug( $slug ) {
-		return $this->get_one( array( array( 'PMD_slug' => $slug ) ) );
+	public function get_one_by_slug($slug) {
+		return $this->get_one(array(array('PMD_slug' => $slug)));
 	}
 
 
@@ -88,8 +88,8 @@ 
 		return apply_filters(
 			'FHEE__EEM_Payment_Method__scopes',
 			array(
-				self::scope_cart 		=> __( "Front-end Registration Page", 'event_espresso' ),
-				self::scope_admin 	=> __( "Admin Registration Page (no online processing)", 'event_espresso' )
+				self::scope_cart 		=> __("Front-end Registration Page", 'event_espresso'),
+				self::scope_admin 	=> __("Admin Registration Page (no online processing)", 'event_espresso')
 			)
 		);
 	}
@@ -101,9 +101,9 @@ 
 	 * @param string $scope like one of EEM_Payment_Method::instance()->scopes()
 	 * @return boolean
 	 */
-	public function is_valid_scope( $scope ) {
+	public function is_valid_scope($scope) {
 		$scopes = $this->scopes();
-		if ( isset( $scopes[ $scope ] ) ) {
+		if (isset($scopes[$scope])) {
 			return TRUE;
 		} else {
 			return FALSE;
@@ -119,11 +119,11 @@ 
 	 * @throws EE_Error
 	 * @return EE_Payment_Method[]
 	 */
-	public function get_all_active( $scope = NULL, $query_params = array() ) {
-		if( ! isset( $query_params[ 'order_by' ] ) && ! isset( $query_params[ 'order' ] ) ) {
-			$query_params['order_by'] = array( 'PMD_order' => 'ASC', 'PMD_ID' => 'ASC' );
+	public function get_all_active($scope = NULL, $query_params = array()) {
+		if ( ! isset($query_params['order_by']) && ! isset($query_params['order'])) {
+			$query_params['order_by'] = array('PMD_order' => 'ASC', 'PMD_ID' => 'ASC');
 		}
-		return $this->get_all( $this->_get_query_params_for_all_active( $scope, $query_params ) );
+		return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
 	}
 
 	/**
@@ -132,8 +132,8 @@ 
 	 * @param array $query_params
 	 * @return int
 	 */
-	public function count_active( $scope = NULL, $query_params = array() ){
-		return $this->count( $this->_get_query_params_for_all_active( $scope, $query_params ) );
+	public function count_active($scope = NULL, $query_params = array()) {
+		return $this->count($this->_get_query_params_for_all_active($scope, $query_params));
 	}
 
 	/**
@@ -144,21 +144,21 @@ 
 	 * @return array like param of EEM_Base::get_all()
 	 * @throws EE_Error
 	 */
-	protected function _get_query_params_for_all_active( $scope = NULL, $query_params = array() ){
-		if ( $scope ) {
-			if ( $this->is_valid_scope( $scope ) ) {
-				return array_replace_recursive( array( array( 'PMD_scope' => array( 'LIKE', "%$scope%" ) ) ), $query_params );
+	protected function _get_query_params_for_all_active($scope = NULL, $query_params = array()) {
+		if ($scope) {
+			if ($this->is_valid_scope($scope)) {
+				return array_replace_recursive(array(array('PMD_scope' => array('LIKE', "%$scope%"))), $query_params);
 			} else {
-				throw new EE_Error( sprintf( __( "'%s' is not a valid scope for a payment method", "event_espresso" ), $scope ) );
+				throw new EE_Error(sprintf(__("'%s' is not a valid scope for a payment method", "event_espresso"), $scope));
 			}
 		} else {
 			$acceptable_scopes = array();
 			$count = 0;
-			foreach ( $this->scopes() as $scope_name => $desc ) {
+			foreach ($this->scopes() as $scope_name => $desc) {
 				$count++;
-				$acceptable_scopes[ 'PMD_scope*' . $count ] = array( 'LIKE', '%' . $scope_name . '%' );
+				$acceptable_scopes['PMD_scope*'.$count] = array('LIKE', '%'.$scope_name.'%');
 			}
-			return array_replace_recursive( array( array( 'OR*active_scope' => $acceptable_scopes ) ), $query_params );
+			return array_replace_recursive(array(array('OR*active_scope' => $acceptable_scopes)), $query_params);
 		}
 	}
 
@@ -170,8 +170,8 @@ 
 	 * @return array like param of EEM_Base::get_all()
 	 * @throws EE_Error
 	 */
-	public function get_query_params_for_all_active( $scope = NULL, $query_params = array() ) {
-		return $this->_get_query_params_for_all_active( $scope, $query_params );
+	public function get_query_params_for_all_active($scope = NULL, $query_params = array()) {
+		return $this->_get_query_params_for_all_active($scope, $query_params);
 	}
 
 
@@ -181,8 +181,8 @@ 
 	 * @param array  $query_params
 	 * @return EE_Payment_Method
 	 */
-	public function get_one_active( $scope = NULL, $query_params = array() ) {
-		return $this->get_one( $this->_get_query_params_for_all_active( $scope, $query_params ) );
+	public function get_one_active($scope = NULL, $query_params = array()) {
+		return $this->get_one($this->_get_query_params_for_all_active($scope, $query_params));
 	}
 
 
@@ -192,8 +192,8 @@ 
 	 * @param string $type
 	 * @return EE_Payment_Method
 	 */
-	public function get_one_of_type( $type ) {
-		return $this->get_one( array( array( 'PMD_type' => $type ) ) );
+	public function get_one_of_type($type) {
+		return $this->get_one(array(array('PMD_type' => $type)));
 	}
 
 
@@ -206,22 +206,22 @@ 
 	 * @return EE_Payment_Method
 	 * @throws EE_Error
 	 */
-	public function ensure_is_obj( $base_class_obj_or_id, $ensure_is_in_db = FALSE ) {
+	public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = FALSE) {
 		//first: check if it's a slug
-		if( is_string( $base_class_obj_or_id ) ) {
-			$obj = $this->get_one_by_slug( $base_class_obj_or_id );
-			if( $obj ) {
+		if (is_string($base_class_obj_or_id)) {
+			$obj = $this->get_one_by_slug($base_class_obj_or_id);
+			if ($obj) {
 				return $obj;
 			}
 		}
 		//ok so it wasn't a slug we were passed. try the usual then (ie, it's an object or an ID)
 		try {
-			return parent::ensure_is_obj( $base_class_obj_or_id, $ensure_is_in_db );
+			return parent::ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db);
 		}
-		catch ( EE_Error $e ) {
+		catch (EE_Error $e) {
 			//handle it outside the catch
 		}
-		throw new EE_Error( sprintf( __( "'%s' is neither a Payment Method ID, slug, nor object.", "event_espresso" ), $base_class_obj_or_id ) );
+		throw new EE_Error(sprintf(__("'%s' is neither a Payment Method ID, slug, nor object.", "event_espresso"), $base_class_obj_or_id));
 	}
 
 
@@ -232,12 +232,12 @@ 
 	 * @param mixed $base_obj_or_id_or_slug
 	 * @return int
 	 */
-	function ensure_is_ID( $base_obj_or_id_or_slug ) {
-		if ( is_string( $base_obj_or_id_or_slug ) ) {
+	function ensure_is_ID($base_obj_or_id_or_slug) {
+		if (is_string($base_obj_or_id_or_slug)) {
 			//assume it's a slug
-			$base_obj_or_id_or_slug = $this->get_one_by_slug( $base_obj_or_id_or_slug );
+			$base_obj_or_id_or_slug = $this->get_one_by_slug($base_obj_or_id_or_slug);
 		}
-		return parent::ensure_is_ID( $base_obj_or_id_or_slug );
+		return parent::ensure_is_ID($base_obj_or_id_or_slug);
 	}
 
 
@@ -246,36 +246,36 @@ 
 	 * Verifies the button urls on all the passed payment methods have a valid button url. If not, resets them to their default.
 	 * @param EE_Payment_Method[] $payment_methods. If NULL is provided defaults to all payment methods active in the cart
 	 */
-	function verify_button_urls( $payment_methods = NULL ) {
-		$payment_methods = is_array( $payment_methods ) ? $payment_methods : $this->get_all_active(EEM_Payment_Method::scope_cart);
-		foreach ( $payment_methods as $payment_method ) {
+	function verify_button_urls($payment_methods = NULL) {
+		$payment_methods = is_array($payment_methods) ? $payment_methods : $this->get_all_active(EEM_Payment_Method::scope_cart);
+		foreach ($payment_methods as $payment_method) {
 			try {
 				$current_button_url = $payment_method->button_url();
-				$buttons_urls_to_try = apply_filters( 'FHEE__EEM_Payment_Method__verify_button_urls__button_urls_to_try', array(
-					'current_ssl' => str_replace( "http://", "https://", $current_button_url ),
-					'current' => str_replace( "https://", "http://", $current_button_url ),
-					'default_ssl' => str_replace( "http://", "https://", $payment_method->type_obj()->default_button_url() ),
-					'default' => str_replace( "https://", "http://", $payment_method->type_obj()->default_button_url() ),
-				) );
-				foreach( $buttons_urls_to_try as $button_url_to_try ) {
-					if(
+				$buttons_urls_to_try = apply_filters('FHEE__EEM_Payment_Method__verify_button_urls__button_urls_to_try', array(
+					'current_ssl' => str_replace("http://", "https://", $current_button_url),
+					'current' => str_replace("https://", "http://", $current_button_url),
+					'default_ssl' => str_replace("http://", "https://", $payment_method->type_obj()->default_button_url()),
+					'default' => str_replace("https://", "http://", $payment_method->type_obj()->default_button_url()),
+				));
+				foreach ($buttons_urls_to_try as $button_url_to_try) {
+					if (
 							(//this is the current url and it exists, regardless of SSL issues
 								$button_url_to_try == $current_button_url &&
 								EEH_URL::remote_file_exists(
 										$button_url_to_try,
 										array(
 											'sslverify' => false,
-											'limit_response_size' => 4095,//we don't really care for a full response, but we do want headers at least. Lets just ask for a one block
+											'limit_response_size' => 4095, //we don't really care for a full response, but we do want headers at least. Lets just ask for a one block
 											) )
 							)
 							||
 							(//this is NOT the current url and it exists with a working SSL cert
 								$button_url_to_try != $current_button_url &&
-								EEH_URL::remote_file_exists( $button_url_to_try )
+								EEH_URL::remote_file_exists($button_url_to_try)
 							) ) {
-						if( $current_button_url != $button_url_to_try ){
-							$payment_method->save( array( 'PMD_button_url' => $button_url_to_try ) );
-							EE_Error::add_attention( sprintf( __( "Payment Method %s's button url was set to %s, because the old image either didnt exist or SSL was recently enabled.", "event_espresso" ), $payment_method->name(), $button_url_to_try ) );
+						if ($current_button_url != $button_url_to_try) {
+							$payment_method->save(array('PMD_button_url' => $button_url_to_try));
+							EE_Error::add_attention(sprintf(__("Payment Method %s's button url was set to %s, because the old image either didnt exist or SSL was recently enabled.", "event_espresso"), $payment_method->name(), $button_url_to_try));
 						}
 						//this image exists. So if wasn't set before, now it is;
 						//or if it was already set, we have nothing to do
@@ -283,8 +283,8 @@ 
 					}
 				}
 			}
-			catch ( EE_Error $e ) {
-				$payment_method->set_active( FALSE );
+			catch (EE_Error $e) {
+				$payment_method->set_active(FALSE);
 			}
 		}
 	}
@@ -298,29 +298,29 @@ 
 	 * @param array $rows
 	 * @return EE_Payment_Method[]
 	 */
-	protected function _create_objects( $rows = array() ) {
-		EE_Registry::instance()->load_lib( 'Payment_Method_Manager' );
-		$payment_methods = parent::_create_objects( $rows );
+	protected function _create_objects($rows = array()) {
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
+		$payment_methods = parent::_create_objects($rows);
 		/* @var $payment_methods EE_Payment_Method[] */
 		$usable_payment_methods = array();
-		foreach ( $payment_methods as $key => $payment_method ) {
-			if ( EE_Payment_Method_Manager::instance()->payment_method_type_exists( $payment_method->type() ) ) {
-				$usable_payment_methods[ $key ] = $payment_method;
+		foreach ($payment_methods as $key => $payment_method) {
+			if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
+				$usable_payment_methods[$key] = $payment_method;
 				//some payment methods enqueue their scripts in EE_PMT_*::__construct
 				//which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
 				//its scripts). but for backwards-compat we should continue to do that
 				$payment_method->type_obj();
-			} elseif( $payment_method->active() ) {				
+			} elseif ($payment_method->active()) {				
 				//only deactivate and notify the admin if the payment is active somewhere
 				$payment_method->deactivate();
 				$payment_method->save();
 				EE_Error::add_persistent_admin_notice(
-					'auto-deactivated-' . $payment_method->type(),
+					'auto-deactivated-'.$payment_method->type(),
 					sprintf(
-						__( 'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.', 'event_espresso' ),
+						__('The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.', 'event_espresso'),
 						$payment_method->admin_name(),
 						'<br />',
-						'<a href="' . admin_url('plugins.php') . '">',
+						'<a href="'.admin_url('plugins.php').'">',
 						'</a>'
 					),
 					true
@@ -340,11 +340,11 @@ 
 	 * @param string 	$scope @see EEM_Payment_Method::get_all_for_events
 	 * @return EE_Payment_Method[]
 	 */
-	public function get_all_for_transaction( $transaction, $scope ) {
+	public function get_all_for_transaction($transaction, $scope) {
 		//give addons a chance to override what payment methods are chosen based on the transaction
 		return apply_filters(
 			'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
-			$this->get_all_active( $scope, array( 'group_by' => 'PMD_type' ) ),
+			$this->get_all_active($scope, array('group_by' => 'PMD_type')),
 			$transaction,
 			$scope
 		);
@@ -360,16 +360,16 @@ 
 	 * @param EE_Registration|int $registration_or_reg_id  Either the EE_Registration object or the id for the registration.
 	 * @return EE_Payment|null
 	 */
-	public function get_last_used_for_registration( $registration_or_reg_id ) {
-		$registration_id = EEM_Registration::instance()->ensure_is_ID( $registration_or_reg_id );
+	public function get_last_used_for_registration($registration_or_reg_id) {
+		$registration_id = EEM_Registration::instance()->ensure_is_ID($registration_or_reg_id);
 
 		$query_params = array(
 			0 => array(
 				'Payment.Registration.REG_ID' => $registration_id,
 			),
-			'order_by' => array( 'Payment.PAY_ID' => 'DESC' )
+			'order_by' => array('Payment.PAY_ID' => 'DESC')
 		);
-		return $this->get_one( $query_params );
+		return $this->get_one($query_params);
 	}
 
 }

core/business/EE_Transaction_Payments.class.php

Indentation +2 added lines, -2 removed lines

@@ -233,8 +233,8 @@
 					if ( $registration instanceof EE_Registration ) {
 						$registration->set_paid( $registration->paid() - $amount_paid );
 						if ($registration->save() !== false) {
-						    $registration_payment->delete_permanently();
-                            $save_payment = true;
+							$registration_payment->delete_permanently();
+							$save_payment = true;
 						}
 					} else {
 						EE_Error::add_error(

Spacing +43 added lines, -43 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
-EE_Registry::instance()->load_class( 'Processor_Base' );
+EE_Registry::instance()->load_class('Processor_Base');
 
 /**
  * Class EE_Transaction_Payments
@@ -42,7 +42,7 @@ 
 	 */
 	public static function instance() {
 		// check if class object is instantiated
-		if ( ! self::$_instance instanceof EE_Transaction_Payments ) {
+		if ( ! self::$_instance instanceof EE_Transaction_Payments) {
 			self::$_instance = new self();
 		}
 		return self::$_instance;
@@ -59,18 +59,18 @@ 
 	 * @return bool true if TXN total was updated, false if not
 	 * @throws \EE_Error
 	 */
-	public function recalculate_transaction_total( EE_Transaction $transaction, $update_txn = true ) {
+	public function recalculate_transaction_total(EE_Transaction $transaction, $update_txn = true) {
 		$total_line_item = $transaction->total_line_item();
-		if ( ! $total_line_item instanceof EE_Line_Item ) {
+		if ( ! $total_line_item instanceof EE_Line_Item) {
 			EE_Error::add_error(
-				sprintf( __( 'The Total Line Item for Transaction %1$d\'s was not found or is invalid.', 'event_espresso' ), $transaction->ID() ),
+				sprintf(__('The Total Line Item for Transaction %1$d\'s was not found or is invalid.', 'event_espresso'), $transaction->ID()),
 				__FILE__, __FUNCTION__, __LINE__
 			);
 			return false;
 		}
 		$new_total = $total_line_item->recalculate_total_including_taxes();
-		$transaction->set_total( $new_total );
-		if ( $update_txn ) {
+		$transaction->set_total($new_total);
+		if ($update_txn) {
 			return $transaction->save() ? true : false;
 		}
 		return false;
@@ -93,20 +93,20 @@ 
 	 * @return    boolean        whether the TXN was saved
 	 * @throws \EE_Error
 	 */
-	public function calculate_total_payments_and_update_status( EE_Transaction $transaction, $update_txn = true ){
+	public function calculate_total_payments_and_update_status(EE_Transaction $transaction, $update_txn = true) {
 		// verify transaction
-		if ( ! $transaction instanceof EE_Transaction ) {
-			EE_Error::add_error( __( 'Please provide a valid EE_Transaction object.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+		if ( ! $transaction instanceof EE_Transaction) {
+			EE_Error::add_error(__('Please provide a valid EE_Transaction object.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
 		// calculate total paid
-		$total_paid = $this->recalculate_total_payments_for_transaction( $transaction );
+		$total_paid = $this->recalculate_total_payments_for_transaction($transaction);
 		// if total paid has changed
-		if ( $total_paid !== false && (float)$total_paid !== $transaction->paid() ) {
-			$transaction->set_paid( $total_paid );
+		if ($total_paid !== false && (float) $total_paid !== $transaction->paid()) {
+			$transaction->set_paid($total_paid);
 			// maybe update status, and make sure to save transaction if not done already
-			if ( ! $transaction->update_status_based_on_total_paid( $update_txn ) ) {
-				if ( $update_txn ) {
+			if ( ! $transaction->update_status_based_on_total_paid($update_txn)) {
+				if ($update_txn) {
 					return $transaction->save() ? true : false;
 				}
 			} else {
@@ -130,18 +130,18 @@ 
 	 * @return float|false   float on success, false on fail
 	 * @throws \EE_Error
 	 */
-	public function recalculate_total_payments_for_transaction( EE_Transaction $transaction, $payment_status = EEM_Payment::status_id_approved ) {
+	public function recalculate_total_payments_for_transaction(EE_Transaction $transaction, $payment_status = EEM_Payment::status_id_approved) {
 		// verify transaction
-		if ( ! $transaction instanceof EE_Transaction ) {
-			EE_Error::add_error( __( 'Please provide a valid EE_Transaction object.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+		if ( ! $transaction instanceof EE_Transaction) {
+			EE_Error::add_error(__('Please provide a valid EE_Transaction object.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
 		// ensure Payment model is loaded
-		EE_Registry::instance()->load_model( 'Payment' );
+		EE_Registry::instance()->load_model('Payment');
 		// calls EEM_Base::sum()
 		return EEM_Payment::instance()->sum(
 			// query params
-			array( array( 'TXN_ID' => $transaction->ID(), 'STS_ID' => $payment_status )),
+			array(array('TXN_ID' => $transaction->ID(), 'STS_ID' => $payment_status)),
 			// field to sum
 			'PAY_amount'
 		);
@@ -159,17 +159,17 @@ 
 	 * @return boolean
 	 * @throws \EE_Error
 	 */
-	public function delete_payment_and_update_transaction( EE_Payment $payment ) {
+	public function delete_payment_and_update_transaction(EE_Payment $payment) {
 		// verify payment
-		if ( ! $payment instanceof EE_Payment ) {
-			EE_Error::add_error( __( 'A valid Payment object was not received.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+		if ( ! $payment instanceof EE_Payment) {
+			EE_Error::add_error(__('A valid Payment object was not received.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
-		if ( ! $this->delete_registration_payments_and_update_registrations( $payment ) ) {
+		if ( ! $this->delete_registration_payments_and_update_registrations($payment)) {
 			return false;
 		}
-		if ( ! $payment->delete() ) {
-			EE_Error::add_error( __( 'The payment could not be deleted.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+		if ( ! $payment->delete()) {
+			EE_Error::add_error(__('The payment could not be deleted.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
 
@@ -180,14 +180,14 @@ 
 			|| $TXN_status === EEM_Transaction::failed_status_code
 			|| $payment->amount() === 0
 		) {
-			EE_Error::add_success( __( 'The Payment was successfully deleted.', 'event_espresso' ) );
+			EE_Error::add_success(__('The Payment was successfully deleted.', 'event_espresso'));
 			return true;
 		}
 
 
 		//if this fails, that just means that the transaction didn't get its status changed and/or updated.
 		//however the payment was still deleted.
-		if ( ! $this->calculate_total_payments_and_update_status( $transaction ) ) {
+		if ( ! $this->calculate_total_payments_and_update_status($transaction)) {
 
 			EE_Error::add_attention(
 				__(
@@ -221,17 +221,17 @@ 
 	 * @return bool
 	 * @throws \EE_Error
 	 */
-	public function delete_registration_payments_and_update_registrations( EE_Payment $payment, $reg_payment_query_params = array() ) {
+	public function delete_registration_payments_and_update_registrations(EE_Payment $payment, $reg_payment_query_params = array()) {
 		$save_payment = false;
-		$reg_payment_query_params = ! empty( $reg_payment_query_params ) ? $reg_payment_query_params : array( array( 'PAY_ID' => $payment->ID() ) );
-		$registration_payments = EEM_Registration_Payment::instance()->get_all( $reg_payment_query_params );
-		if ( ! empty( $registration_payments )) {
-			foreach ( $registration_payments as $registration_payment ) {
-				if ( $registration_payment instanceof EE_Registration_Payment ) {
+		$reg_payment_query_params = ! empty($reg_payment_query_params) ? $reg_payment_query_params : array(array('PAY_ID' => $payment->ID()));
+		$registration_payments = EEM_Registration_Payment::instance()->get_all($reg_payment_query_params);
+		if ( ! empty($registration_payments)) {
+			foreach ($registration_payments as $registration_payment) {
+				if ($registration_payment instanceof EE_Registration_Payment) {
 					$amount_paid = $registration_payment->amount();
 					$registration = $registration_payment->registration();
-					if ( $registration instanceof EE_Registration ) {
-						$registration->set_paid( $registration->paid() - $amount_paid );
+					if ($registration instanceof EE_Registration) {
+						$registration->set_paid($registration->paid() - $amount_paid);
 						if ($registration->save() !== false) {
 						    $registration_payment->delete_permanently();
                             $save_payment = true;
@@ -239,7 +239,7 @@ 
 					} else {
 						EE_Error::add_error(
 							sprintf(
-								__( 'An invalid Registration object was associated with Registration Payment ID# %1$d.', 'event_espresso' ),
+								__('An invalid Registration object was associated with Registration Payment ID# %1$d.', 'event_espresso'),
 								$registration_payment->ID()
 							),
 							__FILE__, __FUNCTION__, __LINE__
@@ -249,7 +249,7 @@ 
 				} else {
 					EE_Error::add_error(
 						sprintf(
-							__( 'An invalid Registration Payment object was associated with payment ID# %1$d.', 'event_espresso' ),
+							__('An invalid Registration Payment object was associated with payment ID# %1$d.', 'event_espresso'),
 							$payment->ID()
 						),
 						__FILE__, __FUNCTION__, __LINE__
@@ -258,7 +258,7 @@ 
 				}
 			}
 		}
-		if ( $save_payment ) {
+		if ($save_payment) {
 			$payment->save();
 		}
 		return true;
@@ -282,7 +282,7 @@ 
 	public function update_transaction_status_based_on_total_paid(EE_Transaction $transaction, $update_txn = true)
 	{
 		EE_Error::doing_it_wrong(
-			__CLASS__ . '::' . __FUNCTION__,
+			__CLASS__.'::'.__FUNCTION__,
 			sprintf(__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
 				'EE_Transaction::update_status_based_on_total_paid()'),
 			'4.9.1',
@@ -324,7 +324,7 @@ 
 	 * @deprecated 4.9.12
 	 * @param string $old_txn_status
 	 */
-	public function set_old_txn_status( $old_txn_status ) {
+	public function set_old_txn_status($old_txn_status) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(
@@ -334,7 +334,7 @@ 
 			'4.9.12'
 		);
 		// only set the first time
-		if ( $this->_old_txn_status === null ) {
+		if ($this->_old_txn_status === null) {
 			$this->_old_txn_status = $old_txn_status;
 		}
 	}
@@ -363,7 +363,7 @@ 
 	 * @deprecated 4.9.12
 	 * @param string $new_txn_status
 	 */
-	public function set_new_txn_status( $new_txn_status ) {
+	public function set_new_txn_status($new_txn_status) {
 		EE_Error::doing_it_wrong(
 			__METHOD__,
 			esc_html__(

core/libraries/form_sections/strategies/filter/VsprintfFilter.php

Indentation +43 added lines, -43 removed lines

@@ -23,49 +23,49 @@
 class VsprintfFilter extends FormHtmlFilter
 {
 
-    /**
-     * @var string $format
-     */
-    protected $format = '';
-
-
-    /**
-     * @var array $args
-     */
-    protected $args = array();
-
-
-
-    /**
-     * SprintfFormHtmlParser constructor.
-     *
-     * @param string $format
-     * @param array  $args
-     */
-    public function __construct($format, array $args)
-    {
-        $this->format = $format;
-        $this->args = $args;
-    }
-
-
-
-    /**
-     * @param                        $html
-     * @param EE_Form_Section_Validatable $form_section
-     * @return string
-     */
-    public function filterHtml($html, EE_Form_Section_Validatable $form_section)
-    {
-        $this->args[] = $html;
-        if ($form_section instanceof EE_Form_Section_Proper) {
-            $subsections = $form_section->subsections();
-            foreach ((array)$subsections as $subsection) {
-                $this->args[] = $subsection->get_html();
-            }
-        }
-        return vsprintf($this->format, $this->args);
-    }
+	/**
+	 * @var string $format
+	 */
+	protected $format = '';
+
+
+	/**
+	 * @var array $args
+	 */
+	protected $args = array();
+
+
+
+	/**
+	 * SprintfFormHtmlParser constructor.
+	 *
+	 * @param string $format
+	 * @param array  $args
+	 */
+	public function __construct($format, array $args)
+	{
+		$this->format = $format;
+		$this->args = $args;
+	}
+
+
+
+	/**
+	 * @param                        $html
+	 * @param EE_Form_Section_Validatable $form_section
+	 * @return string
+	 */
+	public function filterHtml($html, EE_Form_Section_Validatable $form_section)
+	{
+		$this->args[] = $html;
+		if ($form_section instanceof EE_Form_Section_Proper) {
+			$subsections = $form_section->subsections();
+			foreach ((array)$subsections as $subsection) {
+				$this->args[] = $subsection->get_html();
+			}
+		}
+		return vsprintf($this->format, $this->args);
+	}
 
 
 

Spacing +1 added lines, -1 removed lines

@@ -60,7 +60,7 @@
         $this->args[] = $html;
         if ($form_section instanceof EE_Form_Section_Proper) {
             $subsections = $form_section->subsections();
-            foreach ((array)$subsections as $subsection) {
+            foreach ((array) $subsections as $subsection) {
                 $this->args[] = $subsection->get_html();
             }
         }

core/libraries/form_sections/strategies/display/EE_Select_Display_Strategy.strategy.php

Doc Comments +1 added lines, -1 removed lines

@@ -84,7 +84,7 @@
 	 * Checks if that value is the one selected
 	 *
 	 * @param string|int $option_value unnormalized value option (string). How it will appear in the HTML.
-	 * @return string
+	 * @return boolean
 	 */
 	protected function _check_if_option_selected($option_value ){
 		return $option_value === $this->_input->raw_value();

Indentation +11 added lines, -11 removed lines

@@ -38,15 +38,15 @@ 
 		if ( EEH_Array::is_multi_dimensional_array( $this->_input->options() )) {
 			EEH_HTML::indent( 1, 'optgroup' );
 			foreach( $this->_input->options() as $opt_group_label => $opt_group ){
-			    if ( ! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl(0, 'optgroup') . '<optgroup label="' . esc_attr($opt_group_label) . '">';
-                }
+				if ( ! empty($opt_group_label)) {
+					$html .= EEH_HTML::nl(0, 'optgroup') . '<optgroup label="' . esc_attr($opt_group_label) . '">';
+				}
 				EEH_HTML::indent( 1, 'option' );
 				$html .= $this->_display_options( $opt_group );
 				EEH_HTML::indent( -1, 'option' );
-                if ( ! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl( 0, 'optgroup' ) . '</optgroup>';
-			    }
+				if ( ! empty($opt_group_label)) {
+					$html .= EEH_HTML::nl( 0, 'optgroup' ) . '</optgroup>';
+				}
 			}
 			EEH_HTML::indent( -1, 'optgroup' );
 		} else {
@@ -68,11 +68,11 @@ 
 		$html = '';
 		EEH_HTML::indent( 1, 'option' );
 		foreach( $options as $value => $display_text ){
-		    //even if this input uses EE_Text_Normalization if one of the array keys is a numeric string, like "123",
-            //PHP will have converted it to a PHP integer (eg 123). So we need to make sure it's a string
-            $unnormalized_value = $this->_input->get_normalization_strategy()->unnormalize_one( $value );
-            $selected = $this->_check_if_option_selected($unnormalized_value ) ? ' selected="selected"' : '';
-            $html.= EEH_HTML::nl( 0, 'option' ) . '<option value="' . esc_attr($unnormalized_value ) . '"' . $selected . '>' . $display_text . '</option>';
+			//even if this input uses EE_Text_Normalization if one of the array keys is a numeric string, like "123",
+			//PHP will have converted it to a PHP integer (eg 123). So we need to make sure it's a string
+			$unnormalized_value = $this->_input->get_normalization_strategy()->unnormalize_one( $value );
+			$selected = $this->_check_if_option_selected($unnormalized_value ) ? ' selected="selected"' : '';
+			$html.= EEH_HTML::nl( 0, 'option' ) . '<option value="' . esc_attr($unnormalized_value ) . '"' . $selected . '>' . $display_text . '</option>';
 		}
 		EEH_HTML::indent( -1, 'option' );
 		return $html;

Spacing +27 added lines, -27 removed lines

@@ -11,49 +11,49 @@ 
  * @since 				$VID:$
  *
  */
-class EE_Select_Display_Strategy extends EE_Display_Strategy_Base{
+class EE_Select_Display_Strategy extends EE_Display_Strategy_Base {
 
 	/**
 	 *
 	 * @throws EE_Error
 	 * @return string of html to display the field
 	 */
-	function display(){
-		if( ! $this->_input instanceof EE_Form_Input_With_Options_Base){
-			throw new EE_Error( sprintf( __( 'Cannot use Select Display Strategy with an input that doesn\'t have options', 'event_espresso' )));
+	function display() {
+		if ( ! $this->_input instanceof EE_Form_Input_With_Options_Base) {
+			throw new EE_Error(sprintf(__('Cannot use Select Display Strategy with an input that doesn\'t have options', 'event_espresso')));
 		}
 
-		$html = EEH_HTML::nl( 0, 'select' );
+		$html = EEH_HTML::nl(0, 'select');
 		$html .= '<select';
-		$html .= ' id="' . $this->_input->html_id() . '"';
-		$html .= ' name="' . $this->_input->html_name() . '"';
-		$class = $this->_input->required() ? $this->_input->required_css_class() . ' ' . $this->_input->html_class() : $this->_input->html_class();
-		$html .= ' class="' . $class . '"';
+		$html .= ' id="'.$this->_input->html_id().'"';
+		$html .= ' name="'.$this->_input->html_name().'"';
+		$class = $this->_input->required() ? $this->_input->required_css_class().' '.$this->_input->html_class() : $this->_input->html_class();
+		$html .= ' class="'.$class.'"';
 		// add html5 required
 		$html .= $this->_input->required() ? ' required' : '';
-		$html .= ' style="' . $this->_input->html_style() . '"';
-		$html .= ' ' . $this->_input->other_html_attributes();
+		$html .= ' style="'.$this->_input->html_style().'"';
+		$html .= ' '.$this->_input->other_html_attributes();
 		$html .= '>';
 
-		if ( EEH_Array::is_multi_dimensional_array( $this->_input->options() )) {
-			EEH_HTML::indent( 1, 'optgroup' );
-			foreach( $this->_input->options() as $opt_group_label => $opt_group ){
+		if (EEH_Array::is_multi_dimensional_array($this->_input->options())) {
+			EEH_HTML::indent(1, 'optgroup');
+			foreach ($this->_input->options() as $opt_group_label => $opt_group) {
 			    if ( ! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl(0, 'optgroup') . '<optgroup label="' . esc_attr($opt_group_label) . '">';
+                    $html .= EEH_HTML::nl(0, 'optgroup').'<optgroup label="'.esc_attr($opt_group_label).'">';
                 }
-				EEH_HTML::indent( 1, 'option' );
-				$html .= $this->_display_options( $opt_group );
+				EEH_HTML::indent(1, 'option');
+				$html .= $this->_display_options($opt_group);
 				EEH_HTML::indent( -1, 'option' );
                 if ( ! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl( 0, 'optgroup' ) . '</optgroup>';
+                    $html .= EEH_HTML::nl(0, 'optgroup').'</optgroup>';
 			    }
 			}
 			EEH_HTML::indent( -1, 'optgroup' );
 		} else {
-			$html.=$this->_display_options( $this->_input->options() );
+			$html .= $this->_display_options($this->_input->options());
 		}
 
-		$html.= EEH_HTML::nl( 0, 'select' ) . '</select>';
+		$html .= EEH_HTML::nl(0, 'select').'</select>';
 		return $html;
 	}
 
@@ -64,15 +64,15 @@ 
 	 * @param array $options
 	 * @return string
 	 */
-	protected function _display_options($options){
+	protected function _display_options($options) {
 		$html = '';
-		EEH_HTML::indent( 1, 'option' );
-		foreach( $options as $value => $display_text ){
+		EEH_HTML::indent(1, 'option');
+		foreach ($options as $value => $display_text) {
 		    //even if this input uses EE_Text_Normalization if one of the array keys is a numeric string, like "123",
             //PHP will have converted it to a PHP integer (eg 123). So we need to make sure it's a string
-            $unnormalized_value = $this->_input->get_normalization_strategy()->unnormalize_one( $value );
-            $selected = $this->_check_if_option_selected($unnormalized_value ) ? ' selected="selected"' : '';
-            $html.= EEH_HTML::nl( 0, 'option' ) . '<option value="' . esc_attr($unnormalized_value ) . '"' . $selected . '>' . $display_text . '</option>';
+            $unnormalized_value = $this->_input->get_normalization_strategy()->unnormalize_one($value);
+            $selected = $this->_check_if_option_selected($unnormalized_value) ? ' selected="selected"' : '';
+            $html .= EEH_HTML::nl(0, 'option').'<option value="'.esc_attr($unnormalized_value).'"'.$selected.'>'.$display_text.'</option>';
 		}
 		EEH_HTML::indent( -1, 'option' );
 		return $html;
@@ -86,7 +86,7 @@ 
 	 * @param string|int $option_value unnormalized value option (string). How it will appear in the HTML.
 	 * @return string
 	 */
-	protected function _check_if_option_selected($option_value ){
+	protected function _check_if_option_selected($option_value) {
 		return $option_value === $this->_input->raw_value();
 	}
 

core/libraries/form_sections/inputs/EE_Form_Input_With_Options_Base.input.php

Indentation +315 added lines, -315 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -16,320 +16,320 @@ 
 class EE_Form_Input_With_Options_Base extends EE_Form_Input_Base
 {
 
-    /**
-     * array of available options to choose as an answer
-     *
-     * @var array
-     */
-    protected $_options = array();
-
-    /**
-     * whether to display the html_label_text above the checkbox/radio button options
-     *
-     * @var boolean
-     */
-    protected $_display_html_label_text = true;
-
-    /**
-     * whether to display an question option description as part of the input label
-     *
-     * @var boolean
-     */
-    protected $_use_desc_in_label = true;
-
-    /**
-     * strlen() result for the longest input value (what gets displayed in the label)
-     * this is used to apply a css class to the input label
-     *
-     * @var int
-     */
-    protected $_label_size = 0;
-
-    /**
-     * whether to enforce the label size value passed in the constructor
-     *
-     * @var boolean
-     */
-    protected $_enforce_label_size = false;
-
-    /**
-     * whether to allow multiple selections (ie, the value of this input should be an array)
-     * or not (ie, the value should be a simple int, string, etc)
-     *
-     * @var boolean
-     */
-    protected $_multiple_selections = false;
-
-
-
-    /**
-     * @param array     $answer_options
-     * @param array     $input_settings {
-     * @type int|string $label_size
-     * @type boolean    $display_html_label_text
-     *                                  }
-     *                                  And all the options accepted by EE_Form_Input_Base
-     */
-    public function __construct($answer_options = array(), $input_settings = array())
-    {
-        if (isset($input_settings['label_size'])) {
-            $this->_set_label_size($input_settings['label_size']);
-            if (isset($input_settings['enforce_label_size']) && $input_settings['enforce_label_size']) {
-                $this->_enforce_label_size = true;
-            }
-        }
-        if (isset($input_settings['display_html_label_text'])) {
-            $this->set_display_html_label_text($input_settings['display_html_label_text']);
-        }
-        $this->set_select_options($answer_options);
-        parent::__construct($input_settings);
-    }
-
-
-
-    /**
-     * Sets the allowed options for this input. Also has the side-effect of
-     * updating the normalization strategy to match the keys provided in the array
-     *
-     * @param array $answer_options
-     * @return void  just has the side-effect of setting the options for this input
-     */
-    public function set_select_options($answer_options = array())
-    {
-        $answer_options = is_array($answer_options) ? $answer_options : array($answer_options);
-        //get the first item in the select options and check it's type
-        $this->_options = reset($answer_options) instanceof EE_Question_Option
-            ? $this->_process_question_options($answer_options)
-            : $answer_options;
-        //d( $this->_options );
-        $select_option_keys = array_keys($this->_options);
-        // attempt to determine data type for values in order to set normalization type
-        //purposefully only
-        if (
-            count($this->_options) === 2
-            && (
-                (in_array(true, $select_option_keys, true) && in_array(false, $select_option_keys, true))
-                || (in_array(1, $select_option_keys, true) && in_array(0, $select_option_keys, true))
-            )
-        ) {
-            // values appear to be boolean, like TRUE, FALSE, 1, 0
-            $normalization = new EE_Boolean_Normalization();
-        } else {
-            //are ALL the options ints (even if we're using a multi-dimensional array)? If so use int validation
-            $all_ints = true;
-            array_walk_recursive(
-                $this->_options,
-                function($value,$key) use (&$all_ints){
-                    //is this a top-level key? ignore it
-                    if(! is_array($value)
-                        && ! is_int($key)
-                       && $key !== ''
-                       && $key !== null){
-                        $all_ints = false;
-                    }
-                }
-            );
-            if ($all_ints) {
-                $normalization = new EE_Int_Normalization();
-            } else {
-                $normalization = new EE_Text_Normalization();
-            }
-        }
-        // does input type have multiple options ?
-        if ($this->_multiple_selections) {
-            $this->_set_normalization_strategy(new EE_Many_Valued_Normalization($normalization));
-        } else {
-            $this->_set_normalization_strategy($normalization);
-        }
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function options()
-    {
-        return $this->_options;
-    }
-
-
-
-    /**
-     * Returns an array which is guaranteed to not be multidimensional
-     *
-     * @return array
-     */
-    public function flat_options()
-    {
-        return $this->_flatten_select_options($this->options());
-    }
-
-
-
-    /**
-     * Makes sure $arr is a flat array, not a multidimensional one
-     *
-     * @param array $arr
-     * @return array
-     */
-    protected function _flatten_select_options($arr)
-    {
-        $flat_array = array();
-        if (EEH_Array::is_multi_dimensional_array($arr)) {
-            foreach ($arr as $sub_array) {
-                foreach ((array)$sub_array as $key => $value) {
-                    $flat_array[$key] = $value;
-                    $this->_set_label_size($value);
-                }
-            }
-        } else {
-            foreach ($arr as $key => $value) {
-                $flat_array[$key] = $value;
-                $this->_set_label_size($value);
-            }
-        }
-        return $flat_array;
-    }
-
-
-
-    /**
-     * @param EE_Question_Option[] $question_options_array
-     * @return array
-     */
-    protected function _process_question_options($question_options_array = array())
-    {
-        $flat_array = array();
-        foreach ($question_options_array as $question_option) {
-            if ($question_option instanceof EE_Question_Option) {
-                $desc = '';
-                if ($this->_use_desc_in_label) {
-                    $desc = $question_option->desc();
-                    $desc = ! empty($desc) ? '<span class="ee-question-option-desc">' . $desc . '</span>' : '';
-                }
-                $value = $question_option->value();
-                // add value even if it's empty
-                $flat_array[$value] = $value;
-                // if both value and desc are not empty, then separate with a dash
-                if ( ! empty($value) && ! empty($desc)) {
-                    $flat_array[$value] .= ' - ' . $desc;
-                } else {
-                    // otherwise, just add desc, since either or both of the vars is empty, and no dash is necessary
-                    $flat_array[$value] .= $desc;
-                }
-            } elseif (is_array($question_option)) {
-                $flat_array += $this->_flatten_select_options($question_option);
-            }
-        }
-        return $flat_array;
-    }
-
-
-
-    /**
-     *    set_label_sizes
-     *
-     * @return void
-     */
-    public function set_label_sizes()
-    {
-        // did the input settings specifically say to NOT set the label size dynamically ?
-        if ( ! $this->_enforce_label_size) {
-            foreach ($this->_options as $option) {
-                // calculate the strlen of the label
-                $this->_set_label_size($option);
-            }
-        }
-    }
-
-
-
-    /**
-     *    _set_label_size_class
-     *
-     * @param int|string $value
-     * @return void
-     */
-    private function _set_label_size($value = '')
-    {
-        // determine length of option value
-        $val_size = is_int($value) ? $value : strlen($value);
-        // use new value if bigger than existing
-        $this->_label_size = $val_size > $this->_label_size ? $val_size : $this->_label_size;
-    }
-
-
-
-    /**
-     *    get_label_size_class
-     *
-     * @return string
-     */
-    public function get_label_size_class()
-    {
-        $size = ' medium-lbl';
-        // use maximum option value length to determine label size
-        if ($this->_label_size < 3) {
-            $size = ' nano-lbl';
-        } else if ($this->_label_size < 6) {
-            $size = ' micro-lbl';
-        } else if ($this->_label_size < 12) {
-            $size = ' tiny-lbl';
-        } else if ($this->_label_size < 25) {
-            $size = ' small-lbl';
-        } else if ($this->_label_size < 50) {
-            $size = ' medium-lbl';
-        } else if ($this->_label_size >= 100) {
-            $size = ' big-lbl';
-        }
-        return $size;
-    }
-
-
-
-    /**
-     * Returns the pretty value for the normalized value
-     *
-     * @return string
-     */
-    public function pretty_value()
-    {
-        $options = $this->flat_options();
-        $unnormalized_value_choices = $this->get_normalization_strategy()->unnormalize($this->_normalized_value);
-        if ( ! $this->_multiple_selections) {
-            $unnormalized_value_choices = array($unnormalized_value_choices);
-        }
-        $pretty_strings = array();
-        foreach ((array)$unnormalized_value_choices as $unnormalized_value_choice) {
-            if (isset($options[$unnormalized_value_choice])) {
-                $pretty_strings[] = $options[$unnormalized_value_choice];
-            } else {
-                $pretty_strings[] = $this->normalized_value();
-            }
-        }
-        return implode(', ', $pretty_strings);
-    }
-
-
-
-    /**
-     * @return boolean
-     */
-    public function display_html_label_text()
-    {
-        return $this->_display_html_label_text;
-    }
-
-
-
-    /**
-     * @param boolean $display_html_label_text
-     */
-    public function set_display_html_label_text($display_html_label_text)
-    {
-        $this->_display_html_label_text = filter_var($display_html_label_text, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * array of available options to choose as an answer
+	 *
+	 * @var array
+	 */
+	protected $_options = array();
+
+	/**
+	 * whether to display the html_label_text above the checkbox/radio button options
+	 *
+	 * @var boolean
+	 */
+	protected $_display_html_label_text = true;
+
+	/**
+	 * whether to display an question option description as part of the input label
+	 *
+	 * @var boolean
+	 */
+	protected $_use_desc_in_label = true;
+
+	/**
+	 * strlen() result for the longest input value (what gets displayed in the label)
+	 * this is used to apply a css class to the input label
+	 *
+	 * @var int
+	 */
+	protected $_label_size = 0;
+
+	/**
+	 * whether to enforce the label size value passed in the constructor
+	 *
+	 * @var boolean
+	 */
+	protected $_enforce_label_size = false;
+
+	/**
+	 * whether to allow multiple selections (ie, the value of this input should be an array)
+	 * or not (ie, the value should be a simple int, string, etc)
+	 *
+	 * @var boolean
+	 */
+	protected $_multiple_selections = false;
+
+
+
+	/**
+	 * @param array     $answer_options
+	 * @param array     $input_settings {
+	 * @type int|string $label_size
+	 * @type boolean    $display_html_label_text
+	 *                                  }
+	 *                                  And all the options accepted by EE_Form_Input_Base
+	 */
+	public function __construct($answer_options = array(), $input_settings = array())
+	{
+		if (isset($input_settings['label_size'])) {
+			$this->_set_label_size($input_settings['label_size']);
+			if (isset($input_settings['enforce_label_size']) && $input_settings['enforce_label_size']) {
+				$this->_enforce_label_size = true;
+			}
+		}
+		if (isset($input_settings['display_html_label_text'])) {
+			$this->set_display_html_label_text($input_settings['display_html_label_text']);
+		}
+		$this->set_select_options($answer_options);
+		parent::__construct($input_settings);
+	}
+
+
+
+	/**
+	 * Sets the allowed options for this input. Also has the side-effect of
+	 * updating the normalization strategy to match the keys provided in the array
+	 *
+	 * @param array $answer_options
+	 * @return void  just has the side-effect of setting the options for this input
+	 */
+	public function set_select_options($answer_options = array())
+	{
+		$answer_options = is_array($answer_options) ? $answer_options : array($answer_options);
+		//get the first item in the select options and check it's type
+		$this->_options = reset($answer_options) instanceof EE_Question_Option
+			? $this->_process_question_options($answer_options)
+			: $answer_options;
+		//d( $this->_options );
+		$select_option_keys = array_keys($this->_options);
+		// attempt to determine data type for values in order to set normalization type
+		//purposefully only
+		if (
+			count($this->_options) === 2
+			&& (
+				(in_array(true, $select_option_keys, true) && in_array(false, $select_option_keys, true))
+				|| (in_array(1, $select_option_keys, true) && in_array(0, $select_option_keys, true))
+			)
+		) {
+			// values appear to be boolean, like TRUE, FALSE, 1, 0
+			$normalization = new EE_Boolean_Normalization();
+		} else {
+			//are ALL the options ints (even if we're using a multi-dimensional array)? If so use int validation
+			$all_ints = true;
+			array_walk_recursive(
+				$this->_options,
+				function($value,$key) use (&$all_ints){
+					//is this a top-level key? ignore it
+					if(! is_array($value)
+						&& ! is_int($key)
+					   && $key !== ''
+					   && $key !== null){
+						$all_ints = false;
+					}
+				}
+			);
+			if ($all_ints) {
+				$normalization = new EE_Int_Normalization();
+			} else {
+				$normalization = new EE_Text_Normalization();
+			}
+		}
+		// does input type have multiple options ?
+		if ($this->_multiple_selections) {
+			$this->_set_normalization_strategy(new EE_Many_Valued_Normalization($normalization));
+		} else {
+			$this->_set_normalization_strategy($normalization);
+		}
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function options()
+	{
+		return $this->_options;
+	}
+
+
+
+	/**
+	 * Returns an array which is guaranteed to not be multidimensional
+	 *
+	 * @return array
+	 */
+	public function flat_options()
+	{
+		return $this->_flatten_select_options($this->options());
+	}
+
+
+
+	/**
+	 * Makes sure $arr is a flat array, not a multidimensional one
+	 *
+	 * @param array $arr
+	 * @return array
+	 */
+	protected function _flatten_select_options($arr)
+	{
+		$flat_array = array();
+		if (EEH_Array::is_multi_dimensional_array($arr)) {
+			foreach ($arr as $sub_array) {
+				foreach ((array)$sub_array as $key => $value) {
+					$flat_array[$key] = $value;
+					$this->_set_label_size($value);
+				}
+			}
+		} else {
+			foreach ($arr as $key => $value) {
+				$flat_array[$key] = $value;
+				$this->_set_label_size($value);
+			}
+		}
+		return $flat_array;
+	}
+
+
+
+	/**
+	 * @param EE_Question_Option[] $question_options_array
+	 * @return array
+	 */
+	protected function _process_question_options($question_options_array = array())
+	{
+		$flat_array = array();
+		foreach ($question_options_array as $question_option) {
+			if ($question_option instanceof EE_Question_Option) {
+				$desc = '';
+				if ($this->_use_desc_in_label) {
+					$desc = $question_option->desc();
+					$desc = ! empty($desc) ? '<span class="ee-question-option-desc">' . $desc . '</span>' : '';
+				}
+				$value = $question_option->value();
+				// add value even if it's empty
+				$flat_array[$value] = $value;
+				// if both value and desc are not empty, then separate with a dash
+				if ( ! empty($value) && ! empty($desc)) {
+					$flat_array[$value] .= ' - ' . $desc;
+				} else {
+					// otherwise, just add desc, since either or both of the vars is empty, and no dash is necessary
+					$flat_array[$value] .= $desc;
+				}
+			} elseif (is_array($question_option)) {
+				$flat_array += $this->_flatten_select_options($question_option);
+			}
+		}
+		return $flat_array;
+	}
+
+
+
+	/**
+	 *    set_label_sizes
+	 *
+	 * @return void
+	 */
+	public function set_label_sizes()
+	{
+		// did the input settings specifically say to NOT set the label size dynamically ?
+		if ( ! $this->_enforce_label_size) {
+			foreach ($this->_options as $option) {
+				// calculate the strlen of the label
+				$this->_set_label_size($option);
+			}
+		}
+	}
+
+
+
+	/**
+	 *    _set_label_size_class
+	 *
+	 * @param int|string $value
+	 * @return void
+	 */
+	private function _set_label_size($value = '')
+	{
+		// determine length of option value
+		$val_size = is_int($value) ? $value : strlen($value);
+		// use new value if bigger than existing
+		$this->_label_size = $val_size > $this->_label_size ? $val_size : $this->_label_size;
+	}
+
+
+
+	/**
+	 *    get_label_size_class
+	 *
+	 * @return string
+	 */
+	public function get_label_size_class()
+	{
+		$size = ' medium-lbl';
+		// use maximum option value length to determine label size
+		if ($this->_label_size < 3) {
+			$size = ' nano-lbl';
+		} else if ($this->_label_size < 6) {
+			$size = ' micro-lbl';
+		} else if ($this->_label_size < 12) {
+			$size = ' tiny-lbl';
+		} else if ($this->_label_size < 25) {
+			$size = ' small-lbl';
+		} else if ($this->_label_size < 50) {
+			$size = ' medium-lbl';
+		} else if ($this->_label_size >= 100) {
+			$size = ' big-lbl';
+		}
+		return $size;
+	}
+
+
+
+	/**
+	 * Returns the pretty value for the normalized value
+	 *
+	 * @return string
+	 */
+	public function pretty_value()
+	{
+		$options = $this->flat_options();
+		$unnormalized_value_choices = $this->get_normalization_strategy()->unnormalize($this->_normalized_value);
+		if ( ! $this->_multiple_selections) {
+			$unnormalized_value_choices = array($unnormalized_value_choices);
+		}
+		$pretty_strings = array();
+		foreach ((array)$unnormalized_value_choices as $unnormalized_value_choice) {
+			if (isset($options[$unnormalized_value_choice])) {
+				$pretty_strings[] = $options[$unnormalized_value_choice];
+			} else {
+				$pretty_strings[] = $this->normalized_value();
+			}
+		}
+		return implode(', ', $pretty_strings);
+	}
+
+
+
+	/**
+	 * @return boolean
+	 */
+	public function display_html_label_text()
+	{
+		return $this->_display_html_label_text;
+	}
+
+
+
+	/**
+	 * @param boolean $display_html_label_text
+	 */
+	public function set_display_html_label_text($display_html_label_text)
+	{
+		$this->_display_html_label_text = filter_var($display_html_label_text, FILTER_VALIDATE_BOOLEAN);
+	}
 
 
 

Spacing +7 added lines, -7 removed lines

@@ -119,12 +119,12 @@ 
             $all_ints = true;
             array_walk_recursive(
                 $this->_options,
-                function($value,$key) use (&$all_ints){
+                function($value, $key) use (&$all_ints){
                     //is this a top-level key? ignore it
-                    if(! is_array($value)
+                    if ( ! is_array($value)
                         && ! is_int($key)
                        && $key !== ''
-                       && $key !== null){
+                       && $key !== null) {
                         $all_ints = false;
                     }
                 }
@@ -178,7 +178,7 @@ 
         $flat_array = array();
         if (EEH_Array::is_multi_dimensional_array($arr)) {
             foreach ($arr as $sub_array) {
-                foreach ((array)$sub_array as $key => $value) {
+                foreach ((array) $sub_array as $key => $value) {
                     $flat_array[$key] = $value;
                     $this->_set_label_size($value);
                 }
@@ -206,14 +206,14 @@ 
                 $desc = '';
                 if ($this->_use_desc_in_label) {
                     $desc = $question_option->desc();
-                    $desc = ! empty($desc) ? '<span class="ee-question-option-desc">' . $desc . '</span>' : '';
+                    $desc = ! empty($desc) ? '<span class="ee-question-option-desc">'.$desc.'</span>' : '';
                 }
                 $value = $question_option->value();
                 // add value even if it's empty
                 $flat_array[$value] = $value;
                 // if both value and desc are not empty, then separate with a dash
                 if ( ! empty($value) && ! empty($desc)) {
-                    $flat_array[$value] .= ' - ' . $desc;
+                    $flat_array[$value] .= ' - '.$desc;
                 } else {
                     // otherwise, just add desc, since either or both of the vars is empty, and no dash is necessary
                     $flat_array[$value] .= $desc;
@@ -301,7 +301,7 @@ 
             $unnormalized_value_choices = array($unnormalized_value_choices);
         }
         $pretty_strings = array();
-        foreach ((array)$unnormalized_value_choices as $unnormalized_value_choice) {
+        foreach ((array) $unnormalized_value_choices as $unnormalized_value_choice) {
             if (isset($options[$unnormalized_value_choice])) {
                 $pretty_strings[] = $options[$unnormalized_value_choice];
             } else {