eventespresso / event-espresso-core

core/db_classes/EE_Question_Group_Question.class.php

Indentation +17 added lines, -17 removed lines

@@ -6,23 +6,23 @@
 class EE_Question_Group_Question extends EE_Base_Class
 {
 
-    /**
-     * @param array $props_n_values
-     * @return EE_Question_Group_Question|mixed
-     */
-    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_Question_Group_Question|mixed
+	 */
+	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_Question_Group_Question
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_Question_Group_Question
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
 }

core/db_classes/EE_State.class.php

Indentation +100 added lines, -100 removed lines

@@ -11,104 +11,104 @@
 class EE_State extends EE_Base_Class
 {
 
-    /**
-     * @param array $props_n_values
-     * @return EE_State|mixed
-     */
-    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_State
-     */
-    public static function new_instance_from_db($props_n_values = array())
-    {
-        return new self($props_n_values, true);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function country_iso()
-    {
-        return $this->get('CNT_ISO');
-    }
-
-
-    /**
-     * @return string
-     */
-    public function abbrev()
-    {
-        return $this->get('STA_abbrev');
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function active()
-    {
-        return $this->get('STA_active');
-    }
-
-
-    /**
-     * @return string
-     */
-    public function name()
-    {
-        return $this->get('STA_name');
-    }
-
-
-    /**
-     * @return EE_Country
-     */
-    public function country()
-    {
-        return $this->get_first_related('Country');
-    }
-
-
-    /**
-     * @param $iso
-     */
-    public function set_country_iso($iso)
-    {
-        $this->set('CNT_ISO', $iso);
-    }
-
-
-    /**
-     * @param $abbrev
-     */
-    public function set_abbrev($abbrev)
-    {
-        $this->set('STA_abbrev', $abbrev);
-    }
-
-
-    /**
-     * @param $active
-     */
-    public function set_active($active)
-    {
-        $this->set('STA_active', $active);
-    }
-
-
-    /**
-     * @param $name
-     */
-    public function set_name($name)
-    {
-        $this->set('STA_name', $name);
-    }
+	/**
+	 * @param array $props_n_values
+	 * @return EE_State|mixed
+	 */
+	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_State
+	 */
+	public static function new_instance_from_db($props_n_values = array())
+	{
+		return new self($props_n_values, true);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function country_iso()
+	{
+		return $this->get('CNT_ISO');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function abbrev()
+	{
+		return $this->get('STA_abbrev');
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function active()
+	{
+		return $this->get('STA_active');
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function name()
+	{
+		return $this->get('STA_name');
+	}
+
+
+	/**
+	 * @return EE_Country
+	 */
+	public function country()
+	{
+		return $this->get_first_related('Country');
+	}
+
+
+	/**
+	 * @param $iso
+	 */
+	public function set_country_iso($iso)
+	{
+		$this->set('CNT_ISO', $iso);
+	}
+
+
+	/**
+	 * @param $abbrev
+	 */
+	public function set_abbrev($abbrev)
+	{
+		$this->set('STA_abbrev', $abbrev);
+	}
+
+
+	/**
+	 * @param $active
+	 */
+	public function set_active($active)
+	{
+		$this->set('STA_active', $active);
+	}
+
+
+	/**
+	 * @param $name
+	 */
+	public function set_name($name)
+	{
+		$this->set('STA_name', $name);
+	}
 }

core/libraries/line_item_filters/EE_Line_Item_Filter_Processor.class.php

Indentation +75 added lines, -75 removed lines

@@ -36,88 +36,88 @@
 class EE_Line_Item_Filter_Processor
 {
 
-    /**
-     * @type EE_Line_Item_Filter_Collection $line_item_filters
-     */
-    protected $line_item_filters;
+	/**
+	 * @type EE_Line_Item_Filter_Collection $line_item_filters
+	 */
+	protected $line_item_filters;
 
-    /**
-     * @type EEI_Line_Item $grand_total_line_item
-     */
-    protected $grand_total_line_item;
+	/**
+	 * @type EEI_Line_Item $grand_total_line_item
+	 */
+	protected $grand_total_line_item;
 
 
-    /**
-     * EE_Line_Item_Filter_Processor constructor.
-     *
-     * @param \EE_Line_Item_Filter_Collection $line_item_filters
-     * @param \EEI_Line_Item                  $grand_total_line_item
-     * @throws \EE_Error
-     */
-    public function __construct(EE_Line_Item_Filter_Collection $line_item_filters, EEI_Line_Item $grand_total_line_item)
-    {
-        $this->line_item_filters = $line_item_filters;
-        if ($grand_total_line_item->type() !== EEM_Line_Item::type_total) {
-            throw new EE_Error(__('A Line Item of the type total is required', 'event_espresso'));
-        }
-        $this->grand_total_line_item = $this->clone_and_reset_line_item_tree($grand_total_line_item);
-    }
+	/**
+	 * EE_Line_Item_Filter_Processor constructor.
+	 *
+	 * @param \EE_Line_Item_Filter_Collection $line_item_filters
+	 * @param \EEI_Line_Item                  $grand_total_line_item
+	 * @throws \EE_Error
+	 */
+	public function __construct(EE_Line_Item_Filter_Collection $line_item_filters, EEI_Line_Item $grand_total_line_item)
+	{
+		$this->line_item_filters = $line_item_filters;
+		if ($grand_total_line_item->type() !== EEM_Line_Item::type_total) {
+			throw new EE_Error(__('A Line Item of the type total is required', 'event_espresso'));
+		}
+		$this->grand_total_line_item = $this->clone_and_reset_line_item_tree($grand_total_line_item);
+	}
 
 
-    /**
-     * clone_and_reset_line_item_tree
-     *
-     * @param \EEI_Line_Item $line_item
-     * @return \EEI_Line_Item
-     */
-    protected function clone_and_reset_line_item_tree(EEI_Line_Item $line_item)
-    {
-        $cloned_line_item = $this->clone_and_reset_line_item($line_item);
-        foreach ($line_item->children() as $child_line_item) {
-            $cloned_line_item->add_child_line_item($this->clone_and_reset_line_item_tree($child_line_item));
-        }
-        return $cloned_line_item;
-    }
+	/**
+	 * clone_and_reset_line_item_tree
+	 *
+	 * @param \EEI_Line_Item $line_item
+	 * @return \EEI_Line_Item
+	 */
+	protected function clone_and_reset_line_item_tree(EEI_Line_Item $line_item)
+	{
+		$cloned_line_item = $this->clone_and_reset_line_item($line_item);
+		foreach ($line_item->children() as $child_line_item) {
+			$cloned_line_item->add_child_line_item($this->clone_and_reset_line_item_tree($child_line_item));
+		}
+		return $cloned_line_item;
+	}
 
 
-    /**
-     * clone_and_reset_line_item
-     *
-     * clones the incoming object
-     * resets any fields that represent database primary keys
-     * resets total
-     *
-     * @param \EEI_Line_Item $line_item
-     * @return \EEI_Line_Item
-     */
-    protected function clone_and_reset_line_item(EEI_Line_Item $line_item)
-    {
-        // we don't actually want to work with the original line item, so clone it
-        $cloned_line_item = clone $line_item;
-        $cloned_line_item->set('LIN_ID', null);
-        $cloned_line_item->set('LIN_parent', null);
-        $cloned_line_item->clear_related_line_item_cache();
-        foreach (array_keys(EEM_Line_Item::instance()->relation_settings()) as $relation_name) {
-            $cloned_line_item->clear_cache($relation_name, null, true);
-        }
-        $cloned_line_item->set_allow_persist(false);
-        return $cloned_line_item;
-    }
+	/**
+	 * clone_and_reset_line_item
+	 *
+	 * clones the incoming object
+	 * resets any fields that represent database primary keys
+	 * resets total
+	 *
+	 * @param \EEI_Line_Item $line_item
+	 * @return \EEI_Line_Item
+	 */
+	protected function clone_and_reset_line_item(EEI_Line_Item $line_item)
+	{
+		// we don't actually want to work with the original line item, so clone it
+		$cloned_line_item = clone $line_item;
+		$cloned_line_item->set('LIN_ID', null);
+		$cloned_line_item->set('LIN_parent', null);
+		$cloned_line_item->clear_related_line_item_cache();
+		foreach (array_keys(EEM_Line_Item::instance()->relation_settings()) as $relation_name) {
+			$cloned_line_item->clear_cache($relation_name, null, true);
+		}
+		$cloned_line_item->set_allow_persist(false);
+		return $cloned_line_item;
+	}
 
 
-    /**
-     * process
-     *
-     * @return EEI_Line_Item
-     */
-    public function process()
-    {
-        $this->line_item_filters->rewind();
-        while ($this->line_item_filters->valid()) {
-            $this->grand_total_line_item = $this->line_item_filters->current()->process($this->grand_total_line_item);
-            $this->line_item_filters->next();
-        }
-        $this->grand_total_line_item->recalculate_total_including_taxes();
-        return $this->grand_total_line_item;
-    }
+	/**
+	 * process
+	 *
+	 * @return EEI_Line_Item
+	 */
+	public function process()
+	{
+		$this->line_item_filters->rewind();
+		while ($this->line_item_filters->valid()) {
+			$this->grand_total_line_item = $this->line_item_filters->current()->process($this->grand_total_line_item);
+			$this->line_item_filters->next();
+		}
+		$this->grand_total_line_item->recalculate_total_including_taxes();
+		return $this->grand_total_line_item;
+	}
 }

core/libraries/line_item_filters/EE_Non_Zero_Line_Item_Filter.class.php

Spacing +2 added lines, -2 removed lines

@@ -32,7 +32,7 @@ 
     public function process(EEI_Line_Item $line_item)
     {
         $non_zero_line_item = $this->_filter_zero_line_item($line_item);
-        if (! $non_zero_line_item instanceof EEI_Line_Item) {
+        if ( ! $non_zero_line_item instanceof EEI_Line_Item) {
             return null;
         }
         // if this is an event subtotal, we want to only include it if it
@@ -42,7 +42,7 @@ 
             foreach ($line_item->children() as $child_line_item) {
                 $code = $child_line_item->code();
                 $child_line_item = $this->process($child_line_item);
-                if (! $child_line_item instanceof EEI_Line_Item) {
+                if ( ! $child_line_item instanceof EEI_Line_Item) {
                     $line_item->delete_child_line_item($code);
                     continue;
                 }

Indentation +89 added lines, -89 removed lines

@@ -14,99 +14,99 @@
 class EE_Non_Zero_Line_Item_Filter extends EE_Line_Item_Filter_Base
 {
 
-    /**
-     * EE_Non_Zero_Line_Item_Filter constructor.
-     */
-    public function __construct()
-    {
-    }
+	/**
+	 * EE_Non_Zero_Line_Item_Filter constructor.
+	 */
+	public function __construct()
+	{
+	}
 
 
-    /**
-     * Creates a duplicate of the line item tree, except only includes billable items
-     * and the portion of line items attributed to billable things
-     *
-     * @param EEI_Line_Item $line_item
-     * @return EEI_Line_Item
-     */
-    public function process(EEI_Line_Item $line_item)
-    {
-        $non_zero_line_item = $this->_filter_zero_line_item($line_item);
-        if (! $non_zero_line_item instanceof EEI_Line_Item) {
-            return null;
-        }
-        // if this is an event subtotal, we want to only include it if it
-        // has a non-zero total and at least one ticket line item child
-        if ($line_item->children()) {
-            $ticket_or_subtotals_with_tkt_children_count = 0;
-            foreach ($line_item->children() as $child_line_item) {
-                $code = $child_line_item->code();
-                $child_line_item = $this->process($child_line_item);
-                if (! $child_line_item instanceof EEI_Line_Item) {
-                    $line_item->delete_child_line_item($code);
-                    continue;
-                }
-                if (
-                    (
-                        $child_line_item instanceof EEI_Line_Item
-                        && $child_line_item->type() === EEM_Line_Item::type_sub_total
-                    )
-                    || (
-                        $child_line_item instanceof EEI_Line_Item
-                        && $child_line_item->type() === EEM_Line_Item::type_line_item
-                        && $child_line_item->OBJ_type() === 'Ticket'
-                    )
-                ) {
-                    $ticket_or_subtotals_with_tkt_children_count++;
-                }
-            }
-            // if this is an event subtotal with NO ticket children
-            // we basically want to ignore it
-            return $this->_filter_zero_subtotal_line_item(
-                $non_zero_line_item,
-                $ticket_or_subtotals_with_tkt_children_count
-            );
-        }
-        return $non_zero_line_item;
-    }
+	/**
+	 * Creates a duplicate of the line item tree, except only includes billable items
+	 * and the portion of line items attributed to billable things
+	 *
+	 * @param EEI_Line_Item $line_item
+	 * @return EEI_Line_Item
+	 */
+	public function process(EEI_Line_Item $line_item)
+	{
+		$non_zero_line_item = $this->_filter_zero_line_item($line_item);
+		if (! $non_zero_line_item instanceof EEI_Line_Item) {
+			return null;
+		}
+		// if this is an event subtotal, we want to only include it if it
+		// has a non-zero total and at least one ticket line item child
+		if ($line_item->children()) {
+			$ticket_or_subtotals_with_tkt_children_count = 0;
+			foreach ($line_item->children() as $child_line_item) {
+				$code = $child_line_item->code();
+				$child_line_item = $this->process($child_line_item);
+				if (! $child_line_item instanceof EEI_Line_Item) {
+					$line_item->delete_child_line_item($code);
+					continue;
+				}
+				if (
+					(
+						$child_line_item instanceof EEI_Line_Item
+						&& $child_line_item->type() === EEM_Line_Item::type_sub_total
+					)
+					|| (
+						$child_line_item instanceof EEI_Line_Item
+						&& $child_line_item->type() === EEM_Line_Item::type_line_item
+						&& $child_line_item->OBJ_type() === 'Ticket'
+					)
+				) {
+					$ticket_or_subtotals_with_tkt_children_count++;
+				}
+			}
+			// if this is an event subtotal with NO ticket children
+			// we basically want to ignore it
+			return $this->_filter_zero_subtotal_line_item(
+				$non_zero_line_item,
+				$ticket_or_subtotals_with_tkt_children_count
+			);
+		}
+		return $non_zero_line_item;
+	}
 
 
-    /**
-     * Creates a new, unsaved line item, but if it's a ticket line item
-     * with a total of 0, or a subtotal of 0, returns null instead
-     *
-     * @param EEI_Line_Item $line_item
-     * @return EEI_Line_Item
-     */
-    protected function _filter_zero_line_item(EEI_Line_Item $line_item)
-    {
-        if (
-            $line_item->type() === EEM_Line_Item::type_line_item
-            && $line_item->OBJ_type() === 'Ticket'
-            && (int) $line_item->quantity() === 0
-        ) {
-            return null;
-        }
-        return $line_item;
-    }
+	/**
+	 * Creates a new, unsaved line item, but if it's a ticket line item
+	 * with a total of 0, or a subtotal of 0, returns null instead
+	 *
+	 * @param EEI_Line_Item $line_item
+	 * @return EEI_Line_Item
+	 */
+	protected function _filter_zero_line_item(EEI_Line_Item $line_item)
+	{
+		if (
+			$line_item->type() === EEM_Line_Item::type_line_item
+			&& $line_item->OBJ_type() === 'Ticket'
+			&& (int) $line_item->quantity() === 0
+		) {
+			return null;
+		}
+		return $line_item;
+	}
 
 
-    /**
-     * Creates a new, unsaved line item, but if it's a ticket line item
-     * with a total of 0, or a subtotal of 0, returns null instead
-     *
-     * @param EEI_Line_Item $line_item
-     * @param int           $ticket_children
-     * @return EEI_Line_Item
-     */
-    protected function _filter_zero_subtotal_line_item(EEI_Line_Item $line_item, $ticket_children = 0)
-    {
-        if (
-            (int) $ticket_children === 0
-            && $line_item->type() === EEM_Line_Item::type_sub_total
-        ) {
-            return null;
-        }
-        return $line_item;
-    }
+	/**
+	 * Creates a new, unsaved line item, but if it's a ticket line item
+	 * with a total of 0, or a subtotal of 0, returns null instead
+	 *
+	 * @param EEI_Line_Item $line_item
+	 * @param int           $ticket_children
+	 * @return EEI_Line_Item
+	 */
+	protected function _filter_zero_subtotal_line_item(EEI_Line_Item $line_item, $ticket_children = 0)
+	{
+		if (
+			(int) $ticket_children === 0
+			&& $line_item->type() === EEM_Line_Item::type_sub_total
+		) {
+			return null;
+		}
+		return $line_item;
+	}
 }

core/libraries/line_item_filters/EE_Line_Item_Filter_Collection.class.php

Indentation +7 added lines, -7 removed lines

@@ -18,11 +18,11 @@
 {
 
 
-    /**
-     * EE_Line_Item_Filter_Collection constructor.
-     */
-    public function __construct()
-    {
-        $this->interface = 'EEI_Line_Item_Filter';
-    }
+	/**
+	 * EE_Line_Item_Filter_Collection constructor.
+	 */
+	public function __construct()
+	{
+		$this->interface = 'EEI_Line_Item_Filter';
+	}
 }

core/libraries/line_item_filters/EE_Line_Item_Filter_Base.class.php

Indentation +10 added lines, -10 removed lines

@@ -16,14 +16,14 @@
 {
 
 
-    /**
-     * process
-     *
-     * @param \EEI_Line_Item $line_item
-     * @return \EEI_Line_Item
-     */
-    public function process(EEI_Line_Item $line_item)
-    {
-        return $line_item;
-    }
+	/**
+	 * process
+	 *
+	 * @param \EEI_Line_Item $line_item
+	 * @return \EEI_Line_Item
+	 */
+	public function process(EEI_Line_Item $line_item)
+	{
+		return $line_item;
+	}
 }

core/libraries/line_item_filters/EE_Single_Registration_Line_Item_Filter.class.php

Indentation +8 added lines, -8 removed lines

@@ -16,12 +16,12 @@
 class EE_Single_Registration_Line_Item_Filter extends EE_Specific_Registrations_Line_Item_Filter
 {
 
-    /**
-     *
-     * @param EE_Registration $registration
-     */
-    public function __construct($registration)
-    {
-        parent::__construct(array($registration));
-    }
+	/**
+	 *
+	 * @param EE_Registration $registration
+	 */
+	public function __construct($registration)
+	{
+		parent::__construct(array($registration));
+	}
 }

core/libraries/template_parts/EE_Template_Part_Manager.class.php

Indentation +191 added lines, -191 removed lines

@@ -14,195 +14,195 @@
 class EE_Template_Part_Manager
 {
 
-    /**
-     * @param EE_Template_Part_PriorityQueue $template_parts
-     */
-    protected $template_parts;
-
-    /**
-     * @param array $priorities
-     */
-    protected $priorities = array();
-
-    /**
-     * @param int $event_desc_priority
-     */
-    protected $event_desc_priority;
-
-    /**
-     * @param string $before_event_content
-     */
-    protected $before_event_content;
-
-    /**
-     * @param string $event_content
-     */
-    protected $event_content;
-
-    /**
-     * @param string $after_event_content
-     */
-    protected $after_event_content;
-
-
-    /**
-     *    class constructor
-     */
-    public function __construct()
-    {
-        $this->template_parts = new EE_Template_Part_PriorityQueue();
-    }
-
-
-    /**
-     *    add_template_part
-     *
-     *    used for setting the details about a particular template part
-     *
-     * @param string $name     - just a simple string identifier - do NOT use 'event'
-     * @param string $label    - template part label displayed in admin
-     * @param string $template - name or path of template to be used by EEH_Template::locate_template()
-     * @param int    $priority - order in which template parts should be applied
-     */
-    public function add_template_part($name, $label, $template, $priority)
-    {
-        // SplPriorityQueue doesn't play nice with multiple items having the same priority
-        // so if the incoming priority is already occupied, then let's increment it by one,
-        // and then pass everything back into this method and try again with the new priority
-        if (isset($this->priorities[ $priority ])) {
-            $priority++;
-            $this->add_template_part($name, $label, $template, $priority);
-            return;
-        }
-        // kk now we can mark this priority as being occupied
-        $this->priorities[ $priority ] = true;
-        // create the template part and add to the queue
-        $this->template_parts->insert(
-            new EE_Template_Part($name, $label, $template, $priority),
-            $priority
-        );
-        if ($name === 'event') {
-            $this->event_desc_priority = $priority;
-        }
-    }
-
-
-    /**
-     *    apply_template_part_filters
-     *
-     *    adds template parts to the supplied content
-     *    according to the details set when the template parts were added
-     *
-     * @access public
-     * @param string $content
-     * @return string
-     */
-    public function apply_template_part_filters($content = '')
-    {
-        $this->template_parts->rewind();
-        // loop through template parts and position content
-        while ($this->template_parts->valid()) {
-            $this->_position_template_part(
-                $content,
-                $this->template_parts->current()->template(),
-                $this->template_parts->current()->priority()
-            );
-            $this->template_parts->next();
-        }
-        // now simply add our three strings of content together
-        return $this->before_event_content . $this->event_content . $this->after_event_content;
-    }
-
-
-    /**
-     *    position_template_part
-     *
-     * based on the priority of the incoming template part
-     * relative to the known event description template part priority,
-     * this method will assign template parts to one of the following:
-     *        $this->before_event_content
-     *        $this->event_content
-     *        $this->after_event_content
-     *
-     * @access protected
-     * @param string $content
-     * @param string $template
-     * @param int    $priority
-     * @return void
-     */
-    protected function _position_template_part($content, $template, $priority)
-    {
-        // Event Description content is the actual incoming content itself
-        if ($priority === $this->event_desc_priority) {
-            $this->event_content = $content;
-        } elseif ($priority < $this->event_desc_priority) {
-            // everything BEFORE the Event Description
-            $this->before_event_content .= EEH_Template::locate_template($template);
-        } elseif ($priority > $this->event_desc_priority) {
-            // everything AFTER the Event Description
-            $this->after_event_content .= EEH_Template::locate_template($template);
-        }
-    }
-
-
-    /**
-     *    generate_sortable_list_of_template_parts
-     *
-     *    creates an HTML list (<ul>) with list items (<li>) for each template part,
-     *    in a format that can be used as a sortable list in the admin
-     *
-     * @access public
-     * @param string $list_css_id
-     * @param string $list_css_class
-     * @param string $list_item_css_class
-     * @param string $list_item_css_id_prefix
-     * @return string
-     */
-    public function generate_sortable_list_of_template_parts(
-        $list_css_id = '',
-        $list_css_class = '',
-        $list_item_css_class = '',
-        $list_item_css_id_prefix = ''
-    ) {
-        $event_archive_display_order = EEH_HTML::ul($list_css_id, $list_css_class);
-        $this->template_parts->rewind();
-        // loop through template parts and add template content
-        while ($this->template_parts->valid()) {
-            $event_archive_display_order .= EEH_HTML::li(
-                EEH_HTML::span('', '', 'dashicons dashicons-arrow-up-alt2') .
-                EEH_HTML::span('', '', 'dashicons dashicons-arrow-down-alt2') .
-                $this->template_parts->current()->label(),
-                $list_item_css_id_prefix . $this->template_parts->current()->name(),
-                $list_item_css_class
-            );
-            $this->template_parts->next();
-        }
-        $event_archive_display_order .= EEH_HTML::ulx();
-        return $event_archive_display_order;
-    }
-
-
-    /**
-     *    display_template_parts
-     *
-     * just for debugging purposes
-     *
-     * @access    public
-     * @return void
-     */
-    public function display_template_parts()
-    {
-        if (WP_DEBUG) {
-            $this->template_parts->rewind();
-            while ($this->template_parts->valid()) {
-                EEH_Debug_Tools::printr(
-                    $this->template_parts->current(),
-                    'template_part',
-                    __FILE__,
-                    __LINE__
-                );
-                $this->template_parts->next();
-            }
-        }
-    }
+	/**
+	 * @param EE_Template_Part_PriorityQueue $template_parts
+	 */
+	protected $template_parts;
+
+	/**
+	 * @param array $priorities
+	 */
+	protected $priorities = array();
+
+	/**
+	 * @param int $event_desc_priority
+	 */
+	protected $event_desc_priority;
+
+	/**
+	 * @param string $before_event_content
+	 */
+	protected $before_event_content;
+
+	/**
+	 * @param string $event_content
+	 */
+	protected $event_content;
+
+	/**
+	 * @param string $after_event_content
+	 */
+	protected $after_event_content;
+
+
+	/**
+	 *    class constructor
+	 */
+	public function __construct()
+	{
+		$this->template_parts = new EE_Template_Part_PriorityQueue();
+	}
+
+
+	/**
+	 *    add_template_part
+	 *
+	 *    used for setting the details about a particular template part
+	 *
+	 * @param string $name     - just a simple string identifier - do NOT use 'event'
+	 * @param string $label    - template part label displayed in admin
+	 * @param string $template - name or path of template to be used by EEH_Template::locate_template()
+	 * @param int    $priority - order in which template parts should be applied
+	 */
+	public function add_template_part($name, $label, $template, $priority)
+	{
+		// SplPriorityQueue doesn't play nice with multiple items having the same priority
+		// so if the incoming priority is already occupied, then let's increment it by one,
+		// and then pass everything back into this method and try again with the new priority
+		if (isset($this->priorities[ $priority ])) {
+			$priority++;
+			$this->add_template_part($name, $label, $template, $priority);
+			return;
+		}
+		// kk now we can mark this priority as being occupied
+		$this->priorities[ $priority ] = true;
+		// create the template part and add to the queue
+		$this->template_parts->insert(
+			new EE_Template_Part($name, $label, $template, $priority),
+			$priority
+		);
+		if ($name === 'event') {
+			$this->event_desc_priority = $priority;
+		}
+	}
+
+
+	/**
+	 *    apply_template_part_filters
+	 *
+	 *    adds template parts to the supplied content
+	 *    according to the details set when the template parts were added
+	 *
+	 * @access public
+	 * @param string $content
+	 * @return string
+	 */
+	public function apply_template_part_filters($content = '')
+	{
+		$this->template_parts->rewind();
+		// loop through template parts and position content
+		while ($this->template_parts->valid()) {
+			$this->_position_template_part(
+				$content,
+				$this->template_parts->current()->template(),
+				$this->template_parts->current()->priority()
+			);
+			$this->template_parts->next();
+		}
+		// now simply add our three strings of content together
+		return $this->before_event_content . $this->event_content . $this->after_event_content;
+	}
+
+
+	/**
+	 *    position_template_part
+	 *
+	 * based on the priority of the incoming template part
+	 * relative to the known event description template part priority,
+	 * this method will assign template parts to one of the following:
+	 *        $this->before_event_content
+	 *        $this->event_content
+	 *        $this->after_event_content
+	 *
+	 * @access protected
+	 * @param string $content
+	 * @param string $template
+	 * @param int    $priority
+	 * @return void
+	 */
+	protected function _position_template_part($content, $template, $priority)
+	{
+		// Event Description content is the actual incoming content itself
+		if ($priority === $this->event_desc_priority) {
+			$this->event_content = $content;
+		} elseif ($priority < $this->event_desc_priority) {
+			// everything BEFORE the Event Description
+			$this->before_event_content .= EEH_Template::locate_template($template);
+		} elseif ($priority > $this->event_desc_priority) {
+			// everything AFTER the Event Description
+			$this->after_event_content .= EEH_Template::locate_template($template);
+		}
+	}
+
+
+	/**
+	 *    generate_sortable_list_of_template_parts
+	 *
+	 *    creates an HTML list (<ul>) with list items (<li>) for each template part,
+	 *    in a format that can be used as a sortable list in the admin
+	 *
+	 * @access public
+	 * @param string $list_css_id
+	 * @param string $list_css_class
+	 * @param string $list_item_css_class
+	 * @param string $list_item_css_id_prefix
+	 * @return string
+	 */
+	public function generate_sortable_list_of_template_parts(
+		$list_css_id = '',
+		$list_css_class = '',
+		$list_item_css_class = '',
+		$list_item_css_id_prefix = ''
+	) {
+		$event_archive_display_order = EEH_HTML::ul($list_css_id, $list_css_class);
+		$this->template_parts->rewind();
+		// loop through template parts and add template content
+		while ($this->template_parts->valid()) {
+			$event_archive_display_order .= EEH_HTML::li(
+				EEH_HTML::span('', '', 'dashicons dashicons-arrow-up-alt2') .
+				EEH_HTML::span('', '', 'dashicons dashicons-arrow-down-alt2') .
+				$this->template_parts->current()->label(),
+				$list_item_css_id_prefix . $this->template_parts->current()->name(),
+				$list_item_css_class
+			);
+			$this->template_parts->next();
+		}
+		$event_archive_display_order .= EEH_HTML::ulx();
+		return $event_archive_display_order;
+	}
+
+
+	/**
+	 *    display_template_parts
+	 *
+	 * just for debugging purposes
+	 *
+	 * @access    public
+	 * @return void
+	 */
+	public function display_template_parts()
+	{
+		if (WP_DEBUG) {
+			$this->template_parts->rewind();
+			while ($this->template_parts->valid()) {
+				EEH_Debug_Tools::printr(
+					$this->template_parts->current(),
+					'template_part',
+					__FILE__,
+					__LINE__
+				);
+				$this->template_parts->next();
+			}
+		}
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -69,13 +69,13 @@ 
         // SplPriorityQueue doesn't play nice with multiple items having the same priority
         // so if the incoming priority is already occupied, then let's increment it by one,
         // and then pass everything back into this method and try again with the new priority
-        if (isset($this->priorities[ $priority ])) {
+        if (isset($this->priorities[$priority])) {
             $priority++;
             $this->add_template_part($name, $label, $template, $priority);
             return;
         }
         // kk now we can mark this priority as being occupied
-        $this->priorities[ $priority ] = true;
+        $this->priorities[$priority] = true;
         // create the template part and add to the queue
         $this->template_parts->insert(
             new EE_Template_Part($name, $label, $template, $priority),
@@ -110,7 +110,7 @@ 
             $this->template_parts->next();
         }
         // now simply add our three strings of content together
-        return $this->before_event_content . $this->event_content . $this->after_event_content;
+        return $this->before_event_content.$this->event_content.$this->after_event_content;
     }
 
 
@@ -169,10 +169,10 @@ 
         // loop through template parts and add template content
         while ($this->template_parts->valid()) {
             $event_archive_display_order .= EEH_HTML::li(
-                EEH_HTML::span('', '', 'dashicons dashicons-arrow-up-alt2') .
-                EEH_HTML::span('', '', 'dashicons dashicons-arrow-down-alt2') .
+                EEH_HTML::span('', '', 'dashicons dashicons-arrow-up-alt2').
+                EEH_HTML::span('', '', 'dashicons dashicons-arrow-down-alt2').
                 $this->template_parts->current()->label(),
-                $list_item_css_id_prefix . $this->template_parts->current()->name(),
+                $list_item_css_id_prefix.$this->template_parts->current()->name(),
                 $list_item_css_class
             );
             $this->template_parts->next();

core/libraries/template_parts/EE_Template_Part.class.php

Indentation +108 added lines, -108 removed lines

@@ -16,112 +16,112 @@
 {
 
 
-    /**
-     * @type string $name
-     */
-    protected $name;
-
-    /**
-     * @type string $label
-     */
-    protected $label;
-
-    /**
-     * @type string $template
-     */
-    protected $template;
-
-    /**
-     * @type int $priority
-     */
-    protected $priority;
-
-
-    /**
-     *    class constructor
-     *
-     * @param string $name
-     * @param string $label
-     * @param string $template
-     * @param int    $priority
-     */
-    public function __construct($name, $label, $template, $priority = 100)
-    {
-        $this->set_name($name);
-        $this->set_label($label);
-        $this->set_template($template);
-        $this->set_priority($priority);
-    }
-
-
-    /**
-     * @return mixed
-     */
-    public function name()
-    {
-        return $this->name;
-    }
-
-
-    /**
-     * @param mixed $name
-     */
-    public function set_name($name)
-    {
-        $this->name = $name;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function label()
-    {
-        return $this->label;
-    }
-
-
-    /**
-     * @param string $label
-     */
-    public function set_label($label)
-    {
-        $this->label = $label;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function template()
-    {
-        return $this->template;
-    }
-
-
-    /**
-     * @param string $template
-     */
-    public function set_template($template)
-    {
-        $this->template = $template;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function priority()
-    {
-        return $this->priority;
-    }
-
-
-    /**
-     * @param int $priority
-     */
-    public function set_priority($priority)
-    {
-        $this->priority = intval($priority);
-    }
+	/**
+	 * @type string $name
+	 */
+	protected $name;
+
+	/**
+	 * @type string $label
+	 */
+	protected $label;
+
+	/**
+	 * @type string $template
+	 */
+	protected $template;
+
+	/**
+	 * @type int $priority
+	 */
+	protected $priority;
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @param string $name
+	 * @param string $label
+	 * @param string $template
+	 * @param int    $priority
+	 */
+	public function __construct($name, $label, $template, $priority = 100)
+	{
+		$this->set_name($name);
+		$this->set_label($label);
+		$this->set_template($template);
+		$this->set_priority($priority);
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function name()
+	{
+		return $this->name;
+	}
+
+
+	/**
+	 * @param mixed $name
+	 */
+	public function set_name($name)
+	{
+		$this->name = $name;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function label()
+	{
+		return $this->label;
+	}
+
+
+	/**
+	 * @param string $label
+	 */
+	public function set_label($label)
+	{
+		$this->label = $label;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function template()
+	{
+		return $this->template;
+	}
+
+
+	/**
+	 * @param string $template
+	 */
+	public function set_template($template)
+	{
+		$this->template = $template;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function priority()
+	{
+		return $this->priority;
+	}
+
+
+	/**
+	 * @param int $priority
+	 */
+	public function set_priority($priority)
+	{
+		$this->priority = intval($priority);
+	}
 }