From a8f02a346243f56417c7cc08ecb3bfd92d881f7d Mon Sep 17 00:00:00 2001
From: Dan Poltawski <dan@moodle.com>
Date: Thu, 3 May 2012 19:04:46 +0800
Subject: [PATCH] MDL-32508 course_formats: change format_renderer_base to
 format_section_renderer_base

Make it clear that this isn't a golden supported API
---
 course/format/renderer.php        | 6 ++++--
 course/format/topics/renderer.php | 2 +-
 course/format/weeks/renderer.php  | 2 +-
 3 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/course/format/renderer.php b/course/format/renderer.php
index bcbe2e08af8..f9570780ecd 100644
--- a/course/format/renderer.php
+++ b/course/format/renderer.php
@@ -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
diff --git a/course/format/topics/renderer.php b/course/format/topics/renderer.php
index 524ede7a7f9..c500bae15d9 100644
--- a/course/format/topics/renderer.php
+++ b/course/format/topics/renderer.php
@@ -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
diff --git a/course/format/weeks/renderer.php b/course/format/weeks/renderer.php
index 05836906f27..6459249a6f8 100644
--- a/course/format/weeks/renderer.php
+++ b/course/format/weeks/renderer.php
@@ -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.