Documentation

Vtiger_Kanban_View extends Vtiger_Index_View
in package

Kanban view class.

Table of Contents

$csrfActive  : bool
CSRF is active?.
$headers  : Headers
$activatedCsrf  : bool
Activated csrf.
$activatedLocale  : bool
Activated language locale.
$board  : array<string|int, mixed>
$breadcrumbTitle  : string
Breadcrumb title.
$columns  : array<string|int, mixed>
$fieldModel  : Vtiger_Field_Model
$moduleModel  : Vtiger_Module_Model
$pageTitle  : string
Page title.
$viewer  : Vtiger_Viewer
Viewer instance.
$viewName  : int|string
__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.
getPageTitle()  : mixed
{@inheritdoc}
getViewer()  : Vtiger_Viewer
Static function to get the Instance of the Vtiger_Viewer.
isSessionExtend()  : bool
Function to check if session is extended.
loadColumns()  : void
Get columns for kanban.
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()  : bool
Function to validate request method.
convert()  : array<string|int, mixed>
Convert the data.
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.
getRecords()  : array<string|int, mixed>
Get kanban records.
getSummaryFields()  : array<string|int, string>
Get summary fields for kanban item.
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

$csrfActive

CSRF is active?.

public bool $csrfActive = true

$headers

public Headers $headers

Headers instance.

$activatedCsrf

Activated csrf.

protected static bool $activatedCsrf = false

$activatedLocale

Activated language locale.

protected static bool $activatedLocale = false

$board

protected array<string|int, mixed> $board

Active board details.

$breadcrumbTitle

Breadcrumb title.

protected string $breadcrumbTitle

$columns

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

Kanban columns details .

$fieldModel

protected Vtiger_Field_Model $fieldModel

Field Model instance.

$moduleModel

protected Vtiger_Module_Model $moduleModel

Module Model instance.

$pageTitle

Page title.

protected string $pageTitle

$viewName

protected int|string $viewName

List view name or id.

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

{@inheritdoc}

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

isSessionExtend()

Function to check if session is extended.

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

loadColumns()

Get columns for kanban.

public loadColumns() : void
Return values
void

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) : bool
Parameters
$request : Request
Return values
bool

convert()

Convert the data.

protected convert(array<string|int, Vtiger_Record_Model$entries) : array<string|int, mixed>
Parameters
$entries : array<string|int, Vtiger_Record_Model>
Return values
array<string|int, mixed>

getMenu()

Function to get the list of menu.

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

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

getRecords()

Get kanban records.

protected getRecords(Request $request) : array<string|int, mixed>
Parameters
$request : Request
Return values
array<string|int, mixed>

getSummaryFields()

Get summary fields for kanban item.

protected getSummaryFields() : array<string|int, string>
Return values
array<string|int, string>

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
Return values
mixed

        

Search results