You are here

Home » API reference » Dynamic Layouts 8 » DynamicLayoutSettingsInterface.php

interface DynamicLayoutSettingsInterface in Dynamic Layouts 8

Interface for DynamicLayout.

Hierarchy

Expanded class hierarchy of DynamicLayoutSettingsInterface

All classes that implement DynamicLayoutSettingsInterface

3 files declare their use of DynamicLayoutSettingsInterface
DynamicLayout.php in src/Entity/DynamicLayout.php
DynamicLayoutSettings.php in src/Entity/DynamicLayoutSettings.php
SettingsForm.php in src/Form/SettingsForm.php

File

src/DynamicLayoutSettingsInterface.php, line 10

Namespace

Drupal\dynamic_layouts
View source 
interface DynamicLayoutSettingsInterface extends ConfigEntityInterface {

  /**
   * Get the Dynamic layout general settings.
   */
  public function getSettings();

  /**
   * Set the frontend library.
   */
  public function getFrontendLibrary();

  /**
   * Set the frontend library.
   *
   * @param string $frontend_library
   *   The frontend library we need to set.
   */
  public function setFrontendLibrary($frontend_library);

  /**
   * Get the first column number for a specific frontend library.
   *
   * @param string $frontend_library
   *   The frontend library we need to get the first column class from.
   * @param string $new_column_prefix
   *   The new column prefix.
   * @param string $new_grid_column_count
   *   The new grid column count.
   */
  public function getLastColumnNumber($frontend_library, $new_column_prefix, $new_grid_column_count);

  /**
   * Get the frontend column classes.
   */
  public function getFrontendColumnClasses();

  /**
   * Get the grid column count.
   */
  public function getGridColumnCount();

  /**
   * Get the column prefix.
   */
  public function getColumnPrefix();

  /**
   * Purge all column width numbers from all rows.
   *
   * This is needed if the frontend library is changed.
   *
   * @param string $last_column_number
   *   The last column number we need to set when purging the old classes.
   * @param string $new_column_prefix
   *   The new column prefix.
   */
  public function purgeColumnWidthNumbers($last_column_number, $new_column_prefix = '');

  /**
   * Set the column prefix.
   *
   * @param string $column_prefix
   *   The column prefix.
   */
  public function setColumnPrefix($column_prefix);

  /**
   * Set the grid column count.
   *
   * @param string $new_grid_column_count
   *   The grid column count.
   */
  public function setGridColumnCount($new_grid_column_count);

}

Members

Namesort descending 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
DynamicLayoutSettingsInterface::getColumnPrefix public function Get the column prefix. 1
DynamicLayoutSettingsInterface::getFrontendColumnClasses public function Get the frontend column classes. 1
DynamicLayoutSettingsInterface::getFrontendLibrary public function Set the frontend library. 1
DynamicLayoutSettingsInterface::getGridColumnCount public function Get the grid column count. 1
DynamicLayoutSettingsInterface::getLastColumnNumber public function Get the first column number for a specific frontend library. 1
DynamicLayoutSettingsInterface::getSettings public function Get the Dynamic layout general settings. 1
DynamicLayoutSettingsInterface::purgeColumnWidthNumbers public function Purge all column width numbers from all rows. 1
DynamicLayoutSettingsInterface::setColumnPrefix public function Set the column prefix. 1
DynamicLayoutSettingsInterface::setFrontendLibrary public function Set the frontend library. 1
DynamicLayoutSettingsInterface::setGridColumnCount public function Set the grid column count. 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