Completed
Branch dependabot/npm_and_yarn/@wordp... (e9f48b)
by
unknown
60:52 queued 52:34
created
modules/invalid_checkout_access/InvalidCheckoutAccess.php 2 patches
Indentation   +168 added lines, -168 removed lines patch added patch discarded remove patch
@@ -13,178 +13,178 @@
 block discarded – undo
13 13
 class InvalidCheckoutAccess
14 14
 {
15 15
 
16
-    /**
17
-     * key used for saving invalid checkout access data to the wp_options table
18
-     */
19
-    const OPTION_KEY = 'ee_invalid_checkout_access';
16
+	/**
17
+	 * key used for saving invalid checkout access data to the wp_options table
18
+	 */
19
+	const OPTION_KEY = 'ee_invalid_checkout_access';
20 20
 
21 21
 
22
-    /**
23
-     * _block_bots
24
-     * checks that the incoming request has either of the following set:
25
-     *  a uts (unix timestamp) which indicates that the request was redirected from the Ticket Selector
26
-     *  a REG URL Link, which indicates that the request is a return visit to SPCO for a valid TXN
27
-     * so if you're not coming from the Ticket Selector nor returning for a valid IP...
28
-     * then where you coming from man?
29
-     *
30
-     * @param \EE_Checkout $checkout
31
-     * @return bool true if access to registration checkout appears to be invalid
32
-     */
33
-    public function checkoutAccessIsInvalid(\EE_Checkout $checkout)
34
-    {
35
-        if (! ($checkout->uts || $checkout->reg_url_link)
36
-            && ! (defined('DOING_AJAX') && DOING_AJAX)
37
-            && \EE_Config::instance()->registration->track_invalid_checkout_access()
38
-        ) {
39
-            /** @var \EE_Request $request */
40
-            $request = \EE_Registry::instance()->load_core('EE_Request');
41
-            $ip_address = $request->ip_address();
42
-            $ee_bot_checkout = get_option(InvalidCheckoutAccess::OPTION_KEY);
43
-            if ($ee_bot_checkout === false) {
44
-                $ee_bot_checkout = array();
45
-                add_option(InvalidCheckoutAccess::OPTION_KEY, $ee_bot_checkout, '', false);
46
-            }
47
-            if (! isset($ee_bot_checkout[ $ip_address ])) {
48
-                $ee_bot_checkout[ $ip_address ] = array();
49
-            }
50
-            $http_referer = isset($_SERVER['HTTP_REFERER'])
51
-                ? esc_attr($_SERVER['HTTP_REFERER'])
52
-                : 0;
53
-            if (! isset($ee_bot_checkout[ $ip_address ][ $http_referer ])) {
54
-                $ee_bot_checkout[ $ip_address ][ $http_referer ] = 0;
55
-            }
56
-            $ee_bot_checkout[ $ip_address ][ $http_referer ]++;
57
-            update_option(InvalidCheckoutAccess::OPTION_KEY, $ee_bot_checkout);
58
-            if (WP_DEBUG) {
59
-                \EE_Error::add_error(
60
-                    esc_html__('Direct access to the registration checkout page is not allowed.', 'event_espresso'),
61
-                    __FILE__,
62
-                    __FUNCTION__,
63
-                    __LINE__
64
-                );
65
-            }
66
-            return true;
67
-        }
68
-        return false;
69
-    }
22
+	/**
23
+	 * _block_bots
24
+	 * checks that the incoming request has either of the following set:
25
+	 *  a uts (unix timestamp) which indicates that the request was redirected from the Ticket Selector
26
+	 *  a REG URL Link, which indicates that the request is a return visit to SPCO for a valid TXN
27
+	 * so if you're not coming from the Ticket Selector nor returning for a valid IP...
28
+	 * then where you coming from man?
29
+	 *
30
+	 * @param \EE_Checkout $checkout
31
+	 * @return bool true if access to registration checkout appears to be invalid
32
+	 */
33
+	public function checkoutAccessIsInvalid(\EE_Checkout $checkout)
34
+	{
35
+		if (! ($checkout->uts || $checkout->reg_url_link)
36
+			&& ! (defined('DOING_AJAX') && DOING_AJAX)
37
+			&& \EE_Config::instance()->registration->track_invalid_checkout_access()
38
+		) {
39
+			/** @var \EE_Request $request */
40
+			$request = \EE_Registry::instance()->load_core('EE_Request');
41
+			$ip_address = $request->ip_address();
42
+			$ee_bot_checkout = get_option(InvalidCheckoutAccess::OPTION_KEY);
43
+			if ($ee_bot_checkout === false) {
44
+				$ee_bot_checkout = array();
45
+				add_option(InvalidCheckoutAccess::OPTION_KEY, $ee_bot_checkout, '', false);
46
+			}
47
+			if (! isset($ee_bot_checkout[ $ip_address ])) {
48
+				$ee_bot_checkout[ $ip_address ] = array();
49
+			}
50
+			$http_referer = isset($_SERVER['HTTP_REFERER'])
51
+				? esc_attr($_SERVER['HTTP_REFERER'])
52
+				: 0;
53
+			if (! isset($ee_bot_checkout[ $ip_address ][ $http_referer ])) {
54
+				$ee_bot_checkout[ $ip_address ][ $http_referer ] = 0;
55
+			}
56
+			$ee_bot_checkout[ $ip_address ][ $http_referer ]++;
57
+			update_option(InvalidCheckoutAccess::OPTION_KEY, $ee_bot_checkout);
58
+			if (WP_DEBUG) {
59
+				\EE_Error::add_error(
60
+					esc_html__('Direct access to the registration checkout page is not allowed.', 'event_espresso'),
61
+					__FILE__,
62
+					__FUNCTION__,
63
+					__LINE__
64
+				);
65
+			}
66
+			return true;
67
+		}
68
+		return false;
69
+	}
70 70
 
71 71
 
72
-    /**
73
-     * _invalid_checkout_access_form
74
-     *
75
-     * @return \EE_Form_Section_Proper
76
-     * @throws \EE_Error
77
-     */
78
-    public function getForm()
79
-    {
80
-        return new \EE_Form_Section_Proper(
81
-            array(
82
-                'name'            => 'invalid_checkout_access',
83
-                'html_id'         => 'invalid_checkout_access',
84
-                'layout_strategy' => new \EE_Admin_Two_Column_Layout(),
85
-                'subsections'     => array(
86
-                    'invalid_checkout_access_hdr'   => new \EE_Form_Section_HTML(
87
-                        \EEH_HTML::h2(esc_html__('Invalid Checkout Access', 'event_espresso'))
88
-                    ),
89
-                    'ee_bot_checkout_data'          => new \EE_Text_Area_Input(
90
-                        array(
91
-                            'html_label_text' => esc_html__('Invalid Checkout Data', 'event_espresso'),
92
-                            'default'         => var_export(
93
-                                get_option(InvalidCheckoutAccess::OPTION_KEY, array()),
94
-                                true
95
-                            ),
96
-                            'required'        => false,
97
-                            'html_help_text'  => esc_html__(
98
-                                'Event Espresso blocks any attempt to directly access the registration checkout page, that is NOT from a Ticket Selector or for a return visit for a valid transaction. These are not valid requests accessing your checkout page, so we track the IP addresses, what web page they just came from, and the number of times that they have attempted to access your registration page. This information may help you with protecting your site by other means, such as firewalls, etc, but please note that IP addresses are almost guaranteed to be spoofed by malicious agents.',
99
-                                'event_espresso'
100
-                            ),
101
-                        )
102
-                    ),
103
-                    'track_invalid_checkout_access' => new \EE_Yes_No_Input(
104
-                        array(
105
-                            'html_label_text'         => __('Track Invalid Checkout Access?', 'event_espresso'),
106
-                            'html_help_text'          => esc_html__(
107
-                                'Controls whether or not invalid attempts to directly access the registration checkout page should be tracked. Setting this to "No" means that the above data will no longer be collected.',
108
-                                'event_espresso'
109
-                            ),
110
-                            'default'                 => \EE_Config::instance()
111
-                                ->registration
112
-                                ->track_invalid_checkout_access(),
113
-                            'display_html_label_text' => false,
114
-                        )
115
-                    ),
116
-                    'delete_invalid_checkout_data'  => new \EE_Yes_No_Input(
117
-                        array(
118
-                            'html_label_text'         => __('Reset Invalid Checkout Data', 'event_espresso'),
119
-                            'html_help_text'          => esc_html__(
120
-                                'Setting this to "Yes" will delete all existing invalid checkout access data.',
121
-                                'event_espresso'
122
-                            ),
123
-                            'default'                 => false,
124
-                            'display_html_label_text' => false,
125
-                        )
126
-                    ),
127
-                ),
128
-            )
129
-        );
130
-    }
72
+	/**
73
+	 * _invalid_checkout_access_form
74
+	 *
75
+	 * @return \EE_Form_Section_Proper
76
+	 * @throws \EE_Error
77
+	 */
78
+	public function getForm()
79
+	{
80
+		return new \EE_Form_Section_Proper(
81
+			array(
82
+				'name'            => 'invalid_checkout_access',
83
+				'html_id'         => 'invalid_checkout_access',
84
+				'layout_strategy' => new \EE_Admin_Two_Column_Layout(),
85
+				'subsections'     => array(
86
+					'invalid_checkout_access_hdr'   => new \EE_Form_Section_HTML(
87
+						\EEH_HTML::h2(esc_html__('Invalid Checkout Access', 'event_espresso'))
88
+					),
89
+					'ee_bot_checkout_data'          => new \EE_Text_Area_Input(
90
+						array(
91
+							'html_label_text' => esc_html__('Invalid Checkout Data', 'event_espresso'),
92
+							'default'         => var_export(
93
+								get_option(InvalidCheckoutAccess::OPTION_KEY, array()),
94
+								true
95
+							),
96
+							'required'        => false,
97
+							'html_help_text'  => esc_html__(
98
+								'Event Espresso blocks any attempt to directly access the registration checkout page, that is NOT from a Ticket Selector or for a return visit for a valid transaction. These are not valid requests accessing your checkout page, so we track the IP addresses, what web page they just came from, and the number of times that they have attempted to access your registration page. This information may help you with protecting your site by other means, such as firewalls, etc, but please note that IP addresses are almost guaranteed to be spoofed by malicious agents.',
99
+								'event_espresso'
100
+							),
101
+						)
102
+					),
103
+					'track_invalid_checkout_access' => new \EE_Yes_No_Input(
104
+						array(
105
+							'html_label_text'         => __('Track Invalid Checkout Access?', 'event_espresso'),
106
+							'html_help_text'          => esc_html__(
107
+								'Controls whether or not invalid attempts to directly access the registration checkout page should be tracked. Setting this to "No" means that the above data will no longer be collected.',
108
+								'event_espresso'
109
+							),
110
+							'default'                 => \EE_Config::instance()
111
+								->registration
112
+								->track_invalid_checkout_access(),
113
+							'display_html_label_text' => false,
114
+						)
115
+					),
116
+					'delete_invalid_checkout_data'  => new \EE_Yes_No_Input(
117
+						array(
118
+							'html_label_text'         => __('Reset Invalid Checkout Data', 'event_espresso'),
119
+							'html_help_text'          => esc_html__(
120
+								'Setting this to "Yes" will delete all existing invalid checkout access data.',
121
+								'event_espresso'
122
+							),
123
+							'default'                 => false,
124
+							'display_html_label_text' => false,
125
+						)
126
+					),
127
+				),
128
+			)
129
+		);
130
+	}
131 131
 
132 132
 
133
-    /**
134
-     * update_invalid_checkout_access_form
135
-     *
136
-     * @param \EE_Registration_Config $EE_Registration_Config
137
-     * @return \EE_Registration_Config
138
-     */
139
-    public function processForm(\EE_Registration_Config $EE_Registration_Config)
140
-    {
141
-        try {
142
-            $invalid_checkout_access_form = $this->getForm();
143
-            // if not displaying a form, then check for form submission
144
-            if ($invalid_checkout_access_form->was_submitted()) {
145
-                // capture form data
146
-                $invalid_checkout_access_form->receive_form_submission();
147
-                // validate form data
148
-                if ($invalid_checkout_access_form->is_valid()) {
149
-                    // grab validated data from form
150
-                    $valid_data = $invalid_checkout_access_form->valid_data();
151
-                    // ensure form inputs we want are set
152
-                    if (isset(
153
-                        $valid_data['track_invalid_checkout_access'],
154
-                        $valid_data['delete_invalid_checkout_data']
155
-                    )) {
156
-                        $EE_Registration_Config->set_track_invalid_checkout_access(
157
-                            $valid_data['track_invalid_checkout_access']
158
-                        );
159
-                        // if deleting, then update option with empty array
160
-                        if (filter_var($valid_data['delete_invalid_checkout_data'], FILTER_VALIDATE_BOOLEAN)) {
161
-                            update_option(InvalidCheckoutAccess::OPTION_KEY, array());
162
-                        }
163
-                    } else {
164
-                        \EE_Error::add_error(
165
-                            esc_html__(
166
-                                'Invalid or missing Invalid Checkout Access form data. Please refresh the form and try again.',
167
-                                'event_espresso'
168
-                            ),
169
-                            __FILE__,
170
-                            __FUNCTION__,
171
-                            __LINE__
172
-                        );
173
-                    }
174
-                } else {
175
-                    if ($invalid_checkout_access_form->submission_error_message() !== '') {
176
-                        \EE_Error::add_error(
177
-                            $invalid_checkout_access_form->submission_error_message(),
178
-                            __FILE__,
179
-                            __FUNCTION__,
180
-                            __LINE__
181
-                        );
182
-                    }
183
-                }
184
-            }
185
-        } catch (\EE_Error $e) {
186
-            $e->get_error();
187
-        }
188
-        return $EE_Registration_Config;
189
-    }
133
+	/**
134
+	 * update_invalid_checkout_access_form
135
+	 *
136
+	 * @param \EE_Registration_Config $EE_Registration_Config
137
+	 * @return \EE_Registration_Config
138
+	 */
139
+	public function processForm(\EE_Registration_Config $EE_Registration_Config)
140
+	{
141
+		try {
142
+			$invalid_checkout_access_form = $this->getForm();
143
+			// if not displaying a form, then check for form submission
144
+			if ($invalid_checkout_access_form->was_submitted()) {
145
+				// capture form data
146
+				$invalid_checkout_access_form->receive_form_submission();
147
+				// validate form data
148
+				if ($invalid_checkout_access_form->is_valid()) {
149
+					// grab validated data from form
150
+					$valid_data = $invalid_checkout_access_form->valid_data();
151
+					// ensure form inputs we want are set
152
+					if (isset(
153
+						$valid_data['track_invalid_checkout_access'],
154
+						$valid_data['delete_invalid_checkout_data']
155
+					)) {
156
+						$EE_Registration_Config->set_track_invalid_checkout_access(
157
+							$valid_data['track_invalid_checkout_access']
158
+						);
159
+						// if deleting, then update option with empty array
160
+						if (filter_var($valid_data['delete_invalid_checkout_data'], FILTER_VALIDATE_BOOLEAN)) {
161
+							update_option(InvalidCheckoutAccess::OPTION_KEY, array());
162
+						}
163
+					} else {
164
+						\EE_Error::add_error(
165
+							esc_html__(
166
+								'Invalid or missing Invalid Checkout Access form data. Please refresh the form and try again.',
167
+								'event_espresso'
168
+							),
169
+							__FILE__,
170
+							__FUNCTION__,
171
+							__LINE__
172
+						);
173
+					}
174
+				} else {
175
+					if ($invalid_checkout_access_form->submission_error_message() !== '') {
176
+						\EE_Error::add_error(
177
+							$invalid_checkout_access_form->submission_error_message(),
178
+							__FILE__,
179
+							__FUNCTION__,
180
+							__LINE__
181
+						);
182
+					}
183
+				}
184
+			}
185
+		} catch (\EE_Error $e) {
186
+			$e->get_error();
187
+		}
188
+		return $EE_Registration_Config;
189
+	}
190 190
 }
Please login to merge, or discard this patch.
Spacing   +6 added lines, -6 removed lines patch added patch discarded remove patch
@@ -32,7 +32,7 @@  discard block
 block discarded – undo
32 32
      */
33 33
     public function checkoutAccessIsInvalid(\EE_Checkout $checkout)
34 34
     {
35
-        if (! ($checkout->uts || $checkout->reg_url_link)
35
+        if ( ! ($checkout->uts || $checkout->reg_url_link)
36 36
             && ! (defined('DOING_AJAX') && DOING_AJAX)
37 37
             && \EE_Config::instance()->registration->track_invalid_checkout_access()
38 38
         ) {
@@ -44,16 +44,16 @@  discard block
 block discarded – undo
44 44
                 $ee_bot_checkout = array();
45 45
                 add_option(InvalidCheckoutAccess::OPTION_KEY, $ee_bot_checkout, '', false);
46 46
             }
47
-            if (! isset($ee_bot_checkout[ $ip_address ])) {
48
-                $ee_bot_checkout[ $ip_address ] = array();
47
+            if ( ! isset($ee_bot_checkout[$ip_address])) {
48
+                $ee_bot_checkout[$ip_address] = array();
49 49
             }
50 50
             $http_referer = isset($_SERVER['HTTP_REFERER'])
51 51
                 ? esc_attr($_SERVER['HTTP_REFERER'])
52 52
                 : 0;
53
-            if (! isset($ee_bot_checkout[ $ip_address ][ $http_referer ])) {
54
-                $ee_bot_checkout[ $ip_address ][ $http_referer ] = 0;
53
+            if ( ! isset($ee_bot_checkout[$ip_address][$http_referer])) {
54
+                $ee_bot_checkout[$ip_address][$http_referer] = 0;
55 55
             }
56
-            $ee_bot_checkout[ $ip_address ][ $http_referer ]++;
56
+            $ee_bot_checkout[$ip_address][$http_referer]++;
57 57
             update_option(InvalidCheckoutAccess::OPTION_KEY, $ee_bot_checkout);
58 58
             if (WP_DEBUG) {
59 59
                 \EE_Error::add_error(
Please login to merge, or discard this patch.
modules/ticket_selector/DisplayTicketSelector.php 2 patches
Indentation   +710 added lines, -710 removed lines patch added patch discarded remove patch
@@ -33,717 +33,717 @@
 block discarded – undo
33 33
 class DisplayTicketSelector
34 34
 {
35 35
 
36
-    /**
37
-     * event that ticket selector is being generated for
38
-     *
39
-     * @access protected
40
-     * @var EE_Event $event
41
-     */
42
-    protected $event;
43
-
44
-    /**
45
-     * Used to flag when the ticket selector is being called from an external iframe.
46
-     *
47
-     * @var bool $iframe
48
-     */
49
-    protected $iframe = false;
50
-
51
-    /**
52
-     * max attendees that can register for event at one time
53
-     *
54
-     * @var int $max_attendees
55
-     */
56
-    private $max_attendees = EE_INF;
57
-
58
-    /**
59
-     * @var string $date_format
60
-     */
61
-    private $date_format;
62
-
63
-    /**
64
-     * @var string $time_format
65
-     */
66
-    private $time_format;
67
-
68
-    /**
69
-     * @var boolean $display_full_ui
70
-     */
71
-    private $display_full_ui;
72
-
73
-
74
-    /**
75
-     * DisplayTicketSelector constructor.
76
-     *
77
-     * @param bool $iframe
78
-     */
79
-    public function __construct($iframe = false)
80
-    {
81
-        $this->iframe = $iframe;
82
-        $this->date_format = apply_filters(
83
-            'FHEE__EED_Ticket_Selector__display_ticket_selector__date_format',
84
-            get_option('date_format')
85
-        );
86
-        $this->time_format = apply_filters(
87
-            'FHEE__EED_Ticket_Selector__display_ticket_selector__time_format',
88
-            get_option('time_format')
89
-        );
90
-    }
91
-
92
-
93
-    /**
94
-     * @return bool
95
-     */
96
-    public function isIframe()
97
-    {
98
-        return $this->iframe;
99
-    }
100
-
101
-
102
-    /**
103
-     * @param boolean $iframe
104
-     */
105
-    public function setIframe($iframe = true)
106
-    {
107
-        $this->iframe = filter_var($iframe, FILTER_VALIDATE_BOOLEAN);
108
-    }
109
-
110
-
111
-    /**
112
-     * finds and sets the \EE_Event object for use throughout class
113
-     *
114
-     * @param mixed $event
115
-     * @return bool
116
-     * @throws EE_Error
117
-     * @throws InvalidDataTypeException
118
-     * @throws InvalidInterfaceException
119
-     * @throws InvalidArgumentException
120
-     */
121
-    protected function setEvent($event = null)
122
-    {
123
-        if ($event === null) {
124
-            global $post;
125
-            $event = $post;
126
-        }
127
-        if ($event instanceof EE_Event) {
128
-            $this->event = $event;
129
-        } elseif ($event instanceof WP_Post) {
130
-            if (isset($event->EE_Event) && $event->EE_Event instanceof EE_Event) {
131
-                $this->event = $event->EE_Event;
132
-            } elseif ($event->post_type === 'espresso_events') {
133
-                $event->EE_Event = EEM_Event::instance()->instantiate_class_from_post_object($event);
134
-                $this->event = $event->EE_Event;
135
-            }
136
-        } else {
137
-            $user_msg = __('No Event object or an invalid Event object was supplied.', 'event_espresso');
138
-            $dev_msg = $user_msg . __(
139
-                'In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
140
-                'event_espresso'
141
-            );
142
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
143
-            return false;
144
-        }
145
-        return true;
146
-    }
147
-
148
-
149
-    /**
150
-     * @return int
151
-     */
152
-    public function getMaxAttendees()
153
-    {
154
-        return $this->max_attendees;
155
-    }
156
-
157
-
158
-    /**
159
-     * @param int $max_attendees
160
-     */
161
-    public function setMaxAttendees($max_attendees)
162
-    {
163
-        $this->max_attendees = absint(
164
-            apply_filters(
165
-                'FHEE__EE_Ticket_Selector__display_ticket_selector__max_tickets',
166
-                $max_attendees
167
-            )
168
-        );
169
-    }
170
-
171
-
172
-    /**
173
-     * Returns whether or not the full ticket selector should be shown or not.
174
-     * Currently, it displays on the frontend (including ajax requests) but not the backend
175
-     *
176
-     * @return bool
177
-     */
178
-    private function display_full_ui()
179
-    {
180
-        if ($this->display_full_ui === null) {
181
-            $this->display_full_ui = ! is_admin() || (defined('DOING_AJAX') && DOING_AJAX);
182
-        }
183
-        return $this->display_full_ui;
184
-    }
185
-
186
-
187
-    /**
188
-     * creates buttons for selecting number of attendees for an event
189
-     *
190
-     * @param WP_Post|int $event
191
-     * @param bool        $view_details
192
-     * @return string
193
-     * @throws EE_Error
194
-     * @throws InvalidArgumentException
195
-     * @throws InvalidDataTypeException
196
-     * @throws InvalidInterfaceException
197
-     */
198
-    public function display($event = null, $view_details = false)
199
-    {
200
-        // reset filter for displaying submit button
201
-        remove_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
202
-        // poke and prod incoming event till it tells us what it is
203
-        if (! $this->setEvent($event)) {
204
-            return false;
205
-        }
206
-        // begin gathering template arguments by getting event status
207
-        $template_args = array('event_status' => $this->event->get_active_status());
208
-        if ($this->activeEventAndShowTicketSelector(
209
-            $event,
210
-            $template_args['event_status'],
211
-            $view_details
212
-        )) {
213
-            return ! is_single() ? $this->displayViewDetailsButton() : '';
214
-        }
215
-        // filter the maximum qty that can appear in the Ticket Selector qty dropdowns
216
-        $this->setMaxAttendees($this->event->additional_limit());
217
-        if ($this->getMaxAttendees() < 1) {
218
-            return $this->ticketSalesClosedMessage();
219
-        }
220
-        // is the event expired ?
221
-        $template_args['event_is_expired'] = $this->event->is_expired();
222
-        if ($template_args['event_is_expired']) {
223
-            return $this->expiredEventMessage();
224
-        }
225
-        // get all tickets for this event ordered by the datetime
226
-        $tickets = $this->getTickets();
227
-        if (count($tickets) < 1) {
228
-            return $this->noTicketAvailableMessage();
229
-        }
230
-        // redirecting to another site for registration ??
231
-        $external_url = (string) $this->event->external_url();
232
-        // if redirecting to another site for registration, then we don't load the TS
233
-        $ticket_selector = $external_url
234
-            ? $this->externalEventRegistration()
235
-            : $this->loadTicketSelector($tickets, $template_args);
236
-        // now set up the form (but not for the admin)
237
-        $ticket_selector = $this->display_full_ui()
238
-            ? $this->formOpen($this->event->ID(), $external_url) . $ticket_selector
239
-            : $ticket_selector;
240
-        // submit button and form close tag
241
-        $ticket_selector .= $this->display_full_ui() ? $this->displaySubmitButton($external_url) : '';
242
-        return $ticket_selector;
243
-    }
244
-
245
-
246
-    /**
247
-     * displayTicketSelector
248
-     * examines the event properties and determines whether a Ticket Selector should be displayed
249
-     *
250
-     * @param WP_Post|int $event
251
-     * @param string      $_event_active_status
252
-     * @param bool        $view_details
253
-     * @return bool
254
-     * @throws EE_Error
255
-     */
256
-    protected function activeEventAndShowTicketSelector($event, $_event_active_status, $view_details)
257
-    {
258
-        $event_post = $this->event instanceof EE_Event ? $this->event->ID() : $event;
259
-        return $this->display_full_ui()
260
-               && (
261
-                   ! $this->event->display_ticket_selector()
262
-                   || $view_details
263
-                   || post_password_required($event_post)
264
-                   || (
265
-                       $_event_active_status !== EE_Datetime::active
266
-                       && $_event_active_status !== EE_Datetime::upcoming
267
-                       && $_event_active_status !== EE_Datetime::sold_out
268
-                       && ! (
269
-                           $_event_active_status === EE_Datetime::inactive
270
-                           && is_user_logged_in()
271
-                       )
272
-                   )
273
-               );
274
-    }
275
-
276
-
277
-    /**
278
-     * noTicketAvailableMessage
279
-     * notice displayed if event is expired
280
-     *
281
-     * @return string
282
-     * @throws EE_Error
283
-     */
284
-    protected function expiredEventMessage()
285
-    {
286
-        return '<div class="ee-event-expired-notice"><span class="important-notice">' . esc_html__(
287
-            'We\'re sorry, but all tickets sales have ended because the event is expired.',
288
-            'event_espresso'
289
-        ) . '</span></div><!-- .ee-event-expired-notice -->';
290
-    }
291
-
292
-
293
-    /**
294
-     * noTicketAvailableMessage
295
-     * notice displayed if event has no more tickets available
296
-     *
297
-     * @return string
298
-     * @throws EE_Error
299
-     */
300
-    protected function noTicketAvailableMessage()
301
-    {
302
-        $no_ticket_available_msg = esc_html__('We\'re sorry, but all ticket sales have ended.', 'event_espresso');
303
-        if (current_user_can('edit_post', $this->event->ID())) {
304
-            $no_ticket_available_msg .= sprintf(
305
-                esc_html__(
306
-                    '%1$sNote to Event Admin:%2$sNo tickets were found for this event. This effectively turns off ticket sales. Please ensure that at least one ticket is available for if you want people to be able to register.%3$s(click to edit this event)%4$s',
307
-                    'event_espresso'
308
-                ),
309
-                '<div class="ee-attention" style="text-align: left;"><b>',
310
-                '</b><br />',
311
-                '<span class="edit-link"><a class="post-edit-link" href="'
312
-                . get_edit_post_link($this->event->ID())
313
-                . '">',
314
-                '</a></span></div><!-- .ee-attention noTicketAvailableMessage -->'
315
-            );
316
-        }
317
-        return '
36
+	/**
37
+	 * event that ticket selector is being generated for
38
+	 *
39
+	 * @access protected
40
+	 * @var EE_Event $event
41
+	 */
42
+	protected $event;
43
+
44
+	/**
45
+	 * Used to flag when the ticket selector is being called from an external iframe.
46
+	 *
47
+	 * @var bool $iframe
48
+	 */
49
+	protected $iframe = false;
50
+
51
+	/**
52
+	 * max attendees that can register for event at one time
53
+	 *
54
+	 * @var int $max_attendees
55
+	 */
56
+	private $max_attendees = EE_INF;
57
+
58
+	/**
59
+	 * @var string $date_format
60
+	 */
61
+	private $date_format;
62
+
63
+	/**
64
+	 * @var string $time_format
65
+	 */
66
+	private $time_format;
67
+
68
+	/**
69
+	 * @var boolean $display_full_ui
70
+	 */
71
+	private $display_full_ui;
72
+
73
+
74
+	/**
75
+	 * DisplayTicketSelector constructor.
76
+	 *
77
+	 * @param bool $iframe
78
+	 */
79
+	public function __construct($iframe = false)
80
+	{
81
+		$this->iframe = $iframe;
82
+		$this->date_format = apply_filters(
83
+			'FHEE__EED_Ticket_Selector__display_ticket_selector__date_format',
84
+			get_option('date_format')
85
+		);
86
+		$this->time_format = apply_filters(
87
+			'FHEE__EED_Ticket_Selector__display_ticket_selector__time_format',
88
+			get_option('time_format')
89
+		);
90
+	}
91
+
92
+
93
+	/**
94
+	 * @return bool
95
+	 */
96
+	public function isIframe()
97
+	{
98
+		return $this->iframe;
99
+	}
100
+
101
+
102
+	/**
103
+	 * @param boolean $iframe
104
+	 */
105
+	public function setIframe($iframe = true)
106
+	{
107
+		$this->iframe = filter_var($iframe, FILTER_VALIDATE_BOOLEAN);
108
+	}
109
+
110
+
111
+	/**
112
+	 * finds and sets the \EE_Event object for use throughout class
113
+	 *
114
+	 * @param mixed $event
115
+	 * @return bool
116
+	 * @throws EE_Error
117
+	 * @throws InvalidDataTypeException
118
+	 * @throws InvalidInterfaceException
119
+	 * @throws InvalidArgumentException
120
+	 */
121
+	protected function setEvent($event = null)
122
+	{
123
+		if ($event === null) {
124
+			global $post;
125
+			$event = $post;
126
+		}
127
+		if ($event instanceof EE_Event) {
128
+			$this->event = $event;
129
+		} elseif ($event instanceof WP_Post) {
130
+			if (isset($event->EE_Event) && $event->EE_Event instanceof EE_Event) {
131
+				$this->event = $event->EE_Event;
132
+			} elseif ($event->post_type === 'espresso_events') {
133
+				$event->EE_Event = EEM_Event::instance()->instantiate_class_from_post_object($event);
134
+				$this->event = $event->EE_Event;
135
+			}
136
+		} else {
137
+			$user_msg = __('No Event object or an invalid Event object was supplied.', 'event_espresso');
138
+			$dev_msg = $user_msg . __(
139
+				'In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
140
+				'event_espresso'
141
+			);
142
+			EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
143
+			return false;
144
+		}
145
+		return true;
146
+	}
147
+
148
+
149
+	/**
150
+	 * @return int
151
+	 */
152
+	public function getMaxAttendees()
153
+	{
154
+		return $this->max_attendees;
155
+	}
156
+
157
+
158
+	/**
159
+	 * @param int $max_attendees
160
+	 */
161
+	public function setMaxAttendees($max_attendees)
162
+	{
163
+		$this->max_attendees = absint(
164
+			apply_filters(
165
+				'FHEE__EE_Ticket_Selector__display_ticket_selector__max_tickets',
166
+				$max_attendees
167
+			)
168
+		);
169
+	}
170
+
171
+
172
+	/**
173
+	 * Returns whether or not the full ticket selector should be shown or not.
174
+	 * Currently, it displays on the frontend (including ajax requests) but not the backend
175
+	 *
176
+	 * @return bool
177
+	 */
178
+	private function display_full_ui()
179
+	{
180
+		if ($this->display_full_ui === null) {
181
+			$this->display_full_ui = ! is_admin() || (defined('DOING_AJAX') && DOING_AJAX);
182
+		}
183
+		return $this->display_full_ui;
184
+	}
185
+
186
+
187
+	/**
188
+	 * creates buttons for selecting number of attendees for an event
189
+	 *
190
+	 * @param WP_Post|int $event
191
+	 * @param bool        $view_details
192
+	 * @return string
193
+	 * @throws EE_Error
194
+	 * @throws InvalidArgumentException
195
+	 * @throws InvalidDataTypeException
196
+	 * @throws InvalidInterfaceException
197
+	 */
198
+	public function display($event = null, $view_details = false)
199
+	{
200
+		// reset filter for displaying submit button
201
+		remove_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
202
+		// poke and prod incoming event till it tells us what it is
203
+		if (! $this->setEvent($event)) {
204
+			return false;
205
+		}
206
+		// begin gathering template arguments by getting event status
207
+		$template_args = array('event_status' => $this->event->get_active_status());
208
+		if ($this->activeEventAndShowTicketSelector(
209
+			$event,
210
+			$template_args['event_status'],
211
+			$view_details
212
+		)) {
213
+			return ! is_single() ? $this->displayViewDetailsButton() : '';
214
+		}
215
+		// filter the maximum qty that can appear in the Ticket Selector qty dropdowns
216
+		$this->setMaxAttendees($this->event->additional_limit());
217
+		if ($this->getMaxAttendees() < 1) {
218
+			return $this->ticketSalesClosedMessage();
219
+		}
220
+		// is the event expired ?
221
+		$template_args['event_is_expired'] = $this->event->is_expired();
222
+		if ($template_args['event_is_expired']) {
223
+			return $this->expiredEventMessage();
224
+		}
225
+		// get all tickets for this event ordered by the datetime
226
+		$tickets = $this->getTickets();
227
+		if (count($tickets) < 1) {
228
+			return $this->noTicketAvailableMessage();
229
+		}
230
+		// redirecting to another site for registration ??
231
+		$external_url = (string) $this->event->external_url();
232
+		// if redirecting to another site for registration, then we don't load the TS
233
+		$ticket_selector = $external_url
234
+			? $this->externalEventRegistration()
235
+			: $this->loadTicketSelector($tickets, $template_args);
236
+		// now set up the form (but not for the admin)
237
+		$ticket_selector = $this->display_full_ui()
238
+			? $this->formOpen($this->event->ID(), $external_url) . $ticket_selector
239
+			: $ticket_selector;
240
+		// submit button and form close tag
241
+		$ticket_selector .= $this->display_full_ui() ? $this->displaySubmitButton($external_url) : '';
242
+		return $ticket_selector;
243
+	}
244
+
245
+
246
+	/**
247
+	 * displayTicketSelector
248
+	 * examines the event properties and determines whether a Ticket Selector should be displayed
249
+	 *
250
+	 * @param WP_Post|int $event
251
+	 * @param string      $_event_active_status
252
+	 * @param bool        $view_details
253
+	 * @return bool
254
+	 * @throws EE_Error
255
+	 */
256
+	protected function activeEventAndShowTicketSelector($event, $_event_active_status, $view_details)
257
+	{
258
+		$event_post = $this->event instanceof EE_Event ? $this->event->ID() : $event;
259
+		return $this->display_full_ui()
260
+			   && (
261
+				   ! $this->event->display_ticket_selector()
262
+				   || $view_details
263
+				   || post_password_required($event_post)
264
+				   || (
265
+					   $_event_active_status !== EE_Datetime::active
266
+					   && $_event_active_status !== EE_Datetime::upcoming
267
+					   && $_event_active_status !== EE_Datetime::sold_out
268
+					   && ! (
269
+						   $_event_active_status === EE_Datetime::inactive
270
+						   && is_user_logged_in()
271
+					   )
272
+				   )
273
+			   );
274
+	}
275
+
276
+
277
+	/**
278
+	 * noTicketAvailableMessage
279
+	 * notice displayed if event is expired
280
+	 *
281
+	 * @return string
282
+	 * @throws EE_Error
283
+	 */
284
+	protected function expiredEventMessage()
285
+	{
286
+		return '<div class="ee-event-expired-notice"><span class="important-notice">' . esc_html__(
287
+			'We\'re sorry, but all tickets sales have ended because the event is expired.',
288
+			'event_espresso'
289
+		) . '</span></div><!-- .ee-event-expired-notice -->';
290
+	}
291
+
292
+
293
+	/**
294
+	 * noTicketAvailableMessage
295
+	 * notice displayed if event has no more tickets available
296
+	 *
297
+	 * @return string
298
+	 * @throws EE_Error
299
+	 */
300
+	protected function noTicketAvailableMessage()
301
+	{
302
+		$no_ticket_available_msg = esc_html__('We\'re sorry, but all ticket sales have ended.', 'event_espresso');
303
+		if (current_user_can('edit_post', $this->event->ID())) {
304
+			$no_ticket_available_msg .= sprintf(
305
+				esc_html__(
306
+					'%1$sNote to Event Admin:%2$sNo tickets were found for this event. This effectively turns off ticket sales. Please ensure that at least one ticket is available for if you want people to be able to register.%3$s(click to edit this event)%4$s',
307
+					'event_espresso'
308
+				),
309
+				'<div class="ee-attention" style="text-align: left;"><b>',
310
+				'</b><br />',
311
+				'<span class="edit-link"><a class="post-edit-link" href="'
312
+				. get_edit_post_link($this->event->ID())
313
+				. '">',
314
+				'</a></span></div><!-- .ee-attention noTicketAvailableMessage -->'
315
+			);
316
+		}
317
+		return '
318 318
             <div class="ee-event-expired-notice">
319 319
                 <span class="important-notice">' . $no_ticket_available_msg . '</span>
320 320
             </div><!-- .ee-event-expired-notice -->';
321
-    }
322
-
323
-
324
-    /**
325
-     * ticketSalesClosed
326
-     * notice displayed if event ticket sales are turned off
327
-     *
328
-     * @return string
329
-     * @throws EE_Error
330
-     */
331
-    protected function ticketSalesClosedMessage()
332
-    {
333
-        $sales_closed_msg = esc_html__(
334
-            'We\'re sorry, but ticket sales have been closed at this time. Please check back again later.',
335
-            'event_espresso'
336
-        );
337
-        if (current_user_can('edit_post', $this->event->ID())) {
338
-            $sales_closed_msg .= sprintf(
339
-                esc_html__(
340
-                    '%sNote to Event Admin:%sThe "Maximum number of tickets allowed per order for this event" in the Event Registration Options has been set to "0". This effectively turns off ticket sales. %s(click to edit this event)%s',
341
-                    'event_espresso'
342
-                ),
343
-                '<div class="ee-attention" style="text-align: left;"><b>',
344
-                '</b><br />',
345
-                '<span class="edit-link"><a class="post-edit-link" href="'
346
-                . get_edit_post_link($this->event->ID())
347
-                . '">',
348
-                '</a></span></div><!-- .ee-attention ticketSalesClosedMessage -->'
349
-            );
350
-        }
351
-        return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
352
-    }
353
-
354
-
355
-    /**
356
-     * getTickets
357
-     *
358
-     * @return \EE_Base_Class[]|\EE_Ticket[]
359
-     * @throws EE_Error
360
-     * @throws InvalidDataTypeException
361
-     * @throws InvalidInterfaceException
362
-     * @throws InvalidArgumentException
363
-     */
364
-    protected function getTickets()
365
-    {
366
-        $ticket_query_args = array(
367
-            array('Datetime.EVT_ID' => $this->event->ID()),
368
-            'order_by' => array(
369
-                'TKT_order'              => 'ASC',
370
-                'TKT_required'           => 'DESC',
371
-                'TKT_start_date'         => 'ASC',
372
-                'TKT_end_date'           => 'ASC',
373
-                'Datetime.DTT_EVT_start' => 'DESC',
374
-            ),
375
-        );
376
-        if (! (
377
-            EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config
378
-            && EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector->show_expired_tickets
379
-        )) {
380
-            // use the correct applicable time query depending on what version of core is being run.
381
-            $current_time = method_exists('EEM_Datetime', 'current_time_for_query')
382
-                ? time()
383
-                : current_time('timestamp');
384
-            $ticket_query_args[0]['TKT_end_date'] = array('>', $current_time);
385
-        }
386
-        return EEM_Ticket::instance()->get_all($ticket_query_args);
387
-    }
388
-
389
-
390
-    /**
391
-     * loadTicketSelector
392
-     * begins to assemble template arguments
393
-     * and decides whether to load a "simple" ticket selector, or the standard
394
-     *
395
-     * @param \EE_Ticket[] $tickets
396
-     * @param array        $template_args
397
-     * @return string
398
-     * @throws EE_Error
399
-     */
400
-    protected function loadTicketSelector(array $tickets, array $template_args)
401
-    {
402
-        $template_args['event'] = $this->event;
403
-        $template_args['EVT_ID'] = $this->event->ID();
404
-        $template_args['event_is_expired'] = $this->event->is_expired();
405
-        $template_args['max_atndz'] = $this->getMaxAttendees();
406
-        $template_args['date_format'] = $this->date_format;
407
-        $template_args['time_format'] = $this->time_format;
408
-        /**
409
-         * Filters the anchor ID used when redirecting to the Ticket Selector if no quantity selected
410
-         *
411
-         * @since 4.9.13
412
-         * @param     string  '#tkt-slctr-tbl-' . $EVT_ID The html ID to anchor to
413
-         * @param int $EVT_ID The Event ID
414
-         */
415
-        $template_args['anchor_id'] = apply_filters(
416
-            'FHEE__EE_Ticket_Selector__redirect_anchor_id',
417
-            '#tkt-slctr-tbl-' . $this->event->ID(),
418
-            $this->event->ID()
419
-        );
420
-        $template_args['tickets'] = $tickets;
421
-        $template_args['ticket_count'] = count($tickets);
422
-        $ticket_selector = $this->simpleTicketSelector($tickets, $template_args);
423
-        return $ticket_selector instanceof TicketSelectorSimple
424
-            ? $ticket_selector
425
-            : new TicketSelectorStandard(
426
-                $this->event,
427
-                $tickets,
428
-                $this->getMaxAttendees(),
429
-                $template_args,
430
-                $this->date_format,
431
-                $this->time_format
432
-            );
433
-    }
434
-
435
-
436
-    /**
437
-     * simpleTicketSelector
438
-     * there's one ticket, and max attendees is set to one,
439
-     * so if the event is free, then this is a "simple" ticket selector
440
-     * a.k.a. "Dude Where's my Ticket Selector?"
441
-     *
442
-     * @param \EE_Ticket[] $tickets
443
-     * @param array        $template_args
444
-     * @return string
445
-     * @throws EE_Error
446
-     */
447
-    protected function simpleTicketSelector($tickets, array $template_args)
448
-    {
449
-        // if there is only ONE ticket with a max qty of ONE
450
-        if (count($tickets) > 1 || $this->getMaxAttendees() !== 1) {
451
-            return '';
452
-        }
453
-        /** @var \EE_Ticket $ticket */
454
-        $ticket = reset($tickets);
455
-        // if the ticket is free... then not much need for the ticket selector
456
-        if (apply_filters(
457
-            'FHEE__ticket_selector_chart_template__hide_ticket_selector',
458
-            $ticket->is_free(),
459
-            $this->event->ID()
460
-        )) {
461
-            return new TicketSelectorSimple(
462
-                $this->event,
463
-                $ticket,
464
-                $this->getMaxAttendees(),
465
-                $template_args
466
-            );
467
-        }
468
-        return '';
469
-    }
470
-
471
-
472
-    /**
473
-     * externalEventRegistration
474
-     *
475
-     * @return string
476
-     */
477
-    public function externalEventRegistration()
478
-    {
479
-        // if not we still need to trigger the display of the submit button
480
-        add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
481
-        // display notice to admin that registration is external
482
-        return $this->display_full_ui()
483
-            ? esc_html__(
484
-                'Registration is at an external URL for this event.',
485
-                'event_espresso'
486
-            )
487
-            : '';
488
-    }
489
-
490
-
491
-    /**
492
-     * formOpen
493
-     *
494
-     * @param        int    $ID
495
-     * @param        string $external_url
496
-     * @return        string
497
-     */
498
-    public function formOpen($ID = 0, $external_url = '')
499
-    {
500
-        // if redirecting, we don't need any anything else
501
-        if ($external_url) {
502
-            $html = '<form method="GET" ';
503
-            $html .= 'action="' . EEH_URL::refactor_url($external_url) . '" ';
504
-            $html .= 'name="ticket-selector-form-' . $ID . '"';
505
-            // open link in new window ?
506
-            $html .= apply_filters(
507
-                'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
508
-                $this->isIframe(),
509
-                $this
510
-            )
511
-                ? ' target="_blank"'
512
-                : '';
513
-            $html .= '>';
514
-            $query_args = EEH_URL::get_query_string($external_url);
515
-            foreach ((array) $query_args as $query_arg => $value) {
516
-                $html .= '<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
517
-            }
518
-            return $html;
519
-        }
520
-        // if there is no submit button, then don't start building a form
521
-        // because the "View Details" button will build its own form
522
-        if (! apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
523
-            return '';
524
-        }
525
-        $checkout_url = EEH_Event_View::event_link_url($ID);
526
-        if (! $checkout_url) {
527
-            EE_Error::add_error(
528
-                esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
529
-                __FILE__,
530
-                __FUNCTION__,
531
-                __LINE__
532
-            );
533
-        }
534
-        // set no cache headers and constants
535
-        EE_System::do_not_cache();
536
-        $html = '<form method="POST" ';
537
-        $html .= 'action="' . $checkout_url . '" ';
538
-        $html .= 'name="ticket-selector-form-' . $ID . '"';
539
-        $html .= $this->iframe ? ' target="_blank"' : '';
540
-        $html .= '>';
541
-        $html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
542
-        $html = apply_filters('FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event);
543
-        return $html;
544
-    }
545
-
546
-
547
-    /**
548
-     * displaySubmitButton
549
-     *
550
-     * @param  string $external_url
551
-     * @return string
552
-     * @throws EE_Error
553
-     */
554
-    public function displaySubmitButton($external_url = '')
555
-    {
556
-        $html = '';
557
-        if ($this->display_full_ui()) {
558
-            // standard TS displayed with submit button, ie: "Register Now"
559
-            if (apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
560
-                $html .= $this->displayRegisterNowButton();
561
-                $html .= empty($external_url)
562
-                    ? $this->ticketSelectorEndDiv()
563
-                    : $this->clearTicketSelector();
564
-                $html .= '<br/>' . $this->formClose();
565
-            } elseif ($this->getMaxAttendees() === 1) {
566
-                // its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
567
-                if ($this->event->is_sold_out()) {
568
-                    // then instead of a View Details or Submit button, just display a "Sold Out" message
569
-                    $html .= apply_filters(
570
-                        'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__sold_out_msg',
571
-                        sprintf(
572
-                            __(
573
-                                '%1$s"%2$s" is currently sold out.%4$sPlease check back again later, as spots may become available.%3$s',
574
-                                'event_espresso'
575
-                            ),
576
-                            '<p class="no-ticket-selector-msg clear-float">',
577
-                            $this->event->name(),
578
-                            '</p>',
579
-                            '<br />'
580
-                        ),
581
-                        $this->event
582
-                    );
583
-                    if (apply_filters(
584
-                        'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
585
-                        false,
586
-                        $this->event
587
-                    )) {
588
-                        $html .= $this->displayRegisterNowButton();
589
-                    }
590
-                    // sold out DWMTS event, no TS, no submit or view details button, but has additional content
591
-                    $html .= $this->ticketSelectorEndDiv();
592
-                } elseif (apply_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector', false)
593
-                          && ! is_single()
594
-                ) {
595
-                    // this is a "Dude Where's my Ticket Selector?" (DWMTS) type event,
596
-                    // but no tickets are available, so display event's "View Details" button.
597
-                    // it is being viewed via somewhere other than a single post
598
-                    $html .= $this->displayViewDetailsButton(true);
599
-                } else {
600
-                    $html .= $this->ticketSelectorEndDiv();
601
-                }
602
-            } elseif (is_archive()) {
603
-                // event list, no tickets available so display event's "View Details" button
604
-                $html .= $this->ticketSelectorEndDiv();
605
-                $html .= $this->displayViewDetailsButton();
606
-            } else {
607
-                if (apply_filters(
608
-                    'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
609
-                    false,
610
-                    $this->event
611
-                )) {
612
-                    $html .= $this->displayRegisterNowButton();
613
-                }
614
-                // no submit or view details button, and no additional content
615
-                $html .= $this->ticketSelectorEndDiv();
616
-            }
617
-            if (! $this->iframe && ! is_archive()) {
618
-                $html .= EEH_Template::powered_by_event_espresso('', '', array('utm_content' => 'ticket_selector'));
619
-            }
620
-        }
621
-        return apply_filters(
622
-            'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displaySubmitButton__html',
623
-            $html,
624
-            $this->event,
625
-            $this
626
-        );
627
-    }
628
-
629
-
630
-    /**
631
-     * @return string
632
-     * @throws EE_Error
633
-     */
634
-    public function displayRegisterNowButton()
635
-    {
636
-        $btn_text = apply_filters(
637
-            'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__btn_text',
638
-            __('Register Now', 'event_espresso'),
639
-            $this->event
640
-        );
641
-        $external_url = $this->event->external_url();
642
-        $html = EEH_HTML::div(
643
-            '',
644
-            'ticket-selector-submit-' . $this->event->ID() . '-btn-wrap',
645
-            'ticket-selector-submit-btn-wrap'
646
-        );
647
-        $html .= '<input id="ticket-selector-submit-' . $this->event->ID() . '-btn"';
648
-        $html .= ' class="ticket-selector-submit-btn ';
649
-        $html .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
650
-        $html .= ' type="submit" value="' . $btn_text . '" />';
651
-        $html .= EEH_HTML::divx() . '<!-- .ticket-selector-submit-btn-wrap -->';
652
-        $html .= apply_filters(
653
-            'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
654
-            '',
655
-            $this->event,
656
-            $this->iframe
657
-        );
658
-        return $html;
659
-    }
660
-
661
-
662
-    /**
663
-     * displayViewDetailsButton
664
-     *
665
-     * @param bool $DWMTS indicates a "Dude Where's my Ticket Selector?" (DWMTS) type event
666
-     *                    (ie: $_max_atndz === 1) where there are no available tickets,
667
-     *                    either because they are sold out, expired, or not yet on sale.
668
-     *                    In this case, we need to close the form BEFORE adding any closing divs
669
-     * @return string
670
-     * @throws EE_Error
671
-     */
672
-    public function displayViewDetailsButton($DWMTS = false)
673
-    {
674
-        if (! $this->event->get_permalink()) {
675
-            EE_Error::add_error(
676
-                esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
677
-                __FILE__,
678
-                __FUNCTION__,
679
-                __LINE__
680
-            );
681
-        }
682
-        $view_details_btn = '<form method="POST" action="';
683
-        $view_details_btn .= apply_filters(
684
-            'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_url',
685
-            $this->event->get_permalink(),
686
-            $this->event
687
-        );
688
-        $view_details_btn .= '"';
689
-        // open link in new window ?
690
-        $view_details_btn .= apply_filters(
691
-            'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displayViewDetailsButton__url_target_blank',
692
-            $this->isIframe(),
693
-            $this
694
-        )
695
-            ? ' target="_blank"'
696
-            : '';
697
-        $view_details_btn .= '>';
698
-        $btn_text = apply_filters(
699
-            'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_text',
700
-            esc_html__('View Details', 'event_espresso'),
701
-            $this->event
702
-        );
703
-        $view_details_btn .= '<input id="ticket-selector-submit-'
704
-                             . $this->event->ID()
705
-                             . '-btn" class="ticket-selector-submit-btn view-details-btn" type="submit" value="'
706
-                             . $btn_text
707
-                             . '" />';
708
-        $view_details_btn .= apply_filters('FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event);
709
-        if ($DWMTS) {
710
-            $view_details_btn .= $this->formClose();
711
-            $view_details_btn .= $this->ticketSelectorEndDiv();
712
-            $view_details_btn .= '<br/>';
713
-        } else {
714
-            $view_details_btn .= $this->clearTicketSelector();
715
-            $view_details_btn .= '<br/>';
716
-            $view_details_btn .= $this->formClose();
717
-        }
718
-        return $view_details_btn;
719
-    }
720
-
721
-
722
-    /**
723
-     * @return string
724
-     */
725
-    public function ticketSelectorEndDiv()
726
-    {
727
-        return $this->clearTicketSelector() . '</div><!-- ticketSelectorEndDiv -->';
728
-    }
729
-
730
-
731
-    /**
732
-     * @return string
733
-     */
734
-    public function clearTicketSelector()
735
-    {
736
-        // standard TS displayed, appears after a "Register Now" or "view Details" button
737
-        return '<div class="clear"></div><!-- clearTicketSelector -->';
738
-    }
739
-
740
-
741
-    /**
742
-     * @access        public
743
-     * @return        string
744
-     */
745
-    public function formClose()
746
-    {
747
-        return '</form>';
748
-    }
321
+	}
322
+
323
+
324
+	/**
325
+	 * ticketSalesClosed
326
+	 * notice displayed if event ticket sales are turned off
327
+	 *
328
+	 * @return string
329
+	 * @throws EE_Error
330
+	 */
331
+	protected function ticketSalesClosedMessage()
332
+	{
333
+		$sales_closed_msg = esc_html__(
334
+			'We\'re sorry, but ticket sales have been closed at this time. Please check back again later.',
335
+			'event_espresso'
336
+		);
337
+		if (current_user_can('edit_post', $this->event->ID())) {
338
+			$sales_closed_msg .= sprintf(
339
+				esc_html__(
340
+					'%sNote to Event Admin:%sThe "Maximum number of tickets allowed per order for this event" in the Event Registration Options has been set to "0". This effectively turns off ticket sales. %s(click to edit this event)%s',
341
+					'event_espresso'
342
+				),
343
+				'<div class="ee-attention" style="text-align: left;"><b>',
344
+				'</b><br />',
345
+				'<span class="edit-link"><a class="post-edit-link" href="'
346
+				. get_edit_post_link($this->event->ID())
347
+				. '">',
348
+				'</a></span></div><!-- .ee-attention ticketSalesClosedMessage -->'
349
+			);
350
+		}
351
+		return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
352
+	}
353
+
354
+
355
+	/**
356
+	 * getTickets
357
+	 *
358
+	 * @return \EE_Base_Class[]|\EE_Ticket[]
359
+	 * @throws EE_Error
360
+	 * @throws InvalidDataTypeException
361
+	 * @throws InvalidInterfaceException
362
+	 * @throws InvalidArgumentException
363
+	 */
364
+	protected function getTickets()
365
+	{
366
+		$ticket_query_args = array(
367
+			array('Datetime.EVT_ID' => $this->event->ID()),
368
+			'order_by' => array(
369
+				'TKT_order'              => 'ASC',
370
+				'TKT_required'           => 'DESC',
371
+				'TKT_start_date'         => 'ASC',
372
+				'TKT_end_date'           => 'ASC',
373
+				'Datetime.DTT_EVT_start' => 'DESC',
374
+			),
375
+		);
376
+		if (! (
377
+			EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config
378
+			&& EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector->show_expired_tickets
379
+		)) {
380
+			// use the correct applicable time query depending on what version of core is being run.
381
+			$current_time = method_exists('EEM_Datetime', 'current_time_for_query')
382
+				? time()
383
+				: current_time('timestamp');
384
+			$ticket_query_args[0]['TKT_end_date'] = array('>', $current_time);
385
+		}
386
+		return EEM_Ticket::instance()->get_all($ticket_query_args);
387
+	}
388
+
389
+
390
+	/**
391
+	 * loadTicketSelector
392
+	 * begins to assemble template arguments
393
+	 * and decides whether to load a "simple" ticket selector, or the standard
394
+	 *
395
+	 * @param \EE_Ticket[] $tickets
396
+	 * @param array        $template_args
397
+	 * @return string
398
+	 * @throws EE_Error
399
+	 */
400
+	protected function loadTicketSelector(array $tickets, array $template_args)
401
+	{
402
+		$template_args['event'] = $this->event;
403
+		$template_args['EVT_ID'] = $this->event->ID();
404
+		$template_args['event_is_expired'] = $this->event->is_expired();
405
+		$template_args['max_atndz'] = $this->getMaxAttendees();
406
+		$template_args['date_format'] = $this->date_format;
407
+		$template_args['time_format'] = $this->time_format;
408
+		/**
409
+		 * Filters the anchor ID used when redirecting to the Ticket Selector if no quantity selected
410
+		 *
411
+		 * @since 4.9.13
412
+		 * @param     string  '#tkt-slctr-tbl-' . $EVT_ID The html ID to anchor to
413
+		 * @param int $EVT_ID The Event ID
414
+		 */
415
+		$template_args['anchor_id'] = apply_filters(
416
+			'FHEE__EE_Ticket_Selector__redirect_anchor_id',
417
+			'#tkt-slctr-tbl-' . $this->event->ID(),
418
+			$this->event->ID()
419
+		);
420
+		$template_args['tickets'] = $tickets;
421
+		$template_args['ticket_count'] = count($tickets);
422
+		$ticket_selector = $this->simpleTicketSelector($tickets, $template_args);
423
+		return $ticket_selector instanceof TicketSelectorSimple
424
+			? $ticket_selector
425
+			: new TicketSelectorStandard(
426
+				$this->event,
427
+				$tickets,
428
+				$this->getMaxAttendees(),
429
+				$template_args,
430
+				$this->date_format,
431
+				$this->time_format
432
+			);
433
+	}
434
+
435
+
436
+	/**
437
+	 * simpleTicketSelector
438
+	 * there's one ticket, and max attendees is set to one,
439
+	 * so if the event is free, then this is a "simple" ticket selector
440
+	 * a.k.a. "Dude Where's my Ticket Selector?"
441
+	 *
442
+	 * @param \EE_Ticket[] $tickets
443
+	 * @param array        $template_args
444
+	 * @return string
445
+	 * @throws EE_Error
446
+	 */
447
+	protected function simpleTicketSelector($tickets, array $template_args)
448
+	{
449
+		// if there is only ONE ticket with a max qty of ONE
450
+		if (count($tickets) > 1 || $this->getMaxAttendees() !== 1) {
451
+			return '';
452
+		}
453
+		/** @var \EE_Ticket $ticket */
454
+		$ticket = reset($tickets);
455
+		// if the ticket is free... then not much need for the ticket selector
456
+		if (apply_filters(
457
+			'FHEE__ticket_selector_chart_template__hide_ticket_selector',
458
+			$ticket->is_free(),
459
+			$this->event->ID()
460
+		)) {
461
+			return new TicketSelectorSimple(
462
+				$this->event,
463
+				$ticket,
464
+				$this->getMaxAttendees(),
465
+				$template_args
466
+			);
467
+		}
468
+		return '';
469
+	}
470
+
471
+
472
+	/**
473
+	 * externalEventRegistration
474
+	 *
475
+	 * @return string
476
+	 */
477
+	public function externalEventRegistration()
478
+	{
479
+		// if not we still need to trigger the display of the submit button
480
+		add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
481
+		// display notice to admin that registration is external
482
+		return $this->display_full_ui()
483
+			? esc_html__(
484
+				'Registration is at an external URL for this event.',
485
+				'event_espresso'
486
+			)
487
+			: '';
488
+	}
489
+
490
+
491
+	/**
492
+	 * formOpen
493
+	 *
494
+	 * @param        int    $ID
495
+	 * @param        string $external_url
496
+	 * @return        string
497
+	 */
498
+	public function formOpen($ID = 0, $external_url = '')
499
+	{
500
+		// if redirecting, we don't need any anything else
501
+		if ($external_url) {
502
+			$html = '<form method="GET" ';
503
+			$html .= 'action="' . EEH_URL::refactor_url($external_url) . '" ';
504
+			$html .= 'name="ticket-selector-form-' . $ID . '"';
505
+			// open link in new window ?
506
+			$html .= apply_filters(
507
+				'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
508
+				$this->isIframe(),
509
+				$this
510
+			)
511
+				? ' target="_blank"'
512
+				: '';
513
+			$html .= '>';
514
+			$query_args = EEH_URL::get_query_string($external_url);
515
+			foreach ((array) $query_args as $query_arg => $value) {
516
+				$html .= '<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
517
+			}
518
+			return $html;
519
+		}
520
+		// if there is no submit button, then don't start building a form
521
+		// because the "View Details" button will build its own form
522
+		if (! apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
523
+			return '';
524
+		}
525
+		$checkout_url = EEH_Event_View::event_link_url($ID);
526
+		if (! $checkout_url) {
527
+			EE_Error::add_error(
528
+				esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
529
+				__FILE__,
530
+				__FUNCTION__,
531
+				__LINE__
532
+			);
533
+		}
534
+		// set no cache headers and constants
535
+		EE_System::do_not_cache();
536
+		$html = '<form method="POST" ';
537
+		$html .= 'action="' . $checkout_url . '" ';
538
+		$html .= 'name="ticket-selector-form-' . $ID . '"';
539
+		$html .= $this->iframe ? ' target="_blank"' : '';
540
+		$html .= '>';
541
+		$html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
542
+		$html = apply_filters('FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event);
543
+		return $html;
544
+	}
545
+
546
+
547
+	/**
548
+	 * displaySubmitButton
549
+	 *
550
+	 * @param  string $external_url
551
+	 * @return string
552
+	 * @throws EE_Error
553
+	 */
554
+	public function displaySubmitButton($external_url = '')
555
+	{
556
+		$html = '';
557
+		if ($this->display_full_ui()) {
558
+			// standard TS displayed with submit button, ie: "Register Now"
559
+			if (apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
560
+				$html .= $this->displayRegisterNowButton();
561
+				$html .= empty($external_url)
562
+					? $this->ticketSelectorEndDiv()
563
+					: $this->clearTicketSelector();
564
+				$html .= '<br/>' . $this->formClose();
565
+			} elseif ($this->getMaxAttendees() === 1) {
566
+				// its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
567
+				if ($this->event->is_sold_out()) {
568
+					// then instead of a View Details or Submit button, just display a "Sold Out" message
569
+					$html .= apply_filters(
570
+						'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__sold_out_msg',
571
+						sprintf(
572
+							__(
573
+								'%1$s"%2$s" is currently sold out.%4$sPlease check back again later, as spots may become available.%3$s',
574
+								'event_espresso'
575
+							),
576
+							'<p class="no-ticket-selector-msg clear-float">',
577
+							$this->event->name(),
578
+							'</p>',
579
+							'<br />'
580
+						),
581
+						$this->event
582
+					);
583
+					if (apply_filters(
584
+						'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
585
+						false,
586
+						$this->event
587
+					)) {
588
+						$html .= $this->displayRegisterNowButton();
589
+					}
590
+					// sold out DWMTS event, no TS, no submit or view details button, but has additional content
591
+					$html .= $this->ticketSelectorEndDiv();
592
+				} elseif (apply_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector', false)
593
+						  && ! is_single()
594
+				) {
595
+					// this is a "Dude Where's my Ticket Selector?" (DWMTS) type event,
596
+					// but no tickets are available, so display event's "View Details" button.
597
+					// it is being viewed via somewhere other than a single post
598
+					$html .= $this->displayViewDetailsButton(true);
599
+				} else {
600
+					$html .= $this->ticketSelectorEndDiv();
601
+				}
602
+			} elseif (is_archive()) {
603
+				// event list, no tickets available so display event's "View Details" button
604
+				$html .= $this->ticketSelectorEndDiv();
605
+				$html .= $this->displayViewDetailsButton();
606
+			} else {
607
+				if (apply_filters(
608
+					'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
609
+					false,
610
+					$this->event
611
+				)) {
612
+					$html .= $this->displayRegisterNowButton();
613
+				}
614
+				// no submit or view details button, and no additional content
615
+				$html .= $this->ticketSelectorEndDiv();
616
+			}
617
+			if (! $this->iframe && ! is_archive()) {
618
+				$html .= EEH_Template::powered_by_event_espresso('', '', array('utm_content' => 'ticket_selector'));
619
+			}
620
+		}
621
+		return apply_filters(
622
+			'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displaySubmitButton__html',
623
+			$html,
624
+			$this->event,
625
+			$this
626
+		);
627
+	}
628
+
629
+
630
+	/**
631
+	 * @return string
632
+	 * @throws EE_Error
633
+	 */
634
+	public function displayRegisterNowButton()
635
+	{
636
+		$btn_text = apply_filters(
637
+			'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__btn_text',
638
+			__('Register Now', 'event_espresso'),
639
+			$this->event
640
+		);
641
+		$external_url = $this->event->external_url();
642
+		$html = EEH_HTML::div(
643
+			'',
644
+			'ticket-selector-submit-' . $this->event->ID() . '-btn-wrap',
645
+			'ticket-selector-submit-btn-wrap'
646
+		);
647
+		$html .= '<input id="ticket-selector-submit-' . $this->event->ID() . '-btn"';
648
+		$html .= ' class="ticket-selector-submit-btn ';
649
+		$html .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
650
+		$html .= ' type="submit" value="' . $btn_text . '" />';
651
+		$html .= EEH_HTML::divx() . '<!-- .ticket-selector-submit-btn-wrap -->';
652
+		$html .= apply_filters(
653
+			'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
654
+			'',
655
+			$this->event,
656
+			$this->iframe
657
+		);
658
+		return $html;
659
+	}
660
+
661
+
662
+	/**
663
+	 * displayViewDetailsButton
664
+	 *
665
+	 * @param bool $DWMTS indicates a "Dude Where's my Ticket Selector?" (DWMTS) type event
666
+	 *                    (ie: $_max_atndz === 1) where there are no available tickets,
667
+	 *                    either because they are sold out, expired, or not yet on sale.
668
+	 *                    In this case, we need to close the form BEFORE adding any closing divs
669
+	 * @return string
670
+	 * @throws EE_Error
671
+	 */
672
+	public function displayViewDetailsButton($DWMTS = false)
673
+	{
674
+		if (! $this->event->get_permalink()) {
675
+			EE_Error::add_error(
676
+				esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
677
+				__FILE__,
678
+				__FUNCTION__,
679
+				__LINE__
680
+			);
681
+		}
682
+		$view_details_btn = '<form method="POST" action="';
683
+		$view_details_btn .= apply_filters(
684
+			'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_url',
685
+			$this->event->get_permalink(),
686
+			$this->event
687
+		);
688
+		$view_details_btn .= '"';
689
+		// open link in new window ?
690
+		$view_details_btn .= apply_filters(
691
+			'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displayViewDetailsButton__url_target_blank',
692
+			$this->isIframe(),
693
+			$this
694
+		)
695
+			? ' target="_blank"'
696
+			: '';
697
+		$view_details_btn .= '>';
698
+		$btn_text = apply_filters(
699
+			'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_text',
700
+			esc_html__('View Details', 'event_espresso'),
701
+			$this->event
702
+		);
703
+		$view_details_btn .= '<input id="ticket-selector-submit-'
704
+							 . $this->event->ID()
705
+							 . '-btn" class="ticket-selector-submit-btn view-details-btn" type="submit" value="'
706
+							 . $btn_text
707
+							 . '" />';
708
+		$view_details_btn .= apply_filters('FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event);
709
+		if ($DWMTS) {
710
+			$view_details_btn .= $this->formClose();
711
+			$view_details_btn .= $this->ticketSelectorEndDiv();
712
+			$view_details_btn .= '<br/>';
713
+		} else {
714
+			$view_details_btn .= $this->clearTicketSelector();
715
+			$view_details_btn .= '<br/>';
716
+			$view_details_btn .= $this->formClose();
717
+		}
718
+		return $view_details_btn;
719
+	}
720
+
721
+
722
+	/**
723
+	 * @return string
724
+	 */
725
+	public function ticketSelectorEndDiv()
726
+	{
727
+		return $this->clearTicketSelector() . '</div><!-- ticketSelectorEndDiv -->';
728
+	}
729
+
730
+
731
+	/**
732
+	 * @return string
733
+	 */
734
+	public function clearTicketSelector()
735
+	{
736
+		// standard TS displayed, appears after a "Register Now" or "view Details" button
737
+		return '<div class="clear"></div><!-- clearTicketSelector -->';
738
+	}
739
+
740
+
741
+	/**
742
+	 * @access        public
743
+	 * @return        string
744
+	 */
745
+	public function formClose()
746
+	{
747
+		return '</form>';
748
+	}
749 749
 }
Please login to merge, or discard this patch.
Spacing   +25 added lines, -25 removed lines patch added patch discarded remove patch
@@ -135,11 +135,11 @@  discard block
 block discarded – undo
135 135
             }
136 136
         } else {
137 137
             $user_msg = __('No Event object or an invalid Event object was supplied.', 'event_espresso');
138
-            $dev_msg = $user_msg . __(
138
+            $dev_msg = $user_msg.__(
139 139
                 'In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
140 140
                 'event_espresso'
141 141
             );
142
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
142
+            EE_Error::add_error($user_msg.'||'.$dev_msg, __FILE__, __FUNCTION__, __LINE__);
143 143
             return false;
144 144
         }
145 145
         return true;
@@ -200,7 +200,7 @@  discard block
 block discarded – undo
200 200
         // reset filter for displaying submit button
201 201
         remove_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
202 202
         // poke and prod incoming event till it tells us what it is
203
-        if (! $this->setEvent($event)) {
203
+        if ( ! $this->setEvent($event)) {
204 204
             return false;
205 205
         }
206 206
         // begin gathering template arguments by getting event status
@@ -235,7 +235,7 @@  discard block
 block discarded – undo
235 235
             : $this->loadTicketSelector($tickets, $template_args);
236 236
         // now set up the form (but not for the admin)
237 237
         $ticket_selector = $this->display_full_ui()
238
-            ? $this->formOpen($this->event->ID(), $external_url) . $ticket_selector
238
+            ? $this->formOpen($this->event->ID(), $external_url).$ticket_selector
239 239
             : $ticket_selector;
240 240
         // submit button and form close tag
241 241
         $ticket_selector .= $this->display_full_ui() ? $this->displaySubmitButton($external_url) : '';
@@ -283,10 +283,10 @@  discard block
 block discarded – undo
283 283
      */
284 284
     protected function expiredEventMessage()
285 285
     {
286
-        return '<div class="ee-event-expired-notice"><span class="important-notice">' . esc_html__(
286
+        return '<div class="ee-event-expired-notice"><span class="important-notice">'.esc_html__(
287 287
             'We\'re sorry, but all tickets sales have ended because the event is expired.',
288 288
             'event_espresso'
289
-        ) . '</span></div><!-- .ee-event-expired-notice -->';
289
+        ).'</span></div><!-- .ee-event-expired-notice -->';
290 290
     }
291 291
 
292 292
 
@@ -316,7 +316,7 @@  discard block
 block discarded – undo
316 316
         }
317 317
         return '
318 318
             <div class="ee-event-expired-notice">
319
-                <span class="important-notice">' . $no_ticket_available_msg . '</span>
319
+                <span class="important-notice">' . $no_ticket_available_msg.'</span>
320 320
             </div><!-- .ee-event-expired-notice -->';
321 321
     }
322 322
 
@@ -348,7 +348,7 @@  discard block
 block discarded – undo
348 348
                 '</a></span></div><!-- .ee-attention ticketSalesClosedMessage -->'
349 349
             );
350 350
         }
351
-        return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
351
+        return '<p><span class="important-notice">'.$sales_closed_msg.'</span></p>';
352 352
     }
353 353
 
354 354
 
@@ -373,7 +373,7 @@  discard block
 block discarded – undo
373 373
                 'Datetime.DTT_EVT_start' => 'DESC',
374 374
             ),
375 375
         );
376
-        if (! (
376
+        if ( ! (
377 377
             EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config
378 378
             && EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector->show_expired_tickets
379 379
         )) {
@@ -414,7 +414,7 @@  discard block
 block discarded – undo
414 414
          */
415 415
         $template_args['anchor_id'] = apply_filters(
416 416
             'FHEE__EE_Ticket_Selector__redirect_anchor_id',
417
-            '#tkt-slctr-tbl-' . $this->event->ID(),
417
+            '#tkt-slctr-tbl-'.$this->event->ID(),
418 418
             $this->event->ID()
419 419
         );
420 420
         $template_args['tickets'] = $tickets;
@@ -500,8 +500,8 @@  discard block
 block discarded – undo
500 500
         // if redirecting, we don't need any anything else
501 501
         if ($external_url) {
502 502
             $html = '<form method="GET" ';
503
-            $html .= 'action="' . EEH_URL::refactor_url($external_url) . '" ';
504
-            $html .= 'name="ticket-selector-form-' . $ID . '"';
503
+            $html .= 'action="'.EEH_URL::refactor_url($external_url).'" ';
504
+            $html .= 'name="ticket-selector-form-'.$ID.'"';
505 505
             // open link in new window ?
506 506
             $html .= apply_filters(
507 507
                 'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
@@ -513,17 +513,17 @@  discard block
 block discarded – undo
513 513
             $html .= '>';
514 514
             $query_args = EEH_URL::get_query_string($external_url);
515 515
             foreach ((array) $query_args as $query_arg => $value) {
516
-                $html .= '<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
516
+                $html .= '<input type="hidden" name="'.$query_arg.'" value="'.$value.'">';
517 517
             }
518 518
             return $html;
519 519
         }
520 520
         // if there is no submit button, then don't start building a form
521 521
         // because the "View Details" button will build its own form
522
-        if (! apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
522
+        if ( ! apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
523 523
             return '';
524 524
         }
525 525
         $checkout_url = EEH_Event_View::event_link_url($ID);
526
-        if (! $checkout_url) {
526
+        if ( ! $checkout_url) {
527 527
             EE_Error::add_error(
528 528
                 esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
529 529
                 __FILE__,
@@ -534,8 +534,8 @@  discard block
 block discarded – undo
534 534
         // set no cache headers and constants
535 535
         EE_System::do_not_cache();
536 536
         $html = '<form method="POST" ';
537
-        $html .= 'action="' . $checkout_url . '" ';
538
-        $html .= 'name="ticket-selector-form-' . $ID . '"';
537
+        $html .= 'action="'.$checkout_url.'" ';
538
+        $html .= 'name="ticket-selector-form-'.$ID.'"';
539 539
         $html .= $this->iframe ? ' target="_blank"' : '';
540 540
         $html .= '>';
541 541
         $html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
@@ -561,7 +561,7 @@  discard block
 block discarded – undo
561 561
                 $html .= empty($external_url)
562 562
                     ? $this->ticketSelectorEndDiv()
563 563
                     : $this->clearTicketSelector();
564
-                $html .= '<br/>' . $this->formClose();
564
+                $html .= '<br/>'.$this->formClose();
565 565
             } elseif ($this->getMaxAttendees() === 1) {
566 566
                 // its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
567 567
                 if ($this->event->is_sold_out()) {
@@ -614,7 +614,7 @@  discard block
 block discarded – undo
614 614
                 // no submit or view details button, and no additional content
615 615
                 $html .= $this->ticketSelectorEndDiv();
616 616
             }
617
-            if (! $this->iframe && ! is_archive()) {
617
+            if ( ! $this->iframe && ! is_archive()) {
618 618
                 $html .= EEH_Template::powered_by_event_espresso('', '', array('utm_content' => 'ticket_selector'));
619 619
             }
620 620
         }
@@ -641,14 +641,14 @@  discard block
 block discarded – undo
641 641
         $external_url = $this->event->external_url();
642 642
         $html = EEH_HTML::div(
643 643
             '',
644
-            'ticket-selector-submit-' . $this->event->ID() . '-btn-wrap',
644
+            'ticket-selector-submit-'.$this->event->ID().'-btn-wrap',
645 645
             'ticket-selector-submit-btn-wrap'
646 646
         );
647
-        $html .= '<input id="ticket-selector-submit-' . $this->event->ID() . '-btn"';
647
+        $html .= '<input id="ticket-selector-submit-'.$this->event->ID().'-btn"';
648 648
         $html .= ' class="ticket-selector-submit-btn ';
649 649
         $html .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
650
-        $html .= ' type="submit" value="' . $btn_text . '" />';
651
-        $html .= EEH_HTML::divx() . '<!-- .ticket-selector-submit-btn-wrap -->';
650
+        $html .= ' type="submit" value="'.$btn_text.'" />';
651
+        $html .= EEH_HTML::divx().'<!-- .ticket-selector-submit-btn-wrap -->';
652 652
         $html .= apply_filters(
653 653
             'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
654 654
             '',
@@ -671,7 +671,7 @@  discard block
 block discarded – undo
671 671
      */
672 672
     public function displayViewDetailsButton($DWMTS = false)
673 673
     {
674
-        if (! $this->event->get_permalink()) {
674
+        if ( ! $this->event->get_permalink()) {
675 675
             EE_Error::add_error(
676 676
                 esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
677 677
                 __FILE__,
@@ -724,7 +724,7 @@  discard block
 block discarded – undo
724 724
      */
725 725
     public function ticketSelectorEndDiv()
726 726
     {
727
-        return $this->clearTicketSelector() . '</div><!-- ticketSelectorEndDiv -->';
727
+        return $this->clearTicketSelector().'</div><!-- ticketSelectorEndDiv -->';
728 728
     }
729 729
 
730 730
 
Please login to merge, or discard this patch.
modules/ticket_selector/DatetimeSelector.php 2 patches
Indentation   +167 added lines, -167 removed lines patch added patch discarded remove patch
@@ -12,171 +12,171 @@
 block discarded – undo
12 12
 class DatetimeSelector
13 13
 {
14 14
 
15
-    /**
16
-     * @var \EE_Event $event
17
-     */
18
-    protected $event;
19
-
20
-    /**
21
-     * @var \EE_Ticket[] $tickets
22
-     */
23
-    protected $tickets;
24
-
25
-    /**
26
-     * @var \EE_Datetime[] $datetimes
27
-     */
28
-    protected $datetimes;
29
-
30
-    /**
31
-     * @var \EE_Datetime[] $unique_dates
32
-     */
33
-    protected $unique_dates;
34
-
35
-    /**
36
-     * @var \EE_Ticket_Selector_Config $template_settings
37
-     */
38
-    protected $template_settings;
39
-
40
-    /**
41
-     * @var boolean $active
42
-     */
43
-    protected $active = false;
44
-
45
-
46
-    /**
47
-     * DatetimeSelector constructor.
48
-     *
49
-     * @param \EE_Event                  $event
50
-     * @param \EE_Ticket[]               $tickets
51
-     * @param \EE_Ticket_Selector_Config $template_settings
52
-     * @param string                     $date_format
53
-     * @param string                     $time_format
54
-     * @throws \EE_Error
55
-     */
56
-    public function __construct(
57
-        \EE_Event $event,
58
-        array $tickets,
59
-        \EE_Ticket_Selector_Config $template_settings,
60
-        $date_format = 'Y-m-d',
61
-        $time_format = 'g:i a'
62
-    ) {
63
-        $this->event = $event;
64
-        $this->tickets = $tickets;
65
-        $this->template_settings = $template_settings;
66
-        $this->datetimes = $this->getAllDatetimesForAllTicket($tickets);
67
-        $this->unique_dates = $this->getUniqueDatetimeOptions($date_format, $time_format);
68
-        $this->active = $this->template_settings->showDatetimeSelector($this->unique_dates);
69
-    }
70
-
71
-
72
-    /**
73
-     * @param \EE_Ticket[] $tickets
74
-     * @return array
75
-     * @throws \EE_Error
76
-     */
77
-    protected function getAllDatetimesForAllTicket($tickets = array())
78
-    {
79
-        $datetimes = array();
80
-        foreach ($tickets as $ticket) {
81
-            $datetimes = $this->getTicketDatetimes($ticket, $datetimes);
82
-        }
83
-        return $datetimes;
84
-    }
85
-
86
-
87
-    /**
88
-     * @param \EE_Ticket      $ticket
89
-     * @param  \EE_Datetime[] $datetimes
90
-     * @return \EE_Datetime[]
91
-     * @throws \EE_Error
92
-     */
93
-    protected function getTicketDatetimes(\EE_Ticket $ticket, $datetimes = array())
94
-    {
95
-        $ticket_datetimes = $ticket->datetimes(
96
-            array(
97
-                'order_by'                 => array(
98
-                    'DTT_order'     => 'ASC',
99
-                    'DTT_EVT_start' => 'ASC',
100
-                ),
101
-                'default_where_conditions' => 'none',
102
-            )
103
-        );
104
-        foreach ($ticket_datetimes as $ticket_datetime) {
105
-            if (! $ticket_datetime instanceof \EE_Datetime) {
106
-                continue;
107
-            }
108
-            $datetimes[ $ticket_datetime->ID() ] = $ticket_datetime;
109
-        }
110
-        return $datetimes;
111
-    }
112
-
113
-
114
-    /**
115
-     * @param \EE_Ticket $ticket
116
-     * @return string
117
-     * @throws \EE_Error
118
-     */
119
-    public function getTicketDatetimeClasses(\EE_Ticket $ticket)
120
-    {
121
-        if (! $this->active) {
122
-            return '';
123
-        }
124
-        $ticket_datetimes = $this->getTicketDatetimes($ticket);
125
-        $classes = '';
126
-        foreach ($this->datetimes as $datetime) {
127
-            if (! $datetime instanceof \EE_Datetime || ! in_array($datetime, $ticket_datetimes, true)) {
128
-                continue;
129
-            }
130
-            $classes .= ' ee-ticket-datetimes-' . $datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_');
131
-        }
132
-        return $classes;
133
-    }
134
-
135
-
136
-    /**
137
-     * @param string $date_format
138
-     * @param string $time_format
139
-     * @return array
140
-     * @throws \EE_Error
141
-     */
142
-    public function getUniqueDatetimeOptions($date_format = 'Y-m-d', $time_format = 'g:i a')
143
-    {
144
-        $datetime_options = array();
145
-        foreach ($this->datetimes as $datetime) {
146
-            if (! $datetime instanceof \EE_Datetime) {
147
-                continue;
148
-            }
149
-            $datetime_options[ $datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_') ] =
150
-                $datetime->date_and_time_range($date_format, $time_format, ' - ');
151
-        }
152
-        return $datetime_options;
153
-    }
154
-
155
-
156
-    /**
157
-     * @return string
158
-     * @throws \EE_Error
159
-     */
160
-    public function getDatetimeSelector()
161
-    {
162
-        if (! $this->active) {
163
-            return '';
164
-        }
165
-        $dropdown_selector = new \EE_Checkbox_Dropdown_Selector_Input(
166
-            $this->unique_dates,
167
-            array(
168
-                'html_id'               => 'datetime-selector-' . $this->event->ID(),
169
-                'html_name'             => 'datetime_selector_' . $this->event->ID(),
170
-                'html_class'            => 'datetime-selector',
171
-                'select_button_text'    => '<span class="dashicons dashicons-calendar-alt"></span> '
172
-                                           . esc_html__('Filter by Date', 'event_espresso'),
173
-                'other_html_attributes' => ' data-tkt_slctr_evt="' . $this->event->ID() . '"',
174
-            )
175
-        );
176
-        return \EEH_HTML::div(
177
-            $dropdown_selector->get_html_for_input(),
178
-            '',
179
-            'datetime_selector-dv'
180
-        );
181
-    }
15
+	/**
16
+	 * @var \EE_Event $event
17
+	 */
18
+	protected $event;
19
+
20
+	/**
21
+	 * @var \EE_Ticket[] $tickets
22
+	 */
23
+	protected $tickets;
24
+
25
+	/**
26
+	 * @var \EE_Datetime[] $datetimes
27
+	 */
28
+	protected $datetimes;
29
+
30
+	/**
31
+	 * @var \EE_Datetime[] $unique_dates
32
+	 */
33
+	protected $unique_dates;
34
+
35
+	/**
36
+	 * @var \EE_Ticket_Selector_Config $template_settings
37
+	 */
38
+	protected $template_settings;
39
+
40
+	/**
41
+	 * @var boolean $active
42
+	 */
43
+	protected $active = false;
44
+
45
+
46
+	/**
47
+	 * DatetimeSelector constructor.
48
+	 *
49
+	 * @param \EE_Event                  $event
50
+	 * @param \EE_Ticket[]               $tickets
51
+	 * @param \EE_Ticket_Selector_Config $template_settings
52
+	 * @param string                     $date_format
53
+	 * @param string                     $time_format
54
+	 * @throws \EE_Error
55
+	 */
56
+	public function __construct(
57
+		\EE_Event $event,
58
+		array $tickets,
59
+		\EE_Ticket_Selector_Config $template_settings,
60
+		$date_format = 'Y-m-d',
61
+		$time_format = 'g:i a'
62
+	) {
63
+		$this->event = $event;
64
+		$this->tickets = $tickets;
65
+		$this->template_settings = $template_settings;
66
+		$this->datetimes = $this->getAllDatetimesForAllTicket($tickets);
67
+		$this->unique_dates = $this->getUniqueDatetimeOptions($date_format, $time_format);
68
+		$this->active = $this->template_settings->showDatetimeSelector($this->unique_dates);
69
+	}
70
+
71
+
72
+	/**
73
+	 * @param \EE_Ticket[] $tickets
74
+	 * @return array
75
+	 * @throws \EE_Error
76
+	 */
77
+	protected function getAllDatetimesForAllTicket($tickets = array())
78
+	{
79
+		$datetimes = array();
80
+		foreach ($tickets as $ticket) {
81
+			$datetimes = $this->getTicketDatetimes($ticket, $datetimes);
82
+		}
83
+		return $datetimes;
84
+	}
85
+
86
+
87
+	/**
88
+	 * @param \EE_Ticket      $ticket
89
+	 * @param  \EE_Datetime[] $datetimes
90
+	 * @return \EE_Datetime[]
91
+	 * @throws \EE_Error
92
+	 */
93
+	protected function getTicketDatetimes(\EE_Ticket $ticket, $datetimes = array())
94
+	{
95
+		$ticket_datetimes = $ticket->datetimes(
96
+			array(
97
+				'order_by'                 => array(
98
+					'DTT_order'     => 'ASC',
99
+					'DTT_EVT_start' => 'ASC',
100
+				),
101
+				'default_where_conditions' => 'none',
102
+			)
103
+		);
104
+		foreach ($ticket_datetimes as $ticket_datetime) {
105
+			if (! $ticket_datetime instanceof \EE_Datetime) {
106
+				continue;
107
+			}
108
+			$datetimes[ $ticket_datetime->ID() ] = $ticket_datetime;
109
+		}
110
+		return $datetimes;
111
+	}
112
+
113
+
114
+	/**
115
+	 * @param \EE_Ticket $ticket
116
+	 * @return string
117
+	 * @throws \EE_Error
118
+	 */
119
+	public function getTicketDatetimeClasses(\EE_Ticket $ticket)
120
+	{
121
+		if (! $this->active) {
122
+			return '';
123
+		}
124
+		$ticket_datetimes = $this->getTicketDatetimes($ticket);
125
+		$classes = '';
126
+		foreach ($this->datetimes as $datetime) {
127
+			if (! $datetime instanceof \EE_Datetime || ! in_array($datetime, $ticket_datetimes, true)) {
128
+				continue;
129
+			}
130
+			$classes .= ' ee-ticket-datetimes-' . $datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_');
131
+		}
132
+		return $classes;
133
+	}
134
+
135
+
136
+	/**
137
+	 * @param string $date_format
138
+	 * @param string $time_format
139
+	 * @return array
140
+	 * @throws \EE_Error
141
+	 */
142
+	public function getUniqueDatetimeOptions($date_format = 'Y-m-d', $time_format = 'g:i a')
143
+	{
144
+		$datetime_options = array();
145
+		foreach ($this->datetimes as $datetime) {
146
+			if (! $datetime instanceof \EE_Datetime) {
147
+				continue;
148
+			}
149
+			$datetime_options[ $datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_') ] =
150
+				$datetime->date_and_time_range($date_format, $time_format, ' - ');
151
+		}
152
+		return $datetime_options;
153
+	}
154
+
155
+
156
+	/**
157
+	 * @return string
158
+	 * @throws \EE_Error
159
+	 */
160
+	public function getDatetimeSelector()
161
+	{
162
+		if (! $this->active) {
163
+			return '';
164
+		}
165
+		$dropdown_selector = new \EE_Checkbox_Dropdown_Selector_Input(
166
+			$this->unique_dates,
167
+			array(
168
+				'html_id'               => 'datetime-selector-' . $this->event->ID(),
169
+				'html_name'             => 'datetime_selector_' . $this->event->ID(),
170
+				'html_class'            => 'datetime-selector',
171
+				'select_button_text'    => '<span class="dashicons dashicons-calendar-alt"></span> '
172
+										   . esc_html__('Filter by Date', 'event_espresso'),
173
+				'other_html_attributes' => ' data-tkt_slctr_evt="' . $this->event->ID() . '"',
174
+			)
175
+		);
176
+		return \EEH_HTML::div(
177
+			$dropdown_selector->get_html_for_input(),
178
+			'',
179
+			'datetime_selector-dv'
180
+		);
181
+	}
182 182
 }
Please login to merge, or discard this patch.
Spacing   +11 added lines, -11 removed lines patch added patch discarded remove patch
@@ -102,10 +102,10 @@  discard block
 block discarded – undo
102 102
             )
103 103
         );
104 104
         foreach ($ticket_datetimes as $ticket_datetime) {
105
-            if (! $ticket_datetime instanceof \EE_Datetime) {
105
+            if ( ! $ticket_datetime instanceof \EE_Datetime) {
106 106
                 continue;
107 107
             }
108
-            $datetimes[ $ticket_datetime->ID() ] = $ticket_datetime;
108
+            $datetimes[$ticket_datetime->ID()] = $ticket_datetime;
109 109
         }
110 110
         return $datetimes;
111 111
     }
@@ -118,16 +118,16 @@  discard block
 block discarded – undo
118 118
      */
119 119
     public function getTicketDatetimeClasses(\EE_Ticket $ticket)
120 120
     {
121
-        if (! $this->active) {
121
+        if ( ! $this->active) {
122 122
             return '';
123 123
         }
124 124
         $ticket_datetimes = $this->getTicketDatetimes($ticket);
125 125
         $classes = '';
126 126
         foreach ($this->datetimes as $datetime) {
127
-            if (! $datetime instanceof \EE_Datetime || ! in_array($datetime, $ticket_datetimes, true)) {
127
+            if ( ! $datetime instanceof \EE_Datetime || ! in_array($datetime, $ticket_datetimes, true)) {
128 128
                 continue;
129 129
             }
130
-            $classes .= ' ee-ticket-datetimes-' . $datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_');
130
+            $classes .= ' ee-ticket-datetimes-'.$datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_');
131 131
         }
132 132
         return $classes;
133 133
     }
@@ -143,10 +143,10 @@  discard block
 block discarded – undo
143 143
     {
144 144
         $datetime_options = array();
145 145
         foreach ($this->datetimes as $datetime) {
146
-            if (! $datetime instanceof \EE_Datetime) {
146
+            if ( ! $datetime instanceof \EE_Datetime) {
147 147
                 continue;
148 148
             }
149
-            $datetime_options[ $datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_') ] =
149
+            $datetime_options[$datetime->date_and_time_range('Y_m_d', 'H_i', '-', '_')] =
150 150
                 $datetime->date_and_time_range($date_format, $time_format, ' - ');
151 151
         }
152 152
         return $datetime_options;
@@ -159,18 +159,18 @@  discard block
 block discarded – undo
159 159
      */
160 160
     public function getDatetimeSelector()
161 161
     {
162
-        if (! $this->active) {
162
+        if ( ! $this->active) {
163 163
             return '';
164 164
         }
165 165
         $dropdown_selector = new \EE_Checkbox_Dropdown_Selector_Input(
166 166
             $this->unique_dates,
167 167
             array(
168
-                'html_id'               => 'datetime-selector-' . $this->event->ID(),
169
-                'html_name'             => 'datetime_selector_' . $this->event->ID(),
168
+                'html_id'               => 'datetime-selector-'.$this->event->ID(),
169
+                'html_name'             => 'datetime_selector_'.$this->event->ID(),
170 170
                 'html_class'            => 'datetime-selector',
171 171
                 'select_button_text'    => '<span class="dashicons dashicons-calendar-alt"></span> '
172 172
                                            . esc_html__('Filter by Date', 'event_espresso'),
173
-                'other_html_attributes' => ' data-tkt_slctr_evt="' . $this->event->ID() . '"',
173
+                'other_html_attributes' => ' data-tkt_slctr_evt="'.$this->event->ID().'"',
174 174
             )
175 175
         );
176 176
         return \EEH_HTML::div(
Please login to merge, or discard this patch.
caffeinated/modules/recaptcha/ReCaptcha/Response.php 2 patches
Indentation   +61 added lines, -61 removed lines patch added patch discarded remove patch
@@ -28,74 +28,74 @@
 block discarded – undo
28 28
  */
29 29
 class Response
30 30
 {
31
-    /**
32
-     * Succes or failure.
33
-     *
34
-     * @var boolean
35
-     */
36
-    private $success = false;
31
+	/**
32
+	 * Succes or failure.
33
+	 *
34
+	 * @var boolean
35
+	 */
36
+	private $success = false;
37 37
 
38
-    /**
39
-     * Error code strings.
40
-     *
41
-     * @var array
42
-     */
43
-    private $errorCodes = array();
38
+	/**
39
+	 * Error code strings.
40
+	 *
41
+	 * @var array
42
+	 */
43
+	private $errorCodes = array();
44 44
 
45
-    /**
46
-     * Build the response from the expected JSON returned by the service.
47
-     *
48
-     * @param string $json
49
-     * @return \ReCaptcha\Response
50
-     */
51
-    public static function fromJson($json)
52
-    {
53
-        $responseData = json_decode($json, true);
45
+	/**
46
+	 * Build the response from the expected JSON returned by the service.
47
+	 *
48
+	 * @param string $json
49
+	 * @return \ReCaptcha\Response
50
+	 */
51
+	public static function fromJson($json)
52
+	{
53
+		$responseData = json_decode($json, true);
54 54
 
55
-        if (! $responseData) {
56
-            return new Response(false, array('invalid-json'));
57
-        }
55
+		if (! $responseData) {
56
+			return new Response(false, array('invalid-json'));
57
+		}
58 58
 
59
-        if (isset($responseData['success']) && $responseData['success'] == true) {
60
-            return new Response(true);
61
-        }
59
+		if (isset($responseData['success']) && $responseData['success'] == true) {
60
+			return new Response(true);
61
+		}
62 62
 
63
-        if (isset($responseData['error-codes']) && is_array($responseData['error-codes'])) {
64
-            return new Response(false, $responseData['error-codes']);
65
-        }
63
+		if (isset($responseData['error-codes']) && is_array($responseData['error-codes'])) {
64
+			return new Response(false, $responseData['error-codes']);
65
+		}
66 66
 
67
-        return new Response(false);
68
-    }
67
+		return new Response(false);
68
+	}
69 69
 
70
-    /**
71
-     * Constructor.
72
-     *
73
-     * @param boolean $success
74
-     * @param array   $errorCodes
75
-     */
76
-    public function __construct($success, array $errorCodes = array())
77
-    {
78
-        $this->success = $success;
79
-        $this->errorCodes = $errorCodes;
80
-    }
70
+	/**
71
+	 * Constructor.
72
+	 *
73
+	 * @param boolean $success
74
+	 * @param array   $errorCodes
75
+	 */
76
+	public function __construct($success, array $errorCodes = array())
77
+	{
78
+		$this->success = $success;
79
+		$this->errorCodes = $errorCodes;
80
+	}
81 81
 
82
-    /**
83
-     * Is success?
84
-     *
85
-     * @return boolean
86
-     */
87
-    public function isSuccess()
88
-    {
89
-        return $this->success;
90
-    }
82
+	/**
83
+	 * Is success?
84
+	 *
85
+	 * @return boolean
86
+	 */
87
+	public function isSuccess()
88
+	{
89
+		return $this->success;
90
+	}
91 91
 
92
-    /**
93
-     * Get error codes.
94
-     *
95
-     * @return array
96
-     */
97
-    public function getErrorCodes()
98
-    {
99
-        return $this->errorCodes;
100
-    }
92
+	/**
93
+	 * Get error codes.
94
+	 *
95
+	 * @return array
96
+	 */
97
+	public function getErrorCodes()
98
+	{
99
+		return $this->errorCodes;
100
+	}
101 101
 }
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -52,7 +52,7 @@
 block discarded – undo
52 52
     {
53 53
         $responseData = json_decode($json, true);
54 54
 
55
-        if (! $responseData) {
55
+        if ( ! $responseData) {
56 56
             return new Response(false, array('invalid-json'));
57 57
         }
58 58
 
Please login to merge, or discard this patch.
core/exceptions/ExceptionStackTraceDisplay.php 2 patches
Indentation   +285 added lines, -285 removed lines patch added patch discarded remove patch
@@ -19,52 +19,52 @@  discard block
 block discarded – undo
19 19
 {
20 20
 
21 21
 
22
-    /**
23
-     * @param Exception $exception
24
-     * @throws Exception
25
-     */
26
-    public function __construct(Exception $exception)
27
-    {
28
-        if (WP_DEBUG && ! defined('EE_TESTS_DIR')) {
29
-            $this->displayException($exception);
30
-        } else {
31
-            throw $exception;
32
-        }
33
-    }
22
+	/**
23
+	 * @param Exception $exception
24
+	 * @throws Exception
25
+	 */
26
+	public function __construct(Exception $exception)
27
+	{
28
+		if (WP_DEBUG && ! defined('EE_TESTS_DIR')) {
29
+			$this->displayException($exception);
30
+		} else {
31
+			throw $exception;
32
+		}
33
+	}
34 34
 
35 35
 
36
-    /**
37
-     * @access protected
38
-     * @param Exception $exception
39
-     * @throws ReflectionException
40
-     */
41
-    protected function displayException(Exception $exception)
42
-    {
43
-        $error_code = '';
44
-        $trace_details = '';
45
-        $time = time();
46
-        $trace = $exception->getTrace();
47
-        // get separate user and developer messages if they exist
48
-        $msg = explode('||', $exception->getMessage());
49
-        $user_msg = $msg[0];
50
-        $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
51
-        $msg = WP_DEBUG ? $dev_msg : $user_msg;
52
-        // start gathering output
53
-        $output = $this->exceptionStyles();
54
-        $output .= '
36
+	/**
37
+	 * @access protected
38
+	 * @param Exception $exception
39
+	 * @throws ReflectionException
40
+	 */
41
+	protected function displayException(Exception $exception)
42
+	{
43
+		$error_code = '';
44
+		$trace_details = '';
45
+		$time = time();
46
+		$trace = $exception->getTrace();
47
+		// get separate user and developer messages if they exist
48
+		$msg = explode('||', $exception->getMessage());
49
+		$user_msg = $msg[0];
50
+		$dev_msg = isset($msg[1]) ? $msg[1] : $msg[0];
51
+		$msg = WP_DEBUG ? $dev_msg : $user_msg;
52
+		// start gathering output
53
+		$output = $this->exceptionStyles();
54
+		$output .= '
55 55
 <div id="ee-error-message" class="error">';
56
-        if (! WP_DEBUG) {
57
-            $output .= '
56
+		if (! WP_DEBUG) {
57
+			$output .= '
58 58
 	<p>';
59
-        }
60
-        // process trace info
61
-        if (empty($trace)) {
62
-            $trace_details .= __(
63
-                'Sorry, but no trace information was available for this exception.',
64
-                'event_espresso'
65
-            );
66
-        } else {
67
-            $trace_details .= '
59
+		}
60
+		// process trace info
61
+		if (empty($trace)) {
62
+			$trace_details .= __(
63
+				'Sorry, but no trace information was available for this exception.',
64
+				'event_espresso'
65
+			);
66
+		} else {
67
+			$trace_details .= '
68 68
 			<div id="ee-trace-details">
69 69
 			<table width="100%" border="0" cellpadding="5" cellspacing="0">
70 70
 				<tr>
@@ -72,263 +72,263 @@  discard block
 block discarded – undo
72 72
 					<th scope="col" align="right" style="width:3.5%;">Line</th>
73 73
 					<th scope="col" align="left" style="width:40%;">File</th>
74 74
 					<th scope="col" align="left">' . __('Class', 'event_espresso') . '->'
75
-                              . __(
76
-                                  'Method( arguments )',
77
-                                  'event_espresso'
78
-                              ) . '</th>
75
+							  . __(
76
+								  'Method( arguments )',
77
+								  'event_espresso'
78
+							  ) . '</th>
79 79
 				</tr>';
80
-            $last_on_stack = count($trace) - 1;
81
-            // reverse array so that stack is in proper chronological order
82
-            $sorted_trace = array_reverse($trace);
83
-            foreach ($sorted_trace as $nmbr => $trace) {
84
-                $file = isset($trace['file']) ? $trace['file'] : '';
85
-                $class = isset($trace['class']) ? $trace['class'] : '';
86
-                $type = isset($trace['type']) ? $trace['type'] : '';
87
-                $function = isset($trace['function']) ? $trace['function'] : '';
88
-                $args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
89
-                $args = isset($trace['args']) && count($trace['args']) > 4 ? ' <br />' . $args . '<br />' : $args;
90
-                $line = isset($trace['line']) ? $trace['line'] : '';
91
-                $zebra = $nmbr % 2 !== 0 ? ' odd' : '';
92
-                if (empty($file) && ! empty($class)) {
93
-                    $a = new ReflectionClass($class);
94
-                    $file = $a->getFileName();
95
-                    if (empty($line) && ! empty($function)) {
96
-                        try {
97
-                            // if $function is a closure, this throws an exception
98
-                            $b = new ReflectionMethod($class, $function);
99
-                            $line = $b->getStartLine();
100
-                        } catch (Exception $closure_exception) {
101
-                            $line = 'unknown';
102
-                        }
103
-                    }
104
-                }
105
-                if ($nmbr === $last_on_stack) {
106
-                    $file = $exception->getFile() !== '' ? $exception->getFile() : $file;
107
-                    $line = $exception->getLine() !== '' ? $exception->getLine() : $line;
108
-                    $error_code = $this->generate_error_code($file, $trace['function'], $line);
109
-                }
110
-                $file = \EEH_File::standardise_directory_separators($file);
111
-                $nmbr = ! empty($nmbr) ? $nmbr : '&nbsp;';
112
-                $line = ! empty($line) ? $line : '&nbsp;';
113
-                $file = ! empty($file) ? $file : '&nbsp;';
114
-                $class_display = ! empty($class) ? $class : '';
115
-                $type = ! empty($type) ? $type : '';
116
-                $function = ! empty($function) ? $function : '';
117
-                $args = ! empty($args) ? '( ' . $args . ' )' : '()';
118
-                $trace_details .= '
80
+			$last_on_stack = count($trace) - 1;
81
+			// reverse array so that stack is in proper chronological order
82
+			$sorted_trace = array_reverse($trace);
83
+			foreach ($sorted_trace as $nmbr => $trace) {
84
+				$file = isset($trace['file']) ? $trace['file'] : '';
85
+				$class = isset($trace['class']) ? $trace['class'] : '';
86
+				$type = isset($trace['type']) ? $trace['type'] : '';
87
+				$function = isset($trace['function']) ? $trace['function'] : '';
88
+				$args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
89
+				$args = isset($trace['args']) && count($trace['args']) > 4 ? ' <br />' . $args . '<br />' : $args;
90
+				$line = isset($trace['line']) ? $trace['line'] : '';
91
+				$zebra = $nmbr % 2 !== 0 ? ' odd' : '';
92
+				if (empty($file) && ! empty($class)) {
93
+					$a = new ReflectionClass($class);
94
+					$file = $a->getFileName();
95
+					if (empty($line) && ! empty($function)) {
96
+						try {
97
+							// if $function is a closure, this throws an exception
98
+							$b = new ReflectionMethod($class, $function);
99
+							$line = $b->getStartLine();
100
+						} catch (Exception $closure_exception) {
101
+							$line = 'unknown';
102
+						}
103
+					}
104
+				}
105
+				if ($nmbr === $last_on_stack) {
106
+					$file = $exception->getFile() !== '' ? $exception->getFile() : $file;
107
+					$line = $exception->getLine() !== '' ? $exception->getLine() : $line;
108
+					$error_code = $this->generate_error_code($file, $trace['function'], $line);
109
+				}
110
+				$file = \EEH_File::standardise_directory_separators($file);
111
+				$nmbr = ! empty($nmbr) ? $nmbr : '&nbsp;';
112
+				$line = ! empty($line) ? $line : '&nbsp;';
113
+				$file = ! empty($file) ? $file : '&nbsp;';
114
+				$class_display = ! empty($class) ? $class : '';
115
+				$type = ! empty($type) ? $type : '';
116
+				$function = ! empty($function) ? $function : '';
117
+				$args = ! empty($args) ? '( ' . $args . ' )' : '()';
118
+				$trace_details .= '
119 119
 					<tr>
120 120
 						<td align="right" valign="top" class="'
121
-                                  . $zebra
122
-                                  . '">'
123
-                                  . $nmbr
124
-                                  . '</td>
121
+								  . $zebra
122
+								  . '">'
123
+								  . $nmbr
124
+								  . '</td>
125 125
 						<td align="right" valign="top" class="'
126
-                                  . $zebra
127
-                                  . '">'
128
-                                  . $line
129
-                                  . '</td>
126
+								  . $zebra
127
+								  . '">'
128
+								  . $line
129
+								  . '</td>
130 130
 						<td align="left" valign="top" class="'
131
-                                  . $zebra
132
-                                  . '">'
133
-                                  . $file
134
-                                  . '</td>
131
+								  . $zebra
132
+								  . '">'
133
+								  . $file
134
+								  . '</td>
135 135
 						<td align="left" valign="top" class="'
136
-                                  . $zebra
137
-                                  . '">'
138
-                                  . $class_display
139
-                                  . $type
140
-                                  . $function
141
-                                  . $args
142
-                                  . '</td>
136
+								  . $zebra
137
+								  . '">'
138
+								  . $class_display
139
+								  . $type
140
+								  . $function
141
+								  . $args
142
+								  . '</td>
143 143
 					</tr>';
144
-            }
145
-            $trace_details .= '
144
+			}
145
+			$trace_details .= '
146 146
 			 </table>
147 147
 			</div>';
148
-        }
149
-        $code = $exception->getCode() ? $exception->getCode() : $error_code;
150
-        // add generic non-identifying messages for non-privileged users
151
-        if (! WP_DEBUG) {
152
-            $output .= '<span class="ee-error-user-msg-spn">'
153
-                       . trim($msg)
154
-                       . '</span> &nbsp; <sup>'
155
-                       . $code
156
-                       . '</sup><br />';
157
-        } else {
158
-            // or helpful developer messages if debugging is on
159
-            $output .= '
148
+		}
149
+		$code = $exception->getCode() ? $exception->getCode() : $error_code;
150
+		// add generic non-identifying messages for non-privileged users
151
+		if (! WP_DEBUG) {
152
+			$output .= '<span class="ee-error-user-msg-spn">'
153
+					   . trim($msg)
154
+					   . '</span> &nbsp; <sup>'
155
+					   . $code
156
+					   . '</sup><br />';
157
+		} else {
158
+			// or helpful developer messages if debugging is on
159
+			$output .= '
160 160
 		<div class="ee-error-dev-msg-dv">
161 161
 			<p class="ee-error-dev-msg-pg">
162 162
 				'
163
-                       . sprintf(
164
-                           __('%1$sAn %2$s was thrown!%3$s code: %4$s', 'event_espresso'),
165
-                           '<strong class="ee-error-dev-msg-str">',
166
-                           get_class($exception),
167
-                           '</strong>  &nbsp; <span>',
168
-                           $code . '</span>'
169
-                       )
170
-                       . '<br />
163
+					   . sprintf(
164
+						   __('%1$sAn %2$s was thrown!%3$s code: %4$s', 'event_espresso'),
165
+						   '<strong class="ee-error-dev-msg-str">',
166
+						   get_class($exception),
167
+						   '</strong>  &nbsp; <span>',
168
+						   $code . '</span>'
169
+					   )
170
+					   . '<br />
171 171
 				<span class="big-text">"'
172
-                       . trim($msg)
173
-                       . '"</span><br/>
172
+					   . trim($msg)
173
+					   . '"</span><br/>
174 174
 				<a id="display-ee-error-trace-1'
175
-                       . $time
176
-                       . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-1'
177
-                       . $time
178
-                       . '">
175
+					   . $time
176
+					   . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-1'
177
+					   . $time
178
+					   . '">
179 179
 					'
180
-                       . __('click to view backtrace and class/method details', 'event_espresso')
181
-                       . '
180
+					   . __('click to view backtrace and class/method details', 'event_espresso')
181
+					   . '
182 182
 				</a><br />
183 183
 				'
184
-                       . $exception->getFile()
185
-                       . sprintf(
186
-                           __('%1$s( line no: %2$s )%3$s', 'event_espresso'),
187
-                           ' &nbsp; <span class="small-text lt-grey-text">',
188
-                           $exception->getLine(),
189
-                           '</span>'
190
-                       )
191
-                       . '
184
+					   . $exception->getFile()
185
+					   . sprintf(
186
+						   __('%1$s( line no: %2$s )%3$s', 'event_espresso'),
187
+						   ' &nbsp; <span class="small-text lt-grey-text">',
188
+						   $exception->getLine(),
189
+						   '</span>'
190
+					   )
191
+					   . '
192 192
 			</p>
193 193
 			<div id="ee-error-trace-1'
194
-                       . $time
195
-                       . '-dv" class="ee-error-trace-dv" style="display: none;">
194
+					   . $time
195
+					   . '-dv" class="ee-error-trace-dv" style="display: none;">
196 196
 				'
197
-                       . $trace_details;
198
-            if (! empty($class)) {
199
-                $output .= '
197
+					   . $trace_details;
198
+			if (! empty($class)) {
199
+				$output .= '
200 200
 				<div style="padding:3px; margin:0 0 1em; border:1px solid #999; background:#fff; border-radius:3px;">
201 201
 					<div style="padding:1em 2em; border:1px solid #999; background:#fcfcfc;">
202 202
 						<h3>' . __('Class Details', 'event_espresso') . '</h3>';
203
-                $a = new ReflectionClass($class);
204
-                $output .= '
203
+				$a = new ReflectionClass($class);
204
+				$output .= '
205 205
 						<pre>' . $a . '</pre>
206 206
 					</div>
207 207
 				</div>';
208
-            }
209
-            $output .= '
208
+			}
209
+			$output .= '
210 210
 			</div>
211 211
 		</div>
212 212
 		<br />';
213
-        }
214
-        // remove last linebreak
215
-        $output = substr($output, 0, -6);
216
-        if (! WP_DEBUG) {
217
-            $output .= '
213
+		}
214
+		// remove last linebreak
215
+		$output = substr($output, 0, -6);
216
+		if (! WP_DEBUG) {
217
+			$output .= '
218 218
 	</p>';
219
-        }
220
-        $output .= '
219
+		}
220
+		$output .= '
221 221
 </div>';
222
-        $output .= $this->printScripts(true);
223
-        if (defined('DOING_AJAX')) {
224
-            echo wp_json_encode(array('error' => $output));
225
-            exit();
226
-        }
227
-        echo $output;
228
-    }
222
+		$output .= $this->printScripts(true);
223
+		if (defined('DOING_AJAX')) {
224
+			echo wp_json_encode(array('error' => $output));
225
+			exit();
226
+		}
227
+		echo $output;
228
+	}
229 229
 
230 230
 
231
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
232
-    // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
231
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
232
+	// phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
233 233
 
234
-    /**
235
-     * generate string from exception trace args
236
-     *
237
-     * @param array $arguments
238
-     * @param int   $indent
239
-     * @param bool  $array
240
-     * @return string
241
-     */
242
-    private function _convert_args_to_string($arguments = array(), $indent = 0, $array = false)
243
-    {
244
-        $args = array();
245
-        $args_count = count($arguments);
246
-        if ($args_count > 2) {
247
-            $indent++;
248
-            $args[] = '<br />';
249
-        }
250
-        $x = 0;
251
-        foreach ($arguments as $arg) {
252
-            $x++;
253
-            for ($i = 0; $i < $indent; $i++) {
254
-                $args[] = ' &nbsp;&nbsp; ';
255
-            }
256
-            if (is_string($arg)) {
257
-                if (! $array && strlen($arg) > 75) {
258
-                    $args[] = '<br />';
259
-                    for ($i = 0; $i <= $indent; $i++) {
260
-                        $args[] = ' &nbsp;&nbsp; ';
261
-                    }
262
-                    $args[] = "'" . $arg . "'<br />";
263
-                } else {
264
-                    $args[] = " '" . $arg . "'";
265
-                }
266
-            } elseif (is_array($arg)) {
267
-                $arg_count = count($arg);
268
-                if ($arg_count > 2) {
269
-                    $indent++;
270
-                    $args[] = ' array(' . $this->_convert_args_to_string($arg, $indent, true) . ')';
271
-                    $indent--;
272
-                } elseif ($arg_count === 0) {
273
-                    $args[] = ' array()';
274
-                } else {
275
-                    $args[] = ' array( ' . $this->_convert_args_to_string($arg) . ' )';
276
-                }
277
-            } elseif ($arg === null) {
278
-                $args[] = ' null';
279
-            } elseif (is_bool($arg)) {
280
-                $args[] = $arg ? ' true' : ' false';
281
-            } elseif (is_object($arg)) {
282
-                $args[] = get_class($arg);
283
-            } elseif (is_resource($arg)) {
284
-                $args[] = get_resource_type($arg);
285
-            } else {
286
-                $args[] = $arg;
287
-            }
288
-            if ($x === $args_count) {
289
-                if ($args_count > 2) {
290
-                    $args[] = '<br />';
291
-                    $indent--;
292
-                    for ($i = 1; $i < $indent; $i++) {
293
-                        $args[] = ' &nbsp;&nbsp; ';
294
-                    }
295
-                }
296
-            } else {
297
-                $args[] = $args_count > 2 ? ',<br />' : ', ';
298
-            }
299
-        }
300
-        return implode('', $args);
301
-    }
234
+	/**
235
+	 * generate string from exception trace args
236
+	 *
237
+	 * @param array $arguments
238
+	 * @param int   $indent
239
+	 * @param bool  $array
240
+	 * @return string
241
+	 */
242
+	private function _convert_args_to_string($arguments = array(), $indent = 0, $array = false)
243
+	{
244
+		$args = array();
245
+		$args_count = count($arguments);
246
+		if ($args_count > 2) {
247
+			$indent++;
248
+			$args[] = '<br />';
249
+		}
250
+		$x = 0;
251
+		foreach ($arguments as $arg) {
252
+			$x++;
253
+			for ($i = 0; $i < $indent; $i++) {
254
+				$args[] = ' &nbsp;&nbsp; ';
255
+			}
256
+			if (is_string($arg)) {
257
+				if (! $array && strlen($arg) > 75) {
258
+					$args[] = '<br />';
259
+					for ($i = 0; $i <= $indent; $i++) {
260
+						$args[] = ' &nbsp;&nbsp; ';
261
+					}
262
+					$args[] = "'" . $arg . "'<br />";
263
+				} else {
264
+					$args[] = " '" . $arg . "'";
265
+				}
266
+			} elseif (is_array($arg)) {
267
+				$arg_count = count($arg);
268
+				if ($arg_count > 2) {
269
+					$indent++;
270
+					$args[] = ' array(' . $this->_convert_args_to_string($arg, $indent, true) . ')';
271
+					$indent--;
272
+				} elseif ($arg_count === 0) {
273
+					$args[] = ' array()';
274
+				} else {
275
+					$args[] = ' array( ' . $this->_convert_args_to_string($arg) . ' )';
276
+				}
277
+			} elseif ($arg === null) {
278
+				$args[] = ' null';
279
+			} elseif (is_bool($arg)) {
280
+				$args[] = $arg ? ' true' : ' false';
281
+			} elseif (is_object($arg)) {
282
+				$args[] = get_class($arg);
283
+			} elseif (is_resource($arg)) {
284
+				$args[] = get_resource_type($arg);
285
+			} else {
286
+				$args[] = $arg;
287
+			}
288
+			if ($x === $args_count) {
289
+				if ($args_count > 2) {
290
+					$args[] = '<br />';
291
+					$indent--;
292
+					for ($i = 1; $i < $indent; $i++) {
293
+						$args[] = ' &nbsp;&nbsp; ';
294
+					}
295
+				}
296
+			} else {
297
+				$args[] = $args_count > 2 ? ',<br />' : ', ';
298
+			}
299
+		}
300
+		return implode('', $args);
301
+	}
302 302
 
303 303
 
304
-    /**
305
-     * create error code from filepath, function name,
306
-     * and line number where exception or error was thrown
307
-     *
308
-     * @access protected
309
-     * @param string $file
310
-     * @param string $func
311
-     * @param string $line
312
-     * @return string
313
-     */
314
-    protected function generate_error_code($file = '', $func = '', $line = '')
315
-    {
316
-        $file_bits = explode('.', basename($file));
317
-        $error_code = ! empty($file_bits[0]) ? $file_bits[0] : '';
318
-        $error_code .= ! empty($func) ? ' - ' . $func : '';
319
-        $error_code .= ! empty($line) ? ' - ' . $line : '';
320
-        return $error_code;
321
-    }
304
+	/**
305
+	 * create error code from filepath, function name,
306
+	 * and line number where exception or error was thrown
307
+	 *
308
+	 * @access protected
309
+	 * @param string $file
310
+	 * @param string $func
311
+	 * @param string $line
312
+	 * @return string
313
+	 */
314
+	protected function generate_error_code($file = '', $func = '', $line = '')
315
+	{
316
+		$file_bits = explode('.', basename($file));
317
+		$error_code = ! empty($file_bits[0]) ? $file_bits[0] : '';
318
+		$error_code .= ! empty($func) ? ' - ' . $func : '';
319
+		$error_code .= ! empty($line) ? ' - ' . $line : '';
320
+		return $error_code;
321
+	}
322 322
 
323 323
 
324
-    /**
325
-     * _exception_styles
326
-     *
327
-     * @return string
328
-     */
329
-    private function exceptionStyles()
330
-    {
331
-        return '
324
+	/**
325
+	 * _exception_styles
326
+	 *
327
+	 * @return string
328
+	 */
329
+	private function exceptionStyles()
330
+	{
331
+		return '
332 332
 <style type="text/css">
333 333
 	#ee-error-message {
334 334
 		max-width:90% !important;
@@ -385,29 +385,29 @@  discard block
 block discarded – undo
385 385
 		color: #999;
386 386
 	}
387 387
 </style>';
388
-    }
388
+	}
389 389
 
390 390
 
391
-    /**
392
-     * _print_scripts
393
-     *
394
-     * @param bool $force_print
395
-     * @return string
396
-     */
397
-    private function printScripts($force_print = false)
398
-    {
399
-        if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
400
-            if (wp_script_is('ee_error_js', 'enqueued')) {
401
-                return '';
402
-            }
403
-            if (wp_script_is('ee_error_js', 'registered')) {
404
-                wp_enqueue_style('espresso_default');
405
-                wp_enqueue_style('espresso_custom_css');
406
-                wp_enqueue_script('ee_error_js');
407
-                wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG));
408
-            }
409
-        } else {
410
-            return '
391
+	/**
392
+	 * _print_scripts
393
+	 *
394
+	 * @param bool $force_print
395
+	 * @return string
396
+	 */
397
+	private function printScripts($force_print = false)
398
+	{
399
+		if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
400
+			if (wp_script_is('ee_error_js', 'enqueued')) {
401
+				return '';
402
+			}
403
+			if (wp_script_is('ee_error_js', 'registered')) {
404
+				wp_enqueue_style('espresso_default');
405
+				wp_enqueue_style('espresso_custom_css');
406
+				wp_enqueue_script('ee_error_js');
407
+				wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug' => WP_DEBUG));
408
+			}
409
+		} else {
410
+			return '
411 411
 <script>
412 412
 /* <![CDATA[ */
413 413
 var ee_settings = {"wp_debug":"' . WP_DEBUG . '"};
@@ -417,7 +417,7 @@  discard block
 block discarded – undo
417 417
 <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
418 418
 <script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
419 419
 ';
420
-        }
421
-        return '';
422
-    }
420
+		}
421
+		return '';
422
+	}
423 423
 }
Please login to merge, or discard this patch.
Spacing   +23 added lines, -23 removed lines patch added patch discarded remove patch
@@ -53,7 +53,7 @@  discard block
 block discarded – undo
53 53
         $output = $this->exceptionStyles();
54 54
         $output .= '
55 55
 <div id="ee-error-message" class="error">';
56
-        if (! WP_DEBUG) {
56
+        if ( ! WP_DEBUG) {
57 57
             $output .= '
58 58
 	<p>';
59 59
         }
@@ -71,11 +71,11 @@  discard block
 block discarded – undo
71 71
 					<th scope="col" align="right" style="width:2.5%;">#</th>
72 72
 					<th scope="col" align="right" style="width:3.5%;">Line</th>
73 73
 					<th scope="col" align="left" style="width:40%;">File</th>
74
-					<th scope="col" align="left">' . __('Class', 'event_espresso') . '->'
74
+					<th scope="col" align="left">' . __('Class', 'event_espresso').'->'
75 75
                               . __(
76 76
                                   'Method( arguments )',
77 77
                                   'event_espresso'
78
-                              ) . '</th>
78
+                              ).'</th>
79 79
 				</tr>';
80 80
             $last_on_stack = count($trace) - 1;
81 81
             // reverse array so that stack is in proper chronological order
@@ -86,7 +86,7 @@  discard block
 block discarded – undo
86 86
                 $type = isset($trace['type']) ? $trace['type'] : '';
87 87
                 $function = isset($trace['function']) ? $trace['function'] : '';
88 88
                 $args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : '';
89
-                $args = isset($trace['args']) && count($trace['args']) > 4 ? ' <br />' . $args . '<br />' : $args;
89
+                $args = isset($trace['args']) && count($trace['args']) > 4 ? ' <br />'.$args.'<br />' : $args;
90 90
                 $line = isset($trace['line']) ? $trace['line'] : '';
91 91
                 $zebra = $nmbr % 2 !== 0 ? ' odd' : '';
92 92
                 if (empty($file) && ! empty($class)) {
@@ -114,7 +114,7 @@  discard block
 block discarded – undo
114 114
                 $class_display = ! empty($class) ? $class : '';
115 115
                 $type = ! empty($type) ? $type : '';
116 116
                 $function = ! empty($function) ? $function : '';
117
-                $args = ! empty($args) ? '( ' . $args . ' )' : '()';
117
+                $args = ! empty($args) ? '( '.$args.' )' : '()';
118 118
                 $trace_details .= '
119 119
 					<tr>
120 120
 						<td align="right" valign="top" class="'
@@ -148,7 +148,7 @@  discard block
 block discarded – undo
148 148
         }
149 149
         $code = $exception->getCode() ? $exception->getCode() : $error_code;
150 150
         // add generic non-identifying messages for non-privileged users
151
-        if (! WP_DEBUG) {
151
+        if ( ! WP_DEBUG) {
152 152
             $output .= '<span class="ee-error-user-msg-spn">'
153 153
                        . trim($msg)
154 154
                        . '</span> &nbsp; <sup>'
@@ -165,7 +165,7 @@  discard block
 block discarded – undo
165 165
                            '<strong class="ee-error-dev-msg-str">',
166 166
                            get_class($exception),
167 167
                            '</strong>  &nbsp; <span>',
168
-                           $code . '</span>'
168
+                           $code.'</span>'
169 169
                        )
170 170
                        . '<br />
171 171
 				<span class="big-text">"'
@@ -195,14 +195,14 @@  discard block
 block discarded – undo
195 195
                        . '-dv" class="ee-error-trace-dv" style="display: none;">
196 196
 				'
197 197
                        . $trace_details;
198
-            if (! empty($class)) {
198
+            if ( ! empty($class)) {
199 199
                 $output .= '
200 200
 				<div style="padding:3px; margin:0 0 1em; border:1px solid #999; background:#fff; border-radius:3px;">
201 201
 					<div style="padding:1em 2em; border:1px solid #999; background:#fcfcfc;">
202
-						<h3>' . __('Class Details', 'event_espresso') . '</h3>';
202
+						<h3>' . __('Class Details', 'event_espresso').'</h3>';
203 203
                 $a = new ReflectionClass($class);
204 204
                 $output .= '
205
-						<pre>' . $a . '</pre>
205
+						<pre>' . $a.'</pre>
206 206
 					</div>
207 207
 				</div>';
208 208
             }
@@ -213,7 +213,7 @@  discard block
 block discarded – undo
213 213
         }
214 214
         // remove last linebreak
215 215
         $output = substr($output, 0, -6);
216
-        if (! WP_DEBUG) {
216
+        if ( ! WP_DEBUG) {
217 217
             $output .= '
218 218
 	</p>';
219 219
         }
@@ -254,25 +254,25 @@  discard block
 block discarded – undo
254 254
                 $args[] = ' &nbsp;&nbsp; ';
255 255
             }
256 256
             if (is_string($arg)) {
257
-                if (! $array && strlen($arg) > 75) {
257
+                if ( ! $array && strlen($arg) > 75) {
258 258
                     $args[] = '<br />';
259 259
                     for ($i = 0; $i <= $indent; $i++) {
260 260
                         $args[] = ' &nbsp;&nbsp; ';
261 261
                     }
262
-                    $args[] = "'" . $arg . "'<br />";
262
+                    $args[] = "'".$arg."'<br />";
263 263
                 } else {
264
-                    $args[] = " '" . $arg . "'";
264
+                    $args[] = " '".$arg."'";
265 265
                 }
266 266
             } elseif (is_array($arg)) {
267 267
                 $arg_count = count($arg);
268 268
                 if ($arg_count > 2) {
269 269
                     $indent++;
270
-                    $args[] = ' array(' . $this->_convert_args_to_string($arg, $indent, true) . ')';
270
+                    $args[] = ' array('.$this->_convert_args_to_string($arg, $indent, true).')';
271 271
                     $indent--;
272 272
                 } elseif ($arg_count === 0) {
273 273
                     $args[] = ' array()';
274 274
                 } else {
275
-                    $args[] = ' array( ' . $this->_convert_args_to_string($arg) . ' )';
275
+                    $args[] = ' array( '.$this->_convert_args_to_string($arg).' )';
276 276
                 }
277 277
             } elseif ($arg === null) {
278 278
                 $args[] = ' null';
@@ -315,8 +315,8 @@  discard block
 block discarded – undo
315 315
     {
316 316
         $file_bits = explode('.', basename($file));
317 317
         $error_code = ! empty($file_bits[0]) ? $file_bits[0] : '';
318
-        $error_code .= ! empty($func) ? ' - ' . $func : '';
319
-        $error_code .= ! empty($line) ? ' - ' . $line : '';
318
+        $error_code .= ! empty($func) ? ' - '.$func : '';
319
+        $error_code .= ! empty($line) ? ' - '.$line : '';
320 320
         return $error_code;
321 321
     }
322 322
 
@@ -396,7 +396,7 @@  discard block
 block discarded – undo
396 396
      */
397 397
     private function printScripts($force_print = false)
398 398
     {
399
-        if (! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
399
+        if ( ! $force_print && (did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts'))) {
400 400
             if (wp_script_is('ee_error_js', 'enqueued')) {
401 401
                 return '';
402 402
             }
@@ -410,12 +410,12 @@  discard block
 block discarded – undo
410 410
             return '
411 411
 <script>
412 412
 /* <![CDATA[ */
413
-var ee_settings = {"wp_debug":"' . WP_DEBUG . '"};
413
+var ee_settings = {"wp_debug":"' . WP_DEBUG.'"};
414 414
 /* ]]> */
415 415
 </script>
416
-<script src="' . includes_url() . 'js/jquery/jquery.js" type="text/javascript"></script>
417
-<script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
418
-<script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script>
416
+<script src="' . includes_url().'js/jquery/jquery.js" type="text/javascript"></script>
417
+<script src="' . EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js'.'?ver='.espresso_version().'" type="text/javascript"></script>
418
+<script src="' . EE_GLOBAL_ASSETS_URL.'scripts/EE_Error.js'.'?ver='.espresso_version().'" type="text/javascript"></script>
419 419
 ';
420 420
         }
421 421
         return '';
Please login to merge, or discard this patch.
core/services/cache/PostRelatedCacheManager.php 2 patches
Indentation   +117 added lines, -117 removed lines patch added patch discarded remove patch
@@ -13,121 +13,121 @@
 block discarded – undo
13 13
 class PostRelatedCacheManager extends BasicCacheManager
14 14
 {
15 15
 
16
-    /**
17
-     * @type string
18
-     */
19
-    const POST_CACHE_PREFIX = 'ee_cache_post_';
20
-
21
-    /**
22
-     * wp-option option_name for tracking post related cache
23
-     *
24
-     * @type string
25
-     */
26
-    const POST_CACHE_OPTIONS_KEY = 'ee_post_cache';
27
-
28
-
29
-    /**
30
-     * PostRelatedCacheManager constructor.
31
-     *
32
-     * @param CacheStorageInterface $cache_storage
33
-     */
34
-    public function __construct(CacheStorageInterface $cache_storage)
35
-    {
36
-        parent::__construct($cache_storage);
37
-        add_action('save_post', array($this, 'clearPostRelatedCache'));
38
-    }
39
-
40
-
41
-    /**
42
-     * returns a string that will be prepended to all cache identifiers
43
-     *
44
-     * @return string
45
-     */
46
-    public function cachePrefix()
47
-    {
48
-        return PostRelatedCacheManager::POST_CACHE_PREFIX;
49
-    }
50
-
51
-
52
-    /**
53
-     * @return array
54
-     */
55
-    protected function getPostRelatedCache()
56
-    {
57
-        $post_related_cache = get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
58
-        // verify that cached data was not truncated or corrupted and no longer an array
59
-        if (! is_array($post_related_cache)) {
60
-            // uh-oh... let's get rid of any transients using our cache prefix
61
-            $this->clear(PostRelatedCacheManager::CACHE_PREFIX);
62
-            // then update the post related cache tracking option
63
-            $post_related_cache = array();
64
-            $this->updatePostRelatedCache($post_related_cache);
65
-        }
66
-        return $post_related_cache;
67
-    }
68
-
69
-
70
-    /**
71
-     * @param array $post_related_cache
72
-     */
73
-    protected function updatePostRelatedCache(array $post_related_cache = array())
74
-    {
75
-        update_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, $post_related_cache);
76
-    }
77
-
78
-
79
-    /**
80
-     * If you are caching content that pertains to a Post of any type,
81
-     * then it is recommended to pass the post id and cache id prefix to this method
82
-     * so that it can be added to the post related cache tracking.
83
-     * Then, whenever that post is updated, the cache will automatically be deleted,
84
-     * which helps to ensure that outdated cache content will not be served
85
-     *
86
-     * @param int    $post_ID    [required]
87
-     * @param string $id_prefix  [required] Appended to all cache IDs. Can be helpful in finding specific cache types.
88
-     *                           May also be helpful to include an additional specific identifier,
89
-     *                           such as a post ID as part of the $id_prefix so that individual caches
90
-     *                           can be found and/or cleared. ex: "venue-28", or "shortcode-156".
91
-     *                           BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id.
92
-     */
93
-    public function clearPostRelatedCacheOnUpdate($post_ID, $id_prefix)
94
-    {
95
-        $post_related_cache = $this->getPostRelatedCache();
96
-        // if post is not already being tracked
97
-        if (! isset($post_related_cache[ $post_ID ])) {
98
-            // add array to add cache ids to
99
-            $post_related_cache[ $post_ID ] = array();
100
-        }
101
-        if (! in_array($id_prefix, $post_related_cache[ $post_ID ], true)) {
102
-            // add cache id to be tracked
103
-            $post_related_cache[ $post_ID ][] = $id_prefix;
104
-            $this->updatePostRelatedCache($post_related_cache);
105
-        }
106
-    }
107
-
108
-
109
-    /**
110
-     * callback hooked into the WordPress "save_post" action
111
-     * deletes any cache content associated with the post
112
-     *
113
-     * @param int $post_ID [required]
114
-     */
115
-    public function clearPostRelatedCache($post_ID)
116
-    {
117
-        $post_related_cache = $this->getPostRelatedCache();
118
-        // if post is not being tracked
119
-        if (! isset($post_related_cache[ $post_ID ])) {
120
-            // let's clean up some of the duplicate IDs that were getting added
121
-            foreach ($post_related_cache as $other_post_ID => $cache_IDs) {
122
-                // remove duplicates
123
-                $post_related_cache[ $other_post_ID ] = array_unique($post_related_cache[ $other_post_ID ]);
124
-            }
125
-            $this->updatePostRelatedCache($post_related_cache);
126
-            return;
127
-        }
128
-        // get cache id prefixes for post, and delete their corresponding transients
129
-        $this->clear($post_related_cache[ $post_ID ]);
130
-        unset($post_related_cache[ $post_ID ]);
131
-        $this->updatePostRelatedCache($post_related_cache);
132
-    }
16
+	/**
17
+	 * @type string
18
+	 */
19
+	const POST_CACHE_PREFIX = 'ee_cache_post_';
20
+
21
+	/**
22
+	 * wp-option option_name for tracking post related cache
23
+	 *
24
+	 * @type string
25
+	 */
26
+	const POST_CACHE_OPTIONS_KEY = 'ee_post_cache';
27
+
28
+
29
+	/**
30
+	 * PostRelatedCacheManager constructor.
31
+	 *
32
+	 * @param CacheStorageInterface $cache_storage
33
+	 */
34
+	public function __construct(CacheStorageInterface $cache_storage)
35
+	{
36
+		parent::__construct($cache_storage);
37
+		add_action('save_post', array($this, 'clearPostRelatedCache'));
38
+	}
39
+
40
+
41
+	/**
42
+	 * returns a string that will be prepended to all cache identifiers
43
+	 *
44
+	 * @return string
45
+	 */
46
+	public function cachePrefix()
47
+	{
48
+		return PostRelatedCacheManager::POST_CACHE_PREFIX;
49
+	}
50
+
51
+
52
+	/**
53
+	 * @return array
54
+	 */
55
+	protected function getPostRelatedCache()
56
+	{
57
+		$post_related_cache = get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
58
+		// verify that cached data was not truncated or corrupted and no longer an array
59
+		if (! is_array($post_related_cache)) {
60
+			// uh-oh... let's get rid of any transients using our cache prefix
61
+			$this->clear(PostRelatedCacheManager::CACHE_PREFIX);
62
+			// then update the post related cache tracking option
63
+			$post_related_cache = array();
64
+			$this->updatePostRelatedCache($post_related_cache);
65
+		}
66
+		return $post_related_cache;
67
+	}
68
+
69
+
70
+	/**
71
+	 * @param array $post_related_cache
72
+	 */
73
+	protected function updatePostRelatedCache(array $post_related_cache = array())
74
+	{
75
+		update_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, $post_related_cache);
76
+	}
77
+
78
+
79
+	/**
80
+	 * If you are caching content that pertains to a Post of any type,
81
+	 * then it is recommended to pass the post id and cache id prefix to this method
82
+	 * so that it can be added to the post related cache tracking.
83
+	 * Then, whenever that post is updated, the cache will automatically be deleted,
84
+	 * which helps to ensure that outdated cache content will not be served
85
+	 *
86
+	 * @param int    $post_ID    [required]
87
+	 * @param string $id_prefix  [required] Appended to all cache IDs. Can be helpful in finding specific cache types.
88
+	 *                           May also be helpful to include an additional specific identifier,
89
+	 *                           such as a post ID as part of the $id_prefix so that individual caches
90
+	 *                           can be found and/or cleared. ex: "venue-28", or "shortcode-156".
91
+	 *                           BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id.
92
+	 */
93
+	public function clearPostRelatedCacheOnUpdate($post_ID, $id_prefix)
94
+	{
95
+		$post_related_cache = $this->getPostRelatedCache();
96
+		// if post is not already being tracked
97
+		if (! isset($post_related_cache[ $post_ID ])) {
98
+			// add array to add cache ids to
99
+			$post_related_cache[ $post_ID ] = array();
100
+		}
101
+		if (! in_array($id_prefix, $post_related_cache[ $post_ID ], true)) {
102
+			// add cache id to be tracked
103
+			$post_related_cache[ $post_ID ][] = $id_prefix;
104
+			$this->updatePostRelatedCache($post_related_cache);
105
+		}
106
+	}
107
+
108
+
109
+	/**
110
+	 * callback hooked into the WordPress "save_post" action
111
+	 * deletes any cache content associated with the post
112
+	 *
113
+	 * @param int $post_ID [required]
114
+	 */
115
+	public function clearPostRelatedCache($post_ID)
116
+	{
117
+		$post_related_cache = $this->getPostRelatedCache();
118
+		// if post is not being tracked
119
+		if (! isset($post_related_cache[ $post_ID ])) {
120
+			// let's clean up some of the duplicate IDs that were getting added
121
+			foreach ($post_related_cache as $other_post_ID => $cache_IDs) {
122
+				// remove duplicates
123
+				$post_related_cache[ $other_post_ID ] = array_unique($post_related_cache[ $other_post_ID ]);
124
+			}
125
+			$this->updatePostRelatedCache($post_related_cache);
126
+			return;
127
+		}
128
+		// get cache id prefixes for post, and delete their corresponding transients
129
+		$this->clear($post_related_cache[ $post_ID ]);
130
+		unset($post_related_cache[ $post_ID ]);
131
+		$this->updatePostRelatedCache($post_related_cache);
132
+	}
133 133
 }
Please login to merge, or discard this patch.
Spacing   +9 added lines, -9 removed lines patch added patch discarded remove patch
@@ -56,7 +56,7 @@  discard block
 block discarded – undo
56 56
     {
57 57
         $post_related_cache = get_option(PostRelatedCacheManager::POST_CACHE_OPTIONS_KEY, array());
58 58
         // verify that cached data was not truncated or corrupted and no longer an array
59
-        if (! is_array($post_related_cache)) {
59
+        if ( ! is_array($post_related_cache)) {
60 60
             // uh-oh... let's get rid of any transients using our cache prefix
61 61
             $this->clear(PostRelatedCacheManager::CACHE_PREFIX);
62 62
             // then update the post related cache tracking option
@@ -94,13 +94,13 @@  discard block
 block discarded – undo
94 94
     {
95 95
         $post_related_cache = $this->getPostRelatedCache();
96 96
         // if post is not already being tracked
97
-        if (! isset($post_related_cache[ $post_ID ])) {
97
+        if ( ! isset($post_related_cache[$post_ID])) {
98 98
             // add array to add cache ids to
99
-            $post_related_cache[ $post_ID ] = array();
99
+            $post_related_cache[$post_ID] = array();
100 100
         }
101
-        if (! in_array($id_prefix, $post_related_cache[ $post_ID ], true)) {
101
+        if ( ! in_array($id_prefix, $post_related_cache[$post_ID], true)) {
102 102
             // add cache id to be tracked
103
-            $post_related_cache[ $post_ID ][] = $id_prefix;
103
+            $post_related_cache[$post_ID][] = $id_prefix;
104 104
             $this->updatePostRelatedCache($post_related_cache);
105 105
         }
106 106
     }
@@ -116,18 +116,18 @@  discard block
 block discarded – undo
116 116
     {
117 117
         $post_related_cache = $this->getPostRelatedCache();
118 118
         // if post is not being tracked
119
-        if (! isset($post_related_cache[ $post_ID ])) {
119
+        if ( ! isset($post_related_cache[$post_ID])) {
120 120
             // let's clean up some of the duplicate IDs that were getting added
121 121
             foreach ($post_related_cache as $other_post_ID => $cache_IDs) {
122 122
                 // remove duplicates
123
-                $post_related_cache[ $other_post_ID ] = array_unique($post_related_cache[ $other_post_ID ]);
123
+                $post_related_cache[$other_post_ID] = array_unique($post_related_cache[$other_post_ID]);
124 124
             }
125 125
             $this->updatePostRelatedCache($post_related_cache);
126 126
             return;
127 127
         }
128 128
         // get cache id prefixes for post, and delete their corresponding transients
129
-        $this->clear($post_related_cache[ $post_ID ]);
130
-        unset($post_related_cache[ $post_ID ]);
129
+        $this->clear($post_related_cache[$post_ID]);
130
+        unset($post_related_cache[$post_ID]);
131 131
         $this->updatePostRelatedCache($post_related_cache);
132 132
     }
133 133
 }
Please login to merge, or discard this patch.
core/services/cache/TransientCacheStorage.php 2 patches
Indentation   +362 added lines, -362 removed lines patch added patch discarded remove patch
@@ -16,366 +16,366 @@
 block discarded – undo
16 16
 class TransientCacheStorage implements CacheStorageInterface
17 17
 {
18 18
 
19
-    /**
20
-     * wp-option option_name for tracking transients
21
-     *
22
-     * @type string
23
-     */
24
-    const TRANSIENT_SCHEDULE_OPTIONS_KEY = 'ee_transient_schedule';
25
-
26
-    /**
27
-     * @var int $current_time
28
-     */
29
-    private $current_time;
30
-
31
-    /**
32
-     * how often to perform transient cleanup
33
-     *
34
-     * @var string $transient_cleanup_frequency
35
-     */
36
-    private $transient_cleanup_frequency;
37
-
38
-    /**
39
-     * options for how often to perform transient cleanup
40
-     *
41
-     * @var array $transient_cleanup_frequency_options
42
-     */
43
-    private $transient_cleanup_frequency_options = array();
44
-
45
-    /**
46
-     * @var array $transients
47
-     */
48
-    private $transients;
49
-
50
-
51
-    /**
52
-     * TransientCacheStorage constructor.
53
-     */
54
-    public function __construct()
55
-    {
56
-        $this->transient_cleanup_frequency = $this->setTransientCleanupFrequency();
57
-        // round current time down to closest 5 minutes to simplify scheduling
58
-        $this->current_time = $this->roundTimestamp(time(), '5-minutes', false);
59
-        $this->transients = (array) get_option(TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY, array());
60
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && $this->transient_cleanup_frequency !== 'off') {
61
-            add_action('shutdown', array($this, 'checkTransientCleanupSchedule'), 999);
62
-        }
63
-    }
64
-
65
-
66
-    /**
67
-     * Sets how often transient cleanup occurs
68
-     *
69
-     * @return string
70
-     */
71
-    private function setTransientCleanupFrequency()
72
-    {
73
-        // sets how often transients are cleaned up
74
-        $this->transient_cleanup_frequency_options = apply_filters(
75
-            'FHEE__TransientCacheStorage__transient_cleanup_schedule_options',
76
-            array(
77
-                'off',
78
-                '15-minutes',
79
-                'hour',
80
-                '12-hours',
81
-                'day',
82
-            )
83
-        );
84
-        $transient_cleanup_frequency = apply_filters(
85
-            'FHEE__TransientCacheStorage__transient_cleanup_schedule',
86
-            'hour'
87
-        );
88
-        return in_array(
89
-            $transient_cleanup_frequency,
90
-            $this->transient_cleanup_frequency_options,
91
-            true
92
-        )
93
-            ? $transient_cleanup_frequency
94
-            : 'hour';
95
-    }
96
-
97
-
98
-    /**
99
-     * we need to be able to round timestamps off to match the set transient cleanup frequency
100
-     * so if a transient is set to expire at 1:17 pm for example, and our cleanup schedule is every hour,
101
-     * then that timestamp needs to be rounded up to 2:00 pm so that it is removed
102
-     * during the next scheduled cleanup after its expiration.
103
-     * We also round off the current time timestamp to the closest 5 minutes
104
-     * just to make the timestamps a little easier to round which helps with debugging.
105
-     *
106
-     * @param int    $timestamp [required]
107
-     * @param string $cleanup_frequency
108
-     * @param bool   $round_up
109
-     * @return int
110
-     */
111
-    private function roundTimestamp($timestamp, $cleanup_frequency = 'hour', $round_up = true)
112
-    {
113
-        $cleanup_frequency = $cleanup_frequency ? $cleanup_frequency : $this->transient_cleanup_frequency;
114
-        // in order to round the time to the closest xx minutes (or hours),
115
-        // we take the minutes (or hours) portion of the timestamp and divide it by xx,
116
-        // round down to a whole number, then multiply by xx to bring us almost back up to where we were
117
-        // why round down ? so the minutes (or hours) don't go over 60 (or 24)
118
-        // and bump the hour, which could bump the day, which could bump the month, etc,
119
-        // which would be bad because we don't always want to round up,
120
-        // but when we do we can easily achieve that by simply adding the desired offset,
121
-        $minutes = '00';
122
-        $hours = 'H';
123
-        switch ($cleanup_frequency) {
124
-            case '5-minutes':
125
-                $minutes = floor((int) date('i', $timestamp) / 5) * 5;
126
-                $minutes = str_pad($minutes, 2, '0', STR_PAD_LEFT);
127
-                $offset = MINUTE_IN_SECONDS * 5;
128
-                break;
129
-            case '15-minutes':
130
-                $minutes = floor((int) date('i', $timestamp) / 15) * 15;
131
-                $minutes = str_pad($minutes, 2, '0', STR_PAD_LEFT);
132
-                $offset = MINUTE_IN_SECONDS * 15;
133
-                break;
134
-            case '12-hours':
135
-                $hours = floor((int) date('H', $timestamp) / 12) * 12;
136
-                $hours = str_pad($hours, 2, '0', STR_PAD_LEFT);
137
-                $offset = HOUR_IN_SECONDS * 12;
138
-                break;
139
-            case 'day':
140
-                $hours = '03'; // run cleanup at 3:00 am (or first site hit after that)
141
-                $offset = DAY_IN_SECONDS;
142
-                break;
143
-            case 'hour':
144
-            default:
145
-                $offset = HOUR_IN_SECONDS;
146
-                break;
147
-        }
148
-        $rounded_timestamp = (int) strtotime(date("Y-m-d {$hours}:{$minutes}:00", $timestamp));
149
-        $rounded_timestamp += $round_up ? $offset : 0;
150
-        return apply_filters(
151
-            'FHEE__TransientCacheStorage__roundTimestamp__timestamp',
152
-            $rounded_timestamp,
153
-            $timestamp,
154
-            $cleanup_frequency,
155
-            $round_up
156
-        );
157
-    }
158
-
159
-
160
-    /**
161
-     * Saves supplied data to a transient
162
-     * if an expiration is set, then it automatically schedules the transient for cleanup
163
-     *
164
-     * @param string $transient_key [required]
165
-     * @param string $data          [required]
166
-     * @param int    $expiration    number of seconds until the cache expires
167
-     * @return bool
168
-     */
169
-    public function add($transient_key, $data, $expiration = 0)
170
-    {
171
-        $expiration = (int) abs($expiration);
172
-        $saved = set_transient($transient_key, $data, $expiration);
173
-        if ($saved && $expiration) {
174
-            $this->scheduleTransientCleanup($transient_key, $expiration);
175
-        }
176
-        return $saved;
177
-    }
178
-
179
-
180
-    /**
181
-     * retrieves transient data
182
-     * automatically triggers early cache refresh for standard cache items
183
-     * in order to avoid cache stampedes on busy sites.
184
-     * For non-standard cache items like PHP Session data where early refreshing is not wanted,
185
-     * the $standard_cache parameter should be set to false when retrieving data
186
-     *
187
-     * @param string $transient_key [required]
188
-     * @param bool   $standard_cache
189
-     * @return mixed|null
190
-     */
191
-    public function get($transient_key, $standard_cache = true)
192
-    {
193
-        if (isset($this->transients[ $transient_key ])) {
194
-            // to avoid cache stampedes (AKA:dogpiles) for standard cache items,
195
-            // check if known cache expires within the next minute,
196
-            // and if so, remove it from our tracking and and return nothing.
197
-            // this should trigger the cache content to be regenerated during this request,
198
-            // while allowing any following requests to still access the existing cache
199
-            // until it gets replaced with the refreshed content
200
-            if ($standard_cache
201
-                && $this->transients[ $transient_key ] - time() <= MINUTE_IN_SECONDS
202
-            ) {
203
-                unset($this->transients[ $transient_key ]);
204
-                $this->updateTransients();
205
-                return null;
206
-            }
207
-
208
-            // for non standard cache items, remove the key from our tracking,
209
-            // but proceed to retrieve the transient so that it also gets removed from the db
210
-            if ($this->transients[ $transient_key ] <= time()) {
211
-                unset($this->transients[ $transient_key ]);
212
-                $this->updateTransients();
213
-            }
214
-        }
215
-
216
-        $content = get_transient($transient_key);
217
-        return $content !== false ? $content : null;
218
-    }
219
-
220
-
221
-    /**
222
-     * delete a single transient and remove tracking
223
-     *
224
-     * @param string $transient_key [required] full or partial transient key to be deleted
225
-     */
226
-    public function delete($transient_key)
227
-    {
228
-        $this->deleteMany(array($transient_key));
229
-    }
230
-
231
-
232
-    /**
233
-     * delete multiple transients and remove tracking
234
-     *
235
-     * @param array $transient_keys [required] array of full or partial transient keys to be deleted
236
-     * @param bool  $force_delete   [optional] if true, then will not check incoming keys against those being tracked
237
-     *                              and proceed directly to deleting those entries from the cache storage
238
-     */
239
-    public function deleteMany(array $transient_keys, $force_delete = false)
240
-    {
241
-        $full_transient_keys = $force_delete ? $transient_keys : array();
242
-        if (empty($full_transient_keys)) {
243
-            foreach ($this->transients as $transient_key => $expiration) {
244
-                foreach ($transient_keys as $transient_key_to_delete) {
245
-                    if (strpos($transient_key, $transient_key_to_delete) !== false) {
246
-                        $full_transient_keys[] = $transient_key;
247
-                    }
248
-                }
249
-            }
250
-        }
251
-        if ($this->deleteTransientKeys($full_transient_keys)) {
252
-            $this->updateTransients();
253
-        }
254
-    }
255
-
256
-
257
-    /**
258
-     * sorts transients numerically by timestamp
259
-     * then saves the transient schedule to a WP option
260
-     */
261
-    private function updateTransients()
262
-    {
263
-        asort($this->transients, SORT_NUMERIC);
264
-        update_option(
265
-            TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY,
266
-            $this->transients
267
-        );
268
-    }
269
-
270
-
271
-    /**
272
-     * schedules a transient for cleanup by adding it to the transient tracking
273
-     *
274
-     * @param string $transient_key [required]
275
-     * @param int    $expiration    [required]
276
-     */
277
-    private function scheduleTransientCleanup($transient_key, $expiration)
278
-    {
279
-        // make sure a valid future timestamp is set
280
-        $expiration += $expiration < time() ? time() : 0;
281
-        // and round to the closest 15 minutes
282
-        $expiration = $this->roundTimestamp($expiration);
283
-        // save transients to clear using their ID as the key to avoid duplicates
284
-        $this->transients[ $transient_key ] = $expiration;
285
-        $this->updateTransients();
286
-    }
287
-
288
-
289
-    /**
290
-     * Since our tracked transients are sorted by their timestamps
291
-     * we can grab the first transient and see when it is scheduled for cleanup.
292
-     * If that timestamp is less than or equal to the current time,
293
-     * then cleanup is triggered
294
-     */
295
-    public function checkTransientCleanupSchedule()
296
-    {
297
-        if (empty($this->transients)) {
298
-            return;
299
-        }
300
-        // when do we run the next cleanup job?
301
-        reset($this->transients);
302
-        $next_scheduled_cleanup = current($this->transients);
303
-        // if the next cleanup job is scheduled for the current hour
304
-        if ($next_scheduled_cleanup <= $this->current_time) {
305
-            if ($this->cleanupExpiredTransients()) {
306
-                $this->updateTransients();
307
-            }
308
-        }
309
-    }
310
-
311
-
312
-    /**
313
-     * loops through the array of tracked transients,
314
-     * compiles a list of those that have expired, and sends that list off for deletion.
315
-     * Also removes any bad records from the transients array
316
-     *
317
-     * @return bool
318
-     */
319
-    private function cleanupExpiredTransients()
320
-    {
321
-        $update = false;
322
-        // filter the query limit. Set to 0 to turn off garbage collection
323
-        $limit = (int) abs(
324
-            apply_filters(
325
-                'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
326
-                50
327
-            )
328
-        );
329
-        // non-zero LIMIT means take out the trash
330
-        if ($limit) {
331
-            $transient_keys = array();
332
-            foreach ($this->transients as $transient_key => $expiration) {
333
-                if ($expiration > $this->current_time) {
334
-                    continue;
335
-                }
336
-                if (! $expiration || ! $transient_key) {
337
-                    unset($this->transients[ $transient_key ]);
338
-                    $update = true;
339
-                    continue;
340
-                }
341
-                $transient_keys[] = $transient_key;
342
-            }
343
-            // delete expired keys, but maintain value of $update if nothing is deleted
344
-            $update = $this->deleteTransientKeys($transient_keys, $limit) ? true : $update;
345
-            do_action('FHEE__TransientCacheStorage__clearExpiredTransients__end', $this);
346
-        }
347
-        return $update;
348
-    }
349
-
350
-
351
-    /**
352
-     * calls delete_transient() on each transient key provided, up to the specified limit
353
-     *
354
-     * @param array $transient_keys [required]
355
-     * @param int   $limit
356
-     * @return bool
357
-     */
358
-    private function deleteTransientKeys(array $transient_keys, $limit = 50)
359
-    {
360
-        if (empty($transient_keys)) {
361
-            return false;
362
-        }
363
-        $counter = 0;
364
-        foreach ($transient_keys as $transient_key) {
365
-            if ($counter === $limit) {
366
-                break;
367
-            }
368
-            // remove any transient prefixes
369
-            $transient_key = strpos($transient_key, '_transient_timeout_') === 0
370
-                ? str_replace('_transient_timeout_', '', $transient_key)
371
-                : $transient_key;
372
-            $transient_key = strpos($transient_key, '_transient_') === 0
373
-                ? str_replace('_transient_', '', $transient_key)
374
-                : $transient_key;
375
-            delete_transient($transient_key);
376
-            unset($this->transients[ $transient_key ]);
377
-            $counter++;
378
-        }
379
-        return $counter > 0;
380
-    }
19
+	/**
20
+	 * wp-option option_name for tracking transients
21
+	 *
22
+	 * @type string
23
+	 */
24
+	const TRANSIENT_SCHEDULE_OPTIONS_KEY = 'ee_transient_schedule';
25
+
26
+	/**
27
+	 * @var int $current_time
28
+	 */
29
+	private $current_time;
30
+
31
+	/**
32
+	 * how often to perform transient cleanup
33
+	 *
34
+	 * @var string $transient_cleanup_frequency
35
+	 */
36
+	private $transient_cleanup_frequency;
37
+
38
+	/**
39
+	 * options for how often to perform transient cleanup
40
+	 *
41
+	 * @var array $transient_cleanup_frequency_options
42
+	 */
43
+	private $transient_cleanup_frequency_options = array();
44
+
45
+	/**
46
+	 * @var array $transients
47
+	 */
48
+	private $transients;
49
+
50
+
51
+	/**
52
+	 * TransientCacheStorage constructor.
53
+	 */
54
+	public function __construct()
55
+	{
56
+		$this->transient_cleanup_frequency = $this->setTransientCleanupFrequency();
57
+		// round current time down to closest 5 minutes to simplify scheduling
58
+		$this->current_time = $this->roundTimestamp(time(), '5-minutes', false);
59
+		$this->transients = (array) get_option(TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY, array());
60
+		if (! (defined('DOING_AJAX') && DOING_AJAX) && $this->transient_cleanup_frequency !== 'off') {
61
+			add_action('shutdown', array($this, 'checkTransientCleanupSchedule'), 999);
62
+		}
63
+	}
64
+
65
+
66
+	/**
67
+	 * Sets how often transient cleanup occurs
68
+	 *
69
+	 * @return string
70
+	 */
71
+	private function setTransientCleanupFrequency()
72
+	{
73
+		// sets how often transients are cleaned up
74
+		$this->transient_cleanup_frequency_options = apply_filters(
75
+			'FHEE__TransientCacheStorage__transient_cleanup_schedule_options',
76
+			array(
77
+				'off',
78
+				'15-minutes',
79
+				'hour',
80
+				'12-hours',
81
+				'day',
82
+			)
83
+		);
84
+		$transient_cleanup_frequency = apply_filters(
85
+			'FHEE__TransientCacheStorage__transient_cleanup_schedule',
86
+			'hour'
87
+		);
88
+		return in_array(
89
+			$transient_cleanup_frequency,
90
+			$this->transient_cleanup_frequency_options,
91
+			true
92
+		)
93
+			? $transient_cleanup_frequency
94
+			: 'hour';
95
+	}
96
+
97
+
98
+	/**
99
+	 * we need to be able to round timestamps off to match the set transient cleanup frequency
100
+	 * so if a transient is set to expire at 1:17 pm for example, and our cleanup schedule is every hour,
101
+	 * then that timestamp needs to be rounded up to 2:00 pm so that it is removed
102
+	 * during the next scheduled cleanup after its expiration.
103
+	 * We also round off the current time timestamp to the closest 5 minutes
104
+	 * just to make the timestamps a little easier to round which helps with debugging.
105
+	 *
106
+	 * @param int    $timestamp [required]
107
+	 * @param string $cleanup_frequency
108
+	 * @param bool   $round_up
109
+	 * @return int
110
+	 */
111
+	private function roundTimestamp($timestamp, $cleanup_frequency = 'hour', $round_up = true)
112
+	{
113
+		$cleanup_frequency = $cleanup_frequency ? $cleanup_frequency : $this->transient_cleanup_frequency;
114
+		// in order to round the time to the closest xx minutes (or hours),
115
+		// we take the minutes (or hours) portion of the timestamp and divide it by xx,
116
+		// round down to a whole number, then multiply by xx to bring us almost back up to where we were
117
+		// why round down ? so the minutes (or hours) don't go over 60 (or 24)
118
+		// and bump the hour, which could bump the day, which could bump the month, etc,
119
+		// which would be bad because we don't always want to round up,
120
+		// but when we do we can easily achieve that by simply adding the desired offset,
121
+		$minutes = '00';
122
+		$hours = 'H';
123
+		switch ($cleanup_frequency) {
124
+			case '5-minutes':
125
+				$minutes = floor((int) date('i', $timestamp) / 5) * 5;
126
+				$minutes = str_pad($minutes, 2, '0', STR_PAD_LEFT);
127
+				$offset = MINUTE_IN_SECONDS * 5;
128
+				break;
129
+			case '15-minutes':
130
+				$minutes = floor((int) date('i', $timestamp) / 15) * 15;
131
+				$minutes = str_pad($minutes, 2, '0', STR_PAD_LEFT);
132
+				$offset = MINUTE_IN_SECONDS * 15;
133
+				break;
134
+			case '12-hours':
135
+				$hours = floor((int) date('H', $timestamp) / 12) * 12;
136
+				$hours = str_pad($hours, 2, '0', STR_PAD_LEFT);
137
+				$offset = HOUR_IN_SECONDS * 12;
138
+				break;
139
+			case 'day':
140
+				$hours = '03'; // run cleanup at 3:00 am (or first site hit after that)
141
+				$offset = DAY_IN_SECONDS;
142
+				break;
143
+			case 'hour':
144
+			default:
145
+				$offset = HOUR_IN_SECONDS;
146
+				break;
147
+		}
148
+		$rounded_timestamp = (int) strtotime(date("Y-m-d {$hours}:{$minutes}:00", $timestamp));
149
+		$rounded_timestamp += $round_up ? $offset : 0;
150
+		return apply_filters(
151
+			'FHEE__TransientCacheStorage__roundTimestamp__timestamp',
152
+			$rounded_timestamp,
153
+			$timestamp,
154
+			$cleanup_frequency,
155
+			$round_up
156
+		);
157
+	}
158
+
159
+
160
+	/**
161
+	 * Saves supplied data to a transient
162
+	 * if an expiration is set, then it automatically schedules the transient for cleanup
163
+	 *
164
+	 * @param string $transient_key [required]
165
+	 * @param string $data          [required]
166
+	 * @param int    $expiration    number of seconds until the cache expires
167
+	 * @return bool
168
+	 */
169
+	public function add($transient_key, $data, $expiration = 0)
170
+	{
171
+		$expiration = (int) abs($expiration);
172
+		$saved = set_transient($transient_key, $data, $expiration);
173
+		if ($saved && $expiration) {
174
+			$this->scheduleTransientCleanup($transient_key, $expiration);
175
+		}
176
+		return $saved;
177
+	}
178
+
179
+
180
+	/**
181
+	 * retrieves transient data
182
+	 * automatically triggers early cache refresh for standard cache items
183
+	 * in order to avoid cache stampedes on busy sites.
184
+	 * For non-standard cache items like PHP Session data where early refreshing is not wanted,
185
+	 * the $standard_cache parameter should be set to false when retrieving data
186
+	 *
187
+	 * @param string $transient_key [required]
188
+	 * @param bool   $standard_cache
189
+	 * @return mixed|null
190
+	 */
191
+	public function get($transient_key, $standard_cache = true)
192
+	{
193
+		if (isset($this->transients[ $transient_key ])) {
194
+			// to avoid cache stampedes (AKA:dogpiles) for standard cache items,
195
+			// check if known cache expires within the next minute,
196
+			// and if so, remove it from our tracking and and return nothing.
197
+			// this should trigger the cache content to be regenerated during this request,
198
+			// while allowing any following requests to still access the existing cache
199
+			// until it gets replaced with the refreshed content
200
+			if ($standard_cache
201
+				&& $this->transients[ $transient_key ] - time() <= MINUTE_IN_SECONDS
202
+			) {
203
+				unset($this->transients[ $transient_key ]);
204
+				$this->updateTransients();
205
+				return null;
206
+			}
207
+
208
+			// for non standard cache items, remove the key from our tracking,
209
+			// but proceed to retrieve the transient so that it also gets removed from the db
210
+			if ($this->transients[ $transient_key ] <= time()) {
211
+				unset($this->transients[ $transient_key ]);
212
+				$this->updateTransients();
213
+			}
214
+		}
215
+
216
+		$content = get_transient($transient_key);
217
+		return $content !== false ? $content : null;
218
+	}
219
+
220
+
221
+	/**
222
+	 * delete a single transient and remove tracking
223
+	 *
224
+	 * @param string $transient_key [required] full or partial transient key to be deleted
225
+	 */
226
+	public function delete($transient_key)
227
+	{
228
+		$this->deleteMany(array($transient_key));
229
+	}
230
+
231
+
232
+	/**
233
+	 * delete multiple transients and remove tracking
234
+	 *
235
+	 * @param array $transient_keys [required] array of full or partial transient keys to be deleted
236
+	 * @param bool  $force_delete   [optional] if true, then will not check incoming keys against those being tracked
237
+	 *                              and proceed directly to deleting those entries from the cache storage
238
+	 */
239
+	public function deleteMany(array $transient_keys, $force_delete = false)
240
+	{
241
+		$full_transient_keys = $force_delete ? $transient_keys : array();
242
+		if (empty($full_transient_keys)) {
243
+			foreach ($this->transients as $transient_key => $expiration) {
244
+				foreach ($transient_keys as $transient_key_to_delete) {
245
+					if (strpos($transient_key, $transient_key_to_delete) !== false) {
246
+						$full_transient_keys[] = $transient_key;
247
+					}
248
+				}
249
+			}
250
+		}
251
+		if ($this->deleteTransientKeys($full_transient_keys)) {
252
+			$this->updateTransients();
253
+		}
254
+	}
255
+
256
+
257
+	/**
258
+	 * sorts transients numerically by timestamp
259
+	 * then saves the transient schedule to a WP option
260
+	 */
261
+	private function updateTransients()
262
+	{
263
+		asort($this->transients, SORT_NUMERIC);
264
+		update_option(
265
+			TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY,
266
+			$this->transients
267
+		);
268
+	}
269
+
270
+
271
+	/**
272
+	 * schedules a transient for cleanup by adding it to the transient tracking
273
+	 *
274
+	 * @param string $transient_key [required]
275
+	 * @param int    $expiration    [required]
276
+	 */
277
+	private function scheduleTransientCleanup($transient_key, $expiration)
278
+	{
279
+		// make sure a valid future timestamp is set
280
+		$expiration += $expiration < time() ? time() : 0;
281
+		// and round to the closest 15 minutes
282
+		$expiration = $this->roundTimestamp($expiration);
283
+		// save transients to clear using their ID as the key to avoid duplicates
284
+		$this->transients[ $transient_key ] = $expiration;
285
+		$this->updateTransients();
286
+	}
287
+
288
+
289
+	/**
290
+	 * Since our tracked transients are sorted by their timestamps
291
+	 * we can grab the first transient and see when it is scheduled for cleanup.
292
+	 * If that timestamp is less than or equal to the current time,
293
+	 * then cleanup is triggered
294
+	 */
295
+	public function checkTransientCleanupSchedule()
296
+	{
297
+		if (empty($this->transients)) {
298
+			return;
299
+		}
300
+		// when do we run the next cleanup job?
301
+		reset($this->transients);
302
+		$next_scheduled_cleanup = current($this->transients);
303
+		// if the next cleanup job is scheduled for the current hour
304
+		if ($next_scheduled_cleanup <= $this->current_time) {
305
+			if ($this->cleanupExpiredTransients()) {
306
+				$this->updateTransients();
307
+			}
308
+		}
309
+	}
310
+
311
+
312
+	/**
313
+	 * loops through the array of tracked transients,
314
+	 * compiles a list of those that have expired, and sends that list off for deletion.
315
+	 * Also removes any bad records from the transients array
316
+	 *
317
+	 * @return bool
318
+	 */
319
+	private function cleanupExpiredTransients()
320
+	{
321
+		$update = false;
322
+		// filter the query limit. Set to 0 to turn off garbage collection
323
+		$limit = (int) abs(
324
+			apply_filters(
325
+				'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
326
+				50
327
+			)
328
+		);
329
+		// non-zero LIMIT means take out the trash
330
+		if ($limit) {
331
+			$transient_keys = array();
332
+			foreach ($this->transients as $transient_key => $expiration) {
333
+				if ($expiration > $this->current_time) {
334
+					continue;
335
+				}
336
+				if (! $expiration || ! $transient_key) {
337
+					unset($this->transients[ $transient_key ]);
338
+					$update = true;
339
+					continue;
340
+				}
341
+				$transient_keys[] = $transient_key;
342
+			}
343
+			// delete expired keys, but maintain value of $update if nothing is deleted
344
+			$update = $this->deleteTransientKeys($transient_keys, $limit) ? true : $update;
345
+			do_action('FHEE__TransientCacheStorage__clearExpiredTransients__end', $this);
346
+		}
347
+		return $update;
348
+	}
349
+
350
+
351
+	/**
352
+	 * calls delete_transient() on each transient key provided, up to the specified limit
353
+	 *
354
+	 * @param array $transient_keys [required]
355
+	 * @param int   $limit
356
+	 * @return bool
357
+	 */
358
+	private function deleteTransientKeys(array $transient_keys, $limit = 50)
359
+	{
360
+		if (empty($transient_keys)) {
361
+			return false;
362
+		}
363
+		$counter = 0;
364
+		foreach ($transient_keys as $transient_key) {
365
+			if ($counter === $limit) {
366
+				break;
367
+			}
368
+			// remove any transient prefixes
369
+			$transient_key = strpos($transient_key, '_transient_timeout_') === 0
370
+				? str_replace('_transient_timeout_', '', $transient_key)
371
+				: $transient_key;
372
+			$transient_key = strpos($transient_key, '_transient_') === 0
373
+				? str_replace('_transient_', '', $transient_key)
374
+				: $transient_key;
375
+			delete_transient($transient_key);
376
+			unset($this->transients[ $transient_key ]);
377
+			$counter++;
378
+		}
379
+		return $counter > 0;
380
+	}
381 381
 }
Please login to merge, or discard this patch.
Spacing   +10 added lines, -10 removed lines patch added patch discarded remove patch
@@ -57,7 +57,7 @@  discard block
 block discarded – undo
57 57
         // round current time down to closest 5 minutes to simplify scheduling
58 58
         $this->current_time = $this->roundTimestamp(time(), '5-minutes', false);
59 59
         $this->transients = (array) get_option(TransientCacheStorage::TRANSIENT_SCHEDULE_OPTIONS_KEY, array());
60
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && $this->transient_cleanup_frequency !== 'off') {
60
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX) && $this->transient_cleanup_frequency !== 'off') {
61 61
             add_action('shutdown', array($this, 'checkTransientCleanupSchedule'), 999);
62 62
         }
63 63
     }
@@ -190,7 +190,7 @@  discard block
 block discarded – undo
190 190
      */
191 191
     public function get($transient_key, $standard_cache = true)
192 192
     {
193
-        if (isset($this->transients[ $transient_key ])) {
193
+        if (isset($this->transients[$transient_key])) {
194 194
             // to avoid cache stampedes (AKA:dogpiles) for standard cache items,
195 195
             // check if known cache expires within the next minute,
196 196
             // and if so, remove it from our tracking and and return nothing.
@@ -198,17 +198,17 @@  discard block
 block discarded – undo
198 198
             // while allowing any following requests to still access the existing cache
199 199
             // until it gets replaced with the refreshed content
200 200
             if ($standard_cache
201
-                && $this->transients[ $transient_key ] - time() <= MINUTE_IN_SECONDS
201
+                && $this->transients[$transient_key] - time() <= MINUTE_IN_SECONDS
202 202
             ) {
203
-                unset($this->transients[ $transient_key ]);
203
+                unset($this->transients[$transient_key]);
204 204
                 $this->updateTransients();
205 205
                 return null;
206 206
             }
207 207
 
208 208
             // for non standard cache items, remove the key from our tracking,
209 209
             // but proceed to retrieve the transient so that it also gets removed from the db
210
-            if ($this->transients[ $transient_key ] <= time()) {
211
-                unset($this->transients[ $transient_key ]);
210
+            if ($this->transients[$transient_key] <= time()) {
211
+                unset($this->transients[$transient_key]);
212 212
                 $this->updateTransients();
213 213
             }
214 214
         }
@@ -281,7 +281,7 @@  discard block
 block discarded – undo
281 281
         // and round to the closest 15 minutes
282 282
         $expiration = $this->roundTimestamp($expiration);
283 283
         // save transients to clear using their ID as the key to avoid duplicates
284
-        $this->transients[ $transient_key ] = $expiration;
284
+        $this->transients[$transient_key] = $expiration;
285 285
         $this->updateTransients();
286 286
     }
287 287
 
@@ -333,8 +333,8 @@  discard block
 block discarded – undo
333 333
                 if ($expiration > $this->current_time) {
334 334
                     continue;
335 335
                 }
336
-                if (! $expiration || ! $transient_key) {
337
-                    unset($this->transients[ $transient_key ]);
336
+                if ( ! $expiration || ! $transient_key) {
337
+                    unset($this->transients[$transient_key]);
338 338
                     $update = true;
339 339
                     continue;
340 340
                 }
@@ -373,7 +373,7 @@  discard block
 block discarded – undo
373 373
                 ? str_replace('_transient_', '', $transient_key)
374 374
                 : $transient_key;
375 375
             delete_transient($transient_key);
376
-            unset($this->transients[ $transient_key ]);
376
+            unset($this->transients[$transient_key]);
377 377
             $counter++;
378 378
         }
379 379
         return $counter > 0;
Please login to merge, or discard this patch.
core/services/Benchmark.php 2 patches
Indentation   +320 added lines, -320 removed lines patch added patch discarded remove patch
@@ -15,324 +15,324 @@
 block discarded – undo
15 15
 class Benchmark
16 16
 {
17 17
 
18
-    /**
19
-     * @var string $output
20
-     */
21
-    private static $output;
22
-
23
-    /**
24
-     * @var array $start_times array containing the start time for the timers
25
-     */
26
-    private static $start_times;
27
-
28
-    /**
29
-     * @var array $times array containing all the timer'd times, which can be outputted via show_times()
30
-     */
31
-    private static $times = array();
32
-
33
-    /**
34
-     * @var array $memory_usage
35
-     */
36
-    protected static $memory_usage = array();
37
-
38
-
39
-    /**
40
-     * @param string $output
41
-     * @param bool   $formatted
42
-     */
43
-    public static function addOutput($output, $formatted = true)
44
-    {
45
-        Benchmark::$output .= $formatted
46
-            ? "<br />{$output}"
47
-            : "\n{$output}";
48
-    }
49
-
50
-
51
-    /**
52
-     * @return void
53
-     */
54
-    public static function resetOutput()
55
-    {
56
-        Benchmark::$output = '';
57
-    }
58
-
59
-    /**
60
-     * whether to benchmark code or not
61
-     */
62
-    public static function doNotRun()
63
-    {
64
-        return ! WP_DEBUG || (defined('DOING_AJAX') && DOING_AJAX);
65
-    }
66
-
67
-
68
-    /**
69
-     * resetTimes
70
-     */
71
-    public static function resetTimes()
72
-    {
73
-        Benchmark::$times = array();
74
-    }
75
-
76
-
77
-    /**
78
-     * Add Benchmark::startTimer() before a block of code you want to measure the performance of
79
-     *
80
-     * @param null $timer_name
81
-     */
82
-    public static function startTimer($timer_name = null)
83
-    {
84
-        if (Benchmark::doNotRun()) {
85
-            return;
86
-        }
87
-        $timer_name = $timer_name !== '' ? $timer_name : get_called_class();
88
-        Benchmark::$start_times[ $timer_name ] = microtime(true);
89
-    }
90
-
91
-
92
-    /**
93
-     * Add Benchmark::stopTimer() after a block of code you want to measure the performance of
94
-     *
95
-     * @param string $timer_name
96
-     */
97
-    public static function stopTimer($timer_name = '')
98
-    {
99
-        if (Benchmark::doNotRun()) {
100
-            return;
101
-        }
102
-        $timer_name = $timer_name !== '' ? $timer_name : get_called_class();
103
-        if (isset(Benchmark::$start_times[ $timer_name ])) {
104
-            $start_time = Benchmark::$start_times[ $timer_name ];
105
-            unset(Benchmark::$start_times[ $timer_name ]);
106
-        } else {
107
-            $start_time = array_pop(Benchmark::$start_times);
108
-        }
109
-        Benchmark::$times[ $timer_name ] = number_format(microtime(true) - $start_time, 8);
110
-    }
111
-
112
-
113
-    /**
114
-     * Measure the memory usage by PHP so far.
115
-     *
116
-     * @param string  $label      The label to show for this time eg "Start of calling Some_Class::some_function"
117
-     * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called
118
-     * @param bool    $formatted
119
-     * @return void
120
-     */
121
-    public static function measureMemory($label = 'memory usage', $output_now = false, $formatted = true)
122
-    {
123
-        if (Benchmark::doNotRun()) {
124
-            return;
125
-        }
126
-        $memory_used = Benchmark::convert(memory_get_usage(true));
127
-        Benchmark::$memory_usage[ $label ] = $memory_used;
128
-        if ($output_now) {
129
-            echo $formatted
130
-                ? "<br>{$label} : {$memory_used}"
131
-                : "\n {$label} : {$memory_used}";
132
-        }
133
-    }
134
-
135
-
136
-    /**
137
-     * will display the benchmarking results at shutdown
138
-     *
139
-     * @param bool $formatted
140
-     * @return void
141
-     */
142
-    public static function displayResultsAtShutdown($formatted = true)
143
-    {
144
-        Benchmark::resetOutput();
145
-        add_action(
146
-            'shutdown',
147
-            function () use ($formatted) {
148
-                Benchmark::displayResults(true, $formatted);
149
-            },
150
-            999999
151
-        );
152
-    }
153
-
154
-
155
-    /**
156
-     * will display the benchmarking results at shutdown
157
-     *
158
-     * @param string $filepath
159
-     * @param bool   $formatted
160
-     * @param bool   $append
161
-     * @return void
162
-     */
163
-    public static function writeResultsAtShutdown($filepath = '', $formatted = true, $append = true)
164
-    {
165
-        Benchmark::resetOutput();
166
-        add_action(
167
-            'shutdown',
168
-            function () use ($filepath, $formatted, $append) {
169
-                Benchmark::writeResultsToFile($filepath, $formatted, $append);
170
-            },
171
-            999999
172
-        );
173
-    }
174
-
175
-
176
-    /**
177
-     * @param bool $formatted
178
-     * @return string
179
-     */
180
-    private static function generateResults($formatted = true)
181
-    {
182
-        if (Benchmark::doNotRun()) {
183
-            return '';
184
-        }
185
-        if (! empty(Benchmark::$times)) {
186
-            $total = 0;
187
-            Benchmark::$output .= $formatted
188
-                ? '<span style="color:#999999; font-size:.8em;">( time in milliseconds )</span><br />'
189
-                : '';
190
-            foreach (Benchmark::$times as $timer_name => $total_time) {
191
-                Benchmark::$output .= Benchmark::formatTime($timer_name, $total_time, $formatted);
192
-                Benchmark::$output .= $formatted ? '<br />' : "\n";
193
-                $total += $total_time;
194
-            }
195
-            if ($formatted) {
196
-                Benchmark::$output .= '<br />';
197
-                Benchmark::$output .= '<h4>TOTAL TIME</h4>';
198
-                Benchmark::$output .= Benchmark::formatTime('', $total, $formatted);
199
-                Benchmark::$output .= '<span style="color:#999999; font-size:.8em;"> milliseconds</span><br />';
200
-                Benchmark::$output .= '<br />';
201
-                Benchmark::$output .= '<h5>Performance scale (from best to worse)</h5>';
202
-                Benchmark::$output .= '<span style="color:mediumpurple">Like wow! How about a Scooby snack?</span><br />';
203
-                Benchmark::$output .= '<span style="color:deepskyblue">Like...no way man!</span><br />';
204
-                Benchmark::$output .= '<span style="color:limegreen">Like...groovy!</span><br />';
205
-                Benchmark::$output .= '<span style="color:gold">Ruh Oh</span><br />';
206
-                Benchmark::$output .= '<span style="color:darkorange">Zoinks!</span><br />';
207
-                Benchmark::$output .= '<span style="color:red">Like...HEEELLLP</span><br />';
208
-            }
209
-        }
210
-        if (! empty(Benchmark::$memory_usage)) {
211
-            Benchmark::$output .= $formatted
212
-                ? '<h5>Memory</h5>'
213
-                : "\nMemory";
214
-            foreach (Benchmark::$memory_usage as $label => $memory_usage) {
215
-                Benchmark::$output .= $formatted
216
-                    ? "<br />{$memory_usage} : {$label}"
217
-                    : "\n{$memory_usage} : {$label}";
218
-            }
219
-        }
220
-        if (empty(Benchmark::$output)) {
221
-            return '';
222
-        }
223
-        Benchmark::$output = $formatted
224
-            ? '<div style="border:1px solid #dddddd; background-color:#ffffff;'
225
-              . (is_admin()
226
-                ? ' margin:2em 2em 2em 180px;'
227
-                : ' margin:2em;')
228
-              . ' padding:2em;">'
229
-              . '<h4>BENCHMARKING</h4>'
230
-              . Benchmark::$output
231
-              . '</div>'
232
-            : Benchmark::$output;
233
-        return Benchmark::$output;
234
-    }
235
-
236
-
237
-    /**
238
-     * @param bool $echo
239
-     * @param bool $formatted
240
-     * @return string
241
-     */
242
-    public static function displayResults($echo = true, $formatted = true)
243
-    {
244
-        $results = Benchmark::generateResults($formatted);
245
-        if ($echo) {
246
-            echo $results;
247
-            $results = '';
248
-        }
249
-        return $results;
250
-    }
251
-
252
-
253
-    /**
254
-     * @param string $filepath
255
-     * @param bool   $formatted
256
-     * @param bool   $append
257
-     * @throws EE_Error
258
-     */
259
-    public static function writeResultsToFile($filepath = '', $formatted = true, $append = true)
260
-    {
261
-        $filepath = ! empty($filepath) && is_readable(dirname($filepath))
262
-            ? $filepath
263
-            : '';
264
-        if (empty($filepath)) {
265
-            $filepath = EVENT_ESPRESSO_UPLOAD_DIR . 'logs/benchmarking-' . date('Y-m-d') . '.html';
266
-        }
267
-        EEH_File::ensure_file_exists_and_is_writable($filepath);
268
-        file_put_contents(
269
-            $filepath,
270
-            "\n" . date('Y-m-d H:i:s') . Benchmark::generateResults($formatted),
271
-            $append ? FILE_APPEND | LOCK_EX : LOCK_EX
272
-        );
273
-    }
274
-
275
-
276
-    /**
277
-     * Converts a measure of memory bytes into the most logical units (eg kb, mb, etc)
278
-     *
279
-     * @param int $size
280
-     * @return string
281
-     */
282
-    public static function convert($size)
283
-    {
284
-        $unit = array('b', 'kb', 'mb', 'gb', 'tb', 'pb');
285
-        return round(
286
-            $size / pow(1024, $i = floor(log($size, 1024))),
287
-            2
288
-        ) . ' ' . $unit[ absint($i) ];
289
-    }
290
-
291
-
292
-    /**
293
-     * @param string $timer_name
294
-     * @param float  $total_time
295
-     * @param bool   $formatted
296
-     * @return string
297
-     */
298
-    public static function formatTime($timer_name, $total_time, $formatted = true)
299
-    {
300
-        $total_time *= 1000;
301
-        switch ($total_time) {
302
-            case $total_time > 12500:
303
-                $color = 'red';
304
-                $bold = 'bold';
305
-                break;
306
-            case $total_time > 2500:
307
-                $color = 'darkorange';
308
-                $bold = 'bold';
309
-                break;
310
-            case $total_time > 500:
311
-                $color = 'gold';
312
-                $bold = 'bold';
313
-                break;
314
-            case $total_time > 100:
315
-                $color = 'limegreen';
316
-                $bold = 'normal';
317
-                break;
318
-            case $total_time > 20:
319
-                $color = 'deepskyblue';
320
-                $bold = 'normal';
321
-                break;
322
-            default:
323
-                $color = 'mediumpurple';
324
-                $bold = 'normal';
325
-                break;
326
-        }
327
-        return $formatted
328
-            ? '<span style="min-width: 10px; margin:0 1em; color:'
329
-              . $color
330
-              . '; font-weight:'
331
-              . $bold
332
-              . '; font-size:1.2em;">'
333
-              . str_pad(number_format($total_time, 3), 9, '0', STR_PAD_LEFT)
334
-              . '</span> '
335
-              . $timer_name
336
-            : str_pad(number_format($total_time, 3), 9, '0', STR_PAD_LEFT);
337
-    }
18
+	/**
19
+	 * @var string $output
20
+	 */
21
+	private static $output;
22
+
23
+	/**
24
+	 * @var array $start_times array containing the start time for the timers
25
+	 */
26
+	private static $start_times;
27
+
28
+	/**
29
+	 * @var array $times array containing all the timer'd times, which can be outputted via show_times()
30
+	 */
31
+	private static $times = array();
32
+
33
+	/**
34
+	 * @var array $memory_usage
35
+	 */
36
+	protected static $memory_usage = array();
37
+
38
+
39
+	/**
40
+	 * @param string $output
41
+	 * @param bool   $formatted
42
+	 */
43
+	public static function addOutput($output, $formatted = true)
44
+	{
45
+		Benchmark::$output .= $formatted
46
+			? "<br />{$output}"
47
+			: "\n{$output}";
48
+	}
49
+
50
+
51
+	/**
52
+	 * @return void
53
+	 */
54
+	public static function resetOutput()
55
+	{
56
+		Benchmark::$output = '';
57
+	}
58
+
59
+	/**
60
+	 * whether to benchmark code or not
61
+	 */
62
+	public static function doNotRun()
63
+	{
64
+		return ! WP_DEBUG || (defined('DOING_AJAX') && DOING_AJAX);
65
+	}
66
+
67
+
68
+	/**
69
+	 * resetTimes
70
+	 */
71
+	public static function resetTimes()
72
+	{
73
+		Benchmark::$times = array();
74
+	}
75
+
76
+
77
+	/**
78
+	 * Add Benchmark::startTimer() before a block of code you want to measure the performance of
79
+	 *
80
+	 * @param null $timer_name
81
+	 */
82
+	public static function startTimer($timer_name = null)
83
+	{
84
+		if (Benchmark::doNotRun()) {
85
+			return;
86
+		}
87
+		$timer_name = $timer_name !== '' ? $timer_name : get_called_class();
88
+		Benchmark::$start_times[ $timer_name ] = microtime(true);
89
+	}
90
+
91
+
92
+	/**
93
+	 * Add Benchmark::stopTimer() after a block of code you want to measure the performance of
94
+	 *
95
+	 * @param string $timer_name
96
+	 */
97
+	public static function stopTimer($timer_name = '')
98
+	{
99
+		if (Benchmark::doNotRun()) {
100
+			return;
101
+		}
102
+		$timer_name = $timer_name !== '' ? $timer_name : get_called_class();
103
+		if (isset(Benchmark::$start_times[ $timer_name ])) {
104
+			$start_time = Benchmark::$start_times[ $timer_name ];
105
+			unset(Benchmark::$start_times[ $timer_name ]);
106
+		} else {
107
+			$start_time = array_pop(Benchmark::$start_times);
108
+		}
109
+		Benchmark::$times[ $timer_name ] = number_format(microtime(true) - $start_time, 8);
110
+	}
111
+
112
+
113
+	/**
114
+	 * Measure the memory usage by PHP so far.
115
+	 *
116
+	 * @param string  $label      The label to show for this time eg "Start of calling Some_Class::some_function"
117
+	 * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called
118
+	 * @param bool    $formatted
119
+	 * @return void
120
+	 */
121
+	public static function measureMemory($label = 'memory usage', $output_now = false, $formatted = true)
122
+	{
123
+		if (Benchmark::doNotRun()) {
124
+			return;
125
+		}
126
+		$memory_used = Benchmark::convert(memory_get_usage(true));
127
+		Benchmark::$memory_usage[ $label ] = $memory_used;
128
+		if ($output_now) {
129
+			echo $formatted
130
+				? "<br>{$label} : {$memory_used}"
131
+				: "\n {$label} : {$memory_used}";
132
+		}
133
+	}
134
+
135
+
136
+	/**
137
+	 * will display the benchmarking results at shutdown
138
+	 *
139
+	 * @param bool $formatted
140
+	 * @return void
141
+	 */
142
+	public static function displayResultsAtShutdown($formatted = true)
143
+	{
144
+		Benchmark::resetOutput();
145
+		add_action(
146
+			'shutdown',
147
+			function () use ($formatted) {
148
+				Benchmark::displayResults(true, $formatted);
149
+			},
150
+			999999
151
+		);
152
+	}
153
+
154
+
155
+	/**
156
+	 * will display the benchmarking results at shutdown
157
+	 *
158
+	 * @param string $filepath
159
+	 * @param bool   $formatted
160
+	 * @param bool   $append
161
+	 * @return void
162
+	 */
163
+	public static function writeResultsAtShutdown($filepath = '', $formatted = true, $append = true)
164
+	{
165
+		Benchmark::resetOutput();
166
+		add_action(
167
+			'shutdown',
168
+			function () use ($filepath, $formatted, $append) {
169
+				Benchmark::writeResultsToFile($filepath, $formatted, $append);
170
+			},
171
+			999999
172
+		);
173
+	}
174
+
175
+
176
+	/**
177
+	 * @param bool $formatted
178
+	 * @return string
179
+	 */
180
+	private static function generateResults($formatted = true)
181
+	{
182
+		if (Benchmark::doNotRun()) {
183
+			return '';
184
+		}
185
+		if (! empty(Benchmark::$times)) {
186
+			$total = 0;
187
+			Benchmark::$output .= $formatted
188
+				? '<span style="color:#999999; font-size:.8em;">( time in milliseconds )</span><br />'
189
+				: '';
190
+			foreach (Benchmark::$times as $timer_name => $total_time) {
191
+				Benchmark::$output .= Benchmark::formatTime($timer_name, $total_time, $formatted);
192
+				Benchmark::$output .= $formatted ? '<br />' : "\n";
193
+				$total += $total_time;
194
+			}
195
+			if ($formatted) {
196
+				Benchmark::$output .= '<br />';
197
+				Benchmark::$output .= '<h4>TOTAL TIME</h4>';
198
+				Benchmark::$output .= Benchmark::formatTime('', $total, $formatted);
199
+				Benchmark::$output .= '<span style="color:#999999; font-size:.8em;"> milliseconds</span><br />';
200
+				Benchmark::$output .= '<br />';
201
+				Benchmark::$output .= '<h5>Performance scale (from best to worse)</h5>';
202
+				Benchmark::$output .= '<span style="color:mediumpurple">Like wow! How about a Scooby snack?</span><br />';
203
+				Benchmark::$output .= '<span style="color:deepskyblue">Like...no way man!</span><br />';
204
+				Benchmark::$output .= '<span style="color:limegreen">Like...groovy!</span><br />';
205
+				Benchmark::$output .= '<span style="color:gold">Ruh Oh</span><br />';
206
+				Benchmark::$output .= '<span style="color:darkorange">Zoinks!</span><br />';
207
+				Benchmark::$output .= '<span style="color:red">Like...HEEELLLP</span><br />';
208
+			}
209
+		}
210
+		if (! empty(Benchmark::$memory_usage)) {
211
+			Benchmark::$output .= $formatted
212
+				? '<h5>Memory</h5>'
213
+				: "\nMemory";
214
+			foreach (Benchmark::$memory_usage as $label => $memory_usage) {
215
+				Benchmark::$output .= $formatted
216
+					? "<br />{$memory_usage} : {$label}"
217
+					: "\n{$memory_usage} : {$label}";
218
+			}
219
+		}
220
+		if (empty(Benchmark::$output)) {
221
+			return '';
222
+		}
223
+		Benchmark::$output = $formatted
224
+			? '<div style="border:1px solid #dddddd; background-color:#ffffff;'
225
+			  . (is_admin()
226
+				? ' margin:2em 2em 2em 180px;'
227
+				: ' margin:2em;')
228
+			  . ' padding:2em;">'
229
+			  . '<h4>BENCHMARKING</h4>'
230
+			  . Benchmark::$output
231
+			  . '</div>'
232
+			: Benchmark::$output;
233
+		return Benchmark::$output;
234
+	}
235
+
236
+
237
+	/**
238
+	 * @param bool $echo
239
+	 * @param bool $formatted
240
+	 * @return string
241
+	 */
242
+	public static function displayResults($echo = true, $formatted = true)
243
+	{
244
+		$results = Benchmark::generateResults($formatted);
245
+		if ($echo) {
246
+			echo $results;
247
+			$results = '';
248
+		}
249
+		return $results;
250
+	}
251
+
252
+
253
+	/**
254
+	 * @param string $filepath
255
+	 * @param bool   $formatted
256
+	 * @param bool   $append
257
+	 * @throws EE_Error
258
+	 */
259
+	public static function writeResultsToFile($filepath = '', $formatted = true, $append = true)
260
+	{
261
+		$filepath = ! empty($filepath) && is_readable(dirname($filepath))
262
+			? $filepath
263
+			: '';
264
+		if (empty($filepath)) {
265
+			$filepath = EVENT_ESPRESSO_UPLOAD_DIR . 'logs/benchmarking-' . date('Y-m-d') . '.html';
266
+		}
267
+		EEH_File::ensure_file_exists_and_is_writable($filepath);
268
+		file_put_contents(
269
+			$filepath,
270
+			"\n" . date('Y-m-d H:i:s') . Benchmark::generateResults($formatted),
271
+			$append ? FILE_APPEND | LOCK_EX : LOCK_EX
272
+		);
273
+	}
274
+
275
+
276
+	/**
277
+	 * Converts a measure of memory bytes into the most logical units (eg kb, mb, etc)
278
+	 *
279
+	 * @param int $size
280
+	 * @return string
281
+	 */
282
+	public static function convert($size)
283
+	{
284
+		$unit = array('b', 'kb', 'mb', 'gb', 'tb', 'pb');
285
+		return round(
286
+			$size / pow(1024, $i = floor(log($size, 1024))),
287
+			2
288
+		) . ' ' . $unit[ absint($i) ];
289
+	}
290
+
291
+
292
+	/**
293
+	 * @param string $timer_name
294
+	 * @param float  $total_time
295
+	 * @param bool   $formatted
296
+	 * @return string
297
+	 */
298
+	public static function formatTime($timer_name, $total_time, $formatted = true)
299
+	{
300
+		$total_time *= 1000;
301
+		switch ($total_time) {
302
+			case $total_time > 12500:
303
+				$color = 'red';
304
+				$bold = 'bold';
305
+				break;
306
+			case $total_time > 2500:
307
+				$color = 'darkorange';
308
+				$bold = 'bold';
309
+				break;
310
+			case $total_time > 500:
311
+				$color = 'gold';
312
+				$bold = 'bold';
313
+				break;
314
+			case $total_time > 100:
315
+				$color = 'limegreen';
316
+				$bold = 'normal';
317
+				break;
318
+			case $total_time > 20:
319
+				$color = 'deepskyblue';
320
+				$bold = 'normal';
321
+				break;
322
+			default:
323
+				$color = 'mediumpurple';
324
+				$bold = 'normal';
325
+				break;
326
+		}
327
+		return $formatted
328
+			? '<span style="min-width: 10px; margin:0 1em; color:'
329
+			  . $color
330
+			  . '; font-weight:'
331
+			  . $bold
332
+			  . '; font-size:1.2em;">'
333
+			  . str_pad(number_format($total_time, 3), 9, '0', STR_PAD_LEFT)
334
+			  . '</span> '
335
+			  . $timer_name
336
+			: str_pad(number_format($total_time, 3), 9, '0', STR_PAD_LEFT);
337
+	}
338 338
 }
Please login to merge, or discard this patch.
Spacing   +13 added lines, -13 removed lines patch added patch discarded remove patch
@@ -85,7 +85,7 @@  discard block
 block discarded – undo
85 85
             return;
86 86
         }
87 87
         $timer_name = $timer_name !== '' ? $timer_name : get_called_class();
88
-        Benchmark::$start_times[ $timer_name ] = microtime(true);
88
+        Benchmark::$start_times[$timer_name] = microtime(true);
89 89
     }
90 90
 
91 91
 
@@ -100,13 +100,13 @@  discard block
 block discarded – undo
100 100
             return;
101 101
         }
102 102
         $timer_name = $timer_name !== '' ? $timer_name : get_called_class();
103
-        if (isset(Benchmark::$start_times[ $timer_name ])) {
104
-            $start_time = Benchmark::$start_times[ $timer_name ];
105
-            unset(Benchmark::$start_times[ $timer_name ]);
103
+        if (isset(Benchmark::$start_times[$timer_name])) {
104
+            $start_time = Benchmark::$start_times[$timer_name];
105
+            unset(Benchmark::$start_times[$timer_name]);
106 106
         } else {
107 107
             $start_time = array_pop(Benchmark::$start_times);
108 108
         }
109
-        Benchmark::$times[ $timer_name ] = number_format(microtime(true) - $start_time, 8);
109
+        Benchmark::$times[$timer_name] = number_format(microtime(true) - $start_time, 8);
110 110
     }
111 111
 
112 112
 
@@ -124,7 +124,7 @@  discard block
 block discarded – undo
124 124
             return;
125 125
         }
126 126
         $memory_used = Benchmark::convert(memory_get_usage(true));
127
-        Benchmark::$memory_usage[ $label ] = $memory_used;
127
+        Benchmark::$memory_usage[$label] = $memory_used;
128 128
         if ($output_now) {
129 129
             echo $formatted
130 130
                 ? "<br>{$label} : {$memory_used}"
@@ -144,7 +144,7 @@  discard block
 block discarded – undo
144 144
         Benchmark::resetOutput();
145 145
         add_action(
146 146
             'shutdown',
147
-            function () use ($formatted) {
147
+            function() use ($formatted) {
148 148
                 Benchmark::displayResults(true, $formatted);
149 149
             },
150 150
             999999
@@ -165,7 +165,7 @@  discard block
 block discarded – undo
165 165
         Benchmark::resetOutput();
166 166
         add_action(
167 167
             'shutdown',
168
-            function () use ($filepath, $formatted, $append) {
168
+            function() use ($filepath, $formatted, $append) {
169 169
                 Benchmark::writeResultsToFile($filepath, $formatted, $append);
170 170
             },
171 171
             999999
@@ -182,7 +182,7 @@  discard block
 block discarded – undo
182 182
         if (Benchmark::doNotRun()) {
183 183
             return '';
184 184
         }
185
-        if (! empty(Benchmark::$times)) {
185
+        if ( ! empty(Benchmark::$times)) {
186 186
             $total = 0;
187 187
             Benchmark::$output .= $formatted
188 188
                 ? '<span style="color:#999999; font-size:.8em;">( time in milliseconds )</span><br />'
@@ -207,7 +207,7 @@  discard block
 block discarded – undo
207 207
                 Benchmark::$output .= '<span style="color:red">Like...HEEELLLP</span><br />';
208 208
             }
209 209
         }
210
-        if (! empty(Benchmark::$memory_usage)) {
210
+        if ( ! empty(Benchmark::$memory_usage)) {
211 211
             Benchmark::$output .= $formatted
212 212
                 ? '<h5>Memory</h5>'
213 213
                 : "\nMemory";
@@ -262,12 +262,12 @@  discard block
 block discarded – undo
262 262
             ? $filepath
263 263
             : '';
264 264
         if (empty($filepath)) {
265
-            $filepath = EVENT_ESPRESSO_UPLOAD_DIR . 'logs/benchmarking-' . date('Y-m-d') . '.html';
265
+            $filepath = EVENT_ESPRESSO_UPLOAD_DIR.'logs/benchmarking-'.date('Y-m-d').'.html';
266 266
         }
267 267
         EEH_File::ensure_file_exists_and_is_writable($filepath);
268 268
         file_put_contents(
269 269
             $filepath,
270
-            "\n" . date('Y-m-d H:i:s') . Benchmark::generateResults($formatted),
270
+            "\n".date('Y-m-d H:i:s').Benchmark::generateResults($formatted),
271 271
             $append ? FILE_APPEND | LOCK_EX : LOCK_EX
272 272
         );
273 273
     }
@@ -285,7 +285,7 @@  discard block
 block discarded – undo
285 285
         return round(
286 286
             $size / pow(1024, $i = floor(log($size, 1024))),
287 287
             2
288
-        ) . ' ' . $unit[ absint($i) ];
288
+        ).' '.$unit[absint($i)];
289 289
     }
290 290
 
291 291
 
Please login to merge, or discard this patch.
core/services/container/DependencyInjector.php 2 patches
Indentation   +205 added lines, -205 removed lines patch added patch discarded remove patch
@@ -21,209 +21,209 @@
 block discarded – undo
21 21
 class DependencyInjector implements InjectorInterface
22 22
 {
23 23
 
24
-    /**
25
-     * @var CoffeePotInterface $coffee_pot
26
-     */
27
-    private $coffee_pot;
28
-
29
-    /**
30
-     * @var EEH_Array $array_helper
31
-     */
32
-    private $array_helper;
33
-
34
-    /**
35
-     * @var ReflectionClass[] $reflectors
36
-     */
37
-    private $reflectors;
38
-
39
-    /**
40
-     * @var ReflectionMethod[] $constructors
41
-     */
42
-    private $constructors;
43
-
44
-    /**
45
-     * @var ReflectionParameter[] $parameters
46
-     */
47
-    private $parameters;
48
-
49
-
50
-    /**
51
-     * DependencyInjector constructor
52
-     *
53
-     * @param CoffeePotInterface $coffee_pot
54
-     * @param EEH_Array          $array_helper
55
-     */
56
-    public function __construct(CoffeePotInterface $coffee_pot, EEH_Array $array_helper)
57
-    {
58
-        $this->coffee_pot = $coffee_pot;
59
-        $this->array_helper = $array_helper;
60
-    }
61
-
62
-
63
-    /**
64
-     * getReflectionClass
65
-     * checks if a ReflectionClass object has already been generated for a class
66
-     * and returns that instead of creating a new one
67
-     *
68
-     * @param string $class_name
69
-     * @return ReflectionClass
70
-     */
71
-    public function getReflectionClass($class_name)
72
-    {
73
-        if (! isset($this->reflectors[ $class_name ])
74
-            || ! $this->reflectors[ $class_name ] instanceof ReflectionClass
75
-        ) {
76
-            $this->reflectors[ $class_name ] = new ReflectionClass($class_name);
77
-        }
78
-        return $this->reflectors[ $class_name ];
79
-    }
80
-
81
-
82
-    /**
83
-     * getConstructor
84
-     * checks if a ReflectionMethod object has already been generated for the class constructor
85
-     * and returns that instead of creating a new one
86
-     *
87
-     * @param ReflectionClass $reflector
88
-     * @return ReflectionMethod
89
-     */
90
-    protected function getConstructor(ReflectionClass $reflector)
91
-    {
92
-        if (! isset($this->constructors[ $reflector->getName() ])
93
-            || ! $this->constructors[ $reflector->getName() ] instanceof ReflectionMethod
94
-        ) {
95
-            $this->constructors[ $reflector->getName() ] = $reflector->getConstructor();
96
-        }
97
-        return $this->constructors[ $reflector->getName() ];
98
-    }
99
-
100
-
101
-    /**
102
-     * getParameters
103
-     * checks if an array of ReflectionParameter objects has already been generated for the class constructor
104
-     * and returns that instead of creating a new one
105
-     *
106
-     * @param ReflectionMethod $constructor
107
-     * @return ReflectionParameter[]
108
-     */
109
-    protected function getParameters(ReflectionMethod $constructor)
110
-    {
111
-        if (! isset($this->parameters[ $constructor->class ])) {
112
-            $this->parameters[ $constructor->class ] = $constructor->getParameters();
113
-        }
114
-        return $this->parameters[ $constructor->class ];
115
-    }
116
-
117
-
118
-    /**
119
-     * resolveDependencies
120
-     * examines the constructor for the requested class to determine
121
-     * if any dependencies exist, and if they can be injected.
122
-     * If so, then those classes will be added to the array of arguments passed to the constructor
123
-     * PLZ NOTE: this is achieved by type hinting the constructor params
124
-     * For example:
125
-     *        if attempting to load a class "Foo" with the following constructor:
126
-     *        __construct( Bar $bar_class, Fighter $grohl_class )
127
-     *        then $bar_class and $grohl_class will be added to the $arguments array,
128
-     *        but only IF they are NOT already present in the incoming arguments array,
129
-     *        and the correct classes can be loaded
130
-     *
131
-     * @param RecipeInterface $recipe
132
-     * @param ReflectionClass $reflector
133
-     * @param array           $arguments
134
-     * @return array
135
-     * @throws UnexpectedValueException
136
-     */
137
-    public function resolveDependencies(RecipeInterface $recipe, ReflectionClass $reflector, $arguments = array())
138
-    {
139
-        // if arguments array is numerically and sequentially indexed, then we want it to remain as is,
140
-        // else wrap it in an additional array so that it doesn't get split into multiple parameters
141
-        $arguments = $this->array_helper->is_array_numerically_and_sequentially_indexed($arguments)
142
-            ? $arguments
143
-            : array($arguments);
144
-        $resolved_parameters = array();
145
-        // let's examine the constructor
146
-        // let's examine the constructor
147
-        $constructor = $this->getConstructor($reflector);
148
-        // whu? huh? nothing?
149
-        if (! $constructor) {
150
-            return $arguments;
151
-        }
152
-        // get constructor parameters
153
-        $params = $this->getParameters($constructor);
154
-        if (empty($params)) {
155
-            return $resolved_parameters;
156
-        }
157
-        $ingredients = $recipe->ingredients();
158
-        // and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
159
-        $argument_keys = array_keys($arguments);
160
-        // now loop thru all of the constructors expected parameters
161
-        foreach ($params as $index => $param) {
162
-            if (! $param instanceof ReflectionParameter) {
163
-                continue;
164
-            }
165
-            // is this a dependency for a specific class ?
166
-            $param_class = $param->getClass() ? $param->getClass()->name : '';
167
-            $param_name = $param->getName() ? $param->getName() : '';
168
-            if (// param is not a class but is specified in the list of ingredients for this Recipe
169
-                is_string($param_name) && isset($ingredients[ $param_name ])
170
-            ) {
171
-                // attempt to inject the dependency
172
-                $resolved_parameters[ $index ] = $ingredients[ $param_name ];
173
-            } elseif (// param is specified in the list of ingredients for this Recipe
174
-            isset($ingredients[ $param_class ])
175
-            ) { // attempt to inject the dependency
176
-                $resolved_parameters[ $index ] = $this->injectDependency($reflector, $ingredients[ $param_class ]);
177
-            } elseif (// param is not even a class
178
-                empty($param_class)
179
-                // and something already exists in the incoming arguments for this param
180
-                && isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
181
-            ) {
182
-                // add parameter from incoming arguments
183
-                $resolved_parameters[ $index ] = $arguments[ $argument_keys[ $index ] ];
184
-            } elseif (// parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
185
-                ! empty($param_class)
186
-                && isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
187
-                && $arguments[ $argument_keys[ $index ] ] instanceof $param_class
188
-            ) {
189
-                // add parameter from incoming arguments
190
-                $resolved_parameters[ $index ] = $arguments[ $argument_keys[ $index ] ];
191
-            } elseif (// parameter is type hinted as a class, and should be injected
192
-            ! empty($param_class)
193
-            ) {
194
-                // attempt to inject the dependency
195
-                $resolved_parameters[ $index ] = $this->injectDependency($reflector, $param_class);
196
-            } elseif ($param->isOptional()) {
197
-                $resolved_parameters[ $index ] = $param->getDefaultValue();
198
-            } else {
199
-                $resolved_parameters[ $index ] = null;
200
-            }
201
-        }
202
-        return $resolved_parameters;
203
-    }
204
-
205
-
206
-    /**
207
-     * @param ReflectionClass $reflector
208
-     * @param string          $param_class
209
-     * @return mixed
210
-     * @throws UnexpectedValueException
211
-     */
212
-    private function injectDependency(ReflectionClass $reflector, $param_class)
213
-    {
214
-        $dependency = $this->coffee_pot->brew($param_class);
215
-        if (! $dependency instanceof $param_class) {
216
-            throw new UnexpectedValueException(
217
-                sprintf(
218
-                    esc_html__(
219
-                        'Could not resolve dependency for "%1$s" for the "%2$s" class constructor.',
220
-                        'event_espresso'
221
-                    ),
222
-                    $param_class,
223
-                    $reflector->getName()
224
-                )
225
-            );
226
-        }
227
-        return $dependency;
228
-    }
24
+	/**
25
+	 * @var CoffeePotInterface $coffee_pot
26
+	 */
27
+	private $coffee_pot;
28
+
29
+	/**
30
+	 * @var EEH_Array $array_helper
31
+	 */
32
+	private $array_helper;
33
+
34
+	/**
35
+	 * @var ReflectionClass[] $reflectors
36
+	 */
37
+	private $reflectors;
38
+
39
+	/**
40
+	 * @var ReflectionMethod[] $constructors
41
+	 */
42
+	private $constructors;
43
+
44
+	/**
45
+	 * @var ReflectionParameter[] $parameters
46
+	 */
47
+	private $parameters;
48
+
49
+
50
+	/**
51
+	 * DependencyInjector constructor
52
+	 *
53
+	 * @param CoffeePotInterface $coffee_pot
54
+	 * @param EEH_Array          $array_helper
55
+	 */
56
+	public function __construct(CoffeePotInterface $coffee_pot, EEH_Array $array_helper)
57
+	{
58
+		$this->coffee_pot = $coffee_pot;
59
+		$this->array_helper = $array_helper;
60
+	}
61
+
62
+
63
+	/**
64
+	 * getReflectionClass
65
+	 * checks if a ReflectionClass object has already been generated for a class
66
+	 * and returns that instead of creating a new one
67
+	 *
68
+	 * @param string $class_name
69
+	 * @return ReflectionClass
70
+	 */
71
+	public function getReflectionClass($class_name)
72
+	{
73
+		if (! isset($this->reflectors[ $class_name ])
74
+			|| ! $this->reflectors[ $class_name ] instanceof ReflectionClass
75
+		) {
76
+			$this->reflectors[ $class_name ] = new ReflectionClass($class_name);
77
+		}
78
+		return $this->reflectors[ $class_name ];
79
+	}
80
+
81
+
82
+	/**
83
+	 * getConstructor
84
+	 * checks if a ReflectionMethod object has already been generated for the class constructor
85
+	 * and returns that instead of creating a new one
86
+	 *
87
+	 * @param ReflectionClass $reflector
88
+	 * @return ReflectionMethod
89
+	 */
90
+	protected function getConstructor(ReflectionClass $reflector)
91
+	{
92
+		if (! isset($this->constructors[ $reflector->getName() ])
93
+			|| ! $this->constructors[ $reflector->getName() ] instanceof ReflectionMethod
94
+		) {
95
+			$this->constructors[ $reflector->getName() ] = $reflector->getConstructor();
96
+		}
97
+		return $this->constructors[ $reflector->getName() ];
98
+	}
99
+
100
+
101
+	/**
102
+	 * getParameters
103
+	 * checks if an array of ReflectionParameter objects has already been generated for the class constructor
104
+	 * and returns that instead of creating a new one
105
+	 *
106
+	 * @param ReflectionMethod $constructor
107
+	 * @return ReflectionParameter[]
108
+	 */
109
+	protected function getParameters(ReflectionMethod $constructor)
110
+	{
111
+		if (! isset($this->parameters[ $constructor->class ])) {
112
+			$this->parameters[ $constructor->class ] = $constructor->getParameters();
113
+		}
114
+		return $this->parameters[ $constructor->class ];
115
+	}
116
+
117
+
118
+	/**
119
+	 * resolveDependencies
120
+	 * examines the constructor for the requested class to determine
121
+	 * if any dependencies exist, and if they can be injected.
122
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
123
+	 * PLZ NOTE: this is achieved by type hinting the constructor params
124
+	 * For example:
125
+	 *        if attempting to load a class "Foo" with the following constructor:
126
+	 *        __construct( Bar $bar_class, Fighter $grohl_class )
127
+	 *        then $bar_class and $grohl_class will be added to the $arguments array,
128
+	 *        but only IF they are NOT already present in the incoming arguments array,
129
+	 *        and the correct classes can be loaded
130
+	 *
131
+	 * @param RecipeInterface $recipe
132
+	 * @param ReflectionClass $reflector
133
+	 * @param array           $arguments
134
+	 * @return array
135
+	 * @throws UnexpectedValueException
136
+	 */
137
+	public function resolveDependencies(RecipeInterface $recipe, ReflectionClass $reflector, $arguments = array())
138
+	{
139
+		// if arguments array is numerically and sequentially indexed, then we want it to remain as is,
140
+		// else wrap it in an additional array so that it doesn't get split into multiple parameters
141
+		$arguments = $this->array_helper->is_array_numerically_and_sequentially_indexed($arguments)
142
+			? $arguments
143
+			: array($arguments);
144
+		$resolved_parameters = array();
145
+		// let's examine the constructor
146
+		// let's examine the constructor
147
+		$constructor = $this->getConstructor($reflector);
148
+		// whu? huh? nothing?
149
+		if (! $constructor) {
150
+			return $arguments;
151
+		}
152
+		// get constructor parameters
153
+		$params = $this->getParameters($constructor);
154
+		if (empty($params)) {
155
+			return $resolved_parameters;
156
+		}
157
+		$ingredients = $recipe->ingredients();
158
+		// and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
159
+		$argument_keys = array_keys($arguments);
160
+		// now loop thru all of the constructors expected parameters
161
+		foreach ($params as $index => $param) {
162
+			if (! $param instanceof ReflectionParameter) {
163
+				continue;
164
+			}
165
+			// is this a dependency for a specific class ?
166
+			$param_class = $param->getClass() ? $param->getClass()->name : '';
167
+			$param_name = $param->getName() ? $param->getName() : '';
168
+			if (// param is not a class but is specified in the list of ingredients for this Recipe
169
+				is_string($param_name) && isset($ingredients[ $param_name ])
170
+			) {
171
+				// attempt to inject the dependency
172
+				$resolved_parameters[ $index ] = $ingredients[ $param_name ];
173
+			} elseif (// param is specified in the list of ingredients for this Recipe
174
+			isset($ingredients[ $param_class ])
175
+			) { // attempt to inject the dependency
176
+				$resolved_parameters[ $index ] = $this->injectDependency($reflector, $ingredients[ $param_class ]);
177
+			} elseif (// param is not even a class
178
+				empty($param_class)
179
+				// and something already exists in the incoming arguments for this param
180
+				&& isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
181
+			) {
182
+				// add parameter from incoming arguments
183
+				$resolved_parameters[ $index ] = $arguments[ $argument_keys[ $index ] ];
184
+			} elseif (// parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
185
+				! empty($param_class)
186
+				&& isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
187
+				&& $arguments[ $argument_keys[ $index ] ] instanceof $param_class
188
+			) {
189
+				// add parameter from incoming arguments
190
+				$resolved_parameters[ $index ] = $arguments[ $argument_keys[ $index ] ];
191
+			} elseif (// parameter is type hinted as a class, and should be injected
192
+			! empty($param_class)
193
+			) {
194
+				// attempt to inject the dependency
195
+				$resolved_parameters[ $index ] = $this->injectDependency($reflector, $param_class);
196
+			} elseif ($param->isOptional()) {
197
+				$resolved_parameters[ $index ] = $param->getDefaultValue();
198
+			} else {
199
+				$resolved_parameters[ $index ] = null;
200
+			}
201
+		}
202
+		return $resolved_parameters;
203
+	}
204
+
205
+
206
+	/**
207
+	 * @param ReflectionClass $reflector
208
+	 * @param string          $param_class
209
+	 * @return mixed
210
+	 * @throws UnexpectedValueException
211
+	 */
212
+	private function injectDependency(ReflectionClass $reflector, $param_class)
213
+	{
214
+		$dependency = $this->coffee_pot->brew($param_class);
215
+		if (! $dependency instanceof $param_class) {
216
+			throw new UnexpectedValueException(
217
+				sprintf(
218
+					esc_html__(
219
+						'Could not resolve dependency for "%1$s" for the "%2$s" class constructor.',
220
+						'event_espresso'
221
+					),
222
+					$param_class,
223
+					$reflector->getName()
224
+				)
225
+			);
226
+		}
227
+		return $dependency;
228
+	}
229 229
 }
Please login to merge, or discard this patch.
Spacing   +26 added lines, -26 removed lines patch added patch discarded remove patch
@@ -70,12 +70,12 @@  discard block
 block discarded – undo
70 70
      */
71 71
     public function getReflectionClass($class_name)
72 72
     {
73
-        if (! isset($this->reflectors[ $class_name ])
74
-            || ! $this->reflectors[ $class_name ] instanceof ReflectionClass
73
+        if ( ! isset($this->reflectors[$class_name])
74
+            || ! $this->reflectors[$class_name] instanceof ReflectionClass
75 75
         ) {
76
-            $this->reflectors[ $class_name ] = new ReflectionClass($class_name);
76
+            $this->reflectors[$class_name] = new ReflectionClass($class_name);
77 77
         }
78
-        return $this->reflectors[ $class_name ];
78
+        return $this->reflectors[$class_name];
79 79
     }
80 80
 
81 81
 
@@ -89,12 +89,12 @@  discard block
 block discarded – undo
89 89
      */
90 90
     protected function getConstructor(ReflectionClass $reflector)
91 91
     {
92
-        if (! isset($this->constructors[ $reflector->getName() ])
93
-            || ! $this->constructors[ $reflector->getName() ] instanceof ReflectionMethod
92
+        if ( ! isset($this->constructors[$reflector->getName()])
93
+            || ! $this->constructors[$reflector->getName()] instanceof ReflectionMethod
94 94
         ) {
95
-            $this->constructors[ $reflector->getName() ] = $reflector->getConstructor();
95
+            $this->constructors[$reflector->getName()] = $reflector->getConstructor();
96 96
         }
97
-        return $this->constructors[ $reflector->getName() ];
97
+        return $this->constructors[$reflector->getName()];
98 98
     }
99 99
 
100 100
 
@@ -108,10 +108,10 @@  discard block
 block discarded – undo
108 108
      */
109 109
     protected function getParameters(ReflectionMethod $constructor)
110 110
     {
111
-        if (! isset($this->parameters[ $constructor->class ])) {
112
-            $this->parameters[ $constructor->class ] = $constructor->getParameters();
111
+        if ( ! isset($this->parameters[$constructor->class])) {
112
+            $this->parameters[$constructor->class] = $constructor->getParameters();
113 113
         }
114
-        return $this->parameters[ $constructor->class ];
114
+        return $this->parameters[$constructor->class];
115 115
     }
116 116
 
117 117
 
@@ -146,7 +146,7 @@  discard block
 block discarded – undo
146 146
         // let's examine the constructor
147 147
         $constructor = $this->getConstructor($reflector);
148 148
         // whu? huh? nothing?
149
-        if (! $constructor) {
149
+        if ( ! $constructor) {
150 150
             return $arguments;
151 151
         }
152 152
         // get constructor parameters
@@ -159,44 +159,44 @@  discard block
 block discarded – undo
159 159
         $argument_keys = array_keys($arguments);
160 160
         // now loop thru all of the constructors expected parameters
161 161
         foreach ($params as $index => $param) {
162
-            if (! $param instanceof ReflectionParameter) {
162
+            if ( ! $param instanceof ReflectionParameter) {
163 163
                 continue;
164 164
             }
165 165
             // is this a dependency for a specific class ?
166 166
             $param_class = $param->getClass() ? $param->getClass()->name : '';
167 167
             $param_name = $param->getName() ? $param->getName() : '';
168 168
             if (// param is not a class but is specified in the list of ingredients for this Recipe
169
-                is_string($param_name) && isset($ingredients[ $param_name ])
169
+                is_string($param_name) && isset($ingredients[$param_name])
170 170
             ) {
171 171
                 // attempt to inject the dependency
172
-                $resolved_parameters[ $index ] = $ingredients[ $param_name ];
172
+                $resolved_parameters[$index] = $ingredients[$param_name];
173 173
             } elseif (// param is specified in the list of ingredients for this Recipe
174
-            isset($ingredients[ $param_class ])
174
+            isset($ingredients[$param_class])
175 175
             ) { // attempt to inject the dependency
176
-                $resolved_parameters[ $index ] = $this->injectDependency($reflector, $ingredients[ $param_class ]);
176
+                $resolved_parameters[$index] = $this->injectDependency($reflector, $ingredients[$param_class]);
177 177
             } elseif (// param is not even a class
178 178
                 empty($param_class)
179 179
                 // and something already exists in the incoming arguments for this param
180
-                && isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
180
+                && isset($argument_keys[$index], $arguments[$argument_keys[$index]])
181 181
             ) {
182 182
                 // add parameter from incoming arguments
183
-                $resolved_parameters[ $index ] = $arguments[ $argument_keys[ $index ] ];
183
+                $resolved_parameters[$index] = $arguments[$argument_keys[$index]];
184 184
             } elseif (// parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
185 185
                 ! empty($param_class)
186
-                && isset($argument_keys[ $index ], $arguments[ $argument_keys[ $index ] ])
187
-                && $arguments[ $argument_keys[ $index ] ] instanceof $param_class
186
+                && isset($argument_keys[$index], $arguments[$argument_keys[$index]])
187
+                && $arguments[$argument_keys[$index]] instanceof $param_class
188 188
             ) {
189 189
                 // add parameter from incoming arguments
190
-                $resolved_parameters[ $index ] = $arguments[ $argument_keys[ $index ] ];
190
+                $resolved_parameters[$index] = $arguments[$argument_keys[$index]];
191 191
             } elseif (// parameter is type hinted as a class, and should be injected
192 192
             ! empty($param_class)
193 193
             ) {
194 194
                 // attempt to inject the dependency
195
-                $resolved_parameters[ $index ] = $this->injectDependency($reflector, $param_class);
195
+                $resolved_parameters[$index] = $this->injectDependency($reflector, $param_class);
196 196
             } elseif ($param->isOptional()) {
197
-                $resolved_parameters[ $index ] = $param->getDefaultValue();
197
+                $resolved_parameters[$index] = $param->getDefaultValue();
198 198
             } else {
199
-                $resolved_parameters[ $index ] = null;
199
+                $resolved_parameters[$index] = null;
200 200
             }
201 201
         }
202 202
         return $resolved_parameters;
@@ -212,7 +212,7 @@  discard block
 block discarded – undo
212 212
     private function injectDependency(ReflectionClass $reflector, $param_class)
213 213
     {
214 214
         $dependency = $this->coffee_pot->brew($param_class);
215
-        if (! $dependency instanceof $param_class) {
215
+        if ( ! $dependency instanceof $param_class) {
216 216
             throw new UnexpectedValueException(
217 217
                 sprintf(
218 218
                     esc_html__(
Please login to merge, or discard this patch.