www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/layout_builder/src/Entity/LayoutEntityDisplayInterface.php

   1 <?php
   2
   3 namespace Drupal\layout_builder\Entity;
   4
   5 use Drupal\Core\Entity\Display\EntityDisplayInterface;
   6 use Drupal\layout_builder\LayoutBuilderEnabledInterface;
   7 use Drupal\layout_builder\SectionListInterface;
   8
   9 /**
  10  * Provides an interface for entity displays that have layout.
  11  *
  12  * @internal
  13  *   Layout Builder is currently experimental and should only be leveraged by
  14  *   experimental modules and development releases of contributed modules.
  15  *   See https://www.drupal.org/core/experimental for more information.
  16  *
  17  * @todo Refactor this interface in https://www.drupal.org/node/2985362.
  18  */
  19 interface LayoutEntityDisplayInterface extends EntityDisplayInterface, SectionListInterface, LayoutBuilderEnabledInterface {
  20
  21   /**
  22    * Determines if the display allows custom overrides.
  23    *
  24    * @return bool
  25    *   TRUE if custom overrides are allowed, FALSE otherwise.
  26    */
  27   public function isOverridable();
  28
  29   /**
  30    * Sets the display to allow or disallow overrides.
  31    *
  32    * @param bool $overridable
  33    *   TRUE if the display should allow overrides, FALSE otherwise.
  34    *
  35    * @return $this
  36    */
  37   public function setOverridable($overridable = TRUE);
  38
  39 }