eventespresso / event-espresso-core

modules/ticket_selector/TicketSelectorStandard.php

Spacing +1 added lines, -1 removed lines

@@ -135,7 +135,7 @@
         $this->template_args['ticket_row_html'] = $ticket_row_html;
         $this->template_args['taxable_tickets'] = $taxable_tickets;
         $this->template_args['prices_displayed_including_taxes'] = $this->tax_config->prices_displayed_including_taxes;
-        $this->template_args['template_path'] = TICKET_SELECTOR_TEMPLATES_PATH . 'standard_ticket_selector.template.php';
+        $this->template_args['template_path'] = TICKET_SELECTOR_TEMPLATES_PATH.'standard_ticket_selector.template.php';
         remove_all_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector');
     }
 

Indentation +120 added lines, -120 removed lines

@@ -17,126 +17,126 @@
 class TicketSelectorStandard extends TicketSelector
 {
 
-    /**
-     * @var string $date_format
-     */
-    protected $date_format;
-
-    /**
-     * @var string $time_format
-     */
-    protected $time_format;
-
-    /**
-     * @var \EE_Ticket_Selector_Config $ticket_selector_config
-     */
-    protected $ticket_selector_config;
-
-    /**
-     * @var \EE_Tax_Config $tax_config
-     */
-    protected $tax_config;
-
-
-
-    /**
-     * TicketSelectorSimple constructor.
-     *
-     * @param \EE_Event                  $event
-     * @param \EE_Ticket[]               $tickets
-     * @param int                        $max_attendees
-     * @param array                      $template_args
-     * @param string                     $date_format
-     * @param string                     $time_format
-     * @param \EE_Ticket_Selector_Config $ticket_selector_config
-     * @param \EE_Tax_Config             $tax_config
-     */
-    public function __construct(
-        \EE_Event $event,
-        array $tickets,
-        $max_attendees,
-        array $template_args,
-        $date_format = 'Y-m-d',
-        $time_format = 'g:i a',
-        \EE_Ticket_Selector_Config $ticket_selector_config = null,
-        \EE_Tax_Config $tax_config = null
-    ) {
-        $this->date_format = $date_format;
-        $this->time_format = $time_format;
-        // get EE_Ticket_Selector_Config and TicketDetails
-        $this->ticket_selector_config = isset (\EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector)
-            ? \EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector
-            : new \EE_Ticket_Selector_Config();
-        // $template_settings->setDatetimeSelectorThreshold(2);
-        // \EEH_Debug_Tools::printr($template_settings->getShowDatetimeSelector(), 'getShowDatetimeSelector', __FILE__, __LINE__);
-        // \EEH_Debug_Tools::printr($template_settings->getDatetimeSelectorThreshold(), 'getDatetimeSelectorThreshold', __FILE__, __LINE__);
-        $this->tax_config = isset (\EE_Registry::instance()->CFG->tax_settings)
-            ? \EE_Registry::instance()->CFG->tax_settings
-            : new \EE_Tax_Config();
-        parent::__construct($event, $tickets, $max_attendees, $template_args);
-    }
-
-
-
-    /**
-     * sets any and all template args that are required for this Ticket Selector
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function addTemplateArgs()
-    {
-        $row = 1;
-        $ticket_row_html = '';
-        $required_ticket_sold_out = false;
-        // flag to indicate that at least one taxable ticket has been encountered
-        $taxable_tickets = false;
-        $datetime_selector = null;
-        $this->template_args['datetime_selector'] = '';
-        if (
-            $this->ticket_selector_config->getShowDatetimeSelector()
-            !== \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR
-        ) {
-            $datetime_selector = new DatetimeSelector(
-                $this->event,
-                $this->tickets,
-                $this->ticket_selector_config,
-                $this->date_format,
-                $this->time_format
-            );
-            $this->template_args['datetime_selector'] = $datetime_selector->getDatetimeSelector();
-        }
-        $total_tickets = count($this->tickets);
-        // loop through tickets
-        foreach ($this->tickets as $TKT_ID => $ticket) {
-            if ($ticket instanceof \EE_Ticket) {
-                $cols = 2;
-                $taxable_tickets = $ticket->taxable() ? true : $taxable_tickets;
-                $ticket_selector_row = new TicketSelectorRowStandard(
-                    new TicketDetails($ticket, $this->ticket_selector_config, $this->template_args),
-                    $this->tax_config,
-                    $total_tickets,
-                    $this->max_attendees,
-                    $row,
-                    $cols,
-                    $required_ticket_sold_out,
-                    $this->template_args['event_status'],
-                    $datetime_selector instanceof DatetimeSelector
-                        ? $datetime_selector->getTicketDatetimeClasses($ticket)
-                        : ''
-                );
-                $ticket_row_html .= $ticket_selector_row->getHtml();
-                $required_ticket_sold_out = $ticket_selector_row->getRequiredTicketSoldOut();
-                $row++;
-            }
-        }
-        $this->template_args['row'] = $row;
-        $this->template_args['ticket_row_html'] = $ticket_row_html;
-        $this->template_args['taxable_tickets'] = $taxable_tickets;
-        $this->template_args['prices_displayed_including_taxes'] = $this->tax_config->prices_displayed_including_taxes;
-        $this->template_args['template_path'] = TICKET_SELECTOR_TEMPLATES_PATH . 'standard_ticket_selector.template.php';
-        remove_all_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector');
-    }
+	/**
+	 * @var string $date_format
+	 */
+	protected $date_format;
+
+	/**
+	 * @var string $time_format
+	 */
+	protected $time_format;
+
+	/**
+	 * @var \EE_Ticket_Selector_Config $ticket_selector_config
+	 */
+	protected $ticket_selector_config;
+
+	/**
+	 * @var \EE_Tax_Config $tax_config
+	 */
+	protected $tax_config;
+
+
+
+	/**
+	 * TicketSelectorSimple constructor.
+	 *
+	 * @param \EE_Event                  $event
+	 * @param \EE_Ticket[]               $tickets
+	 * @param int                        $max_attendees
+	 * @param array                      $template_args
+	 * @param string                     $date_format
+	 * @param string                     $time_format
+	 * @param \EE_Ticket_Selector_Config $ticket_selector_config
+	 * @param \EE_Tax_Config             $tax_config
+	 */
+	public function __construct(
+		\EE_Event $event,
+		array $tickets,
+		$max_attendees,
+		array $template_args,
+		$date_format = 'Y-m-d',
+		$time_format = 'g:i a',
+		\EE_Ticket_Selector_Config $ticket_selector_config = null,
+		\EE_Tax_Config $tax_config = null
+	) {
+		$this->date_format = $date_format;
+		$this->time_format = $time_format;
+		// get EE_Ticket_Selector_Config and TicketDetails
+		$this->ticket_selector_config = isset (\EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector)
+			? \EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector
+			: new \EE_Ticket_Selector_Config();
+		// $template_settings->setDatetimeSelectorThreshold(2);
+		// \EEH_Debug_Tools::printr($template_settings->getShowDatetimeSelector(), 'getShowDatetimeSelector', __FILE__, __LINE__);
+		// \EEH_Debug_Tools::printr($template_settings->getDatetimeSelectorThreshold(), 'getDatetimeSelectorThreshold', __FILE__, __LINE__);
+		$this->tax_config = isset (\EE_Registry::instance()->CFG->tax_settings)
+			? \EE_Registry::instance()->CFG->tax_settings
+			: new \EE_Tax_Config();
+		parent::__construct($event, $tickets, $max_attendees, $template_args);
+	}
+
+
+
+	/**
+	 * sets any and all template args that are required for this Ticket Selector
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function addTemplateArgs()
+	{
+		$row = 1;
+		$ticket_row_html = '';
+		$required_ticket_sold_out = false;
+		// flag to indicate that at least one taxable ticket has been encountered
+		$taxable_tickets = false;
+		$datetime_selector = null;
+		$this->template_args['datetime_selector'] = '';
+		if (
+			$this->ticket_selector_config->getShowDatetimeSelector()
+			!== \EE_Ticket_Selector_Config::DO_NOT_SHOW_DATETIME_SELECTOR
+		) {
+			$datetime_selector = new DatetimeSelector(
+				$this->event,
+				$this->tickets,
+				$this->ticket_selector_config,
+				$this->date_format,
+				$this->time_format
+			);
+			$this->template_args['datetime_selector'] = $datetime_selector->getDatetimeSelector();
+		}
+		$total_tickets = count($this->tickets);
+		// loop through tickets
+		foreach ($this->tickets as $TKT_ID => $ticket) {
+			if ($ticket instanceof \EE_Ticket) {
+				$cols = 2;
+				$taxable_tickets = $ticket->taxable() ? true : $taxable_tickets;
+				$ticket_selector_row = new TicketSelectorRowStandard(
+					new TicketDetails($ticket, $this->ticket_selector_config, $this->template_args),
+					$this->tax_config,
+					$total_tickets,
+					$this->max_attendees,
+					$row,
+					$cols,
+					$required_ticket_sold_out,
+					$this->template_args['event_status'],
+					$datetime_selector instanceof DatetimeSelector
+						? $datetime_selector->getTicketDatetimeClasses($ticket)
+						: ''
+				);
+				$ticket_row_html .= $ticket_selector_row->getHtml();
+				$required_ticket_sold_out = $ticket_selector_row->getRequiredTicketSoldOut();
+				$row++;
+			}
+		}
+		$this->template_args['row'] = $row;
+		$this->template_args['ticket_row_html'] = $ticket_row_html;
+		$this->template_args['taxable_tickets'] = $taxable_tickets;
+		$this->template_args['prices_displayed_including_taxes'] = $this->tax_config->prices_displayed_including_taxes;
+		$this->template_args['template_path'] = TICKET_SELECTOR_TEMPLATES_PATH . 'standard_ticket_selector.template.php';
+		remove_all_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector');
+	}
 
 
 

core/libraries/plugin_api/EE_Register_Message_Type.lib.php

Spacing +14 added lines, -14 removed lines

@@ -6,7 +6,7 @@ 
  * @subpackage      plugin api, messages
  * @since           4.3.0
  */
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -93,20 +93,20 @@ 
              * Required.
              * @type string
              */
-            'mtfilename'                  => (string)$setup_args['mtfilename'],
+            'mtfilename'                  => (string) $setup_args['mtfilename'],
             /**
              * Autoload paths for classes used by the message type.
              * Required.
              * @type array
              */
-            'autoloadpaths'               => (array)$setup_args['autoloadpaths'],
+            'autoloadpaths'               => (array) $setup_args['autoloadpaths'],
             /**
              * Messengers that the message type should be able to activate with.
              * Use messenger slugs.
              * @type array
              */
             'messengers_to_activate_with' => ! empty($setup_args['messengers_to_activate_with'])
-                ? (array)$setup_args['messengers_to_activate_with']
+                ? (array) $setup_args['messengers_to_activate_with']
                 : array(),
             /**
              * Messengers that the message type should validate with.
@@ -114,14 +114,14 @@ 
              * @type array
              */
             'messengers_to_validate_with' => ! empty($setup_args['messengers_to_validate_with'])
-                ? (array)$setup_args['messengers_to_validate_with']
+                ? (array) $setup_args['messengers_to_validate_with']
                 : array(),
             /**
              * Whether to force activate this message type the first time it is registered.
              * @type bool   False means its not activated by default and left up to the end user to activate.
              */
             'force_activation'            => ! empty($setup_args['force_activation'])
-                ? (bool)$setup_args['force_activation']
+                ? (bool) $setup_args['force_activation']
                 : false,
             /**
              * What messengers this message type supports the default template pack for.
@@ -136,7 +136,7 @@ 
              * @type array   Expect an array of messengers this supports default template packs for.
              */
             'messengers_supporting_default_template_pack_with' => isset($setup_args['messengers_supporting_default_template_pack_with'])
-                ? (array)$setup_args['messengers_supporting_default_template_pack_with']
+                ? (array) $setup_args['messengers_supporting_default_template_pack_with']
                 : array(),
             /**
              * The base path where the default templates for this message type can be found.
@@ -162,7 +162,7 @@ 
         );
         //add filters but only if they haven't already been set (these filters only need to be registered ONCE because
         //the callback handles all registered message types.
-        if ( false === has_filter(
+        if (false === has_filter(
             'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
             array('EE_Register_Message_Type', 'register_msgs_autoload_paths')
         )) {
@@ -236,7 +236,7 @@ 
             if ($settings['force_activation']) {
                 foreach ($settings['messengers_to_activate_with'] as $messenger) {
                     //DO not force activation if this message type has already been activated in the system
-                    if (! $message_resource_manager->has_message_type_been_activated_for_messenger($message_type_name,
+                    if ( ! $message_resource_manager->has_message_type_been_activated_for_messenger($message_type_name,
                         $messenger)
                     ) {
                         $message_resource_manager->ensure_message_type_is_active($message_type_name, $messenger);
@@ -256,7 +256,7 @@ 
      */
     public static function deregister($message_type_name = null)
     {
-        if (! empty(self::$_ee_message_type_registry[$message_type_name])) {
+        if ( ! empty(self::$_ee_message_type_registry[$message_type_name])) {
             //let's make sure that we remove any place this message type was made active
             /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
             $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
@@ -297,7 +297,7 @@ 
      */
     public static function register_msgs_autoload_paths($paths)
     {
-        if (! empty(self::$_ee_message_type_registry)) {
+        if ( ! empty(self::$_ee_message_type_registry)) {
             foreach (self::$_ee_message_type_registry as $mt_reg) {
                 if (empty($mt_reg['autoloadpaths'])) {
                     continue;
@@ -413,7 +413,7 @@ 
         $context,
         $template_pack
     ) {
-        if (! $template_pack instanceof EE_Messages_Template_Pack_Default
+        if ( ! $template_pack instanceof EE_Messages_Template_Pack_Default
             || ! $message_type instanceof EE_message_type
         ) {
             return $base_path;
@@ -454,7 +454,7 @@ 
         $file_extension,
         $template_pack
     ) {
-        if (! $template_pack instanceof EE_Messages_Template_Pack_Default) {
+        if ( ! $template_pack instanceof EE_Messages_Template_Pack_Default) {
             return $base_path_or_url;
         }
         foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
@@ -464,7 +464,7 @@ 
                     && ! empty($mt_reg['base_url_for_default_variation'])
                 ) {
                     return $mt_reg['base_url_for_default_variation'];
-                } elseif (! $url
+                } elseif ( ! $url
                     && ! empty($mt_reg['base_path_for_default_variation'])
                 ) {
                     return $mt_reg['base_path_for_default_variation'];

Indentation +432 added lines, -432 removed lines

@@ -7,7 +7,7 @@ 
  * @since           4.3.0
  */
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -22,461 +22,461 @@ 
 {
 
 
-    /**
-     * Holds values for registered message types
-     *
-     * @var array
-     */
-    protected static $_ee_message_type_registry = array();
+	/**
+	 * Holds values for registered message types
+	 *
+	 * @var array
+	 */
+	protected static $_ee_message_type_registry = array();
 
 
-    /**
-     * Method for registering new message types in the EE_messages system.
-     * Note:  All message types must have the following files in order to work:
-     * Template files for default templates getting setup.
-     * See /core/libraries/messages/defaults/default/ for examples
-     * (note that template files match a specific naming schema).
-     * These templates will need to be registered with the default template pack.
-     * - EE_Messages_Validator extended class(es).  See /core/libraries/messages/validators/email/
-     *      for examples.  Note for any new message types, there will need to be a validator for each
-     *      messenger combo this message type can activate with.
-     * - And of course the main EE_{Message_Type_Name}_message_type class that defines the new
-     *      message type and its properties.
-     *
-     * @since    4.3.0
-     * @param string $mt_name       Whatever is defined for the $name property of
-     *                              the message type you are registering (eg.
-     *                              declined_registration). Required.
-     * @param  array $setup_args    An array of arguments provided for registering the message type.
-     *                              @see inline docs in the register method for what can be passed in as arguments.
-     * @throws \EE_Error
-     *                              }
-     */
-    public static function register($mt_name = null, $setup_args = array())
-    {
-        //required fields MUST be present, so let's make sure they are.
-        if (
-            ! isset($mt_name)
-            || ! is_array($setup_args)
-            || empty($setup_args['mtfilename']) || empty($setup_args['autoloadpaths'])
-        ) {
-            throw new EE_Error(
-                __('In order to register a message type with EE_Register_Message_Type::register, you must include a unique name for the message type, plus an array containing the following keys: "mtfilename", "autoloadpaths"',
-                    'event_espresso')
-            );
-        }
+	/**
+	 * Method for registering new message types in the EE_messages system.
+	 * Note:  All message types must have the following files in order to work:
+	 * Template files for default templates getting setup.
+	 * See /core/libraries/messages/defaults/default/ for examples
+	 * (note that template files match a specific naming schema).
+	 * These templates will need to be registered with the default template pack.
+	 * - EE_Messages_Validator extended class(es).  See /core/libraries/messages/validators/email/
+	 *      for examples.  Note for any new message types, there will need to be a validator for each
+	 *      messenger combo this message type can activate with.
+	 * - And of course the main EE_{Message_Type_Name}_message_type class that defines the new
+	 *      message type and its properties.
+	 *
+	 * @since    4.3.0
+	 * @param string $mt_name       Whatever is defined for the $name property of
+	 *                              the message type you are registering (eg.
+	 *                              declined_registration). Required.
+	 * @param  array $setup_args    An array of arguments provided for registering the message type.
+	 *                              @see inline docs in the register method for what can be passed in as arguments.
+	 * @throws \EE_Error
+	 *                              }
+	 */
+	public static function register($mt_name = null, $setup_args = array())
+	{
+		//required fields MUST be present, so let's make sure they are.
+		if (
+			! isset($mt_name)
+			|| ! is_array($setup_args)
+			|| empty($setup_args['mtfilename']) || empty($setup_args['autoloadpaths'])
+		) {
+			throw new EE_Error(
+				__('In order to register a message type with EE_Register_Message_Type::register, you must include a unique name for the message type, plus an array containing the following keys: "mtfilename", "autoloadpaths"',
+					'event_espresso')
+			);
+		}
 
-        //make sure we don't register twice
-        if (isset(self::$_ee_message_type_registry[$mt_name])) {
-            return;
-        }
+		//make sure we don't register twice
+		if (isset(self::$_ee_message_type_registry[$mt_name])) {
+			return;
+		}
 
-        //make sure this was called in the right place!
-        if (
-            ! did_action('EE_Brewing_Regular___messages_caf')
-            || did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    __('A message type named "%s" has been attempted to be registered with the EE Messages System.  It may or may not work because it should be only called on the "EE_Brewing_Regular___messages_caf" hook.',
-                        'event_espresso'),
-                    $mt_name
-                ),
-                '4.3.0'
-            );
-        }
-        //setup $__ee_message_type_registry array from incoming values.
-        self::$_ee_message_type_registry[$mt_name] = array(
-            /**
-             * The file name for the message type being registered.
-             * Required.
-             * @type string
-             */
-            'mtfilename'                  => (string)$setup_args['mtfilename'],
-            /**
-             * Autoload paths for classes used by the message type.
-             * Required.
-             * @type array
-             */
-            'autoloadpaths'               => (array)$setup_args['autoloadpaths'],
-            /**
-             * Messengers that the message type should be able to activate with.
-             * Use messenger slugs.
-             * @type array
-             */
-            'messengers_to_activate_with' => ! empty($setup_args['messengers_to_activate_with'])
-                ? (array)$setup_args['messengers_to_activate_with']
-                : array(),
-            /**
-             * Messengers that the message type should validate with.
-             * Use messenger slugs.
-             * @type array
-             */
-            'messengers_to_validate_with' => ! empty($setup_args['messengers_to_validate_with'])
-                ? (array)$setup_args['messengers_to_validate_with']
-                : array(),
-            /**
-             * Whether to force activate this message type the first time it is registered.
-             * @type bool   False means its not activated by default and left up to the end user to activate.
-             */
-            'force_activation'            => ! empty($setup_args['force_activation'])
-                ? (bool)$setup_args['force_activation']
-                : false,
-            /**
-             * What messengers this message type supports the default template pack for.
-             * Note: If you do not set this (or any of the following template pack/variation related arguments) to true,
-             * then it is expected that the message type being registered is doing its own custom default template
-             * pack/variation registration.
-             *
-             * If this is set and has values, then it is expected that the following arguments are also set in the incoming options
-             * $setup_arguments array as well:
-             * - 'base_path_for_default_templates'
-             *
-             * @type array   Expect an array of messengers this supports default template packs for.
-             */
-            'messengers_supporting_default_template_pack_with' => isset($setup_args['messengers_supporting_default_template_pack_with'])
-                ? (array)$setup_args['messengers_supporting_default_template_pack_with']
-                : array(),
-            /**
-             * The base path where the default templates for this message type can be found.
-             * @type string
-             */
-            'base_path_for_default_templates' => isset($setup_args['base_path_for_default_templates'])
-                ? $setup_args['base_path_for_default_templates']
-                : '',
-            /**
-             * The base path where the default variations for this message type can be found.
-             * @type string
-             */
-            'base_path_for_default_variation' => isset($setup_args['base_path_for_default_variation'])
-                ? $setup_args['base_path_for_default_variation']
-                : '',
-            /**
-             * The base url for the default variations for this message type.
-             * @type string
-             */
-            'base_url_for_default_variation' => isset($setup_args['base_url_for_default_variation'])
-                ? $setup_args['base_url_for_default_variation']
-                : ''
-        );
-        //add filters but only if they haven't already been set (these filters only need to be registered ONCE because
-        //the callback handles all registered message types.
-        if ( false === has_filter(
-            'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
-            array('EE_Register_Message_Type', 'register_msgs_autoload_paths')
-        )) {
-            add_filter(
-                'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
-                array('EE_Register_Message_Type', 'register_msgs_autoload_paths'),
-                10
-            );
-            add_filter(
-                'FHEE__EE_messages__get_installed__messagetype_files',
-                array('EE_Register_Message_Type', 'register_messagetype_files'),
-                10,
-                1
-            );
-            add_filter(
-                'FHEE__EE_messenger__get_default_message_types__default_types',
-                array('EE_Register_Message_Type', 'register_messengers_to_activate_mt_with'),
-                10,
-                2
-            );
-            add_filter(
-                'FHEE__EE_messenger__get_valid_message_types__valid_types',
-                array('EE_Register_Message_Type', 'register_messengers_to_validate_mt_with'),
-                10,
-                2
-            );
-            //actions
-            add_action(
-                'AHEE__EE_Addon__initialize_default_data__begin',
-                array('EE_Register_Message_Type', 'set_defaults')
-            );
+		//make sure this was called in the right place!
+		if (
+			! did_action('EE_Brewing_Regular___messages_caf')
+			|| did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					__('A message type named "%s" has been attempted to be registered with the EE Messages System.  It may or may not work because it should be only called on the "EE_Brewing_Regular___messages_caf" hook.',
+						'event_espresso'),
+					$mt_name
+				),
+				'4.3.0'
+			);
+		}
+		//setup $__ee_message_type_registry array from incoming values.
+		self::$_ee_message_type_registry[$mt_name] = array(
+			/**
+			 * The file name for the message type being registered.
+			 * Required.
+			 * @type string
+			 */
+			'mtfilename'                  => (string)$setup_args['mtfilename'],
+			/**
+			 * Autoload paths for classes used by the message type.
+			 * Required.
+			 * @type array
+			 */
+			'autoloadpaths'               => (array)$setup_args['autoloadpaths'],
+			/**
+			 * Messengers that the message type should be able to activate with.
+			 * Use messenger slugs.
+			 * @type array
+			 */
+			'messengers_to_activate_with' => ! empty($setup_args['messengers_to_activate_with'])
+				? (array)$setup_args['messengers_to_activate_with']
+				: array(),
+			/**
+			 * Messengers that the message type should validate with.
+			 * Use messenger slugs.
+			 * @type array
+			 */
+			'messengers_to_validate_with' => ! empty($setup_args['messengers_to_validate_with'])
+				? (array)$setup_args['messengers_to_validate_with']
+				: array(),
+			/**
+			 * Whether to force activate this message type the first time it is registered.
+			 * @type bool   False means its not activated by default and left up to the end user to activate.
+			 */
+			'force_activation'            => ! empty($setup_args['force_activation'])
+				? (bool)$setup_args['force_activation']
+				: false,
+			/**
+			 * What messengers this message type supports the default template pack for.
+			 * Note: If you do not set this (or any of the following template pack/variation related arguments) to true,
+			 * then it is expected that the message type being registered is doing its own custom default template
+			 * pack/variation registration.
+			 *
+			 * If this is set and has values, then it is expected that the following arguments are also set in the incoming options
+			 * $setup_arguments array as well:
+			 * - 'base_path_for_default_templates'
+			 *
+			 * @type array   Expect an array of messengers this supports default template packs for.
+			 */
+			'messengers_supporting_default_template_pack_with' => isset($setup_args['messengers_supporting_default_template_pack_with'])
+				? (array)$setup_args['messengers_supporting_default_template_pack_with']
+				: array(),
+			/**
+			 * The base path where the default templates for this message type can be found.
+			 * @type string
+			 */
+			'base_path_for_default_templates' => isset($setup_args['base_path_for_default_templates'])
+				? $setup_args['base_path_for_default_templates']
+				: '',
+			/**
+			 * The base path where the default variations for this message type can be found.
+			 * @type string
+			 */
+			'base_path_for_default_variation' => isset($setup_args['base_path_for_default_variation'])
+				? $setup_args['base_path_for_default_variation']
+				: '',
+			/**
+			 * The base url for the default variations for this message type.
+			 * @type string
+			 */
+			'base_url_for_default_variation' => isset($setup_args['base_url_for_default_variation'])
+				? $setup_args['base_url_for_default_variation']
+				: ''
+		);
+		//add filters but only if they haven't already been set (these filters only need to be registered ONCE because
+		//the callback handles all registered message types.
+		if ( false === has_filter(
+			'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
+			array('EE_Register_Message_Type', 'register_msgs_autoload_paths')
+		)) {
+			add_filter(
+				'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
+				array('EE_Register_Message_Type', 'register_msgs_autoload_paths'),
+				10
+			);
+			add_filter(
+				'FHEE__EE_messages__get_installed__messagetype_files',
+				array('EE_Register_Message_Type', 'register_messagetype_files'),
+				10,
+				1
+			);
+			add_filter(
+				'FHEE__EE_messenger__get_default_message_types__default_types',
+				array('EE_Register_Message_Type', 'register_messengers_to_activate_mt_with'),
+				10,
+				2
+			);
+			add_filter(
+				'FHEE__EE_messenger__get_valid_message_types__valid_types',
+				array('EE_Register_Message_Type', 'register_messengers_to_validate_mt_with'),
+				10,
+				2
+			);
+			//actions
+			add_action(
+				'AHEE__EE_Addon__initialize_default_data__begin',
+				array('EE_Register_Message_Type', 'set_defaults')
+			);
 
-            //default template packs and variations related
-            add_filter(
-                'FHEE__EE_Messages_Template_Pack_Default__get_supports',
-                array('EE_Register_Message_Type', 'register_default_template_pack_supports')
-            );
-            add_filter(
-                'FHEE__EE_Template_Pack___get_specific_template__filtered_base_path',
-                array('EE_Register_Message_Type', 'register_base_template_path'),
-                10,
-                6
-            );
-            add_filter(
-                'FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url',
-                array('EE_Register_Message_Type', 'register_variation_base_path_or_url'),
-                10,
-                8
-            );
-            add_filter(
-                'FHEE__EE_Messages_Template_Pack__get_variation__base_path',
-                array('EE_Register_Message_Type', 'register_variation_base_path_or_url'),
-                10,
-                8
-            );
-        }
-    }
+			//default template packs and variations related
+			add_filter(
+				'FHEE__EE_Messages_Template_Pack_Default__get_supports',
+				array('EE_Register_Message_Type', 'register_default_template_pack_supports')
+			);
+			add_filter(
+				'FHEE__EE_Template_Pack___get_specific_template__filtered_base_path',
+				array('EE_Register_Message_Type', 'register_base_template_path'),
+				10,
+				6
+			);
+			add_filter(
+				'FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url',
+				array('EE_Register_Message_Type', 'register_variation_base_path_or_url'),
+				10,
+				8
+			);
+			add_filter(
+				'FHEE__EE_Messages_Template_Pack__get_variation__base_path',
+				array('EE_Register_Message_Type', 'register_variation_base_path_or_url'),
+				10,
+				8
+			);
+		}
+	}
 
 
-    /**
-     * This just ensures that when an addon registers a message type that on initial activation/reactivation the
-     * defaults the addon sets are taken care of.
-     */
-    public static function set_defaults()
-    {
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+	/**
+	 * This just ensures that when an addon registers a message type that on initial activation/reactivation the
+	 * defaults the addon sets are taken care of.
+	 */
+	public static function set_defaults()
+	{
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
 
-        //for any message types with force activation, let's ensure they are activated
-        foreach (self::$_ee_message_type_registry as $message_type_name => $settings) {
-            if ($settings['force_activation']) {
-                foreach ($settings['messengers_to_activate_with'] as $messenger) {
-                    //DO not force activation if this message type has already been activated in the system
-                    if (! $message_resource_manager->has_message_type_been_activated_for_messenger($message_type_name,
-                        $messenger)
-                    ) {
-                        $message_resource_manager->ensure_message_type_is_active($message_type_name, $messenger);
-                    }
-                }
-            }
-        }
-    }
+		//for any message types with force activation, let's ensure they are activated
+		foreach (self::$_ee_message_type_registry as $message_type_name => $settings) {
+			if ($settings['force_activation']) {
+				foreach ($settings['messengers_to_activate_with'] as $messenger) {
+					//DO not force activation if this message type has already been activated in the system
+					if (! $message_resource_manager->has_message_type_been_activated_for_messenger($message_type_name,
+						$messenger)
+					) {
+						$message_resource_manager->ensure_message_type_is_active($message_type_name, $messenger);
+					}
+				}
+			}
+		}
+	}
 
 
-    /**
-     * This deregisters a message type that was previously registered with a specific message_type_name.
-     *
-     * @since    4.3.0
-     * @param string $message_type_name the name for the message type that was previously registered
-     * @return void
-     */
-    public static function deregister($message_type_name = null)
-    {
-        if (! empty(self::$_ee_message_type_registry[$message_type_name])) {
-            //let's make sure that we remove any place this message type was made active
-            /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-            $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-            //ensures that if this message type is registered again that it retains its previous active state vs
-            //remaining inactive.
-            $Message_Resource_Manager->remove_message_type_has_been_activated_from_all_messengers(
-                $message_type_name,
-                true
-            );
-            $Message_Resource_Manager->deactivate_message_type($message_type_name, false);
-            unset(self::$_ee_message_type_registry[$message_type_name]);
-        }
-    }
+	/**
+	 * This deregisters a message type that was previously registered with a specific message_type_name.
+	 *
+	 * @since    4.3.0
+	 * @param string $message_type_name the name for the message type that was previously registered
+	 * @return void
+	 */
+	public static function deregister($message_type_name = null)
+	{
+		if (! empty(self::$_ee_message_type_registry[$message_type_name])) {
+			//let's make sure that we remove any place this message type was made active
+			/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
+			$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+			//ensures that if this message type is registered again that it retains its previous active state vs
+			//remaining inactive.
+			$Message_Resource_Manager->remove_message_type_has_been_activated_from_all_messengers(
+				$message_type_name,
+				true
+			);
+			$Message_Resource_Manager->deactivate_message_type($message_type_name, false);
+			unset(self::$_ee_message_type_registry[$message_type_name]);
+		}
+	}
 
 
-    /**
-     * callback for FHEE__EE_messages__get_installed__messagetype_files filter.
-     *
-     * @since   4.3.0
-     * @param  array $messagetype_files The current array of message type file names
-     * @return  array                                 Array of message type file names
-     */
-    public static function register_messagetype_files($messagetype_files)
-    {
-        if (empty(self::$_ee_message_type_registry)) {
-            return $messagetype_files;
-        }
-        foreach (self::$_ee_message_type_registry as $mt_reg) {
-            if (empty($mt_reg['mtfilename'])) {
-                continue;
-            }
-            $messagetype_files[] = $mt_reg['mtfilename'];
-        }
-        return $messagetype_files;
-    }
+	/**
+	 * callback for FHEE__EE_messages__get_installed__messagetype_files filter.
+	 *
+	 * @since   4.3.0
+	 * @param  array $messagetype_files The current array of message type file names
+	 * @return  array                                 Array of message type file names
+	 */
+	public static function register_messagetype_files($messagetype_files)
+	{
+		if (empty(self::$_ee_message_type_registry)) {
+			return $messagetype_files;
+		}
+		foreach (self::$_ee_message_type_registry as $mt_reg) {
+			if (empty($mt_reg['mtfilename'])) {
+				continue;
+			}
+			$messagetype_files[] = $mt_reg['mtfilename'];
+		}
+		return $messagetype_files;
+	}
 
 
-    /**
-     * callback for FHEE__EED_Messages___set_messages_paths___MSG_PATHS filter.
-     *
-     * @since    4.3.0
-     * @param array $paths array of paths to be checked by EE_messages autoloader.
-     * @return array
-     */
-    public static function register_msgs_autoload_paths($paths)
-    {
-        if (! empty(self::$_ee_message_type_registry)) {
-            foreach (self::$_ee_message_type_registry as $mt_reg) {
-                if (empty($mt_reg['autoloadpaths'])) {
-                    continue;
-                }
-                $paths = array_merge($paths, $mt_reg['autoloadpaths']);
-            }
-        }
-        return $paths;
-    }
+	/**
+	 * callback for FHEE__EED_Messages___set_messages_paths___MSG_PATHS filter.
+	 *
+	 * @since    4.3.0
+	 * @param array $paths array of paths to be checked by EE_messages autoloader.
+	 * @return array
+	 */
+	public static function register_msgs_autoload_paths($paths)
+	{
+		if (! empty(self::$_ee_message_type_registry)) {
+			foreach (self::$_ee_message_type_registry as $mt_reg) {
+				if (empty($mt_reg['autoloadpaths'])) {
+					continue;
+				}
+				$paths = array_merge($paths, $mt_reg['autoloadpaths']);
+			}
+		}
+		return $paths;
+	}
 
 
-    /**
-     * callback for FHEE__EE_messenger__get_default_message_types__default_types filter.
-     *
-     * @since  4.3.0
-     * @param  array        $default_types  array of message types activated with messenger (
-     *                                      corresponds to the $name property of message type)
-     * @param  EE_messenger $messenger      The EE_messenger the filter is called from.
-     * @return array
-     */
-    public static function register_messengers_to_activate_mt_with($default_types, EE_messenger $messenger)
-    {
-        if (empty(self::$_ee_message_type_registry)) {
-            return $default_types;
-        }
-        foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
-            if (empty($mt_reg['messengers_to_activate_with']) || empty($mt_reg['mtfilename'])) {
-                continue;
-            }
-            // loop through each of the messengers and if it matches the loaded class
-            // then we add this message type to the
-            foreach ($mt_reg['messengers_to_activate_with'] as $msgr) {
-                if ($messenger->name == $msgr) {
-                    $default_types[] = $message_type_name;
-                }
-            }
-        }
+	/**
+	 * callback for FHEE__EE_messenger__get_default_message_types__default_types filter.
+	 *
+	 * @since  4.3.0
+	 * @param  array        $default_types  array of message types activated with messenger (
+	 *                                      corresponds to the $name property of message type)
+	 * @param  EE_messenger $messenger      The EE_messenger the filter is called from.
+	 * @return array
+	 */
+	public static function register_messengers_to_activate_mt_with($default_types, EE_messenger $messenger)
+	{
+		if (empty(self::$_ee_message_type_registry)) {
+			return $default_types;
+		}
+		foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
+			if (empty($mt_reg['messengers_to_activate_with']) || empty($mt_reg['mtfilename'])) {
+				continue;
+			}
+			// loop through each of the messengers and if it matches the loaded class
+			// then we add this message type to the
+			foreach ($mt_reg['messengers_to_activate_with'] as $msgr) {
+				if ($messenger->name == $msgr) {
+					$default_types[] = $message_type_name;
+				}
+			}
+		}
 
-        return $default_types;
-    }
+		return $default_types;
+	}
 
 
-    /**
-     * callback for FHEE__EE_messenger__get_valid_message_types__default_types filter.
-     *
-     * @since   4.3.0
-     * @param  array        $valid_types    array of message types valid with messenger (
-     *                                      corresponds to the $name property of message type)
-     * @param  EE_messenger $messenger      The EE_messenger the filter is called from.
-     * @return  array
-     */
-    public static function register_messengers_to_validate_mt_with($valid_types, EE_messenger $messenger)
-    {
-        if (empty(self::$_ee_message_type_registry)) {
-            return $valid_types;
-        }
-        foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
-            if (empty($mt_reg['messengers_to_validate_with']) || empty($mt_reg['mtfilename'])) {
-                continue;
-            }
-            // loop through each of the messengers and if it matches the loaded class
-            // then we add this message type to the
-            foreach ($mt_reg['messengers_to_validate_with'] as $msgr) {
-                if ($messenger->name == $msgr) {
-                    $valid_types[] = $message_type_name;
-                }
-            }
-        }
+	/**
+	 * callback for FHEE__EE_messenger__get_valid_message_types__default_types filter.
+	 *
+	 * @since   4.3.0
+	 * @param  array        $valid_types    array of message types valid with messenger (
+	 *                                      corresponds to the $name property of message type)
+	 * @param  EE_messenger $messenger      The EE_messenger the filter is called from.
+	 * @return  array
+	 */
+	public static function register_messengers_to_validate_mt_with($valid_types, EE_messenger $messenger)
+	{
+		if (empty(self::$_ee_message_type_registry)) {
+			return $valid_types;
+		}
+		foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
+			if (empty($mt_reg['messengers_to_validate_with']) || empty($mt_reg['mtfilename'])) {
+				continue;
+			}
+			// loop through each of the messengers and if it matches the loaded class
+			// then we add this message type to the
+			foreach ($mt_reg['messengers_to_validate_with'] as $msgr) {
+				if ($messenger->name == $msgr) {
+					$valid_types[] = $message_type_name;
+				}
+			}
+		}
 
-        return $valid_types;
-    }
+		return $valid_types;
+	}
 
 
-    /**
-     * Callback for `FHEE__EE_Messages_Template_Pack_Default__get_supports` filter to register this message type as
-     * supporting the default template pack
-     *
-     * @param array $supports
-     *
-     * @return array
-     */
-    public static function register_default_template_pack_supports($supports)
-    {
-        foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
-            if (empty($mt_reg['messengers_supporting_default_template_pack_with'])) {
-                continue;
-            }
-            foreach ($mt_reg['messengers_supporting_default_template_pack_with'] as $messenger_slug) {
-                $supports[$messenger_slug][] = $message_type_name;
-            }
-        }
-        return $supports;
-    }
+	/**
+	 * Callback for `FHEE__EE_Messages_Template_Pack_Default__get_supports` filter to register this message type as
+	 * supporting the default template pack
+	 *
+	 * @param array $supports
+	 *
+	 * @return array
+	 */
+	public static function register_default_template_pack_supports($supports)
+	{
+		foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
+			if (empty($mt_reg['messengers_supporting_default_template_pack_with'])) {
+				continue;
+			}
+			foreach ($mt_reg['messengers_supporting_default_template_pack_with'] as $messenger_slug) {
+				$supports[$messenger_slug][] = $message_type_name;
+			}
+		}
+		return $supports;
+	}
 
 
-    /**
-     * Callback for FHEE__EE_Template_Pack___get_specific_template__filtered_base_path
-     *
-     * @param string $base_path The original base path for message templates
-     * @param EE_messenger $messenger
-     * @param EE_message_type $message_type
-     * @param string $field  The field requesting a template
-     * @param string $context  The context requesting a template
-     * @param EE_Messages_Template_Pack $template_pack
-     *
-     * @return string
-     */
-    public static function register_base_template_path(
-        $base_path,
-        $messenger,
-        $message_type,
-        $field,
-        $context,
-        $template_pack
-    ) {
-        if (! $template_pack instanceof EE_Messages_Template_Pack_Default
-            || ! $message_type instanceof EE_message_type
-        ) {
-            return $base_path;
-        }
-        foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
-            if ($message_type->name === $message_type_name
-                && ! empty($mt_reg['base_path_for_default_templates'])
-            ) {
-                return $mt_reg['base_path_for_default_templates'];
-            }
-        }
-        return $base_path;
-    }
+	/**
+	 * Callback for FHEE__EE_Template_Pack___get_specific_template__filtered_base_path
+	 *
+	 * @param string $base_path The original base path for message templates
+	 * @param EE_messenger $messenger
+	 * @param EE_message_type $message_type
+	 * @param string $field  The field requesting a template
+	 * @param string $context  The context requesting a template
+	 * @param EE_Messages_Template_Pack $template_pack
+	 *
+	 * @return string
+	 */
+	public static function register_base_template_path(
+		$base_path,
+		$messenger,
+		$message_type,
+		$field,
+		$context,
+		$template_pack
+	) {
+		if (! $template_pack instanceof EE_Messages_Template_Pack_Default
+			|| ! $message_type instanceof EE_message_type
+		) {
+			return $base_path;
+		}
+		foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
+			if ($message_type->name === $message_type_name
+				&& ! empty($mt_reg['base_path_for_default_templates'])
+			) {
+				return $mt_reg['base_path_for_default_templates'];
+			}
+		}
+		return $base_path;
+	}
 
 
-    /**
-     * Callback for FHEE__EE_Messages_Template_Pack__get_variation__base_path and
-     * FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url hooks
-     *
-     * @param string $base_path_or_url       The original incoming base url or path
-     * @param string $messenger_slug      The slug of the messenger the template is being generated for.
-     * @param string $message_type_slug The slug of the message type the template is being generated for.
-     * @param string $type             The "type" of css being requested.
-     * @param string $variation      The variation being requested.
-     * @param string $file_extension What file extension is expected for the variation file.
-     * @param bool $url whether a url or path is being requested.
-     * @param EE_Messages_Template_Pack $template_pack
-     *
-     * @return string
-     */
-    public static function register_variation_base_path_or_url(
-        $base_path_or_url,
-        $messenger_slug,
-        $message_type_slug,
-        $type,
-        $variation,
-        $url,
-        $file_extension,
-        $template_pack
-    ) {
-        if (! $template_pack instanceof EE_Messages_Template_Pack_Default) {
-            return $base_path_or_url;
-        }
-        foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
-            if ($message_type_name === $message_type_slug
-            ) {
-                if ($url
-                    && ! empty($mt_reg['base_url_for_default_variation'])
-                ) {
-                    return $mt_reg['base_url_for_default_variation'];
-                } elseif (! $url
-                    && ! empty($mt_reg['base_path_for_default_variation'])
-                ) {
-                    return $mt_reg['base_path_for_default_variation'];
-                }
-            }
-        }
-        return $base_path_or_url;
-    }
+	/**
+	 * Callback for FHEE__EE_Messages_Template_Pack__get_variation__base_path and
+	 * FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url hooks
+	 *
+	 * @param string $base_path_or_url       The original incoming base url or path
+	 * @param string $messenger_slug      The slug of the messenger the template is being generated for.
+	 * @param string $message_type_slug The slug of the message type the template is being generated for.
+	 * @param string $type             The "type" of css being requested.
+	 * @param string $variation      The variation being requested.
+	 * @param string $file_extension What file extension is expected for the variation file.
+	 * @param bool $url whether a url or path is being requested.
+	 * @param EE_Messages_Template_Pack $template_pack
+	 *
+	 * @return string
+	 */
+	public static function register_variation_base_path_or_url(
+		$base_path_or_url,
+		$messenger_slug,
+		$message_type_slug,
+		$type,
+		$variation,
+		$url,
+		$file_extension,
+		$template_pack
+	) {
+		if (! $template_pack instanceof EE_Messages_Template_Pack_Default) {
+			return $base_path_or_url;
+		}
+		foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
+			if ($message_type_name === $message_type_slug
+			) {
+				if ($url
+					&& ! empty($mt_reg['base_url_for_default_variation'])
+				) {
+					return $mt_reg['base_url_for_default_variation'];
+				} elseif (! $url
+					&& ! empty($mt_reg['base_path_for_default_variation'])
+				) {
+					return $mt_reg['base_path_for_default_variation'];
+				}
+			}
+		}
+		return $base_path_or_url;
+	}
 }

core/services/shortcodes/LegacyShortcodesManager.php

Spacing +13 added lines, -13 removed lines

@@ -117,44 +117,44 @@ 
             // remove last segment
             array_pop($shortcode_path);
             // glue it back together
-            $shortcode_path = implode(DS, $shortcode_path) . DS;
+            $shortcode_path = implode(DS, $shortcode_path).DS;
         } else {
             // we need to generate the filename based off of the folder name
             // grab and sanitize shortcode directory name
             $shortcode = sanitize_key(basename($shortcode_path));
-            $shortcode_path = rtrim($shortcode_path, DS) . DS;
+            $shortcode_path = rtrim($shortcode_path, DS).DS;
         }
         // create classname from shortcode directory or file name
         $shortcode = str_replace(' ', '_', ucwords(str_replace('_', ' ', $shortcode)));
         // add class prefix
-        $shortcode_class = 'EES_' . $shortcode;
+        $shortcode_class = 'EES_'.$shortcode;
         // does the shortcode exist ?
-        if ( ! is_readable($shortcode_path . DS . $shortcode_class . $shortcode_ext)) {
+        if ( ! is_readable($shortcode_path.DS.$shortcode_class.$shortcode_ext)) {
             $msg = sprintf(
                 esc_html__(
                     'The requested %s shortcode file could not be found or is not readable due to file permissions. It should be in %s',
                     'event_espresso'
                 ),
                 $shortcode_class,
-                $shortcode_path . DS . $shortcode_class . $shortcode_ext
+                $shortcode_path.DS.$shortcode_class.$shortcode_ext
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // load the shortcode class file
-        require_once($shortcode_path . $shortcode_class . $shortcode_ext);
+        require_once($shortcode_path.$shortcode_class.$shortcode_ext);
         // verify that class exists
         if ( ! class_exists($shortcode_class)) {
             $msg = sprintf(
                 esc_html__('The requested %s shortcode class does not exist.', 'event_espresso'),
                 $shortcode_class
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         $shortcode = strtoupper($shortcode);
         // add to array of registered shortcodes
-        $this->registry->shortcodes->{$shortcode} = $shortcode_path . $shortcode_class . $shortcode_ext;
+        $this->registry->shortcodes->{$shortcode} = $shortcode_path.$shortcode_class.$shortcode_ext;
         return true;
     }
 
@@ -172,7 +172,7 @@ 
         // cycle thru shortcode folders
         foreach ($this->registry->shortcodes as $shortcode => $shortcode_path) {
             // add class prefix
-            $shortcode_class = 'EES_' . $shortcode;
+            $shortcode_class = 'EES_'.$shortcode;
             // fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
             // which set hooks ?
             if (is_admin()) {
@@ -290,7 +290,7 @@ 
     {
         $has_shortcode = false;
         foreach ($this->registry->shortcodes as $shortcode_class => $shortcode) {
-            if ($load_all || has_shortcode($content, $shortcode_class) ) {
+            if ($load_all || has_shortcode($content, $shortcode_class)) {
                 // load up the shortcode
                 $this->initializeShortcode($shortcode_class);
                 $has_shortcode = true;
@@ -402,7 +402,7 @@ 
      */
     public static function addShortcodeClassPrefix($class_name)
     {
-        return strpos($class_name, 'EES_') === 0 ? $class_name : 'EES_' . $class_name;
+        return strpos($class_name, 'EES_') === 0 ? $class_name : 'EES_'.$class_name;
     }
 
 
@@ -414,7 +414,7 @@ 
     {
         static $shortcode_tags = array();
         if (empty($shortcode_tags)) {
-            $shortcode_tags = array_keys((array)$this->registry->shortcodes);
+            $shortcode_tags = array_keys((array) $this->registry->shortcodes);
         }
         return $shortcode_tags;
     }

Indentation +423 added lines, -423 removed lines

@@ -25,429 +25,429 @@
 class LegacyShortcodesManager
 {
 
-    /**
-     * @var EE_Registry $registry
-     */
-    private $registry;
-
-
-
-
-    /**
-     * LegacyShortcodesManager constructor.
-     *
-     * @param \EE_Registry $registry
-     */
-    public function __construct(EE_Registry $registry)
-    {
-        $this->registry = $registry;
-    }
-
-
-
-    /**
-     * @return EE_Registry
-     */
-    public function registry()
-    {
-        return $this->registry;
-    }
-
-
-
-    /**
-     * registerShortcodes
-     *
-     * @return void
-     */
-    public function registerShortcodes()
-    {
-        $this->registry->shortcodes = $this->getShortcodes();
-    }
-
-
-
-    /**
-     * getShortcodes
-     *
-     * @return array
-     */
-    public function getShortcodes()
-    {
-        // previously this method would glob the shortcodes directory
-        // then filter that list of shortcodes to register,
-        // but now we are going to just supply an empty array.
-        // this allows any shortcodes that have not yet been converted to the new system
-        // to still get loaded and processed, albeit using the same legacy logic as before
-        $shortcodes_to_register = apply_filters(
-            'FHEE__EE_Config__register_shortcodes__shortcodes_to_register',
-            array()
-        );
-        if ( ! empty($shortcodes_to_register)) {
-            // cycle thru shortcode folders
-            foreach ($shortcodes_to_register as $shortcode_path) {
-                // add to list of installed shortcode modules
-                $this->registerShortcode($shortcode_path);
-            }
-        }
-        // filter list of installed modules
-        return apply_filters(
-            'FHEE__EE_Config___register_shortcodes__installed_shortcodes',
-            ! empty($this->registry->shortcodes)
-                ? $this->registry->shortcodes
-                : array()
-        );
-    }
-
-
-
-    /**
-     *    register_shortcode - makes core aware of this shortcode
-     *
-     * @access    public
-     * @param    string $shortcode_path - full path up to and including shortcode folder
-     * @return    bool
-     */
-    public function registerShortcode($shortcode_path = null)
-    {
-        do_action('AHEE__EE_Config__register_shortcode__begin', $shortcode_path);
-        $shortcode_ext = '.shortcode.php';
-        // make all separators match
-        $shortcode_path = str_replace(array('\\', '/'), DS, $shortcode_path);
-        // does the file path INCLUDE the actual file name as part of the path ?
-        if (strpos($shortcode_path, $shortcode_ext) !== false) {
-            // grab shortcode file name from directory name and break apart at dots
-            $shortcode_file = explode('.', basename($shortcode_path));
-            // take first segment from file name pieces and remove class prefix if it exists
-            $shortcode = strpos($shortcode_file[0], 'EES_') === 0
-                ? substr($shortcode_file[0], 4)
-                : $shortcode_file[0];
-            // sanitize shortcode directory name
-            $shortcode = sanitize_key($shortcode);
-            // now we need to rebuild the shortcode path
-            $shortcode_path = explode(DS, $shortcode_path);
-            // remove last segment
-            array_pop($shortcode_path);
-            // glue it back together
-            $shortcode_path = implode(DS, $shortcode_path) . DS;
-        } else {
-            // we need to generate the filename based off of the folder name
-            // grab and sanitize shortcode directory name
-            $shortcode = sanitize_key(basename($shortcode_path));
-            $shortcode_path = rtrim($shortcode_path, DS) . DS;
-        }
-        // create classname from shortcode directory or file name
-        $shortcode = str_replace(' ', '_', ucwords(str_replace('_', ' ', $shortcode)));
-        // add class prefix
-        $shortcode_class = 'EES_' . $shortcode;
-        // does the shortcode exist ?
-        if ( ! is_readable($shortcode_path . DS . $shortcode_class . $shortcode_ext)) {
-            $msg = sprintf(
-                esc_html__(
-                    'The requested %s shortcode file could not be found or is not readable due to file permissions. It should be in %s',
-                    'event_espresso'
-                ),
-                $shortcode_class,
-                $shortcode_path . DS . $shortcode_class . $shortcode_ext
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // load the shortcode class file
-        require_once($shortcode_path . $shortcode_class . $shortcode_ext);
-        // verify that class exists
-        if ( ! class_exists($shortcode_class)) {
-            $msg = sprintf(
-                esc_html__('The requested %s shortcode class does not exist.', 'event_espresso'),
-                $shortcode_class
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        $shortcode = strtoupper($shortcode);
-        // add to array of registered shortcodes
-        $this->registry->shortcodes->{$shortcode} = $shortcode_path . $shortcode_class . $shortcode_ext;
-        return true;
-    }
-
-
-
-    /**
-     *    _initialize_shortcodes
-     *    allow shortcodes to set hooks for the rest of the system
-     *
-     * @access private
-     * @return void
-     */
-    public function addShortcodes()
-    {
-        // cycle thru shortcode folders
-        foreach ($this->registry->shortcodes as $shortcode => $shortcode_path) {
-            // add class prefix
-            $shortcode_class = 'EES_' . $shortcode;
-            // fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
-            // which set hooks ?
-            if (is_admin()) {
-                // fire immediately
-                call_user_func(array($shortcode_class, 'set_hooks_admin'));
-            } else {
-                // delay until other systems are online
-                add_action(
-                    'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons',
-                    array($shortcode_class, 'set_hooks')
-                );
-                // convert classname to UPPERCASE and create WP shortcode.
-                $shortcode_tag = strtoupper($shortcode);
-                // but first check if the shortcode has already
-                // been added before assigning 'fallback_shortcode_processor'
-                if ( ! shortcode_exists($shortcode_tag)) {
-                    // NOTE: this shortcode declaration will get overridden if the shortcode
-                    // is successfully detected in the post content in initializeShortcode()
-                    add_shortcode($shortcode_tag, array($shortcode_class, 'fallback_shortcode_processor'));
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * callback for the WP "get_header" hook point
-     * checks posts for EE shortcodes, and initializes them,
-     * then toggles filter switch that loads core default assets
-     *
-     * @param \WP_Query $wp_query
-     * @return void
-     */
-    public function initializeShortcodes(WP_Query $wp_query)
-    {
-        if (empty($this->registry->shortcodes) || ! $wp_query->is_main_query() || is_admin()) {
-            return;
-        }
-        global $wp;
-        /** @var EE_Front_controller $Front_Controller */
-        $Front_Controller = $this->registry->load_core('Front_Controller', array(), false);
-        do_action('AHEE__EE_Front_Controller__initialize_shortcodes__begin', $wp, $Front_Controller);
-        $Front_Controller->Request_Handler()->set_request_vars();
-        // grab post_name from request
-        $current_post = apply_filters(
-            'FHEE__EE_Front_Controller__initialize_shortcodes__current_post_name',
-            $Front_Controller->Request_Handler()->get('post_name')
-        );
-        $show_on_front = get_option('show_on_front');
-        // if it's not set, then check if frontpage is blog
-        if (empty($current_post)) {
-            // yup.. this is the posts page, prepare to load all shortcode modules
-            $current_post = 'posts';
-            // unless..
-            if ($show_on_front === 'page') {
-                // some other page is set as the homepage
-                $page_on_front = get_option('page_on_front');
-                if ($page_on_front) {
-                    // k now we need to find the post_name for this page
-                    global $wpdb;
-                    $page_on_front = $wpdb->get_var(
-                        $wpdb->prepare(
-                            "SELECT post_name from {$wpdb->posts} WHERE post_type='page' AND post_status NOT IN ('auto-draft', 'inherit', 'trash') AND ID=%d",
-                            $page_on_front
-                        )
-                    );
-                    // set the current post slug to what it actually is
-                    $current_post = $page_on_front ? $page_on_front : $current_post;
-                }
-            }
-        }
-        // in case $current_post is hierarchical like: /parent-page/current-page
-        $current_post = basename($current_post);
-        if (
-            // is current page/post the "blog" page ?
-            $current_post === EE_Config::get_page_for_posts()
-            // or are we on a category page?
-            || (
-                is_array(term_exists($current_post, 'category'))
-                || array_key_exists('category_name', $wp->query_vars)
-            )
-        ) {
-            // initialize all legacy shortcodes
-            $load_assets = $this->parseContentForShortcodes('', true);
-        } else {
-            global $wpdb;
-            $post_content = $wpdb->get_var(
-                $wpdb->prepare(
-                    "SELECT post_content from {$wpdb->posts} WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash') AND post_name=%s",
-                    $current_post
-                )
-            );
-            $load_assets = $this->parseContentForShortcodes($post_content);
-        }
-        if ($load_assets) {
-            $this->registry->REQ->set_espresso_page(true);
-            add_filter('FHEE_load_css', '__return_true');
-            add_filter('FHEE_load_js', '__return_true');
-        }
-        do_action('AHEE__EE_Front_Controller__initialize_shortcodes__end', $Front_Controller);
-    }
-
-
-
-    /**
-     * checks supplied content against list of legacy shortcodes,
-     * then initializes any found shortcodes, and returns true.
-     * returns false if no shortcodes found.
-     *
-     * @param string $content
-     * @param bool   $load_all if true, then ALL active legacy shortcodes will be initialized
-     * @return bool
-     */
-    public function parseContentForShortcodes($content = '', $load_all = false)
-    {
-        $has_shortcode = false;
-        foreach ($this->registry->shortcodes as $shortcode_class => $shortcode) {
-            if ($load_all || has_shortcode($content, $shortcode_class) ) {
-                // load up the shortcode
-                $this->initializeShortcode($shortcode_class);
-                $has_shortcode = true;
-            }
-        }
-        return $has_shortcode;
-    }
-
-
-
-    /**
-     * given a shortcode name, will instantiate the shortcode and call it's run() method
-     *
-     * @param string $shortcode_class
-     * @param WP     $wp
-     */
-    public function initializeShortcode($shortcode_class = '', WP $wp = null)
-    {
-        // don't do anything if shortcode is already initialized
-        if (
-            empty($this->registry->shortcodes->{$shortcode_class})
-            || ! is_string($this->registry->shortcodes->{$shortcode_class})
-        ) {
-            return;
-        }
-        // let's pause to reflect on this...
-        $sc_reflector = new ReflectionClass(LegacyShortcodesManager::addShortcodeClassPrefix($shortcode_class));
-        // ensure that class is actually a shortcode
-        if (
-            defined('WP_DEBUG')
-            && WP_DEBUG === true
-            && ! $sc_reflector->isSubclassOf('EES_Shortcode')
-        ) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The requested %s shortcode is not of the class "EES_Shortcode". Please check your files.',
-                        'event_espresso'
-                    ),
-                    $shortcode_class
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            add_filter('FHEE_run_EE_the_content', '__return_true');
-            return;
-        }
-        global $wp;
-        // and pass the request object to the run method
-        $this->registry->shortcodes->{$shortcode_class} = $sc_reflector->newInstance();
-        // fire the shortcode class's run method, so that it can activate resources
-        $this->registry->shortcodes->{$shortcode_class}->run($wp);
-    }
-
-
-
-    /**
-     * get classname, remove EES_prefix, and convert to UPPERCASE
-     *
-     * @param string $class_name
-     * @return string
-     */
-    public static function generateShortcodeTagFromClassName($class_name)
-    {
-        return strtoupper(str_replace('EES_', '', $class_name));
-    }
-
-
-
-    /**
-     * add EES_prefix and Capitalize words
-     *
-     * @param string $tag
-     * @return string
-     */
-    public static function generateShortcodeClassNameFromTag($tag)
-    {
-        // order of operation runs from inside to out
-        // 5) maybe add prefix
-        return LegacyShortcodesManager::addShortcodeClassPrefix(
-        // 4) find spaces, replace with underscores
-            str_replace(
-                ' ',
-                '_',
-                // 3) capitalize first letter of each word
-                ucwords(
-                // 2) also change to lowercase so ucwords() will work
-                    strtolower(
-                    // 1) find underscores, replace with spaces so ucwords() will work
-                        str_replace(
-                            '_',
-                            ' ',
-                            $tag
-                        )
-                    )
-                )
-            )
-        );
-    }
-
-
-
-    /**
-     * maybe add EES_prefix
-     *
-     * @param string $class_name
-     * @return string
-     */
-    public static function addShortcodeClassPrefix($class_name)
-    {
-        return strpos($class_name, 'EES_') === 0 ? $class_name : 'EES_' . $class_name;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function getEspressoShortcodeTags()
-    {
-        static $shortcode_tags = array();
-        if (empty($shortcode_tags)) {
-            $shortcode_tags = array_keys((array)$this->registry->shortcodes);
-        }
-        return $shortcode_tags;
-    }
-
-
-
-    /**
-     * @param string $content
-     * @return string
-     */
-    public function doShortcode($content)
-    {
-        foreach ($this->getEspressoShortcodeTags() as $shortcode_tag) {
-            if (strpos($content, $shortcode_tag) !== false) {
-                $shortcode_class = LegacyShortcodesManager::generateShortcodeClassNameFromTag($shortcode_tag);
-                $this->initializeShortcode($shortcode_class);
-            }
-        }
-        return do_shortcode($content);
-    }
+	/**
+	 * @var EE_Registry $registry
+	 */
+	private $registry;
+
+
+
+
+	/**
+	 * LegacyShortcodesManager constructor.
+	 *
+	 * @param \EE_Registry $registry
+	 */
+	public function __construct(EE_Registry $registry)
+	{
+		$this->registry = $registry;
+	}
+
+
+
+	/**
+	 * @return EE_Registry
+	 */
+	public function registry()
+	{
+		return $this->registry;
+	}
+
+
+
+	/**
+	 * registerShortcodes
+	 *
+	 * @return void
+	 */
+	public function registerShortcodes()
+	{
+		$this->registry->shortcodes = $this->getShortcodes();
+	}
+
+
+
+	/**
+	 * getShortcodes
+	 *
+	 * @return array
+	 */
+	public function getShortcodes()
+	{
+		// previously this method would glob the shortcodes directory
+		// then filter that list of shortcodes to register,
+		// but now we are going to just supply an empty array.
+		// this allows any shortcodes that have not yet been converted to the new system
+		// to still get loaded and processed, albeit using the same legacy logic as before
+		$shortcodes_to_register = apply_filters(
+			'FHEE__EE_Config__register_shortcodes__shortcodes_to_register',
+			array()
+		);
+		if ( ! empty($shortcodes_to_register)) {
+			// cycle thru shortcode folders
+			foreach ($shortcodes_to_register as $shortcode_path) {
+				// add to list of installed shortcode modules
+				$this->registerShortcode($shortcode_path);
+			}
+		}
+		// filter list of installed modules
+		return apply_filters(
+			'FHEE__EE_Config___register_shortcodes__installed_shortcodes',
+			! empty($this->registry->shortcodes)
+				? $this->registry->shortcodes
+				: array()
+		);
+	}
+
+
+
+	/**
+	 *    register_shortcode - makes core aware of this shortcode
+	 *
+	 * @access    public
+	 * @param    string $shortcode_path - full path up to and including shortcode folder
+	 * @return    bool
+	 */
+	public function registerShortcode($shortcode_path = null)
+	{
+		do_action('AHEE__EE_Config__register_shortcode__begin', $shortcode_path);
+		$shortcode_ext = '.shortcode.php';
+		// make all separators match
+		$shortcode_path = str_replace(array('\\', '/'), DS, $shortcode_path);
+		// does the file path INCLUDE the actual file name as part of the path ?
+		if (strpos($shortcode_path, $shortcode_ext) !== false) {
+			// grab shortcode file name from directory name and break apart at dots
+			$shortcode_file = explode('.', basename($shortcode_path));
+			// take first segment from file name pieces and remove class prefix if it exists
+			$shortcode = strpos($shortcode_file[0], 'EES_') === 0
+				? substr($shortcode_file[0], 4)
+				: $shortcode_file[0];
+			// sanitize shortcode directory name
+			$shortcode = sanitize_key($shortcode);
+			// now we need to rebuild the shortcode path
+			$shortcode_path = explode(DS, $shortcode_path);
+			// remove last segment
+			array_pop($shortcode_path);
+			// glue it back together
+			$shortcode_path = implode(DS, $shortcode_path) . DS;
+		} else {
+			// we need to generate the filename based off of the folder name
+			// grab and sanitize shortcode directory name
+			$shortcode = sanitize_key(basename($shortcode_path));
+			$shortcode_path = rtrim($shortcode_path, DS) . DS;
+		}
+		// create classname from shortcode directory or file name
+		$shortcode = str_replace(' ', '_', ucwords(str_replace('_', ' ', $shortcode)));
+		// add class prefix
+		$shortcode_class = 'EES_' . $shortcode;
+		// does the shortcode exist ?
+		if ( ! is_readable($shortcode_path . DS . $shortcode_class . $shortcode_ext)) {
+			$msg = sprintf(
+				esc_html__(
+					'The requested %s shortcode file could not be found or is not readable due to file permissions. It should be in %s',
+					'event_espresso'
+				),
+				$shortcode_class,
+				$shortcode_path . DS . $shortcode_class . $shortcode_ext
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// load the shortcode class file
+		require_once($shortcode_path . $shortcode_class . $shortcode_ext);
+		// verify that class exists
+		if ( ! class_exists($shortcode_class)) {
+			$msg = sprintf(
+				esc_html__('The requested %s shortcode class does not exist.', 'event_espresso'),
+				$shortcode_class
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		$shortcode = strtoupper($shortcode);
+		// add to array of registered shortcodes
+		$this->registry->shortcodes->{$shortcode} = $shortcode_path . $shortcode_class . $shortcode_ext;
+		return true;
+	}
+
+
+
+	/**
+	 *    _initialize_shortcodes
+	 *    allow shortcodes to set hooks for the rest of the system
+	 *
+	 * @access private
+	 * @return void
+	 */
+	public function addShortcodes()
+	{
+		// cycle thru shortcode folders
+		foreach ($this->registry->shortcodes as $shortcode => $shortcode_path) {
+			// add class prefix
+			$shortcode_class = 'EES_' . $shortcode;
+			// fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
+			// which set hooks ?
+			if (is_admin()) {
+				// fire immediately
+				call_user_func(array($shortcode_class, 'set_hooks_admin'));
+			} else {
+				// delay until other systems are online
+				add_action(
+					'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons',
+					array($shortcode_class, 'set_hooks')
+				);
+				// convert classname to UPPERCASE and create WP shortcode.
+				$shortcode_tag = strtoupper($shortcode);
+				// but first check if the shortcode has already
+				// been added before assigning 'fallback_shortcode_processor'
+				if ( ! shortcode_exists($shortcode_tag)) {
+					// NOTE: this shortcode declaration will get overridden if the shortcode
+					// is successfully detected in the post content in initializeShortcode()
+					add_shortcode($shortcode_tag, array($shortcode_class, 'fallback_shortcode_processor'));
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * callback for the WP "get_header" hook point
+	 * checks posts for EE shortcodes, and initializes them,
+	 * then toggles filter switch that loads core default assets
+	 *
+	 * @param \WP_Query $wp_query
+	 * @return void
+	 */
+	public function initializeShortcodes(WP_Query $wp_query)
+	{
+		if (empty($this->registry->shortcodes) || ! $wp_query->is_main_query() || is_admin()) {
+			return;
+		}
+		global $wp;
+		/** @var EE_Front_controller $Front_Controller */
+		$Front_Controller = $this->registry->load_core('Front_Controller', array(), false);
+		do_action('AHEE__EE_Front_Controller__initialize_shortcodes__begin', $wp, $Front_Controller);
+		$Front_Controller->Request_Handler()->set_request_vars();
+		// grab post_name from request
+		$current_post = apply_filters(
+			'FHEE__EE_Front_Controller__initialize_shortcodes__current_post_name',
+			$Front_Controller->Request_Handler()->get('post_name')
+		);
+		$show_on_front = get_option('show_on_front');
+		// if it's not set, then check if frontpage is blog
+		if (empty($current_post)) {
+			// yup.. this is the posts page, prepare to load all shortcode modules
+			$current_post = 'posts';
+			// unless..
+			if ($show_on_front === 'page') {
+				// some other page is set as the homepage
+				$page_on_front = get_option('page_on_front');
+				if ($page_on_front) {
+					// k now we need to find the post_name for this page
+					global $wpdb;
+					$page_on_front = $wpdb->get_var(
+						$wpdb->prepare(
+							"SELECT post_name from {$wpdb->posts} WHERE post_type='page' AND post_status NOT IN ('auto-draft', 'inherit', 'trash') AND ID=%d",
+							$page_on_front
+						)
+					);
+					// set the current post slug to what it actually is
+					$current_post = $page_on_front ? $page_on_front : $current_post;
+				}
+			}
+		}
+		// in case $current_post is hierarchical like: /parent-page/current-page
+		$current_post = basename($current_post);
+		if (
+			// is current page/post the "blog" page ?
+			$current_post === EE_Config::get_page_for_posts()
+			// or are we on a category page?
+			|| (
+				is_array(term_exists($current_post, 'category'))
+				|| array_key_exists('category_name', $wp->query_vars)
+			)
+		) {
+			// initialize all legacy shortcodes
+			$load_assets = $this->parseContentForShortcodes('', true);
+		} else {
+			global $wpdb;
+			$post_content = $wpdb->get_var(
+				$wpdb->prepare(
+					"SELECT post_content from {$wpdb->posts} WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash') AND post_name=%s",
+					$current_post
+				)
+			);
+			$load_assets = $this->parseContentForShortcodes($post_content);
+		}
+		if ($load_assets) {
+			$this->registry->REQ->set_espresso_page(true);
+			add_filter('FHEE_load_css', '__return_true');
+			add_filter('FHEE_load_js', '__return_true');
+		}
+		do_action('AHEE__EE_Front_Controller__initialize_shortcodes__end', $Front_Controller);
+	}
+
+
+
+	/**
+	 * checks supplied content against list of legacy shortcodes,
+	 * then initializes any found shortcodes, and returns true.
+	 * returns false if no shortcodes found.
+	 *
+	 * @param string $content
+	 * @param bool   $load_all if true, then ALL active legacy shortcodes will be initialized
+	 * @return bool
+	 */
+	public function parseContentForShortcodes($content = '', $load_all = false)
+	{
+		$has_shortcode = false;
+		foreach ($this->registry->shortcodes as $shortcode_class => $shortcode) {
+			if ($load_all || has_shortcode($content, $shortcode_class) ) {
+				// load up the shortcode
+				$this->initializeShortcode($shortcode_class);
+				$has_shortcode = true;
+			}
+		}
+		return $has_shortcode;
+	}
+
+
+
+	/**
+	 * given a shortcode name, will instantiate the shortcode and call it's run() method
+	 *
+	 * @param string $shortcode_class
+	 * @param WP     $wp
+	 */
+	public function initializeShortcode($shortcode_class = '', WP $wp = null)
+	{
+		// don't do anything if shortcode is already initialized
+		if (
+			empty($this->registry->shortcodes->{$shortcode_class})
+			|| ! is_string($this->registry->shortcodes->{$shortcode_class})
+		) {
+			return;
+		}
+		// let's pause to reflect on this...
+		$sc_reflector = new ReflectionClass(LegacyShortcodesManager::addShortcodeClassPrefix($shortcode_class));
+		// ensure that class is actually a shortcode
+		if (
+			defined('WP_DEBUG')
+			&& WP_DEBUG === true
+			&& ! $sc_reflector->isSubclassOf('EES_Shortcode')
+		) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The requested %s shortcode is not of the class "EES_Shortcode". Please check your files.',
+						'event_espresso'
+					),
+					$shortcode_class
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			add_filter('FHEE_run_EE_the_content', '__return_true');
+			return;
+		}
+		global $wp;
+		// and pass the request object to the run method
+		$this->registry->shortcodes->{$shortcode_class} = $sc_reflector->newInstance();
+		// fire the shortcode class's run method, so that it can activate resources
+		$this->registry->shortcodes->{$shortcode_class}->run($wp);
+	}
+
+
+
+	/**
+	 * get classname, remove EES_prefix, and convert to UPPERCASE
+	 *
+	 * @param string $class_name
+	 * @return string
+	 */
+	public static function generateShortcodeTagFromClassName($class_name)
+	{
+		return strtoupper(str_replace('EES_', '', $class_name));
+	}
+
+
+
+	/**
+	 * add EES_prefix and Capitalize words
+	 *
+	 * @param string $tag
+	 * @return string
+	 */
+	public static function generateShortcodeClassNameFromTag($tag)
+	{
+		// order of operation runs from inside to out
+		// 5) maybe add prefix
+		return LegacyShortcodesManager::addShortcodeClassPrefix(
+		// 4) find spaces, replace with underscores
+			str_replace(
+				' ',
+				'_',
+				// 3) capitalize first letter of each word
+				ucwords(
+				// 2) also change to lowercase so ucwords() will work
+					strtolower(
+					// 1) find underscores, replace with spaces so ucwords() will work
+						str_replace(
+							'_',
+							' ',
+							$tag
+						)
+					)
+				)
+			)
+		);
+	}
+
+
+
+	/**
+	 * maybe add EES_prefix
+	 *
+	 * @param string $class_name
+	 * @return string
+	 */
+	public static function addShortcodeClassPrefix($class_name)
+	{
+		return strpos($class_name, 'EES_') === 0 ? $class_name : 'EES_' . $class_name;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function getEspressoShortcodeTags()
+	{
+		static $shortcode_tags = array();
+		if (empty($shortcode_tags)) {
+			$shortcode_tags = array_keys((array)$this->registry->shortcodes);
+		}
+		return $shortcode_tags;
+	}
+
+
+
+	/**
+	 * @param string $content
+	 * @return string
+	 */
+	public function doShortcode($content)
+	{
+		foreach ($this->getEspressoShortcodeTags() as $shortcode_tag) {
+			if (strpos($content, $shortcode_tag) !== false) {
+				$shortcode_class = LegacyShortcodesManager::generateShortcodeClassNameFromTag($shortcode_tag);
+				$this->initializeShortcode($shortcode_class);
+			}
+		}
+		return do_shortcode($content);
+	}
 
 
 

core/EES_Shortcode.shortcode.php

Indentation +68 added lines, -68 removed lines

@@ -20,17 +20,17 @@ 
 
 
 
-    /**
-     * class constructor - should ONLY be instantiated by EE_Front_Controller
-     */
-    final public function __construct()
-    {
-        $shortcode = LegacyShortcodesManager::generateShortcodeTagFromClassName(get_class($this));
-        // assign shortcode to the preferred callback, which overwrites the "fallback shortcode processor" assigned earlier
-        add_shortcode($shortcode, array($this, 'process_shortcode'));
-        // make sure system knows this is an EE page
-        EE_Registry::instance()->REQ->set_espresso_page(true);
-    }
+	/**
+	 * class constructor - should ONLY be instantiated by EE_Front_Controller
+	 */
+	final public function __construct()
+	{
+		$shortcode = LegacyShortcodesManager::generateShortcodeTagFromClassName(get_class($this));
+		// assign shortcode to the preferred callback, which overwrites the "fallback shortcode processor" assigned earlier
+		add_shortcode($shortcode, array($this, 'process_shortcode'));
+		// make sure system knows this is an EE page
+		EE_Registry::instance()->REQ->set_espresso_page(true);
+	}
 
 
 
@@ -77,11 +77,11 @@ 
 		}
 		$shortcode = str_replace( 'EES_', '', strtoupper( $shortcode_class ));
 		$shortcode_obj = isset( EE_Registry::instance()->shortcodes->{$shortcode} )
-            ? EE_Registry::instance()->shortcodes->{$shortcode}
-            : null;
+			? EE_Registry::instance()->shortcodes->{$shortcode}
+			: null;
 		return $shortcode_obj instanceof $shortcode_class || $shortcode_class === 'self'
-            ? $shortcode_obj
-            : new $shortcode_class();
+			? $shortcode_obj
+			: new $shortcode_class();
 	}
 
 
@@ -135,59 +135,59 @@ 
 
 
 
-    /**
-     * Performs basic sanitization on shortcode attributes
-     * Since incoming attributes from the shortcode usage in the WP editor will all be strings,
-     * most attributes will by default be sanitized using the sanitize_text_field() function.
-     * This can be overridden by supplying an array for the $custom_sanitization param,
-     * where keys match keys in your attributes array,
-     * and values represent the sanitization function you wish to be applied to that attribute.
-     * So for example, if you had an integer attribute named "event_id"
-     * that you wanted to be sanitized using absint(),
-     * then you would pass the following for your $custom_sanitization array:
-     *      array('event_id' => 'absint')
-     * all other attributes would be sanitized using the defaults in the switch statement below
-     *
-     * @param array $attributes
-     * @param array $custom_sanitization
-     * @return array
-     */
-    public static function sanitize_attributes(array $attributes, $custom_sanitization = array())
-    {
-        foreach ($attributes as $key => $value) {
-            // is a custom sanitization callback specified ?
-            if ( isset($custom_sanitization[$key])) {
-                $callback = $custom_sanitization[$key];
-                if ($callback === 'skip_sanitization') {
-                    $attributes[$key] = $value;
-                    continue;
-                } else if (function_exists($callback)){
-                    $attributes[$key] = $callback($value);
-                    continue;
-                }
-            }
-            switch (true) {
-                case $value === null :
-                case is_int($value) :
-                case is_float($value) :
-                    // typical booleans
-                case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true) :
-                    $attributes[$key] = $value;
-                    break;
-                case is_string($value) :
-                    $attributes[$key] = sanitize_text_field($value);
-                    break;
-                case is_array($value) :
-                    $attributes[$key] = \EES_Shortcode::sanitize_attributes($value);
-                    break;
-                default :
-                    // only remaining data types are Object and Resource
-                    // which are not allowed as shortcode attributes
-                    $attributes[$key] = null;
-                    break;
-            }
-        }
-        return $attributes;
+	/**
+	 * Performs basic sanitization on shortcode attributes
+	 * Since incoming attributes from the shortcode usage in the WP editor will all be strings,
+	 * most attributes will by default be sanitized using the sanitize_text_field() function.
+	 * This can be overridden by supplying an array for the $custom_sanitization param,
+	 * where keys match keys in your attributes array,
+	 * and values represent the sanitization function you wish to be applied to that attribute.
+	 * So for example, if you had an integer attribute named "event_id"
+	 * that you wanted to be sanitized using absint(),
+	 * then you would pass the following for your $custom_sanitization array:
+	 *      array('event_id' => 'absint')
+	 * all other attributes would be sanitized using the defaults in the switch statement below
+	 *
+	 * @param array $attributes
+	 * @param array $custom_sanitization
+	 * @return array
+	 */
+	public static function sanitize_attributes(array $attributes, $custom_sanitization = array())
+	{
+		foreach ($attributes as $key => $value) {
+			// is a custom sanitization callback specified ?
+			if ( isset($custom_sanitization[$key])) {
+				$callback = $custom_sanitization[$key];
+				if ($callback === 'skip_sanitization') {
+					$attributes[$key] = $value;
+					continue;
+				} else if (function_exists($callback)){
+					$attributes[$key] = $callback($value);
+					continue;
+				}
+			}
+			switch (true) {
+				case $value === null :
+				case is_int($value) :
+				case is_float($value) :
+					// typical booleans
+				case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true) :
+					$attributes[$key] = $value;
+					break;
+				case is_string($value) :
+					$attributes[$key] = sanitize_text_field($value);
+					break;
+				case is_array($value) :
+					$attributes[$key] = \EES_Shortcode::sanitize_attributes($value);
+					break;
+				default :
+					// only remaining data types are Object and Resource
+					// which are not allowed as shortcode attributes
+					$attributes[$key] = null;
+					break;
+			}
+		}
+		return $attributes;
 	}
 
 

Spacing +18 added lines, -18 removed lines

@@ -47,7 +47,7 @@ 
 	 * @param WP $WP
 	 * @return    void
 	 */
-	public abstract function run( WP $WP );
+	public abstract function run(WP $WP);
 
 
 
@@ -59,7 +59,7 @@ 
 	 *  @param		array 	$attributes
 	 *  @return 	mixed
 	 */
-	public abstract function process_shortcode( $attributes = array() );
+	public abstract function process_shortcode($attributes = array());
 
 
 
@@ -70,13 +70,13 @@ 
 	 * @param 	string $shortcode_class
 	 * @return 	\EES_Shortcode
 	 */
-	final public static function instance( $shortcode_class = null ) {
-		$shortcode_class = ! empty( $shortcode_class ) ? $shortcode_class : get_called_class();
-		if ( $shortcode_class === 'EES_Shortcode' || empty( $shortcode_class )) {
+	final public static function instance($shortcode_class = null) {
+		$shortcode_class = ! empty($shortcode_class) ? $shortcode_class : get_called_class();
+		if ($shortcode_class === 'EES_Shortcode' || empty($shortcode_class)) {
 			return null;
 		}
-		$shortcode = str_replace( 'EES_', '', strtoupper( $shortcode_class ));
-		$shortcode_obj = isset( EE_Registry::instance()->shortcodes->{$shortcode} )
+		$shortcode = str_replace('EES_', '', strtoupper($shortcode_class));
+		$shortcode_obj = isset(EE_Registry::instance()->shortcodes->{$shortcode} )
             ? EE_Registry::instance()->shortcodes->{$shortcode}
             : null;
 		return $shortcode_obj instanceof $shortcode_class || $shortcode_class === 'self'
@@ -95,23 +95,23 @@ 
 	 * @param 	$attributes
 	 * @return 	mixed
 	 */
-	final public static function fallback_shortcode_processor( $attributes ) {
-		if ( EE_Maintenance_Mode::disable_frontend_for_maintenance() ) {
+	final public static function fallback_shortcode_processor($attributes) {
+		if (EE_Maintenance_Mode::disable_frontend_for_maintenance()) {
 			return null;
 		}
 		// what shortcode was actually parsed ?
 		$shortcode_class = get_called_class();
 		// notify rest of system that fallback processor was triggered
-		add_filter( 'FHEE__fallback_shortcode_processor__' . $shortcode_class, '__return_true' );
+		add_filter('FHEE__fallback_shortcode_processor__'.$shortcode_class, '__return_true');
 		// get instance of actual shortcode
-		$shortcode_obj = self::instance( $shortcode_class );
+		$shortcode_obj = self::instance($shortcode_class);
 		// verify class
-		if ( $shortcode_obj instanceof EES_Shortcode ) {
+		if ($shortcode_obj instanceof EES_Shortcode) {
 			global $wp;
-			$shortcode_obj->run( $wp );
+			$shortcode_obj->run($wp);
 			// set attributes and run the shortcode
-			$shortcode_obj->_attributes = (array)$attributes;
-			return $shortcode_obj->process_shortcode( $shortcode_obj->_attributes );
+			$shortcode_obj->_attributes = (array) $attributes;
+			return $shortcode_obj->process_shortcode($shortcode_obj->_attributes);
 		} else {
 			return null;
 		}
@@ -127,7 +127,7 @@ 
 	 * @param 	$attributes
 	 * @return 	string
 	 */
-	final public static function invalid_shortcode_processor( $attributes ) {
+	final public static function invalid_shortcode_processor($attributes) {
 		return '';
 	}
 
@@ -156,12 +156,12 @@ 
     {
         foreach ($attributes as $key => $value) {
             // is a custom sanitization callback specified ?
-            if ( isset($custom_sanitization[$key])) {
+            if (isset($custom_sanitization[$key])) {
                 $callback = $custom_sanitization[$key];
                 if ($callback === 'skip_sanitization') {
                     $attributes[$key] = $value;
                     continue;
-                } else if (function_exists($callback)){
+                } else if (function_exists($callback)) {
                     $attributes[$key] = $callback($value);
                     continue;
                 }

core/domain/entities/shortcodes/EspressoEvents.php

Spacing +1 added lines, -1 removed lines

@@ -108,7 +108,7 @@
     private function getAttributes(array $attributes)
     {
         return array_merge(
-            (array)apply_filters(
+            (array) apply_filters(
                 'EES_Espresso_Events__process_shortcode__default_espresso_events_shortcode_atts',
                 array(
                     'title'         => '',

Indentation +133 added lines, -133 removed lines

@@ -34,139 +34,139 @@
 
 
 
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_EVENTS';
-    }
-
-
-
-    /**
-     * the time in seconds to cache the results of the processShortcode() method
-     * 0 means the processShortcode() results will NOT be cached at all
-     *
-     * @return int
-     */
-    public function cacheExpiration()
-    {
-        return 0;
-    }
-
-
-
-    /**
-     * a place for adding any initialization code that needs to run prior to wp_header().
-     * this may be required for shortcodes that utilize a corresponding module,
-     * and need to enqueue assets for that module
-     *
-     * @return void
-     */
-    public function initializeShortcode()
-    {
-        EED_Events_Archive::instance()->event_list();
-        $this->shortcodeHasBeenInitialized();
-    }
-
-
-
-    /**
-     * callback that runs when the shortcode is encountered in post content.
-     * IMPORTANT !!!
-     * remember that shortcode content should be RETURNED and NOT echoed out
-     *
-     * @param array $attributes
-     * @return string
-     */
-    public function processShortcode($attributes = array())
-    {
-        // grab attributes and merge with defaults
-        $attributes = $this->getAttributes($attributes);
-        // make sure we use the_excerpt()
-        add_filter('FHEE__EES_Espresso_Events__process_shortcode__true', '__return_true');
-        // apply query filters
-        add_filter('FHEE__EEH_Event_Query__apply_query_filters', '__return_true');
-        // run the query
-        global $wp_query;
-        // yes we have to overwrite the main wp query, but it's ok...
-        // we're going to reset it again below, so everything will be Hunky Dory (amazing album)
-        $wp_query = new EventListQuery($attributes);
-        // check what template is loaded and load filters accordingly
-        EED_Events_Archive::instance()->template_include('loop-espresso_events.php');
-        // load our template
-        $event_list = EEH_Template::locate_template(
-            'loop-espresso_events.php',
-            array(),
-            true,
-            true
-        );
-        // now reset the query and post data
-        wp_reset_query();
-        wp_reset_postdata();
-        EED_Events_Archive::remove_all_events_archive_filters();
-        // remove query filters
-        remove_filter('FHEE__EEH_Event_Query__apply_query_filters', '__return_true');
-        // pull our content from the output buffer and return it
-        return $event_list;
-    }
-
-
-
-    /**
-     * merge incoming attributes with filtered defaults
-     *
-     * @param array $attributes
-     * @return array
-     */
-    private function getAttributes(array $attributes)
-    {
-        return array_merge(
-            (array)apply_filters(
-                'EES_Espresso_Events__process_shortcode__default_espresso_events_shortcode_atts',
-                array(
-                    'title'         => '',
-                    'limit'         => 10,
-                    'css_class'     => '',
-                    'show_expired'  => false,
-                    'month'         => '',
-                    'category_slug' => '',
-                    'order_by'      => 'start_date',
-                    'sort'          => 'ASC',
-                    'show_title'    => true,
-                )
-            ),
-            $attributes
-        );
-    }
-
-
-
-    /**
-     * array for defining custom attribute sanitization callbacks,
-     * where keys match keys in your attributes array,
-     * and values represent the sanitization function you wish to be applied to that attribute.
-     * So for example, if you had an integer attribute named "event_id"
-     * that you wanted to be sanitized using absint(),
-     * then you would pass the following for your $custom_sanitization array:
-     *      array('event_id' => 'absint')
-     *
-     * @return array
-     */
-    protected function customAttributeSanitizationMap()
-    {
-        // the following get sanitized/whitelisted in EEH_Event_Query
-        return array(
-            'category_slug' => 'skip_sanitization',
-            'show_expired'  => 'skip_sanitization',
-            'order_by'      => 'skip_sanitization',
-            'month'         => 'skip_sanitization',
-            'sort'          => 'skip_sanitization',
-        );
-    }
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag()
+	{
+		return 'ESPRESSO_EVENTS';
+	}
+
+
+
+	/**
+	 * the time in seconds to cache the results of the processShortcode() method
+	 * 0 means the processShortcode() results will NOT be cached at all
+	 *
+	 * @return int
+	 */
+	public function cacheExpiration()
+	{
+		return 0;
+	}
+
+
+
+	/**
+	 * a place for adding any initialization code that needs to run prior to wp_header().
+	 * this may be required for shortcodes that utilize a corresponding module,
+	 * and need to enqueue assets for that module
+	 *
+	 * @return void
+	 */
+	public function initializeShortcode()
+	{
+		EED_Events_Archive::instance()->event_list();
+		$this->shortcodeHasBeenInitialized();
+	}
+
+
+
+	/**
+	 * callback that runs when the shortcode is encountered in post content.
+	 * IMPORTANT !!!
+	 * remember that shortcode content should be RETURNED and NOT echoed out
+	 *
+	 * @param array $attributes
+	 * @return string
+	 */
+	public function processShortcode($attributes = array())
+	{
+		// grab attributes and merge with defaults
+		$attributes = $this->getAttributes($attributes);
+		// make sure we use the_excerpt()
+		add_filter('FHEE__EES_Espresso_Events__process_shortcode__true', '__return_true');
+		// apply query filters
+		add_filter('FHEE__EEH_Event_Query__apply_query_filters', '__return_true');
+		// run the query
+		global $wp_query;
+		// yes we have to overwrite the main wp query, but it's ok...
+		// we're going to reset it again below, so everything will be Hunky Dory (amazing album)
+		$wp_query = new EventListQuery($attributes);
+		// check what template is loaded and load filters accordingly
+		EED_Events_Archive::instance()->template_include('loop-espresso_events.php');
+		// load our template
+		$event_list = EEH_Template::locate_template(
+			'loop-espresso_events.php',
+			array(),
+			true,
+			true
+		);
+		// now reset the query and post data
+		wp_reset_query();
+		wp_reset_postdata();
+		EED_Events_Archive::remove_all_events_archive_filters();
+		// remove query filters
+		remove_filter('FHEE__EEH_Event_Query__apply_query_filters', '__return_true');
+		// pull our content from the output buffer and return it
+		return $event_list;
+	}
+
+
+
+	/**
+	 * merge incoming attributes with filtered defaults
+	 *
+	 * @param array $attributes
+	 * @return array
+	 */
+	private function getAttributes(array $attributes)
+	{
+		return array_merge(
+			(array)apply_filters(
+				'EES_Espresso_Events__process_shortcode__default_espresso_events_shortcode_atts',
+				array(
+					'title'         => '',
+					'limit'         => 10,
+					'css_class'     => '',
+					'show_expired'  => false,
+					'month'         => '',
+					'category_slug' => '',
+					'order_by'      => 'start_date',
+					'sort'          => 'ASC',
+					'show_title'    => true,
+				)
+			),
+			$attributes
+		);
+	}
+
+
+
+	/**
+	 * array for defining custom attribute sanitization callbacks,
+	 * where keys match keys in your attributes array,
+	 * and values represent the sanitization function you wish to be applied to that attribute.
+	 * So for example, if you had an integer attribute named "event_id"
+	 * that you wanted to be sanitized using absint(),
+	 * then you would pass the following for your $custom_sanitization array:
+	 *      array('event_id' => 'absint')
+	 *
+	 * @return array
+	 */
+	protected function customAttributeSanitizationMap()
+	{
+		// the following get sanitized/whitelisted in EEH_Event_Query
+		return array(
+			'category_slug' => 'skip_sanitization',
+			'show_expired'  => 'skip_sanitization',
+			'order_by'      => 'skip_sanitization',
+			'month'         => 'skip_sanitization',
+			'sort'          => 'skip_sanitization',
+		);
+	}
 
 
 

core/services/commands/ticket/CreateTicketLineItemCommandHandler.php

Spacing +5 added lines, -5 removed lines

@@ -6,8 +6,8 @@ 
 use EventEspresso\core\services\commands\CommandHandler;
 use EventEspresso\core\services\commands\CommandInterface;
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -49,10 +49,10 @@ 
 	 * @throws \EventEspresso\core\exceptions\UnexpectedEntityException
 	 * @throws \EE_Error
 	 */
-	public function handle( CommandInterface $command ) {
+	public function handle(CommandInterface $command) {
 		/** @var CreateTicketLineItemCommand $command */
-		if ( ! $command instanceof CreateTicketLineItemCommand ) {
-			throw new InvalidEntityException( get_class( $command ), 'CreateTicketLineItemCommand' );
+		if ( ! $command instanceof CreateTicketLineItemCommand) {
+			throw new InvalidEntityException(get_class($command), 'CreateTicketLineItemCommand');
 		}
 		// create new line item for ticket
 		return $this->factory->create(

core/db_classes/EE_Payment.class.php

Spacing +104 added lines, -104 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');
 }
 
 /**
@@ -20,9 +20,9 @@ 
 	 * @return EE_Payment
 	 * @throws \EE_Error
 	 */
-	public static function new_instance( $props_n_values = array(), $timezone = null, $date_formats = array() ) {
-		$has_object = parent::_check_for_object( $props_n_values, __CLASS__, $timezone, $date_formats );
-		return $has_object ? $has_object : new self( $props_n_values, false, $timezone, $date_formats );
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) {
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
 	}
 
 
@@ -34,8 +34,8 @@ 
 	 * @return EE_Payment
 	 * @throws \EE_Error
 	 */
-	public static function new_instance_from_db( $props_n_values = array(), $timezone = null ) {
-		return new self( $props_n_values, true, $timezone );
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null) {
+		return new self($props_n_values, true, $timezone);
 	}
 
 
@@ -47,8 +47,8 @@ 
 	 * @param int $TXN_ID
 	 * @throws \EE_Error
 	 */
-	public function set_transaction_id( $TXN_ID = 0 ) {
-		$this->set( 'TXN_ID', $TXN_ID );
+	public function set_transaction_id($TXN_ID = 0) {
+		$this->set('TXN_ID', $TXN_ID);
 	}
 
 
@@ -60,7 +60,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function transaction() {
-		return $this->get_first_related( 'Transaction' );
+		return $this->get_first_related('Transaction');
 	}
 
 
@@ -72,8 +72,8 @@ 
 	 * @param string $STS_ID
 	 * @throws \EE_Error
 	 */
-	public function set_status( $STS_ID = '' ) {
-		$this->set( 'STS_ID', $STS_ID );
+	public function set_status($STS_ID = '') {
+		$this->set('STS_ID', $STS_ID);
 	}
 
 
@@ -85,8 +85,8 @@ 
 	 * @param int $timestamp
 	 * @throws \EE_Error
 	 */
-	public function set_timestamp( $timestamp = 0 ) {
-		$this->set( 'PAY_timestamp', $timestamp );
+	public function set_timestamp($timestamp = 0) {
+		$this->set('PAY_timestamp', $timestamp);
 	}
 
 
@@ -98,8 +98,8 @@ 
 	 * @param string $PAY_source
 	 * @throws \EE_Error
 	 */
-	public function set_source( $PAY_source = '' ) {
-		$this->set( 'PAY_source', $PAY_source );
+	public function set_source($PAY_source = '') {
+		$this->set('PAY_source', $PAY_source);
 	}
 
 
@@ -111,8 +111,8 @@ 
 	 * @param float $amount
 	 * @throws \EE_Error
 	 */
-	public function set_amount( $amount = 0.00 ) {
-		$this->set( 'PAY_amount', (float)$amount );
+	public function set_amount($amount = 0.00) {
+		$this->set('PAY_amount', (float) $amount);
 	}
 
 
@@ -124,8 +124,8 @@ 
 	 * @param string $gateway_response
 	 * @throws \EE_Error
 	 */
-	public function set_gateway_response( $gateway_response = '' ) {
-		$this->set( 'PAY_gateway_response', $gateway_response );
+	public function set_gateway_response($gateway_response = '') {
+		$this->set('PAY_gateway_response', $gateway_response);
 	}
 
 
@@ -148,7 +148,7 @@ 
 			),
 			'4.6.0'
 		);
-		return $this->payment_method() ? $this->payment_method()->name() : __( 'Unknown', 'event_espresso' );
+		return $this->payment_method() ? $this->payment_method()->name() : __('Unknown', 'event_espresso');
 	}
 
 
@@ -160,8 +160,8 @@ 
 	 * @param string $txn_id_chq_nmbr
 	 * @throws \EE_Error
 	 */
-	public function set_txn_id_chq_nmbr( $txn_id_chq_nmbr = '' ) {
-		$this->set( 'PAY_txn_id_chq_nmbr', $txn_id_chq_nmbr );
+	public function set_txn_id_chq_nmbr($txn_id_chq_nmbr = '') {
+		$this->set('PAY_txn_id_chq_nmbr', $txn_id_chq_nmbr);
 	}
 
 
@@ -173,8 +173,8 @@ 
 	 * @param string $po_number
 	 * @throws \EE_Error
 	 */
-	public function set_po_number( $po_number = '' ) {
-		$this->set( 'PAY_po_number', $po_number );
+	public function set_po_number($po_number = '') {
+		$this->set('PAY_po_number', $po_number);
 	}
 
 
@@ -186,8 +186,8 @@ 
 	 * @param string $extra_accntng
 	 * @throws \EE_Error
 	 */
-	public function set_extra_accntng( $extra_accntng = '' ) {
-		$this->set( 'PAY_extra_accntng', $extra_accntng );
+	public function set_extra_accntng($extra_accntng = '') {
+		$this->set('PAY_extra_accntng', $extra_accntng);
 	}
 
 
@@ -199,11 +199,11 @@ 
 	 * @param bool $via_admin
 	 * @throws \EE_Error
 	 */
-	public function set_payment_made_via_admin( $via_admin = false ) {
-		if ( $via_admin ) {
-			$this->set( 'PAY_source', EEM_Payment_Method::scope_admin );
+	public function set_payment_made_via_admin($via_admin = false) {
+		if ($via_admin) {
+			$this->set('PAY_source', EEM_Payment_Method::scope_admin);
 		} else {
-			$this->set( 'PAY_source', EEM_Payment_Method::scope_cart );
+			$this->set('PAY_source', EEM_Payment_Method::scope_cart);
 		}
 	}
 
@@ -216,13 +216,13 @@ 
 	 * @param string|array $details
 	 * @throws \EE_Error
 	 */
-	public function set_details( $details = '' ) {
-		if ( is_array( $details ) ) {
-			array_walk_recursive( $details, array( $this, '_strip_all_tags_within_array' ) );
+	public function set_details($details = '') {
+		if (is_array($details)) {
+			array_walk_recursive($details, array($this, '_strip_all_tags_within_array'));
 		} else {
-			$details = wp_strip_all_tags( $details );
+			$details = wp_strip_all_tags($details);
 		}
-		$this->set( 'PAY_details', $details );
+		$this->set('PAY_details', $details);
 	}
 
 
@@ -233,8 +233,8 @@ 
 	 * @param string $redirect_url
 	 * @throws \EE_Error
 	 */
-	public function set_redirect_url( $redirect_url ) {
-		$this->set( 'PAY_redirect_url', $redirect_url );
+	public function set_redirect_url($redirect_url) {
+		$this->set('PAY_redirect_url', $redirect_url);
 	}
 
 
@@ -245,8 +245,8 @@ 
 	 * @param array $redirect_args
 	 * @throws \EE_Error
 	 */
-	public function set_redirect_args( $redirect_args ) {
-		$this->set( 'PAY_redirect_args', $redirect_args );
+	public function set_redirect_args($redirect_args) {
+		$this->set('PAY_redirect_args', $redirect_args);
 	}
 
 
@@ -258,7 +258,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function TXN_ID() {
-		return $this->get( 'TXN_ID' );
+		return $this->get('TXN_ID');
 	}
 
 
@@ -270,7 +270,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function status() {
-		return $this->get( 'STS_ID' );
+		return $this->get('STS_ID');
 	}
 
 
@@ -282,7 +282,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function STS_ID() {
-		return $this->get( 'STS_ID' );
+		return $this->get('STS_ID');
 	}
 
 
@@ -296,8 +296,8 @@ 
 	 * @return string
 	 * @throws \EE_Error
 	 */
-	public function timestamp( $dt_frmt = '', $tm_frmt = '' ) {
-		return $this->get_i18n_datetime( 'PAY_timestamp', trim( $dt_frmt . ' ' . $tm_frmt) );
+	public function timestamp($dt_frmt = '', $tm_frmt = '') {
+		return $this->get_i18n_datetime('PAY_timestamp', trim($dt_frmt.' '.$tm_frmt));
 	}
 
 
@@ -309,7 +309,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function source() {
-		return $this->get( 'PAY_source' );
+		return $this->get('PAY_source');
 	}
 
 
@@ -322,7 +322,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function amount() {
-		return (float)$this->get( 'PAY_amount' );
+		return (float) $this->get('PAY_amount');
 	}
 
 
@@ -332,7 +332,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function amount_no_code() {
-		return $this->get_pretty( 'PAY_amount', 'no_currency_code' );
+		return $this->get_pretty('PAY_amount', 'no_currency_code');
 	}
 
 
@@ -344,7 +344,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function gateway_response() {
-		return $this->get( 'PAY_gateway_response' );
+		return $this->get('PAY_gateway_response');
 	}
 
 
@@ -356,7 +356,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function txn_id_chq_nmbr() {
-		return $this->get( 'PAY_txn_id_chq_nmbr' );
+		return $this->get('PAY_txn_id_chq_nmbr');
 	}
 
 
@@ -368,7 +368,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function po_number() {
-		return $this->get( 'PAY_po_number' );
+		return $this->get('PAY_po_number');
 	}
 
 
@@ -380,7 +380,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function extra_accntng() {
-		return $this->get( 'PAY_extra_accntng' );
+		return $this->get('PAY_extra_accntng');
 	}
 
 
@@ -392,7 +392,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function payment_made_via_admin() {
-		return ( $this->get( 'PAY_source' ) === EEM_Payment_Method::scope_admin );
+		return ($this->get('PAY_source') === EEM_Payment_Method::scope_admin);
 	}
 
 
@@ -404,7 +404,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function details() {
-		return $this->get( 'PAY_details' );
+		return $this->get('PAY_details');
 	}
 
 
@@ -416,7 +416,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function redirect_url() {
-		return $this->get( 'PAY_redirect_url' );
+		return $this->get('PAY_redirect_url');
 	}
 
 
@@ -428,7 +428,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function redirect_args() {
-		return $this->get( 'PAY_redirect_args' );
+		return $this->get('PAY_redirect_args');
 	}
 
 
@@ -440,8 +440,8 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	public function e_pretty_status( $show_icons = false ) {
-		echo $this->pretty_status( $show_icons );
+	public function e_pretty_status($show_icons = false) {
+		echo $this->pretty_status($show_icons);
 	}
 
 
@@ -453,14 +453,14 @@ 
 	 * @return string
 	 * @throws \EE_Error
 	 */
-	public function pretty_status( $show_icons = false ) {
+	public function pretty_status($show_icons = false) {
 		$status = EEM_Status::instance()->localized_status(
-			array( $this->STS_ID() => __( 'unknown', 'event_espresso' ) ),
+			array($this->STS_ID() => __('unknown', 'event_espresso')),
 			false,
 			'sentence'
 		);
 		$icon = '';
-		switch ( $this->STS_ID() ) {
+		switch ($this->STS_ID()) {
 			case EEM_Payment::status_id_approved:
 				$icon = $show_icons
 					? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>'
@@ -482,7 +482,7 @@ 
 					: '';
 				break;
 		}
-		return $icon . $status[ $this->STS_ID() ];
+		return $icon.$status[$this->STS_ID()];
 	}
 
 
@@ -494,7 +494,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function is_approved() {
-		return $this->status_is( EEM_Payment::status_id_approved );
+		return $this->status_is(EEM_Payment::status_id_approved);
 	}
 
 
@@ -508,7 +508,7 @@ 
 	 * @return boolean whether the status of this payment equals the status id
 	 * @throws \EE_Error
 	 */
-	protected function status_is( $STS_ID ) {
+	protected function status_is($STS_ID) {
 		return $STS_ID === $this->STS_ID() ? true : false;
 	}
 
@@ -521,7 +521,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function is_pending() {
-		return $this->status_is( EEM_Payment::status_id_pending );
+		return $this->status_is(EEM_Payment::status_id_pending);
 	}
 
 
@@ -533,7 +533,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function is_cancelled() {
-		return $this->status_is( EEM_Payment::status_id_cancelled );
+		return $this->status_is(EEM_Payment::status_id_cancelled);
 	}
 
 
@@ -545,7 +545,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function is_declined() {
-		return $this->status_is( EEM_Payment::status_id_declined );
+		return $this->status_is(EEM_Payment::status_id_declined);
 	}
 
 
@@ -557,7 +557,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function is_failed() {
-		return $this->status_is( EEM_Payment::status_id_failed );
+		return $this->status_is(EEM_Payment::status_id_failed);
 	}
 
 
@@ -581,7 +581,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function status_obj() {
-		return $this->get_first_related( 'Status' );
+		return $this->get_first_related('Status');
 	}
 
 
@@ -593,8 +593,8 @@ 
 	 * @return EE_Extra_Meta
 	 * @throws \EE_Error
 	 */
-	public function extra_meta( $query_params = array() ) {
-		return $this->get_many_related( 'Extra_Meta', $query_params );
+	public function extra_meta($query_params = array()) {
+		return $this->get_many_related('Extra_Meta', $query_params);
 	}
 
 
@@ -608,7 +608,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function payment_method() {
-		return $this->get_first_related( 'Payment_Method' );
+		return $this->get_first_related('Payment_Method');
 	}
 
 
@@ -626,18 +626,18 @@ 
 	 * @return string html
 	 * @throws \EE_Error
 	 */
-	public function redirect_form( $inside_form_html = null ) {
+	public function redirect_form($inside_form_html = null) {
 		$redirect_url = $this->redirect_url();
-		if ( ! empty( $redirect_url ) ) {
+		if ( ! empty($redirect_url)) {
 			// what ? no inner form content?
-			if ( $inside_form_html === null ) {
+			if ($inside_form_html === null) {
 				$inside_form_html = EEH_HTML::p(
 					sprintf(
 						__(
 							'If you are not automatically redirected to the payment website within 10 seconds... %1$s %2$s Click Here %3$s',
 							'event_espresso'
 						),
-						EEH_HTML::br( 2 ),
+						EEH_HTML::br(2),
 						'<input type="submit" value="',
 						'">'
 					),
@@ -653,22 +653,22 @@ 
 			);
 			//if it's a GET request, we need to remove all the GET params in the querystring
 			//and put them into the form instead
-			if ( $method === 'GET' ) {
-				$querystring = parse_url( $redirect_url, PHP_URL_QUERY );
+			if ($method === 'GET') {
+				$querystring = parse_url($redirect_url, PHP_URL_QUERY);
 				$get_params = null;
-				parse_str( $querystring, $get_params );
-				$inside_form_html .= $this->_args_as_inputs( $get_params );
-				$redirect_url = str_replace( '?' . $querystring, '', $redirect_url );
+				parse_str($querystring, $get_params);
+				$inside_form_html .= $this->_args_as_inputs($get_params);
+				$redirect_url = str_replace('?'.$querystring, '', $redirect_url);
 			}
-			$form = EEH_HTML::nl( 1 )
+			$form = EEH_HTML::nl(1)
 			        . '<form method="'
 			        . $method
 			        . '" name="gateway_form" action="'
 			        . $redirect_url
 			        . '">';
-			$form .= EEH_HTML::nl( 1 ) . $this->redirect_args_as_inputs();
+			$form .= EEH_HTML::nl(1).$this->redirect_args_as_inputs();
 			$form .= $inside_form_html;
-			$form .= EEH_HTML::nl( -1 ) . '</form>' . EEH_HTML::nl( -1 );
+			$form .= EEH_HTML::nl( -1 ).'</form>'.EEH_HTML::nl( -1 );
 			return $form;
 		} else {
 			return null;
@@ -685,7 +685,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function redirect_args_as_inputs() {
-		return $this->_args_as_inputs( $this->redirect_args() );
+		return $this->_args_as_inputs($this->redirect_args());
 	}
 
 
@@ -697,15 +697,15 @@ 
 	 * @param array $args key-value pairs
 	 * @return string
 	 */
-	protected function _args_as_inputs( $args ) {
+	protected function _args_as_inputs($args) {
 		$html = '';
-		if ( $args !== null && is_array( $args ) ) {
-			foreach ( $args as $name => $value ) {
-				$html .= EEH_HTML::nl( 0 )
+		if ($args !== null && is_array($args)) {
+			foreach ($args as $name => $value) {
+				$html .= EEH_HTML::nl(0)
 				         . '<input type="hidden" name="'
 				         . $name
 				         . '" value="'
-				         . esc_attr( $value )
+				         . esc_attr($value)
 				         . '"/>';
 			}
 		}
@@ -734,14 +734,14 @@ 
 	 * @access private
 	 * @param mixed $item
 	 */
-	private function _strip_all_tags_within_array( &$item ) {
-		if ( is_object( $item ) ) {
-			$item = (array)$item;
+	private function _strip_all_tags_within_array(&$item) {
+		if (is_object($item)) {
+			$item = (array) $item;
 		}
-		if ( is_array( $item ) ) {
-			array_walk_recursive( $item, array( $this, '_strip_all_tags_within_array' ) );
+		if (is_array($item)) {
+			array_walk_recursive($item, array($this, '_strip_all_tags_within_array'));
 		} else {
-			$item = wp_strip_all_tags( $item );
+			$item = wp_strip_all_tags($item);
 		}
 	}
 
@@ -758,7 +758,7 @@ 
 		$original_status = EEH_Array::is_set(
 			$this->_props_n_values_provided_in_constructor,
 			'STS_ID',
-			$this->get_model()->field_settings_for( 'STS_ID' )->get_default_value()
+			$this->get_model()->field_settings_for('STS_ID')->get_default_value()
 		);
 		$current_status = $this->status();
 		if (
@@ -784,11 +784,11 @@ 
 	 * @return mixed
 	 * @throws \EE_Error
 	 */
-	public function get_pretty( $field_name, $extra_cache_ref = null ) {
-		if ( $field_name === 'PAY_gateway' ) {
-			return $this->payment_method() ? $this->payment_method()->name() : __( 'Unknown', 'event_espresso' );
+	public function get_pretty($field_name, $extra_cache_ref = null) {
+		if ($field_name === 'PAY_gateway') {
+			return $this->payment_method() ? $this->payment_method()->name() : __('Unknown', 'event_espresso');
 		}
-		return $this->_get_cached_property( $field_name, true, $extra_cache_ref );
+		return $this->_get_cached_property($field_name, true, $extra_cache_ref);
 	}
 
 
@@ -800,8 +800,8 @@ 
 	 * @return EE_Registration_Payment[]
 	 * @throws \EE_Error
 	 */
-	public function registration_payments( $query_params = array() ) {
-		return $this->get_many_related( 'Registration_Payment', $query_params );
+	public function registration_payments($query_params = array()) {
+		return $this->get_many_related('Registration_Payment', $query_params);
 	}
 
 
@@ -862,7 +862,7 @@ 
     public function get_primary_attendee()
     {
         $primary_reg = $this->get_primary_registration();
-        if( $primary_reg instanceof EE_Registration) {
+        if ($primary_reg instanceof EE_Registration) {
             return $primary_reg->attendee();
         }
         return null;

Indentation +68 added lines, -68 removed lines

@@ -661,11 +661,11 @@ 
 				$redirect_url = str_replace( '?' . $querystring, '', $redirect_url );
 			}
 			$form = EEH_HTML::nl( 1 )
-			        . '<form method="'
-			        . $method
-			        . '" name="gateway_form" action="'
-			        . $redirect_url
-			        . '">';
+					. '<form method="'
+					. $method
+					. '" name="gateway_form" action="'
+					. $redirect_url
+					. '">';
 			$form .= EEH_HTML::nl( 1 ) . $this->redirect_args_as_inputs();
 			$form .= $inside_form_html;
 			$form .= EEH_HTML::nl( -1 ) . '</form>' . EEH_HTML::nl( -1 );
@@ -702,11 +702,11 @@ 
 		if ( $args !== null && is_array( $args ) ) {
 			foreach ( $args as $name => $value ) {
 				$html .= EEH_HTML::nl( 0 )
-				         . '<input type="hidden" name="'
-				         . $name
-				         . '" value="'
-				         . esc_attr( $value )
-				         . '"/>';
+						 . '<input type="hidden" name="'
+						 . $name
+						 . '" value="'
+						 . esc_attr( $value )
+						 . '"/>';
 			}
 		}
 		return $html;
@@ -806,64 +806,64 @@ 
 
 
 
-    /**
-     * Gets the first event for this payment (it's possible that it could be for multiple)
-     *
-     * @return EE_Event|null
-     */
-    public function get_first_event()
-    {
-        $transaction = $this->transaction();
-        if ($transaction instanceof EE_Transaction) {
-            $primary_registrant = $transaction->primary_registration();
-            if ($primary_registrant instanceof EE_Registration) {
-                return $primary_registrant->event_obj();
-            }
-        }
-        return null;
-    }
-
-
-
-    /**
-     * Gets the name of the first event for which is being paid
-     *
-     * @return string
-     */
-    public function get_first_event_name()
-    {
-        $event = $this->get_first_event();
-        return $event instanceof EE_Event ? $event->name() : __('Event', 'event_espresso');
-    }
-
-
-
-    /**
-     * Returns the payment's transaction's primary registration
-     * @return EE_Registration|null
-     */
-    public function get_primary_registration()
-    {
-        if ($this->transaction() instanceof EE_Transaction) {
-            return $this->transaction()->primary_registration();
-        }
-        return null;
-    }
-
-
-
-    /**
-     * Gets the payment's transaction's primary registration's attendee, or null
-     * @return EE_Attendee|null
-     */
-    public function get_primary_attendee()
-    {
-        $primary_reg = $this->get_primary_registration();
-        if( $primary_reg instanceof EE_Registration) {
-            return $primary_reg->attendee();
-        }
-        return null;
-    }
+	/**
+	 * Gets the first event for this payment (it's possible that it could be for multiple)
+	 *
+	 * @return EE_Event|null
+	 */
+	public function get_first_event()
+	{
+		$transaction = $this->transaction();
+		if ($transaction instanceof EE_Transaction) {
+			$primary_registrant = $transaction->primary_registration();
+			if ($primary_registrant instanceof EE_Registration) {
+				return $primary_registrant->event_obj();
+			}
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * Gets the name of the first event for which is being paid
+	 *
+	 * @return string
+	 */
+	public function get_first_event_name()
+	{
+		$event = $this->get_first_event();
+		return $event instanceof EE_Event ? $event->name() : __('Event', 'event_espresso');
+	}
+
+
+
+	/**
+	 * Returns the payment's transaction's primary registration
+	 * @return EE_Registration|null
+	 */
+	public function get_primary_registration()
+	{
+		if ($this->transaction() instanceof EE_Transaction) {
+			return $this->transaction()->primary_registration();
+		}
+		return null;
+	}
+
+
+
+	/**
+	 * Gets the payment's transaction's primary registration's attendee, or null
+	 * @return EE_Attendee|null
+	 */
+	public function get_primary_attendee()
+	{
+		$primary_reg = $this->get_primary_registration();
+		if( $primary_reg instanceof EE_Registration) {
+			return $primary_reg->attendee();
+		}
+		return null;
+	}
 }
 /* End of file EE_Payment.class.php */
 /* Location: /includes/classes/EE_Payment.class.php */

Doc Comments +3 added lines, -3 removed lines

@@ -15,7 +15,7 @@ 
 	 * @param array  $props_n_values          incoming values
 	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
 	 *                                        used.)
-	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 * @param string[]  $date_formats            incoming date_formats in an array where the first value is the
 	 *                                        date_format and the second value is the time format
 	 * @return EE_Payment
 	 * @throws \EE_Error
@@ -590,7 +590,7 @@ 
 	 * Gets all the extra meta info on this payment
 	 *
 	 * @param array $query_params like EEM_Base::get_all
-	 * @return EE_Extra_Meta
+	 * @return EE_Base_Class[]
 	 * @throws \EE_Error
 	 */
 	public function extra_meta( $query_params = array() ) {
@@ -840,7 +840,7 @@ 
 
     /**
      * Returns the payment's transaction's primary registration
-     * @return EE_Registration|null
+     * @return EE_Base_Class|null
      */
     public function get_primary_registration()
     {

admin_pages/registration_form/templates/questions_main_meta_box.template.php

Indentation +8 added lines, -8 removed lines

@@ -98,14 +98,14 @@
 				</th>
 				<td>
 					<?php
-                        $disabled = ! empty( $QST_system ) && $QST_system !== EEM_Attendee::system_question_phone;
-                        if( $disabled ){
-                            $disabled_attr =  'disabled="disabled"';
-						    $id =  '_disabled';
-                        } else {
-                            $disabled_attr = '';
-                            $id = '';
-                        }
+						$disabled = ! empty( $QST_system ) && $QST_system !== EEM_Attendee::system_question_phone;
+						if( $disabled ){
+							$disabled_attr =  'disabled="disabled"';
+							$id =  '_disabled';
+						} else {
+							$disabled_attr = '';
+							$id = '';
+						}
 
 						echo EEH_Form_Fields::select_input( 'QST_type' . $id, $question_types, $question->type(), 'id="QST_type' . $id . '"' . $disabled_attr );
 						if( $disabled ) { ?>

Spacing +58 added lines, -58 removed lines

@@ -15,9 +15,9 @@ 
 //does question have any answers? cause if it does then we have to disable type
 $has_answers = $question->has_answers();
 
-if ( $QST_system === 'country' ) {
+if ($QST_system === 'country') {
 	echo EEH_HTML::div(
-		EEH_HTML::h4( '<span class="dashicons dashicons-info"></span>' . esc_html__( 'Did you know...', 'event_espresso' ) ) .
+		EEH_HTML::h4('<span class="dashicons dashicons-info"></span>'.esc_html__('Did you know...', 'event_espresso')).
 		EEH_HTML::p(
 			esc_html__(
 				'If you add a State/Province Select input immediately after this Country Select input when building your registration form, then the State/Province Select input options will change to correspond with the choice made in this input. So for example, choosing "United States" in this Country Select input will populate the State/Province Select input with just the state options for the United States.',
@@ -34,7 +34,7 @@ 
 		<tbody>
 			<tr>
 				<th>
-					<label for="QST_display_text"><?php echo $fields['QST_display_text']->get_nicename();?></label> <?php echo EEH_Template::get_help_tab_link('question_text_info');?>
+					<label for="QST_display_text"><?php echo $fields['QST_display_text']->get_nicename(); ?></label> <?php echo EEH_Template::get_help_tab_link('question_text_info'); ?>
 				</th>
 				<td>
 					<input type="text" class="regular-text" id="QST_display_text" name="QST_display_text" value="<?php $question->f('QST_display_text')?>"/>
@@ -44,23 +44,23 @@ 
 
 			<tr>
 				<th>
-					<label for="QST_admin_label"><?php echo $fields['QST_admin_label']->get_nicename();?></label> <?php echo EEH_Template::get_help_tab_link('question_label_info');?>
+					<label for="QST_admin_label"><?php echo $fields['QST_admin_label']->get_nicename(); ?></label> <?php echo EEH_Template::get_help_tab_link('question_label_info'); ?>
 				</th>
 				<td>
 					<?php
-						$disabled_attr = ! empty( $QST_system ) ? ' disabled="disabled"' : '';
-						$id =  ! empty( $QST_system ) ? '_disabled' : '';
+						$disabled_attr = ! empty($QST_system) ? ' disabled="disabled"' : '';
+						$id = ! empty($QST_system) ? '_disabled' : '';
 					?>
 					<input type="text" class="regular-text" id="QST_admin_label<?php echo $id?>" name="QST_admin_label<?php echo $id?>" value="<?php $question->f('QST_admin_label')?>"<?php echo $disabled_attr?>/>
 					<input class="QST_order" type="hidden" id="QST_order<?php echo $id; ?>" name = "QST_order<?php echo $id; ?>" value="<?php echo $question->get('QST_order'); ?>" />
-					<?php if ( ! empty( $QST_system )) { ?>
+					<?php if ( ! empty($QST_system)) { ?>
 						<input type="hidden"  id="QST_admin_label" name="QST_admin_label" value="<?php echo $question->admin_label()?>"/>
 					<?php } ?>
 					<br/>
 					<p class="description">
-					<?php if ( ! empty( $QST_system )) { ?>
+					<?php if ( ! empty($QST_system)) { ?>
 					<span class="description" style="color:#D54E21;">
-						<?php esc_html_e('System question! This field cannot be changed.','event_espresso')?>
+						<?php esc_html_e('System question! This field cannot be changed.', 'event_espresso')?>
 					</span>
 					<?php } ?>
 
@@ -70,21 +70,21 @@ 
 
 			<tr>
 				<th>
-					<label for="QST_admin_only"><?php echo $fields['QST_admin_only']->get_nicename();?></label> <?php echo EEH_Template::get_help_tab_link('question_admin_only_info');?>
+					<label for="QST_admin_only"><?php echo $fields['QST_admin_only']->get_nicename(); ?></label> <?php echo EEH_Template::get_help_tab_link('question_admin_only_info'); ?>
 				</th>
 				<td>
 					<?php
-						$disabled_attr = ! empty( $QST_system ) ? ' disabled="disabled"' : '';
-						$id =  ! empty( $QST_system ) ? '_disabled' : '';
+						$disabled_attr = ! empty($QST_system) ? ' disabled="disabled"' : '';
+						$id = ! empty($QST_system) ? '_disabled' : '';
 						$admin_only = $question->get('QST_admin_only');
-						$checked = !empty( $admin_only ) ? ' checked="checked"' : '';
+						$checked = ! empty($admin_only) ? ' checked="checked"' : '';
 					?>
 					<input class="QST_admin_only" type="checkbox" id="QST_admin_only<?php echo $id; ?>" name = "QST_admin_only<?php echo $id; ?>" value="1"<?php echo $disabled_attr; echo $checked; ?>/>
 					<br/>
 					<p class="description">
-					<?php if ( ! empty( $QST_system )) { ?>
+					<?php if ( ! empty($QST_system)) { ?>
 					<span class="description" style="color:#D54E21;">
-						<?php esc_html_e('System question! This field cannot be changed.','event_espresso')?>
+						<?php esc_html_e('System question! This field cannot be changed.', 'event_espresso')?>
 					</span>
 					<?php } ?>
 
@@ -94,28 +94,28 @@ 
 
 			<tr>
 				<th>
-					<label for="QST_type"><?php echo $fields['QST_type']->get_nicename();?></label> <?php echo EEH_Template::get_help_tab_link('question_type_info');?>
+					<label for="QST_type"><?php echo $fields['QST_type']->get_nicename(); ?></label> <?php echo EEH_Template::get_help_tab_link('question_type_info'); ?>
 				</th>
 				<td>
 					<?php
-                        $disabled = ! empty( $QST_system ) && $QST_system !== EEM_Attendee::system_question_phone;
-                        if( $disabled ){
-                            $disabled_attr =  'disabled="disabled"';
-						    $id =  '_disabled';
+                        $disabled = ! empty($QST_system) && $QST_system !== EEM_Attendee::system_question_phone;
+                        if ($disabled) {
+                            $disabled_attr = 'disabled="disabled"';
+						    $id = '_disabled';
                         } else {
                             $disabled_attr = '';
                             $id = '';
                         }
 
-						echo EEH_Form_Fields::select_input( 'QST_type' . $id, $question_types, $question->type(), 'id="QST_type' . $id . '"' . $disabled_attr );
-						if( $disabled ) { ?>
+						echo EEH_Form_Fields::select_input('QST_type'.$id, $question_types, $question->type(), 'id="QST_type'.$id.'"'.$disabled_attr);
+						if ($disabled) { ?>
 							<input type="hidden"  id="QST_type" name="QST_type" value="<?php echo $question->type()?>"/>
 						<?php
-							$explanatory_text = esc_html__('System question! This field cannot be changed.','event_espresso');
-						}else{
-							$explanatory_text = esc_html__('Because there are currently answers for this question in the database, your options to change the question type have been limited to similar question-types.','event_espresso');
+							$explanatory_text = esc_html__('System question! This field cannot be changed.', 'event_espresso');
+						} else {
+							$explanatory_text = esc_html__('Because there are currently answers for this question in the database, your options to change the question type have been limited to similar question-types.', 'event_espresso');
 						}
-						if ( $disabled || $has_answers ) { ?>
+						if ($disabled || $has_answers) { ?>
 							<p><span class="description" style="color:#D54E21;">
 								<?php echo $explanatory_text; ?>
 							</span></p>
@@ -128,22 +128,22 @@ 
 			<tr id="text_input_question_options">
 				<th>
 					<label>
-						<?php esc_html_e( 'Maximum Allowed Response Size', 'event_espresso' );?>
+						<?php esc_html_e('Maximum Allowed Response Size', 'event_espresso'); ?>
 					</label>
 				</th>
 				<td>
-					<input id="QST_max" name="QST_max" type="number" <?php echo $max_max === EE_INF ? '' : "max='$max_max'";?> value="<?php $question->f( 'QST_max' );?>" min="1">
+					<input id="QST_max" name="QST_max" type="number" <?php echo $max_max === EE_INF ? '' : "max='$max_max'"; ?> value="<?php $question->f('QST_max'); ?>" min="1">
 					<p>
 						<span class="description">
-							<?php esc_html_e( 'Maximum number of characters allowed when answering this question', 'event_espresso' );?>
+							<?php esc_html_e('Maximum number of characters allowed when answering this question', 'event_espresso'); ?>
 						</span>
 					</p>
-					<?php if ( $QST_system ) { ?>
+					<?php if ($QST_system) { ?>
 					<p>
 						<span class="description" style="color:#D54E21;">
 							<?php printf(
-									esc_html__( 'System question! The maximum number of characters that can be used for this question is %1$s', 'event_espresso' ),
-									$max_max );?>
+									esc_html__('System question! The maximum number of characters that can be used for this question is %1$s', 'event_espresso'),
+									$max_max ); ?>
 						</span>
 					</p>
 					<?php } ?>
@@ -152,7 +152,7 @@ 
 			<tr id="question_options">
 				<th>
 					<label>
-						<?php esc_html_e('Answer Options','event_espresso')?>
+						<?php esc_html_e('Answer Options', 'event_espresso')?>
 					</label>
 				</th>
 				<td>
@@ -161,10 +161,10 @@ 
 						<thead>
 							<tr>
 								<th class="option-value-header">
-									<?php esc_html_e('Value','event_espresso')?>
+									<?php esc_html_e('Value', 'event_espresso')?>
 								</th>
 								<th class="option-desc-header">
-									<?php esc_html_e('Description (optional, only shown on registration form)','event_espresso')?>
+									<?php esc_html_e('Description (optional, only shown on registration form)', 'event_espresso')?>
 								</th>
 								<th>
 								</th>
@@ -187,17 +187,17 @@ 
 							</tr>
 
 							<?php
-							$count=0;
+							$count = 0;
 							$question_options = $question->options();
-							if ( ! empty( $question_options )) {
-								foreach( $question_options as $option_id => $option ) {
-									$disabled_attr = $has_answers || $option->get('QSO_system') ? ' disabled="disabled"'  : '';
+							if ( ! empty($question_options)) {
+								foreach ($question_options as $option_id => $option) {
+									$disabled_attr = $has_answers || $option->get('QSO_system') ? ' disabled="disabled"' : '';
 							?>
 								<tr class="question-option ee-options-sortable">
 									<td class="option-value-cell">
 										<input type="hidden" class="QSO_order" name="question_options[<?php echo $count; ?>][QSO_order]" value="<?php echo $count; ?>">
 										<input type="text" class="option-value regular-text" name="question_options[<?php echo $count?>][QSO_value]" value="<?php  $option->f('QSO_value')?>"<?php echo $disabled_attr; ?>>
-										<?php if ( $has_answers ) : ?>
+										<?php if ($has_answers) : ?>
 											<input type="hidden" name="question_options[<?php echo $count; ?>][QSO_value]" value="<?php echo $option->f('QSO_value'); ?>" >
 										<?php endif; ?>
 									</td>
@@ -205,7 +205,7 @@ 
 										<input type="text" class="option-desc regular-text" name="question_options[<?php echo $count?>][QSO_desc]" value="<?php $option->f('QSO_desc')?>">
 									</td>
 									<td>
-										<?php if ( ! $option->system() ) { ?>
+										<?php if ( ! $option->system()) { ?>
 											<span class="dashicons clickable dashicons-post-trash ee-icon-size-18 remove-option remove-item"></span>
 										<?php } ?>
                                         <span class="dashicons dashicons-image-flip-vertical sortable-drag-handle ee-icon-size-18"></span>
@@ -244,13 +244,13 @@ 
 					</table>
 
 					<a id="new-question-option" class="button" style="margin:0 0 1em 3px;">
-						<?php esc_html_e('Add Another Answer Option','event_espresso')?>
+						<?php esc_html_e('Add Another Answer Option', 'event_espresso')?>
 					</a><br/>
 
 					<p class="description">
-						<?php esc_html_e('Answer Options are the choices that you give people to select from for RADIO_BTN, CHECKBOX or DROPDOWN questions. The Value is a simple key that will be saved to the database and the description is optional. Note that values CANNOT contain any HTML, but descriptions can.','event_espresso')?>
+						<?php esc_html_e('Answer Options are the choices that you give people to select from for RADIO_BTN, CHECKBOX or DROPDOWN questions. The Value is a simple key that will be saved to the database and the description is optional. Note that values CANNOT contain any HTML, but descriptions can.', 'event_espresso')?>
 					</p>
-					<?php if ( $has_answers ) : ?>
+					<?php if ($has_answers) : ?>
 					<p class="description" style="color:#D54E21;">
 							<?php esc_html_e('Answer values that are uneditable are this way because there are registrations in the database that have answers for this question.  If you need to correct a mistake, or edit an existing option value, then trash the existing one and create a new option with the changes.  This will ensure that the existing registrations that chose the original answer will preserve that answer.', 'event_espresso'); ?>
 					</p>
@@ -261,32 +261,32 @@ 
 
 			<tr>
 				<th>
-					<label for="QST_required"><?php echo $fields['QST_required']->get_nicename();?></label> <?php echo EEH_Template::get_help_tab_link('required_question_info');?>
+					<label for="QST_required"><?php echo $fields['QST_required']->get_nicename(); ?></label> <?php echo EEH_Template::get_help_tab_link('required_question_info'); ?>
 				</th>
 				<td>
 					<?php
-					$system_required = array( 'fname', 'email' );
-					$disabled_attr = in_array( $QST_system, $system_required ) ? ' disabled="disabled"' : '';
+					$system_required = array('fname', 'email');
+					$disabled_attr = in_array($QST_system, $system_required) ? ' disabled="disabled"' : '';
 					$required_on = $question->get('QST_admin_only');
 					$show_required_msg = $required_on ? '' : ' display:none;';
-					$disabled_attr = $required_on || ! empty( $disabled_attr ) ? ' disabled="disabled"' : '';
-					$id = ! empty( $disabled_attr ) && in_array( $QST_system, $system_required) ? '_disabled' : '';
-					$requiredOptions=array(
-						array( 'text'=> esc_html__( 'Optional', 'event_espresso' ), 'id'=>0 ),
-						array( 'text'=> esc_html__( 'Required', 'event_espresso' ), 'id'=>1 )
+					$disabled_attr = $required_on || ! empty($disabled_attr) ? ' disabled="disabled"' : '';
+					$id = ! empty($disabled_attr) && in_array($QST_system, $system_required) ? '_disabled' : '';
+					$requiredOptions = array(
+						array('text'=> esc_html__('Optional', 'event_espresso'), 'id'=>0),
+						array('text'=> esc_html__('Required', 'event_espresso'), 'id'=>1)
 					);
-					echo EEH_Form_Fields::select_input('QST_required' . $id, $requiredOptions, $question->required(), 'id="QST_required' . $id . '"' . $disabled_attr );
+					echo EEH_Form_Fields::select_input('QST_required'.$id, $requiredOptions, $question->required(), 'id="QST_required'.$id.'"'.$disabled_attr);
 					?>
 						<p><span id="required_toggled_on" class="description" style="color:#D54E21;<?php echo $show_required_msg; ?>">
-						<?php esc_html_e('Required is set to optional, and this field is disabled, because the question is Admin-Only.','event_espresso')?>
+						<?php esc_html_e('Required is set to optional, and this field is disabled, because the question is Admin-Only.', 'event_espresso')?>
 						</span></p>
 						<p><span id="required_toggled_off" class="description" style="color:#D54E21; display: none;">
-							<?php esc_html_e('Required option field is no longer disabled because the question is not Admin-Only','event_espresso')?>
+							<?php esc_html_e('Required option field is no longer disabled because the question is not Admin-Only', 'event_espresso')?>
 						</span></p>
-					<?php if (! empty( $disabled_attr ) && in_array( $QST_system, $system_required ) ) { ?>
+					<?php if ( ! empty($disabled_attr) && in_array($QST_system, $system_required)) { ?>
 						<input type="hidden"  id="QST_required" name="QST_required" value="1"/>
 						<p><span class="description" style="color:#D54E21;">
-						<?php esc_html_e('System question! This field cannot be changed.','event_espresso')?>
+						<?php esc_html_e('System question! This field cannot be changed.', 'event_espresso')?>
 					</span></p>
 					<?php } ?>
 
@@ -295,7 +295,7 @@ 
 
 			<tr>
 				<th>
-					<label for="QST_required_text"><?php esc_html_e('Required Text', 'event_espresso'); ?></label> <?php echo EEH_Template::get_help_tab_link('required_text_info');?>
+					<label for="QST_required_text"><?php esc_html_e('Required Text', 'event_espresso'); ?></label> <?php echo EEH_Template::get_help_tab_link('required_text_info'); ?>
 				</th>
 				<td>
 					<input type="text" maxlength="100" class="regular-text" id="QST_required_text" name="QST_required_text" value="<?php  $question->f('QST_required_text')?>"/>

Braces +1 added lines, -1 removed lines

@@ -112,7 +112,7 @@
 							<input type="hidden"  id="QST_type" name="QST_type" value="<?php echo $question->type()?>"/>
 						<?php
 							$explanatory_text = esc_html__('System question! This field cannot be changed.','event_espresso');
-						}else{
+						} else{
 							$explanatory_text = esc_html__('Because there are currently answers for this question in the database, your options to change the question type have been limited to similar question-types.','event_espresso');
 						}
 						if ( $disabled || $has_answers ) { ?>

core/services/payment_methods/gateways/GatewayDataFormatterInterface.php

Indentation +44 added lines, -44 removed lines

@@ -16,65 +16,65 @@
 interface GatewayDataFormatterInterface
 {
 
-    /**
-     * Gets the text to use for a gateway's line item name when this is a partial payment
-     *
-     * @param \EEI_Payment $payment
-     * @return string
-     */
-    public function formatPartialPaymentLineItemName(\EEI_Payment $payment);
+	/**
+	 * Gets the text to use for a gateway's line item name when this is a partial payment
+	 *
+	 * @param \EEI_Payment $payment
+	 * @return string
+	 */
+	public function formatPartialPaymentLineItemName(\EEI_Payment $payment);
 
 
 
-    /**
-     * Gets the text to use for a gateway's line item description when this is a partial payment
-     *
-     * @param \EEI_Payment $payment
-     * @return string
-     */
-    public function formatPartialPaymentLineItemDesc(\EEI_Payment $payment);
+	/**
+	 * Gets the text to use for a gateway's line item description when this is a partial payment
+	 *
+	 * @param \EEI_Payment $payment
+	 * @return string
+	 */
+	public function formatPartialPaymentLineItemDesc(\EEI_Payment $payment);
 
 
 
-    /**
-     * Gets the name to use for a line item when sending line items to the gateway
-     *
-     * @param \EEI_Line_Item $line_item
-     * @param \EEI_Payment   $payment
-     * @return string
-     */
-    public function formatLineItemName(\EEI_Line_Item $line_item, \EEI_Payment $payment);
+	/**
+	 * Gets the name to use for a line item when sending line items to the gateway
+	 *
+	 * @param \EEI_Line_Item $line_item
+	 * @param \EEI_Payment   $payment
+	 * @return string
+	 */
+	public function formatLineItemName(\EEI_Line_Item $line_item, \EEI_Payment $payment);
 
 
 
-    /**
-     * Gets the description to use for a line item when sending line items to the gateway
-     *
-     * @param \EEI_Line_Item $line_item
-     * @param \EEI_Payment   $payment
-     * @return string
-     */
-    public function formatLineItemDesc(\EEI_Line_Item $line_item, \EEI_Payment $payment);
+	/**
+	 * Gets the description to use for a line item when sending line items to the gateway
+	 *
+	 * @param \EEI_Line_Item $line_item
+	 * @param \EEI_Payment   $payment
+	 * @return string
+	 */
+	public function formatLineItemDesc(\EEI_Line_Item $line_item, \EEI_Payment $payment);
 
 
 
-    /**
-     * Gets the order description that should generally be sent to gateways
-     *
-     * @param \EEI_Payment $payment
-     * @return string
-     */
-    public function formatOrderDescription(\EEI_Payment $payment);
+	/**
+	 * Gets the order description that should generally be sent to gateways
+	 *
+	 * @param \EEI_Payment $payment
+	 * @return string
+	 */
+	public function formatOrderDescription(\EEI_Payment $payment);
 
 
 
-    /**
-     * Formats the amount so it can generally be sent to gateways
-     *
-     * @param float $amount
-     * @return string
-     */
-    public function formatCurrency($amount);
+	/**
+	 * Formats the amount so it can generally be sent to gateways
+	 *
+	 * @param float $amount
+	 * @return string
+	 */
+	public function formatCurrency($amount);
 }
 // End of file GatewayDataFormatterInterface.php
 // Location: core\services\payment_methods\gateways/GatewayDataFormatterInterface.php
\ No newline at end of file