give / includes / admin / tools / export / export-functions.php

export-functions.php in GiveWP – Donation Plugin and Fundraising Platform 4.16.8.1, at includes/admin/tools/export/export-functions.php

170 lines 3.9 KB

Raw Download Zip

1	<?php
2	/**
3	* Exports Functions
4	*
5	* These functions are used for exporting data from Give
6	*
7	* @package Give
8	* @subpackage Admin/Export
9	* @copyright Copyright (c) 2016, GiveWP
10	* @license https://opensource.org/licenses/gpl-license GNU Public License
11	*/
12
13	// Exit if accessed directly.
14	if ( ! defined( 'ABSPATH' ) ) {
15	exit;
16	}
17
18
19	/**
20	* Process batch exports via ajax
21	*
22	* @since 2.21.0 Sanitize file name. Allow plain file name only.
23	* @since 1.5
24	* @return void
25	*/
26	function give_do_ajax_export() {
27
28	require_once GIVE_PLUGIN_DIR . 'includes/admin/tools/export/class-batch-export.php';
29
30	parse_str( $_POST['form'], $form );
31
32	$_REQUEST = $form = (array) $form;
33
34	if (
35	! wp_verify_nonce( $_REQUEST['give_ajax_export'], 'give_ajax_export' ) \|\|
36	! current_user_can( 'manage_give_settings' )
37	) {
38	die( '-2' );
39	}
40
41	/**
42	* Fires before batch export.
43	*
44	* @since 1.5
45	*
46	* @param string $class Export class.
47	*/
48	do_action( 'give_batch_export_class_include', $form['give-export-class'] );
49
50	if( ! is_subclass_of( $form['give-export-class'], \Give_Batch_Export::class ) ) {
51	die(-2);
52	}
53
54	$step = absint( $_POST['step'] );
55	$class = sanitize_text_field( $form['give-export-class'] );
56	$filename = isset( $_POST['file_name'] ) ?
57	basename(sanitize_file_name( $_POST['file_name'] ), '.csv') :
58	null;
59
60	/* @var Give_Batch_Export $export */
61	$export = new $class( $step, $filename );
62
63	if ( ! $export->can_export() ) {
64	die( '-1' );
65	}
66
67	if ( ! $export->is_writable ) {
68	$json_args = [
69	'error' => true,
70	'message' => esc_html__( 'Export location or file not writable.', 'give' ),
71	];
72	echo json_encode( $json_args );
73	exit;
74	}
75
76	$export->set_properties( give_clean( $_REQUEST ) );
77
78	$export->pre_fetch();
79
80	$ret = $export->process_step();
81
82	$percentage = $export->get_percentage_complete();
83
84	if ( $ret ) {
85
86	$step += 1;
87	$json_data = [
88	'step' => $step,
89	'percentage' => $percentage,
90	'file_name' => $export->filename,
91	];
92
93	} elseif ( true === $export->is_empty ) {
94
95	$json_data = [
96	'error' => true,
97	'message' => esc_html__( 'No data found for export parameters.', 'give' ),
98	];
99
100	} elseif ( true === $export->done && true === $export->is_void ) {
101
102	$message = ! empty( $export->message ) ?
103	$export->message :
104	esc_html__( 'Batch Processing Complete', 'give' );
105
106	$json_data = [
107	'success' => true,
108	'message' => $message,
109	];
110
111	} else {
112
113	$args = array_merge(
114	$_REQUEST,
115	[
116	'step' => $step,
117	'class' => $class,
118	'nonce' => wp_create_nonce( 'give-batch-export' ),
119	'give_action' => 'form_batch_export',
120	'file_name' => $export->filename,
121	]
122	);
123
124	$json_data = [
125	'step' => 'done',
126	'url' => esc_url_raw(add_query_arg( $args, admin_url() )),
127	];
128
129	}
130
131	$export->unset_properties( give_clean( $_REQUEST ), $export );
132	echo json_encode( $json_data );
133	exit;
134	}
135
136	add_action( 'wp_ajax_give_do_ajax_export', 'give_do_ajax_export' );
137
138
139	/**
140	* This function is used to define default columns for export.
141	*
142	* Note: This function is for internal purposes only.
143	* Use filter "give_export_donors_get_default_columns" instead.
144	*
145	* @since 3.12.1 add donor_phone_number column.
146	* @since 2.2.6
147	*
148	* @return array
149	*/
150	function give_export_donors_get_default_columns() {
151
152	$default_columns = [
153	'full_name' => __( 'Name', 'give' ),
154	'email' => __( 'Email', 'give' ),
155	'address' => __( 'Address', 'give' ),
156	'userid' => __( 'User ID', 'give' ),
157	'donor_created_date' => __( 'Donor Created Date', 'give' ),
158	'donor_phone_number' => __( 'Donor Phone Number', 'give' ),
159	'donations' => __( 'Number of donations', 'give' ),
160	'donation_sum' => __( 'Total Donated', 'give' ),
161	];
162
163	/**
164	* This filter will be used to define default columns for export.
165	*
166	* @since 2.2.6
167	*/
168	return apply_filters( 'give_export_donors_get_default_columns', $default_columns );
169	}
170