eventespresso / event-espresso-core

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

Indentation +84 added lines, -84 removed lines

@@ -15,96 +15,96 @@
 class Pricing_Add_New_Default_Price_Help_Tour extends EE_Help_Tour
 {
 
-    protected function _set_tour_properties()
-    {
-        $this->_label = __('Add New Default Price Tour', 'event_espresso');
-        $this->_slug = 'add-new-default-price-joyride';
-    }
+	protected function _set_tour_properties()
+	{
+		$this->_label = __('Add New Default Price Tour', 'event_espresso');
+		$this->_slug = 'add-new-default-price-joyride';
+	}
 
 
-    protected function _set_tour_stops()
-    {
-        $this->_stops = array(
-            10 => array(
-                'content' => $this->_start(),
-            ),
-            20 => array(
-                'id'      => 'PRT_ID',
-                'content' => $this->_price_type_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentY' => -50,
-                    'tipAdjustmentX' => -15,
-                ),
-            ),
-            30 => array(
-                'id'      => 'PRC_name',
-                'content' => $this->_price_name_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentY' => -40,
-                ),
-            ),
-            40 => array(
-                'id'      => 'PRC_desc',
-                'content' => $this->_price_description_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentY' => -40,
-                ),
-            ),
-            50 => array(
-                'id'      => 'PRC_amount',
-                'content' => $this->_price_amount_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentY' => -40,
-                ),
-            ),
-        );
-    }
+	protected function _set_tour_stops()
+	{
+		$this->_stops = array(
+			10 => array(
+				'content' => $this->_start(),
+			),
+			20 => array(
+				'id'      => 'PRT_ID',
+				'content' => $this->_price_type_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentY' => -50,
+					'tipAdjustmentX' => -15,
+				),
+			),
+			30 => array(
+				'id'      => 'PRC_name',
+				'content' => $this->_price_name_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentY' => -40,
+				),
+			),
+			40 => array(
+				'id'      => 'PRC_desc',
+				'content' => $this->_price_description_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentY' => -40,
+				),
+			),
+			50 => array(
+				'id'      => 'PRC_amount',
+				'content' => $this->_price_amount_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentY' => -40,
+				),
+			),
+		);
+	}
 
 
-    protected function _start()
-    {
-        $content = '<h3>' . __('Add New Default Price', 'event_espresso') . '</h3>';
-        $content .= '<p>'
-                    . __(
-                        'This tour of the add new default price 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>' . __('Add New Default Price', 'event_espresso') . '</h3>';
+		$content .= '<p>'
+					. __(
+						'This tour of the add new default price 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 _price_type_stop()
-    {
-        return '<p>'
-               . __(
-                   'Price Types are a way of categorizing a price, discount, tax, or surcharge and indicating how it gets applied to a running total when a transaction occurs.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _price_type_stop()
+	{
+		return '<p>'
+			   . __(
+				   'Price Types are a way of categorizing a price, discount, tax, or surcharge and indicating how it gets applied to a running total when a transaction occurs.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _price_name_stop()
-    {
-        return '<p>'
-               . __(
-                   'The name of the price, discount, tax, or surcharge that will be seen by your customers.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _price_name_stop()
+	{
+		return '<p>'
+			   . __(
+				   'The name of the price, discount, tax, or surcharge that will be seen by your customers.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _price_description_stop()
-    {
-        return '<p>'
-               . __(
-                   'View the price type (price, discount, tax or surcharge) description.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _price_description_stop()
+	{
+		return '<p>'
+			   . __(
+				   'View the price type (price, discount, tax or surcharge) description.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _price_amount_stop()
-    {
-        return '<p>' . __('The ticket amount before any deductions.', 'event_espresso') . '</p>';
-    }
+	protected function _price_amount_stop()
+	{
+		return '<p>' . __('The ticket amount before any deductions.', 'event_espresso') . '</p>';
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -67,12 +67,12 @@ 
 
     protected function _start()
     {
-        $content = '<h3>' . __('Add New Default Price', 'event_espresso') . '</h3>';
+        $content = '<h3>'.__('Add New Default Price', 'event_espresso').'</h3>';
         $content .= '<p>'
                     . __(
                         'This tour of the add new default price page will go over different areas of the screen to help you understand what they are used for.',
                         'event_espresso'
-                    ) . '</p>';
+                    ).'</p>';
         return $content;
     }
 
@@ -82,7 +82,7 @@ 
                . __(
                    'Price Types are a way of categorizing a price, discount, tax, or surcharge and indicating how it gets applied to a running total when a transaction occurs.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _price_name_stop()
@@ -91,7 +91,7 @@ 
                . __(
                    'The name of the price, discount, tax, or surcharge that will be seen by your customers.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _price_description_stop()
@@ -100,11 +100,11 @@ 
                . __(
                    'View the price type (price, discount, tax or surcharge) description.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _price_amount_stop()
     {
-        return '<p>' . __('The ticket amount before any deductions.', 'event_espresso') . '</p>';
+        return '<p>'.__('The ticket amount before any deductions.', 'event_espresso').'</p>';
     }
 }

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

Indentation +121 added lines, -121 removed lines

@@ -15,135 +15,135 @@
 class Pricing_Default_Prices_Help_Tour extends EE_Help_Tour
 {
 
-    protected function _set_tour_properties()
-    {
-        $this->_label = __('Default Pricing Tour', 'event_espresso');
-        $this->_slug = 'default-prices-joyride';
-    }
+	protected function _set_tour_properties()
+	{
+		$this->_label = __('Default Pricing Tour', 'event_espresso');
+		$this->_slug = 'default-prices-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'      => 'type',
-                'content' => $this->_type_column_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => 5,
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            40 => array(
-                'id'      => 'description',
-                'content' => $this->_description_column_stop(),
-                'options' => array(
-                    'tipLocation'    => 'top',
-                    'tipAdjustmentX' => 5,
-                    'tipAdjustmentY' => -30,
-                ),
-            ),
-            50 => array(
-                'id'      => 'amount',
-                'content' => $this->_amount_column_stop(),
-                'options' => array(
-                    'tipLocation'    => 'left',
-                    'tipAdjustmentY' => -50,
-                    'tipAdjustmentX' => 20,
-                ),
-            ),
-            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'      => 'type',
+				'content' => $this->_type_column_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => 5,
+					'tipAdjustmentY' => -30,
+				),
+			),
+			40 => array(
+				'id'      => 'description',
+				'content' => $this->_description_column_stop(),
+				'options' => array(
+					'tipLocation'    => 'top',
+					'tipAdjustmentX' => 5,
+					'tipAdjustmentY' => -30,
+				),
+			),
+			50 => array(
+				'id'      => 'amount',
+				'content' => $this->_amount_column_stop(),
+				'options' => array(
+					'tipLocation'    => 'left',
+					'tipAdjustmentY' => -50,
+					'tipAdjustmentX' => 20,
+				),
+			),
+			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>' . __('Default Pricing', 'event_espresso') . '</h3>';
-        $content .= '<p>'
-                    . __(
-                        'This tour of the Default Pricing 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>' . __('Default Pricing', 'event_espresso') . '</h3>';
+		$content .= '<p>'
+					. __(
+						'This tour of the Default Pricing 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, discount, tax, or surcharge that will be seen by your customers. Can be sorted in ascending or descending order.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _name_column_stop()
+	{
+		return '<p>'
+			   . __(
+				   'The name of the price, discount, tax, or surcharge that will be seen by your customers. Can be sorted in ascending or descending order.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _type_column_stop()
-    {
-        return '<p>'
-               . __(
-                   'Price Types are a way of categorizing a price, discount, tax, or surcharge and indicating how it gets applied to a running total when a transaction occurs. Can be sorted in ascending or descending order.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _type_column_stop()
+	{
+		return '<p>'
+			   . __(
+				   'Price Types are a way of categorizing a price, discount, tax, or surcharge and indicating how it gets applied to a running total when a transaction occurs. Can be sorted in ascending or descending order.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _description_column_stop()
-    {
-        return '<p>'
-               . __(
-                   'View the price type (price, discount, tax or surcharge) description.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _description_column_stop()
+	{
+		return '<p>'
+			   . __(
+				   'View the price type (price, discount, tax or surcharge) description.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 
-    protected function _amount_column_stop()
-    {
-        return '<p>'
-               . __(
-                   'The ticket amount before any deductions. Can be sorted in ascending or descending order.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _amount_column_stop()
+	{
+		return '<p>'
+			   . __(
+				   'The ticket amount before any deductions. Can be sorted in ascending or descending order.',
+				   '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 default pricing. The following sources will be searched: Price Name, Price Type, Price Description, and Price Amount.',
-                   'event_espresso'
-               ) . '</p>';
-    }
+	protected function _search_stop()
+	{
+		return '<p>'
+			   . __(
+				   'Search through default pricing. The following sources will be searched: Price Name, Price Type, Price Description, and Price Amount.',
+				   'event_espresso'
+			   ) . '</p>';
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -88,12 +88,12 @@ 
 
     protected function _start()
     {
-        $content = '<h3>' . __('Default Pricing', 'event_espresso') . '</h3>';
+        $content = '<h3>'.__('Default Pricing', 'event_espresso').'</h3>';
         $content .= '<p>'
                     . __(
                         'This tour of the Default Pricing 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,7 +103,7 @@ 
                . __(
                    'The name of the price, discount, tax, or surcharge that will be seen by your customers. Can be sorted in ascending or descending order.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _type_column_stop()
@@ -112,7 +112,7 @@ 
                . __(
                    'Price Types are a way of categorizing a price, discount, tax, or surcharge and indicating how it gets applied to a running total when a transaction occurs. Can be sorted in ascending or descending order.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _description_column_stop()
@@ -121,7 +121,7 @@ 
                . __(
                    'View the price type (price, discount, tax or surcharge) description.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 
     protected function _amount_column_stop()
@@ -130,12 +130,12 @@ 
                . __(
                    'The ticket amount before any deductions. Can be sorted in ascending or descending order.',
                    '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()
@@ -144,6 +144,6 @@ 
                . __(
                    'Search through default pricing. The following sources will be searched: Price Name, Price Type, Price Description, and Price Amount.',
                    'event_espresso'
-               ) . '</p>';
+               ).'</p>';
     }
 }

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);

admin_pages/registration_form/espresso_events_Registration_Form_Hooks.class.php

Doc Comments +1 added lines, -1 removed lines

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

Spacing +7 added lines, -7 removed lines

@@ -135,7 +135,7 @@ 
                 : array();
             $EQGids = array_keys($EQGs);
 
-            if (! empty($QSGs)) {
+            if ( ! empty($QSGs)) {
                 $html = count($QSGs) > 10 ? '<div style="height:250px;overflow:auto;">' : '';
                 foreach ($QSGs as $QSG) {
                     $checked = in_array($QSG->ID(), $EQGids, true)
@@ -155,16 +155,16 @@ 
                     );
 
                     $html .= '
-					<p id="event-question-group-' . $QSG->ID() . '">
-						<input value="' . $QSG->ID() . '" type="checkbox"'
+					<p id="event-question-group-' . $QSG->ID().'">
+						<input value="' . $QSG->ID().'" type="checkbox"'
                              . $visibility
-                             . ' name="question_groups[' . $QSG->ID() . ']"' . $checked . ' />
-						<a href="' . $edit_link . '" title="'
+                             . ' name="question_groups['.$QSG->ID().']"'.$checked.' />
+						<a href="' . $edit_link.'" title="'
                              . sprintf(
                                  esc_attr__('Edit %s Group', 'event_espresso'),
                                  $QSG->get('QSG_name')
                              )
-                             . '" target="_blank">' . $QSG->get('QSG_name') . '</a>
+                             . '" target="_blank">'.$QSG->get('QSG_name').'</a>
 					</p>';
                 }
                 $html .= count($QSGs) > 10 ? '</div>' : '';
@@ -203,7 +203,7 @@ 
         $current_qgs = array_keys($current_qgs); // we just want the ids
 
         // now let's get the groups selected in the editor and update (IF we have data)
-        if (! empty($question_groups)) {
+        if ( ! empty($question_groups)) {
             foreach ($question_groups as $id => $val) {
                 // add to event
                 if ($val) {

Indentation +192 added lines, -192 removed lines

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

core/business/EE_Transaction_Payments.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -137,7 +137,7 @@
      * @param EE_Transaction $transaction
      * @param string         $payment_status One of EEM_Payment's statuses, like 'PAP' (Approved).
      *                                       By default, searches for approved payments
-     * @return float|false   float on success, false on fail
+     * @return double   float on success, false on fail
      * @throws \EE_Error
      */
     public function recalculate_total_payments_for_transaction(

Indentation +419 added lines, -419 removed lines

@@ -16,423 +16,423 @@
 class EE_Transaction_Payments
 {
 
-    /**
-     * @var EE_Transaction_Payments $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-    /**
-     * @deprecated
-     * @var string
-     */
-    protected $_old_txn_status;
-
-    /**
-     * @deprecated
-     * @var string
-     */
-    protected $_new_txn_status;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EE_Transaction_Payments instance
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Transaction_Payments) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * recalculate_transaction_total
-     *
-     * @access private
-     * @param EE_Transaction $transaction
-     * @param bool           $update_txn
-     * @return bool true if TXN total was updated, false if not
-     * @throws \EE_Error
-     */
-    public function recalculate_transaction_total(EE_Transaction $transaction, $update_txn = true)
-    {
-        $total_line_item = $transaction->total_line_item();
-        if (! $total_line_item instanceof EE_Line_Item) {
-            EE_Error::add_error(
-                sprintf(
-                    __('The Total Line Item for Transaction %1$d\'s was not found or is invalid.', 'event_espresso'),
-                    $transaction->ID()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $new_total = $total_line_item->recalculate_total_including_taxes();
-        $transaction->set_total($new_total);
-        if ($update_txn) {
-            return $transaction->save() ? true : false;
-        }
-        return false;
-    }
-
-
-    /**
-     * Updates the provided EE_Transaction with all the applicable payments
-     * returns a boolean for whether the TXN was saved to the db
-     * (meaning a status change occurred)
-     * or not saved (which could **still** mean that
-     * the TXN status changed, but just was not yet saved).
-     * So if passing a value of false for the $update_txn param,
-     * then client code needs to take responsibility for saving the TXN
-     * regardless of what happens within EE_Transaction_Payments;
-     *
-     * @param            EE_Transaction /int $transaction_obj_or_id EE_Transaction or its ID
-     * @param    boolean $update_txn whether to save the TXN
-     * @return    boolean        whether the TXN was saved
-     * @throws \EE_Error
-     */
-    public function calculate_total_payments_and_update_status(EE_Transaction $transaction, $update_txn = true)
-    {
-        // verify transaction
-        if (! $transaction instanceof EE_Transaction) {
-            EE_Error::add_error(
-                __('Please provide a valid EE_Transaction object.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // calculate total paid
-        $total_paid = $this->recalculate_total_payments_for_transaction($transaction);
-        // if total paid has changed
-        if ($total_paid !== false && (float) $total_paid !== $transaction->paid()) {
-            $transaction->set_paid($total_paid);
-            // maybe update status, and make sure to save transaction if not done already
-            if (! $transaction->update_status_based_on_total_paid($update_txn)) {
-                if ($update_txn) {
-                    return $transaction->save() ? true : false;
-                }
-            } else {
-                // the status got updated and was saved by
-                // update_transaction_status_based_on_total_paid()
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * recalculate_total_payments_for_transaction
-     *
-     * @access public
-     * @param EE_Transaction $transaction
-     * @param string         $payment_status One of EEM_Payment's statuses, like 'PAP' (Approved).
-     *                                       By default, searches for approved payments
-     * @return float|false   float on success, false on fail
-     * @throws \EE_Error
-     */
-    public function recalculate_total_payments_for_transaction(
-        EE_Transaction $transaction,
-        $payment_status = EEM_Payment::status_id_approved
-    ) {
-        // verify transaction
-        if (! $transaction instanceof EE_Transaction) {
-            EE_Error::add_error(
-                __('Please provide a valid EE_Transaction object.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // ensure Payment model is loaded
-        EE_Registry::instance()->load_model('Payment');
-        // calls EEM_Base::sum()
-        return EEM_Payment::instance()->sum(
-            // query params
-            array(array('TXN_ID' => $transaction->ID(), 'STS_ID' => $payment_status)),
-            // field to sum
-            'PAY_amount'
-        );
-    }
-
-
-    /**
-     * delete_payment_and_update_transaction
-     * Before deleting the selected payment, we fetch it's transaction,
-     * then delete the payment, and update the transactions' amount paid.
-     *
-     * @param EE_Payment $payment
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function delete_payment_and_update_transaction(EE_Payment $payment)
-    {
-        // verify payment
-        if (! $payment instanceof EE_Payment) {
-            EE_Error::add_error(
-                __('A valid Payment object was not received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        if (! $this->delete_registration_payments_and_update_registrations($payment)) {
-            return false;
-        }
-        if (! $payment->delete()) {
-            EE_Error::add_error(
-                __('The payment could not be deleted.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-
-        $transaction = $payment->transaction();
-        $TXN_status = $transaction->status_ID();
-        if ($TXN_status === EEM_Transaction::abandoned_status_code
-            || $TXN_status === EEM_Transaction::failed_status_code
-            || $payment->amount() === 0
-        ) {
-            EE_Error::add_success(__('The Payment was successfully deleted.', 'event_espresso'));
-            return true;
-        }
-
-
-        // if this fails, that just means that the transaction didn't get its status changed and/or updated.
-        // however the payment was still deleted.
-        if (! $this->calculate_total_payments_and_update_status($transaction)) {
-            EE_Error::add_attention(
-                __(
-                    'It appears that the Payment was deleted but no change was recorded for the Transaction for an unknown reason. Please verify that all data for this Transaction looks correct..',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return true;
-        }
-
-        EE_Error::add_success(
-            __(
-                'The Payment was successfully deleted, and the Transaction has been updated accordingly.',
-                'event_espresso'
-            )
-        );
-        return true;
-    }
-
-
-    /**
-     * delete_registration_payments_and_update_registrations
-     *
-     * removes all registration payment records associated with a payment
-     * and subtracts their amounts from the corresponding registrations REG_paid field
-     *
-     * @param EE_Payment $payment
-     * @param array      $reg_payment_query_params
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function delete_registration_payments_and_update_registrations(
-        EE_Payment $payment,
-        $reg_payment_query_params = array()
-    ) {
-        $save_payment = false;
-        $reg_payment_query_params = ! empty($reg_payment_query_params) ? $reg_payment_query_params
-            : array(array('PAY_ID' => $payment->ID()));
-        $registration_payments = EEM_Registration_Payment::instance()->get_all($reg_payment_query_params);
-        if (! empty($registration_payments)) {
-            foreach ($registration_payments as $registration_payment) {
-                if ($registration_payment instanceof EE_Registration_Payment) {
-                    $amount_paid = $registration_payment->amount();
-                    $registration = $registration_payment->registration();
-                    if ($registration instanceof EE_Registration) {
-                        $registration->set_paid($registration->paid() - $amount_paid);
-                        if ($registration->save() !== false) {
-                            $registration_payment->delete_permanently();
-                            $save_payment = true;
-                        }
-                    } else {
-                        EE_Error::add_error(
-                            sprintf(
-                                __(
-                                    'An invalid Registration object was associated with Registration Payment ID# %1$d.',
-                                    'event_espresso'
-                                ),
-                                $registration_payment->ID()
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                        return false;
-                    }
-                } else {
-                    EE_Error::add_error(
-                        sprintf(
-                            __(
-                                'An invalid Registration Payment object was associated with payment ID# %1$d.',
-                                'event_espresso'
-                            ),
-                            $payment->ID()
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                }
-            }
-        }
-        if ($save_payment) {
-            $payment->save();
-        }
-        return true;
-    }
-
-
-
-    /********************************** DEPRECATED METHODS **********************************/
-
-
-    /**
-     * possibly toggles TXN status
-     *
-     * @deprecated 4.9.1
-     * @param EE_Transaction $transaction
-     * @param    boolean     $update_txn whether to save the TXN
-     * @return    boolean        whether the TXN was saved
-     * @throws \EE_Error
-     */
-    public function update_transaction_status_based_on_total_paid(EE_Transaction $transaction, $update_txn = true)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            sprintf(
-                __('This method is deprecated. Please use "%s" instead', 'event_espresso'),
-                'EE_Transaction::update_status_based_on_total_paid()'
-            ),
-            '4.9.1',
-            '5.0.0'
-        );
-        // verify transaction
-        if (! $transaction instanceof EE_Transaction) {
-            EE_Error::add_error(
-                __('Please provide a valid EE_Transaction object.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // set transaction status based on comparison of TXN_paid vs TXN_total
-        return $transaction->update_status_based_on_total_paid($update_txn);
-    }
-
-
-    /**
-     * @deprecated 4.9.12
-     * @return string
-     */
-    public function old_txn_status()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::old_txn_status(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        return $this->_old_txn_status;
-    }
-
-
-    /**
-     * @deprecated 4.9.12
-     * @param string $old_txn_status
-     */
-    public function set_old_txn_status($old_txn_status)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::set_old_txn_status(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        // only set the first time
-        if ($this->_old_txn_status === null) {
-            $this->_old_txn_status = $old_txn_status;
-        }
-    }
-
-
-    /**
-     * @deprecated 4.9.12
-     * @return string
-     */
-    public function new_txn_status()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been removed. Please just use \EE_Transaction::status_ID() instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        return $this->_new_txn_status;
-    }
-
-
-    /**
-     * @deprecated 4.9.12
-     * @param string $new_txn_status
-     */
-    public function set_new_txn_status($new_txn_status)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been removed. Please just use \EE_Transaction::set_status() instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        $this->_new_txn_status = $new_txn_status;
-    }
-
-
-    /**
-     * @deprecated 4.9.12
-     * @return bool
-     */
-    public function txn_status_updated()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::txn_status_updated(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        return $this->_new_txn_status !== $this->_old_txn_status && $this->_old_txn_status !== null ? true : false;
-    }
+	/**
+	 * @var EE_Transaction_Payments $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+	/**
+	 * @deprecated
+	 * @var string
+	 */
+	protected $_old_txn_status;
+
+	/**
+	 * @deprecated
+	 * @var string
+	 */
+	protected $_new_txn_status;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EE_Transaction_Payments instance
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Transaction_Payments) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * recalculate_transaction_total
+	 *
+	 * @access private
+	 * @param EE_Transaction $transaction
+	 * @param bool           $update_txn
+	 * @return bool true if TXN total was updated, false if not
+	 * @throws \EE_Error
+	 */
+	public function recalculate_transaction_total(EE_Transaction $transaction, $update_txn = true)
+	{
+		$total_line_item = $transaction->total_line_item();
+		if (! $total_line_item instanceof EE_Line_Item) {
+			EE_Error::add_error(
+				sprintf(
+					__('The Total Line Item for Transaction %1$d\'s was not found or is invalid.', 'event_espresso'),
+					$transaction->ID()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$new_total = $total_line_item->recalculate_total_including_taxes();
+		$transaction->set_total($new_total);
+		if ($update_txn) {
+			return $transaction->save() ? true : false;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Updates the provided EE_Transaction with all the applicable payments
+	 * returns a boolean for whether the TXN was saved to the db
+	 * (meaning a status change occurred)
+	 * or not saved (which could **still** mean that
+	 * the TXN status changed, but just was not yet saved).
+	 * So if passing a value of false for the $update_txn param,
+	 * then client code needs to take responsibility for saving the TXN
+	 * regardless of what happens within EE_Transaction_Payments;
+	 *
+	 * @param            EE_Transaction /int $transaction_obj_or_id EE_Transaction or its ID
+	 * @param    boolean $update_txn whether to save the TXN
+	 * @return    boolean        whether the TXN was saved
+	 * @throws \EE_Error
+	 */
+	public function calculate_total_payments_and_update_status(EE_Transaction $transaction, $update_txn = true)
+	{
+		// verify transaction
+		if (! $transaction instanceof EE_Transaction) {
+			EE_Error::add_error(
+				__('Please provide a valid EE_Transaction object.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// calculate total paid
+		$total_paid = $this->recalculate_total_payments_for_transaction($transaction);
+		// if total paid has changed
+		if ($total_paid !== false && (float) $total_paid !== $transaction->paid()) {
+			$transaction->set_paid($total_paid);
+			// maybe update status, and make sure to save transaction if not done already
+			if (! $transaction->update_status_based_on_total_paid($update_txn)) {
+				if ($update_txn) {
+					return $transaction->save() ? true : false;
+				}
+			} else {
+				// the status got updated and was saved by
+				// update_transaction_status_based_on_total_paid()
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * recalculate_total_payments_for_transaction
+	 *
+	 * @access public
+	 * @param EE_Transaction $transaction
+	 * @param string         $payment_status One of EEM_Payment's statuses, like 'PAP' (Approved).
+	 *                                       By default, searches for approved payments
+	 * @return float|false   float on success, false on fail
+	 * @throws \EE_Error
+	 */
+	public function recalculate_total_payments_for_transaction(
+		EE_Transaction $transaction,
+		$payment_status = EEM_Payment::status_id_approved
+	) {
+		// verify transaction
+		if (! $transaction instanceof EE_Transaction) {
+			EE_Error::add_error(
+				__('Please provide a valid EE_Transaction object.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// ensure Payment model is loaded
+		EE_Registry::instance()->load_model('Payment');
+		// calls EEM_Base::sum()
+		return EEM_Payment::instance()->sum(
+			// query params
+			array(array('TXN_ID' => $transaction->ID(), 'STS_ID' => $payment_status)),
+			// field to sum
+			'PAY_amount'
+		);
+	}
+
+
+	/**
+	 * delete_payment_and_update_transaction
+	 * Before deleting the selected payment, we fetch it's transaction,
+	 * then delete the payment, and update the transactions' amount paid.
+	 *
+	 * @param EE_Payment $payment
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function delete_payment_and_update_transaction(EE_Payment $payment)
+	{
+		// verify payment
+		if (! $payment instanceof EE_Payment) {
+			EE_Error::add_error(
+				__('A valid Payment object was not received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		if (! $this->delete_registration_payments_and_update_registrations($payment)) {
+			return false;
+		}
+		if (! $payment->delete()) {
+			EE_Error::add_error(
+				__('The payment could not be deleted.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+
+		$transaction = $payment->transaction();
+		$TXN_status = $transaction->status_ID();
+		if ($TXN_status === EEM_Transaction::abandoned_status_code
+			|| $TXN_status === EEM_Transaction::failed_status_code
+			|| $payment->amount() === 0
+		) {
+			EE_Error::add_success(__('The Payment was successfully deleted.', 'event_espresso'));
+			return true;
+		}
+
+
+		// if this fails, that just means that the transaction didn't get its status changed and/or updated.
+		// however the payment was still deleted.
+		if (! $this->calculate_total_payments_and_update_status($transaction)) {
+			EE_Error::add_attention(
+				__(
+					'It appears that the Payment was deleted but no change was recorded for the Transaction for an unknown reason. Please verify that all data for this Transaction looks correct..',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return true;
+		}
+
+		EE_Error::add_success(
+			__(
+				'The Payment was successfully deleted, and the Transaction has been updated accordingly.',
+				'event_espresso'
+			)
+		);
+		return true;
+	}
+
+
+	/**
+	 * delete_registration_payments_and_update_registrations
+	 *
+	 * removes all registration payment records associated with a payment
+	 * and subtracts their amounts from the corresponding registrations REG_paid field
+	 *
+	 * @param EE_Payment $payment
+	 * @param array      $reg_payment_query_params
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function delete_registration_payments_and_update_registrations(
+		EE_Payment $payment,
+		$reg_payment_query_params = array()
+	) {
+		$save_payment = false;
+		$reg_payment_query_params = ! empty($reg_payment_query_params) ? $reg_payment_query_params
+			: array(array('PAY_ID' => $payment->ID()));
+		$registration_payments = EEM_Registration_Payment::instance()->get_all($reg_payment_query_params);
+		if (! empty($registration_payments)) {
+			foreach ($registration_payments as $registration_payment) {
+				if ($registration_payment instanceof EE_Registration_Payment) {
+					$amount_paid = $registration_payment->amount();
+					$registration = $registration_payment->registration();
+					if ($registration instanceof EE_Registration) {
+						$registration->set_paid($registration->paid() - $amount_paid);
+						if ($registration->save() !== false) {
+							$registration_payment->delete_permanently();
+							$save_payment = true;
+						}
+					} else {
+						EE_Error::add_error(
+							sprintf(
+								__(
+									'An invalid Registration object was associated with Registration Payment ID# %1$d.',
+									'event_espresso'
+								),
+								$registration_payment->ID()
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+						return false;
+					}
+				} else {
+					EE_Error::add_error(
+						sprintf(
+							__(
+								'An invalid Registration Payment object was associated with payment ID# %1$d.',
+								'event_espresso'
+							),
+							$payment->ID()
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+				}
+			}
+		}
+		if ($save_payment) {
+			$payment->save();
+		}
+		return true;
+	}
+
+
+
+	/********************************** DEPRECATED METHODS **********************************/
+
+
+	/**
+	 * possibly toggles TXN status
+	 *
+	 * @deprecated 4.9.1
+	 * @param EE_Transaction $transaction
+	 * @param    boolean     $update_txn whether to save the TXN
+	 * @return    boolean        whether the TXN was saved
+	 * @throws \EE_Error
+	 */
+	public function update_transaction_status_based_on_total_paid(EE_Transaction $transaction, $update_txn = true)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			sprintf(
+				__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
+				'EE_Transaction::update_status_based_on_total_paid()'
+			),
+			'4.9.1',
+			'5.0.0'
+		);
+		// verify transaction
+		if (! $transaction instanceof EE_Transaction) {
+			EE_Error::add_error(
+				__('Please provide a valid EE_Transaction object.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// set transaction status based on comparison of TXN_paid vs TXN_total
+		return $transaction->update_status_based_on_total_paid($update_txn);
+	}
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @return string
+	 */
+	public function old_txn_status()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::old_txn_status(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		return $this->_old_txn_status;
+	}
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @param string $old_txn_status
+	 */
+	public function set_old_txn_status($old_txn_status)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::set_old_txn_status(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		// only set the first time
+		if ($this->_old_txn_status === null) {
+			$this->_old_txn_status = $old_txn_status;
+		}
+	}
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @return string
+	 */
+	public function new_txn_status()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been removed. Please just use \EE_Transaction::status_ID() instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		return $this->_new_txn_status;
+	}
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @param string $new_txn_status
+	 */
+	public function set_new_txn_status($new_txn_status)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been removed. Please just use \EE_Transaction::set_status() instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		$this->_new_txn_status = $new_txn_status;
+	}
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @return bool
+	 */
+	public function txn_status_updated()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::txn_status_updated(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		return $this->_new_txn_status !== $this->_old_txn_status && $this->_old_txn_status !== null ? true : false;
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -43,7 +43,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Transaction_Payments) {
+        if ( ! self::$_instance instanceof EE_Transaction_Payments) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -62,7 +62,7 @@ 
     public function recalculate_transaction_total(EE_Transaction $transaction, $update_txn = true)
     {
         $total_line_item = $transaction->total_line_item();
-        if (! $total_line_item instanceof EE_Line_Item) {
+        if ( ! $total_line_item instanceof EE_Line_Item) {
             EE_Error::add_error(
                 sprintf(
                     __('The Total Line Item for Transaction %1$d\'s was not found or is invalid.', 'event_espresso'),
@@ -101,7 +101,7 @@ 
     public function calculate_total_payments_and_update_status(EE_Transaction $transaction, $update_txn = true)
     {
         // verify transaction
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             EE_Error::add_error(
                 __('Please provide a valid EE_Transaction object.', 'event_espresso'),
                 __FILE__,
@@ -116,7 +116,7 @@ 
         if ($total_paid !== false && (float) $total_paid !== $transaction->paid()) {
             $transaction->set_paid($total_paid);
             // maybe update status, and make sure to save transaction if not done already
-            if (! $transaction->update_status_based_on_total_paid($update_txn)) {
+            if ( ! $transaction->update_status_based_on_total_paid($update_txn)) {
                 if ($update_txn) {
                     return $transaction->save() ? true : false;
                 }
@@ -145,7 +145,7 @@ 
         $payment_status = EEM_Payment::status_id_approved
     ) {
         // verify transaction
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             EE_Error::add_error(
                 __('Please provide a valid EE_Transaction object.', 'event_espresso'),
                 __FILE__,
@@ -178,7 +178,7 @@ 
     public function delete_payment_and_update_transaction(EE_Payment $payment)
     {
         // verify payment
-        if (! $payment instanceof EE_Payment) {
+        if ( ! $payment instanceof EE_Payment) {
             EE_Error::add_error(
                 __('A valid Payment object was not received.', 'event_espresso'),
                 __FILE__,
@@ -187,10 +187,10 @@ 
             );
             return false;
         }
-        if (! $this->delete_registration_payments_and_update_registrations($payment)) {
+        if ( ! $this->delete_registration_payments_and_update_registrations($payment)) {
             return false;
         }
-        if (! $payment->delete()) {
+        if ( ! $payment->delete()) {
             EE_Error::add_error(
                 __('The payment could not be deleted.', 'event_espresso'),
                 __FILE__,
@@ -213,7 +213,7 @@ 
 
         // if this fails, that just means that the transaction didn't get its status changed and/or updated.
         // however the payment was still deleted.
-        if (! $this->calculate_total_payments_and_update_status($transaction)) {
+        if ( ! $this->calculate_total_payments_and_update_status($transaction)) {
             EE_Error::add_attention(
                 __(
                     'It appears that the Payment was deleted but no change was recorded for the Transaction for an unknown reason. Please verify that all data for this Transaction looks correct..',
@@ -255,7 +255,7 @@ 
         $reg_payment_query_params = ! empty($reg_payment_query_params) ? $reg_payment_query_params
             : array(array('PAY_ID' => $payment->ID()));
         $registration_payments = EEM_Registration_Payment::instance()->get_all($reg_payment_query_params);
-        if (! empty($registration_payments)) {
+        if ( ! empty($registration_payments)) {
             foreach ($registration_payments as $registration_payment) {
                 if ($registration_payment instanceof EE_Registration_Payment) {
                     $amount_paid = $registration_payment->amount();
@@ -321,7 +321,7 @@ 
     public function update_transaction_status_based_on_total_paid(EE_Transaction $transaction, $update_txn = true)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             sprintf(
                 __('This method is deprecated. Please use "%s" instead', 'event_espresso'),
                 'EE_Transaction::update_status_based_on_total_paid()'
@@ -330,7 +330,7 @@ 
             '5.0.0'
         );
         // verify transaction
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             EE_Error::add_error(
                 __('Please provide a valid EE_Transaction object.', 'event_espresso'),
                 __FILE__,

core/db_classes/EE_Answer.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -61,7 +61,7 @@
      *    Set Answer value
      *
      * @access        public
-     * @param mixed $ANS_value
+     * @param string $ANS_value
      */
     public function set_value($ANS_value = '')
     {

Indentation +138 added lines, -138 removed lines

@@ -10,144 +10,144 @@
 class EE_Answer extends EE_Base_Class
 {
 
-    /**
-     *
-     * @param array $props_n_values
-     * @return EE_Answer
-     */
-    public static function new_instance($props_n_values = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__);
-        return $has_object ? $has_object : new self($props_n_values);
-    }
-
-
-    /**
-     *
-     * @param array $props_n_values
-     * @return EE_Answer
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
-
-
-    /**
-     *    Set Question ID
-     *
-     * @access        public
-     * @param int $QST_ID
-     */
-    public function set_question($QST_ID = 0)
-    {
-        $this->set('QST_ID', $QST_ID);
-    }
-
-
-    /**
-     *    Set Registration ID
-     *
-     * @access        public
-     * @param int $REG_ID
-     */
-    public function set_registration($REG_ID = 0)
-    {
-        $this->set('REG_ID', $REG_ID);
-    }
-
-
-    /**
-     *    Set Answer value
-     *
-     * @access        public
-     * @param mixed $ANS_value
-     */
-    public function set_value($ANS_value = '')
-    {
-        $this->set('ANS_value', $ANS_value);
-    }
-
-
-    /**
-     *    get Attendee First Name
-     *
-     * @access        public
-     * @return        int
-     */
-    public function registration_ID()
-    {
-        return $this->get('REG_ID');
-    }
-
-
-    /**
-     *    get Attendee Last Name
-     *
-     * @access        public
-     * @return        int
-     */
-    public function question_ID()
-    {
-        return $this->get('QST_ID');
-    }
-
-
-    /**
-     *    get Attendee Address
-     *
-     * @access        public
-     * @return        string
-     */
-    public function value()
-    {
-        return $this->get('ANS_value');
-    }
-
-
-    /**
-     * Gets a pretty form of the value (mostly applies to answers that have multiple answers)
-     *
-     * @param null $schema
-     * @return string
-     */
-    public function pretty_value($schema = null)
-    {
-        return $this->get_pretty('ANS_value', $schema);
-    }
-
-
-    /**
-     * Echoes out a pretty value (even for multi-choice options)
-     *
-     * @param string $schema
-     */
-    public function e_value($schema = null)
-    {
-        $this->e('ANS_value', $schema);
-    }
-
-
-    /**
-     * Gets the related EE_Question to this EE_Answer
-     *
-     * @return EE_Question
-     */
-    public function question()
-    {
-        return $this->get_first_related('Question');
-    }
-
-
-    /**
-     * Gets the related EE_Registration to this EE_Answer
-     *
-     * @return EE_Registration
-     */
-    public function registration()
-    {
-        return $this->get_first_related('Registration');
-    }
+	/**
+	 *
+	 * @param array $props_n_values
+	 * @return EE_Answer
+	 */
+	public static function new_instance($props_n_values = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__);
+		return $has_object ? $has_object : new self($props_n_values);
+	}
+
+
+	/**
+	 *
+	 * @param array $props_n_values
+	 * @return EE_Answer
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
+
+
+	/**
+	 *    Set Question ID
+	 *
+	 * @access        public
+	 * @param int $QST_ID
+	 */
+	public function set_question($QST_ID = 0)
+	{
+		$this->set('QST_ID', $QST_ID);
+	}
+
+
+	/**
+	 *    Set Registration ID
+	 *
+	 * @access        public
+	 * @param int $REG_ID
+	 */
+	public function set_registration($REG_ID = 0)
+	{
+		$this->set('REG_ID', $REG_ID);
+	}
+
+
+	/**
+	 *    Set Answer value
+	 *
+	 * @access        public
+	 * @param mixed $ANS_value
+	 */
+	public function set_value($ANS_value = '')
+	{
+		$this->set('ANS_value', $ANS_value);
+	}
+
+
+	/**
+	 *    get Attendee First Name
+	 *
+	 * @access        public
+	 * @return        int
+	 */
+	public function registration_ID()
+	{
+		return $this->get('REG_ID');
+	}
+
+
+	/**
+	 *    get Attendee Last Name
+	 *
+	 * @access        public
+	 * @return        int
+	 */
+	public function question_ID()
+	{
+		return $this->get('QST_ID');
+	}
+
+
+	/**
+	 *    get Attendee Address
+	 *
+	 * @access        public
+	 * @return        string
+	 */
+	public function value()
+	{
+		return $this->get('ANS_value');
+	}
+
+
+	/**
+	 * Gets a pretty form of the value (mostly applies to answers that have multiple answers)
+	 *
+	 * @param null $schema
+	 * @return string
+	 */
+	public function pretty_value($schema = null)
+	{
+		return $this->get_pretty('ANS_value', $schema);
+	}
+
+
+	/**
+	 * Echoes out a pretty value (even for multi-choice options)
+	 *
+	 * @param string $schema
+	 */
+	public function e_value($schema = null)
+	{
+		$this->e('ANS_value', $schema);
+	}
+
+
+	/**
+	 * Gets the related EE_Question to this EE_Answer
+	 *
+	 * @return EE_Question
+	 */
+	public function question()
+	{
+		return $this->get_first_related('Question');
+	}
+
+
+	/**
+	 * Gets the related EE_Registration to this EE_Answer
+	 *
+	 * @return EE_Registration
+	 */
+	public function registration()
+	{
+		return $this->get_first_related('Registration');
+	}
 }
 
 /* End of file EE_Answer.class.php */

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;