MDL-32508 course_formats: change format_renderer_base to format_section_renderer_base
authorDan Poltawski <dan@moodle.com>
Thu, 3 May 2012 11:04:46 +0000 (19:04 +0800)
committerDan Poltawski <dan@moodle.com>
Fri, 4 May 2012 02:53:05 +0000 (10:53 +0800)
Make it clear that this isn't a golden supported API

course/format/renderer.php
course/format/topics/renderer.php
course/format/weeks/renderer.php

index bcbe2e0..f957078 100644 (file)
@@ -27,14 +27,16 @@ defined('MOODLE_INTERNAL') || die();
 
 
 /**
- * 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
index 524ede7..c500bae 100644 (file)
@@ -33,7 +33,7 @@ require_once($CFG->dirroot.'/course/format/renderer.php');
  * @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
index 0583690..6459249 100644 (file)
@@ -34,7 +34,7 @@ require_once($CFG->dirroot.'/course/format/renderer.php');
  * @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.