LLMS_Meta_Box_Voucher_Export

Meta box Voucher Export class

Contents

Source Source

File: includes/admin/post-types/meta-boxes/class.llms.meta.box.voucher.export.php

20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
class LLMS_Meta_Box_Voucher_Export {
 
 
    public static $prefix = '_';
 
    public function __construct() {}
 
    /**
     * Function to field WP::output() method call
     * Passes output instruction to parent
     *
     * @param    object $post  WP global post object
     * @return   void
     * @since    ??
     * @version  3.24.0
     */
    public static function output( $post ) {
 
        global $post;
        if ( 'publish' !== $post->post_status ) {
            _e( 'You need to publish this post before you can generate a CSV.', 'lifterlms' );
            return;
        }
        ob_start();
        ?>
        <div class="llms-voucher-export-wrapper" id="llms-form-wrapper">
 
            <div class="llms-voucher-export-type">
                <input type="radio" name="llms_voucher_export_type" id="vouchers_only_type" value="vouchers">
                <label for="vouchers_only_type"><strong><?php _e( 'Vouchers only', 'lifterlms' ); ?></strong></label>
                <p><?php _e( 'Generates a CSV of voucher codes, uses, and remaining uses.', 'lifterlms' ); ?></p>
            </div>
 
            <div class="llms-voucher-export-type">
                <input type="radio" name="llms_voucher_export_type" id="redeemed_codes_type" value="redeemed">
                <label for="redeemed_codes_type"><strong><?php _e( 'Redeemed codes', 'lifterlms' ); ?></strong></label>
                <p><?php _e( 'Generated a CSV of student emails, redemption date, and used code.', 'lifterlms' ); ?></p>
            </div>
 
 
            <div class="llms-voucher-email-wrapper">
                <input type="checkbox" name="llms_voucher_export_send_email" id="llms_voucher_export_send_email"
                       value="true">
                <label for="llms_voucher_export_send_email"><?php _e( 'Email CSV', 'lifterlms' ); ?></label>
                <input type="text" placeholder="Email" name="llms_voucher_export_email">
                <p><?php _e( 'Send to multiple emails by separating emails addresses with commas.', 'lifterlms' ); ?></p>
            </div>
 
            <button type="submit" name="llms_generate_export" value="generate" class="button-primary"><?php _e( 'Generate Export', 'lifterlms' ); ?></button>
            <?php wp_nonce_field( 'lifterlms_csv_export_data', 'lifterlms_export_nonce' ); ?>
            <div class="clear"></div>
        </div>
        <?php
 
        echo ob_get_clean();
    }
 
    /**
     * Export vouchers.
     *
     * @since Unknown.
     * @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
     *
     * @return [type] [description]
     */
    public static function export() {
 
        if ( empty( llms_filter_input( INPUT_POST, 'llms_generate_export' ) ) || ! llms_verify_nonce( 'lifterlms_export_nonce', 'lifterlms_csv_export_data' ) ) {
            return false;
        }
 
        $type = llms_filter_input( INPUT_POST, 'llms_voucher_export_type' );
        if ( ! empty( $type ) ) {
 
            if ( 'vouchers' === $type || 'redeemed' === $type ) {
 
                // Export CSV.
 
                $csv       = array();
                $file_name = '';
 
                global $post;
                $voucher = new LLMS_Voucher( $post->ID );
 
                switch ( $type ) {
                    case 'vouchers':
                        $voucher = new LLMS_Voucher( $post->ID );
                        $codes   = $voucher->get_voucher_codes( 'ARRAY_A' );
 
                        if ( ! $codes ) {
                            /**
                             * @todo  error handling here
                             */
                            return;
                        }
 
                        foreach ( $codes as $k => $v ) {
                            unset( $codes[ $k ]['id'] );
                            unset( $codes[ $k ]['voucher_id'] );
                            $codes[ $k ]['count']   = $codes[ $k ]['redemption_count'];
                            $codes[ $k ]['used']    = $codes[ $k ]['used'];
                            $codes[ $k ]['created'] = $codes[ $k ]['created_at'];
                            $codes[ $k ]['updated'] = $codes[ $k ]['updated_at'];
                            unset( $codes[ $k ]['redemption_count'] );
                            unset( $codes[ $k ]['created_at'] );
                            unset( $codes[ $k ]['updated_at'] );
                            unset( $codes[ $k ]['is_deleted'] );
 
                        }
                        $csv = self::array_to_csv( $codes );
 
                        $file_name = 'vouchers.csv';
                        break;
 
                    case 'redeemed':
                        $redeemed_codes = $voucher->get_redeemed_codes( 'ARRAY_A' );
 
                        if ( ! $redeemed_codes ) {
                            /**
                             * @todo  error handling here
                             */
                            return;
                        }
 
                        foreach ( $redeemed_codes as $k => $v ) {
                            unset( $redeemed_codes[ $k ]['id'] );
                            unset( $redeemed_codes[ $k ]['code_id'] );
                            unset( $redeemed_codes[ $k ]['voucher_id'] );
                            unset( $redeemed_codes[ $k ]['redemption_count'] );
                            unset( $redeemed_codes[ $k ]['user_id'] );
 
                        }
 
                        $csv = self::array_to_csv( $redeemed_codes );
 
                        $file_name = 'redeemed_codes.csv';
 
                        break;
                }
 
                $send_email = llms_parse_bool( llms_filter_input( INPUT_POST, 'llms_voucher_export_send_email' ) );
                if ( $send_email ) {
 
                    // Send email.
                    $email_text = trim( llms_filter_input_sanitize_string( INPUT_POST, 'llms_voucher_export_email' ) );
                    if ( ! empty( $email_text ) ) {
 
                        $emails = array_filter( array_map( 'is_email', array_map( 'trim', explode( ',', $email_text ) ) ) );
 
                        if ( ! empty( $emails ) ) {
 
                            $voucher = new LLMS_Voucher( $post->ID );
 
                            self::send_email( $csv, $emails, $voucher->get_voucher_title() );
 
                        }
                    }
 
                    return false;
                }
 
                self::download_csv( $csv, $file_name );
            }// End if().
        }// End if().
 
    }
 
    public static function array_to_csv( $data, $delimiter = ',', $enclosure = '"' ) {
 
        $handle   = fopen( 'php://temp', 'r+' );
        $contents = '';
 
        $names = array();
 
        foreach ( $data[0] as $name => $item ) {
            $names[] = $name;
        }
 
        fputcsv( $handle, $names, $delimiter, $enclosure );
 
        foreach ( $data as $line ) {
            fputcsv( $handle, $line, $delimiter, $enclosure );
        }
        rewind( $handle );
        while ( ! feof( $handle ) ) {
            $contents .= fread( $handle, 8192 );
        }
        fclose( $handle );
        return $contents;
    }
 
    /**
     * Serve the CSV as an attachment to be downloaded.
     *
     * @since Unknown
     * @since 3.30.3 Fixed typo in export content-disposition header.
     *
     * @param string $csv CSV content string.
     * @param string $name Filename.
     * @return void
     */
    public static function download_csv( $csv, $name ) {
 
        header( 'Content-Type: application/csv' );
        header( 'Content-Disposition: attachment; filename="' . $name . '";' );
 
        echo $csv;
        exit;
    }
 
    public static function send_email( $csv, $emails, $title ) {
 
        $subject = 'Your LifterLMS Voucher Export';
        $message = 'Please find the attached voucher csv export for ' . $title . '.';
 
        // Create temp file.
        $temp = tempnam( '/tmp', 'vouchers' );
 
        // Write CSV.
        $handle = fopen( $temp, 'w' );
        fwrite( $handle, $csv );
 
        // Prepare filename.
        $temp_data     = stream_get_meta_data( $handle );
        $temp_filename = $temp_data['uri'];
 
        $new_filename = substr_replace( $temp_filename, '', 13 ) . '.csv';
        rename( $temp_filename, $new_filename );
 
        // Send email/s.
        $mail = wp_mail( $emails, $subject, $message, '', $new_filename );
 
        // And remove it.
        fclose( $handle );
        unlink( $new_filename );
 
        return $mail;
    }
 
}

Expand full source code Collapse full source code View on GitHub

Top ↑

Methods Methods

Top ↑

Changelog Changelog

Changelog
Version Description
3.35.0 Sanitize $_POST data, fix issue preventing emails from being properly sent.
3.30.3 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.