annotate core/lib/Drupal/Core/Layout/LayoutInterface.php @ 19:fa3358dc1485 tip

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