Documentation

Import_Utils_Helper
in package

Table of Contents

$AUTO_MERGE_IGNORE  : mixed
$AUTO_MERGE_MERGEFIELDS  : mixed
$AUTO_MERGE_NONE  : mixed
$AUTO_MERGE_OVERWRITE  : mixed
$supportedFileExtensions  : mixed
$supportedFileExtensionsByModule  : mixed
getAssignedToGroupList()  : mixed
getAssignedToUserList()  : mixed
getImportFilePath()  : string
The function takes the path of the file to be imported.
getSupportedFileExtensions()  : mixed
getSupportedFileExtensionsDescription()  : string
Get supported file extensions description.
hasAssignPrivilege()  : mixed
showErrorPage()  : mixed
showImportLockedError()  : mixed
showImportTableBlockedError()  : mixed
Shows import errors in the table.
validateFileUpload()  : bool
Validates uploads file.

Properties

$AUTO_MERGE_IGNORE

public static mixed $AUTO_MERGE_IGNORE = 1

$AUTO_MERGE_MERGEFIELDS

public static mixed $AUTO_MERGE_MERGEFIELDS = 3

$AUTO_MERGE_NONE

public static mixed $AUTO_MERGE_NONE = 0

$AUTO_MERGE_OVERWRITE

public static mixed $AUTO_MERGE_OVERWRITE = 2

$supportedFileExtensions

public static mixed $supportedFileExtensions = ['csv', 'vcf', 'ical', 'xml', 'ics']

$supportedFileExtensionsByModule

public static mixed $supportedFileExtensionsByModule = ['Contacts' => ['csv', 'vcf'], 'Calendar' => ['csv', 'ical', 'ics'], 'Default' => ['csv', 'xml', 'zip']]

Methods

getAssignedToGroupList()

public static getAssignedToGroupList(mixed $module) : mixed
Parameters
$module : mixed
Return values
mixed

getAssignedToUserList()

public static getAssignedToUserList(mixed $module) : mixed
Parameters
$module : mixed
Return values
mixed

getImportFilePath()

The function takes the path of the file to be imported.

public static getImportFilePath(User $user) : string
Parameters
$user : User
Return values
string

getSupportedFileExtensions()

public static getSupportedFileExtensions([mixed $moduleName = null ]) : mixed
Parameters
$moduleName : mixed = null
Return values
mixed

getSupportedFileExtensionsDescription()

Get supported file extensions description.

public static getSupportedFileExtensionsDescription(string $moduleName) : string
Parameters
$moduleName : string
Return values
string

hasAssignPrivilege()

public static hasAssignPrivilege(mixed $moduleName, mixed $assignToUserId) : mixed
Parameters
$moduleName : mixed
$assignToUserId : mixed
Return values
mixed

showErrorPage()

public static showErrorPage(mixed $errorMessage[, mixed $errorDetails = false ][, mixed $customActions = false ]) : mixed
Parameters
$errorMessage : mixed
$errorDetails : mixed = false
$customActions : mixed = false
Return values
mixed

showImportLockedError()

public static showImportLockedError(mixed $lockInfo) : mixed
Parameters
$lockInfo : mixed
Return values
mixed

showImportTableBlockedError()

Shows import errors in the table.

public static showImportTableBlockedError(string $moduleName) : mixed
Parameters
$moduleName : string
Return values
mixed

validateFileUpload()

Validates uploads file.

public static validateFileUpload(Request $request) : bool
Parameters
$request : Request
Return values
bool

        

Search results