Documentation

Settings_WidgetsManagement_Module_Model extends Settings_Vtiger_Module_Model
in package

Settings OSSMailView index view class.

Tags
copyright

YetiForce Sp. z o.o

license

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

Table of Contents

addBlock()  : mixed
addWidget()  : array<string|int, mixed>
Add widget.
deleteDashboard()  : mixed
filerItems()  : array<string|int, mixed>
Exclude defined values from filters.
getBlocksFromModule()  : mixed
getBlocksId()  : array<string|int, mixed>
Gets blocks.
getDashboardForModule()  : array<string|int, mixed>
Gets all id widgets for the module.
getDashboardInfo()  : mixed
getDashboardTypes()  : array<string|int, mixed>
Function to get all dashboard.
getDataKeys()  : array<string|int, mixed>
getDateSelectDefault()  : array<string|int, mixed>
getDefaultDashboard()  : int
Function to get id of default dashboard.
getDefaultDateRange()  : array<string|int, mixed>
Get default date range.
getDefaultUserId()  : mixed
Function appoints the proper owner.
getDefaultValues()  : array<string|int, mixed>
getFieldsByTypeDate()  : array<string|int, mixed>
Get a date field.
getFilterSelect()  : array<string|int, string>
Function to get available filters.
getFilterSelectDefault()  : array<string|int, mixed>
getRestrictFilter()  : array<string|int, mixed>
Exclude defined values from filters.
getSelectableDashboard()  : mixed
getSize()  : array<string|int, mixed>
getSpecialWidgets()  : mixed
getWidgetSpecial()  : array<string|int, mixed>
getWidgetsWithDate()  : array<string|int, mixed>
getWidgetsWithFilterUsers()  : array<string|int, mixed>
getWidgetsWithLimit()  : array<string|int, mixed>
getWidgetsWithRecordLimit()  : array<string|int, mixed>
getWidgetsWithTitle()  : array<string|int, string>
Function to get filters with customizable title.
removeBlock()  : array<string|int, mixed>
Remove block.
removeWidget()  : array<string|int, mixed>
Remove widget.
saveDashboard()  : mixed
saveDetails()  : mixed
Save data.

Methods

addBlock()

public addBlock(mixed $data, mixed $moduleName, mixed $addToUser) : mixed
Parameters
$data : mixed
$moduleName : mixed
$addToUser : mixed
Return values
mixed

addWidget()

Add widget.

public addWidget(array<string|int, mixed> $data, string $moduleName[, bool $addToUser = false ]) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
$moduleName : string
$addToUser : bool = false
Return values
array<string|int, mixed>

deleteDashboard()

public static deleteDashboard(mixed $dashboardId) : mixed
Parameters
$dashboardId : mixed
Return values
mixed

filerItems()

Exclude defined values from filters.

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

getBlocksFromModule()

public static getBlocksFromModule(mixed $moduleName, mixed $authorized, mixed $dashboard) : mixed
Parameters
$moduleName : mixed
$authorized : mixed
$dashboard : mixed
Return values
mixed

getBlocksId()

Gets blocks.

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

getDashboardForModule()

Gets all id widgets for the module.

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

getDashboardInfo()

public static getDashboardInfo(mixed $dashboardId) : mixed
Parameters
$dashboardId : mixed
Return values
mixed

getDashboardTypes()

Function to get all dashboard.

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

getDataKeys()

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

getDateSelectDefault()

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

getDefaultDashboard()

Function to get id of default dashboard.

public static getDefaultDashboard() : int
Return values
int

getDefaultDateRange()

Get default date range.

public static getDefaultDateRange(Vtiger_Widget_Model $widgetModel) : array<string|int, mixed>
Parameters
$widgetModel : Vtiger_Widget_Model
Return values
array<string|int, mixed>

range ['2018-03-02','2018-03-04']

getDefaultUserId()

Function appoints the proper owner.

public static getDefaultUserId(Vtiger_Widget_Model $widgetModel[, string $moduleName = false ][, mixed $owner = false ]) : mixed
Parameters
$widgetModel : Vtiger_Widget_Model
$moduleName : string = false
$owner : mixed = false
Return values
mixed

getDefaultValues()

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

getFieldsByTypeDate()

Get a date field.

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

getFilterSelect()

Function to get available filters.

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

getFilterSelectDefault()

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

getRestrictFilter()

Exclude defined values from filters.

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

getSelectableDashboard()

public getSelectableDashboard() : mixed
Return values
mixed

getSize()

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

getSpecialWidgets()

public static getSpecialWidgets(mixed $moduleName) : mixed
Parameters
$moduleName : mixed
Return values
mixed

getWidgetSpecial()

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

getWidgetsWithDate()

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

getWidgetsWithFilterUsers()

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

getWidgetsWithLimit()

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

getWidgetsWithRecordLimit()

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

getWidgetsWithTitle()

Function to get filters with customizable title.

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

removeBlock()

Remove block.

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

removeWidget()

Remove widget.

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

saveDashboard()

public static saveDashboard(mixed $dashboardId, mixed $dashboardName) : mixed
Parameters
$dashboardId : mixed
$dashboardName : mixed
Return values
mixed

saveDetails()

Save data.

public saveDetails(array<string|int, mixed> $data, string $moduleName) : mixed
Parameters
$data : array<string|int, mixed>
$moduleName : string
Return values
mixed

Search results