MDL-32508 course_formats: change format_renderer_base to format_section_renderer_base

Make it clear that this isn't a golden supported API
This commit is contained in:
Dan Poltawski
2012-05-04 10:53:05 +08:00
parent 2db66a9319
commit a8f02a3462
3 changed files with 6 additions and 4 deletions
+4 -2
View 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
+1 -1
View 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
+1 -1
View 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.