Settings_PickListDependency_Record_Model
extends Settings_Vtiger_Record_Model
in package
Roles Record Model Class.
Table of Contents
- $value : array<string|int, mixed>
- $nonMappedSourcePickListValues : mixed
- $sourceModuleModel : Vtiger_Module_Model
- __construct() : mixed
- Constructor.
- checkHandler() : void
- Check whether to activate/remove handler.
- delete() : bool
- Delete entry.
- get() : mixed
- Function to get the value for a given key.
- getArray() : array<string|int, mixed>
- Function to get the array values for a given key.
- getCleanInstance() : self
- Function to get clean instance.
- getData() : array<string|int, mixed>
- Function to get all the values of the Object.
- getDisplayValue() : string
- Function to get the Display Value, for the current field type with given DB Insert Value.
- getEditRecordUrl() : string
- Get edit view URL.
- getFieldInstanceByName() : Vtiger_Field_Model
- Get fields instance by name.
- 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).
- getId() : int|null
- Function to get the Id.
- getInstanceById() : self
- Get instance by id.
- getKeys() : array<string|int, string>
- Function to get keys.
- getListViewUrl() : string
- Get list view URL.
- getModule() : Settings_PickListDependency_Module_Model
- Function to get Module instance.
- getName() : string
- Record name.
- getNonMappedSourcePickListValues() : mixed
- getPickListDependency() : array<string|int, mixed>
- Get picklist dependency.
- getPickListValuesByField() : array<string|int, mixed>
- Get pickList values for field.
- getRecordLinks() : array<string|int, Vtiger_Link_Model>
- Get record links.
- getSourceModule() : Vtiger_Module_Model
- Get source module model.
- getSourceModuleName() : string
- Get source module name.
- getValuesForSave() : array<string|int, mixed>
- Get values for save.
- has() : bool
- Function to check if the key exists.
- isEmpty() : bool
- Function to check if the key is empty.
- recursiveMapping() : void
- Recirsive parse data.
- remove() : mixed
- Function to remove the value.
- save() : mixed
- Function to save.
- saveToDb() : mixed
- Save data to the database.
- set() : mixed
- {@inheritdoc}
- setData() : mixed
- {@inheritdoc}
- setId() : mixed
- Function to set the id of the record.
- setModule() : $this
- Set module Instance.
- validate() : array<string|int, mixed>
- Validation duplicate.
Properties
$value
protected
array<string|int, mixed>
$value
Values
$nonMappedSourcePickListValues
private
mixed
$nonMappedSourcePickListValues
= \false
$sourceModuleModel
private
Vtiger_Module_Model
$sourceModuleModel
Source module model
Methods
__construct()
Constructor.
public
__construct([array<string|int, mixed> $values = [] ]) : mixed
Parameters
- $values : array<string|int, mixed> = []
Return values
mixed —checkHandler()
Check whether to activate/remove handler.
public
checkHandler() : void
Return values
void —delete()
Delete entry.
public
delete() : bool
Return values
bool —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
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> —getCleanInstance()
Function to get clean instance.
public
static getCleanInstance() : self
Return values
self —getData()
Function to get all the values of the Object.
public
getData() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDisplayValue()
Function to get the Display Value, for the current field type with given DB Insert Value.
public
getDisplayValue(string $name) : string
Parameters
- $name : string
Return values
string —getEditRecordUrl()
Get edit view URL.
public
getEditRecordUrl(int $recordId) : string
Parameters
- $recordId : int
Return values
string —getFieldInstanceByName()
Get fields instance by name.
public
getFieldInstanceByName(string $name) : Vtiger_Field_Model
Parameters
- $name : string
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
getId()
Function to get the Id.
public
getId() : int|null
Return values
int|null —Id
getInstanceById()
Get instance by id.
public
static getInstanceById(int $id) : self
Parameters
- $id : int
Return values
self —getKeys()
Function to get keys.
public
getKeys() : array<string|int, string>
Return values
array<string|int, string> —getListViewUrl()
Get list view URL.
public
getListViewUrl() : string
Return values
string —getModule()
Function to get Module instance.
public
getModule() : Settings_PickListDependency_Module_Model
Return values
Settings_PickListDependency_Module_Model —getName()
Record name.
public
getName() : string
Return values
string —getNonMappedSourcePickListValues()
public
getNonMappedSourcePickListValues() : mixed
Return values
mixed —getPickListDependency()
Get picklist dependency.
public
getPickListDependency() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPickListValuesByField()
Get pickList values for field.
public
getPickListValuesByField(string $fieldName) : array<string|int, mixed>
Parameters
- $fieldName : string
Return values
array<string|int, mixed> —getRecordLinks()
Get record links.
public
getRecordLinks() : array<string|int, Vtiger_Link_Model>
Return values
array<string|int, Vtiger_Link_Model> —getSourceModule()
Get source module model.
public
getSourceModule() : Vtiger_Module_Model
Return values
Vtiger_Module_Model —getSourceModuleName()
Get source module name.
public
getSourceModuleName() : string
Return values
string —getValuesForSave()
Get values for save.
public
getValuesForSave() : 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 —recursiveMapping()
Recirsive parse data.
public
recursiveMapping(array<string|int, mixed> $data, array<string|int, mixed> $row, array<string|int, mixed> &$global) : void
Parameters
- $data : array<string|int, mixed>
- $row : array<string|int, mixed>
- $global : array<string|int, mixed>
Return values
void —remove()
Function to remove the value.
public
remove(string $key) : mixed
Parameters
- $key : string
Return values
mixed —save()
Function to save.
public
save() : mixed
Return values
mixed —saveToDb()
Save data to the database.
public
saveToDb() : mixed
Return values
mixed —set()
{@inheritdoc}
public
set(mixed $key, mixed $value) : mixed
Parameters
- $key : mixed
- $value : mixed
Return values
mixed —setData()
{@inheritdoc}
public
setData(mixed $row) : mixed
Parameters
- $row : mixed
Return values
mixed —setId()
Function to set the id of the record.
public
setId(int $value) : mixed
Parameters
- $value : int
-
- id value
Return values
mixed —setModule()
Set module Instance.
public
setModule(Settings_PickListDependency_Module_Model $moduleModel) : $this
Parameters
- $moduleModel : Settings_PickListDependency_Module_Model
Return values
$this —validate()
Validation duplicate.
public
validate() : array<string|int, mixed>