Documentation

Settings_Magento_Record_Model extends Settings_Vtiger_Record_Model
in package

Settings magento class.

Table of Contents

$value  : mixed
__construct()  : mixed
Constructor.
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()  : self
Function to get the clean instance.
getData()  : array<string|int, mixed>
Function to get all the values of the Object.
getDetailViewUrl()  : string
Function to get the Detail Url.
getDisplayValue()  : mixed
Get display value.
getEditViewUrl()  : string
Function to get the Edit View Url.
getFieldInstanceByName()  : Settings_Vtiger_Field_Model
Get field instance by name.
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 of record model.
getKeys()  : array<string|int, string>
Function to get keys.
getModule()  : Settings_Magento_Module_Model
Function to get Module instance.
getName()  : string
Record name.
getRecordLinks()  : array<string|int, mixed>
Function to get the list view actions for the record.
getSaveAjaxActionUrl()  : string
Function to get the Save Ajax.
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()  : $this
Function to set the value for a given key.
setData()  : $this
Function to set all the values.
setDataFromRequest()  : mixed
Sets data from request.

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

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 the clean instance.

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>

getDetailViewUrl()

Function to get the Detail Url.

public getDetailViewUrl() : string
Return values
string

URL

getDisplayValue()

Get display value.

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

getEditViewUrl()

Function to get the Edit View Url.

public getEditViewUrl() : string
Return values
string

URL

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 of record model.

public static getInstanceById(int $id) : self
Parameters
$id : int
Return values
self

instance, if exists

getKeys()

Function to get keys.

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

getName()

Record name.

public getName() : string
Return values
string

Function to get the list view actions for the record.

public getRecordLinks() : array<string|int, mixed>
Return values
array<string|int, mixed>
  • Associate array of Vtiger_Link_Model instances

getSaveAjaxActionUrl()

Function to get the Save Ajax.

public getSaveAjaxActionUrl() : string
Return values
string

URL

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) : $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

setDataFromRequest()

Sets data from request.

public setDataFromRequest(Request $request) : mixed
Parameters
$request : Request
Return values
mixed

        

Search results