Settings_PBX_Record_Model
extends Settings_Vtiger_Record_Model
in package
Record Model.
Tags
Table of Contents
- $param : array<string|int, mixed>
- Connector configuration.
- $value : array<string|int, mixed>
- $editFields : array<string|int, mixed>
- Edit fields.
- __construct() : mixed
- Constructor.
- delete() : bool
- Function removes record.
- 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 the clean instance.
- getConnectorFieldsModel() : type
- Get connector config fields model.
- 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.
- getEditFields() : array<string|int, string>
- Function determines fields available in edition view.
- getEditFieldsModel() : array<string|int, Settings_Vtiger_Field_Model>
- Get edit fields model.
- 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
- Record ID.
- getInstanceById() : self
- Function to get the instance, given id.
- getKeys() : array<string|int, string>
- Function to get keys.
- getModule() : Settings_PBX_Module_Model
- Function to get Module instance.
- getName() : string
- Record name.
- getParam() : mixed
- Function to get the confog param for a given key.
- 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.
- parseFromRequest() : mixed
- Parse dana from request.
- remove() : mixed
- Function to remove the value.
- save() : bool
- Save pbx instance.
- set() : $this
- Function to set the value for a given key.
- setData() : $this
- Function to set all the values.
- setModule() : $this
- Function to set Module instance.
Properties
$param
Connector configuration.
public
array<string|int, mixed>
$param
$value
protected
array<string|int, mixed>
$value
Values
$editFields
Edit fields.
private
array<string|int, mixed>
$editFields
= ['name' => ['label' => 'LBL_NAME'], 'type' => ['label' => 'LBL_TYPE', 'uitype' => 16], 'default' => ['label' => 'LBL_DEFAULT', 'uitype' => 56, 'typeofdata' => 'C~O']]
Methods
__construct()
Constructor.
public
__construct([array<string|int, mixed> $values = [] ]) : mixed
Parameters
- $values : array<string|int, mixed> = []
Return values
mixed —delete()
Function removes record.
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 the clean instance.
public
static getCleanInstance() : self
Return values
self —getConnectorFieldsModel()
Get connector config fields model.
public
getConnectorFieldsModel() : type
Return values
type —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 —getEditFields()
Function determines fields available in edition view.
public
getEditFields() : array<string|int, string>
Return values
array<string|int, string> —getEditFieldsModel()
Get edit fields model.
public
getEditFieldsModel() : array<string|int, Settings_Vtiger_Field_Model>
Return values
array<string|int, Settings_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()
Record ID.
public
getId() : int
Return values
int —getInstanceById()
Function to get the instance, given 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> —getModule()
Function to get Module instance.
public
getModule() : Settings_PBX_Module_Model
Return values
Settings_PBX_Module_Model —getName()
Record name.
public
getName() : string
Return values
string —getParam()
Function to get the confog param for a given key.
public
getParam(string $key) : mixed
Parameters
- $key : string
Return values
mixed —Value for the given key
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 —parseFromRequest()
Parse dana from request.
public
parseFromRequest(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
Return values
mixed —remove()
Function to remove the value.
public
remove(string $key) : mixed
Parameters
- $key : string
Return values
mixed —save()
Save pbx instance.
public
save() : bool
Return values
bool —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 —setModule()
Function to set Module instance.
public
setModule(Settings_PBX_Module_Model $moduleModel) : $this
Parameters
- $moduleModel : Settings_PBX_Module_Model