annotate core/modules/layout_builder/src/Entity/LayoutEntityDisplayInterface.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@14 1 <?php
Chris@14 2
Chris@14 3 namespace Drupal\layout_builder\Entity;
Chris@14 4
Chris@14 5 use Drupal\Core\Entity\Display\EntityDisplayInterface;
Chris@17 6 use Drupal\layout_builder\LayoutBuilderEnabledInterface;
Chris@14 7 use Drupal\layout_builder\SectionListInterface;
Chris@14 8
Chris@14 9 /**
Chris@14 10 * Provides an interface for entity displays that have layout.
Chris@14 11 *
Chris@17 12 * @todo Refactor this interface in https://www.drupal.org/node/2985362.
Chris@14 13 */
Chris@17 14 interface LayoutEntityDisplayInterface extends EntityDisplayInterface, SectionListInterface, LayoutBuilderEnabledInterface {
Chris@14 15
Chris@14 16 /**
Chris@14 17 * Determines if the display allows custom overrides.
Chris@14 18 *
Chris@14 19 * @return bool
Chris@14 20 * TRUE if custom overrides are allowed, FALSE otherwise.
Chris@14 21 */
Chris@14 22 public function isOverridable();
Chris@14 23
Chris@14 24 /**
Chris@14 25 * Sets the display to allow or disallow overrides.
Chris@14 26 *
Chris@14 27 * @param bool $overridable
Chris@14 28 * TRUE if the display should allow overrides, FALSE otherwise.
Chris@14 29 *
Chris@14 30 * @return $this
Chris@14 31 */
Chris@14 32 public function setOverridable($overridable = TRUE);
Chris@14 33
Chris@14 34 }