ImporterConfig
in package
VuFind CSV importer configuration
Tags
Table of Contents
- $batchSize : int
- Batch size
- $columns : array<string|int, mixed>
- Column data
- $encoding : string
- Input character encoding
- $fields : array<string|int, mixed>
- Field data
- __construct() : mixed
- Constructor
- configureColumn() : void
- Add column configuration
- configureField() : void
- Add field configuration
- getAllFields() : array<string|int, string>
- Get all field names
- getBatchSize() : int
- Get batch size setting
- getColumn() : array<string|int, mixed>
- Get configuration for the specified column.
- getEncoding() : string
- Get encoding setting
- getField() : array<string|int, mixed>
- Get configuration for the specified field.
- getFixedFieldValues() : array<string|int, mixed>
- Initialize a field array with any fixed values configured here.
- getOutstandingCallbacks() : array<string|int, string>
- Get a list of fields with callbacks that have not already been processed.
Properties
$batchSize
Batch size
protected
int
$batchSize
= 100
$columns
Column data
protected
array<string|int, mixed>
$columns
= []
$encoding
Input character encoding
protected
string
$encoding
= 'UTF-8'
$fields
Field data
protected
array<string|int, mixed>
$fields
= []
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $options : array<string|int, mixed> = []
-
Config options
Return values
mixed —configureColumn()
Add column configuration
public
configureColumn(int $column, array<string|int, mixed> $config) : void
Parameters
- $column : int
-
Column number
- $config : array<string|int, mixed>
-
Column configuration
Return values
void —configureField()
Add field configuration
public
configureField(string $name, array<string|int, mixed> $config) : void
Parameters
- $name : string
-
Field name
- $config : array<string|int, mixed>
-
Field configuration
Return values
void —getAllFields()
Get all field names
public
getAllFields() : array<string|int, string>
Return values
array<string|int, string> —getBatchSize()
Get batch size setting
public
getBatchSize() : int
Return values
int —getColumn()
Get configuration for the specified column.
public
getColumn(int $column) : array<string|int, mixed>
Parameters
- $column : int
-
Column number
Return values
array<string|int, mixed> —getEncoding()
Get encoding setting
public
getEncoding() : string
Return values
string —getField()
Get configuration for the specified field.
public
getField(string $name) : array<string|int, mixed>
Parameters
- $name : string
-
Field name
Return values
array<string|int, mixed> —getFixedFieldValues()
Initialize a field array with any fixed values configured here.
public
getFixedFieldValues() : array<string|int, mixed>
Return values
array<string|int, mixed> —getOutstandingCallbacks()
Get a list of fields with callbacks that have not already been processed.
public
getOutstandingCallbacks(array<string|int, string> $processed) : array<string|int, string>
Parameters
- $processed : array<string|int, string>
-
List of fields that have already been processed.