eventespresso / event-espresso-core

core/libraries/line_item_display/EE_Receipt_Line_Item_Display_Strategy.strategy.php

Indentation +57 added lines, -57 removed lines

@@ -14,88 +14,88 @@
  * ------------------------------------------------------------------------
  */
  /**
- *
- * Class EE_Receipt_Line_Item_Display_Strategy
- *
- * Description
- *
- * @package         Event Espresso
- * @subpackage    core
- * @author              Brent Christensen
- *
- *
- */
+  *
+  * Class EE_Receipt_Line_Item_Display_Strategy
+  *
+  * Description
+  *
+  * @package         Event Espresso
+  * @subpackage    core
+  * @author              Brent Christensen
+  *
+  *
+  */
 
 class EE_Receipt_Line_Item_Display_Strategy implements EEI_Line_Item_Display
 {
 
-    /**
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    public function display_line_item(EE_Line_Item $line_item, $options = array())
-    {
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	public function display_line_item(EE_Line_Item $line_item, $options = array())
+	{
 
-        $html = '';
-        // set some default options and merge with incoming
-        $default_options = array(
-            'show_desc' => true,
-            'odd' => false
-        );
-        $options = array_merge($default_options, (array) $options);
-        switch ($line_item->type()) {
-            case EEM_Line_Item::type_total:
-                // loop thru children
-                foreach ($line_item->children() as $child_line_item) {
-                    // recursively feed children back into this method
+		$html = '';
+		// set some default options and merge with incoming
+		$default_options = array(
+			'show_desc' => true,
+			'odd' => false
+		);
+		$options = array_merge($default_options, (array) $options);
+		switch ($line_item->type()) {
+			case EEM_Line_Item::type_total:
+				// loop thru children
+				foreach ($line_item->children() as $child_line_item) {
+					// recursively feed children back into this method
 //                  $html .= $this->display_line_item( $child_line_item, $options );
-                }
+				}
 //              $html .= $this->_separator_row( $options );
 //              $html .= $this->_total_row( $line_item, __('Total', 'event_espresso'), $options );
-                break;
+				break;
 
 
-            case EEM_Line_Item::type_sub_total:
-                // loop thru children
-                foreach ($line_item->children() as $child_line_item) {
-                    // recursively feed children back into this method
+			case EEM_Line_Item::type_sub_total:
+				// loop thru children
+				foreach ($line_item->children() as $child_line_item) {
+					// recursively feed children back into this method
 //                  $html .= $this->display_line_item( $child_line_item, $options );
-                }
+				}
 //              $html .= $this->_total_row( $line_item, __('Sub-Total', 'event_espresso'), $options );
-                break;
+				break;
 
 
-            case EEM_Line_Item::type_tax_sub_total:
-                // loop thru children
-                foreach ($line_item->children() as $child_line_item) {
-                    // recursively feed children back into this method
+			case EEM_Line_Item::type_tax_sub_total:
+				// loop thru children
+				foreach ($line_item->children() as $child_line_item) {
+					// recursively feed children back into this method
 //                  $html .= $this->display_line_item( $child_line_item, $options );
-                }
+				}
 //              $html .= $this->_total_row( $line_item, __('Tax Total', 'event_espresso'), $options );
-                break;
+				break;
 
 
-            case EEM_Line_Item::type_line_item:
-                // item row
+			case EEM_Line_Item::type_line_item:
+				// item row
 //              $html .= $this->_item_row( $line_item, $options );
-                // got any kids?
-                foreach ($line_item->children() as $child_line_item) {
+				// got any kids?
+				foreach ($line_item->children() as $child_line_item) {
 //                  $this->display_line_item( $child_line_item, $options );
-                }
-                break;
+				}
+				break;
 
 
-            case EEM_Line_Item::type_sub_line_item:
+			case EEM_Line_Item::type_sub_line_item:
 //              $html .= $this->_sub_item_row( $line_item, $options );
-                break;
+				break;
 
 
-            case EEM_Line_Item::type_tax:
+			case EEM_Line_Item::type_tax:
 //              $html .= $this->_tax_row( $line_item, $options );
-                break;
-        }
+				break;
+		}
 
-        return $html;
-    }
+		return $html;
+	}
 }

core/libraries/line_item_display/EE_Admin_Table_Registration_Line_Item_Display_Strategy.strategy.php

Spacing +11 added lines, -11 removed lines

@@ -71,22 +71,22 @@ 
 
         $name_html = $line_item_related_object instanceof EEI_Line_Item_Object
             ? $line_item_related_object->name() : $line_item->name();
-        $name_html = $name_link ? '<a href="' . $name_link . '">' . $name_html . '</a>'
+        $name_html = $name_link ? '<a href="'.$name_link.'">'.$name_html.'</a>'
             : $name_html;
         $name_html .= $line_item->is_taxable() ? ' *' : '';
         // maybe preface with icon?
         $name_html = $line_item_related_object instanceof EEI_Has_Icon
-            ? $line_item_related_object->get_icon() . $name_html
+            ? $line_item_related_object->get_icon().$name_html
             : $name_html;
-        $name_html = '<span class="ee-line-item-name linked">' . $name_html . '</span><br>';
-        $name_html .=  sprintf(
+        $name_html = '<span class="ee-line-item-name linked">'.$name_html.'</span><br>';
+        $name_html .= sprintf(
             _x('%1$sfor the %2$s: %3$s%4$s', 'eg. "for the Event: My Cool Event"', 'event_espresso'),
             '<span class="ee-line-item-related-parent-object">',
             $line_item->parent() instanceof EE_Line_Item
                 ? $line_item->parent()->OBJ_type_i18n()
                 : __('Item:', 'event_espresso'),
             $parent_related_object_link
-                ? '<a href="' . $parent_related_object_link . '">' . $parent_related_object_name . '</a>'
+                ? '<a href="'.$parent_related_object_link.'">'.$parent_related_object_name.'</a>'
                 : $parent_related_object_name,
             '</span>'
         );
@@ -96,7 +96,7 @@ 
         $type_html .= $this->_get_cancellations($line_item);
         $type_html .= $line_item->OBJ_type() ? '<br />' : '';
         $code = $line_item_related_object instanceof EEI_Has_Code ? $line_item_related_object->code() : '';
-        $type_html .= ! empty($code) ? '<span class="ee-line-item-id">' . sprintf(__('Code: %s', 'event_espresso'), $code) . '</span>' : '';
+        $type_html .= ! empty($code) ? '<span class="ee-line-item-id">'.sprintf(__('Code: %s', 'event_espresso'), $code).'</span>' : '';
         $html .= EEH_HTML::td($type_html, '', 'jst-left');
 
         // Date column
@@ -105,7 +105,7 @@ 
             $datetimes = $line_item_related_object->datetimes();
             foreach ($datetimes as $datetime) {
                 if ($datetime instanceof EE_Datetime) {
-                    $datetime_content .= $datetime->get_dtt_display_name() . '<br>';
+                    $datetime_content .= $datetime->get_dtt_display_name().'<br>';
                 }
             }
         }
@@ -113,7 +113,7 @@ 
 
         // Amount Column
         if ($line_item->is_percent()) {
-            $html .= EEH_HTML::td($line_item->percent() . '%', '', 'jst-rght');
+            $html .= EEH_HTML::td($line_item->percent().'%', '', 'jst-rght');
         } else {
             $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'jst-rght');
         }
@@ -138,7 +138,7 @@ 
         // start of row
         $html = EEH_HTML::tr('', 'admin-primary-mbox-taxes-tr');
         // name th
-        $html .= EEH_HTML::th($line_item->name() . '(' . $line_item->get_pretty('LIN_percent') . '%)', '', 'jst-rght', '', ' colspan="3"');
+        $html .= EEH_HTML::th($line_item->name().'('.$line_item->get_pretty('LIN_percent').'%)', '', 'jst-rght', '', ' colspan="3"');
         // total th
         $html .= EEH_HTML::th(EEH_Template::format_currency($line_item->total(), false, false), '', 'jst-rght');
         // end of row
@@ -171,9 +171,9 @@ 
         $html = EEH_HTML::tr('', '', 'admin-primary-mbox-total-tr');
         // Total th label
         if ($total_match) {
-            $total_label = sprintf(__('This registration\'s total %s:', 'event_espresso'), '(' . EE_Registry::instance()->CFG->currency->code . ')');
+            $total_label = sprintf(__('This registration\'s total %s:', 'event_espresso'), '('.EE_Registry::instance()->CFG->currency->code.')');
         } else {
-            $total_label = sprintf(__('This registration\'s approximate total %s', 'event_espresso'), '(' . EE_Registry::instance()->CFG->currency->code . ')');
+            $total_label = sprintf(__('This registration\'s approximate total %s', 'event_espresso'), '('.EE_Registry::instance()->CFG->currency->code.')');
             $total_label .= '<br>';
             $total_label .= '<p class="ee-footnote-text">'
                             . sprintf(

Indentation +186 added lines, -186 removed lines

@@ -13,191 +13,191 @@
 class EE_Admin_Table_Registration_Line_Item_Display_Strategy extends EE_Admin_Table_Line_Item_Display_Strategy
 {
 
-    /**
-     * Table header for display.
-     * @since   4.8
-     * @param array $options
-     * @return string
-     */
-    protected function _table_header($options)
-    {
-        $html = EEH_HTML::table('', '', $options['table_css_class']);
-        $html .= EEH_HTML::thead();
-        $html .= EEH_HTML::tr();
-        $html .= EEH_HTML::th(__('Name', 'event_espresso'), '', 'jst-left');
-        $html .= EEH_HTML::th(__('Type', 'event_espresso'), '', 'jst-left');
-        $html .= EEH_HTML::th(__('Date(s)', 'event_espresso'), '', 'jst-left');
-        $html .= EEH_HTML::th(__('Amount', 'event_espresso'), '', 'jst-cntr');
-        $html .= EEH_HTML::tbody();
-        return $html;
-    }
-
-
-
-
-
-    /**
-     *    _item_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    protected function _item_row(EE_Line_Item $line_item, $options = array())
-    {
-        $line_item_related_object = $line_item->get_object();
-        $parent_line_item_related_object = $line_item->parent() instanceof EE_Line_Item
-            ? $line_item->parent()->get_object()
-            : null;
-        // start of row
-        $row_class = $options['odd'] ? 'item odd' : 'item';
-        $html = EEH_HTML::tr('', '', $row_class);
-
-
-        // Name Column
-        $name_link = $line_item_related_object instanceof EEI_Admin_Links ? $line_item_related_object->get_admin_details_link() : '';
-
-        // related object scope.
-        $parent_related_object_name = $parent_line_item_related_object instanceof EEI_Line_Item_Object
-            ? $parent_line_item_related_object->name()
-            : '';
-        $parent_related_object_name = empty($parent_related_object_name) && $line_item->parent() instanceof EE_Line_Item
-            ? $line_item->parent()->name()
-            : $parent_related_object_name;
-        $parent_related_object_link = $parent_line_item_related_object instanceof EEI_Admin_Links
-            ? $parent_line_item_related_object->get_admin_details_link()
-            : '';
-
-
-        $name_html = $line_item_related_object instanceof EEI_Line_Item_Object
-            ? $line_item_related_object->name() : $line_item->name();
-        $name_html = $name_link ? '<a href="' . $name_link . '">' . $name_html . '</a>'
-            : $name_html;
-        $name_html .= $line_item->is_taxable() ? ' *' : '';
-        // maybe preface with icon?
-        $name_html = $line_item_related_object instanceof EEI_Has_Icon
-            ? $line_item_related_object->get_icon() . $name_html
-            : $name_html;
-        $name_html = '<span class="ee-line-item-name linked">' . $name_html . '</span><br>';
-        $name_html .=  sprintf(
-            _x('%1$sfor the %2$s: %3$s%4$s', 'eg. "for the Event: My Cool Event"', 'event_espresso'),
-            '<span class="ee-line-item-related-parent-object">',
-            $line_item->parent() instanceof EE_Line_Item
-                ? $line_item->parent()->OBJ_type_i18n()
-                : __('Item:', 'event_espresso'),
-            $parent_related_object_link
-                ? '<a href="' . $parent_related_object_link . '">' . $parent_related_object_name . '</a>'
-                : $parent_related_object_name,
-            '</span>'
-        );
-
-        $name_html = apply_filters(
-            'FHEE__EE_Admin_Table_Registration_Line_Item_Display_Strategy___item_row__name_html',
-            $name_html,
-            $line_item,
-            $options
-        );
+	/**
+	 * Table header for display.
+	 * @since   4.8
+	 * @param array $options
+	 * @return string
+	 */
+	protected function _table_header($options)
+	{
+		$html = EEH_HTML::table('', '', $options['table_css_class']);
+		$html .= EEH_HTML::thead();
+		$html .= EEH_HTML::tr();
+		$html .= EEH_HTML::th(__('Name', 'event_espresso'), '', 'jst-left');
+		$html .= EEH_HTML::th(__('Type', 'event_espresso'), '', 'jst-left');
+		$html .= EEH_HTML::th(__('Date(s)', 'event_espresso'), '', 'jst-left');
+		$html .= EEH_HTML::th(__('Amount', 'event_espresso'), '', 'jst-cntr');
+		$html .= EEH_HTML::tbody();
+		return $html;
+	}
+
+
+
+
+
+	/**
+	 *    _item_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	protected function _item_row(EE_Line_Item $line_item, $options = array())
+	{
+		$line_item_related_object = $line_item->get_object();
+		$parent_line_item_related_object = $line_item->parent() instanceof EE_Line_Item
+			? $line_item->parent()->get_object()
+			: null;
+		// start of row
+		$row_class = $options['odd'] ? 'item odd' : 'item';
+		$html = EEH_HTML::tr('', '', $row_class);
+
+
+		// Name Column
+		$name_link = $line_item_related_object instanceof EEI_Admin_Links ? $line_item_related_object->get_admin_details_link() : '';
+
+		// related object scope.
+		$parent_related_object_name = $parent_line_item_related_object instanceof EEI_Line_Item_Object
+			? $parent_line_item_related_object->name()
+			: '';
+		$parent_related_object_name = empty($parent_related_object_name) && $line_item->parent() instanceof EE_Line_Item
+			? $line_item->parent()->name()
+			: $parent_related_object_name;
+		$parent_related_object_link = $parent_line_item_related_object instanceof EEI_Admin_Links
+			? $parent_line_item_related_object->get_admin_details_link()
+			: '';
+
+
+		$name_html = $line_item_related_object instanceof EEI_Line_Item_Object
+			? $line_item_related_object->name() : $line_item->name();
+		$name_html = $name_link ? '<a href="' . $name_link . '">' . $name_html . '</a>'
+			: $name_html;
+		$name_html .= $line_item->is_taxable() ? ' *' : '';
+		// maybe preface with icon?
+		$name_html = $line_item_related_object instanceof EEI_Has_Icon
+			? $line_item_related_object->get_icon() . $name_html
+			: $name_html;
+		$name_html = '<span class="ee-line-item-name linked">' . $name_html . '</span><br>';
+		$name_html .=  sprintf(
+			_x('%1$sfor the %2$s: %3$s%4$s', 'eg. "for the Event: My Cool Event"', 'event_espresso'),
+			'<span class="ee-line-item-related-parent-object">',
+			$line_item->parent() instanceof EE_Line_Item
+				? $line_item->parent()->OBJ_type_i18n()
+				: __('Item:', 'event_espresso'),
+			$parent_related_object_link
+				? '<a href="' . $parent_related_object_link . '">' . $parent_related_object_name . '</a>'
+				: $parent_related_object_name,
+			'</span>'
+		);
+
+		$name_html = apply_filters(
+			'FHEE__EE_Admin_Table_Registration_Line_Item_Display_Strategy___item_row__name_html',
+			$name_html,
+			$line_item,
+			$options
+		);
         
-        $html .= EEH_HTML::td($name_html, '', 'jst-left');
-        // Type Column
-        $type_html = $line_item->OBJ_type() ? $line_item->OBJ_type_i18n() : '';
-        $type_html .= $this->_get_cancellations($line_item);
-        $type_html .= $line_item->OBJ_type() ? '<br />' : '';
-        $code = $line_item_related_object instanceof EEI_Has_Code ? $line_item_related_object->code() : '';
-        $type_html .= ! empty($code) ? '<span class="ee-line-item-id">' . sprintf(__('Code: %s', 'event_espresso'), $code) . '</span>' : '';
-        $html .= EEH_HTML::td($type_html, '', 'jst-left');
-
-        // Date column
-        $datetime_content = '';
-        if ($line_item_related_object instanceof EE_Ticket) {
-            $datetimes = $line_item_related_object->datetimes();
-            foreach ($datetimes as $datetime) {
-                if ($datetime instanceof EE_Datetime) {
-                    $datetime_content .= $datetime->get_dtt_display_name() . '<br>';
-                }
-            }
-        }
-        $html .= EEH_HTML::td($datetime_content, '', 'jst-left');
-
-        // Amount Column
-        if ($line_item->is_percent()) {
-            $html .= EEH_HTML::td($line_item->percent() . '%', '', 'jst-rght');
-        } else {
-            $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'jst-rght');
-        }
-
-
-        // finish things off and return
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-    /**
-     *  _tax_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    protected function _tax_row(EE_Line_Item $line_item, $options = array())
-    {
-        // start of row
-        $html = EEH_HTML::tr('', 'admin-primary-mbox-taxes-tr');
-        // name th
-        $html .= EEH_HTML::th($line_item->name() . '(' . $line_item->get_pretty('LIN_percent') . '%)', '', 'jst-rght', '', ' colspan="3"');
-        // total th
-        $html .= EEH_HTML::th(EEH_Template::format_currency($line_item->total(), false, false), '', 'jst-rght');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-
-
-    /**
-     *  _total_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    protected function _total_row(EE_Line_Item $line_item, $options = array())
-    {
-
-        $registration = isset($options['EE_Registration']) ? $options['EE_Registration'] : null;
-        $registration_total = $registration instanceof EE_Registration ? $registration->pretty_final_price() : 0;
-        // if no valid registration object then we're not going to show the approximate text.
-        $total_match = $registration instanceof EE_Registration
-            ? $registration->final_price() === $line_item->total()
-            : true;
-
-        // start of row
-        $html = EEH_HTML::tr('', '', 'admin-primary-mbox-total-tr');
-        // Total th label
-        if ($total_match) {
-            $total_label = sprintf(__('This registration\'s total %s:', 'event_espresso'), '(' . EE_Registry::instance()->CFG->currency->code . ')');
-        } else {
-            $total_label = sprintf(__('This registration\'s approximate total %s', 'event_espresso'), '(' . EE_Registry::instance()->CFG->currency->code . ')');
-            $total_label .= '<br>';
-            $total_label .= '<p class="ee-footnote-text">'
-                            . sprintf(
-                                __('The registrations\' share of the transaction total is approximate because it might not be possible to evenly divide the transaction total among each registration, and so some registrations may need to pay a penny more than others.  This registration\'s final share is actually %1$s%2$s%3$s.', 'event_espresso'),
-                                '<strong>',
-                                $registration_total,
-                                '</strong>'
-                            )
-                            . '</p>';
-        }
-        $html .= EEH_HTML::th($total_label, '', 'jst-rght', '', ' colspan="3"');
-        // total th
-
-        $html .= EEH_HTML::th(EEH_Template::format_currency($line_item->total(), false, false), '', 'jst-rght');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
+		$html .= EEH_HTML::td($name_html, '', 'jst-left');
+		// Type Column
+		$type_html = $line_item->OBJ_type() ? $line_item->OBJ_type_i18n() : '';
+		$type_html .= $this->_get_cancellations($line_item);
+		$type_html .= $line_item->OBJ_type() ? '<br />' : '';
+		$code = $line_item_related_object instanceof EEI_Has_Code ? $line_item_related_object->code() : '';
+		$type_html .= ! empty($code) ? '<span class="ee-line-item-id">' . sprintf(__('Code: %s', 'event_espresso'), $code) . '</span>' : '';
+		$html .= EEH_HTML::td($type_html, '', 'jst-left');
+
+		// Date column
+		$datetime_content = '';
+		if ($line_item_related_object instanceof EE_Ticket) {
+			$datetimes = $line_item_related_object->datetimes();
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$datetime_content .= $datetime->get_dtt_display_name() . '<br>';
+				}
+			}
+		}
+		$html .= EEH_HTML::td($datetime_content, '', 'jst-left');
+
+		// Amount Column
+		if ($line_item->is_percent()) {
+			$html .= EEH_HTML::td($line_item->percent() . '%', '', 'jst-rght');
+		} else {
+			$html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'jst-rght');
+		}
+
+
+		// finish things off and return
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+	/**
+	 *  _tax_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	protected function _tax_row(EE_Line_Item $line_item, $options = array())
+	{
+		// start of row
+		$html = EEH_HTML::tr('', 'admin-primary-mbox-taxes-tr');
+		// name th
+		$html .= EEH_HTML::th($line_item->name() . '(' . $line_item->get_pretty('LIN_percent') . '%)', '', 'jst-rght', '', ' colspan="3"');
+		// total th
+		$html .= EEH_HTML::th(EEH_Template::format_currency($line_item->total(), false, false), '', 'jst-rght');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+
+
+	/**
+	 *  _total_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	protected function _total_row(EE_Line_Item $line_item, $options = array())
+	{
+
+		$registration = isset($options['EE_Registration']) ? $options['EE_Registration'] : null;
+		$registration_total = $registration instanceof EE_Registration ? $registration->pretty_final_price() : 0;
+		// if no valid registration object then we're not going to show the approximate text.
+		$total_match = $registration instanceof EE_Registration
+			? $registration->final_price() === $line_item->total()
+			: true;
+
+		// start of row
+		$html = EEH_HTML::tr('', '', 'admin-primary-mbox-total-tr');
+		// Total th label
+		if ($total_match) {
+			$total_label = sprintf(__('This registration\'s total %s:', 'event_espresso'), '(' . EE_Registry::instance()->CFG->currency->code . ')');
+		} else {
+			$total_label = sprintf(__('This registration\'s approximate total %s', 'event_espresso'), '(' . EE_Registry::instance()->CFG->currency->code . ')');
+			$total_label .= '<br>';
+			$total_label .= '<p class="ee-footnote-text">'
+							. sprintf(
+								__('The registrations\' share of the transaction total is approximate because it might not be possible to evenly divide the transaction total among each registration, and so some registrations may need to pay a penny more than others.  This registration\'s final share is actually %1$s%2$s%3$s.', 'event_espresso'),
+								'<strong>',
+								$registration_total,
+								'</strong>'
+							)
+							. '</p>';
+		}
+		$html .= EEH_HTML::th($total_label, '', 'jst-rght', '', ' colspan="3"');
+		// total th
+
+		$html .= EEH_HTML::th(EEH_Template::format_currency($line_item->total(), false, false), '', 'jst-rght');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
 }

core/libraries/line_item_display/EE_Invoice_Line_Item_Display_Strategy.strategy.php

Indentation +212 added lines, -212 removed lines

@@ -1,222 +1,222 @@
 <?php
  /**
- *
- * Class EE_Invoice_Line_Item_Display_Strategy
- *
- * Description
- *
- * @package         Event Espresso
- * @subpackage    core
- * @author              Brent Christensen
- *
- *
- */
+  *
+  * Class EE_Invoice_Line_Item_Display_Strategy
+  *
+  * Description
+  *
+  * @package         Event Espresso
+  * @subpackage    core
+  * @author              Brent Christensen
+  *
+  *
+  */
 class EE_Invoice_Line_Item_Display_Strategy implements EEI_Line_Item_Display
 {
 
-    /**
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    public function display_line_item(EE_Line_Item $line_item, $options = array())
-    {
-
-        $html = '';
-        // set some default options and merge with incoming
-        $default_options = array(
-            'show_desc' => true,
-            'odd' => false
-        );
-        $options = array_merge($default_options, (array) $options);
-
-        switch ($line_item->type()) {
-            case EEM_Line_Item::type_total:
-                // loop thru children
-                foreach ($line_item->children() as $child_line_item) {
-                    // recursively feed children back into this method
-                    $html .= $this->display_line_item($child_line_item, $options);
-                }
-                $html .= $this->_separator_row($options);
-                $html .= $this->_total_row($line_item, __('Total', 'event_espresso'), $options);
-                break;
-
-
-            case EEM_Line_Item::type_sub_total:
-                // loop thru children
-                foreach ($line_item->children() as $child_line_item) {
-                    // recursively feed children back into this method
-                    $html .= $this->display_line_item($child_line_item, $options);
-                }
-                $html .= $this->_total_row($line_item, __('Sub-Total', 'event_espresso'), $options);
-                break;
-
-
-            case EEM_Line_Item::type_tax_sub_total:
-                // loop thru children
-                foreach ($line_item->children() as $child_line_item) {
-                    // recursively feed children back into this method
-                    $html .= $this->display_line_item($child_line_item, $options);
-                }
-                $html .= $this->_total_row($line_item, __('Tax Total', 'event_espresso'), $options);
-                break;
-
-
-            case EEM_Line_Item::type_line_item:
-                // item row
-                $html .= $this->_item_row($line_item, $options);
-                // got any kids?
-                foreach ($line_item->children() as $child_line_item) {
-                    $this->display_line_item($child_line_item, $options);
-                }
-                break;
-
-
-            case EEM_Line_Item::type_sub_line_item:
-                $html .= $this->_sub_item_row($line_item, $options);
-                break;
-
-
-            case EEM_Line_Item::type_tax:
-                $html .= $this->_tax_row($line_item, $options);
-                break;
-        }
-
-        return $html;
-    }
-
-
-
-    /**
-     *  _total_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    private function _item_row(EE_Line_Item $line_item, $options = array())
-    {
-        // start of row
-        $row_class = $options['odd'] ? 'item odd' : 'item';
-        $html = EEH_HTML::tr('', $row_class);
-        // name td
-        $html .= EEH_HTML::td($line_item->name(), '', 'item_l');
-        // desc td
-        $html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
-        // quantity td
-        $html .= EEH_HTML::td($line_item->quantity(), '', 'item_l');
-        // price td
-        $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c');
-        // total td
-        $total = $line_item->is_taxable() ? $line_item->total_no_code() . '*' : $line_item->total_no_code();
-        $html .= EEH_HTML::td($total, '', 'item_r');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-    /**
-     *  _sub_item_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    private function _sub_item_row(EE_Line_Item $line_item, $options = array())
-    {
-        // start of row
-        $html = EEH_HTML::tr('', 'item sub-item-row');
-        // name td
-        $html .= EEH_HTML::td($line_item->name(), '', 'item_l sub-item');
-        // desc td
-        $html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
-        $html .= EEH_HTML::td() . EEH_HTML::tdx();
-        // discount/surcharge td
-        if ($line_item->is_percent()) {
-            $html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c');
-        } else {
-            $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c');
-        }
-        // total td
-        $html .= EEH_HTML::td($line_item->total_no_code(), '', 'item_r');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-    /**
-     *  _tax_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     */
-    private function _tax_row(EE_Line_Item $line_item, $options = array())
-    {
-        // start of row
-        $html = EEH_HTML::tr('', 'item sub-item tax-total');
-        // name td
-        $html .= EEH_HTML::td($line_item->name(), '', 'item_l sub-item');
-        // desc td
-        $html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
-        // percent td
-        $html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c', '', ' colspan="2"');
-        // total td
-        $html .= EEH_HTML::td($line_item->total_no_code(), '', 'item_r');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-    /**
-     *  _total_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param string       $text
-     * @param array        $options
-     * @return mixed
-     */
-    private function _total_row(EE_Line_Item $line_item, $text = '', $options = array())
-    {
-        // colspan
-        $colspan = $options['show_desc'] ? ' colspan="2"' : '';
-        // start of row
-        $html = EEH_HTML::tr('', '', 'total_tr odd');
-        // empty td
-        $html .= EEH_HTML::td(EEH_HTML::nbsp(), '', '', '', $colspan);
-        // total td
-        $html .= EEH_HTML::td($text, '', 'total_currency total', '', $colspan);
-        // total td
-        $html .= EEH_HTML::td($line_item->total_no_code(), '', 'total');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-
-    /**
-     *  _separator_row
-     *
-     * @param array        $options
-     * @return mixed
-     */
-    private function _separator_row($options = array())
-    {
-        // colspan
-        $colspan = $options['show_desc'] ? ' colspan="5"' : ' colspan="4"';
-        // start of row
-        $html = EEH_HTML::tr(EEH_HTML::td('<hr>', '', '', '', $colspan));
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	public function display_line_item(EE_Line_Item $line_item, $options = array())
+	{
+
+		$html = '';
+		// set some default options and merge with incoming
+		$default_options = array(
+			'show_desc' => true,
+			'odd' => false
+		);
+		$options = array_merge($default_options, (array) $options);
+
+		switch ($line_item->type()) {
+			case EEM_Line_Item::type_total:
+				// loop thru children
+				foreach ($line_item->children() as $child_line_item) {
+					// recursively feed children back into this method
+					$html .= $this->display_line_item($child_line_item, $options);
+				}
+				$html .= $this->_separator_row($options);
+				$html .= $this->_total_row($line_item, __('Total', 'event_espresso'), $options);
+				break;
+
+
+			case EEM_Line_Item::type_sub_total:
+				// loop thru children
+				foreach ($line_item->children() as $child_line_item) {
+					// recursively feed children back into this method
+					$html .= $this->display_line_item($child_line_item, $options);
+				}
+				$html .= $this->_total_row($line_item, __('Sub-Total', 'event_espresso'), $options);
+				break;
+
+
+			case EEM_Line_Item::type_tax_sub_total:
+				// loop thru children
+				foreach ($line_item->children() as $child_line_item) {
+					// recursively feed children back into this method
+					$html .= $this->display_line_item($child_line_item, $options);
+				}
+				$html .= $this->_total_row($line_item, __('Tax Total', 'event_espresso'), $options);
+				break;
+
+
+			case EEM_Line_Item::type_line_item:
+				// item row
+				$html .= $this->_item_row($line_item, $options);
+				// got any kids?
+				foreach ($line_item->children() as $child_line_item) {
+					$this->display_line_item($child_line_item, $options);
+				}
+				break;
+
+
+			case EEM_Line_Item::type_sub_line_item:
+				$html .= $this->_sub_item_row($line_item, $options);
+				break;
+
+
+			case EEM_Line_Item::type_tax:
+				$html .= $this->_tax_row($line_item, $options);
+				break;
+		}
+
+		return $html;
+	}
+
+
+
+	/**
+	 *  _total_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	private function _item_row(EE_Line_Item $line_item, $options = array())
+	{
+		// start of row
+		$row_class = $options['odd'] ? 'item odd' : 'item';
+		$html = EEH_HTML::tr('', $row_class);
+		// name td
+		$html .= EEH_HTML::td($line_item->name(), '', 'item_l');
+		// desc td
+		$html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
+		// quantity td
+		$html .= EEH_HTML::td($line_item->quantity(), '', 'item_l');
+		// price td
+		$html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c');
+		// total td
+		$total = $line_item->is_taxable() ? $line_item->total_no_code() . '*' : $line_item->total_no_code();
+		$html .= EEH_HTML::td($total, '', 'item_r');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+	/**
+	 *  _sub_item_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	private function _sub_item_row(EE_Line_Item $line_item, $options = array())
+	{
+		// start of row
+		$html = EEH_HTML::tr('', 'item sub-item-row');
+		// name td
+		$html .= EEH_HTML::td($line_item->name(), '', 'item_l sub-item');
+		// desc td
+		$html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
+		$html .= EEH_HTML::td() . EEH_HTML::tdx();
+		// discount/surcharge td
+		if ($line_item->is_percent()) {
+			$html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c');
+		} else {
+			$html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c');
+		}
+		// total td
+		$html .= EEH_HTML::td($line_item->total_no_code(), '', 'item_r');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+	/**
+	 *  _tax_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 */
+	private function _tax_row(EE_Line_Item $line_item, $options = array())
+	{
+		// start of row
+		$html = EEH_HTML::tr('', 'item sub-item tax-total');
+		// name td
+		$html .= EEH_HTML::td($line_item->name(), '', 'item_l sub-item');
+		// desc td
+		$html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
+		// percent td
+		$html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c', '', ' colspan="2"');
+		// total td
+		$html .= EEH_HTML::td($line_item->total_no_code(), '', 'item_r');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+	/**
+	 *  _total_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param string       $text
+	 * @param array        $options
+	 * @return mixed
+	 */
+	private function _total_row(EE_Line_Item $line_item, $text = '', $options = array())
+	{
+		// colspan
+		$colspan = $options['show_desc'] ? ' colspan="2"' : '';
+		// start of row
+		$html = EEH_HTML::tr('', '', 'total_tr odd');
+		// empty td
+		$html .= EEH_HTML::td(EEH_HTML::nbsp(), '', '', '', $colspan);
+		// total td
+		$html .= EEH_HTML::td($text, '', 'total_currency total', '', $colspan);
+		// total td
+		$html .= EEH_HTML::td($line_item->total_no_code(), '', 'total');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+
+	/**
+	 *  _separator_row
+	 *
+	 * @param array        $options
+	 * @return mixed
+	 */
+	private function _separator_row($options = array())
+	{
+		// colspan
+		$colspan = $options['show_desc'] ? ' colspan="5"' : ' colspan="4"';
+		// start of row
+		$html = EEH_HTML::tr(EEH_HTML::td('<hr>', '', '', '', $colspan));
 //      // separator td
 //      $html .= EEH_HTML::td( '<hr>', '',  '',  '',  $colspan );
 //      // end of row
 //      $html .= EEH_HTML::trx();
-        return $html;
-    }
+		return $html;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -108,7 +108,7 @@ 
         // price td
         $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c');
         // total td
-        $total = $line_item->is_taxable() ? $line_item->total_no_code() . '*' : $line_item->total_no_code();
+        $total = $line_item->is_taxable() ? $line_item->total_no_code().'*' : $line_item->total_no_code();
         $html .= EEH_HTML::td($total, '', 'item_r');
         // end of row
         $html .= EEH_HTML::trx();
@@ -132,10 +132,10 @@ 
         $html .= EEH_HTML::td($line_item->name(), '', 'item_l sub-item');
         // desc td
         $html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
-        $html .= EEH_HTML::td() . EEH_HTML::tdx();
+        $html .= EEH_HTML::td().EEH_HTML::tdx();
         // discount/surcharge td
         if ($line_item->is_percent()) {
-            $html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c');
+            $html .= EEH_HTML::td($line_item->percent().'%', '', 'item_c');
         } else {
             $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c');
         }
@@ -164,7 +164,7 @@ 
         // desc td
         $html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : '';
         // percent td
-        $html .= EEH_HTML::td($line_item->percent() . '%', '', 'item_c', '', ' colspan="2"');
+        $html .= EEH_HTML::td($line_item->percent().'%', '', 'item_c', '', ' colspan="2"');
         // total td
         $html .= EEH_HTML::td($line_item->total_no_code(), '', 'item_r');
         // end of row

core/libraries/batch/JobHandlerBaseClasses/JobHandlerInterface.php

Indentation +24 added lines, -24 removed lines

@@ -22,30 +22,30 @@
 
 interface JobHandlerInterface
 {
-    /**
-     * Performs any necessary setup for starting the job. This is also a good
-     * place to setup the $job_arguments which will be used for subsequent HTTP requests
-     * when continue_job will be called
-     * @param JobParameters $job_parameters
-     * @throws BatchRequestException
-     * @return JobStepResponse
-     */
-    public function create_job(JobParameters $job_parameters);
+	/**
+	 * Performs any necessary setup for starting the job. This is also a good
+	 * place to setup the $job_arguments which will be used for subsequent HTTP requests
+	 * when continue_job will be called
+	 * @param JobParameters $job_parameters
+	 * @throws BatchRequestException
+	 * @return JobStepResponse
+	 */
+	public function create_job(JobParameters $job_parameters);
 
-    /**
-     * Performs another step of the job
-     * @param JobParameters $job_parameters
-     * @param int $batch_size
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     */
-    public function continue_job(JobParameters $job_parameters, $batch_size = 50);
+	/**
+	 * Performs another step of the job
+	 * @param JobParameters $job_parameters
+	 * @param int $batch_size
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 */
+	public function continue_job(JobParameters $job_parameters, $batch_size = 50);
 
-    /**
-     * Performs any clean-up logic when we know the job is completed
-     * @param JobParameters $job_parameters
-     * @return JobStepResponse
-     * @throws BatchRequestException
-     */
-    public function cleanup_job(JobParameters $job_parameters);
+	/**
+	 * Performs any clean-up logic when we know the job is completed
+	 * @param JobParameters $job_parameters
+	 * @return JobStepResponse
+	 * @throws BatchRequestException
+	 */
+	public function cleanup_job(JobParameters $job_parameters);
 }

core/request_stack/EE_Request.core.php

Indentation +355 added lines, -355 removed lines

@@ -18,359 +18,359 @@
 class EE_Request implements LegacyRequestInterface, InterminableInterface
 {
 
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
-
-    /**
-     * whether current request is for the admin but NOT via AJAX
-     *
-     * @var boolean $admin
-     */
-    public $admin = false;
-
-    /**
-     * whether current request is via AJAX
-     *
-     * @var boolean $ajax
-     */
-    public $ajax = false;
-
-    /**
-     * whether current request is via AJAX from the frontend of the site
-     *
-     * @var boolean $front_ajax
-     */
-    public $front_ajax = false;
-
-
-    /**
-     * @deprecated 4.9.53
-     * @param array $get
-     * @param array $post
-     * @param array $cookie
-     * @param array $server
-     */
-    public function __construct(
-        array $get = array(),
-        array $post = array(),
-        array $cookie = array(),
-        array $server = array()
-    ) {
-    }
-
-
-    /**
-     * @return RequestInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    private function request()
-    {
-        if ($this->request instanceof RequestInterface) {
-            return $this->request;
-        }
-        $loader = LoaderFactory::getLoader();
-        $this->request = $loader->getShared('EventEspresso\core\services\request\RequestInterface');
-        return $this->request;
-    }
-
-
-    /**
-     * @param RequestInterface $request
-     */
-    public function setRequest(RequestInterface $request)
-    {
-        $this->request = $request;
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_params()
-    {
-        return $this->request()->getParams();
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function post_params()
-    {
-        return $this->request()->postParams();
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function cookie_params()
-    {
-        return $this->request()->cookieParams();
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function server_params()
-    {
-        return $this->request()->serverParams();
-    }
-
-
-    /**
-     * returns contents of $_REQUEST
-     *
-     * @deprecated 4.9.53
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function params()
-    {
-        return $this->request()->requestParams();
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @param      $key
-     * @param      $value
-     * @param bool $override_ee
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function set($key, $value, $override_ee = false)
-    {
-        $this->request()->setRequestParam($key, $value, $override_ee);
-    }
-
-
-    /**
-     * returns   the value for a request param if the given key exists
-     *
-     * @deprecated 4.9.53
-     * @param      $key
-     * @param null $default
-     * @return mixed
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get($key, $default = null)
-    {
-        return $this->request()->getRequestParam($key, $default);
-    }
-
-
-    /**
-     * check if param exists
-     *
-     * @deprecated 4.9.53
-     * @param $key
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function is_set($key)
-    {
-        return $this->request()->requestParamIsSet($key);
-    }
-
-
-    /**
-     * remove param
-     *
-     * @deprecated 4.9.53
-     * @param      $key
-     * @param bool $unset_from_global_too
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function un_set($key, $unset_from_global_too = false)
-    {
-        $this->request()->unSetRequestParam($key, $unset_from_global_too);
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function ip_address()
-    {
-        return $this->request()->ipAddress();
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function isAdmin()
-    {
-        return $this->request()->isAdmin();
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @return mixed
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function isAjax()
-    {
-        return $this->request()->isAjax();
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @return mixed
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function isFrontAjax()
-    {
-        return $this->request()->isFrontAjax();
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @return mixed|string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function requestUri()
-    {
-        return $this->request()->requestUri();
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function userAgent()
-    {
-        return $this->request()->userAgent();
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @param string $user_agent
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function setUserAgent($user_agent = '')
-    {
-        $this->request()->setUserAgent($user_agent);
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function isBot()
-    {
-        return $this->request()->isBot();
-    }
-
-
-    /**
-     * @deprecated 4.9.53
-     * @param bool $is_bot
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function setIsBot($is_bot)
-    {
-        $this->request()->setIsBot($is_bot);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
-     * and return the value for the first match found
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     *
-     * @param string     $pattern
-     * @param null|mixed $default
-     * @return false|int
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public function getMatch($pattern, $default = null)
-    {
-        return $this->request()->getMatch($pattern, $default);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     * returns true if a match is found or false if not
-     *
-     * @param string $pattern
-     * @return false|int
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public function matches($pattern)
-    {
-        return $this->request()->matches($pattern);
-    }
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
+
+	/**
+	 * whether current request is for the admin but NOT via AJAX
+	 *
+	 * @var boolean $admin
+	 */
+	public $admin = false;
+
+	/**
+	 * whether current request is via AJAX
+	 *
+	 * @var boolean $ajax
+	 */
+	public $ajax = false;
+
+	/**
+	 * whether current request is via AJAX from the frontend of the site
+	 *
+	 * @var boolean $front_ajax
+	 */
+	public $front_ajax = false;
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @param array $get
+	 * @param array $post
+	 * @param array $cookie
+	 * @param array $server
+	 */
+	public function __construct(
+		array $get = array(),
+		array $post = array(),
+		array $cookie = array(),
+		array $server = array()
+	) {
+	}
+
+
+	/**
+	 * @return RequestInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	private function request()
+	{
+		if ($this->request instanceof RequestInterface) {
+			return $this->request;
+		}
+		$loader = LoaderFactory::getLoader();
+		$this->request = $loader->getShared('EventEspresso\core\services\request\RequestInterface');
+		return $this->request;
+	}
+
+
+	/**
+	 * @param RequestInterface $request
+	 */
+	public function setRequest(RequestInterface $request)
+	{
+		$this->request = $request;
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_params()
+	{
+		return $this->request()->getParams();
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function post_params()
+	{
+		return $this->request()->postParams();
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function cookie_params()
+	{
+		return $this->request()->cookieParams();
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function server_params()
+	{
+		return $this->request()->serverParams();
+	}
+
+
+	/**
+	 * returns contents of $_REQUEST
+	 *
+	 * @deprecated 4.9.53
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function params()
+	{
+		return $this->request()->requestParams();
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @param      $key
+	 * @param      $value
+	 * @param bool $override_ee
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function set($key, $value, $override_ee = false)
+	{
+		$this->request()->setRequestParam($key, $value, $override_ee);
+	}
+
+
+	/**
+	 * returns   the value for a request param if the given key exists
+	 *
+	 * @deprecated 4.9.53
+	 * @param      $key
+	 * @param null $default
+	 * @return mixed
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get($key, $default = null)
+	{
+		return $this->request()->getRequestParam($key, $default);
+	}
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @deprecated 4.9.53
+	 * @param $key
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function is_set($key)
+	{
+		return $this->request()->requestParamIsSet($key);
+	}
+
+
+	/**
+	 * remove param
+	 *
+	 * @deprecated 4.9.53
+	 * @param      $key
+	 * @param bool $unset_from_global_too
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function un_set($key, $unset_from_global_too = false)
+	{
+		$this->request()->unSetRequestParam($key, $unset_from_global_too);
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function ip_address()
+	{
+		return $this->request()->ipAddress();
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function isAdmin()
+	{
+		return $this->request()->isAdmin();
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @return mixed
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function isAjax()
+	{
+		return $this->request()->isAjax();
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @return mixed
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function isFrontAjax()
+	{
+		return $this->request()->isFrontAjax();
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @return mixed|string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function requestUri()
+	{
+		return $this->request()->requestUri();
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function userAgent()
+	{
+		return $this->request()->userAgent();
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @param string $user_agent
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function setUserAgent($user_agent = '')
+	{
+		$this->request()->setUserAgent($user_agent);
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function isBot()
+	{
+		return $this->request()->isBot();
+	}
+
+
+	/**
+	 * @deprecated 4.9.53
+	 * @param bool $is_bot
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function setIsBot($is_bot)
+	{
+		$this->request()->setIsBot($is_bot);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
+	 * and return the value for the first match found
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 *
+	 * @param string     $pattern
+	 * @param null|mixed $default
+	 * @return false|int
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public function getMatch($pattern, $default = null)
+	{
+		return $this->request()->getMatch($pattern, $default);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 * returns true if a match is found or false if not
+	 *
+	 * @param string $pattern
+	 * @return false|int
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public function matches($pattern)
+	{
+		return $this->request()->matches($pattern);
+	}
 }

core/request_stack/EE_Response.core.php

Indentation +142 added lines, -142 removed lines

@@ -13,146 +13,146 @@
 class EE_Response
 {
 
-    /**
-     * @access    protected
-     * @type        array $_notice
-     */
-    protected $_notice = array();
-
-    /**
-     *    rendered output to be returned to WP
-     *
-     * @access    protected
-     * @type        string
-     */
-    protected $_output = '';
-
-    /**
-     * @access    protected
-     * @type        bool
-     */
-    protected $request_terminated = false;
-
-    /**
-     * @access    protected
-     * @type        bool
-     */
-    protected $deactivate_plugin = false;
-
-
-    /**
-     * @deprecated  4.9.53
-     * @return \EE_Response
-     */
-    public function __construct()
-    {
-        $this->terminate_request(false);
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
-                    'event_espresso'
-                ),
-                'EventEspresso\core\services\request\Response',
-                '\core\services\request',
-                'EventEspresso\core\services\request'
-            ),
-            '4.9.53'
-        );
-    }
-
-
-    /**
-     * @deprecated  4.9.53
-     * @param $key
-     * @param $value
-     * @return    void
-     */
-    public function set_notice($key, $value)
-    {
-        $this->_notice[ $key ] = $value;
-    }
-
-
-    /**
-     * @deprecated  4.9.53
-     * @param $key
-     * @return    mixed
-     */
-    public function get_notice($key)
-    {
-        return isset($this->_notice[ $key ]) ? $this->_notice[ $key ] : null;
-    }
-
-
-    /**
-     * @deprecated  4.9.53
-     * @return    array
-     */
-    public function get_notices()
-    {
-        return $this->_notice;
-    }
-
-
-    /**
-     * @deprecated  4.9.53
-     * @param      $string
-     * @param bool $append
-     */
-    public function add_output($string, $append = true)
-    {
-        $this->_output = $append ? $this->_output . $string : $string . $this->_output;
-    }
-
-
-    /**
-     * @deprecated  4.9.53
-     * @return    string
-     */
-    public function get_output()
-    {
-        return $this->_output;
-    }
-
-
-    /**
-     * @deprecated  4.9.53
-     * @return boolean
-     */
-    public function request_terminated()
-    {
-        return $this->request_terminated;
-    }
-
-
-    /**
-     * @deprecated  4.9.53
-     * @param boolean $request_terminated
-     */
-    public function terminate_request($request_terminated = true)
-    {
-        $this->request_terminated = filter_var($request_terminated, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @deprecated  4.9.53
-     * @return boolean
-     */
-    public function plugin_deactivated()
-    {
-        return $this->deactivate_plugin;
-    }
-
-
-    /**
-     * @deprecated  4.9.53
-     * sets $deactivate_plugin to true
-     */
-    public function deactivate_plugin()
-    {
-        $this->deactivate_plugin = true;
-    }
+	/**
+	 * @access    protected
+	 * @type        array $_notice
+	 */
+	protected $_notice = array();
+
+	/**
+	 *    rendered output to be returned to WP
+	 *
+	 * @access    protected
+	 * @type        string
+	 */
+	protected $_output = '';
+
+	/**
+	 * @access    protected
+	 * @type        bool
+	 */
+	protected $request_terminated = false;
+
+	/**
+	 * @access    protected
+	 * @type        bool
+	 */
+	protected $deactivate_plugin = false;
+
+
+	/**
+	 * @deprecated  4.9.53
+	 * @return \EE_Response
+	 */
+	public function __construct()
+	{
+		$this->terminate_request(false);
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
+					'event_espresso'
+				),
+				'EventEspresso\core\services\request\Response',
+				'\core\services\request',
+				'EventEspresso\core\services\request'
+			),
+			'4.9.53'
+		);
+	}
+
+
+	/**
+	 * @deprecated  4.9.53
+	 * @param $key
+	 * @param $value
+	 * @return    void
+	 */
+	public function set_notice($key, $value)
+	{
+		$this->_notice[ $key ] = $value;
+	}
+
+
+	/**
+	 * @deprecated  4.9.53
+	 * @param $key
+	 * @return    mixed
+	 */
+	public function get_notice($key)
+	{
+		return isset($this->_notice[ $key ]) ? $this->_notice[ $key ] : null;
+	}
+
+
+	/**
+	 * @deprecated  4.9.53
+	 * @return    array
+	 */
+	public function get_notices()
+	{
+		return $this->_notice;
+	}
+
+
+	/**
+	 * @deprecated  4.9.53
+	 * @param      $string
+	 * @param bool $append
+	 */
+	public function add_output($string, $append = true)
+	{
+		$this->_output = $append ? $this->_output . $string : $string . $this->_output;
+	}
+
+
+	/**
+	 * @deprecated  4.9.53
+	 * @return    string
+	 */
+	public function get_output()
+	{
+		return $this->_output;
+	}
+
+
+	/**
+	 * @deprecated  4.9.53
+	 * @return boolean
+	 */
+	public function request_terminated()
+	{
+		return $this->request_terminated;
+	}
+
+
+	/**
+	 * @deprecated  4.9.53
+	 * @param boolean $request_terminated
+	 */
+	public function terminate_request($request_terminated = true)
+	{
+		$this->request_terminated = filter_var($request_terminated, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @deprecated  4.9.53
+	 * @return boolean
+	 */
+	public function plugin_deactivated()
+	{
+		return $this->deactivate_plugin;
+	}
+
+
+	/**
+	 * @deprecated  4.9.53
+	 * sets $deactivate_plugin to true
+	 */
+	public function deactivate_plugin()
+	{
+		$this->deactivate_plugin = true;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -71,7 +71,7 @@ 
      */
     public function set_notice($key, $value)
     {
-        $this->_notice[ $key ] = $value;
+        $this->_notice[$key] = $value;
     }
 
 
@@ -82,7 +82,7 @@ 
      */
     public function get_notice($key)
     {
-        return isset($this->_notice[ $key ]) ? $this->_notice[ $key ] : null;
+        return isset($this->_notice[$key]) ? $this->_notice[$key] : null;
     }
 
 
@@ -103,7 +103,7 @@ 
      */
     public function add_output($string, $append = true)
     {
-        $this->_output = $append ? $this->_output . $string : $string . $this->_output;
+        $this->_output = $append ? $this->_output.$string : $string.$this->_output;
     }
 
 

core/request_stack/EE_Request_Stack_Builder.core.php

Indentation +37 added lines, -37 removed lines

@@ -13,46 +13,46 @@
 class EE_Request_Stack_Builder
 {
 
-    /**
-     * EE_Request_Stack_Builder
-     */
-    public function __construct()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
-                    'event_espresso'
-                ),
-                'EventEspresso\core\services\request\RequestStackBuilder',
-                '\core\services\request',
-                'EventEspresso\core\services\request'
-            ),
-            '4.9.53'
-        );
-    }
+	/**
+	 * EE_Request_Stack_Builder
+	 */
+	public function __construct()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
+					'event_espresso'
+				),
+				'EventEspresso\core\services\request\RequestStackBuilder',
+				'\core\services\request',
+				'EventEspresso\core\services\request'
+			),
+			'4.9.53'
+		);
+	}
 
-    /**
-     * @deprecated  4.9.53
-     */
-    public function unshift()
-    {
-    }
+	/**
+	 * @deprecated  4.9.53
+	 */
+	public function unshift()
+	{
+	}
 
 
-    /**
-     * @deprecated  4.9.53
-     */
-    public function push()
-    {
-    }
+	/**
+	 * @deprecated  4.9.53
+	 */
+	public function push()
+	{
+	}
 
 
-    /**
-     * @deprecated  4.9.53
-     */
-    public function resolve(EEI_Request_Decorator $application)
-    {
-    }
+	/**
+	 * @deprecated  4.9.53
+	 */
+	public function resolve(EEI_Request_Decorator $application)
+	{
+	}
 }

core/request_stack/EE_Request_Stack.core.php

Indentation +21 added lines, -21 removed lines

@@ -13,25 +13,25 @@
 {
 
 
-    /**
-     * @deprecated  4.9.53
-     * @param    EEI_Request_Decorator $application
-     * @param    array                 $middlewares
-     */
-    public function __construct(EEI_Request_Decorator $application, $middlewares = array())
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
-                    'event_espresso'
-                ),
-                'EventEspresso\core\services\request\RequestStack',
-                '\core\services\request',
-                'EventEspresso\core\services\request'
-            ),
-            '4.9.53'
-        );
-    }
+	/**
+	 * @deprecated  4.9.53
+	 * @param    EEI_Request_Decorator $application
+	 * @param    array                 $middlewares
+	 */
+	public function __construct(EEI_Request_Decorator $application, $middlewares = array())
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
+					'event_espresso'
+				),
+				'EventEspresso\core\services\request\RequestStack',
+				'\core\services\request',
+				'EventEspresso\core\services\request'
+			),
+			'4.9.53'
+		);
+	}
 }

core/EES_Shortcode.shortcode.php

Indentation +180 added lines, -180 removed lines

@@ -12,184 +12,184 @@
 abstract class EES_Shortcode extends EE_Base
 {
 
-    /**
-     * @protected   public
-     * @var     array $_attributes
-     */
-    protected $_attributes = array();
-
-
-
-    /**
-     * class constructor - should ONLY be instantiated by EE_Front_Controller
-     */
-    final public function __construct()
-    {
-        $shortcode = LegacyShortcodesManager::generateShortcodeTagFromClassName(get_class($this));
-        // assign shortcode to the preferred callback, which overwrites the "fallback shortcode processor" assigned earlier
-        add_shortcode($shortcode, array($this, 'process_shortcode'));
-        // make sure system knows this is an EE page
-        EE_Registry::instance()->REQ->set_espresso_page(true);
-    }
-
-
-
-    /**
-     * run - initial shortcode module setup called during "parse_request" hook by
-     * \EE_Front_Controller::_initialize_shortcodes() IF this shortcode is going to execute during this request !
-     * It may also get called by \EES_Shortcode::fallback_shortcode_processor() if the shortcode is being implemented
-     * by a theme or plugin in a non-standard way.
-     * Basically this method is primarily used for loading resources and assets like CSS or JS
-     * that will be required by the shortcode when it is actually processed.
-     * Please note that assets may not load if the fallback_shortcode_processor() is being used.
-     *
-     * @access    public
-     * @param WP $WP
-     * @return    void
-     */
-    abstract public function run(WP $WP);
-
-
-
-    /**
-     *  process_shortcode
-     *  this method is the callback function for the actual shortcode, and is what runs when WP encounters the shortcode within the_content
-     *
-     *  @access     public
-     *  @param      array   $attributes
-     *  @return     mixed
-     */
-    abstract public function process_shortcode($attributes = array());
-
-
-
-    /**
-     *    instance - returns instance of child class object
-     *
-     * @access  public
-     * @param   string $shortcode_class
-     * @return  \EES_Shortcode
-     */
-    final public static function instance($shortcode_class = null)
-    {
-        $shortcode_class = ! empty($shortcode_class) ? $shortcode_class : get_called_class();
-        if ($shortcode_class === 'EES_Shortcode' || empty($shortcode_class)) {
-            return null;
-        }
-        $shortcode = str_replace('EES_', '', strtoupper($shortcode_class));
-        $shortcode_obj = isset(EE_Registry::instance()->shortcodes->{$shortcode})
-            ? EE_Registry::instance()->shortcodes->{$shortcode}
-            : null;
-        return $shortcode_obj instanceof $shortcode_class || $shortcode_class === 'self'
-            ? $shortcode_obj
-            : new $shortcode_class();
-    }
-
-
-
-
-    /**
-     *    fallback_shortcode_processor - create instance and call process_shortcode
-     *    NOTE: shortcode may not function perfectly dues to missing assets, but it's better than not having things work at all
-     *
-     * @access  public
-     * @param   $attributes
-     * @return  mixed
-     */
-    final public static function fallback_shortcode_processor($attributes)
-    {
-        if (EE_Maintenance_Mode::disable_frontend_for_maintenance()) {
-            return null;
-        }
-        // what shortcode was actually parsed ?
-        $shortcode_class = get_called_class();
-        // notify rest of system that fallback processor was triggered
-        add_filter('FHEE__fallback_shortcode_processor__' . $shortcode_class, '__return_true');
-        // get instance of actual shortcode
-        $shortcode_obj = self::instance($shortcode_class);
-        // verify class
-        if ($shortcode_obj instanceof EES_Shortcode) {
-            global $wp;
-            $shortcode_obj->run($wp);
-            // set attributes and run the shortcode
-            $shortcode_obj->_attributes = (array) $attributes;
-            return $shortcode_obj->process_shortcode($shortcode_obj->_attributes);
-        } else {
-            return null;
-        }
-    }
-
-
-
-
-    /**
-     *    invalid_shortcode_processor -  used in cases where we know the shortcode is invalid, most likely due to a deactivated addon, and simply returns an empty string
-     *
-     * @access  public
-     * @param   $attributes
-     * @return  string
-     */
-    final public static function invalid_shortcode_processor($attributes)
-    {
-        return '';
-    }
-
-
-
-
-
-    /**
-     * Performs basic sanitization on shortcode attributes
-     * Since incoming attributes from the shortcode usage in the WP editor will all be strings,
-     * most attributes will by default be sanitized using the sanitize_text_field() function.
-     * This can be overridden by supplying an array for the $custom_sanitization param,
-     * where keys match keys in your attributes array,
-     * and values represent the sanitization function you wish to be applied to that attribute.
-     * So for example, if you had an integer attribute named "event_id"
-     * that you wanted to be sanitized using absint(),
-     * then you would pass the following for your $custom_sanitization array:
-     *      array('event_id' => 'absint')
-     * all other attributes would be sanitized using the defaults in the switch statement below
-     *
-     * @param array $attributes
-     * @param array $custom_sanitization
-     * @return array
-     */
-    public static function sanitize_attributes(array $attributes, $custom_sanitization = array())
-    {
-        foreach ($attributes as $key => $value) {
-            // is a custom sanitization callback specified ?
-            if (isset($custom_sanitization[ $key ])) {
-                $callback = $custom_sanitization[ $key ];
-                if ($callback === 'skip_sanitization') {
-                    $attributes[ $key ] = $value;
-                    continue;
-                } elseif (function_exists($callback)) {
-                    $attributes[ $key ] = $callback($value);
-                    continue;
-                }
-            }
-            switch (true) {
-                case $value === null:
-                case is_int($value):
-                case is_float($value):
-                    // typical booleans
-                case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true):
-                    $attributes[ $key ] = $value;
-                    break;
-                case is_string($value):
-                    $attributes[ $key ] = sanitize_text_field($value);
-                    break;
-                case is_array($value):
-                    $attributes[ $key ] = \EES_Shortcode::sanitize_attributes($value);
-                    break;
-                default:
-                    // only remaining data types are Object and Resource
-                    // which are not allowed as shortcode attributes
-                    $attributes[ $key ] = null;
-                    break;
-            }
-        }
-        return $attributes;
-    }
+	/**
+	 * @protected   public
+	 * @var     array $_attributes
+	 */
+	protected $_attributes = array();
+
+
+
+	/**
+	 * class constructor - should ONLY be instantiated by EE_Front_Controller
+	 */
+	final public function __construct()
+	{
+		$shortcode = LegacyShortcodesManager::generateShortcodeTagFromClassName(get_class($this));
+		// assign shortcode to the preferred callback, which overwrites the "fallback shortcode processor" assigned earlier
+		add_shortcode($shortcode, array($this, 'process_shortcode'));
+		// make sure system knows this is an EE page
+		EE_Registry::instance()->REQ->set_espresso_page(true);
+	}
+
+
+
+	/**
+	 * run - initial shortcode module setup called during "parse_request" hook by
+	 * \EE_Front_Controller::_initialize_shortcodes() IF this shortcode is going to execute during this request !
+	 * It may also get called by \EES_Shortcode::fallback_shortcode_processor() if the shortcode is being implemented
+	 * by a theme or plugin in a non-standard way.
+	 * Basically this method is primarily used for loading resources and assets like CSS or JS
+	 * that will be required by the shortcode when it is actually processed.
+	 * Please note that assets may not load if the fallback_shortcode_processor() is being used.
+	 *
+	 * @access    public
+	 * @param WP $WP
+	 * @return    void
+	 */
+	abstract public function run(WP $WP);
+
+
+
+	/**
+	 *  process_shortcode
+	 *  this method is the callback function for the actual shortcode, and is what runs when WP encounters the shortcode within the_content
+	 *
+	 *  @access     public
+	 *  @param      array   $attributes
+	 *  @return     mixed
+	 */
+	abstract public function process_shortcode($attributes = array());
+
+
+
+	/**
+	 *    instance - returns instance of child class object
+	 *
+	 * @access  public
+	 * @param   string $shortcode_class
+	 * @return  \EES_Shortcode
+	 */
+	final public static function instance($shortcode_class = null)
+	{
+		$shortcode_class = ! empty($shortcode_class) ? $shortcode_class : get_called_class();
+		if ($shortcode_class === 'EES_Shortcode' || empty($shortcode_class)) {
+			return null;
+		}
+		$shortcode = str_replace('EES_', '', strtoupper($shortcode_class));
+		$shortcode_obj = isset(EE_Registry::instance()->shortcodes->{$shortcode})
+			? EE_Registry::instance()->shortcodes->{$shortcode}
+			: null;
+		return $shortcode_obj instanceof $shortcode_class || $shortcode_class === 'self'
+			? $shortcode_obj
+			: new $shortcode_class();
+	}
+
+
+
+
+	/**
+	 *    fallback_shortcode_processor - create instance and call process_shortcode
+	 *    NOTE: shortcode may not function perfectly dues to missing assets, but it's better than not having things work at all
+	 *
+	 * @access  public
+	 * @param   $attributes
+	 * @return  mixed
+	 */
+	final public static function fallback_shortcode_processor($attributes)
+	{
+		if (EE_Maintenance_Mode::disable_frontend_for_maintenance()) {
+			return null;
+		}
+		// what shortcode was actually parsed ?
+		$shortcode_class = get_called_class();
+		// notify rest of system that fallback processor was triggered
+		add_filter('FHEE__fallback_shortcode_processor__' . $shortcode_class, '__return_true');
+		// get instance of actual shortcode
+		$shortcode_obj = self::instance($shortcode_class);
+		// verify class
+		if ($shortcode_obj instanceof EES_Shortcode) {
+			global $wp;
+			$shortcode_obj->run($wp);
+			// set attributes and run the shortcode
+			$shortcode_obj->_attributes = (array) $attributes;
+			return $shortcode_obj->process_shortcode($shortcode_obj->_attributes);
+		} else {
+			return null;
+		}
+	}
+
+
+
+
+	/**
+	 *    invalid_shortcode_processor -  used in cases where we know the shortcode is invalid, most likely due to a deactivated addon, and simply returns an empty string
+	 *
+	 * @access  public
+	 * @param   $attributes
+	 * @return  string
+	 */
+	final public static function invalid_shortcode_processor($attributes)
+	{
+		return '';
+	}
+
+
+
+
+
+	/**
+	 * Performs basic sanitization on shortcode attributes
+	 * Since incoming attributes from the shortcode usage in the WP editor will all be strings,
+	 * most attributes will by default be sanitized using the sanitize_text_field() function.
+	 * This can be overridden by supplying an array for the $custom_sanitization param,
+	 * where keys match keys in your attributes array,
+	 * and values represent the sanitization function you wish to be applied to that attribute.
+	 * So for example, if you had an integer attribute named "event_id"
+	 * that you wanted to be sanitized using absint(),
+	 * then you would pass the following for your $custom_sanitization array:
+	 *      array('event_id' => 'absint')
+	 * all other attributes would be sanitized using the defaults in the switch statement below
+	 *
+	 * @param array $attributes
+	 * @param array $custom_sanitization
+	 * @return array
+	 */
+	public static function sanitize_attributes(array $attributes, $custom_sanitization = array())
+	{
+		foreach ($attributes as $key => $value) {
+			// is a custom sanitization callback specified ?
+			if (isset($custom_sanitization[ $key ])) {
+				$callback = $custom_sanitization[ $key ];
+				if ($callback === 'skip_sanitization') {
+					$attributes[ $key ] = $value;
+					continue;
+				} elseif (function_exists($callback)) {
+					$attributes[ $key ] = $callback($value);
+					continue;
+				}
+			}
+			switch (true) {
+				case $value === null:
+				case is_int($value):
+				case is_float($value):
+					// typical booleans
+				case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true):
+					$attributes[ $key ] = $value;
+					break;
+				case is_string($value):
+					$attributes[ $key ] = sanitize_text_field($value);
+					break;
+				case is_array($value):
+					$attributes[ $key ] = \EES_Shortcode::sanitize_attributes($value);
+					break;
+				default:
+					// only remaining data types are Object and Resource
+					// which are not allowed as shortcode attributes
+					$attributes[ $key ] = null;
+					break;
+			}
+		}
+		return $attributes;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -104,7 +104,7 @@ 
         // what shortcode was actually parsed ?
         $shortcode_class = get_called_class();
         // notify rest of system that fallback processor was triggered
-        add_filter('FHEE__fallback_shortcode_processor__' . $shortcode_class, '__return_true');
+        add_filter('FHEE__fallback_shortcode_processor__'.$shortcode_class, '__return_true');
         // get instance of actual shortcode
         $shortcode_obj = self::instance($shortcode_class);
         // verify class
@@ -159,13 +159,13 @@ 
     {
         foreach ($attributes as $key => $value) {
             // is a custom sanitization callback specified ?
-            if (isset($custom_sanitization[ $key ])) {
-                $callback = $custom_sanitization[ $key ];
+            if (isset($custom_sanitization[$key])) {
+                $callback = $custom_sanitization[$key];
                 if ($callback === 'skip_sanitization') {
-                    $attributes[ $key ] = $value;
+                    $attributes[$key] = $value;
                     continue;
                 } elseif (function_exists($callback)) {
-                    $attributes[ $key ] = $callback($value);
+                    $attributes[$key] = $callback($value);
                     continue;
                 }
             }
@@ -175,18 +175,18 @@ 
                 case is_float($value):
                     // typical booleans
                 case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true):
-                    $attributes[ $key ] = $value;
+                    $attributes[$key] = $value;
                     break;
                 case is_string($value):
-                    $attributes[ $key ] = sanitize_text_field($value);
+                    $attributes[$key] = sanitize_text_field($value);
                     break;
                 case is_array($value):
-                    $attributes[ $key ] = \EES_Shortcode::sanitize_attributes($value);
+                    $attributes[$key] = \EES_Shortcode::sanitize_attributes($value);
                     break;
                 default:
                     // only remaining data types are Object and Resource
                     // which are not allowed as shortcode attributes
-                    $attributes[ $key ] = null;
+                    $attributes[$key] = null;
                     break;
             }
         }