Settings_WebserviceUsers_ListViewSession_View
extends ModalSettings
in package
List view session class.
Table of Contents
- $autoRegisterEvents : bool
- $columnsToShow : array<string|int, mixed>
- $dangerBtn : string
- The name of the danger button.
- $footerClass : string
- The name of the footerClass.
- $headerClass : string
- Header class.
- $headers : Headers
- $lockExit : bool
- Block the window closing.
- $modalData : array<string|int, string>
- Modal data.
- $modalIcon : mixed
- {@inheritdoc}
- $modalId : string
- Modal ID.
- $modalSize : mixed
- {@inheritdoc}
- $pageTitle : mixed
- {@inheritdoc}
- $showFooter : mixed
- {@inheritdoc}
- $showHeader : bool
- Show modal header.
- $successBtn : string
- The name of the success button.
- $successBtnIcon : string
- The name of the success button icon.
- $activatedLocale : bool
- $blurBackground : bool
- $breadcrumbTitle : string
- Breadcrumb title.
- $draggable : bool
- $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.
- getModalCss() : array<string|int, Vtiger_CssScript_Model>
- Get modal css files that need to loaded in the modal.
- getModalScripts() : array<string|int, Vtiger_JsScript_Model>
- Get modal scripts files that need to loaded in the modal.
- getPageTitle() : string
- Get page title.
- getViewer() : Vtiger_Viewer
- Static function to get the Instance of the Vtiger_Viewer.
- 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
- {@inheritdoc}
- sendHeaders() : mixed
- Send headers.
- validateRequest() : void
- Function to validate request method.
- preProcessDisplay() : mixed
- Pre process display function.
- preProcessTplName() : string
- Pre process template name.
- showBodyHeader() : mixed
- {@inheritdoc}
- showBreadCrumbLine() : bool
- Show bread crumbs.
- showFooter() : mixed
- {@inheritdoc}
Properties
$autoRegisterEvents
public
bool
$autoRegisterEvents
= true
Auto register events
$columnsToShow
public
static array<string|int, mixed>
$columnsToShow
= ['language' => 'FL_LANGUAGE', 'created' => 'FL_LOGIN_TIME', 'changed' => 'FL_DATETIME_LAST_QUERY', 'params' => 'LBL_PARAMS', 'last_method' => 'FL_LAST_METHOD', 'agent' => 'LBL_USER_AGENT', 'parent_id' => 'Accounts']
Columns to show on the list session.
$dangerBtn
The name of the danger button.
public
string
$dangerBtn
= 'LBL_CANCEL'
$footerClass
The name of the footerClass.
public
string
$footerClass
= ''
$headerClass
Header class.
public
string
$headerClass
= ''
$headers
public
Headers
$headers
Headers instance.
$lockExit
Block the window closing.
public
bool
$lockExit
= false
$modalData
Modal data.
public
array<string|int, string>
$modalData
= []
$modalIcon
{@inheritdoc}
public
mixed
$modalIcon
= 'fas fa-users-cog'
$modalId
Modal ID.
public
string
$modalId
= ''
$modalSize
{@inheritdoc}
public
mixed
$modalSize
= 'modal-full'
$pageTitle
{@inheritdoc}
public
mixed
$pageTitle
= 'LBL_SESSION_RECORD'
$showFooter
{@inheritdoc}
public
mixed
$showFooter
= \false
$showHeader
Show modal header.
public
bool
$showHeader
= true
$successBtn
The name of the success button.
public
string
$successBtn
= 'LBL_SAVE'
$successBtnIcon
The name of the success button icon.
public
string
$successBtnIcon
= 'fas fa-check'
$activatedLocale
protected
static bool
$activatedLocale
= false
Activated language locale.
$blurBackground
protected
bool
$blurBackground
= false
Blur background
$breadcrumbTitle
Breadcrumb title.
protected
string
$breadcrumbTitle
$draggable
protected
bool
$draggable
= true
Draggable
$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 —getModalCss()
Get modal css files that need to loaded in the modal.
public
getModalCss(Request $request) : array<string|int, Vtiger_CssScript_Model>
Parameters
- $request : Request
Return values
array<string|int, Vtiger_CssScript_Model> —getModalScripts()
Get modal scripts files that need to loaded in the modal.
public
getModalScripts(Request $request) : array<string|int, Vtiger_JsScript_Model>
Parameters
- $request : Request
Return values
array<string|int, Vtiger_JsScript_Model> —getPageTitle()
Get page title.
public
getPageTitle(Request $request) : string
Parameters
- $request : Request
Return values
string —getViewer()
Static function to get the Instance of the Vtiger_Viewer.
public
getViewer(Request $request) : Vtiger_Viewer
Parameters
- $request : Request
Return values
Vtiger_Viewer —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()
{@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 —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