supportcandy / includes / custom-field-types / class-wpsc-df-customer-name.php

class-wpsc-df-customer-name.php in SupportCandy – AI Customer Support Ticket System & Live Chatbot Agent 3.4.3, at includes/custom-field-types/class-wpsc-df-customer-name.php

391 lines 10.3 KB

Raw Download Zip

1	<?php
2	if ( ! defined( 'ABSPATH' ) ) {
3	exit; // Exit if accessed directly!
4	}
5
6	if ( ! class_exists( 'WPSC_DF_Customer_Name' ) ) :
7
8	final class WPSC_DF_Customer_Name {
9
10	/**
11	* Slug for this custom field type
12	*
13	* @var string
14	*/
15	public static $slug = 'df_customer_name';
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 field type is system default (no fields can be created from it).
33	*
34	* @var boolean
35	*/
36	public static $is_default = true;
37
38	/**
39	* Set whether this field type has extra information that can be used in ticket form, edit custom fields, etc.
40	*
41	* @var boolean
42	*/
43	public static $has_extra_info = true;
44
45	/**
46	* Set whether this custom field type can accept personal info.
47	*
48	* @var boolean
49	*/
50	public static $has_personal_info = true;
51
52	/**
53	* Set whether this custom field type has multiple values
54	*
55	* @var boolean
56	*/
57	public static $has_multiple_val = false;
58
59	/**
60	* Set whether this custom field type has reference to other class
61	*
62	* @var boolean
63	*/
64	public static $has_ref = false;
65
66	/**
67	* 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.
68	*
69	* @var string
70	*/
71	public static $ref_class = '';
72
73	/**
74	* Data type for column created in customer table
75	*
76	* @var string
77	*/
78	public static $data_type = 'VARCHAR(200) NOT NULL';
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 = true;
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 = true;
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 = false;
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 available for ticket list sorting
117	*
118	* @var boolean
119	*/
120	public static $is_sort = true;
121
122	/**
123	* Set whether fields created from this custom field type can be auto-filled
124	*
125	* @var boolean
126	*/
127	public static $is_auto_fill = 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 = true;
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 = true;
149
150	/**
151	* Set whether fields of this custom field type is applicalbe for search on ticket list page.
152	*
153	* @var boolean
154	*/
155	public static $is_search = false;
156
157	/**
158	* Initialize the class
159	*
160	* @return void
161	*/
162	public static function init() {
163
164	// Get object of this class.
165	add_filter( 'wpsc_load_ref_classes', array( __CLASS__, 'load_ref_class' ) );
166
167	// TFF!
168	add_action( 'wpsc_js_validate_ticket_form', array( __CLASS__, 'js_validate_ticket_form' ) );
169	}
170
171	/**
172	* Load current class to reference classes
173	*
174	* @param array $classes - Associative array of class names indexed by its slug.
175	* @return array
176	*/
177	public static function load_ref_class( $classes ) {
178
179	$classes[ self::$slug ] = array(
180	'class' => __CLASS__,
181	'save-key' => 'id',
182	);
183	return $classes;
184	}
185
186	/**
187	* Print ticket form field
188	*
189	* @param WPSC_Custom_Field $cf - Custom field object.
190	* @param array $tff - Array of ticket form field settings for this field.
191	* @return string
192	*/
193	public static function print_tff( $cf, $tff ) {
194
195	$current_user = WPSC_Current_User::$current_user;
196	ob_start();
197	if ( ! $current_user->is_customer ) {?>
198
199	<div class="<?php echo esc_attr( WPSC_Functions::get_tff_classes( $cf, $tff ) ); ?>" data-cft="<?php echo esc_attr( self::$slug ); ?>">
200	<div class="wpsc-tff-label">
201	<span class="name"><?php echo esc_attr( $cf->name ); ?></span>
202	<?php
203	if ( $tff['is-required'] ) {
204	?>
205	<span class="required-indicator">*</span>
206	<?php
207	}
208	?>
209	</div>
210	<span class="extra-info"><?php echo esc_attr( $cf->extra_info ); ?></span>
211	<input
212	type="text"
213	class="<?php echo esc_attr( $cf->slug ); ?>"
214	name="<?php echo esc_attr( $cf->slug ); ?>"
215	placeholder="<?php echo esc_attr( $cf->placeholder_text ); ?>"
216	autocomplete="off"/>
217	</div>
218	<?php
219
220	} else {
221	?>
222
223	<input
224	type="hidden"
225	class="<?php echo esc_attr( $cf->slug ); ?>"
226	name="<?php echo esc_attr( $cf->slug ); ?>"
227	value="<?php echo esc_attr( $current_user->customer->name ); ?>"/>
228	<?php
229	}
230	return ob_get_clean();
231	}
232
233	/**
234	* Validate this type field in create ticket
235	*
236	* @return void
237	*/
238	public static function js_validate_ticket_form() {
239	?>
240
241	case '<?php echo esc_attr( self::$slug ); ?>':
242	var val = customField.find('input').first().val().trim();
243	if (customField.hasClass('required') && !val) {
244	isValid = false;
245	alert(supportcandy.translations.req_fields_missing);
246	}
247	break;
248	<?php
249	echo PHP_EOL;
250	}
251
252	/**
253	* Return custom field value in $_POST
254	* Ignore phpcs nonce issue as we already checked where it is called from.
255	*
256	* @param string $slug - Custom field slug.
257	* @param mixed $cf - Custom field object or false.
258	* @return mixed
259	*/
260	public static function get_tff_value( $slug, $cf = false ) {
261
262	return isset( $_POST[ $slug ] ) ? sanitize_text_field( wp_unslash( $_POST[ $slug ] ) ) : ''; // phpcs:ignore
263	}
264
265	/**
266	* Return slug string to be used in where condition of ticket model for this type of field
267	*
268	* @param WPSC_Custom_Field $cf - custom field object.
269	* @return string
270	*/
271	public static function get_sql_slug( $cf ) {
272
273	return 'c.' . $cf->slug;
274	}
275
276	/**
277	* Print edit custom field properties
278	*
279	* @param WPSC_Custom_Fields $cf - custom field object.
280	* @param string $field_class - class name of field category.
281	* @return void
282	*/
283	public static function get_edit_custom_field_properties( $cf, $field_class ) {
284
285	if ( in_array( 'extra_info', $field_class::$allowed_properties ) ) :
286	?>
287	<div data-type="textfield" data-required="false" class="wpsc-input-group extra-info">
288	<div class="label-container">
289	<label for=""><?php esc_attr_e( 'Extra info', 'supportcandy' ); ?></label>
290	</div>
291	<input name="extra_info" type="text" value="<?php echo esc_attr( $cf->extra_info ); ?>" autocomplete="off" />
292	</div>
293	<?php
294	endif;
295
296	if ( in_array( 'placeholder_text', $field_class::$allowed_properties ) ) :
297	?>
298	<div data-type="textfield" data-required="false" class="wpsc-input-group placeholder_text">
299	<div class="label-container">
300	<label for="">
301	<?php esc_attr_e( 'Placeholder', 'supportcandy' ); ?>
302	</label>
303	</div>
304	<input type="text" name="placeholder_text" value="<?php echo esc_attr( $cf->placeholder_text ); ?>" autocomplete="off">
305	</div>
306	<?php
307	endif;
308
309	if ( in_array( 'tl_width', $field_class::$allowed_properties ) ) :
310	?>
311	<div data-type="number" data-required="false" class="wpsc-input-group tl_width">
312	<div class="label-container">
313	<label for="">
314	<?php esc_attr_e( 'Ticket list width (pixels)', 'supportcandy' ); ?>
315	</label>
316	</div>
317	<input type="number" name="tl_width" value="<?php echo esc_attr( intval( $cf->tl_width ) ); ?>" autocomplete="off">
318	</div>
319	<?php
320	endif;
321	}
322
323	/**
324	* Set custom field properties. Can be used by add/edit custom field.
325	* Ignore phpcs nonce issue as we already checked where it is called from.
326	*
327	* @param WPSC_Custom_Field $cf - custom field object.
328	* @param string $field_class - class of field category.
329	* @return void
330	*/
331	public static function set_cf_properties( $cf, $field_class ) {
332
333	// extra info.
334	if ( in_array( 'extra_info', $field_class::$allowed_properties ) ) {
335	$cf->extra_info = isset( $_POST['extra_info'] ) ? sanitize_text_field( wp_unslash( $_POST['extra_info'] ) ) : ''; // phpcs:ignore
336	}
337
338	// placeholder!
339	if ( in_array( 'placeholder_text', $field_class::$allowed_properties ) ) {
340	$cf->placeholder_text = isset( $_POST['placeholder_text'] ) ? sanitize_text_field( wp_unslash( $_POST['placeholder_text'] ) ) : ''; // phpcs:ignore
341	}
342
343	// tl_width!
344	if ( in_array( 'tl_width', $field_class::$allowed_properties ) ) {
345	$tl_width = isset( $_POST['tl_width'] ) ? intval( $_POST['tl_width'] ) : 0; // phpcs:ignore
346	$cf->tl_width = $tl_width ? $tl_width : 100;
347	}
348
349	// save!
350	$cf->save();
351	}
352
353	/**
354	* Return orderby string
355	*
356	* @param WPSC_Custom_Field $cf - custom field object.
357	* @return string
358	*/
359	public static function get_orderby_string( $cf ) {
360
361	return 'c.' . $cf->slug;
362	}
363
364	/**
365	* Returns printable customer value for custom field. Can be used in export tickets, replace macros etc.
366	*
367	* @param WPSC_Custom_Field $cf - custom field object.
368	* @param WPSC_Customer $customer - customer object.
369	* @return string
370	*/
371	public static function get_customer_field_val( $cf, $customer ) {
372
373	return $customer->name;
374	}
375
376	/**
377	* Print customer value for given custom field on ticket list
378	*
379	* @param WPSC_Custom_Field $cf - custom field object.
380	* @param WPSC_Customer $customer - customer object.
381	* @return void
382	*/
383	public static function print_tl_customer_field_val( $cf, $customer ) {
384
385	echo esc_attr( self::get_customer_field_val( $cf, $customer ) );
386	}
387	}
388	endif;
389
390	WPSC_DF_Customer_Name::init();
391