Merge pull request simplesamlphp#1174 from ghalse/enhancement/twig-theme-parent

jaimeperez · web-flow · commit caa16d3b0807 · 2019-08-06T16:36:15.000+02:00
Allow themes to inherit module templates
diff --git a/docs/simplesamlphp-theming.md b/docs/simplesamlphp-theming.md
@@ -131,6 +131,8 @@ If you need to make more extensive customizations to the base template, you shou
 
 Any references to `$this->data['baseurlpath']` in old-style templates can be replaced with `{{baseurlpath}}` in Twig templates. Likewise, references to `\SimpleSAML\Module::getModuleURL()` can be replaced with `{{baseurlpath}}module.php/mymodule/...`
 
+Within templates each module is defined as a separate namespace matching the module name. This allows one template to reference templates from other modules using Twig's `@namespace_name/template_path` notation. For instance, a template in `mymodule` can include the widget template from the `yourmodule` module using the notation `@yourmodule/widget.twig`. A special namespace, `__parent__`, exists to allow theme developers to more easily extend a module's stock template.
+
 Even more advanced changes can be made by defining a theme controller in `config.php`:
 
     'theme.controller' => '\SimpleSAML\Module\mymodule\FancyThemeController',
diff --git a/lib/SimpleSAML/XHTML/Template.php b/lib/SimpleSAML/XHTML/Template.php
@@ -244,6 +244,7 @@ private function setupTwigTemplatepaths()
                 $templateDirs[] = [
                     $this->theme['module'] => TemplateLoader::getModuleTemplateDir($this->theme['module'])
                 ];
+                $templateDirs[] = ['__parent__' => TemplateLoader::getModuleTemplateDir($this->module)];
             } catch (\InvalidArgumentException $e) {
                 // either the module is not enabled or it has no "templates" directory, ignore
             }
@@ -524,7 +525,7 @@ public function send()
     public function show()
     {
         if ($this->useNewUI) {
-            echo $this->getContents();            
+            echo $this->getContents();
         } else {
             require($this->findTemplatePath($this->template));
         }

Original file line number	Diff line number	Diff line change
`@@ -244,6 +244,7 @@ private function setupTwigTemplatepaths()`
`244`	`244`	`$templateDirs[] = [`
`245`	`245`	`$this->theme['module'] => TemplateLoader::getModuleTemplateDir($this->theme['module'])`
`246`	`246`	`];`
	`247`	`+ $templateDirs[] = ['__parent__' => TemplateLoader::getModuleTemplateDir($this->module)];`
`247`	`248`	`} catch (\InvalidArgumentException $e) {`
`248`	`249`	`// either the module is not enabled or it has no "templates" directory, ignore`
`249`	`250`	`}`
`@@ -524,7 +525,7 @@ public function send()`
`524`	`525`	`public function show()`
`525`	`526`	`{`
`526`	`527`	`if ($this->useNewUI) {`
`527`		`- echo $this->getContents();`
	`528`	`+ echo $this->getContents();`
`528`	`529`	`} else {`
`529`	`530`	`require($this->findTemplatePath($this->template));`
`530`	`531`	`}`