| 1 |
<?php |
| 2 |
/** |
| 3 |
* Export Class |
| 4 |
* |
| 5 |
* This is the base class for all export methods. Each data export type (donors, payments, etc) extend this class |
| 6 |
* |
| 7 |
* @package Give |
| 8 |
* @subpackage Admin/Reports |
| 9 |
* @copyright Copyright (c) 2016, GiveWP |
| 10 |
* @license https://opensource.org/licenses/gpl-license GNU Public License |
| 11 |
* @since 1.0 |
| 12 |
*/ |
| 13 |
|
| 14 |
// Exit if accessed directly. |
| 15 |
if ( ! defined( 'ABSPATH' ) ) { |
| 16 |
exit; |
| 17 |
} |
| 18 |
|
| 19 |
/** |
| 20 |
* Give_Export Class |
| 21 |
* |
| 22 |
* @since 1.0 |
| 23 |
*/ |
| 24 |
class Give_Export { |
| 25 |
/** |
| 26 |
* Our export type. Used for export-type specific filters/actions |
| 27 |
* |
| 28 |
* @var string |
| 29 |
* @since 1.0 |
| 30 |
*/ |
| 31 |
public $export_type = 'default'; |
| 32 |
|
| 33 |
/** |
| 34 |
* Can we export? |
| 35 |
* |
| 36 |
* @access public |
| 37 |
* @since 1.0 |
| 38 |
* @return bool Whether we can export or not |
| 39 |
*/ |
| 40 |
public function can_export() { |
| 41 |
return (bool) apply_filters( 'give_export_capability', current_user_can( 'export_give_reports' ) ); |
| 42 |
} |
| 43 |
|
| 44 |
/** |
| 45 |
* Set the export headers |
| 46 |
* |
| 47 |
* @access public |
| 48 |
* @since 1.0 |
| 49 |
* @return void |
| 50 |
*/ |
| 51 |
public function headers() { |
| 52 |
give_ignore_user_abort(); |
| 53 |
|
| 54 |
/** |
| 55 |
* Filter to Modify CSV file name |
| 56 |
* |
| 57 |
* @since 2.1.0 |
| 58 |
* |
| 59 |
* @param $file_name string file name |
| 60 |
* @param$export_type string export type name |
| 61 |
* |
| 62 |
* @return $file_name string file name |
| 63 |
*/ |
| 64 |
$file_name = apply_filters( 'give_export_filename', 'give-export-' . $this->export_type . '-' . date( 'm-d-Y' ), $this->export_type ); |
| 65 |
|
| 66 |
nocache_headers(); |
| 67 |
header( 'Content-Type: text/csv; charset=utf-8' ); |
| 68 |
header( 'Content-Disposition: attachment; filename=' . $file_name . '.csv' ); |
| 69 |
header( 'Expires: 0' ); |
| 70 |
} |
| 71 |
|
| 72 |
/** |
| 73 |
* Set the CSV columns |
| 74 |
* |
| 75 |
* @access public |
| 76 |
* @since 1.0 |
| 77 |
* @return array $cols All the columns |
| 78 |
*/ |
| 79 |
public function csv_cols() { |
| 80 |
$cols = array( |
| 81 |
'id' => __( 'ID', 'give' ), |
| 82 |
'date' => __( 'Date', 'give' ), |
| 83 |
); |
| 84 |
|
| 85 |
return $cols; |
| 86 |
} |
| 87 |
|
| 88 |
/** |
| 89 |
* Retrieve the CSV columns |
| 90 |
* |
| 91 |
* @access public |
| 92 |
* @since 1.0 |
| 93 |
* @return array $cols Array of the columns |
| 94 |
*/ |
| 95 |
public function get_csv_cols() { |
| 96 |
$cols = $this->csv_cols(); |
| 97 |
|
| 98 |
return apply_filters( "give_export_csv_cols_{$this->export_type}", $cols ); |
| 99 |
} |
| 100 |
|
| 101 |
/** |
| 102 |
* Output the CSV columns |
| 103 |
* |
| 104 |
* @access public |
| 105 |
* @since 1.0 |
| 106 |
* @uses Give_Export::get_csv_cols() |
| 107 |
* @return void |
| 108 |
*/ |
| 109 |
public function csv_cols_out() { |
| 110 |
$cols = $this->get_csv_cols(); |
| 111 |
$i = 1; |
| 112 |
foreach ( $cols as $col_id => $column ) { |
| 113 |
echo '"' . addslashes( $column ) . '"'; |
| 114 |
echo $i == count( $cols ) ? '' : ','; |
| 115 |
$i ++; |
| 116 |
} |
| 117 |
echo "\r\n"; |
| 118 |
} |
| 119 |
|
| 120 |
/** |
| 121 |
* Get the data being exported |
| 122 |
* |
| 123 |
* @access public |
| 124 |
* @since 1.0 |
| 125 |
* @return array $data Data for Export |
| 126 |
*/ |
| 127 |
public function get_data() { |
| 128 |
// Just a sample data array |
| 129 |
$data = array( |
| 130 |
0 => array( |
| 131 |
'id' => '', |
| 132 |
'data' => date( 'F j, Y' ), |
| 133 |
), |
| 134 |
1 => array( |
| 135 |
'id' => '', |
| 136 |
'data' => date( 'F j, Y' ), |
| 137 |
), |
| 138 |
); |
| 139 |
|
| 140 |
$data = apply_filters( 'give_export_get_data', $data ); |
| 141 |
$data = apply_filters( "give_export_get_data_{$this->export_type}", $data ); |
| 142 |
|
| 143 |
return $data; |
| 144 |
} |
| 145 |
|
| 146 |
/** |
| 147 |
* Output the CSV rows |
| 148 |
* |
| 149 |
* @access public |
| 150 |
* @since 1.0 |
| 151 |
* @return void |
| 152 |
*/ |
| 153 |
public function csv_rows_out() { |
| 154 |
$data = $this->get_data(); |
| 155 |
|
| 156 |
$cols = $this->get_csv_cols(); |
| 157 |
|
| 158 |
// Output each row |
| 159 |
foreach ( $data as $row ) { |
| 160 |
$i = 1; |
| 161 |
foreach ( $row as $col_id => $column ) { |
| 162 |
// Make sure the column is valid |
| 163 |
if ( array_key_exists( $col_id, $cols ) ) { |
| 164 |
echo '"' . addslashes( $column ) . '"'; |
| 165 |
echo $i == count( $cols ) ? '' : ','; |
| 166 |
$i ++; |
| 167 |
} |
| 168 |
} |
| 169 |
echo "\r\n"; |
| 170 |
} |
| 171 |
} |
| 172 |
|
| 173 |
/** |
| 174 |
* Perform the export |
| 175 |
* |
| 176 |
* @access public |
| 177 |
* @since 1.0 |
| 178 |
* @uses Give_Export::can_export() |
| 179 |
* @uses Give_Export::headers() |
| 180 |
* @uses Give_Export::csv_cols_out() |
| 181 |
* @uses Give_Export::csv_rows_out() |
| 182 |
* @return void |
| 183 |
*/ |
| 184 |
public function export() { |
| 185 |
if ( ! $this->can_export() ) { |
| 186 |
wp_die( __( 'You do not have permission to export data.', 'give' ), __( 'Error', 'give' ), array( 'response' => 403 ) ); |
| 187 |
} |
| 188 |
|
| 189 |
// Set headers |
| 190 |
$this->headers(); |
| 191 |
|
| 192 |
// Output CSV columns (headers) |
| 193 |
$this->csv_cols_out(); |
| 194 |
|
| 195 |
// Output CSV rows |
| 196 |
$this->csv_rows_out(); |
| 197 |
|
| 198 |
give_die(); |
| 199 |
} |
| 200 |
} |
| 201 |
|
