eventespresso / event-espresso-core

acceptance_tests/Page/TicketSelector.php

Indentation +21 added lines, -21 removed lines

@@ -12,27 +12,27 @@
 class TicketSelector
 {
 
-    /**
-     * Return the selector for the ticket option select input for the given event id.
-     * @param int|string $event_id
-     * @return string
-     */
-    public static function ticketOptionByEventIdSelector($event_id)
-    {
-        return "//select[@id='ticket-selector-tbl-qty-slct-$event_id-1']";
-    }
+	/**
+	 * Return the selector for the ticket option select input for the given event id.
+	 * @param int|string $event_id
+	 * @return string
+	 */
+	public static function ticketOptionByEventIdSelector($event_id)
+	{
+		return "//select[@id='ticket-selector-tbl-qty-slct-$event_id-1']";
+	}
 
 
-    /**
-     * Return the selector for the submit button for the ticket selector for the given event id.
-     * @param int|string $event_id
-     * @param bool       $admin     Used to return the selector from the context of the admin (true) or frontend (false)
-     * @return string
-     */
-    public static function ticketSelectionSubmitSelectorByEventId($event_id, $admin = false)
-    {
-        return $admin
-            ? "#ee-new-registration-step-button"
-            : "#ticket-selector-submit-$event_id-btn";
-    }
+	/**
+	 * Return the selector for the submit button for the ticket selector for the given event id.
+	 * @param int|string $event_id
+	 * @param bool       $admin     Used to return the selector from the context of the admin (true) or frontend (false)
+	 * @return string
+	 */
+	public static function ticketSelectionSubmitSelectorByEventId($event_id, $admin = false)
+	{
+		return $admin
+			? "#ee-new-registration-step-button"
+			: "#ticket-selector-submit-$event_id-btn";
+	}
 }
\ No newline at end of file

acceptance_tests/Page/RegistrationsAdmin.php

Indentation +43 added lines, -43 removed lines

@@ -12,47 +12,47 @@
 class RegistrationsAdmin extends CoreAdmin
 {
 
-    const REGISTRATION_STATUS_NOT_APPROVED = 'RNA';
-    const REGISTRATION_STATUS_APPROVED = 'RAP';
-    const REGISTRATION_STATUS_PENDING_PAYMENT = 'RPP';
-    const SEARCH_INPUT_SELECTOR_LIST_TABLE_REGISTRATION = '#event-espresso_page_espresso_registrations-search-input';
-    const BUTTON_ADD_NEW_REGISTRATION = '#add-new-registration';
-    const DROPDOWN_REGISTRATION_STATUS = '#reg-status-change-form-reg-status';
-    const BUTTON_UPDATE_REGISTRATION_STATUS = '#reg-status-change-form-submit-submit';
-    const DROPDOWN_SEND_RELATED_MESSAGES = '#reg-status-change-form-send-notifications';
-
-
-    /**
-     * @param string $additional_params
-     * @return string
-     */
-    public static function registrationsDefaultAdminListTableUrl($additional_params = '')
-    {
-        return self::adminUrl('espresso_registrations', 'default', $additional_params);
-    }
-
-
-    /**
-     * Given a registration id, this will return the selector for all the checkbox for that id.
-     * Assumes the view is the default registrations list table.
-     * @param int $registration_id
-     * @return string
-     */
-    public static function listTableCheckBoxSelectorForRegistrationId($registration_id)
-    {
-        return "//input[@name='_REG_ID[]' and @value='{$registration_id}']";
-    }
-
-
-    /**
-     * Given a registration id, this will return the selector for the link to the registration details.
-     * Assumes the view is the default registrations list table.
-     * @param int $registration_id
-     * @return string
-     */
-    public static function viewDetailsLinkSelectorForRegistrationId($registration_id)
-    {
-        return "//tbody[@id='the-list']/tr/td[contains(@class, 'column-_REG_ID') and contains(., $registration_id)]"
-            . "//ancestor::tr/td[contains(@class, 'column-ATT_fname')]/a[1]";
-    }
+	const REGISTRATION_STATUS_NOT_APPROVED = 'RNA';
+	const REGISTRATION_STATUS_APPROVED = 'RAP';
+	const REGISTRATION_STATUS_PENDING_PAYMENT = 'RPP';
+	const SEARCH_INPUT_SELECTOR_LIST_TABLE_REGISTRATION = '#event-espresso_page_espresso_registrations-search-input';
+	const BUTTON_ADD_NEW_REGISTRATION = '#add-new-registration';
+	const DROPDOWN_REGISTRATION_STATUS = '#reg-status-change-form-reg-status';
+	const BUTTON_UPDATE_REGISTRATION_STATUS = '#reg-status-change-form-submit-submit';
+	const DROPDOWN_SEND_RELATED_MESSAGES = '#reg-status-change-form-send-notifications';
+
+
+	/**
+	 * @param string $additional_params
+	 * @return string
+	 */
+	public static function registrationsDefaultAdminListTableUrl($additional_params = '')
+	{
+		return self::adminUrl('espresso_registrations', 'default', $additional_params);
+	}
+
+
+	/**
+	 * Given a registration id, this will return the selector for all the checkbox for that id.
+	 * Assumes the view is the default registrations list table.
+	 * @param int $registration_id
+	 * @return string
+	 */
+	public static function listTableCheckBoxSelectorForRegistrationId($registration_id)
+	{
+		return "//input[@name='_REG_ID[]' and @value='{$registration_id}']";
+	}
+
+
+	/**
+	 * Given a registration id, this will return the selector for the link to the registration details.
+	 * Assumes the view is the default registrations list table.
+	 * @param int $registration_id
+	 * @return string
+	 */
+	public static function viewDetailsLinkSelectorForRegistrationId($registration_id)
+	{
+		return "//tbody[@id='the-list']/tr/td[contains(@class, 'column-_REG_ID') and contains(., $registration_id)]"
+			. "//ancestor::tr/td[contains(@class, 'column-ATT_fname')]/a[1]";
+	}
 }
\ No newline at end of file

acceptance_tests/Page/Checkout.php

Indentation +67 added lines, -67 removed lines

@@ -13,71 +13,71 @@
 class Checkout
 {
 
-    /**
-     * The class selector for the next step button in the checkout.
-     * @var string
-     */
-    const NEXT_STEP_BUTTON_SELECTOR = '.spco-next-step-btn';
-
-
-    const PAYMENT_METHOD_STEP_FORM = '#ee-spco-payment_options-reg-step-form';
-
-
-    const SELECTOR_PAYMENT_OPTIONS_CONTAINER = '#spco-available-methods-of-payment-dv';
-
-
-    /**
-     * @param int $attendee_number
-     * @param bool  $admin  Used to indicate whether we're retrieving the selector from the context of the admin or not.
-     * @return string
-     */
-    public static function firstNameFieldSelectorForAttendeeNumber($attendee_number = 1, $admin = false)
-    {
-        return self::fieldSelectorForAttendeeNumber('fname', $attendee_number, $admin);
-    }
-
-
-    /**
-     * @param int $attendee_number
-     * @param bool  $admin  Used to indicate whether we're retrieving the selector from the context of the admin or not.
-     * @return string
-     */
-    public static function lastNameFieldSelectorForAttendeeNumber($attendee_number = 1, $admin = false)
-    {
-        return self::fieldSelectorForAttendeeNumber('lname', $attendee_number, $admin);
-    }
-
-
-    /**
-     * @param int $attendee_number
-     * @param bool  $admin  Used to indicate whether we're retrieving the selector from the context of the admin or not.
-     * @return string
-     */
-    public static function emailFieldSelectorForAttendeeNumber($attendee_number = 1, $admin = false)
-    {
-        return self::fieldSelectorForAttendeeNumber('email', $attendee_number, $admin);
-    }
-
-    /**
-     * @param string    $field_name
-     * @param int $attendee_number
-     * @param bool  $admin  Used to indicate whether we're retrieving the selector from the context of the admin or not.
-     * @return string
-     */
-    public static function fieldSelectorForAttendeeNumber($field_name, $attendee_number = 1, $admin = false)
-    {
-        return $admin
-                ? "//fieldset[starts-with(@id, 'ee-registration-$attendee_number')]//input[contains(@class, 'ee-reg-qstn-$field_name')]"
-                : "//div[starts-with(@id, 'spco-attendee-panel-dv-$attendee_number')]//input[contains(@class, 'ee-reg-qstn-$field_name')]";
-    }
-
-
-    /**
-     * @param string $payment_method_slug Slug for the payment method.
-     * @return string
-     */
-    public static function fieldSelectorForPaymentOption($payment_method_slug)
-    {
-        return "#ee-available-payment-method-inputs-{$payment_method_slug}";
-    }
+	/**
+	 * The class selector for the next step button in the checkout.
+	 * @var string
+	 */
+	const NEXT_STEP_BUTTON_SELECTOR = '.spco-next-step-btn';
+
+
+	const PAYMENT_METHOD_STEP_FORM = '#ee-spco-payment_options-reg-step-form';
+
+
+	const SELECTOR_PAYMENT_OPTIONS_CONTAINER = '#spco-available-methods-of-payment-dv';
+
+
+	/**
+	 * @param int $attendee_number
+	 * @param bool  $admin  Used to indicate whether we're retrieving the selector from the context of the admin or not.
+	 * @return string
+	 */
+	public static function firstNameFieldSelectorForAttendeeNumber($attendee_number = 1, $admin = false)
+	{
+		return self::fieldSelectorForAttendeeNumber('fname', $attendee_number, $admin);
+	}
+
+
+	/**
+	 * @param int $attendee_number
+	 * @param bool  $admin  Used to indicate whether we're retrieving the selector from the context of the admin or not.
+	 * @return string
+	 */
+	public static function lastNameFieldSelectorForAttendeeNumber($attendee_number = 1, $admin = false)
+	{
+		return self::fieldSelectorForAttendeeNumber('lname', $attendee_number, $admin);
+	}
+
+
+	/**
+	 * @param int $attendee_number
+	 * @param bool  $admin  Used to indicate whether we're retrieving the selector from the context of the admin or not.
+	 * @return string
+	 */
+	public static function emailFieldSelectorForAttendeeNumber($attendee_number = 1, $admin = false)
+	{
+		return self::fieldSelectorForAttendeeNumber('email', $attendee_number, $admin);
+	}
+
+	/**
+	 * @param string    $field_name
+	 * @param int $attendee_number
+	 * @param bool  $admin  Used to indicate whether we're retrieving the selector from the context of the admin or not.
+	 * @return string
+	 */
+	public static function fieldSelectorForAttendeeNumber($field_name, $attendee_number = 1, $admin = false)
+	{
+		return $admin
+				? "//fieldset[starts-with(@id, 'ee-registration-$attendee_number')]//input[contains(@class, 'ee-reg-qstn-$field_name')]"
+				: "//div[starts-with(@id, 'spco-attendee-panel-dv-$attendee_number')]//input[contains(@class, 'ee-reg-qstn-$field_name')]";
+	}
+
+
+	/**
+	 * @param string $payment_method_slug Slug for the payment method.
+	 * @return string
+	 */
+	public static function fieldSelectorForPaymentOption($payment_method_slug)
+	{
+		return "#ee-available-payment-method-inputs-{$payment_method_slug}";
+	}
 }

modules/ticket_selector/TicketDatetimeAvailabilityTracker.php

Spacing +13 added lines, -13 removed lines

@@ -66,24 +66,24 @@ 
     public function ticketDatetimeAvailability(EE_Ticket $ticket, $get_original_ticket_spaces = false)
     {
         // if the $_available_spaces array has not been set up yet...
-        if (! isset($this->available_spaces['tickets'][ $ticket->ID() ])) {
+        if ( ! isset($this->available_spaces['tickets'][$ticket->ID()])) {
             $this->setInitialTicketDatetimeAvailability($ticket);
         }
         $available_spaces = $ticket->qty() - $ticket->sold();
-        if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) {
+        if (isset($this->available_spaces['tickets'][$ticket->ID()])) {
             // loop thru tickets, which will ALSO include individual ticket records AND a total
-            foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) {
+            foreach ($this->available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) {
                 // if we want the original datetime availability BEFORE we started subtracting tickets ?
                 if ($get_original_ticket_spaces) {
                     // then grab the available spaces from the "tickets" array
                     // and compare with the above to get the lowest number
                     $available_spaces = min(
                         $available_spaces,
-                        $this->available_spaces['tickets'][ $ticket->ID() ][ $DTD_ID ]
+                        $this->available_spaces['tickets'][$ticket->ID()][$DTD_ID]
                     );
                 } else {
                     // we want the updated ticket availability as stored in the "datetimes" array
-                    $available_spaces = min($available_spaces, $this->available_spaces['datetimes'][ $DTD_ID ]);
+                    $available_spaces = min($available_spaces, $this->available_spaces['datetimes'][$DTD_ID]);
                 }
             }
         }
@@ -114,7 +114,7 @@ 
                 'order_by' => array('DTT_EVT_start' => 'ASC'),
             )
         );
-        if (! empty($datetimes)) {
+        if ( ! empty($datetimes)) {
             // now loop thru all of the datetimes
             foreach ($datetimes as $datetime) {
                 if ($datetime instanceof EE_Datetime) {
@@ -122,17 +122,17 @@ 
                     $spaces_remaining = $datetime->spaces_remaining();
                     // save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold
                     // or the datetime spaces remaining) to this ticket using the datetime ID as the key
-                    $this->available_spaces['tickets'][ $ticket->ID() ][ $datetime->ID() ] = min(
+                    $this->available_spaces['tickets'][$ticket->ID()][$datetime->ID()] = min(
                         $ticket->qty() - $ticket->sold(),
                         $spaces_remaining
                     );
                     // if the remaining spaces for this datetime is already set,
                     // then compare that against the datetime spaces remaining, and take the lowest number,
                     // else just take the datetime spaces remaining, and assign to the datetimes array
-                    $this->available_spaces['datetimes'][ $datetime->ID() ] = isset(
-                        $this->available_spaces['datetimes'][ $datetime->ID() ]
+                    $this->available_spaces['datetimes'][$datetime->ID()] = isset(
+                        $this->available_spaces['datetimes'][$datetime->ID()]
                     )
-                        ? min($this->available_spaces['datetimes'][ $datetime->ID() ], $spaces_remaining)
+                        ? min($this->available_spaces['datetimes'][$datetime->ID()], $spaces_remaining)
                         : $spaces_remaining;
                 }
             }
@@ -148,11 +148,11 @@ 
      */
     public function recalculateTicketDatetimeAvailability(EE_Ticket $ticket, $qty = 0)
     {
-        if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) {
+        if (isset($this->available_spaces['tickets'][$ticket->ID()])) {
             // loop thru tickets, which will ALSO include individual ticket records AND a total
-            foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) {
+            foreach ($this->available_spaces['tickets'][$ticket->ID()] as $DTD_ID => $spaces) {
                 // subtract the qty of selected tickets from each datetime's available spaces this ticket has access to,
-                $this->available_spaces['datetimes'][ $DTD_ID ] -= $qty;
+                $this->available_spaces['datetimes'][$DTD_ID] -= $qty;
             }
         }
     }

Indentation +213 added lines, -213 removed lines

@@ -21,217 +21,217 @@
  */
 class TicketDatetimeAvailabilityTracker
 {
-    /**
-     * array of datetimes and the spaces available for them
-     *
-     * @var array[][]
-     */
-    private $available_spaces = array();
-
-    /**
-     * @var EEM_Datetime $datetime_model
-     */
-    private $datetime_model;
-
-
-    /**
-     * TicketDatetimeAvailabilityTracker constructor.
-     *
-     * @param EEM_Datetime $datetime_model
-     */
-    public function __construct(EEM_Datetime $datetime_model)
-    {
-        $this->datetime_model = $datetime_model;
-    }
-
-
-    /**
-     * ticketDatetimeAvailability
-     * creates an array of tickets plus all of the datetimes available to each ticket
-     * and tracks the spaces remaining for each of those datetimes
-     *
-     * @param EE_Ticket $ticket - selected ticket
-     * @param bool      $get_original_ticket_spaces
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function ticketDatetimeAvailability(EE_Ticket $ticket, $get_original_ticket_spaces = false)
-    {
-        // if the $_available_spaces array has not been set up yet...
-        if (! isset($this->available_spaces['tickets'][ $ticket->ID() ])) {
-            $this->setInitialTicketDatetimeAvailability($ticket);
-        }
-        $available_spaces = $ticket->qty() - $ticket->sold();
-        if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) {
-            // loop thru tickets, which will ALSO include individual ticket records AND a total
-            foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) {
-                // if we want the original datetime availability BEFORE we started subtracting tickets ?
-                if ($get_original_ticket_spaces) {
-                    // then grab the available spaces from the "tickets" array
-                    // and compare with the above to get the lowest number
-                    $available_spaces = min(
-                        $available_spaces,
-                        $this->available_spaces['tickets'][ $ticket->ID() ][ $DTD_ID ]
-                    );
-                } else {
-                    // we want the updated ticket availability as stored in the "datetimes" array
-                    $available_spaces = min($available_spaces, $this->available_spaces['datetimes'][ $DTD_ID ]);
-                }
-            }
-        }
-        return $available_spaces;
-    }
-
-
-    /**
-     * @param EE_Ticket $ticket
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    private function setInitialTicketDatetimeAvailability(EE_Ticket $ticket)
-    {
-        // first, get all of the datetimes that are available to this ticket
-        $datetimes = $ticket->get_many_related(
-            'Datetime',
-            array(
-                array(
-                    'DTT_EVT_end' => array(
-                        '>=',
-                        $this->datetime_model->current_time_for_query('DTT_EVT_end'),
-                    ),
-                ),
-                'order_by' => array('DTT_EVT_start' => 'ASC'),
-            )
-        );
-        if (! empty($datetimes)) {
-            // now loop thru all of the datetimes
-            foreach ($datetimes as $datetime) {
-                if ($datetime instanceof EE_Datetime) {
-                    // the number of spaces available for the datetime without considering individual ticket quantities
-                    $spaces_remaining = $datetime->spaces_remaining();
-                    // save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold
-                    // or the datetime spaces remaining) to this ticket using the datetime ID as the key
-                    $this->available_spaces['tickets'][ $ticket->ID() ][ $datetime->ID() ] = min(
-                        $ticket->qty() - $ticket->sold(),
-                        $spaces_remaining
-                    );
-                    // if the remaining spaces for this datetime is already set,
-                    // then compare that against the datetime spaces remaining, and take the lowest number,
-                    // else just take the datetime spaces remaining, and assign to the datetimes array
-                    $this->available_spaces['datetimes'][ $datetime->ID() ] = isset(
-                        $this->available_spaces['datetimes'][ $datetime->ID() ]
-                    )
-                        ? min($this->available_spaces['datetimes'][ $datetime->ID() ], $spaces_remaining)
-                        : $spaces_remaining;
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @param    EE_Ticket $ticket
-     * @param    int       $qty
-     * @return    void
-     * @throws EE_Error
-     */
-    public function recalculateTicketDatetimeAvailability(EE_Ticket $ticket, $qty = 0)
-    {
-        if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) {
-            // loop thru tickets, which will ALSO include individual ticket records AND a total
-            foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) {
-                // subtract the qty of selected tickets from each datetime's available spaces this ticket has access to,
-                $this->available_spaces['datetimes'][ $DTD_ID ] -= $qty;
-            }
-        }
-    }
-
-
-    /**
-     * @param EE_Ticket $ticket
-     * @param           $qty
-     * @param int       $total_ticket_count
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function processAvailabilityError(EE_Ticket $ticket, $qty, $total_ticket_count = 1)
-    {
-        // tickets can not be purchased but let's find the exact number left
-        // for the last ticket selected PRIOR to subtracting tickets
-        $available_spaces = $this->ticketDatetimeAvailability($ticket, true);
-        // greedy greedy greedy eh?
-        if ($available_spaces > 0) {
-            if (
-                apply_filters(
-                    'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_display_availability_error',
-                    true,
-                    $ticket,
-                    $qty,
-                    $available_spaces
-                )
-            ) {
-                $this->availabilityError(
-                    $available_spaces,
-                    $total_ticket_count
-                );
-            }
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'We\'re sorry, but there are no available spaces left for this event at this particular date and time.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * @param int $available_spaces
-     * @param int $total_ticket_count
-     */
-    private function availabilityError($available_spaces = 1, $total_ticket_count = 1)
-    {
-        // add error messaging - we're using the _n function that will generate
-        // the appropriate singular or plural message based on the number of $available_spaces
-        if ($total_ticket_count) {
-            $msg = sprintf(
-                esc_html(
-                    _n(
-                        'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.',
-                        'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.',
-                        $available_spaces,
-                        'event_espresso'
-                    )
-                ),
-                $available_spaces,
-                '<br />'
-            );
-        } else {
-            $msg = sprintf(
-                esc_html(
-                    _n(
-                        'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets.',
-                        'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets.',
-                        $available_spaces,
-                        'event_espresso'
-                    )
-                ),
-                $available_spaces,
-                '<br />'
-            );
-        }
-        EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-    }
+	/**
+	 * array of datetimes and the spaces available for them
+	 *
+	 * @var array[][]
+	 */
+	private $available_spaces = array();
+
+	/**
+	 * @var EEM_Datetime $datetime_model
+	 */
+	private $datetime_model;
+
+
+	/**
+	 * TicketDatetimeAvailabilityTracker constructor.
+	 *
+	 * @param EEM_Datetime $datetime_model
+	 */
+	public function __construct(EEM_Datetime $datetime_model)
+	{
+		$this->datetime_model = $datetime_model;
+	}
+
+
+	/**
+	 * ticketDatetimeAvailability
+	 * creates an array of tickets plus all of the datetimes available to each ticket
+	 * and tracks the spaces remaining for each of those datetimes
+	 *
+	 * @param EE_Ticket $ticket - selected ticket
+	 * @param bool      $get_original_ticket_spaces
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function ticketDatetimeAvailability(EE_Ticket $ticket, $get_original_ticket_spaces = false)
+	{
+		// if the $_available_spaces array has not been set up yet...
+		if (! isset($this->available_spaces['tickets'][ $ticket->ID() ])) {
+			$this->setInitialTicketDatetimeAvailability($ticket);
+		}
+		$available_spaces = $ticket->qty() - $ticket->sold();
+		if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) {
+			// loop thru tickets, which will ALSO include individual ticket records AND a total
+			foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) {
+				// if we want the original datetime availability BEFORE we started subtracting tickets ?
+				if ($get_original_ticket_spaces) {
+					// then grab the available spaces from the "tickets" array
+					// and compare with the above to get the lowest number
+					$available_spaces = min(
+						$available_spaces,
+						$this->available_spaces['tickets'][ $ticket->ID() ][ $DTD_ID ]
+					);
+				} else {
+					// we want the updated ticket availability as stored in the "datetimes" array
+					$available_spaces = min($available_spaces, $this->available_spaces['datetimes'][ $DTD_ID ]);
+				}
+			}
+		}
+		return $available_spaces;
+	}
+
+
+	/**
+	 * @param EE_Ticket $ticket
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	private function setInitialTicketDatetimeAvailability(EE_Ticket $ticket)
+	{
+		// first, get all of the datetimes that are available to this ticket
+		$datetimes = $ticket->get_many_related(
+			'Datetime',
+			array(
+				array(
+					'DTT_EVT_end' => array(
+						'>=',
+						$this->datetime_model->current_time_for_query('DTT_EVT_end'),
+					),
+				),
+				'order_by' => array('DTT_EVT_start' => 'ASC'),
+			)
+		);
+		if (! empty($datetimes)) {
+			// now loop thru all of the datetimes
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					// the number of spaces available for the datetime without considering individual ticket quantities
+					$spaces_remaining = $datetime->spaces_remaining();
+					// save the total available spaces ( the lesser of the ticket qty minus the number of tickets sold
+					// or the datetime spaces remaining) to this ticket using the datetime ID as the key
+					$this->available_spaces['tickets'][ $ticket->ID() ][ $datetime->ID() ] = min(
+						$ticket->qty() - $ticket->sold(),
+						$spaces_remaining
+					);
+					// if the remaining spaces for this datetime is already set,
+					// then compare that against the datetime spaces remaining, and take the lowest number,
+					// else just take the datetime spaces remaining, and assign to the datetimes array
+					$this->available_spaces['datetimes'][ $datetime->ID() ] = isset(
+						$this->available_spaces['datetimes'][ $datetime->ID() ]
+					)
+						? min($this->available_spaces['datetimes'][ $datetime->ID() ], $spaces_remaining)
+						: $spaces_remaining;
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @param    EE_Ticket $ticket
+	 * @param    int       $qty
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public function recalculateTicketDatetimeAvailability(EE_Ticket $ticket, $qty = 0)
+	{
+		if (isset($this->available_spaces['tickets'][ $ticket->ID() ])) {
+			// loop thru tickets, which will ALSO include individual ticket records AND a total
+			foreach ($this->available_spaces['tickets'][ $ticket->ID() ] as $DTD_ID => $spaces) {
+				// subtract the qty of selected tickets from each datetime's available spaces this ticket has access to,
+				$this->available_spaces['datetimes'][ $DTD_ID ] -= $qty;
+			}
+		}
+	}
+
+
+	/**
+	 * @param EE_Ticket $ticket
+	 * @param           $qty
+	 * @param int       $total_ticket_count
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function processAvailabilityError(EE_Ticket $ticket, $qty, $total_ticket_count = 1)
+	{
+		// tickets can not be purchased but let's find the exact number left
+		// for the last ticket selected PRIOR to subtracting tickets
+		$available_spaces = $this->ticketDatetimeAvailability($ticket, true);
+		// greedy greedy greedy eh?
+		if ($available_spaces > 0) {
+			if (
+				apply_filters(
+					'FHEE__EE_Ticket_Selector___add_ticket_to_cart__allow_display_availability_error',
+					true,
+					$ticket,
+					$qty,
+					$available_spaces
+				)
+			) {
+				$this->availabilityError(
+					$available_spaces,
+					$total_ticket_count
+				);
+			}
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'We\'re sorry, but there are no available spaces left for this event at this particular date and time.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * @param int $available_spaces
+	 * @param int $total_ticket_count
+	 */
+	private function availabilityError($available_spaces = 1, $total_ticket_count = 1)
+	{
+		// add error messaging - we're using the _n function that will generate
+		// the appropriate singular or plural message based on the number of $available_spaces
+		if ($total_ticket_count) {
+			$msg = sprintf(
+				esc_html(
+					_n(
+						'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.',
+						'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets by cancelling the current selection and choosing again, or proceed to registration.',
+						$available_spaces,
+						'event_espresso'
+					)
+				),
+				$available_spaces,
+				'<br />'
+			);
+		} else {
+			$msg = sprintf(
+				esc_html(
+					_n(
+						'We\'re sorry, but there is only %1$s available space left for this event at this particular date and time. Please select a different number (or different combination) of tickets.',
+						'We\'re sorry, but there are only %1$s available spaces left for this event at this particular date and time. Please select a different number (or different combination) of tickets.',
+						$available_spaces,
+						'event_espresso'
+					)
+				),
+				$available_spaces,
+				'<br />'
+			);
+		}
+		EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+	}
 }

acceptance_tests/Helpers/EventsAdmin.php

Indentation +129 added lines, -129 removed lines

@@ -14,133 +14,133 @@
 trait EventsAdmin
 {
 
-    /**
-     * @param string $additional_params
-     */
-    public function amOnDefaultEventsListTablePage($additional_params = '')
-    {
-        $this->actor()->amOnAdminPage(EventsPage::defaultEventsListTableUrl($additional_params));
-    }
-
-
-    /**
-     * Triggers the publishing of the Event.
-     */
-    public function publishEvent()
-    {
-        $this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR);
-        $this->actor()->wait(3);
-        $this->actor()->click(EventsPage::EVENT_EDITOR_PUBLISH_BUTTON_SELECTOR);
-        $this->actor()->waitForText('Event published.', 30);
-    }
-
-
-    /**
-     * Triggers saving the Event.
-     */
-    public function saveEvent()
-    {
-        $this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR);
-        $this->actor()->wait(2);
-        $this->actor()->click(EventsPage::EVENT_EDITOR_SAVE_BUTTON_SELECTOR);
-    }
-
-
-    /**
-     * Navigates the actor to the event list table page and will attempt to edit the event for the given title.
-     * First this will search using the given title and then attempt to edit from the results of the search.
-     *
-     * Assumes actor is already logged in.
-     * @param $event_title
-     */
-    public function amEditingTheEventWithTitle($event_title)
-    {
-        $this->amOnDefaultEventsListTablePage();
-        $this->actor()->fillField(EventsPage::EVENT_LIST_TABLE_SEARCH_INPUT_SELECTOR, $event_title);
-        $this->actor()->click(CoreAdmin::LIST_TABLE_SEARCH_SUBMIT_SELECTOR);
-        $this->actor()->waitForText($event_title, 15);
-        $this->actor()->click(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title));
-    }
-
-
-    /**
-     * Navigates the user to the single event page (frontend view) for the given event title via clicking the "View"
-     * link for the event in the event list table.
-     * Assumes the actor is already logged in and on the Event list table page.
-     *
-     * @param string $event_title
-     */
-    public function amOnEventPageAfterClickingViewLinkInListTableForEvent($event_title)
-    {
-        $this->actor()->moveMouseOver(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title));
-        $this->actor()->click(EventsPage::eventListTableEventTitleViewLinkSelectorForTitle($event_title));
-    }
-
-
-    /**
-     * Used to retrieve the event id for the event via the list table and for the given event.
-     * @param string $event_title
-     */
-    public function observeEventIdInListTableForEvent($event_title)
-    {
-        return $this->actor()->observeValueFromInputAt(EventsPage::eventListTableEventIdSelectorForTitle($event_title));
-    }
-
-
-    /**
-     * This performs the click action on the gear icon that triggers the advanced settings view state.
-     * Assumes the actor is already logged in and editing an event.
-     *
-     * @param int $row_number  What ticket row to toggle open/close.
-     */
-    public function toggleAdvancedSettingsViewForTicketRow($row_number = 1)
-    {
-        $this->actor()->click(EventsPage::eventEditorTicketAdvancedDetailsSelector($row_number));
-    }
-
-
-    /**
-     * Toggles the TKT_is_taxable checkbox for the ticket in the given row.
-     * Assumes the actor is already logged in and editing an event and that the advanced settings view state for that
-     * ticket is "open".
-     *
-     * @param int $row_number  What ticket row to toggle the checkbox for.
-     */
-    public function toggleTicketIsTaxableForTicketRow($row_number = 1)
-    {
-        $this->actor()->click(EventsPage::eventEditorTicketTaxableCheckboxSelector($row_number));
-    }
-
-
-    /**
-     * Use to change the default registration status for the event.
-     * Assumes the view is already on the event editor.
-     * @param $registration_status
-     */
-    public function changeDefaultRegistrationStatusTo($registration_status)
-    {
-        $this->actor()->selectOption(
-            EventsPage::EVENT_EDITOR_DEFAULT_REGISTRATION_STATUS_FIELD_SELECTOR,
-            $registration_status
-        );
-    }
-
-
-    /**
-     * Use this from the context of the event editor to select the given custom template for a given message type and
-     * messenger.
-     *
-     * @param string $message_type_label  The visible label for the message type (eg Registration Approved)
-     * @param string $messenger_slug      The slug for the messenger (eg 'email')
-     * @param string $custom_template_label The visible label in the select input for the custom template you want
-     *                                      selected.
-     */
-    public function selectCustomTemplateFor($message_type_label, $messenger_slug, $custom_template_label)
-    {
-        $this->actor()->click(EventsPage::eventEditorNotificationsMetaBoxMessengerTabSelector($messenger_slug));
-        $this->actor()->selectOption(
-            EventsPage::eventEditorNotificationsMetaBoxSelectSelectorForMessageType($message_type_label),
-            $custom_template_label
-        );
-    }
+	/**
+	 * @param string $additional_params
+	 */
+	public function amOnDefaultEventsListTablePage($additional_params = '')
+	{
+		$this->actor()->amOnAdminPage(EventsPage::defaultEventsListTableUrl($additional_params));
+	}
+
+
+	/**
+	 * Triggers the publishing of the Event.
+	 */
+	public function publishEvent()
+	{
+		$this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR);
+		$this->actor()->wait(3);
+		$this->actor()->click(EventsPage::EVENT_EDITOR_PUBLISH_BUTTON_SELECTOR);
+		$this->actor()->waitForText('Event published.', 30);
+	}
+
+
+	/**
+	 * Triggers saving the Event.
+	 */
+	public function saveEvent()
+	{
+		$this->actor()->scrollTo(EventsPage::EVENT_EDITOR_TITLE_FIELD_SELECTOR);
+		$this->actor()->wait(2);
+		$this->actor()->click(EventsPage::EVENT_EDITOR_SAVE_BUTTON_SELECTOR);
+	}
+
+
+	/**
+	 * Navigates the actor to the event list table page and will attempt to edit the event for the given title.
+	 * First this will search using the given title and then attempt to edit from the results of the search.
+	 *
+	 * Assumes actor is already logged in.
+	 * @param $event_title
+	 */
+	public function amEditingTheEventWithTitle($event_title)
+	{
+		$this->amOnDefaultEventsListTablePage();
+		$this->actor()->fillField(EventsPage::EVENT_LIST_TABLE_SEARCH_INPUT_SELECTOR, $event_title);
+		$this->actor()->click(CoreAdmin::LIST_TABLE_SEARCH_SUBMIT_SELECTOR);
+		$this->actor()->waitForText($event_title, 15);
+		$this->actor()->click(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title));
+	}
+
+
+	/**
+	 * Navigates the user to the single event page (frontend view) for the given event title via clicking the "View"
+	 * link for the event in the event list table.
+	 * Assumes the actor is already logged in and on the Event list table page.
+	 *
+	 * @param string $event_title
+	 */
+	public function amOnEventPageAfterClickingViewLinkInListTableForEvent($event_title)
+	{
+		$this->actor()->moveMouseOver(EventsPage::eventListTableEventTitleEditLinkSelectorForTitle($event_title));
+		$this->actor()->click(EventsPage::eventListTableEventTitleViewLinkSelectorForTitle($event_title));
+	}
+
+
+	/**
+	 * Used to retrieve the event id for the event via the list table and for the given event.
+	 * @param string $event_title
+	 */
+	public function observeEventIdInListTableForEvent($event_title)
+	{
+		return $this->actor()->observeValueFromInputAt(EventsPage::eventListTableEventIdSelectorForTitle($event_title));
+	}
+
+
+	/**
+	 * This performs the click action on the gear icon that triggers the advanced settings view state.
+	 * Assumes the actor is already logged in and editing an event.
+	 *
+	 * @param int $row_number  What ticket row to toggle open/close.
+	 */
+	public function toggleAdvancedSettingsViewForTicketRow($row_number = 1)
+	{
+		$this->actor()->click(EventsPage::eventEditorTicketAdvancedDetailsSelector($row_number));
+	}
+
+
+	/**
+	 * Toggles the TKT_is_taxable checkbox for the ticket in the given row.
+	 * Assumes the actor is already logged in and editing an event and that the advanced settings view state for that
+	 * ticket is "open".
+	 *
+	 * @param int $row_number  What ticket row to toggle the checkbox for.
+	 */
+	public function toggleTicketIsTaxableForTicketRow($row_number = 1)
+	{
+		$this->actor()->click(EventsPage::eventEditorTicketTaxableCheckboxSelector($row_number));
+	}
+
+
+	/**
+	 * Use to change the default registration status for the event.
+	 * Assumes the view is already on the event editor.
+	 * @param $registration_status
+	 */
+	public function changeDefaultRegistrationStatusTo($registration_status)
+	{
+		$this->actor()->selectOption(
+			EventsPage::EVENT_EDITOR_DEFAULT_REGISTRATION_STATUS_FIELD_SELECTOR,
+			$registration_status
+		);
+	}
+
+
+	/**
+	 * Use this from the context of the event editor to select the given custom template for a given message type and
+	 * messenger.
+	 *
+	 * @param string $message_type_label  The visible label for the message type (eg Registration Approved)
+	 * @param string $messenger_slug      The slug for the messenger (eg 'email')
+	 * @param string $custom_template_label The visible label in the select input for the custom template you want
+	 *                                      selected.
+	 */
+	public function selectCustomTemplateFor($message_type_label, $messenger_slug, $custom_template_label)
+	{
+		$this->actor()->click(EventsPage::eventEditorNotificationsMetaBoxMessengerTabSelector($messenger_slug));
+		$this->actor()->selectOption(
+			EventsPage::eventEditorNotificationsMetaBoxSelectSelectorForMessageType($message_type_label),
+			$custom_template_label
+		);
+	}
 }
\ No newline at end of file

core/services/activation/ActivationHistory.php

Indentation +276 added lines, -276 removed lines

@@ -20,282 +20,282 @@
 class ActivationHistory
 {
 
-    /**
-     * option name for recording the activation history for core
-     */
-    const EE_ACTIVATION_HISTORY_OPTION_NAME = 'espresso_db_update';
-
-    /**
-     * option name for indicating that the current request is for activating core
-     */
-    const EE_ACTIVATION_INDICATOR_OPTION_NAME = 'ee_espresso_activation';
-
-    /**
-     * stores the values for the activation history option name for core or an addon
-     *
-     * @var string $activation_history_option_name
-     */
-    protected $activation_history_option_name;
-
-    /**
-     * stores the values for the activation indicator option name for core or an addon
-     *
-     * @var string $activation_indicator_option_name
-     */
-    protected $activation_indicator_option_name;
-
-    /**
-     * the current version for core or an addon, like "1.2.3.p"
-     *
-     * @var string $current_version
-     */
-    protected $current_version;
-
-    /**
-     * array of activated versions and activation dates for core or an addon
-     *
-     * @var array $version_history
-     */
-    protected $version_history;
-
-
-
-    /**
-     * ActivationHistory constructor.
-     *
-     * @param string $activation_history_option_name
-     * @param string $activation_indicator_option_name
-     * @param string $current_version
-     * @throws InvalidDataTypeException
-     */
-    public function __construct(
-        $activation_history_option_name = '',
-        $activation_indicator_option_name = '',
-        $current_version = ''
-    ) {
-        $this->setActivationHistoryOptionName($activation_history_option_name);
-        $this->setActivationIndicatorOptionName($activation_indicator_option_name);
-        $this->setCurrentVersion($current_version);
-        $this->version_history = (array) get_option($this->activation_history_option_name, array());
-    }
-
-
-
-    /**
-     * @param string $activation_history_option_name
-     * @throws InvalidDataTypeException
-     */
-    protected function setActivationHistoryOptionName($activation_history_option_name)
-    {
-        if(! is_string($activation_history_option_name)) {
-            throw new InvalidDataTypeException(
-                '$activation_history_option_name',
-                $activation_history_option_name,
-                'string'
-            );
-        }
-        $this->activation_history_option_name = $activation_history_option_name !== ''
-            ? $activation_history_option_name
-            : ActivationHistory::EE_ACTIVATION_HISTORY_OPTION_NAME;
-    }
-
-
-
-    /**
-     * @param string $activation_indicator_option_name
-     * @throws InvalidDataTypeException
-     */
-    protected function setActivationIndicatorOptionName($activation_indicator_option_name)
-    {
-        if (! is_string($activation_indicator_option_name)) {
-            throw new InvalidDataTypeException(
-                '$activation_indicator_option_name',
-                $activation_indicator_option_name,
-                'string'
-            );
-        }
-        $this->activation_indicator_option_name = $activation_indicator_option_name !== ''
-            ? $activation_indicator_option_name
-            : ActivationHistory::EE_ACTIVATION_INDICATOR_OPTION_NAME;
-    }
-
-
-
-    /**
-     * @param string $current_version
-     * @throws InvalidDataTypeException
-     */
-    protected function setCurrentVersion($current_version)
-    {
-        if (! is_string($current_version)) {
-            throw new InvalidDataTypeException(
-                '$current_version',
-                $current_version,
-                'string'
-            );
-        }
-        $this->current_version = $current_version !== ''
-            ? $current_version
-            : espresso_version();
-    }
-
-
-
-
-    /**
-     * Gets the wp option which stores the activation history for this addon
-     *
-     * @return array|bool
-     */
-    public function getVersionHistory()
-    {
-        return $this->version_history;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function getCurrentVersion()
-    {
-        return $this->current_version;
-    }
-
-
-
-    /**
-     * Gets the most recently active version listed in the activation history,
-     * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
-     *
-     * @return string
-     */
-    public function getMostRecentActiveVersion()
-    {
-        $most_recently_active_version_activation = '1970-01-01 00:00:00';
-        $most_recently_active_version = '0.0.0.dev.000';
-        if (is_array($this->version_history) && count($this->version_history)) {
-            foreach ($this->version_history as $version => $times_activated) {
-                // check there is a record of when this version was activated.
-                // Otherwise, mark it as unknown
-                if (! $times_activated) {
-                    $times_activated = array('unknown-date');
-                }
-                if (is_string($times_activated)) {
-                    $times_activated = array($times_activated);
-                }
-                foreach ($times_activated as $an_activation) {
-                    if (
-                        $an_activation !== 'unknown-date'
-                        && $an_activation > $most_recently_active_version_activation
-                    ) {
-                        $most_recently_active_version = $version;
-                        $most_recently_active_version_activation = $an_activation === 'unknown-date'
-                            ? '1970-01-01 00:00:00'
-                            : $an_activation;
-                    }
-                }
-            }
-        }
-        return $most_recently_active_version;
-    }
-
-
-
-    /**
-     * Updates the version history for this addon
-     *
-     * @param array|null $version_history
-     * @param string     $current_version
-     * @param bool       $add_current
-     * @return bool success
-     */
-    public function updateActivationHistory($version_history = null, $current_version = '', $add_current  = true)
-    {
-        if ($version_history !== null) {
-            $this->version_history = $version_history;
-        }
-        if ($current_version !== '') {
-            $this->current_version = $current_version;
-        }
-        if(! isset($this->version_history[$this->current_version])) {
-            $this->version_history[$this->current_version] =   array();
-        }
-        if($add_current) {
-            $this->version_history[$this->current_version][] = date('Y-m-d H:i:s');
-        }
-        return update_option(
-            $this->activation_history_option_name,
-            $this->version_history
-        );
-    }
-
-
-
-    /**
-     * Updates the version history for this addon
-     *
-     * @param array|null $version_history
-     * @param string     $current_version
-     * @return boolean success
-     */
-    public function addActivationHistory($version_history = null, $current_version = '')
-    {
-        if ($version_history !== null) {
-            $this->version_history = $version_history;
-        }
-        if ($current_version !== '') {
-            $this->current_version = $current_version;
-        }
-        return add_option(
-            $this->activation_history_option_name,
-            $this->version_history,
-            '',
-            'no'
-        );
-    }
-
-
-
-    /**
-     * @return bool
-     */
-    public function getActivationIndicator()
-    {
-        return get_option($this->activation_indicator_option_name, false);
-    }
-
-
-
-    /**
-     * @return bool
-     */
-    public function setActivationIndicator()
-    {
-        return update_option($this->activation_indicator_option_name, true);
-    }
-
-
-
-    /**
-     * @return bool
-     */
-    public function deleteActivationIndicator()
-    {
-        return delete_option($this->activation_indicator_option_name);
-    }
-
-
-
-    /**
-     * DANGER!!! HOPE YOU KNOW WHAT YOU ARE DOING !!!
-     *
-     * @return bool
-     */
-    public function deleteActivationHistory()
-    {
-        return delete_option($this->activation_history_option_name);
-    }
+	/**
+	 * option name for recording the activation history for core
+	 */
+	const EE_ACTIVATION_HISTORY_OPTION_NAME = 'espresso_db_update';
+
+	/**
+	 * option name for indicating that the current request is for activating core
+	 */
+	const EE_ACTIVATION_INDICATOR_OPTION_NAME = 'ee_espresso_activation';
+
+	/**
+	 * stores the values for the activation history option name for core or an addon
+	 *
+	 * @var string $activation_history_option_name
+	 */
+	protected $activation_history_option_name;
+
+	/**
+	 * stores the values for the activation indicator option name for core or an addon
+	 *
+	 * @var string $activation_indicator_option_name
+	 */
+	protected $activation_indicator_option_name;
+
+	/**
+	 * the current version for core or an addon, like "1.2.3.p"
+	 *
+	 * @var string $current_version
+	 */
+	protected $current_version;
+
+	/**
+	 * array of activated versions and activation dates for core or an addon
+	 *
+	 * @var array $version_history
+	 */
+	protected $version_history;
+
+
+
+	/**
+	 * ActivationHistory constructor.
+	 *
+	 * @param string $activation_history_option_name
+	 * @param string $activation_indicator_option_name
+	 * @param string $current_version
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct(
+		$activation_history_option_name = '',
+		$activation_indicator_option_name = '',
+		$current_version = ''
+	) {
+		$this->setActivationHistoryOptionName($activation_history_option_name);
+		$this->setActivationIndicatorOptionName($activation_indicator_option_name);
+		$this->setCurrentVersion($current_version);
+		$this->version_history = (array) get_option($this->activation_history_option_name, array());
+	}
+
+
+
+	/**
+	 * @param string $activation_history_option_name
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setActivationHistoryOptionName($activation_history_option_name)
+	{
+		if(! is_string($activation_history_option_name)) {
+			throw new InvalidDataTypeException(
+				'$activation_history_option_name',
+				$activation_history_option_name,
+				'string'
+			);
+		}
+		$this->activation_history_option_name = $activation_history_option_name !== ''
+			? $activation_history_option_name
+			: ActivationHistory::EE_ACTIVATION_HISTORY_OPTION_NAME;
+	}
+
+
+
+	/**
+	 * @param string $activation_indicator_option_name
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setActivationIndicatorOptionName($activation_indicator_option_name)
+	{
+		if (! is_string($activation_indicator_option_name)) {
+			throw new InvalidDataTypeException(
+				'$activation_indicator_option_name',
+				$activation_indicator_option_name,
+				'string'
+			);
+		}
+		$this->activation_indicator_option_name = $activation_indicator_option_name !== ''
+			? $activation_indicator_option_name
+			: ActivationHistory::EE_ACTIVATION_INDICATOR_OPTION_NAME;
+	}
+
+
+
+	/**
+	 * @param string $current_version
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setCurrentVersion($current_version)
+	{
+		if (! is_string($current_version)) {
+			throw new InvalidDataTypeException(
+				'$current_version',
+				$current_version,
+				'string'
+			);
+		}
+		$this->current_version = $current_version !== ''
+			? $current_version
+			: espresso_version();
+	}
+
+
+
+
+	/**
+	 * Gets the wp option which stores the activation history for this addon
+	 *
+	 * @return array|bool
+	 */
+	public function getVersionHistory()
+	{
+		return $this->version_history;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function getCurrentVersion()
+	{
+		return $this->current_version;
+	}
+
+
+
+	/**
+	 * Gets the most recently active version listed in the activation history,
+	 * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
+	 *
+	 * @return string
+	 */
+	public function getMostRecentActiveVersion()
+	{
+		$most_recently_active_version_activation = '1970-01-01 00:00:00';
+		$most_recently_active_version = '0.0.0.dev.000';
+		if (is_array($this->version_history) && count($this->version_history)) {
+			foreach ($this->version_history as $version => $times_activated) {
+				// check there is a record of when this version was activated.
+				// Otherwise, mark it as unknown
+				if (! $times_activated) {
+					$times_activated = array('unknown-date');
+				}
+				if (is_string($times_activated)) {
+					$times_activated = array($times_activated);
+				}
+				foreach ($times_activated as $an_activation) {
+					if (
+						$an_activation !== 'unknown-date'
+						&& $an_activation > $most_recently_active_version_activation
+					) {
+						$most_recently_active_version = $version;
+						$most_recently_active_version_activation = $an_activation === 'unknown-date'
+							? '1970-01-01 00:00:00'
+							: $an_activation;
+					}
+				}
+			}
+		}
+		return $most_recently_active_version;
+	}
+
+
+
+	/**
+	 * Updates the version history for this addon
+	 *
+	 * @param array|null $version_history
+	 * @param string     $current_version
+	 * @param bool       $add_current
+	 * @return bool success
+	 */
+	public function updateActivationHistory($version_history = null, $current_version = '', $add_current  = true)
+	{
+		if ($version_history !== null) {
+			$this->version_history = $version_history;
+		}
+		if ($current_version !== '') {
+			$this->current_version = $current_version;
+		}
+		if(! isset($this->version_history[$this->current_version])) {
+			$this->version_history[$this->current_version] =   array();
+		}
+		if($add_current) {
+			$this->version_history[$this->current_version][] = date('Y-m-d H:i:s');
+		}
+		return update_option(
+			$this->activation_history_option_name,
+			$this->version_history
+		);
+	}
+
+
+
+	/**
+	 * Updates the version history for this addon
+	 *
+	 * @param array|null $version_history
+	 * @param string     $current_version
+	 * @return boolean success
+	 */
+	public function addActivationHistory($version_history = null, $current_version = '')
+	{
+		if ($version_history !== null) {
+			$this->version_history = $version_history;
+		}
+		if ($current_version !== '') {
+			$this->current_version = $current_version;
+		}
+		return add_option(
+			$this->activation_history_option_name,
+			$this->version_history,
+			'',
+			'no'
+		);
+	}
+
+
+
+	/**
+	 * @return bool
+	 */
+	public function getActivationIndicator()
+	{
+		return get_option($this->activation_indicator_option_name, false);
+	}
+
+
+
+	/**
+	 * @return bool
+	 */
+	public function setActivationIndicator()
+	{
+		return update_option($this->activation_indicator_option_name, true);
+	}
+
+
+
+	/**
+	 * @return bool
+	 */
+	public function deleteActivationIndicator()
+	{
+		return delete_option($this->activation_indicator_option_name);
+	}
+
+
+
+	/**
+	 * DANGER!!! HOPE YOU KNOW WHAT YOU ARE DOING !!!
+	 *
+	 * @return bool
+	 */
+	public function deleteActivationHistory()
+	{
+		return delete_option($this->activation_history_option_name);
+	}
 
 
 

Spacing +8 added lines, -8 removed lines

@@ -87,7 +87,7 @@ 
      */
     protected function setActivationHistoryOptionName($activation_history_option_name)
     {
-        if(! is_string($activation_history_option_name)) {
+        if ( ! is_string($activation_history_option_name)) {
             throw new InvalidDataTypeException(
                 '$activation_history_option_name',
                 $activation_history_option_name,
@@ -107,7 +107,7 @@ 
      */
     protected function setActivationIndicatorOptionName($activation_indicator_option_name)
     {
-        if (! is_string($activation_indicator_option_name)) {
+        if ( ! is_string($activation_indicator_option_name)) {
             throw new InvalidDataTypeException(
                 '$activation_indicator_option_name',
                 $activation_indicator_option_name,
@@ -127,7 +127,7 @@ 
      */
     protected function setCurrentVersion($current_version)
     {
-        if (! is_string($current_version)) {
+        if ( ! is_string($current_version)) {
             throw new InvalidDataTypeException(
                 '$current_version',
                 $current_version,
@@ -178,7 +178,7 @@ 
             foreach ($this->version_history as $version => $times_activated) {
                 // check there is a record of when this version was activated.
                 // Otherwise, mark it as unknown
-                if (! $times_activated) {
+                if ( ! $times_activated) {
                     $times_activated = array('unknown-date');
                 }
                 if (is_string($times_activated)) {
@@ -210,7 +210,7 @@ 
      * @param bool       $add_current
      * @return bool success
      */
-    public function updateActivationHistory($version_history = null, $current_version = '', $add_current  = true)
+    public function updateActivationHistory($version_history = null, $current_version = '', $add_current = true)
     {
         if ($version_history !== null) {
             $this->version_history = $version_history;
@@ -218,10 +218,10 @@ 
         if ($current_version !== '') {
             $this->current_version = $current_version;
         }
-        if(! isset($this->version_history[$this->current_version])) {
-            $this->version_history[$this->current_version] =   array();
+        if ( ! isset($this->version_history[$this->current_version])) {
+            $this->version_history[$this->current_version] = array();
         }
-        if($add_current) {
+        if ($add_current) {
             $this->version_history[$this->current_version][] = date('Y-m-d H:i:s');
         }
         return update_option(

core/services/activation/InitializeAddon.php

Indentation +138 added lines, -138 removed lines

@@ -24,144 +24,144 @@
 class InitializeAddon implements InitializeInterface
 {
 
-    /**
-     * @var EE_Addon $addon
-     */
-    private $addon;
-
-    /**
-     * @var EE_Data_Migration_Manager $data_migration_manager
-     */
-    private $data_migration_manager;
-
-    /**
-     * @var EE_Maintenance_Mode $maintenance_mode
-     */
-    private $maintenance_mode;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    private $registry;
-
-
-
-    /**
-     * InitializeDatabase constructor.
-     *
-     * @param EE_Addon $addon
-     * @param EE_Data_Migration_Manager $data_migration_manager
-     * @param EE_Maintenance_Mode       $maintenance_mode
-     * @param EE_Registry $registry
-     */
-    public function __construct(
-        EE_Addon $addon,
-        EE_Data_Migration_Manager $data_migration_manager,
-        EE_Maintenance_Mode $maintenance_mode,
-        EE_Registry $registry
-    ) {
-        $this->addon = $addon;
-        $this->data_migration_manager = $data_migration_manager;
-        $this->maintenance_mode = $maintenance_mode;
-        $this->registry = $registry;
-    }
-
-
-    /**
-     * Takes care of double-checking that we're not in maintenance mode, and then
-     * initializing this addon's necessary initial data. This is called by default on new activations
-     * and reactivations
-     *
-     * @param boolean $verify_schema whether to verify the database's schema for this addon, or just its data.
-     *                               This is a resource-intensive job so we prefer to only do it when necessary
-     * @return void
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    public function initialize($verify_schema = true)
-    {
-        if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
-            if ($verify_schema) {
-                $this->initializeDatabase();
-            }
-            $this->initializeDefaultData();
-            //@todo: this will probably need to be adjusted in 4.4 as the array changed formats I believe
-            $this->data_migration_manager->update_current_database_state_to(
-                array(
-                    'slug'    => $this->addon->name(),
-                    'version' => $this->addon->version()
-                )
-            );
-            //in case there are lots of addons being activated at once, let's force garbage collection
-            //to help avoid memory limit errors
-            //EEH_Debug_Tools::instance()->measure_memory( 'db content initialized for ' . get_class( $this), true );
-            gc_collect_cycles();
-        } else {
-            //ask the data migration manager to init this addon's data
-            //when migrations are finished because we can't do it now
-            $this->data_migration_manager->enqueue_db_initialization_for($this->addon->name());
-        }
-    }
-
-
-    /**
-     * Used to setup this addon's database tables, but not necessarily any default
-     * data in them. The default is to actually use the most up-to-date data migration script
-     * for this addon, and just use its schema_changes_before_migration() and schema_changes_after_migration()
-     * methods to setup the db.
-     *
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    public function initializeDatabase()
-    {
-        //find the migration script that sets the database to be compatible with the code
-        $current_dms_name = $this->data_migration_manager->get_most_up_to_date_dms($this->addon->name());
-        if ($current_dms_name) {
-            $current_data_migration_script = $this->registry->load_dms($current_dms_name);
-            $current_data_migration_script->set_migrating(false);
-            $current_data_migration_script->schema_changes_before_migration();
-            $current_data_migration_script->schema_changes_after_migration();
-            if ($current_data_migration_script->get_errors()) {
-                foreach ($current_data_migration_script->get_errors() as $error) {
-                    EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-        }
-        //if not DMS was found that should be ok. This addon just doesn't require any database changes
-        $this->data_migration_manager->update_current_database_state_to(
-            array(
-                'slug'    => $this->addon->name(),
-                'version' => $this->addon->version()
-            )
-        );
-    }
-
-
-
-    /**
-     * If you want to setup default data for the addon, override this method, and call
-     * parent::initialize_default_data() from within it. This is normally called
-     * from EE_Addon::initialize_db_if_no_migrations_required(), just after EE_Addon::initialize_db()
-     * and should verify default data is present (but this is also called
-     * on reactivations and just after migrations, so please verify you actually want
-     * to ADD default data, because it may already be present).
-     * However, please call this parent (currently it just fires a hook which other
-     * addons may be depending on)
-     */
-    public function initializeDefaultData()
-    {
-        /**
-         * Called when an addon is ensuring its default data is set (possibly called
-         * on a reactivation, so first check for the absence of other data before setting
-         * default data)
-         *
-         * @param EE_Addon $addon the addon that called this
-         */
-        do_action('AHEE__EE_Addon__initialize_default_data__begin', $this);
-        //override to insert default data. It is safe to use the models here
-        //because the site should not be in maintenance mode
-    }
+	/**
+	 * @var EE_Addon $addon
+	 */
+	private $addon;
+
+	/**
+	 * @var EE_Data_Migration_Manager $data_migration_manager
+	 */
+	private $data_migration_manager;
+
+	/**
+	 * @var EE_Maintenance_Mode $maintenance_mode
+	 */
+	private $maintenance_mode;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	private $registry;
+
+
+
+	/**
+	 * InitializeDatabase constructor.
+	 *
+	 * @param EE_Addon $addon
+	 * @param EE_Data_Migration_Manager $data_migration_manager
+	 * @param EE_Maintenance_Mode       $maintenance_mode
+	 * @param EE_Registry $registry
+	 */
+	public function __construct(
+		EE_Addon $addon,
+		EE_Data_Migration_Manager $data_migration_manager,
+		EE_Maintenance_Mode $maintenance_mode,
+		EE_Registry $registry
+	) {
+		$this->addon = $addon;
+		$this->data_migration_manager = $data_migration_manager;
+		$this->maintenance_mode = $maintenance_mode;
+		$this->registry = $registry;
+	}
+
+
+	/**
+	 * Takes care of double-checking that we're not in maintenance mode, and then
+	 * initializing this addon's necessary initial data. This is called by default on new activations
+	 * and reactivations
+	 *
+	 * @param boolean $verify_schema whether to verify the database's schema for this addon, or just its data.
+	 *                               This is a resource-intensive job so we prefer to only do it when necessary
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	public function initialize($verify_schema = true)
+	{
+		if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
+			if ($verify_schema) {
+				$this->initializeDatabase();
+			}
+			$this->initializeDefaultData();
+			//@todo: this will probably need to be adjusted in 4.4 as the array changed formats I believe
+			$this->data_migration_manager->update_current_database_state_to(
+				array(
+					'slug'    => $this->addon->name(),
+					'version' => $this->addon->version()
+				)
+			);
+			//in case there are lots of addons being activated at once, let's force garbage collection
+			//to help avoid memory limit errors
+			//EEH_Debug_Tools::instance()->measure_memory( 'db content initialized for ' . get_class( $this), true );
+			gc_collect_cycles();
+		} else {
+			//ask the data migration manager to init this addon's data
+			//when migrations are finished because we can't do it now
+			$this->data_migration_manager->enqueue_db_initialization_for($this->addon->name());
+		}
+	}
+
+
+	/**
+	 * Used to setup this addon's database tables, but not necessarily any default
+	 * data in them. The default is to actually use the most up-to-date data migration script
+	 * for this addon, and just use its schema_changes_before_migration() and schema_changes_after_migration()
+	 * methods to setup the db.
+	 *
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	public function initializeDatabase()
+	{
+		//find the migration script that sets the database to be compatible with the code
+		$current_dms_name = $this->data_migration_manager->get_most_up_to_date_dms($this->addon->name());
+		if ($current_dms_name) {
+			$current_data_migration_script = $this->registry->load_dms($current_dms_name);
+			$current_data_migration_script->set_migrating(false);
+			$current_data_migration_script->schema_changes_before_migration();
+			$current_data_migration_script->schema_changes_after_migration();
+			if ($current_data_migration_script->get_errors()) {
+				foreach ($current_data_migration_script->get_errors() as $error) {
+					EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+		}
+		//if not DMS was found that should be ok. This addon just doesn't require any database changes
+		$this->data_migration_manager->update_current_database_state_to(
+			array(
+				'slug'    => $this->addon->name(),
+				'version' => $this->addon->version()
+			)
+		);
+	}
+
+
+
+	/**
+	 * If you want to setup default data for the addon, override this method, and call
+	 * parent::initialize_default_data() from within it. This is normally called
+	 * from EE_Addon::initialize_db_if_no_migrations_required(), just after EE_Addon::initialize_db()
+	 * and should verify default data is present (but this is also called
+	 * on reactivations and just after migrations, so please verify you actually want
+	 * to ADD default data, because it may already be present).
+	 * However, please call this parent (currently it just fires a hook which other
+	 * addons may be depending on)
+	 */
+	public function initializeDefaultData()
+	{
+		/**
+		 * Called when an addon is ensuring its default data is set (possibly called
+		 * on a reactivation, so first check for the absence of other data before setting
+		 * default data)
+		 *
+		 * @param EE_Addon $addon the addon that called this
+		 */
+		do_action('AHEE__EE_Addon__initialize_default_data__begin', $this);
+		//override to insert default data. It is safe to use the models here
+		//because the site should not be in maintenance mode
+	}
 
 
 

core/services/bootstrap/BootstrapDependencyInjectionContainer.php

Spacing +2 added lines, -2 removed lines

@@ -78,13 +78,13 @@
         // EE_Dependency_Map: info about how to load classes required by other classes
         espresso_load_required(
             'EE_Dependency_Map',
-            EE_CORE . 'EE_Dependency_Map.core.php'
+            EE_CORE.'EE_Dependency_Map.core.php'
         );
         $this->dependency_map = EE_Dependency_Map::instance($this->class_cache);
         // EE_Registry: central repository for classes (legacy)
         espresso_load_required(
             'EE_Registry',
-            EE_CORE . 'EE_Registry.core.php'
+            EE_CORE.'EE_Registry.core.php'
         );
         $this->registry = EE_Registry::instance(
             $this->dependency_map,

Indentation +119 added lines, -119 removed lines

@@ -24,123 +24,123 @@
  */
 class BootstrapDependencyInjectionContainer
 {
-    /**
-     * @var EE_Dependency_Map $dependency_map
-     */
-    protected $dependency_map;
-
-    /**
-     * @type LoaderInterface $loader
-     */
-    protected $loader;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    protected $registry;
-
-    /**
-     * @var ClassInterfaceCache $class_cache
-     */
-    private $class_cache;
-
-    /**
-     * @var Mirror
-     */
-    private $mirror;
-
-    /**
-     * @var ObjectIdentifier
-     */
-    private $object_identifier;
-
-
-    /**
-     * Can't use this just yet until we exorcise some more of our singleton usage from core
-     */
-    public function buildDependencyInjectionContainer()
-    {
-        // build DI container
-        // $OpenCoffeeShop = new EventEspresso\core\services\container\OpenCoffeeShop();
-        // $OpenCoffeeShop->addRecipes();
-        // $CoffeeShop = $OpenCoffeeShop->CoffeeShop();
-    }
-
-
-    /**
-     * Setups  EE_Registry and EE_Dependency_Map
-     *
-     * @throws EE_Error
-     */
-    public function buildLegacyDependencyInjectionContainer()
-    {
-        $this->class_cache = new ClassInterfaceCache();
-        $this->object_identifier = new ObjectIdentifier($this->class_cache);
-        $this->mirror = new Mirror();
-        // EE_Dependency_Map: info about how to load classes required by other classes
-        espresso_load_required(
-            'EE_Dependency_Map',
-            EE_CORE . 'EE_Dependency_Map.core.php'
-        );
-        $this->dependency_map = EE_Dependency_Map::instance($this->class_cache);
-        // EE_Registry: central repository for classes (legacy)
-        espresso_load_required(
-            'EE_Registry',
-            EE_CORE . 'EE_Registry.core.php'
-        );
-        $this->registry = EE_Registry::instance(
-            $this->dependency_map,
-            $this->mirror,
-            $this->class_cache,
-            $this->object_identifier
-        );
-    }
-
-
-    /**
-     * Performs initial setup for the generic Loader
-     *
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function buildLoader()
-    {
-        $this->loader = LoaderFactory::getLoader(
-            $this->registry,
-            $this->class_cache,
-            $this->object_identifier
-        );
-        $this->loader->share('EventEspresso\core\services\loaders\ClassInterfaceCache', $this->class_cache);
-        $this->loader->share('EventEspresso\core\services\loaders\ObjectIdentifier', $this->object_identifier);
-        $this->loader->share('EventEspresso\core\services\container\Mirror', $this->mirror);
-        $this->dependency_map->setLoader($this->loader);
-    }
-
-
-    /**
-     * @return EE_Dependency_Map
-     */
-    public function getDependencyMap()
-    {
-        return $this->dependency_map;
-    }
-
-
-    /**
-     * @return EE_Registry
-     */
-    public function getRegistry()
-    {
-        return $this->registry;
-    }
-
-
-    /**
-     * @return LoaderInterface
-     */
-    public function getLoader()
-    {
-        return $this->loader;
-    }
+	/**
+	 * @var EE_Dependency_Map $dependency_map
+	 */
+	protected $dependency_map;
+
+	/**
+	 * @type LoaderInterface $loader
+	 */
+	protected $loader;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	protected $registry;
+
+	/**
+	 * @var ClassInterfaceCache $class_cache
+	 */
+	private $class_cache;
+
+	/**
+	 * @var Mirror
+	 */
+	private $mirror;
+
+	/**
+	 * @var ObjectIdentifier
+	 */
+	private $object_identifier;
+
+
+	/**
+	 * Can't use this just yet until we exorcise some more of our singleton usage from core
+	 */
+	public function buildDependencyInjectionContainer()
+	{
+		// build DI container
+		// $OpenCoffeeShop = new EventEspresso\core\services\container\OpenCoffeeShop();
+		// $OpenCoffeeShop->addRecipes();
+		// $CoffeeShop = $OpenCoffeeShop->CoffeeShop();
+	}
+
+
+	/**
+	 * Setups  EE_Registry and EE_Dependency_Map
+	 *
+	 * @throws EE_Error
+	 */
+	public function buildLegacyDependencyInjectionContainer()
+	{
+		$this->class_cache = new ClassInterfaceCache();
+		$this->object_identifier = new ObjectIdentifier($this->class_cache);
+		$this->mirror = new Mirror();
+		// EE_Dependency_Map: info about how to load classes required by other classes
+		espresso_load_required(
+			'EE_Dependency_Map',
+			EE_CORE . 'EE_Dependency_Map.core.php'
+		);
+		$this->dependency_map = EE_Dependency_Map::instance($this->class_cache);
+		// EE_Registry: central repository for classes (legacy)
+		espresso_load_required(
+			'EE_Registry',
+			EE_CORE . 'EE_Registry.core.php'
+		);
+		$this->registry = EE_Registry::instance(
+			$this->dependency_map,
+			$this->mirror,
+			$this->class_cache,
+			$this->object_identifier
+		);
+	}
+
+
+	/**
+	 * Performs initial setup for the generic Loader
+	 *
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function buildLoader()
+	{
+		$this->loader = LoaderFactory::getLoader(
+			$this->registry,
+			$this->class_cache,
+			$this->object_identifier
+		);
+		$this->loader->share('EventEspresso\core\services\loaders\ClassInterfaceCache', $this->class_cache);
+		$this->loader->share('EventEspresso\core\services\loaders\ObjectIdentifier', $this->object_identifier);
+		$this->loader->share('EventEspresso\core\services\container\Mirror', $this->mirror);
+		$this->dependency_map->setLoader($this->loader);
+	}
+
+
+	/**
+	 * @return EE_Dependency_Map
+	 */
+	public function getDependencyMap()
+	{
+		return $this->dependency_map;
+	}
+
+
+	/**
+	 * @return EE_Registry
+	 */
+	public function getRegistry()
+	{
+		return $this->registry;
+	}
+
+
+	/**
+	 * @return LoaderInterface
+	 */
+	public function getLoader()
+	{
+		return $this->loader;
+	}
 }

core/domain/services/custom_post_types/RegisterCustomTaxonomyTerms.php

Spacing +1 added lines, -1 removed lines

@@ -65,7 +65,7 @@
      */
     public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array())
     {
-        $this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm(
+        $this->custom_taxonomy_terms[][$term_slug] = new CustomTaxonomyTerm(
             $taxonomy,
             $term_slug,
             $cpt_slugs

Indentation +165 added lines, -165 removed lines

@@ -15,181 +15,181 @@
  */
 class RegisterCustomTaxonomyTerms
 {
-    /**
-     * @var array[] $custom_taxonomy_terms
-     */
-    public $custom_taxonomy_terms = array();
+	/**
+	 * @var array[] $custom_taxonomy_terms
+	 */
+	public $custom_taxonomy_terms = array();
 
 
-    /**
-     * RegisterCustomTaxonomyTerms constructor.
-     */
-    public function __construct()
-    {
-        // hook into save_post so that we can make sure that the default terms get saved on publish of registered cpts
-        // IF they don't have a term for that taxonomy set.
-        add_action('save_post', array($this, 'saveDefaultTerm'), 100, 2);
-        do_action(
-            'AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end',
-            $this
-        );
-    }
+	/**
+	 * RegisterCustomTaxonomyTerms constructor.
+	 */
+	public function __construct()
+	{
+		// hook into save_post so that we can make sure that the default terms get saved on publish of registered cpts
+		// IF they don't have a term for that taxonomy set.
+		add_action('save_post', array($this, 'saveDefaultTerm'), 100, 2);
+		do_action(
+			'AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end',
+			$this
+		);
+	}
 
 
-    public function registerCustomTaxonomyTerms()
-    {
-        // setup default terms in any of our taxonomies (but only if we're in admin).
-        // Why not added via register_activation_hook?
-        // Because it's possible that in future iterations of EE we may add new defaults for specialized taxonomies
-        // (think event_types) and register_activation_hook only reliably runs when a user manually activates the plugin.
-        // Keep in mind that this will READ these terms if they are deleted by the user.  Hence MUST use terms.
-        // if ( is_admin() ) {
-        // $this->set_must_use_event_types();
-        // }
-        // set default terms
-        $this->registerCustomTaxonomyTerm(
-            'espresso_event_type',
-            'single-event',
-            array('espresso_events')
-        );
-    }
+	public function registerCustomTaxonomyTerms()
+	{
+		// setup default terms in any of our taxonomies (but only if we're in admin).
+		// Why not added via register_activation_hook?
+		// Because it's possible that in future iterations of EE we may add new defaults for specialized taxonomies
+		// (think event_types) and register_activation_hook only reliably runs when a user manually activates the plugin.
+		// Keep in mind that this will READ these terms if they are deleted by the user.  Hence MUST use terms.
+		// if ( is_admin() ) {
+		// $this->set_must_use_event_types();
+		// }
+		// set default terms
+		$this->registerCustomTaxonomyTerm(
+			'espresso_event_type',
+			'single-event',
+			array('espresso_events')
+		);
+	}
 
 
-    /**
-     * Allows us to set what the default will be for terms when a cpt is PUBLISHED.
-     *
-     * @param string $taxonomy  The taxonomy we're using for the default term
-     * @param string $term_slug The slug of the term that will be the default.
-     * @param array  $cpt_slugs An array of custom post types we want the default assigned to
-     */
-    public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array())
-    {
-        $this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm(
-            $taxonomy,
-            $term_slug,
-            $cpt_slugs
-        );
-    }
+	/**
+	 * Allows us to set what the default will be for terms when a cpt is PUBLISHED.
+	 *
+	 * @param string $taxonomy  The taxonomy we're using for the default term
+	 * @param string $term_slug The slug of the term that will be the default.
+	 * @param array  $cpt_slugs An array of custom post types we want the default assigned to
+	 */
+	public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array())
+	{
+		$this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm(
+			$taxonomy,
+			$term_slug,
+			$cpt_slugs
+		);
+	}
 
 
-    /**
-     * hooked into the wp 'save_post' action hook for setting our default terms found in the $_default_terms property
-     *
-     * @param  int     $post_id ID of CPT being saved
-     * @param  WP_Post $post    Post object
-     * @return void
-     */
-    public function saveDefaultTerm($post_id, WP_Post $post)
-    {
-        if (empty($this->custom_taxonomy_terms)) {
-            return;
-        }
-        // no default terms set so lets just exit.
-        foreach ($this->custom_taxonomy_terms as $custom_taxonomy_terms) {
-            foreach ($custom_taxonomy_terms as $custom_taxonomy_term) {
-                if (
-                    $post->post_status === 'publish'
-                    && $custom_taxonomy_term instanceof CustomTaxonomyTerm
-                    && in_array($post->post_type, $custom_taxonomy_term->customPostTypeSlugs(), true)
-                ) {
-                    // note some error proofing going on here to save unnecessary db queries
-                    $taxonomies = get_object_taxonomies($post->post_type);
-                    foreach ($taxonomies as $taxonomy) {
-                        $terms = wp_get_post_terms($post_id, $taxonomy);
-                        if (empty($terms) && $taxonomy === $custom_taxonomy_term->taxonomySlug()) {
-                            wp_set_object_terms(
-                                $post_id,
-                                array($custom_taxonomy_term->termSlug()),
-                                $taxonomy
-                            );
-                        }
-                    }
-                }
-            }
-        }
-    }
+	/**
+	 * hooked into the wp 'save_post' action hook for setting our default terms found in the $_default_terms property
+	 *
+	 * @param  int     $post_id ID of CPT being saved
+	 * @param  WP_Post $post    Post object
+	 * @return void
+	 */
+	public function saveDefaultTerm($post_id, WP_Post $post)
+	{
+		if (empty($this->custom_taxonomy_terms)) {
+			return;
+		}
+		// no default terms set so lets just exit.
+		foreach ($this->custom_taxonomy_terms as $custom_taxonomy_terms) {
+			foreach ($custom_taxonomy_terms as $custom_taxonomy_term) {
+				if (
+					$post->post_status === 'publish'
+					&& $custom_taxonomy_term instanceof CustomTaxonomyTerm
+					&& in_array($post->post_type, $custom_taxonomy_term->customPostTypeSlugs(), true)
+				) {
+					// note some error proofing going on here to save unnecessary db queries
+					$taxonomies = get_object_taxonomies($post->post_type);
+					foreach ($taxonomies as $taxonomy) {
+						$terms = wp_get_post_terms($post_id, $taxonomy);
+						if (empty($terms) && $taxonomy === $custom_taxonomy_term->taxonomySlug()) {
+							wp_set_object_terms(
+								$post_id,
+								array($custom_taxonomy_term->termSlug()),
+								$taxonomy
+							);
+						}
+					}
+				}
+			}
+		}
+	}
 
 
-    /**
-     * @return void
-     */
-    public function setMustUseEventTypes()
-    {
-        $term_details = array(
-            // Attendee's register for the first date-time only
-            'single-event'    => array(
-                'term' => esc_html__('Single Event', 'event_espresso'),
-                'desc' => esc_html__(
-                    'A single event that spans one or more consecutive days.',
-                    'event_espresso'
-                ),
-            ),
-            // example: a party or two-day long workshop
-            // Attendee's can register for any of the date-times
-            'multi-event'     => array(
-                'term' => esc_html__('Multi Event', 'event_espresso'),
-                'desc' => esc_html__(
-                    'Multiple, separate, but related events that occur on consecutive days.',
-                    'event_espresso'
-                ),
-            ),
-            // example: a three day music festival or week long conference
-            // Attendee's register for the first date-time only
-            'event-series'    => array(
-                'term' => esc_html__('Event Series', 'event_espresso'),
-                'desc' => esc_html__(
-                    ' Multiple events that occur over multiple non-consecutive days.',
-                    'event_espresso'
-                ),
-            ),
-            // example: an 8 week introduction to basket weaving course
-            // Attendee's can register for any of the date-times.
-            'recurring-event' => array(
-                'term' => esc_html__('Recurring Event', 'event_espresso'),
-                'desc' => esc_html__(
-                    'Multiple events that occur over multiple non-consecutive days.',
-                    'event_espresso'
-                ),
-            ),
-            // example: a yoga class
-            'ongoing'         => array(
-                'term' => esc_html__('Ongoing Event', 'event_espresso'),
-                'desc' => esc_html__(
-                    'An "event" that people can purchase tickets to gain access for anytime for this event regardless of date times on the event',
-                    'event_espresso'
-                ),
-            )
-            // example: access to a museum
-            // 'walk-in' => array( esc_html__('Walk In', 'event_espresso'), esc_html__('Single datetime and single entry recurring events. Attendees register for one or multiple datetimes individually.', 'event_espresso') ),
-            // 'reservation' => array( esc_html__('Reservation', 'event_espresso'), esc_html__('Reservations are created by specifying available datetimes and quantities. Attendees choose from the available datetimes and specify the quantity available (if the maximum is greater than 1)') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1
-            // 'multiple-session' => array( esc_html__('Multiple Session', 'event_espresso'), esc_html__('Multiple event, multiple datetime, hierarchically organized, custom entry events. Attendees may be required to register for a parent event before being allowed to register for child events. Attendees can register for any combination of child events as long as the datetimes do not conflict. Parent and child events may have additional fees or registration questions.') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1
-            // 'appointment' => array( esc_html__('Appointments', 'event_espresso'), esc_html__('Time slotted events where datetimes are generally in hours or minutes. For example, attendees can register for a single 15 minute or 1 hour time slot and this type of availability frequently reoccurs.', 'event_espresso') )
-        );
-        $this->setMustUseTerms('espresso_event_type', $term_details);
-    }
+	/**
+	 * @return void
+	 */
+	public function setMustUseEventTypes()
+	{
+		$term_details = array(
+			// Attendee's register for the first date-time only
+			'single-event'    => array(
+				'term' => esc_html__('Single Event', 'event_espresso'),
+				'desc' => esc_html__(
+					'A single event that spans one or more consecutive days.',
+					'event_espresso'
+				),
+			),
+			// example: a party or two-day long workshop
+			// Attendee's can register for any of the date-times
+			'multi-event'     => array(
+				'term' => esc_html__('Multi Event', 'event_espresso'),
+				'desc' => esc_html__(
+					'Multiple, separate, but related events that occur on consecutive days.',
+					'event_espresso'
+				),
+			),
+			// example: a three day music festival or week long conference
+			// Attendee's register for the first date-time only
+			'event-series'    => array(
+				'term' => esc_html__('Event Series', 'event_espresso'),
+				'desc' => esc_html__(
+					' Multiple events that occur over multiple non-consecutive days.',
+					'event_espresso'
+				),
+			),
+			// example: an 8 week introduction to basket weaving course
+			// Attendee's can register for any of the date-times.
+			'recurring-event' => array(
+				'term' => esc_html__('Recurring Event', 'event_espresso'),
+				'desc' => esc_html__(
+					'Multiple events that occur over multiple non-consecutive days.',
+					'event_espresso'
+				),
+			),
+			// example: a yoga class
+			'ongoing'         => array(
+				'term' => esc_html__('Ongoing Event', 'event_espresso'),
+				'desc' => esc_html__(
+					'An "event" that people can purchase tickets to gain access for anytime for this event regardless of date times on the event',
+					'event_espresso'
+				),
+			)
+			// example: access to a museum
+			// 'walk-in' => array( esc_html__('Walk In', 'event_espresso'), esc_html__('Single datetime and single entry recurring events. Attendees register for one or multiple datetimes individually.', 'event_espresso') ),
+			// 'reservation' => array( esc_html__('Reservation', 'event_espresso'), esc_html__('Reservations are created by specifying available datetimes and quantities. Attendees choose from the available datetimes and specify the quantity available (if the maximum is greater than 1)') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1
+			// 'multiple-session' => array( esc_html__('Multiple Session', 'event_espresso'), esc_html__('Multiple event, multiple datetime, hierarchically organized, custom entry events. Attendees may be required to register for a parent event before being allowed to register for child events. Attendees can register for any combination of child events as long as the datetimes do not conflict. Parent and child events may have additional fees or registration questions.') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1
+			// 'appointment' => array( esc_html__('Appointments', 'event_espresso'), esc_html__('Time slotted events where datetimes are generally in hours or minutes. For example, attendees can register for a single 15 minute or 1 hour time slot and this type of availability frequently reoccurs.', 'event_espresso') )
+		);
+		$this->setMustUseTerms('espresso_event_type', $term_details);
+	}
 
 
-    /**
-     * wrapper method for handling the setting up of initial terms in the db (if they don't already exist).
-     * Note this should ONLY be used for terms that always must be present.  Be aware that if an initial term is
-     * deleted then it WILL be recreated.
-     *
-     * @param string $taxonomy     The name of the taxonomy
-     * @param array  $term_details An array of term details indexed by slug and containing Name of term, and
-     *                             description as the elements in the array
-     * @return void
-     */
-    public function setMustUseTerms($taxonomy, $term_details)
-    {
-        $term_details = (array) $term_details;
-        foreach ($term_details as $slug => $details) {
-            if (isset($details['term'], $details['desc']) && ! term_exists($slug, $taxonomy)) {
-                $insert_arr = array(
-                    'slug'        => $slug,
-                    'description' => $details['desc'],
-                );
-                wp_insert_term($details['term'], $taxonomy, $insert_arr);
-            }
-        }
-    }
+	/**
+	 * wrapper method for handling the setting up of initial terms in the db (if they don't already exist).
+	 * Note this should ONLY be used for terms that always must be present.  Be aware that if an initial term is
+	 * deleted then it WILL be recreated.
+	 *
+	 * @param string $taxonomy     The name of the taxonomy
+	 * @param array  $term_details An array of term details indexed by slug and containing Name of term, and
+	 *                             description as the elements in the array
+	 * @return void
+	 */
+	public function setMustUseTerms($taxonomy, $term_details)
+	{
+		$term_details = (array) $term_details;
+		foreach ($term_details as $slug => $details) {
+			if (isset($details['term'], $details['desc']) && ! term_exists($slug, $taxonomy)) {
+				$insert_arr = array(
+					'slug'        => $slug,
+					'description' => $details['desc'],
+				);
+				wp_insert_term($details['term'], $taxonomy, $insert_arr);
+			}
+		}
+	}
 }