PHP Класс Give_Batch_Export, Give

С версии: 1.5
Наследование: extends Give_Export
Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
$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

Открытые методы

Метод Описание
__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

Защищенные методы

Метод Описание
get_file ( ) : string Retrieve the file data is written to
stash_step_data ( $data = '' ) : void Append data to export file

Описание методов

__construct() публичный Метод

Get things started
С версии: 1.5
public __construct ( $_step = 1 )
$_step int The step to process

export() публичный Метод

Perform the export
С версии: 1.5
public export ( ) : void
Результат void

get_file() защищенный Метод

Retrieve the file data is written to
С версии: 1.5
protected get_file ( ) : string
Результат string

get_percentage_complete() публичный Метод

Return the calculated completion percentage
С версии: 1.5
public get_percentage_complete ( ) : integer
Результат integer

pre_fetch() публичный Метод

Allow for prefetching of data for the remainder of the exporter
С версии: 1.5
public pre_fetch ( ) : void
Результат void

print_csv_cols() публичный Метод

Output the CSV columns
С версии: 1.5
public print_csv_cols ( ) : string
Результат string

print_csv_rows() публичный Метод

Print the CSV rows for the current step
С версии: 1.5
public print_csv_rows ( ) : string | false
Результат string | false

process_step() публичный Метод

Process a step
С версии: 1.5
public process_step ( ) : boolean
Результат boolean

set_properties() публичный Метод

* Set the properties specific to the export
С версии: 1.5
public set_properties ( $request )
$request The Form Data passed into the batch processing

stash_step_data() защищенный Метод

Append data to export file
С версии: 1.5
protected stash_step_data ( $data = '' ) : void
$data string The data to add to the file
Результат void

Описание свойств

$end публичное свойство

End date, Y-m-d H:i:s
С версии: 1.5
public $end

$filename публичное свойство

The name of the file the data is stored in
С версии: 1.5
public $filename

$filetype публичное свойство

The file type, typically .csv
С версии: 1.5
public $filetype

$form публичное свойство

Form to export data for
С версии: 1.5
public $form

$is_empty публичное свойство

Is the export file empty
С версии: 1.5
public $is_empty

$is_writable публичное свойство

Is the export file writable
С версии: 1.5
public $is_writable

$price_id публичное свойство

Form Price ID to export data for
С версии: 1.5
public $price_id

$start публичное свойство

Start date, Y-m-d H:i:s
С версии: 1.5
public $start

$status публичное свойство

Status to export
С версии: 1.5
public $status

$step публичное свойство

The current step being processed
С версии: 1.5
public $step