Konquadrat API Reference

Index

\com\setasign\Konquadrat
1. Import
  1. RowImport

com\setasign\Konquadrat\Import\RowImport

AbstractRowImportWithImportRelations Class AbstractRowImport

File: /Konquadrat/src/Import/RowImport/AbstractRowImportWithImportRelations.php

Class hierarchy

AbstractRowImport
- AbstractRowImportWithImportRelations

Implements

Summary

Methods

__construct()
getImportRelations()
importRow()
sanitizeRow()
validateEmail()
validateField()

Properties

$importRelations
$languageManager
$objectConfig
$objectFinder
$objectManager

Properties

$importRelations

protected AbstractRowImportWithImportRelations::$importRelations

$languageManager

protected AbstractRowImport::$languageManager

$objectConfig

protected AbstractRowImport::$objectConfig

$objectFinder

protected AbstractRowImport::$objectFinder

$objectManager

protected AbstractRowImport::$objectManager

Methods

__construct()

public AbstractRowImportWithImportRelations::__construct (

\com\setasign\Konquadrat\Object\ObjectConfig $objectConfig,
\com\setasign\Konquadrat\Object\ObjectFinder $objectFinder,
\com\setasign\Konquadrat\Object\ObjectManager $objectManager,
\com\setasign\Konquadrat\LanguageManager $languageManager,
ImportRelationsInterface $importRelations

)

Parameters

$objectConfig : \com\setasign\Konquadrat\Object\ObjectConfig
$objectFinder : \com\setasign\Konquadrat\Object\ObjectFinder
$objectManager : \com\setasign\Konquadrat\Object\ObjectManager
$languageManager : \com\setasign\Konquadrat\LanguageManager
$importRelations : ImportRelationsInterface

getImportRelations()

public AbstractRowImportWithImportRelations::getImportRelations (

void

): ImportRelationsInterface

importRow()

abstract public RowImportInterface::importRow (

MainImportRow $row

): void

Imports the row.

Note that importRow should not throw any exceptions! All possible errors should be found with the sanitizeRow!

Parameters

$row : MainImportRow

Exceptions

Throws \Throwable

sanitizeRow()

abstract public RowImportInterface::sanitizeRow (

MainImportRow $row

): void

Sanitize the row.

Note that sanitizeRow MUST NOT throw any exceptions!

Parameters

$row : MainImportRow

validateEmail()

protected AbstractRowImport::validateEmail (

ImportRow $importRow,
string $columnName

): void

Parameters

$importRow : ImportRow
$columnName : string

validateField()

protected AbstractRowImport::validateField (

string $objectType,
MainImportRow $importRow,
string $columnName,
bool $allowEmpty = false,
?callable $extraValidation = null,
?string $fieldName = null

): void

Parameters

$objectType : string
$importRow : MainImportRow
$columnName : string
$allowEmpty : bool
$extraValidation : ?callable: function(MainImportRow $importRow, string $columnName): void
$fieldName : ?string