Documentation

Import_Module_Model extends Vtiger_Module_Model
in package

Table of Contents

AUTO_MERGE_EXISTINGISPRIORITY  = 4
AUTO_MERGE_IGNORE  = 1
AUTO_MERGE_MERGEFIELDS  = 3
AUTO_MERGE_NONE  = 0
Auto marge state.
AUTO_MERGE_OVERWRITE  = 2
IMPORT_TABLE_PREFIX  = 'u_yf_import_'
Import table prefix.
$componentReader  : array<string|int, mixed>
Components name.
$importModule  : mixed
$importModuleModel  : mixed
$supportedDelimiters  : mixed
$supportedFileEncoding  : mixed
$supportedFileExtensions  : mixed
$supportedFileExtensionsByModule  : mixed
clearUserImportInfo()  : mixed
Function clears data related to import of records by user.
getAutoMergeTypes()  : mixed
getDbTableName()  : string
Function returns name of the table to import.
getFields()  : array<string|int, Vtiger_Field_Model>
Function that returns all the fields for the module.
getFileReader()  : Import_FileReader_Reader
Get file reader.
getImportModule()  : string
Function returns module name where import takes place.
getImportModuleModel()  : Vtiger_Module_Model
Function returns instance of the module where import takes place.
getInventoryDbTableName()  : string
Function returns name of the table to import for data from advanced block.
getListTplForXmlType()  : array<string|int, mixed>
Function returns list of templates to import.
getSupportedDelimiters()  : type
Get supported delimiters.
getSupportedFileEncoding()  : type
Function returns supported extensions.
getSupportedFileExtensions()  : array<string|int, mixed>
Function returns supported extensions.
getSupportedFileExtensionsDescription()  : string
Function returns supported extensions.
getUrl()  : string
Get callback url.
isUserImportBlocked()  : bool
Function checks if import is blocked for user.
setImportModule()  : $this
Set import module name.

Constants

AUTO_MERGE_EXISTINGISPRIORITY

public mixed AUTO_MERGE_EXISTINGISPRIORITY = 4

AUTO_MERGE_IGNORE

public mixed AUTO_MERGE_IGNORE = 1

AUTO_MERGE_MERGEFIELDS

public mixed AUTO_MERGE_MERGEFIELDS = 3

AUTO_MERGE_NONE

Auto marge state.

public int AUTO_MERGE_NONE = ""

AUTO_MERGE_OVERWRITE

public mixed AUTO_MERGE_OVERWRITE = 2

IMPORT_TABLE_PREFIX

Import table prefix.

public string IMPORT_TABLE_PREFIX = 'u_yf_import_'

Properties

$componentReader

Components name.

public static array<string|int, mixed> $componentReader = ['csv' => 'CSVReader', 'vcf' => 'VCardReader', 'ics' => 'ICSReader', 'ical' => 'ICSReader', 'default' => 'FileReader', 'xml' => 'XmlReader', 'zip' => 'ZipReader']

$importModule

public mixed $importModule

$importModuleModel

public mixed $importModuleModel

$supportedDelimiters

public static mixed $supportedDelimiters = [',' => 'comma', ';' => 'semicolon']

$supportedFileEncoding

public static mixed $supportedFileEncoding = ['UTF-8' => 'UTF-8', 'ISO-8859-1' => 'ISO-8859-1', 'Windows-1250' => 'Windows-1250', 'Windows-1251' => 'Windows-1251', 'Windows-1252' => 'Windows-1252', 'Windows-1253' => 'Windows-1253', 'Windows-1254' => 'Windows-1254', 'Windows-1255' => 'Windows-1255', 'Windows-1256' => 'Windows-1256', 'Windows-1257' => 'Windows-1257', 'Windows-1258' => 'Windows-1258']

$supportedFileExtensions

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

$supportedFileExtensionsByModule

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

Methods

clearUserImportInfo()

Function clears data related to import of records by user.

public static clearUserImportInfo(mixed $user) : mixed
Parameters
$user : mixed
Return values
mixed

getAutoMergeTypes()

public static getAutoMergeTypes() : mixed
Return values
mixed

getDbTableName()

Function returns name of the table to import.

public static getDbTableName(mixed $user) : string
Parameters
$user : mixed
Return values
string

getFields()

Function that returns all the fields for the module.

public getFields([mixed $blockInstance = false ]) : array<string|int, Vtiger_Field_Model>
Parameters
$blockInstance : mixed = false
Return values
array<string|int, Vtiger_Field_Model>
  • list of field models

getImportModule()

Function returns module name where import takes place.

public getImportModule() : string
Return values
string

getImportModuleModel()

Function returns instance of the module where import takes place.

public getImportModuleModel() : Vtiger_Module_Model
Return values
Vtiger_Module_Model

getInventoryDbTableName()

Function returns name of the table to import for data from advanced block.

public static getInventoryDbTableName(mixed $user) : string
Parameters
$user : mixed
Return values
string

getListTplForXmlType()

Function returns list of templates to import.

public static getListTplForXmlType(type $moduleName) : array<string|int, mixed>
Parameters
$moduleName : type
Return values
array<string|int, mixed>

getSupportedDelimiters()

Get supported delimiters.

public static getSupportedDelimiters() : type
Return values
type

getSupportedFileEncoding()

Function returns supported extensions.

public static getSupportedFileEncoding() : type
Return values
type

getSupportedFileExtensions()

Function returns supported extensions.

public static getSupportedFileExtensions([string $moduleName = null ]) : array<string|int, mixed>
Parameters
$moduleName : string = null
Return values
array<string|int, mixed>

getSupportedFileExtensionsDescription()

Function returns supported extensions.

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

getUrl()

Get callback url.

public getUrl() : string
Return values
string

isUserImportBlocked()

Function checks if import is blocked for user.

public static isUserImportBlocked(mixed $user) : bool
Parameters
$user : mixed
Return values
bool

setImportModule()

Set import module name.

public setImportModule(string $moduleName) : $this
Parameters
$moduleName : string
Return values
$this

Search results