interface DynamicLayoutInterface in Dynamic Layouts 8

Interface for DynamicLayout.

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\dynamic_layouts\DynamicLayoutInterface

Expanded class hierarchy of DynamicLayoutInterface

All classes that implement DynamicLayoutInterface

2 files declare their use of DynamicLayoutInterface

DynamicLayout.php in src/Entity/DynamicLayout.php
DynamicLayoutForm.php in src/Form/DynamicLayoutForm.php

File

src/DynamicLayoutInterface.php, line 10

Namespace

Drupal\dynamic_layouts

View source

interface DynamicLayoutInterface extends ConfigEntityInterface {

  /**
   * Get the layout category.
   */
  public function getCategory();

  /**
   * Get the layout regions.
   */
  public function getRegions();

  /**
   * Get all layout regions.
   */
  public function getLayoutRegions();

  /**
   * Set the layout row classes.
   *
   * @param int $row_id
   *   The row number we need to set.
   * @param array $row_classes
   *   The row classes we need to set.
   */
  public function setRowClasses($row_id, array $row_classes);

  /**
   * Set the layout column classes.
   *
   * @param int $row_id
   *   The row number we need to set the classes on.
   * @param int $column_id
   *   The column id we need to set the classes on.
   * @param array $column_classes
   *   The column classes.
   */
  public function setCustomColumnClasses($row_id, $column_id, array $column_classes);

  /**
   * Set the layout column classes.
   *
   * @param int $row_id
   *   The row number we need to set the classes on.
   * @param int $column_id
   *   The column id we need to set the classes on.
   * @param string $column_name
   *   The column name.
   */
  public function setColumnName($row_id, $column_id, $column_name);

  /**
   * Set the custom column width number.
   *
   * @param int $row_id
   *   The row number we need to set the classes on.
   * @param int $column_id
   *   The column id we need to set the classes on.
   * @param string $column_width_number
   *   The column width number.
   */
  public function setCustomColumnWidthNumber($row_id, $column_id, $column_width_number);

  /**
   * Set the column width number.
   *
   * @param int $row_id
   *   The row number we need to set the classes on.
   * @param int $column_id
   *   The column id we need to set the classes on.
   */
  public function getColumnWidthNumber($row_id, $column_id);

  /**
   * Get the layout row classes, comma separated.
   *
   * @param int $row_id
   *   The row number we need to get.
   */
  public function getRowClasses($row_id);

  /**
   * Get the layout column classes, comma separated.
   *
   * @param int $row_id
   *   The row number we need to get the column classes from.
   * @param int $column_id
   *   The column id we need to get.
   */
  public function getColumnClasses($row_id, $column_id);

  /**
   * Get the layout column name.
   *
   * @param int $row_id
   *   The row number we need to get the column name from.
   * @param int $column_id
   *   The column id we need to get.
   */
  public function getColumnName($row_id, $column_id);

  /**
   * Delete a specific row from the layout.
   *
   * @param int $row_id
   *   The row number we need to delete.
   */
  public function deleteRow($row_id);

  /**
   * Delete a specific column from the layout.
   *
   * @param int $row_id
   *   The row number we need to delete the column from.
   * @param int $column_id
   *   The column id we need to delete.
   */
  public function deleteColumn($row_id, $column_id);

  /**
   * Add a row to the layout.
   */
  public function addRow();

  /**
   * Add multiple rows to the layout.
   *
   * @param int $rows_count
   *   The amount of rows to add.
   */
  public function addStartingRows($rows_count);

  /**
   * Add a column to a row.
   *
   * @param int $row_id
   *   The row number we need to add the column to.
   */
  public function addColumn($row_id);

  /**
   * Get the unserialized rows.
   */
  public function getRows();

  /**
   * Get the default column class.
   */
  public function getDefaultColumnClass();

  /**
   * Get the default row class.
   */
  public function getDefaultRowClass();

  /**
   * Get the icon map for this layout.
   */
  public function getIconMap();

  /**
   * Set the default column class.
   *
   * @param string $default_column_class
   *   The default column class we need to set.
   */
  public function setDefaultColumnClass($default_column_class);

  /**
   * Set the default row class.
   *
   * @param string $default_row_class
   *   The default row class we need to set.
   */
  public function setDefaultRowClass($default_row_class);

}

Members

Name	Modifiers	Type	Description	Overrides
AccessibleInterface::access	public	function	Checks data value access.	9
CacheableDependencyInterface::getCacheContexts	public	function	The cache contexts associated with this object.	34
CacheableDependencyInterface::getCacheMaxAge	public	function	The maximum age for which this object may be cached.	34
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object.	27
ConfigEntityInterface::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property.	2
ConfigEntityInterface::disable	public	function	Disables the configuration entity.	2
ConfigEntityInterface::enable	public	function	Enables the configuration entity.	2
ConfigEntityInterface::get	public	function	Returns the value of a property.	2
ConfigEntityInterface::getDependencies	public	function	Gets the configuration dependencies.	2
ConfigEntityInterface::hasTrustedData	public	function	Gets whether on not the data is trusted.	2
ConfigEntityInterface::isInstallable	public	function	Checks whether this entity is installable.	2
ConfigEntityInterface::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process.	2
ConfigEntityInterface::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted.	2
ConfigEntityInterface::set	public	function	Sets the value of a property.	2
ConfigEntityInterface::setStatus	public	function	Sets the status of the configuration entity.	2
ConfigEntityInterface::status	public	function	Returns whether the configuration entity is enabled.	2
ConfigEntityInterface::trustData	public	function	Sets that the data should be trusted.	2
DynamicLayoutInterface::addColumn	public	function	Add a column to a row.	1
DynamicLayoutInterface::addRow	public	function	Add a row to the layout.	1
DynamicLayoutInterface::addStartingRows	public	function	Add multiple rows to the layout.	1
DynamicLayoutInterface::deleteColumn	public	function	Delete a specific column from the layout.	1
DynamicLayoutInterface::deleteRow	public	function	Delete a specific row from the layout.	1
DynamicLayoutInterface::getCategory	public	function	Get the layout category.	1
DynamicLayoutInterface::getColumnClasses	public	function	Get the layout column classes, comma separated.	1
DynamicLayoutInterface::getColumnName	public	function	Get the layout column name.	1
DynamicLayoutInterface::getColumnWidthNumber	public	function	Set the column width number.	1
DynamicLayoutInterface::getDefaultColumnClass	public	function	Get the default column class.	1
DynamicLayoutInterface::getDefaultRowClass	public	function	Get the default row class.	1
DynamicLayoutInterface::getIconMap	public	function	Get the icon map for this layout.	1
DynamicLayoutInterface::getLayoutRegions	public	function	Get all layout regions.	1
DynamicLayoutInterface::getRegions	public	function	Get the layout regions.	1
DynamicLayoutInterface::getRowClasses	public	function	Get the layout row classes, comma separated.	1
DynamicLayoutInterface::getRows	public	function	Get the unserialized rows.	1
DynamicLayoutInterface::setColumnName	public	function	Set the layout column classes.	1
DynamicLayoutInterface::setCustomColumnClasses	public	function	Set the layout column classes.	1
DynamicLayoutInterface::setCustomColumnWidthNumber	public	function	Set the custom column width number.	1
DynamicLayoutInterface::setDefaultColumnClass	public	function	Set the default column class.	1
DynamicLayoutInterface::setDefaultRowClass	public	function	Set the default row class.	1
DynamicLayoutInterface::setRowClasses	public	function	Set the layout row classes.	1
EntityInterface::bundle	public	function	Gets the bundle of the entity.	2
EntityInterface::create	public static	function	Constructs a new entity object, without permanently saving it.	2
EntityInterface::createDuplicate	public	function	Creates a duplicate of the entity.	2
EntityInterface::delete	public	function	Deletes an entity permanently.	2
EntityInterface::enforceIsNew	public	function	Enforces an entity to be new.	2
EntityInterface::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches.	2
EntityInterface::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies.	2
EntityInterface::getConfigDependencyName	public	function	Gets the configuration dependency name.	2
EntityInterface::getConfigTarget	public	function	Gets the configuration target identifier for the entity.	2
EntityInterface::getEntityType	public	function	Gets the entity type definition.	2
EntityInterface::getEntityTypeId	public	function	Gets the ID of the type of the entity.	2
EntityInterface::getOriginalId	public	function	Gets the original ID.	2
EntityInterface::getTypedData	public	function	Gets a typed data object for this entity object.	2
EntityInterface::hasLinkTemplate	public	function	Indicates if a link template exists for a given key.	2
EntityInterface::id	public	function	Gets the identifier.	2
EntityInterface::isNew	public	function	Determines whether the entity is new.	2
EntityInterface::label	public	function	Gets the label of the entity.	2
EntityInterface::language	public	function	Gets the language of the entity.	2
EntityInterface::link Deprecated	public	function	Deprecated way of generating a link to the entity. See toLink().	2
EntityInterface::load	public static	function	Loads an entity.	2
EntityInterface::loadMultiple	public static	function	Loads one or more entities.	2
EntityInterface::postCreate	public	function	Acts on a created entity before hooks are invoked.	2
EntityInterface::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked.	2
EntityInterface::postLoad	public static	function	Acts on loaded entities.	3
EntityInterface::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked.	2
EntityInterface::preCreate	public static	function	Changes the values of an entity before it is created.	2
EntityInterface::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked.	2
EntityInterface::preSave	public	function	Acts on an entity before the presave hook is invoked.	2
EntityInterface::referencedEntities	public	function	Gets a list of entities referenced by this entity.	2
EntityInterface::save	public	function	Saves an entity permanently.	2
EntityInterface::setOriginalId	public	function	Sets the original ID.	2
EntityInterface::toArray	public	function	Gets an array of all property values.	3
EntityInterface::toLink	public	function	Generates the HTML for a link to this entity.	2
EntityInterface::toUrl	public	function	Gets the URL object for the entity.	2
EntityInterface::uriRelationships	public	function	Gets a list of URI relationships supported by this entity.	2
EntityInterface::url Deprecated	public	function	Gets the public URL for this entity.	2
EntityInterface::urlInfo Deprecated	public	function	Gets the URL object for the entity.	2
EntityInterface::uuid	public	function	Gets the entity UUID (Universally Unique Identifier).	2
RefinableCacheableDependencyInterface::addCacheableDependency	public	function	Adds a dependency on an object: merges its cacheability metadata.	1
RefinableCacheableDependencyInterface::addCacheContexts	public	function	Adds cache contexts.	1
RefinableCacheableDependencyInterface::addCacheTags	public	function	Adds cache tags.	1
RefinableCacheableDependencyInterface::mergeCacheMaxAge	public	function	Merges the maximum age (in seconds) with the existing maximum age.	1
SynchronizableInterface::isSyncing	public	function	Returns whether this entity is being changed as part of a synchronization.	1
SynchronizableInterface::setSyncing	public	function	Sets the status of the synchronization flag.	1
ThirdPartySettingsInterface::getThirdPartyProviders	public	function	Gets the list of third parties that store information.	5
ThirdPartySettingsInterface::getThirdPartySetting	public	function	Gets the value of a third-party setting.	5
ThirdPartySettingsInterface::getThirdPartySettings	public	function	Gets all third-party settings of a given module.	5
ThirdPartySettingsInterface::setThirdPartySetting	public	function	Sets the value of a third-party setting.	5
ThirdPartySettingsInterface::unsetThirdPartySetting	public	function	Unsets a third-party setting.	5

You are here

interface DynamicLayoutInterface in Dynamic Layouts 8

Hierarchy

File

Namespace

Members

API Navigation