annotate core/modules/field_layout/src/Display/EntityDisplayWithLayoutInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\field_layout\Display;
Chris@0 4
Chris@0 5 use Drupal\Core\Entity\Display\EntityDisplayInterface;
Chris@0 6 use Drupal\Core\Layout\LayoutInterface;
Chris@0 7
Chris@0 8 /**
Chris@0 9 * Provides a common interface for entity displays that have layout.
Chris@0 10 */
Chris@0 11 interface EntityDisplayWithLayoutInterface extends EntityDisplayInterface {
Chris@0 12
Chris@0 13 /**
Chris@0 14 * Gets the default region.
Chris@0 15 *
Chris@0 16 * @return string
Chris@0 17 * The default region for this display.
Chris@0 18 */
Chris@0 19 public function getDefaultRegion();
Chris@0 20
Chris@0 21 /**
Chris@0 22 * Gets the layout plugin ID for this display.
Chris@0 23 *
Chris@0 24 * @return string
Chris@0 25 * The layout plugin ID.
Chris@0 26 */
Chris@0 27 public function getLayoutId();
Chris@0 28
Chris@0 29 /**
Chris@0 30 * Gets the layout plugin settings for this display.
Chris@0 31 *
Chris@0 32 * @return mixed[]
Chris@0 33 * The layout plugin settings.
Chris@0 34 */
Chris@0 35 public function getLayoutSettings();
Chris@0 36
Chris@0 37 /**
Chris@0 38 * Sets the layout plugin ID for this display.
Chris@0 39 *
Chris@0 40 * @param string|null $layout_id
Chris@0 41 * Either a valid layout plugin ID, or NULL to remove the layout setting.
Chris@0 42 * @param array $layout_settings
Chris@0 43 * (optional) An array of settings for this layout.
Chris@0 44 *
Chris@0 45 * @return $this
Chris@0 46 */
Chris@0 47 public function setLayoutId($layout_id, array $layout_settings = []);
Chris@0 48
Chris@0 49 /**
Chris@0 50 * Sets the layout plugin for this display.
Chris@0 51 *
Chris@0 52 * @param \Drupal\Core\Layout\LayoutInterface $layout
Chris@0 53 * A layout plugin.
Chris@0 54 *
Chris@0 55 * @return $this
Chris@0 56 */
Chris@0 57 public function setLayout(LayoutInterface $layout);
Chris@0 58
Chris@0 59 /**
Chris@0 60 * Gets the layout plugin for this display.
Chris@0 61 *
Chris@0 62 * @return \Drupal\Core\Layout\LayoutInterface
Chris@0 63 * The layout plugin.
Chris@0 64 */
Chris@0 65 public function getLayout();
Chris@0 66
Chris@0 67 /**
Chris@0 68 * Ensures this entity has a layout.
Chris@0 69 *
Chris@0 70 * @param string $default_layout_id
Chris@0 71 * (optional) The layout ID to use as a default. Defaults to
Chris@0 72 * 'layout_onecol'.
Chris@0 73 *
Chris@0 74 * @return $this
Chris@0 75 */
Chris@0 76 public function ensureLayout($default_layout_id = 'layout_onecol');
Chris@0 77
Chris@0 78 }