Documentation

Workflow
in package

Workflow class.

Table of Contents

$SCHEDULED_15_MINUTES  : int
Scheduled hourly.
$SCHEDULED_30_MINUTES  : int
Scheduled hourly.
$SCHEDULED_5_MINUTES  : int
Scheduled hourly.
$SCHEDULED_ANNUALLY  : int
Scheduled annually.
$SCHEDULED_DAILY  : int
Scheduled daily.
$SCHEDULED_HOURLY  : int
Scheduled hourly.
$SCHEDULED_LIST  : array<string|int, int>
Scheduled list.
$SCHEDULED_MONTHLY_BY_DATE  : int
Scheduled monthly by date.
$SCHEDULED_MONTHLY_BY_WEEKDAY  : int
Scheduled monthly by weekday.
$SCHEDULED_ON_SPECIFIC_DATE  : int
Scheduled on specific date.
$SCHEDULED_WEEKLY  : int
Scheduled weekly.
$SCHEDULED_WORKINGDAY_DAY  : int
Scheduled closest working day.
$SCHEDULED_WORKINGDAY_MONTH  : int
Scheduled first working day in month.
$SCHEDULED_WORKINGDAY_WEEK  : int
Scheduled first working day in week.
__construct()  : mixed
Constructor.
evaluate()  : bool
Evaluate.
executionConditionAsLabel()  : string
Execution condition as label.
getNextTriggerTime()  : timestamp
Function gets the next trigger for the workflows.
getNextTriggerTimeForAnnualDates()  : time
to get next trigger time.
getNextTriggerTimeForDaily()  : time
get next trigger time for daily.
getNextTriggerTimeForMonthlyByDate()  : time
get next triggertime for monthly.
getNextTriggerTimeForMonthlyByWeekDay()  : time
to get next trigger time for weekday of the month.
getNextTriggerTimeForWeekly()  : time
get next trigger Time For weekly.
getNextTriggerTimeValue()  : timestamp
Return next trigger timestamp.
getWFScheduleAnnualDates()  : bool
Return workflow schedule annual dates.
getWFScheduleDay()  : int
Return workflow schedule day.
getWFScheduleTime()  : timestamp
Return workflow schedule timestamp.
getWFScheduleTimeUserFormat()  : string
Return workflow schedule timestamp in user format.
getWFScheduleType()  : int
Return schedule type.
getWFScheduleWeek()  : int
Return workflow schedule week.
isCompletedForRecord()  : bool
Check if workfow is completed for record.
markAsCompletedForRecord()  : mixed
Mark workflow as completed for record.
performTasks()  : mixed
Perform tasks.
setNextTriggerTime()  : mixed
Sets next trigger time.
setup()  : mixed
Setup workflow.

Properties

$SCHEDULED_15_MINUTES

Scheduled hourly.

public static int $SCHEDULED_15_MINUTES = 9

$SCHEDULED_30_MINUTES

Scheduled hourly.

public static int $SCHEDULED_30_MINUTES = 8

$SCHEDULED_5_MINUTES

Scheduled hourly.

public static int $SCHEDULED_5_MINUTES = 10

$SCHEDULED_ANNUALLY

Scheduled annually.

public static int $SCHEDULED_ANNUALLY = 7

$SCHEDULED_DAILY

Scheduled daily.

public static int $SCHEDULED_DAILY = 2

$SCHEDULED_HOURLY

Scheduled hourly.

public static int $SCHEDULED_HOURLY = 1

$SCHEDULED_LIST

Scheduled list.

public static array<string|int, int> $SCHEDULED_LIST = [10 => 'LBL_5_MINUTES', 9 => 'LBL_15_MINUTES', 8 => 'LBL_30_MINUTES', 1 => 'LBL_HOURLY', 2 => 'LBL_DAILY', 3 => 'LBL_WEEKLY', 4 => 'LBL_SPECIFIC_DATE', 5 => 'LBL_MONTHLY_BY_DATE', 6 => 'LBL_MONTHLY_BY_WEEKDAY', 7 => 'LBL_YEARLY', 11 => 'LBL_WORKINGDAY_DAY', 12 => 'LBL_WORKINGDAY_WEEK', 13 => 'LBL_WORKINGDAY_MONTH']

$SCHEDULED_MONTHLY_BY_DATE

Scheduled monthly by date.

public static int $SCHEDULED_MONTHLY_BY_DATE = 5

$SCHEDULED_MONTHLY_BY_WEEKDAY

Scheduled monthly by weekday.

public static int $SCHEDULED_MONTHLY_BY_WEEKDAY = 6

$SCHEDULED_ON_SPECIFIC_DATE

Scheduled on specific date.

public static int $SCHEDULED_ON_SPECIFIC_DATE = 4

$SCHEDULED_WEEKLY

Scheduled weekly.

public static int $SCHEDULED_WEEKLY = 3

$SCHEDULED_WORKINGDAY_DAY

Scheduled closest working day.

public static int $SCHEDULED_WORKINGDAY_DAY = 11

$SCHEDULED_WORKINGDAY_MONTH

Scheduled first working day in month.

public static int $SCHEDULED_WORKINGDAY_MONTH = 13

$SCHEDULED_WORKINGDAY_WEEK

Scheduled first working day in week.

public static int $SCHEDULED_WORKINGDAY_WEEK = 12

Methods

__construct()

Constructor.

public __construct() : mixed
Return values
mixed

executionConditionAsLabel()

Execution condition as label.

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

getNextTriggerTime()

Function gets the next trigger for the workflows.

public getNextTriggerTime() : timestamp
Tags
global

string $default_timezone

Return values
timestamp

getNextTriggerTimeForAnnualDates()

to get next trigger time.

public getNextTriggerTimeForAnnualDates(json $annualDates, timestamp $scheduledTime) : time
Parameters
$annualDates : json
$scheduledTime : timestamp
Return values
time

getNextTriggerTimeForDaily()

get next trigger time for daily.

public getNextTriggerTimeForDaily(mixed $scheduledTime) : time
Parameters
$scheduledTime : mixed
Return values
time

getNextTriggerTimeForMonthlyByDate()

get next triggertime for monthly.

public getNextTriggerTimeForMonthlyByDate(int $scheduledDayOfMonth, int $scheduledTime) : time
Parameters
$scheduledDayOfMonth : int
$scheduledTime : int
Return values
time

getNextTriggerTimeForMonthlyByWeekDay()

to get next trigger time for weekday of the month.

public getNextTriggerTimeForMonthlyByWeekDay(int $scheduledWeekDayOfMonth, timestamp $scheduledTime) : time
Parameters
$scheduledWeekDayOfMonth : int
$scheduledTime : timestamp
Return values
time

getNextTriggerTimeForWeekly()

get next trigger Time For weekly.

public getNextTriggerTimeForWeekly(json $scheduledDaysOfWeek, time $scheduledTime) : time
Parameters
$scheduledDaysOfWeek : json
$scheduledTime : time
Return values
time

getNextTriggerTimeValue()

Return next trigger timestamp.

public getNextTriggerTimeValue() : timestamp
Return values
timestamp

getWFScheduleAnnualDates()

Return workflow schedule annual dates.

public getWFScheduleAnnualDates() : bool
Return values
bool

getWFScheduleDay()

Return workflow schedule day.

public getWFScheduleDay() : int
Return values
int

getWFScheduleTime()

Return workflow schedule timestamp.

public getWFScheduleTime() : timestamp
Return values
timestamp

getWFScheduleTimeUserFormat()

Return workflow schedule timestamp in user format.

public getWFScheduleTimeUserFormat() : string
Return values
string

getWFScheduleType()

Return schedule type.

public getWFScheduleType() : int
Return values
int

getWFScheduleWeek()

Return workflow schedule week.

public getWFScheduleWeek() : int
Return values
int

isCompletedForRecord()

Check if workfow is completed for record.

public isCompletedForRecord(int $recordId) : bool
Parameters
$recordId : int
Return values
bool

markAsCompletedForRecord()

Mark workflow as completed for record.

public markAsCompletedForRecord(int $recordId) : mixed
Parameters
$recordId : int
Return values
mixed

performTasks()

Perform tasks.

public performTasks(Vtiger_Record_Model $recordModel[, array<string|int, mixed>|null $tasks = null ]) : mixed
Parameters
$recordModel : Vtiger_Record_Model
$tasks : array<string|int, mixed>|null = null
Return values
mixed

setNextTriggerTime()

Sets next trigger time.

public setNextTriggerTime(timestamp $time) : mixed
Parameters
$time : timestamp
Return values
mixed

setup()

Setup workflow.

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

Search results