Documentation

Vtiger_Documents_Widget extends Vtiger_RelatedModule_Widget
in package

Documents widget class.

Tags
copyright

YetiForce Sp. z o.o

license

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

author

Radosław Skrzypczak r.skrzypczak@yetiforce.com

Table of Contents

$allowedModules  : mixed
$Config  : mixed
$dbParams  : mixed
$Module  : mixed
$moduleModel  : mixed
$Record  : mixed
__construct()  : mixed
getApiData()  : array<string|int, mixed>
Return data for api.
getCheckboxLables()  : mixed
getConfigTplName()  : mixed
getCustomFields()  : array<string|int, mixed>
Gets custom fields.
getHeaderButtons()  : array<string|int, Vtiger_Link_Model>
Function to get buttons which visible in header widget.
getRelations()  : array<string|int, mixed>
Gets relations.
getUrl()  : mixed
getWidget()  : mixed
isPermitted()  : bool
{@inheritdoc}

Properties

$allowedModules

public mixed $allowedModules = []

$Config

public mixed $Config = []

$dbParams

public mixed $dbParams = []

$Module

public mixed $Module = alse

$moduleModel

public mixed $moduleModel = alse

$Record

public mixed $Record = alse

Methods

__construct()

public __construct([mixed $Module = false ][, mixed $moduleModel = null ][, mixed $Record = null ][, mixed $widget = [] ]) : mixed
Parameters
$Module : mixed = false
$moduleModel : mixed = null
$Record : mixed = null
$widget : mixed = []
Return values
mixed

getApiData()

Return data for api.

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

getCheckboxLables()

public getCheckboxLables(mixed $model, mixed $type, mixed $prefix) : mixed
Parameters
$model : mixed
$type : mixed
$prefix : mixed
Return values
mixed

getConfigTplName()

public getConfigTplName() : mixed
Return values
mixed

getCustomFields()

Gets custom fields.

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

getHeaderButtons()

Function to get buttons which visible in header widget.

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

getRelations()

Gets relations.

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

getWidget()

public getWidget() : mixed
Return values
mixed

isPermitted()

{@inheritdoc}

public isPermitted() : bool
Return values
bool

        

Search results