eventespresso / event-espresso-core

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

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
         );

Indentation +201 added lines, -201 removed lines

@@ -22,86 +22,86 @@ 
 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'));
-        }
-    }
-
-
-    /**
-     * 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'));
+		}
+	}
+
+
+	/**
+	 * 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>
@@ -114,125 +114,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 and it is disabled 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 not yet active on your site. For %1$smore info%2$s and to opt-in %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 and it is disabled 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 not yet active on your site. For %1$smore info%2$s and to opt-in %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;
+	}
 }

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()

core/domain/services/attendee/forms/AttendeeContactDetailsMetaboxFormHandler.php

Indentation +75 added lines, -75 removed lines

@@ -27,84 +27,84 @@
 {
 
 
-    protected $attendee;
+	protected $attendee;
 
 
-    /**
-     * AttendeeContactDetailsMetaboxFormHandler constructor.
-     *
-     * @param EE_Attendee $attendee
-     * @param EE_Registry $registry
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    public function __construct(EE_Attendee $attendee, EE_Registry $registry)
-    {
-        $this->attendee = $attendee;
-        $label = esc_html__('Contact Details', 'event_espresso');
-        parent::__construct(
-            $label,
-            $label,
-            'attendee_contact_details',
-            '',
-            FormHandler::DO_NOT_SETUP_FORM,
-            $registry
-        );
-    }
+	/**
+	 * AttendeeContactDetailsMetaboxFormHandler constructor.
+	 *
+	 * @param EE_Attendee $attendee
+	 * @param EE_Registry $registry
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct(EE_Attendee $attendee, EE_Registry $registry)
+	{
+		$this->attendee = $attendee;
+		$label = esc_html__('Contact Details', 'event_espresso');
+		parent::__construct(
+			$label,
+			$label,
+			'attendee_contact_details',
+			'',
+			FormHandler::DO_NOT_SETUP_FORM,
+			$registry
+		);
+	}
 
-    /**
-     * creates and returns the actual form
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    public function generate()
-    {
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => 'attendee_contact_details',
-                'html_id'         => 'attendee-contact-details',
-                'html_class'      => 'form-table',
-                'layout_strategy' => new EE_Admin_One_Column_Layout(),
-                'subsections'     => array(
-                    'ATT_email' => new EE_Email_Input(
-                        array(
-                            'default'         => $this->attendee->email(),
-                            'html_label_text' => esc_html__('Email Address', 'event_espresso'),
-                            'required'        => true,
-                        )
-                    ),
-                    'ATT_phone' => new EE_Text_Input(
-                        array(
-                            'default'         => $this->attendee->phone(),
-                            'html_label_text' => esc_html__('Phone Number', 'event_espresso'),
-                        )
-                    ),
-                ),
-            )
-        );
-    }
+	/**
+	 * creates and returns the actual form
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	public function generate()
+	{
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => 'attendee_contact_details',
+				'html_id'         => 'attendee-contact-details',
+				'html_class'      => 'form-table',
+				'layout_strategy' => new EE_Admin_One_Column_Layout(),
+				'subsections'     => array(
+					'ATT_email' => new EE_Email_Input(
+						array(
+							'default'         => $this->attendee->email(),
+							'html_label_text' => esc_html__('Email Address', 'event_espresso'),
+							'required'        => true,
+						)
+					),
+					'ATT_phone' => new EE_Text_Input(
+						array(
+							'default'         => $this->attendee->phone(),
+							'html_label_text' => esc_html__('Phone Number', 'event_espresso'),
+						)
+					),
+				),
+			)
+		);
+	}
 
 
-    /**
-     * Process form data.
-     *
-     * @param array $form_data
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidFormSubmissionException
-     * @throws LogicException
-     */
-    public function process($form_data = array())
-    {
-        $valid_data = (array) parent::process($form_data);
-        if (empty($valid_data)) {
-            return false;
-        }
-        $this->attendee->set_email($valid_data['ATT_email']);
-        $this->attendee->set_phone($valid_data['ATT_phone']);
-        $updated = $this->attendee->save();
-        return $updated !== false;
-    }
+	/**
+	 * Process form data.
+	 *
+	 * @param array $form_data
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidFormSubmissionException
+	 * @throws LogicException
+	 */
+	public function process($form_data = array())
+	{
+		$valid_data = (array) parent::process($form_data);
+		if (empty($valid_data)) {
+			return false;
+		}
+		$this->attendee->set_email($valid_data['ATT_email']);
+		$this->attendee->set_phone($valid_data['ATT_phone']);
+		$updated = $this->attendee->save();
+		return $updated !== false;
+	}
 }

core/domain/values/EmailAddress.php

Indentation +44 added lines, -44 removed lines

@@ -15,56 +15,56 @@
 class EmailAddress
 {
 
-    /**
-     * @var string $email_address
-     */
-    private $email_address;
+	/**
+	 * @var string $email_address
+	 */
+	private $email_address;
 
 
-    /**
-     * EmailAddress constructor.
-     *
-     * @param string                  $email_address
-     * @param EmailValidatorInterface $validator
-     * @throws EmailValidationException
-     */
-    public function __construct($email_address, EmailValidatorInterface $validator)
-    {
-        $validator->validate($email_address);
-        $this->email_address = $email_address;
-    }
+	/**
+	 * EmailAddress constructor.
+	 *
+	 * @param string                  $email_address
+	 * @param EmailValidatorInterface $validator
+	 * @throws EmailValidationException
+	 */
+	public function __construct($email_address, EmailValidatorInterface $validator)
+	{
+		$validator->validate($email_address);
+		$this->email_address = $email_address;
+	}
 
 
-    /**
-     * returns the string value for this EmailAddress
-     *
-     * @return string
-     */
-    public function get()
-    {
-        return $this->email_address;
-    }
+	/**
+	 * returns the string value for this EmailAddress
+	 *
+	 * @return string
+	 */
+	public function get()
+	{
+		return $this->email_address;
+	}
 
 
-    /**
-     * compare another EmailAddress to this one to determine if they are the same
-     *
-     * @param EmailAddress $address
-     * @return bool
-     */
-    public function equals(EmailAddress $address)
-    {
-        return strtolower((string) $this) === strtolower((string) $address);
-    }
+	/**
+	 * compare another EmailAddress to this one to determine if they are the same
+	 *
+	 * @param EmailAddress $address
+	 * @return bool
+	 */
+	public function equals(EmailAddress $address)
+	{
+		return strtolower((string) $this) === strtolower((string) $address);
+	}
 
 
-    /**
-     * allows an EmailAddress object to be used as a string
-     *
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->email_address;
-    }
+	/**
+	 * allows an EmailAddress object to be used as a string
+	 *
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->email_address;
+	}
 }

core/domain/values/model/CustomSelects.php

Indentation +335 added lines, -335 removed lines

@@ -17,339 +17,339 @@
  */
 class CustomSelects
 {
-    const TYPE_SIMPLE = 'simple';
-    const TYPE_COMPLEX = 'complex';
-    const TYPE_STRUCTURED = 'structured';
-
-    private $valid_operators = array('COUNT', 'SUM');
-
-
-    /**
-     * Original incoming select array
-     *
-     * @var array
-     */
-    private $original_selects;
-
-    /**
-     * Select string that can be added to the query
-     *
-     * @var string
-     */
-    private $columns_to_select_expression;
-
-
-    /**
-     * An array of aliases for the columns included in the incoming select array.
-     *
-     * @var array
-     */
-    private $column_aliases_in_select;
-
-
-    /**
-     * Enum representation of the "type" of array coming into this value object.
-     *
-     * @var string
-     */
-    private $type = '';
-
-
-    /**
-     * CustomSelects constructor.
-     * Incoming selects can be in one of the following formats:
-     * ---- self::TYPE_SIMPLE array ----
-     * This is considered the "simple" type. In this case the array is an numerically indexed array with single or
-     * multiple columns to select as the values.
-     * eg. array( 'ATT_ID', 'REG_ID' )
-     * eg. array( '*' )
-     * If you want to use the columns in any WHERE, GROUP BY, or HAVING clauses, you must instead use the "complex" or
-     * "structured" method.
-     * ---- self::TYPE_COMPLEX array ----
-     * This is considered the "complex" type.  In this case the array is indexed by arbitrary strings that serve as
-     * column alias, and the value is an numerically indexed array where there are two values.  The first value (0) is
-     * the selection and the second value (1) is the data type.  Data types must be one of the types defined in
-     * EEM_Base::$_valid_wpdb_data_types.
-     * eg. array( 'count' => array('count(REG_ID)', '%d') )
-     * Complex array configuration allows for using the column alias in any WHERE, GROUP BY, or HAVING clauses.
-     * ---- self::TYPE_STRUCTURED array ---
-     * This is considered the "structured" type. This type is similar to the complex type except that the array attached
-     * to the column alias contains three values.  The first value is the qualified column name (which can include
-     * join syntax for models).  The second value is the operator performed on the column (i.e. 'COUNT', 'SUM' etc).,
-     * the third value is the data type.  Note, if the select does not have an operator, you can use an empty string for
-     * the second value.
-     * Note: for now SUM is only for simple single column expressions (i.e. SUM(Transaction.TXN_total))
-     * eg. array( 'registration_count' => array('Registration.REG_ID', 'count', '%d') );
-     * NOTE: mixing array types in the incoming $select will cause errors.
-     *
-     * @param array $selects
-     * @throws InvalidArgumentException
-     */
-    public function __construct(array $selects)
-    {
-        $this->original_selects = $selects;
-        $this->deriveType($selects);
-        $this->deriveParts($selects);
-    }
-
-
-    /**
-     * Derives what type of custom select has been sent in.
-     *
-     * @param array $selects
-     * @throws InvalidArgumentException
-     */
-    private function deriveType(array $selects)
-    {
-        // first if the first key for this array is an integer then its coming in as a simple format, so we'll also
-        // ensure all elements of the array are simple.
-        if (is_int(key($selects))) {
-            // let's ensure all keys are ints
-            $invalid_keys = array_filter(
-                array_keys($selects),
-                function ($value) {
-                    return ! is_int($value);
-                }
-            );
-            if (! empty($invalid_keys)) {
-                throw new InvalidArgumentException(
-                    sprintf(
-                        esc_html__(
-                            'Incoming array looks like its formatted for "%1$s" type selects, however it has elements that are not indexed numerically',
-                            'event_espresso'
-                        ),
-                        self::TYPE_SIMPLE
-                    )
-                );
-            }
-            $this->type = self::TYPE_SIMPLE;
-            return;
-        }
-        // made it here so that means we've got either complex or structured selects.  Let's find out which by popping
-        // the first array element off.
-        $first_element = reset($selects);
-
-        if (! is_array($first_element)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'Incoming array looks like its formatted as a "%1$s" or "%2$s" type.  However, the values in the array must be arrays themselves and they are not.',
-                        'event_espresso'
-                    ),
-                    self::TYPE_COMPLEX,
-                    self::TYPE_STRUCTURED
-                )
-            );
-        }
-        $this->type = count($first_element) === 2
-            ? self::TYPE_COMPLEX
-            : self::TYPE_STRUCTURED;
-    }
-
-
-    /**
-     * Sets up the various properties for the vo depending on type.
-     *
-     * @param array $selects
-     * @throws InvalidArgumentException
-     */
-    private function deriveParts(array $selects)
-    {
-        $column_parts = array();
-        switch ($this->type) {
-            case self::TYPE_SIMPLE:
-                $column_parts = $selects;
-                $this->column_aliases_in_select = $selects;
-                break;
-            case self::TYPE_COMPLEX:
-                foreach ($selects as $alias => $parts) {
-                    $this->validateSelectValueForType($parts, $alias);
-                    $column_parts[] = "{$parts[0]} AS {$alias}";
-                    $this->column_aliases_in_select[] = $alias;
-                }
-                break;
-            case self::TYPE_STRUCTURED:
-                foreach ($selects as $alias => $parts) {
-                    $this->validateSelectValueForType($parts, $alias);
-                    $column_parts[] = $parts[1] !== ''
-                        ? $this->assembleSelectStringWithOperator($parts, $alias)
-                        : "{$parts[0]} AS {$alias}";
-                    $this->column_aliases_in_select[] = $alias;
-                }
-                break;
-        }
-        $this->columns_to_select_expression = implode(', ', $column_parts);
-    }
-
-
-    /**
-     * Validates self::TYPE_COMPLEX and self::TYPE_STRUCTURED select statement parts.
-     *
-     * @param array  $select_parts
-     * @param string $alias
-     * @throws InvalidArgumentException
-     */
-    private function validateSelectValueForType(array $select_parts, $alias)
-    {
-        $valid_data_types = array('%d', '%s', '%f');
-        if (count($select_parts) !== $this->expectedSelectPartCountForType()) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'The provided select part array for the %1$s column is expected to have a count of %2$d because the incoming select array is of type %3$s.  However the count was %4$d.',
-                        'event_espresso'
-                    ),
-                    $alias,
-                    $this->expectedSelectPartCountForType(),
-                    $this->type,
-                    count($select_parts)
-                )
-            );
-        }
-        // validate data type.
-        $data_type = $this->type === self::TYPE_COMPLEX ? $select_parts[1] : '';
-        $data_type = $this->type === self::TYPE_STRUCTURED ? $select_parts[2] : $data_type;
-
-        if (! in_array($data_type, $valid_data_types, true)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'Datatype %1$s (for selection "%2$s" and alias "%3$s") is not a valid wpdb datatype (eg %%s)',
-                        'event_espresso'
-                    ),
-                    $data_type,
-                    $select_parts[0],
-                    $alias,
-                    implode(', ', $valid_data_types)
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Each type will have an expected count of array elements, this returns what that expected count is.
-     *
-     * @param string $type
-     * @return int
-     */
-    private function expectedSelectPartCountForType($type = '')
-    {
-        $type = $type === '' ? $this->type : $type;
-        $types_count_map = array(
-            self::TYPE_COMPLEX    => 2,
-            self::TYPE_STRUCTURED => 3,
-        );
-        return isset($types_count_map[ $type ]) ? $types_count_map[ $type ] : 0;
-    }
-
-
-    /**
-     * Prepares the select statement part for for structured type selects.
-     *
-     * @param array  $select_parts
-     * @param string $alias
-     * @return string
-     * @throws InvalidArgumentException
-     */
-    private function assembleSelectStringWithOperator(array $select_parts, $alias)
-    {
-        $operator = strtoupper($select_parts[1]);
-        // validate operator
-        if (! in_array($operator, $this->valid_operators, true)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'An invalid operator has been provided (%1$s) for the column %2$s.  Valid operators must be one of the following: %3$s.',
-                        'event_espresso'
-                    ),
-                    $operator,
-                    $alias,
-                    implode(', ', $this->valid_operators)
-                )
-            );
-        }
-        return $operator . '(' . $select_parts[0] . ') AS ' . $alias;
-    }
-
-
-    /**
-     * Return the datatype from the given select part.
-     * Remember the select_part has already been validated on object instantiation.
-     *
-     * @param array $select_part
-     * @return string
-     */
-    private function getDataTypeForSelectType(array $select_part)
-    {
-        switch ($this->type) {
-            case self::TYPE_COMPLEX:
-                return $select_part[1];
-            case self::TYPE_STRUCTURED:
-                return $select_part[2];
-            default:
-                return '';
-        }
-    }
-
-
-    /**
-     * Returns the original select array sent into the VO.
-     *
-     * @return array
-     */
-    public function originalSelects()
-    {
-        return $this->original_selects;
-    }
-
-
-    /**
-     * Returns the final assembled select expression derived from the incoming select array.
-     *
-     * @return string
-     */
-    public function columnsToSelectExpression()
-    {
-        return $this->columns_to_select_expression;
-    }
-
-
-    /**
-     * Returns all the column aliases derived from the incoming select array.
-     *
-     * @return array
-     */
-    public function columnAliases()
-    {
-        return $this->column_aliases_in_select;
-    }
-
-
-    /**
-     * Returns the enum type for the incoming select array.
-     *
-     * @return string
-     */
-    public function type()
-    {
-        return $this->type;
-    }
-
-
-    /**
-     * Return the datatype for the given column_alias
-     *
-     * @param string $column_alias
-     * @return string  (if there's no data type we return string as the default).
-     */
-    public function getDataTypeForAlias($column_alias)
-    {
-        if (isset($this->original_selects[ $column_alias ])
-            && in_array($column_alias, $this->columnAliases(), true)
-        ) {
-            return $this->getDataTypeForSelectType($this->original_selects[ $column_alias ]);
-        }
-        return '%s';
-    }
+	const TYPE_SIMPLE = 'simple';
+	const TYPE_COMPLEX = 'complex';
+	const TYPE_STRUCTURED = 'structured';
+
+	private $valid_operators = array('COUNT', 'SUM');
+
+
+	/**
+	 * Original incoming select array
+	 *
+	 * @var array
+	 */
+	private $original_selects;
+
+	/**
+	 * Select string that can be added to the query
+	 *
+	 * @var string
+	 */
+	private $columns_to_select_expression;
+
+
+	/**
+	 * An array of aliases for the columns included in the incoming select array.
+	 *
+	 * @var array
+	 */
+	private $column_aliases_in_select;
+
+
+	/**
+	 * Enum representation of the "type" of array coming into this value object.
+	 *
+	 * @var string
+	 */
+	private $type = '';
+
+
+	/**
+	 * CustomSelects constructor.
+	 * Incoming selects can be in one of the following formats:
+	 * ---- self::TYPE_SIMPLE array ----
+	 * This is considered the "simple" type. In this case the array is an numerically indexed array with single or
+	 * multiple columns to select as the values.
+	 * eg. array( 'ATT_ID', 'REG_ID' )
+	 * eg. array( '*' )
+	 * If you want to use the columns in any WHERE, GROUP BY, or HAVING clauses, you must instead use the "complex" or
+	 * "structured" method.
+	 * ---- self::TYPE_COMPLEX array ----
+	 * This is considered the "complex" type.  In this case the array is indexed by arbitrary strings that serve as
+	 * column alias, and the value is an numerically indexed array where there are two values.  The first value (0) is
+	 * the selection and the second value (1) is the data type.  Data types must be one of the types defined in
+	 * EEM_Base::$_valid_wpdb_data_types.
+	 * eg. array( 'count' => array('count(REG_ID)', '%d') )
+	 * Complex array configuration allows for using the column alias in any WHERE, GROUP BY, or HAVING clauses.
+	 * ---- self::TYPE_STRUCTURED array ---
+	 * This is considered the "structured" type. This type is similar to the complex type except that the array attached
+	 * to the column alias contains three values.  The first value is the qualified column name (which can include
+	 * join syntax for models).  The second value is the operator performed on the column (i.e. 'COUNT', 'SUM' etc).,
+	 * the third value is the data type.  Note, if the select does not have an operator, you can use an empty string for
+	 * the second value.
+	 * Note: for now SUM is only for simple single column expressions (i.e. SUM(Transaction.TXN_total))
+	 * eg. array( 'registration_count' => array('Registration.REG_ID', 'count', '%d') );
+	 * NOTE: mixing array types in the incoming $select will cause errors.
+	 *
+	 * @param array $selects
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct(array $selects)
+	{
+		$this->original_selects = $selects;
+		$this->deriveType($selects);
+		$this->deriveParts($selects);
+	}
+
+
+	/**
+	 * Derives what type of custom select has been sent in.
+	 *
+	 * @param array $selects
+	 * @throws InvalidArgumentException
+	 */
+	private function deriveType(array $selects)
+	{
+		// first if the first key for this array is an integer then its coming in as a simple format, so we'll also
+		// ensure all elements of the array are simple.
+		if (is_int(key($selects))) {
+			// let's ensure all keys are ints
+			$invalid_keys = array_filter(
+				array_keys($selects),
+				function ($value) {
+					return ! is_int($value);
+				}
+			);
+			if (! empty($invalid_keys)) {
+				throw new InvalidArgumentException(
+					sprintf(
+						esc_html__(
+							'Incoming array looks like its formatted for "%1$s" type selects, however it has elements that are not indexed numerically',
+							'event_espresso'
+						),
+						self::TYPE_SIMPLE
+					)
+				);
+			}
+			$this->type = self::TYPE_SIMPLE;
+			return;
+		}
+		// made it here so that means we've got either complex or structured selects.  Let's find out which by popping
+		// the first array element off.
+		$first_element = reset($selects);
+
+		if (! is_array($first_element)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'Incoming array looks like its formatted as a "%1$s" or "%2$s" type.  However, the values in the array must be arrays themselves and they are not.',
+						'event_espresso'
+					),
+					self::TYPE_COMPLEX,
+					self::TYPE_STRUCTURED
+				)
+			);
+		}
+		$this->type = count($first_element) === 2
+			? self::TYPE_COMPLEX
+			: self::TYPE_STRUCTURED;
+	}
+
+
+	/**
+	 * Sets up the various properties for the vo depending on type.
+	 *
+	 * @param array $selects
+	 * @throws InvalidArgumentException
+	 */
+	private function deriveParts(array $selects)
+	{
+		$column_parts = array();
+		switch ($this->type) {
+			case self::TYPE_SIMPLE:
+				$column_parts = $selects;
+				$this->column_aliases_in_select = $selects;
+				break;
+			case self::TYPE_COMPLEX:
+				foreach ($selects as $alias => $parts) {
+					$this->validateSelectValueForType($parts, $alias);
+					$column_parts[] = "{$parts[0]} AS {$alias}";
+					$this->column_aliases_in_select[] = $alias;
+				}
+				break;
+			case self::TYPE_STRUCTURED:
+				foreach ($selects as $alias => $parts) {
+					$this->validateSelectValueForType($parts, $alias);
+					$column_parts[] = $parts[1] !== ''
+						? $this->assembleSelectStringWithOperator($parts, $alias)
+						: "{$parts[0]} AS {$alias}";
+					$this->column_aliases_in_select[] = $alias;
+				}
+				break;
+		}
+		$this->columns_to_select_expression = implode(', ', $column_parts);
+	}
+
+
+	/**
+	 * Validates self::TYPE_COMPLEX and self::TYPE_STRUCTURED select statement parts.
+	 *
+	 * @param array  $select_parts
+	 * @param string $alias
+	 * @throws InvalidArgumentException
+	 */
+	private function validateSelectValueForType(array $select_parts, $alias)
+	{
+		$valid_data_types = array('%d', '%s', '%f');
+		if (count($select_parts) !== $this->expectedSelectPartCountForType()) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'The provided select part array for the %1$s column is expected to have a count of %2$d because the incoming select array is of type %3$s.  However the count was %4$d.',
+						'event_espresso'
+					),
+					$alias,
+					$this->expectedSelectPartCountForType(),
+					$this->type,
+					count($select_parts)
+				)
+			);
+		}
+		// validate data type.
+		$data_type = $this->type === self::TYPE_COMPLEX ? $select_parts[1] : '';
+		$data_type = $this->type === self::TYPE_STRUCTURED ? $select_parts[2] : $data_type;
+
+		if (! in_array($data_type, $valid_data_types, true)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'Datatype %1$s (for selection "%2$s" and alias "%3$s") is not a valid wpdb datatype (eg %%s)',
+						'event_espresso'
+					),
+					$data_type,
+					$select_parts[0],
+					$alias,
+					implode(', ', $valid_data_types)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Each type will have an expected count of array elements, this returns what that expected count is.
+	 *
+	 * @param string $type
+	 * @return int
+	 */
+	private function expectedSelectPartCountForType($type = '')
+	{
+		$type = $type === '' ? $this->type : $type;
+		$types_count_map = array(
+			self::TYPE_COMPLEX    => 2,
+			self::TYPE_STRUCTURED => 3,
+		);
+		return isset($types_count_map[ $type ]) ? $types_count_map[ $type ] : 0;
+	}
+
+
+	/**
+	 * Prepares the select statement part for for structured type selects.
+	 *
+	 * @param array  $select_parts
+	 * @param string $alias
+	 * @return string
+	 * @throws InvalidArgumentException
+	 */
+	private function assembleSelectStringWithOperator(array $select_parts, $alias)
+	{
+		$operator = strtoupper($select_parts[1]);
+		// validate operator
+		if (! in_array($operator, $this->valid_operators, true)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'An invalid operator has been provided (%1$s) for the column %2$s.  Valid operators must be one of the following: %3$s.',
+						'event_espresso'
+					),
+					$operator,
+					$alias,
+					implode(', ', $this->valid_operators)
+				)
+			);
+		}
+		return $operator . '(' . $select_parts[0] . ') AS ' . $alias;
+	}
+
+
+	/**
+	 * Return the datatype from the given select part.
+	 * Remember the select_part has already been validated on object instantiation.
+	 *
+	 * @param array $select_part
+	 * @return string
+	 */
+	private function getDataTypeForSelectType(array $select_part)
+	{
+		switch ($this->type) {
+			case self::TYPE_COMPLEX:
+				return $select_part[1];
+			case self::TYPE_STRUCTURED:
+				return $select_part[2];
+			default:
+				return '';
+		}
+	}
+
+
+	/**
+	 * Returns the original select array sent into the VO.
+	 *
+	 * @return array
+	 */
+	public function originalSelects()
+	{
+		return $this->original_selects;
+	}
+
+
+	/**
+	 * Returns the final assembled select expression derived from the incoming select array.
+	 *
+	 * @return string
+	 */
+	public function columnsToSelectExpression()
+	{
+		return $this->columns_to_select_expression;
+	}
+
+
+	/**
+	 * Returns all the column aliases derived from the incoming select array.
+	 *
+	 * @return array
+	 */
+	public function columnAliases()
+	{
+		return $this->column_aliases_in_select;
+	}
+
+
+	/**
+	 * Returns the enum type for the incoming select array.
+	 *
+	 * @return string
+	 */
+	public function type()
+	{
+		return $this->type;
+	}
+
+
+	/**
+	 * Return the datatype for the given column_alias
+	 *
+	 * @param string $column_alias
+	 * @return string  (if there's no data type we return string as the default).
+	 */
+	public function getDataTypeForAlias($column_alias)
+	{
+		if (isset($this->original_selects[ $column_alias ])
+			&& in_array($column_alias, $this->columnAliases(), true)
+		) {
+			return $this->getDataTypeForSelectType($this->original_selects[ $column_alias ]);
+		}
+		return '%s';
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -107,11 +107,11 @@ 
             // let's ensure all keys are ints
             $invalid_keys = array_filter(
                 array_keys($selects),
-                function ($value) {
+                function($value) {
                     return ! is_int($value);
                 }
             );
-            if (! empty($invalid_keys)) {
+            if ( ! empty($invalid_keys)) {
                 throw new InvalidArgumentException(
                     sprintf(
                         esc_html__(
@@ -129,7 +129,7 @@ 
         // the first array element off.
         $first_element = reset($selects);
 
-        if (! is_array($first_element)) {
+        if ( ! is_array($first_element)) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__(
@@ -210,7 +210,7 @@ 
         $data_type = $this->type === self::TYPE_COMPLEX ? $select_parts[1] : '';
         $data_type = $this->type === self::TYPE_STRUCTURED ? $select_parts[2] : $data_type;
 
-        if (! in_array($data_type, $valid_data_types, true)) {
+        if ( ! in_array($data_type, $valid_data_types, true)) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__(
@@ -240,7 +240,7 @@ 
             self::TYPE_COMPLEX    => 2,
             self::TYPE_STRUCTURED => 3,
         );
-        return isset($types_count_map[ $type ]) ? $types_count_map[ $type ] : 0;
+        return isset($types_count_map[$type]) ? $types_count_map[$type] : 0;
     }
 
 
@@ -256,7 +256,7 @@ 
     {
         $operator = strtoupper($select_parts[1]);
         // validate operator
-        if (! in_array($operator, $this->valid_operators, true)) {
+        if ( ! in_array($operator, $this->valid_operators, true)) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__(
@@ -269,7 +269,7 @@ 
                 )
             );
         }
-        return $operator . '(' . $select_parts[0] . ') AS ' . $alias;
+        return $operator.'('.$select_parts[0].') AS '.$alias;
     }
 
 
@@ -345,10 +345,10 @@ 
      */
     public function getDataTypeForAlias($column_alias)
     {
-        if (isset($this->original_selects[ $column_alias ])
+        if (isset($this->original_selects[$column_alias])
             && in_array($column_alias, $this->columnAliases(), true)
         ) {
-            return $this->getDataTypeForSelectType($this->original_selects[ $column_alias ]);
+            return $this->getDataTypeForSelectType($this->original_selects[$column_alias]);
         }
         return '%s';
     }

core/services/loaders/LoaderFactory.php

Indentation +38 added lines, -38 removed lines

@@ -70,44 +70,44 @@
 class LoaderFactory
 {
 
-    /**
-     * @var LoaderInterface $loader ;
-     */
-    private static $loader;
+	/**
+	 * @var LoaderInterface $loader ;
+	 */
+	private static $loader;
 
 
-    /**
-     * @param EE_Registry|CoffeeShop   $generator   provided during very first instantiation in
-     *                                              BootstrapDependencyInjectionContainer::buildLoader()
-     *                                              otherwise can be left null
-     * @param ClassInterfaceCache|null $class_cache also provided during first instantiation
-     * @param ObjectIdentifier|null    $object_identifier
-     * @return LoaderInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function getLoader(
-        $generator = null,
-        ClassInterfaceCache $class_cache = null,
-        ObjectIdentifier $object_identifier = null
-    ) {
-        if (! LoaderFactory::$loader instanceof LoaderInterface
-            && ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)
-            && $class_cache instanceof ClassInterfaceCache
-            && $object_identifier instanceof ObjectIdentifier
-        ) {
-            $core_loader = new CoreLoader($generator);
-            LoaderFactory::$loader = new Loader(
-                $core_loader,
-                new CachingLoader(
-                    $core_loader,
-                    new LooseCollection(''),
-                    $object_identifier
-                ),
-                $class_cache
-            );
-        }
-        return LoaderFactory::$loader;
-    }
+	/**
+	 * @param EE_Registry|CoffeeShop   $generator   provided during very first instantiation in
+	 *                                              BootstrapDependencyInjectionContainer::buildLoader()
+	 *                                              otherwise can be left null
+	 * @param ClassInterfaceCache|null $class_cache also provided during first instantiation
+	 * @param ObjectIdentifier|null    $object_identifier
+	 * @return LoaderInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function getLoader(
+		$generator = null,
+		ClassInterfaceCache $class_cache = null,
+		ObjectIdentifier $object_identifier = null
+	) {
+		if (! LoaderFactory::$loader instanceof LoaderInterface
+			&& ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)
+			&& $class_cache instanceof ClassInterfaceCache
+			&& $object_identifier instanceof ObjectIdentifier
+		) {
+			$core_loader = new CoreLoader($generator);
+			LoaderFactory::$loader = new Loader(
+				$core_loader,
+				new CachingLoader(
+					$core_loader,
+					new LooseCollection(''),
+					$object_identifier
+				),
+				$class_cache
+			);
+		}
+		return LoaderFactory::$loader;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -92,7 +92,7 @@
         ClassInterfaceCache $class_cache = null,
         ObjectIdentifier $object_identifier = null
     ) {
-        if (! LoaderFactory::$loader instanceof LoaderInterface
+        if ( ! LoaderFactory::$loader instanceof LoaderInterface
             && ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)
             && $class_cache instanceof ClassInterfaceCache
             && $object_identifier instanceof ObjectIdentifier

core/services/collections/CollectionLoader.php

Doc Comments +1 added lines, -1 removed lines

@@ -163,7 +163,7 @@
 
     /**
      * @param        $entity
-     * @param  mixed $identifier
+     * @param  string $identifier
      * @return string
      * @throws InvalidEntityException
      */

Spacing +8 added lines, -8 removed lines

@@ -84,7 +84,7 @@ 
         LocatorInterface $file_locator = null
     ) {
         $this->collection_details = $collection_details;
-        if (! $collection instanceof CollectionInterface) {
+        if ( ! $collection instanceof CollectionInterface) {
             $collection = new Collection($this->collection_details->getCollectionInterface());
         }
         $this->collection = $collection;
@@ -111,7 +111,7 @@ 
      */
     protected function loadAllFromFilepaths()
     {
-        if (! $this->file_locator instanceof FileLocator) {
+        if ( ! $this->file_locator instanceof FileLocator) {
             $this->file_locator = new FileLocator();
         }
         $this->file_locator->setFileMask($this->collection_details->getFileMask());
@@ -143,10 +143,10 @@ 
      */
     protected function loadClassFromFilepath($filepath)
     {
-        if (! is_string($filepath)) {
+        if ( ! is_string($filepath)) {
             throw new InvalidDataTypeException('$filepath', $filepath, 'string');
         }
-        if (! is_readable($filepath)) {
+        if ( ! is_readable($filepath)) {
             throw new InvalidFilePathException($filepath);
         }
         require_once $filepath;
@@ -154,7 +154,7 @@ 
         $file_name = basename($filepath);
         // now remove any file extensions
         $class_name = EEH_File::get_classname_from_filepath_with_standard_filename($file_name);
-        if (! class_exists($class_name)) {
+        if ( ! class_exists($class_name)) {
             throw new InvalidClassException($class_name);
         }
         return $this->addEntityToCollection(new $class_name(), $file_name);
@@ -224,7 +224,7 @@ 
             // objects added to the collection based on entity callback, so the entity itself decides
             case CollectionDetails::ID_CALLBACK_METHOD:
                 $identifier_callback = $this->collection_details->identifierCallback();
-                if (! method_exists($entity, $identifier_callback)) {
+                if ( ! method_exists($entity, $identifier_callback)) {
                     throw new InvalidEntityException(
                         $entity,
                         $this->collection_details->getCollectionInterface(),
@@ -288,10 +288,10 @@ 
      */
     protected function loadClassFromFQCN($FQCN)
     {
-        if (! is_string($FQCN)) {
+        if ( ! is_string($FQCN)) {
             throw new InvalidDataTypeException('$FQCN', $FQCN, 'string');
         }
-        if (! class_exists($FQCN)) {
+        if ( ! class_exists($FQCN)) {
             throw new InvalidClassException($FQCN);
         }
         return $this->addEntityToCollection(

Indentation +249 added lines, -249 removed lines

@@ -27,276 +27,276 @@
 class CollectionLoader
 {
 
-    /**
-     * possible return value when adding entities to a collection.
-     * denotes that the entity was NOT ADDED to the collection
-     */
-    const ENTITY_NOT_ADDED = 'entity-not-added-to-collection';
+	/**
+	 * possible return value when adding entities to a collection.
+	 * denotes that the entity was NOT ADDED to the collection
+	 */
+	const ENTITY_NOT_ADDED = 'entity-not-added-to-collection';
 
-    /**
-     * possible return value when adding entities to a collection.
-     * denotes that the entity was SUCCESSFULLY ADDED to the collection
-     */
-    const ENTITY_ADDED = 'entity-added-to-collection';
+	/**
+	 * possible return value when adding entities to a collection.
+	 * denotes that the entity was SUCCESSFULLY ADDED to the collection
+	 */
+	const ENTITY_ADDED = 'entity-added-to-collection';
 
-    /**
-     * possible return value when adding entities to a collection.
-     * denotes that the entity was ALREADY ADDED to the collection,
-     * and therefore could not be added again.
-     */
-    const ENTITY_EXISTS = 'entity-already-in-collection';
+	/**
+	 * possible return value when adding entities to a collection.
+	 * denotes that the entity was ALREADY ADDED to the collection,
+	 * and therefore could not be added again.
+	 */
+	const ENTITY_EXISTS = 'entity-already-in-collection';
 
 
-    /**
-     * @var CollectionDetailsInterface $collection_details
-     */
-    protected $collection_details;
+	/**
+	 * @var CollectionDetailsInterface $collection_details
+	 */
+	protected $collection_details;
 
-    /**
-     * @var CollectionInterface $collection
-     */
-    protected $collection;
+	/**
+	 * @var CollectionInterface $collection
+	 */
+	protected $collection;
 
-    /**
-     * @var FileLocator $file_locator
-     */
-    protected $file_locator;
+	/**
+	 * @var FileLocator $file_locator
+	 */
+	protected $file_locator;
 
 
-    /**
-     * CollectionLoader constructor.
-     *
-     * @param CollectionDetailsInterface $collection_details
-     * @param CollectionInterface        $collection
-     * @param LocatorInterface           $file_locator
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws EE_Error
-     * @throws InvalidInterfaceException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidFilePathException
-     * @throws InvalidEntityException
-     */
-    public function __construct(
-        CollectionDetailsInterface $collection_details,
-        CollectionInterface $collection = null,
-        LocatorInterface $file_locator = null
-    ) {
-        $this->collection_details = $collection_details;
-        if (! $collection instanceof CollectionInterface) {
-            $collection = new Collection($this->collection_details->getCollectionInterface());
-        }
-        $this->collection = $collection;
-        $this->file_locator = $file_locator;
-        $this->loadAllFromFilepaths();
-        $this->loadFromFQCNs();
-    }
+	/**
+	 * CollectionLoader constructor.
+	 *
+	 * @param CollectionDetailsInterface $collection_details
+	 * @param CollectionInterface        $collection
+	 * @param LocatorInterface           $file_locator
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws EE_Error
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidEntityException
+	 */
+	public function __construct(
+		CollectionDetailsInterface $collection_details,
+		CollectionInterface $collection = null,
+		LocatorInterface $file_locator = null
+	) {
+		$this->collection_details = $collection_details;
+		if (! $collection instanceof CollectionInterface) {
+			$collection = new Collection($this->collection_details->getCollectionInterface());
+		}
+		$this->collection = $collection;
+		$this->file_locator = $file_locator;
+		$this->loadAllFromFilepaths();
+		$this->loadFromFQCNs();
+	}
 
 
-    /**
-     * @return CollectionInterface
-     */
-    public function getCollection()
-    {
-        return $this->collection;
-    }
+	/**
+	 * @return CollectionInterface
+	 */
+	public function getCollection()
+	{
+		return $this->collection;
+	}
 
 
-    /**
-     * @throws InvalidClassException
-     * @throws InvalidFilePathException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     */
-    protected function loadAllFromFilepaths()
-    {
-        if (! $this->file_locator instanceof FileLocator) {
-            $this->file_locator = new FileLocator();
-        }
-        $this->file_locator->setFileMask($this->collection_details->getFileMask());
-        // find all of the files that match the file mask in the specified folder
-        $this->file_locator->locate($this->collection_details->getCollectionPaths());
-        // filter the results
-        $filepaths = (array) apply_filters(
-            'FHEE__CollectionLoader__loadAllFromFilepath__filepaths',
-            $this->file_locator->getFilePaths(),
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-        if (empty($filepaths)) {
-            return;
-        }
-        foreach ($filepaths as $filepath) {
-            $this->loadClassFromFilepath($filepath);
-        }
-    }
+	/**
+	 * @throws InvalidClassException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 */
+	protected function loadAllFromFilepaths()
+	{
+		if (! $this->file_locator instanceof FileLocator) {
+			$this->file_locator = new FileLocator();
+		}
+		$this->file_locator->setFileMask($this->collection_details->getFileMask());
+		// find all of the files that match the file mask in the specified folder
+		$this->file_locator->locate($this->collection_details->getCollectionPaths());
+		// filter the results
+		$filepaths = (array) apply_filters(
+			'FHEE__CollectionLoader__loadAllFromFilepath__filepaths',
+			$this->file_locator->getFilePaths(),
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+		if (empty($filepaths)) {
+			return;
+		}
+		foreach ($filepaths as $filepath) {
+			$this->loadClassFromFilepath($filepath);
+		}
+	}
 
 
-    /**
-     * @param  string $filepath
-     * @return string
-     * @throws InvalidEntityException
-     * @throws InvalidDataTypeException
-     * @throws InvalidFilePathException
-     * @throws InvalidClassException
-     */
-    protected function loadClassFromFilepath($filepath)
-    {
-        if (! is_string($filepath)) {
-            throw new InvalidDataTypeException('$filepath', $filepath, 'string');
-        }
-        if (! is_readable($filepath)) {
-            throw new InvalidFilePathException($filepath);
-        }
-        require_once $filepath;
-        // extract filename from path
-        $file_name = basename($filepath);
-        // now remove any file extensions
-        $class_name = EEH_File::get_classname_from_filepath_with_standard_filename($file_name);
-        if (! class_exists($class_name)) {
-            throw new InvalidClassException($class_name);
-        }
-        return $this->addEntityToCollection(new $class_name(), $file_name);
-    }
+	/**
+	 * @param  string $filepath
+	 * @return string
+	 * @throws InvalidEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidClassException
+	 */
+	protected function loadClassFromFilepath($filepath)
+	{
+		if (! is_string($filepath)) {
+			throw new InvalidDataTypeException('$filepath', $filepath, 'string');
+		}
+		if (! is_readable($filepath)) {
+			throw new InvalidFilePathException($filepath);
+		}
+		require_once $filepath;
+		// extract filename from path
+		$file_name = basename($filepath);
+		// now remove any file extensions
+		$class_name = EEH_File::get_classname_from_filepath_with_standard_filename($file_name);
+		if (! class_exists($class_name)) {
+			throw new InvalidClassException($class_name);
+		}
+		return $this->addEntityToCollection(new $class_name(), $file_name);
+	}
 
 
-    /**
-     * @param        $entity
-     * @param  mixed $identifier
-     * @return string
-     * @throws InvalidEntityException
-     */
-    protected function addEntityToCollection($entity, $identifier)
-    {
-        do_action(
-            'FHEE__CollectionLoader__addEntityToCollection__entity',
-            $entity,
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-        $identifier = $this->setIdentifier($entity, $identifier);
-        if ($this->collection->has($identifier)) {
-            do_action(
-                'FHEE__CollectionLoader__addEntityToCollection__entity_already_added',
-                $this,
-                $this->collection_details->collectionName(),
-                $this->collection_details
-            );
-            return CollectionLoader::ENTITY_EXISTS;
-        }
-        if ($this->collection->add($entity, $identifier)) {
-            do_action(
-                'FHEE__CollectionLoader__addEntityToCollection__entity_added',
-                $this,
-                $this->collection_details->collectionName(),
-                $this->collection_details
-            );
-            return CollectionLoader::ENTITY_ADDED;
-        }
-        do_action(
-            'FHEE__CollectionLoader__addEntityToCollection__entity_not_added',
-            $this,
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-        return CollectionLoader::ENTITY_NOT_ADDED;
-    }
+	/**
+	 * @param        $entity
+	 * @param  mixed $identifier
+	 * @return string
+	 * @throws InvalidEntityException
+	 */
+	protected function addEntityToCollection($entity, $identifier)
+	{
+		do_action(
+			'FHEE__CollectionLoader__addEntityToCollection__entity',
+			$entity,
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+		$identifier = $this->setIdentifier($entity, $identifier);
+		if ($this->collection->has($identifier)) {
+			do_action(
+				'FHEE__CollectionLoader__addEntityToCollection__entity_already_added',
+				$this,
+				$this->collection_details->collectionName(),
+				$this->collection_details
+			);
+			return CollectionLoader::ENTITY_EXISTS;
+		}
+		if ($this->collection->add($entity, $identifier)) {
+			do_action(
+				'FHEE__CollectionLoader__addEntityToCollection__entity_added',
+				$this,
+				$this->collection_details->collectionName(),
+				$this->collection_details
+			);
+			return CollectionLoader::ENTITY_ADDED;
+		}
+		do_action(
+			'FHEE__CollectionLoader__addEntityToCollection__entity_not_added',
+			$this,
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+		return CollectionLoader::ENTITY_NOT_ADDED;
+	}
 
 
-    /**
-     * @param        $entity
-     * @param  mixed $identifier
-     * @return string
-     * @throws InvalidEntityException
-     */
-    protected function setIdentifier($entity, $identifier)
-    {
-        switch ($this->collection_details->identifierType()) {
-            // every unique object gets added to the collection, but not duplicates of the exact same object
-            case CollectionDetails::ID_OBJECT_HASH:
-                $identifier = spl_object_hash($entity);
-                break;
-            // only one entity per class can be added to collection, like a singleton
-            case CollectionDetails::ID_CLASS_NAME:
-                $identifier = get_class($entity);
-                break;
-            // objects added to the collection based on entity callback, so the entity itself decides
-            case CollectionDetails::ID_CALLBACK_METHOD:
-                $identifier_callback = $this->collection_details->identifierCallback();
-                if (! method_exists($entity, $identifier_callback)) {
-                    throw new InvalidEntityException(
-                        $entity,
-                        $this->collection_details->getCollectionInterface(),
-                        sprintf(
-                            __(
-                                'The current collection is configured to use a method named "%1$s" when setting or retrieving objects. The supplied entity is an instance
+	/**
+	 * @param        $entity
+	 * @param  mixed $identifier
+	 * @return string
+	 * @throws InvalidEntityException
+	 */
+	protected function setIdentifier($entity, $identifier)
+	{
+		switch ($this->collection_details->identifierType()) {
+			// every unique object gets added to the collection, but not duplicates of the exact same object
+			case CollectionDetails::ID_OBJECT_HASH:
+				$identifier = spl_object_hash($entity);
+				break;
+			// only one entity per class can be added to collection, like a singleton
+			case CollectionDetails::ID_CLASS_NAME:
+				$identifier = get_class($entity);
+				break;
+			// objects added to the collection based on entity callback, so the entity itself decides
+			case CollectionDetails::ID_CALLBACK_METHOD:
+				$identifier_callback = $this->collection_details->identifierCallback();
+				if (! method_exists($entity, $identifier_callback)) {
+					throw new InvalidEntityException(
+						$entity,
+						$this->collection_details->getCollectionInterface(),
+						sprintf(
+							__(
+								'The current collection is configured to use a method named "%1$s" when setting or retrieving objects. The supplied entity is an instance
                                 of "%2$s", but does not contain this method.',
-                                'event_espresso'
-                            ),
-                            $identifier_callback,
-                            get_class($entity)
-                        )
-                    );
-                }
-                $identifier = $entity->{$identifier_callback}();
-                break;
-        }
-        return apply_filters(
-            'FHEE__CollectionLoader__addEntityToCollection__identifier',
-            $identifier,
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-    }
+								'event_espresso'
+							),
+							$identifier_callback,
+							get_class($entity)
+						)
+					);
+				}
+				$identifier = $entity->{$identifier_callback}();
+				break;
+		}
+		return apply_filters(
+			'FHEE__CollectionLoader__addEntityToCollection__identifier',
+			$identifier,
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+	}
 
 
-    /**
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws EE_Error
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     */
-    protected function loadFromFQCNs()
-    {
-        $FQCNs = $this->collection_details->getCollectionFQCNs();
-        $FQCNs = (array) apply_filters(
-            'FHEE__CollectionLoader__loadAllFromFQCNs__FQCNs',
-            $FQCNs,
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-        foreach ($FQCNs as $FQCN) {
-            $this->loadClassFromFQCN($FQCN);
-        }
-    }
+	/**
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws EE_Error
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 */
+	protected function loadFromFQCNs()
+	{
+		$FQCNs = $this->collection_details->getCollectionFQCNs();
+		$FQCNs = (array) apply_filters(
+			'FHEE__CollectionLoader__loadAllFromFQCNs__FQCNs',
+			$FQCNs,
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+		foreach ($FQCNs as $FQCN) {
+			$this->loadClassFromFQCN($FQCN);
+		}
+	}
 
 
-    /**
-     * @param  string $FQCN Fully Qualified Class Name
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws EE_Error
-     * @throws InvalidEntityException
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     */
-    protected function loadClassFromFQCN($FQCN)
-    {
-        if (! is_string($FQCN)) {
-            throw new InvalidDataTypeException('$FQCN', $FQCN, 'string');
-        }
-        if (! class_exists($FQCN)) {
-            throw new InvalidClassException($FQCN);
-        }
-        return $this->addEntityToCollection(
-            EE_Registry::instance()->create($FQCN),
-            $FQCN
-        );
-    }
+	/**
+	 * @param  string $FQCN Fully Qualified Class Name
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 * @throws InvalidEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 */
+	protected function loadClassFromFQCN($FQCN)
+	{
+		if (! is_string($FQCN)) {
+			throw new InvalidDataTypeException('$FQCN', $FQCN, 'string');
+		}
+		if (! class_exists($FQCN)) {
+			throw new InvalidClassException($FQCN);
+		}
+		return $this->addEntityToCollection(
+			EE_Registry::instance()->create($FQCN),
+			$FQCN
+		);
+	}
 }