Vtiger_TreeView_Model
extends Base
in package
Basic TreeView Model Class.
Tags
Table of Contents
- $_cached_instance : mixed
- $value : array<string|int, 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.
- 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() : Vtiger_TreeView_Model
- Static Function to get the instance of Vtiger TreeView Model for the given Vtiger Module Model.
- getKeys() : array<string|int, string>
- Function to get keys.
- getModuleName() : string
- Function to get the Module Name.
- getName() : string
- Load tree tab label.
- getTemplate() : type
- Load tree ID.
- getTreeField() : array<string|int, mixed>
- Load tree field info.
- getTreeList() : string
- Load tree.
- getTreeViewUrl() : string
- Load records tree address.
- has() : bool
- Function to check if the key exists.
- isActive() : bool
- Active tree tab.
- 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
$_cached_instance
public
static mixed
$_cached_instance
$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 —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> —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()
Static Function to get the instance of Vtiger TreeView Model for the given Vtiger Module Model.
public
static getInstance(string $moduleName) : Vtiger_TreeView_Model
Parameters
- $moduleName : string
Tags
Return values
Vtiger_TreeView_Model —getKeys()
Function to get keys.
public
getKeys() : array<string|int, string>
Return values
array<string|int, string> —getModuleName()
Function to get the Module Name.
public
getModuleName() : string
Return values
string —Module name
getName()
Load tree tab label.
public
getName() : string
Return values
string —getTemplate()
Load tree ID.
public
getTemplate() : type
Return values
type —getTreeField()
Load tree field info.
public
getTreeField() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTreeList()
Load tree.
public
getTreeList() : string
Return values
string —getTreeViewUrl()
Load records tree address.
public
getTreeViewUrl() : string
Return values
string —- url
has()
Function to check if the key exists.
public
has(string $key) : bool
Parameters
- $key : string
Return values
bool —isActive()
Active tree tab.
public
isActive() : 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 —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