supportcandy / includes / custom-field-types / class-wpsc-df-last-reply-source.php

class-wpsc-df-last-reply-source.php in SupportCandy – AI Customer Support Ticket System & Live Chatbot Agent 3.5.4, at includes/custom-field-types/class-wpsc-df-last-reply-source.php

507 lines 14.2 KB

Raw Download Zip

1	<?php
2	if ( ! defined( 'ABSPATH' ) ) {
3	exit; // Exit if accessed directly!
4	}
5
6	if ( ! class_exists( 'WPSC_DF_Last_Reply_Source' ) ) :
7
8	final class WPSC_DF_Last_Reply_Source {
9
10	/**
11	* Slug for this custom field type
12	*
13	* @var string
14	*/
15	public static $slug = 'df_last_reply_source';
16
17	/**
18	* Set whether this custom field type is of type date
19	*
20	* @var boolean
21	*/
22	public static $is_date = false;
23
24	/**
25	* Set whether this custom field type has applicable to date range
26	*
27	* @var boolean
28	*/
29	public static $has_date_range = false;
30
31	/**
32	* Set whether this custom field type has multiple values
33	*
34	* @var boolean
35	*/
36	public static $has_multiple_val = false;
37
38	/**
39	* Data type for column created in tickets table
40	*
41	* @var string
42	*/
43	public static $data_type = 'VARCHAR(50) NULL';
44
45	/**
46	* Set whether this custom field type has reference to other class
47	*
48	* @var boolean
49	*/
50	public static $has_ref = false;
51
52	/**
53	* Reference class for this custom field type so that its value(s) return with object or array of objects automatically. Empty string indicate no reference.
54	*
55	* @var string
56	*/
57	public static $ref_class = '';
58
59	/**
60	* Set whether this custom field field type is system default (no fields can be created from it).
61	*
62	* @var boolean
63	*/
64	public static $is_default = true;
65
66	/**
67	* Set whether this field type has extra information that can be used in ticket form, edit custom fields, etc.
68	*
69	* @var boolean
70	*/
71	public static $has_extra_info = false;
72
73	/**
74	* Set whether this custom field type can accept personal info.
75	*
76	* @var boolean
77	*/
78	public static $has_personal_info = false;
79
80	/**
81	* Set whether fields created from this custom field type is allowed in create ticket form
82	*
83	* @var boolean
84	*/
85	public static $is_ctf = false;
86
87	/**
88	* Set whether fields created from this custom field type is allowed in ticket list
89	*
90	* @var boolean
91	*/
92	public static $is_list = false;
93
94	/**
95	* Set whether fields created from this custom field type is allowed in ticket filter
96	*
97	* @var boolean
98	*/
99	public static $is_filter = true;
100
101	/**
102	* Set whether fields created from this custom field type can be given character limits
103	*
104	* @var boolean
105	*/
106	public static $has_char_limit = false;
107
108	/**
109	* Set whether fields created from this custom field type has custom options set in options table
110	*
111	* @var boolean
112	*/
113	public static $has_options = false;
114
115	/**
116	* Set whether fields created from this custom field type can be auto-filled
117	*
118	* @var boolean
119	*/
120	public static $is_auto_fill = false;
121
122	/**
123	* Set whether fields created from this custom field type can be available for ticket list sorting
124	*
125	* @var boolean
126	*/
127	public static $is_sort = false;
128
129	/**
130	* Set whether fields created from this custom field type can have placeholder
131	*
132	* @var boolean
133	*/
134	public static $is_placeholder = false;
135
136	/**
137	* Set whether fields created from this custom field type is applicable for visibility conditions in create ticket form
138	*
139	* @var boolean
140	*/
141	public static $is_visibility_conditions = false;
142
143	/**
144	* Set whether fields created from this custom field type is applicable for macros
145	*
146	* @var boolean
147	*/
148	public static $has_macro = false;
149
150	/**
151	* Source list
152	*
153	* @var boolean
154	*/
155	public static $sources = array();
156
157	/**
158	* Set whether fields of this custom field type is applicalbe for search on ticket list page.
159	*
160	* @var boolean
161	*/
162	public static $is_search = false;
163
164	/**
165	* Initialize the class
166	*
167	* @return void
168	*/
169	public static function init() {
170
171	// Get object of this class.
172	add_filter( 'wpsc_load_ref_classes', array( __CLASS__, 'load_ref_class' ) );
173
174	// ticket form.
175	add_filter( 'wpsc_create_ticket_data', array( __CLASS__, 'set_create_ticket_data' ), 10, 3 );
176
177	// create ticket data for rest api.
178	add_filter( 'wpsc_rest_create_ticket', array( __CLASS__, 'set_rest_ticket_data' ), 10, 3 );
179
180	// source list.
181	add_action( 'init', array( __CLASS__, 'load_last_reply_sources' ) );
182
183	// Set custom field type.
184	add_filter( 'wpsc_default_cf_types', array( __CLASS__, 'default_cf_types' ), 4 );
185	}
186
187	/**
188	* Load current class to reference classes
189	*
190	* @param array $classes - Associative array of class names indexed by its slug.
191	* @return array
192	*/
193	public static function load_ref_class( $classes ) {
194
195	$classes[ self::$slug ] = array(
196	'class' => __CLASS__,
197	'save-key' => 'id',
198	);
199	return $classes;
200	}
201
202	/**
203	* Add default custom field type to list
204	*
205	* @param array $default_cf_types - default custom field types array.
206	* @return array
207	*/
208	public static function default_cf_types( $default_cf_types ) {
209	$default_cf_types[ self::$slug ] = array(
210	'label' => esc_attr__( 'Last Reply Source', 'supportcandy' ),
211	'class' => __CLASS__,
212	);
213	return $default_cf_types;
214	}
215
216	/**
217	* Load last reply source list
218	*
219	* @return void
220	*/
221	public static function load_last_reply_sources() {
222
223	self::$sources = apply_filters(
224	'wpsc_last_reply_source_list',
225	array(
226	'browser' => __( 'Browser', 'supportcandy' ),
227	'rest-api' => 'REST API',
228	)
229	);
230	}
231
232	/**
233	* Print operators for ticket form filter
234	*
235	* @param WPSC_Custom_Field $cf - custom field object.
236	* @param array $filter - Existing filters (if any).
237	* @return void
238	*/
239	public static function get_operators( $cf, $filter = array() ) {
240	?>
241
242	<div class="item conditional">
243	<select class="operator" onchange="wpsc_tc_get_operand(this, '<?php echo esc_attr( $cf->slug ); ?>', '<?php echo esc_attr( wp_create_nonce( 'wpsc_tc_get_operand' ) ); ?>');">
244	<option value=""><?php esc_attr_e( 'Compare As', 'supportcandy' ); ?></option>
245	<option <?php isset( $filter['operator'] ) && selected( $filter['operator'], '=' ); ?> value="="><?php esc_attr_e( 'Equals', 'supportcandy' ); ?></option>
246	<option <?php isset( $filter['operator'] ) && selected( $filter['operator'], 'IN' ); ?> value="IN"><?php esc_attr_e( 'Matches', 'supportcandy' ); ?></option>
247	<option <?php isset( $filter['operator'] ) && selected( $filter['operator'], 'NOT IN' ); ?> value="NOT IN"><?php esc_attr_e( 'Not Matches', 'supportcandy' ); ?></option>
248	</select>
249	</div>
250	<?php
251	}
252
253	/**
254	* Print operators for ticket form filter
255	*
256	* @param string $operator - condition operator on which operands should be returned.
257	* @param WPSC_Custom_Field $cf - custom field object.
258	* @param array $filter - Exising functions (if any).
259	* @return void
260	*/
261	public static function get_operands( $operator, $cf, $filter = array() ) {
262
263	$is_multiple = $operator !== '=' ? true : false;
264	$unique_id = uniqid( 'wpsc_' );
265	?>
266
267	<div class="item conditional operand single">
268	<select class="operand_val_1 <?php echo esc_attr( $unique_id ); ?>" <?php echo $is_multiple ? 'multiple' : ''; ?>>
269	<?php
270	foreach ( self::$sources as $key => $label ) {
271	$selected = '';
272	if (
273	isset( $filter['operand_val_1'] ) &&
274	(
275	( $is_multiple && in_array( $key, $filter['operand_val_1'] ) ) \|\|
276	( ! $is_multiple && $key == $filter['operand_val_1'] )
277	)
278	) {
279	$selected = 'selected';
280	}
281	?>
282	<option <?php echo esc_attr( $selected ); ?> value="<?php echo esc_attr( $key ); ?>"><?php echo esc_attr( $label ); ?></option>
283	<?php
284	}
285	?>
286	</select>
287	</div>
288	<script>jQuery('.operand_val_1.<?php echo esc_attr( $unique_id ); ?>').selectWoo();</script>
289	<?php
290	}
291
292	/**
293	* Parse filter and return sql query to be merged in ticket model query builder
294	*
295	* @param WPSC_Custom_Field $cf - custom field of this type.
296	* @param mixed $compare - comparison operator.
297	* @param mixed $val - value to compare.
298	* @return string
299	*/
300	public static function parse_filter( $cf, $compare, $val ) {
301
302	$slug = is_string( $cf->slug ) ? trim( $cf->slug ) : '';
303	if ( $slug === '' \|\| ! preg_match( '/^[a-zA-Z0-9_]+$/', $slug ) ) {
304	return '1=0';
305	}
306
307	$column = 't.' . $cf->slug;
308
309	// Normalize values → array of clean strings.
310	$values = is_array( $val ) ? $val : array( $val );
311	$clean = array();
312
313	foreach ( $values as $v ) {
314	if ( is_string( $v ) ) {
315	$v = trim( $v );
316	if ( $v !== '' ) {
317	$clean[] = esc_sql( $v );
318	}
319	}
320	}
321
322	if ( empty( $clean ) ) {
323	return '1=0';
324	}
325
326	switch ( $compare ) {
327
328	case '=':
329	return "$column = '{$clean[0]}'";
330
331	case 'IN':
332	return "CONVERT($column USING utf8) IN ('" . implode( "', '", $clean ) . "')";
333
334	case 'NOT IN':
335	return "CONVERT($column USING utf8) NOT IN ('" . implode( "', '", $clean ) . "')";
336
337	default:
338	return '1=1';
339	}
340	}
341
342	/**
343	* Check ticket condition
344	*
345	* @param array $condition - array with condition data.
346	* @param WPSC_Custom_Field $cf - custom field object.
347	* @param WPSC_Ticket $ticket - ticket object.
348	* @return boolean
349	*/
350	public static function is_valid_ticket_condition( $condition, $cf, $ticket ) {
351
352	$flag = true;
353	switch ( $condition['operator'] ) {
354
355	case '=':
356	$flag = $ticket->{$cf->slug} == $condition['operand_val_1'] ? true : false;
357	break;
358
359	case 'IN':
360	$flag = in_array( $ticket->{$cf->slug}, $condition['operand_val_1'] );
361	break;
362
363	case 'NOT IN':
364	$flag = ! in_array( $ticket->{$cf->slug}, $condition['operand_val_1'] );
365	break;
366
367	default:
368	$flag = true;
369	}
370
371	return $flag;
372	}
373
374	/**
375	* Check and return custom field value for new ticket to be created.
376	* This function is used by filter for set create ticket form and called directly by my-profile for each applicable custom fields.
377	* Ignore phpcs nonce issue as we already checked where it is called from.
378	*
379	* @param array $data - Array of values to to stored in ticket in an insert function.
380	* @param array $custom_fields - Array containing all applicable custom fields indexed by unique custom field types.
381	* @param boolean $is_my_profile - Whether it or not it is created from my-profile. This function is used by create ticket as well as my-profile. Due to customer fields handling is done same way, this flag gives apportunity to identify where it being called.
382	* @return array
383	*/
384	public static function set_create_ticket_data( $data, $custom_fields, $is_my_profile ) {
385
386	$data['last_reply_source'] = 'browser';
387	return $data;
388	}
389
390	/**
391	* Set create ticket data for rest api request
392	*
393	* @param array $data - create ticket data array.
394	* @param WP_REST_Request $request - rest request object.
395	* @param array $custom_fields - custom field objects indexed by unique custom field types.
396	* @return array
397	*/
398	public static function set_rest_ticket_data( $data, $request, $custom_fields ) {
399
400	$data['last_reply_source'] = 'rest-api';
401	return $data;
402	}
403
404	/**
405	* Return val field for meta query of this type of custom field
406	*
407	* @param array $condition - condition data.
408	* @return mixed
409	*/
410	public static function get_meta_value( $condition ) {
411
412	$operator = $condition['operator'];
413	switch ( $operator ) {
414
415	case '=':
416	case 'IN':
417	case 'NOT IN':
418	return $condition['operand_val_1'];
419	}
420	return false;
421	}
422
423	/**
424	* Print edit custom field properties
425	*
426	* @param WPSC_Custom_Fields $cf - custom field object.
427	* @param string $field_class - class name of field category.
428	* @return void
429	*/
430	public static function get_edit_custom_field_properties( $cf, $field_class ) {
431
432	if ( in_array( 'tl_width', $field_class::$allowed_properties ) ) :
433	?>
434	<div data-type="number" data-required="false" class="wpsc-input-group tl_width">
435	<div class="label-container">
436	<label for="">
437	<?php esc_attr_e( 'Ticket list width (pixels)', 'supportcandy' ); ?>
438	</label>
439	</div>
440	<input type="number" name="tl_width" value="<?php echo intval( $cf->tl_width ); ?>" autocomplete="off">
441	</div>
442	<?php
443	endif;
444	}
445
446	/**
447	* Set custom field properties. Can be used by add/edit custom field.
448	* Ignore phpcs nonce issue as we already checked where it is called from.
449	*
450	* @param WPSC_Custom_Field $cf - custom field object.
451	* @param string $field_class - class of field category.
452	* @return void
453	*/
454	public static function set_cf_properties( $cf, $field_class ) {
455
456	// tl_width!
457	if ( in_array( 'tl_width', $field_class::$allowed_properties ) ) {
458	$tl_width = isset( $_POST['tl_width'] ) ? intval( $_POST['tl_width'] ) : 0; // phpcs:ignore
459	$cf->tl_width = $tl_width ? $tl_width : 100;
460	}
461
462	// save!
463	$cf->save();
464	}
465
466	/**
467	* Returns printable ticket value for custom field. Can be used in export tickets, replace macros etc.
468	*
469	* @param WPSC_Custom_Field $cf - custom field object.
470	* @param WPSC_Ticket $ticket - ticket object.
471	* @param string $module - module name.
472	* @return string
473	*/
474	public static function get_ticket_field_val( $cf, $ticket, $module = '' ) {
475
476	$value = $ticket->{$cf->slug} && isset( self::$sources[ $ticket->{$cf->slug} ] ) ? self::$sources[ $ticket->{$cf->slug} ] : '';
477	return apply_filters( 'wpsc_ticket_field_val_last_reply_source', $value, $cf, $ticket, $module );
478	}
479
480	/**
481	* Print ticket value for given custom field on ticket list
482	*
483	* @param WPSC_Custom_Field $cf - custom field object.
484	* @param WPSC_Ticket $ticket - ticket object.
485	* @return void
486	*/
487	public static function print_tl_ticket_field_val( $cf, $ticket ) {
488
489	echo $ticket->{$cf->slug} && isset( self::$sources[ $ticket->{$cf->slug} ] ) ? esc_attr( self::$sources[ $ticket->{$cf->slug} ] ) : '';
490	}
491
492	/**
493	* Print ticket value for given custom field on widget
494	*
495	* @param WPSC_Custom_Field $cf - custom field object.
496	* @param WPSC_Ticket $ticket - ticket object.
497	* @return void
498	*/
499	public static function print_widget_ticket_field_val( $cf, $ticket ) {
500
501	echo $ticket->{$cf->slug} && isset( self::$sources[ $ticket->{$cf->slug} ] ) ? esc_attr( self::$sources[ $ticket->{$cf->slug} ] ) : esc_attr__( 'Not Applicable', 'supportcandy' );
502	}
503	}
504	endif;
505
506	WPSC_DF_Last_Reply_Source::init();
507