Documentation

Vtiger_Utility_Model extends Vtiger_Action_Model
in package

Vtiger Action Model Class.

Table of Contents

$nonConfigurableActions  : array<string|int, mixed>
Non configurable actions.
$standardActions  : array<string|int, mixed>
Standard actions.
$utilityActions  : array<string|int, mixed>
Utility actions.
$cachedInstances  : array<string|int, mixed>
Cached instances.
$value  : mixed
__construct()  : mixed
Constructor.
get()  : mixed
Function to get the value for a given key.
getAll()  : array<string|int, Vtiger_Action_Model>
Return all instances.
getAllBasic()  : array<string|int, self>
Function to get all instances models of basic action.
getAllUtility()  : array<string|int, self>
Function to get all instances models of utility action.
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).
getId()  : int
Return action id.
getInstance()  : Vtiger_Action_Model|null
Return instance.
getInstanceFromRow()  : Vtiger_Action_Model
Create instance from record row.
getInstanceWithIdOrName()  : Vtiger_Action_Model|null
Return instance by id or name.
getKeys()  : array<string|int, string>
Function to get keys.
getName()  : string
Return action name.
has()  : bool
Function to check if the key exists.
isEmpty()  : bool
Function to check if the key is empty.
isModuleEnabled()  : bool
Check if module is enabled.
isUtilityTool()  : bool
Check if is a utility tool.
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

$nonConfigurableActions

Non configurable actions.

public static array<string|int, mixed> $nonConfigurableActions = ['Save', 'index', 'SavePriceBook', 'SaveVendor', 'DetailViewAjax', 'PriceBookEditView', 'QuickCreate', 'VendorEditView', 'DeletePriceBook', 'DeleteVendor', 'Popup', 'PriceBookDetailView', 'VendorDetailView']

$standardActions

Standard actions.

public static array<string|int, mixed> $standardActions = [0 => 'Save', 1 => 'EditView', 2 => 'Delete', 3 => 'index', 4 => 'DetailView', 7 => 'CreateView']

$utilityActions

Utility actions.

public static array<string|int, mixed> $utilityActions = [5 => 'Import', 6 => 'Export', 9 => 'ConvertLead']

$cachedInstances

Cached instances.

protected static array<string|int, mixed> $cachedInstances = ull

$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

getAll()

Return all instances.

public static getAll([bool $configurable = false ]) : array<string|int, Vtiger_Action_Model>
Parameters
$configurable : bool = false
Return values
array<string|int, Vtiger_Action_Model>

getAllBasic()

Function to get all instances models of basic action.

public static getAllBasic([bool $configurable = false ]) : array<string|int, self>
Parameters
$configurable : bool = false
Return values
array<string|int, self>

getAllUtility()

Function to get all instances models of utility action.

public static getAllUtility([bool $configurable = false ]) : array<string|int, self>
Parameters
$configurable : bool = false
Return values
array<string|int, self>

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

getId()

Return action id.

public getId() : int
Return values
int

getInstanceFromRow()

Create instance from record row.

public static getInstanceFromRow(array<string|int, mixed> $row) : Vtiger_Action_Model
Parameters
$row : array<string|int, mixed>
Return values
Vtiger_Action_Model

getKeys()

Function to get keys.

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

getName()

Return action name.

public getName() : string
Return values
string

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

isModuleEnabled()

Check if module is enabled.

public isModuleEnabled(mixed $module) : bool
Parameters
$module : mixed
Return values
bool

isUtilityTool()

Check if is a utility tool.

public isUtilityTool() : bool
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

        

Search results