eventespresso / event-espresso-core

caffeinated/admin/new/pricing/help_tours/Pricing_Edit_Price_Type_Help_Tour.class.php

Indentation +72 added lines, -72 removed lines

@@ -15,84 +15,84 @@
 class Pricing_Edit_Price_Type_Help_Tour extends EE_Help_Tour
 {
 
-    protected function _set_tour_properties()
-    {
-        $this->_label = __('Edit Price Type Tour', 'event_espresso');
-        $this->_slug = 'edit-price-type-joyride';
-    }
+	protected function _set_tour_properties()
+	{
+		$this->_label = __('Edit Price Type Tour', 'event_espresso');
+		$this->_slug = 'edit-price-type-joyride';
+	}
 
 
-    protected function _set_tour_stops()
-    {
-        $this->_stops = array(
-            10 => array(
-                'content' => $this->_start(),
-            ),
-            20 => array(
-                'id'      => 'base_type',
-                'content' => $this->_basic_type_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentY' => -50,
-                    'tipAdjustmentX' => -15,
-                ),
-            ),
-            30 => array(
-                'id'      => 'PRT_name',
-                'content' => $this->_price_type_name_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentY' => -40,
-                ),
-            ),
-            40 => array(
-                'id'      => 'PRT_name',
-                'content' => $this->_percentage_dollar_amount_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentY' => 45,
-                ),
-            ),
-            50 => array(
-                'id'      => 'PRT_order',
-                'content' => $this->_order_of_application_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentY' => -40,
-                ),
-            ),
-        );
-    }
+	protected function _set_tour_stops()
+	{
+		$this->_stops = array(
+			10 => array(
+				'content' => $this->_start(),
+			),
+			20 => array(
+				'id'      => 'base_type',
+				'content' => $this->_basic_type_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentY' => -50,
+					'tipAdjustmentX' => -15,
+				),
+			),
+			30 => array(
+				'id'      => 'PRT_name',
+				'content' => $this->_price_type_name_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentY' => -40,
+				),
+			),
+			40 => array(
+				'id'      => 'PRT_name',
+				'content' => $this->_percentage_dollar_amount_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentY' => 45,
+				),
+			),
+			50 => array(
+				'id'      => 'PRT_order',
+				'content' => $this->_order_of_application_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentY' => -40,
+				),
+			),
+		);
+	}
 
 
-    protected function _start()
-    {
-        $content = '<h3>' . __('Edit Price Type', 'event_espresso') . '</h3>';
-        $content .= '<p>'
-                    . __(
-                        'This tour of the Edit Price Type page will go over different areas of the screen to help you understand what they are used for.',
-                        'event_espresso'
-                    ) . '</p>';
-        return $content;
-    }
+	protected function _start()
+	{
+		$content = '<h3>' . __('Edit Price Type', 'event_espresso') . '</h3>';
+		$content .= '<p>'
+					. __(
+						'This tour of the Edit Price Type page will go over different areas of the screen to help you understand what they are used for.',
+						'event_espresso'
+					) . '</p>';
+		return $content;
+	}
 
-    protected function _basic_type_stop()
-    {
-        return '<p>' . __('Set a price type to be a discount, surcharge, or tax.', 'event_espresso') . '</p>';
-    }
+	protected function _basic_type_stop()
+	{
+		return '<p>' . __('Set a price type to be a discount, surcharge, or tax.', 'event_espresso') . '</p>';
+	}
 
-    protected function _price_type_name_stop()
-    {
-        return '<p>' . __('The name of the price type.', 'event_espresso') . '</p>';
-    }
+	protected function _price_type_name_stop()
+	{
+		return '<p>' . __('The name of the price type.', 'event_espresso') . '</p>';
+	}
 
-    protected function _percentage_dollar_amount_stop()
-    {
-        return '<p>' . __('Set a price type to be percentage-based or a fixed amount.', 'event_espresso') . '</p>';
-    }
+	protected function _percentage_dollar_amount_stop()
+	{
+		return '<p>' . __('Set a price type to be percentage-based or a fixed amount.', 'event_espresso') . '</p>';
+	}
 
-    protected function _order_of_application_stop()
-    {
-        return '<p>' . __('Set the order of application for a price type.', 'event_espresso') . '</p>';
-    }
+	protected function _order_of_application_stop()
+	{
+		return '<p>' . __('Set the order of application for a price type.', 'event_espresso') . '</p>';
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -67,32 +67,32 @@
 
     protected function _start()
     {
-        $content = '<h3>' . __('Edit Price Type', 'event_espresso') . '</h3>';
+        $content = '<h3>'.__('Edit Price Type', 'event_espresso').'</h3>';
         $content .= '<p>'
                     . __(
                         'This tour of the Edit Price Type page will go over different areas of the screen to help you understand what they are used for.',
                         'event_espresso'
-                    ) . '</p>';
+                    ).'</p>';
         return $content;
     }
 
     protected function _basic_type_stop()
     {
-        return '<p>' . __('Set a price type to be a discount, surcharge, or tax.', 'event_espresso') . '</p>';
+        return '<p>'.__('Set a price type to be a discount, surcharge, or tax.', 'event_espresso').'</p>';
     }
 
     protected function _price_type_name_stop()
     {
-        return '<p>' . __('The name of the price type.', 'event_espresso') . '</p>';
+        return '<p>'.__('The name of the price type.', 'event_espresso').'</p>';
     }
 
     protected function _percentage_dollar_amount_stop()
     {
-        return '<p>' . __('Set a price type to be percentage-based or a fixed amount.', 'event_espresso') . '</p>';
+        return '<p>'.__('Set a price type to be percentage-based or a fixed amount.', 'event_espresso').'</p>';
     }
 
     protected function _order_of_application_stop()
     {
-        return '<p>' . __('Set the order of application for a price type.', 'event_espresso') . '</p>';
+        return '<p>'.__('Set the order of application for a price type.', 'event_espresso').'</p>';
     }
 }

caffeinated/admin/new/pricing/help_tours/Pricing_Price_Types_Default_Help_Tour.class.php

Indentation +125 added lines, -125 removed lines

@@ -15,140 +15,140 @@
 class Pricing_Price_Types_Default_Help_Tour extends EE_Help_Tour
 {
 
-    protected function _set_tour_properties()
-    {
-        $this->_label = __('Price Types Tour', 'event_espresso');
-        $this->_slug = 'default-price-types-joyride';
-    }
+	protected function _set_tour_properties()
+	{
+		$this->_label = __('Price Types Tour', 'event_espresso');
+		$this->_slug = 'default-price-types-joyride';
+	}
 
 
-    protected function _set_tour_stops()
-    {
-        $this->_stops = array(
-            10 => array(
-                'content' => $this->_start(),
-            ),
-            20 => array(
-                'id'      => 'name',
-                'content' => $this->_name_column_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => -5,
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            30 => array(
-                'id'      => 'base_type',
-                'content' => $this->_base_type_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => 120,
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            40 => array(
-                'id'      => 'percent',
-                'content' => $this->_percent_column_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => 120,
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            50 => array(
-                'id'      => 'order',
-                'content' => $this->_order_column_stop(),
-                'options' => array(
-                    'tipLocation'    => 'left',
-                    'tipAdjustmentY' => -30,
-                    'tipAdjustmentX' => 100,
-                ),
-            ),
-            60 => array(
-                'class'   => 'bulkactions',
-                'content' => $this->_bulk_actions_stop(),
-                'options' => array(
-                    'tipLocation'    => 'left',
-                    'tipAdjustmentY' => -50,
-                    'tipAdjustmentX' => -75,
-                ),
-            ),
-            70 => array(
-                'id'      => 'event-espresso_page_pricing-search-input',
-                'content' => $this->_search_stop(),
-                'options' => array(
-                    'tipLocation'    => 'left',
-                    'tipAdjustmentY' => -50,
-                    'tipAdjustmentX' => -15,
-                ),
-            ),
-        );
-    }
+	protected function _set_tour_stops()
+	{
+		$this->_stops = array(
+			10 => array(
+				'content' => $this->_start(),
+			),
+			20 => array(
+				'id'      => 'name',
+				'content' => $this->_name_column_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => -5,
+					'tipAdjustmentY' => -30,
+				),
+			),
+			30 => array(
+				'id'      => 'base_type',
+				'content' => $this->_base_type_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => 120,
+					'tipAdjustmentY' => -30,
+				),
+			),
+			40 => array(
+				'id'      => 'percent',
+				'content' => $this->_percent_column_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => 120,
+					'tipAdjustmentY' => -30,
+				),
+			),
+			50 => array(
+				'id'      => 'order',
+				'content' => $this->_order_column_stop(),
+				'options' => array(
+					'tipLocation'    => 'left',
+					'tipAdjustmentY' => -30,
+					'tipAdjustmentX' => 100,
+				),
+			),
+			60 => array(
+				'class'   => 'bulkactions',
+				'content' => $this->_bulk_actions_stop(),
+				'options' => array(
+					'tipLocation'    => 'left',
+					'tipAdjustmentY' => -50,
+					'tipAdjustmentX' => -75,
+				),
+			),
+			70 => array(
+				'id'      => 'event-espresso_page_pricing-search-input',
+				'content' => $this->_search_stop(),
+				'options' => array(
+					'tipLocation'    => 'left',
+					'tipAdjustmentY' => -50,
+					'tipAdjustmentX' => -15,
+				),
+			),
+		);
+	}
 
 
-    protected function _start()
-    {
-        $content = '<h3>' . __('Price Types', 'event_espresso') . '</h3>';
-        $content .= '<p>'
-                    . __(
-                        'This tour of the Price Types page will go over different areas of the screen to help you understand what they are used for.',
-                        'event_espresso'
-                    ) . '</p>';
-        return $content;
-    }
+	protected function _start()
+	{
+		$content = '<h3>' . __('Price Types', 'event_espresso') . '</h3>';
+		$content .= '<p>'
+					. __(
+						'This tour of the Price Types page will go over different areas of the screen to help you understand what they are used for.',
+						'event_espresso'
+					) . '</p>';
+		return $content;
+	}
 
-    protected function _name_column_stop()
-    {
-        return '<p>'
-               . __(
-                   'The name of the price type. Can be sorted in ascending or descending order.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _name_column_stop()
+	{
+		return '<p>'
+			   . __(
+				   'The name of the price type. Can be sorted in ascending or descending order.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _base_type_stop()
-    {
-        return '<p>' . __('View if a price type is a discount, surcharge, or tax.', 'event_espresso') . '</p>';
-    }
+	protected function _base_type_stop()
+	{
+		return '<p>' . __('View if a price type is a discount, surcharge, or tax.', 'event_espresso') . '</p>';
+	}
 
-    protected function _member_column_stop()
-    {
-        return '<p>'
-               . __(
-                   'Here you can see if the discount/surcharge is percentage based or a flat monetary amount.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _member_column_stop()
+	{
+		return '<p>'
+			   . __(
+				   'Here you can see if the discount/surcharge is percentage based or a flat monetary amount.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _percent_column_stop()
-    {
-        return '<p>'
-               . __(
-                   'View if the discount, surcharge, or tax is percentage-based or a fixed amount.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _percent_column_stop()
+	{
+		return '<p>'
+			   . __(
+				   'View if the discount, surcharge, or tax is percentage-based or a fixed amount.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _order_column_stop()
-    {
-        return '<p>'
-               . __(
-                   'View the order in which each discount, surcharge, or tax will be applied to the base ticket cost. Zero (0) means it will be applied first.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _order_column_stop()
+	{
+		return '<p>'
+			   . __(
+				   'View the order in which each discount, surcharge, or tax will be applied to the base ticket cost. Zero (0) means it will be applied first.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _bulk_actions_stop()
-    {
-        return '<p>' . __('Perform bulk actions to multiple price types.', 'event_espresso') . '</p>';
-    }
+	protected function _bulk_actions_stop()
+	{
+		return '<p>' . __('Perform bulk actions to multiple price types.', 'event_espresso') . '</p>';
+	}
 
-    protected function _search_stop()
-    {
-        return '<p>'
-               . __(
-                   'Search through price types. The following source will be searched: Price Type Name.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _search_stop()
+	{
+		return '<p>'
+			   . __(
+				   'Search through price types. The following source will be searched: Price Type Name.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -88,12 +88,12 @@ 
 
     protected function _start()
     {
-        $content = '<h3>' . __('Price Types', 'event_espresso') . '</h3>';
+        $content = '<h3>'.__('Price Types', 'event_espresso').'</h3>';
         $content .= '<p>'
                     . __(
                         'This tour of the Price Types page will go over different areas of the screen to help you understand what they are used for.',
                         'event_espresso'
-                    ) . '</p>';
+                    ).'</p>';
         return $content;
     }
 
@@ -103,12 +103,12 @@ 
                . __(
                    'The name of the price type. Can be sorted in ascending or descending order.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _base_type_stop()
     {
-        return '<p>' . __('View if a price type is a discount, surcharge, or tax.', 'event_espresso') . '</p>';
+        return '<p>'.__('View if a price type is a discount, surcharge, or tax.', 'event_espresso').'</p>';
     }
 
     protected function _member_column_stop()
@@ -117,7 +117,7 @@ 
                . __(
                    'Here you can see if the discount/surcharge is percentage based or a flat monetary amount.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _percent_column_stop()
@@ -126,7 +126,7 @@ 
                . __(
                    'View if the discount, surcharge, or tax is percentage-based or a fixed amount.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _order_column_stop()
@@ -135,12 +135,12 @@ 
                . __(
                    'View the order in which each discount, surcharge, or tax will be applied to the base ticket cost. Zero (0) means it will be applied first.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _bulk_actions_stop()
     {
-        return '<p>' . __('Perform bulk actions to multiple price types.', 'event_espresso') . '</p>';
+        return '<p>'.__('Perform bulk actions to multiple price types.', 'event_espresso').'</p>';
     }
 
     protected function _search_stop()
@@ -149,6 +149,6 @@ 
                . __(
                    'Search through price types. The following source will be searched: Price Type Name.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 }

caffeinated/admin/hooks/Global_EE_Caf_Hooks.class.php

Indentation +38 added lines, -38 removed lines

@@ -15,42 +15,42 @@
 class Global_EE_Caf_Hooks
 {
 
-    public function __construct()
-    {
-        $this->_do_hooks();
-    }
-
-
-    private function _do_hooks()
-    {
-        add_filter('FHEE_show_sponsors_meta_box', '__return_false', 10);
-        add_filter('FHEE_show_ratings_request_meta_box', '__return_false', 10);
-        add_filter(
-            'FHEE__EE_Admin_Page_Core__load_global_scripts_styles__loader_containers',
-            array($this, 'forums_lazy_loading'),
-            10
-        );
-        add_action(
-            'AHEE__EE_Admin_Page__espresso_news_post_box__after_content',
-            array($this, 'extra_news_box_content'),
-            10
-        );
-    }
-
-
-    public function extra_news_box_content($content)
-    {
-        echo '<h3 style="margin:0">' . __('From the Forums', 'event_espresso') . '</h3>';
-        echo '<div id="ee_forum_posts_content">';
-        $url = 'http://eventespresso.com/forum/event-espresso-support/feed/';
-        EE_Admin_Page::cached_rss_display('ee_forum_posts_content', $url);
-        echo '</div>';
-    }
-
-
-    public function forums_lazy_loading($ids)
-    {
-        $ids[] = 'ee_forum_posts_content';
-        return $ids;
-    }
+	public function __construct()
+	{
+		$this->_do_hooks();
+	}
+
+
+	private function _do_hooks()
+	{
+		add_filter('FHEE_show_sponsors_meta_box', '__return_false', 10);
+		add_filter('FHEE_show_ratings_request_meta_box', '__return_false', 10);
+		add_filter(
+			'FHEE__EE_Admin_Page_Core__load_global_scripts_styles__loader_containers',
+			array($this, 'forums_lazy_loading'),
+			10
+		);
+		add_action(
+			'AHEE__EE_Admin_Page__espresso_news_post_box__after_content',
+			array($this, 'extra_news_box_content'),
+			10
+		);
+	}
+
+
+	public function extra_news_box_content($content)
+	{
+		echo '<h3 style="margin:0">' . __('From the Forums', 'event_espresso') . '</h3>';
+		echo '<div id="ee_forum_posts_content">';
+		$url = 'http://eventespresso.com/forum/event-espresso-support/feed/';
+		EE_Admin_Page::cached_rss_display('ee_forum_posts_content', $url);
+		echo '</div>';
+	}
+
+
+	public function forums_lazy_loading($ids)
+	{
+		$ids[] = 'ee_forum_posts_content';
+		return $ids;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -40,7 +40,7 @@
 
     public function extra_news_box_content($content)
     {
-        echo '<h3 style="margin:0">' . __('From the Forums', 'event_espresso') . '</h3>';
+        echo '<h3 style="margin:0">'.__('From the Forums', 'event_espresso').'</h3>';
         echo '<div id="ee_forum_posts_content">';
         $url = 'http://eventespresso.com/forum/event-espresso-support/feed/';
         EE_Admin_Page::cached_rss_display('ee_forum_posts_content', $url);

espresso.php

Spacing +6 added lines, -6 removed lines

@@ -38,7 +38,7 @@ 
  * @since           4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
+    if ( ! function_exists('espresso_duplicate_plugin_error')) {
         /**
          *    espresso_duplicate_plugin_error
          *    displays if more than one version of EE is activated at the same time
@@ -62,7 +62,7 @@ 
     add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
     define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+    if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
         /**
          * espresso_minimum_php_version_error
          *
@@ -116,11 +116,11 @@ 
 
         register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
+        require_once __DIR__.'/core/bootstrap_espresso.php';
         bootstrap_espresso();
     }
 }
-if (! function_exists('espresso_deactivate_plugin')) {
+if ( ! function_exists('espresso_deactivate_plugin')) {
     /**
      *    deactivate_plugin
      * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
@@ -131,8 +131,8 @@ 
      */
     function espresso_deactivate_plugin($plugin_basename = '')
     {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
+        if ( ! function_exists('deactivate_plugins')) {
+            require_once ABSPATH.'wp-admin/includes/plugin.php';
         }
         unset($_GET['activate'], $_REQUEST['activate']);
         deactivate_plugins($plugin_basename);

Indentation +80 added lines, -80 removed lines

@@ -38,103 +38,103 @@
  * @since           4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.80.rc.103');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.80.rc.103');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
-        bootstrap_espresso();
-    }
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
+		bootstrap_espresso();
+	}
 }
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }

core/db_classes/EE_CPT_Base.class.php

Doc Comments +7 added lines, -7 removed lines

@@ -216,7 +216,7 @@ 
      *
      * @link   http://codex.wordpress.org/Function_Reference/get_the_post_thumbnail
      * @access protected
-     * @param string|array $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array
+     * @param string $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array
      *                           representing width and height in pixels (i.e. array(32,32) ).
      * @param string|array $attr Optional. Query string or array of attributes.
      * @return string HTML image element
@@ -264,7 +264,7 @@ 
      * This is a method for restoring this_obj using details from the given $revision_id
      *
      * @param int   $revision_id       ID of the revision we're getting data from
-     * @param array $related_obj_names if included this will be used to restore for related obj
+     * @param string[] $related_obj_names if included this will be used to restore for related obj
      *                                 if not included then we just do restore on the meta.
      *                                 We will accept an array of related_obj_names for restoration here.
      * @param array $where_query       You can optionally include an array of key=>value pairs
@@ -320,7 +320,7 @@ 
      *
      * @param string  $meta_key
      * @param boolean $single
-     * @return mixed <ul><li>If only $id is set it will return all meta values in an associative array.</li>
+     * @return string|null <ul><li>If only $id is set it will return all meta values in an associative array.</li>
      * <li>If $single is set to false, or left blank, the function returns an array containing all values of the
      * specified key.</li>
      * <li>If $single is set to true, the function returns the first value of the specified key (not in an
@@ -354,8 +354,8 @@ 
     /**
      * Wrapper for add_post_meta, http://codex.wordpress.org/Function_Reference/add_post_meta
      *
-     * @param mixed $meta_key
-     * @param mixed $meta_value
+     * @param string $meta_key
+     * @param string $meta_value
      * @param bool  $unique . If postmeta for this $meta_key already exists, whether to add an additional item or not
      * @return boolean Boolean true, except if the $unique argument was set to true and a custom field with the given
      *                 key already exists, in which case false is returned.
@@ -372,7 +372,7 @@ 
     /**
      * Wrapper for delete_post_meta, http://codex.wordpress.org/Function_Reference/delete_post_meta
      *
-     * @param mixed $meta_key
+     * @param string $meta_key
      * @param mixed $meta_value
      * @return boolean False for failure. True for success.
      */
@@ -402,7 +402,7 @@ 
      * Gets all the term-taxonomies for this CPT
      *
      * @param array $query_params
-     * @return EE_Term_Taxonomy
+     * @return EE_Base_Class[]
      */
     public function term_taxonomies($query_params = array())
     {

Indentation +425 added lines, -425 removed lines

@@ -14,429 +14,429 @@
 abstract class EE_CPT_Base extends EE_Soft_Delete_Base_Class
 {
 
-    /**
-     * This is a property for holding cached feature images on CPT objects.  Cache's are set on the first
-     * "feature_image()" method call.  Each key in the array corresponds to the requested size.
-     *
-     * @var array
-     */
-    protected $_feature_image = array();
-
-    /**
-     * @var WP_Post the WP_Post that corresponds with this CPT model object
-     */
-    protected $_wp_post;
-
-
-    abstract public function wp_user();
-
-
-    /**
-     * Returns the WP post associated with this CPT model object. If this CPT is saved, fetches it
-     * from the DB. Otherwise, create an unsaved WP_POst object. Caches the post internally.
-     *
-     * @return WP_Post
-     */
-    public function wp_post()
-    {
-        global $wpdb;
-        if (! $this->_wp_post instanceof WP_Post) {
-            if ($this->ID()) {
-                $this->_wp_post = get_post($this->ID());
-            } else {
-                $simulated_db_result = new stdClass();
-                foreach ($this->get_model()->field_settings(true) as $field_name => $field_obj) {
-                    if ($this->get_model()->get_table_obj_by_alias($field_obj->get_table_alias())->get_table_name()
-                        === $wpdb->posts
-                    ) {
-                        $column = $field_obj->get_table_column();
-
-                        if ($field_obj instanceof EE_Datetime_Field) {
-                            $value_on_model_obj = $this->get_DateTime_object($field_name);
-                        } elseif ($field_obj->is_db_only_field()) {
-                            $value_on_model_obj = $field_obj->get_default_value();
-                        } else {
-                            $value_on_model_obj = $this->get_raw($field_name);
-                        }
-                        $simulated_db_result->{$column} = $field_obj->prepare_for_use_in_db($value_on_model_obj);
-                    }
-                }
-                $this->_wp_post = new WP_Post($simulated_db_result);
-            }
-            // and let's make retrieving the EE CPT object easy too
-            $classname = get_class($this);
-            if (! isset($this->_wp_post->{$classname})) {
-                $this->_wp_post->{$classname} = $this;
-            }
-        }
-        return $this->_wp_post;
-    }
-
-    /**
-     * When fetching a new value for a post field that uses the global $post for rendering,
-     * set the global $post temporarily to be this model object; and afterwards restore it
-     *
-     * @param string $fieldname
-     * @param bool   $pretty
-     * @param string $extra_cache_ref
-     * @return mixed
-     */
-    protected function _get_fresh_property($fieldname, $pretty = false, $extra_cache_ref = null)
-    {
-        global $post;
-
-        if ($pretty
-            && (
-                ! (
-                    $post instanceof WP_Post
-                    && $post->ID
-                )
-                || (int) $post->ID !== $this->ID()
-            )
-            && $this->get_model()->field_settings_for($fieldname) instanceof EE_Post_Content_Field) {
-            $old_post = $post;
-            $post = $this->wp_post();
-            $return_value = parent::_get_fresh_property($fieldname, $pretty, $extra_cache_ref);
-            $post = $old_post;
-        } else {
-            $return_value = parent::_get_fresh_property($fieldname, $pretty, $extra_cache_ref);
-        }
-        return $return_value;
-    }
-
-    /**
-     * Adds to the specified event category. If it category doesn't exist, creates it.
-     *
-     * @param string $category_name
-     * @param string $category_description    optional
-     * @param int    $parent_term_taxonomy_id optional
-     * @return EE_Term_Taxonomy
-     */
-    public function add_event_category($category_name, $category_description = null, $parent_term_taxonomy_id = null)
-    {
-        return $this->get_model()->add_event_category(
-            $this,
-            $category_name,
-            $category_description,
-            $parent_term_taxonomy_id
-        );
-    }
-
-
-    /**
-     * Removes the event category by specified name from being related ot this event
-     *
-     * @param string $category_name
-     * @return bool
-     */
-    public function remove_event_category($category_name)
-    {
-        return $this->get_model()->remove_event_category($this, $category_name);
-    }
-
-
-    /**
-     * Removes the relation to the specified term taxonomy, and maintains the
-     * data integrity of the term taxonomy provided
-     *
-     * @param EE_Term_Taxonomy $term_taxonomy
-     * @return EE_Base_Class the relation was removed from
-     */
-    public function remove_relation_to_term_taxonomy($term_taxonomy)
-    {
-        if (! $term_taxonomy) {
-            EE_Error::add_error(
-                sprintf(
-                    __(
-                        "No Term_Taxonomy provided which to remove from model object of type %s and id %d",
-                        "event_espresso"
-                    ),
-                    get_class($this),
-                    $this->ID()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        $term_taxonomy->set_count($term_taxonomy->count() - 1);
-        $term_taxonomy->save();
-        return $this->_remove_relation_to($term_taxonomy, 'Term_Taxonomy');
-    }
-
-
-    /**
-     * The main purpose of this method is to return the post type for the model object
-     *
-     * @access public
-     * @return string
-     */
-    public function post_type()
-    {
-        return $this->get_model()->post_type();
-    }
-
-
-    /**
-     * The main purpose of this method is to return the parent for the model object
-     *
-     * @access public
-     * @return int
-     */
-    public function parent()
-    {
-        return $this->get('parent');
-    }
-
-
-    /**
-     * return the _status property
-     *
-     * @return string
-     */
-    public function status()
-    {
-        return $this->get('status');
-    }
-
-
-    /**
-     * @param string $status
-     */
-    public function set_status($status)
-    {
-        $this->set('status', $status);
-    }
-
-
-    /**
-     * This calls the equivalent model method for retrieving the feature image which in turn is a wrapper for
-     * WordPress' get_the_post_thumbnail() function.
-     *
-     * @link   http://codex.wordpress.org/Function_Reference/get_the_post_thumbnail
-     * @access protected
-     * @param string|array $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array
-     *                           representing width and height in pixels (i.e. array(32,32) ).
-     * @param string|array $attr Optional. Query string or array of attributes.
-     * @return string HTML image element
-     */
-    protected function _get_feature_image($size, $attr)
-    {
-        // first let's see if we already have the _feature_image property set AND if it has a cached element on it FOR the given size
-        $attr_key = is_array($attr) ? implode('_', $attr) : $attr;
-        $cache_key = is_array($size) ? implode('_', $size) . $attr_key : $size . $attr_key;
-        $this->_feature_image[ $cache_key ] = isset($this->_feature_image[ $cache_key ])
-            ? $this->_feature_image[ $cache_key ] : $this->get_model()->get_feature_image($this->ID(), $size, $attr);
-        return $this->_feature_image[ $cache_key ];
-    }
-
-
-    /**
-     * See _get_feature_image. Returns the HTML to display a featured image
-     *
-     * @param string       $size
-     * @param string|array $attr
-     * @return string of html
-     */
-    public function feature_image($size = 'thumbnail', $attr = '')
-    {
-        return $this->_get_feature_image($size, $attr);
-    }
-
-
-    /**
-     * This uses the wp "wp_get_attachment_image_src()" function to return the feature image for the current class
-     * using the given size params.
-     *
-     * @param  string|array $size can either be a string: 'thumbnail', 'medium', 'large', 'full' OR 2-item array
-     *                            representing width and height in pixels eg. array(32,32).
-     * @return string|boolean          the url of the image or false if not found
-     */
-    public function feature_image_url($size = 'thumbnail')
-    {
-        $attachment = wp_get_attachment_image_src(get_post_thumbnail_id($this->ID()), $size);
-        return ! empty($attachment) ? $attachment[0] : false;
-    }
-
-
-    /**
-     * This is a method for restoring this_obj using details from the given $revision_id
-     *
-     * @param int   $revision_id       ID of the revision we're getting data from
-     * @param array $related_obj_names if included this will be used to restore for related obj
-     *                                 if not included then we just do restore on the meta.
-     *                                 We will accept an array of related_obj_names for restoration here.
-     * @param array $where_query       You can optionally include an array of key=>value pairs
-     *                                 that allow you to further constrict the relation to being added.
-     *                                 However, keep in mind that the columns (keys) given
-     *                                 must match a column on the JOIN table and currently
-     *                                 only the HABTM models accept these additional conditions.
-     *                                 Also remember that if an exact match isn't found for these extra cols/val pairs,
-     *                                 then a NEW row is created in the join table.
-     *                                 This array is INDEXED by RELATED OBJ NAME (so it corresponds with the obj_names
-     *                                 sent);
-     * @return void
-     */
-    public function restore_revision($revision_id, $related_obj_names = array(), $where_query = array())
-    {
-        // get revision object
-        $revision_obj = $this->get_model()->get_one_by_ID($revision_id);
-        if ($revision_obj instanceof EE_CPT_Base) {
-            // no related_obj_name so we assume we're saving a revision on this object.
-            if (empty($related_obj_names)) {
-                $fields = $this->get_model()->get_meta_table_fields();
-                foreach ($fields as $field) {
-                    $this->set($field, $revision_obj->get($field));
-                }
-                $this->save();
-            }
-            $related_obj_names = (array) $related_obj_names;
-            foreach ($related_obj_names as $related_name) {
-                // related_obj_name so we're saving a revision on an object related to this object
-                // do we have $where_query params for this related object?  If we do then we include that.
-                $cols_n_values = isset($where_query[ $related_name ]) ? $where_query[ $related_name ] : array();
-                $where_params = ! empty($cols_n_values) ? array($cols_n_values) : array();
-                $related_objs = $this->get_many_related($related_name, $where_params);
-                $revision_related_objs = $revision_obj->get_many_related($related_name, $where_params);
-                // load helper
-                // remove related objs from this object that are not in revision
-                // array_diff *should* work cause I think objects are indexed by ID?
-                $related_to_remove = EEH_Array::object_array_diff($related_objs, $revision_related_objs);
-                foreach ($related_to_remove as $rr) {
-                    $this->_remove_relation_to($rr, $related_name, $cols_n_values);
-                }
-                // add all related objs attached to revision to this object
-                foreach ($revision_related_objs as $r_obj) {
-                    $this->_add_relation_to($r_obj, $related_name, $cols_n_values);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Wrapper for get_post_meta, http://codex.wordpress.org/Function_Reference/get_post_meta
-     *
-     * @param string  $meta_key
-     * @param boolean $single
-     * @return mixed <ul><li>If only $id is set it will return all meta values in an associative array.</li>
-     * <li>If $single is set to false, or left blank, the function returns an array containing all values of the
-     * specified key.</li>
-     * <li>If $single is set to true, the function returns the first value of the specified key (not in an
-     * array</li></ul>
-     */
-    public function get_post_meta($meta_key = null, $single = false)
-    {
-        return get_post_meta($this->ID(), $meta_key, $single);
-    }
-
-
-    /**
-     * Wrapper for update_post_meta, http://codex.wordpress.org/Function_Reference/update_post_meta
-     *
-     * @param string $meta_key
-     * @param mixed  $meta_value
-     * @param mixed  $prev_value
-     * @return mixed Returns meta_id if the meta doesn't exist, otherwise returns true on success and false on failure.
-     *               NOTE: If the meta_value passed to this function is the same as the value that is already in the
-     *               database, this function returns false.
-     */
-    public function update_post_meta($meta_key, $meta_value, $prev_value = null)
-    {
-        if (! $this->ID()) {
-            $this->save();
-        }
-        return update_post_meta($this->ID(), $meta_key, $meta_value, $prev_value);
-    }
-
-
-    /**
-     * Wrapper for add_post_meta, http://codex.wordpress.org/Function_Reference/add_post_meta
-     *
-     * @param mixed $meta_key
-     * @param mixed $meta_value
-     * @param bool  $unique . If postmeta for this $meta_key already exists, whether to add an additional item or not
-     * @return boolean Boolean true, except if the $unique argument was set to true and a custom field with the given
-     *                 key already exists, in which case false is returned.
-     */
-    public function add_post_meta($meta_key, $meta_value, $unique = false)
-    {
-        if ($this->ID()) {
-            $this->save();
-        }
-        return add_post_meta($this->ID(), $meta_key, $meta_value, $unique);
-    }
-
-
-    /**
-     * Wrapper for delete_post_meta, http://codex.wordpress.org/Function_Reference/delete_post_meta
-     *
-     * @param mixed $meta_key
-     * @param mixed $meta_value
-     * @return boolean False for failure. True for success.
-     */
-    public function delete_post_meta($meta_key, $meta_value = '')
-    {
-        if (! $this->ID()) {
-            // there are obviously no postmetas for this if it's not saved
-            // so let's just report this as a success
-            return true;
-        }
-        return delete_post_meta($this->ID(), $meta_key, $meta_value);
-    }
-
-
-    /**
-     * Gets the URL for viewing this event on the front-end
-     *
-     * @return string
-     */
-    public function get_permalink()
-    {
-        return get_permalink($this->ID());
-    }
-
-
-    /**
-     * Gets all the term-taxonomies for this CPT
-     *
-     * @param array $query_params
-     * @return EE_Term_Taxonomy
-     */
-    public function term_taxonomies($query_params = array())
-    {
-        return $this->get_many_related('Term_Taxonomy', $query_params);
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function get_custom_post_statuses()
-    {
-        return $this->get_model()->get_custom_post_statuses();
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function get_all_post_statuses()
-    {
-        return $this->get_model()->get_status_array();
-    }
-
-
-    /**
-     * Don't serialize the WP Post. That's just duplicate data and we want to avoid recursion
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        $properties_to_serialize = parent::__sleep();
-        $properties_to_serialize = array_diff($properties_to_serialize, array('_wp_post'));
-        return $properties_to_serialize;
-    }
+	/**
+	 * This is a property for holding cached feature images on CPT objects.  Cache's are set on the first
+	 * "feature_image()" method call.  Each key in the array corresponds to the requested size.
+	 *
+	 * @var array
+	 */
+	protected $_feature_image = array();
+
+	/**
+	 * @var WP_Post the WP_Post that corresponds with this CPT model object
+	 */
+	protected $_wp_post;
+
+
+	abstract public function wp_user();
+
+
+	/**
+	 * Returns the WP post associated with this CPT model object. If this CPT is saved, fetches it
+	 * from the DB. Otherwise, create an unsaved WP_POst object. Caches the post internally.
+	 *
+	 * @return WP_Post
+	 */
+	public function wp_post()
+	{
+		global $wpdb;
+		if (! $this->_wp_post instanceof WP_Post) {
+			if ($this->ID()) {
+				$this->_wp_post = get_post($this->ID());
+			} else {
+				$simulated_db_result = new stdClass();
+				foreach ($this->get_model()->field_settings(true) as $field_name => $field_obj) {
+					if ($this->get_model()->get_table_obj_by_alias($field_obj->get_table_alias())->get_table_name()
+						=== $wpdb->posts
+					) {
+						$column = $field_obj->get_table_column();
+
+						if ($field_obj instanceof EE_Datetime_Field) {
+							$value_on_model_obj = $this->get_DateTime_object($field_name);
+						} elseif ($field_obj->is_db_only_field()) {
+							$value_on_model_obj = $field_obj->get_default_value();
+						} else {
+							$value_on_model_obj = $this->get_raw($field_name);
+						}
+						$simulated_db_result->{$column} = $field_obj->prepare_for_use_in_db($value_on_model_obj);
+					}
+				}
+				$this->_wp_post = new WP_Post($simulated_db_result);
+			}
+			// and let's make retrieving the EE CPT object easy too
+			$classname = get_class($this);
+			if (! isset($this->_wp_post->{$classname})) {
+				$this->_wp_post->{$classname} = $this;
+			}
+		}
+		return $this->_wp_post;
+	}
+
+	/**
+	 * When fetching a new value for a post field that uses the global $post for rendering,
+	 * set the global $post temporarily to be this model object; and afterwards restore it
+	 *
+	 * @param string $fieldname
+	 * @param bool   $pretty
+	 * @param string $extra_cache_ref
+	 * @return mixed
+	 */
+	protected function _get_fresh_property($fieldname, $pretty = false, $extra_cache_ref = null)
+	{
+		global $post;
+
+		if ($pretty
+			&& (
+				! (
+					$post instanceof WP_Post
+					&& $post->ID
+				)
+				|| (int) $post->ID !== $this->ID()
+			)
+			&& $this->get_model()->field_settings_for($fieldname) instanceof EE_Post_Content_Field) {
+			$old_post = $post;
+			$post = $this->wp_post();
+			$return_value = parent::_get_fresh_property($fieldname, $pretty, $extra_cache_ref);
+			$post = $old_post;
+		} else {
+			$return_value = parent::_get_fresh_property($fieldname, $pretty, $extra_cache_ref);
+		}
+		return $return_value;
+	}
+
+	/**
+	 * Adds to the specified event category. If it category doesn't exist, creates it.
+	 *
+	 * @param string $category_name
+	 * @param string $category_description    optional
+	 * @param int    $parent_term_taxonomy_id optional
+	 * @return EE_Term_Taxonomy
+	 */
+	public function add_event_category($category_name, $category_description = null, $parent_term_taxonomy_id = null)
+	{
+		return $this->get_model()->add_event_category(
+			$this,
+			$category_name,
+			$category_description,
+			$parent_term_taxonomy_id
+		);
+	}
+
+
+	/**
+	 * Removes the event category by specified name from being related ot this event
+	 *
+	 * @param string $category_name
+	 * @return bool
+	 */
+	public function remove_event_category($category_name)
+	{
+		return $this->get_model()->remove_event_category($this, $category_name);
+	}
+
+
+	/**
+	 * Removes the relation to the specified term taxonomy, and maintains the
+	 * data integrity of the term taxonomy provided
+	 *
+	 * @param EE_Term_Taxonomy $term_taxonomy
+	 * @return EE_Base_Class the relation was removed from
+	 */
+	public function remove_relation_to_term_taxonomy($term_taxonomy)
+	{
+		if (! $term_taxonomy) {
+			EE_Error::add_error(
+				sprintf(
+					__(
+						"No Term_Taxonomy provided which to remove from model object of type %s and id %d",
+						"event_espresso"
+					),
+					get_class($this),
+					$this->ID()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		$term_taxonomy->set_count($term_taxonomy->count() - 1);
+		$term_taxonomy->save();
+		return $this->_remove_relation_to($term_taxonomy, 'Term_Taxonomy');
+	}
+
+
+	/**
+	 * The main purpose of this method is to return the post type for the model object
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function post_type()
+	{
+		return $this->get_model()->post_type();
+	}
+
+
+	/**
+	 * The main purpose of this method is to return the parent for the model object
+	 *
+	 * @access public
+	 * @return int
+	 */
+	public function parent()
+	{
+		return $this->get('parent');
+	}
+
+
+	/**
+	 * return the _status property
+	 *
+	 * @return string
+	 */
+	public function status()
+	{
+		return $this->get('status');
+	}
+
+
+	/**
+	 * @param string $status
+	 */
+	public function set_status($status)
+	{
+		$this->set('status', $status);
+	}
+
+
+	/**
+	 * This calls the equivalent model method for retrieving the feature image which in turn is a wrapper for
+	 * WordPress' get_the_post_thumbnail() function.
+	 *
+	 * @link   http://codex.wordpress.org/Function_Reference/get_the_post_thumbnail
+	 * @access protected
+	 * @param string|array $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array
+	 *                           representing width and height in pixels (i.e. array(32,32) ).
+	 * @param string|array $attr Optional. Query string or array of attributes.
+	 * @return string HTML image element
+	 */
+	protected function _get_feature_image($size, $attr)
+	{
+		// first let's see if we already have the _feature_image property set AND if it has a cached element on it FOR the given size
+		$attr_key = is_array($attr) ? implode('_', $attr) : $attr;
+		$cache_key = is_array($size) ? implode('_', $size) . $attr_key : $size . $attr_key;
+		$this->_feature_image[ $cache_key ] = isset($this->_feature_image[ $cache_key ])
+			? $this->_feature_image[ $cache_key ] : $this->get_model()->get_feature_image($this->ID(), $size, $attr);
+		return $this->_feature_image[ $cache_key ];
+	}
+
+
+	/**
+	 * See _get_feature_image. Returns the HTML to display a featured image
+	 *
+	 * @param string       $size
+	 * @param string|array $attr
+	 * @return string of html
+	 */
+	public function feature_image($size = 'thumbnail', $attr = '')
+	{
+		return $this->_get_feature_image($size, $attr);
+	}
+
+
+	/**
+	 * This uses the wp "wp_get_attachment_image_src()" function to return the feature image for the current class
+	 * using the given size params.
+	 *
+	 * @param  string|array $size can either be a string: 'thumbnail', 'medium', 'large', 'full' OR 2-item array
+	 *                            representing width and height in pixels eg. array(32,32).
+	 * @return string|boolean          the url of the image or false if not found
+	 */
+	public function feature_image_url($size = 'thumbnail')
+	{
+		$attachment = wp_get_attachment_image_src(get_post_thumbnail_id($this->ID()), $size);
+		return ! empty($attachment) ? $attachment[0] : false;
+	}
+
+
+	/**
+	 * This is a method for restoring this_obj using details from the given $revision_id
+	 *
+	 * @param int   $revision_id       ID of the revision we're getting data from
+	 * @param array $related_obj_names if included this will be used to restore for related obj
+	 *                                 if not included then we just do restore on the meta.
+	 *                                 We will accept an array of related_obj_names for restoration here.
+	 * @param array $where_query       You can optionally include an array of key=>value pairs
+	 *                                 that allow you to further constrict the relation to being added.
+	 *                                 However, keep in mind that the columns (keys) given
+	 *                                 must match a column on the JOIN table and currently
+	 *                                 only the HABTM models accept these additional conditions.
+	 *                                 Also remember that if an exact match isn't found for these extra cols/val pairs,
+	 *                                 then a NEW row is created in the join table.
+	 *                                 This array is INDEXED by RELATED OBJ NAME (so it corresponds with the obj_names
+	 *                                 sent);
+	 * @return void
+	 */
+	public function restore_revision($revision_id, $related_obj_names = array(), $where_query = array())
+	{
+		// get revision object
+		$revision_obj = $this->get_model()->get_one_by_ID($revision_id);
+		if ($revision_obj instanceof EE_CPT_Base) {
+			// no related_obj_name so we assume we're saving a revision on this object.
+			if (empty($related_obj_names)) {
+				$fields = $this->get_model()->get_meta_table_fields();
+				foreach ($fields as $field) {
+					$this->set($field, $revision_obj->get($field));
+				}
+				$this->save();
+			}
+			$related_obj_names = (array) $related_obj_names;
+			foreach ($related_obj_names as $related_name) {
+				// related_obj_name so we're saving a revision on an object related to this object
+				// do we have $where_query params for this related object?  If we do then we include that.
+				$cols_n_values = isset($where_query[ $related_name ]) ? $where_query[ $related_name ] : array();
+				$where_params = ! empty($cols_n_values) ? array($cols_n_values) : array();
+				$related_objs = $this->get_many_related($related_name, $where_params);
+				$revision_related_objs = $revision_obj->get_many_related($related_name, $where_params);
+				// load helper
+				// remove related objs from this object that are not in revision
+				// array_diff *should* work cause I think objects are indexed by ID?
+				$related_to_remove = EEH_Array::object_array_diff($related_objs, $revision_related_objs);
+				foreach ($related_to_remove as $rr) {
+					$this->_remove_relation_to($rr, $related_name, $cols_n_values);
+				}
+				// add all related objs attached to revision to this object
+				foreach ($revision_related_objs as $r_obj) {
+					$this->_add_relation_to($r_obj, $related_name, $cols_n_values);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Wrapper for get_post_meta, http://codex.wordpress.org/Function_Reference/get_post_meta
+	 *
+	 * @param string  $meta_key
+	 * @param boolean $single
+	 * @return mixed <ul><li>If only $id is set it will return all meta values in an associative array.</li>
+	 * <li>If $single is set to false, or left blank, the function returns an array containing all values of the
+	 * specified key.</li>
+	 * <li>If $single is set to true, the function returns the first value of the specified key (not in an
+	 * array</li></ul>
+	 */
+	public function get_post_meta($meta_key = null, $single = false)
+	{
+		return get_post_meta($this->ID(), $meta_key, $single);
+	}
+
+
+	/**
+	 * Wrapper for update_post_meta, http://codex.wordpress.org/Function_Reference/update_post_meta
+	 *
+	 * @param string $meta_key
+	 * @param mixed  $meta_value
+	 * @param mixed  $prev_value
+	 * @return mixed Returns meta_id if the meta doesn't exist, otherwise returns true on success and false on failure.
+	 *               NOTE: If the meta_value passed to this function is the same as the value that is already in the
+	 *               database, this function returns false.
+	 */
+	public function update_post_meta($meta_key, $meta_value, $prev_value = null)
+	{
+		if (! $this->ID()) {
+			$this->save();
+		}
+		return update_post_meta($this->ID(), $meta_key, $meta_value, $prev_value);
+	}
+
+
+	/**
+	 * Wrapper for add_post_meta, http://codex.wordpress.org/Function_Reference/add_post_meta
+	 *
+	 * @param mixed $meta_key
+	 * @param mixed $meta_value
+	 * @param bool  $unique . If postmeta for this $meta_key already exists, whether to add an additional item or not
+	 * @return boolean Boolean true, except if the $unique argument was set to true and a custom field with the given
+	 *                 key already exists, in which case false is returned.
+	 */
+	public function add_post_meta($meta_key, $meta_value, $unique = false)
+	{
+		if ($this->ID()) {
+			$this->save();
+		}
+		return add_post_meta($this->ID(), $meta_key, $meta_value, $unique);
+	}
+
+
+	/**
+	 * Wrapper for delete_post_meta, http://codex.wordpress.org/Function_Reference/delete_post_meta
+	 *
+	 * @param mixed $meta_key
+	 * @param mixed $meta_value
+	 * @return boolean False for failure. True for success.
+	 */
+	public function delete_post_meta($meta_key, $meta_value = '')
+	{
+		if (! $this->ID()) {
+			// there are obviously no postmetas for this if it's not saved
+			// so let's just report this as a success
+			return true;
+		}
+		return delete_post_meta($this->ID(), $meta_key, $meta_value);
+	}
+
+
+	/**
+	 * Gets the URL for viewing this event on the front-end
+	 *
+	 * @return string
+	 */
+	public function get_permalink()
+	{
+		return get_permalink($this->ID());
+	}
+
+
+	/**
+	 * Gets all the term-taxonomies for this CPT
+	 *
+	 * @param array $query_params
+	 * @return EE_Term_Taxonomy
+	 */
+	public function term_taxonomies($query_params = array())
+	{
+		return $this->get_many_related('Term_Taxonomy', $query_params);
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function get_custom_post_statuses()
+	{
+		return $this->get_model()->get_custom_post_statuses();
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function get_all_post_statuses()
+	{
+		return $this->get_model()->get_status_array();
+	}
+
+
+	/**
+	 * Don't serialize the WP Post. That's just duplicate data and we want to avoid recursion
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		$properties_to_serialize = parent::__sleep();
+		$properties_to_serialize = array_diff($properties_to_serialize, array('_wp_post'));
+		return $properties_to_serialize;
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -40,7 +40,7 @@ 
     public function wp_post()
     {
         global $wpdb;
-        if (! $this->_wp_post instanceof WP_Post) {
+        if ( ! $this->_wp_post instanceof WP_Post) {
             if ($this->ID()) {
                 $this->_wp_post = get_post($this->ID());
             } else {
@@ -65,7 +65,7 @@ 
             }
             // and let's make retrieving the EE CPT object easy too
             $classname = get_class($this);
-            if (! isset($this->_wp_post->{$classname})) {
+            if ( ! isset($this->_wp_post->{$classname})) {
                 $this->_wp_post->{$classname} = $this;
             }
         }
@@ -144,7 +144,7 @@ 
      */
     public function remove_relation_to_term_taxonomy($term_taxonomy)
     {
-        if (! $term_taxonomy) {
+        if ( ! $term_taxonomy) {
             EE_Error::add_error(
                 sprintf(
                     __(
@@ -225,10 +225,10 @@ 
     {
         // first let's see if we already have the _feature_image property set AND if it has a cached element on it FOR the given size
         $attr_key = is_array($attr) ? implode('_', $attr) : $attr;
-        $cache_key = is_array($size) ? implode('_', $size) . $attr_key : $size . $attr_key;
-        $this->_feature_image[ $cache_key ] = isset($this->_feature_image[ $cache_key ])
-            ? $this->_feature_image[ $cache_key ] : $this->get_model()->get_feature_image($this->ID(), $size, $attr);
-        return $this->_feature_image[ $cache_key ];
+        $cache_key = is_array($size) ? implode('_', $size).$attr_key : $size.$attr_key;
+        $this->_feature_image[$cache_key] = isset($this->_feature_image[$cache_key])
+            ? $this->_feature_image[$cache_key] : $this->get_model()->get_feature_image($this->ID(), $size, $attr);
+        return $this->_feature_image[$cache_key];
     }
 
 
@@ -295,7 +295,7 @@ 
             foreach ($related_obj_names as $related_name) {
                 // related_obj_name so we're saving a revision on an object related to this object
                 // do we have $where_query params for this related object?  If we do then we include that.
-                $cols_n_values = isset($where_query[ $related_name ]) ? $where_query[ $related_name ] : array();
+                $cols_n_values = isset($where_query[$related_name]) ? $where_query[$related_name] : array();
                 $where_params = ! empty($cols_n_values) ? array($cols_n_values) : array();
                 $related_objs = $this->get_many_related($related_name, $where_params);
                 $revision_related_objs = $revision_obj->get_many_related($related_name, $where_params);
@@ -344,7 +344,7 @@ 
      */
     public function update_post_meta($meta_key, $meta_value, $prev_value = null)
     {
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             $this->save();
         }
         return update_post_meta($this->ID(), $meta_key, $meta_value, $prev_value);
@@ -378,7 +378,7 @@ 
      */
     public function delete_post_meta($meta_key, $meta_value = '')
     {
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             // there are obviously no postmetas for this if it's not saved
             // so let's just report this as a success
             return true;

core/db_classes/EE_CSV.class.php

Doc Comments +6 added lines, -9 removed lines

@@ -326,7 +326,7 @@ 
      * and starts writing the file to PHP's output. Returns the file handle so other functions can
      * also write to it
      *
-     * @param string $new_filename the name of the file that the user will download
+     * @param string|false $filename the name of the file that the user will download
      * @return resource, like the results of fopen(), which can be used for fwrite, fputcsv2, etc.
      */
     public function begin_sending_csv($filename)
@@ -391,10 +391,7 @@ 
      *
      * @param array   $data                 2D array, first numerically-indexed, and next-level-down preferably indexed
      *                                      by string
-     * @param boolean $add_csv_column_names whether or not we should add the keys in the bottom-most array as a row for
-     *                                      headers in the CSV. Eg, if $data looked like
-     *                                      array(0=>array('EVT_ID'=>1,'EVT_name'=>'monkey'...), 1=>array(...),...))
-     *                                      then the first row we'd write to the CSV would be "EVT_ID,EVT_name,..."
+     * @param resource $filehandle
      * @return boolean if we successfully wrote to the CSV or not. If there's no $data, we consider that a success
      *                 (because we wrote everything there was...nothing)
      */
@@ -491,7 +488,7 @@ 
      *                                   next layer is numerically indexed to represent each model object (eg, each
      *                                   individual event), and the last layer has all the attributes o fthat model
      *                                   object (eg, the event's id, name, etc)
-     * @return boolean success
+     * @return boolean|null success
      */
     public function write_model_data_to_csv($filehandle, $model_data_array)
     {
@@ -522,8 +519,8 @@ 
      * and dies (in order to avoid other plugins from messing up the csv output)
      *
      * @param string $filename         the filename you want to give the file
-     * @param array  $model_data_array 3d array, as described in EE_CSV::write_model_data_to_csv()
-     * @return bool | void writes CSV file to output and dies
+     * @param boolean  $model_data_array 3d array, as described in EE_CSV::write_model_data_to_csv()
+     * @return boolean|null | void writes CSV file to output and dies
      */
     public function export_multiple_model_data_to_csv($filename, $model_data_array)
     {
@@ -537,7 +534,7 @@ 
      * @access public
      * @param array  $data     - the array of data to be converted to csv and exported
      * @param string $filename - name for newly created csv file
-     * @return TRUE on success, FALSE on fail
+     * @return false|null on success, FALSE on fail
      */
     public function export_array_to_csv($data = false, $filename = false)
     {

Indentation +669 added lines, -669 removed lines

@@ -16,673 +16,673 @@
 class EE_CSV
 {
 
-    // instance of the EE_CSV object
-    private static $_instance = null;
-
-
-    // multidimensional array to store update & error messages
-    // var $_notices = array( 'updates' => array(), 'errors' => array() );
-
-
-    private $_primary_keys;
-
-    /**
-     *
-     * @var EE_Registry
-     */
-    private $EE;
-    /**
-     * string used for 1st cell in exports, which indicates that the following 2 rows will be metadata keys and values
-     */
-    const metadata_header = 'Event Espresso Export Meta Data';
-
-    /**
-     *        private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access private
-     * @return void
-     */
-    private function __construct()
-    {
-        global $wpdb;
-
-        $this->_primary_keys = array(
-            $wpdb->prefix . 'esp_answer'                  => array('ANS_ID'),
-            $wpdb->prefix . 'esp_attendee'                => array('ATT_ID'),
-            $wpdb->prefix . 'esp_datetime'                => array('DTT_ID'),
-            $wpdb->prefix . 'esp_event_question_group'    => array('EQG_ID'),
-            $wpdb->prefix . 'esp_message_template'        => array('MTP_ID'),
-            $wpdb->prefix . 'esp_payment'                 => array('PAY_ID'),
-            $wpdb->prefix . 'esp_price'                   => array('PRC_ID'),
-            $wpdb->prefix . 'esp_price_type'              => array('PRT_ID'),
-            $wpdb->prefix . 'esp_question'                => array('QST_ID'),
-            $wpdb->prefix . 'esp_question_group'          => array('QSG_ID'),
-            $wpdb->prefix . 'esp_question_group_question' => array('QGQ_ID'),
-            $wpdb->prefix . 'esp_question_option'         => array('QSO_ID'),
-            $wpdb->prefix . 'esp_registration'            => array('REG_ID'),
-            $wpdb->prefix . 'esp_status'                  => array('STS_ID'),
-            $wpdb->prefix . 'esp_transaction'             => array('TXN_ID'),
-            $wpdb->prefix . 'esp_transaction'             => array('TXN_ID'),
-            $wpdb->prefix . 'events_detail'               => array('id'),
-            $wpdb->prefix . 'events_category_detail'      => array('id'),
-            $wpdb->prefix . 'events_category_rel'         => array('id'),
-            $wpdb->prefix . 'events_venue'                => array('id'),
-            $wpdb->prefix . 'events_venue_rel'            => array('emeta_id'),
-            $wpdb->prefix . 'events_locale'               => array('id'),
-            $wpdb->prefix . 'events_locale_rel'           => array('id'),
-            $wpdb->prefix . 'events_personnel'            => array('id'),
-            $wpdb->prefix . 'events_personnel_rel'        => array('id'),
-        );
-    }
-
-
-    /**
-     *        @ singleton method used to instantiate class object
-     *        @ access public
-     *
-     * @return EE_CSV
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (self::$_instance === null or ! is_object(self::$_instance) or ! (self::$_instance instanceof EE_CSV)) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-    /**
-     * Opens a unicode or utf file (normal file_get_contents has difficulty readin ga unicode file. @see
-     * http://stackoverflow.com/questions/15092764/how-to-read-unicode-text-file-in-php
-     *
-     * @param string $file_path
-     * @return string
-     * @throws EE_Error
-     */
-    private function read_unicode_file($file_path)
-    {
-        $fc = "";
-        $fh = fopen($file_path, "rb");
-        if (! $fh) {
-            throw new EE_Error(sprintf(__("Cannot open file for read: %s<br>\n", 'event_espresso'), $file_path));
-        }
-        $flen = filesize($file_path);
-        $bc = fread($fh, $flen);
-        for ($i = 0; $i < $flen; $i++) {
-            $c = substr($bc, $i, 1);
-            if ((ord($c) != 0) && (ord($c) != 13)) {
-                $fc = $fc . $c;
-            }
-        }
-        if ((ord(substr($fc, 0, 1)) == 255) && (ord(substr($fc, 1, 1)) == 254)) {
-            $fc = substr($fc, 2);
-        }
-        return ($fc);
-    }
-
-
-    /**
-     * Generic CSV-functionality to turn an entire CSV file into a single array that's
-     * NOT in a specific format to EE. It's just a 2-level array, with top-level arrays
-     * representing each row in the CSV file, and the second-level arrays being each column in that row
-     *
-     * @param string $path_to_file
-     * @return array of arrays. Top-level array has rows, second-level array has each item
-     */
-    public function import_csv_to_multi_dimensional_array($path_to_file)
-    {
-        // needed to deal with Mac line endings
-        ini_set('auto_detect_line_endings', true);
-
-        // because fgetcsv does not correctly deal with backslashed quotes such as \"
-        // we'll read the file into a string
-        $file_contents = $this->read_unicode_file($path_to_file);
-        // replace backslashed quotes with CSV enclosures
-        $file_contents = str_replace('\\"', '"""', $file_contents);
-        // HEY YOU! PUT THAT FILE BACK!!!
-        file_put_contents($path_to_file, $file_contents);
-
-        if (($file_handle = fopen($path_to_file, "r")) !== false) {
-            # Set the parent multidimensional array key to 0.
-            $nn = 0;
-            $csvarray = array();
-
-            // in PHP 5.3 fgetcsv accepts a 5th parameter, but the pre 5.3 versions of fgetcsv choke if passed more than 4 - is that crazy or what?
-            if (version_compare(PHP_VERSION, '5.3.0') < 0) {
-                //  PHP 5.2- version
-                // loop through each row of the file
-                while (($data = fgetcsv($file_handle, 0, ',', '"')) !== false) {
-                    $csvarray[] = $data;
-                }
-            } else {
-                // loop through each row of the file
-                while (($data = fgetcsv($file_handle, 0, ',', '"', '\\')) !== false) {
-                    $csvarray[] = $data;
-                }
-            }
-            # Close the File.
-            fclose($file_handle);
-            return $csvarray;
-        } else {
-            EE_Error::add_error(
-                sprintf(__("An error occurred - the file: %s could not opened.", "event_espresso"), $path_to_file),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-    }
-
-
-    /**
-     * @Import contents of csv file and store values in an array to be manipulated by other functions
-     * @access public
-     * @param string  $path_to_file         - the csv file to be imported including the path to it's location.
-     *                                      If $model_name is provided, assumes that each row in the CSV represents a
-     *                                      model object for that model If $model_name ISN'T provided, assumes that
-     *                                      before model object data, there is a row where the first entry is simply
-     *                                      'MODEL', and next entry is the model's name, (untranslated) like Event, and
-     *                                      then maybe a row of headers, and then the model data. Eg.
-     *                                      '<br>MODEL,Event,<br>EVT_ID,EVT_name,...<br>1,Monkey
-     *                                      Party,...<br>2,Llamarama,...<br>MODEL,Venue,<br>VNU_ID,VNU_name<br>1,The
-     *                                      Forest
-     * @param string  $model_name           model name if we know what model we're importing
-     * @param boolean $first_row_is_headers - whether the first row of data is headers or not - TRUE = headers, FALSE =
-     *                                      data
-     * @return mixed - array on success - multi dimensional with headers as keys (if headers exist) OR string on fail -
-     *               error message like the following array('Event'=>array( array('EVT_ID'=>1,'EVT_name'=>'bob
-     *               party',...), array('EVT_ID'=>2,'EVT_name'=>'llamarama',...),
-     *                                      ...
-     *                                      )
-     *                                      'Venue'=>array(
-     *                                      array('VNU_ID'=>1,'VNU_name'=>'the shack',...),
-     *                                      array('VNU_ID'=>2,'VNU_name'=>'tree house',...),
-     *                                      ...
-     *                                      )
-     *                                      ...
-     *                                      )
-     */
-    public function import_csv_to_model_data_array($path_to_file, $model_name = false, $first_row_is_headers = true)
-    {
-        $multi_dimensional_array = $this->import_csv_to_multi_dimensional_array($path_to_file);
-        if (! $multi_dimensional_array) {
-            return false;
-        }
-        // gotta start somewhere
-        $row = 1;
-        // array to store csv data in
-        $ee_formatted_data = array();
-        // array to store headers (column names)
-        $headers = array();
-        foreach ($multi_dimensional_array as $data) {
-            // if first cell is MODEL, then second cell is the MODEL name
-            if ($data[0] == 'MODEL') {
-                $model_name = $data[1];
-                // don't bother looking for model data in this row. The rest of this
-                // row should be blank
-                // AND pretend this is the first row again
-                $row = 1;
-                // reset headers
-                $headers = array();
-                continue;
-            }
-            if (strpos($data[0], EE_CSV::metadata_header) !== false) {
-                $model_name = EE_CSV::metadata_header;
-                // store like model data, we just won't try importing it etc.
-                $row = 1;
-                continue;
-            }
-
-
-            // how many columns are there?
-            $columns = count($data);
-
-            $model_entry = array();
-            // loop through each column
-            for ($i = 0; $i < $columns; $i++) {
-                // replace csv_enclosures with backslashed quotes
-                $data[ $i ] = str_replace('"""', '\\"', $data[ $i ]);
-                // do we need to grab the column names?
-                if ($row === 1) {
-                    if ($first_row_is_headers) {
-                        // store the column names to use for keys
-                        $column_name = $data[ $i ];
-                        // check it's not blank... sometimes CSV editign programs adda bunch of empty columns onto the end...
-                        if (! $column_name) {
-                            continue;
-                        }
-                        $matches = array();
-                        if ($model_name == EE_CSV::metadata_header) {
-                            $headers[ $i ] = $column_name;
-                        } else {
-                            // now get the db table name from it (the part between square brackets)
-                            $success = preg_match('~(.*)\[(.*)\]~', $column_name, $matches);
-                            if (! $success) {
-                                EE_Error::add_error(
-                                    sprintf(
-                                        __(
-                                            "The column titled %s is invalid for importing. It must be be in the format of 'Nice Name[model_field_name]' in row %s",
-                                            "event_espresso"
-                                        ),
-                                        $column_name,
-                                        implode(",", $data)
-                                    ),
-                                    __FILE__,
-                                    __FUNCTION__,
-                                    __LINE__
-                                );
-                                return false;
-                            }
-                            $headers[ $i ] = $matches[2];
-                        }
-                    } else {
-                        // no column names means our final array will just use counters for keys
-                        $model_entry[ $headers[ $i ] ] = $data[ $i ];
-                        $headers[ $i ] = $i;
-                    }
-                    // and we need to store csv data
-                } else {
-                    // this column isn' ta header, store it if there is a header for it
-                    if (isset($headers[ $i ])) {
-                        $model_entry[ $headers[ $i ] ] = $data[ $i ];
-                    }
-                }
-            }
-            // save the row's data IF it's a non-header-row
-            if (! $first_row_is_headers || ($first_row_is_headers && $row > 1)) {
-                $ee_formatted_data[ $model_name ][] = $model_entry;
-            }
-            // advance to next row
-            $row++;
-        }
-
-        // delete the uploaded file
-        unlink($path_to_file);
-        // echo '<pre style="height:auto;border:2px solid lightblue;">' . print_r( $ee_formatted_data, TRUE ) . '</pre><br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>';
-        // die();
-
-        // it's good to give back
-        return $ee_formatted_data;
-    }
-
-
-    public function save_csv_to_db($csv_data_array, $model_name = false)
-    {
-        EE_Error::doing_it_wrong(
-            'save_csv_to_db',
-            __(
-                'Function moved to EE_Import and renamed to save_csv_data_array_to_db',
-                'event_espresso'
-            ),
-            '4.6.7'
-        );
-        return EE_Import::instance()->save_csv_data_array_to_db($csv_data_array, $model_name);
-    }
-
-    /**
-     * Sends HTTP headers to indicate that the browser should download a file,
-     * and starts writing the file to PHP's output. Returns the file handle so other functions can
-     * also write to it
-     *
-     * @param string $new_filename the name of the file that the user will download
-     * @return resource, like the results of fopen(), which can be used for fwrite, fputcsv2, etc.
-     */
-    public function begin_sending_csv($filename)
-    {
-        // grab file extension
-        $ext = substr(strrchr($filename, '.'), 1);
-        if ($ext == '.csv' or $ext == '.xls') {
-            str_replace($ext, '', $filename);
-        }
-        $filename .= '.csv';
-
-        // if somebody's been naughty and already started outputting stuff, trash it
-        // and start writing our stuff.
-        if (ob_get_length()) {
-            @ob_flush();
-            @flush();
-            @ob_end_flush();
-        }
-        @ob_start();
-        header("Pragma: public");
-        header("Expires: 0");
-        header("Pragma: no-cache");
-        header("Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
-        // header("Content-Type: application/force-download");
-        // header("Content-Type: application/octet-stream");
-        // header("Content-Type: application/download");
-        header('Content-disposition: attachment; filename=' . $filename);
-        header("Content-Type: text/csv; charset=utf-8");
-        do_action('AHEE__EE_CSV__begin_sending_csv__headers');
-        echo apply_filters(
-            'FHEE__EE_CSV__begin_sending_csv__start_writing',
-            "\xEF\xBB\xBF"
-        ); // makes excel open it as UTF-8. UTF-8 BOM, see http://stackoverflow.com/a/4440143/2773835
-        $fh = fopen('php://output', 'w');
-        return $fh;
-    }
-
-    /**
-     * Writes some meta data to the CSV as a bunch of columns. Initially we're only
-     * mentioning the version and timezone
-     *
-     * @param resource $filehandle
-     */
-    public function write_metadata_to_csv($filehandle)
-    {
-        $data_row = array(EE_CSV::metadata_header);// do NOT translate because this exact string is used when importing
-        $this->fputcsv2($filehandle, $data_row);
-        $meta_data = array(
-            0 => array(
-                'version'        => espresso_version(),
-                'timezone'       => EEH_DTT_Helper::get_timezone(),
-                'time_of_export' => current_time('mysql'),
-                'site_url'       => site_url(),
-            ),
-        );
-        $this->write_data_array_to_csv($filehandle, $meta_data);
-    }
-
-
-    /**
-     * Writes $data to the csv file open in $filehandle. uses the array indices of $data for column headers
-     *
-     * @param array   $data                 2D array, first numerically-indexed, and next-level-down preferably indexed
-     *                                      by string
-     * @param boolean $add_csv_column_names whether or not we should add the keys in the bottom-most array as a row for
-     *                                      headers in the CSV. Eg, if $data looked like
-     *                                      array(0=>array('EVT_ID'=>1,'EVT_name'=>'monkey'...), 1=>array(...),...))
-     *                                      then the first row we'd write to the CSV would be "EVT_ID,EVT_name,..."
-     * @return boolean if we successfully wrote to the CSV or not. If there's no $data, we consider that a success
-     *                 (because we wrote everything there was...nothing)
-     */
-    public function write_data_array_to_csv($filehandle, $data)
-    {
-
-
-        // determine if $data is actually a 2d array
-        if ($data && is_array($data) && is_array(EEH_Array::get_one_item_from_array($data))) {
-            // make sure top level is numerically indexed,
-
-            if (EEH_Array::is_associative_array($data)) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            "top-level array must be numerically indexed. Does these look like numbers to you? %s",
-                            "event_espresso"
-                        ),
-                        implode(",", array_keys($data))
-                    )
-                );
-            }
-            $item_in_top_level_array = EEH_Array::get_one_item_from_array($data);
-            // now, is the last item in the top-level array of $data an associative or numeric array?
-            if (EEH_Array::is_associative_array($item_in_top_level_array)) {
-                // its associative, so we want to output its keys as column headers
-                $keys = array_keys($item_in_top_level_array);
-                echo $this->fputcsv2($filehandle, $keys);
-            }
-            // start writing data
-            foreach ($data as $data_row) {
-                echo $this->fputcsv2($filehandle, $data_row);
-            }
-            return true;
-        } else {
-            // no data TO write... so we can assume that's a success
-            return true;
-        }
-        // //if 2nd level is indexed by strings, use those as csv column headers (ie, the first row)
-        //
-        //
-        // $no_table = TRUE;
-        //
-        // // loop through data and add each row to the file/stream as csv
-        // foreach ( $data as $model_name => $model_data ) {
-        // // test first row to see if it is data or a model name
-        // $model = EE_Registry::instance();->load_model($model_name);
-        // //if the model really exists,
-        // if ( $model ) {
-        //
-        // // we have a table name
-        // $no_table = FALSE;
-        //
-        // // put the tablename into an array cuz that's how fputcsv rolls
-        // $model_name_row = array( 'MODEL', $model_name );
-        //
-        // // add table name to csv output
-        // echo self::fputcsv2($filehandle, $model_name_row);
-        //
-        // // now get the rest of the data
-        // foreach ( $model_data as $row ) {
-        // // output the row
-        // echo self::fputcsv2($filehandle, $row);
-        // }
-        //
-        // }
-        //
-        // if ( $no_table ) {
-        // // no table so just put the data
-        // echo self::fputcsv2($filehandle, $model_data);
-        // }
-        //
-        // } // END OF foreach ( $data )
-    }
-
-    /**
-     * Should be called after begin_sending_csv(), and one or more write_data_array_to_csv()s.
-     * Calls exit to prevent polluting the CSV file with other junk
-     *
-     * @param resource $fh filehandle where we're writing the CSV to
-     */
-    public function end_sending_csv($fh)
-    {
-        fclose($fh);
-        exit(0);
-    }
-
-    /**
-     * Given an open file, writes all the model data to it in the format the importer expects.
-     * Usually preceded by begin_sending_csv($filename), and followed by end_sending_csv($filehandle).
-     *
-     * @param resource $filehandle
-     * @param array    $model_data_array is assumed to be a 3d array: 1st layer has keys of model names (eg 'Event'),
-     *                                   next layer is numerically indexed to represent each model object (eg, each
-     *                                   individual event), and the last layer has all the attributes o fthat model
-     *                                   object (eg, the event's id, name, etc)
-     * @return boolean success
-     */
-    public function write_model_data_to_csv($filehandle, $model_data_array)
-    {
-        $this->write_metadata_to_csv($filehandle);
-        foreach ($model_data_array as $model_name => $model_instance_arrays) {
-            // first: output a special row stating the model
-            echo $this->fputcsv2($filehandle, array('MODEL', $model_name));
-            // if we have items to put in the CSV, do it normally
-
-            if (! empty($model_instance_arrays)) {
-                $this->write_data_array_to_csv($filehandle, $model_instance_arrays);
-            } else {
-                // echo "no data to write... so just write the headers";
-                // so there's actually NO model objects for that model.
-                // probably still want to show the columns
-                $model = EE_Registry::instance()->load_model($model_name);
-                $column_names = array();
-                foreach ($model->field_settings() as $field) {
-                    $column_names[ $field->get_nicename() . "[" . $field->get_name() . "]" ] = null;
-                }
-                $this->write_data_array_to_csv($filehandle, array($column_names));
-            }
-        }
-    }
-
-    /**
-     * Writes the CSV file to the output buffer, with rows corresponding to $model_data_array,
-     * and dies (in order to avoid other plugins from messing up the csv output)
-     *
-     * @param string $filename         the filename you want to give the file
-     * @param array  $model_data_array 3d array, as described in EE_CSV::write_model_data_to_csv()
-     * @return bool | void writes CSV file to output and dies
-     */
-    public function export_multiple_model_data_to_csv($filename, $model_data_array)
-    {
-        $filehandle = $this->begin_sending_csv($filename);
-        $this->write_model_data_to_csv($filehandle, $model_data_array);
-        $this->end_sending_csv($filehandle);
-    }
-
-    /**
-     * @Export contents of an array to csv file
-     * @access public
-     * @param array  $data     - the array of data to be converted to csv and exported
-     * @param string $filename - name for newly created csv file
-     * @return TRUE on success, FALSE on fail
-     */
-    public function export_array_to_csv($data = false, $filename = false)
-    {
-
-        // no data file?? get outta here
-        if (! $data or ! is_array($data) or empty($data)) {
-            return false;
-        }
-
-        // no filename?? get outta here
-        if (! $filename) {
-            return false;
-        }
-
-
-        // somebody told me i might need this ???
-        global $wpdb;
-        $prefix = $wpdb->prefix;
-
-
-        $fh = $this->begin_sending_csv($filename);
-
-
-        $this->end_sending_csv($fh);
-    }
-
-
-    /**
-     * @Determine the maximum upload file size based on php.ini settings
-     * @access    public
-     * @param int $percent_of_max - desired percentage of the max upload_mb
-     * @return int KB
-     */
-    public function get_max_upload_size($percent_of_max = false)
-    {
-
-        $max_upload = (int) (ini_get('upload_max_filesize'));
-        $max_post = (int) (ini_get('post_max_size'));
-        $memory_limit = (int) (ini_get('memory_limit'));
-
-        // determine the smallest of the three values from above
-        $upload_mb = min($max_upload, $max_post, $memory_limit);
-
-        // convert MB to KB
-        $upload_mb = $upload_mb * 1024;
-
-        // don't want the full monty? then reduce the max uplaod size
-        if ($percent_of_max) {
-            // is percent_of_max like this -> 50 or like this -> 0.50 ?
-            if ($percent_of_max > 1) {
-                // chnages 50 to 0.50
-                $percent_of_max = $percent_of_max / 100;
-            }
-            // make upload_mb a percentage of the max upload_mb
-            $upload_mb = $upload_mb * $percent_of_max;
-        }
-
-        return $upload_mb;
-    }
-
-
-    /**
-     * @Drop   in replacement for PHP's fputcsv function - but this one works!!!
-     * @access private
-     * @param resource $fh         - file handle - what we are writing to
-     * @param array    $row        - individual row of csv data
-     * @param string   $delimiter  - csv delimiter
-     * @param string   $enclosure  - csv enclosure
-     * @param string   $mysql_null - allows php NULL to be overridden with MySQl's insertable NULL value
-     * @return void
-     */
-    private function fputcsv2($fh, array $row, $delimiter = ',', $enclosure = '"', $mysql_null = false)
-    {
-        // Allow user to filter the csv delimiter and enclosure for other countries csv standards
-        $delimiter = apply_filters('FHEE__EE_CSV__fputcsv2__delimiter', $delimiter);
-        $enclosure = apply_filters('FHEE__EE_CSV__fputcsv2__enclosure', $enclosure);
-
-        $delimiter_esc = preg_quote($delimiter, '/');
-        $enclosure_esc = preg_quote($enclosure, '/');
-
-        $output = array();
-        foreach ($row as $field_value) {
-            if (is_object($field_value) || is_array($field_value)) {
-                $field_value = serialize($field_value);
-            }
-            if ($field_value === null && $mysql_null) {
-                $output[] = 'NULL';
-                continue;
-            }
-
-            $output[] = preg_match("/(?:${delimiter_esc}|${enclosure_esc}|\s)/", $field_value) ?
-                ($enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure)
-                : $field_value;
-        }
-
-        fwrite($fh, join($delimiter, $output) . PHP_EOL);
-    }
-
-
-    // /**
-    //  * @CSV    Import / Export messages
-    //  * @access public
-    //  * @return void
-    //  */
-    // public function csv_admin_notices()
-    // {
-    //
-    //     // We play both kinds of music here! Country AND Western! - err... I mean, cycle through both types of notices
-    //     foreach (array('updates', 'errors') as $type) {
-    //
-    //         // if particular notice type is not empty, then "You've got Mail"
-    //         if (! empty($this->_notices[ $type ])) {
-    //
-    //             // is it an update or an error ?
-    //             $msg_class = $type == 'updates' ? 'updated' : 'error';
-    //             echo '<div id="message" class="' . $msg_class . '">';
-    //             // display each notice, however many that may be
-    //             foreach ($this->_notices[ $type ] as $message) {
-    //                 echo '<p>' . $message . '</p>';
-    //             }
-    //             // wrap it up
-    //             echo '</div>';
-    //         }
-    //     }
-    // }
-
-    /**
-     * Gets the date format to use in teh csv. filterable
-     *
-     * @param string $current_format
-     * @return string
-     */
-    public function get_date_format_for_csv($current_format = null)
-    {
-        return apply_filters('FHEE__EE_CSV__get_date_format_for_csv__format', 'Y-m-d', $current_format);
-    }
-
-    /**
-     * Gets the time format we want to use in CSV reports. Filterable
-     *
-     * @param string $current_format
-     * @return string
-     */
-    public function get_time_format_for_csv($current_format = null)
-    {
-        return apply_filters('FHEE__EE_CSV__get_time_format_for_csv__format', 'H:i:s', $current_format);
-    }
+	// instance of the EE_CSV object
+	private static $_instance = null;
+
+
+	// multidimensional array to store update & error messages
+	// var $_notices = array( 'updates' => array(), 'errors' => array() );
+
+
+	private $_primary_keys;
+
+	/**
+	 *
+	 * @var EE_Registry
+	 */
+	private $EE;
+	/**
+	 * string used for 1st cell in exports, which indicates that the following 2 rows will be metadata keys and values
+	 */
+	const metadata_header = 'Event Espresso Export Meta Data';
+
+	/**
+	 *        private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access private
+	 * @return void
+	 */
+	private function __construct()
+	{
+		global $wpdb;
+
+		$this->_primary_keys = array(
+			$wpdb->prefix . 'esp_answer'                  => array('ANS_ID'),
+			$wpdb->prefix . 'esp_attendee'                => array('ATT_ID'),
+			$wpdb->prefix . 'esp_datetime'                => array('DTT_ID'),
+			$wpdb->prefix . 'esp_event_question_group'    => array('EQG_ID'),
+			$wpdb->prefix . 'esp_message_template'        => array('MTP_ID'),
+			$wpdb->prefix . 'esp_payment'                 => array('PAY_ID'),
+			$wpdb->prefix . 'esp_price'                   => array('PRC_ID'),
+			$wpdb->prefix . 'esp_price_type'              => array('PRT_ID'),
+			$wpdb->prefix . 'esp_question'                => array('QST_ID'),
+			$wpdb->prefix . 'esp_question_group'          => array('QSG_ID'),
+			$wpdb->prefix . 'esp_question_group_question' => array('QGQ_ID'),
+			$wpdb->prefix . 'esp_question_option'         => array('QSO_ID'),
+			$wpdb->prefix . 'esp_registration'            => array('REG_ID'),
+			$wpdb->prefix . 'esp_status'                  => array('STS_ID'),
+			$wpdb->prefix . 'esp_transaction'             => array('TXN_ID'),
+			$wpdb->prefix . 'esp_transaction'             => array('TXN_ID'),
+			$wpdb->prefix . 'events_detail'               => array('id'),
+			$wpdb->prefix . 'events_category_detail'      => array('id'),
+			$wpdb->prefix . 'events_category_rel'         => array('id'),
+			$wpdb->prefix . 'events_venue'                => array('id'),
+			$wpdb->prefix . 'events_venue_rel'            => array('emeta_id'),
+			$wpdb->prefix . 'events_locale'               => array('id'),
+			$wpdb->prefix . 'events_locale_rel'           => array('id'),
+			$wpdb->prefix . 'events_personnel'            => array('id'),
+			$wpdb->prefix . 'events_personnel_rel'        => array('id'),
+		);
+	}
+
+
+	/**
+	 *        @ singleton method used to instantiate class object
+	 *        @ access public
+	 *
+	 * @return EE_CSV
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (self::$_instance === null or ! is_object(self::$_instance) or ! (self::$_instance instanceof EE_CSV)) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+	/**
+	 * Opens a unicode or utf file (normal file_get_contents has difficulty readin ga unicode file. @see
+	 * http://stackoverflow.com/questions/15092764/how-to-read-unicode-text-file-in-php
+	 *
+	 * @param string $file_path
+	 * @return string
+	 * @throws EE_Error
+	 */
+	private function read_unicode_file($file_path)
+	{
+		$fc = "";
+		$fh = fopen($file_path, "rb");
+		if (! $fh) {
+			throw new EE_Error(sprintf(__("Cannot open file for read: %s<br>\n", 'event_espresso'), $file_path));
+		}
+		$flen = filesize($file_path);
+		$bc = fread($fh, $flen);
+		for ($i = 0; $i < $flen; $i++) {
+			$c = substr($bc, $i, 1);
+			if ((ord($c) != 0) && (ord($c) != 13)) {
+				$fc = $fc . $c;
+			}
+		}
+		if ((ord(substr($fc, 0, 1)) == 255) && (ord(substr($fc, 1, 1)) == 254)) {
+			$fc = substr($fc, 2);
+		}
+		return ($fc);
+	}
+
+
+	/**
+	 * Generic CSV-functionality to turn an entire CSV file into a single array that's
+	 * NOT in a specific format to EE. It's just a 2-level array, with top-level arrays
+	 * representing each row in the CSV file, and the second-level arrays being each column in that row
+	 *
+	 * @param string $path_to_file
+	 * @return array of arrays. Top-level array has rows, second-level array has each item
+	 */
+	public function import_csv_to_multi_dimensional_array($path_to_file)
+	{
+		// needed to deal with Mac line endings
+		ini_set('auto_detect_line_endings', true);
+
+		// because fgetcsv does not correctly deal with backslashed quotes such as \"
+		// we'll read the file into a string
+		$file_contents = $this->read_unicode_file($path_to_file);
+		// replace backslashed quotes with CSV enclosures
+		$file_contents = str_replace('\\"', '"""', $file_contents);
+		// HEY YOU! PUT THAT FILE BACK!!!
+		file_put_contents($path_to_file, $file_contents);
+
+		if (($file_handle = fopen($path_to_file, "r")) !== false) {
+			# Set the parent multidimensional array key to 0.
+			$nn = 0;
+			$csvarray = array();
+
+			// in PHP 5.3 fgetcsv accepts a 5th parameter, but the pre 5.3 versions of fgetcsv choke if passed more than 4 - is that crazy or what?
+			if (version_compare(PHP_VERSION, '5.3.0') < 0) {
+				//  PHP 5.2- version
+				// loop through each row of the file
+				while (($data = fgetcsv($file_handle, 0, ',', '"')) !== false) {
+					$csvarray[] = $data;
+				}
+			} else {
+				// loop through each row of the file
+				while (($data = fgetcsv($file_handle, 0, ',', '"', '\\')) !== false) {
+					$csvarray[] = $data;
+				}
+			}
+			# Close the File.
+			fclose($file_handle);
+			return $csvarray;
+		} else {
+			EE_Error::add_error(
+				sprintf(__("An error occurred - the file: %s could not opened.", "event_espresso"), $path_to_file),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+	}
+
+
+	/**
+	 * @Import contents of csv file and store values in an array to be manipulated by other functions
+	 * @access public
+	 * @param string  $path_to_file         - the csv file to be imported including the path to it's location.
+	 *                                      If $model_name is provided, assumes that each row in the CSV represents a
+	 *                                      model object for that model If $model_name ISN'T provided, assumes that
+	 *                                      before model object data, there is a row where the first entry is simply
+	 *                                      'MODEL', and next entry is the model's name, (untranslated) like Event, and
+	 *                                      then maybe a row of headers, and then the model data. Eg.
+	 *                                      '<br>MODEL,Event,<br>EVT_ID,EVT_name,...<br>1,Monkey
+	 *                                      Party,...<br>2,Llamarama,...<br>MODEL,Venue,<br>VNU_ID,VNU_name<br>1,The
+	 *                                      Forest
+	 * @param string  $model_name           model name if we know what model we're importing
+	 * @param boolean $first_row_is_headers - whether the first row of data is headers or not - TRUE = headers, FALSE =
+	 *                                      data
+	 * @return mixed - array on success - multi dimensional with headers as keys (if headers exist) OR string on fail -
+	 *               error message like the following array('Event'=>array( array('EVT_ID'=>1,'EVT_name'=>'bob
+	 *               party',...), array('EVT_ID'=>2,'EVT_name'=>'llamarama',...),
+	 *                                      ...
+	 *                                      )
+	 *                                      'Venue'=>array(
+	 *                                      array('VNU_ID'=>1,'VNU_name'=>'the shack',...),
+	 *                                      array('VNU_ID'=>2,'VNU_name'=>'tree house',...),
+	 *                                      ...
+	 *                                      )
+	 *                                      ...
+	 *                                      )
+	 */
+	public function import_csv_to_model_data_array($path_to_file, $model_name = false, $first_row_is_headers = true)
+	{
+		$multi_dimensional_array = $this->import_csv_to_multi_dimensional_array($path_to_file);
+		if (! $multi_dimensional_array) {
+			return false;
+		}
+		// gotta start somewhere
+		$row = 1;
+		// array to store csv data in
+		$ee_formatted_data = array();
+		// array to store headers (column names)
+		$headers = array();
+		foreach ($multi_dimensional_array as $data) {
+			// if first cell is MODEL, then second cell is the MODEL name
+			if ($data[0] == 'MODEL') {
+				$model_name = $data[1];
+				// don't bother looking for model data in this row. The rest of this
+				// row should be blank
+				// AND pretend this is the first row again
+				$row = 1;
+				// reset headers
+				$headers = array();
+				continue;
+			}
+			if (strpos($data[0], EE_CSV::metadata_header) !== false) {
+				$model_name = EE_CSV::metadata_header;
+				// store like model data, we just won't try importing it etc.
+				$row = 1;
+				continue;
+			}
+
+
+			// how many columns are there?
+			$columns = count($data);
+
+			$model_entry = array();
+			// loop through each column
+			for ($i = 0; $i < $columns; $i++) {
+				// replace csv_enclosures with backslashed quotes
+				$data[ $i ] = str_replace('"""', '\\"', $data[ $i ]);
+				// do we need to grab the column names?
+				if ($row === 1) {
+					if ($first_row_is_headers) {
+						// store the column names to use for keys
+						$column_name = $data[ $i ];
+						// check it's not blank... sometimes CSV editign programs adda bunch of empty columns onto the end...
+						if (! $column_name) {
+							continue;
+						}
+						$matches = array();
+						if ($model_name == EE_CSV::metadata_header) {
+							$headers[ $i ] = $column_name;
+						} else {
+							// now get the db table name from it (the part between square brackets)
+							$success = preg_match('~(.*)\[(.*)\]~', $column_name, $matches);
+							if (! $success) {
+								EE_Error::add_error(
+									sprintf(
+										__(
+											"The column titled %s is invalid for importing. It must be be in the format of 'Nice Name[model_field_name]' in row %s",
+											"event_espresso"
+										),
+										$column_name,
+										implode(",", $data)
+									),
+									__FILE__,
+									__FUNCTION__,
+									__LINE__
+								);
+								return false;
+							}
+							$headers[ $i ] = $matches[2];
+						}
+					} else {
+						// no column names means our final array will just use counters for keys
+						$model_entry[ $headers[ $i ] ] = $data[ $i ];
+						$headers[ $i ] = $i;
+					}
+					// and we need to store csv data
+				} else {
+					// this column isn' ta header, store it if there is a header for it
+					if (isset($headers[ $i ])) {
+						$model_entry[ $headers[ $i ] ] = $data[ $i ];
+					}
+				}
+			}
+			// save the row's data IF it's a non-header-row
+			if (! $first_row_is_headers || ($first_row_is_headers && $row > 1)) {
+				$ee_formatted_data[ $model_name ][] = $model_entry;
+			}
+			// advance to next row
+			$row++;
+		}
+
+		// delete the uploaded file
+		unlink($path_to_file);
+		// echo '<pre style="height:auto;border:2px solid lightblue;">' . print_r( $ee_formatted_data, TRUE ) . '</pre><br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>';
+		// die();
+
+		// it's good to give back
+		return $ee_formatted_data;
+	}
+
+
+	public function save_csv_to_db($csv_data_array, $model_name = false)
+	{
+		EE_Error::doing_it_wrong(
+			'save_csv_to_db',
+			__(
+				'Function moved to EE_Import and renamed to save_csv_data_array_to_db',
+				'event_espresso'
+			),
+			'4.6.7'
+		);
+		return EE_Import::instance()->save_csv_data_array_to_db($csv_data_array, $model_name);
+	}
+
+	/**
+	 * Sends HTTP headers to indicate that the browser should download a file,
+	 * and starts writing the file to PHP's output. Returns the file handle so other functions can
+	 * also write to it
+	 *
+	 * @param string $new_filename the name of the file that the user will download
+	 * @return resource, like the results of fopen(), which can be used for fwrite, fputcsv2, etc.
+	 */
+	public function begin_sending_csv($filename)
+	{
+		// grab file extension
+		$ext = substr(strrchr($filename, '.'), 1);
+		if ($ext == '.csv' or $ext == '.xls') {
+			str_replace($ext, '', $filename);
+		}
+		$filename .= '.csv';
+
+		// if somebody's been naughty and already started outputting stuff, trash it
+		// and start writing our stuff.
+		if (ob_get_length()) {
+			@ob_flush();
+			@flush();
+			@ob_end_flush();
+		}
+		@ob_start();
+		header("Pragma: public");
+		header("Expires: 0");
+		header("Pragma: no-cache");
+		header("Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
+		// header("Content-Type: application/force-download");
+		// header("Content-Type: application/octet-stream");
+		// header("Content-Type: application/download");
+		header('Content-disposition: attachment; filename=' . $filename);
+		header("Content-Type: text/csv; charset=utf-8");
+		do_action('AHEE__EE_CSV__begin_sending_csv__headers');
+		echo apply_filters(
+			'FHEE__EE_CSV__begin_sending_csv__start_writing',
+			"\xEF\xBB\xBF"
+		); // makes excel open it as UTF-8. UTF-8 BOM, see http://stackoverflow.com/a/4440143/2773835
+		$fh = fopen('php://output', 'w');
+		return $fh;
+	}
+
+	/**
+	 * Writes some meta data to the CSV as a bunch of columns. Initially we're only
+	 * mentioning the version and timezone
+	 *
+	 * @param resource $filehandle
+	 */
+	public function write_metadata_to_csv($filehandle)
+	{
+		$data_row = array(EE_CSV::metadata_header);// do NOT translate because this exact string is used when importing
+		$this->fputcsv2($filehandle, $data_row);
+		$meta_data = array(
+			0 => array(
+				'version'        => espresso_version(),
+				'timezone'       => EEH_DTT_Helper::get_timezone(),
+				'time_of_export' => current_time('mysql'),
+				'site_url'       => site_url(),
+			),
+		);
+		$this->write_data_array_to_csv($filehandle, $meta_data);
+	}
+
+
+	/**
+	 * Writes $data to the csv file open in $filehandle. uses the array indices of $data for column headers
+	 *
+	 * @param array   $data                 2D array, first numerically-indexed, and next-level-down preferably indexed
+	 *                                      by string
+	 * @param boolean $add_csv_column_names whether or not we should add the keys in the bottom-most array as a row for
+	 *                                      headers in the CSV. Eg, if $data looked like
+	 *                                      array(0=>array('EVT_ID'=>1,'EVT_name'=>'monkey'...), 1=>array(...),...))
+	 *                                      then the first row we'd write to the CSV would be "EVT_ID,EVT_name,..."
+	 * @return boolean if we successfully wrote to the CSV or not. If there's no $data, we consider that a success
+	 *                 (because we wrote everything there was...nothing)
+	 */
+	public function write_data_array_to_csv($filehandle, $data)
+	{
+
+
+		// determine if $data is actually a 2d array
+		if ($data && is_array($data) && is_array(EEH_Array::get_one_item_from_array($data))) {
+			// make sure top level is numerically indexed,
+
+			if (EEH_Array::is_associative_array($data)) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							"top-level array must be numerically indexed. Does these look like numbers to you? %s",
+							"event_espresso"
+						),
+						implode(",", array_keys($data))
+					)
+				);
+			}
+			$item_in_top_level_array = EEH_Array::get_one_item_from_array($data);
+			// now, is the last item in the top-level array of $data an associative or numeric array?
+			if (EEH_Array::is_associative_array($item_in_top_level_array)) {
+				// its associative, so we want to output its keys as column headers
+				$keys = array_keys($item_in_top_level_array);
+				echo $this->fputcsv2($filehandle, $keys);
+			}
+			// start writing data
+			foreach ($data as $data_row) {
+				echo $this->fputcsv2($filehandle, $data_row);
+			}
+			return true;
+		} else {
+			// no data TO write... so we can assume that's a success
+			return true;
+		}
+		// //if 2nd level is indexed by strings, use those as csv column headers (ie, the first row)
+		//
+		//
+		// $no_table = TRUE;
+		//
+		// // loop through data and add each row to the file/stream as csv
+		// foreach ( $data as $model_name => $model_data ) {
+		// // test first row to see if it is data or a model name
+		// $model = EE_Registry::instance();->load_model($model_name);
+		// //if the model really exists,
+		// if ( $model ) {
+		//
+		// // we have a table name
+		// $no_table = FALSE;
+		//
+		// // put the tablename into an array cuz that's how fputcsv rolls
+		// $model_name_row = array( 'MODEL', $model_name );
+		//
+		// // add table name to csv output
+		// echo self::fputcsv2($filehandle, $model_name_row);
+		//
+		// // now get the rest of the data
+		// foreach ( $model_data as $row ) {
+		// // output the row
+		// echo self::fputcsv2($filehandle, $row);
+		// }
+		//
+		// }
+		//
+		// if ( $no_table ) {
+		// // no table so just put the data
+		// echo self::fputcsv2($filehandle, $model_data);
+		// }
+		//
+		// } // END OF foreach ( $data )
+	}
+
+	/**
+	 * Should be called after begin_sending_csv(), and one or more write_data_array_to_csv()s.
+	 * Calls exit to prevent polluting the CSV file with other junk
+	 *
+	 * @param resource $fh filehandle where we're writing the CSV to
+	 */
+	public function end_sending_csv($fh)
+	{
+		fclose($fh);
+		exit(0);
+	}
+
+	/**
+	 * Given an open file, writes all the model data to it in the format the importer expects.
+	 * Usually preceded by begin_sending_csv($filename), and followed by end_sending_csv($filehandle).
+	 *
+	 * @param resource $filehandle
+	 * @param array    $model_data_array is assumed to be a 3d array: 1st layer has keys of model names (eg 'Event'),
+	 *                                   next layer is numerically indexed to represent each model object (eg, each
+	 *                                   individual event), and the last layer has all the attributes o fthat model
+	 *                                   object (eg, the event's id, name, etc)
+	 * @return boolean success
+	 */
+	public function write_model_data_to_csv($filehandle, $model_data_array)
+	{
+		$this->write_metadata_to_csv($filehandle);
+		foreach ($model_data_array as $model_name => $model_instance_arrays) {
+			// first: output a special row stating the model
+			echo $this->fputcsv2($filehandle, array('MODEL', $model_name));
+			// if we have items to put in the CSV, do it normally
+
+			if (! empty($model_instance_arrays)) {
+				$this->write_data_array_to_csv($filehandle, $model_instance_arrays);
+			} else {
+				// echo "no data to write... so just write the headers";
+				// so there's actually NO model objects for that model.
+				// probably still want to show the columns
+				$model = EE_Registry::instance()->load_model($model_name);
+				$column_names = array();
+				foreach ($model->field_settings() as $field) {
+					$column_names[ $field->get_nicename() . "[" . $field->get_name() . "]" ] = null;
+				}
+				$this->write_data_array_to_csv($filehandle, array($column_names));
+			}
+		}
+	}
+
+	/**
+	 * Writes the CSV file to the output buffer, with rows corresponding to $model_data_array,
+	 * and dies (in order to avoid other plugins from messing up the csv output)
+	 *
+	 * @param string $filename         the filename you want to give the file
+	 * @param array  $model_data_array 3d array, as described in EE_CSV::write_model_data_to_csv()
+	 * @return bool | void writes CSV file to output and dies
+	 */
+	public function export_multiple_model_data_to_csv($filename, $model_data_array)
+	{
+		$filehandle = $this->begin_sending_csv($filename);
+		$this->write_model_data_to_csv($filehandle, $model_data_array);
+		$this->end_sending_csv($filehandle);
+	}
+
+	/**
+	 * @Export contents of an array to csv file
+	 * @access public
+	 * @param array  $data     - the array of data to be converted to csv and exported
+	 * @param string $filename - name for newly created csv file
+	 * @return TRUE on success, FALSE on fail
+	 */
+	public function export_array_to_csv($data = false, $filename = false)
+	{
+
+		// no data file?? get outta here
+		if (! $data or ! is_array($data) or empty($data)) {
+			return false;
+		}
+
+		// no filename?? get outta here
+		if (! $filename) {
+			return false;
+		}
+
+
+		// somebody told me i might need this ???
+		global $wpdb;
+		$prefix = $wpdb->prefix;
+
+
+		$fh = $this->begin_sending_csv($filename);
+
+
+		$this->end_sending_csv($fh);
+	}
+
+
+	/**
+	 * @Determine the maximum upload file size based on php.ini settings
+	 * @access    public
+	 * @param int $percent_of_max - desired percentage of the max upload_mb
+	 * @return int KB
+	 */
+	public function get_max_upload_size($percent_of_max = false)
+	{
+
+		$max_upload = (int) (ini_get('upload_max_filesize'));
+		$max_post = (int) (ini_get('post_max_size'));
+		$memory_limit = (int) (ini_get('memory_limit'));
+
+		// determine the smallest of the three values from above
+		$upload_mb = min($max_upload, $max_post, $memory_limit);
+
+		// convert MB to KB
+		$upload_mb = $upload_mb * 1024;
+
+		// don't want the full monty? then reduce the max uplaod size
+		if ($percent_of_max) {
+			// is percent_of_max like this -> 50 or like this -> 0.50 ?
+			if ($percent_of_max > 1) {
+				// chnages 50 to 0.50
+				$percent_of_max = $percent_of_max / 100;
+			}
+			// make upload_mb a percentage of the max upload_mb
+			$upload_mb = $upload_mb * $percent_of_max;
+		}
+
+		return $upload_mb;
+	}
+
+
+	/**
+	 * @Drop   in replacement for PHP's fputcsv function - but this one works!!!
+	 * @access private
+	 * @param resource $fh         - file handle - what we are writing to
+	 * @param array    $row        - individual row of csv data
+	 * @param string   $delimiter  - csv delimiter
+	 * @param string   $enclosure  - csv enclosure
+	 * @param string   $mysql_null - allows php NULL to be overridden with MySQl's insertable NULL value
+	 * @return void
+	 */
+	private function fputcsv2($fh, array $row, $delimiter = ',', $enclosure = '"', $mysql_null = false)
+	{
+		// Allow user to filter the csv delimiter and enclosure for other countries csv standards
+		$delimiter = apply_filters('FHEE__EE_CSV__fputcsv2__delimiter', $delimiter);
+		$enclosure = apply_filters('FHEE__EE_CSV__fputcsv2__enclosure', $enclosure);
+
+		$delimiter_esc = preg_quote($delimiter, '/');
+		$enclosure_esc = preg_quote($enclosure, '/');
+
+		$output = array();
+		foreach ($row as $field_value) {
+			if (is_object($field_value) || is_array($field_value)) {
+				$field_value = serialize($field_value);
+			}
+			if ($field_value === null && $mysql_null) {
+				$output[] = 'NULL';
+				continue;
+			}
+
+			$output[] = preg_match("/(?:${delimiter_esc}|${enclosure_esc}|\s)/", $field_value) ?
+				($enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure)
+				: $field_value;
+		}
+
+		fwrite($fh, join($delimiter, $output) . PHP_EOL);
+	}
+
+
+	// /**
+	//  * @CSV    Import / Export messages
+	//  * @access public
+	//  * @return void
+	//  */
+	// public function csv_admin_notices()
+	// {
+	//
+	//     // We play both kinds of music here! Country AND Western! - err... I mean, cycle through both types of notices
+	//     foreach (array('updates', 'errors') as $type) {
+	//
+	//         // if particular notice type is not empty, then "You've got Mail"
+	//         if (! empty($this->_notices[ $type ])) {
+	//
+	//             // is it an update or an error ?
+	//             $msg_class = $type == 'updates' ? 'updated' : 'error';
+	//             echo '<div id="message" class="' . $msg_class . '">';
+	//             // display each notice, however many that may be
+	//             foreach ($this->_notices[ $type ] as $message) {
+	//                 echo '<p>' . $message . '</p>';
+	//             }
+	//             // wrap it up
+	//             echo '</div>';
+	//         }
+	//     }
+	// }
+
+	/**
+	 * Gets the date format to use in teh csv. filterable
+	 *
+	 * @param string $current_format
+	 * @return string
+	 */
+	public function get_date_format_for_csv($current_format = null)
+	{
+		return apply_filters('FHEE__EE_CSV__get_date_format_for_csv__format', 'Y-m-d', $current_format);
+	}
+
+	/**
+	 * Gets the time format we want to use in CSV reports. Filterable
+	 *
+	 * @param string $current_format
+	 * @return string
+	 */
+	public function get_time_format_for_csv($current_format = null)
+	{
+		return apply_filters('FHEE__EE_CSV__get_time_format_for_csv__format', 'H:i:s', $current_format);
+	}
 }

Spacing +48 added lines, -48 removed lines

@@ -48,31 +48,31 @@ 
         global $wpdb;
 
         $this->_primary_keys = array(
-            $wpdb->prefix . 'esp_answer'                  => array('ANS_ID'),
-            $wpdb->prefix . 'esp_attendee'                => array('ATT_ID'),
-            $wpdb->prefix . 'esp_datetime'                => array('DTT_ID'),
-            $wpdb->prefix . 'esp_event_question_group'    => array('EQG_ID'),
-            $wpdb->prefix . 'esp_message_template'        => array('MTP_ID'),
-            $wpdb->prefix . 'esp_payment'                 => array('PAY_ID'),
-            $wpdb->prefix . 'esp_price'                   => array('PRC_ID'),
-            $wpdb->prefix . 'esp_price_type'              => array('PRT_ID'),
-            $wpdb->prefix . 'esp_question'                => array('QST_ID'),
-            $wpdb->prefix . 'esp_question_group'          => array('QSG_ID'),
-            $wpdb->prefix . 'esp_question_group_question' => array('QGQ_ID'),
-            $wpdb->prefix . 'esp_question_option'         => array('QSO_ID'),
-            $wpdb->prefix . 'esp_registration'            => array('REG_ID'),
-            $wpdb->prefix . 'esp_status'                  => array('STS_ID'),
-            $wpdb->prefix . 'esp_transaction'             => array('TXN_ID'),
-            $wpdb->prefix . 'esp_transaction'             => array('TXN_ID'),
-            $wpdb->prefix . 'events_detail'               => array('id'),
-            $wpdb->prefix . 'events_category_detail'      => array('id'),
-            $wpdb->prefix . 'events_category_rel'         => array('id'),
-            $wpdb->prefix . 'events_venue'                => array('id'),
-            $wpdb->prefix . 'events_venue_rel'            => array('emeta_id'),
-            $wpdb->prefix . 'events_locale'               => array('id'),
-            $wpdb->prefix . 'events_locale_rel'           => array('id'),
-            $wpdb->prefix . 'events_personnel'            => array('id'),
-            $wpdb->prefix . 'events_personnel_rel'        => array('id'),
+            $wpdb->prefix.'esp_answer'                  => array('ANS_ID'),
+            $wpdb->prefix.'esp_attendee'                => array('ATT_ID'),
+            $wpdb->prefix.'esp_datetime'                => array('DTT_ID'),
+            $wpdb->prefix.'esp_event_question_group'    => array('EQG_ID'),
+            $wpdb->prefix.'esp_message_template'        => array('MTP_ID'),
+            $wpdb->prefix.'esp_payment'                 => array('PAY_ID'),
+            $wpdb->prefix.'esp_price'                   => array('PRC_ID'),
+            $wpdb->prefix.'esp_price_type'              => array('PRT_ID'),
+            $wpdb->prefix.'esp_question'                => array('QST_ID'),
+            $wpdb->prefix.'esp_question_group'          => array('QSG_ID'),
+            $wpdb->prefix.'esp_question_group_question' => array('QGQ_ID'),
+            $wpdb->prefix.'esp_question_option'         => array('QSO_ID'),
+            $wpdb->prefix.'esp_registration'            => array('REG_ID'),
+            $wpdb->prefix.'esp_status'                  => array('STS_ID'),
+            $wpdb->prefix.'esp_transaction'             => array('TXN_ID'),
+            $wpdb->prefix.'esp_transaction'             => array('TXN_ID'),
+            $wpdb->prefix.'events_detail'               => array('id'),
+            $wpdb->prefix.'events_category_detail'      => array('id'),
+            $wpdb->prefix.'events_category_rel'         => array('id'),
+            $wpdb->prefix.'events_venue'                => array('id'),
+            $wpdb->prefix.'events_venue_rel'            => array('emeta_id'),
+            $wpdb->prefix.'events_locale'               => array('id'),
+            $wpdb->prefix.'events_locale_rel'           => array('id'),
+            $wpdb->prefix.'events_personnel'            => array('id'),
+            $wpdb->prefix.'events_personnel_rel'        => array('id'),
         );
     }
 
@@ -104,7 +104,7 @@ 
     {
         $fc = "";
         $fh = fopen($file_path, "rb");
-        if (! $fh) {
+        if ( ! $fh) {
             throw new EE_Error(sprintf(__("Cannot open file for read: %s<br>\n", 'event_espresso'), $file_path));
         }
         $flen = filesize($file_path);
@@ -112,7 +112,7 @@ 
         for ($i = 0; $i < $flen; $i++) {
             $c = substr($bc, $i, 1);
             if ((ord($c) != 0) && (ord($c) != 13)) {
-                $fc = $fc . $c;
+                $fc = $fc.$c;
             }
         }
         if ((ord(substr($fc, 0, 1)) == 255) && (ord(substr($fc, 1, 1)) == 254)) {
@@ -207,7 +207,7 @@ 
     public function import_csv_to_model_data_array($path_to_file, $model_name = false, $first_row_is_headers = true)
     {
         $multi_dimensional_array = $this->import_csv_to_multi_dimensional_array($path_to_file);
-        if (! $multi_dimensional_array) {
+        if ( ! $multi_dimensional_array) {
             return false;
         }
         // gotta start somewhere
@@ -243,23 +243,23 @@ 
             // loop through each column
             for ($i = 0; $i < $columns; $i++) {
                 // replace csv_enclosures with backslashed quotes
-                $data[ $i ] = str_replace('"""', '\\"', $data[ $i ]);
+                $data[$i] = str_replace('"""', '\\"', $data[$i]);
                 // do we need to grab the column names?
                 if ($row === 1) {
                     if ($first_row_is_headers) {
                         // store the column names to use for keys
-                        $column_name = $data[ $i ];
+                        $column_name = $data[$i];
                         // check it's not blank... sometimes CSV editign programs adda bunch of empty columns onto the end...
-                        if (! $column_name) {
+                        if ( ! $column_name) {
                             continue;
                         }
                         $matches = array();
                         if ($model_name == EE_CSV::metadata_header) {
-                            $headers[ $i ] = $column_name;
+                            $headers[$i] = $column_name;
                         } else {
                             // now get the db table name from it (the part between square brackets)
                             $success = preg_match('~(.*)\[(.*)\]~', $column_name, $matches);
-                            if (! $success) {
+                            if ( ! $success) {
                                 EE_Error::add_error(
                                     sprintf(
                                         __(
@@ -275,24 +275,24 @@ 
                                 );
                                 return false;
                             }
-                            $headers[ $i ] = $matches[2];
+                            $headers[$i] = $matches[2];
                         }
                     } else {
                         // no column names means our final array will just use counters for keys
-                        $model_entry[ $headers[ $i ] ] = $data[ $i ];
-                        $headers[ $i ] = $i;
+                        $model_entry[$headers[$i]] = $data[$i];
+                        $headers[$i] = $i;
                     }
                     // and we need to store csv data
                 } else {
                     // this column isn' ta header, store it if there is a header for it
-                    if (isset($headers[ $i ])) {
-                        $model_entry[ $headers[ $i ] ] = $data[ $i ];
+                    if (isset($headers[$i])) {
+                        $model_entry[$headers[$i]] = $data[$i];
                     }
                 }
             }
             // save the row's data IF it's a non-header-row
-            if (! $first_row_is_headers || ($first_row_is_headers && $row > 1)) {
-                $ee_formatted_data[ $model_name ][] = $model_entry;
+            if ( ! $first_row_is_headers || ($first_row_is_headers && $row > 1)) {
+                $ee_formatted_data[$model_name][] = $model_entry;
             }
             // advance to next row
             $row++;
@@ -353,7 +353,7 @@ 
         // header("Content-Type: application/force-download");
         // header("Content-Type: application/octet-stream");
         // header("Content-Type: application/download");
-        header('Content-disposition: attachment; filename=' . $filename);
+        header('Content-disposition: attachment; filename='.$filename);
         header("Content-Type: text/csv; charset=utf-8");
         do_action('AHEE__EE_CSV__begin_sending_csv__headers');
         echo apply_filters(
@@ -372,7 +372,7 @@ 
      */
     public function write_metadata_to_csv($filehandle)
     {
-        $data_row = array(EE_CSV::metadata_header);// do NOT translate because this exact string is used when importing
+        $data_row = array(EE_CSV::metadata_header); // do NOT translate because this exact string is used when importing
         $this->fputcsv2($filehandle, $data_row);
         $meta_data = array(
             0 => array(
@@ -501,7 +501,7 @@ 
             echo $this->fputcsv2($filehandle, array('MODEL', $model_name));
             // if we have items to put in the CSV, do it normally
 
-            if (! empty($model_instance_arrays)) {
+            if ( ! empty($model_instance_arrays)) {
                 $this->write_data_array_to_csv($filehandle, $model_instance_arrays);
             } else {
                 // echo "no data to write... so just write the headers";
@@ -510,7 +510,7 @@ 
                 $model = EE_Registry::instance()->load_model($model_name);
                 $column_names = array();
                 foreach ($model->field_settings() as $field) {
-                    $column_names[ $field->get_nicename() . "[" . $field->get_name() . "]" ] = null;
+                    $column_names[$field->get_nicename()."[".$field->get_name()."]"] = null;
                 }
                 $this->write_data_array_to_csv($filehandle, array($column_names));
             }
@@ -543,12 +543,12 @@ 
     {
 
         // no data file?? get outta here
-        if (! $data or ! is_array($data) or empty($data)) {
+        if ( ! $data or ! is_array($data) or empty($data)) {
             return false;
         }
 
         // no filename?? get outta here
-        if (! $filename) {
+        if ( ! $filename) {
             return false;
         }
 
@@ -629,11 +629,11 @@ 
             }
 
             $output[] = preg_match("/(?:${delimiter_esc}|${enclosure_esc}|\s)/", $field_value) ?
-                ($enclosure . str_replace($enclosure, $enclosure . $enclosure, $field_value) . $enclosure)
+                ($enclosure.str_replace($enclosure, $enclosure.$enclosure, $field_value).$enclosure)
                 : $field_value;
         }
 
-        fwrite($fh, join($delimiter, $output) . PHP_EOL);
+        fwrite($fh, join($delimiter, $output).PHP_EOL);
     }
 
 

caffeinated/EE_Caf_Messages.class.php

Indentation +799 added lines, -799 removed lines

@@ -13,803 +13,803 @@
 {
 
 
-    /**
-     * constructor.
-     */
-    public function __construct()
-    {
-        $this->_caf_hooks();
-    }
-
-
-    /**
-     * Contains all the hooks filters for setting up caffeinated messages functionality.
-     *
-     * @since 4.3.2
-     *
-     * @return void
-     */
-    private function _caf_hooks()
-    {
-        add_filter('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', array($this, 'messages_autoload_paths'), 5);
-        add_filter(
-            'FHEE__EE_Email_messenger__get_validator_config',
-            array($this, 'email_messenger_validator_config'),
-            5,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Email_messenger__get_template_fields',
-            array($this, 'email_messenger_template_fields'),
-            5,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Html_messenger__get_template_fields',
-            array($this, 'html_messenger_template_fields'),
-            5,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Html_messenger__get_validator_config',
-            array($this, 'html_messenger_validator_config'),
-            5,
-            2
-        );
-        add_filter('FHEE__EE_Pdf_messenger__get_template_fields', array($this, 'pdf_messenger_template_fields'), 5, 2);
-        add_filter(
-            'FHEE__EE_Pdf_messenger__get_validator_config',
-            array($this, 'pdf_messenger_validator_config'),
-            5,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Messages_Template_Pack__get_specific_template__contents',
-            array($this, 'new_default_templates'),
-            5,
-            7
-        );
-        add_filter(
-            'FHEE__EE_Messages_Base__get_valid_shortcodes',
-            array($this, 'message_types_valid_shortcodes'),
-            5,
-            2
-        );
-
-        // shortcode parsers
-        add_filter('FHEE__EE_Attendee_Shortcodes__shortcodes', array($this, 'additional_attendee_shortcodes'), 5, 2);
-        add_filter('FHEE__EE_Attendee_Shortcodes__parser_after', array($this, 'additional_attendee_parser'), 5, 5);
-        add_filter(
-            'FHEE__EE_Recipient_List_Shortcodes__shortcodes',
-            array($this, 'additional_recipient_details_shortcodes'),
-            5,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Recipient_List_Shortcodes__parser_after',
-            array($this, 'additional_recipient_details_parser'),
-            5,
-            5
-        );
-        add_filter(
-            'FHEE__EE_Primary_Registration_List_Shortcodes__shortcodes',
-            array($this, 'additional_primary_registration_details_shortcodes'),
-            5,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Primary_Registration_List_Shortcodes__parser_after',
-            array($this, 'additional_primary_registration_details_parser'),
-            5,
-            5
-        );
-
-        /**
-         * @since 4.2.0
-         */
-        add_filter('FHEE__EE_Datetime_Shortcodes__shortcodes', array($this, 'additional_datetime_shortcodes'), 10, 2);
-        add_filter('FHEE__EE_Datetime_Shortcodes__parser_after', array($this, 'additional_datetime_parser'), 10, 5);
-
-        /**
-         * @since 4.3.0
-         */
-        // eat our own dog food!
-        add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_message_types'));
-        add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_shortcodes'));
-        do_action('EE_Brewing_Regular___messages_caf');
-    }
-
-
-    /**
-     * This just allows us to add additional paths to the autoloader (EED_Messages::autoload_messages()) for the
-     * messages system.
-     *
-     * @param  array $dir_ref original array of paths
-     *
-     * @return array           appended paths
-     */
-    public function messages_autoload_paths($dir_ref)
-    {
-        $dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/';
-
-        return $dir_ref;
-    }
-
-
-    public function email_messenger_validator_config($validator_config, EE_Email_messenger $messenger)
-    {
-        $validator_config['attendee_list'] = array(
-            'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
-            'required'   => array('[ATTENDEE_LIST]'),
-        );
-        $validator_config['question_list'] = array(
-            'shortcodes' => array('question'),
-            'required'   => array('[QUESTION_LIST]'),
-        );
-
-        return $validator_config;
-    }
-
-
-    public function html_messenger_validator_config($validator_config, EE_Html_messenger $messenger)
-    {
-        $validator_config['attendee_list'] = array(
-            'shortcodes' => array('attendee', 'question_list'),
-            'required'   => array('[ATTENDEE_LIST]'),
-        );
-        $validator_config['question_list'] = array(
-            'shortcodes' => array('question'),
-            'required'   => array('[QUESTION_LIST]'),
-        );
-
-        return $validator_config;
-    }
-
-
-    public function pdf_messenger_validator_config($validator_config, EE_Pdf_messenger $messenger)
-    {
-        $validator_config['attendee_list'] = array(
-            'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
-            'required'   => array('[ATTENDEE_LIST]'),
-        );
-        $validator_config['question_list'] = array(
-            'shortcodes' => array('question'),
-            'required'   => array('[QUESTION_LIST]'),
-        );
-
-        return $validator_config;
-    }
-
-
-    public function email_messenger_template_fields($template_fields, EE_Email_messenger $messenger)
-    {
-        $template_fields['extra']['content']['question_list'] = array(
-            'input'               => 'textarea',
-            'label'               => '[QUESTION_LIST]',
-            'type'                => 'string',
-            'required'            => true,
-            'validation'          => true,
-            'format'              => '%s',
-            'css_class'           => 'large-text',
-            'rows'                => '5',
-            'shortcodes_required' => array('[QUESTION_LIST]'),
-        );
-
-        return $template_fields;
-    }
-
-
-    public function html_messenger_template_fields($template_fields, EE_Html_messenger $messenger)
-    {
-        $template_fields['extra']['content']['question_list'] = array(
-            'input'               => 'textarea',
-            'label'               => '[QUESTION_LIST]',
-            'type'                => 'string',
-            'required'            => true,
-            'validation'          => true,
-            'format'              => '%s',
-            'css_class'           => 'large-text',
-            'rows'                => '5',
-            'shortcodes_required' => array('[QUESTION_LIST]'),
-        );
-
-        return $template_fields;
-    }
-
-
-    public function pdf_messenger_template_fields($template_fields, EE_Pdf_messenger $messenger)
-    {
-        $template_fields['extra']['content']['question_list'] = array(
-            'input'               => 'textarea',
-            'label'               => '[QUESTION_LIST]',
-            'type'                => 'string',
-            'required'            => true,
-            'validation'          => true,
-            'format'              => '%s',
-            'css_class'           => 'large-text',
-            'rows'                => '5',
-            'shortcodes_required' => array('[QUESTION_LIST]'),
-        );
-
-        return $template_fields;
-    }
-
-
-    public function new_default_templates(
-        $contents,
-        $actual_path,
-        EE_messenger $messenger,
-        EE_message_type $message_type,
-        $field,
-        $context,
-        EE_Messages_Template_Pack $template_pack
-    ) {
-
-        // we're only modifying templates for the default template pack
-        if (! $template_pack instanceof EE_Messages_Template_Pack_Default) {
-            return $contents;
-        }
-
-        // the template file name we're replacing contents for.
-        $template_file_prefix = $field . '_' . $context;
-        $msg_prefix = $messenger->name . '_' . $message_type->name . '_';
-
-        $base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/';
-
-        if ($messenger->name == 'email' && $message_type->name == 'registration') {
-            switch ($template_file_prefix) {
-                case 'question_list_admin':
-                case 'question_list_attendee':
-                case 'question_list_primary_attendee':
-                    $path = $base_path . $msg_prefix . 'question_list.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-
-                case 'attendee_list_primary_attendee':
-                    $path = $base_path . $msg_prefix . 'attendee_list.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-
-                case 'attendee_list_admin':
-                    $path = $base_path . $msg_prefix . 'attendee_list_admin.template.php';
-                    $contents = EEH_Template::display_template(
-                        $path,
-                        array(),
-                        true
-                    );
-                    break;
-
-                case 'attendee_list_attendee':
-                    $contents = '';
-                    break;
-
-                case 'event_list_attendee':
-                    $path = $base_path . $msg_prefix . 'event_list_attendee.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-            }
-        } elseif ($messenger->name == 'email' && $message_type->name == 'newsletter') {
-            switch ($template_file_prefix) {
-                case 'content_attendee':
-                    $path = $base_path . $msg_prefix . 'content.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-
-                case 'newsletter_content_attendee':
-                    $path = $base_path . $msg_prefix . 'newsletter_content.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-
-                case 'newsletter_subject_attendee':
-                    $path = $base_path . $msg_prefix . 'subject.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-            }
-        } elseif ($messenger->name == 'html' && $message_type->name == 'receipt') {
-            switch ($template_file_prefix) {
-                case 'attendee_list_purchaser':
-                    $path = $base_path . $msg_prefix . 'attendee_list.template.php';
-                    $contents = EEH_Template::display_template($path, array(), true);
-                    break;
-            }
-        }
-
-        return $contents;
-    }
-
-
-    public function message_types_valid_shortcodes($valid_shortcodes, EE_Messages_Base $msg)
-    {
-        // make sure question_list and question are ONLY added for the core message types.  Any other message types will have to explicitly set question_list as a valid shortcode.
-        $include_with = array(
-            'registration',
-            'cancelled_registration',
-            'declined_registration',
-            'not_approved_registration',
-            'payment_declined',
-            'payment_failed',
-            'payment_cancelled',
-            'payment',
-            'payment_reminder',
-            'pending_approval',
-            'registration_summary',
-            'invoice',
-            'receipt',
-        );
-        if ($msg instanceof EE_message_type && in_array($msg->name, $include_with)) {
-            $contexts = array_keys($msg->get_contexts());
-            foreach ($contexts as $context) {
-                $valid_shortcodes[ $context ][] = 'question_list';
-                $valid_shortcodes[ $context ][] = 'question';
-            }
-        }
-
-        return $valid_shortcodes;
-    }
-
-
-    public function additional_attendee_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $shortcodes['[ANSWER_*]'] = __(
-            'This is a special dynamic shortcode. Right after the "*", add the exact text of a existing question, and if there is an answer for that question for this registrant, that will take the place of this shortcode.',
-            'event_espresso'
-        );
-
-        return $shortcodes;
-    }
-
-
-    public function additional_attendee_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
-    {
-
-        if (strpos($shortcode, '[ANSWER_*') === false
-            || ! isset($extra_data['data']->questions)
-            || ! isset($extra_data['data']->registrations)
-        ) {
-            return $parsed;
-        }
-
-        // let's get the question from the code.
-        $shortcode = str_replace('[ANSWER_*', '', $shortcode);
-        $shortcode = trim(str_replace(']', '', $shortcode));
-
-        $registration = $data instanceof EE_Registration ? $data : null;
-        $registration = ! $registration instanceof EE_Registration && is_array(
-            $extra_data
-        ) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Registration ? $extra_data['data'] : $registration;
-
-        $aee = $data instanceof EE_Messages_Addressee ? $data : null;
-        $aee = ! $aee instanceof EE_Messages_Addressee && is_array(
-            $extra_data
-        ) && isset($extra_data['data']) ? $extra_data['data'] : $aee;
-
-        if (! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) {
-            return $parsed;
-        }
-
-        // now let's figure out which question has this text.
-        foreach ($aee->questions as $ansid => $question) {
-            if ($question instanceof EE_Question
-                && trim($question->display_text()) == trim($shortcode)
-                && isset($aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ])
-            ) {
-                return $aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ]->get_pretty(
-                    'ANS_value',
-                    'no_wpautop'
-                );
-            }
-        }
-
-        // nothing!
-        return $parsed;
-    }
-
-
-    /**
-     * Callback for additional shortcodes filter for adding additional datetime shortcodes.
-     *
-     * @since  4.2
-     *
-     * @param  array                  $shortcodes         array of shortcodes and
-     *                                                    descriptions
-     * @param  EE_Datetime_Shortcodes $shortcode_parser   EE_Shortcodes object
-     *
-     * @return array                                        array of shortcodes and
-     *                                                        descriptions
-     */
-    public function additional_datetime_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $shortcodes['[DTT_NAME]'] = __(
-            'This will be parsed to the Title given for a Datetime',
-            'event_espresso'
-        );
-        $shortcodes['[DTT_DESCRIPTION]'] = __(
-            'This will be parsed to the description for a Datetime',
-            'event_espresso'
-        );
-        $shortcodes['[DTT_NAME_OR_DATES]'] = __(
-            'When parsed, if the Datetime has a name, it is used, otherwise a formatted string including the start date and end date will be used.',
-            'event_espresso'
-        );
-
-        return $shortcodes;
-    }
-
-
-    /**
-     * Callback for additional shortcodes parser filter used for adding parser for new
-     * Datetime shortcodes
-     *
-     * @since  4.2
-     *
-     * @param  string                 $parsed     The finished parsed string for the given shortcode.
-     * @param  string                 $shortcode  The shortcode being parsed.
-     * @param  object                 $data       The incoming data object for the Shortcode Parser.
-     * @param  object                 $extra_data The incoming extra date object for the Shortcode
-     *                                            Parser.
-     * @param  EE_Datetime_Shortcodes $shortcode_parser
-     *
-     * @return string                   The new parsed string.
-     */
-    public function additional_datetime_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
-    {
-
-        if (! $data instanceof EE_Datetime) {
-            return ''; // get out because we can only parse with the datetime object.
-        }
-
-        switch ($shortcode) {
-            case '[DTT_NAME]':
-                return $data->name();
-                break;
-            case '[DTT_DESCRIPTION]':
-                return $data->description();
-                break;
-            case '[DTT_NAME_OR_DATES]':
-                return $data->get_dtt_display_name(true);
-                break;
-            default:
-                return $parsed;
-                break;
-        }
-    }
-
-
-    public function additional_recipient_details_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $shortcodes['[RECIPIENT_QUESTION_LIST]'] = __(
-            'This is used to indicate where you want the list of questions and answers to show for the person receiving the message.',
-            'event_espresso'
-        );
-
-        return $shortcodes;
-    }
-
-
-    /**
-     * Callback for FHEE__EE_Recipient_List_Shortcodes__parser_after filter (dynamic filter).
-     *
-     * @param string         $parsed           The original parsed content for the shortcode
-     * @param string         $shortcode        The shortcode being parsed
-     * @param array          $data             The shortcode parser data array
-     * @param array          $extra_data       The shortcode parser extra data array
-     * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
-     *
-     * @return string
-     */
-    public function additional_recipient_details_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
-    {
-
-        if (array($data) && ! isset($data['data'])) {
-            return $parsed;
-        }
-
-        $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
-        $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
-
-        if (! $recipient instanceof EE_Messages_Addressee) {
-            return $parsed;
-        }
-
-        switch ($shortcode) {
-            case '[RECIPIENT_QUESTION_LIST]':
-                $att = $recipient->att_obj;
-                $registrations_on_attendee = $att instanceof EE_Attendee
-                    ? $recipient->attendees[ $att->ID() ]['reg_objs']
-                    : array();
-                $registrations_on_attendee = empty($registrations_on_attendee) && $recipient->reg_obj instanceof EE_Registration ? array($recipient->reg_obj) : $registrations_on_attendee;
-                $answers = array();
-
-                $template = is_array($data['template']) && isset($data['template']['question_list'])
-                    ? $data['template']['question_list']
-                    : $extra_data['template']['question_list'];
-                $valid_shortcodes = array('question');
-
-                // if the context is main_content then get all answers for all registrations on this attendee
-                if ($data['data'] instanceof EE_Messages_Addressee) {
-                    foreach ($registrations_on_attendee as $reg) {
-                        if ($reg instanceof EE_Registration) {
-                            $anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs'])
-                                ? $recipient->registrations[ $reg->ID() ]['ans_objs']
-                                : array();
-                            foreach ($anss as $ans) {
-                                if ($ans instanceof EE_Answer) {
-                                    $answers[ $ans->ID() ] = $ans;
-                                }
-                            }
-                        }
-                    }
-                }
-
-                // if the context is the event list parser, then let's return just the answers for all registrations attached to the recipient for that event.
-                if ($data['data'] instanceof EE_Event) {
-                    $event = $data['data'];
-                    foreach ($registrations_on_attendee as $reg) {
-                        if ($reg instanceof EE_Registration && $reg->event_ID() == $event->ID()) {
-                            $anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs'])
-                                ? $recipient->registrations[ $reg->ID() ]['ans_objs']
-                                : array();
-                            foreach ($anss as $ans) {
-                                if ($ans instanceof EE_Answer) {
-                                    $answers[ $ans->ID() ] = $ans;
-                                }
-                            }
-                        }
-                    }
-                }
-
-                $questions = $questions = isset($recipient->questions) ? $recipient->questions : array();
-
-                // if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
-                // object on it.
-                if (! isset($extra_data['data'])) {
-                    $extra_data['data'] = $recipient;
-                }
-
-                return $this->_parse_question_list_for_primary_or_recipient_registration(
-                    $shortcode_parser,
-                    $questions,
-                    $answers,
-                    $template,
-                    $valid_shortcodes,
-                    $extra_data
-                );
-                break;
-
-            default:
-                return $parsed;
-                break;
-        }
-    }
-
-
-    public function additional_primary_registration_details_shortcodes($shortcodes, $shortcode_parser)
-    {
-        $shortcodes['[PRIMARY_REGISTRANT_QUESTION_LIST]'] = __(
-            'This is used to indicate the questions and answers for the primary_registrant. It should be placed in the "[attendee_list]" field',
-            'event_espresso'
-        );
-
-        return $shortcodes;
-    }
-
-
-    /**
-     * Callback for FHEE__EE_Primary_Registration_List_Shortcodes__parser_after filter (dynamic filter).
-     *
-     * @param string         $parsed           The original parsed content for the shortcode
-     * @param string         $shortcode        The shortcode being parsed
-     * @param array          $data             The shortcode parser data array
-     * @param array          $extra_data       The shortcode parser extra data array
-     * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
-     *
-     * @return string
-     */
-    public function additional_primary_registration_details_parser(
-        $parsed,
-        $shortcode,
-        $data,
-        $extra_data,
-        $shortcode_parser
-    ) {
-        if (array($data) && ! isset($data['data'])) {
-            return $parsed;
-        }
-
-        $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
-        $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
-
-        if (! $recipient instanceof EE_Messages_Addressee) {
-            return $parsed;
-        }
-
-        switch ($shortcode) {
-            case '[PRIMARY_REGISTRANT_QUESTION_LIST]':
-                if (! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) {
-                    return '';
-                }
-                $registration = $recipient->primary_reg_obj;
-                $answers = isset($recipient->registrations[ $registration->ID() ]['ans_objs'])
-                    ? $recipient->registrations[ $registration->ID() ]['ans_objs']
-                    : array();
-                if (empty($answers)) {
-                    return '';
-                }
-                $template = is_array($data['template']) && isset($data['template']['question_list'])
-                    ? $data['template']['question_list']
-                    : $extra_data['template']['question_list'];
-                $valid_shortcodes = array('question');
-                $answers = $recipient->registrations[ $registration->ID() ]['ans_objs'];
-                $questions = isset($recipient->questions) ? $recipient->questions : array();
-                // if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
-                // object on it.
-                if (! isset($extra_data['data'])) {
-                    $extra_data['data'] = $recipient;
-                }
-                return $this->_parse_question_list_for_primary_or_recipient_registration(
-                    $shortcode_parser,
-                    $questions,
-                    $answers,
-                    $template,
-                    $valid_shortcodes,
-                    $extra_data
-                );
-                break;
-
-            default:
-                return $parsed;
-                break;
-        }
-    }
-
-
-    /**
-     * Takes care of registering the  message types that are only available in caffeinated EE.
-     *
-     * @since   4.3.2
-     *
-     * @return  void
-     */
-    public function register_caf_message_types()
-    {
-        // register newsletter message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Newsletter_message_type.class.php',
-            'autoloadpaths'                                    => array(
-                EE_CAF_LIBRARIES . 'messages/message_type/newsletter/',
-            ),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('newsletter', $setup_args);
-
-        // register payment reminder message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Payment_Reminder_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('payment_reminder', $setup_args);
-
-        // register payment declined message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Payment_Declined_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('payment_declined', $setup_args);
-
-        // register registration declined message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Declined_Registration_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('declined_registration', $setup_args);
-
-        // register registration cancelled message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Cancelled_Registration_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('cancelled_registration', $setup_args);
-
-
-        // register payment failed message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Payment_Failed_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('payment_failed', $setup_args);
-
-        // register payment declined message type
-        $setup_args = array(
-            'mtfilename'                                       => 'EE_Payment_Cancelled_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'),
-            'messengers_to_activate_with'                      => array('email'),
-            'messengers_to_validate_with'                      => array('email'),
-            'messengers_supporting_default_template_pack_with' => array('email'),
-        );
-        EE_Register_Message_Type::register('payment_cancelled', $setup_args);
-    }
-
-
-    /**
-     * Takes care of registering the  shortcode libraries implemented with caffeinated EE and set up related items.
-     *
-     * @since   4.3.2
-     *
-     * @return void
-     */
-    public function register_caf_shortcodes()
-    {
-        $setup_args = array(
-            'autoloadpaths'                 => array(
-                EE_CAF_LIBRARIES . 'shortcodes/',
-            ),
-            'msgr_validator_callback'       => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'),
-            'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'),
-            'list_type_shortcodes'          => array('[NEWSLETTER_CONTENT]'),
-        );
-        EE_Register_Messages_Shortcode_Library::register('newsletter', $setup_args);
-    }
-
-
-    /**
-     * Parses a question list shortcode using given data and template
-     *
-     * @param \EE_Shortcodes $shortcode_parser
-     * @param EE_Question[]  $questions        An array of questions indexed by answer id.
-     * @param EE_Answer[]    $answers          An array of answer objects
-     * @param string         $template         Template content to be parsed.
-     * @param array          $valid_shortcodes Valid shortcodes for the template being parsed.
-     * @param array          $extra_data       Extra data that might be used when parsing the template.
-     */
-    protected function _parse_question_list_for_primary_or_recipient_registration(
-        $shortcode_parser,
-        $questions,
-        $answers,
-        $template,
-        $valid_shortcodes,
-        $extra_data
-    ) {
-        $question_list = '';
-        /** @var EEH_Parse_Shortcodes $shortcode_helper */
-        $shortcode_helper = $shortcode_parser->get_shortcode_helper();
-        foreach ($answers as $answer) {
-            if ($answer instanceof EE_Answer) {
-                // first see if the question is in our $questions array. If not then try to get from answer object.
-                $question = isset($questions[ $answer->ID() ]) ? $questions[ $answer->ID() ] : null;
-                $question = ! $question instanceof EE_Question ? $answer->question() : $question;
-                if (! $question instanceof EE_Question
-                    || (
-                        $question instanceof EE_Question
-                        && $question->admin_only()
-                    )
-                ) {
-                    continue;
-                }
-                $question_list .= $shortcode_helper->parse_question_list_template(
-                    $template,
-                    $answer,
-                    $valid_shortcodes,
-                    $extra_data
-                );
-            }
-        }
-        return $question_list;
-    }
+	/**
+	 * constructor.
+	 */
+	public function __construct()
+	{
+		$this->_caf_hooks();
+	}
+
+
+	/**
+	 * Contains all the hooks filters for setting up caffeinated messages functionality.
+	 *
+	 * @since 4.3.2
+	 *
+	 * @return void
+	 */
+	private function _caf_hooks()
+	{
+		add_filter('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', array($this, 'messages_autoload_paths'), 5);
+		add_filter(
+			'FHEE__EE_Email_messenger__get_validator_config',
+			array($this, 'email_messenger_validator_config'),
+			5,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Email_messenger__get_template_fields',
+			array($this, 'email_messenger_template_fields'),
+			5,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Html_messenger__get_template_fields',
+			array($this, 'html_messenger_template_fields'),
+			5,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Html_messenger__get_validator_config',
+			array($this, 'html_messenger_validator_config'),
+			5,
+			2
+		);
+		add_filter('FHEE__EE_Pdf_messenger__get_template_fields', array($this, 'pdf_messenger_template_fields'), 5, 2);
+		add_filter(
+			'FHEE__EE_Pdf_messenger__get_validator_config',
+			array($this, 'pdf_messenger_validator_config'),
+			5,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Messages_Template_Pack__get_specific_template__contents',
+			array($this, 'new_default_templates'),
+			5,
+			7
+		);
+		add_filter(
+			'FHEE__EE_Messages_Base__get_valid_shortcodes',
+			array($this, 'message_types_valid_shortcodes'),
+			5,
+			2
+		);
+
+		// shortcode parsers
+		add_filter('FHEE__EE_Attendee_Shortcodes__shortcodes', array($this, 'additional_attendee_shortcodes'), 5, 2);
+		add_filter('FHEE__EE_Attendee_Shortcodes__parser_after', array($this, 'additional_attendee_parser'), 5, 5);
+		add_filter(
+			'FHEE__EE_Recipient_List_Shortcodes__shortcodes',
+			array($this, 'additional_recipient_details_shortcodes'),
+			5,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Recipient_List_Shortcodes__parser_after',
+			array($this, 'additional_recipient_details_parser'),
+			5,
+			5
+		);
+		add_filter(
+			'FHEE__EE_Primary_Registration_List_Shortcodes__shortcodes',
+			array($this, 'additional_primary_registration_details_shortcodes'),
+			5,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Primary_Registration_List_Shortcodes__parser_after',
+			array($this, 'additional_primary_registration_details_parser'),
+			5,
+			5
+		);
+
+		/**
+		 * @since 4.2.0
+		 */
+		add_filter('FHEE__EE_Datetime_Shortcodes__shortcodes', array($this, 'additional_datetime_shortcodes'), 10, 2);
+		add_filter('FHEE__EE_Datetime_Shortcodes__parser_after', array($this, 'additional_datetime_parser'), 10, 5);
+
+		/**
+		 * @since 4.3.0
+		 */
+		// eat our own dog food!
+		add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_message_types'));
+		add_action('EE_Brewing_Regular___messages_caf', array($this, 'register_caf_shortcodes'));
+		do_action('EE_Brewing_Regular___messages_caf');
+	}
+
+
+	/**
+	 * This just allows us to add additional paths to the autoloader (EED_Messages::autoload_messages()) for the
+	 * messages system.
+	 *
+	 * @param  array $dir_ref original array of paths
+	 *
+	 * @return array           appended paths
+	 */
+	public function messages_autoload_paths($dir_ref)
+	{
+		$dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/';
+
+		return $dir_ref;
+	}
+
+
+	public function email_messenger_validator_config($validator_config, EE_Email_messenger $messenger)
+	{
+		$validator_config['attendee_list'] = array(
+			'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
+			'required'   => array('[ATTENDEE_LIST]'),
+		);
+		$validator_config['question_list'] = array(
+			'shortcodes' => array('question'),
+			'required'   => array('[QUESTION_LIST]'),
+		);
+
+		return $validator_config;
+	}
+
+
+	public function html_messenger_validator_config($validator_config, EE_Html_messenger $messenger)
+	{
+		$validator_config['attendee_list'] = array(
+			'shortcodes' => array('attendee', 'question_list'),
+			'required'   => array('[ATTENDEE_LIST]'),
+		);
+		$validator_config['question_list'] = array(
+			'shortcodes' => array('question'),
+			'required'   => array('[QUESTION_LIST]'),
+		);
+
+		return $validator_config;
+	}
+
+
+	public function pdf_messenger_validator_config($validator_config, EE_Pdf_messenger $messenger)
+	{
+		$validator_config['attendee_list'] = array(
+			'shortcodes' => array('attendee', 'event_list', 'ticket_list', 'question_list'),
+			'required'   => array('[ATTENDEE_LIST]'),
+		);
+		$validator_config['question_list'] = array(
+			'shortcodes' => array('question'),
+			'required'   => array('[QUESTION_LIST]'),
+		);
+
+		return $validator_config;
+	}
+
+
+	public function email_messenger_template_fields($template_fields, EE_Email_messenger $messenger)
+	{
+		$template_fields['extra']['content']['question_list'] = array(
+			'input'               => 'textarea',
+			'label'               => '[QUESTION_LIST]',
+			'type'                => 'string',
+			'required'            => true,
+			'validation'          => true,
+			'format'              => '%s',
+			'css_class'           => 'large-text',
+			'rows'                => '5',
+			'shortcodes_required' => array('[QUESTION_LIST]'),
+		);
+
+		return $template_fields;
+	}
+
+
+	public function html_messenger_template_fields($template_fields, EE_Html_messenger $messenger)
+	{
+		$template_fields['extra']['content']['question_list'] = array(
+			'input'               => 'textarea',
+			'label'               => '[QUESTION_LIST]',
+			'type'                => 'string',
+			'required'            => true,
+			'validation'          => true,
+			'format'              => '%s',
+			'css_class'           => 'large-text',
+			'rows'                => '5',
+			'shortcodes_required' => array('[QUESTION_LIST]'),
+		);
+
+		return $template_fields;
+	}
+
+
+	public function pdf_messenger_template_fields($template_fields, EE_Pdf_messenger $messenger)
+	{
+		$template_fields['extra']['content']['question_list'] = array(
+			'input'               => 'textarea',
+			'label'               => '[QUESTION_LIST]',
+			'type'                => 'string',
+			'required'            => true,
+			'validation'          => true,
+			'format'              => '%s',
+			'css_class'           => 'large-text',
+			'rows'                => '5',
+			'shortcodes_required' => array('[QUESTION_LIST]'),
+		);
+
+		return $template_fields;
+	}
+
+
+	public function new_default_templates(
+		$contents,
+		$actual_path,
+		EE_messenger $messenger,
+		EE_message_type $message_type,
+		$field,
+		$context,
+		EE_Messages_Template_Pack $template_pack
+	) {
+
+		// we're only modifying templates for the default template pack
+		if (! $template_pack instanceof EE_Messages_Template_Pack_Default) {
+			return $contents;
+		}
+
+		// the template file name we're replacing contents for.
+		$template_file_prefix = $field . '_' . $context;
+		$msg_prefix = $messenger->name . '_' . $message_type->name . '_';
+
+		$base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/';
+
+		if ($messenger->name == 'email' && $message_type->name == 'registration') {
+			switch ($template_file_prefix) {
+				case 'question_list_admin':
+				case 'question_list_attendee':
+				case 'question_list_primary_attendee':
+					$path = $base_path . $msg_prefix . 'question_list.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+
+				case 'attendee_list_primary_attendee':
+					$path = $base_path . $msg_prefix . 'attendee_list.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+
+				case 'attendee_list_admin':
+					$path = $base_path . $msg_prefix . 'attendee_list_admin.template.php';
+					$contents = EEH_Template::display_template(
+						$path,
+						array(),
+						true
+					);
+					break;
+
+				case 'attendee_list_attendee':
+					$contents = '';
+					break;
+
+				case 'event_list_attendee':
+					$path = $base_path . $msg_prefix . 'event_list_attendee.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+			}
+		} elseif ($messenger->name == 'email' && $message_type->name == 'newsletter') {
+			switch ($template_file_prefix) {
+				case 'content_attendee':
+					$path = $base_path . $msg_prefix . 'content.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+
+				case 'newsletter_content_attendee':
+					$path = $base_path . $msg_prefix . 'newsletter_content.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+
+				case 'newsletter_subject_attendee':
+					$path = $base_path . $msg_prefix . 'subject.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+			}
+		} elseif ($messenger->name == 'html' && $message_type->name == 'receipt') {
+			switch ($template_file_prefix) {
+				case 'attendee_list_purchaser':
+					$path = $base_path . $msg_prefix . 'attendee_list.template.php';
+					$contents = EEH_Template::display_template($path, array(), true);
+					break;
+			}
+		}
+
+		return $contents;
+	}
+
+
+	public function message_types_valid_shortcodes($valid_shortcodes, EE_Messages_Base $msg)
+	{
+		// make sure question_list and question are ONLY added for the core message types.  Any other message types will have to explicitly set question_list as a valid shortcode.
+		$include_with = array(
+			'registration',
+			'cancelled_registration',
+			'declined_registration',
+			'not_approved_registration',
+			'payment_declined',
+			'payment_failed',
+			'payment_cancelled',
+			'payment',
+			'payment_reminder',
+			'pending_approval',
+			'registration_summary',
+			'invoice',
+			'receipt',
+		);
+		if ($msg instanceof EE_message_type && in_array($msg->name, $include_with)) {
+			$contexts = array_keys($msg->get_contexts());
+			foreach ($contexts as $context) {
+				$valid_shortcodes[ $context ][] = 'question_list';
+				$valid_shortcodes[ $context ][] = 'question';
+			}
+		}
+
+		return $valid_shortcodes;
+	}
+
+
+	public function additional_attendee_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$shortcodes['[ANSWER_*]'] = __(
+			'This is a special dynamic shortcode. Right after the "*", add the exact text of a existing question, and if there is an answer for that question for this registrant, that will take the place of this shortcode.',
+			'event_espresso'
+		);
+
+		return $shortcodes;
+	}
+
+
+	public function additional_attendee_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
+	{
+
+		if (strpos($shortcode, '[ANSWER_*') === false
+			|| ! isset($extra_data['data']->questions)
+			|| ! isset($extra_data['data']->registrations)
+		) {
+			return $parsed;
+		}
+
+		// let's get the question from the code.
+		$shortcode = str_replace('[ANSWER_*', '', $shortcode);
+		$shortcode = trim(str_replace(']', '', $shortcode));
+
+		$registration = $data instanceof EE_Registration ? $data : null;
+		$registration = ! $registration instanceof EE_Registration && is_array(
+			$extra_data
+		) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Registration ? $extra_data['data'] : $registration;
+
+		$aee = $data instanceof EE_Messages_Addressee ? $data : null;
+		$aee = ! $aee instanceof EE_Messages_Addressee && is_array(
+			$extra_data
+		) && isset($extra_data['data']) ? $extra_data['data'] : $aee;
+
+		if (! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) {
+			return $parsed;
+		}
+
+		// now let's figure out which question has this text.
+		foreach ($aee->questions as $ansid => $question) {
+			if ($question instanceof EE_Question
+				&& trim($question->display_text()) == trim($shortcode)
+				&& isset($aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ])
+			) {
+				return $aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ]->get_pretty(
+					'ANS_value',
+					'no_wpautop'
+				);
+			}
+		}
+
+		// nothing!
+		return $parsed;
+	}
+
+
+	/**
+	 * Callback for additional shortcodes filter for adding additional datetime shortcodes.
+	 *
+	 * @since  4.2
+	 *
+	 * @param  array                  $shortcodes         array of shortcodes and
+	 *                                                    descriptions
+	 * @param  EE_Datetime_Shortcodes $shortcode_parser   EE_Shortcodes object
+	 *
+	 * @return array                                        array of shortcodes and
+	 *                                                        descriptions
+	 */
+	public function additional_datetime_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$shortcodes['[DTT_NAME]'] = __(
+			'This will be parsed to the Title given for a Datetime',
+			'event_espresso'
+		);
+		$shortcodes['[DTT_DESCRIPTION]'] = __(
+			'This will be parsed to the description for a Datetime',
+			'event_espresso'
+		);
+		$shortcodes['[DTT_NAME_OR_DATES]'] = __(
+			'When parsed, if the Datetime has a name, it is used, otherwise a formatted string including the start date and end date will be used.',
+			'event_espresso'
+		);
+
+		return $shortcodes;
+	}
+
+
+	/**
+	 * Callback for additional shortcodes parser filter used for adding parser for new
+	 * Datetime shortcodes
+	 *
+	 * @since  4.2
+	 *
+	 * @param  string                 $parsed     The finished parsed string for the given shortcode.
+	 * @param  string                 $shortcode  The shortcode being parsed.
+	 * @param  object                 $data       The incoming data object for the Shortcode Parser.
+	 * @param  object                 $extra_data The incoming extra date object for the Shortcode
+	 *                                            Parser.
+	 * @param  EE_Datetime_Shortcodes $shortcode_parser
+	 *
+	 * @return string                   The new parsed string.
+	 */
+	public function additional_datetime_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
+	{
+
+		if (! $data instanceof EE_Datetime) {
+			return ''; // get out because we can only parse with the datetime object.
+		}
+
+		switch ($shortcode) {
+			case '[DTT_NAME]':
+				return $data->name();
+				break;
+			case '[DTT_DESCRIPTION]':
+				return $data->description();
+				break;
+			case '[DTT_NAME_OR_DATES]':
+				return $data->get_dtt_display_name(true);
+				break;
+			default:
+				return $parsed;
+				break;
+		}
+	}
+
+
+	public function additional_recipient_details_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$shortcodes['[RECIPIENT_QUESTION_LIST]'] = __(
+			'This is used to indicate where you want the list of questions and answers to show for the person receiving the message.',
+			'event_espresso'
+		);
+
+		return $shortcodes;
+	}
+
+
+	/**
+	 * Callback for FHEE__EE_Recipient_List_Shortcodes__parser_after filter (dynamic filter).
+	 *
+	 * @param string         $parsed           The original parsed content for the shortcode
+	 * @param string         $shortcode        The shortcode being parsed
+	 * @param array          $data             The shortcode parser data array
+	 * @param array          $extra_data       The shortcode parser extra data array
+	 * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
+	 *
+	 * @return string
+	 */
+	public function additional_recipient_details_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
+	{
+
+		if (array($data) && ! isset($data['data'])) {
+			return $parsed;
+		}
+
+		$recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
+		$recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
+
+		if (! $recipient instanceof EE_Messages_Addressee) {
+			return $parsed;
+		}
+
+		switch ($shortcode) {
+			case '[RECIPIENT_QUESTION_LIST]':
+				$att = $recipient->att_obj;
+				$registrations_on_attendee = $att instanceof EE_Attendee
+					? $recipient->attendees[ $att->ID() ]['reg_objs']
+					: array();
+				$registrations_on_attendee = empty($registrations_on_attendee) && $recipient->reg_obj instanceof EE_Registration ? array($recipient->reg_obj) : $registrations_on_attendee;
+				$answers = array();
+
+				$template = is_array($data['template']) && isset($data['template']['question_list'])
+					? $data['template']['question_list']
+					: $extra_data['template']['question_list'];
+				$valid_shortcodes = array('question');
+
+				// if the context is main_content then get all answers for all registrations on this attendee
+				if ($data['data'] instanceof EE_Messages_Addressee) {
+					foreach ($registrations_on_attendee as $reg) {
+						if ($reg instanceof EE_Registration) {
+							$anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs'])
+								? $recipient->registrations[ $reg->ID() ]['ans_objs']
+								: array();
+							foreach ($anss as $ans) {
+								if ($ans instanceof EE_Answer) {
+									$answers[ $ans->ID() ] = $ans;
+								}
+							}
+						}
+					}
+				}
+
+				// if the context is the event list parser, then let's return just the answers for all registrations attached to the recipient for that event.
+				if ($data['data'] instanceof EE_Event) {
+					$event = $data['data'];
+					foreach ($registrations_on_attendee as $reg) {
+						if ($reg instanceof EE_Registration && $reg->event_ID() == $event->ID()) {
+							$anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs'])
+								? $recipient->registrations[ $reg->ID() ]['ans_objs']
+								: array();
+							foreach ($anss as $ans) {
+								if ($ans instanceof EE_Answer) {
+									$answers[ $ans->ID() ] = $ans;
+								}
+							}
+						}
+					}
+				}
+
+				$questions = $questions = isset($recipient->questions) ? $recipient->questions : array();
+
+				// if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
+				// object on it.
+				if (! isset($extra_data['data'])) {
+					$extra_data['data'] = $recipient;
+				}
+
+				return $this->_parse_question_list_for_primary_or_recipient_registration(
+					$shortcode_parser,
+					$questions,
+					$answers,
+					$template,
+					$valid_shortcodes,
+					$extra_data
+				);
+				break;
+
+			default:
+				return $parsed;
+				break;
+		}
+	}
+
+
+	public function additional_primary_registration_details_shortcodes($shortcodes, $shortcode_parser)
+	{
+		$shortcodes['[PRIMARY_REGISTRANT_QUESTION_LIST]'] = __(
+			'This is used to indicate the questions and answers for the primary_registrant. It should be placed in the "[attendee_list]" field',
+			'event_espresso'
+		);
+
+		return $shortcodes;
+	}
+
+
+	/**
+	 * Callback for FHEE__EE_Primary_Registration_List_Shortcodes__parser_after filter (dynamic filter).
+	 *
+	 * @param string         $parsed           The original parsed content for the shortcode
+	 * @param string         $shortcode        The shortcode being parsed
+	 * @param array          $data             The shortcode parser data array
+	 * @param array          $extra_data       The shortcode parser extra data array
+	 * @param \EE_Shortcodes $shortcode_parser Shortcode parser.
+	 *
+	 * @return string
+	 */
+	public function additional_primary_registration_details_parser(
+		$parsed,
+		$shortcode,
+		$data,
+		$extra_data,
+		$shortcode_parser
+	) {
+		if (array($data) && ! isset($data['data'])) {
+			return $parsed;
+		}
+
+		$recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
+		$recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
+
+		if (! $recipient instanceof EE_Messages_Addressee) {
+			return $parsed;
+		}
+
+		switch ($shortcode) {
+			case '[PRIMARY_REGISTRANT_QUESTION_LIST]':
+				if (! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) {
+					return '';
+				}
+				$registration = $recipient->primary_reg_obj;
+				$answers = isset($recipient->registrations[ $registration->ID() ]['ans_objs'])
+					? $recipient->registrations[ $registration->ID() ]['ans_objs']
+					: array();
+				if (empty($answers)) {
+					return '';
+				}
+				$template = is_array($data['template']) && isset($data['template']['question_list'])
+					? $data['template']['question_list']
+					: $extra_data['template']['question_list'];
+				$valid_shortcodes = array('question');
+				$answers = $recipient->registrations[ $registration->ID() ]['ans_objs'];
+				$questions = isset($recipient->questions) ? $recipient->questions : array();
+				// if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
+				// object on it.
+				if (! isset($extra_data['data'])) {
+					$extra_data['data'] = $recipient;
+				}
+				return $this->_parse_question_list_for_primary_or_recipient_registration(
+					$shortcode_parser,
+					$questions,
+					$answers,
+					$template,
+					$valid_shortcodes,
+					$extra_data
+				);
+				break;
+
+			default:
+				return $parsed;
+				break;
+		}
+	}
+
+
+	/**
+	 * Takes care of registering the  message types that are only available in caffeinated EE.
+	 *
+	 * @since   4.3.2
+	 *
+	 * @return  void
+	 */
+	public function register_caf_message_types()
+	{
+		// register newsletter message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Newsletter_message_type.class.php',
+			'autoloadpaths'                                    => array(
+				EE_CAF_LIBRARIES . 'messages/message_type/newsletter/',
+			),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('newsletter', $setup_args);
+
+		// register payment reminder message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Payment_Reminder_message_type.class.php',
+			'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('payment_reminder', $setup_args);
+
+		// register payment declined message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Payment_Declined_message_type.class.php',
+			'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('payment_declined', $setup_args);
+
+		// register registration declined message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Declined_Registration_message_type.class.php',
+			'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('declined_registration', $setup_args);
+
+		// register registration cancelled message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Cancelled_Registration_message_type.class.php',
+			'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('cancelled_registration', $setup_args);
+
+
+		// register payment failed message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Payment_Failed_message_type.class.php',
+			'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('payment_failed', $setup_args);
+
+		// register payment declined message type
+		$setup_args = array(
+			'mtfilename'                                       => 'EE_Payment_Cancelled_message_type.class.php',
+			'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'),
+			'messengers_to_activate_with'                      => array('email'),
+			'messengers_to_validate_with'                      => array('email'),
+			'messengers_supporting_default_template_pack_with' => array('email'),
+		);
+		EE_Register_Message_Type::register('payment_cancelled', $setup_args);
+	}
+
+
+	/**
+	 * Takes care of registering the  shortcode libraries implemented with caffeinated EE and set up related items.
+	 *
+	 * @since   4.3.2
+	 *
+	 * @return void
+	 */
+	public function register_caf_shortcodes()
+	{
+		$setup_args = array(
+			'autoloadpaths'                 => array(
+				EE_CAF_LIBRARIES . 'shortcodes/',
+			),
+			'msgr_validator_callback'       => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'),
+			'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'),
+			'list_type_shortcodes'          => array('[NEWSLETTER_CONTENT]'),
+		);
+		EE_Register_Messages_Shortcode_Library::register('newsletter', $setup_args);
+	}
+
+
+	/**
+	 * Parses a question list shortcode using given data and template
+	 *
+	 * @param \EE_Shortcodes $shortcode_parser
+	 * @param EE_Question[]  $questions        An array of questions indexed by answer id.
+	 * @param EE_Answer[]    $answers          An array of answer objects
+	 * @param string         $template         Template content to be parsed.
+	 * @param array          $valid_shortcodes Valid shortcodes for the template being parsed.
+	 * @param array          $extra_data       Extra data that might be used when parsing the template.
+	 */
+	protected function _parse_question_list_for_primary_or_recipient_registration(
+		$shortcode_parser,
+		$questions,
+		$answers,
+		$template,
+		$valid_shortcodes,
+		$extra_data
+	) {
+		$question_list = '';
+		/** @var EEH_Parse_Shortcodes $shortcode_helper */
+		$shortcode_helper = $shortcode_parser->get_shortcode_helper();
+		foreach ($answers as $answer) {
+			if ($answer instanceof EE_Answer) {
+				// first see if the question is in our $questions array. If not then try to get from answer object.
+				$question = isset($questions[ $answer->ID() ]) ? $questions[ $answer->ID() ] : null;
+				$question = ! $question instanceof EE_Question ? $answer->question() : $question;
+				if (! $question instanceof EE_Question
+					|| (
+						$question instanceof EE_Question
+						&& $question->admin_only()
+					)
+				) {
+					continue;
+				}
+				$question_list .= $shortcode_helper->parse_question_list_template(
+					$template,
+					$answer,
+					$valid_shortcodes,
+					$extra_data
+				);
+			}
+		}
+		return $question_list;
+	}
 }

Spacing +44 added lines, -44 removed lines

@@ -130,7 +130,7 @@ 
      */
     public function messages_autoload_paths($dir_ref)
     {
-        $dir_ref[] = EE_CAF_LIBRARIES . 'shortcodes/';
+        $dir_ref[] = EE_CAF_LIBRARIES.'shortcodes/';
 
         return $dir_ref;
     }
@@ -246,32 +246,32 @@ 
     ) {
 
         // we're only modifying templates for the default template pack
-        if (! $template_pack instanceof EE_Messages_Template_Pack_Default) {
+        if ( ! $template_pack instanceof EE_Messages_Template_Pack_Default) {
             return $contents;
         }
 
         // the template file name we're replacing contents for.
-        $template_file_prefix = $field . '_' . $context;
-        $msg_prefix = $messenger->name . '_' . $message_type->name . '_';
+        $template_file_prefix = $field.'_'.$context;
+        $msg_prefix = $messenger->name.'_'.$message_type->name.'_';
 
-        $base_path = EE_CAF_LIBRARIES . 'messages/defaults/default/';
+        $base_path = EE_CAF_LIBRARIES.'messages/defaults/default/';
 
         if ($messenger->name == 'email' && $message_type->name == 'registration') {
             switch ($template_file_prefix) {
                 case 'question_list_admin':
                 case 'question_list_attendee':
                 case 'question_list_primary_attendee':
-                    $path = $base_path . $msg_prefix . 'question_list.template.php';
+                    $path = $base_path.$msg_prefix.'question_list.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
 
                 case 'attendee_list_primary_attendee':
-                    $path = $base_path . $msg_prefix . 'attendee_list.template.php';
+                    $path = $base_path.$msg_prefix.'attendee_list.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
 
                 case 'attendee_list_admin':
-                    $path = $base_path . $msg_prefix . 'attendee_list_admin.template.php';
+                    $path = $base_path.$msg_prefix.'attendee_list_admin.template.php';
                     $contents = EEH_Template::display_template(
                         $path,
                         array(),
@@ -284,31 +284,31 @@ 
                     break;
 
                 case 'event_list_attendee':
-                    $path = $base_path . $msg_prefix . 'event_list_attendee.template.php';
+                    $path = $base_path.$msg_prefix.'event_list_attendee.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
             }
         } elseif ($messenger->name == 'email' && $message_type->name == 'newsletter') {
             switch ($template_file_prefix) {
                 case 'content_attendee':
-                    $path = $base_path . $msg_prefix . 'content.template.php';
+                    $path = $base_path.$msg_prefix.'content.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
 
                 case 'newsletter_content_attendee':
-                    $path = $base_path . $msg_prefix . 'newsletter_content.template.php';
+                    $path = $base_path.$msg_prefix.'newsletter_content.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
 
                 case 'newsletter_subject_attendee':
-                    $path = $base_path . $msg_prefix . 'subject.template.php';
+                    $path = $base_path.$msg_prefix.'subject.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
             }
         } elseif ($messenger->name == 'html' && $message_type->name == 'receipt') {
             switch ($template_file_prefix) {
                 case 'attendee_list_purchaser':
-                    $path = $base_path . $msg_prefix . 'attendee_list.template.php';
+                    $path = $base_path.$msg_prefix.'attendee_list.template.php';
                     $contents = EEH_Template::display_template($path, array(), true);
                     break;
             }
@@ -339,8 +339,8 @@ 
         if ($msg instanceof EE_message_type && in_array($msg->name, $include_with)) {
             $contexts = array_keys($msg->get_contexts());
             foreach ($contexts as $context) {
-                $valid_shortcodes[ $context ][] = 'question_list';
-                $valid_shortcodes[ $context ][] = 'question';
+                $valid_shortcodes[$context][] = 'question_list';
+                $valid_shortcodes[$context][] = 'question';
             }
         }
 
@@ -383,7 +383,7 @@ 
             $extra_data
         ) && isset($extra_data['data']) ? $extra_data['data'] : $aee;
 
-        if (! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) {
+        if ( ! $registration instanceof EE_Registration || ! $aee instanceof EE_Messages_Addressee) {
             return $parsed;
         }
 
@@ -391,9 +391,9 @@ 
         foreach ($aee->questions as $ansid => $question) {
             if ($question instanceof EE_Question
                 && trim($question->display_text()) == trim($shortcode)
-                && isset($aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ])
+                && isset($aee->registrations[$registration->ID()]['ans_objs'][$ansid])
             ) {
-                return $aee->registrations[ $registration->ID() ]['ans_objs'][ $ansid ]->get_pretty(
+                return $aee->registrations[$registration->ID()]['ans_objs'][$ansid]->get_pretty(
                     'ANS_value',
                     'no_wpautop'
                 );
@@ -454,7 +454,7 @@ 
     public function additional_datetime_parser($parsed, $shortcode, $data, $extra_data, $shortcode_parser)
     {
 
-        if (! $data instanceof EE_Datetime) {
+        if ( ! $data instanceof EE_Datetime) {
             return ''; // get out because we can only parse with the datetime object.
         }
 
@@ -507,7 +507,7 @@ 
         $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
         $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
 
-        if (! $recipient instanceof EE_Messages_Addressee) {
+        if ( ! $recipient instanceof EE_Messages_Addressee) {
             return $parsed;
         }
 
@@ -515,7 +515,7 @@ 
             case '[RECIPIENT_QUESTION_LIST]':
                 $att = $recipient->att_obj;
                 $registrations_on_attendee = $att instanceof EE_Attendee
-                    ? $recipient->attendees[ $att->ID() ]['reg_objs']
+                    ? $recipient->attendees[$att->ID()]['reg_objs']
                     : array();
                 $registrations_on_attendee = empty($registrations_on_attendee) && $recipient->reg_obj instanceof EE_Registration ? array($recipient->reg_obj) : $registrations_on_attendee;
                 $answers = array();
@@ -529,12 +529,12 @@ 
                 if ($data['data'] instanceof EE_Messages_Addressee) {
                     foreach ($registrations_on_attendee as $reg) {
                         if ($reg instanceof EE_Registration) {
-                            $anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs'])
-                                ? $recipient->registrations[ $reg->ID() ]['ans_objs']
+                            $anss = ! empty($recipient->registrations[$reg->ID()]['ans_objs'])
+                                ? $recipient->registrations[$reg->ID()]['ans_objs']
                                 : array();
                             foreach ($anss as $ans) {
                                 if ($ans instanceof EE_Answer) {
-                                    $answers[ $ans->ID() ] = $ans;
+                                    $answers[$ans->ID()] = $ans;
                                 }
                             }
                         }
@@ -546,12 +546,12 @@ 
                     $event = $data['data'];
                     foreach ($registrations_on_attendee as $reg) {
                         if ($reg instanceof EE_Registration && $reg->event_ID() == $event->ID()) {
-                            $anss = ! empty($recipient->registrations[ $reg->ID() ]['ans_objs'])
-                                ? $recipient->registrations[ $reg->ID() ]['ans_objs']
+                            $anss = ! empty($recipient->registrations[$reg->ID()]['ans_objs'])
+                                ? $recipient->registrations[$reg->ID()]['ans_objs']
                                 : array();
                             foreach ($anss as $ans) {
                                 if ($ans instanceof EE_Answer) {
-                                    $answers[ $ans->ID() ] = $ans;
+                                    $answers[$ans->ID()] = $ans;
                                 }
                             }
                         }
@@ -562,7 +562,7 @@ 
 
                 // if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
                 // object on it.
-                if (! isset($extra_data['data'])) {
+                if ( ! isset($extra_data['data'])) {
                     $extra_data['data'] = $recipient;
                 }
 
@@ -619,18 +619,18 @@ 
         $recipient = $data['data'] instanceof EE_Messages_Addressee ? $data['data'] : null;
         $recipient = ! $recipient instanceof EE_Messages_Addressee && array($extra_data) && isset($extra_data['data']) && $extra_data['data'] instanceof EE_Messages_Addressee ? $extra_data['data'] : $recipient;
 
-        if (! $recipient instanceof EE_Messages_Addressee) {
+        if ( ! $recipient instanceof EE_Messages_Addressee) {
             return $parsed;
         }
 
         switch ($shortcode) {
             case '[PRIMARY_REGISTRANT_QUESTION_LIST]':
-                if (! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) {
+                if ( ! $recipient->primary_att_obj instanceof EE_Attendee || ! $recipient->primary_reg_obj instanceof EE_Registration) {
                     return '';
                 }
                 $registration = $recipient->primary_reg_obj;
-                $answers = isset($recipient->registrations[ $registration->ID() ]['ans_objs'])
-                    ? $recipient->registrations[ $registration->ID() ]['ans_objs']
+                $answers = isset($recipient->registrations[$registration->ID()]['ans_objs'])
+                    ? $recipient->registrations[$registration->ID()]['ans_objs']
                     : array();
                 if (empty($answers)) {
                     return '';
@@ -639,11 +639,11 @@ 
                     ? $data['template']['question_list']
                     : $extra_data['template']['question_list'];
                 $valid_shortcodes = array('question');
-                $answers = $recipient->registrations[ $registration->ID() ]['ans_objs'];
+                $answers = $recipient->registrations[$registration->ID()]['ans_objs'];
                 $questions = isset($recipient->questions) ? $recipient->questions : array();
                 // if $extra_data does not have a 'data' key then let's make sure we add it and set the EE_Messages_Addressee
                 // object on it.
-                if (! isset($extra_data['data'])) {
+                if ( ! isset($extra_data['data'])) {
                     $extra_data['data'] = $recipient;
                 }
                 return $this->_parse_question_list_for_primary_or_recipient_registration(
@@ -676,7 +676,7 @@ 
         $setup_args = array(
             'mtfilename'                                       => 'EE_Newsletter_message_type.class.php',
             'autoloadpaths'                                    => array(
-                EE_CAF_LIBRARIES . 'messages/message_type/newsletter/',
+                EE_CAF_LIBRARIES.'messages/message_type/newsletter/',
             ),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
@@ -687,7 +687,7 @@ 
         // register payment reminder message type
         $setup_args = array(
             'mtfilename'                                       => 'EE_Payment_Reminder_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_reminder/'),
+            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES.'messages/message_type/payment_reminder/'),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email'),
@@ -697,7 +697,7 @@ 
         // register payment declined message type
         $setup_args = array(
             'mtfilename'                                       => 'EE_Payment_Declined_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_declined/'),
+            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES.'messages/message_type/payment_declined/'),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email'),
@@ -707,7 +707,7 @@ 
         // register registration declined message type
         $setup_args = array(
             'mtfilename'                                       => 'EE_Declined_Registration_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/declined_registration/'),
+            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES.'messages/message_type/declined_registration/'),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email'),
@@ -717,7 +717,7 @@ 
         // register registration cancelled message type
         $setup_args = array(
             'mtfilename'                                       => 'EE_Cancelled_Registration_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/cancelled_registration/'),
+            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES.'messages/message_type/cancelled_registration/'),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email'),
@@ -728,7 +728,7 @@ 
         // register payment failed message type
         $setup_args = array(
             'mtfilename'                                       => 'EE_Payment_Failed_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_failed/'),
+            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES.'messages/message_type/payment_failed/'),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email'),
@@ -738,7 +738,7 @@ 
         // register payment declined message type
         $setup_args = array(
             'mtfilename'                                       => 'EE_Payment_Cancelled_message_type.class.php',
-            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES . 'messages/message_type/payment_cancelled/'),
+            'autoloadpaths'                                    => array(EE_CAF_LIBRARIES.'messages/message_type/payment_cancelled/'),
             'messengers_to_activate_with'                      => array('email'),
             'messengers_to_validate_with'                      => array('email'),
             'messengers_supporting_default_template_pack_with' => array('email'),
@@ -758,7 +758,7 @@ 
     {
         $setup_args = array(
             'autoloadpaths'                 => array(
-                EE_CAF_LIBRARIES . 'shortcodes/',
+                EE_CAF_LIBRARIES.'shortcodes/',
             ),
             'msgr_validator_callback'       => array('EE_Newsletter_Shortcodes', 'messenger_validator_config'),
             'msgr_template_fields_callback' => array('EE_Newsletter_Shortcodes', 'messenger_template_fields'),
@@ -792,9 +792,9 @@ 
         foreach ($answers as $answer) {
             if ($answer instanceof EE_Answer) {
                 // first see if the question is in our $questions array. If not then try to get from answer object.
-                $question = isset($questions[ $answer->ID() ]) ? $questions[ $answer->ID() ] : null;
+                $question = isset($questions[$answer->ID()]) ? $questions[$answer->ID()] : null;
                 $question = ! $question instanceof EE_Question ? $answer->question() : $question;
-                if (! $question instanceof EE_Question
+                if ( ! $question instanceof EE_Question
                     || (
                         $question instanceof EE_Question
                         && $question->admin_only()

caffeinated/admin/new/pricing/Prices_List_Table.class.php

Indentation +216 added lines, -216 removed lines

@@ -16,220 +16,220 @@
 class Prices_List_Table extends EE_Admin_List_Table
 {
 
-    private $_PRT;
-
-    /**
-     * Array of price types.
-     *
-     * @var EE_Price_Type[]
-     */
-    protected $_price_types = array();
-
-    public function __construct($admin_page)
-    {
-        parent::__construct($admin_page);
-        require_once(EE_MODELS . 'EEM_Price_Type.model.php');
-        $this->_PRT = EEM_Price_Type::instance();
-        $this->_price_types = $this->_PRT->get_all_deleted_and_undeleted();
-    }
-
-
-    protected function _setup_data()
-    {
-        $trashed = $this->_admin_page->get_view() == 'trashed' ? true : false;
-        $this->_data = $this->_admin_page->get_prices_overview_data($this->_per_page, false, $trashed);
-        $this->_all_data_count = $this->_admin_page->get_prices_overview_data($this->_per_page, true, false);
-        $this->_trashed_count = $this->_admin_page->get_prices_overview_data($this->_per_page, true, true);
-    }
-
-
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = array(
-            'singular' => __('price', 'event_espresso'),
-            'plural'   => __('prices', 'event_espresso'),
-            'ajax'     => true,
-            'screen'   => $this->_admin_page->get_current_screen()->id,
-        );
-
-        $this->_columns = array(
-            'cb'          => '<input type="checkbox" />', // Render a checkbox instead of text
-            'name'        => __('Name', 'event_espresso'),
-            'type'        => __('Price Type', 'event_espresso'),
-            'description' => __('Description', 'event_espresso'),
-            'amount'      => __('Amount', 'event_espresso'),
-        );
-
-        $this->_sortable_columns = array(
-            // true means its already sorted
-            'name'   => array('name' => false),
-            'type'   => array('type' => false),
-            'amount' => array('amount' => false),
-        );
-
-        $this->_hidden_columns = array();
-
-        $this->_ajax_sorting_callback = 'update_prices_order';
-    }
-
-
-    protected function _get_table_filters()
-    {
-    }
-
-
-    protected function _add_view_counts()
-    {
-        $this->_views['all']['count'] = $this->_all_data_count;
-        if (EE_Registry::instance()->CAP->current_user_can('ee_delete_default_prices', 'pricing_trash_price')) {
-            $this->_views['trashed']['count'] = $this->_trashed_count;
-        }
-    }
-
-
-    /**
-     * overriding parent method so that we can make sure the row isn't sortable for certain items
-     *
-     * @param  object $item the current item
-     * @return string
-     */
-    protected function _get_row_class($item)
-    {
-        static $row_class = '';
-        $row_class = ($row_class == '' ? 'alternate' : '');
-
-        $new_row = $row_class;
-
-        if ($item->type_obj()->base_type() !== 1 && $item->type_obj()->base_type() !== 4) {
-            $new_row .= ' rowsortable';
-        }
-
-        return ' class="' . $new_row . '"';
-    }
-
-
-    public function column_cb($item)
-    {
-        if ($item->type_obj()->base_type() !== 1) {
-            return sprintf(
-                '<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />',
-                $item->ID()
-            );
-        }
-        return '';
-    }
-
-
-    public function column_name($item)
-    {
-
-        // Build row actions
-        $actions = array();
-        // edit price link
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_default_price',
-            'pricing_edit_price',
-            $item->ID()
-        )) {
-            $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-                'action' => 'edit_price',
-                'id'     => $item->ID(),
-            ), PRICING_ADMIN_URL);
-            $actions['edit'] = '<a href="' . $edit_lnk_url . '" title="'
-                               . esc_attr__('Edit Price', 'event_espresso') . '">'
-                               . __('Edit', 'event_espresso') . '</a>';
-        }
-
-        $name_link = EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_default_price',
-            'edit_price',
-            $item->ID()
-        )
-            ? '<a href="' . $edit_lnk_url . '" title="'
-              . esc_attr__('Edit Price', 'event_espresso') . '">'
-              . stripslashes($item->name()) . '</a>'
-            : $item->name();
-
-        if ($item->type_obj()->base_type() !== 1) {
-            if ($this->_view == 'all') {
-                // trash price link
-                if (EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_default_price',
-                    'pricing_trash_price',
-                    $item->ID()
-                )) {
-                    $trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-                        'action'   => 'trash_price',
-                        'id'       => $item->ID(),
-                        'noheader' => true,
-                    ), PRICING_ADMIN_URL);
-                    $actions['trash'] = '<a href="' . $trash_lnk_url . '" title="'
-                                        . esc_attr__('Move Price to Trash', 'event_espresso') . '">'
-                                        . __('Move to Trash', 'event_espresso') . '</a>';
-                }
-            } else {
-                if (EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_default_price',
-                    'pricing_restore_price',
-                    $item->ID()
-                )) {
-                    // restore price link
-                    $restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-                        'action'   => 'restore_price',
-                        'id'       => $item->ID(),
-                        'noheader' => true,
-                    ), PRICING_ADMIN_URL);
-                    $actions['restore'] = '<a href="' . $restore_lnk_url . '" title="'
-                                          . esc_attr__('Restore Price', 'event_espresso') . '">'
-                                          . __('Restore', 'event_espresso') . '</a>';
-                }
-
-                // delete price link
-                if (EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_default_price',
-                    'pricing_delete_price',
-                    $item->ID()
-                )) {
-                    $delete_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-                        'action'   => 'delete_price',
-                        'id'       => $item->ID(),
-                        'noheader' => true,
-                    ), PRICING_ADMIN_URL);
-                    $actions['delete'] = '<a href="' . $delete_lnk_url . '" title="'
-                                         . esc_attr__('Delete Price Permanently', 'event_espresso') . '">'
-                                         . __('Delete Permanently', 'event_espresso') . '</a>';
-                }
-            }
-        }
-
-        // Return the name contents
-        return sprintf(
-            '%1$s <span style="color:silver">(id:%2$s)</span>%3$s',
-            $name_link,
-            $item->ID(),
-            $this->row_actions($actions)
-        );
-    }
-
-
-    public function column_type($item)
-    {
-        return $this->_price_types[ $item->type() ]->name();
-    }
-
-
-    public function column_description($item)
-    {
-        return stripslashes($item->desc());
-    }
-
-
-    public function column_amount($item)
-    {
-        if ($this->_price_types[ $item->type() ]->is_percent()) {
-            return '<div class="pad-amnt-rght">' . number_format($item->amount(), 1) . '%</div>';
-        } else {
-            return '<div class="pad-amnt-rght">' . EEH_Template::format_currency($item->amount()) . '</div>';
-        }
-    }
+	private $_PRT;
+
+	/**
+	 * Array of price types.
+	 *
+	 * @var EE_Price_Type[]
+	 */
+	protected $_price_types = array();
+
+	public function __construct($admin_page)
+	{
+		parent::__construct($admin_page);
+		require_once(EE_MODELS . 'EEM_Price_Type.model.php');
+		$this->_PRT = EEM_Price_Type::instance();
+		$this->_price_types = $this->_PRT->get_all_deleted_and_undeleted();
+	}
+
+
+	protected function _setup_data()
+	{
+		$trashed = $this->_admin_page->get_view() == 'trashed' ? true : false;
+		$this->_data = $this->_admin_page->get_prices_overview_data($this->_per_page, false, $trashed);
+		$this->_all_data_count = $this->_admin_page->get_prices_overview_data($this->_per_page, true, false);
+		$this->_trashed_count = $this->_admin_page->get_prices_overview_data($this->_per_page, true, true);
+	}
+
+
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = array(
+			'singular' => __('price', 'event_espresso'),
+			'plural'   => __('prices', 'event_espresso'),
+			'ajax'     => true,
+			'screen'   => $this->_admin_page->get_current_screen()->id,
+		);
+
+		$this->_columns = array(
+			'cb'          => '<input type="checkbox" />', // Render a checkbox instead of text
+			'name'        => __('Name', 'event_espresso'),
+			'type'        => __('Price Type', 'event_espresso'),
+			'description' => __('Description', 'event_espresso'),
+			'amount'      => __('Amount', 'event_espresso'),
+		);
+
+		$this->_sortable_columns = array(
+			// true means its already sorted
+			'name'   => array('name' => false),
+			'type'   => array('type' => false),
+			'amount' => array('amount' => false),
+		);
+
+		$this->_hidden_columns = array();
+
+		$this->_ajax_sorting_callback = 'update_prices_order';
+	}
+
+
+	protected function _get_table_filters()
+	{
+	}
+
+
+	protected function _add_view_counts()
+	{
+		$this->_views['all']['count'] = $this->_all_data_count;
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_default_prices', 'pricing_trash_price')) {
+			$this->_views['trashed']['count'] = $this->_trashed_count;
+		}
+	}
+
+
+	/**
+	 * overriding parent method so that we can make sure the row isn't sortable for certain items
+	 *
+	 * @param  object $item the current item
+	 * @return string
+	 */
+	protected function _get_row_class($item)
+	{
+		static $row_class = '';
+		$row_class = ($row_class == '' ? 'alternate' : '');
+
+		$new_row = $row_class;
+
+		if ($item->type_obj()->base_type() !== 1 && $item->type_obj()->base_type() !== 4) {
+			$new_row .= ' rowsortable';
+		}
+
+		return ' class="' . $new_row . '"';
+	}
+
+
+	public function column_cb($item)
+	{
+		if ($item->type_obj()->base_type() !== 1) {
+			return sprintf(
+				'<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />',
+				$item->ID()
+			);
+		}
+		return '';
+	}
+
+
+	public function column_name($item)
+	{
+
+		// Build row actions
+		$actions = array();
+		// edit price link
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_default_price',
+			'pricing_edit_price',
+			$item->ID()
+		)) {
+			$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+				'action' => 'edit_price',
+				'id'     => $item->ID(),
+			), PRICING_ADMIN_URL);
+			$actions['edit'] = '<a href="' . $edit_lnk_url . '" title="'
+							   . esc_attr__('Edit Price', 'event_espresso') . '">'
+							   . __('Edit', 'event_espresso') . '</a>';
+		}
+
+		$name_link = EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_default_price',
+			'edit_price',
+			$item->ID()
+		)
+			? '<a href="' . $edit_lnk_url . '" title="'
+			  . esc_attr__('Edit Price', 'event_espresso') . '">'
+			  . stripslashes($item->name()) . '</a>'
+			: $item->name();
+
+		if ($item->type_obj()->base_type() !== 1) {
+			if ($this->_view == 'all') {
+				// trash price link
+				if (EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_default_price',
+					'pricing_trash_price',
+					$item->ID()
+				)) {
+					$trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+						'action'   => 'trash_price',
+						'id'       => $item->ID(),
+						'noheader' => true,
+					), PRICING_ADMIN_URL);
+					$actions['trash'] = '<a href="' . $trash_lnk_url . '" title="'
+										. esc_attr__('Move Price to Trash', 'event_espresso') . '">'
+										. __('Move to Trash', 'event_espresso') . '</a>';
+				}
+			} else {
+				if (EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_default_price',
+					'pricing_restore_price',
+					$item->ID()
+				)) {
+					// restore price link
+					$restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+						'action'   => 'restore_price',
+						'id'       => $item->ID(),
+						'noheader' => true,
+					), PRICING_ADMIN_URL);
+					$actions['restore'] = '<a href="' . $restore_lnk_url . '" title="'
+										  . esc_attr__('Restore Price', 'event_espresso') . '">'
+										  . __('Restore', 'event_espresso') . '</a>';
+				}
+
+				// delete price link
+				if (EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_default_price',
+					'pricing_delete_price',
+					$item->ID()
+				)) {
+					$delete_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+						'action'   => 'delete_price',
+						'id'       => $item->ID(),
+						'noheader' => true,
+					), PRICING_ADMIN_URL);
+					$actions['delete'] = '<a href="' . $delete_lnk_url . '" title="'
+										 . esc_attr__('Delete Price Permanently', 'event_espresso') . '">'
+										 . __('Delete Permanently', 'event_espresso') . '</a>';
+				}
+			}
+		}
+
+		// Return the name contents
+		return sprintf(
+			'%1$s <span style="color:silver">(id:%2$s)</span>%3$s',
+			$name_link,
+			$item->ID(),
+			$this->row_actions($actions)
+		);
+	}
+
+
+	public function column_type($item)
+	{
+		return $this->_price_types[ $item->type() ]->name();
+	}
+
+
+	public function column_description($item)
+	{
+		return stripslashes($item->desc());
+	}
+
+
+	public function column_amount($item)
+	{
+		if ($this->_price_types[ $item->type() ]->is_percent()) {
+			return '<div class="pad-amnt-rght">' . number_format($item->amount(), 1) . '%</div>';
+		} else {
+			return '<div class="pad-amnt-rght">' . EEH_Template::format_currency($item->amount()) . '</div>';
+		}
+	}
 }

Spacing +21 added lines, -21 removed lines

@@ -28,7 +28,7 @@ 
     public function __construct($admin_page)
     {
         parent::__construct($admin_page);
-        require_once(EE_MODELS . 'EEM_Price_Type.model.php');
+        require_once(EE_MODELS.'EEM_Price_Type.model.php');
         $this->_PRT = EEM_Price_Type::instance();
         $this->_price_types = $this->_PRT->get_all_deleted_and_undeleted();
     }
@@ -104,7 +104,7 @@ 
             $new_row .= ' rowsortable';
         }
 
-        return ' class="' . $new_row . '"';
+        return ' class="'.$new_row.'"';
     }
 
 
@@ -135,9 +135,9 @@ 
                 'action' => 'edit_price',
                 'id'     => $item->ID(),
             ), PRICING_ADMIN_URL);
-            $actions['edit'] = '<a href="' . $edit_lnk_url . '" title="'
-                               . esc_attr__('Edit Price', 'event_espresso') . '">'
-                               . __('Edit', 'event_espresso') . '</a>';
+            $actions['edit'] = '<a href="'.$edit_lnk_url.'" title="'
+                               . esc_attr__('Edit Price', 'event_espresso').'">'
+                               . __('Edit', 'event_espresso').'</a>';
         }
 
         $name_link = EE_Registry::instance()->CAP->current_user_can(
@@ -145,9 +145,9 @@ 
             'edit_price',
             $item->ID()
         )
-            ? '<a href="' . $edit_lnk_url . '" title="'
-              . esc_attr__('Edit Price', 'event_espresso') . '">'
-              . stripslashes($item->name()) . '</a>'
+            ? '<a href="'.$edit_lnk_url.'" title="'
+              . esc_attr__('Edit Price', 'event_espresso').'">'
+              . stripslashes($item->name()).'</a>'
             : $item->name();
 
         if ($item->type_obj()->base_type() !== 1) {
@@ -163,9 +163,9 @@ 
                         'id'       => $item->ID(),
                         'noheader' => true,
                     ), PRICING_ADMIN_URL);
-                    $actions['trash'] = '<a href="' . $trash_lnk_url . '" title="'
-                                        . esc_attr__('Move Price to Trash', 'event_espresso') . '">'
-                                        . __('Move to Trash', 'event_espresso') . '</a>';
+                    $actions['trash'] = '<a href="'.$trash_lnk_url.'" title="'
+                                        . esc_attr__('Move Price to Trash', 'event_espresso').'">'
+                                        . __('Move to Trash', 'event_espresso').'</a>';
                 }
             } else {
                 if (EE_Registry::instance()->CAP->current_user_can(
@@ -179,9 +179,9 @@ 
                         'id'       => $item->ID(),
                         'noheader' => true,
                     ), PRICING_ADMIN_URL);
-                    $actions['restore'] = '<a href="' . $restore_lnk_url . '" title="'
-                                          . esc_attr__('Restore Price', 'event_espresso') . '">'
-                                          . __('Restore', 'event_espresso') . '</a>';
+                    $actions['restore'] = '<a href="'.$restore_lnk_url.'" title="'
+                                          . esc_attr__('Restore Price', 'event_espresso').'">'
+                                          . __('Restore', 'event_espresso').'</a>';
                 }
 
                 // delete price link
@@ -195,9 +195,9 @@ 
                         'id'       => $item->ID(),
                         'noheader' => true,
                     ), PRICING_ADMIN_URL);
-                    $actions['delete'] = '<a href="' . $delete_lnk_url . '" title="'
-                                         . esc_attr__('Delete Price Permanently', 'event_espresso') . '">'
-                                         . __('Delete Permanently', 'event_espresso') . '</a>';
+                    $actions['delete'] = '<a href="'.$delete_lnk_url.'" title="'
+                                         . esc_attr__('Delete Price Permanently', 'event_espresso').'">'
+                                         . __('Delete Permanently', 'event_espresso').'</a>';
                 }
             }
         }
@@ -214,7 +214,7 @@ 
 
     public function column_type($item)
     {
-        return $this->_price_types[ $item->type() ]->name();
+        return $this->_price_types[$item->type()]->name();
     }
 
 
@@ -226,10 +226,10 @@ 
 
     public function column_amount($item)
     {
-        if ($this->_price_types[ $item->type() ]->is_percent()) {
-            return '<div class="pad-amnt-rght">' . number_format($item->amount(), 1) . '%</div>';
+        if ($this->_price_types[$item->type()]->is_percent()) {
+            return '<div class="pad-amnt-rght">'.number_format($item->amount(), 1).'%</div>';
         } else {
-            return '<div class="pad-amnt-rght">' . EEH_Template::format_currency($item->amount()) . '</div>';
+            return '<div class="pad-amnt-rght">'.EEH_Template::format_currency($item->amount()).'</div>';
         }
     }
 }

core/db_classes/EE_Taxes.class.php

Indentation +123 added lines, -123 removed lines

@@ -10,138 +10,138 @@
 class EE_Taxes extends EE_Base
 {
 
-    /**
-     * This is used for when EE_Taxes is used statically by the admin
-     *
-     * @var array
-     */
-    private static $_subtotal = array();
+	/**
+	 * This is used for when EE_Taxes is used statically by the admin
+	 *
+	 * @var array
+	 */
+	private static $_subtotal = array();
 
-    /**
-     * This holds an array of EE_Price objects that are of PRT_ID == 4 (tax price types)
-     *
-     * @var EE_Price[]
-     */
-    private static $_default_taxes = array();
+	/**
+	 * This holds an array of EE_Price objects that are of PRT_ID == 4 (tax price types)
+	 *
+	 * @var EE_Price[]
+	 */
+	private static $_default_taxes = array();
 
 
-    /**
-     * This method simply calculates the total taxes for a given ticket (by pulling the prices attached to the ticket
-     * and applying default taxes to it). Note: this is just an intermediary helper method added to facilitate quick
-     * calc of taxes for tickets listed in the event editor.
-     *
-     * @param  EE_Ticket $ticket incoming EE_Ticket
-     * @return float             total taxes to apply to ticket.
-     * @throws \EE_Error
-     */
-    public static function get_total_taxes_for_admin(EE_Ticket $ticket)
-    {
-        $tax = 0;
-        $total_tax = 0;
-        // This first checks to see if the given ticket is taxable.
-        if (! $ticket->get('TKT_taxable')) {
-            return $tax;
-        }
-        // get subtotal (notice we're only retrieving a subtotal if there isn't one given)
-        $subtotal = self::get_subtotal_for_admin($ticket);
-        // get taxes
-        $taxes = self::get_taxes_for_admin();
-        // apply taxes to subtotal
-        foreach ($taxes as $tax) {
-            // assuming taxes are not cumulative
-            $total_tax += $subtotal * $tax->get('PRC_amount') / 100;
-        }
-        return $total_tax;
-    }
+	/**
+	 * This method simply calculates the total taxes for a given ticket (by pulling the prices attached to the ticket
+	 * and applying default taxes to it). Note: this is just an intermediary helper method added to facilitate quick
+	 * calc of taxes for tickets listed in the event editor.
+	 *
+	 * @param  EE_Ticket $ticket incoming EE_Ticket
+	 * @return float             total taxes to apply to ticket.
+	 * @throws \EE_Error
+	 */
+	public static function get_total_taxes_for_admin(EE_Ticket $ticket)
+	{
+		$tax = 0;
+		$total_tax = 0;
+		// This first checks to see if the given ticket is taxable.
+		if (! $ticket->get('TKT_taxable')) {
+			return $tax;
+		}
+		// get subtotal (notice we're only retrieving a subtotal if there isn't one given)
+		$subtotal = self::get_subtotal_for_admin($ticket);
+		// get taxes
+		$taxes = self::get_taxes_for_admin();
+		// apply taxes to subtotal
+		foreach ($taxes as $tax) {
+			// assuming taxes are not cumulative
+			$total_tax += $subtotal * $tax->get('PRC_amount') / 100;
+		}
+		return $total_tax;
+	}
 
 
-    /**
-     * Gets the total percentage of tax that should be applied to taxable line items
-     *
-     * @return float the percentage of tax that should be added to taxable items
-     * @throws \EE_Error
-     * eg 20 for %20 tax (NOT 0.20, which
-     */
-    public static function get_total_taxes_percentage()
-    {
-        $total_tax_percent = 0;
-        foreach (self::get_taxes_for_admin() as $tax_price) {
-            $total_tax_percent += $tax_price->get('PRC_amount');
-        }
-        return $total_tax_percent;
-    }
+	/**
+	 * Gets the total percentage of tax that should be applied to taxable line items
+	 *
+	 * @return float the percentage of tax that should be added to taxable items
+	 * @throws \EE_Error
+	 * eg 20 for %20 tax (NOT 0.20, which
+	 */
+	public static function get_total_taxes_percentage()
+	{
+		$total_tax_percent = 0;
+		foreach (self::get_taxes_for_admin() as $tax_price) {
+			$total_tax_percent += $tax_price->get('PRC_amount');
+		}
+		return $total_tax_percent;
+	}
 
 
-    /**
-     * @param EE_Ticket $ticket
-     * @return float
-     * @throws \EE_Error
-     */
-    public static function get_subtotal_for_admin(EE_Ticket $ticket)
-    {
-        $TKT_ID = $ticket->ID();
-        return isset(self::$_subtotal[ $TKT_ID ])
-            ? self::$_subtotal[ $TKT_ID ]
-            : self::_get_subtotal_for_admin($ticket);
-    }
+	/**
+	 * @param EE_Ticket $ticket
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public static function get_subtotal_for_admin(EE_Ticket $ticket)
+	{
+		$TKT_ID = $ticket->ID();
+		return isset(self::$_subtotal[ $TKT_ID ])
+			? self::$_subtotal[ $TKT_ID ]
+			: self::_get_subtotal_for_admin($ticket);
+	}
 
 
-    /**
-     * simply take an incoming ticket and calculate the subtotal for the ticket
-     *
-     * @param  EE_Ticket $ticket
-     * @return float     subtotal calculated from all EE_Price[] on Ticket.
-     * @throws \EE_Error
-     */
-    private static function _get_subtotal_for_admin(EE_Ticket $ticket)
-    {
-        $subtotal = 0;
-        // get all prices
-        $prices = $ticket->get_many_related(
-            'Price',
-            array(
-                'default_where_conditions' => 'none',
-                'order_by'                 => array('PRC_order' => 'ASC'),
-            )
-        );
-        // let's loop through them (base price is always the first item)
-        foreach ($prices as $price) {
-            if ($price instanceof EE_Price) {
-                $price_type = $price->type_obj();
-                if ($price_type instanceof EE_Price_Type) {
-                    switch ($price->type_obj()->base_type()) {
-                        case 1: // base price
-                        case 3: // surcharges
-                            $subtotal += $price->is_percent() ? $subtotal * $price->get('PRC_amount') / 100
-                                : $price->get('PRC_amount');
-                            break;
-                        case 2: // discounts
-                            $subtotal -= $price->is_percent() ? $subtotal * $price->get('PRC_amount') / 100
-                                : $price->get('PRC_amount');
-                            break;
-                    }
-                }
-            }
-        }
-        $TKT_ID = $ticket->ID();
-        self::$_subtotal = array($TKT_ID => $subtotal);
-        return $subtotal;
-    }
+	/**
+	 * simply take an incoming ticket and calculate the subtotal for the ticket
+	 *
+	 * @param  EE_Ticket $ticket
+	 * @return float     subtotal calculated from all EE_Price[] on Ticket.
+	 * @throws \EE_Error
+	 */
+	private static function _get_subtotal_for_admin(EE_Ticket $ticket)
+	{
+		$subtotal = 0;
+		// get all prices
+		$prices = $ticket->get_many_related(
+			'Price',
+			array(
+				'default_where_conditions' => 'none',
+				'order_by'                 => array('PRC_order' => 'ASC'),
+			)
+		);
+		// let's loop through them (base price is always the first item)
+		foreach ($prices as $price) {
+			if ($price instanceof EE_Price) {
+				$price_type = $price->type_obj();
+				if ($price_type instanceof EE_Price_Type) {
+					switch ($price->type_obj()->base_type()) {
+						case 1: // base price
+						case 3: // surcharges
+							$subtotal += $price->is_percent() ? $subtotal * $price->get('PRC_amount') / 100
+								: $price->get('PRC_amount');
+							break;
+						case 2: // discounts
+							$subtotal -= $price->is_percent() ? $subtotal * $price->get('PRC_amount') / 100
+								: $price->get('PRC_amount');
+							break;
+					}
+				}
+			}
+		}
+		$TKT_ID = $ticket->ID();
+		self::$_subtotal = array($TKT_ID => $subtotal);
+		return $subtotal;
+	}
 
 
-    /**
-     * get all default prices that are a Tax price type (PRT_ID = 4) and return
-     *
-     * @return EE_Price[] EE_Price objects that have PRT_ID == 4
-     * @throws \EE_Error
-     */
-    public static function get_taxes_for_admin()
-    {
-        if (empty(self::$_default_taxes)) {
-            self::$_default_taxes = EE_Registry::instance()->load_model('Price')->get_all(
-                array(array('Price_Type.PBT_ID' => 4))
-            );
-        }
-        return self::$_default_taxes;
-    }
+	/**
+	 * get all default prices that are a Tax price type (PRT_ID = 4) and return
+	 *
+	 * @return EE_Price[] EE_Price objects that have PRT_ID == 4
+	 * @throws \EE_Error
+	 */
+	public static function get_taxes_for_admin()
+	{
+		if (empty(self::$_default_taxes)) {
+			self::$_default_taxes = EE_Registry::instance()->load_model('Price')->get_all(
+				array(array('Price_Type.PBT_ID' => 4))
+			);
+		}
+		return self::$_default_taxes;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -39,7 +39,7 @@ 
         $tax = 0;
         $total_tax = 0;
         // This first checks to see if the given ticket is taxable.
-        if (! $ticket->get('TKT_taxable')) {
+        if ( ! $ticket->get('TKT_taxable')) {
             return $tax;
         }
         // get subtotal (notice we're only retrieving a subtotal if there isn't one given)
@@ -80,8 +80,8 @@ 
     public static function get_subtotal_for_admin(EE_Ticket $ticket)
     {
         $TKT_ID = $ticket->ID();
-        return isset(self::$_subtotal[ $TKT_ID ])
-            ? self::$_subtotal[ $TKT_ID ]
+        return isset(self::$_subtotal[$TKT_ID])
+            ? self::$_subtotal[$TKT_ID]
             : self::_get_subtotal_for_admin($ticket);
     }