LayoutEntityDisplayInterface.php

Same filename in other branches
  1. 9 core/modules/layout_builder/src/Entity/LayoutEntityDisplayInterface.php
  2. 10 core/modules/layout_builder/src/Entity/LayoutEntityDisplayInterface.php
  3. 11.x core/modules/layout_builder/src/Entity/LayoutEntityDisplayInterface.php

Namespace

Drupal\layout_builder\Entity

File

core/modules/layout_builder/src/Entity/LayoutEntityDisplayInterface.php

View source
<?php

namespace Drupal\layout_builder\Entity;

use Drupal\Core\Entity\Display\EntityDisplayInterface;
use Drupal\layout_builder\LayoutBuilderEnabledInterface;
use Drupal\layout_builder\SectionListInterface;

/**
 * Provides an interface for entity displays that have layout.
 *
 * @todo Refactor this interface in https://www.drupal.org/node/2985362.
 */
interface LayoutEntityDisplayInterface extends EntityDisplayInterface, SectionListInterface, LayoutBuilderEnabledInterface {
    
    /**
     * Determines if the display allows custom overrides.
     *
     * @return bool
     *   TRUE if custom overrides are allowed, FALSE otherwise.
     */
    public function isOverridable();
    
    /**
     * Sets the display to allow or disallow overrides.
     *
     * @param bool $overridable
     *   TRUE if the display should allow overrides, FALSE otherwise.
     *
     * @return $this
     */
    public function setOverridable($overridable = TRUE);

}

Interfaces

Title Deprecated Summary
LayoutEntityDisplayInterface Provides an interface for entity displays that have layout.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.