Documentation

Settings_FieldsDependency_Record_Model extends Settings_Vtiger_Record_Model
in package

Settings fields dependency record model class.

Table of Contents

$value  : mixed
__construct()  : mixed
Constructor.
checkHandler()  : void
Check whether to activate/remove handler.
delete()  : mixed
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.
getCleanInstance()  : static
function to get clean instance.
getData()  : array<string|int, mixed>
Function to get all the values of the Object.
getDisplayValue()  : mixed
Get display value.
getEditRecordUrl()  : string
Get edit record url.
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()  : mixed
getInstanceById()  : mixed
Function to get the instance of sla policy record model.
getKeys()  : array<string|int, string>
Function to get keys.
getModule()  : Settings_Vtiger_Module_Model
Function to get module instance of this record.
getName()  : mixed
getRecordLinks()  : array<string|int, Vtiger_Link_Model>
Function to get the list view actions for the record.
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.
sanitize()  : array<string|int, mixed>
Validate and sanitize record data.
save()  : void
Function to save.
set()  : $this
Function to set the value for a given key.
setData()  : $this
Function to set all the values.
setModule()  : self
Function to set module to this record instance.
setId()  : mixed
{@inheritdoc}

Properties

$value

protected mixed $value

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()

Function to delete the current Record Model.

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

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() : static
Return values
static

getData()

Function to get all the values of the Object.

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

getDisplayValue()

Get display value.

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

getEditRecordUrl()

Get edit record url.

public getEditRecordUrl(int $recordId) : string
Parameters
$recordId : int
Return values
string

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()

public getId() : mixed
Return values
mixed

getInstanceById()

Function to get the instance of sla policy record model.

public static getInstanceById(int $id[, string $qualifiedModuleName = 'Settings:FieldsDependency' ]) : mixed
Parameters
$id : int
$qualifiedModuleName : string = 'Settings:FieldsDependency'
Return values
mixed

getKeys()

Function to get keys.

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

getModule()

Function to get module instance of this record.

public getModule() : Settings_Vtiger_Module_Model
Return values
Settings_Vtiger_Module_Model

getName()

public getName() : mixed
Return values
mixed

Function to get the list view actions for the record.

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

Associate array of Vtiger_Link_Model instances

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

sanitize()

Validate and sanitize record data.

public static sanitize(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
Return values
array<string|int, mixed>

cleaned up data

save()

Function to save.

public save() : void
Return values
void

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

setId()

{@inheritdoc}

protected setId(mixed $id) : mixed
Parameters
$id : mixed
Return values
mixed

Search results