MDL-41663 Renderers - allow autoloaded renderers
This commit is contained in:
Damyon Wiese
+126
-40
@@ -157,19 +157,28 @@ abstract class renderer_factory_base implements renderer_factory {
|
||||
}
|
||||
|
||||
/**
|
||||
* For a given module name, return the name of the standard renderer class
|
||||
* For a given module name, return the possible class names
|
||||
* that defines the renderer interface for that module.
|
||||
*
|
||||
* Newer auto-loaded class names are returned as well as the old style _renderable classnames.
|
||||
*
|
||||
* Also, if it exists, include the renderer.php file for that module, so
|
||||
* the class definition of the default renderer has been loaded.
|
||||
*
|
||||
* @param string $component name such as 'core', 'mod_forum' or 'qtype_multichoice'.
|
||||
* @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
|
||||
* @return string the name of the standard renderer class for that module.
|
||||
* @param string $subtype optional subtype such as 'news' resulting to:
|
||||
* '\mod_forum\output\news_renderer'
|
||||
* or non-autoloaded 'mod_forum_news'
|
||||
* @return array[] Each element of the array is an array with keys:
|
||||
* classname - The class name to search
|
||||
* autoloaded - Does this classname assume autoloading?
|
||||
* validwithprefix - Is this class name valid when a prefix is added to it?
|
||||
* validwithoutprefix - Is this class name valid when no prefix is added to it?
|
||||
* @throws coding_exception
|
||||
*/
|
||||
protected function standard_renderer_classname($component, $subtype = null) {
|
||||
protected function standard_renderer_classnames($component, $subtype = null) {
|
||||
global $CFG; // Needed in included files.
|
||||
$classnames = array();
|
||||
|
||||
// Standardize component name ala frankenstyle.
|
||||
list($plugin, $type) = core_component::normalize_component($component);
|
||||
@@ -203,11 +212,52 @@ abstract class renderer_factory_base implements renderer_factory {
|
||||
}
|
||||
|
||||
if (empty($subtype)) {
|
||||
$class = $component . '_renderer';
|
||||
// Theme specific auto-loaded name (only valid when prefixed with the theme name).
|
||||
$classnames[] = array(
|
||||
'validwithprefix' => true,
|
||||
'validwithoutprefix' => false,
|
||||
'autoloaded' => true,
|
||||
'classname' => '\\output\\' . $component . '_renderer'
|
||||
);
|
||||
|
||||
// Standard autoloaded plugin name (not valid with a prefix).
|
||||
$classnames[] = array(
|
||||
'validwithprefix' => false,
|
||||
'validwithoutprefix' => true,
|
||||
'autoloaded' => true,
|
||||
'classname' => '\\' . $component . '\\output\\renderer'
|
||||
);
|
||||
// Legacy class name - (valid with or without a prefix).
|
||||
$classnames[] = array(
|
||||
'validwithprefix' => true,
|
||||
'validwithoutprefix' => true,
|
||||
'autoloaded' => false,
|
||||
'classname' => $component . '_renderer'
|
||||
);
|
||||
} else {
|
||||
$class = $component . '_' . $subtype . '_renderer';
|
||||
// Theme specific auto-loaded name (only valid when prefixed with the theme name).
|
||||
$classnames[] = array(
|
||||
'validwithprefix' => true,
|
||||
'validwithoutprefix' => false,
|
||||
'autoloaded' => true,
|
||||
'classname' => '\\output\\' . $component . '\\' . $subtype . '_renderer'
|
||||
);
|
||||
// Standard autoloaded plugin name (not valid with a prefix).
|
||||
$classnames[] = array(
|
||||
'validwithprefix' => false,
|
||||
'validwithoutprefix' => true,
|
||||
'autoloaded' => true,
|
||||
'classname' => '\\' . $component . '\\output\\' . $subtype . '_renderer'
|
||||
);
|
||||
// Legacy class name - (valid with or without a prefix).
|
||||
$classnames[] = array(
|
||||
'validwithprefix' => true,
|
||||
'validwithoutprefix' => true,
|
||||
'autoloaded' => false,
|
||||
'classname' => $component . '_' . $subtype . '_renderer'
|
||||
);
|
||||
}
|
||||
return $class;
|
||||
return $classnames;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -234,16 +284,27 @@ class standard_renderer_factory extends renderer_factory_base {
|
||||
* @return renderer_base an object implementing the requested renderer interface.
|
||||
*/
|
||||
public function get_renderer(moodle_page $page, $component, $subtype = null, $target = null) {
|
||||
$classname = $this->standard_renderer_classname($component, $subtype);
|
||||
if (!class_exists($classname)) {
|
||||
throw new coding_exception('Request for an unknown renderer class ' . $classname);
|
||||
}
|
||||
$classnames = $this->standard_renderer_classnames($component, $subtype);
|
||||
$classname = '';
|
||||
|
||||
list($target, $suffix) = $this->get_target_suffix($target);
|
||||
if (class_exists($classname . $suffix)) {
|
||||
// use the specialised renderer for given target, default renderer might also decide
|
||||
// to implement support for more targets
|
||||
$classname = $classname . $suffix;
|
||||
foreach ($classnames as $classnamedetails) {
|
||||
if ($classnamedetails['validwithoutprefix']) {
|
||||
$newclassname = $classnamedetails['classname'] . $suffix;
|
||||
if (class_exists($newclassname)) {
|
||||
$classname = $newclassname;
|
||||
} else {
|
||||
$newclassname = $classnamedetails['classname'];
|
||||
if (class_exists($newclassname)) {
|
||||
$classname = $newclassname;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (!class_exists($classname)) {
|
||||
// Standard renderer must always exist.
|
||||
throw new coding_exception('Request for an unknown renderer class ' . $classname);
|
||||
}
|
||||
|
||||
return new $classname($page, $target);
|
||||
@@ -293,39 +354,64 @@ class theme_overridden_renderer_factory extends renderer_factory_base {
|
||||
* @return renderer_base an object implementing the requested renderer interface.
|
||||
*/
|
||||
public function get_renderer(moodle_page $page, $component, $subtype = null, $target = null) {
|
||||
$classname = $this->standard_renderer_classname($component, $subtype);
|
||||
if (!class_exists($classname)) {
|
||||
// standard renderer must always exist
|
||||
throw new coding_exception('Request for an unknown renderer class ' . $classname);
|
||||
}
|
||||
$classnames = $this->standard_renderer_classnames($component, $subtype);
|
||||
|
||||
list($target, $suffix) = $this->get_target_suffix($target);
|
||||
|
||||
// theme lib.php and renderers.php files are loaded automatically
|
||||
// when loading the theme configs
|
||||
// Theme lib.php and renderers.php files are loaded automatically
|
||||
// when loading the theme configs.
|
||||
|
||||
// first try the renderers with correct suffix
|
||||
// First try the renderers with correct suffix.
|
||||
foreach ($this->prefixes as $prefix) {
|
||||
if (class_exists($prefix . '_' . $classname . $suffix)) {
|
||||
$classname = $prefix . '_' . $classname . $suffix;
|
||||
return new $classname($page, $target);
|
||||
foreach ($classnames as $classnamedetails) {
|
||||
if ($classnamedetails['validwithprefix']) {
|
||||
if ($classnamedetails['autoloaded']) {
|
||||
$newclassname = $prefix . $classnamedetails['classname'] . $suffix;
|
||||
} else {
|
||||
$newclassname = $prefix . '_' . $classnamedetails['classname'] . $suffix;
|
||||
}
|
||||
if (class_exists($newclassname)) {
|
||||
return new $newclassname($page, $target);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
if (class_exists($classname . $suffix)) {
|
||||
// use the specialised renderer for given target, default renderer might also decide
|
||||
// to implement support for more targets
|
||||
$classname = $classname . $suffix;
|
||||
return new $classname($page, $target);
|
||||
}
|
||||
|
||||
// then try general renderer
|
||||
foreach ($this->prefixes as $prefix) {
|
||||
if (class_exists($prefix . '_' . $classname)) {
|
||||
$classname = $prefix . '_' . $classname;
|
||||
return new $classname($page, $target);
|
||||
foreach ($classnames as $classnamedetails) {
|
||||
if ($classnamedetails['validwithoutprefix']) {
|
||||
$newclassname = $classnamedetails['classname'] . $suffix;
|
||||
if (class_exists($newclassname)) {
|
||||
// Use the specialised renderer for given target, default renderer might also decide
|
||||
// to implement support for more targets.
|
||||
return new $newclassname($page, $target);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return new $classname($page, $target);
|
||||
// Then try general renderer.
|
||||
foreach ($this->prefixes as $prefix) {
|
||||
foreach ($classnames as $classnamedetails) {
|
||||
if ($classnamedetails['validwithprefix']) {
|
||||
if ($classnamedetails['autoloaded']) {
|
||||
$newclassname = $prefix . $classnamedetails['classname'];
|
||||
} else {
|
||||
$newclassname = $prefix . '_' . $classnamedetails['classname'];
|
||||
}
|
||||
if (class_exists($newclassname)) {
|
||||
return new $newclassname($page, $target);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Final attempt - no prefix or suffix.
|
||||
foreach ($classnames as $classnamedetails) {
|
||||
if ($classnamedetails['validwithoutprefix']) {
|
||||
$newclassname = $classnamedetails['classname'];
|
||||
if (class_exists($newclassname)) {
|
||||
return new $newclassname($page, $target);
|
||||
}
|
||||
}
|
||||
}
|
||||
throw new coding_exception('Request for an unknown renderer ' . $component . ', ' . $subtype . ', ' . $target);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+14
-2
@@ -96,7 +96,13 @@ class renderer_base {
|
||||
* @return string
|
||||
*/
|
||||
public function render(renderable $widget) {
|
||||
$rendermethod = 'render_'.get_class($widget);
|
||||
$classname = get_class($widget);
|
||||
// Strip namespaces.
|
||||
$classname = preg_replace('/^.*\\\/', '', $classname);
|
||||
// Remove _renderable suffixes
|
||||
$classname = preg_replace('/_renderable$/', '', $classname);
|
||||
|
||||
$rendermethod = 'render_'.$classname;
|
||||
if (method_exists($this, $rendermethod)) {
|
||||
return $this->$rendermethod($widget);
|
||||
}
|
||||
@@ -216,7 +222,13 @@ class plugin_renderer_base extends renderer_base {
|
||||
* @return string
|
||||
*/
|
||||
public function render(renderable $widget) {
|
||||
$rendermethod = 'render_'.get_class($widget);
|
||||
$classname = get_class($widget);
|
||||
// Strip namespaces.
|
||||
$classname = preg_replace('/^.*\\\/', '', $classname);
|
||||
// Remove _renderable suffixes
|
||||
$classname = preg_replace('/_renderable/', '', $classname);
|
||||
|
||||
$rendermethod = 'render_'.$classname;
|
||||
if (method_exists($this, $rendermethod)) {
|
||||
return $this->$rendermethod($widget);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user