Vtiger_KeyMetrics_Dashboard
extends Vtiger_IndexAjax_View
in package
Abstract page view controller class.
Table of Contents
- $headers : Headers
- $activatedLocale : bool
- $breadcrumbTitle : string
- Breadcrumb title.
- $exposedMethods : array<string|int, string>
- Control the exposure of methods to be invoked from client (kind-of RPC).
- $pageTitle : string
- Page title.
- $viewer : Vtiger_Viewer
- Viewer instance.
- $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() : 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.
- getMetricList() : mixed
- To get the details of a customview entries.
- getPageTitle() : string
- Get page title.
- getRecordsListFromRequest() : mixed
- 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() : 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
- sendHeaders() : mixed
- Send headers.
- validateRequest() : void
- Function to validate request method.
- exposeMethod() : mixed
- Function that will expose methods for external access.
- getHeaderAdditionalTpl() : array<string|int, Vtiger_Link_Model>
- Get the list of additional TPL files to show in the header.
- getKeyMetricsWithCount() : mixed
- 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
$headers
public
Headers
$headers
Headers instance.
$activatedLocale
protected
static bool
$activatedLocale
= false
Activated language locale.
$breadcrumbTitle
Breadcrumb title.
protected
string
$breadcrumbTitle
$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
$viewer
Viewer instance.
protected
Vtiger_Viewer
$viewer
$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
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 —getMetricList()
To get the details of a customview entries.
public
getMetricList() : mixed
Tags
Return values
mixed —getPageTitle()
Get page title.
public
getPageTitle(Request $request) : string
Parameters
- $request : Request
Return values
string —getRecordsListFromRequest()
public
getRecordsListFromRequest(Request $request) : mixed
Parameters
- $request : Request
Return values
mixed —getViewer()
Static function to get the Instance of the Vtiger_Viewer.
public
getViewer(Request $request) : Vtiger_Viewer
Parameters
- $request : Request
Return values
Vtiger_Viewer —invokeExposedMethod()
Function invokes exposed methods for this class.
public
invokeExposedMethod() : type
Tags
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()
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 —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 —exposeMethod()
Function that will expose methods for external access.
protected
exposeMethod(string $name) : mixed
Parameters
- $name : string
-
- method name
Return values
mixed —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
getKeyMetricsWithCount()
protected
getKeyMetricsWithCount() : mixed
Return values
mixed —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 —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