mod_system_Autotasks

Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!

mod_system_Autotasks

Task objects

• Class name: mod_system_Autotasks
• Namespace:
• Parent class: icms_ipf_Object

Properties

$content

public mixed $content = \false

• Visibility: public

sat_id

public int sat_id

Task ID

• Visibility: public

sat_lastruntime

public int sat_lastruntime

Last run time

• Visibility: public

sat_name

public string sat_name

Name dispalyed in admin

• Visibility: public

sat_code

public string sat_code

Code to execute

• Visibility: public

sat_repeat

public int sat_repeat

How many times to repeat (0 - always)

• Visibility: public

sat_interval

public int sat_interval

Interval in minutes

• Visibility: public

sat_onfinish

public int sat_onfinish

Auto delete?

• Visibility: public

sat_enabled

public int sat_enabled

Is enabled?

• Visibility: public

sat_type

public string sat_type

Type (custom or module)

• Visibility: public

sat_addon_id

public int sat_addon_id

Module ID

• Visibility: public

Methods

__construct

mixed mod_system_Autotasks::__construct(object handler)

Constructor

• Visibility: public

Arguments

• handler object

getLastRunTimeForDisplay

string mod_system_Autotasks::getLastRunTimeForDisplay()

Get the last time a task was run and format it for display

• Visibility: public

getRepeatForDisplay

string mod_system_Autotasks::getRepeatForDisplay()

Get the recurrence for the task and format it for display

• Visibility: public

getIntervalForDisplay

string mod_system_Autotasks::getIntervalForDisplay()

Get the recur interval and format it for display

• Visibility: public

getType

string mod_system_Autotasks::getType(string part)

Get the autotask type

• Visibility: public

Arguments

• part string

getTypeForDisplay

string mod_system_Autotasks::getTypeForDisplay()

Format the type for display

• Visibility: public

getEnableForDisplay

string mod_system_Autotasks::getEnableForDisplay()

Retrieve and format the enabled status of the task

• Visibility: public

getOnFinishForDisplay

string mod_system_Autotasks::getOnFinishForDisplay()

Retrieve and format for display if the task will be deleted on completion

• Visibility: public

exec

bool mod_system_Autotasks::exec()

Executes code attached to event

• Visibility: public

getForm

mixed mod_system_Autotasks::getForm(mixed form_caption, mixed form_name, mixed form_action, mixed submit_button_caption, mixed cancel_js_action, mixed captcha)

Custom form generation for autotasks

• Visibility: public

Arguments

• form_caption mixed
• form_name mixed
• form_action mixed
• submit_button_caption mixed
• cancel_js_action mixed
• captcha mixed

getDeleteButtonForDisplay

mixed mod_system_Autotasks::getDeleteButtonForDisplay()

Determine if the user can delete the task and display a button

• Visibility: public

getNameForDisplay

string mod_system_Autotasks::getNameForDisplay()

Retrieve name for display

• Visibility: public