Documentation

Settings_Currency_Record_Model extends Settings_Vtiger_Record_Model
in package

Roles Record Model Class.

Table of Contents

$changes  : array<string|int, mixed>
Changes value.
$value  : mixed
__construct()  : mixed
Constructor.
get()  : mixed
Function to get the value for a given key.
getAll()  : array<string|int, Settings_Currency_Record_Model>
Return currences.
getAllNonMapped()  : array<string|int, Settings_Currency_Record_Model>
Return all non mapped currences.
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.
getDeleteStatus()  : int
return delete state of record.
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|null
Return currency id.
getInstance()  : self
Returns instance of self.
getKeys()  : array<string|int, string>
Function to get keys.
getName()  : string
Return currency name.
getRecordLinks()  : array<string|int, mixed>
Return record actions links.
has()  : bool
Function to check if the key exists.
isBaseCurrency()  : bool
Check if currency is base.
isEmpty()  : bool
Function to check if the key is empty.
remove()  : mixed
Function to remove the value.
save()  : int
Populate changes to database.
set()  : mixed
{@inheritdoc}
setData()  : $this
Function to set all the values.

Properties

$changes

Changes value.

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

$value

protected mixed $value

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $values = [] ]) : mixed
Parameters
$values : array<string|int, 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>

getDeleteStatus()

return delete state of record.

public getDeleteStatus() : int
Return values
int

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

Return currency id.

public getId() : int|null
Return values
int|null

getInstance()

Returns instance of self.

public static getInstance(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>

getName()

Return currency name.

public getName() : string
Return values
string

Return record actions links.

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

isBaseCurrency()

Check if currency is base.

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

Populate changes to database.

public save() : int
Return values
int

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
Return values
$this

Search results