Settings_Mail_Record_Model
extends Settings_Vtiger_Record_Model
in package
Mail record model class.
Tags
Table of Contents
- $value : array<string|int, mixed>
- __construct() : mixed
- Constructor.
- delete() : bool
- Function to delete the current Record Model.
- get() : mixed
- Function to get the value for a given key.
- getAcceptanceActionUrl() : string
- Function to get the Acceptance Action Url.
- 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.
- getDetailViewUrl() : string
- Function to get the Detail Url.
- getDisplayValue() : string
- Function to get the Display Value, for the current field type with given DB Insert Value.
- getDisplayValueForEmail() : string
- Function to get the display value for emails.
- 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 the Id.
- getInstance() : self
- Function to get the instance of advanced permission record model.
- getKeys() : array<string|int, string>
- Function to get keys.
- getName() : string
- Function to get the Name.
- getRecordLinks() : array<string|int, Vtiger_Link_Model>
- Get record links.
- 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.
- set() : $this
- Function to set the value for a given key.
- setData() : $this
- Function to set all the values.
Properties
$value
protected
array<string|int, mixed>
$value
Values
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() : bool
Return values
bool —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
getAcceptanceActionUrl()
Function to get the Acceptance Action Url.
public
getAcceptanceActionUrl() : string
Return values
string —URL
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> —getDetailViewUrl()
Function to get the Detail Url.
public
getDetailViewUrl() : string
Return values
string —URL
getDisplayValue()
Function to get the Display Value, for the current field type with given DB Insert Value.
public
getDisplayValue(string $key) : string
Parameters
- $key : string
Return values
string —getDisplayValueForEmail()
Function to get the display value for emails.
public
getDisplayValueForEmail(array<string|int, mixed> $emails) : string
Parameters
- $emails : array<string|int, mixed>
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()
Function to get the Id.
public
getId() : int
Return values
int —Id
getInstance()
Function to get the instance of advanced permission record model.
public
static getInstance(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()
Function to get the Name.
public
getName() : string
Return values
string —getRecordLinks()
Get record links.
public
getRecordLinks() : array<string|int, Vtiger_Link_Model>
Return values
array<string|int, Vtiger_Link_Model> —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 —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