com\setasign\Konquadrat\Object\Custom\Traits

ImportTask Trait ImportTask

File: /Konquadrat/src/Object/Custom/traits/ImportTask.php

Used in

Summary

Properties

$STATUS_IMPORT

protected ImportTask::$STATUS_IMPORT = 'import_data'

$STATUS_READ_FILE

protected ImportTask::$STATUS_READ_FILE = 'read_file'

$STATUS_VALIDATE_DATA

protected ImportTask::$STATUS_VALIDATE_DATA = 'validate_data'

$importRelationsTable

protected \com\setasign\SetaFramework\Database\TableInterface ImportTask::$importRelationsTable

$importTable

protected \com\setasign\SetaFramework\Database\TableInterface ImportTask::$importTable

Methods

deleteImportRelationsTable()

public ImportTask::deleteImportRelationsTable (
?callable $where = null
): void
Parameters
$where : ?callable
 

deleteImportTable()

public ImportTask::deleteImportTable (
?callable $where = null
): void

Deletes all entries in the import table.

If $where is a callable it will get called with $where(DeleteQuery $delete, Database $db). The DeleteQuery is already prefiltered with the importId.

Parameters
$where : ?callable
 

getImportRelationsTableSelect()

public ImportTask::getImportRelationsTableSelect (
void
): \com\setasign\SetaFramework\Database\TableSelectInterface

getImportTableSelect()

public ImportTask::getImportTableSelect (
void
): \com\setasign\SetaFramework\Database\TableSelectInterface

The returned select is already prefiltered with the importId.

getName()

getProgress()

public ImportTask::getProgress (
void
): float

import()

protected ImportTask::import (
void
): bool
Return Values

Is Finished?

Exceptions

Throws \Throwable

initAndWakeupImportTask()

public ImportTask::initAndWakeupImportTask (
\com\setasign\SetaFramework\Database\TableFactoryInterface $tableFactory,
\com\setasign\Konquadrat\Import\RowImport\RowImportHandlerFactoryInterface $rowImportHandlerFactory
): void
Parameters
$tableFactory : \com\setasign\SetaFramework\Database\TableFactoryInterface
 
$rowImportHandlerFactory : \com\setasign\Konquadrat\Import\RowImport\RowImportHandlerFactoryInterface
 

insertIntoImportRelationsTable()

public ImportTask::insertIntoImportRelationsTable (
array $data
): void
Parameters
$data : array
 

insertIntoImportTable()

protected ImportTask::insertIntoImportTable (
array $data
): void
Parameters
$data : array
 

process()

public ImportTask::process (
void
): void
Exceptions

Throws \Throwable

readFile()

protected ImportTask::readFile (
void
): bool
Return Values

Is Finished?

Exceptions

Throws \com\setasign\Konquadrat\Exception

Throws \Throwable

setParams()

public ImportTask::setParams (
$params
): void
Parameters
$params
 

updateImportRelationsTable()

public ImportTask::updateImportRelationsTable (
array $data,
?callable $where
): void
Parameters
$data : array
 
$where : ?callable
 

validateData()

protected ImportTask::validateData (
void
): bool
Return Values

Is Finished?

Exceptions

Throws \Throwable