diff --git a/core/modules/layout/layout.info b/core/modules/layout/layout.info new file mode 100644 index 0000000..187bfea --- /dev/null +++ b/core/modules/layout/layout.info @@ -0,0 +1,5 @@ +name = Layout +description = Makes it possible to swap different page layouts. +package = Core +version = VERSION +core = 8.x diff --git a/core/modules/layout/layout.module b/core/modules/layout/layout.module new file mode 100644 index 0000000..7d82798 --- /dev/null +++ b/core/modules/layout/layout.module @@ -0,0 +1,33 @@ +get('plugin.manager.layout'); +} + +/** + * Implements hook_theme(). + * + * Expose all layouts as theme items, so themes can override layout markup. + */ +function layout_theme($existing, $type, $theme, $path) { + $items = array(); + foreach (layout_manager()->getDefinitions() as $name => $layout) { + $items[$layout['theme']] = array( + 'variables' => array('content' => NULL), + 'path' => $layout['path'], + 'template' => $layout['template'], + ); + } + return $items; +} diff --git a/core/modules/layout/layouts/static/onecol/onecol.tpl.php b/core/modules/layout/layouts/static/onecol/onecol.tpl.php new file mode 100644 index 0000000..74f5c30 --- /dev/null +++ b/core/modules/layout/layouts/static/onecol/onecol.tpl.php @@ -0,0 +1,18 @@ + +
+
+
+
+
diff --git a/core/modules/layout/layouts/static/onecol/onecol.yml b/core/modules/layout/layouts/static/onecol/onecol.yml new file mode 100644 index 0000000..d401573 --- /dev/null +++ b/core/modules/layout/layouts/static/onecol/onecol.yml @@ -0,0 +1,5 @@ +title: Single column +category: Columns: 1 +template: onecol +regions: + middle: 'Middle column' diff --git a/core/modules/layout/layouts/static/twocol/twocol.css b/core/modules/layout/layouts/static/twocol/twocol.css new file mode 100644 index 0000000..9654752 --- /dev/null +++ b/core/modules/layout/layouts/static/twocol/twocol.css @@ -0,0 +1,17 @@ +.layout-twocol .layout-col-left { + float: left; + width: 50%; +} + +.layout-twocol .layout-col-left .inside { + margin-right: .5em; +} + +.layout-twocol .layout-col-right { + float: right; + width: 50%; +} + +.layout-twocol .layout-col-right .inside { + margin-left: .5em; +} diff --git a/core/modules/layout/layouts/static/twocol/twocol.tpl.php b/core/modules/layout/layouts/static/twocol/twocol.tpl.php new file mode 100644 index 0000000..158426a --- /dev/null +++ b/core/modules/layout/layouts/static/twocol/twocol.tpl.php @@ -0,0 +1,24 @@ + +
+
+
+
+ +
+
+
+
diff --git a/core/modules/layout/layouts/static/twocol/twocol.yml b/core/modules/layout/layouts/static/twocol/twocol.yml new file mode 100644 index 0000000..6362669 --- /dev/null +++ b/core/modules/layout/layouts/static/twocol/twocol.yml @@ -0,0 +1,7 @@ +title: Two column +category: Columns: 2 +template: twocol +css: twocol.css +regions: + left: 'Left side' + right: 'Right side' diff --git a/core/modules/layout/lib/Drupal/layout/LayoutBundle.php b/core/modules/layout/lib/Drupal/layout/LayoutBundle.php new file mode 100644 index 0000000..59b8513 --- /dev/null +++ b/core/modules/layout/lib/Drupal/layout/LayoutBundle.php @@ -0,0 +1,25 @@ +register('plugin.manager.layout', 'Drupal\layout\Plugin\Type\LayoutManager'); + } +} diff --git a/core/modules/layout/lib/Drupal/layout/Plugin/Derivative/Layout.php b/core/modules/layout/lib/Drupal/layout/Plugin/Derivative/Layout.php new file mode 100644 index 0000000..c585295 --- /dev/null +++ b/core/modules/layout/lib/Drupal/layout/Plugin/Derivative/Layout.php @@ -0,0 +1,117 @@ +derivatives) && !empty($this->derivatives[$derivative_id])) { + return $this->derivatives[$derivative_id]; + } + $this->getDerivativeDefinitions($base_plugin_definition); + return $this->derivatives[$derivative_id]; + } + + /** + * Implements DerivativeInterface::getDerivativeDefinitions(). + */ + public function getDerivativeDefinitions(array $base_plugin_definition) { + $available_layout_providers = array(); + + // Add all modules as possible layout providers. + foreach (module_list() as $module) { + $available_layout_providers[$module] = array( + 'type' => 'module', + 'provider' => $module, + 'dir' => drupal_get_path('module', $module), + ); + } + + // Add all themes as possible layout providers. + foreach (list_themes() as $theme_id => $theme) { + $available_layout_providers[$theme_id] = array( + 'type' => 'theme', + 'provider' => $theme->name, + 'dir' => drupal_get_path('theme', $theme->name), + ); + } + + foreach ($available_layout_providers as $provider) { + // Looks for layouts in the 'layout' directory under the module/theme. + // There could be subdirectories under there with one layout defined + // in each. + $dir = $provider['dir'] . DIRECTORY_SEPARATOR . 'layouts' . DIRECTORY_SEPARATOR . $this->type; + if (file_exists($dir)) { + $this->iterateDirectories($dir, $provider); + } + } + return $this->derivatives; + } + + /** + * Finds layout definitions by looking for layout metadata. + */ + protected function iterateDirectories($dir, $provider) { + $directories = new DirectoryIterator($dir); + foreach ($directories as $fileinfo) { + if ($fileinfo->isDir() && !$fileinfo->isDot()) { + // Keep discovering in subdirectories to arbitrary depth. + $this->iterateDirectories($fileinfo->getPathname(), $provider); + } + elseif ($fileinfo->isFile() && pathinfo($fileinfo->getFilename(), PATHINFO_EXTENSION) == 'yml') { + // Declarative layout definitions are defined with a .yml file in a + // layout subdirectory. This provides all information about the layout + // such as layout markup template and CSS and JavaScript files to use. + $directory = new FileStorage($fileinfo->getPath()); + $key = $provider['provider'] . '__' . $fileinfo->getBasename('.yml'); + $this->derivatives[$key] = $directory->read($fileinfo->getBasename('.yml')); + $this->derivatives[$key]['theme'] = $key; + $this->derivatives[$key]['path'] = $fileinfo->getPath(); + // If the layout author didn't specify a template name, assume the same + // name as the yml file. + if (!isset($this->derivatives[$key]['template'])) { + $this->derivatives[$key]['template'] = $fileinfo->getBasename('.yml'); + } + } + } + } +} diff --git a/core/modules/layout/lib/Drupal/layout/Plugin/LayoutInterface.php b/core/modules/layout/lib/Drupal/layout/Plugin/LayoutInterface.php new file mode 100644 index 0000000..5b874f6 --- /dev/null +++ b/core/modules/layout/lib/Drupal/layout/Plugin/LayoutInterface.php @@ -0,0 +1,30 @@ + 'Drupal\layout\Plugin\layout\layout\StaticLayout', + ); + + /** + * Overrides Drupal\Component\Plugin\PluginManagerBase::__construct(). + */ + public function __construct() { + // Create layout plugin derivatives from declaratively defined layouts. + $this->discovery = new DerivativeDiscoveryDecorator(new AnnotatedClassDiscovery('layout', 'layout')); + $this->factory = new ReflectionFactory($this); + } +} diff --git a/core/modules/layout/lib/Drupal/layout/Plugin/layout/layout/StaticLayout.php b/core/modules/layout/lib/Drupal/layout/Plugin/layout/layout/StaticLayout.php new file mode 100644 index 0000000..581d38b --- /dev/null +++ b/core/modules/layout/lib/Drupal/layout/Plugin/layout/layout/StaticLayout.php @@ -0,0 +1,147 @@ +getDefinition($plugin_id); + foreach ($definition['regions'] as $region => $title) { + if (!isset($configuration['regions'][$region])) { + $configuration['regions'][$region] = array(); + } + } + parent::__construct($configuration, $plugin_id, $discovery); + } + + /** + * Implements Drupal\layout\Plugin\LayoutInterface::getRegions(). + */ + public function getRegions() { + $definition = $this->getDefinition(); + return $definition['regions']; + } + + /** + * Add the CSS files associated with this layout to the page. + */ + public function getCssFiles() { + $definition = $this->getDefinition(); + $files = $definition['css']; + if (is_string($files)) { + $files = array($files); + } + return $files; + } + + /** + * Add the administrative CSS files associated with this layout to the page. + */ + public function getAdminCssFiles() { + $definition = $this->getDefinition(); + // Fall back on regular CSS for the admin page if admin CSS not provided. + $files = isset($definition['admin css']) ? $definition['admin css'] : $definition['css']; + if (is_string($files)) { + $files = array($files); + } + return $files; + } + + /** + * Add the JS files associated with this layout to the page. + */ + public function getJsFiles() { + $definition = $this->getDefinition(); + if (isset($definition['js'])) { + $files = $definition['js']; + if (is_string($files)) { + $files = array($files); + } + return $files; + } + return array(); + } + + /** + * Add the admin JS files associated with this layout to the page. + */ + public function getAdminJsFiles() { + $definition = $this->getDefinition(); + $files = array(); + if (isset($definition['admin js'])) { + $files = $definition['admin js']; + } + elseif (isset($definition['js'])) { + // Fall back on regular JS for the admin page if admin JS not provided. + $files = $definition['js']; + } + if (is_string($files)) { + $files = array($files); + } + return $files; + } + + /** + * Implements Drupal\layout\Plugin\LayoutInterface::renderLayout(). + */ + public function renderLayout($admin = FALSE) { + $definition = $this->getDefinition(); + + // Assemble a render array with the regions and attached CSS/JS. + $render = array( + '#theme' => $definition['theme'], + '#content' => array(), + ); + + // Render all regions needed for this layout. + foreach ($this->getRegions() as $region => $title) { + // @todo This is just stub code to fill in regions with stuff for now. + // When blocks are related to layouts and not themes, we can make this + // really be filled in with blocks. + $render['#content'][$region] = '

' . $title . '

'; + } + + // Fill in attached CSS and JS files based on metadata. + if (!$admin) { + $render['#attached'] = array( + 'css' => $this->getCssFiles(), + 'js' => $this->getJsFiles(), + ); + } + else { + $render['#attached'] = array( + 'css' => $this->getAdminCssFiles(), + 'js' => $this->getAdminJsFiles(), + ); + } + + // Include the path of the definition in all CSS and JS files. + foreach (array('css', 'js') as $type) { + foreach ($render['#attached'][$type] as &$filename) { + $filename = $definition['path'] . '/' . $filename; + } + } + + return drupal_render($render); + } +} diff --git a/core/modules/layout/lib/Drupal/layout/Tests/LayoutDerivativesTest.php b/core/modules/layout/lib/Drupal/layout/Tests/LayoutDerivativesTest.php new file mode 100644 index 0000000..1068373 --- /dev/null +++ b/core/modules/layout/lib/Drupal/layout/Tests/LayoutDerivativesTest.php @@ -0,0 +1,94 @@ + 'Layout derivatives', + 'description' => 'Tests layout derivatives discovery.', + 'group' => 'Layout', + ); + } + + /** + * Tests for module/theme layout derivatives. + */ + function testDerivatives() { + $manager = drupal_container()->get('plugin.manager.layout'); + + $definitions = $manager->getDefinitions(); + $this->assertTrue(is_array($definitions), 'Definitions found.'); + $this->assertTrue(count($definitions) == 3, 'Three definitions available.'); + $this->assertTrue(isset($definitions['static_layout:layout__onecol']), 'One column layout found.'); + $this->assertTrue(isset($definitions['static_layout:layout__twocol']), 'Two column layout found.'); + $this->assertTrue(isset($definitions['static_layout:layout_test_theme__page']), 'Test theme page layout found.'); + + // Get a two column layout instance. This is defined under the layout + // module. + $layout = $manager->createInstance('static_layout:layout__twocol', array()); + // Verify the expected regions are properly available. + $regions = $layout->getRegions(); + $this->assertTrue(is_array($regions), 'Regions array present.'); + $this->assertTrue(count($regions) == 2, 'Two regions defined.'); + $this->assertTrue(isset($regions['left']), 'Left region found.'); + $this->assertTrue(isset($regions['right']), 'Right region found.'); + + // Render the layout and look at whether expected region names and classes + // were in the output. + $render = $layout->renderLayout(); + $this->drupalSetContent($render); + $this->assertText('Left side'); + $this->assertText('Right side'); + $this->assertRaw('class="layout-display layout-twocol'); + + // Get the page layout defined by the layout test theme. + $layout = $manager->createInstance('static_layout:layout_test_theme__page', array()); + // Verify the expected regions are properly available. + $regions = $layout->getRegions(); + $this->assertTrue(is_array($regions), 'Regions array present.'); + $this->assertTrue(count($regions) == 15, '15 regions defined.'); + $this->assertTrue(isset($regions['footer']), 'Footer region found.'); + $this->assertTrue(isset($regions['triptych_middle']), 'Triptych middle region found.'); + + // Render the layout and look at whether expected region names and classes + // were in the output. + $render = $layout->renderLayout(); + $this->drupalSetContent($render); + $this->assertText('Triptych middle'); + $this->assertText('Footer'); + $this->assertRaw('id="triptych-wrapper"'); + } + + /** + * Test layout functionality as applies to pages. + */ + function testPageLayout() { + // The layout-test page uses the layout_test_theme page layout. + $this->drupalGet('layout-test'); + $this->assertText('Triptych middle'); + $this->assertText('Footer'); + $this->assertRaw('id="triptych-wrapper"'); + + // Ensure the CSS was added. + $this->assertRaw('@import url("' . url('', array('absolute' => TRUE)) . drupal_get_path('theme', 'layout_test_theme') . '/layouts/static/page/page.css'); + } +} diff --git a/core/modules/layout/tests/layout_test.info b/core/modules/layout/tests/layout_test.info new file mode 100644 index 0000000..7b054a9 --- /dev/null +++ b/core/modules/layout/tests/layout_test.info @@ -0,0 +1,6 @@ +name = Layout test +description = Helps with testing layouts. +package = Testing +version = VERSION +core = 8.x +hidden = TRUE diff --git a/core/modules/layout/tests/layout_test.module b/core/modules/layout/tests/layout_test.module new file mode 100644 index 0000000..9dce5b9 --- /dev/null +++ b/core/modules/layout/tests/layout_test.module @@ -0,0 +1,39 @@ + 'Layout test', + 'page callback' => 'layout_test_page', + 'access callback' => TRUE, + ); + return $items; +} + +/** + * Page callback for layout testing. + */ +function layout_test_page() { + // Hack to enable and apply the theme to this page and manually invoke its + // layout plugin and render it. + global $theme; + $theme = 'layout_test_theme'; + theme_enable(array($theme)); + $layout = layout_manager()->createInstance('static_layout:layout_test_theme__page'); + return $layout->renderLayout(); +} + +/** + * Implements hook_system_theme_info(). + */ +function layout_test_system_theme_info() { + $themes['layout_test_theme'] = drupal_get_path('module', 'layout_test') . '/themes/layout_test_theme/layout_test_theme.info'; + return $themes; +} diff --git a/core/modules/layout/tests/themes/layout_test_theme/layout_test_theme.info b/core/modules/layout/tests/themes/layout_test_theme/layout_test_theme.info new file mode 100644 index 0000000..84bcff0 --- /dev/null +++ b/core/modules/layout/tests/themes/layout_test_theme/layout_test_theme.info @@ -0,0 +1,4 @@ +name = Layout test theme +description = Theme for testing the layout system +core = 8.x +hidden = TRUE diff --git a/core/modules/layout/tests/themes/layout_test_theme/layouts/static/page/page.css b/core/modules/layout/tests/themes/layout_test_theme/layouts/static/page/page.css new file mode 100644 index 0000000..a624d66 --- /dev/null +++ b/core/modules/layout/tests/themes/layout_test_theme/layouts/static/page/page.css @@ -0,0 +1 @@ +/* Page CSS */ diff --git a/core/modules/layout/tests/themes/layout_test_theme/layouts/static/page/page.yml b/core/modules/layout/tests/themes/layout_test_theme/layouts/static/page/page.yml new file mode 100644 index 0000000..68bb478 --- /dev/null +++ b/core/modules/layout/tests/themes/layout_test_theme/layouts/static/page/page.yml @@ -0,0 +1,20 @@ +title: Layout test page +category: Other +template: test-layout +css: page.css +regions: + header: 'Header' + help: 'Help' + highlighted: 'Highlighted' + featured: 'Featured' + content: 'Content' + sidebar_first: 'Sidebar first' + sidebar_second: 'Sidebar second' + triptych_first: 'Triptych first' + triptych_middle: 'Triptych middle' + triptych_last: 'Triptych last' + footer_firstcolumn: 'Footer first column' + footer_secondcolumn: 'Footer second column' + footer_thirdcolumn: 'Footer third column' + footer_fourthcolumn: 'Footer fourth column' + footer: 'Footer' diff --git a/core/modules/layout/tests/themes/layout_test_theme/layouts/static/page/test-layout.tpl.php b/core/modules/layout/tests/themes/layout_test_theme/layouts/static/page/test-layout.tpl.php new file mode 100644 index 0000000..3a5db91 --- /dev/null +++ b/core/modules/layout/tests/themes/layout_test_theme/layouts/static/page/test-layout.tpl.php @@ -0,0 +1,62 @@ +
+ + + + + + + +
+ +
+
+ + +
+ + + + + + + + + +
+ + +
+ + + +
+ + + + +