Documentation

Users_YetiForce_View extends Modal
in package
Uses ExposeMethod

Request visit purpose when logging in as an administrator.

Table of Contents

$autoRegisterEvents  : bool
$csrfActive  : bool
CSRF is active?.
$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  : string
Modal icon.
$modalId  : string
Modal ID.
$modalSize  : string
Modal size.
$showFooter  : bool
Show modal footer.
$showHeader  : bool
Show modal header.
$successBtn  : string
The name of the success button.
$successBtnIcon  : string
The name of the success button icon.
$activatedCsrf  : bool
Activated csrf.
$activatedLocale  : bool
Activated language locale.
$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.
__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>
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.
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
Process function.
registration()  : void
Registration modal process.
sendHeaders()  : mixed
Send headers.
shop()  : void
Shop modal process.
validateRequest()  : bool
Function to validate request method.
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

$autoRegisterEvents

public bool $autoRegisterEvents = true

Auto register events

$csrfActive

CSRF is active?.

public bool $csrfActive = true

$dangerBtn

The name of the danger button.

public string $dangerBtn = ''

$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 = rue

$modalData

Modal data.

public array<string|int, string> $modalData = []

$modalIcon

Modal icon.

public string $modalIcon = 'fas fa-radiation-alt'

$modalId

Modal ID.

public string $modalId = 'YetiForceAlert'

$modalSize

Modal size.

public string $modalSize = 'modal-lg'

$showFooter

Show modal footer.

public bool $showFooter = true

$showHeader

Show modal header.

public bool $showHeader = true

$successBtn

The name of the success button.

public string $successBtn = ''

$successBtnIcon

The name of the success button icon.

public string $successBtnIcon = 'fas fa-check'

$activatedCsrf

Activated csrf.

protected static bool $activatedCsrf = false

$activatedLocale

Activated language locale.

protected static bool $activatedLocale = false

$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

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

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

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

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

Process function.

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

registration()

Registration modal process.

public registration(Request $request) : void
Parameters
$request : Request
Return values
void

sendHeaders()

Send headers.

public sendHeaders() : mixed
Return values
mixed

shop()

Shop modal process.

public shop(Request $request) : void
Parameters
$request : Request
Return values
void

validateRequest()

Function to validate request method.

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

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