PHP Class Craft\Import_HistoryService

Contains logic for showing import history
Author: Bob Olde Hampsink ([email protected])
Inheritance: extends craft\BaseApplicationComponent
Datei anzeigen Open project: boboldehampsink/import Class Usage Examples

Public Methods

Method Description
clear ( integer $history ) Clear history.
end ( integer $history, string $status ) Stop logging.
log ( integer $history, integer $line, array $errors ) : array Add to log.
show ( ) : array Show all log entries.
showLog ( integer $history ) : array Show a specific log item.
start ( array | object $settings ) : integer Start logging.
version ( integer $history, integer $entry ) Save entry version.

Protected Methods

Method Description
findAllHistories ( CDbCriteria $criteria ) : craft\Import_HistoryRecord[]
findAllLogs ( CDbCriteria $criteria ) : craft\Import_LogRecord[]
findHistoryById ( integer $historyId ) : craft\Import_HistoryRecord
getNewImportEntriesRecord ( ) : craft\Import_EntriesRecord
getNewImportHistoryRecord ( ) : craft\Import_HistoryRecord
getNewImportLogRecord ( ) : craft\Import_LogRecord

Method Details

clear() public method

Clear history.
public clear ( integer $history )
$history integer

end() public method

Stop logging.
public end ( integer $history, string $status )
$history integer
$status string

findAllHistories() protected method

protected findAllHistories ( CDbCriteria $criteria ) : craft\Import_HistoryRecord[]
$criteria CDbCriteria
return craft\Import_HistoryRecord[]

findAllLogs() protected method

protected findAllLogs ( CDbCriteria $criteria ) : craft\Import_LogRecord[]
$criteria CDbCriteria
return craft\Import_LogRecord[]

findHistoryById() protected method

protected findHistoryById ( integer $historyId ) : craft\Import_HistoryRecord
$historyId integer
return craft\Import_HistoryRecord

getNewImportEntriesRecord() protected method

protected getNewImportEntriesRecord ( ) : craft\Import_EntriesRecord
return craft\Import_EntriesRecord

getNewImportHistoryRecord() protected method

protected getNewImportHistoryRecord ( ) : craft\Import_HistoryRecord
return craft\Import_HistoryRecord

getNewImportLogRecord() protected method

protected getNewImportLogRecord ( ) : craft\Import_LogRecord
return craft\Import_LogRecord

log() public method

Add to log.
public log ( integer $history, integer $line, array $errors ) : array
$history integer
$line integer
$errors array
return array

show() public method

Show all log entries.
public show ( ) : array
return array

showLog() public method

Show a specific log item.
public showLog ( integer $history ) : array
$history integer
return array

start() public method

Start logging.
public start ( array | object $settings ) : integer
$settings array | object
return integer

version() public method

Save entry version.
public version ( integer $history, integer $entry )
$history integer
$entry integer