Documentation

IStorages_RelationListView_Model extends Vtiger_RelationListView_Model
in package

RelationListView Model 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

$mandatoryColumns  : array<string|int, mixed>
Mandatory columns.
$parentRecordModel  : Vtiger_Record_Model
Parent record model instance.
$relatedModuleModel  : Vtiger_Module_Model
Related module model instance.
$relationModel  : Vtiger_Relation_Model
Relation model instance.
$value  : mixed
__construct()  : mixed
Constructor.
get()  : mixed
Function to get the value for a given key.
getAddRelationLinks()  : array<string|int, Vtiger_Link_Model>
Function to get the add links for related list.
getAllEntries()  : array<string|int, Vtiger_Record_Model>
Gets all entries.
getArray()  : array<string|int, mixed>
Function to get the array values for a given key.
getCreateViewUrl()  : mixed
getData()  : array<string|int, mixed>
Function to get all the values of the Object.
getEntries()  : array<string|int, Vtiger_Record_Model>
Function to get the related list view entries.
getEntryExtend()  : mixed
Function extending recordModel object with additional information.
getFavoriteRecords()  : mixed
getForHtml()  : mixed
Function to get the html encoded value for a given key.
getForSql()  : mixed
Function to get the value if its safe to use for SQL Query (column).
getHeaders()  : array<string|int, Vtiger_Field_Model>
Get header fields.
getInstance()  : self
Get relation list view model instance.
getKeys()  : array<string|int, string>
Function to get keys.
getLinks()  : array<string|int, Vtiger_Link_Model>
Function to get the links for related list.
getParentRecordModel()  : Vtiger_Record_Model
Get parent record model instance.
getQueryGenerator()  : QueryGenerator
Get query generator instance.
getRecordsFromArray()  : array<string|int, Vtiger_Record_Model>
Get models of records from array.
getRelatedEntriesCount()  : int
Function to get Total number of record in this relation.
getRelatedModuleModel()  : Vtiger_Module_Model
Get related module model instance.
getRelatedTreeEntriesCount()  : int
Function to get Total number of record in this relation.
getRelationModel()  : Vtiger_Relation_Model
Get relation model instance.
getRelationQuery()  : Query|QueryGenerator
Function to get Relation query.
getSelectRelationLinks()  : array<string|int, Vtiger_Link_Model>
Function to get the select links for related list.
getTreeEntries()  : array<string|int, array<string|int, mixed>>
Get tree entries.
getTreeHeaders()  : array<string|int, string>
Get tree headers.
getTreeViewModel()  : Vtiger_TreeCategoryModal_Model
Get tree view model.
getWidgets()  : array<string|int, mixed>
Get widgets instances.
getWidgetsList()  : array<string|int, mixed>
Get widgets list.
has()  : bool
Function to check if the key exists.
isEmpty()  : bool
Function to check if the key is empty.
isQuickSearchEnabled()  : mixed
Function to identify if the module supports quick search or not.
isWidgetsList()  : bool
Check if widgets exist.
loadCondition()  : mixed
Load list view conditions.
loadCustomView()  : mixed
Load custom view.
loadOrderBy()  : mixed
Set list view order by.
remove()  : mixed
Function to remove the value.
set()  : $this
Function to set the value for a given key.
setData()  : $this
Function to set all the values.
setFields()  : mixed
Set fileds.
setParentRecordModel()  : $this
Set parent record model instance.
setRelatedModuleModel()  : $this
Set related module model instance.
setRelationModel()  : $this
Set relation model instance.

Properties

$mandatoryColumns

Mandatory columns.

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

$relatedModuleModel

Related module model instance.

protected Vtiger_Module_Model $relatedModuleModel

$value

protected mixed $value

Methods

__construct()

Constructor.

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

get()

Function to get the value for a given key.

public get(string $key) : mixed
Parameters
$key : string
Return values
mixed

Value for the given key

Function to get the add links for related list.

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

getArray()

Function to get the array values for a given key.

public getArray(string $key[, array<string|int, mixed> $value = [] ]) : array<string|int, mixed>
Parameters
$key : string
$value : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getCreateViewUrl()

public getCreateViewUrl() : mixed
Return values
mixed

getData()

Function to get all the values of the Object.

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

getFavoriteRecords()

public getFavoriteRecords() : mixed
Return values
mixed

getForHtml()

Function to get the html encoded value for a given key.

public getForHtml(string $key) : mixed
Parameters
$key : string
Return values
mixed

getForSql()

Function to get the value if its safe to use for SQL Query (column).

public getForSql(string $key[, bool $skipEmtpy = true ]) : mixed
Parameters
$key : string
$skipEmtpy : bool = true

Skip the check if string is empty

Return values
mixed

Value for the given key

getHeaders()

Get header fields.

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

getInstance()

Get relation list view model instance.

public static getInstance(Vtiger_Record_Model $parentRecordModel, string $relationModuleName[, bool|int $relationId = false ], int|string $cvId) : self
Parameters
$parentRecordModel : Vtiger_Record_Model
$relationModuleName : string
$relationId : bool|int = false
$cvId : int|string
Return values
self

getKeys()

Function to get keys.

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

Function to get the links for related list.

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

getRelatedEntriesCount()

Function to get Total number of record in this relation.

public getRelatedEntriesCount() : int
Return values
int

getRelatedModuleModel()

Get related module model instance.

public getRelatedModuleModel() : Vtiger_Module_Model
Return values
Vtiger_Module_Model

getRelatedTreeEntriesCount()

Function to get Total number of record in this relation.

public getRelatedTreeEntriesCount() : int
Return values
int

Function to get the select links for related list.

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

getTreeEntries()

Get tree entries.

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

getTreeHeaders()

Get tree headers.

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

getWidgets()

Get widgets instances.

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

getWidgetsList()

Get widgets list.

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

has()

Function to check if the key exists.

public has(string $key) : bool
Parameters
$key : string
Return values
bool

isEmpty()

Function to check if the key is empty.

public isEmpty(string $key) : bool
Parameters
$key : string
Return values
bool

isQuickSearchEnabled()

Function to identify if the module supports quick search or not.

public isQuickSearchEnabled() : mixed
Return values
mixed

isWidgetsList()

Check if widgets exist.

public isWidgetsList() : bool
Return values
bool

loadCondition()

Load list view conditions.

public loadCondition() : mixed
Return values
mixed

loadCustomView()

Load custom view.

public loadCustomView() : mixed
Return values
mixed

loadOrderBy()

Set list view order by.

public loadOrderBy() : mixed
Return values
mixed

remove()

Function to remove the value.

public remove(string $key) : mixed
Parameters
$key : string
Return values
mixed

set()

Function to set the value for a given key.

public set(string $key, mixed $value) : $this
Parameters
$key : string
$value : mixed
Return values
$this

setData()

Function to set all the values.

public setData(mixed $values) : $this
Parameters
$values : mixed
Return values
$this

setFields()

Set fileds.

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

setRelatedModuleModel()

Set related module model instance.

public setRelatedModuleModel(Vtiger_Module_Model $relatedModuleModel) : $this
Parameters
$relatedModuleModel : Vtiger_Module_Model
Return values
$this

        

Search results