Class that cleans up data related to deleted search area.
More...
Class that cleans up data related to deleted search area.
Custom data accepted:
- areaid -> String search area id .
- Copyright
- 2019 Dmitrii Metelkin dmitr.nosp@m.iim@.nosp@m.catal.nosp@m.yst-.nosp@m.au.ne.nosp@m.t
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
◆ execute()
core\task\clean_up_deleted_search_area_task::execute |
( |
| ) |
|
◆ get_attempts_available()
core\task\adhoc_task::get_attempts_available |
( |
| ) |
|
|
inherited |
Get the remaining attempts of the task.
- Return values
-
int | Number of the remaining attempts of the task. |
◆ get_component()
core\task\task_base::get_component |
( |
| ) |
|
|
inherited |
Getter for $component.
- Return values
-
◆ get_concurrency_limit()
core\task\adhoc_task::get_concurrency_limit |
( |
| ) |
|
|
finalinherited |
Returns effective concurrency limit for this task.
- Return values
-
int | effective concurrency limit for this task |
◆ get_cron_lock()
core\task\task_base::get_cron_lock |
( |
| ) |
|
|
inherited |
Get the current lock for the entire cron.
- Return values
-
◆ get_custom_data()
core\task\adhoc_task::get_custom_data |
( |
| ) |
|
|
inherited |
Getter for $customdata.
- Return values
-
mixed | (anything that can be handled by json_decode). |
◆ get_custom_data_as_string()
core\task\adhoc_task::get_custom_data_as_string |
( |
| ) |
|
|
inherited |
Alternate getter for $customdata.
- Return values
-
string | this is the raw json encoded version. |
◆ get_default_concurrency_limit()
core\task\adhoc_task::get_default_concurrency_limit |
( |
| ) |
|
|
protectedinherited |
Returns default concurrency limit for this task.
- Return values
-
int | default concurrency limit |
◆ get_fail_delay()
core\task\task_base::get_fail_delay |
( |
| ) |
|
|
inherited |
Getter for $faildelay.
- Return values
-
◆ get_hostname()
core\task\task_base::get_hostname |
( |
| ) |
|
|
inherited |
Getter for $hostname.
- Return values
-
◆ get_id()
core\task\adhoc_task::get_id |
( |
| ) |
|
|
inherited |
Getter for $id.
- Return values
-
◆ get_lock()
core\task\task_base::get_lock |
( |
| ) |
|
|
inherited |
Get the current lock for this task.
- Return values
-
◆ get_name()
core\task\adhoc_task::get_name |
( |
| ) |
|
|
inherited |
◆ get_next_run_time()
core\task\task_base::get_next_run_time |
( |
| ) |
|
|
inherited |
Get the next run time for this task.
- Return values
-
◆ get_pid()
core\task\task_base::get_pid |
( |
| ) |
|
|
inherited |
Getter for $pid.
- Return values
-
◆ get_runtime()
core\task\task_base::get_runtime |
( |
| ) |
|
|
inherited |
Returns task runtime.
- Return values
-
◆ get_runtime_result()
core\task\task_base::get_runtime_result |
( |
| ) |
|
|
inherited |
Returns if the task has been running for too long.
- Return values
-
◆ get_timestarted()
core\task\task_base::get_timestarted |
( |
| ) |
|
|
inherited |
Getter for $timestarted.
- Return values
-
◆ get_userid()
core\task\adhoc_task::get_userid |
( |
| ) |
|
|
inherited |
Getter for $userid.
- Return values
-
◆ is_component_enabled()
core\task\task_base::is_component_enabled |
( |
| ) |
|
|
inherited |
Informs whether the task's component is enabled.
- Return values
-
bool | true when enabled. false otherwise. |
◆ retry_until_success()
core\task\adhoc_task::retry_until_success |
( |
| ) |
|
|
inherited |
◆ set_attempts_available()
core\task\adhoc_task::set_attempts_available |
( |
int | $attemptsavailable | ) |
|
|
inherited |
Set the remaining attempts of the task.
- Parameters
-
int | $attemptsavailable | Number of the remaining attempts of the task. |
◆ set_component()
core\task\task_base::set_component |
( |
| $component | ) |
|
|
inherited |
Setter for $component.
- Parameters
-
◆ set_concurrency_lock()
Sets concurrency task lock.
- Parameters
-
◆ set_cron_lock()
Set the current lock for the entire cron process.
- Parameters
-
◆ set_custom_data()
core\task\adhoc_task::set_custom_data |
( |
| $customdata | ) |
|
|
inherited |
Setter for $customdata.
- Parameters
-
mixed | $customdata | (anything that can be handled by json_encode) |
◆ set_custom_data_as_string()
core\task\adhoc_task::set_custom_data_as_string |
( |
| $customdata | ) |
|
|
inherited |
Alternate setter for $customdata.
Expects the data as a json_encoded string.
- Parameters
-
string | $customdata | json_encoded string |
◆ set_fail_delay()
core\task\task_base::set_fail_delay |
( |
| $faildelay | ) |
|
|
inherited |
Setter for $faildelay.
- Parameters
-
◆ set_hostname()
core\task\task_base::set_hostname |
( |
| $hostname = null | ) |
|
|
inherited |
Setter for $hostname.
- Parameters
-
◆ set_id()
core\task\adhoc_task::set_id |
( |
| $id | ) |
|
|
inherited |
Setter for $id.
- Parameters
-
◆ set_lock()
Set the current lock for this task.
- Parameters
-
◆ set_next_run_time()
core\task\task_base::set_next_run_time |
( |
| $nextruntime | ) |
|
|
inherited |
Set the next run time for this task.
- Parameters
-
◆ set_pid()
core\task\task_base::set_pid |
( |
| $pid = null | ) |
|
|
inherited |
Setter for $pid.
- Parameters
-
◆ set_timestarted()
core\task\task_base::set_timestarted |
( |
| $timestarted = null | ) |
|
|
inherited |
Setter for $timestarted.
- Parameters
-
◆ set_userid()
core\task\adhoc_task::set_userid |
( |
| $userid | ) |
|
|
inherited |
Setter for $userid.
- Parameters
-
◆ __pad0__
Setter for $blocking.
Please note that task blocking is no longer supported. If you are using it in older versions of Moodle you are strongly advised to rewrite your code as has a detrimental impact upon performance.
- Deprecated
- since Moodle 4.4 See MDL-67667
- Todo
- Remove in MDL-81509
◆ __pad1__
The documentation for this class was generated from the following file:
- lib/classes/task/clean_up_deleted_search_area_task.php