initial commit
This commit is contained in:
189
includes/export/abstract-wc-csv-batch-exporter.php
Normal file
189
includes/export/abstract-wc-csv-batch-exporter.php
Normal file
@ -0,0 +1,189 @@
|
||||
<?php
|
||||
/**
|
||||
* Handles Batch CSV export.
|
||||
*
|
||||
* Based on https://pippinsplugins.com/batch-processing-for-big-data/
|
||||
*
|
||||
* @package WooCommerce\Export
|
||||
* @version 3.1.0
|
||||
*/
|
||||
|
||||
defined( 'ABSPATH' ) || exit;
|
||||
|
||||
/**
|
||||
* Include dependencies.
|
||||
*/
|
||||
if ( ! class_exists( 'WC_CSV_Exporter', false ) ) {
|
||||
require_once WC_ABSPATH . 'includes/export/abstract-wc-csv-exporter.php';
|
||||
}
|
||||
|
||||
/**
|
||||
* WC_CSV_Exporter Class.
|
||||
*/
|
||||
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() ) ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$fp = fopen( $this->get_file_path(), 'a+' );
|
||||
|
||||
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 ? floor( ( $this->get_total_exported() / $this->total_rows ) * 100 ) : 100;
|
||||
}
|
||||
}
|
||||
507
includes/export/abstract-wc-csv-exporter.php
Normal file
507
includes/export/abstract-wc-csv-exporter.php
Normal file
@ -0,0 +1,507 @@
|
||||
<?php
|
||||
/**
|
||||
* Handles CSV export.
|
||||
*
|
||||
* @package WooCommerce\Export
|
||||
* @version 3.1.0
|
||||
*/
|
||||
|
||||
if ( ! defined( 'ABSPATH' ) ) {
|
||||
exit;
|
||||
}
|
||||
|
||||
/**
|
||||
* WC_CSV_Exporter Class.
|
||||
*/
|
||||
abstract class WC_CSV_Exporter {
|
||||
|
||||
/**
|
||||
* Type of export used in filter names.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $export_type = '';
|
||||
|
||||
/**
|
||||
* Filename to export to.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $filename = 'wc-export.csv';
|
||||
|
||||
/**
|
||||
* Batch limit.
|
||||
*
|
||||
* @var integer
|
||||
*/
|
||||
protected $limit = 50;
|
||||
|
||||
/**
|
||||
* Number exported.
|
||||
*
|
||||
* @var integer
|
||||
*/
|
||||
protected $exported_row_count = 0;
|
||||
|
||||
/**
|
||||
* Raw data to export.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $row_data = array();
|
||||
|
||||
/**
|
||||
* Total rows to export.
|
||||
*
|
||||
* @var integer
|
||||
*/
|
||||
protected $total_rows = 0;
|
||||
|
||||
/**
|
||||
* Columns ids and names.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $column_names = array();
|
||||
|
||||
/**
|
||||
* List of columns to export, or empty for all.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $columns_to_export = array();
|
||||
|
||||
/**
|
||||
* The delimiter parameter sets the field delimiter (one character only).
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $delimiter = ',';
|
||||
|
||||
/**
|
||||
* Prepare data that will be exported.
|
||||
*/
|
||||
abstract public function prepare_data_to_export();
|
||||
|
||||
/**
|
||||
* Return an array of supported column names and ids.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @return array
|
||||
*/
|
||||
public function get_column_names() {
|
||||
return apply_filters( "woocommerce_{$this->export_type}_export_column_names", $this->column_names, $this );
|
||||
}
|
||||
|
||||
/**
|
||||
* Set column names.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @param array $column_names Column names array.
|
||||
*/
|
||||
public function set_column_names( $column_names ) {
|
||||
$this->column_names = array();
|
||||
|
||||
foreach ( $column_names as $column_id => $column_name ) {
|
||||
$this->column_names[ wc_clean( $column_id ) ] = wc_clean( $column_name );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Return an array of columns to export.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @return array
|
||||
*/
|
||||
public function get_columns_to_export() {
|
||||
return $this->columns_to_export;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the delimiter to use in CSV file
|
||||
*
|
||||
* @since 3.9.0
|
||||
* @return string
|
||||
*/
|
||||
public function get_delimiter() {
|
||||
return apply_filters( "woocommerce_{$this->export_type}_export_delimiter", $this->delimiter );
|
||||
}
|
||||
|
||||
/**
|
||||
* Set columns to export.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @param array $columns Columns array.
|
||||
*/
|
||||
public function set_columns_to_export( $columns ) {
|
||||
$this->columns_to_export = array_map( 'wc_clean', $columns );
|
||||
}
|
||||
|
||||
/**
|
||||
* See if a column is to be exported or not.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @param string $column_id ID of the column being exported.
|
||||
* @return boolean
|
||||
*/
|
||||
public function is_column_exporting( $column_id ) {
|
||||
$column_id = strstr( $column_id, ':' ) ? current( explode( ':', $column_id ) ) : $column_id;
|
||||
$columns_to_export = $this->get_columns_to_export();
|
||||
|
||||
if ( empty( $columns_to_export ) ) {
|
||||
return true;
|
||||
}
|
||||
|
||||
if ( in_array( $column_id, $columns_to_export, true ) || 'meta' === $column_id ) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return default columns.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @return array
|
||||
*/
|
||||
public function get_default_column_names() {
|
||||
return array();
|
||||
}
|
||||
|
||||
/**
|
||||
* Do the export.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*/
|
||||
public function export() {
|
||||
$this->prepare_data_to_export();
|
||||
$this->send_headers();
|
||||
$this->send_content( chr( 239 ) . chr( 187 ) . chr( 191 ) . $this->export_column_headers() . $this->get_csv_data() );
|
||||
die();
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the export headers.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*/
|
||||
public function send_headers() {
|
||||
if ( function_exists( 'gc_enable' ) ) {
|
||||
gc_enable(); // phpcs:ignore PHPCompatibility.FunctionUse.NewFunctions.gc_enableFound
|
||||
}
|
||||
if ( function_exists( 'apache_setenv' ) ) {
|
||||
@apache_setenv( 'no-gzip', 1 ); // @codingStandardsIgnoreLine
|
||||
}
|
||||
@ini_set( 'zlib.output_compression', 'Off' ); // @codingStandardsIgnoreLine
|
||||
@ini_set( 'output_buffering', 'Off' ); // @codingStandardsIgnoreLine
|
||||
@ini_set( 'output_handler', '' ); // @codingStandardsIgnoreLine
|
||||
ignore_user_abort( true );
|
||||
wc_set_time_limit( 0 );
|
||||
wc_nocache_headers();
|
||||
header( 'Content-Type: text/csv; charset=utf-8' );
|
||||
header( 'Content-Disposition: attachment; filename=' . $this->get_filename() );
|
||||
header( 'Pragma: no-cache' );
|
||||
header( 'Expires: 0' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Set filename to export to.
|
||||
*
|
||||
* @param string $filename Filename to export to.
|
||||
*/
|
||||
public function set_filename( $filename ) {
|
||||
$this->filename = sanitize_file_name( str_replace( '.csv', '', $filename ) . '.csv' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate and return a filename.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function get_filename() {
|
||||
return sanitize_file_name( apply_filters( "woocommerce_{$this->export_type}_export_get_filename", $this->filename ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the export content.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @param string $csv_data All CSV content.
|
||||
*/
|
||||
public function send_content( $csv_data ) {
|
||||
echo $csv_data; // @codingStandardsIgnoreLine
|
||||
}
|
||||
|
||||
/**
|
||||
* Get CSV data for this export.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @return string
|
||||
*/
|
||||
protected function get_csv_data() {
|
||||
return $this->export_rows();
|
||||
}
|
||||
|
||||
/**
|
||||
* Export column headers in CSV format.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @return string
|
||||
*/
|
||||
protected function export_column_headers() {
|
||||
$columns = $this->get_column_names();
|
||||
$export_row = array();
|
||||
$buffer = fopen( 'php://output', 'w' ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_read_fopen
|
||||
ob_start();
|
||||
|
||||
foreach ( $columns as $column_id => $column_name ) {
|
||||
if ( ! $this->is_column_exporting( $column_id ) ) {
|
||||
continue;
|
||||
}
|
||||
$export_row[] = $this->format_data( $column_name );
|
||||
}
|
||||
|
||||
$this->fputcsv( $buffer, $export_row );
|
||||
|
||||
return ob_get_clean();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get data that will be exported.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @return array
|
||||
*/
|
||||
protected function get_data_to_export() {
|
||||
return $this->row_data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Export rows in CSV format.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @return string
|
||||
*/
|
||||
protected function export_rows() {
|
||||
$data = $this->get_data_to_export();
|
||||
$buffer = fopen( 'php://output', 'w' ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_read_fopen
|
||||
ob_start();
|
||||
|
||||
array_walk( $data, array( $this, 'export_row' ), $buffer );
|
||||
|
||||
return apply_filters( "woocommerce_{$this->export_type}_export_rows", ob_get_clean(), $this );
|
||||
}
|
||||
|
||||
/**
|
||||
* Export rows to an array ready for the CSV.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @param array $row_data Data to export.
|
||||
* @param string $key Column being exported.
|
||||
* @param resource $buffer Output buffer.
|
||||
*/
|
||||
protected function export_row( $row_data, $key, $buffer ) {
|
||||
$columns = $this->get_column_names();
|
||||
$export_row = array();
|
||||
|
||||
foreach ( $columns as $column_id => $column_name ) {
|
||||
if ( ! $this->is_column_exporting( $column_id ) ) {
|
||||
continue;
|
||||
}
|
||||
if ( isset( $row_data[ $column_id ] ) ) {
|
||||
$export_row[] = $this->format_data( $row_data[ $column_id ] );
|
||||
} else {
|
||||
$export_row[] = '';
|
||||
}
|
||||
}
|
||||
|
||||
$this->fputcsv( $buffer, $export_row );
|
||||
|
||||
++ $this->exported_row_count;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get batch limit.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @return int
|
||||
*/
|
||||
public function get_limit() {
|
||||
return apply_filters( "woocommerce_{$this->export_type}_export_batch_limit", $this->limit, $this );
|
||||
}
|
||||
|
||||
/**
|
||||
* Set batch limit.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @param int $limit Limit to export.
|
||||
*/
|
||||
public function set_limit( $limit ) {
|
||||
$this->limit = absint( $limit );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get count of records exported.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @return int
|
||||
*/
|
||||
public function get_total_exported() {
|
||||
return $this->exported_row_count;
|
||||
}
|
||||
|
||||
/**
|
||||
* Escape a string to be used in a CSV context
|
||||
*
|
||||
* Malicious input can inject formulas into CSV files, opening up the possibility
|
||||
* for phishing attacks and disclosure of sensitive information.
|
||||
*
|
||||
* Additionally, Excel exposes the ability to launch arbitrary commands through
|
||||
* the DDE protocol.
|
||||
*
|
||||
* @see http://www.contextis.com/resources/blog/comma-separated-vulnerabilities/
|
||||
* @see https://hackerone.com/reports/72785
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @param string $data CSV field to escape.
|
||||
* @return string
|
||||
*/
|
||||
public function escape_data( $data ) {
|
||||
$active_content_triggers = array( '=', '+', '-', '@' );
|
||||
|
||||
if ( in_array( mb_substr( $data, 0, 1 ), $active_content_triggers, true ) ) {
|
||||
$data = "'" . $data;
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Format and escape data ready for the CSV file.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @param string $data Data to format.
|
||||
* @return string
|
||||
*/
|
||||
public function format_data( $data ) {
|
||||
if ( ! is_scalar( $data ) ) {
|
||||
if ( is_a( $data, 'WC_Datetime' ) ) {
|
||||
$data = $data->date( 'Y-m-d G:i:s' );
|
||||
} else {
|
||||
$data = ''; // Not supported.
|
||||
}
|
||||
} elseif ( is_bool( $data ) ) {
|
||||
$data = $data ? 1 : 0;
|
||||
}
|
||||
|
||||
$use_mb = function_exists( 'mb_convert_encoding' );
|
||||
|
||||
if ( $use_mb ) {
|
||||
$encoding = mb_detect_encoding( $data, 'UTF-8, ISO-8859-1', true );
|
||||
$data = 'UTF-8' === $encoding ? $data : utf8_encode( $data );
|
||||
}
|
||||
|
||||
return $this->escape_data( $data );
|
||||
}
|
||||
|
||||
/**
|
||||
* Format term ids to names.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @param array $term_ids Term IDs to format.
|
||||
* @param string $taxonomy Taxonomy name.
|
||||
* @return string
|
||||
*/
|
||||
public function format_term_ids( $term_ids, $taxonomy ) {
|
||||
$term_ids = wp_parse_id_list( $term_ids );
|
||||
|
||||
if ( ! count( $term_ids ) ) {
|
||||
return '';
|
||||
}
|
||||
|
||||
$formatted_terms = array();
|
||||
|
||||
if ( is_taxonomy_hierarchical( $taxonomy ) ) {
|
||||
foreach ( $term_ids as $term_id ) {
|
||||
$formatted_term = array();
|
||||
$ancestor_ids = array_reverse( get_ancestors( $term_id, $taxonomy ) );
|
||||
|
||||
foreach ( $ancestor_ids as $ancestor_id ) {
|
||||
$term = get_term( $ancestor_id, $taxonomy );
|
||||
if ( $term && ! is_wp_error( $term ) ) {
|
||||
$formatted_term[] = $term->name;
|
||||
}
|
||||
}
|
||||
|
||||
$term = get_term( $term_id, $taxonomy );
|
||||
|
||||
if ( $term && ! is_wp_error( $term ) ) {
|
||||
$formatted_term[] = $term->name;
|
||||
}
|
||||
|
||||
$formatted_terms[] = implode( ' > ', $formatted_term );
|
||||
}
|
||||
} else {
|
||||
foreach ( $term_ids as $term_id ) {
|
||||
$term = get_term( $term_id, $taxonomy );
|
||||
|
||||
if ( $term && ! is_wp_error( $term ) ) {
|
||||
$formatted_terms[] = $term->name;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $this->implode_values( $formatted_terms );
|
||||
}
|
||||
|
||||
/**
|
||||
* Implode CSV cell values using commas by default, and wrapping values
|
||||
* which contain the separator.
|
||||
*
|
||||
* @since 3.2.0
|
||||
* @param array $values Values to implode.
|
||||
* @return string
|
||||
*/
|
||||
protected function implode_values( $values ) {
|
||||
$values_to_implode = array();
|
||||
|
||||
foreach ( $values as $value ) {
|
||||
$value = (string) is_scalar( $value ) ? $value : '';
|
||||
$values_to_implode[] = str_replace( ',', '\\,', $value );
|
||||
}
|
||||
|
||||
return implode( ', ', $values_to_implode );
|
||||
}
|
||||
|
||||
/**
|
||||
* Write to the CSV file, ensuring escaping works across versions of
|
||||
* PHP.
|
||||
*
|
||||
* PHP 5.5.4 uses '\' as the default escape character. This is not RFC-4180 compliant.
|
||||
* \0 disables the escape character.
|
||||
*
|
||||
* @see https://bugs.php.net/bug.php?id=43225
|
||||
* @see https://bugs.php.net/bug.php?id=50686
|
||||
* @see https://github.com/woocommerce/woocommerce/issues/19514
|
||||
* @since 3.4.0
|
||||
* @see https://github.com/woocommerce/woocommerce/issues/24579
|
||||
* @since 3.9.0
|
||||
* @param resource $buffer Resource we are writing to.
|
||||
* @param array $export_row Row to export.
|
||||
*/
|
||||
protected function fputcsv( $buffer, $export_row ) {
|
||||
|
||||
if ( version_compare( PHP_VERSION, '5.5.4', '<' ) ) {
|
||||
ob_start();
|
||||
$temp = fopen( 'php://output', 'w' ); // @codingStandardsIgnoreLine
|
||||
fputcsv( $temp, $export_row, $this->get_delimiter(), '"' ); // @codingStandardsIgnoreLine
|
||||
fclose( $temp ); // @codingStandardsIgnoreLine
|
||||
$row = ob_get_clean();
|
||||
$row = str_replace( '\\"', '\\""', $row );
|
||||
fwrite( $buffer, $row ); // @codingStandardsIgnoreLine
|
||||
} else {
|
||||
fputcsv( $buffer, $export_row, $this->get_delimiter(), '"', "\0" ); // @codingStandardsIgnoreLine
|
||||
}
|
||||
}
|
||||
}
|
||||
733
includes/export/class-wc-product-csv-exporter.php
Normal file
733
includes/export/class-wc-product-csv-exporter.php
Normal file
@ -0,0 +1,733 @@
|
||||
<?php
|
||||
/**
|
||||
* Handles product CSV export.
|
||||
*
|
||||
* @package WooCommerce\Export
|
||||
* @version 3.1.0
|
||||
*/
|
||||
|
||||
if ( ! defined( 'ABSPATH' ) ) {
|
||||
exit;
|
||||
}
|
||||
|
||||
/**
|
||||
* Include dependencies.
|
||||
*/
|
||||
if ( ! class_exists( 'WC_CSV_Batch_Exporter', false ) ) {
|
||||
include_once WC_ABSPATH . 'includes/export/abstract-wc-csv-batch-exporter.php';
|
||||
}
|
||||
|
||||
/**
|
||||
* WC_Product_CSV_Exporter Class.
|
||||
*/
|
||||
class WC_Product_CSV_Exporter extends WC_CSV_Batch_Exporter {
|
||||
|
||||
/**
|
||||
* Type of export used in filter names.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $export_type = 'product';
|
||||
|
||||
/**
|
||||
* Should meta be exported?
|
||||
*
|
||||
* @var boolean
|
||||
*/
|
||||
protected $enable_meta_export = false;
|
||||
|
||||
/**
|
||||
* Which product types are being exported.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $product_types_to_export = array();
|
||||
|
||||
/**
|
||||
* Products belonging to what category should be exported.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $product_category_to_export = array();
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*/
|
||||
public function __construct() {
|
||||
parent::__construct();
|
||||
$this->set_product_types_to_export( array_keys( WC_Admin_Exporters::get_product_types() ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Should meta be exported?
|
||||
*
|
||||
* @param bool $enable_meta_export Should meta be exported.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*/
|
||||
public function enable_meta_export( $enable_meta_export ) {
|
||||
$this->enable_meta_export = (bool) $enable_meta_export;
|
||||
}
|
||||
|
||||
/**
|
||||
* Product types to export.
|
||||
*
|
||||
* @param array $product_types_to_export List of types to export.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*/
|
||||
public function set_product_types_to_export( $product_types_to_export ) {
|
||||
$this->product_types_to_export = array_map( 'wc_clean', $product_types_to_export );
|
||||
}
|
||||
|
||||
/**
|
||||
* Product category to export
|
||||
*
|
||||
* @param string $product_category_to_export Product category slug to export, empty string exports all.
|
||||
*
|
||||
* @since 3.5.0
|
||||
* @return void
|
||||
*/
|
||||
public function set_product_category_to_export( $product_category_to_export ) {
|
||||
$this->product_category_to_export = array_map( 'sanitize_title_with_dashes', $product_category_to_export );
|
||||
}
|
||||
|
||||
/**
|
||||
* Return an array of columns to export.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @return array
|
||||
*/
|
||||
public function get_default_column_names() {
|
||||
return apply_filters(
|
||||
"woocommerce_product_export_{$this->export_type}_default_columns",
|
||||
array(
|
||||
'id' => __( 'ID', 'woocommerce' ),
|
||||
'type' => __( 'Type', 'woocommerce' ),
|
||||
'sku' => __( 'SKU', 'woocommerce' ),
|
||||
'name' => __( 'Name', 'woocommerce' ),
|
||||
'published' => __( 'Published', 'woocommerce' ),
|
||||
'featured' => __( 'Is featured?', 'woocommerce' ),
|
||||
'catalog_visibility' => __( 'Visibility in catalog', 'woocommerce' ),
|
||||
'short_description' => __( 'Short description', 'woocommerce' ),
|
||||
'description' => __( 'Description', 'woocommerce' ),
|
||||
'date_on_sale_from' => __( 'Date sale price starts', 'woocommerce' ),
|
||||
'date_on_sale_to' => __( 'Date sale price ends', 'woocommerce' ),
|
||||
'tax_status' => __( 'Tax status', 'woocommerce' ),
|
||||
'tax_class' => __( 'Tax class', 'woocommerce' ),
|
||||
'stock_status' => __( 'In stock?', 'woocommerce' ),
|
||||
'stock' => __( 'Stock', 'woocommerce' ),
|
||||
'low_stock_amount' => __( 'Low stock amount', 'woocommerce' ),
|
||||
'backorders' => __( 'Backorders allowed?', 'woocommerce' ),
|
||||
'sold_individually' => __( 'Sold individually?', 'woocommerce' ),
|
||||
/* translators: %s: weight */
|
||||
'weight' => sprintf( __( 'Weight (%s)', 'woocommerce' ), get_option( 'woocommerce_weight_unit' ) ),
|
||||
/* translators: %s: length */
|
||||
'length' => sprintf( __( 'Length (%s)', 'woocommerce' ), get_option( 'woocommerce_dimension_unit' ) ),
|
||||
/* translators: %s: width */
|
||||
'width' => sprintf( __( 'Width (%s)', 'woocommerce' ), get_option( 'woocommerce_dimension_unit' ) ),
|
||||
/* translators: %s: Height */
|
||||
'height' => sprintf( __( 'Height (%s)', 'woocommerce' ), get_option( 'woocommerce_dimension_unit' ) ),
|
||||
'reviews_allowed' => __( 'Allow customer reviews?', 'woocommerce' ),
|
||||
'purchase_note' => __( 'Purchase note', 'woocommerce' ),
|
||||
'sale_price' => __( 'Sale price', 'woocommerce' ),
|
||||
'regular_price' => __( 'Regular price', 'woocommerce' ),
|
||||
'category_ids' => __( 'Categories', 'woocommerce' ),
|
||||
'tag_ids' => __( 'Tags', 'woocommerce' ),
|
||||
'shipping_class_id' => __( 'Shipping class', 'woocommerce' ),
|
||||
'images' => __( 'Images', 'woocommerce' ),
|
||||
'download_limit' => __( 'Download limit', 'woocommerce' ),
|
||||
'download_expiry' => __( 'Download expiry days', 'woocommerce' ),
|
||||
'parent_id' => __( 'Parent', 'woocommerce' ),
|
||||
'grouped_products' => __( 'Grouped products', 'woocommerce' ),
|
||||
'upsell_ids' => __( 'Upsells', 'woocommerce' ),
|
||||
'cross_sell_ids' => __( 'Cross-sells', 'woocommerce' ),
|
||||
'product_url' => __( 'External URL', 'woocommerce' ),
|
||||
'button_text' => __( 'Button text', 'woocommerce' ),
|
||||
'menu_order' => __( 'Position', 'woocommerce' ),
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Prepare data for export.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*/
|
||||
public function prepare_data_to_export() {
|
||||
$args = array(
|
||||
'status' => array( 'private', 'publish', 'draft', 'future', 'pending' ),
|
||||
'type' => $this->product_types_to_export,
|
||||
'limit' => $this->get_limit(),
|
||||
'page' => $this->get_page(),
|
||||
'orderby' => array(
|
||||
'ID' => 'ASC',
|
||||
),
|
||||
'return' => 'objects',
|
||||
'paginate' => true,
|
||||
);
|
||||
|
||||
if ( ! empty( $this->product_category_to_export ) ) {
|
||||
$args['category'] = $this->product_category_to_export;
|
||||
}
|
||||
$products = wc_get_products( apply_filters( "woocommerce_product_export_{$this->export_type}_query_args", $args ) );
|
||||
|
||||
$this->total_rows = $products->total;
|
||||
$this->row_data = array();
|
||||
$variable_products = array();
|
||||
|
||||
foreach ( $products->products as $product ) {
|
||||
// Check if the category is set, this means we need to fetch variations seperately as they are not tied to a category.
|
||||
if ( ! empty( $args['category'] ) && $product->is_type( 'variable' ) ) {
|
||||
$variable_products[] = $product->get_id();
|
||||
}
|
||||
|
||||
$this->row_data[] = $this->generate_row_data( $product );
|
||||
}
|
||||
|
||||
// If a category was selected we loop through the variations as they are not tied to a category so will be excluded by default.
|
||||
if ( ! empty( $variable_products ) ) {
|
||||
foreach ( $variable_products as $parent_id ) {
|
||||
$products = wc_get_products(
|
||||
array(
|
||||
'parent' => $parent_id,
|
||||
'type' => array( 'variation' ),
|
||||
'return' => 'objects',
|
||||
'limit' => -1,
|
||||
)
|
||||
);
|
||||
|
||||
if ( ! $products ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
foreach ( $products as $product ) {
|
||||
$this->row_data[] = $this->generate_row_data( $product );
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Take a product and generate row data from it for export.
|
||||
*
|
||||
* @param WC_Product $product WC_Product object.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function generate_row_data( $product ) {
|
||||
$columns = $this->get_column_names();
|
||||
$row = array();
|
||||
foreach ( $columns as $column_id => $column_name ) {
|
||||
$column_id = strstr( $column_id, ':' ) ? current( explode( ':', $column_id ) ) : $column_id;
|
||||
$value = '';
|
||||
|
||||
// Skip some columns if dynamically handled later or if we're being selective.
|
||||
if ( in_array( $column_id, array( 'downloads', 'attributes', 'meta' ), true ) || ! $this->is_column_exporting( $column_id ) ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if ( has_filter( "woocommerce_product_export_{$this->export_type}_column_{$column_id}" ) ) {
|
||||
// Filter for 3rd parties.
|
||||
$value = apply_filters( "woocommerce_product_export_{$this->export_type}_column_{$column_id}", '', $product, $column_id );
|
||||
|
||||
} elseif ( is_callable( array( $this, "get_column_value_{$column_id}" ) ) ) {
|
||||
// Handle special columns which don't map 1:1 to product data.
|
||||
$value = $this->{"get_column_value_{$column_id}"}( $product );
|
||||
|
||||
} elseif ( is_callable( array( $product, "get_{$column_id}" ) ) ) {
|
||||
// Default and custom handling.
|
||||
$value = $product->{"get_{$column_id}"}( 'edit' );
|
||||
}
|
||||
|
||||
if ( 'description' === $column_id || 'short_description' === $column_id ) {
|
||||
$value = $this->filter_description_field( $value );
|
||||
}
|
||||
|
||||
$row[ $column_id ] = $value;
|
||||
}
|
||||
|
||||
$this->prepare_downloads_for_export( $product, $row );
|
||||
$this->prepare_attributes_for_export( $product, $row );
|
||||
$this->prepare_meta_for_export( $product, $row );
|
||||
return apply_filters( 'woocommerce_product_export_row_data', $row, $product );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get published value.
|
||||
*
|
||||
* @param WC_Product $product Product being exported.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @return int
|
||||
*/
|
||||
protected function get_column_value_published( $product ) {
|
||||
$statuses = array(
|
||||
'draft' => -1,
|
||||
'private' => 0,
|
||||
'publish' => 1,
|
||||
);
|
||||
|
||||
// Fix display for variations when parent product is a draft.
|
||||
if ( 'variation' === $product->get_type() ) {
|
||||
$parent = $product->get_parent_data();
|
||||
$status = 'draft' === $parent['status'] ? $parent['status'] : $product->get_status( 'edit' );
|
||||
} else {
|
||||
$status = $product->get_status( 'edit' );
|
||||
}
|
||||
|
||||
return isset( $statuses[ $status ] ) ? $statuses[ $status ] : -1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get formatted sale price.
|
||||
*
|
||||
* @param WC_Product $product Product being exported.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function get_column_value_sale_price( $product ) {
|
||||
return wc_format_localized_price( $product->get_sale_price( 'view' ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get formatted regular price.
|
||||
*
|
||||
* @param WC_Product $product Product being exported.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function get_column_value_regular_price( $product ) {
|
||||
return wc_format_localized_price( $product->get_regular_price() );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get product_cat value.
|
||||
*
|
||||
* @param WC_Product $product Product being exported.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @return string
|
||||
*/
|
||||
protected function get_column_value_category_ids( $product ) {
|
||||
$term_ids = $product->get_category_ids( 'edit' );
|
||||
return $this->format_term_ids( $term_ids, 'product_cat' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get product_tag value.
|
||||
*
|
||||
* @param WC_Product $product Product being exported.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @return string
|
||||
*/
|
||||
protected function get_column_value_tag_ids( $product ) {
|
||||
$term_ids = $product->get_tag_ids( 'edit' );
|
||||
return $this->format_term_ids( $term_ids, 'product_tag' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get product_shipping_class value.
|
||||
*
|
||||
* @param WC_Product $product Product being exported.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @return string
|
||||
*/
|
||||
protected function get_column_value_shipping_class_id( $product ) {
|
||||
$term_ids = $product->get_shipping_class_id( 'edit' );
|
||||
return $this->format_term_ids( $term_ids, 'product_shipping_class' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get images value.
|
||||
*
|
||||
* @param WC_Product $product Product being exported.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @return string
|
||||
*/
|
||||
protected function get_column_value_images( $product ) {
|
||||
$image_ids = array_merge( array( $product->get_image_id( 'edit' ) ), $product->get_gallery_image_ids( 'edit' ) );
|
||||
$images = array();
|
||||
|
||||
foreach ( $image_ids as $image_id ) {
|
||||
$image = wp_get_attachment_image_src( $image_id, 'full' );
|
||||
|
||||
if ( $image ) {
|
||||
$images[] = $image[0];
|
||||
}
|
||||
}
|
||||
|
||||
return $this->implode_values( $images );
|
||||
}
|
||||
|
||||
/**
|
||||
* Prepare linked products for export.
|
||||
*
|
||||
* @param int[] $linked_products Array of linked product ids.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @return string
|
||||
*/
|
||||
protected function prepare_linked_products_for_export( $linked_products ) {
|
||||
$product_list = array();
|
||||
|
||||
foreach ( $linked_products as $linked_product ) {
|
||||
if ( $linked_product->get_sku() ) {
|
||||
$product_list[] = $linked_product->get_sku();
|
||||
} else {
|
||||
$product_list[] = 'id:' . $linked_product->get_id();
|
||||
}
|
||||
}
|
||||
|
||||
return $this->implode_values( $product_list );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get cross_sell_ids value.
|
||||
*
|
||||
* @param WC_Product $product Product being exported.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @return string
|
||||
*/
|
||||
protected function get_column_value_cross_sell_ids( $product ) {
|
||||
return $this->prepare_linked_products_for_export( array_filter( array_map( 'wc_get_product', (array) $product->get_cross_sell_ids( 'edit' ) ) ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get upsell_ids value.
|
||||
*
|
||||
* @param WC_Product $product Product being exported.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @return string
|
||||
*/
|
||||
protected function get_column_value_upsell_ids( $product ) {
|
||||
return $this->prepare_linked_products_for_export( array_filter( array_map( 'wc_get_product', (array) $product->get_upsell_ids( 'edit' ) ) ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get parent_id value.
|
||||
*
|
||||
* @param WC_Product $product Product being exported.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @return string
|
||||
*/
|
||||
protected function get_column_value_parent_id( $product ) {
|
||||
if ( $product->get_parent_id( 'edit' ) ) {
|
||||
$parent = wc_get_product( $product->get_parent_id( 'edit' ) );
|
||||
if ( ! $parent ) {
|
||||
return '';
|
||||
}
|
||||
|
||||
return $parent->get_sku( 'edit' ) ? $parent->get_sku( 'edit' ) : 'id:' . $parent->get_id();
|
||||
}
|
||||
return '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Get grouped_products value.
|
||||
*
|
||||
* @param WC_Product $product Product being exported.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @return string
|
||||
*/
|
||||
protected function get_column_value_grouped_products( $product ) {
|
||||
if ( 'grouped' !== $product->get_type() ) {
|
||||
return '';
|
||||
}
|
||||
|
||||
$grouped_products = array();
|
||||
$child_ids = $product->get_children( 'edit' );
|
||||
foreach ( $child_ids as $child_id ) {
|
||||
$child = wc_get_product( $child_id );
|
||||
if ( ! $child ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$grouped_products[] = $child->get_sku( 'edit' ) ? $child->get_sku( 'edit' ) : 'id:' . $child_id;
|
||||
}
|
||||
return $this->implode_values( $grouped_products );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get download_limit value.
|
||||
*
|
||||
* @param WC_Product $product Product being exported.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @return string
|
||||
*/
|
||||
protected function get_column_value_download_limit( $product ) {
|
||||
return $product->is_downloadable() && $product->get_download_limit( 'edit' ) ? $product->get_download_limit( 'edit' ) : '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Get download_expiry value.
|
||||
*
|
||||
* @param WC_Product $product Product being exported.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @return string
|
||||
*/
|
||||
protected function get_column_value_download_expiry( $product ) {
|
||||
return $product->is_downloadable() && $product->get_download_expiry( 'edit' ) ? $product->get_download_expiry( 'edit' ) : '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Get stock value.
|
||||
*
|
||||
* @param WC_Product $product Product being exported.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @return string
|
||||
*/
|
||||
protected function get_column_value_stock( $product ) {
|
||||
$manage_stock = $product->get_manage_stock( 'edit' );
|
||||
$stock_quantity = $product->get_stock_quantity( 'edit' );
|
||||
|
||||
if ( $product->is_type( 'variation' ) && 'parent' === $manage_stock ) {
|
||||
return 'parent';
|
||||
} elseif ( $manage_stock ) {
|
||||
return $stock_quantity;
|
||||
} else {
|
||||
return '';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get stock status value.
|
||||
*
|
||||
* @param WC_Product $product Product being exported.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @return string
|
||||
*/
|
||||
protected function get_column_value_stock_status( $product ) {
|
||||
$status = $product->get_stock_status( 'edit' );
|
||||
|
||||
if ( 'onbackorder' === $status ) {
|
||||
return 'backorder';
|
||||
}
|
||||
|
||||
return 'instock' === $status ? 1 : 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get backorders.
|
||||
*
|
||||
* @param WC_Product $product Product being exported.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @return string
|
||||
*/
|
||||
protected function get_column_value_backorders( $product ) {
|
||||
$backorders = $product->get_backorders( 'edit' );
|
||||
|
||||
switch ( $backorders ) {
|
||||
case 'notify':
|
||||
return 'notify';
|
||||
default:
|
||||
return wc_string_to_bool( $backorders ) ? 1 : 0;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get low stock amount value.
|
||||
*
|
||||
* @param WC_Product $product Product being exported.
|
||||
*
|
||||
* @since 3.5.0
|
||||
* @return int|string Empty string if value not set
|
||||
*/
|
||||
protected function get_column_value_low_stock_amount( $product ) {
|
||||
return $product->managing_stock() && $product->get_low_stock_amount( 'edit' ) ? $product->get_low_stock_amount( 'edit' ) : '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Get type value.
|
||||
*
|
||||
* @param WC_Product $product Product being exported.
|
||||
*
|
||||
* @since 3.1.0
|
||||
* @return string
|
||||
*/
|
||||
protected function get_column_value_type( $product ) {
|
||||
$types = array();
|
||||
$types[] = $product->get_type();
|
||||
|
||||
if ( $product->is_downloadable() ) {
|
||||
$types[] = 'downloadable';
|
||||
}
|
||||
|
||||
if ( $product->is_virtual() ) {
|
||||
$types[] = 'virtual';
|
||||
}
|
||||
|
||||
return $this->implode_values( $types );
|
||||
}
|
||||
|
||||
/**
|
||||
* Filter description field for export.
|
||||
* Convert newlines to '\n'.
|
||||
*
|
||||
* @param string $description Product description text to filter.
|
||||
*
|
||||
* @since 3.5.4
|
||||
* @return string
|
||||
*/
|
||||
protected function filter_description_field( $description ) {
|
||||
$description = str_replace( '\n', "\\\\n", $description );
|
||||
$description = str_replace( "\n", '\n', $description );
|
||||
return $description;
|
||||
}
|
||||
/**
|
||||
* Export downloads.
|
||||
*
|
||||
* @param WC_Product $product Product being exported.
|
||||
* @param array $row Row being exported.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*/
|
||||
protected function prepare_downloads_for_export( $product, &$row ) {
|
||||
if ( $product->is_downloadable() && $this->is_column_exporting( 'downloads' ) ) {
|
||||
$downloads = $product->get_downloads( 'edit' );
|
||||
|
||||
if ( $downloads ) {
|
||||
$i = 1;
|
||||
foreach ( $downloads as $download ) {
|
||||
/* translators: %s: download number */
|
||||
$this->column_names[ 'downloads:id' . $i ] = sprintf( __( 'Download %d ID', 'woocommerce' ), $i );
|
||||
/* translators: %s: download number */
|
||||
$this->column_names[ 'downloads:name' . $i ] = sprintf( __( 'Download %d name', 'woocommerce' ), $i );
|
||||
/* translators: %s: download number */
|
||||
$this->column_names[ 'downloads:url' . $i ] = sprintf( __( 'Download %d URL', 'woocommerce' ), $i );
|
||||
$row[ 'downloads:id' . $i ] = $download->get_id();
|
||||
$row[ 'downloads:name' . $i ] = $download->get_name();
|
||||
$row[ 'downloads:url' . $i ] = $download->get_file();
|
||||
$i++;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Export attributes data.
|
||||
*
|
||||
* @param WC_Product $product Product being exported.
|
||||
* @param array $row Row being exported.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*/
|
||||
protected function prepare_attributes_for_export( $product, &$row ) {
|
||||
if ( $this->is_column_exporting( 'attributes' ) ) {
|
||||
$attributes = $product->get_attributes();
|
||||
$default_attributes = $product->get_default_attributes();
|
||||
|
||||
if ( count( $attributes ) ) {
|
||||
$i = 1;
|
||||
foreach ( $attributes as $attribute_name => $attribute ) {
|
||||
/* translators: %s: attribute number */
|
||||
$this->column_names[ 'attributes:name' . $i ] = sprintf( __( 'Attribute %d name', 'woocommerce' ), $i );
|
||||
/* translators: %s: attribute number */
|
||||
$this->column_names[ 'attributes:value' . $i ] = sprintf( __( 'Attribute %d value(s)', 'woocommerce' ), $i );
|
||||
/* translators: %s: attribute number */
|
||||
$this->column_names[ 'attributes:visible' . $i ] = sprintf( __( 'Attribute %d visible', 'woocommerce' ), $i );
|
||||
/* translators: %s: attribute number */
|
||||
$this->column_names[ 'attributes:taxonomy' . $i ] = sprintf( __( 'Attribute %d global', 'woocommerce' ), $i );
|
||||
|
||||
if ( is_a( $attribute, 'WC_Product_Attribute' ) ) {
|
||||
$row[ 'attributes:name' . $i ] = wc_attribute_label( $attribute->get_name(), $product );
|
||||
|
||||
if ( $attribute->is_taxonomy() ) {
|
||||
$terms = $attribute->get_terms();
|
||||
$values = array();
|
||||
|
||||
foreach ( $terms as $term ) {
|
||||
$values[] = $term->name;
|
||||
}
|
||||
|
||||
$row[ 'attributes:value' . $i ] = $this->implode_values( $values );
|
||||
$row[ 'attributes:taxonomy' . $i ] = 1;
|
||||
} else {
|
||||
$row[ 'attributes:value' . $i ] = $this->implode_values( $attribute->get_options() );
|
||||
$row[ 'attributes:taxonomy' . $i ] = 0;
|
||||
}
|
||||
|
||||
$row[ 'attributes:visible' . $i ] = $attribute->get_visible();
|
||||
} else {
|
||||
$row[ 'attributes:name' . $i ] = wc_attribute_label( $attribute_name, $product );
|
||||
|
||||
if ( 0 === strpos( $attribute_name, 'pa_' ) ) {
|
||||
$option_term = get_term_by( 'slug', $attribute, $attribute_name ); // @codingStandardsIgnoreLine.
|
||||
$row[ 'attributes:value' . $i ] = $option_term && ! is_wp_error( $option_term ) ? str_replace( ',', '\\,', $option_term->name ) : str_replace( ',', '\\,', $attribute );
|
||||
$row[ 'attributes:taxonomy' . $i ] = 1;
|
||||
} else {
|
||||
$row[ 'attributes:value' . $i ] = str_replace( ',', '\\,', $attribute );
|
||||
$row[ 'attributes:taxonomy' . $i ] = 0;
|
||||
}
|
||||
|
||||
$row[ 'attributes:visible' . $i ] = '';
|
||||
}
|
||||
|
||||
if ( $product->is_type( 'variable' ) && isset( $default_attributes[ sanitize_title( $attribute_name ) ] ) ) {
|
||||
/* translators: %s: attribute number */
|
||||
$this->column_names[ 'attributes:default' . $i ] = sprintf( __( 'Attribute %d default', 'woocommerce' ), $i );
|
||||
$default_value = $default_attributes[ sanitize_title( $attribute_name ) ];
|
||||
|
||||
if ( 0 === strpos( $attribute_name, 'pa_' ) ) {
|
||||
$option_term = get_term_by( 'slug', $default_value, $attribute_name ); // @codingStandardsIgnoreLine.
|
||||
$row[ 'attributes:default' . $i ] = $option_term && ! is_wp_error( $option_term ) ? $option_term->name : $default_value;
|
||||
} else {
|
||||
$row[ 'attributes:default' . $i ] = $default_value;
|
||||
}
|
||||
}
|
||||
$i++;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Export meta data.
|
||||
*
|
||||
* @param WC_Product $product Product being exported.
|
||||
* @param array $row Row data.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*/
|
||||
protected function prepare_meta_for_export( $product, &$row ) {
|
||||
if ( $this->enable_meta_export ) {
|
||||
$meta_data = $product->get_meta_data();
|
||||
|
||||
if ( count( $meta_data ) ) {
|
||||
$meta_keys_to_skip = apply_filters( 'woocommerce_product_export_skip_meta_keys', array(), $product );
|
||||
|
||||
$i = 1;
|
||||
foreach ( $meta_data as $meta ) {
|
||||
if ( in_array( $meta->key, $meta_keys_to_skip, true ) ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// Allow 3rd parties to process the meta, e.g. to transform non-scalar values to scalar.
|
||||
$meta_value = apply_filters( 'woocommerce_product_export_meta_value', $meta->value, $meta, $product, $row );
|
||||
|
||||
if ( ! is_scalar( $meta_value ) ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$column_key = 'meta:' . esc_attr( $meta->key );
|
||||
/* translators: %s: meta data name */
|
||||
$this->column_names[ $column_key ] = sprintf( __( 'Meta: %s', 'woocommerce' ), $meta->key );
|
||||
$row[ $column_key ] = $meta_value;
|
||||
$i ++;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user