Documentation

Vtiger_ReferenceSubProcessSL_UIType extends Vtiger_ReferenceLink_UIType
in package

Class Vtiger_ReferenceSubProcessSL_UIType.

Table of Contents

$validate  : array<string|int, mixed>
Verify the value.
$value  : mixed
__construct()  : mixed
Constructor.
convertToSave()  : mixed
Convert value before writing to the database.
get()  : mixed
Function to get the value for a given key.
getAllowedColumnTypes()  : array<string|int, string>|null
Returns allowed types of columns in database.
getApiDisplayValue()  : mixed
Function to get display value for Web Service API.
getArray()  : array<string|int, mixed>
Function to get the array values for a given key.
getConditionBuilderField()  : Vtiger_Field_Model
Function to get the field model for condition builder.
getData()  : array<string|int, mixed>
Function to get all the values of the Object.
getDbConditionBuilderValue()  : string
Function to get the DB Insert Value, for the current field type with given User Value for condition builder.
getDBValue()  : mixed
Function to get the DB Insert Value, for the current field type with given User Value.
getDefaultEditTemplateName()  : string
Function to get the default edit view template name for the current UI Type Object.
getDefaultValue()  : mixed
Function to get Default Field Value.
getDetailViewTemplateName()  : string
Function to get the Detailview template name for the current UI Type Object.
getDisplayValue()  : mixed
Function to get the display value, for the current field type with given DB Insert Value.
getDuplicateValue()  : mixed
Duplicate value from record.
getEditViewDisplayValue()  : mixed
Function to get the edit value in display view.
getEditViewValue()  : mixed
Function to get the edit value.
getFieldModel()  : Vtiger_Field_Model
Get field model instance.
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).
getHeaderTypes()  : array<string|int, string>
Gets header types.
getHistoryDisplayValue()  : mixed
Function to get display value for ModTracker.
getInstanceFromField()  : self
Static function to get the UIType object from Vtiger Field Model.
getKeys()  : array<string|int, string>
Function to get keys.
getListSearchTemplateName()  : string
Function to get the Template name for the current UI Type object.
getListViewDisplayValue()  : mixed
Function to get the list value in display view.
getOperatorTemplateName()  : string
Returns template for operator.
getParentModule()  : mixed
{@inheritdoc}
getQueryOperators()  : array<string|int, string>
Return allowed query operators for field.
getRecordOperators()  : array<string|int, string>
Return allowed record operators for field.
getReferenceList()  : mixed
{@inheritdoc}
getReferenceModule()  : Vtiger_Module_Model|null
Function to get the Display Value, for the current field type with given DB Insert Value.
getRelatedListDisplayValue()  : string
Function to get Display value for RelatedList.
getRelatedListViewDisplayValue()  : mixed
Function to get the related list value in display view.
getTemplateName()  : string
Function to get the Template name for the current UI Type Object.
getTextParserDisplayValue()  : mixed
Function to get display value for TextParser.
getValueFromImport()  : mixed
Gets value from import.
getValueToExport()  : mixed
Gets value to export.
has()  : bool
Function to check if the key exists.
isActiveSearchView()  : mixed
isAjaxEditable()  : mixed
isEmpty()  : bool
Function to check if the key is empty.
isListviewSortable()  : mixed
If the field is sortable in ListView.
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.
setDefaultValueFromRequest()  : mixed
Set default value from request.
setValueFromRequest()  : mixed
Set value from request.
validate()  : mixed
Verification of data.
validateValue()  : mixed
Verification of value.

Properties

$validate

Verify the value.

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

$value

protected mixed $value

Methods

__construct()

Constructor.

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

convertToSave()

Convert value before writing to the database.

public convertToSave(mixed $value, Vtiger_Record_Model $recordModel) : mixed
Parameters
$value : mixed
$recordModel : Vtiger_Record_Model
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

getAllowedColumnTypes()

Returns allowed types of columns in database.

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

getApiDisplayValue()

Function to get display value for Web Service API.

public getApiDisplayValue( $value, Vtiger_Record_Model $recordModel) : mixed
Parameters
$value :
$recordModel : Vtiger_Record_Model
Return values
mixed

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>

getConditionBuilderField()

Function to get the field model for condition builder.

public getConditionBuilderField(string $operator) : Vtiger_Field_Model
Parameters
$operator : string
Return values
Vtiger_Field_Model

getData()

Function to get all the values of the Object.

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

getDbConditionBuilderValue()

Function to get the DB Insert Value, for the current field type with given User Value for condition builder.

public getDbConditionBuilderValue(mixed $value, string $operator) : string
Parameters
$value : mixed
$operator : string
Return values
string

getDBValue()

Function to get the DB Insert Value, for the current field type with given User Value.

public getDBValue(mixed $value[, Vtiger_Record_Model $recordModel = false ]) : mixed
Parameters
$value : mixed
$recordModel : Vtiger_Record_Model = false
Return values
mixed

getDefaultEditTemplateName()

Function to get the default edit view template name for the current UI Type Object.

public getDefaultEditTemplateName() : string
Return values
string
  • Template Name

getDefaultValue()

Function to get Default Field Value.

public getDefaultValue() : mixed
Tags
throws
Exception
Return values
mixed

getDetailViewTemplateName()

Function to get the Detailview template name for the current UI Type Object.

public getDetailViewTemplateName() : string
Return values
string
  • Template Name

getDisplayValue()

Function to get the display value, for the current field type with given DB Insert Value.

public getDisplayValue(mixed $value[, bool|int $record = false ][, bool|Vtiger_Record_Model $recordModel = false ][, bool $rawText = false ][, bool|int $length = false ]) : mixed
Parameters
$value : mixed

Field value

$record : bool|int = false

Record Id

$recordModel : bool|Vtiger_Record_Model = false
$rawText : bool = false

Return text or html

$length : bool|int = false

Length of the text

Return values
mixed

getEditViewDisplayValue()

Function to get the edit value in display view.

public getEditViewDisplayValue(mixed $value[, Vtiger_Record_Model $recordModel = false ]) : mixed
Parameters
$value : mixed
$recordModel : Vtiger_Record_Model = false
Return values
mixed

getEditViewValue()

Function to get the edit value.

public getEditViewValue(mixed $value[, Vtiger_Record_Model $recordModel = false ]) : mixed
Parameters
$value : mixed
$recordModel : Vtiger_Record_Model = false
Return values
mixed

getFieldModel()

Get field model instance.

public getFieldModel() : Vtiger_Field_Model
Return values
Vtiger_Field_Model

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

getHeaderTypes()

Gets header types.

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

getHistoryDisplayValue()

Function to get display value for ModTracker.

public getHistoryDisplayValue( $value, Vtiger_Record_Model $recordModel[, bool $rawText = false ]) : mixed
Parameters
$value :
$recordModel : Vtiger_Record_Model
$rawText : bool = false
Return values
mixed

getInstanceFromField()

Static function to get the UIType object from Vtiger Field Model.

public static getInstanceFromField(Vtiger_Field_Model $fieldModel) : self
Parameters
$fieldModel : Vtiger_Field_Model
Return values
self

Vtiger_Base_UIType or UIType specific object instance

getKeys()

Function to get keys.

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

getListSearchTemplateName()

Function to get the Template name for the current UI Type object.

public getListSearchTemplateName() : string
Return values
string
  • Template Name

getListViewDisplayValue()

Function to get the list value in display view.

public getListViewDisplayValue(mixed $value[, int $record = false ][, bool|Vtiger_Record_Model $recordModel = false ][, bool $rawText = false ]) : mixed
Parameters
$value : mixed

Field value

$record : int = false

|bool Record Id

$recordModel : bool|Vtiger_Record_Model = false
$rawText : bool = false

Return text or html

Return values
mixed

getOperatorTemplateName()

Returns template for operator.

public getOperatorTemplateName([string $operator = '' ]) : string
Parameters
$operator : string = ''
Return values
string

getParentModule()

{@inheritdoc}

public getParentModule(mixed $module) : mixed
Parameters
$module : mixed
Return values
mixed

getQueryOperators()

Return allowed query operators for field.

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

getRecordOperators()

Return allowed record operators for field.

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

getReferenceModule()

Function to get the Display Value, for the current field type with given DB Insert Value.

public getReferenceModule(int $value) : Vtiger_Module_Model|null
Parameters
$value : int
Return values
Vtiger_Module_Model|null

getRelatedListDisplayValue()

Function to get Display value for RelatedList.

public getRelatedListDisplayValue(string $value) : string
Parameters
$value : string
Return values
string

getRelatedListViewDisplayValue()

Function to get the related list value in display view.

public getRelatedListViewDisplayValue(mixed $value[, int $record = false ][, bool|Vtiger_Record_Model $recordModel = false ][, bool $rawText = false ]) : mixed
Parameters
$value : mixed

Field value

$record : int = false

|bool Record Id

$recordModel : bool|Vtiger_Record_Model = false
$rawText : bool = false

Return text or html

Return values
mixed

getTemplateName()

Function to get the Template name for the current UI Type Object.

public getTemplateName() : string
Return values
string
  • Template Name

getTextParserDisplayValue()

Function to get display value for TextParser.

public getTextParserDisplayValue(mixed $value, Vtiger_Record_Model $recordModel, string $params) : mixed
Parameters
$value : mixed
$recordModel : Vtiger_Record_Model
$params : string
Return values
mixed

getValueFromImport()

Gets value from import.

public getValueFromImport(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed

getValueToExport()

Gets value to export.

public getValueToExport(mixed $value, int $recordId) : mixed
Parameters
$value : mixed
$recordId : int
Return values
mixed

has()

Function to check if the key exists.

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

isActiveSearchView()

public isActiveSearchView() : mixed
Return values
mixed

isAjaxEditable()

public isAjaxEditable() : mixed
Return values
mixed

isEmpty()

Function to check if the key is empty.

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

isListviewSortable()

If the field is sortable in ListView.

public isListviewSortable() : 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

setDefaultValueFromRequest()

Set default value from request.

public setDefaultValueFromRequest(Request $request) : mixed
Parameters
$request : Request
Tags
throws
Security
Return values
mixed

setValueFromRequest()

Set value from request.

public setValueFromRequest(Request $request, Vtiger_Record_Model $recordModel[, bool|string $requestFieldName = false ]) : mixed
Parameters
$request : Request
$recordModel : Vtiger_Record_Model
$requestFieldName : bool|string = false
Return values
mixed

validate()

Verification of data.

public validate(string $value[, bool $isUserFormat = false ]) : mixed
Parameters
$value : string
$isUserFormat : bool = false
Tags
throws
Security
Return values
mixed

validateValue()

Verification of value.

public validateValue(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed

Search results