Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
block_rss_client\output\renderer Class Reference

Renderer for RSS Client block. More...

Inheritance diagram for block_rss_client\output\renderer:
plugin_renderer_base renderer_base

Public Member Functions

 __call ($method, $arguments)
 Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.
 
 add_action_handler (component_action $action, $id=null)
 Adds a JS action for the element with the provided id.
 
 format_description ($description)
 Format an RSS item description.
 
 format_published_date ($timestamp)
 Format a timestamp to use as a published date.
 
 format_title ($title)
 Format an RSS item title.
 
 get_compact_logo_url ($maxwidth=300, $maxheight=300)
 Return the site's compact logo URL, if any.
 
 get_logo_url ($maxwidth=null, $maxheight=200)
 Return the site's logo URL, if any.
 
 get_page ()
 Returns the moodle page object.
 
 has_started ()
 Returns true is output has already started, and false if not.
 
 image_url ($imagename, $component='moodle')
 Return the moodle_url for an image.
 
 pix_url ($imagename, $component='moodle')
 Return the direct URL for an image from the pix folder.
 
 render (renderable $widget)
 Renders the provided widget and returns the HTML to display it.
 
 render_block (\templatable $block)
 Render an RSS feeds block.
 
 render_feed (\templatable $feed)
 Render an RSS Feed.
 
 render_footer (\templatable $footer)
 Render the block footer.
 
 render_from_template ($templatename, $context)
 Renders a template by name with the given context.
 
 render_item (\templatable $item)
 Render an RSS Item.
 
 should_display_main_logo ($headinglevel=1)
 Whether we should display the main logo.
 
 should_display_navbar_logo ()
 Whether we should display the logo in the navbar.
 

Static Public Member Functions

static prepare_classes ($classes)
 Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.
 

Protected Member Functions

 get_mustache ()
 Return an instance of the mustache class.
 

Protected Attributes

xhtml_container_stack $opencontainers
 The xhtml_container_stack to use.
 
renderer_base core_renderer $output
 A reference to the current renderer.
 
moodle_page $page
 The Moodle page the renderer has been created to assist with.
 
string $target
 The requested rendering target.
 
array $templatecache = []
 $templatecache The mustache template cache.
 

Detailed Description

Renderer for RSS Client block.

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

Member Function Documentation

◆ format_description()

block_rss_client\output\renderer::format_description ( $description)

Format an RSS item description.

Parameters
string$description
Return values
string

◆ format_published_date()

block_rss_client\output\renderer::format_published_date ( $timestamp)

Format a timestamp to use as a published date.

Parameters
int$timestampUnix timestamp
Return values
string

◆ format_title()

block_rss_client\output\renderer::format_title ( $title)

Format an RSS item title.

Parameters
string$title
Return values
string

◆ render_block()

block_rss_client\output\renderer::render_block ( \templatable $block)

Render an RSS feeds block.

Parameters
templatable$block
Return values
string

◆ render_feed()

block_rss_client\output\renderer::render_feed ( \templatable $feed)

Render an RSS Feed.

Parameters
templatable$feed
Return values
string

◆ render_footer()

block_rss_client\output\renderer::render_footer ( \templatable $footer)

Render the block footer.

Parameters
templatable$footer
Return values
string

◆ render_item()

block_rss_client\output\renderer::render_item ( \templatable $item)

Render an RSS Item.

Parameters
templatable$item
Return values
string

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