YetiForce PHP Documentation

Settings_Workflows_TaskRecord_Model extends Settings_Vtiger_Record_Model
in package

Roles Record Model Class.

Table of Contents

TASK_STATUS_ACTIVE  = 1
Task status active.
$value  : mixed
__construct()  : mixed
Constructor.
delete()  : mixed
Function deletes workflow task.
get()  : mixed
Function to get the value for a given key.
getAllForWorkflow()  : array<string|int, VTTask>
Return all tasks for workflow.
getArray()  : array<string|int, mixed>
Function to get the array values for a given key.
getChangeStatusUrl()  : string
return change status url.
getCleanInstance()  : VTTask
Return clean instance.
getData()  : array<string|int, mixed>
Function to get all the values of the Object.
getDeleteActionUrl()  : string
Return delete action url.
getDisplayValue()  : mixed
Get display value.
getEditViewUrl()  : string
Return edit view url.
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 task record id.
getInstance()  : VTTask
Return instance.
getInstanceFromTaskObject()  : VTTask
getKeys()  : array<string|int, string>
Function to get keys.
getName()  : string
Return task record name.
getRecordLinks()  : mixed
getTaskManager()  : VTTaskManager
Return task manager object.
getTaskObject()  : VTTask
Return task object.
getTaskType()  : Settings_Workflows_TaskType_Model
Return task type.
getWorkflow()  : Workflow
Return workflow object.
has()  : bool
Function to check if the key exists.
isActive()  : bool
Check if task is active.
isEmpty()  : bool
Function to check if the key is empty.
remove()  : mixed
Function to remove the value.
save()  : mixed
Function saves workflow task.
set()  : $this
Function to set the value for a given key.
setData()  : $this
Function to set all the values.
setTaskManager()  : mixed
Set task manager object.
setTaskObject()  : $this
Set task object.
setWorkflowFromInstance()  : $this
Set workflow from instance.

Constants

TASK_STATUS_ACTIVE

Task status active.

public int TASK_STATUS_ACTIVE = 1

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

Function deletes workflow task.

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

getAllForWorkflow()

Return all tasks for workflow.

public static getAllForWorkflow(Workflow $workflowModel[, bool $active = false ]) : array<string|int, VTTask>
Parameters
$workflowModel : Workflow
$active : bool = false
Return values
array<string|int, VTTask>

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>

getChangeStatusUrl()

return change status url.

public getChangeStatusUrl() : string
Return values
string

getCleanInstance()

Return clean instance.

public static getCleanInstance(object $workflowModel, string $taskName) : VTTask
Parameters
$workflowModel : object
$taskName : string
Return values
VTTask

getData()

Function to get all the values of the Object.

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

getDeleteActionUrl()

Return delete action url.

public getDeleteActionUrl() : string
Return values
string

getDisplayValue()

Get display value.

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

getEditViewUrl()

Return edit view url.

public getEditViewUrl() : string
Return values
string

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 task record id.

public getId() : int
Return values
int

getInstance()

Return instance.

public static getInstance(int $taskId[, Workflow $workflowModel = null ]) : VTTask
Parameters
$taskId : int
$workflowModel : Workflow = null
Return values
VTTask

getKeys()

Function to get keys.

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

getName()

Return task record name.

public getName() : string
Return values
string
public getRecordLinks() : mixed
Return values
mixed

has()

Function to check if the key exists.

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

isActive()

Check if task is active.

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

save()

Function saves workflow task.

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

setTaskObject()

Set task object.

public setTaskObject(VTTask $task) : $this
Parameters
$task : VTTask
Return values
$this

setWorkflowFromInstance()

Set workflow from instance.

public setWorkflowFromInstance(object $workflowModel) : $this
Parameters
$workflowModel : object
Return values
$this

Search results