modules/Import/ImportFileSplitter.php
Show:
inherited
inherited
Classes
\ImportFileSplitter
Package:
Properties
$_fileCount= ''
Count of files that we split the $_sourceFile into
Details
- Type
- n/a
$_recordCount= ''
Count of records in $_sourceFile
Details
- Type
- n/a
$_recordThreshold= ''
Maximum number of records per file
Details
- Type
- n/a
$_sourceFile= ''
Filename of file we are splitting
Details
- Type
- n/a
Methods
__construct(
string $source
=
null, $recordThreshold
=
1000
)
:
voidConstructor
Parameters
| Name | Type | Description |
|---|---|---|
| $source | string | filename we are splitting |
| $recordThreshold |
fileExists(
)
:
boolReturns true if the filename given exists and is readable
Returns
| Type | Description |
|---|---|
| bool |
getFileCount(
)
:
intReturn the count of files created by the split, if it's been processed with splitSourceFile()
Returns
| Type | Description |
|---|---|
| int | count of files created by the split |
getRecordCount(
)
:
intReturn the count of records in the file, if it's been processed with splitSourceFile()
Returns
| Type | Description |
|---|---|
| int | count of records in the file |
getSplitFileName(
int $filenumber
=
0
)
:
stringReturn file name of one of the split files
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $filenumber | int | which split file we want |
| Type | Description |
|---|---|
| string | filename |
splitSourceFile(
string $delimiter
=
',', string $enclosure
=
'"', bool $has_header
=
false
)
:
voidActually split the file into parts
Parameters
| Name | Type | Description |
|---|---|---|
| $delimiter | string | |
| $enclosure | string | |
| $has_header | bool | true if file has a header row |