Moodle PHP Documentation 5.1
Moodle 5.1dev (Build: 20250706) (a6b17d8f6bd)
block_rss_client\output\footer Class Reference

Class to help display an RSS Block footer. More...

Inheritance diagram for block_rss_client\output\footer:

Public Member Functions

 __construct ($channelurl=null)
 Constructor.
 
 export_for_template (\renderer_base $output)
 Export context for use in mustache templates.
 
 get_channelurl ()
 Get the channel url.
 
 set_channelurl (\moodle_url $channelurl)
 Set the channel url.
 
 set_failed (\moodle_url $manageurl)
 Record the fact that there is at least one failed feed (and the URL for viewing these failed feeds).
 

Protected Attributes

moodle_url null $channelurl
 The link provided in the RSS channel.
 
moodle_url null $manageurl = null
 Link to manage feeds, only provided if a feed has failed.
 

Detailed Description

Class to help display an RSS Block footer.

Author
Brendan Anderson brend.nosp@m.an_a.nosp@m.nders.nosp@m.on@h.nosp@m.cpss..nosp@m.org
License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

◆ __construct()

block_rss_client\output\footer::__construct ( $channelurl = null)

Constructor.

Parameters
moodle_url$channelurl(optional) The link provided in the RSS channel

Member Function Documentation

◆ export_for_template()

block_rss_client\output\footer::export_for_template ( \renderer_base $output)

Export context for use in mustache templates.

See also
templatable::export_for_template()
Parameters
renderer_base$output
Return values
stdClass

◆ get_channelurl()

block_rss_client\output\footer::get_channelurl ( )

Get the channel url.

Return values
moodle_url

◆ set_channelurl()

block_rss_client\output\footer::set_channelurl ( \moodle_url $channelurl)

Set the channel url.

Parameters
moodle_url$channelurl
Return values
block_rss_client\output\footer

◆ set_failed()

block_rss_client\output\footer::set_failed ( \moodle_url $manageurl)

Record the fact that there is at least one failed feed (and the URL for viewing these failed feeds).

Parameters
moodle_url$manageurlthe URL to link to for more information

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