interface LayoutOptionInterface in Bootstrap Layout Builder 2.x
Same name and namespace in other branches
- 1.x src/LayoutOptionInterface.php \Drupal\bootstrap_layout_builder\LayoutOptionInterface
Provides an interface defining a layout option entity.
Hierarchy
- interface \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface; interface \Drupal\Core\Entity\SynchronizableInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface
- interface \Drupal\bootstrap_layout_builder\LayoutOptionInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface
Expanded class hierarchy of LayoutOptionInterface
All classes that implement LayoutOptionInterface
1 file declares its use of LayoutOptionInterface
- LayoutOption.php in src/
Entity/ LayoutOption.php
File
- src/
LayoutOptionInterface.php, line 10
Namespace
Drupal\bootstrap_layout_builderView source
interface LayoutOptionInterface extends ConfigEntityInterface {
/**
* Returns the layout_id.
*
* @return int
* The layout option layout_id.
*/
public function getLayoutId();
/**
* Sets the layout_id.
*
* @param int $layout_id
* The layout option layout_id.
*
* @return $this
* The called layout option entity.
*/
public function setLayoutId($layout_id);
/**
* Returns the structure.
*
* @return string
* The layout option structure.
*/
public function getStructure();
/**
* Sets the structure.
*
* @param string $structure
* The layout option structure.
*
* @return $this
* The called layout option entity.
*/
public function setStructure($structure);
/**
* Returns the structure id for select list options.
*
* @return string
* The layout option structure.
*/
public function getStructureId();
/**
* Returns the weight among layout options with the same depth.
*
* @return int
* The layout option weight.
*/
public function getWeight();
/**
* Sets the weight among layout options with the same depth.
*
* @param int $weight
* The layout option weight.
*
* @return $this
* The called layout option entity.
*/
public function setWeight($weight);
/**
* Returns array of enabled breakpoints ids.
*
* @return array
* The breakpoints ids.
*/
public function getBreakpointsIds();
/**
* Returns array of enabled breakpoints lablels.
*
* @return array
* The breakpoints labels.
*/
public function getBreakpointsLabels();
/**
* Returns parent layout entity.
*
* @return object
* The parent layout entity.
*/
public function getLayout();
/**
* Get layout entity by Id.
*
* @param string $layout_id
* The layout id.
*
* @return object
* The layout entity.
*/
public function getLayoutById($layout_id);
/**
* Returns array of enabled default breakpoints ids.
*
* @return array
* The default breakpoints ids.
*/
public function getDefaultBreakpointsIds();
/**
* Returns array of enabled default breakpoints labels.
*
* @return array
* The breakpoints labels.
*/
public function getDefaultBreakpointsLabels();
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AccessibleInterface:: |
public | function | Checks data value access. | 9 |
CacheableDependencyInterface:: |
public | function | The cache contexts associated with this object. | 34 |
CacheableDependencyInterface:: |
public | function | The maximum age for which this object may be cached. | 34 |
CacheableDependencyInterface:: |
public | function | The cache tags associated with this object. | 27 |
ConfigEntityInterface:: |
public | function | Calculates dependencies and stores them in the dependency property. | 2 |
ConfigEntityInterface:: |
public | function | Disables the configuration entity. | 2 |
ConfigEntityInterface:: |
public | function | Enables the configuration entity. | 2 |
ConfigEntityInterface:: |
public | function | Returns the value of a property. | 2 |
ConfigEntityInterface:: |
public | function | Gets the configuration dependencies. | 2 |
ConfigEntityInterface:: |
public | function | Gets whether on not the data is trusted. | 2 |
ConfigEntityInterface:: |
public | function | Checks whether this entity is installable. | 2 |
ConfigEntityInterface:: |
public | function | Returns whether this entity is being changed during the uninstall process. | 2 |
ConfigEntityInterface:: |
public | function | Informs the entity that entities it depends on will be deleted. | 2 |
ConfigEntityInterface:: |
public | function | Sets the value of a property. | 2 |
ConfigEntityInterface:: |
public | function | Sets the status of the configuration entity. | 2 |
ConfigEntityInterface:: |
public | function | Returns whether the configuration entity is enabled. | 2 |
ConfigEntityInterface:: |
public | function | Sets that the data should be trusted. | 2 |
EntityInterface:: |
public | function | Gets the bundle of the entity. | 2 |
EntityInterface:: |
public static | function | Constructs a new entity object, without permanently saving it. | 2 |
EntityInterface:: |
public | function | Creates a duplicate of the entity. | 2 |
EntityInterface:: |
public | function | Deletes an entity permanently. | 2 |
EntityInterface:: |
public | function | Enforces an entity to be new. | 2 |
EntityInterface:: |
public | function | Returns the cache tags that should be used to invalidate caches. | 2 |
EntityInterface:: |
public | function | Gets the key that is used to store configuration dependencies. | 2 |
EntityInterface:: |
public | function | Gets the configuration dependency name. | 2 |
EntityInterface:: |
public | function | Gets the configuration target identifier for the entity. | 2 |
EntityInterface:: |
public | function | Gets the entity type definition. | 2 |
EntityInterface:: |
public | function | Gets the ID of the type of the entity. | 2 |
EntityInterface:: |
public | function | Gets the original ID. | 2 |
EntityInterface:: |
public | function | Gets a typed data object for this entity object. | 2 |
EntityInterface:: |
public | function | Indicates if a link template exists for a given key. | 2 |
EntityInterface:: |
public | function | Gets the identifier. | 2 |
EntityInterface:: |
public | function | Determines whether the entity is new. | 2 |
EntityInterface:: |
public | function | Gets the label of the entity. | 2 |
EntityInterface:: |
public | function | Gets the language of the entity. | 2 |
EntityInterface:: |
public static | function | Loads an entity. | 2 |
EntityInterface:: |
public static | function | Loads one or more entities. | 2 |
EntityInterface:: |
public | function | Acts on a created entity before hooks are invoked. | 2 |
EntityInterface:: |
public static | function | Acts on deleted entities before the delete hook is invoked. | 2 |
EntityInterface:: |
public static | function | Acts on loaded entities. | 3 |
EntityInterface:: |
public | function | Acts on a saved entity before the insert or update hook is invoked. | 2 |
EntityInterface:: |
public static | function | Changes the values of an entity before it is created. | 2 |
EntityInterface:: |
public static | function | Acts on entities before they are deleted and before hooks are invoked. | 2 |
EntityInterface:: |
public | function | Acts on an entity before the presave hook is invoked. | 2 |
EntityInterface:: |
public | function | Gets a list of entities referenced by this entity. | 2 |
EntityInterface:: |
public | function | Saves an entity permanently. | 2 |
EntityInterface:: |
public | function | Sets the original ID. | 2 |
EntityInterface:: |
public | function | Gets an array of all property values. | 3 |
EntityInterface:: |
public | function | Generates the HTML for a link to this entity. | 2 |
EntityInterface:: |
public | function | Gets the URL object for the entity. | 2 |
EntityInterface:: |
public | function | Gets a list of URI relationships supported by this entity. | 2 |
EntityInterface:: |
public | function | Gets the entity UUID (Universally Unique Identifier). | 2 |
LayoutOptionInterface:: |
public | function | Returns array of enabled breakpoints ids. | 1 |
LayoutOptionInterface:: |
public | function | Returns array of enabled breakpoints lablels. | 1 |
LayoutOptionInterface:: |
public | function | Returns array of enabled default breakpoints ids. | 1 |
LayoutOptionInterface:: |
public | function | Returns array of enabled default breakpoints labels. | 1 |
LayoutOptionInterface:: |
public | function | Returns parent layout entity. | 1 |
LayoutOptionInterface:: |
public | function | Get layout entity by Id. | 1 |
LayoutOptionInterface:: |
public | function | Returns the layout_id. | 1 |
LayoutOptionInterface:: |
public | function | Returns the structure. | 1 |
LayoutOptionInterface:: |
public | function | Returns the structure id for select list options. | 1 |
LayoutOptionInterface:: |
public | function | Returns the weight among layout options with the same depth. | 1 |
LayoutOptionInterface:: |
public | function | Sets the layout_id. | 1 |
LayoutOptionInterface:: |
public | function | Sets the structure. | 1 |
LayoutOptionInterface:: |
public | function | Sets the weight among layout options with the same depth. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds a dependency on an object: merges its cacheability metadata. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds cache contexts. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds cache tags. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Merges the maximum age (in seconds) with the existing maximum age. | 1 |
SynchronizableInterface:: |
public | function | Returns whether this entity is being changed as part of a synchronization. | 1 |
SynchronizableInterface:: |
public | function | Sets the status of the synchronization flag. | 1 |
ThirdPartySettingsInterface:: |
public | function | Gets the list of third parties that store information. | 5 |
ThirdPartySettingsInterface:: |
public | function | Gets the value of a third-party setting. | 5 |
ThirdPartySettingsInterface:: |
public | function | Gets all third-party settings of a given module. | 5 |
ThirdPartySettingsInterface:: |
public | function | Sets the value of a third-party setting. | 5 |
ThirdPartySettingsInterface:: |
public | function | Unsets a third-party setting. | 5 |