eventespresso / event-espresso-core

core/services/helpers/datetime/HelperInterface.php

Indentation +90 added lines, -90 removed lines

@@ -16,94 +16,94 @@
 interface HelperInterface
 {
 
-    /**
-     * Ensures that a valid timezone string is returned.
-     *
-     * @param string $timezone_string  When not provided then attempt to use the timezone_string set in the WP Time
-     *                                 settings (or derive from set UTC offset).
-     * @return string
-     */
-    public function getValidTimezoneString($timezone_string = '');
-
-
-    /**
-     * The only purpose for this static method is to validate that the incoming timezone is a valid php timezone.
-     *
-     * @param string $timezone_string
-     * @param bool   $throw_error
-     * @return bool
-     */
-    public function validateTimezone($timezone_string, $throw_error = true);
-
-
-    /**
-     * Returns a timezone string for the provided gmt_offset.
-     * @param float|string $gmt_offset
-     * @return string
-     */
-    public function getTimezoneStringFromGmtOffset($gmt_offset = '');
-
-
-    /**
-     * Gets the site's GMT offset based on either the timezone string
-     * (in which case the gmt offset will vary depending on the location's
-     * observance of daylight savings time) or the gmt_offset wp option
-     *
-     * @return int  seconds offset
-     */
-    public function getSiteTimezoneGmtOffset();
-
-
-    /**
-     * Get timezone transitions
-     * @param DateTimeZone $date_time_zone
-     * @param int|null     $time
-     * @param bool         $first_only
-     * @return array
-     */
-    public function getTimezoneTransitions(DateTimeZone $date_time_zone, $time = null, $first_only = true);
-
-
-    /**
-     * Get Timezone offset for given timezone object
-     * @param DateTimeZone $date_time_zone
-     * @param null|int         $time
-     * @return int
-     */
-    public function getTimezoneOffset(DateTimeZone $date_time_zone, $time = null);
-
-
-    /**
-     * Provide a timezone select input
-     * @param string $timezone_string
-     * @return string
-     */
-    public function timezoneSelectInput($timezone_string = '');
-
-
-    /**
-     * This method will take an incoming unix timestamp and add the offset to it for the given timezone_string.
-     * If no unix timestamp is given then time() is used.  If no timezone is given then the set timezone string for
-     * the site is used.
-     * This is used typically when using a Unix timestamp any core WP functions that expect their specially
-     * computed timestamp (i.e. date_i18n() )
-     *
-     * @param int    $unix_timestamp    if 0, then time() will be used.
-     * @param string $timezone_string timezone_string. If empty, then the current set timezone for the
-     *                                site will be used.
-     * @return int      unix_timestamp value with the offset applied for the given timezone.
-     */
-    public function getTimestampWithOffset($unix_timestamp = 0, $timezone_string = '');
-
-
-    /**
-     * Depending on PHP version,
-     * there might not be valid current timezone strings to match these gmt_offsets in its timezone tables.
-     * To get around that, for these fringe timezones we bump them to a known valid offset.
-     * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset.
-     *
-     * @param int $gmt_offset
-     * @return int
-     */
-    public function adjustInvalidGmtOffsets($gmt_offset);
+	/**
+	 * Ensures that a valid timezone string is returned.
+	 *
+	 * @param string $timezone_string  When not provided then attempt to use the timezone_string set in the WP Time
+	 *                                 settings (or derive from set UTC offset).
+	 * @return string
+	 */
+	public function getValidTimezoneString($timezone_string = '');
+
+
+	/**
+	 * The only purpose for this static method is to validate that the incoming timezone is a valid php timezone.
+	 *
+	 * @param string $timezone_string
+	 * @param bool   $throw_error
+	 * @return bool
+	 */
+	public function validateTimezone($timezone_string, $throw_error = true);
+
+
+	/**
+	 * Returns a timezone string for the provided gmt_offset.
+	 * @param float|string $gmt_offset
+	 * @return string
+	 */
+	public function getTimezoneStringFromGmtOffset($gmt_offset = '');
+
+
+	/**
+	 * Gets the site's GMT offset based on either the timezone string
+	 * (in which case the gmt offset will vary depending on the location's
+	 * observance of daylight savings time) or the gmt_offset wp option
+	 *
+	 * @return int  seconds offset
+	 */
+	public function getSiteTimezoneGmtOffset();
+
+
+	/**
+	 * Get timezone transitions
+	 * @param DateTimeZone $date_time_zone
+	 * @param int|null     $time
+	 * @param bool         $first_only
+	 * @return array
+	 */
+	public function getTimezoneTransitions(DateTimeZone $date_time_zone, $time = null, $first_only = true);
+
+
+	/**
+	 * Get Timezone offset for given timezone object
+	 * @param DateTimeZone $date_time_zone
+	 * @param null|int         $time
+	 * @return int
+	 */
+	public function getTimezoneOffset(DateTimeZone $date_time_zone, $time = null);
+
+
+	/**
+	 * Provide a timezone select input
+	 * @param string $timezone_string
+	 * @return string
+	 */
+	public function timezoneSelectInput($timezone_string = '');
+
+
+	/**
+	 * This method will take an incoming unix timestamp and add the offset to it for the given timezone_string.
+	 * If no unix timestamp is given then time() is used.  If no timezone is given then the set timezone string for
+	 * the site is used.
+	 * This is used typically when using a Unix timestamp any core WP functions that expect their specially
+	 * computed timestamp (i.e. date_i18n() )
+	 *
+	 * @param int    $unix_timestamp    if 0, then time() will be used.
+	 * @param string $timezone_string timezone_string. If empty, then the current set timezone for the
+	 *                                site will be used.
+	 * @return int      unix_timestamp value with the offset applied for the given timezone.
+	 */
+	public function getTimestampWithOffset($unix_timestamp = 0, $timezone_string = '');
+
+
+	/**
+	 * Depending on PHP version,
+	 * there might not be valid current timezone strings to match these gmt_offsets in its timezone tables.
+	 * To get around that, for these fringe timezones we bump them to a known valid offset.
+	 * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset.
+	 *
+	 * @param int $gmt_offset
+	 * @return int
+	 */
+	public function adjustInvalidGmtOffsets($gmt_offset);
 }

core/services/context/ContextChecker.php

Spacing +1 added lines, -1 removed lines

@@ -87,7 +87,7 @@
     {
         $this->evaluation_callback = $evaluation_callback instanceof Closure
             ? $evaluation_callback
-            : function (ContextInterface $context, $acceptable_values) {
+            : function(ContextInterface $context, $acceptable_values) {
                 return in_array($context->slug(), $acceptable_values, true);
             };
     }

Indentation +141 added lines, -141 removed lines

@@ -17,145 +17,145 @@
 class ContextChecker
 {
 
-    /**
-     * A unique string used to identify where this ContextChecker is being employed
-     * Is currently only used within the hook name for the filterable return value of isAllowed().
-     *
-     * @var string $identifier
-     */
-    private $identifier;
-
-    /**
-     * A list of values to be compared against the slug of the Context class passed to isAllowed()
-     *
-     * @var array $acceptable_values
-     */
-    private $acceptable_values;
-
-    /**
-     * Closure that will be called to perform the evaluation within isAllowed().
-     * If none is provided, then a simple type sensitive in_array() check will be used
-     * and return true if the incoming Context::slug() is found within the array of $acceptable_values.
-     *
-     * @var Closure $evaluation_callback
-     */
-    private $evaluation_callback;
-
-
-    /**
-     * ContextChecker constructor.
-     *
-     * @param string       $identifier
-     * @param array        $acceptable_values
-     * @param Closure|null $evaluation_callback [optional]
-     */
-    public function __construct($identifier, array $acceptable_values, Closure $evaluation_callback = null)
-    {
-        $this->setIdentifier($identifier);
-        $this->setAcceptableValues($acceptable_values);
-        $this->setEvaluationCallback($evaluation_callback);
-    }
-
-
-    /**
-     * @param string $identifier
-     */
-    private function setIdentifier($identifier)
-    {
-        $this->identifier = sanitize_key($identifier);
-    }
-
-
-    /**
-     * @param array $acceptable_values
-     */
-    private function setAcceptableValues(array $acceptable_values)
-    {
-        $this->acceptable_values = $acceptable_values;
-    }
-
-
-    /**
-     * @param Closure $evaluation_callback
-     */
-    private function setEvaluationCallback(Closure $evaluation_callback = null)
-    {
-        $this->evaluation_callback = $evaluation_callback instanceof Closure
-            ? $evaluation_callback
-            : function (ContextInterface $context, $acceptable_values) {
-                return in_array($context->slug(), $acceptable_values, true);
-            };
-    }
-
-
-    /**
-     * @return string
-     */
-    protected function identifier()
-    {
-        return $this->identifier;
-    }
-
-
-    /**
-     * @return array
-     */
-    protected function acceptableValues()
-    {
-        return apply_filters(
-            "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__{$this->identifier}__acceptableValues",
-            $this->acceptable_values
-        );
-    }
-
-
-    /**
-     * @return Closure
-     */
-    protected function evaluationCallback()
-    {
-        return $this->evaluation_callback;
-    }
-
-
-    /**
-     * Returns true if the incoming Context class slug matches one of the preset acceptable values.
-     * The result is filterable using the identifier for this ContextChecker.
-     * example:
-     * If this ContextChecker's $identifier was set to "registration-checkout-type",
-     * then the filter here would be named:
-     *  "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed".
-     * Other code could hook into the filter in isAllowed() using the above name
-     * and test for additional acceptable values.
-     * So if the set of $acceptable_values was: [ "initial-visit",  "revisit" ]
-     * then adding a filter to
-     *  "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed",
-     * would allow you to perform your own conditional and allow "wait-list-checkout" as an acceptable value.
-     *  example:
-     *      add_filter(
-     *          'FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed',
-     *          function ($is_allowed, ContextInterface $context) { return $context->slug() === 'wait-list-checkout'
-     *                  ? true
-     *                  : $is_allowed;
-     *          },
-     *          10,
-     *          2
-     *      );
-     *
-     * @param ContextInterface $context
-     * @return boolean
-     */
-    public function isAllowed(ContextInterface $context)
-    {
-        $evaluation_callback = $this->evaluationCallback();
-        return filter_var(
-            apply_filters(
-                "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__{$this->identifier}__isAllowed",
-                $evaluation_callback($context, $this->acceptableValues()),
-                $context,
-                $this
-            ),
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
+	/**
+	 * A unique string used to identify where this ContextChecker is being employed
+	 * Is currently only used within the hook name for the filterable return value of isAllowed().
+	 *
+	 * @var string $identifier
+	 */
+	private $identifier;
+
+	/**
+	 * A list of values to be compared against the slug of the Context class passed to isAllowed()
+	 *
+	 * @var array $acceptable_values
+	 */
+	private $acceptable_values;
+
+	/**
+	 * Closure that will be called to perform the evaluation within isAllowed().
+	 * If none is provided, then a simple type sensitive in_array() check will be used
+	 * and return true if the incoming Context::slug() is found within the array of $acceptable_values.
+	 *
+	 * @var Closure $evaluation_callback
+	 */
+	private $evaluation_callback;
+
+
+	/**
+	 * ContextChecker constructor.
+	 *
+	 * @param string       $identifier
+	 * @param array        $acceptable_values
+	 * @param Closure|null $evaluation_callback [optional]
+	 */
+	public function __construct($identifier, array $acceptable_values, Closure $evaluation_callback = null)
+	{
+		$this->setIdentifier($identifier);
+		$this->setAcceptableValues($acceptable_values);
+		$this->setEvaluationCallback($evaluation_callback);
+	}
+
+
+	/**
+	 * @param string $identifier
+	 */
+	private function setIdentifier($identifier)
+	{
+		$this->identifier = sanitize_key($identifier);
+	}
+
+
+	/**
+	 * @param array $acceptable_values
+	 */
+	private function setAcceptableValues(array $acceptable_values)
+	{
+		$this->acceptable_values = $acceptable_values;
+	}
+
+
+	/**
+	 * @param Closure $evaluation_callback
+	 */
+	private function setEvaluationCallback(Closure $evaluation_callback = null)
+	{
+		$this->evaluation_callback = $evaluation_callback instanceof Closure
+			? $evaluation_callback
+			: function (ContextInterface $context, $acceptable_values) {
+				return in_array($context->slug(), $acceptable_values, true);
+			};
+	}
+
+
+	/**
+	 * @return string
+	 */
+	protected function identifier()
+	{
+		return $this->identifier;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	protected function acceptableValues()
+	{
+		return apply_filters(
+			"FHEE__EventEspresso_core_domain_entities_context_ContextChecker__{$this->identifier}__acceptableValues",
+			$this->acceptable_values
+		);
+	}
+
+
+	/**
+	 * @return Closure
+	 */
+	protected function evaluationCallback()
+	{
+		return $this->evaluation_callback;
+	}
+
+
+	/**
+	 * Returns true if the incoming Context class slug matches one of the preset acceptable values.
+	 * The result is filterable using the identifier for this ContextChecker.
+	 * example:
+	 * If this ContextChecker's $identifier was set to "registration-checkout-type",
+	 * then the filter here would be named:
+	 *  "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed".
+	 * Other code could hook into the filter in isAllowed() using the above name
+	 * and test for additional acceptable values.
+	 * So if the set of $acceptable_values was: [ "initial-visit",  "revisit" ]
+	 * then adding a filter to
+	 *  "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed",
+	 * would allow you to perform your own conditional and allow "wait-list-checkout" as an acceptable value.
+	 *  example:
+	 *      add_filter(
+	 *          'FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed',
+	 *          function ($is_allowed, ContextInterface $context) { return $context->slug() === 'wait-list-checkout'
+	 *                  ? true
+	 *                  : $is_allowed;
+	 *          },
+	 *          10,
+	 *          2
+	 *      );
+	 *
+	 * @param ContextInterface $context
+	 * @return boolean
+	 */
+	public function isAllowed(ContextInterface $context)
+	{
+		$evaluation_callback = $this->evaluationCallback();
+		return filter_var(
+			apply_filters(
+				"FHEE__EventEspresso_core_domain_entities_context_ContextChecker__{$this->identifier}__isAllowed",
+				$evaluation_callback($context, $this->acceptableValues()),
+				$context,
+				$this
+			),
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
 }

core/domain/entities/contexts/ContextInterface.php

Indentation +8 added lines, -8 removed lines

@@ -18,14 +18,14 @@
 interface ContextInterface
 {
 
-    /**
-     * @return string
-     */
-    public function slug();
+	/**
+	 * @return string
+	 */
+	public function slug();
 
 
-    /**
-     * @return string
-     */
-    public function description();
+	/**
+	 * @return string
+	 */
+	public function description();
 }

core/domain/services/factories/CartFactory.php

Indentation +10 added lines, -10 removed lines

@@ -23,14 +23,14 @@
 class CartFactory
 {
 
-    /**
-     * @return EE_Cart
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function getCart()
-    {
-        return LoaderFactory::getLoader()->getShared('EE_Cart');
-    }
+	/**
+	 * @return EE_Cart
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function getCart()
+	{
+		return LoaderFactory::getLoader()->getShared('EE_Cart');
+	}
 }

core/domain/services/factories/ModelFactory.php

Indentation +13 added lines, -13 removed lines

@@ -25,17 +25,17 @@
 class ModelFactory
 {
 
-    /**
-     * @param string $model_name
-     * @return bool|EEM_Base
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public static function getModel($model_name)
-    {
-        return EE_Registry::instance()->load_model($model_name);
-    }
+	/**
+	 * @param string $model_name
+	 * @return bool|EEM_Base
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public static function getModel($model_name)
+	{
+		return EE_Registry::instance()->load_model($model_name);
+	}
 }

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

@@ -22,217 +22,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__);
+	}
 }

core/domain/entities/notifications/PersistentAdminNotice.php

Spacing +7 added lines, -7 removed lines

@@ -130,7 +130,7 @@ 
      */
     private function setName($name)
     {
-        if (! is_string($name)) {
+        if ( ! is_string($name)) {
             throw new InvalidDataTypeException('$name', $name, 'string');
         }
         $this->name = sanitize_key($name);
@@ -154,7 +154,7 @@ 
      */
     private function setMessage($message)
     {
-        if (! is_string($message)) {
+        if ( ! is_string($message)) {
             throw new InvalidDataTypeException('$message', $message, 'string');
         }
         global $allowedtags;
@@ -200,7 +200,7 @@ 
      */
     private function setCapability($capability)
     {
-        if (! is_string($capability)) {
+        if ( ! is_string($capability)) {
             throw new InvalidDataTypeException('$capability', $capability, 'string');
         }
         $this->capability = ! empty($capability) ? $capability : 'manage_options';
@@ -224,7 +224,7 @@ 
      */
     private function setCapContext($cap_context)
     {
-        if (! is_string($cap_context)) {
+        if ( ! is_string($cap_context)) {
             throw new InvalidDataTypeException('$cap_context', $cap_context, 'string');
         }
         $this->cap_context = ! empty($cap_context) ? $cap_context : 'view persistent admin notice';
@@ -258,7 +258,7 @@ 
      */
     public function getCapCheck()
     {
-        if (! $this->cap_check instanceof CapCheckInterface) {
+        if ( ! $this->cap_check instanceof CapCheckInterface) {
             $this->setCapCheck(
                 new CapCheck(
                     $this->capability,
@@ -343,10 +343,10 @@ 
      */
     public function confirmRegistered()
     {
-        if (! apply_filters('PersistentAdminNoticeManager__registerAndSaveNotices__complete', false)) {
+        if ( ! apply_filters('PersistentAdminNoticeManager__registerAndSaveNotices__complete', false)) {
             PersistentAdminNoticeManager::loadRegisterAndSaveNotices();
         }
-        if (! $this->registered && WP_DEBUG) {
+        if ( ! $this->registered && WP_DEBUG) {
             throw new DomainException(
                 sprintf(
                     esc_html__(

Indentation +312 added lines, -312 removed lines

@@ -25,316 +25,316 @@
 class PersistentAdminNotice implements RequiresCapCheckInterface
 {
 
-    /**
-     * @var string $name
-     */
-    protected $name = '';
-
-    /**
-     * @var string $message
-     */
-    protected $message = '';
-
-    /**
-     * @var boolean $force_update
-     */
-    protected $force_update = false;
-
-    /**
-     * @var string $capability
-     */
-    protected $capability = 'manage_options';
-
-    /**
-     * @var string $cap_context
-     */
-    protected $cap_context = 'view persistent admin notice';
-
-    /**
-     * @var boolean $dismissed
-     */
-    protected $dismissed = false;
-
-    /**
-     * @var CapCheckInterface $cap_check
-     */
-    protected $cap_check;
-
-    /**
-     * if true, then this notice will be deleted from the database
-     *
-     * @var boolean $purge
-     */
-    protected $purge = false;
-
-    /**
-     * gets set to true if notice is successfully registered with the PersistentAdminNoticeManager
-     * if false, and WP_DEBUG is on, then an exception will be thrown in the admin footer
-     *
-     * @var boolean $registered
-     */
-    private $registered = false;
-
-
-    /**
-     * PersistentAdminNotice constructor
-     *
-     * @param string $name         [required] the name, or key of the Persistent Admin Notice to be stored
-     * @param string $message      [required] the message to be stored persistently until dismissed
-     * @param bool   $force_update enforce the reappearance of a persistent message
-     * @param string $capability   user capability required to view this notice
-     * @param string $cap_context  description for why the cap check is being performed
-     * @param bool   $dismissed    whether or not the user has already dismissed/viewed this notice
-     * @throws InvalidDataTypeException
-     */
-    public function __construct(
-        $name,
-        $message,
-        $force_update = false,
-        $capability = 'manage_options',
-        $cap_context = 'view persistent admin notice',
-        $dismissed = false
-    ) {
-        $this->setName($name);
-        $this->setMessage($message);
-        $this->setForceUpdate($force_update);
-        $this->setCapability($capability);
-        $this->setCapContext($cap_context);
-        $this->setDismissed($dismissed);
-        add_action(
-            'AHEE__EventEspresso_core_services_notifications_PersistentAdminNoticeManager__registerNotices',
-            array($this, 'registerPersistentAdminNotice')
-        );
-        add_action('shutdown', array($this, 'confirmRegistered'), 999);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getName()
-    {
-        return $this->name;
-    }
-
-
-    /**
-     * @param string $name
-     * @throws InvalidDataTypeException
-     */
-    private function setName($name)
-    {
-        if (! is_string($name)) {
-            throw new InvalidDataTypeException('$name', $name, 'string');
-        }
-        $this->name = sanitize_key($name);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getMessage()
-    {
-        return $this->message;
-    }
-
-
-    /**
-     * @param string $message
-     * @throws InvalidDataTypeException
-     */
-    private function setMessage($message)
-    {
-        if (! is_string($message)) {
-            throw new InvalidDataTypeException('$message', $message, 'string');
-        }
-        global $allowedtags;
-        $allowedtags['br'] = array();
-        $this->message = wp_kses($message, $allowedtags);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function getForceUpdate()
-    {
-        return $this->force_update;
-    }
-
-
-    /**
-     * @param bool $force_update
-     */
-    private function setForceUpdate($force_update)
-    {
-        $this->force_update = filter_var($force_update, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getCapability()
-    {
-        return $this->capability;
-    }
-
-
-    /**
-     * @param string $capability
-     * @throws InvalidDataTypeException
-     */
-    private function setCapability($capability)
-    {
-        if (! is_string($capability)) {
-            throw new InvalidDataTypeException('$capability', $capability, 'string');
-        }
-        $this->capability = ! empty($capability) ? $capability : 'manage_options';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getCapContext()
-    {
-        return $this->cap_context;
-    }
-
-
-    /**
-     * @param string $cap_context
-     * @throws InvalidDataTypeException
-     */
-    private function setCapContext($cap_context)
-    {
-        if (! is_string($cap_context)) {
-            throw new InvalidDataTypeException('$cap_context', $cap_context, 'string');
-        }
-        $this->cap_context = ! empty($cap_context) ? $cap_context : 'view persistent admin notice';
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function getDismissed()
-    {
-        return $this->dismissed;
-    }
-
-
-    /**
-     * @param bool $dismissed
-     */
-    public function setDismissed($dismissed)
-    {
-        $this->dismissed = filter_var($dismissed, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return CapCheckInterface
-     * @throws InvalidDataTypeException
-     */
-    public function getCapCheck()
-    {
-        if (! $this->cap_check instanceof CapCheckInterface) {
-            $this->setCapCheck(
-                new CapCheck(
-                    $this->capability,
-                    $this->cap_context
-                )
-            );
-        }
-        return $this->cap_check;
-    }
-
-
-    /**
-     * @param CapCheckInterface $cap_check
-     */
-    private function setCapCheck(CapCheckInterface $cap_check)
-    {
-        $this->cap_check = $cap_check;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function getPurge()
-    {
-        return $this->purge;
-    }
-
-
-    /**
-     * @param bool $purge
-     */
-    public function setPurge($purge)
-    {
-        $this->purge = filter_var($purge, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * given a valid PersistentAdminNotice Collection,
-     * this notice will be added if it is not already found in the collection (using its name as the identifier)
-     * if an existing notice is found that has already been dismissed,
-     * but we are overriding with a forced update, then we will toggle its dismissed state,
-     * so that the notice is displayed again
-     *
-     * @param Collection $persistent_admin_notice_collection
-     * @throws InvalidEntityException
-     * @throws InvalidDataTypeException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    public function registerPersistentAdminNotice(Collection $persistent_admin_notice_collection)
-    {
-        if ($this->registered) {
-            return;
-        }
-        // first check if this notice has already been added to the collection
-        if ($persistent_admin_notice_collection->has($this->name)) {
-            /** @var PersistentAdminNotice $existing */
-            $existing = $persistent_admin_notice_collection->get($this->name);
-            // we don't need to add it again (we can't actually)
-            // but if it has already been dismissed, and we are overriding with a forced update
-            if ($existing->getDismissed() && $this->getForceUpdate()) {
-                // then toggle the notice's dismissed state to true
-                // so that it gets displayed again
-                $existing->setDismissed(false);
-                // and make sure the message is set
-                $existing->setMessage($this->message);
-            }
-        } else {
-            $persistent_admin_notice_collection->add($this, $this->name);
-        }
-        $this->registered = true;
-    }
-
-
-    /**
-     * @throws Exception
-     */
-    public function confirmRegistered()
-    {
-        if (! apply_filters('PersistentAdminNoticeManager__registerAndSaveNotices__complete', false)) {
-            PersistentAdminNoticeManager::loadRegisterAndSaveNotices();
-        }
-        if (! $this->registered && WP_DEBUG) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'The "%1$s" PersistentAdminNotice was not successfully registered. Please ensure that it is being created prior to either the "admin_notices" or "network_admin_notices" hooks being triggered.',
-                        'event_espresso'
-                    ),
-                    $this->name
-                )
-            );
-        }
-    }
+	/**
+	 * @var string $name
+	 */
+	protected $name = '';
+
+	/**
+	 * @var string $message
+	 */
+	protected $message = '';
+
+	/**
+	 * @var boolean $force_update
+	 */
+	protected $force_update = false;
+
+	/**
+	 * @var string $capability
+	 */
+	protected $capability = 'manage_options';
+
+	/**
+	 * @var string $cap_context
+	 */
+	protected $cap_context = 'view persistent admin notice';
+
+	/**
+	 * @var boolean $dismissed
+	 */
+	protected $dismissed = false;
+
+	/**
+	 * @var CapCheckInterface $cap_check
+	 */
+	protected $cap_check;
+
+	/**
+	 * if true, then this notice will be deleted from the database
+	 *
+	 * @var boolean $purge
+	 */
+	protected $purge = false;
+
+	/**
+	 * gets set to true if notice is successfully registered with the PersistentAdminNoticeManager
+	 * if false, and WP_DEBUG is on, then an exception will be thrown in the admin footer
+	 *
+	 * @var boolean $registered
+	 */
+	private $registered = false;
+
+
+	/**
+	 * PersistentAdminNotice constructor
+	 *
+	 * @param string $name         [required] the name, or key of the Persistent Admin Notice to be stored
+	 * @param string $message      [required] the message to be stored persistently until dismissed
+	 * @param bool   $force_update enforce the reappearance of a persistent message
+	 * @param string $capability   user capability required to view this notice
+	 * @param string $cap_context  description for why the cap check is being performed
+	 * @param bool   $dismissed    whether or not the user has already dismissed/viewed this notice
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct(
+		$name,
+		$message,
+		$force_update = false,
+		$capability = 'manage_options',
+		$cap_context = 'view persistent admin notice',
+		$dismissed = false
+	) {
+		$this->setName($name);
+		$this->setMessage($message);
+		$this->setForceUpdate($force_update);
+		$this->setCapability($capability);
+		$this->setCapContext($cap_context);
+		$this->setDismissed($dismissed);
+		add_action(
+			'AHEE__EventEspresso_core_services_notifications_PersistentAdminNoticeManager__registerNotices',
+			array($this, 'registerPersistentAdminNotice')
+		);
+		add_action('shutdown', array($this, 'confirmRegistered'), 999);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getName()
+	{
+		return $this->name;
+	}
+
+
+	/**
+	 * @param string $name
+	 * @throws InvalidDataTypeException
+	 */
+	private function setName($name)
+	{
+		if (! is_string($name)) {
+			throw new InvalidDataTypeException('$name', $name, 'string');
+		}
+		$this->name = sanitize_key($name);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getMessage()
+	{
+		return $this->message;
+	}
+
+
+	/**
+	 * @param string $message
+	 * @throws InvalidDataTypeException
+	 */
+	private function setMessage($message)
+	{
+		if (! is_string($message)) {
+			throw new InvalidDataTypeException('$message', $message, 'string');
+		}
+		global $allowedtags;
+		$allowedtags['br'] = array();
+		$this->message = wp_kses($message, $allowedtags);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function getForceUpdate()
+	{
+		return $this->force_update;
+	}
+
+
+	/**
+	 * @param bool $force_update
+	 */
+	private function setForceUpdate($force_update)
+	{
+		$this->force_update = filter_var($force_update, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getCapability()
+	{
+		return $this->capability;
+	}
+
+
+	/**
+	 * @param string $capability
+	 * @throws InvalidDataTypeException
+	 */
+	private function setCapability($capability)
+	{
+		if (! is_string($capability)) {
+			throw new InvalidDataTypeException('$capability', $capability, 'string');
+		}
+		$this->capability = ! empty($capability) ? $capability : 'manage_options';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getCapContext()
+	{
+		return $this->cap_context;
+	}
+
+
+	/**
+	 * @param string $cap_context
+	 * @throws InvalidDataTypeException
+	 */
+	private function setCapContext($cap_context)
+	{
+		if (! is_string($cap_context)) {
+			throw new InvalidDataTypeException('$cap_context', $cap_context, 'string');
+		}
+		$this->cap_context = ! empty($cap_context) ? $cap_context : 'view persistent admin notice';
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function getDismissed()
+	{
+		return $this->dismissed;
+	}
+
+
+	/**
+	 * @param bool $dismissed
+	 */
+	public function setDismissed($dismissed)
+	{
+		$this->dismissed = filter_var($dismissed, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return CapCheckInterface
+	 * @throws InvalidDataTypeException
+	 */
+	public function getCapCheck()
+	{
+		if (! $this->cap_check instanceof CapCheckInterface) {
+			$this->setCapCheck(
+				new CapCheck(
+					$this->capability,
+					$this->cap_context
+				)
+			);
+		}
+		return $this->cap_check;
+	}
+
+
+	/**
+	 * @param CapCheckInterface $cap_check
+	 */
+	private function setCapCheck(CapCheckInterface $cap_check)
+	{
+		$this->cap_check = $cap_check;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function getPurge()
+	{
+		return $this->purge;
+	}
+
+
+	/**
+	 * @param bool $purge
+	 */
+	public function setPurge($purge)
+	{
+		$this->purge = filter_var($purge, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * given a valid PersistentAdminNotice Collection,
+	 * this notice will be added if it is not already found in the collection (using its name as the identifier)
+	 * if an existing notice is found that has already been dismissed,
+	 * but we are overriding with a forced update, then we will toggle its dismissed state,
+	 * so that the notice is displayed again
+	 *
+	 * @param Collection $persistent_admin_notice_collection
+	 * @throws InvalidEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	public function registerPersistentAdminNotice(Collection $persistent_admin_notice_collection)
+	{
+		if ($this->registered) {
+			return;
+		}
+		// first check if this notice has already been added to the collection
+		if ($persistent_admin_notice_collection->has($this->name)) {
+			/** @var PersistentAdminNotice $existing */
+			$existing = $persistent_admin_notice_collection->get($this->name);
+			// we don't need to add it again (we can't actually)
+			// but if it has already been dismissed, and we are overriding with a forced update
+			if ($existing->getDismissed() && $this->getForceUpdate()) {
+				// then toggle the notice's dismissed state to true
+				// so that it gets displayed again
+				$existing->setDismissed(false);
+				// and make sure the message is set
+				$existing->setMessage($this->message);
+			}
+		} else {
+			$persistent_admin_notice_collection->add($this, $this->name);
+		}
+		$this->registered = true;
+	}
+
+
+	/**
+	 * @throws Exception
+	 */
+	public function confirmRegistered()
+	{
+		if (! apply_filters('PersistentAdminNoticeManager__registerAndSaveNotices__complete', false)) {
+			PersistentAdminNoticeManager::loadRegisterAndSaveNotices();
+		}
+		if (! $this->registered && WP_DEBUG) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'The "%1$s" PersistentAdminNotice was not successfully registered. Please ensure that it is being created prior to either the "admin_notices" or "network_admin_notices" hooks being triggered.',
+						'event_espresso'
+					),
+					$this->name
+				)
+			);
+		}
+	}
 }

core/middleware/EE_Detect_File_Editor_Request.core.php

Indentation +23 added lines, -23 removed lines

@@ -14,28 +14,28 @@
 class EE_Detect_File_Editor_Request extends EE_Middleware
 {
 
-    /**
-     * @deprecated
-     * @param EE_Request  $request
-     * @param EE_Response $response
-     * @return EE_Response
-     */
-    public function handle_request(EE_Request $request, EE_Response $response)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
-                    'event_espresso'
-                ),
-                'EventEspresso\core\services\request\middleware\DetectFileEditorRequest',
-                '\core\services\request',
-                'EventEspresso\core\services\request'
-            ),
-            '4.9.52'
-        );
-        return $response;
-    }
+	/**
+	 * @deprecated
+	 * @param EE_Request  $request
+	 * @param EE_Response $response
+	 * @return EE_Response
+	 */
+	public function handle_request(EE_Request $request, EE_Response $response)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
+					'event_espresso'
+				),
+				'EventEspresso\core\services\request\middleware\DetectFileEditorRequest',
+				'\core\services\request',
+				'EventEspresso\core\services\request'
+			),
+			'4.9.52'
+		);
+		return $response;
+	}
 
 }

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

@@ -25,123 +25,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;
+	}
 }