Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Public Member Functions | Protected Attributes | List of all members
block_rss_client\output\feed Class Reference

Class to help display an RSS Feed. More...

Inheritance diagram for block_rss_client\output\feed:
renderable templatable

Public Member Functions

 __construct ($title, $showtitle=true, $showimage=true)
 Contructor. More...
 
 add_item (item $item)
 Add an RSS item. More...
 
 export_for_template (\renderer_base $output)
 Export this for use in a mustache template context. More...
 
 export_for_template (renderer_base $output)
 Function to export the renderer data in a format that is suitable for a mustache template. More...
 
 get_image ()
 Get the channel image. More...
 
 get_items ()
 Get the RSS items. More...
 
 get_showimage ()
 Get showimage. More...
 
 get_showtitle ()
 Get showtitle. More...
 
 get_title ()
 Get the feed title. More...
 
 set_image (channel_image $image)
 Set the channel image. More...
 
 set_items (array $items)
 Set the RSS items. More...
 
 set_showimage ($showimage)
 Set showimage. More...
 
 set_showtitle ($showtitle)
 Set showtitle. More...
 
 set_title ($title)
 Set the feed title. More...
 

Protected Attributes

channel_image $image = null
 The channel image.
 
array $items = array()
 An array of renderable feed items.
 
boolean $showimage
 Whether or not to show the channel image.
 
boolean $showtitle
 Whether or not to show the title.
 
string $title = null
 The feed's title.
 

Detailed Description

Class to help display an RSS Feed.

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\feed::__construct (   $title,
  $showtitle = true,
  $showimage = true 
)

Contructor.

Parameters
string$titleThe title of the RSS feed
boolean$showtitleWhether to show the title
boolean$showimageWhether to show the channel image

Member Function Documentation

◆ add_item()

block_rss_client\output\feed::add_item ( item  $item)

Add an RSS item.

Parameters
block_rss_client\output\item$item

◆ export_for_template() [1/2]

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

Export this for use in a mustache template context.

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

◆ export_for_template() [2/2]

templatable::export_for_template ( renderer_base  $output)
inherited

Function to export the renderer data in a format that is suitable for a mustache template.

This means:

  1. No complex types - only stdClass, array, int, string, float, bool
  2. Any additional info that is required for the template is pre-calculated (e.g. capability checks).
Parameters
renderer_base$outputUsed to do a final render of any components that need to be rendered for export.
Return values
stdClass|array

Implemented in forumreport_summary\output\filters, core_user\output\unified_filter, core_user\output\status_field, core_tag\output\taglist, core_tag\output\tagindex, core_tag\output\tagfeed, core_tag\output\tagcloud, core_tag\output\tag, report_competency\output\user_course_navigation, report_competency\output\report, core_privacy\output\exported_navigation_page, core_privacy\output\exported_html_page, MoodleQuickForm_wikieditor, mod_lti\output\tool_configure_page, mod_lti\output\external_registration_return_page, mod_forum\output\quick_search_form, mod_forum\output\big_search_form, mod_feedback\output\summary, booktool_print\output\print_book_page, booktool_print\output\print_book_chapter_page, assign_attempt_history_chooser, mod_assign\output\grading_app, login_signup_form, progress_bar, action_menu, tabtree, tabobject, custom_menu_item, initials_bar, paging_bar, url_select, single_select, pix_icon, pix_icon_font, help_icon, component_action, MoodleQuickForm_warning, MoodleQuickForm_url, MoodleQuickForm_textarea, MoodleQuickForm_tags, MoodleQuickForm_submit, MoodleQuickForm_static, MoodleQuickForm_selectwithlink, MoodleQuickForm_selectgroups, MoodleQuickForm_select, MoodleQuickForm_recaptcha, MoodleQuickForm_passwordunmask, MoodleQuickForm_group, MoodleQuickForm_grading, MoodleQuickForm_filepicker, MoodleQuickForm_filemanager, MoodleQuickForm_editor, MoodleQuickForm_date_time_selector, MoodleQuickForm_date_selector, MoodleQuickForm_checkbox, MoodleQuickForm_autocomplete, MoodleQuickForm_advcheckbox, core\output\chooser_section, core\output\chooser_item, core\output\chooser, core\output\checkbox_toggleall, core_group\output\index_page, core_group\output\group_details, enrol_lti\output\registration, core_course\output\modchooser, block_timeline\output\main, block_starredcourses\output\main, block_search_forums\output\search_form, block_recentlyaccesseditems\output\main, block_recentlyaccessedcourses\output\main, block_myprofile\output\myprofile, block_myoverview\output\main, block_lp\output\summary, block_lp\output\plans_to_review_page, block_lp\output\competencies_to_review_page, core_auth\output\verify_age_location_page, core_auth\output\login, core_auth\output\digital_minor_page, tool_templatelibrary\output\list_templates_page, tool_policy\output\page_viewdoc, tool_policy\output\page_viewalldoc, tool_policy\output\page_nopermission, tool_policy\output\page_managedocs_list, tool_policy\output\page_agreedocs, tool_policy\output\guestconsent, tool_policy\output\acceptances, tool_lp\output\user_evidence_list_page, tool_lp\output\user_competency_summary_in_course, tool_lp\output\user_competency_summary, tool_lp\output\user_competency_course_navigation, tool_lp\output\template_competencies_page, tool_lp\output\related_competencies, tool_lp\output\plans_page, tool_lp\output\module_navigation, tool_lp\output\manage_templates_page, tool_lp\output\manage_competency_frameworks_page, tool_lp\output\manage_competencies_page, tool_lp\output\course_competencies_page, tool_lp\output\competency_summary, tool_lp\output\competency_plan_navigation, tool_langimport\output\langimport_page, tool_dataprivacy\output\summary_page, tool_dataprivacy\output\request_filter, tool_dataprivacy\output\purposes, tool_dataprivacy\output\my_data_requests_page, tool_dataprivacy\output\defaults_page, tool_dataprivacy\output\data_requests_page, tool_dataprivacy\output\data_registry_page, tool_dataprivacy\output\data_registry_compliance_page, tool_dataprivacy\output\data_deletion_page, tool_dataprivacy\output\categories, and tool_customlang\output\translator.

◆ get_image()

block_rss_client\output\feed::get_image ( )

Get the channel image.

Return values
channel_image

◆ get_items()

block_rss_client\output\feed::get_items ( )

Get the RSS items.

Return values
arrayAn array of renderable RSS items

◆ get_showimage()

block_rss_client\output\feed::get_showimage ( )

Get showimage.

Return values
boolean

◆ get_showtitle()

block_rss_client\output\feed::get_showtitle ( )

Get showtitle.

Return values
boolean

◆ get_title()

block_rss_client\output\feed::get_title ( )

Get the feed title.

Return values
string

◆ set_image()

block_rss_client\output\feed::set_image ( channel_image  $image)

Set the channel image.

Parameters
block_rss_client\output\channel_image$image

◆ set_items()

block_rss_client\output\feed::set_items ( array  $items)

Set the RSS items.

Parameters
array$itemsAn array of renderable RSS items

◆ set_showimage()

block_rss_client\output\feed::set_showimage (   $showimage)

Set showimage.

Parameters
boolean$showimage
Return values
block_rss_client

◆ set_showtitle()

block_rss_client\output\feed::set_showtitle (   $showtitle)

Set showtitle.

Parameters
boolean$showtitle
Return values
block_rss_client

◆ set_title()

block_rss_client\output\feed::set_title (   $title)

Set the feed title.

Parameters
string$title
Return values
block_rss_client

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