ReportCSVExporter
extends WC_CSV_Batch_Exporter
in package
ReportCSVExporter Class.
Table of Contents
- $column_names : array<string|int, mixed>
- Columns ids and names.
- $columns_to_export : array<string|int, mixed>
- List of columns to export, or empty for all.
- $controller : WC_REST_Reports_Controller
- REST controller for the report.
- $delimiter : string
- The delimiter parameter sets the field delimiter (one character only).
- $download_suffix : string
- Detail appended to the name the export is downloaded as.
- $export_type : string
- Type of export used in filter names.
- $exported_row_count : int
- Number exported.
- $filename : string
- Filename to export to.
- $limit : int
- Batch limit.
- $page : int
- Page being exported
- $report_args : array<string|int, mixed>
- Parameters for the report query.
- $report_type : string
- Type of report being exported.
- $row_data : array<string|int, mixed>
- Raw data to export.
- $total_rows : int
- Total rows to export.
- __construct() : mixed
- Constructor.
- escape_data() : string
- Escape a string to be used in a CSV context
- export() : void
- Serve the export file.
- export_file_exists() : bool
- Check whether a complete generated export is still on disk.
- format_data() : string
- Format and escape data ready for the CSV file.
- format_term_ids() : string
- Format term ids to names.
- generate_file() : mixed
- Generate the CSV file.
- get_column_names() : array<string|int, mixed>
- Return an array of supported column names and ids.
- get_columns_to_export() : array<string|int, mixed>
- Return an array of columns to export.
- get_default_column_names() : array<string|int, mixed>
- Return default columns.
- get_delimiter() : string
- Return the delimiter to use in CSV file
- get_download_filename() : string
- Get the name the export is downloaded as.
- get_file() : string
- Get the file contents.
- get_filename() : string
- Generate and return a filename.
- get_headers_row_file() : string
- Get the contents of the CSV headers row file. Defaults to the original known headers.
- get_limit() : int
- Get batch limit.
- get_page() : int
- Get page.
- get_percent_complete() : int
- Get total % complete.
- get_report_controller() : WC_REST_Reports_Controller|false
- Get a REST controller instance for a given report type, or false if unknown.
- get_reports_directory() : string
- Get report uploads directory.
- get_total_exported() : int
- Get count of records exported.
- get_total_rows() : int
- Get total number of rows in export.
- is_column_exporting() : bool
- See if a column is to be exported or not.
- maybe_create_directory() : mixed
- Create the directory for reports if it does not yet exist.
- prepare_data_to_export() : mixed
- Prepare data for export.
- send_content() : mixed
- Set the export content.
- send_headers() : void
- Set the export headers.
- set_column_names() : mixed
- Set column names.
- set_columns_to_export() : mixed
- Set columns to export.
- set_download_suffix() : void
- Add detail to the name the export is downloaded as, leaving the stored file's name alone.
- set_filename() : mixed
- Set filename to export to.
- set_limit() : mixed
- Set batch limit.
- set_page() : mixed
- Set page.
- set_report_args() : mixed
- Setter for report args.
- set_report_type() : mixed
- Setter for report type.
- stream_export_file() : void
- Write the export to the output, leaving the file in place. Send the download headers first.
- export_column_headers() : string
- Export column headers in CSV format.
- export_row() : mixed
- Export rows to an array ready for the CSV.
- export_rows() : string
- Export rows in CSV format.
- fputcsv() : mixed
- Write to the CSV file.
- generate_row_data() : array<string|int, mixed>
- Get the export row for a given report item.
- get_csv_data() : string
- Get CSV data for this export.
- get_data_to_export() : array<string|int, mixed>
- Get data that will be exported.
- get_file_path() : string
- Get file path to export to.
- get_headers_row_file_path() : string
- Get CSV headers row file path to export to.
- get_raw_row_data() : array<string|int, mixed>
- Generate row data from a raw report item.
- get_report_columns() : array<string|int, mixed>
- Get the report columns from the controller.
- implode_values() : string
- Implode CSV cell values using commas by default, and wrapping values which contain the separator.
- map_report_controller() : bool|WC_REST_Reports_Controller
- Get a REST controller instance for the report type.
- write_csv_data() : mixed
- Write data to the file.
- get_report_controller_map() : array<string|int, mixed>
- Get the report type to report controller class map.
Properties
$column_names
Columns ids and names.
protected
array<string|int, mixed>
$column_names
= array()
$columns_to_export
List of columns to export, or empty for all.
protected
array<string|int, mixed>
$columns_to_export
= array()
$controller
REST controller for the report.
protected
WC_REST_Reports_Controller
$controller
$delimiter
The delimiter parameter sets the field delimiter (one character only).
protected
string
$delimiter
= ','
$download_suffix
Detail appended to the name the export is downloaded as.
protected
string
$download_suffix
= ''
$export_type
Type of export used in filter names.
protected
string
$export_type
= ''
$exported_row_count
Number exported.
protected
int
$exported_row_count
= 0
$filename
Filename to export to.
protected
string
$filename
= 'wc-export.csv'
$limit
Batch limit.
protected
int
$limit
= 50
$page
Page being exported
protected
int
$page
= 1
$report_args
Parameters for the report query.
protected
array<string|int, mixed>
$report_args
$report_type
Type of report being exported.
protected
string
$report_type
$row_data
Raw data to export.
protected
array<string|int, mixed>
$row_data
= array()
$total_rows
Total rows to export.
protected
int
$total_rows
= 0
Methods
__construct()
Constructor.
public
__construct([string $type = false ][, array<string|int, mixed> $args = array() ]) : mixed
Parameters
- $type : string = false
-
Report type. E.g. 'customers'.
- $args : array<string|int, mixed> = array()
-
Report parameters.
Return values
mixed —escape_data()
Escape a string to be used in a CSV context
public
escape_data(string $data) : string
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.
Number values are not escaped since a pure numeric value cannot form a valid formula to be injected.
This preserves negative numeric values (e.g. -42) as numbers in the CSV output.
Parameters
- $data : string
-
CSV field to escape.
Tags
Return values
string —export()
Serve the export file.
public
export() : void
Unlike the parent, this keeps the file so that the download link WooCommerce emails to the merchant works more than once. ReportExporter::delete_expired_exports() removes it later.
Tags
Return values
void —export_file_exists()
Check whether a complete generated export is still on disk.
public
export_file_exists() : bool
The .headers companion is only written once the export reaches 100%, so a body without one
is an export that never finished and must not be served.
Tags
Return values
bool —format_data()
Format and escape data ready for the CSV file.
public
format_data(string $data) : string
Parameters
- $data : string
-
Data to format.
Tags
Return values
string —format_term_ids()
Format term ids to names.
public
format_term_ids(array<string|int, mixed> $term_ids, string $taxonomy) : string
Parameters
- $term_ids : array<string|int, mixed>
-
Term IDs to format.
- $taxonomy : string
-
Taxonomy name.
Tags
Return values
string —generate_file()
Generate the CSV file.
public
generate_file() : mixed
Tags
Return values
mixed —get_column_names()
Return an array of supported column names and ids.
public
get_column_names() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —get_columns_to_export()
Return an array of columns to export.
public
get_columns_to_export() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —get_default_column_names()
Return default columns.
public
get_default_column_names() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —get_delimiter()
Return the delimiter to use in CSV file
public
get_delimiter() : string
Tags
Return values
string —get_download_filename()
Get the name the export is downloaded as.
public
get_download_filename() : string
The stored file keeps get_filename(), which only has to identify the export.
Tags
Return values
string —get_file()
Get the file contents.
public
get_file() : string
Tags
Return values
string —get_filename()
Generate and return a filename.
public
get_filename() : string
Return values
string —get_headers_row_file()
Get the contents of the CSV headers row file. Defaults to the original known headers.
public
get_headers_row_file() : string
Tags
Return values
string —get_limit()
Get batch limit.
public
get_limit() : int
Tags
Return values
int —get_page()
Get page.
public
get_page() : int
Tags
Return values
int —get_percent_complete()
Get total % complete.
public
get_percent_complete() : int
Forces an int from parent::get_percent_complete(), which can return a float.
Return values
int — Percent complete.get_report_controller()
Get a REST controller instance for a given report type, or false if unknown.
public
static get_report_controller(string $report_type) : WC_REST_Reports_Controller|false
Parameters
- $report_type : string
-
Report type. E.g. 'orders'.
Tags
Return values
WC_REST_Reports_Controller|false —get_reports_directory()
Get report uploads directory.
public
static get_reports_directory() : string
Return values
string —get_total_exported()
Get count of records exported.
public
get_total_exported() : int
Tags
Return values
int —get_total_rows()
Get total number of rows in export.
public
get_total_rows() : int
Return values
int — Number of rows to export.is_column_exporting()
See if a column is to be exported or not.
public
is_column_exporting(string $column_id) : bool
Parameters
- $column_id : string
-
ID of the column being exported.
Tags
Return values
bool —maybe_create_directory()
Create the directory for reports if it does not yet exist.
public
static maybe_create_directory() : mixed
Return values
mixed —prepare_data_to_export()
Prepare data for export.
public
prepare_data_to_export() : mixed
Return values
mixed —send_content()
Set the export content.
public
send_content(string $csv_data) : mixed
Parameters
- $csv_data : string
-
All CSV content.
Tags
Return values
mixed —send_headers()
Set the export headers.
public
send_headers() : void
Re-sends the parent's Content-Disposition so the download is named after what the report covers, leaving the stored file's name alone.
Tags
Return values
void —set_column_names()
Set column names.
public
set_column_names(array<string|int, mixed> $column_names) : mixed
Parameters
- $column_names : array<string|int, mixed>
-
Column names array.
Tags
Return values
mixed —set_columns_to_export()
Set columns to export.
public
set_columns_to_export(array<string|int, mixed> $columns) : mixed
Parameters
- $columns : array<string|int, mixed>
-
Columns array.
Tags
Return values
mixed —set_download_suffix()
Add detail to the name the export is downloaded as, leaving the stored file's name alone.
public
set_download_suffix(string $suffix) : void
Lets a download say what the report covers, such as the date range, when the stored name only identifies the export.
Parameters
- $suffix : string
-
Detail to append to the download's name, e.g. a date range.
Tags
Return values
void —set_filename()
Set filename to export to.
public
set_filename(string $filename) : mixed
Parameters
- $filename : string
-
Filename to export to.
Return values
mixed —set_limit()
Set batch limit.
public
set_limit(int $limit) : mixed
Parameters
- $limit : int
-
Limit to export.
Tags
Return values
mixed —set_page()
Set page.
public
set_page(int $page) : mixed
Parameters
- $page : int
-
Page Nr.
Tags
Return values
mixed —set_report_args()
Setter for report args.
public
set_report_args(array<string|int, mixed> $args) : mixed
Parameters
- $args : array<string|int, mixed>
-
The report args.
Return values
mixed —set_report_type()
Setter for report type.
public
set_report_type(string $type) : mixed
Parameters
- $type : string
-
The report type. E.g. customers.
Return values
mixed —stream_export_file()
Write the export to the output, leaving the file in place. Send the download headers first.
public
stream_export_file() : void
Tags
Return values
void —export_column_headers()
Export column headers in CSV format.
protected
export_column_headers() : string
Tags
Return values
string —export_row()
Export rows to an array ready for the CSV.
protected
export_row(array<string|int, mixed> $row_data, string $key, resource $buffer) : mixed
Parameters
- $row_data : array<string|int, mixed>
-
Data to export.
- $key : string
-
Column being exported.
- $buffer : resource
-
Output buffer.
Tags
Return values
mixed —export_rows()
Export rows in CSV format.
protected
export_rows() : string
Tags
Return values
string —fputcsv()
Write to the CSV file.
protected
fputcsv(resource $buffer, array<string|int, mixed> $export_row) : mixed
Parameters
- $buffer : resource
-
Resource we are writing to.
- $export_row : array<string|int, mixed>
-
Row to export.
Tags
Return values
mixed —generate_row_data()
Get the export row for a given report item.
protected
generate_row_data(object $item) : array<string|int, mixed>
Parameters
- $item : object
-
Report item data.
Return values
array<string|int, mixed> — CSV row data.get_csv_data()
Get CSV data for this export.
protected
get_csv_data() : string
Tags
Return values
string —get_data_to_export()
Get data that will be exported.
protected
get_data_to_export() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —get_file_path()
Get file path to export to.
protected
get_file_path() : string
Return values
string —get_headers_row_file_path()
Get CSV headers row file path to export to.
protected
get_headers_row_file_path() : string
Return values
string —get_raw_row_data()
Generate row data from a raw report item.
protected
get_raw_row_data(object $item) : array<string|int, mixed>
Parameters
- $item : object
-
Report item data.
Return values
array<string|int, mixed> — CSV row data.get_report_columns()
Get the report columns from the controller.
protected
get_report_columns() : array<string|int, mixed>
Return values
array<string|int, mixed> — Array of report column names.implode_values()
Implode CSV cell values using commas by default, and wrapping values which contain the separator.
protected
implode_values(array<string|int, mixed> $values) : string
Parameters
- $values : array<string|int, mixed>
-
Values to implode.
Tags
Return values
string —map_report_controller()
Get a REST controller instance for the report type.
protected
map_report_controller() : bool|WC_REST_Reports_Controller
Return values
bool|WC_REST_Reports_Controller — Report controller instance or boolean false on error.write_csv_data()
Write data to the file.
protected
write_csv_data(string $data) : mixed
Parameters
- $data : string
-
Data.
Tags
Return values
mixed —get_report_controller_map()
Get the report type to report controller class map.
private
static get_report_controller_map() : array<string|int, mixed>