class-batch-export-donors.php
8 years ago
class-batch-export-forms.php
9 years ago
class-batch-export-payments.php
8 years ago
class-batch-export.php
8 years ago
class-core-settings-export.php
8 years ago
class-export-earnings.php
8 years ago
class-export.php
8 years ago
export-actions.php
8 years ago
export-functions.php
8 years ago
pdf-reports.php
8 years ago
class-export.php
188 lines
| 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, WordImpress |
| 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 | * @var string |
| 28 | * @since 1.0 |
| 29 | */ |
| 30 | public $export_type = 'default'; |
| 31 | |
| 32 | /** |
| 33 | * Can we export? |
| 34 | * |
| 35 | * @access public |
| 36 | * @since 1.0 |
| 37 | * @return bool Whether we can export or not |
| 38 | */ |
| 39 | public function can_export() { |
| 40 | return (bool) apply_filters( 'give_export_capability', current_user_can( 'export_give_reports' ) ); |
| 41 | } |
| 42 | |
| 43 | /** |
| 44 | * Set the export headers |
| 45 | * |
| 46 | * @access public |
| 47 | * @since 1.0 |
| 48 | * @return void |
| 49 | */ |
| 50 | public function headers() { |
| 51 | give_ignore_user_abort(); |
| 52 | |
| 53 | nocache_headers(); |
| 54 | header( 'Content-Type: text/csv; charset=utf-8' ); |
| 55 | header( 'Content-Disposition: attachment; filename=give-export-' . $this->export_type . '-' . date( 'm-d-Y' ) . '.csv' ); |
| 56 | header( "Expires: 0" ); |
| 57 | } |
| 58 | |
| 59 | /** |
| 60 | * Set the CSV columns |
| 61 | * |
| 62 | * @access public |
| 63 | * @since 1.0 |
| 64 | * @return array $cols All the columns |
| 65 | */ |
| 66 | public function csv_cols() { |
| 67 | $cols = array( |
| 68 | 'id' => __( 'ID', 'give' ), |
| 69 | 'date' => __( 'Date', 'give' ) |
| 70 | ); |
| 71 | |
| 72 | return $cols; |
| 73 | } |
| 74 | |
| 75 | /** |
| 76 | * Retrieve the CSV columns |
| 77 | * |
| 78 | * @access public |
| 79 | * @since 1.0 |
| 80 | * @return array $cols Array of the columns |
| 81 | */ |
| 82 | public function get_csv_cols() { |
| 83 | $cols = $this->csv_cols(); |
| 84 | |
| 85 | return apply_filters( "give_export_csv_cols_{$this->export_type}", $cols ); |
| 86 | } |
| 87 | |
| 88 | /** |
| 89 | * Output the CSV columns |
| 90 | * |
| 91 | * @access public |
| 92 | * @since 1.0 |
| 93 | * @uses Give_Export::get_csv_cols() |
| 94 | * @return void |
| 95 | */ |
| 96 | public function csv_cols_out() { |
| 97 | $cols = $this->get_csv_cols(); |
| 98 | $i = 1; |
| 99 | foreach ( $cols as $col_id => $column ) { |
| 100 | echo '"' . addslashes( $column ) . '"'; |
| 101 | echo $i == count( $cols ) ? '' : ','; |
| 102 | $i ++; |
| 103 | } |
| 104 | echo "\r\n"; |
| 105 | } |
| 106 | |
| 107 | /** |
| 108 | * Get the data being exported |
| 109 | * |
| 110 | * @access public |
| 111 | * @since 1.0 |
| 112 | * @return array $data Data for Export |
| 113 | */ |
| 114 | public function get_data() { |
| 115 | // Just a sample data array |
| 116 | $data = array( |
| 117 | 0 => array( |
| 118 | 'id' => '', |
| 119 | 'data' => date( 'F j, Y' ) |
| 120 | ), |
| 121 | 1 => array( |
| 122 | 'id' => '', |
| 123 | 'data' => date( 'F j, Y' ) |
| 124 | ) |
| 125 | ); |
| 126 | |
| 127 | $data = apply_filters( 'give_export_get_data', $data ); |
| 128 | $data = apply_filters( "give_export_get_data_{$this->export_type}", $data ); |
| 129 | |
| 130 | return $data; |
| 131 | } |
| 132 | |
| 133 | /** |
| 134 | * Output the CSV rows |
| 135 | * |
| 136 | * @access public |
| 137 | * @since 1.0 |
| 138 | * @return void |
| 139 | */ |
| 140 | public function csv_rows_out() { |
| 141 | $data = $this->get_data(); |
| 142 | |
| 143 | $cols = $this->get_csv_cols(); |
| 144 | |
| 145 | // Output each row |
| 146 | foreach ( $data as $row ) { |
| 147 | $i = 1; |
| 148 | foreach ( $row as $col_id => $column ) { |
| 149 | // Make sure the column is valid |
| 150 | if ( array_key_exists( $col_id, $cols ) ) { |
| 151 | echo '"' . addslashes( $column ) . '"'; |
| 152 | echo $i == count( $cols ) ? '' : ','; |
| 153 | $i ++; |
| 154 | } |
| 155 | } |
| 156 | echo "\r\n"; |
| 157 | } |
| 158 | } |
| 159 | |
| 160 | /** |
| 161 | * Perform the export |
| 162 | * |
| 163 | * @access public |
| 164 | * @since 1.0 |
| 165 | * @uses Give_Export::can_export() |
| 166 | * @uses Give_Export::headers() |
| 167 | * @uses Give_Export::csv_cols_out() |
| 168 | * @uses Give_Export::csv_rows_out() |
| 169 | * @return void |
| 170 | */ |
| 171 | public function export() { |
| 172 | if ( ! $this->can_export() ) { |
| 173 | wp_die( __( 'You do not have permission to export data.', 'give' ), __( 'Error', 'give' ), array( 'response' => 403 ) ); |
| 174 | } |
| 175 | |
| 176 | // Set headers |
| 177 | $this->headers(); |
| 178 | |
| 179 | // Output CSV columns (headers) |
| 180 | $this->csv_cols_out(); |
| 181 | |
| 182 | // Output CSV rows |
| 183 | $this->csv_rows_out(); |
| 184 | |
| 185 | give_die(); |
| 186 | } |
| 187 | } |
| 188 |