Documentation

Settings_WebserviceApps_Record_Model extends Settings_Vtiger_Record_Model
in package

Record Model.

Tags
copyright

YetiForce Sp. z o.o

license

YetiForce Public License 3.0 (licenses/LicenseEN.txt or yetiforce.com)

author

Tomasz Kur t.kur@yetiforce.com

author

Mariusz Krzaczkowski m.krzaczkowski@yetiforce.com

Table of Contents

KEY_LENGTH  = 32
Length key.
$value  : mixed
__construct()  : mixed
Constructor.
delete()  : mixed
Delete the 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 instance without data.
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
Function to get id.
getInstanceById()  : bool|self
Static function to get model.
getKeys()  : array<string|int, string>
Function to get keys.
getName()  : type
Return name server.
getRecordLinks()  : mixed
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
Save record.
set()  : $this
Function to set the value for a given key.
setData()  : $this
Function to set all the values.
checkDuplicate()  : bool
Checks if duplicates.

Constants

KEY_LENGTH

Length key.

public mixed KEY_LENGTH = 32

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

delete()

Delete the record.

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 instance without data.

public static getCleanInstance() : self
Return values
self

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

Function to get id.

public getId() : int
Return values
int

getInstanceById()

Static function to get model.

public static getInstanceById(int $recordId) : bool|self
Parameters
$recordId : int
Return values
bool|self

getKeys()

Function to get keys.

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

getName()

Return name server.

public getName() : type
Return values
type
public getRecordLinks() : mixed
Return values
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()

Save record.

public save() : mixed
Return values
mixed

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

checkDuplicate()

Checks if duplicates.

private checkDuplicate() : bool
Return values
bool

Search results