eventespresso / event-espresso-core

caffeinated/admin/extend/registrations/EE_Event_Registrations_List_Table.class.php

Indentation +561 added lines, -561 removed lines

@@ -12,570 +12,570 @@
 class EE_Event_Registrations_List_Table extends EE_Admin_List_Table
 {
 
-    /**
-     * This property will hold the related Datetimes on an event IF the event id is included in the request.
-     *
-     * @var EE_Datetime[]
-     */
-    protected $_dtts_for_event = array();
-
-
-    /**
-     * The event if one is specified in the request
-     *
-     * @var EE_Event
-     */
-    protected $_evt = null;
-
-
-    /**
-     * The DTT_ID if the current view has a specified datetime.
-     *
-     * @var int $_cur_dtt_id
-     */
-    protected $_cur_dtt_id = 0;
-
-
-    /**
-     * EE_Event_Registrations_List_Table constructor.
-     *
-     * @param \Registrations_Admin_Page $admin_page
-     */
-    public function __construct($admin_page)
-    {
-        parent::__construct($admin_page);
-        $this->_status = $this->_admin_page->get_registration_status_array();
-    }
-
-
-    protected function _setup_data()
-    {
-        $this->_data = $this->_view !== 'trash' ? $this->_admin_page->get_event_attendees($this->_per_page)
-            : $this->_admin_page->get_event_attendees($this->_per_page, false, true);
-        $this->_all_data_count = $this->_view !== 'trash' ? $this->_admin_page->get_event_attendees(
-            $this->_per_page,
-            true
-        ) : $this->_admin_page->get_event_attendees($this->_per_page, true, true);
-    }
-
-
-    protected function _set_properties()
-    {
-        $return_url = $this->getReturnUrl();
-
-        $evt_id = isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null;
-        $this->_wp_list_args = array(
-            'singular' => esc_html__('registrant', 'event_espresso'),
-            'plural'   => esc_html__('registrants', 'event_espresso'),
-            'ajax'     => true,
-            'screen'   => $this->_admin_page->get_current_screen()->id,
-        );
-        $columns = array();
-        // $columns['_Reg_Status'] = '';
-        $this->_columns = array(
-            '_REG_att_checked_in' => '<span class="dashicons dashicons-yes ee-icon-size-18"></span>',
-            'ATT_name'            => esc_html__('Registrant', 'event_espresso'),
-            'ATT_email'           => esc_html__('Email Address', 'event_espresso'),
-            'Event'               => esc_html__('Event', 'event_espresso'),
-            'PRC_name'            => esc_html__('TKT Option', 'event_espresso'),
-            '_REG_final_price'    => esc_html__('Price', 'event_espresso'),
-            'TXN_paid'            => esc_html__('Paid', 'event_espresso'),
-            'TXN_total'           => esc_html__('Total', 'event_espresso'),
-        );
-        // Add/remove columns when an event has been selected
-        if (! empty($evt_id)) {
-            // Render a checkbox column
-            $columns['cb'] = '<input type="checkbox" />';
-            $this->_has_checkbox_column = true;
-            // Remove the 'Event' column
-            unset($this->_columns['Event']);
-        }
-        $this->_columns = array_merge($columns, $this->_columns);
-        $this->_primary_column = '_REG_att_checked_in';
-        if (
-            ! empty($evt_id)
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_registrations',
-                'espresso_registrations_registrations_reports',
-                $evt_id
-            )
-        ) {
-            $this->_bottom_buttons = array(
-                'report' => array(
-                    'route'         => 'registrations_report',
-                    'extra_request' =>
-                        array(
-                            'EVT_ID'     => $evt_id,
-                            'return_url' => $return_url,
-                        ),
-                ),
-            );
-        }
-        $this->_bottom_buttons['report_filtered'] = array(
-            'route'         => 'registrations_checkin_report',
-            'extra_request' => array(
-                'use_filters' => true,
-                'filters'     => array_merge(
-                    array(
-                        'EVT_ID' => $evt_id,
-                    ),
-                    array_diff_key(
-                        $this->_req_data,
-                        array_flip(
-                            array(
-                                'page',
-                                'action',
-                                'default_nonce',
-                            )
-                        )
-                    )
-                ),
-                'return_url'  => $return_url,
-            ),
-        );
-        $this->_sortable_columns = array(
-            /**
-             * Allows users to change the default sort if they wish.
-             * Returning a falsey on this filter will result in the default sort to be by firstname rather than last name.
-             *
-             * Note: usual naming conventions for filters aren't followed here so that just one filter can be used to
-             * change the sorts on any list table involving registration contacts.  If you want to only change the filter
-             * for a specific list table you can use the provided reference to this object instance.
-             */
-            'ATT_name' => array(
-                'FHEE__EE_Registrations_List_Table___set_properties__default_sort_by_registration_last_name',
-                true,
-                $this,
-            )
-                ? array('ATT_lname' => true)
-                : array('ATT_fname' => true),
-            'Event'    => array('Event.EVT_name' => false),
-        );
-        $this->_hidden_columns = array();
-        $this->_evt = EEM_Event::instance()->get_one_by_ID($evt_id);
-        $this->_dtts_for_event = $this->_evt instanceof EE_Event ? $this->_evt->datetimes_ordered() : array();
-    }
-
-
-    /**
-     * @param \EE_Registration $item
-     * @return string
-     */
-    protected function _get_row_class($item)
-    {
-        $class = parent::_get_row_class($item);
-        // add status class
-        $class .= ' ee-status-strip reg-status-' . $item->status_ID();
-        if ($this->_has_checkbox_column) {
-            $class .= ' has-checkbox-column';
-        }
-        return $class;
-    }
-
-
-    /**
-     * @return array
-     * @throws \EE_Error
-     */
-    protected function _get_table_filters()
-    {
-        $filters = $where = array();
-        $current_EVT_ID = isset($this->_req_data['event_id']) ? (int) $this->_req_data['event_id'] : 0;
-        if (empty($this->_dtts_for_event) || count($this->_dtts_for_event) === 1) {
-            // this means we don't have an event so let's setup a filter dropdown for all the events to select
-            // note possible capability restrictions
-            if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
-                $where['status**'] = array('!=', 'private');
-            }
-            if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
-                $where['EVT_wp_user'] = get_current_user_id();
-            }
-            $events = EEM_Event::instance()->get_all(
-                array(
-                    $where,
-                    'order_by' => array('Datetime.DTT_EVT_start' => 'DESC'),
-                )
-            );
-            $evts[] = array(
-                'id'   => 0,
-                'text' => esc_html__('To toggle Check-in status, select an event', 'event_espresso'),
-            );
-            $checked = 'checked';
-            /** @var EE_Event $evt */
-            foreach ($events as $evt) {
-                // any registrations for this event?
-                if (! $evt->get_count_of_all_registrations()) {
-                    continue;
-                }
-                $evts[] = array(
-                    'id'    => $evt->ID(),
-                    'text'  => apply_filters(
-                        'FHEE__EE_Event_Registrations___get_table_filters__event_name',
-                        $evt->get('EVT_name'),
-                        $evt
-                    ),
-                    'class' => $evt->is_expired() ? 'ee-expired-event' : '',
-                );
-                if ($evt->ID() === $current_EVT_ID && $evt->is_expired()) {
-                    $checked = '';
-                }
-            }
-            $event_filter = '<div class="ee-event-filter">';
-            $event_filter .= EEH_Form_Fields::select_input('event_id', $evts, $current_EVT_ID);
-            $event_filter .= '<span class="ee-event-filter-toggle">';
-            $event_filter .= '<input type="checkbox" id="js-ee-hide-expired-events" ' . $checked . '> ';
-            $event_filter .= esc_html__('Hide Expired Events', 'event_espresso');
-            $event_filter .= '</span>';
-            $event_filter .= '</div>';
-            $filters[] = $event_filter;
-        }
-        if (! empty($this->_dtts_for_event)) {
-            // DTT datetimes filter
-            $this->_cur_dtt_id = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0;
-            if (count($this->_dtts_for_event) > 1) {
-                $dtts[0] = esc_html__('To toggle check-in status, select a datetime.', 'event_espresso');
-                foreach ($this->_dtts_for_event as $dtt) {
-                    $datetime_string = $dtt->name();
-                    $datetime_string = ! empty($datetime_string) ? ' (' . $datetime_string . ')' : '';
-                    $datetime_string = $dtt->start_date_and_time() . ' - ' . $dtt->end_date_and_time() . $datetime_string;
-                    $dtts[ $dtt->ID() ] = $datetime_string;
-                }
-                $input = new EE_Select_Input(
-                    $dtts,
-                    array(
-                        'html_name' => 'DTT_ID',
-                        'html_id'   => 'DTT_ID',
-                        'default'   => $this->_cur_dtt_id,
-                    )
-                );
-                $filters[] = $input->get_html_for_input();
-                $filters[] = '<input type="hidden" name="event_id" value="' . $current_EVT_ID . '">';
-            }
-        }
-        return $filters;
-    }
-
-
-    protected function _add_view_counts()
-    {
-        $this->_views['all']['count'] = $this->_get_total_event_attendees();
-    }
-
-
-    /**
-     * @return int
-     * @throws \EE_Error
-     */
-    protected function _get_total_event_attendees()
-    {
-        $EVT_ID = isset($this->_req_data['event_id']) ? absint($this->_req_data['event_id']) : false;
-        $DTT_ID = $this->_cur_dtt_id;
-        $query_params = array();
-        if ($EVT_ID) {
-            $query_params[0]['EVT_ID'] = $EVT_ID;
-        }
-        // if DTT is included we only show for that datetime.  Otherwise we're showing for all datetimes (the event).
-        if ($DTT_ID) {
-            $query_params[0]['Ticket.Datetime.DTT_ID'] = $DTT_ID;
-        }
-        $status_ids_array = apply_filters(
-            'FHEE__Extend_Registrations_Admin_Page__get_event_attendees__status_ids_array',
-            array(EEM_Registration::status_id_pending_payment, EEM_Registration::status_id_approved)
-        );
-        $query_params[0]['STS_ID'] = array('IN', $status_ids_array);
-        return EEM_Registration::instance()->count($query_params);
-    }
-
-
-    /**
-     * @param \EE_Registration $item
-     * @return string
-     */
-    public function column__Reg_Status(EE_Registration $item)
-    {
-        return '<span class="ee-status-strip ee-status-strip-td reg-status-' . $item->status_ID() . '"></span>';
-    }
-
-
-    /**
-     * @param \EE_Registration $item
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_cb($item)
-    {
-        return sprintf('<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />', $item->ID());
-    }
-
-
-    /**
-     * column_REG_att_checked_in
-     *
-     * @param EE_Registration $item
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column__REG_att_checked_in(EE_Registration $item)
-    {
-        $attendee = $item->attendee();
-        $attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : '';
-
-        if ($this->_cur_dtt_id === 0 && count($this->_dtts_for_event) === 1) {
-            $latest_related_datetime = $item->get_latest_related_datetime();
-            if ($latest_related_datetime instanceof EE_Datetime) {
-                $this->_cur_dtt_id = $latest_related_datetime->ID();
-            }
-        }
-        $checkin_status_dashicon = CheckinStatusDashicon::fromRegistrationAndDatetimeId(
-            $item,
-            $this->_cur_dtt_id
-        );
-        $nonce = wp_create_nonce('checkin_nonce');
-        $toggle_active = ! empty($this->_cur_dtt_id)
-                         && EE_Registry::instance()->CAP->current_user_can(
-                             'ee_edit_checkin',
-                             'espresso_registrations_toggle_checkin_status',
-                             $item->ID()
-                         )
-            ? ' clickable trigger-checkin'
-            : '';
-        $mobile_view_content = ' <span class="show-on-mobile-view-only">' . $attendee_name . '</span>';
-        return '<span class="' . $checkin_status_dashicon->cssClasses() . $toggle_active . '"'
-               . ' data-_regid="' . $item->ID() . '"'
-               . ' data-dttid="' . $this->_cur_dtt_id . '"'
-               . ' data-nonce="' . $nonce . '">'
-               . '</span>'
-               . $mobile_view_content;
-    }
-
-
-    /**
-     * @param \EE_Registration $item
-     * @return mixed|string|void
-     * @throws \EE_Error
-     */
-    public function column_ATT_name(EE_Registration $item)
-    {
-        $attendee = $item->attendee();
-        if (! $attendee instanceof EE_Attendee) {
-            return esc_html__('No contact record for this registration.', 'event_espresso');
-        }
-        // edit attendee link
-        $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-            array('action' => 'view_registration', '_REG_ID' => $item->ID()),
-            REG_ADMIN_URL
-        );
-        $name_link = EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_contacts',
-            'espresso_registrations_edit_attendee'
-        )
-            ? '<a href="' . $edit_lnk_url . '" title="' . esc_attr__('View Registration Details', 'event_espresso') . '">'
-              . $item->attendee()->full_name()
-              . '</a>'
-            : $item->attendee()->full_name();
-        $name_link .= $item->count() === 1
-            ? '&nbsp;<sup><div class="dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8"></div></sup>	'
-            : '';
-        // add group details
-        $name_link .= '&nbsp;' . sprintf(esc_html__('(%s of %s)', 'event_espresso'), $item->count(), $item->group_size());
-        // add regcode
-        $link = EE_Admin_Page::add_query_args_and_nonce(
-            array('action' => 'view_registration', '_REG_ID' => $item->ID()),
-            REG_ADMIN_URL
-        );
-        $name_link .= '<br>';
-        $name_link .= EE_Registry::instance()->instance()->CAP->current_user_can(
-            'ee_read_registration',
-            'view_registration',
-            $item->ID()
-        )
-            ? '<a href="' . $link . '" title="' . esc_attr__('View Registration Details', 'event_espresso') . '">'
-              . $item->reg_code()
-              . '</a>'
-            : $item->reg_code();
-        // status
-        $name_link .= '<br><span class="ee-status-text-small">';
-        $name_link .= EEH_Template::pretty_status($item->status_ID(), false, 'sentence');
-        $name_link .= '</span>';
-        $actions = array();
-        $DTT_ID = $this->_cur_dtt_id;
-        $latest_related_datetime = empty($DTT_ID) && ! empty($this->_req_data['event_id']) && $item instanceof EE_Registration
-            ? $item->get_latest_related_datetime()
-            : null;
-        $DTT_ID = $latest_related_datetime instanceof EE_Datetime
-            ? $latest_related_datetime->ID()
-            : $DTT_ID;
-        if (
-            ! empty($DTT_ID)
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_checkins',
-                'espresso_registrations_registration_checkins'
-            )
-        ) {
-            $checkin_list_url = EE_Admin_Page::add_query_args_and_nonce(
-                array('action' => 'registration_checkins', '_REG_ID' => $item->ID(), 'DTT_ID' => $DTT_ID),
-                REG_ADMIN_URL
-            );
-            // get the timestamps for this registration's checkins, related to the selected datetime
-            $timestamps = $item->get_many_related('Checkin', array(array('DTT_ID' => $DTT_ID)));
-            if (! empty($timestamps)) {
-                // get the last timestamp
-                $last_timestamp = end($timestamps);
-                // checked in or checked out?
-                $checkin_status = $last_timestamp->get('CHK_in')
-                    ? esc_html__('Checked In', 'event_espresso')
-                    : esc_html__('Checked Out', 'event_espresso');
-                // get timestamp string
-                $timestamp_string = $last_timestamp->get_datetime('CHK_timestamp');
-                $actions['checkin'] = '<a href="' . $checkin_list_url . '" title="'
-                                      . esc_attr__(
-                                          'View this registrant\'s check-ins/checkouts for the datetime',
-                                          'event_espresso'
-                                      ) . '">' . $checkin_status . ': ' . $timestamp_string . '</a>';
-            }
-        }
-        return (! empty($DTT_ID) && ! empty($timestamps))
-            ? sprintf('%1$s %2$s', $name_link, $this->row_actions($actions, true))
-            : $name_link;
-    }
-
-
-    /**
-     * @param \EE_Registration $item
-     * @return string
-     */
-    public function column_ATT_email(EE_Registration $item)
-    {
-        $attendee = $item->attendee();
-        return $attendee instanceof EE_Attendee ? $attendee->email() : '';
-    }
-
-
-    /**
-     * @param \EE_Registration $item
-     * @return bool|string
-     * @throws \EE_Error
-     */
-    public function column_Event(EE_Registration $item)
-    {
-        try {
-            $event = $this->_evt instanceof EE_Event ? $this->_evt : $item->event();
-            $chkin_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-                array('action' => 'event_registrations', 'event_id' => $event->ID()),
-                REG_ADMIN_URL
-            );
-            $event_label = EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_checkins',
-                'espresso_registrations_registration_checkins'
-            ) ? '<a href="' . $chkin_lnk_url . '" title="'
-                . esc_attr__(
-                    'View Checkins for this Event',
-                    'event_espresso'
-                ) . '">' . $event->name() . '</a>' : $event->name();
-        } catch (\EventEspresso\core\exceptions\EntityNotFoundException $e) {
-            $event_label = esc_html__('Unknown', 'event_espresso');
-        }
-        return $event_label;
-    }
-
-
-    /**
-     * @param \EE_Registration $item
-     * @return mixed|string|void
-     */
-    public function column_PRC_name(EE_Registration $item)
-    {
-        return $item->ticket() instanceof EE_Ticket ? $item->ticket()->name() : esc_html__("Unknown", "event_espresso");
-    }
-
-
-    /**
-     * column_REG_final_price
-     *
-     * @param \EE_Registration $item
-     * @return string
-     */
-    public function column__REG_final_price(EE_Registration $item)
-    {
-        return '<span class="reg-pad-rght">' . ' ' . $item->pretty_final_price() . '</span>';
-    }
-
-
-    /**
-     * column_TXN_paid
-     *
-     * @param \EE_Registration $item
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_TXN_paid(EE_Registration $item)
-    {
-        if ($item->count() === 1) {
-            if ($item->transaction()->paid() >= $item->transaction()->total()) {
-                return '<span class="reg-pad-rght"><div class="dashicons dashicons-yes green-icon"></div></span>';
-            } else {
-                $view_txn_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
-                    array('action' => 'view_transaction', 'TXN_ID' => $item->transaction_ID()),
-                    TXN_ADMIN_URL
-                );
-                return EE_Registry::instance()->CAP->current_user_can(
-                    'ee_read_transaction',
-                    'espresso_transactions_view_transaction'
-                ) ? '
+	/**
+	 * This property will hold the related Datetimes on an event IF the event id is included in the request.
+	 *
+	 * @var EE_Datetime[]
+	 */
+	protected $_dtts_for_event = array();
+
+
+	/**
+	 * The event if one is specified in the request
+	 *
+	 * @var EE_Event
+	 */
+	protected $_evt = null;
+
+
+	/**
+	 * The DTT_ID if the current view has a specified datetime.
+	 *
+	 * @var int $_cur_dtt_id
+	 */
+	protected $_cur_dtt_id = 0;
+
+
+	/**
+	 * EE_Event_Registrations_List_Table constructor.
+	 *
+	 * @param \Registrations_Admin_Page $admin_page
+	 */
+	public function __construct($admin_page)
+	{
+		parent::__construct($admin_page);
+		$this->_status = $this->_admin_page->get_registration_status_array();
+	}
+
+
+	protected function _setup_data()
+	{
+		$this->_data = $this->_view !== 'trash' ? $this->_admin_page->get_event_attendees($this->_per_page)
+			: $this->_admin_page->get_event_attendees($this->_per_page, false, true);
+		$this->_all_data_count = $this->_view !== 'trash' ? $this->_admin_page->get_event_attendees(
+			$this->_per_page,
+			true
+		) : $this->_admin_page->get_event_attendees($this->_per_page, true, true);
+	}
+
+
+	protected function _set_properties()
+	{
+		$return_url = $this->getReturnUrl();
+
+		$evt_id = isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null;
+		$this->_wp_list_args = array(
+			'singular' => esc_html__('registrant', 'event_espresso'),
+			'plural'   => esc_html__('registrants', 'event_espresso'),
+			'ajax'     => true,
+			'screen'   => $this->_admin_page->get_current_screen()->id,
+		);
+		$columns = array();
+		// $columns['_Reg_Status'] = '';
+		$this->_columns = array(
+			'_REG_att_checked_in' => '<span class="dashicons dashicons-yes ee-icon-size-18"></span>',
+			'ATT_name'            => esc_html__('Registrant', 'event_espresso'),
+			'ATT_email'           => esc_html__('Email Address', 'event_espresso'),
+			'Event'               => esc_html__('Event', 'event_espresso'),
+			'PRC_name'            => esc_html__('TKT Option', 'event_espresso'),
+			'_REG_final_price'    => esc_html__('Price', 'event_espresso'),
+			'TXN_paid'            => esc_html__('Paid', 'event_espresso'),
+			'TXN_total'           => esc_html__('Total', 'event_espresso'),
+		);
+		// Add/remove columns when an event has been selected
+		if (! empty($evt_id)) {
+			// Render a checkbox column
+			$columns['cb'] = '<input type="checkbox" />';
+			$this->_has_checkbox_column = true;
+			// Remove the 'Event' column
+			unset($this->_columns['Event']);
+		}
+		$this->_columns = array_merge($columns, $this->_columns);
+		$this->_primary_column = '_REG_att_checked_in';
+		if (
+			! empty($evt_id)
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_registrations',
+				'espresso_registrations_registrations_reports',
+				$evt_id
+			)
+		) {
+			$this->_bottom_buttons = array(
+				'report' => array(
+					'route'         => 'registrations_report',
+					'extra_request' =>
+						array(
+							'EVT_ID'     => $evt_id,
+							'return_url' => $return_url,
+						),
+				),
+			);
+		}
+		$this->_bottom_buttons['report_filtered'] = array(
+			'route'         => 'registrations_checkin_report',
+			'extra_request' => array(
+				'use_filters' => true,
+				'filters'     => array_merge(
+					array(
+						'EVT_ID' => $evt_id,
+					),
+					array_diff_key(
+						$this->_req_data,
+						array_flip(
+							array(
+								'page',
+								'action',
+								'default_nonce',
+							)
+						)
+					)
+				),
+				'return_url'  => $return_url,
+			),
+		);
+		$this->_sortable_columns = array(
+			/**
+			 * Allows users to change the default sort if they wish.
+			 * Returning a falsey on this filter will result in the default sort to be by firstname rather than last name.
+			 *
+			 * Note: usual naming conventions for filters aren't followed here so that just one filter can be used to
+			 * change the sorts on any list table involving registration contacts.  If you want to only change the filter
+			 * for a specific list table you can use the provided reference to this object instance.
+			 */
+			'ATT_name' => array(
+				'FHEE__EE_Registrations_List_Table___set_properties__default_sort_by_registration_last_name',
+				true,
+				$this,
+			)
+				? array('ATT_lname' => true)
+				: array('ATT_fname' => true),
+			'Event'    => array('Event.EVT_name' => false),
+		);
+		$this->_hidden_columns = array();
+		$this->_evt = EEM_Event::instance()->get_one_by_ID($evt_id);
+		$this->_dtts_for_event = $this->_evt instanceof EE_Event ? $this->_evt->datetimes_ordered() : array();
+	}
+
+
+	/**
+	 * @param \EE_Registration $item
+	 * @return string
+	 */
+	protected function _get_row_class($item)
+	{
+		$class = parent::_get_row_class($item);
+		// add status class
+		$class .= ' ee-status-strip reg-status-' . $item->status_ID();
+		if ($this->_has_checkbox_column) {
+			$class .= ' has-checkbox-column';
+		}
+		return $class;
+	}
+
+
+	/**
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	protected function _get_table_filters()
+	{
+		$filters = $where = array();
+		$current_EVT_ID = isset($this->_req_data['event_id']) ? (int) $this->_req_data['event_id'] : 0;
+		if (empty($this->_dtts_for_event) || count($this->_dtts_for_event) === 1) {
+			// this means we don't have an event so let's setup a filter dropdown for all the events to select
+			// note possible capability restrictions
+			if (! EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_events')) {
+				$where['status**'] = array('!=', 'private');
+			}
+			if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_events', 'get_events')) {
+				$where['EVT_wp_user'] = get_current_user_id();
+			}
+			$events = EEM_Event::instance()->get_all(
+				array(
+					$where,
+					'order_by' => array('Datetime.DTT_EVT_start' => 'DESC'),
+				)
+			);
+			$evts[] = array(
+				'id'   => 0,
+				'text' => esc_html__('To toggle Check-in status, select an event', 'event_espresso'),
+			);
+			$checked = 'checked';
+			/** @var EE_Event $evt */
+			foreach ($events as $evt) {
+				// any registrations for this event?
+				if (! $evt->get_count_of_all_registrations()) {
+					continue;
+				}
+				$evts[] = array(
+					'id'    => $evt->ID(),
+					'text'  => apply_filters(
+						'FHEE__EE_Event_Registrations___get_table_filters__event_name',
+						$evt->get('EVT_name'),
+						$evt
+					),
+					'class' => $evt->is_expired() ? 'ee-expired-event' : '',
+				);
+				if ($evt->ID() === $current_EVT_ID && $evt->is_expired()) {
+					$checked = '';
+				}
+			}
+			$event_filter = '<div class="ee-event-filter">';
+			$event_filter .= EEH_Form_Fields::select_input('event_id', $evts, $current_EVT_ID);
+			$event_filter .= '<span class="ee-event-filter-toggle">';
+			$event_filter .= '<input type="checkbox" id="js-ee-hide-expired-events" ' . $checked . '> ';
+			$event_filter .= esc_html__('Hide Expired Events', 'event_espresso');
+			$event_filter .= '</span>';
+			$event_filter .= '</div>';
+			$filters[] = $event_filter;
+		}
+		if (! empty($this->_dtts_for_event)) {
+			// DTT datetimes filter
+			$this->_cur_dtt_id = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0;
+			if (count($this->_dtts_for_event) > 1) {
+				$dtts[0] = esc_html__('To toggle check-in status, select a datetime.', 'event_espresso');
+				foreach ($this->_dtts_for_event as $dtt) {
+					$datetime_string = $dtt->name();
+					$datetime_string = ! empty($datetime_string) ? ' (' . $datetime_string . ')' : '';
+					$datetime_string = $dtt->start_date_and_time() . ' - ' . $dtt->end_date_and_time() . $datetime_string;
+					$dtts[ $dtt->ID() ] = $datetime_string;
+				}
+				$input = new EE_Select_Input(
+					$dtts,
+					array(
+						'html_name' => 'DTT_ID',
+						'html_id'   => 'DTT_ID',
+						'default'   => $this->_cur_dtt_id,
+					)
+				);
+				$filters[] = $input->get_html_for_input();
+				$filters[] = '<input type="hidden" name="event_id" value="' . $current_EVT_ID . '">';
+			}
+		}
+		return $filters;
+	}
+
+
+	protected function _add_view_counts()
+	{
+		$this->_views['all']['count'] = $this->_get_total_event_attendees();
+	}
+
+
+	/**
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	protected function _get_total_event_attendees()
+	{
+		$EVT_ID = isset($this->_req_data['event_id']) ? absint($this->_req_data['event_id']) : false;
+		$DTT_ID = $this->_cur_dtt_id;
+		$query_params = array();
+		if ($EVT_ID) {
+			$query_params[0]['EVT_ID'] = $EVT_ID;
+		}
+		// if DTT is included we only show for that datetime.  Otherwise we're showing for all datetimes (the event).
+		if ($DTT_ID) {
+			$query_params[0]['Ticket.Datetime.DTT_ID'] = $DTT_ID;
+		}
+		$status_ids_array = apply_filters(
+			'FHEE__Extend_Registrations_Admin_Page__get_event_attendees__status_ids_array',
+			array(EEM_Registration::status_id_pending_payment, EEM_Registration::status_id_approved)
+		);
+		$query_params[0]['STS_ID'] = array('IN', $status_ids_array);
+		return EEM_Registration::instance()->count($query_params);
+	}
+
+
+	/**
+	 * @param \EE_Registration $item
+	 * @return string
+	 */
+	public function column__Reg_Status(EE_Registration $item)
+	{
+		return '<span class="ee-status-strip ee-status-strip-td reg-status-' . $item->status_ID() . '"></span>';
+	}
+
+
+	/**
+	 * @param \EE_Registration $item
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_cb($item)
+	{
+		return sprintf('<input type="checkbox" name="checkbox[%1$s]" value="%1$s" />', $item->ID());
+	}
+
+
+	/**
+	 * column_REG_att_checked_in
+	 *
+	 * @param EE_Registration $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column__REG_att_checked_in(EE_Registration $item)
+	{
+		$attendee = $item->attendee();
+		$attendee_name = $attendee instanceof EE_Attendee ? $attendee->full_name() : '';
+
+		if ($this->_cur_dtt_id === 0 && count($this->_dtts_for_event) === 1) {
+			$latest_related_datetime = $item->get_latest_related_datetime();
+			if ($latest_related_datetime instanceof EE_Datetime) {
+				$this->_cur_dtt_id = $latest_related_datetime->ID();
+			}
+		}
+		$checkin_status_dashicon = CheckinStatusDashicon::fromRegistrationAndDatetimeId(
+			$item,
+			$this->_cur_dtt_id
+		);
+		$nonce = wp_create_nonce('checkin_nonce');
+		$toggle_active = ! empty($this->_cur_dtt_id)
+						 && EE_Registry::instance()->CAP->current_user_can(
+							 'ee_edit_checkin',
+							 'espresso_registrations_toggle_checkin_status',
+							 $item->ID()
+						 )
+			? ' clickable trigger-checkin'
+			: '';
+		$mobile_view_content = ' <span class="show-on-mobile-view-only">' . $attendee_name . '</span>';
+		return '<span class="' . $checkin_status_dashicon->cssClasses() . $toggle_active . '"'
+			   . ' data-_regid="' . $item->ID() . '"'
+			   . ' data-dttid="' . $this->_cur_dtt_id . '"'
+			   . ' data-nonce="' . $nonce . '">'
+			   . '</span>'
+			   . $mobile_view_content;
+	}
+
+
+	/**
+	 * @param \EE_Registration $item
+	 * @return mixed|string|void
+	 * @throws \EE_Error
+	 */
+	public function column_ATT_name(EE_Registration $item)
+	{
+		$attendee = $item->attendee();
+		if (! $attendee instanceof EE_Attendee) {
+			return esc_html__('No contact record for this registration.', 'event_espresso');
+		}
+		// edit attendee link
+		$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+			array('action' => 'view_registration', '_REG_ID' => $item->ID()),
+			REG_ADMIN_URL
+		);
+		$name_link = EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_contacts',
+			'espresso_registrations_edit_attendee'
+		)
+			? '<a href="' . $edit_lnk_url . '" title="' . esc_attr__('View Registration Details', 'event_espresso') . '">'
+			  . $item->attendee()->full_name()
+			  . '</a>'
+			: $item->attendee()->full_name();
+		$name_link .= $item->count() === 1
+			? '&nbsp;<sup><div class="dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8"></div></sup>	'
+			: '';
+		// add group details
+		$name_link .= '&nbsp;' . sprintf(esc_html__('(%s of %s)', 'event_espresso'), $item->count(), $item->group_size());
+		// add regcode
+		$link = EE_Admin_Page::add_query_args_and_nonce(
+			array('action' => 'view_registration', '_REG_ID' => $item->ID()),
+			REG_ADMIN_URL
+		);
+		$name_link .= '<br>';
+		$name_link .= EE_Registry::instance()->instance()->CAP->current_user_can(
+			'ee_read_registration',
+			'view_registration',
+			$item->ID()
+		)
+			? '<a href="' . $link . '" title="' . esc_attr__('View Registration Details', 'event_espresso') . '">'
+			  . $item->reg_code()
+			  . '</a>'
+			: $item->reg_code();
+		// status
+		$name_link .= '<br><span class="ee-status-text-small">';
+		$name_link .= EEH_Template::pretty_status($item->status_ID(), false, 'sentence');
+		$name_link .= '</span>';
+		$actions = array();
+		$DTT_ID = $this->_cur_dtt_id;
+		$latest_related_datetime = empty($DTT_ID) && ! empty($this->_req_data['event_id']) && $item instanceof EE_Registration
+			? $item->get_latest_related_datetime()
+			: null;
+		$DTT_ID = $latest_related_datetime instanceof EE_Datetime
+			? $latest_related_datetime->ID()
+			: $DTT_ID;
+		if (
+			! empty($DTT_ID)
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_checkins',
+				'espresso_registrations_registration_checkins'
+			)
+		) {
+			$checkin_list_url = EE_Admin_Page::add_query_args_and_nonce(
+				array('action' => 'registration_checkins', '_REG_ID' => $item->ID(), 'DTT_ID' => $DTT_ID),
+				REG_ADMIN_URL
+			);
+			// get the timestamps for this registration's checkins, related to the selected datetime
+			$timestamps = $item->get_many_related('Checkin', array(array('DTT_ID' => $DTT_ID)));
+			if (! empty($timestamps)) {
+				// get the last timestamp
+				$last_timestamp = end($timestamps);
+				// checked in or checked out?
+				$checkin_status = $last_timestamp->get('CHK_in')
+					? esc_html__('Checked In', 'event_espresso')
+					: esc_html__('Checked Out', 'event_espresso');
+				// get timestamp string
+				$timestamp_string = $last_timestamp->get_datetime('CHK_timestamp');
+				$actions['checkin'] = '<a href="' . $checkin_list_url . '" title="'
+									  . esc_attr__(
+										  'View this registrant\'s check-ins/checkouts for the datetime',
+										  'event_espresso'
+									  ) . '">' . $checkin_status . ': ' . $timestamp_string . '</a>';
+			}
+		}
+		return (! empty($DTT_ID) && ! empty($timestamps))
+			? sprintf('%1$s %2$s', $name_link, $this->row_actions($actions, true))
+			: $name_link;
+	}
+
+
+	/**
+	 * @param \EE_Registration $item
+	 * @return string
+	 */
+	public function column_ATT_email(EE_Registration $item)
+	{
+		$attendee = $item->attendee();
+		return $attendee instanceof EE_Attendee ? $attendee->email() : '';
+	}
+
+
+	/**
+	 * @param \EE_Registration $item
+	 * @return bool|string
+	 * @throws \EE_Error
+	 */
+	public function column_Event(EE_Registration $item)
+	{
+		try {
+			$event = $this->_evt instanceof EE_Event ? $this->_evt : $item->event();
+			$chkin_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+				array('action' => 'event_registrations', 'event_id' => $event->ID()),
+				REG_ADMIN_URL
+			);
+			$event_label = EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_checkins',
+				'espresso_registrations_registration_checkins'
+			) ? '<a href="' . $chkin_lnk_url . '" title="'
+				. esc_attr__(
+					'View Checkins for this Event',
+					'event_espresso'
+				) . '">' . $event->name() . '</a>' : $event->name();
+		} catch (\EventEspresso\core\exceptions\EntityNotFoundException $e) {
+			$event_label = esc_html__('Unknown', 'event_espresso');
+		}
+		return $event_label;
+	}
+
+
+	/**
+	 * @param \EE_Registration $item
+	 * @return mixed|string|void
+	 */
+	public function column_PRC_name(EE_Registration $item)
+	{
+		return $item->ticket() instanceof EE_Ticket ? $item->ticket()->name() : esc_html__("Unknown", "event_espresso");
+	}
+
+
+	/**
+	 * column_REG_final_price
+	 *
+	 * @param \EE_Registration $item
+	 * @return string
+	 */
+	public function column__REG_final_price(EE_Registration $item)
+	{
+		return '<span class="reg-pad-rght">' . ' ' . $item->pretty_final_price() . '</span>';
+	}
+
+
+	/**
+	 * column_TXN_paid
+	 *
+	 * @param \EE_Registration $item
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_TXN_paid(EE_Registration $item)
+	{
+		if ($item->count() === 1) {
+			if ($item->transaction()->paid() >= $item->transaction()->total()) {
+				return '<span class="reg-pad-rght"><div class="dashicons dashicons-yes green-icon"></div></span>';
+			} else {
+				$view_txn_lnk_url = EE_Admin_Page::add_query_args_and_nonce(
+					array('action' => 'view_transaction', 'TXN_ID' => $item->transaction_ID()),
+					TXN_ADMIN_URL
+				);
+				return EE_Registry::instance()->CAP->current_user_can(
+					'ee_read_transaction',
+					'espresso_transactions_view_transaction'
+				) ? '
 				<span class="reg-pad-rght">
 					<a class="status-'
-                    . $item->transaction()->status_ID()
-                    . '" href="'
-                    . $view_txn_lnk_url
-                    . '"  title="'
-                    . esc_attr__('View Transaction', 'event_espresso')
-                    . '">
+					. $item->transaction()->status_ID()
+					. '" href="'
+					. $view_txn_lnk_url
+					. '"  title="'
+					. esc_attr__('View Transaction', 'event_espresso')
+					. '">
 						'
-                    . $item->transaction()->pretty_paid()
-                    . '
+					. $item->transaction()->pretty_paid()
+					. '
 					</a>
 				<span>' : '<span class="reg-pad-rght">' . $item->transaction()->pretty_paid() . '</span>';
-            }
-        } else {
-            return '<span class="reg-pad-rght"></span>';
-        }
-    }
-
-
-    /**
-     *        column_TXN_total
-     *
-     * @param \EE_Registration $item
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_TXN_total(EE_Registration $item)
-    {
-        $txn = $item->transaction();
-        $view_txn_url = add_query_arg(array('action' => 'view_transaction', 'TXN_ID' => $txn->ID()), TXN_ADMIN_URL);
-        if ($item->get('REG_count') === 1) {
-            $line_total_obj = $txn->total_line_item();
-            $txn_total = $line_total_obj instanceof EE_Line_Item
-                ? $line_total_obj->get_pretty('LIN_total')
-                : esc_html__(
-                    'View Transaction',
-                    'event_espresso'
-                );
-            return EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_transaction',
-                'espresso_transactions_view_transaction'
-            ) ? '<a href="'
-                . $view_txn_url
-                . '" title="'
-                . esc_attr__('View Transaction', 'event_espresso')
-                . '"><span class="reg-pad-rght">'
-                . $txn_total
-                . '</span></a>' : '<span class="reg-pad-rght">' . $txn_total . '</span>';
-        } else {
-            return '<span class="reg-pad-rght"></span>';
-        }
-    }
+			}
+		} else {
+			return '<span class="reg-pad-rght"></span>';
+		}
+	}
+
+
+	/**
+	 *        column_TXN_total
+	 *
+	 * @param \EE_Registration $item
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_TXN_total(EE_Registration $item)
+	{
+		$txn = $item->transaction();
+		$view_txn_url = add_query_arg(array('action' => 'view_transaction', 'TXN_ID' => $txn->ID()), TXN_ADMIN_URL);
+		if ($item->get('REG_count') === 1) {
+			$line_total_obj = $txn->total_line_item();
+			$txn_total = $line_total_obj instanceof EE_Line_Item
+				? $line_total_obj->get_pretty('LIN_total')
+				: esc_html__(
+					'View Transaction',
+					'event_espresso'
+				);
+			return EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_transaction',
+				'espresso_transactions_view_transaction'
+			) ? '<a href="'
+				. $view_txn_url
+				. '" title="'
+				. esc_attr__('View Transaction', 'event_espresso')
+				. '"><span class="reg-pad-rght">'
+				. $txn_total
+				. '</span></a>' : '<span class="reg-pad-rght">' . $txn_total . '</span>';
+		} else {
+			return '<span class="reg-pad-rght"></span>';
+		}
+	}
 }

caffeinated/admin/extend/registrations/Extend_EE_Attendee_Contact_List_Table.class.php

Indentation +13 added lines, -13 removed lines

@@ -15,17 +15,17 @@
 class Extend_EE_Attendee_Contact_List_Table extends EE_Attendee_Contact_List_Table
 {
 
-    protected function _set_properties()
-    {
-        parent::_set_properties();
-        $this->_bottom_buttons = array(
-            'contact_list_report' => array(
-                'route'         => 'contact_list_report',
-                'extra_request' =>
-                    array(
-                        'return_url' => $this->getReturnUrl(),
-                    ),
-            ),
-        );
-    }
+	protected function _set_properties()
+	{
+		parent::_set_properties();
+		$this->_bottom_buttons = array(
+			'contact_list_report' => array(
+				'route'         => 'contact_list_report',
+				'extra_request' =>
+					array(
+						'return_url' => $this->getReturnUrl(),
+					),
+			),
+		);
+	}
 }

caffeinated/modules/event_single_caff/EED_Event_Single_Caff.module.php

Indentation +224 added lines, -224 removed lines

@@ -26,228 +26,228 @@
 {
 
 
-    /**
-     * @return EED_Event_Single_Caff
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-    }
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        self::setDefinitions();
-        add_action(
-            'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__template_settings',
-            array('EED_Event_Single_Caff', 'load_scripts_styles'),
-            10
-        );
-        add_action(
-            'AHEE__template_settings__template__before_settings_form',
-            array('EED_Event_Single_Caff', 'template_settings_form'),
-            10
-        );
-        add_filter(
-            'FHEE__General_Settings_Admin_Page__update_template_settings__data',
-            array('EED_Event_Single_Caff', 'update_template_settings'),
-            10,
-            2
-        );
-        // AJAX
-        add_action(
-            'wp_ajax_espresso_update_event_single_order',
-            array('EED_Event_Single_Caff', 'update_event_single_order')
-        );
-        add_action(
-            'wp_ajax_nopriv_espresso_update_event_single_order',
-            array('EED_Event_Single_Caff', 'update_event_single_order')
-        );
-    }
-
-
-    public static function load_scripts_styles()
-    {
-        add_action('admin_enqueue_scripts', array('EED_Event_Single_Caff', 'enqueue_scripts_styles'), 10);
-    }
-
-
-    public static function enqueue_scripts_styles()
-    {
-        wp_register_style(
-            'eed-event-single-sortable',
-            EVENT_SINGLE_CAFF_ASSETS_URL . 'eed_event_single_sortable.css',
-            array(),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('eed-event-single-sortable');
-        wp_register_script(
-            'eed-event-single-sortable',
-            EVENT_SINGLE_CAFF_ASSETS_URL . 'eed_event_single_sortable.js',
-            array('jquery-ui-sortable'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('eed-event-single-sortable');
-    }
-
-
-    /**
-     * Set constants only if they haven't been set yet.
-     */
-    public static function setDefinitions()
-    {
-        if (! defined('EVENT_SINGLE_CAFF_TEMPLATES_PATH')) {
-            define('EVENT_SINGLE_CAFF_TEMPLATES_PATH', plugin_dir_path(__FILE__) . 'templates/');
-            define('EVENT_SINGLE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
-        }
-    }
-
-
-    /**
-     *    template_settings_form
-     *
-     * @access    public
-     * @static
-     * @return    void
-     */
-    public static function template_settings_form()
-    {
-        $config = EE_Registry::instance()->CFG->template_settings;
-        $config = isset($config->EED_Event_Single) && $config->EED_Event_Single instanceof EE_Event_Single_Config
-            ? $config->EED_Event_Single : new EE_Event_Single_Config();
-        $config->use_sortable_display_order = isset($config->use_sortable_display_order)
-            ? $config->use_sortable_display_order : false;
-        $config = apply_filters('FHEE__EED_Event_Single__template_settings_form__event_list_config', $config);
-
-        $event_single_order_array = array();
-        $event_single_order_array[ $config->display_order_tickets ] = 'tickets';
-        $event_single_order_array[ $config->display_order_datetimes ] = 'datetimes';
-        $event_single_order_array[ $config->display_order_event ] = 'event';
-        $event_single_order_array[ $config->display_order_venue ] = 'venue';
-        // get template parts
-        $template_parts = EED_Event_Single::instance()->initialize_template_parts($config);
-        // convert to array so that we can add more properties
-        $config = get_object_vars($config);
-        $config['event_single_display_order'] = $template_parts->generate_sortable_list_of_template_parts(
-            'event-single-sortable-js',
-            '',
-            'single-sortable-li single-sortable-js'
-        );
-        EEH_Template::display_template(
-            EVENT_SINGLE_CAFF_TEMPLATES_PATH . 'admin-event-single-settings.template.php',
-            $config
-        );
-    }
-
-
-    /**
-     * update_template_settings
-     *
-     * @param EE_Template_Config $CFG
-     * @param array              $REQ
-     * @return EE_Template_Config
-     */
-    public static function update_template_settings(EE_Template_Config $CFG, $REQ)
-    {
-        if (! $CFG->EED_Event_Single instanceof EE_Event_Single_Config) {
-            $CFG->EED_Event_Single = new EE_Event_Single_Config();
-        }
-        $display_order_event = $CFG->EED_Event_Single->display_order_event !== null
-            ? $CFG->EED_Event_Single->display_order_event
-            : EED_Event_Single::EVENT_DETAILS_PRIORITY;
-        $display_order_datetimes = $CFG->EED_Event_Single->display_order_datetimes !== null
-            ? $CFG->EED_Event_Single->display_order_datetimes
-            : EED_Event_Single::EVENT_DATETIMES_PRIORITY;
-        $display_order_tickets = $CFG->EED_Event_Single->display_order_tickets !== null
-            ? $CFG->EED_Event_Single->display_order_tickets
-            : EED_Event_Single::EVENT_TICKETS_PRIORITY;
-        $display_order_venue = $CFG->EED_Event_Single->display_order_venue !== null
-            ? $CFG->EED_Event_Single->display_order_venue
-            : EED_Event_Single::EVENT_VENUES_PRIORITY;
-        $CFG->EED_Event_Single = new EE_Event_Single_Config();
-        $CFG->EED_Event_Single->display_status_banner_single = ! empty($REQ['display_status_banner_single'])
-                                                               && $REQ['display_status_banner_single'];
-        $CFG->EED_Event_Single->display_venue = ! empty($REQ['display_venue']) && $REQ['display_venue'];
-        $CFG->EED_Event_Single->use_sortable_display_order = ! empty($REQ['EED_Events_Single_use_sortable_display_order'])
-            ? absint($REQ['EED_Events_Single_use_sortable_display_order'])
-            : 0;
-        $CFG->EED_Event_Single->display_order_event = $CFG->EED_Event_Single->use_sortable_display_order
-            ? $display_order_event
-            : EED_Event_Single::EVENT_DETAILS_PRIORITY;
-        $CFG->EED_Event_Single->display_order_datetimes = $CFG->EED_Event_Single->use_sortable_display_order
-            ? $display_order_datetimes
-            : EED_Event_Single::EVENT_DATETIMES_PRIORITY;
-        $CFG->EED_Event_Single->display_order_tickets = $CFG->EED_Event_Single->use_sortable_display_order
-            ? $display_order_tickets
-            : EED_Event_Single::EVENT_TICKETS_PRIORITY;
-        $CFG->EED_Event_Single->display_order_venue = $CFG->EED_Event_Single->use_sortable_display_order
-            ? $display_order_venue
-            : EED_Event_Single::EVENT_VENUES_PRIORITY;
-        do_action('AHEE__EED_Event_Single__update_template_settings__after_update', $CFG, $REQ);
-        return $CFG;
-    }
-
-
-    /**
-     * update_event_single_order
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function update_event_single_order()
-    {
-        $config_saved = false;
-        $template_parts = EED_Event_Single_Caff::getRequest()->getRequestParam('elements');
-        if (! empty($template_parts)) {
-            $template_parts = explode(',', trim($template_parts, ','));
-            foreach ($template_parts as $key => $template_part) {
-                $template_part = "display_order_$template_part";
-                $priority = ($key * 10) + EED_Event_Single::EVENT_DETAILS_PRIORITY;
-                EE_Registry::instance()->CFG->template_settings->EED_Event_Single->{$template_part} = $priority;
-                do_action("AHEE__EED_Event_Single__update_event_single_order__$template_part", $priority);
-            }
-            $config_saved = EE_Registry::instance()->CFG->update_espresso_config(false, false);
-        }
-        if ($config_saved) {
-            EE_Error::add_success(esc_html__('Display Order has been successfully updated.', 'event_espresso'));
-        } else {
-            EE_Error::add_error(
-                esc_html__('Display Order was not updated.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        echo wp_json_encode(EE_Error::get_notices(false));
-        exit();
-    }
-
-
-    /**
-     *    run - initial module setup
-     *
-     * @access    public
-     * @param WP $WP
-     * @return    void
-     */
-    public function run($WP)
-    {
-    }
+	/**
+	 * @return EED_Event_Single_Caff
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+	}
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		self::setDefinitions();
+		add_action(
+			'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__template_settings',
+			array('EED_Event_Single_Caff', 'load_scripts_styles'),
+			10
+		);
+		add_action(
+			'AHEE__template_settings__template__before_settings_form',
+			array('EED_Event_Single_Caff', 'template_settings_form'),
+			10
+		);
+		add_filter(
+			'FHEE__General_Settings_Admin_Page__update_template_settings__data',
+			array('EED_Event_Single_Caff', 'update_template_settings'),
+			10,
+			2
+		);
+		// AJAX
+		add_action(
+			'wp_ajax_espresso_update_event_single_order',
+			array('EED_Event_Single_Caff', 'update_event_single_order')
+		);
+		add_action(
+			'wp_ajax_nopriv_espresso_update_event_single_order',
+			array('EED_Event_Single_Caff', 'update_event_single_order')
+		);
+	}
+
+
+	public static function load_scripts_styles()
+	{
+		add_action('admin_enqueue_scripts', array('EED_Event_Single_Caff', 'enqueue_scripts_styles'), 10);
+	}
+
+
+	public static function enqueue_scripts_styles()
+	{
+		wp_register_style(
+			'eed-event-single-sortable',
+			EVENT_SINGLE_CAFF_ASSETS_URL . 'eed_event_single_sortable.css',
+			array(),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('eed-event-single-sortable');
+		wp_register_script(
+			'eed-event-single-sortable',
+			EVENT_SINGLE_CAFF_ASSETS_URL . 'eed_event_single_sortable.js',
+			array('jquery-ui-sortable'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('eed-event-single-sortable');
+	}
+
+
+	/**
+	 * Set constants only if they haven't been set yet.
+	 */
+	public static function setDefinitions()
+	{
+		if (! defined('EVENT_SINGLE_CAFF_TEMPLATES_PATH')) {
+			define('EVENT_SINGLE_CAFF_TEMPLATES_PATH', plugin_dir_path(__FILE__) . 'templates/');
+			define('EVENT_SINGLE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
+		}
+	}
+
+
+	/**
+	 *    template_settings_form
+	 *
+	 * @access    public
+	 * @static
+	 * @return    void
+	 */
+	public static function template_settings_form()
+	{
+		$config = EE_Registry::instance()->CFG->template_settings;
+		$config = isset($config->EED_Event_Single) && $config->EED_Event_Single instanceof EE_Event_Single_Config
+			? $config->EED_Event_Single : new EE_Event_Single_Config();
+		$config->use_sortable_display_order = isset($config->use_sortable_display_order)
+			? $config->use_sortable_display_order : false;
+		$config = apply_filters('FHEE__EED_Event_Single__template_settings_form__event_list_config', $config);
+
+		$event_single_order_array = array();
+		$event_single_order_array[ $config->display_order_tickets ] = 'tickets';
+		$event_single_order_array[ $config->display_order_datetimes ] = 'datetimes';
+		$event_single_order_array[ $config->display_order_event ] = 'event';
+		$event_single_order_array[ $config->display_order_venue ] = 'venue';
+		// get template parts
+		$template_parts = EED_Event_Single::instance()->initialize_template_parts($config);
+		// convert to array so that we can add more properties
+		$config = get_object_vars($config);
+		$config['event_single_display_order'] = $template_parts->generate_sortable_list_of_template_parts(
+			'event-single-sortable-js',
+			'',
+			'single-sortable-li single-sortable-js'
+		);
+		EEH_Template::display_template(
+			EVENT_SINGLE_CAFF_TEMPLATES_PATH . 'admin-event-single-settings.template.php',
+			$config
+		);
+	}
+
+
+	/**
+	 * update_template_settings
+	 *
+	 * @param EE_Template_Config $CFG
+	 * @param array              $REQ
+	 * @return EE_Template_Config
+	 */
+	public static function update_template_settings(EE_Template_Config $CFG, $REQ)
+	{
+		if (! $CFG->EED_Event_Single instanceof EE_Event_Single_Config) {
+			$CFG->EED_Event_Single = new EE_Event_Single_Config();
+		}
+		$display_order_event = $CFG->EED_Event_Single->display_order_event !== null
+			? $CFG->EED_Event_Single->display_order_event
+			: EED_Event_Single::EVENT_DETAILS_PRIORITY;
+		$display_order_datetimes = $CFG->EED_Event_Single->display_order_datetimes !== null
+			? $CFG->EED_Event_Single->display_order_datetimes
+			: EED_Event_Single::EVENT_DATETIMES_PRIORITY;
+		$display_order_tickets = $CFG->EED_Event_Single->display_order_tickets !== null
+			? $CFG->EED_Event_Single->display_order_tickets
+			: EED_Event_Single::EVENT_TICKETS_PRIORITY;
+		$display_order_venue = $CFG->EED_Event_Single->display_order_venue !== null
+			? $CFG->EED_Event_Single->display_order_venue
+			: EED_Event_Single::EVENT_VENUES_PRIORITY;
+		$CFG->EED_Event_Single = new EE_Event_Single_Config();
+		$CFG->EED_Event_Single->display_status_banner_single = ! empty($REQ['display_status_banner_single'])
+															   && $REQ['display_status_banner_single'];
+		$CFG->EED_Event_Single->display_venue = ! empty($REQ['display_venue']) && $REQ['display_venue'];
+		$CFG->EED_Event_Single->use_sortable_display_order = ! empty($REQ['EED_Events_Single_use_sortable_display_order'])
+			? absint($REQ['EED_Events_Single_use_sortable_display_order'])
+			: 0;
+		$CFG->EED_Event_Single->display_order_event = $CFG->EED_Event_Single->use_sortable_display_order
+			? $display_order_event
+			: EED_Event_Single::EVENT_DETAILS_PRIORITY;
+		$CFG->EED_Event_Single->display_order_datetimes = $CFG->EED_Event_Single->use_sortable_display_order
+			? $display_order_datetimes
+			: EED_Event_Single::EVENT_DATETIMES_PRIORITY;
+		$CFG->EED_Event_Single->display_order_tickets = $CFG->EED_Event_Single->use_sortable_display_order
+			? $display_order_tickets
+			: EED_Event_Single::EVENT_TICKETS_PRIORITY;
+		$CFG->EED_Event_Single->display_order_venue = $CFG->EED_Event_Single->use_sortable_display_order
+			? $display_order_venue
+			: EED_Event_Single::EVENT_VENUES_PRIORITY;
+		do_action('AHEE__EED_Event_Single__update_template_settings__after_update', $CFG, $REQ);
+		return $CFG;
+	}
+
+
+	/**
+	 * update_event_single_order
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function update_event_single_order()
+	{
+		$config_saved = false;
+		$template_parts = EED_Event_Single_Caff::getRequest()->getRequestParam('elements');
+		if (! empty($template_parts)) {
+			$template_parts = explode(',', trim($template_parts, ','));
+			foreach ($template_parts as $key => $template_part) {
+				$template_part = "display_order_$template_part";
+				$priority = ($key * 10) + EED_Event_Single::EVENT_DETAILS_PRIORITY;
+				EE_Registry::instance()->CFG->template_settings->EED_Event_Single->{$template_part} = $priority;
+				do_action("AHEE__EED_Event_Single__update_event_single_order__$template_part", $priority);
+			}
+			$config_saved = EE_Registry::instance()->CFG->update_espresso_config(false, false);
+		}
+		if ($config_saved) {
+			EE_Error::add_success(esc_html__('Display Order has been successfully updated.', 'event_espresso'));
+		} else {
+			EE_Error::add_error(
+				esc_html__('Display Order was not updated.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		echo wp_json_encode(EE_Error::get_notices(false));
+		exit();
+	}
+
+
+	/**
+	 *    run - initial module setup
+	 *
+	 * @access    public
+	 * @param WP $WP
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -92,14 +92,14 @@ 
     {
         wp_register_style(
             'eed-event-single-sortable',
-            EVENT_SINGLE_CAFF_ASSETS_URL . 'eed_event_single_sortable.css',
+            EVENT_SINGLE_CAFF_ASSETS_URL.'eed_event_single_sortable.css',
             array(),
             EVENT_ESPRESSO_VERSION
         );
         wp_enqueue_style('eed-event-single-sortable');
         wp_register_script(
             'eed-event-single-sortable',
-            EVENT_SINGLE_CAFF_ASSETS_URL . 'eed_event_single_sortable.js',
+            EVENT_SINGLE_CAFF_ASSETS_URL.'eed_event_single_sortable.js',
             array('jquery-ui-sortable'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -113,9 +113,9 @@ 
      */
     public static function setDefinitions()
     {
-        if (! defined('EVENT_SINGLE_CAFF_TEMPLATES_PATH')) {
-            define('EVENT_SINGLE_CAFF_TEMPLATES_PATH', plugin_dir_path(__FILE__) . 'templates/');
-            define('EVENT_SINGLE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
+        if ( ! defined('EVENT_SINGLE_CAFF_TEMPLATES_PATH')) {
+            define('EVENT_SINGLE_CAFF_TEMPLATES_PATH', plugin_dir_path(__FILE__).'templates/');
+            define('EVENT_SINGLE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__).'assets/');
         }
     }
 
@@ -137,10 +137,10 @@ 
         $config = apply_filters('FHEE__EED_Event_Single__template_settings_form__event_list_config', $config);
 
         $event_single_order_array = array();
-        $event_single_order_array[ $config->display_order_tickets ] = 'tickets';
-        $event_single_order_array[ $config->display_order_datetimes ] = 'datetimes';
-        $event_single_order_array[ $config->display_order_event ] = 'event';
-        $event_single_order_array[ $config->display_order_venue ] = 'venue';
+        $event_single_order_array[$config->display_order_tickets] = 'tickets';
+        $event_single_order_array[$config->display_order_datetimes] = 'datetimes';
+        $event_single_order_array[$config->display_order_event] = 'event';
+        $event_single_order_array[$config->display_order_venue] = 'venue';
         // get template parts
         $template_parts = EED_Event_Single::instance()->initialize_template_parts($config);
         // convert to array so that we can add more properties
@@ -151,7 +151,7 @@ 
             'single-sortable-li single-sortable-js'
         );
         EEH_Template::display_template(
-            EVENT_SINGLE_CAFF_TEMPLATES_PATH . 'admin-event-single-settings.template.php',
+            EVENT_SINGLE_CAFF_TEMPLATES_PATH.'admin-event-single-settings.template.php',
             $config
         );
     }
@@ -166,7 +166,7 @@ 
      */
     public static function update_template_settings(EE_Template_Config $CFG, $REQ)
     {
-        if (! $CFG->EED_Event_Single instanceof EE_Event_Single_Config) {
+        if ( ! $CFG->EED_Event_Single instanceof EE_Event_Single_Config) {
             $CFG->EED_Event_Single = new EE_Event_Single_Config();
         }
         $display_order_event = $CFG->EED_Event_Single->display_order_event !== null
@@ -215,7 +215,7 @@ 
     {
         $config_saved = false;
         $template_parts = EED_Event_Single_Caff::getRequest()->getRequestParam('elements');
-        if (! empty($template_parts)) {
+        if ( ! empty($template_parts)) {
             $template_parts = explode(',', trim($template_parts, ','));
             foreach ($template_parts as $key => $template_part) {
                 $template_part = "display_order_$template_part";

caffeinated/modules/events_archive_caff/EED_Events_Archive_Caff.module.php

Indentation +245 added lines, -245 removed lines

@@ -13,262 +13,262 @@
 class EED_Events_Archive_Caff extends EED_Events_Archive
 {
 
-    /**
-     * @return EED_Events_Archive_Caff|EED_Module
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
+	/**
+	 * @return EED_Events_Archive_Caff|EED_Module
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
 
 
-    /**
-     * set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-    }
+	/**
+	 * set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+	}
 
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        self::setDefinitions();
-        add_action(
-            'AHEE__template_settings__template__before_settings_form',
-            array('EED_Events_Archive_Caff', 'template_settings_form'),
-            10
-        );
-        add_filter(
-            'FHEE__General_Settings_Admin_Page__update_template_settings__data',
-            array('EED_Events_Archive_Caff', 'update_template_settings'),
-            10,
-            2
-        );
-        // AJAX
-        add_action(
-            'wp_ajax_espresso_update_event_archive_order',
-            array('EED_Events_Archive_Caff', 'update_event_archive_order')
-        );
-        add_action(
-            'wp_ajax_nopriv_espresso_update_event_archive_order',
-            array('EED_Events_Archive_Caff', 'update_event_archive_order')
-        );
-    }
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		self::setDefinitions();
+		add_action(
+			'AHEE__template_settings__template__before_settings_form',
+			array('EED_Events_Archive_Caff', 'template_settings_form'),
+			10
+		);
+		add_filter(
+			'FHEE__General_Settings_Admin_Page__update_template_settings__data',
+			array('EED_Events_Archive_Caff', 'update_template_settings'),
+			10,
+			2
+		);
+		// AJAX
+		add_action(
+			'wp_ajax_espresso_update_event_archive_order',
+			array('EED_Events_Archive_Caff', 'update_event_archive_order')
+		);
+		add_action(
+			'wp_ajax_nopriv_espresso_update_event_archive_order',
+			array('EED_Events_Archive_Caff', 'update_event_archive_order')
+		);
+	}
 
 
-    /**
-     * run - initial module setup
-     *
-     * @param    WP $WP
-     * @return    void
-     */
-    public function run($WP)
-    {
-    }
+	/**
+	 * run - initial module setup
+	 *
+	 * @param    WP $WP
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+	}
 
 
-    /**
-     * Conditionally set constants if they haven't been defined yet.
-     */
-    public static function setDefinitions()
-    {
-        if (! defined('EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH')) {
-            define(
-                'EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH',
-                str_replace('\\', DS, plugin_dir_path(__FILE__)) . 'templates/'
-            );
-            define('EVENT_ARCHIVE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
-        }
-    }
+	/**
+	 * Conditionally set constants if they haven't been defined yet.
+	 */
+	public static function setDefinitions()
+	{
+		if (! defined('EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH')) {
+			define(
+				'EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH',
+				str_replace('\\', DS, plugin_dir_path(__FILE__)) . 'templates/'
+			);
+			define('EVENT_ARCHIVE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
+		}
+	}
 
 
-    /**
-     * @return void
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function template_settings_form()
-    {
-        // grab general settings admin page and remove the existing hook callback
-        $gen_set_admin = EE_Registry::instance()->LIB->EE_Admin_Page_Loader->get_admin_page_object('general_settings');
-        if ($gen_set_admin instanceof General_Settings_Admin_Page) {
-            remove_action(
-                'AHEE__template_settings__template__before_settings_form',
-                array($gen_set_admin, 'template_settings_caff_features'),
-                100
-            );
-        }
-        // first just grab the template settings
-        $config = EE_Registry::instance()->CFG->template_settings;
-        // then if the Event Archive config is valid, use that, else create a new one
-        $config = $config instanceof EE_Template_Config
-                  && $config->EED_Events_Archive instanceof EE_Events_Archive_Config
-            ? $config->EED_Events_Archive
-            : new EE_Events_Archive_Config();
-        $config = apply_filters(
-            'FHEE__EED_Events_Archive__template_settings_form__event_list_config',
-            $config
-        );
-        $config->display_status_banner = isset($config->display_status_banner)
-            ? $config->display_status_banner
-            : 0;
-        $config->display_description = isset($config->display_description)
-            ? $config->display_description
-            : 1;
-        $config->display_ticket_selector = isset($config->display_ticket_selector)
-            ? $config->display_ticket_selector
-            : 0;
-        $config->display_datetimes = isset($config->display_datetimes)
-            ? $config->display_datetimes
-            : 1;
-        $config->display_venue = isset($config->display_venue)
-            ? $config->display_venue
-            : 0;
-        $config->display_expired_events = isset($config->display_expired_events)
-            ? $config->display_expired_events
-            : 0;
-        // display order options
-        $config->use_sortable_display_order = isset($config->use_sortable_display_order)
-            ? $config->use_sortable_display_order
-            : false;
-        $config->display_order_tickets = isset($config->display_order_tickets)
-            ? $config->display_order_tickets
-            : 120;
-        $config->display_order_datetimes = isset($config->display_order_datetimes)
-            ? $config->display_order_datetimes
-            : 110;
-        $config->display_order_event = isset($config->display_order_event)
-            ? $config->display_order_event
-            : 100;
-        $config->display_order_venue = isset($config->display_order_venue)
-            ? $config->display_order_venue
-            : 130;
-        // get template parts
-        $template_parts = EED_Events_Archive::instance()->initialize_template_parts($config);
-        // convert to array so that we can add more properties
-        $config = get_object_vars($config);
-        $config['event_archive_display_order'] = $template_parts->generate_sortable_list_of_template_parts(
-            'event-archive-sortable-js',
-            '',
-            'archive-sortable-li archive-sortable-js'
-        );
-        EEH_Template::display_template(
-            EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH . 'admin-event-list-settings.template.php',
-            $config
-        );
-    }
+	/**
+	 * @return void
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function template_settings_form()
+	{
+		// grab general settings admin page and remove the existing hook callback
+		$gen_set_admin = EE_Registry::instance()->LIB->EE_Admin_Page_Loader->get_admin_page_object('general_settings');
+		if ($gen_set_admin instanceof General_Settings_Admin_Page) {
+			remove_action(
+				'AHEE__template_settings__template__before_settings_form',
+				array($gen_set_admin, 'template_settings_caff_features'),
+				100
+			);
+		}
+		// first just grab the template settings
+		$config = EE_Registry::instance()->CFG->template_settings;
+		// then if the Event Archive config is valid, use that, else create a new one
+		$config = $config instanceof EE_Template_Config
+				  && $config->EED_Events_Archive instanceof EE_Events_Archive_Config
+			? $config->EED_Events_Archive
+			: new EE_Events_Archive_Config();
+		$config = apply_filters(
+			'FHEE__EED_Events_Archive__template_settings_form__event_list_config',
+			$config
+		);
+		$config->display_status_banner = isset($config->display_status_banner)
+			? $config->display_status_banner
+			: 0;
+		$config->display_description = isset($config->display_description)
+			? $config->display_description
+			: 1;
+		$config->display_ticket_selector = isset($config->display_ticket_selector)
+			? $config->display_ticket_selector
+			: 0;
+		$config->display_datetimes = isset($config->display_datetimes)
+			? $config->display_datetimes
+			: 1;
+		$config->display_venue = isset($config->display_venue)
+			? $config->display_venue
+			: 0;
+		$config->display_expired_events = isset($config->display_expired_events)
+			? $config->display_expired_events
+			: 0;
+		// display order options
+		$config->use_sortable_display_order = isset($config->use_sortable_display_order)
+			? $config->use_sortable_display_order
+			: false;
+		$config->display_order_tickets = isset($config->display_order_tickets)
+			? $config->display_order_tickets
+			: 120;
+		$config->display_order_datetimes = isset($config->display_order_datetimes)
+			? $config->display_order_datetimes
+			: 110;
+		$config->display_order_event = isset($config->display_order_event)
+			? $config->display_order_event
+			: 100;
+		$config->display_order_venue = isset($config->display_order_venue)
+			? $config->display_order_venue
+			: 130;
+		// get template parts
+		$template_parts = EED_Events_Archive::instance()->initialize_template_parts($config);
+		// convert to array so that we can add more properties
+		$config = get_object_vars($config);
+		$config['event_archive_display_order'] = $template_parts->generate_sortable_list_of_template_parts(
+			'event-archive-sortable-js',
+			'',
+			'archive-sortable-li archive-sortable-js'
+		);
+		EEH_Template::display_template(
+			EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH . 'admin-event-list-settings.template.php',
+			$config
+		);
+	}
 
 
-    /**
-     * @param EE_Template_Config $CFG
-     * @param array              $REQ
-     * @return EE_Template_Config
-     */
-    public static function update_template_settings($CFG, $REQ)
-    {
-        /** @var EE_Events_Archive_Config $config */
-        $config = $CFG->EED_Events_Archive instanceof EE_Events_Archive_Config
-            ? $CFG->EED_Events_Archive
-            : new EE_Events_Archive_Config();
-        // unless we are resetting the config...
-        if (
-            ! isset($REQ['EED_Events_Archive_reset_event_list_settings'])
-            || absint($REQ['EED_Events_Archive_reset_event_list_settings']) !== 1
-        ) {
-            $config->display_status_banner = isset($REQ['EED_Events_Archive_display_status_banner'])
-                ? absint($REQ['EED_Events_Archive_display_status_banner'])
-                : 0;
-            $config->display_description = isset($REQ['EED_Events_Archive_display_description'])
-                ? absint($REQ['EED_Events_Archive_display_description'])
-                : 1;
-            $config->display_ticket_selector = isset($REQ['EED_Events_Archive_display_ticket_selector'])
-                ? absint($REQ['EED_Events_Archive_display_ticket_selector'])
-                : 0;
-            $config->display_datetimes = isset($REQ['EED_Events_Archive_display_datetimes'])
-                ? absint($REQ['EED_Events_Archive_display_datetimes'])
-                : 1;
-            $config->display_venue = isset($REQ['EED_Events_Archive_display_venue'])
-                ? absint($REQ['EED_Events_Archive_display_venue'])
-                : 0;
-            $config->display_expired_events = isset($REQ['EED_Events_Archive_display_expired_events'])
-                ? absint($REQ['EED_Events_Archive_display_expired_events'])
-                : 0;
-            $config->use_sortable_display_order = isset($REQ['EED_Events_Archive_use_sortable_display_order'])
-                ? absint($REQ['EED_Events_Archive_use_sortable_display_order'])
-                : 0;
-            $config->display_order_event = $config->display_order_event !== null
-                                           && $config->use_sortable_display_order
-                ? $config->display_order_event
-                : EED_Events_Archive::EVENT_DETAILS_PRIORITY;
-            $config->display_order_datetimes = $config->display_order_datetimes !== null
-                                               && $config->use_sortable_display_order
-                ? $config->display_order_datetimes
-                : EED_Events_Archive::EVENT_DATETIMES_PRIORITY;
-            $config->display_order_tickets = $config->display_order_tickets !== null
-                                             && $config->use_sortable_display_order
-                ? $config->display_order_tickets
-                : EED_Events_Archive::EVENT_TICKETS_PRIORITY;
-            $config->display_order_venue = $config->display_order_venue !== null
-                                           && $config->use_sortable_display_order
-                ? $config->display_order_venue
-                : EED_Events_Archive::EVENT_VENUES_PRIORITY;
-        }
-        $CFG->EED_Events_Archive = $config;
-        do_action('AHEE__EED_Events_Archive__update_template_settings__after_update', $CFG, $REQ);
-        return $CFG;
-    }
+	/**
+	 * @param EE_Template_Config $CFG
+	 * @param array              $REQ
+	 * @return EE_Template_Config
+	 */
+	public static function update_template_settings($CFG, $REQ)
+	{
+		/** @var EE_Events_Archive_Config $config */
+		$config = $CFG->EED_Events_Archive instanceof EE_Events_Archive_Config
+			? $CFG->EED_Events_Archive
+			: new EE_Events_Archive_Config();
+		// unless we are resetting the config...
+		if (
+			! isset($REQ['EED_Events_Archive_reset_event_list_settings'])
+			|| absint($REQ['EED_Events_Archive_reset_event_list_settings']) !== 1
+		) {
+			$config->display_status_banner = isset($REQ['EED_Events_Archive_display_status_banner'])
+				? absint($REQ['EED_Events_Archive_display_status_banner'])
+				: 0;
+			$config->display_description = isset($REQ['EED_Events_Archive_display_description'])
+				? absint($REQ['EED_Events_Archive_display_description'])
+				: 1;
+			$config->display_ticket_selector = isset($REQ['EED_Events_Archive_display_ticket_selector'])
+				? absint($REQ['EED_Events_Archive_display_ticket_selector'])
+				: 0;
+			$config->display_datetimes = isset($REQ['EED_Events_Archive_display_datetimes'])
+				? absint($REQ['EED_Events_Archive_display_datetimes'])
+				: 1;
+			$config->display_venue = isset($REQ['EED_Events_Archive_display_venue'])
+				? absint($REQ['EED_Events_Archive_display_venue'])
+				: 0;
+			$config->display_expired_events = isset($REQ['EED_Events_Archive_display_expired_events'])
+				? absint($REQ['EED_Events_Archive_display_expired_events'])
+				: 0;
+			$config->use_sortable_display_order = isset($REQ['EED_Events_Archive_use_sortable_display_order'])
+				? absint($REQ['EED_Events_Archive_use_sortable_display_order'])
+				: 0;
+			$config->display_order_event = $config->display_order_event !== null
+										   && $config->use_sortable_display_order
+				? $config->display_order_event
+				: EED_Events_Archive::EVENT_DETAILS_PRIORITY;
+			$config->display_order_datetimes = $config->display_order_datetimes !== null
+											   && $config->use_sortable_display_order
+				? $config->display_order_datetimes
+				: EED_Events_Archive::EVENT_DATETIMES_PRIORITY;
+			$config->display_order_tickets = $config->display_order_tickets !== null
+											 && $config->use_sortable_display_order
+				? $config->display_order_tickets
+				: EED_Events_Archive::EVENT_TICKETS_PRIORITY;
+			$config->display_order_venue = $config->display_order_venue !== null
+										   && $config->use_sortable_display_order
+				? $config->display_order_venue
+				: EED_Events_Archive::EVENT_VENUES_PRIORITY;
+		}
+		$CFG->EED_Events_Archive = $config;
+		do_action('AHEE__EED_Events_Archive__update_template_settings__after_update', $CFG, $REQ);
+		return $CFG;
+	}
 
 
-    /**
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function update_event_archive_order()
-    {
-        /** @var EE_Config $config */
-        $config = EE_Registry::instance()->CFG;
-        $config_saved = false;
-        $template_parts = EED_Events_Archive_Caff::getRequest()->getRequestParam('elements');
-        if (! empty($template_parts)) {
-            $template_parts = explode(',', trim($template_parts, ','));
-            foreach ($template_parts as $key => $template_part) {
-                $template_part = "display_order_$template_part";
-                $priority = ($key * 10) + EED_Events_Archive::EVENT_DETAILS_PRIORITY;
-                if (
-                    $config->template_settings->EED_Events_Archive instanceof EE_Events_Archive_Config
-                    && property_exists(
-                        $config->template_settings->EED_Events_Archive,
-                        $template_part
-                    )
-                ) {
-                    $config->template_settings->EED_Events_Archive->{$template_part} = $priority;
-                }
-                do_action("AHEE__EED_Events_Archive__update_event_archive_order__$template_part", $priority);
-            }
-            $config_saved = $config->update_espresso_config(false, false);
-        }
-        if ($config_saved) {
-            EE_Error::add_success(esc_html__('Display Order has been successfully updated.', 'event_espresso'));
-        } else {
-            EE_Error::add_error(
-                esc_html__('Display Order was not updated.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        echo wp_json_encode(EE_Error::get_notices(false));
-        exit();
-    }
+	/**
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function update_event_archive_order()
+	{
+		/** @var EE_Config $config */
+		$config = EE_Registry::instance()->CFG;
+		$config_saved = false;
+		$template_parts = EED_Events_Archive_Caff::getRequest()->getRequestParam('elements');
+		if (! empty($template_parts)) {
+			$template_parts = explode(',', trim($template_parts, ','));
+			foreach ($template_parts as $key => $template_part) {
+				$template_part = "display_order_$template_part";
+				$priority = ($key * 10) + EED_Events_Archive::EVENT_DETAILS_PRIORITY;
+				if (
+					$config->template_settings->EED_Events_Archive instanceof EE_Events_Archive_Config
+					&& property_exists(
+						$config->template_settings->EED_Events_Archive,
+						$template_part
+					)
+				) {
+					$config->template_settings->EED_Events_Archive->{$template_part} = $priority;
+				}
+				do_action("AHEE__EED_Events_Archive__update_event_archive_order__$template_part", $priority);
+			}
+			$config_saved = $config->update_espresso_config(false, false);
+		}
+		if ($config_saved) {
+			EE_Error::add_success(esc_html__('Display Order has been successfully updated.', 'event_espresso'));
+		} else {
+			EE_Error::add_error(
+				esc_html__('Display Order was not updated.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		echo wp_json_encode(EE_Error::get_notices(false));
+		exit();
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -79,12 +79,12 @@ 
      */
     public static function setDefinitions()
     {
-        if (! defined('EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH')) {
+        if ( ! defined('EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH')) {
             define(
                 'EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH',
-                str_replace('\\', DS, plugin_dir_path(__FILE__)) . 'templates/'
+                str_replace('\\', DS, plugin_dir_path(__FILE__)).'templates/'
             );
-            define('EVENT_ARCHIVE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
+            define('EVENT_ARCHIVE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__).'assets/');
         }
     }
 
@@ -162,7 +162,7 @@ 
             'archive-sortable-li archive-sortable-js'
         );
         EEH_Template::display_template(
-            EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH . 'admin-event-list-settings.template.php',
+            EVENTS_ARCHIVE_CAFF_TEMPLATES_PATH.'admin-event-list-settings.template.php',
             $config
         );
     }
@@ -240,7 +240,7 @@ 
         $config = EE_Registry::instance()->CFG;
         $config_saved = false;
         $template_parts = EED_Events_Archive_Caff::getRequest()->getRequestParam('elements');
-        if (! empty($template_parts)) {
+        if ( ! empty($template_parts)) {
             $template_parts = explode(',', trim($template_parts, ','));
             foreach ($template_parts as $key => $template_part) {
                 $template_part = "display_order_$template_part";

caffeinated/modules/recaptcha/EED_Recaptcha.module.php

Indentation +378 added lines, -378 removed lines

@@ -18,382 +18,382 @@
 class EED_Recaptcha extends EED_Module
 {
 
-    /**
-     * @var EE_Registration_Config $config
-     */
-    private static $config;
-
-    /**
-     * @type bool $_not_a_robot
-     */
-    private static $_not_a_robot;
-
-    /**
-     * @type string $_recaptcha_response
-     */
-    private static $_recaptcha_response;
-
-
-    /**
-     * @return EED_Module|EED_Recaptcha
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function set_hooks()
-    {
-        EED_Recaptcha::$config = EE_Registry::instance()->CFG->registration;
-        // use_captcha ?
-        if (
-            EED_Recaptcha::useRecaptcha()
-            && EED_Recaptcha::notPaymentOptionsRevisit()
-        ) {
-            EED_Recaptcha::set_definitions();
-            EED_Recaptcha::enqueue_styles_and_scripts();
-            add_action('wp', array('EED_Recaptcha', 'set_late_hooks'), 1, 0);
-            add_action(
-                'AHEE__before_spco_whats_next_buttons',
-                array('EED_Recaptcha', 'display_recaptcha'),
-                10,
-                0
-            );
-            add_filter(
-                'FHEE__EED_Single_Page_Checkout__init___continue_reg',
-                array('EED_Recaptcha', 'not_a_robot')
-            );
-            add_filter(
-                'FHEE__EE_SPCO_Reg_Step__set_completed___completed',
-                array('EED_Recaptcha', 'not_a_robot')
-            );
-            add_filter(
-                'FHEE__EE_SPCO_JSON_Response___toString__JSON_response',
-                array('EED_Recaptcha', 'recaptcha_response')
-            );
-            add_filter(
-                'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
-                array('EED_Recaptcha', 'bypass_recaptcha_for_spco_load_payment_method')
-            );
-        }
-    }
-
-
-    /**
-     * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function set_hooks_admin()
-    {
-        EED_Recaptcha::$config = EE_Registry::instance()->CFG->registration;
-        EED_Recaptcha::set_definitions();
-        // use_captcha ?
-        if (
-            EED_Recaptcha::useRecaptcha()
-            && EED_Recaptcha::notPaymentOptionsRevisit()
-            && EED_Recaptcha::getRequest()->getRequestParam('step', '') !== ''
-        ) {
-            EED_Recaptcha::enqueue_styles_and_scripts();
-            add_filter(
-                'FHEE__EED_Single_Page_Checkout__init___continue_reg',
-                array('EED_Recaptcha', 'not_a_robot')
-            );
-            add_filter(
-                'FHEE__EE_SPCO_Reg_Step__set_completed___completed',
-                array('EED_Recaptcha', 'not_a_robot')
-            );
-            add_filter(
-                'FHEE__EE_SPCO_JSON_Response___toString__JSON_response',
-                array('EED_Recaptcha', 'recaptcha_response')
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function set_definitions()
-    {
-        if (is_user_logged_in()) {
-            EED_Recaptcha::$_not_a_robot = true;
-        }
-        define(
-            'RECAPTCHA_BASE_PATH',
-            rtrim(str_replace(array('\\', '/'), '/', plugin_dir_path(__FILE__)), '/') . '/'
-        );
-        define('RECAPTCHA_BASE_URL', plugin_dir_url(__FILE__));
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function set_late_hooks()
-    {
-        add_filter(
-            'FHEE__Single_Page_Checkout__translate_js_strings__ajax_submit',
-            array('EED_Recaptcha', 'not_a_robot')
-        );
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public static function useRecaptcha()
-    {
-        return EED_Recaptcha::$config->use_captcha
-               && EED_Recaptcha::$config->recaptcha_theme !== 'invisible';
-    }
-
-
-    /**
-     * @return boolean
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function notPaymentOptionsRevisit()
-    {
-        $request = EED_Recaptcha::getRequest();
-        return ! (
-            $request->getRequestParam('step', '') === 'payment_options'
-            && $request->getRequestParam('revisit', false, 'bool') === true
-        );
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function enqueue_styles_and_scripts()
-    {
-        wp_register_script(
-            'espresso_recaptcha',
-            RECAPTCHA_BASE_URL . 'scripts/espresso_recaptcha.js',
-            array('single_page_checkout'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_script(
-            'google_recaptcha',
-            'https://www.google.com/recaptcha/api.js?hl=' . EED_Recaptcha::$config->recaptcha_language,
-            array('espresso_recaptcha'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        EE_Registry::$i18n_js_strings['no_SPCO_error'] = __(
-            'It appears the Single Page Checkout javascript was not loaded properly! Please refresh the page and try again or contact support.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['no_recaptcha_error'] = __(
-            'There appears to be a problem with the reCAPTCHA configuration! Please check the admin settings or contact support.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['recaptcha_fail'] = __(
-            'Please complete the anti-spam test before proceeding.',
-            'event_espresso'
-        );
-    }
-
-
-    /**
-     * @param WP $WP
-     */
-    public function run($WP)
-    {
-    }
-
-
-    /**
-     * @return boolean
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function not_a_robot()
-    {
-        return is_bool(EED_Recaptcha::$_not_a_robot)
-            ? EED_Recaptcha::$_not_a_robot
-            : EED_Recaptcha::recaptcha_passed();
-    }
-
-
-    /**
-     * @return void
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function display_recaptcha()
-    {
-        // logged in means you have already passed a turing test of sorts
-        if (is_user_logged_in()) {
-            return;
-        }
-        // don't display if not using recaptcha or user is logged in
-        if (EED_Recaptcha::useRecaptcha() && ! EED_Recaptcha::$_not_a_robot) {
-            // only display if they have NOT passed the test yet
-            EEH_Template::display_template(
-                RECAPTCHA_BASE_PATH . '/templates/recaptcha.template.php',
-                array(
-                    'recaptcha_publickey' => EED_Recaptcha::$config->recaptcha_publickey,
-                    'recaptcha_theme'     => EED_Recaptcha::$config->recaptcha_theme,
-                    'recaptcha_type'      => EED_Recaptcha::$config->recaptcha_type,
-                )
-            );
-            wp_enqueue_script('google_recaptcha');
-        }
-    }
-
-
-    /**
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function bypass_recaptcha_for_spco_load_payment_method()
-    {
-        return array(
-            'EESID'  => EE_Registry::instance()->SSN->id(),
-            'step'   => 'payment_options',
-            'action' => 'switch_spco_billing_form',
-        );
-    }
-
-
-    /**
-     * @return boolean
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function recaptcha_passed()
-    {
-        // logged in means you have already passed a turing test of sorts
-        if (is_user_logged_in() || EED_Recaptcha::_bypass_recaptcha()) {
-            return true;
-        }
-        // was test already passed?
-        $recaptcha_passed = EE_Registry::instance()->SSN->get_session_data('recaptcha_passed');
-        $recaptcha_passed = filter_var($recaptcha_passed, FILTER_VALIDATE_BOOLEAN);
-        // verify recaptcha
-        EED_Recaptcha::_get_recaptcha_response();
-        if (! $recaptcha_passed && EED_Recaptcha::$_recaptcha_response) {
-            $recaptcha_passed = EED_Recaptcha::_process_recaptcha_response();
-            EE_Registry::instance()->SSN->set_session_data(array('recaptcha_passed' => $recaptcha_passed));
-        }
-        EED_Recaptcha::$_not_a_robot = $recaptcha_passed;
-        return $recaptcha_passed;
-    }
-
-
-    /**
-     * @param array $recaptcha_response
-     * @return array
-     */
-    public static function recaptcha_response($recaptcha_response = array())
-    {
-        if (EED_Recaptcha::_bypass_recaptcha()) {
-            $recaptcha_response['bypass_recaptcha'] = true;
-            $recaptcha_response['recaptcha_passed'] = true;
-        } else {
-            $recaptcha_response['recaptcha_passed'] = EED_Recaptcha::$_not_a_robot;
-        }
-        return $recaptcha_response;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    private static function _bypass_recaptcha()
-    {
-        // an array of key value pairs that must match exactly with the incoming request,
-        // in order to bypass recaptcha for the current request ONLY
-        $bypass_request_params_array = (array) apply_filters(
-            'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
-            array()
-        );
-        // does $bypass_request_params_array have any values ?
-        if (empty($bypass_request_params_array)) {
-            return false;
-        }
-        $request = EED_Recaptcha::getRequest();
-        // initially set bypass to TRUE
-        $bypass_recaptcha = true;
-        foreach ($bypass_request_params_array as $key => $value) {
-            // if $key is not found or value doesn't match exactly, then toggle bypass to FALSE,
-            // otherwise carry over it's value. This way, one missed setting results in no bypass
-            $bypass_recaptcha = $request->getRequestParam($key) === $value
-                ? $bypass_recaptcha
-                : false;
-        }
-        return $bypass_recaptcha;
-    }
-
-
-    /**
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    private static function _get_recaptcha_response()
-    {
-        EED_Recaptcha::$_recaptcha_response = EED_Recaptcha::getRequest()->getRequestParam(
-            'g-recaptcha-response'
-        );
-    }
-
-
-    /**
-     * @return boolean
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    private static function _process_recaptcha_response()
-    {
-        // verify library is loaded
-        if (! class_exists('\ReCaptcha\ReCaptcha')) {
-            require_once RECAPTCHA_BASE_PATH . '/autoload.php';
-        }
-        // The response from reCAPTCHA
-        EED_Recaptcha::_get_recaptcha_response();
-        $recaptcha_response = EED_Recaptcha::$_recaptcha_response;
-        // Was there a reCAPTCHA response?
-        if ($recaptcha_response) {
-            // if allow_url_fopen is Off, then set a different request method
-            $request_method = ! ini_get('allow_url_fopen') ? new SocketPost() : null;
-            $recaptcha = new ReCaptcha(
-                EED_Recaptcha::$config->recaptcha_privatekey,
-                $request_method
-            );
-            $recaptcha_response = $recaptcha->verify(
-                EED_Recaptcha::$_recaptcha_response,
-                EED_Recaptcha::getRequest()->getServerParam('REMOTE_ADDR')
-            );
-        }
-        return $recaptcha_response instanceof Response && $recaptcha_response->isSuccess();
-    }
+	/**
+	 * @var EE_Registration_Config $config
+	 */
+	private static $config;
+
+	/**
+	 * @type bool $_not_a_robot
+	 */
+	private static $_not_a_robot;
+
+	/**
+	 * @type string $_recaptcha_response
+	 */
+	private static $_recaptcha_response;
+
+
+	/**
+	 * @return EED_Module|EED_Recaptcha
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function set_hooks()
+	{
+		EED_Recaptcha::$config = EE_Registry::instance()->CFG->registration;
+		// use_captcha ?
+		if (
+			EED_Recaptcha::useRecaptcha()
+			&& EED_Recaptcha::notPaymentOptionsRevisit()
+		) {
+			EED_Recaptcha::set_definitions();
+			EED_Recaptcha::enqueue_styles_and_scripts();
+			add_action('wp', array('EED_Recaptcha', 'set_late_hooks'), 1, 0);
+			add_action(
+				'AHEE__before_spco_whats_next_buttons',
+				array('EED_Recaptcha', 'display_recaptcha'),
+				10,
+				0
+			);
+			add_filter(
+				'FHEE__EED_Single_Page_Checkout__init___continue_reg',
+				array('EED_Recaptcha', 'not_a_robot')
+			);
+			add_filter(
+				'FHEE__EE_SPCO_Reg_Step__set_completed___completed',
+				array('EED_Recaptcha', 'not_a_robot')
+			);
+			add_filter(
+				'FHEE__EE_SPCO_JSON_Response___toString__JSON_response',
+				array('EED_Recaptcha', 'recaptcha_response')
+			);
+			add_filter(
+				'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
+				array('EED_Recaptcha', 'bypass_recaptcha_for_spco_load_payment_method')
+			);
+		}
+	}
+
+
+	/**
+	 * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function set_hooks_admin()
+	{
+		EED_Recaptcha::$config = EE_Registry::instance()->CFG->registration;
+		EED_Recaptcha::set_definitions();
+		// use_captcha ?
+		if (
+			EED_Recaptcha::useRecaptcha()
+			&& EED_Recaptcha::notPaymentOptionsRevisit()
+			&& EED_Recaptcha::getRequest()->getRequestParam('step', '') !== ''
+		) {
+			EED_Recaptcha::enqueue_styles_and_scripts();
+			add_filter(
+				'FHEE__EED_Single_Page_Checkout__init___continue_reg',
+				array('EED_Recaptcha', 'not_a_robot')
+			);
+			add_filter(
+				'FHEE__EE_SPCO_Reg_Step__set_completed___completed',
+				array('EED_Recaptcha', 'not_a_robot')
+			);
+			add_filter(
+				'FHEE__EE_SPCO_JSON_Response___toString__JSON_response',
+				array('EED_Recaptcha', 'recaptcha_response')
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function set_definitions()
+	{
+		if (is_user_logged_in()) {
+			EED_Recaptcha::$_not_a_robot = true;
+		}
+		define(
+			'RECAPTCHA_BASE_PATH',
+			rtrim(str_replace(array('\\', '/'), '/', plugin_dir_path(__FILE__)), '/') . '/'
+		);
+		define('RECAPTCHA_BASE_URL', plugin_dir_url(__FILE__));
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function set_late_hooks()
+	{
+		add_filter(
+			'FHEE__Single_Page_Checkout__translate_js_strings__ajax_submit',
+			array('EED_Recaptcha', 'not_a_robot')
+		);
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public static function useRecaptcha()
+	{
+		return EED_Recaptcha::$config->use_captcha
+			   && EED_Recaptcha::$config->recaptcha_theme !== 'invisible';
+	}
+
+
+	/**
+	 * @return boolean
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function notPaymentOptionsRevisit()
+	{
+		$request = EED_Recaptcha::getRequest();
+		return ! (
+			$request->getRequestParam('step', '') === 'payment_options'
+			&& $request->getRequestParam('revisit', false, 'bool') === true
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function enqueue_styles_and_scripts()
+	{
+		wp_register_script(
+			'espresso_recaptcha',
+			RECAPTCHA_BASE_URL . 'scripts/espresso_recaptcha.js',
+			array('single_page_checkout'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_script(
+			'google_recaptcha',
+			'https://www.google.com/recaptcha/api.js?hl=' . EED_Recaptcha::$config->recaptcha_language,
+			array('espresso_recaptcha'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		EE_Registry::$i18n_js_strings['no_SPCO_error'] = __(
+			'It appears the Single Page Checkout javascript was not loaded properly! Please refresh the page and try again or contact support.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['no_recaptcha_error'] = __(
+			'There appears to be a problem with the reCAPTCHA configuration! Please check the admin settings or contact support.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['recaptcha_fail'] = __(
+			'Please complete the anti-spam test before proceeding.',
+			'event_espresso'
+		);
+	}
+
+
+	/**
+	 * @param WP $WP
+	 */
+	public function run($WP)
+	{
+	}
+
+
+	/**
+	 * @return boolean
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function not_a_robot()
+	{
+		return is_bool(EED_Recaptcha::$_not_a_robot)
+			? EED_Recaptcha::$_not_a_robot
+			: EED_Recaptcha::recaptcha_passed();
+	}
+
+
+	/**
+	 * @return void
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function display_recaptcha()
+	{
+		// logged in means you have already passed a turing test of sorts
+		if (is_user_logged_in()) {
+			return;
+		}
+		// don't display if not using recaptcha or user is logged in
+		if (EED_Recaptcha::useRecaptcha() && ! EED_Recaptcha::$_not_a_robot) {
+			// only display if they have NOT passed the test yet
+			EEH_Template::display_template(
+				RECAPTCHA_BASE_PATH . '/templates/recaptcha.template.php',
+				array(
+					'recaptcha_publickey' => EED_Recaptcha::$config->recaptcha_publickey,
+					'recaptcha_theme'     => EED_Recaptcha::$config->recaptcha_theme,
+					'recaptcha_type'      => EED_Recaptcha::$config->recaptcha_type,
+				)
+			);
+			wp_enqueue_script('google_recaptcha');
+		}
+	}
+
+
+	/**
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function bypass_recaptcha_for_spco_load_payment_method()
+	{
+		return array(
+			'EESID'  => EE_Registry::instance()->SSN->id(),
+			'step'   => 'payment_options',
+			'action' => 'switch_spco_billing_form',
+		);
+	}
+
+
+	/**
+	 * @return boolean
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function recaptcha_passed()
+	{
+		// logged in means you have already passed a turing test of sorts
+		if (is_user_logged_in() || EED_Recaptcha::_bypass_recaptcha()) {
+			return true;
+		}
+		// was test already passed?
+		$recaptcha_passed = EE_Registry::instance()->SSN->get_session_data('recaptcha_passed');
+		$recaptcha_passed = filter_var($recaptcha_passed, FILTER_VALIDATE_BOOLEAN);
+		// verify recaptcha
+		EED_Recaptcha::_get_recaptcha_response();
+		if (! $recaptcha_passed && EED_Recaptcha::$_recaptcha_response) {
+			$recaptcha_passed = EED_Recaptcha::_process_recaptcha_response();
+			EE_Registry::instance()->SSN->set_session_data(array('recaptcha_passed' => $recaptcha_passed));
+		}
+		EED_Recaptcha::$_not_a_robot = $recaptcha_passed;
+		return $recaptcha_passed;
+	}
+
+
+	/**
+	 * @param array $recaptcha_response
+	 * @return array
+	 */
+	public static function recaptcha_response($recaptcha_response = array())
+	{
+		if (EED_Recaptcha::_bypass_recaptcha()) {
+			$recaptcha_response['bypass_recaptcha'] = true;
+			$recaptcha_response['recaptcha_passed'] = true;
+		} else {
+			$recaptcha_response['recaptcha_passed'] = EED_Recaptcha::$_not_a_robot;
+		}
+		return $recaptcha_response;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	private static function _bypass_recaptcha()
+	{
+		// an array of key value pairs that must match exactly with the incoming request,
+		// in order to bypass recaptcha for the current request ONLY
+		$bypass_request_params_array = (array) apply_filters(
+			'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
+			array()
+		);
+		// does $bypass_request_params_array have any values ?
+		if (empty($bypass_request_params_array)) {
+			return false;
+		}
+		$request = EED_Recaptcha::getRequest();
+		// initially set bypass to TRUE
+		$bypass_recaptcha = true;
+		foreach ($bypass_request_params_array as $key => $value) {
+			// if $key is not found or value doesn't match exactly, then toggle bypass to FALSE,
+			// otherwise carry over it's value. This way, one missed setting results in no bypass
+			$bypass_recaptcha = $request->getRequestParam($key) === $value
+				? $bypass_recaptcha
+				: false;
+		}
+		return $bypass_recaptcha;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	private static function _get_recaptcha_response()
+	{
+		EED_Recaptcha::$_recaptcha_response = EED_Recaptcha::getRequest()->getRequestParam(
+			'g-recaptcha-response'
+		);
+	}
+
+
+	/**
+	 * @return boolean
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	private static function _process_recaptcha_response()
+	{
+		// verify library is loaded
+		if (! class_exists('\ReCaptcha\ReCaptcha')) {
+			require_once RECAPTCHA_BASE_PATH . '/autoload.php';
+		}
+		// The response from reCAPTCHA
+		EED_Recaptcha::_get_recaptcha_response();
+		$recaptcha_response = EED_Recaptcha::$_recaptcha_response;
+		// Was there a reCAPTCHA response?
+		if ($recaptcha_response) {
+			// if allow_url_fopen is Off, then set a different request method
+			$request_method = ! ini_get('allow_url_fopen') ? new SocketPost() : null;
+			$recaptcha = new ReCaptcha(
+				EED_Recaptcha::$config->recaptcha_privatekey,
+				$request_method
+			);
+			$recaptcha_response = $recaptcha->verify(
+				EED_Recaptcha::$_recaptcha_response,
+				EED_Recaptcha::getRequest()->getServerParam('REMOTE_ADDR')
+			);
+		}
+		return $recaptcha_response instanceof Response && $recaptcha_response->isSuccess();
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -133,7 +133,7 @@ 
         }
         define(
             'RECAPTCHA_BASE_PATH',
-            rtrim(str_replace(array('\\', '/'), '/', plugin_dir_path(__FILE__)), '/') . '/'
+            rtrim(str_replace(array('\\', '/'), '/', plugin_dir_path(__FILE__)), '/').'/'
         );
         define('RECAPTCHA_BASE_URL', plugin_dir_url(__FILE__));
     }
@@ -187,14 +187,14 @@ 
     {
         wp_register_script(
             'espresso_recaptcha',
-            RECAPTCHA_BASE_URL . 'scripts/espresso_recaptcha.js',
+            RECAPTCHA_BASE_URL.'scripts/espresso_recaptcha.js',
             array('single_page_checkout'),
             EVENT_ESPRESSO_VERSION,
             true
         );
         wp_register_script(
             'google_recaptcha',
-            'https://www.google.com/recaptcha/api.js?hl=' . EED_Recaptcha::$config->recaptcha_language,
+            'https://www.google.com/recaptcha/api.js?hl='.EED_Recaptcha::$config->recaptcha_language,
             array('espresso_recaptcha'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -253,7 +253,7 @@ 
         if (EED_Recaptcha::useRecaptcha() && ! EED_Recaptcha::$_not_a_robot) {
             // only display if they have NOT passed the test yet
             EEH_Template::display_template(
-                RECAPTCHA_BASE_PATH . '/templates/recaptcha.template.php',
+                RECAPTCHA_BASE_PATH.'/templates/recaptcha.template.php',
                 array(
                     'recaptcha_publickey' => EED_Recaptcha::$config->recaptcha_publickey,
                     'recaptcha_theme'     => EED_Recaptcha::$config->recaptcha_theme,
@@ -298,7 +298,7 @@ 
         $recaptcha_passed = filter_var($recaptcha_passed, FILTER_VALIDATE_BOOLEAN);
         // verify recaptcha
         EED_Recaptcha::_get_recaptcha_response();
-        if (! $recaptcha_passed && EED_Recaptcha::$_recaptcha_response) {
+        if ( ! $recaptcha_passed && EED_Recaptcha::$_recaptcha_response) {
             $recaptcha_passed = EED_Recaptcha::_process_recaptcha_response();
             EE_Registry::instance()->SSN->set_session_data(array('recaptcha_passed' => $recaptcha_passed));
         }
@@ -375,8 +375,8 @@ 
     private static function _process_recaptcha_response()
     {
         // verify library is loaded
-        if (! class_exists('\ReCaptcha\ReCaptcha')) {
-            require_once RECAPTCHA_BASE_PATH . '/autoload.php';
+        if ( ! class_exists('\ReCaptcha\ReCaptcha')) {
+            require_once RECAPTCHA_BASE_PATH.'/autoload.php';
         }
         // The response from reCAPTCHA
         EED_Recaptcha::_get_recaptcha_response();