Documentation

Settings_Widgets_Module_Model extends Settings_Vtiger_Module_Model
in package

Settings Widgets Module Model class.

Tags
copyright

YetiForce S.A.

license

YetiForce Public License 6.5 (licenses/LicenseEN.txt or yetiforce.com)

author

Mariusz Krzaczkowski m.krzaczkowski@yetiforce.com

Table of Contents

getCheckboxs()  : array<string|int, mixed>
Function to get checkboxes.
getColumns()  : array<string|int, int>
Return available columns of widgets.
getCustomView()  : array<string|int, mixed>
Get custom views from related modules.
getFields()  : array<string|int, mixed>
Return list of fields for module and uitypes.
getFiletrs()  : array<string|int, mixed>
Function to get filters.
getHeaderSwitch()  : array<string|int, mixed>
Function to get switch buttons for widget.
getLastSequence()  : int
Function to get last sequence number.
getModulesList()  : array<string|int, mixed>
Return list of modules which have summary view.
getSize()  : array<string|int, int>
Return available sizes of widgets.
getType()  : array<string|int, mixed>
Function to get types.
getWidgetInfo()  : type
Return information about widget.
getWidgets()  : array<string|int, mixed>
Function to get widgets.
getWYSIWYGFields()  : array<string|int, mixed>
Return available fields with WYSIWYG.
removeWidget()  : mixed
Remove widget.
saveWidget()  : mixed
Save widget.
updateSequence()  : mixed
Update sequence number.

Methods

getCheckboxs()

Function to get checkboxes.

public getCheckboxs(array<string|int, mixed> $modules) : array<string|int, mixed>
Parameters
$modules : array<string|int, mixed>
Return values
array<string|int, mixed>

getColumns()

Return available columns of widgets.

public getColumns() : array<string|int, int>
Return values
array<string|int, int>

getCustomView()

Get custom views from related modules.

public getCustomView(array<string|int, mixed> $modules) : array<string|int, mixed>
Parameters
$modules : array<string|int, mixed>
Return values
array<string|int, mixed>

getFields()

Return list of fields for module and uitypes.

public getFields(int $tabid[, array<string|int, int>|bool $uitype = false ]) : array<string|int, mixed>
Parameters
$tabid : int
$uitype : array<string|int, int>|bool = false
Return values
array<string|int, mixed>

getFiletrs()

Function to get filters.

public getFiletrs(array<string|int, mixed> $modules) : array<string|int, mixed>
Parameters
$modules : array<string|int, mixed>
Return values
array<string|int, mixed>

getHeaderSwitch()

Function to get switch buttons for widget.

public static getHeaderSwitch(mixed $sourceModule[, array<string|int, mixed> $index = [] ]) : array<string|int, mixed>
Parameters
$sourceModule : mixed
$index : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getLastSequence()

Function to get last sequence number.

public static getLastSequence(int $tabid) : int
Parameters
$tabid : int
Return values
int

getModulesList()

Return list of modules which have summary view.

public getModulesList() : array<string|int, mixed>
Return values
array<string|int, mixed>

getSize()

Return available sizes of widgets.

public getSize() : array<string|int, int>
Return values
array<string|int, int>

getType()

Function to get types.

public getType([int $module = false ]) : array<string|int, mixed>
Parameters
$module : int = false
Return values
array<string|int, mixed>

getWidgetInfo()

Return information about widget.

public getWidgetInfo(int $wid) : type
Parameters
$wid : int
Return values
type

getWidgets()

Function to get widgets.

public static getWidgets([int|string $module = false ]) : array<string|int, mixed>
Parameters
$module : int|string = false
Return values
array<string|int, mixed>

getWYSIWYGFields()

Return available fields with WYSIWYG.

public getWYSIWYGFields(int $tabid, string $module) : array<string|int, mixed>
Parameters
$tabid : int
$module : string
Return values
array<string|int, mixed>

removeWidget()

Remove widget.

public static removeWidget(int $wid) : mixed
Parameters
$wid : int
Return values
mixed

saveWidget()

Save widget.

public static saveWidget(array<string|int, mixed> $params) : mixed
Parameters
$params : array<string|int, mixed>
Return values
mixed

updateSequence()

Update sequence number.

public static updateSequence(array<string|int, mixed> $params) : mixed
Parameters
$params : array<string|int, mixed>
Return values
mixed

        

Search results