PHP Class Give_Batch_Export, Give

Since: 1.5
Inheritance: extends Give_Export
Afficher le fichier Open project: wordimpress/give

Méthodes publiques

Свойство 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

Méthodes publiques

Méthode 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

Méthodes protégées

Méthode Description
get_file ( ) : string Retrieve the file data is written to
stash_step_data ( $data = '' ) : void Append data to export file

Method Details

__construct() public méthode

Get things started
Since: 1.5
public __construct ( $_step = 1 )
$_step int The step to process

export() public méthode

Perform the export
Since: 1.5
public export ( ) : void
Résultat void

get_file() protected méthode

Retrieve the file data is written to
Since: 1.5
protected get_file ( ) : string
Résultat string

get_percentage_complete() public méthode

Return the calculated completion percentage
Since: 1.5
public get_percentage_complete ( ) : integer
Résultat integer

pre_fetch() public méthode

Allow for prefetching of data for the remainder of the exporter
Since: 1.5
public pre_fetch ( ) : void
Résultat void

print_csv_cols() public méthode

Output the CSV columns
Since: 1.5
public print_csv_cols ( ) : string
Résultat string

print_csv_rows() public méthode

Print the CSV rows for the current step
Since: 1.5
public print_csv_rows ( ) : string | false
Résultat string | false

process_step() public méthode

Process a step
Since: 1.5
public process_step ( ) : boolean
Résultat boolean

set_properties() public méthode

* Set the properties specific to the export
Since: 1.5
public set_properties ( $request )
$request The Form Data passed into the batch processing

stash_step_data() protected méthode

Append data to export file
Since: 1.5
protected stash_step_data ( $data = '' ) : void
$data string The data to add to the file
Résultat void

Property Details

$end public_oe property

End date, Y-m-d H:i:s
Since: 1.5
public $end

$filename public_oe property

The name of the file the data is stored in
Since: 1.5
public $filename

$filetype public_oe property

The file type, typically .csv
Since: 1.5
public $filetype

$form public_oe property

Form to export data for
Since: 1.5
public $form

$is_empty public_oe property

Is the export file empty
Since: 1.5
public $is_empty

$is_writable public_oe property

Is the export file writable
Since: 1.5
public $is_writable

$price_id public_oe property

Form Price ID to export data for
Since: 1.5
public $price_id

$start public_oe property

Start date, Y-m-d H:i:s
Since: 1.5
public $start

$status public_oe property

Status to export
Since: 1.5
public $status

$step public_oe property

The current step being processed
Since: 1.5
public $step