eventespresso / event-espresso-core

core/domain/services/custom_post_types/RegisterCustomTaxonomyTerms.php

Indentation +176 added lines, -176 removed lines

@@ -16,180 +16,180 @@
 class RegisterCustomTaxonomyTerms
 {
 
-    /**
-     * @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
-        );
-    }
-
-
-    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
-        );
-    }
-
-
-    /**
-     * 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);
-    }
-
-
-    /**
-     * 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);
-            }
-        }
-    }
+	/**
+	 * @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
+		);
+	}
+
+
+	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
+		);
+	}
+
+
+	/**
+	 * 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);
+	}
+
+
+	/**
+	 * 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);
+			}
+		}
+	}
 }

core/domain/services/custom_post_types/RegisterCustomPostTypes.php

Indentation +221 added lines, -221 removed lines

@@ -18,240 +18,240 @@
 class RegisterCustomPostTypes
 {
 
-    /**
-     * @var CustomPostTypeDefinitions $custom_post_types
-     */
-    public $custom_post_types;
+	/**
+	 * @var CustomPostTypeDefinitions $custom_post_types
+	 */
+	public $custom_post_types;
 
-    /**
-     * @var WP_Post_Type[] $wp_post_types
-     */
-    public $wp_post_types = array();
+	/**
+	 * @var WP_Post_Type[] $wp_post_types
+	 */
+	public $wp_post_types = array();
 
 
-    /**
-     * RegisterCustomPostTypes constructor.
-     *
-     * @param CustomPostTypeDefinitions $custom_post_types
-     */
-    public function __construct(CustomPostTypeDefinitions $custom_post_types)
-    {
-        $this->custom_post_types = $custom_post_types;
-    }
+	/**
+	 * RegisterCustomPostTypes constructor.
+	 *
+	 * @param CustomPostTypeDefinitions $custom_post_types
+	 */
+	public function __construct(CustomPostTypeDefinitions $custom_post_types)
+	{
+		$this->custom_post_types = $custom_post_types;
+	}
 
 
-    /**
-     * @return WP_Post_Type[]
-     */
-    public function getRegisteredCustomPostTypes()
-    {
-        return $this->wp_post_types;
-    }
+	/**
+	 * @return WP_Post_Type[]
+	 */
+	public function getRegisteredCustomPostTypes()
+	{
+		return $this->wp_post_types;
+	}
 
 
-    /**
-     * @return void
-     * @throws DomainException
-     */
-    public function registerCustomPostTypes()
-    {
-        $custom_post_types = $this->custom_post_types->getDefinitions();
-        foreach ($custom_post_types as $custom_post_type => $CPT) {
-            $this->wp_post_types[ $custom_post_type ] = $this->registerCustomPostType(
-                $custom_post_type,
-                $CPT['singular_name'],
-                $CPT['plural_name'],
-                $CPT['singular_slug'],
-                $CPT['plural_slug'],
-                $CPT['args']
-            );
-        }
-    }
+	/**
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function registerCustomPostTypes()
+	{
+		$custom_post_types = $this->custom_post_types->getDefinitions();
+		foreach ($custom_post_types as $custom_post_type => $CPT) {
+			$this->wp_post_types[ $custom_post_type ] = $this->registerCustomPostType(
+				$custom_post_type,
+				$CPT['singular_name'],
+				$CPT['plural_name'],
+				$CPT['singular_slug'],
+				$CPT['plural_slug'],
+				$CPT['args']
+			);
+		}
+	}
 
 
-    /**
-     * Registers a new custom post type. Sets default settings given only the following params.
-     * Returns the registered post type object, or an error object.
-     *
-     * @param string $post_type          the actual post type name
-     *                                   IMPORTANT:
-     *                                   this must match what the slug is for admin pages related to this CPT
-     *                                   Also any models must use this slug as well
-     * @param string $singular_name      a pre-internationalized string for the singular name of the objects
-     * @param string $plural_name        a pre-internationalized string for the plural name of the objects
-     * @param string $singular_slug
-     * @param string $plural_slug
-     * @param array  $override_arguments exactly like $args as described in
-     *                                   http://codex.wordpress.org/Function_Reference/register_post_type
-     * @return WP_Post_Type|WP_Error
-     * @throws DomainException
-     */
-    public function registerCustomPostType(
-        $post_type,
-        $singular_name,
-        $plural_name,
-        $singular_slug = '',
-        $plural_slug = '',
-        array $override_arguments = array()
-    ) {
-        $wp_post_type = register_post_type(
-            $post_type,
-            $this->prepareArguments(
-                $post_type,
-                $singular_name,
-                $plural_name,
-                $singular_slug,
-                $plural_slug,
-                $override_arguments
-            )
-        );
-        if ($wp_post_type instanceof WP_Error) {
-            throw new DomainException($wp_post_type->get_error_message());
-        }
-        return $wp_post_type;
-    }
+	/**
+	 * Registers a new custom post type. Sets default settings given only the following params.
+	 * Returns the registered post type object, or an error object.
+	 *
+	 * @param string $post_type          the actual post type name
+	 *                                   IMPORTANT:
+	 *                                   this must match what the slug is for admin pages related to this CPT
+	 *                                   Also any models must use this slug as well
+	 * @param string $singular_name      a pre-internationalized string for the singular name of the objects
+	 * @param string $plural_name        a pre-internationalized string for the plural name of the objects
+	 * @param string $singular_slug
+	 * @param string $plural_slug
+	 * @param array  $override_arguments exactly like $args as described in
+	 *                                   http://codex.wordpress.org/Function_Reference/register_post_type
+	 * @return WP_Post_Type|WP_Error
+	 * @throws DomainException
+	 */
+	public function registerCustomPostType(
+		$post_type,
+		$singular_name,
+		$plural_name,
+		$singular_slug = '',
+		$plural_slug = '',
+		array $override_arguments = array()
+	) {
+		$wp_post_type = register_post_type(
+			$post_type,
+			$this->prepareArguments(
+				$post_type,
+				$singular_name,
+				$plural_name,
+				$singular_slug,
+				$plural_slug,
+				$override_arguments
+			)
+		);
+		if ($wp_post_type instanceof WP_Error) {
+			throw new DomainException($wp_post_type->get_error_message());
+		}
+		return $wp_post_type;
+	}
 
 
-    /**
-     * @param string $post_type          the actual post type name
-     * @param string $singular_name      a pre-internationalized string for the singular name of the objects
-     * @param string $plural_name        a pre-internationalized string for the plural name of the objects
-     * @param string $singular_slug
-     * @param string $plural_slug
-     * @param array  $override_arguments The default values set in this function will be overridden
-     *                                   by whatever you set in $override_arguments
-     * @return array
-     */
-    protected function prepareArguments(
-        $post_type,
-        $singular_name,
-        $plural_name,
-        $singular_slug,
-        $plural_slug,
-        array $override_arguments = array()
-    ) {
-        // verify plural slug and singular slug, if they aren't we'll use $singular_name and $plural_name
-        $singular_slug = ! empty($singular_slug) ? $singular_slug : $singular_name;
-        $plural_slug = ! empty($plural_slug) ? $plural_slug : $plural_name;
-        $labels = $this->getLabels(
-            $singular_name,
-            $plural_name,
-            $singular_slug,
-            $plural_slug
-        );
-        // note the page_templates arg in the supports index is something specific to EE.
-        // WordPress doesn't actually have that in their register_post_type api.
-        $arguments = $this->getDefaultArguments($labels, $post_type, $plural_slug);
-        if ($override_arguments) {
-            if (isset($override_arguments['labels'])) {
-                $labels = array_merge($arguments['labels'], $override_arguments['labels']);
-            }
-            $arguments = array_merge($arguments, $override_arguments);
-            $arguments['labels'] = $labels;
-        }
-        return $arguments;
-    }
+	/**
+	 * @param string $post_type          the actual post type name
+	 * @param string $singular_name      a pre-internationalized string for the singular name of the objects
+	 * @param string $plural_name        a pre-internationalized string for the plural name of the objects
+	 * @param string $singular_slug
+	 * @param string $plural_slug
+	 * @param array  $override_arguments The default values set in this function will be overridden
+	 *                                   by whatever you set in $override_arguments
+	 * @return array
+	 */
+	protected function prepareArguments(
+		$post_type,
+		$singular_name,
+		$plural_name,
+		$singular_slug,
+		$plural_slug,
+		array $override_arguments = array()
+	) {
+		// verify plural slug and singular slug, if they aren't we'll use $singular_name and $plural_name
+		$singular_slug = ! empty($singular_slug) ? $singular_slug : $singular_name;
+		$plural_slug = ! empty($plural_slug) ? $plural_slug : $plural_name;
+		$labels = $this->getLabels(
+			$singular_name,
+			$plural_name,
+			$singular_slug,
+			$plural_slug
+		);
+		// note the page_templates arg in the supports index is something specific to EE.
+		// WordPress doesn't actually have that in their register_post_type api.
+		$arguments = $this->getDefaultArguments($labels, $post_type, $plural_slug);
+		if ($override_arguments) {
+			if (isset($override_arguments['labels'])) {
+				$labels = array_merge($arguments['labels'], $override_arguments['labels']);
+			}
+			$arguments = array_merge($arguments, $override_arguments);
+			$arguments['labels'] = $labels;
+		}
+		return $arguments;
+	}
 
 
-    /**
-     * @param string $singular_name
-     * @param string $plural_name
-     * @param string $singular_slug
-     * @param string $plural_slug
-     * @return array
-     */
-    private function getLabels($singular_name, $plural_name, $singular_slug, $plural_slug)
-    {
-        return array(
-            'name'               => $plural_name,
-            'singular_name'      => $singular_name,
-            'singular_slug'      => $singular_slug,
-            'plural_slug'        => $plural_slug,
-            'add_new'            => sprintf(
-                esc_html_x('Add %s', 'Add Event', 'event_espresso'),
-                $singular_name
-            ),
-            'add_new_item'       => sprintf(
-                esc_html_x('Add New %s', 'Add New Event', 'event_espresso'),
-                $singular_name
-            ),
-            'edit_item'          => sprintf(
-                esc_html_x('Edit %s', 'Edit Event', 'event_espresso'),
-                $singular_name
-            ),
-            'new_item'           => sprintf(
-                esc_html_x('New %s', 'New Event', 'event_espresso'),
-                $singular_name
-            ),
-            'all_items'          => sprintf(
-                esc_html_x('All %s', 'All Events', 'event_espresso'),
-                $plural_name
-            ),
-            'view_item'          => sprintf(
-                esc_html_x('View %s', 'View Event', 'event_espresso'),
-                $singular_name
-            ),
-            'search_items'       => sprintf(
-                esc_html_x('Search %s', 'Search Events', 'event_espresso'),
-                $plural_name
-            ),
-            'not_found'          => sprintf(
-                esc_html_x('No %s found', 'No Events found', 'event_espresso'),
-                $plural_name
-            ),
-            'not_found_in_trash' => sprintf(
-                esc_html_x('No %s found in Trash', 'No Events found in Trash', 'event_espresso'),
-                $plural_name
-            ),
-            'parent_item_colon'  => '',
-            'menu_name'          => $plural_name,
-        );
-    }
+	/**
+	 * @param string $singular_name
+	 * @param string $plural_name
+	 * @param string $singular_slug
+	 * @param string $plural_slug
+	 * @return array
+	 */
+	private function getLabels($singular_name, $plural_name, $singular_slug, $plural_slug)
+	{
+		return array(
+			'name'               => $plural_name,
+			'singular_name'      => $singular_name,
+			'singular_slug'      => $singular_slug,
+			'plural_slug'        => $plural_slug,
+			'add_new'            => sprintf(
+				esc_html_x('Add %s', 'Add Event', 'event_espresso'),
+				$singular_name
+			),
+			'add_new_item'       => sprintf(
+				esc_html_x('Add New %s', 'Add New Event', 'event_espresso'),
+				$singular_name
+			),
+			'edit_item'          => sprintf(
+				esc_html_x('Edit %s', 'Edit Event', 'event_espresso'),
+				$singular_name
+			),
+			'new_item'           => sprintf(
+				esc_html_x('New %s', 'New Event', 'event_espresso'),
+				$singular_name
+			),
+			'all_items'          => sprintf(
+				esc_html_x('All %s', 'All Events', 'event_espresso'),
+				$plural_name
+			),
+			'view_item'          => sprintf(
+				esc_html_x('View %s', 'View Event', 'event_espresso'),
+				$singular_name
+			),
+			'search_items'       => sprintf(
+				esc_html_x('Search %s', 'Search Events', 'event_espresso'),
+				$plural_name
+			),
+			'not_found'          => sprintf(
+				esc_html_x('No %s found', 'No Events found', 'event_espresso'),
+				$plural_name
+			),
+			'not_found_in_trash' => sprintf(
+				esc_html_x('No %s found in Trash', 'No Events found in Trash', 'event_espresso'),
+				$plural_name
+			),
+			'parent_item_colon'  => '',
+			'menu_name'          => $plural_name,
+		);
+	}
 
 
-    /**
-     * @param array  $labels
-     * @param string $post_type
-     * @param string $plural_slug
-     * @return array
-     */
-    private function getDefaultArguments(array $labels, $post_type, $plural_slug)
-    {
-        return array(
-            'labels'             => $labels,
-            'public'             => true,
-            'publicly_queryable' => true,
-            'show_ui'            => false,
-            'show_ee_ui'         => true,
-            'show_in_menu'       => false,
-            'show_in_nav_menus'  => false,
-            'query_var'          => true,
-            'rewrite'            => apply_filters(
-                'FHEE__EventEspresso_core_domain_entities_custom_post_types_RegisterCustomPostTypes__getDefaultArguments__rewrite',
-                // legacy filter applied for now,
-                // later on we'll run a has_filter($tag) check and throw a doing_it_wrong() notice
-                apply_filters(
-                    'FHEE__EE_Register_CPTs__register_CPT__rewrite',
-                    array('slug' => $plural_slug),
-                    $post_type
-                ),
-                $post_type,
-                $plural_slug
-            ),
-            'capability_type'    => 'post',
-            'map_meta_cap'       => true,
-            'has_archive'        => true,
-            'hierarchical'       => false,
-            'menu_position'      => null,
-            'supports'           => array(
-                'title',
-                'editor',
-                'author',
-                'thumbnail',
-                'excerpt',
-                'custom-fields',
-                'comments',
-            ),
-        );
-    }
+	/**
+	 * @param array  $labels
+	 * @param string $post_type
+	 * @param string $plural_slug
+	 * @return array
+	 */
+	private function getDefaultArguments(array $labels, $post_type, $plural_slug)
+	{
+		return array(
+			'labels'             => $labels,
+			'public'             => true,
+			'publicly_queryable' => true,
+			'show_ui'            => false,
+			'show_ee_ui'         => true,
+			'show_in_menu'       => false,
+			'show_in_nav_menus'  => false,
+			'query_var'          => true,
+			'rewrite'            => apply_filters(
+				'FHEE__EventEspresso_core_domain_entities_custom_post_types_RegisterCustomPostTypes__getDefaultArguments__rewrite',
+				// legacy filter applied for now,
+				// later on we'll run a has_filter($tag) check and throw a doing_it_wrong() notice
+				apply_filters(
+					'FHEE__EE_Register_CPTs__register_CPT__rewrite',
+					array('slug' => $plural_slug),
+					$post_type
+				),
+				$post_type,
+				$plural_slug
+			),
+			'capability_type'    => 'post',
+			'map_meta_cap'       => true,
+			'has_archive'        => true,
+			'hierarchical'       => false,
+			'menu_position'      => null,
+			'supports'           => array(
+				'title',
+				'editor',
+				'author',
+				'thumbnail',
+				'excerpt',
+				'custom-fields',
+				'comments',
+			),
+		);
+	}
 }

core/domain/services/validation/email/strategies/Basic.php

Indentation +102 added lines, -102 removed lines

@@ -15,112 +15,112 @@
 class Basic implements EmailValidatorInterface
 {
 
-    /**
-     * @param string $email_address
-     * @return bool
-     * @throws EmailValidationException
-     */
-    public function validate($email_address)
-    {
-        if (! preg_match('/^.+\@\S+$/', $email_address)) {
-            // email not in correct {string}@{string} format
-            throw new EmailValidationException(
-                esc_html__('Email does not have the required @ sign.', 'event_espresso')
-            );
-        }
-        $atIndex = $this->getAtIndex($email_address);
-        $local = $this->getLocalPartOfEmail($email_address, $atIndex);
-        $localLen = strlen($local);
-        if ($localLen < 1) {
-            // no local part
-            throw new EmailValidationException(
-                esc_html__('Email local-part (before the @) is required.', 'event_espresso')
-            );
-        }
-        if ($localLen > 64) {
-            // local part length exceeded
-            throw new EmailValidationException(
-                esc_html__('Email local-part (before the @) is too long.', 'event_espresso')
-            );
-        }
-        if ($local[0] === '.') {
-            // local part starts with '.'
-            throw new EmailValidationException(
-                esc_html__('Email local-part (before the @) must not begin with a period.', 'event_espresso')
-            );
-        }
-        if ($local[ $localLen - 1 ] === '.') {
-            // local part starts or ends with '.'
-            throw new EmailValidationException(
-                esc_html__('Email local-part (before the @) must not end with a period.', 'event_espresso')
-            );
-        }
-        if (preg_match('/\\.\\./', $local)) {
-            // local part has two consecutive dots
-            throw new EmailValidationException(
-                esc_html__(
-                    'Email local-part (before the @) must not have two consecutive periods.',
-                    'event_espresso'
-                )
-            );
-        }
-        $domain = $this->getDomainPartOfEmail($email_address, $atIndex);
-        $domainLen = strlen($domain);
-        if ($domainLen < 1) {
-            throw new EmailValidationException(
-                esc_html__('Email domain (after the @) is required.', 'event_espresso')
-            );
-        }
-        if ($domainLen > 255) {
-            // domain part length exceeded
-            throw new EmailValidationException(
-                esc_html__('Email domain (after the @) is too long.', 'event_espresso')
-            );
-        }
-        if (preg_match('/\\.\\./', $domain)) {
-            // domain part has two consecutive dots
-            throw new EmailValidationException(
-                esc_html__('Email domain (after the @) must not have two consecutive periods.', 'event_espresso')
-            );
-        }
-        return true;
-    }
+	/**
+	 * @param string $email_address
+	 * @return bool
+	 * @throws EmailValidationException
+	 */
+	public function validate($email_address)
+	{
+		if (! preg_match('/^.+\@\S+$/', $email_address)) {
+			// email not in correct {string}@{string} format
+			throw new EmailValidationException(
+				esc_html__('Email does not have the required @ sign.', 'event_espresso')
+			);
+		}
+		$atIndex = $this->getAtIndex($email_address);
+		$local = $this->getLocalPartOfEmail($email_address, $atIndex);
+		$localLen = strlen($local);
+		if ($localLen < 1) {
+			// no local part
+			throw new EmailValidationException(
+				esc_html__('Email local-part (before the @) is required.', 'event_espresso')
+			);
+		}
+		if ($localLen > 64) {
+			// local part length exceeded
+			throw new EmailValidationException(
+				esc_html__('Email local-part (before the @) is too long.', 'event_espresso')
+			);
+		}
+		if ($local[0] === '.') {
+			// local part starts with '.'
+			throw new EmailValidationException(
+				esc_html__('Email local-part (before the @) must not begin with a period.', 'event_espresso')
+			);
+		}
+		if ($local[ $localLen - 1 ] === '.') {
+			// local part starts or ends with '.'
+			throw new EmailValidationException(
+				esc_html__('Email local-part (before the @) must not end with a period.', 'event_espresso')
+			);
+		}
+		if (preg_match('/\\.\\./', $local)) {
+			// local part has two consecutive dots
+			throw new EmailValidationException(
+				esc_html__(
+					'Email local-part (before the @) must not have two consecutive periods.',
+					'event_espresso'
+				)
+			);
+		}
+		$domain = $this->getDomainPartOfEmail($email_address, $atIndex);
+		$domainLen = strlen($domain);
+		if ($domainLen < 1) {
+			throw new EmailValidationException(
+				esc_html__('Email domain (after the @) is required.', 'event_espresso')
+			);
+		}
+		if ($domainLen > 255) {
+			// domain part length exceeded
+			throw new EmailValidationException(
+				esc_html__('Email domain (after the @) is too long.', 'event_espresso')
+			);
+		}
+		if (preg_match('/\\.\\./', $domain)) {
+			// domain part has two consecutive dots
+			throw new EmailValidationException(
+				esc_html__('Email domain (after the @) must not have two consecutive periods.', 'event_espresso')
+			);
+		}
+		return true;
+	}
 
 
-    /**
-     * returns the location of the @ symbol
-     *
-     * @param string $email_address
-     * @return bool|string
-     */
-    protected function getAtIndex($email_address)
-    {
-        return strrpos($email_address, '@');
-    }
+	/**
+	 * returns the location of the @ symbol
+	 *
+	 * @param string $email_address
+	 * @return bool|string
+	 */
+	protected function getAtIndex($email_address)
+	{
+		return strrpos($email_address, '@');
+	}
 
 
-    /**
-     * Gets the local part of the email
-     *
-     * @param string   $email_address
-     * @param bool|int $atIndex
-     * @return bool|string
-     */
-    protected function getLocalPartOfEmail($email_address, $atIndex)
-    {
-        return substr($email_address, 0, $atIndex);
-    }
+	/**
+	 * Gets the local part of the email
+	 *
+	 * @param string   $email_address
+	 * @param bool|int $atIndex
+	 * @return bool|string
+	 */
+	protected function getLocalPartOfEmail($email_address, $atIndex)
+	{
+		return substr($email_address, 0, $atIndex);
+	}
 
 
-    /**
-     * Gets the domain part of the email
-     *
-     * @param string   $email_address
-     * @param bool|int $atIndex
-     * @return bool|string
-     */
-    protected function getDomainPartOfEmail($email_address, $atIndex)
-    {
-        return substr($email_address, $atIndex + 1);
-    }
+	/**
+	 * Gets the domain part of the email
+	 *
+	 * @param string   $email_address
+	 * @param bool|int $atIndex
+	 * @return bool|string
+	 */
+	protected function getDomainPartOfEmail($email_address, $atIndex)
+	{
+		return substr($email_address, $atIndex + 1);
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -22,7 +22,7 @@ 
      */
     public function validate($email_address)
     {
-        if (! preg_match('/^.+\@\S+$/', $email_address)) {
+        if ( ! preg_match('/^.+\@\S+$/', $email_address)) {
             // email not in correct {string}@{string} format
             throw new EmailValidationException(
                 esc_html__('Email does not have the required @ sign.', 'event_espresso')
@@ -49,7 +49,7 @@ 
                 esc_html__('Email local-part (before the @) must not begin with a period.', 'event_espresso')
             );
         }
-        if ($local[ $localLen - 1 ] === '.') {
+        if ($local[$localLen - 1] === '.') {
             // local part starts or ends with '.'
             throw new EmailValidationException(
                 esc_html__('Email local-part (before the @) must not end with a period.', 'event_espresso')

core/domain/services/registration/CopyRegistrationService.php

Indentation +139 added lines, -139 removed lines

@@ -26,149 +26,149 @@
 {
 
 
-    /**
-     * @param EE_Registration $target_registration
-     * @param EE_Registration $registration_to_copy
-     * @return bool
-     * @throws UnexpectedEntityException
-     * @throws EntityNotFoundException
-     * @throws RuntimeException
-     * @throws EE_Error
-     */
-    public function copyRegistrationDetails(
-        EE_Registration $target_registration,
-        EE_Registration $registration_to_copy
-    ) {
-        // copy attendee
-        $target_registration->set_attendee_id($registration_to_copy->attendee_ID());
-        $target_registration->updateStatusBasedOnTotalPaid(false);
-        $target_registration->save();
-        // get answers to previous reg questions
-        $answers = $this->reindexAnswersByQuestionId($registration_to_copy->answers());
-        // get questions to new event reg form
-        $new_event = $target_registration->event();
-        $question_groups = $new_event->question_groups(
-            array(
-                array(
-                    'Event.EVT_ID'                     => $new_event->ID(),
-                    'Event_Question_Group.EQG_primary' => $registration_to_copy->is_primary_registrant(),
-                ),
-                'order_by' => array('QSG_order' => 'ASC'),
-            )
-        );
-        foreach ($question_groups as $question_group) {
-            if ($question_group instanceof \EE_Question_Group) {
-                foreach ($question_group->questions() as $question) {
-                    if ($question instanceof EE_Question) {
-                        $this->generateNewAnswer(
-                            $question,
-                            $target_registration,
-                            $answers
-                        );
-                    }
-                }
-            }
-        }
-        return true;
-    }
+	/**
+	 * @param EE_Registration $target_registration
+	 * @param EE_Registration $registration_to_copy
+	 * @return bool
+	 * @throws UnexpectedEntityException
+	 * @throws EntityNotFoundException
+	 * @throws RuntimeException
+	 * @throws EE_Error
+	 */
+	public function copyRegistrationDetails(
+		EE_Registration $target_registration,
+		EE_Registration $registration_to_copy
+	) {
+		// copy attendee
+		$target_registration->set_attendee_id($registration_to_copy->attendee_ID());
+		$target_registration->updateStatusBasedOnTotalPaid(false);
+		$target_registration->save();
+		// get answers to previous reg questions
+		$answers = $this->reindexAnswersByQuestionId($registration_to_copy->answers());
+		// get questions to new event reg form
+		$new_event = $target_registration->event();
+		$question_groups = $new_event->question_groups(
+			array(
+				array(
+					'Event.EVT_ID'                     => $new_event->ID(),
+					'Event_Question_Group.EQG_primary' => $registration_to_copy->is_primary_registrant(),
+				),
+				'order_by' => array('QSG_order' => 'ASC'),
+			)
+		);
+		foreach ($question_groups as $question_group) {
+			if ($question_group instanceof \EE_Question_Group) {
+				foreach ($question_group->questions() as $question) {
+					if ($question instanceof EE_Question) {
+						$this->generateNewAnswer(
+							$question,
+							$target_registration,
+							$answers
+						);
+					}
+				}
+			}
+		}
+		return true;
+	}
 
 
-    /**
-     * @param EE_Answer[] $answers
-     * @return array
-     * @throws EE_Error
-     */
-    protected function reindexAnswersByQuestionId(array $answers)
-    {
-        $reindexed_answers = array();
-        foreach ($answers as $answer) {
-            if ($answer instanceof EE_Answer) {
-                $reindexed_answers[ $answer->question_ID() ] = $answer->value();
-            }
-        }
-        return $reindexed_answers;
-    }
+	/**
+	 * @param EE_Answer[] $answers
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function reindexAnswersByQuestionId(array $answers)
+	{
+		$reindexed_answers = array();
+		foreach ($answers as $answer) {
+			if ($answer instanceof EE_Answer) {
+				$reindexed_answers[ $answer->question_ID() ] = $answer->value();
+			}
+		}
+		return $reindexed_answers;
+	}
 
 
-    /**
-     * @param EE_Question      $question
-     * @param EE_Registration  $registration
-     * @param                  $previous_answers
-     * @return EE_Answer
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function generateNewAnswer(
-        EE_Question $question,
-        EE_Registration $registration,
-        $previous_answers
-    ) {
-        $old_answer_value = isset($previous_answers[ $question->ID() ])
-            ? $previous_answers[ $question->ID() ]
-            : '';
-        $new_answer = EE_Answer::new_instance(
-            array(
-                'QST_ID'    => $question->ID(),
-                'REG_ID'    => $registration->ID(),
-                'ANS_value' => $old_answer_value,
-            )
-        );
-        if (! $new_answer instanceof EE_Answer) {
-            throw new UnexpectedEntityException($new_answer, 'EE_Answer');
-        }
-        $new_answer->save();
-        return $new_answer;
-    }
+	/**
+	 * @param EE_Question      $question
+	 * @param EE_Registration  $registration
+	 * @param                  $previous_answers
+	 * @return EE_Answer
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function generateNewAnswer(
+		EE_Question $question,
+		EE_Registration $registration,
+		$previous_answers
+	) {
+		$old_answer_value = isset($previous_answers[ $question->ID() ])
+			? $previous_answers[ $question->ID() ]
+			: '';
+		$new_answer = EE_Answer::new_instance(
+			array(
+				'QST_ID'    => $question->ID(),
+				'REG_ID'    => $registration->ID(),
+				'ANS_value' => $old_answer_value,
+			)
+		);
+		if (! $new_answer instanceof EE_Answer) {
+			throw new UnexpectedEntityException($new_answer, 'EE_Answer');
+		}
+		$new_answer->save();
+		return $new_answer;
+	}
 
 
-    /**
-     * @param EE_Registration $target_registration
-     * @param EE_Registration $registration_to_copy
-     * @return bool
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    public function copyPaymentDetails(
-        EE_Registration $target_registration,
-        EE_Registration $registration_to_copy
-    ) {
-        $save = false;
-        $previous_registration_payments = $registration_to_copy->registration_payments();
-        $new_registration_payment_total = 0;
-        $registration_to_copy_total = $registration_to_copy->paid();
-        foreach ($previous_registration_payments as $previous_registration_payment) {
-            if ($previous_registration_payment instanceof EE_Registration_Payment
-                && $previous_registration_payment->payment() instanceof EE_Payment
-                && $previous_registration_payment->payment()->is_approved()
-            ) {
-                $payment_amount = $previous_registration_payment->amount();
-                $new_registration_payment = EE_Registration_Payment::new_instance(
-                    array(
-                        'REG_ID'     => $target_registration->ID(),
-                        'PAY_ID'     => $previous_registration_payment->payment()->ID(),
-                        'RPY_amount' => $payment_amount,
-                    )
-                );
-                if (! $new_registration_payment instanceof EE_Registration_Payment) {
-                    throw new UnexpectedEntityException($new_registration_payment, 'EE_Registration_Payment');
-                }
-                $new_registration_payment->save();
-                // if new reg payment is good, then set old reg payment amount to zero
-                $previous_registration_payment->set_amount(0);
-                $previous_registration_payment->save();
-                // now  increment/decrement payment amounts
-                $new_registration_payment_total += $payment_amount;
-                $registration_to_copy_total -= $payment_amount;
-                $save = true;
-            }
-        }
-        if ($save) {
-            $target_registration->set_paid($new_registration_payment_total);
-            $target_registration->save();
-            $registration_to_copy->set_paid($registration_to_copy_total);
-            $registration_to_copy->save();
-        }
-        return true;
-    }
+	/**
+	 * @param EE_Registration $target_registration
+	 * @param EE_Registration $registration_to_copy
+	 * @return bool
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	public function copyPaymentDetails(
+		EE_Registration $target_registration,
+		EE_Registration $registration_to_copy
+	) {
+		$save = false;
+		$previous_registration_payments = $registration_to_copy->registration_payments();
+		$new_registration_payment_total = 0;
+		$registration_to_copy_total = $registration_to_copy->paid();
+		foreach ($previous_registration_payments as $previous_registration_payment) {
+			if ($previous_registration_payment instanceof EE_Registration_Payment
+				&& $previous_registration_payment->payment() instanceof EE_Payment
+				&& $previous_registration_payment->payment()->is_approved()
+			) {
+				$payment_amount = $previous_registration_payment->amount();
+				$new_registration_payment = EE_Registration_Payment::new_instance(
+					array(
+						'REG_ID'     => $target_registration->ID(),
+						'PAY_ID'     => $previous_registration_payment->payment()->ID(),
+						'RPY_amount' => $payment_amount,
+					)
+				);
+				if (! $new_registration_payment instanceof EE_Registration_Payment) {
+					throw new UnexpectedEntityException($new_registration_payment, 'EE_Registration_Payment');
+				}
+				$new_registration_payment->save();
+				// if new reg payment is good, then set old reg payment amount to zero
+				$previous_registration_payment->set_amount(0);
+				$previous_registration_payment->save();
+				// now  increment/decrement payment amounts
+				$new_registration_payment_total += $payment_amount;
+				$registration_to_copy_total -= $payment_amount;
+				$save = true;
+			}
+		}
+		if ($save) {
+			$target_registration->set_paid($new_registration_payment_total);
+			$target_registration->save();
+			$registration_to_copy->set_paid($registration_to_copy_total);
+			$registration_to_copy->save();
+		}
+		return true;
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -83,7 +83,7 @@ 
         $reindexed_answers = array();
         foreach ($answers as $answer) {
             if ($answer instanceof EE_Answer) {
-                $reindexed_answers[ $answer->question_ID() ] = $answer->value();
+                $reindexed_answers[$answer->question_ID()] = $answer->value();
             }
         }
         return $reindexed_answers;
@@ -103,8 +103,8 @@ 
         EE_Registration $registration,
         $previous_answers
     ) {
-        $old_answer_value = isset($previous_answers[ $question->ID() ])
-            ? $previous_answers[ $question->ID() ]
+        $old_answer_value = isset($previous_answers[$question->ID()])
+            ? $previous_answers[$question->ID()]
             : '';
         $new_answer = EE_Answer::new_instance(
             array(
@@ -113,7 +113,7 @@ 
                 'ANS_value' => $old_answer_value,
             )
         );
-        if (! $new_answer instanceof EE_Answer) {
+        if ( ! $new_answer instanceof EE_Answer) {
             throw new UnexpectedEntityException($new_answer, 'EE_Answer');
         }
         $new_answer->save();
@@ -150,7 +150,7 @@ 
                         'RPY_amount' => $payment_amount,
                     )
                 );
-                if (! $new_registration_payment instanceof EE_Registration_Payment) {
+                if ( ! $new_registration_payment instanceof EE_Registration_Payment) {
                     throw new UnexpectedEntityException($new_registration_payment, 'EE_Registration_Payment');
                 }
                 $new_registration_payment->save();

core/domain/services/event/EventSpacesCalculator.php

Indentation +698 added lines, -698 removed lines

@@ -26,702 +26,702 @@
 class EventSpacesCalculator
 {
 
-    /**
-     * @var EE_Event $event
-     */
-    private $event;
-
-    /**
-     * @var array $datetime_query_params
-     */
-    private $datetime_query_params;
-
-    /**
-     * @var EE_Ticket[] $active_tickets
-     */
-    private $active_tickets = array();
-
-    /**
-     * @var EE_Datetime[] $datetimes
-     */
-    private $datetimes = array();
-
-    /**
-     * Array of Ticket IDs grouped by Datetime
-     *
-     * @var array $datetimes
-     */
-    private $datetime_tickets = array();
-
-    /**
-     * Max spaces for each Datetime (reg limit - previous sold)
-     *
-     * @var array $datetime_spaces
-     */
-    private $datetime_spaces = array();
-
-    /**
-     * Array of Datetime IDs grouped by Ticket
-     *
-     * @var array[] $ticket_datetimes
-     */
-    private $ticket_datetimes = array();
-
-    /**
-     * maximum ticket quantities for each ticket (adjusted for reg limit)
-     *
-     * @var array $ticket_quantities
-     */
-    private $ticket_quantities = array();
-
-    /**
-     * total quantity of sold and reserved for each ticket
-     *
-     * @var array $tickets_sold
-     */
-    private $tickets_sold = array();
-
-    /**
-     * total spaces available across all datetimes
-     *
-     * @var array $total_spaces
-     */
-    private $total_spaces = array();
-
-    /**
-     * @var boolean $debug
-     */
-    private $debug = false; // true false
-
-    /**
-     * @var null|int $spaces_remaining
-     */
-    private $spaces_remaining;
-
-    /**
-     * @var null|int $total_spaces_available
-     */
-    private $total_spaces_available;
-
-
-    /**
-     * EventSpacesCalculator constructor.
-     *
-     * @param EE_Event $event
-     * @param array    $datetime_query_params
-     * @throws EE_Error
-     */
-    public function __construct(EE_Event $event, array $datetime_query_params = array())
-    {
-        $this->event = $event;
-        $this->datetime_query_params = $datetime_query_params + array('order_by' => array('DTT_reg_limit' => 'ASC'));
-        $this->setHooks();
-    }
-
-
-    /**
-     * @return void
-     */
-    private function setHooks()
-    {
-        add_action('AHEE__EE_Ticket__increase_sold', array($this, 'clearResults'));
-        add_action('AHEE__EE_Ticket__decrease_sold', array($this, 'clearResults'));
-        add_action('AHEE__EE_Datetime__increase_sold', array($this, 'clearResults'));
-        add_action('AHEE__EE_Datetime__decrease_sold', array($this, 'clearResults'));
-        add_action('AHEE__EE_Ticket__increase_reserved', array($this, 'clearResults'));
-        add_action('AHEE__EE_Ticket__decrease_reserved', array($this, 'clearResults'));
-        add_action('AHEE__EE_Datetime__increase_reserved', array($this, 'clearResults'));
-        add_action('AHEE__EE_Datetime__decrease_reserved', array($this, 'clearResults'));
-    }
-
-
-    /**
-     * @return void
-     */
-    public function clearResults()
-    {
-        $this->spaces_remaining = null;
-        $this->total_spaces_available = null;
-    }
-
-
-    /**
-     * @return EE_Ticket[]
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function getActiveTickets()
-    {
-        if (empty($this->active_tickets)) {
-            $this->active_tickets = $this->event->tickets(
-                array(
-                    array('TKT_deleted' => false),
-                    'order_by' => array('TKT_qty' => 'ASC'),
-                )
-            );
-        }
-        return $this->active_tickets;
-    }
-
-
-    /**
-     * @param EE_Ticket[] $active_tickets
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     */
-    public function setActiveTickets(array $active_tickets = array())
-    {
-        if (! empty($active_tickets)) {
-            foreach ($active_tickets as $active_ticket) {
-                $this->validateTicket($active_ticket);
-            }
-            // sort incoming array by ticket quantity (asc)
-            usort(
-                $active_tickets,
-                function (EE_Ticket $a, EE_Ticket $b) {
-                    if ($a->qty() === $b->qty()) {
-                        return 0;
-                    }
-                    return ($a->qty() < $b->qty())
-                        ? -1
-                        : 1;
-                }
-            );
-        }
-        $this->active_tickets = $active_tickets;
-    }
-
-
-    /**
-     * @param $ticket
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws UnexpectedEntityException
-     */
-    private function validateTicket($ticket)
-    {
-        if (! $ticket instanceof EE_Ticket) {
-            throw new DomainException(
-                esc_html__(
-                    'Invalid Ticket. Only EE_Ticket objects can be used to calculate event space availability.',
-                    'event_espresso'
-                )
-            );
-        }
-        if ($ticket->get_event_ID() !== $this->event->ID()) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'An EE_Ticket for Event %1$d was supplied while calculating event space availability for Event %2$d.',
-                        'event_espresso'
-                    ),
-                    $ticket->get_event_ID(),
-                    $this->event->ID()
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return EE_Datetime[]
-     */
-    public function getDatetimes()
-    {
-        return $this->datetimes;
-    }
-
-
-    /**
-     * @param EE_Datetime $datetime
-     * @throws EE_Error
-     * @throws DomainException
-     */
-    public function setDatetime(EE_Datetime $datetime)
-    {
-        if ($datetime->event()->ID() !== $this->event->ID()) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'An EE_Datetime for Event %1$d was supplied while calculating event space availability for Event %2$d.',
-                        'event_espresso'
-                    ),
-                    $datetime->event()->ID(),
-                    $this->event->ID()
-                )
-            );
-        }
-        $this->datetimes[ $datetime->ID() ] = $datetime;
-    }
-
-
-    /**
-     * calculate spaces remaining based on "saleable" tickets
-     *
-     * @return float|int
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function spacesRemaining()
-    {
-        if ($this->spaces_remaining === null) {
-            $this->initialize();
-            $this->spaces_remaining = $this->calculate();
-        }
-        return $this->spaces_remaining;
-    }
-
-
-    /**
-     * calculates total available spaces for an event with no regard for sold tickets
-     *
-     * @return int|float
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function totalSpacesAvailable()
-    {
-        if ($this->total_spaces_available === null) {
-            $this->initialize();
-            $this->total_spaces_available = $this->calculate(false);
-        }
-        return $this->total_spaces_available;
-    }
-
-
-    /**
-     * Loops through the active tickets for the event
-     * and builds a series of data arrays that will be used for calculating
-     * the total maximum available spaces, as well as the spaces remaining.
-     * Because ticket quantities affect datetime spaces and vice versa,
-     * we need to be constantly updating these data arrays as things change,
-     * which is the entire reason for their existence.
-     *
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws UnexpectedEntityException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    private function initialize()
-    {
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
-        }
-        $this->datetime_tickets = array();
-        $this->datetime_spaces = array();
-        $this->ticket_datetimes = array();
-        $this->ticket_quantities = array();
-        $this->tickets_sold = array();
-        $this->total_spaces = array();
-        $active_tickets = $this->getActiveTickets();
-        if (! empty($active_tickets)) {
-            foreach ($active_tickets as $ticket) {
-                $this->validateTicket($ticket);
-                // we need to index our data arrays using strings for the purpose of sorting,
-                // but we also need them to be unique, so  we'll just prepend a letter T to the ID
-                $ticket_identifier = "T{$ticket->ID()}";
-                // to start, we'll just consider the raw qty to be the maximum availability for this ticket,
-                // unless the ticket is past its "sell until" date, in which case the qty will be 0
-                $max_tickets = $ticket->is_expired() ? 0 : $ticket->qty();
-                // but we'll adjust that after looping over each datetime for the ticket and checking reg limits
-                $ticket_datetimes = $ticket->datetimes($this->datetime_query_params);
-                foreach ($ticket_datetimes as $datetime) {
-                    // save all datetimes
-                    $this->setDatetime($datetime);
-                    $datetime_identifier = "D{$datetime->ID()}";
-                    $reg_limit = $datetime->reg_limit();
-                    // ticket quantity can not exceed datetime reg limit
-                    $max_tickets = min($max_tickets, $reg_limit);
-                    // as described earlier, because we need to be able to constantly adjust numbers for things,
-                    // we are going to move all of our data into the following arrays:
-                    // datetime spaces initially represents the reg limit for each datetime,
-                    // but this will get adjusted as tickets are accounted for
-                    $this->datetime_spaces[ $datetime_identifier ] = $reg_limit;
-                    // just an array of ticket IDs grouped by datetime
-                    $this->datetime_tickets[ $datetime_identifier ][] = $ticket_identifier;
-                    // and an array of datetime IDs grouped by ticket
-                    $this->ticket_datetimes[ $ticket_identifier ][] = $datetime_identifier;
-                }
-                // total quantity of sold and reserved for each ticket
-                $this->tickets_sold[ $ticket_identifier ] = $ticket->sold() + $ticket->reserved();
-                // and the maximum ticket quantities for each ticket (adjusted for reg limit)
-                $this->ticket_quantities[ $ticket_identifier ] = $max_tickets;
-            }
-        }
-        // sort datetime spaces by reg limit, but maintain our string indexes
-        asort($this->datetime_spaces, SORT_NUMERIC);
-        // datetime tickets need to be sorted in the SAME order as the above array...
-        // so we'll just use array_merge() to take the structure of datetime_spaces
-        // but overwrite all of the data with that from datetime_tickets
-        $this->datetime_tickets = array_merge(
-            $this->datetime_spaces,
-            $this->datetime_tickets
-        );
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr($this->datetime_spaces, 'datetime_spaces', __FILE__, __LINE__);
-            \EEH_Debug_Tools::printr($this->datetime_tickets, 'datetime_tickets', __FILE__, __LINE__);
-            \EEH_Debug_Tools::printr($this->ticket_quantities, 'ticket_quantities', __FILE__, __LINE__);
-        }
-    }
-
-
-    /**
-     * performs calculations on initialized data
-     *
-     * @param bool $consider_sold
-     * @return int|float
-     */
-    private function calculate($consider_sold = true)
-    {
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
-            \EEH_Debug_Tools::printr($consider_sold, '$consider_sold', __FILE__, __LINE__);
-        }
-        if ($consider_sold) {
-            // subtract amounts sold from all ticket quantities and datetime spaces
-            $this->adjustTicketQuantitiesDueToSales();
-        }
-        foreach ($this->datetime_tickets as $datetime_identifier => $tickets) {
-            $this->trackAvailableSpacesForDatetimes($datetime_identifier, $tickets);
-        }
-        // total spaces available is just the sum of the spaces available for each datetime
-        $spaces_remaining = array_sum($this->total_spaces);
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr($this->total_spaces, '$this->total_spaces', __FILE__, __LINE__);
-            \EEH_Debug_Tools::printr($this->tickets_sold, '$this->tickets_sold', __FILE__, __LINE__);
-            \EEH_Debug_Tools::printr($spaces_remaining, '$spaces_remaining', __FILE__, __LINE__);
-        }
-        return $spaces_remaining;
-    }
-
-
-    /**
-     * subtracts amount of  tickets sold from ticket quantities and datetime spaces
-     */
-    private function adjustTicketQuantitiesDueToSales()
-    {
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
-        }
-        foreach ($this->tickets_sold as $ticket_identifier => $tickets_sold) {
-            if (isset($this->ticket_quantities[ $ticket_identifier ])) {
-                $this->ticket_quantities[ $ticket_identifier ] -= $tickets_sold;
-                // don't let values go below zero
-                $this->ticket_quantities[ $ticket_identifier ] = max(
-                    $this->ticket_quantities[ $ticket_identifier ],
-                    0
-                );
-                if ($this->debug) {
-                    \EEH_Debug_Tools::printr(
-                        "{$tickets_sold} sales for ticket {$ticket_identifier} ",
-                        'subtracting',
-                        __FILE__,
-                        __LINE__
-                    );
-                }
-            }
-            if (isset($this->ticket_datetimes[ $ticket_identifier ])
-                && is_array($this->ticket_datetimes[ $ticket_identifier ])
-            ) {
-                foreach ($this->ticket_datetimes[ $ticket_identifier ] as $ticket_datetime) {
-                    if (isset($this->ticket_quantities[ $ticket_identifier ])) {
-                        $this->datetime_spaces[ $ticket_datetime ] -= $tickets_sold;
-                        // don't let values go below zero
-                        $this->datetime_spaces[ $ticket_datetime ] = max(
-                            $this->datetime_spaces[ $ticket_datetime ],
-                            0
-                        );
-                        if ($this->debug) {
-                            \EEH_Debug_Tools::printr(
-                                "{$tickets_sold} sales for datetime {$ticket_datetime} ",
-                                'subtracting',
-                                __FILE__,
-                                __LINE__
-                            );
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @param string $datetime_identifier
-     * @param array  $tickets
-     */
-    private function trackAvailableSpacesForDatetimes($datetime_identifier, array $tickets)
-    {
-        // make sure a reg limit is set for the datetime
-        $reg_limit = isset($this->datetime_spaces[ $datetime_identifier ])
-            ? $this->datetime_spaces[ $datetime_identifier ]
-            : 0;
-        // and bail if it is not
-        if (! $reg_limit) {
-            if ($this->debug) {
-                \EEH_Debug_Tools::printr('AT CAPACITY', " . {$datetime_identifier}", __FILE__, __LINE__);
-            }
-            return;
-        }
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr($datetime_identifier, '* $datetime_identifier', __FILE__, __LINE__, 1);
-            \EEH_Debug_Tools::printr(
-                "{$reg_limit}",
-                'REG LIMIT',
-                __FILE__,
-                __LINE__
-            );
-        }
-        // number of allocated spaces always starts at zero
-        $spaces_allocated = 0;
-        $this->total_spaces[ $datetime_identifier ] = 0;
-        foreach ($tickets as $ticket_identifier) {
-            $spaces_allocated = $this->calculateAvailableSpacesForTicket(
-                $datetime_identifier,
-                $reg_limit,
-                $ticket_identifier,
-                $spaces_allocated
-            );
-        }
-        // spaces can't be negative
-        $spaces_allocated = max($spaces_allocated, 0);
-        if ($spaces_allocated) {
-            // track any non-zero values
-            $this->total_spaces[ $datetime_identifier ] += $spaces_allocated;
-            if ($this->debug) {
-                \EEH_Debug_Tools::printr((string) $spaces_allocated, ' . $spaces_allocated: ', __FILE__, __LINE__);
-            }
-        } else {
-            if ($this->debug) {
-                \EEH_Debug_Tools::printr(' ', ' . NO TICKETS AVAILABLE FOR DATETIME', __FILE__, __LINE__);
-            }
-        }
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr(
-                $this->total_spaces[ $datetime_identifier ],
-                '$total_spaces',
-                __FILE__,
-                __LINE__
-            );
-            \EEH_Debug_Tools::printr($this->ticket_quantities, '$ticket_quantities', __FILE__, __LINE__);
-            \EEH_Debug_Tools::printr($this->datetime_spaces, 'datetime_spaces', __FILE__, __LINE__);
-        }
-    }
-
-
-    /**
-     * @param string $datetime_identifier
-     * @param int    $reg_limit
-     * @param string $ticket_identifier
-     * @param int    $spaces_allocated
-     * @return int
-     */
-    private function calculateAvailableSpacesForTicket(
-        $datetime_identifier,
-        $reg_limit,
-        $ticket_identifier,
-        $spaces_allocated
-    ) {
-        // make sure ticket quantity is set
-        $ticket_quantity = isset($this->ticket_quantities[ $ticket_identifier ])
-            ? $this->ticket_quantities[ $ticket_identifier ]
-            : 0;
-        if ($this->debug) {
-            \EEH_Debug_Tools::printr("{$spaces_allocated}", '$spaces_allocated', __FILE__, __LINE__);
-            \EEH_Debug_Tools::printr(
-                "{$ticket_quantity}",
-                "ticket $ticket_identifier quantity: ",
-                __FILE__,
-                __LINE__,
-                2
-            );
-        }
-        if ($ticket_quantity) {
-            if ($this->debug) {
-                \EEH_Debug_Tools::printr(
-                    ($spaces_allocated <= $reg_limit)
-                        ? 'true'
-                        : 'false',
-                    ' . spaces_allocated <= reg_limit = ',
-                    __FILE__,
-                    __LINE__
-                );
-            }
-            // if the datetime is NOT at full capacity yet
-            if ($spaces_allocated <= $reg_limit) {
-                // then the maximum ticket quantity we can allocate is the lowest value of either:
-                //  the number of remaining spaces for the datetime, which is the limit - spaces already taken
-                //  or the maximum ticket quantity
-                $ticket_quantity = min($reg_limit - $spaces_allocated, $ticket_quantity);
-                // adjust the available quantity in our tracking array
-                $this->ticket_quantities[ $ticket_identifier ] -= $ticket_quantity;
-                // and increment spaces allocated for this datetime
-                $spaces_allocated += $ticket_quantity;
-                $at_capacity = $spaces_allocated >= $reg_limit;
-                if ($this->debug) {
-                    \EEH_Debug_Tools::printr(
-                        "{$ticket_quantity} {$ticket_identifier} tickets",
-                        ' > > allocate ',
-                        __FILE__,
-                        __LINE__,
-                        3
-                    );
-                    if ($at_capacity) {
-                        \EEH_Debug_Tools::printr('AT CAPACITY', " . {$datetime_identifier}", __FILE__, __LINE__, 3);
-                    }
-                }
-                // now adjust all other datetimes that allow access to this ticket
-                $this->adjustDatetimes(
-                    $datetime_identifier,
-                    $ticket_identifier,
-                    $ticket_quantity,
-                    $at_capacity
-                );
-            }
-        }
-        return $spaces_allocated;
-    }
-
-
-    /**
-     * subtracts ticket amounts from all datetime reg limits
-     * that allow access to the ticket specified,
-     * because that ticket could be used
-     * to attend any of the datetimes it has access to
-     *
-     * @param string $datetime_identifier
-     * @param string $ticket_identifier
-     * @param bool   $at_capacity
-     * @param int    $ticket_quantity
-     */
-    private function adjustDatetimes(
-        $datetime_identifier,
-        $ticket_identifier,
-        $ticket_quantity,
-        $at_capacity
-    ) {
-        /** @var array $datetime_tickets */
-        foreach ($this->datetime_tickets as $datetime_ID => $datetime_tickets) {
-            if ($datetime_ID !== $datetime_identifier || ! is_array($datetime_tickets)) {
-                continue;
-            }
-            $adjusted = $this->adjustDatetimeSpaces(
-                $datetime_ID,
-                $ticket_identifier,
-                $ticket_quantity
-            );
-            // skip to next ticket if nothing changed
-            if (! ($adjusted || $at_capacity)) {
-                continue;
-            }
-            // then all of it's tickets are now unavailable
-            foreach ($datetime_tickets as $datetime_ticket) {
-                if (($ticket_identifier === $datetime_ticket || $at_capacity)
-                    && isset($this->ticket_quantities[ $datetime_ticket ])
-                    && $this->ticket_quantities[ $datetime_ticket ] > 0
-                ) {
-                    if ($this->debug) {
-                        \EEH_Debug_Tools::printr(
-                            $datetime_ticket,
-                            ' . . . adjust ticket quantities for',
-                            __FILE__,
-                            __LINE__
-                        );
-                    }
-                    // if this datetime is at full capacity, set any tracked available quantities to zero
-                    // otherwise just subtract the ticket quantity
-                    $new_quantity = $at_capacity
-                        ? 0
-                        : $this->ticket_quantities[ $datetime_ticket ] - $ticket_quantity;
-                    // don't let ticket quantity go below zero
-                    $this->ticket_quantities[ $datetime_ticket ] = max($new_quantity, 0);
-                    if ($this->debug) {
-                        \EEH_Debug_Tools::printr(
-                            $at_capacity
-                                ? "0 because Datetime {$datetime_identifier} is at capacity"
-                                : "{$this->ticket_quantities[ $datetime_ticket ]}",
-                            " . . . . {$datetime_ticket} quantity set to ",
-                            __FILE__,
-                            __LINE__
-                        );
-                    }
-                }
-                // but we also need to adjust spaces for any other datetimes this ticket has access to
-                if ($datetime_ticket === $ticket_identifier) {
-                    if (isset($this->ticket_datetimes[ $datetime_ticket ])
-                        && is_array($this->ticket_datetimes[ $datetime_ticket ])
-                    ) {
-                        if ($this->debug) {
-                            \EEH_Debug_Tools::printr(
-                                $datetime_ticket,
-                                ' . . adjust other Datetimes for',
-                                __FILE__,
-                                __LINE__
-                            );
-                        }
-                        foreach ($this->ticket_datetimes[ $datetime_ticket ] as $datetime) {
-                            // don't adjust the current datetime twice
-                            if ($datetime !== $datetime_identifier) {
-                                $this->adjustDatetimeSpaces(
-                                    $datetime,
-                                    $datetime_ticket,
-                                    $ticket_quantity
-                                );
-                            }
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-    private function adjustDatetimeSpaces($datetime_identifier, $ticket_identifier, $ticket_quantity = 0)
-    {
-        // does datetime have spaces available?
-        // and does the supplied ticket have access to this datetime ?
-        if ($this->datetime_spaces[ $datetime_identifier ] > 0
-            && isset($this->datetime_spaces[ $datetime_identifier ], $this->datetime_tickets[ $datetime_identifier ])
-            && in_array($ticket_identifier, $this->datetime_tickets[ $datetime_identifier ], true)
-        ) {
-            if ($this->debug) {
-                \EEH_Debug_Tools::printr($datetime_identifier, ' . . adjust Datetime Spaces for', __FILE__, __LINE__);
-                \EEH_Debug_Tools::printr(
-                    "{$this->datetime_spaces[ $datetime_identifier ]}",
-                    " . . current  {$datetime_identifier} spaces available",
-                    __FILE__,
-                    __LINE__
-                );
-            }
-            // then decrement the available spaces for the datetime
-            $this->datetime_spaces[ $datetime_identifier ] -= $ticket_quantity;
-            // but don't let quantities go below zero
-            $this->datetime_spaces[ $datetime_identifier ] = max(
-                $this->datetime_spaces[ $datetime_identifier ],
-                0
-            );
-            if ($this->debug) {
-                \EEH_Debug_Tools::printr(
-                    "{$ticket_quantity}",
-                    " . . . {$datetime_identifier} capacity reduced by",
-                    __FILE__,
-                    __LINE__
-                );
-            }
-            return true;
-        }
-        return false;
-    }
+	/**
+	 * @var EE_Event $event
+	 */
+	private $event;
+
+	/**
+	 * @var array $datetime_query_params
+	 */
+	private $datetime_query_params;
+
+	/**
+	 * @var EE_Ticket[] $active_tickets
+	 */
+	private $active_tickets = array();
+
+	/**
+	 * @var EE_Datetime[] $datetimes
+	 */
+	private $datetimes = array();
+
+	/**
+	 * Array of Ticket IDs grouped by Datetime
+	 *
+	 * @var array $datetimes
+	 */
+	private $datetime_tickets = array();
+
+	/**
+	 * Max spaces for each Datetime (reg limit - previous sold)
+	 *
+	 * @var array $datetime_spaces
+	 */
+	private $datetime_spaces = array();
+
+	/**
+	 * Array of Datetime IDs grouped by Ticket
+	 *
+	 * @var array[] $ticket_datetimes
+	 */
+	private $ticket_datetimes = array();
+
+	/**
+	 * maximum ticket quantities for each ticket (adjusted for reg limit)
+	 *
+	 * @var array $ticket_quantities
+	 */
+	private $ticket_quantities = array();
+
+	/**
+	 * total quantity of sold and reserved for each ticket
+	 *
+	 * @var array $tickets_sold
+	 */
+	private $tickets_sold = array();
+
+	/**
+	 * total spaces available across all datetimes
+	 *
+	 * @var array $total_spaces
+	 */
+	private $total_spaces = array();
+
+	/**
+	 * @var boolean $debug
+	 */
+	private $debug = false; // true false
+
+	/**
+	 * @var null|int $spaces_remaining
+	 */
+	private $spaces_remaining;
+
+	/**
+	 * @var null|int $total_spaces_available
+	 */
+	private $total_spaces_available;
+
+
+	/**
+	 * EventSpacesCalculator constructor.
+	 *
+	 * @param EE_Event $event
+	 * @param array    $datetime_query_params
+	 * @throws EE_Error
+	 */
+	public function __construct(EE_Event $event, array $datetime_query_params = array())
+	{
+		$this->event = $event;
+		$this->datetime_query_params = $datetime_query_params + array('order_by' => array('DTT_reg_limit' => 'ASC'));
+		$this->setHooks();
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function setHooks()
+	{
+		add_action('AHEE__EE_Ticket__increase_sold', array($this, 'clearResults'));
+		add_action('AHEE__EE_Ticket__decrease_sold', array($this, 'clearResults'));
+		add_action('AHEE__EE_Datetime__increase_sold', array($this, 'clearResults'));
+		add_action('AHEE__EE_Datetime__decrease_sold', array($this, 'clearResults'));
+		add_action('AHEE__EE_Ticket__increase_reserved', array($this, 'clearResults'));
+		add_action('AHEE__EE_Ticket__decrease_reserved', array($this, 'clearResults'));
+		add_action('AHEE__EE_Datetime__increase_reserved', array($this, 'clearResults'));
+		add_action('AHEE__EE_Datetime__decrease_reserved', array($this, 'clearResults'));
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function clearResults()
+	{
+		$this->spaces_remaining = null;
+		$this->total_spaces_available = null;
+	}
+
+
+	/**
+	 * @return EE_Ticket[]
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function getActiveTickets()
+	{
+		if (empty($this->active_tickets)) {
+			$this->active_tickets = $this->event->tickets(
+				array(
+					array('TKT_deleted' => false),
+					'order_by' => array('TKT_qty' => 'ASC'),
+				)
+			);
+		}
+		return $this->active_tickets;
+	}
+
+
+	/**
+	 * @param EE_Ticket[] $active_tickets
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 */
+	public function setActiveTickets(array $active_tickets = array())
+	{
+		if (! empty($active_tickets)) {
+			foreach ($active_tickets as $active_ticket) {
+				$this->validateTicket($active_ticket);
+			}
+			// sort incoming array by ticket quantity (asc)
+			usort(
+				$active_tickets,
+				function (EE_Ticket $a, EE_Ticket $b) {
+					if ($a->qty() === $b->qty()) {
+						return 0;
+					}
+					return ($a->qty() < $b->qty())
+						? -1
+						: 1;
+				}
+			);
+		}
+		$this->active_tickets = $active_tickets;
+	}
+
+
+	/**
+	 * @param $ticket
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws UnexpectedEntityException
+	 */
+	private function validateTicket($ticket)
+	{
+		if (! $ticket instanceof EE_Ticket) {
+			throw new DomainException(
+				esc_html__(
+					'Invalid Ticket. Only EE_Ticket objects can be used to calculate event space availability.',
+					'event_espresso'
+				)
+			);
+		}
+		if ($ticket->get_event_ID() !== $this->event->ID()) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'An EE_Ticket for Event %1$d was supplied while calculating event space availability for Event %2$d.',
+						'event_espresso'
+					),
+					$ticket->get_event_ID(),
+					$this->event->ID()
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return EE_Datetime[]
+	 */
+	public function getDatetimes()
+	{
+		return $this->datetimes;
+	}
+
+
+	/**
+	 * @param EE_Datetime $datetime
+	 * @throws EE_Error
+	 * @throws DomainException
+	 */
+	public function setDatetime(EE_Datetime $datetime)
+	{
+		if ($datetime->event()->ID() !== $this->event->ID()) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'An EE_Datetime for Event %1$d was supplied while calculating event space availability for Event %2$d.',
+						'event_espresso'
+					),
+					$datetime->event()->ID(),
+					$this->event->ID()
+				)
+			);
+		}
+		$this->datetimes[ $datetime->ID() ] = $datetime;
+	}
+
+
+	/**
+	 * calculate spaces remaining based on "saleable" tickets
+	 *
+	 * @return float|int
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function spacesRemaining()
+	{
+		if ($this->spaces_remaining === null) {
+			$this->initialize();
+			$this->spaces_remaining = $this->calculate();
+		}
+		return $this->spaces_remaining;
+	}
+
+
+	/**
+	 * calculates total available spaces for an event with no regard for sold tickets
+	 *
+	 * @return int|float
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function totalSpacesAvailable()
+	{
+		if ($this->total_spaces_available === null) {
+			$this->initialize();
+			$this->total_spaces_available = $this->calculate(false);
+		}
+		return $this->total_spaces_available;
+	}
+
+
+	/**
+	 * Loops through the active tickets for the event
+	 * and builds a series of data arrays that will be used for calculating
+	 * the total maximum available spaces, as well as the spaces remaining.
+	 * Because ticket quantities affect datetime spaces and vice versa,
+	 * we need to be constantly updating these data arrays as things change,
+	 * which is the entire reason for their existence.
+	 *
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws UnexpectedEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	private function initialize()
+	{
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
+		}
+		$this->datetime_tickets = array();
+		$this->datetime_spaces = array();
+		$this->ticket_datetimes = array();
+		$this->ticket_quantities = array();
+		$this->tickets_sold = array();
+		$this->total_spaces = array();
+		$active_tickets = $this->getActiveTickets();
+		if (! empty($active_tickets)) {
+			foreach ($active_tickets as $ticket) {
+				$this->validateTicket($ticket);
+				// we need to index our data arrays using strings for the purpose of sorting,
+				// but we also need them to be unique, so  we'll just prepend a letter T to the ID
+				$ticket_identifier = "T{$ticket->ID()}";
+				// to start, we'll just consider the raw qty to be the maximum availability for this ticket,
+				// unless the ticket is past its "sell until" date, in which case the qty will be 0
+				$max_tickets = $ticket->is_expired() ? 0 : $ticket->qty();
+				// but we'll adjust that after looping over each datetime for the ticket and checking reg limits
+				$ticket_datetimes = $ticket->datetimes($this->datetime_query_params);
+				foreach ($ticket_datetimes as $datetime) {
+					// save all datetimes
+					$this->setDatetime($datetime);
+					$datetime_identifier = "D{$datetime->ID()}";
+					$reg_limit = $datetime->reg_limit();
+					// ticket quantity can not exceed datetime reg limit
+					$max_tickets = min($max_tickets, $reg_limit);
+					// as described earlier, because we need to be able to constantly adjust numbers for things,
+					// we are going to move all of our data into the following arrays:
+					// datetime spaces initially represents the reg limit for each datetime,
+					// but this will get adjusted as tickets are accounted for
+					$this->datetime_spaces[ $datetime_identifier ] = $reg_limit;
+					// just an array of ticket IDs grouped by datetime
+					$this->datetime_tickets[ $datetime_identifier ][] = $ticket_identifier;
+					// and an array of datetime IDs grouped by ticket
+					$this->ticket_datetimes[ $ticket_identifier ][] = $datetime_identifier;
+				}
+				// total quantity of sold and reserved for each ticket
+				$this->tickets_sold[ $ticket_identifier ] = $ticket->sold() + $ticket->reserved();
+				// and the maximum ticket quantities for each ticket (adjusted for reg limit)
+				$this->ticket_quantities[ $ticket_identifier ] = $max_tickets;
+			}
+		}
+		// sort datetime spaces by reg limit, but maintain our string indexes
+		asort($this->datetime_spaces, SORT_NUMERIC);
+		// datetime tickets need to be sorted in the SAME order as the above array...
+		// so we'll just use array_merge() to take the structure of datetime_spaces
+		// but overwrite all of the data with that from datetime_tickets
+		$this->datetime_tickets = array_merge(
+			$this->datetime_spaces,
+			$this->datetime_tickets
+		);
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr($this->datetime_spaces, 'datetime_spaces', __FILE__, __LINE__);
+			\EEH_Debug_Tools::printr($this->datetime_tickets, 'datetime_tickets', __FILE__, __LINE__);
+			\EEH_Debug_Tools::printr($this->ticket_quantities, 'ticket_quantities', __FILE__, __LINE__);
+		}
+	}
+
+
+	/**
+	 * performs calculations on initialized data
+	 *
+	 * @param bool $consider_sold
+	 * @return int|float
+	 */
+	private function calculate($consider_sold = true)
+	{
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
+			\EEH_Debug_Tools::printr($consider_sold, '$consider_sold', __FILE__, __LINE__);
+		}
+		if ($consider_sold) {
+			// subtract amounts sold from all ticket quantities and datetime spaces
+			$this->adjustTicketQuantitiesDueToSales();
+		}
+		foreach ($this->datetime_tickets as $datetime_identifier => $tickets) {
+			$this->trackAvailableSpacesForDatetimes($datetime_identifier, $tickets);
+		}
+		// total spaces available is just the sum of the spaces available for each datetime
+		$spaces_remaining = array_sum($this->total_spaces);
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr($this->total_spaces, '$this->total_spaces', __FILE__, __LINE__);
+			\EEH_Debug_Tools::printr($this->tickets_sold, '$this->tickets_sold', __FILE__, __LINE__);
+			\EEH_Debug_Tools::printr($spaces_remaining, '$spaces_remaining', __FILE__, __LINE__);
+		}
+		return $spaces_remaining;
+	}
+
+
+	/**
+	 * subtracts amount of  tickets sold from ticket quantities and datetime spaces
+	 */
+	private function adjustTicketQuantitiesDueToSales()
+	{
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
+		}
+		foreach ($this->tickets_sold as $ticket_identifier => $tickets_sold) {
+			if (isset($this->ticket_quantities[ $ticket_identifier ])) {
+				$this->ticket_quantities[ $ticket_identifier ] -= $tickets_sold;
+				// don't let values go below zero
+				$this->ticket_quantities[ $ticket_identifier ] = max(
+					$this->ticket_quantities[ $ticket_identifier ],
+					0
+				);
+				if ($this->debug) {
+					\EEH_Debug_Tools::printr(
+						"{$tickets_sold} sales for ticket {$ticket_identifier} ",
+						'subtracting',
+						__FILE__,
+						__LINE__
+					);
+				}
+			}
+			if (isset($this->ticket_datetimes[ $ticket_identifier ])
+				&& is_array($this->ticket_datetimes[ $ticket_identifier ])
+			) {
+				foreach ($this->ticket_datetimes[ $ticket_identifier ] as $ticket_datetime) {
+					if (isset($this->ticket_quantities[ $ticket_identifier ])) {
+						$this->datetime_spaces[ $ticket_datetime ] -= $tickets_sold;
+						// don't let values go below zero
+						$this->datetime_spaces[ $ticket_datetime ] = max(
+							$this->datetime_spaces[ $ticket_datetime ],
+							0
+						);
+						if ($this->debug) {
+							\EEH_Debug_Tools::printr(
+								"{$tickets_sold} sales for datetime {$ticket_datetime} ",
+								'subtracting',
+								__FILE__,
+								__LINE__
+							);
+						}
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @param string $datetime_identifier
+	 * @param array  $tickets
+	 */
+	private function trackAvailableSpacesForDatetimes($datetime_identifier, array $tickets)
+	{
+		// make sure a reg limit is set for the datetime
+		$reg_limit = isset($this->datetime_spaces[ $datetime_identifier ])
+			? $this->datetime_spaces[ $datetime_identifier ]
+			: 0;
+		// and bail if it is not
+		if (! $reg_limit) {
+			if ($this->debug) {
+				\EEH_Debug_Tools::printr('AT CAPACITY', " . {$datetime_identifier}", __FILE__, __LINE__);
+			}
+			return;
+		}
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr($datetime_identifier, '* $datetime_identifier', __FILE__, __LINE__, 1);
+			\EEH_Debug_Tools::printr(
+				"{$reg_limit}",
+				'REG LIMIT',
+				__FILE__,
+				__LINE__
+			);
+		}
+		// number of allocated spaces always starts at zero
+		$spaces_allocated = 0;
+		$this->total_spaces[ $datetime_identifier ] = 0;
+		foreach ($tickets as $ticket_identifier) {
+			$spaces_allocated = $this->calculateAvailableSpacesForTicket(
+				$datetime_identifier,
+				$reg_limit,
+				$ticket_identifier,
+				$spaces_allocated
+			);
+		}
+		// spaces can't be negative
+		$spaces_allocated = max($spaces_allocated, 0);
+		if ($spaces_allocated) {
+			// track any non-zero values
+			$this->total_spaces[ $datetime_identifier ] += $spaces_allocated;
+			if ($this->debug) {
+				\EEH_Debug_Tools::printr((string) $spaces_allocated, ' . $spaces_allocated: ', __FILE__, __LINE__);
+			}
+		} else {
+			if ($this->debug) {
+				\EEH_Debug_Tools::printr(' ', ' . NO TICKETS AVAILABLE FOR DATETIME', __FILE__, __LINE__);
+			}
+		}
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr(
+				$this->total_spaces[ $datetime_identifier ],
+				'$total_spaces',
+				__FILE__,
+				__LINE__
+			);
+			\EEH_Debug_Tools::printr($this->ticket_quantities, '$ticket_quantities', __FILE__, __LINE__);
+			\EEH_Debug_Tools::printr($this->datetime_spaces, 'datetime_spaces', __FILE__, __LINE__);
+		}
+	}
+
+
+	/**
+	 * @param string $datetime_identifier
+	 * @param int    $reg_limit
+	 * @param string $ticket_identifier
+	 * @param int    $spaces_allocated
+	 * @return int
+	 */
+	private function calculateAvailableSpacesForTicket(
+		$datetime_identifier,
+		$reg_limit,
+		$ticket_identifier,
+		$spaces_allocated
+	) {
+		// make sure ticket quantity is set
+		$ticket_quantity = isset($this->ticket_quantities[ $ticket_identifier ])
+			? $this->ticket_quantities[ $ticket_identifier ]
+			: 0;
+		if ($this->debug) {
+			\EEH_Debug_Tools::printr("{$spaces_allocated}", '$spaces_allocated', __FILE__, __LINE__);
+			\EEH_Debug_Tools::printr(
+				"{$ticket_quantity}",
+				"ticket $ticket_identifier quantity: ",
+				__FILE__,
+				__LINE__,
+				2
+			);
+		}
+		if ($ticket_quantity) {
+			if ($this->debug) {
+				\EEH_Debug_Tools::printr(
+					($spaces_allocated <= $reg_limit)
+						? 'true'
+						: 'false',
+					' . spaces_allocated <= reg_limit = ',
+					__FILE__,
+					__LINE__
+				);
+			}
+			// if the datetime is NOT at full capacity yet
+			if ($spaces_allocated <= $reg_limit) {
+				// then the maximum ticket quantity we can allocate is the lowest value of either:
+				//  the number of remaining spaces for the datetime, which is the limit - spaces already taken
+				//  or the maximum ticket quantity
+				$ticket_quantity = min($reg_limit - $spaces_allocated, $ticket_quantity);
+				// adjust the available quantity in our tracking array
+				$this->ticket_quantities[ $ticket_identifier ] -= $ticket_quantity;
+				// and increment spaces allocated for this datetime
+				$spaces_allocated += $ticket_quantity;
+				$at_capacity = $spaces_allocated >= $reg_limit;
+				if ($this->debug) {
+					\EEH_Debug_Tools::printr(
+						"{$ticket_quantity} {$ticket_identifier} tickets",
+						' > > allocate ',
+						__FILE__,
+						__LINE__,
+						3
+					);
+					if ($at_capacity) {
+						\EEH_Debug_Tools::printr('AT CAPACITY', " . {$datetime_identifier}", __FILE__, __LINE__, 3);
+					}
+				}
+				// now adjust all other datetimes that allow access to this ticket
+				$this->adjustDatetimes(
+					$datetime_identifier,
+					$ticket_identifier,
+					$ticket_quantity,
+					$at_capacity
+				);
+			}
+		}
+		return $spaces_allocated;
+	}
+
+
+	/**
+	 * subtracts ticket amounts from all datetime reg limits
+	 * that allow access to the ticket specified,
+	 * because that ticket could be used
+	 * to attend any of the datetimes it has access to
+	 *
+	 * @param string $datetime_identifier
+	 * @param string $ticket_identifier
+	 * @param bool   $at_capacity
+	 * @param int    $ticket_quantity
+	 */
+	private function adjustDatetimes(
+		$datetime_identifier,
+		$ticket_identifier,
+		$ticket_quantity,
+		$at_capacity
+	) {
+		/** @var array $datetime_tickets */
+		foreach ($this->datetime_tickets as $datetime_ID => $datetime_tickets) {
+			if ($datetime_ID !== $datetime_identifier || ! is_array($datetime_tickets)) {
+				continue;
+			}
+			$adjusted = $this->adjustDatetimeSpaces(
+				$datetime_ID,
+				$ticket_identifier,
+				$ticket_quantity
+			);
+			// skip to next ticket if nothing changed
+			if (! ($adjusted || $at_capacity)) {
+				continue;
+			}
+			// then all of it's tickets are now unavailable
+			foreach ($datetime_tickets as $datetime_ticket) {
+				if (($ticket_identifier === $datetime_ticket || $at_capacity)
+					&& isset($this->ticket_quantities[ $datetime_ticket ])
+					&& $this->ticket_quantities[ $datetime_ticket ] > 0
+				) {
+					if ($this->debug) {
+						\EEH_Debug_Tools::printr(
+							$datetime_ticket,
+							' . . . adjust ticket quantities for',
+							__FILE__,
+							__LINE__
+						);
+					}
+					// if this datetime is at full capacity, set any tracked available quantities to zero
+					// otherwise just subtract the ticket quantity
+					$new_quantity = $at_capacity
+						? 0
+						: $this->ticket_quantities[ $datetime_ticket ] - $ticket_quantity;
+					// don't let ticket quantity go below zero
+					$this->ticket_quantities[ $datetime_ticket ] = max($new_quantity, 0);
+					if ($this->debug) {
+						\EEH_Debug_Tools::printr(
+							$at_capacity
+								? "0 because Datetime {$datetime_identifier} is at capacity"
+								: "{$this->ticket_quantities[ $datetime_ticket ]}",
+							" . . . . {$datetime_ticket} quantity set to ",
+							__FILE__,
+							__LINE__
+						);
+					}
+				}
+				// but we also need to adjust spaces for any other datetimes this ticket has access to
+				if ($datetime_ticket === $ticket_identifier) {
+					if (isset($this->ticket_datetimes[ $datetime_ticket ])
+						&& is_array($this->ticket_datetimes[ $datetime_ticket ])
+					) {
+						if ($this->debug) {
+							\EEH_Debug_Tools::printr(
+								$datetime_ticket,
+								' . . adjust other Datetimes for',
+								__FILE__,
+								__LINE__
+							);
+						}
+						foreach ($this->ticket_datetimes[ $datetime_ticket ] as $datetime) {
+							// don't adjust the current datetime twice
+							if ($datetime !== $datetime_identifier) {
+								$this->adjustDatetimeSpaces(
+									$datetime,
+									$datetime_ticket,
+									$ticket_quantity
+								);
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+
+	private function adjustDatetimeSpaces($datetime_identifier, $ticket_identifier, $ticket_quantity = 0)
+	{
+		// does datetime have spaces available?
+		// and does the supplied ticket have access to this datetime ?
+		if ($this->datetime_spaces[ $datetime_identifier ] > 0
+			&& isset($this->datetime_spaces[ $datetime_identifier ], $this->datetime_tickets[ $datetime_identifier ])
+			&& in_array($ticket_identifier, $this->datetime_tickets[ $datetime_identifier ], true)
+		) {
+			if ($this->debug) {
+				\EEH_Debug_Tools::printr($datetime_identifier, ' . . adjust Datetime Spaces for', __FILE__, __LINE__);
+				\EEH_Debug_Tools::printr(
+					"{$this->datetime_spaces[ $datetime_identifier ]}",
+					" . . current  {$datetime_identifier} spaces available",
+					__FILE__,
+					__LINE__
+				);
+			}
+			// then decrement the available spaces for the datetime
+			$this->datetime_spaces[ $datetime_identifier ] -= $ticket_quantity;
+			// but don't let quantities go below zero
+			$this->datetime_spaces[ $datetime_identifier ] = max(
+				$this->datetime_spaces[ $datetime_identifier ],
+				0
+			);
+			if ($this->debug) {
+				\EEH_Debug_Tools::printr(
+					"{$ticket_quantity}",
+					" . . . {$datetime_identifier} capacity reduced by",
+					__FILE__,
+					__LINE__
+				);
+			}
+			return true;
+		}
+		return false;
+	}
 }

Spacing +46 added lines, -46 removed lines

@@ -174,14 +174,14 @@ 
      */
     public function setActiveTickets(array $active_tickets = array())
     {
-        if (! empty($active_tickets)) {
+        if ( ! empty($active_tickets)) {
             foreach ($active_tickets as $active_ticket) {
                 $this->validateTicket($active_ticket);
             }
             // sort incoming array by ticket quantity (asc)
             usort(
                 $active_tickets,
-                function (EE_Ticket $a, EE_Ticket $b) {
+                function(EE_Ticket $a, EE_Ticket $b) {
                     if ($a->qty() === $b->qty()) {
                         return 0;
                     }
@@ -203,7 +203,7 @@ 
      */
     private function validateTicket($ticket)
     {
-        if (! $ticket instanceof EE_Ticket) {
+        if ( ! $ticket instanceof EE_Ticket) {
             throw new DomainException(
                 esc_html__(
                     'Invalid Ticket. Only EE_Ticket objects can be used to calculate event space availability.',
@@ -254,7 +254,7 @@ 
                 )
             );
         }
-        $this->datetimes[ $datetime->ID() ] = $datetime;
+        $this->datetimes[$datetime->ID()] = $datetime;
     }
 
 
@@ -327,7 +327,7 @@ 
         $this->tickets_sold = array();
         $this->total_spaces = array();
         $active_tickets = $this->getActiveTickets();
-        if (! empty($active_tickets)) {
+        if ( ! empty($active_tickets)) {
             foreach ($active_tickets as $ticket) {
                 $this->validateTicket($ticket);
                 // we need to index our data arrays using strings for the purpose of sorting,
@@ -349,16 +349,16 @@ 
                     // we are going to move all of our data into the following arrays:
                     // datetime spaces initially represents the reg limit for each datetime,
                     // but this will get adjusted as tickets are accounted for
-                    $this->datetime_spaces[ $datetime_identifier ] = $reg_limit;
+                    $this->datetime_spaces[$datetime_identifier] = $reg_limit;
                     // just an array of ticket IDs grouped by datetime
-                    $this->datetime_tickets[ $datetime_identifier ][] = $ticket_identifier;
+                    $this->datetime_tickets[$datetime_identifier][] = $ticket_identifier;
                     // and an array of datetime IDs grouped by ticket
-                    $this->ticket_datetimes[ $ticket_identifier ][] = $datetime_identifier;
+                    $this->ticket_datetimes[$ticket_identifier][] = $datetime_identifier;
                 }
                 // total quantity of sold and reserved for each ticket
-                $this->tickets_sold[ $ticket_identifier ] = $ticket->sold() + $ticket->reserved();
+                $this->tickets_sold[$ticket_identifier] = $ticket->sold() + $ticket->reserved();
                 // and the maximum ticket quantities for each ticket (adjusted for reg limit)
-                $this->ticket_quantities[ $ticket_identifier ] = $max_tickets;
+                $this->ticket_quantities[$ticket_identifier] = $max_tickets;
             }
         }
         // sort datetime spaces by reg limit, but maintain our string indexes
@@ -417,11 +417,11 @@ 
             \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2);
         }
         foreach ($this->tickets_sold as $ticket_identifier => $tickets_sold) {
-            if (isset($this->ticket_quantities[ $ticket_identifier ])) {
-                $this->ticket_quantities[ $ticket_identifier ] -= $tickets_sold;
+            if (isset($this->ticket_quantities[$ticket_identifier])) {
+                $this->ticket_quantities[$ticket_identifier] -= $tickets_sold;
                 // don't let values go below zero
-                $this->ticket_quantities[ $ticket_identifier ] = max(
-                    $this->ticket_quantities[ $ticket_identifier ],
+                $this->ticket_quantities[$ticket_identifier] = max(
+                    $this->ticket_quantities[$ticket_identifier],
                     0
                 );
                 if ($this->debug) {
@@ -433,15 +433,15 @@ 
                     );
                 }
             }
-            if (isset($this->ticket_datetimes[ $ticket_identifier ])
-                && is_array($this->ticket_datetimes[ $ticket_identifier ])
+            if (isset($this->ticket_datetimes[$ticket_identifier])
+                && is_array($this->ticket_datetimes[$ticket_identifier])
             ) {
-                foreach ($this->ticket_datetimes[ $ticket_identifier ] as $ticket_datetime) {
-                    if (isset($this->ticket_quantities[ $ticket_identifier ])) {
-                        $this->datetime_spaces[ $ticket_datetime ] -= $tickets_sold;
+                foreach ($this->ticket_datetimes[$ticket_identifier] as $ticket_datetime) {
+                    if (isset($this->ticket_quantities[$ticket_identifier])) {
+                        $this->datetime_spaces[$ticket_datetime] -= $tickets_sold;
                         // don't let values go below zero
-                        $this->datetime_spaces[ $ticket_datetime ] = max(
-                            $this->datetime_spaces[ $ticket_datetime ],
+                        $this->datetime_spaces[$ticket_datetime] = max(
+                            $this->datetime_spaces[$ticket_datetime],
                             0
                         );
                         if ($this->debug) {
@@ -466,11 +466,11 @@ 
     private function trackAvailableSpacesForDatetimes($datetime_identifier, array $tickets)
     {
         // make sure a reg limit is set for the datetime
-        $reg_limit = isset($this->datetime_spaces[ $datetime_identifier ])
-            ? $this->datetime_spaces[ $datetime_identifier ]
+        $reg_limit = isset($this->datetime_spaces[$datetime_identifier])
+            ? $this->datetime_spaces[$datetime_identifier]
             : 0;
         // and bail if it is not
-        if (! $reg_limit) {
+        if ( ! $reg_limit) {
             if ($this->debug) {
                 \EEH_Debug_Tools::printr('AT CAPACITY', " . {$datetime_identifier}", __FILE__, __LINE__);
             }
@@ -487,7 +487,7 @@ 
         }
         // number of allocated spaces always starts at zero
         $spaces_allocated = 0;
-        $this->total_spaces[ $datetime_identifier ] = 0;
+        $this->total_spaces[$datetime_identifier] = 0;
         foreach ($tickets as $ticket_identifier) {
             $spaces_allocated = $this->calculateAvailableSpacesForTicket(
                 $datetime_identifier,
@@ -500,7 +500,7 @@ 
         $spaces_allocated = max($spaces_allocated, 0);
         if ($spaces_allocated) {
             // track any non-zero values
-            $this->total_spaces[ $datetime_identifier ] += $spaces_allocated;
+            $this->total_spaces[$datetime_identifier] += $spaces_allocated;
             if ($this->debug) {
                 \EEH_Debug_Tools::printr((string) $spaces_allocated, ' . $spaces_allocated: ', __FILE__, __LINE__);
             }
@@ -511,7 +511,7 @@ 
         }
         if ($this->debug) {
             \EEH_Debug_Tools::printr(
-                $this->total_spaces[ $datetime_identifier ],
+                $this->total_spaces[$datetime_identifier],
                 '$total_spaces',
                 __FILE__,
                 __LINE__
@@ -536,8 +536,8 @@ 
         $spaces_allocated
     ) {
         // make sure ticket quantity is set
-        $ticket_quantity = isset($this->ticket_quantities[ $ticket_identifier ])
-            ? $this->ticket_quantities[ $ticket_identifier ]
+        $ticket_quantity = isset($this->ticket_quantities[$ticket_identifier])
+            ? $this->ticket_quantities[$ticket_identifier]
             : 0;
         if ($this->debug) {
             \EEH_Debug_Tools::printr("{$spaces_allocated}", '$spaces_allocated', __FILE__, __LINE__);
@@ -567,7 +567,7 @@ 
                 //  or the maximum ticket quantity
                 $ticket_quantity = min($reg_limit - $spaces_allocated, $ticket_quantity);
                 // adjust the available quantity in our tracking array
-                $this->ticket_quantities[ $ticket_identifier ] -= $ticket_quantity;
+                $this->ticket_quantities[$ticket_identifier] -= $ticket_quantity;
                 // and increment spaces allocated for this datetime
                 $spaces_allocated += $ticket_quantity;
                 $at_capacity = $spaces_allocated >= $reg_limit;
@@ -624,14 +624,14 @@ 
                 $ticket_quantity
             );
             // skip to next ticket if nothing changed
-            if (! ($adjusted || $at_capacity)) {
+            if ( ! ($adjusted || $at_capacity)) {
                 continue;
             }
             // then all of it's tickets are now unavailable
             foreach ($datetime_tickets as $datetime_ticket) {
                 if (($ticket_identifier === $datetime_ticket || $at_capacity)
-                    && isset($this->ticket_quantities[ $datetime_ticket ])
-                    && $this->ticket_quantities[ $datetime_ticket ] > 0
+                    && isset($this->ticket_quantities[$datetime_ticket])
+                    && $this->ticket_quantities[$datetime_ticket] > 0
                 ) {
                     if ($this->debug) {
                         \EEH_Debug_Tools::printr(
@@ -645,14 +645,14 @@ 
                     // otherwise just subtract the ticket quantity
                     $new_quantity = $at_capacity
                         ? 0
-                        : $this->ticket_quantities[ $datetime_ticket ] - $ticket_quantity;
+                        : $this->ticket_quantities[$datetime_ticket] - $ticket_quantity;
                     // don't let ticket quantity go below zero
-                    $this->ticket_quantities[ $datetime_ticket ] = max($new_quantity, 0);
+                    $this->ticket_quantities[$datetime_ticket] = max($new_quantity, 0);
                     if ($this->debug) {
                         \EEH_Debug_Tools::printr(
                             $at_capacity
                                 ? "0 because Datetime {$datetime_identifier} is at capacity"
-                                : "{$this->ticket_quantities[ $datetime_ticket ]}",
+                                : "{$this->ticket_quantities[$datetime_ticket]}",
                             " . . . . {$datetime_ticket} quantity set to ",
                             __FILE__,
                             __LINE__
@@ -661,8 +661,8 @@ 
                 }
                 // but we also need to adjust spaces for any other datetimes this ticket has access to
                 if ($datetime_ticket === $ticket_identifier) {
-                    if (isset($this->ticket_datetimes[ $datetime_ticket ])
-                        && is_array($this->ticket_datetimes[ $datetime_ticket ])
+                    if (isset($this->ticket_datetimes[$datetime_ticket])
+                        && is_array($this->ticket_datetimes[$datetime_ticket])
                     ) {
                         if ($this->debug) {
                             \EEH_Debug_Tools::printr(
@@ -672,7 +672,7 @@ 
                                 __LINE__
                             );
                         }
-                        foreach ($this->ticket_datetimes[ $datetime_ticket ] as $datetime) {
+                        foreach ($this->ticket_datetimes[$datetime_ticket] as $datetime) {
                             // don't adjust the current datetime twice
                             if ($datetime !== $datetime_identifier) {
                                 $this->adjustDatetimeSpaces(
@@ -692,24 +692,24 @@ 
     {
         // does datetime have spaces available?
         // and does the supplied ticket have access to this datetime ?
-        if ($this->datetime_spaces[ $datetime_identifier ] > 0
-            && isset($this->datetime_spaces[ $datetime_identifier ], $this->datetime_tickets[ $datetime_identifier ])
-            && in_array($ticket_identifier, $this->datetime_tickets[ $datetime_identifier ], true)
+        if ($this->datetime_spaces[$datetime_identifier] > 0
+            && isset($this->datetime_spaces[$datetime_identifier], $this->datetime_tickets[$datetime_identifier])
+            && in_array($ticket_identifier, $this->datetime_tickets[$datetime_identifier], true)
         ) {
             if ($this->debug) {
                 \EEH_Debug_Tools::printr($datetime_identifier, ' . . adjust Datetime Spaces for', __FILE__, __LINE__);
                 \EEH_Debug_Tools::printr(
-                    "{$this->datetime_spaces[ $datetime_identifier ]}",
+                    "{$this->datetime_spaces[$datetime_identifier]}",
                     " . . current  {$datetime_identifier} spaces available",
                     __FILE__,
                     __LINE__
                 );
             }
             // then decrement the available spaces for the datetime
-            $this->datetime_spaces[ $datetime_identifier ] -= $ticket_quantity;
+            $this->datetime_spaces[$datetime_identifier] -= $ticket_quantity;
             // but don't let quantities go below zero
-            $this->datetime_spaces[ $datetime_identifier ] = max(
-                $this->datetime_spaces[ $datetime_identifier ],
+            $this->datetime_spaces[$datetime_identifier] = max(
+                $this->datetime_spaces[$datetime_identifier],
                 0
             );
             if ($this->debug) {

core/domain/services/pue/StatsGatherer.php

Indentation +269 added lines, -269 removed lines

@@ -15,293 +15,293 @@
 class StatsGatherer
 {
 
-    const COUNT_ALL_EVENTS = 'event';
-    const COUNT_ACTIVE_EVENTS = 'active_event';
-    const COUNT_DATETIMES = 'datetime';
-    const COUNT_TICKETS = 'ticket';
-    const COUNT_DATETIMES_SOLD = 'datetime_sold';
-    const COUNT_TICKETS_FREE = 'free_ticket';
-    const COUNT_TICKETS_PAID = 'paid_ticket';
-    const COUNT_TICKETS_SOLD = 'ticket_sold';
-    const COUNT_REGISTRATIONS_APPROVED = 'registrations_approved';
-    const COUNT_REGISTRATIONS_NOT_APPROVED = 'registrations_not_approved';
-    const COUNT_REGISTRATIONS_PENDING = 'registrations_pending';
-    const COUNT_REGISTRATIONS_INCOMPLETE = 'registrations_incomplete';
-    const COUNT_REGISTRATIONS_ALL = 'registrations_all';
-    const COUNT_REGISTRATIONS_CANCELLED = 'registrations_cancelled';
-    const COUNT_REGISTRATIONS_DECLINED = 'registrations_declined';
-    const SUM_TRANSACTIONS_COMPLETE_TOTAL = 'transactions_complete_total_sum';
-    const SUM_TRANSACTIONS_ALL_PAID = 'transactions_all_paid';
-    const INFO_SITE_CURRENCY = 'site_currency';
+	const COUNT_ALL_EVENTS = 'event';
+	const COUNT_ACTIVE_EVENTS = 'active_event';
+	const COUNT_DATETIMES = 'datetime';
+	const COUNT_TICKETS = 'ticket';
+	const COUNT_DATETIMES_SOLD = 'datetime_sold';
+	const COUNT_TICKETS_FREE = 'free_ticket';
+	const COUNT_TICKETS_PAID = 'paid_ticket';
+	const COUNT_TICKETS_SOLD = 'ticket_sold';
+	const COUNT_REGISTRATIONS_APPROVED = 'registrations_approved';
+	const COUNT_REGISTRATIONS_NOT_APPROVED = 'registrations_not_approved';
+	const COUNT_REGISTRATIONS_PENDING = 'registrations_pending';
+	const COUNT_REGISTRATIONS_INCOMPLETE = 'registrations_incomplete';
+	const COUNT_REGISTRATIONS_ALL = 'registrations_all';
+	const COUNT_REGISTRATIONS_CANCELLED = 'registrations_cancelled';
+	const COUNT_REGISTRATIONS_DECLINED = 'registrations_declined';
+	const SUM_TRANSACTIONS_COMPLETE_TOTAL = 'transactions_complete_total_sum';
+	const SUM_TRANSACTIONS_ALL_PAID = 'transactions_all_paid';
+	const INFO_SITE_CURRENCY = 'site_currency';
 
 
-    /**
-     * @var EEM_Payment_Method
-     */
-    private $payment_method_model;
+	/**
+	 * @var EEM_Payment_Method
+	 */
+	private $payment_method_model;
 
 
-    /**
-     * @var EEM_Event
-     */
-    private $event_model;
+	/**
+	 * @var EEM_Event
+	 */
+	private $event_model;
 
-    /**
-     * @var EEM_Datetime
-     */
-    private $datetime_model;
+	/**
+	 * @var EEM_Datetime
+	 */
+	private $datetime_model;
 
 
-    /**
-     * @var EEM_Ticket
-     */
-    private $ticket_model;
+	/**
+	 * @var EEM_Ticket
+	 */
+	private $ticket_model;
 
 
-    /**
-     * @var EEM_Registration
-     */
-    private $registration_model;
+	/**
+	 * @var EEM_Registration
+	 */
+	private $registration_model;
 
 
-    /**
-     * @var EEM_Transaction
-     */
-    private $transaction_model;
+	/**
+	 * @var EEM_Transaction
+	 */
+	private $transaction_model;
 
 
-    /**
-     * @var EE_Config
-     */
-    private $config;
+	/**
+	 * @var EE_Config
+	 */
+	private $config;
 
 
-    /**
-     * StatsGatherer constructor.
-     *
-     * @param EEM_Payment_Method $payment_method_model
-     * @param EEM_Event          $event_model
-     * @param EEM_Datetime       $datetime_model
-     * @param EEM_Ticket         $ticket_model
-     * @param EEM_Registration   $registration_model
-     * @param EEM_Transaction    $transaction_model
-     * @param EE_Config          $config
-     */
-    public function __construct(
-        EEM_Payment_Method $payment_method_model,
-        EEM_Event $event_model,
-        EEM_Datetime $datetime_model,
-        EEM_Ticket $ticket_model,
-        EEM_Registration $registration_model,
-        EEM_Transaction $transaction_model,
-        EE_Config $config
-    ) {
-        $this->payment_method_model = $payment_method_model;
-        $this->event_model = $event_model;
-        $this->datetime_model = $datetime_model;
-        $this->ticket_model = $ticket_model;
-        $this->registration_model = $registration_model;
-        $this->transaction_model = $transaction_model;
-        $this->config = $config;
-    }
+	/**
+	 * StatsGatherer constructor.
+	 *
+	 * @param EEM_Payment_Method $payment_method_model
+	 * @param EEM_Event          $event_model
+	 * @param EEM_Datetime       $datetime_model
+	 * @param EEM_Ticket         $ticket_model
+	 * @param EEM_Registration   $registration_model
+	 * @param EEM_Transaction    $transaction_model
+	 * @param EE_Config          $config
+	 */
+	public function __construct(
+		EEM_Payment_Method $payment_method_model,
+		EEM_Event $event_model,
+		EEM_Datetime $datetime_model,
+		EEM_Ticket $ticket_model,
+		EEM_Registration $registration_model,
+		EEM_Transaction $transaction_model,
+		EE_Config $config
+	) {
+		$this->payment_method_model = $payment_method_model;
+		$this->event_model = $event_model;
+		$this->datetime_model = $datetime_model;
+		$this->ticket_model = $ticket_model;
+		$this->registration_model = $registration_model;
+		$this->transaction_model = $transaction_model;
+		$this->config = $config;
+	}
 
 
-    /**
-     * Return the stats array for PUE UXIP stats.
-     *
-     * @return array
-     */
-    public function stats()
-    {
-        $stats = $this->paymentMethodStats();
-        // a-ok so let's setup our stats.
-        $stats = array_merge($stats, array(
-            'is_multisite'                    => is_multisite() && is_main_site(),
-            'active_theme'                    => $this->getActiveThemeStat(),
-            'ee4_all_events_count'            => $this->getCountFor(self::COUNT_ALL_EVENTS),
-            'ee4_active_events_count'         => $this->getCountFor(self::COUNT_ACTIVE_EVENTS),
-            'all_dtts_count'                  => $this->getCountFor(self::COUNT_DATETIMES),
-            'dtt_sold'                        => $this->getCountFor(self::COUNT_DATETIMES_SOLD),
-            'all_tkt_count'                   => $this->getCountFor(self::COUNT_TICKETS),
-            'free_tkt_count'                  => $this->getCountFor(self::COUNT_TICKETS_FREE),
-            'paid_tkt_count'                  => $this->getCountFor(self::COUNT_TICKETS_PAID),
-            'tkt_sold'                        => $this->getCountFor(self::COUNT_TICKETS_SOLD),
-            'approve_registration_count'      => $this->getCountFor(self::COUNT_REGISTRATIONS_APPROVED),
-            'pending_registration_count'      => $this->getCountFor(self::COUNT_REGISTRATIONS_PENDING),
-            'not_approved_registration_count' => $this->getCountFor(self::COUNT_REGISTRATIONS_NOT_APPROVED),
-            'incomplete_registration_count'   => $this->getCountFor(self::COUNT_REGISTRATIONS_INCOMPLETE),
-            'cancelled_registration_count'    => $this->getCountFor(self::COUNT_REGISTRATIONS_CANCELLED),
-            'declined_registration_count'     => $this->getCountFor(self::COUNT_REGISTRATIONS_DECLINED),
-            'all_registration_count'          => $this->getCountFor(self::COUNT_REGISTRATIONS_ALL),
-            'completed_transaction_total_sum' => $this->getCountFor(self::SUM_TRANSACTIONS_COMPLETE_TOTAL),
-            'all_transaction_paid_sum'        => $this->getCountFor(self::SUM_TRANSACTIONS_ALL_PAID),
-            self::INFO_SITE_CURRENCY          => $this->config->currency instanceof EE_Currency_Config
-                ? $this->config->currency->code
-                : 'unknown',
-            'phpversion'                      => implode(
-                '.',
-                array(PHP_MAJOR_VERSION, PHP_MINOR_VERSION, PHP_RELEASE_VERSION)
-            ),
-        ));
-        // remove any values that equal null.  This ensures any stats that weren't retrieved successfully are excluded.
-        return array_filter($stats, function ($value) {
-            return $value !== null;
-        });
-    }
+	/**
+	 * Return the stats array for PUE UXIP stats.
+	 *
+	 * @return array
+	 */
+	public function stats()
+	{
+		$stats = $this->paymentMethodStats();
+		// a-ok so let's setup our stats.
+		$stats = array_merge($stats, array(
+			'is_multisite'                    => is_multisite() && is_main_site(),
+			'active_theme'                    => $this->getActiveThemeStat(),
+			'ee4_all_events_count'            => $this->getCountFor(self::COUNT_ALL_EVENTS),
+			'ee4_active_events_count'         => $this->getCountFor(self::COUNT_ACTIVE_EVENTS),
+			'all_dtts_count'                  => $this->getCountFor(self::COUNT_DATETIMES),
+			'dtt_sold'                        => $this->getCountFor(self::COUNT_DATETIMES_SOLD),
+			'all_tkt_count'                   => $this->getCountFor(self::COUNT_TICKETS),
+			'free_tkt_count'                  => $this->getCountFor(self::COUNT_TICKETS_FREE),
+			'paid_tkt_count'                  => $this->getCountFor(self::COUNT_TICKETS_PAID),
+			'tkt_sold'                        => $this->getCountFor(self::COUNT_TICKETS_SOLD),
+			'approve_registration_count'      => $this->getCountFor(self::COUNT_REGISTRATIONS_APPROVED),
+			'pending_registration_count'      => $this->getCountFor(self::COUNT_REGISTRATIONS_PENDING),
+			'not_approved_registration_count' => $this->getCountFor(self::COUNT_REGISTRATIONS_NOT_APPROVED),
+			'incomplete_registration_count'   => $this->getCountFor(self::COUNT_REGISTRATIONS_INCOMPLETE),
+			'cancelled_registration_count'    => $this->getCountFor(self::COUNT_REGISTRATIONS_CANCELLED),
+			'declined_registration_count'     => $this->getCountFor(self::COUNT_REGISTRATIONS_DECLINED),
+			'all_registration_count'          => $this->getCountFor(self::COUNT_REGISTRATIONS_ALL),
+			'completed_transaction_total_sum' => $this->getCountFor(self::SUM_TRANSACTIONS_COMPLETE_TOTAL),
+			'all_transaction_paid_sum'        => $this->getCountFor(self::SUM_TRANSACTIONS_ALL_PAID),
+			self::INFO_SITE_CURRENCY          => $this->config->currency instanceof EE_Currency_Config
+				? $this->config->currency->code
+				: 'unknown',
+			'phpversion'                      => implode(
+				'.',
+				array(PHP_MAJOR_VERSION, PHP_MINOR_VERSION, PHP_RELEASE_VERSION)
+			),
+		));
+		// remove any values that equal null.  This ensures any stats that weren't retrieved successfully are excluded.
+		return array_filter($stats, function ($value) {
+			return $value !== null;
+		});
+	}
 
-    /**
-     * @param string $which enum (@see constants prefixed with COUNT)
-     * @return int|null
-     */
-    private function getCountFor($which)
-    {
-        try {
-            switch ($which) {
-                case self::COUNT_ALL_EVENTS:
-                    $count = $this->event_model->count();
-                    break;
-                case self::COUNT_TICKETS:
-                    $count = $this->ticket_model->count();
-                    break;
-                case self::COUNT_DATETIMES:
-                    $count = $this->datetime_model->count();
-                    break;
-                case self::COUNT_ACTIVE_EVENTS:
-                    $count = $this->event_model->get_active_events(array(), true);
-                    break;
-                case self::COUNT_DATETIMES_SOLD:
-                    $count = $this->datetime_model->sum(array(), 'DTT_sold');
-                    break;
-                case self::COUNT_TICKETS_FREE:
-                    $count = $this->ticket_model->count(array(
-                        array(
-                            'TKT_price' => 0,
-                        ),
-                    ));
-                    break;
-                case self::COUNT_TICKETS_PAID:
-                    $count = $this->ticket_model->count(array(
-                        array(
-                            'TKT_price' => array('>', 0),
-                        ),
-                    ));
-                    break;
-                case self::COUNT_TICKETS_SOLD:
-                    $count = $this->ticket_model->sum(array(), 'TKT_sold');
-                    break;
-                case self::COUNT_REGISTRATIONS_ALL:
-                    $count = $this->registration_model->count();
-                    break;
-                case self::COUNT_REGISTRATIONS_CANCELLED:
-                    $count = $this->registration_model->count(
-                        array(
-                            array(
-                                'STS_ID' => EEM_Registration::status_id_cancelled,
-                            ),
-                        )
-                    );
-                    break;
-                case self::COUNT_REGISTRATIONS_INCOMPLETE:
-                    $count = $this->registration_model->count(
-                        array(
-                            array(
-                                'STS_ID' => EEM_Registration::status_id_incomplete,
-                            ),
-                        )
-                    );
-                    break;
-                case self::COUNT_REGISTRATIONS_NOT_APPROVED:
-                    $count = $this->registration_model->count(
-                        array(
-                            array(
-                                'STS_ID' => EEM_Registration::status_id_not_approved,
-                            ),
-                        )
-                    );
-                    break;
-                case self::COUNT_REGISTRATIONS_DECLINED:
-                    $count = $this->registration_model->count(
-                        array(
-                            array(
-                                'STS_ID' => EEM_Registration::status_id_declined,
-                            ),
-                        )
-                    );
-                    break;
-                case self::COUNT_REGISTRATIONS_PENDING:
-                    $count = $this->registration_model->count(
-                        array(
-                            array(
-                                'STS_ID' => EEM_Registration::status_id_pending_payment,
-                            ),
-                        )
-                    );
-                    break;
-                case self::COUNT_REGISTRATIONS_APPROVED:
-                    $count = $this->registration_model->count(
-                        array(
-                            array(
-                                'STS_ID' => EEM_Registration::status_id_approved,
-                            ),
-                        )
-                    );
-                    break;
-                case self::SUM_TRANSACTIONS_COMPLETE_TOTAL:
-                    $count = $this->transaction_model->sum(
-                        array(
-                            array(
-                                'STS_ID' => EEM_Transaction::complete_status_code,
-                            ),
-                        ),
-                        'TXN_total'
-                    );
-                    break;
-                case self::SUM_TRANSACTIONS_ALL_PAID:
-                    $count = $this->transaction_model->sum(
-                        array(),
-                        'TXN_paid'
-                    );
-                    break;
-                default:
-                    $count = null;
-                    break;
-            }
-        } catch (Exception $e) {
-            $count = null;
-        }
-        return $count;
-    }
+	/**
+	 * @param string $which enum (@see constants prefixed with COUNT)
+	 * @return int|null
+	 */
+	private function getCountFor($which)
+	{
+		try {
+			switch ($which) {
+				case self::COUNT_ALL_EVENTS:
+					$count = $this->event_model->count();
+					break;
+				case self::COUNT_TICKETS:
+					$count = $this->ticket_model->count();
+					break;
+				case self::COUNT_DATETIMES:
+					$count = $this->datetime_model->count();
+					break;
+				case self::COUNT_ACTIVE_EVENTS:
+					$count = $this->event_model->get_active_events(array(), true);
+					break;
+				case self::COUNT_DATETIMES_SOLD:
+					$count = $this->datetime_model->sum(array(), 'DTT_sold');
+					break;
+				case self::COUNT_TICKETS_FREE:
+					$count = $this->ticket_model->count(array(
+						array(
+							'TKT_price' => 0,
+						),
+					));
+					break;
+				case self::COUNT_TICKETS_PAID:
+					$count = $this->ticket_model->count(array(
+						array(
+							'TKT_price' => array('>', 0),
+						),
+					));
+					break;
+				case self::COUNT_TICKETS_SOLD:
+					$count = $this->ticket_model->sum(array(), 'TKT_sold');
+					break;
+				case self::COUNT_REGISTRATIONS_ALL:
+					$count = $this->registration_model->count();
+					break;
+				case self::COUNT_REGISTRATIONS_CANCELLED:
+					$count = $this->registration_model->count(
+						array(
+							array(
+								'STS_ID' => EEM_Registration::status_id_cancelled,
+							),
+						)
+					);
+					break;
+				case self::COUNT_REGISTRATIONS_INCOMPLETE:
+					$count = $this->registration_model->count(
+						array(
+							array(
+								'STS_ID' => EEM_Registration::status_id_incomplete,
+							),
+						)
+					);
+					break;
+				case self::COUNT_REGISTRATIONS_NOT_APPROVED:
+					$count = $this->registration_model->count(
+						array(
+							array(
+								'STS_ID' => EEM_Registration::status_id_not_approved,
+							),
+						)
+					);
+					break;
+				case self::COUNT_REGISTRATIONS_DECLINED:
+					$count = $this->registration_model->count(
+						array(
+							array(
+								'STS_ID' => EEM_Registration::status_id_declined,
+							),
+						)
+					);
+					break;
+				case self::COUNT_REGISTRATIONS_PENDING:
+					$count = $this->registration_model->count(
+						array(
+							array(
+								'STS_ID' => EEM_Registration::status_id_pending_payment,
+							),
+						)
+					);
+					break;
+				case self::COUNT_REGISTRATIONS_APPROVED:
+					$count = $this->registration_model->count(
+						array(
+							array(
+								'STS_ID' => EEM_Registration::status_id_approved,
+							),
+						)
+					);
+					break;
+				case self::SUM_TRANSACTIONS_COMPLETE_TOTAL:
+					$count = $this->transaction_model->sum(
+						array(
+							array(
+								'STS_ID' => EEM_Transaction::complete_status_code,
+							),
+						),
+						'TXN_total'
+					);
+					break;
+				case self::SUM_TRANSACTIONS_ALL_PAID:
+					$count = $this->transaction_model->sum(
+						array(),
+						'TXN_paid'
+					);
+					break;
+				default:
+					$count = null;
+					break;
+			}
+		} catch (Exception $e) {
+			$count = null;
+		}
+		return $count;
+	}
 
-    /**
-     * Return the active theme.
-     *
-     * @return false|string
-     */
-    private function getActiveThemeStat()
-    {
-        $theme = wp_get_theme();
-        return $theme->get('Name');
-    }
+	/**
+	 * Return the active theme.
+	 *
+	 * @return false|string
+	 */
+	private function getActiveThemeStat()
+	{
+		$theme = wp_get_theme();
+		return $theme->get('Name');
+	}
 
-    /**
-     * @return array
-     */
-    private function paymentMethodStats()
-    {
-        $payment_method_stats = array();
-        try {
-            $active_payment_methods = $this->payment_method_model->get_all_active(
-                null,
-                array('group_by' => 'PMD_type')
-            );
-            if ($active_payment_methods) {
-                foreach ($active_payment_methods as $payment_method) {
-                    $payment_method_stats[ $payment_method->name() . '_active_payment_method' ] = 1;
-                }
-            }
-        } catch (Exception $e) {
-            // do nothing just prevents fatals.
-        }
-        return $payment_method_stats;
-    }
+	/**
+	 * @return array
+	 */
+	private function paymentMethodStats()
+	{
+		$payment_method_stats = array();
+		try {
+			$active_payment_methods = $this->payment_method_model->get_all_active(
+				null,
+				array('group_by' => 'PMD_type')
+			);
+			if ($active_payment_methods) {
+				foreach ($active_payment_methods as $payment_method) {
+					$payment_method_stats[ $payment_method->name() . '_active_payment_method' ] = 1;
+				}
+			}
+		} catch (Exception $e) {
+			// do nothing just prevents fatals.
+		}
+		return $payment_method_stats;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -144,7 +144,7 @@ 
             ),
         ));
         // remove any values that equal null.  This ensures any stats that weren't retrieved successfully are excluded.
-        return array_filter($stats, function ($value) {
+        return array_filter($stats, function($value) {
             return $value !== null;
         });
     }
@@ -296,7 +296,7 @@ 
             );
             if ($active_payment_methods) {
                 foreach ($active_payment_methods as $payment_method) {
-                    $payment_method_stats[ $payment_method->name() . '_active_payment_method' ] = 1;
+                    $payment_method_stats[$payment_method->name().'_active_payment_method'] = 1;
                 }
             }
         } catch (Exception $e) {

core/domain/services/pue/Stats.php

Indentation +203 added lines, -203 removed lines

@@ -22,88 +22,88 @@ 
 class Stats
 {
 
-    const OPTIONS_KEY_EXPIRY_TIMESTAMP_FOR_SENDING_STATS = 'ee_uxip_stats_expiry';
-
-    /**
-     * @var Config
-     */
-    private $config;
-
-
-    /**
-     * @var StatsGatherer
-     */
-    private $stats_gatherer;
-
-
-    /**
-     * @var EE_Maintenance_Mode
-     */
-    private $maintenance_mode;
-
-    public function __construct(
-        Config $config,
-        EE_Maintenance_Mode $maintenance_mode,
-        StatsGatherer $stats_gatherer
-    ) {
-        $this->config = $config;
-        $this->maintenance_mode = $maintenance_mode;
-        $this->stats_gatherer = $stats_gatherer;
-        $this->setUxipNotices();
-    }
-
-
-    /**
-     * Displays uxip opt-in notice if necessary.
-     */
-    private function setUxipNotices()
-    {
-        if ($this->canDisplayNotices()) {
-            add_action('admin_notices', array($this, 'optinNotice'));
-            add_action('admin_enqueue_scripts', array($this, 'enqueueScripts'));
-            add_action('wp_ajax_espresso_data_optin', array($this, 'ajaxHandler'));
-            // makes sure optin defaults to yes even if its currently empty.
-            $this->config->setHasOptedInForUxip();
-        }
-    }
-
-
-    /**
-     * This returns the callback that PluginUpdateEngineChecker will use for getting any extra stats to send.
-     *
-     * @return Closure
-     */
-    public function statsCallback()
-    {
-        // returns a callback that can is used to retrieve the stats to send along to the pue server.
-        return function () {
-            // we only send stats one a week, so let's see if our stat timestamp has expired.
-            if (! $this->sendStats()) {
-                return array();
-            }
-            return $this->stats_gatherer->stats();
-        };
-    }
-
-
-    /**
-     * Return whether notices can be displayed or not
-     *
-     * @return bool
-     */
-    private function canDisplayNotices()
-    {
-        return ! $this->config->hasNotifiedForUxip()
-               && $this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance;
-    }
-
-
-    /**
-     * Callback for the admin_notices hook that outputs the UXIP optin-in notice.
-     */
-    public function optinNotice()
-    {
-        ?>
+	const OPTIONS_KEY_EXPIRY_TIMESTAMP_FOR_SENDING_STATS = 'ee_uxip_stats_expiry';
+
+	/**
+	 * @var Config
+	 */
+	private $config;
+
+
+	/**
+	 * @var StatsGatherer
+	 */
+	private $stats_gatherer;
+
+
+	/**
+	 * @var EE_Maintenance_Mode
+	 */
+	private $maintenance_mode;
+
+	public function __construct(
+		Config $config,
+		EE_Maintenance_Mode $maintenance_mode,
+		StatsGatherer $stats_gatherer
+	) {
+		$this->config = $config;
+		$this->maintenance_mode = $maintenance_mode;
+		$this->stats_gatherer = $stats_gatherer;
+		$this->setUxipNotices();
+	}
+
+
+	/**
+	 * Displays uxip opt-in notice if necessary.
+	 */
+	private function setUxipNotices()
+	{
+		if ($this->canDisplayNotices()) {
+			add_action('admin_notices', array($this, 'optinNotice'));
+			add_action('admin_enqueue_scripts', array($this, 'enqueueScripts'));
+			add_action('wp_ajax_espresso_data_optin', array($this, 'ajaxHandler'));
+			// makes sure optin defaults to yes even if its currently empty.
+			$this->config->setHasOptedInForUxip();
+		}
+	}
+
+
+	/**
+	 * This returns the callback that PluginUpdateEngineChecker will use for getting any extra stats to send.
+	 *
+	 * @return Closure
+	 */
+	public function statsCallback()
+	{
+		// returns a callback that can is used to retrieve the stats to send along to the pue server.
+		return function () {
+			// we only send stats one a week, so let's see if our stat timestamp has expired.
+			if (! $this->sendStats()) {
+				return array();
+			}
+			return $this->stats_gatherer->stats();
+		};
+	}
+
+
+	/**
+	 * Return whether notices can be displayed or not
+	 *
+	 * @return bool
+	 */
+	private function canDisplayNotices()
+	{
+		return ! $this->config->hasNotifiedForUxip()
+			   && $this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance;
+	}
+
+
+	/**
+	 * Callback for the admin_notices hook that outputs the UXIP optin-in notice.
+	 */
+	public function optinNotice()
+	{
+		?>
         <div class="updated data-collect-optin" id="espresso-data-collect-optin-container">
             <div id="data-collect-optin-options-container">
                 <span class="dashicons dashicons-admin-site"></span>
@@ -116,125 +116,125 @@ 
             </div>
         </div>
         <?php
-    }
-
-
-    /**
-     * Retrieves the optin text (static so it can be used in multiple places as necessary).
-     *
-     * @param bool $extra
-     */
-    public static function optinText($extra = true)
-    {
-        if (! $extra) {
-            echo '<h2 class="ee-admin-settings-hdr" '
-                 . (! $extra ? 'id="UXIP_settings"' : '')
-                 . '>'
-                 . esc_html__('User eXperience Improvement Program (UXIP)', 'event_espresso')
-                 . EEH_Template::get_help_tab_link('organization_logo_info')
-                 . '</h2>';
-            printf(
-                esc_html__(
-                    '%1$sPlease help us make Event Espresso better and vote for your favorite features.%2$s The %3$sUser eXperience Improvement Program (UXIP)%4$s, has been created so when you use Event Espresso you are voting for the features and settings that are important to you. The UXIP helps us understand how you use our products and services, track problems and in what context. If you opt-out of the UXIP you essentially elect for us to disregard how you use Event Espresso as we build new features and make changes. Participation in the program is completely voluntary but it is enabled by default. The end results of the UXIP are software improvements to better meet your needs. The data we collect will never be sold, traded, or misused in any way. %5$sPlease see our %6$sPrivacy Policy%7$s for more information.',
-                    'event_espresso'
-                ),
-                '<p><em>',
-                '</em></p>',
-                '<a href="https://eventespresso.com/about/user-experience-improvement-program-uxip/" target="_blank">',
-                '</a>',
-                '<br><br>',
-                '<a href="https://eventespresso.com/about/privacy-policy/" target="_blank">',
-                '</a>'
-            );
-        } else {
-            $settings_url = EE_Admin_Page::add_query_args_and_nonce(
-                array('action' => 'default'),
-                admin_url('admin.php?page=espresso_general_settings')
-            );
-            $settings_url .= '#UXIP_settings';
-            printf(
-                esc_html__(
-                    'The Event Espresso UXIP feature is active on your site. For %1$smore info%2$s and to opt-out %3$sclick here%4$s.',
-                    'event_espresso'
-                ),
-                '<a href="https://eventespresso.com/about/user-experience-improvement-program-uxip/" target="_blank">',
-                '</a>',
-                '<a href="' . $settings_url . '" target="_blank">',
-                '</a>'
-            );
-        }
-    }
-
-
-    /**
-     * Callback for admin_enqueue_scripts that sets up the scripts and styles for the uxip notice
-     */
-    public function enqueueScripts()
-    {
-        wp_register_script(
-            'ee-data-optin-js',
-            EE_GLOBAL_ASSETS_URL . 'scripts/ee-data-optin.js',
-            array('jquery'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_style(
-            'ee-data-optin-css',
-            EE_GLOBAL_ASSETS_URL . 'css/ee-data-optin.css',
-            array(),
-            EVENT_ESPRESSO_VERSION
-        );
-
-        wp_enqueue_script('ee-data-optin-js');
-        wp_enqueue_style('ee-data-optin-css');
-    }
-
-
-    /**
-     * Callback for wp_ajax_espresso_data_optin that handles the ajax request
-     */
-    public function ajaxHandler()
-    {
-        // verify nonce
-        if (isset($_POST['nonce']) && ! wp_verify_nonce($_POST['nonce'], 'ee-data-optin')) {
-            exit();
-        }
-
-        // update has notified option
-        $this->config->setHasNotifiedAboutUxip();
-        exit();
-    }
-
-
-    /**
-     * Used to determine whether additional stats are sent.
-     */
-    private function sendStats()
-    {
-        return $this->config->isOptedInForUxip()
-               && $this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance
-               && $this->statSendTimestampExpired();
-    }
-
-
-    /**
-     * Returns true when the timestamp used to track whether stats get sent (currently a weekly interval) is expired.
-     * Returns false otherwise.
-     *
-     * @return bool
-     */
-    private function statSendTimestampExpired()
-    {
-        $current_expiry = get_option(self::OPTIONS_KEY_EXPIRY_TIMESTAMP_FOR_SENDING_STATS, null);
-        if ($current_expiry === null) {
-            add_option(self::OPTIONS_KEY_EXPIRY_TIMESTAMP_FOR_SENDING_STATS, time() + WEEK_IN_SECONDS, '', 'no');
-            return true;
-        }
-
-        if (time() > (int) $current_expiry) {
-            update_option(self::OPTIONS_KEY_EXPIRY_TIMESTAMP_FOR_SENDING_STATS, time() + WEEK_IN_SECONDS);
-            return true;
-        }
-        return false;
-    }
+	}
+
+
+	/**
+	 * Retrieves the optin text (static so it can be used in multiple places as necessary).
+	 *
+	 * @param bool $extra
+	 */
+	public static function optinText($extra = true)
+	{
+		if (! $extra) {
+			echo '<h2 class="ee-admin-settings-hdr" '
+				 . (! $extra ? 'id="UXIP_settings"' : '')
+				 . '>'
+				 . esc_html__('User eXperience Improvement Program (UXIP)', 'event_espresso')
+				 . EEH_Template::get_help_tab_link('organization_logo_info')
+				 . '</h2>';
+			printf(
+				esc_html__(
+					'%1$sPlease help us make Event Espresso better and vote for your favorite features.%2$s The %3$sUser eXperience Improvement Program (UXIP)%4$s, has been created so when you use Event Espresso you are voting for the features and settings that are important to you. The UXIP helps us understand how you use our products and services, track problems and in what context. If you opt-out of the UXIP you essentially elect for us to disregard how you use Event Espresso as we build new features and make changes. Participation in the program is completely voluntary but it is enabled by default. The end results of the UXIP are software improvements to better meet your needs. The data we collect will never be sold, traded, or misused in any way. %5$sPlease see our %6$sPrivacy Policy%7$s for more information.',
+					'event_espresso'
+				),
+				'<p><em>',
+				'</em></p>',
+				'<a href="https://eventespresso.com/about/user-experience-improvement-program-uxip/" target="_blank">',
+				'</a>',
+				'<br><br>',
+				'<a href="https://eventespresso.com/about/privacy-policy/" target="_blank">',
+				'</a>'
+			);
+		} else {
+			$settings_url = EE_Admin_Page::add_query_args_and_nonce(
+				array('action' => 'default'),
+				admin_url('admin.php?page=espresso_general_settings')
+			);
+			$settings_url .= '#UXIP_settings';
+			printf(
+				esc_html__(
+					'The Event Espresso UXIP feature is active on your site. For %1$smore info%2$s and to opt-out %3$sclick here%4$s.',
+					'event_espresso'
+				),
+				'<a href="https://eventespresso.com/about/user-experience-improvement-program-uxip/" target="_blank">',
+				'</a>',
+				'<a href="' . $settings_url . '" target="_blank">',
+				'</a>'
+			);
+		}
+	}
+
+
+	/**
+	 * Callback for admin_enqueue_scripts that sets up the scripts and styles for the uxip notice
+	 */
+	public function enqueueScripts()
+	{
+		wp_register_script(
+			'ee-data-optin-js',
+			EE_GLOBAL_ASSETS_URL . 'scripts/ee-data-optin.js',
+			array('jquery'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_style(
+			'ee-data-optin-css',
+			EE_GLOBAL_ASSETS_URL . 'css/ee-data-optin.css',
+			array(),
+			EVENT_ESPRESSO_VERSION
+		);
+
+		wp_enqueue_script('ee-data-optin-js');
+		wp_enqueue_style('ee-data-optin-css');
+	}
+
+
+	/**
+	 * Callback for wp_ajax_espresso_data_optin that handles the ajax request
+	 */
+	public function ajaxHandler()
+	{
+		// verify nonce
+		if (isset($_POST['nonce']) && ! wp_verify_nonce($_POST['nonce'], 'ee-data-optin')) {
+			exit();
+		}
+
+		// update has notified option
+		$this->config->setHasNotifiedAboutUxip();
+		exit();
+	}
+
+
+	/**
+	 * Used to determine whether additional stats are sent.
+	 */
+	private function sendStats()
+	{
+		return $this->config->isOptedInForUxip()
+			   && $this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance
+			   && $this->statSendTimestampExpired();
+	}
+
+
+	/**
+	 * Returns true when the timestamp used to track whether stats get sent (currently a weekly interval) is expired.
+	 * Returns false otherwise.
+	 *
+	 * @return bool
+	 */
+	private function statSendTimestampExpired()
+	{
+		$current_expiry = get_option(self::OPTIONS_KEY_EXPIRY_TIMESTAMP_FOR_SENDING_STATS, null);
+		if ($current_expiry === null) {
+			add_option(self::OPTIONS_KEY_EXPIRY_TIMESTAMP_FOR_SENDING_STATS, time() + WEEK_IN_SECONDS, '', 'no');
+			return true;
+		}
+
+		if (time() > (int) $current_expiry) {
+			update_option(self::OPTIONS_KEY_EXPIRY_TIMESTAMP_FOR_SENDING_STATS, time() + WEEK_IN_SECONDS);
+			return true;
+		}
+		return false;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -76,9 +76,9 @@ 
     public function statsCallback()
     {
         // returns a callback that can is used to retrieve the stats to send along to the pue server.
-        return function () {
+        return function() {
             // we only send stats one a week, so let's see if our stat timestamp has expired.
-            if (! $this->sendStats()) {
+            if ( ! $this->sendStats()) {
                 return array();
             }
             return $this->stats_gatherer->stats();
@@ -126,9 +126,9 @@ 
      */
     public static function optinText($extra = true)
     {
-        if (! $extra) {
+        if ( ! $extra) {
             echo '<h2 class="ee-admin-settings-hdr" '
-                 . (! $extra ? 'id="UXIP_settings"' : '')
+                 . ( ! $extra ? 'id="UXIP_settings"' : '')
                  . '>'
                  . esc_html__('User eXperience Improvement Program (UXIP)', 'event_espresso')
                  . EEH_Template::get_help_tab_link('organization_logo_info')
@@ -159,7 +159,7 @@ 
                 ),
                 '<a href="https://eventespresso.com/about/user-experience-improvement-program-uxip/" target="_blank">',
                 '</a>',
-                '<a href="' . $settings_url . '" target="_blank">',
+                '<a href="'.$settings_url.'" target="_blank">',
                 '</a>'
             );
         }
@@ -173,14 +173,14 @@ 
     {
         wp_register_script(
             'ee-data-optin-js',
-            EE_GLOBAL_ASSETS_URL . 'scripts/ee-data-optin.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/ee-data-optin.js',
             array('jquery'),
             EVENT_ESPRESSO_VERSION,
             true
         );
         wp_register_style(
             'ee-data-optin-css',
-            EE_GLOBAL_ASSETS_URL . 'css/ee-data-optin.css',
+            EE_GLOBAL_ASSETS_URL.'css/ee-data-optin.css',
             array(),
             EVENT_ESPRESSO_VERSION
         );

core/domain/services/ticket/CancelTicketLineItemService.php

Indentation +105 added lines, -105 removed lines

@@ -20,113 +20,113 @@
 {
 
 
-    /**
-     * @param \EE_Registration $registration
-     * @param int              $quantity
-     * @return bool|int
-     */
-    public function forRegistration(\EE_Registration $registration, $quantity = 1)
-    {
-        return $this->cancel(
-            $registration->transaction(),
-            $registration->ticket(),
-            $quantity,
-            $registration->ticket_line_item()
-        );
-    }
+	/**
+	 * @param \EE_Registration $registration
+	 * @param int              $quantity
+	 * @return bool|int
+	 */
+	public function forRegistration(\EE_Registration $registration, $quantity = 1)
+	{
+		return $this->cancel(
+			$registration->transaction(),
+			$registration->ticket(),
+			$quantity,
+			$registration->ticket_line_item()
+		);
+	}
 
 
-    /**
-     * @param \EE_Transaction $transaction
-     * @param \EE_Ticket      $ticket
-     * @param int             $quantity
-     * @param \EE_Line_Item   $ticket_line_item
-     * @return bool|int
-     */
-    public function cancel(
-        \EE_Transaction $transaction,
-        \EE_Ticket $ticket,
-        $quantity = 1,
-        \EE_Line_Item $ticket_line_item = null
-    ) {
-        $ticket_line_item = $ticket_line_item instanceof \EE_Line_Item
-            ? $ticket_line_item
-            : $this->getTicketLineItem($transaction, $ticket);
-        // first we need to decrement the ticket quantity
-        \EEH_Line_Item::decrement_quantity($ticket_line_item, $quantity);
-        // no tickets left for this line item ?
-        if ((int) $ticket_line_item->quantity() === 0) {
-            // then just set this line item as cancelled, save, and get out
-            $ticket_line_item->set_type(\EEM_Line_Item::type_cancellation);
-            $success = $ticket_line_item->save();
-        } else {
-            // otherwise create a new cancelled line item, so that we have a record of the cancellation
-            $items_subtotal = \EEH_Line_Item::get_pre_tax_subtotal(
-                \EEH_Line_Item::get_event_line_item_for_ticket(
-                    $transaction->total_line_item(),
-                    $ticket
-                )
-            );
-            $cancelled_line_item = \EE_Line_Item::new_instance(
-                array(
-                    'LIN_name'       => $ticket_line_item->name(),
-                    'LIN_desc'       => sprintf(
-                        __('%1$s Cancelled: %2$s', 'event_espresso'),
-                        $ticket_line_item->desc(),
-                        date('Y-m-d h:i a')
-                    ),
-                    'LIN_unit_price' => (float) $ticket_line_item->unit_price(),
-                    'LIN_quantity'   => $quantity,
-                    'LIN_percent'    => null,
-                    'LIN_is_taxable' => false,
-                    'LIN_order'      => $items_subtotal instanceof \EE_Line_Item
-                        ? count($items_subtotal->children())
-                        : 0,
-                    'LIN_total'      => (float) $ticket_line_item->unit_price(),
-                    'LIN_type'       => \EEM_Line_Item::type_cancellation,
-                )
-            );
-            $success = \EEH_Line_Item::add_item($transaction->total_line_item(), $cancelled_line_item);
-        }
-        if (! $success) {
-            throw new \RuntimeException(
-                sprintf(
-                    __('An error occurred while attempting to cancel ticket line item %1$s', 'event_espresso'),
-                    $ticket_line_item->ID()
-                )
-            );
-        }
-        return $success;
-    }
+	/**
+	 * @param \EE_Transaction $transaction
+	 * @param \EE_Ticket      $ticket
+	 * @param int             $quantity
+	 * @param \EE_Line_Item   $ticket_line_item
+	 * @return bool|int
+	 */
+	public function cancel(
+		\EE_Transaction $transaction,
+		\EE_Ticket $ticket,
+		$quantity = 1,
+		\EE_Line_Item $ticket_line_item = null
+	) {
+		$ticket_line_item = $ticket_line_item instanceof \EE_Line_Item
+			? $ticket_line_item
+			: $this->getTicketLineItem($transaction, $ticket);
+		// first we need to decrement the ticket quantity
+		\EEH_Line_Item::decrement_quantity($ticket_line_item, $quantity);
+		// no tickets left for this line item ?
+		if ((int) $ticket_line_item->quantity() === 0) {
+			// then just set this line item as cancelled, save, and get out
+			$ticket_line_item->set_type(\EEM_Line_Item::type_cancellation);
+			$success = $ticket_line_item->save();
+		} else {
+			// otherwise create a new cancelled line item, so that we have a record of the cancellation
+			$items_subtotal = \EEH_Line_Item::get_pre_tax_subtotal(
+				\EEH_Line_Item::get_event_line_item_for_ticket(
+					$transaction->total_line_item(),
+					$ticket
+				)
+			);
+			$cancelled_line_item = \EE_Line_Item::new_instance(
+				array(
+					'LIN_name'       => $ticket_line_item->name(),
+					'LIN_desc'       => sprintf(
+						__('%1$s Cancelled: %2$s', 'event_espresso'),
+						$ticket_line_item->desc(),
+						date('Y-m-d h:i a')
+					),
+					'LIN_unit_price' => (float) $ticket_line_item->unit_price(),
+					'LIN_quantity'   => $quantity,
+					'LIN_percent'    => null,
+					'LIN_is_taxable' => false,
+					'LIN_order'      => $items_subtotal instanceof \EE_Line_Item
+						? count($items_subtotal->children())
+						: 0,
+					'LIN_total'      => (float) $ticket_line_item->unit_price(),
+					'LIN_type'       => \EEM_Line_Item::type_cancellation,
+				)
+			);
+			$success = \EEH_Line_Item::add_item($transaction->total_line_item(), $cancelled_line_item);
+		}
+		if (! $success) {
+			throw new \RuntimeException(
+				sprintf(
+					__('An error occurred while attempting to cancel ticket line item %1$s', 'event_espresso'),
+					$ticket_line_item->ID()
+				)
+			);
+		}
+		return $success;
+	}
 
 
-    /**
-     * @param \EE_Transaction $transaction
-     * @param \EE_Ticket      $ticket
-     * @return \EE_Line_Item
-     * @throws EntityNotFoundException
-     * @throws \EE_Error
-     */
-    protected static function getTicketLineItem(\EE_Transaction $transaction, \EE_Ticket $ticket)
-    {
-        $line_item = null;
-        $ticket_line_items = \EEH_Line_Item::get_line_items_by_object_type_and_IDs(
-            $transaction->total_line_item(),
-            'Ticket',
-            array($ticket->ID())
-        );
-        foreach ($ticket_line_items as $ticket_line_item) {
-            if ($ticket_line_item instanceof \EE_Line_Item
-                && $ticket_line_item->OBJ_type() === 'Ticket'
-                && $ticket_line_item->OBJ_ID() === $ticket->ID()
-            ) {
-                $line_item = $ticket_line_item;
-                break;
-            }
-        }
-        if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
-            throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
-        }
-        return $line_item;
-    }
+	/**
+	 * @param \EE_Transaction $transaction
+	 * @param \EE_Ticket      $ticket
+	 * @return \EE_Line_Item
+	 * @throws EntityNotFoundException
+	 * @throws \EE_Error
+	 */
+	protected static function getTicketLineItem(\EE_Transaction $transaction, \EE_Ticket $ticket)
+	{
+		$line_item = null;
+		$ticket_line_items = \EEH_Line_Item::get_line_items_by_object_type_and_IDs(
+			$transaction->total_line_item(),
+			'Ticket',
+			array($ticket->ID())
+		);
+		foreach ($ticket_line_items as $ticket_line_item) {
+			if ($ticket_line_item instanceof \EE_Line_Item
+				&& $ticket_line_item->OBJ_type() === 'Ticket'
+				&& $ticket_line_item->OBJ_ID() === $ticket->ID()
+			) {
+				$line_item = $ticket_line_item;
+				break;
+			}
+		}
+		if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
+			throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
+		}
+		return $line_item;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -88,7 +88,7 @@ 
             );
             $success = \EEH_Line_Item::add_item($transaction->total_line_item(), $cancelled_line_item);
         }
-        if (! $success) {
+        if ( ! $success) {
             throw new \RuntimeException(
                 sprintf(
                     __('An error occurred while attempting to cancel ticket line item %1$s', 'event_espresso'),
@@ -124,7 +124,7 @@ 
                 break;
             }
         }
-        if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
+        if ( ! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
             throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
         }
         return $line_item;

core/domain/services/capabilities/CapabilitiesChecker.php

Indentation +72 added lines, -72 removed lines

@@ -18,84 +18,84 @@
 class CapabilitiesChecker implements CapabilitiesCheckerInterface
 {
 
-    /**
-     * @type EE_Capabilities $capabilities
-     */
-    private $capabilities;
+	/**
+	 * @type EE_Capabilities $capabilities
+	 */
+	private $capabilities;
 
 
-    /**
-     * CapabilitiesChecker constructor
-     *
-     * @param EE_Capabilities $capabilities
-     */
-    public function __construct(EE_Capabilities $capabilities)
-    {
-        $this->capabilities = $capabilities;
-    }
+	/**
+	 * CapabilitiesChecker constructor
+	 *
+	 * @param EE_Capabilities $capabilities
+	 */
+	public function __construct(EE_Capabilities $capabilities)
+	{
+		$this->capabilities = $capabilities;
+	}
 
 
-    /**
-     * @return EE_Capabilities
-     */
-    protected function capabilities()
-    {
-        return $this->capabilities;
-    }
+	/**
+	 * @return EE_Capabilities
+	 */
+	protected function capabilities()
+	{
+		return $this->capabilities;
+	}
 
 
-    /**
-     * Verifies that the current user has ALL of the capabilities listed in the CapCheck DTO.
-     * If any of the individual capability checks fails, then the command will NOT be executed.
-     *
-     * @param CapCheckInterface|CapCheckInterface[] $cap_check
-     * @return bool
-     * @throws InvalidClassException
-     * @throws InsufficientPermissionsException
-     */
-    public function processCapCheck($cap_check)
-    {
-        if (is_array($cap_check)) {
-            foreach ($cap_check as $check) {
-                $this->processCapCheck($check);
-            }
-            return true;
-        }
-        // at this point, $cap_check should be an individual instance of CapCheck
-        if (! $cap_check instanceof CapCheckInterface) {
-            throw new InvalidClassException(
-                '\EventEspresso\core\domain\services\capabilities\CapCheckInterface'
-            );
-        }
-        // sometimes cap checks are conditional, and no capabilities are required
-        if ($cap_check instanceof PublicCapabilities) {
-            return true;
-        }
-        $capabilities = (array) $cap_check->capability();
-        foreach ($capabilities as $capability) {
-            if (! $this->capabilities()->current_user_can(
-                $capability,
-                $cap_check->context(),
-                $cap_check->ID()
-            )) {
-                throw new InsufficientPermissionsException($cap_check->context());
-            }
-        }
-        return true;
-    }
+	/**
+	 * Verifies that the current user has ALL of the capabilities listed in the CapCheck DTO.
+	 * If any of the individual capability checks fails, then the command will NOT be executed.
+	 *
+	 * @param CapCheckInterface|CapCheckInterface[] $cap_check
+	 * @return bool
+	 * @throws InvalidClassException
+	 * @throws InsufficientPermissionsException
+	 */
+	public function processCapCheck($cap_check)
+	{
+		if (is_array($cap_check)) {
+			foreach ($cap_check as $check) {
+				$this->processCapCheck($check);
+			}
+			return true;
+		}
+		// at this point, $cap_check should be an individual instance of CapCheck
+		if (! $cap_check instanceof CapCheckInterface) {
+			throw new InvalidClassException(
+				'\EventEspresso\core\domain\services\capabilities\CapCheckInterface'
+			);
+		}
+		// sometimes cap checks are conditional, and no capabilities are required
+		if ($cap_check instanceof PublicCapabilities) {
+			return true;
+		}
+		$capabilities = (array) $cap_check->capability();
+		foreach ($capabilities as $capability) {
+			if (! $this->capabilities()->current_user_can(
+				$capability,
+				$cap_check->context(),
+				$cap_check->ID()
+			)) {
+				throw new InsufficientPermissionsException($cap_check->context());
+			}
+		}
+		return true;
+	}
 
 
-    /**
-     * @param string $capability - the capability to be checked, like: 'ee_edit_registrations'
-     * @param string $context    - what the user is attempting to do, like: 'Edit Registration'
-     * @param int    $ID         - (optional) ID for item where current_user_can is being called from
-     * @return bool
-     * @throws InvalidDataTypeException
-     * @throws InsufficientPermissionsException
-     * @throws InvalidClassException
-     */
-    public function process($capability, $context, $ID = 0)
-    {
-        return $this->processCapCheck(new CapCheck($capability, $context, $ID));
-    }
+	/**
+	 * @param string $capability - the capability to be checked, like: 'ee_edit_registrations'
+	 * @param string $context    - what the user is attempting to do, like: 'Edit Registration'
+	 * @param int    $ID         - (optional) ID for item where current_user_can is being called from
+	 * @return bool
+	 * @throws InvalidDataTypeException
+	 * @throws InsufficientPermissionsException
+	 * @throws InvalidClassException
+	 */
+	public function process($capability, $context, $ID = 0)
+	{
+		return $this->processCapCheck(new CapCheck($capability, $context, $ID));
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -62,7 +62,7 @@ 
             return true;
         }
         // at this point, $cap_check should be an individual instance of CapCheck
-        if (! $cap_check instanceof CapCheckInterface) {
+        if ( ! $cap_check instanceof CapCheckInterface) {
             throw new InvalidClassException(
                 '\EventEspresso\core\domain\services\capabilities\CapCheckInterface'
             );
@@ -73,7 +73,7 @@ 
         }
         $capabilities = (array) $cap_check->capability();
         foreach ($capabilities as $capability) {
-            if (! $this->capabilities()->current_user_can(
+            if ( ! $this->capabilities()->current_user_can(
                 $capability,
                 $cap_check->context(),
                 $cap_check->ID()