WC_CSV_Batch_Exporter{} │ WC 1.0
WC_CSV_Exporter Class.
Hooks from the class
Usage
$WC_CSV_Batch_Exporter = new WC_CSV_Batch_Exporter(); // use class methods
Methods
- public __construct()
- public export()
- public generate_file()
- public get_file()
- protected get_file_path()
- public get_headers_row_file()
- protected get_headers_row_file_path()
- public get_page()
- public get_percent_complete()
- public get_total_exported()
- public set_page( $page )
- protected write_csv_data( $data )
WC_CSV_Batch_Exporter{} WC CSV Batch Exporter{} code WC 9.4.2
abstract class WC_CSV_Batch_Exporter extends WC_CSV_Exporter { /** * Page being exported * * @var integer */ protected $page = 1; /** * Constructor. */ public function __construct() { $this->column_names = $this->get_default_column_names(); } /** * Get file path to export to. * * @return string */ protected function get_file_path() { $upload_dir = wp_upload_dir(); return trailingslashit( $upload_dir['basedir'] ) . $this->get_filename(); } /** * Get CSV headers row file path to export to. * * @return string */ protected function get_headers_row_file_path() { return $this->get_file_path() . '.headers'; } /** * Get the contents of the CSV headers row file. Defaults to the original known headers. * * @since 3.1.0 * @return string */ public function get_headers_row_file() { $file = chr( 239 ) . chr( 187 ) . chr( 191 ) . $this->export_column_headers(); if ( @file_exists( $this->get_headers_row_file_path() ) ) { // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged $file = @file_get_contents( $this->get_headers_row_file_path() ); // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged, WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents, WordPress.WP.AlternativeFunctions.file_system_read_file_get_contents } return $file; } /** * Get the file contents. * * @since 3.1.0 * @return string */ public function get_file() { $file = ''; if ( @file_exists( $this->get_file_path() ) ) { // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged $file = @file_get_contents( $this->get_file_path() ); // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged, WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents, WordPress.WP.AlternativeFunctions.file_system_read_file_get_contents } else { @file_put_contents( $this->get_file_path(), '' ); // phpcs:ignore WordPress.VIP.FileSystemWritesDisallow.file_ops_file_put_contents, Generic.PHP.NoSilencedErrors.Discouraged, WordPress.WP.AlternativeFunctions.file_system_read_file_put_contents @chmod( $this->get_file_path(), 0664 ); // phpcs:ignore WordPress.VIP.FileSystemWritesDisallow.chmod_chmod, WordPress.WP.AlternativeFunctions.file_system_read_file_put_contents, Generic.PHP.NoSilencedErrors.Discouraged } return $file; } /** * Serve the file and remove once sent to the client. * * @since 3.1.0 */ public function export() { $this->send_headers(); $this->send_content( $this->get_headers_row_file() . $this->get_file() ); @unlink( $this->get_file_path() ); // phpcs:ignore WordPress.VIP.FileSystemWritesDisallow.file_ops_unlink, Generic.PHP.NoSilencedErrors.Discouraged @unlink( $this->get_headers_row_file_path() ); // phpcs:ignore WordPress.VIP.FileSystemWritesDisallow.file_ops_unlink, Generic.PHP.NoSilencedErrors.Discouraged die(); } /** * Generate the CSV file. * * @since 3.1.0 */ public function generate_file() { if ( 1 === $this->get_page() ) { @unlink( $this->get_file_path() ); // phpcs:ignore WordPress.VIP.FileSystemWritesDisallow.file_ops_unlink, Generic.PHP.NoSilencedErrors.Discouraged, // We need to initialize the file here. $this->get_file(); } $this->prepare_data_to_export(); $this->write_csv_data( $this->get_csv_data() ); } /** * Write data to the file. * * @since 3.1.0 * @param string $data Data. */ protected function write_csv_data( $data ) { if ( ! file_exists( $this->get_file_path() ) || ! is_writeable( $this->get_file_path() ) ) { wc_get_logger()->error( sprintf( /* translators: %s is file path. */ __( 'Unable to create or write to %s during CSV export. Please check file permissions.', 'woocommerce' ), esc_html( $this->get_file_path() ) ) ); return false; } /** * Filters the mode parameter which specifies the type of access you require to the stream (used during file * writing for CSV exports). Defaults to 'a+' (which supports both reading and writing, and places the file * pointer at the end of the file). * * @see https://www.php.net/manual/en/function.fopen.php * @since 6.8.0 * * @param string $fopen_mode, either (r, r+, w, w+, a, a+, x, x+, c, c+, e) */ $fopen_mode = apply_filters( 'woocommerce_csv_exporter_fopen_mode', 'a+' ); $fp = fopen( $this->get_file_path(), $fopen_mode ); if ( $fp ) { fwrite( $fp, $data ); fclose( $fp ); } // Add all columns when finished. if ( 100 === $this->get_percent_complete() ) { $header = chr( 239 ) . chr( 187 ) . chr( 191 ) . $this->export_column_headers(); // We need to use a temporary file to store headers, this will make our life so much easier. @file_put_contents( $this->get_headers_row_file_path(), $header ); //phpcs:ignore WordPress.VIP.FileSystemWritesDisallow.file_ops_file_put_contents, Generic.PHP.NoSilencedErrors.Discouraged, WordPress.WP.AlternativeFunctions.file_system_read_file_put_contents } } /** * Get page. * * @since 3.1.0 * @return int */ public function get_page() { return $this->page; } /** * Set page. * * @since 3.1.0 * @param int $page Page Nr. */ public function set_page( $page ) { $this->page = absint( $page ); } /** * Get count of records exported. * * @since 3.1.0 * @return int */ public function get_total_exported() { return ( ( $this->get_page() - 1 ) * $this->get_limit() ) + $this->exported_row_count; } /** * Get total % complete. * * @since 3.1.0 * @return int */ public function get_percent_complete() { return $this->total_rows ? (int) floor( ( $this->get_total_exported() / $this->total_rows ) * 100 ) : 100; } }