Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
  • Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
/mod/forum/classes/local/factories/ -> renderer.php (source)

[Source view]

Renderer factory.

Copyright: 2019 Ryan Wyllie <ryan@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 638 lines (28 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

renderer:: (12 methods):
  __construct()
  get_discussion_renderer()
  get_posts_renderer()
  get_single_discussion_posts_renderer()
  get_posts_search_results_renderer()
  get_user_forum_posts_report_renderer()
  get_discussion_list_renderer()
  get_detailed_discussion_list_renderer()
  get_blog_discussion_list_renderer()
  get_social_discussion_list_renderer()
  get_frontpage_news_discussion_list_renderer()
  get_single_discussion_list_renderer()


Class: renderer  - X-Ref

Renderer factory.

See:
https://designpatternsphp.readthedocs.io/en/latest/Creational/SimpleFactory/README.html

__construct(legacy_data_mapper_factory $legacydatamapperfactory,exporter_factory $exporterfactory,vault_factory $vaultfactory,manager_factory $managerfactory,entity_factory $entityfactory,builder_factory $builderfactory,url_factory $urlfactory,moodle_page $page)   X-Ref
Constructor.

param: legacy_data_mapper_factory $legacydatamapperfactory Legacy data mapper factory
param: exporter_factory $exporterfactory Exporter factory
param: vault_factory $vaultfactory Vault factory
param: manager_factory $managerfactory Manager factory
param: entity_factory $entityfactory Entity factory
param: builder_factory $builderfactory Builder factory
param: url_factory $urlfactory URL factory
param: moodle_page $page Moodle page

get_discussion_renderer(forum_entity $forum,discussion_entity $discussion,int $displaymode)   X-Ref
Create a discussion renderer for the given forum and discussion.

param: forum_entity $forum Forum the discussion belongs to
param: discussion_entity $discussion Discussion to render
param: int $displaymode How should the posts be formatted?
return: discussion_renderer

get_posts_renderer()   X-Ref
No description

get_single_discussion_posts_renderer(int $displaymode = null, bool $readonly = false)   X-Ref
Create a posts renderer to render a list of posts in a single discussion.

param: int|null $displaymode How should the posts be formatted?
param: bool $readonly Should the posts include the actions to reply, delete, etc?
return: posts_renderer

get_posts_search_results_renderer(array $searchterms)   X-Ref
No description

get_user_forum_posts_report_renderer(bool $addlinkstocontext)   X-Ref
No description

get_discussion_list_renderer(forum_entity $forum)   X-Ref
No description

get_detailed_discussion_list_renderer(forum_entity $forum,string $template)   X-Ref
No description

get_blog_discussion_list_renderer(forum_entity $forum)   X-Ref
No description

get_social_discussion_list_renderer(forum_entity $forum)   X-Ref
Create a discussion list renderer for the social course format.

param: forum_entity $forum The forum that the discussions belong to
return: discussion_list_renderer

get_frontpage_news_discussion_list_renderer(forum_entity $forum)   X-Ref
Create a discussion list renderer for the social course format.

param: forum_entity $forum The forum that the discussions belong to
return: discussion_list_renderer

get_single_discussion_list_renderer(forum_entity $forum,discussion_entity $discussion,bool $hasmultiplediscussions,int $displaymode)   X-Ref
Create a single type discussion list renderer.

param: forum_entity $forum Forum the discussion belongs to
param: discussion_entity $discussion The discussion entity
param: bool $hasmultiplediscussions Whether the forum has multiple discussions (more than one)
param: int $displaymode How should the posts be formatted?
return: discussion_renderer