MDL-32508 course_formats: change format_renderer_base to format_secti…

…on_renderer_base Make it clear that this isn't a golden supported API
Jaswinder00 · May 4, 2012 · a8f02a3 · a8f02a3
1 parent 2db66a9
commit a8f02a3
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git a/course/format/renderer.php b/course/format/renderer.php
@@ -27,14 +27,16 @@
 
 
 /**
- * This renderer is used by section based formats
+ * This is a convenience renderer which can be used by section based formats
+ * to reduce code duplication. It is not necessary for all course formats to 
+ * use this and its likely to change in future releases.
  *
  * @package core
  * @copyright 2012 Dan Poltawski
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @since Moodle 2.3
  */
-abstract class format_renderer_base extends plugin_renderer_base {
+abstract class format_section_renderer_base extends plugin_renderer_base {
 
     /**
      * Generate the starting container html for a list of sections

diff --git a/course/format/topics/renderer.php b/course/format/topics/renderer.php
@@ -33,7 +33,7 @@
  * @copyright 2012 Dan Poltawski
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class format_topics_renderer extends format_renderer_base {
+class format_topics_renderer extends format_section_renderer_base {
 
     /**
      * Generate the starting container html for a list of sections

diff --git a/course/format/weeks/renderer.php b/course/format/weeks/renderer.php
@@ -34,7 +34,7 @@
  * @copyright 2012 Dan Poltawski
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class format_weeks_renderer extends format_renderer_base {
+class format_weeks_renderer extends format_section_renderer_base {
     /**
      * Generate the starting container html for a list of sections
      * @return string HTML to output.