Vtiger_TreeCategoryModal_Model
extends Base
in package
Basic TreeCategoryModal 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.
- getRelationModel() : bool|Vtiger_Relation_Model
- Gets relation model.
- getRelationType() : mixed
- Gets relation type.
- getTemplate() : type
- Load tree ID.
- getTreeData() : mixed
- getTreeField() : array<string|int, mixed>
- Load tree field info.
- has() : bool
- Function to check if the key exists.
- isDeletable() : bool
- Function check if record is deletable.
- 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.
- getAllRecords() : mixed
- getRecords() : mixed
- getSelectedRecords() : mixed
- getSelectedTreeList() : array<string|int, mixed>
- Function to get selected item in the tree.
- getTreeList() : string
- Load tree.
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(Vtiger_Module_Model $moduleModel) : Vtiger_TreeView_Model
Parameters
- $moduleModel : Vtiger_Module_Model
Return values
Vtiger_TreeView_Model —instance
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
getRelationModel()
Gets relation model.
public
getRelationModel() : bool|Vtiger_Relation_Model
Return values
bool|Vtiger_Relation_Model —getRelationType()
Gets relation type.
public
getRelationType() : mixed
Return values
mixed —getTemplate()
Load tree ID.
public
getTemplate() : type
Return values
type —getTreeData()
public
getTreeData() : mixed
Return values
mixed —getTreeField()
Load tree field info.
public
getTreeField() : array<string|int, mixed>
Return values
array<string|int, mixed> —has()
Function to check if the key exists.
public
has(string $key) : bool
Parameters
- $key : string
Return values
bool —isDeletable()
Function check if record is deletable.
public
isDeletable() : 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
Return values
$this —getAllRecords()
private
getAllRecords() : mixed
Return values
mixed —getRecords()
private
getRecords() : mixed
Return values
mixed —getSelectedRecords()
private
getSelectedRecords([mixed $onlyKeys = true ]) : mixed
Parameters
- $onlyKeys : mixed = true
Return values
mixed —getSelectedTreeList()
Function to get selected item in the tree.
private
getSelectedTreeList() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTreeList()
Load tree.
private
getTreeList() : string