PHP Class Craft\AmForms_ExportsService

Inheritance: extends craft\BaseApplicationComponent
ファイルを表示 Open project: am-impact/amforms

Public Methods

Method Description
__construct ( )
deleteExportById ( integer $id ) : boolean Delete an export.
deleteExportFilesForForm ( AmForms_FormModel $form ) : boolean Delete export files for a form.
deleteTempExportFiles ( ) : boolean Delete temporarily created export files.
getAllExports ( ) : array | null Get all exports.
getExportById ( integer $id ) : craft\AmForms_ExportModel | null Get an export by its ID.
getExportFields ( AmForms_FormModel $form ) : array Get export fields for a form.
getTempExportFiles ( array $exports = [] ) : boolean | array Get temporarily created export files.
restartExport ( craft\AmForms_ExportModel $export ) Restart an export.
runExport ( craft\AmForms_ExportModel $export, integer $limit = null, integer $offset = null ) : boolean Run an export.
saveExport ( craft\AmForms_ExportModel $export ) : boolean Save an export.
saveTotalByCriteria ( craft\AmForms_ExportModel $export ) Save total submissions that meet the saved criteria.

Private Methods

Method Description
_addExportCriteria ( craft\AmForms_ExportModel $export, &$criteria ) : boolean Add export criteria.
_createExportFile ( craft\AmForms_ExportModel $export, AmForms_FormModel $form ) : string Create an export file.
_exportSubmission ( craft\AmForms_ExportModel $export, mixed $submission, boolean $returnData = false ) Export submission.
_exportSubmissionToZip ( craft\AmForms_ExportModel $export, craft\AmForms_SubmissionModel $submission ) Export a submission to the export's zip file.
_getExportColumns ( craft\AmForms_ExportModel $export, AmForms_FormModel $form ) : array Get export columns.
_getExportPath ( ) : string Get export path.

Method Details

__construct() public method

public __construct ( )

deleteExportById() public method

Delete an export.
public deleteExportById ( integer $id ) : boolean
$id integer
return boolean

deleteExportFilesForForm() public method

Delete export files for a form.
public deleteExportFilesForForm ( AmForms_FormModel $form ) : boolean
$form AmForms_FormModel
return boolean

deleteTempExportFiles() public method

Delete temporarily created export files.
public deleteTempExportFiles ( ) : boolean
return boolean

getAllExports() public method

Get all exports.
public getAllExports ( ) : array | null
return array | null

getExportById() public method

Get an export by its ID.
public getExportById ( integer $id ) : craft\AmForms_ExportModel | null
$id integer
return craft\AmForms_ExportModel | null

getExportFields() public method

Get export fields for a form.
public getExportFields ( AmForms_FormModel $form ) : array
$form AmForms_FormModel
return array

getTempExportFiles() public method

Note: these files were created by single submission export.
public getTempExportFiles ( array $exports = [] ) : boolean | array
$exports array Array with AmForms_ExportModel to be able to skip files.
return boolean | array

restartExport() public method

Restart an export.
public restartExport ( craft\AmForms_ExportModel $export )
$export craft\AmForms_ExportModel

runExport() public method

Run an export.
public runExport ( craft\AmForms_ExportModel $export, integer $limit = null, integer $offset = null ) : boolean
$export craft\AmForms_ExportModel
$limit integer
$offset integer
return boolean

saveExport() public method

Save an export.
public saveExport ( craft\AmForms_ExportModel $export ) : boolean
$export craft\AmForms_ExportModel
return boolean

saveTotalByCriteria() public method

Save total submissions that meet the saved criteria.
public saveTotalByCriteria ( craft\AmForms_ExportModel $export )
$export craft\AmForms_ExportModel