-
Notifications
You must be signed in to change notification settings - Fork 35
mod_system_Autotasks
Raimondas Rimkevičius edited this page Mar 9, 2020
·
1 revision
Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!
Task objects
- Class name: mod_system_Autotasks
- Namespace:
- Parent class: icms_ipf_Object
public mixed $content = \false
- Visibility: public
public int sat_id
Task ID
- Visibility: public
public int sat_lastruntime
Last run time
- Visibility: public
public string sat_name
Name dispalyed in admin
- Visibility: public
public string sat_code
Code to execute
- Visibility: public
public int sat_repeat
How many times to repeat (0 - always)
- Visibility: public
public int sat_interval
Interval in minutes
- Visibility: public
public int sat_onfinish
Auto delete?
- Visibility: public
public int sat_enabled
Is enabled?
- Visibility: public
public string sat_type
Type (custom or module)
- Visibility: public
public int sat_addon_id
Module ID
- Visibility: public
mixed mod_system_Autotasks::__construct(object handler)
Constructor
- Visibility: public
- handler object
string mod_system_Autotasks::getLastRunTimeForDisplay()
Get the last time a task was run and format it for display
- Visibility: public
string mod_system_Autotasks::getRepeatForDisplay()
Get the recurrence for the task and format it for display
- Visibility: public
string mod_system_Autotasks::getIntervalForDisplay()
Get the recur interval and format it for display
- Visibility: public
string mod_system_Autotasks::getType(string part)
Get the autotask type
- Visibility: public
- part string
string mod_system_Autotasks::getTypeForDisplay()
Format the type for display
- Visibility: public
string mod_system_Autotasks::getEnableForDisplay()
Retrieve and format the enabled status of the task
- Visibility: public
string mod_system_Autotasks::getOnFinishForDisplay()
Retrieve and format for display if the task will be deleted on completion
- Visibility: public
bool mod_system_Autotasks::exec()
Executes code attached to event
- Visibility: public
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
- form_caption mixed
- form_name mixed
- form_action mixed
- submit_button_caption mixed
- cancel_js_action mixed
- captcha mixed
mixed mod_system_Autotasks::getDeleteButtonForDisplay()
Determine if the user can delete the task and display a button
- Visibility: public
string mod_system_Autotasks::getNameForDisplay()
Retrieve name for display
- Visibility: public