block_rss_client\task\refreshfeeds Class Reference

Task for updating RSS feeds for rss client block. More...

Inheritance diagram for block_rss_client\task\refreshfeeds:

Public Member Functions
	can_run ()
	Informs whether this task can be run.
	disable ()
	Disable the task.
	enable ()
	Enable the task.
	eval_cron_field ($field, $min, $max)
	Take a cron field definition and return an array of valid numbers with the range min-max.
	execute ()
	This task goes through all the feeds.
	get_component ()
	Getter for $component.
	get_cron_lock ()
	Get the current lock for the entire cron.
	get_day ()
	Getter for $day.
	get_day_of_week ()
	Getter for $dayofweek.
	get_disabled ()
	Getter for $disabled.
	get_fail_delay ()
	Getter for $faildelay.
	get_hostname ()
	Getter for $hostname.
	get_hour ()
	Getter for $hour.
	get_last_run_time ()
	Get the last run time for this scheduled task.
	get_lock ()
	Get the current lock for this task.
	get_minute ()
	Getter for $minute.
	get_month ()
	Getter for $month.
	get_name ()
	Name for this task.
	get_next_run_time ()
	Get the next run time for this task.
	get_next_scheduled_time (int $now=0)
	Calculate when this task should next be run based on the schedule.
	get_pid ()
	Getter for $pid.
	get_run_if_component_disabled ()
	Override this function if you want this scheduled task to run, even if the component is disabled.
	get_runtime ()
	Returns task runtime.
	get_runtime_result ()
	Returns if the task has been running for too long.
	get_timestarted ()
	Getter for $timestarted.
	has_default_configuration ()
	Determine if this task is using its default configuration changed from the default.
replacement	is_blocking ()
	is_component_enabled ()
	Informs whether the task's component is enabled.
	is_customised ()
	Has this task been changed from it's default config?
	is_enabled ()
	Checks whether the component and the task disabled flag enables to run this task.
	is_overridden ()
	Has this task been changed from it's default config?
	is_valid (string $field)
	Informs whether the given field is valid.
replacement	set_blocking ($blocking)
	set_component ($component)
	Setter for $component.
	set_cron_lock (\core\lock\lock $lock)
	Set the current lock for the entire cron process.
	set_customised ($customised)
	Set customised for this scheduled task.
	set_day ($day)
	Setter for $day.
	set_day_of_week ($dayofweek, $expandr=true)
	Setter for $dayofweek.
	set_disabled ($disabled)
	Setter for $disabled.
	set_fail_delay ($faildelay)
	Setter for $faildelay.
	set_hostname ($hostname=null)
	Setter for $hostname.
	set_hour ($hour, $expandr=true)
	Setter for $hour.
	set_last_run_time ($lastruntime)
	Set the last run time for this scheduled task.
	set_lock (\core\lock\lock $lock)
	Set the current lock for this task.
	set_minute ($minute, $expandr=true)
	Setter for $minute.
	set_month ($month)
	Setter for $month.
	set_next_run_time ($nextruntime)
	Set the next run time for this task.
	set_overridden (bool $overridden)
	Set the overridden value.
	set_pid ($pid=null)
	Setter for $pid.
	set_timestarted ($timestarted=null)
	Setter for $timestarted.

Static Public Member Functions
static	get_html_id (string $classname)
	Produces a valid id string to use as id attribute based on the given FQCN class name.

Public Attributes
replacement	: null
	Setter for $blocking.
replacement	: null
	Getter for $blocking.
const	CLIENT_MAX_SKIPTIME = HOURSECS * 12
	The maximum time in seconds that cron will wait between attempts to retry failing RSS feeds.
const	DAYMAX = 31
	Maximum day of month value.
const	DAYMIN = 1
	Minimum day of month value.
const	DAYOFWEEKMAX = 6
	Maximum dayofweek value.
const	DAYOFWEEKMAXINPUT = 7
	Maximum dayofweek value allowed in input (7 = 0).
const	DAYOFWEEKMIN = 0
	Minimum dayofweek value.
const	FIELD_DAY = 'day'
	Day-of-month field identifier.
const	FIELD_DAYOFWEEK = 'dayofweek'
	Day-of-week field identifier.
const	FIELD_HOUR = 'hour'
	Hour field identifier.
const	FIELD_MINUTE = 'minute'
	Minute field identifier.
const	FIELD_MONTH = 'month'
	Month field identifier.
const	HOURMAX = 23
	Maximum hour value.
const	HOURMIN = 0
	Minimum hour value.
const	MINUTEMAX = 59
	Maximum minute value.
const	MINUTEMIN = 0
	Minimum minute value.
const	MONTHMAX = 12
	Maximum month value.
const	MONTHMIN = 1
	Minimum month value.
const	NEVER_RUN_TIME = 7952342400
	Time used for the next scheduled time when a task should never run.
replacement	reason: 'Blocking tasks are no longer supported'
replacement	since: '4.4'

Protected Member Functions
	calculate_skiptime (int $currentskip)
	Calculates a new skip time for a record based on the current skip time.
	fetch_feed (string $url)
	Fetch a feed for the specified URL.
	get_next_scheduled_time_inner (int $now, array $validminutes, array $validhours, array $validdays, array $validdaysofweek, array $validmonths, int $originalyear=0)
	Recursively calculate the next valid time for this task.

Detailed Description

Task for updating RSS feeds for rss client block.

Author

Farhan Karmali farha.nosp@m.n631.nosp@m.8@gma.nosp@m.il.c.nosp@m.om

Copyright

Farhan Karmali 2018

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

calculate_skiptime()

block_rss_client\task\refreshfeeds::calculate_skiptime ( int $currentskip )

protected

Calculates a new skip time for a record based on the current skip time.

Parameters

int

$currentskip

The current skip time of a record.

Return values

int	The newly calculated skip time.

can_run()

core\task\scheduled_task::can_run ( )

inherited

Informs whether this task can be run.

Return values

bool	true when this task can be run. false otherwise.

Reimplemented in cachestore_redis\task\ttl.

eval_cron_field()

core\task\scheduled_task::eval_cron_field ( $field, $min, $max )

inherited

Take a cron field definition and return an array of valid numbers with the range min-max.

Parameters

string	$field	- The field definition.
int	$min	- The minimum allowable value.
int	$max	- The maximum allowable value.

Return values

array(int)

execute()

block_rss_client\task\refreshfeeds::execute

(

)

This task goes through all the feeds.

If the feed has a skipuntil value that is less than the current time cron will attempt to retrieve it with the cache duration set to 0 in order to force the retrieval of the item and refresh the cache.

If a feed fails then the skipuntil time of that feed is set to be later than the next expected task time. The amount of time will increase each time the fetch fails until the maximum is reached.

If a feed that has been failing is successfully retrieved it will go back to being handled as though it had never failed.

Task should therefore process requests for permanently broken RSS feeds infrequently, and temporarily unavailable feeds will be tried less often until they become available again.

Reimplemented from core\task\task_base.

fetch_feed()

block_rss_client\task\refreshfeeds::fetch_feed ( string $url )

protected

Fetch a feed for the specified URL.

Parameters

string

$url

The URL to fetch

Return values

moodle_simplepie

get_component()

core\task\task_base::get_component ( )

inherited

Getter for $component.

Return values

string

get_cron_lock()

core\task\task_base::get_cron_lock ( )

inherited

Get the current lock for the entire cron.

Return values

core\lock\lock

get_day()

core\task\scheduled_task::get_day ( )

inherited

Getter for $day.

Return values

string

get_day_of_week()

core\task\scheduled_task::get_day_of_week ( )

inherited

Getter for $dayofweek.

Return values

string

get_disabled()

core\task\scheduled_task::get_disabled ( )

inherited

Getter for $disabled.

Return values

bool

get_fail_delay()

core\task\task_base::get_fail_delay ( )

inherited

Getter for $faildelay.

Return values

int

get_hostname()

core\task\task_base::get_hostname ( )

inherited

Getter for $hostname.

Return values

string

get_hour()

core\task\scheduled_task::get_hour ( )

inherited

Getter for $hour.

Return values

string

get_html_id()

static core\task\scheduled_task::get_html_id ( string $classname )

staticinherited

Produces a valid id string to use as id attribute based on the given FQCN class name.

Parameters

string

$classname

FQCN of a task.

Return values

string

valid string to be used as id attribute.

get_last_run_time()

core\task\scheduled_task::get_last_run_time ( )

inherited

Get the last run time for this scheduled task.

Return values

int

get_lock()

core\task\task_base::get_lock ( )

inherited

Get the current lock for this task.

Return values

core\lock\lock

get_minute()

core\task\scheduled_task::get_minute ( )

inherited

Getter for $minute.

Return values

string

get_month()

core\task\scheduled_task::get_month ( )

inherited

Getter for $month.

Return values

string

get_name()

block_rss_client\task\refreshfeeds::get_name

(

)

Name for this task.

Return values

string

Reimplemented from core\task\task_base.

get_next_run_time()

core\task\task_base::get_next_run_time ( )

inherited

Get the next run time for this task.

Return values

int

timestamp

get_next_scheduled_time()

core\task\scheduled_task::get_next_scheduled_time ( int $now = 0 )

inherited

Calculate when this task should next be run based on the schedule.

Parameters

int

$now

Current time, for testing (leave 0 to use default time)

Return values

int\$nextruntime,.

get_next_scheduled_time_inner()

core\task\scheduled_task::get_next_scheduled_time_inner ( int $now, array $validminutes, array $validhours, array $validdays, array $validdaysofweek, array $validmonths, int $originalyear = 0 )

protectedinherited

Recursively calculate the next valid time for this task.

Parameters

int	$now	Start time
array	$validminutes	Valid minutes
array	$validhours	Valid hours
array	$validdays	Valid days
array	$validdaysofweek	Valid days of week
array	$validmonths	Valid months
int	$originalyear	Zero for first call, original year for recursive calls

Return values

int	Next run time

get_pid()

core\task\task_base::get_pid ( )

inherited

Getter for $pid.

Return values

int

get_run_if_component_disabled()

core\task\scheduled_task::get_run_if_component_disabled ( )

inherited

Override this function if you want this scheduled task to run, even if the component is disabled.

Return values

bool

get_runtime()

core\task\task_base::get_runtime ( )

inherited

Returns task runtime.

Return values

int

get_runtime_result()

core\task\task_base::get_runtime_result ( )

inherited

Returns if the task has been running for too long.

Return values

result

get_timestarted()

core\task\task_base::get_timestarted ( )

inherited

Getter for $timestarted.

Return values

int

has_default_configuration()

core\task\scheduled_task::has_default_configuration ( )

inherited

Determine if this task is using its default configuration changed from the default.

Returns true if it is and false otherwise. Does not rely on the customised field.

Return values

bool

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.

is_customised()

core\task\scheduled_task::is_customised ( )

inherited

Has this task been changed from it's default config?

Return values

bool

is_enabled()

core\task\scheduled_task::is_enabled ( )

inherited

Checks whether the component and the task disabled flag enables to run this task.

This do not checks whether the task manager allows running them or if the site allows tasks to "run now".

Return values

bool	true if task is enabled. false otherwise.

is_overridden()

core\task\scheduled_task::is_overridden ( )

inherited

Has this task been changed from it's default config?

Return values

bool

is_valid()

core\task\scheduled_task::is_valid ( string $field )

inherited

Informs whether the given field is valid.

Use the constants FIELD_* to identify the field. Have to be called after the method set_{field}(string).

Parameters

string

$field

field identifier; expected values from constants FIELD_*.

Return values

bool	true if given field is valid. false otherwise.

set_component()

core\task\task_base::set_component ( $component )

inherited

Setter for $component.

Parameters

string

$component

set_cron_lock()

core\task\task_base::set_cron_lock ( \core\lock\lock $lock )

inherited

Set the current lock for the entire cron process.

Parameters

core\lock\lock

$lock

set_customised()

core\task\scheduled_task::set_customised ( $customised )

inherited

Set customised for this scheduled task.

Parameters

bool

set_day()

core\task\scheduled_task::set_day ( $day )

inherited

Setter for $day.

Parameters

string

$day

set_day_of_week()

core\task\scheduled_task::set_day_of_week ( $dayofweek, $expandr = true )

inherited

Setter for $dayofweek.

Parameters

string	$dayofweek
bool	$expandr	- if true (default) an 'R' value in a time is expanded to an appropriate int. If false, they are left as 'R'

set_disabled()

core\task\scheduled_task::set_disabled ( $disabled )

inherited

Setter for $disabled.

Parameters

bool

$disabled

set_fail_delay()

core\task\task_base::set_fail_delay ( $faildelay )

inherited

Setter for $faildelay.

Parameters

int

$faildelay

set_hostname()

core\task\task_base::set_hostname ( $hostname = null )

inherited

Setter for $hostname.

Parameters

string

$hostname

set_hour()

core\task\scheduled_task::set_hour ( $hour, $expandr = true )

inherited

Setter for $hour.

Accepts a special 'R' value which will be translated to a random hour.

Parameters

string	$hour
bool	$expandr	- if true (default) an 'R' value in a time is expanded to an appropriate int. If false, they are left as 'R'

set_last_run_time()

core\task\scheduled_task::set_last_run_time ( $lastruntime )

inherited

Set the last run time for this scheduled task.

Parameters

int

$lastruntime

set_lock()

core\task\task_base::set_lock ( \core\lock\lock $lock )

inherited

Set the current lock for this task.

Parameters

core\lock\lock

$lock

set_minute()

core\task\scheduled_task::set_minute ( $minute, $expandr = true )

inherited

Setter for $minute.

Accepts a special 'R' value which will be translated to a random minute.

Parameters

string	$minute
bool	$expandr	- if true (default) an 'R' value in a time is expanded to an appropriate int. If false, they are left as 'R'

set_month()

core\task\scheduled_task::set_month ( $month )

inherited

Setter for $month.

Parameters

string

$month

set_next_run_time()

core\task\task_base::set_next_run_time ( $nextruntime )

inherited

Set the next run time for this task.

Parameters

int

$nextruntime

set_overridden()

core\task\scheduled_task::set_overridden ( bool $overridden )

inherited

Set the overridden value.

Parameters

bool

$overridden

set_pid()

core\task\task_base::set_pid ( $pid = null )

inherited

Setter for $pid.

Parameters

int

$pid

set_timestarted()

core\task\task_base::set_timestarted ( $timestarted = null )

inherited

Setter for $timestarted.

Parameters

int

$timestarted

Member Data Documentation

__pad0__

replacement core\task\task_base::__pad0__

inherited

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__

replacement core\task\task_base::__pad1__

inherited

Getter for $blocking.

Return values

bool

Deprecated

since Moodle 4.4 See MDL-67667

Todo

Remove in MDL-81509

NEVER_RUN_TIME

const core\task\scheduled_task::NEVER_RUN_TIME = 7952342400

inherited

Time used for the next scheduled time when a task should never run.

This is 2222-01-01 00:00 GMT which is a large time that still fits in 10 digits.

---

The documentation for this class was generated from the following file:

• blocks/rss_client/classes/task/refreshfeeds.php