Documentation

Settings_AdminAccess_Record_Model extends Settings_Vtiger_Record_Model
in package

Settings_AdminAccess_Record_Model class.

Table of Contents

$value  : mixed
$changes  : array<string|int, mixed>
Changes value.
__construct()  : mixed
Constructor.
clearCache()  : mixed
Clear cache.
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()  : mixed
Get display value.
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.
getInstance()  : self
Gets instance.
getKeys()  : array<string|int, string>
Function to get keys.
getModule()  : Settings_Vtiger_Module_Model
Function to get Module instance.
getName()  : string
Record name.
getRecordLinks()  : mixed
getValuesForSave()  : array<string|int, mixed>
Prepare value to save.
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()  : mixed
Function to save.
set()  : mixed
Function to set the value for a given key.
setData()  : $this
Function to set all the values.
setModule()  : $this
Function to set module instance to this record instance.

Properties

$value

protected mixed $value

$changes

Changes value.

private array<string|int, mixed> $changes = []

Methods

__construct()

Constructor.

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

clearCache()

Clear cache.

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

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

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

getInstance()

Gets instance.

public static getInstance(int|string $module[, Settings_Vtiger_Module_Model|null $moduleModel = null ]) : self
Parameters
$module : int|string
$moduleModel : Settings_Vtiger_Module_Model|null = null
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_Vtiger_Module_Model
Return values
Settings_Vtiger_Module_Model

getName()

Record name.

public getName() : string
Return values
string
public getRecordLinks() : mixed
Return values
mixed

getValuesForSave()

Prepare value to 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

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

set()

Function to set the value for a given key.

public set(string $key, mixed $value) : mixed
Parameters
$key : string
$value : mixed
Return values
mixed

setData()

Function to set all the values.

public setData(mixed $values) : $this
Parameters
$values : mixed
Return values
$this

setModule()

Function to set module instance to this record instance.

public setModule(Settings_Vtiger_Module_Model $moduleModel) : $this
Parameters
$moduleModel : Settings_Vtiger_Module_Model
Return values
$this

Search results