@@ -18,14 +18,14 @@ |
||
18 | 18 | interface EmailValidatorInterface |
19 | 19 | { |
20 | 20 | |
21 | - /** |
|
22 | - * Validates the supplied email address. If it is invalid, throws EmailValidationException |
|
23 | - * |
|
24 | - * @param string $email_address |
|
25 | - * @return boolean |
|
26 | - * @throws EmailValidationException |
|
27 | - */ |
|
28 | - public function validate($email_address); |
|
21 | + /** |
|
22 | + * Validates the supplied email address. If it is invalid, throws EmailValidationException |
|
23 | + * |
|
24 | + * @param string $email_address |
|
25 | + * @return boolean |
|
26 | + * @throws EmailValidationException |
|
27 | + */ |
|
28 | + public function validate($email_address); |
|
29 | 29 | |
30 | 30 | |
31 | 31 | } |
@@ -18,72 +18,72 @@ |
||
18 | 18 | { |
19 | 19 | |
20 | 20 | |
21 | - /** |
|
22 | - * @param string $validation_error_message |
|
23 | - */ |
|
24 | - public function __construct($validation_error_message = '') |
|
25 | - { |
|
26 | - if (! $validation_error_message) { |
|
27 | - $validation_error_message = esc_html__('Please enter a valid email address.', 'event_espresso'); |
|
28 | - } |
|
29 | - parent::__construct($validation_error_message); |
|
30 | - } |
|
21 | + /** |
|
22 | + * @param string $validation_error_message |
|
23 | + */ |
|
24 | + public function __construct($validation_error_message = '') |
|
25 | + { |
|
26 | + if (! $validation_error_message) { |
|
27 | + $validation_error_message = esc_html__('Please enter a valid email address.', 'event_espresso'); |
|
28 | + } |
|
29 | + parent::__construct($validation_error_message); |
|
30 | + } |
|
31 | 31 | |
32 | 32 | |
33 | 33 | |
34 | - /** |
|
35 | - * just checks the field isn't blank |
|
36 | - * |
|
37 | - * @param $normalized_value |
|
38 | - * @return bool |
|
39 | - * @throws InvalidArgumentException |
|
40 | - * @throws InvalidInterfaceException |
|
41 | - * @throws InvalidDataTypeException |
|
42 | - * @throws EE_Validation_Error |
|
43 | - */ |
|
44 | - public function validate($normalized_value) |
|
45 | - { |
|
46 | - if ($normalized_value && ! $this->_validate_email($normalized_value)) { |
|
47 | - throw new EE_Validation_Error($this->get_validation_error_message(), 'required'); |
|
48 | - } |
|
49 | - return true; |
|
50 | - } |
|
34 | + /** |
|
35 | + * just checks the field isn't blank |
|
36 | + * |
|
37 | + * @param $normalized_value |
|
38 | + * @return bool |
|
39 | + * @throws InvalidArgumentException |
|
40 | + * @throws InvalidInterfaceException |
|
41 | + * @throws InvalidDataTypeException |
|
42 | + * @throws EE_Validation_Error |
|
43 | + */ |
|
44 | + public function validate($normalized_value) |
|
45 | + { |
|
46 | + if ($normalized_value && ! $this->_validate_email($normalized_value)) { |
|
47 | + throw new EE_Validation_Error($this->get_validation_error_message(), 'required'); |
|
48 | + } |
|
49 | + return true; |
|
50 | + } |
|
51 | 51 | |
52 | 52 | |
53 | 53 | |
54 | - /** |
|
55 | - * @return array |
|
56 | - */ |
|
57 | - public function get_jquery_validation_rule_array() |
|
58 | - { |
|
59 | - return array('email' => true, 'messages' => array('email' => $this->get_validation_error_message())); |
|
60 | - } |
|
54 | + /** |
|
55 | + * @return array |
|
56 | + */ |
|
57 | + public function get_jquery_validation_rule_array() |
|
58 | + { |
|
59 | + return array('email' => true, 'messages' => array('email' => $this->get_validation_error_message())); |
|
60 | + } |
|
61 | 61 | |
62 | 62 | |
63 | 63 | |
64 | - /** |
|
65 | - * Validate an email address. |
|
66 | - * Provide email address (raw input) |
|
67 | - * |
|
68 | - * @param $email |
|
69 | - * @return bool of whether the email is valid or not |
|
70 | - * @throws InvalidArgumentException |
|
71 | - * @throws InvalidInterfaceException |
|
72 | - * @throws InvalidDataTypeException |
|
73 | - * @throws EE_Validation_Error |
|
74 | - */ |
|
75 | - private function _validate_email($email) |
|
76 | - { |
|
77 | - try { |
|
78 | - EmailAddressFactory::create($email); |
|
79 | - } catch (EmailValidationException $e) { |
|
80 | - throw new EE_Validation_Error( |
|
81 | - $e->getMessage(), |
|
82 | - 'invalid_email', |
|
83 | - $this->_input, |
|
84 | - $e |
|
85 | - ); |
|
86 | - } |
|
87 | - return true; |
|
88 | - } |
|
64 | + /** |
|
65 | + * Validate an email address. |
|
66 | + * Provide email address (raw input) |
|
67 | + * |
|
68 | + * @param $email |
|
69 | + * @return bool of whether the email is valid or not |
|
70 | + * @throws InvalidArgumentException |
|
71 | + * @throws InvalidInterfaceException |
|
72 | + * @throws InvalidDataTypeException |
|
73 | + * @throws EE_Validation_Error |
|
74 | + */ |
|
75 | + private function _validate_email($email) |
|
76 | + { |
|
77 | + try { |
|
78 | + EmailAddressFactory::create($email); |
|
79 | + } catch (EmailValidationException $e) { |
|
80 | + throw new EE_Validation_Error( |
|
81 | + $e->getMessage(), |
|
82 | + 'invalid_email', |
|
83 | + $this->_input, |
|
84 | + $e |
|
85 | + ); |
|
86 | + } |
|
87 | + return true; |
|
88 | + } |
|
89 | 89 | } |
@@ -23,7 +23,7 @@ |
||
23 | 23 | */ |
24 | 24 | public function __construct($validation_error_message = '') |
25 | 25 | { |
26 | - if (! $validation_error_message) { |
|
26 | + if ( ! $validation_error_message) { |
|
27 | 27 | $validation_error_message = esc_html__('Please enter a valid email address.', 'event_espresso'); |
28 | 28 | } |
29 | 29 | parent::__construct($validation_error_message); |
@@ -351,7 +351,7 @@ |
||
351 | 351 | * retrieve a single attendee from db via their ID |
352 | 352 | * |
353 | 353 | * @param $ATT_ID |
354 | - * @return mixed array on success, FALSE on fail |
|
354 | + * @return EE_Base_Class|null array on success, FALSE on fail |
|
355 | 355 | * @deprecated |
356 | 356 | */ |
357 | 357 | public function get_attendee_by_ID($ATT_ID = false) |
@@ -1,5 +1,4 @@ |
||
1 | 1 | <?php |
2 | -use EventEspresso\core\services\loaders\Loader; |
|
3 | 2 | use EventEspresso\core\services\orm\ModelFieldFactory; |
4 | 3 | |
5 | 4 | /** |
@@ -284,8 +284,8 @@ discard block |
||
284 | 284 | */ |
285 | 285 | public function get_attendee_field_for_system_question($system_question_string) |
286 | 286 | { |
287 | - return isset($this->_system_question_to_attendee_field_name[ $system_question_string ]) |
|
288 | - ? $this->_system_question_to_attendee_field_name[ $system_question_string ] |
|
287 | + return isset($this->_system_question_to_attendee_field_name[$system_question_string]) |
|
288 | + ? $this->_system_question_to_attendee_field_name[$system_question_string] |
|
289 | 289 | : null; |
290 | 290 | } |
291 | 291 | |
@@ -353,7 +353,7 @@ discard block |
||
353 | 353 | return false; |
354 | 354 | } |
355 | 355 | $attendee = $this->get_all(array($where_cols_n_values)); |
356 | - if (! empty($attendee)) { |
|
356 | + if ( ! empty($attendee)) { |
|
357 | 357 | return array_shift($attendee); |
358 | 358 | } |
359 | 359 | return false; |
@@ -12,432 +12,432 @@ |
||
12 | 12 | class EEM_Attendee extends EEM_CPT_Base |
13 | 13 | { |
14 | 14 | |
15 | - // private instance of the Attendee object |
|
16 | - protected static $_instance = null; |
|
15 | + // private instance of the Attendee object |
|
16 | + protected static $_instance = null; |
|
17 | 17 | |
18 | - /** |
|
19 | - * QST_system for questions are strings not integers now, |
|
20 | - * so these constants are deprecated. |
|
21 | - * Please instead use the EEM_Attendee::system_question_* constants |
|
22 | - * |
|
23 | - * @deprecated |
|
24 | - */ |
|
25 | - const fname_question_id = 1; |
|
18 | + /** |
|
19 | + * QST_system for questions are strings not integers now, |
|
20 | + * so these constants are deprecated. |
|
21 | + * Please instead use the EEM_Attendee::system_question_* constants |
|
22 | + * |
|
23 | + * @deprecated |
|
24 | + */ |
|
25 | + const fname_question_id = 1; |
|
26 | 26 | |
27 | - /** |
|
28 | - * @deprecated |
|
29 | - */ |
|
30 | - const lname_question_id = 2; |
|
27 | + /** |
|
28 | + * @deprecated |
|
29 | + */ |
|
30 | + const lname_question_id = 2; |
|
31 | 31 | |
32 | 32 | |
33 | - /** |
|
34 | - * @deprecated |
|
35 | - */ |
|
36 | - const email_question_id = 3; |
|
33 | + /** |
|
34 | + * @deprecated |
|
35 | + */ |
|
36 | + const email_question_id = 3; |
|
37 | 37 | |
38 | 38 | |
39 | - /** |
|
40 | - * @deprecated |
|
41 | - */ |
|
42 | - const address_question_id = 4; |
|
39 | + /** |
|
40 | + * @deprecated |
|
41 | + */ |
|
42 | + const address_question_id = 4; |
|
43 | 43 | |
44 | 44 | |
45 | - /** |
|
46 | - * @deprecated |
|
47 | - */ |
|
48 | - const address2_question_id = 5; |
|
45 | + /** |
|
46 | + * @deprecated |
|
47 | + */ |
|
48 | + const address2_question_id = 5; |
|
49 | 49 | |
50 | - |
|
51 | - /** |
|
52 | - * @deprecated |
|
53 | - */ |
|
54 | - const city_question_id = 6; |
|
55 | - |
|
56 | - |
|
57 | - /** |
|
58 | - * @deprecated |
|
59 | - */ |
|
60 | - const state_question_id = 7; |
|
61 | - |
|
62 | - |
|
63 | - /** |
|
64 | - * @deprecated |
|
65 | - */ |
|
66 | - const country_question_id = 8; |
|
67 | - |
|
68 | - |
|
69 | - /** |
|
70 | - * @deprecated |
|
71 | - */ |
|
72 | - const zip_question_id = 9; |
|
73 | - |
|
74 | - |
|
75 | - /** |
|
76 | - * @deprecated |
|
77 | - */ |
|
78 | - const phone_question_id = 10; |
|
79 | - |
|
80 | - /** |
|
81 | - * When looking for questions that correspond to attendee fields, |
|
82 | - * look for the question with this QST_system value. |
|
83 | - * These replace the old constants like EEM_Attendee::*_question_id |
|
84 | - */ |
|
85 | - const system_question_fname = 'fname'; |
|
86 | - |
|
87 | - const system_question_lname = 'lname'; |
|
88 | - |
|
89 | - const system_question_email = 'email'; |
|
90 | - |
|
91 | - const system_question_email_confirm = 'email_confirm'; |
|
92 | - |
|
93 | - const system_question_address = 'address'; |
|
94 | - |
|
95 | - const system_question_address2 = 'address2'; |
|
96 | - |
|
97 | - const system_question_city = 'city'; |
|
98 | - |
|
99 | - const system_question_state = 'state'; |
|
100 | - |
|
101 | - const system_question_country = 'country'; |
|
102 | - |
|
103 | - const system_question_zip = 'zip'; |
|
104 | - |
|
105 | - const system_question_phone = 'phone'; |
|
106 | - |
|
107 | - /** |
|
108 | - * Keys are all the EEM_Attendee::system_question_* constants, which are |
|
109 | - * also all the values of QST_system in the questions table, and values |
|
110 | - * are their corresponding Attendee field names |
|
111 | - * |
|
112 | - * @var array |
|
113 | - */ |
|
114 | - protected $_system_question_to_attendee_field_name = array( |
|
115 | - EEM_Attendee::system_question_fname => 'ATT_fname', |
|
116 | - EEM_Attendee::system_question_lname => 'ATT_lname', |
|
117 | - EEM_Attendee::system_question_email => 'ATT_email', |
|
118 | - EEM_Attendee::system_question_address => 'ATT_address', |
|
119 | - EEM_Attendee::system_question_address2 => 'ATT_address2', |
|
120 | - EEM_Attendee::system_question_city => 'ATT_city', |
|
121 | - EEM_Attendee::system_question_state => 'STA_ID', |
|
122 | - EEM_Attendee::system_question_country => 'CNT_ISO', |
|
123 | - EEM_Attendee::system_question_zip => 'ATT_zip', |
|
124 | - EEM_Attendee::system_question_phone => 'ATT_phone', |
|
125 | - ); |
|
126 | - |
|
127 | - |
|
128 | - |
|
129 | - /** |
|
130 | - * EEM_Attendee constructor. |
|
131 | - * |
|
132 | - * @param null $timezone |
|
133 | - * @param ModelFieldFactory $model_field_factory |
|
134 | - * @throws EE_Error |
|
135 | - * @throws InvalidArgumentException |
|
136 | - */ |
|
137 | - protected function __construct($timezone = null, ModelFieldFactory $model_field_factory) |
|
138 | - { |
|
139 | - $this->singular_item = esc_html__('Attendee', 'event_espresso'); |
|
140 | - $this->plural_item = esc_html__('Attendees', 'event_espresso'); |
|
141 | - $this->_tables = array( |
|
142 | - 'Attendee_CPT' => new EE_Primary_Table('posts', 'ID'), |
|
143 | - 'Attendee_Meta' => new EE_Secondary_Table( |
|
144 | - 'esp_attendee_meta', |
|
145 | - 'ATTM_ID', |
|
146 | - 'ATT_ID' |
|
147 | - ), |
|
148 | - ); |
|
149 | - $this->_fields = array( |
|
150 | - 'Attendee_CPT' => array( |
|
151 | - 'ATT_ID' => $model_field_factory->createPrimaryKeyIntField( |
|
152 | - 'ID', |
|
153 | - esc_html__('Attendee ID', 'event_espresso') |
|
154 | - ), |
|
155 | - 'ATT_full_name' => $model_field_factory->createPlainTextField( |
|
156 | - 'post_title', |
|
157 | - esc_html__('Attendee Full Name', 'event_espresso'), |
|
158 | - false, |
|
159 | - esc_html__('Unknown', 'event_espresso') |
|
160 | - ), |
|
161 | - 'ATT_bio' => $model_field_factory->createPostContentField( |
|
162 | - 'post_content', |
|
163 | - esc_html__('Attendee Biography', 'event_espresso'), |
|
164 | - false, |
|
165 | - esc_html__('No Biography Provided', 'event_espresso') |
|
166 | - ), |
|
167 | - 'ATT_slug' => $model_field_factory->createSlugField( |
|
168 | - 'post_name', |
|
169 | - esc_html__('Attendee URL Slug', 'event_espresso') |
|
170 | - ), |
|
171 | - 'ATT_created' => $model_field_factory->createDatetimeField( |
|
172 | - 'post_date', |
|
173 | - esc_html__('Time Attendee Created', 'event_espresso') |
|
174 | - ), |
|
175 | - 'ATT_short_bio' => $model_field_factory->createSimpleHtmlField( |
|
176 | - 'post_excerpt', |
|
177 | - esc_html__('Attendee Short Biography', 'event_espresso'), |
|
178 | - true, |
|
179 | - esc_html__('No Biography Provided', 'event_espresso') |
|
180 | - ), |
|
181 | - 'ATT_modified' => $model_field_factory->createDatetimeField( |
|
182 | - 'post_modified', |
|
183 | - esc_html__('Time Attendee Last Modified', 'event_espresso') |
|
184 | - ), |
|
185 | - 'ATT_author' => $model_field_factory->createWpUserField( |
|
186 | - 'post_author', |
|
187 | - esc_html__('Creator ID of the first Event attended', 'event_espresso'), |
|
188 | - false |
|
189 | - ), |
|
190 | - 'ATT_parent' => $model_field_factory->createDbOnlyIntField( |
|
191 | - 'post_parent', |
|
192 | - esc_html__('Parent Attendee (unused)', 'event_espresso'), |
|
193 | - false, |
|
194 | - 0 |
|
195 | - ), |
|
196 | - 'post_type' => $model_field_factory->createWpPostTypeField('espresso_attendees'), |
|
197 | - 'status' => $model_field_factory->createWpPostStatusField( |
|
198 | - 'post_status', |
|
199 | - esc_html__('Attendee Status', 'event_espresso'), |
|
200 | - false, |
|
201 | - 'publish' |
|
202 | - ), |
|
203 | - 'password' => new EE_Password_Field( |
|
204 | - 'post_password', |
|
205 | - __('Password', 'event_espresso'), |
|
206 | - false, |
|
207 | - '', |
|
208 | - array( |
|
209 | - 'ATT_bio', |
|
210 | - 'ATT_short_bio', |
|
211 | - 'ATT_address', |
|
212 | - 'ATT_address2', |
|
213 | - 'ATT_city', |
|
214 | - 'STA_ID', |
|
215 | - 'CNT_ISO', |
|
216 | - 'ATT_zip', |
|
217 | - 'ATT_email', |
|
218 | - 'ATT_phone' |
|
219 | - ) |
|
220 | - ) |
|
221 | - ), |
|
222 | - 'Attendee_Meta' => array( |
|
223 | - 'ATTM_ID' => $model_field_factory->createDbOnlyIntField( |
|
224 | - 'ATTM_ID', |
|
225 | - esc_html__('Attendee Meta Row ID', 'event_espresso'), |
|
226 | - false |
|
227 | - ), |
|
228 | - 'ATT_ID_fk' => $model_field_factory->createDbOnlyIntField( |
|
229 | - 'ATT_ID', |
|
230 | - esc_html__('Foreign Key to Attendee in Post Table', 'event_espresso'), |
|
231 | - false |
|
232 | - ), |
|
233 | - 'ATT_fname' => $model_field_factory->createPlainTextField( |
|
234 | - 'ATT_fname', |
|
235 | - esc_html__('First Name', 'event_espresso') |
|
236 | - ), |
|
237 | - 'ATT_lname' => $model_field_factory->createPlainTextField( |
|
238 | - 'ATT_lname', |
|
239 | - esc_html__('Last Name', 'event_espresso') |
|
240 | - ), |
|
241 | - 'ATT_address' => $model_field_factory->createPlainTextField( |
|
242 | - 'ATT_address', |
|
243 | - esc_html__('Address Part 1', 'event_espresso') |
|
244 | - ), |
|
245 | - 'ATT_address2' => $model_field_factory->createPlainTextField( |
|
246 | - 'ATT_address2', |
|
247 | - esc_html__('Address Part 2', 'event_espresso') |
|
248 | - ), |
|
249 | - 'ATT_city' => $model_field_factory->createPlainTextField( |
|
250 | - 'ATT_city', |
|
251 | - esc_html__('City', 'event_espresso') |
|
252 | - ), |
|
253 | - 'STA_ID' => $model_field_factory->createForeignKeyIntField( |
|
254 | - 'STA_ID', |
|
255 | - esc_html__('State', 'event_espresso'), |
|
256 | - true, |
|
257 | - 0, |
|
258 | - 'State' |
|
259 | - ), |
|
260 | - 'CNT_ISO' => $model_field_factory->createForeignKeyStringField( |
|
261 | - 'CNT_ISO', |
|
262 | - esc_html__('Country', 'event_espresso'), |
|
263 | - true, |
|
264 | - '', |
|
265 | - 'Country' |
|
266 | - ), |
|
267 | - 'ATT_zip' => $model_field_factory->createPlainTextField( |
|
268 | - 'ATT_zip', |
|
269 | - esc_html__('ZIP/Postal Code', 'event_espresso') |
|
270 | - ), |
|
271 | - 'ATT_email' => $model_field_factory->createEmailField( |
|
272 | - 'ATT_email', |
|
273 | - esc_html__('Email Address', 'event_espresso') |
|
274 | - ), |
|
275 | - 'ATT_phone' => $model_field_factory->createPlainTextField( |
|
276 | - 'ATT_phone', |
|
277 | - esc_html__('Phone', 'event_espresso') |
|
278 | - ), |
|
279 | - ), |
|
280 | - ); |
|
281 | - $this->_model_relations = array( |
|
282 | - 'Registration' => new EE_Has_Many_Relation(), |
|
283 | - 'State' => new EE_Belongs_To_Relation(), |
|
284 | - 'Country' => new EE_Belongs_To_Relation(), |
|
285 | - 'Event' => new EE_HABTM_Relation('Registration', false), |
|
286 | - 'WP_User' => new EE_Belongs_To_Relation(), |
|
287 | - 'Message' => new EE_Has_Many_Any_Relation(false), |
|
288 | - // allow deletion of attendees even if they have messages in the queue for them. |
|
289 | - 'Term_Relationship' => new EE_Has_Many_Relation(), |
|
290 | - 'Term_Taxonomy' => new EE_HABTM_Relation('Term_Relationship'), |
|
291 | - ); |
|
292 | - $this->_caps_slug = 'contacts'; |
|
293 | - $this->model_chain_to_password = ''; |
|
294 | - parent::__construct($timezone); |
|
295 | - } |
|
296 | - |
|
297 | - |
|
298 | - |
|
299 | - /** |
|
300 | - * Gets the name of the field on the attendee model corresponding to the system question string |
|
301 | - * which should be one of the keys from EEM_Attendee::_system_question_to_attendee_field_name |
|
302 | - * |
|
303 | - * @param string $system_question_string |
|
304 | - * @return string|null if not found |
|
305 | - */ |
|
306 | - public function get_attendee_field_for_system_question($system_question_string) |
|
307 | - { |
|
308 | - return isset($this->_system_question_to_attendee_field_name[ $system_question_string ]) |
|
309 | - ? $this->_system_question_to_attendee_field_name[ $system_question_string ] |
|
310 | - : null; |
|
311 | - } |
|
312 | - |
|
313 | - |
|
314 | - |
|
315 | - /** |
|
316 | - * Gets mapping from esp_question.QST_system values to their corresponding attendee field names |
|
317 | - * |
|
318 | - * @return array |
|
319 | - */ |
|
320 | - public function system_question_to_attendee_field_mapping() |
|
321 | - { |
|
322 | - return $this->_system_question_to_attendee_field_name; |
|
323 | - } |
|
324 | - |
|
325 | - |
|
326 | - |
|
327 | - /** |
|
328 | - * Gets all the attendees for a transaction (by using the esp_registration as a join table) |
|
329 | - * |
|
330 | - * @param EE_Transaction /int $transaction_id_or_obj EE_Transaction or its ID |
|
331 | - * @return EE_Attendee[]|EE_Base_Class[] |
|
332 | - * @throws EE_Error |
|
333 | - */ |
|
334 | - public function get_attendees_for_transaction($transaction_id_or_obj) |
|
335 | - { |
|
336 | - return $this->get_all( |
|
337 | - array( |
|
338 | - array( |
|
339 | - 'Registration.Transaction.TXN_ID' => $transaction_id_or_obj instanceof EE_Transaction |
|
340 | - ? $transaction_id_or_obj->ID() |
|
341 | - : $transaction_id_or_obj, |
|
342 | - ), |
|
343 | - ) |
|
344 | - ); |
|
345 | - } |
|
346 | - |
|
347 | - |
|
348 | - |
|
349 | - /** |
|
350 | - * retrieve a single attendee from db via their ID |
|
351 | - * |
|
352 | - * @param $ATT_ID |
|
353 | - * @return mixed array on success, FALSE on fail |
|
354 | - * @deprecated |
|
355 | - */ |
|
356 | - public function get_attendee_by_ID($ATT_ID = false) |
|
357 | - { |
|
358 | - // retrieve a particular EE_Attendee |
|
359 | - return $this->get_one_by_ID($ATT_ID); |
|
360 | - } |
|
361 | - |
|
362 | - |
|
363 | - |
|
364 | - /** |
|
365 | - * retrieve a single attendee from db via their ID |
|
366 | - * |
|
367 | - * @param array $where_cols_n_values |
|
368 | - * @return mixed array on success, FALSE on fail |
|
369 | - * @throws EE_Error |
|
370 | - */ |
|
371 | - public function get_attendee($where_cols_n_values = array()) |
|
372 | - { |
|
373 | - if (empty($where_cols_n_values)) { |
|
374 | - return false; |
|
375 | - } |
|
376 | - $attendee = $this->get_all(array($where_cols_n_values)); |
|
377 | - if (! empty($attendee)) { |
|
378 | - return array_shift($attendee); |
|
379 | - } |
|
380 | - return false; |
|
381 | - } |
|
382 | - |
|
383 | - |
|
384 | - |
|
385 | - /** |
|
386 | - * Search for an existing Attendee record in the DB |
|
387 | - * |
|
388 | - * @param array $where_cols_n_values |
|
389 | - * @return bool|mixed |
|
390 | - * @throws EE_Error |
|
391 | - */ |
|
392 | - public function find_existing_attendee($where_cols_n_values = null) |
|
393 | - { |
|
394 | - // search by combo of first and last names plus the email address |
|
395 | - $attendee_data_keys = array( |
|
396 | - 'ATT_fname' => $this->_ATT_fname, |
|
397 | - 'ATT_lname' => $this->_ATT_lname, |
|
398 | - 'ATT_email' => $this->_ATT_email, |
|
399 | - ); |
|
400 | - // no search params means attendee object already exists. |
|
401 | - $where_cols_n_values = is_array($where_cols_n_values) && ! empty($where_cols_n_values) |
|
402 | - ? $where_cols_n_values |
|
403 | - : $attendee_data_keys; |
|
404 | - $valid_data = true; |
|
405 | - // check for required values |
|
406 | - $valid_data = isset($where_cols_n_values['ATT_fname']) && ! empty($where_cols_n_values['ATT_fname']) |
|
407 | - ? $valid_data |
|
408 | - : false; |
|
409 | - $valid_data = isset($where_cols_n_values['ATT_lname']) && ! empty($where_cols_n_values['ATT_lname']) |
|
410 | - ? $valid_data |
|
411 | - : false; |
|
412 | - $valid_data = isset($where_cols_n_values['ATT_email']) && ! empty($where_cols_n_values['ATT_email']) |
|
413 | - ? $valid_data |
|
414 | - : false; |
|
415 | - if ($valid_data) { |
|
416 | - $attendee = $this->get_attendee($where_cols_n_values); |
|
417 | - if ($attendee instanceof EE_Attendee) { |
|
418 | - return $attendee; |
|
419 | - } |
|
420 | - } |
|
421 | - return false; |
|
422 | - } |
|
423 | - |
|
424 | - |
|
425 | - |
|
426 | - /** |
|
427 | - * Takes an incoming array of EE_Registration ids |
|
428 | - * and sends back a list of corresponding non duplicate EE_Attendee objects. |
|
429 | - * |
|
430 | - * @since 4.3.0 |
|
431 | - * @param array $ids array of EE_Registration ids |
|
432 | - * @return EE_Attendee[]|EE_Base_Class[] |
|
433 | - * @throws EE_Error |
|
434 | - */ |
|
435 | - public function get_array_of_contacts_from_reg_ids($ids) |
|
436 | - { |
|
437 | - $ids = (array) $ids; |
|
438 | - $_where = array( |
|
439 | - 'Registration.REG_ID' => array('in', $ids), |
|
440 | - ); |
|
441 | - return $this->get_all(array($_where)); |
|
442 | - } |
|
50 | + |
|
51 | + /** |
|
52 | + * @deprecated |
|
53 | + */ |
|
54 | + const city_question_id = 6; |
|
55 | + |
|
56 | + |
|
57 | + /** |
|
58 | + * @deprecated |
|
59 | + */ |
|
60 | + const state_question_id = 7; |
|
61 | + |
|
62 | + |
|
63 | + /** |
|
64 | + * @deprecated |
|
65 | + */ |
|
66 | + const country_question_id = 8; |
|
67 | + |
|
68 | + |
|
69 | + /** |
|
70 | + * @deprecated |
|
71 | + */ |
|
72 | + const zip_question_id = 9; |
|
73 | + |
|
74 | + |
|
75 | + /** |
|
76 | + * @deprecated |
|
77 | + */ |
|
78 | + const phone_question_id = 10; |
|
79 | + |
|
80 | + /** |
|
81 | + * When looking for questions that correspond to attendee fields, |
|
82 | + * look for the question with this QST_system value. |
|
83 | + * These replace the old constants like EEM_Attendee::*_question_id |
|
84 | + */ |
|
85 | + const system_question_fname = 'fname'; |
|
86 | + |
|
87 | + const system_question_lname = 'lname'; |
|
88 | + |
|
89 | + const system_question_email = 'email'; |
|
90 | + |
|
91 | + const system_question_email_confirm = 'email_confirm'; |
|
92 | + |
|
93 | + const system_question_address = 'address'; |
|
94 | + |
|
95 | + const system_question_address2 = 'address2'; |
|
96 | + |
|
97 | + const system_question_city = 'city'; |
|
98 | + |
|
99 | + const system_question_state = 'state'; |
|
100 | + |
|
101 | + const system_question_country = 'country'; |
|
102 | + |
|
103 | + const system_question_zip = 'zip'; |
|
104 | + |
|
105 | + const system_question_phone = 'phone'; |
|
106 | + |
|
107 | + /** |
|
108 | + * Keys are all the EEM_Attendee::system_question_* constants, which are |
|
109 | + * also all the values of QST_system in the questions table, and values |
|
110 | + * are their corresponding Attendee field names |
|
111 | + * |
|
112 | + * @var array |
|
113 | + */ |
|
114 | + protected $_system_question_to_attendee_field_name = array( |
|
115 | + EEM_Attendee::system_question_fname => 'ATT_fname', |
|
116 | + EEM_Attendee::system_question_lname => 'ATT_lname', |
|
117 | + EEM_Attendee::system_question_email => 'ATT_email', |
|
118 | + EEM_Attendee::system_question_address => 'ATT_address', |
|
119 | + EEM_Attendee::system_question_address2 => 'ATT_address2', |
|
120 | + EEM_Attendee::system_question_city => 'ATT_city', |
|
121 | + EEM_Attendee::system_question_state => 'STA_ID', |
|
122 | + EEM_Attendee::system_question_country => 'CNT_ISO', |
|
123 | + EEM_Attendee::system_question_zip => 'ATT_zip', |
|
124 | + EEM_Attendee::system_question_phone => 'ATT_phone', |
|
125 | + ); |
|
126 | + |
|
127 | + |
|
128 | + |
|
129 | + /** |
|
130 | + * EEM_Attendee constructor. |
|
131 | + * |
|
132 | + * @param null $timezone |
|
133 | + * @param ModelFieldFactory $model_field_factory |
|
134 | + * @throws EE_Error |
|
135 | + * @throws InvalidArgumentException |
|
136 | + */ |
|
137 | + protected function __construct($timezone = null, ModelFieldFactory $model_field_factory) |
|
138 | + { |
|
139 | + $this->singular_item = esc_html__('Attendee', 'event_espresso'); |
|
140 | + $this->plural_item = esc_html__('Attendees', 'event_espresso'); |
|
141 | + $this->_tables = array( |
|
142 | + 'Attendee_CPT' => new EE_Primary_Table('posts', 'ID'), |
|
143 | + 'Attendee_Meta' => new EE_Secondary_Table( |
|
144 | + 'esp_attendee_meta', |
|
145 | + 'ATTM_ID', |
|
146 | + 'ATT_ID' |
|
147 | + ), |
|
148 | + ); |
|
149 | + $this->_fields = array( |
|
150 | + 'Attendee_CPT' => array( |
|
151 | + 'ATT_ID' => $model_field_factory->createPrimaryKeyIntField( |
|
152 | + 'ID', |
|
153 | + esc_html__('Attendee ID', 'event_espresso') |
|
154 | + ), |
|
155 | + 'ATT_full_name' => $model_field_factory->createPlainTextField( |
|
156 | + 'post_title', |
|
157 | + esc_html__('Attendee Full Name', 'event_espresso'), |
|
158 | + false, |
|
159 | + esc_html__('Unknown', 'event_espresso') |
|
160 | + ), |
|
161 | + 'ATT_bio' => $model_field_factory->createPostContentField( |
|
162 | + 'post_content', |
|
163 | + esc_html__('Attendee Biography', 'event_espresso'), |
|
164 | + false, |
|
165 | + esc_html__('No Biography Provided', 'event_espresso') |
|
166 | + ), |
|
167 | + 'ATT_slug' => $model_field_factory->createSlugField( |
|
168 | + 'post_name', |
|
169 | + esc_html__('Attendee URL Slug', 'event_espresso') |
|
170 | + ), |
|
171 | + 'ATT_created' => $model_field_factory->createDatetimeField( |
|
172 | + 'post_date', |
|
173 | + esc_html__('Time Attendee Created', 'event_espresso') |
|
174 | + ), |
|
175 | + 'ATT_short_bio' => $model_field_factory->createSimpleHtmlField( |
|
176 | + 'post_excerpt', |
|
177 | + esc_html__('Attendee Short Biography', 'event_espresso'), |
|
178 | + true, |
|
179 | + esc_html__('No Biography Provided', 'event_espresso') |
|
180 | + ), |
|
181 | + 'ATT_modified' => $model_field_factory->createDatetimeField( |
|
182 | + 'post_modified', |
|
183 | + esc_html__('Time Attendee Last Modified', 'event_espresso') |
|
184 | + ), |
|
185 | + 'ATT_author' => $model_field_factory->createWpUserField( |
|
186 | + 'post_author', |
|
187 | + esc_html__('Creator ID of the first Event attended', 'event_espresso'), |
|
188 | + false |
|
189 | + ), |
|
190 | + 'ATT_parent' => $model_field_factory->createDbOnlyIntField( |
|
191 | + 'post_parent', |
|
192 | + esc_html__('Parent Attendee (unused)', 'event_espresso'), |
|
193 | + false, |
|
194 | + 0 |
|
195 | + ), |
|
196 | + 'post_type' => $model_field_factory->createWpPostTypeField('espresso_attendees'), |
|
197 | + 'status' => $model_field_factory->createWpPostStatusField( |
|
198 | + 'post_status', |
|
199 | + esc_html__('Attendee Status', 'event_espresso'), |
|
200 | + false, |
|
201 | + 'publish' |
|
202 | + ), |
|
203 | + 'password' => new EE_Password_Field( |
|
204 | + 'post_password', |
|
205 | + __('Password', 'event_espresso'), |
|
206 | + false, |
|
207 | + '', |
|
208 | + array( |
|
209 | + 'ATT_bio', |
|
210 | + 'ATT_short_bio', |
|
211 | + 'ATT_address', |
|
212 | + 'ATT_address2', |
|
213 | + 'ATT_city', |
|
214 | + 'STA_ID', |
|
215 | + 'CNT_ISO', |
|
216 | + 'ATT_zip', |
|
217 | + 'ATT_email', |
|
218 | + 'ATT_phone' |
|
219 | + ) |
|
220 | + ) |
|
221 | + ), |
|
222 | + 'Attendee_Meta' => array( |
|
223 | + 'ATTM_ID' => $model_field_factory->createDbOnlyIntField( |
|
224 | + 'ATTM_ID', |
|
225 | + esc_html__('Attendee Meta Row ID', 'event_espresso'), |
|
226 | + false |
|
227 | + ), |
|
228 | + 'ATT_ID_fk' => $model_field_factory->createDbOnlyIntField( |
|
229 | + 'ATT_ID', |
|
230 | + esc_html__('Foreign Key to Attendee in Post Table', 'event_espresso'), |
|
231 | + false |
|
232 | + ), |
|
233 | + 'ATT_fname' => $model_field_factory->createPlainTextField( |
|
234 | + 'ATT_fname', |
|
235 | + esc_html__('First Name', 'event_espresso') |
|
236 | + ), |
|
237 | + 'ATT_lname' => $model_field_factory->createPlainTextField( |
|
238 | + 'ATT_lname', |
|
239 | + esc_html__('Last Name', 'event_espresso') |
|
240 | + ), |
|
241 | + 'ATT_address' => $model_field_factory->createPlainTextField( |
|
242 | + 'ATT_address', |
|
243 | + esc_html__('Address Part 1', 'event_espresso') |
|
244 | + ), |
|
245 | + 'ATT_address2' => $model_field_factory->createPlainTextField( |
|
246 | + 'ATT_address2', |
|
247 | + esc_html__('Address Part 2', 'event_espresso') |
|
248 | + ), |
|
249 | + 'ATT_city' => $model_field_factory->createPlainTextField( |
|
250 | + 'ATT_city', |
|
251 | + esc_html__('City', 'event_espresso') |
|
252 | + ), |
|
253 | + 'STA_ID' => $model_field_factory->createForeignKeyIntField( |
|
254 | + 'STA_ID', |
|
255 | + esc_html__('State', 'event_espresso'), |
|
256 | + true, |
|
257 | + 0, |
|
258 | + 'State' |
|
259 | + ), |
|
260 | + 'CNT_ISO' => $model_field_factory->createForeignKeyStringField( |
|
261 | + 'CNT_ISO', |
|
262 | + esc_html__('Country', 'event_espresso'), |
|
263 | + true, |
|
264 | + '', |
|
265 | + 'Country' |
|
266 | + ), |
|
267 | + 'ATT_zip' => $model_field_factory->createPlainTextField( |
|
268 | + 'ATT_zip', |
|
269 | + esc_html__('ZIP/Postal Code', 'event_espresso') |
|
270 | + ), |
|
271 | + 'ATT_email' => $model_field_factory->createEmailField( |
|
272 | + 'ATT_email', |
|
273 | + esc_html__('Email Address', 'event_espresso') |
|
274 | + ), |
|
275 | + 'ATT_phone' => $model_field_factory->createPlainTextField( |
|
276 | + 'ATT_phone', |
|
277 | + esc_html__('Phone', 'event_espresso') |
|
278 | + ), |
|
279 | + ), |
|
280 | + ); |
|
281 | + $this->_model_relations = array( |
|
282 | + 'Registration' => new EE_Has_Many_Relation(), |
|
283 | + 'State' => new EE_Belongs_To_Relation(), |
|
284 | + 'Country' => new EE_Belongs_To_Relation(), |
|
285 | + 'Event' => new EE_HABTM_Relation('Registration', false), |
|
286 | + 'WP_User' => new EE_Belongs_To_Relation(), |
|
287 | + 'Message' => new EE_Has_Many_Any_Relation(false), |
|
288 | + // allow deletion of attendees even if they have messages in the queue for them. |
|
289 | + 'Term_Relationship' => new EE_Has_Many_Relation(), |
|
290 | + 'Term_Taxonomy' => new EE_HABTM_Relation('Term_Relationship'), |
|
291 | + ); |
|
292 | + $this->_caps_slug = 'contacts'; |
|
293 | + $this->model_chain_to_password = ''; |
|
294 | + parent::__construct($timezone); |
|
295 | + } |
|
296 | + |
|
297 | + |
|
298 | + |
|
299 | + /** |
|
300 | + * Gets the name of the field on the attendee model corresponding to the system question string |
|
301 | + * which should be one of the keys from EEM_Attendee::_system_question_to_attendee_field_name |
|
302 | + * |
|
303 | + * @param string $system_question_string |
|
304 | + * @return string|null if not found |
|
305 | + */ |
|
306 | + public function get_attendee_field_for_system_question($system_question_string) |
|
307 | + { |
|
308 | + return isset($this->_system_question_to_attendee_field_name[ $system_question_string ]) |
|
309 | + ? $this->_system_question_to_attendee_field_name[ $system_question_string ] |
|
310 | + : null; |
|
311 | + } |
|
312 | + |
|
313 | + |
|
314 | + |
|
315 | + /** |
|
316 | + * Gets mapping from esp_question.QST_system values to their corresponding attendee field names |
|
317 | + * |
|
318 | + * @return array |
|
319 | + */ |
|
320 | + public function system_question_to_attendee_field_mapping() |
|
321 | + { |
|
322 | + return $this->_system_question_to_attendee_field_name; |
|
323 | + } |
|
324 | + |
|
325 | + |
|
326 | + |
|
327 | + /** |
|
328 | + * Gets all the attendees for a transaction (by using the esp_registration as a join table) |
|
329 | + * |
|
330 | + * @param EE_Transaction /int $transaction_id_or_obj EE_Transaction or its ID |
|
331 | + * @return EE_Attendee[]|EE_Base_Class[] |
|
332 | + * @throws EE_Error |
|
333 | + */ |
|
334 | + public function get_attendees_for_transaction($transaction_id_or_obj) |
|
335 | + { |
|
336 | + return $this->get_all( |
|
337 | + array( |
|
338 | + array( |
|
339 | + 'Registration.Transaction.TXN_ID' => $transaction_id_or_obj instanceof EE_Transaction |
|
340 | + ? $transaction_id_or_obj->ID() |
|
341 | + : $transaction_id_or_obj, |
|
342 | + ), |
|
343 | + ) |
|
344 | + ); |
|
345 | + } |
|
346 | + |
|
347 | + |
|
348 | + |
|
349 | + /** |
|
350 | + * retrieve a single attendee from db via their ID |
|
351 | + * |
|
352 | + * @param $ATT_ID |
|
353 | + * @return mixed array on success, FALSE on fail |
|
354 | + * @deprecated |
|
355 | + */ |
|
356 | + public function get_attendee_by_ID($ATT_ID = false) |
|
357 | + { |
|
358 | + // retrieve a particular EE_Attendee |
|
359 | + return $this->get_one_by_ID($ATT_ID); |
|
360 | + } |
|
361 | + |
|
362 | + |
|
363 | + |
|
364 | + /** |
|
365 | + * retrieve a single attendee from db via their ID |
|
366 | + * |
|
367 | + * @param array $where_cols_n_values |
|
368 | + * @return mixed array on success, FALSE on fail |
|
369 | + * @throws EE_Error |
|
370 | + */ |
|
371 | + public function get_attendee($where_cols_n_values = array()) |
|
372 | + { |
|
373 | + if (empty($where_cols_n_values)) { |
|
374 | + return false; |
|
375 | + } |
|
376 | + $attendee = $this->get_all(array($where_cols_n_values)); |
|
377 | + if (! empty($attendee)) { |
|
378 | + return array_shift($attendee); |
|
379 | + } |
|
380 | + return false; |
|
381 | + } |
|
382 | + |
|
383 | + |
|
384 | + |
|
385 | + /** |
|
386 | + * Search for an existing Attendee record in the DB |
|
387 | + * |
|
388 | + * @param array $where_cols_n_values |
|
389 | + * @return bool|mixed |
|
390 | + * @throws EE_Error |
|
391 | + */ |
|
392 | + public function find_existing_attendee($where_cols_n_values = null) |
|
393 | + { |
|
394 | + // search by combo of first and last names plus the email address |
|
395 | + $attendee_data_keys = array( |
|
396 | + 'ATT_fname' => $this->_ATT_fname, |
|
397 | + 'ATT_lname' => $this->_ATT_lname, |
|
398 | + 'ATT_email' => $this->_ATT_email, |
|
399 | + ); |
|
400 | + // no search params means attendee object already exists. |
|
401 | + $where_cols_n_values = is_array($where_cols_n_values) && ! empty($where_cols_n_values) |
|
402 | + ? $where_cols_n_values |
|
403 | + : $attendee_data_keys; |
|
404 | + $valid_data = true; |
|
405 | + // check for required values |
|
406 | + $valid_data = isset($where_cols_n_values['ATT_fname']) && ! empty($where_cols_n_values['ATT_fname']) |
|
407 | + ? $valid_data |
|
408 | + : false; |
|
409 | + $valid_data = isset($where_cols_n_values['ATT_lname']) && ! empty($where_cols_n_values['ATT_lname']) |
|
410 | + ? $valid_data |
|
411 | + : false; |
|
412 | + $valid_data = isset($where_cols_n_values['ATT_email']) && ! empty($where_cols_n_values['ATT_email']) |
|
413 | + ? $valid_data |
|
414 | + : false; |
|
415 | + if ($valid_data) { |
|
416 | + $attendee = $this->get_attendee($where_cols_n_values); |
|
417 | + if ($attendee instanceof EE_Attendee) { |
|
418 | + return $attendee; |
|
419 | + } |
|
420 | + } |
|
421 | + return false; |
|
422 | + } |
|
423 | + |
|
424 | + |
|
425 | + |
|
426 | + /** |
|
427 | + * Takes an incoming array of EE_Registration ids |
|
428 | + * and sends back a list of corresponding non duplicate EE_Attendee objects. |
|
429 | + * |
|
430 | + * @since 4.3.0 |
|
431 | + * @param array $ids array of EE_Registration ids |
|
432 | + * @return EE_Attendee[]|EE_Base_Class[] |
|
433 | + * @throws EE_Error |
|
434 | + */ |
|
435 | + public function get_array_of_contacts_from_reg_ids($ids) |
|
436 | + { |
|
437 | + $ids = (array) $ids; |
|
438 | + $_where = array( |
|
439 | + 'Registration.REG_ID' => array('in', $ids), |
|
440 | + ); |
|
441 | + return $this->get_all(array($_where)); |
|
442 | + } |
|
443 | 443 | } |
@@ -456,7 +456,7 @@ |
||
456 | 456 | * be empty |
457 | 457 | * |
458 | 458 | * @since 4.3.1 |
459 | - * @return array |
|
459 | + * @return string[] |
|
460 | 460 | */ |
461 | 461 | private function _parse_from() |
462 | 462 | { |
@@ -56,7 +56,7 @@ discard block |
||
56 | 56 | ), |
57 | 57 | '<code>wp_mail</code>' |
58 | 58 | ); |
59 | - $this->label = array( |
|
59 | + $this->label = array( |
|
60 | 60 | 'singular' => esc_html__('email', 'event_espresso'), |
61 | 61 | 'plural' => esc_html__('emails', 'event_espresso'), |
62 | 62 | ); |
@@ -438,7 +438,7 @@ discard block |
||
438 | 438 | $this->_body(), |
439 | 439 | $this->_headers() |
440 | 440 | ); |
441 | - if (! $success) { |
|
441 | + if ( ! $success) { |
|
442 | 442 | EE_Error::add_error( |
443 | 443 | sprintf( |
444 | 444 | esc_html__( |
@@ -482,8 +482,8 @@ discard block |
||
482 | 482 | $this->_ensure_has_from_email_address(); |
483 | 483 | $from = $this->_from; |
484 | 484 | $headers = array( |
485 | - 'From:' . $from, |
|
486 | - 'Reply-To:' . $from, |
|
485 | + 'From:'.$from, |
|
486 | + 'Reply-To:'.$from, |
|
487 | 487 | 'Content-Type:text/html; charset=utf-8', |
488 | 488 | ); |
489 | 489 | |
@@ -492,8 +492,8 @@ discard block |
||
492 | 492 | * cover back compat where there may be users who have saved cc values in their db for the newsletter message |
493 | 493 | * type which they are no longer able to change. |
494 | 494 | */ |
495 | - if (! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) { |
|
496 | - $headers[] = 'cc: ' . $this->_cc; |
|
495 | + if ( ! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) { |
|
496 | + $headers[] = 'cc: '.$this->_cc; |
|
497 | 497 | } |
498 | 498 | |
499 | 499 | // but wait! Header's for the from is NOT reliable because some plugins don't respect From: as set in the |
@@ -600,7 +600,7 @@ discard block |
||
600 | 600 | 'from' => $this->_from, |
601 | 601 | 'main_body' => wpautop($this->_content), |
602 | 602 | ); |
603 | - $body = $this->_get_main_template($preview); |
|
603 | + $body = $this->_get_main_template($preview); |
|
604 | 604 | |
605 | 605 | /** |
606 | 606 | * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched. |
@@ -610,10 +610,10 @@ discard block |
||
610 | 610 | */ |
611 | 611 | if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) { |
612 | 612 | // require CssToInlineStyles library and its dependencies via composer autoloader |
613 | - require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php'; |
|
613 | + require_once EE_THIRD_PARTY.'cssinliner/vendor/autoload.php'; |
|
614 | 614 | |
615 | 615 | // now if this isn't a preview, let's setup the body so it has inline styles |
616 | - if (! $preview || ($preview && defined('DOING_AJAX'))) { |
|
616 | + if ( ! $preview || ($preview && defined('DOING_AJAX'))) { |
|
617 | 617 | $style = file_get_contents( |
618 | 618 | $this->get_variation( |
619 | 619 | $this->_tmp_pack, |
@@ -6,648 +6,648 @@ |
||
6 | 6 | class EE_Email_messenger extends EE_messenger |
7 | 7 | { |
8 | 8 | |
9 | - /** |
|
10 | - * To field for email |
|
11 | - * @var string |
|
12 | - */ |
|
13 | - protected $_to = ''; |
|
14 | - |
|
15 | - |
|
16 | - /** |
|
17 | - * CC field for email. |
|
18 | - * @var string |
|
19 | - */ |
|
20 | - protected $_cc = ''; |
|
21 | - |
|
22 | - /** |
|
23 | - * From field for email |
|
24 | - * @var string |
|
25 | - */ |
|
26 | - protected $_from = ''; |
|
27 | - |
|
28 | - |
|
29 | - /** |
|
30 | - * Subject field for email |
|
31 | - * @var string |
|
32 | - */ |
|
33 | - protected $_subject = ''; |
|
34 | - |
|
35 | - |
|
36 | - /** |
|
37 | - * Content field for email |
|
38 | - * @var string |
|
39 | - */ |
|
40 | - protected $_content = ''; |
|
41 | - |
|
42 | - |
|
43 | - /** |
|
44 | - * constructor |
|
45 | - * |
|
46 | - * @access public |
|
47 | - */ |
|
48 | - public function __construct() |
|
49 | - { |
|
50 | - // set name and description properties |
|
51 | - $this->name = 'email'; |
|
52 | - $this->description = sprintf( |
|
53 | - esc_html__( |
|
54 | - 'This messenger delivers messages via email using the built-in %s function included with WordPress', |
|
55 | - 'event_espresso' |
|
56 | - ), |
|
57 | - '<code>wp_mail</code>' |
|
58 | - ); |
|
59 | - $this->label = array( |
|
60 | - 'singular' => esc_html__('email', 'event_espresso'), |
|
61 | - 'plural' => esc_html__('emails', 'event_espresso'), |
|
62 | - ); |
|
63 | - $this->activate_on_install = true; |
|
64 | - |
|
65 | - // we're using defaults so let's call parent constructor that will take care of setting up all the other |
|
66 | - // properties |
|
67 | - parent::__construct(); |
|
68 | - } |
|
69 | - |
|
70 | - |
|
71 | - /** |
|
72 | - * see abstract declaration in parent class for details. |
|
73 | - */ |
|
74 | - protected function _set_admin_pages() |
|
75 | - { |
|
76 | - $this->admin_registered_pages = array( |
|
77 | - 'events_edit' => true, |
|
78 | - ); |
|
79 | - } |
|
80 | - |
|
81 | - |
|
82 | - /** |
|
83 | - * see abstract declaration in parent class for details |
|
84 | - */ |
|
85 | - protected function _set_valid_shortcodes() |
|
86 | - { |
|
87 | - // remember by leaving the other fields not set, those fields will inherit the valid shortcodes from the |
|
88 | - // message type. |
|
89 | - $this->_valid_shortcodes = array( |
|
90 | - 'to' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'), |
|
91 | - 'cc' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'), |
|
92 | - 'from' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'), |
|
93 | - ); |
|
94 | - } |
|
95 | - |
|
96 | - |
|
97 | - /** |
|
98 | - * see abstract declaration in parent class for details |
|
99 | - * |
|
100 | - * @access protected |
|
101 | - * @return void |
|
102 | - */ |
|
103 | - protected function _set_validator_config() |
|
104 | - { |
|
105 | - $valid_shortcodes = $this->get_valid_shortcodes(); |
|
106 | - |
|
107 | - $this->_validator_config = array( |
|
108 | - 'to' => array( |
|
109 | - 'shortcodes' => $valid_shortcodes['to'], |
|
110 | - 'type' => 'email', |
|
111 | - ), |
|
112 | - 'cc' => array( |
|
113 | - 'shortcodes' => $valid_shortcodes['to'], |
|
114 | - 'type' => 'email', |
|
115 | - ), |
|
116 | - 'from' => array( |
|
117 | - 'shortcodes' => $valid_shortcodes['from'], |
|
118 | - 'type' => 'email', |
|
119 | - ), |
|
120 | - 'subject' => array( |
|
121 | - 'shortcodes' => array( |
|
122 | - 'organization', |
|
123 | - 'primary_registration_details', |
|
124 | - 'event_author', |
|
125 | - 'primary_registration_details', |
|
126 | - 'recipient_details', |
|
127 | - ), |
|
128 | - ), |
|
129 | - 'content' => array( |
|
130 | - 'shortcodes' => array( |
|
131 | - 'event_list', |
|
132 | - 'attendee_list', |
|
133 | - 'ticket_list', |
|
134 | - 'organization', |
|
135 | - 'primary_registration_details', |
|
136 | - 'primary_registration_list', |
|
137 | - 'event_author', |
|
138 | - 'recipient_details', |
|
139 | - 'recipient_list', |
|
140 | - 'transaction', |
|
141 | - 'messenger', |
|
142 | - ), |
|
143 | - ), |
|
144 | - 'attendee_list' => array( |
|
145 | - 'shortcodes' => array('attendee', 'event_list', 'ticket_list'), |
|
146 | - 'required' => array('[ATTENDEE_LIST]'), |
|
147 | - ), |
|
148 | - 'event_list' => array( |
|
149 | - 'shortcodes' => array( |
|
150 | - 'event', |
|
151 | - 'attendee_list', |
|
152 | - 'ticket_list', |
|
153 | - 'venue', |
|
154 | - 'datetime_list', |
|
155 | - 'attendee', |
|
156 | - 'primary_registration_details', |
|
157 | - 'primary_registration_list', |
|
158 | - 'event_author', |
|
159 | - 'recipient_details', |
|
160 | - 'recipient_list', |
|
161 | - ), |
|
162 | - 'required' => array('[EVENT_LIST]'), |
|
163 | - ), |
|
164 | - 'ticket_list' => array( |
|
165 | - 'shortcodes' => array( |
|
166 | - 'event_list', |
|
167 | - 'attendee_list', |
|
168 | - 'ticket', |
|
169 | - 'datetime_list', |
|
170 | - 'primary_registration_details', |
|
171 | - 'recipient_details', |
|
172 | - ), |
|
173 | - 'required' => array('[TICKET_LIST]'), |
|
174 | - ), |
|
175 | - 'datetime_list' => array( |
|
176 | - 'shortcodes' => array('datetime'), |
|
177 | - 'required' => array('[DATETIME_LIST]'), |
|
178 | - ), |
|
179 | - ); |
|
180 | - } |
|
181 | - |
|
182 | - |
|
183 | - /** |
|
184 | - * @see parent EE_messenger class for docs |
|
185 | - * @since 4.5.0 |
|
186 | - */ |
|
187 | - public function do_secondary_messenger_hooks($sending_messenger_name) |
|
188 | - { |
|
189 | - if ($sending_messenger_name === 'html') { |
|
190 | - add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8); |
|
191 | - } |
|
192 | - } |
|
193 | - |
|
194 | - |
|
195 | - public function add_email_css( |
|
196 | - $variation_path, |
|
197 | - $messenger, |
|
198 | - $message_type, |
|
199 | - $type, |
|
200 | - $variation, |
|
201 | - $file_extension, |
|
202 | - $url, |
|
203 | - EE_Messages_Template_Pack $template_pack |
|
204 | - ) { |
|
205 | - // prevent recursion on this callback. |
|
206 | - remove_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10); |
|
207 | - $variation = $this->get_variation($template_pack, $message_type, $url, 'main', $variation, false); |
|
208 | - |
|
209 | - add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8); |
|
210 | - return $variation; |
|
211 | - } |
|
212 | - |
|
213 | - |
|
214 | - /** |
|
215 | - * See parent for details |
|
216 | - * |
|
217 | - * @access protected |
|
218 | - * @return void |
|
219 | - */ |
|
220 | - protected function _set_test_settings_fields() |
|
221 | - { |
|
222 | - $this->_test_settings_fields = array( |
|
223 | - 'to' => array( |
|
224 | - 'input' => 'text', |
|
225 | - 'label' => esc_html__('Send a test email to', 'event_espresso'), |
|
226 | - 'type' => 'email', |
|
227 | - 'required' => true, |
|
228 | - 'validation' => true, |
|
229 | - 'css_class' => 'large-text', |
|
230 | - 'format' => '%s', |
|
231 | - 'default' => get_bloginfo('admin_email'), |
|
232 | - ), |
|
233 | - 'subject' => array( |
|
234 | - 'input' => 'hidden', |
|
235 | - 'label' => '', |
|
236 | - 'type' => 'string', |
|
237 | - 'required' => false, |
|
238 | - 'validation' => false, |
|
239 | - 'format' => '%s', |
|
240 | - 'value' => sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')), |
|
241 | - 'default' => '', |
|
242 | - 'css_class' => '', |
|
243 | - ), |
|
244 | - ); |
|
245 | - } |
|
246 | - |
|
247 | - |
|
248 | - /** |
|
249 | - * _set_template_fields |
|
250 | - * This sets up the fields that a messenger requires for the message to go out. |
|
251 | - * |
|
252 | - * @access protected |
|
253 | - * @return void |
|
254 | - */ |
|
255 | - protected function _set_template_fields() |
|
256 | - { |
|
257 | - // any extra template fields that are NOT used by the messenger but will get used by a messenger field for |
|
258 | - // shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field |
|
259 | - // they relate to. This is important for the Messages_admin to know what fields to display to the user. |
|
260 | - // Also, notice that the "values" are equal to the field type that messages admin will use to know what |
|
261 | - // kind of field to display. The values ALSO have one index labeled "shortcode". the values in that array |
|
262 | - // indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be |
|
263 | - // displayed. If the required shortcode isn't part of the shortcodes array then the field is not needed and |
|
264 | - // will not be displayed/parsed. |
|
265 | - $this->_template_fields = array( |
|
266 | - 'to' => array( |
|
267 | - 'input' => 'text', |
|
268 | - 'label' => esc_html_x( |
|
269 | - 'To', |
|
270 | - 'Label for the "To" field for email addresses', |
|
271 | - 'event_espresso' |
|
272 | - ), |
|
273 | - 'type' => 'string', |
|
274 | - 'required' => true, |
|
275 | - 'validation' => true, |
|
276 | - 'css_class' => 'large-text', |
|
277 | - 'format' => '%s', |
|
278 | - ), |
|
279 | - 'cc' => array( |
|
280 | - 'input' => 'text', |
|
281 | - 'label' => esc_html_x( |
|
282 | - 'CC', |
|
283 | - 'Label for the "Carbon Copy" field used for additional email addresses', |
|
284 | - 'event_espresso' |
|
285 | - ), |
|
286 | - 'type' => 'string', |
|
287 | - 'required' => false, |
|
288 | - 'validation' => true, |
|
289 | - 'css_class' => 'large-text', |
|
290 | - 'format' => '%s', |
|
291 | - ), |
|
292 | - 'from' => array( |
|
293 | - 'input' => 'text', |
|
294 | - 'label' => esc_html_x( |
|
295 | - 'From', |
|
296 | - 'Label for the "From" field for email addresses.', |
|
297 | - 'event_espresso' |
|
298 | - ), |
|
299 | - 'type' => 'string', |
|
300 | - 'required' => true, |
|
301 | - 'validation' => true, |
|
302 | - 'css_class' => 'large-text', |
|
303 | - 'format' => '%s', |
|
304 | - ), |
|
305 | - 'subject' => array( |
|
306 | - 'input' => 'text', |
|
307 | - 'label' => esc_html_x( |
|
308 | - 'Subject', |
|
309 | - 'Label for the "Subject" field (short description of contents) for emails.', |
|
310 | - 'event_espresso' |
|
311 | - ), |
|
312 | - 'type' => 'string', |
|
313 | - 'required' => true, |
|
314 | - 'validation' => true, |
|
315 | - 'css_class' => 'large-text', |
|
316 | - 'format' => '%s', |
|
317 | - ), |
|
318 | - 'content' => '', |
|
319 | - // left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field. |
|
320 | - 'extra' => array( |
|
321 | - 'content' => array( |
|
322 | - 'main' => array( |
|
323 | - 'input' => 'wp_editor', |
|
324 | - 'label' => esc_html__('Main Content', 'event_espresso'), |
|
325 | - 'type' => 'string', |
|
326 | - 'required' => true, |
|
327 | - 'validation' => true, |
|
328 | - 'format' => '%s', |
|
329 | - 'rows' => '15', |
|
330 | - ), |
|
331 | - 'event_list' => array( |
|
332 | - 'input' => 'wp_editor', |
|
333 | - 'label' => '[EVENT_LIST]', |
|
334 | - 'type' => 'string', |
|
335 | - 'required' => true, |
|
336 | - 'validation' => true, |
|
337 | - 'format' => '%s', |
|
338 | - 'rows' => '15', |
|
339 | - 'shortcodes_required' => array('[EVENT_LIST]'), |
|
340 | - ), |
|
341 | - 'attendee_list' => array( |
|
342 | - 'input' => 'textarea', |
|
343 | - 'label' => '[ATTENDEE_LIST]', |
|
344 | - 'type' => 'string', |
|
345 | - 'required' => true, |
|
346 | - 'validation' => true, |
|
347 | - 'format' => '%s', |
|
348 | - 'css_class' => 'large-text', |
|
349 | - 'rows' => '5', |
|
350 | - 'shortcodes_required' => array('[ATTENDEE_LIST]'), |
|
351 | - ), |
|
352 | - 'ticket_list' => array( |
|
353 | - 'input' => 'textarea', |
|
354 | - 'label' => '[TICKET_LIST]', |
|
355 | - 'type' => 'string', |
|
356 | - 'required' => true, |
|
357 | - 'validation' => true, |
|
358 | - 'format' => '%s', |
|
359 | - 'css_class' => 'large-text', |
|
360 | - 'rows' => '10', |
|
361 | - 'shortcodes_required' => array('[TICKET_LIST]'), |
|
362 | - ), |
|
363 | - 'datetime_list' => array( |
|
364 | - 'input' => 'textarea', |
|
365 | - 'label' => '[DATETIME_LIST]', |
|
366 | - 'type' => 'string', |
|
367 | - 'required' => true, |
|
368 | - 'validation' => true, |
|
369 | - 'format' => '%s', |
|
370 | - 'css_class' => 'large-text', |
|
371 | - 'rows' => '10', |
|
372 | - 'shortcodes_required' => array('[DATETIME_LIST]'), |
|
373 | - ), |
|
374 | - ), |
|
375 | - ), |
|
376 | - ); |
|
377 | - } |
|
378 | - |
|
379 | - |
|
380 | - /** |
|
381 | - * See definition of this class in parent |
|
382 | - */ |
|
383 | - protected function _set_default_message_types() |
|
384 | - { |
|
385 | - $this->_default_message_types = array( |
|
386 | - 'payment', |
|
387 | - 'payment_refund', |
|
388 | - 'registration', |
|
389 | - 'not_approved_registration', |
|
390 | - 'pending_approval', |
|
391 | - ); |
|
392 | - } |
|
393 | - |
|
394 | - |
|
395 | - /** |
|
396 | - * @see definition of this class in parent |
|
397 | - * @since 4.5.0 |
|
398 | - */ |
|
399 | - protected function _set_valid_message_types() |
|
400 | - { |
|
401 | - $this->_valid_message_types = array( |
|
402 | - 'payment', |
|
403 | - 'registration', |
|
404 | - 'not_approved_registration', |
|
405 | - 'declined_registration', |
|
406 | - 'cancelled_registration', |
|
407 | - 'pending_approval', |
|
408 | - 'registration_summary', |
|
409 | - 'payment_reminder', |
|
410 | - 'payment_declined', |
|
411 | - 'payment_refund', |
|
412 | - ); |
|
413 | - } |
|
414 | - |
|
415 | - |
|
416 | - /** |
|
417 | - * setting up admin_settings_fields for messenger. |
|
418 | - */ |
|
419 | - protected function _set_admin_settings_fields() |
|
420 | - { |
|
421 | - } |
|
422 | - |
|
423 | - /** |
|
424 | - * We just deliver the messages don't kill us!! |
|
425 | - * |
|
426 | - * @return bool|WP_Error true if message delivered, false if it didn't deliver OR bubble up any error object if |
|
427 | - * present. |
|
428 | - * @throws EE_Error |
|
429 | - * @throws \TijsVerkoyen\CssToInlineStyles\Exception |
|
430 | - */ |
|
431 | - protected function _send_message() |
|
432 | - { |
|
433 | - $success = wp_mail( |
|
434 | - $this->_to, |
|
435 | - // some old values for subject may be expecting HTML entities to be decoded in the subject |
|
436 | - // and subjects aren't interpreted as HTML, so there should be no HTML in them |
|
437 | - wp_strip_all_tags(wp_specialchars_decode($this->_subject, ENT_QUOTES)), |
|
438 | - $this->_body(), |
|
439 | - $this->_headers() |
|
440 | - ); |
|
441 | - if (! $success) { |
|
442 | - EE_Error::add_error( |
|
443 | - sprintf( |
|
444 | - esc_html__( |
|
445 | - 'The email did not send successfully.%3$sThe WordPress wp_mail function is used for sending mails but does not give any useful information when an email fails to send.%3$sIt is possible the "to" address (%1$s) or "from" address (%2$s) is invalid.%3$s', |
|
446 | - 'event_espresso' |
|
447 | - ), |
|
448 | - $this->_to, |
|
449 | - $this->_from, |
|
450 | - '<br />' |
|
451 | - ), |
|
452 | - __FILE__, |
|
453 | - __FUNCTION__, |
|
454 | - __LINE__ |
|
455 | - ); |
|
456 | - } |
|
457 | - return $success; |
|
458 | - } |
|
459 | - |
|
460 | - |
|
461 | - /** |
|
462 | - * see parent for definition |
|
463 | - * |
|
464 | - * @return string html body of the message content and the related css. |
|
465 | - * @throws EE_Error |
|
466 | - * @throws \TijsVerkoyen\CssToInlineStyles\Exception |
|
467 | - */ |
|
468 | - protected function _preview() |
|
469 | - { |
|
470 | - return $this->_body(true); |
|
471 | - } |
|
472 | - |
|
473 | - |
|
474 | - /** |
|
475 | - * Setup headers for email |
|
476 | - * |
|
477 | - * @access protected |
|
478 | - * @return string formatted header for email |
|
479 | - */ |
|
480 | - protected function _headers() |
|
481 | - { |
|
482 | - $this->_ensure_has_from_email_address(); |
|
483 | - $from = $this->_from; |
|
484 | - $headers = array( |
|
485 | - 'From:' . $from, |
|
486 | - 'Reply-To:' . $from, |
|
487 | - 'Content-Type:text/html; charset=utf-8', |
|
488 | - ); |
|
489 | - |
|
490 | - /** |
|
491 | - * Second condition added as a result of https://events.codebasehq.com/projects/event-espresso/tickets/11416 to |
|
492 | - * cover back compat where there may be users who have saved cc values in their db for the newsletter message |
|
493 | - * type which they are no longer able to change. |
|
494 | - */ |
|
495 | - if (! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) { |
|
496 | - $headers[] = 'cc: ' . $this->_cc; |
|
497 | - } |
|
498 | - |
|
499 | - // but wait! Header's for the from is NOT reliable because some plugins don't respect From: as set in the |
|
500 | - // header. |
|
501 | - add_filter('wp_mail_from', array($this, 'set_from_address'), 100); |
|
502 | - add_filter('wp_mail_from_name', array($this, 'set_from_name'), 100); |
|
503 | - return apply_filters('FHEE__EE_Email_messenger___headers', $headers, $this->_incoming_message_type, $this); |
|
504 | - } |
|
505 | - |
|
506 | - |
|
507 | - /** |
|
508 | - * This simply ensures that the from address is not empty. If it is, then we use whatever is set as the site email |
|
509 | - * address for the from address to avoid problems with sending emails. |
|
510 | - */ |
|
511 | - protected function _ensure_has_from_email_address() |
|
512 | - { |
|
513 | - if (empty($this->_from)) { |
|
514 | - $this->_from = get_bloginfo('admin_email'); |
|
515 | - } |
|
516 | - } |
|
517 | - |
|
518 | - |
|
519 | - /** |
|
520 | - * This simply parses whatever is set as the $_from address and determines if it is in the format {name} <{email}> |
|
521 | - * or just {email} and returns an array with the "from_name" and "from_email" as the values. Note from_name *MAY* |
|
522 | - * be empty |
|
523 | - * |
|
524 | - * @since 4.3.1 |
|
525 | - * @return array |
|
526 | - */ |
|
527 | - private function _parse_from() |
|
528 | - { |
|
529 | - if (strpos($this->_from, '<') !== false) { |
|
530 | - $from_name = substr($this->_from, 0, strpos($this->_from, '<') - 1); |
|
531 | - $from_name = str_replace('"', '', $from_name); |
|
532 | - $from_name = trim($from_name); |
|
533 | - |
|
534 | - $from_email = substr($this->_from, strpos($this->_from, '<') + 1); |
|
535 | - $from_email = str_replace('>', '', $from_email); |
|
536 | - $from_email = trim($from_email); |
|
537 | - } elseif (trim($this->_from) !== '') { |
|
538 | - $from_name = ''; |
|
539 | - $from_email = trim($this->_from); |
|
540 | - } else { |
|
541 | - $from_name = $from_email = ''; |
|
542 | - } |
|
543 | - return array($from_name, $from_email); |
|
544 | - } |
|
545 | - |
|
546 | - |
|
547 | - /** |
|
548 | - * Callback for the wp_mail_from filter. |
|
549 | - * |
|
550 | - * @since 4.3.1 |
|
551 | - * @param string $from_email What the original from_email is. |
|
552 | - * @return string |
|
553 | - */ |
|
554 | - public function set_from_address($from_email) |
|
555 | - { |
|
556 | - $parsed_from = $this->_parse_from(); |
|
557 | - // includes fallback if the parsing failed. |
|
558 | - $from_email = is_array($parsed_from) && ! empty($parsed_from[1]) |
|
559 | - ? $parsed_from[1] |
|
560 | - : get_bloginfo('admin_email'); |
|
561 | - return $from_email; |
|
562 | - } |
|
563 | - |
|
564 | - |
|
565 | - /** |
|
566 | - * Callback fro the wp_mail_from_name filter. |
|
567 | - * |
|
568 | - * @since 4.3.1 |
|
569 | - * @param string $from_name The original from_name. |
|
570 | - * @return string |
|
571 | - */ |
|
572 | - public function set_from_name($from_name) |
|
573 | - { |
|
574 | - $parsed_from = $this->_parse_from(); |
|
575 | - if (is_array($parsed_from) && ! empty($parsed_from[0])) { |
|
576 | - $from_name = $parsed_from[0]; |
|
577 | - } |
|
578 | - |
|
579 | - // if from name is "WordPress" let's sub in the site name instead (more friendly!) |
|
580 | - // but realize the default name is HTML entity-encoded |
|
581 | - $from_name = $from_name == 'WordPress' ? wp_specialchars_decode(get_bloginfo(), ENT_QUOTES) : $from_name; |
|
582 | - |
|
583 | - return $from_name; |
|
584 | - } |
|
585 | - |
|
586 | - |
|
587 | - /** |
|
588 | - * setup body for email |
|
589 | - * |
|
590 | - * @param bool $preview will determine whether this is preview template or not. |
|
591 | - * @return string formatted body for email. |
|
592 | - * @throws EE_Error |
|
593 | - * @throws \TijsVerkoyen\CssToInlineStyles\Exception |
|
594 | - */ |
|
595 | - protected function _body($preview = false) |
|
596 | - { |
|
597 | - // setup template args! |
|
598 | - $this->_template_args = array( |
|
599 | - 'subject' => $this->_subject, |
|
600 | - 'from' => $this->_from, |
|
601 | - 'main_body' => wpautop($this->_content), |
|
602 | - ); |
|
603 | - $body = $this->_get_main_template($preview); |
|
604 | - |
|
605 | - /** |
|
606 | - * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched. |
|
607 | - * |
|
608 | - * @type bool $preview Indicates whether a preview is being generated or not. |
|
609 | - * @return bool true indicates to use the inliner, false bypasses it. |
|
610 | - */ |
|
611 | - if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) { |
|
612 | - // require CssToInlineStyles library and its dependencies via composer autoloader |
|
613 | - require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php'; |
|
614 | - |
|
615 | - // now if this isn't a preview, let's setup the body so it has inline styles |
|
616 | - if (! $preview || ($preview && defined('DOING_AJAX'))) { |
|
617 | - $style = file_get_contents( |
|
618 | - $this->get_variation( |
|
619 | - $this->_tmp_pack, |
|
620 | - $this->_incoming_message_type->name, |
|
621 | - false, |
|
622 | - 'main', |
|
623 | - $this->_variation |
|
624 | - ), |
|
625 | - true |
|
626 | - ); |
|
627 | - $CSS = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles($body, $style); |
|
628 | - // for some reason the library has a bracket and new line at the beginning. This takes care of that. |
|
629 | - $body = ltrim($CSS->convert(true), ">\n"); |
|
630 | - // see https://events.codebasehq.com/projects/event-espresso/tickets/8609 |
|
631 | - $body = ltrim($body, "<?"); |
|
632 | - } |
|
633 | - } |
|
634 | - return $body; |
|
635 | - } |
|
636 | - |
|
637 | - |
|
638 | - /** |
|
639 | - * This just returns any existing test settings that might be saved in the database |
|
640 | - * |
|
641 | - * @access public |
|
642 | - * @return array |
|
643 | - */ |
|
644 | - public function get_existing_test_settings() |
|
645 | - { |
|
646 | - $settings = parent::get_existing_test_settings(); |
|
647 | - // override subject if present because we always want it to be fresh. |
|
648 | - if (is_array($settings) && ! empty($settings['subject'])) { |
|
649 | - $settings['subject'] = sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')); |
|
650 | - } |
|
651 | - return $settings; |
|
652 | - } |
|
9 | + /** |
|
10 | + * To field for email |
|
11 | + * @var string |
|
12 | + */ |
|
13 | + protected $_to = ''; |
|
14 | + |
|
15 | + |
|
16 | + /** |
|
17 | + * CC field for email. |
|
18 | + * @var string |
|
19 | + */ |
|
20 | + protected $_cc = ''; |
|
21 | + |
|
22 | + /** |
|
23 | + * From field for email |
|
24 | + * @var string |
|
25 | + */ |
|
26 | + protected $_from = ''; |
|
27 | + |
|
28 | + |
|
29 | + /** |
|
30 | + * Subject field for email |
|
31 | + * @var string |
|
32 | + */ |
|
33 | + protected $_subject = ''; |
|
34 | + |
|
35 | + |
|
36 | + /** |
|
37 | + * Content field for email |
|
38 | + * @var string |
|
39 | + */ |
|
40 | + protected $_content = ''; |
|
41 | + |
|
42 | + |
|
43 | + /** |
|
44 | + * constructor |
|
45 | + * |
|
46 | + * @access public |
|
47 | + */ |
|
48 | + public function __construct() |
|
49 | + { |
|
50 | + // set name and description properties |
|
51 | + $this->name = 'email'; |
|
52 | + $this->description = sprintf( |
|
53 | + esc_html__( |
|
54 | + 'This messenger delivers messages via email using the built-in %s function included with WordPress', |
|
55 | + 'event_espresso' |
|
56 | + ), |
|
57 | + '<code>wp_mail</code>' |
|
58 | + ); |
|
59 | + $this->label = array( |
|
60 | + 'singular' => esc_html__('email', 'event_espresso'), |
|
61 | + 'plural' => esc_html__('emails', 'event_espresso'), |
|
62 | + ); |
|
63 | + $this->activate_on_install = true; |
|
64 | + |
|
65 | + // we're using defaults so let's call parent constructor that will take care of setting up all the other |
|
66 | + // properties |
|
67 | + parent::__construct(); |
|
68 | + } |
|
69 | + |
|
70 | + |
|
71 | + /** |
|
72 | + * see abstract declaration in parent class for details. |
|
73 | + */ |
|
74 | + protected function _set_admin_pages() |
|
75 | + { |
|
76 | + $this->admin_registered_pages = array( |
|
77 | + 'events_edit' => true, |
|
78 | + ); |
|
79 | + } |
|
80 | + |
|
81 | + |
|
82 | + /** |
|
83 | + * see abstract declaration in parent class for details |
|
84 | + */ |
|
85 | + protected function _set_valid_shortcodes() |
|
86 | + { |
|
87 | + // remember by leaving the other fields not set, those fields will inherit the valid shortcodes from the |
|
88 | + // message type. |
|
89 | + $this->_valid_shortcodes = array( |
|
90 | + 'to' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'), |
|
91 | + 'cc' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'), |
|
92 | + 'from' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'), |
|
93 | + ); |
|
94 | + } |
|
95 | + |
|
96 | + |
|
97 | + /** |
|
98 | + * see abstract declaration in parent class for details |
|
99 | + * |
|
100 | + * @access protected |
|
101 | + * @return void |
|
102 | + */ |
|
103 | + protected function _set_validator_config() |
|
104 | + { |
|
105 | + $valid_shortcodes = $this->get_valid_shortcodes(); |
|
106 | + |
|
107 | + $this->_validator_config = array( |
|
108 | + 'to' => array( |
|
109 | + 'shortcodes' => $valid_shortcodes['to'], |
|
110 | + 'type' => 'email', |
|
111 | + ), |
|
112 | + 'cc' => array( |
|
113 | + 'shortcodes' => $valid_shortcodes['to'], |
|
114 | + 'type' => 'email', |
|
115 | + ), |
|
116 | + 'from' => array( |
|
117 | + 'shortcodes' => $valid_shortcodes['from'], |
|
118 | + 'type' => 'email', |
|
119 | + ), |
|
120 | + 'subject' => array( |
|
121 | + 'shortcodes' => array( |
|
122 | + 'organization', |
|
123 | + 'primary_registration_details', |
|
124 | + 'event_author', |
|
125 | + 'primary_registration_details', |
|
126 | + 'recipient_details', |
|
127 | + ), |
|
128 | + ), |
|
129 | + 'content' => array( |
|
130 | + 'shortcodes' => array( |
|
131 | + 'event_list', |
|
132 | + 'attendee_list', |
|
133 | + 'ticket_list', |
|
134 | + 'organization', |
|
135 | + 'primary_registration_details', |
|
136 | + 'primary_registration_list', |
|
137 | + 'event_author', |
|
138 | + 'recipient_details', |
|
139 | + 'recipient_list', |
|
140 | + 'transaction', |
|
141 | + 'messenger', |
|
142 | + ), |
|
143 | + ), |
|
144 | + 'attendee_list' => array( |
|
145 | + 'shortcodes' => array('attendee', 'event_list', 'ticket_list'), |
|
146 | + 'required' => array('[ATTENDEE_LIST]'), |
|
147 | + ), |
|
148 | + 'event_list' => array( |
|
149 | + 'shortcodes' => array( |
|
150 | + 'event', |
|
151 | + 'attendee_list', |
|
152 | + 'ticket_list', |
|
153 | + 'venue', |
|
154 | + 'datetime_list', |
|
155 | + 'attendee', |
|
156 | + 'primary_registration_details', |
|
157 | + 'primary_registration_list', |
|
158 | + 'event_author', |
|
159 | + 'recipient_details', |
|
160 | + 'recipient_list', |
|
161 | + ), |
|
162 | + 'required' => array('[EVENT_LIST]'), |
|
163 | + ), |
|
164 | + 'ticket_list' => array( |
|
165 | + 'shortcodes' => array( |
|
166 | + 'event_list', |
|
167 | + 'attendee_list', |
|
168 | + 'ticket', |
|
169 | + 'datetime_list', |
|
170 | + 'primary_registration_details', |
|
171 | + 'recipient_details', |
|
172 | + ), |
|
173 | + 'required' => array('[TICKET_LIST]'), |
|
174 | + ), |
|
175 | + 'datetime_list' => array( |
|
176 | + 'shortcodes' => array('datetime'), |
|
177 | + 'required' => array('[DATETIME_LIST]'), |
|
178 | + ), |
|
179 | + ); |
|
180 | + } |
|
181 | + |
|
182 | + |
|
183 | + /** |
|
184 | + * @see parent EE_messenger class for docs |
|
185 | + * @since 4.5.0 |
|
186 | + */ |
|
187 | + public function do_secondary_messenger_hooks($sending_messenger_name) |
|
188 | + { |
|
189 | + if ($sending_messenger_name === 'html') { |
|
190 | + add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8); |
|
191 | + } |
|
192 | + } |
|
193 | + |
|
194 | + |
|
195 | + public function add_email_css( |
|
196 | + $variation_path, |
|
197 | + $messenger, |
|
198 | + $message_type, |
|
199 | + $type, |
|
200 | + $variation, |
|
201 | + $file_extension, |
|
202 | + $url, |
|
203 | + EE_Messages_Template_Pack $template_pack |
|
204 | + ) { |
|
205 | + // prevent recursion on this callback. |
|
206 | + remove_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10); |
|
207 | + $variation = $this->get_variation($template_pack, $message_type, $url, 'main', $variation, false); |
|
208 | + |
|
209 | + add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8); |
|
210 | + return $variation; |
|
211 | + } |
|
212 | + |
|
213 | + |
|
214 | + /** |
|
215 | + * See parent for details |
|
216 | + * |
|
217 | + * @access protected |
|
218 | + * @return void |
|
219 | + */ |
|
220 | + protected function _set_test_settings_fields() |
|
221 | + { |
|
222 | + $this->_test_settings_fields = array( |
|
223 | + 'to' => array( |
|
224 | + 'input' => 'text', |
|
225 | + 'label' => esc_html__('Send a test email to', 'event_espresso'), |
|
226 | + 'type' => 'email', |
|
227 | + 'required' => true, |
|
228 | + 'validation' => true, |
|
229 | + 'css_class' => 'large-text', |
|
230 | + 'format' => '%s', |
|
231 | + 'default' => get_bloginfo('admin_email'), |
|
232 | + ), |
|
233 | + 'subject' => array( |
|
234 | + 'input' => 'hidden', |
|
235 | + 'label' => '', |
|
236 | + 'type' => 'string', |
|
237 | + 'required' => false, |
|
238 | + 'validation' => false, |
|
239 | + 'format' => '%s', |
|
240 | + 'value' => sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')), |
|
241 | + 'default' => '', |
|
242 | + 'css_class' => '', |
|
243 | + ), |
|
244 | + ); |
|
245 | + } |
|
246 | + |
|
247 | + |
|
248 | + /** |
|
249 | + * _set_template_fields |
|
250 | + * This sets up the fields that a messenger requires for the message to go out. |
|
251 | + * |
|
252 | + * @access protected |
|
253 | + * @return void |
|
254 | + */ |
|
255 | + protected function _set_template_fields() |
|
256 | + { |
|
257 | + // any extra template fields that are NOT used by the messenger but will get used by a messenger field for |
|
258 | + // shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field |
|
259 | + // they relate to. This is important for the Messages_admin to know what fields to display to the user. |
|
260 | + // Also, notice that the "values" are equal to the field type that messages admin will use to know what |
|
261 | + // kind of field to display. The values ALSO have one index labeled "shortcode". the values in that array |
|
262 | + // indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be |
|
263 | + // displayed. If the required shortcode isn't part of the shortcodes array then the field is not needed and |
|
264 | + // will not be displayed/parsed. |
|
265 | + $this->_template_fields = array( |
|
266 | + 'to' => array( |
|
267 | + 'input' => 'text', |
|
268 | + 'label' => esc_html_x( |
|
269 | + 'To', |
|
270 | + 'Label for the "To" field for email addresses', |
|
271 | + 'event_espresso' |
|
272 | + ), |
|
273 | + 'type' => 'string', |
|
274 | + 'required' => true, |
|
275 | + 'validation' => true, |
|
276 | + 'css_class' => 'large-text', |
|
277 | + 'format' => '%s', |
|
278 | + ), |
|
279 | + 'cc' => array( |
|
280 | + 'input' => 'text', |
|
281 | + 'label' => esc_html_x( |
|
282 | + 'CC', |
|
283 | + 'Label for the "Carbon Copy" field used for additional email addresses', |
|
284 | + 'event_espresso' |
|
285 | + ), |
|
286 | + 'type' => 'string', |
|
287 | + 'required' => false, |
|
288 | + 'validation' => true, |
|
289 | + 'css_class' => 'large-text', |
|
290 | + 'format' => '%s', |
|
291 | + ), |
|
292 | + 'from' => array( |
|
293 | + 'input' => 'text', |
|
294 | + 'label' => esc_html_x( |
|
295 | + 'From', |
|
296 | + 'Label for the "From" field for email addresses.', |
|
297 | + 'event_espresso' |
|
298 | + ), |
|
299 | + 'type' => 'string', |
|
300 | + 'required' => true, |
|
301 | + 'validation' => true, |
|
302 | + 'css_class' => 'large-text', |
|
303 | + 'format' => '%s', |
|
304 | + ), |
|
305 | + 'subject' => array( |
|
306 | + 'input' => 'text', |
|
307 | + 'label' => esc_html_x( |
|
308 | + 'Subject', |
|
309 | + 'Label for the "Subject" field (short description of contents) for emails.', |
|
310 | + 'event_espresso' |
|
311 | + ), |
|
312 | + 'type' => 'string', |
|
313 | + 'required' => true, |
|
314 | + 'validation' => true, |
|
315 | + 'css_class' => 'large-text', |
|
316 | + 'format' => '%s', |
|
317 | + ), |
|
318 | + 'content' => '', |
|
319 | + // left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field. |
|
320 | + 'extra' => array( |
|
321 | + 'content' => array( |
|
322 | + 'main' => array( |
|
323 | + 'input' => 'wp_editor', |
|
324 | + 'label' => esc_html__('Main Content', 'event_espresso'), |
|
325 | + 'type' => 'string', |
|
326 | + 'required' => true, |
|
327 | + 'validation' => true, |
|
328 | + 'format' => '%s', |
|
329 | + 'rows' => '15', |
|
330 | + ), |
|
331 | + 'event_list' => array( |
|
332 | + 'input' => 'wp_editor', |
|
333 | + 'label' => '[EVENT_LIST]', |
|
334 | + 'type' => 'string', |
|
335 | + 'required' => true, |
|
336 | + 'validation' => true, |
|
337 | + 'format' => '%s', |
|
338 | + 'rows' => '15', |
|
339 | + 'shortcodes_required' => array('[EVENT_LIST]'), |
|
340 | + ), |
|
341 | + 'attendee_list' => array( |
|
342 | + 'input' => 'textarea', |
|
343 | + 'label' => '[ATTENDEE_LIST]', |
|
344 | + 'type' => 'string', |
|
345 | + 'required' => true, |
|
346 | + 'validation' => true, |
|
347 | + 'format' => '%s', |
|
348 | + 'css_class' => 'large-text', |
|
349 | + 'rows' => '5', |
|
350 | + 'shortcodes_required' => array('[ATTENDEE_LIST]'), |
|
351 | + ), |
|
352 | + 'ticket_list' => array( |
|
353 | + 'input' => 'textarea', |
|
354 | + 'label' => '[TICKET_LIST]', |
|
355 | + 'type' => 'string', |
|
356 | + 'required' => true, |
|
357 | + 'validation' => true, |
|
358 | + 'format' => '%s', |
|
359 | + 'css_class' => 'large-text', |
|
360 | + 'rows' => '10', |
|
361 | + 'shortcodes_required' => array('[TICKET_LIST]'), |
|
362 | + ), |
|
363 | + 'datetime_list' => array( |
|
364 | + 'input' => 'textarea', |
|
365 | + 'label' => '[DATETIME_LIST]', |
|
366 | + 'type' => 'string', |
|
367 | + 'required' => true, |
|
368 | + 'validation' => true, |
|
369 | + 'format' => '%s', |
|
370 | + 'css_class' => 'large-text', |
|
371 | + 'rows' => '10', |
|
372 | + 'shortcodes_required' => array('[DATETIME_LIST]'), |
|
373 | + ), |
|
374 | + ), |
|
375 | + ), |
|
376 | + ); |
|
377 | + } |
|
378 | + |
|
379 | + |
|
380 | + /** |
|
381 | + * See definition of this class in parent |
|
382 | + */ |
|
383 | + protected function _set_default_message_types() |
|
384 | + { |
|
385 | + $this->_default_message_types = array( |
|
386 | + 'payment', |
|
387 | + 'payment_refund', |
|
388 | + 'registration', |
|
389 | + 'not_approved_registration', |
|
390 | + 'pending_approval', |
|
391 | + ); |
|
392 | + } |
|
393 | + |
|
394 | + |
|
395 | + /** |
|
396 | + * @see definition of this class in parent |
|
397 | + * @since 4.5.0 |
|
398 | + */ |
|
399 | + protected function _set_valid_message_types() |
|
400 | + { |
|
401 | + $this->_valid_message_types = array( |
|
402 | + 'payment', |
|
403 | + 'registration', |
|
404 | + 'not_approved_registration', |
|
405 | + 'declined_registration', |
|
406 | + 'cancelled_registration', |
|
407 | + 'pending_approval', |
|
408 | + 'registration_summary', |
|
409 | + 'payment_reminder', |
|
410 | + 'payment_declined', |
|
411 | + 'payment_refund', |
|
412 | + ); |
|
413 | + } |
|
414 | + |
|
415 | + |
|
416 | + /** |
|
417 | + * setting up admin_settings_fields for messenger. |
|
418 | + */ |
|
419 | + protected function _set_admin_settings_fields() |
|
420 | + { |
|
421 | + } |
|
422 | + |
|
423 | + /** |
|
424 | + * We just deliver the messages don't kill us!! |
|
425 | + * |
|
426 | + * @return bool|WP_Error true if message delivered, false if it didn't deliver OR bubble up any error object if |
|
427 | + * present. |
|
428 | + * @throws EE_Error |
|
429 | + * @throws \TijsVerkoyen\CssToInlineStyles\Exception |
|
430 | + */ |
|
431 | + protected function _send_message() |
|
432 | + { |
|
433 | + $success = wp_mail( |
|
434 | + $this->_to, |
|
435 | + // some old values for subject may be expecting HTML entities to be decoded in the subject |
|
436 | + // and subjects aren't interpreted as HTML, so there should be no HTML in them |
|
437 | + wp_strip_all_tags(wp_specialchars_decode($this->_subject, ENT_QUOTES)), |
|
438 | + $this->_body(), |
|
439 | + $this->_headers() |
|
440 | + ); |
|
441 | + if (! $success) { |
|
442 | + EE_Error::add_error( |
|
443 | + sprintf( |
|
444 | + esc_html__( |
|
445 | + 'The email did not send successfully.%3$sThe WordPress wp_mail function is used for sending mails but does not give any useful information when an email fails to send.%3$sIt is possible the "to" address (%1$s) or "from" address (%2$s) is invalid.%3$s', |
|
446 | + 'event_espresso' |
|
447 | + ), |
|
448 | + $this->_to, |
|
449 | + $this->_from, |
|
450 | + '<br />' |
|
451 | + ), |
|
452 | + __FILE__, |
|
453 | + __FUNCTION__, |
|
454 | + __LINE__ |
|
455 | + ); |
|
456 | + } |
|
457 | + return $success; |
|
458 | + } |
|
459 | + |
|
460 | + |
|
461 | + /** |
|
462 | + * see parent for definition |
|
463 | + * |
|
464 | + * @return string html body of the message content and the related css. |
|
465 | + * @throws EE_Error |
|
466 | + * @throws \TijsVerkoyen\CssToInlineStyles\Exception |
|
467 | + */ |
|
468 | + protected function _preview() |
|
469 | + { |
|
470 | + return $this->_body(true); |
|
471 | + } |
|
472 | + |
|
473 | + |
|
474 | + /** |
|
475 | + * Setup headers for email |
|
476 | + * |
|
477 | + * @access protected |
|
478 | + * @return string formatted header for email |
|
479 | + */ |
|
480 | + protected function _headers() |
|
481 | + { |
|
482 | + $this->_ensure_has_from_email_address(); |
|
483 | + $from = $this->_from; |
|
484 | + $headers = array( |
|
485 | + 'From:' . $from, |
|
486 | + 'Reply-To:' . $from, |
|
487 | + 'Content-Type:text/html; charset=utf-8', |
|
488 | + ); |
|
489 | + |
|
490 | + /** |
|
491 | + * Second condition added as a result of https://events.codebasehq.com/projects/event-espresso/tickets/11416 to |
|
492 | + * cover back compat where there may be users who have saved cc values in their db for the newsletter message |
|
493 | + * type which they are no longer able to change. |
|
494 | + */ |
|
495 | + if (! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) { |
|
496 | + $headers[] = 'cc: ' . $this->_cc; |
|
497 | + } |
|
498 | + |
|
499 | + // but wait! Header's for the from is NOT reliable because some plugins don't respect From: as set in the |
|
500 | + // header. |
|
501 | + add_filter('wp_mail_from', array($this, 'set_from_address'), 100); |
|
502 | + add_filter('wp_mail_from_name', array($this, 'set_from_name'), 100); |
|
503 | + return apply_filters('FHEE__EE_Email_messenger___headers', $headers, $this->_incoming_message_type, $this); |
|
504 | + } |
|
505 | + |
|
506 | + |
|
507 | + /** |
|
508 | + * This simply ensures that the from address is not empty. If it is, then we use whatever is set as the site email |
|
509 | + * address for the from address to avoid problems with sending emails. |
|
510 | + */ |
|
511 | + protected function _ensure_has_from_email_address() |
|
512 | + { |
|
513 | + if (empty($this->_from)) { |
|
514 | + $this->_from = get_bloginfo('admin_email'); |
|
515 | + } |
|
516 | + } |
|
517 | + |
|
518 | + |
|
519 | + /** |
|
520 | + * This simply parses whatever is set as the $_from address and determines if it is in the format {name} <{email}> |
|
521 | + * or just {email} and returns an array with the "from_name" and "from_email" as the values. Note from_name *MAY* |
|
522 | + * be empty |
|
523 | + * |
|
524 | + * @since 4.3.1 |
|
525 | + * @return array |
|
526 | + */ |
|
527 | + private function _parse_from() |
|
528 | + { |
|
529 | + if (strpos($this->_from, '<') !== false) { |
|
530 | + $from_name = substr($this->_from, 0, strpos($this->_from, '<') - 1); |
|
531 | + $from_name = str_replace('"', '', $from_name); |
|
532 | + $from_name = trim($from_name); |
|
533 | + |
|
534 | + $from_email = substr($this->_from, strpos($this->_from, '<') + 1); |
|
535 | + $from_email = str_replace('>', '', $from_email); |
|
536 | + $from_email = trim($from_email); |
|
537 | + } elseif (trim($this->_from) !== '') { |
|
538 | + $from_name = ''; |
|
539 | + $from_email = trim($this->_from); |
|
540 | + } else { |
|
541 | + $from_name = $from_email = ''; |
|
542 | + } |
|
543 | + return array($from_name, $from_email); |
|
544 | + } |
|
545 | + |
|
546 | + |
|
547 | + /** |
|
548 | + * Callback for the wp_mail_from filter. |
|
549 | + * |
|
550 | + * @since 4.3.1 |
|
551 | + * @param string $from_email What the original from_email is. |
|
552 | + * @return string |
|
553 | + */ |
|
554 | + public function set_from_address($from_email) |
|
555 | + { |
|
556 | + $parsed_from = $this->_parse_from(); |
|
557 | + // includes fallback if the parsing failed. |
|
558 | + $from_email = is_array($parsed_from) && ! empty($parsed_from[1]) |
|
559 | + ? $parsed_from[1] |
|
560 | + : get_bloginfo('admin_email'); |
|
561 | + return $from_email; |
|
562 | + } |
|
563 | + |
|
564 | + |
|
565 | + /** |
|
566 | + * Callback fro the wp_mail_from_name filter. |
|
567 | + * |
|
568 | + * @since 4.3.1 |
|
569 | + * @param string $from_name The original from_name. |
|
570 | + * @return string |
|
571 | + */ |
|
572 | + public function set_from_name($from_name) |
|
573 | + { |
|
574 | + $parsed_from = $this->_parse_from(); |
|
575 | + if (is_array($parsed_from) && ! empty($parsed_from[0])) { |
|
576 | + $from_name = $parsed_from[0]; |
|
577 | + } |
|
578 | + |
|
579 | + // if from name is "WordPress" let's sub in the site name instead (more friendly!) |
|
580 | + // but realize the default name is HTML entity-encoded |
|
581 | + $from_name = $from_name == 'WordPress' ? wp_specialchars_decode(get_bloginfo(), ENT_QUOTES) : $from_name; |
|
582 | + |
|
583 | + return $from_name; |
|
584 | + } |
|
585 | + |
|
586 | + |
|
587 | + /** |
|
588 | + * setup body for email |
|
589 | + * |
|
590 | + * @param bool $preview will determine whether this is preview template or not. |
|
591 | + * @return string formatted body for email. |
|
592 | + * @throws EE_Error |
|
593 | + * @throws \TijsVerkoyen\CssToInlineStyles\Exception |
|
594 | + */ |
|
595 | + protected function _body($preview = false) |
|
596 | + { |
|
597 | + // setup template args! |
|
598 | + $this->_template_args = array( |
|
599 | + 'subject' => $this->_subject, |
|
600 | + 'from' => $this->_from, |
|
601 | + 'main_body' => wpautop($this->_content), |
|
602 | + ); |
|
603 | + $body = $this->_get_main_template($preview); |
|
604 | + |
|
605 | + /** |
|
606 | + * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched. |
|
607 | + * |
|
608 | + * @type bool $preview Indicates whether a preview is being generated or not. |
|
609 | + * @return bool true indicates to use the inliner, false bypasses it. |
|
610 | + */ |
|
611 | + if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) { |
|
612 | + // require CssToInlineStyles library and its dependencies via composer autoloader |
|
613 | + require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php'; |
|
614 | + |
|
615 | + // now if this isn't a preview, let's setup the body so it has inline styles |
|
616 | + if (! $preview || ($preview && defined('DOING_AJAX'))) { |
|
617 | + $style = file_get_contents( |
|
618 | + $this->get_variation( |
|
619 | + $this->_tmp_pack, |
|
620 | + $this->_incoming_message_type->name, |
|
621 | + false, |
|
622 | + 'main', |
|
623 | + $this->_variation |
|
624 | + ), |
|
625 | + true |
|
626 | + ); |
|
627 | + $CSS = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles($body, $style); |
|
628 | + // for some reason the library has a bracket and new line at the beginning. This takes care of that. |
|
629 | + $body = ltrim($CSS->convert(true), ">\n"); |
|
630 | + // see https://events.codebasehq.com/projects/event-espresso/tickets/8609 |
|
631 | + $body = ltrim($body, "<?"); |
|
632 | + } |
|
633 | + } |
|
634 | + return $body; |
|
635 | + } |
|
636 | + |
|
637 | + |
|
638 | + /** |
|
639 | + * This just returns any existing test settings that might be saved in the database |
|
640 | + * |
|
641 | + * @access public |
|
642 | + * @return array |
|
643 | + */ |
|
644 | + public function get_existing_test_settings() |
|
645 | + { |
|
646 | + $settings = parent::get_existing_test_settings(); |
|
647 | + // override subject if present because we always want it to be fresh. |
|
648 | + if (is_array($settings) && ! empty($settings['subject'])) { |
|
649 | + $settings['subject'] = sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')); |
|
650 | + } |
|
651 | + return $settings; |
|
652 | + } |
|
653 | 653 | } |
@@ -164,7 +164,7 @@ |
||
164 | 164 | |
165 | 165 | |
166 | 166 | /** |
167 | - * @param $ticket |
|
167 | + * @param \EE_Base_Class $ticket |
|
168 | 168 | * @throws DomainException |
169 | 169 | * @throws EE_Error |
170 | 170 | * @throws UnexpectedEntityException |
@@ -26,719 +26,719 @@ |
||
26 | 26 | class EventSpacesCalculator |
27 | 27 | { |
28 | 28 | |
29 | - /** |
|
30 | - * @var EE_Event $event |
|
31 | - */ |
|
32 | - private $event; |
|
33 | - |
|
34 | - /** |
|
35 | - * @var array $datetime_query_params |
|
36 | - */ |
|
37 | - private $datetime_query_params; |
|
38 | - |
|
39 | - /** |
|
40 | - * @var EE_Ticket[] $active_tickets |
|
41 | - */ |
|
42 | - private $active_tickets = array(); |
|
43 | - |
|
44 | - /** |
|
45 | - * @var EE_Datetime[] $datetimes |
|
46 | - */ |
|
47 | - private $datetimes = array(); |
|
48 | - |
|
49 | - /** |
|
50 | - * Array of Ticket IDs grouped by Datetime |
|
51 | - * |
|
52 | - * @var array $datetimes |
|
53 | - */ |
|
54 | - private $datetime_tickets = array(); |
|
55 | - |
|
56 | - /** |
|
57 | - * Max spaces for each Datetime (reg limit - previous sold) |
|
58 | - * |
|
59 | - * @var array $datetime_spaces |
|
60 | - */ |
|
61 | - private $datetime_spaces = array(); |
|
62 | - |
|
63 | - /** |
|
64 | - * Array of Datetime IDs grouped by Ticket |
|
65 | - * |
|
66 | - * @var array[] $ticket_datetimes |
|
67 | - */ |
|
68 | - private $ticket_datetimes = array(); |
|
69 | - |
|
70 | - /** |
|
71 | - * maximum ticket quantities for each ticket (adjusted for reg limit) |
|
72 | - * |
|
73 | - * @var array $ticket_quantities |
|
74 | - */ |
|
75 | - private $ticket_quantities = array(); |
|
76 | - |
|
77 | - /** |
|
78 | - * total quantity of sold and reserved for each ticket |
|
79 | - * |
|
80 | - * @var array $tickets_sold |
|
81 | - */ |
|
82 | - private $tickets_sold = array(); |
|
83 | - |
|
84 | - /** |
|
85 | - * total spaces available across all datetimes |
|
86 | - * |
|
87 | - * @var array $total_spaces |
|
88 | - */ |
|
89 | - private $total_spaces = array(); |
|
90 | - |
|
91 | - /** |
|
92 | - * @var boolean $debug |
|
93 | - */ |
|
94 | - private $debug = false; // true false |
|
95 | - |
|
96 | - /** |
|
97 | - * @var null|int $spaces_remaining |
|
98 | - */ |
|
99 | - private $spaces_remaining; |
|
100 | - |
|
101 | - /** |
|
102 | - * @var null|int $total_spaces_available |
|
103 | - */ |
|
104 | - private $total_spaces_available; |
|
105 | - |
|
106 | - |
|
107 | - /** |
|
108 | - * EventSpacesCalculator constructor. |
|
109 | - * |
|
110 | - * @param EE_Event $event |
|
111 | - * @param array $datetime_query_params |
|
112 | - * @throws EE_Error |
|
113 | - */ |
|
114 | - public function __construct(EE_Event $event, array $datetime_query_params = array()) |
|
115 | - { |
|
116 | - if ($this->debug) { |
|
117 | - \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 1); |
|
118 | - \EEH_Debug_Tools::printr((string) $event->ID(), 'For event', __FILE__, __LINE__); |
|
119 | - } |
|
120 | - $this->event = $event; |
|
121 | - $this->datetime_query_params = $datetime_query_params + array('order_by' => array('DTT_reg_limit' => 'ASC')); |
|
122 | - $this->setHooks(); |
|
123 | - } |
|
124 | - |
|
125 | - |
|
126 | - /** |
|
127 | - * @return void |
|
128 | - */ |
|
129 | - private function setHooks() |
|
130 | - { |
|
131 | - add_action('AHEE__EE_Ticket__increase_sold', array($this, 'clearResults')); |
|
132 | - add_action('AHEE__EE_Ticket__decrease_sold', array($this, 'clearResults')); |
|
133 | - add_action('AHEE__EE_Datetime__increase_sold', array($this, 'clearResults')); |
|
134 | - add_action('AHEE__EE_Datetime__decrease_sold', array($this, 'clearResults')); |
|
135 | - add_action('AHEE__EE_Ticket__increase_reserved', array($this, 'clearResults')); |
|
136 | - add_action('AHEE__EE_Ticket__decrease_reserved', array($this, 'clearResults')); |
|
137 | - add_action('AHEE__EE_Datetime__increase_reserved', array($this, 'clearResults')); |
|
138 | - add_action('AHEE__EE_Datetime__decrease_reserved', array($this, 'clearResults')); |
|
139 | - } |
|
140 | - |
|
141 | - |
|
142 | - /** |
|
143 | - * @return void |
|
144 | - */ |
|
145 | - public function clearResults() |
|
146 | - { |
|
147 | - if ($this->debug) { |
|
148 | - \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 1); |
|
149 | - } |
|
150 | - $this->spaces_remaining = null; |
|
151 | - $this->total_spaces_available = null; |
|
152 | - } |
|
153 | - |
|
154 | - |
|
155 | - /** |
|
156 | - * @return EE_Ticket[] |
|
157 | - * @throws EE_Error |
|
158 | - * @throws InvalidDataTypeException |
|
159 | - * @throws InvalidInterfaceException |
|
160 | - * @throws InvalidArgumentException |
|
161 | - */ |
|
162 | - public function getActiveTickets() |
|
163 | - { |
|
164 | - if (empty($this->active_tickets)) { |
|
165 | - $this->active_tickets = $this->event->tickets( |
|
166 | - array( |
|
167 | - array('TKT_deleted' => false), |
|
168 | - 'order_by' => array('TKT_qty' => 'ASC'), |
|
169 | - ) |
|
170 | - ); |
|
171 | - } |
|
172 | - return $this->active_tickets; |
|
173 | - } |
|
174 | - |
|
175 | - |
|
176 | - /** |
|
177 | - * @param EE_Ticket[] $active_tickets |
|
178 | - * @throws EE_Error |
|
179 | - * @throws DomainException |
|
180 | - * @throws UnexpectedEntityException |
|
181 | - */ |
|
182 | - public function setActiveTickets(array $active_tickets = array()) |
|
183 | - { |
|
184 | - if (! empty($active_tickets)) { |
|
185 | - foreach ($active_tickets as $active_ticket) { |
|
186 | - $this->validateTicket($active_ticket); |
|
187 | - } |
|
188 | - // sort incoming array by ticket quantity (asc) |
|
189 | - usort( |
|
190 | - $active_tickets, |
|
191 | - function (EE_Ticket $a, EE_Ticket $b) { |
|
192 | - if ($a->qty() === $b->qty()) { |
|
193 | - return 0; |
|
194 | - } |
|
195 | - return ($a->qty() < $b->qty()) |
|
196 | - ? -1 |
|
197 | - : 1; |
|
198 | - } |
|
199 | - ); |
|
200 | - } |
|
201 | - $this->active_tickets = $active_tickets; |
|
202 | - } |
|
203 | - |
|
204 | - |
|
205 | - /** |
|
206 | - * @param $ticket |
|
207 | - * @throws DomainException |
|
208 | - * @throws EE_Error |
|
209 | - * @throws UnexpectedEntityException |
|
210 | - */ |
|
211 | - private function validateTicket($ticket) |
|
212 | - { |
|
213 | - if (! $ticket instanceof EE_Ticket) { |
|
214 | - throw new DomainException( |
|
215 | - esc_html__( |
|
216 | - 'Invalid Ticket. Only EE_Ticket objects can be used to calculate event space availability.', |
|
217 | - 'event_espresso' |
|
218 | - ) |
|
219 | - ); |
|
220 | - } |
|
221 | - if ($ticket->get_event_ID() !== $this->event->ID()) { |
|
222 | - throw new DomainException( |
|
223 | - sprintf( |
|
224 | - esc_html__( |
|
225 | - 'An EE_Ticket for Event %1$d was supplied while calculating event space availability for Event %2$d.', |
|
226 | - 'event_espresso' |
|
227 | - ), |
|
228 | - $ticket->get_event_ID(), |
|
229 | - $this->event->ID() |
|
230 | - ) |
|
231 | - ); |
|
232 | - } |
|
233 | - } |
|
234 | - |
|
235 | - |
|
236 | - /** |
|
237 | - * @return EE_Datetime[] |
|
238 | - */ |
|
239 | - public function getDatetimes() |
|
240 | - { |
|
241 | - return $this->datetimes; |
|
242 | - } |
|
243 | - |
|
244 | - |
|
245 | - /** |
|
246 | - * @param EE_Datetime $datetime |
|
247 | - * @throws EE_Error |
|
248 | - * @throws DomainException |
|
249 | - */ |
|
250 | - public function setDatetime(EE_Datetime $datetime) |
|
251 | - { |
|
252 | - if ($datetime->event()->ID() !== $this->event->ID()) { |
|
253 | - throw new DomainException( |
|
254 | - sprintf( |
|
255 | - esc_html__( |
|
256 | - 'An EE_Datetime for Event %1$d was supplied while calculating event space availability for Event %2$d.', |
|
257 | - 'event_espresso' |
|
258 | - ), |
|
259 | - $datetime->event()->ID(), |
|
260 | - $this->event->ID() |
|
261 | - ) |
|
262 | - ); |
|
263 | - } |
|
264 | - $this->datetimes[ $datetime->ID() ] = $datetime; |
|
265 | - } |
|
266 | - |
|
267 | - |
|
268 | - /** |
|
269 | - * calculate spaces remaining based on "saleable" tickets |
|
270 | - * |
|
271 | - * @return float|int |
|
272 | - * @throws EE_Error |
|
273 | - * @throws DomainException |
|
274 | - * @throws UnexpectedEntityException |
|
275 | - * @throws InvalidDataTypeException |
|
276 | - * @throws InvalidInterfaceException |
|
277 | - * @throws InvalidArgumentException |
|
278 | - */ |
|
279 | - public function spacesRemaining() |
|
280 | - { |
|
281 | - if ($this->debug) { |
|
282 | - \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2); |
|
283 | - } |
|
284 | - if ($this->spaces_remaining === null) { |
|
285 | - $this->initialize(); |
|
286 | - $this->spaces_remaining = $this->calculate(); |
|
287 | - } |
|
288 | - return $this->spaces_remaining; |
|
289 | - } |
|
290 | - |
|
291 | - |
|
292 | - /** |
|
293 | - * calculates total available spaces for an event with no regard for sold tickets |
|
294 | - * |
|
295 | - * @return int|float |
|
296 | - * @throws EE_Error |
|
297 | - * @throws DomainException |
|
298 | - * @throws UnexpectedEntityException |
|
299 | - * @throws InvalidDataTypeException |
|
300 | - * @throws InvalidInterfaceException |
|
301 | - * @throws InvalidArgumentException |
|
302 | - */ |
|
303 | - public function totalSpacesAvailable() |
|
304 | - { |
|
305 | - if ($this->debug) { |
|
306 | - \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2); |
|
307 | - } |
|
308 | - if ($this->total_spaces_available === null) { |
|
309 | - $this->initialize(); |
|
310 | - $this->total_spaces_available = $this->calculate(false); |
|
311 | - } |
|
312 | - return $this->total_spaces_available; |
|
313 | - } |
|
314 | - |
|
315 | - |
|
316 | - /** |
|
317 | - * Loops through the active tickets for the event |
|
318 | - * and builds a series of data arrays that will be used for calculating |
|
319 | - * the total maximum available spaces, as well as the spaces remaining. |
|
320 | - * Because ticket quantities affect datetime spaces and vice versa, |
|
321 | - * we need to be constantly updating these data arrays as things change, |
|
322 | - * which is the entire reason for their existence. |
|
323 | - * |
|
324 | - * @throws EE_Error |
|
325 | - * @throws DomainException |
|
326 | - * @throws UnexpectedEntityException |
|
327 | - * @throws InvalidDataTypeException |
|
328 | - * @throws InvalidInterfaceException |
|
329 | - * @throws InvalidArgumentException |
|
330 | - */ |
|
331 | - private function initialize() |
|
332 | - { |
|
333 | - if ($this->debug) { |
|
334 | - \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2); |
|
335 | - } |
|
336 | - $this->datetime_tickets = array(); |
|
337 | - $this->datetime_spaces = array(); |
|
338 | - $this->ticket_datetimes = array(); |
|
339 | - $this->ticket_quantities = array(); |
|
340 | - $this->tickets_sold = array(); |
|
341 | - $this->total_spaces = array(); |
|
342 | - $active_tickets = $this->getActiveTickets(); |
|
343 | - if (! empty($active_tickets)) { |
|
344 | - foreach ($active_tickets as $ticket) { |
|
345 | - $this->validateTicket($ticket); |
|
346 | - // we need to index our data arrays using strings for the purpose of sorting, |
|
347 | - // but we also need them to be unique, so we'll just prepend a letter T to the ID |
|
348 | - $ticket_identifier = "T{$ticket->ID()}"; |
|
349 | - // to start, we'll just consider the raw qty to be the maximum availability for this ticket, |
|
350 | - // unless the ticket is past its "sell until" date, in which case the qty will be 0 |
|
351 | - $max_tickets = $ticket->is_expired() ? 0 : $ticket->qty(); |
|
352 | - // but we'll adjust that after looping over each datetime for the ticket and checking reg limits |
|
353 | - $ticket_datetimes = $ticket->datetimes($this->datetime_query_params); |
|
354 | - foreach ($ticket_datetimes as $datetime) { |
|
355 | - // save all datetimes |
|
356 | - $this->setDatetime($datetime); |
|
357 | - $datetime_identifier = "D{$datetime->ID()}"; |
|
358 | - $reg_limit = $datetime->reg_limit(); |
|
359 | - // ticket quantity can not exceed datetime reg limit |
|
360 | - $max_tickets = min($max_tickets, $reg_limit); |
|
361 | - // as described earlier, because we need to be able to constantly adjust numbers for things, |
|
362 | - // we are going to move all of our data into the following arrays: |
|
363 | - // datetime spaces initially represents the reg limit for each datetime, |
|
364 | - // but this will get adjusted as tickets are accounted for |
|
365 | - $this->datetime_spaces[ $datetime_identifier ] = $reg_limit; |
|
366 | - // just an array of ticket IDs grouped by datetime |
|
367 | - $this->datetime_tickets[ $datetime_identifier ][] = $ticket_identifier; |
|
368 | - // and an array of datetime IDs grouped by ticket |
|
369 | - $this->ticket_datetimes[ $ticket_identifier ][] = $datetime_identifier; |
|
370 | - } |
|
371 | - // total quantity of sold and reserved for each ticket |
|
372 | - $this->tickets_sold[ $ticket_identifier ] = $ticket->sold() + $ticket->reserved(); |
|
373 | - // and the maximum ticket quantities for each ticket (adjusted for reg limit) |
|
374 | - $this->ticket_quantities[ $ticket_identifier ] = $max_tickets; |
|
375 | - } |
|
376 | - } |
|
377 | - // sort datetime spaces by reg limit, but maintain our string indexes |
|
378 | - asort($this->datetime_spaces, SORT_NUMERIC); |
|
379 | - // datetime tickets need to be sorted in the SAME order as the above array... |
|
380 | - // so we'll just use array_merge() to take the structure of datetime_spaces |
|
381 | - // but overwrite all of the data with that from datetime_tickets |
|
382 | - $this->datetime_tickets = array_merge( |
|
383 | - $this->datetime_spaces, |
|
384 | - $this->datetime_tickets |
|
385 | - ); |
|
386 | - if ($this->debug) { |
|
387 | - \EEH_Debug_Tools::printr($this->datetime_spaces, 'datetime_spaces', __FILE__, __LINE__); |
|
388 | - \EEH_Debug_Tools::printr($this->datetime_tickets, 'datetime_tickets', __FILE__, __LINE__); |
|
389 | - \EEH_Debug_Tools::printr($this->ticket_quantities, 'ticket_quantities', __FILE__, __LINE__); |
|
390 | - } |
|
391 | - } |
|
392 | - |
|
393 | - |
|
394 | - /** |
|
395 | - * performs calculations on initialized data |
|
396 | - * |
|
397 | - * @param bool $consider_sold |
|
398 | - * @return int|float |
|
399 | - */ |
|
400 | - private function calculate($consider_sold = true) |
|
401 | - { |
|
402 | - if ($this->debug) { |
|
403 | - \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2); |
|
404 | - \EEH_Debug_Tools::printr($consider_sold, '$consider_sold', __FILE__, __LINE__); |
|
405 | - } |
|
406 | - if ($consider_sold) { |
|
407 | - // subtract amounts sold from all ticket quantities and datetime spaces |
|
408 | - $this->adjustTicketQuantitiesDueToSales(); |
|
409 | - } |
|
410 | - foreach ($this->datetime_tickets as $datetime_identifier => $tickets) { |
|
411 | - $this->trackAvailableSpacesForDatetimes($datetime_identifier, $tickets); |
|
412 | - } |
|
413 | - // total spaces available is just the sum of the spaces available for each datetime |
|
414 | - $spaces_remaining = array_sum($this->total_spaces); |
|
415 | - if ($this->debug) { |
|
416 | - \EEH_Debug_Tools::printr($this->total_spaces, '$this->total_spaces', __FILE__, __LINE__); |
|
417 | - \EEH_Debug_Tools::printr($this->tickets_sold, '$this->tickets_sold', __FILE__, __LINE__); |
|
418 | - \EEH_Debug_Tools::printr($spaces_remaining, '$spaces_remaining', __FILE__, __LINE__); |
|
419 | - } |
|
420 | - return $spaces_remaining; |
|
421 | - } |
|
422 | - |
|
423 | - |
|
424 | - /** |
|
425 | - * subtracts amount of tickets sold from ticket quantities and datetime spaces |
|
426 | - */ |
|
427 | - private function adjustTicketQuantitiesDueToSales() |
|
428 | - { |
|
429 | - if ($this->debug) { |
|
430 | - \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2); |
|
431 | - } |
|
432 | - foreach ($this->tickets_sold as $ticket_identifier => $tickets_sold) { |
|
433 | - if (isset($this->ticket_quantities[ $ticket_identifier ])) { |
|
434 | - $this->ticket_quantities[ $ticket_identifier ] -= $tickets_sold; |
|
435 | - // don't let values go below zero |
|
436 | - $this->ticket_quantities[ $ticket_identifier ] = max( |
|
437 | - $this->ticket_quantities[ $ticket_identifier ], |
|
438 | - 0 |
|
439 | - ); |
|
440 | - if ($this->debug) { |
|
441 | - \EEH_Debug_Tools::printr( |
|
442 | - "{$tickets_sold} sales for ticket {$ticket_identifier} ", |
|
443 | - 'subtracting', |
|
444 | - __FILE__, |
|
445 | - __LINE__ |
|
446 | - ); |
|
447 | - } |
|
448 | - } |
|
449 | - if ( |
|
450 | - isset($this->ticket_datetimes[ $ticket_identifier ]) |
|
451 | - && is_array($this->ticket_datetimes[ $ticket_identifier ]) |
|
452 | - ) { |
|
453 | - foreach ($this->ticket_datetimes[ $ticket_identifier ] as $ticket_datetime) { |
|
454 | - if (isset($this->ticket_quantities[ $ticket_identifier ])) { |
|
455 | - $this->datetime_spaces[ $ticket_datetime ] -= $tickets_sold; |
|
456 | - // don't let values go below zero |
|
457 | - $this->datetime_spaces[ $ticket_datetime ] = max( |
|
458 | - $this->datetime_spaces[ $ticket_datetime ], |
|
459 | - 0 |
|
460 | - ); |
|
461 | - if ($this->debug) { |
|
462 | - \EEH_Debug_Tools::printr( |
|
463 | - "{$tickets_sold} sales for datetime {$ticket_datetime} ", |
|
464 | - 'subtracting', |
|
465 | - __FILE__, |
|
466 | - __LINE__ |
|
467 | - ); |
|
468 | - } |
|
469 | - } |
|
470 | - } |
|
471 | - } |
|
472 | - } |
|
473 | - } |
|
474 | - |
|
475 | - |
|
476 | - /** |
|
477 | - * @param string $datetime_identifier |
|
478 | - * @param array $tickets |
|
479 | - */ |
|
480 | - private function trackAvailableSpacesForDatetimes($datetime_identifier, array $tickets) |
|
481 | - { |
|
482 | - // make sure a reg limit is set for the datetime |
|
483 | - $reg_limit = isset($this->datetime_spaces[ $datetime_identifier ]) |
|
484 | - ? $this->datetime_spaces[ $datetime_identifier ] |
|
485 | - : 0; |
|
486 | - // and bail if it is not |
|
487 | - if (! $reg_limit) { |
|
488 | - if ($this->debug) { |
|
489 | - \EEH_Debug_Tools::printr('AT CAPACITY', " . {$datetime_identifier}", __FILE__, __LINE__); |
|
490 | - } |
|
491 | - return; |
|
492 | - } |
|
493 | - if ($this->debug) { |
|
494 | - \EEH_Debug_Tools::printr($datetime_identifier, '* $datetime_identifier', __FILE__, __LINE__, 1); |
|
495 | - \EEH_Debug_Tools::printr( |
|
496 | - "{$reg_limit}", |
|
497 | - 'REG LIMIT', |
|
498 | - __FILE__, |
|
499 | - __LINE__ |
|
500 | - ); |
|
501 | - } |
|
502 | - // number of allocated spaces always starts at zero |
|
503 | - $spaces_allocated = 0; |
|
504 | - $this->total_spaces[ $datetime_identifier ] = 0; |
|
505 | - foreach ($tickets as $ticket_identifier) { |
|
506 | - $spaces_allocated = $this->calculateAvailableSpacesForTicket( |
|
507 | - $datetime_identifier, |
|
508 | - $reg_limit, |
|
509 | - $ticket_identifier, |
|
510 | - $spaces_allocated |
|
511 | - ); |
|
512 | - } |
|
513 | - // spaces can't be negative |
|
514 | - $spaces_allocated = max($spaces_allocated, 0); |
|
515 | - if ($spaces_allocated) { |
|
516 | - // track any non-zero values |
|
517 | - $this->total_spaces[ $datetime_identifier ] += $spaces_allocated; |
|
518 | - if ($this->debug) { |
|
519 | - \EEH_Debug_Tools::printr((string) $spaces_allocated, ' . $spaces_allocated: ', __FILE__, __LINE__); |
|
520 | - } |
|
521 | - } else { |
|
522 | - if ($this->debug) { |
|
523 | - \EEH_Debug_Tools::printr(' ', ' . NO TICKETS AVAILABLE FOR DATETIME', __FILE__, __LINE__); |
|
524 | - } |
|
525 | - } |
|
526 | - if ($this->debug) { |
|
527 | - \EEH_Debug_Tools::printr( |
|
528 | - $this->total_spaces[ $datetime_identifier ], |
|
529 | - '$total_spaces', |
|
530 | - __FILE__, |
|
531 | - __LINE__ |
|
532 | - ); |
|
533 | - \EEH_Debug_Tools::printr($this->ticket_quantities, '$ticket_quantities', __FILE__, __LINE__); |
|
534 | - \EEH_Debug_Tools::printr($this->datetime_spaces, 'datetime_spaces', __FILE__, __LINE__); |
|
535 | - } |
|
536 | - } |
|
537 | - |
|
538 | - |
|
539 | - /** |
|
540 | - * @param string $datetime_identifier |
|
541 | - * @param int $reg_limit |
|
542 | - * @param string $ticket_identifier |
|
543 | - * @param int $spaces_allocated |
|
544 | - * @return int |
|
545 | - */ |
|
546 | - private function calculateAvailableSpacesForTicket( |
|
547 | - $datetime_identifier, |
|
548 | - $reg_limit, |
|
549 | - $ticket_identifier, |
|
550 | - $spaces_allocated |
|
551 | - ) { |
|
552 | - // make sure ticket quantity is set |
|
553 | - $ticket_quantity = isset($this->ticket_quantities[ $ticket_identifier ]) |
|
554 | - ? $this->ticket_quantities[ $ticket_identifier ] |
|
555 | - : 0; |
|
556 | - if ($this->debug) { |
|
557 | - \EEH_Debug_Tools::printr("{$spaces_allocated}", '$spaces_allocated', __FILE__, __LINE__); |
|
558 | - \EEH_Debug_Tools::printr( |
|
559 | - "{$ticket_quantity}", |
|
560 | - "ticket $ticket_identifier quantity: ", |
|
561 | - __FILE__, |
|
562 | - __LINE__, |
|
563 | - 2 |
|
564 | - ); |
|
565 | - } |
|
566 | - if ($ticket_quantity) { |
|
567 | - if ($this->debug) { |
|
568 | - \EEH_Debug_Tools::printr( |
|
569 | - ($spaces_allocated <= $reg_limit) |
|
570 | - ? 'true' |
|
571 | - : 'false', |
|
572 | - ' . spaces_allocated <= reg_limit = ', |
|
573 | - __FILE__, |
|
574 | - __LINE__ |
|
575 | - ); |
|
576 | - } |
|
577 | - // if the datetime is NOT at full capacity yet |
|
578 | - if ($spaces_allocated <= $reg_limit) { |
|
579 | - // then the maximum ticket quantity we can allocate is the lowest value of either: |
|
580 | - // the number of remaining spaces for the datetime, which is the limit - spaces already taken |
|
581 | - // or the maximum ticket quantity |
|
582 | - $ticket_quantity = min($reg_limit - $spaces_allocated, $ticket_quantity); |
|
583 | - // adjust the available quantity in our tracking array |
|
584 | - $this->ticket_quantities[ $ticket_identifier ] -= $ticket_quantity; |
|
585 | - // and increment spaces allocated for this datetime |
|
586 | - $spaces_allocated += $ticket_quantity; |
|
587 | - $at_capacity = $spaces_allocated >= $reg_limit; |
|
588 | - if ($this->debug) { |
|
589 | - \EEH_Debug_Tools::printr( |
|
590 | - "{$ticket_quantity} {$ticket_identifier} tickets", |
|
591 | - ' > > allocate ', |
|
592 | - __FILE__, |
|
593 | - __LINE__, |
|
594 | - 3 |
|
595 | - ); |
|
596 | - if ($at_capacity) { |
|
597 | - \EEH_Debug_Tools::printr('AT CAPACITY', " . {$datetime_identifier}", __FILE__, __LINE__, 3); |
|
598 | - } |
|
599 | - } |
|
600 | - // now adjust all other datetimes that allow access to this ticket |
|
601 | - $this->adjustDatetimes( |
|
602 | - $datetime_identifier, |
|
603 | - $ticket_identifier, |
|
604 | - $ticket_quantity, |
|
605 | - $at_capacity |
|
606 | - ); |
|
607 | - } |
|
608 | - } |
|
609 | - return $spaces_allocated; |
|
610 | - } |
|
611 | - |
|
612 | - |
|
613 | - /** |
|
614 | - * subtracts ticket amounts from all datetime reg limits |
|
615 | - * that allow access to the ticket specified, |
|
616 | - * because that ticket could be used |
|
617 | - * to attend any of the datetimes it has access to |
|
618 | - * |
|
619 | - * @param string $datetime_identifier |
|
620 | - * @param string $ticket_identifier |
|
621 | - * @param bool $at_capacity |
|
622 | - * @param int $ticket_quantity |
|
623 | - */ |
|
624 | - private function adjustDatetimes( |
|
625 | - $datetime_identifier, |
|
626 | - $ticket_identifier, |
|
627 | - $ticket_quantity, |
|
628 | - $at_capacity |
|
629 | - ) { |
|
630 | - /** @var array $datetime_tickets */ |
|
631 | - foreach ($this->datetime_tickets as $datetime_ID => $datetime_tickets) { |
|
632 | - if ($datetime_ID !== $datetime_identifier || ! is_array($datetime_tickets)) { |
|
633 | - continue; |
|
634 | - } |
|
635 | - $adjusted = $this->adjustDatetimeSpaces( |
|
636 | - $datetime_ID, |
|
637 | - $ticket_identifier, |
|
638 | - $ticket_quantity |
|
639 | - ); |
|
640 | - // skip to next ticket if nothing changed |
|
641 | - if (! ($adjusted || $at_capacity)) { |
|
642 | - continue; |
|
643 | - } |
|
644 | - // then all of it's tickets are now unavailable |
|
645 | - foreach ($datetime_tickets as $datetime_ticket) { |
|
646 | - if ( |
|
647 | - ($ticket_identifier === $datetime_ticket || $at_capacity) |
|
648 | - && isset($this->ticket_quantities[ $datetime_ticket ]) |
|
649 | - && $this->ticket_quantities[ $datetime_ticket ] > 0 |
|
650 | - ) { |
|
651 | - if ($this->debug) { |
|
652 | - \EEH_Debug_Tools::printr( |
|
653 | - $datetime_ticket, |
|
654 | - ' . . . adjust ticket quantities for', |
|
655 | - __FILE__, |
|
656 | - __LINE__ |
|
657 | - ); |
|
658 | - } |
|
659 | - // if this datetime is at full capacity, set any tracked available quantities to zero |
|
660 | - // otherwise just subtract the ticket quantity |
|
661 | - $new_quantity = $at_capacity |
|
662 | - ? 0 |
|
663 | - : $this->ticket_quantities[ $datetime_ticket ] - $ticket_quantity; |
|
664 | - // don't let ticket quantity go below zero |
|
665 | - $this->ticket_quantities[ $datetime_ticket ] = max($new_quantity, 0); |
|
666 | - if ($this->debug) { |
|
667 | - \EEH_Debug_Tools::printr( |
|
668 | - $at_capacity |
|
669 | - ? "0 because Datetime {$datetime_identifier} is at capacity" |
|
670 | - : "{$this->ticket_quantities[ $datetime_ticket ]}", |
|
671 | - " . . . . {$datetime_ticket} quantity set to ", |
|
672 | - __FILE__, |
|
673 | - __LINE__ |
|
674 | - ); |
|
675 | - } |
|
676 | - } |
|
677 | - // but we also need to adjust spaces for any other datetimes this ticket has access to |
|
678 | - if ($datetime_ticket === $ticket_identifier) { |
|
679 | - if ( |
|
680 | - isset($this->ticket_datetimes[ $datetime_ticket ]) |
|
681 | - && is_array($this->ticket_datetimes[ $datetime_ticket ]) |
|
682 | - ) { |
|
683 | - if ($this->debug) { |
|
684 | - \EEH_Debug_Tools::printr( |
|
685 | - $datetime_ticket, |
|
686 | - ' . . adjust other Datetimes for', |
|
687 | - __FILE__, |
|
688 | - __LINE__ |
|
689 | - ); |
|
690 | - } |
|
691 | - foreach ($this->ticket_datetimes[ $datetime_ticket ] as $datetime) { |
|
692 | - // don't adjust the current datetime twice |
|
693 | - if ($datetime !== $datetime_identifier) { |
|
694 | - $this->adjustDatetimeSpaces( |
|
695 | - $datetime, |
|
696 | - $datetime_ticket, |
|
697 | - $ticket_quantity |
|
698 | - ); |
|
699 | - } |
|
700 | - } |
|
701 | - } |
|
702 | - } |
|
703 | - } |
|
704 | - } |
|
705 | - } |
|
706 | - |
|
707 | - private function adjustDatetimeSpaces($datetime_identifier, $ticket_identifier, $ticket_quantity = 0) |
|
708 | - { |
|
709 | - // does datetime have spaces available? |
|
710 | - // and does the supplied ticket have access to this datetime ? |
|
711 | - if ( |
|
712 | - $this->datetime_spaces[ $datetime_identifier ] > 0 |
|
713 | - && isset($this->datetime_spaces[ $datetime_identifier ], $this->datetime_tickets[ $datetime_identifier ]) |
|
714 | - && in_array($ticket_identifier, $this->datetime_tickets[ $datetime_identifier ], true) |
|
715 | - ) { |
|
716 | - if ($this->debug) { |
|
717 | - \EEH_Debug_Tools::printr($datetime_identifier, ' . . adjust Datetime Spaces for', __FILE__, __LINE__); |
|
718 | - \EEH_Debug_Tools::printr( |
|
719 | - "{$this->datetime_spaces[ $datetime_identifier ]}", |
|
720 | - " . . current {$datetime_identifier} spaces available", |
|
721 | - __FILE__, |
|
722 | - __LINE__ |
|
723 | - ); |
|
724 | - } |
|
725 | - // then decrement the available spaces for the datetime |
|
726 | - $this->datetime_spaces[ $datetime_identifier ] -= $ticket_quantity; |
|
727 | - // but don't let quantities go below zero |
|
728 | - $this->datetime_spaces[ $datetime_identifier ] = max( |
|
729 | - $this->datetime_spaces[ $datetime_identifier ], |
|
730 | - 0 |
|
731 | - ); |
|
732 | - if ($this->debug) { |
|
733 | - \EEH_Debug_Tools::printr( |
|
734 | - "{$ticket_quantity}", |
|
735 | - " . . . {$datetime_identifier} capacity reduced by", |
|
736 | - __FILE__, |
|
737 | - __LINE__ |
|
738 | - ); |
|
739 | - } |
|
740 | - return true; |
|
741 | - } |
|
742 | - return false; |
|
743 | - } |
|
29 | + /** |
|
30 | + * @var EE_Event $event |
|
31 | + */ |
|
32 | + private $event; |
|
33 | + |
|
34 | + /** |
|
35 | + * @var array $datetime_query_params |
|
36 | + */ |
|
37 | + private $datetime_query_params; |
|
38 | + |
|
39 | + /** |
|
40 | + * @var EE_Ticket[] $active_tickets |
|
41 | + */ |
|
42 | + private $active_tickets = array(); |
|
43 | + |
|
44 | + /** |
|
45 | + * @var EE_Datetime[] $datetimes |
|
46 | + */ |
|
47 | + private $datetimes = array(); |
|
48 | + |
|
49 | + /** |
|
50 | + * Array of Ticket IDs grouped by Datetime |
|
51 | + * |
|
52 | + * @var array $datetimes |
|
53 | + */ |
|
54 | + private $datetime_tickets = array(); |
|
55 | + |
|
56 | + /** |
|
57 | + * Max spaces for each Datetime (reg limit - previous sold) |
|
58 | + * |
|
59 | + * @var array $datetime_spaces |
|
60 | + */ |
|
61 | + private $datetime_spaces = array(); |
|
62 | + |
|
63 | + /** |
|
64 | + * Array of Datetime IDs grouped by Ticket |
|
65 | + * |
|
66 | + * @var array[] $ticket_datetimes |
|
67 | + */ |
|
68 | + private $ticket_datetimes = array(); |
|
69 | + |
|
70 | + /** |
|
71 | + * maximum ticket quantities for each ticket (adjusted for reg limit) |
|
72 | + * |
|
73 | + * @var array $ticket_quantities |
|
74 | + */ |
|
75 | + private $ticket_quantities = array(); |
|
76 | + |
|
77 | + /** |
|
78 | + * total quantity of sold and reserved for each ticket |
|
79 | + * |
|
80 | + * @var array $tickets_sold |
|
81 | + */ |
|
82 | + private $tickets_sold = array(); |
|
83 | + |
|
84 | + /** |
|
85 | + * total spaces available across all datetimes |
|
86 | + * |
|
87 | + * @var array $total_spaces |
|
88 | + */ |
|
89 | + private $total_spaces = array(); |
|
90 | + |
|
91 | + /** |
|
92 | + * @var boolean $debug |
|
93 | + */ |
|
94 | + private $debug = false; // true false |
|
95 | + |
|
96 | + /** |
|
97 | + * @var null|int $spaces_remaining |
|
98 | + */ |
|
99 | + private $spaces_remaining; |
|
100 | + |
|
101 | + /** |
|
102 | + * @var null|int $total_spaces_available |
|
103 | + */ |
|
104 | + private $total_spaces_available; |
|
105 | + |
|
106 | + |
|
107 | + /** |
|
108 | + * EventSpacesCalculator constructor. |
|
109 | + * |
|
110 | + * @param EE_Event $event |
|
111 | + * @param array $datetime_query_params |
|
112 | + * @throws EE_Error |
|
113 | + */ |
|
114 | + public function __construct(EE_Event $event, array $datetime_query_params = array()) |
|
115 | + { |
|
116 | + if ($this->debug) { |
|
117 | + \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 1); |
|
118 | + \EEH_Debug_Tools::printr((string) $event->ID(), 'For event', __FILE__, __LINE__); |
|
119 | + } |
|
120 | + $this->event = $event; |
|
121 | + $this->datetime_query_params = $datetime_query_params + array('order_by' => array('DTT_reg_limit' => 'ASC')); |
|
122 | + $this->setHooks(); |
|
123 | + } |
|
124 | + |
|
125 | + |
|
126 | + /** |
|
127 | + * @return void |
|
128 | + */ |
|
129 | + private function setHooks() |
|
130 | + { |
|
131 | + add_action('AHEE__EE_Ticket__increase_sold', array($this, 'clearResults')); |
|
132 | + add_action('AHEE__EE_Ticket__decrease_sold', array($this, 'clearResults')); |
|
133 | + add_action('AHEE__EE_Datetime__increase_sold', array($this, 'clearResults')); |
|
134 | + add_action('AHEE__EE_Datetime__decrease_sold', array($this, 'clearResults')); |
|
135 | + add_action('AHEE__EE_Ticket__increase_reserved', array($this, 'clearResults')); |
|
136 | + add_action('AHEE__EE_Ticket__decrease_reserved', array($this, 'clearResults')); |
|
137 | + add_action('AHEE__EE_Datetime__increase_reserved', array($this, 'clearResults')); |
|
138 | + add_action('AHEE__EE_Datetime__decrease_reserved', array($this, 'clearResults')); |
|
139 | + } |
|
140 | + |
|
141 | + |
|
142 | + /** |
|
143 | + * @return void |
|
144 | + */ |
|
145 | + public function clearResults() |
|
146 | + { |
|
147 | + if ($this->debug) { |
|
148 | + \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 1); |
|
149 | + } |
|
150 | + $this->spaces_remaining = null; |
|
151 | + $this->total_spaces_available = null; |
|
152 | + } |
|
153 | + |
|
154 | + |
|
155 | + /** |
|
156 | + * @return EE_Ticket[] |
|
157 | + * @throws EE_Error |
|
158 | + * @throws InvalidDataTypeException |
|
159 | + * @throws InvalidInterfaceException |
|
160 | + * @throws InvalidArgumentException |
|
161 | + */ |
|
162 | + public function getActiveTickets() |
|
163 | + { |
|
164 | + if (empty($this->active_tickets)) { |
|
165 | + $this->active_tickets = $this->event->tickets( |
|
166 | + array( |
|
167 | + array('TKT_deleted' => false), |
|
168 | + 'order_by' => array('TKT_qty' => 'ASC'), |
|
169 | + ) |
|
170 | + ); |
|
171 | + } |
|
172 | + return $this->active_tickets; |
|
173 | + } |
|
174 | + |
|
175 | + |
|
176 | + /** |
|
177 | + * @param EE_Ticket[] $active_tickets |
|
178 | + * @throws EE_Error |
|
179 | + * @throws DomainException |
|
180 | + * @throws UnexpectedEntityException |
|
181 | + */ |
|
182 | + public function setActiveTickets(array $active_tickets = array()) |
|
183 | + { |
|
184 | + if (! empty($active_tickets)) { |
|
185 | + foreach ($active_tickets as $active_ticket) { |
|
186 | + $this->validateTicket($active_ticket); |
|
187 | + } |
|
188 | + // sort incoming array by ticket quantity (asc) |
|
189 | + usort( |
|
190 | + $active_tickets, |
|
191 | + function (EE_Ticket $a, EE_Ticket $b) { |
|
192 | + if ($a->qty() === $b->qty()) { |
|
193 | + return 0; |
|
194 | + } |
|
195 | + return ($a->qty() < $b->qty()) |
|
196 | + ? -1 |
|
197 | + : 1; |
|
198 | + } |
|
199 | + ); |
|
200 | + } |
|
201 | + $this->active_tickets = $active_tickets; |
|
202 | + } |
|
203 | + |
|
204 | + |
|
205 | + /** |
|
206 | + * @param $ticket |
|
207 | + * @throws DomainException |
|
208 | + * @throws EE_Error |
|
209 | + * @throws UnexpectedEntityException |
|
210 | + */ |
|
211 | + private function validateTicket($ticket) |
|
212 | + { |
|
213 | + if (! $ticket instanceof EE_Ticket) { |
|
214 | + throw new DomainException( |
|
215 | + esc_html__( |
|
216 | + 'Invalid Ticket. Only EE_Ticket objects can be used to calculate event space availability.', |
|
217 | + 'event_espresso' |
|
218 | + ) |
|
219 | + ); |
|
220 | + } |
|
221 | + if ($ticket->get_event_ID() !== $this->event->ID()) { |
|
222 | + throw new DomainException( |
|
223 | + sprintf( |
|
224 | + esc_html__( |
|
225 | + 'An EE_Ticket for Event %1$d was supplied while calculating event space availability for Event %2$d.', |
|
226 | + 'event_espresso' |
|
227 | + ), |
|
228 | + $ticket->get_event_ID(), |
|
229 | + $this->event->ID() |
|
230 | + ) |
|
231 | + ); |
|
232 | + } |
|
233 | + } |
|
234 | + |
|
235 | + |
|
236 | + /** |
|
237 | + * @return EE_Datetime[] |
|
238 | + */ |
|
239 | + public function getDatetimes() |
|
240 | + { |
|
241 | + return $this->datetimes; |
|
242 | + } |
|
243 | + |
|
244 | + |
|
245 | + /** |
|
246 | + * @param EE_Datetime $datetime |
|
247 | + * @throws EE_Error |
|
248 | + * @throws DomainException |
|
249 | + */ |
|
250 | + public function setDatetime(EE_Datetime $datetime) |
|
251 | + { |
|
252 | + if ($datetime->event()->ID() !== $this->event->ID()) { |
|
253 | + throw new DomainException( |
|
254 | + sprintf( |
|
255 | + esc_html__( |
|
256 | + 'An EE_Datetime for Event %1$d was supplied while calculating event space availability for Event %2$d.', |
|
257 | + 'event_espresso' |
|
258 | + ), |
|
259 | + $datetime->event()->ID(), |
|
260 | + $this->event->ID() |
|
261 | + ) |
|
262 | + ); |
|
263 | + } |
|
264 | + $this->datetimes[ $datetime->ID() ] = $datetime; |
|
265 | + } |
|
266 | + |
|
267 | + |
|
268 | + /** |
|
269 | + * calculate spaces remaining based on "saleable" tickets |
|
270 | + * |
|
271 | + * @return float|int |
|
272 | + * @throws EE_Error |
|
273 | + * @throws DomainException |
|
274 | + * @throws UnexpectedEntityException |
|
275 | + * @throws InvalidDataTypeException |
|
276 | + * @throws InvalidInterfaceException |
|
277 | + * @throws InvalidArgumentException |
|
278 | + */ |
|
279 | + public function spacesRemaining() |
|
280 | + { |
|
281 | + if ($this->debug) { |
|
282 | + \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2); |
|
283 | + } |
|
284 | + if ($this->spaces_remaining === null) { |
|
285 | + $this->initialize(); |
|
286 | + $this->spaces_remaining = $this->calculate(); |
|
287 | + } |
|
288 | + return $this->spaces_remaining; |
|
289 | + } |
|
290 | + |
|
291 | + |
|
292 | + /** |
|
293 | + * calculates total available spaces for an event with no regard for sold tickets |
|
294 | + * |
|
295 | + * @return int|float |
|
296 | + * @throws EE_Error |
|
297 | + * @throws DomainException |
|
298 | + * @throws UnexpectedEntityException |
|
299 | + * @throws InvalidDataTypeException |
|
300 | + * @throws InvalidInterfaceException |
|
301 | + * @throws InvalidArgumentException |
|
302 | + */ |
|
303 | + public function totalSpacesAvailable() |
|
304 | + { |
|
305 | + if ($this->debug) { |
|
306 | + \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2); |
|
307 | + } |
|
308 | + if ($this->total_spaces_available === null) { |
|
309 | + $this->initialize(); |
|
310 | + $this->total_spaces_available = $this->calculate(false); |
|
311 | + } |
|
312 | + return $this->total_spaces_available; |
|
313 | + } |
|
314 | + |
|
315 | + |
|
316 | + /** |
|
317 | + * Loops through the active tickets for the event |
|
318 | + * and builds a series of data arrays that will be used for calculating |
|
319 | + * the total maximum available spaces, as well as the spaces remaining. |
|
320 | + * Because ticket quantities affect datetime spaces and vice versa, |
|
321 | + * we need to be constantly updating these data arrays as things change, |
|
322 | + * which is the entire reason for their existence. |
|
323 | + * |
|
324 | + * @throws EE_Error |
|
325 | + * @throws DomainException |
|
326 | + * @throws UnexpectedEntityException |
|
327 | + * @throws InvalidDataTypeException |
|
328 | + * @throws InvalidInterfaceException |
|
329 | + * @throws InvalidArgumentException |
|
330 | + */ |
|
331 | + private function initialize() |
|
332 | + { |
|
333 | + if ($this->debug) { |
|
334 | + \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2); |
|
335 | + } |
|
336 | + $this->datetime_tickets = array(); |
|
337 | + $this->datetime_spaces = array(); |
|
338 | + $this->ticket_datetimes = array(); |
|
339 | + $this->ticket_quantities = array(); |
|
340 | + $this->tickets_sold = array(); |
|
341 | + $this->total_spaces = array(); |
|
342 | + $active_tickets = $this->getActiveTickets(); |
|
343 | + if (! empty($active_tickets)) { |
|
344 | + foreach ($active_tickets as $ticket) { |
|
345 | + $this->validateTicket($ticket); |
|
346 | + // we need to index our data arrays using strings for the purpose of sorting, |
|
347 | + // but we also need them to be unique, so we'll just prepend a letter T to the ID |
|
348 | + $ticket_identifier = "T{$ticket->ID()}"; |
|
349 | + // to start, we'll just consider the raw qty to be the maximum availability for this ticket, |
|
350 | + // unless the ticket is past its "sell until" date, in which case the qty will be 0 |
|
351 | + $max_tickets = $ticket->is_expired() ? 0 : $ticket->qty(); |
|
352 | + // but we'll adjust that after looping over each datetime for the ticket and checking reg limits |
|
353 | + $ticket_datetimes = $ticket->datetimes($this->datetime_query_params); |
|
354 | + foreach ($ticket_datetimes as $datetime) { |
|
355 | + // save all datetimes |
|
356 | + $this->setDatetime($datetime); |
|
357 | + $datetime_identifier = "D{$datetime->ID()}"; |
|
358 | + $reg_limit = $datetime->reg_limit(); |
|
359 | + // ticket quantity can not exceed datetime reg limit |
|
360 | + $max_tickets = min($max_tickets, $reg_limit); |
|
361 | + // as described earlier, because we need to be able to constantly adjust numbers for things, |
|
362 | + // we are going to move all of our data into the following arrays: |
|
363 | + // datetime spaces initially represents the reg limit for each datetime, |
|
364 | + // but this will get adjusted as tickets are accounted for |
|
365 | + $this->datetime_spaces[ $datetime_identifier ] = $reg_limit; |
|
366 | + // just an array of ticket IDs grouped by datetime |
|
367 | + $this->datetime_tickets[ $datetime_identifier ][] = $ticket_identifier; |
|
368 | + // and an array of datetime IDs grouped by ticket |
|
369 | + $this->ticket_datetimes[ $ticket_identifier ][] = $datetime_identifier; |
|
370 | + } |
|
371 | + // total quantity of sold and reserved for each ticket |
|
372 | + $this->tickets_sold[ $ticket_identifier ] = $ticket->sold() + $ticket->reserved(); |
|
373 | + // and the maximum ticket quantities for each ticket (adjusted for reg limit) |
|
374 | + $this->ticket_quantities[ $ticket_identifier ] = $max_tickets; |
|
375 | + } |
|
376 | + } |
|
377 | + // sort datetime spaces by reg limit, but maintain our string indexes |
|
378 | + asort($this->datetime_spaces, SORT_NUMERIC); |
|
379 | + // datetime tickets need to be sorted in the SAME order as the above array... |
|
380 | + // so we'll just use array_merge() to take the structure of datetime_spaces |
|
381 | + // but overwrite all of the data with that from datetime_tickets |
|
382 | + $this->datetime_tickets = array_merge( |
|
383 | + $this->datetime_spaces, |
|
384 | + $this->datetime_tickets |
|
385 | + ); |
|
386 | + if ($this->debug) { |
|
387 | + \EEH_Debug_Tools::printr($this->datetime_spaces, 'datetime_spaces', __FILE__, __LINE__); |
|
388 | + \EEH_Debug_Tools::printr($this->datetime_tickets, 'datetime_tickets', __FILE__, __LINE__); |
|
389 | + \EEH_Debug_Tools::printr($this->ticket_quantities, 'ticket_quantities', __FILE__, __LINE__); |
|
390 | + } |
|
391 | + } |
|
392 | + |
|
393 | + |
|
394 | + /** |
|
395 | + * performs calculations on initialized data |
|
396 | + * |
|
397 | + * @param bool $consider_sold |
|
398 | + * @return int|float |
|
399 | + */ |
|
400 | + private function calculate($consider_sold = true) |
|
401 | + { |
|
402 | + if ($this->debug) { |
|
403 | + \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2); |
|
404 | + \EEH_Debug_Tools::printr($consider_sold, '$consider_sold', __FILE__, __LINE__); |
|
405 | + } |
|
406 | + if ($consider_sold) { |
|
407 | + // subtract amounts sold from all ticket quantities and datetime spaces |
|
408 | + $this->adjustTicketQuantitiesDueToSales(); |
|
409 | + } |
|
410 | + foreach ($this->datetime_tickets as $datetime_identifier => $tickets) { |
|
411 | + $this->trackAvailableSpacesForDatetimes($datetime_identifier, $tickets); |
|
412 | + } |
|
413 | + // total spaces available is just the sum of the spaces available for each datetime |
|
414 | + $spaces_remaining = array_sum($this->total_spaces); |
|
415 | + if ($this->debug) { |
|
416 | + \EEH_Debug_Tools::printr($this->total_spaces, '$this->total_spaces', __FILE__, __LINE__); |
|
417 | + \EEH_Debug_Tools::printr($this->tickets_sold, '$this->tickets_sold', __FILE__, __LINE__); |
|
418 | + \EEH_Debug_Tools::printr($spaces_remaining, '$spaces_remaining', __FILE__, __LINE__); |
|
419 | + } |
|
420 | + return $spaces_remaining; |
|
421 | + } |
|
422 | + |
|
423 | + |
|
424 | + /** |
|
425 | + * subtracts amount of tickets sold from ticket quantities and datetime spaces |
|
426 | + */ |
|
427 | + private function adjustTicketQuantitiesDueToSales() |
|
428 | + { |
|
429 | + if ($this->debug) { |
|
430 | + \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2); |
|
431 | + } |
|
432 | + foreach ($this->tickets_sold as $ticket_identifier => $tickets_sold) { |
|
433 | + if (isset($this->ticket_quantities[ $ticket_identifier ])) { |
|
434 | + $this->ticket_quantities[ $ticket_identifier ] -= $tickets_sold; |
|
435 | + // don't let values go below zero |
|
436 | + $this->ticket_quantities[ $ticket_identifier ] = max( |
|
437 | + $this->ticket_quantities[ $ticket_identifier ], |
|
438 | + 0 |
|
439 | + ); |
|
440 | + if ($this->debug) { |
|
441 | + \EEH_Debug_Tools::printr( |
|
442 | + "{$tickets_sold} sales for ticket {$ticket_identifier} ", |
|
443 | + 'subtracting', |
|
444 | + __FILE__, |
|
445 | + __LINE__ |
|
446 | + ); |
|
447 | + } |
|
448 | + } |
|
449 | + if ( |
|
450 | + isset($this->ticket_datetimes[ $ticket_identifier ]) |
|
451 | + && is_array($this->ticket_datetimes[ $ticket_identifier ]) |
|
452 | + ) { |
|
453 | + foreach ($this->ticket_datetimes[ $ticket_identifier ] as $ticket_datetime) { |
|
454 | + if (isset($this->ticket_quantities[ $ticket_identifier ])) { |
|
455 | + $this->datetime_spaces[ $ticket_datetime ] -= $tickets_sold; |
|
456 | + // don't let values go below zero |
|
457 | + $this->datetime_spaces[ $ticket_datetime ] = max( |
|
458 | + $this->datetime_spaces[ $ticket_datetime ], |
|
459 | + 0 |
|
460 | + ); |
|
461 | + if ($this->debug) { |
|
462 | + \EEH_Debug_Tools::printr( |
|
463 | + "{$tickets_sold} sales for datetime {$ticket_datetime} ", |
|
464 | + 'subtracting', |
|
465 | + __FILE__, |
|
466 | + __LINE__ |
|
467 | + ); |
|
468 | + } |
|
469 | + } |
|
470 | + } |
|
471 | + } |
|
472 | + } |
|
473 | + } |
|
474 | + |
|
475 | + |
|
476 | + /** |
|
477 | + * @param string $datetime_identifier |
|
478 | + * @param array $tickets |
|
479 | + */ |
|
480 | + private function trackAvailableSpacesForDatetimes($datetime_identifier, array $tickets) |
|
481 | + { |
|
482 | + // make sure a reg limit is set for the datetime |
|
483 | + $reg_limit = isset($this->datetime_spaces[ $datetime_identifier ]) |
|
484 | + ? $this->datetime_spaces[ $datetime_identifier ] |
|
485 | + : 0; |
|
486 | + // and bail if it is not |
|
487 | + if (! $reg_limit) { |
|
488 | + if ($this->debug) { |
|
489 | + \EEH_Debug_Tools::printr('AT CAPACITY', " . {$datetime_identifier}", __FILE__, __LINE__); |
|
490 | + } |
|
491 | + return; |
|
492 | + } |
|
493 | + if ($this->debug) { |
|
494 | + \EEH_Debug_Tools::printr($datetime_identifier, '* $datetime_identifier', __FILE__, __LINE__, 1); |
|
495 | + \EEH_Debug_Tools::printr( |
|
496 | + "{$reg_limit}", |
|
497 | + 'REG LIMIT', |
|
498 | + __FILE__, |
|
499 | + __LINE__ |
|
500 | + ); |
|
501 | + } |
|
502 | + // number of allocated spaces always starts at zero |
|
503 | + $spaces_allocated = 0; |
|
504 | + $this->total_spaces[ $datetime_identifier ] = 0; |
|
505 | + foreach ($tickets as $ticket_identifier) { |
|
506 | + $spaces_allocated = $this->calculateAvailableSpacesForTicket( |
|
507 | + $datetime_identifier, |
|
508 | + $reg_limit, |
|
509 | + $ticket_identifier, |
|
510 | + $spaces_allocated |
|
511 | + ); |
|
512 | + } |
|
513 | + // spaces can't be negative |
|
514 | + $spaces_allocated = max($spaces_allocated, 0); |
|
515 | + if ($spaces_allocated) { |
|
516 | + // track any non-zero values |
|
517 | + $this->total_spaces[ $datetime_identifier ] += $spaces_allocated; |
|
518 | + if ($this->debug) { |
|
519 | + \EEH_Debug_Tools::printr((string) $spaces_allocated, ' . $spaces_allocated: ', __FILE__, __LINE__); |
|
520 | + } |
|
521 | + } else { |
|
522 | + if ($this->debug) { |
|
523 | + \EEH_Debug_Tools::printr(' ', ' . NO TICKETS AVAILABLE FOR DATETIME', __FILE__, __LINE__); |
|
524 | + } |
|
525 | + } |
|
526 | + if ($this->debug) { |
|
527 | + \EEH_Debug_Tools::printr( |
|
528 | + $this->total_spaces[ $datetime_identifier ], |
|
529 | + '$total_spaces', |
|
530 | + __FILE__, |
|
531 | + __LINE__ |
|
532 | + ); |
|
533 | + \EEH_Debug_Tools::printr($this->ticket_quantities, '$ticket_quantities', __FILE__, __LINE__); |
|
534 | + \EEH_Debug_Tools::printr($this->datetime_spaces, 'datetime_spaces', __FILE__, __LINE__); |
|
535 | + } |
|
536 | + } |
|
537 | + |
|
538 | + |
|
539 | + /** |
|
540 | + * @param string $datetime_identifier |
|
541 | + * @param int $reg_limit |
|
542 | + * @param string $ticket_identifier |
|
543 | + * @param int $spaces_allocated |
|
544 | + * @return int |
|
545 | + */ |
|
546 | + private function calculateAvailableSpacesForTicket( |
|
547 | + $datetime_identifier, |
|
548 | + $reg_limit, |
|
549 | + $ticket_identifier, |
|
550 | + $spaces_allocated |
|
551 | + ) { |
|
552 | + // make sure ticket quantity is set |
|
553 | + $ticket_quantity = isset($this->ticket_quantities[ $ticket_identifier ]) |
|
554 | + ? $this->ticket_quantities[ $ticket_identifier ] |
|
555 | + : 0; |
|
556 | + if ($this->debug) { |
|
557 | + \EEH_Debug_Tools::printr("{$spaces_allocated}", '$spaces_allocated', __FILE__, __LINE__); |
|
558 | + \EEH_Debug_Tools::printr( |
|
559 | + "{$ticket_quantity}", |
|
560 | + "ticket $ticket_identifier quantity: ", |
|
561 | + __FILE__, |
|
562 | + __LINE__, |
|
563 | + 2 |
|
564 | + ); |
|
565 | + } |
|
566 | + if ($ticket_quantity) { |
|
567 | + if ($this->debug) { |
|
568 | + \EEH_Debug_Tools::printr( |
|
569 | + ($spaces_allocated <= $reg_limit) |
|
570 | + ? 'true' |
|
571 | + : 'false', |
|
572 | + ' . spaces_allocated <= reg_limit = ', |
|
573 | + __FILE__, |
|
574 | + __LINE__ |
|
575 | + ); |
|
576 | + } |
|
577 | + // if the datetime is NOT at full capacity yet |
|
578 | + if ($spaces_allocated <= $reg_limit) { |
|
579 | + // then the maximum ticket quantity we can allocate is the lowest value of either: |
|
580 | + // the number of remaining spaces for the datetime, which is the limit - spaces already taken |
|
581 | + // or the maximum ticket quantity |
|
582 | + $ticket_quantity = min($reg_limit - $spaces_allocated, $ticket_quantity); |
|
583 | + // adjust the available quantity in our tracking array |
|
584 | + $this->ticket_quantities[ $ticket_identifier ] -= $ticket_quantity; |
|
585 | + // and increment spaces allocated for this datetime |
|
586 | + $spaces_allocated += $ticket_quantity; |
|
587 | + $at_capacity = $spaces_allocated >= $reg_limit; |
|
588 | + if ($this->debug) { |
|
589 | + \EEH_Debug_Tools::printr( |
|
590 | + "{$ticket_quantity} {$ticket_identifier} tickets", |
|
591 | + ' > > allocate ', |
|
592 | + __FILE__, |
|
593 | + __LINE__, |
|
594 | + 3 |
|
595 | + ); |
|
596 | + if ($at_capacity) { |
|
597 | + \EEH_Debug_Tools::printr('AT CAPACITY', " . {$datetime_identifier}", __FILE__, __LINE__, 3); |
|
598 | + } |
|
599 | + } |
|
600 | + // now adjust all other datetimes that allow access to this ticket |
|
601 | + $this->adjustDatetimes( |
|
602 | + $datetime_identifier, |
|
603 | + $ticket_identifier, |
|
604 | + $ticket_quantity, |
|
605 | + $at_capacity |
|
606 | + ); |
|
607 | + } |
|
608 | + } |
|
609 | + return $spaces_allocated; |
|
610 | + } |
|
611 | + |
|
612 | + |
|
613 | + /** |
|
614 | + * subtracts ticket amounts from all datetime reg limits |
|
615 | + * that allow access to the ticket specified, |
|
616 | + * because that ticket could be used |
|
617 | + * to attend any of the datetimes it has access to |
|
618 | + * |
|
619 | + * @param string $datetime_identifier |
|
620 | + * @param string $ticket_identifier |
|
621 | + * @param bool $at_capacity |
|
622 | + * @param int $ticket_quantity |
|
623 | + */ |
|
624 | + private function adjustDatetimes( |
|
625 | + $datetime_identifier, |
|
626 | + $ticket_identifier, |
|
627 | + $ticket_quantity, |
|
628 | + $at_capacity |
|
629 | + ) { |
|
630 | + /** @var array $datetime_tickets */ |
|
631 | + foreach ($this->datetime_tickets as $datetime_ID => $datetime_tickets) { |
|
632 | + if ($datetime_ID !== $datetime_identifier || ! is_array($datetime_tickets)) { |
|
633 | + continue; |
|
634 | + } |
|
635 | + $adjusted = $this->adjustDatetimeSpaces( |
|
636 | + $datetime_ID, |
|
637 | + $ticket_identifier, |
|
638 | + $ticket_quantity |
|
639 | + ); |
|
640 | + // skip to next ticket if nothing changed |
|
641 | + if (! ($adjusted || $at_capacity)) { |
|
642 | + continue; |
|
643 | + } |
|
644 | + // then all of it's tickets are now unavailable |
|
645 | + foreach ($datetime_tickets as $datetime_ticket) { |
|
646 | + if ( |
|
647 | + ($ticket_identifier === $datetime_ticket || $at_capacity) |
|
648 | + && isset($this->ticket_quantities[ $datetime_ticket ]) |
|
649 | + && $this->ticket_quantities[ $datetime_ticket ] > 0 |
|
650 | + ) { |
|
651 | + if ($this->debug) { |
|
652 | + \EEH_Debug_Tools::printr( |
|
653 | + $datetime_ticket, |
|
654 | + ' . . . adjust ticket quantities for', |
|
655 | + __FILE__, |
|
656 | + __LINE__ |
|
657 | + ); |
|
658 | + } |
|
659 | + // if this datetime is at full capacity, set any tracked available quantities to zero |
|
660 | + // otherwise just subtract the ticket quantity |
|
661 | + $new_quantity = $at_capacity |
|
662 | + ? 0 |
|
663 | + : $this->ticket_quantities[ $datetime_ticket ] - $ticket_quantity; |
|
664 | + // don't let ticket quantity go below zero |
|
665 | + $this->ticket_quantities[ $datetime_ticket ] = max($new_quantity, 0); |
|
666 | + if ($this->debug) { |
|
667 | + \EEH_Debug_Tools::printr( |
|
668 | + $at_capacity |
|
669 | + ? "0 because Datetime {$datetime_identifier} is at capacity" |
|
670 | + : "{$this->ticket_quantities[ $datetime_ticket ]}", |
|
671 | + " . . . . {$datetime_ticket} quantity set to ", |
|
672 | + __FILE__, |
|
673 | + __LINE__ |
|
674 | + ); |
|
675 | + } |
|
676 | + } |
|
677 | + // but we also need to adjust spaces for any other datetimes this ticket has access to |
|
678 | + if ($datetime_ticket === $ticket_identifier) { |
|
679 | + if ( |
|
680 | + isset($this->ticket_datetimes[ $datetime_ticket ]) |
|
681 | + && is_array($this->ticket_datetimes[ $datetime_ticket ]) |
|
682 | + ) { |
|
683 | + if ($this->debug) { |
|
684 | + \EEH_Debug_Tools::printr( |
|
685 | + $datetime_ticket, |
|
686 | + ' . . adjust other Datetimes for', |
|
687 | + __FILE__, |
|
688 | + __LINE__ |
|
689 | + ); |
|
690 | + } |
|
691 | + foreach ($this->ticket_datetimes[ $datetime_ticket ] as $datetime) { |
|
692 | + // don't adjust the current datetime twice |
|
693 | + if ($datetime !== $datetime_identifier) { |
|
694 | + $this->adjustDatetimeSpaces( |
|
695 | + $datetime, |
|
696 | + $datetime_ticket, |
|
697 | + $ticket_quantity |
|
698 | + ); |
|
699 | + } |
|
700 | + } |
|
701 | + } |
|
702 | + } |
|
703 | + } |
|
704 | + } |
|
705 | + } |
|
706 | + |
|
707 | + private function adjustDatetimeSpaces($datetime_identifier, $ticket_identifier, $ticket_quantity = 0) |
|
708 | + { |
|
709 | + // does datetime have spaces available? |
|
710 | + // and does the supplied ticket have access to this datetime ? |
|
711 | + if ( |
|
712 | + $this->datetime_spaces[ $datetime_identifier ] > 0 |
|
713 | + && isset($this->datetime_spaces[ $datetime_identifier ], $this->datetime_tickets[ $datetime_identifier ]) |
|
714 | + && in_array($ticket_identifier, $this->datetime_tickets[ $datetime_identifier ], true) |
|
715 | + ) { |
|
716 | + if ($this->debug) { |
|
717 | + \EEH_Debug_Tools::printr($datetime_identifier, ' . . adjust Datetime Spaces for', __FILE__, __LINE__); |
|
718 | + \EEH_Debug_Tools::printr( |
|
719 | + "{$this->datetime_spaces[ $datetime_identifier ]}", |
|
720 | + " . . current {$datetime_identifier} spaces available", |
|
721 | + __FILE__, |
|
722 | + __LINE__ |
|
723 | + ); |
|
724 | + } |
|
725 | + // then decrement the available spaces for the datetime |
|
726 | + $this->datetime_spaces[ $datetime_identifier ] -= $ticket_quantity; |
|
727 | + // but don't let quantities go below zero |
|
728 | + $this->datetime_spaces[ $datetime_identifier ] = max( |
|
729 | + $this->datetime_spaces[ $datetime_identifier ], |
|
730 | + 0 |
|
731 | + ); |
|
732 | + if ($this->debug) { |
|
733 | + \EEH_Debug_Tools::printr( |
|
734 | + "{$ticket_quantity}", |
|
735 | + " . . . {$datetime_identifier} capacity reduced by", |
|
736 | + __FILE__, |
|
737 | + __LINE__ |
|
738 | + ); |
|
739 | + } |
|
740 | + return true; |
|
741 | + } |
|
742 | + return false; |
|
743 | + } |
|
744 | 744 | } |
@@ -181,14 +181,14 @@ discard block |
||
181 | 181 | */ |
182 | 182 | public function setActiveTickets(array $active_tickets = array()) |
183 | 183 | { |
184 | - if (! empty($active_tickets)) { |
|
184 | + if ( ! empty($active_tickets)) { |
|
185 | 185 | foreach ($active_tickets as $active_ticket) { |
186 | 186 | $this->validateTicket($active_ticket); |
187 | 187 | } |
188 | 188 | // sort incoming array by ticket quantity (asc) |
189 | 189 | usort( |
190 | 190 | $active_tickets, |
191 | - function (EE_Ticket $a, EE_Ticket $b) { |
|
191 | + function(EE_Ticket $a, EE_Ticket $b) { |
|
192 | 192 | if ($a->qty() === $b->qty()) { |
193 | 193 | return 0; |
194 | 194 | } |
@@ -210,7 +210,7 @@ discard block |
||
210 | 210 | */ |
211 | 211 | private function validateTicket($ticket) |
212 | 212 | { |
213 | - if (! $ticket instanceof EE_Ticket) { |
|
213 | + if ( ! $ticket instanceof EE_Ticket) { |
|
214 | 214 | throw new DomainException( |
215 | 215 | esc_html__( |
216 | 216 | 'Invalid Ticket. Only EE_Ticket objects can be used to calculate event space availability.', |
@@ -261,7 +261,7 @@ discard block |
||
261 | 261 | ) |
262 | 262 | ); |
263 | 263 | } |
264 | - $this->datetimes[ $datetime->ID() ] = $datetime; |
|
264 | + $this->datetimes[$datetime->ID()] = $datetime; |
|
265 | 265 | } |
266 | 266 | |
267 | 267 | |
@@ -340,7 +340,7 @@ discard block |
||
340 | 340 | $this->tickets_sold = array(); |
341 | 341 | $this->total_spaces = array(); |
342 | 342 | $active_tickets = $this->getActiveTickets(); |
343 | - if (! empty($active_tickets)) { |
|
343 | + if ( ! empty($active_tickets)) { |
|
344 | 344 | foreach ($active_tickets as $ticket) { |
345 | 345 | $this->validateTicket($ticket); |
346 | 346 | // we need to index our data arrays using strings for the purpose of sorting, |
@@ -362,16 +362,16 @@ discard block |
||
362 | 362 | // we are going to move all of our data into the following arrays: |
363 | 363 | // datetime spaces initially represents the reg limit for each datetime, |
364 | 364 | // but this will get adjusted as tickets are accounted for |
365 | - $this->datetime_spaces[ $datetime_identifier ] = $reg_limit; |
|
365 | + $this->datetime_spaces[$datetime_identifier] = $reg_limit; |
|
366 | 366 | // just an array of ticket IDs grouped by datetime |
367 | - $this->datetime_tickets[ $datetime_identifier ][] = $ticket_identifier; |
|
367 | + $this->datetime_tickets[$datetime_identifier][] = $ticket_identifier; |
|
368 | 368 | // and an array of datetime IDs grouped by ticket |
369 | - $this->ticket_datetimes[ $ticket_identifier ][] = $datetime_identifier; |
|
369 | + $this->ticket_datetimes[$ticket_identifier][] = $datetime_identifier; |
|
370 | 370 | } |
371 | 371 | // total quantity of sold and reserved for each ticket |
372 | - $this->tickets_sold[ $ticket_identifier ] = $ticket->sold() + $ticket->reserved(); |
|
372 | + $this->tickets_sold[$ticket_identifier] = $ticket->sold() + $ticket->reserved(); |
|
373 | 373 | // and the maximum ticket quantities for each ticket (adjusted for reg limit) |
374 | - $this->ticket_quantities[ $ticket_identifier ] = $max_tickets; |
|
374 | + $this->ticket_quantities[$ticket_identifier] = $max_tickets; |
|
375 | 375 | } |
376 | 376 | } |
377 | 377 | // sort datetime spaces by reg limit, but maintain our string indexes |
@@ -430,11 +430,11 @@ discard block |
||
430 | 430 | \EEH_Debug_Tools::printr(__FUNCTION__, __CLASS__, __FILE__, __LINE__, 2); |
431 | 431 | } |
432 | 432 | foreach ($this->tickets_sold as $ticket_identifier => $tickets_sold) { |
433 | - if (isset($this->ticket_quantities[ $ticket_identifier ])) { |
|
434 | - $this->ticket_quantities[ $ticket_identifier ] -= $tickets_sold; |
|
433 | + if (isset($this->ticket_quantities[$ticket_identifier])) { |
|
434 | + $this->ticket_quantities[$ticket_identifier] -= $tickets_sold; |
|
435 | 435 | // don't let values go below zero |
436 | - $this->ticket_quantities[ $ticket_identifier ] = max( |
|
437 | - $this->ticket_quantities[ $ticket_identifier ], |
|
436 | + $this->ticket_quantities[$ticket_identifier] = max( |
|
437 | + $this->ticket_quantities[$ticket_identifier], |
|
438 | 438 | 0 |
439 | 439 | ); |
440 | 440 | if ($this->debug) { |
@@ -447,15 +447,15 @@ discard block |
||
447 | 447 | } |
448 | 448 | } |
449 | 449 | if ( |
450 | - isset($this->ticket_datetimes[ $ticket_identifier ]) |
|
451 | - && is_array($this->ticket_datetimes[ $ticket_identifier ]) |
|
450 | + isset($this->ticket_datetimes[$ticket_identifier]) |
|
451 | + && is_array($this->ticket_datetimes[$ticket_identifier]) |
|
452 | 452 | ) { |
453 | - foreach ($this->ticket_datetimes[ $ticket_identifier ] as $ticket_datetime) { |
|
454 | - if (isset($this->ticket_quantities[ $ticket_identifier ])) { |
|
455 | - $this->datetime_spaces[ $ticket_datetime ] -= $tickets_sold; |
|
453 | + foreach ($this->ticket_datetimes[$ticket_identifier] as $ticket_datetime) { |
|
454 | + if (isset($this->ticket_quantities[$ticket_identifier])) { |
|
455 | + $this->datetime_spaces[$ticket_datetime] -= $tickets_sold; |
|
456 | 456 | // don't let values go below zero |
457 | - $this->datetime_spaces[ $ticket_datetime ] = max( |
|
458 | - $this->datetime_spaces[ $ticket_datetime ], |
|
457 | + $this->datetime_spaces[$ticket_datetime] = max( |
|
458 | + $this->datetime_spaces[$ticket_datetime], |
|
459 | 459 | 0 |
460 | 460 | ); |
461 | 461 | if ($this->debug) { |
@@ -480,11 +480,11 @@ discard block |
||
480 | 480 | private function trackAvailableSpacesForDatetimes($datetime_identifier, array $tickets) |
481 | 481 | { |
482 | 482 | // make sure a reg limit is set for the datetime |
483 | - $reg_limit = isset($this->datetime_spaces[ $datetime_identifier ]) |
|
484 | - ? $this->datetime_spaces[ $datetime_identifier ] |
|
483 | + $reg_limit = isset($this->datetime_spaces[$datetime_identifier]) |
|
484 | + ? $this->datetime_spaces[$datetime_identifier] |
|
485 | 485 | : 0; |
486 | 486 | // and bail if it is not |
487 | - if (! $reg_limit) { |
|
487 | + if ( ! $reg_limit) { |
|
488 | 488 | if ($this->debug) { |
489 | 489 | \EEH_Debug_Tools::printr('AT CAPACITY', " . {$datetime_identifier}", __FILE__, __LINE__); |
490 | 490 | } |
@@ -501,7 +501,7 @@ discard block |
||
501 | 501 | } |
502 | 502 | // number of allocated spaces always starts at zero |
503 | 503 | $spaces_allocated = 0; |
504 | - $this->total_spaces[ $datetime_identifier ] = 0; |
|
504 | + $this->total_spaces[$datetime_identifier] = 0; |
|
505 | 505 | foreach ($tickets as $ticket_identifier) { |
506 | 506 | $spaces_allocated = $this->calculateAvailableSpacesForTicket( |
507 | 507 | $datetime_identifier, |
@@ -514,7 +514,7 @@ discard block |
||
514 | 514 | $spaces_allocated = max($spaces_allocated, 0); |
515 | 515 | if ($spaces_allocated) { |
516 | 516 | // track any non-zero values |
517 | - $this->total_spaces[ $datetime_identifier ] += $spaces_allocated; |
|
517 | + $this->total_spaces[$datetime_identifier] += $spaces_allocated; |
|
518 | 518 | if ($this->debug) { |
519 | 519 | \EEH_Debug_Tools::printr((string) $spaces_allocated, ' . $spaces_allocated: ', __FILE__, __LINE__); |
520 | 520 | } |
@@ -525,7 +525,7 @@ discard block |
||
525 | 525 | } |
526 | 526 | if ($this->debug) { |
527 | 527 | \EEH_Debug_Tools::printr( |
528 | - $this->total_spaces[ $datetime_identifier ], |
|
528 | + $this->total_spaces[$datetime_identifier], |
|
529 | 529 | '$total_spaces', |
530 | 530 | __FILE__, |
531 | 531 | __LINE__ |
@@ -550,8 +550,8 @@ discard block |
||
550 | 550 | $spaces_allocated |
551 | 551 | ) { |
552 | 552 | // make sure ticket quantity is set |
553 | - $ticket_quantity = isset($this->ticket_quantities[ $ticket_identifier ]) |
|
554 | - ? $this->ticket_quantities[ $ticket_identifier ] |
|
553 | + $ticket_quantity = isset($this->ticket_quantities[$ticket_identifier]) |
|
554 | + ? $this->ticket_quantities[$ticket_identifier] |
|
555 | 555 | : 0; |
556 | 556 | if ($this->debug) { |
557 | 557 | \EEH_Debug_Tools::printr("{$spaces_allocated}", '$spaces_allocated', __FILE__, __LINE__); |
@@ -581,7 +581,7 @@ discard block |
||
581 | 581 | // or the maximum ticket quantity |
582 | 582 | $ticket_quantity = min($reg_limit - $spaces_allocated, $ticket_quantity); |
583 | 583 | // adjust the available quantity in our tracking array |
584 | - $this->ticket_quantities[ $ticket_identifier ] -= $ticket_quantity; |
|
584 | + $this->ticket_quantities[$ticket_identifier] -= $ticket_quantity; |
|
585 | 585 | // and increment spaces allocated for this datetime |
586 | 586 | $spaces_allocated += $ticket_quantity; |
587 | 587 | $at_capacity = $spaces_allocated >= $reg_limit; |
@@ -638,15 +638,15 @@ discard block |
||
638 | 638 | $ticket_quantity |
639 | 639 | ); |
640 | 640 | // skip to next ticket if nothing changed |
641 | - if (! ($adjusted || $at_capacity)) { |
|
641 | + if ( ! ($adjusted || $at_capacity)) { |
|
642 | 642 | continue; |
643 | 643 | } |
644 | 644 | // then all of it's tickets are now unavailable |
645 | 645 | foreach ($datetime_tickets as $datetime_ticket) { |
646 | 646 | if ( |
647 | 647 | ($ticket_identifier === $datetime_ticket || $at_capacity) |
648 | - && isset($this->ticket_quantities[ $datetime_ticket ]) |
|
649 | - && $this->ticket_quantities[ $datetime_ticket ] > 0 |
|
648 | + && isset($this->ticket_quantities[$datetime_ticket]) |
|
649 | + && $this->ticket_quantities[$datetime_ticket] > 0 |
|
650 | 650 | ) { |
651 | 651 | if ($this->debug) { |
652 | 652 | \EEH_Debug_Tools::printr( |
@@ -660,14 +660,14 @@ discard block |
||
660 | 660 | // otherwise just subtract the ticket quantity |
661 | 661 | $new_quantity = $at_capacity |
662 | 662 | ? 0 |
663 | - : $this->ticket_quantities[ $datetime_ticket ] - $ticket_quantity; |
|
663 | + : $this->ticket_quantities[$datetime_ticket] - $ticket_quantity; |
|
664 | 664 | // don't let ticket quantity go below zero |
665 | - $this->ticket_quantities[ $datetime_ticket ] = max($new_quantity, 0); |
|
665 | + $this->ticket_quantities[$datetime_ticket] = max($new_quantity, 0); |
|
666 | 666 | if ($this->debug) { |
667 | 667 | \EEH_Debug_Tools::printr( |
668 | 668 | $at_capacity |
669 | 669 | ? "0 because Datetime {$datetime_identifier} is at capacity" |
670 | - : "{$this->ticket_quantities[ $datetime_ticket ]}", |
|
670 | + : "{$this->ticket_quantities[$datetime_ticket]}", |
|
671 | 671 | " . . . . {$datetime_ticket} quantity set to ", |
672 | 672 | __FILE__, |
673 | 673 | __LINE__ |
@@ -677,8 +677,8 @@ discard block |
||
677 | 677 | // but we also need to adjust spaces for any other datetimes this ticket has access to |
678 | 678 | if ($datetime_ticket === $ticket_identifier) { |
679 | 679 | if ( |
680 | - isset($this->ticket_datetimes[ $datetime_ticket ]) |
|
681 | - && is_array($this->ticket_datetimes[ $datetime_ticket ]) |
|
680 | + isset($this->ticket_datetimes[$datetime_ticket]) |
|
681 | + && is_array($this->ticket_datetimes[$datetime_ticket]) |
|
682 | 682 | ) { |
683 | 683 | if ($this->debug) { |
684 | 684 | \EEH_Debug_Tools::printr( |
@@ -688,7 +688,7 @@ discard block |
||
688 | 688 | __LINE__ |
689 | 689 | ); |
690 | 690 | } |
691 | - foreach ($this->ticket_datetimes[ $datetime_ticket ] as $datetime) { |
|
691 | + foreach ($this->ticket_datetimes[$datetime_ticket] as $datetime) { |
|
692 | 692 | // don't adjust the current datetime twice |
693 | 693 | if ($datetime !== $datetime_identifier) { |
694 | 694 | $this->adjustDatetimeSpaces( |
@@ -709,24 +709,24 @@ discard block |
||
709 | 709 | // does datetime have spaces available? |
710 | 710 | // and does the supplied ticket have access to this datetime ? |
711 | 711 | if ( |
712 | - $this->datetime_spaces[ $datetime_identifier ] > 0 |
|
713 | - && isset($this->datetime_spaces[ $datetime_identifier ], $this->datetime_tickets[ $datetime_identifier ]) |
|
714 | - && in_array($ticket_identifier, $this->datetime_tickets[ $datetime_identifier ], true) |
|
712 | + $this->datetime_spaces[$datetime_identifier] > 0 |
|
713 | + && isset($this->datetime_spaces[$datetime_identifier], $this->datetime_tickets[$datetime_identifier]) |
|
714 | + && in_array($ticket_identifier, $this->datetime_tickets[$datetime_identifier], true) |
|
715 | 715 | ) { |
716 | 716 | if ($this->debug) { |
717 | 717 | \EEH_Debug_Tools::printr($datetime_identifier, ' . . adjust Datetime Spaces for', __FILE__, __LINE__); |
718 | 718 | \EEH_Debug_Tools::printr( |
719 | - "{$this->datetime_spaces[ $datetime_identifier ]}", |
|
719 | + "{$this->datetime_spaces[$datetime_identifier]}", |
|
720 | 720 | " . . current {$datetime_identifier} spaces available", |
721 | 721 | __FILE__, |
722 | 722 | __LINE__ |
723 | 723 | ); |
724 | 724 | } |
725 | 725 | // then decrement the available spaces for the datetime |
726 | - $this->datetime_spaces[ $datetime_identifier ] -= $ticket_quantity; |
|
726 | + $this->datetime_spaces[$datetime_identifier] -= $ticket_quantity; |
|
727 | 727 | // but don't let quantities go below zero |
728 | - $this->datetime_spaces[ $datetime_identifier ] = max( |
|
729 | - $this->datetime_spaces[ $datetime_identifier ], |
|
728 | + $this->datetime_spaces[$datetime_identifier] = max( |
|
729 | + $this->datetime_spaces[$datetime_identifier], |
|
730 | 730 | 0 |
731 | 731 | ); |
732 | 732 | if ($this->debug) { |
@@ -64,6 +64,9 @@ |
||
64 | 64 | } |
65 | 65 | |
66 | 66 | |
67 | + /** |
|
68 | + * @param string $argument_label |
|
69 | + */ |
|
67 | 70 | private function throwValidationException($argument_label, $argument_value) |
68 | 71 | { |
69 | 72 | throw new InvalidArgumentException( |
@@ -11,109 +11,109 @@ |
||
11 | 11 | class EE_Number_Input_Display_Strategy extends EE_Display_Strategy_Base |
12 | 12 | { |
13 | 13 | |
14 | - /** |
|
15 | - * minimum value for number field |
|
16 | - * |
|
17 | - * @var int|null $min |
|
18 | - */ |
|
19 | - protected $min; |
|
14 | + /** |
|
15 | + * minimum value for number field |
|
16 | + * |
|
17 | + * @var int|null $min |
|
18 | + */ |
|
19 | + protected $min; |
|
20 | 20 | |
21 | - /** |
|
22 | - * maximum value for number field |
|
23 | - * |
|
24 | - * @var int|null $max |
|
25 | - */ |
|
26 | - protected $max; |
|
21 | + /** |
|
22 | + * maximum value for number field |
|
23 | + * |
|
24 | + * @var int|null $max |
|
25 | + */ |
|
26 | + protected $max; |
|
27 | 27 | |
28 | 28 | |
29 | - /** |
|
30 | - * This is used to set the "step" attribute for the html5 number input. |
|
31 | - * Controls the increments on the input when incrementing or decrementing the value. |
|
32 | - * Note: Although the step attribute allows for the string "any" to be used, Firefox and Chrome will interpret that |
|
33 | - * to increment by 1. So although "any" is accepted as a value, it is converted to 1. |
|
34 | - * @var float |
|
35 | - */ |
|
36 | - protected $step; |
|
29 | + /** |
|
30 | + * This is used to set the "step" attribute for the html5 number input. |
|
31 | + * Controls the increments on the input when incrementing or decrementing the value. |
|
32 | + * Note: Although the step attribute allows for the string "any" to be used, Firefox and Chrome will interpret that |
|
33 | + * to increment by 1. So although "any" is accepted as a value, it is converted to 1. |
|
34 | + * @var float |
|
35 | + */ |
|
36 | + protected $step; |
|
37 | 37 | |
38 | 38 | |
39 | - /** |
|
40 | - * EE_Number_Input_Display_Strategy constructor. |
|
41 | - * Null is the default value for the incoming arguments because 0 is a valid value. So we use null |
|
42 | - * to indicate NOT setting this attribute. |
|
43 | - * |
|
44 | - * @param int|null $min |
|
45 | - * @param int|null $max |
|
46 | - * @param int|null $step |
|
47 | - * @throws InvalidArgumentException |
|
48 | - */ |
|
49 | - public function __construct($min = null, $max = null, $step = null) |
|
50 | - { |
|
51 | - $this->min = is_numeric($min) || $min === null |
|
52 | - ? $min |
|
53 | - : $this->throwValidationException('min', $min); |
|
54 | - $this->max = is_numeric($max) || $max === null |
|
55 | - ? $max |
|
56 | - : $this->throwValidationException('max', $max); |
|
57 | - $step = $step === 'any' ? 1 : $step; |
|
58 | - $this->step = is_numeric($step) || $step === null |
|
59 | - ? $step |
|
60 | - : $this->throwValidationException('step', $step); |
|
61 | - } |
|
39 | + /** |
|
40 | + * EE_Number_Input_Display_Strategy constructor. |
|
41 | + * Null is the default value for the incoming arguments because 0 is a valid value. So we use null |
|
42 | + * to indicate NOT setting this attribute. |
|
43 | + * |
|
44 | + * @param int|null $min |
|
45 | + * @param int|null $max |
|
46 | + * @param int|null $step |
|
47 | + * @throws InvalidArgumentException |
|
48 | + */ |
|
49 | + public function __construct($min = null, $max = null, $step = null) |
|
50 | + { |
|
51 | + $this->min = is_numeric($min) || $min === null |
|
52 | + ? $min |
|
53 | + : $this->throwValidationException('min', $min); |
|
54 | + $this->max = is_numeric($max) || $max === null |
|
55 | + ? $max |
|
56 | + : $this->throwValidationException('max', $max); |
|
57 | + $step = $step === 'any' ? 1 : $step; |
|
58 | + $this->step = is_numeric($step) || $step === null |
|
59 | + ? $step |
|
60 | + : $this->throwValidationException('step', $step); |
|
61 | + } |
|
62 | 62 | |
63 | 63 | |
64 | - private function throwValidationException($argument_label, $argument_value) |
|
65 | - { |
|
66 | - throw new InvalidArgumentException( |
|
67 | - sprintf( |
|
68 | - esc_html__( |
|
69 | - 'The %1$s parameter value for %2$s must be numeric or null, %3$s was passed into the constructor.', |
|
70 | - 'event_espresso' |
|
71 | - ), |
|
72 | - $argument_label, |
|
73 | - __CLASS__, |
|
74 | - $argument_value |
|
75 | - ) |
|
76 | - ); |
|
77 | - } |
|
64 | + private function throwValidationException($argument_label, $argument_value) |
|
65 | + { |
|
66 | + throw new InvalidArgumentException( |
|
67 | + sprintf( |
|
68 | + esc_html__( |
|
69 | + 'The %1$s parameter value for %2$s must be numeric or null, %3$s was passed into the constructor.', |
|
70 | + 'event_espresso' |
|
71 | + ), |
|
72 | + $argument_label, |
|
73 | + __CLASS__, |
|
74 | + $argument_value |
|
75 | + ) |
|
76 | + ); |
|
77 | + } |
|
78 | 78 | |
79 | 79 | |
80 | 80 | |
81 | - /** |
|
82 | - * @return string of html to display the field |
|
83 | - */ |
|
84 | - public function display() |
|
85 | - { |
|
86 | - $input = $this->_opening_tag('input'); |
|
87 | - $input .= $this->_attributes_string( |
|
88 | - array_merge( |
|
89 | - $this->_standard_attributes_array(), |
|
90 | - $this->getNumberInputAttributes() |
|
91 | - ) |
|
92 | - ); |
|
93 | - $input .= $this->_close_tag(); |
|
94 | - return $input; |
|
95 | - } |
|
81 | + /** |
|
82 | + * @return string of html to display the field |
|
83 | + */ |
|
84 | + public function display() |
|
85 | + { |
|
86 | + $input = $this->_opening_tag('input'); |
|
87 | + $input .= $this->_attributes_string( |
|
88 | + array_merge( |
|
89 | + $this->_standard_attributes_array(), |
|
90 | + $this->getNumberInputAttributes() |
|
91 | + ) |
|
92 | + ); |
|
93 | + $input .= $this->_close_tag(); |
|
94 | + return $input; |
|
95 | + } |
|
96 | 96 | |
97 | 97 | |
98 | - /** |
|
99 | - * Return the attributes specific to this display strategy |
|
100 | - * @return array |
|
101 | - */ |
|
102 | - private function getNumberInputAttributes() |
|
103 | - { |
|
104 | - $attributes = array( |
|
105 | - 'type' => 'number', |
|
106 | - 'value' => $this->_input->raw_value_in_form() |
|
107 | - ); |
|
108 | - if ($this->min !== null) { |
|
109 | - $attributes['min'] = $this->min; |
|
110 | - } |
|
111 | - if ($this->max !== null) { |
|
112 | - $attributes['max'] = $this->max; |
|
113 | - } |
|
114 | - if ($this->step !== null) { |
|
115 | - $attributes['step'] = $this->step; |
|
116 | - } |
|
117 | - return $attributes; |
|
118 | - } |
|
98 | + /** |
|
99 | + * Return the attributes specific to this display strategy |
|
100 | + * @return array |
|
101 | + */ |
|
102 | + private function getNumberInputAttributes() |
|
103 | + { |
|
104 | + $attributes = array( |
|
105 | + 'type' => 'number', |
|
106 | + 'value' => $this->_input->raw_value_in_form() |
|
107 | + ); |
|
108 | + if ($this->min !== null) { |
|
109 | + $attributes['min'] = $this->min; |
|
110 | + } |
|
111 | + if ($this->max !== null) { |
|
112 | + $attributes['max'] = $this->max; |
|
113 | + } |
|
114 | + if ($this->step !== null) { |
|
115 | + $attributes['step'] = $this->step; |
|
116 | + } |
|
117 | + return $attributes; |
|
118 | + } |
|
119 | 119 | } |
@@ -11,33 +11,33 @@ |
||
11 | 11 | class EE_Float_Input extends EE_Form_Input_Base |
12 | 12 | { |
13 | 13 | |
14 | - /** |
|
15 | - * @param array $input_settings |
|
16 | - * @throws InvalidArgumentException |
|
17 | - */ |
|
18 | - public function __construct($input_settings = array()) |
|
19 | - { |
|
20 | - $this->_set_display_strategy( |
|
21 | - new EE_Number_Input_Display_Strategy( |
|
22 | - isset($input_settings['min_value']) |
|
23 | - ? $input_settings['min_value'] |
|
24 | - : null, |
|
25 | - isset($input_settings['max_value']) |
|
26 | - ? $input_settings['max_value'] |
|
27 | - : null, |
|
28 | - isset($input_settings['step_value']) |
|
29 | - ? $input_settings['step_value'] |
|
30 | - : null |
|
31 | - ) |
|
32 | - ); |
|
33 | - $this->_set_normalization_strategy(new EE_Float_Normalization()); |
|
34 | - $this->_add_validation_strategy( |
|
35 | - new EE_Float_Validation_Strategy( |
|
36 | - isset($input_settings['validation_error_message']) |
|
37 | - ? $input_settings['validation_error_message'] |
|
38 | - : null |
|
39 | - ) |
|
40 | - ); |
|
41 | - parent::__construct($input_settings); |
|
42 | - } |
|
14 | + /** |
|
15 | + * @param array $input_settings |
|
16 | + * @throws InvalidArgumentException |
|
17 | + */ |
|
18 | + public function __construct($input_settings = array()) |
|
19 | + { |
|
20 | + $this->_set_display_strategy( |
|
21 | + new EE_Number_Input_Display_Strategy( |
|
22 | + isset($input_settings['min_value']) |
|
23 | + ? $input_settings['min_value'] |
|
24 | + : null, |
|
25 | + isset($input_settings['max_value']) |
|
26 | + ? $input_settings['max_value'] |
|
27 | + : null, |
|
28 | + isset($input_settings['step_value']) |
|
29 | + ? $input_settings['step_value'] |
|
30 | + : null |
|
31 | + ) |
|
32 | + ); |
|
33 | + $this->_set_normalization_strategy(new EE_Float_Normalization()); |
|
34 | + $this->_add_validation_strategy( |
|
35 | + new EE_Float_Validation_Strategy( |
|
36 | + isset($input_settings['validation_error_message']) |
|
37 | + ? $input_settings['validation_error_message'] |
|
38 | + : null |
|
39 | + ) |
|
40 | + ); |
|
41 | + parent::__construct($input_settings); |
|
42 | + } |
|
43 | 43 | } |
@@ -152,7 +152,7 @@ |
||
152 | 152 | |
153 | 153 | /** |
154 | 154 | * @param EE_Event $item |
155 | - * @return mixed|string |
|
155 | + * @return string |
|
156 | 156 | * @throws EE_Error |
157 | 157 | */ |
158 | 158 | public function column_id(EE_Event $item) |
@@ -15,572 +15,572 @@ |
||
15 | 15 | class Events_Admin_List_Table extends EE_Admin_List_Table |
16 | 16 | { |
17 | 17 | |
18 | - /** |
|
19 | - * @var EE_Datetime |
|
20 | - */ |
|
21 | - private $_dtt; |
|
22 | - |
|
23 | - |
|
24 | - /** |
|
25 | - * Initial setup of data properties for the list table. |
|
26 | - */ |
|
27 | - protected function _setup_data() |
|
28 | - { |
|
29 | - $this->_data = $this->_admin_page->get_events($this->_per_page, $this->_current_page); |
|
30 | - $this->_all_data_count = $this->_admin_page->get_events(0, 0, true); |
|
31 | - } |
|
32 | - |
|
33 | - |
|
34 | - /** |
|
35 | - * Set up of additional properties for the list table. |
|
36 | - */ |
|
37 | - protected function _set_properties() |
|
38 | - { |
|
39 | - $this->_wp_list_args = array( |
|
40 | - 'singular' => esc_html__('event', 'event_espresso'), |
|
41 | - 'plural' => esc_html__('events', 'event_espresso'), |
|
42 | - 'ajax' => true, // for now |
|
43 | - 'screen' => $this->_admin_page->get_current_screen()->id, |
|
44 | - ); |
|
45 | - $this->_columns = array( |
|
46 | - 'cb' => '<input type="checkbox" />', |
|
47 | - 'id' => esc_html__('ID', 'event_espresso'), |
|
48 | - 'name' => esc_html__('Name', 'event_espresso'), |
|
49 | - 'author' => esc_html__('Author', 'event_espresso'), |
|
50 | - 'venue' => esc_html__('Venue', 'event_espresso'), |
|
51 | - 'start_date_time' => esc_html__('Event Start', 'event_espresso'), |
|
52 | - 'reg_begins' => esc_html__('On Sale', 'event_espresso'), |
|
53 | - 'attendees' => '<span class="dashicons dashicons-groups ee-icon-color-ee-green ee-icon-size-20">' |
|
54 | - . '<span class="screen-reader-text">' |
|
55 | - . esc_html__('Approved Registrations', 'event_espresso') |
|
56 | - . '</span>' |
|
57 | - . '</span>', |
|
58 | - // 'tkts_sold' => esc_html__('Tickets Sold', 'event_espresso'), |
|
59 | - 'actions' => esc_html__('Actions', 'event_espresso'), |
|
60 | - ); |
|
61 | - $this->addConditionalColumns(); |
|
62 | - $this->_sortable_columns = array( |
|
63 | - 'id' => array('EVT_ID' => true), |
|
64 | - 'name' => array('EVT_name' => false), |
|
65 | - 'author' => array('EVT_wp_user' => false), |
|
66 | - 'venue' => array('Venue.VNU_name' => false), |
|
67 | - 'start_date_time' => array('Datetime.DTT_EVT_start' => false), |
|
68 | - 'reg_begins' => array('Datetime.Ticket.TKT_start_date' => false), |
|
69 | - ); |
|
70 | - |
|
71 | - $this->_primary_column = 'id'; |
|
72 | - $this->_hidden_columns = array('author', 'event_category'); |
|
73 | - } |
|
74 | - |
|
75 | - |
|
76 | - /** |
|
77 | - * @return array |
|
78 | - */ |
|
79 | - protected function _get_table_filters() |
|
80 | - { |
|
81 | - return array(); // no filters with decaf |
|
82 | - } |
|
83 | - |
|
84 | - |
|
85 | - /** |
|
86 | - * Setup of views properties. |
|
87 | - * |
|
88 | - * @throws InvalidDataTypeException |
|
89 | - * @throws InvalidInterfaceException |
|
90 | - * @throws InvalidArgumentException |
|
91 | - */ |
|
92 | - protected function _add_view_counts() |
|
93 | - { |
|
94 | - $this->_views['all']['count'] = $this->_admin_page->total_events(); |
|
95 | - $this->_views['draft']['count'] = $this->_admin_page->total_events_draft(); |
|
96 | - if ( |
|
97 | - EE_Registry::instance()->CAP->current_user_can( |
|
98 | - 'ee_delete_events', |
|
99 | - 'espresso_events_trash_events' |
|
100 | - ) |
|
101 | - ) { |
|
102 | - $this->_views['trash']['count'] = $this->_admin_page->total_trashed_events(); |
|
103 | - } |
|
104 | - } |
|
105 | - |
|
106 | - |
|
107 | - /** |
|
108 | - * @param EE_Event $item |
|
109 | - * @return string |
|
110 | - * @throws EE_Error |
|
111 | - */ |
|
112 | - protected function _get_row_class($item) |
|
113 | - { |
|
114 | - $class = parent::_get_row_class($item); |
|
115 | - // add status class |
|
116 | - $class .= $item instanceof EE_Event |
|
117 | - ? ' ee-status-strip event-status-' . $item->get_active_status() |
|
118 | - : ''; |
|
119 | - if ($this->_has_checkbox_column) { |
|
120 | - $class .= ' has-checkbox-column'; |
|
121 | - } |
|
122 | - return $class; |
|
123 | - } |
|
124 | - |
|
125 | - |
|
126 | - /** |
|
127 | - * @param EE_Event $item |
|
128 | - * @return string |
|
129 | - * @throws EE_Error |
|
130 | - */ |
|
131 | - public function column_status(EE_Event $item) |
|
132 | - { |
|
133 | - return '<span class="ee-status-strip ee-status-strip-td event-status-' |
|
134 | - . $item->get_active_status() |
|
135 | - . '"></span>'; |
|
136 | - } |
|
137 | - |
|
138 | - |
|
139 | - /** |
|
140 | - * @param EE_Event $item |
|
141 | - * @return string |
|
142 | - * @throws EE_Error |
|
143 | - */ |
|
144 | - public function column_cb($item) |
|
145 | - { |
|
146 | - if (! $item instanceof EE_Event) { |
|
147 | - return ''; |
|
148 | - } |
|
149 | - $this->_dtt = $item->primary_datetime(); // set this for use in other columns |
|
150 | - // does event have any attached registrations? |
|
151 | - $regs = $item->count_related('Registration'); |
|
152 | - return $regs > 0 && $this->_view === 'trash' |
|
153 | - ? '<span class="ee-lock-icon"></span>' |
|
154 | - : sprintf( |
|
155 | - '<input type="checkbox" name="EVT_IDs[]" value="%s" />', |
|
156 | - $item->ID() |
|
157 | - ); |
|
158 | - } |
|
159 | - |
|
160 | - |
|
161 | - /** |
|
162 | - * @param EE_Event $item |
|
163 | - * @return mixed|string |
|
164 | - * @throws EE_Error |
|
165 | - */ |
|
166 | - public function column_id(EE_Event $item) |
|
167 | - { |
|
168 | - $content = $item->ID(); |
|
169 | - $content .= ' <span class="show-on-mobile-view-only">' . $item->name() . '</span>'; |
|
170 | - return $content; |
|
171 | - } |
|
172 | - |
|
173 | - |
|
174 | - /** |
|
175 | - * @param EE_Event $item |
|
176 | - * @return string |
|
177 | - * @throws EE_Error |
|
178 | - * @throws InvalidArgumentException |
|
179 | - * @throws InvalidDataTypeException |
|
180 | - * @throws InvalidInterfaceException |
|
181 | - */ |
|
182 | - public function column_name(EE_Event $item) |
|
183 | - { |
|
184 | - $edit_query_args = array( |
|
185 | - 'action' => 'edit', |
|
186 | - 'post' => $item->ID(), |
|
187 | - ); |
|
188 | - $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL); |
|
189 | - $actions = $this->_column_name_action_setup($item); |
|
190 | - $status = ''; // $item->status() !== 'publish' ? ' (' . $item->status() . ')' : ''; |
|
191 | - $content = '<strong><a class="row-title" href="' |
|
192 | - . $edit_link . '">' |
|
193 | - . $item->name() |
|
194 | - . '</a></strong>' |
|
195 | - . $status; |
|
196 | - $content .= '<br><span class="ee-status-text-small">' |
|
197 | - . EEH_Template::pretty_status( |
|
198 | - $item->get_active_status(), |
|
199 | - false, |
|
200 | - 'sentence' |
|
201 | - ) |
|
202 | - . '</span>'; |
|
203 | - $content .= $this->row_actions($actions); |
|
204 | - return $content; |
|
205 | - } |
|
206 | - |
|
207 | - |
|
208 | - /** |
|
209 | - * Just a method for setting up the actions for the name column |
|
210 | - * |
|
211 | - * @param EE_Event $item |
|
212 | - * @return array array of actions |
|
213 | - * @throws EE_Error |
|
214 | - * @throws InvalidArgumentException |
|
215 | - * @throws InvalidDataTypeException |
|
216 | - * @throws InvalidInterfaceException |
|
217 | - */ |
|
218 | - protected function _column_name_action_setup(EE_Event $item) |
|
219 | - { |
|
220 | - // todo: remove when attendees is active |
|
221 | - if (! defined('REG_ADMIN_URL')) { |
|
222 | - define('REG_ADMIN_URL', EVENTS_ADMIN_URL); |
|
223 | - } |
|
224 | - $actions = array(); |
|
225 | - $restore_event_link = ''; |
|
226 | - $delete_event_link = ''; |
|
227 | - $trash_event_link = ''; |
|
228 | - if ( |
|
229 | - EE_Registry::instance()->CAP->current_user_can( |
|
230 | - 'ee_edit_event', |
|
231 | - 'espresso_events_edit', |
|
232 | - $item->ID() |
|
233 | - ) |
|
234 | - ) { |
|
235 | - $edit_query_args = array( |
|
236 | - 'action' => 'edit', |
|
237 | - 'post' => $item->ID(), |
|
238 | - ); |
|
239 | - $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL); |
|
240 | - $actions['edit'] = '<a href="' . $edit_link . '"' |
|
241 | - . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">' |
|
242 | - . esc_html__('Edit', 'event_espresso') |
|
243 | - . '</a>'; |
|
244 | - } |
|
245 | - if ( |
|
246 | - EE_Registry::instance()->CAP->current_user_can( |
|
247 | - 'ee_read_registrations', |
|
248 | - 'espresso_registrations_view_registration' |
|
249 | - ) |
|
250 | - && EE_Registry::instance()->CAP->current_user_can( |
|
251 | - 'ee_read_event', |
|
252 | - 'espresso_registrations_view_registration', |
|
253 | - $item->ID() |
|
254 | - ) |
|
255 | - ) { |
|
256 | - $attendees_query_args = array( |
|
257 | - 'action' => 'default', |
|
258 | - 'event_id' => $item->ID(), |
|
259 | - ); |
|
260 | - $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL); |
|
261 | - $actions['attendees'] = '<a href="' . $attendees_link . '"' |
|
262 | - . ' title="' . esc_attr__('View Registrations', 'event_espresso') . '">' |
|
263 | - . esc_html__('Registrations', 'event_espresso') |
|
264 | - . '</a>'; |
|
265 | - } |
|
266 | - if ( |
|
267 | - EE_Registry::instance()->CAP->current_user_can( |
|
268 | - 'ee_delete_event', |
|
269 | - 'espresso_events_trash_event', |
|
270 | - $item->ID() |
|
271 | - ) |
|
272 | - ) { |
|
273 | - $trash_event_query_args = array( |
|
274 | - 'action' => 'trash_event', |
|
275 | - 'EVT_ID' => $item->ID(), |
|
276 | - ); |
|
277 | - $trash_event_link = EE_Admin_Page::add_query_args_and_nonce( |
|
278 | - $trash_event_query_args, |
|
279 | - EVENTS_ADMIN_URL |
|
280 | - ); |
|
281 | - } |
|
282 | - if ( |
|
283 | - EE_Registry::instance()->CAP->current_user_can( |
|
284 | - 'ee_delete_event', |
|
285 | - 'espresso_events_restore_event', |
|
286 | - $item->ID() |
|
287 | - ) |
|
288 | - ) { |
|
289 | - $restore_event_query_args = array( |
|
290 | - 'action' => 'restore_event', |
|
291 | - 'EVT_ID' => $item->ID(), |
|
292 | - ); |
|
293 | - $restore_event_link = EE_Admin_Page::add_query_args_and_nonce( |
|
294 | - $restore_event_query_args, |
|
295 | - EVENTS_ADMIN_URL |
|
296 | - ); |
|
297 | - } |
|
298 | - if ( |
|
299 | - EE_Registry::instance()->CAP->current_user_can( |
|
300 | - 'ee_delete_event', |
|
301 | - 'espresso_events_delete_event', |
|
302 | - $item->ID() |
|
303 | - ) |
|
304 | - ) { |
|
305 | - $delete_event_query_args = array( |
|
306 | - 'action' => 'delete_event', |
|
307 | - 'EVT_ID' => $item->ID(), |
|
308 | - ); |
|
309 | - $delete_event_link = EE_Admin_Page::add_query_args_and_nonce( |
|
310 | - $delete_event_query_args, |
|
311 | - EVENTS_ADMIN_URL |
|
312 | - ); |
|
313 | - } |
|
314 | - $view_link = get_permalink($item->ID()); |
|
315 | - $actions['view'] = '<a href="' . $view_link . '"' |
|
316 | - . ' title="' . esc_attr__('View Event', 'event_espresso') . '">' |
|
317 | - . esc_html__('View', 'event_espresso') |
|
318 | - . '</a>'; |
|
319 | - if ($item->get('status') === 'trash') { |
|
320 | - if ( |
|
321 | - EE_Registry::instance()->CAP->current_user_can( |
|
322 | - 'ee_delete_event', |
|
323 | - 'espresso_events_restore_event', |
|
324 | - $item->ID() |
|
325 | - ) |
|
326 | - ) { |
|
327 | - $actions['restore_from_trash'] = '<a href="' . $restore_event_link . '"' |
|
328 | - . ' title="' . esc_attr__('Restore from Trash', 'event_espresso') |
|
329 | - . '">' |
|
330 | - . esc_html__('Restore from Trash', 'event_espresso') |
|
331 | - . '</a>'; |
|
332 | - } |
|
333 | - if ( |
|
334 | - $item->count_related('Registration') === 0 |
|
335 | - && EE_Registry::instance()->CAP->current_user_can( |
|
336 | - 'ee_delete_event', |
|
337 | - 'espresso_events_delete_event', |
|
338 | - $item->ID() |
|
339 | - ) |
|
340 | - ) { |
|
341 | - $actions['delete'] = '<a href="' . $delete_event_link . '"' |
|
342 | - . ' title="' . esc_attr__('Delete Permanently', 'event_espresso') . '">' |
|
343 | - . esc_html__('Delete Permanently', 'event_espresso') |
|
344 | - . '</a>'; |
|
345 | - } |
|
346 | - } else { |
|
347 | - if ( |
|
348 | - EE_Registry::instance()->CAP->current_user_can( |
|
349 | - 'ee_delete_event', |
|
350 | - 'espresso_events_trash_event', |
|
351 | - $item->ID() |
|
352 | - ) |
|
353 | - ) { |
|
354 | - $actions['move to trash'] = '<a href="' . $trash_event_link . '"' |
|
355 | - . ' title="' . esc_attr__('Trash Event', 'event_espresso') . '">' |
|
356 | - . esc_html__('Trash', 'event_espresso') |
|
357 | - . '</a>'; |
|
358 | - } |
|
359 | - } |
|
360 | - return $actions; |
|
361 | - } |
|
362 | - |
|
363 | - |
|
364 | - /** |
|
365 | - * @param EE_Event $item |
|
366 | - * @return string |
|
367 | - * @throws EE_Error |
|
368 | - */ |
|
369 | - public function column_author(EE_Event $item) |
|
370 | - { |
|
371 | - // user author info |
|
372 | - $event_author = get_userdata($item->wp_user()); |
|
373 | - $gravatar = get_avatar($item->wp_user(), '15'); |
|
374 | - // filter link |
|
375 | - $query_args = array( |
|
376 | - 'action' => 'default', |
|
377 | - 'EVT_wp_user' => $item->wp_user(), |
|
378 | - ); |
|
379 | - $filter_url = EE_Admin_Page::add_query_args_and_nonce($query_args, EVENTS_ADMIN_URL); |
|
380 | - return $gravatar . ' <a href="' . $filter_url . '"' |
|
381 | - . ' title="' . esc_attr__('Click to filter events by this author.', 'event_espresso') . '">' |
|
382 | - . $event_author->display_name |
|
383 | - . '</a>'; |
|
384 | - } |
|
385 | - |
|
386 | - |
|
387 | - /** |
|
388 | - * @param EE_Event $event |
|
389 | - * @return string |
|
390 | - * @throws EE_Error |
|
391 | - */ |
|
392 | - public function column_event_category(EE_Event $event) |
|
393 | - { |
|
394 | - $event_categories = $event->get_all_event_categories(); |
|
395 | - return implode( |
|
396 | - ', ', |
|
397 | - array_map( |
|
398 | - function (EE_Term $category) { |
|
399 | - return $category->name(); |
|
400 | - }, |
|
401 | - $event_categories |
|
402 | - ) |
|
403 | - ); |
|
404 | - } |
|
405 | - |
|
406 | - |
|
407 | - /** |
|
408 | - * @param EE_Event $item |
|
409 | - * @return string |
|
410 | - * @throws EE_Error |
|
411 | - */ |
|
412 | - public function column_venue(EE_Event $item) |
|
413 | - { |
|
414 | - $venue = $item->get_first_related('Venue'); |
|
415 | - return ! empty($venue) |
|
416 | - ? $venue->name() |
|
417 | - : ''; |
|
418 | - } |
|
419 | - |
|
420 | - |
|
421 | - /** |
|
422 | - * @param EE_Event $item |
|
423 | - * @return string |
|
424 | - * @throws EE_Error |
|
425 | - */ |
|
426 | - public function column_start_date_time(EE_Event $item) |
|
427 | - { |
|
428 | - return $this->_dtt instanceof EE_Datetime |
|
429 | - ? $this->_dtt->get_i18n_datetime('DTT_EVT_start') |
|
430 | - : esc_html__('No Date was saved for this Event', 'event_espresso'); |
|
431 | - } |
|
432 | - |
|
433 | - |
|
434 | - /** |
|
435 | - * @param EE_Event $item |
|
436 | - * @return string |
|
437 | - * @throws EE_Error |
|
438 | - */ |
|
439 | - public function column_reg_begins(EE_Event $item) |
|
440 | - { |
|
441 | - $reg_start = $item->get_ticket_with_earliest_start_time(); |
|
442 | - return $reg_start instanceof EE_Ticket |
|
443 | - ? $reg_start->get_i18n_datetime('TKT_start_date') |
|
444 | - : esc_html__('No Tickets have been setup for this Event', 'event_espresso'); |
|
445 | - } |
|
446 | - |
|
447 | - |
|
448 | - /** |
|
449 | - * @param EE_Event $item |
|
450 | - * @return int|string |
|
451 | - * @throws EE_Error |
|
452 | - * @throws InvalidArgumentException |
|
453 | - * @throws InvalidDataTypeException |
|
454 | - * @throws InvalidInterfaceException |
|
455 | - */ |
|
456 | - public function column_attendees(EE_Event $item) |
|
457 | - { |
|
458 | - $attendees_query_args = array( |
|
459 | - 'action' => 'default', |
|
460 | - 'event_id' => $item->ID(), |
|
461 | - ); |
|
462 | - $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL); |
|
463 | - $registered_attendees = EEM_Registration::instance()->get_event_registration_count($item->ID()); |
|
464 | - return EE_Registry::instance()->CAP->current_user_can( |
|
465 | - 'ee_read_event', |
|
466 | - 'espresso_registrations_view_registration', |
|
467 | - $item->ID() |
|
468 | - ) |
|
469 | - && EE_Registry::instance()->CAP->current_user_can( |
|
470 | - 'ee_read_registrations', |
|
471 | - 'espresso_registrations_view_registration' |
|
472 | - ) |
|
473 | - ? '<a href="' . $attendees_link . '">' . $registered_attendees . '</a>' |
|
474 | - : $registered_attendees; |
|
475 | - } |
|
476 | - |
|
477 | - |
|
478 | - /** |
|
479 | - * @param EE_Event $item |
|
480 | - * @return float |
|
481 | - * @throws EE_Error |
|
482 | - * @throws InvalidArgumentException |
|
483 | - * @throws InvalidDataTypeException |
|
484 | - * @throws InvalidInterfaceException |
|
485 | - */ |
|
486 | - public function column_tkts_sold(EE_Event $item) |
|
487 | - { |
|
488 | - return EEM_Ticket::instance()->sum(array(array('Datetime.EVT_ID' => $item->ID())), 'TKT_sold'); |
|
489 | - } |
|
490 | - |
|
491 | - |
|
492 | - /** |
|
493 | - * @param EE_Event $item |
|
494 | - * @return string |
|
495 | - * @throws EE_Error |
|
496 | - * @throws InvalidArgumentException |
|
497 | - * @throws InvalidDataTypeException |
|
498 | - * @throws InvalidInterfaceException |
|
499 | - */ |
|
500 | - public function column_actions(EE_Event $item) |
|
501 | - { |
|
502 | - // todo: remove when attendees is active |
|
503 | - if (! defined('REG_ADMIN_URL')) { |
|
504 | - define('REG_ADMIN_URL', EVENTS_ADMIN_URL); |
|
505 | - } |
|
506 | - $action_links = array(); |
|
507 | - $view_link = get_permalink($item->ID()); |
|
508 | - $action_links[] = '<a href="' . $view_link . '"' |
|
509 | - . ' title="' . esc_attr__('View Event', 'event_espresso') . '" target="_blank">'; |
|
510 | - $action_links[] = '<div class="dashicons dashicons-search"></div></a>'; |
|
511 | - if ( |
|
512 | - EE_Registry::instance()->CAP->current_user_can( |
|
513 | - 'ee_edit_event', |
|
514 | - 'espresso_events_edit', |
|
515 | - $item->ID() |
|
516 | - ) |
|
517 | - ) { |
|
518 | - $edit_query_args = array( |
|
519 | - 'action' => 'edit', |
|
520 | - 'post' => $item->ID(), |
|
521 | - ); |
|
522 | - $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL); |
|
523 | - $action_links[] = '<a href="' . $edit_link . '"' |
|
524 | - . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">' |
|
525 | - . '<div class="ee-icon ee-icon-calendar-edit"></div>' |
|
526 | - . '</a>'; |
|
527 | - } |
|
528 | - if ( |
|
529 | - EE_Registry::instance()->CAP->current_user_can( |
|
530 | - 'ee_read_registrations', |
|
531 | - 'espresso_registrations_view_registration' |
|
532 | - ) && EE_Registry::instance()->CAP->current_user_can( |
|
533 | - 'ee_read_event', |
|
534 | - 'espresso_registrations_view_registration', |
|
535 | - $item->ID() |
|
536 | - ) |
|
537 | - ) { |
|
538 | - $attendees_query_args = array( |
|
539 | - 'action' => 'default', |
|
540 | - 'event_id' => $item->ID(), |
|
541 | - ); |
|
542 | - $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL); |
|
543 | - $action_links[] = '<a href="' . $attendees_link . '"' |
|
544 | - . ' title="' . esc_attr__('View Registrants', 'event_espresso') . '">' |
|
545 | - . '<div class="dashicons dashicons-groups"></div>' |
|
546 | - . '</a>'; |
|
547 | - } |
|
548 | - $action_links = apply_filters( |
|
549 | - 'FHEE__Events_Admin_List_Table__column_actions__action_links', |
|
550 | - $action_links, |
|
551 | - $item |
|
552 | - ); |
|
553 | - return $this->_action_string( |
|
554 | - implode("\n\t", $action_links), |
|
555 | - $item, |
|
556 | - 'div' |
|
557 | - ); |
|
558 | - } |
|
559 | - |
|
560 | - |
|
561 | - /** |
|
562 | - * Helper for adding columns conditionally |
|
563 | - * |
|
564 | - * @throws EE_Error |
|
565 | - * @throws InvalidArgumentException |
|
566 | - * @throws InvalidDataTypeException |
|
567 | - * @throws InvalidInterfaceException |
|
568 | - */ |
|
569 | - private function addConditionalColumns() |
|
570 | - { |
|
571 | - $event_category_count = EEM_Term::instance()->count( |
|
572 | - [['Term_Taxonomy.taxonomy' => EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY]] |
|
573 | - ); |
|
574 | - if ($event_category_count === 0) { |
|
575 | - return; |
|
576 | - } |
|
577 | - $column_array = []; |
|
578 | - foreach ($this->_columns as $column => $column_label) { |
|
579 | - $column_array[ $column ] = $column_label; |
|
580 | - if ($column === 'venue') { |
|
581 | - $column_array['event_category'] = esc_html__('Event Category', 'event_espresso'); |
|
582 | - } |
|
583 | - } |
|
584 | - $this->_columns = $column_array; |
|
585 | - } |
|
18 | + /** |
|
19 | + * @var EE_Datetime |
|
20 | + */ |
|
21 | + private $_dtt; |
|
22 | + |
|
23 | + |
|
24 | + /** |
|
25 | + * Initial setup of data properties for the list table. |
|
26 | + */ |
|
27 | + protected function _setup_data() |
|
28 | + { |
|
29 | + $this->_data = $this->_admin_page->get_events($this->_per_page, $this->_current_page); |
|
30 | + $this->_all_data_count = $this->_admin_page->get_events(0, 0, true); |
|
31 | + } |
|
32 | + |
|
33 | + |
|
34 | + /** |
|
35 | + * Set up of additional properties for the list table. |
|
36 | + */ |
|
37 | + protected function _set_properties() |
|
38 | + { |
|
39 | + $this->_wp_list_args = array( |
|
40 | + 'singular' => esc_html__('event', 'event_espresso'), |
|
41 | + 'plural' => esc_html__('events', 'event_espresso'), |
|
42 | + 'ajax' => true, // for now |
|
43 | + 'screen' => $this->_admin_page->get_current_screen()->id, |
|
44 | + ); |
|
45 | + $this->_columns = array( |
|
46 | + 'cb' => '<input type="checkbox" />', |
|
47 | + 'id' => esc_html__('ID', 'event_espresso'), |
|
48 | + 'name' => esc_html__('Name', 'event_espresso'), |
|
49 | + 'author' => esc_html__('Author', 'event_espresso'), |
|
50 | + 'venue' => esc_html__('Venue', 'event_espresso'), |
|
51 | + 'start_date_time' => esc_html__('Event Start', 'event_espresso'), |
|
52 | + 'reg_begins' => esc_html__('On Sale', 'event_espresso'), |
|
53 | + 'attendees' => '<span class="dashicons dashicons-groups ee-icon-color-ee-green ee-icon-size-20">' |
|
54 | + . '<span class="screen-reader-text">' |
|
55 | + . esc_html__('Approved Registrations', 'event_espresso') |
|
56 | + . '</span>' |
|
57 | + . '</span>', |
|
58 | + // 'tkts_sold' => esc_html__('Tickets Sold', 'event_espresso'), |
|
59 | + 'actions' => esc_html__('Actions', 'event_espresso'), |
|
60 | + ); |
|
61 | + $this->addConditionalColumns(); |
|
62 | + $this->_sortable_columns = array( |
|
63 | + 'id' => array('EVT_ID' => true), |
|
64 | + 'name' => array('EVT_name' => false), |
|
65 | + 'author' => array('EVT_wp_user' => false), |
|
66 | + 'venue' => array('Venue.VNU_name' => false), |
|
67 | + 'start_date_time' => array('Datetime.DTT_EVT_start' => false), |
|
68 | + 'reg_begins' => array('Datetime.Ticket.TKT_start_date' => false), |
|
69 | + ); |
|
70 | + |
|
71 | + $this->_primary_column = 'id'; |
|
72 | + $this->_hidden_columns = array('author', 'event_category'); |
|
73 | + } |
|
74 | + |
|
75 | + |
|
76 | + /** |
|
77 | + * @return array |
|
78 | + */ |
|
79 | + protected function _get_table_filters() |
|
80 | + { |
|
81 | + return array(); // no filters with decaf |
|
82 | + } |
|
83 | + |
|
84 | + |
|
85 | + /** |
|
86 | + * Setup of views properties. |
|
87 | + * |
|
88 | + * @throws InvalidDataTypeException |
|
89 | + * @throws InvalidInterfaceException |
|
90 | + * @throws InvalidArgumentException |
|
91 | + */ |
|
92 | + protected function _add_view_counts() |
|
93 | + { |
|
94 | + $this->_views['all']['count'] = $this->_admin_page->total_events(); |
|
95 | + $this->_views['draft']['count'] = $this->_admin_page->total_events_draft(); |
|
96 | + if ( |
|
97 | + EE_Registry::instance()->CAP->current_user_can( |
|
98 | + 'ee_delete_events', |
|
99 | + 'espresso_events_trash_events' |
|
100 | + ) |
|
101 | + ) { |
|
102 | + $this->_views['trash']['count'] = $this->_admin_page->total_trashed_events(); |
|
103 | + } |
|
104 | + } |
|
105 | + |
|
106 | + |
|
107 | + /** |
|
108 | + * @param EE_Event $item |
|
109 | + * @return string |
|
110 | + * @throws EE_Error |
|
111 | + */ |
|
112 | + protected function _get_row_class($item) |
|
113 | + { |
|
114 | + $class = parent::_get_row_class($item); |
|
115 | + // add status class |
|
116 | + $class .= $item instanceof EE_Event |
|
117 | + ? ' ee-status-strip event-status-' . $item->get_active_status() |
|
118 | + : ''; |
|
119 | + if ($this->_has_checkbox_column) { |
|
120 | + $class .= ' has-checkbox-column'; |
|
121 | + } |
|
122 | + return $class; |
|
123 | + } |
|
124 | + |
|
125 | + |
|
126 | + /** |
|
127 | + * @param EE_Event $item |
|
128 | + * @return string |
|
129 | + * @throws EE_Error |
|
130 | + */ |
|
131 | + public function column_status(EE_Event $item) |
|
132 | + { |
|
133 | + return '<span class="ee-status-strip ee-status-strip-td event-status-' |
|
134 | + . $item->get_active_status() |
|
135 | + . '"></span>'; |
|
136 | + } |
|
137 | + |
|
138 | + |
|
139 | + /** |
|
140 | + * @param EE_Event $item |
|
141 | + * @return string |
|
142 | + * @throws EE_Error |
|
143 | + */ |
|
144 | + public function column_cb($item) |
|
145 | + { |
|
146 | + if (! $item instanceof EE_Event) { |
|
147 | + return ''; |
|
148 | + } |
|
149 | + $this->_dtt = $item->primary_datetime(); // set this for use in other columns |
|
150 | + // does event have any attached registrations? |
|
151 | + $regs = $item->count_related('Registration'); |
|
152 | + return $regs > 0 && $this->_view === 'trash' |
|
153 | + ? '<span class="ee-lock-icon"></span>' |
|
154 | + : sprintf( |
|
155 | + '<input type="checkbox" name="EVT_IDs[]" value="%s" />', |
|
156 | + $item->ID() |
|
157 | + ); |
|
158 | + } |
|
159 | + |
|
160 | + |
|
161 | + /** |
|
162 | + * @param EE_Event $item |
|
163 | + * @return mixed|string |
|
164 | + * @throws EE_Error |
|
165 | + */ |
|
166 | + public function column_id(EE_Event $item) |
|
167 | + { |
|
168 | + $content = $item->ID(); |
|
169 | + $content .= ' <span class="show-on-mobile-view-only">' . $item->name() . '</span>'; |
|
170 | + return $content; |
|
171 | + } |
|
172 | + |
|
173 | + |
|
174 | + /** |
|
175 | + * @param EE_Event $item |
|
176 | + * @return string |
|
177 | + * @throws EE_Error |
|
178 | + * @throws InvalidArgumentException |
|
179 | + * @throws InvalidDataTypeException |
|
180 | + * @throws InvalidInterfaceException |
|
181 | + */ |
|
182 | + public function column_name(EE_Event $item) |
|
183 | + { |
|
184 | + $edit_query_args = array( |
|
185 | + 'action' => 'edit', |
|
186 | + 'post' => $item->ID(), |
|
187 | + ); |
|
188 | + $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL); |
|
189 | + $actions = $this->_column_name_action_setup($item); |
|
190 | + $status = ''; // $item->status() !== 'publish' ? ' (' . $item->status() . ')' : ''; |
|
191 | + $content = '<strong><a class="row-title" href="' |
|
192 | + . $edit_link . '">' |
|
193 | + . $item->name() |
|
194 | + . '</a></strong>' |
|
195 | + . $status; |
|
196 | + $content .= '<br><span class="ee-status-text-small">' |
|
197 | + . EEH_Template::pretty_status( |
|
198 | + $item->get_active_status(), |
|
199 | + false, |
|
200 | + 'sentence' |
|
201 | + ) |
|
202 | + . '</span>'; |
|
203 | + $content .= $this->row_actions($actions); |
|
204 | + return $content; |
|
205 | + } |
|
206 | + |
|
207 | + |
|
208 | + /** |
|
209 | + * Just a method for setting up the actions for the name column |
|
210 | + * |
|
211 | + * @param EE_Event $item |
|
212 | + * @return array array of actions |
|
213 | + * @throws EE_Error |
|
214 | + * @throws InvalidArgumentException |
|
215 | + * @throws InvalidDataTypeException |
|
216 | + * @throws InvalidInterfaceException |
|
217 | + */ |
|
218 | + protected function _column_name_action_setup(EE_Event $item) |
|
219 | + { |
|
220 | + // todo: remove when attendees is active |
|
221 | + if (! defined('REG_ADMIN_URL')) { |
|
222 | + define('REG_ADMIN_URL', EVENTS_ADMIN_URL); |
|
223 | + } |
|
224 | + $actions = array(); |
|
225 | + $restore_event_link = ''; |
|
226 | + $delete_event_link = ''; |
|
227 | + $trash_event_link = ''; |
|
228 | + if ( |
|
229 | + EE_Registry::instance()->CAP->current_user_can( |
|
230 | + 'ee_edit_event', |
|
231 | + 'espresso_events_edit', |
|
232 | + $item->ID() |
|
233 | + ) |
|
234 | + ) { |
|
235 | + $edit_query_args = array( |
|
236 | + 'action' => 'edit', |
|
237 | + 'post' => $item->ID(), |
|
238 | + ); |
|
239 | + $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL); |
|
240 | + $actions['edit'] = '<a href="' . $edit_link . '"' |
|
241 | + . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">' |
|
242 | + . esc_html__('Edit', 'event_espresso') |
|
243 | + . '</a>'; |
|
244 | + } |
|
245 | + if ( |
|
246 | + EE_Registry::instance()->CAP->current_user_can( |
|
247 | + 'ee_read_registrations', |
|
248 | + 'espresso_registrations_view_registration' |
|
249 | + ) |
|
250 | + && EE_Registry::instance()->CAP->current_user_can( |
|
251 | + 'ee_read_event', |
|
252 | + 'espresso_registrations_view_registration', |
|
253 | + $item->ID() |
|
254 | + ) |
|
255 | + ) { |
|
256 | + $attendees_query_args = array( |
|
257 | + 'action' => 'default', |
|
258 | + 'event_id' => $item->ID(), |
|
259 | + ); |
|
260 | + $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL); |
|
261 | + $actions['attendees'] = '<a href="' . $attendees_link . '"' |
|
262 | + . ' title="' . esc_attr__('View Registrations', 'event_espresso') . '">' |
|
263 | + . esc_html__('Registrations', 'event_espresso') |
|
264 | + . '</a>'; |
|
265 | + } |
|
266 | + if ( |
|
267 | + EE_Registry::instance()->CAP->current_user_can( |
|
268 | + 'ee_delete_event', |
|
269 | + 'espresso_events_trash_event', |
|
270 | + $item->ID() |
|
271 | + ) |
|
272 | + ) { |
|
273 | + $trash_event_query_args = array( |
|
274 | + 'action' => 'trash_event', |
|
275 | + 'EVT_ID' => $item->ID(), |
|
276 | + ); |
|
277 | + $trash_event_link = EE_Admin_Page::add_query_args_and_nonce( |
|
278 | + $trash_event_query_args, |
|
279 | + EVENTS_ADMIN_URL |
|
280 | + ); |
|
281 | + } |
|
282 | + if ( |
|
283 | + EE_Registry::instance()->CAP->current_user_can( |
|
284 | + 'ee_delete_event', |
|
285 | + 'espresso_events_restore_event', |
|
286 | + $item->ID() |
|
287 | + ) |
|
288 | + ) { |
|
289 | + $restore_event_query_args = array( |
|
290 | + 'action' => 'restore_event', |
|
291 | + 'EVT_ID' => $item->ID(), |
|
292 | + ); |
|
293 | + $restore_event_link = EE_Admin_Page::add_query_args_and_nonce( |
|
294 | + $restore_event_query_args, |
|
295 | + EVENTS_ADMIN_URL |
|
296 | + ); |
|
297 | + } |
|
298 | + if ( |
|
299 | + EE_Registry::instance()->CAP->current_user_can( |
|
300 | + 'ee_delete_event', |
|
301 | + 'espresso_events_delete_event', |
|
302 | + $item->ID() |
|
303 | + ) |
|
304 | + ) { |
|
305 | + $delete_event_query_args = array( |
|
306 | + 'action' => 'delete_event', |
|
307 | + 'EVT_ID' => $item->ID(), |
|
308 | + ); |
|
309 | + $delete_event_link = EE_Admin_Page::add_query_args_and_nonce( |
|
310 | + $delete_event_query_args, |
|
311 | + EVENTS_ADMIN_URL |
|
312 | + ); |
|
313 | + } |
|
314 | + $view_link = get_permalink($item->ID()); |
|
315 | + $actions['view'] = '<a href="' . $view_link . '"' |
|
316 | + . ' title="' . esc_attr__('View Event', 'event_espresso') . '">' |
|
317 | + . esc_html__('View', 'event_espresso') |
|
318 | + . '</a>'; |
|
319 | + if ($item->get('status') === 'trash') { |
|
320 | + if ( |
|
321 | + EE_Registry::instance()->CAP->current_user_can( |
|
322 | + 'ee_delete_event', |
|
323 | + 'espresso_events_restore_event', |
|
324 | + $item->ID() |
|
325 | + ) |
|
326 | + ) { |
|
327 | + $actions['restore_from_trash'] = '<a href="' . $restore_event_link . '"' |
|
328 | + . ' title="' . esc_attr__('Restore from Trash', 'event_espresso') |
|
329 | + . '">' |
|
330 | + . esc_html__('Restore from Trash', 'event_espresso') |
|
331 | + . '</a>'; |
|
332 | + } |
|
333 | + if ( |
|
334 | + $item->count_related('Registration') === 0 |
|
335 | + && EE_Registry::instance()->CAP->current_user_can( |
|
336 | + 'ee_delete_event', |
|
337 | + 'espresso_events_delete_event', |
|
338 | + $item->ID() |
|
339 | + ) |
|
340 | + ) { |
|
341 | + $actions['delete'] = '<a href="' . $delete_event_link . '"' |
|
342 | + . ' title="' . esc_attr__('Delete Permanently', 'event_espresso') . '">' |
|
343 | + . esc_html__('Delete Permanently', 'event_espresso') |
|
344 | + . '</a>'; |
|
345 | + } |
|
346 | + } else { |
|
347 | + if ( |
|
348 | + EE_Registry::instance()->CAP->current_user_can( |
|
349 | + 'ee_delete_event', |
|
350 | + 'espresso_events_trash_event', |
|
351 | + $item->ID() |
|
352 | + ) |
|
353 | + ) { |
|
354 | + $actions['move to trash'] = '<a href="' . $trash_event_link . '"' |
|
355 | + . ' title="' . esc_attr__('Trash Event', 'event_espresso') . '">' |
|
356 | + . esc_html__('Trash', 'event_espresso') |
|
357 | + . '</a>'; |
|
358 | + } |
|
359 | + } |
|
360 | + return $actions; |
|
361 | + } |
|
362 | + |
|
363 | + |
|
364 | + /** |
|
365 | + * @param EE_Event $item |
|
366 | + * @return string |
|
367 | + * @throws EE_Error |
|
368 | + */ |
|
369 | + public function column_author(EE_Event $item) |
|
370 | + { |
|
371 | + // user author info |
|
372 | + $event_author = get_userdata($item->wp_user()); |
|
373 | + $gravatar = get_avatar($item->wp_user(), '15'); |
|
374 | + // filter link |
|
375 | + $query_args = array( |
|
376 | + 'action' => 'default', |
|
377 | + 'EVT_wp_user' => $item->wp_user(), |
|
378 | + ); |
|
379 | + $filter_url = EE_Admin_Page::add_query_args_and_nonce($query_args, EVENTS_ADMIN_URL); |
|
380 | + return $gravatar . ' <a href="' . $filter_url . '"' |
|
381 | + . ' title="' . esc_attr__('Click to filter events by this author.', 'event_espresso') . '">' |
|
382 | + . $event_author->display_name |
|
383 | + . '</a>'; |
|
384 | + } |
|
385 | + |
|
386 | + |
|
387 | + /** |
|
388 | + * @param EE_Event $event |
|
389 | + * @return string |
|
390 | + * @throws EE_Error |
|
391 | + */ |
|
392 | + public function column_event_category(EE_Event $event) |
|
393 | + { |
|
394 | + $event_categories = $event->get_all_event_categories(); |
|
395 | + return implode( |
|
396 | + ', ', |
|
397 | + array_map( |
|
398 | + function (EE_Term $category) { |
|
399 | + return $category->name(); |
|
400 | + }, |
|
401 | + $event_categories |
|
402 | + ) |
|
403 | + ); |
|
404 | + } |
|
405 | + |
|
406 | + |
|
407 | + /** |
|
408 | + * @param EE_Event $item |
|
409 | + * @return string |
|
410 | + * @throws EE_Error |
|
411 | + */ |
|
412 | + public function column_venue(EE_Event $item) |
|
413 | + { |
|
414 | + $venue = $item->get_first_related('Venue'); |
|
415 | + return ! empty($venue) |
|
416 | + ? $venue->name() |
|
417 | + : ''; |
|
418 | + } |
|
419 | + |
|
420 | + |
|
421 | + /** |
|
422 | + * @param EE_Event $item |
|
423 | + * @return string |
|
424 | + * @throws EE_Error |
|
425 | + */ |
|
426 | + public function column_start_date_time(EE_Event $item) |
|
427 | + { |
|
428 | + return $this->_dtt instanceof EE_Datetime |
|
429 | + ? $this->_dtt->get_i18n_datetime('DTT_EVT_start') |
|
430 | + : esc_html__('No Date was saved for this Event', 'event_espresso'); |
|
431 | + } |
|
432 | + |
|
433 | + |
|
434 | + /** |
|
435 | + * @param EE_Event $item |
|
436 | + * @return string |
|
437 | + * @throws EE_Error |
|
438 | + */ |
|
439 | + public function column_reg_begins(EE_Event $item) |
|
440 | + { |
|
441 | + $reg_start = $item->get_ticket_with_earliest_start_time(); |
|
442 | + return $reg_start instanceof EE_Ticket |
|
443 | + ? $reg_start->get_i18n_datetime('TKT_start_date') |
|
444 | + : esc_html__('No Tickets have been setup for this Event', 'event_espresso'); |
|
445 | + } |
|
446 | + |
|
447 | + |
|
448 | + /** |
|
449 | + * @param EE_Event $item |
|
450 | + * @return int|string |
|
451 | + * @throws EE_Error |
|
452 | + * @throws InvalidArgumentException |
|
453 | + * @throws InvalidDataTypeException |
|
454 | + * @throws InvalidInterfaceException |
|
455 | + */ |
|
456 | + public function column_attendees(EE_Event $item) |
|
457 | + { |
|
458 | + $attendees_query_args = array( |
|
459 | + 'action' => 'default', |
|
460 | + 'event_id' => $item->ID(), |
|
461 | + ); |
|
462 | + $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL); |
|
463 | + $registered_attendees = EEM_Registration::instance()->get_event_registration_count($item->ID()); |
|
464 | + return EE_Registry::instance()->CAP->current_user_can( |
|
465 | + 'ee_read_event', |
|
466 | + 'espresso_registrations_view_registration', |
|
467 | + $item->ID() |
|
468 | + ) |
|
469 | + && EE_Registry::instance()->CAP->current_user_can( |
|
470 | + 'ee_read_registrations', |
|
471 | + 'espresso_registrations_view_registration' |
|
472 | + ) |
|
473 | + ? '<a href="' . $attendees_link . '">' . $registered_attendees . '</a>' |
|
474 | + : $registered_attendees; |
|
475 | + } |
|
476 | + |
|
477 | + |
|
478 | + /** |
|
479 | + * @param EE_Event $item |
|
480 | + * @return float |
|
481 | + * @throws EE_Error |
|
482 | + * @throws InvalidArgumentException |
|
483 | + * @throws InvalidDataTypeException |
|
484 | + * @throws InvalidInterfaceException |
|
485 | + */ |
|
486 | + public function column_tkts_sold(EE_Event $item) |
|
487 | + { |
|
488 | + return EEM_Ticket::instance()->sum(array(array('Datetime.EVT_ID' => $item->ID())), 'TKT_sold'); |
|
489 | + } |
|
490 | + |
|
491 | + |
|
492 | + /** |
|
493 | + * @param EE_Event $item |
|
494 | + * @return string |
|
495 | + * @throws EE_Error |
|
496 | + * @throws InvalidArgumentException |
|
497 | + * @throws InvalidDataTypeException |
|
498 | + * @throws InvalidInterfaceException |
|
499 | + */ |
|
500 | + public function column_actions(EE_Event $item) |
|
501 | + { |
|
502 | + // todo: remove when attendees is active |
|
503 | + if (! defined('REG_ADMIN_URL')) { |
|
504 | + define('REG_ADMIN_URL', EVENTS_ADMIN_URL); |
|
505 | + } |
|
506 | + $action_links = array(); |
|
507 | + $view_link = get_permalink($item->ID()); |
|
508 | + $action_links[] = '<a href="' . $view_link . '"' |
|
509 | + . ' title="' . esc_attr__('View Event', 'event_espresso') . '" target="_blank">'; |
|
510 | + $action_links[] = '<div class="dashicons dashicons-search"></div></a>'; |
|
511 | + if ( |
|
512 | + EE_Registry::instance()->CAP->current_user_can( |
|
513 | + 'ee_edit_event', |
|
514 | + 'espresso_events_edit', |
|
515 | + $item->ID() |
|
516 | + ) |
|
517 | + ) { |
|
518 | + $edit_query_args = array( |
|
519 | + 'action' => 'edit', |
|
520 | + 'post' => $item->ID(), |
|
521 | + ); |
|
522 | + $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL); |
|
523 | + $action_links[] = '<a href="' . $edit_link . '"' |
|
524 | + . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">' |
|
525 | + . '<div class="ee-icon ee-icon-calendar-edit"></div>' |
|
526 | + . '</a>'; |
|
527 | + } |
|
528 | + if ( |
|
529 | + EE_Registry::instance()->CAP->current_user_can( |
|
530 | + 'ee_read_registrations', |
|
531 | + 'espresso_registrations_view_registration' |
|
532 | + ) && EE_Registry::instance()->CAP->current_user_can( |
|
533 | + 'ee_read_event', |
|
534 | + 'espresso_registrations_view_registration', |
|
535 | + $item->ID() |
|
536 | + ) |
|
537 | + ) { |
|
538 | + $attendees_query_args = array( |
|
539 | + 'action' => 'default', |
|
540 | + 'event_id' => $item->ID(), |
|
541 | + ); |
|
542 | + $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL); |
|
543 | + $action_links[] = '<a href="' . $attendees_link . '"' |
|
544 | + . ' title="' . esc_attr__('View Registrants', 'event_espresso') . '">' |
|
545 | + . '<div class="dashicons dashicons-groups"></div>' |
|
546 | + . '</a>'; |
|
547 | + } |
|
548 | + $action_links = apply_filters( |
|
549 | + 'FHEE__Events_Admin_List_Table__column_actions__action_links', |
|
550 | + $action_links, |
|
551 | + $item |
|
552 | + ); |
|
553 | + return $this->_action_string( |
|
554 | + implode("\n\t", $action_links), |
|
555 | + $item, |
|
556 | + 'div' |
|
557 | + ); |
|
558 | + } |
|
559 | + |
|
560 | + |
|
561 | + /** |
|
562 | + * Helper for adding columns conditionally |
|
563 | + * |
|
564 | + * @throws EE_Error |
|
565 | + * @throws InvalidArgumentException |
|
566 | + * @throws InvalidDataTypeException |
|
567 | + * @throws InvalidInterfaceException |
|
568 | + */ |
|
569 | + private function addConditionalColumns() |
|
570 | + { |
|
571 | + $event_category_count = EEM_Term::instance()->count( |
|
572 | + [['Term_Taxonomy.taxonomy' => EEM_CPT_Base::EVENT_CATEGORY_TAXONOMY]] |
|
573 | + ); |
|
574 | + if ($event_category_count === 0) { |
|
575 | + return; |
|
576 | + } |
|
577 | + $column_array = []; |
|
578 | + foreach ($this->_columns as $column => $column_label) { |
|
579 | + $column_array[ $column ] = $column_label; |
|
580 | + if ($column === 'venue') { |
|
581 | + $column_array['event_category'] = esc_html__('Event Category', 'event_espresso'); |
|
582 | + } |
|
583 | + } |
|
584 | + $this->_columns = $column_array; |
|
585 | + } |
|
586 | 586 | } |
@@ -114,7 +114,7 @@ discard block |
||
114 | 114 | $class = parent::_get_row_class($item); |
115 | 115 | // add status class |
116 | 116 | $class .= $item instanceof EE_Event |
117 | - ? ' ee-status-strip event-status-' . $item->get_active_status() |
|
117 | + ? ' ee-status-strip event-status-'.$item->get_active_status() |
|
118 | 118 | : ''; |
119 | 119 | if ($this->_has_checkbox_column) { |
120 | 120 | $class .= ' has-checkbox-column'; |
@@ -143,7 +143,7 @@ discard block |
||
143 | 143 | */ |
144 | 144 | public function column_cb($item) |
145 | 145 | { |
146 | - if (! $item instanceof EE_Event) { |
|
146 | + if ( ! $item instanceof EE_Event) { |
|
147 | 147 | return ''; |
148 | 148 | } |
149 | 149 | $this->_dtt = $item->primary_datetime(); // set this for use in other columns |
@@ -166,7 +166,7 @@ discard block |
||
166 | 166 | public function column_id(EE_Event $item) |
167 | 167 | { |
168 | 168 | $content = $item->ID(); |
169 | - $content .= ' <span class="show-on-mobile-view-only">' . $item->name() . '</span>'; |
|
169 | + $content .= ' <span class="show-on-mobile-view-only">'.$item->name().'</span>'; |
|
170 | 170 | return $content; |
171 | 171 | } |
172 | 172 | |
@@ -189,7 +189,7 @@ discard block |
||
189 | 189 | $actions = $this->_column_name_action_setup($item); |
190 | 190 | $status = ''; // $item->status() !== 'publish' ? ' (' . $item->status() . ')' : ''; |
191 | 191 | $content = '<strong><a class="row-title" href="' |
192 | - . $edit_link . '">' |
|
192 | + . $edit_link.'">' |
|
193 | 193 | . $item->name() |
194 | 194 | . '</a></strong>' |
195 | 195 | . $status; |
@@ -218,7 +218,7 @@ discard block |
||
218 | 218 | protected function _column_name_action_setup(EE_Event $item) |
219 | 219 | { |
220 | 220 | // todo: remove when attendees is active |
221 | - if (! defined('REG_ADMIN_URL')) { |
|
221 | + if ( ! defined('REG_ADMIN_URL')) { |
|
222 | 222 | define('REG_ADMIN_URL', EVENTS_ADMIN_URL); |
223 | 223 | } |
224 | 224 | $actions = array(); |
@@ -237,8 +237,8 @@ discard block |
||
237 | 237 | 'post' => $item->ID(), |
238 | 238 | ); |
239 | 239 | $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL); |
240 | - $actions['edit'] = '<a href="' . $edit_link . '"' |
|
241 | - . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">' |
|
240 | + $actions['edit'] = '<a href="'.$edit_link.'"' |
|
241 | + . ' title="'.esc_attr__('Edit Event', 'event_espresso').'">' |
|
242 | 242 | . esc_html__('Edit', 'event_espresso') |
243 | 243 | . '</a>'; |
244 | 244 | } |
@@ -258,8 +258,8 @@ discard block |
||
258 | 258 | 'event_id' => $item->ID(), |
259 | 259 | ); |
260 | 260 | $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL); |
261 | - $actions['attendees'] = '<a href="' . $attendees_link . '"' |
|
262 | - . ' title="' . esc_attr__('View Registrations', 'event_espresso') . '">' |
|
261 | + $actions['attendees'] = '<a href="'.$attendees_link.'"' |
|
262 | + . ' title="'.esc_attr__('View Registrations', 'event_espresso').'">' |
|
263 | 263 | . esc_html__('Registrations', 'event_espresso') |
264 | 264 | . '</a>'; |
265 | 265 | } |
@@ -312,8 +312,8 @@ discard block |
||
312 | 312 | ); |
313 | 313 | } |
314 | 314 | $view_link = get_permalink($item->ID()); |
315 | - $actions['view'] = '<a href="' . $view_link . '"' |
|
316 | - . ' title="' . esc_attr__('View Event', 'event_espresso') . '">' |
|
315 | + $actions['view'] = '<a href="'.$view_link.'"' |
|
316 | + . ' title="'.esc_attr__('View Event', 'event_espresso').'">' |
|
317 | 317 | . esc_html__('View', 'event_espresso') |
318 | 318 | . '</a>'; |
319 | 319 | if ($item->get('status') === 'trash') { |
@@ -324,8 +324,8 @@ discard block |
||
324 | 324 | $item->ID() |
325 | 325 | ) |
326 | 326 | ) { |
327 | - $actions['restore_from_trash'] = '<a href="' . $restore_event_link . '"' |
|
328 | - . ' title="' . esc_attr__('Restore from Trash', 'event_espresso') |
|
327 | + $actions['restore_from_trash'] = '<a href="'.$restore_event_link.'"' |
|
328 | + . ' title="'.esc_attr__('Restore from Trash', 'event_espresso') |
|
329 | 329 | . '">' |
330 | 330 | . esc_html__('Restore from Trash', 'event_espresso') |
331 | 331 | . '</a>'; |
@@ -338,8 +338,8 @@ discard block |
||
338 | 338 | $item->ID() |
339 | 339 | ) |
340 | 340 | ) { |
341 | - $actions['delete'] = '<a href="' . $delete_event_link . '"' |
|
342 | - . ' title="' . esc_attr__('Delete Permanently', 'event_espresso') . '">' |
|
341 | + $actions['delete'] = '<a href="'.$delete_event_link.'"' |
|
342 | + . ' title="'.esc_attr__('Delete Permanently', 'event_espresso').'">' |
|
343 | 343 | . esc_html__('Delete Permanently', 'event_espresso') |
344 | 344 | . '</a>'; |
345 | 345 | } |
@@ -351,8 +351,8 @@ discard block |
||
351 | 351 | $item->ID() |
352 | 352 | ) |
353 | 353 | ) { |
354 | - $actions['move to trash'] = '<a href="' . $trash_event_link . '"' |
|
355 | - . ' title="' . esc_attr__('Trash Event', 'event_espresso') . '">' |
|
354 | + $actions['move to trash'] = '<a href="'.$trash_event_link.'"' |
|
355 | + . ' title="'.esc_attr__('Trash Event', 'event_espresso').'">' |
|
356 | 356 | . esc_html__('Trash', 'event_espresso') |
357 | 357 | . '</a>'; |
358 | 358 | } |
@@ -377,8 +377,8 @@ discard block |
||
377 | 377 | 'EVT_wp_user' => $item->wp_user(), |
378 | 378 | ); |
379 | 379 | $filter_url = EE_Admin_Page::add_query_args_and_nonce($query_args, EVENTS_ADMIN_URL); |
380 | - return $gravatar . ' <a href="' . $filter_url . '"' |
|
381 | - . ' title="' . esc_attr__('Click to filter events by this author.', 'event_espresso') . '">' |
|
380 | + return $gravatar.' <a href="'.$filter_url.'"' |
|
381 | + . ' title="'.esc_attr__('Click to filter events by this author.', 'event_espresso').'">' |
|
382 | 382 | . $event_author->display_name |
383 | 383 | . '</a>'; |
384 | 384 | } |
@@ -395,7 +395,7 @@ discard block |
||
395 | 395 | return implode( |
396 | 396 | ', ', |
397 | 397 | array_map( |
398 | - function (EE_Term $category) { |
|
398 | + function(EE_Term $category) { |
|
399 | 399 | return $category->name(); |
400 | 400 | }, |
401 | 401 | $event_categories |
@@ -470,7 +470,7 @@ discard block |
||
470 | 470 | 'ee_read_registrations', |
471 | 471 | 'espresso_registrations_view_registration' |
472 | 472 | ) |
473 | - ? '<a href="' . $attendees_link . '">' . $registered_attendees . '</a>' |
|
473 | + ? '<a href="'.$attendees_link.'">'.$registered_attendees.'</a>' |
|
474 | 474 | : $registered_attendees; |
475 | 475 | } |
476 | 476 | |
@@ -500,13 +500,13 @@ discard block |
||
500 | 500 | public function column_actions(EE_Event $item) |
501 | 501 | { |
502 | 502 | // todo: remove when attendees is active |
503 | - if (! defined('REG_ADMIN_URL')) { |
|
503 | + if ( ! defined('REG_ADMIN_URL')) { |
|
504 | 504 | define('REG_ADMIN_URL', EVENTS_ADMIN_URL); |
505 | 505 | } |
506 | 506 | $action_links = array(); |
507 | 507 | $view_link = get_permalink($item->ID()); |
508 | - $action_links[] = '<a href="' . $view_link . '"' |
|
509 | - . ' title="' . esc_attr__('View Event', 'event_espresso') . '" target="_blank">'; |
|
508 | + $action_links[] = '<a href="'.$view_link.'"' |
|
509 | + . ' title="'.esc_attr__('View Event', 'event_espresso').'" target="_blank">'; |
|
510 | 510 | $action_links[] = '<div class="dashicons dashicons-search"></div></a>'; |
511 | 511 | if ( |
512 | 512 | EE_Registry::instance()->CAP->current_user_can( |
@@ -520,8 +520,8 @@ discard block |
||
520 | 520 | 'post' => $item->ID(), |
521 | 521 | ); |
522 | 522 | $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL); |
523 | - $action_links[] = '<a href="' . $edit_link . '"' |
|
524 | - . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">' |
|
523 | + $action_links[] = '<a href="'.$edit_link.'"' |
|
524 | + . ' title="'.esc_attr__('Edit Event', 'event_espresso').'">' |
|
525 | 525 | . '<div class="ee-icon ee-icon-calendar-edit"></div>' |
526 | 526 | . '</a>'; |
527 | 527 | } |
@@ -540,8 +540,8 @@ discard block |
||
540 | 540 | 'event_id' => $item->ID(), |
541 | 541 | ); |
542 | 542 | $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL); |
543 | - $action_links[] = '<a href="' . $attendees_link . '"' |
|
544 | - . ' title="' . esc_attr__('View Registrants', 'event_espresso') . '">' |
|
543 | + $action_links[] = '<a href="'.$attendees_link.'"' |
|
544 | + . ' title="'.esc_attr__('View Registrants', 'event_espresso').'">' |
|
545 | 545 | . '<div class="dashicons dashicons-groups"></div>' |
546 | 546 | . '</a>'; |
547 | 547 | } |
@@ -576,7 +576,7 @@ discard block |
||
576 | 576 | } |
577 | 577 | $column_array = []; |
578 | 578 | foreach ($this->_columns as $column => $column_label) { |
579 | - $column_array[ $column ] = $column_label; |
|
579 | + $column_array[$column] = $column_label; |
|
580 | 580 | if ($column === 'venue') { |
581 | 581 | $column_array['event_category'] = esc_html__('Event Category', 'event_espresso'); |
582 | 582 | } |
@@ -33,9 +33,6 @@ |
||
33 | 33 | use EE_WP_Post_Status_Field; |
34 | 34 | use EE_WP_Post_Type_Field; |
35 | 35 | use EE_WP_User_Field; |
36 | -use EventEspresso\core\exceptions\InvalidDataTypeException; |
|
37 | -use EventEspresso\core\exceptions\InvalidInterfaceException; |
|
38 | -use EventEspresso\core\services\loaders\LoaderFactory; |
|
39 | 36 | use EventEspresso\core\services\loaders\LoaderInterface; |
40 | 37 | use InvalidArgumentException; |
41 | 38 |
@@ -125,7 +125,6 @@ discard block |
||
125 | 125 | /** |
126 | 126 | * @param string $table_column |
127 | 127 | * @param string $nice_name |
128 | - * @param string $timezone_string |
|
129 | 128 | * @param bool $nullable |
130 | 129 | * @param string $default_value |
131 | 130 | * @throws EE_Error |
@@ -170,7 +169,7 @@ discard block |
||
170 | 169 | * @param string $table_column |
171 | 170 | * @param string $nice_name |
172 | 171 | * @param bool $nullable |
173 | - * @param null $default_value |
|
172 | + * @param integer $default_value |
|
174 | 173 | * @return EE_DB_Only_Int_Field |
175 | 174 | */ |
176 | 175 | public function createDbOnlyIntField($table_column, $nice_name, $nullable, $default_value = null) |
@@ -280,7 +279,7 @@ discard block |
||
280 | 279 | * @param string $table_column |
281 | 280 | * @param string $nice_name |
282 | 281 | * @param bool $nullable |
283 | - * @param null $default_value |
|
282 | + * @param integer $default_value |
|
284 | 283 | * @param string $model_name |
285 | 284 | * @return EE_Foreign_Key_Int_Field |
286 | 285 | */ |
@@ -297,7 +296,7 @@ discard block |
||
297 | 296 | * @param string $table_column |
298 | 297 | * @param string $nice_name |
299 | 298 | * @param bool $nullable |
300 | - * @param null $default_value |
|
299 | + * @param string $default_value |
|
301 | 300 | * @param string $model_name |
302 | 301 | * @return EE_Foreign_Key_String_Field |
303 | 302 | */ |
@@ -533,7 +532,7 @@ discard block |
||
533 | 532 | * @param string $table_column |
534 | 533 | * @param string $nice_name |
535 | 534 | * @param bool $nullable |
536 | - * @param mixed $default_value |
|
535 | + * @param string $default_value |
|
537 | 536 | * @param array $values If additional stati are to be used other than the default WP |
538 | 537 | * statuses, then they can be registered via this property. The |
539 | 538 | * format of the array should be as follows: array( |
@@ -51,547 +51,547 @@ |
||
51 | 51 | class ModelFieldFactory |
52 | 52 | { |
53 | 53 | |
54 | - /** |
|
55 | - * @var LoaderInterface $loader |
|
56 | - */ |
|
57 | - private $loader; |
|
58 | - |
|
59 | - |
|
60 | - /** |
|
61 | - * ModelFieldFactory constructor. |
|
62 | - * |
|
63 | - * @param LoaderInterface $loader |
|
64 | - */ |
|
65 | - public function __construct(LoaderInterface $loader) |
|
66 | - { |
|
67 | - $this->loader = $loader; |
|
68 | - } |
|
69 | - |
|
70 | - |
|
71 | - /** |
|
72 | - * @param string $table_column |
|
73 | - * @param string $nice_name |
|
74 | - * @param bool $nullable |
|
75 | - * @param null $default_value |
|
76 | - * @return EE_All_Caps_Text_Field |
|
77 | - */ |
|
78 | - public function createAllCapsTextField($table_column, $nice_name, $nullable, $default_value = null) |
|
79 | - { |
|
80 | - return $this->loader->getNew( |
|
81 | - 'EE_All_Caps_Text_Field', |
|
82 | - array($table_column, $nice_name, $nullable, $default_value) |
|
83 | - ); |
|
84 | - } |
|
85 | - |
|
86 | - |
|
87 | - /** |
|
88 | - * @param string $table_column |
|
89 | - * @param string $nice_name |
|
90 | - * @param bool $nullable |
|
91 | - * @param null $default_value |
|
92 | - * @param string $model_name |
|
93 | - * @return EE_Any_Foreign_Model_Name_Field |
|
94 | - */ |
|
95 | - public function createAnyForeignModelNameField( |
|
96 | - $table_column, |
|
97 | - $nice_name, |
|
98 | - $nullable, |
|
99 | - $default_value = null, |
|
100 | - $model_name |
|
101 | - ) { |
|
102 | - return $this->loader->getNew( |
|
103 | - 'EE_Any_Foreign_Model_Name_Field', |
|
104 | - array($table_column, $nice_name, $nullable, $default_value, $model_name) |
|
105 | - ); |
|
106 | - } |
|
107 | - |
|
108 | - |
|
109 | - /** |
|
110 | - * @param string $table_column |
|
111 | - * @param string $nice_name |
|
112 | - * @param bool $nullable |
|
113 | - * @param null $default_value |
|
114 | - * @return EE_Boolean_Field |
|
115 | - */ |
|
116 | - public function createBooleanField($table_column, $nice_name, $nullable, $default_value = null) |
|
117 | - { |
|
118 | - return $this->loader->getNew( |
|
119 | - 'EE_Boolean_Field', |
|
120 | - array($table_column, $nice_name, $nullable, $default_value) |
|
121 | - ); |
|
122 | - } |
|
123 | - |
|
124 | - |
|
125 | - /** |
|
126 | - * @param string $table_column |
|
127 | - * @param string $nice_name |
|
128 | - * @param string $timezone_string |
|
129 | - * @param bool $nullable |
|
130 | - * @param string $default_value |
|
131 | - * @throws EE_Error |
|
132 | - * @throws InvalidArgumentException |
|
133 | - * @return EE_Datetime_Field |
|
134 | - */ |
|
135 | - public function createDatetimeField( |
|
136 | - $table_column, |
|
137 | - $nice_name, |
|
138 | - $nullable = false, |
|
139 | - $default_value = EE_Datetime_Field::now |
|
140 | - ) { |
|
141 | - return $this->loader->getNew( |
|
142 | - 'EE_Datetime_Field', |
|
143 | - array( |
|
144 | - $table_column, |
|
145 | - $nice_name, |
|
146 | - $nullable, |
|
147 | - $default_value, |
|
148 | - ) |
|
149 | - ); |
|
150 | - } |
|
151 | - |
|
152 | - |
|
153 | - /** |
|
154 | - * @param string $table_column |
|
155 | - * @param string $nice_name |
|
156 | - * @param bool $nullable |
|
157 | - * @param null $default_value |
|
158 | - * @return EE_DB_Only_Float_Field |
|
159 | - */ |
|
160 | - public function createDbOnlyFloatField($table_column, $nice_name, $nullable, $default_value = null) |
|
161 | - { |
|
162 | - return $this->loader->getNew( |
|
163 | - 'EE_DB_Only_Float_Field', |
|
164 | - array($table_column, $nice_name, $nullable, $default_value) |
|
165 | - ); |
|
166 | - } |
|
167 | - |
|
168 | - |
|
169 | - /** |
|
170 | - * @param string $table_column |
|
171 | - * @param string $nice_name |
|
172 | - * @param bool $nullable |
|
173 | - * @param null $default_value |
|
174 | - * @return EE_DB_Only_Int_Field |
|
175 | - */ |
|
176 | - public function createDbOnlyIntField($table_column, $nice_name, $nullable, $default_value = null) |
|
177 | - { |
|
178 | - return $this->loader->getNew( |
|
179 | - 'EE_DB_Only_Int_Field', |
|
180 | - array($table_column, $nice_name, $nullable, $default_value) |
|
181 | - ); |
|
182 | - } |
|
183 | - |
|
184 | - |
|
185 | - /** |
|
186 | - * @param string $table_column |
|
187 | - * @param string $nice_name |
|
188 | - * @param bool $nullable |
|
189 | - * @param null $default_value |
|
190 | - * @return EE_DB_Only_Text_Field |
|
191 | - */ |
|
192 | - public function createDbOnlyTextField($table_column, $nice_name, $nullable, $default_value = null) |
|
193 | - { |
|
194 | - return $this->loader->getNew( |
|
195 | - 'EE_DB_Only_Text_Field', |
|
196 | - array($table_column, $nice_name, $nullable, $default_value) |
|
197 | - ); |
|
198 | - } |
|
199 | - |
|
200 | - |
|
201 | - /** |
|
202 | - * @param string $table_column |
|
203 | - * @param string $nice_name |
|
204 | - * @param bool $nullable |
|
205 | - * @param string $default_value |
|
206 | - * @return EE_Email_Field |
|
207 | - */ |
|
208 | - public function createEmailField($table_column, $nice_name, $nullable = true, $default_value = '') |
|
209 | - { |
|
210 | - return $this->loader->getNew( |
|
211 | - 'EE_Email_Field', |
|
212 | - array($table_column, $nice_name, $nullable, $default_value) |
|
213 | - ); |
|
214 | - } |
|
215 | - |
|
216 | - |
|
217 | - /** |
|
218 | - * @param string $table_column |
|
219 | - * @param string $nice_name |
|
220 | - * @param bool $nullable |
|
221 | - * @param null $default_value |
|
222 | - * @param array $allowed_enum_values keys are values to be used in the DB, |
|
223 | - * values are how they should be displayed |
|
224 | - * @return EE_Enum_Integer_Field |
|
225 | - */ |
|
226 | - public function createEnumIntegerField( |
|
227 | - $table_column, |
|
228 | - $nice_name, |
|
229 | - $nullable, |
|
230 | - $default_value = null, |
|
231 | - array $allowed_enum_values |
|
232 | - ) { |
|
233 | - return $this->loader->getNew( |
|
234 | - 'EE_Enum_Integer_Field', |
|
235 | - array($table_column, $nice_name, $nullable, $default_value, $allowed_enum_values) |
|
236 | - ); |
|
237 | - } |
|
238 | - |
|
239 | - |
|
240 | - /** |
|
241 | - * @param string $table_column |
|
242 | - * @param string $nice_name |
|
243 | - * @param bool $nullable |
|
244 | - * @param null $default_value |
|
245 | - * @param array $allowed_enum_values keys are values to be used in the DB, |
|
246 | - * values are how they should be displayed |
|
247 | - * @return EE_Enum_Text_Field |
|
248 | - */ |
|
249 | - public function createEnumTextField( |
|
250 | - $table_column, |
|
251 | - $nice_name, |
|
252 | - $nullable, |
|
253 | - $default_value, |
|
254 | - array $allowed_enum_values |
|
255 | - ) { |
|
256 | - return $this->loader->getNew( |
|
257 | - 'EE_Enum_Text_Field', |
|
258 | - array($table_column, $nice_name, $nullable, $default_value, $allowed_enum_values) |
|
259 | - ); |
|
260 | - } |
|
261 | - |
|
262 | - |
|
263 | - /** |
|
264 | - * @param string $table_column |
|
265 | - * @param string $nice_name |
|
266 | - * @param bool $nullable |
|
267 | - * @param null $default_value |
|
268 | - * @return EE_Float_Field |
|
269 | - */ |
|
270 | - public function createFloatField($table_column, $nice_name, $nullable, $default_value = null) |
|
271 | - { |
|
272 | - return $this->loader->getNew( |
|
273 | - 'EE_Float_Field', |
|
274 | - array($table_column, $nice_name, $nullable, $default_value) |
|
275 | - ); |
|
276 | - } |
|
277 | - |
|
278 | - |
|
279 | - /** |
|
280 | - * @param string $table_column |
|
281 | - * @param string $nice_name |
|
282 | - * @param bool $nullable |
|
283 | - * @param null $default_value |
|
284 | - * @param string $model_name |
|
285 | - * @return EE_Foreign_Key_Int_Field |
|
286 | - */ |
|
287 | - public function createForeignKeyIntField($table_column, $nice_name, $nullable, $default_value, $model_name) |
|
288 | - { |
|
289 | - return $this->loader->getNew( |
|
290 | - 'EE_Foreign_Key_Int_Field', |
|
291 | - array($table_column, $nice_name, $nullable, $default_value, $model_name) |
|
292 | - ); |
|
293 | - } |
|
294 | - |
|
295 | - |
|
296 | - /** |
|
297 | - * @param string $table_column |
|
298 | - * @param string $nice_name |
|
299 | - * @param bool $nullable |
|
300 | - * @param null $default_value |
|
301 | - * @param string $model_name |
|
302 | - * @return EE_Foreign_Key_String_Field |
|
303 | - */ |
|
304 | - public function createForeignKeyStringField( |
|
305 | - $table_column, |
|
306 | - $nice_name, |
|
307 | - $nullable, |
|
308 | - $default_value, |
|
309 | - $model_name |
|
310 | - ) { |
|
311 | - return $this->loader->getNew( |
|
312 | - 'EE_Foreign_Key_String_Field', |
|
313 | - array($table_column, $nice_name, $nullable, $default_value, $model_name) |
|
314 | - ); |
|
315 | - } |
|
316 | - |
|
317 | - |
|
318 | - /** |
|
319 | - * @param string $table_column |
|
320 | - * @param string $nice_name |
|
321 | - * @param bool $nullable |
|
322 | - * @param null $default_value |
|
323 | - * @return EE_Full_HTML_Field |
|
324 | - */ |
|
325 | - public function createFullHtmlField($table_column, $nice_name, $nullable, $default_value = null) |
|
326 | - { |
|
327 | - return $this->loader->getNew( |
|
328 | - 'EE_Full_HTML_Field', |
|
329 | - array($table_column, $nice_name, $nullable, $default_value) |
|
330 | - ); |
|
331 | - } |
|
332 | - |
|
333 | - |
|
334 | - /** |
|
335 | - * @param string $table_column |
|
336 | - * @param string $nice_name |
|
337 | - * @param bool $nullable |
|
338 | - * @param null $default_value |
|
339 | - * @return EE_Infinite_Integer_Field |
|
340 | - */ |
|
341 | - public function createInfiniteIntegerField($table_column, $nice_name, $nullable, $default_value = null) |
|
342 | - { |
|
343 | - return $this->loader->getNew( |
|
344 | - 'EE_Infinite_Integer_Field', |
|
345 | - array($table_column, $nice_name, $nullable, $default_value) |
|
346 | - ); |
|
347 | - } |
|
348 | - |
|
349 | - |
|
350 | - /** |
|
351 | - * @param string $table_column |
|
352 | - * @param string $nice_name |
|
353 | - * @param bool $nullable |
|
354 | - * @param integer $default_value |
|
355 | - * @return EE_Integer_Field |
|
356 | - */ |
|
357 | - public function createIntegerField($table_column, $nice_name, $nullable = false, $default_value = 0) |
|
358 | - { |
|
359 | - return $this->loader->getNew( |
|
360 | - 'EE_Integer_Field', |
|
361 | - array($table_column, $nice_name, $nullable, $default_value) |
|
362 | - ); |
|
363 | - } |
|
364 | - |
|
365 | - |
|
366 | - /** |
|
367 | - * @param string $table_column |
|
368 | - * @param string $nice_name |
|
369 | - * @param bool $nullable |
|
370 | - * @param null $default_value |
|
371 | - * @return EE_Maybe_Serialized_Simple_HTML_Field |
|
372 | - */ |
|
373 | - public function createMaybeSerializedSimpleHtmlField($table_column, $nice_name, $nullable, $default_value = null) |
|
374 | - { |
|
375 | - return $this->loader->getNew( |
|
376 | - 'EE_Maybe_Serialized_Simple_HTML_Field', |
|
377 | - array($table_column, $nice_name, $nullable, $default_value) |
|
378 | - ); |
|
379 | - } |
|
380 | - |
|
381 | - |
|
382 | - /** |
|
383 | - * @param string $table_column |
|
384 | - * @param string $nice_name |
|
385 | - * @param bool $nullable |
|
386 | - * @param null $default_value |
|
387 | - * @return EE_Maybe_Serialized_Text_Field |
|
388 | - */ |
|
389 | - public function createMaybeSerializedTextField($table_column, $nice_name, $nullable, $default_value = null) |
|
390 | - { |
|
391 | - return $this->loader->getNew( |
|
392 | - 'EE_Maybe_Serialized_Text_Field', |
|
393 | - array($table_column, $nice_name, $nullable, $default_value) |
|
394 | - ); |
|
395 | - } |
|
396 | - |
|
397 | - |
|
398 | - /** |
|
399 | - * @param string $table_column |
|
400 | - * @param string $nice_name |
|
401 | - * @param bool $nullable |
|
402 | - * @param null $default_value |
|
403 | - * @return EE_Money_Field |
|
404 | - */ |
|
405 | - public function createMoneyField($table_column, $nice_name, $nullable, $default_value = null) |
|
406 | - { |
|
407 | - return $this->loader->getNew( |
|
408 | - 'EE_Money_Field', |
|
409 | - array($table_column, $nice_name, $nullable, $default_value) |
|
410 | - ); |
|
411 | - } |
|
412 | - |
|
413 | - |
|
414 | - /** |
|
415 | - * @param string $table_column |
|
416 | - * @param string $nice_name |
|
417 | - * @param bool $nullable |
|
418 | - * @param string $default_value |
|
419 | - * @return EE_Plain_Text_Field |
|
420 | - */ |
|
421 | - public function createPlainTextField($table_column, $nice_name, $nullable = true, $default_value = '') |
|
422 | - { |
|
423 | - return $this->loader->getNew( |
|
424 | - 'EE_Plain_Text_Field', |
|
425 | - array($table_column, $nice_name, $nullable, $default_value) |
|
426 | - ); |
|
427 | - } |
|
428 | - |
|
429 | - |
|
430 | - /** |
|
431 | - * @param string $table_column |
|
432 | - * @param string $nice_name |
|
433 | - * @param bool $nullable |
|
434 | - * @param null $default_value |
|
435 | - * @return EE_Post_Content_Field |
|
436 | - */ |
|
437 | - public function createPostContentField($table_column, $nice_name, $nullable, $default_value = null) |
|
438 | - { |
|
439 | - return $this->loader->getNew( |
|
440 | - 'EE_Post_Content_Field', |
|
441 | - array($table_column, $nice_name, $nullable, $default_value) |
|
442 | - ); |
|
443 | - } |
|
444 | - |
|
445 | - |
|
446 | - /** |
|
447 | - * @param string $table_column |
|
448 | - * @param string $nice_name |
|
449 | - * @return EE_Primary_Key_Int_Field |
|
450 | - */ |
|
451 | - public function createPrimaryKeyIntField($table_column, $nice_name) |
|
452 | - { |
|
453 | - return $this->loader->getNew('EE_Primary_Key_Int_Field', array($table_column, $nice_name)); |
|
454 | - } |
|
455 | - |
|
456 | - |
|
457 | - /** |
|
458 | - * @param string $table_column |
|
459 | - * @param string $nice_name |
|
460 | - * @return EE_Primary_Key_String_Field |
|
461 | - */ |
|
462 | - public function createPrimaryKeyStringField($table_column, $nice_name) |
|
463 | - { |
|
464 | - return $this->loader->getNew('EE_Primary_Key_String_Field', array($table_column, $nice_name)); |
|
465 | - } |
|
466 | - |
|
467 | - |
|
468 | - /** |
|
469 | - * @param string $table_column |
|
470 | - * @param string $nice_name |
|
471 | - * @param bool $nullable |
|
472 | - * @param null $default_value |
|
473 | - * @return EE_Serialized_Text_Field |
|
474 | - */ |
|
475 | - public function createSerializedTextField($table_column, $nice_name, $nullable, $default_value = null) |
|
476 | - { |
|
477 | - return $this->loader->getNew( |
|
478 | - 'EE_Serialized_Text_Field', |
|
479 | - array($table_column, $nice_name, $nullable, $default_value) |
|
480 | - ); |
|
481 | - } |
|
482 | - |
|
483 | - |
|
484 | - /** |
|
485 | - * @param string $table_column |
|
486 | - * @param string $nice_name |
|
487 | - * @param bool $nullable |
|
488 | - * @param null $default_value |
|
489 | - * @return EE_Simple_HTML_Field |
|
490 | - */ |
|
491 | - public function createSimpleHtmlField($table_column, $nice_name, $nullable, $default_value = null) |
|
492 | - { |
|
493 | - return $this->loader->getNew( |
|
494 | - 'EE_Simple_HTML_Field', |
|
495 | - array($table_column, $nice_name, $nullable, $default_value) |
|
496 | - ); |
|
497 | - } |
|
498 | - |
|
499 | - |
|
500 | - /** |
|
501 | - * @param string $table_column |
|
502 | - * @param string $nice_name |
|
503 | - * @param bool $nullable |
|
504 | - * @param null $default_value |
|
505 | - * @return EE_Slug_Field |
|
506 | - */ |
|
507 | - public function createSlugField($table_column, $nice_name, $nullable = false, $default_value = null) |
|
508 | - { |
|
509 | - return $this->loader->getNew( |
|
510 | - 'EE_Slug_Field', |
|
511 | - array($table_column, $nice_name, $nullable, $default_value) |
|
512 | - ); |
|
513 | - } |
|
514 | - |
|
515 | - |
|
516 | - /** |
|
517 | - * @param string $table_column |
|
518 | - * @param string $nice_name |
|
519 | - * @param bool $nullable |
|
520 | - * @param null $default_value |
|
521 | - * @return EE_Trashed_Flag_Field |
|
522 | - */ |
|
523 | - public function createTrashedFlagField($table_column, $nice_name, $nullable, $default_value = null) |
|
524 | - { |
|
525 | - return $this->loader->getNew( |
|
526 | - 'EE_Trashed_Flag_Field', |
|
527 | - array($table_column, $nice_name, $nullable, $default_value) |
|
528 | - ); |
|
529 | - } |
|
530 | - |
|
531 | - |
|
532 | - /** |
|
533 | - * @param string $table_column |
|
534 | - * @param string $nice_name |
|
535 | - * @param bool $nullable |
|
536 | - * @param mixed $default_value |
|
537 | - * @param array $values If additional stati are to be used other than the default WP |
|
538 | - * statuses, then they can be registered via this property. The |
|
539 | - * format of the array should be as follows: array( |
|
540 | - * 'status_reference' => array( |
|
541 | - * 'label' => __('Status Reference Label', 'event_espresso'), |
|
542 | - * 'public' => true, // whether this status should |
|
543 | - * be shown on the frontend of the site |
|
544 | - * 'exclude_from_search' => false, // whether this status should |
|
545 | - * be excluded from wp searches |
|
546 | - * 'show_in_admin_all_list' => true, // whether this status is |
|
547 | - * included in queries for the admin "all" view in list table |
|
548 | - * views. |
|
549 | - * 'show_in_admin_status_list' => true, // show in the list of |
|
550 | - * statuses with post counts at the top of the admin list tables |
|
551 | - * (i.e. Status Reference(2) ) |
|
552 | - * 'label_count' => _n_noop( |
|
553 | - * 'Status Reference <span class="count">(%s)</span>', |
|
554 | - * 'Status References <span class="count">(%s)</span>' |
|
555 | - * ), // the text to display on |
|
556 | - * the admin screen |
|
557 | - * ( or you won't see your status count ). |
|
558 | - * ) |
|
559 | - * ) |
|
560 | - * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info |
|
561 | - * @return EE_WP_Post_Status_Field |
|
562 | - */ |
|
563 | - public function createWpPostStatusField( |
|
564 | - $table_column, |
|
565 | - $nice_name, |
|
566 | - $nullable, |
|
567 | - $default_value = null, |
|
568 | - array $values = array() |
|
569 | - ) { |
|
570 | - return $this->loader->getNew( |
|
571 | - 'EE_WP_Post_Status_Field', |
|
572 | - array($table_column, $nice_name, $nullable, $default_value, $values) |
|
573 | - ); |
|
574 | - } |
|
575 | - |
|
576 | - |
|
577 | - /** |
|
578 | - * @param string $post_type |
|
579 | - * @return EE_WP_Post_Type_Field |
|
580 | - */ |
|
581 | - public function createWpPostTypeField($post_type) |
|
582 | - { |
|
583 | - return $this->loader->getNew('EE_WP_Post_Type_Field', array($post_type)); |
|
584 | - } |
|
585 | - |
|
586 | - |
|
587 | - /** |
|
588 | - * @param string $table_column |
|
589 | - * @param string $nice_name |
|
590 | - * @param bool $nullable |
|
591 | - * @return EE_WP_User_Field |
|
592 | - */ |
|
593 | - public function createWpUserField($table_column, $nice_name, $nullable) |
|
594 | - { |
|
595 | - return $this->loader->getNew('EE_WP_User_Field', array($table_column, $nice_name, $nullable)); |
|
596 | - } |
|
54 | + /** |
|
55 | + * @var LoaderInterface $loader |
|
56 | + */ |
|
57 | + private $loader; |
|
58 | + |
|
59 | + |
|
60 | + /** |
|
61 | + * ModelFieldFactory constructor. |
|
62 | + * |
|
63 | + * @param LoaderInterface $loader |
|
64 | + */ |
|
65 | + public function __construct(LoaderInterface $loader) |
|
66 | + { |
|
67 | + $this->loader = $loader; |
|
68 | + } |
|
69 | + |
|
70 | + |
|
71 | + /** |
|
72 | + * @param string $table_column |
|
73 | + * @param string $nice_name |
|
74 | + * @param bool $nullable |
|
75 | + * @param null $default_value |
|
76 | + * @return EE_All_Caps_Text_Field |
|
77 | + */ |
|
78 | + public function createAllCapsTextField($table_column, $nice_name, $nullable, $default_value = null) |
|
79 | + { |
|
80 | + return $this->loader->getNew( |
|
81 | + 'EE_All_Caps_Text_Field', |
|
82 | + array($table_column, $nice_name, $nullable, $default_value) |
|
83 | + ); |
|
84 | + } |
|
85 | + |
|
86 | + |
|
87 | + /** |
|
88 | + * @param string $table_column |
|
89 | + * @param string $nice_name |
|
90 | + * @param bool $nullable |
|
91 | + * @param null $default_value |
|
92 | + * @param string $model_name |
|
93 | + * @return EE_Any_Foreign_Model_Name_Field |
|
94 | + */ |
|
95 | + public function createAnyForeignModelNameField( |
|
96 | + $table_column, |
|
97 | + $nice_name, |
|
98 | + $nullable, |
|
99 | + $default_value = null, |
|
100 | + $model_name |
|
101 | + ) { |
|
102 | + return $this->loader->getNew( |
|
103 | + 'EE_Any_Foreign_Model_Name_Field', |
|
104 | + array($table_column, $nice_name, $nullable, $default_value, $model_name) |
|
105 | + ); |
|
106 | + } |
|
107 | + |
|
108 | + |
|
109 | + /** |
|
110 | + * @param string $table_column |
|
111 | + * @param string $nice_name |
|
112 | + * @param bool $nullable |
|
113 | + * @param null $default_value |
|
114 | + * @return EE_Boolean_Field |
|
115 | + */ |
|
116 | + public function createBooleanField($table_column, $nice_name, $nullable, $default_value = null) |
|
117 | + { |
|
118 | + return $this->loader->getNew( |
|
119 | + 'EE_Boolean_Field', |
|
120 | + array($table_column, $nice_name, $nullable, $default_value) |
|
121 | + ); |
|
122 | + } |
|
123 | + |
|
124 | + |
|
125 | + /** |
|
126 | + * @param string $table_column |
|
127 | + * @param string $nice_name |
|
128 | + * @param string $timezone_string |
|
129 | + * @param bool $nullable |
|
130 | + * @param string $default_value |
|
131 | + * @throws EE_Error |
|
132 | + * @throws InvalidArgumentException |
|
133 | + * @return EE_Datetime_Field |
|
134 | + */ |
|
135 | + public function createDatetimeField( |
|
136 | + $table_column, |
|
137 | + $nice_name, |
|
138 | + $nullable = false, |
|
139 | + $default_value = EE_Datetime_Field::now |
|
140 | + ) { |
|
141 | + return $this->loader->getNew( |
|
142 | + 'EE_Datetime_Field', |
|
143 | + array( |
|
144 | + $table_column, |
|
145 | + $nice_name, |
|
146 | + $nullable, |
|
147 | + $default_value, |
|
148 | + ) |
|
149 | + ); |
|
150 | + } |
|
151 | + |
|
152 | + |
|
153 | + /** |
|
154 | + * @param string $table_column |
|
155 | + * @param string $nice_name |
|
156 | + * @param bool $nullable |
|
157 | + * @param null $default_value |
|
158 | + * @return EE_DB_Only_Float_Field |
|
159 | + */ |
|
160 | + public function createDbOnlyFloatField($table_column, $nice_name, $nullable, $default_value = null) |
|
161 | + { |
|
162 | + return $this->loader->getNew( |
|
163 | + 'EE_DB_Only_Float_Field', |
|
164 | + array($table_column, $nice_name, $nullable, $default_value) |
|
165 | + ); |
|
166 | + } |
|
167 | + |
|
168 | + |
|
169 | + /** |
|
170 | + * @param string $table_column |
|
171 | + * @param string $nice_name |
|
172 | + * @param bool $nullable |
|
173 | + * @param null $default_value |
|
174 | + * @return EE_DB_Only_Int_Field |
|
175 | + */ |
|
176 | + public function createDbOnlyIntField($table_column, $nice_name, $nullable, $default_value = null) |
|
177 | + { |
|
178 | + return $this->loader->getNew( |
|
179 | + 'EE_DB_Only_Int_Field', |
|
180 | + array($table_column, $nice_name, $nullable, $default_value) |
|
181 | + ); |
|
182 | + } |
|
183 | + |
|
184 | + |
|
185 | + /** |
|
186 | + * @param string $table_column |
|
187 | + * @param string $nice_name |
|
188 | + * @param bool $nullable |
|
189 | + * @param null $default_value |
|
190 | + * @return EE_DB_Only_Text_Field |
|
191 | + */ |
|
192 | + public function createDbOnlyTextField($table_column, $nice_name, $nullable, $default_value = null) |
|
193 | + { |
|
194 | + return $this->loader->getNew( |
|
195 | + 'EE_DB_Only_Text_Field', |
|
196 | + array($table_column, $nice_name, $nullable, $default_value) |
|
197 | + ); |
|
198 | + } |
|
199 | + |
|
200 | + |
|
201 | + /** |
|
202 | + * @param string $table_column |
|
203 | + * @param string $nice_name |
|
204 | + * @param bool $nullable |
|
205 | + * @param string $default_value |
|
206 | + * @return EE_Email_Field |
|
207 | + */ |
|
208 | + public function createEmailField($table_column, $nice_name, $nullable = true, $default_value = '') |
|
209 | + { |
|
210 | + return $this->loader->getNew( |
|
211 | + 'EE_Email_Field', |
|
212 | + array($table_column, $nice_name, $nullable, $default_value) |
|
213 | + ); |
|
214 | + } |
|
215 | + |
|
216 | + |
|
217 | + /** |
|
218 | + * @param string $table_column |
|
219 | + * @param string $nice_name |
|
220 | + * @param bool $nullable |
|
221 | + * @param null $default_value |
|
222 | + * @param array $allowed_enum_values keys are values to be used in the DB, |
|
223 | + * values are how they should be displayed |
|
224 | + * @return EE_Enum_Integer_Field |
|
225 | + */ |
|
226 | + public function createEnumIntegerField( |
|
227 | + $table_column, |
|
228 | + $nice_name, |
|
229 | + $nullable, |
|
230 | + $default_value = null, |
|
231 | + array $allowed_enum_values |
|
232 | + ) { |
|
233 | + return $this->loader->getNew( |
|
234 | + 'EE_Enum_Integer_Field', |
|
235 | + array($table_column, $nice_name, $nullable, $default_value, $allowed_enum_values) |
|
236 | + ); |
|
237 | + } |
|
238 | + |
|
239 | + |
|
240 | + /** |
|
241 | + * @param string $table_column |
|
242 | + * @param string $nice_name |
|
243 | + * @param bool $nullable |
|
244 | + * @param null $default_value |
|
245 | + * @param array $allowed_enum_values keys are values to be used in the DB, |
|
246 | + * values are how they should be displayed |
|
247 | + * @return EE_Enum_Text_Field |
|
248 | + */ |
|
249 | + public function createEnumTextField( |
|
250 | + $table_column, |
|
251 | + $nice_name, |
|
252 | + $nullable, |
|
253 | + $default_value, |
|
254 | + array $allowed_enum_values |
|
255 | + ) { |
|
256 | + return $this->loader->getNew( |
|
257 | + 'EE_Enum_Text_Field', |
|
258 | + array($table_column, $nice_name, $nullable, $default_value, $allowed_enum_values) |
|
259 | + ); |
|
260 | + } |
|
261 | + |
|
262 | + |
|
263 | + /** |
|
264 | + * @param string $table_column |
|
265 | + * @param string $nice_name |
|
266 | + * @param bool $nullable |
|
267 | + * @param null $default_value |
|
268 | + * @return EE_Float_Field |
|
269 | + */ |
|
270 | + public function createFloatField($table_column, $nice_name, $nullable, $default_value = null) |
|
271 | + { |
|
272 | + return $this->loader->getNew( |
|
273 | + 'EE_Float_Field', |
|
274 | + array($table_column, $nice_name, $nullable, $default_value) |
|
275 | + ); |
|
276 | + } |
|
277 | + |
|
278 | + |
|
279 | + /** |
|
280 | + * @param string $table_column |
|
281 | + * @param string $nice_name |
|
282 | + * @param bool $nullable |
|
283 | + * @param null $default_value |
|
284 | + * @param string $model_name |
|
285 | + * @return EE_Foreign_Key_Int_Field |
|
286 | + */ |
|
287 | + public function createForeignKeyIntField($table_column, $nice_name, $nullable, $default_value, $model_name) |
|
288 | + { |
|
289 | + return $this->loader->getNew( |
|
290 | + 'EE_Foreign_Key_Int_Field', |
|
291 | + array($table_column, $nice_name, $nullable, $default_value, $model_name) |
|
292 | + ); |
|
293 | + } |
|
294 | + |
|
295 | + |
|
296 | + /** |
|
297 | + * @param string $table_column |
|
298 | + * @param string $nice_name |
|
299 | + * @param bool $nullable |
|
300 | + * @param null $default_value |
|
301 | + * @param string $model_name |
|
302 | + * @return EE_Foreign_Key_String_Field |
|
303 | + */ |
|
304 | + public function createForeignKeyStringField( |
|
305 | + $table_column, |
|
306 | + $nice_name, |
|
307 | + $nullable, |
|
308 | + $default_value, |
|
309 | + $model_name |
|
310 | + ) { |
|
311 | + return $this->loader->getNew( |
|
312 | + 'EE_Foreign_Key_String_Field', |
|
313 | + array($table_column, $nice_name, $nullable, $default_value, $model_name) |
|
314 | + ); |
|
315 | + } |
|
316 | + |
|
317 | + |
|
318 | + /** |
|
319 | + * @param string $table_column |
|
320 | + * @param string $nice_name |
|
321 | + * @param bool $nullable |
|
322 | + * @param null $default_value |
|
323 | + * @return EE_Full_HTML_Field |
|
324 | + */ |
|
325 | + public function createFullHtmlField($table_column, $nice_name, $nullable, $default_value = null) |
|
326 | + { |
|
327 | + return $this->loader->getNew( |
|
328 | + 'EE_Full_HTML_Field', |
|
329 | + array($table_column, $nice_name, $nullable, $default_value) |
|
330 | + ); |
|
331 | + } |
|
332 | + |
|
333 | + |
|
334 | + /** |
|
335 | + * @param string $table_column |
|
336 | + * @param string $nice_name |
|
337 | + * @param bool $nullable |
|
338 | + * @param null $default_value |
|
339 | + * @return EE_Infinite_Integer_Field |
|
340 | + */ |
|
341 | + public function createInfiniteIntegerField($table_column, $nice_name, $nullable, $default_value = null) |
|
342 | + { |
|
343 | + return $this->loader->getNew( |
|
344 | + 'EE_Infinite_Integer_Field', |
|
345 | + array($table_column, $nice_name, $nullable, $default_value) |
|
346 | + ); |
|
347 | + } |
|
348 | + |
|
349 | + |
|
350 | + /** |
|
351 | + * @param string $table_column |
|
352 | + * @param string $nice_name |
|
353 | + * @param bool $nullable |
|
354 | + * @param integer $default_value |
|
355 | + * @return EE_Integer_Field |
|
356 | + */ |
|
357 | + public function createIntegerField($table_column, $nice_name, $nullable = false, $default_value = 0) |
|
358 | + { |
|
359 | + return $this->loader->getNew( |
|
360 | + 'EE_Integer_Field', |
|
361 | + array($table_column, $nice_name, $nullable, $default_value) |
|
362 | + ); |
|
363 | + } |
|
364 | + |
|
365 | + |
|
366 | + /** |
|
367 | + * @param string $table_column |
|
368 | + * @param string $nice_name |
|
369 | + * @param bool $nullable |
|
370 | + * @param null $default_value |
|
371 | + * @return EE_Maybe_Serialized_Simple_HTML_Field |
|
372 | + */ |
|
373 | + public function createMaybeSerializedSimpleHtmlField($table_column, $nice_name, $nullable, $default_value = null) |
|
374 | + { |
|
375 | + return $this->loader->getNew( |
|
376 | + 'EE_Maybe_Serialized_Simple_HTML_Field', |
|
377 | + array($table_column, $nice_name, $nullable, $default_value) |
|
378 | + ); |
|
379 | + } |
|
380 | + |
|
381 | + |
|
382 | + /** |
|
383 | + * @param string $table_column |
|
384 | + * @param string $nice_name |
|
385 | + * @param bool $nullable |
|
386 | + * @param null $default_value |
|
387 | + * @return EE_Maybe_Serialized_Text_Field |
|
388 | + */ |
|
389 | + public function createMaybeSerializedTextField($table_column, $nice_name, $nullable, $default_value = null) |
|
390 | + { |
|
391 | + return $this->loader->getNew( |
|
392 | + 'EE_Maybe_Serialized_Text_Field', |
|
393 | + array($table_column, $nice_name, $nullable, $default_value) |
|
394 | + ); |
|
395 | + } |
|
396 | + |
|
397 | + |
|
398 | + /** |
|
399 | + * @param string $table_column |
|
400 | + * @param string $nice_name |
|
401 | + * @param bool $nullable |
|
402 | + * @param null $default_value |
|
403 | + * @return EE_Money_Field |
|
404 | + */ |
|
405 | + public function createMoneyField($table_column, $nice_name, $nullable, $default_value = null) |
|
406 | + { |
|
407 | + return $this->loader->getNew( |
|
408 | + 'EE_Money_Field', |
|
409 | + array($table_column, $nice_name, $nullable, $default_value) |
|
410 | + ); |
|
411 | + } |
|
412 | + |
|
413 | + |
|
414 | + /** |
|
415 | + * @param string $table_column |
|
416 | + * @param string $nice_name |
|
417 | + * @param bool $nullable |
|
418 | + * @param string $default_value |
|
419 | + * @return EE_Plain_Text_Field |
|
420 | + */ |
|
421 | + public function createPlainTextField($table_column, $nice_name, $nullable = true, $default_value = '') |
|
422 | + { |
|
423 | + return $this->loader->getNew( |
|
424 | + 'EE_Plain_Text_Field', |
|
425 | + array($table_column, $nice_name, $nullable, $default_value) |
|
426 | + ); |
|
427 | + } |
|
428 | + |
|
429 | + |
|
430 | + /** |
|
431 | + * @param string $table_column |
|
432 | + * @param string $nice_name |
|
433 | + * @param bool $nullable |
|
434 | + * @param null $default_value |
|
435 | + * @return EE_Post_Content_Field |
|
436 | + */ |
|
437 | + public function createPostContentField($table_column, $nice_name, $nullable, $default_value = null) |
|
438 | + { |
|
439 | + return $this->loader->getNew( |
|
440 | + 'EE_Post_Content_Field', |
|
441 | + array($table_column, $nice_name, $nullable, $default_value) |
|
442 | + ); |
|
443 | + } |
|
444 | + |
|
445 | + |
|
446 | + /** |
|
447 | + * @param string $table_column |
|
448 | + * @param string $nice_name |
|
449 | + * @return EE_Primary_Key_Int_Field |
|
450 | + */ |
|
451 | + public function createPrimaryKeyIntField($table_column, $nice_name) |
|
452 | + { |
|
453 | + return $this->loader->getNew('EE_Primary_Key_Int_Field', array($table_column, $nice_name)); |
|
454 | + } |
|
455 | + |
|
456 | + |
|
457 | + /** |
|
458 | + * @param string $table_column |
|
459 | + * @param string $nice_name |
|
460 | + * @return EE_Primary_Key_String_Field |
|
461 | + */ |
|
462 | + public function createPrimaryKeyStringField($table_column, $nice_name) |
|
463 | + { |
|
464 | + return $this->loader->getNew('EE_Primary_Key_String_Field', array($table_column, $nice_name)); |
|
465 | + } |
|
466 | + |
|
467 | + |
|
468 | + /** |
|
469 | + * @param string $table_column |
|
470 | + * @param string $nice_name |
|
471 | + * @param bool $nullable |
|
472 | + * @param null $default_value |
|
473 | + * @return EE_Serialized_Text_Field |
|
474 | + */ |
|
475 | + public function createSerializedTextField($table_column, $nice_name, $nullable, $default_value = null) |
|
476 | + { |
|
477 | + return $this->loader->getNew( |
|
478 | + 'EE_Serialized_Text_Field', |
|
479 | + array($table_column, $nice_name, $nullable, $default_value) |
|
480 | + ); |
|
481 | + } |
|
482 | + |
|
483 | + |
|
484 | + /** |
|
485 | + * @param string $table_column |
|
486 | + * @param string $nice_name |
|
487 | + * @param bool $nullable |
|
488 | + * @param null $default_value |
|
489 | + * @return EE_Simple_HTML_Field |
|
490 | + */ |
|
491 | + public function createSimpleHtmlField($table_column, $nice_name, $nullable, $default_value = null) |
|
492 | + { |
|
493 | + return $this->loader->getNew( |
|
494 | + 'EE_Simple_HTML_Field', |
|
495 | + array($table_column, $nice_name, $nullable, $default_value) |
|
496 | + ); |
|
497 | + } |
|
498 | + |
|
499 | + |
|
500 | + /** |
|
501 | + * @param string $table_column |
|
502 | + * @param string $nice_name |
|
503 | + * @param bool $nullable |
|
504 | + * @param null $default_value |
|
505 | + * @return EE_Slug_Field |
|
506 | + */ |
|
507 | + public function createSlugField($table_column, $nice_name, $nullable = false, $default_value = null) |
|
508 | + { |
|
509 | + return $this->loader->getNew( |
|
510 | + 'EE_Slug_Field', |
|
511 | + array($table_column, $nice_name, $nullable, $default_value) |
|
512 | + ); |
|
513 | + } |
|
514 | + |
|
515 | + |
|
516 | + /** |
|
517 | + * @param string $table_column |
|
518 | + * @param string $nice_name |
|
519 | + * @param bool $nullable |
|
520 | + * @param null $default_value |
|
521 | + * @return EE_Trashed_Flag_Field |
|
522 | + */ |
|
523 | + public function createTrashedFlagField($table_column, $nice_name, $nullable, $default_value = null) |
|
524 | + { |
|
525 | + return $this->loader->getNew( |
|
526 | + 'EE_Trashed_Flag_Field', |
|
527 | + array($table_column, $nice_name, $nullable, $default_value) |
|
528 | + ); |
|
529 | + } |
|
530 | + |
|
531 | + |
|
532 | + /** |
|
533 | + * @param string $table_column |
|
534 | + * @param string $nice_name |
|
535 | + * @param bool $nullable |
|
536 | + * @param mixed $default_value |
|
537 | + * @param array $values If additional stati are to be used other than the default WP |
|
538 | + * statuses, then they can be registered via this property. The |
|
539 | + * format of the array should be as follows: array( |
|
540 | + * 'status_reference' => array( |
|
541 | + * 'label' => __('Status Reference Label', 'event_espresso'), |
|
542 | + * 'public' => true, // whether this status should |
|
543 | + * be shown on the frontend of the site |
|
544 | + * 'exclude_from_search' => false, // whether this status should |
|
545 | + * be excluded from wp searches |
|
546 | + * 'show_in_admin_all_list' => true, // whether this status is |
|
547 | + * included in queries for the admin "all" view in list table |
|
548 | + * views. |
|
549 | + * 'show_in_admin_status_list' => true, // show in the list of |
|
550 | + * statuses with post counts at the top of the admin list tables |
|
551 | + * (i.e. Status Reference(2) ) |
|
552 | + * 'label_count' => _n_noop( |
|
553 | + * 'Status Reference <span class="count">(%s)</span>', |
|
554 | + * 'Status References <span class="count">(%s)</span>' |
|
555 | + * ), // the text to display on |
|
556 | + * the admin screen |
|
557 | + * ( or you won't see your status count ). |
|
558 | + * ) |
|
559 | + * ) |
|
560 | + * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info |
|
561 | + * @return EE_WP_Post_Status_Field |
|
562 | + */ |
|
563 | + public function createWpPostStatusField( |
|
564 | + $table_column, |
|
565 | + $nice_name, |
|
566 | + $nullable, |
|
567 | + $default_value = null, |
|
568 | + array $values = array() |
|
569 | + ) { |
|
570 | + return $this->loader->getNew( |
|
571 | + 'EE_WP_Post_Status_Field', |
|
572 | + array($table_column, $nice_name, $nullable, $default_value, $values) |
|
573 | + ); |
|
574 | + } |
|
575 | + |
|
576 | + |
|
577 | + /** |
|
578 | + * @param string $post_type |
|
579 | + * @return EE_WP_Post_Type_Field |
|
580 | + */ |
|
581 | + public function createWpPostTypeField($post_type) |
|
582 | + { |
|
583 | + return $this->loader->getNew('EE_WP_Post_Type_Field', array($post_type)); |
|
584 | + } |
|
585 | + |
|
586 | + |
|
587 | + /** |
|
588 | + * @param string $table_column |
|
589 | + * @param string $nice_name |
|
590 | + * @param bool $nullable |
|
591 | + * @return EE_WP_User_Field |
|
592 | + */ |
|
593 | + public function createWpUserField($table_column, $nice_name, $nullable) |
|
594 | + { |
|
595 | + return $this->loader->getNew('EE_WP_User_Field', array($table_column, $nice_name, $nullable)); |
|
596 | + } |
|
597 | 597 | } |