annotate core/lib/Drupal/Core/Layout/LayoutInterface.php @ 17:129ea1e6d783

Update, including to Drupal core 8.6.10
author Chris Cannam
date Thu, 28 Feb 2019 13:21:36 +0000
parents 4c8ae668cc8c
children af1871eacc83
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\Core\Layout;
Chris@0 4
Chris@0 5 use Drupal\Component\Plugin\DerivativeInspectionInterface;
Chris@0 6 use Drupal\Component\Plugin\PluginInspectionInterface;
Chris@0 7 use Drupal\Component\Plugin\ConfigurablePluginInterface;
Chris@0 8
Chris@0 9 /**
Chris@0 10 * Provides an interface for static Layout plugins.
Chris@0 11 */
Chris@0 12 interface LayoutInterface extends PluginInspectionInterface, DerivativeInspectionInterface, ConfigurablePluginInterface {
Chris@0 13
Chris@0 14 /**
Chris@0 15 * Build a render array for layout with regions.
Chris@0 16 *
Chris@0 17 * @param array $regions
Chris@0 18 * An associative array keyed by region name, containing render arrays
Chris@0 19 * representing the content that should be placed in each region.
Chris@0 20 *
Chris@0 21 * @return array
Chris@0 22 * Render array for the layout with regions.
Chris@0 23 */
Chris@0 24 public function build(array $regions);
Chris@0 25
Chris@0 26 /**
Chris@0 27 * {@inheritdoc}
Chris@0 28 *
Chris@0 29 * @return \Drupal\Core\Layout\LayoutDefinition
Chris@0 30 */
Chris@0 31 public function getPluginDefinition();
Chris@0 32
Chris@0 33 }