DefaultsSectionStorageInterface.php

Same filename in other branches
  1. 8.9.x core/modules/layout_builder/src/DefaultsSectionStorageInterface.php
  2. 10 core/modules/layout_builder/src/DefaultsSectionStorageInterface.php
  3. 11.x core/modules/layout_builder/src/DefaultsSectionStorageInterface.php

Namespace

Drupal\layout_builder

File

core/modules/layout_builder/src/DefaultsSectionStorageInterface.php

View source
<?php

namespace Drupal\layout_builder;

use Drupal\Core\Config\Entity\ThirdPartySettingsInterface;

/**
 * Defines an interface for an object that stores layout sections for defaults.
 *
 * @todo Refactor this interface in https://www.drupal.org/node/2985362.
 */
interface DefaultsSectionStorageInterface extends SectionStorageInterface, ThirdPartySettingsInterface, LayoutBuilderEnabledInterface {
    
    /**
     * Determines if the defaults allow custom overrides.
     *
     * @return bool
     *   TRUE if custom overrides are allowed, FALSE otherwise.
     */
    public function isOverridable();
    
    /**
     * Sets the defaults 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
DefaultsSectionStorageInterface Defines an interface for an object that stores layout sections for defaults.

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