Documentation

Install_Index_View extends Base
in package
Uses ExposeMethod

Abstract base view controller class.

Table of Contents

$headers  : Headers
$activatedLocale  : bool
$breadcrumbTitle  : string
Breadcrumb title.
$debug  : bool
$exposedMethods  : array<string|int, string>
Control the exposure of methods to be invoked from client (kind-of RPC).
$pageTitle  : string
Page title.
$stepNumber  : int
Step number.
$viewer  : Vtiger_Viewer
Viewer instance.
$csrfInitiated  : bool
__construct()  : mixed
{@inheritdoc}
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
{@inheritdoc}
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>
Retrieves css styles 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.
invokeExposedMethod()  : type
Function invokes exposed methods for this class.
isMethodExposed()  : bool
Function checks if the method is exposed for client usage.
isSessionExtend()  : bool
Function to check if session is extended.
loadJsConfig()  : mixed
Load js config.
loginRequired()  : mixed
{@inheritdoc}
postProcess()  : mixed
Post process function.
postProcessAjax()  : mixed
Post process ajax function.
preProcess()  : mixed
Pre process function.
preProcessAjax()  : mixed
Pre process ajax function.
process()  : mixed
{@inheritdoc}
sendHeaders()  : mixed
Send headers.
setLanguage()  : Request
Set language.
step1()  : mixed
step2()  : mixed
step3()  : mixed
step4()  : mixed
step5()  : mixed
step6()  : mixed
Create configuration file.
step7()  : mixed
validateRequest()  : mixed
{@inheritdoc}
exposeMethod()  : mixed
Function that will expose methods for external access.
preProcessDisplay()  : mixed
Pre process display function.
preProcessTplName()  : string
Pre process template name.
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

$debug

protected bool $debug = \false

$exposedMethods

Control the exposure of methods to be invoked from client (kind-of RPC).

protected array<string|int, string> $exposedMethods = []

$pageTitle

Page title.

protected string $pageTitle

$stepNumber

Step number.

protected int $stepNumber = 1

$csrfInitiated

private static bool $csrfInitiated = false

CSRF already initiated.

Methods

__construct()

{@inheritdoc}

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

{@inheritdoc}

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

getBreadcrumbTitle()

Get breadcrumb title.

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

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 —

invokeExposedMethod()

Function invokes exposed methods for this class.

public invokeExposedMethod() : type
Tags
throws
AppException
Return values
type —

isMethodExposed()

Function checks if the method is exposed for client usage.

public isMethodExposed(string $name) : bool
Parameters
$name : string
  • method name
Return values
bool —

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

{@inheritdoc}

public loginRequired() : mixed
Return values
mixed —

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 function.

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

preProcessAjax()

Pre process ajax function.

public preProcessAjax(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 —

step1()

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

step2()

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

step3()

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

step4()

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

step5()

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

step6()

Create configuration file.

public step6(Request $request) : mixed
Parameters
$request : Request
Tags
throws
SmartyException
Return values
mixed —

step7()

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

validateRequest()

{@inheritdoc}

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

exposeMethod()

Function that will expose methods for external access.

protected exposeMethod(string $name) : mixed
Parameters
$name : string
  • method name
Return values
mixed —

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