Settings_Companies_Record_Model
extends Settings_Vtiger_Record_Model
in package
Companies record model class.
Tags
Table of Contents
- $module : mixed
- $changes : array<string|int, mixed>
- $value : array<string|int, mixed>
- __construct() : mixed
- Constructor.
- delete() : bool
- Function to delete the current Record Model.
- 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.
- 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.
- getEditViewUrl() : string
- Function to get the Edit View Url.
- getFieldInstanceByName() : Vtiger_Field_Model
- Function determines fields available in edition view.
- 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
- Function to get the Id.
- getInstance() : bool|Settings_Companies_Record_Model
- Function to get the instance of companies record model.
- getKeys() : array<string|int, string>
- Function to get keys.
- getModule() : Settings_Companies_Module_Model
- Function to get Module instance.
- getName() : string
- Function to get the Name.
- getPreviousValue() : mixed
- Get pervious value by field.
- getRecordLinks() : array<string|int, Vtiger_Link_Model>
- Get record links.
- has() : bool
- Function to check if the key exists.
- isEmpty() : bool
- Function to check if the key is empty.
- remove() : mixed
- Function to remove the value.
- save() : void
- Function to save.
- set() : mixed
- {@inheritdoc}
- setData() : $this
- Function to set all the values.
Properties
$module
public
mixed
$module
$changes
protected
array<string|int, mixed>
$changes
= []
Record changes
$value
protected
array<string|int, mixed>
$value
Values
Methods
__construct()
Constructor.
public
__construct([array<string|int, mixed> $values = [] ]) : mixed
Parameters
- $values : array<string|int, mixed> = []
Return values
mixed —delete()
Function to delete the current Record Model.
public
delete() : bool
Tags
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> —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 $key) : string
Parameters
- $key : string
Return values
string —getEditViewUrl()
Function to get the Edit View Url.
public
getEditViewUrl() : string
Return values
string —URL
getFieldInstanceByName()
Function determines fields available in edition view.
public
getFieldInstanceByName(string $name[, string $label = '' ]) : Vtiger_Field_Model
Parameters
- $name : string
- $label : 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
Return values
int —Id
getInstance()
Function to get the instance of companies record model.
public
static getInstance() : bool|Settings_Companies_Record_Model
Tags
Return values
bool|Settings_Companies_Record_Model —instance, if exists
getKeys()
Function to get keys.
public
getKeys() : array<string|int, string>
Return values
array<string|int, string> —getModule()
Function to get Module instance.
public
getModule() : Settings_Companies_Module_Model
Return values
Settings_Companies_Module_Model —getName()
Function to get the Name.
public
getName() : string
Return values
string —getPreviousValue()
Get pervious value by field.
public
getPreviousValue([string $fieldName = '' ]) : mixed
Parameters
- $fieldName : string = ''
Return values
mixed —getRecordLinks()
Get record links.
public
getRecordLinks() : array<string|int, Vtiger_Link_Model>
Return values
array<string|int, Vtiger_Link_Model> —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 —remove()
Function to remove the value.
public
remove(string $key) : mixed
Parameters
- $key : string
Return values
mixed —save()
Function to save.
public
save() : void
Return values
void —set()
{@inheritdoc}
public
set(mixed $key, mixed $value) : mixed
Parameters
- $key : mixed
- $value : mixed
Return values
mixed —setData()
Function to set all the values.
public
setData(mixed $values) : $this
Parameters
- $values : mixed