@@ -69,10 +69,10 @@ discard block |
||
69 | 69 | * @return string |
70 | 70 | * @todo: at some point we can break this down into other static methods to abstract it a bit better. |
71 | 71 | */ |
72 | - static public function get_form_fields( $input_vars = array(), $id = FALSE ) { |
|
72 | + static public function get_form_fields($input_vars = array(), $id = FALSE) { |
|
73 | 73 | |
74 | - if ( empty($input_vars) ) { |
|
75 | - EE_Error::add_error( __('missing required variables for the form field generator', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
74 | + if (empty($input_vars)) { |
|
75 | + EE_Error::add_error(__('missing required variables for the form field generator', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
76 | 76 | return FALSE; |
77 | 77 | } |
78 | 78 | |
@@ -98,25 +98,25 @@ discard block |
||
98 | 98 | 'append_content' => '' |
99 | 99 | ); |
100 | 100 | |
101 | - $input_value = wp_parse_args( $input_value, $defaults ); |
|
101 | + $input_value = wp_parse_args($input_value, $defaults); |
|
102 | 102 | |
103 | 103 | // required fields get a * |
104 | 104 | $required = isset($input_value['required']) && $input_value['required'] ? ' <span>*</span>: ' : ': '; |
105 | 105 | // and the css class "required" |
106 | - $css_class = isset( $input_value['css_class'] ) ? $input_value['css_class'] : ''; |
|
107 | - $styles = $input_value['required'] ? 'required ' . $css_class : $css_class; |
|
106 | + $css_class = isset($input_value['css_class']) ? $input_value['css_class'] : ''; |
|
107 | + $styles = $input_value['required'] ? 'required '.$css_class : $css_class; |
|
108 | 108 | |
109 | - $field_id = ($id) ? $id . '-' . $input_key : $input_key; |
|
110 | - $tabindex = !empty($input_value['tabindex']) ? ' tabindex="' . $input_value['tabindex'] . '"' : ''; |
|
109 | + $field_id = ($id) ? $id.'-'.$input_key : $input_key; |
|
110 | + $tabindex = ! empty($input_value['tabindex']) ? ' tabindex="'.$input_value['tabindex'].'"' : ''; |
|
111 | 111 | |
112 | 112 | //rows or cols? |
113 | - $rows = isset($input_value['rows'] ) ? $input_value['rows'] : '10'; |
|
114 | - $cols = isset($input_value['cols'] ) ? $input_value['cols'] : '80'; |
|
113 | + $rows = isset($input_value['rows']) ? $input_value['rows'] : '10'; |
|
114 | + $cols = isset($input_value['cols']) ? $input_value['cols'] : '80'; |
|
115 | 115 | |
116 | 116 | //any content? |
117 | 117 | $append_content = $input_value['append_content']; |
118 | 118 | |
119 | - $output .= (!$close) ? '<ul>' : ''; |
|
119 | + $output .= ( ! $close) ? '<ul>' : ''; |
|
120 | 120 | $output .= '<li>'; |
121 | 121 | |
122 | 122 | // what type of input are we dealing with ? |
@@ -124,15 +124,15 @@ discard block |
||
124 | 124 | |
125 | 125 | // text inputs |
126 | 126 | case 'text' : |
127 | - $output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>'; |
|
128 | - $output .= "\n\t\t\t" . '<input id="' . $field_id . '" class="' . $styles . '" type="text" value="' . esc_textarea($input_value['value']) . '" name="' . $input_value['name'] . '"' . $tabindex . '>'; |
|
127 | + $output .= "\n\t\t\t".'<label for="'.$field_id.'">'.$input_value['label'].$required.'</label>'; |
|
128 | + $output .= "\n\t\t\t".'<input id="'.$field_id.'" class="'.$styles.'" type="text" value="'.esc_textarea($input_value['value']).'" name="'.$input_value['name'].'"'.$tabindex.'>'; |
|
129 | 129 | break; |
130 | 130 | |
131 | 131 | // dropdowns |
132 | 132 | case 'select' : |
133 | 133 | |
134 | - $output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>'; |
|
135 | - $output .= "\n\t\t\t" . '<select id="' . $field_id . '" class="' . $styles . '" name="' . $input_value['name'] . '"' . $tabindex . '>'; |
|
134 | + $output .= "\n\t\t\t".'<label for="'.$field_id.'">'.$input_value['label'].$required.'</label>'; |
|
135 | + $output .= "\n\t\t\t".'<select id="'.$field_id.'" class="'.$styles.'" name="'.$input_value['name'].'"'.$tabindex.'>'; |
|
136 | 136 | |
137 | 137 | if (is_array($input_value['options'])) { |
138 | 138 | $options = $input_value['options']; |
@@ -141,30 +141,30 @@ discard block |
||
141 | 141 | } |
142 | 142 | |
143 | 143 | foreach ($options as $key => $value) { |
144 | - $selected = isset( $input_value['value'] ) && $input_value['value'] == $key ? 'selected=selected' : ''; |
|
144 | + $selected = isset($input_value['value']) && $input_value['value'] == $key ? 'selected=selected' : ''; |
|
145 | 145 | //$key = str_replace( ' ', '_', sanitize_key( $value )); |
146 | - $output .= "\n\t\t\t\t" . '<option '. $selected . ' value="' . $key . '">' . $value . '</option>'; |
|
146 | + $output .= "\n\t\t\t\t".'<option '.$selected.' value="'.$key.'">'.$value.'</option>'; |
|
147 | 147 | } |
148 | - $output .= "\n\t\t\t" . '</select>'; |
|
148 | + $output .= "\n\t\t\t".'</select>'; |
|
149 | 149 | |
150 | 150 | break; |
151 | 151 | |
152 | 152 | case 'textarea' : |
153 | 153 | |
154 | - $output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>'; |
|
155 | - $output .= "\n\t\t\t" . '<textarea id="' . $field_id . '" class="' . $styles . '" rows="'.$rows.'" cols="'.$cols.'" name="' . $input_value['name'] . '"' . $tabindex . '>' . esc_textarea($input_value['value']) . '</textarea>'; |
|
154 | + $output .= "\n\t\t\t".'<label for="'.$field_id.'">'.$input_value['label'].$required.'</label>'; |
|
155 | + $output .= "\n\t\t\t".'<textarea id="'.$field_id.'" class="'.$styles.'" rows="'.$rows.'" cols="'.$cols.'" name="'.$input_value['name'].'"'.$tabindex.'>'.esc_textarea($input_value['value']).'</textarea>'; |
|
156 | 156 | break; |
157 | 157 | |
158 | 158 | case 'hidden' : |
159 | 159 | $close = false; |
160 | 160 | $output .= "</li></ul>"; |
161 | - $output .= "\n\t\t\t" . '<input id="' . $field_id . '" type="hidden" name="' . $input_value['name'] . '" value="' . $input_value['value'] . '">'; |
|
161 | + $output .= "\n\t\t\t".'<input id="'.$field_id.'" type="hidden" name="'.$input_value['name'].'" value="'.$input_value['value'].'">'; |
|
162 | 162 | break; |
163 | 163 | |
164 | 164 | case 'checkbox' : |
165 | - $checked = ( $input_value['value'] == 1 ) ? 'checked="checked"' : ''; |
|
166 | - $output .= "\n\t\t\t" . '<label for="' . $field_id . '">' . $input_value['label'] . $required . '</label>'; |
|
167 | - $output .= "\n\t\t\t" . '<input id="' . $field_id. '" type="checkbox" name="' . $input_value['name'] . '" value="1"' . $checked . $tabindex . ' />'; |
|
165 | + $checked = ($input_value['value'] == 1) ? 'checked="checked"' : ''; |
|
166 | + $output .= "\n\t\t\t".'<label for="'.$field_id.'">'.$input_value['label'].$required.'</label>'; |
|
167 | + $output .= "\n\t\t\t".'<input id="'.$field_id.'" type="checkbox" name="'.$input_value['name'].'" value="1"'.$checked.$tabindex.' />'; |
|
168 | 168 | break; |
169 | 169 | |
170 | 170 | case 'wp_editor' : |
@@ -177,19 +177,19 @@ discard block |
||
177 | 177 | ); |
178 | 178 | $output .= '</li>'; |
179 | 179 | $output .= '</ul>'; |
180 | - $output .= '<h4>' . $input_value['label'] . '</h4>'; |
|
181 | - if ( $append_content ) { |
|
180 | + $output .= '<h4>'.$input_value['label'].'</h4>'; |
|
181 | + if ($append_content) { |
|
182 | 182 | $output .= $append_content; |
183 | 183 | } |
184 | 184 | ob_start(); |
185 | - wp_editor( $input_value['value'], $field_id, $editor_settings); |
|
185 | + wp_editor($input_value['value'], $field_id, $editor_settings); |
|
186 | 186 | $editor = ob_get_contents(); |
187 | 187 | ob_end_clean(); |
188 | 188 | $output .= $editor; |
189 | 189 | break; |
190 | 190 | |
191 | 191 | } |
192 | - if ( $append_content && $input_value['input'] !== 'wp_editor' ) { |
|
192 | + if ($append_content && $input_value['input'] !== 'wp_editor') { |
|
193 | 193 | $output .= $append_content; |
194 | 194 | } |
195 | 195 | $output .= ($close) ? '</li>' : ''; |
@@ -230,7 +230,7 @@ discard block |
||
230 | 230 | $form_fields = array(); |
231 | 231 | $fields = (array) $fields; |
232 | 232 | |
233 | - foreach ( $fields as $field_name => $field_atts ) { |
|
233 | + foreach ($fields as $field_name => $field_atts) { |
|
234 | 234 | //defaults: |
235 | 235 | $defaults = array( |
236 | 236 | 'label' => '', |
@@ -248,67 +248,67 @@ discard block |
||
248 | 248 | 'wpeditor_args' => array() |
249 | 249 | ); |
250 | 250 | // merge defaults with passed arguments |
251 | - $_fields = wp_parse_args( $field_atts, $defaults); |
|
252 | - extract( $_fields ); |
|
251 | + $_fields = wp_parse_args($field_atts, $defaults); |
|
252 | + extract($_fields); |
|
253 | 253 | // generate label |
254 | - $label = empty($label) ? '' : '<label for="' . $id . '">' . $label . '</label>'; |
|
254 | + $label = empty($label) ? '' : '<label for="'.$id.'">'.$label.'</label>'; |
|
255 | 255 | // generate field name |
256 | - $f_name = !empty($unique_id) ? $field_name . '[' . $unique_id . ']' : $field_name; |
|
256 | + $f_name = ! empty($unique_id) ? $field_name.'['.$unique_id.']' : $field_name; |
|
257 | 257 | |
258 | 258 | //tabindex |
259 | - $tabindex_str = !empty( $tabindex ) ? ' tabindex="' . $tabindex . '"' : ''; |
|
259 | + $tabindex_str = ! empty($tabindex) ? ' tabindex="'.$tabindex.'"' : ''; |
|
260 | 260 | |
261 | 261 | //we determine what we're building based on the type |
262 | - switch ( $type ) { |
|
262 | + switch ($type) { |
|
263 | 263 | |
264 | 264 | case 'textarea' : |
265 | - $fld = '<textarea id="' . $id . '" class="' . $class . '" rows="' . $dimensions[1] . '" cols="' . $dimensions[0] . '" name="' . $f_name . '"' . $tabindex_str . '>' . $value . '</textarea>'; |
|
265 | + $fld = '<textarea id="'.$id.'" class="'.$class.'" rows="'.$dimensions[1].'" cols="'.$dimensions[0].'" name="'.$f_name.'"'.$tabindex_str.'>'.$value.'</textarea>'; |
|
266 | 266 | $fld .= $extra_desc; |
267 | 267 | break; |
268 | 268 | |
269 | 269 | case 'checkbox' : |
270 | 270 | $c_input = ''; |
271 | - if ( is_array($value) ) { |
|
272 | - foreach ( $value as $key => $val ) { |
|
273 | - $c_id = $field_name . '_' . $value; |
|
274 | - $c_class = isset($classes[$key]) ? ' class="' . $classes[$key] . '" ' : ''; |
|
275 | - $c_label = isset($labels[$key]) ? '<label for="' . $c_id . '">' . $labels[$key] . '</label>' : ''; |
|
276 | - $checked = !empty($default) && $default == $val ? ' checked="checked" ' : ''; |
|
277 | - $c_input .= '<input name="' . $f_name . '[]" type="checkbox" id="' . $c_id . '"' . $c_class . 'value="' . $val . '"' . $checked . $tabindex_str . ' />' . "\n" . $c_label; |
|
271 | + if (is_array($value)) { |
|
272 | + foreach ($value as $key => $val) { |
|
273 | + $c_id = $field_name.'_'.$value; |
|
274 | + $c_class = isset($classes[$key]) ? ' class="'.$classes[$key].'" ' : ''; |
|
275 | + $c_label = isset($labels[$key]) ? '<label for="'.$c_id.'">'.$labels[$key].'</label>' : ''; |
|
276 | + $checked = ! empty($default) && $default == $val ? ' checked="checked" ' : ''; |
|
277 | + $c_input .= '<input name="'.$f_name.'[]" type="checkbox" id="'.$c_id.'"'.$c_class.'value="'.$val.'"'.$checked.$tabindex_str.' />'."\n".$c_label; |
|
278 | 278 | } |
279 | 279 | $fld = $c_input; |
280 | 280 | } else { |
281 | - $checked = !empty($default) && $default == $val ? 'checked="checked" ' : ''; |
|
282 | - $fld = '<input name="'. $f_name . '" type="checkbox" id="' . $id . '" class="' . $class . '" value="' . $value . '"' . $checked . $tabindex_str . ' />' . "\n"; |
|
281 | + $checked = ! empty($default) && $default == $val ? 'checked="checked" ' : ''; |
|
282 | + $fld = '<input name="'.$f_name.'" type="checkbox" id="'.$id.'" class="'.$class.'" value="'.$value.'"'.$checked.$tabindex_str.' />'."\n"; |
|
283 | 283 | } |
284 | 284 | break; |
285 | 285 | |
286 | 286 | case 'radio' : |
287 | 287 | $c_input = ''; |
288 | - if ( is_array($value) ) { |
|
289 | - foreach ( $value as $key => $val ) { |
|
290 | - $c_id = $field_name . '_' . $value; |
|
291 | - $c_class = isset($classes[$key]) ? 'class="' . $classes[$key] . '" ' : ''; |
|
292 | - $c_label = isset($labels[$key]) ? '<label for="' . $c_id . '">' . $labels[$key] . '</label>' : ''; |
|
293 | - $checked = !empty($default) && $default == $val ? ' checked="checked" ' : ''; |
|
294 | - $c_input .= '<input name="' . $f_name . '" type="checkbox" id="' . $c_id . '"' . $c_class . 'value="' . $val . '"' . $checked . $tabindex_str . ' />' . "\n" . $c_label; |
|
288 | + if (is_array($value)) { |
|
289 | + foreach ($value as $key => $val) { |
|
290 | + $c_id = $field_name.'_'.$value; |
|
291 | + $c_class = isset($classes[$key]) ? 'class="'.$classes[$key].'" ' : ''; |
|
292 | + $c_label = isset($labels[$key]) ? '<label for="'.$c_id.'">'.$labels[$key].'</label>' : ''; |
|
293 | + $checked = ! empty($default) && $default == $val ? ' checked="checked" ' : ''; |
|
294 | + $c_input .= '<input name="'.$f_name.'" type="checkbox" id="'.$c_id.'"'.$c_class.'value="'.$val.'"'.$checked.$tabindex_str.' />'."\n".$c_label; |
|
295 | 295 | } |
296 | 296 | $fld = $c_input; |
297 | 297 | } else { |
298 | - $checked = !empty($default) && $default == $val ? 'checked="checked" ' : ''; |
|
299 | - $fld = '<input name="'. $f_name . '" type="checkbox" id="' . $id . '" class="' . $class . '" value="' . $value . '"' . $checked . $tabindex_str . ' />' . "\n"; |
|
298 | + $checked = ! empty($default) && $default == $val ? 'checked="checked" ' : ''; |
|
299 | + $fld = '<input name="'.$f_name.'" type="checkbox" id="'.$id.'" class="'.$class.'" value="'.$value.'"'.$checked.$tabindex_str.' />'."\n"; |
|
300 | 300 | } |
301 | 301 | break; |
302 | 302 | |
303 | 303 | case 'hidden' : |
304 | - $fld = '<input name="' . $f_name . '" type="hidden" id="' . $id . '" class="' . $class . '" value="' . $value . '" />' . "\n"; |
|
304 | + $fld = '<input name="'.$f_name.'" type="hidden" id="'.$id.'" class="'.$class.'" value="'.$value.'" />'."\n"; |
|
305 | 305 | break; |
306 | 306 | |
307 | 307 | case 'select' : |
308 | - $fld = '<select name="' . $f_name . '" class="' . $class . '" id="' . $id . '"' . $tabindex_str . '>' . "\n"; |
|
309 | - foreach ( $value as $key => $val ) { |
|
310 | - $checked = !empty($default) && $default == $val ? ' selected="selected"' : ''; |
|
311 | - $fld .= "\t" . '<option value="' . $val . '"' . $checked . '>' . $labels[$key] . '</option>' . "\n"; |
|
308 | + $fld = '<select name="'.$f_name.'" class="'.$class.'" id="'.$id.'"'.$tabindex_str.'>'."\n"; |
|
309 | + foreach ($value as $key => $val) { |
|
310 | + $checked = ! empty($default) && $default == $val ? ' selected="selected"' : ''; |
|
311 | + $fld .= "\t".'<option value="'.$val.'"'.$checked.'>'.$labels[$key].'</option>'."\n"; |
|
312 | 312 | } |
313 | 313 | $fld .= '</select>'; |
314 | 314 | break; |
@@ -320,21 +320,21 @@ discard block |
||
320 | 320 | 'editor_class' => $class, |
321 | 321 | 'tabindex' => $tabindex |
322 | 322 | ); |
323 | - $editor_settings = array_merge( $wpeditor_args, $editor_settings ); |
|
323 | + $editor_settings = array_merge($wpeditor_args, $editor_settings); |
|
324 | 324 | ob_start(); |
325 | - wp_editor( $value, $id, $editor_settings ); |
|
325 | + wp_editor($value, $id, $editor_settings); |
|
326 | 326 | $editor = ob_get_contents(); |
327 | 327 | ob_end_clean(); |
328 | 328 | $fld = $editor; |
329 | 329 | break; |
330 | 330 | |
331 | 331 | default : //'text fields' |
332 | - $fld = '<input name="' . $f_name . '" type="text" id="' . $id . '" class="' . $class . '" value="' . $value . '"' . $tabindex_str . ' />' . "\n"; |
|
332 | + $fld = '<input name="'.$f_name.'" type="text" id="'.$id.'" class="'.$class.'" value="'.$value.'"'.$tabindex_str.' />'."\n"; |
|
333 | 333 | $fld .= $extra_desc; |
334 | 334 | |
335 | 335 | } |
336 | 336 | |
337 | - $form_fields[ $field_name ] = array( 'label' => $label, 'field' => $fld ); |
|
337 | + $form_fields[$field_name] = array('label' => $label, 'field' => $fld); |
|
338 | 338 | } |
339 | 339 | |
340 | 340 | return $form_fields; |
@@ -363,19 +363,19 @@ discard block |
||
363 | 363 | */ |
364 | 364 | static public function select_input($name, $values, $default = '', $parameters = '', $class = '', $autosize = true) { |
365 | 365 | //if $values was submitted in the wrong format, convert it over |
366 | - if(!empty($values) && (!array_key_exists(0,$values) || !is_array($values[0]))){ |
|
367 | - $converted_values=array(); |
|
368 | - foreach($values as $id=>$text){ |
|
369 | - $converted_values[]=array('id'=>$id,'text'=>$text); |
|
366 | + if ( ! empty($values) && ( ! array_key_exists(0, $values) || ! is_array($values[0]))) { |
|
367 | + $converted_values = array(); |
|
368 | + foreach ($values as $id=>$text) { |
|
369 | + $converted_values[] = array('id'=>$id, 'text'=>$text); |
|
370 | 370 | } |
371 | - $values=$converted_values; |
|
371 | + $values = $converted_values; |
|
372 | 372 | } |
373 | 373 | |
374 | - $field = '<select id="' . EEH_Formatter::ee_tep_output_string($name) . '" name="' . EEH_Formatter::ee_tep_output_string($name) . '"'; |
|
374 | + $field = '<select id="'.EEH_Formatter::ee_tep_output_string($name).'" name="'.EEH_Formatter::ee_tep_output_string($name).'"'; |
|
375 | 375 | //Debug |
376 | 376 | //EEH_Debug_Tools::printr( $values, '$values <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' ); |
377 | - if ( EEH_Formatter::ee_tep_not_null($parameters)) |
|
378 | - $field .= ' ' . $parameters; |
|
377 | + if (EEH_Formatter::ee_tep_not_null($parameters)) |
|
378 | + $field .= ' '.$parameters; |
|
379 | 379 | if ($autosize) { |
380 | 380 | $size = 'med'; |
381 | 381 | for ($ii = 0, $ni = sizeof($values); $ii < $ni; $ii++) { |
@@ -388,21 +388,21 @@ discard block |
||
388 | 388 | $size = ''; |
389 | 389 | } |
390 | 390 | |
391 | - $field .= ' class="' . $class . ' ' . $size . '">'; |
|
391 | + $field .= ' class="'.$class.' '.$size.'">'; |
|
392 | 392 | |
393 | 393 | if (empty($default) && isset($GLOBALS[$name])) |
394 | 394 | $default = stripslashes($GLOBALS[$name]); |
395 | 395 | |
396 | 396 | |
397 | 397 | for ($i = 0, $n = sizeof($values); $i < $n; $i++) { |
398 | - $field .= '<option value="' . $values[$i]['id'] . '"'; |
|
398 | + $field .= '<option value="'.$values[$i]['id'].'"'; |
|
399 | 399 | if ($default == $values[$i]['id']) { |
400 | 400 | $field .= ' selected = "selected"'; |
401 | 401 | } |
402 | - if ( isset( $values[$i]['class'] ) ) { |
|
403 | - $field .= ' class="' . $values[$i]['class'] . '"'; |
|
402 | + if (isset($values[$i]['class'])) { |
|
403 | + $field .= ' class="'.$values[$i]['class'].'"'; |
|
404 | 404 | } |
405 | - $field .= '>' . $values[$i]['text'] . '</option>'; |
|
405 | + $field .= '>'.$values[$i]['text'].'</option>'; |
|
406 | 406 | } |
407 | 407 | $field .= '</select>'; |
408 | 408 | |
@@ -420,38 +420,38 @@ discard block |
||
420 | 420 | * @param string $question_groups |
421 | 421 | * @return string HTML |
422 | 422 | */ |
423 | - static function generate_question_groups_html( $question_groups = array(), $group_wrapper = 'fieldset' ) { |
|
423 | + static function generate_question_groups_html($question_groups = array(), $group_wrapper = 'fieldset') { |
|
424 | 424 | |
425 | 425 | $html = ''; |
426 | - $before_question_group_questions = apply_filters( 'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', '' ); |
|
427 | - $after_question_group_questions = apply_filters( 'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', '' ); |
|
426 | + $before_question_group_questions = apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', ''); |
|
427 | + $after_question_group_questions = apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', ''); |
|
428 | 428 | |
429 | - if ( ! empty( $question_groups )) { |
|
429 | + if ( ! empty($question_groups)) { |
|
430 | 430 | //EEH_Debug_Tools::printr( $question_groups, '$question_groups <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' ); |
431 | 431 | // loop thru question groups |
432 | - foreach ( $question_groups as $QSG ) { |
|
432 | + foreach ($question_groups as $QSG) { |
|
433 | 433 | // check that questions exist |
434 | - if ( ! empty( $QSG['QSG_questions'] )) { |
|
434 | + if ( ! empty($QSG['QSG_questions'])) { |
|
435 | 435 | // use fieldsets |
436 | - $html .= "\n\t" . '<' . $group_wrapper . ' class="espresso-question-group-wrap" id="' . $QSG['QSG_identifier'] . '">'; |
|
436 | + $html .= "\n\t".'<'.$group_wrapper.' class="espresso-question-group-wrap" id="'.$QSG['QSG_identifier'].'">'; |
|
437 | 437 | // group_name |
438 | - $html .= $QSG['QSG_show_group_name'] ? "\n\t\t" . '<h5 class="espresso-question-group-title-h5 section-title">' . self::prep_answer( $QSG['QSG_name'] ) . '</h5>' : ''; |
|
438 | + $html .= $QSG['QSG_show_group_name'] ? "\n\t\t".'<h5 class="espresso-question-group-title-h5 section-title">'.self::prep_answer($QSG['QSG_name']).'</h5>' : ''; |
|
439 | 439 | // group_desc |
440 | - $html .= $QSG['QSG_show_group_desc'] && ! empty( $QSG['QSG_desc'] ) ? '<div class="espresso-question-group-desc-pg">' . self::prep_answer( $QSG['QSG_desc'] ) . '</div>' : ''; |
|
440 | + $html .= $QSG['QSG_show_group_desc'] && ! empty($QSG['QSG_desc']) ? '<div class="espresso-question-group-desc-pg">'.self::prep_answer($QSG['QSG_desc']).'</div>' : ''; |
|
441 | 441 | |
442 | 442 | $html .= $before_question_group_questions; |
443 | 443 | // loop thru questions |
444 | - foreach ( $QSG['QSG_questions'] as $question ) { |
|
444 | + foreach ($QSG['QSG_questions'] as $question) { |
|
445 | 445 | // EEH_Debug_Tools::printr( $question, '$question <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' ); |
446 | 446 | $QFI = new EE_Question_Form_Input( |
447 | 447 | $question['qst_obj'], |
448 | 448 | $question['ans_obj'], |
449 | 449 | $question |
450 | 450 | ); |
451 | - $html .= self::generate_form_input( $QFI ); |
|
451 | + $html .= self::generate_form_input($QFI); |
|
452 | 452 | } |
453 | 453 | $html .= $after_question_group_questions; |
454 | - $html .= "\n\t" . '</' . $group_wrapper . '>'; |
|
454 | + $html .= "\n\t".'</'.$group_wrapper.'>'; |
|
455 | 455 | } |
456 | 456 | } |
457 | 457 | } |
@@ -471,11 +471,11 @@ discard block |
||
471 | 471 | * @param string $group_wrapper |
472 | 472 | * @return string HTML |
473 | 473 | */ |
474 | - static function generate_question_groups_html2( $question_groups = array(), $q_meta = array(), $from_admin = FALSE, $group_wrapper = 'fieldset' ) { |
|
474 | + static function generate_question_groups_html2($question_groups = array(), $q_meta = array(), $from_admin = FALSE, $group_wrapper = 'fieldset') { |
|
475 | 475 | |
476 | 476 | $html = ''; |
477 | - $before_question_group_questions = apply_filters( 'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', '' ); |
|
478 | - $after_question_group_questions = apply_filters( 'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', '' ); |
|
477 | + $before_question_group_questions = apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', ''); |
|
478 | + $after_question_group_questions = apply_filters('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', ''); |
|
479 | 479 | |
480 | 480 | $default_q_meta = array( |
481 | 481 | 'att_nmbr' => 1, |
@@ -484,55 +484,55 @@ discard block |
||
484 | 484 | 'input_id' => '', |
485 | 485 | 'input_class' => '' |
486 | 486 | ); |
487 | - $q_meta = array_merge( $default_q_meta, $q_meta ); |
|
487 | + $q_meta = array_merge($default_q_meta, $q_meta); |
|
488 | 488 | //EEH_Debug_Tools::printr( $q_meta, '$q_meta <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' ); |
489 | 489 | |
490 | - if ( ! empty( $question_groups )) { |
|
490 | + if ( ! empty($question_groups)) { |
|
491 | 491 | // EEH_Debug_Tools::printr( $question_groups, '$question_groups <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' ); |
492 | 492 | // loop thru question groups |
493 | - foreach ( $question_groups as $QSG ) { |
|
494 | - if ( $QSG instanceof EE_Question_Group ) { |
|
493 | + foreach ($question_groups as $QSG) { |
|
494 | + if ($QSG instanceof EE_Question_Group) { |
|
495 | 495 | // check that questions exist |
496 | 496 | |
497 | - $where = array( 'QST_deleted' => 0 ); |
|
498 | - if ( ! $from_admin ) { |
|
497 | + $where = array('QST_deleted' => 0); |
|
498 | + if ( ! $from_admin) { |
|
499 | 499 | $where['QST_admin_only'] = 0; |
500 | 500 | } |
501 | - $questions = $QSG->questions( array( $where, 'order_by' => array( 'Question_Group_Question.QGQ_order' => 'ASC' ))); |
|
502 | - if ( ! empty( $questions )) { |
|
501 | + $questions = $QSG->questions(array($where, 'order_by' => array('Question_Group_Question.QGQ_order' => 'ASC'))); |
|
502 | + if ( ! empty($questions)) { |
|
503 | 503 | // use fieldsets |
504 | - $html .= "\n\t" . '<' . $group_wrapper . ' class="espresso-question-group-wrap" id="' . $QSG->get( 'QSG_identifier' ) . '">'; |
|
504 | + $html .= "\n\t".'<'.$group_wrapper.' class="espresso-question-group-wrap" id="'.$QSG->get('QSG_identifier').'">'; |
|
505 | 505 | // group_name |
506 | - if ( $QSG->show_group_name() ) { |
|
507 | - $html .= "\n\t\t" . '<h5 class="espresso-question-group-title-h5 section-title">' . $QSG->get_pretty( 'QSG_name' ) . '</h5>'; |
|
506 | + if ($QSG->show_group_name()) { |
|
507 | + $html .= "\n\t\t".'<h5 class="espresso-question-group-title-h5 section-title">'.$QSG->get_pretty('QSG_name').'</h5>'; |
|
508 | 508 | } |
509 | 509 | // group_desc |
510 | - if ( $QSG->show_group_desc() ) { |
|
511 | - $html .= '<div class="espresso-question-group-desc-pg">' . $QSG->get_pretty( 'QSG_desc' ) . '</div>'; |
|
510 | + if ($QSG->show_group_desc()) { |
|
511 | + $html .= '<div class="espresso-question-group-desc-pg">'.$QSG->get_pretty('QSG_desc').'</div>'; |
|
512 | 512 | } |
513 | 513 | |
514 | 514 | $html .= $before_question_group_questions; |
515 | 515 | // loop thru questions |
516 | - foreach ( $questions as $QST ) { |
|
516 | + foreach ($questions as $QST) { |
|
517 | 517 | $qstn_id = $QST->is_system_question() ? $QST->system_ID() : $QST->ID(); |
518 | 518 | |
519 | 519 | $answer = NULL; |
520 | 520 | |
521 | - if ( isset( $_GET['qstn'] ) && isset( $q_meta['input_id'] ) && isset( $q_meta['att_nmbr'] )) { |
|
521 | + if (isset($_GET['qstn']) && isset($q_meta['input_id']) && isset($q_meta['att_nmbr'])) { |
|
522 | 522 | // check for answer in $_GET in case we are reprocessing a form after an error |
523 | - if ( isset( $_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ] )) { |
|
524 | - $answer = is_array( $_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ] ) ? $_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ] : sanitize_text_field( $_GET['qstn'][ $q_meta['input_id'] ][ $qstn_id ] ); |
|
523 | + if (isset($_GET['qstn'][$q_meta['input_id']][$qstn_id])) { |
|
524 | + $answer = is_array($_GET['qstn'][$q_meta['input_id']][$qstn_id]) ? $_GET['qstn'][$q_meta['input_id']][$qstn_id] : sanitize_text_field($_GET['qstn'][$q_meta['input_id']][$qstn_id]); |
|
525 | 525 | } |
526 | - } else if ( isset( $q_meta['attendee'] ) && $q_meta['attendee'] ) { |
|
526 | + } else if (isset($q_meta['attendee']) && $q_meta['attendee']) { |
|
527 | 527 | //attendee data from the session |
528 | - $answer = isset( $q_meta['attendee'][ $qstn_id ] ) ? $q_meta['attendee'][ $qstn_id ] : NULL; |
|
528 | + $answer = isset($q_meta['attendee'][$qstn_id]) ? $q_meta['attendee'][$qstn_id] : NULL; |
|
529 | 529 | } |
530 | 530 | |
531 | 531 | |
532 | 532 | |
533 | 533 | $QFI = new EE_Question_Form_Input( |
534 | 534 | $QST, |
535 | - EE_Answer::new_instance ( array( |
|
535 | + EE_Answer::new_instance(array( |
|
536 | 536 | 'ANS_ID'=> 0, |
537 | 537 | 'QST_ID'=> 0, |
538 | 538 | 'REG_ID'=> 0, |
@@ -541,10 +541,10 @@ discard block |
||
541 | 541 | $q_meta |
542 | 542 | ); |
543 | 543 | //EEH_Debug_Tools::printr( $QFI, '$QFI <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' ); |
544 | - $html .= self::generate_form_input( $QFI ); |
|
544 | + $html .= self::generate_form_input($QFI); |
|
545 | 545 | } |
546 | 546 | $html .= $after_question_group_questions; |
547 | - $html .= "\n\t" . '</' . $group_wrapper . '>'; |
|
547 | + $html .= "\n\t".'</'.$group_wrapper.'>'; |
|
548 | 548 | } |
549 | 549 | } |
550 | 550 | } |
@@ -564,63 +564,63 @@ discard block |
||
564 | 564 | * @param EE_Question_Form_Input $QFI |
565 | 565 | * @return string HTML |
566 | 566 | */ |
567 | - static function generate_form_input( EE_Question_Form_Input $QFI ) { |
|
568 | - if ( isset( $QFI->QST_admin_only) && $QFI->QST_admin_only && ! is_admin() ) { |
|
567 | + static function generate_form_input(EE_Question_Form_Input $QFI) { |
|
568 | + if (isset($QFI->QST_admin_only) && $QFI->QST_admin_only && ! is_admin()) { |
|
569 | 569 | return ''; |
570 | 570 | } |
571 | 571 | |
572 | - $QFI = self::_load_system_dropdowns( $QFI ); |
|
573 | - $QFI = self::_load_specialized_dropdowns( $QFI ); |
|
572 | + $QFI = self::_load_system_dropdowns($QFI); |
|
573 | + $QFI = self::_load_specialized_dropdowns($QFI); |
|
574 | 574 | |
575 | 575 | //we also need to verify |
576 | 576 | |
577 | 577 | $display_text = $QFI->get('QST_display_text'); |
578 | 578 | $input_name = $QFI->get('QST_input_name'); |
579 | - $answer = EE_Registry::instance()->REQ->is_set( $input_name ) ? EE_Registry::instance()->REQ->get( $input_name ) : $QFI->get('ANS_value'); |
|
579 | + $answer = EE_Registry::instance()->REQ->is_set($input_name) ? EE_Registry::instance()->REQ->get($input_name) : $QFI->get('ANS_value'); |
|
580 | 580 | $input_id = $QFI->get('QST_input_id'); |
581 | 581 | $input_class = $QFI->get('QST_input_class'); |
582 | 582 | // $disabled = $QFI->get('QST_disabled') ? ' disabled="disabled"' : ''; |
583 | 583 | $disabled = $QFI->get('QST_disabled') ? TRUE : FALSE; |
584 | - $required_label = apply_filters(' FHEE__EEH_Form_Fields__generate_form_input__required_label', '<em>*</em>' ); |
|
584 | + $required_label = apply_filters(' FHEE__EEH_Form_Fields__generate_form_input__required_label', '<em>*</em>'); |
|
585 | 585 | $QST_required = $QFI->get('QST_required'); |
586 | - $required = $QST_required ? array( 'label' => $required_label, 'class' => 'required needs-value', 'title' => $QST_required ) : array(); |
|
587 | - $use_html_entities = $QFI->get_meta( 'htmlentities' ); |
|
588 | - $required_text = $QFI->get('QST_required_text') != '' ? $QFI->get('QST_required_text') : __( 'This field is required', 'event_espresso' ); |
|
589 | - $required_text = $QST_required ? "\n\t\t\t" . '<div class="required-text hidden">' . self::prep_answer( $required_text, $use_html_entities ) . '</div>' : ''; |
|
586 | + $required = $QST_required ? array('label' => $required_label, 'class' => 'required needs-value', 'title' => $QST_required) : array(); |
|
587 | + $use_html_entities = $QFI->get_meta('htmlentities'); |
|
588 | + $required_text = $QFI->get('QST_required_text') != '' ? $QFI->get('QST_required_text') : __('This field is required', 'event_espresso'); |
|
589 | + $required_text = $QST_required ? "\n\t\t\t".'<div class="required-text hidden">'.self::prep_answer($required_text, $use_html_entities).'</div>' : ''; |
|
590 | 590 | $label_class = 'espresso-form-input-lbl'; |
591 | - $QST_options = $QFI->options(true,$answer); |
|
592 | - $options = is_array( $QST_options ) ? self::prep_answer_options( $QST_options ) : array(); |
|
591 | + $QST_options = $QFI->options(true, $answer); |
|
592 | + $options = is_array($QST_options) ? self::prep_answer_options($QST_options) : array(); |
|
593 | 593 | $system_ID = $QFI->get('QST_system'); |
594 | - $label_b4 = $QFI->get_meta( 'label_b4' ); |
|
595 | - $use_desc_4_label = $QFI->get_meta( 'use_desc_4_label' ); |
|
594 | + $label_b4 = $QFI->get_meta('label_b4'); |
|
595 | + $use_desc_4_label = $QFI->get_meta('use_desc_4_label'); |
|
596 | 596 | |
597 | 597 | |
598 | - switch ( $QFI->get('QST_type') ){ |
|
598 | + switch ($QFI->get('QST_type')) { |
|
599 | 599 | |
600 | 600 | case 'TEXTAREA' : |
601 | - return EEH_Form_Fields::textarea( $display_text, $answer, $input_name, $input_id, $input_class, array(), $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities ); |
|
601 | + return EEH_Form_Fields::textarea($display_text, $answer, $input_name, $input_id, $input_class, array(), $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities); |
|
602 | 602 | break; |
603 | 603 | |
604 | 604 | case 'DROPDOWN' : |
605 | - return EEH_Form_Fields::select( $display_text, $answer, $options, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities, TRUE ); |
|
605 | + return EEH_Form_Fields::select($display_text, $answer, $options, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities, TRUE); |
|
606 | 606 | break; |
607 | 607 | |
608 | 608 | |
609 | 609 | case 'RADIO_BTN' : |
610 | - return EEH_Form_Fields::radio( $display_text, $answer, $options, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities, $label_b4, $use_desc_4_label ); |
|
610 | + return EEH_Form_Fields::radio($display_text, $answer, $options, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities, $label_b4, $use_desc_4_label); |
|
611 | 611 | break; |
612 | 612 | |
613 | 613 | case 'CHECKBOX' : |
614 | - return EEH_Form_Fields::checkbox( $display_text, $answer, $options, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $label_b4, $system_ID, $use_html_entities ); |
|
614 | + return EEH_Form_Fields::checkbox($display_text, $answer, $options, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $label_b4, $system_ID, $use_html_entities); |
|
615 | 615 | break; |
616 | 616 | |
617 | 617 | case 'DATE' : |
618 | - return EEH_Form_Fields::datepicker( $display_text, $answer, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities ); |
|
618 | + return EEH_Form_Fields::datepicker($display_text, $answer, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities); |
|
619 | 619 | break; |
620 | 620 | |
621 | 621 | case 'TEXT' : |
622 | 622 | default: |
623 | - return EEH_Form_Fields::text( $display_text, $answer, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities ); |
|
623 | + return EEH_Form_Fields::text($display_text, $answer, $input_name, $input_id, $input_class, $required, $required_text, $label_class, $disabled, $system_ID, $use_html_entities); |
|
624 | 624 | break; |
625 | 625 | |
626 | 626 | } |
@@ -646,31 +646,31 @@ discard block |
||
646 | 646 | * @param string $disabled disabled="disabled" or null |
647 | 647 | * @return string HTML |
648 | 648 | */ |
649 | - static function text( $question = FALSE, $answer = NULL, $name = FALSE, $id = '', $class = '', $required = FALSE, $required_text = '', $label_class = '', $disabled = FALSE, $system_ID = FALSE, $use_html_entities = TRUE ) { |
|
649 | + static function text($question = FALSE, $answer = NULL, $name = FALSE, $id = '', $class = '', $required = FALSE, $required_text = '', $label_class = '', $disabled = FALSE, $system_ID = FALSE, $use_html_entities = TRUE) { |
|
650 | 650 | // need these |
651 | - if ( ! $question || ! $name ) { |
|
651 | + if ( ! $question || ! $name) { |
|
652 | 652 | return NULL; |
653 | 653 | } |
654 | 654 | // prep the answer |
655 | - $answer = is_array( $answer ) ? '' : self::prep_answer( $answer, $use_html_entities ); |
|
655 | + $answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities); |
|
656 | 656 | // prep the required array |
657 | - $required = self::prep_required( $required ); |
|
657 | + $required = self::prep_required($required); |
|
658 | 658 | // set disabled tag |
659 | - $disabled = $answer === NULL || ! $disabled ? '' : ' disabled="disabled"'; |
|
659 | + $disabled = $answer === NULL || ! $disabled ? '' : ' disabled="disabled"'; |
|
660 | 660 | // ya gots ta have style man!!! |
661 | 661 | $txt_class = is_admin() ? 'regular-text' : 'espresso-text-inp'; |
662 | - $class = empty( $class ) ? $txt_class : $class; |
|
663 | - $class .= ! empty( $system_ID ) ? ' ' . $system_ID : ''; |
|
664 | - $extra = apply_filters( 'FHEE__EEH_Form_Fields__additional_form_field_attributes', '' ); |
|
662 | + $class = empty($class) ? $txt_class : $class; |
|
663 | + $class .= ! empty($system_ID) ? ' '.$system_ID : ''; |
|
664 | + $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', ''); |
|
665 | 665 | |
666 | - $label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question( $question ) . $required['label'] . '</label><br/>'; |
|
666 | + $label_html = $required_text."\n\t\t\t".'<label for="'.$name.'" class="'.$label_class.'">'.self::prep_question($question).$required['label'].'</label><br/>'; |
|
667 | 667 | // filter label but ensure required text comes before it |
668 | - $label_html = apply_filters( 'FHEE__EEH_Form_Fields__label_html', $label_html, $required_text ); |
|
668 | + $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text); |
|
669 | 669 | |
670 | - $input_html = "\n\t\t\t" . '<input type="text" name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" value="' . esc_attr( $answer ) . '" title="' . esc_attr( $required['msg'] ) . '" ' . $disabled .' ' . $extra . '/>'; |
|
670 | + $input_html = "\n\t\t\t".'<input type="text" name="'.$name.'" id="'.$id.'" class="'.$class.' '.$required['class'].'" value="'.esc_attr($answer).'" title="'.esc_attr($required['msg']).'" '.$disabled.' '.$extra.'/>'; |
|
671 | 671 | |
672 | - $input_html = apply_filters( 'FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id ); |
|
673 | - return $label_html . $input_html; |
|
672 | + $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id); |
|
673 | + return $label_html.$input_html; |
|
674 | 674 | |
675 | 675 | } |
676 | 676 | |
@@ -692,35 +692,35 @@ discard block |
||
692 | 692 | * @param string $disabled disabled="disabled" or null |
693 | 693 | * @return string HTML |
694 | 694 | */ |
695 | - static function textarea( $question = FALSE, $answer = NULL, $name = FALSE, $id = '', $class = '', $dimensions = FALSE, $required = FALSE, $required_text = '', $label_class = '', $disabled = FALSE, $system_ID = FALSE, $use_html_entities = TRUE ) { |
|
695 | + static function textarea($question = FALSE, $answer = NULL, $name = FALSE, $id = '', $class = '', $dimensions = FALSE, $required = FALSE, $required_text = '', $label_class = '', $disabled = FALSE, $system_ID = FALSE, $use_html_entities = TRUE) { |
|
696 | 696 | // need these |
697 | - if ( ! $question || ! $name ) { |
|
697 | + if ( ! $question || ! $name) { |
|
698 | 698 | return NULL; |
699 | 699 | } |
700 | 700 | // prep the answer |
701 | - $answer = is_array( $answer ) ? '' : self::prep_answer( $answer, $use_html_entities ); |
|
701 | + $answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities); |
|
702 | 702 | // prep the required array |
703 | - $required = self::prep_required( $required ); |
|
703 | + $required = self::prep_required($required); |
|
704 | 704 | // make sure $dimensions is an array |
705 | - $dimensions = is_array( $dimensions ) ? $dimensions : array(); |
|
705 | + $dimensions = is_array($dimensions) ? $dimensions : array(); |
|
706 | 706 | // and set some defaults |
707 | - $dimensions = array_merge( array( 'rows' => 3, 'cols' => 40 ), $dimensions ); |
|
707 | + $dimensions = array_merge(array('rows' => 3, 'cols' => 40), $dimensions); |
|
708 | 708 | // set disabled tag |
709 | - $disabled = $answer === NULL || ! $disabled ? '' : ' disabled="disabled"'; |
|
709 | + $disabled = $answer === NULL || ! $disabled ? '' : ' disabled="disabled"'; |
|
710 | 710 | // ya gots ta have style man!!! |
711 | 711 | $txt_class = is_admin() ? 'regular-text' : 'espresso-textarea-inp'; |
712 | - $class = empty( $class ) ? $txt_class : $class; |
|
713 | - $class .= ! empty( $system_ID ) ? ' ' . $system_ID : ''; |
|
714 | - $extra = apply_filters( 'FHEE__EEH_Form_Fields__additional_form_field_attributes', '' ); |
|
712 | + $class = empty($class) ? $txt_class : $class; |
|
713 | + $class .= ! empty($system_ID) ? ' '.$system_ID : ''; |
|
714 | + $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', ''); |
|
715 | 715 | |
716 | - $label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question( $question ) . $required['label'] . '</label><br/>'; |
|
716 | + $label_html = $required_text."\n\t\t\t".'<label for="'.$name.'" class="'.$label_class.'">'.self::prep_question($question).$required['label'].'</label><br/>'; |
|
717 | 717 | // filter label but ensure required text comes before it |
718 | - $label_html = apply_filters( 'FHEE__EEH_Form_Fields__label_html', $label_html, $required_text ); |
|
718 | + $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text); |
|
719 | 719 | |
720 | - $input_html = "\n\t\t\t" . '<textarea name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" rows="' . $dimensions['rows'] . '" cols="' . $dimensions['cols'] . '" title="' . $required['msg'] . '" ' . $disabled . ' ' . $extra . '>' . $answer . '</textarea>'; |
|
720 | + $input_html = "\n\t\t\t".'<textarea name="'.$name.'" id="'.$id.'" class="'.$class.' '.$required['class'].'" rows="'.$dimensions['rows'].'" cols="'.$dimensions['cols'].'" title="'.$required['msg'].'" '.$disabled.' '.$extra.'>'.$answer.'</textarea>'; |
|
721 | 721 | |
722 | - $input_html = apply_filters( 'FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id ); |
|
723 | - return $label_html . $input_html; |
|
722 | + $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id); |
|
723 | + return $label_html.$input_html; |
|
724 | 724 | |
725 | 725 | } |
726 | 726 | |
@@ -743,47 +743,47 @@ discard block |
||
743 | 743 | * @param string $disabled disabled="disabled" or null |
744 | 744 | * @return string HTML |
745 | 745 | */ |
746 | - static function select( $question = FALSE, $answer = NULL, $options = FALSE, $name = FALSE, $id = '', $class = '', $required = FALSE, $required_text = '', $label_class = '', $disabled = FALSE, $system_ID = FALSE, $use_html_entities = TRUE, $add_please_select_option = FALSE ) { |
|
746 | + static function select($question = FALSE, $answer = NULL, $options = FALSE, $name = FALSE, $id = '', $class = '', $required = FALSE, $required_text = '', $label_class = '', $disabled = FALSE, $system_ID = FALSE, $use_html_entities = TRUE, $add_please_select_option = FALSE) { |
|
747 | 747 | |
748 | 748 | // need these |
749 | - if ( ! $question || ! $name || ! $options || empty( $options ) || ! is_array( $options )) { |
|
749 | + if ( ! $question || ! $name || ! $options || empty($options) || ! is_array($options)) { |
|
750 | 750 | return NULL; |
751 | 751 | } |
752 | 752 | // prep the answer |
753 | - $answer = is_array( $answer ) ? self::prep_answer( array_shift( $answer ), $use_html_entities) : self::prep_answer( $answer, $use_html_entities ); |
|
753 | + $answer = is_array($answer) ? self::prep_answer(array_shift($answer), $use_html_entities) : self::prep_answer($answer, $use_html_entities); |
|
754 | 754 | // prep the required array |
755 | - $required = self::prep_required( $required ); |
|
755 | + $required = self::prep_required($required); |
|
756 | 756 | // set disabled tag |
757 | - $disabled = $answer === NULL || ! $disabled ? '' : ' disabled="disabled"'; |
|
757 | + $disabled = $answer === NULL || ! $disabled ? '' : ' disabled="disabled"'; |
|
758 | 758 | // ya gots ta have style man!!! |
759 | 759 | $txt_class = is_admin() ? 'wide' : 'espresso-select-inp'; |
760 | - $class = empty( $class ) ? $txt_class : $class; |
|
761 | - $class .= ! empty( $system_ID ) ? ' ' . $system_ID : ''; |
|
762 | - $extra = apply_filters( 'FHEE__EEH_Form_Fields__additional_form_field_attributes', '' ); |
|
760 | + $class = empty($class) ? $txt_class : $class; |
|
761 | + $class .= ! empty($system_ID) ? ' '.$system_ID : ''; |
|
762 | + $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', ''); |
|
763 | 763 | |
764 | - $label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question( $question ) . $required['label'] . '</label><br/>'; |
|
764 | + $label_html = $required_text."\n\t\t\t".'<label for="'.$name.'" class="'.$label_class.'">'.self::prep_question($question).$required['label'].'</label><br/>'; |
|
765 | 765 | // filter label but ensure required text comes before it |
766 | - $label_html = apply_filters( 'FHEE__EEH_Form_Fields__label_html', $label_html, $required_text ); |
|
766 | + $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text); |
|
767 | 767 | |
768 | - $input_html = "\n\t\t\t" . '<select name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . '" title="' . esc_attr( $required['msg'] ) . '"' . $disabled . ' ' . $extra . '>'; |
|
768 | + $input_html = "\n\t\t\t".'<select name="'.$name.'" id="'.$id.'" class="'.$class.' '.$required['class'].'" title="'.esc_attr($required['msg']).'"'.$disabled.' '.$extra.'>'; |
|
769 | 769 | // recursively count array elements, to determine total number of options |
770 | - $only_option = count( $options, 1 ) == 1 ? TRUE : FALSE; |
|
771 | - if ( ! $only_option ) { |
|
770 | + $only_option = count($options, 1) == 1 ? TRUE : FALSE; |
|
771 | + if ( ! $only_option) { |
|
772 | 772 | // if there is NO answer set and there are multiple options to choose from, then set the "please select" message as selected |
773 | 773 | $selected = $answer === NULL ? ' selected="selected"' : ''; |
774 | - $input_html .= $add_please_select_option ? "\n\t\t\t\t" . '<option value=""' . $selected . '>' . __(' - please select - ', 'event_espresso') . '</option>' : ''; |
|
774 | + $input_html .= $add_please_select_option ? "\n\t\t\t\t".'<option value=""'.$selected.'>'.__(' - please select - ', 'event_espresso').'</option>' : ''; |
|
775 | 775 | } |
776 | - foreach ( $options as $key => $value ) { |
|
776 | + foreach ($options as $key => $value) { |
|
777 | 777 | // if value is an array, then create option groups, else create regular ol' options |
778 | - $input_html .= is_array( $value ) ? self::_generate_select_option_group( $key, $value, $answer, $use_html_entities ) : self::_generate_select_option( $value->value(), $value->desc(), $answer, $only_option, $use_html_entities ); |
|
778 | + $input_html .= is_array($value) ? self::_generate_select_option_group($key, $value, $answer, $use_html_entities) : self::_generate_select_option($value->value(), $value->desc(), $answer, $only_option, $use_html_entities); |
|
779 | 779 | } |
780 | 780 | |
781 | - $input_html .= "\n\t\t\t" . '</select>'; |
|
781 | + $input_html .= "\n\t\t\t".'</select>'; |
|
782 | 782 | |
783 | - $input_html = apply_filters( 'FHEE__EEH_Form_Fields__select__before_end_wrapper', $input_html, $question, $answer, $name, $id, $class, $system_ID ); |
|
783 | + $input_html = apply_filters('FHEE__EEH_Form_Fields__select__before_end_wrapper', $input_html, $question, $answer, $name, $id, $class, $system_ID); |
|
784 | 784 | |
785 | - $input_html = apply_filters( 'FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id ); |
|
786 | - return $label_html . $input_html; |
|
785 | + $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id); |
|
786 | + return $label_html.$input_html; |
|
787 | 787 | |
788 | 788 | } |
789 | 789 | |
@@ -801,12 +801,12 @@ discard block |
||
801 | 801 | * @param boolean $use_html_entities |
802 | 802 | * @return string |
803 | 803 | */ |
804 | - private static function _generate_select_option_group( $opt_group, $QSOs, $answer, $use_html_entities = true ){ |
|
805 | - $html = "\n\t\t\t\t" . '<optgroup label="' . self::prep_option_value( $opt_group ) . '">'; |
|
806 | - foreach ( $QSOs as $QSO ) { |
|
807 | - $html .= self::_generate_select_option( $QSO->value(), $QSO->desc(), $answer, false, $use_html_entities ); |
|
804 | + private static function _generate_select_option_group($opt_group, $QSOs, $answer, $use_html_entities = true) { |
|
805 | + $html = "\n\t\t\t\t".'<optgroup label="'.self::prep_option_value($opt_group).'">'; |
|
806 | + foreach ($QSOs as $QSO) { |
|
807 | + $html .= self::_generate_select_option($QSO->value(), $QSO->desc(), $answer, false, $use_html_entities); |
|
808 | 808 | } |
809 | - $html .= "\n\t\t\t\t" . '</optgroup>'; |
|
809 | + $html .= "\n\t\t\t\t".'</optgroup>'; |
|
810 | 810 | return $html; |
811 | 811 | } |
812 | 812 | |
@@ -821,12 +821,12 @@ discard block |
||
821 | 821 | * @param boolean $use_html_entities |
822 | 822 | * @return string |
823 | 823 | */ |
824 | - private static function _generate_select_option( $key, $value, $answer, $only_option = FALSE, $use_html_entities = true ){ |
|
825 | - $key = self::prep_answer( $key, $use_html_entities ); |
|
826 | - $value = self::prep_answer( $value, $use_html_entities ); |
|
827 | - $value = ! empty( $value ) ? $value : $key; |
|
828 | - $selected = ( $answer == $key || $only_option ) ? ' selected="selected"' : ''; |
|
829 | - return "\n\t\t\t\t" . '<option value="' . self::prep_option_value( $key ) . '"' . $selected . '> ' . $value . ' </option>'; |
|
824 | + private static function _generate_select_option($key, $value, $answer, $only_option = FALSE, $use_html_entities = true) { |
|
825 | + $key = self::prep_answer($key, $use_html_entities); |
|
826 | + $value = self::prep_answer($value, $use_html_entities); |
|
827 | + $value = ! empty($value) ? $value : $key; |
|
828 | + $selected = ($answer == $key || $only_option) ? ' selected="selected"' : ''; |
|
829 | + return "\n\t\t\t\t".'<option value="'.self::prep_option_value($key).'"'.$selected.'> '.$value.' </option>'; |
|
830 | 830 | } |
831 | 831 | |
832 | 832 | |
@@ -850,56 +850,56 @@ discard block |
||
850 | 850 | * @param bool $use_desc_4_label |
851 | 851 | * @return string HTML |
852 | 852 | */ |
853 | - static function radio( $question = FALSE, $answer = NULL, $options = FALSE, $name = FALSE, $id = '', $class = '', $required = FALSE, $required_text = '', $label_class = '', $disabled = FALSE, $system_ID = FALSE, $use_html_entities = TRUE, $label_b4 = FALSE, $use_desc_4_label = FALSE ) { |
|
853 | + static function radio($question = FALSE, $answer = NULL, $options = FALSE, $name = FALSE, $id = '', $class = '', $required = FALSE, $required_text = '', $label_class = '', $disabled = FALSE, $system_ID = FALSE, $use_html_entities = TRUE, $label_b4 = FALSE, $use_desc_4_label = FALSE) { |
|
854 | 854 | // need these |
855 | - if ( ! $question || ! $name || ! $options || empty( $options ) || ! is_array( $options )) { |
|
855 | + if ( ! $question || ! $name || ! $options || empty($options) || ! is_array($options)) { |
|
856 | 856 | return NULL; |
857 | 857 | } |
858 | 858 | // prep the answer |
859 | - $answer = is_array( $answer ) ? '' : self::prep_answer( $answer, $use_html_entities ); |
|
859 | + $answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities); |
|
860 | 860 | // prep the required array |
861 | - $required = self::prep_required( $required ); |
|
861 | + $required = self::prep_required($required); |
|
862 | 862 | // set disabled tag |
863 | - $disabled = $answer === NULL || ! $disabled ? '' : ' disabled="disabled"'; |
|
863 | + $disabled = $answer === NULL || ! $disabled ? '' : ' disabled="disabled"'; |
|
864 | 864 | // ya gots ta have style man!!! |
865 | 865 | $radio_class = is_admin() ? 'ee-admin-radio-lbl' : $label_class; |
866 | - $class = ! empty( $class ) ? $class : 'espresso-radio-btn-inp'; |
|
867 | - $extra = apply_filters( 'FHEE__EEH_Form_Fields__additional_form_field_attributes', '' ); |
|
866 | + $class = ! empty($class) ? $class : 'espresso-radio-btn-inp'; |
|
867 | + $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', ''); |
|
868 | 868 | |
869 | - $label_html = $required_text . "\n\t\t\t" . '<label class="' . $label_class . '">' . self::prep_question( $question ) . $required['label'] . '</label> '; |
|
869 | + $label_html = $required_text."\n\t\t\t".'<label class="'.$label_class.'">'.self::prep_question($question).$required['label'].'</label> '; |
|
870 | 870 | // filter label but ensure required text comes before it |
871 | - $label_html = apply_filters( 'FHEE__EEH_Form_Fields__label_html', $label_html, $required_text ); |
|
871 | + $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text); |
|
872 | 872 | |
873 | - $input_html = "\n\t\t\t" . '<ul id="' . $id . '-ul" class="espresso-radio-btn-options-ul ' . $label_class . ' ' . $class . '-ul">'; |
|
873 | + $input_html = "\n\t\t\t".'<ul id="'.$id.'-ul" class="espresso-radio-btn-options-ul '.$label_class.' '.$class.'-ul">'; |
|
874 | 874 | |
875 | - $class .= ! empty( $system_ID ) ? ' ' . $system_ID : ''; |
|
876 | - $class .= ! empty( $required['class'] ) ? ' ' . $required['class'] : ''; |
|
875 | + $class .= ! empty($system_ID) ? ' '.$system_ID : ''; |
|
876 | + $class .= ! empty($required['class']) ? ' '.$required['class'] : ''; |
|
877 | 877 | |
878 | - foreach ( $options as $OPT ) { |
|
879 | - if ( $OPT instanceof EE_Question_Option ) { |
|
880 | - $value = self::prep_option_value( $OPT->value() ); |
|
878 | + foreach ($options as $OPT) { |
|
879 | + if ($OPT instanceof EE_Question_Option) { |
|
880 | + $value = self::prep_option_value($OPT->value()); |
|
881 | 881 | $label = $use_desc_4_label ? $OPT->desc() : $OPT->value(); |
882 | - $size = $use_desc_4_label ? self::get_label_size_class( $OPT->value() . ' ' . $OPT->desc() ) : self::get_label_size_class( $OPT->value() ); |
|
883 | - $desc = $OPT->desc();//no self::prep_answer |
|
884 | - $answer = is_numeric( $value ) && empty( $answer ) ? 0 : $answer; |
|
885 | - $checked = (string)$value == (string)$answer ? ' checked="checked"' : ''; |
|
886 | - $opt = '-' . sanitize_key( $value ); |
|
887 | - |
|
888 | - $input_html .= "\n\t\t\t\t" . '<li' . $size . '>'; |
|
889 | - $input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-radio-btn-lbl">'; |
|
890 | - $input_html .= $label_b4 ? "\n\t\t\t\t\t\t" . '<span>' . $label . '</span>' : ''; |
|
891 | - $input_html .= "\n\t\t\t\t\t\t" . '<input type="radio" name="' . $name . '" id="' . $id . $opt . '" class="' . $class . '" value="' . $value . '" title="' . esc_attr( $required['msg'] ) . '" ' . $disabled . $checked . ' ' . $extra . '/>'; |
|
892 | - $input_html .= ! $label_b4 ? "\n\t\t\t\t\t\t" . '<span class="espresso-radio-btn-desc">' . $label . '</span>' : ''; |
|
893 | - $input_html .= "\n\t\t\t\t\t" . '</label>'; |
|
894 | - $input_html .= $use_desc_4_label ? '' : '<span class="espresso-radio-btn-option-desc small-text grey-text">' . $desc . '</span>'; |
|
895 | - $input_html .= "\n\t\t\t\t" . '</li>'; |
|
882 | + $size = $use_desc_4_label ? self::get_label_size_class($OPT->value().' '.$OPT->desc()) : self::get_label_size_class($OPT->value()); |
|
883 | + $desc = $OPT->desc(); //no self::prep_answer |
|
884 | + $answer = is_numeric($value) && empty($answer) ? 0 : $answer; |
|
885 | + $checked = (string) $value == (string) $answer ? ' checked="checked"' : ''; |
|
886 | + $opt = '-'.sanitize_key($value); |
|
887 | + |
|
888 | + $input_html .= "\n\t\t\t\t".'<li'.$size.'>'; |
|
889 | + $input_html .= "\n\t\t\t\t\t".'<label class="'.$radio_class.' espresso-radio-btn-lbl">'; |
|
890 | + $input_html .= $label_b4 ? "\n\t\t\t\t\t\t".'<span>'.$label.'</span>' : ''; |
|
891 | + $input_html .= "\n\t\t\t\t\t\t".'<input type="radio" name="'.$name.'" id="'.$id.$opt.'" class="'.$class.'" value="'.$value.'" title="'.esc_attr($required['msg']).'" '.$disabled.$checked.' '.$extra.'/>'; |
|
892 | + $input_html .= ! $label_b4 ? "\n\t\t\t\t\t\t".'<span class="espresso-radio-btn-desc">'.$label.'</span>' : ''; |
|
893 | + $input_html .= "\n\t\t\t\t\t".'</label>'; |
|
894 | + $input_html .= $use_desc_4_label ? '' : '<span class="espresso-radio-btn-option-desc small-text grey-text">'.$desc.'</span>'; |
|
895 | + $input_html .= "\n\t\t\t\t".'</li>'; |
|
896 | 896 | } |
897 | 897 | } |
898 | 898 | |
899 | - $input_html .= "\n\t\t\t" . '</ul>'; |
|
899 | + $input_html .= "\n\t\t\t".'</ul>'; |
|
900 | 900 | |
901 | - $input_html = apply_filters( 'FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id ); |
|
902 | - return $label_html . $input_html; |
|
901 | + $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id); |
|
902 | + return $label_html.$input_html; |
|
903 | 903 | |
904 | 904 | } |
905 | 905 | |
@@ -922,65 +922,65 @@ discard block |
||
922 | 922 | * @param string $disabled disabled="disabled" or null |
923 | 923 | * @return string HTML |
924 | 924 | */ |
925 | - static function checkbox( $question = FALSE, $answer = NULL, $options = FALSE, $name = FALSE, $id = '', $class = '', $required = FALSE, $required_text = '', $label_class = '', $disabled = FALSE, $label_b4 = FALSE, $system_ID = FALSE, $use_html_entities = TRUE ) { |
|
925 | + static function checkbox($question = FALSE, $answer = NULL, $options = FALSE, $name = FALSE, $id = '', $class = '', $required = FALSE, $required_text = '', $label_class = '', $disabled = FALSE, $label_b4 = FALSE, $system_ID = FALSE, $use_html_entities = TRUE) { |
|
926 | 926 | // need these |
927 | - if ( ! $question || ! $name || ! $options || empty( $options ) || ! is_array( $options )) { |
|
927 | + if ( ! $question || ! $name || ! $options || empty($options) || ! is_array($options)) { |
|
928 | 928 | return NULL; |
929 | 929 | } |
930 | - $answer = maybe_unserialize( $answer ); |
|
930 | + $answer = maybe_unserialize($answer); |
|
931 | 931 | |
932 | 932 | // prep the answer(s) |
933 | - $answer = is_array( $answer ) ? $answer : array( sanitize_key( $answer ) => $answer ); |
|
933 | + $answer = is_array($answer) ? $answer : array(sanitize_key($answer) => $answer); |
|
934 | 934 | |
935 | - foreach ( $answer as $key => $value ) { |
|
936 | - $key = self::prep_option_value( $key ); |
|
937 | - $answer[$key] = self::prep_answer( $value, $use_html_entities ); |
|
935 | + foreach ($answer as $key => $value) { |
|
936 | + $key = self::prep_option_value($key); |
|
937 | + $answer[$key] = self::prep_answer($value, $use_html_entities); |
|
938 | 938 | } |
939 | 939 | |
940 | 940 | // prep the required array |
941 | - $required = self::prep_required( $required ); |
|
941 | + $required = self::prep_required($required); |
|
942 | 942 | // set disabled tag |
943 | - $disabled = $answer === NULL || ! $disabled ? '' : ' disabled="disabled"'; |
|
943 | + $disabled = $answer === NULL || ! $disabled ? '' : ' disabled="disabled"'; |
|
944 | 944 | // ya gots ta have style man!!! |
945 | 945 | $radio_class = is_admin() ? 'ee-admin-radio-lbl' : $label_class; |
946 | - $class = empty( $class ) ? 'espresso-radio-btn-inp' : $class; |
|
947 | - $extra = apply_filters( 'FHEE__EEH_Form_Fields__additional_form_field_attributes', '' ); |
|
946 | + $class = empty($class) ? 'espresso-radio-btn-inp' : $class; |
|
947 | + $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', ''); |
|
948 | 948 | |
949 | - $label_html = $required_text . "\n\t\t\t" . '<label class="' . $label_class . '">' . self::prep_question( $question ) . $required['label'] . '</label> '; |
|
949 | + $label_html = $required_text."\n\t\t\t".'<label class="'.$label_class.'">'.self::prep_question($question).$required['label'].'</label> '; |
|
950 | 950 | // filter label but ensure required text comes before it |
951 | - $label_html = apply_filters( 'FHEE__EEH_Form_Fields__label_html', $label_html, $required_text ); |
|
952 | - |
|
953 | - $input_html = "\n\t\t\t" . '<ul id="' . $id . '-ul" class="espresso-checkbox-options-ul ' . $label_class . ' ' . $class . '-ul">'; |
|
954 | - |
|
955 | - $class .= ! empty( $system_ID ) ? ' ' . $system_ID : ''; |
|
956 | - $class .= ! empty( $required['class'] ) ? ' ' . $required['class'] : ''; |
|
957 | - |
|
958 | - foreach ( $options as $OPT ) { |
|
959 | - $value = $OPT->value();//self::prep_option_value( $OPT->value() ); |
|
960 | - $size = self::get_label_size_class( $OPT->value() . ' ' . $OPT->desc() ); |
|
961 | - $text = self::prep_answer( $OPT->value() ); |
|
962 | - $desc = $OPT->desc() ; |
|
963 | - $opt = '-' . sanitize_key( $value ); |
|
964 | - |
|
965 | - $checked = is_array( $answer ) && in_array( $text, $answer ) ? ' checked="checked"' : ''; |
|
966 | - |
|
967 | - $input_html .= "\n\t\t\t\t" . '<li' . $size . '>'; |
|
968 | - $input_html .= "\n\t\t\t\t\t" . '<label class="' . $radio_class . ' espresso-checkbox-lbl">'; |
|
969 | - $input_html .= $label_b4 ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>' : ''; |
|
970 | - $input_html .= "\n\t\t\t\t\t\t" . '<input type="checkbox" name="' . $name . '[' . $OPT->ID() . ']" id="' . $id . $opt . '" class="' . $class . '" value="' . $value . '" title="' . esc_attr( $required['msg'] ) . '" ' . $disabled . $checked . ' ' . $extra . '/>'; |
|
971 | - $input_html .= ! $label_b4 ? "\n\t\t\t\t\t\t" . '<span>' . $text . '</span>' : ''; |
|
972 | - $input_html .= "\n\t\t\t\t\t" . '</label>'; |
|
973 | - if ( ! empty( $desc ) && $desc != $text ) { |
|
974 | - $input_html .= "\n\t\t\t\t\t" . ' <br/><div class="espresso-checkbox-option-desc small-text grey-text">' . $desc . '</div>'; |
|
951 | + $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text); |
|
952 | + |
|
953 | + $input_html = "\n\t\t\t".'<ul id="'.$id.'-ul" class="espresso-checkbox-options-ul '.$label_class.' '.$class.'-ul">'; |
|
954 | + |
|
955 | + $class .= ! empty($system_ID) ? ' '.$system_ID : ''; |
|
956 | + $class .= ! empty($required['class']) ? ' '.$required['class'] : ''; |
|
957 | + |
|
958 | + foreach ($options as $OPT) { |
|
959 | + $value = $OPT->value(); //self::prep_option_value( $OPT->value() ); |
|
960 | + $size = self::get_label_size_class($OPT->value().' '.$OPT->desc()); |
|
961 | + $text = self::prep_answer($OPT->value()); |
|
962 | + $desc = $OPT->desc(); |
|
963 | + $opt = '-'.sanitize_key($value); |
|
964 | + |
|
965 | + $checked = is_array($answer) && in_array($text, $answer) ? ' checked="checked"' : ''; |
|
966 | + |
|
967 | + $input_html .= "\n\t\t\t\t".'<li'.$size.'>'; |
|
968 | + $input_html .= "\n\t\t\t\t\t".'<label class="'.$radio_class.' espresso-checkbox-lbl">'; |
|
969 | + $input_html .= $label_b4 ? "\n\t\t\t\t\t\t".'<span>'.$text.'</span>' : ''; |
|
970 | + $input_html .= "\n\t\t\t\t\t\t".'<input type="checkbox" name="'.$name.'['.$OPT->ID().']" id="'.$id.$opt.'" class="'.$class.'" value="'.$value.'" title="'.esc_attr($required['msg']).'" '.$disabled.$checked.' '.$extra.'/>'; |
|
971 | + $input_html .= ! $label_b4 ? "\n\t\t\t\t\t\t".'<span>'.$text.'</span>' : ''; |
|
972 | + $input_html .= "\n\t\t\t\t\t".'</label>'; |
|
973 | + if ( ! empty($desc) && $desc != $text) { |
|
974 | + $input_html .= "\n\t\t\t\t\t".' <br/><div class="espresso-checkbox-option-desc small-text grey-text">'.$desc.'</div>'; |
|
975 | 975 | } |
976 | - $input_html .= "\n\t\t\t\t" . '</li>'; |
|
976 | + $input_html .= "\n\t\t\t\t".'</li>'; |
|
977 | 977 | |
978 | 978 | } |
979 | 979 | |
980 | - $input_html .= "\n\t\t\t" . '</ul>'; |
|
980 | + $input_html .= "\n\t\t\t".'</ul>'; |
|
981 | 981 | |
982 | - $input_html = apply_filters( 'FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id ); |
|
983 | - return $label_html . $input_html; |
|
982 | + $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id); |
|
983 | + return $label_html.$input_html; |
|
984 | 984 | |
985 | 985 | } |
986 | 986 | |
@@ -1002,36 +1002,36 @@ discard block |
||
1002 | 1002 | * @param string $disabled disabled="disabled" or null |
1003 | 1003 | * @return string HTML |
1004 | 1004 | */ |
1005 | - static function datepicker( $question = FALSE, $answer = NULL, $name = FALSE, $id = '', $class = '', $required = FALSE, $required_text = '', $label_class = '', $disabled = FALSE, $system_ID = FALSE, $use_html_entities = TRUE ) { |
|
1005 | + static function datepicker($question = FALSE, $answer = NULL, $name = FALSE, $id = '', $class = '', $required = FALSE, $required_text = '', $label_class = '', $disabled = FALSE, $system_ID = FALSE, $use_html_entities = TRUE) { |
|
1006 | 1006 | // need these |
1007 | - if ( ! $question || ! $name ) { |
|
1007 | + if ( ! $question || ! $name) { |
|
1008 | 1008 | return NULL; |
1009 | 1009 | } |
1010 | 1010 | // prep the answer |
1011 | - $answer = is_array( $answer ) ? '' : self::prep_answer( $answer, $use_html_entities ); |
|
1011 | + $answer = is_array($answer) ? '' : self::prep_answer($answer, $use_html_entities); |
|
1012 | 1012 | // prep the required array |
1013 | - $required = self::prep_required( $required ); |
|
1013 | + $required = self::prep_required($required); |
|
1014 | 1014 | // set disabled tag |
1015 | - $disabled = $answer === NULL || ! $disabled ? '' : ' disabled="disabled"'; |
|
1015 | + $disabled = $answer === NULL || ! $disabled ? '' : ' disabled="disabled"'; |
|
1016 | 1016 | // ya gots ta have style man!!! |
1017 | 1017 | $txt_class = is_admin() ? 'regular-text' : 'espresso-datepicker-inp'; |
1018 | - $class = empty( $class ) ? $txt_class : $class; |
|
1019 | - $class .= ! empty( $system_ID ) ? ' ' . $system_ID : ''; |
|
1020 | - $extra = apply_filters( 'FHEE__EEH_Form_Fields__additional_form_field_attributes', '' ); |
|
1018 | + $class = empty($class) ? $txt_class : $class; |
|
1019 | + $class .= ! empty($system_ID) ? ' '.$system_ID : ''; |
|
1020 | + $extra = apply_filters('FHEE__EEH_Form_Fields__additional_form_field_attributes', ''); |
|
1021 | 1021 | |
1022 | - $label_html = $required_text . "\n\t\t\t" . '<label for="' . $name . '" class="' . $label_class . '">' . self::prep_question( $question ) . $required['label'] . '</label><br/>'; |
|
1022 | + $label_html = $required_text."\n\t\t\t".'<label for="'.$name.'" class="'.$label_class.'">'.self::prep_question($question).$required['label'].'</label><br/>'; |
|
1023 | 1023 | // filter label but ensure required text comes before it |
1024 | - $label_html = apply_filters( 'FHEE__EEH_Form_Fields__label_html', $label_html, $required_text ); |
|
1024 | + $label_html = apply_filters('FHEE__EEH_Form_Fields__label_html', $label_html, $required_text); |
|
1025 | 1025 | |
1026 | - $input_html = "\n\t\t\t" . '<input type="text" name="' . $name . '" id="' . $id . '" class="' . $class . ' ' . $required['class'] . ' datepicker" value="' . $answer . '" title="' . esc_attr( $required['msg'] ) . '" ' . $disabled . ' ' . $extra . '/>'; |
|
1026 | + $input_html = "\n\t\t\t".'<input type="text" name="'.$name.'" id="'.$id.'" class="'.$class.' '.$required['class'].' datepicker" value="'.$answer.'" title="'.esc_attr($required['msg']).'" '.$disabled.' '.$extra.'/>'; |
|
1027 | 1027 | |
1028 | 1028 | // enqueue scripts |
1029 | - wp_register_style( 'espresso-ui-theme', EE_GLOBAL_ASSETS_URL . 'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css', array(), EVENT_ESPRESSO_VERSION ); |
|
1030 | - wp_enqueue_style( 'espresso-ui-theme'); |
|
1031 | - wp_enqueue_script( 'jquery-ui-datepicker' ); |
|
1029 | + wp_register_style('espresso-ui-theme', EE_GLOBAL_ASSETS_URL.'css/espresso-ui-theme/jquery-ui-1.10.3.custom.min.css', array(), EVENT_ESPRESSO_VERSION); |
|
1030 | + wp_enqueue_style('espresso-ui-theme'); |
|
1031 | + wp_enqueue_script('jquery-ui-datepicker'); |
|
1032 | 1032 | |
1033 | - $input_html = apply_filters( 'FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id ); |
|
1034 | - return $label_html . $input_html; |
|
1033 | + $input_html = apply_filters('FHEE__EEH_Form_Fields__input_html', $input_html, $label_html, $id); |
|
1034 | + return $label_html.$input_html; |
|
1035 | 1035 | |
1036 | 1036 | } |
1037 | 1037 | |
@@ -1043,7 +1043,7 @@ discard block |
||
1043 | 1043 | * @access public |
1044 | 1044 | * @return string |
1045 | 1045 | */ |
1046 | - public static function remove_label_keep_required_msg( $label_html, $required_text ) { |
|
1046 | + public static function remove_label_keep_required_msg($label_html, $required_text) { |
|
1047 | 1047 | return $required_text; |
1048 | 1048 | } |
1049 | 1049 | |
@@ -1057,9 +1057,9 @@ discard block |
||
1057 | 1057 | * @param string $value |
1058 | 1058 | * @return string HTML |
1059 | 1059 | */ |
1060 | - static function hidden_input( $name, $value, $id = '' ){ |
|
1061 | - $id = ! empty( $id ) ? $id : $name; |
|
1062 | - return '<input id="' . $id . '" type="hidden" name="'.$name.'" value="' . $value . '"/>'; |
|
1060 | + static function hidden_input($name, $value, $id = '') { |
|
1061 | + $id = ! empty($id) ? $id : $name; |
|
1062 | + return '<input id="'.$id.'" type="hidden" name="'.$name.'" value="'.$value.'"/>'; |
|
1063 | 1063 | } |
1064 | 1064 | |
1065 | 1065 | |
@@ -1071,7 +1071,7 @@ discard block |
||
1071 | 1071 | * @param string $question |
1072 | 1072 | * @return string |
1073 | 1073 | */ |
1074 | - static function prep_question( $question ){ |
|
1074 | + static function prep_question($question) { |
|
1075 | 1075 | return $question; |
1076 | 1076 | // $link = ''; |
1077 | 1077 | // // does this label have a help link attached ? |
@@ -1094,13 +1094,13 @@ discard block |
||
1094 | 1094 | * @param mixed $answer |
1095 | 1095 | * @return string |
1096 | 1096 | */ |
1097 | - static function prep_answer( $answer, $use_html_entities = TRUE ){ |
|
1097 | + static function prep_answer($answer, $use_html_entities = TRUE) { |
|
1098 | 1098 | //make sure we convert bools first. Otherwise (bool) false becomes an empty string which is NOT desired, we want "0". |
1099 | - if ( is_bool( $answer ) ) { |
|
1099 | + if (is_bool($answer)) { |
|
1100 | 1100 | $answer = $answer ? 1 : 0; |
1101 | 1101 | } |
1102 | - $answer = trim( stripslashes( str_replace( ''', "'", $answer ))); |
|
1103 | - return $use_html_entities ? htmlentities( $answer, ENT_QUOTES, 'UTF-8' ) : $answer; |
|
1102 | + $answer = trim(stripslashes(str_replace(''', "'", $answer))); |
|
1103 | + return $use_html_entities ? htmlentities($answer, ENT_QUOTES, 'UTF-8') : $answer; |
|
1104 | 1104 | } |
1105 | 1105 | |
1106 | 1106 | |
@@ -1110,18 +1110,18 @@ discard block |
||
1110 | 1110 | * @param array $QSOs array of EE_Question_Option objects |
1111 | 1111 | * @return array |
1112 | 1112 | */ |
1113 | - public static function prep_answer_options( $QSOs = array() ){ |
|
1113 | + public static function prep_answer_options($QSOs = array()) { |
|
1114 | 1114 | $prepped_answer_options = array(); |
1115 | - if ( is_array( $QSOs ) && ! empty( $QSOs )) { |
|
1116 | - foreach( $QSOs as $key => $QSO ) { |
|
1117 | - if ( ! $QSO instanceof EE_Question_Option ) { |
|
1118 | - $QSO = EE_Question_Option::new_instance( array( |
|
1119 | - 'QSO_value' => is_array( $QSO ) && isset( $QSO['id'] ) ? (string)$QSO['id'] : (string)$key, |
|
1120 | - 'QSO_desc' => is_array( $QSO ) && isset( $QSO['text'] ) ? (string)$QSO['text'] : (string)$QSO |
|
1115 | + if (is_array($QSOs) && ! empty($QSOs)) { |
|
1116 | + foreach ($QSOs as $key => $QSO) { |
|
1117 | + if ( ! $QSO instanceof EE_Question_Option) { |
|
1118 | + $QSO = EE_Question_Option::new_instance(array( |
|
1119 | + 'QSO_value' => is_array($QSO) && isset($QSO['id']) ? (string) $QSO['id'] : (string) $key, |
|
1120 | + 'QSO_desc' => is_array($QSO) && isset($QSO['text']) ? (string) $QSO['text'] : (string) $QSO |
|
1121 | 1121 | )); |
1122 | 1122 | } |
1123 | - if ( $QSO->opt_group() ) { |
|
1124 | - $prepped_answer_options[ $QSO->opt_group() ][] = $QSO; |
|
1123 | + if ($QSO->opt_group()) { |
|
1124 | + $prepped_answer_options[$QSO->opt_group()][] = $QSO; |
|
1125 | 1125 | } else { |
1126 | 1126 | $prepped_answer_options[] = $QSO; |
1127 | 1127 | } |
@@ -1137,8 +1137,8 @@ discard block |
||
1137 | 1137 | * @param string $option_value |
1138 | 1138 | * @return string |
1139 | 1139 | */ |
1140 | - static function prep_option_value( $option_value ){ |
|
1141 | - return esc_attr( trim( stripslashes( $option_value ) ) ); |
|
1140 | + static function prep_option_value($option_value) { |
|
1141 | + return esc_attr(trim(stripslashes($option_value))); |
|
1142 | 1142 | } |
1143 | 1143 | |
1144 | 1144 | |
@@ -1149,11 +1149,11 @@ discard block |
||
1149 | 1149 | * @param string|array $required |
1150 | 1150 | * @return array |
1151 | 1151 | */ |
1152 | - static function prep_required( $required = array() ){ |
|
1152 | + static function prep_required($required = array()) { |
|
1153 | 1153 | // make sure required is an array |
1154 | - $required = is_array( $required ) ? $required : array(); |
|
1154 | + $required = is_array($required) ? $required : array(); |
|
1155 | 1155 | // and set some defaults |
1156 | - $required = array_merge( array( 'label' => '', 'class' => '', 'msg' => '' ), $required ); |
|
1156 | + $required = array_merge(array('label' => '', 'class' => '', 'msg' => ''), $required); |
|
1157 | 1157 | return $required; |
1158 | 1158 | } |
1159 | 1159 | |
@@ -1164,30 +1164,30 @@ discard block |
||
1164 | 1164 | * @param string $value |
1165 | 1165 | * @return string |
1166 | 1166 | */ |
1167 | - static function get_label_size_class( $value = FALSE ){ |
|
1168 | - if ( $value === FALSE || $value == '' ) { |
|
1167 | + static function get_label_size_class($value = FALSE) { |
|
1168 | + if ($value === FALSE || $value == '') { |
|
1169 | 1169 | return ' class="medium-lbl"'; |
1170 | 1170 | } |
1171 | 1171 | // determine length of option value |
1172 | - $val_size = strlen( $value ); |
|
1173 | - switch( $val_size ){ |
|
1172 | + $val_size = strlen($value); |
|
1173 | + switch ($val_size) { |
|
1174 | 1174 | case $val_size < 3 : |
1175 | - $size = ' class="nano-lbl"'; |
|
1175 | + $size = ' class="nano-lbl"'; |
|
1176 | 1176 | break; |
1177 | 1177 | case $val_size < 6 : |
1178 | - $size = ' class="micro-lbl"'; |
|
1178 | + $size = ' class="micro-lbl"'; |
|
1179 | 1179 | break; |
1180 | 1180 | case $val_size < 12 : |
1181 | - $size = ' class="tiny-lbl"'; |
|
1181 | + $size = ' class="tiny-lbl"'; |
|
1182 | 1182 | break; |
1183 | 1183 | case $val_size < 25 : |
1184 | - $size = ' class="small-lbl"'; |
|
1184 | + $size = ' class="small-lbl"'; |
|
1185 | 1185 | break; |
1186 | 1186 | case $val_size > 100 : |
1187 | - $size = ' class="big-lbl"'; |
|
1187 | + $size = ' class="big-lbl"'; |
|
1188 | 1188 | break; |
1189 | 1189 | default: |
1190 | - $size = ' class="medium-lbl"'; |
|
1190 | + $size = ' class="medium-lbl"'; |
|
1191 | 1191 | break; |
1192 | 1192 | } |
1193 | 1193 | return $size; |
@@ -1201,20 +1201,20 @@ discard block |
||
1201 | 1201 | * @param array $QFI |
1202 | 1202 | * @return array |
1203 | 1203 | */ |
1204 | - private static function _load_system_dropdowns( $QFI ){ |
|
1204 | + private static function _load_system_dropdowns($QFI) { |
|
1205 | 1205 | $QST_system = $QFI->get('QST_system'); |
1206 | - switch ( $QST_system ) { |
|
1206 | + switch ($QST_system) { |
|
1207 | 1207 | case 'state' : |
1208 | - $QFI = self::generate_state_dropdown( $QFI ); |
|
1208 | + $QFI = self::generate_state_dropdown($QFI); |
|
1209 | 1209 | break; |
1210 | 1210 | case 'country' : |
1211 | - $QFI = self::generate_country_dropdown( $QFI ); |
|
1211 | + $QFI = self::generate_country_dropdown($QFI); |
|
1212 | 1212 | break; |
1213 | 1213 | case 'admin-state' : |
1214 | - $QFI = self::generate_state_dropdown( $QFI, TRUE ); |
|
1214 | + $QFI = self::generate_state_dropdown($QFI, TRUE); |
|
1215 | 1215 | break; |
1216 | 1216 | case 'admin-country' : |
1217 | - $QFI = self::generate_country_dropdown( $QFI, TRUE ); |
|
1217 | + $QFI = self::generate_country_dropdown($QFI, TRUE); |
|
1218 | 1218 | break; |
1219 | 1219 | } |
1220 | 1220 | return $QFI; |
@@ -1231,13 +1231,13 @@ discard block |
||
1231 | 1231 | * |
1232 | 1232 | * @return EE_Question_Form_Input |
1233 | 1233 | */ |
1234 | - protected static function _load_specialized_dropdowns( $QFI ) { |
|
1235 | - switch( $QFI->get( 'QST_type' ) ) { |
|
1234 | + protected static function _load_specialized_dropdowns($QFI) { |
|
1235 | + switch ($QFI->get('QST_type')) { |
|
1236 | 1236 | case 'STATE' : |
1237 | - $QFI = self::generate_state_dropdown( $QFI ); |
|
1237 | + $QFI = self::generate_state_dropdown($QFI); |
|
1238 | 1238 | break; |
1239 | 1239 | case 'COUNTRY' : |
1240 | - $QFI = self::generate_country_dropdown( $QFI ); |
|
1240 | + $QFI = self::generate_country_dropdown($QFI); |
|
1241 | 1241 | break; |
1242 | 1242 | } |
1243 | 1243 | return $QFI; |
@@ -1251,23 +1251,23 @@ discard block |
||
1251 | 1251 | * @param bool $get_all |
1252 | 1252 | * @return array |
1253 | 1253 | */ |
1254 | - public static function generate_state_dropdown( $QST, $get_all = FALSE ){ |
|
1254 | + public static function generate_state_dropdown($QST, $get_all = FALSE) { |
|
1255 | 1255 | $states = $get_all ? EEM_State::instance()->get_all_states() : EEM_State::instance()->get_all_states_of_active_countries(); |
1256 | - if ( $states && count( $states ) != count( $QST->options() )) { |
|
1257 | - $QST->set( 'QST_type', 'DROPDOWN' ); |
|
1256 | + if ($states && count($states) != count($QST->options())) { |
|
1257 | + $QST->set('QST_type', 'DROPDOWN'); |
|
1258 | 1258 | // if multiple countries, we'll create option groups within the dropdown |
1259 | - foreach ( $states as $state ) { |
|
1260 | - if ( $state instanceof EE_State ) { |
|
1261 | - $QSO = EE_Question_Option::new_instance ( array ( |
|
1259 | + foreach ($states as $state) { |
|
1260 | + if ($state instanceof EE_State) { |
|
1261 | + $QSO = EE_Question_Option::new_instance(array( |
|
1262 | 1262 | 'QSO_value' => $state->ID(), |
1263 | 1263 | 'QSO_desc' => $state->name(), |
1264 | - 'QST_ID' => $QST->get( 'QST_ID' ), |
|
1264 | + 'QST_ID' => $QST->get('QST_ID'), |
|
1265 | 1265 | 'QSO_deleted' => FALSE |
1266 | 1266 | )); |
1267 | 1267 | // set option group |
1268 | - $QSO->set_opt_group( $state->country()->name() ); |
|
1268 | + $QSO->set_opt_group($state->country()->name()); |
|
1269 | 1269 | // add option to question |
1270 | - $QST->add_temp_option( $QSO ); |
|
1270 | + $QST->add_temp_option($QSO); |
|
1271 | 1271 | } |
1272 | 1272 | } |
1273 | 1273 | } |
@@ -1283,20 +1283,20 @@ discard block |
||
1283 | 1283 | * @internal param array $question |
1284 | 1284 | * @return array |
1285 | 1285 | */ |
1286 | - public static function generate_country_dropdown( $QST, $get_all = FALSE ){ |
|
1286 | + public static function generate_country_dropdown($QST, $get_all = FALSE) { |
|
1287 | 1287 | $countries = $get_all ? EEM_Country::instance()->get_all_countries() : EEM_Country::instance()->get_all_active_countries(); |
1288 | - if ( $countries && count( $countries ) != count( $QST->options() ) ) { |
|
1289 | - $QST->set( 'QST_type', 'DROPDOWN' ); |
|
1288 | + if ($countries && count($countries) != count($QST->options())) { |
|
1289 | + $QST->set('QST_type', 'DROPDOWN'); |
|
1290 | 1290 | // now add countries |
1291 | - foreach ( $countries as $country ) { |
|
1292 | - if ( $country instanceof EE_Country ) { |
|
1293 | - $QSO = EE_Question_Option::new_instance ( array ( |
|
1291 | + foreach ($countries as $country) { |
|
1292 | + if ($country instanceof EE_Country) { |
|
1293 | + $QSO = EE_Question_Option::new_instance(array( |
|
1294 | 1294 | 'QSO_value' => $country->ID(), |
1295 | 1295 | 'QSO_desc' => $country->name(), |
1296 | - 'QST_ID' => $QST->get( 'QST_ID' ), |
|
1296 | + 'QST_ID' => $QST->get('QST_ID'), |
|
1297 | 1297 | 'QSO_deleted' => FALSE |
1298 | 1298 | )); |
1299 | - $QST->add_temp_option( $QSO ); |
|
1299 | + $QST->add_temp_option($QSO); |
|
1300 | 1300 | } |
1301 | 1301 | } |
1302 | 1302 | } |
@@ -1313,11 +1313,11 @@ discard block |
||
1313 | 1313 | */ |
1314 | 1314 | public static function two_digit_months_dropdown_options() { |
1315 | 1315 | $options = array(); |
1316 | - for ( $x = 1; $x <= 12; $x++ ) { |
|
1317 | - $mm = str_pad( $x, 2, '0', STR_PAD_LEFT ); |
|
1318 | - $options[ (string)$mm ] = (string)$mm; |
|
1316 | + for ($x = 1; $x <= 12; $x++) { |
|
1317 | + $mm = str_pad($x, 2, '0', STR_PAD_LEFT); |
|
1318 | + $options[(string) $mm] = (string) $mm; |
|
1319 | 1319 | } |
1320 | - return EEH_Form_Fields::prep_answer_options( $options ); |
|
1320 | + return EEH_Form_Fields::prep_answer_options($options); |
|
1321 | 1321 | } |
1322 | 1322 | |
1323 | 1323 | |
@@ -1332,11 +1332,11 @@ discard block |
||
1332 | 1332 | $options = array(); |
1333 | 1333 | $current_year = date('y'); |
1334 | 1334 | $next_decade = $current_year + 10; |
1335 | - for ( $x = $current_year; $x <= $next_decade; $x++ ) { |
|
1336 | - $yy = str_pad( $x, 2, '0', STR_PAD_LEFT ); |
|
1337 | - $options[ (string)$yy ] = (string)$yy; |
|
1335 | + for ($x = $current_year; $x <= $next_decade; $x++) { |
|
1336 | + $yy = str_pad($x, 2, '0', STR_PAD_LEFT); |
|
1337 | + $options[(string) $yy] = (string) $yy; |
|
1338 | 1338 | } |
1339 | - return EEH_Form_Fields::prep_answer_options( $options ); |
|
1339 | + return EEH_Form_Fields::prep_answer_options($options); |
|
1340 | 1340 | } |
1341 | 1341 | |
1342 | 1342 | |
@@ -1350,17 +1350,17 @@ discard block |
||
1350 | 1350 | * @param integer $evt_category Event Category ID if the Event Category filter is selected |
1351 | 1351 | * @return string html |
1352 | 1352 | */ |
1353 | - public static function generate_registration_months_dropdown( $cur_date = '', $status = '', $evt_category = 0 ) { |
|
1353 | + public static function generate_registration_months_dropdown($cur_date = '', $status = '', $evt_category = 0) { |
|
1354 | 1354 | $_where = array(); |
1355 | - if ( !empty( $status ) ) { |
|
1355 | + if ( ! empty($status)) { |
|
1356 | 1356 | $_where['STS_ID'] = $status; |
1357 | 1357 | } |
1358 | 1358 | |
1359 | - if ( $evt_category > 0 ) { |
|
1359 | + if ($evt_category > 0) { |
|
1360 | 1360 | $_where['Event.Term_Taxonomy.term_id'] = $evt_category; |
1361 | 1361 | } |
1362 | 1362 | |
1363 | - $regdtts = EEM_Registration::instance()->get_reg_months_and_years( $_where ); |
|
1363 | + $regdtts = EEM_Registration::instance()->get_reg_months_and_years($_where); |
|
1364 | 1364 | |
1365 | 1365 | //setup vals for select input helper |
1366 | 1366 | $options = array( |
@@ -1370,15 +1370,15 @@ discard block |
||
1370 | 1370 | ) |
1371 | 1371 | ); |
1372 | 1372 | |
1373 | - foreach ( $regdtts as $regdtt ) { |
|
1374 | - $date = $regdtt->reg_month. ' ' . $regdtt->reg_year; |
|
1373 | + foreach ($regdtts as $regdtt) { |
|
1374 | + $date = $regdtt->reg_month.' '.$regdtt->reg_year; |
|
1375 | 1375 | $options[] = array( |
1376 | 1376 | 'text' => $date, |
1377 | 1377 | 'id' => $date |
1378 | 1378 | ); |
1379 | 1379 | } |
1380 | 1380 | |
1381 | - return self::select_input('month_range', $options, $cur_date, '', 'wide' ); |
|
1381 | + return self::select_input('month_range', $options, $cur_date, '', 'wide'); |
|
1382 | 1382 | } |
1383 | 1383 | |
1384 | 1384 | |
@@ -1392,18 +1392,18 @@ discard block |
||
1392 | 1392 | * @param string $evt_active_status "upcoming", "expired", "active", or "inactive" |
1393 | 1393 | * @return string html |
1394 | 1394 | */ |
1395 | - public static function generate_event_months_dropdown( $cur_date = '', $status = NULL, $evt_category = NULL, $evt_active_status = NULL ) { |
|
1395 | + public static function generate_event_months_dropdown($cur_date = '', $status = NULL, $evt_category = NULL, $evt_active_status = NULL) { |
|
1396 | 1396 | //determine what post_status our condition will have for the query. |
1397 | - switch ( $status ) { |
|
1397 | + switch ($status) { |
|
1398 | 1398 | case 'month' : |
1399 | 1399 | case 'today' : |
1400 | 1400 | case NULL : |
1401 | 1401 | case 'all' : |
1402 | - $where['Event.status'] = array( 'NOT IN', array('trash') ); |
|
1402 | + $where['Event.status'] = array('NOT IN', array('trash')); |
|
1403 | 1403 | break; |
1404 | 1404 | |
1405 | 1405 | case 'draft' : |
1406 | - $where['Event.status'] = array( 'IN', array('draft', 'auto-draft') ); |
|
1406 | + $where['Event.status'] = array('IN', array('draft', 'auto-draft')); |
|
1407 | 1407 | |
1408 | 1408 | default : |
1409 | 1409 | $where['Event.status'] = $status; |
@@ -1412,7 +1412,7 @@ discard block |
||
1412 | 1412 | //categories? |
1413 | 1413 | |
1414 | 1414 | |
1415 | - if ( !empty ( $evt_category ) ) { |
|
1415 | + if ( ! empty ($evt_category)) { |
|
1416 | 1416 | $where['Event.Term_Taxonomy.taxonomy'] = 'espresso_event_categories'; |
1417 | 1417 | $where['Event.Term_Taxonomy.term_id'] = $evt_category; |
1418 | 1418 | } |
@@ -1420,7 +1420,7 @@ discard block |
||
1420 | 1420 | |
1421 | 1421 | // $where['DTT_is_primary'] = 1; |
1422 | 1422 | |
1423 | - $DTTS = EE_Registry::instance()->load_model('Datetime')->get_dtt_months_and_years($where, $evt_active_status ); |
|
1423 | + $DTTS = EE_Registry::instance()->load_model('Datetime')->get_dtt_months_and_years($where, $evt_active_status); |
|
1424 | 1424 | |
1425 | 1425 | //let's setup vals for select input helper |
1426 | 1426 | $options = array( |
@@ -1435,9 +1435,9 @@ discard block |
||
1435 | 1435 | //translate month and date |
1436 | 1436 | global $wp_locale; |
1437 | 1437 | |
1438 | - foreach ( $DTTS as $DTT ) { |
|
1439 | - $localized_date = $wp_locale->get_month( $DTT->dtt_month_num ) . ' ' . $DTT->dtt_year; |
|
1440 | - $id = $DTT->dtt_month . ' ' . $DTT->dtt_year; |
|
1438 | + foreach ($DTTS as $DTT) { |
|
1439 | + $localized_date = $wp_locale->get_month($DTT->dtt_month_num).' '.$DTT->dtt_year; |
|
1440 | + $id = $DTT->dtt_month.' '.$DTT->dtt_year; |
|
1441 | 1441 | $options[] = array( |
1442 | 1442 | 'text' => $localized_date, |
1443 | 1443 | 'id' => $id |
@@ -1445,7 +1445,7 @@ discard block |
||
1445 | 1445 | } |
1446 | 1446 | |
1447 | 1447 | |
1448 | - return self::select_input( 'month_range', $options, $cur_date, '', 'wide' ); |
|
1448 | + return self::select_input('month_range', $options, $cur_date, '', 'wide'); |
|
1449 | 1449 | } |
1450 | 1450 | |
1451 | 1451 | |
@@ -1456,7 +1456,7 @@ discard block |
||
1456 | 1456 | * @param integer $current_cat currently selected category |
1457 | 1457 | * @return string html for dropdown |
1458 | 1458 | */ |
1459 | - public static function generate_event_category_dropdown( $current_cat = -1 ) { |
|
1459 | + public static function generate_event_category_dropdown($current_cat = -1) { |
|
1460 | 1460 | $categories = EEM_Term::instance()->get_all_ee_categories(TRUE); |
1461 | 1461 | $options = array( |
1462 | 1462 | '0' => array( |
@@ -1466,14 +1466,14 @@ discard block |
||
1466 | 1466 | ); |
1467 | 1467 | |
1468 | 1468 | //setup categories for dropdown |
1469 | - foreach ( $categories as $category ) { |
|
1469 | + foreach ($categories as $category) { |
|
1470 | 1470 | $options[] = array( |
1471 | 1471 | 'text' => $category->get('name'), |
1472 | 1472 | 'id' => $category->ID() |
1473 | 1473 | ); |
1474 | 1474 | } |
1475 | 1475 | |
1476 | - return self::select_input( 'EVT_CAT', $options, $current_cat ); |
|
1476 | + return self::select_input('EVT_CAT', $options, $current_cat); |
|
1477 | 1477 | } |
1478 | 1478 | |
1479 | 1479 | |
@@ -1492,20 +1492,20 @@ discard block |
||
1492 | 1492 | * @param string $extra_attributes - any extra attributes that need to be attached to the form input |
1493 | 1493 | * @return void |
1494 | 1494 | */ |
1495 | - public static function submit_button( $url = '', $ID = '', $class = '', $text = '', $nonce_action = '', $input_only = FALSE, $extra_attributes = '' ) { |
|
1495 | + public static function submit_button($url = '', $ID = '', $class = '', $text = '', $nonce_action = '', $input_only = FALSE, $extra_attributes = '') { |
|
1496 | 1496 | $btn = ''; |
1497 | - if ( empty( $url ) || empty( $ID )) { |
|
1497 | + if (empty($url) || empty($ID)) { |
|
1498 | 1498 | return $btn; |
1499 | 1499 | } |
1500 | - $text = ! empty( $text ) ? $text : __('Submit', 'event_espresso' ); |
|
1501 | - $btn .= '<input id="' . $ID . '-btn" class="' . $class . '" type="submit" value="' . $text . '" ' . $extra_attributes . '/>'; |
|
1502 | - if ( ! $input_only ) { |
|
1503 | - $btn_frm = '<form id="' . $ID . '-frm" method="POST" action="' . $url . '">'; |
|
1504 | - $btn_frm .= ! empty( $nonce_action ) ? wp_nonce_field( $nonce_action, $nonce_action . '_nonce', TRUE, FALSE ) : ''; |
|
1500 | + $text = ! empty($text) ? $text : __('Submit', 'event_espresso'); |
|
1501 | + $btn .= '<input id="'.$ID.'-btn" class="'.$class.'" type="submit" value="'.$text.'" '.$extra_attributes.'/>'; |
|
1502 | + if ( ! $input_only) { |
|
1503 | + $btn_frm = '<form id="'.$ID.'-frm" method="POST" action="'.$url.'">'; |
|
1504 | + $btn_frm .= ! empty($nonce_action) ? wp_nonce_field($nonce_action, $nonce_action.'_nonce', TRUE, FALSE) : ''; |
|
1505 | 1505 | $btn_frm .= $btn; |
1506 | 1506 | $btn_frm .= '</form>'; |
1507 | 1507 | $btn = $btn_frm; |
1508 | - unset ( $btn_frm ); |
|
1508 | + unset ($btn_frm); |
|
1509 | 1509 | } |
1510 | 1510 | return $btn; |
1511 | 1511 | } |
@@ -6,8 +6,9 @@ |
||
6 | 6 | * @package Event Espresso |
7 | 7 | * @subpackage messages |
8 | 8 | */ |
9 | -if (!defined('EVENT_ESPRESSO_VERSION')) |
|
9 | +if (!defined('EVENT_ESPRESSO_VERSION')) { |
|
10 | 10 | exit('NO direct script access allowed'); |
11 | +} |
|
11 | 12 | |
12 | 13 | /** |
13 | 14 | * |
@@ -7,7 +7,7 @@ discard block |
||
7 | 7 | * @subpackage messages |
8 | 8 | */ |
9 | 9 | if (!defined('EVENT_ESPRESSO_VERSION')) |
10 | - exit('NO direct script access allowed'); |
|
10 | + exit('NO direct script access allowed'); |
|
11 | 11 | |
12 | 12 | /** |
13 | 13 | * |
@@ -24,343 +24,343 @@ discard block |
||
24 | 24 | { |
25 | 25 | |
26 | 26 | |
27 | - /** |
|
28 | - * The following are the properties that this messenger requires for generating pdf |
|
29 | - */ |
|
30 | - |
|
31 | - /** |
|
32 | - * This is the pdf body generated by the template via the message type. |
|
33 | - * |
|
34 | - * @var string |
|
35 | - */ |
|
36 | - protected $_content; |
|
37 | - |
|
38 | - |
|
39 | - /** |
|
40 | - * This is for the page title that gets displayed. This will end up being the filename for the generated pdf. |
|
41 | - * |
|
42 | - * @var string |
|
43 | - */ |
|
44 | - protected $_subject; |
|
45 | - |
|
46 | - |
|
47 | - /** |
|
48 | - * @return EE_Pdf_messenger |
|
49 | - */ |
|
50 | - public function __construct() |
|
51 | - { |
|
52 | - //set properties |
|
53 | - $this->name = 'pdf'; |
|
54 | - $this->description = __('This messenger is used for generating a pdf version of the message.', 'event_espresso'); |
|
55 | - $this->label = array( |
|
56 | - 'singular' => __('PDF', 'event_espresso'), |
|
57 | - 'plural' => __('PDFs', 'event_espresso') |
|
58 | - ); |
|
59 | - $this->activate_on_install = TRUE; |
|
60 | - |
|
61 | - parent::__construct(); |
|
62 | - } |
|
63 | - |
|
64 | - |
|
65 | - /** |
|
66 | - * PDF Messenger desires execution immediately. |
|
67 | - * @see parent::send_now() for documentation. |
|
68 | - * @since 4.9.0 |
|
69 | - * @return bool |
|
70 | - */ |
|
71 | - public function send_now() |
|
72 | - { |
|
73 | - return true; |
|
74 | - } |
|
75 | - |
|
76 | - |
|
77 | - /** |
|
78 | - * HTML Messenger allows an empty to field. |
|
79 | - * @see parent::allow_empty_to_field() for documentation |
|
80 | - * @since 4.9.0 |
|
81 | - * @return bool |
|
82 | - */ |
|
83 | - public function allow_empty_to_field() |
|
84 | - { |
|
85 | - return true; |
|
86 | - } |
|
87 | - |
|
88 | - |
|
89 | - /** |
|
90 | - * @see abstract declaration in EE_messenger for details. |
|
91 | - */ |
|
92 | - protected function _set_admin_pages() |
|
93 | - { |
|
94 | - $this->admin_registered_pages = array('events_edit' => false); |
|
95 | - } |
|
96 | - |
|
97 | - |
|
98 | - /** |
|
99 | - * @see abstract declaration in EE_messenger for details. |
|
100 | - */ |
|
101 | - protected function _set_valid_shortcodes() |
|
102 | - { |
|
103 | - $this->_valid_shortcodes = array(); |
|
104 | - } |
|
105 | - |
|
106 | - |
|
107 | - /** |
|
108 | - * @see abstract declaration in EE_messenger for details. |
|
109 | - */ |
|
110 | - protected function _set_validator_config() |
|
111 | - { |
|
112 | - $this->_validator_config = array( |
|
113 | - 'subject' => array( |
|
114 | - 'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email', 'event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime') |
|
115 | - ), |
|
116 | - 'content' => array( |
|
117 | - 'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email', 'event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime') |
|
118 | - ), |
|
119 | - 'attendee_list' => array( |
|
120 | - 'shortcodes' => array('attendee', 'event_list', 'ticket_list'), |
|
121 | - 'required' => array('[ATTENDEE_LIST]') |
|
122 | - ), |
|
123 | - 'event_list' => array( |
|
124 | - 'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'venue', 'datetime_list', 'attendee', 'primary_registration_details', 'primary_registration_list', 'event_author', 'recipient_details', 'recipient_list'), |
|
125 | - 'required' => array('[EVENT_LIST]') |
|
126 | - ), |
|
127 | - 'ticket_list' => array( |
|
128 | - 'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'primary_registration_details', 'recipient_details'), |
|
129 | - 'required' => array('[TICKET_LIST]') |
|
130 | - ), |
|
131 | - 'datetime_list' => array( |
|
132 | - 'shortcodes' => array('datetime'), |
|
133 | - 'required' => array('[DATETIME_LIST]') |
|
134 | - ), |
|
135 | - ); |
|
136 | - } |
|
137 | - |
|
138 | - |
|
139 | - /** |
|
140 | - * Takes care of enqueuing any necessary scripts or styles for the page. A do_action() so message types using this messenger can add their own js. |
|
141 | - * |
|
142 | - * @return void. |
|
143 | - */ |
|
144 | - public function enqueue_scripts_styles() |
|
145 | - { |
|
146 | - parent::enqueue_scripts_styles(); |
|
147 | - do_action('AHEE__EE_Pdf_messenger__enqueue_scripts_styles'); |
|
148 | - } |
|
149 | - |
|
150 | - |
|
151 | - /** |
|
152 | - * _set_template_fields |
|
153 | - * This sets up the fields that a messenger requires for the message to go out. |
|
154 | - * |
|
155 | - * @access protected |
|
156 | - * @return void |
|
157 | - */ |
|
158 | - protected function _set_template_fields() |
|
159 | - { |
|
160 | - // any extra template fields that are NOT used by the messenger but will get used by a messenger field for shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field they relate to. This is important for the Messages_admin to know what fields to display to the user. Also, notice that the "values" are equal to the field type that messages admin will use to know what kind of field to display. The values ALSO have one index labeled "shortcode". the values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be displayed. If the required shortcode isn't part of the shortcodes array then the field is not needed and will not be displayed/parsed. |
|
161 | - $this->_template_fields = array( |
|
162 | - 'subject' => array( |
|
163 | - 'input' => 'text', |
|
164 | - 'label' => __('Page Title', 'event_espresso'), |
|
165 | - 'type' => 'string', |
|
166 | - 'required' => TRUE, |
|
167 | - 'validation' => TRUE, |
|
168 | - 'css_class' => 'large-text', |
|
169 | - 'format' => '%s' |
|
170 | - ), |
|
171 | - 'content' => '', //left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field. |
|
172 | - 'extra' => array( |
|
173 | - 'content' => array( |
|
174 | - 'main' => array( |
|
175 | - 'input' => 'wp_editor', |
|
176 | - 'label' => __('Main Content', 'event_espresso'), |
|
177 | - 'type' => 'string', |
|
178 | - 'required' => TRUE, |
|
179 | - 'validation' => TRUE, |
|
180 | - 'format' => '%s', |
|
181 | - 'rows' => '15' |
|
182 | - ), |
|
183 | - 'event_list' => array( |
|
184 | - 'input' => 'wp_editor', |
|
185 | - 'label' => '[EVENT_LIST]', |
|
186 | - 'type' => 'string', |
|
187 | - 'required' => TRUE, |
|
188 | - 'validation' => TRUE, |
|
189 | - 'format' => '%s', |
|
190 | - 'rows' => '15', |
|
191 | - 'shortcodes_required' => array('[EVENT_LIST]') |
|
192 | - ), |
|
193 | - 'attendee_list' => array( |
|
194 | - 'input' => 'textarea', |
|
195 | - 'label' => '[ATTENDEE_LIST]', |
|
196 | - 'type' => 'string', |
|
197 | - 'required' => TRUE, |
|
198 | - 'validation' => TRUE, |
|
199 | - 'format' => '%s', |
|
200 | - 'css_class' => 'large-text', |
|
201 | - 'rows' => '5', |
|
202 | - 'shortcodes_required' => array('[ATTENDEE_LIST]') |
|
203 | - ), |
|
204 | - 'ticket_list' => array( |
|
205 | - 'input' => 'textarea', |
|
206 | - 'label' => '[TICKET_LIST]', |
|
207 | - 'type' => 'string', |
|
208 | - 'required' => TRUE, |
|
209 | - 'validation' => TRUE, |
|
210 | - 'format' => '%s', |
|
211 | - 'css_class' => 'large-text', |
|
212 | - 'rows' => '10', |
|
213 | - 'shortcodes_required' => array('[TICKET_LIST]') |
|
214 | - ), |
|
215 | - 'datetime_list' => array( |
|
216 | - 'input' => 'textarea', |
|
217 | - 'label' => '[DATETIME_LIST]', |
|
218 | - 'type' => 'string', |
|
219 | - 'required' => TRUE, |
|
220 | - 'validation' => TRUE, |
|
221 | - 'format' => '%s', |
|
222 | - 'css_class' => 'large-text', |
|
223 | - 'rows' => '10', |
|
224 | - 'shortcodes_required' => array('[DATETIME_LIST]') |
|
225 | - ) |
|
226 | - ) |
|
227 | - ) |
|
228 | - ); |
|
229 | - } |
|
230 | - |
|
231 | - |
|
232 | - /** |
|
233 | - * @see definition of this method in parent |
|
234 | - * |
|
235 | - * @since 4.5.0 |
|
236 | - * |
|
237 | - */ |
|
238 | - protected function _set_default_message_types() |
|
239 | - { |
|
240 | - //note currently PDF is only a secondary messenger so it never has any associated message types. |
|
241 | - $this->_default_message_types = array(); |
|
242 | - } |
|
243 | - |
|
244 | - |
|
245 | - /** |
|
246 | - * @see definition of this method in parent |
|
247 | - * |
|
248 | - * @since 4.5.0 |
|
249 | - */ |
|
250 | - protected function _set_valid_message_types() |
|
251 | - { |
|
252 | - $this->_valid_message_types = array(); |
|
253 | - } |
|
254 | - |
|
255 | - |
|
256 | - /** |
|
257 | - * Generates html version of the message content and then sends it to the pdf generator. |
|
258 | - * |
|
259 | - * |
|
260 | - * @since 4.5.0 |
|
261 | - * |
|
262 | - * @return string. |
|
263 | - */ |
|
264 | - protected function _send_message() |
|
265 | - { |
|
266 | - $this->_template_args = array( |
|
267 | - 'page_title' => $this->_subject, |
|
268 | - 'base_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'base', $this->_variation), |
|
269 | - 'print_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'print', $this->_variation), |
|
270 | - 'main_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'main', $this->_variation), |
|
271 | - 'extra_css' => EE_LIBRARIES_URL . 'messages/defaults/default/variations/pdf_base_default.css', |
|
272 | - 'main_body' => apply_filters('FHEE__EE_Pdf_messenger___send_message__main_body', wpautop($this->_content), $this->_content) |
|
273 | - ); |
|
274 | - $this->_deregister_wp_hooks(); |
|
275 | - add_action('wp_enqueue_scripts', array($this, 'enqueue_scripts_styles')); |
|
276 | - $content = $this->_get_main_template(); |
|
27 | + /** |
|
28 | + * The following are the properties that this messenger requires for generating pdf |
|
29 | + */ |
|
30 | + |
|
31 | + /** |
|
32 | + * This is the pdf body generated by the template via the message type. |
|
33 | + * |
|
34 | + * @var string |
|
35 | + */ |
|
36 | + protected $_content; |
|
37 | + |
|
38 | + |
|
39 | + /** |
|
40 | + * This is for the page title that gets displayed. This will end up being the filename for the generated pdf. |
|
41 | + * |
|
42 | + * @var string |
|
43 | + */ |
|
44 | + protected $_subject; |
|
45 | + |
|
46 | + |
|
47 | + /** |
|
48 | + * @return EE_Pdf_messenger |
|
49 | + */ |
|
50 | + public function __construct() |
|
51 | + { |
|
52 | + //set properties |
|
53 | + $this->name = 'pdf'; |
|
54 | + $this->description = __('This messenger is used for generating a pdf version of the message.', 'event_espresso'); |
|
55 | + $this->label = array( |
|
56 | + 'singular' => __('PDF', 'event_espresso'), |
|
57 | + 'plural' => __('PDFs', 'event_espresso') |
|
58 | + ); |
|
59 | + $this->activate_on_install = TRUE; |
|
60 | + |
|
61 | + parent::__construct(); |
|
62 | + } |
|
63 | + |
|
64 | + |
|
65 | + /** |
|
66 | + * PDF Messenger desires execution immediately. |
|
67 | + * @see parent::send_now() for documentation. |
|
68 | + * @since 4.9.0 |
|
69 | + * @return bool |
|
70 | + */ |
|
71 | + public function send_now() |
|
72 | + { |
|
73 | + return true; |
|
74 | + } |
|
75 | + |
|
76 | + |
|
77 | + /** |
|
78 | + * HTML Messenger allows an empty to field. |
|
79 | + * @see parent::allow_empty_to_field() for documentation |
|
80 | + * @since 4.9.0 |
|
81 | + * @return bool |
|
82 | + */ |
|
83 | + public function allow_empty_to_field() |
|
84 | + { |
|
85 | + return true; |
|
86 | + } |
|
87 | + |
|
88 | + |
|
89 | + /** |
|
90 | + * @see abstract declaration in EE_messenger for details. |
|
91 | + */ |
|
92 | + protected function _set_admin_pages() |
|
93 | + { |
|
94 | + $this->admin_registered_pages = array('events_edit' => false); |
|
95 | + } |
|
96 | + |
|
97 | + |
|
98 | + /** |
|
99 | + * @see abstract declaration in EE_messenger for details. |
|
100 | + */ |
|
101 | + protected function _set_valid_shortcodes() |
|
102 | + { |
|
103 | + $this->_valid_shortcodes = array(); |
|
104 | + } |
|
105 | + |
|
106 | + |
|
107 | + /** |
|
108 | + * @see abstract declaration in EE_messenger for details. |
|
109 | + */ |
|
110 | + protected function _set_validator_config() |
|
111 | + { |
|
112 | + $this->_validator_config = array( |
|
113 | + 'subject' => array( |
|
114 | + 'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email', 'event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime') |
|
115 | + ), |
|
116 | + 'content' => array( |
|
117 | + 'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email', 'event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime') |
|
118 | + ), |
|
119 | + 'attendee_list' => array( |
|
120 | + 'shortcodes' => array('attendee', 'event_list', 'ticket_list'), |
|
121 | + 'required' => array('[ATTENDEE_LIST]') |
|
122 | + ), |
|
123 | + 'event_list' => array( |
|
124 | + 'shortcodes' => array('event', 'attendee_list', 'ticket_list', 'venue', 'datetime_list', 'attendee', 'primary_registration_details', 'primary_registration_list', 'event_author', 'recipient_details', 'recipient_list'), |
|
125 | + 'required' => array('[EVENT_LIST]') |
|
126 | + ), |
|
127 | + 'ticket_list' => array( |
|
128 | + 'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'primary_registration_details', 'recipient_details'), |
|
129 | + 'required' => array('[TICKET_LIST]') |
|
130 | + ), |
|
131 | + 'datetime_list' => array( |
|
132 | + 'shortcodes' => array('datetime'), |
|
133 | + 'required' => array('[DATETIME_LIST]') |
|
134 | + ), |
|
135 | + ); |
|
136 | + } |
|
137 | + |
|
138 | + |
|
139 | + /** |
|
140 | + * Takes care of enqueuing any necessary scripts or styles for the page. A do_action() so message types using this messenger can add their own js. |
|
141 | + * |
|
142 | + * @return void. |
|
143 | + */ |
|
144 | + public function enqueue_scripts_styles() |
|
145 | + { |
|
146 | + parent::enqueue_scripts_styles(); |
|
147 | + do_action('AHEE__EE_Pdf_messenger__enqueue_scripts_styles'); |
|
148 | + } |
|
149 | + |
|
150 | + |
|
151 | + /** |
|
152 | + * _set_template_fields |
|
153 | + * This sets up the fields that a messenger requires for the message to go out. |
|
154 | + * |
|
155 | + * @access protected |
|
156 | + * @return void |
|
157 | + */ |
|
158 | + protected function _set_template_fields() |
|
159 | + { |
|
160 | + // any extra template fields that are NOT used by the messenger but will get used by a messenger field for shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field they relate to. This is important for the Messages_admin to know what fields to display to the user. Also, notice that the "values" are equal to the field type that messages admin will use to know what kind of field to display. The values ALSO have one index labeled "shortcode". the values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be displayed. If the required shortcode isn't part of the shortcodes array then the field is not needed and will not be displayed/parsed. |
|
161 | + $this->_template_fields = array( |
|
162 | + 'subject' => array( |
|
163 | + 'input' => 'text', |
|
164 | + 'label' => __('Page Title', 'event_espresso'), |
|
165 | + 'type' => 'string', |
|
166 | + 'required' => TRUE, |
|
167 | + 'validation' => TRUE, |
|
168 | + 'css_class' => 'large-text', |
|
169 | + 'format' => '%s' |
|
170 | + ), |
|
171 | + 'content' => '', //left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field. |
|
172 | + 'extra' => array( |
|
173 | + 'content' => array( |
|
174 | + 'main' => array( |
|
175 | + 'input' => 'wp_editor', |
|
176 | + 'label' => __('Main Content', 'event_espresso'), |
|
177 | + 'type' => 'string', |
|
178 | + 'required' => TRUE, |
|
179 | + 'validation' => TRUE, |
|
180 | + 'format' => '%s', |
|
181 | + 'rows' => '15' |
|
182 | + ), |
|
183 | + 'event_list' => array( |
|
184 | + 'input' => 'wp_editor', |
|
185 | + 'label' => '[EVENT_LIST]', |
|
186 | + 'type' => 'string', |
|
187 | + 'required' => TRUE, |
|
188 | + 'validation' => TRUE, |
|
189 | + 'format' => '%s', |
|
190 | + 'rows' => '15', |
|
191 | + 'shortcodes_required' => array('[EVENT_LIST]') |
|
192 | + ), |
|
193 | + 'attendee_list' => array( |
|
194 | + 'input' => 'textarea', |
|
195 | + 'label' => '[ATTENDEE_LIST]', |
|
196 | + 'type' => 'string', |
|
197 | + 'required' => TRUE, |
|
198 | + 'validation' => TRUE, |
|
199 | + 'format' => '%s', |
|
200 | + 'css_class' => 'large-text', |
|
201 | + 'rows' => '5', |
|
202 | + 'shortcodes_required' => array('[ATTENDEE_LIST]') |
|
203 | + ), |
|
204 | + 'ticket_list' => array( |
|
205 | + 'input' => 'textarea', |
|
206 | + 'label' => '[TICKET_LIST]', |
|
207 | + 'type' => 'string', |
|
208 | + 'required' => TRUE, |
|
209 | + 'validation' => TRUE, |
|
210 | + 'format' => '%s', |
|
211 | + 'css_class' => 'large-text', |
|
212 | + 'rows' => '10', |
|
213 | + 'shortcodes_required' => array('[TICKET_LIST]') |
|
214 | + ), |
|
215 | + 'datetime_list' => array( |
|
216 | + 'input' => 'textarea', |
|
217 | + 'label' => '[DATETIME_LIST]', |
|
218 | + 'type' => 'string', |
|
219 | + 'required' => TRUE, |
|
220 | + 'validation' => TRUE, |
|
221 | + 'format' => '%s', |
|
222 | + 'css_class' => 'large-text', |
|
223 | + 'rows' => '10', |
|
224 | + 'shortcodes_required' => array('[DATETIME_LIST]') |
|
225 | + ) |
|
226 | + ) |
|
227 | + ) |
|
228 | + ); |
|
229 | + } |
|
230 | + |
|
231 | + |
|
232 | + /** |
|
233 | + * @see definition of this method in parent |
|
234 | + * |
|
235 | + * @since 4.5.0 |
|
236 | + * |
|
237 | + */ |
|
238 | + protected function _set_default_message_types() |
|
239 | + { |
|
240 | + //note currently PDF is only a secondary messenger so it never has any associated message types. |
|
241 | + $this->_default_message_types = array(); |
|
242 | + } |
|
243 | + |
|
244 | + |
|
245 | + /** |
|
246 | + * @see definition of this method in parent |
|
247 | + * |
|
248 | + * @since 4.5.0 |
|
249 | + */ |
|
250 | + protected function _set_valid_message_types() |
|
251 | + { |
|
252 | + $this->_valid_message_types = array(); |
|
253 | + } |
|
254 | + |
|
255 | + |
|
256 | + /** |
|
257 | + * Generates html version of the message content and then sends it to the pdf generator. |
|
258 | + * |
|
259 | + * |
|
260 | + * @since 4.5.0 |
|
261 | + * |
|
262 | + * @return string. |
|
263 | + */ |
|
264 | + protected function _send_message() |
|
265 | + { |
|
266 | + $this->_template_args = array( |
|
267 | + 'page_title' => $this->_subject, |
|
268 | + 'base_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'base', $this->_variation), |
|
269 | + 'print_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'print', $this->_variation), |
|
270 | + 'main_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'main', $this->_variation), |
|
271 | + 'extra_css' => EE_LIBRARIES_URL . 'messages/defaults/default/variations/pdf_base_default.css', |
|
272 | + 'main_body' => apply_filters('FHEE__EE_Pdf_messenger___send_message__main_body', wpautop($this->_content), $this->_content) |
|
273 | + ); |
|
274 | + $this->_deregister_wp_hooks(); |
|
275 | + add_action('wp_enqueue_scripts', array($this, 'enqueue_scripts_styles')); |
|
276 | + $content = $this->_get_main_template(); |
|
277 | 277 | // die( $content ); |
278 | - $this->_do_pdf($content); |
|
279 | - exit(0); |
|
280 | - } |
|
281 | - |
|
282 | - |
|
283 | - /** |
|
284 | - * The purpose of this function is to de register all actions hooked into wp_head and wp_footer so that it doesn't interfere with our templates. If users want to add any custom styles or scripts they must use the AHEE__EE_Pdf_messenger__enqueue_scripts_styles hook. |
|
285 | - * |
|
286 | - * @since 4.5.0 |
|
287 | - * |
|
288 | - * @return void |
|
289 | - */ |
|
290 | - protected function _deregister_wp_hooks() |
|
291 | - { |
|
292 | - remove_all_actions('wp_head'); |
|
293 | - remove_all_actions('wp_footer'); |
|
294 | - remove_all_actions('wp_print_footer_scripts'); |
|
295 | - remove_all_actions('wp_enqueue_scripts'); |
|
296 | - global $wp_scripts, $wp_styles; |
|
297 | - $wp_scripts = $wp_styles = array(); |
|
298 | - |
|
299 | - //just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load. |
|
300 | - add_action('wp_head', 'wp_enqueue_scripts'); |
|
301 | - add_action('wp_footer', 'wp_print_footer_scripts'); |
|
302 | - add_action('wp_print_footer_scripts', '_wp_footer_scripts'); |
|
303 | - } |
|
304 | - |
|
305 | - |
|
306 | - /** |
|
307 | - * Overwrite parent _get_main_template for pdf purposes. |
|
308 | - * |
|
309 | - * @since 4.5.0 |
|
310 | - * |
|
311 | - * @param bool $preview |
|
312 | - * @return string |
|
313 | - */ |
|
314 | - protected function _get_main_template($preview = FALSE) |
|
315 | - { |
|
316 | - $wrapper_template = $this->_tmp_pack->get_wrapper('html', 'main'); |
|
317 | - //add message type to template_args |
|
318 | - $this->_template_args['message_type'] = $this->_incoming_message_type; |
|
319 | - return EEH_Template::display_template($wrapper_template, $this->_template_args, TRUE); |
|
320 | - } |
|
321 | - |
|
322 | - |
|
323 | - /** |
|
324 | - * This takes care of loading the dompdf library and generating the actual pdf |
|
325 | - * |
|
326 | - * @param string $content This is the generated html content being converted into a pdf. |
|
327 | - * |
|
328 | - * @return void |
|
329 | - */ |
|
330 | - protected function _do_pdf($content = '') |
|
331 | - { |
|
332 | - $invoice_name = $this->_subject; |
|
333 | - |
|
334 | - //only load dompdf if nobody else has yet... |
|
335 | - if (!defined('DOMPDF_DIR')) { |
|
336 | - define('DOMPDF_ENABLE_REMOTE', TRUE); |
|
337 | - define('DOMPDF_ENABLE_JAVASCRIPT', FALSE); |
|
338 | - define('DOMPDF_ENABLE_CSS_FLOAT', TRUE); |
|
339 | - require_once(EE_THIRD_PARTY . 'dompdf/dompdf_config.inc.php'); |
|
340 | - } |
|
341 | - $dompdf = new DOMPDF(); |
|
342 | - if (defined('DOMPDF_DEFAULT_PAPER_SIZE')) { |
|
343 | - $dompdf->set_paper(DOMPDF_DEFAULT_PAPER_SIZE); |
|
344 | - } |
|
345 | - //Remove all spaces between HTML tags |
|
346 | - $content = preg_replace('/>\s+</', '><', $content); |
|
347 | - $dompdf->load_html($content); |
|
348 | - $dompdf->render(); |
|
349 | - //forcing the browser to open a download dialog. |
|
350 | - $dompdf->stream($invoice_name . ".pdf", array('Attachment' => TRUE)); |
|
351 | - } |
|
352 | - |
|
353 | - |
|
354 | - /** |
|
355 | - * @return string |
|
356 | - */ |
|
357 | - protected function _preview() |
|
358 | - { |
|
359 | - return $this->_send_message(); |
|
360 | - } |
|
361 | - |
|
362 | - |
|
363 | - protected function _set_admin_settings_fields() |
|
364 | - { |
|
365 | - } |
|
278 | + $this->_do_pdf($content); |
|
279 | + exit(0); |
|
280 | + } |
|
281 | + |
|
282 | + |
|
283 | + /** |
|
284 | + * The purpose of this function is to de register all actions hooked into wp_head and wp_footer so that it doesn't interfere with our templates. If users want to add any custom styles or scripts they must use the AHEE__EE_Pdf_messenger__enqueue_scripts_styles hook. |
|
285 | + * |
|
286 | + * @since 4.5.0 |
|
287 | + * |
|
288 | + * @return void |
|
289 | + */ |
|
290 | + protected function _deregister_wp_hooks() |
|
291 | + { |
|
292 | + remove_all_actions('wp_head'); |
|
293 | + remove_all_actions('wp_footer'); |
|
294 | + remove_all_actions('wp_print_footer_scripts'); |
|
295 | + remove_all_actions('wp_enqueue_scripts'); |
|
296 | + global $wp_scripts, $wp_styles; |
|
297 | + $wp_scripts = $wp_styles = array(); |
|
298 | + |
|
299 | + //just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load. |
|
300 | + add_action('wp_head', 'wp_enqueue_scripts'); |
|
301 | + add_action('wp_footer', 'wp_print_footer_scripts'); |
|
302 | + add_action('wp_print_footer_scripts', '_wp_footer_scripts'); |
|
303 | + } |
|
304 | + |
|
305 | + |
|
306 | + /** |
|
307 | + * Overwrite parent _get_main_template for pdf purposes. |
|
308 | + * |
|
309 | + * @since 4.5.0 |
|
310 | + * |
|
311 | + * @param bool $preview |
|
312 | + * @return string |
|
313 | + */ |
|
314 | + protected function _get_main_template($preview = FALSE) |
|
315 | + { |
|
316 | + $wrapper_template = $this->_tmp_pack->get_wrapper('html', 'main'); |
|
317 | + //add message type to template_args |
|
318 | + $this->_template_args['message_type'] = $this->_incoming_message_type; |
|
319 | + return EEH_Template::display_template($wrapper_template, $this->_template_args, TRUE); |
|
320 | + } |
|
321 | + |
|
322 | + |
|
323 | + /** |
|
324 | + * This takes care of loading the dompdf library and generating the actual pdf |
|
325 | + * |
|
326 | + * @param string $content This is the generated html content being converted into a pdf. |
|
327 | + * |
|
328 | + * @return void |
|
329 | + */ |
|
330 | + protected function _do_pdf($content = '') |
|
331 | + { |
|
332 | + $invoice_name = $this->_subject; |
|
333 | + |
|
334 | + //only load dompdf if nobody else has yet... |
|
335 | + if (!defined('DOMPDF_DIR')) { |
|
336 | + define('DOMPDF_ENABLE_REMOTE', TRUE); |
|
337 | + define('DOMPDF_ENABLE_JAVASCRIPT', FALSE); |
|
338 | + define('DOMPDF_ENABLE_CSS_FLOAT', TRUE); |
|
339 | + require_once(EE_THIRD_PARTY . 'dompdf/dompdf_config.inc.php'); |
|
340 | + } |
|
341 | + $dompdf = new DOMPDF(); |
|
342 | + if (defined('DOMPDF_DEFAULT_PAPER_SIZE')) { |
|
343 | + $dompdf->set_paper(DOMPDF_DEFAULT_PAPER_SIZE); |
|
344 | + } |
|
345 | + //Remove all spaces between HTML tags |
|
346 | + $content = preg_replace('/>\s+</', '><', $content); |
|
347 | + $dompdf->load_html($content); |
|
348 | + $dompdf->render(); |
|
349 | + //forcing the browser to open a download dialog. |
|
350 | + $dompdf->stream($invoice_name . ".pdf", array('Attachment' => TRUE)); |
|
351 | + } |
|
352 | + |
|
353 | + |
|
354 | + /** |
|
355 | + * @return string |
|
356 | + */ |
|
357 | + protected function _preview() |
|
358 | + { |
|
359 | + return $this->_send_message(); |
|
360 | + } |
|
361 | + |
|
362 | + |
|
363 | + protected function _set_admin_settings_fields() |
|
364 | + { |
|
365 | + } |
|
366 | 366 | } |
@@ -6,7 +6,7 @@ discard block |
||
6 | 6 | * @package Event Espresso |
7 | 7 | * @subpackage messages |
8 | 8 | */ |
9 | -if (!defined('EVENT_ESPRESSO_VERSION')) |
|
9 | +if ( ! defined('EVENT_ESPRESSO_VERSION')) |
|
10 | 10 | exit('NO direct script access allowed'); |
11 | 11 | |
12 | 12 | /** |
@@ -268,7 +268,7 @@ discard block |
||
268 | 268 | 'base_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'base', $this->_variation), |
269 | 269 | 'print_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'print', $this->_variation), |
270 | 270 | 'main_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'main', $this->_variation), |
271 | - 'extra_css' => EE_LIBRARIES_URL . 'messages/defaults/default/variations/pdf_base_default.css', |
|
271 | + 'extra_css' => EE_LIBRARIES_URL.'messages/defaults/default/variations/pdf_base_default.css', |
|
272 | 272 | 'main_body' => apply_filters('FHEE__EE_Pdf_messenger___send_message__main_body', wpautop($this->_content), $this->_content) |
273 | 273 | ); |
274 | 274 | $this->_deregister_wp_hooks(); |
@@ -332,11 +332,11 @@ discard block |
||
332 | 332 | $invoice_name = $this->_subject; |
333 | 333 | |
334 | 334 | //only load dompdf if nobody else has yet... |
335 | - if (!defined('DOMPDF_DIR')) { |
|
335 | + if ( ! defined('DOMPDF_DIR')) { |
|
336 | 336 | define('DOMPDF_ENABLE_REMOTE', TRUE); |
337 | 337 | define('DOMPDF_ENABLE_JAVASCRIPT', FALSE); |
338 | 338 | define('DOMPDF_ENABLE_CSS_FLOAT', TRUE); |
339 | - require_once(EE_THIRD_PARTY . 'dompdf/dompdf_config.inc.php'); |
|
339 | + require_once(EE_THIRD_PARTY.'dompdf/dompdf_config.inc.php'); |
|
340 | 340 | } |
341 | 341 | $dompdf = new DOMPDF(); |
342 | 342 | if (defined('DOMPDF_DEFAULT_PAPER_SIZE')) { |
@@ -347,7 +347,7 @@ discard block |
||
347 | 347 | $dompdf->load_html($content); |
348 | 348 | $dompdf->render(); |
349 | 349 | //forcing the browser to open a download dialog. |
350 | - $dompdf->stream($invoice_name . ".pdf", array('Attachment' => TRUE)); |
|
350 | + $dompdf->stream($invoice_name.".pdf", array('Attachment' => TRUE)); |
|
351 | 351 | } |
352 | 352 | |
353 | 353 |
@@ -1,5 +1,5 @@ discard block |
||
1 | 1 | <?php |
2 | -if (!defined('EVENT_ESPRESSO_VERSION')) { |
|
2 | +if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
3 | 3 | exit('NO direct script access allowed'); |
4 | 4 | } |
5 | 5 | |
@@ -318,7 +318,7 @@ discard block |
||
318 | 318 | ), |
319 | 319 | 'ticket_line_item_no_pms' => array( |
320 | 320 | 'input' => 'textarea', |
321 | - 'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __( |
|
321 | + 'label' => '[TICKET_LINE_ITEM_LIST] <br>'.__( |
|
322 | 322 | 'Ticket Line Item List with no Price Modifiers', |
323 | 323 | 'event_espresso' |
324 | 324 | ), |
@@ -332,7 +332,7 @@ discard block |
||
332 | 332 | ), |
333 | 333 | 'ticket_line_item_pms' => array( |
334 | 334 | 'input' => 'textarea', |
335 | - 'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __( |
|
335 | + 'label' => '[TICKET_LINE_ITEM_LIST] <br>'.__( |
|
336 | 336 | 'Ticket Line Item List with Price Modifiers', |
337 | 337 | 'event_espresso' |
338 | 338 | ), |
@@ -1,6 +1,6 @@ discard block |
||
1 | 1 | <?php |
2 | 2 | if (!defined('EVENT_ESPRESSO_VERSION')) { |
3 | - exit('NO direct script access allowed'); |
|
3 | + exit('NO direct script access allowed'); |
|
4 | 4 | } |
5 | 5 | |
6 | 6 | |
@@ -16,552 +16,552 @@ discard block |
||
16 | 16 | { |
17 | 17 | |
18 | 18 | |
19 | - /** |
|
20 | - * The following are the properties that this messenger requires for displaying the html |
|
21 | - */ |
|
22 | - /** |
|
23 | - * This is the html body generated by the template via the message type. |
|
24 | - * |
|
25 | - * @var string |
|
26 | - */ |
|
27 | - protected $_content; |
|
28 | - |
|
29 | - |
|
30 | - /** |
|
31 | - * This is for the page title that gets displayed. (Why use "subject"? Because the "title" tag in html is |
|
32 | - * equivalent to the "subject" of the page. |
|
33 | - * |
|
34 | - * @var string |
|
35 | - */ |
|
36 | - protected $_subject; |
|
37 | - |
|
38 | - |
|
39 | - /** |
|
40 | - * EE_Html_messenger constructor. |
|
41 | - */ |
|
42 | - public function __construct() |
|
43 | - { |
|
44 | - //set properties |
|
45 | - $this->name = 'html'; |
|
46 | - $this->description = __('This messenger outputs a message to a browser for display.', 'event_espresso'); |
|
47 | - $this->label = array( |
|
48 | - 'singular' => __('html', 'event_espresso'), |
|
49 | - 'plural' => __('html', 'event_espresso'), |
|
50 | - ); |
|
51 | - $this->activate_on_install = true; |
|
52 | - // add the "powered by EE" credit link to the HTML receipt and invoice |
|
53 | - add_filter( |
|
54 | - 'FHEE__EE_Html_messenger___send_message__main_body', |
|
55 | - array($this, 'add_powered_by_credit_link_to_receipt_and_invoice'), |
|
56 | - 10, |
|
57 | - 3 |
|
58 | - ); |
|
59 | - parent::__construct(); |
|
60 | - } |
|
61 | - |
|
62 | - |
|
63 | - /** |
|
64 | - * HTML Messenger desires execution immediately. |
|
65 | - * |
|
66 | - * @see parent::send_now() for documentation. |
|
67 | - * @since 4.9.0 |
|
68 | - * @return bool |
|
69 | - */ |
|
70 | - public function send_now() |
|
71 | - { |
|
72 | - return true; |
|
73 | - } |
|
74 | - |
|
75 | - |
|
76 | - /** |
|
77 | - * HTML Messenger allows an empty to field. |
|
78 | - * |
|
79 | - * @see parent::allow_empty_to_field() for documentation |
|
80 | - * @since 4.9.0 |
|
81 | - * @return bool |
|
82 | - */ |
|
83 | - public function allow_empty_to_field() |
|
84 | - { |
|
85 | - return true; |
|
86 | - } |
|
87 | - |
|
88 | - |
|
89 | - /** |
|
90 | - * @see abstract declaration in EE_messenger for details. |
|
91 | - */ |
|
92 | - protected function _set_admin_pages() |
|
93 | - { |
|
94 | - $this->admin_registered_pages = array('events_edit' => true); |
|
95 | - } |
|
96 | - |
|
97 | - |
|
98 | - /** |
|
99 | - * @see abstract declaration in EE_messenger for details. |
|
100 | - */ |
|
101 | - protected function _set_valid_shortcodes() |
|
102 | - { |
|
103 | - $this->_valid_shortcodes = array(); |
|
104 | - } |
|
105 | - |
|
106 | - |
|
107 | - /** |
|
108 | - * @see abstract declaration in EE_messenger for details. |
|
109 | - */ |
|
110 | - protected function _set_validator_config() |
|
111 | - { |
|
112 | - $this->_validator_config = array( |
|
113 | - 'subject' => array( |
|
114 | - 'shortcodes' => array('organization', 'primary_registration_details', 'email', 'transaction'), |
|
115 | - ), |
|
116 | - 'content' => array( |
|
117 | - 'shortcodes' => array( |
|
118 | - 'organization', |
|
119 | - 'primary_registration_list', |
|
120 | - 'primary_registration_details', |
|
121 | - 'email', |
|
122 | - 'transaction', |
|
123 | - 'event_list', |
|
124 | - 'payment_list', |
|
125 | - 'venue', |
|
126 | - 'line_item_list', |
|
127 | - 'messenger', |
|
128 | - 'ticket_list', |
|
129 | - ), |
|
130 | - ), |
|
131 | - 'event_list' => array( |
|
132 | - 'shortcodes' => array( |
|
133 | - 'event', |
|
134 | - 'ticket_list', |
|
135 | - 'venue', |
|
136 | - 'primary_registration_details', |
|
137 | - 'primary_registration_list', |
|
138 | - 'event_author', |
|
139 | - ), |
|
140 | - 'required' => array('[EVENT_LIST]'), |
|
141 | - ), |
|
142 | - 'ticket_list' => array( |
|
143 | - 'shortcodes' => array( |
|
144 | - 'attendee_list', |
|
145 | - 'ticket', |
|
146 | - 'datetime_list', |
|
147 | - 'primary_registration_details', |
|
148 | - 'line_item_list', |
|
149 | - 'venue', |
|
150 | - ), |
|
151 | - 'required' => array('[TICKET_LIST]'), |
|
152 | - ), |
|
153 | - 'ticket_line_item_no_pms' => array( |
|
154 | - 'shortcodes' => array('line_item', 'ticket'), |
|
155 | - 'required' => array('[TICKET_LINE_ITEM_LIST]'), |
|
156 | - ), |
|
157 | - 'ticket_line_item_pms' => array( |
|
158 | - 'shortcodes' => array('line_item', 'ticket', 'line_item_list'), |
|
159 | - 'required' => array('[TICKET_LINE_ITEM_LIST]'), |
|
160 | - ), |
|
161 | - 'price_modifier_line_item_list' => array( |
|
162 | - 'shortcodes' => array('line_item'), |
|
163 | - 'required' => array('[PRICE_MODIFIER_LINE_ITEM_LIST]'), |
|
164 | - ), |
|
165 | - 'datetime_list' => array( |
|
166 | - 'shortcodes' => array('datetime'), |
|
167 | - 'required' => array('[DATETIME_LIST]'), |
|
168 | - ), |
|
169 | - 'attendee_list' => array( |
|
170 | - 'shortcodes' => array('attendee'), |
|
171 | - 'required' => array('[ATTENDEE_LIST]'), |
|
172 | - ), |
|
173 | - 'tax_line_item_list' => array( |
|
174 | - 'shortcodes' => array('line_item'), |
|
175 | - 'required' => array('[TAX_LINE_ITEM_LIST]'), |
|
176 | - ), |
|
177 | - 'additional_line_item_list' => array( |
|
178 | - 'shortcodes' => array('line_item'), |
|
179 | - 'required' => array('[ADDITIONAL_LINE_ITEM_LIST]'), |
|
180 | - ), |
|
181 | - 'payment_list' => array( |
|
182 | - 'shortcodes' => array('payment'), |
|
183 | - 'required' => array('[PAYMENT_LIST_*]'), |
|
184 | - ), |
|
185 | - ); |
|
186 | - } |
|
187 | - |
|
188 | - |
|
189 | - /** |
|
190 | - * This is a method called from EE_messages when this messenger is a generating messenger and the sending messenger |
|
191 | - * is a different messenger. Child messengers can set hooks for the sending messenger to callback on if necessary |
|
192 | - * (i.e. swap out css files or something else). |
|
193 | - * |
|
194 | - * @since 4.5.0 |
|
195 | - * @param string $sending_messenger_name the name of the sending messenger so we only set the hooks needed. |
|
196 | - * @return void |
|
197 | - */ |
|
198 | - public function do_secondary_messenger_hooks($sending_messenger_name) |
|
199 | - { |
|
200 | - if ($sending_messenger_name = 'pdf') { |
|
201 | - add_filter('EE_messenger__get_variation__variation', array($this, 'add_html_css'), 10, 8); |
|
202 | - } |
|
203 | - } |
|
204 | - |
|
205 | - |
|
206 | - /** |
|
207 | - * @param $variation_path |
|
208 | - * @param \EE_Messages_Template_Pack $template_pack |
|
209 | - * @param $messenger_name |
|
210 | - * @param $message_type_name |
|
211 | - * @param $url |
|
212 | - * @param $type |
|
213 | - * @param $variation |
|
214 | - * @param $skip_filters |
|
215 | - * @return string |
|
216 | - */ |
|
217 | - public function add_html_css( |
|
218 | - $variation_path, |
|
219 | - EE_Messages_Template_Pack $template_pack, |
|
220 | - $messenger_name, |
|
221 | - $message_type_name, |
|
222 | - $url, |
|
223 | - $type, |
|
224 | - $variation, |
|
225 | - $skip_filters |
|
226 | - ) |
|
227 | - { |
|
228 | - $variation = $template_pack->get_variation( |
|
229 | - $this->name, |
|
230 | - $message_type_name, |
|
231 | - $type, |
|
232 | - $variation, |
|
233 | - $url, |
|
234 | - '.css', |
|
235 | - $skip_filters |
|
236 | - ); |
|
237 | - return $variation; |
|
238 | - } |
|
239 | - |
|
240 | - |
|
241 | - /** |
|
242 | - * Takes care of enqueuing any necessary scripts or styles for the page. A do_action() so message types using this |
|
243 | - * messenger can add their own js. |
|
244 | - * |
|
245 | - * @return void. |
|
246 | - */ |
|
247 | - public function enqueue_scripts_styles() |
|
248 | - { |
|
249 | - parent::enqueue_scripts_styles(); |
|
250 | - do_action('AHEE__EE_Html_messenger__enqueue_scripts_styles'); |
|
251 | - } |
|
252 | - |
|
253 | - |
|
254 | - /** |
|
255 | - * _set_template_fields |
|
256 | - * This sets up the fields that a messenger requires for the message to go out. |
|
257 | - * |
|
258 | - * @access protected |
|
259 | - * @return void |
|
260 | - */ |
|
261 | - protected function _set_template_fields() |
|
262 | - { |
|
263 | - // any extra template fields that are NOT used by the messenger |
|
264 | - // but will get used by a messenger field for shortcode replacement |
|
265 | - // get added to the 'extra' key in an associated array |
|
266 | - // indexed by the messenger field they relate to. |
|
267 | - // This is important for the Messages_admin to know what fields to display to the user. |
|
268 | - // Also, notice that the "values" are equal to the field type |
|
269 | - // that messages admin will use to know what kind of field to display. |
|
270 | - // The values ALSO have one index labeled "shortcode". |
|
271 | - // The values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) |
|
272 | - // is required in order for this extra field to be displayed. |
|
273 | - // If the required shortcode isn't part of the shortcodes array |
|
274 | - // then the field is not needed and will not be displayed/parsed. |
|
275 | - $this->_template_fields = array( |
|
276 | - 'subject' => array( |
|
277 | - 'input' => 'text', |
|
278 | - 'label' => __('Page Title', 'event_espresso'), |
|
279 | - 'type' => 'string', |
|
280 | - 'required' => true, |
|
281 | - 'validation' => true, |
|
282 | - 'css_class' => 'large-text', |
|
283 | - 'format' => '%s', |
|
284 | - ), |
|
285 | - 'content' => '', |
|
286 | - //left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field. |
|
287 | - 'extra' => array( |
|
288 | - 'content' => array( |
|
289 | - 'main' => array( |
|
290 | - 'input' => 'wp_editor', |
|
291 | - 'label' => __('Main Content', 'event_espresso'), |
|
292 | - 'type' => 'string', |
|
293 | - 'required' => true, |
|
294 | - 'validation' => true, |
|
295 | - 'format' => '%s', |
|
296 | - 'rows' => '15', |
|
297 | - ), |
|
298 | - 'event_list' => array( |
|
299 | - 'input' => 'wp_editor', |
|
300 | - 'label' => '[EVENT_LIST]', |
|
301 | - 'type' => 'string', |
|
302 | - 'required' => true, |
|
303 | - 'validation' => true, |
|
304 | - 'format' => '%s', |
|
305 | - 'rows' => '15', |
|
306 | - 'shortcodes_required' => array('[EVENT_LIST]'), |
|
307 | - ), |
|
308 | - 'ticket_list' => array( |
|
309 | - 'input' => 'textarea', |
|
310 | - 'label' => '[TICKET_LIST]', |
|
311 | - 'type' => 'string', |
|
312 | - 'required' => true, |
|
313 | - 'validation' => true, |
|
314 | - 'format' => '%s', |
|
315 | - 'css_class' => 'large-text', |
|
316 | - 'rows' => '10', |
|
317 | - 'shortcodes_required' => array('[TICKET_LIST]'), |
|
318 | - ), |
|
319 | - 'ticket_line_item_no_pms' => array( |
|
320 | - 'input' => 'textarea', |
|
321 | - 'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __( |
|
322 | - 'Ticket Line Item List with no Price Modifiers', |
|
323 | - 'event_espresso' |
|
324 | - ), |
|
325 | - 'type' => 'string', |
|
326 | - 'required' => false, |
|
327 | - 'validation' => true, |
|
328 | - 'format' => '%s', |
|
329 | - 'css_class' => 'large-text', |
|
330 | - 'rows' => '5', |
|
331 | - 'shortcodes_required' => array('[TICKET_LINE_ITEM_LIST]'), |
|
332 | - ), |
|
333 | - 'ticket_line_item_pms' => array( |
|
334 | - 'input' => 'textarea', |
|
335 | - 'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __( |
|
336 | - 'Ticket Line Item List with Price Modifiers', |
|
337 | - 'event_espresso' |
|
338 | - ), |
|
339 | - 'type' => 'string', |
|
340 | - 'required' => false, |
|
341 | - 'validation' => true, |
|
342 | - 'format' => '%s', |
|
343 | - 'css_class' => 'large-text', |
|
344 | - 'rows' => '5', |
|
345 | - 'shortcodes_required' => array('[TICKET_LINE_ITEM_LIST]'), |
|
346 | - ), |
|
347 | - 'price_modifier_line_item_list' => array( |
|
348 | - 'input' => 'textarea', |
|
349 | - 'label' => '[PRICE_MODIFIER_LINE_ITEM_LIST]', |
|
350 | - 'type' => 'string', |
|
351 | - 'required' => false, |
|
352 | - 'validation' => true, |
|
353 | - 'format' => '%s', |
|
354 | - 'css_class' => 'large-text', |
|
355 | - 'rows' => '5', |
|
356 | - 'shortcodes_required' => array('[PRICE_MODIFIER_LINE_ITEM_LIST]'), |
|
357 | - ), |
|
358 | - 'datetime_list' => array( |
|
359 | - 'input' => 'textarea', |
|
360 | - 'label' => '[DATETIME_LIST]', |
|
361 | - 'type' => 'string', |
|
362 | - 'required' => true, |
|
363 | - 'validation' => true, |
|
364 | - 'format' => '%s', |
|
365 | - 'css_class' => 'large-text', |
|
366 | - 'rows' => '5', |
|
367 | - 'shortcodes_required' => array('[DATETIME_LIST]'), |
|
368 | - ), |
|
369 | - 'attendee_list' => array( |
|
370 | - 'input' => 'textarea', |
|
371 | - 'label' => '[ATTENDEE_LIST]', |
|
372 | - 'type' => 'string', |
|
373 | - 'required' => true, |
|
374 | - 'validation' => true, |
|
375 | - 'format' => '%s', |
|
376 | - 'css_class' => 'large-text', |
|
377 | - 'rows' => '5', |
|
378 | - 'shortcodes_required' => array('[ATTENDEE_LIST]'), |
|
379 | - ), |
|
380 | - 'tax_line_item_list' => array( |
|
381 | - 'input' => 'textarea', |
|
382 | - 'label' => '[TAX_LINE_ITEM_LIST]', |
|
383 | - 'type' => 'string', |
|
384 | - 'required' => false, |
|
385 | - 'validation' => true, |
|
386 | - 'format' => '%s', |
|
387 | - 'css_class' => 'large-text', |
|
388 | - 'rows' => '5', |
|
389 | - 'shortcodes_required' => array('[TAX_LINE_ITEM_LIST]'), |
|
390 | - ), |
|
391 | - 'additional_line_item_list' => array( |
|
392 | - 'input' => 'textarea', |
|
393 | - 'label' => '[ADDITIONAL_LINE_ITEM_LIST]', |
|
394 | - 'type' => 'string', |
|
395 | - 'required' => false, |
|
396 | - 'validation' => true, |
|
397 | - 'format' => '%s', |
|
398 | - 'css_class' => 'large-text', |
|
399 | - 'rows' => '5', |
|
400 | - 'shortcodes_required' => array('[ADDITIONAL_LINE_ITEM_LIST]'), |
|
401 | - ), |
|
402 | - 'payment_list' => array( |
|
403 | - 'input' => 'textarea', |
|
404 | - 'label' => '[PAYMENT_LIST]', |
|
405 | - 'type' => 'string', |
|
406 | - 'required' => true, |
|
407 | - 'validation' => true, |
|
408 | - 'format' => '%s', |
|
409 | - 'css_class' => 'large-text', |
|
410 | - 'rows' => '5', |
|
411 | - 'shortcodes_required' => array('[PAYMENT_LIST_*]'), |
|
412 | - ), |
|
413 | - ), |
|
414 | - ), |
|
415 | - ); |
|
416 | - } |
|
417 | - |
|
418 | - |
|
419 | - /** |
|
420 | - * @see definition of this method in parent |
|
421 | - * @since 4.5.0 |
|
422 | - */ |
|
423 | - protected function _set_default_message_types() |
|
424 | - { |
|
425 | - $this->_default_message_types = array('receipt', 'invoice'); |
|
426 | - } |
|
427 | - |
|
428 | - |
|
429 | - /** |
|
430 | - * @see definition of this method in parent |
|
431 | - * @since 4.5.0 |
|
432 | - */ |
|
433 | - protected function _set_valid_message_types() |
|
434 | - { |
|
435 | - $this->_valid_message_types = array('receipt', 'invoice'); |
|
436 | - } |
|
437 | - |
|
438 | - |
|
439 | - /** |
|
440 | - * Displays the message in the browser. |
|
441 | - * |
|
442 | - * @since 4.5.0 |
|
443 | - * @return string. |
|
444 | - */ |
|
445 | - protected function _send_message() |
|
446 | - { |
|
447 | - $this->_template_args = array( |
|
448 | - 'page_title' => $this->_subject, |
|
449 | - 'base_css' => $this->get_variation( |
|
450 | - $this->_tmp_pack, |
|
451 | - $this->_incoming_message_type->name, |
|
452 | - true, |
|
453 | - 'base', |
|
454 | - $this->_variation |
|
455 | - ), |
|
456 | - 'print_css' => $this->get_variation( |
|
457 | - $this->_tmp_pack, |
|
458 | - $this->_incoming_message_type->name, |
|
459 | - true, |
|
460 | - 'print', |
|
461 | - $this->_variation |
|
462 | - ), |
|
463 | - 'main_css' => $this->get_variation( |
|
464 | - $this->_tmp_pack, |
|
465 | - $this->_incoming_message_type->name, |
|
466 | - true, |
|
467 | - 'main', |
|
468 | - $this->_variation |
|
469 | - ), |
|
470 | - 'main_body' => wpautop( |
|
471 | - apply_filters( |
|
472 | - 'FHEE__EE_Html_messenger___send_message__main_body', |
|
473 | - $this->_content, |
|
474 | - $this->_content, |
|
475 | - $this->_incoming_message_type |
|
476 | - ) |
|
477 | - ) |
|
478 | - ); |
|
479 | - $this->_deregister_wp_hooks(); |
|
480 | - add_action('wp_enqueue_scripts', array($this, 'enqueue_scripts_styles')); |
|
481 | - echo $this->_get_main_template(); |
|
482 | - exit(); |
|
483 | - } |
|
484 | - |
|
485 | - |
|
486 | - /** |
|
487 | - * The purpose of this function is to de register all actions hooked into wp_head and wp_footer so that it doesn't |
|
488 | - * interfere with our templates. If users want to add any custom styles or scripts they must use the |
|
489 | - * AHEE__EE_Html_messenger__enqueue_scripts_styles hook. |
|
490 | - * |
|
491 | - * @since 4.5.0 |
|
492 | - * @return void |
|
493 | - */ |
|
494 | - protected function _deregister_wp_hooks() |
|
495 | - { |
|
496 | - remove_all_actions('wp_head'); |
|
497 | - remove_all_actions('wp_footer'); |
|
498 | - remove_all_actions('wp_print_footer_scripts'); |
|
499 | - remove_all_actions('wp_enqueue_scripts'); |
|
500 | - global $wp_scripts, $wp_styles; |
|
501 | - $wp_scripts = $wp_styles = array(); |
|
502 | - //just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load. |
|
503 | - add_action('wp_footer', 'wp_print_footer_scripts'); |
|
504 | - add_action('wp_print_footer_scripts', '_wp_footer_scripts'); |
|
505 | - add_action('wp_head', 'wp_enqueue_scripts'); |
|
506 | - } |
|
507 | - |
|
508 | - |
|
509 | - /** |
|
510 | - * Overwrite parent _get_main_template for display_html purposes. |
|
511 | - * |
|
512 | - * @since 4.5.0 |
|
513 | - * @param bool $preview |
|
514 | - * @return string |
|
515 | - */ |
|
516 | - protected function _get_main_template($preview = false) |
|
517 | - { |
|
518 | - $wrapper_template = $this->_tmp_pack->get_wrapper($this->name, 'main'); |
|
519 | - //include message type as a template arg |
|
520 | - $this->_template_args['message_type'] = $this->_incoming_message_type; |
|
521 | - return EEH_Template::display_template($wrapper_template, $this->_template_args, true); |
|
522 | - } |
|
523 | - |
|
524 | - |
|
525 | - /** |
|
526 | - * @return string |
|
527 | - */ |
|
528 | - protected function _preview() |
|
529 | - { |
|
530 | - return $this->_send_message(); |
|
531 | - } |
|
532 | - |
|
533 | - |
|
534 | - protected function _set_admin_settings_fields() |
|
535 | - { |
|
536 | - } |
|
537 | - |
|
538 | - |
|
539 | - /** |
|
540 | - * add the "powered by EE" credit link to the HTML receipt and invoice |
|
541 | - * |
|
542 | - * @param string $content |
|
543 | - * @param string $content_again |
|
544 | - * @param \EE_message_type $incoming_message_type |
|
545 | - * @return string |
|
546 | - */ |
|
547 | - public function add_powered_by_credit_link_to_receipt_and_invoice( |
|
548 | - $content = '', |
|
549 | - $content_again = '', |
|
550 | - EE_message_type $incoming_message_type |
|
551 | - ) |
|
552 | - { |
|
553 | - if ( |
|
554 | - ($incoming_message_type->name === 'invoice' || $incoming_message_type->name === 'receipt') |
|
555 | - && apply_filters('FHEE_EE_Html_messenger__add_powered_by_credit_link_to_receipt_and_invoice', true) |
|
556 | - ) { |
|
557 | - $content .= \EEH_Template::powered_by_event_espresso( |
|
558 | - 'aln-cntr', |
|
559 | - '', |
|
560 | - array('utm_content' => 'messages_system') |
|
561 | - ) |
|
562 | - . EEH_HTML::div(EEH_HTML::p(' ')); |
|
563 | - } |
|
564 | - return $content; |
|
565 | - } |
|
19 | + /** |
|
20 | + * The following are the properties that this messenger requires for displaying the html |
|
21 | + */ |
|
22 | + /** |
|
23 | + * This is the html body generated by the template via the message type. |
|
24 | + * |
|
25 | + * @var string |
|
26 | + */ |
|
27 | + protected $_content; |
|
28 | + |
|
29 | + |
|
30 | + /** |
|
31 | + * This is for the page title that gets displayed. (Why use "subject"? Because the "title" tag in html is |
|
32 | + * equivalent to the "subject" of the page. |
|
33 | + * |
|
34 | + * @var string |
|
35 | + */ |
|
36 | + protected $_subject; |
|
37 | + |
|
38 | + |
|
39 | + /** |
|
40 | + * EE_Html_messenger constructor. |
|
41 | + */ |
|
42 | + public function __construct() |
|
43 | + { |
|
44 | + //set properties |
|
45 | + $this->name = 'html'; |
|
46 | + $this->description = __('This messenger outputs a message to a browser for display.', 'event_espresso'); |
|
47 | + $this->label = array( |
|
48 | + 'singular' => __('html', 'event_espresso'), |
|
49 | + 'plural' => __('html', 'event_espresso'), |
|
50 | + ); |
|
51 | + $this->activate_on_install = true; |
|
52 | + // add the "powered by EE" credit link to the HTML receipt and invoice |
|
53 | + add_filter( |
|
54 | + 'FHEE__EE_Html_messenger___send_message__main_body', |
|
55 | + array($this, 'add_powered_by_credit_link_to_receipt_and_invoice'), |
|
56 | + 10, |
|
57 | + 3 |
|
58 | + ); |
|
59 | + parent::__construct(); |
|
60 | + } |
|
61 | + |
|
62 | + |
|
63 | + /** |
|
64 | + * HTML Messenger desires execution immediately. |
|
65 | + * |
|
66 | + * @see parent::send_now() for documentation. |
|
67 | + * @since 4.9.0 |
|
68 | + * @return bool |
|
69 | + */ |
|
70 | + public function send_now() |
|
71 | + { |
|
72 | + return true; |
|
73 | + } |
|
74 | + |
|
75 | + |
|
76 | + /** |
|
77 | + * HTML Messenger allows an empty to field. |
|
78 | + * |
|
79 | + * @see parent::allow_empty_to_field() for documentation |
|
80 | + * @since 4.9.0 |
|
81 | + * @return bool |
|
82 | + */ |
|
83 | + public function allow_empty_to_field() |
|
84 | + { |
|
85 | + return true; |
|
86 | + } |
|
87 | + |
|
88 | + |
|
89 | + /** |
|
90 | + * @see abstract declaration in EE_messenger for details. |
|
91 | + */ |
|
92 | + protected function _set_admin_pages() |
|
93 | + { |
|
94 | + $this->admin_registered_pages = array('events_edit' => true); |
|
95 | + } |
|
96 | + |
|
97 | + |
|
98 | + /** |
|
99 | + * @see abstract declaration in EE_messenger for details. |
|
100 | + */ |
|
101 | + protected function _set_valid_shortcodes() |
|
102 | + { |
|
103 | + $this->_valid_shortcodes = array(); |
|
104 | + } |
|
105 | + |
|
106 | + |
|
107 | + /** |
|
108 | + * @see abstract declaration in EE_messenger for details. |
|
109 | + */ |
|
110 | + protected function _set_validator_config() |
|
111 | + { |
|
112 | + $this->_validator_config = array( |
|
113 | + 'subject' => array( |
|
114 | + 'shortcodes' => array('organization', 'primary_registration_details', 'email', 'transaction'), |
|
115 | + ), |
|
116 | + 'content' => array( |
|
117 | + 'shortcodes' => array( |
|
118 | + 'organization', |
|
119 | + 'primary_registration_list', |
|
120 | + 'primary_registration_details', |
|
121 | + 'email', |
|
122 | + 'transaction', |
|
123 | + 'event_list', |
|
124 | + 'payment_list', |
|
125 | + 'venue', |
|
126 | + 'line_item_list', |
|
127 | + 'messenger', |
|
128 | + 'ticket_list', |
|
129 | + ), |
|
130 | + ), |
|
131 | + 'event_list' => array( |
|
132 | + 'shortcodes' => array( |
|
133 | + 'event', |
|
134 | + 'ticket_list', |
|
135 | + 'venue', |
|
136 | + 'primary_registration_details', |
|
137 | + 'primary_registration_list', |
|
138 | + 'event_author', |
|
139 | + ), |
|
140 | + 'required' => array('[EVENT_LIST]'), |
|
141 | + ), |
|
142 | + 'ticket_list' => array( |
|
143 | + 'shortcodes' => array( |
|
144 | + 'attendee_list', |
|
145 | + 'ticket', |
|
146 | + 'datetime_list', |
|
147 | + 'primary_registration_details', |
|
148 | + 'line_item_list', |
|
149 | + 'venue', |
|
150 | + ), |
|
151 | + 'required' => array('[TICKET_LIST]'), |
|
152 | + ), |
|
153 | + 'ticket_line_item_no_pms' => array( |
|
154 | + 'shortcodes' => array('line_item', 'ticket'), |
|
155 | + 'required' => array('[TICKET_LINE_ITEM_LIST]'), |
|
156 | + ), |
|
157 | + 'ticket_line_item_pms' => array( |
|
158 | + 'shortcodes' => array('line_item', 'ticket', 'line_item_list'), |
|
159 | + 'required' => array('[TICKET_LINE_ITEM_LIST]'), |
|
160 | + ), |
|
161 | + 'price_modifier_line_item_list' => array( |
|
162 | + 'shortcodes' => array('line_item'), |
|
163 | + 'required' => array('[PRICE_MODIFIER_LINE_ITEM_LIST]'), |
|
164 | + ), |
|
165 | + 'datetime_list' => array( |
|
166 | + 'shortcodes' => array('datetime'), |
|
167 | + 'required' => array('[DATETIME_LIST]'), |
|
168 | + ), |
|
169 | + 'attendee_list' => array( |
|
170 | + 'shortcodes' => array('attendee'), |
|
171 | + 'required' => array('[ATTENDEE_LIST]'), |
|
172 | + ), |
|
173 | + 'tax_line_item_list' => array( |
|
174 | + 'shortcodes' => array('line_item'), |
|
175 | + 'required' => array('[TAX_LINE_ITEM_LIST]'), |
|
176 | + ), |
|
177 | + 'additional_line_item_list' => array( |
|
178 | + 'shortcodes' => array('line_item'), |
|
179 | + 'required' => array('[ADDITIONAL_LINE_ITEM_LIST]'), |
|
180 | + ), |
|
181 | + 'payment_list' => array( |
|
182 | + 'shortcodes' => array('payment'), |
|
183 | + 'required' => array('[PAYMENT_LIST_*]'), |
|
184 | + ), |
|
185 | + ); |
|
186 | + } |
|
187 | + |
|
188 | + |
|
189 | + /** |
|
190 | + * This is a method called from EE_messages when this messenger is a generating messenger and the sending messenger |
|
191 | + * is a different messenger. Child messengers can set hooks for the sending messenger to callback on if necessary |
|
192 | + * (i.e. swap out css files or something else). |
|
193 | + * |
|
194 | + * @since 4.5.0 |
|
195 | + * @param string $sending_messenger_name the name of the sending messenger so we only set the hooks needed. |
|
196 | + * @return void |
|
197 | + */ |
|
198 | + public function do_secondary_messenger_hooks($sending_messenger_name) |
|
199 | + { |
|
200 | + if ($sending_messenger_name = 'pdf') { |
|
201 | + add_filter('EE_messenger__get_variation__variation', array($this, 'add_html_css'), 10, 8); |
|
202 | + } |
|
203 | + } |
|
204 | + |
|
205 | + |
|
206 | + /** |
|
207 | + * @param $variation_path |
|
208 | + * @param \EE_Messages_Template_Pack $template_pack |
|
209 | + * @param $messenger_name |
|
210 | + * @param $message_type_name |
|
211 | + * @param $url |
|
212 | + * @param $type |
|
213 | + * @param $variation |
|
214 | + * @param $skip_filters |
|
215 | + * @return string |
|
216 | + */ |
|
217 | + public function add_html_css( |
|
218 | + $variation_path, |
|
219 | + EE_Messages_Template_Pack $template_pack, |
|
220 | + $messenger_name, |
|
221 | + $message_type_name, |
|
222 | + $url, |
|
223 | + $type, |
|
224 | + $variation, |
|
225 | + $skip_filters |
|
226 | + ) |
|
227 | + { |
|
228 | + $variation = $template_pack->get_variation( |
|
229 | + $this->name, |
|
230 | + $message_type_name, |
|
231 | + $type, |
|
232 | + $variation, |
|
233 | + $url, |
|
234 | + '.css', |
|
235 | + $skip_filters |
|
236 | + ); |
|
237 | + return $variation; |
|
238 | + } |
|
239 | + |
|
240 | + |
|
241 | + /** |
|
242 | + * Takes care of enqueuing any necessary scripts or styles for the page. A do_action() so message types using this |
|
243 | + * messenger can add their own js. |
|
244 | + * |
|
245 | + * @return void. |
|
246 | + */ |
|
247 | + public function enqueue_scripts_styles() |
|
248 | + { |
|
249 | + parent::enqueue_scripts_styles(); |
|
250 | + do_action('AHEE__EE_Html_messenger__enqueue_scripts_styles'); |
|
251 | + } |
|
252 | + |
|
253 | + |
|
254 | + /** |
|
255 | + * _set_template_fields |
|
256 | + * This sets up the fields that a messenger requires for the message to go out. |
|
257 | + * |
|
258 | + * @access protected |
|
259 | + * @return void |
|
260 | + */ |
|
261 | + protected function _set_template_fields() |
|
262 | + { |
|
263 | + // any extra template fields that are NOT used by the messenger |
|
264 | + // but will get used by a messenger field for shortcode replacement |
|
265 | + // get added to the 'extra' key in an associated array |
|
266 | + // indexed by the messenger field they relate to. |
|
267 | + // This is important for the Messages_admin to know what fields to display to the user. |
|
268 | + // Also, notice that the "values" are equal to the field type |
|
269 | + // that messages admin will use to know what kind of field to display. |
|
270 | + // The values ALSO have one index labeled "shortcode". |
|
271 | + // The values in that array indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) |
|
272 | + // is required in order for this extra field to be displayed. |
|
273 | + // If the required shortcode isn't part of the shortcodes array |
|
274 | + // then the field is not needed and will not be displayed/parsed. |
|
275 | + $this->_template_fields = array( |
|
276 | + 'subject' => array( |
|
277 | + 'input' => 'text', |
|
278 | + 'label' => __('Page Title', 'event_espresso'), |
|
279 | + 'type' => 'string', |
|
280 | + 'required' => true, |
|
281 | + 'validation' => true, |
|
282 | + 'css_class' => 'large-text', |
|
283 | + 'format' => '%s', |
|
284 | + ), |
|
285 | + 'content' => '', |
|
286 | + //left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field. |
|
287 | + 'extra' => array( |
|
288 | + 'content' => array( |
|
289 | + 'main' => array( |
|
290 | + 'input' => 'wp_editor', |
|
291 | + 'label' => __('Main Content', 'event_espresso'), |
|
292 | + 'type' => 'string', |
|
293 | + 'required' => true, |
|
294 | + 'validation' => true, |
|
295 | + 'format' => '%s', |
|
296 | + 'rows' => '15', |
|
297 | + ), |
|
298 | + 'event_list' => array( |
|
299 | + 'input' => 'wp_editor', |
|
300 | + 'label' => '[EVENT_LIST]', |
|
301 | + 'type' => 'string', |
|
302 | + 'required' => true, |
|
303 | + 'validation' => true, |
|
304 | + 'format' => '%s', |
|
305 | + 'rows' => '15', |
|
306 | + 'shortcodes_required' => array('[EVENT_LIST]'), |
|
307 | + ), |
|
308 | + 'ticket_list' => array( |
|
309 | + 'input' => 'textarea', |
|
310 | + 'label' => '[TICKET_LIST]', |
|
311 | + 'type' => 'string', |
|
312 | + 'required' => true, |
|
313 | + 'validation' => true, |
|
314 | + 'format' => '%s', |
|
315 | + 'css_class' => 'large-text', |
|
316 | + 'rows' => '10', |
|
317 | + 'shortcodes_required' => array('[TICKET_LIST]'), |
|
318 | + ), |
|
319 | + 'ticket_line_item_no_pms' => array( |
|
320 | + 'input' => 'textarea', |
|
321 | + 'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __( |
|
322 | + 'Ticket Line Item List with no Price Modifiers', |
|
323 | + 'event_espresso' |
|
324 | + ), |
|
325 | + 'type' => 'string', |
|
326 | + 'required' => false, |
|
327 | + 'validation' => true, |
|
328 | + 'format' => '%s', |
|
329 | + 'css_class' => 'large-text', |
|
330 | + 'rows' => '5', |
|
331 | + 'shortcodes_required' => array('[TICKET_LINE_ITEM_LIST]'), |
|
332 | + ), |
|
333 | + 'ticket_line_item_pms' => array( |
|
334 | + 'input' => 'textarea', |
|
335 | + 'label' => '[TICKET_LINE_ITEM_LIST] <br>' . __( |
|
336 | + 'Ticket Line Item List with Price Modifiers', |
|
337 | + 'event_espresso' |
|
338 | + ), |
|
339 | + 'type' => 'string', |
|
340 | + 'required' => false, |
|
341 | + 'validation' => true, |
|
342 | + 'format' => '%s', |
|
343 | + 'css_class' => 'large-text', |
|
344 | + 'rows' => '5', |
|
345 | + 'shortcodes_required' => array('[TICKET_LINE_ITEM_LIST]'), |
|
346 | + ), |
|
347 | + 'price_modifier_line_item_list' => array( |
|
348 | + 'input' => 'textarea', |
|
349 | + 'label' => '[PRICE_MODIFIER_LINE_ITEM_LIST]', |
|
350 | + 'type' => 'string', |
|
351 | + 'required' => false, |
|
352 | + 'validation' => true, |
|
353 | + 'format' => '%s', |
|
354 | + 'css_class' => 'large-text', |
|
355 | + 'rows' => '5', |
|
356 | + 'shortcodes_required' => array('[PRICE_MODIFIER_LINE_ITEM_LIST]'), |
|
357 | + ), |
|
358 | + 'datetime_list' => array( |
|
359 | + 'input' => 'textarea', |
|
360 | + 'label' => '[DATETIME_LIST]', |
|
361 | + 'type' => 'string', |
|
362 | + 'required' => true, |
|
363 | + 'validation' => true, |
|
364 | + 'format' => '%s', |
|
365 | + 'css_class' => 'large-text', |
|
366 | + 'rows' => '5', |
|
367 | + 'shortcodes_required' => array('[DATETIME_LIST]'), |
|
368 | + ), |
|
369 | + 'attendee_list' => array( |
|
370 | + 'input' => 'textarea', |
|
371 | + 'label' => '[ATTENDEE_LIST]', |
|
372 | + 'type' => 'string', |
|
373 | + 'required' => true, |
|
374 | + 'validation' => true, |
|
375 | + 'format' => '%s', |
|
376 | + 'css_class' => 'large-text', |
|
377 | + 'rows' => '5', |
|
378 | + 'shortcodes_required' => array('[ATTENDEE_LIST]'), |
|
379 | + ), |
|
380 | + 'tax_line_item_list' => array( |
|
381 | + 'input' => 'textarea', |
|
382 | + 'label' => '[TAX_LINE_ITEM_LIST]', |
|
383 | + 'type' => 'string', |
|
384 | + 'required' => false, |
|
385 | + 'validation' => true, |
|
386 | + 'format' => '%s', |
|
387 | + 'css_class' => 'large-text', |
|
388 | + 'rows' => '5', |
|
389 | + 'shortcodes_required' => array('[TAX_LINE_ITEM_LIST]'), |
|
390 | + ), |
|
391 | + 'additional_line_item_list' => array( |
|
392 | + 'input' => 'textarea', |
|
393 | + 'label' => '[ADDITIONAL_LINE_ITEM_LIST]', |
|
394 | + 'type' => 'string', |
|
395 | + 'required' => false, |
|
396 | + 'validation' => true, |
|
397 | + 'format' => '%s', |
|
398 | + 'css_class' => 'large-text', |
|
399 | + 'rows' => '5', |
|
400 | + 'shortcodes_required' => array('[ADDITIONAL_LINE_ITEM_LIST]'), |
|
401 | + ), |
|
402 | + 'payment_list' => array( |
|
403 | + 'input' => 'textarea', |
|
404 | + 'label' => '[PAYMENT_LIST]', |
|
405 | + 'type' => 'string', |
|
406 | + 'required' => true, |
|
407 | + 'validation' => true, |
|
408 | + 'format' => '%s', |
|
409 | + 'css_class' => 'large-text', |
|
410 | + 'rows' => '5', |
|
411 | + 'shortcodes_required' => array('[PAYMENT_LIST_*]'), |
|
412 | + ), |
|
413 | + ), |
|
414 | + ), |
|
415 | + ); |
|
416 | + } |
|
417 | + |
|
418 | + |
|
419 | + /** |
|
420 | + * @see definition of this method in parent |
|
421 | + * @since 4.5.0 |
|
422 | + */ |
|
423 | + protected function _set_default_message_types() |
|
424 | + { |
|
425 | + $this->_default_message_types = array('receipt', 'invoice'); |
|
426 | + } |
|
427 | + |
|
428 | + |
|
429 | + /** |
|
430 | + * @see definition of this method in parent |
|
431 | + * @since 4.5.0 |
|
432 | + */ |
|
433 | + protected function _set_valid_message_types() |
|
434 | + { |
|
435 | + $this->_valid_message_types = array('receipt', 'invoice'); |
|
436 | + } |
|
437 | + |
|
438 | + |
|
439 | + /** |
|
440 | + * Displays the message in the browser. |
|
441 | + * |
|
442 | + * @since 4.5.0 |
|
443 | + * @return string. |
|
444 | + */ |
|
445 | + protected function _send_message() |
|
446 | + { |
|
447 | + $this->_template_args = array( |
|
448 | + 'page_title' => $this->_subject, |
|
449 | + 'base_css' => $this->get_variation( |
|
450 | + $this->_tmp_pack, |
|
451 | + $this->_incoming_message_type->name, |
|
452 | + true, |
|
453 | + 'base', |
|
454 | + $this->_variation |
|
455 | + ), |
|
456 | + 'print_css' => $this->get_variation( |
|
457 | + $this->_tmp_pack, |
|
458 | + $this->_incoming_message_type->name, |
|
459 | + true, |
|
460 | + 'print', |
|
461 | + $this->_variation |
|
462 | + ), |
|
463 | + 'main_css' => $this->get_variation( |
|
464 | + $this->_tmp_pack, |
|
465 | + $this->_incoming_message_type->name, |
|
466 | + true, |
|
467 | + 'main', |
|
468 | + $this->_variation |
|
469 | + ), |
|
470 | + 'main_body' => wpautop( |
|
471 | + apply_filters( |
|
472 | + 'FHEE__EE_Html_messenger___send_message__main_body', |
|
473 | + $this->_content, |
|
474 | + $this->_content, |
|
475 | + $this->_incoming_message_type |
|
476 | + ) |
|
477 | + ) |
|
478 | + ); |
|
479 | + $this->_deregister_wp_hooks(); |
|
480 | + add_action('wp_enqueue_scripts', array($this, 'enqueue_scripts_styles')); |
|
481 | + echo $this->_get_main_template(); |
|
482 | + exit(); |
|
483 | + } |
|
484 | + |
|
485 | + |
|
486 | + /** |
|
487 | + * The purpose of this function is to de register all actions hooked into wp_head and wp_footer so that it doesn't |
|
488 | + * interfere with our templates. If users want to add any custom styles or scripts they must use the |
|
489 | + * AHEE__EE_Html_messenger__enqueue_scripts_styles hook. |
|
490 | + * |
|
491 | + * @since 4.5.0 |
|
492 | + * @return void |
|
493 | + */ |
|
494 | + protected function _deregister_wp_hooks() |
|
495 | + { |
|
496 | + remove_all_actions('wp_head'); |
|
497 | + remove_all_actions('wp_footer'); |
|
498 | + remove_all_actions('wp_print_footer_scripts'); |
|
499 | + remove_all_actions('wp_enqueue_scripts'); |
|
500 | + global $wp_scripts, $wp_styles; |
|
501 | + $wp_scripts = $wp_styles = array(); |
|
502 | + //just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load. |
|
503 | + add_action('wp_footer', 'wp_print_footer_scripts'); |
|
504 | + add_action('wp_print_footer_scripts', '_wp_footer_scripts'); |
|
505 | + add_action('wp_head', 'wp_enqueue_scripts'); |
|
506 | + } |
|
507 | + |
|
508 | + |
|
509 | + /** |
|
510 | + * Overwrite parent _get_main_template for display_html purposes. |
|
511 | + * |
|
512 | + * @since 4.5.0 |
|
513 | + * @param bool $preview |
|
514 | + * @return string |
|
515 | + */ |
|
516 | + protected function _get_main_template($preview = false) |
|
517 | + { |
|
518 | + $wrapper_template = $this->_tmp_pack->get_wrapper($this->name, 'main'); |
|
519 | + //include message type as a template arg |
|
520 | + $this->_template_args['message_type'] = $this->_incoming_message_type; |
|
521 | + return EEH_Template::display_template($wrapper_template, $this->_template_args, true); |
|
522 | + } |
|
523 | + |
|
524 | + |
|
525 | + /** |
|
526 | + * @return string |
|
527 | + */ |
|
528 | + protected function _preview() |
|
529 | + { |
|
530 | + return $this->_send_message(); |
|
531 | + } |
|
532 | + |
|
533 | + |
|
534 | + protected function _set_admin_settings_fields() |
|
535 | + { |
|
536 | + } |
|
537 | + |
|
538 | + |
|
539 | + /** |
|
540 | + * add the "powered by EE" credit link to the HTML receipt and invoice |
|
541 | + * |
|
542 | + * @param string $content |
|
543 | + * @param string $content_again |
|
544 | + * @param \EE_message_type $incoming_message_type |
|
545 | + * @return string |
|
546 | + */ |
|
547 | + public function add_powered_by_credit_link_to_receipt_and_invoice( |
|
548 | + $content = '', |
|
549 | + $content_again = '', |
|
550 | + EE_message_type $incoming_message_type |
|
551 | + ) |
|
552 | + { |
|
553 | + if ( |
|
554 | + ($incoming_message_type->name === 'invoice' || $incoming_message_type->name === 'receipt') |
|
555 | + && apply_filters('FHEE_EE_Html_messenger__add_powered_by_credit_link_to_receipt_and_invoice', true) |
|
556 | + ) { |
|
557 | + $content .= \EEH_Template::powered_by_event_espresso( |
|
558 | + 'aln-cntr', |
|
559 | + '', |
|
560 | + array('utm_content' => 'messages_system') |
|
561 | + ) |
|
562 | + . EEH_HTML::div(EEH_HTML::p(' ')); |
|
563 | + } |
|
564 | + return $content; |
|
565 | + } |
|
566 | 566 | |
567 | 567 | } |
@@ -14,7 +14,7 @@ discard block |
||
14 | 14 | use RuntimeException; |
15 | 15 | |
16 | 16 | if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
17 | - exit('No direct script access allowed'); |
|
17 | + exit('No direct script access allowed'); |
|
18 | 18 | } |
19 | 19 | |
20 | 20 | |
@@ -32,155 +32,155 @@ discard block |
||
32 | 32 | { |
33 | 33 | |
34 | 34 | |
35 | - /** |
|
36 | - * @param EE_Registration $target_registration |
|
37 | - * @param EE_Registration $registration_to_copy |
|
38 | - * @return bool |
|
39 | - * @throws UnexpectedEntityException |
|
40 | - * @throws EntityNotFoundException |
|
41 | - * @throws RuntimeException |
|
42 | - * @throws EE_Error |
|
43 | - */ |
|
44 | - public function copyRegistrationDetails( |
|
45 | - EE_Registration $target_registration, |
|
46 | - EE_Registration $registration_to_copy |
|
47 | - ) { |
|
48 | - // copy attendee |
|
49 | - $target_registration->set_attendee_id($registration_to_copy->attendee_ID()); |
|
50 | - $target_registration->updateStatusBasedOnTotalPaid(false); |
|
51 | - $target_registration->save(); |
|
52 | - // get answers to previous reg questions |
|
53 | - $answers = $this->reindexAnswersByQuestionId($registration_to_copy->answers()); |
|
54 | - // get questions to new event reg form |
|
55 | - $new_event = $target_registration->event(); |
|
56 | - $question_groups = $new_event->question_groups( |
|
57 | - array( |
|
58 | - array( |
|
59 | - 'Event.EVT_ID' => $new_event->ID(), |
|
60 | - 'Event_Question_Group.EQG_primary' => $registration_to_copy->is_primary_registrant(), |
|
61 | - ), |
|
62 | - 'order_by' => array('QSG_order' => 'ASC'), |
|
63 | - ) |
|
64 | - ); |
|
65 | - foreach ($question_groups as $question_group) { |
|
66 | - if ($question_group instanceof \EE_Question_Group) { |
|
67 | - foreach ($question_group->questions() as $question) { |
|
68 | - if ($question instanceof EE_Question) { |
|
69 | - $this->generateNewAnswer( |
|
70 | - $question, |
|
71 | - $target_registration, |
|
72 | - $answers |
|
73 | - ); |
|
74 | - } |
|
75 | - } |
|
76 | - } |
|
77 | - } |
|
78 | - return true; |
|
79 | - } |
|
80 | - |
|
81 | - |
|
82 | - |
|
83 | - /** |
|
84 | - * @param EE_Answer[] $answers |
|
85 | - * @return array |
|
86 | - * @throws EE_Error |
|
87 | - */ |
|
88 | - protected function reindexAnswersByQuestionId(array $answers) |
|
89 | - { |
|
90 | - $reindexed_answers = array(); |
|
91 | - foreach ($answers as $answer) { |
|
92 | - if ($answer instanceof EE_Answer) { |
|
93 | - $reindexed_answers[ $answer->question_ID() ] = $answer->value(); |
|
94 | - } |
|
95 | - } |
|
96 | - return $reindexed_answers; |
|
97 | - } |
|
98 | - |
|
99 | - |
|
100 | - |
|
101 | - /** |
|
102 | - * @param EE_Question $question |
|
103 | - * @param EE_Registration $registration |
|
104 | - * @param $previous_answers |
|
105 | - * @return EE_Answer |
|
106 | - * @throws UnexpectedEntityException |
|
107 | - * @throws EE_Error |
|
108 | - */ |
|
109 | - protected function generateNewAnswer( |
|
110 | - EE_Question $question, |
|
111 | - EE_Registration $registration, |
|
112 | - $previous_answers |
|
113 | - ) { |
|
114 | - $old_answer_value = isset($previous_answers[ $question->ID() ]) |
|
115 | - ? $previous_answers[ $question->ID() ] |
|
116 | - : ''; |
|
117 | - $new_answer = EE_Answer::new_instance( |
|
118 | - array( |
|
119 | - 'QST_ID' => $question->ID(), |
|
120 | - 'REG_ID' => $registration->ID(), |
|
121 | - 'ANS_value' => $old_answer_value, |
|
122 | - ) |
|
123 | - ); |
|
124 | - if ( ! $new_answer instanceof EE_Answer) { |
|
125 | - throw new UnexpectedEntityException($new_answer, 'EE_Answer'); |
|
126 | - } |
|
127 | - $new_answer->save(); |
|
128 | - return $new_answer; |
|
129 | - } |
|
130 | - |
|
131 | - |
|
132 | - |
|
133 | - /** |
|
134 | - * @param EE_Registration $target_registration |
|
135 | - * @param EE_Registration $registration_to_copy |
|
136 | - * @return bool |
|
137 | - * @throws RuntimeException |
|
138 | - * @throws UnexpectedEntityException |
|
139 | - * @throws EE_Error |
|
140 | - */ |
|
141 | - public function copyPaymentDetails( |
|
142 | - EE_Registration $target_registration, |
|
143 | - EE_Registration $registration_to_copy |
|
144 | - ) { |
|
145 | - $save = false; |
|
146 | - $previous_registration_payments = $registration_to_copy->registration_payments(); |
|
147 | - $new_registration_payment_total = 0; |
|
148 | - $registration_to_copy_total = $registration_to_copy->paid(); |
|
149 | - foreach ($previous_registration_payments as $previous_registration_payment) { |
|
150 | - if ( |
|
151 | - $previous_registration_payment instanceof EE_Registration_Payment |
|
152 | - && $previous_registration_payment->payment() instanceof EE_Payment |
|
153 | - && $previous_registration_payment->payment()->is_approved() |
|
154 | - ) { |
|
155 | - $payment_amount = $previous_registration_payment->amount(); |
|
156 | - $new_registration_payment = EE_Registration_Payment::new_instance( |
|
157 | - array( |
|
158 | - 'REG_ID' => $target_registration->ID(), |
|
159 | - 'PAY_ID' => $previous_registration_payment->payment()->ID(), |
|
160 | - 'RPY_amount' => $payment_amount, |
|
161 | - ) |
|
162 | - ); |
|
163 | - if ( ! $new_registration_payment instanceof EE_Registration_Payment) { |
|
164 | - throw new UnexpectedEntityException($new_registration_payment, 'EE_Registration_Payment'); |
|
165 | - } |
|
166 | - $new_registration_payment->save(); |
|
167 | - // if new reg payment is good, then set old reg payment amount to zero |
|
168 | - $previous_registration_payment->set_amount(0); |
|
169 | - $previous_registration_payment->save(); |
|
170 | - // now increment/decrement payment amounts |
|
171 | - $new_registration_payment_total += $payment_amount; |
|
172 | - $registration_to_copy_total -= $payment_amount; |
|
173 | - $save = true; |
|
174 | - } |
|
175 | - } |
|
176 | - if($save){ |
|
177 | - $target_registration->set_paid($new_registration_payment_total); |
|
178 | - $target_registration->save(); |
|
179 | - $registration_to_copy->set_paid($registration_to_copy_total); |
|
180 | - $registration_to_copy->save(); |
|
181 | - } |
|
182 | - return true; |
|
183 | - } |
|
35 | + /** |
|
36 | + * @param EE_Registration $target_registration |
|
37 | + * @param EE_Registration $registration_to_copy |
|
38 | + * @return bool |
|
39 | + * @throws UnexpectedEntityException |
|
40 | + * @throws EntityNotFoundException |
|
41 | + * @throws RuntimeException |
|
42 | + * @throws EE_Error |
|
43 | + */ |
|
44 | + public function copyRegistrationDetails( |
|
45 | + EE_Registration $target_registration, |
|
46 | + EE_Registration $registration_to_copy |
|
47 | + ) { |
|
48 | + // copy attendee |
|
49 | + $target_registration->set_attendee_id($registration_to_copy->attendee_ID()); |
|
50 | + $target_registration->updateStatusBasedOnTotalPaid(false); |
|
51 | + $target_registration->save(); |
|
52 | + // get answers to previous reg questions |
|
53 | + $answers = $this->reindexAnswersByQuestionId($registration_to_copy->answers()); |
|
54 | + // get questions to new event reg form |
|
55 | + $new_event = $target_registration->event(); |
|
56 | + $question_groups = $new_event->question_groups( |
|
57 | + array( |
|
58 | + array( |
|
59 | + 'Event.EVT_ID' => $new_event->ID(), |
|
60 | + 'Event_Question_Group.EQG_primary' => $registration_to_copy->is_primary_registrant(), |
|
61 | + ), |
|
62 | + 'order_by' => array('QSG_order' => 'ASC'), |
|
63 | + ) |
|
64 | + ); |
|
65 | + foreach ($question_groups as $question_group) { |
|
66 | + if ($question_group instanceof \EE_Question_Group) { |
|
67 | + foreach ($question_group->questions() as $question) { |
|
68 | + if ($question instanceof EE_Question) { |
|
69 | + $this->generateNewAnswer( |
|
70 | + $question, |
|
71 | + $target_registration, |
|
72 | + $answers |
|
73 | + ); |
|
74 | + } |
|
75 | + } |
|
76 | + } |
|
77 | + } |
|
78 | + return true; |
|
79 | + } |
|
80 | + |
|
81 | + |
|
82 | + |
|
83 | + /** |
|
84 | + * @param EE_Answer[] $answers |
|
85 | + * @return array |
|
86 | + * @throws EE_Error |
|
87 | + */ |
|
88 | + protected function reindexAnswersByQuestionId(array $answers) |
|
89 | + { |
|
90 | + $reindexed_answers = array(); |
|
91 | + foreach ($answers as $answer) { |
|
92 | + if ($answer instanceof EE_Answer) { |
|
93 | + $reindexed_answers[ $answer->question_ID() ] = $answer->value(); |
|
94 | + } |
|
95 | + } |
|
96 | + return $reindexed_answers; |
|
97 | + } |
|
98 | + |
|
99 | + |
|
100 | + |
|
101 | + /** |
|
102 | + * @param EE_Question $question |
|
103 | + * @param EE_Registration $registration |
|
104 | + * @param $previous_answers |
|
105 | + * @return EE_Answer |
|
106 | + * @throws UnexpectedEntityException |
|
107 | + * @throws EE_Error |
|
108 | + */ |
|
109 | + protected function generateNewAnswer( |
|
110 | + EE_Question $question, |
|
111 | + EE_Registration $registration, |
|
112 | + $previous_answers |
|
113 | + ) { |
|
114 | + $old_answer_value = isset($previous_answers[ $question->ID() ]) |
|
115 | + ? $previous_answers[ $question->ID() ] |
|
116 | + : ''; |
|
117 | + $new_answer = EE_Answer::new_instance( |
|
118 | + array( |
|
119 | + 'QST_ID' => $question->ID(), |
|
120 | + 'REG_ID' => $registration->ID(), |
|
121 | + 'ANS_value' => $old_answer_value, |
|
122 | + ) |
|
123 | + ); |
|
124 | + if ( ! $new_answer instanceof EE_Answer) { |
|
125 | + throw new UnexpectedEntityException($new_answer, 'EE_Answer'); |
|
126 | + } |
|
127 | + $new_answer->save(); |
|
128 | + return $new_answer; |
|
129 | + } |
|
130 | + |
|
131 | + |
|
132 | + |
|
133 | + /** |
|
134 | + * @param EE_Registration $target_registration |
|
135 | + * @param EE_Registration $registration_to_copy |
|
136 | + * @return bool |
|
137 | + * @throws RuntimeException |
|
138 | + * @throws UnexpectedEntityException |
|
139 | + * @throws EE_Error |
|
140 | + */ |
|
141 | + public function copyPaymentDetails( |
|
142 | + EE_Registration $target_registration, |
|
143 | + EE_Registration $registration_to_copy |
|
144 | + ) { |
|
145 | + $save = false; |
|
146 | + $previous_registration_payments = $registration_to_copy->registration_payments(); |
|
147 | + $new_registration_payment_total = 0; |
|
148 | + $registration_to_copy_total = $registration_to_copy->paid(); |
|
149 | + foreach ($previous_registration_payments as $previous_registration_payment) { |
|
150 | + if ( |
|
151 | + $previous_registration_payment instanceof EE_Registration_Payment |
|
152 | + && $previous_registration_payment->payment() instanceof EE_Payment |
|
153 | + && $previous_registration_payment->payment()->is_approved() |
|
154 | + ) { |
|
155 | + $payment_amount = $previous_registration_payment->amount(); |
|
156 | + $new_registration_payment = EE_Registration_Payment::new_instance( |
|
157 | + array( |
|
158 | + 'REG_ID' => $target_registration->ID(), |
|
159 | + 'PAY_ID' => $previous_registration_payment->payment()->ID(), |
|
160 | + 'RPY_amount' => $payment_amount, |
|
161 | + ) |
|
162 | + ); |
|
163 | + if ( ! $new_registration_payment instanceof EE_Registration_Payment) { |
|
164 | + throw new UnexpectedEntityException($new_registration_payment, 'EE_Registration_Payment'); |
|
165 | + } |
|
166 | + $new_registration_payment->save(); |
|
167 | + // if new reg payment is good, then set old reg payment amount to zero |
|
168 | + $previous_registration_payment->set_amount(0); |
|
169 | + $previous_registration_payment->save(); |
|
170 | + // now increment/decrement payment amounts |
|
171 | + $new_registration_payment_total += $payment_amount; |
|
172 | + $registration_to_copy_total -= $payment_amount; |
|
173 | + $save = true; |
|
174 | + } |
|
175 | + } |
|
176 | + if($save){ |
|
177 | + $target_registration->set_paid($new_registration_payment_total); |
|
178 | + $target_registration->save(); |
|
179 | + $registration_to_copy->set_paid($registration_to_copy_total); |
|
180 | + $registration_to_copy->save(); |
|
181 | + } |
|
182 | + return true; |
|
183 | + } |
|
184 | 184 | |
185 | 185 | |
186 | 186 | } |
@@ -90,7 +90,7 @@ discard block |
||
90 | 90 | $reindexed_answers = array(); |
91 | 91 | foreach ($answers as $answer) { |
92 | 92 | if ($answer instanceof EE_Answer) { |
93 | - $reindexed_answers[ $answer->question_ID() ] = $answer->value(); |
|
93 | + $reindexed_answers[$answer->question_ID()] = $answer->value(); |
|
94 | 94 | } |
95 | 95 | } |
96 | 96 | return $reindexed_answers; |
@@ -111,8 +111,8 @@ discard block |
||
111 | 111 | EE_Registration $registration, |
112 | 112 | $previous_answers |
113 | 113 | ) { |
114 | - $old_answer_value = isset($previous_answers[ $question->ID() ]) |
|
115 | - ? $previous_answers[ $question->ID() ] |
|
114 | + $old_answer_value = isset($previous_answers[$question->ID()]) |
|
115 | + ? $previous_answers[$question->ID()] |
|
116 | 116 | : ''; |
117 | 117 | $new_answer = EE_Answer::new_instance( |
118 | 118 | array( |
@@ -173,7 +173,7 @@ discard block |
||
173 | 173 | $save = true; |
174 | 174 | } |
175 | 175 | } |
176 | - if($save){ |
|
176 | + if ($save) { |
|
177 | 177 | $target_registration->set_paid($new_registration_payment_total); |
178 | 178 | $target_registration->save(); |
179 | 179 | $registration_to_copy->set_paid($registration_to_copy_total); |
@@ -9,51 +9,51 @@ |
||
9 | 9 | class CollectionFilterCallbackIterator extends FilterIterator |
10 | 10 | { |
11 | 11 | |
12 | - /** |
|
13 | - * Used for determining whether the iterated object in the Collection is "valid" or not. |
|
14 | - * @var Closure |
|
15 | - */ |
|
16 | - private $acceptance_callback; |
|
17 | - |
|
18 | - |
|
19 | - /** |
|
20 | - * CollectionFilterCallbackIterator constructor. |
|
21 | - * |
|
22 | - * @param Collection $collection |
|
23 | - * @param Closure $acceptance_callback The closure will receive an instance of whatever object is stored on the |
|
24 | - * collection when iterating over the collection and should return boolean. |
|
25 | - */ |
|
26 | - public function __construct(Collection $collection, Closure $acceptance_callback) |
|
27 | - { |
|
28 | - $this->acceptance_callback = $acceptance_callback; |
|
29 | - parent::__construct($collection); |
|
30 | - } |
|
31 | - |
|
32 | - /** |
|
33 | - * Check whether the current element of the iterator is acceptable |
|
34 | - * |
|
35 | - * @link http://php.net/manual/en/filteriterator.accept.php |
|
36 | - * @return bool true if the current element is acceptable, otherwise false. |
|
37 | - */ |
|
38 | - public function accept() |
|
39 | - { |
|
40 | - $acceptance_callback = $this->acceptance_callback; |
|
41 | - return $acceptance_callback($this->getInnerIterator()->current()); |
|
42 | - } |
|
43 | - |
|
44 | - |
|
45 | - |
|
46 | - /** |
|
47 | - * Returns a filtered array of objects from the collection using the provided acceptance callback |
|
48 | - * @return array |
|
49 | - */ |
|
50 | - public function getFiltered() |
|
51 | - { |
|
52 | - $filtered_array = array(); |
|
53 | - $this->rewind(); |
|
54 | - foreach ($this as $filtered_object) { |
|
55 | - $filtered_array[] = $filtered_object; |
|
56 | - } |
|
57 | - return $filtered_array; |
|
58 | - } |
|
12 | + /** |
|
13 | + * Used for determining whether the iterated object in the Collection is "valid" or not. |
|
14 | + * @var Closure |
|
15 | + */ |
|
16 | + private $acceptance_callback; |
|
17 | + |
|
18 | + |
|
19 | + /** |
|
20 | + * CollectionFilterCallbackIterator constructor. |
|
21 | + * |
|
22 | + * @param Collection $collection |
|
23 | + * @param Closure $acceptance_callback The closure will receive an instance of whatever object is stored on the |
|
24 | + * collection when iterating over the collection and should return boolean. |
|
25 | + */ |
|
26 | + public function __construct(Collection $collection, Closure $acceptance_callback) |
|
27 | + { |
|
28 | + $this->acceptance_callback = $acceptance_callback; |
|
29 | + parent::__construct($collection); |
|
30 | + } |
|
31 | + |
|
32 | + /** |
|
33 | + * Check whether the current element of the iterator is acceptable |
|
34 | + * |
|
35 | + * @link http://php.net/manual/en/filteriterator.accept.php |
|
36 | + * @return bool true if the current element is acceptable, otherwise false. |
|
37 | + */ |
|
38 | + public function accept() |
|
39 | + { |
|
40 | + $acceptance_callback = $this->acceptance_callback; |
|
41 | + return $acceptance_callback($this->getInnerIterator()->current()); |
|
42 | + } |
|
43 | + |
|
44 | + |
|
45 | + |
|
46 | + /** |
|
47 | + * Returns a filtered array of objects from the collection using the provided acceptance callback |
|
48 | + * @return array |
|
49 | + */ |
|
50 | + public function getFiltered() |
|
51 | + { |
|
52 | + $filtered_array = array(); |
|
53 | + $this->rewind(); |
|
54 | + foreach ($this as $filtered_object) { |
|
55 | + $filtered_array[] = $filtered_object; |
|
56 | + } |
|
57 | + return $filtered_array; |
|
58 | + } |
|
59 | 59 | } |
@@ -17,18 +17,18 @@ |
||
17 | 17 | { |
18 | 18 | |
19 | 19 | |
20 | - /** |
|
21 | - * Uses CollectionFilterCallbackIterator on a provided collection with provided Closure for filtering each object |
|
22 | - * in the collection. |
|
23 | - * The closure receives an instance of the object and should return false if it is not "valid" and true if it is. |
|
24 | - * |
|
25 | - * @param Collection $collection |
|
26 | - * @param Closure $acceptance_callback |
|
27 | - * @return array |
|
28 | - */ |
|
29 | - public static function getFilteredObjectsFromCollection(Collection $collection, Closure $acceptance_callback) |
|
30 | - { |
|
31 | - $collection_filter_iterator = new CollectionFilterCallbackIterator($collection, $acceptance_callback); |
|
32 | - return $collection_filter_iterator->getFiltered(); |
|
33 | - } |
|
20 | + /** |
|
21 | + * Uses CollectionFilterCallbackIterator on a provided collection with provided Closure for filtering each object |
|
22 | + * in the collection. |
|
23 | + * The closure receives an instance of the object and should return false if it is not "valid" and true if it is. |
|
24 | + * |
|
25 | + * @param Collection $collection |
|
26 | + * @param Closure $acceptance_callback |
|
27 | + * @return array |
|
28 | + */ |
|
29 | + public static function getFilteredObjectsFromCollection(Collection $collection, Closure $acceptance_callback) |
|
30 | + { |
|
31 | + $collection_filter_iterator = new CollectionFilterCallbackIterator($collection, $acceptance_callback); |
|
32 | + return $collection_filter_iterator->getFiltered(); |
|
33 | + } |
|
34 | 34 | } |
35 | 35 | \ No newline at end of file |
@@ -1,6 +1,6 @@ discard block |
||
1 | 1 | <?php |
2 | 2 | if (! defined('EVENT_ESPRESSO_VERSION')) { |
3 | - exit('No direct script access allowed'); |
|
3 | + exit('No direct script access allowed'); |
|
4 | 4 | } |
5 | 5 | |
6 | 6 | |
@@ -25,592 +25,592 @@ discard block |
||
25 | 25 | class EEG_Paypal_Pro extends EE_Onsite_Gateway |
26 | 26 | { |
27 | 27 | |
28 | - /** |
|
29 | - * @var $_paypal_api_username string |
|
30 | - */ |
|
31 | - protected $_username = null; |
|
32 | - |
|
33 | - /** |
|
34 | - * @var $_password string |
|
35 | - */ |
|
36 | - protected $_password = null; |
|
37 | - |
|
38 | - /** |
|
39 | - * @var $_signature string |
|
40 | - */ |
|
41 | - protected $_signature = null; |
|
42 | - |
|
43 | - /** |
|
44 | - * @var $_credit_card_types array with the keys for credit card types accepted on this account |
|
45 | - */ |
|
46 | - protected $_credit_card_types = null; |
|
47 | - |
|
48 | - protected $_currencies_supported = array( |
|
49 | - 'USD', |
|
50 | - 'GBP', |
|
51 | - 'CAD', |
|
52 | - 'AUD', |
|
53 | - 'BRL', |
|
54 | - 'CHF', |
|
55 | - 'CZK', |
|
56 | - 'DKK', |
|
57 | - 'EUR', |
|
58 | - 'HKD', |
|
59 | - 'HUF', |
|
60 | - 'ILS', |
|
61 | - 'JPY', |
|
62 | - 'MXN', |
|
63 | - 'MYR', |
|
64 | - 'NOK', |
|
65 | - 'NZD', |
|
66 | - 'PHP', |
|
67 | - 'PLN', |
|
68 | - 'SEK', |
|
69 | - 'SGD', |
|
70 | - 'THB', |
|
71 | - 'TRY', |
|
72 | - 'TWD', |
|
73 | - 'RUB', |
|
74 | - ); |
|
75 | - |
|
76 | - |
|
77 | - |
|
78 | - /** |
|
79 | - * @param EEI_Payment $payment |
|
80 | - * @param array $billing_info { |
|
81 | - * @type string $credit_card |
|
82 | - * @type string $credit_card_type |
|
83 | - * @type string $exp_month always 2 characters |
|
84 | - * @type string $exp_year always 4 characters |
|
85 | - * @type string $cvv |
|
86 | - * } |
|
87 | - * @see parent::do_direct_payment for more info |
|
88 | - * @return EE_Payment|EEI_Payment |
|
89 | - * @throws EE_Error |
|
90 | - */ |
|
91 | - public function do_direct_payment($payment, $billing_info = null) |
|
92 | - { |
|
93 | - $transaction = $payment->transaction(); |
|
94 | - if (! $transaction instanceof EEI_Transaction) { |
|
95 | - throw new EE_Error( |
|
96 | - esc_html__('No transaction for payment while paying with PayPal Pro.', 'event_espresso') |
|
97 | - ); |
|
98 | - } |
|
99 | - $primary_registrant = $transaction->primary_registration(); |
|
100 | - if (! $primary_registrant instanceof EEI_Registration) { |
|
101 | - throw new EE_Error( |
|
102 | - esc_html__( |
|
103 | - 'No primary registration on transaction while paying with PayPal Pro.', |
|
104 | - 'event_espresso' |
|
105 | - ) |
|
106 | - ); |
|
107 | - } |
|
108 | - $attendee = $primary_registrant->attendee(); |
|
109 | - if (! $attendee instanceof EEI_Attendee) { |
|
110 | - throw new EE_Error( |
|
111 | - esc_html__( |
|
112 | - 'No attendee on primary registration while paying with PayPal Pro.', |
|
113 | - 'event_espresso' |
|
114 | - ) |
|
115 | - ); |
|
116 | - } |
|
117 | - $gateway_formatter = $this->_get_gateway_formatter(); |
|
118 | - $order_description = substr($gateway_formatter->formatOrderDescription($payment), 0, 127); |
|
119 | - //charge for the full amount. Show itemized list |
|
120 | - if ($this->_can_easily_itemize_transaction_for($payment)) { |
|
121 | - $item_num = 1; |
|
122 | - $total_line_item = $transaction->total_line_item(); |
|
123 | - $order_items = array(); |
|
124 | - foreach ($total_line_item->get_items() as $line_item) { |
|
125 | - //ignore line items with a quantity of 0 |
|
126 | - if ($line_item->quantity() == 0) { |
|
127 | - continue; |
|
128 | - } |
|
129 | - $item = array( |
|
130 | - // Item Name. 127 char max. |
|
131 | - 'l_name' => substr( |
|
132 | - $gateway_formatter->formatLineItemName($line_item, $payment), |
|
133 | - 0, |
|
134 | - 127 |
|
135 | - ), |
|
136 | - // Item description. 127 char max. |
|
137 | - 'l_desc' => substr( |
|
138 | - $gateway_formatter->formatLineItemDesc($line_item, $payment), |
|
139 | - 0, |
|
140 | - 127 |
|
141 | - ), |
|
142 | - // Cost of individual item. |
|
143 | - 'l_amt' => $line_item->unit_price(), |
|
144 | - // Item Number. 127 char max. |
|
145 | - 'l_number' => $item_num++, |
|
146 | - // Item quantity. Must be any positive integer. |
|
147 | - 'l_qty' => $line_item->quantity(), |
|
148 | - // Item's sales tax amount. |
|
149 | - 'l_taxamt' => '', |
|
150 | - // eBay auction number of item. |
|
151 | - 'l_ebayitemnumber' => '', |
|
152 | - // eBay transaction ID of purchased item. |
|
153 | - 'l_ebayitemauctiontxnid' => '', |
|
154 | - // eBay order ID for the item. |
|
155 | - 'l_ebayitemorderid' => '', |
|
156 | - ); |
|
157 | - // add to array of all items |
|
158 | - array_push($order_items, $item); |
|
159 | - } |
|
160 | - $item_amount = $total_line_item->get_items_total(); |
|
161 | - $tax_amount = $total_line_item->get_total_tax(); |
|
162 | - } else { |
|
163 | - $order_items = array(); |
|
164 | - $item_amount = $payment->amount(); |
|
165 | - $tax_amount = 0; |
|
166 | - array_push($order_items, array( |
|
167 | - // Item Name. 127 char max. |
|
168 | - 'l_name' => substr( |
|
169 | - $gateway_formatter->formatPartialPaymentLineItemName($payment), |
|
170 | - 0, |
|
171 | - 127 |
|
172 | - ), |
|
173 | - // Item description. 127 char max. |
|
174 | - 'l_desc' => substr( |
|
175 | - $gateway_formatter->formatPartialPaymentLineItemDesc($payment), |
|
176 | - 0, |
|
177 | - 127 |
|
178 | - ), |
|
179 | - // Cost of individual item. |
|
180 | - 'l_amt' => $payment->amount(), |
|
181 | - // Item Number. 127 char max. |
|
182 | - 'l_number' => 1, |
|
183 | - // Item quantity. Must be any positive integer. |
|
184 | - 'l_qty' => 1, |
|
185 | - )); |
|
186 | - } |
|
187 | - // Populate data arrays with order data. |
|
188 | - $DPFields = array( |
|
189 | - // How you want to obtain payment ? |
|
190 | - // Authorization indicates the payment is a basic auth subject to settlement with Auth & Capture. |
|
191 | - // Sale indicates that this is a final sale for which you are requesting payment. Default is Sale. |
|
192 | - 'paymentaction' => 'Sale', |
|
193 | - // Required. IP address of the payer's browser. |
|
194 | - 'ipaddress' => $_SERVER['REMOTE_ADDR'], |
|
195 | - // Flag to determine whether you want the results returned by FMF. 1 or 0. Default is 0. |
|
196 | - 'returnfmfdetails' => '1', |
|
197 | - ); |
|
198 | - $CCDetails = array( |
|
199 | - // Required. Type of credit card. Visa, MasterCard, Discover, Amex, Maestro, Solo. |
|
200 | - // If Maestro or Solo, the currency code must be GBP. |
|
201 | - // In addition, either start date or issue number must be specified. |
|
202 | - 'creditcardtype' => $billing_info['credit_card_type'], |
|
203 | - // Required. Credit card number. No spaces or punctuation. |
|
204 | - 'acct' => $billing_info['credit_card'], |
|
205 | - // Required. Credit card expiration date. Format is MMYYYY |
|
206 | - 'expdate' => $billing_info['exp_month'] . $billing_info['exp_year'], |
|
207 | - // Requirements determined by your PayPal account settings. Security digits for credit card. |
|
208 | - 'cvv2' => $billing_info['cvv'], |
|
209 | - ); |
|
210 | - $PayerInfo = array( |
|
211 | - // Email address of payer. |
|
212 | - 'email' => $billing_info['email'], |
|
213 | - // Unique PayPal customer ID for payer. |
|
214 | - 'payerid' => '', |
|
215 | - // Status of payer. Values are verified or unverified |
|
216 | - 'payerstatus' => '', |
|
217 | - // Payer's business name. |
|
218 | - 'business' => '', |
|
219 | - ); |
|
220 | - $PayerName = array( |
|
221 | - // Payer's salutation. 20 char max. |
|
222 | - 'salutation' => '', |
|
223 | - // Payer's first name. 25 char max. |
|
224 | - 'firstname' => substr($billing_info['first_name'], 0, 25), |
|
225 | - // Payer's middle name. 25 char max. |
|
226 | - 'middlename' => '', |
|
227 | - // Payer's last name. 25 char max. |
|
228 | - 'lastname' => substr($billing_info['last_name'], 0, 25), |
|
229 | - // Payer's suffix. 12 char max. |
|
230 | - 'suffix' => '', |
|
231 | - ); |
|
232 | - $BillingAddress = array( |
|
233 | - // Required. First street address. |
|
234 | - 'street' => $billing_info['address'], |
|
235 | - // Second street address. |
|
236 | - 'street2' => $billing_info['address2'], |
|
237 | - // Required. Name of City. |
|
238 | - 'city' => $billing_info['city'], |
|
239 | - // Required. Name of State or Province. |
|
240 | - 'state' => substr($billing_info['state'], 0, 40), |
|
241 | - // Required. Country code. |
|
242 | - 'countrycode' => $billing_info['country'], |
|
243 | - // Required. Postal code of payer. |
|
244 | - 'zip' => $billing_info['zip'], |
|
245 | - ); |
|
246 | - //check if the registration info contains the needed fields for paypal pro |
|
247 | - //(see https://developer.paypal.com/docs/classic/api/merchant/DoDirectPayment_API_Operation_NVP/) |
|
248 | - if ($attendee->address() && $attendee->city() && $attendee->country_ID()) { |
|
249 | - $use_registration_address_info = true; |
|
250 | - } else { |
|
251 | - $use_registration_address_info = false; |
|
252 | - } |
|
253 | - //so if the attendee has enough data to fill out PayPal Pro's shipping info, use it. |
|
254 | - // If not, use the billing info again |
|
255 | - $ShippingAddress = array( |
|
256 | - 'shiptoname' => substr($use_registration_address_info |
|
257 | - ? $attendee->full_name() |
|
258 | - : $billing_info['first_name'] . ' ' . $billing_info['last_name'], 0, 32), |
|
259 | - 'shiptostreet' => substr($use_registration_address_info |
|
260 | - ? $attendee->address() |
|
261 | - : $billing_info['address'], 0, 100), |
|
262 | - 'shiptostreet2' => substr($use_registration_address_info |
|
263 | - ? $attendee->address2() : $billing_info['address2'], 0, 100), |
|
264 | - 'shiptocity' => substr($use_registration_address_info |
|
265 | - ? $attendee->city() |
|
266 | - : $billing_info['city'], 0, 40), |
|
267 | - 'state' => substr($use_registration_address_info |
|
268 | - ? $attendee->state_name() |
|
269 | - : $billing_info['state'], 0, 40), |
|
270 | - 'shiptocountry' => $use_registration_address_info |
|
271 | - ? $attendee->country_ID() |
|
272 | - : $billing_info['country'], |
|
273 | - 'shiptozip' => substr($use_registration_address_info |
|
274 | - ? $attendee->zip() |
|
275 | - : $billing_info['zip'], 0, 20), |
|
276 | - 'shiptophonenum' => substr($use_registration_address_info |
|
277 | - ? $attendee->phone() |
|
278 | - : $billing_info['phone'], 0, 20), |
|
279 | - ); |
|
280 | - $PaymentDetails = array( |
|
281 | - // Required. Total amount of order, including shipping, handling, and tax. |
|
282 | - 'amt' => $gateway_formatter->formatCurrency($payment->amount()), |
|
283 | - // Required. Three-letter currency code. Default is USD. |
|
284 | - 'currencycode' => $payment->currency_code(), |
|
285 | - // Required if you include itemized cart details. (L_AMTn, etc.) |
|
286 | - //Subtotal of items not including S&H, or tax. |
|
287 | - 'itemamt' => $gateway_formatter->formatCurrency($item_amount),// |
|
288 | - // Total shipping costs for the order. If you specify shippingamt, you must also specify itemamt. |
|
289 | - 'shippingamt' => '', |
|
290 | - // Total handling costs for the order. If you specify handlingamt, you must also specify itemamt. |
|
291 | - 'handlingamt' => '', |
|
292 | - // Required if you specify itemized cart tax details. |
|
293 | - // Sum of tax for all items on the order. Total sales tax. |
|
294 | - 'taxamt' => $gateway_formatter->formatCurrency($tax_amount), |
|
295 | - // Description of the order the customer is purchasing. 127 char max. |
|
296 | - 'desc' => $order_description, |
|
297 | - // Free-form field for your own use. 256 char max. |
|
298 | - 'custom' => $primary_registrant ? $primary_registrant->ID() : '', |
|
299 | - // Your own invoice or tracking number |
|
300 | - 'invnum' => wp_generate_password(12, false),//$transaction->ID(), |
|
301 | - // URL for receiving Instant Payment Notifications. This overrides what your profile is set to use. |
|
302 | - 'notifyurl' => '', |
|
303 | - 'buttonsource' => 'EventEspresso_SP',//EE will blow up if you change this |
|
304 | - ); |
|
305 | - // Wrap all data arrays into a single, "master" array which will be passed into the class function. |
|
306 | - $PayPalRequestData = array( |
|
307 | - 'DPFields' => $DPFields, |
|
308 | - 'CCDetails' => $CCDetails, |
|
309 | - 'PayerInfo' => $PayerInfo, |
|
310 | - 'PayerName' => $PayerName, |
|
311 | - 'BillingAddress' => $BillingAddress, |
|
312 | - 'ShippingAddress' => $ShippingAddress, |
|
313 | - 'PaymentDetails' => $PaymentDetails, |
|
314 | - 'OrderItems' => $order_items, |
|
315 | - ); |
|
316 | - $this->_log_clean_request($PayPalRequestData, $payment); |
|
317 | - try { |
|
318 | - $PayPalResult = $this->prep_and_curl_request($PayPalRequestData); |
|
319 | - //remove PCI-sensitive data so it doesn't get stored |
|
320 | - $PayPalResult = $this->_log_clean_response($PayPalResult, $payment); |
|
321 | - $message = isset($PayPalResult['L_LONGMESSAGE0']) ? $PayPalResult['L_LONGMESSAGE0'] : $PayPalResult['ACK']; |
|
322 | - if (empty($PayPalResult['RAWRESPONSE'])) { |
|
323 | - $payment->set_status($this->_pay_model->failed_status()); |
|
324 | - $payment->set_gateway_response(__('No response received from Paypal Pro', 'event_espresso')); |
|
325 | - $payment->set_details($PayPalResult); |
|
326 | - } else { |
|
327 | - if ($this->_APICallSuccessful($PayPalResult)) { |
|
328 | - $payment->set_status($this->_pay_model->approved_status()); |
|
329 | - } else { |
|
330 | - $payment->set_status($this->_pay_model->declined_status()); |
|
331 | - } |
|
332 | - //make sure we interpret the AMT as a float, not an international string |
|
333 | - // (where periods are thousand separators) |
|
334 | - $payment->set_amount(isset($PayPalResult['AMT']) ? floatval($PayPalResult['AMT']) : 0); |
|
335 | - $payment->set_gateway_response($message); |
|
336 | - $payment->set_txn_id_chq_nmbr(isset($PayPalResult['TRANSACTIONID']) |
|
337 | - ? $PayPalResult['TRANSACTIONID'] |
|
338 | - : null); |
|
339 | - $primary_registration_code = $primary_registrant instanceof EE_Registration |
|
340 | - ? $primary_registrant->reg_code() |
|
341 | - : ''; |
|
342 | - $payment->set_extra_accntng($primary_registration_code); |
|
343 | - $payment->set_details($PayPalResult); |
|
344 | - } |
|
345 | - } catch (Exception $e) { |
|
346 | - $payment->set_status($this->_pay_model->failed_status()); |
|
347 | - $payment->set_gateway_response($e->getMessage()); |
|
348 | - } |
|
349 | - //$payment->set_status( $this->_pay_model->declined_status() ); |
|
350 | - //$payment->set_gateway_response( '' ); |
|
351 | - return $payment; |
|
352 | - } |
|
353 | - |
|
354 | - |
|
355 | - |
|
356 | - /** |
|
357 | - * CLeans out sensitive CC data and then logs it, and returns the cleaned request |
|
358 | - * |
|
359 | - * @param array $request |
|
360 | - * @param EEI_Payment $payment |
|
361 | - * @return void |
|
362 | - */ |
|
363 | - private function _log_clean_request($request, $payment) |
|
364 | - { |
|
365 | - $cleaned_request_data = $request; |
|
366 | - unset($cleaned_request_data['CCDetails']['acct']); |
|
367 | - unset($cleaned_request_data['CCDetails']['cvv2']); |
|
368 | - unset($cleaned_request_data['CCDetails']['expdate']); |
|
369 | - $this->log(array('Paypal Request' => $cleaned_request_data), $payment); |
|
370 | - } |
|
371 | - |
|
372 | - |
|
373 | - |
|
374 | - /** |
|
375 | - * Cleans the response, logs it, and returns it |
|
376 | - * |
|
377 | - * @param array $response |
|
378 | - * @param EEI_Payment $payment |
|
379 | - * @return array cleaned |
|
380 | - */ |
|
381 | - private function _log_clean_response($response, $payment) |
|
382 | - { |
|
383 | - unset($response['REQUESTDATA']['CREDITCARDTYPE']); |
|
384 | - unset($response['REQUESTDATA']['ACCT']); |
|
385 | - unset($response['REQUESTDATA']['EXPDATE']); |
|
386 | - unset($response['REQUESTDATA']['CVV2']); |
|
387 | - unset($response['RAWREQUEST']); |
|
388 | - $this->log(array('Paypal Response' => $response), $payment); |
|
389 | - return $response; |
|
390 | - } |
|
391 | - |
|
392 | - |
|
393 | - |
|
394 | - /** |
|
395 | - * @param $DataArray |
|
396 | - * @return array |
|
397 | - */ |
|
398 | - private function prep_and_curl_request($DataArray) |
|
399 | - { |
|
400 | - // Create empty holders for each portion of the NVP string |
|
401 | - $DPFieldsNVP = '&METHOD=DoDirectPayment&BUTTONSOURCE=AngellEYE_PHP_Class_DDP'; |
|
402 | - $CCDetailsNVP = ''; |
|
403 | - $PayerInfoNVP = ''; |
|
404 | - $PayerNameNVP = ''; |
|
405 | - $BillingAddressNVP = ''; |
|
406 | - $ShippingAddressNVP = ''; |
|
407 | - $PaymentDetailsNVP = ''; |
|
408 | - $OrderItemsNVP = ''; |
|
409 | - $Secure3DNVP = ''; |
|
410 | - // DP Fields |
|
411 | - $DPFields = isset($DataArray['DPFields']) ? $DataArray['DPFields'] : array(); |
|
412 | - foreach ($DPFields as $DPFieldsVar => $DPFieldsVal) { |
|
413 | - $DPFieldsNVP .= '&' . strtoupper($DPFieldsVar) . '=' . urlencode($DPFieldsVal); |
|
414 | - } |
|
415 | - // CC Details Fields |
|
416 | - $CCDetails = isset($DataArray['CCDetails']) ? $DataArray['CCDetails'] : array(); |
|
417 | - foreach ($CCDetails as $CCDetailsVar => $CCDetailsVal) { |
|
418 | - $CCDetailsNVP .= '&' . strtoupper($CCDetailsVar) . '=' . urlencode($CCDetailsVal); |
|
419 | - } |
|
420 | - // PayerInfo Type Fields |
|
421 | - $PayerInfo = isset($DataArray['PayerInfo']) ? $DataArray['PayerInfo'] : array(); |
|
422 | - foreach ($PayerInfo as $PayerInfoVar => $PayerInfoVal) { |
|
423 | - $PayerInfoNVP .= '&' . strtoupper($PayerInfoVar) . '=' . urlencode($PayerInfoVal); |
|
424 | - } |
|
425 | - // Payer Name Fields |
|
426 | - $PayerName = isset($DataArray['PayerName']) ? $DataArray['PayerName'] : array(); |
|
427 | - foreach ($PayerName as $PayerNameVar => $PayerNameVal) { |
|
428 | - $PayerNameNVP .= '&' . strtoupper($PayerNameVar) . '=' . urlencode($PayerNameVal); |
|
429 | - } |
|
430 | - // Address Fields (Billing) |
|
431 | - $BillingAddress = isset($DataArray['BillingAddress']) ? $DataArray['BillingAddress'] : array(); |
|
432 | - foreach ($BillingAddress as $BillingAddressVar => $BillingAddressVal) { |
|
433 | - $BillingAddressNVP .= '&' . strtoupper($BillingAddressVar) . '=' . urlencode($BillingAddressVal); |
|
434 | - } |
|
435 | - // Payment Details Type Fields |
|
436 | - $PaymentDetails = isset($DataArray['PaymentDetails']) ? $DataArray['PaymentDetails'] : array(); |
|
437 | - foreach ($PaymentDetails as $PaymentDetailsVar => $PaymentDetailsVal) { |
|
438 | - $PaymentDetailsNVP .= '&' . strtoupper($PaymentDetailsVar) . '=' . urlencode($PaymentDetailsVal); |
|
439 | - } |
|
440 | - // Payment Details Item Type Fields |
|
441 | - $OrderItems = isset($DataArray['OrderItems']) ? $DataArray['OrderItems'] : array(); |
|
442 | - $n = 0; |
|
443 | - foreach ($OrderItems as $OrderItemsVar => $OrderItemsVal) { |
|
444 | - $CurrentItem = $OrderItems[$OrderItemsVar]; |
|
445 | - foreach ($CurrentItem as $CurrentItemVar => $CurrentItemVal) { |
|
446 | - $OrderItemsNVP .= '&' . strtoupper($CurrentItemVar) . $n . '=' . urlencode($CurrentItemVal); |
|
447 | - } |
|
448 | - $n++; |
|
449 | - } |
|
450 | - // Ship To Address Fields |
|
451 | - $ShippingAddress = isset($DataArray['ShippingAddress']) ? $DataArray['ShippingAddress'] : array(); |
|
452 | - foreach ($ShippingAddress as $ShippingAddressVar => $ShippingAddressVal) { |
|
453 | - $ShippingAddressNVP .= '&' . strtoupper($ShippingAddressVar) . '=' . urlencode($ShippingAddressVal); |
|
454 | - } |
|
455 | - // 3D Secure Fields |
|
456 | - $Secure3D = isset($DataArray['Secure3D']) ? $DataArray['Secure3D'] : array(); |
|
457 | - foreach ($Secure3D as $Secure3DVar => $Secure3DVal) { |
|
458 | - $Secure3DNVP .= '&' . strtoupper($Secure3DVar) . '=' . urlencode($Secure3DVal); |
|
459 | - } |
|
460 | - // Now that we have each chunk we need to go ahead and append them all together for our entire NVP string |
|
461 | - $NVPRequest = 'USER=' |
|
462 | - . $this->_username |
|
463 | - . '&PWD=' |
|
464 | - . $this->_password |
|
465 | - . '&VERSION=64.0' |
|
466 | - . '&SIGNATURE=' |
|
467 | - . $this->_signature |
|
468 | - . $DPFieldsNVP |
|
469 | - . $CCDetailsNVP |
|
470 | - . $PayerInfoNVP |
|
471 | - . $PayerNameNVP |
|
472 | - . $BillingAddressNVP |
|
473 | - . $PaymentDetailsNVP |
|
474 | - . $OrderItemsNVP |
|
475 | - . $ShippingAddressNVP |
|
476 | - . $Secure3DNVP; |
|
477 | - $NVPResponse = $this->_CURLRequest($NVPRequest); |
|
478 | - $NVPRequestArray = $this->_NVPToArray($NVPRequest); |
|
479 | - $NVPResponseArray = $this->_NVPToArray($NVPResponse); |
|
480 | - $Errors = $this->_GetErrors($NVPResponseArray); |
|
481 | - $NVPResponseArray['ERRORS'] = $Errors; |
|
482 | - $NVPResponseArray['REQUESTDATA'] = $NVPRequestArray; |
|
483 | - $NVPResponseArray['RAWREQUEST'] = $NVPRequest; |
|
484 | - $NVPResponseArray['RAWRESPONSE'] = $NVPResponse; |
|
485 | - return $NVPResponseArray; |
|
486 | - } |
|
487 | - |
|
488 | - |
|
489 | - |
|
490 | - /** |
|
491 | - * @param $Request |
|
492 | - * @return mixed |
|
493 | - */ |
|
494 | - private function _CURLRequest($Request) |
|
495 | - { |
|
496 | - $EndPointURL = $this->_debug_mode ? 'https://api-3t.sandbox.paypal.com/nvp' : 'https://api-3t.paypal.com/nvp'; |
|
497 | - $curl = curl_init(); |
|
498 | - curl_setopt($curl, CURLOPT_VERBOSE, apply_filters('FHEE__EEG_Paypal_Pro__CurlRequest__CURLOPT_VERBOSE', true)); |
|
499 | - curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false); |
|
500 | - curl_setopt($curl, CURLOPT_TIMEOUT, 60); |
|
501 | - curl_setopt($curl, CURLOPT_URL, $EndPointURL); |
|
502 | - curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1); |
|
503 | - curl_setopt($curl, CURLOPT_POSTFIELDS, $Request); |
|
504 | - curl_setopt($curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1); |
|
505 | - //execute the curl POST |
|
506 | - $Response = curl_exec($curl); |
|
507 | - curl_close($curl); |
|
508 | - return $Response; |
|
509 | - } |
|
510 | - |
|
511 | - |
|
512 | - |
|
513 | - /** |
|
514 | - * @param $NVPString |
|
515 | - * @return array |
|
516 | - */ |
|
517 | - private function _NVPToArray($NVPString) |
|
518 | - { |
|
519 | - // prepare responses into array |
|
520 | - $proArray = array(); |
|
521 | - while (strlen($NVPString)) { |
|
522 | - // name |
|
523 | - $keypos = strpos($NVPString, '='); |
|
524 | - $keyval = substr($NVPString, 0, $keypos); |
|
525 | - // value |
|
526 | - $valuepos = strpos($NVPString, '&') ? strpos($NVPString, '&') : strlen($NVPString); |
|
527 | - $valval = substr($NVPString, $keypos + 1, $valuepos - $keypos - 1); |
|
528 | - // decoding the response |
|
529 | - $proArray[$keyval] = urldecode($valval); |
|
530 | - $NVPString = substr($NVPString, $valuepos + 1, strlen($NVPString)); |
|
531 | - } |
|
532 | - return $proArray; |
|
533 | - } |
|
534 | - |
|
535 | - |
|
536 | - |
|
537 | - /** |
|
538 | - * @param array $PayPalResult |
|
539 | - * @return bool |
|
540 | - */ |
|
541 | - private function _APICallSuccessful($PayPalResult) |
|
542 | - { |
|
543 | - $approved = false; |
|
544 | - // check main response message from PayPal |
|
545 | - if (isset($PayPalResult['ACK']) && ! empty($PayPalResult['ACK'])) { |
|
546 | - $ack = strtoupper($PayPalResult['ACK']); |
|
547 | - $approved = ($ack == 'SUCCESS' || $ack == 'SUCCESSWITHWARNING' || $ack == 'PARTIALSUCCESS') ? true : false; |
|
548 | - } |
|
549 | - return $approved; |
|
550 | - } |
|
551 | - |
|
552 | - |
|
553 | - |
|
554 | - /** |
|
555 | - * @param $DataArray |
|
556 | - * @return array |
|
557 | - */ |
|
558 | - private function _GetErrors($DataArray) |
|
559 | - { |
|
560 | - $Errors = array(); |
|
561 | - $n = 0; |
|
562 | - while (isset($DataArray['L_ERRORCODE' . $n . ''])) { |
|
563 | - $LErrorCode = isset($DataArray['L_ERRORCODE' . $n . '']) ? $DataArray['L_ERRORCODE' . $n . ''] : ''; |
|
564 | - $LShortMessage = isset($DataArray['L_SHORTMESSAGE' . $n . '']) |
|
565 | - ? $DataArray['L_SHORTMESSAGE' . $n . ''] |
|
566 | - : ''; |
|
567 | - $LLongMessage = isset($DataArray['L_LONGMESSAGE' . $n . '']) |
|
568 | - ? $DataArray['L_LONGMESSAGE' . $n . ''] |
|
569 | - : ''; |
|
570 | - $LSeverityCode = isset($DataArray['L_SEVERITYCODE' . $n . '']) |
|
571 | - ? $DataArray['L_SEVERITYCODE' . $n . ''] |
|
572 | - : ''; |
|
573 | - $CurrentItem = array( |
|
574 | - 'L_ERRORCODE' => $LErrorCode, |
|
575 | - 'L_SHORTMESSAGE' => $LShortMessage, |
|
576 | - 'L_LONGMESSAGE' => $LLongMessage, |
|
577 | - 'L_SEVERITYCODE' => $LSeverityCode, |
|
578 | - ); |
|
579 | - array_push($Errors, $CurrentItem); |
|
580 | - $n++; |
|
581 | - } |
|
582 | - return $Errors; |
|
583 | - } |
|
584 | - |
|
585 | - |
|
586 | - |
|
587 | - /** |
|
588 | - * nothing to see here... move along.... |
|
589 | - * |
|
590 | - * @access protected |
|
591 | - * @param $Errors |
|
592 | - * @return string |
|
593 | - */ |
|
594 | - private function _DisplayErrors($Errors) |
|
595 | - { |
|
596 | - $error = ''; |
|
597 | - foreach ($Errors as $ErrorVar => $ErrorVal) { |
|
598 | - $CurrentError = $Errors[$ErrorVar]; |
|
599 | - foreach ($CurrentError as $CurrentErrorVar => $CurrentErrorVal) { |
|
600 | - $CurrentVarName = ''; |
|
601 | - if ($CurrentErrorVar == 'L_ERRORCODE') { |
|
602 | - $CurrentVarName = 'Error Code'; |
|
603 | - } elseif ($CurrentErrorVar == 'L_SHORTMESSAGE') { |
|
604 | - $CurrentVarName = 'Short Message'; |
|
605 | - } elseif ($CurrentErrorVar == 'L_LONGMESSAGE') { |
|
606 | - $CurrentVarName = 'Long Message'; |
|
607 | - } elseif ($CurrentErrorVar == 'L_SEVERITYCODE') { |
|
608 | - $CurrentVarName = 'Severity Code'; |
|
609 | - } |
|
610 | - $error .= '<br />' . $CurrentVarName . ': ' . $CurrentErrorVal; |
|
611 | - } |
|
612 | - } |
|
613 | - return $error; |
|
614 | - } |
|
28 | + /** |
|
29 | + * @var $_paypal_api_username string |
|
30 | + */ |
|
31 | + protected $_username = null; |
|
32 | + |
|
33 | + /** |
|
34 | + * @var $_password string |
|
35 | + */ |
|
36 | + protected $_password = null; |
|
37 | + |
|
38 | + /** |
|
39 | + * @var $_signature string |
|
40 | + */ |
|
41 | + protected $_signature = null; |
|
42 | + |
|
43 | + /** |
|
44 | + * @var $_credit_card_types array with the keys for credit card types accepted on this account |
|
45 | + */ |
|
46 | + protected $_credit_card_types = null; |
|
47 | + |
|
48 | + protected $_currencies_supported = array( |
|
49 | + 'USD', |
|
50 | + 'GBP', |
|
51 | + 'CAD', |
|
52 | + 'AUD', |
|
53 | + 'BRL', |
|
54 | + 'CHF', |
|
55 | + 'CZK', |
|
56 | + 'DKK', |
|
57 | + 'EUR', |
|
58 | + 'HKD', |
|
59 | + 'HUF', |
|
60 | + 'ILS', |
|
61 | + 'JPY', |
|
62 | + 'MXN', |
|
63 | + 'MYR', |
|
64 | + 'NOK', |
|
65 | + 'NZD', |
|
66 | + 'PHP', |
|
67 | + 'PLN', |
|
68 | + 'SEK', |
|
69 | + 'SGD', |
|
70 | + 'THB', |
|
71 | + 'TRY', |
|
72 | + 'TWD', |
|
73 | + 'RUB', |
|
74 | + ); |
|
75 | + |
|
76 | + |
|
77 | + |
|
78 | + /** |
|
79 | + * @param EEI_Payment $payment |
|
80 | + * @param array $billing_info { |
|
81 | + * @type string $credit_card |
|
82 | + * @type string $credit_card_type |
|
83 | + * @type string $exp_month always 2 characters |
|
84 | + * @type string $exp_year always 4 characters |
|
85 | + * @type string $cvv |
|
86 | + * } |
|
87 | + * @see parent::do_direct_payment for more info |
|
88 | + * @return EE_Payment|EEI_Payment |
|
89 | + * @throws EE_Error |
|
90 | + */ |
|
91 | + public function do_direct_payment($payment, $billing_info = null) |
|
92 | + { |
|
93 | + $transaction = $payment->transaction(); |
|
94 | + if (! $transaction instanceof EEI_Transaction) { |
|
95 | + throw new EE_Error( |
|
96 | + esc_html__('No transaction for payment while paying with PayPal Pro.', 'event_espresso') |
|
97 | + ); |
|
98 | + } |
|
99 | + $primary_registrant = $transaction->primary_registration(); |
|
100 | + if (! $primary_registrant instanceof EEI_Registration) { |
|
101 | + throw new EE_Error( |
|
102 | + esc_html__( |
|
103 | + 'No primary registration on transaction while paying with PayPal Pro.', |
|
104 | + 'event_espresso' |
|
105 | + ) |
|
106 | + ); |
|
107 | + } |
|
108 | + $attendee = $primary_registrant->attendee(); |
|
109 | + if (! $attendee instanceof EEI_Attendee) { |
|
110 | + throw new EE_Error( |
|
111 | + esc_html__( |
|
112 | + 'No attendee on primary registration while paying with PayPal Pro.', |
|
113 | + 'event_espresso' |
|
114 | + ) |
|
115 | + ); |
|
116 | + } |
|
117 | + $gateway_formatter = $this->_get_gateway_formatter(); |
|
118 | + $order_description = substr($gateway_formatter->formatOrderDescription($payment), 0, 127); |
|
119 | + //charge for the full amount. Show itemized list |
|
120 | + if ($this->_can_easily_itemize_transaction_for($payment)) { |
|
121 | + $item_num = 1; |
|
122 | + $total_line_item = $transaction->total_line_item(); |
|
123 | + $order_items = array(); |
|
124 | + foreach ($total_line_item->get_items() as $line_item) { |
|
125 | + //ignore line items with a quantity of 0 |
|
126 | + if ($line_item->quantity() == 0) { |
|
127 | + continue; |
|
128 | + } |
|
129 | + $item = array( |
|
130 | + // Item Name. 127 char max. |
|
131 | + 'l_name' => substr( |
|
132 | + $gateway_formatter->formatLineItemName($line_item, $payment), |
|
133 | + 0, |
|
134 | + 127 |
|
135 | + ), |
|
136 | + // Item description. 127 char max. |
|
137 | + 'l_desc' => substr( |
|
138 | + $gateway_formatter->formatLineItemDesc($line_item, $payment), |
|
139 | + 0, |
|
140 | + 127 |
|
141 | + ), |
|
142 | + // Cost of individual item. |
|
143 | + 'l_amt' => $line_item->unit_price(), |
|
144 | + // Item Number. 127 char max. |
|
145 | + 'l_number' => $item_num++, |
|
146 | + // Item quantity. Must be any positive integer. |
|
147 | + 'l_qty' => $line_item->quantity(), |
|
148 | + // Item's sales tax amount. |
|
149 | + 'l_taxamt' => '', |
|
150 | + // eBay auction number of item. |
|
151 | + 'l_ebayitemnumber' => '', |
|
152 | + // eBay transaction ID of purchased item. |
|
153 | + 'l_ebayitemauctiontxnid' => '', |
|
154 | + // eBay order ID for the item. |
|
155 | + 'l_ebayitemorderid' => '', |
|
156 | + ); |
|
157 | + // add to array of all items |
|
158 | + array_push($order_items, $item); |
|
159 | + } |
|
160 | + $item_amount = $total_line_item->get_items_total(); |
|
161 | + $tax_amount = $total_line_item->get_total_tax(); |
|
162 | + } else { |
|
163 | + $order_items = array(); |
|
164 | + $item_amount = $payment->amount(); |
|
165 | + $tax_amount = 0; |
|
166 | + array_push($order_items, array( |
|
167 | + // Item Name. 127 char max. |
|
168 | + 'l_name' => substr( |
|
169 | + $gateway_formatter->formatPartialPaymentLineItemName($payment), |
|
170 | + 0, |
|
171 | + 127 |
|
172 | + ), |
|
173 | + // Item description. 127 char max. |
|
174 | + 'l_desc' => substr( |
|
175 | + $gateway_formatter->formatPartialPaymentLineItemDesc($payment), |
|
176 | + 0, |
|
177 | + 127 |
|
178 | + ), |
|
179 | + // Cost of individual item. |
|
180 | + 'l_amt' => $payment->amount(), |
|
181 | + // Item Number. 127 char max. |
|
182 | + 'l_number' => 1, |
|
183 | + // Item quantity. Must be any positive integer. |
|
184 | + 'l_qty' => 1, |
|
185 | + )); |
|
186 | + } |
|
187 | + // Populate data arrays with order data. |
|
188 | + $DPFields = array( |
|
189 | + // How you want to obtain payment ? |
|
190 | + // Authorization indicates the payment is a basic auth subject to settlement with Auth & Capture. |
|
191 | + // Sale indicates that this is a final sale for which you are requesting payment. Default is Sale. |
|
192 | + 'paymentaction' => 'Sale', |
|
193 | + // Required. IP address of the payer's browser. |
|
194 | + 'ipaddress' => $_SERVER['REMOTE_ADDR'], |
|
195 | + // Flag to determine whether you want the results returned by FMF. 1 or 0. Default is 0. |
|
196 | + 'returnfmfdetails' => '1', |
|
197 | + ); |
|
198 | + $CCDetails = array( |
|
199 | + // Required. Type of credit card. Visa, MasterCard, Discover, Amex, Maestro, Solo. |
|
200 | + // If Maestro or Solo, the currency code must be GBP. |
|
201 | + // In addition, either start date or issue number must be specified. |
|
202 | + 'creditcardtype' => $billing_info['credit_card_type'], |
|
203 | + // Required. Credit card number. No spaces or punctuation. |
|
204 | + 'acct' => $billing_info['credit_card'], |
|
205 | + // Required. Credit card expiration date. Format is MMYYYY |
|
206 | + 'expdate' => $billing_info['exp_month'] . $billing_info['exp_year'], |
|
207 | + // Requirements determined by your PayPal account settings. Security digits for credit card. |
|
208 | + 'cvv2' => $billing_info['cvv'], |
|
209 | + ); |
|
210 | + $PayerInfo = array( |
|
211 | + // Email address of payer. |
|
212 | + 'email' => $billing_info['email'], |
|
213 | + // Unique PayPal customer ID for payer. |
|
214 | + 'payerid' => '', |
|
215 | + // Status of payer. Values are verified or unverified |
|
216 | + 'payerstatus' => '', |
|
217 | + // Payer's business name. |
|
218 | + 'business' => '', |
|
219 | + ); |
|
220 | + $PayerName = array( |
|
221 | + // Payer's salutation. 20 char max. |
|
222 | + 'salutation' => '', |
|
223 | + // Payer's first name. 25 char max. |
|
224 | + 'firstname' => substr($billing_info['first_name'], 0, 25), |
|
225 | + // Payer's middle name. 25 char max. |
|
226 | + 'middlename' => '', |
|
227 | + // Payer's last name. 25 char max. |
|
228 | + 'lastname' => substr($billing_info['last_name'], 0, 25), |
|
229 | + // Payer's suffix. 12 char max. |
|
230 | + 'suffix' => '', |
|
231 | + ); |
|
232 | + $BillingAddress = array( |
|
233 | + // Required. First street address. |
|
234 | + 'street' => $billing_info['address'], |
|
235 | + // Second street address. |
|
236 | + 'street2' => $billing_info['address2'], |
|
237 | + // Required. Name of City. |
|
238 | + 'city' => $billing_info['city'], |
|
239 | + // Required. Name of State or Province. |
|
240 | + 'state' => substr($billing_info['state'], 0, 40), |
|
241 | + // Required. Country code. |
|
242 | + 'countrycode' => $billing_info['country'], |
|
243 | + // Required. Postal code of payer. |
|
244 | + 'zip' => $billing_info['zip'], |
|
245 | + ); |
|
246 | + //check if the registration info contains the needed fields for paypal pro |
|
247 | + //(see https://developer.paypal.com/docs/classic/api/merchant/DoDirectPayment_API_Operation_NVP/) |
|
248 | + if ($attendee->address() && $attendee->city() && $attendee->country_ID()) { |
|
249 | + $use_registration_address_info = true; |
|
250 | + } else { |
|
251 | + $use_registration_address_info = false; |
|
252 | + } |
|
253 | + //so if the attendee has enough data to fill out PayPal Pro's shipping info, use it. |
|
254 | + // If not, use the billing info again |
|
255 | + $ShippingAddress = array( |
|
256 | + 'shiptoname' => substr($use_registration_address_info |
|
257 | + ? $attendee->full_name() |
|
258 | + : $billing_info['first_name'] . ' ' . $billing_info['last_name'], 0, 32), |
|
259 | + 'shiptostreet' => substr($use_registration_address_info |
|
260 | + ? $attendee->address() |
|
261 | + : $billing_info['address'], 0, 100), |
|
262 | + 'shiptostreet2' => substr($use_registration_address_info |
|
263 | + ? $attendee->address2() : $billing_info['address2'], 0, 100), |
|
264 | + 'shiptocity' => substr($use_registration_address_info |
|
265 | + ? $attendee->city() |
|
266 | + : $billing_info['city'], 0, 40), |
|
267 | + 'state' => substr($use_registration_address_info |
|
268 | + ? $attendee->state_name() |
|
269 | + : $billing_info['state'], 0, 40), |
|
270 | + 'shiptocountry' => $use_registration_address_info |
|
271 | + ? $attendee->country_ID() |
|
272 | + : $billing_info['country'], |
|
273 | + 'shiptozip' => substr($use_registration_address_info |
|
274 | + ? $attendee->zip() |
|
275 | + : $billing_info['zip'], 0, 20), |
|
276 | + 'shiptophonenum' => substr($use_registration_address_info |
|
277 | + ? $attendee->phone() |
|
278 | + : $billing_info['phone'], 0, 20), |
|
279 | + ); |
|
280 | + $PaymentDetails = array( |
|
281 | + // Required. Total amount of order, including shipping, handling, and tax. |
|
282 | + 'amt' => $gateway_formatter->formatCurrency($payment->amount()), |
|
283 | + // Required. Three-letter currency code. Default is USD. |
|
284 | + 'currencycode' => $payment->currency_code(), |
|
285 | + // Required if you include itemized cart details. (L_AMTn, etc.) |
|
286 | + //Subtotal of items not including S&H, or tax. |
|
287 | + 'itemamt' => $gateway_formatter->formatCurrency($item_amount),// |
|
288 | + // Total shipping costs for the order. If you specify shippingamt, you must also specify itemamt. |
|
289 | + 'shippingamt' => '', |
|
290 | + // Total handling costs for the order. If you specify handlingamt, you must also specify itemamt. |
|
291 | + 'handlingamt' => '', |
|
292 | + // Required if you specify itemized cart tax details. |
|
293 | + // Sum of tax for all items on the order. Total sales tax. |
|
294 | + 'taxamt' => $gateway_formatter->formatCurrency($tax_amount), |
|
295 | + // Description of the order the customer is purchasing. 127 char max. |
|
296 | + 'desc' => $order_description, |
|
297 | + // Free-form field for your own use. 256 char max. |
|
298 | + 'custom' => $primary_registrant ? $primary_registrant->ID() : '', |
|
299 | + // Your own invoice or tracking number |
|
300 | + 'invnum' => wp_generate_password(12, false),//$transaction->ID(), |
|
301 | + // URL for receiving Instant Payment Notifications. This overrides what your profile is set to use. |
|
302 | + 'notifyurl' => '', |
|
303 | + 'buttonsource' => 'EventEspresso_SP',//EE will blow up if you change this |
|
304 | + ); |
|
305 | + // Wrap all data arrays into a single, "master" array which will be passed into the class function. |
|
306 | + $PayPalRequestData = array( |
|
307 | + 'DPFields' => $DPFields, |
|
308 | + 'CCDetails' => $CCDetails, |
|
309 | + 'PayerInfo' => $PayerInfo, |
|
310 | + 'PayerName' => $PayerName, |
|
311 | + 'BillingAddress' => $BillingAddress, |
|
312 | + 'ShippingAddress' => $ShippingAddress, |
|
313 | + 'PaymentDetails' => $PaymentDetails, |
|
314 | + 'OrderItems' => $order_items, |
|
315 | + ); |
|
316 | + $this->_log_clean_request($PayPalRequestData, $payment); |
|
317 | + try { |
|
318 | + $PayPalResult = $this->prep_and_curl_request($PayPalRequestData); |
|
319 | + //remove PCI-sensitive data so it doesn't get stored |
|
320 | + $PayPalResult = $this->_log_clean_response($PayPalResult, $payment); |
|
321 | + $message = isset($PayPalResult['L_LONGMESSAGE0']) ? $PayPalResult['L_LONGMESSAGE0'] : $PayPalResult['ACK']; |
|
322 | + if (empty($PayPalResult['RAWRESPONSE'])) { |
|
323 | + $payment->set_status($this->_pay_model->failed_status()); |
|
324 | + $payment->set_gateway_response(__('No response received from Paypal Pro', 'event_espresso')); |
|
325 | + $payment->set_details($PayPalResult); |
|
326 | + } else { |
|
327 | + if ($this->_APICallSuccessful($PayPalResult)) { |
|
328 | + $payment->set_status($this->_pay_model->approved_status()); |
|
329 | + } else { |
|
330 | + $payment->set_status($this->_pay_model->declined_status()); |
|
331 | + } |
|
332 | + //make sure we interpret the AMT as a float, not an international string |
|
333 | + // (where periods are thousand separators) |
|
334 | + $payment->set_amount(isset($PayPalResult['AMT']) ? floatval($PayPalResult['AMT']) : 0); |
|
335 | + $payment->set_gateway_response($message); |
|
336 | + $payment->set_txn_id_chq_nmbr(isset($PayPalResult['TRANSACTIONID']) |
|
337 | + ? $PayPalResult['TRANSACTIONID'] |
|
338 | + : null); |
|
339 | + $primary_registration_code = $primary_registrant instanceof EE_Registration |
|
340 | + ? $primary_registrant->reg_code() |
|
341 | + : ''; |
|
342 | + $payment->set_extra_accntng($primary_registration_code); |
|
343 | + $payment->set_details($PayPalResult); |
|
344 | + } |
|
345 | + } catch (Exception $e) { |
|
346 | + $payment->set_status($this->_pay_model->failed_status()); |
|
347 | + $payment->set_gateway_response($e->getMessage()); |
|
348 | + } |
|
349 | + //$payment->set_status( $this->_pay_model->declined_status() ); |
|
350 | + //$payment->set_gateway_response( '' ); |
|
351 | + return $payment; |
|
352 | + } |
|
353 | + |
|
354 | + |
|
355 | + |
|
356 | + /** |
|
357 | + * CLeans out sensitive CC data and then logs it, and returns the cleaned request |
|
358 | + * |
|
359 | + * @param array $request |
|
360 | + * @param EEI_Payment $payment |
|
361 | + * @return void |
|
362 | + */ |
|
363 | + private function _log_clean_request($request, $payment) |
|
364 | + { |
|
365 | + $cleaned_request_data = $request; |
|
366 | + unset($cleaned_request_data['CCDetails']['acct']); |
|
367 | + unset($cleaned_request_data['CCDetails']['cvv2']); |
|
368 | + unset($cleaned_request_data['CCDetails']['expdate']); |
|
369 | + $this->log(array('Paypal Request' => $cleaned_request_data), $payment); |
|
370 | + } |
|
371 | + |
|
372 | + |
|
373 | + |
|
374 | + /** |
|
375 | + * Cleans the response, logs it, and returns it |
|
376 | + * |
|
377 | + * @param array $response |
|
378 | + * @param EEI_Payment $payment |
|
379 | + * @return array cleaned |
|
380 | + */ |
|
381 | + private function _log_clean_response($response, $payment) |
|
382 | + { |
|
383 | + unset($response['REQUESTDATA']['CREDITCARDTYPE']); |
|
384 | + unset($response['REQUESTDATA']['ACCT']); |
|
385 | + unset($response['REQUESTDATA']['EXPDATE']); |
|
386 | + unset($response['REQUESTDATA']['CVV2']); |
|
387 | + unset($response['RAWREQUEST']); |
|
388 | + $this->log(array('Paypal Response' => $response), $payment); |
|
389 | + return $response; |
|
390 | + } |
|
391 | + |
|
392 | + |
|
393 | + |
|
394 | + /** |
|
395 | + * @param $DataArray |
|
396 | + * @return array |
|
397 | + */ |
|
398 | + private function prep_and_curl_request($DataArray) |
|
399 | + { |
|
400 | + // Create empty holders for each portion of the NVP string |
|
401 | + $DPFieldsNVP = '&METHOD=DoDirectPayment&BUTTONSOURCE=AngellEYE_PHP_Class_DDP'; |
|
402 | + $CCDetailsNVP = ''; |
|
403 | + $PayerInfoNVP = ''; |
|
404 | + $PayerNameNVP = ''; |
|
405 | + $BillingAddressNVP = ''; |
|
406 | + $ShippingAddressNVP = ''; |
|
407 | + $PaymentDetailsNVP = ''; |
|
408 | + $OrderItemsNVP = ''; |
|
409 | + $Secure3DNVP = ''; |
|
410 | + // DP Fields |
|
411 | + $DPFields = isset($DataArray['DPFields']) ? $DataArray['DPFields'] : array(); |
|
412 | + foreach ($DPFields as $DPFieldsVar => $DPFieldsVal) { |
|
413 | + $DPFieldsNVP .= '&' . strtoupper($DPFieldsVar) . '=' . urlencode($DPFieldsVal); |
|
414 | + } |
|
415 | + // CC Details Fields |
|
416 | + $CCDetails = isset($DataArray['CCDetails']) ? $DataArray['CCDetails'] : array(); |
|
417 | + foreach ($CCDetails as $CCDetailsVar => $CCDetailsVal) { |
|
418 | + $CCDetailsNVP .= '&' . strtoupper($CCDetailsVar) . '=' . urlencode($CCDetailsVal); |
|
419 | + } |
|
420 | + // PayerInfo Type Fields |
|
421 | + $PayerInfo = isset($DataArray['PayerInfo']) ? $DataArray['PayerInfo'] : array(); |
|
422 | + foreach ($PayerInfo as $PayerInfoVar => $PayerInfoVal) { |
|
423 | + $PayerInfoNVP .= '&' . strtoupper($PayerInfoVar) . '=' . urlencode($PayerInfoVal); |
|
424 | + } |
|
425 | + // Payer Name Fields |
|
426 | + $PayerName = isset($DataArray['PayerName']) ? $DataArray['PayerName'] : array(); |
|
427 | + foreach ($PayerName as $PayerNameVar => $PayerNameVal) { |
|
428 | + $PayerNameNVP .= '&' . strtoupper($PayerNameVar) . '=' . urlencode($PayerNameVal); |
|
429 | + } |
|
430 | + // Address Fields (Billing) |
|
431 | + $BillingAddress = isset($DataArray['BillingAddress']) ? $DataArray['BillingAddress'] : array(); |
|
432 | + foreach ($BillingAddress as $BillingAddressVar => $BillingAddressVal) { |
|
433 | + $BillingAddressNVP .= '&' . strtoupper($BillingAddressVar) . '=' . urlencode($BillingAddressVal); |
|
434 | + } |
|
435 | + // Payment Details Type Fields |
|
436 | + $PaymentDetails = isset($DataArray['PaymentDetails']) ? $DataArray['PaymentDetails'] : array(); |
|
437 | + foreach ($PaymentDetails as $PaymentDetailsVar => $PaymentDetailsVal) { |
|
438 | + $PaymentDetailsNVP .= '&' . strtoupper($PaymentDetailsVar) . '=' . urlencode($PaymentDetailsVal); |
|
439 | + } |
|
440 | + // Payment Details Item Type Fields |
|
441 | + $OrderItems = isset($DataArray['OrderItems']) ? $DataArray['OrderItems'] : array(); |
|
442 | + $n = 0; |
|
443 | + foreach ($OrderItems as $OrderItemsVar => $OrderItemsVal) { |
|
444 | + $CurrentItem = $OrderItems[$OrderItemsVar]; |
|
445 | + foreach ($CurrentItem as $CurrentItemVar => $CurrentItemVal) { |
|
446 | + $OrderItemsNVP .= '&' . strtoupper($CurrentItemVar) . $n . '=' . urlencode($CurrentItemVal); |
|
447 | + } |
|
448 | + $n++; |
|
449 | + } |
|
450 | + // Ship To Address Fields |
|
451 | + $ShippingAddress = isset($DataArray['ShippingAddress']) ? $DataArray['ShippingAddress'] : array(); |
|
452 | + foreach ($ShippingAddress as $ShippingAddressVar => $ShippingAddressVal) { |
|
453 | + $ShippingAddressNVP .= '&' . strtoupper($ShippingAddressVar) . '=' . urlencode($ShippingAddressVal); |
|
454 | + } |
|
455 | + // 3D Secure Fields |
|
456 | + $Secure3D = isset($DataArray['Secure3D']) ? $DataArray['Secure3D'] : array(); |
|
457 | + foreach ($Secure3D as $Secure3DVar => $Secure3DVal) { |
|
458 | + $Secure3DNVP .= '&' . strtoupper($Secure3DVar) . '=' . urlencode($Secure3DVal); |
|
459 | + } |
|
460 | + // Now that we have each chunk we need to go ahead and append them all together for our entire NVP string |
|
461 | + $NVPRequest = 'USER=' |
|
462 | + . $this->_username |
|
463 | + . '&PWD=' |
|
464 | + . $this->_password |
|
465 | + . '&VERSION=64.0' |
|
466 | + . '&SIGNATURE=' |
|
467 | + . $this->_signature |
|
468 | + . $DPFieldsNVP |
|
469 | + . $CCDetailsNVP |
|
470 | + . $PayerInfoNVP |
|
471 | + . $PayerNameNVP |
|
472 | + . $BillingAddressNVP |
|
473 | + . $PaymentDetailsNVP |
|
474 | + . $OrderItemsNVP |
|
475 | + . $ShippingAddressNVP |
|
476 | + . $Secure3DNVP; |
|
477 | + $NVPResponse = $this->_CURLRequest($NVPRequest); |
|
478 | + $NVPRequestArray = $this->_NVPToArray($NVPRequest); |
|
479 | + $NVPResponseArray = $this->_NVPToArray($NVPResponse); |
|
480 | + $Errors = $this->_GetErrors($NVPResponseArray); |
|
481 | + $NVPResponseArray['ERRORS'] = $Errors; |
|
482 | + $NVPResponseArray['REQUESTDATA'] = $NVPRequestArray; |
|
483 | + $NVPResponseArray['RAWREQUEST'] = $NVPRequest; |
|
484 | + $NVPResponseArray['RAWRESPONSE'] = $NVPResponse; |
|
485 | + return $NVPResponseArray; |
|
486 | + } |
|
487 | + |
|
488 | + |
|
489 | + |
|
490 | + /** |
|
491 | + * @param $Request |
|
492 | + * @return mixed |
|
493 | + */ |
|
494 | + private function _CURLRequest($Request) |
|
495 | + { |
|
496 | + $EndPointURL = $this->_debug_mode ? 'https://api-3t.sandbox.paypal.com/nvp' : 'https://api-3t.paypal.com/nvp'; |
|
497 | + $curl = curl_init(); |
|
498 | + curl_setopt($curl, CURLOPT_VERBOSE, apply_filters('FHEE__EEG_Paypal_Pro__CurlRequest__CURLOPT_VERBOSE', true)); |
|
499 | + curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false); |
|
500 | + curl_setopt($curl, CURLOPT_TIMEOUT, 60); |
|
501 | + curl_setopt($curl, CURLOPT_URL, $EndPointURL); |
|
502 | + curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1); |
|
503 | + curl_setopt($curl, CURLOPT_POSTFIELDS, $Request); |
|
504 | + curl_setopt($curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1); |
|
505 | + //execute the curl POST |
|
506 | + $Response = curl_exec($curl); |
|
507 | + curl_close($curl); |
|
508 | + return $Response; |
|
509 | + } |
|
510 | + |
|
511 | + |
|
512 | + |
|
513 | + /** |
|
514 | + * @param $NVPString |
|
515 | + * @return array |
|
516 | + */ |
|
517 | + private function _NVPToArray($NVPString) |
|
518 | + { |
|
519 | + // prepare responses into array |
|
520 | + $proArray = array(); |
|
521 | + while (strlen($NVPString)) { |
|
522 | + // name |
|
523 | + $keypos = strpos($NVPString, '='); |
|
524 | + $keyval = substr($NVPString, 0, $keypos); |
|
525 | + // value |
|
526 | + $valuepos = strpos($NVPString, '&') ? strpos($NVPString, '&') : strlen($NVPString); |
|
527 | + $valval = substr($NVPString, $keypos + 1, $valuepos - $keypos - 1); |
|
528 | + // decoding the response |
|
529 | + $proArray[$keyval] = urldecode($valval); |
|
530 | + $NVPString = substr($NVPString, $valuepos + 1, strlen($NVPString)); |
|
531 | + } |
|
532 | + return $proArray; |
|
533 | + } |
|
534 | + |
|
535 | + |
|
536 | + |
|
537 | + /** |
|
538 | + * @param array $PayPalResult |
|
539 | + * @return bool |
|
540 | + */ |
|
541 | + private function _APICallSuccessful($PayPalResult) |
|
542 | + { |
|
543 | + $approved = false; |
|
544 | + // check main response message from PayPal |
|
545 | + if (isset($PayPalResult['ACK']) && ! empty($PayPalResult['ACK'])) { |
|
546 | + $ack = strtoupper($PayPalResult['ACK']); |
|
547 | + $approved = ($ack == 'SUCCESS' || $ack == 'SUCCESSWITHWARNING' || $ack == 'PARTIALSUCCESS') ? true : false; |
|
548 | + } |
|
549 | + return $approved; |
|
550 | + } |
|
551 | + |
|
552 | + |
|
553 | + |
|
554 | + /** |
|
555 | + * @param $DataArray |
|
556 | + * @return array |
|
557 | + */ |
|
558 | + private function _GetErrors($DataArray) |
|
559 | + { |
|
560 | + $Errors = array(); |
|
561 | + $n = 0; |
|
562 | + while (isset($DataArray['L_ERRORCODE' . $n . ''])) { |
|
563 | + $LErrorCode = isset($DataArray['L_ERRORCODE' . $n . '']) ? $DataArray['L_ERRORCODE' . $n . ''] : ''; |
|
564 | + $LShortMessage = isset($DataArray['L_SHORTMESSAGE' . $n . '']) |
|
565 | + ? $DataArray['L_SHORTMESSAGE' . $n . ''] |
|
566 | + : ''; |
|
567 | + $LLongMessage = isset($DataArray['L_LONGMESSAGE' . $n . '']) |
|
568 | + ? $DataArray['L_LONGMESSAGE' . $n . ''] |
|
569 | + : ''; |
|
570 | + $LSeverityCode = isset($DataArray['L_SEVERITYCODE' . $n . '']) |
|
571 | + ? $DataArray['L_SEVERITYCODE' . $n . ''] |
|
572 | + : ''; |
|
573 | + $CurrentItem = array( |
|
574 | + 'L_ERRORCODE' => $LErrorCode, |
|
575 | + 'L_SHORTMESSAGE' => $LShortMessage, |
|
576 | + 'L_LONGMESSAGE' => $LLongMessage, |
|
577 | + 'L_SEVERITYCODE' => $LSeverityCode, |
|
578 | + ); |
|
579 | + array_push($Errors, $CurrentItem); |
|
580 | + $n++; |
|
581 | + } |
|
582 | + return $Errors; |
|
583 | + } |
|
584 | + |
|
585 | + |
|
586 | + |
|
587 | + /** |
|
588 | + * nothing to see here... move along.... |
|
589 | + * |
|
590 | + * @access protected |
|
591 | + * @param $Errors |
|
592 | + * @return string |
|
593 | + */ |
|
594 | + private function _DisplayErrors($Errors) |
|
595 | + { |
|
596 | + $error = ''; |
|
597 | + foreach ($Errors as $ErrorVar => $ErrorVal) { |
|
598 | + $CurrentError = $Errors[$ErrorVar]; |
|
599 | + foreach ($CurrentError as $CurrentErrorVar => $CurrentErrorVal) { |
|
600 | + $CurrentVarName = ''; |
|
601 | + if ($CurrentErrorVar == 'L_ERRORCODE') { |
|
602 | + $CurrentVarName = 'Error Code'; |
|
603 | + } elseif ($CurrentErrorVar == 'L_SHORTMESSAGE') { |
|
604 | + $CurrentVarName = 'Short Message'; |
|
605 | + } elseif ($CurrentErrorVar == 'L_LONGMESSAGE') { |
|
606 | + $CurrentVarName = 'Long Message'; |
|
607 | + } elseif ($CurrentErrorVar == 'L_SEVERITYCODE') { |
|
608 | + $CurrentVarName = 'Severity Code'; |
|
609 | + } |
|
610 | + $error .= '<br />' . $CurrentVarName . ': ' . $CurrentErrorVal; |
|
611 | + } |
|
612 | + } |
|
613 | + return $error; |
|
614 | + } |
|
615 | 615 | } |
616 | 616 | // End of file EEG_Paypal_Pro.gateway.php |
@@ -1,5 +1,5 @@ discard block |
||
1 | 1 | <?php |
2 | -if (! defined('EVENT_ESPRESSO_VERSION')) { |
|
2 | +if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
3 | 3 | exit('No direct script access allowed'); |
4 | 4 | } |
5 | 5 | |
@@ -91,13 +91,13 @@ discard block |
||
91 | 91 | public function do_direct_payment($payment, $billing_info = null) |
92 | 92 | { |
93 | 93 | $transaction = $payment->transaction(); |
94 | - if (! $transaction instanceof EEI_Transaction) { |
|
94 | + if ( ! $transaction instanceof EEI_Transaction) { |
|
95 | 95 | throw new EE_Error( |
96 | 96 | esc_html__('No transaction for payment while paying with PayPal Pro.', 'event_espresso') |
97 | 97 | ); |
98 | 98 | } |
99 | 99 | $primary_registrant = $transaction->primary_registration(); |
100 | - if (! $primary_registrant instanceof EEI_Registration) { |
|
100 | + if ( ! $primary_registrant instanceof EEI_Registration) { |
|
101 | 101 | throw new EE_Error( |
102 | 102 | esc_html__( |
103 | 103 | 'No primary registration on transaction while paying with PayPal Pro.', |
@@ -106,7 +106,7 @@ discard block |
||
106 | 106 | ); |
107 | 107 | } |
108 | 108 | $attendee = $primary_registrant->attendee(); |
109 | - if (! $attendee instanceof EEI_Attendee) { |
|
109 | + if ( ! $attendee instanceof EEI_Attendee) { |
|
110 | 110 | throw new EE_Error( |
111 | 111 | esc_html__( |
112 | 112 | 'No attendee on primary registration while paying with PayPal Pro.', |
@@ -203,7 +203,7 @@ discard block |
||
203 | 203 | // Required. Credit card number. No spaces or punctuation. |
204 | 204 | 'acct' => $billing_info['credit_card'], |
205 | 205 | // Required. Credit card expiration date. Format is MMYYYY |
206 | - 'expdate' => $billing_info['exp_month'] . $billing_info['exp_year'], |
|
206 | + 'expdate' => $billing_info['exp_month'].$billing_info['exp_year'], |
|
207 | 207 | // Requirements determined by your PayPal account settings. Security digits for credit card. |
208 | 208 | 'cvv2' => $billing_info['cvv'], |
209 | 209 | ); |
@@ -255,7 +255,7 @@ discard block |
||
255 | 255 | $ShippingAddress = array( |
256 | 256 | 'shiptoname' => substr($use_registration_address_info |
257 | 257 | ? $attendee->full_name() |
258 | - : $billing_info['first_name'] . ' ' . $billing_info['last_name'], 0, 32), |
|
258 | + : $billing_info['first_name'].' '.$billing_info['last_name'], 0, 32), |
|
259 | 259 | 'shiptostreet' => substr($use_registration_address_info |
260 | 260 | ? $attendee->address() |
261 | 261 | : $billing_info['address'], 0, 100), |
@@ -284,7 +284,7 @@ discard block |
||
284 | 284 | 'currencycode' => $payment->currency_code(), |
285 | 285 | // Required if you include itemized cart details. (L_AMTn, etc.) |
286 | 286 | //Subtotal of items not including S&H, or tax. |
287 | - 'itemamt' => $gateway_formatter->formatCurrency($item_amount),// |
|
287 | + 'itemamt' => $gateway_formatter->formatCurrency($item_amount), // |
|
288 | 288 | // Total shipping costs for the order. If you specify shippingamt, you must also specify itemamt. |
289 | 289 | 'shippingamt' => '', |
290 | 290 | // Total handling costs for the order. If you specify handlingamt, you must also specify itemamt. |
@@ -297,10 +297,10 @@ discard block |
||
297 | 297 | // Free-form field for your own use. 256 char max. |
298 | 298 | 'custom' => $primary_registrant ? $primary_registrant->ID() : '', |
299 | 299 | // Your own invoice or tracking number |
300 | - 'invnum' => wp_generate_password(12, false),//$transaction->ID(), |
|
300 | + 'invnum' => wp_generate_password(12, false), //$transaction->ID(), |
|
301 | 301 | // URL for receiving Instant Payment Notifications. This overrides what your profile is set to use. |
302 | 302 | 'notifyurl' => '', |
303 | - 'buttonsource' => 'EventEspresso_SP',//EE will blow up if you change this |
|
303 | + 'buttonsource' => 'EventEspresso_SP', //EE will blow up if you change this |
|
304 | 304 | ); |
305 | 305 | // Wrap all data arrays into a single, "master" array which will be passed into the class function. |
306 | 306 | $PayPalRequestData = array( |
@@ -410,32 +410,32 @@ discard block |
||
410 | 410 | // DP Fields |
411 | 411 | $DPFields = isset($DataArray['DPFields']) ? $DataArray['DPFields'] : array(); |
412 | 412 | foreach ($DPFields as $DPFieldsVar => $DPFieldsVal) { |
413 | - $DPFieldsNVP .= '&' . strtoupper($DPFieldsVar) . '=' . urlencode($DPFieldsVal); |
|
413 | + $DPFieldsNVP .= '&'.strtoupper($DPFieldsVar).'='.urlencode($DPFieldsVal); |
|
414 | 414 | } |
415 | 415 | // CC Details Fields |
416 | 416 | $CCDetails = isset($DataArray['CCDetails']) ? $DataArray['CCDetails'] : array(); |
417 | 417 | foreach ($CCDetails as $CCDetailsVar => $CCDetailsVal) { |
418 | - $CCDetailsNVP .= '&' . strtoupper($CCDetailsVar) . '=' . urlencode($CCDetailsVal); |
|
418 | + $CCDetailsNVP .= '&'.strtoupper($CCDetailsVar).'='.urlencode($CCDetailsVal); |
|
419 | 419 | } |
420 | 420 | // PayerInfo Type Fields |
421 | 421 | $PayerInfo = isset($DataArray['PayerInfo']) ? $DataArray['PayerInfo'] : array(); |
422 | 422 | foreach ($PayerInfo as $PayerInfoVar => $PayerInfoVal) { |
423 | - $PayerInfoNVP .= '&' . strtoupper($PayerInfoVar) . '=' . urlencode($PayerInfoVal); |
|
423 | + $PayerInfoNVP .= '&'.strtoupper($PayerInfoVar).'='.urlencode($PayerInfoVal); |
|
424 | 424 | } |
425 | 425 | // Payer Name Fields |
426 | 426 | $PayerName = isset($DataArray['PayerName']) ? $DataArray['PayerName'] : array(); |
427 | 427 | foreach ($PayerName as $PayerNameVar => $PayerNameVal) { |
428 | - $PayerNameNVP .= '&' . strtoupper($PayerNameVar) . '=' . urlencode($PayerNameVal); |
|
428 | + $PayerNameNVP .= '&'.strtoupper($PayerNameVar).'='.urlencode($PayerNameVal); |
|
429 | 429 | } |
430 | 430 | // Address Fields (Billing) |
431 | 431 | $BillingAddress = isset($DataArray['BillingAddress']) ? $DataArray['BillingAddress'] : array(); |
432 | 432 | foreach ($BillingAddress as $BillingAddressVar => $BillingAddressVal) { |
433 | - $BillingAddressNVP .= '&' . strtoupper($BillingAddressVar) . '=' . urlencode($BillingAddressVal); |
|
433 | + $BillingAddressNVP .= '&'.strtoupper($BillingAddressVar).'='.urlencode($BillingAddressVal); |
|
434 | 434 | } |
435 | 435 | // Payment Details Type Fields |
436 | 436 | $PaymentDetails = isset($DataArray['PaymentDetails']) ? $DataArray['PaymentDetails'] : array(); |
437 | 437 | foreach ($PaymentDetails as $PaymentDetailsVar => $PaymentDetailsVal) { |
438 | - $PaymentDetailsNVP .= '&' . strtoupper($PaymentDetailsVar) . '=' . urlencode($PaymentDetailsVal); |
|
438 | + $PaymentDetailsNVP .= '&'.strtoupper($PaymentDetailsVar).'='.urlencode($PaymentDetailsVal); |
|
439 | 439 | } |
440 | 440 | // Payment Details Item Type Fields |
441 | 441 | $OrderItems = isset($DataArray['OrderItems']) ? $DataArray['OrderItems'] : array(); |
@@ -443,19 +443,19 @@ discard block |
||
443 | 443 | foreach ($OrderItems as $OrderItemsVar => $OrderItemsVal) { |
444 | 444 | $CurrentItem = $OrderItems[$OrderItemsVar]; |
445 | 445 | foreach ($CurrentItem as $CurrentItemVar => $CurrentItemVal) { |
446 | - $OrderItemsNVP .= '&' . strtoupper($CurrentItemVar) . $n . '=' . urlencode($CurrentItemVal); |
|
446 | + $OrderItemsNVP .= '&'.strtoupper($CurrentItemVar).$n.'='.urlencode($CurrentItemVal); |
|
447 | 447 | } |
448 | 448 | $n++; |
449 | 449 | } |
450 | 450 | // Ship To Address Fields |
451 | 451 | $ShippingAddress = isset($DataArray['ShippingAddress']) ? $DataArray['ShippingAddress'] : array(); |
452 | 452 | foreach ($ShippingAddress as $ShippingAddressVar => $ShippingAddressVal) { |
453 | - $ShippingAddressNVP .= '&' . strtoupper($ShippingAddressVar) . '=' . urlencode($ShippingAddressVal); |
|
453 | + $ShippingAddressNVP .= '&'.strtoupper($ShippingAddressVar).'='.urlencode($ShippingAddressVal); |
|
454 | 454 | } |
455 | 455 | // 3D Secure Fields |
456 | 456 | $Secure3D = isset($DataArray['Secure3D']) ? $DataArray['Secure3D'] : array(); |
457 | 457 | foreach ($Secure3D as $Secure3DVar => $Secure3DVal) { |
458 | - $Secure3DNVP .= '&' . strtoupper($Secure3DVar) . '=' . urlencode($Secure3DVal); |
|
458 | + $Secure3DNVP .= '&'.strtoupper($Secure3DVar).'='.urlencode($Secure3DVal); |
|
459 | 459 | } |
460 | 460 | // Now that we have each chunk we need to go ahead and append them all together for our entire NVP string |
461 | 461 | $NVPRequest = 'USER=' |
@@ -559,16 +559,16 @@ discard block |
||
559 | 559 | { |
560 | 560 | $Errors = array(); |
561 | 561 | $n = 0; |
562 | - while (isset($DataArray['L_ERRORCODE' . $n . ''])) { |
|
563 | - $LErrorCode = isset($DataArray['L_ERRORCODE' . $n . '']) ? $DataArray['L_ERRORCODE' . $n . ''] : ''; |
|
564 | - $LShortMessage = isset($DataArray['L_SHORTMESSAGE' . $n . '']) |
|
565 | - ? $DataArray['L_SHORTMESSAGE' . $n . ''] |
|
562 | + while (isset($DataArray['L_ERRORCODE'.$n.''])) { |
|
563 | + $LErrorCode = isset($DataArray['L_ERRORCODE'.$n.'']) ? $DataArray['L_ERRORCODE'.$n.''] : ''; |
|
564 | + $LShortMessage = isset($DataArray['L_SHORTMESSAGE'.$n.'']) |
|
565 | + ? $DataArray['L_SHORTMESSAGE'.$n.''] |
|
566 | 566 | : ''; |
567 | - $LLongMessage = isset($DataArray['L_LONGMESSAGE' . $n . '']) |
|
568 | - ? $DataArray['L_LONGMESSAGE' . $n . ''] |
|
567 | + $LLongMessage = isset($DataArray['L_LONGMESSAGE'.$n.'']) |
|
568 | + ? $DataArray['L_LONGMESSAGE'.$n.''] |
|
569 | 569 | : ''; |
570 | - $LSeverityCode = isset($DataArray['L_SEVERITYCODE' . $n . '']) |
|
571 | - ? $DataArray['L_SEVERITYCODE' . $n . ''] |
|
570 | + $LSeverityCode = isset($DataArray['L_SEVERITYCODE'.$n.'']) |
|
571 | + ? $DataArray['L_SEVERITYCODE'.$n.''] |
|
572 | 572 | : ''; |
573 | 573 | $CurrentItem = array( |
574 | 574 | 'L_ERRORCODE' => $LErrorCode, |
@@ -607,7 +607,7 @@ discard block |
||
607 | 607 | } elseif ($CurrentErrorVar == 'L_SEVERITYCODE') { |
608 | 608 | $CurrentVarName = 'Severity Code'; |
609 | 609 | } |
610 | - $error .= '<br />' . $CurrentVarName . ': ' . $CurrentErrorVal; |
|
610 | + $error .= '<br />'.$CurrentVarName.': '.$CurrentErrorVal; |
|
611 | 611 | } |
612 | 612 | } |
613 | 613 | return $error; |
@@ -1,5 +1,5 @@ discard block |
||
1 | 1 | <?php if (! defined('EVENT_ESPRESSO_VERSION')) { |
2 | - exit('NO direct script access allowed'); |
|
2 | + exit('NO direct script access allowed'); |
|
3 | 3 | } |
4 | 4 | |
5 | 5 | |
@@ -16,680 +16,680 @@ discard block |
||
16 | 16 | */ |
17 | 17 | //Quickfix to address https://events.codebasehq.com/projects/event-espresso/tickets/11089 ASAP |
18 | 18 | if (! function_exists('mb_strcut')) { |
19 | - /** |
|
20 | - * Very simple mimic of mb_substr (which WP ensures exists in wp-includes/compat.php). Still has all the problems of mb_substr |
|
21 | - * (namely, that we might send too many characters to PayPal; however in this case they just issue a warning but nothing breaks) |
|
22 | - * @param $string |
|
23 | - * @param $start |
|
24 | - * @param $length |
|
25 | - * @return bool|string |
|
26 | - */ |
|
27 | - function mb_strcut($string, $start, $length = null) |
|
28 | - { |
|
29 | - return mb_substr($string, $start, $length); |
|
30 | - } |
|
19 | + /** |
|
20 | + * Very simple mimic of mb_substr (which WP ensures exists in wp-includes/compat.php). Still has all the problems of mb_substr |
|
21 | + * (namely, that we might send too many characters to PayPal; however in this case they just issue a warning but nothing breaks) |
|
22 | + * @param $string |
|
23 | + * @param $start |
|
24 | + * @param $length |
|
25 | + * @return bool|string |
|
26 | + */ |
|
27 | + function mb_strcut($string, $start, $length = null) |
|
28 | + { |
|
29 | + return mb_substr($string, $start, $length); |
|
30 | + } |
|
31 | 31 | } |
32 | 32 | class EEG_Paypal_Express extends EE_Offsite_Gateway |
33 | 33 | { |
34 | 34 | |
35 | - /** |
|
36 | - * Merchant API Username. |
|
37 | - * |
|
38 | - * @var string |
|
39 | - */ |
|
40 | - protected $_api_username; |
|
41 | - |
|
42 | - /** |
|
43 | - * Merchant API Password. |
|
44 | - * |
|
45 | - * @var string |
|
46 | - */ |
|
47 | - protected $_api_password; |
|
48 | - |
|
49 | - /** |
|
50 | - * API Signature. |
|
51 | - * |
|
52 | - * @var string |
|
53 | - */ |
|
54 | - protected $_api_signature; |
|
55 | - |
|
56 | - /** |
|
57 | - * Request Shipping address on PP checkout page. |
|
58 | - * |
|
59 | - * @var string |
|
60 | - */ |
|
61 | - protected $_request_shipping_addr; |
|
62 | - |
|
63 | - /** |
|
64 | - * Business/personal logo. |
|
65 | - * |
|
66 | - * @var string |
|
67 | - */ |
|
68 | - protected $_image_url; |
|
69 | - |
|
70 | - /** |
|
71 | - * gateway URL variable |
|
72 | - * |
|
73 | - * @var string |
|
74 | - */ |
|
75 | - protected $_base_gateway_url = ''; |
|
76 | - |
|
77 | - |
|
78 | - |
|
79 | - /** |
|
80 | - * EEG_Paypal_Express constructor. |
|
81 | - */ |
|
82 | - public function __construct() |
|
83 | - { |
|
84 | - $this->_currencies_supported = array( |
|
85 | - 'USD', |
|
86 | - 'AUD', |
|
87 | - 'BRL', |
|
88 | - 'CAD', |
|
89 | - 'CZK', |
|
90 | - 'DKK', |
|
91 | - 'EUR', |
|
92 | - 'HKD', |
|
93 | - 'HUF', |
|
94 | - 'ILS', |
|
95 | - 'JPY', |
|
96 | - 'MYR', |
|
97 | - 'MXN', |
|
98 | - 'NOK', |
|
99 | - 'NZD', |
|
100 | - 'PHP', |
|
101 | - 'PLN', |
|
102 | - 'GBP', |
|
103 | - 'RUB', |
|
104 | - 'SGD', |
|
105 | - 'SEK', |
|
106 | - 'CHF', |
|
107 | - 'TWD', |
|
108 | - 'THB', |
|
109 | - 'TRY', |
|
110 | - ); |
|
111 | - parent::__construct(); |
|
112 | - } |
|
113 | - |
|
114 | - |
|
115 | - |
|
116 | - /** |
|
117 | - * Sets the gateway URL variable based on whether debug mode is enabled or not. |
|
118 | - * |
|
119 | - * @param array $settings_array |
|
120 | - */ |
|
121 | - public function set_settings($settings_array) |
|
122 | - { |
|
123 | - parent::set_settings($settings_array); |
|
124 | - // Redirect URL. |
|
125 | - $this->_base_gateway_url = $this->_debug_mode |
|
126 | - ? 'https://api-3t.sandbox.paypal.com/nvp' |
|
127 | - : 'https://api-3t.paypal.com/nvp'; |
|
128 | - } |
|
129 | - |
|
130 | - |
|
131 | - |
|
132 | - /** |
|
133 | - * @param EEI_Payment $payment |
|
134 | - * @param array $billing_info |
|
135 | - * @param string $return_url |
|
136 | - * @param string $notify_url |
|
137 | - * @param string $cancel_url |
|
138 | - * @return \EE_Payment|\EEI_Payment |
|
139 | - * @throws \EE_Error |
|
140 | - */ |
|
141 | - public function set_redirection_info( |
|
142 | - $payment, |
|
143 | - $billing_info = array(), |
|
144 | - $return_url = null, |
|
145 | - $notify_url = null, |
|
146 | - $cancel_url = null |
|
147 | - ) { |
|
148 | - if (! $payment instanceof EEI_Payment) { |
|
149 | - $payment->set_gateway_response( |
|
150 | - esc_html__( |
|
151 | - 'Error. No associated payment was found.', |
|
152 | - 'event_espresso' |
|
153 | - ) |
|
154 | - ); |
|
155 | - $payment->set_status($this->_pay_model->failed_status()); |
|
156 | - return $payment; |
|
157 | - } |
|
158 | - $transaction = $payment->transaction(); |
|
159 | - if (! $transaction instanceof EEI_Transaction) { |
|
160 | - $payment->set_gateway_response( |
|
161 | - esc_html__( |
|
162 | - 'Could not process this payment because it has no associated transaction.', |
|
163 | - 'event_espresso' |
|
164 | - ) |
|
165 | - ); |
|
166 | - $payment->set_status($this->_pay_model->failed_status()); |
|
167 | - return $payment; |
|
168 | - } |
|
169 | - $gateway_formatter = $this->_get_gateway_formatter(); |
|
170 | - $order_description = mb_strcut($gateway_formatter->formatOrderDescription($payment), 0, 127); |
|
171 | - $primary_registration = $transaction->primary_registration(); |
|
172 | - $primary_attendee = $primary_registration instanceof EE_Registration |
|
173 | - ? $primary_registration->attendee() |
|
174 | - : false; |
|
175 | - $locale = explode('-', get_bloginfo('language')); |
|
176 | - // Gather request parameters. |
|
177 | - $token_request_dtls = array( |
|
178 | - 'METHOD' => 'SetExpressCheckout', |
|
179 | - 'PAYMENTREQUEST_0_AMT' => $payment->amount(), |
|
180 | - 'PAYMENTREQUEST_0_CURRENCYCODE' => $payment->currency_code(), |
|
181 | - 'PAYMENTREQUEST_0_DESC' => $order_description, |
|
182 | - 'RETURNURL' => $return_url, |
|
183 | - 'CANCELURL' => $cancel_url, |
|
184 | - 'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale', |
|
185 | - // Buyer does not need to create a PayPal account to check out. |
|
186 | - // This is referred to as PayPal Account Optional. |
|
187 | - 'SOLUTIONTYPE' => 'Sole', |
|
188 | - //EE will blow up if you change this |
|
189 | - 'BUTTONSOURCE' => 'EventEspresso_SP', |
|
190 | - // Locale of the pages displayed by PayPal during Express Checkout. |
|
191 | - 'LOCALECODE' => $locale[1] |
|
192 | - ); |
|
193 | - // Show itemized list. |
|
194 | - $itemized_list = $this->itemize_list($payment, $transaction); |
|
195 | - $token_request_dtls = array_merge($token_request_dtls, $itemized_list); |
|
196 | - // Automatically filling out shipping and contact information. |
|
197 | - if ($this->_request_shipping_addr && $primary_attendee instanceof EEI_Attendee) { |
|
198 | - // If you do not pass the shipping address, PayPal obtains it from the buyer's account profile. |
|
199 | - $token_request_dtls['NOSHIPPING'] = '2'; |
|
200 | - $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET'] = $primary_attendee->address(); |
|
201 | - $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET2'] = $primary_attendee->address2(); |
|
202 | - $token_request_dtls['PAYMENTREQUEST_0_SHIPTOCITY'] = $primary_attendee->city(); |
|
203 | - $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTATE'] = $primary_attendee->state_abbrev(); |
|
204 | - $token_request_dtls['PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE'] = $primary_attendee->country_ID(); |
|
205 | - $token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip(); |
|
206 | - $token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email(); |
|
207 | - $token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone(); |
|
208 | - } elseif (! $this->_request_shipping_addr) { |
|
209 | - // Do not request shipping details on the PP Checkout page. |
|
210 | - $token_request_dtls['NOSHIPPING'] = '1'; |
|
211 | - $token_request_dtls['REQCONFIRMSHIPPING'] = '0'; |
|
212 | - } |
|
213 | - // Used a business/personal logo on the PayPal page. |
|
214 | - if (! empty($this->_image_url)) { |
|
215 | - $token_request_dtls['LOGOIMG'] = $this->_image_url; |
|
216 | - } |
|
217 | - $token_request_dtls = apply_filters( |
|
218 | - 'FHEE__EEG_Paypal_Express__set_redirection_info__arguments', |
|
219 | - $token_request_dtls, |
|
220 | - $this |
|
221 | - ); |
|
222 | - // Request PayPal token. |
|
223 | - $token_request_response = $this->_ppExpress_request($token_request_dtls, 'Payment Token', $payment); |
|
224 | - $token_rstatus = $this->_ppExpress_check_response($token_request_response); |
|
225 | - $response_args = (isset($token_rstatus['args']) && is_array($token_rstatus['args'])) |
|
226 | - ? $token_rstatus['args'] |
|
227 | - : array(); |
|
228 | - if ($token_rstatus['status']) { |
|
229 | - // We got the Token so we may continue with the payment and redirect the client. |
|
230 | - $payment->set_details($response_args); |
|
231 | - $gateway_url = $this->_debug_mode ? 'https://www.sandbox.paypal.com' : 'https://www.paypal.com'; |
|
232 | - $payment->set_redirect_url( |
|
233 | - $gateway_url |
|
234 | - . '/checkoutnow?useraction=commit&cmd=_express-checkout&token=' |
|
235 | - . $response_args['TOKEN'] |
|
236 | - ); |
|
237 | - } else { |
|
238 | - if (isset($response_args['L_ERRORCODE'])) { |
|
239 | - $payment->set_gateway_response($response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']); |
|
240 | - } else { |
|
241 | - $payment->set_gateway_response( |
|
242 | - esc_html__( |
|
243 | - 'Error occurred while trying to setup the Express Checkout.', |
|
244 | - 'event_espresso' |
|
245 | - ) |
|
246 | - ); |
|
247 | - } |
|
248 | - $payment->set_details($response_args); |
|
249 | - $payment->set_status($this->_pay_model->failed_status()); |
|
250 | - } |
|
251 | - return $payment; |
|
252 | - } |
|
253 | - |
|
254 | - |
|
255 | - |
|
256 | - /** |
|
257 | - * @param array $update_info { |
|
258 | - * @type string $gateway_txn_id |
|
259 | - * @type string status an EEMI_Payment status |
|
260 | - * } |
|
261 | - * @param EEI_Transaction $transaction |
|
262 | - * @return EEI_Payment |
|
263 | - */ |
|
264 | - public function handle_payment_update($update_info, $transaction) |
|
265 | - { |
|
266 | - $payment = $transaction instanceof EEI_Transaction ? $transaction->last_payment() : null; |
|
267 | - if ($payment instanceof EEI_Payment) { |
|
268 | - $this->log(array('Return from Authorization' => $update_info), $payment); |
|
269 | - $transaction = $payment->transaction(); |
|
270 | - if (! $transaction instanceof EEI_Transaction) { |
|
271 | - $payment->set_gateway_response( |
|
272 | - esc_html__( |
|
273 | - 'Could not process this payment because it has no associated transaction.', |
|
274 | - 'event_espresso' |
|
275 | - ) |
|
276 | - ); |
|
277 | - $payment->set_status($this->_pay_model->failed_status()); |
|
278 | - return $payment; |
|
279 | - } |
|
280 | - $primary_registrant = $transaction->primary_registration(); |
|
281 | - $payment_details = $payment->details(); |
|
282 | - // Check if we still have the token. |
|
283 | - if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) { |
|
284 | - $payment->set_status($this->_pay_model->failed_status()); |
|
285 | - return $payment; |
|
286 | - } |
|
287 | - $cdetails_request_dtls = array( |
|
288 | - 'METHOD' => 'GetExpressCheckoutDetails', |
|
289 | - 'TOKEN' => $payment_details['TOKEN'], |
|
290 | - ); |
|
291 | - // Request Customer Details. |
|
292 | - $cdetails_request_response = $this->_ppExpress_request( |
|
293 | - $cdetails_request_dtls, |
|
294 | - 'Customer Details', |
|
295 | - $payment |
|
296 | - ); |
|
297 | - $cdetails_rstatus = $this->_ppExpress_check_response($cdetails_request_response); |
|
298 | - $cdata_response_args = (isset($cdetails_rstatus['args']) && is_array($cdetails_rstatus['args'])) |
|
299 | - ? $cdetails_rstatus['args'] |
|
300 | - : array(); |
|
301 | - if ($cdetails_rstatus['status']) { |
|
302 | - // We got the PayerID so now we can Complete the transaction. |
|
303 | - $docheckout_request_dtls = array( |
|
304 | - 'METHOD' => 'DoExpressCheckoutPayment', |
|
305 | - 'PAYERID' => $cdata_response_args['PAYERID'], |
|
306 | - 'TOKEN' => $payment_details['TOKEN'], |
|
307 | - 'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale', |
|
308 | - 'PAYMENTREQUEST_0_AMT' => $payment->amount(), |
|
309 | - 'PAYMENTREQUEST_0_CURRENCYCODE' => $payment->currency_code(), |
|
310 | - //EE will blow up if you change this |
|
311 | - 'BUTTONSOURCE' => 'EventEspresso_SP', |
|
312 | - ); |
|
313 | - // Include itemized list. |
|
314 | - $itemized_list = $this->itemize_list( |
|
315 | - $payment, |
|
316 | - $transaction, |
|
317 | - $cdata_response_args |
|
318 | - ); |
|
319 | - $docheckout_request_dtls = array_merge($docheckout_request_dtls, $itemized_list); |
|
320 | - // Payment Checkout/Capture. |
|
321 | - $docheckout_request_response = $this->_ppExpress_request( |
|
322 | - $docheckout_request_dtls, |
|
323 | - 'Do Payment', |
|
324 | - $payment |
|
325 | - ); |
|
326 | - $docheckout_rstatus = $this->_ppExpress_check_response($docheckout_request_response); |
|
327 | - $docheckout_response_args = (isset($docheckout_rstatus['args']) && is_array($docheckout_rstatus['args'])) |
|
328 | - ? $docheckout_rstatus['args'] |
|
329 | - : array(); |
|
330 | - if ($docheckout_rstatus['status']) { |
|
331 | - // All is well, payment approved. |
|
332 | - $primary_registration_code = $primary_registrant instanceof EE_Registration ? |
|
333 | - $primary_registrant->reg_code() |
|
334 | - : ''; |
|
335 | - $payment->set_extra_accntng($primary_registration_code); |
|
336 | - $payment->set_amount(isset($docheckout_response_args['PAYMENTINFO_0_AMT']) |
|
337 | - ? (float)$docheckout_response_args['PAYMENTINFO_0_AMT'] |
|
338 | - : 0); |
|
339 | - $payment->set_txn_id_chq_nmbr(isset($docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID']) |
|
340 | - ? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'] |
|
341 | - : null); |
|
342 | - $payment->set_details($cdata_response_args); |
|
343 | - $payment->set_gateway_response(isset($docheckout_response_args['PAYMENTINFO_0_ACK']) |
|
344 | - ? $docheckout_response_args['PAYMENTINFO_0_ACK'] |
|
345 | - : ''); |
|
346 | - $payment->set_status($this->_pay_model->approved_status()); |
|
347 | - } else { |
|
348 | - if (isset($docheckout_response_args['L_ERRORCODE'])) { |
|
349 | - $payment->set_gateway_response( |
|
350 | - $docheckout_response_args['L_ERRORCODE'] |
|
351 | - . '; ' |
|
352 | - . $docheckout_response_args['L_SHORTMESSAGE'] |
|
353 | - ); |
|
354 | - } else { |
|
355 | - $payment->set_gateway_response( |
|
356 | - esc_html__( |
|
357 | - 'Error occurred while trying to Capture the funds.', |
|
358 | - 'event_espresso' |
|
359 | - ) |
|
360 | - ); |
|
361 | - } |
|
362 | - $payment->set_details($docheckout_response_args); |
|
363 | - $payment->set_status($this->_pay_model->declined_status()); |
|
364 | - } |
|
365 | - } else { |
|
366 | - if (isset($cdata_response_args['L_ERRORCODE'])) { |
|
367 | - $payment->set_gateway_response( |
|
368 | - $cdata_response_args['L_ERRORCODE'] |
|
369 | - . '; ' |
|
370 | - . $cdata_response_args['L_SHORTMESSAGE'] |
|
371 | - ); |
|
372 | - } else { |
|
373 | - $payment->set_gateway_response( |
|
374 | - esc_html__( |
|
375 | - 'Error occurred while trying to get payment Details from PayPal.', |
|
376 | - 'event_espresso' |
|
377 | - ) |
|
378 | - ); |
|
379 | - } |
|
380 | - $payment->set_details($cdata_response_args); |
|
381 | - $payment->set_status($this->_pay_model->failed_status()); |
|
382 | - } |
|
383 | - } else { |
|
384 | - $payment->set_gateway_response( |
|
385 | - esc_html__( |
|
386 | - 'Error occurred while trying to process the payment.', |
|
387 | - 'event_espresso' |
|
388 | - ) |
|
389 | - ); |
|
390 | - $payment->set_status($this->_pay_model->failed_status()); |
|
391 | - } |
|
392 | - return $payment; |
|
393 | - } |
|
394 | - |
|
395 | - |
|
396 | - |
|
397 | - /** |
|
398 | - * Make a list of items that are in the giver transaction. |
|
399 | - * |
|
400 | - * @param EEI_Payment $payment |
|
401 | - * @param EEI_Transaction $transaction |
|
402 | - * @param array $request_response_args Data from a previous communication with PP. |
|
403 | - * @return array |
|
404 | - */ |
|
405 | - public function itemize_list(EEI_Payment $payment, EEI_Transaction $transaction, $request_response_args = array()) |
|
406 | - { |
|
407 | - $itemized_list = array(); |
|
408 | - $gateway_formatter = $this->_get_gateway_formatter(); |
|
409 | - // If we have data from a previous communication with PP (on this transaction) we may use that for our list... |
|
410 | - if ( |
|
411 | - ! empty($request_response_args) |
|
412 | - && array_key_exists('L_PAYMENTREQUEST_0_AMT0', $request_response_args) |
|
413 | - && array_key_exists('PAYMENTREQUEST_0_ITEMAMT', $request_response_args) |
|
414 | - ) { |
|
415 | - foreach ($request_response_args as $arg_key => $arg_val) { |
|
416 | - if ( |
|
417 | - strpos($arg_key, 'PAYMENTREQUEST_') !== false |
|
418 | - && strpos($arg_key, 'NOTIFYURL') === false |
|
419 | - ) { |
|
420 | - $itemized_list[$arg_key] = $arg_val; |
|
421 | - } |
|
422 | - } |
|
423 | - // If we got only a few Items then something is not right. |
|
424 | - if (count($itemized_list) > 2) { |
|
425 | - return $itemized_list; |
|
426 | - } else { |
|
427 | - if (WP_DEBUG) { |
|
428 | - throw new EE_Error( |
|
429 | - sprintf( |
|
430 | - esc_html__( |
|
431 | - // @codingStandardsIgnoreStart |
|
432 | - 'Unable to continue with the checkout because a proper purchase list could not be generated. The purchased list we could have sent was %1$s', |
|
433 | - // @codingStandardsIgnoreEnd |
|
434 | - 'event_espresso' |
|
435 | - ), |
|
436 | - wp_json_encode($itemized_list) |
|
437 | - ) |
|
438 | - ); |
|
439 | - } |
|
440 | - // Reset the list and log an error, maybe allow to try and generate a new list (below). |
|
441 | - $itemized_list = array(); |
|
442 | - $this->log( |
|
443 | - array( |
|
444 | - esc_html__( |
|
445 | - 'Could not generate a proper item list with:', |
|
446 | - 'event_espresso' |
|
447 | - ) => $request_response_args |
|
448 | - ), |
|
449 | - $payment |
|
450 | - ); |
|
451 | - } |
|
452 | - } |
|
453 | - // ...otherwise we generate a new list for this transaction. |
|
454 | - if ($this->_money->compare_floats($payment->amount(), $transaction->total(), '==')) { |
|
455 | - $item_num = 0; |
|
456 | - $itemized_sum = 0; |
|
457 | - $total_line_items = $transaction->total_line_item(); |
|
458 | - // Go through each item in the list. |
|
459 | - foreach ($total_line_items->get_items() as $line_item) { |
|
460 | - if ($line_item instanceof EE_Line_Item) { |
|
461 | - // PayPal doesn't like line items with 0.00 amount, so we may skip those. |
|
462 | - if (EEH_Money::compare_floats($line_item->total(), '0.00', '==')) { |
|
463 | - continue; |
|
464 | - } |
|
465 | - $unit_price = $line_item->unit_price(); |
|
466 | - $line_item_quantity = $line_item->quantity(); |
|
467 | - // This is a discount. |
|
468 | - if ($line_item->is_percent()) { |
|
469 | - $unit_price = $line_item->total(); |
|
470 | - $line_item_quantity = 1; |
|
471 | - } |
|
472 | - // Item Name. |
|
473 | - $itemized_list['L_PAYMENTREQUEST_0_NAME' . $item_num] = mb_strcut( |
|
474 | - $gateway_formatter->formatLineItemName($line_item, $payment), |
|
475 | - 0, |
|
476 | - 127 |
|
477 | - ); |
|
478 | - // Item description. |
|
479 | - $itemized_list['L_PAYMENTREQUEST_0_DESC' . $item_num] = mb_strcut( |
|
480 | - $gateway_formatter->formatLineItemDesc($line_item, $payment), |
|
481 | - 0, |
|
482 | - 127 |
|
483 | - ); |
|
484 | - // Cost of individual item. |
|
485 | - $itemized_list['L_PAYMENTREQUEST_0_AMT' . $item_num] = $gateway_formatter->formatCurrency($unit_price); |
|
486 | - // Item Number. |
|
487 | - $itemized_list['L_PAYMENTREQUEST_0_NUMBER' . $item_num] = $item_num + 1; |
|
488 | - // Item quantity. |
|
489 | - $itemized_list['L_PAYMENTREQUEST_0_QTY' . $item_num] = $line_item_quantity; |
|
490 | - // Digital item is sold. |
|
491 | - $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num] = 'Physical'; |
|
492 | - $itemized_sum += $line_item->total(); |
|
493 | - ++$item_num; |
|
494 | - } |
|
495 | - } |
|
496 | - // Item's sales S/H and tax amount. |
|
497 | - $itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $total_line_items->get_items_total(); |
|
498 | - $itemized_list['PAYMENTREQUEST_0_TAXAMT'] = $total_line_items->get_total_tax(); |
|
499 | - $itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0'; |
|
500 | - $itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0'; |
|
501 | - $itemized_sum_diff_from_txn_total = round( |
|
502 | - $transaction->total() - $itemized_sum - $total_line_items->get_total_tax(), |
|
503 | - 2 |
|
504 | - ); |
|
505 | - // If we were not able to recognize some item like promotion, surcharge or cancellation, |
|
506 | - // add the difference as an extra line item. |
|
507 | - if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) { |
|
508 | - // Item Name. |
|
509 | - $itemized_list['L_PAYMENTREQUEST_0_NAME' . $item_num] = mb_strcut( |
|
510 | - esc_html__( |
|
511 | - 'Other (promotion/surcharge/cancellation)', |
|
512 | - 'event_espresso' |
|
513 | - ), |
|
514 | - 0, |
|
515 | - 127 |
|
516 | - ); |
|
517 | - // Item description. |
|
518 | - $itemized_list['L_PAYMENTREQUEST_0_DESC' . $item_num] = ''; |
|
519 | - // Cost of individual item. |
|
520 | - $itemized_list['L_PAYMENTREQUEST_0_AMT' . $item_num] = $gateway_formatter->formatCurrency( |
|
521 | - $itemized_sum_diff_from_txn_total |
|
522 | - ); |
|
523 | - // Item Number. |
|
524 | - $itemized_list['L_PAYMENTREQUEST_0_NUMBER' . $item_num] = $item_num + 1; |
|
525 | - // Item quantity. |
|
526 | - $itemized_list['L_PAYMENTREQUEST_0_QTY' . $item_num] = 1; |
|
527 | - // Digital item is sold. |
|
528 | - $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num] = 'Physical'; |
|
529 | - $item_num++; |
|
530 | - } |
|
531 | - } else { |
|
532 | - // Just one Item. |
|
533 | - // Item Name. |
|
534 | - $itemized_list['L_PAYMENTREQUEST_0_NAME0'] = mb_strcut( |
|
535 | - $gateway_formatter->formatPartialPaymentLineItemName($payment), |
|
536 | - 0, |
|
537 | - 127 |
|
538 | - ); |
|
539 | - // Item description. |
|
540 | - $itemized_list['L_PAYMENTREQUEST_0_DESC0'] = mb_strcut( |
|
541 | - $gateway_formatter->formatPartialPaymentLineItemDesc($payment), |
|
542 | - 0, |
|
543 | - 127 |
|
544 | - ); |
|
545 | - // Cost of individual item. |
|
546 | - $itemized_list['L_PAYMENTREQUEST_0_AMT0'] = $gateway_formatter->formatCurrency($payment->amount()); |
|
547 | - // Item Number. |
|
548 | - $itemized_list['L_PAYMENTREQUEST_0_NUMBER0'] = 1; |
|
549 | - // Item quantity. |
|
550 | - $itemized_list['L_PAYMENTREQUEST_0_QTY0'] = 1; |
|
551 | - // Digital item is sold. |
|
552 | - $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY0'] = 'Physical'; |
|
553 | - // Item's sales S/H and tax amount. |
|
554 | - $itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $gateway_formatter->formatCurrency($payment->amount()); |
|
555 | - $itemized_list['PAYMENTREQUEST_0_TAXAMT'] = '0'; |
|
556 | - $itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0'; |
|
557 | - $itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0'; |
|
558 | - } |
|
559 | - return $itemized_list; |
|
560 | - } |
|
561 | - |
|
562 | - |
|
563 | - |
|
564 | - /** |
|
565 | - * Make the Express checkout request. |
|
566 | - * |
|
567 | - * @param array $request_params |
|
568 | - * @param string $request_text |
|
569 | - * @param EEI_Payment $payment |
|
570 | - * @return mixed |
|
571 | - */ |
|
572 | - public function _ppExpress_request($request_params, $request_text, $payment) |
|
573 | - { |
|
574 | - $request_dtls = array( |
|
575 | - 'VERSION' => '204.0', |
|
576 | - 'USER' => urlencode($this->_api_username), |
|
577 | - 'PWD' => urlencode($this->_api_password), |
|
578 | - 'SIGNATURE' => urlencode($this->_api_signature), |
|
579 | - ); |
|
580 | - $dtls = array_merge($request_dtls, $request_params); |
|
581 | - $this->_log_clean_request($dtls, $payment, $request_text . ' Request'); |
|
582 | - // Request Customer Details. |
|
583 | - $request_response = wp_remote_post( |
|
584 | - $this->_base_gateway_url, |
|
585 | - array( |
|
586 | - 'method' => 'POST', |
|
587 | - 'timeout' => 45, |
|
588 | - 'httpversion' => '1.1', |
|
589 | - 'cookies' => array(), |
|
590 | - 'headers' => array(), |
|
591 | - 'body' => http_build_query($dtls), |
|
592 | - ) |
|
593 | - ); |
|
594 | - // Log the response. |
|
595 | - $this->log(array($request_text . ' Response' => $request_response), $payment); |
|
596 | - return $request_response; |
|
597 | - } |
|
598 | - |
|
599 | - |
|
600 | - |
|
601 | - /** |
|
602 | - * Check the response status. |
|
603 | - * |
|
604 | - * @param mixed $request_response |
|
605 | - * @return array |
|
606 | - */ |
|
607 | - public function _ppExpress_check_response($request_response) |
|
608 | - { |
|
609 | - if (is_wp_error($request_response) || empty($request_response['body'])) { |
|
610 | - // If we got here then there was an error in this request. |
|
611 | - return array('status' => false, 'args' => $request_response); |
|
612 | - } |
|
613 | - $response_args = array(); |
|
614 | - parse_str(urldecode($request_response['body']), $response_args); |
|
615 | - if (! isset($response_args['ACK'])) { |
|
616 | - return array('status' => false, 'args' => $request_response); |
|
617 | - } |
|
618 | - if ( |
|
619 | - ( |
|
620 | - isset($response_args['PAYERID']) |
|
621 | - || isset($response_args['TOKEN']) |
|
622 | - || isset($response_args['PAYMENTINFO_0_TRANSACTIONID']) |
|
623 | - || (isset($response_args['PAYMENTSTATUS']) && $response_args['PAYMENTSTATUS'] === 'Completed') |
|
624 | - ) |
|
625 | - && in_array($response_args['ACK'], array('Success', 'SuccessWithWarning'), true) |
|
626 | - ) { |
|
627 | - // Response status OK, return response parameters for further processing. |
|
628 | - return array('status' => true, 'args' => $response_args); |
|
629 | - } |
|
630 | - $errors = $this->_get_errors($response_args); |
|
631 | - return array('status' => false, 'args' => $errors); |
|
632 | - } |
|
633 | - |
|
634 | - |
|
635 | - |
|
636 | - /** |
|
637 | - * Log a "Cleared" request. |
|
638 | - * |
|
639 | - * @param array $request |
|
640 | - * @param EEI_Payment $payment |
|
641 | - * @param string $info |
|
642 | - * @return void |
|
643 | - */ |
|
644 | - private function _log_clean_request($request, $payment, $info) |
|
645 | - { |
|
646 | - $cleaned_request_data = $request; |
|
647 | - unset($cleaned_request_data['PWD'], $cleaned_request_data['USER'], $cleaned_request_data['SIGNATURE']); |
|
648 | - $this->log(array($info => $cleaned_request_data), $payment); |
|
649 | - } |
|
650 | - |
|
651 | - |
|
652 | - |
|
653 | - /** |
|
654 | - * Get error from the response data. |
|
655 | - * |
|
656 | - * @param array $data_array |
|
657 | - * @return array |
|
658 | - */ |
|
659 | - private function _get_errors($data_array) |
|
660 | - { |
|
661 | - $errors = array(); |
|
662 | - $n = 0; |
|
663 | - while (isset($data_array["L_ERRORCODE{$n}"])) { |
|
664 | - $l_error_code = isset($data_array["L_ERRORCODE{$n}"]) |
|
665 | - ? $data_array["L_ERRORCODE{$n}"] |
|
666 | - : ''; |
|
667 | - $l_severity_code = isset($data_array["L_SEVERITYCODE{$n}"]) |
|
668 | - ? $data_array["L_SEVERITYCODE{$n}"] |
|
669 | - : ''; |
|
670 | - $l_short_message = isset($data_array["L_SHORTMESSAGE{$n}"]) |
|
671 | - ? $data_array["L_SHORTMESSAGE{$n}"] |
|
672 | - : ''; |
|
673 | - $l_long_message = isset($data_array["L_LONGMESSAGE{$n}"]) |
|
674 | - ? $data_array["L_LONGMESSAGE{$n}"] |
|
675 | - : ''; |
|
676 | - if ($n === 0) { |
|
677 | - $errors = array( |
|
678 | - 'L_ERRORCODE' => $l_error_code, |
|
679 | - 'L_SHORTMESSAGE' => $l_short_message, |
|
680 | - 'L_LONGMESSAGE' => $l_long_message, |
|
681 | - 'L_SEVERITYCODE' => $l_severity_code, |
|
682 | - ); |
|
683 | - } else { |
|
684 | - $errors['L_ERRORCODE'] .= ', ' . $l_error_code; |
|
685 | - $errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message; |
|
686 | - $errors['L_LONGMESSAGE'] .= ', ' . $l_long_message; |
|
687 | - $errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code; |
|
688 | - } |
|
689 | - $n++; |
|
690 | - } |
|
691 | - return $errors; |
|
692 | - } |
|
35 | + /** |
|
36 | + * Merchant API Username. |
|
37 | + * |
|
38 | + * @var string |
|
39 | + */ |
|
40 | + protected $_api_username; |
|
41 | + |
|
42 | + /** |
|
43 | + * Merchant API Password. |
|
44 | + * |
|
45 | + * @var string |
|
46 | + */ |
|
47 | + protected $_api_password; |
|
48 | + |
|
49 | + /** |
|
50 | + * API Signature. |
|
51 | + * |
|
52 | + * @var string |
|
53 | + */ |
|
54 | + protected $_api_signature; |
|
55 | + |
|
56 | + /** |
|
57 | + * Request Shipping address on PP checkout page. |
|
58 | + * |
|
59 | + * @var string |
|
60 | + */ |
|
61 | + protected $_request_shipping_addr; |
|
62 | + |
|
63 | + /** |
|
64 | + * Business/personal logo. |
|
65 | + * |
|
66 | + * @var string |
|
67 | + */ |
|
68 | + protected $_image_url; |
|
69 | + |
|
70 | + /** |
|
71 | + * gateway URL variable |
|
72 | + * |
|
73 | + * @var string |
|
74 | + */ |
|
75 | + protected $_base_gateway_url = ''; |
|
76 | + |
|
77 | + |
|
78 | + |
|
79 | + /** |
|
80 | + * EEG_Paypal_Express constructor. |
|
81 | + */ |
|
82 | + public function __construct() |
|
83 | + { |
|
84 | + $this->_currencies_supported = array( |
|
85 | + 'USD', |
|
86 | + 'AUD', |
|
87 | + 'BRL', |
|
88 | + 'CAD', |
|
89 | + 'CZK', |
|
90 | + 'DKK', |
|
91 | + 'EUR', |
|
92 | + 'HKD', |
|
93 | + 'HUF', |
|
94 | + 'ILS', |
|
95 | + 'JPY', |
|
96 | + 'MYR', |
|
97 | + 'MXN', |
|
98 | + 'NOK', |
|
99 | + 'NZD', |
|
100 | + 'PHP', |
|
101 | + 'PLN', |
|
102 | + 'GBP', |
|
103 | + 'RUB', |
|
104 | + 'SGD', |
|
105 | + 'SEK', |
|
106 | + 'CHF', |
|
107 | + 'TWD', |
|
108 | + 'THB', |
|
109 | + 'TRY', |
|
110 | + ); |
|
111 | + parent::__construct(); |
|
112 | + } |
|
113 | + |
|
114 | + |
|
115 | + |
|
116 | + /** |
|
117 | + * Sets the gateway URL variable based on whether debug mode is enabled or not. |
|
118 | + * |
|
119 | + * @param array $settings_array |
|
120 | + */ |
|
121 | + public function set_settings($settings_array) |
|
122 | + { |
|
123 | + parent::set_settings($settings_array); |
|
124 | + // Redirect URL. |
|
125 | + $this->_base_gateway_url = $this->_debug_mode |
|
126 | + ? 'https://api-3t.sandbox.paypal.com/nvp' |
|
127 | + : 'https://api-3t.paypal.com/nvp'; |
|
128 | + } |
|
129 | + |
|
130 | + |
|
131 | + |
|
132 | + /** |
|
133 | + * @param EEI_Payment $payment |
|
134 | + * @param array $billing_info |
|
135 | + * @param string $return_url |
|
136 | + * @param string $notify_url |
|
137 | + * @param string $cancel_url |
|
138 | + * @return \EE_Payment|\EEI_Payment |
|
139 | + * @throws \EE_Error |
|
140 | + */ |
|
141 | + public function set_redirection_info( |
|
142 | + $payment, |
|
143 | + $billing_info = array(), |
|
144 | + $return_url = null, |
|
145 | + $notify_url = null, |
|
146 | + $cancel_url = null |
|
147 | + ) { |
|
148 | + if (! $payment instanceof EEI_Payment) { |
|
149 | + $payment->set_gateway_response( |
|
150 | + esc_html__( |
|
151 | + 'Error. No associated payment was found.', |
|
152 | + 'event_espresso' |
|
153 | + ) |
|
154 | + ); |
|
155 | + $payment->set_status($this->_pay_model->failed_status()); |
|
156 | + return $payment; |
|
157 | + } |
|
158 | + $transaction = $payment->transaction(); |
|
159 | + if (! $transaction instanceof EEI_Transaction) { |
|
160 | + $payment->set_gateway_response( |
|
161 | + esc_html__( |
|
162 | + 'Could not process this payment because it has no associated transaction.', |
|
163 | + 'event_espresso' |
|
164 | + ) |
|
165 | + ); |
|
166 | + $payment->set_status($this->_pay_model->failed_status()); |
|
167 | + return $payment; |
|
168 | + } |
|
169 | + $gateway_formatter = $this->_get_gateway_formatter(); |
|
170 | + $order_description = mb_strcut($gateway_formatter->formatOrderDescription($payment), 0, 127); |
|
171 | + $primary_registration = $transaction->primary_registration(); |
|
172 | + $primary_attendee = $primary_registration instanceof EE_Registration |
|
173 | + ? $primary_registration->attendee() |
|
174 | + : false; |
|
175 | + $locale = explode('-', get_bloginfo('language')); |
|
176 | + // Gather request parameters. |
|
177 | + $token_request_dtls = array( |
|
178 | + 'METHOD' => 'SetExpressCheckout', |
|
179 | + 'PAYMENTREQUEST_0_AMT' => $payment->amount(), |
|
180 | + 'PAYMENTREQUEST_0_CURRENCYCODE' => $payment->currency_code(), |
|
181 | + 'PAYMENTREQUEST_0_DESC' => $order_description, |
|
182 | + 'RETURNURL' => $return_url, |
|
183 | + 'CANCELURL' => $cancel_url, |
|
184 | + 'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale', |
|
185 | + // Buyer does not need to create a PayPal account to check out. |
|
186 | + // This is referred to as PayPal Account Optional. |
|
187 | + 'SOLUTIONTYPE' => 'Sole', |
|
188 | + //EE will blow up if you change this |
|
189 | + 'BUTTONSOURCE' => 'EventEspresso_SP', |
|
190 | + // Locale of the pages displayed by PayPal during Express Checkout. |
|
191 | + 'LOCALECODE' => $locale[1] |
|
192 | + ); |
|
193 | + // Show itemized list. |
|
194 | + $itemized_list = $this->itemize_list($payment, $transaction); |
|
195 | + $token_request_dtls = array_merge($token_request_dtls, $itemized_list); |
|
196 | + // Automatically filling out shipping and contact information. |
|
197 | + if ($this->_request_shipping_addr && $primary_attendee instanceof EEI_Attendee) { |
|
198 | + // If you do not pass the shipping address, PayPal obtains it from the buyer's account profile. |
|
199 | + $token_request_dtls['NOSHIPPING'] = '2'; |
|
200 | + $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET'] = $primary_attendee->address(); |
|
201 | + $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTREET2'] = $primary_attendee->address2(); |
|
202 | + $token_request_dtls['PAYMENTREQUEST_0_SHIPTOCITY'] = $primary_attendee->city(); |
|
203 | + $token_request_dtls['PAYMENTREQUEST_0_SHIPTOSTATE'] = $primary_attendee->state_abbrev(); |
|
204 | + $token_request_dtls['PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE'] = $primary_attendee->country_ID(); |
|
205 | + $token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip(); |
|
206 | + $token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email(); |
|
207 | + $token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone(); |
|
208 | + } elseif (! $this->_request_shipping_addr) { |
|
209 | + // Do not request shipping details on the PP Checkout page. |
|
210 | + $token_request_dtls['NOSHIPPING'] = '1'; |
|
211 | + $token_request_dtls['REQCONFIRMSHIPPING'] = '0'; |
|
212 | + } |
|
213 | + // Used a business/personal logo on the PayPal page. |
|
214 | + if (! empty($this->_image_url)) { |
|
215 | + $token_request_dtls['LOGOIMG'] = $this->_image_url; |
|
216 | + } |
|
217 | + $token_request_dtls = apply_filters( |
|
218 | + 'FHEE__EEG_Paypal_Express__set_redirection_info__arguments', |
|
219 | + $token_request_dtls, |
|
220 | + $this |
|
221 | + ); |
|
222 | + // Request PayPal token. |
|
223 | + $token_request_response = $this->_ppExpress_request($token_request_dtls, 'Payment Token', $payment); |
|
224 | + $token_rstatus = $this->_ppExpress_check_response($token_request_response); |
|
225 | + $response_args = (isset($token_rstatus['args']) && is_array($token_rstatus['args'])) |
|
226 | + ? $token_rstatus['args'] |
|
227 | + : array(); |
|
228 | + if ($token_rstatus['status']) { |
|
229 | + // We got the Token so we may continue with the payment and redirect the client. |
|
230 | + $payment->set_details($response_args); |
|
231 | + $gateway_url = $this->_debug_mode ? 'https://www.sandbox.paypal.com' : 'https://www.paypal.com'; |
|
232 | + $payment->set_redirect_url( |
|
233 | + $gateway_url |
|
234 | + . '/checkoutnow?useraction=commit&cmd=_express-checkout&token=' |
|
235 | + . $response_args['TOKEN'] |
|
236 | + ); |
|
237 | + } else { |
|
238 | + if (isset($response_args['L_ERRORCODE'])) { |
|
239 | + $payment->set_gateway_response($response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']); |
|
240 | + } else { |
|
241 | + $payment->set_gateway_response( |
|
242 | + esc_html__( |
|
243 | + 'Error occurred while trying to setup the Express Checkout.', |
|
244 | + 'event_espresso' |
|
245 | + ) |
|
246 | + ); |
|
247 | + } |
|
248 | + $payment->set_details($response_args); |
|
249 | + $payment->set_status($this->_pay_model->failed_status()); |
|
250 | + } |
|
251 | + return $payment; |
|
252 | + } |
|
253 | + |
|
254 | + |
|
255 | + |
|
256 | + /** |
|
257 | + * @param array $update_info { |
|
258 | + * @type string $gateway_txn_id |
|
259 | + * @type string status an EEMI_Payment status |
|
260 | + * } |
|
261 | + * @param EEI_Transaction $transaction |
|
262 | + * @return EEI_Payment |
|
263 | + */ |
|
264 | + public function handle_payment_update($update_info, $transaction) |
|
265 | + { |
|
266 | + $payment = $transaction instanceof EEI_Transaction ? $transaction->last_payment() : null; |
|
267 | + if ($payment instanceof EEI_Payment) { |
|
268 | + $this->log(array('Return from Authorization' => $update_info), $payment); |
|
269 | + $transaction = $payment->transaction(); |
|
270 | + if (! $transaction instanceof EEI_Transaction) { |
|
271 | + $payment->set_gateway_response( |
|
272 | + esc_html__( |
|
273 | + 'Could not process this payment because it has no associated transaction.', |
|
274 | + 'event_espresso' |
|
275 | + ) |
|
276 | + ); |
|
277 | + $payment->set_status($this->_pay_model->failed_status()); |
|
278 | + return $payment; |
|
279 | + } |
|
280 | + $primary_registrant = $transaction->primary_registration(); |
|
281 | + $payment_details = $payment->details(); |
|
282 | + // Check if we still have the token. |
|
283 | + if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) { |
|
284 | + $payment->set_status($this->_pay_model->failed_status()); |
|
285 | + return $payment; |
|
286 | + } |
|
287 | + $cdetails_request_dtls = array( |
|
288 | + 'METHOD' => 'GetExpressCheckoutDetails', |
|
289 | + 'TOKEN' => $payment_details['TOKEN'], |
|
290 | + ); |
|
291 | + // Request Customer Details. |
|
292 | + $cdetails_request_response = $this->_ppExpress_request( |
|
293 | + $cdetails_request_dtls, |
|
294 | + 'Customer Details', |
|
295 | + $payment |
|
296 | + ); |
|
297 | + $cdetails_rstatus = $this->_ppExpress_check_response($cdetails_request_response); |
|
298 | + $cdata_response_args = (isset($cdetails_rstatus['args']) && is_array($cdetails_rstatus['args'])) |
|
299 | + ? $cdetails_rstatus['args'] |
|
300 | + : array(); |
|
301 | + if ($cdetails_rstatus['status']) { |
|
302 | + // We got the PayerID so now we can Complete the transaction. |
|
303 | + $docheckout_request_dtls = array( |
|
304 | + 'METHOD' => 'DoExpressCheckoutPayment', |
|
305 | + 'PAYERID' => $cdata_response_args['PAYERID'], |
|
306 | + 'TOKEN' => $payment_details['TOKEN'], |
|
307 | + 'PAYMENTREQUEST_0_PAYMENTACTION' => 'Sale', |
|
308 | + 'PAYMENTREQUEST_0_AMT' => $payment->amount(), |
|
309 | + 'PAYMENTREQUEST_0_CURRENCYCODE' => $payment->currency_code(), |
|
310 | + //EE will blow up if you change this |
|
311 | + 'BUTTONSOURCE' => 'EventEspresso_SP', |
|
312 | + ); |
|
313 | + // Include itemized list. |
|
314 | + $itemized_list = $this->itemize_list( |
|
315 | + $payment, |
|
316 | + $transaction, |
|
317 | + $cdata_response_args |
|
318 | + ); |
|
319 | + $docheckout_request_dtls = array_merge($docheckout_request_dtls, $itemized_list); |
|
320 | + // Payment Checkout/Capture. |
|
321 | + $docheckout_request_response = $this->_ppExpress_request( |
|
322 | + $docheckout_request_dtls, |
|
323 | + 'Do Payment', |
|
324 | + $payment |
|
325 | + ); |
|
326 | + $docheckout_rstatus = $this->_ppExpress_check_response($docheckout_request_response); |
|
327 | + $docheckout_response_args = (isset($docheckout_rstatus['args']) && is_array($docheckout_rstatus['args'])) |
|
328 | + ? $docheckout_rstatus['args'] |
|
329 | + : array(); |
|
330 | + if ($docheckout_rstatus['status']) { |
|
331 | + // All is well, payment approved. |
|
332 | + $primary_registration_code = $primary_registrant instanceof EE_Registration ? |
|
333 | + $primary_registrant->reg_code() |
|
334 | + : ''; |
|
335 | + $payment->set_extra_accntng($primary_registration_code); |
|
336 | + $payment->set_amount(isset($docheckout_response_args['PAYMENTINFO_0_AMT']) |
|
337 | + ? (float)$docheckout_response_args['PAYMENTINFO_0_AMT'] |
|
338 | + : 0); |
|
339 | + $payment->set_txn_id_chq_nmbr(isset($docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID']) |
|
340 | + ? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'] |
|
341 | + : null); |
|
342 | + $payment->set_details($cdata_response_args); |
|
343 | + $payment->set_gateway_response(isset($docheckout_response_args['PAYMENTINFO_0_ACK']) |
|
344 | + ? $docheckout_response_args['PAYMENTINFO_0_ACK'] |
|
345 | + : ''); |
|
346 | + $payment->set_status($this->_pay_model->approved_status()); |
|
347 | + } else { |
|
348 | + if (isset($docheckout_response_args['L_ERRORCODE'])) { |
|
349 | + $payment->set_gateway_response( |
|
350 | + $docheckout_response_args['L_ERRORCODE'] |
|
351 | + . '; ' |
|
352 | + . $docheckout_response_args['L_SHORTMESSAGE'] |
|
353 | + ); |
|
354 | + } else { |
|
355 | + $payment->set_gateway_response( |
|
356 | + esc_html__( |
|
357 | + 'Error occurred while trying to Capture the funds.', |
|
358 | + 'event_espresso' |
|
359 | + ) |
|
360 | + ); |
|
361 | + } |
|
362 | + $payment->set_details($docheckout_response_args); |
|
363 | + $payment->set_status($this->_pay_model->declined_status()); |
|
364 | + } |
|
365 | + } else { |
|
366 | + if (isset($cdata_response_args['L_ERRORCODE'])) { |
|
367 | + $payment->set_gateway_response( |
|
368 | + $cdata_response_args['L_ERRORCODE'] |
|
369 | + . '; ' |
|
370 | + . $cdata_response_args['L_SHORTMESSAGE'] |
|
371 | + ); |
|
372 | + } else { |
|
373 | + $payment->set_gateway_response( |
|
374 | + esc_html__( |
|
375 | + 'Error occurred while trying to get payment Details from PayPal.', |
|
376 | + 'event_espresso' |
|
377 | + ) |
|
378 | + ); |
|
379 | + } |
|
380 | + $payment->set_details($cdata_response_args); |
|
381 | + $payment->set_status($this->_pay_model->failed_status()); |
|
382 | + } |
|
383 | + } else { |
|
384 | + $payment->set_gateway_response( |
|
385 | + esc_html__( |
|
386 | + 'Error occurred while trying to process the payment.', |
|
387 | + 'event_espresso' |
|
388 | + ) |
|
389 | + ); |
|
390 | + $payment->set_status($this->_pay_model->failed_status()); |
|
391 | + } |
|
392 | + return $payment; |
|
393 | + } |
|
394 | + |
|
395 | + |
|
396 | + |
|
397 | + /** |
|
398 | + * Make a list of items that are in the giver transaction. |
|
399 | + * |
|
400 | + * @param EEI_Payment $payment |
|
401 | + * @param EEI_Transaction $transaction |
|
402 | + * @param array $request_response_args Data from a previous communication with PP. |
|
403 | + * @return array |
|
404 | + */ |
|
405 | + public function itemize_list(EEI_Payment $payment, EEI_Transaction $transaction, $request_response_args = array()) |
|
406 | + { |
|
407 | + $itemized_list = array(); |
|
408 | + $gateway_formatter = $this->_get_gateway_formatter(); |
|
409 | + // If we have data from a previous communication with PP (on this transaction) we may use that for our list... |
|
410 | + if ( |
|
411 | + ! empty($request_response_args) |
|
412 | + && array_key_exists('L_PAYMENTREQUEST_0_AMT0', $request_response_args) |
|
413 | + && array_key_exists('PAYMENTREQUEST_0_ITEMAMT', $request_response_args) |
|
414 | + ) { |
|
415 | + foreach ($request_response_args as $arg_key => $arg_val) { |
|
416 | + if ( |
|
417 | + strpos($arg_key, 'PAYMENTREQUEST_') !== false |
|
418 | + && strpos($arg_key, 'NOTIFYURL') === false |
|
419 | + ) { |
|
420 | + $itemized_list[$arg_key] = $arg_val; |
|
421 | + } |
|
422 | + } |
|
423 | + // If we got only a few Items then something is not right. |
|
424 | + if (count($itemized_list) > 2) { |
|
425 | + return $itemized_list; |
|
426 | + } else { |
|
427 | + if (WP_DEBUG) { |
|
428 | + throw new EE_Error( |
|
429 | + sprintf( |
|
430 | + esc_html__( |
|
431 | + // @codingStandardsIgnoreStart |
|
432 | + 'Unable to continue with the checkout because a proper purchase list could not be generated. The purchased list we could have sent was %1$s', |
|
433 | + // @codingStandardsIgnoreEnd |
|
434 | + 'event_espresso' |
|
435 | + ), |
|
436 | + wp_json_encode($itemized_list) |
|
437 | + ) |
|
438 | + ); |
|
439 | + } |
|
440 | + // Reset the list and log an error, maybe allow to try and generate a new list (below). |
|
441 | + $itemized_list = array(); |
|
442 | + $this->log( |
|
443 | + array( |
|
444 | + esc_html__( |
|
445 | + 'Could not generate a proper item list with:', |
|
446 | + 'event_espresso' |
|
447 | + ) => $request_response_args |
|
448 | + ), |
|
449 | + $payment |
|
450 | + ); |
|
451 | + } |
|
452 | + } |
|
453 | + // ...otherwise we generate a new list for this transaction. |
|
454 | + if ($this->_money->compare_floats($payment->amount(), $transaction->total(), '==')) { |
|
455 | + $item_num = 0; |
|
456 | + $itemized_sum = 0; |
|
457 | + $total_line_items = $transaction->total_line_item(); |
|
458 | + // Go through each item in the list. |
|
459 | + foreach ($total_line_items->get_items() as $line_item) { |
|
460 | + if ($line_item instanceof EE_Line_Item) { |
|
461 | + // PayPal doesn't like line items with 0.00 amount, so we may skip those. |
|
462 | + if (EEH_Money::compare_floats($line_item->total(), '0.00', '==')) { |
|
463 | + continue; |
|
464 | + } |
|
465 | + $unit_price = $line_item->unit_price(); |
|
466 | + $line_item_quantity = $line_item->quantity(); |
|
467 | + // This is a discount. |
|
468 | + if ($line_item->is_percent()) { |
|
469 | + $unit_price = $line_item->total(); |
|
470 | + $line_item_quantity = 1; |
|
471 | + } |
|
472 | + // Item Name. |
|
473 | + $itemized_list['L_PAYMENTREQUEST_0_NAME' . $item_num] = mb_strcut( |
|
474 | + $gateway_formatter->formatLineItemName($line_item, $payment), |
|
475 | + 0, |
|
476 | + 127 |
|
477 | + ); |
|
478 | + // Item description. |
|
479 | + $itemized_list['L_PAYMENTREQUEST_0_DESC' . $item_num] = mb_strcut( |
|
480 | + $gateway_formatter->formatLineItemDesc($line_item, $payment), |
|
481 | + 0, |
|
482 | + 127 |
|
483 | + ); |
|
484 | + // Cost of individual item. |
|
485 | + $itemized_list['L_PAYMENTREQUEST_0_AMT' . $item_num] = $gateway_formatter->formatCurrency($unit_price); |
|
486 | + // Item Number. |
|
487 | + $itemized_list['L_PAYMENTREQUEST_0_NUMBER' . $item_num] = $item_num + 1; |
|
488 | + // Item quantity. |
|
489 | + $itemized_list['L_PAYMENTREQUEST_0_QTY' . $item_num] = $line_item_quantity; |
|
490 | + // Digital item is sold. |
|
491 | + $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num] = 'Physical'; |
|
492 | + $itemized_sum += $line_item->total(); |
|
493 | + ++$item_num; |
|
494 | + } |
|
495 | + } |
|
496 | + // Item's sales S/H and tax amount. |
|
497 | + $itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $total_line_items->get_items_total(); |
|
498 | + $itemized_list['PAYMENTREQUEST_0_TAXAMT'] = $total_line_items->get_total_tax(); |
|
499 | + $itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0'; |
|
500 | + $itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0'; |
|
501 | + $itemized_sum_diff_from_txn_total = round( |
|
502 | + $transaction->total() - $itemized_sum - $total_line_items->get_total_tax(), |
|
503 | + 2 |
|
504 | + ); |
|
505 | + // If we were not able to recognize some item like promotion, surcharge or cancellation, |
|
506 | + // add the difference as an extra line item. |
|
507 | + if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) { |
|
508 | + // Item Name. |
|
509 | + $itemized_list['L_PAYMENTREQUEST_0_NAME' . $item_num] = mb_strcut( |
|
510 | + esc_html__( |
|
511 | + 'Other (promotion/surcharge/cancellation)', |
|
512 | + 'event_espresso' |
|
513 | + ), |
|
514 | + 0, |
|
515 | + 127 |
|
516 | + ); |
|
517 | + // Item description. |
|
518 | + $itemized_list['L_PAYMENTREQUEST_0_DESC' . $item_num] = ''; |
|
519 | + // Cost of individual item. |
|
520 | + $itemized_list['L_PAYMENTREQUEST_0_AMT' . $item_num] = $gateway_formatter->formatCurrency( |
|
521 | + $itemized_sum_diff_from_txn_total |
|
522 | + ); |
|
523 | + // Item Number. |
|
524 | + $itemized_list['L_PAYMENTREQUEST_0_NUMBER' . $item_num] = $item_num + 1; |
|
525 | + // Item quantity. |
|
526 | + $itemized_list['L_PAYMENTREQUEST_0_QTY' . $item_num] = 1; |
|
527 | + // Digital item is sold. |
|
528 | + $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num] = 'Physical'; |
|
529 | + $item_num++; |
|
530 | + } |
|
531 | + } else { |
|
532 | + // Just one Item. |
|
533 | + // Item Name. |
|
534 | + $itemized_list['L_PAYMENTREQUEST_0_NAME0'] = mb_strcut( |
|
535 | + $gateway_formatter->formatPartialPaymentLineItemName($payment), |
|
536 | + 0, |
|
537 | + 127 |
|
538 | + ); |
|
539 | + // Item description. |
|
540 | + $itemized_list['L_PAYMENTREQUEST_0_DESC0'] = mb_strcut( |
|
541 | + $gateway_formatter->formatPartialPaymentLineItemDesc($payment), |
|
542 | + 0, |
|
543 | + 127 |
|
544 | + ); |
|
545 | + // Cost of individual item. |
|
546 | + $itemized_list['L_PAYMENTREQUEST_0_AMT0'] = $gateway_formatter->formatCurrency($payment->amount()); |
|
547 | + // Item Number. |
|
548 | + $itemized_list['L_PAYMENTREQUEST_0_NUMBER0'] = 1; |
|
549 | + // Item quantity. |
|
550 | + $itemized_list['L_PAYMENTREQUEST_0_QTY0'] = 1; |
|
551 | + // Digital item is sold. |
|
552 | + $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY0'] = 'Physical'; |
|
553 | + // Item's sales S/H and tax amount. |
|
554 | + $itemized_list['PAYMENTREQUEST_0_ITEMAMT'] = $gateway_formatter->formatCurrency($payment->amount()); |
|
555 | + $itemized_list['PAYMENTREQUEST_0_TAXAMT'] = '0'; |
|
556 | + $itemized_list['PAYMENTREQUEST_0_SHIPPINGAMT'] = '0'; |
|
557 | + $itemized_list['PAYMENTREQUEST_0_HANDLINGAMT'] = '0'; |
|
558 | + } |
|
559 | + return $itemized_list; |
|
560 | + } |
|
561 | + |
|
562 | + |
|
563 | + |
|
564 | + /** |
|
565 | + * Make the Express checkout request. |
|
566 | + * |
|
567 | + * @param array $request_params |
|
568 | + * @param string $request_text |
|
569 | + * @param EEI_Payment $payment |
|
570 | + * @return mixed |
|
571 | + */ |
|
572 | + public function _ppExpress_request($request_params, $request_text, $payment) |
|
573 | + { |
|
574 | + $request_dtls = array( |
|
575 | + 'VERSION' => '204.0', |
|
576 | + 'USER' => urlencode($this->_api_username), |
|
577 | + 'PWD' => urlencode($this->_api_password), |
|
578 | + 'SIGNATURE' => urlencode($this->_api_signature), |
|
579 | + ); |
|
580 | + $dtls = array_merge($request_dtls, $request_params); |
|
581 | + $this->_log_clean_request($dtls, $payment, $request_text . ' Request'); |
|
582 | + // Request Customer Details. |
|
583 | + $request_response = wp_remote_post( |
|
584 | + $this->_base_gateway_url, |
|
585 | + array( |
|
586 | + 'method' => 'POST', |
|
587 | + 'timeout' => 45, |
|
588 | + 'httpversion' => '1.1', |
|
589 | + 'cookies' => array(), |
|
590 | + 'headers' => array(), |
|
591 | + 'body' => http_build_query($dtls), |
|
592 | + ) |
|
593 | + ); |
|
594 | + // Log the response. |
|
595 | + $this->log(array($request_text . ' Response' => $request_response), $payment); |
|
596 | + return $request_response; |
|
597 | + } |
|
598 | + |
|
599 | + |
|
600 | + |
|
601 | + /** |
|
602 | + * Check the response status. |
|
603 | + * |
|
604 | + * @param mixed $request_response |
|
605 | + * @return array |
|
606 | + */ |
|
607 | + public function _ppExpress_check_response($request_response) |
|
608 | + { |
|
609 | + if (is_wp_error($request_response) || empty($request_response['body'])) { |
|
610 | + // If we got here then there was an error in this request. |
|
611 | + return array('status' => false, 'args' => $request_response); |
|
612 | + } |
|
613 | + $response_args = array(); |
|
614 | + parse_str(urldecode($request_response['body']), $response_args); |
|
615 | + if (! isset($response_args['ACK'])) { |
|
616 | + return array('status' => false, 'args' => $request_response); |
|
617 | + } |
|
618 | + if ( |
|
619 | + ( |
|
620 | + isset($response_args['PAYERID']) |
|
621 | + || isset($response_args['TOKEN']) |
|
622 | + || isset($response_args['PAYMENTINFO_0_TRANSACTIONID']) |
|
623 | + || (isset($response_args['PAYMENTSTATUS']) && $response_args['PAYMENTSTATUS'] === 'Completed') |
|
624 | + ) |
|
625 | + && in_array($response_args['ACK'], array('Success', 'SuccessWithWarning'), true) |
|
626 | + ) { |
|
627 | + // Response status OK, return response parameters for further processing. |
|
628 | + return array('status' => true, 'args' => $response_args); |
|
629 | + } |
|
630 | + $errors = $this->_get_errors($response_args); |
|
631 | + return array('status' => false, 'args' => $errors); |
|
632 | + } |
|
633 | + |
|
634 | + |
|
635 | + |
|
636 | + /** |
|
637 | + * Log a "Cleared" request. |
|
638 | + * |
|
639 | + * @param array $request |
|
640 | + * @param EEI_Payment $payment |
|
641 | + * @param string $info |
|
642 | + * @return void |
|
643 | + */ |
|
644 | + private function _log_clean_request($request, $payment, $info) |
|
645 | + { |
|
646 | + $cleaned_request_data = $request; |
|
647 | + unset($cleaned_request_data['PWD'], $cleaned_request_data['USER'], $cleaned_request_data['SIGNATURE']); |
|
648 | + $this->log(array($info => $cleaned_request_data), $payment); |
|
649 | + } |
|
650 | + |
|
651 | + |
|
652 | + |
|
653 | + /** |
|
654 | + * Get error from the response data. |
|
655 | + * |
|
656 | + * @param array $data_array |
|
657 | + * @return array |
|
658 | + */ |
|
659 | + private function _get_errors($data_array) |
|
660 | + { |
|
661 | + $errors = array(); |
|
662 | + $n = 0; |
|
663 | + while (isset($data_array["L_ERRORCODE{$n}"])) { |
|
664 | + $l_error_code = isset($data_array["L_ERRORCODE{$n}"]) |
|
665 | + ? $data_array["L_ERRORCODE{$n}"] |
|
666 | + : ''; |
|
667 | + $l_severity_code = isset($data_array["L_SEVERITYCODE{$n}"]) |
|
668 | + ? $data_array["L_SEVERITYCODE{$n}"] |
|
669 | + : ''; |
|
670 | + $l_short_message = isset($data_array["L_SHORTMESSAGE{$n}"]) |
|
671 | + ? $data_array["L_SHORTMESSAGE{$n}"] |
|
672 | + : ''; |
|
673 | + $l_long_message = isset($data_array["L_LONGMESSAGE{$n}"]) |
|
674 | + ? $data_array["L_LONGMESSAGE{$n}"] |
|
675 | + : ''; |
|
676 | + if ($n === 0) { |
|
677 | + $errors = array( |
|
678 | + 'L_ERRORCODE' => $l_error_code, |
|
679 | + 'L_SHORTMESSAGE' => $l_short_message, |
|
680 | + 'L_LONGMESSAGE' => $l_long_message, |
|
681 | + 'L_SEVERITYCODE' => $l_severity_code, |
|
682 | + ); |
|
683 | + } else { |
|
684 | + $errors['L_ERRORCODE'] .= ', ' . $l_error_code; |
|
685 | + $errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message; |
|
686 | + $errors['L_LONGMESSAGE'] .= ', ' . $l_long_message; |
|
687 | + $errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code; |
|
688 | + } |
|
689 | + $n++; |
|
690 | + } |
|
691 | + return $errors; |
|
692 | + } |
|
693 | 693 | |
694 | 694 | } |
695 | 695 | // End of file EEG_Paypal_Express.gateway.php |
@@ -1,4 +1,4 @@ discard block |
||
1 | -<?php if (! defined('EVENT_ESPRESSO_VERSION')) { |
|
1 | +<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
2 | 2 | exit('NO direct script access allowed'); |
3 | 3 | } |
4 | 4 | |
@@ -15,7 +15,7 @@ discard block |
||
15 | 15 | * ---------------------------------------------- |
16 | 16 | */ |
17 | 17 | //Quickfix to address https://events.codebasehq.com/projects/event-espresso/tickets/11089 ASAP |
18 | -if (! function_exists('mb_strcut')) { |
|
18 | +if ( ! function_exists('mb_strcut')) { |
|
19 | 19 | /** |
20 | 20 | * Very simple mimic of mb_substr (which WP ensures exists in wp-includes/compat.php). Still has all the problems of mb_substr |
21 | 21 | * (namely, that we might send too many characters to PayPal; however in this case they just issue a warning but nothing breaks) |
@@ -145,7 +145,7 @@ discard block |
||
145 | 145 | $notify_url = null, |
146 | 146 | $cancel_url = null |
147 | 147 | ) { |
148 | - if (! $payment instanceof EEI_Payment) { |
|
148 | + if ( ! $payment instanceof EEI_Payment) { |
|
149 | 149 | $payment->set_gateway_response( |
150 | 150 | esc_html__( |
151 | 151 | 'Error. No associated payment was found.', |
@@ -156,7 +156,7 @@ discard block |
||
156 | 156 | return $payment; |
157 | 157 | } |
158 | 158 | $transaction = $payment->transaction(); |
159 | - if (! $transaction instanceof EEI_Transaction) { |
|
159 | + if ( ! $transaction instanceof EEI_Transaction) { |
|
160 | 160 | $payment->set_gateway_response( |
161 | 161 | esc_html__( |
162 | 162 | 'Could not process this payment because it has no associated transaction.', |
@@ -205,13 +205,13 @@ discard block |
||
205 | 205 | $token_request_dtls['PAYMENTREQUEST_0_SHIPTOZIP'] = $primary_attendee->zip(); |
206 | 206 | $token_request_dtls['PAYMENTREQUEST_0_EMAIL'] = $primary_attendee->email(); |
207 | 207 | $token_request_dtls['PAYMENTREQUEST_0_SHIPTOPHONENUM'] = $primary_attendee->phone(); |
208 | - } elseif (! $this->_request_shipping_addr) { |
|
208 | + } elseif ( ! $this->_request_shipping_addr) { |
|
209 | 209 | // Do not request shipping details on the PP Checkout page. |
210 | 210 | $token_request_dtls['NOSHIPPING'] = '1'; |
211 | 211 | $token_request_dtls['REQCONFIRMSHIPPING'] = '0'; |
212 | 212 | } |
213 | 213 | // Used a business/personal logo on the PayPal page. |
214 | - if (! empty($this->_image_url)) { |
|
214 | + if ( ! empty($this->_image_url)) { |
|
215 | 215 | $token_request_dtls['LOGOIMG'] = $this->_image_url; |
216 | 216 | } |
217 | 217 | $token_request_dtls = apply_filters( |
@@ -236,7 +236,7 @@ discard block |
||
236 | 236 | ); |
237 | 237 | } else { |
238 | 238 | if (isset($response_args['L_ERRORCODE'])) { |
239 | - $payment->set_gateway_response($response_args['L_ERRORCODE'] . '; ' . $response_args['L_SHORTMESSAGE']); |
|
239 | + $payment->set_gateway_response($response_args['L_ERRORCODE'].'; '.$response_args['L_SHORTMESSAGE']); |
|
240 | 240 | } else { |
241 | 241 | $payment->set_gateway_response( |
242 | 242 | esc_html__( |
@@ -267,7 +267,7 @@ discard block |
||
267 | 267 | if ($payment instanceof EEI_Payment) { |
268 | 268 | $this->log(array('Return from Authorization' => $update_info), $payment); |
269 | 269 | $transaction = $payment->transaction(); |
270 | - if (! $transaction instanceof EEI_Transaction) { |
|
270 | + if ( ! $transaction instanceof EEI_Transaction) { |
|
271 | 271 | $payment->set_gateway_response( |
272 | 272 | esc_html__( |
273 | 273 | 'Could not process this payment because it has no associated transaction.', |
@@ -280,7 +280,7 @@ discard block |
||
280 | 280 | $primary_registrant = $transaction->primary_registration(); |
281 | 281 | $payment_details = $payment->details(); |
282 | 282 | // Check if we still have the token. |
283 | - if (! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) { |
|
283 | + if ( ! isset($payment_details['TOKEN']) || empty($payment_details['TOKEN'])) { |
|
284 | 284 | $payment->set_status($this->_pay_model->failed_status()); |
285 | 285 | return $payment; |
286 | 286 | } |
@@ -334,7 +334,7 @@ discard block |
||
334 | 334 | : ''; |
335 | 335 | $payment->set_extra_accntng($primary_registration_code); |
336 | 336 | $payment->set_amount(isset($docheckout_response_args['PAYMENTINFO_0_AMT']) |
337 | - ? (float)$docheckout_response_args['PAYMENTINFO_0_AMT'] |
|
337 | + ? (float) $docheckout_response_args['PAYMENTINFO_0_AMT'] |
|
338 | 338 | : 0); |
339 | 339 | $payment->set_txn_id_chq_nmbr(isset($docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID']) |
340 | 340 | ? $docheckout_response_args['PAYMENTINFO_0_TRANSACTIONID'] |
@@ -470,25 +470,25 @@ discard block |
||
470 | 470 | $line_item_quantity = 1; |
471 | 471 | } |
472 | 472 | // Item Name. |
473 | - $itemized_list['L_PAYMENTREQUEST_0_NAME' . $item_num] = mb_strcut( |
|
473 | + $itemized_list['L_PAYMENTREQUEST_0_NAME'.$item_num] = mb_strcut( |
|
474 | 474 | $gateway_formatter->formatLineItemName($line_item, $payment), |
475 | 475 | 0, |
476 | 476 | 127 |
477 | 477 | ); |
478 | 478 | // Item description. |
479 | - $itemized_list['L_PAYMENTREQUEST_0_DESC' . $item_num] = mb_strcut( |
|
479 | + $itemized_list['L_PAYMENTREQUEST_0_DESC'.$item_num] = mb_strcut( |
|
480 | 480 | $gateway_formatter->formatLineItemDesc($line_item, $payment), |
481 | 481 | 0, |
482 | 482 | 127 |
483 | 483 | ); |
484 | 484 | // Cost of individual item. |
485 | - $itemized_list['L_PAYMENTREQUEST_0_AMT' . $item_num] = $gateway_formatter->formatCurrency($unit_price); |
|
485 | + $itemized_list['L_PAYMENTREQUEST_0_AMT'.$item_num] = $gateway_formatter->formatCurrency($unit_price); |
|
486 | 486 | // Item Number. |
487 | - $itemized_list['L_PAYMENTREQUEST_0_NUMBER' . $item_num] = $item_num + 1; |
|
487 | + $itemized_list['L_PAYMENTREQUEST_0_NUMBER'.$item_num] = $item_num + 1; |
|
488 | 488 | // Item quantity. |
489 | - $itemized_list['L_PAYMENTREQUEST_0_QTY' . $item_num] = $line_item_quantity; |
|
489 | + $itemized_list['L_PAYMENTREQUEST_0_QTY'.$item_num] = $line_item_quantity; |
|
490 | 490 | // Digital item is sold. |
491 | - $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num] = 'Physical'; |
|
491 | + $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY'.$item_num] = 'Physical'; |
|
492 | 492 | $itemized_sum += $line_item->total(); |
493 | 493 | ++$item_num; |
494 | 494 | } |
@@ -506,7 +506,7 @@ discard block |
||
506 | 506 | // add the difference as an extra line item. |
507 | 507 | if ($this->_money->compare_floats($itemized_sum_diff_from_txn_total, 0, '!=')) { |
508 | 508 | // Item Name. |
509 | - $itemized_list['L_PAYMENTREQUEST_0_NAME' . $item_num] = mb_strcut( |
|
509 | + $itemized_list['L_PAYMENTREQUEST_0_NAME'.$item_num] = mb_strcut( |
|
510 | 510 | esc_html__( |
511 | 511 | 'Other (promotion/surcharge/cancellation)', |
512 | 512 | 'event_espresso' |
@@ -515,17 +515,17 @@ discard block |
||
515 | 515 | 127 |
516 | 516 | ); |
517 | 517 | // Item description. |
518 | - $itemized_list['L_PAYMENTREQUEST_0_DESC' . $item_num] = ''; |
|
518 | + $itemized_list['L_PAYMENTREQUEST_0_DESC'.$item_num] = ''; |
|
519 | 519 | // Cost of individual item. |
520 | - $itemized_list['L_PAYMENTREQUEST_0_AMT' . $item_num] = $gateway_formatter->formatCurrency( |
|
520 | + $itemized_list['L_PAYMENTREQUEST_0_AMT'.$item_num] = $gateway_formatter->formatCurrency( |
|
521 | 521 | $itemized_sum_diff_from_txn_total |
522 | 522 | ); |
523 | 523 | // Item Number. |
524 | - $itemized_list['L_PAYMENTREQUEST_0_NUMBER' . $item_num] = $item_num + 1; |
|
524 | + $itemized_list['L_PAYMENTREQUEST_0_NUMBER'.$item_num] = $item_num + 1; |
|
525 | 525 | // Item quantity. |
526 | - $itemized_list['L_PAYMENTREQUEST_0_QTY' . $item_num] = 1; |
|
526 | + $itemized_list['L_PAYMENTREQUEST_0_QTY'.$item_num] = 1; |
|
527 | 527 | // Digital item is sold. |
528 | - $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY' . $item_num] = 'Physical'; |
|
528 | + $itemized_list['L_PAYMENTREQUEST_0_ITEMCATEGORY'.$item_num] = 'Physical'; |
|
529 | 529 | $item_num++; |
530 | 530 | } |
531 | 531 | } else { |
@@ -578,7 +578,7 @@ discard block |
||
578 | 578 | 'SIGNATURE' => urlencode($this->_api_signature), |
579 | 579 | ); |
580 | 580 | $dtls = array_merge($request_dtls, $request_params); |
581 | - $this->_log_clean_request($dtls, $payment, $request_text . ' Request'); |
|
581 | + $this->_log_clean_request($dtls, $payment, $request_text.' Request'); |
|
582 | 582 | // Request Customer Details. |
583 | 583 | $request_response = wp_remote_post( |
584 | 584 | $this->_base_gateway_url, |
@@ -592,7 +592,7 @@ discard block |
||
592 | 592 | ) |
593 | 593 | ); |
594 | 594 | // Log the response. |
595 | - $this->log(array($request_text . ' Response' => $request_response), $payment); |
|
595 | + $this->log(array($request_text.' Response' => $request_response), $payment); |
|
596 | 596 | return $request_response; |
597 | 597 | } |
598 | 598 | |
@@ -612,7 +612,7 @@ discard block |
||
612 | 612 | } |
613 | 613 | $response_args = array(); |
614 | 614 | parse_str(urldecode($request_response['body']), $response_args); |
615 | - if (! isset($response_args['ACK'])) { |
|
615 | + if ( ! isset($response_args['ACK'])) { |
|
616 | 616 | return array('status' => false, 'args' => $request_response); |
617 | 617 | } |
618 | 618 | if ( |
@@ -681,10 +681,10 @@ discard block |
||
681 | 681 | 'L_SEVERITYCODE' => $l_severity_code, |
682 | 682 | ); |
683 | 683 | } else { |
684 | - $errors['L_ERRORCODE'] .= ', ' . $l_error_code; |
|
685 | - $errors['L_SHORTMESSAGE'] .= ', ' . $l_short_message; |
|
686 | - $errors['L_LONGMESSAGE'] .= ', ' . $l_long_message; |
|
687 | - $errors['L_SEVERITYCODE'] .= ', ' . $l_severity_code; |
|
684 | + $errors['L_ERRORCODE'] .= ', '.$l_error_code; |
|
685 | + $errors['L_SHORTMESSAGE'] .= ', '.$l_short_message; |
|
686 | + $errors['L_LONGMESSAGE'] .= ', '.$l_long_message; |
|
687 | + $errors['L_SEVERITYCODE'] .= ', '.$l_severity_code; |
|
688 | 688 | } |
689 | 689 | $n++; |
690 | 690 | } |
@@ -8,641 +8,641 @@ |
||
8 | 8 | class EE_Email_messenger extends EE_messenger |
9 | 9 | { |
10 | 10 | |
11 | - /** |
|
12 | - * To field for email |
|
13 | - * @var string |
|
14 | - */ |
|
15 | - protected $_to = ''; |
|
16 | - |
|
17 | - |
|
18 | - /** |
|
19 | - * CC field for email. |
|
20 | - * @var string |
|
21 | - */ |
|
22 | - protected $_cc = ''; |
|
23 | - |
|
24 | - /** |
|
25 | - * From field for email |
|
26 | - * @var string |
|
27 | - */ |
|
28 | - protected $_from = ''; |
|
29 | - |
|
30 | - |
|
31 | - /** |
|
32 | - * Subject field for email |
|
33 | - * @var string |
|
34 | - */ |
|
35 | - protected $_subject = ''; |
|
36 | - |
|
37 | - |
|
38 | - /** |
|
39 | - * Content field for email |
|
40 | - * @var string |
|
41 | - */ |
|
42 | - protected $_content = ''; |
|
43 | - |
|
44 | - |
|
45 | - /** |
|
46 | - * constructor |
|
47 | - * |
|
48 | - * @access public |
|
49 | - */ |
|
50 | - public function __construct() |
|
51 | - { |
|
52 | - //set name and description properties |
|
53 | - $this->name = 'email'; |
|
54 | - $this->description = sprintf( |
|
55 | - esc_html__( |
|
56 | - 'This messenger delivers messages via email using the built-in %s function included with WordPress', |
|
57 | - 'event_espresso' |
|
58 | - ), |
|
59 | - '<code>wp_mail</code>' |
|
60 | - ); |
|
61 | - $this->label = array( |
|
62 | - 'singular' => esc_html__('email', 'event_espresso'), |
|
63 | - 'plural' => esc_html__('emails', 'event_espresso'), |
|
64 | - ); |
|
65 | - $this->activate_on_install = true; |
|
66 | - |
|
67 | - //we're using defaults so let's call parent constructor that will take care of setting up all the other |
|
68 | - // properties |
|
69 | - parent::__construct(); |
|
70 | - } |
|
71 | - |
|
72 | - |
|
73 | - /** |
|
74 | - * see abstract declaration in parent class for details. |
|
75 | - */ |
|
76 | - protected function _set_admin_pages() |
|
77 | - { |
|
78 | - $this->admin_registered_pages = array( |
|
79 | - 'events_edit' => true, |
|
80 | - ); |
|
81 | - } |
|
82 | - |
|
83 | - |
|
84 | - /** |
|
85 | - * see abstract declaration in parent class for details |
|
86 | - */ |
|
87 | - protected function _set_valid_shortcodes() |
|
88 | - { |
|
89 | - //remember by leaving the other fields not set, those fields will inherit the valid shortcodes from the |
|
90 | - // message type. |
|
91 | - $this->_valid_shortcodes = array( |
|
92 | - 'to' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'), |
|
93 | - 'cc' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'), |
|
94 | - 'from' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'), |
|
95 | - ); |
|
96 | - } |
|
97 | - |
|
98 | - |
|
99 | - /** |
|
100 | - * see abstract declaration in parent class for details |
|
101 | - * |
|
102 | - * @access protected |
|
103 | - * @return void |
|
104 | - */ |
|
105 | - protected function _set_validator_config() |
|
106 | - { |
|
107 | - $valid_shortcodes = $this->get_valid_shortcodes(); |
|
108 | - |
|
109 | - $this->_validator_config = array( |
|
110 | - 'to' => array( |
|
111 | - 'shortcodes' => $valid_shortcodes['to'], |
|
112 | - 'type' => 'email', |
|
113 | - ), |
|
114 | - 'cc' => array( |
|
115 | - 'shortcodes' => $valid_shortcodes['to'], |
|
116 | - 'type' => 'email', |
|
117 | - ), |
|
118 | - 'from' => array( |
|
119 | - 'shortcodes' => $valid_shortcodes['from'], |
|
120 | - 'type' => 'email', |
|
121 | - ), |
|
122 | - 'subject' => array( |
|
123 | - 'shortcodes' => array( |
|
124 | - 'organization', |
|
125 | - 'primary_registration_details', |
|
126 | - 'event_author', |
|
127 | - 'primary_registration_details', |
|
128 | - 'recipient_details', |
|
129 | - ), |
|
130 | - ), |
|
131 | - 'content' => array( |
|
132 | - 'shortcodes' => array( |
|
133 | - 'event_list', |
|
134 | - 'attendee_list', |
|
135 | - 'ticket_list', |
|
136 | - 'organization', |
|
137 | - 'primary_registration_details', |
|
138 | - 'primary_registration_list', |
|
139 | - 'event_author', |
|
140 | - 'recipient_details', |
|
141 | - 'recipient_list', |
|
142 | - 'transaction', |
|
143 | - 'messenger', |
|
144 | - ), |
|
145 | - ), |
|
146 | - 'attendee_list' => array( |
|
147 | - 'shortcodes' => array('attendee', 'event_list', 'ticket_list'), |
|
148 | - 'required' => array('[ATTENDEE_LIST]'), |
|
149 | - ), |
|
150 | - 'event_list' => array( |
|
151 | - 'shortcodes' => array( |
|
152 | - 'event', |
|
153 | - 'attendee_list', |
|
154 | - 'ticket_list', |
|
155 | - 'venue', |
|
156 | - 'datetime_list', |
|
157 | - 'attendee', |
|
158 | - 'primary_registration_details', |
|
159 | - 'primary_registration_list', |
|
160 | - 'event_author', |
|
161 | - 'recipient_details', |
|
162 | - 'recipient_list', |
|
163 | - ), |
|
164 | - 'required' => array('[EVENT_LIST]'), |
|
165 | - ), |
|
166 | - 'ticket_list' => array( |
|
167 | - 'shortcodes' => array( |
|
168 | - 'event_list', |
|
169 | - 'attendee_list', |
|
170 | - 'ticket', |
|
171 | - 'datetime_list', |
|
172 | - 'primary_registration_details', |
|
173 | - 'recipient_details', |
|
174 | - ), |
|
175 | - 'required' => array('[TICKET_LIST]'), |
|
176 | - ), |
|
177 | - 'datetime_list' => array( |
|
178 | - 'shortcodes' => array('datetime'), |
|
179 | - 'required' => array('[DATETIME_LIST]'), |
|
180 | - ), |
|
181 | - ); |
|
182 | - } |
|
183 | - |
|
184 | - |
|
185 | - /** |
|
186 | - * @see parent EE_messenger class for docs |
|
187 | - * @since 4.5.0 |
|
188 | - */ |
|
189 | - public function do_secondary_messenger_hooks($sending_messenger_name) |
|
190 | - { |
|
191 | - if ($sending_messenger_name = 'html') { |
|
192 | - add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8); |
|
193 | - } |
|
194 | - } |
|
195 | - |
|
196 | - |
|
197 | - public function add_email_css( |
|
198 | - $variation_path, |
|
199 | - $messenger, |
|
200 | - $message_type, |
|
201 | - $type, |
|
202 | - $variation, |
|
203 | - $file_extension, |
|
204 | - $url, |
|
205 | - EE_Messages_Template_Pack $template_pack |
|
206 | - ) { |
|
207 | - //prevent recursion on this callback. |
|
208 | - remove_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10); |
|
209 | - $variation = $this->get_variation($template_pack, $message_type, $url, 'main', $variation, false); |
|
210 | - |
|
211 | - add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8); |
|
212 | - return $variation; |
|
213 | - } |
|
214 | - |
|
215 | - |
|
216 | - /** |
|
217 | - * See parent for details |
|
218 | - * |
|
219 | - * @access protected |
|
220 | - * @return void |
|
221 | - */ |
|
222 | - protected function _set_test_settings_fields() |
|
223 | - { |
|
224 | - $this->_test_settings_fields = array( |
|
225 | - 'to' => array( |
|
226 | - 'input' => 'text', |
|
227 | - 'label' => esc_html__('Send a test email to', 'event_espresso'), |
|
228 | - 'type' => 'email', |
|
229 | - 'required' => true, |
|
230 | - 'validation' => true, |
|
231 | - 'css_class' => 'large-text', |
|
232 | - 'format' => '%s', |
|
233 | - 'default' => get_bloginfo('admin_email'), |
|
234 | - ), |
|
235 | - 'subject' => array( |
|
236 | - 'input' => 'hidden', |
|
237 | - 'label' => '', |
|
238 | - 'type' => 'string', |
|
239 | - 'required' => false, |
|
240 | - 'validation' => false, |
|
241 | - 'format' => '%s', |
|
242 | - 'value' => sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')), |
|
243 | - 'default' => '', |
|
244 | - 'css_class' => '', |
|
245 | - ), |
|
246 | - ); |
|
247 | - } |
|
248 | - |
|
249 | - |
|
250 | - /** |
|
251 | - * _set_template_fields |
|
252 | - * This sets up the fields that a messenger requires for the message to go out. |
|
253 | - * |
|
254 | - * @access protected |
|
255 | - * @return void |
|
256 | - */ |
|
257 | - protected function _set_template_fields() |
|
258 | - { |
|
259 | - // any extra template fields that are NOT used by the messenger but will get used by a messenger field for |
|
260 | - // shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field |
|
261 | - // they relate to. This is important for the Messages_admin to know what fields to display to the user. |
|
262 | - // Also, notice that the "values" are equal to the field type that messages admin will use to know what |
|
263 | - // kind of field to display. The values ALSO have one index labeled "shortcode". the values in that array |
|
264 | - // indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be |
|
265 | - // displayed. If the required shortcode isn't part of the shortcodes array then the field is not needed and |
|
266 | - // will not be displayed/parsed. |
|
267 | - $this->_template_fields = array( |
|
268 | - 'to' => array( |
|
269 | - 'input' => 'text', |
|
270 | - 'label' => esc_html_x( |
|
271 | - 'To', |
|
272 | - 'Label for the "To" field for email addresses', |
|
273 | - 'event_espresso' |
|
274 | - ), |
|
275 | - 'type' => 'string', |
|
276 | - 'required' => true, |
|
277 | - 'validation' => true, |
|
278 | - 'css_class' => 'large-text', |
|
279 | - 'format' => '%s', |
|
280 | - ), |
|
281 | - 'cc' => array( |
|
282 | - 'input' => 'text', |
|
283 | - 'label' => esc_html_x( |
|
284 | - 'CC', |
|
285 | - 'Label for the "Carbon Copy" field used for additional email addresses', |
|
286 | - 'event_espresso' |
|
287 | - ), |
|
288 | - 'type' => 'string', |
|
289 | - 'required' => false, |
|
290 | - 'validation' => true, |
|
291 | - 'css_class' => 'large-text', |
|
292 | - 'format' => '%s', |
|
293 | - ), |
|
294 | - 'from' => array( |
|
295 | - 'input' => 'text', |
|
296 | - 'label' => esc_html_x( |
|
297 | - 'From', |
|
298 | - 'Label for the "From" field for email addresses.', |
|
299 | - 'event_espresso' |
|
300 | - ), |
|
301 | - 'type' => 'string', |
|
302 | - 'required' => true, |
|
303 | - 'validation' => true, |
|
304 | - 'css_class' => 'large-text', |
|
305 | - 'format' => '%s', |
|
306 | - ), |
|
307 | - 'subject' => array( |
|
308 | - 'input' => 'text', |
|
309 | - 'label' => esc_html_x( |
|
310 | - 'Subject', |
|
311 | - 'Label for the "Subject" field (short description of contents) for emails.', |
|
312 | - 'event_espresso' |
|
313 | - ), |
|
314 | - 'type' => 'string', |
|
315 | - 'required' => true, |
|
316 | - 'validation' => true, |
|
317 | - 'css_class' => 'large-text', |
|
318 | - 'format' => '%s', |
|
319 | - ), |
|
320 | - 'content' => '', |
|
321 | - //left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field. |
|
322 | - 'extra' => array( |
|
323 | - 'content' => array( |
|
324 | - 'main' => array( |
|
325 | - 'input' => 'wp_editor', |
|
326 | - 'label' => esc_html__('Main Content', 'event_espresso'), |
|
327 | - 'type' => 'string', |
|
328 | - 'required' => true, |
|
329 | - 'validation' => true, |
|
330 | - 'format' => '%s', |
|
331 | - 'rows' => '15', |
|
332 | - ), |
|
333 | - 'event_list' => array( |
|
334 | - 'input' => 'wp_editor', |
|
335 | - 'label' => '[EVENT_LIST]', |
|
336 | - 'type' => 'string', |
|
337 | - 'required' => true, |
|
338 | - 'validation' => true, |
|
339 | - 'format' => '%s', |
|
340 | - 'rows' => '15', |
|
341 | - 'shortcodes_required' => array('[EVENT_LIST]'), |
|
342 | - ), |
|
343 | - 'attendee_list' => array( |
|
344 | - 'input' => 'textarea', |
|
345 | - 'label' => '[ATTENDEE_LIST]', |
|
346 | - 'type' => 'string', |
|
347 | - 'required' => true, |
|
348 | - 'validation' => true, |
|
349 | - 'format' => '%s', |
|
350 | - 'css_class' => 'large-text', |
|
351 | - 'rows' => '5', |
|
352 | - 'shortcodes_required' => array('[ATTENDEE_LIST]'), |
|
353 | - ), |
|
354 | - 'ticket_list' => array( |
|
355 | - 'input' => 'textarea', |
|
356 | - 'label' => '[TICKET_LIST]', |
|
357 | - 'type' => 'string', |
|
358 | - 'required' => true, |
|
359 | - 'validation' => true, |
|
360 | - 'format' => '%s', |
|
361 | - 'css_class' => 'large-text', |
|
362 | - 'rows' => '10', |
|
363 | - 'shortcodes_required' => array('[TICKET_LIST]'), |
|
364 | - ), |
|
365 | - 'datetime_list' => array( |
|
366 | - 'input' => 'textarea', |
|
367 | - 'label' => '[DATETIME_LIST]', |
|
368 | - 'type' => 'string', |
|
369 | - 'required' => true, |
|
370 | - 'validation' => true, |
|
371 | - 'format' => '%s', |
|
372 | - 'css_class' => 'large-text', |
|
373 | - 'rows' => '10', |
|
374 | - 'shortcodes_required' => array('[DATETIME_LIST]'), |
|
375 | - ), |
|
376 | - ), |
|
377 | - ), |
|
378 | - ); |
|
379 | - } |
|
380 | - |
|
381 | - |
|
382 | - /** |
|
383 | - * See definition of this class in parent |
|
384 | - */ |
|
385 | - protected function _set_default_message_types() |
|
386 | - { |
|
387 | - $this->_default_message_types = array( |
|
388 | - 'payment', |
|
389 | - 'payment_refund', |
|
390 | - 'registration', |
|
391 | - 'not_approved_registration', |
|
392 | - 'pending_approval', |
|
393 | - ); |
|
394 | - } |
|
395 | - |
|
396 | - |
|
397 | - /** |
|
398 | - * @see definition of this class in parent |
|
399 | - * @since 4.5.0 |
|
400 | - */ |
|
401 | - protected function _set_valid_message_types() |
|
402 | - { |
|
403 | - $this->_valid_message_types = array( |
|
404 | - 'payment', |
|
405 | - 'registration', |
|
406 | - 'not_approved_registration', |
|
407 | - 'declined_registration', |
|
408 | - 'cancelled_registration', |
|
409 | - 'pending_approval', |
|
410 | - 'registration_summary', |
|
411 | - 'payment_reminder', |
|
412 | - 'payment_declined', |
|
413 | - 'payment_refund', |
|
414 | - ); |
|
415 | - } |
|
416 | - |
|
417 | - |
|
418 | - /** |
|
419 | - * setting up admin_settings_fields for messenger. |
|
420 | - */ |
|
421 | - protected function _set_admin_settings_fields() |
|
422 | - { |
|
423 | - } |
|
424 | - |
|
425 | - /** |
|
426 | - * We just deliver the messages don't kill us!! |
|
427 | - * |
|
428 | - * @return bool|WP_Error true if message delivered, false if it didn't deliver OR bubble up any error object if |
|
429 | - * present. |
|
430 | - * @throws EE_Error |
|
431 | - * @throws \TijsVerkoyen\CssToInlineStyles\Exception |
|
432 | - */ |
|
433 | - protected function _send_message() |
|
434 | - { |
|
435 | - $success = wp_mail( |
|
436 | - $this->_to, |
|
437 | - $this->_subject, |
|
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 | - if (! empty($this->_cc)) { |
|
491 | - $headers[] = 'cc: ' . $this->_cc; |
|
492 | - } |
|
493 | - |
|
494 | - //but wait! Header's for the from is NOT reliable because some plugins don't respect From: as set in the |
|
495 | - // header. |
|
496 | - add_filter('wp_mail_from', array($this, 'set_from_address'), 100); |
|
497 | - add_filter('wp_mail_from_name', array($this, 'set_from_name'), 100); |
|
498 | - return apply_filters('FHEE__EE_Email_messenger___headers', $headers, $this->_incoming_message_type, $this); |
|
499 | - } |
|
500 | - |
|
501 | - |
|
502 | - /** |
|
503 | - * This simply ensures that the from address is not empty. If it is, then we use whatever is set as the site email |
|
504 | - * address for the from address to avoid problems with sending emails. |
|
505 | - */ |
|
506 | - protected function _ensure_has_from_email_address() |
|
507 | - { |
|
508 | - if (empty($this->_from)) { |
|
509 | - $this->_from = get_bloginfo('admin_email'); |
|
510 | - } |
|
511 | - } |
|
512 | - |
|
513 | - |
|
514 | - /** |
|
515 | - * This simply parses whatever is set as the $_from address and determines if it is in the format {name} <{email}> |
|
516 | - * or just {email} and returns an array with the "from_name" and "from_email" as the values. Note from_name *MAY* |
|
517 | - * be empty |
|
518 | - * |
|
519 | - * @since 4.3.1 |
|
520 | - * @return array |
|
521 | - */ |
|
522 | - private function _parse_from() |
|
523 | - { |
|
524 | - if (strpos($this->_from, '<') !== false) { |
|
525 | - $from_name = substr($this->_from, 0, strpos($this->_from, '<') - 1); |
|
526 | - $from_name = str_replace('"', '', $from_name); |
|
527 | - $from_name = trim($from_name); |
|
528 | - |
|
529 | - $from_email = substr($this->_from, strpos($this->_from, '<') + 1); |
|
530 | - $from_email = str_replace('>', '', $from_email); |
|
531 | - $from_email = trim($from_email); |
|
532 | - } elseif (trim($this->_from) !== '') { |
|
533 | - $from_name = ''; |
|
534 | - $from_email = trim($this->_from); |
|
535 | - } else { |
|
536 | - $from_name = $from_email = ''; |
|
537 | - } |
|
538 | - return array($from_name, $from_email); |
|
539 | - } |
|
540 | - |
|
541 | - |
|
542 | - /** |
|
543 | - * Callback for the wp_mail_from filter. |
|
544 | - * |
|
545 | - * @since 4.3.1 |
|
546 | - * @param string $from_email What the original from_email is. |
|
547 | - * @return string |
|
548 | - */ |
|
549 | - public function set_from_address($from_email) |
|
550 | - { |
|
551 | - $parsed_from = $this->_parse_from(); |
|
552 | - //includes fallback if the parsing failed. |
|
553 | - $from_email = is_array($parsed_from) && ! empty($parsed_from[1]) |
|
554 | - ? $parsed_from[1] |
|
555 | - : get_bloginfo('admin_email'); |
|
556 | - return $from_email; |
|
557 | - } |
|
558 | - |
|
559 | - |
|
560 | - /** |
|
561 | - * Callback fro the wp_mail_from_name filter. |
|
562 | - * |
|
563 | - * @since 4.3.1 |
|
564 | - * @param string $from_name The original from_name. |
|
565 | - * @return string |
|
566 | - */ |
|
567 | - public function set_from_name($from_name) |
|
568 | - { |
|
569 | - $parsed_from = $this->_parse_from(); |
|
570 | - if (is_array($parsed_from) && ! empty($parsed_from[0])) { |
|
571 | - $from_name = $parsed_from[0]; |
|
572 | - } |
|
573 | - |
|
574 | - //if from name is "WordPress" let's sub in the site name instead (more friendly!) |
|
575 | - $from_name = $from_name == 'WordPress' ? get_bloginfo() : $from_name; |
|
576 | - |
|
577 | - return $from_name; |
|
578 | - } |
|
579 | - |
|
580 | - |
|
581 | - /** |
|
582 | - * setup body for email |
|
583 | - * |
|
584 | - * @param bool $preview will determine whether this is preview template or not. |
|
585 | - * @return string formatted body for email. |
|
586 | - * @throws EE_Error |
|
587 | - * @throws \TijsVerkoyen\CssToInlineStyles\Exception |
|
588 | - */ |
|
589 | - protected function _body($preview = false) |
|
590 | - { |
|
591 | - //setup template args! |
|
592 | - $this->_template_args = array( |
|
593 | - 'subject' => $this->_subject, |
|
594 | - 'from' => $this->_from, |
|
595 | - 'main_body' => wpautop($this->_content), |
|
596 | - ); |
|
597 | - $body = $this->_get_main_template($preview); |
|
598 | - |
|
599 | - /** |
|
600 | - * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched. |
|
601 | - * |
|
602 | - * @type bool $preview Indicates whether a preview is being generated or not. |
|
603 | - * @return bool true indicates to use the inliner, false bypasses it. |
|
604 | - */ |
|
605 | - if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) { |
|
606 | - //require CssToInlineStyles library and its dependencies via composer autoloader |
|
607 | - require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php'; |
|
608 | - |
|
609 | - //now if this isn't a preview, let's setup the body so it has inline styles |
|
610 | - if (! $preview || ($preview && defined('DOING_AJAX'))) { |
|
611 | - $style = file_get_contents( |
|
612 | - $this->get_variation( |
|
613 | - $this->_tmp_pack, |
|
614 | - $this->_incoming_message_type->name, |
|
615 | - false, |
|
616 | - 'main', |
|
617 | - $this->_variation |
|
618 | - ), |
|
619 | - true |
|
620 | - ); |
|
621 | - $CSS = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles($body, $style); |
|
622 | - //for some reason the library has a bracket and new line at the beginning. This takes care of that. |
|
623 | - $body = ltrim($CSS->convert(true), ">\n"); |
|
624 | - //see https://events.codebasehq.com/projects/event-espresso/tickets/8609 |
|
625 | - $body = ltrim($body, "<?"); |
|
626 | - } |
|
627 | - |
|
628 | - } |
|
629 | - return $body; |
|
630 | - } |
|
631 | - |
|
632 | - |
|
633 | - /** |
|
634 | - * This just returns any existing test settings that might be saved in the database |
|
635 | - * |
|
636 | - * @access public |
|
637 | - * @return array |
|
638 | - */ |
|
639 | - public function get_existing_test_settings() |
|
640 | - { |
|
641 | - $settings = parent::get_existing_test_settings(); |
|
642 | - //override subject if present because we always want it to be fresh. |
|
643 | - if (is_array($settings) && ! empty($settings['subject'])) { |
|
644 | - $settings['subject'] = sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')); |
|
645 | - } |
|
646 | - return $settings; |
|
647 | - } |
|
11 | + /** |
|
12 | + * To field for email |
|
13 | + * @var string |
|
14 | + */ |
|
15 | + protected $_to = ''; |
|
16 | + |
|
17 | + |
|
18 | + /** |
|
19 | + * CC field for email. |
|
20 | + * @var string |
|
21 | + */ |
|
22 | + protected $_cc = ''; |
|
23 | + |
|
24 | + /** |
|
25 | + * From field for email |
|
26 | + * @var string |
|
27 | + */ |
|
28 | + protected $_from = ''; |
|
29 | + |
|
30 | + |
|
31 | + /** |
|
32 | + * Subject field for email |
|
33 | + * @var string |
|
34 | + */ |
|
35 | + protected $_subject = ''; |
|
36 | + |
|
37 | + |
|
38 | + /** |
|
39 | + * Content field for email |
|
40 | + * @var string |
|
41 | + */ |
|
42 | + protected $_content = ''; |
|
43 | + |
|
44 | + |
|
45 | + /** |
|
46 | + * constructor |
|
47 | + * |
|
48 | + * @access public |
|
49 | + */ |
|
50 | + public function __construct() |
|
51 | + { |
|
52 | + //set name and description properties |
|
53 | + $this->name = 'email'; |
|
54 | + $this->description = sprintf( |
|
55 | + esc_html__( |
|
56 | + 'This messenger delivers messages via email using the built-in %s function included with WordPress', |
|
57 | + 'event_espresso' |
|
58 | + ), |
|
59 | + '<code>wp_mail</code>' |
|
60 | + ); |
|
61 | + $this->label = array( |
|
62 | + 'singular' => esc_html__('email', 'event_espresso'), |
|
63 | + 'plural' => esc_html__('emails', 'event_espresso'), |
|
64 | + ); |
|
65 | + $this->activate_on_install = true; |
|
66 | + |
|
67 | + //we're using defaults so let's call parent constructor that will take care of setting up all the other |
|
68 | + // properties |
|
69 | + parent::__construct(); |
|
70 | + } |
|
71 | + |
|
72 | + |
|
73 | + /** |
|
74 | + * see abstract declaration in parent class for details. |
|
75 | + */ |
|
76 | + protected function _set_admin_pages() |
|
77 | + { |
|
78 | + $this->admin_registered_pages = array( |
|
79 | + 'events_edit' => true, |
|
80 | + ); |
|
81 | + } |
|
82 | + |
|
83 | + |
|
84 | + /** |
|
85 | + * see abstract declaration in parent class for details |
|
86 | + */ |
|
87 | + protected function _set_valid_shortcodes() |
|
88 | + { |
|
89 | + //remember by leaving the other fields not set, those fields will inherit the valid shortcodes from the |
|
90 | + // message type. |
|
91 | + $this->_valid_shortcodes = array( |
|
92 | + 'to' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'), |
|
93 | + 'cc' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'), |
|
94 | + 'from' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'), |
|
95 | + ); |
|
96 | + } |
|
97 | + |
|
98 | + |
|
99 | + /** |
|
100 | + * see abstract declaration in parent class for details |
|
101 | + * |
|
102 | + * @access protected |
|
103 | + * @return void |
|
104 | + */ |
|
105 | + protected function _set_validator_config() |
|
106 | + { |
|
107 | + $valid_shortcodes = $this->get_valid_shortcodes(); |
|
108 | + |
|
109 | + $this->_validator_config = array( |
|
110 | + 'to' => array( |
|
111 | + 'shortcodes' => $valid_shortcodes['to'], |
|
112 | + 'type' => 'email', |
|
113 | + ), |
|
114 | + 'cc' => array( |
|
115 | + 'shortcodes' => $valid_shortcodes['to'], |
|
116 | + 'type' => 'email', |
|
117 | + ), |
|
118 | + 'from' => array( |
|
119 | + 'shortcodes' => $valid_shortcodes['from'], |
|
120 | + 'type' => 'email', |
|
121 | + ), |
|
122 | + 'subject' => array( |
|
123 | + 'shortcodes' => array( |
|
124 | + 'organization', |
|
125 | + 'primary_registration_details', |
|
126 | + 'event_author', |
|
127 | + 'primary_registration_details', |
|
128 | + 'recipient_details', |
|
129 | + ), |
|
130 | + ), |
|
131 | + 'content' => array( |
|
132 | + 'shortcodes' => array( |
|
133 | + 'event_list', |
|
134 | + 'attendee_list', |
|
135 | + 'ticket_list', |
|
136 | + 'organization', |
|
137 | + 'primary_registration_details', |
|
138 | + 'primary_registration_list', |
|
139 | + 'event_author', |
|
140 | + 'recipient_details', |
|
141 | + 'recipient_list', |
|
142 | + 'transaction', |
|
143 | + 'messenger', |
|
144 | + ), |
|
145 | + ), |
|
146 | + 'attendee_list' => array( |
|
147 | + 'shortcodes' => array('attendee', 'event_list', 'ticket_list'), |
|
148 | + 'required' => array('[ATTENDEE_LIST]'), |
|
149 | + ), |
|
150 | + 'event_list' => array( |
|
151 | + 'shortcodes' => array( |
|
152 | + 'event', |
|
153 | + 'attendee_list', |
|
154 | + 'ticket_list', |
|
155 | + 'venue', |
|
156 | + 'datetime_list', |
|
157 | + 'attendee', |
|
158 | + 'primary_registration_details', |
|
159 | + 'primary_registration_list', |
|
160 | + 'event_author', |
|
161 | + 'recipient_details', |
|
162 | + 'recipient_list', |
|
163 | + ), |
|
164 | + 'required' => array('[EVENT_LIST]'), |
|
165 | + ), |
|
166 | + 'ticket_list' => array( |
|
167 | + 'shortcodes' => array( |
|
168 | + 'event_list', |
|
169 | + 'attendee_list', |
|
170 | + 'ticket', |
|
171 | + 'datetime_list', |
|
172 | + 'primary_registration_details', |
|
173 | + 'recipient_details', |
|
174 | + ), |
|
175 | + 'required' => array('[TICKET_LIST]'), |
|
176 | + ), |
|
177 | + 'datetime_list' => array( |
|
178 | + 'shortcodes' => array('datetime'), |
|
179 | + 'required' => array('[DATETIME_LIST]'), |
|
180 | + ), |
|
181 | + ); |
|
182 | + } |
|
183 | + |
|
184 | + |
|
185 | + /** |
|
186 | + * @see parent EE_messenger class for docs |
|
187 | + * @since 4.5.0 |
|
188 | + */ |
|
189 | + public function do_secondary_messenger_hooks($sending_messenger_name) |
|
190 | + { |
|
191 | + if ($sending_messenger_name = 'html') { |
|
192 | + add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8); |
|
193 | + } |
|
194 | + } |
|
195 | + |
|
196 | + |
|
197 | + public function add_email_css( |
|
198 | + $variation_path, |
|
199 | + $messenger, |
|
200 | + $message_type, |
|
201 | + $type, |
|
202 | + $variation, |
|
203 | + $file_extension, |
|
204 | + $url, |
|
205 | + EE_Messages_Template_Pack $template_pack |
|
206 | + ) { |
|
207 | + //prevent recursion on this callback. |
|
208 | + remove_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10); |
|
209 | + $variation = $this->get_variation($template_pack, $message_type, $url, 'main', $variation, false); |
|
210 | + |
|
211 | + add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8); |
|
212 | + return $variation; |
|
213 | + } |
|
214 | + |
|
215 | + |
|
216 | + /** |
|
217 | + * See parent for details |
|
218 | + * |
|
219 | + * @access protected |
|
220 | + * @return void |
|
221 | + */ |
|
222 | + protected function _set_test_settings_fields() |
|
223 | + { |
|
224 | + $this->_test_settings_fields = array( |
|
225 | + 'to' => array( |
|
226 | + 'input' => 'text', |
|
227 | + 'label' => esc_html__('Send a test email to', 'event_espresso'), |
|
228 | + 'type' => 'email', |
|
229 | + 'required' => true, |
|
230 | + 'validation' => true, |
|
231 | + 'css_class' => 'large-text', |
|
232 | + 'format' => '%s', |
|
233 | + 'default' => get_bloginfo('admin_email'), |
|
234 | + ), |
|
235 | + 'subject' => array( |
|
236 | + 'input' => 'hidden', |
|
237 | + 'label' => '', |
|
238 | + 'type' => 'string', |
|
239 | + 'required' => false, |
|
240 | + 'validation' => false, |
|
241 | + 'format' => '%s', |
|
242 | + 'value' => sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')), |
|
243 | + 'default' => '', |
|
244 | + 'css_class' => '', |
|
245 | + ), |
|
246 | + ); |
|
247 | + } |
|
248 | + |
|
249 | + |
|
250 | + /** |
|
251 | + * _set_template_fields |
|
252 | + * This sets up the fields that a messenger requires for the message to go out. |
|
253 | + * |
|
254 | + * @access protected |
|
255 | + * @return void |
|
256 | + */ |
|
257 | + protected function _set_template_fields() |
|
258 | + { |
|
259 | + // any extra template fields that are NOT used by the messenger but will get used by a messenger field for |
|
260 | + // shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field |
|
261 | + // they relate to. This is important for the Messages_admin to know what fields to display to the user. |
|
262 | + // Also, notice that the "values" are equal to the field type that messages admin will use to know what |
|
263 | + // kind of field to display. The values ALSO have one index labeled "shortcode". the values in that array |
|
264 | + // indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be |
|
265 | + // displayed. If the required shortcode isn't part of the shortcodes array then the field is not needed and |
|
266 | + // will not be displayed/parsed. |
|
267 | + $this->_template_fields = array( |
|
268 | + 'to' => array( |
|
269 | + 'input' => 'text', |
|
270 | + 'label' => esc_html_x( |
|
271 | + 'To', |
|
272 | + 'Label for the "To" field for email addresses', |
|
273 | + 'event_espresso' |
|
274 | + ), |
|
275 | + 'type' => 'string', |
|
276 | + 'required' => true, |
|
277 | + 'validation' => true, |
|
278 | + 'css_class' => 'large-text', |
|
279 | + 'format' => '%s', |
|
280 | + ), |
|
281 | + 'cc' => array( |
|
282 | + 'input' => 'text', |
|
283 | + 'label' => esc_html_x( |
|
284 | + 'CC', |
|
285 | + 'Label for the "Carbon Copy" field used for additional email addresses', |
|
286 | + 'event_espresso' |
|
287 | + ), |
|
288 | + 'type' => 'string', |
|
289 | + 'required' => false, |
|
290 | + 'validation' => true, |
|
291 | + 'css_class' => 'large-text', |
|
292 | + 'format' => '%s', |
|
293 | + ), |
|
294 | + 'from' => array( |
|
295 | + 'input' => 'text', |
|
296 | + 'label' => esc_html_x( |
|
297 | + 'From', |
|
298 | + 'Label for the "From" field for email addresses.', |
|
299 | + 'event_espresso' |
|
300 | + ), |
|
301 | + 'type' => 'string', |
|
302 | + 'required' => true, |
|
303 | + 'validation' => true, |
|
304 | + 'css_class' => 'large-text', |
|
305 | + 'format' => '%s', |
|
306 | + ), |
|
307 | + 'subject' => array( |
|
308 | + 'input' => 'text', |
|
309 | + 'label' => esc_html_x( |
|
310 | + 'Subject', |
|
311 | + 'Label for the "Subject" field (short description of contents) for emails.', |
|
312 | + 'event_espresso' |
|
313 | + ), |
|
314 | + 'type' => 'string', |
|
315 | + 'required' => true, |
|
316 | + 'validation' => true, |
|
317 | + 'css_class' => 'large-text', |
|
318 | + 'format' => '%s', |
|
319 | + ), |
|
320 | + 'content' => '', |
|
321 | + //left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field. |
|
322 | + 'extra' => array( |
|
323 | + 'content' => array( |
|
324 | + 'main' => array( |
|
325 | + 'input' => 'wp_editor', |
|
326 | + 'label' => esc_html__('Main Content', 'event_espresso'), |
|
327 | + 'type' => 'string', |
|
328 | + 'required' => true, |
|
329 | + 'validation' => true, |
|
330 | + 'format' => '%s', |
|
331 | + 'rows' => '15', |
|
332 | + ), |
|
333 | + 'event_list' => array( |
|
334 | + 'input' => 'wp_editor', |
|
335 | + 'label' => '[EVENT_LIST]', |
|
336 | + 'type' => 'string', |
|
337 | + 'required' => true, |
|
338 | + 'validation' => true, |
|
339 | + 'format' => '%s', |
|
340 | + 'rows' => '15', |
|
341 | + 'shortcodes_required' => array('[EVENT_LIST]'), |
|
342 | + ), |
|
343 | + 'attendee_list' => array( |
|
344 | + 'input' => 'textarea', |
|
345 | + 'label' => '[ATTENDEE_LIST]', |
|
346 | + 'type' => 'string', |
|
347 | + 'required' => true, |
|
348 | + 'validation' => true, |
|
349 | + 'format' => '%s', |
|
350 | + 'css_class' => 'large-text', |
|
351 | + 'rows' => '5', |
|
352 | + 'shortcodes_required' => array('[ATTENDEE_LIST]'), |
|
353 | + ), |
|
354 | + 'ticket_list' => array( |
|
355 | + 'input' => 'textarea', |
|
356 | + 'label' => '[TICKET_LIST]', |
|
357 | + 'type' => 'string', |
|
358 | + 'required' => true, |
|
359 | + 'validation' => true, |
|
360 | + 'format' => '%s', |
|
361 | + 'css_class' => 'large-text', |
|
362 | + 'rows' => '10', |
|
363 | + 'shortcodes_required' => array('[TICKET_LIST]'), |
|
364 | + ), |
|
365 | + 'datetime_list' => array( |
|
366 | + 'input' => 'textarea', |
|
367 | + 'label' => '[DATETIME_LIST]', |
|
368 | + 'type' => 'string', |
|
369 | + 'required' => true, |
|
370 | + 'validation' => true, |
|
371 | + 'format' => '%s', |
|
372 | + 'css_class' => 'large-text', |
|
373 | + 'rows' => '10', |
|
374 | + 'shortcodes_required' => array('[DATETIME_LIST]'), |
|
375 | + ), |
|
376 | + ), |
|
377 | + ), |
|
378 | + ); |
|
379 | + } |
|
380 | + |
|
381 | + |
|
382 | + /** |
|
383 | + * See definition of this class in parent |
|
384 | + */ |
|
385 | + protected function _set_default_message_types() |
|
386 | + { |
|
387 | + $this->_default_message_types = array( |
|
388 | + 'payment', |
|
389 | + 'payment_refund', |
|
390 | + 'registration', |
|
391 | + 'not_approved_registration', |
|
392 | + 'pending_approval', |
|
393 | + ); |
|
394 | + } |
|
395 | + |
|
396 | + |
|
397 | + /** |
|
398 | + * @see definition of this class in parent |
|
399 | + * @since 4.5.0 |
|
400 | + */ |
|
401 | + protected function _set_valid_message_types() |
|
402 | + { |
|
403 | + $this->_valid_message_types = array( |
|
404 | + 'payment', |
|
405 | + 'registration', |
|
406 | + 'not_approved_registration', |
|
407 | + 'declined_registration', |
|
408 | + 'cancelled_registration', |
|
409 | + 'pending_approval', |
|
410 | + 'registration_summary', |
|
411 | + 'payment_reminder', |
|
412 | + 'payment_declined', |
|
413 | + 'payment_refund', |
|
414 | + ); |
|
415 | + } |
|
416 | + |
|
417 | + |
|
418 | + /** |
|
419 | + * setting up admin_settings_fields for messenger. |
|
420 | + */ |
|
421 | + protected function _set_admin_settings_fields() |
|
422 | + { |
|
423 | + } |
|
424 | + |
|
425 | + /** |
|
426 | + * We just deliver the messages don't kill us!! |
|
427 | + * |
|
428 | + * @return bool|WP_Error true if message delivered, false if it didn't deliver OR bubble up any error object if |
|
429 | + * present. |
|
430 | + * @throws EE_Error |
|
431 | + * @throws \TijsVerkoyen\CssToInlineStyles\Exception |
|
432 | + */ |
|
433 | + protected function _send_message() |
|
434 | + { |
|
435 | + $success = wp_mail( |
|
436 | + $this->_to, |
|
437 | + $this->_subject, |
|
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 | + if (! empty($this->_cc)) { |
|
491 | + $headers[] = 'cc: ' . $this->_cc; |
|
492 | + } |
|
493 | + |
|
494 | + //but wait! Header's for the from is NOT reliable because some plugins don't respect From: as set in the |
|
495 | + // header. |
|
496 | + add_filter('wp_mail_from', array($this, 'set_from_address'), 100); |
|
497 | + add_filter('wp_mail_from_name', array($this, 'set_from_name'), 100); |
|
498 | + return apply_filters('FHEE__EE_Email_messenger___headers', $headers, $this->_incoming_message_type, $this); |
|
499 | + } |
|
500 | + |
|
501 | + |
|
502 | + /** |
|
503 | + * This simply ensures that the from address is not empty. If it is, then we use whatever is set as the site email |
|
504 | + * address for the from address to avoid problems with sending emails. |
|
505 | + */ |
|
506 | + protected function _ensure_has_from_email_address() |
|
507 | + { |
|
508 | + if (empty($this->_from)) { |
|
509 | + $this->_from = get_bloginfo('admin_email'); |
|
510 | + } |
|
511 | + } |
|
512 | + |
|
513 | + |
|
514 | + /** |
|
515 | + * This simply parses whatever is set as the $_from address and determines if it is in the format {name} <{email}> |
|
516 | + * or just {email} and returns an array with the "from_name" and "from_email" as the values. Note from_name *MAY* |
|
517 | + * be empty |
|
518 | + * |
|
519 | + * @since 4.3.1 |
|
520 | + * @return array |
|
521 | + */ |
|
522 | + private function _parse_from() |
|
523 | + { |
|
524 | + if (strpos($this->_from, '<') !== false) { |
|
525 | + $from_name = substr($this->_from, 0, strpos($this->_from, '<') - 1); |
|
526 | + $from_name = str_replace('"', '', $from_name); |
|
527 | + $from_name = trim($from_name); |
|
528 | + |
|
529 | + $from_email = substr($this->_from, strpos($this->_from, '<') + 1); |
|
530 | + $from_email = str_replace('>', '', $from_email); |
|
531 | + $from_email = trim($from_email); |
|
532 | + } elseif (trim($this->_from) !== '') { |
|
533 | + $from_name = ''; |
|
534 | + $from_email = trim($this->_from); |
|
535 | + } else { |
|
536 | + $from_name = $from_email = ''; |
|
537 | + } |
|
538 | + return array($from_name, $from_email); |
|
539 | + } |
|
540 | + |
|
541 | + |
|
542 | + /** |
|
543 | + * Callback for the wp_mail_from filter. |
|
544 | + * |
|
545 | + * @since 4.3.1 |
|
546 | + * @param string $from_email What the original from_email is. |
|
547 | + * @return string |
|
548 | + */ |
|
549 | + public function set_from_address($from_email) |
|
550 | + { |
|
551 | + $parsed_from = $this->_parse_from(); |
|
552 | + //includes fallback if the parsing failed. |
|
553 | + $from_email = is_array($parsed_from) && ! empty($parsed_from[1]) |
|
554 | + ? $parsed_from[1] |
|
555 | + : get_bloginfo('admin_email'); |
|
556 | + return $from_email; |
|
557 | + } |
|
558 | + |
|
559 | + |
|
560 | + /** |
|
561 | + * Callback fro the wp_mail_from_name filter. |
|
562 | + * |
|
563 | + * @since 4.3.1 |
|
564 | + * @param string $from_name The original from_name. |
|
565 | + * @return string |
|
566 | + */ |
|
567 | + public function set_from_name($from_name) |
|
568 | + { |
|
569 | + $parsed_from = $this->_parse_from(); |
|
570 | + if (is_array($parsed_from) && ! empty($parsed_from[0])) { |
|
571 | + $from_name = $parsed_from[0]; |
|
572 | + } |
|
573 | + |
|
574 | + //if from name is "WordPress" let's sub in the site name instead (more friendly!) |
|
575 | + $from_name = $from_name == 'WordPress' ? get_bloginfo() : $from_name; |
|
576 | + |
|
577 | + return $from_name; |
|
578 | + } |
|
579 | + |
|
580 | + |
|
581 | + /** |
|
582 | + * setup body for email |
|
583 | + * |
|
584 | + * @param bool $preview will determine whether this is preview template or not. |
|
585 | + * @return string formatted body for email. |
|
586 | + * @throws EE_Error |
|
587 | + * @throws \TijsVerkoyen\CssToInlineStyles\Exception |
|
588 | + */ |
|
589 | + protected function _body($preview = false) |
|
590 | + { |
|
591 | + //setup template args! |
|
592 | + $this->_template_args = array( |
|
593 | + 'subject' => $this->_subject, |
|
594 | + 'from' => $this->_from, |
|
595 | + 'main_body' => wpautop($this->_content), |
|
596 | + ); |
|
597 | + $body = $this->_get_main_template($preview); |
|
598 | + |
|
599 | + /** |
|
600 | + * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched. |
|
601 | + * |
|
602 | + * @type bool $preview Indicates whether a preview is being generated or not. |
|
603 | + * @return bool true indicates to use the inliner, false bypasses it. |
|
604 | + */ |
|
605 | + if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) { |
|
606 | + //require CssToInlineStyles library and its dependencies via composer autoloader |
|
607 | + require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php'; |
|
608 | + |
|
609 | + //now if this isn't a preview, let's setup the body so it has inline styles |
|
610 | + if (! $preview || ($preview && defined('DOING_AJAX'))) { |
|
611 | + $style = file_get_contents( |
|
612 | + $this->get_variation( |
|
613 | + $this->_tmp_pack, |
|
614 | + $this->_incoming_message_type->name, |
|
615 | + false, |
|
616 | + 'main', |
|
617 | + $this->_variation |
|
618 | + ), |
|
619 | + true |
|
620 | + ); |
|
621 | + $CSS = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles($body, $style); |
|
622 | + //for some reason the library has a bracket and new line at the beginning. This takes care of that. |
|
623 | + $body = ltrim($CSS->convert(true), ">\n"); |
|
624 | + //see https://events.codebasehq.com/projects/event-espresso/tickets/8609 |
|
625 | + $body = ltrim($body, "<?"); |
|
626 | + } |
|
627 | + |
|
628 | + } |
|
629 | + return $body; |
|
630 | + } |
|
631 | + |
|
632 | + |
|
633 | + /** |
|
634 | + * This just returns any existing test settings that might be saved in the database |
|
635 | + * |
|
636 | + * @access public |
|
637 | + * @return array |
|
638 | + */ |
|
639 | + public function get_existing_test_settings() |
|
640 | + { |
|
641 | + $settings = parent::get_existing_test_settings(); |
|
642 | + //override subject if present because we always want it to be fresh. |
|
643 | + if (is_array($settings) && ! empty($settings['subject'])) { |
|
644 | + $settings['subject'] = sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')); |
|
645 | + } |
|
646 | + return $settings; |
|
647 | + } |
|
648 | 648 | } |
@@ -58,7 +58,7 @@ discard block |
||
58 | 58 | ), |
59 | 59 | '<code>wp_mail</code>' |
60 | 60 | ); |
61 | - $this->label = array( |
|
61 | + $this->label = array( |
|
62 | 62 | 'singular' => esc_html__('email', 'event_espresso'), |
63 | 63 | 'plural' => esc_html__('emails', 'event_espresso'), |
64 | 64 | ); |
@@ -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,13 +482,13 @@ 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 | |
490 | - if (! empty($this->_cc)) { |
|
491 | - $headers[] = 'cc: ' . $this->_cc; |
|
490 | + if ( ! empty($this->_cc)) { |
|
491 | + $headers[] = 'cc: '.$this->_cc; |
|
492 | 492 | } |
493 | 493 | |
494 | 494 | //but wait! Header's for the from is NOT reliable because some plugins don't respect From: as set in the |
@@ -594,7 +594,7 @@ discard block |
||
594 | 594 | 'from' => $this->_from, |
595 | 595 | 'main_body' => wpautop($this->_content), |
596 | 596 | ); |
597 | - $body = $this->_get_main_template($preview); |
|
597 | + $body = $this->_get_main_template($preview); |
|
598 | 598 | |
599 | 599 | /** |
600 | 600 | * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched. |
@@ -604,10 +604,10 @@ discard block |
||
604 | 604 | */ |
605 | 605 | if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) { |
606 | 606 | //require CssToInlineStyles library and its dependencies via composer autoloader |
607 | - require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php'; |
|
607 | + require_once EE_THIRD_PARTY.'cssinliner/vendor/autoload.php'; |
|
608 | 608 | |
609 | 609 | //now if this isn't a preview, let's setup the body so it has inline styles |
610 | - if (! $preview || ($preview && defined('DOING_AJAX'))) { |
|
610 | + if ( ! $preview || ($preview && defined('DOING_AJAX'))) { |
|
611 | 611 | $style = file_get_contents( |
612 | 612 | $this->get_variation( |
613 | 613 | $this->_tmp_pack, |