Documentation

Settings_SMSNotifier_ListView_Model extends Settings_Vtiger_ListView_Model
in package

SMSNotifier ListView Model Class.

Table of Contents

$value  : mixed
__construct()  : mixed
Constructor.
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.
getBasicLinks()  : array<string|int, mixed>
Function to get Basic links.
getBasicListQuery()  : mixed
getData()  : array<string|int, mixed>
Function to get all the values of the Object.
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).
getInstance()  : Settings_Vtiger_Module_Model
Function to get the instance of Settings module model.
getKeys()  : array<string|int, string>
Function to get keys.
getListViewCount()  : mixed
* * Function which will get the list view count.
getListViewEntries()  : array<string|int, Settings_Vtiger_Record_Model>
Function to get the list view entries.
getListViewHeaders()  : array<string|int, mixed>
Function to get the list view header.
getListViewLinks()  : mixed
getModule()  : Vtiger_Module_Model
Function to get the Module Model.
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.
setModule()  : mixed
setModuleFromInstance()  : mixed

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

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>

Function to get Basic links.

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

of Basic links

getBasicListQuery()

public getBasicListQuery() : mixed
Return values
mixed

getData()

Function to get all the values of the Object.

public getData() : array<string|int, mixed>
Return values
array<string|int, 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

getInstance()

Function to get the instance of Settings module model.

public static getInstance([mixed $name = 'Settings:Vtiger' ]) : Settings_Vtiger_Module_Model
Parameters
$name : mixed = 'Settings:Vtiger'
Return values
Settings_Vtiger_Module_Model

instance

getKeys()

Function to get keys.

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

getListViewCount()

* * Function which will get the list view count.

public getListViewCount() : mixed
Return values
mixed

getListViewEntries()

Function to get the list view entries.

public getListViewEntries(Vtiger_Paging_Model $pagingModel) : array<string|int, Settings_Vtiger_Record_Model>
Parameters
$pagingModel : Vtiger_Paging_Model
Return values
array<string|int, Settings_Vtiger_Record_Model>
  • Associative array of record id mapped to Vtiger_Record_Model instance

getListViewHeaders()

Function to get the list view header.

public getListViewHeaders() : array<string|int, mixed>
Return values
array<string|int, mixed>
  • List of Vtiger_Field_Model instances
public getListViewLinks() : mixed
Return values
mixed

getModule()

Function to get the Module Model.

public getModule() : Vtiger_Module_Model
Return values
Vtiger_Module_Model

instance

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

setModule()

public setModule(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed

setModuleFromInstance()

public setModuleFromInstance(mixed $module) : mixed
Parameters
$module : mixed
Return values
mixed

Search results