OXID eShop CE  6.1.5
OxidEsales\EshopCommunity\Application\Controller\Admin\VoucherSerieExport Class Reference
+ Inheritance diagram for OxidEsales\EshopCommunity\Application\Controller\Admin\VoucherSerieExport:
+ Collaboration diagram for OxidEsales\EshopCommunity\Application\Controller\Admin\VoucherSerieExport:

Public Member Functions

 __construct ()
 
 getDownloadUrl ()
 
 download ()
 
 run ()
 
 exportVouchers ($iStart)
 
 write ($sLine)
 

Public Attributes

 $sClassDo = "voucherserie_export"
 
 $sExportFileType = "csv"
 
 $iExportPerTick = 1000
 

Protected Member Functions

 _getExportFileName ()
 
 _getExportFilePath ()
 

Protected Attributes

 $_sThisTemplate = "voucherserie_export.tpl"
 

Detailed Description

General export class.

Constructor & Destructor Documentation

◆ __construct()

OxidEsales\EshopCommunity\Application\Controller\Admin\VoucherSerieExport::__construct ( )

Calls parent costructor and initializes $this->_sFilePath parameter

Member Function Documentation

◆ _getExportFileName()

OxidEsales\EshopCommunity\Application\Controller\Admin\VoucherSerieExport::_getExportFileName ( )
protected

Return export file name

Returns
string

◆ _getExportFilePath()

OxidEsales\EshopCommunity\Application\Controller\Admin\VoucherSerieExport::_getExportFilePath ( )
protected

Return export file path

Returns
string

◆ download()

OxidEsales\EshopCommunity\Application\Controller\Admin\VoucherSerieExport::download ( )

Performs Voucherserie export to export file.

◆ exportVouchers()

OxidEsales\EshopCommunity\Application\Controller\Admin\VoucherSerieExport::exportVouchers (   $iStart)

Writes voucher number information to export file and returns number of written records info

Parameters
int$iStartstart exporting from
Returns
int

◆ getDownloadUrl()

OxidEsales\EshopCommunity\Application\Controller\Admin\VoucherSerieExport::getDownloadUrl ( )

Returns export file download url

Returns
string

◆ run()

OxidEsales\EshopCommunity\Application\Controller\Admin\VoucherSerieExport::run ( )

Does Export

◆ write()

OxidEsales\EshopCommunity\Application\Controller\Admin\VoucherSerieExport::write (   $sLine)

writes one line into open export file

Parameters
string$sLineexported line

Member Data Documentation

◆ $_sThisTemplate

OxidEsales\EshopCommunity\Application\Controller\Admin\VoucherSerieExport::$_sThisTemplate = "voucherserie_export.tpl"
protected

◆ $iExportPerTick

OxidEsales\EshopCommunity\Application\Controller\Admin\VoucherSerieExport::$iExportPerTick = 1000

◆ $sClassDo

OxidEsales\EshopCommunity\Application\Controller\Admin\VoucherSerieExport::$sClassDo = "voucherserie_export"

◆ $sExportFileType

OxidEsales\EshopCommunity\Application\Controller\Admin\VoucherSerieExport::$sExportFileType = "csv"

The documentation for this class was generated from the following file: