Documentation

Vtiger_List_View extends Vtiger_Index_View
in package

Abstract page view controller class.

Table of Contents

$headers  : Headers
$activatedLocale  : bool
$breadcrumbTitle  : string
Breadcrumb title.
$listViewCount  : mixed
$listViewEntries  : mixed
$listViewHeaders  : mixed
$listViewLinks  : mixed
$listViewModel  : Vtiger_ListView_Model
List view model instance.
$pageTitle  : string
Page title.
$viewer  : Vtiger_Viewer
Viewer instance.
$viewName  : int|string
$csrfInitiated  : bool
__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
Function to check permission.
getBreadcrumbTitle()  : mixed
{@inheritdoc}
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()  : mixed
{@inheritdoc}
getProcessTemplate()  : string
Get template name for process.
getViewer()  : Vtiger_Viewer
Static function to get the Instance of the Vtiger_Viewer.
initializeListViewContents()  : mixed
Function to initialize the required data in smarty to display the List View Contents.
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.
preProcessAjax()  : mixed
Pre process ajax function.
preProcessTplName()  : mixed
{@inheritdoc}
process()  : mixed
{@inheritdoc}
sendHeaders()  : mixed
Send headers.
validateRequest()  : void
Function to validate request method.
getHeaderAdditionalTpl()  : array<string|int, Vtiger_Link_Model>
Get the list of additional TPL files to show in the header.
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.
showBodyHeader()  : mixed
{@inheritdoc}
showBreadCrumbLine()  : bool
Show bread crumbs.
showFooter()  : mixed
{@inheritdoc}

Properties

$headers

public Headers $headers

Headers instance.

$activatedLocale

protected static bool $activatedLocale = false

Activated language locale.

$breadcrumbTitle

Breadcrumb title.

protected string $breadcrumbTitle

$listViewCount

protected mixed $listViewCount = \false

$listViewEntries

protected mixed $listViewEntries = \false

$listViewHeaders

protected mixed $listViewHeaders = \false

$listViewLinks

protected mixed $listViewLinks = \false

$listViewModel

List view model instance.

protected Vtiger_ListView_Model $listViewModel

$pageTitle

Page title.

protected string $pageTitle = 'LBL_VIEW_LIST'

$viewName

protected int|string $viewName

List view name or id.

$csrfInitiated

private static bool $csrfInitiated = false

CSRF already initiated.

Methods

__construct()

Constructor.

public __construct() : mixed
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()

Function to check permission.

public abstract checkPermission(Request $request) : mixed
Parameters
$request : Request
Tags
throws
NoPermitted
Return values
mixed —

getBreadcrumbTitle()

{@inheritdoc}

public getBreadcrumbTitle(Request $request) : mixed
Parameters
$request : Request
Return values
mixed —

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()

{@inheritdoc}

public getPageTitle(Request $request) : mixed
Parameters
$request : Request
Return values
mixed —

getProcessTemplate()

Get template name for process.

public getProcessTemplate() : string
Return values
string —

initializeListViewContents()

Function to initialize the required data in smarty to display the List View Contents.

public initializeListViewContents(Request $request, Vtiger_Viewer $viewer) : mixed
Parameters
$request : Request
$viewer : Vtiger_Viewer
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[, mixed $display = true ]) : mixed
Parameters
$request : Request
$display : mixed = true
Return values
mixed —

postProcessAjax()

Post process ajax function.

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

preProcess()

Pre process.

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 —

preProcessTplName()

{@inheritdoc}

public preProcessTplName(Request $request) : mixed
Parameters
$request : Request
Return values
mixed —

process()

{@inheritdoc}

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

sendHeaders()

Send headers.

public sendHeaders() : mixed
Return values
mixed —

validateRequest()

Function to validate request method.

public validateRequest(Request $request) : void
Parameters
$request : Request
Return values
void —

getHeaderAdditionalTpl()

Get the list of additional TPL files to show in the header.

protected getHeaderAdditionalTpl(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

getMenu()

Function to get the list of menu.

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

getMenuHeaderLinks()

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

getUserQuickMenuLinks()

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 —

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