YetiForce PHP Documentation

Settings_Workflows_Record_Model extends Settings_Vtiger_Record_Model
in package

Class settings workflows record model.

Table of Contents

$value  : mixed
__construct()  : mixed
Constructor.
delete()  : mixed
Delete record from database.
executionConditionAsLabel()  : string
Get execution condition label.
get()  : mixed
Function to get the value for a given key.
getActiveCount()  : int
Function to get the count of active workflows.
getActiveCountFromRecord()  : int
Get active workflows from task list.
getAddTaskUrl()  : string
Get add task url.
getAllAmountWorkflowsAmount()  : int
Function to get number of workflow.
getArray()  : array<string|int, mixed>
Function to get the array values for a given key.
getCleanInstance()  : Self
Get clean instance.
getData()  : array<string|int, mixed>
Function to get all the values of the Object.
getDependentModules()  : JSON
Function returns all the related modules for workflows create entity task.
getDisplayValue()  : mixed
Get display value.
getEditViewUrl()  : string
Get edit view url.
getEntityMethods()  : array<string|int, mixed>
Functions returns the Custom Entity Methods that are supported for a module.
getFieldFilterValueType()  : string|bool
Function returns valuetype of the field filter.
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
Get record id.
getInstance()  : Self
Get instance.
getInstanceFromWorkflowObject()  : self
Get instance from workflow object.
getKeys()  : array<string|int, string>
Function to get keys.
getModule()  : Vtiger_Module_Model
Get module object.
getName()  : string
Get record name.
getRecordLinks()  : array<string|int, Vtiger_Link_Model>
Function to get the list view actions for the record.
getReferenceFieldName()  : string
Function to get reference field name.
getTasks()  : array<string|int, mixed>
Get tasks array.
getTasksForExport()  : array<string|int, mixed>
Returns array of tasks for active workflow.
getTasksListUrl()  : string
Get tasks list url.
getTaskTypes()  : array<string|int, mixed>
Get task types array.
getWorkflowObject()  : object
Get workflow object.
has()  : bool
Function to check if the key exists.
isDefault()  : bool
Check if is default record.
isEmpty()  : bool
Function to check if the key is empty.
isFilterSavedInNew()  : bool
Check if filter is saved in new.
remove()  : mixed
Function to remove the value.
save()  : mixed
Save record to database.
set()  : $this
Function to set the value for a given key.
setData()  : $this
Function to set all the values.
setModule()  : $this
Set module model.
transformAdvanceFilterToWorkFlowFilter()  : mixed
Function transforms Advance filter to workflow conditions.
transformToAdvancedFilterCondition()  : array<string|int, mixed>
Functions transforms workflow filter to advanced filter.
updateNextTriggerTime()  : mixed
setWorkflowObject()  : $this
Set workflow object.

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

delete()

Delete record from database.

public delete() : mixed
Return values
mixed

executionConditionAsLabel()

Get execution condition label.

public executionConditionAsLabel([int $executionCondition = null ]) : string
Parameters
$executionCondition : int = null
Return values
string

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

getActiveCount()

Function to get the count of active workflows.

public static getActiveCount() : int
Return values
int

count of acive workflows

getActiveCountFromRecord()

Get active workflows from task list.

public static getActiveCountFromRecord([array<string|int, mixed> $taskList = [] ]) : int
Parameters
$taskList : array<string|int, mixed> = []
Return values
int

getAddTaskUrl()

Get add task url.

public getAddTaskUrl() : string
Return values
string

getAllAmountWorkflowsAmount()

Function to get number of workflow.

public static getAllAmountWorkflowsAmount() : int
Return values
int

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()

Get clean instance.

public static getCleanInstance(string $moduleName) : Self
Parameters
$moduleName : string
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>

getDependentModules()

Function returns all the related modules for workflows create entity task.

public getDependentModules() : JSON
Return values
JSON

getDisplayValue()

Get display value.

public getDisplayValue(string $key) : mixed
Parameters
$key : string
Return values
mixed

getEditViewUrl()

Get edit view url.

public getEditViewUrl() : string
Return values
string

getEntityMethods()

Functions returns the Custom Entity Methods that are supported for a module.

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

getFieldFilterValueType()

Function returns valuetype of the field filter.

public getFieldFilterValueType(mixed $fieldname) : string|bool
Parameters
$fieldname : mixed
Return values
string|bool

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()

Get record id.

public getId() : int
Return values
int

getInstance()

Get instance.

public static getInstance(int $workflowId) : Self
Parameters
$workflowId : int
Return values
Self

getInstanceFromWorkflowObject()

Get instance from workflow object.

public static getInstanceFromWorkflowObject(object $wf) : self
Parameters
$wf : object
Return values
self

getKeys()

Function to get keys.

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

getModule()

Get module object.

public getModule() : Vtiger_Module_Model
Return values
Vtiger_Module_Model

getName()

Get record name.

public getName() : string
Return values
string

Function to get the list view actions for the record.

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

getReferenceFieldName()

Function to get reference field name.

public getReferenceFieldName(string $relatedModule) : string
Parameters
$relatedModule : string
Return values
string

fieldname

getTasks()

Get tasks array.

public getTasks([bool $active = false ]) : array<string|int, mixed>
Parameters
$active : bool = false
Return values
array<string|int, mixed>

getTasksForExport()

Returns array of tasks for active workflow.

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

tasks

getTasksListUrl()

Get tasks list url.

public getTasksListUrl() : string
Return values
string

getTaskTypes()

Get task types array.

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

getWorkflowObject()

Get workflow object.

public getWorkflowObject() : object
Return values
object

has()

Function to check if the key exists.

public has(string $key) : bool
Parameters
$key : string
Return values
bool

isDefault()

Check if is default record.

public isDefault() : bool
Return values
bool

isEmpty()

Function to check if the key is empty.

public isEmpty(string $key) : bool
Parameters
$key : string
Return values
bool

isFilterSavedInNew()

Check if filter is saved in new.

public isFilterSavedInNew() : bool
Return values
bool

remove()

Function to remove the value.

public remove(string $key) : mixed
Parameters
$key : string
Return values
mixed

save()

Save record to database.

public save() : mixed
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()

Set module model.

public setModule(string $moduleName) : $this
Parameters
$moduleName : string
Return values
$this

transformAdvanceFilterToWorkFlowFilter()

Function transforms Advance filter to workflow conditions.

public transformAdvanceFilterToWorkFlowFilter() : mixed
Return values
mixed

transformToAdvancedFilterCondition()

Functions transforms workflow filter to advanced filter.

public transformToAdvancedFilterCondition([mixed $conditions = false ]) : array<string|int, mixed>
Parameters
$conditions : mixed = false
Return values
array<string|int, mixed>

updateNextTriggerTime()

public updateNextTriggerTime() : mixed
Return values
mixed

setWorkflowObject()

Set workflow object.

protected setWorkflowObject(object $wf) : $this
Parameters
$wf : object
Return values
$this

Search results