Settings_PublicHoliday_Record_Model
extends Settings_Vtiger_Record_Model
in package
Settings PublicHoliday record model class.
Tags
Table of Contents
- $module : Settings_PublicHoliday_Module_Model
- Module model instance.
- $value : array<string|int, mixed>
- __construct() : mixed
- Constructor.
- delete() : int
- Deletes 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
- Returns a clean instance.
- getData() : array<string|int, mixed>
- Function to get all the values of the Object.
- getDate() : string
- Returns holiday date.
- getDayOfWeek() : string
- Return day of week for holiday date.
- getDisplayValue() : string
- Returns 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
- Returns record id.
- getInstanceById() : mixed
- {@inheritdoc}
- getKeys() : array<string|int, string>
- Function to get keys.
- getModule() : Settings_Companies_Module_Model
- Sets and returns module model instance.
- getName() : string
- Returns holiday name.
- getRecordLinks() : array<string|int, Vtiger_Link_Model>
- Get record links.
- getType() : string
- Returns holiday type.
- has() : bool
- Function to check if the key exists.
- isDuplicate() : bool
- Check if is duplicated.
- isEmpty() : bool
- Function to check if the key is empty.
- remove() : mixed
- Function to remove the value.
- save() : int
- Updates / inserts record.
- set() : $this
- Function to set the value for a given key.
- setData() : $this
- Function to set all the values.
Properties
$module
Module model instance.
public
Settings_PublicHoliday_Module_Model
$module
$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()
Deletes record.
public
delete() : int
Return values
int —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()
Returns a 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> —getDate()
Returns holiday date.
public
getDate() : string
Return values
string —getDayOfWeek()
Return day of week for holiday date.
public
getDayOfWeek() : string
Return values
string —getDisplayValue()
Returns display value.
public
getDisplayValue(string $key) : string
Parameters
- $key : string
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()
Returns record id.
public
getId() : int
Return values
int —getInstanceById()
{@inheritdoc}
public
static getInstanceById(mixed $id) : mixed
Parameters
- $id : mixed
Return values
mixed —getKeys()
Function to get keys.
public
getKeys() : array<string|int, string>
Return values
array<string|int, string> —getModule()
Sets and returns module model instance.
public
getModule() : Settings_Companies_Module_Model
Return values
Settings_Companies_Module_Model —getName()
Returns holiday 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> —getType()
Returns holiday type.
public
getType() : string
Return values
string —has()
Function to check if the key exists.
public
has(string $key) : bool
Parameters
- $key : string
Return values
bool —isDuplicate()
Check if is duplicated.
public
isDuplicate() : 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()
Updates / inserts record.
public
save() : int
Return values
int —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