Documentation

Import_Main_View extends Page
in package

Abstract page view controller class.

Table of Contents

$csrfActive  : bool
CSRF is active?.
$headers  : Headers
$numberOfRecords  : mixed
$request  : mixed
$user  : mixed
$activatedCsrf  : bool
Activated csrf.
$activatedLocale  : bool
Activated language locale.
$breadcrumbTitle  : string
Breadcrumb title.
$pageTitle  : string
Page title.
$viewer  : Vtiger_Viewer
Viewer instance.
__construct()  : mixed
Constructor.
checkAndConvertCssStyles()  : array<string|int, Vtiger_CssScript_Model>
Check and convert css files.
checkAndConvertJsScripts()  : array<string|int, Vtiger_JsScript_Model>
Check and convert js scripts.
checkPermission()  : mixed
copyFromFileToDB()  : mixed
deleteMap()  : mixed
Delete map.
getBreadcrumbTitle()  : string
Get breadcrumb title.
getFooterScripts()  : array<string|int, Vtiger_JsScript_Model>
Function to get the list of Script models to be included.
getHeaderCss()  : array<string|int, Vtiger_CssScript_Model>
Get header css files that need to loaded in the page.
getHeaderScripts()  : array<string|int, Vtiger_JsScript_Model>
Get header scripts files that need to loaded in the page.
getJSLanguageStrings()  : string
Function returns the Client side language string.
getPageTitle()  : string
Get page title.
getViewer()  : Vtiger_Viewer
Static function to get the Instance of the Vtiger_Viewer.
import()  : mixed
Import data from file.
isSessionExtend()  : bool
Function to check if session is extended.
loadJsConfig()  : mixed
Load js config.
loginRequired()  : bool
Function to check login required permission.
postProcess()  : mixed
Post process function.
postProcessAjax()  : mixed
Post process ajax function.
preProcess()  : mixed
Pre process function.
preProcessAjax()  : mixed
Pre process ajax function.
process()  : mixed
queueDataImport()  : mixed
saveMap()  : mixed
sendHeaders()  : mixed
Send headers.
showCurrentStatus()  : mixed
showImportStatus()  : mixed
Show import status.
showResult()  : mixed
showScheduledStatus()  : mixed
triggerImport()  : mixed
Trigger import.
validateRequest()  : bool
Function to validate request method.
getMenu()  : array<string|int, mixed>
Function to get the list of menu.
getMenuHeaderLinks()  : array<string|int, Vtiger_Link_Model>
Function to get the list of Header Links.
getUserQuickMenuLinks()  : array<string|int, Vtiger_Link_Model>
Function to get the list of User Quick Menu Links.
preProcessDisplay()  : mixed
Pre process display function.
preProcessTplName()  : string
Pre process template name.
showBodyHeader()  : mixed
{@inheritdoc}
showBreadCrumbLine()  : bool
Show bread crumbs.
showFooter()  : mixed
{@inheritdoc}

Properties

$csrfActive

CSRF is active?.

public bool $csrfActive = true

$headers

public Headers $headers

Headers instance.

$numberOfRecords

public mixed $numberOfRecords

$request

public mixed $request

$user

public mixed $user

$activatedCsrf

Activated csrf.

protected static bool $activatedCsrf = false

$activatedLocale

Activated language locale.

protected static bool $activatedLocale = false

$breadcrumbTitle

Breadcrumb title.

protected string $breadcrumbTitle

$pageTitle

Page title.

protected string $pageTitle

Methods

__construct()

Constructor.

public __construct(Request $request, User $user) : mixed
Parameters
$request : Request
$user : User
Return values
mixed

checkAndConvertCssStyles()

Check and convert css files.

public checkAndConvertCssStyles(array<string|int, string> $fileNames[, string $fileExtension = 'css' ]) : array<string|int, Vtiger_CssScript_Model>
Parameters
$fileNames : array<string|int, string>
$fileExtension : string = 'css'
Return values
array<string|int, Vtiger_CssScript_Model>

checkAndConvertJsScripts()

Check and convert js scripts.

public checkAndConvertJsScripts(array<string|int, string> $jsFileNames) : array<string|int, Vtiger_JsScript_Model>
Parameters
$jsFileNames : array<string|int, string>
Return values
array<string|int, Vtiger_JsScript_Model>

checkPermission()

public checkPermission(Request $request) : mixed
Parameters
$request : Request
Return values
mixed

copyFromFileToDB()

public copyFromFileToDB() : mixed
Return values
mixed

deleteMap()

Delete map.

public static deleteMap(Request $request) : mixed
Parameters
$request : Request
Return values
mixed

getBreadcrumbTitle()

Get breadcrumb title.

public getBreadcrumbTitle(Request $request) : string
Parameters
$request : Request
Return values
string

getFooterScripts()

Function to get the list of Script models to be included.

public getFooterScripts(Request $request) : array<string|int, Vtiger_JsScript_Model>
Parameters
$request : Request

Request instance

Return values
array<string|int, Vtiger_JsScript_Model>

getHeaderCss()

Get header css files that need to loaded in the page.

public getHeaderCss(Request $request) : array<string|int, Vtiger_CssScript_Model>
Parameters
$request : Request

Request instance

Return values
array<string|int, Vtiger_CssScript_Model>

getHeaderScripts()

Get header scripts files that need to loaded in the page.

public getHeaderScripts(Request $request) : array<string|int, Vtiger_JsScript_Model>
Parameters
$request : Request

Request instance

Return values
array<string|int, Vtiger_JsScript_Model>

getJSLanguageStrings()

Function returns the Client side language string.

public getJSLanguageStrings(Request $request) : string
Parameters
$request : Request
Return values
string

getPageTitle()

Get page title.

public getPageTitle(Request $request) : string
Parameters
$request : Request
Return values
string

import()

Import data from file.

public static import(Request $request, User $user) : mixed
Parameters
$request : Request
$user : User
Return values
mixed

isSessionExtend()

Function to check if session is extended.

public isSessionExtend(Request $request) : bool
Parameters
$request : Request
Return values
bool

loadJsConfig()

Load js config.

public loadJsConfig(Request $request) : mixed
Parameters
$request : Request
Return values
mixed

loginRequired()

Function to check login required permission.

public loginRequired() : bool
Return values
bool

postProcess()

Post process function.

public postProcess(Request $request[, bool $display = true ]) : mixed
Parameters
$request : Request
$display : bool = true
Return values
mixed

postProcessAjax()

Post process ajax function.

public postProcessAjax(Request $request) : mixed
Parameters
$request : Request
Return values
mixed

preProcess()

Pre process function.

public preProcess(Request $request[, bool $display = true ]) : mixed
Parameters
$request : Request
$display : bool = true
Return values
mixed

preProcessAjax()

Pre process ajax function.

public preProcessAjax(Request $request) : mixed
Parameters
$request : Request
Return values
mixed

process()

public process(Request $request) : mixed
Parameters
$request : Request
Return values
mixed

queueDataImport()

public queueDataImport() : mixed
Return values
mixed

saveMap()

public saveMap() : mixed
Return values
mixed

sendHeaders()

Send headers.

public sendHeaders() : mixed
Return values
mixed

showCurrentStatus()

public static showCurrentStatus(mixed $importInfo, mixed $importStatusCount, mixed $continueImport) : mixed
Parameters
$importInfo : mixed
$importStatusCount : mixed
$continueImport : mixed
Return values
mixed

showImportStatus()

Show import status.

public static showImportStatus(array<string|int, mixed> $importInfo, User $user) : mixed
Parameters
$importInfo : array<string|int, mixed>
$user : User
Tags
throws
AppException
Return values
mixed

showResult()

public static showResult(mixed $importInfo, mixed $importStatusCount) : mixed
Parameters
$importInfo : mixed
$importStatusCount : mixed
Return values
mixed

showScheduledStatus()

public static showScheduledStatus(mixed $importInfo) : mixed
Parameters
$importInfo : mixed
Return values
mixed

triggerImport()

Trigger import.

public triggerImport([bool $batchImport = false ]) : mixed
Parameters
$batchImport : bool = false
Tags
throws
AppException
Return values
mixed

validateRequest()

Function to validate request method.

public validateRequest(Request $request) : bool
Parameters
$request : Request
Return values
bool

getMenu()

Function to get the list of menu.

protected getMenu() : array<string|int, mixed>
Return values
array<string|int, mixed>

Function to get the list of Header Links.

protected getMenuHeaderLinks(Request $request) : array<string|int, Vtiger_Link_Model>
Parameters
$request : Request
Return values
array<string|int, Vtiger_Link_Model>
  • List of Vtiger_Link_Model instances

Function to get the list of User Quick Menu Links.

protected getUserQuickMenuLinks(Request $request) : array<string|int, Vtiger_Link_Model>
Parameters
$request : Request
Return values
array<string|int, Vtiger_Link_Model>
  • List of Vtiger_Link_Model instances

preProcessDisplay()

Pre process display function.

protected preProcessDisplay(Request $request) : mixed
Parameters
$request : Request
Return values
mixed

preProcessTplName()

Pre process template name.

protected preProcessTplName(Request $request) : string
Parameters
$request : Request
Return values
string

showBodyHeader()

{@inheritdoc}

protected showBodyHeader() : mixed
Return values
mixed

showBreadCrumbLine()

Show bread crumbs.

protected showBreadCrumbLine() : bool
Return values
bool

showFooter()

{@inheritdoc}

protected showFooter() : mixed
Return values
mixed

        

Search results