| Property | Type | Description | |
|---|---|---|---|
| $end | End date, Y-m-d H:i:s | ||
| $filename | The name of the file the data is stored in | ||
| $filetype | The file type, typically .csv | ||
| $form | Form to export data for | ||
| $is_empty | Is the export file empty | ||
| $is_writable | Is the export file writable | ||
| $price_id | Form Price ID to export data for | ||
| $start | Start date, Y-m-d H:i:s | ||
| $status | Status to export | ||
| $step | The current step being processed |
| Method | Description | |
|---|---|---|
| __construct ( $_step = 1 ) | Get things started | |
| export ( ) : void | Perform the export | |
| get_percentage_complete ( ) : integer | Return the calculated completion percentage | |
| pre_fetch ( ) : void | Allow for prefetching of data for the remainder of the exporter | |
| print_csv_cols ( ) : string | Output the CSV columns | |
| print_csv_rows ( ) : string | false | Print the CSV rows for the current step | |
| process_step ( ) : boolean | Process a step | |
| set_properties ( $request ) | * Set the properties specific to the export |
| Method | Description | |
|---|---|---|
| get_file ( ) : string | Retrieve the file data is written to | |
| stash_step_data ( $data = '' ) : void | Append data to export file |
| public __construct ( $_step = 1 ) | ||
| $_step | int The step to process | |
| public get_percentage_complete ( ) : integer | ||
| return | integer | |
| public print_csv_cols ( ) : string | ||
| return | string | |
| public print_csv_rows ( ) : string | false | ||
| return | string | false | |
| public set_properties ( $request ) | ||
| $request | The Form Data passed into the batch processing | |
| protected stash_step_data ( $data = '' ) : void | ||
| $data | string The data to add to the file | |
| return | void | |