modules/Import/ImportCacheFiles.php
Show:
inherited
inherited
Classes
\ImportCacheFiles
Package:
Constants
FILE_MISCELLANEOUS
= 'misc'
FILE_DUPLICATES
= 'dupes'
FILE_DUPLICATES_DISPLAY
= 'dupesdisplay'
FILE_ERRORS
= 'error'
FILE_ERROR_RECORDS
= 'errorrecords'
FILE_ERROR_RECORDS_ONLY
= 'errorrecordsonly'
FILE_STATUS
= 'status'
Properties
array
$all_files= 'array(
self::FILE_MISCELLANEOUS,
self::FILE_DUPLICATES,
self::FILE_DUPLICATES_DISPLAY,
self::FILE_ERRORS,
self::FILE_ERROR_RECORDS,
self::FILE_ERROR_RECORDS_ONLY,
self::FILE_STATUS,
)'
static
List of all cache file names
Default value
array(
self::FILE_MISCELLANEOUS,
self::FILE_DUPLICATES,
self::FILE_DUPLICATES_DISPLAY,
self::FILE_ERRORS,
self::FILE_ERROR_RECORDS,
self::FILE_ERROR_RECORDS_ONLY,
self::FILE_STATUS,
)Details- Type
- array
Methods
_createFileName(
string $type
=
self::FILE_MISCELLANEOUS
)
:
string
static
Returns the filename for a temporary file
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $type | string | string to prepend to the filename, typically to indicate the file's use |
| Type | Description |
|---|---|
| string | filename |
clearCacheFiles(
)
:
void
static
Clears out all cache files in the import directory
convertFileNameToUrl(
string $fileName
)
:
string
static
Function generates a download link for the given import file
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $fileName | string | String value of the upload file name |
| Type | Description |
|---|---|
| string | The converted URL of the file name |
ensureWritable(
)
:
bool
static
Ensure that all cache files are writable or can be created
Returns
| Type | Description |
|---|---|
| bool |
getDuplicateFileDisplayName(
)
:
string
static
Returns the duplicates display filename (the one used for display in html)
Returns
| Type | Description |
|---|---|
| string | filename |
getDuplicateFileName(
)
:
string
static
Returns the duplicates filename (the ones used to download to csv file
Returns
| Type | Description |
|---|---|
| string | filename |
getErrorFileName(
)
:
string
static
Returns the error filename
Returns
| Type | Description |
|---|---|
| string | filename |
getErrorRecordsFileName(
)
:
string
static
Returns the error records filename
Returns
| Type | Description |
|---|---|
| string | filename |
getErrorRecordsWithoutErrorFileName(
)
:
string
static
Returns the error records filename
Returns
| Type | Description |
|---|---|
| string | filename |
getImportDir(
)
:
string
static
Get import directory name
Returns
| Type | Description |
|---|---|
| string |
getStatusFileName(
)
:
string
static
Returns the status filename
Returns
| Type | Description |
|---|---|
| string | filename |