tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

FIX Overriding of theme templates in project folder

Browse Source 
Fixes issue of templates not being found when a Page's main/Layout templates are split between the project and theme folders. Adds more expansive testing for template loading.
This commit is contained in:
Ryan Wachtl 2014-01-13 14:33:22 -06:00
parent 9b5a9afe2b
commit 5f87d344f1
4 changed files with 197 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
core/manifest/TemplateLoader.php
View File

@ -64,27 +64,26 @@ class SS_TemplateLoader {
public function findTemplates($templates, $theme = null) { public function findTemplates($templates, $theme = null) {
$result = array(); $result = array();
$project = project(); $project = project();
foreach ((array) $templates as $template) { foreach ((array) $templates as $template) {
$found = false; $found = false;
if (strpos($template, '/')) { if (strpos($template, '/')) {
list($type, $template) = explode('/', $template, 2); list($type, $template) = explode('/', $template, 2);
} else { } else {
$type = null; $type = null;
} }
if ($found = $this->getManifest()->getCandidateTemplate($template, $theme)) { if ($found = $this->getManifest()->getCandidateTemplate($template, $theme)) {
if ($type && isset($found[$type])) { if ($type && isset($found[$type])) {
$found = array( $found = array(
'main' => $found[$type] 'main' => $found[$type]
); );
} }
$result = array_merge($found, $result); $result = array_merge($found, $result);
} }
} }
return $result; return $result;
} }

22
core/manifest/TemplateManifest.php
View File

@ -110,17 +110,23 @@ class SS_TemplateManifest {
* @return array * @return array
*/ */
public function getCandidateTemplate($name, $theme = null) { public function getCandidateTemplate($name, $theme = null) {
$found = array();
$candidates = $this->getTemplate($name); $candidates = $this->getTemplate($name);
if ($this->project && isset($candidates[$this->project])) { // theme overrides modules
$found = $candidates[$this->project]; if ($theme && isset($candidates['themes'][$theme])) {
} else if ($theme && isset($candidates['themes'][$theme])) {
$found = array_merge($candidates, $candidates['themes'][$theme]); $found = array_merge($candidates, $candidates['themes'][$theme]);
} else {
$found = $candidates;
} }
if(isset($found['themes'])) unset($found['themes']); // project overrides theme
if ($this->project && isset($candidates[$this->project])) {
$found = array_merge($found, $candidates[$this->project]);
}
$found = ($found) ? $found : $candidates;
if (isset($found['themes'])) unset($found['themes']);
if (isset($found[$this->project])) unset($found[$this->project]);
return $found; return $found;
} }

232
tests/core/manifest/TemplateLoaderTest.php
View File

@ -6,64 +6,184 @@
* @subpackage tests * @subpackage tests
*/ */
class TemplateLoaderTest extends SapphireTest { class TemplateLoaderTest extends SapphireTest {
public function testFindTemplates() { private $base;
$base = dirname(__FILE__) . '/fixtures/templatemanifest'; private $manifest;
$manifest = new SS_TemplateManifest($base, 'myproject', false, true); private $loader;
$loader = new SS_TemplateLoader();
/**
$manifest->regenerate(false); * Set up manifest before each test
$loader->pushManifest($manifest); */
public function setUp() {
$expectPage = array( parent::setUp();
'main' => "$base/module/templates/Page.ss", $this->base = dirname(__FILE__) . '/fixtures/templatemanifest';
'Layout' => "$base/module/templates/Layout/Page.ss" $this->manifest = new SS_TemplateManifest($this->base, 'myproject', false, true);
); $this->loader = new SS_TemplateLoader();
$expectPageThemed = array( $this->refreshLoader();
'main' => "$base/themes/theme/templates/Page.ss",
'Layout' => "$base/themes/theme/templates/Layout/Page.ss"
);
$this->assertEquals($expectPage, $loader->findTemplates('Page'));
$this->assertEquals($expectPage, $loader->findTemplates(array('Foo', 'Page')));
$this->assertEquals($expectPage, $loader->findTemplates('PAGE'));
$this->assertEquals($expectPageThemed, $loader->findTemplates('Page', 'theme'));
$expectPageLayout = array('main' => "$base/module/templates/Layout/Page.ss");
$expectPageLayoutThemed = array('main' => "$base/themes/theme/templates/Layout/Page.ss");
$this->assertEquals($expectPageLayout, $loader->findTemplates('Layout/Page'));
$this->assertEquals($expectPageLayout, $loader->findTemplates('Layout/PAGE'));
$this->assertEquals($expectPageLayoutThemed, $loader->findTemplates('Layout/Page', 'theme'));
$expectCustomPage = array(
'main' => "$base/module/templates/Page.ss",
'Layout' => "$base/module/templates/Layout/CustomPage.ss"
);
$this->assertEquals($expectCustomPage, $loader->findTemplates(array('CustomPage', 'Page')));
// 'main' template only exists in theme, and 'Layout' template only exists in module
$expectCustomThemePage = array(
'main' => "$base/themes/theme/templates/CustomThemePage.ss",
'Layout' => "$base/module/templates/Layout/CustomThemePage.ss"
);
$this->assertEquals($expectCustomThemePage, $loader->findTemplates(array('CustomThemePage', 'Page'), 'theme'));
} }
public function testFindTemplatesApplicationOverridesModule() { /**
$base = dirname(__FILE__) . '/fixtures/templatemanifest'; * Test that 'main' and 'Layout' templates are loaded from module
$manifest = new SS_TemplateManifest($base, 'myproject', false, true); */
$loader = new SS_TemplateLoader(); public function testFindTemplatesInModule() {
$expect = array(
$manifest->regenerate(false); 'main' => "$this->base/module/templates/Page.ss",
$loader->pushManifest($manifest); 'Layout' => "$this->base/module/templates/Layout/Page.ss"
$expectPage = array(
'main' => "$base/myproject/templates/CustomTemplate.ss"
); );
$this->assertEquals($expect, $this->loader->findTemplates('Page'));
$this->assertEquals($expectPage, $loader->findTemplates('CustomTemplate')); $this->assertEquals($expect, $this->loader->findTemplates('PAGE'));
$this->assertEquals($expect, $this->loader->findTemplates(array('Foo', 'Page')));
}
/**
* Test that 'main' and 'Layout' templates are loaded from set theme
*/
public function testFindTemplatesInTheme() {
$expect = array(
'main' => "$this->base/themes/theme/templates/Page.ss",
'Layout' => "$this->base/themes/theme/templates/Layout/Page.ss"
);
$this->assertEquals($expect, $this->loader->findTemplates('Page', 'theme'));
$this->assertEquals($expect, $this->loader->findTemplates('PAGE', 'theme'));
$this->assertEquals($expect, $this->loader->findTemplates(array('Foo', 'Page'), 'theme'));
}
/**
* Test that 'main' and 'Layout' templates are loaded from project without a set theme
*/
public function testFindTemplatesInApplication() {
$templates = array(
$this->base . '/myproject/templates/Page.ss',
$this->base . '/myproject/templates/Layout/Page.ss'
);
$this->createTestTemplates($templates);
$this->refreshLoader();
$expect = array(
'main' => "$this->base/myproject/templates/Page.ss",
'Layout' => "$this->base/myproject/templates/Layout/Page.ss"
);
$this->assertEquals($expect, $this->loader->findTemplates('Page'));
$this->assertEquals($expect, $this->loader->findTemplates('PAGE'));
$this->assertEquals($expect, $this->loader->findTemplates(array('Foo', 'Page')));
$this->removeTestTemplates($templates);
}
/**
* Test that 'Layout' template is loaded from module
*/
public function testFindTemplatesInModuleLayout() {
$expect = array(
'main' => "$this->base/module/templates/Layout/Page.ss"
);
$this->assertEquals($expect, $this->loader->findTemplates('Layout/Page'));
}
/**
* Test that 'Layout' template is loaded from theme
*/
public function testFindTemplatesInThemeLayout() {
$expect = array(
'main' => "$this->base/themes/theme/templates/Layout/Page.ss"
);
$this->assertEquals($expect, $this->loader->findTemplates('Layout/Page', 'theme'));
}
/**
* Test that 'main' template is found in theme and 'Layout' is found in module
*/
public function testFindTemplatesMainThemeLayoutModule() {
$expect = array(
'main' => "$this->base/themes/theme/templates/CustomThemePage.ss",
'Layout' => "$this->base/module/templates/Layout/CustomThemePage.ss"
);
$this->assertEquals($expect, $this->loader->findTemplates(array('CustomThemePage', 'Page'), 'theme'));
}
/**
* Test that project template overrides module template of same name
*/
public function testFindTemplatesApplicationOverridesModule() {
$expect = array(
'main' => "$this->base/myproject/templates/CustomTemplate.ss"
);
$this->assertEquals($expect, $this->loader->findTemplates('CustomTemplate'));
}
/**
* Test that project templates overrides theme templates
*/
public function testFindTemplatesApplicationOverridesTheme() {
$templates = array(
$this->base . '/myproject/templates/Page.ss',
$this->base . '/myproject/templates/Layout/Page.ss'
);
$this->createTestTemplates($templates);
$this->refreshLoader();
$expect = array(
'main' => "$this->base/myproject/templates/Page.ss",
'Layout' => "$this->base/myproject/templates/Layout/Page.ss"
);
$this->assertEquals($expect, $this->loader->findTemplates('Page'), 'theme');
$this->removeTestTemplates($templates);
}
/**
* Test that project 'Layout' template overrides theme 'Layout' template
*/
public function testFindTemplatesApplicationLayoutOverridesThemeLayout() {
$templates = array(
$this->base . '/myproject/templates/Layout/Page.ss'
);
$this->createTestTemplates($templates);
$this->refreshLoader();
$expect = array(
'main' => "$this->base/themes/theme/templates/Page.ss",
'Layout' => "$this->base/myproject/templates/Layout/Page.ss"
);
$this->assertEquals($expect, $this->loader->findTemplates('Page', 'theme'));
$this->removeTestTemplates($templates);
}
/**
* Test that project 'main' template overrides theme 'main' template
*/
public function testFindTemplatesApplicationMainOverridesThemeMain() {
$templates = array(
$this->base . '/myproject/templates/Page.ss'
);
$this->createTestTemplates($templates);
$this->refreshLoader();
$expect = array(
'main' => "$this->base/myproject/templates/Page.ss",
'Layout' => "$this->base/themes/theme/templates/Layout/Page.ss"
);
$this->assertEquals($expect, $this->loader->findTemplates('Page', 'theme'));
$this->removeTestTemplates($templates);
}
protected function refreshLoader() {
$this->manifest->regenerate(false);
$this->loader->pushManifest($this->manifest);
}
protected function createTestTemplates($templates) {
foreach ($templates as $template) {
file_put_contents($template, '');
}
}
protected function removeTestTemplates($templates) {
foreach ($templates as $template) {
unlink($template);
}
} }
} }

0
tests/core/manifest/fixtures/templatemanifest/myproject/templates/Layout/.gitignore vendored Normal file
View File